user32,server: Set the initial window rectangles to 0,0-0,0.
[wine.git] / dlls / dbghelp / dbghelp_private.h
blob99b8b542f9d662e2d937ac0194d9c570ac1e0ac9
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/unicode.h"
34 #include "cvconst.h"
36 /* #define USE_STATS */
38 struct pool /* poor's man */
40 struct pool_arena* first;
41 unsigned arena_size;
44 void pool_init(struct pool* a, unsigned arena_size);
45 void pool_destroy(struct pool* a);
46 void* pool_alloc(struct pool* a, unsigned len);
47 char* pool_strdup(struct pool* a, const char* str);
49 struct vector
51 void** buckets;
52 unsigned elt_size;
53 unsigned shift;
54 unsigned num_elts;
55 unsigned num_buckets;
56 unsigned buckets_allocated;
59 void vector_init(struct vector* v, unsigned elt_sz, unsigned bucket_sz);
60 unsigned vector_length(const struct vector* v);
61 void* vector_at(const struct vector* v, unsigned pos);
62 void* vector_add(struct vector* v, struct pool* pool);
64 struct sparse_array
66 struct vector key2index;
67 struct vector elements;
70 void sparse_array_init(struct sparse_array* sa, unsigned elt_sz, unsigned bucket_sz);
71 void* sparse_array_find(const struct sparse_array* sa, unsigned long idx);
72 void* sparse_array_add(struct sparse_array* sa, unsigned long key, struct pool* pool);
73 unsigned sparse_array_length(const struct sparse_array* sa);
75 struct hash_table_elt
77 const char* name;
78 struct hash_table_elt* next;
81 struct hash_table
83 unsigned num_elts;
84 unsigned num_buckets;
85 struct hash_table_elt** buckets;
86 struct pool* pool;
89 void hash_table_init(struct pool* pool, struct hash_table* ht,
90 unsigned num_buckets);
91 void hash_table_destroy(struct hash_table* ht);
92 void hash_table_add(struct hash_table* ht, struct hash_table_elt* elt);
93 void* hash_table_find(const struct hash_table* ht, const char* name);
94 unsigned hash_table_hash(const char* name, unsigned num_buckets);
96 struct hash_table_iter
98 const struct hash_table* ht;
99 struct hash_table_elt* element;
100 int index;
101 int last;
104 void hash_table_iter_init(const struct hash_table* ht,
105 struct hash_table_iter* hti, const char* name);
106 void* hash_table_iter_up(struct hash_table_iter* hti);
108 #define GET_ENTRY(__i, __t, __f) \
109 ((__t*)((char*)(__i) - (unsigned int)(&((__t*)0)->__f)))
112 extern unsigned dbghelp_options;
113 /* some more Wine extensions */
114 #define SYMOPT_WINE_WITH_ELF_MODULES 0x40000000
116 enum location_kind {loc_error, /* reg is the error code */
117 loc_absolute, /* offset is the location */
118 loc_register, /* reg is the location */
119 loc_regrel, /* [reg+offset] is the location */
120 loc_user, /* value is debug information dependent,
121 reg & offset can be used ad libidem */
124 enum location_error {loc_err_internal = -1, /* internal while computing */
125 loc_err_too_complex = -2, /* couldn't compute location (even at runtime) */
126 loc_err_out_of_scope = -3, /* variable isn't available at current address */
127 loc_err_cant_read = -4, /* couldn't read memory at given address */
130 struct location
132 unsigned kind : 8,
133 reg;
134 unsigned long offset;
137 struct symt
139 enum SymTagEnum tag;
142 struct symt_ht
144 struct symt symt;
145 struct hash_table_elt hash_elt; /* if global symbol or type */
148 /* lexical tree */
149 struct symt_block
151 struct symt symt;
152 unsigned long address;
153 unsigned long size;
154 struct symt* container; /* block, or func */
155 struct vector vchildren; /* sub-blocks & local variables */
158 struct symt_compiland
160 struct symt symt;
161 unsigned long address;
162 unsigned source;
163 struct vector vchildren; /* global variables & functions */
166 struct symt_data
168 struct symt symt;
169 struct hash_table_elt hash_elt; /* if global symbol */
170 enum DataKind kind;
171 struct symt* container;
172 struct symt* type;
173 union /* depends on kind */
175 /* DataIs{Global, FileStatic}:
176 * loc.kind is loc_absolute
177 * loc.offset is address
178 * DataIs{Local,Param}:
179 * with loc.kind
180 * loc_absolute not supported
181 * loc_register location is in register loc.reg
182 * loc_regrel location is at address loc.reg + loc.offset
183 * >= loc_user ask debug info provider for resolution
185 struct location var;
186 /* DataIs{Member} (all values are in bits, not bytes) */
187 struct
189 long offset;
190 unsigned long length;
191 } member;
192 /* DataIsConstant */
193 VARIANT value;
194 } u;
197 struct symt_function
199 struct symt symt;
200 struct hash_table_elt hash_elt; /* if global symbol */
201 unsigned long address;
202 struct symt* container; /* compiland */
203 struct symt* type; /* points to function_signature */
204 unsigned long size;
205 struct vector vlines;
206 struct vector vchildren; /* locals, params, blocks, start/end, labels */
209 struct symt_function_point
211 struct symt symt; /* either SymTagFunctionDebugStart, SymTagFunctionDebugEnd, SymTagLabel */
212 struct symt_function* parent;
213 struct location loc;
214 const char* name; /* for labels */
217 struct symt_public
219 struct symt symt;
220 struct hash_table_elt hash_elt;
221 struct symt* container; /* compiland */
222 unsigned long address;
223 unsigned long size;
224 unsigned in_code : 1,
225 is_function : 1;
228 struct symt_thunk
230 struct symt symt;
231 struct hash_table_elt hash_elt;
232 struct symt* container; /* compiland */
233 unsigned long address;
234 unsigned long size;
235 THUNK_ORDINAL ordinal; /* FIXME: doesn't seem to be accessible */
238 /* class tree */
239 struct symt_array
241 struct symt symt;
242 int start;
243 int end;
244 struct symt* base_type;
245 struct symt* index_type;
248 struct symt_basic
250 struct symt symt;
251 struct hash_table_elt hash_elt;
252 enum BasicType bt;
253 unsigned long size;
256 struct symt_enum
258 struct symt symt;
259 const char* name;
260 struct vector vchildren;
263 struct symt_function_signature
265 struct symt symt;
266 struct symt* rettype;
267 struct vector vchildren;
268 enum CV_call_e call_conv;
271 struct symt_function_arg_type
273 struct symt symt;
274 struct symt* arg_type;
275 struct symt* container;
278 struct symt_pointer
280 struct symt symt;
281 struct symt* pointsto;
284 struct symt_typedef
286 struct symt symt;
287 struct hash_table_elt hash_elt;
288 struct symt* type;
291 struct symt_udt
293 struct symt symt;
294 struct hash_table_elt hash_elt;
295 enum UdtKind kind;
296 int size;
297 struct vector vchildren;
300 enum module_type
302 DMT_UNKNOWN, /* for lookup, not actually used for a module */
303 DMT_ELF, /* a real ELF shared module */
304 DMT_PE, /* a native or builtin PE module */
305 DMT_PDB, /* PDB file */
308 struct process;
310 struct module
312 IMAGEHLP_MODULEW64 module;
313 /* ANSI copy of module.ModuleName for efficiency */
314 char module_name[MAX_PATH];
315 struct module* next;
316 enum module_type type : 16;
317 unsigned short is_virtual : 1;
319 /* specific information for debug types */
320 struct elf_module_info* elf_info;
321 struct dwarf2_module_info_s*dwarf2_info;
323 /* memory allocation pool */
324 struct pool pool;
326 /* symbols & symbol tables */
327 int sortlist_valid;
328 unsigned num_sorttab; /* number of symbols with addresses */
329 struct symt_ht** addr_sorttab;
330 struct hash_table ht_symbols;
331 void (*loc_compute)(struct process* pcs,
332 const struct module* module,
333 const struct symt_function* func,
334 struct location* loc);
336 /* types */
337 struct hash_table ht_types;
338 struct vector vtypes;
340 /* source files */
341 unsigned sources_used;
342 unsigned sources_alloc;
343 char* sources;
346 struct process
348 struct process* next;
349 HANDLE handle;
350 WCHAR* search_path;
352 PSYMBOL_REGISTERED_CALLBACK64 reg_cb;
353 BOOL reg_is_unicode;
354 DWORD64 reg_user;
356 struct module* lmodules;
357 unsigned long dbg_hdr_addr;
359 IMAGEHLP_STACK_FRAME ctx_frame;
361 unsigned buffer_size;
362 void* buffer;
365 struct line_info
367 unsigned long is_first : 1,
368 is_last : 1,
369 is_source_file : 1,
370 line_number;
371 union
373 unsigned long pc_offset; /* if is_source_file isn't set */
374 unsigned source_file; /* if is_source_file is set */
375 } u;
378 struct module_pair
380 struct process* pcs;
381 struct module* requested; /* in: to module_get_debug() */
382 struct module* effective; /* out: module with debug info */
385 enum pdb_kind {PDB_JG, PDB_DS};
387 struct pdb_lookup
389 const char* filename;
390 DWORD age;
391 enum pdb_kind kind;
392 union
394 struct
396 DWORD timestamp;
397 struct PDB_JG_TOC* toc;
398 } jg;
399 struct
401 GUID guid;
402 struct PDB_DS_TOC* toc;
403 } ds;
404 } u;
407 /* dbghelp.c */
408 extern struct process* process_find_by_handle(HANDLE hProcess);
409 extern HANDLE hMsvcrt;
410 extern BOOL validate_addr64(DWORD64 addr);
411 extern BOOL pcs_callback(const struct process* pcs, ULONG action, void* data);
412 extern void* fetch_buffer(struct process* pcs, unsigned size);
414 /* elf_module.c */
415 #define ELF_NO_MAP ((const void*)0xffffffff)
416 typedef BOOL (*elf_enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
417 extern BOOL elf_enum_modules(HANDLE hProc, elf_enum_modules_cb, void*);
418 extern BOOL elf_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
419 struct elf_file_map;
420 extern BOOL elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
421 extern struct module*
422 elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
423 extern BOOL elf_read_wine_loader_dbg_info(struct process* pcs);
424 extern BOOL elf_synchronize_module_list(struct process* pcs);
425 struct elf_thunk_area;
426 extern int elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
427 extern DWORD WINAPI addr_to_linear(HANDLE hProcess, HANDLE hThread, ADDRESS* addr);
429 /* module.c */
430 extern const WCHAR S_ElfW[];
431 extern const WCHAR S_WineLoaderW[];
432 extern const WCHAR S_WinePThreadW[];
433 extern const WCHAR S_WineKThreadW[];
434 extern const WCHAR S_SlashW[];
436 extern struct module*
437 module_find_by_addr(const struct process* pcs, unsigned long addr,
438 enum module_type type);
439 extern struct module*
440 module_find_by_name(const struct process* pcs,
441 const WCHAR* name);
442 extern struct module*
443 module_find_by_nameA(const struct process* pcs,
444 const char* name);
445 extern struct module*
446 module_is_already_loaded(const struct process* pcs,
447 const WCHAR* imgname);
448 extern BOOL module_get_debug(struct module_pair*);
449 extern struct module*
450 module_new(struct process* pcs, const WCHAR* name,
451 enum module_type type, BOOL virtual,
452 unsigned long addr, unsigned long size,
453 unsigned long stamp, unsigned long checksum);
454 extern struct module*
455 module_get_container(const struct process* pcs,
456 const struct module* inner);
457 extern struct module*
458 module_get_containee(const struct process* pcs,
459 const struct module* inner);
460 extern enum module_type
461 module_get_type_by_name(const WCHAR* name);
462 extern void module_reset_debug_info(struct module* module);
463 extern BOOL module_remove(struct process* pcs,
464 struct module* module);
465 extern void module_set_module(struct module* module, const WCHAR* name);
467 /* msc.c */
468 extern BOOL pe_load_debug_directory(const struct process* pcs,
469 struct module* module,
470 const BYTE* mapping,
471 const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
472 const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
473 extern BOOL pdb_fetch_file_info(struct pdb_lookup* pdb_lookup);
475 /* pe_module.c */
476 extern BOOL pe_load_nt_header(HANDLE hProc, DWORD base, IMAGE_NT_HEADERS* nth);
477 extern struct module*
478 pe_load_native_module(struct process* pcs, const WCHAR* name,
479 HANDLE hFile, DWORD base, DWORD size);
480 extern struct module*
481 pe_load_builtin_module(struct process* pcs, const WCHAR* name,
482 DWORD base, DWORD size);
483 extern BOOL pe_load_debug_info(const struct process* pcs,
484 struct module* module);
485 /* source.c */
486 extern unsigned source_new(struct module* module, const char* basedir, const char* source);
487 extern const char* source_get(const struct module* module, unsigned idx);
489 /* stabs.c */
490 extern BOOL stabs_parse(struct module* module, unsigned long load_offset,
491 const void* stabs, int stablen,
492 const char* strs, int strtablen);
494 /* dwarf.c */
495 extern BOOL dwarf2_parse(struct module* module, unsigned long load_offset,
496 const struct elf_thunk_area* thunks,
497 const unsigned char* debug, unsigned int debug_size,
498 const unsigned char* abbrev, unsigned int abbrev_size,
499 const unsigned char* str, unsigned int str_size,
500 const unsigned char* line, unsigned int line_size,
501 const unsigned char* loclist, unsigned int loclist_size);
503 /* symbol.c */
504 extern const char* symt_get_name(const struct symt* sym);
505 extern int symt_cmp_addr(const void* p1, const void* p2);
506 extern void copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
507 extern struct symt_ht*
508 symt_find_nearest(struct module* module, DWORD addr);
509 extern struct symt_compiland*
510 symt_new_compiland(struct module* module, unsigned long address,
511 unsigned src_idx);
512 extern struct symt_public*
513 symt_new_public(struct module* module,
514 struct symt_compiland* parent,
515 const char* typename,
516 unsigned long address, unsigned size,
517 BOOL in_code, BOOL is_func);
518 extern struct symt_data*
519 symt_new_global_variable(struct module* module,
520 struct symt_compiland* parent,
521 const char* name, unsigned is_static,
522 unsigned long addr, unsigned long size,
523 struct symt* type);
524 extern struct symt_function*
525 symt_new_function(struct module* module,
526 struct symt_compiland* parent,
527 const char* name,
528 unsigned long addr, unsigned long size,
529 struct symt* type);
530 extern BOOL symt_normalize_function(struct module* module,
531 struct symt_function* func);
532 extern void symt_add_func_line(struct module* module,
533 struct symt_function* func,
534 unsigned source_idx, int line_num,
535 unsigned long offset);
536 extern struct symt_data*
537 symt_add_func_local(struct module* module,
538 struct symt_function* func,
539 enum DataKind dt, const struct location* loc,
540 struct symt_block* block,
541 struct symt* type, const char* name);
542 extern struct symt_block*
543 symt_open_func_block(struct module* module,
544 struct symt_function* func,
545 struct symt_block* block,
546 unsigned pc, unsigned len);
547 extern struct symt_block*
548 symt_close_func_block(struct module* module,
549 struct symt_function* func,
550 struct symt_block* block, unsigned pc);
551 extern struct symt_function_point*
552 symt_add_function_point(struct module* module,
553 struct symt_function* func,
554 enum SymTagEnum point,
555 const struct location* loc,
556 const char* name);
557 extern BOOL symt_fill_func_line_info(const struct module* module,
558 const struct symt_function* func,
559 DWORD addr, IMAGEHLP_LINE* line);
560 extern BOOL symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE line);
561 extern struct symt_thunk*
562 symt_new_thunk(struct module* module,
563 struct symt_compiland* parent,
564 const char* name, THUNK_ORDINAL ord,
565 unsigned long addr, unsigned long size);
566 extern struct symt_data*
567 symt_new_constant(struct module* module,
568 struct symt_compiland* parent,
569 const char* name, struct symt* type,
570 const VARIANT* v);
572 /* type.c */
573 extern void symt_init_basic(struct module* module);
574 extern BOOL symt_get_info(const struct symt* type,
575 IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
576 extern struct symt_basic*
577 symt_new_basic(struct module* module, enum BasicType,
578 const char* typename, unsigned size);
579 extern struct symt_udt*
580 symt_new_udt(struct module* module, const char* typename,
581 unsigned size, enum UdtKind kind);
582 extern BOOL symt_set_udt_size(struct module* module,
583 struct symt_udt* type, unsigned size);
584 extern BOOL symt_add_udt_element(struct module* module,
585 struct symt_udt* udt_type,
586 const char* name,
587 struct symt* elt_type, unsigned offset,
588 unsigned size);
589 extern struct symt_enum*
590 symt_new_enum(struct module* module, const char* typename);
591 extern BOOL symt_add_enum_element(struct module* module,
592 struct symt_enum* enum_type,
593 const char* name, int value);
594 extern struct symt_array*
595 symt_new_array(struct module* module, int min, int max,
596 struct symt* base, struct symt* index);
597 extern struct symt_function_signature*
598 symt_new_function_signature(struct module* module,
599 struct symt* ret_type,
600 enum CV_call_e call_conv);
601 extern BOOL symt_add_function_signature_parameter(struct module* module,
602 struct symt_function_signature* sig,
603 struct symt* param);
604 extern struct symt_pointer*
605 symt_new_pointer(struct module* module,
606 struct symt* ref_type);
607 extern struct symt_typedef*
608 symt_new_typedef(struct module* module, struct symt* ref,
609 const char* name);