2 * File dbghelp_private.h - dbghelp internal definitions
4 * Copyright (C) 1995, Alexandre Julliard
5 * Copyright (C) 1996, Eric Youngdale.
6 * Copyright (C) 1999-2000, Ulrich Weigand.
7 * Copyright (C) 2004-2007, Eric Pouech.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
32 #include "wine/unicode.h"
36 /* #define USE_STATS */
38 struct pool /* poor's man */
40 struct pool_arena* first;
44 void pool_init(struct pool* a, unsigned arena_size);
45 void pool_destroy(struct pool* a);
46 void* pool_alloc(struct pool* a, unsigned len);
47 char* pool_strdup(struct pool* a, const char* str);
56 unsigned buckets_allocated;
59 void vector_init(struct vector* v, unsigned elt_sz, unsigned bucket_sz);
60 unsigned vector_length(const struct vector* v);
61 void* vector_at(const struct vector* v, unsigned pos);
62 void* vector_add(struct vector* v, struct pool* pool);
66 struct vector key2index;
67 struct vector elements;
70 void sparse_array_init(struct sparse_array* sa, unsigned elt_sz, unsigned bucket_sz);
71 void* sparse_array_find(const struct sparse_array* sa, unsigned long idx);
72 void* sparse_array_add(struct sparse_array* sa, unsigned long key, struct pool* pool);
73 unsigned sparse_array_length(const struct sparse_array* sa);
78 struct hash_table_elt* next;
85 struct hash_table_elt** buckets;
89 void hash_table_init(struct pool* pool, struct hash_table* ht,
90 unsigned num_buckets);
91 void hash_table_destroy(struct hash_table* ht);
92 void hash_table_add(struct hash_table* ht, struct hash_table_elt* elt);
93 void* hash_table_find(const struct hash_table* ht, const char* name);
94 unsigned hash_table_hash(const char* name, unsigned num_buckets);
96 struct hash_table_iter
98 const struct hash_table* ht;
99 struct hash_table_elt* element;
104 void hash_table_iter_init(const struct hash_table* ht,
105 struct hash_table_iter* hti, const char* name);
106 void* hash_table_iter_up(struct hash_table_iter* hti);
108 #define GET_ENTRY(__i, __t, __f) \
109 ((__t*)((char*)(__i) - FIELD_OFFSET(__t,__f)))
112 extern unsigned dbghelp_options;
113 /* some more Wine extensions */
114 #define SYMOPT_WINE_WITH_ELF_MODULES 0x40000000
116 enum location_kind {loc_error, /* reg is the error code */
117 loc_absolute, /* offset is the location */
118 loc_register, /* reg is the location */
119 loc_regrel, /* [reg+offset] is the location */
120 loc_user, /* value is debug information dependent,
121 reg & offset can be used ad libidem */
124 enum location_error {loc_err_internal = -1, /* internal while computing */
125 loc_err_too_complex = -2, /* couldn't compute location (even at runtime) */
126 loc_err_out_of_scope = -3, /* variable isn't available at current address */
127 loc_err_cant_read = -4, /* couldn't read memory at given address */
134 unsigned long offset;
145 struct hash_table_elt hash_elt; /* if global symbol or type */
152 unsigned long address;
154 struct symt* container; /* block, or func */
155 struct vector vchildren; /* sub-blocks & local variables */
158 struct symt_compiland
161 unsigned long address;
163 struct vector vchildren; /* global variables & functions */
169 struct hash_table_elt hash_elt; /* if global symbol */
171 struct symt* container;
173 union /* depends on kind */
175 /* DataIs{Global, FileStatic}:
176 * loc.kind is loc_absolute
177 * loc.offset is address
178 * DataIs{Local,Param}:
180 * loc_absolute not supported
181 * loc_register location is in register loc.reg
182 * loc_regrel location is at address loc.reg + loc.offset
183 * >= loc_user ask debug info provider for resolution
186 /* DataIs{Member} (all values are in bits, not bytes) */
190 unsigned long length;
200 struct hash_table_elt hash_elt; /* if global symbol */
201 unsigned long address;
202 struct symt* container; /* compiland */
203 struct symt* type; /* points to function_signature */
205 struct vector vlines;
206 struct vector vchildren; /* locals, params, blocks, start/end, labels */
209 struct symt_hierarchy_point
211 struct symt symt; /* either SymTagFunctionDebugStart, SymTagFunctionDebugEnd, SymTagLabel */
212 struct hash_table_elt hash_elt; /* if label (and in compiland's hash table if global) */
213 struct symt* parent; /* symt_function or symt_compiland */
220 struct hash_table_elt hash_elt;
221 struct symt* container; /* compiland */
222 unsigned long address;
224 unsigned in_code : 1,
231 struct hash_table_elt hash_elt;
232 struct symt* container; /* compiland */
233 unsigned long address;
235 THUNK_ORDINAL ordinal; /* FIXME: doesn't seem to be accessible */
244 struct symt* base_type;
245 struct symt* index_type;
251 struct hash_table_elt hash_elt;
259 struct symt* base_type;
261 struct vector vchildren;
264 struct symt_function_signature
267 struct symt* rettype;
268 struct vector vchildren;
269 enum CV_call_e call_conv;
272 struct symt_function_arg_type
275 struct symt* arg_type;
276 struct symt* container;
282 struct symt* pointsto;
288 struct hash_table_elt hash_elt;
295 struct hash_table_elt hash_elt;
298 struct vector vchildren;
303 DMT_UNKNOWN, /* for lookup, not actually used for a module */
304 DMT_ELF, /* a real ELF shared module */
305 DMT_PE, /* a native or builtin PE module */
306 DMT_PDB, /* .PDB file */
307 DMT_DBG, /* .DBG file */
314 IMAGEHLP_MODULEW64 module;
315 /* ANSI copy of module.ModuleName for efficiency */
316 char module_name[MAX_PATH];
318 enum module_type type : 16;
319 unsigned short is_virtual : 1;
321 /* specific information for debug types */
322 struct elf_module_info* elf_info;
323 struct dwarf2_module_info_s*dwarf2_info;
325 /* memory allocation pool */
328 /* symbols & symbol tables */
330 unsigned num_sorttab; /* number of symbols with addresses */
331 struct symt_ht** addr_sorttab;
332 struct hash_table ht_symbols;
333 void (*loc_compute)(struct process* pcs,
334 const struct module* module,
335 const struct symt_function* func,
336 struct location* loc);
339 struct hash_table ht_types;
340 struct vector vtypes;
343 unsigned sources_used;
344 unsigned sources_alloc;
350 struct process* next;
354 PSYMBOL_REGISTERED_CALLBACK64 reg_cb;
358 struct module* lmodules;
359 unsigned long dbg_hdr_addr;
361 IMAGEHLP_STACK_FRAME ctx_frame;
363 unsigned buffer_size;
369 unsigned long is_first : 1,
375 unsigned long pc_offset; /* if is_source_file isn't set */
376 unsigned source_file; /* if is_source_file is set */
383 struct module* requested; /* in: to module_get_debug() */
384 struct module* effective; /* out: module with debug info */
387 enum pdb_kind {PDB_JG, PDB_DS};
391 const char* filename;
399 struct PDB_JG_TOC* toc;
404 struct PDB_DS_TOC* toc;
410 extern struct process* process_find_by_handle(HANDLE hProcess);
411 extern HANDLE hMsvcrt;
412 extern BOOL validate_addr64(DWORD64 addr);
413 extern BOOL pcs_callback(const struct process* pcs, ULONG action, void* data);
414 extern void* fetch_buffer(struct process* pcs, unsigned size);
417 #define ELF_NO_MAP ((const void*)0xffffffff)
418 typedef BOOL (*elf_enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
419 extern BOOL elf_enum_modules(HANDLE hProc, elf_enum_modules_cb, void*);
420 extern BOOL elf_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
422 extern BOOL elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
423 extern struct module*
424 elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
425 extern BOOL elf_read_wine_loader_dbg_info(struct process* pcs);
426 extern BOOL elf_synchronize_module_list(struct process* pcs);
427 struct elf_thunk_area;
428 extern int elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
429 extern DWORD WINAPI addr_to_linear(HANDLE hProcess, HANDLE hThread, ADDRESS* addr);
432 extern const WCHAR S_ElfW[];
433 extern const WCHAR S_WineLoaderW[];
434 extern const WCHAR S_WinePThreadW[];
435 extern const WCHAR S_WineKThreadW[];
436 extern const WCHAR S_SlashW[];
438 extern struct module*
439 module_find_by_addr(const struct process* pcs, unsigned long addr,
440 enum module_type type);
441 extern struct module*
442 module_find_by_name(const struct process* pcs,
444 extern struct module*
445 module_find_by_nameA(const struct process* pcs,
447 extern struct module*
448 module_is_already_loaded(const struct process* pcs,
449 const WCHAR* imgname);
450 extern BOOL module_get_debug(struct module_pair*);
451 extern struct module*
452 module_new(struct process* pcs, const WCHAR* name,
453 enum module_type type, BOOL virtual,
454 unsigned long addr, unsigned long size,
455 unsigned long stamp, unsigned long checksum);
456 extern struct module*
457 module_get_container(const struct process* pcs,
458 const struct module* inner);
459 extern struct module*
460 module_get_containee(const struct process* pcs,
461 const struct module* inner);
462 extern enum module_type
463 module_get_type_by_name(const WCHAR* name);
464 extern void module_reset_debug_info(struct module* module);
465 extern BOOL module_remove(struct process* pcs,
466 struct module* module);
467 extern void module_set_module(struct module* module, const WCHAR* name);
470 extern BOOL pe_load_debug_directory(const struct process* pcs,
471 struct module* module,
473 const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
474 const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
475 extern BOOL pdb_fetch_file_info(struct pdb_lookup* pdb_lookup);
478 extern BOOL path_find_symbol_file(const struct process* pcs, PCSTR full_path,
479 const GUID* guid, DWORD dw1, DWORD dw2, PSTR buffer,
483 extern BOOL pe_load_nt_header(HANDLE hProc, DWORD base, IMAGE_NT_HEADERS* nth);
484 extern struct module*
485 pe_load_native_module(struct process* pcs, const WCHAR* name,
486 HANDLE hFile, DWORD base, DWORD size);
487 extern struct module*
488 pe_load_builtin_module(struct process* pcs, const WCHAR* name,
489 DWORD base, DWORD size);
490 extern BOOL pe_load_debug_info(const struct process* pcs,
491 struct module* module);
493 extern unsigned source_new(struct module* module, const char* basedir, const char* source);
494 extern const char* source_get(const struct module* module, unsigned idx);
497 extern BOOL stabs_parse(struct module* module, unsigned long load_offset,
498 const void* stabs, int stablen,
499 const char* strs, int strtablen);
502 extern BOOL dwarf2_parse(struct module* module, unsigned long load_offset,
503 const struct elf_thunk_area* thunks,
504 const unsigned char* debug, unsigned int debug_size,
505 const unsigned char* abbrev, unsigned int abbrev_size,
506 const unsigned char* str, unsigned int str_size,
507 const unsigned char* line, unsigned int line_size,
508 const unsigned char* loclist, unsigned int loclist_size);
511 extern const char* symt_get_name(const struct symt* sym);
512 extern int symt_cmp_addr(const void* p1, const void* p2);
513 extern void copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
514 extern struct symt_ht*
515 symt_find_nearest(struct module* module, DWORD addr);
516 extern struct symt_compiland*
517 symt_new_compiland(struct module* module, unsigned long address,
519 extern struct symt_public*
520 symt_new_public(struct module* module,
521 struct symt_compiland* parent,
522 const char* typename,
523 unsigned long address, unsigned size,
524 BOOL in_code, BOOL is_func);
525 extern struct symt_data*
526 symt_new_global_variable(struct module* module,
527 struct symt_compiland* parent,
528 const char* name, unsigned is_static,
529 unsigned long addr, unsigned long size,
531 extern struct symt_function*
532 symt_new_function(struct module* module,
533 struct symt_compiland* parent,
535 unsigned long addr, unsigned long size,
537 extern BOOL symt_normalize_function(struct module* module,
538 struct symt_function* func);
539 extern void symt_add_func_line(struct module* module,
540 struct symt_function* func,
541 unsigned source_idx, int line_num,
542 unsigned long offset);
543 extern struct symt_data*
544 symt_add_func_local(struct module* module,
545 struct symt_function* func,
546 enum DataKind dt, const struct location* loc,
547 struct symt_block* block,
548 struct symt* type, const char* name);
549 extern struct symt_block*
550 symt_open_func_block(struct module* module,
551 struct symt_function* func,
552 struct symt_block* block,
553 unsigned pc, unsigned len);
554 extern struct symt_block*
555 symt_close_func_block(struct module* module,
556 struct symt_function* func,
557 struct symt_block* block, unsigned pc);
558 extern struct symt_hierarchy_point*
559 symt_add_function_point(struct module* module,
560 struct symt_function* func,
561 enum SymTagEnum point,
562 const struct location* loc,
564 extern BOOL symt_fill_func_line_info(const struct module* module,
565 const struct symt_function* func,
566 DWORD addr, IMAGEHLP_LINE* line);
567 extern BOOL symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE line);
568 extern struct symt_thunk*
569 symt_new_thunk(struct module* module,
570 struct symt_compiland* parent,
571 const char* name, THUNK_ORDINAL ord,
572 unsigned long addr, unsigned long size);
573 extern struct symt_data*
574 symt_new_constant(struct module* module,
575 struct symt_compiland* parent,
576 const char* name, struct symt* type,
578 extern struct symt_hierarchy_point*
579 symt_new_label(struct module* module,
580 struct symt_compiland* compiland,
581 const char* name, unsigned long address);
584 extern void symt_init_basic(struct module* module);
585 extern BOOL symt_get_info(const struct symt* type,
586 IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
587 extern struct symt_basic*
588 symt_new_basic(struct module* module, enum BasicType,
589 const char* typename, unsigned size);
590 extern struct symt_udt*
591 symt_new_udt(struct module* module, const char* typename,
592 unsigned size, enum UdtKind kind);
593 extern BOOL symt_set_udt_size(struct module* module,
594 struct symt_udt* type, unsigned size);
595 extern BOOL symt_add_udt_element(struct module* module,
596 struct symt_udt* udt_type,
598 struct symt* elt_type, unsigned offset,
600 extern struct symt_enum*
601 symt_new_enum(struct module* module, const char* typename,
602 struct symt* basetype);
603 extern BOOL symt_add_enum_element(struct module* module,
604 struct symt_enum* enum_type,
605 const char* name, int value);
606 extern struct symt_array*
607 symt_new_array(struct module* module, int min, int max,
608 struct symt* base, struct symt* index);
609 extern struct symt_function_signature*
610 symt_new_function_signature(struct module* module,
611 struct symt* ret_type,
612 enum CV_call_e call_conv);
613 extern BOOL symt_add_function_signature_parameter(struct module* module,
614 struct symt_function_signature* sig,
616 extern struct symt_pointer*
617 symt_new_pointer(struct module* module,
618 struct symt* ref_type);
619 extern struct symt_typedef*
620 symt_new_typedef(struct module* module, struct symt* ref,