DBGFSym.cpp@ 10171

Last change on this file since 10171 was 9182, checked in by vboxsync, 17 years ago
fixed bad log formatter VRc instead of Vrc.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 31.4 KB

Line
1	/* $Id: DBGFSym.cpp 9182 2008-05-28 01:48:19Z vboxsync $ */
2	/** @file
3	* VMM DBGF - Debugger Facility, Symbol Management.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22
23	/*******************************************************************************
24	* Header Files *
25	*******************************************************************************/
26	#define LOG_GROUP LOG_GROUP_DBGF
27	#if defined(RT_OS_WINDOWS) && 0 //defined(DEBUG_bird) // enabled this is you want to debug win32 guests or the hypervisor.
28	# include <Windows.h>
29	# define _IMAGEHLP64
30	# include <DbgHelp.h>
31	# define HAVE_DBGHELP /* if doing guest stuff, this can be nice. */
32	#endif
33	/** @todo Only use DBGHELP for reading modules since it doesn't do all we want (relocations), or is way to slow in some cases (add symbol)! */
34	#include <VBox/dbgf.h>
35	#include "DBGFInternal.h"
36	#include <VBox/vm.h>
37	#include <VBox/mm.h>
38	#include <VBox/pdm.h>
39	#include <VBox/err.h>
40	#include <VBox/log.h>
41	#include <iprt/assert.h>
42
43	#ifndef HAVE_DBGHELP
44	# include <iprt/avl.h>
45	# include <iprt/string.h>
46	# include <iprt/ctype.h>
47	#endif
48
49	#include <stdio.h> /* for fopen(). / /* @todo use iprt/stream.h! */
50	#include <stdlib.h>
51
52
53
54	/*******************************************************************************
55	* Internal Functions *
56	*******************************************************************************/
57	#ifdef HAVE_DBGHELP
58	static DECLCALLBACK(int) dbgfR3EnumModules(PVM pVM, const char pszFilename, const char pszName, RTUINTPTR ImageBase, size_t cbImage, bool fGC);
59	static int win32Error(PVM pVM);
60	#endif
61
62
63	/*******************************************************************************
64	* Structures and Typedefs *
65	*******************************************************************************/
66	#ifndef HAVE_DBGHELP
67	/* later */
68	typedef struct DBGFMOD *PDBGFMOD;
69
70	/**
71	* Internal represenation of a symbol.
72	*/
73	typedef struct DBGFSYM
74	{
75	/** Node core with the symbol address range. */
76	AVLRGCPTRNODECORE Core;
77	/** Pointer to the module this symbol is associated with. */
78	PDBGFMOD pModule;
79	/** Pointer to the next symbol in with this name. */
80	struct DBGFSYM *pNext;
81	/** Symbol name. */
82	char szName[1];
83	} DBGFSYM, *PDBGFSYM;
84
85	/**
86	* Symbol name space node.
87	*/
88	typedef struct DBGFSYMSPACE
89	{
90	/** Node core with the symbol name.
91	* (it's allocated in the same block as this struct) */
92	RTSTRSPACECORE Core;
93	/** Pointer to the first symbol with this name (LIFO). */
94	PDBGFSYM pSym;
95	} DBGFSYMSPACE, *PDBGFSYMSPACE;
96
97	#endif
98
99
100
101	/*******************************************************************************
102	* Internal Functions *
103	*******************************************************************************/
104	#ifndef HAVE_DBGHELP
105
106	/**
107	* Initializes the symbol tree.
108	*/
109	static int dbgfR3SymbolInit(PVM pVM)
110	{
111	PDBGFSYM pSym = (PDBGFSYM)MMR3HeapAlloc(pVM, MM_TAG_DBGF_SYMBOL, sizeof(*pSym));
112	if (pSym)
113	{
114	pSym->Core.Key = 0;
115	pSym->Core.KeyLast = ~0;
116	pSym->pModule = NULL;
117	pSym->szName[0] = '\0';
118	if (RTAvlrGCPtrInsert(&pVM->dbgf.s.SymbolTree, &pSym->Core))
119	return VINF_SUCCESS;
120	AssertReleaseMsgFailed(("Failed to insert %VGv-%VGv!\n", pSym->Core.Key, pSym->Core.KeyLast));
121	return VERR_INTERNAL_ERROR;
122	}
123	return VERR_NO_MEMORY;
124	}
125
126
127	/**
128	* Insert a record into the symbol tree.
129	*/
130	static int dbgfR3SymbolInsert(PVM pVM, const char *pszName, RTGCPTR Address, size_t cb, PDBGFMOD pModule)
131	{
132	/*
133	* Make the address space node.
134	*/
135	size_t cchName = strlen(pszName) + 1;
136	PDBGFSYM pSym = (PDBGFSYM)MMR3HeapAlloc(pVM, MM_TAG_DBGF_SYMBOL, RT_OFFSETOF(DBGFSYM, szName[cchName]));
137	if (pSym)
138	{
139	pSym->Core.Key = Address;
140	pSym->Core.KeyLast = Address + cb;
141	pSym->pModule = pModule;
142	memcpy(pSym->szName, pszName, cchName);
143
144	PDBGFSYM pOld = (PDBGFSYM)RTAvlrGCPtrRangeGet(&pVM->dbgf.s.SymbolTree, (RTGCPTR)Address);
145	if (pOld)
146	{
147	pSym->Core.KeyLast = pOld->Core.KeyLast;
148	if (pOld->Core.Key == pSym->Core.Key)
149	{
150	pOld = (PDBGFSYM)RTAvlrGCPtrRemove(&pVM->dbgf.s.SymbolTree, (RTGCPTR)Address);
151	AssertRelease(pOld);
152	MMR3HeapFree(pOld);
153	}
154	else
155	pOld->Core.KeyLast = Address - 1;
156	if (RTAvlrGCPtrInsert(&pVM->dbgf.s.SymbolTree, &pSym->Core))
157	{
158	/*
159	* Make the name space node.
160	*/
161	PDBGFSYMSPACE pName = (PDBGFSYMSPACE)RTStrSpaceGet(pVM->dbgf.s.pSymbolSpace, pszName);
162	if (!pName)
163	{
164	/* make new symbol space node. */
165	PDBGFSYMSPACE pName = (PDBGFSYMSPACE)MMR3HeapAlloc(pVM, MM_TAG_DBGF_SYMBOL, sizeof(*pName) + cchName);
166	if (pName)
167	{
168	pName->Core.pszString = (char *)memcpy(pName + 1, pszName, cchName);
169	pName->pSym = pSym;
170	if (RTStrSpaceInsert(pVM->dbgf.s.pSymbolSpace, &pName->Core))
171	return VINF_SUCCESS;
172	}
173	else
174	return VINF_SUCCESS;
175	}
176	else
177	{
178	/* Add to existing symbol name. */
179	pSym->pNext = pName->pSym;
180	pName->pSym = pSym;
181	return VINF_SUCCESS;
182	}
183	}
184	AssertReleaseMsgFailed(("Failed to insert %VGv-%VGv!\n", pSym->Core.Key, pSym->Core.KeyLast));
185	}
186	else
187	AssertMsgFailed(("pOld! %VGv %s\n", pSym->Core.Key, pszName));
188	return VERR_INTERNAL_ERROR;
189
190	}
191	return VERR_NO_MEMORY;
192	}
193
194
195	/**
196	* Get nearest symbol.
197	* @returns NULL if no symbol was the for that address.
198	*/
199	static PDBGFSYM dbgfR3SymbolGetAddr(PVM pVM, RTGCPTR Address)
200	{
201	PDBGFSYM pSym = (PDBGFSYM)RTAvlrGCPtrRangeGet(&pVM->dbgf.s.SymbolTree, Address);
202	Assert(pSym);
203	if (pSym && pSym->szName[0])
204	return pSym;
205	return NULL;
206	}
207
208
209	/**
210	* Get first symbol.
211	* @returns NULL if no symbol by that name.
212	*/
213	static PDBGFSYM dbgfR3SymbolGetName(PVM pVM, const char *pszSymbol)
214	{
215	PDBGFSYMSPACE pName = (PDBGFSYMSPACE)RTStrSpaceGet(pVM->dbgf.s.pSymbolSpace, pszSymbol);
216	if (pName)
217	return pName->pSym;
218	return NULL;
219	}
220
221	#endif
222
223
224	/**
225	* Strips all kind of spaces from head and tail of a string.
226	*/
227	static char dbgfR3Strip(char psz)
228	{
229	while (psz && isspace(psz))
230	psz++;
231	char *psz2 = strchr(psz, '\0') - 1;
232	while (psz2 >= psz && isspace(*psz2))
233	*psz2-- = '\0';
234	return psz;
235	}
236
237
238	/**
239	* Initialize the debug info for a VM.
240	*
241	* This will check the CFGM for any symbols or symbol files
242	* which needs loading.
243	*
244	* @returns VBox status code.
245	* @param pVM The VM handle.
246	*/
247	int dbgfR3SymInit(PVM pVM)
248	{
249	int rc;
250
251	/*
252	* Initialize the symbol table.
253	*/
254	pVM->dbgf.s.pSymbolSpace = (PRTSTRSPACE)MMR3HeapAllocZ(pVM, MM_TAG_DBGF_SYMBOL, sizeof(*pVM->dbgf.s.pSymbolSpace));
255	AssertReturn(pVM->dbgf.s.pSymbolSpace, VERR_NO_MEMORY);
256
257	#ifndef HAVE_DBGHELP
258	/* modules & lines later */
259	rc = dbgfR3SymbolInit(pVM);
260	if (VBOX_FAILURE(rc))
261	return rc;
262	pVM->dbgf.s.fSymInited = true;
263	#endif
264
265	/*
266	* Check if there are 'loadsyms' commands in the configuration.
267	*/
268	PCFGMNODE pNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "/DBGF/loadsyms/");
269	if (pNode)
270	{
271	/*
272	* Enumerate the commands.
273	*/
274	for (PCFGMNODE pCmdNode = CFGMR3GetFirstChild(pNode);
275	pCmdNode;
276	pCmdNode = CFGMR3GetNextChild(pCmdNode))
277	{
278	char szCmdName[128];
279	CFGMR3GetName(pCmdNode, &szCmdName[0], sizeof(szCmdName));
280
281	/* File */
282	char *pszFilename;
283	rc = CFGMR3QueryStringAlloc(pCmdNode, "Filename", &pszFilename);
284	AssertMsgRCReturn(rc, ("rc=%Vrc querying the 'File' attribute of '/DBGF/loadsyms/%s'!\n", rc, szCmdName), rc);
285
286	/* Delta (optional) */
287	RTGCINTPTR offDelta;
288	rc = CFGMR3QueryGCPtrS(pNode, "Delta", &offDelta);
289	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
290	offDelta = 0;
291	else
292	AssertMsgRCReturn(rc, ("rc=%Vrc querying the 'Delta' attribute of '/DBGF/loadsyms/%s'!\n", rc, szCmdName), rc);
293
294	/* Module (optional) */
295	char *pszModule;
296	rc = CFGMR3QueryStringAlloc(pCmdNode, "Module", &pszModule);
297	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
298	pszModule = NULL;
299	else
300	AssertMsgRCReturn(rc, ("rc=%Vrc querying the 'Module' attribute of '/DBGF/loadsyms/%s'!\n", rc, szCmdName), rc);
301
302	/* Module (optional) */
303	RTGCUINTPTR ModuleAddress;
304	rc = CFGMR3QueryGCPtrU(pNode, "ModuleAddress", &ModuleAddress);
305	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
306	ModuleAddress = 0;
307	else
308	AssertMsgRCReturn(rc, ("rc=%Vrc querying the 'ModuleAddress' attribute of '/DBGF/loadsyms/%s'!\n", rc, szCmdName), rc);
309
310	/* Image size (optional) */
311	RTGCUINTPTR cbModule;
312	rc = CFGMR3QueryGCPtrU(pNode, "ModuleSize", &cbModule);
313	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
314	cbModule = 0;
315	else
316	AssertMsgRCReturn(rc, ("rc=%Vrc querying the 'ModuleAddress' attribute of '/DBGF/loadsyms/%s'!\n", rc, szCmdName), rc);
317
318
319	/*
320	* Execute the command.
321	*/
322	rc = DBGFR3ModuleLoad(pVM, pszFilename, offDelta, pszModule, ModuleAddress, cbModule);
323	AssertMsgRCReturn(rc, ("pszFilename=%s offDelta=%RGv pszModule=%s ModuleAddress=%RGv cbModule=%RGv\n",
324	pszFilename, offDelta, pszModule, ModuleAddress, cbModule), rc);
325
326	MMR3HeapFree(pszModule);
327	MMR3HeapFree(pszFilename);
328	}
329	}
330
331	/*
332	* Check if there are any 'symadd' commands in the configuration.
333	*/
334
335	return VINF_SUCCESS;
336	}
337
338
339	/**
340	* We delay certain
341	* Initialize the debug info for a VM.
342	*/
343	int dbgfR3SymLazyInit(PVM pVM)
344	{
345	if (pVM->dbgf.s.fSymInited)
346	return VINF_SUCCESS;
347	#ifdef HAVE_DBGHELP
348	if (SymInitialize(pVM, NULL, FALSE))
349	{
350	pVM->dbgf.s.fSymInited = true;
351	SymSetOptions(SYMOPT_LOAD_LINES \| SYMOPT_AUTO_PUBLICS \| SYMOPT_ALLOW_ABSOLUTE_SYMBOLS);
352
353	/*
354	* Enumerate all modules loaded by PDM and add them to the symbol database.
355	*/
356	PDMR3EnumModules(pVM, dbgfR3EnumModules, NULL);
357	return VINF_SUCCESS;
358	}
359	return win32Error(pVM);
360	#else
361	return VINF_SUCCESS;
362	#endif
363	}
364
365
366	#ifdef HAVE_DBGHELP
367	/**
368	* Module enumeration callback function.
369	*
370	* @returns VBox status.
371	* Failure will stop the search and return the return code.
372	* Warnings will be ignored and not returned.
373	* @param pVM VM Handle.
374	* @param pszFilename Module filename.
375	* @param pszName Module name. (short and unique)
376	* @param ImageBase Address where to executable image is loaded.
377	* @param cbImage Size of the executable image.
378	* @param fGC Set if guest context, clear if host context.
379	* @param pvArg User argument.
380	*/
381	static DECLCALLBACK(int) dbgfR3EnumModules(PVM pVM, const char pszFilename, const char pszName, RTUINTPTR ImageBase, size_t cbImage, bool fGC)
382	{
383	if (fGC)
384	{
385	DWORD64 LoadedImageBase = SymLoadModule64(pVM, NULL, (char )(void )pszFilename, (char )(void )pszName, ImageBase, cbImage);
386	if (!LoadedImageBase)
387	Log(("SymLoadModule64(,,%s,,) -> lasterr=%d\n", pszFilename, GetLastError()));
388	else
389	Log(("Loaded debuginfo for %s - %s %llx\n", pszName, pszFilename, LoadedImageBase));
390	}
391	return VINF_SUCCESS;
392	}
393	#endif
394
395
396	/**
397	* Terminate the debug info repository for the specified VM.
398	*
399	* @returns VBox status.
400	* @param pVM VM Handle.
401	*/
402	int dbgfR3SymTerm(PVM pVM)
403	{
404	#ifdef HAVE_DBGHELP
405	if (pVM->dbgf.s.fSymInited)
406	SymCleanup(pVM);
407	pVM->dbgf.s.fSymInited = false;
408	return VINF_SUCCESS;
409	#else
410	pVM->dbgf.s.SymbolTree = 0; /* MM cleans up allocations */
411	pVM->dbgf.s.fSymInited = false;
412	return VINF_SUCCESS;
413	#endif
414	}
415
416
417	/** Symbol file type.. */
418	typedef enum SYMFILETYPE
419	{
420	SYMFILETYPE_UNKNOWN,
421	SYMFILETYPE_LD_MAP,
422	SYMFILETYPE_MS_MAP,
423	SYMFILETYPE_OBJDUMP,
424	SYMFILETYPE_LINUX_SYSTEM_MAP,
425	SYMFILETYPE_PDB,
426	SYMFILETYPE_DBG,
427	SYMFILETYPE_MZ,
428	SYMFILETYPE_ELF
429	} SYMFILETYPE, *PSYMFILETYPE;
430
431
432
433	/**
434	* Probe the type of a symbol information file.
435	*
436	* @returns The file type.
437	* @param pFile File handle.
438	*/
439	SYMFILETYPE dbgfR3ModuleProbe(FILE *pFile)
440	{
441	char szHead[4096];
442	size_t cchHead = fread(szHead, 1, sizeof(szHead) - 1, pFile);
443	if (cchHead > 0)
444	{
445	szHead[cchHead] = '\0';
446	if (strstr(szHead, "Preferred load address is"))
447	return SYMFILETYPE_MS_MAP;
448
449	if ( strstr(szHead, "Archive member included because of")
450	\|\| strstr(szHead, "Memory Configuration")
451	\|\| strstr(szHead, "Linker script and memory map"))
452	return SYMFILETYPE_LD_MAP;
453
454	if ( isxdigit(szHead[0])
455	&& isxdigit(szHead[1])
456	&& isxdigit(szHead[2])
457	&& isxdigit(szHead[3])
458	&& isxdigit(szHead[4])
459	&& isxdigit(szHead[5])
460	&& isxdigit(szHead[6])
461	&& isxdigit(szHead[7])
462	&& szHead[8] == ' '
463	&& isalpha(szHead[9])
464	&& szHead[10] == ' '
465	&& (isalpha(szHead[11]) \|\| szHead[11] == '_' \|\| szHead[11] == '$')
466	)
467	return SYMFILETYPE_LINUX_SYSTEM_MAP;
468
469	if (strstr(szHead, "Microsoft C/C++ MSF") == szHead)
470	return SYMFILETYPE_PDB;
471
472	if (strstr(szHead, "ELF") == szHead + 1)
473	return SYMFILETYPE_ELF;
474
475	if ( strstr(szHead, "MZ") == szHead
476	\|\| strstr(szHead, "PE") == szHead
477	\|\| strstr(szHead, "LE") == szHead
478	\|\| strstr(szHead, "LX") == szHead
479	\|\| strstr(szHead, "NE") == szHead)
480	return SYMFILETYPE_MZ;
481
482
483	if (strstr(szHead, "file format"))
484	return SYMFILETYPE_OBJDUMP;
485	}
486
487	return SYMFILETYPE_UNKNOWN;
488	}
489
490
491	static int dbgfR3LoadLinuxSystemMap(PVM pVM, FILE *pFile, RTGCUINTPTR ModuleAddress, RTGCUINTPTR AddressDelta)
492	{
493	char szLine[4096];
494	while (fgets(szLine, sizeof(szLine), pFile))
495	{
496	/* parse the line: <address> <type> <name> */
497	const char *psz = dbgfR3Strip(szLine);
498	char *pszEnd = NULL;
499	RTGCUINTPTR Address = strtoul(psz, &pszEnd, 16);
500	if ( pszEnd && (pszEnd == ' ' \|\| pszEnd == '\t')
501	&& Address != 0
502	&& Address != (RTGCUINTPTR)~0)
503	{
504	pszEnd++;
505	if ( isalpha(*pszEnd)
506	&& (pszEnd[1] == ' ' \|\| pszEnd[1] == '\t'))
507	{
508	psz = dbgfR3Strip(pszEnd + 2);
509	if (*psz)
510	{
511	int rc2 = DBGFR3SymbolAdd(pVM, ModuleAddress, Address + AddressDelta, 0, psz);
512	if (VBOX_FAILURE(rc2))
513	Log2(("DBGFR3SymbolAdd(,, %#VGv, 0, '%s') -> %Vrc\n", Address, psz, rc2));
514	}
515	}
516	}
517	}
518	return VINF_SUCCESS;
519	}
520
521
522	/**
523	* Load debug info, optionally related to a specific module.
524	*
525	* @returns VBox status.
526	* @param pVM VM Handle.
527	* @param pszFilename Path to the file containing the symbol information.
528	* This can be the executable image, a flat symbol file of some kind or stripped debug info.
529	* @param AddressDelta The value to add to the loaded symbols.
530	* @param pszName Short hand name for the module. If not related to a module specify NULL.
531	* @param ModuleAddress Address which the image is loaded at. This will be used to reference the module other places in the api.
532	* Ignored when pszName is NULL.
533	* @param cbImage Size of the image.
534	* Ignored when pszName is NULL.
535	*/
536	DBGFR3DECL(int) DBGFR3ModuleLoad(PVM pVM, const char pszFilename, RTGCUINTPTR AddressDelta, const char pszName, RTGCUINTPTR ModuleAddress, unsigned cbImage)
537	{
538	/*
539	* Lazy init.
540	*/
541	if (!pVM->dbgf.s.fSymInited)
542	{
543	int rc = dbgfR3SymLazyInit(pVM);
544	if (VBOX_FAILURE(rc))
545	return rc;
546	}
547
548	/*
549	* Open the load file.
550	*/
551	int rc = VINF_SUCCESS;
552	FILE *pFile = fopen(pszFilename, "rb");
553	if (pFile)
554	{
555	/*
556	* Probe the file type.
557	*/
558	SYMFILETYPE enmType = dbgfR3ModuleProbe(pFile);
559	if (enmType != SYMFILETYPE_UNKNOWN)
560	{
561	/*
562	* Add the module.
563	*/
564	if (pszName)
565	{
566	#ifdef HAVE_DBGHELP
567	/** @todo arg! checkout the inserting of modules and then loading them again.... Or just the module representation.... */
568	DWORD64 ImageBase = SymLoadModule64(pVM, NULL, (char )(void )pszFilename, (char )(void )pszName, ModuleAddress, cbImage);
569	if (!ImageBase)
570	ImageBase = SymLoadModule64(pVM, NULL, (char )(void )pszName, (char )(void )pszName, ModuleAddress, cbImage);
571	if (ImageBase)
572	{
573	AssertMsg(ModuleAddress == 0 \|\| ModuleAddress == ImageBase, ("ModuleAddres=%VGv ImageBase=%llx\n", ModuleAddress, ImageBase));
574	ModuleAddress = ImageBase;
575	}
576	else
577	rc = win32Error(pVM);
578	#else
579	rc = VERR_NOT_IMPLEMENTED;
580	#endif
581	}
582	if (VBOX_SUCCESS(rc))
583	{
584	/*
585	* Seek to the start of the file.
586	*/
587	rc = fseek(pFile, 0, SEEK_SET);
588	Assert(!rc);
589
590	/*
591	* Process the specific.
592	*/
593	switch (enmType)
594	{
595	case SYMFILETYPE_LINUX_SYSTEM_MAP:
596	rc = dbgfR3LoadLinuxSystemMap(pVM, pFile, ModuleAddress, AddressDelta);
597	break;
598
599	case SYMFILETYPE_PDB:
600	case SYMFILETYPE_DBG:
601	case SYMFILETYPE_MZ:
602	#ifdef HAVE_DBGHELP
603	/* done it all above! */
604	break;
605	#endif
606	case SYMFILETYPE_LD_MAP:
607	case SYMFILETYPE_MS_MAP:
608	case SYMFILETYPE_OBJDUMP:
609	case SYMFILETYPE_ELF:
610	rc = VERR_NOT_SUPPORTED;
611	break;
612
613	default:
614	AssertFailed();
615	rc = VERR_INTERNAL_ERROR;
616	break;
617	} /* file switch. */
618	} /* module added successfully. */
619	} /* format identified */
620	else
621	rc = VERR_NOT_SUPPORTED;
622	/** @todo check for read errors */
623	fclose(pFile);
624	}
625	else
626	rc = VERR_OPEN_FAILED;
627	return rc;
628	}
629
630
631	/**
632	* Interface used by PDMR3LdrRelocate for telling us that a GC module has been relocated.
633	*
634	* @param pVM The VM handle.
635	* @param OldImageBase The old image base.
636	* @param NewImageBase The new image base.
637	* @param cbImage The image size.
638	* @param pszFilename The image filename.
639	* @param pszName The module name.
640	*/
641	DBGFR3DECL(void) DBGFR3ModuleRelocate(PVM pVM, RTGCUINTPTR OldImageBase, RTGCUINTPTR NewImageBase, unsigned cbImage,
642	const char pszFilename, const char pszName)
643	{
644	#ifdef HAVE_DBGHELP
645	if (pVM->dbgf.s.fSymInited)
646	{
647	if (!SymUnloadModule64(pVM, OldImageBase))
648	Log(("SymUnloadModule64(,%VGv) failed, lasterr=%d\n", OldImageBase, GetLastError()));
649
650	DWORD64 LoadedImageBase = SymLoadModule64(pVM, NULL, (char )(void )pszFilename, (char )(void )pszName, NewImageBase, cbImage);
651	if (!LoadedImageBase)
652	Log(("SymLoadModule64(,,%s,,) -> lasterr=%d (relocate)\n", pszFilename, GetLastError()));
653	else
654	Log(("Reloaded debuginfo for %s - %s %llx\n", pszName, pszFilename, LoadedImageBase));
655	}
656	#else
657
658	#endif
659	}
660
661
662	/**
663	* Adds a symbol to the debug info manager.
664	*
665	* @returns VBox status.
666	* @param pVM VM Handle.
667	* @param ModuleAddress Module address. Use 0 if no module.
668	* @param SymbolAddress Symbol address
669	* @param cbSymbol Size of the symbol. Use 0 if info not available.
670	* @param pszSymbol Symbol name.
671	*/
672	DBGFR3DECL(int) DBGFR3SymbolAdd(PVM pVM, RTGCUINTPTR ModuleAddress, RTGCUINTPTR SymbolAddress, RTUINT cbSymbol, const char *pszSymbol)
673	{
674	/*
675	* Validate.
676	*/
677	if (!pszSymbol \|\| !*pszSymbol)
678	{
679	AssertMsgFailed(("No symbol name!\n"));
680	return VERR_INVALID_PARAMETER;
681	}
682
683	/*
684	* Lazy init.
685	*/
686	if (!pVM->dbgf.s.fSymInited)
687	{
688	int rc = dbgfR3SymLazyInit(pVM);
689	if (VBOX_FAILURE(rc))
690	return rc;
691	}
692
693	#ifdef HAVE_DBGHELP
694	if (SymAddSymbol(pVM, ModuleAddress, (char )(void )pszSymbol, SymbolAddress, cbSymbol, 0))
695	return VINF_SUCCESS;
696	return win32Error(pVM);
697	#else
698	/** @todo module lookup. */
699	return dbgfR3SymbolInsert(pVM, pszSymbol, SymbolAddress, cbSymbol, NULL);
700	#endif
701	}
702
703
704	/**
705	* Find symbol by address (nearest).
706	*
707	* @returns VBox status.
708	* @param pVM VM handle.
709	* @param Address Address.
710	* @param poffDisplacement Where to store the symbol displacement from Address.
711	* @param pSymbol Where to store the symbol info.
712	*/
713	DBGFR3DECL(int) DBGFR3SymbolByAddr(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement, PDBGFSYMBOL pSymbol)
714	{
715	/*
716	* Lazy init.
717	*/
718	if (!pVM->dbgf.s.fSymInited)
719	{
720	int rc = dbgfR3SymLazyInit(pVM);
721	if (VBOX_FAILURE(rc))
722	return rc;
723	}
724
725	/*
726	* Look it up.
727	*/
728	#ifdef HAVE_DBGHELP
729	char achBuffer[sizeof(IMAGEHLP_SYMBOL64) + DBGF_SYMBOL_NAME_LENGTH * sizeof(TCHAR) + sizeof(ULONG64)];
730	PIMAGEHLP_SYMBOL64 pSym = (PIMAGEHLP_SYMBOL64)&achBuffer[0];
731	pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
732	pSym->MaxNameLength = DBGF_SYMBOL_NAME_LENGTH;
733
734	if (SymGetSymFromAddr64(pVM, Address, (PDWORD64)poffDisplacement, pSym))
735	{
736	pSymbol->Value = (RTGCUINTPTR)pSym->Address;
737	pSymbol->cb = pSym->Size;
738	pSymbol->fFlags = pSym->Flags;
739	strcpy(pSymbol->szName, pSym->Name);
740	return VINF_SUCCESS;
741	}
742	//return win32Error(pVM);
743
744	#else
745
746	PDBGFSYM pSym = dbgfR3SymbolGetAddr(pVM, Address);
747	if (pSym)
748	{
749	pSymbol->Value = pSym->Core.Key;
750	pSymbol->cb = pSym->Core.KeyLast - pSym->Core.Key + 1;
751	pSymbol->fFlags = 0;
752	pSymbol->szName[0] = '\0';
753	strncat(pSymbol->szName, pSym->szName, sizeof(pSymbol->szName) - 1);
754	if (poffDisplacement)
755	*poffDisplacement = Address - pSymbol->Value;
756	return VINF_SUCCESS;
757	}
758
759	#endif
760
761	/*
762	* Try PDM.
763	*/
764	if (MMHyperIsInsideArea(pVM, Address))
765	{
766	char szModName[64];
767	RTGCPTR GCPtrMod;
768	char szNearSym1[260];
769	RTGCPTR GCPtrNearSym1;
770	char szNearSym2[260];
771	RTGCPTR GCPtrNearSym2;
772	int rc = PDMR3QueryModFromEIP(pVM, Address,
773	&szModName[0], sizeof(szModName), &GCPtrMod,
774	&szNearSym1[0], sizeof(szNearSym1), &GCPtrNearSym1,
775	&szNearSym2[0], sizeof(szNearSym2), &GCPtrNearSym2);
776	if (VBOX_SUCCESS(rc) && szNearSym1[0])
777	{
778	pSymbol->Value = GCPtrNearSym1;
779	pSymbol->cb = GCPtrNearSym2 > GCPtrNearSym1 ? GCPtrNearSym2 - GCPtrNearSym1 : 0;
780	pSymbol->fFlags = 0;
781	pSymbol->szName[0] = '\0';
782	strncat(pSymbol->szName, szNearSym1, sizeof(pSymbol->szName) - 1);
783	if (poffDisplacement)
784	*poffDisplacement = Address - pSymbol->Value;
785	return VINF_SUCCESS;
786	}
787	}
788
789	return VERR_SYMBOL_NOT_FOUND;
790	}
791
792
793	/**
794	* Find symbol by name (first).
795	*
796	* @returns VBox status.
797	* @param pVM VM handle.
798	* @param pszSymbol Symbol name.
799	* @param pSymbol Where to store the symbol info.
800	*/
801	DBGFR3DECL(int) DBGFR3SymbolByName(PVM pVM, const char *pszSymbol, PDBGFSYMBOL pSymbol)
802	{
803	/*
804	* Lazy init.
805	*/
806	if (!pVM->dbgf.s.fSymInited)
807	{
808	int rc = dbgfR3SymLazyInit(pVM);
809	if (VBOX_FAILURE(rc))
810	return rc;
811	}
812
813	/*
814	* Look it up.
815	*/
816	#ifdef HAVE_DBGHELP
817	char achBuffer[sizeof(IMAGEHLP_SYMBOL64) + DBGF_SYMBOL_NAME_LENGTH * sizeof(TCHAR) + sizeof(ULONG64)];
818	PIMAGEHLP_SYMBOL64 pSym = (PIMAGEHLP_SYMBOL64)&achBuffer[0];
819	pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
820	pSym->MaxNameLength = DBGF_SYMBOL_NAME_LENGTH;
821
822	if (SymGetSymFromName64(pVM, (char )(void )pszSymbol, pSym))
823	{
824	pSymbol->Value = (RTGCUINTPTR)pSym->Address;
825	pSymbol->cb = pSym->Size;
826	pSymbol->fFlags = pSym->Flags;
827	strcpy(pSymbol->szName, pSym->Name);
828	return VINF_SUCCESS;
829	}
830	return win32Error(pVM);
831	#else
832
833	PDBGFSYM pSym = dbgfR3SymbolGetName(pVM, pszSymbol);
834	if (pSym)
835	{
836	pSymbol->Value = pSym->Core.Key;
837	pSymbol->cb = pSym->Core.KeyLast - pSym->Core.Key + 1;
838	pSymbol->fFlags = 0;
839	pSymbol->szName[0] = '\0';
840	strncat(pSymbol->szName, pSym->szName, sizeof(pSymbol->szName) - 1);
841	return VINF_SUCCESS;
842	}
843
844	return VERR_SYMBOL_NOT_FOUND;
845	#endif
846	}
847
848
849	/**
850	* Duplicates a symbol.
851	*
852	* @returns Pointer to the duplicated symbol.
853	* @param pVM The VM handle.
854	* @param pSymbol The symbol to duplicate.
855	*/
856	static PDBGFSYMBOL dbgfR3SymbolDup(PVM pVM, PCDBGFSYMBOL pSymbol)
857	{
858	size_t cb = strlen(pSymbol->szName) + RT_OFFSETOF(DBGFSYMBOL, szName[1]);
859	PDBGFSYMBOL pDup = (PDBGFSYMBOL)MMR3HeapAlloc(pVM, MM_TAG_DBGF_SYMBOL_DUP, cb);
860	if (pDup)
861	memcpy(pDup, pSymbol, cb);
862	return pDup;
863	}
864
865
866	/**
867	* Find symbol by address (nearest), allocate return buffer.
868	*
869	* @returns Pointer to the symbol. Must be freed using DBGFR3SymbolFree().
870	* @returns NULL if the symbol was not found or if we're out of memory.
871	* @param pVM VM handle.
872	* @param Address Address.
873	* @param poffDisplacement Where to store the symbol displacement from Address.
874	*/
875	DBGFR3DECL(PDBGFSYMBOL) DBGFR3SymbolByAddrAlloc(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement)
876	{
877	DBGFSYMBOL Symbol;
878	int rc = DBGFR3SymbolByAddr(pVM, Address, poffDisplacement, &Symbol);
879	if (VBOX_FAILURE(rc))
880	return NULL;
881	return dbgfR3SymbolDup(pVM, &Symbol);
882	}
883
884
885	/**
886	* Find symbol by name (first), allocate return buffer.
887	*
888	* @returns Pointer to the symbol. Must be freed using DBGFR3SymbolFree().
889	* @returns NULL if the symbol was not found or if we're out of memory.
890	* @param pVM VM handle.
891	* @param pszSymbol Symbol name.
892	*/
893	DBGFR3DECL(PDBGFSYMBOL) DBGFR3SymbolByNameAlloc(PVM pVM, const char *pszSymbol)
894	{
895	DBGFSYMBOL Symbol;
896	int rc = DBGFR3SymbolByName(pVM, pszSymbol, &Symbol);
897	if (VBOX_FAILURE(rc))
898	return NULL;
899	return dbgfR3SymbolDup(pVM, &Symbol);
900	}
901
902
903	/**
904	* Frees a symbol returned by DBGFR3SymbolbyNameAlloc() or DBGFR3SymbolByAddressAlloc().
905	*
906	* @param pSymbol Pointer to the symbol.
907	*/
908	DBGFR3DECL(void) DBGFR3SymbolFree(PDBGFSYMBOL pSymbol)
909	{
910	if (pSymbol)
911	MMR3HeapFree(pSymbol);
912	}
913
914
915	/**
916	* Find line by address (nearest).
917	*
918	* @returns VBox status.
919	* @param pVM VM handle.
920	* @param Address Address.
921	* @param poffDisplacement Where to store the line displacement from Address.
922	* @param pLine Where to store the line info.
923	*/
924	DBGFR3DECL(int) DBGFR3LineByAddr(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement, PDBGFLINE pLine)
925	{
926	/*
927	* Lazy init.
928	*/
929	if (!pVM->dbgf.s.fSymInited)
930	{
931	int rc = dbgfR3SymLazyInit(pVM);
932	if (VBOX_FAILURE(rc))
933	return rc;
934	}
935
936	/*
937	* Look it up.
938	*/
939	#ifdef HAVE_DBGHELP
940	IMAGEHLP_LINE64 Line = {0};
941	DWORD off = 0;
942	Line.SizeOfStruct = sizeof(IMAGEHLP_LINE64);
943	if (SymGetLineFromAddr64(pVM, Address, &off, &Line))
944	{
945	if (poffDisplacement)
946	*poffDisplacement = (long)off;
947	pLine->Address = (RTGCUINTPTR)Line.Address;
948	pLine->uLineNo = Line.LineNumber;
949	pLine->szFilename[0] = '\0';
950	strncat(pLine->szFilename, Line.FileName, sizeof(pLine->szFilename));
951	return VINF_SUCCESS;
952	}
953	return win32Error(pVM);
954	#else
955	return VERR_NOT_IMPLEMENTED;
956	#endif
957	}
958
959
960	/**
961	* Duplicates a line.
962	*
963	* @returns VBox status code.
964	* @param pVM The VM handle.
965	* @param pLine The line to duplicate.
966	*/
967	static PDBGFLINE dbgfR3LineDup(PVM pVM, PCDBGFLINE pLine)
968	{
969	size_t cb = strlen(pLine->szFilename) + RT_OFFSETOF(DBGFLINE, szFilename[1]);
970	PDBGFLINE pDup = (PDBGFLINE)MMR3HeapAlloc(pVM, MM_TAG_DBGF_LINE_DUP, cb);
971	if (pDup)
972	memcpy(pDup, pLine, cb);
973	return pDup;
974	}
975
976
977	/**
978	* Find line by address (nearest), allocate return buffer.
979	*
980	* @returns Pointer to the line. Must be freed using DBGFR3LineFree().
981	* @returns NULL if the line was not found or if we're out of memory.
982	* @param pVM VM handle.
983	* @param Address Address.
984	* @param poffDisplacement Where to store the line displacement from Address.
985	*/
986	DBGFR3DECL(PDBGFLINE) DBGFR3LineByAddrAlloc(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement)
987	{
988	DBGFLINE Line;
989	int rc = DBGFR3LineByAddr(pVM, Address, poffDisplacement, &Line);
990	if (VBOX_FAILURE(rc))
991	return NULL;
992	return dbgfR3LineDup(pVM, &Line);
993	}
994
995
996	/**
997	* Frees a line returned by DBGFR3LineByAddressAlloc().
998	*
999	* @param pLine Pointer to the line.
1000	*/
1001	DBGFR3DECL(void) DBGFR3LineFree(PDBGFLINE pLine)
1002	{
1003	if (pLine)
1004	MMR3HeapFree(pLine);
1005	}
1006
1007
1008	#ifdef HAVE_DBGHELP
1009
1010	//static BOOL CALLBACK win32EnumModulesCallback(PSTR ModuleName, DWORD64 BaseOfDll, PVOID UserContext)
1011	//{
1012	// Log(("dbg: module: %08llx %s\n", ModuleName, BaseOfDll));
1013	// return TRUE;
1014	//}
1015
1016	static int win32Error(PVM pVM)
1017	{
1018	int rc = GetLastError();
1019	Log(("Lasterror=%d\n", rc));
1020
1021	//SymEnumerateModules64(pVM, win32EnumModulesCallback, NULL);
1022
1023	return VERR_GENERAL_FAILURE;
1024	}
1025	#endif
1026

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

source: vbox/trunk/src/VBox/VMM/DBGFSym.cpp@ 10171

Download in other formats: