ole32: Fix memory leaks in the storage test.
[wine] / dlls / 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     unsigned                    in_code : 1,
231                                 is_function : 1;
232 };
233
234 struct symt_thunk
235 {
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 */
242 };
243
244 /* class tree */
245 struct symt_array
246 {
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;
252 };
253
254 struct symt_basic
255 {
256     struct symt                 symt;
257     struct hash_table_elt       hash_elt;
258     enum BasicType              bt;
259     unsigned long               size;
260 };
261
262 struct symt_enum
263 {
264     struct symt                 symt;
265     struct symt*                base_type;
266     const char*                 name;
267     struct vector               vchildren;
268 };
269
270 struct symt_function_signature
271 {
272     struct symt                 symt;
273     struct symt*                rettype;
274     struct vector               vchildren;
275     enum CV_call_e              call_conv;
276 };
277
278 struct symt_function_arg_type
279 {
280     struct symt                 symt;
281     struct symt*                arg_type;
282     struct symt*                container;
283 };
284
285 struct symt_pointer
286 {
287     struct symt                 symt;
288     struct symt*                pointsto;
289 };
290
291 struct symt_typedef
292 {
293     struct symt                 symt;
294     struct hash_table_elt       hash_elt;
295     struct symt*                type;
296 };
297
298 struct symt_udt
299 {
300     struct symt                 symt;
301     struct hash_table_elt       hash_elt;
302     enum UdtKind                kind;
303     int                         size;
304     struct vector               vchildren;
305 };
306
307 enum module_type
308 {
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 */
315 };
316
317 struct process;
318
319 struct module
320 {
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;
327
328     /* specific information for debug types */
329     struct elf_module_info*     elf_info;
330     struct dwarf2_module_info_s*dwarf2_info;
331
332     struct macho_module_info*   macho_info;
333
334     /* memory allocation pool */
335     struct pool                 pool;
336
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);
349
350     /* types */
351     struct hash_table           ht_types;
352     struct vector               vtypes;
353
354     /* source files */
355     unsigned                    sources_used;
356     unsigned                    sources_alloc;
357     char*                       sources;
358 };
359
360 struct process 
361 {
362     struct process*             next;
363     HANDLE                      handle;
364     WCHAR*                      search_path;
365
366     PSYMBOL_REGISTERED_CALLBACK64       reg_cb;
367     PSYMBOL_REGISTERED_CALLBACK reg_cb32;
368     BOOL                        reg_is_unicode;
369     DWORD64                     reg_user;
370
371     struct module*              lmodules;
372     unsigned long               dbg_hdr_addr;
373
374     IMAGEHLP_STACK_FRAME        ctx_frame;
375
376     unsigned                    buffer_size;
377     void*                       buffer;
378 };
379
380 struct line_info
381 {
382     unsigned long               is_first : 1,
383                                 is_last : 1,
384                                 is_source_file : 1,
385                                 line_number;
386     union
387     {
388         unsigned long               pc_offset;   /* if is_source_file isn't set */
389         unsigned                    source_file; /* if is_source_file is set */
390     } u;
391 };
392
393 struct module_pair
394 {
395     struct process*             pcs;
396     struct module*              requested; /* in:  to module_get_debug() */
397     struct module*              effective; /* out: module with debug info */
398 };
399
400 enum pdb_kind {PDB_JG, PDB_DS};
401
402 struct pdb_lookup
403 {
404     const char*                 filename;
405     DWORD                       age;
406     enum pdb_kind               kind;
407     union
408     {
409         struct
410         {
411             DWORD               timestamp;
412             struct PDB_JG_TOC*  toc;
413         } jg;
414         struct
415         {
416             GUID                guid;
417             struct PDB_DS_TOC*  toc;
418         } ds;
419     } u;
420 };
421
422 /* dbghelp.c */
423 extern struct process* process_find_by_handle(HANDLE hProcess);
424 extern HANDLE hMsvcrt;
425 extern BOOL         validate_addr64(DWORD64 addr);
426 extern BOOL         pcs_callback(const struct process* pcs, ULONG action, void* data);
427 extern void*        fetch_buffer(struct process* pcs, unsigned size);
428
429 /* crc32.c */
430 extern DWORD calc_crc32(int fd);
431
432 typedef BOOL (*enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
433
434 /* elf_module.c */
435 #define ELF_NO_MAP      ((const void*)-1)
436 extern BOOL         elf_enum_modules(HANDLE hProc, enum_modules_cb, void*);
437 extern BOOL         elf_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
438 struct elf_file_map;
439 extern BOOL         elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
440 extern struct module*
441                     elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
442 extern BOOL         elf_read_wine_loader_dbg_info(struct process* pcs);
443 extern BOOL         elf_synchronize_module_list(struct process* pcs);
444 struct elf_thunk_area;
445 extern int          elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
446
447 /* macho_module.c */
448 #define MACHO_NO_MAP    ((const void*)-1)
449 extern BOOL         macho_enum_modules(HANDLE hProc, enum_modules_cb, void*);
450 extern BOOL         macho_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
451 struct macho_file_map;
452 extern BOOL         macho_load_debug_info(struct module* module, struct macho_file_map* fmap);
453 extern struct module*
454                     macho_load_module(struct process* pcs, const WCHAR* name, unsigned long);
455 extern BOOL         macho_read_wine_loader_dbg_info(struct process* pcs);
456 extern BOOL         macho_synchronize_module_list(struct process* pcs);
457
458 /* module.c */
459 extern const WCHAR      S_ElfW[];
460 extern const WCHAR      S_WineLoaderW[];
461 extern const WCHAR      S_WineW[];
462 extern const WCHAR      S_SlashW[];
463
464 extern struct module*
465                     module_find_by_addr(const struct process* pcs, unsigned long addr,
466                                         enum module_type type);
467 extern struct module*
468                     module_find_by_nameA(const struct process* pcs,
469                                          const char* name);
470 extern struct module*
471                     module_is_already_loaded(const struct process* pcs,
472                                              const WCHAR* imgname);
473 extern BOOL         module_get_debug(struct module_pair*);
474 extern struct module*
475                     module_new(struct process* pcs, const WCHAR* name,
476                                enum module_type type, BOOL virtual,
477                                DWORD64 addr, DWORD64 size,
478                                unsigned long stamp, unsigned long checksum);
479 extern struct module*
480                     module_get_containee(const struct process* pcs,
481                                          const struct module* inner);
482 extern enum module_type
483                     module_get_type_by_name(const WCHAR* name);
484 extern void         module_reset_debug_info(struct module* module);
485 extern BOOL         module_remove(struct process* pcs,
486                                   struct module* module);
487 extern void         module_set_module(struct module* module, const WCHAR* name);
488
489 /* msc.c */
490 extern BOOL         pe_load_debug_directory(const struct process* pcs,
491                                             struct module* module, 
492                                             const BYTE* mapping,
493                                             const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
494                                             const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
495 extern BOOL         pdb_fetch_file_info(struct pdb_lookup* pdb_lookup);
496
497 /* path.c */
498 extern BOOL         path_find_symbol_file(const struct process* pcs, PCSTR full_path,
499                                           const GUID* guid, DWORD dw1, DWORD dw2, PSTR buffer,
500                                           BOOL* is_unmatched);
501
502 /* pe_module.c */
503 extern BOOL         pe_load_nt_header(HANDLE hProc, DWORD64 base, IMAGE_NT_HEADERS* nth);
504 extern struct module*
505                     pe_load_native_module(struct process* pcs, const WCHAR* name,
506                                           HANDLE hFile, DWORD base, DWORD size);
507 extern struct module*
508                     pe_load_builtin_module(struct process* pcs, const WCHAR* name,
509                                            DWORD64 base, DWORD64 size);
510 extern BOOL         pe_load_debug_info(const struct process* pcs,
511                                        struct module* module);
512 /* source.c */
513 extern unsigned     source_new(struct module* module, const char* basedir, const char* source);
514 extern const char*  source_get(const struct module* module, unsigned idx);
515
516 /* stabs.c */
517 typedef void (*stabs_def_cb)(struct module* module, unsigned long load_offset,
518                                 const char* name, unsigned long offset,
519                                 BOOL is_public, BOOL is_global, unsigned char other,
520                                 struct symt_compiland* compiland, void* user);
521 extern BOOL         stabs_parse(struct module* module, unsigned long load_offset,
522                                 const void* stabs, int stablen,
523                                 const char* strs, int strtablen,
524                                 stabs_def_cb callback, void* user);
525
526 /* dwarf.c */
527 extern BOOL         dwarf2_parse(struct module* module, unsigned long load_offset,
528                                  const struct elf_thunk_area* thunks,
529                                  const unsigned char* debug, unsigned int debug_size, 
530                                  const unsigned char* abbrev, unsigned int abbrev_size, 
531                                  const unsigned char* str, unsigned int str_size,
532                                  const unsigned char* line, unsigned int line_size,
533                                  const unsigned char* loclist, unsigned int loclist_size);
534
535 /* symbol.c */
536 extern const char*  symt_get_name(const struct symt* sym);
537 extern struct module* symt_cmp_addr_module;
538 extern int          symt_cmp_addr(const void* p1, const void* p2);
539 extern void         copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
540 extern struct symt_ht*
541                     symt_find_nearest(struct module* module, DWORD_PTR addr);
542 extern struct symt_compiland*
543                     symt_new_compiland(struct module* module, unsigned long address,
544                                        unsigned src_idx);
545 extern struct symt_public*
546                     symt_new_public(struct module* module, 
547                                     struct symt_compiland* parent, 
548                                     const char* typename,
549                                     unsigned long address, unsigned size,
550                                     BOOL in_code, BOOL is_func);
551 extern struct symt_data*
552                     symt_new_global_variable(struct module* module, 
553                                              struct symt_compiland* parent,
554                                              const char* name, unsigned is_static,
555                                              unsigned long addr, unsigned long size, 
556                                              struct symt* type);
557 extern struct symt_function*
558                     symt_new_function(struct module* module,
559                                       struct symt_compiland* parent,
560                                       const char* name,
561                                       unsigned long addr, unsigned long size,
562                                       struct symt* type);
563 extern BOOL         symt_normalize_function(struct module* module, 
564                                             const struct symt_function* func);
565 extern void         symt_add_func_line(struct module* module,
566                                        struct symt_function* func, 
567                                        unsigned source_idx, int line_num, 
568                                        unsigned long offset);
569 extern struct symt_data*
570                     symt_add_func_local(struct module* module, 
571                                         struct symt_function* func, 
572                                         enum DataKind dt, const struct location* loc,
573                                         struct symt_block* block,
574                                         struct symt* type, const char* name);
575 extern struct symt_block*
576                     symt_open_func_block(struct module* module, 
577                                          struct symt_function* func,
578                                          struct symt_block* block, 
579                                          unsigned pc, unsigned len);
580 extern struct symt_block*
581                     symt_close_func_block(struct module* module, 
582                                           const struct symt_function* func,
583                                           struct symt_block* block, unsigned pc);
584 extern struct symt_hierarchy_point*
585                     symt_add_function_point(struct module* module, 
586                                             struct symt_function* func,
587                                             enum SymTagEnum point, 
588                                             const struct location* loc,
589                                             const char* name);
590 extern BOOL         symt_fill_func_line_info(const struct module* module,
591                                              const struct symt_function* func,
592                                              DWORD64 addr, IMAGEHLP_LINE64* line);
593 extern BOOL         symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE64 line);
594 extern struct symt_thunk*
595                     symt_new_thunk(struct module* module, 
596                                    struct symt_compiland* parent,
597                                    const char* name, THUNK_ORDINAL ord,
598                                    unsigned long addr, unsigned long size);
599 extern struct symt_data*
600                     symt_new_constant(struct module* module,
601                                       struct symt_compiland* parent,
602                                       const char* name, struct symt* type,
603                                       const VARIANT* v);
604 extern struct symt_hierarchy_point*
605                     symt_new_label(struct module* module,
606                                    struct symt_compiland* compiland,
607                                    const char* name, unsigned long address);
608 extern struct symt* symt_index2ptr(struct module* module, DWORD id);
609 extern DWORD        symt_ptr2index(struct module* module, const struct symt* sym);
610
611 /* type.c */
612 extern void         symt_init_basic(struct module* module);
613 extern BOOL         symt_get_info(struct module* module, const struct symt* type,
614                                   IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
615 extern struct symt_basic*
616                     symt_new_basic(struct module* module, enum BasicType, 
617                                    const char* typename, unsigned size);
618 extern struct symt_udt*
619                     symt_new_udt(struct module* module, const char* typename,
620                                  unsigned size, enum UdtKind kind);
621 extern BOOL         symt_set_udt_size(struct module* module,
622                                       struct symt_udt* type, unsigned size);
623 extern BOOL         symt_add_udt_element(struct module* module, 
624                                          struct symt_udt* udt_type, 
625                                          const char* name,
626                                          struct symt* elt_type, unsigned offset, 
627                                          unsigned size);
628 extern struct symt_enum*
629                     symt_new_enum(struct module* module, const char* typename,
630                                   struct symt* basetype);
631 extern BOOL         symt_add_enum_element(struct module* module, 
632                                           struct symt_enum* enum_type, 
633                                           const char* name, int value);
634 extern struct symt_array*
635                     symt_new_array(struct module* module, int min, int max, 
636                                    struct symt* base, struct symt* index);
637 extern struct symt_function_signature*
638                     symt_new_function_signature(struct module* module, 
639                                                 struct symt* ret_type,
640                                                 enum CV_call_e call_conv);
641 extern BOOL         symt_add_function_signature_parameter(struct module* module,
642                                                           struct symt_function_signature* sig,
643                                                           struct symt* param);
644 extern struct symt_pointer*
645                     symt_new_pointer(struct module* module, 
646                                      struct symt* ref_type);
647 extern struct symt_typedef*
648                     symt_new_typedef(struct module* module, struct symt* ref, 
649                                      const char* name);