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"
34 #include "wine/rbtree.h"
38 /* #define USE_STATS */
40 struct pool /* poor's man */
42 struct list arena_list;
43 struct list arena_full;
47 void pool_init(struct pool* a, size_t arena_size);
48 void pool_destroy(struct pool* a);
49 void* pool_alloc(struct pool* a, size_t len);
50 char* pool_strdup(struct pool* a, const char* str);
59 unsigned buckets_allocated;
62 void vector_init(struct vector* v, unsigned elt_sz, unsigned bucket_sz);
63 unsigned vector_length(const struct vector* v);
64 void* vector_at(const struct vector* v, unsigned pos);
65 void* vector_add(struct vector* v, struct pool* pool);
69 struct vector key2index;
70 struct vector elements;
73 void sparse_array_init(struct sparse_array* sa, unsigned elt_sz, unsigned bucket_sz);
74 void* sparse_array_find(const struct sparse_array* sa, unsigned long idx);
75 void* sparse_array_add(struct sparse_array* sa, unsigned long key, struct pool* pool);
76 unsigned sparse_array_length(const struct sparse_array* sa);
81 struct hash_table_elt* next;
84 struct hash_table_bucket
86 struct hash_table_elt* first;
87 struct hash_table_elt* last;
94 struct hash_table_bucket* buckets;
98 void hash_table_init(struct pool* pool, struct hash_table* ht,
99 unsigned num_buckets);
100 void hash_table_destroy(struct hash_table* ht);
101 void hash_table_add(struct hash_table* ht, struct hash_table_elt* elt);
103 struct hash_table_iter
105 const struct hash_table* ht;
106 struct hash_table_elt* element;
111 void hash_table_iter_init(const struct hash_table* ht,
112 struct hash_table_iter* hti, const char* name);
113 void* hash_table_iter_up(struct hash_table_iter* hti);
115 #define GET_ENTRY(__i, __t, __f) \
116 ((__t*)((char*)(__i) - FIELD_OFFSET(__t,__f)))
119 extern unsigned dbghelp_options;
120 /* some more Wine extensions */
121 #define SYMOPT_WINE_WITH_NATIVE_MODULES 0x40000000
123 enum location_kind {loc_error, /* reg is the error code */
124 loc_unavailable, /* location is not available */
125 loc_absolute, /* offset is the location */
126 loc_register, /* reg is the location */
127 loc_regrel, /* [reg+offset] is the location */
128 loc_tlsrel, /* offset is the address of the TLS index */
129 loc_user, /* value is debug information dependent,
130 reg & offset can be used ad libidem */
133 enum location_error {loc_err_internal = -1, /* internal while computing */
134 loc_err_too_complex = -2, /* couldn't compute location (even at runtime) */
135 loc_err_out_of_scope = -3, /* variable isn't available at current address */
136 loc_err_cant_read = -4, /* couldn't read memory at given address */
137 loc_err_no_location = -5, /* likely optimized away (by compiler) */
144 unsigned long offset;
155 struct hash_table_elt hash_elt; /* if global symbol or type */
162 unsigned long address;
164 struct symt* container; /* block, or func */
165 struct vector vchildren; /* sub-blocks & local variables */
168 struct symt_compiland
171 unsigned long address;
173 struct vector vchildren; /* global variables & functions */
179 struct hash_table_elt hash_elt; /* if global symbol */
181 struct symt* container;
183 union /* depends on kind */
185 /* DataIs{Global, FileStatic}:
187 * loc_absolute loc.offset is address
188 * loc_tlsrel loc.offset is TLS index address
189 * DataIs{Local,Param}:
191 * loc_absolute not supported
192 * loc_register location is in register loc.reg
193 * loc_regrel location is at address loc.reg + loc.offset
194 * >= loc_user ask debug info provider for resolution
197 /* DataIs{Member} (all values are in bits, not bytes) */
201 unsigned long length;
211 struct hash_table_elt hash_elt; /* if global symbol */
212 unsigned long address;
213 struct symt* container; /* compiland */
214 struct symt* type; /* points to function_signature */
216 struct vector vlines;
217 struct vector vchildren; /* locals, params, blocks, start/end, labels */
220 struct symt_hierarchy_point
222 struct symt symt; /* either SymTagFunctionDebugStart, SymTagFunctionDebugEnd, SymTagLabel */
223 struct hash_table_elt hash_elt; /* if label (and in compiland's hash table if global) */
224 struct symt* parent; /* symt_function or symt_compiland */
231 struct hash_table_elt hash_elt;
232 struct symt* container; /* compiland */
233 unsigned long address;
240 struct hash_table_elt hash_elt;
241 struct symt* container; /* compiland */
242 unsigned long address;
244 THUNK_ORDINAL ordinal; /* FIXME: doesn't seem to be accessible */
252 int end; /* end index if > 0, or -array_len (in bytes) if < 0 */
253 struct symt* base_type;
254 struct symt* index_type;
260 struct hash_table_elt hash_elt;
268 struct symt* base_type;
270 struct vector vchildren;
273 struct symt_function_signature
276 struct symt* rettype;
277 struct vector vchildren;
278 enum CV_call_e call_conv;
281 struct symt_function_arg_type
284 struct symt* arg_type;
285 struct symt* container;
291 struct symt* pointsto;
298 struct hash_table_elt hash_elt;
305 struct hash_table_elt hash_elt;
308 struct vector vchildren;
313 DMT_UNKNOWN, /* for lookup, not actually used for a module */
314 DMT_ELF, /* a real ELF shared module */
315 DMT_PE, /* a native or builtin PE module */
316 DMT_MACHO, /* a real Mach-O shared module */
317 DMT_PDB, /* .PDB file */
318 DMT_DBG, /* .DBG file */
324 /* a module can be made of several debug information formats, so we have to
339 struct module* module;
340 void (*remove)(struct process* pcs, struct module_format* modfmt);
341 void (*loc_compute)(struct process* pcs,
342 const struct module_format* modfmt,
343 const struct symt_function* func,
344 struct location* loc);
347 struct elf_module_info* elf_info;
348 struct dwarf2_module_info_s* dwarf2_info;
349 struct pe_module_info* pe_info;
350 struct macho_module_info* macho_info;
351 struct pdb_module_info* pdb_info;
355 extern const struct wine_rb_functions source_rb_functions;
358 struct process* process;
359 IMAGEHLP_MODULEW64 module;
360 /* ANSI copy of module.ModuleName for efficiency */
361 char module_name[MAX_PATH];
363 enum module_type type : 16;
364 unsigned short is_virtual : 1;
367 /* specific information for debug types */
368 struct module_format* format_info[DFI_LAST];
370 /* memory allocation pool */
373 /* symbols & symbol tables */
376 unsigned num_sorttab; /* number of symbols with addresses */
377 unsigned num_symbols;
378 unsigned sorttab_size;
379 struct symt_ht** addr_sorttab;
380 struct hash_table ht_symbols;
383 struct hash_table ht_types;
384 struct vector vtypes;
387 unsigned sources_used;
388 unsigned sources_alloc;
390 struct wine_rb_tree sources_offsets_tree;
395 struct process* next;
399 PSYMBOL_REGISTERED_CALLBACK64 reg_cb;
400 PSYMBOL_REGISTERED_CALLBACK reg_cb32;
404 struct module* lmodules;
405 unsigned long dbg_hdr_addr;
407 IMAGEHLP_STACK_FRAME ctx_frame;
409 unsigned buffer_size;
415 unsigned long is_first : 1,
421 unsigned long pc_offset; /* if is_source_file isn't set */
422 unsigned source_file; /* if is_source_file is set */
429 struct module* requested; /* in: to module_get_debug() */
430 struct module* effective; /* out: module with debug info */
433 enum pdb_kind {PDB_JG, PDB_DS};
437 const char* filename;
444 struct cpu_stack_walk
453 PREAD_PROCESS_MEMORY_ROUTINE f_read_mem;
454 PTRANSLATE_ADDRESS_ROUTINE f_xlat_adr;
455 PFUNCTION_TABLE_ACCESS_ROUTINE f_tabl_acs;
456 PGET_MODULE_BASE_ROUTINE f_modl_bas;
460 PREAD_PROCESS_MEMORY_ROUTINE64 f_read_mem;
461 PTRANSLATE_ADDRESS_ROUTINE64 f_xlat_adr;
462 PFUNCTION_TABLE_ACCESS_ROUTINE64 f_tabl_acs;
463 PGET_MODULE_BASE_ROUTINE64 f_modl_bas;
468 enum cpu_addr {cpu_addr_pc, cpu_addr_stack, cpu_addr_frame};
475 /* address manipulation */
476 unsigned (*get_addr)(HANDLE hThread, const CONTEXT* ctx,
477 enum cpu_addr, ADDRESS64* addr);
479 /* stack manipulation */
480 BOOL (*stack_walk)(struct cpu_stack_walk* csw, LPSTACKFRAME64 frame, CONTEXT* context);
482 /* module manipulation */
483 void* (*find_runtime_function)(struct module*, DWORD64 addr);
485 /* dwarf dedicated information */
486 unsigned (*map_dwarf_register)(unsigned regno);
488 /* context related maniputation */
489 void* (*fetch_context_reg)(CONTEXT* context, unsigned regno, unsigned* size);
490 const char* (*fetch_regname)(unsigned regno);
493 extern struct cpu* dbghelp_current_cpu;
496 extern struct process* process_find_by_handle(HANDLE hProcess);
497 extern HANDLE hMsvcrt;
498 extern BOOL validate_addr64(DWORD64 addr);
499 extern BOOL pcs_callback(const struct process* pcs, ULONG action, void* data);
500 extern void* fetch_buffer(struct process* pcs, unsigned size);
501 extern const char* wine_dbgstr_addr(const ADDRESS64* addr);
502 extern struct cpu* cpu_find(DWORD);
505 extern DWORD calc_crc32(int fd);
507 typedef BOOL (*enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
510 extern BOOL elf_enum_modules(HANDLE hProc, enum_modules_cb, void*);
511 extern BOOL elf_fetch_file_info(const WCHAR* name, DWORD_PTR* base, DWORD* size, DWORD* checksum);
512 struct image_file_map;
513 extern BOOL elf_load_debug_info(struct module* module);
514 extern struct module*
515 elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
516 extern BOOL elf_read_wine_loader_dbg_info(struct process* pcs);
517 extern BOOL elf_synchronize_module_list(struct process* pcs);
518 struct elf_thunk_area;
519 extern int elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
522 #define MACHO_NO_MAP ((const void*)-1)
523 extern BOOL macho_enum_modules(HANDLE hProc, enum_modules_cb, void*);
524 extern BOOL macho_fetch_file_info(const WCHAR* name, DWORD_PTR* base, DWORD* size, DWORD* checksum);
525 struct macho_file_map;
526 extern BOOL macho_load_debug_info(struct module* module, struct macho_file_map* fmap);
527 extern struct module*
528 macho_load_module(struct process* pcs, const WCHAR* name, unsigned long);
529 extern BOOL macho_read_wine_loader_dbg_info(struct process* pcs);
530 extern BOOL macho_synchronize_module_list(struct process* pcs);
533 extern const WCHAR S_ElfW[];
534 extern const WCHAR S_WineLoaderW[];
535 extern const WCHAR S_SlashW[];
537 extern struct module*
538 module_find_by_addr(const struct process* pcs, unsigned long addr,
539 enum module_type type);
540 extern struct module*
541 module_find_by_nameA(const struct process* pcs,
543 extern struct module*
544 module_is_already_loaded(const struct process* pcs,
545 const WCHAR* imgname);
546 extern BOOL module_get_debug(struct module_pair*);
547 extern struct module*
548 module_new(struct process* pcs, const WCHAR* name,
549 enum module_type type, BOOL virtual,
550 DWORD64 addr, DWORD64 size,
551 unsigned long stamp, unsigned long checksum);
552 extern struct module*
553 module_get_containee(const struct process* pcs,
554 const struct module* inner);
555 extern enum module_type
556 module_get_type_by_name(const WCHAR* name);
557 extern void module_reset_debug_info(struct module* module);
558 extern BOOL module_remove(struct process* pcs,
559 struct module* module);
560 extern void module_set_module(struct module* module, const WCHAR* name);
561 extern const WCHAR *get_wine_loader_name(void);
564 extern BOOL pe_load_debug_directory(const struct process* pcs,
565 struct module* module,
567 const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
568 const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
569 extern BOOL pdb_fetch_file_info(const struct pdb_lookup* pdb_lookup, unsigned* matched);
570 struct pdb_cmd_pair {
574 extern BOOL pdb_virtual_unwind(struct cpu_stack_walk* csw, DWORD_PTR ip,
575 CONTEXT* context, struct pdb_cmd_pair* cpair);
578 extern BOOL path_find_symbol_file(const struct process* pcs, PCSTR full_path,
579 const GUID* guid, DWORD dw1, DWORD dw2, PSTR buffer,
583 extern BOOL pe_load_nt_header(HANDLE hProc, DWORD64 base, IMAGE_NT_HEADERS* nth);
584 extern struct module*
585 pe_load_native_module(struct process* pcs, const WCHAR* name,
586 HANDLE hFile, DWORD64 base, DWORD size);
587 extern struct module*
588 pe_load_builtin_module(struct process* pcs, const WCHAR* name,
589 DWORD64 base, DWORD64 size);
590 extern BOOL pe_load_debug_info(const struct process* pcs,
591 struct module* module);
592 extern const char* pe_map_directory(struct module* module, int dirno, DWORD* size);
593 extern void pe_unmap_directoy(struct module* module, int dirno);
596 extern unsigned source_new(struct module* module, const char* basedir, const char* source);
597 extern const char* source_get(const struct module* module, unsigned idx);
600 typedef void (*stabs_def_cb)(struct module* module, unsigned long load_offset,
601 const char* name, unsigned long offset,
602 BOOL is_public, BOOL is_global, unsigned char other,
603 struct symt_compiland* compiland, void* user);
604 extern BOOL stabs_parse(struct module* module, unsigned long load_offset,
605 const void* stabs, int stablen,
606 const char* strs, int strtablen,
607 stabs_def_cb callback, void* user);
610 extern BOOL dwarf2_parse(struct module* module, unsigned long load_offset,
611 const struct elf_thunk_area* thunks,
612 struct image_file_map* fmap);
613 extern BOOL dwarf2_virtual_unwind(struct cpu_stack_walk* csw, DWORD_PTR ip,
614 CONTEXT* context, ULONG_PTR* cfa);
617 extern BOOL sw_read_mem(struct cpu_stack_walk* csw, DWORD64 addr, void* ptr, DWORD sz);
618 extern DWORD64 sw_xlat_addr(struct cpu_stack_walk* csw, ADDRESS64* addr);
619 extern void* sw_table_access(struct cpu_stack_walk* csw, DWORD64 addr);
620 extern DWORD64 sw_module_base(struct cpu_stack_walk* csw, DWORD64 addr);
623 extern const char* symt_get_name(const struct symt* sym);
624 extern BOOL symt_get_address(const struct symt* type, ULONG64* addr);
625 extern int symt_cmp_addr(const void* p1, const void* p2);
626 extern void copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
627 extern struct symt_ht*
628 symt_find_nearest(struct module* module, DWORD_PTR addr);
629 extern struct symt_compiland*
630 symt_new_compiland(struct module* module, unsigned long address,
632 extern struct symt_public*
633 symt_new_public(struct module* module,
634 struct symt_compiland* parent,
635 const char* typename,
636 unsigned long address, unsigned size);
637 extern struct symt_data*
638 symt_new_global_variable(struct module* module,
639 struct symt_compiland* parent,
640 const char* name, unsigned is_static,
641 struct location loc, unsigned long size,
643 extern struct symt_function*
644 symt_new_function(struct module* module,
645 struct symt_compiland* parent,
647 unsigned long addr, unsigned long size,
649 extern BOOL symt_normalize_function(struct module* module,
650 const struct symt_function* func);
651 extern void symt_add_func_line(struct module* module,
652 struct symt_function* func,
653 unsigned source_idx, int line_num,
654 unsigned long offset);
655 extern struct symt_data*
656 symt_add_func_local(struct module* module,
657 struct symt_function* func,
658 enum DataKind dt, const struct location* loc,
659 struct symt_block* block,
660 struct symt* type, const char* name);
661 extern struct symt_block*
662 symt_open_func_block(struct module* module,
663 struct symt_function* func,
664 struct symt_block* block,
665 unsigned pc, unsigned len);
666 extern struct symt_block*
667 symt_close_func_block(struct module* module,
668 const struct symt_function* func,
669 struct symt_block* block, unsigned pc);
670 extern struct symt_hierarchy_point*
671 symt_add_function_point(struct module* module,
672 struct symt_function* func,
673 enum SymTagEnum point,
674 const struct location* loc,
676 extern BOOL symt_fill_func_line_info(const struct module* module,
677 const struct symt_function* func,
678 DWORD64 addr, IMAGEHLP_LINE64* line);
679 extern BOOL symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE64 line);
680 extern struct symt_thunk*
681 symt_new_thunk(struct module* module,
682 struct symt_compiland* parent,
683 const char* name, THUNK_ORDINAL ord,
684 unsigned long addr, unsigned long size);
685 extern struct symt_data*
686 symt_new_constant(struct module* module,
687 struct symt_compiland* parent,
688 const char* name, struct symt* type,
690 extern struct symt_hierarchy_point*
691 symt_new_label(struct module* module,
692 struct symt_compiland* compiland,
693 const char* name, unsigned long address);
694 extern struct symt* symt_index2ptr(struct module* module, DWORD id);
695 extern DWORD symt_ptr2index(struct module* module, const struct symt* sym);
698 extern void symt_init_basic(struct module* module);
699 extern BOOL symt_get_info(struct module* module, const struct symt* type,
700 IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
701 extern struct symt_basic*
702 symt_new_basic(struct module* module, enum BasicType,
703 const char* typename, unsigned size);
704 extern struct symt_udt*
705 symt_new_udt(struct module* module, const char* typename,
706 unsigned size, enum UdtKind kind);
707 extern BOOL symt_set_udt_size(struct module* module,
708 struct symt_udt* type, unsigned size);
709 extern BOOL symt_add_udt_element(struct module* module,
710 struct symt_udt* udt_type,
712 struct symt* elt_type, unsigned offset,
714 extern struct symt_enum*
715 symt_new_enum(struct module* module, const char* typename,
716 struct symt* basetype);
717 extern BOOL symt_add_enum_element(struct module* module,
718 struct symt_enum* enum_type,
719 const char* name, int value);
720 extern struct symt_array*
721 symt_new_array(struct module* module, int min, int max,
722 struct symt* base, struct symt* index);
723 extern struct symt_function_signature*
724 symt_new_function_signature(struct module* module,
725 struct symt* ret_type,
726 enum CV_call_e call_conv);
727 extern BOOL symt_add_function_signature_parameter(struct module* module,
728 struct symt_function_signature* sig,
730 extern struct symt_pointer*
731 symt_new_pointer(struct module* module,
732 struct symt* ref_type,
734 extern struct symt_typedef*
735 symt_new_typedef(struct module* module, struct symt* ref,