dbghelp_private.h 23.5 KB
Newer Older
1 2 3 4 5 6
/*
 * File dbghelp_private.h - dbghelp internal definitions
 *
 * Copyright (C) 1995, Alexandre Julliard
 * Copyright (C) 1996, Eric Youngdale.
 * Copyright (C) 1999-2000, Ulrich Weigand.
7
 * Copyright (C) 2004-2007, Eric Pouech.
8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * 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 25 26 27 28
 */

#include <stdarg.h>
#include "windef.h"
#include "winbase.h"
#include "winver.h"
#include "dbghelp.h"
29
#include "objbase.h"
30
#include "oaidl.h"
31 32
#include "winnls.h"
#include "wine/unicode.h"
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

#include "cvconst.h"

/* #define USE_STATS */

struct pool /* poor's man */
{
    struct pool_arena*  first;
    unsigned            arena_size;
};

void     pool_init(struct pool* a, unsigned arena_size);
void     pool_destroy(struct pool* a);
void*    pool_alloc(struct pool* a, unsigned len);
/* void*    pool_realloc(struct pool* a, void* p,
   unsigned old_size, unsigned new_size); */
char*    pool_strdup(struct pool* a, const char* str);

struct vector
{
    void**      buckets;
54 55 56 57
    unsigned    elt_size;
    unsigned    shift;
    unsigned    num_elts;
    unsigned    num_buckets;
58 59 60 61 62 63 64 65 66 67
};

void     vector_init(struct vector* v, unsigned elt_sz, unsigned bucket_sz);
unsigned vector_length(const struct vector* v);
void*    vector_at(const struct vector* v, unsigned pos);
void*    vector_add(struct vector* v, struct pool* pool);
/*void     vector_pool_normalize(struct vector* v, struct pool* pool); */
void*    vector_iter_up(const struct vector* v, void* elt);
void*    vector_iter_down(const struct vector* v, void* elt);

68 69 70 71 72 73 74 75 76 77 78
struct sparse_array
{
    struct vector               key2index;
    struct vector               elements;
};

void     sparse_array_init(struct sparse_array* sa, unsigned elt_sz, unsigned bucket_sz);
void*    sparse_array_find(const struct sparse_array* sa, unsigned long idx);
void*    sparse_array_add(struct sparse_array* sa, unsigned long key, struct pool* pool);
unsigned sparse_array_length(const struct sparse_array* sa);

79 80 81 82 83 84 85 86
struct hash_table_elt
{
    const char*                 name;
    struct hash_table_elt*      next;
};

struct hash_table
{
87
    unsigned                    num_elts;
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
    unsigned                    num_buckets;
    struct hash_table_elt**     buckets;
};

void     hash_table_init(struct pool* pool, struct hash_table* ht,
                         unsigned num_buckets);
void     hash_table_destroy(struct hash_table* ht);
void     hash_table_add(struct hash_table* ht, struct hash_table_elt* elt);
void*    hash_table_find(const struct hash_table* ht, const char* name);
unsigned hash_table_hash(const char* name, unsigned num_buckets);

struct hash_table_iter
{
    const struct hash_table*    ht;
    struct hash_table_elt*      element;
    int                         index;
    int                         last;
};

void     hash_table_iter_init(const struct hash_table* ht,
                              struct hash_table_iter* hti, const char* name);
void*    hash_table_iter_up(struct hash_table_iter* hti);

#define GET_ENTRY(__i, __t, __f) \
    ((__t*)((char*)(__i) - (unsigned int)(&((__t*)0)->__f)))


extern unsigned dbghelp_options;
116 117
/* some more Wine extensions */
#define SYMOPT_WINE_WITH_ELF_MODULES 0x40000000
118

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
enum location_kind {loc_error,          /* reg is the error code */
                    loc_absolute,       /* offset is the location */
                    loc_register,       /* reg is the location */
                    loc_regrel,         /* [reg+offset] is the location */
                    loc_user,           /* value is debug information dependent,
                                           reg & offset can be used ad libidem */
};

enum location_error {loc_err_internal = -1,     /* internal while computing */
                     loc_err_too_complex = -2,  /* couldn't compute location (even at runtime) */
                     loc_err_out_of_scope = -3, /* variable isn't available at current address */
                     loc_err_cant_read = -4,    /* couldn't read memory at given address */
};

struct location
{
    unsigned            kind : 8,
                        reg;
    unsigned long       offset;
};

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
struct symt
{
    enum SymTagEnum             tag;
};

struct symt_ht
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;        /* if global symbol or type */
};

/* lexical tree */
struct symt_block
{
    struct symt                 symt;
    unsigned long               address;
    unsigned long               size;
    struct symt*                container;      /* block, or func */
    struct vector               vchildren;      /* sub-blocks & local variables */
};

struct symt_compiland
{
    struct symt                 symt;
164
    unsigned long               address;
165 166 167 168 169 170 171 172 173 174 175
    unsigned                    source;
    struct vector               vchildren;      /* global variables & functions */
};

struct symt_data
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;       /* if global symbol */
    enum DataKind               kind;
    struct symt*                container;
    struct symt*                type;
176
    union                                       /* depends on kind */
177
    {
178 179 180 181 182 183 184 185 186 187 188 189
        /* DataIs{Global, FileStatic}:
         *      loc.kind is loc_absolute
         *      loc.offset is address
         * DataIs{Local,Param}:
         *      with loc.kind
         *              loc_absolute    not supported
         *              loc_register    location is in register loc.reg
         *              loc_regrel      location is at address loc.reg + loc.offset
         *              >= loc_user     ask debug info provider for resolution
         */
        struct location         var;
        /* DataIs{Member} (all values are in bits, not bytes) */
190 191
        struct
        {
192 193 194 195 196
            long                        offset;
            unsigned long               length;
        } member;
        /* DataIsConstant */
        VARIANT                 value;
197 198 199 200 201 202 203
    } u;
};

struct symt_function
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;       /* if global symbol */
204
    unsigned long               address;
205 206 207 208
    struct symt*                container;      /* compiland */
    struct symt*                type;           /* points to function_signature */
    unsigned long               size;
    struct vector               vlines;
209 210 211 212 213 214 215
    struct vector               vchildren;      /* locals, params, blocks, start/end, labels */
};

struct symt_function_point
{
    struct symt                 symt;           /* either SymTagFunctionDebugStart, SymTagFunctionDebugEnd, SymTagLabel */
    struct symt_function*       parent;
216
    struct location             loc;
217
    const char*                 name;           /* for labels */
218 219 220 221 222 223 224 225 226 227 228 229 230
};

struct symt_public
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;
    struct symt*                container;      /* compiland */
    unsigned long               address;
    unsigned long               size;
    unsigned                    in_code : 1,
                                is_function : 1;
};

231 232 233 234 235 236 237 238 239 240
struct symt_thunk
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;
    struct symt*                container;      /* compiland */
    unsigned long               address;
    unsigned long               size;
    THUNK_ORDINAL               ordinal;        /* FIXME: doesn't seem to be accessible */
};

241 242 243 244 245 246
/* class tree */
struct symt_array
{
    struct symt                 symt;
    int		                start;
    int		                end;
247 248
    struct symt*                base_type;
    struct symt*                index_type;
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
};

struct symt_basic
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;
    enum BasicType              bt;
    unsigned long               size;
};

struct symt_enum
{
    struct symt                 symt;
    const char*                 name;
    struct vector               vchildren;
};

struct symt_function_signature
{
    struct symt                 symt;
    struct symt*                rettype;
270
    struct vector               vchildren;
271
    enum CV_call_e              call_conv;
272 273
};

274 275 276 277 278 279 280
struct symt_function_arg_type
{
    struct symt                 symt;
    struct symt*                arg_type;
    struct symt*                container;
};

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
struct symt_pointer
{
    struct symt                 symt;
    struct symt*                pointsto;
};

struct symt_typedef
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;
    struct symt*                type;
};

struct symt_udt
{
    struct symt                 symt;
    struct hash_table_elt       hash_elt;
    enum UdtKind                kind;
    int		                size;
    struct vector               vchildren;
};

303 304 305 306 307
enum module_type
{
    DMT_UNKNOWN,        /* for lookup, not actually used for a module */
    DMT_ELF,            /* a real ELF shared module */
    DMT_PE,             /* a native or builtin PE module */
308
    DMT_PDB,            /* PDB file */
309
};
310

311 312
struct process;

313 314
struct module
{
315
    IMAGEHLP_MODULEW64          module;
316 317
    /* ANSI copy of module.ModuleName for efficiency */
    char                        module_name[MAX_PATH];
318
    struct module*              next;
Eric Pouech's avatar
Eric Pouech committed
319 320
    enum module_type		type : 16;
    unsigned short              is_virtual : 1;
321 322

    /* specific information for debug types */
323
    struct elf_module_info*	elf_info;
324
    struct dwarf2_module_info_s*dwarf2_info;
325

326 327 328
    /* memory allocation pool */
    struct pool                 pool;

329
    /* symbols & symbol tables */
330
    int                         sortlist_valid;
331
    unsigned                    num_sorttab;    /* number of symbols with addresses */
332 333
    struct symt_ht**            addr_sorttab;
    struct hash_table           ht_symbols;
334 335 336 337
    void                        (*loc_compute)(struct process* pcs,
                                               const struct module* module,
                                               const struct symt_function* func,
                                               struct location* loc);
338 339 340

    /* types */
    struct hash_table           ht_types;
341
    struct vector               vtypes;
342 343 344 345 346 347 348 349 350 351 352

    /* source files */
    unsigned                    sources_used;
    unsigned                    sources_alloc;
    char*                       sources;
};

struct process 
{
    struct process*             next;
    HANDLE                      handle;
Eric Pouech's avatar
Eric Pouech committed
353
    WCHAR*                      search_path;
354 355
    
    PSYMBOL_REGISTERED_CALLBACK64       reg_cb;
356
    BOOL                        reg_is_unicode;
357
    DWORD64                     reg_user;
358 359 360 361 362

    struct module*              lmodules;
    unsigned long               dbg_hdr_addr;

    IMAGEHLP_STACK_FRAME        ctx_frame;
363 364 365

    unsigned                    buffer_size;
    void*                       buffer;
366 367
};

Eric Pouech's avatar
Eric Pouech committed
368 369 370 371 372 373 374 375 376 377 378 379 380
struct line_info
{
    unsigned long               is_first : 1,
                                is_last : 1,
                                is_source_file : 1,
                                line_number;
    union
    {
        unsigned long               pc_offset;   /* if is_source_file isn't set */
        unsigned                    source_file; /* if is_source_file is set */
    } u;
};

Eric Pouech's avatar
Eric Pouech committed
381 382
struct module_pair
{
383
    struct process*             pcs;
Eric Pouech's avatar
Eric Pouech committed
384 385 386 387
    struct module*              requested; /* in:  to module_get_debug() */
    struct module*              effective; /* out: module with debug info */
};

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
enum pdb_kind {PDB_JG, PDB_DS};

struct pdb_lookup
{
    const char*                 filename;
    DWORD                       age;
    enum pdb_kind               kind;
    union
    {
        struct
        {
            DWORD               timestamp;
            struct PDB_JG_TOC*  toc;
        } jg;
        struct
        {
            GUID                guid;
            struct PDB_DS_TOC*  toc;
        } ds;
    } u;
};

410 411
/* dbghelp.c */
extern struct process* process_find_by_handle(HANDLE hProcess);
412
extern HANDLE hMsvcrt;
413 414
extern BOOL         validate_addr64(DWORD64 addr);
extern BOOL         pcs_callback(const struct process* pcs, ULONG action, void* data);
415
extern void*        fetch_buffer(struct process* pcs, unsigned size);
416

417
/* elf_module.c */
418
#define ELF_NO_MAP      ((const void*)0xffffffff)
419
typedef BOOL (*elf_enum_modules_cb)(const WCHAR*, unsigned long addr, void* user);
420
extern BOOL         elf_enum_modules(HANDLE hProc, elf_enum_modules_cb, void*);
421
extern BOOL         elf_fetch_file_info(const WCHAR* name, DWORD* base, DWORD* size, DWORD* checksum);
422 423
struct elf_file_map;
extern BOOL         elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
424
extern struct module*
425
                    elf_load_module(struct process* pcs, const WCHAR* name, unsigned long);
426
extern BOOL         elf_read_wine_loader_dbg_info(struct process* pcs);
427
extern BOOL         elf_synchronize_module_list(struct process* pcs);
Eric Pouech's avatar
Eric Pouech committed
428 429
struct elf_thunk_area;
extern int          elf_is_in_thunk_area(unsigned long addr, const struct elf_thunk_area* thunks);
430
extern DWORD WINAPI addr_to_linear(HANDLE hProcess, HANDLE hThread, ADDRESS* addr);
431 432

/* module.c */
433 434
extern const WCHAR      S_ElfW[];
extern const WCHAR      S_WineLoaderW[];
435 436 437
extern const WCHAR      S_WinePThreadW[];
extern const WCHAR      S_WineKThreadW[];
extern const WCHAR      S_SlashW[];
438

439 440
extern struct module*
                    module_find_by_addr(const struct process* pcs, unsigned long addr,
441
                                        enum module_type type);
442
extern struct module*
443 444 445 446 447
                    module_find_by_name(const struct process* pcs,
                                        const WCHAR* name, enum module_type type);
extern struct module*
                    module_find_by_nameA(const struct process* pcs,
                                         const char* name, enum module_type type);
448
extern BOOL         module_get_debug(struct module_pair*);
449
extern struct module*
450
                    module_new(struct process* pcs, const WCHAR* name,
Eric Pouech's avatar
Eric Pouech committed
451 452 453
                               enum module_type type, BOOL virtual,
                               unsigned long addr, unsigned long size,
                               unsigned long stamp, unsigned long checksum);
454 455 456 457 458 459
extern struct module*
                    module_get_container(const struct process* pcs,
                                         const struct module* inner);
extern struct module*
                    module_get_containee(const struct process* pcs,
                                         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);
466

467
/* msc.c */
468
extern BOOL         pe_load_debug_directory(const struct process* pcs,
469
                                            struct module* module, 
470 471
                                            const BYTE* mapping,
                                            const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
472
                                            const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
473 474
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_module(struct process* pcs, const WCHAR* name,
479 480
                                   HANDLE hFile, DWORD base, DWORD size);
extern struct module*
481 482 483
                    pe_load_module_from_pcs(struct process* pcs, const WCHAR* name,
                                            const WCHAR* mod_name, DWORD base, DWORD size);
extern BOOL         pe_load_debug_info(const struct process* pcs,
484 485
                                       struct module* module);
/* source.c */
486
extern unsigned     source_new(struct module* module, const char* basedir, const char* source);
487 488 489
extern const char*  source_get(const struct module* module, unsigned idx);

/* stabs.c */
490 491 492
extern BOOL         stabs_parse(struct module* module, unsigned long load_offset,
                                const void* stabs, int stablen,
                                const char* strs, int strtablen);
493

494 495
/* dwarf.c */
extern BOOL         dwarf2_parse(struct module* module, unsigned long load_offset,
Eric Pouech's avatar
Eric Pouech committed
496
                                 const struct elf_thunk_area* thunks,
497 498
				 const unsigned char* debug, unsigned int debug_size, 
				 const unsigned char* abbrev, unsigned int abbrev_size, 
499
				 const unsigned char* str, unsigned int str_size,
500 501
                                 const unsigned char* line, unsigned int line_size,
                                 const unsigned char* loclist, unsigned int loclist_size);
502

503 504 505
/* symbol.c */
extern const char*  symt_get_name(const struct symt* sym);
extern int          symt_cmp_addr(const void* p1, const void* p2);
506 507
extern struct symt_ht*
                    symt_find_nearest(struct module* module, DWORD addr);
508
extern struct symt_compiland*
509 510
                    symt_new_compiland(struct module* module, unsigned long address,
                                       unsigned src_idx);
511 512 513 514 515 516 517 518 519 520 521 522 523
extern struct symt_public*
                    symt_new_public(struct module* module, 
                                    struct symt_compiland* parent, 
                                    const char* typename,
                                    unsigned long address, unsigned size,
                                    BOOL in_code, BOOL is_func);
extern struct symt_data*
                    symt_new_global_variable(struct module* module, 
                                             struct symt_compiland* parent,
                                             const char* name, unsigned is_static,
                                             unsigned long addr, unsigned long size, 
                                             struct symt* type);
extern struct symt_function*
524
                    symt_new_function(struct module* module,
525 526
                                      struct symt_compiland* parent,
                                      const char* name,
527
                                      unsigned long addr, unsigned long size,
528 529 530 531 532 533 534 535 536 537
                                      struct symt* type);
extern BOOL         symt_normalize_function(struct module* module, 
                                            struct symt_function* func);
extern void         symt_add_func_line(struct module* module,
                                       struct symt_function* func, 
                                       unsigned source_idx, int line_num, 
                                       unsigned long offset);
extern struct symt_data*
                    symt_add_func_local(struct module* module, 
                                        struct symt_function* func, 
538
                                        enum DataKind dt, const struct location* loc,
539 540 541 542 543
                                        struct symt_block* block,
                                        struct symt* type, const char* name);
extern struct symt_block*
                    symt_open_func_block(struct module* module, 
                                         struct symt_function* func,
544 545
                                         struct symt_block* block, 
                                         unsigned pc, unsigned len);
546 547 548 549
extern struct symt_block*
                    symt_close_func_block(struct module* module, 
                                          struct symt_function* func,
                                          struct symt_block* block, unsigned pc);
550 551 552 553
extern struct symt_function_point*
                    symt_add_function_point(struct module* module, 
                                            struct symt_function* func,
                                            enum SymTagEnum point, 
554 555
                                            const struct location* loc,
                                            const char* name);
556 557 558 559
extern BOOL         symt_fill_func_line_info(struct module* module,
                                             struct symt_function* func, 
                                             DWORD addr, IMAGEHLP_LINE* line);
extern BOOL         symt_get_func_line_next(struct module* module, PIMAGEHLP_LINE line);
560 561 562 563 564
extern struct symt_thunk*
                    symt_new_thunk(struct module* module, 
                                   struct symt_compiland* parent,
                                   const char* name, THUNK_ORDINAL ord,
                                   unsigned long addr, unsigned long size);
565 566 567 568 569
extern struct symt_data*
                    symt_new_constant(struct module* module,
                                      struct symt_compiland* parent,
                                      const char* name, struct symt* type,
                                      const VARIANT* v);
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591

/* type.c */
extern void         symt_init_basic(struct module* module);
extern BOOL         symt_get_info(const struct symt* type,
                                  IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
extern struct symt_basic*
                    symt_new_basic(struct module* module, enum BasicType, 
                                   const char* typename, unsigned size);
extern struct symt_udt*
                    symt_new_udt(struct module* module, const char* typename,
                                 unsigned size, enum UdtKind kind);
extern BOOL         symt_set_udt_size(struct module* module,
                                      struct symt_udt* type, unsigned size);
extern BOOL         symt_add_udt_element(struct module* module, 
                                         struct symt_udt* udt_type, 
                                         const char* name,
                                         struct symt* elt_type, unsigned offset, 
                                         unsigned size);
extern struct symt_enum*
                    symt_new_enum(struct module* module, const char* typename);
extern BOOL         symt_add_enum_element(struct module* module, 
                                          struct symt_enum* enum_type, 
592
                                          const char* name, int value);
593 594
extern struct symt_array*
                    symt_new_array(struct module* module, int min, int max, 
595
                                   struct symt* base, struct symt* index);
596 597
extern struct symt_function_signature*
                    symt_new_function_signature(struct module* module, 
598 599
                                                struct symt* ret_type,
                                                enum CV_call_e call_conv);
600 601 602
extern BOOL         symt_add_function_signature_parameter(struct module* module,
                                                          struct symt_function_signature* sig,
                                                          struct symt* param);
603 604 605
extern struct symt_pointer*
                    symt_new_pointer(struct module* module, 
                                     struct symt* ref_type);
606 607 608
extern struct symt_typedef*
                    symt_new_typedef(struct module* module, struct symt* ref, 
                                     const char* name);