DBGFAddrSpace.cpp@ 63495

Last change on this file since 63495 was 62637, checked in by vboxsync, 8 years ago
VMMR3: warnings
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 45.1 KB

Line
1	/* $Id: DBGFAddrSpace.cpp 62637 2016-07-28 17:12:17Z vboxsync $ */
2	/** @file
3	* DBGF - Debugger Facility, Address Space Management.
4	*/
5
6	/*
7	* Copyright (C) 2008-2016 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	#ifdef VBOX_WITH_RAW_MODE
46	# include <VBox/vmm/patm.h>
47	#endif
48	#include "DBGFInternal.h"
49	#include <VBox/vmm/uvm.h>
50	#include <VBox/vmm/vm.h>
51	#include <VBox/err.h>
52	#include <VBox/log.h>
53
54	#include <iprt/asm.h>
55	#include <iprt/assert.h>
56	#include <iprt/ctype.h>
57	#include <iprt/env.h>
58	#include <iprt/mem.h>
59	#include <iprt/path.h>
60	#include <iprt/param.h>
61
62
63	/*********************************************************************************************************************************
64	* Structures and Typedefs *
65	*********************************************************************************************************************************/
66	/**
67	* Address space database node.
68	*/
69	typedef struct DBGFASDBNODE
70	{
71	/** The node core for DBGF::AsHandleTree, the key is the address space handle. */
72	AVLPVNODECORE HandleCore;
73	/** The node core for DBGF::AsPidTree, the key is the process id. */
74	AVLU32NODECORE PidCore;
75	/** The node core for DBGF::AsNameSpace, the string is the address space name. */
76	RTSTRSPACECORE NameCore;
77
78	} DBGFASDBNODE;
79	/** Pointer to an address space database node. */
80	typedef DBGFASDBNODE *PDBGFASDBNODE;
81
82
83	/**
84	* For dbgfR3AsLoadImageOpenData and dbgfR3AsLoadMapOpenData.
85	*/
86	typedef struct DBGFR3ASLOADOPENDATA
87	{
88	const char *pszModName;
89	RTGCUINTPTR uSubtrahend;
90	uint32_t fFlags;
91	RTDBGMOD hMod;
92	} DBGFR3ASLOADOPENDATA;
93
94	#if 0 /* unused */
95	/**
96	* Callback for dbgfR3AsSearchPath and dbgfR3AsSearchEnvPath.
97	*
98	* @returns VBox status code. If success, then the search is completed.
99	* @param pszFilename The file name under evaluation.
100	* @param pvUser The user argument.
101	*/
102	typedef int FNDBGFR3ASSEARCHOPEN(const char pszFilename, void pvUser);
103	/** Pointer to a FNDBGFR3ASSEARCHOPEN. */
104	typedef FNDBGFR3ASSEARCHOPEN *PFNDBGFR3ASSEARCHOPEN;
105	#endif
106
107
108	/*********************************************************************************************************************************
109	* Defined Constants And Macros *
110	*********************************************************************************************************************************/
111	/** Locks the address space database for writing. */
112	#define DBGF_AS_DB_LOCK_WRITE(pUVM) \
113	do { \
114	int rcSem = RTSemRWRequestWrite((pUVM)->dbgf.s.hAsDbLock, RT_INDEFINITE_WAIT); \
115	AssertRC(rcSem); \
116	} while (0)
117
118	/** Unlocks the address space database after writing. */
119	#define DBGF_AS_DB_UNLOCK_WRITE(pUVM) \
120	do { \
121	int rcSem = RTSemRWReleaseWrite((pUVM)->dbgf.s.hAsDbLock); \
122	AssertRC(rcSem); \
123	} while (0)
124
125	/** Locks the address space database for reading. */
126	#define DBGF_AS_DB_LOCK_READ(pUVM) \
127	do { \
128	int rcSem = RTSemRWRequestRead((pUVM)->dbgf.s.hAsDbLock, RT_INDEFINITE_WAIT); \
129	AssertRC(rcSem); \
130	} while (0)
131
132	/** Unlocks the address space database after reading. */
133	#define DBGF_AS_DB_UNLOCK_READ(pUVM) \
134	do { \
135	int rcSem = RTSemRWReleaseRead((pUVM)->dbgf.s.hAsDbLock); \
136	AssertRC(rcSem); \
137	} while (0)
138
139
140
141	/**
142	* Initializes the address space parts of DBGF.
143	*
144	* @returns VBox status code.
145	* @param pUVM The user mode VM handle.
146	*/
147	int dbgfR3AsInit(PUVM pUVM)
148	{
149	Assert(pUVM->pVM);
150
151	/*
152	* Create the semaphore.
153	*/
154	int rc = RTSemRWCreate(&pUVM->dbgf.s.hAsDbLock);
155	AssertRCReturn(rc, rc);
156
157	/*
158	* Create the debugging config instance and set it up, defaulting to
159	* deferred loading in order to keep things fast.
160	*/
161	rc = RTDbgCfgCreate(&pUVM->dbgf.s.hDbgCfg, NULL, true /fNativePaths/);
162	AssertRCReturn(rc, rc);
163	rc = RTDbgCfgChangeUInt(pUVM->dbgf.s.hDbgCfg, RTDBGCFGPROP_FLAGS, RTDBGCFGOP_PREPEND,
164	RTDBGCFG_FLAGS_DEFERRED);
165	AssertRCReturn(rc, rc);
166
167	static struct
168	{
169	RTDBGCFGPROP enmProp;
170	const char *pszEnvName;
171	const char *pszCfgName;
172	} const s_aProps[] =
173	{
174	{ RTDBGCFGPROP_FLAGS, "VBOXDBG_FLAGS", "Flags" },
175	{ RTDBGCFGPROP_PATH, "VBOXDBG_PATH", "Path" },
176	{ RTDBGCFGPROP_SUFFIXES, "VBOXDBG_SUFFIXES", "Suffixes" },
177	{ RTDBGCFGPROP_SRC_PATH, "VBOXDBG_SRC_PATH", "SrcPath" },
178	};
179	PCFGMNODE pCfgDbgf = CFGMR3GetChild(CFGMR3GetRootU(pUVM), "/DBGF");
180	for (unsigned i = 0; i < RT_ELEMENTS(s_aProps); i++)
181	{
182	char szEnvValue[8192];
183	rc = RTEnvGetEx(RTENV_DEFAULT, s_aProps[i].pszEnvName, szEnvValue, sizeof(szEnvValue), NULL);
184	if (RT_SUCCESS(rc))
185	{
186	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, s_aProps[i].enmProp, RTDBGCFGOP_PREPEND, szEnvValue);
187	if (RT_FAILURE(rc))
188	return VMR3SetError(pUVM, rc, RT_SRC_POS,
189	"DBGF Config Error: %s=%s -> %Rrc", s_aProps[i].pszEnvName, szEnvValue, rc);
190	}
191	else if (rc != VERR_ENV_VAR_NOT_FOUND)
192	return VMR3SetError(pUVM, rc, RT_SRC_POS,
193	"DBGF Config Error: Error querying env.var. %s: %Rrc", s_aProps[i].pszEnvName, rc);
194
195	char *pszCfgValue;
196	rc = CFGMR3QueryStringAllocDef(pCfgDbgf, s_aProps[i].pszCfgName, &pszCfgValue, NULL);
197	if (RT_FAILURE(rc))
198	return VMR3SetError(pUVM, rc, RT_SRC_POS,
199	"DBGF Config Error: Querying /DBGF/%s -> %Rrc", s_aProps[i].pszCfgName, rc);
200	if (pszCfgValue)
201	{
202	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, s_aProps[i].enmProp, RTDBGCFGOP_PREPEND, pszCfgValue);
203	if (RT_FAILURE(rc))
204	return VMR3SetError(pUVM, rc, RT_SRC_POS,
205	"DBGF Config Error: /DBGF/%s=%s -> %Rrc", s_aProps[i].pszCfgName, pszCfgValue, rc);
206	}
207	}
208
209	/*
210	* Prepend the NoArch and VBoxDbgSyms directories to the path.
211	*/
212	char szPath[RTPATH_MAX];
213	rc = RTPathAppPrivateNoArch(szPath, sizeof(szPath));
214	AssertRCReturn(rc, rc);
215	#ifdef RT_OS_DARWIN
216	rc = RTPathAppend(szPath, sizeof(szPath), "../Resources/VBoxDbgSyms/");
217	#else
218	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, RTDBGCFGPROP_PATH, RTDBGCFGOP_PREPEND, szPath);
219	AssertRCReturn(rc, rc);
220
221	rc = RTPathAppend(szPath, sizeof(szPath), "VBoxDbgSyms/");
222	#endif
223	AssertRCReturn(rc, rc);
224	rc = RTDbgCfgChangeString(pUVM->dbgf.s.hDbgCfg, RTDBGCFGPROP_PATH, RTDBGCFGOP_PREPEND, szPath);
225	AssertRCReturn(rc, rc);
226
227	/*
228	* Create the standard address spaces.
229	*/
230	RTDBGAS hDbgAs;
231	rc = RTDbgAsCreate(&hDbgAs, 0, RTGCPTR_MAX, "Global");
232	AssertRCReturn(rc, rc);
233	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
234	AssertRCReturn(rc, rc);
235	RTDbgAsRetain(hDbgAs);
236	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_GLOBAL)] = hDbgAs;
237
238	RTDbgAsRetain(hDbgAs);
239	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_KERNEL)] = hDbgAs;
240
241	rc = RTDbgAsCreate(&hDbgAs, 0, RTGCPHYS_MAX, "Physical");
242	AssertRCReturn(rc, rc);
243	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
244	AssertRCReturn(rc, rc);
245	RTDbgAsRetain(hDbgAs);
246	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_PHYS)] = hDbgAs;
247
248	rc = RTDbgAsCreate(&hDbgAs, 0, RTRCPTR_MAX, "HyperRawMode");
249	AssertRCReturn(rc, rc);
250	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
251	AssertRCReturn(rc, rc);
252	RTDbgAsRetain(hDbgAs);
253	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_RC)] = hDbgAs;
254	RTDbgAsRetain(hDbgAs);
255	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_RC_AND_GC_GLOBAL)] = hDbgAs;
256
257	rc = RTDbgAsCreate(&hDbgAs, 0, RTR0PTR_MAX, "HyperRing0");
258	AssertRCReturn(rc, rc);
259	rc = DBGFR3AsAdd(pUVM, hDbgAs, NIL_RTPROCESS);
260	AssertRCReturn(rc, rc);
261	RTDbgAsRetain(hDbgAs);
262	pUVM->dbgf.s.ahAsAliases[DBGF_AS_ALIAS_2_INDEX(DBGF_AS_R0)] = hDbgAs;
263
264	return VINF_SUCCESS;
265	}
266
267
268	/**
269	* Callback used by dbgfR3AsTerm / RTAvlPVDestroy to release an address space.
270	*
271	* @returns 0.
272	* @param pNode The address space database node.
273	* @param pvIgnore NULL.
274	*/
275	static DECLCALLBACK(int) dbgfR3AsTermDestroyNode(PAVLPVNODECORE pNode, void *pvIgnore)
276	{
277	PDBGFASDBNODE pDbNode = (PDBGFASDBNODE)pNode;
278	RTDbgAsRelease((RTDBGAS)pDbNode->HandleCore.Key);
279	pDbNode->HandleCore.Key = NIL_RTDBGAS;
280	/* Don't bother freeing it here as MM will free it soon and MM is much at
281	it when doing it wholesale instead of piecemeal. */
282	NOREF(pvIgnore);
283	return 0;
284	}
285
286
287	/**
288	* Terminates the address space parts of DBGF.
289	*
290	* @param pUVM The user mode VM handle.
291	*/
292	void dbgfR3AsTerm(PUVM pUVM)
293	{
294	/*
295	* Create the semaphore.
296	*/
297	int rc = RTSemRWDestroy(pUVM->dbgf.s.hAsDbLock);
298	AssertRC(rc);
299	pUVM->dbgf.s.hAsDbLock = NIL_RTSEMRW;
300
301	/*
302	* Release all the address spaces.
303	*/
304	RTAvlPVDestroy(&pUVM->dbgf.s.AsHandleTree, dbgfR3AsTermDestroyNode, NULL);
305	for (size_t i = 0; i < RT_ELEMENTS(pUVM->dbgf.s.ahAsAliases); i++)
306	{
307	RTDbgAsRelease(pUVM->dbgf.s.ahAsAliases[i]);
308	pUVM->dbgf.s.ahAsAliases[i] = NIL_RTDBGAS;
309	}
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 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 has 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	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
560
561	return rc;
562	}
563
564
565	/**
566	* @callback_method_impl{FNPDMR3ENUM}
567	*/
568	static DECLCALLBACK(int) dbgfR3AsLazyPopulateR0Callback(PVM pVM, const char pszFilename, const char pszName,
569	RTUINTPTR ImageBase, size_t cbImage, PDMLDRCTX enmCtx, void *pvArg)
570	{
571	NOREF(pVM); NOREF(cbImage);
572
573	/* Only ring-0 modules. */
574	if (enmCtx == PDMLDRCTX_RING_0)
575	{
576	RTDBGMOD hDbgMod;
577	int rc = RTDbgModCreateFromImage(&hDbgMod, pszFilename, pszName, RTLDRARCH_HOST, pVM->pUVM->dbgf.s.hDbgCfg);
578	if (RT_SUCCESS(rc))
579	{
580	rc = RTDbgAsModuleLink((RTDBGAS)pvArg, hDbgMod, ImageBase, 0 /fFlags/);
581	if (RT_FAILURE(rc))
582	LogRel(("DBGF: Failed to link module \"%s\" into DBGF_AS_R0 at %RTptr: %Rrc\n",
583	pszName, ImageBase, rc));
584	}
585	else
586	LogRel(("DBGF: RTDbgModCreateFromImage failed with rc=%Rrc for module \"%s\" (%s)\n",
587	rc, pszName, pszFilename));
588	}
589	return VINF_SUCCESS;
590	}
591
592
593	/**
594	* @callback_method_impl{FNPDMR3ENUM}
595	*/
596	static DECLCALLBACK(int) dbgfR3AsLazyPopulateRCCallback(PVM pVM, const char pszFilename, const char pszName,
597	RTUINTPTR ImageBase, size_t cbImage, PDMLDRCTX enmCtx, void *pvArg)
598	{
599	NOREF(pVM); NOREF(cbImage);
600
601	/* Only raw-mode modules. */
602	if (enmCtx == PDMLDRCTX_RAW_MODE)
603	{
604	RTDBGMOD hDbgMod;
605	int rc = RTDbgModCreateFromImage(&hDbgMod, pszFilename, pszName, RTLDRARCH_X86_32, pVM->pUVM->dbgf.s.hDbgCfg);
606	if (RT_SUCCESS(rc))
607	{
608	rc = RTDbgAsModuleLink((RTDBGAS)pvArg, hDbgMod, ImageBase, 0 /fFlags/);
609	if (RT_FAILURE(rc))
610	LogRel(("DBGF: Failed to link module \"%s\" into DBGF_AS_RC at %RTptr: %Rrc\n",
611	pszName, ImageBase, rc));
612	}
613	else
614	LogRel(("DBGF: RTDbgModCreateFromImage failed with rc=%Rrc for module \"%s\" (%s)\n",
615	rc, pszName, pszFilename));
616	}
617	return VINF_SUCCESS;
618	}
619
620
621	/**
622	* Lazily populates the specified address space.
623	*
624	* @param pUVM The user mode VM handle.
625	* @param hAlias The alias.
626	*/
627	static void dbgfR3AsLazyPopulate(PUVM pUVM, RTDBGAS hAlias)
628	{
629	DBGF_AS_DB_LOCK_WRITE(pUVM);
630	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
631	if (!pUVM->dbgf.s.afAsAliasPopuplated[iAlias])
632	{
633	RTDBGAS hDbgAs = pUVM->dbgf.s.ahAsAliases[iAlias];
634	if (hAlias == DBGF_AS_R0 && pUVM->pVM)
635	PDMR3LdrEnumModules(pUVM->pVM, dbgfR3AsLazyPopulateR0Callback, hDbgAs);
636	else if (hAlias == DBGF_AS_RC && pUVM->pVM && !HMIsEnabled(pUVM->pVM))
637	{
638	LogRel(("DBGF: Lazy init of RC address space\n"));
639	PDMR3LdrEnumModules(pUVM->pVM, dbgfR3AsLazyPopulateRCCallback, hDbgAs);
640	#ifdef VBOX_WITH_RAW_MODE
641	PATMR3DbgPopulateAddrSpace(pUVM->pVM, hDbgAs);
642	#endif
643	}
644	else if (hAlias == DBGF_AS_PHYS && pUVM->pVM)
645	{
646	/** @todo Lazy load pc and vga bios symbols or the EFI stuff. */
647	}
648
649	pUVM->dbgf.s.afAsAliasPopuplated[iAlias] = true;
650	}
651	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
652	}
653
654
655	/**
656	* Resolves the address space handle into a real handle if it's an alias.
657	*
658	* @returns Real address space handle. NIL_RTDBGAS if invalid handle.
659	*
660	* @param pUVM The user mode VM handle.
661	* @param hAlias The possibly address space alias.
662	*
663	* @remarks Doesn't take any locks.
664	*/
665	VMMR3DECL(RTDBGAS) DBGFR3AsResolve(PUVM pUVM, RTDBGAS hAlias)
666	{
667	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NULL);
668	AssertCompileNS(NIL_RTDBGAS == (RTDBGAS)0);
669
670	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
671	if (iAlias < DBGF_AS_COUNT)
672	ASMAtomicReadHandle(&pUVM->dbgf.s.ahAsAliases[iAlias], &hAlias);
673	return hAlias;
674	}
675
676
677	/**
678	* Resolves the address space handle into a real handle if it's an alias,
679	* and retains whatever it is.
680	*
681	* @returns Real address space handle. NIL_RTDBGAS if invalid handle.
682	*
683	* @param pUVM The user mode VM handle.
684	* @param hAlias The possibly address space alias.
685	*/
686	VMMR3DECL(RTDBGAS) DBGFR3AsResolveAndRetain(PUVM pUVM, RTDBGAS hAlias)
687	{
688	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NULL);
689	AssertCompileNS(NIL_RTDBGAS == (RTDBGAS)0);
690
691	uint32_t cRefs;
692	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
693	if (iAlias < DBGF_AS_COUNT)
694	{
695	if (DBGF_AS_IS_FIXED_ALIAS(hAlias))
696	{
697	/* Perform lazy address space population. */
698	if (!pUVM->dbgf.s.afAsAliasPopuplated[iAlias])
699	dbgfR3AsLazyPopulate(pUVM, hAlias);
700
701	/* Won't ever change, no need to grab the lock. */
702	hAlias = pUVM->dbgf.s.ahAsAliases[iAlias];
703	cRefs = RTDbgAsRetain(hAlias);
704	}
705	else
706	{
707	/* May change, grab the lock so we can read it safely. */
708	DBGF_AS_DB_LOCK_READ(pUVM);
709	hAlias = pUVM->dbgf.s.ahAsAliases[iAlias];
710	cRefs = RTDbgAsRetain(hAlias);
711	DBGF_AS_DB_UNLOCK_READ(pUVM);
712	}
713	}
714	else
715	/* Not an alias, just retain it. */
716	cRefs = RTDbgAsRetain(hAlias);
717
718	return cRefs != UINT32_MAX ? hAlias : NIL_RTDBGAS;
719	}
720
721
722	/**
723	* Query an address space by name.
724	*
725	* @returns Retained address space handle if found, NIL_RTDBGAS if not.
726	*
727	* @param pUVM The user mode VM handle.
728	* @param pszName The name.
729	*/
730	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByName(PUVM pUVM, const char *pszName)
731	{
732	/*
733	* Validate the input.
734	*/
735	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NIL_RTDBGAS);
736	AssertPtrReturn(pszName, NIL_RTDBGAS);
737	AssertReturn(*pszName, NIL_RTDBGAS);
738
739	/*
740	* Look it up in the string space and retain the result.
741	*/
742	RTDBGAS hDbgAs = NIL_RTDBGAS;
743	DBGF_AS_DB_LOCK_READ(pUVM);
744
745	PRTSTRSPACECORE pNode = RTStrSpaceGet(&pUVM->dbgf.s.AsNameSpace, pszName);
746	if (pNode)
747	{
748	PDBGFASDBNODE pDbNode = RT_FROM_MEMBER(pNode, DBGFASDBNODE, NameCore);
749	hDbgAs = (RTDBGAS)pDbNode->HandleCore.Key;
750	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
751	if (RT_UNLIKELY(cRefs == UINT32_MAX))
752	hDbgAs = NIL_RTDBGAS;
753	}
754
755	DBGF_AS_DB_UNLOCK_READ(pUVM);
756	return hDbgAs;
757	}
758
759
760	/**
761	* Query an address space by process ID.
762	*
763	* @returns Retained address space handle if found, NIL_RTDBGAS if not.
764	*
765	* @param pUVM The user mode VM handle.
766	* @param ProcId The process ID.
767	*/
768	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByPid(PUVM pUVM, RTPROCESS ProcId)
769	{
770	/*
771	* Validate the input.
772	*/
773	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NIL_RTDBGAS);
774	AssertReturn(ProcId != NIL_RTPROCESS, NIL_RTDBGAS);
775
776	/*
777	* Look it up in the PID tree and retain the result.
778	*/
779	RTDBGAS hDbgAs = NIL_RTDBGAS;
780	DBGF_AS_DB_LOCK_READ(pUVM);
781
782	PAVLU32NODECORE pNode = RTAvlU32Get(&pUVM->dbgf.s.AsPidTree, ProcId);
783	if (pNode)
784	{
785	PDBGFASDBNODE pDbNode = RT_FROM_MEMBER(pNode, DBGFASDBNODE, PidCore);
786	hDbgAs = (RTDBGAS)pDbNode->HandleCore.Key;
787	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
788	if (RT_UNLIKELY(cRefs == UINT32_MAX))
789	hDbgAs = NIL_RTDBGAS;
790	}
791	DBGF_AS_DB_UNLOCK_READ(pUVM);
792
793	return hDbgAs;
794	}
795
796	#if 0 /* unused */
797
798	/**
799	* Searches for the file in the path.
800	*
801	* The file is first tested without any path modification, then we walk the path
802	* looking in each directory.
803	*
804	* @returns VBox status code.
805	* @param pszFilename The file to search for.
806	* @param pszPath The search path.
807	* @param pfnOpen The open callback function.
808	* @param pvUser User argument for the callback.
809	*/
810	static int dbgfR3AsSearchPath(const char pszFilename, const char pszPath, PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
811	{
812	char szFound[RTPATH_MAX];
813
814	/* Check the filename length. */
815	size_t const cchFilename = strlen(pszFilename);
816	if (cchFilename >= sizeof(szFound))
817	return VERR_FILENAME_TOO_LONG;
818	const char *pszName = RTPathFilename(pszFilename);
819	if (!pszName)
820	return VERR_IS_A_DIRECTORY;
821	size_t const cchName = strlen(pszName);
822
823	/*
824	* Try default location first.
825	*/
826	memcpy(szFound, pszFilename, cchFilename + 1);
827	int rc = pfnOpen(szFound, pvUser);
828	if (RT_SUCCESS(rc))
829	return rc;
830
831	/*
832	* Walk the search path.
833	*/
834	const char *psz = pszPath;
835	while (*psz)
836	{
837	/* Skip leading blanks - no directories with leading spaces, thank you. */
838	while (RT_C_IS_BLANK(*psz))
839	psz++;
840
841	/* Find the end of this element. */
842	const char *pszNext;
843	const char *pszEnd = strchr(psz, ';');
844	if (!pszEnd)
845	pszEnd = pszNext = strchr(psz, '\0');
846	else
847	pszNext = pszEnd + 1;
848	if (pszEnd != psz)
849	{
850	size_t const cch = pszEnd - psz;
851	if (cch + 1 + cchName < sizeof(szFound))
852	{
853	/** @todo RTPathCompose, RTPathComposeN(). This code isn't right
854	* for 'E:' on DOS systems. It may also create unwanted double slashes. */
855	memcpy(szFound, psz, cch);
856	szFound[cch] = '/';
857	memcpy(szFound + cch + 1, pszName, cchName + 1);
858	int rc2 = pfnOpen(szFound, pvUser);
859	if (RT_SUCCESS(rc2))
860	return rc2;
861	if ( rc2 != rc
862	&& ( rc == VERR_FILE_NOT_FOUND
863	\|\| rc == VERR_OPEN_FAILED))
864	rc = rc2;
865	}
866	}
867
868	/* advance */
869	psz = pszNext;
870	}
871
872	/*
873	* Walk the path once again, this time do a depth search.
874	*/
875	/** @todo do a depth search using the specified path. */
876
877	/* failed */
878	return rc;
879	}
880
881
882	/**
883	* Same as dbgfR3AsSearchEnv, except that the path is taken from the environment.
884	*
885	* If the environment variable doesn't exist, the current directory is searched
886	* instead.
887	*
888	* @returns VBox status code.
889	* @param pszFilename The filename.
890	* @param pszEnvVar The environment variable name.
891	* @param pfnOpen The open callback function.
892	* @param pvUser User argument for the callback.
893	*/
894	static int dbgfR3AsSearchEnvPath(const char pszFilename, const char pszEnvVar, PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
895	{
896	int rc;
897	char *pszPath = RTEnvDupEx(RTENV_DEFAULT, pszEnvVar);
898	if (pszPath)
899	{
900	rc = dbgfR3AsSearchPath(pszFilename, pszPath, pfnOpen, pvUser);
901	RTStrFree(pszPath);
902	}
903	else
904	rc = dbgfR3AsSearchPath(pszFilename, ".", pfnOpen, pvUser);
905	return rc;
906	}
907
908
909	/**
910	* Same as dbgfR3AsSearchEnv, except that the path is taken from the DBGF config
911	* (CFGM).
912	*
913	* Nothing is done if the CFGM variable isn't set.
914	*
915	* @returns VBox status code.
916	* @param pUVM The user mode VM handle.
917	* @param pszFilename The filename.
918	* @param pszCfgValue The name of the config variable (under /DBGF/).
919	* @param pfnOpen The open callback function.
920	* @param pvUser User argument for the callback.
921	*/
922	static int dbgfR3AsSearchCfgPath(PUVM pUVM, const char pszFilename, const char pszCfgValue,
923	PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
924	{
925	char *pszPath;
926	int rc = CFGMR3QueryStringAllocDef(CFGMR3GetChild(CFGMR3GetRootU(pUVM), "/DBGF"), pszCfgValue, &pszPath, NULL);
927	if (RT_FAILURE(rc))
928	return rc;
929	if (!pszPath)
930	return VERR_FILE_NOT_FOUND;
931	rc = dbgfR3AsSearchPath(pszFilename, pszPath, pfnOpen, pvUser);
932	MMR3HeapFree(pszPath);
933	return rc;
934	}
935
936	#endif /* unused */
937
938
939	/**
940	* Load symbols from an executable module into the specified address space.
941	*
942	* If an module exist at the specified address it will be replaced by this
943	* call, otherwise a new module is created.
944	*
945	* @returns VBox status code.
946	*
947	* @param pUVM The user mode VM handle.
948	* @param hDbgAs The address space.
949	* @param pszFilename The filename of the executable module.
950	* @param pszModName The module name. If NULL, then then the file name
951	* base is used (no extension or nothing).
952	* @param enmArch The desired architecture, use RTLDRARCH_WHATEVER if
953	* it's not relevant or known.
954	* @param pModAddress The load address of the module.
955	* @param iModSeg The segment to load, pass NIL_RTDBGSEGIDX to load
956	* the whole image.
957	* @param fFlags Flags reserved for future extensions, must be 0.
958	*/
959	VMMR3DECL(int) DBGFR3AsLoadImage(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName, RTLDRARCH enmArch,
960	PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags)
961	{
962	/*
963	* Validate input
964	*/
965	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
966	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
967	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
968	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
969	AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER);
970	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
971	if (hRealAS == NIL_RTDBGAS)
972	return VERR_INVALID_HANDLE;
973
974	RTDBGMOD hDbgMod;
975	int rc = RTDbgModCreateFromImage(&hDbgMod, pszFilename, pszModName, enmArch, pUVM->dbgf.s.hDbgCfg);
976	if (RT_SUCCESS(rc))
977	{
978	rc = DBGFR3AsLinkModule(pUVM, hRealAS, hDbgMod, pModAddress, iModSeg, 0);
979	if (RT_FAILURE(rc))
980	RTDbgModRelease(hDbgMod);
981	}
982
983	RTDbgAsRelease(hRealAS);
984	return rc;
985	}
986
987
988	/**
989	* Load symbols from a map file into a module at the specified address space.
990	*
991	* If an module exist at the specified address it will be replaced by this
992	* call, otherwise a new module is created.
993	*
994	* @returns VBox status code.
995	*
996	* @param pUVM The user mode VM handle.
997	* @param hDbgAs The address space.
998	* @param pszFilename The map file.
999	* @param pszModName The module name. If NULL, then then the file name
1000	* base is used (no extension or nothing).
1001	* @param pModAddress The load address of the module.
1002	* @param iModSeg The segment to load, pass NIL_RTDBGSEGIDX to load
1003	* the whole image.
1004	* @param uSubtrahend Value to to subtract from the symbols in the map
1005	* file. This is useful for the linux System.map and
1006	* /proc/kallsyms.
1007	* @param fFlags Flags reserved for future extensions, must be 0.
1008	*/
1009	VMMR3DECL(int) DBGFR3AsLoadMap(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName,
1010	PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, RTGCUINTPTR uSubtrahend, uint32_t fFlags)
1011	{
1012	/*
1013	* Validate input
1014	*/
1015	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1016	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1017	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
1018	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
1019	AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER);
1020	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1021	if (hRealAS == NIL_RTDBGAS)
1022	return VERR_INVALID_HANDLE;
1023
1024	RTDBGMOD hDbgMod;
1025	int rc = RTDbgModCreateFromMap(&hDbgMod, pszFilename, pszModName, uSubtrahend, pUVM->dbgf.s.hDbgCfg);
1026	if (RT_SUCCESS(rc))
1027	{
1028	rc = DBGFR3AsLinkModule(pUVM, hRealAS, hDbgMod, pModAddress, iModSeg, 0);
1029	if (RT_FAILURE(rc))
1030	RTDbgModRelease(hDbgMod);
1031	}
1032
1033	RTDbgAsRelease(hRealAS);
1034	return rc;
1035	}
1036
1037
1038	/**
1039	* Wrapper around RTDbgAsModuleLink, RTDbgAsModuleLinkSeg and DBGFR3AsResolve.
1040	*
1041	* @returns VBox status code.
1042	* @param pUVM The user mode VM handle.
1043	* @param hDbgAs The address space handle.
1044	* @param hMod The module handle.
1045	* @param pModAddress The link address.
1046	* @param iModSeg The segment to link, NIL_RTDBGSEGIDX for the entire image.
1047	* @param fFlags Flags to pass to the link functions, see RTDBGASLINK_FLAGS_*.
1048	*/
1049	VMMR3DECL(int) DBGFR3AsLinkModule(PUVM pUVM, RTDBGAS hDbgAs, RTDBGMOD hMod, PCDBGFADDRESS pModAddress,
1050	RTDBGSEGIDX iModSeg, uint32_t fFlags)
1051	{
1052	/*
1053	* Input validation.
1054	*/
1055	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1056	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
1057	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1058	if (hRealAS == NIL_RTDBGAS)
1059	return VERR_INVALID_HANDLE;
1060
1061	/*
1062	* Do the job.
1063	*/
1064	int rc;
1065	if (iModSeg == NIL_RTDBGSEGIDX)
1066	rc = RTDbgAsModuleLink(hRealAS, hMod, pModAddress->FlatPtr, fFlags);
1067	else
1068	rc = RTDbgAsModuleLinkSeg(hRealAS, hMod, iModSeg, pModAddress->FlatPtr, fFlags);
1069
1070	RTDbgAsRelease(hRealAS);
1071	return rc;
1072	}
1073
1074
1075	/**
1076	* Wrapper around RTDbgAsModuleByName and RTDbgAsModuleUnlink.
1077	*
1078	* Unlinks all mappings matching the given module name.
1079	*
1080	* @returns VBox status code.
1081	* @param pUVM The user mode VM handle.
1082	* @param hDbgAs The address space handle.
1083	* @param pszModName The name of the module to unlink.
1084	*/
1085	VMMR3DECL(int) DBGFR3AsUnlinkModuleByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszModName)
1086	{
1087	/*
1088	* Input validation.
1089	*/
1090	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1091	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1092	if (hRealAS == NIL_RTDBGAS)
1093	return VERR_INVALID_HANDLE;
1094
1095	/*
1096	* Do the job.
1097	*/
1098	RTDBGMOD hMod;
1099	int rc = RTDbgAsModuleByName(hRealAS, pszModName, 0, &hMod);
1100	if (RT_SUCCESS(rc))
1101	{
1102	for (;;)
1103	{
1104	rc = RTDbgAsModuleUnlink(hRealAS, hMod);
1105	RTDbgModRelease(hMod);
1106	if (RT_FAILURE(rc))
1107	break;
1108	rc = RTDbgAsModuleByName(hRealAS, pszModName, 0, &hMod);
1109	if (RT_FAILURE_NP(rc))
1110	{
1111	if (rc == VERR_NOT_FOUND)
1112	rc = VINF_SUCCESS;
1113	break;
1114	}
1115	}
1116	}
1117
1118	RTDbgAsRelease(hRealAS);
1119	return rc;
1120	}
1121
1122
1123	/**
1124	* Adds the module name to the symbol name.
1125	*
1126	* @param pSymbol The symbol info (in/out).
1127	* @param hMod The module handle.
1128	*/
1129	static void dbgfR3AsSymbolJoinNames(PRTDBGSYMBOL pSymbol, RTDBGMOD hMod)
1130	{
1131	/* Figure the lengths, adjust them if the result is too long. */
1132	const char *pszModName = RTDbgModName(hMod);
1133	size_t cchModName = strlen(pszModName);
1134	size_t cchSymbol = strlen(pSymbol->szName);
1135	if (cchModName + 1 + cchSymbol >= sizeof(pSymbol->szName))
1136	{
1137	if (cchModName >= sizeof(pSymbol->szName) / 4)
1138	cchModName = sizeof(pSymbol->szName) / 4;
1139	if (cchModName + 1 + cchSymbol >= sizeof(pSymbol->szName))
1140	cchSymbol = sizeof(pSymbol->szName) - cchModName - 2;
1141	Assert(cchModName + 1 + cchSymbol < sizeof(pSymbol->szName));
1142	}
1143
1144	/* Do the moving and copying. */
1145	memmove(&pSymbol->szName[cchModName + 1], &pSymbol->szName[0], cchSymbol + 1);
1146	memcpy(&pSymbol->szName[0], pszModName, cchModName);
1147	pSymbol->szName[cchModName] = '!';
1148	}
1149
1150
1151	/**
1152	* Query a symbol by address.
1153	*
1154	* The returned symbol is the one we consider closes to the specified address.
1155	*
1156	* @returns VBox status code. See RTDbgAsSymbolByAddr.
1157	*
1158	* @param pUVM The user mode VM handle.
1159	* @param hDbgAs The address space handle.
1160	* @param pAddress The address to lookup.
1161	* @param fFlags One of the RTDBGSYMADDR_FLAGS_XXX flags.
1162	* @param poffDisp Where to return the distance between the returned
1163	* symbol and pAddress. Optional.
1164	* @param pSymbol Where to return the symbol information. The returned
1165	* symbol name will be prefixed by the module name as
1166	* far as space allows.
1167	* @param phMod Where to return the module handle. Optional.
1168	*/
1169	VMMR3DECL(int) DBGFR3AsSymbolByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1170	PRTGCINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod)
1171	{
1172	/*
1173	* Implement the special address space aliases the lazy way.
1174	*/
1175	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1176	{
1177	int rc = DBGFR3AsSymbolByAddr(pUVM, DBGF_AS_RC, pAddress, fFlags, poffDisp, pSymbol, phMod);
1178	if (RT_FAILURE(rc))
1179	rc = DBGFR3AsSymbolByAddr(pUVM, DBGF_AS_GLOBAL, pAddress, fFlags, poffDisp, pSymbol, phMod);
1180	return rc;
1181	}
1182
1183	/*
1184	* Input validation.
1185	*/
1186	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1187	AssertReturn(DBGFR3AddrIsValid(pUVM, pAddress), VERR_INVALID_PARAMETER);
1188	AssertPtrNullReturn(poffDisp, VERR_INVALID_POINTER);
1189	AssertPtrReturn(pSymbol, VERR_INVALID_POINTER);
1190	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1191	if (poffDisp)
1192	*poffDisp = 0;
1193	if (phMod)
1194	*phMod = NIL_RTDBGMOD;
1195	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1196	if (hRealAS == NIL_RTDBGAS)
1197	return VERR_INVALID_HANDLE;
1198
1199	/*
1200	* Do the lookup.
1201	*/
1202	RTDBGMOD hMod;
1203	int rc = RTDbgAsSymbolByAddr(hRealAS, pAddress->FlatPtr, fFlags, poffDisp, pSymbol, &hMod);
1204	if (RT_SUCCESS(rc))
1205	{
1206	dbgfR3AsSymbolJoinNames(pSymbol, hMod);
1207	if (!phMod)
1208	RTDbgModRelease(hMod);
1209	}
1210
1211	return rc;
1212	}
1213
1214
1215	/**
1216	* Convenience function that combines RTDbgSymbolDup and DBGFR3AsSymbolByAddr.
1217	*
1218	* @returns Pointer to the symbol on success. This must be free using
1219	* RTDbgSymbolFree(). NULL is returned if not found or any error
1220	* occurs.
1221	*
1222	* @param pUVM The user mode VM handle.
1223	* @param hDbgAs See DBGFR3AsSymbolByAddr.
1224	* @param pAddress See DBGFR3AsSymbolByAddr.
1225	* @param fFlags See DBGFR3AsSymbolByAddr.
1226	* @param poffDisp See DBGFR3AsSymbolByAddr.
1227	* @param phMod See DBGFR3AsSymbolByAddr.
1228	*/
1229	VMMR3DECL(PRTDBGSYMBOL) DBGFR3AsSymbolByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1230	PRTGCINTPTR poffDisp, PRTDBGMOD phMod)
1231	{
1232	RTDBGSYMBOL SymInfo;
1233	int rc = DBGFR3AsSymbolByAddr(pUVM, hDbgAs, pAddress, fFlags, poffDisp, &SymInfo, phMod);
1234	if (RT_SUCCESS(rc))
1235	return RTDbgSymbolDup(&SymInfo);
1236	return NULL;
1237	}
1238
1239
1240	/**
1241	* Query a symbol by name.
1242	*
1243	* The symbol can be prefixed by a module name pattern to scope the search. The
1244	* pattern is a simple string pattern with '*' and '?' as wild chars. See
1245	* RTStrSimplePatternMatch().
1246	*
1247	* @returns VBox status code. See RTDbgAsSymbolByAddr.
1248	*
1249	* @param pUVM The user mode VM handle.
1250	* @param hDbgAs The address space handle.
1251	* @param pszSymbol The symbol to search for, maybe prefixed by a
1252	* module pattern.
1253	* @param pSymbol Where to return the symbol information.
1254	* The returned symbol name will be prefixed by
1255	* the module name as far as space allows.
1256	* @param phMod Where to return the module handle. Optional.
1257	*/
1258	VMMR3DECL(int) DBGFR3AsSymbolByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszSymbol,
1259	PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod)
1260	{
1261	/*
1262	* Implement the special address space aliases the lazy way.
1263	*/
1264	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1265	{
1266	int rc = DBGFR3AsSymbolByName(pUVM, DBGF_AS_RC, pszSymbol, pSymbol, phMod);
1267	if (RT_FAILURE(rc))
1268	rc = DBGFR3AsSymbolByName(pUVM, DBGF_AS_GLOBAL, pszSymbol, pSymbol, phMod);
1269	return rc;
1270	}
1271
1272	/*
1273	* Input validation.
1274	*/
1275	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1276	AssertPtrReturn(pSymbol, VERR_INVALID_POINTER);
1277	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1278	if (phMod)
1279	*phMod = NIL_RTDBGMOD;
1280	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1281	if (hRealAS == NIL_RTDBGAS)
1282	return VERR_INVALID_HANDLE;
1283
1284
1285	/*
1286	* Do the lookup.
1287	*/
1288	RTDBGMOD hMod;
1289	int rc = RTDbgAsSymbolByName(hRealAS, pszSymbol, pSymbol, &hMod);
1290	if (RT_SUCCESS(rc))
1291	{
1292	dbgfR3AsSymbolJoinNames(pSymbol, hMod);
1293	if (!phMod)
1294	RTDbgModRelease(hMod);
1295	}
1296
1297	return rc;
1298	}
1299
1300
1301	VMMR3DECL(int) DBGFR3AsLineByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1302	PRTGCINTPTR poffDisp, PRTDBGLINE pLine, PRTDBGMOD phMod)
1303	{
1304	/*
1305	* Implement the special address space aliases the lazy way.
1306	*/
1307	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1308	{
1309	int rc = DBGFR3AsLineByAddr(pUVM, DBGF_AS_RC, pAddress, poffDisp, pLine, phMod);
1310	if (RT_FAILURE(rc))
1311	rc = DBGFR3AsLineByAddr(pUVM, DBGF_AS_GLOBAL, pAddress, poffDisp, pLine, phMod);
1312	return rc;
1313	}
1314
1315	/*
1316	* Input validation.
1317	*/
1318	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1319	AssertReturn(DBGFR3AddrIsValid(pUVM, pAddress), VERR_INVALID_PARAMETER);
1320	AssertPtrNullReturn(poffDisp, VERR_INVALID_POINTER);
1321	AssertPtrReturn(pLine, VERR_INVALID_POINTER);
1322	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1323	if (poffDisp)
1324	*poffDisp = 0;
1325	if (phMod)
1326	*phMod = NIL_RTDBGMOD;
1327	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1328	if (hRealAS == NIL_RTDBGAS)
1329	return VERR_INVALID_HANDLE;
1330
1331	/*
1332	* Do the lookup.
1333	*/
1334	return RTDbgAsLineByAddr(hRealAS, pAddress->FlatPtr, poffDisp, pLine, phMod);
1335	}
1336
1337
1338	VMMR3DECL(PRTDBGLINE) DBGFR3AsLineByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1339	PRTGCINTPTR poffDisp, PRTDBGMOD phMod)
1340	{
1341	RTDBGLINE Line;
1342	int rc = DBGFR3AsLineByAddr(pUVM, hDbgAs, pAddress, poffDisp, &Line, phMod);
1343	if (RT_SUCCESS(rc))
1344	return RTDbgLineDup(&Line);
1345	return NULL;
1346	}
1347

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

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

Download in other formats: