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
;
230 unsigned in_code
: 1,
237 struct hash_table_elt hash_elt
;
238 struct symt
* container
; /* compiland */
239 unsigned long address
;
241 THUNK_ORDINAL ordinal
; /* FIXME: doesn't seem to be accessible */
249 int end
; /* end index if > 0, or -array_len (in bytes) if < 0 */
250 struct symt
* base_type
;
251 struct symt
* index_type
;
257 struct hash_table_elt hash_elt
;
265 struct symt
* base_type
;
267 struct vector vchildren
;
270 struct symt_function_signature
273 struct symt
* rettype
;
274 struct vector vchildren
;
275 enum CV_call_e call_conv
;
278 struct symt_function_arg_type
281 struct symt
* arg_type
;
282 struct symt
* container
;
288 struct symt
* pointsto
;
294 struct hash_table_elt hash_elt
;
301 struct hash_table_elt hash_elt
;
304 struct vector vchildren
;
309 DMT_UNKNOWN
, /* for lookup, not actually used for a module */
310 DMT_ELF
, /* a real ELF shared module */
311 DMT_PE
, /* a native or builtin PE module */
312 DMT_MACHO
, /* a real Mach-O shared module */
313 DMT_PDB
, /* .PDB file */
314 DMT_DBG
, /* .DBG file */
321 IMAGEHLP_MODULEW64 module
;
322 /* ANSI copy of module.ModuleName for efficiency */
323 char module_name
[MAX_PATH
];
325 enum module_type type
: 16;
326 unsigned short is_virtual
: 1;
328 /* specific information for debug types */
329 struct elf_module_info
* elf_info
;
330 struct dwarf2_module_info_s
*dwarf2_info
;
332 struct macho_module_info
* macho_info
;
334 /* memory allocation pool */
337 /* 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
;
369 struct module
* lmodules
;
370 unsigned long dbg_hdr_addr
;
372 IMAGEHLP_STACK_FRAME ctx_frame
;
374 unsigned buffer_size
;
380 unsigned long is_first
: 1,
386 unsigned long pc_offset
; /* if is_source_file isn't set */
387 unsigned source_file
; /* if is_source_file is set */
394 struct module
* requested
; /* in: to module_get_debug() */
395 struct module
* effective
; /* out: module with debug info */
398 enum pdb_kind
{PDB_JG
, PDB_DS
};
402 const char* filename
;
410 struct PDB_JG_TOC
* toc
;
415 struct PDB_DS_TOC
* toc
;
421 extern struct process
* process_find_by_handle(HANDLE hProcess
);
422 extern HANDLE hMsvcrt
;
423 extern BOOL
validate_addr64(DWORD64 addr
);
424 extern BOOL
pcs_callback(const struct process
* pcs
, ULONG action
, void* data
);
425 extern void* fetch_buffer(struct process
* pcs
, unsigned size
);
428 extern DWORD
calc_crc32(int fd
);
430 typedef BOOL (*enum_modules_cb
)(const WCHAR
*, unsigned long addr
, void* user
);
433 #define ELF_NO_MAP ((const void*)-1)
434 extern BOOL
elf_enum_modules(HANDLE hProc
, enum_modules_cb
, void*);
435 extern BOOL
elf_fetch_file_info(const WCHAR
* name
, DWORD
* base
, DWORD
* size
, DWORD
* checksum
);
437 extern BOOL
elf_load_debug_info(struct module
* module
, struct elf_file_map
* fmap
);
438 extern struct module
*
439 elf_load_module(struct process
* pcs
, const WCHAR
* name
, unsigned long);
440 extern BOOL
elf_read_wine_loader_dbg_info(struct process
* pcs
);
441 extern BOOL
elf_synchronize_module_list(struct process
* pcs
);
442 struct elf_thunk_area
;
443 extern int elf_is_in_thunk_area(unsigned long addr
, const struct elf_thunk_area
* thunks
);
446 #define MACHO_NO_MAP ((const void*)-1)
447 extern BOOL
macho_enum_modules(HANDLE hProc
, enum_modules_cb
, void*);
448 extern BOOL
macho_fetch_file_info(const WCHAR
* name
, DWORD
* base
, DWORD
* size
, DWORD
* checksum
);
449 struct macho_file_map
;
450 extern BOOL
macho_load_debug_info(struct module
* module
, struct macho_file_map
* fmap
);
451 extern struct module
*
452 macho_load_module(struct process
* pcs
, const WCHAR
* name
, unsigned long);
453 extern BOOL
macho_read_wine_loader_dbg_info(struct process
* pcs
);
454 extern BOOL
macho_synchronize_module_list(struct process
* pcs
);
457 extern const WCHAR S_ElfW
[];
458 extern const WCHAR S_WineLoaderW
[];
459 extern const WCHAR S_WineW
[];
460 extern const WCHAR S_SlashW
[];
462 extern struct module
*
463 module_find_by_addr(const struct process
* pcs
, unsigned long addr
,
464 enum module_type type
);
465 extern struct module
*
466 module_find_by_nameA(const struct process
* pcs
,
468 extern struct module
*
469 module_is_already_loaded(const struct process
* pcs
,
470 const WCHAR
* imgname
);
471 extern BOOL
module_get_debug(struct module_pair
*);
472 extern struct module
*
473 module_new(struct process
* pcs
, const WCHAR
* name
,
474 enum module_type type
, BOOL
virtual,
475 unsigned long addr
, unsigned long size
,
476 unsigned long stamp
, unsigned long checksum
);
477 extern struct module
*
478 module_get_containee(const struct process
* pcs
,
479 const struct module
* inner
);
480 extern enum module_type
481 module_get_type_by_name(const WCHAR
* name
);
482 extern void module_reset_debug_info(struct module
* module
);
483 extern BOOL
module_remove(struct process
* pcs
,
484 struct module
* module
);
485 extern void module_set_module(struct module
* module
, const WCHAR
* name
);
488 extern BOOL
pe_load_debug_directory(const struct process
* pcs
,
489 struct module
* module
,
491 const IMAGE_SECTION_HEADER
* sectp
, DWORD nsect
,
492 const IMAGE_DEBUG_DIRECTORY
* dbg
, int nDbg
);
493 extern BOOL
pdb_fetch_file_info(struct pdb_lookup
* pdb_lookup
);
496 extern BOOL
path_find_symbol_file(const struct process
* pcs
, PCSTR full_path
,
497 const GUID
* guid
, DWORD dw1
, DWORD dw2
, PSTR buffer
,
501 extern BOOL
pe_load_nt_header(HANDLE hProc
, DWORD base
, IMAGE_NT_HEADERS
* nth
);
502 extern struct module
*
503 pe_load_native_module(struct process
* pcs
, const WCHAR
* name
,
504 HANDLE hFile
, DWORD base
, DWORD size
);
505 extern struct module
*
506 pe_load_builtin_module(struct process
* pcs
, const WCHAR
* name
,
507 DWORD base
, DWORD size
);
508 extern BOOL
pe_load_debug_info(const struct process
* pcs
,
509 struct module
* module
);
511 extern unsigned source_new(struct module
* module
, const char* basedir
, const char* source
);
512 extern const char* source_get(const struct module
* module
, unsigned idx
);
515 typedef void (*stabs_def_cb
)(struct module
* module
, unsigned long load_offset
,
516 const char* name
, unsigned long offset
,
517 BOOL is_public
, BOOL is_global
, unsigned char other
,
518 struct symt_compiland
* compiland
, void* user
);
519 extern BOOL
stabs_parse(struct module
* module
, unsigned long load_offset
,
520 const void* stabs
, int stablen
,
521 const char* strs
, int strtablen
,
522 stabs_def_cb callback
, void* user
);
525 extern BOOL
dwarf2_parse(struct module
* module
, unsigned long load_offset
,
526 const struct elf_thunk_area
* thunks
,
527 const unsigned char* debug
, unsigned int debug_size
,
528 const unsigned char* abbrev
, unsigned int abbrev_size
,
529 const unsigned char* str
, unsigned int str_size
,
530 const unsigned char* line
, unsigned int line_size
,
531 const unsigned char* loclist
, unsigned int loclist_size
);
534 extern const char* symt_get_name(const struct symt
* sym
);
535 extern int symt_cmp_addr(const void* p1
, const void* p2
);
536 extern void copy_symbolW(SYMBOL_INFOW
* siw
, const SYMBOL_INFO
* si
);
537 extern struct symt_ht
*
538 symt_find_nearest(struct module
* module
, DWORD addr
);
539 extern struct symt_compiland
*
540 symt_new_compiland(struct module
* module
, unsigned long address
,
542 extern struct symt_public
*
543 symt_new_public(struct module
* module
,
544 struct symt_compiland
* parent
,
545 const char* typename
,
546 unsigned long address
, unsigned size
,
547 BOOL in_code
, BOOL is_func
);
548 extern struct symt_data
*
549 symt_new_global_variable(struct module
* module
,
550 struct symt_compiland
* parent
,
551 const char* name
, unsigned is_static
,
552 unsigned long addr
, unsigned long size
,
554 extern struct symt_function
*
555 symt_new_function(struct module
* module
,
556 struct symt_compiland
* parent
,
558 unsigned long addr
, unsigned long size
,
560 extern BOOL
symt_normalize_function(struct module
* module
,
561 const struct symt_function
* func
);
562 extern void symt_add_func_line(struct module
* module
,
563 struct symt_function
* func
,
564 unsigned source_idx
, int line_num
,
565 unsigned long offset
);
566 extern struct symt_data
*
567 symt_add_func_local(struct module
* module
,
568 struct symt_function
* func
,
569 enum DataKind dt
, const struct location
* loc
,
570 struct symt_block
* block
,
571 struct symt
* type
, const char* name
);
572 extern struct symt_block
*
573 symt_open_func_block(struct module
* module
,
574 struct symt_function
* func
,
575 struct symt_block
* block
,
576 unsigned pc
, unsigned len
);
577 extern struct symt_block
*
578 symt_close_func_block(struct module
* module
,
579 const struct symt_function
* func
,
580 struct symt_block
* block
, unsigned pc
);
581 extern struct symt_hierarchy_point
*
582 symt_add_function_point(struct module
* module
,
583 struct symt_function
* func
,
584 enum SymTagEnum point
,
585 const struct location
* loc
,
587 extern BOOL
symt_fill_func_line_info(const struct module
* module
,
588 const struct symt_function
* func
,
589 DWORD addr
, IMAGEHLP_LINE
* line
);
590 extern BOOL
symt_get_func_line_next(const struct module
* module
, PIMAGEHLP_LINE line
);
591 extern struct symt_thunk
*
592 symt_new_thunk(struct module
* module
,
593 struct symt_compiland
* parent
,
594 const char* name
, THUNK_ORDINAL ord
,
595 unsigned long addr
, unsigned long size
);
596 extern struct symt_data
*
597 symt_new_constant(struct module
* module
,
598 struct symt_compiland
* parent
,
599 const char* name
, struct symt
* type
,
601 extern struct symt_hierarchy_point
*
602 symt_new_label(struct module
* module
,
603 struct symt_compiland
* compiland
,
604 const char* name
, unsigned long address
);
607 extern void symt_init_basic(struct module
* module
);
608 extern BOOL
symt_get_info(const struct symt
* type
,
609 IMAGEHLP_SYMBOL_TYPE_INFO req
, void* pInfo
);
610 extern struct symt_basic
*
611 symt_new_basic(struct module
* module
, enum BasicType
,
612 const char* typename
, unsigned size
);
613 extern struct symt_udt
*
614 symt_new_udt(struct module
* module
, const char* typename
,
615 unsigned size
, enum UdtKind kind
);
616 extern BOOL
symt_set_udt_size(struct module
* module
,
617 struct symt_udt
* type
, unsigned size
);
618 extern BOOL
symt_add_udt_element(struct module
* module
,
619 struct symt_udt
* udt_type
,
621 struct symt
* elt_type
, unsigned offset
,
623 extern struct symt_enum
*
624 symt_new_enum(struct module
* module
, const char* typename
,
625 struct symt
* basetype
);
626 extern BOOL
symt_add_enum_element(struct module
* module
,
627 struct symt_enum
* enum_type
,
628 const char* name
, int value
);
629 extern struct symt_array
*
630 symt_new_array(struct module
* module
, int min
, int max
,
631 struct symt
* base
, struct symt
* index
);
632 extern struct symt_function_signature
*
633 symt_new_function_signature(struct module
* module
,
634 struct symt
* ret_type
,
635 enum CV_call_e call_conv
);
636 extern BOOL
symt_add_function_signature_parameter(struct module
* module
,
637 struct symt_function_signature
* sig
,
639 extern struct symt_pointer
*
640 symt_new_pointer(struct module
* module
,
641 struct symt
* ref_type
);
642 extern struct symt_typedef
*
643 symt_new_typedef(struct module
* module
, struct symt
* ref
,