dlls/dbghelp/symbol.c

   1 /*
   2  * File symbol.c - management of symbols (lexical tree)
   3  *
   4  * Copyright (C) 1993, Eric Youngdale.
   5  *               2004, Eric Pouech
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #define NONAMELESSUNION
  23 #define NONAMELESSSTRUCT
  24
  25 #include "config.h"
  26
  27 #include <stdlib.h>
  28 #include <stdio.h>
  29 #include <string.h>
  30 #include <limits.h>
  31 #include <sys/types.h>
  32 #include <assert.h>
  33 #ifdef HAVE_REGEX_H
  34 # include <regex.h>
  35 #endif
  36
  37 #include "wine/debug.h"
  38 #include "dbghelp_private.h"
  39
  40 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp);
  41 WINE_DECLARE_DEBUG_CHANNEL(dbghelp_symt);
  42
  43 struct line_info
  44 {
  45     unsigned long               is_first : 1,
  46                                 is_last : 1,
  47                                 is_source_file : 1,
  48                                 line_number;
  49     union
  50     {
  51         unsigned long               pc_offset;   /* if is_source_file isn't set */
  52         unsigned                    source_file; /* if is_source_file is set */
  53     } u;
  54 };
  55
  56 inline static int cmp_addr(DWORD a1, DWORD a2)
  57 {
  58     if (a1 > a2) return 1;
  59     if (a1 < a2) return -1;
  60     return 0;
  61 }
  62
  63 inline static int cmp_sorttab_addr(const struct module* module, int idx, DWORD addr)
  64 {
  65     DWORD       ref;
  66
  67     symt_get_info(&module->addr_sorttab[idx]->symt, TI_GET_ADDRESS, &ref);
  68     return cmp_addr(ref, addr);
  69 }
  70
  71 int symt_cmp_addr(const void* p1, const void* p2)
  72 {
  73     const struct symt*  sym1 = *(const struct symt* const *)p1;
  74     const struct symt*  sym2 = *(const struct symt* const *)p2;
  75     DWORD               a1, a2;
  76
  77     symt_get_info(sym1, TI_GET_ADDRESS, &a1);
  78     symt_get_info(sym2, TI_GET_ADDRESS, &a2);
  79     return cmp_addr(a1, a2);
  80 }
  81
  82 static inline void re_append(char** mask, unsigned* len, char ch)
  83 {
  84     *mask = HeapReAlloc(GetProcessHeap(), 0, *mask, ++(*len));
  85     (*mask)[*len - 2] = ch;
  86 }
  87
  88 /* transforms a dbghelp's regular expression into a POSIX one
  89  * Here are the valid dbghelp reg ex characters:
  90  *      *       0 or more characters
  91  *      ?       a single character
  92  *      []      list
  93  *      #       0 or more of preceding char
  94  *      +       1 or more of preceding char
  95  *      escapes \ on #, ?, [, ], *, +. don't work on -
  96  */
  97 static void compile_regex(const char* str, int numchar, regex_t* re)
  98 {
  99     char*       mask = HeapAlloc(GetProcessHeap(), 0, 1);
 100     unsigned    len = 1;
 101     BOOL        in_escape = FALSE;
 102
 103     re_append(&mask, &len, '^');
 104
 105     while (*str && numchar--)
 106     {
 107         /* FIXME: this shouldn't be valid on '-' */
 108         if (in_escape)
 109         {
 110             re_append(&mask, &len, '\\');
 111             re_append(&mask, &len, *str);
 112             in_escape = FALSE;
 113         }
 114         else switch (*str)
 115         {
 116         case '\\': in_escape = TRUE; break;
 117         case '*':  re_append(&mask, &len, '.'); re_append(&mask, &len, '*'); break;
 118         case '?':  re_append(&mask, &len, '.'); break;
 119         case '#':  re_append(&mask, &len, '*'); break;
 120         /* escape some valid characters in dbghelp reg exp:s */
 121         case '$':  re_append(&mask, &len, '\\'); re_append(&mask, &len, '$'); break;
 122         /* +, [, ], - are the same in dbghelp & POSIX, use them as any other char */
 123         default:   re_append(&mask, &len, *str); break;
 124         }
 125         str++;
 126     }
 127     if (in_escape)
 128     {
 129         re_append(&mask, &len, '\\');
 130         re_append(&mask, &len, '\\');
 131     }
 132     re_append(&mask, &len, '$');
 133     mask[len - 1] = '\0';
 134     if (regcomp(re, mask, REG_NOSUB)) FIXME("Couldn't compile %s\n", mask);
 135     HeapFree(GetProcessHeap(), 0, mask);
 136 }
 137
 138 struct symt_compiland* symt_new_compiland(struct module* module, const char* name)
 139 {
 140     struct symt_compiland*    sym;
 141
 142     TRACE_(dbghelp_symt)("Adding compiland symbol %s:%s\n",
 143                          module->module.ModuleName, name);
 144     if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
 145     {
 146         sym->symt.tag = SymTagCompiland;
 147         sym->source   = source_new(module, name);
 148         vector_init(&sym->vchildren, sizeof(struct symt*), 32);
 149     }
 150     return sym;
 151 }
 152
 153 struct symt_public* symt_new_public(struct module* module,
 154                                     struct symt_compiland* compiland,
 155                                     const char* name,
 156                                     unsigned long address, unsigned size,
 157                                     BOOL in_code, BOOL is_func)
 158 {
 159     struct symt_public* sym;
 160     struct symt**       p;
 161
 162     TRACE_(dbghelp_symt)("Adding public symbol %s:%s @%lx\n",
 163                          module->module.ModuleName, name, address);
 164     if ((dbghelp_options & SYMOPT_AUTO_PUBLICS) &&
 165         symt_find_nearest(module, address) != -1)
 166         return NULL;
 167     if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
 168     {
 169         sym->symt.tag      = SymTagPublicSymbol;
 170         sym->hash_elt.name = pool_strdup(&module->pool, name);
 171         hash_table_add(&module->ht_symbols, &sym->hash_elt);
 172         module->sortlist_valid = FALSE;
 173         sym->container     = compiland ? &compiland->symt : NULL;
 174         sym->address       = address;
 175         sym->size          = size;
 176         sym->in_code       = in_code;
 177         sym->is_function   = is_func;
 178         if (compiland)
 179         {
 180             p = vector_add(&compiland->vchildren, &module->pool);
 181             *p = &sym->symt;
 182         }
 183     }
 184     return sym;
 185 }
 186
 187 struct symt_data* symt_new_global_variable(struct module* module,
 188                                            struct symt_compiland* compiland,
 189                                            const char* name, unsigned is_static,
 190                                            unsigned long addr, unsigned long size,
 191                                            struct symt* type)
 192 {
 193     struct symt_data*   sym;
 194     struct symt**       p;
 195     DWORD               tsz;
 196
 197     TRACE_(dbghelp_symt)("Adding global symbol %s:%s @%lx %p\n",
 198                          module->module.ModuleName, name, addr, type);
 199     if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
 200     {
 201         sym->symt.tag      = SymTagData;
 202         sym->hash_elt.name = pool_strdup(&module->pool, name);
 203         hash_table_add(&module->ht_symbols, &sym->hash_elt);
 204         module->sortlist_valid = FALSE;
 205         sym->kind          = is_static ? DataIsFileStatic : DataIsGlobal;
 206         sym->container     = compiland ? &compiland->symt : NULL;
 207         sym->type          = type;
 208         sym->u.address     = addr;
 209         if (type && size && symt_get_info(type, TI_GET_LENGTH, &tsz))
 210         {
 211             if (tsz != size)
 212                 FIXME("Size mismatch for %s.%s between type (%lu) and src (%lu)\n",
 213                       module->module.ModuleName, name, tsz, size);
 214         }
 215         if (compiland)
 216         {
 217             p = vector_add(&compiland->vchildren, &module->pool);
 218             *p = &sym->symt;
 219         }
 220     }
 221     return sym;
 222 }
 223
 224 struct symt_function* symt_new_function(struct module* module,
 225                                         struct symt_compiland* compiland,
 226                                         const char* name,
 227                                         unsigned long addr, unsigned long size,
 228                                         struct symt* sig_type)
 229 {
 230     struct symt_function*       sym;
 231     struct symt**               p;
 232
 233     TRACE_(dbghelp_symt)("Adding global function %s:%s @%lx-%lx\n",
 234                          module->module.ModuleName, name, addr, addr + size - 1);
 235
 236     assert(!sig_type || sig_type->tag == SymTagFunctionType);
 237     if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
 238     {
 239         sym->symt.tag  = SymTagFunction;
 240         sym->hash_elt.name = pool_strdup(&module->pool, name);
 241         hash_table_add(&module->ht_symbols, &sym->hash_elt);
 242         module->sortlist_valid = FALSE;
 243         sym->container = &compiland->symt;
 244         sym->address   = addr;
 245         sym->type      = sig_type;
 246         sym->size      = size;
 247         vector_init(&sym->vlines,  sizeof(struct line_info), 64);
 248         vector_init(&sym->vchildren, sizeof(struct symt*), 8);
 249         if (compiland)
 250         {
 251             p = vector_add(&compiland->vchildren, &module->pool);
 252             *p = &sym->symt;
 253         }
 254     }
 255     return sym;
 256 }
 257
 258 void symt_add_func_line(struct module* module, struct symt_function* func,
 259                         unsigned source_idx, int line_num, unsigned long offset)
 260 {
 261     struct line_info*   dli;
 262     BOOL                last_matches = FALSE;
 263
 264     if (func == NULL || !(dbghelp_options & SYMOPT_LOAD_LINES)) return;
 265
 266     TRACE_(dbghelp_symt)("(%p)%s:%lx %s:%u\n",
 267                          func, func->hash_elt.name, offset,
 268                          source_get(module, source_idx), line_num);
 269
 270     assert(func->symt.tag == SymTagFunction);
 271
 272     dli = NULL;
 273     while ((dli = vector_iter_down(&func->vlines, dli)))
 274     {
 275         if (dli->is_source_file)
 276         {
 277             last_matches = (source_idx == dli->u.source_file);
 278             break;
 279         }
 280     }
 281
 282     if (!last_matches)
 283     {
 284         /* we shouldn't have line changes on first line of function */
 285         dli = vector_add(&func->vlines, &module->pool);
 286         dli->is_source_file = 1;
 287         dli->is_first       = dli->is_last = 0;
 288         dli->line_number    = 0;
 289         dli->u.source_file  = source_idx;
 290     }
 291     dli = vector_add(&func->vlines, &module->pool);
 292     dli->is_source_file = 0;
 293     dli->is_first       = dli->is_last = 0;
 294     dli->line_number    = line_num;
 295     dli->u.pc_offset    = func->address + offset;
 296 }
 297
 298 struct symt_data* symt_add_func_local(struct module* module,
 299                                       struct symt_function* func,
 300                                       int regno, int offset,
 301                                       struct symt_block* block,
 302                                       struct symt* type, const char* name)
 303 {
 304     struct symt_data*   locsym;
 305     struct symt**       p;
 306
 307     assert(func);
 308     assert(func->symt.tag == SymTagFunction);
 309
 310     TRACE_(dbghelp_symt)("Adding local symbol (%s:%s): %s %p\n",
 311                          module->module.ModuleName, func->hash_elt.name,
 312                          name, type);
 313     locsym = pool_alloc(&module->pool, sizeof(*locsym));
 314     locsym->symt.tag      = SymTagData;
 315     locsym->hash_elt.name = pool_strdup(&module->pool, name);
 316     locsym->hash_elt.next = NULL;
 317     locsym->kind          = (offset < 0) ? DataIsParam : DataIsLocal;
 318     locsym->container     = &block->symt;
 319     locsym->type          = type;
 320     if (regno)
 321     {
 322         locsym->u.s.reg_id = regno;
 323         locsym->u.s.offset = 0;
 324         locsym->u.s.length = 0;
 325     }
 326     else
 327     {
 328         locsym->u.s.reg_id = 0;
 329         locsym->u.s.offset = offset * 8;
 330         locsym->u.s.length = 0;
 331     }
 332     if (block)
 333         p = vector_add(&block->vchildren, &module->pool);
 334     else
 335         p = vector_add(&func->vchildren, &module->pool);
 336     *p = &locsym->symt;
 337     return locsym;
 338 }
 339
 340 struct symt_block* symt_open_func_block(struct module* module,
 341                                         struct symt_function* func,
 342                                         struct symt_block* parent_block,
 343                                         unsigned pc, unsigned len)
 344 {
 345     struct symt_block*  block;
 346     struct symt**       p;
 347
 348     assert(func);
 349     assert(func->symt.tag == SymTagFunction);
 350
 351     assert(!parent_block || parent_block->symt.tag == SymTagBlock);
 352     block = pool_alloc(&module->pool, sizeof(*block));
 353     block->symt.tag = SymTagBlock;
 354     block->address  = func->address + pc;
 355     block->size     = len;
 356     block->container = parent_block ? &parent_block->symt : &func->symt;
 357     vector_init(&block->vchildren, sizeof(struct symt*), 4);
 358     if (parent_block)
 359         p = vector_add(&parent_block->vchildren, &module->pool);
 360     else
 361         p = vector_add(&func->vchildren, &module->pool);
 362     *p = &block->symt;
 363
 364     return block;
 365 }
 366
 367 struct symt_block* symt_close_func_block(struct module* module,
 368                                          struct symt_function* func,
 369                                          struct symt_block* block, unsigned pc)
 370 {
 371     assert(func->symt.tag == SymTagFunction);
 372
 373     if (pc) block->size = func->address + pc - block->address;
 374     return (block->container->tag == SymTagBlock) ?
 375         GET_ENTRY(block->container, struct symt_block, symt) : NULL;
 376 }
 377
 378 struct symt_function_point* symt_add_function_point(struct module* module,
 379                                                     struct symt_function* func,
 380                                                     enum SymTagEnum point,
 381                                                     unsigned offset, const char* name)
 382 {
 383     struct symt_function_point* sym;
 384     struct symt**               p;
 385
 386     if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
 387     {
 388         sym->symt.tag = point;
 389         sym->parent   = func;
 390         sym->offset   = offset;
 391         sym->name     = name ? pool_strdup(&module->pool, name) : NULL;
 392         p = vector_add(&func->vchildren, &module->pool);
 393         *p = &sym->symt;
 394     }
 395     return sym;
 396 }
 397
 398 BOOL symt_normalize_function(struct module* module, struct symt_function* func)
 399 {
 400     unsigned            len;
 401     struct line_info*   dli;
 402
 403     assert(func);
 404     /* We aren't adding any more locals or line numbers to this function.
 405      * Free any spare memory that we might have allocated.
 406      */
 407     assert(func->symt.tag == SymTagFunction);
 408
 409 /* EPP     vector_pool_normalize(&func->vlines,    &module->pool); */
 410 /* EPP     vector_pool_normalize(&func->vchildren, &module->pool); */
 411
 412     len = vector_length(&func->vlines);
 413     if (len--)
 414     {
 415         dli = vector_at(&func->vlines,   0);  dli->is_first = 1;
 416         dli = vector_at(&func->vlines, len);  dli->is_last  = 1;
 417     }
 418     return TRUE;
 419 }
 420
 421 struct symt_thunk* symt_new_thunk(struct module* module,
 422                                   struct symt_compiland* compiland,
 423                                   const char* name, THUNK_ORDINAL ord,
 424                                   unsigned long addr, unsigned long size)
 425 {
 426     struct symt_thunk*  sym;
 427
 428     TRACE_(dbghelp_symt)("Adding global thunk %s:%s @%lx-%lx\n",
 429                          module->module.ModuleName, name, addr, addr + size - 1);
 430
 431     if ((sym = pool_alloc(&module->pool, sizeof(*sym))))
 432     {
 433         sym->symt.tag  = SymTagThunk;
 434         sym->hash_elt.name = pool_strdup(&module->pool, name);
 435         hash_table_add(&module->ht_symbols, &sym->hash_elt);
 436         module->sortlist_valid = FALSE;
 437         sym->container = &compiland->symt;
 438         sym->address   = addr;
 439         sym->size      = size;
 440         sym->ordinal   = ord;
 441         if (compiland)
 442         {
 443             struct symt**       p;
 444             p = vector_add(&compiland->vchildren, &module->pool);
 445             *p = &sym->symt;
 446         }
 447     }
 448     return sym;
 449 }
 450
 451 /* expect sym_info->MaxNameLen to be set before being called */
 452 static void symt_fill_sym_info(const struct module* module,
 453                                const struct symt* sym, SYMBOL_INFO* sym_info)
 454 {
 455     const char* name;
 456
 457     sym_info->TypeIndex = (DWORD)sym;
 458     sym_info->info = 0; /* TBD */
 459     symt_get_info(sym, TI_GET_LENGTH, &sym_info->Size);
 460     sym_info->ModBase = module->module.BaseOfImage;
 461     sym_info->Flags = 0;
 462     switch (sym->tag)
 463     {
 464     case SymTagData:
 465         {
 466             const struct symt_data*  data = (const struct symt_data*)sym;
 467             switch (data->kind)
 468             {
 469             case DataIsLocal:
 470             case DataIsParam:
 471                 if (data->u.s.reg_id)
 472                 {
 473                     sym_info->Flags |= SYMFLAG_LOCAL | SYMFLAG_REGISTER;
 474                     sym_info->Register = data->u.s.reg_id;
 475                     sym_info->Address = 0;
 476                 }
 477                 else
 478                 {
 479                     if (data->u.s.offset < 0)
 480                         sym_info->Flags |= SYMFLAG_LOCAL | SYMFLAG_FRAMEREL;
 481                     else
 482                         sym_info->Flags |= SYMFLAG_PARAMETER | SYMFLAG_FRAMEREL;
 483                     /* FIXME: needed ? moreover, it's i386 dependant !!! */
 484                     sym_info->Register = CV_REG_EBP;
 485                     sym_info->Address = data->u.s.offset;
 486                 }
 487                 break;
 488             case DataIsGlobal:
 489             case DataIsFileStatic:
 490                 symt_get_info(sym, TI_GET_ADDRESS, &sym_info->Address);
 491                 sym_info->Register = 0;
 492                 break;
 493             case DataIsConstant:
 494                 sym_info->Flags |= SYMFLAG_VALUEPRESENT;
 495                 switch (data->u.value.n1.n2.vt)
 496                 {
 497                 case VT_I4:  sym_info->Value = (ULONG)data->u.value.n1.n2.n3.lVal; break;
 498                 case VT_I2:  sym_info->Value = (ULONG)(long)data->u.value.n1.n2.n3.iVal; break;
 499                 case VT_I1:  sym_info->Value = (ULONG)(long)data->u.value.n1.n2.n3.cVal; break;
 500                 case VT_UI4: sym_info->Value = (ULONG)data->u.value.n1.n2.n3.ulVal; break;
 501                 case VT_UI2: sym_info->Value = (ULONG)data->u.value.n1.n2.n3.uiVal; break;
 502                 case VT_UI1: sym_info->Value = (ULONG)data->u.value.n1.n2.n3.bVal; break;
 503                 default:
 504                     FIXME("Unsupported variant type (%u)\n", data->u.value.n1.n2.vt);
 505                 }
 506                 break;
 507             default:
 508                 FIXME("Unhandled kind (%u) in sym data\n", data->kind);
 509             }
 510         }
 511         break;
 512     case SymTagPublicSymbol:
 513         sym_info->Flags |= SYMFLAG_EXPORT;
 514         symt_get_info(sym, TI_GET_ADDRESS, &sym_info->Address);
 515         break;
 516     case SymTagFunction:
 517         sym_info->Flags |= SYMFLAG_FUNCTION;
 518         symt_get_info(sym, TI_GET_ADDRESS, &sym_info->Address);
 519         break;
 520     case SymTagThunk:
 521         sym_info->Flags |= SYMFLAG_THUNK;
 522         symt_get_info(sym, TI_GET_ADDRESS, &sym_info->Address);
 523         break;
 524     default:
 525         symt_get_info(sym, TI_GET_ADDRESS, &sym_info->Address);
 526         sym_info->Register = 0;
 527         break;
 528     }
 529     sym_info->Scope = 0; /* FIXME */
 530     sym_info->Tag = sym->tag;
 531     name = symt_get_name(sym);
 532     sym_info->NameLen = strlen(name) + 1;
 533     if (sym_info->MaxNameLen)
 534     {
 535         strncpy(sym_info->Name, name, min(sym_info->NameLen, sym_info->MaxNameLen));
 536         sym_info->Name[sym_info->MaxNameLen - 1] = '\0';
 537     }
 538     TRACE_(dbghelp_symt)("%p => %s %lu %lx\n",
 539                          sym, sym_info->Name, sym_info->Size, sym_info->Address);
 540 }
 541
 542 static BOOL symt_enum_module(struct module* module, regex_t* regex,
 543                              PSYM_ENUMERATESYMBOLS_CALLBACK cb, PVOID user)
 544 {
 545     char                        buffer[sizeof(SYMBOL_INFO) + 256];
 546     SYMBOL_INFO*                sym_info = (SYMBOL_INFO*)buffer;
 547     void*                       ptr;
 548     struct symt_ht*             sym = NULL;
 549     struct hash_table_iter      hti;
 550
 551     hash_table_iter_init(&module->ht_symbols, &hti, NULL);
 552     while ((ptr = hash_table_iter_up(&hti)))
 553     {
 554         sym = GET_ENTRY(ptr, struct symt_ht, hash_elt);
 555         if (sym->hash_elt.name &&
 556             regexec(regex, sym->hash_elt.name, 0, NULL, 0) == 0)
 557         {
 558             sym_info->SizeOfStruct = sizeof(SYMBOL_INFO);
 559             sym_info->MaxNameLen = sizeof(buffer) - sizeof(SYMBOL_INFO);
 560             symt_fill_sym_info(module, &sym->symt, sym_info);
 561             if (!cb(sym_info, sym_info->Size, user)) return TRUE;
 562         }
 563     }
 564     return FALSE;
 565 }
 566
 567 /***********************************************************************
 568  *              resort_symbols
 569  *
 570  * Rebuild sorted list of symbols for a module.
 571  */
 572 static BOOL resort_symbols(struct module* module)
 573 {
 574     int                         nsym = 0;
 575     void*                       ptr;
 576     struct symt_ht*             sym;
 577     struct hash_table_iter      hti;
 578
 579     hash_table_iter_init(&module->ht_symbols, &hti, NULL);
 580     while ((ptr = hash_table_iter_up(&hti)))
 581         nsym++;
 582
 583     if (!(module->module.NumSyms = nsym)) return FALSE;
 584
 585     if (module->addr_sorttab)
 586         module->addr_sorttab = HeapReAlloc(GetProcessHeap(), 0,
 587                                            module->addr_sorttab,
 588                                            nsym * sizeof(struct symt_ht*));
 589     else
 590         module->addr_sorttab = HeapAlloc(GetProcessHeap(), 0,
 591                                          nsym * sizeof(struct symt_ht*));
 592     if (!module->addr_sorttab) return FALSE;
 593
 594     nsym = 0;
 595     hash_table_iter_init(&module->ht_symbols, &hti, NULL);
 596     while ((ptr = hash_table_iter_up(&hti)))
 597     {
 598         sym = GET_ENTRY(ptr, struct symt_ht, hash_elt);
 599         assert(sym);
 600         module->addr_sorttab[nsym++] = sym;
 601     }
 602
 603     qsort(module->addr_sorttab, nsym, sizeof(struct symt_ht*), symt_cmp_addr);
 604     return module->sortlist_valid = TRUE;
 605 }
 606
 607 /* assume addr is in module */
 608 int symt_find_nearest(struct module* module, DWORD addr)
 609 {
 610     int         mid, high, low;
 611     DWORD       ref_addr, ref_size;
 612
 613     if (!module->sortlist_valid || !module->addr_sorttab)
 614     {
 615         if (!resort_symbols(module)) return -1;
 616     }
 617
 618     /*
 619      * Binary search to find closest symbol.
 620      */
 621     low = 0;
 622     high = module->module.NumSyms;
 623
 624     symt_get_info(&module->addr_sorttab[0]->symt, TI_GET_ADDRESS, &ref_addr);
 625     if (addr < ref_addr) return -1;
 626     if (high)
 627     {
 628         symt_get_info(&module->addr_sorttab[high - 1]->symt, TI_GET_ADDRESS, &ref_addr);
 629         if (!symt_get_info(&module->addr_sorttab[high - 1]->symt,  TI_GET_LENGTH, &ref_size) || !ref_size)
 630             ref_size = 0x1000; /* arbitrary value */
 631         if (addr >= ref_addr + ref_size) return -1;
 632     }
 633
 634     while (high > low + 1)
 635     {
 636         mid = (high + low) / 2;
 637         if (cmp_sorttab_addr(module, mid, addr) < 0)
 638             low = mid;
 639         else
 640             high = mid;
 641     }
 642     if (low != high && high != module->module.NumSyms &&
 643         cmp_sorttab_addr(module, high, addr) <= 0)
 644         low = high;
 645
 646     /* If found symbol is a public symbol, check if there are any other entries that
 647      * might also have the same address, but would get better information
 648      */
 649     if (module->addr_sorttab[low]->symt.tag == SymTagPublicSymbol)
 650     {
 651         symt_get_info(&module->addr_sorttab[low]->symt, TI_GET_ADDRESS, &ref_addr);
 652         if (low > 0 &&
 653             module->addr_sorttab[low - 1]->symt.tag != SymTagPublicSymbol &&
 654             !cmp_sorttab_addr(module, low - 1, ref_addr))
 655             low--;
 656         else if (low < module->module.NumSyms - 1 &&
 657                  module->addr_sorttab[low + 1]->symt.tag != SymTagPublicSymbol &&
 658                  !cmp_sorttab_addr(module, low + 1, ref_addr))
 659             low++;
 660     }
 661     /* finally check that we fit into the found symbol */
 662     symt_get_info(&module->addr_sorttab[low]->symt, TI_GET_ADDRESS, &ref_addr);
 663     if (addr < ref_addr) return -1;
 664     if (!symt_get_info(&module->addr_sorttab[high - 1]->symt, TI_GET_LENGTH, &ref_size) || !ref_size)
 665         ref_size = 0x1000; /* arbitrary value */
 666     if (addr >= ref_addr + ref_size) return -1;
 667
 668     return low;
 669 }
 670
 671 static BOOL symt_enum_locals_helper(struct process* pcs, struct module* module,
 672                                     regex_t* preg, PSYM_ENUMERATESYMBOLS_CALLBACK cb,
 673                                     PVOID user, SYMBOL_INFO* sym_info,
 674                                     struct vector* v)
 675 {
 676     struct symt**       plsym = NULL;
 677     struct symt*        lsym = NULL;
 678     DWORD               pc = pcs->ctx_frame.InstructionOffset;
 679
 680     while ((plsym = vector_iter_up(v, plsym)))
 681     {
 682         lsym = *plsym;
 683         switch (lsym->tag)
 684         {
 685         case SymTagBlock:
 686             {
 687                 struct symt_block*  block = (struct symt_block*)lsym;
 688                 if (pc < block->address || block->address + block->size <= pc)
 689                     continue;
 690                 if (!symt_enum_locals_helper(pcs, module, preg, cb, user,
 691                                              sym_info, &block->vchildren))
 692                     return FALSE;
 693             }
 694             break;
 695         case SymTagData:
 696             if (regexec(preg, symt_get_name(lsym), 0, NULL, 0) == 0)
 697             {
 698                 symt_fill_sym_info(module, lsym, sym_info);
 699                 if (!cb(sym_info, sym_info->Size, user))
 700                     return FALSE;
 701             }
 702             break;
 703         case SymTagLabel:
 704         case SymTagFuncDebugStart:
 705         case SymTagFuncDebugEnd:
 706             break;
 707         default:
 708             FIXME("Unknown type: %u (%x)\n", lsym->tag, lsym->tag);
 709             assert(0);
 710         }
 711     }
 712     return TRUE;
 713 }
 714
 715 static BOOL symt_enum_locals(struct process* pcs, const char* mask,
 716                              PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback,
 717                              PVOID UserContext)
 718 {
 719     struct module*      module;
 720     struct symt_ht*     sym;
 721     char                buffer[sizeof(SYMBOL_INFO) + 256];
 722     SYMBOL_INFO*        sym_info = (SYMBOL_INFO*)buffer;
 723     DWORD               pc = pcs->ctx_frame.InstructionOffset;
 724     int                 idx;
 725
 726     sym_info->SizeOfStruct = sizeof(*sym_info);
 727     sym_info->MaxNameLen = sizeof(buffer) - sizeof(SYMBOL_INFO);
 728
 729     module = module_find_by_addr(pcs, pc, DMT_UNKNOWN);
 730     if (!(module = module_get_debug(pcs, module))) return FALSE;
 731     if ((idx = symt_find_nearest(module, pc)) == -1) return FALSE;
 732
 733     sym = module->addr_sorttab[idx];
 734     if (sym->symt.tag == SymTagFunction)
 735     {
 736         BOOL            ret;
 737         regex_t         preg;
 738
 739         compile_regex(mask ? mask : "*", -1, &preg);
 740         ret = symt_enum_locals_helper(pcs, module, &preg, EnumSymbolsCallback,
 741                                       UserContext, sym_info,
 742                                       &((struct symt_function*)sym)->vchildren);
 743         regfree(&preg);
 744         return ret;
 745
 746     }
 747     symt_fill_sym_info(module, &sym->symt, sym_info);
 748     return EnumSymbolsCallback(sym_info, sym_info->Size, UserContext);
 749 }
 750
 751 /******************************************************************
 752  *              SymEnumSymbols (DBGHELP.@)
 753  *
 754  * cases BaseOfDll = 0
 755  *      !foo fails always (despite what MSDN states)
 756  *      RE1!RE2 looks up all modules matching RE1, and in all these modules, lookup RE2
 757  *      no ! in Mask, lookup in local Context
 758  * cases BaseOfDll != 0
 759  *      !foo fails always (despite what MSDN states)
 760  *      RE1!RE2 gets RE2 from BaseOfDll (whatever RE1 is)
 761  */
 762 BOOL WINAPI SymEnumSymbols(HANDLE hProcess, ULONG BaseOfDll, PCSTR Mask,
 763                            PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback,
 764                            PVOID UserContext)
 765 {
 766     struct process*     pcs = process_find_by_handle(hProcess);
 767     struct module*      module;
 768     struct module*      dbg_module;
 769     const char*         bang;
 770     regex_t             mod_regex, sym_regex;
 771
 772     TRACE("(%p %08lx %s %p %p)\n",
 773           hProcess, BaseOfDll, debugstr_a(Mask), EnumSymbolsCallback, UserContext);
 774
 775     if (!pcs) return FALSE;
 776
 777     if (BaseOfDll == 0)
 778     {
 779         /* do local variables ? */
 780         if (!Mask || !(bang = strchr(Mask, '!')))
 781             return symt_enum_locals(pcs, Mask, EnumSymbolsCallback, UserContext);
 782
 783         if (bang == Mask) return FALSE;
 784
 785         compile_regex(Mask, bang - Mask, &mod_regex);
 786         compile_regex(bang + 1, -1, &sym_regex);
 787
 788         for (module = pcs->lmodules; module; module = module->next)
 789         {
 790             if (module->type == DMT_PE && (dbg_module = module_get_debug(pcs, module)))
 791             {
 792                 if (regexec(&mod_regex, module->module.ModuleName, 0, NULL, 0) == 0 &&
 793                     symt_enum_module(dbg_module, &sym_regex,
 794                                      EnumSymbolsCallback, UserContext))
 795                     break;
 796             }
 797         }
 798         /* not found in PE modules, retry on the ELF ones
 799          */
 800         if (!module && (dbghelp_options & SYMOPT_WINE_WITH_ELF_MODULES))
 801         {
 802             for (module = pcs->lmodules; module; module = module->next)
 803             {
 804                 if (module->type == DMT_ELF &&
 805                     !module_get_containee(pcs, module) &&
 806                     (dbg_module = module_get_debug(pcs, module)))
 807                 {
 808                     if (regexec(&mod_regex, module->module.ModuleName, 0, NULL, 0) == 0 &&
 809                         symt_enum_module(dbg_module, &sym_regex, EnumSymbolsCallback, UserContext))
 810                     break;
 811                 }
 812             }
 813         }
 814         regfree(&mod_regex);
 815         regfree(&sym_regex);
 816         return TRUE;
 817     }
 818     module = module_find_by_addr(pcs, BaseOfDll, DMT_UNKNOWN);
 819     if (!(module = module_get_debug(pcs, module)))
 820         return FALSE;
 821
 822     /* we always ignore module name from Mask when BaseOfDll is defined */
 823     if (Mask && (bang = strchr(Mask, '!')))
 824     {
 825         if (bang == Mask) return FALSE;
 826         Mask = bang + 1;
 827     }
 828
 829     compile_regex(Mask ? Mask : "*", -1, &sym_regex);
 830     symt_enum_module(module, &sym_regex, EnumSymbolsCallback, UserContext);
 831     regfree(&sym_regex);
 832
 833     return TRUE;
 834 }
 835
 836 struct sym_enumerate
 837 {
 838     void*                       ctx;
 839     PSYM_ENUMSYMBOLS_CALLBACK   cb;
 840 };
 841
 842 static BOOL CALLBACK sym_enumerate_cb(PSYMBOL_INFO syminfo, ULONG size, void* ctx)
 843 {
 844     struct sym_enumerate*       se = (struct sym_enumerate*)ctx;
 845     return (se->cb)(syminfo->Name, syminfo->Address, syminfo->Size, se->ctx);
 846 }
 847
 848 /***********************************************************************
 849  *              SymEnumerateSymbols (DBGHELP.@)
 850  */
 851 BOOL WINAPI SymEnumerateSymbols(HANDLE hProcess, DWORD BaseOfDll,
 852                                 PSYM_ENUMSYMBOLS_CALLBACK EnumSymbolsCallback,
 853                                 PVOID UserContext)
 854 {
 855     struct sym_enumerate        se;
 856
 857     se.ctx = UserContext;
 858     se.cb  = EnumSymbolsCallback;
 859
 860     return SymEnumSymbols(hProcess, BaseOfDll, NULL, sym_enumerate_cb, &se);
 861 }
 862
 863 /******************************************************************
 864  *              SymFromAddr (DBGHELP.@)
 865  *
 866  */
 867 BOOL WINAPI SymFromAddr(HANDLE hProcess, DWORD Address,
 868                         DWORD* Displacement, PSYMBOL_INFO Symbol)
 869 {
 870     struct process*     pcs = process_find_by_handle(hProcess);
 871     struct module*      module;
 872     struct symt_ht*     sym;
 873     int                 idx;
 874
 875     if (!pcs) return FALSE;
 876     module = module_find_by_addr(pcs, Address, DMT_UNKNOWN);
 877     if (!(module = module_get_debug(pcs, module))) return FALSE;
 878     if ((idx = symt_find_nearest(module, Address)) == -1) return FALSE;
 879
 880     sym = module->addr_sorttab[idx];
 881
 882     symt_fill_sym_info(module, &sym->symt, Symbol);
 883     if (Displacement) *Displacement = Address - Symbol->Address;
 884     return TRUE;
 885 }
 886
 887 /******************************************************************
 888  *              SymGetSymFromAddr (DBGHELP.@)
 889  *
 890  */
 891 BOOL WINAPI SymGetSymFromAddr(HANDLE hProcess, DWORD Address,
 892                               PDWORD Displacement, PIMAGEHLP_SYMBOL Symbol)
 893 {
 894     char        buffer[sizeof(SYMBOL_INFO) + 256];
 895     SYMBOL_INFO*si = (SYMBOL_INFO*)buffer;
 896     size_t      len;
 897
 898     if (Symbol->SizeOfStruct < sizeof(*Symbol)) return FALSE;
 899     si->SizeOfStruct = sizeof(*si);
 900     si->MaxNameLen = 256;
 901     if (!SymFromAddr(hProcess, Address, Displacement, si))
 902         return FALSE;
 903
 904     Symbol->Address = si->Address;
 905     Symbol->Size    = si->Size;
 906     Symbol->Flags   = si->Flags;
 907     len = min(Symbol->MaxNameLength, si->MaxNameLen);
 908     strncpy(Symbol->Name, si->Name, len);
 909     Symbol->Name[len - 1] = '\0';
 910     return TRUE;
 911 }
 912
 913 /******************************************************************
 914  *              SymFromName (DBGHELP.@)
 915  *
 916  */
 917 BOOL WINAPI SymFromName(HANDLE hProcess, LPSTR Name, PSYMBOL_INFO Symbol)
 918 {
 919     struct process*             pcs = process_find_by_handle(hProcess);
 920     struct module*              module;
 921     struct hash_table_iter      hti;
 922     void*                       ptr;
 923     struct symt_ht*             sym = NULL;
 924     const char*                 name;
 925
 926     TRACE("(%p, %s, %p)\n", hProcess, Name, Symbol);
 927     if (!pcs) return FALSE;
 928     if (Symbol->SizeOfStruct < sizeof(*Symbol)) return FALSE;
 929     name = strchr(Name, '!');
 930     if (name)
 931     {
 932         char    tmp[128];
 933         assert(name - Name < sizeof(tmp));
 934         memcpy(tmp, Name, name - Name);
 935         tmp[name - Name] = '\0';
 936         module = module_find_by_name(pcs, tmp, DMT_UNKNOWN);
 937         if (!module) return FALSE;
 938         Name = (char*)(name + 1);
 939     }
 940     else module = pcs->lmodules;
 941
 942     /* FIXME: Name could be made out of a regular expression */
 943     for (; module; module = (name) ? NULL : module->next)
 944     {
 945         if (module->module.SymType == SymNone) continue;
 946         if (module->module.SymType == SymDeferred)
 947         {
 948             struct module*      xmodule = module_get_debug(pcs, module);
 949             if (!xmodule || xmodule != module) continue;
 950         }
 951         hash_table_iter_init(&module->ht_symbols, &hti, Name);
 952         while ((ptr = hash_table_iter_up(&hti)))
 953         {
 954             sym = GET_ENTRY(ptr, struct symt_ht, hash_elt);
 955
 956             if (!strcmp(sym->hash_elt.name, Name))
 957             {
 958                 symt_fill_sym_info(module, &sym->symt, Symbol);
 959                 return TRUE;
 960             }
 961         }
 962     }
 963     return FALSE;
 964 }
 965
 966 /***********************************************************************
 967  *              SymGetSymFromName (DBGHELP.@)
 968  */
 969 BOOL WINAPI SymGetSymFromName(HANDLE hProcess, LPSTR Name, PIMAGEHLP_SYMBOL Symbol)
 970 {
 971     char        buffer[sizeof(SYMBOL_INFO) + 256];
 972     SYMBOL_INFO*si = (SYMBOL_INFO*)buffer;
 973     size_t      len;
 974
 975     if (Symbol->SizeOfStruct < sizeof(*Symbol)) return FALSE;
 976     si->SizeOfStruct = sizeof(*si);
 977     si->MaxNameLen = 256;
 978     if (!SymFromName(hProcess, Name, si)) return FALSE;
 979
 980     Symbol->Address = si->Address;
 981     Symbol->Size    = si->Size;
 982     Symbol->Flags   = si->Flags;
 983     len = min(Symbol->MaxNameLength, si->MaxNameLen);
 984     strncpy(Symbol->Name, si->Name, len);
 985     Symbol->Name[len - 1] = '\0';
 986     return TRUE;
 987 }
 988
 989 /******************************************************************
 990  *              sym_fill_func_line_info
 991  *
 992  * fills information about a file
 993  */
 994 BOOL symt_fill_func_line_info(struct module* module, struct symt_function* func,
 995                               DWORD addr, IMAGEHLP_LINE* line)
 996 {
 997     struct line_info*   dli = NULL;
 998     BOOL                found = FALSE;
 999
1000     assert(func->symt.tag == SymTagFunction);
1001
1002     while ((dli = vector_iter_down(&func->vlines, dli)))
1003     {
1004         if (!dli->is_source_file)
1005         {
1006             if (found || dli->u.pc_offset > addr) continue;
1007             line->LineNumber = dli->line_number;
1008             line->Address    = dli->u.pc_offset;
1009             line->Key        = dli;
1010             found = TRUE;
1011             continue;
1012         }
1013         if (found)
1014         {
1015             line->FileName = (char*)source_get(module, dli->u.source_file);
1016             return TRUE;
1017         }
1018     }
1019     return FALSE;
1020 }
1021
1022 /***********************************************************************
1023  *              SymGetSymNext (DBGHELP.@)
1024  */
1025 BOOL WINAPI SymGetSymNext(HANDLE hProcess, PIMAGEHLP_SYMBOL Symbol)
1026 {
1027     /* algo:
1028      * get module from Symbol.Address
1029      * get index in module.addr_sorttab of Symbol.Address
1030      * increment index
1031      * if out of module bounds, move to next module in process address space
1032      */
1033     FIXME("(%p, %p): stub\n", hProcess, Symbol);
1034     SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
1035     return FALSE;
1036 }
1037
1038 /***********************************************************************
1039  *              SymGetSymPrev (DBGHELP.@)
1040  */
1041
1042 BOOL WINAPI SymGetSymPrev(HANDLE hProcess, PIMAGEHLP_SYMBOL Symbol)
1043 {
1044     FIXME("(%p, %p): stub\n", hProcess, Symbol);
1045     SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
1046     return FALSE;
1047 }
1048
1049 /******************************************************************
1050  *              SymGetLineFromAddr (DBGHELP.@)
1051  *
1052  */
1053 BOOL WINAPI SymGetLineFromAddr(HANDLE hProcess, DWORD dwAddr,
1054                                PDWORD pdwDisplacement, PIMAGEHLP_LINE Line)
1055 {
1056     struct process*     pcs = process_find_by_handle(hProcess);
1057     struct module*      module;
1058     int                 idx;
1059
1060     TRACE("%p %08lx %p %p\n", hProcess, dwAddr, pdwDisplacement, Line);
1061
1062     if (Line->SizeOfStruct < sizeof(*Line)) return FALSE;
1063
1064     if (!pcs) return FALSE;
1065     module = module_find_by_addr(pcs, dwAddr, DMT_UNKNOWN);
1066     if (!(module = module_get_debug(pcs, module))) return FALSE;
1067     if ((idx = symt_find_nearest(module, dwAddr)) == -1) return FALSE;
1068
1069     if (module->addr_sorttab[idx]->symt.tag != SymTagFunction) return FALSE;
1070     if (!symt_fill_func_line_info(module,
1071                                   (struct symt_function*)module->addr_sorttab[idx],
1072                                   dwAddr, Line)) return FALSE;
1073     if (pdwDisplacement) *pdwDisplacement = dwAddr - Line->Address;
1074     return TRUE;
1075 }
1076
1077 /******************************************************************
1078  *              SymGetLinePrev (DBGHELP.@)
1079  *
1080  */
1081 BOOL WINAPI SymGetLinePrev(HANDLE hProcess, PIMAGEHLP_LINE Line)
1082 {
1083     struct process*     pcs = process_find_by_handle(hProcess);
1084     struct module*      module;
1085     struct line_info*   li;
1086     BOOL                in_search = FALSE;
1087
1088     TRACE("(%p %p)\n", hProcess, Line);
1089
1090     if (Line->SizeOfStruct < sizeof(*Line)) return FALSE;
1091
1092     if (!pcs) return FALSE;
1093     module = module_find_by_addr(pcs, Line->Address, DMT_UNKNOWN);
1094     if (!(module = module_get_debug(pcs, module))) return FALSE;
1095
1096     if (Line->Key == 0) return FALSE;
1097     li = (struct line_info*)Line->Key;
1098     /* things are a bit complicated because when we encounter a DLIT_SOURCEFILE
1099      * element we have to go back until we find the prev one to get the real
1100      * source file name for the DLIT_OFFSET element just before
1101      * the first DLIT_SOURCEFILE
1102      */
1103     while (!li->is_first)
1104     {
1105         li--;
1106         if (!li->is_source_file)
1107         {
1108             Line->LineNumber = li->line_number;
1109             Line->Address    = li->u.pc_offset;
1110             Line->Key        = li;
1111             if (!in_search) return TRUE;
1112         }
1113         else
1114         {
1115             if (in_search)
1116             {
1117                 Line->FileName = (char*)source_get(module, li->u.source_file);
1118                 return TRUE;
1119             }
1120             in_search = TRUE;
1121         }
1122     }
1123     SetLastError(ERROR_NO_MORE_ITEMS); /* FIXME */
1124     return FALSE;
1125 }
1126
1127 BOOL symt_get_func_line_next(struct module* module, PIMAGEHLP_LINE line)
1128 {
1129     struct line_info*   li;
1130
1131     if (line->Key == 0) return FALSE;
1132     li = (struct line_info*)line->Key;
1133     while (!li->is_last)
1134     {
1135         li++;
1136         if (!li->is_source_file)
1137         {
1138             line->LineNumber = li->line_number;
1139             line->Address    = li->u.pc_offset;
1140             line->Key        = li;
1141             return TRUE;
1142         }
1143         line->FileName = (char*)source_get(module, li->u.source_file);
1144     }
1145     return FALSE;
1146 }
1147
1148 /******************************************************************
1149  *              SymGetLineNext (DBGHELP.@)
1150  *
1151  */
1152 BOOL WINAPI SymGetLineNext(HANDLE hProcess, PIMAGEHLP_LINE Line)
1153 {
1154     struct process*     pcs = process_find_by_handle(hProcess);
1155     struct module*      module;
1156
1157     TRACE("(%p %p)\n", hProcess, Line);
1158
1159     if (Line->SizeOfStruct < sizeof(*Line)) return FALSE;
1160     if (!pcs) return FALSE;
1161     module = module_find_by_addr(pcs, Line->Address, DMT_UNKNOWN);
1162     if (!(module = module_get_debug(pcs, module))) return FALSE;
1163
1164     if (symt_get_func_line_next(module, Line)) return TRUE;
1165     SetLastError(ERROR_NO_MORE_ITEMS); /* FIXME */
1166     return FALSE;
1167 }
1168
1169 /***********************************************************************
1170  *              SymFunctionTableAccess (DBGHELP.@)
1171  */
1172 PVOID WINAPI SymFunctionTableAccess(HANDLE hProcess, DWORD AddrBase)
1173 {
1174     FIXME("(%p, 0x%08lx): stub\n", hProcess, AddrBase);
1175     SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
1176     return FALSE;
1177 }
1178
1179 /***********************************************************************
1180  *              SymUnDName (DBGHELP.@)
1181  */
1182 BOOL WINAPI SymUnDName(PIMAGEHLP_SYMBOL sym, LPSTR UnDecName, DWORD UnDecNameLength)
1183 {
1184     FIXME("(%p %s %lu): stub\n", sym, UnDecName, UnDecNameLength);
1185     return UnDecorateSymbolName(sym->Name, UnDecName, UnDecNameLength,
1186                                 UNDNAME_COMPLETE);
1187 }
1188
1189 /***********************************************************************
1190  *              UnDecorateSymbolName (DBGHELP.@)
1191  */
1192 DWORD WINAPI UnDecorateSymbolName(LPCSTR DecoratedName, LPSTR UnDecoratedName,
1193                                   DWORD UndecoratedLength, DWORD Flags)
1194 {
1195     FIXME("(%s, %p, %ld, 0x%08lx): stub\n",
1196           debugstr_a(DecoratedName), UnDecoratedName, UndecoratedLength, Flags);
1197
1198     strncpy(UnDecoratedName, DecoratedName, UndecoratedLength);
1199     UnDecoratedName[UndecoratedLength - 1] = '\0';
1200     return TRUE;
1201 }