VirtualBox

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

Last change on this file since 18499 was 16080, checked in by vboxsync, 15 years ago

DBGF: 64-bit linux symbol files.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 32.4 KB
Line 
1/* $Id: DBGFSym.cpp 16080 2009-01-20 11:15:58Z 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 %RGv-%RGv!\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 %RGv-%RGv!\n", pSym->Core.Key, pSym->Core.KeyLast));
184 }
185 else
186 AssertMsgFailed(("pOld! %RGv %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 (RT_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=%Rrc 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=%Rrc 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=%Rrc 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=%Rrc 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=%Rrc 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 ( isxdigit(szHead[0])
469 && isxdigit(szHead[1])
470 && isxdigit(szHead[2])
471 && isxdigit(szHead[3])
472 && isxdigit(szHead[4])
473 && isxdigit(szHead[5])
474 && isxdigit(szHead[6])
475 && isxdigit(szHead[7])
476 && isxdigit(szHead[8])
477 && isxdigit(szHead[9])
478 && isxdigit(szHead[10])
479 && isxdigit(szHead[11])
480 && isxdigit(szHead[12])
481 && isxdigit(szHead[13])
482 && isxdigit(szHead[14])
483 && isxdigit(szHead[15])
484 && szHead[16] == ' '
485 && isalpha(szHead[17])
486 && szHead[18] == ' '
487 && (isalpha(szHead[19]) || szHead[19] == '_' || szHead[19] == '$')
488 )
489 return SYMFILETYPE_LINUX_SYSTEM_MAP;
490
491 if (strstr(szHead, "Microsoft C/C++ MSF") == szHead)
492 return SYMFILETYPE_PDB;
493
494 if (strstr(szHead, "ELF") == szHead + 1)
495 return SYMFILETYPE_ELF;
496
497 if ( strstr(szHead, "MZ") == szHead
498 || strstr(szHead, "PE") == szHead
499 || strstr(szHead, "LE") == szHead
500 || strstr(szHead, "LX") == szHead
501 || strstr(szHead, "NE") == szHead)
502 return SYMFILETYPE_MZ;
503
504
505 if (strstr(szHead, "file format"))
506 return SYMFILETYPE_OBJDUMP;
507 }
508
509 return SYMFILETYPE_UNKNOWN;
510}
511
512
513static int dbgfR3LoadLinuxSystemMap(PVM pVM, FILE *pFile, RTGCUINTPTR ModuleAddress, RTGCUINTPTR AddressDelta)
514{
515 char szLine[4096];
516 while (fgets(szLine, sizeof(szLine), pFile))
517 {
518 /* parse the line: <address> <type> <name> */
519 const char *psz = dbgfR3Strip(szLine);
520 char *pszEnd = NULL;
521 uint64_t u64Address;
522 int rc = RTStrToUInt64Ex(psz, &pszEnd, 16, &u64Address);
523 RTGCUINTPTR Address = u64Address;
524 if ( RT_SUCCESS(rc)
525 && (*pszEnd == ' ' || *pszEnd == '\t')
526 && Address == u64Address
527 && u64Address != 0
528 && u64Address != (RTGCUINTPTR)~0)
529 {
530 pszEnd++;
531 if ( isalpha(*pszEnd)
532 && (pszEnd[1] == ' ' || pszEnd[1] == '\t'))
533 {
534 psz = dbgfR3Strip(pszEnd + 2);
535 if (*psz)
536 {
537 int rc2 = DBGFR3SymbolAdd(pVM, ModuleAddress, Address + AddressDelta, 0, psz);
538 if (RT_FAILURE(rc2))
539 Log2(("DBGFR3SymbolAdd(,, %RGv, 0, '%s') -> %Rrc\n", Address, psz, rc2));
540 }
541 }
542 }
543 }
544 return VINF_SUCCESS;
545}
546
547
548/**
549 * Load debug info, optionally related to a specific module.
550 *
551 * @returns VBox status.
552 * @param pVM VM Handle.
553 * @param pszFilename Path to the file containing the symbol information.
554 * This can be the executable image, a flat symbol file of some kind or stripped debug info.
555 * @param AddressDelta The value to add to the loaded symbols.
556 * @param pszName Short hand name for the module. If not related to a module specify NULL.
557 * @param ModuleAddress Address which the image is loaded at. This will be used to reference the module other places in the api.
558 * Ignored when pszName is NULL.
559 * @param cbImage Size of the image.
560 * Ignored when pszName is NULL.
561 */
562VMMR3DECL(int) DBGFR3ModuleLoad(PVM pVM, const char *pszFilename, RTGCUINTPTR AddressDelta, const char *pszName, RTGCUINTPTR ModuleAddress, unsigned cbImage)
563{
564 /*
565 * Lazy init.
566 */
567 if (!pVM->dbgf.s.fSymInited)
568 {
569 int rc = dbgfR3SymLazyInit(pVM);
570 if (RT_FAILURE(rc))
571 return rc;
572 }
573
574 /*
575 * Open the load file.
576 */
577 int rc = VINF_SUCCESS;
578 FILE *pFile = fopen(pszFilename, "rb");
579 if (pFile)
580 {
581 /*
582 * Probe the file type.
583 */
584 SYMFILETYPE enmType = dbgfR3ModuleProbe(pFile);
585 if (enmType != SYMFILETYPE_UNKNOWN)
586 {
587 /*
588 * Add the module.
589 */
590 if (pszName)
591 {
592 #ifdef HAVE_DBGHELP
593 /** @todo arg! checkout the inserting of modules and then loading them again.... Or just the module representation.... */
594 DWORD64 ImageBase = SymLoadModule64(pVM, NULL, (char *)(void *)pszFilename, (char *)(void *)pszName, ModuleAddress, cbImage);
595 if (!ImageBase)
596 ImageBase = SymLoadModule64(pVM, NULL, (char *)(void *)pszName, (char *)(void *)pszName, ModuleAddress, cbImage);
597 if (ImageBase)
598 {
599 AssertMsg(ModuleAddress == 0 || ModuleAddress == ImageBase, ("ModuleAddres=%RGv ImageBase=%llx\n", ModuleAddress, ImageBase));
600 ModuleAddress = ImageBase;
601 }
602 else
603 rc = win32Error(pVM);
604 #else
605 rc = VERR_NOT_IMPLEMENTED;
606 #endif
607 }
608 if (RT_SUCCESS(rc))
609 {
610 /*
611 * Seek to the start of the file.
612 */
613 rc = fseek(pFile, 0, SEEK_SET);
614 Assert(!rc);
615
616 /*
617 * Process the specific.
618 */
619 switch (enmType)
620 {
621 case SYMFILETYPE_LINUX_SYSTEM_MAP:
622 rc = dbgfR3LoadLinuxSystemMap(pVM, pFile, ModuleAddress, AddressDelta);
623 break;
624
625 case SYMFILETYPE_PDB:
626 case SYMFILETYPE_DBG:
627 case SYMFILETYPE_MZ:
628 #ifdef HAVE_DBGHELP
629 /* done it all above! */
630 break;
631 #endif
632 case SYMFILETYPE_LD_MAP:
633 case SYMFILETYPE_MS_MAP:
634 case SYMFILETYPE_OBJDUMP:
635 case SYMFILETYPE_ELF:
636 rc = VERR_NOT_SUPPORTED;
637 break;
638
639 default:
640 AssertFailed();
641 rc = VERR_INTERNAL_ERROR;
642 break;
643 } /* file switch. */
644 } /* module added successfully. */
645 } /* format identified */
646 else
647 rc = VERR_NOT_SUPPORTED;
648 /** @todo check for read errors */
649 fclose(pFile);
650 }
651 else
652 rc = VERR_OPEN_FAILED;
653 return rc;
654}
655
656
657/**
658 * Interface used by PDMR3LdrRelocate for telling us that a GC module has been relocated.
659 *
660 * @param pVM The VM handle.
661 * @param OldImageBase The old image base.
662 * @param NewImageBase The new image base.
663 * @param cbImage The image size.
664 * @param pszFilename The image filename.
665 * @param pszName The module name.
666 */
667VMMR3DECL(void) DBGFR3ModuleRelocate(PVM pVM, RTGCUINTPTR OldImageBase, RTGCUINTPTR NewImageBase, RTGCUINTPTR cbImage,
668 const char *pszFilename, const char *pszName)
669{
670#ifdef HAVE_DBGHELP
671 if (pVM->dbgf.s.fSymInited)
672 {
673 if (!SymUnloadModule64(pVM, OldImageBase))
674 Log(("SymUnloadModule64(,%RGv) failed, lasterr=%d\n", OldImageBase, GetLastError()));
675
676 DWORD ImageSize = (DWORD)cbImage; Assert(ImageSize == cbImage);
677 DWORD64 LoadedImageBase = SymLoadModule64(pVM, NULL, (char *)(void *)pszFilename, (char *)(void *)pszName, NewImageBase, ImageSize);
678 if (!LoadedImageBase)
679 Log(("SymLoadModule64(,,%s,,) -> lasterr=%d (relocate)\n", pszFilename, GetLastError()));
680 else
681 Log(("Reloaded debuginfo for %s - %s %llx\n", pszName, pszFilename, LoadedImageBase));
682 }
683#else
684
685#endif
686}
687
688
689/**
690 * Adds a symbol to the debug info manager.
691 *
692 * @returns VBox status.
693 * @param pVM VM Handle.
694 * @param ModuleAddress Module address. Use 0 if no module.
695 * @param SymbolAddress Symbol address
696 * @param cbSymbol Size of the symbol. Use 0 if info not available.
697 * @param pszSymbol Symbol name.
698 */
699VMMR3DECL(int) DBGFR3SymbolAdd(PVM pVM, RTGCUINTPTR ModuleAddress, RTGCUINTPTR SymbolAddress, RTUINT cbSymbol, const char *pszSymbol)
700{
701 /*
702 * Validate.
703 */
704 if (!pszSymbol || !*pszSymbol)
705 {
706 AssertMsgFailed(("No symbol name!\n"));
707 return VERR_INVALID_PARAMETER;
708 }
709
710 /*
711 * Lazy init.
712 */
713 if (!pVM->dbgf.s.fSymInited)
714 {
715 int rc = dbgfR3SymLazyInit(pVM);
716 if (RT_FAILURE(rc))
717 return rc;
718 }
719
720#ifdef HAVE_DBGHELP
721 if (SymAddSymbol(pVM, ModuleAddress, (char *)(void *)pszSymbol, SymbolAddress, cbSymbol, 0))
722 return VINF_SUCCESS;
723 return win32Error(pVM);
724#else
725 /** @todo module lookup. */
726 return dbgfR3SymbolInsert(pVM, pszSymbol, SymbolAddress, cbSymbol, NULL);
727#endif
728}
729
730
731/**
732 * Find symbol by address (nearest).
733 *
734 * @returns VBox status.
735 * @param pVM VM handle.
736 * @param Address Address.
737 * @param poffDisplacement Where to store the symbol displacement from Address.
738 * @param pSymbol Where to store the symbol info.
739 */
740VMMR3DECL(int) DBGFR3SymbolByAddr(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement, PDBGFSYMBOL pSymbol)
741{
742 /*
743 * Lazy init.
744 */
745 if (!pVM->dbgf.s.fSymInited)
746 {
747 int rc = dbgfR3SymLazyInit(pVM);
748 if (RT_FAILURE(rc))
749 return rc;
750 }
751
752 /*
753 * Look it up.
754 */
755#ifdef HAVE_DBGHELP
756 char achBuffer[sizeof(IMAGEHLP_SYMBOL64) + DBGF_SYMBOL_NAME_LENGTH * sizeof(TCHAR) + sizeof(ULONG64)];
757 PIMAGEHLP_SYMBOL64 pSym = (PIMAGEHLP_SYMBOL64)&achBuffer[0];
758 pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
759 pSym->MaxNameLength = DBGF_SYMBOL_NAME_LENGTH;
760
761 if (SymGetSymFromAddr64(pVM, Address, (PDWORD64)poffDisplacement, pSym))
762 {
763 pSymbol->Value = (RTGCUINTPTR)pSym->Address;
764 pSymbol->cb = pSym->Size;
765 pSymbol->fFlags = pSym->Flags;
766 strcpy(pSymbol->szName, pSym->Name);
767 return VINF_SUCCESS;
768 }
769 //return win32Error(pVM);
770
771#else
772
773 PDBGFSYM pSym = dbgfR3SymbolGetAddr(pVM, Address);
774 if (pSym)
775 {
776 pSymbol->Value = pSym->Core.Key;
777 pSymbol->cb = pSym->Core.KeyLast - pSym->Core.Key + 1;
778 pSymbol->fFlags = 0;
779 pSymbol->szName[0] = '\0';
780 strncat(pSymbol->szName, pSym->szName, sizeof(pSymbol->szName) - 1);
781 if (poffDisplacement)
782 *poffDisplacement = Address - pSymbol->Value;
783 return VINF_SUCCESS;
784 }
785
786#endif
787
788 /*
789 * Try PDM.
790 */
791 if (MMHyperIsInsideArea(pVM, Address))
792 {
793 char szModName[64];
794 RTRCPTR RCPtrMod;
795 char szNearSym1[260];
796 RTRCPTR RCPtrNearSym1;
797 char szNearSym2[260];
798 RTRCPTR RCPtrNearSym2;
799 int rc = PDMR3LdrQueryRCModFromPC(pVM, Address,
800 &szModName[0], sizeof(szModName), &RCPtrMod,
801 &szNearSym1[0], sizeof(szNearSym1), &RCPtrNearSym1,
802 &szNearSym2[0], sizeof(szNearSym2), &RCPtrNearSym2);
803 if (RT_SUCCESS(rc) && szNearSym1[0])
804 {
805 pSymbol->Value = RCPtrNearSym1;
806 pSymbol->cb = RCPtrNearSym2 > RCPtrNearSym1 ? RCPtrNearSym2 - RCPtrNearSym1 : 0;
807 pSymbol->fFlags = 0;
808 pSymbol->szName[0] = '\0';
809 strncat(pSymbol->szName, szNearSym1, sizeof(pSymbol->szName) - 1);
810 if (poffDisplacement)
811 *poffDisplacement = Address - pSymbol->Value;
812 return VINF_SUCCESS;
813 }
814 }
815
816 return VERR_SYMBOL_NOT_FOUND;
817}
818
819
820/**
821 * Find symbol by name (first).
822 *
823 * @returns VBox status.
824 * @param pVM VM handle.
825 * @param pszSymbol Symbol name.
826 * @param pSymbol Where to store the symbol info.
827 */
828VMMR3DECL(int) DBGFR3SymbolByName(PVM pVM, const char *pszSymbol, PDBGFSYMBOL pSymbol)
829{
830 /*
831 * Lazy init.
832 */
833 if (!pVM->dbgf.s.fSymInited)
834 {
835 int rc = dbgfR3SymLazyInit(pVM);
836 if (RT_FAILURE(rc))
837 return rc;
838 }
839
840 /*
841 * Look it up.
842 */
843#ifdef HAVE_DBGHELP
844 char achBuffer[sizeof(IMAGEHLP_SYMBOL64) + DBGF_SYMBOL_NAME_LENGTH * sizeof(TCHAR) + sizeof(ULONG64)];
845 PIMAGEHLP_SYMBOL64 pSym = (PIMAGEHLP_SYMBOL64)&achBuffer[0];
846 pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
847 pSym->MaxNameLength = DBGF_SYMBOL_NAME_LENGTH;
848
849 if (SymGetSymFromName64(pVM, (char *)(void *)pszSymbol, pSym))
850 {
851 pSymbol->Value = (RTGCUINTPTR)pSym->Address;
852 pSymbol->cb = pSym->Size;
853 pSymbol->fFlags = pSym->Flags;
854 strcpy(pSymbol->szName, pSym->Name);
855 return VINF_SUCCESS;
856 }
857 return win32Error(pVM);
858#else
859
860 PDBGFSYM pSym = dbgfR3SymbolGetName(pVM, pszSymbol);
861 if (pSym)
862 {
863 pSymbol->Value = pSym->Core.Key;
864 pSymbol->cb = pSym->Core.KeyLast - pSym->Core.Key + 1;
865 pSymbol->fFlags = 0;
866 pSymbol->szName[0] = '\0';
867 strncat(pSymbol->szName, pSym->szName, sizeof(pSymbol->szName) - 1);
868 return VINF_SUCCESS;
869 }
870
871 return VERR_SYMBOL_NOT_FOUND;
872#endif
873}
874
875
876/**
877 * Duplicates a symbol.
878 *
879 * @returns Pointer to the duplicated symbol.
880 * @param pVM The VM handle.
881 * @param pSymbol The symbol to duplicate.
882 */
883static PDBGFSYMBOL dbgfR3SymbolDup(PVM pVM, PCDBGFSYMBOL pSymbol)
884{
885 size_t cb = strlen(pSymbol->szName) + RT_OFFSETOF(DBGFSYMBOL, szName[1]);
886 PDBGFSYMBOL pDup = (PDBGFSYMBOL)MMR3HeapAlloc(pVM, MM_TAG_DBGF_SYMBOL_DUP, cb);
887 if (pDup)
888 memcpy(pDup, pSymbol, cb);
889 return pDup;
890}
891
892
893/**
894 * Find symbol by address (nearest), allocate return buffer.
895 *
896 * @returns Pointer to the symbol. Must be freed using DBGFR3SymbolFree().
897 * @returns NULL if the symbol was not found or if we're out of memory.
898 * @param pVM VM handle.
899 * @param Address Address.
900 * @param poffDisplacement Where to store the symbol displacement from Address.
901 */
902VMMR3DECL(PDBGFSYMBOL) DBGFR3SymbolByAddrAlloc(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement)
903{
904 DBGFSYMBOL Symbol;
905 int rc = DBGFR3SymbolByAddr(pVM, Address, poffDisplacement, &Symbol);
906 if (RT_FAILURE(rc))
907 return NULL;
908 return dbgfR3SymbolDup(pVM, &Symbol);
909}
910
911
912/**
913 * Find symbol by name (first), allocate return buffer.
914 *
915 * @returns Pointer to the symbol. Must be freed using DBGFR3SymbolFree().
916 * @returns NULL if the symbol was not found or if we're out of memory.
917 * @param pVM VM handle.
918 * @param pszSymbol Symbol name.
919 */
920VMMR3DECL(PDBGFSYMBOL) DBGFR3SymbolByNameAlloc(PVM pVM, const char *pszSymbol)
921{
922 DBGFSYMBOL Symbol;
923 int rc = DBGFR3SymbolByName(pVM, pszSymbol, &Symbol);
924 if (RT_FAILURE(rc))
925 return NULL;
926 return dbgfR3SymbolDup(pVM, &Symbol);
927}
928
929
930/**
931 * Frees a symbol returned by DBGFR3SymbolbyNameAlloc() or DBGFR3SymbolByAddressAlloc().
932 *
933 * @param pSymbol Pointer to the symbol.
934 */
935VMMR3DECL(void) DBGFR3SymbolFree(PDBGFSYMBOL pSymbol)
936{
937 if (pSymbol)
938 MMR3HeapFree(pSymbol);
939}
940
941
942/**
943 * Find line by address (nearest).
944 *
945 * @returns VBox status.
946 * @param pVM VM handle.
947 * @param Address Address.
948 * @param poffDisplacement Where to store the line displacement from Address.
949 * @param pLine Where to store the line info.
950 */
951VMMR3DECL(int) DBGFR3LineByAddr(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement, PDBGFLINE pLine)
952{
953 /*
954 * Lazy init.
955 */
956 if (!pVM->dbgf.s.fSymInited)
957 {
958 int rc = dbgfR3SymLazyInit(pVM);
959 if (RT_FAILURE(rc))
960 return rc;
961 }
962
963 /*
964 * Look it up.
965 */
966#ifdef HAVE_DBGHELP
967 IMAGEHLP_LINE64 Line = {0};
968 DWORD off = 0;
969 Line.SizeOfStruct = sizeof(IMAGEHLP_LINE64);
970 if (SymGetLineFromAddr64(pVM, Address, &off, &Line))
971 {
972 if (poffDisplacement)
973 *poffDisplacement = (long)off;
974 pLine->Address = (RTGCUINTPTR)Line.Address;
975 pLine->uLineNo = Line.LineNumber;
976 pLine->szFilename[0] = '\0';
977 strncat(pLine->szFilename, Line.FileName, sizeof(pLine->szFilename));
978 return VINF_SUCCESS;
979 }
980 return win32Error(pVM);
981#else
982 return VERR_NOT_IMPLEMENTED;
983#endif
984}
985
986
987/**
988 * Duplicates a line.
989 *
990 * @returns VBox status code.
991 * @param pVM The VM handle.
992 * @param pLine The line to duplicate.
993 */
994static PDBGFLINE dbgfR3LineDup(PVM pVM, PCDBGFLINE pLine)
995{
996 size_t cb = strlen(pLine->szFilename) + RT_OFFSETOF(DBGFLINE, szFilename[1]);
997 PDBGFLINE pDup = (PDBGFLINE)MMR3HeapAlloc(pVM, MM_TAG_DBGF_LINE_DUP, cb);
998 if (pDup)
999 memcpy(pDup, pLine, cb);
1000 return pDup;
1001}
1002
1003
1004/**
1005 * Find line by address (nearest), allocate return buffer.
1006 *
1007 * @returns Pointer to the line. Must be freed using DBGFR3LineFree().
1008 * @returns NULL if the line was not found or if we're out of memory.
1009 * @param pVM VM handle.
1010 * @param Address Address.
1011 * @param poffDisplacement Where to store the line displacement from Address.
1012 */
1013VMMR3DECL(PDBGFLINE) DBGFR3LineByAddrAlloc(PVM pVM, RTGCUINTPTR Address, PRTGCINTPTR poffDisplacement)
1014{
1015 DBGFLINE Line;
1016 int rc = DBGFR3LineByAddr(pVM, Address, poffDisplacement, &Line);
1017 if (RT_FAILURE(rc))
1018 return NULL;
1019 return dbgfR3LineDup(pVM, &Line);
1020}
1021
1022
1023/**
1024 * Frees a line returned by DBGFR3LineByAddressAlloc().
1025 *
1026 * @param pLine Pointer to the line.
1027 */
1028VMMR3DECL(void) DBGFR3LineFree(PDBGFLINE pLine)
1029{
1030 if (pLine)
1031 MMR3HeapFree(pLine);
1032}
1033
1034
1035#ifdef HAVE_DBGHELP
1036
1037//static BOOL CALLBACK win32EnumModulesCallback(PSTR ModuleName, DWORD64 BaseOfDll, PVOID UserContext)
1038//{
1039// Log(("dbg: module: %08llx %s\n", ModuleName, BaseOfDll));
1040// return TRUE;
1041//}
1042
1043static int win32Error(PVM pVM)
1044{
1045 int rc = GetLastError();
1046 Log(("Lasterror=%d\n", rc));
1047
1048 //SymEnumerateModules64(pVM, win32EnumModulesCallback, NULL);
1049
1050 return VERR_GENERAL_FAILURE;
1051}
1052#endif
1053
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use