DBGFAddrSpace.cpp@ 93115

Last change on this file since 93115 was 93115, checked in by vboxsync, 3 years ago
scm --update-copyright-year
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 45.3 KB

Line
1	/* $Id: DBGFAddrSpace.cpp 93115 2022-01-01 11:31:46Z vboxsync $ */
2	/** @file
3	* DBGF - Debugger Facility, Address Space Management.
4	*/
5
6	/*
7	* Copyright (C) 2008-2022 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/** @page pg_dbgf_addr_space DBGFAddrSpace - Address Space Management
20	*
21	* What's an address space? It's mainly a convenient way of stuffing
22	* module segments and ad-hoc symbols together. It will also help out
23	* when the debugger gets extended to deal with user processes later.
24	*
25	* There are two standard address spaces that will always be present:
26	* - The physical address space.
27	* - The global virtual address space.
28	*
29	* Additional address spaces will be added and removed at runtime for
30	* guest processes. The global virtual address space will be used to
31	* track the kernel parts of the OS, or at least the bits of the kernel
32	* that is part of all address spaces (mac os x and 4G/4G patched linux).
33	*
34	*/
35
36
37	/*********************************************************************************************************************************
38	* Header Files *
39	*********************************************************************************************************************************/
40	#define LOG_GROUP LOG_GROUP_DBGF
41	#include <VBox/vmm/dbgf.h>
42	#include <VBox/vmm/hm.h>
43	#include <VBox/vmm/pdmapi.h>
44	#include <VBox/vmm/mm.h>
45	#include "DBGFInternal.h"
46	#include <VBox/vmm/uvm.h>
47	#include <VBox/vmm/vm.h>
48	#include <VBox/err.h>
49	#include <VBox/log.h>
50
51	#include <iprt/asm.h>
52	#include <iprt/assert.h>
53	#include <iprt/ctype.h>
54	#include <iprt/env.h>
55	#include <iprt/mem.h>
56	#include <iprt/path.h>
57	#include <iprt/param.h>
58
59
60	/*********************************************************************************************************************************
61	* Structures and Typedefs *
62	*********************************************************************************************************************************/
63	/**
64	* Address space database node.
65	*/
66	typedef struct DBGFASDBNODE
67	{
68	/** The node core for DBGF::AsHandleTree, the key is the address space handle. */
69	AVLPVNODECORE HandleCore;
70	/** The node core for DBGF::AsPidTree, the key is the process id. */
71	AVLU32NODECORE PidCore;
72	/** The node core for DBGF::AsNameSpace, the string is the address space name. */
73	RTSTRSPACECORE NameCore;
74
75	} DBGFASDBNODE;
76	/** Pointer to an address space database node. */
77	typedef DBGFASDBNODE *PDBGFASDBNODE;
78
79
80	/**
81	* For dbgfR3AsLoadImageOpenData and dbgfR3AsLoadMapOpenData.
82	*/
83	typedef struct DBGFR3ASLOADOPENDATA
84	{
85	const char *pszModName;
86	RTGCUINTPTR uSubtrahend;
87	uint32_t fFlags;
88	RTDBGMOD hMod;
89	} DBGFR3ASLOADOPENDATA;
90
91	#if 0 /* unused */
92	/**
93	* Callback for dbgfR3AsSearchPath and dbgfR3AsSearchEnvPath.
94	*
95	* @returns VBox status code. If success, then the search is completed.
96	* @param pszFilename The file name under evaluation.
97	* @param pvUser The user argument.
98	*/
99	typedef int FNDBGFR3ASSEARCHOPEN(const char pszFilename, void pvUser);
100	/** Pointer to a FNDBGFR3ASSEARCHOPEN. */
101	typedef FNDBGFR3ASSEARCHOPEN *PFNDBGFR3ASSEARCHOPEN;
102	#endif
103
104
105	/*********************************************************************************************************************************
106	* Defined Constants And Macros *
107	*********************************************************************************************************************************/
108	/** Locks the address space database for writing. */
109	#define DBGF_AS_DB_LOCK_WRITE(pUVM) \
110	do { \
111	int rcSem = RTSemRWRequestWrite((pUVM)->dbgf.s.hAsDbLock, RT_INDEFINITE_WAIT); \
112	AssertRC(rcSem); \
113	} while (0)
114
115	/** Unlocks the address space database after writing. */
116	#define DBGF_AS_DB_UNLOCK_WRITE(pUVM) \
117	do { \
118	int rcSem = RTSemRWReleaseWrite((pUVM)->dbgf.s.hAsDbLock); \
119	AssertRC(rcSem); \
120	} while (0)
121
122	/** Locks the address space database for reading. */
123	#define DBGF_AS_DB_LOCK_READ(pUVM) \
124	do { \
125	int rcSem = RTSemRWRequestRead((pUVM)->dbgf.s.hAsDbLock, RT_INDEFINITE_WAIT); \
126	AssertRC(rcSem); \
127	} while (0)
128
129	/** Unlocks the address space database after reading. */
130	#define DBGF_AS_DB_UNLOCK_READ(pUVM) \
131	do { \
132	int rcSem = RTSemRWReleaseRead((pUVM)->dbgf.s.hAsDbLock); \
133	AssertRC(rcSem); \
134	} while (0)
135
136
137
138	/**
139	* Initializes the address space parts of DBGF.
140	*
141	* @returns VBox status code.
142	* @param pUVM The user mode VM handle.
143	*/
144	int dbgfR3AsInit(PUVM pUVM)
145	{
146	Assert(pUVM->pVM);
147
148	/*
149	* Create the semaphore.
150	*/
151	int rc = RTSemRWCreate(&pUVM->dbgf.s.hAsDbLock);
152	AssertRCReturn(rc, rc);
153
154	/*
155	* Create the debugging config instance and set it up, defaulting to
156	* deferred loading in order to keep things fast.
157	*/
158	rc = RTDbgCfgCreate(&pUVM->dbgf.s.hDbgCfg, "VBOXDBG_", true /fNativePaths/);
159	AssertRCReturn(rc, rc);
160	rc = RTDbgCfgChangeUInt(pUVM->dbgf.s.hDbgCfg, RTDBGCFGPROP_FLAGS, RTDBGCFGOP_PREPEND,
161	RTDBGCFG_FLAGS_DEFERRED);
162	AssertRCReturn(rc, rc);
163
164	static struct
165	{
166	RTDBGCFGPROP enmProp;
167	const char *pszEnvName;
168	const char *pszCfgName;
169	} const s_aProps[] =
170	{
171	{ RTDBGCFGPROP_FLAGS, "VBOXDBG_FLAGS", "Flags" },
172	{ RTDBGCFGPROP_PATH, "VBOXDBG_PATH", "Path" },
173	{ RTDBGCFGPROP_SUFFIXES, "VBOXDBG_SUFFIXES", "Suffixes" },
174	{ RTDBGCFGPROP_SRC_PATH, "VBOXDBG_SRC_PATH", "SrcPath" },
175	};
176	PCFGMNODE pCfgDbgf = CFGMR3GetChild(CFGMR3GetRootU(pUVM), "/DBGF");
177	for (unsigned i = 0; i < RT_ELEMENTS(s_aProps); i++)
178	{
179	char szEnvValue[8192];
180	rc = RTEnvGetEx(RTENV_DEFAULT, s_aProps[i].pszEnvName, szEnvValue, sizeof(szEnvValue), NULL);
181	if (RT_SUCCESS(rc))
182	{
183	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, s_aProps[i].enmProp, RTDBGCFGOP_PREPEND, szEnvValue);
184	if (RT_FAILURE(rc))
185	return VMR3SetError(pUVM, rc, RT_SRC_POS,
186	"DBGF Config Error: %s=%s -> %Rrc", s_aProps[i].pszEnvName, szEnvValue, rc);
187	}
188	else if (rc != VERR_ENV_VAR_NOT_FOUND)
189	return VMR3SetError(pUVM, rc, RT_SRC_POS,
190	"DBGF Config Error: Error querying env.var. %s: %Rrc", s_aProps[i].pszEnvName, rc);
191
192	char *pszCfgValue;
193	rc = CFGMR3QueryStringAllocDef(pCfgDbgf, s_aProps[i].pszCfgName, &pszCfgValue, NULL);
194	if (RT_FAILURE(rc))
195	return VMR3SetError(pUVM, rc, RT_SRC_POS,
196	"DBGF Config Error: Querying /DBGF/%s -> %Rrc", s_aProps[i].pszCfgName, rc);
197	if (pszCfgValue)
198	{
199	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, s_aProps[i].enmProp, RTDBGCFGOP_PREPEND, pszCfgValue);
200	if (RT_FAILURE(rc))
201	return VMR3SetError(pUVM, rc, RT_SRC_POS,
202	"DBGF Config Error: /DBGF/%s=%s -> %Rrc", s_aProps[i].pszCfgName, pszCfgValue, rc);
203	MMR3HeapFree(pszCfgValue);
204	}
205	}
206
207	/*
208	* Prepend the NoArch and VBoxDbgSyms directories to the path.
209	*/
210	char szPath[RTPATH_MAX];
211	rc = RTPathAppPrivateNoArch(szPath, sizeof(szPath));
212	AssertRCReturn(rc, rc);
213	#ifdef RT_OS_DARWIN
214	rc = RTPathAppend(szPath, sizeof(szPath), "../Resources/VBoxDbgSyms/");
215	#else
216	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, RTDBGCFGPROP_PATH, RTDBGCFGOP_PREPEND, szPath);
217	AssertRCReturn(rc, rc);
218
219	rc = RTPathAppend(szPath, sizeof(szPath), "VBoxDbgSyms/");
220	#endif
221	AssertRCReturn(rc, rc);
222	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, RTDBGCFGPROP_PATH, RTDBGCFGOP_PREPEND, szPath);
223	AssertRCReturn(rc, rc);
224
225	/*
226	* Create the standard address spaces.
227	*/
228	RTDBGAS hDbgAs;
229	rc = RTDbgAsCreate(&hDbgAs, 0, RTGCPTR_MAX, "Global");
230	AssertRCReturn(rc, rc);
231	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
232	AssertRCReturn(rc, rc);
233	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_GLOBAL)] = hDbgAs;
234
235	RTDbgAsRetain(hDbgAs);
236	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_KERNEL)] = hDbgAs;
237
238	rc = RTDbgAsCreate(&hDbgAs, 0, RTGCPHYS_MAX, "Physical");
239	AssertRCReturn(rc, rc);
240	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
241	AssertRCReturn(rc, rc);
242	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_PHYS)] = hDbgAs;
243
244	rc = RTDbgAsCreate(&hDbgAs, 0, RTRCPTR_MAX, "HyperRawMode");
245	AssertRCReturn(rc, rc);
246	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
247	AssertRCReturn(rc, rc);
248	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_RC)] = hDbgAs;
249	RTDbgAsRetain(hDbgAs);
250	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_RC_AND_GC_GLOBAL)] = hDbgAs;
251
252	rc = RTDbgAsCreate(&hDbgAs, 0, RTR0PTR_MAX, "HyperRing0");
253	AssertRCReturn(rc, rc);
254	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
255	AssertRCReturn(rc, rc);
256	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_R0)] = hDbgAs;
257
258	return VINF_SUCCESS;
259	}
260
261
262	/**
263	* Callback used by dbgfR3AsTerm / RTAvlPVDestroy to release an address space.
264	*
265	* @returns 0.
266	* @param pNode The address space database node.
267	* @param pvIgnore NULL.
268	*/
269	static DECLCALLBACK(int) dbgfR3AsTermDestroyNode(PAVLPVNODECORE pNode, void *pvIgnore)
270	{
271	PDBGFASDBNODE pDbNode = (PDBGFASDBNODE)pNode;
272	RTDbgAsRelease((RTDBGAS)pDbNode->HandleCore.Key);
273	pDbNode->HandleCore.Key = NIL_RTDBGAS;
274	/* Don't bother freeing it here as MM will free it soon and MM is much at
275	it when doing it wholesale instead of piecemeal. */
276	NOREF(pvIgnore);
277	return 0;
278	}
279
280
281	/**
282	* Terminates the address space parts of DBGF.
283	*
284	* @param pUVM The user mode VM handle.
285	*/
286	void dbgfR3AsTerm(PUVM pUVM)
287	{
288	/*
289	* Create the semaphore.
290	*/
291	int rc = RTSemRWDestroy(pUVM->dbgf.s.hAsDbLock);
292	AssertRC(rc);
293	pUVM->dbgf.s.hAsDbLock = NIL_RTSEMRW;
294
295	/*
296	* Release all the address spaces.
297	*/
298	RTAvlPVDestroy(&pUVM->dbgf.s.AsHandleTree, dbgfR3AsTermDestroyNode, NULL);
299	for (size_t i = 0; i < RT_ELEMENTS(pUVM->dbgf.s.ahAsAliases); i++)
300	{
301	RTDbgAsRelease(pUVM->dbgf.s.ahAsAliases[i]);
302	pUVM->dbgf.s.ahAsAliases[i] = NIL_RTDBGAS;
303	}
304
305	/*
306	* Release the reference to the debugging config.
307	*/
308	rc = RTDbgCfgRelease(pUVM->dbgf.s.hDbgCfg);
309	AssertRC(rc);
310	}
311
312
313	/**
314	* Relocates the RC address space.
315	*
316	* @param pUVM The user mode VM handle.
317	* @param offDelta The relocation delta.
318	*/
319	void dbgfR3AsRelocate(PUVM pUVM, RTGCUINTPTR offDelta)
320	{
321	/*
322	* We will relocate the raw-mode context modules by offDelta if they have
323	* been injected into the DBGF_AS_RC map.
324	*/
325	if ( pUVM->dbgf.s.afAsAliasPopuplated[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_RC)]
326	&& offDelta != 0)
327	{
328	RTDBGAS hAs = pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_RC)];
329
330	/* Take a snapshot of the modules as we might have overlapping
331	addresses between the previous and new mapping. */
332	RTDbgAsLockExcl(hAs);
333	uint32_t cModules = RTDbgAsModuleCount(hAs);
334	if (cModules > 0 && cModules < _4K)
335	{
336	struct DBGFASRELOCENTRY
337	{
338	RTDBGMOD hDbgMod;
339	RTRCPTR uOldAddr;
340	} paEntries = (struct DBGFASRELOCENTRY )RTMemTmpAllocZ(sizeof(paEntries[0]) * cModules);
341	if (paEntries)
342	{
343	/* Snapshot. */
344	for (uint32_t i = 0; i < cModules; i++)
345	{
346	paEntries[i].hDbgMod = RTDbgAsModuleByIndex(hAs, i);
347	AssertLogRelMsg(paEntries[i].hDbgMod != NIL_RTDBGMOD, ("iModule=%#x\n", i));
348
349	RTDBGASMAPINFO aMappings[1] = { { 0, 0 } };
350	uint32_t cMappings = 1;
351	int rc = RTDbgAsModuleQueryMapByIndex(hAs, i, &aMappings[0], &cMappings, 0 /fFlags/);
352	if (RT_SUCCESS(rc) && cMappings == 1 && aMappings[0].iSeg == NIL_RTDBGSEGIDX)
353	paEntries[i].uOldAddr = (RTRCPTR)aMappings[0].Address;
354	else
355	AssertLogRelMsgFailed(("iModule=%#x rc=%Rrc cMappings=%#x.\n", i, rc, cMappings));
356	}
357
358	/* Unlink them. */
359	for (uint32_t i = 0; i < cModules; i++)
360	{
361	int rc = RTDbgAsModuleUnlink(hAs, paEntries[i].hDbgMod);
362	AssertLogRelMsg(RT_SUCCESS(rc), ("iModule=%#x rc=%Rrc hDbgMod=%p\n", i, rc, paEntries[i].hDbgMod));
363	}
364
365	/* Link them at the new locations. */
366	for (uint32_t i = 0; i < cModules; i++)
367	{
368	RTRCPTR uNewAddr = paEntries[i].uOldAddr + offDelta;
369	int rc = RTDbgAsModuleLink(hAs, paEntries[i].hDbgMod, uNewAddr,
370	RTDBGASLINK_FLAGS_REPLACE);
371	AssertLogRelMsg(RT_SUCCESS(rc),
372	("iModule=%#x rc=%Rrc hDbgMod=%p %RRv -> %RRv\n", i, rc, paEntries[i].hDbgMod,
373	paEntries[i].uOldAddr, uNewAddr));
374	RTDbgModRelease(paEntries[i].hDbgMod);
375	}
376
377	RTMemTmpFree(paEntries);
378	}
379	else
380	AssertLogRelMsgFailed(("No memory for %#x modules.\n", cModules));
381	}
382	else
383	AssertLogRelMsgFailed(("cModules=%#x\n", cModules));
384	RTDbgAsUnlockExcl(hAs);
385	}
386	}
387
388
389	/**
390	* Gets the IPRT debugging configuration handle (no refs retained).
391	*
392	* @returns Config handle or NIL_RTDBGCFG.
393	* @param pUVM The user mode VM handle.
394	*/
395	VMMR3DECL(RTDBGCFG) DBGFR3AsGetConfig(PUVM pUVM)
396	{
397	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NIL_RTDBGCFG);
398	return pUVM->dbgf.s.hDbgCfg;
399	}
400
401
402	/**
403	* Adds the address space to the database.
404	*
405	* @returns VBox status code.
406	* @param pUVM The user mode VM handle.
407	* @param hDbgAs The address space handle. The reference of the caller
408	* will NOT be consumed.
409	* @param ProcId The process id or NIL_RTPROCESS.
410	*/
411	VMMR3DECL(int) DBGFR3AsAdd(PUVM pUVM, RTDBGAS hDbgAs, RTPROCESS ProcId)
412	{
413	/*
414	* Input validation.
415	*/
416	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
417	const char *pszName = RTDbgAsName(hDbgAs);
418	if (!pszName)
419	return VERR_INVALID_HANDLE;
420	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
421	if (cRefs == UINT32_MAX)
422	return VERR_INVALID_HANDLE;
423
424	/*
425	* Allocate a tracking node.
426	*/
427	int rc = VERR_NO_MEMORY;
428	PDBGFASDBNODE pDbNode = (PDBGFASDBNODE)MMR3HeapAllocU(pUVM, MM_TAG_DBGF_AS, sizeof(*pDbNode));
429	if (pDbNode)
430	{
431	pDbNode->HandleCore.Key = hDbgAs;
432	pDbNode->PidCore.Key = ProcId;
433	pDbNode->NameCore.pszString = pszName;
434	pDbNode->NameCore.cchString = strlen(pszName);
435	DBGF_AS_DB_LOCK_WRITE(pUVM);
436	if (RTStrSpaceInsert(&pUVM->dbgf.s.AsNameSpace, &pDbNode->NameCore))
437	{
438	if (RTAvlPVInsert(&pUVM->dbgf.s.AsHandleTree, &pDbNode->HandleCore))
439	{
440	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
441	return VINF_SUCCESS;
442	}
443
444	/* bail out */
445	RTStrSpaceRemove(&pUVM->dbgf.s.AsNameSpace, pszName);
446	}
447	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
448	MMR3HeapFree(pDbNode);
449	}
450	RTDbgAsRelease(hDbgAs);
451	return rc;
452	}
453
454
455	/**
456	* Delete an address space from the database.
457	*
458	* The address space must not be engaged as any of the standard aliases.
459	*
460	* @returns VBox status code.
461	* @retval VERR_SHARING_VIOLATION if in use as an alias.
462	* @retval VERR_NOT_FOUND if not found in the address space database.
463	*
464	* @param pUVM The user mode VM handle.
465	* @param hDbgAs The address space handle. Aliases are not allowed.
466	*/
467	VMMR3DECL(int) DBGFR3AsDelete(PUVM pUVM, RTDBGAS hDbgAs)
468	{
469	/*
470	* Input validation. Retain the address space so it can be released outside
471	* the lock as well as validated.
472	*/
473	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
474	if (hDbgAs == NIL_RTDBGAS)
475	return VINF_SUCCESS;
476	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
477	if (cRefs == UINT32_MAX)
478	return VERR_INVALID_HANDLE;
479	RTDbgAsRelease(hDbgAs);
480
481	DBGF_AS_DB_LOCK_WRITE(pUVM);
482
483	/*
484	* You cannot delete any of the aliases.
485	*/
486	for (size_t i = 0; i < RT_ELEMENTS(pUVM->dbgf.s.ahAsAliases); i++)
487	if (pUVM->dbgf.s.ahAsAliases[i] == hDbgAs)
488	{
489	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
490	return VERR_SHARING_VIOLATION;
491	}
492
493	/*
494	* Ok, try remove it from the database.
495	*/
496	PDBGFASDBNODE pDbNode = (PDBGFASDBNODE)RTAvlPVRemove(&pUVM->dbgf.s.AsHandleTree, hDbgAs);
497	if (!pDbNode)
498	{
499	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
500	return VERR_NOT_FOUND;
501	}
502	RTStrSpaceRemove(&pUVM->dbgf.s.AsNameSpace, pDbNode->NameCore.pszString);
503	if (pDbNode->PidCore.Key != NIL_RTPROCESS)
504	RTAvlU32Remove(&pUVM->dbgf.s.AsPidTree, pDbNode->PidCore.Key);
505
506	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
507
508	/*
509	* Free the resources.
510	*/
511	RTDbgAsRelease(hDbgAs);
512	MMR3HeapFree(pDbNode);
513
514	return VINF_SUCCESS;
515	}
516
517
518	/**
519	* Changes an alias to point to a new address space.
520	*
521	* Not all the aliases can be changed, currently it's only DBGF_AS_GLOBAL
522	* and DBGF_AS_KERNEL.
523	*
524	* @returns VBox status code.
525	* @param pUVM The user mode VM handle.
526	* @param hAlias The alias to change.
527	* @param hAliasFor The address space hAlias should be an alias for. This
528	* can be an alias. The caller's reference to this address
529	* space will NOT be consumed.
530	*/
531	VMMR3DECL(int) DBGFR3AsSetAlias(PUVM pUVM, RTDBGAS hAlias, RTDBGAS hAliasFor)
532	{
533	/*
534	* Input validation.
535	*/
536	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
537	AssertMsgReturn(DBGF_AS_IS_ALIAS(hAlias), ("%p\n", hAlias), VERR_INVALID_PARAMETER);
538	AssertMsgReturn(!DBGF_AS_IS_FIXED_ALIAS(hAlias), ("%p\n", hAlias), VERR_INVALID_PARAMETER);
539	RTDBGAS hRealAliasFor = DBGFR3AsResolveAndRetain(pUVM, hAliasFor);
540	if (hRealAliasFor == NIL_RTDBGAS)
541	return VERR_INVALID_HANDLE;
542
543	/*
544	* Make sure the handle is already in the database.
545	*/
546	int rc = VERR_NOT_FOUND;
547	DBGF_AS_DB_LOCK_WRITE(pUVM);
548	if (RTAvlPVGet(&pUVM->dbgf.s.AsHandleTree, hRealAliasFor))
549	{
550	/*
551	* Update the alias table and release the current address space.
552	*/
553	RTDBGAS hAsOld;
554	ASMAtomicXchgHandle(&pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(hAlias)], hRealAliasFor, &hAsOld);
555	uint32_t cRefs = RTDbgAsRelease(hAsOld);
556	Assert(cRefs > 0); Assert(cRefs != UINT32_MAX); NOREF(cRefs);
557	rc = VINF_SUCCESS;
558	}
559	else
560	RTDbgAsRelease(hRealAliasFor);
561	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
562
563	return rc;
564	}
565
566
567	/**
568	* @callback_method_impl{FNPDMR3ENUM}
569	*/
570	static DECLCALLBACK(int) dbgfR3AsLazyPopulateR0Callback(PVM pVM, const char pszFilename, const char pszName,
571	RTUINTPTR ImageBase, size_t cbImage, PDMLDRCTX enmCtx, void *pvArg)
572	{
573	NOREF(pVM); NOREF(cbImage);
574
575	/* Only ring-0 modules. */
576	if (enmCtx == PDMLDRCTX_RING_0)
577	{
578	RTDBGMOD hDbgMod;
579	int rc = RTDbgModCreateFromImage(&hDbgMod, pszFilename, pszName, RTLDRARCH_HOST, pVM->pUVM->dbgf.s.hDbgCfg);
580	if (RT_SUCCESS(rc))
581	{
582	rc = RTDbgAsModuleLink((RTDBGAS)pvArg, hDbgMod, ImageBase, 0 /fFlags/);
583	if (RT_FAILURE(rc))
584	LogRel(("DBGF: Failed to link module \"%s\" into DBGF_AS_R0 at %RTptr: %Rrc\n",
585	pszName, ImageBase, rc));
586	}
587	else
588	LogRel(("DBGF: RTDbgModCreateFromImage failed with rc=%Rrc for module \"%s\" (%s)\n",
589	rc, pszName, pszFilename));
590	}
591	return VINF_SUCCESS;
592	}
593
594
595	/**
596	* @callback_method_impl{FNPDMR3ENUM}
597	*/
598	static DECLCALLBACK(int) dbgfR3AsLazyPopulateRCCallback(PVM pVM, const char pszFilename, const char pszName,
599	RTUINTPTR ImageBase, size_t cbImage, PDMLDRCTX enmCtx, void *pvArg)
600	{
601	NOREF(pVM); NOREF(cbImage);
602
603	/* Only raw-mode modules. */
604	if (enmCtx == PDMLDRCTX_RAW_MODE)
605	{
606	RTDBGMOD hDbgMod;
607	int rc = RTDbgModCreateFromImage(&hDbgMod, pszFilename, pszName, RTLDRARCH_X86_32, pVM->pUVM->dbgf.s.hDbgCfg);
608	if (RT_SUCCESS(rc))
609	{
610	rc = RTDbgAsModuleLink((RTDBGAS)pvArg, hDbgMod, ImageBase, 0 /fFlags/);
611	if (RT_FAILURE(rc))
612	LogRel(("DBGF: Failed to link module \"%s\" into DBGF_AS_RC at %RTptr: %Rrc\n",
613	pszName, ImageBase, rc));
614	}
615	else
616	LogRel(("DBGF: RTDbgModCreateFromImage failed with rc=%Rrc for module \"%s\" (%s)\n",
617	rc, pszName, pszFilename));
618	}
619	return VINF_SUCCESS;
620	}
621
622
623	/**
624	* Lazily populates the specified address space.
625	*
626	* @param pUVM The user mode VM handle.
627	* @param hAlias The alias.
628	*/
629	static void dbgfR3AsLazyPopulate(PUVM pUVM, RTDBGAS hAlias)
630	{
631	DBGF_AS_DB_LOCK_WRITE(pUVM);
632	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
633	if (!pUVM->dbgf.s.afAsAliasPopuplated[iAlias])
634	{
635	RTDBGAS hDbgAs = pUVM->dbgf.s.ahAsAliases[iAlias];
636	if (hAlias == DBGF_AS_R0 && pUVM->pVM)
637	PDMR3LdrEnumModules(pUVM->pVM, dbgfR3AsLazyPopulateR0Callback, hDbgAs);
638	else if (hAlias == DBGF_AS_RC && pUVM->pVM && VM_IS_RAW_MODE_ENABLED(pUVM->pVM))
639	{
640	LogRel(("DBGF: Lazy init of RC address space\n"));
641	PDMR3LdrEnumModules(pUVM->pVM, dbgfR3AsLazyPopulateRCCallback, hDbgAs);
642	}
643	else if (hAlias == DBGF_AS_PHYS && pUVM->pVM)
644	{
645	/** @todo Lazy load pc and vga bios symbols or the EFI stuff. */
646	}
647
648	pUVM->dbgf.s.afAsAliasPopuplated[iAlias] = true;
649	}
650	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
651	}
652
653
654	/**
655	* Resolves the address space handle into a real handle if it's an alias.
656	*
657	* @returns Real address space handle. NIL_RTDBGAS if invalid handle.
658	*
659	* @param pUVM The user mode VM handle.
660	* @param hAlias The possibly address space alias.
661	*
662	* @remarks Doesn't take any locks.
663	*/
664	VMMR3DECL(RTDBGAS) DBGFR3AsResolve(PUVM pUVM, RTDBGAS hAlias)
665	{
666	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NULL);
667	AssertCompileNS(NIL_RTDBGAS == (RTDBGAS)0);
668
669	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
670	if (iAlias < DBGF_AS_COUNT)
671	ASMAtomicReadHandle(&pUVM->dbgf.s.ahAsAliases[iAlias], &hAlias);
672	return hAlias;
673	}
674
675
676	/**
677	* Resolves the address space handle into a real handle if it's an alias,
678	* and retains whatever it is.
679	*
680	* @returns Real address space handle. NIL_RTDBGAS if invalid handle.
681	*
682	* @param pUVM The user mode VM handle.
683	* @param hAlias The possibly address space alias.
684	*/
685	VMMR3DECL(RTDBGAS) DBGFR3AsResolveAndRetain(PUVM pUVM, RTDBGAS hAlias)
686	{
687	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NULL);
688	AssertCompileNS(NIL_RTDBGAS == (RTDBGAS)0);
689
690	uint32_t cRefs;
691	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
692	if (iAlias < DBGF_AS_COUNT)
693	{
694	if (DBGF_AS_IS_FIXED_ALIAS(hAlias))
695	{
696	/* Perform lazy address space population. */
697	if (!pUVM->dbgf.s.afAsAliasPopuplated[iAlias])
698	dbgfR3AsLazyPopulate(pUVM, hAlias);
699
700	/* Won't ever change, no need to grab the lock. */
701	hAlias = pUVM->dbgf.s.ahAsAliases[iAlias];
702	cRefs = RTDbgAsRetain(hAlias);
703	}
704	else
705	{
706	/* May change, grab the lock so we can read it safely. */
707	DBGF_AS_DB_LOCK_READ(pUVM);
708	hAlias = pUVM->dbgf.s.ahAsAliases[iAlias];
709	cRefs = RTDbgAsRetain(hAlias);
710	DBGF_AS_DB_UNLOCK_READ(pUVM);
711	}
712	}
713	else
714	/* Not an alias, just retain it. */
715	cRefs = RTDbgAsRetain(hAlias);
716
717	return cRefs != UINT32_MAX ? hAlias : NIL_RTDBGAS;
718	}
719
720
721	/**
722	* Query an address space by name.
723	*
724	* @returns Retained address space handle if found, NIL_RTDBGAS if not.
725	*
726	* @param pUVM The user mode VM handle.
727	* @param pszName The name.
728	*/
729	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByName(PUVM pUVM, const char *pszName)
730	{
731	/*
732	* Validate the input.
733	*/
734	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NIL_RTDBGAS);
735	AssertPtrReturn(pszName, NIL_RTDBGAS);
736	AssertReturn(*pszName, NIL_RTDBGAS);
737
738	/*
739	* Look it up in the string space and retain the result.
740	*/
741	RTDBGAS hDbgAs = NIL_RTDBGAS;
742	DBGF_AS_DB_LOCK_READ(pUVM);
743
744	PRTSTRSPACECORE pNode = RTStrSpaceGet(&pUVM->dbgf.s.AsNameSpace, pszName);
745	if (pNode)
746	{
747	PDBGFASDBNODE pDbNode = RT_FROM_MEMBER(pNode, DBGFASDBNODE, NameCore);
748	hDbgAs = (RTDBGAS)pDbNode->HandleCore.Key;
749	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
750	if (RT_UNLIKELY(cRefs == UINT32_MAX))
751	hDbgAs = NIL_RTDBGAS;
752	}
753
754	DBGF_AS_DB_UNLOCK_READ(pUVM);
755	return hDbgAs;
756	}
757
758
759	/**
760	* Query an address space by process ID.
761	*
762	* @returns Retained address space handle if found, NIL_RTDBGAS if not.
763	*
764	* @param pUVM The user mode VM handle.
765	* @param ProcId The process ID.
766	*/
767	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByPid(PUVM pUVM, RTPROCESS ProcId)
768	{
769	/*
770	* Validate the input.
771	*/
772	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NIL_RTDBGAS);
773	AssertReturn(ProcId != NIL_RTPROCESS, NIL_RTDBGAS);
774
775	/*
776	* Look it up in the PID tree and retain the result.
777	*/
778	RTDBGAS hDbgAs = NIL_RTDBGAS;
779	DBGF_AS_DB_LOCK_READ(pUVM);
780
781	PAVLU32NODECORE pNode = RTAvlU32Get(&pUVM->dbgf.s.AsPidTree, ProcId);
782	if (pNode)
783	{
784	PDBGFASDBNODE pDbNode = RT_FROM_MEMBER(pNode, DBGFASDBNODE, PidCore);
785	hDbgAs = (RTDBGAS)pDbNode->HandleCore.Key;
786	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
787	if (RT_UNLIKELY(cRefs == UINT32_MAX))
788	hDbgAs = NIL_RTDBGAS;
789	}
790	DBGF_AS_DB_UNLOCK_READ(pUVM);
791
792	return hDbgAs;
793	}
794
795	#if 0 /* unused */
796
797	/**
798	* Searches for the file in the path.
799	*
800	* The file is first tested without any path modification, then we walk the path
801	* looking in each directory.
802	*
803	* @returns VBox status code.
804	* @param pszFilename The file to search for.
805	* @param pszPath The search path.
806	* @param pfnOpen The open callback function.
807	* @param pvUser User argument for the callback.
808	*/
809	static int dbgfR3AsSearchPath(const char pszFilename, const char pszPath, PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
810	{
811	char szFound[RTPATH_MAX];
812
813	/* Check the filename length. */
814	size_t const cchFilename = strlen(pszFilename);
815	if (cchFilename >= sizeof(szFound))
816	return VERR_FILENAME_TOO_LONG;
817	const char *pszName = RTPathFilename(pszFilename);
818	if (!pszName)
819	return VERR_IS_A_DIRECTORY;
820	size_t const cchName = strlen(pszName);
821
822	/*
823	* Try default location first.
824	*/
825	memcpy(szFound, pszFilename, cchFilename + 1);
826	int rc = pfnOpen(szFound, pvUser);
827	if (RT_SUCCESS(rc))
828	return rc;
829
830	/*
831	* Walk the search path.
832	*/
833	const char *psz = pszPath;
834	while (*psz)
835	{
836	/* Skip leading blanks - no directories with leading spaces, thank you. */
837	while (RT_C_IS_BLANK(*psz))
838	psz++;
839
840	/* Find the end of this element. */
841	const char *pszNext;
842	const char *pszEnd = strchr(psz, ';');
843	if (!pszEnd)
844	pszEnd = pszNext = strchr(psz, '\0');
845	else
846	pszNext = pszEnd + 1;
847	if (pszEnd != psz)
848	{
849	size_t const cch = pszEnd - psz;
850	if (cch + 1 + cchName < sizeof(szFound))
851	{
852	/** @todo RTPathCompose, RTPathComposeN(). This code isn't right
853	* for 'E:' on DOS systems. It may also create unwanted double slashes. */
854	memcpy(szFound, psz, cch);
855	szFound[cch] = '/';
856	memcpy(szFound + cch + 1, pszName, cchName + 1);
857	int rc2 = pfnOpen(szFound, pvUser);
858	if (RT_SUCCESS(rc2))
859	return rc2;
860	if ( rc2 != rc
861	&& ( rc == VERR_FILE_NOT_FOUND
862	\|\| rc == VERR_OPEN_FAILED))
863	rc = rc2;
864	}
865	}
866
867	/* advance */
868	psz = pszNext;
869	}
870
871	/*
872	* Walk the path once again, this time do a depth search.
873	*/
874	/** @todo do a depth search using the specified path. */
875
876	/* failed */
877	return rc;
878	}
879
880
881	/**
882	* Same as dbgfR3AsSearchEnv, except that the path is taken from the environment.
883	*
884	* If the environment variable doesn't exist, the current directory is searched
885	* instead.
886	*
887	* @returns VBox status code.
888	* @param pszFilename The filename.
889	* @param pszEnvVar The environment variable name.
890	* @param pfnOpen The open callback function.
891	* @param pvUser User argument for the callback.
892	*/
893	static int dbgfR3AsSearchEnvPath(const char pszFilename, const char pszEnvVar, PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
894	{
895	int rc;
896	char *pszPath = RTEnvDupEx(RTENV_DEFAULT, pszEnvVar);
897	if (pszPath)
898	{
899	rc = dbgfR3AsSearchPath(pszFilename, pszPath, pfnOpen, pvUser);
900	RTStrFree(pszPath);
901	}
902	else
903	rc = dbgfR3AsSearchPath(pszFilename, ".", pfnOpen, pvUser);
904	return rc;
905	}
906
907
908	/**
909	* Same as dbgfR3AsSearchEnv, except that the path is taken from the DBGF config
910	* (CFGM).
911	*
912	* Nothing is done if the CFGM variable isn't set.
913	*
914	* @returns VBox status code.
915	* @param pUVM The user mode VM handle.
916	* @param pszFilename The filename.
917	* @param pszCfgValue The name of the config variable (under /DBGF/).
918	* @param pfnOpen The open callback function.
919	* @param pvUser User argument for the callback.
920	*/
921	static int dbgfR3AsSearchCfgPath(PUVM pUVM, const char pszFilename, const char pszCfgValue,
922	PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
923	{
924	char *pszPath;
925	int rc = CFGMR3QueryStringAllocDef(CFGMR3GetChild(CFGMR3GetRootU(pUVM), "/DBGF"), pszCfgValue, &pszPath, NULL);
926	if (RT_FAILURE(rc))
927	return rc;
928	if (!pszPath)
929	return VERR_FILE_NOT_FOUND;
930	rc = dbgfR3AsSearchPath(pszFilename, pszPath, pfnOpen, pvUser);
931	MMR3HeapFree(pszPath);
932	return rc;
933	}
934
935	#endif /* unused */
936
937
938	/**
939	* Load symbols from an executable module into the specified address space.
940	*
941	* If an module exist at the specified address it will be replaced by this
942	* call, otherwise a new module is created.
943	*
944	* @returns VBox status code.
945	*
946	* @param pUVM The user mode VM handle.
947	* @param hDbgAs The address space.
948	* @param pszFilename The filename of the executable module.
949	* @param pszModName The module name. If NULL, then then the file name
950	* base is used (no extension or nothing).
951	* @param enmArch The desired architecture, use RTLDRARCH_WHATEVER if
952	* it's not relevant or known.
953	* @param pModAddress The load address of the module.
954	* @param iModSeg The segment to load, pass NIL_RTDBGSEGIDX to load
955	* the whole image.
956	* @param fFlags For DBGFR3AsLinkModule, see RTDBGASLINK_FLAGS_*.
957	*/
958	VMMR3DECL(int) DBGFR3AsLoadImage(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName, RTLDRARCH enmArch,
959	PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags)
960	{
961	/*
962	* Validate input
963	*/
964	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
965	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
966	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
967	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
968	AssertReturn(!(fFlags & ~RTDBGASLINK_FLAGS_VALID_MASK), VERR_INVALID_PARAMETER);
969	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
970	if (hRealAS == NIL_RTDBGAS)
971	return VERR_INVALID_HANDLE;
972
973	RTDBGMOD hDbgMod;
974	int rc = RTDbgModCreateFromImage(&hDbgMod, pszFilename, pszModName, enmArch, pUVM->dbgf.s.hDbgCfg);
975	if (RT_SUCCESS(rc))
976	{
977	rc = DBGFR3AsLinkModule(pUVM, hRealAS, hDbgMod, pModAddress, iModSeg, fFlags & RTDBGASLINK_FLAGS_VALID_MASK);
978	if (RT_FAILURE(rc))
979	RTDbgModRelease(hDbgMod);
980	}
981
982	RTDbgAsRelease(hRealAS);
983	return rc;
984	}
985
986
987	/**
988	* Load symbols from a map file into a module at the specified address space.
989	*
990	* If an module exist at the specified address it will be replaced by this
991	* call, otherwise a new module is created.
992	*
993	* @returns VBox status code.
994	*
995	* @param pUVM The user mode VM handle.
996	* @param hDbgAs The address space.
997	* @param pszFilename The map file.
998	* @param pszModName The module name. If NULL, then then the file name
999	* base is used (no extension or nothing).
1000	* @param pModAddress The load address of the module.
1001	* @param iModSeg The segment to load, pass NIL_RTDBGSEGIDX to load
1002	* the whole image.
1003	* @param uSubtrahend Value to to subtract from the symbols in the map
1004	* file. This is useful for the linux System.map and
1005	* /proc/kallsyms.
1006	* @param fFlags Flags reserved for future extensions, must be 0.
1007	*/
1008	VMMR3DECL(int) DBGFR3AsLoadMap(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName,
1009	PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, RTGCUINTPTR uSubtrahend, uint32_t fFlags)
1010	{
1011	/*
1012	* Validate input
1013	*/
1014	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1015	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1016	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
1017	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
1018	AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER);
1019	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1020	if (hRealAS == NIL_RTDBGAS)
1021	return VERR_INVALID_HANDLE;
1022
1023	RTDBGMOD hDbgMod;
1024	int rc = RTDbgModCreateFromMap(&hDbgMod, pszFilename, pszModName, uSubtrahend, pUVM->dbgf.s.hDbgCfg);
1025	if (RT_SUCCESS(rc))
1026	{
1027	rc = DBGFR3AsLinkModule(pUVM, hRealAS, hDbgMod, pModAddress, iModSeg, 0);
1028	if (RT_FAILURE(rc))
1029	RTDbgModRelease(hDbgMod);
1030	}
1031
1032	RTDbgAsRelease(hRealAS);
1033	return rc;
1034	}
1035
1036
1037	/**
1038	* Wrapper around RTDbgAsModuleLink, RTDbgAsModuleLinkSeg and DBGFR3AsResolve.
1039	*
1040	* @returns VBox status code.
1041	* @param pUVM The user mode VM handle.
1042	* @param hDbgAs The address space handle.
1043	* @param hMod The module handle.
1044	* @param pModAddress The link address.
1045	* @param iModSeg The segment to link, NIL_RTDBGSEGIDX for the entire image.
1046	* @param fFlags Flags to pass to the link functions, see RTDBGASLINK_FLAGS_*.
1047	*/
1048	VMMR3DECL(int) DBGFR3AsLinkModule(PUVM pUVM, RTDBGAS hDbgAs, RTDBGMOD hMod, PCDBGFADDRESS pModAddress,
1049	RTDBGSEGIDX iModSeg, uint32_t fFlags)
1050	{
1051	/*
1052	* Input validation.
1053	*/
1054	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1055	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
1056	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1057	if (hRealAS == NIL_RTDBGAS)
1058	return VERR_INVALID_HANDLE;
1059
1060	/*
1061	* Do the job.
1062	*/
1063	int rc;
1064	if (iModSeg == NIL_RTDBGSEGIDX)
1065	rc = RTDbgAsModuleLink(hRealAS, hMod, pModAddress->FlatPtr, fFlags);
1066	else
1067	rc = RTDbgAsModuleLinkSeg(hRealAS, hMod, iModSeg, pModAddress->FlatPtr, fFlags);
1068
1069	RTDbgAsRelease(hRealAS);
1070	return rc;
1071	}
1072
1073
1074	/**
1075	* Wrapper around RTDbgAsModuleByName and RTDbgAsModuleUnlink.
1076	*
1077	* Unlinks all mappings matching the given module name.
1078	*
1079	* @returns VBox status code.
1080	* @param pUVM The user mode VM handle.
1081	* @param hDbgAs The address space handle.
1082	* @param pszModName The name of the module to unlink.
1083	*/
1084	VMMR3DECL(int) DBGFR3AsUnlinkModuleByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszModName)
1085	{
1086	/*
1087	* Input validation.
1088	*/
1089	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1090	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1091	if (hRealAS == NIL_RTDBGAS)
1092	return VERR_INVALID_HANDLE;
1093
1094	/*
1095	* Do the job.
1096	*/
1097	RTDBGMOD hMod;
1098	int rc = RTDbgAsModuleByName(hRealAS, pszModName, 0, &hMod);
1099	if (RT_SUCCESS(rc))
1100	{
1101	for (;;)
1102	{
1103	rc = RTDbgAsModuleUnlink(hRealAS, hMod);
1104	RTDbgModRelease(hMod);
1105	if (RT_FAILURE(rc))
1106	break;
1107	rc = RTDbgAsModuleByName(hRealAS, pszModName, 0, &hMod);
1108	if (RT_FAILURE_NP(rc))
1109	{
1110	if (rc == VERR_NOT_FOUND)
1111	rc = VINF_SUCCESS;
1112	break;
1113	}
1114	}
1115	}
1116
1117	RTDbgAsRelease(hRealAS);
1118	return rc;
1119	}
1120
1121
1122	/**
1123	* Adds the module name to the symbol name.
1124	*
1125	* @param pSymbol The symbol info (in/out).
1126	* @param hMod The module handle.
1127	*/
1128	static void dbgfR3AsSymbolJoinNames(PRTDBGSYMBOL pSymbol, RTDBGMOD hMod)
1129	{
1130	/* Figure the lengths, adjust them if the result is too long. */
1131	const char *pszModName = RTDbgModName(hMod);
1132	size_t cchModName = strlen(pszModName);
1133	size_t cchSymbol = strlen(pSymbol->szName);
1134	if (cchModName + 1 + cchSymbol >= sizeof(pSymbol->szName))
1135	{
1136	if (cchModName >= sizeof(pSymbol->szName) / 4)
1137	cchModName = sizeof(pSymbol->szName) / 4;
1138	if (cchModName + 1 + cchSymbol >= sizeof(pSymbol->szName))
1139	cchSymbol = sizeof(pSymbol->szName) - cchModName - 2;
1140	Assert(cchModName + 1 + cchSymbol < sizeof(pSymbol->szName));
1141	}
1142
1143	/* Do the moving and copying. */
1144	memmove(&pSymbol->szName[cchModName + 1], &pSymbol->szName[0], cchSymbol + 1);
1145	memcpy(&pSymbol->szName[0], pszModName, cchModName);
1146	pSymbol->szName[cchModName] = '!';
1147	}
1148
1149
1150	/**
1151	* Query a symbol by address.
1152	*
1153	* The returned symbol is the one we consider closes to the specified address.
1154	*
1155	* @returns VBox status code. See RTDbgAsSymbolByAddr.
1156	*
1157	* @param pUVM The user mode VM handle.
1158	* @param hDbgAs The address space handle.
1159	* @param pAddress The address to lookup.
1160	* @param fFlags One of the RTDBGSYMADDR_FLAGS_XXX flags.
1161	* @param poffDisp Where to return the distance between the returned
1162	* symbol and pAddress. Optional.
1163	* @param pSymbol Where to return the symbol information. The returned
1164	* symbol name will be prefixed by the module name as
1165	* far as space allows.
1166	* @param phMod Where to return the module handle. Optional.
1167	*/
1168	VMMR3DECL(int) DBGFR3AsSymbolByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1169	PRTGCINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod)
1170	{
1171	/*
1172	* Implement the special address space aliases the lazy way.
1173	*/
1174	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1175	{
1176	int rc = DBGFR3AsSymbolByAddr(pUVM, DBGF_AS_RC, pAddress, fFlags, poffDisp, pSymbol, phMod);
1177	if (RT_FAILURE(rc))
1178	rc = DBGFR3AsSymbolByAddr(pUVM, DBGF_AS_GLOBAL, pAddress, fFlags, poffDisp, pSymbol, phMod);
1179	return rc;
1180	}
1181
1182	/*
1183	* Input validation.
1184	*/
1185	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1186	AssertReturn(DBGFR3AddrIsValid(pUVM, pAddress), VERR_INVALID_PARAMETER);
1187	AssertPtrNullReturn(poffDisp, VERR_INVALID_POINTER);
1188	AssertPtrReturn(pSymbol, VERR_INVALID_POINTER);
1189	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1190	if (poffDisp)
1191	*poffDisp = 0;
1192	if (phMod)
1193	*phMod = NIL_RTDBGMOD;
1194	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1195	if (hRealAS == NIL_RTDBGAS)
1196	return VERR_INVALID_HANDLE;
1197
1198	/*
1199	* Do the lookup.
1200	*/
1201	RTDBGMOD hMod;
1202	int rc = RTDbgAsSymbolByAddr(hRealAS, pAddress->FlatPtr, fFlags, poffDisp, pSymbol, &hMod);
1203	if (RT_SUCCESS(rc))
1204	{
1205	dbgfR3AsSymbolJoinNames(pSymbol, hMod);
1206	if (!phMod)
1207	RTDbgModRelease(hMod);
1208	else
1209	*phMod = hMod;
1210	}
1211
1212	RTDbgAsRelease(hRealAS);
1213	return rc;
1214	}
1215
1216
1217	/**
1218	* Convenience function that combines RTDbgSymbolDup and DBGFR3AsSymbolByAddr.
1219	*
1220	* @returns Pointer to the symbol on success. This must be free using
1221	* RTDbgSymbolFree(). NULL is returned if not found or any error
1222	* occurs.
1223	*
1224	* @param pUVM The user mode VM handle.
1225	* @param hDbgAs See DBGFR3AsSymbolByAddr.
1226	* @param pAddress See DBGFR3AsSymbolByAddr.
1227	* @param fFlags See DBGFR3AsSymbolByAddr.
1228	* @param poffDisp See DBGFR3AsSymbolByAddr.
1229	* @param phMod See DBGFR3AsSymbolByAddr.
1230	*/
1231	VMMR3DECL(PRTDBGSYMBOL) DBGFR3AsSymbolByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1232	PRTGCINTPTR poffDisp, PRTDBGMOD phMod)
1233	{
1234	RTDBGSYMBOL SymInfo;
1235	int rc = DBGFR3AsSymbolByAddr(pUVM, hDbgAs, pAddress, fFlags, poffDisp, &SymInfo, phMod);
1236	if (RT_SUCCESS(rc))
1237	return RTDbgSymbolDup(&SymInfo);
1238	return NULL;
1239	}
1240
1241
1242	/**
1243	* Query a symbol by name.
1244	*
1245	* The symbol can be prefixed by a module name pattern to scope the search. The
1246	* pattern is a simple string pattern with '*' and '?' as wild chars. See
1247	* RTStrSimplePatternMatch().
1248	*
1249	* @returns VBox status code. See RTDbgAsSymbolByAddr.
1250	*
1251	* @param pUVM The user mode VM handle.
1252	* @param hDbgAs The address space handle.
1253	* @param pszSymbol The symbol to search for, maybe prefixed by a
1254	* module pattern.
1255	* @param pSymbol Where to return the symbol information.
1256	* The returned symbol name will be prefixed by
1257	* the module name as far as space allows.
1258	* @param phMod Where to return the module handle. Optional.
1259	*/
1260	VMMR3DECL(int) DBGFR3AsSymbolByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszSymbol,
1261	PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod)
1262	{
1263	/*
1264	* Implement the special address space aliases the lazy way.
1265	*/
1266	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1267	{
1268	int rc = DBGFR3AsSymbolByName(pUVM, DBGF_AS_RC, pszSymbol, pSymbol, phMod);
1269	if (RT_FAILURE(rc))
1270	rc = DBGFR3AsSymbolByName(pUVM, DBGF_AS_GLOBAL, pszSymbol, pSymbol, phMod);
1271	return rc;
1272	}
1273
1274	/*
1275	* Input validation.
1276	*/
1277	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1278	AssertPtrReturn(pSymbol, VERR_INVALID_POINTER);
1279	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1280	if (phMod)
1281	*phMod = NIL_RTDBGMOD;
1282	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1283	if (hRealAS == NIL_RTDBGAS)
1284	return VERR_INVALID_HANDLE;
1285
1286
1287	/*
1288	* Do the lookup.
1289	*/
1290	RTDBGMOD hMod;
1291	int rc = RTDbgAsSymbolByName(hRealAS, pszSymbol, pSymbol, &hMod);
1292	if (RT_SUCCESS(rc))
1293	{
1294	dbgfR3AsSymbolJoinNames(pSymbol, hMod);
1295	if (!phMod)
1296	RTDbgModRelease(hMod);
1297	}
1298
1299	RTDbgAsRelease(hRealAS);
1300	return rc;
1301	}
1302
1303
1304	VMMR3DECL(int) DBGFR3AsLineByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1305	PRTGCINTPTR poffDisp, PRTDBGLINE pLine, PRTDBGMOD phMod)
1306	{
1307	/*
1308	* Implement the special address space aliases the lazy way.
1309	*/
1310	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1311	{
1312	int rc = DBGFR3AsLineByAddr(pUVM, DBGF_AS_RC, pAddress, poffDisp, pLine, phMod);
1313	if (RT_FAILURE(rc))
1314	rc = DBGFR3AsLineByAddr(pUVM, DBGF_AS_GLOBAL, pAddress, poffDisp, pLine, phMod);
1315	return rc;
1316	}
1317
1318	/*
1319	* Input validation.
1320	*/
1321	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1322	AssertReturn(DBGFR3AddrIsValid(pUVM, pAddress), VERR_INVALID_PARAMETER);
1323	AssertPtrNullReturn(poffDisp, VERR_INVALID_POINTER);
1324	AssertPtrReturn(pLine, VERR_INVALID_POINTER);
1325	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1326	if (poffDisp)
1327	*poffDisp = 0;
1328	if (phMod)
1329	*phMod = NIL_RTDBGMOD;
1330	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1331	if (hRealAS == NIL_RTDBGAS)
1332	return VERR_INVALID_HANDLE;
1333
1334	/*
1335	* Do the lookup.
1336	*/
1337	int rc = RTDbgAsLineByAddr(hRealAS, pAddress->FlatPtr, poffDisp, pLine, phMod);
1338
1339	RTDbgAsRelease(hRealAS);
1340	return rc;
1341	}
1342
1343
1344	VMMR3DECL(PRTDBGLINE) DBGFR3AsLineByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1345	PRTGCINTPTR poffDisp, PRTDBGMOD phMod)
1346	{
1347	RTDBGLINE Line;
1348	int rc = DBGFR3AsLineByAddr(pUVM, hDbgAs, pAddress, poffDisp, &Line, phMod);
1349	if (RT_SUCCESS(rc))
1350	return RTDbgLineDup(&Line);
1351	return NULL;
1352	}
1353

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/VMM/VMMR3/DBGFAddrSpace.cpp@ 93115

Download in other formats: