projects / reactos.git / blob
? search:


e7e3c7c3c3771536f88dfc6fde0ab635ff5d05fb
[reactos.git] / reactos / dll / win32 / dbghelp / dbghelp_private.h
1 /*
2 * File dbghelp_private.h - dbghelp internal definitions
3 *
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.
8 *
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.
13 *
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.
18 *
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
22 */
23
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"
34
35 #include "cvconst.h"
36
37 /* #define USE_STATS */
38
39 struct pool /* poor's man */
40 {
41 struct list arena_list;
42 struct list arena_full;
43 size_t arena_size;
44 };
45
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);
50
51 struct vector
52 {
53 void** buckets;
54 unsigned elt_size;
55 unsigned shift;
56 unsigned num_elts;
57 unsigned num_buckets;
58 unsigned buckets_allocated;
59 };
60
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);
65
66 struct sparse_array
67 {
68 struct vector key2index;
69 struct vector elements;
70 };
71
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);
76
77 struct hash_table_elt
78 {
79 const char* name;
80 struct hash_table_elt* next;
81 };
82
83 struct hash_table_bucket
84 {
85 struct hash_table_elt* first;
86 struct hash_table_elt* last;
87 };
88
89 struct hash_table
90 {
91 unsigned num_elts;
92 unsigned num_buckets;
93 struct hash_table_bucket* buckets;
94 struct pool* pool;
95 };
96
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);
101
102 struct hash_table_iter
103 {
104 const struct hash_table* ht;
105 struct hash_table_elt* element;
106 int index;
107 int last;
108 };
109
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);
113
114 #define GET_ENTRY(__i, __t, __f) \
115 ((__t*)((char*)(__i) - FIELD_OFFSET(__t,__f)))
116
117
118 extern unsigned dbghelp_options;
119 /* some more Wine extensions */
120 #define SYMOPT_WINE_WITH_NATIVE_MODULES 0x40000000
121
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 */
128 };
129
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 */
134 };
135
136 struct location
137 {
138 unsigned kind : 8,
139 reg;
140 unsigned long offset;
141 };
142
143 struct symt
144 {
145 enum SymTagEnum tag;
146 };
147
148 struct symt_ht
149 {
150 struct symt symt;
151 struct hash_table_elt hash_elt; /* if global symbol or type */
152 };
153
154 /* lexical tree */
155 struct symt_block
156 {
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 */
162 };
163
164 struct symt_compiland
165 {
166 struct symt symt;
167 unsigned long address;
168 unsigned source;
169 struct vector vchildren; /* global variables & functions */
170 };
171
172 struct symt_data
173 {
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 */
180 {
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
190 */
191 struct location var;
192 /* DataIs{Member} (all values are in bits, not bytes) */
193 struct
194 {
195 long offset;
196 unsigned long length;
197 } member;
198 /* DataIsConstant */
199 VARIANT value;
200 } u;
201 };
202
203 struct symt_function
204 {
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 */
213 };
214
215 struct symt_hierarchy_point
216 {
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;
221 };
222
223 struct symt_public
224 {
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 };
231
232 struct symt_thunk
233 {
234 struct symt symt;
235 struct hash_table_elt hash_elt;
236 struct symt* container; /* compiland */
237 unsigned long address;
238 unsigned long size;
239 THUNK_ORDINAL ordinal; /* FIXME: doesn't seem to be accessible */
240 };
241
242 /* class tree */
243 struct symt_array
244 {
245 struct symt symt;
246 int start;
247 int end; /* end index if > 0, or -array_len (in bytes) if < 0 */
248 struct symt* base_type;
249 struct symt* index_type;
250 };
251
252 struct symt_basic
253 {
254 struct symt symt;
255 struct hash_table_elt hash_elt;
256 enum BasicType bt;
257 unsigned long size;
258 };
259
260 struct symt_enum
261 {
262 struct symt symt;
263 struct symt* base_type;
264 const char* name;
265 struct vector vchildren;
266 };
267
268 struct symt_function_signature
269 {
270 struct symt symt;
271 struct symt* rettype;
272 struct vector vchildren;
273 enum CV_call_e call_conv;
274 };
275
276 struct symt_function_arg_type
277 {
278 struct symt symt;
279 struct symt* arg_type;
280 struct symt* container;
281 };
282
283 struct symt_pointer
284 {
285 struct symt symt;
286 struct symt* pointsto;
287 };
288
289 struct symt_typedef
290 {
291 struct symt symt;
292 struct hash_table_elt hash_elt;
293 struct symt* type;
294 };
295
296 struct symt_udt
297 {
298 struct symt symt;
299 struct hash_table_elt hash_elt;
300 enum UdtKind kind;
301 int size;
302 struct vector vchildren;
303 };
304
305 enum module_type
306 {
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 */
313 };
314
315 struct process;
316
317 struct module
318 {
319 IMAGEHLP_MODULEW64 module;
320 /* ANSI copy of module.ModuleName for efficiency */
321 char module_name[MAX_PATH];
322 struct module* next;
323 enum module_type type : 16;
324 unsigned short is_virtual : 1;
325
326 /* specific information for debug types */
327 struct elf_module_info* elf_info;
328 struct dwarf2_module_info_s*dwarf2_info;
329
330 struct macho_module_info* macho_info;
331
332 /* memory allocation pool */
333 struct pool pool;
334
335 /* symbols & symbol tables */
336 struct vector vsymt;
337 int sortlist_valid;
338 unsigned num_sorttab; /* number of symbols with addresses */
339 unsigned num_symbols;
340 unsigned sorttab_size;
341 struct symt_ht** addr_sorttab;
342 struct hash_table ht_symbols;
343 void (*loc_compute)(struct process* pcs,
344 const struct module* module,
345 const struct symt_function* func,
346 struct location* loc);
347
348 /* types */
349 struct hash_table ht_types;
350 struct vector vtypes;
351
352 /* source files */
353 unsigned sources_used;
354 unsigned sources_alloc;
355 char* sources;
356 };
357
358 struct process
359 {
360 struct process* next;
361 HANDLE handle;
362 WCHAR* search_path;
363
364 PSYMBOL_REGISTERED_CALLBACK64 reg_cb;
365 PSYMBOL_REGISTERED_CALLBACK reg_cb32;
366 BOOL reg_is_unicode;
367 DWORD64 reg_user;
368
369 struct module* lmodules;
370 unsigned long dbg_hdr_addr;
371
372 IMAGEHLP_STACK_FRAME ctx_frame;
373
374 unsigned buffer_size;
375 void* buffer;
376 };
377
378 struct line_info
379 {
380 unsigned long is_first : 1,
381 is_last : 1,
382 is_source_file : 1,
383 line_number;
384 union
385 {
386 unsigned long pc_offset; /* if is_source_file isn't set */
387 unsigned source_file; /* if is_source_file is set */
388 } u;
389 };
390
391 struct module_pair
392 {
393 struct process* pcs;
394 struct module* requested; /* in: to module_get_debug() */
395 struct module* effective; /* out: module with debug info */
396 };
397
398 enum pdb_kind {PDB_JG, PDB_DS};
399
400 struct pdb_lookup
401 {
402 const char* filename;
403 DWORD age;
404 enum pdb_kind kind;
405 union
406 {
407 struct
408 {
409 DWORD timestamp;
410 struct PDB_JG_TOC* toc;
411 } jg;
412 struct
413 {
414 GUID guid;
415 struct PDB_DS_TOC* toc;
416 } ds;
417 } u;
418 };
419
420 struct cpu_stack_walk
421 {
422 HANDLE hProcess;
423 HANDLE hThread;
424 BOOL is32;
425 union
426 {
427 struct
428 {
429 PREAD_PROCESS_MEMORY_ROUTINE f_read_mem;
430 PTRANSLATE_ADDRESS_ROUTINE f_xlat_adr;
431 PFUNCTION_TABLE_ACCESS_ROUTINE f_tabl_acs;
432 PGET_MODULE_BASE_ROUTINE f_modl_bas;
433 } s32;
434 struct
435 {
436 PREAD_PROCESS_MEMORY_ROUTINE64 f_read_mem;
437 PTRANSLATE_ADDRESS_ROUTINE64 f_xlat_adr;
438 PFUNCTION_TABLE_ACCESS_ROUTINE64 f_tabl_acs;
439 PGET_MODULE_BASE_ROUTINE64 f_modl_bas;
440 } s64;
441 } u;
442 };
443
444 enum cpu_addr {cpu_addr_pc, cpu_addr_stack, cpu_addr_frame};
445 struct cpu
446 {
447 DWORD machine;
448 DWORD word_size;
449 /* address manipulation */
450 unsigned (*get_addr)(HANDLE hThread, const CONTEXT* ctx,
451 enum cpu_addr, ADDRESS64* addr);
452
453 /* stack manipulation */
454 BOOL (*stack_walk)(struct cpu_stack_walk* csw, LPSTACKFRAME64 frame);
455 };
456
457 extern struct cpu* dbghelp_current_cpu;
458
459 /* dbghelp.c */
460 extern struct process* process_find_by_handle(HANDLE hProcess);
461 extern HANDLE hMsvcrt;
462 extern BOOL validate_addr64(DWORD64 addr);
463 extern BOOL pcs_callback(const struct process* pcs, ULONG action, void* data);
464 extern void* fetch_buffer(struct process* pcs, unsigned size);
465 extern const char* wine_dbgstr_addr(const ADDRESS64* addr);
466 extern struct cpu* cpu_find(DWORD);
467
468 /* crc32.c */
469 extern DWORD calc_crc32(int fd);
470
471 typedef BOOL (*enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
472
473 /* elf_module.c */
474 #define ELF_NO_MAP ((const void*)-1)
475 extern BOOL elf_enum_modules(HANDLE hProc, enum_modules_cb, void*);
476 extern BOOL elf_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
477 struct elf_file_map;
478 extern BOOL elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
479 extern struct module*
480 elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
481 extern BOOL elf_read_wine_loader_dbg_info(struct process* pcs);
482 extern BOOL elf_synchronize_module_list(struct process* pcs);
483 struct elf_thunk_area;
484 extern int elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
485
486 /* macho_module.c */
487 #define MACHO_NO_MAP ((const void*)-1)
488 extern BOOL macho_enum_modules(HANDLE hProc, enum_modules_cb, void*);
489 extern BOOL macho_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
490 struct macho_file_map;
491 extern BOOL macho_load_debug_info(struct module* module, struct macho_file_map* fmap);
492 extern struct module*
493 macho_load_module(struct process* pcs, const WCHAR* name, unsigned long);
494 extern BOOL macho_read_wine_loader_dbg_info(struct process* pcs);
495 extern BOOL macho_synchronize_module_list(struct process* pcs);
496
497 /* module.c */
498 extern const WCHAR S_ElfW[];
499 extern const WCHAR S_WineLoaderW[];
500 extern const WCHAR S_WineW[];
501 extern const WCHAR S_SlashW[];
502
503 extern struct module*
504 module_find_by_addr(const struct process* pcs, unsigned long addr,
505 enum module_type type);
506 extern struct module*
507 module_find_by_nameA(const struct process* pcs,
508 const char* name);
509 extern struct module*
510 module_is_already_loaded(const struct process* pcs,
511 const WCHAR* imgname);
512 extern BOOL module_get_debug(struct module_pair*);
513 extern struct module*
514 module_new(struct process* pcs, const WCHAR* name,
515 enum module_type type, BOOL virtual,
516 DWORD64 addr, DWORD64 size,
517 unsigned long stamp, unsigned long checksum);
518 extern struct module*
519 module_get_containee(const struct process* pcs,
520 const struct module* inner);
521 extern enum module_type
522 module_get_type_by_name(const WCHAR* name);
523 extern void module_reset_debug_info(struct module* module);
524 extern BOOL module_remove(struct process* pcs,
525 struct module* module);
526 extern void module_set_module(struct module* module, const WCHAR* name);
527
528 /* msc.c */
529 extern BOOL pe_load_debug_directory(const struct process* pcs,
530 struct module* module,
531 const BYTE* mapping,
532 const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
533 const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
534 extern BOOL pdb_fetch_file_info(struct pdb_lookup* pdb_lookup);
535
536 /* path.c */
537 extern BOOL path_find_symbol_file(const struct process* pcs, PCSTR full_path,
538 const GUID* guid, DWORD dw1, DWORD dw2, PSTR buffer,
539 BOOL* is_unmatched);
540
541 /* pe_module.c */
542 extern BOOL pe_load_nt_header(HANDLE hProc, DWORD64 base, IMAGE_NT_HEADERS* nth);
543 extern struct module*
544 pe_load_native_module(struct process* pcs, const WCHAR* name,
545 HANDLE hFile, DWORD base, DWORD size);
546 extern struct module*
547 pe_load_builtin_module(struct process* pcs, const WCHAR* name,
548 DWORD64 base, DWORD64 size);
549 extern BOOL pe_load_debug_info(const struct process* pcs,
550 struct module* module);
551 /* source.c */
552 extern unsigned source_new(struct module* module, const char* basedir, const char* source);
553 extern const char* source_get(const struct module* module, unsigned idx);
554
555 /* stabs.c */
556 typedef void (*stabs_def_cb)(struct module* module, unsigned long load_offset,
557 const char* name, unsigned long offset,
558 BOOL is_public, BOOL is_global, unsigned char other,
559 struct symt_compiland* compiland, void* user);
560 extern BOOL stabs_parse(struct module* module, unsigned long load_offset,
561 const void* stabs, int stablen,
562 const char* strs, int strtablen,
563 stabs_def_cb callback, void* user);
564
565 /* dwarf.c */
566 extern BOOL dwarf2_parse(struct module* module, unsigned long load_offset,
567 const struct elf_thunk_area* thunks,
568 const unsigned char* debug, unsigned int debug_size,
569 const unsigned char* abbrev, unsigned int abbrev_size,
570 const unsigned char* str, unsigned int str_size,
571 const unsigned char* line, unsigned int line_size,
572 const unsigned char* loclist, unsigned int loclist_size);
573
574 /* stack.c */
575 extern BOOL sw_read_mem(struct cpu_stack_walk* csw, DWORD64 addr, void* ptr, DWORD sz);
576 extern DWORD64 sw_xlat_addr(struct cpu_stack_walk* csw, ADDRESS64* addr);
577 extern void* sw_table_access(struct cpu_stack_walk* csw, DWORD64 addr);
578 extern DWORD64 sw_module_base(struct cpu_stack_walk* csw, DWORD64 addr);
579
580 /* symbol.c */
581 extern const char* symt_get_name(const struct symt* sym);
582 extern struct module* symt_cmp_addr_module;
583 extern int symt_cmp_addr(const void* p1, const void* p2);
584 extern void copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
585 extern struct symt_ht*
586 symt_find_nearest(struct module* module, DWORD_PTR addr);
587 extern struct symt_compiland*
588 symt_new_compiland(struct module* module, unsigned long address,
589 unsigned src_idx);
590 extern struct symt_public*
591 symt_new_public(struct module* module,
592 struct symt_compiland* parent,
593 const char* typename,
594 unsigned long address, unsigned size);
595 extern struct symt_data*
596 symt_new_global_variable(struct module* module,
597 struct symt_compiland* parent,
598 const char* name, unsigned is_static,
599 unsigned long addr, unsigned long size,
600 struct symt* type);
601 extern struct symt_function*
602 symt_new_function(struct module* module,
603 struct symt_compiland* parent,
604 const char* name,
605 unsigned long addr, unsigned long size,
606 struct symt* type);
607 extern BOOL symt_normalize_function(struct module* module,
608 const struct symt_function* func);
609 extern void symt_add_func_line(struct module* module,
610 struct symt_function* func,
611 unsigned source_idx, int line_num,
612 unsigned long offset);
613 extern struct symt_data*
614 symt_add_func_local(struct module* module,
615 struct symt_function* func,
616 enum DataKind dt, const struct location* loc,
617 struct symt_block* block,
618 struct symt* type, const char* name);
619 extern struct symt_block*
620 symt_open_func_block(struct module* module,
621 struct symt_function* func,
622 struct symt_block* block,
623 unsigned pc, unsigned len);
624 extern struct symt_block*
625 symt_close_func_block(struct module* module,
626 const struct symt_function* func,
627 struct symt_block* block, unsigned pc);
628 extern struct symt_hierarchy_point*
629 symt_add_function_point(struct module* module,
630 struct symt_function* func,
631 enum SymTagEnum point,
632 const struct location* loc,
633 const char* name);
634 extern BOOL symt_fill_func_line_info(const struct module* module,
635 const struct symt_function* func,
636 DWORD64 addr, IMAGEHLP_LINE64* line);
637 extern BOOL symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE64 line);
638 extern struct symt_thunk*
639 symt_new_thunk(struct module* module,
640 struct symt_compiland* parent,
641 const char* name, THUNK_ORDINAL ord,
642 unsigned long addr, unsigned long size);
643 extern struct symt_data*
644 symt_new_constant(struct module* module,
645 struct symt_compiland* parent,
646 const char* name, struct symt* type,
647 const VARIANT* v);
648 extern struct symt_hierarchy_point*
649 symt_new_label(struct module* module,
650 struct symt_compiland* compiland,
651 const char* name, unsigned long address);
652 extern struct symt* symt_index2ptr(struct module* module, DWORD id);
653 extern DWORD symt_ptr2index(struct module* module, const struct symt* sym);
654
655 /* type.c */
656 extern void symt_init_basic(struct module* module);
657 extern BOOL symt_get_info(struct module* module, const struct symt* type,
658 IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
659 extern struct symt_basic*
660 symt_new_basic(struct module* module, enum BasicType,
661 const char* typename, unsigned size);
662 extern struct symt_udt*
663 symt_new_udt(struct module* module, const char* typename,
664 unsigned size, enum UdtKind kind);
665 extern BOOL symt_set_udt_size(struct module* module,
666 struct symt_udt* type, unsigned size);
667 extern BOOL symt_add_udt_element(struct module* module,
668 struct symt_udt* udt_type,
669 const char* name,
670 struct symt* elt_type, unsigned offset,
671 unsigned size);
672 extern struct symt_enum*
673 symt_new_enum(struct module* module, const char* typename,
674 struct symt* basetype);
675 extern BOOL symt_add_enum_element(struct module* module,
676 struct symt_enum* enum_type,
677 const char* name, int value);
678 extern struct symt_array*
679 symt_new_array(struct module* module, int min, int max,
680 struct symt* base, struct symt* index);
681 extern struct symt_function_signature*
682 symt_new_function_signature(struct module* module,
683 struct symt* ret_type,
684 enum CV_call_e call_conv);
685 extern BOOL symt_add_function_signature_parameter(struct module* module,
686 struct symt_function_signature* sig,
687 struct symt* param);
688 extern struct symt_pointer*
689 symt_new_pointer(struct module* module,
690 struct symt* ref_type);
691 extern struct symt_typedef*
692 symt_new_typedef(struct module* module, struct symt* ref,
693 const char* name);
A free Windows-compatible Operating System