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/list.h"
33 #include "wine/unicode.h"
37 /* #define USE_STATS */
39 struct pool /* poor's man */
41 struct list arena_list;
42 struct list arena_full;
46 void pool_init(struct pool* a, size_t arena_size);
47 void pool_destroy(struct pool* a);
48 void* pool_alloc(struct pool* a, size_t len);
49 char* pool_strdup(struct pool* a, const char* str);
58 unsigned buckets_allocated;
61 void vector_init(struct vector* v, unsigned elt_sz, unsigned bucket_sz);
62 unsigned vector_length(const struct vector* v);
63 void* vector_at(const struct vector* v, unsigned pos);
64 void* vector_add(struct vector* v, struct pool* pool);
68 struct vector key2index;
69 struct vector elements;
72 void sparse_array_init(struct sparse_array* sa, unsigned elt_sz, unsigned bucket_sz);
73 void* sparse_array_find(const struct sparse_array* sa, unsigned long idx);
74 void* sparse_array_add(struct sparse_array* sa, unsigned long key, struct pool* pool);
75 unsigned sparse_array_length(const struct sparse_array* sa);
80 struct hash_table_elt* next;
83 struct hash_table_bucket
85 struct hash_table_elt* first;
86 struct hash_table_elt* last;
93 struct hash_table_bucket* buckets;
97 void hash_table_init(struct pool* pool, struct hash_table* ht,
98 unsigned num_buckets);
99 void hash_table_destroy(struct hash_table* ht);
100 void hash_table_add(struct hash_table* ht, struct hash_table_elt* elt);
102 struct hash_table_iter
104 const struct hash_table* ht;
105 struct hash_table_elt* element;
110 void hash_table_iter_init(const struct hash_table* ht,
111 struct hash_table_iter* hti, const char* name);
112 void* hash_table_iter_up(struct hash_table_iter* hti);
114 #define GET_ENTRY(__i, __t, __f) \
115 ((__t*)((char*)(__i) - FIELD_OFFSET(__t,__f)))
118 extern unsigned dbghelp_options;
119 /* some more Wine extensions */
120 #define SYMOPT_WINE_WITH_NATIVE_MODULES 0x40000000
122 enum location_kind {loc_error, /* reg is the error code */
123 loc_absolute, /* offset is the location */
124 loc_register, /* reg is the location */
125 loc_regrel, /* [reg+offset] is the location */
126 loc_user, /* value is debug information dependent,
127 reg & offset can be used ad libidem */
130 enum location_error {loc_err_internal = -1, /* internal while computing */
131 loc_err_too_complex = -2, /* couldn't compute location (even at runtime) */
132 loc_err_out_of_scope = -3, /* variable isn't available at current address */
133 loc_err_cant_read = -4, /* couldn't read memory at given address */
140 unsigned long offset;
151 struct hash_table_elt hash_elt; /* if global symbol or type */
158 unsigned long address;
160 struct symt* container; /* block, or func */
161 struct vector vchildren; /* sub-blocks & local variables */
164 struct symt_compiland
167 unsigned long address;
169 struct vector vchildren; /* global variables & functions */
175 struct hash_table_elt hash_elt; /* if global symbol */
177 struct symt* container;
179 union /* depends on kind */
181 /* DataIs{Global, FileStatic}:
182 * loc.kind is loc_absolute
183 * loc.offset is address
184 * DataIs{Local,Param}:
186 * loc_absolute not supported
187 * loc_register location is in register loc.reg
188 * loc_regrel location is at address loc.reg + loc.offset
189 * >= loc_user ask debug info provider for resolution
192 /* DataIs{Member} (all values are in bits, not bytes) */
196 unsigned long length;
206 struct hash_table_elt hash_elt; /* if global symbol */
207 unsigned long address;
208 struct symt* container; /* compiland */
209 struct symt* type; /* points to function_signature */
211 struct vector vlines;
212 struct vector vchildren; /* locals, params, blocks, start/end, labels */
215 struct symt_hierarchy_point
217 struct symt symt; /* either SymTagFunctionDebugStart, SymTagFunctionDebugEnd, SymTagLabel */
218 struct hash_table_elt hash_elt; /* if label (and in compiland's hash table if global) */
219 struct symt* parent; /* symt_function or symt_compiland */
226 struct hash_table_elt hash_elt;
227 struct symt* container; /* compiland */
228 unsigned long address;
235 struct hash_table_elt hash_elt;
236 struct symt* container; /* compiland */
237 unsigned long address;
239 THUNK_ORDINAL ordinal; /* FIXME: doesn't seem to be accessible */
247 int end; /* end index if > 0, or -array_len (in bytes) if < 0 */
248 struct symt* base_type;
249 struct symt* index_type;
255 struct hash_table_elt hash_elt;
263 struct symt* base_type;
265 struct vector vchildren;
268 struct symt_function_signature
271 struct symt* rettype;
272 struct vector vchildren;
273 enum CV_call_e call_conv;
276 struct symt_function_arg_type
279 struct symt* arg_type;
280 struct symt* container;
286 struct symt* pointsto;
292 struct hash_table_elt hash_elt;
299 struct hash_table_elt hash_elt;
302 struct vector vchildren;
307 DMT_UNKNOWN, /* for lookup, not actually used for a module */
308 DMT_ELF, /* a real ELF shared module */
309 DMT_PE, /* a native or builtin PE module */
310 DMT_MACHO, /* a real Mach-O shared module */
311 DMT_PDB, /* .PDB file */
312 DMT_DBG, /* .DBG file */
319 IMAGEHLP_MODULEW64 module;
320 /* ANSI copy of module.ModuleName for efficiency */
321 char module_name[MAX_PATH];
323 enum module_type type : 16;
324 unsigned short is_virtual : 1;
326 /* specific information for debug types */
327 struct elf_module_info* elf_info;
328 struct dwarf2_module_info_s*dwarf2_info;
329 void (*module_remove)(struct process* pcs, struct module* module);
331 struct macho_module_info* macho_info;
333 /* memory allocation pool */
336 /* symbols & symbol tables */
339 unsigned num_sorttab; /* number of symbols with addresses */
340 unsigned num_symbols;
341 unsigned sorttab_size;
342 struct symt_ht** addr_sorttab;
343 struct hash_table ht_symbols;
344 void (*loc_compute)(struct process* pcs,
345 const struct module* module,
346 const struct symt_function* func,
347 struct location* loc);
350 struct hash_table ht_types;
351 struct vector vtypes;
354 unsigned sources_used;
355 unsigned sources_alloc;
361 struct process* next;
365 PSYMBOL_REGISTERED_CALLBACK64 reg_cb;
366 PSYMBOL_REGISTERED_CALLBACK reg_cb32;
370 struct module* lmodules;
371 unsigned long dbg_hdr_addr;
373 IMAGEHLP_STACK_FRAME ctx_frame;
375 unsigned buffer_size;
381 unsigned long is_first : 1,
387 unsigned long pc_offset; /* if is_source_file isn't set */
388 unsigned source_file; /* if is_source_file is set */
395 struct module* requested; /* in: to module_get_debug() */
396 struct module* effective; /* out: module with debug info */
399 enum pdb_kind {PDB_JG, PDB_DS};
403 const char* filename;
411 struct PDB_JG_TOC* toc;
416 struct PDB_DS_TOC* toc;
421 struct cpu_stack_walk
430 PREAD_PROCESS_MEMORY_ROUTINE f_read_mem;
431 PTRANSLATE_ADDRESS_ROUTINE f_xlat_adr;
432 PFUNCTION_TABLE_ACCESS_ROUTINE f_tabl_acs;
433 PGET_MODULE_BASE_ROUTINE f_modl_bas;
437 PREAD_PROCESS_MEMORY_ROUTINE64 f_read_mem;
438 PTRANSLATE_ADDRESS_ROUTINE64 f_xlat_adr;
439 PFUNCTION_TABLE_ACCESS_ROUTINE64 f_tabl_acs;
440 PGET_MODULE_BASE_ROUTINE64 f_modl_bas;
445 enum cpu_addr {cpu_addr_pc, cpu_addr_stack, cpu_addr_frame};
450 /* address manipulation */
451 unsigned (*get_addr)(HANDLE hThread, const CONTEXT* ctx,
452 enum cpu_addr, ADDRESS64* addr);
454 /* stack manipulation */
455 BOOL (*stack_walk)(struct cpu_stack_walk* csw, LPSTACKFRAME64 frame);
458 extern struct cpu* dbghelp_current_cpu;
461 extern struct process* process_find_by_handle(HANDLE hProcess);
462 extern HANDLE hMsvcrt;
463 extern BOOL validate_addr64(DWORD64 addr);
464 extern BOOL pcs_callback(const struct process* pcs, ULONG action, void* data);
465 extern void* fetch_buffer(struct process* pcs, unsigned size);
466 extern const char* wine_dbgstr_addr(const ADDRESS64* addr);
467 extern struct cpu* cpu_find(DWORD);
470 extern DWORD calc_crc32(int fd);
472 typedef BOOL (*enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
475 #define ELF_NO_MAP ((const void*)-1)
476 extern BOOL elf_enum_modules(HANDLE hProc, enum_modules_cb, void*);
477 extern BOOL elf_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
479 extern BOOL elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
480 extern struct module*
481 elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
482 extern BOOL elf_read_wine_loader_dbg_info(struct process* pcs);
483 extern BOOL elf_synchronize_module_list(struct process* pcs);
484 struct elf_thunk_area;
485 extern int elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
488 #define MACHO_NO_MAP ((const void*)-1)
489 extern BOOL macho_enum_modules(HANDLE hProc, enum_modules_cb, void*);
490 extern BOOL macho_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
491 struct macho_file_map;
492 extern BOOL macho_load_debug_info(struct module* module, struct macho_file_map* fmap);
493 extern struct module*
494 macho_load_module(struct process* pcs, const WCHAR* name, unsigned long);
495 extern BOOL macho_read_wine_loader_dbg_info(struct process* pcs);
496 extern BOOL macho_synchronize_module_list(struct process* pcs);
499 extern const WCHAR S_ElfW[];
500 extern const WCHAR S_WineLoaderW[];
501 extern const WCHAR S_WineW[];
502 extern const WCHAR S_SlashW[];
504 extern struct module*
505 module_find_by_addr(const struct process* pcs, unsigned long addr,
506 enum module_type type);
507 extern struct module*
508 module_find_by_nameA(const struct process* pcs,
510 extern struct module*
511 module_is_already_loaded(const struct process* pcs,
512 const WCHAR* imgname);
513 extern BOOL module_get_debug(struct module_pair*);
514 extern struct module*
515 module_new(struct process* pcs, const WCHAR* name,
516 enum module_type type, BOOL virtual,
517 DWORD64 addr, DWORD64 size,
518 unsigned long stamp, unsigned long checksum);
519 extern struct module*
520 module_get_containee(const struct process* pcs,
521 const struct module* inner);
522 extern enum module_type
523 module_get_type_by_name(const WCHAR* name);
524 extern void module_reset_debug_info(struct module* module);
525 extern BOOL module_remove(struct process* pcs,
526 struct module* module);
527 extern void module_set_module(struct module* module, const WCHAR* name);
530 extern BOOL pe_load_debug_directory(const struct process* pcs,
531 struct module* module,
533 const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
534 const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
535 extern BOOL pdb_fetch_file_info(struct pdb_lookup* pdb_lookup);
538 extern BOOL path_find_symbol_file(const struct process* pcs, PCSTR full_path,
539 const GUID* guid, DWORD dw1, DWORD dw2, PSTR buffer,
543 extern BOOL pe_load_nt_header(HANDLE hProc, DWORD64 base, IMAGE_NT_HEADERS* nth);
544 extern struct module*
545 pe_load_native_module(struct process* pcs, const WCHAR* name,
546 HANDLE hFile, DWORD base, DWORD size);
547 extern struct module*
548 pe_load_builtin_module(struct process* pcs, const WCHAR* name,
549 DWORD64 base, DWORD64 size);
550 extern BOOL pe_load_debug_info(const struct process* pcs,
551 struct module* module);
553 extern unsigned source_new(struct module* module, const char* basedir, const char* source);
554 extern const char* source_get(const struct module* module, unsigned idx);
557 typedef void (*stabs_def_cb)(struct module* module, unsigned long load_offset,
558 const char* name, unsigned long offset,
559 BOOL is_public, BOOL is_global, unsigned char other,
560 struct symt_compiland* compiland, void* user);
561 extern BOOL stabs_parse(struct module* module, unsigned long load_offset,
562 const void* stabs, int stablen,
563 const char* strs, int strtablen,
564 stabs_def_cb callback, void* user);
567 extern BOOL dwarf2_parse(struct module* module, unsigned long load_offset,
568 const struct elf_thunk_area* thunks,
569 const unsigned char* debug, unsigned int debug_size,
570 const unsigned char* abbrev, unsigned int abbrev_size,
571 const unsigned char* str, unsigned int str_size,
572 const unsigned char* line, unsigned int line_size,
573 const unsigned char* loclist, unsigned int loclist_size);
576 extern BOOL sw_read_mem(struct cpu_stack_walk* csw, DWORD64 addr, void* ptr, DWORD sz);
577 extern DWORD64 sw_xlat_addr(struct cpu_stack_walk* csw, ADDRESS64* addr);
578 extern void* sw_table_access(struct cpu_stack_walk* csw, DWORD64 addr);
579 extern DWORD64 sw_module_base(struct cpu_stack_walk* csw, DWORD64 addr);
582 extern const char* symt_get_name(const struct symt* sym);
583 extern struct module* symt_cmp_addr_module;
584 extern int symt_cmp_addr(const void* p1, const void* p2);
585 extern void copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
586 extern struct symt_ht*
587 symt_find_nearest(struct module* module, DWORD_PTR addr);
588 extern struct symt_compiland*
589 symt_new_compiland(struct module* module, unsigned long address,
591 extern struct symt_public*
592 symt_new_public(struct module* module,
593 struct symt_compiland* parent,
594 const char* typename,
595 unsigned long address, unsigned size);
596 extern struct symt_data*
597 symt_new_global_variable(struct module* module,
598 struct symt_compiland* parent,
599 const char* name, unsigned is_static,
600 unsigned long addr, unsigned long size,
602 extern struct symt_function*
603 symt_new_function(struct module* module,
604 struct symt_compiland* parent,
606 unsigned long addr, unsigned long size,
608 extern BOOL symt_normalize_function(struct module* module,
609 const struct symt_function* func);
610 extern void symt_add_func_line(struct module* module,
611 struct symt_function* func,
612 unsigned source_idx, int line_num,
613 unsigned long offset);
614 extern struct symt_data*
615 symt_add_func_local(struct module* module,
616 struct symt_function* func,
617 enum DataKind dt, const struct location* loc,
618 struct symt_block* block,
619 struct symt* type, const char* name);
620 extern struct symt_block*
621 symt_open_func_block(struct module* module,
622 struct symt_function* func,
623 struct symt_block* block,
624 unsigned pc, unsigned len);
625 extern struct symt_block*
626 symt_close_func_block(struct module* module,
627 const struct symt_function* func,
628 struct symt_block* block, unsigned pc);
629 extern struct symt_hierarchy_point*
630 symt_add_function_point(struct module* module,
631 struct symt_function* func,
632 enum SymTagEnum point,
633 const struct location* loc,
635 extern BOOL symt_fill_func_line_info(const struct module* module,
636 const struct symt_function* func,
637 DWORD64 addr, IMAGEHLP_LINE64* line);
638 extern BOOL symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE64 line);
639 extern struct symt_thunk*
640 symt_new_thunk(struct module* module,
641 struct symt_compiland* parent,
642 const char* name, THUNK_ORDINAL ord,
643 unsigned long addr, unsigned long size);
644 extern struct symt_data*
645 symt_new_constant(struct module* module,
646 struct symt_compiland* parent,
647 const char* name, struct symt* type,
649 extern struct symt_hierarchy_point*
650 symt_new_label(struct module* module,
651 struct symt_compiland* compiland,
652 const char* name, unsigned long address);
653 extern struct symt* symt_index2ptr(struct module* module, DWORD id);
654 extern DWORD symt_ptr2index(struct module* module, const struct symt* sym);
657 extern void symt_init_basic(struct module* module);
658 extern BOOL symt_get_info(struct module* module, const struct symt* type,
659 IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
660 extern struct symt_basic*
661 symt_new_basic(struct module* module, enum BasicType,
662 const char* typename, unsigned size);
663 extern struct symt_udt*
664 symt_new_udt(struct module* module, const char* typename,
665 unsigned size, enum UdtKind kind);
666 extern BOOL symt_set_udt_size(struct module* module,
667 struct symt_udt* type, unsigned size);
668 extern BOOL symt_add_udt_element(struct module* module,
669 struct symt_udt* udt_type,
671 struct symt* elt_type, unsigned offset,
673 extern struct symt_enum*
674 symt_new_enum(struct module* module, const char* typename,
675 struct symt* basetype);
676 extern BOOL symt_add_enum_element(struct module* module,
677 struct symt_enum* enum_type,
678 const char* name, int value);
679 extern struct symt_array*
680 symt_new_array(struct module* module, int min, int max,
681 struct symt* base, struct symt* index);
682 extern struct symt_function_signature*
683 symt_new_function_signature(struct module* module,
684 struct symt* ret_type,
685 enum CV_call_e call_conv);
686 extern BOOL symt_add_function_signature_parameter(struct module* module,
687 struct symt_function_signature* sig,
689 extern struct symt_pointer*
690 symt_new_pointer(struct module* module,
691 struct symt* ref_type);
692 extern struct symt_typedef*
693 symt_new_typedef(struct module* module, struct symt* ref,