git.oblomov.eu Git - wine/blob - 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
  84 {
  85     unsigned                    num_elts;
  86     unsigned                    num_buckets;
  87     struct hash_table_elt**     buckets;
  88     struct pool*                pool;
  89 };
  90
  91 void     hash_table_init(struct pool* pool, struct hash_table* ht,
  92                          unsigned num_buckets);
  93 void     hash_table_destroy(struct hash_table* ht);
  94 void     hash_table_add(struct hash_table* ht, struct hash_table_elt* elt);
  95 void*    hash_table_find(const struct hash_table* ht, const char* name);
  96
  97 struct hash_table_iter
  98 {
  99     const struct hash_table*    ht;
 100     struct hash_table_elt*      element;
 101     int                         index;
 102     int                         last;
 103 };
 104
 105 void     hash_table_iter_init(const struct hash_table* ht,
 106                               struct hash_table_iter* hti, const char* name);
 107 void*    hash_table_iter_up(struct hash_table_iter* hti);
 108
 109 #define GET_ENTRY(__i, __t, __f) \
 110     ((__t*)((char*)(__i) - FIELD_OFFSET(__t,__f)))
 111
 112
 113 extern unsigned dbghelp_options;
 114 /* some more Wine extensions */
 115 #define SYMOPT_WINE_WITH_ELF_MODULES 0x40000000
 116
 117 enum location_kind {loc_error,          /* reg is the error code */
 118                     loc_absolute,       /* offset is the location */
 119                     loc_register,       /* reg is the location */
 120                     loc_regrel,         /* [reg+offset] is the location */
 121                     loc_user,           /* value is debug information dependent,
 122                                            reg & offset can be used ad libidem */
 123 };
 124
 125 enum location_error {loc_err_internal = -1,     /* internal while computing */
 126                      loc_err_too_complex = -2,  /* couldn't compute location (even at runtime) */
 127                      loc_err_out_of_scope = -3, /* variable isn't available at current address */
 128                      loc_err_cant_read = -4,    /* couldn't read memory at given address */
 129 };
 130
 131 struct location
 132 {
 133     unsigned            kind : 8,
 134                         reg;
 135     unsigned long       offset;
 136 };
 137
 138 struct symt
 139 {
 140     enum SymTagEnum             tag;
 141 };
 142
 143 struct symt_ht
 144 {
 145     struct symt                 symt;
 146     struct hash_table_elt       hash_elt;        /* if global symbol or type */
 147 };
 148
 149 /* lexical tree */
 150 struct symt_block
 151 {
 152     struct symt                 symt;
 153     unsigned long               address;
 154     unsigned long               size;
 155     struct symt*                container;      /* block, or func */
 156     struct vector               vchildren;      /* sub-blocks & local variables */
 157 };
 158
 159 struct symt_compiland
 160 {
 161     struct symt                 symt;
 162     unsigned long               address;
 163     unsigned                    source;
 164     struct vector               vchildren;      /* global variables & functions */
 165 };
 166
 167 struct symt_data
 168 {
 169     struct symt                 symt;
 170     struct hash_table_elt       hash_elt;       /* if global symbol */
 171     enum DataKind               kind;
 172     struct symt*                container;
 173     struct symt*                type;
 174     union                                       /* depends on kind */
 175     {
 176         /* DataIs{Global, FileStatic}:
 177          *      loc.kind is loc_absolute
 178          *      loc.offset is address
 179          * DataIs{Local,Param}:
 180          *      with loc.kind
 181          *              loc_absolute    not supported
 182          *              loc_register    location is in register loc.reg
 183          *              loc_regrel      location is at address loc.reg + loc.offset
 184          *              >= loc_user     ask debug info provider for resolution
 185          */
 186         struct location         var;
 187         /* DataIs{Member} (all values are in bits, not bytes) */
 188         struct
 189         {
 190             long                        offset;
 191             unsigned long               length;
 192         } member;
 193         /* DataIsConstant */
 194         VARIANT                 value;
 195     } u;
 196 };
 197
 198 struct symt_function
 199 {
 200     struct symt                 symt;
 201     struct hash_table_elt       hash_elt;       /* if global symbol */
 202     unsigned long               address;
 203     struct symt*                container;      /* compiland */
 204     struct symt*                type;           /* points to function_signature */
 205     unsigned long               size;
 206     struct vector               vlines;
 207     struct vector               vchildren;      /* locals, params, blocks, start/end, labels */
 208 };
 209
 210 struct symt_hierarchy_point
 211 {
 212     struct symt                 symt;           /* either SymTagFunctionDebugStart, SymTagFunctionDebugEnd, SymTagLabel */
 213     struct hash_table_elt       hash_elt;       /* if label (and in compiland's hash table if global) */
 214     struct symt*                parent;         /* symt_function or symt_compiland */
 215     struct location             loc;
 216 };
 217
 218 struct symt_public
 219 {
 220     struct symt                 symt;
 221     struct hash_table_elt       hash_elt;
 222     struct symt*                container;      /* compiland */
 223     unsigned long               address;
 224     unsigned long               size;
 225     unsigned                    in_code : 1,
 226                                 is_function : 1;
 227 };
 228
 229 struct symt_thunk
 230 {
 231     struct symt                 symt;
 232     struct hash_table_elt       hash_elt;
 233     struct symt*                container;      /* compiland */
 234     unsigned long               address;
 235     unsigned long               size;
 236     THUNK_ORDINAL               ordinal;        /* FIXME: doesn't seem to be accessible */
 237 };
 238
 239 /* class tree */
 240 struct symt_array
 241 {
 242     struct symt                 symt;
 243     int                         start;
 244     int                         end;
 245     struct symt*                base_type;
 246     struct symt*                index_type;
 247 };
 248
 249 struct symt_basic
 250 {
 251     struct symt                 symt;
 252     struct hash_table_elt       hash_elt;
 253     enum BasicType              bt;
 254     unsigned long               size;
 255 };
 256
 257 struct symt_enum
 258 {
 259     struct symt                 symt;
 260     struct symt*                base_type;
 261     const char*                 name;
 262     struct vector               vchildren;
 263 };
 264
 265 struct symt_function_signature
 266 {
 267     struct symt                 symt;
 268     struct symt*                rettype;
 269     struct vector               vchildren;
 270     enum CV_call_e              call_conv;
 271 };
 272
 273 struct symt_function_arg_type
 274 {
 275     struct symt                 symt;
 276     struct symt*                arg_type;
 277     struct symt*                container;
 278 };
 279
 280 struct symt_pointer
 281 {
 282     struct symt                 symt;
 283     struct symt*                pointsto;
 284 };
 285
 286 struct symt_typedef
 287 {
 288     struct symt                 symt;
 289     struct hash_table_elt       hash_elt;
 290     struct symt*                type;
 291 };
 292
 293 struct symt_udt
 294 {
 295     struct symt                 symt;
 296     struct hash_table_elt       hash_elt;
 297     enum UdtKind                kind;
 298     int                         size;
 299     struct vector               vchildren;
 300 };
 301
 302 enum module_type
 303 {
 304     DMT_UNKNOWN,        /* for lookup, not actually used for a module */
 305     DMT_ELF,            /* a real ELF shared module */
 306     DMT_PE,             /* a native or builtin PE module */
 307     DMT_PDB,            /* .PDB file */
 308     DMT_DBG,            /* .DBG file */
 309 };
 310
 311 struct process;
 312
 313 struct module
 314 {
 315     IMAGEHLP_MODULEW64          module;
 316     /* ANSI copy of module.ModuleName for efficiency */
 317     char                        module_name[MAX_PATH];
 318     struct module*              next;
 319     enum module_type            type : 16;
 320     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     /* memory allocation pool */
 327     struct pool                 pool;
 328
 329     /* symbols & symbol tables */
 330     int                         sortlist_valid;
 331     unsigned                    num_sorttab;    /* number of symbols with addresses */
 332     struct symt_ht**            addr_sorttab;
 333     struct hash_table           ht_symbols;
 334     void                        (*loc_compute)(struct process* pcs,
 335                                                const struct module* module,
 336                                                const struct symt_function* func,
 337                                                struct location* loc);
 338
 339     /* types */
 340     struct hash_table           ht_types;
 341     struct vector               vtypes;
 342
 343     /* source files */
 344     unsigned                    sources_used;
 345     unsigned                    sources_alloc;
 346     char*                       sources;
 347 };
 348
 349 struct process
 350 {
 351     struct process*             next;
 352     HANDLE                      handle;
 353     WCHAR*                      search_path;
 354
 355     PSYMBOL_REGISTERED_CALLBACK64       reg_cb;
 356     BOOL                        reg_is_unicode;
 357     DWORD64                     reg_user;
 358
 359     struct module*              lmodules;
 360     unsigned long               dbg_hdr_addr;
 361
 362     IMAGEHLP_STACK_FRAME        ctx_frame;
 363
 364     unsigned                    buffer_size;
 365     void*                       buffer;
 366 };
 367
 368 struct line_info
 369 {
 370     unsigned long               is_first : 1,
 371                                 is_last : 1,
 372                                 is_source_file : 1,
 373                                 line_number;
 374     union
 375     {
 376         unsigned long               pc_offset;   /* if is_source_file isn't set */
 377         unsigned                    source_file; /* if is_source_file is set */
 378     } u;
 379 };
 380
 381 struct module_pair
 382 {
 383     struct process*             pcs;
 384     struct module*              requested; /* in:  to module_get_debug() */
 385     struct module*              effective; /* out: module with debug info */
 386 };
 387
 388 enum pdb_kind {PDB_JG, PDB_DS};
 389
 390 struct pdb_lookup
 391 {
 392     const char*                 filename;
 393     DWORD                       age;
 394     enum pdb_kind               kind;
 395     union
 396     {
 397         struct
 398         {
 399             DWORD               timestamp;
 400             struct PDB_JG_TOC*  toc;
 401         } jg;
 402         struct
 403         {
 404             GUID                guid;
 405             struct PDB_DS_TOC*  toc;
 406         } ds;
 407     } u;
 408 };
 409
 410 /* dbghelp.c */
 411 extern struct process* process_find_by_handle(HANDLE hProcess);
 412 extern HANDLE hMsvcrt;
 413 extern BOOL         validate_addr64(DWORD64 addr);
 414 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 struct elf_file_map;
 423 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);
 428 struct elf_thunk_area;
 429 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 extern const WCHAR      S_ElfW[];
 434 extern const WCHAR      S_WineLoaderW[];
 435 extern const WCHAR      S_WinePThreadW[];
 436 extern const WCHAR      S_WineKThreadW[];
 437 extern const WCHAR      S_SlashW[];
 438
 439 extern struct module*
 440                     module_find_by_addr(const struct process* pcs, unsigned long addr,
 441                                         enum module_type type);
 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_containee(const struct process* pcs,
 456                                          const struct module* inner);
 457 extern enum module_type
 458                     module_get_type_by_name(const WCHAR* name);
 459 extern void         module_reset_debug_info(struct module* module);
 460 extern BOOL         module_remove(struct process* pcs,
 461                                   struct module* module);
 462 extern void         module_set_module(struct module* module, const WCHAR* name);
 463
 464 /* msc.c */
 465 extern BOOL         pe_load_debug_directory(const struct process* pcs,
 466                                             struct module* module,
 467                                             const BYTE* mapping,
 468                                             const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
 469                                             const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
 470 extern BOOL         pdb_fetch_file_info(struct pdb_lookup* pdb_lookup);
 471
 472 /* path.c */
 473 extern BOOL         path_find_symbol_file(const struct process* pcs, PCSTR full_path,
 474                                           const GUID* guid, DWORD dw1, DWORD dw2, PSTR buffer,
 475                                           BOOL* is_unmatched);
 476
 477 /* pe_module.c */
 478 extern BOOL         pe_load_nt_header(HANDLE hProc, DWORD base, IMAGE_NT_HEADERS* nth);
 479 extern struct module*
 480                     pe_load_native_module(struct process* pcs, const WCHAR* name,
 481                                           HANDLE hFile, DWORD base, DWORD size);
 482 extern struct module*
 483                     pe_load_builtin_module(struct process* pcs, const WCHAR* name,
 484                                            DWORD base, DWORD size);
 485 extern BOOL         pe_load_debug_info(const struct process* pcs,
 486                                        struct module* module);
 487 /* source.c */
 488 extern unsigned     source_new(struct module* module, const char* basedir, const char* source);
 489 extern const char*  source_get(const struct module* module, unsigned idx);
 490
 491 /* stabs.c */
 492 extern BOOL         stabs_parse(struct module* module, unsigned long load_offset,
 493                                 const void* stabs, int stablen,
 494                                 const char* strs, int strtablen);
 495
 496 /* dwarf.c */
 497 extern BOOL         dwarf2_parse(struct module* module, unsigned long load_offset,
 498                                  const struct elf_thunk_area* thunks,
 499                                  const unsigned char* debug, unsigned int debug_size,
 500                                  const unsigned char* abbrev, unsigned int abbrev_size,
 501                                  const unsigned char* str, unsigned int str_size,
 502                                  const unsigned char* line, unsigned int line_size,
 503                                  const unsigned char* loclist, unsigned int loclist_size);
 504
 505 /* symbol.c */
 506 extern const char*  symt_get_name(const struct symt* sym);
 507 extern int          symt_cmp_addr(const void* p1, const void* p2);
 508 extern void         copy_symbolW(SYMBOL_INFOW* siw, const SYMBOL_INFO* si);
 509 extern struct symt_ht*
 510                     symt_find_nearest(struct module* module, DWORD addr);
 511 extern struct symt_compiland*
 512                     symt_new_compiland(struct module* module, unsigned long address,
 513                                        unsigned src_idx);
 514 extern struct symt_public*
 515                     symt_new_public(struct module* module,
 516                                     struct symt_compiland* parent,
 517                                     const char* typename,
 518                                     unsigned long address, unsigned size,
 519                                     BOOL in_code, BOOL is_func);
 520 extern struct symt_data*
 521                     symt_new_global_variable(struct module* module,
 522                                              struct symt_compiland* parent,
 523                                              const char* name, unsigned is_static,
 524                                              unsigned long addr, unsigned long size,
 525                                              struct symt* type);
 526 extern struct symt_function*
 527                     symt_new_function(struct module* module,
 528                                       struct symt_compiland* parent,
 529                                       const char* name,
 530                                       unsigned long addr, unsigned long size,
 531                                       struct symt* type);
 532 extern BOOL         symt_normalize_function(struct module* module,
 533                                             struct symt_function* func);
 534 extern void         symt_add_func_line(struct module* module,
 535                                        struct symt_function* func,
 536                                        unsigned source_idx, int line_num,
 537                                        unsigned long offset);
 538 extern struct symt_data*
 539                     symt_add_func_local(struct module* module,
 540                                         struct symt_function* func,
 541                                         enum DataKind dt, const struct location* loc,
 542                                         struct symt_block* block,
 543                                         struct symt* type, const char* name);
 544 extern struct symt_block*
 545                     symt_open_func_block(struct module* module,
 546                                          struct symt_function* func,
 547                                          struct symt_block* block,
 548                                          unsigned pc, unsigned len);
 549 extern struct symt_block*
 550                     symt_close_func_block(struct module* module,
 551                                           struct symt_function* func,
 552                                           struct symt_block* block, unsigned pc);
 553 extern struct symt_hierarchy_point*
 554                     symt_add_function_point(struct module* module,
 555                                             struct symt_function* func,
 556                                             enum SymTagEnum point,
 557                                             const struct location* loc,
 558                                             const char* name);
 559 extern BOOL         symt_fill_func_line_info(const struct module* module,
 560                                              const struct symt_function* func,
 561                                              DWORD addr, IMAGEHLP_LINE* line);
 562 extern BOOL         symt_get_func_line_next(const struct module* module, PIMAGEHLP_LINE line);
 563 extern struct symt_thunk*
 564                     symt_new_thunk(struct module* module,
 565                                    struct symt_compiland* parent,
 566                                    const char* name, THUNK_ORDINAL ord,
 567                                    unsigned long addr, unsigned long size);
 568 extern struct symt_data*
 569                     symt_new_constant(struct module* module,
 570                                       struct symt_compiland* parent,
 571                                       const char* name, struct symt* type,
 572                                       const VARIANT* v);
 573 extern struct symt_hierarchy_point*
 574                     symt_new_label(struct module* module,
 575                                    struct symt_compiland* compiland,
 576                                    const char* name, unsigned long address);
 577
 578 /* type.c */
 579 extern void         symt_init_basic(struct module* module);
 580 extern BOOL         symt_get_info(const struct symt* type,
 581                                   IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
 582 extern struct symt_basic*
 583                     symt_new_basic(struct module* module, enum BasicType,
 584                                    const char* typename, unsigned size);
 585 extern struct symt_udt*
 586                     symt_new_udt(struct module* module, const char* typename,
 587                                  unsigned size, enum UdtKind kind);
 588 extern BOOL         symt_set_udt_size(struct module* module,
 589                                       struct symt_udt* type, unsigned size);
 590 extern BOOL         symt_add_udt_element(struct module* module,
 591                                          struct symt_udt* udt_type,
 592                                          const char* name,
 593                                          struct symt* elt_type, unsigned offset,
 594                                          unsigned size);
 595 extern struct symt_enum*
 596                     symt_new_enum(struct module* module, const char* typename,
 597                                   struct symt* basetype);
 598 extern BOOL         symt_add_enum_element(struct module* module,
 599                                           struct symt_enum* enum_type,
 600                                           const char* name, int value);
 601 extern struct symt_array*
 602                     symt_new_array(struct module* module, int min, int max,
 603                                    struct symt* base, struct symt* index);
 604 extern struct symt_function_signature*
 605                     symt_new_function_signature(struct module* module,
 606                                                 struct symt* ret_type,
 607                                                 enum CV_call_e call_conv);
 608 extern BOOL         symt_add_function_signature_parameter(struct module* module,
 609                                                           struct symt_function_signature* sig,
 610                                                           struct symt* param);
 611 extern struct symt_pointer*
 612                     symt_new_pointer(struct module* module,
 613                                      struct symt* ref_type);
 614 extern struct symt_typedef*
 615                     symt_new_typedef(struct module* module, struct symt* ref,
 616                                      const char* name);