Release 1.1.37.
[wine/gsoc-2012-control.git] / dlls / dbghelp / dbghelp_private.h
blobd2e2f1be5780cbb02d6386f075c0314253deef91
1 /*
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
24 #include <stdarg.h>
25 #include "windef.h"
26 #include "winbase.h"
27 #include "winver.h"
28 #include "dbghelp.h"
29 #include "objbase.h"
30 #include "oaidl.h"
31 #include "winnls.h"
32 #include "wine/list.h"
33 #include "wine/unicode.h"
35 #include "cvconst.h"
37 /* #define USE_STATS */
39 struct pool /* poor's man */
41 struct list arena_list;
42 struct list arena_full;
43 size_t arena_size;
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);
51 struct vector
53 void** buckets;
54 unsigned elt_size;
55 unsigned shift;
56 unsigned num_elts;
57 unsigned num_buckets;
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);
66 struct sparse_array
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);
77 struct hash_table_elt
79 const char* name;
80 struct hash_table_elt* next;
83 struct hash_table_bucket
85 struct hash_table_elt* first;
86 struct hash_table_elt* last;
89 struct hash_table
91 unsigned num_elts;
92 unsigned num_buckets;
93 struct hash_table_bucket* buckets;
94 struct pool* pool;
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;
106 int index;
107 int last;
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 */
136 struct location
138 unsigned kind : 8,
139 reg;
140 unsigned long offset;
143 struct symt
145 enum SymTagEnum tag;
148 struct symt_ht
150 struct symt symt;
151 struct hash_table_elt hash_elt; /* if global symbol or type */
154 /* lexical tree */
155 struct symt_block
157 struct symt symt;
158 unsigned long address;
159 unsigned long size;
160 struct symt* container; /* block, or func */
161 struct vector vchildren; /* sub-blocks & local variables */
164 struct symt_compiland
166 struct symt symt;
167 unsigned long address;
168 unsigned source;
169 struct vector vchildren; /* global variables & functions */
172 struct symt_data
174 struct symt symt;
175 struct hash_table_elt hash_elt; /* if global symbol */
176 enum DataKind kind;
177 struct symt* container;
178 struct symt* type;
179 union /* depends on kind */
181 /* DataIs{Global, FileStatic}:
182 * loc.kind is loc_absolute
183 * loc.offset is address
184 * DataIs{Local,Param}:
185 * with loc.kind
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
191 struct location var;
192 /* DataIs{Member} (all values are in bits, not bytes) */
193 struct
195 long offset;
196 unsigned long length;
197 } member;
198 /* DataIsConstant */
199 VARIANT value;
200 } u;
203 struct symt_function
205 struct symt symt;
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 */
210 unsigned long size;
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 */
220 struct location loc;
223 struct symt_public
225 struct symt symt;
226 struct hash_table_elt hash_elt;
227 struct symt* container; /* compiland */
228 unsigned long address;
229 unsigned long size;
230 unsigned in_code : 1,
231 is_function : 1;
234 struct symt_thunk
236 struct symt symt;
237 struct hash_table_elt hash_elt;
238 struct symt* container; /* compiland */
239 unsigned long address;
240 unsigned long size;
241 THUNK_ORDINAL ordinal; /* FIXME: doesn't seem to be accessible */
244 /* class tree */
245 struct symt_array
247 struct symt symt;
248 int start;
249 int end; /* end index if > 0, or -array_len (in bytes) if < 0 */
250 struct symt* base_type;
251 struct symt* index_type;
254 struct symt_basic
256 struct symt symt;
257 struct hash_table_elt hash_elt;
258 enum BasicType bt;
259 unsigned long size;
262 struct symt_enum
264 struct symt symt;
265 struct symt* base_type;
266 const char* name;
267 struct vector vchildren;
270 struct symt_function_signature
272 struct symt symt;
273 struct symt* rettype;
274 struct vector vchildren;
275 enum CV_call_e call_conv;
278 struct symt_function_arg_type
280 struct symt symt;
281 struct symt* arg_type;
282 struct symt* container;
285 struct symt_pointer
287 struct symt symt;
288 struct symt* pointsto;
291 struct symt_typedef
293 struct symt symt;
294 struct hash_table_elt hash_elt;
295 struct symt* type;
298 struct symt_udt
300 struct symt symt;
301 struct hash_table_elt hash_elt;
302 enum UdtKind kind;
303 int size;
304 struct vector vchildren;
307 enum module_type
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 */
317 struct process;
319 struct module
321 IMAGEHLP_MODULEW64 module;
322 /* ANSI copy of module.ModuleName for efficiency */
323 char module_name[MAX_PATH];
324 struct module* next;
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 */
335 struct pool pool;
337 /* symbols & symbol tables */
338 struct vector vsymt;
339 int sortlist_valid;
340 unsigned num_sorttab; /* number of symbols with addresses */
341 unsigned num_symbols;
342 unsigned sorttab_size;
343 struct symt_ht** addr_sorttab;
344 struct hash_table ht_symbols;
345 void (*loc_compute)(struct process* pcs,
346 const struct module* module,
347 const struct symt_function* func,
348 struct location* loc);
350 /* types */
351 struct hash_table ht_types;
352 struct vector vtypes;
354 /* source files */
355 unsigned sources_used;
356 unsigned sources_alloc;
357 char* sources;
360 struct process
362 struct process* next;
363 HANDLE handle;
364 WCHAR* search_path;
366 PSYMBOL_REGISTERED_CALLBACK64 reg_cb;
367 PSYMBOL_REGISTERED_CALLBACK reg_cb32;
368 BOOL reg_is_unicode;
369 DWORD64 reg_user;
371 struct module* lmodules;
372 unsigned long dbg_hdr_addr;
374 IMAGEHLP_STACK_FRAME ctx_frame;
376 unsigned buffer_size;
377 void* buffer;
380 struct line_info
382 unsigned long is_first : 1,
383 is_last : 1,
384 is_source_file : 1,
385 line_number;
386 union
388 unsigned long pc_offset; /* if is_source_file isn't set */
389 unsigned source_file; /* if is_source_file is set */
390 } u;
393 struct module_pair
395 struct process* pcs;
396 struct module* requested; /* in: to module_get_debug() */
397 struct module* effective; /* out: module with debug info */
400 enum pdb_kind {PDB_JG, PDB_DS};
402 struct pdb_lookup
404 const char* filename;
405 DWORD age;
406 enum pdb_kind kind;
407 union
409 struct
411 DWORD timestamp;
412 struct PDB_JG_TOC* toc;
413 } jg;
414 struct
416 GUID guid;
417 struct PDB_DS_TOC* toc;
418 } ds;
419 } u;
422 struct cpu_stack_walk
424 HANDLE hProcess;
425 HANDLE hThread;
426 BOOL is32;
427 union
429 struct
431 PREAD_PROCESS_MEMORY_ROUTINE f_read_mem;
432 PTRANSLATE_ADDRESS_ROUTINE f_xlat_adr;
433 PFUNCTION_TABLE_ACCESS_ROUTINE f_tabl_acs;
434 PGET_MODULE_BASE_ROUTINE f_modl_bas;
435 } s32;
436 struct
438 PREAD_PROCESS_MEMORY_ROUTINE64 f_read_mem;
439 PTRANSLATE_ADDRESS_ROUTINE64 f_xlat_adr;
440 PFUNCTION_TABLE_ACCESS_ROUTINE64 f_tabl_acs;
441 PGET_MODULE_BASE_ROUTINE64 f_modl_bas;
442 } s64;
443 } u;
446 enum cpu_addr {cpu_addr_pc, cpu_addr_stack, cpu_addr_frame};
447 struct cpu
449 DWORD machine;
450 DWORD word_size;
451 /* address manipulation */
452 unsigned (*get_addr)(HANDLE hThread, const CONTEXT* ctx,
453 enum cpu_addr, ADDRESS64* addr);
455 /* stack manipulation */
456 BOOL (*stack_walk)(struct cpu_stack_walk* csw, LPSTACKFRAME64 frame);
459 extern struct cpu* dbghelp_current_cpu;
461 /* dbghelp.c */
462 extern struct process* process_find_by_handle(HANDLE hProcess);
463 extern HANDLE hMsvcrt;
464 extern BOOL validate_addr64(DWORD64 addr);
465 extern BOOL pcs_callback(const struct process* pcs, ULONG action, void* data);
466 extern void* fetch_buffer(struct process* pcs, unsigned size);
467 extern const char* wine_dbgstr_addr(const ADDRESS64* addr);
468 extern struct cpu* cpu_find(DWORD);
470 /* crc32.c */
471 extern DWORD calc_crc32(int fd);
473 typedef BOOL (*enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
475 /* elf_module.c */
476 #define ELF_NO_MAP ((const void*)-1)
477 extern BOOL elf_enum_modules(HANDLE hProc, enum_modules_cb, void*);
478 extern BOOL elf_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
479 struct elf_file_map;
480 extern BOOL elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
481 extern struct module*
482 elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
483 extern BOOL elf_read_wine_loader_dbg_info(struct process* pcs);
484 extern BOOL elf_synchronize_module_list(struct process* pcs);
485 struct elf_thunk_area;
486 extern int elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
488 /* macho_module.c */
489 #define MACHO_NO_MAP ((const void*)-1)
490 extern BOOL macho_enum_modules(HANDLE hProc, enum_modules_cb, void*);
491 extern BOOL macho_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
492 struct macho_file_map;
493 extern BOOL macho_load_debug_info(struct module* module, struct macho_file_map* fmap);
494 extern struct module*
495 macho_load_module(struct process* pcs, const WCHAR* name, unsigned long);
496 extern BOOL macho_read_wine_loader_dbg_info(struct process* pcs);
497 extern BOOL macho_synchronize_module_list(struct process* pcs);
499 /* module.c */
500 extern const WCHAR S_ElfW[];
501 extern const WCHAR S_WineLoaderW[];
502 extern const WCHAR S_WineW[];
503 extern const WCHAR S_SlashW[];
505 extern struct module*
506 module_find_by_addr(const struct process* pcs, unsigned long addr,
507 enum module_type type);
508 extern struct module*
509 module_find_by_nameA(const struct process* pcs,
510 const char* name);
511 extern struct module*
512 module_is_already_loaded(const struct process* pcs,
513 const WCHAR* imgname);
514 extern BOOL module_get_debug(struct module_pair*);
515 extern struct module*
516 module_new(struct process* pcs, const WCHAR* name,
517 enum module_type type, BOOL virtual,
518 DWORD64 addr, DWORD64 size,
519 unsigned long stamp, unsigned long checksum);
520 extern struct module*
521 module_get_containee(const struct process* pcs,
522 const struct module* inner);
523 extern enum module_type
524 module_get_type_by_name(const WCHAR* name);
525 extern void module_reset_debug_info(struct module* module);
526 extern BOOL module_remove(struct process* pcs,
527 struct module* module);
528 extern void module_set_module(struct module* module, const WCHAR* name);
530 /* msc.c */
531 extern BOOL pe_load_debug_directory(const struct process* pcs,
532 struct module* module,
533 const BYTE* mapping,
534 const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
535 const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
536 extern BOOL pdb_fetch_file_info(struct pdb_lookup* pdb_lookup);
538 /* path.c */
539 extern BOOL path_find_symbol_file(const struct process* pcs, PCSTR full_path,
540 const GUID* guid, DWORD dw1, DWORD dw2, PSTR buffer,
541 BOOL* is_unmatched);
543 /* pe_module.c */
544 extern BOOL pe_load_nt_header(HANDLE hProc, DWORD64 base, IMAGE_NT_HEADERS* nth);
545 extern struct module*
546 pe_load_native_module(struct process* pcs, const WCHAR* name,
547 HANDLE hFile, DWORD base, DWORD size);
548 extern struct module*
549 pe_load_builtin_module(struct process* pcs, const WCHAR* name,
550 DWORD64 base, DWORD64 size);
551 extern BOOL pe_load_debug_info(const struct process* pcs,
552 struct module* module);
553 /* source.c */
554 extern unsigned source_new(struct module* module, const char* basedir, const char* source);
555 extern const char* source_get(const struct module* module, unsigned idx);
557 /* stabs.c */
558 typedef void (*stabs_def_cb)(struct module* module, unsigned long load_offset,
559 const char* name, unsigned long offset,
560 BOOL is_public, BOOL is_global, unsigned char other,
561 struct symt_compiland* compiland, void* user);
562 extern BOOL stabs_parse(struct module* module, unsigned long load_offset,
563 const void* stabs, int stablen,
564 const char* strs, int strtablen,
565 stabs_def_cb callback, void* user);
567 /* dwarf.c */
568 extern BOOL dwarf2_parse(struct module* module, unsigned long load_offset,
569 const struct elf_thunk_area* thunks,
570 const unsigned char* debug, unsigned int debug_size,
571 const unsigned char* abbrev, unsigned int abbrev_size,
572 const unsigned char* str, unsigned int str_size,
573 const unsigned char* line, unsigned int line_size,
574 const unsigned char* loclist, unsigned int loclist_size);
576 /* stack.c */
577 extern BOOL sw_read_mem(struct cpu_stack_walk* csw, DWORD64 addr, void* ptr, DWORD sz);
578 extern DWORD64 sw_xlat_addr(struct cpu_stack_walk* csw, ADDRESS64* addr);
579 extern void* sw_table_access(struct cpu_stack_walk* csw, DWORD64 addr);
580 extern DWORD64 sw_module_base(struct cpu_stack_walk* csw, DWORD64 addr);
582 /* symbol.c */
583 extern const char* symt_get_name(const struct symt* sym);
584 extern struct module* symt_cmp_addr_module;
585 extern int symt_cmp_addr(const void* p1, const void* p2);
586 extern void copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
587 extern struct symt_ht*
588 symt_find_nearest(struct module* module, DWORD_PTR addr);
589 extern struct symt_compiland*
590 symt_new_compiland(struct module* module, unsigned long address,
591 unsigned src_idx);
592 extern struct symt_public*
593 symt_new_public(struct module* module,
594 struct symt_compiland* parent,
595 const char* typename,
596 unsigned long address, unsigned size,
597 BOOL in_code, BOOL is_func);
598 extern struct symt_data*
599 symt_new_global_variable(struct module* module,
600 struct symt_compiland* parent,
601 const char* name, unsigned is_static,
602 unsigned long addr, unsigned long size,
603 struct symt* type);
604 extern struct symt_function*
605 symt_new_function(struct module* module,
606 struct symt_compiland* parent,
607 const char* name,
608 unsigned long addr, unsigned long size,
609 struct symt* type);
610 extern BOOL symt_normalize_function(struct module* module,
611 const struct symt_function* func);
612 extern void symt_add_func_line(struct module* module,
613 struct symt_function* func,
614 unsigned source_idx, int line_num,
615 unsigned long offset);
616 extern struct symt_data*
617 symt_add_func_local(struct module* module,
618 struct symt_function* func,
619 enum DataKind dt, const struct location* loc,
620 struct symt_block* block,
621 struct symt* type, const char* name);
622 extern struct symt_block*
623 symt_open_func_block(struct module* module,
624 struct symt_function* func,
625 struct symt_block* block,
626 unsigned pc, unsigned len);
627 extern struct symt_block*
628 symt_close_func_block(struct module* module,
629 const struct symt_function* func,
630 struct symt_block* block, unsigned pc);
631 extern struct symt_hierarchy_point*
632 symt_add_function_point(struct module* module,
633 struct symt_function* func,
634 enum SymTagEnum point,
635 const struct location* loc,
636 const char* name);
637 extern BOOL symt_fill_func_line_info(const struct module* module,
638 const struct symt_function* func,
639 DWORD64 addr, IMAGEHLP_LINE64* line);
640 extern BOOL symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE64 line);
641 extern struct symt_thunk*
642 symt_new_thunk(struct module* module,
643 struct symt_compiland* parent,
644 const char* name, THUNK_ORDINAL ord,
645 unsigned long addr, unsigned long size);
646 extern struct symt_data*
647 symt_new_constant(struct module* module,
648 struct symt_compiland* parent,
649 const char* name, struct symt* type,
650 const VARIANT* v);
651 extern struct symt_hierarchy_point*
652 symt_new_label(struct module* module,
653 struct symt_compiland* compiland,
654 const char* name, unsigned long address);
655 extern struct symt* symt_index2ptr(struct module* module, DWORD id);
656 extern DWORD symt_ptr2index(struct module* module, const struct symt* sym);
658 /* type.c */
659 extern void symt_init_basic(struct module* module);
660 extern BOOL symt_get_info(struct module* module, const struct symt* type,
661 IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
662 extern struct symt_basic*
663 symt_new_basic(struct module* module, enum BasicType,
664 const char* typename, unsigned size);
665 extern struct symt_udt*
666 symt_new_udt(struct module* module, const char* typename,
667 unsigned size, enum UdtKind kind);
668 extern BOOL symt_set_udt_size(struct module* module,
669 struct symt_udt* type, unsigned size);
670 extern BOOL symt_add_udt_element(struct module* module,
671 struct symt_udt* udt_type,
672 const char* name,
673 struct symt* elt_type, unsigned offset,
674 unsigned size);
675 extern struct symt_enum*
676 symt_new_enum(struct module* module, const char* typename,
677 struct symt* basetype);
678 extern BOOL symt_add_enum_element(struct module* module,
679 struct symt_enum* enum_type,
680 const char* name, int value);
681 extern struct symt_array*
682 symt_new_array(struct module* module, int min, int max,
683 struct symt* base, struct symt* index);
684 extern struct symt_function_signature*
685 symt_new_function_signature(struct module* module,
686 struct symt* ret_type,
687 enum CV_call_e call_conv);
688 extern BOOL symt_add_function_signature_parameter(struct module* module,
689 struct symt_function_signature* sig,
690 struct symt* param);
691 extern struct symt_pointer*
692 symt_new_pointer(struct module* module,
693 struct symt* ref_type);
694 extern struct symt_typedef*
695 symt_new_typedef(struct module* module, struct symt* ref,
696 const char* name);