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
)
85 if (!memory_get_register(sym
->Register
, &pval
, buffer
, sz
))
87 lvalue
->cookie
= DLV_TARGET
;
88 lvalue
->addr
.Offset
= (ULONG64
)*pval
+ sym
->Address
;
90 else if (sym
->Flags
& SYMFLAG_VALUEPRESENT
)
95 type
.module
= sym
->ModBase
;
98 if (!types_get_info(&type
, TI_GET_VALUE
, &v
))
100 if (buffer
) snprintf(buffer
, sz
, "Couldn't get full value information for %s", sym
->Name
);
103 else if (v
.n1
.n2
.vt
& VT_BYREF
)
105 /* FIXME: this won't work for pointers or arrays, as we don't always
106 * know, if the value to be dereferenced lies in debuggee or
107 * debugger address space.
109 if (sym
->Tag
== SymTagPointerType
|| sym
->Tag
== SymTagArrayType
)
111 if (buffer
) snprintf(buffer
, sz
, "Couldn't dereference pointer for const value for %s", sym
->Name
);
114 /* this is likely Wine's dbghelp which passes const values by reference
115 * (object is managed by dbghelp, hence in debugger address space)
117 lvalue
->cookie
= DLV_HOST
;
118 lvalue
->addr
.Offset
= (DWORD_PTR
)sym
->Value
;
122 DWORD
* pdw
= (DWORD
*)lexeme_alloc_size(sizeof(*pdw
));
123 lvalue
->cookie
= DLV_HOST
;
124 lvalue
->addr
.Offset
= (DWORD_PTR
)pdw
;
128 else if (sym
->Flags
& SYMFLAG_LOCAL
)
130 lvalue
->cookie
= DLV_TARGET
;
131 lvalue
->addr
.Offset
= base
+ sym
->Address
;
135 lvalue
->cookie
= DLV_TARGET
;
136 lvalue
->addr
.Offset
= sym
->Address
;
138 lvalue
->addr
.Mode
= AddrModeFlat
;
139 lvalue
->type
.module
= sym
->ModBase
;
140 lvalue
->type
.id
= sym
->TypeIndex
;
150 /* FIXME: NUMDBGV should be made variable */
151 struct dbg_lvalue lvalue
;
154 } syms
[NUMDBGV
]; /* out : will be filled in with various found symbols */
155 int num
; /* out : number of found symbols */
156 int num_thunks
; /* out : number of thunks found */
157 const char* name
; /* in : name of symbol to look up */
158 unsigned do_thunks
: 1; /* in : whether we return thunks tags */
159 ULONG64 frame_offset
; /* in : frame for local & parameter variables look up */
162 static BOOL CALLBACK
sgv_cb(PSYMBOL_INFO sym
, ULONG size
, PVOID ctx
)
164 struct sgv_data
* sgv
= ctx
;
168 if (sym
->Flags
& SYMFLAG_THUNK
)
170 if (!sgv
->do_thunks
) return TRUE
;
174 if (sgv
->num
>= NUMDBGV
)
176 dbg_printf("Too many addresses for symbol '%s', limiting the first %d\n",
180 WINE_TRACE("==> %s %s%s%s%s%s%s%s\n",
182 (sym
->Flags
& SYMFLAG_FUNCTION
) ? "func " : "",
183 (sym
->Flags
& SYMFLAG_FRAMEREL
) ? "framerel " : "",
184 (sym
->Flags
& SYMFLAG_REGISTER
) ? "register " : "",
185 (sym
->Flags
& SYMFLAG_REGREL
) ? "regrel " : "",
186 (sym
->Flags
& SYMFLAG_PARAMETER
) ? "param " : "",
187 (sym
->Flags
& SYMFLAG_LOCAL
) ? "local " : "",
188 (sym
->Flags
& SYMFLAG_THUNK
) ? "thunk " : "");
190 /* always keep the thunks at end of the array */
192 if (sgv
->num_thunks
&& !(sym
->Flags
& SYMFLAG_THUNK
))
194 insp
-= sgv
->num_thunks
;
195 memmove(&sgv
->syms
[insp
+ 1], &sgv
->syms
[insp
],
196 sizeof(sgv
->syms
[0]) * sgv
->num_thunks
);
198 if (!fill_sym_lvalue(sym
, sgv
->frame_offset
, &sgv
->syms
[insp
].lvalue
, tmp
, sizeof(tmp
)))
200 dbg_printf("%s: %s\n", sym
->Name
, tmp
);
203 sgv
->syms
[insp
].flags
= sym
->Flags
;
204 sgv
->syms
[insp
].sym_info
= sym
->info
;
210 enum sym_get_lval
symbol_picker_interactive(const char* name
, const struct sgv_data
* sgv
,
211 struct dbg_lvalue
* rtn
)
216 if (!dbg_interactiveP
)
218 dbg_printf("More than one symbol named %s, picking the first one\n", name
);
219 *rtn
= sgv
->syms
[0].lvalue
;
223 dbg_printf("Many symbols with name '%s', "
224 "choose the one you want (<cr> to abort):\n", name
);
225 for (i
= 0; i
< sgv
->num
; i
++)
227 if (sgv
->num
- sgv
->num_thunks
> 1 && (sgv
->syms
[i
].flags
& SYMFLAG_THUNK
) && !DBG_IVAR(AlwaysShowThunks
))
229 dbg_printf("[%d]: ", i
+ 1);
230 if (sgv
->syms
[i
].flags
& (SYMFLAG_LOCAL
| SYMFLAG_PARAMETER
))
232 dbg_printf("%s %sof %s\n",
233 sgv
->syms
[i
].flags
& SYMFLAG_PARAMETER
? "Parameter" : "Local variable",
234 sgv
->syms
[i
].flags
& (SYMFLAG_REGISTER
|SYMFLAG_REGREL
) ? "(in a register) " : "",
237 else if (sgv
->syms
[i
].flags
& SYMFLAG_THUNK
)
239 print_address(&sgv
->syms
[i
].lvalue
.addr
, TRUE
);
240 /* FIXME: should display where the thunks points to */
241 dbg_printf(" thunk %s\n", name
);
245 print_address(&sgv
->syms
[i
].lvalue
.addr
, TRUE
);
252 if (input_read_line("=> ", buffer
, sizeof(buffer
)))
254 if (buffer
[0] == '\0') return sglv_aborted
;
256 if (i
< 1 || i
> sgv
->num
)
257 dbg_printf("Invalid choice %d\n", i
);
259 else return sglv_aborted
;
260 } while (i
< 1 || i
> sgv
->num
);
262 /* The array is 0-based, but the choices are 1..n,
263 * so we have to subtract one before returning.
265 *rtn
= sgv
->syms
[i
- 1].lvalue
;
269 enum sym_get_lval
symbol_picker_scoped(const char* name
, const struct sgv_data
* sgv
,
270 struct dbg_lvalue
* rtn
)
275 for (i
= 0; i
< sgv
->num
; i
++)
277 if (sgv
->num
- sgv
->num_thunks
> 1 && (sgv
->syms
[i
].flags
& SYMFLAG_THUNK
) && !DBG_IVAR(AlwaysShowThunks
))
279 if (sgv
->syms
[i
].flags
& (SYMFLAG_LOCAL
| SYMFLAG_PARAMETER
))
285 /* FIXME: several locals with same name... which one to pick ?? */
286 dbg_printf("Several local variables/parameters for %s, aborting\n", name
);
293 *rtn
= sgv
->syms
[local
].lvalue
;
296 /* no locals found, multiple globals... abort for now */
297 dbg_printf("Several global variables for %s, aborting\n", name
);
301 symbol_picker_t symbol_current_picker
= symbol_picker_interactive
;
303 /***********************************************************************
306 * Get the address of a named symbol.
308 * sglv_found: if the symbol is found
309 * sglv_unknown: if the symbol isn't found
310 * sglv_aborted: some error occurred (likely, many symbols of same name exist,
311 * and user didn't pick one of them)
313 enum sym_get_lval
symbol_get_lvalue(const char* name
, const int lineno
,
314 struct dbg_lvalue
* rtn
, BOOL bp_disp
)
320 IMAGEHLP_STACK_FRAME ihsf
;
322 if (strlen(name
) + 4 > sizeof(buffer
))
324 WINE_WARN("Too long symbol (%s)\n", name
);
330 sgv
.name
= &buffer
[2];
331 sgv
.do_thunks
= DBG_IVAR(AlwaysShowThunks
);
333 if (strchr(name
, '!'))
335 strcpy(buffer
, name
);
341 strcpy(&buffer
[2], name
);
344 /* this is a wine specific options to return also ELF modules in the
347 SymSetOptions((opt
= SymGetOptions()) | 0x40000000);
348 SymEnumSymbols(dbg_curr_process
->handle
, 0, buffer
, sgv_cb
, (void*)&sgv
);
352 const char* ptr
= strchr(name
, '!');
353 if ((ptr
&& ptr
[1] != '_') || (!ptr
&& *name
!= '_'))
357 int offset
= ptr
- name
;
358 memcpy(buffer
, name
, offset
+ 1);
359 buffer
[offset
+ 1] = '_';
360 strcpy(&buffer
[offset
+ 2], ptr
+ 1);
367 strcpy(&buffer
[3], name
);
369 SymEnumSymbols(dbg_curr_process
->handle
, 0, buffer
, sgv_cb
, (void*)&sgv
);
374 /* now grab local symbols */
375 if (stack_get_current_frame(&ihsf
) && sgv
.num
< NUMDBGV
)
377 sgv
.frame_offset
= ihsf
.FrameOffset
;
378 SymEnumSymbols(dbg_curr_process
->handle
, 0, name
, sgv_cb
, (void*)&sgv
);
383 dbg_printf("No symbols found for %s\n", name
);
387 /* recompute potential offsets for functions (linenumber, skip prolog) */
388 for (i
= 0; i
< sgv
.num
; i
++)
390 if (sgv
.syms
[i
].flags
& (SYMFLAG_REGISTER
|SYMFLAG_REGREL
|SYMFLAG_LOCAL
|SYMFLAG_THUNK
))
395 struct dbg_type type
;
398 type
.module
= sgv
.syms
[i
].lvalue
.type
.module
;
399 type
.id
= sgv
.syms
[i
].sym_info
;
400 if (bp_disp
&& symbol_get_debug_start(&type
, &addr
))
401 sgv
.syms
[i
].lvalue
.addr
.Offset
= addr
;
409 il
.SizeOfStruct
= sizeof(il
);
410 SymGetLineFromAddr64(dbg_curr_process
->handle
,
411 (DWORD_PTR
)memory_to_linear_addr(&sgv
.syms
[i
].lvalue
.addr
),
415 if (lineno
== il
.LineNumber
)
417 sgv
.syms
[i
].lvalue
.addr
.Offset
= il
.Address
;
421 } while (SymGetLineNext64(dbg_curr_process
->handle
, &il
));
423 WINE_FIXME("No line (%d) found for %s (setting to symbol start)\n",
428 if (sgv
.num
- sgv
.num_thunks
> 1 || /* many symbols non thunks (and showing only non thunks) */
429 (sgv
.num
> 1 && DBG_IVAR(AlwaysShowThunks
)) || /* many symbols (showing symbols & thunks) */
430 (sgv
.num
== sgv
.num_thunks
&& sgv
.num_thunks
> 1))
432 return symbol_current_picker(name
, &sgv
, rtn
);
434 /* first symbol is the one we want:
435 * - only one symbol found,
436 * - or many symbols but only one non thunk when AlwaysShowThunks is FALSE
438 *rtn
= sgv
.syms
[0].lvalue
;
442 BOOL
symbol_is_local(const char* name
)
445 IMAGEHLP_STACK_FRAME ihsf
;
450 sgv
.do_thunks
= FALSE
;
452 if (stack_get_current_frame(&ihsf
))
454 sgv
.frame_offset
= ihsf
.FrameOffset
;
455 SymEnumSymbols(dbg_curr_process
->handle
, 0, name
, sgv_cb
, (void*)&sgv
);
460 /***********************************************************************
461 * symbol_read_symtable
463 * Read a symbol file into the hash table.
465 void symbol_read_symtable(const char* filename
, unsigned long offset
)
467 dbg_printf("No longer supported\n");
470 /* FIXME: have to implement SymAddSymbol in dbghelp, but likely we'll need to link
471 * this with an already loaded module !!
480 if (!(symbolfile
= fopen(filename
, "r")))
482 WINE_WARN("Unable to open symbol table %s\n", filename
);
486 dbg_printf("Reading symbols from file %s\n", filename
);
490 fgets(buffer
, sizeof(buffer
), symbolfile
);
491 if (feof(symbolfile
)) break;
493 /* Strip any text after a # sign (i.e. comments) */
494 cpnt
= strchr(buffer
, '#');
495 if (cpnt
) *cpnt
= '\0';
497 /* Quietly ignore any lines that have just whitespace */
498 for (cpnt
= buffer
; *cpnt
; cpnt
++)
500 if (*cpnt
!= ' ' && *cpnt
!= '\t') break;
502 if (!*cpnt
|| *cpnt
== '\n') continue;
504 if (sscanf(buffer
, "%lx %c %s", &addr
, &type
, name
) == 3)
506 if (value
.addr
.off
+ offset
< value
.addr
.off
)
507 WINE_WARN("Address wrap around\n");
508 value
.addr
.off
+= offset
;
509 SymAddSymbol(current_process
->handle
, BaseOfDll
,
517 /***********************************************************************
518 * symbol_get_function_line_status
520 * Find the symbol nearest to a given address.
522 enum dbg_line_status
symbol_get_function_line_status(const ADDRESS64
* addr
)
526 ULONG64 disp64
, start
;
527 DWORD_PTR lin
= (DWORD_PTR
)memory_to_linear_addr(addr
);
528 char buffer
[sizeof(SYMBOL_INFO
) + 256];
529 SYMBOL_INFO
* sym
= (SYMBOL_INFO
*)buffer
;
530 struct dbg_type func
;
532 il
.SizeOfStruct
= sizeof(il
);
533 sym
->SizeOfStruct
= sizeof(SYMBOL_INFO
);
534 sym
->MaxNameLen
= sizeof(buffer
) - sizeof(SYMBOL_INFO
);
536 /* do we have some info for lin address ? */
537 if (!SymFromAddr(dbg_curr_process
->handle
, lin
, &disp64
, sym
))
538 return dbg_no_line_info
;
543 /* FIXME: so far dbghelp doesn't return the 16 <=> 32 thunks
544 * and furthermore, we no longer take care of them !!!
546 return dbg_in_a_thunk
;
548 case SymTagPublicSymbol
: break;
550 WINE_FIXME("Unexpected sym-tag 0x%08x\n", sym
->Tag
);
552 return dbg_no_line_info
;
554 /* we should have a function now */
555 if (!SymGetLineFromAddr64(dbg_curr_process
->handle
, lin
, &disp
, &il
))
556 return dbg_no_line_info
;
558 func
.module
= sym
->ModBase
;
561 if (symbol_get_debug_start(&func
, &start
) && lin
< start
)
562 return dbg_not_on_a_line_number
;
564 if (!sym
->Size
) sym
->Size
= 0x100000;
565 if (il
.FileName
&& il
.FileName
[0] && disp
< sym
->Size
)
566 return (disp
== 0) ? dbg_on_a_line_number
: dbg_not_on_a_line_number
;
568 return dbg_no_line_info
;
571 /***********************************************************************
574 * Find the symbol nearest to a given address.
575 * Returns sourcefile name and line number in a format that the listing
576 * handler can deal with.
578 BOOL
symbol_get_line(const char* filename
, const char* name
,
579 IMAGEHLP_LINE64
* line
)
584 unsigned i
, found
= FALSE
;
589 sgv
.name
= &buffer
[2];
590 sgv
.do_thunks
= FALSE
;
594 strcpy(&buffer
[2], name
);
596 /* this is a wine specific options to return also ELF modules in the
599 SymSetOptions((opt
= SymGetOptions()) | 0x40000000);
600 if (!SymEnumSymbols(dbg_curr_process
->handle
, 0, buffer
, sgv_cb
, (void*)&sgv
))
606 if (!sgv
.num
&& (name
[0] != '_'))
609 strcpy(&buffer
[3], name
);
610 if (!SymEnumSymbols(dbg_curr_process
->handle
, 0, buffer
, sgv_cb
, (void*)&sgv
))
618 for (i
= 0; i
< sgv
.num
; i
++)
620 DWORD_PTR linear
= (DWORD_PTR
)memory_to_linear_addr(&sgv
.syms
[i
].lvalue
.addr
);
622 il
.SizeOfStruct
= sizeof(il
);
623 if (!SymGetLineFromAddr64(dbg_curr_process
->handle
, linear
, &disp
, &il
))
625 if (filename
&& strcmp(il
.FileName
, filename
)) continue;
628 WINE_FIXME("Several found, returning first (may not be what you want)...\n");
636 if (filename
) dbg_printf("No such function %s in %s\n", name
, filename
);
637 else dbg_printf("No such function %s\n", name
);
643 /******************************************************************
647 * <name>=<value> in non detailed form
648 * <name>=<value> (local|pmt <where>) in detailed form
649 * Note <value> can be an error message in case of error
651 void symbol_print_local(const SYMBOL_INFO
* sym
, DWORD_PTR base
, BOOL detailed
)
653 struct dbg_lvalue lvalue
;
656 dbg_printf("%s=", sym
->Name
);
658 if (fill_sym_lvalue(sym
, base
, &lvalue
, buffer
, sizeof(buffer
)))
660 print_value(&lvalue
, 0, 1);
662 dbg_printf(" (%s%s)",
663 (sym
->Flags
& SYMFLAG_PARAMETER
) ? "parameter" : "local",
668 dbg_printf("%s", buffer
);
671 (sym
->Flags
& SYMFLAG_PARAMETER
) ? "parameter" : "local");
675 static BOOL CALLBACK
info_locals_cb(PSYMBOL_INFO sym
, ULONG size
, PVOID ctx
)
677 struct dbg_type type
;
680 type
.module
= sym
->ModBase
;
681 type
.id
= sym
->TypeIndex
;
682 types_print_type(&type
, FALSE
);
685 symbol_print_local(sym
, (DWORD_PTR
)ctx
, TRUE
);
691 int symbol_info_locals(void)
693 IMAGEHLP_STACK_FRAME ihsf
;
696 stack_get_current_frame(&ihsf
);
697 addr
.Mode
= AddrModeFlat
;
698 addr
.Offset
= ihsf
.InstructionOffset
;
699 print_address(&addr
, FALSE
);
700 dbg_printf(": (%08lx)\n", (DWORD_PTR
)ihsf
.FrameOffset
);
701 SymEnumSymbols(dbg_curr_process
->handle
, 0, NULL
, info_locals_cb
, (void*)(DWORD_PTR
)ihsf
.FrameOffset
);
707 static BOOL CALLBACK
symbols_info_cb(PSYMBOL_INFO sym
, ULONG size
, PVOID ctx
)
709 struct dbg_type type
;
712 mi
.SizeOfStruct
= sizeof(mi
);
714 if (!SymGetModuleInfo(dbg_curr_process
->handle
, sym
->ModBase
, &mi
))
715 mi
.ModuleName
[0] = '\0';
718 size_t len
= strlen(mi
.ModuleName
);
719 if (len
> 5 && !strcmp(mi
.ModuleName
+ len
- 5, "<elf>"))
720 mi
.ModuleName
[len
- 5] = '\0';
723 dbg_printf("%08lx: %s!%s", (ULONG_PTR
)sym
->Address
, mi
.ModuleName
, sym
->Name
);
724 type
.id
= sym
->TypeIndex
;
725 type
.module
= sym
->ModBase
;
727 if (sym
->TypeIndex
!= dbg_itype_none
&& sym
->TypeIndex
!= 0)
730 types_print_type(&type
, FALSE
);
736 void symbol_info(const char* str
)
741 if (strlen(str
) + 3 >= sizeof(buffer
))
743 dbg_printf("Symbol too long (%s)\n", str
);
748 strcpy(&buffer
[2], str
);
749 /* this is a wine specific options to return also ELF modules in the
752 SymSetOptions((opt
= SymGetOptions()) | 0x40000000);
753 SymEnumSymbols(dbg_curr_process
->handle
, 0, buffer
, symbols_info_cb
, NULL
);