DBGFAddrSpace.cpp@ 93901

Last change on this file since 93901 was 93901, checked in by vboxsync, 3 years ago
VMM,Main,++: Removed VM_IS_RAW_MODE_ENABLED/VM_EXEC_ENGINE_RAW_MODE and added VM_IS_EXEC_ENGINE_IEM/VM_EXEC_ENGINE_IEM instead. In IMachineDebugger::getExecutionEngine VMExecutionEngine_RawMode was removed and VMExecutionEngine_Emulated added. Removed dead code and updated frontends accordingly. On darwin.arm64 HM now falls back on IEM execution since neither HM or NEM is availble there. bugref:9898
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 45.4 KB

Line
1	/* $Id: DBGFAddrSpace.cpp 93901 2022-02-23 15:35:26Z 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.215389.xyz. 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	#ifdef VBOX_WITH_RAW_MODE_KEEP /* needs fixing */
639	else if (hAlias == DBGF_AS_RC && pUVM->pVM && VM_IS_RAW_MODE_ENABLED(pUVM->pVM))
640	{
641	LogRel(("DBGF: Lazy init of RC address space\n"));
642	PDMR3LdrEnumModules(pUVM->pVM, dbgfR3AsLazyPopulateRCCallback, hDbgAs);
643	}
644	#endif
645	else if (hAlias == DBGF_AS_PHYS && pUVM->pVM)
646	{
647	/** @todo Lazy load pc and vga bios symbols or the EFI stuff. */
648	}
649
650	pUVM->dbgf.s.afAsAliasPopuplated[iAlias] = true;
651	}
652	DBGF_AS_DB_UNLOCK_WRITE(pUVM);
653	}
654
655
656	/**
657	* Resolves the address space handle into a real handle if it's an alias.
658	*
659	* @returns Real address space handle. NIL_RTDBGAS if invalid handle.
660	*
661	* @param pUVM The user mode VM handle.
662	* @param hAlias The possibly address space alias.
663	*
664	* @remarks Doesn't take any locks.
665	*/
666	VMMR3DECL(RTDBGAS) DBGFR3AsResolve(PUVM pUVM, RTDBGAS hAlias)
667	{
668	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NULL);
669	AssertCompileNS(NIL_RTDBGAS == (RTDBGAS)0);
670
671	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
672	if (iAlias < DBGF_AS_COUNT)
673	ASMAtomicReadHandle(&pUVM->dbgf.s.ahAsAliases[iAlias], &hAlias);
674	return hAlias;
675	}
676
677
678	/**
679	* Resolves the address space handle into a real handle if it's an alias,
680	* and retains whatever it is.
681	*
682	* @returns Real address space handle. NIL_RTDBGAS if invalid handle.
683	*
684	* @param pUVM The user mode VM handle.
685	* @param hAlias The possibly address space alias.
686	*/
687	VMMR3DECL(RTDBGAS) DBGFR3AsResolveAndRetain(PUVM pUVM, RTDBGAS hAlias)
688	{
689	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NULL);
690	AssertCompileNS(NIL_RTDBGAS == (RTDBGAS)0);
691
692	uint32_t cRefs;
693	uintptr_t iAlias = DBGF_AS_ALIAS_2_INDEX(hAlias);
694	if (iAlias < DBGF_AS_COUNT)
695	{
696	if (DBGF_AS_IS_FIXED_ALIAS(hAlias))
697	{
698	/* Perform lazy address space population. */
699	if (!pUVM->dbgf.s.afAsAliasPopuplated[iAlias])
700	dbgfR3AsLazyPopulate(pUVM, hAlias);
701
702	/* Won't ever change, no need to grab the lock. */
703	hAlias = pUVM->dbgf.s.ahAsAliases[iAlias];
704	cRefs = RTDbgAsRetain(hAlias);
705	}
706	else
707	{
708	/* May change, grab the lock so we can read it safely. */
709	DBGF_AS_DB_LOCK_READ(pUVM);
710	hAlias = pUVM->dbgf.s.ahAsAliases[iAlias];
711	cRefs = RTDbgAsRetain(hAlias);
712	DBGF_AS_DB_UNLOCK_READ(pUVM);
713	}
714	}
715	else
716	/* Not an alias, just retain it. */
717	cRefs = RTDbgAsRetain(hAlias);
718
719	return cRefs != UINT32_MAX ? hAlias : NIL_RTDBGAS;
720	}
721
722
723	/**
724	* Query an address space by name.
725	*
726	* @returns Retained address space handle if found, NIL_RTDBGAS if not.
727	*
728	* @param pUVM The user mode VM handle.
729	* @param pszName The name.
730	*/
731	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByName(PUVM pUVM, const char *pszName)
732	{
733	/*
734	* Validate the input.
735	*/
736	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NIL_RTDBGAS);
737	AssertPtrReturn(pszName, NIL_RTDBGAS);
738	AssertReturn(*pszName, NIL_RTDBGAS);
739
740	/*
741	* Look it up in the string space and retain the result.
742	*/
743	RTDBGAS hDbgAs = NIL_RTDBGAS;
744	DBGF_AS_DB_LOCK_READ(pUVM);
745
746	PRTSTRSPACECORE pNode = RTStrSpaceGet(&pUVM->dbgf.s.AsNameSpace, pszName);
747	if (pNode)
748	{
749	PDBGFASDBNODE pDbNode = RT_FROM_MEMBER(pNode, DBGFASDBNODE, NameCore);
750	hDbgAs = (RTDBGAS)pDbNode->HandleCore.Key;
751	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
752	if (RT_UNLIKELY(cRefs == UINT32_MAX))
753	hDbgAs = NIL_RTDBGAS;
754	}
755
756	DBGF_AS_DB_UNLOCK_READ(pUVM);
757	return hDbgAs;
758	}
759
760
761	/**
762	* Query an address space by process ID.
763	*
764	* @returns Retained address space handle if found, NIL_RTDBGAS if not.
765	*
766	* @param pUVM The user mode VM handle.
767	* @param ProcId The process ID.
768	*/
769	VMMR3DECL(RTDBGAS) DBGFR3AsQueryByPid(PUVM pUVM, RTPROCESS ProcId)
770	{
771	/*
772	* Validate the input.
773	*/
774	UVM_ASSERT_VALID_EXT_RETURN(pUVM, NIL_RTDBGAS);
775	AssertReturn(ProcId != NIL_RTPROCESS, NIL_RTDBGAS);
776
777	/*
778	* Look it up in the PID tree and retain the result.
779	*/
780	RTDBGAS hDbgAs = NIL_RTDBGAS;
781	DBGF_AS_DB_LOCK_READ(pUVM);
782
783	PAVLU32NODECORE pNode = RTAvlU32Get(&pUVM->dbgf.s.AsPidTree, ProcId);
784	if (pNode)
785	{
786	PDBGFASDBNODE pDbNode = RT_FROM_MEMBER(pNode, DBGFASDBNODE, PidCore);
787	hDbgAs = (RTDBGAS)pDbNode->HandleCore.Key;
788	uint32_t cRefs = RTDbgAsRetain(hDbgAs);
789	if (RT_UNLIKELY(cRefs == UINT32_MAX))
790	hDbgAs = NIL_RTDBGAS;
791	}
792	DBGF_AS_DB_UNLOCK_READ(pUVM);
793
794	return hDbgAs;
795	}
796
797	#if 0 /* unused */
798
799	/**
800	* Searches for the file in the path.
801	*
802	* The file is first tested without any path modification, then we walk the path
803	* looking in each directory.
804	*
805	* @returns VBox status code.
806	* @param pszFilename The file to search for.
807	* @param pszPath The search path.
808	* @param pfnOpen The open callback function.
809	* @param pvUser User argument for the callback.
810	*/
811	static int dbgfR3AsSearchPath(const char pszFilename, const char pszPath, PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
812	{
813	char szFound[RTPATH_MAX];
814
815	/* Check the filename length. */
816	size_t const cchFilename = strlen(pszFilename);
817	if (cchFilename >= sizeof(szFound))
818	return VERR_FILENAME_TOO_LONG;
819	const char *pszName = RTPathFilename(pszFilename);
820	if (!pszName)
821	return VERR_IS_A_DIRECTORY;
822	size_t const cchName = strlen(pszName);
823
824	/*
825	* Try default location first.
826	*/
827	memcpy(szFound, pszFilename, cchFilename + 1);
828	int rc = pfnOpen(szFound, pvUser);
829	if (RT_SUCCESS(rc))
830	return rc;
831
832	/*
833	* Walk the search path.
834	*/
835	const char *psz = pszPath;
836	while (*psz)
837	{
838	/* Skip leading blanks - no directories with leading spaces, thank you. */
839	while (RT_C_IS_BLANK(*psz))
840	psz++;
841
842	/* Find the end of this element. */
843	const char *pszNext;
844	const char *pszEnd = strchr(psz, ';');
845	if (!pszEnd)
846	pszEnd = pszNext = strchr(psz, '\0');
847	else
848	pszNext = pszEnd + 1;
849	if (pszEnd != psz)
850	{
851	size_t const cch = pszEnd - psz;
852	if (cch + 1 + cchName < sizeof(szFound))
853	{
854	/** @todo RTPathCompose, RTPathComposeN(). This code isn't right
855	* for 'E:' on DOS systems. It may also create unwanted double slashes. */
856	memcpy(szFound, psz, cch);
857	szFound[cch] = '/';
858	memcpy(szFound + cch + 1, pszName, cchName + 1);
859	int rc2 = pfnOpen(szFound, pvUser);
860	if (RT_SUCCESS(rc2))
861	return rc2;
862	if ( rc2 != rc
863	&& ( rc == VERR_FILE_NOT_FOUND
864	\|\| rc == VERR_OPEN_FAILED))
865	rc = rc2;
866	}
867	}
868
869	/* advance */
870	psz = pszNext;
871	}
872
873	/*
874	* Walk the path once again, this time do a depth search.
875	*/
876	/** @todo do a depth search using the specified path. */
877
878	/* failed */
879	return rc;
880	}
881
882
883	/**
884	* Same as dbgfR3AsSearchEnv, except that the path is taken from the environment.
885	*
886	* If the environment variable doesn't exist, the current directory is searched
887	* instead.
888	*
889	* @returns VBox status code.
890	* @param pszFilename The filename.
891	* @param pszEnvVar The environment variable name.
892	* @param pfnOpen The open callback function.
893	* @param pvUser User argument for the callback.
894	*/
895	static int dbgfR3AsSearchEnvPath(const char pszFilename, const char pszEnvVar, PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
896	{
897	int rc;
898	char *pszPath = RTEnvDupEx(RTENV_DEFAULT, pszEnvVar);
899	if (pszPath)
900	{
901	rc = dbgfR3AsSearchPath(pszFilename, pszPath, pfnOpen, pvUser);
902	RTStrFree(pszPath);
903	}
904	else
905	rc = dbgfR3AsSearchPath(pszFilename, ".", pfnOpen, pvUser);
906	return rc;
907	}
908
909
910	/**
911	* Same as dbgfR3AsSearchEnv, except that the path is taken from the DBGF config
912	* (CFGM).
913	*
914	* Nothing is done if the CFGM variable isn't set.
915	*
916	* @returns VBox status code.
917	* @param pUVM The user mode VM handle.
918	* @param pszFilename The filename.
919	* @param pszCfgValue The name of the config variable (under /DBGF/).
920	* @param pfnOpen The open callback function.
921	* @param pvUser User argument for the callback.
922	*/
923	static int dbgfR3AsSearchCfgPath(PUVM pUVM, const char pszFilename, const char pszCfgValue,
924	PFNDBGFR3ASSEARCHOPEN pfnOpen, void *pvUser)
925	{
926	char *pszPath;
927	int rc = CFGMR3QueryStringAllocDef(CFGMR3GetChild(CFGMR3GetRootU(pUVM), "/DBGF"), pszCfgValue, &pszPath, NULL);
928	if (RT_FAILURE(rc))
929	return rc;
930	if (!pszPath)
931	return VERR_FILE_NOT_FOUND;
932	rc = dbgfR3AsSearchPath(pszFilename, pszPath, pfnOpen, pvUser);
933	MMR3HeapFree(pszPath);
934	return rc;
935	}
936
937	#endif /* unused */
938
939
940	/**
941	* Load symbols from an executable module into the specified address space.
942	*
943	* If an module exist at the specified address it will be replaced by this
944	* call, otherwise a new module is created.
945	*
946	* @returns VBox status code.
947	*
948	* @param pUVM The user mode VM handle.
949	* @param hDbgAs The address space.
950	* @param pszFilename The filename of the executable module.
951	* @param pszModName The module name. If NULL, then then the file name
952	* base is used (no extension or nothing).
953	* @param enmArch The desired architecture, use RTLDRARCH_WHATEVER if
954	* it's not relevant or known.
955	* @param pModAddress The load address of the module.
956	* @param iModSeg The segment to load, pass NIL_RTDBGSEGIDX to load
957	* the whole image.
958	* @param fFlags For DBGFR3AsLinkModule, see RTDBGASLINK_FLAGS_*.
959	*/
960	VMMR3DECL(int) DBGFR3AsLoadImage(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName, RTLDRARCH enmArch,
961	PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, uint32_t fFlags)
962	{
963	/*
964	* Validate input
965	*/
966	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
967	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
968	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
969	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
970	AssertReturn(!(fFlags & ~RTDBGASLINK_FLAGS_VALID_MASK), VERR_INVALID_PARAMETER);
971	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
972	if (hRealAS == NIL_RTDBGAS)
973	return VERR_INVALID_HANDLE;
974
975	RTDBGMOD hDbgMod;
976	int rc = RTDbgModCreateFromImage(&hDbgMod, pszFilename, pszModName, enmArch, pUVM->dbgf.s.hDbgCfg);
977	if (RT_SUCCESS(rc))
978	{
979	rc = DBGFR3AsLinkModule(pUVM, hRealAS, hDbgMod, pModAddress, iModSeg, fFlags & RTDBGASLINK_FLAGS_VALID_MASK);
980	if (RT_FAILURE(rc))
981	RTDbgModRelease(hDbgMod);
982	}
983
984	RTDbgAsRelease(hRealAS);
985	return rc;
986	}
987
988
989	/**
990	* Load symbols from a map file into a module at the specified address space.
991	*
992	* If an module exist at the specified address it will be replaced by this
993	* call, otherwise a new module is created.
994	*
995	* @returns VBox status code.
996	*
997	* @param pUVM The user mode VM handle.
998	* @param hDbgAs The address space.
999	* @param pszFilename The map file.
1000	* @param pszModName The module name. If NULL, then then the file name
1001	* base is used (no extension or nothing).
1002	* @param pModAddress The load address of the module.
1003	* @param iModSeg The segment to load, pass NIL_RTDBGSEGIDX to load
1004	* the whole image.
1005	* @param uSubtrahend Value to to subtract from the symbols in the map
1006	* file. This is useful for the linux System.map and
1007	* /proc/kallsyms.
1008	* @param fFlags Flags reserved for future extensions, must be 0.
1009	*/
1010	VMMR3DECL(int) DBGFR3AsLoadMap(PUVM pUVM, RTDBGAS hDbgAs, const char pszFilename, const char pszModName,
1011	PCDBGFADDRESS pModAddress, RTDBGSEGIDX iModSeg, RTGCUINTPTR uSubtrahend, uint32_t fFlags)
1012	{
1013	/*
1014	* Validate input
1015	*/
1016	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1017	AssertPtrReturn(pszFilename, VERR_INVALID_POINTER);
1018	AssertReturn(*pszFilename, VERR_INVALID_PARAMETER);
1019	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
1020	AssertReturn(fFlags == 0, VERR_INVALID_PARAMETER);
1021	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1022	if (hRealAS == NIL_RTDBGAS)
1023	return VERR_INVALID_HANDLE;
1024
1025	RTDBGMOD hDbgMod;
1026	int rc = RTDbgModCreateFromMap(&hDbgMod, pszFilename, pszModName, uSubtrahend, pUVM->dbgf.s.hDbgCfg);
1027	if (RT_SUCCESS(rc))
1028	{
1029	rc = DBGFR3AsLinkModule(pUVM, hRealAS, hDbgMod, pModAddress, iModSeg, 0);
1030	if (RT_FAILURE(rc))
1031	RTDbgModRelease(hDbgMod);
1032	}
1033
1034	RTDbgAsRelease(hRealAS);
1035	return rc;
1036	}
1037
1038
1039	/**
1040	* Wrapper around RTDbgAsModuleLink, RTDbgAsModuleLinkSeg and DBGFR3AsResolve.
1041	*
1042	* @returns VBox status code.
1043	* @param pUVM The user mode VM handle.
1044	* @param hDbgAs The address space handle.
1045	* @param hMod The module handle.
1046	* @param pModAddress The link address.
1047	* @param iModSeg The segment to link, NIL_RTDBGSEGIDX for the entire image.
1048	* @param fFlags Flags to pass to the link functions, see RTDBGASLINK_FLAGS_*.
1049	*/
1050	VMMR3DECL(int) DBGFR3AsLinkModule(PUVM pUVM, RTDBGAS hDbgAs, RTDBGMOD hMod, PCDBGFADDRESS pModAddress,
1051	RTDBGSEGIDX iModSeg, uint32_t fFlags)
1052	{
1053	/*
1054	* Input validation.
1055	*/
1056	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1057	AssertReturn(DBGFR3AddrIsValid(pUVM, pModAddress), VERR_INVALID_PARAMETER);
1058	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1059	if (hRealAS == NIL_RTDBGAS)
1060	return VERR_INVALID_HANDLE;
1061
1062	/*
1063	* Do the job.
1064	*/
1065	int rc;
1066	if (iModSeg == NIL_RTDBGSEGIDX)
1067	rc = RTDbgAsModuleLink(hRealAS, hMod, pModAddress->FlatPtr, fFlags);
1068	else
1069	rc = RTDbgAsModuleLinkSeg(hRealAS, hMod, iModSeg, pModAddress->FlatPtr, fFlags);
1070
1071	RTDbgAsRelease(hRealAS);
1072	return rc;
1073	}
1074
1075
1076	/**
1077	* Wrapper around RTDbgAsModuleByName and RTDbgAsModuleUnlink.
1078	*
1079	* Unlinks all mappings matching the given module name.
1080	*
1081	* @returns VBox status code.
1082	* @param pUVM The user mode VM handle.
1083	* @param hDbgAs The address space handle.
1084	* @param pszModName The name of the module to unlink.
1085	*/
1086	VMMR3DECL(int) DBGFR3AsUnlinkModuleByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszModName)
1087	{
1088	/*
1089	* Input validation.
1090	*/
1091	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1092	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1093	if (hRealAS == NIL_RTDBGAS)
1094	return VERR_INVALID_HANDLE;
1095
1096	/*
1097	* Do the job.
1098	*/
1099	RTDBGMOD hMod;
1100	int rc = RTDbgAsModuleByName(hRealAS, pszModName, 0, &hMod);
1101	if (RT_SUCCESS(rc))
1102	{
1103	for (;;)
1104	{
1105	rc = RTDbgAsModuleUnlink(hRealAS, hMod);
1106	RTDbgModRelease(hMod);
1107	if (RT_FAILURE(rc))
1108	break;
1109	rc = RTDbgAsModuleByName(hRealAS, pszModName, 0, &hMod);
1110	if (RT_FAILURE_NP(rc))
1111	{
1112	if (rc == VERR_NOT_FOUND)
1113	rc = VINF_SUCCESS;
1114	break;
1115	}
1116	}
1117	}
1118
1119	RTDbgAsRelease(hRealAS);
1120	return rc;
1121	}
1122
1123
1124	/**
1125	* Adds the module name to the symbol name.
1126	*
1127	* @param pSymbol The symbol info (in/out).
1128	* @param hMod The module handle.
1129	*/
1130	static void dbgfR3AsSymbolJoinNames(PRTDBGSYMBOL pSymbol, RTDBGMOD hMod)
1131	{
1132	/* Figure the lengths, adjust them if the result is too long. */
1133	const char *pszModName = RTDbgModName(hMod);
1134	size_t cchModName = strlen(pszModName);
1135	size_t cchSymbol = strlen(pSymbol->szName);
1136	if (cchModName + 1 + cchSymbol >= sizeof(pSymbol->szName))
1137	{
1138	if (cchModName >= sizeof(pSymbol->szName) / 4)
1139	cchModName = sizeof(pSymbol->szName) / 4;
1140	if (cchModName + 1 + cchSymbol >= sizeof(pSymbol->szName))
1141	cchSymbol = sizeof(pSymbol->szName) - cchModName - 2;
1142	Assert(cchModName + 1 + cchSymbol < sizeof(pSymbol->szName));
1143	}
1144
1145	/* Do the moving and copying. */
1146	memmove(&pSymbol->szName[cchModName + 1], &pSymbol->szName[0], cchSymbol + 1);
1147	memcpy(&pSymbol->szName[0], pszModName, cchModName);
1148	pSymbol->szName[cchModName] = '!';
1149	}
1150
1151
1152	/**
1153	* Query a symbol by address.
1154	*
1155	* The returned symbol is the one we consider closes to the specified address.
1156	*
1157	* @returns VBox status code. See RTDbgAsSymbolByAddr.
1158	*
1159	* @param pUVM The user mode VM handle.
1160	* @param hDbgAs The address space handle.
1161	* @param pAddress The address to lookup.
1162	* @param fFlags One of the RTDBGSYMADDR_FLAGS_XXX flags.
1163	* @param poffDisp Where to return the distance between the returned
1164	* symbol and pAddress. Optional.
1165	* @param pSymbol Where to return the symbol information. The returned
1166	* symbol name will be prefixed by the module name as
1167	* far as space allows.
1168	* @param phMod Where to return the module handle. Optional.
1169	*/
1170	VMMR3DECL(int) DBGFR3AsSymbolByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1171	PRTGCINTPTR poffDisp, PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod)
1172	{
1173	/*
1174	* Implement the special address space aliases the lazy way.
1175	*/
1176	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1177	{
1178	int rc = DBGFR3AsSymbolByAddr(pUVM, DBGF_AS_RC, pAddress, fFlags, poffDisp, pSymbol, phMod);
1179	if (RT_FAILURE(rc))
1180	rc = DBGFR3AsSymbolByAddr(pUVM, DBGF_AS_GLOBAL, pAddress, fFlags, poffDisp, pSymbol, phMod);
1181	return rc;
1182	}
1183
1184	/*
1185	* Input validation.
1186	*/
1187	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1188	AssertReturn(DBGFR3AddrIsValid(pUVM, pAddress), VERR_INVALID_PARAMETER);
1189	AssertPtrNullReturn(poffDisp, VERR_INVALID_POINTER);
1190	AssertPtrReturn(pSymbol, VERR_INVALID_POINTER);
1191	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1192	if (poffDisp)
1193	*poffDisp = 0;
1194	if (phMod)
1195	*phMod = NIL_RTDBGMOD;
1196	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1197	if (hRealAS == NIL_RTDBGAS)
1198	return VERR_INVALID_HANDLE;
1199
1200	/*
1201	* Do the lookup.
1202	*/
1203	RTDBGMOD hMod;
1204	int rc = RTDbgAsSymbolByAddr(hRealAS, pAddress->FlatPtr, fFlags, poffDisp, pSymbol, &hMod);
1205	if (RT_SUCCESS(rc))
1206	{
1207	dbgfR3AsSymbolJoinNames(pSymbol, hMod);
1208	if (!phMod)
1209	RTDbgModRelease(hMod);
1210	else
1211	*phMod = hMod;
1212	}
1213
1214	RTDbgAsRelease(hRealAS);
1215	return rc;
1216	}
1217
1218
1219	/**
1220	* Convenience function that combines RTDbgSymbolDup and DBGFR3AsSymbolByAddr.
1221	*
1222	* @returns Pointer to the symbol on success. This must be free using
1223	* RTDbgSymbolFree(). NULL is returned if not found or any error
1224	* occurs.
1225	*
1226	* @param pUVM The user mode VM handle.
1227	* @param hDbgAs See DBGFR3AsSymbolByAddr.
1228	* @param pAddress See DBGFR3AsSymbolByAddr.
1229	* @param fFlags See DBGFR3AsSymbolByAddr.
1230	* @param poffDisp See DBGFR3AsSymbolByAddr.
1231	* @param phMod See DBGFR3AsSymbolByAddr.
1232	*/
1233	VMMR3DECL(PRTDBGSYMBOL) DBGFR3AsSymbolByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress, uint32_t fFlags,
1234	PRTGCINTPTR poffDisp, PRTDBGMOD phMod)
1235	{
1236	RTDBGSYMBOL SymInfo;
1237	int rc = DBGFR3AsSymbolByAddr(pUVM, hDbgAs, pAddress, fFlags, poffDisp, &SymInfo, phMod);
1238	if (RT_SUCCESS(rc))
1239	return RTDbgSymbolDup(&SymInfo);
1240	return NULL;
1241	}
1242
1243
1244	/**
1245	* Query a symbol by name.
1246	*
1247	* The symbol can be prefixed by a module name pattern to scope the search. The
1248	* pattern is a simple string pattern with '*' and '?' as wild chars. See
1249	* RTStrSimplePatternMatch().
1250	*
1251	* @returns VBox status code. See RTDbgAsSymbolByAddr.
1252	*
1253	* @param pUVM The user mode VM handle.
1254	* @param hDbgAs The address space handle.
1255	* @param pszSymbol The symbol to search for, maybe prefixed by a
1256	* module pattern.
1257	* @param pSymbol Where to return the symbol information.
1258	* The returned symbol name will be prefixed by
1259	* the module name as far as space allows.
1260	* @param phMod Where to return the module handle. Optional.
1261	*/
1262	VMMR3DECL(int) DBGFR3AsSymbolByName(PUVM pUVM, RTDBGAS hDbgAs, const char *pszSymbol,
1263	PRTDBGSYMBOL pSymbol, PRTDBGMOD phMod)
1264	{
1265	/*
1266	* Implement the special address space aliases the lazy way.
1267	*/
1268	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1269	{
1270	int rc = DBGFR3AsSymbolByName(pUVM, DBGF_AS_RC, pszSymbol, pSymbol, phMod);
1271	if (RT_FAILURE(rc))
1272	rc = DBGFR3AsSymbolByName(pUVM, DBGF_AS_GLOBAL, pszSymbol, pSymbol, phMod);
1273	return rc;
1274	}
1275
1276	/*
1277	* Input validation.
1278	*/
1279	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1280	AssertPtrReturn(pSymbol, VERR_INVALID_POINTER);
1281	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1282	if (phMod)
1283	*phMod = NIL_RTDBGMOD;
1284	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1285	if (hRealAS == NIL_RTDBGAS)
1286	return VERR_INVALID_HANDLE;
1287
1288
1289	/*
1290	* Do the lookup.
1291	*/
1292	RTDBGMOD hMod;
1293	int rc = RTDbgAsSymbolByName(hRealAS, pszSymbol, pSymbol, &hMod);
1294	if (RT_SUCCESS(rc))
1295	{
1296	dbgfR3AsSymbolJoinNames(pSymbol, hMod);
1297	if (!phMod)
1298	RTDbgModRelease(hMod);
1299	}
1300
1301	RTDbgAsRelease(hRealAS);
1302	return rc;
1303	}
1304
1305
1306	VMMR3DECL(int) DBGFR3AsLineByAddr(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1307	PRTGCINTPTR poffDisp, PRTDBGLINE pLine, PRTDBGMOD phMod)
1308	{
1309	/*
1310	* Implement the special address space aliases the lazy way.
1311	*/
1312	if (hDbgAs == DBGF_AS_RC_AND_GC_GLOBAL)
1313	{
1314	int rc = DBGFR3AsLineByAddr(pUVM, DBGF_AS_RC, pAddress, poffDisp, pLine, phMod);
1315	if (RT_FAILURE(rc))
1316	rc = DBGFR3AsLineByAddr(pUVM, DBGF_AS_GLOBAL, pAddress, poffDisp, pLine, phMod);
1317	return rc;
1318	}
1319
1320	/*
1321	* Input validation.
1322	*/
1323	UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1324	AssertReturn(DBGFR3AddrIsValid(pUVM, pAddress), VERR_INVALID_PARAMETER);
1325	AssertPtrNullReturn(poffDisp, VERR_INVALID_POINTER);
1326	AssertPtrReturn(pLine, VERR_INVALID_POINTER);
1327	AssertPtrNullReturn(phMod, VERR_INVALID_POINTER);
1328	if (poffDisp)
1329	*poffDisp = 0;
1330	if (phMod)
1331	*phMod = NIL_RTDBGMOD;
1332	RTDBGAS hRealAS = DBGFR3AsResolveAndRetain(pUVM, hDbgAs);
1333	if (hRealAS == NIL_RTDBGAS)
1334	return VERR_INVALID_HANDLE;
1335
1336	/*
1337	* Do the lookup.
1338	*/
1339	int rc = RTDbgAsLineByAddr(hRealAS, pAddress->FlatPtr, poffDisp, pLine, phMod);
1340
1341	RTDbgAsRelease(hRealAS);
1342	return rc;
1343	}
1344
1345
1346	VMMR3DECL(PRTDBGLINE) DBGFR3AsLineByAddrA(PUVM pUVM, RTDBGAS hDbgAs, PCDBGFADDRESS pAddress,
1347	PRTGCINTPTR poffDisp, PRTDBGMOD phMod)
1348	{
1349	RTDBGLINE Line;
1350	int rc = DBGFR3AsLineByAddr(pUVM, hDbgAs, pAddress, poffDisp, &Line, phMod);
1351	if (RT_SUCCESS(rc))
1352	return RTDbgLineDup(&Line);
1353	return NULL;
1354	}
1355

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

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

Download in other formats: