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