VirtualBox

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

Last change on this file since 13762 was 12989, checked in by vboxsync, 16 years ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use