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, 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
  32 #include "cvconst.h"
  33
  34 /* #define USE_STATS */
  35
  36 struct pool /* poor's man */
  37 {
  38     struct pool_arena*  first;
  39     unsigned            arena_size;
  40 };
  41
  42 void     pool_init(struct pool* a, unsigned arena_size);
  43 void     pool_destroy(struct pool* a);
  44 void*    pool_alloc(struct pool* a, unsigned len);
  45 /* void*    pool_realloc(struct pool* a, void* p,
  46    unsigned old_size, unsigned new_size); */
  47 char*    pool_strdup(struct pool* a, const char* str);
  48
  49 struct vector
  50 {
  51     void**      buckets;
  52     unsigned    elt_size;
  53     unsigned    shift;
  54     unsigned    num_elts;
  55     unsigned    num_buckets;
  56 };
  57
  58 void     vector_init(struct vector* v, unsigned elt_sz, unsigned bucket_sz);
  59 unsigned vector_length(const struct vector* v);
  60 void*    vector_at(const struct vector* v, unsigned pos);
  61 void*    vector_add(struct vector* v, struct pool* pool);
  62 /*void     vector_pool_normalize(struct vector* v, struct pool* pool); */
  63 void*    vector_iter_up(const struct vector* v, void* elt);
  64 void*    vector_iter_down(const struct vector* v, void* elt);
  65
  66 struct hash_table_elt
  67 {
  68     const char*                 name;
  69     struct hash_table_elt*      next;
  70 };
  71
  72 struct hash_table
  73 {
  74     unsigned                    num_buckets;
  75     struct hash_table_elt**     buckets;
  76 };
  77
  78 void     hash_table_init(struct pool* pool, struct hash_table* ht,
  79                          unsigned num_buckets);
  80 void     hash_table_destroy(struct hash_table* ht);
  81 void     hash_table_add(struct hash_table* ht, struct hash_table_elt* elt);
  82 void*    hash_table_find(const struct hash_table* ht, const char* name);
  83 unsigned hash_table_hash(const char* name, unsigned num_buckets);
  84
  85 struct hash_table_iter
  86 {
  87     const struct hash_table*    ht;
  88     struct hash_table_elt*      element;
  89     int                         index;
  90     int                         last;
  91 };
  92
  93 void     hash_table_iter_init(const struct hash_table* ht,
  94                               struct hash_table_iter* hti, const char* name);
  95 void*    hash_table_iter_up(struct hash_table_iter* hti);
  96
  97 #define GET_ENTRY(__i, __t, __f) \
  98     ((__t*)((char*)(__i) - (unsigned int)(&((__t*)0)->__f)))
  99
 100
 101 extern unsigned dbghelp_options;
 102 /* some more Wine extensions */
 103 #define SYMOPT_WINE_WITH_ELF_MODULES 0x40000000
 104
 105 struct symt
 106 {
 107     enum SymTagEnum             tag;
 108 };
 109
 110 struct symt_ht
 111 {
 112     struct symt                 symt;
 113     struct hash_table_elt       hash_elt;        /* if global symbol or type */
 114 };
 115
 116 /* lexical tree */
 117 struct symt_block
 118 {
 119     struct symt                 symt;
 120     unsigned long               address;
 121     unsigned long               size;
 122     struct symt*                container;      /* block, or func */
 123     struct vector               vchildren;      /* sub-blocks & local variables */
 124 };
 125
 126 struct symt_compiland
 127 {
 128     struct symt                 symt;
 129     unsigned                    source;
 130     struct vector               vchildren;      /* global variables & functions */
 131 };
 132
 133 struct symt_data
 134 {
 135     struct symt                 symt;
 136     struct hash_table_elt       hash_elt;       /* if global symbol */
 137     enum DataKind               kind;
 138     struct symt*                container;
 139     struct symt*                type;
 140     union                                       /* depends on kind */
 141     {
 142         unsigned long           address;        /* DataIs{Global, FileStatic} */
 143         struct
 144         {
 145             long                        offset; /* DataIs{Member,Local,Param} in bits */
 146             unsigned long               length; /* DataIs{Member} in bits */
 147             unsigned long               reg_id; /* DataIs{Local} (0 if frame relative) */
 148         } s;
 149         VARIANT                 value;          /* DataIsConstant */
 150     } u;
 151 };
 152
 153 struct symt_function
 154 {
 155     struct symt                 symt;
 156     struct hash_table_elt       hash_elt;       /* if global symbol */
 157     unsigned long               address;
 158     struct symt*                container;      /* compiland */
 159     struct symt*                type;           /* points to function_signature */
 160     unsigned long               size;
 161     struct vector               vlines;
 162     struct vector               vchildren;      /* locals, params, blocks, start/end, labels */
 163 };
 164
 165 struct symt_function_point
 166 {
 167     struct symt                 symt;           /* either SymTagFunctionDebugStart, SymTagFunctionDebugEnd, SymTagLabel */
 168     struct symt_function*       parent;
 169     unsigned long               offset;
 170     const char*                 name;           /* for labels */
 171 };
 172
 173 struct symt_public
 174 {
 175     struct symt                 symt;
 176     struct hash_table_elt       hash_elt;
 177     struct symt*                container;      /* compiland */
 178     unsigned long               address;
 179     unsigned long               size;
 180     unsigned                    in_code : 1,
 181                                 is_function : 1;
 182 };
 183
 184 struct symt_thunk
 185 {
 186     struct symt                 symt;
 187     struct hash_table_elt       hash_elt;
 188     struct symt*                container;      /* compiland */
 189     unsigned long               address;
 190     unsigned long               size;
 191     THUNK_ORDINAL               ordinal;        /* FIXME: doesn't seem to be accessible */
 192 };
 193
 194 /* class tree */
 195 struct symt_array
 196 {
 197     struct symt                 symt;
 198     int                         start;
 199     int                         end;
 200     struct symt*                basetype;
 201 };
 202
 203 struct symt_basic
 204 {
 205     struct symt                 symt;
 206     struct hash_table_elt       hash_elt;
 207     enum BasicType              bt;
 208     unsigned long               size;
 209 };
 210
 211 struct symt_enum
 212 {
 213     struct symt                 symt;
 214     const char*                 name;
 215     struct vector               vchildren;
 216 };
 217
 218 struct symt_function_signature
 219 {
 220     struct symt                 symt;
 221     struct symt*                rettype;
 222     struct vector               vchildren;
 223     enum CV_call_e              call_conv;
 224 };
 225
 226 struct symt_function_arg_type
 227 {
 228     struct symt                 symt;
 229     struct symt*                arg_type;
 230     struct symt*                container;
 231 };
 232
 233 struct symt_pointer
 234 {
 235     struct symt                 symt;
 236     struct symt*                pointsto;
 237 };
 238
 239 struct symt_typedef
 240 {
 241     struct symt                 symt;
 242     struct hash_table_elt       hash_elt;
 243     struct symt*                type;
 244 };
 245
 246 struct symt_udt
 247 {
 248     struct symt                 symt;
 249     struct hash_table_elt       hash_elt;
 250     enum UdtKind                kind;
 251     int                         size;
 252     struct vector               vchildren;
 253 };
 254
 255 enum module_type
 256 {
 257     DMT_UNKNOWN,        /* for lookup, not actually used for a module */
 258     DMT_ELF,            /* a real ELF shared module */
 259     DMT_PE,             /* a native or builtin PE module */
 260     DMT_PDB,            /* PDB file */
 261     DMT_VIRTUAL,        /* a virtual module (ie defined by caller) */
 262 };
 263
 264 struct module
 265 {
 266     IMAGEHLP_MODULE             module;
 267     struct module*              next;
 268     enum module_type            type;
 269     struct elf_module_info*     elf_info;
 270
 271     /* memory allocation pool */
 272     struct pool                 pool;
 273
 274     /* symbol tables */
 275     int                         sortlist_valid;
 276     struct symt_ht**            addr_sorttab;
 277     struct hash_table           ht_symbols;
 278
 279     /* types */
 280     struct hash_table           ht_types;
 281     struct vector               vtypes;
 282
 283     /* source files */
 284     unsigned                    sources_used;
 285     unsigned                    sources_alloc;
 286     char*                       sources;
 287 };
 288
 289 struct process
 290 {
 291     struct process*             next;
 292     HANDLE                      handle;
 293     char*                       search_path;
 294
 295     struct module*              lmodules;
 296     unsigned long               dbg_hdr_addr;
 297
 298     IMAGEHLP_STACK_FRAME        ctx_frame;
 299 };
 300
 301 struct line_info
 302 {
 303     unsigned long               is_first : 1,
 304                                 is_last : 1,
 305                                 is_source_file : 1,
 306                                 line_number;
 307     union
 308     {
 309         unsigned long               pc_offset;   /* if is_source_file isn't set */
 310         unsigned                    source_file; /* if is_source_file is set */
 311     } u;
 312 };
 313
 314 /* dbghelp.c */
 315 extern struct process* process_find_by_handle(HANDLE hProcess);
 316 extern HANDLE hMsvcrt;
 317 extern BOOL validate_addr64(DWORD64 addr);
 318
 319 /* elf_module.c */
 320 typedef BOOL (*elf_enum_modules_cb)(const char*, unsigned long addr, void* user);
 321 extern BOOL         elf_enum_modules(HANDLE hProc, elf_enum_modules_cb, void*);
 322 extern BOOL         elf_fetch_file_info(const char* name, DWORD* base, DWORD* size, DWORD* checksum);
 323 struct elf_file_map;
 324 extern BOOL         elf_load_debug_info(struct module* module, struct elf_file_map* fmap);
 325 extern struct module*
 326                     elf_load_module(struct process* pcs, const char* name, unsigned long);
 327 extern BOOL         elf_read_wine_loader_dbg_info(struct process* pcs);
 328 extern BOOL         elf_synchronize_module_list(struct process* pcs);
 329
 330 extern DWORD WINAPI addr_to_linear(HANDLE hProcess, HANDLE hThread, ADDRESS* addr);
 331
 332 /* module.c */
 333 extern struct module*
 334                     module_find_by_addr(const struct process* pcs, unsigned long addr,
 335                                         enum module_type type);
 336 extern struct module*
 337                     module_find_by_name(const struct process* pcs,
 338                                         const char* name, enum module_type type);
 339 extern struct module*
 340                     module_get_debug(const struct process* pcs, struct module*);
 341 extern struct module*
 342                     module_new(struct process* pcs, const char* name,
 343                                enum module_type type, unsigned long addr,
 344                                unsigned long size, unsigned long stamp,
 345                                unsigned long checksum);
 346 extern struct module*
 347                     module_get_container(const struct process* pcs,
 348                                          const struct module* inner);
 349 extern struct module*
 350                     module_get_containee(const struct process* pcs,
 351                                          const struct module* inner);
 352 extern enum module_type
 353                     module_get_type_by_name(const char* name);
 354 extern void         module_reset_debug_info(struct module* module);
 355 extern BOOL         module_remove(struct process* pcs,
 356                                   struct module* module);
 357 /* msc.c */
 358 extern BOOL         pe_load_debug_directory(const struct process* pcs,
 359                                             struct module* module,
 360                                             const BYTE* mapping,
 361                                             const IMAGE_SECTION_HEADER* sectp, DWORD nsect,
 362                                             const IMAGE_DEBUG_DIRECTORY* dbg, int nDbg);
 363 /* pe_module.c */
 364 extern BOOL         pe_load_nt_header(HANDLE hProc, DWORD base, IMAGE_NT_HEADERS* nth);
 365 extern struct module*
 366                     pe_load_module(struct process* pcs, char* name,
 367                                    HANDLE hFile, DWORD base, DWORD size);
 368 extern struct module*
 369                     pe_load_module_from_pcs(struct process* pcs, const char* name,
 370                                             const char* mod_name, DWORD base, DWORD size);
 371 extern BOOL         pe_load_debug_info(const struct process* pcs,
 372                                        struct module* module);
 373 /* source.c */
 374 extern unsigned     source_new(struct module* module, const char* source);
 375 extern const char*  source_get(const struct module* module, unsigned idx);
 376
 377 /* stabs.c */
 378 extern BOOL         stabs_parse(struct module* module, unsigned long load_offset,
 379                                 const void* stabs, int stablen,
 380                                 const char* strs, int strtablen);
 381
 382 /* dwarf.c */
 383 extern BOOL         dwarf2_parse(struct module* module, unsigned long load_offset,
 384                                  const unsigned char* debug, unsigned int debug_size,
 385                                  const unsigned char* abbrev, unsigned int abbrev_size,
 386                                  const unsigned char* str, unsigned int str_sz);
 387
 388 /* symbol.c */
 389 extern const char*  symt_get_name(const struct symt* sym);
 390 extern int          symt_cmp_addr(const void* p1, const void* p2);
 391 extern int          symt_find_nearest(struct module* module, DWORD addr);
 392 extern struct symt_compiland*
 393                     symt_new_compiland(struct module* module,
 394                                        const char* filename);
 395 extern struct symt_public*
 396                     symt_new_public(struct module* module,
 397                                     struct symt_compiland* parent,
 398                                     const char* typename,
 399                                     unsigned long address, unsigned size,
 400                                     BOOL in_code, BOOL is_func);
 401 extern struct symt_data*
 402                     symt_new_global_variable(struct module* module,
 403                                              struct symt_compiland* parent,
 404                                              const char* name, unsigned is_static,
 405                                              unsigned long addr, unsigned long size,
 406                                              struct symt* type);
 407 extern struct symt_function*
 408                     symt_new_function(struct module* module,
 409                                       struct symt_compiland* parent,
 410                                       const char* name,
 411                                       unsigned long addr, unsigned long size,
 412                                       struct symt* type);
 413 extern BOOL         symt_normalize_function(struct module* module,
 414                                             struct symt_function* func);
 415 extern void         symt_add_func_line(struct module* module,
 416                                        struct symt_function* func,
 417                                        unsigned source_idx, int line_num,
 418                                        unsigned long offset);
 419 extern struct symt_data*
 420                     symt_add_func_local(struct module* module,
 421                                         struct symt_function* func,
 422                                         int regno, int offset,
 423                                         struct symt_block* block,
 424                                         struct symt* type, const char* name);
 425 extern struct symt_block*
 426                     symt_open_func_block(struct module* module,
 427                                          struct symt_function* func,
 428                                          struct symt_block* block,
 429                                          unsigned pc, unsigned len);
 430 extern struct symt_block*
 431                     symt_close_func_block(struct module* module,
 432                                           struct symt_function* func,
 433                                           struct symt_block* block, unsigned pc);
 434 extern struct symt_function_point*
 435                     symt_add_function_point(struct module* module,
 436                                             struct symt_function* func,
 437                                             enum SymTagEnum point,
 438                                             unsigned offset, const char* name);
 439 extern BOOL         symt_fill_func_line_info(struct module* module,
 440                                              struct symt_function* func,
 441                                              DWORD addr, IMAGEHLP_LINE* line);
 442 extern BOOL         symt_get_func_line_next(struct module* module, PIMAGEHLP_LINE line);
 443 extern struct symt_thunk*
 444                     symt_new_thunk(struct module* module,
 445                                    struct symt_compiland* parent,
 446                                    const char* name, THUNK_ORDINAL ord,
 447                                    unsigned long addr, unsigned long size);
 448
 449 /* type.c */
 450 extern void         symt_init_basic(struct module* module);
 451 extern BOOL         symt_get_info(const struct symt* type,
 452                                   IMAGEHLP_SYMBOL_TYPE_INFO req, void* pInfo);
 453 extern struct symt_basic*
 454                     symt_new_basic(struct module* module, enum BasicType,
 455                                    const char* typename, unsigned size);
 456 extern struct symt_udt*
 457                     symt_new_udt(struct module* module, const char* typename,
 458                                  unsigned size, enum UdtKind kind);
 459 extern BOOL         symt_set_udt_size(struct module* module,
 460                                       struct symt_udt* type, unsigned size);
 461 extern BOOL         symt_add_udt_element(struct module* module,
 462                                          struct symt_udt* udt_type,
 463                                          const char* name,
 464                                          struct symt* elt_type, unsigned offset,
 465                                          unsigned size);
 466 extern struct symt_enum*
 467                     symt_new_enum(struct module* module, const char* typename);
 468 extern BOOL         symt_add_enum_element(struct module* module,
 469                                           struct symt_enum* enum_type,
 470                                           const char* name, int value);
 471 extern struct symt_array*
 472                     symt_new_array(struct module* module, int min, int max,
 473                                    struct symt* base);
 474 extern struct symt_function_signature*
 475                     symt_new_function_signature(struct module* module,
 476                                                 struct symt* ret_type,
 477                                                 enum CV_call_e call_conv);
 478 extern BOOL         symt_add_function_signature_parameter(struct module* module,
 479                                                           struct symt_function_signature* sig,
 480                                                           struct symt* param);
 481 extern struct symt_pointer*
 482                     symt_new_pointer(struct module* module,
 483                                      struct symt* ref_type);
 484 extern struct symt_typedef*
 485                     symt_new_typedef(struct module* module, struct symt* ref,
 486                                      const char* name);