2 * Generate hash tables for Wine debugger symbols
4 * Copyright (C) 1993, Eric Youngdale.
5 * 2004-2005, Eric Pouech.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #define NONAMELESSUNION
23 #define NONAMELESSSTRUCT
31 #include "wine/debug.h"
33 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
35 static BOOL symbol_get_debug_start(const struct dbg_type* func, ULONG64* start)
38 char buffer[sizeof(TI_FINDCHILDREN_PARAMS) + 256 * sizeof(DWORD)];
39 TI_FINDCHILDREN_PARAMS* fcp = (TI_FINDCHILDREN_PARAMS*)buffer;
41 struct dbg_type child;
43 if (!func->id) return FALSE; /* native dbghelp not always fills the info field */
45 if (!types_get_info(func, TI_GET_CHILDRENCOUNT, &count)) return FALSE;
49 fcp->Count = min(count, 256);
50 if (types_get_info(func, TI_FINDCHILDREN, fcp))
52 for (i = 0; i < min(fcp->Count, count); i++)
54 child.module = func->module;
55 child.id = fcp->ChildId[i];
56 types_get_info(&child, TI_GET_SYMTAG, &tag);
57 if (tag != SymTagFuncDebugStart) continue;
58 return types_get_info(&child, TI_GET_ADDRESS, start);
60 count -= min(count, 256);
68 static BOOL fill_sym_lvalue(const SYMBOL_INFO* sym, ULONG_PTR base,
69 struct dbg_lvalue* lvalue, char* buffer, size_t sz)
71 if (buffer) buffer[0] = '\0';
72 if (sym->Flags & SYMFLAG_REGISTER)
76 if (!memory_get_register(sym->Register, &pval, buffer, sz))
78 lvalue->cookie = DLV_HOST;
79 lvalue->addr.Offset = (DWORD_PTR)pval;
81 else if (sym->Flags & SYMFLAG_REGREL)
86 *buffer++ = '['; sz--;
87 if (!memory_get_register(sym->Register, &pval, buffer, sz))
92 lvalue->cookie = DLV_TARGET;
93 lvalue->addr.Offset = (ULONG64)*pval + sym->Address;
94 if ((LONG_PTR)sym->Address >= 0)
95 snprintf(buffer, sz, "+%ld]", (ULONG_PTR)sym->Address);
97 snprintf(buffer, sz, "-%ld]", -(LONG_PTR)sym->Address);
99 else if (sym->Flags & SYMFLAG_VALUEPRESENT)
101 struct dbg_type type;
104 type.module = sym->ModBase;
107 if (!types_get_info(&type, TI_GET_VALUE, &v))
109 if (buffer) snprintf(buffer, sz, "Couldn't get full value information for %s", sym->Name);
112 else if (v.n1.n2.vt & VT_BYREF)
114 /* FIXME: this won't work for pointers or arrays, as we don't always
115 * know, if the value to be dereferenced lies in debuggee or
116 * debugger address space.
118 if (sym->Tag == SymTagPointerType || sym->Tag == SymTagArrayType)
120 if (buffer) snprintf(buffer, sz, "Couldn't dereference pointer for const value for %s", sym->Name);
123 /* this is likely Wine's dbghelp which passes const values by reference
124 * (object is managed by dbghelp, hence in debugger address space)
126 lvalue->cookie = DLV_HOST;
127 lvalue->addr.Offset = (DWORD_PTR)sym->Value;
131 DWORD* pdw = (DWORD*)lexeme_alloc_size(sizeof(*pdw));
132 lvalue->cookie = DLV_HOST;
133 lvalue->addr.Offset = (DWORD_PTR)pdw;
137 else if (sym->Flags & SYMFLAG_LOCAL)
139 lvalue->cookie = DLV_TARGET;
140 lvalue->addr.Offset = base + sym->Address;
142 else if (sym->Flags & SYMFLAG_TLSREL)
144 PROCESS_BASIC_INFORMATION pbi;
145 THREAD_BASIC_INFORMATION tbi;
148 PEB_LDR_DATA ldr_data;
149 PLIST_ENTRY head, current;
150 LDR_MODULE ldr_module;
151 unsigned tlsindex = -1;
153 if (NtQueryInformationProcess(dbg_curr_process->handle, ProcessBasicInformation,
154 &pbi, sizeof(pbi), NULL) ||
155 NtQueryInformationThread(dbg_curr_thread->handle, ThreadBasicInformation,
156 &tbi, sizeof(tbi), NULL))
159 if (buffer) snprintf(buffer, sz, "Cannot read TLS address\n");
162 addr = (DWORD_PTR)&(((TEB*)tbi.TebBaseAddress)->ThreadLocalStoragePointer);
163 if (!dbg_read_memory((void*)addr, &addr, sizeof(addr)) ||
164 !dbg_read_memory(pbi.PebBaseAddress, &peb, sizeof(peb)) ||
165 !dbg_read_memory(peb.LdrData, &ldr_data, sizeof(ldr_data)))
167 current = ldr_data.InLoadOrderModuleList.Flink;
168 head = &((PEB_LDR_DATA*)peb.LdrData)->InLoadOrderModuleList;
171 if (!dbg_read_memory(CONTAINING_RECORD(current, LDR_MODULE, InLoadOrderModuleList),
172 &ldr_module, sizeof(ldr_module))) goto tls_error;
173 if ((DWORD_PTR)ldr_module.BaseAddress == sym->ModBase)
175 tlsindex = ldr_module.TlsIndex;
178 current = ldr_module.InLoadOrderModuleList.Flink;
179 } while (current != head);
181 addr += tlsindex * sizeof(DWORD_PTR);
182 if (!dbg_read_memory((void*)addr, &addr, sizeof(addr))) goto tls_error;
183 lvalue->cookie = DLV_TARGET;
184 lvalue->addr.Offset = addr + sym->Address;
188 lvalue->cookie = DLV_TARGET;
189 lvalue->addr.Offset = sym->Address;
191 lvalue->addr.Mode = AddrModeFlat;
192 lvalue->type.module = sym->ModBase;
193 lvalue->type.id = sym->TypeIndex;
203 /* FIXME: NUMDBGV should be made variable */
204 struct dbg_lvalue lvalue;
207 } syms[NUMDBGV]; /* out : will be filled in with various found symbols */
208 int num; /* out : number of found symbols */
209 int num_thunks; /* out : number of thunks found */
210 const char* name; /* in : name of symbol to look up */
211 unsigned do_thunks : 1; /* in : whether we return thunks tags */
212 ULONG64 frame_offset; /* in : frame for local & parameter variables look up */
215 static BOOL CALLBACK sgv_cb(PSYMBOL_INFO sym, ULONG size, PVOID ctx)
217 struct sgv_data* sgv = ctx;
221 if (sym->Flags & SYMFLAG_THUNK)
223 if (!sgv->do_thunks) return TRUE;
227 if (sgv->num >= NUMDBGV)
229 dbg_printf("Too many addresses for symbol '%s', limiting the first %d\n",
233 WINE_TRACE("==> %s %s%s%s%s%s%s%s%s\n",
235 (sym->Flags & SYMFLAG_FUNCTION) ? "func " : "",
236 (sym->Flags & SYMFLAG_FRAMEREL) ? "framerel " : "",
237 (sym->Flags & SYMFLAG_TLSREL) ? "tlsrel " : "",
238 (sym->Flags & SYMFLAG_REGISTER) ? "register " : "",
239 (sym->Flags & SYMFLAG_REGREL) ? "regrel " : "",
240 (sym->Flags & SYMFLAG_PARAMETER) ? "param " : "",
241 (sym->Flags & SYMFLAG_LOCAL) ? "local " : "",
242 (sym->Flags & SYMFLAG_THUNK) ? "thunk " : "");
244 /* always keep the thunks at end of the array */
246 if (sgv->num_thunks && !(sym->Flags & SYMFLAG_THUNK))
248 insp -= sgv->num_thunks;
249 memmove(&sgv->syms[insp + 1], &sgv->syms[insp],
250 sizeof(sgv->syms[0]) * sgv->num_thunks);
252 if (!fill_sym_lvalue(sym, sgv->frame_offset, &sgv->syms[insp].lvalue, tmp, sizeof(tmp)))
254 dbg_printf("%s: %s\n", sym->Name, tmp);
257 sgv->syms[insp].flags = sym->Flags;
258 sgv->syms[insp].sym_info = sym->info;
264 enum sym_get_lval symbol_picker_interactive(const char* name, const struct sgv_data* sgv,
265 struct dbg_lvalue* rtn)
270 if (!dbg_interactiveP)
272 dbg_printf("More than one symbol named %s, picking the first one\n", name);
273 *rtn = sgv->syms[0].lvalue;
277 dbg_printf("Many symbols with name '%s', "
278 "choose the one you want (<cr> to abort):\n", name);
279 for (i = 0; i < sgv->num; i++)
281 if (sgv->num - sgv->num_thunks > 1 && (sgv->syms[i].flags & SYMFLAG_THUNK) && !DBG_IVAR(AlwaysShowThunks))
283 dbg_printf("[%d]: ", i + 1);
284 if (sgv->syms[i].flags & (SYMFLAG_LOCAL | SYMFLAG_PARAMETER))
286 dbg_printf("%s %sof %s\n",
287 sgv->syms[i].flags & SYMFLAG_PARAMETER ? "Parameter" : "Local variable",
288 sgv->syms[i].flags & (SYMFLAG_REGISTER|SYMFLAG_REGREL) ? "(in a register) " : "",
291 else if (sgv->syms[i].flags & SYMFLAG_THUNK)
293 print_address(&sgv->syms[i].lvalue.addr, TRUE);
294 /* FIXME: should display where the thunks points to */
295 dbg_printf(" thunk %s\n", name);
299 print_address(&sgv->syms[i].lvalue.addr, TRUE);
305 if (input_read_line("=> ", buffer, sizeof(buffer)))
307 if (buffer[0] == '\0') return sglv_aborted;
309 if (i < 1 || i > sgv->num)
310 dbg_printf("Invalid choice %d\n", i);
312 else return sglv_aborted;
313 } while (i < 1 || i > sgv->num);
315 /* The array is 0-based, but the choices are 1..n,
316 * so we have to subtract one before returning.
318 *rtn = sgv->syms[i - 1].lvalue;
322 enum sym_get_lval symbol_picker_scoped(const char* name, const struct sgv_data* sgv,
323 struct dbg_lvalue* rtn)
328 for (i = 0; i < sgv->num; i++)
330 if (sgv->num - sgv->num_thunks > 1 && (sgv->syms[i].flags & SYMFLAG_THUNK) && !DBG_IVAR(AlwaysShowThunks))
332 if (sgv->syms[i].flags & (SYMFLAG_LOCAL | SYMFLAG_PARAMETER))
338 /* FIXME: several locals with same name... which one to pick ?? */
339 dbg_printf("Several local variables/parameters for %s, aborting\n", name);
346 *rtn = sgv->syms[local].lvalue;
349 /* no locals found, multiple globals... abort for now */
350 dbg_printf("Several global variables for %s, aborting\n", name);
354 symbol_picker_t symbol_current_picker = symbol_picker_interactive;
356 /***********************************************************************
359 * Get the address of a named symbol.
361 * sglv_found: if the symbol is found
362 * sglv_unknown: if the symbol isn't found
363 * sglv_aborted: some error occurred (likely, many symbols of same name exist,
364 * and user didn't pick one of them)
366 enum sym_get_lval symbol_get_lvalue(const char* name, const int lineno,
367 struct dbg_lvalue* rtn, BOOL bp_disp)
373 IMAGEHLP_STACK_FRAME ihsf;
375 if (strlen(name) + 4 > sizeof(buffer))
377 WINE_WARN("Too long symbol (%s)\n", name);
383 sgv.name = &buffer[2];
384 sgv.do_thunks = DBG_IVAR(AlwaysShowThunks);
386 if (strchr(name, '!'))
388 strcpy(buffer, name);
394 strcpy(&buffer[2], name);
397 /* this is a wine specific options to return also ELF modules in the
400 SymSetOptions((opt = SymGetOptions()) | 0x40000000);
401 SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv);
405 const char* ptr = strchr(name, '!');
406 if ((ptr && ptr[1] != '_') || (!ptr && *name != '_'))
410 int offset = ptr - name;
411 memcpy(buffer, name, offset + 1);
412 buffer[offset + 1] = '_';
413 strcpy(&buffer[offset + 2], ptr + 1);
420 strcpy(&buffer[3], name);
422 SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv);
427 /* now grab local symbols */
428 if (stack_get_current_frame(&ihsf) && sgv.num < NUMDBGV)
430 sgv.frame_offset = ihsf.FrameOffset;
431 SymEnumSymbols(dbg_curr_process->handle, 0, name, sgv_cb, (void*)&sgv);
436 dbg_printf("No symbols found for %s\n", name);
440 /* recompute potential offsets for functions (linenumber, skip prolog) */
441 for (i = 0; i < sgv.num; i++)
443 if (sgv.syms[i].flags & (SYMFLAG_REGISTER|SYMFLAG_REGREL|SYMFLAG_LOCAL|SYMFLAG_THUNK))
448 struct dbg_type type;
451 type.module = sgv.syms[i].lvalue.type.module;
452 type.id = sgv.syms[i].sym_info;
453 if (bp_disp && symbol_get_debug_start(&type, &addr))
454 sgv.syms[i].lvalue.addr.Offset = addr;
462 il.SizeOfStruct = sizeof(il);
463 SymGetLineFromAddr64(dbg_curr_process->handle,
464 (DWORD_PTR)memory_to_linear_addr(&sgv.syms[i].lvalue.addr),
468 if (lineno == il.LineNumber)
470 sgv.syms[i].lvalue.addr.Offset = il.Address;
474 } while (SymGetLineNext64(dbg_curr_process->handle, &il));
476 WINE_FIXME("No line (%d) found for %s (setting to symbol start)\n",
481 if (sgv.num - sgv.num_thunks > 1 || /* many symbols non thunks (and showing only non thunks) */
482 (sgv.num > 1 && DBG_IVAR(AlwaysShowThunks)) || /* many symbols (showing symbols & thunks) */
483 (sgv.num == sgv.num_thunks && sgv.num_thunks > 1))
485 return symbol_current_picker(name, &sgv, rtn);
487 /* first symbol is the one we want:
488 * - only one symbol found,
489 * - or many symbols but only one non thunk when AlwaysShowThunks is FALSE
491 *rtn = sgv.syms[0].lvalue;
495 BOOL symbol_is_local(const char* name)
498 IMAGEHLP_STACK_FRAME ihsf;
503 sgv.do_thunks = FALSE;
505 if (stack_get_current_frame(&ihsf))
507 sgv.frame_offset = ihsf.FrameOffset;
508 SymEnumSymbols(dbg_curr_process->handle, 0, name, sgv_cb, (void*)&sgv);
513 /***********************************************************************
514 * symbol_read_symtable
516 * Read a symbol file into the hash table.
518 void symbol_read_symtable(const char* filename, unsigned long offset)
520 dbg_printf("No longer supported\n");
523 /* FIXME: have to implement SymAddSymbol in dbghelp, but likely we'll need to link
524 * this with an already loaded module !!
533 if (!(symbolfile = fopen(filename, "r")))
535 WINE_WARN("Unable to open symbol table %s\n", filename);
539 dbg_printf("Reading symbols from file %s\n", filename);
543 fgets(buffer, sizeof(buffer), symbolfile);
544 if (feof(symbolfile)) break;
546 /* Strip any text after a # sign (i.e. comments) */
547 cpnt = strchr(buffer, '#');
548 if (cpnt) *cpnt = '\0';
550 /* Quietly ignore any lines that have just whitespace */
551 for (cpnt = buffer; *cpnt; cpnt++)
553 if (*cpnt != ' ' && *cpnt != '\t') break;
555 if (!*cpnt || *cpnt == '\n') continue;
557 if (sscanf(buffer, "%lx %c %s", &addr, &type, name) == 3)
559 if (value.addr.off + offset < value.addr.off)
560 WINE_WARN("Address wrap around\n");
561 value.addr.off += offset;
562 SymAddSymbol(current_process->handle, BaseOfDll,
570 /***********************************************************************
571 * symbol_get_function_line_status
573 * Find the symbol nearest to a given address.
575 enum dbg_line_status symbol_get_function_line_status(const ADDRESS64* addr)
579 ULONG64 disp64, start;
580 DWORD_PTR lin = (DWORD_PTR)memory_to_linear_addr(addr);
581 char buffer[sizeof(SYMBOL_INFO) + 256];
582 SYMBOL_INFO* sym = (SYMBOL_INFO*)buffer;
583 struct dbg_type func;
585 il.SizeOfStruct = sizeof(il);
586 sym->SizeOfStruct = sizeof(SYMBOL_INFO);
587 sym->MaxNameLen = sizeof(buffer) - sizeof(SYMBOL_INFO);
589 /* do we have some info for lin address ? */
590 if (!SymFromAddr(dbg_curr_process->handle, lin, &disp64, sym))
593 /* some compilers insert thunks in their code without debug info associated
594 * take care of this situation
596 if (be_cpu->is_jump((void*)lin, &jumpee))
597 return symbol_get_function_line_status(&jumpee);
598 return dbg_no_line_info;
604 /* FIXME: so far dbghelp doesn't return the 16 <=> 32 thunks
605 * and furthermore, we no longer take care of them !!!
607 return dbg_in_a_thunk;
609 case SymTagPublicSymbol: break;
611 WINE_FIXME("Unexpected sym-tag 0x%08x\n", sym->Tag);
613 return dbg_no_line_info;
615 /* we should have a function now */
616 if (!SymGetLineFromAddr64(dbg_curr_process->handle, lin, &disp, &il))
617 return dbg_no_line_info;
619 func.module = sym->ModBase;
622 if (symbol_get_debug_start(&func, &start) && lin < start)
623 return dbg_not_on_a_line_number;
625 if (!sym->Size) sym->Size = 0x100000;
626 if (il.FileName && il.FileName[0] && disp < sym->Size)
627 return (disp == 0) ? dbg_on_a_line_number : dbg_not_on_a_line_number;
629 return dbg_no_line_info;
632 /***********************************************************************
635 * Find the symbol nearest to a given address.
636 * Returns sourcefile name and line number in a format that the listing
637 * handler can deal with.
639 BOOL symbol_get_line(const char* filename, const char* name,
640 IMAGEHLP_LINE64* line)
645 unsigned i, found = FALSE;
650 sgv.name = &buffer[2];
651 sgv.do_thunks = FALSE;
655 strcpy(&buffer[2], name);
657 /* this is a wine specific options to return also ELF modules in the
660 SymSetOptions((opt = SymGetOptions()) | 0x40000000);
661 if (!SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv))
667 if (!sgv.num && (name[0] != '_'))
670 strcpy(&buffer[3], name);
671 if (!SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv))
679 for (i = 0; i < sgv.num; i++)
681 DWORD_PTR linear = (DWORD_PTR)memory_to_linear_addr(&sgv.syms[i].lvalue.addr);
683 il.SizeOfStruct = sizeof(il);
684 if (!SymGetLineFromAddr64(dbg_curr_process->handle, linear, &disp, &il))
686 if (filename && strcmp(il.FileName, filename)) continue;
689 WINE_FIXME("Several found, returning first (may not be what you want)...\n");
697 if (filename) dbg_printf("No such function %s in %s\n", name, filename);
698 else dbg_printf("No such function %s\n", name);
704 /******************************************************************
708 * <name>=<value> in non detailed form
709 * <name>=<value> (local|pmt <where>) in detailed form
710 * Note <value> can be an error message in case of error
712 void symbol_print_local(const SYMBOL_INFO* sym, DWORD_PTR base, BOOL detailed)
714 struct dbg_lvalue lvalue;
717 dbg_printf("%s=", sym->Name);
719 if (fill_sym_lvalue(sym, base, &lvalue, buffer, sizeof(buffer)))
721 print_value(&lvalue, 0, 1);
723 dbg_printf(" (%s %s)",
724 (sym->Flags & SYMFLAG_PARAMETER) ? "parameter" : "local",
729 dbg_printf("%s", buffer);
732 (sym->Flags & SYMFLAG_PARAMETER) ? "parameter" : "local");
736 static BOOL CALLBACK info_locals_cb(PSYMBOL_INFO sym, ULONG size, PVOID ctx)
738 struct dbg_type type;
741 type.module = sym->ModBase;
742 type.id = sym->TypeIndex;
743 types_print_type(&type, FALSE);
746 symbol_print_local(sym, (DWORD_PTR)ctx, TRUE);
752 int symbol_info_locals(void)
754 IMAGEHLP_STACK_FRAME ihsf;
757 stack_get_current_frame(&ihsf);
758 addr.Mode = AddrModeFlat;
759 addr.Offset = ihsf.InstructionOffset;
760 print_address(&addr, FALSE);
761 dbg_printf(": (%08lx)\n", (DWORD_PTR)ihsf.FrameOffset);
762 SymEnumSymbols(dbg_curr_process->handle, 0, NULL, info_locals_cb, (void*)(DWORD_PTR)ihsf.FrameOffset);
768 static BOOL CALLBACK symbols_info_cb(PSYMBOL_INFO sym, ULONG size, PVOID ctx)
770 struct dbg_type type;
773 mi.SizeOfStruct = sizeof(mi);
775 if (!SymGetModuleInfo(dbg_curr_process->handle, sym->ModBase, &mi))
776 mi.ModuleName[0] = '\0';
779 size_t len = strlen(mi.ModuleName);
780 if (len > 5 && !strcmp(mi.ModuleName + len - 5, "<elf>"))
781 mi.ModuleName[len - 5] = '\0';
784 dbg_printf("%08lx: %s!%s", (ULONG_PTR)sym->Address, mi.ModuleName, sym->Name);
785 type.id = sym->TypeIndex;
786 type.module = sym->ModBase;
788 if (sym->TypeIndex != dbg_itype_none && sym->TypeIndex != 0)
791 types_print_type(&type, FALSE);
797 void symbol_info(const char* str)
802 if (strlen(str) + 3 >= sizeof(buffer))
804 dbg_printf("Symbol too long (%s)\n", str);
809 strcpy(&buffer[2], str);
810 /* this is a wine specific options to return also ELF modules in the
813 SymSetOptions((opt = SymGetOptions()) | 0x40000000);
814 SymEnumSymbols(dbg_curr_process->handle, 0, buffer, symbols_info_cb, NULL);