?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Added a few functions that are now implemented.
[wine/testsucceed.git] / programs / winedbg / symbol.c
blob4c4a8389d749223dbdceb1a84af0f2bad3e3095b
1 /*
2 * Generate hash tables for Wine debugger symbols
3 *
4 * Copyright (C) 1993, Eric Youngdale.
5 * 2004, Eric Pouech.
6 *
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.
11 *
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.
16 *
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22 #define NONAMELESSUNION
23 #define NONAMELESSSTRUCT
24
25 #include "config.h"
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include <string.h>
29
30 #include "debugger.h"
31 #include "wine/debug.h"
32
33 WINE_DEFAULT_DEBUG_CHANNEL(winedbg);
34
35 static BOOL symbol_get_debug_start(DWORD mod_base, DWORD typeid, ULONG64* start)
36 {
37 DWORD count, tag;
38 char buffer[sizeof(TI_FINDCHILDREN_PARAMS) + 256 * sizeof(DWORD)];
39 TI_FINDCHILDREN_PARAMS* fcp = (TI_FINDCHILDREN_PARAMS*)buffer;
40 int i;
41 struct dbg_type type;
42
43 type.module = mod_base;
44 type.id = typeid;
45
46 if (!types_get_info(&type, TI_GET_CHILDRENCOUNT, &count)) return FALSE;
47 fcp->Start = 0;
48 while (count)
49 {
50 fcp->Count = min(count, 256);
51 if (types_get_info(&type, TI_FINDCHILDREN, fcp))
52 {
53 for (i = 0; i < min(fcp->Count, count); i++)
54 {
55 type.id = fcp->ChildId[i];
56 types_get_info(&type, TI_GET_SYMTAG, &tag);
57 if (tag != SymTagFuncDebugStart) continue;
58 return types_get_info(&type, TI_GET_ADDRESS, start);
59 }
60 count -= min(count, 256);
61 fcp->Start += 256;
62 }
63 }
64 return FALSE;
65 }
66
67 struct sgv_data
68 {
69 #define NUMDBGV 100
70 struct {
71 /* FIXME: NUMDBGV should be made variable */
72 struct dbg_lvalue lvalue;
73 DWORD flags;
74 } syms[NUMDBGV]; /* out : will be filled in with various found symbols */
75 int num; /* out : number of found symbols */
76 int num_thunks; /* out : number of thunks found */
77 const char* name; /* in : name of symbol to look up */
78 const char* filename; /* in (opt): filename where to look up symbol */
79 int lineno; /* in (opt): line number in filename where to look up symbol */
80 unsigned bp_disp : 1, /* in : whether if we take into account func address or func first displayable insn */
81 do_thunks : 1; /* in : whether we return thunks tags */
82 IMAGEHLP_STACK_FRAME ihsf; /* in : frame for local & parameter variables look up */
83 };
84
85 static BOOL CALLBACK sgv_cb(SYMBOL_INFO* sym, ULONG size, void* ctx)
86 {
87 struct sgv_data* sgv = (struct sgv_data*)ctx;
88 ULONG64 addr;
89 IMAGEHLP_LINE il;
90 unsigned cookie = DLV_TARGET, insp;
91
92 if (sym->Flags & SYMFLAG_REGISTER)
93 {
94 const struct dbg_internal_var* div;
95
96 if (dbg_curr_frame != 0)
97 {
98 dbg_printf(" %s (register): << cannot display, not in correct frame\n",
99 sym->Name);
100 return TRUE;
101 }
102 for (div = dbg_context_vars; div->name && div->val != sym->Register; div++);
103 if (!div->name)
104 {
105 dbg_printf(" %s (register): couldn't find register %lu\n",
106 sym->Name, sym->Register);
107 return TRUE;
108 }
109 addr = (ULONG64)(DWORD_PTR)div->pval;
110 cookie = DLV_HOST;
111 }
112 else if (sym->Flags & SYMFLAG_FRAMEREL)
113 {
114 ULONG offset;
115 struct dbg_type type;
116
117 type.module = sym->ModBase;
118 type.id = sym->TypeIndex;
119 types_get_info(&type, TI_GET_OFFSET, &offset);
120 addr = sgv->ihsf.FrameOffset + offset;
121 }
122 else if (sym->Flags & SYMFLAG_THUNK)
123 {
124 if (!sgv->do_thunks) return TRUE;
125 sgv->num_thunks++;
126 addr = sym->Address;
127 }
128 else
129 {
130 il.SizeOfStruct = sizeof(il);
131 SymGetLineFromAddr(dbg_curr_process->handle, sym->Address, NULL, &il);
132 if (sgv->filename && strcmp(sgv->filename, il.FileName))
133 {
134 WINE_FIXME("File name mismatch (%s / %s)\n", sgv->filename, il.FileName);
135 return TRUE;
136 }
137
138 if (sgv->lineno == -1)
139 {
140 if (!sgv->bp_disp ||
141 !symbol_get_debug_start(sym->ModBase, sym->TypeIndex, &addr))
142 addr = sym->Address;
143 }
144 else
145 {
146 addr = 0;
147 do
148 {
149 if (sgv->lineno == il.LineNumber)
150 {
151 addr = il.Address;
152 break;
153 }
154 } while (SymGetLineNext(dbg_curr_process->handle, &il));
155 if (!addr)
156 {
157 WINE_FIXME("No line (%d) found for %s (setting to symbol)\n",
158 sgv->lineno, sgv->name);
159 addr = sym->Address;
160 }
161 }
162 }
163
164 if (sgv->num >= NUMDBGV)
165 {
166 dbg_printf("Too many addresses for symbol '%s', limiting the first %d\n",
167 sgv->name, NUMDBGV);
168 return FALSE;
169 }
170 WINE_TRACE("==> %s %s%s%s%s%s%s\n",
171 sym->Name,
172 (sym->Flags & SYMFLAG_FUNCTION) ? "func " : "",
173 (sym->Flags & SYMFLAG_FRAMEREL) ? "framerel " : "",
174 (sym->Flags & SYMFLAG_REGISTER) ? "register " : "",
175 (sym->Flags & SYMFLAG_REGREL) ? "regrel " : "",
176 (sym->Flags & SYMFLAG_PARAMETER) ? "param " : "",
177 (sym->Flags & SYMFLAG_THUNK) ? "thunk " : "");
178
179 /* always keep the thunks at end of the array */
180 insp = sgv->num;
181 if (sgv->num_thunks && !(sym->Flags & SYMFLAG_THUNK))
182 {
183 insp -= sgv->num_thunks;
184 memmove(&sgv->syms[insp + 1], &sgv->syms[insp],
185 sizeof(sgv->syms[0]) * sgv->num_thunks);
186 }
187 sgv->syms[insp].lvalue.cookie = cookie;
188 sgv->syms[insp].lvalue.addr.Mode = AddrModeFlat;
189 sgv->syms[insp].lvalue.addr.Offset = addr;
190 sgv->syms[insp].lvalue.type.module = sym->ModBase;
191 sgv->syms[insp].lvalue.type.id = sym->TypeIndex;
192 types_get_info(&sgv->syms[insp].lvalue.type, TI_GET_TYPE,
193 &sgv->syms[insp].lvalue.type.id);
194 sgv->syms[insp].flags = sym->Flags;
195 sgv->num++;
196
197 return TRUE;
198 }
199
200 /***********************************************************************
201 * symbol_get_lvalue
202 *
203 * Get the address of a named symbol.
204 * Return values:
205 * sglv_found: if the symbol is found
206 * sglv_unknown: if the symbol isn't found
207 * sglv_aborted: some error occurred (likely, many symbols of same name exist,
208 * and user didn't pick one of them)
209 */
210 enum sym_get_lval symbol_get_lvalue(const char* name, const int lineno,
211 struct dbg_lvalue* rtn, BOOL bp_disp)
212 {
213 struct sgv_data sgv;
214 int i = 0;
215 char tmp[sizeof(SYMBOL_INFO) + 256];
216 SYMBOL_INFO* si = (SYMBOL_INFO*)tmp;
217 char buffer[512];
218 DWORD opt;
219
220 if (strlen(name) + 4 > sizeof(buffer))
221 {
222 WINE_WARN("Too long symbol (%s)\n", name);
223 return sglv_unknown;
224 }
225
226 sgv.num = 0;
227 sgv.num_thunks = 0;
228 sgv.name = &buffer[2];
229 sgv.filename = NULL;
230 sgv.lineno = lineno;
231 sgv.bp_disp = bp_disp ? TRUE : FALSE;
232 sgv.do_thunks = DBG_IVAR(AlwaysShowThunks);
233
234 buffer[0] = '*';
235 buffer[1] = '!';
236 strcpy(&buffer[2], name);
237
238 /* this is a wine specific options to return also ELF modules in the
239 * enumeration
240 */
241 SymSetOptions((opt = SymGetOptions()) | 0x40000000);
242 if (!SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv))
243 {
244 SymSetOptions(opt);
245 return sglv_unknown;
246 }
247
248 if (!sgv.num && (name[0] != '_'))
249 {
250 buffer[2] = '_';
251 strcpy(&buffer[3], name);
252 if (!SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv))
253 {
254 SymSetOptions(opt);
255 return sglv_unknown;
256 }
257 }
258 SymSetOptions(opt);
259
260 /* now grab local symbols */
261 si->SizeOfStruct = sizeof(*si);
262 si->MaxNameLen = 256;
263 if (stack_get_frame(si, &sgv.ihsf) && sgv.num < NUMDBGV)
264 {
265 if (SymSetContext(dbg_curr_process->handle, &sgv.ihsf, NULL))
266 SymEnumSymbols(dbg_curr_process->handle, 0, name, sgv_cb, (void*)&sgv);
267 }
268
269 if (!sgv.num)
270 {
271 dbg_printf("No symbols found for %s\n", name);
272 return sglv_unknown;
273 }
274
275 if (dbg_interactiveP)
276 {
277 if (sgv.num - sgv.num_thunks > 1 || /* many symbols non thunks (and showing only non thunks) */
278 (sgv.num > 1 && DBG_IVAR(AlwaysShowThunks)) || /* many symbols (showing symbols & thunks) */
279 (sgv.num == sgv.num_thunks && sgv.num_thunks > 1))
280 {
281 dbg_printf("Many symbols with name '%s', "
282 "choose the one you want (<cr> to abort):\n", name);
283 for (i = 0; i < sgv.num; i++)
284 {
285 if (sgv.num - sgv.num_thunks > 1 && (sgv.syms[i].flags & SYMFLAG_THUNK) && !DBG_IVAR(AlwaysShowThunks))
286 continue;
287 dbg_printf("[%d]: ", i + 1);
288 if (sgv.syms[i].flags & SYMFLAG_LOCAL)
289 {
290 dbg_printf("local variable %sof %s\n",
291 sgv.syms[i].flags & SYMFLAG_REGISTER ? "(in a register) " : "",
292 si->Name);
293 }
294 else if (sgv.syms[i].flags & SYMFLAG_PARAMETER)
295 {
296 dbg_printf("parameter %sof %s\n",
297 sgv.syms[i].flags & SYMFLAG_REGISTER ? "(in a register) " : "",
298 si->Name);
299 }
300 else if (sgv.syms[i].flags & SYMFLAG_THUNK)
301 {
302 print_address(&sgv.syms[i].lvalue.addr, TRUE);
303 /* FIXME: should display where the thunks points to */
304 dbg_printf(" thunk %s\n", name);
305 }
306 else
307 {
308 print_address(&sgv.syms[i].lvalue.addr, TRUE);
309 dbg_printf("\n");
310 }
311 }
312 do
313 {
314 i = 0;
315 if (input_read_line("=> ", buffer, sizeof(buffer)))
316 {
317 if (buffer[0] == '\0') return sglv_aborted;
318 i = atoi(buffer);
319 if (i < 1 || i > sgv.num)
320 dbg_printf("Invalid choice %d\n", i);
321 }
322 } while (i < 1 || i > sgv.num);
323
324 /* The array is 0-based, but the choices are 1..n,
325 * so we have to subtract one before returning.
326 */
327 i--;
328 }
329 }
330 else
331 {
332 /* FIXME: could display the list of non-picked up symbols */
333 if (sgv.num > 1)
334 dbg_printf("More than one symbol named %s, picking the first one\n", name);
335 }
336 *rtn = sgv.syms[i].lvalue;
337 return sglv_found;
338 }
339
340 BOOL symbol_is_local(const char* name)
341 {
342 struct sgv_data sgv;
343 char tmp[sizeof(SYMBOL_INFO) + 256];
344 SYMBOL_INFO* si = (SYMBOL_INFO*)tmp;
345
346 sgv.num = 0;
347 sgv.num_thunks = 0;
348 sgv.name = name;
349 sgv.filename = NULL;
350 sgv.lineno = 0;
351 sgv.bp_disp = FALSE;
352 sgv.do_thunks = FALSE;
353
354 si->SizeOfStruct = sizeof(*si);
355 si->MaxNameLen = 256;
356 if (stack_get_frame(si, &sgv.ihsf) &&
357 SymSetContext(dbg_curr_process->handle, &sgv.ihsf, NULL))
358 SymEnumSymbols(dbg_curr_process->handle, 0, name, sgv_cb, (void*)&sgv);
359 return sgv.num > 0;
360 }
361
362 /***********************************************************************
363 * symbol_read_symtable
364 *
365 * Read a symbol file into the hash table.
366 */
367 void symbol_read_symtable(const char* filename, unsigned long offset)
368 {
369 dbg_printf("No longer supported\n");
370
371 #if 0
372 /* FIXME: have to implement SymAddSymbol in dbghelp, but likely we'll need to link
373 * this with an already loaded module !!
374 */
375 FILE* symbolfile;
376 unsigned addr;
377 char type;
378 char* cpnt;
379 char buffer[256];
380 char name[256];
381
382 if (!(symbolfile = fopen(filename, "r")))
383 {
384 WINE_WARN("Unable to open symbol table %s\n", filename);
385 return;
386 }
387
388 dbg_printf("Reading symbols from file %s\n", filename);
389
390 while (1)
391 {
392 fgets(buffer, sizeof(buffer), symbolfile);
393 if (feof(symbolfile)) break;
394
395 /* Strip any text after a # sign (i.e. comments) */
396 cpnt = strchr(buffer, '#');
397 if (cpnt) *cpnt = '\0';
398
399 /* Quietly ignore any lines that have just whitespace */
400 for (cpnt = buffer; *cpnt; cpnt++)
401 {
402 if (*cpnt != ' ' && *cpnt != '\t') break;
403 }
404 if (!*cpnt || *cpnt == '\n') continue;
405
406 if (sscanf(buffer, "%lx %c %s", &addr, &type, name) == 3)
407 {
408 if (value.addr.off + offset < value.addr.off)
409 WINE_WARN("Address wrap around\n");
410 value.addr.off += offset;
411 SymAddSymbol(current_process->handle, BaseOfDll,
412 name, addr, 0, 0);
413 }
414 }
415 fclose(symbolfile);
416 #endif
417 }
418
419 /***********************************************************************
420 * symbol_get_function_line_status
421 *
422 * Find the symbol nearest to a given address.
423 */
424 enum dbg_line_status symbol_get_function_line_status(const ADDRESS* addr)
425 {
426 IMAGEHLP_LINE il;
427 DWORD disp, size;
428 ULONG64 start;
429 DWORD lin = (DWORD)memory_to_linear_addr(addr);
430 char buffer[sizeof(SYMBOL_INFO) + 256];
431 SYMBOL_INFO* sym = (SYMBOL_INFO*)buffer;
432 struct dbg_type type;
433
434 il.SizeOfStruct = sizeof(il);
435 sym->SizeOfStruct = sizeof(SYMBOL_INFO);
436 sym->MaxNameLen = sizeof(buffer) - sizeof(SYMBOL_INFO);
437
438 /* do we have some info for lin address ? */
439 if (!SymFromAddr(dbg_curr_process->handle, lin, NULL, sym))
440 return dbg_no_line_info;
441
442 switch (sym->Tag)
443 {
444 case SymTagThunk:
445 /* FIXME: so far dbghelp doesn't return the 16 <=> 32 thunks
446 * and furthermore, we no longer take care of them !!!
447 */
448 return dbg_in_a_thunk;
449 case SymTagFunction:
450 case SymTagPublicSymbol: break;
451 default:
452 WINE_FIXME("Unexpected sym-tag 0x%08lx\n", sym->Tag);
453 case SymTagData:
454 return dbg_no_line_info;
455 }
456 /* we should have a function now */
457 if (!SymGetLineFromAddr(dbg_curr_process->handle, lin, &disp, &il))
458 return dbg_no_line_info;
459
460 if (symbol_get_debug_start(sym->ModBase, sym->TypeIndex, &start) && lin < start)
461 return dbg_not_on_a_line_number;
462 type.module = sym->ModBase;
463 type.id = sym->TypeIndex;
464 if (!types_get_info(&type, TI_GET_LENGTH, &size) || size == 0)
465 size = 0x100000;
466 if (il.FileName && il.FileName[0] && disp < size)
467 return (disp == 0) ? dbg_on_a_line_number : dbg_not_on_a_line_number;
468
469 return dbg_no_line_info;
470 }
471
472 /***********************************************************************
473 * symbol_get_line
474 *
475 * Find the symbol nearest to a given address.
476 * Returns sourcefile name and line number in a format that the listing
477 * handler can deal with.
478 */
479 BOOL symbol_get_line(const char* filename, const char* name, IMAGEHLP_LINE* line)
480 {
481 struct sgv_data sgv;
482 char buffer[512];
483 DWORD opt;
484
485 sgv.num = 0;
486 sgv.num_thunks = 0;
487 sgv.name = &buffer[2];
488 sgv.filename = filename;
489 sgv.lineno = -1;
490 sgv.bp_disp = FALSE;
491 sgv.do_thunks = FALSE;
492
493 buffer[0] = '*';
494 buffer[1] = '!';
495 strcpy(&buffer[2], name);
496
497 /* this is a wine specific options to return also ELF modules in the
498 * enumeration
499 */
500 SymSetOptions((opt = SymGetOptions()) | 0x40000000);
501 if (!SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv))
502 {
503 SymSetOptions(opt);
504 return sglv_unknown;
505 }
506
507 if (!sgv.num && (name[0] != '_'))
508 {
509 buffer[2] = '_';
510 strcpy(&buffer[3], name);
511 if (!SymEnumSymbols(dbg_curr_process->handle, 0, buffer, sgv_cb, (void*)&sgv))
512 {
513 SymSetOptions(opt);
514 return sglv_unknown;
515 }
516 }
517 SymSetOptions(opt);
518
519 switch (sgv.num)
520 {
521 case 0:
522 if (filename) dbg_printf("No such function %s in %s\n", name, filename);
523 else dbg_printf("No such function %s\n", name);
524 return FALSE;
525 default:
526 WINE_FIXME("Several found, returning first (may not be what you want)...\n");
527 case 1:
528 return SymGetLineFromAddr(dbg_curr_process->handle,
529 (DWORD)memory_to_linear_addr(&sgv.syms[0].lvalue.addr),
530 NULL, line);
531 }
532 return TRUE;
533 }
534
535 static BOOL CALLBACK info_locals_cb(SYMBOL_INFO* sym, ULONG size, void* ctx)
536 {
537 ULONG v, val;
538 const char* explain = NULL;
539 char buf[128];
540 struct dbg_type type;
541
542 dbg_printf("\t");
543 type.module = sym->ModBase;
544 type.id = sym->TypeIndex;
545 types_get_info(&type, TI_GET_TYPE, &type.id);
546 types_print_type(&type, FALSE);
547
548 if (sym->Flags & SYMFLAG_LOCAL) explain = "local";
549 else if (sym->Flags & SYMFLAG_PARAMETER) explain = "parameter";
550 else if (sym->Flags & SYMFLAG_REGISTER) explain = buf;
551
552 if (sym->Flags & SYMFLAG_REGISTER)
553 {
554 const struct dbg_internal_var* div;
555
556 if (dbg_curr_frame != 0)
557 {
558 dbg_printf(" %s (register): << cannot display, not in correct frame\n",
559 sym->Name);
560 return TRUE;
561 }
562 for (div = dbg_context_vars; div->name; div++)
563 {
564 if (div->val == sym->Register)
565 {
566 val = *div->pval;
567 sprintf(buf, "local in register %s", div->name);
568 break;
569 }
570 }
571 }
572 else if (sym->Flags & SYMFLAG_FRAMEREL)
573 {
574 type.id = sym->TypeIndex;
575 types_get_info(&type, TI_GET_OFFSET, &v);
576 v += ((IMAGEHLP_STACK_FRAME*)ctx)->FrameOffset;
577
578 dbg_read_memory_verbose((void*)v, &val, sizeof(val));
579 }
580 dbg_printf(" %s = 0x%8.8lx (%s)\n", sym->Name, val, explain);
581
582 return TRUE;
583 }
584
585 int symbol_info_locals(void)
586 {
587 IMAGEHLP_STACK_FRAME ihsf;
588 char buffer[sizeof(SYMBOL_INFO) + 256];
589 SYMBOL_INFO* si = (SYMBOL_INFO*)buffer;
590
591 si->SizeOfStruct = sizeof(*si);
592 si->MaxNameLen = 256;
593 if (stack_get_frame(si, &ihsf))
594 {
595 dbg_printf("%s:\n", si->Name);
596 if (SymSetContext(dbg_curr_process->handle, &ihsf, NULL))
597 SymEnumSymbols(dbg_curr_process->handle, 0, NULL, info_locals_cb, &ihsf);
598 }
599 return TRUE;
600 }
601
602 static BOOL CALLBACK symbols_info_cb(SYMBOL_INFO* sym, ULONG size, void* ctx)
603 {
604 struct dbg_type type;
605 IMAGEHLP_MODULE mi;
606
607 mi.SizeOfStruct = sizeof(mi);
608
609 if (!SymGetModuleInfo(dbg_curr_process->handle, sym->ModBase, &mi))
610 mi.ModuleName[0] = '\0';
611 else
612 {
613 size_t len = strlen(mi.ModuleName);
614 if (len > 5 && !strcmp(mi.ModuleName + len - 5, "<elf>"))
615 mi.ModuleName[len - 5] = '\0';
616 }
617
618 dbg_printf("%08lx: %s!%s", (ULONG_PTR)sym->Address, mi.ModuleName, sym->Name);
619 type.id = sym->TypeIndex;
620 type.module = sym->ModBase;
621
622 if (sym->TypeIndex != dbg_itype_none && sym->TypeIndex != 0 &&
623 types_get_info(&type, TI_GET_TYPE, &type.id))
624 {
625 dbg_printf(" ");
626 types_print_type(&type, FALSE);
627 }
628 dbg_printf("\n");
629 return TRUE;
630 }
631
632 void symbol_info(const char* str)
633 {
634 char buffer[512];
635 DWORD opt;
636
637 if (strlen(str) + 3 >= sizeof(buffer))
638 {
639 dbg_printf("Symbol too long (%s)\n", str);
640 return;
641 }
642 buffer[0] = '*';
643 buffer[1] = '!';
644 strcpy(&buffer[2], str);
645 /* this is a wine specific options to return also ELF modules in the
646 * enumeration
647 */
648 SymSetOptions((opt = SymGetOptions()) | 0x40000000);
649 SymEnumSymbols(dbg_curr_process->handle, 0, buffer, symbols_info_cb, NULL);
650 SymSetOptions(opt);
651 }
Quick hack tree for wine patches julliard doesn't want to commit