dlls/dbghelp/module.c

   1 /*
   2  * File module.c - module handling for the wine debugger
   3  *
   4  * Copyright (C) 1993,      Eric Youngdale.
   5  *               2000-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 #include "config.h"
  23 #include <stdlib.h>
  24 #include <stdio.h>
  25 #include <string.h>
  26 #include <assert.h>
  27
  28 #include "dbghelp_private.h"
  29 #include "psapi.h"
  30 #include "winreg.h"
  31 #include "winternl.h"
  32 #include "wine/debug.h"
  33
  34 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp);
  35
  36 static void module_fill_module(const char* in, char* out, unsigned size)
  37 {
  38     const char*         ptr;
  39     unsigned            len;
  40
  41     for (ptr = in + strlen(in) - 1;
  42          *ptr != '/' && *ptr != '\\' && ptr >= in;
  43          ptr--);
  44     if (ptr < in || *ptr == '/' || *ptr == '\\') ptr++;
  45     strncpy(out, ptr, size);
  46     out[size - 1] = '\0';
  47     len = strlen(out);
  48     if (len > 4 &&
  49         (!strcasecmp(&out[len - 4], ".dll") || !strcasecmp(&out[len - 4], ".exe")))
  50         out[len - 4] = '\0';
  51     else
  52     {
  53         if (len > 7 &&
  54             (!strcasecmp(&out[len - 7], ".dll.so") || !strcasecmp(&out[len - 7], ".exe.so")))
  55             strcpy(&out[len - 7], "<elf>");
  56         else if (len > 7 &&
  57                  out[len - 7] == '.' && !strcasecmp(&out[len - 3], ".so"))
  58         {
  59             if (len + 3 < size) strcpy(&out[len - 3], "<elf>");
  60             else WARN("Buffer too short: %s\n", out);
  61         }
  62     }
  63     while ((*out = tolower(*out))) out++;
  64 }
  65
  66 /***********************************************************************
  67  * Creates and links a new module to a process
  68  */
  69 struct module* module_new(struct process* pcs, const char* name,
  70                           enum module_type type,
  71                           unsigned long mod_addr, unsigned long size,
  72                           unsigned long stamp, unsigned long checksum)
  73 {
  74     struct module*      module;
  75
  76     if (!(module = HeapAlloc(GetProcessHeap(), 0, sizeof(*module))))
  77         return NULL;
  78
  79     memset(module, 0, sizeof(*module));
  80
  81     module->next = pcs->lmodules;
  82     pcs->lmodules = module;
  83
  84     TRACE("=> %s %08lx-%08lx %s\n",
  85           type == DMT_ELF ? "ELF" : (type == DMT_PE ? "PE" : "---"),
  86           mod_addr, mod_addr + size, name);
  87
  88     pool_init(&module->pool, 65536);
  89
  90     module->module.SizeOfStruct = sizeof(module->module);
  91     module->module.BaseOfImage = mod_addr;
  92     module->module.ImageSize = size;
  93     module_fill_module(name, module->module.ModuleName, sizeof(module->module.ModuleName));
  94     module->module.ImageName[0] = '\0';
  95     strncpy(module->module.LoadedImageName, name,
  96             sizeof(module->module.LoadedImageName));
  97     module->module.LoadedImageName[sizeof(module->module.LoadedImageName) - 1] = '\0';
  98     module->module.SymType = SymNone;
  99     module->module.NumSyms = 0;
 100     module->module.TimeDateStamp = stamp;
 101     module->module.CheckSum = checksum;
 102
 103     module->type              = type;
 104     module->sortlist_valid    = FALSE;
 105     module->addr_sorttab      = NULL;
 106     /* FIXME: this seems a bit too high (on a per module basis)
 107      * need some statistics about this
 108      */
 109     hash_table_init(&module->pool, &module->ht_symbols, 4096);
 110     hash_table_init(&module->pool, &module->ht_types,   4096);
 111     vector_init(&module->vtypes, sizeof(struct symt*),  32);
 112
 113     module->sources_used      = 0;
 114     module->sources_alloc     = 0;
 115     module->sources           = 0;
 116
 117     return module;
 118 }
 119
 120 /***********************************************************************
 121  *      module_find_by_name
 122  *
 123  */
 124 struct module* module_find_by_name(const struct process* pcs,
 125                                    const char* name, enum module_type type)
 126 {
 127     struct module*      module;
 128
 129     if (type == DMT_UNKNOWN)
 130     {
 131         if ((module = module_find_by_name(pcs, name, DMT_PE)) ||
 132             (module = module_find_by_name(pcs, name, DMT_ELF)))
 133             return module;
 134     }
 135     else
 136     {
 137         for (module = pcs->lmodules; module; module = module->next)
 138         {
 139             if (type == module->type && !strcasecmp(name, module->module.LoadedImageName))
 140                 return module;
 141         }
 142         for (module = pcs->lmodules; module; module = module->next)
 143         {
 144             if (type == module->type && !strcasecmp(name, module->module.ModuleName))
 145                 return module;
 146         }
 147     }
 148     SetLastError(ERROR_INVALID_NAME);
 149     return NULL;
 150 }
 151
 152 /***********************************************************************
 153  *           module_get_container
 154  *
 155  */
 156 struct module* module_get_container(const struct process* pcs,
 157                                     const struct module* inner)
 158 {
 159     struct module*      module;
 160
 161     for (module = pcs->lmodules; module; module = module->next)
 162     {
 163         if (module != inner &&
 164             module->module.BaseOfImage <= inner->module.BaseOfImage &&
 165             module->module.BaseOfImage + module->module.ImageSize >=
 166             inner->module.BaseOfImage + inner->module.ImageSize)
 167             return module;
 168     }
 169     return NULL;
 170 }
 171
 172 /***********************************************************************
 173  *           module_get_containee
 174  *
 175  */
 176 struct module* module_get_containee(const struct process* pcs,
 177                                     const struct module* outter)
 178 {
 179     struct module*      module;
 180
 181     for (module = pcs->lmodules; module; module = module->next)
 182     {
 183         if (module != outter &&
 184             outter->module.BaseOfImage <= module->module.BaseOfImage &&
 185             outter->module.BaseOfImage + outter->module.ImageSize >=
 186             module->module.BaseOfImage + module->module.ImageSize)
 187             return module;
 188     }
 189     return NULL;
 190 }
 191
 192 /******************************************************************
 193  *              module_get_debug
 194  *
 195  * get the debug information from a module:
 196  * - if the module's type is deferred, then force loading of debug info (and return
 197  *   the module itself)
 198  * - if the module has no debug info and has an ELF container, then return the ELF
 199  *   container (and also force the ELF container's debug info loading if deferred)
 200  * - otherwise return the module itself if it has some debug info
 201  */
 202 struct module* module_get_debug(const struct process* pcs, struct module* module)
 203 {
 204     struct module*      parent;
 205
 206     if (!module) return NULL;
 207     /* for a PE builtin, always get info from parent */
 208     if ((parent = module_get_container(pcs, module)))
 209         module = parent;
 210     /* if deferred, force loading */
 211     if (module->module.SymType == SymDeferred)
 212     {
 213         BOOL ret;
 214
 215         switch (module->type)
 216         {
 217         case DMT_ELF: ret = elf_load_debug_info(module);     break;
 218         case DMT_PE:  ret = pe_load_debug_info(pcs, module); break;
 219         default:      ret = FALSE;                           break;
 220         }
 221         if (!ret) module->module.SymType = SymNone;
 222         assert(module->module.SymType != SymDeferred);
 223     }
 224     return (module && module->module.SymType != SymNone) ? module : NULL;
 225 }
 226
 227 /***********************************************************************
 228  *      module_find_by_addr
 229  *
 230  * either the addr where module is loaded, or any address inside the
 231  * module
 232  */
 233 struct module* module_find_by_addr(const struct process* pcs, unsigned long addr,
 234                                    enum module_type type)
 235 {
 236     struct module*      module;
 237
 238     if (type == DMT_UNKNOWN)
 239     {
 240         if ((module = module_find_by_addr(pcs, addr, DMT_PE)) ||
 241             (module = module_find_by_addr(pcs, addr, DMT_ELF)))
 242             return module;
 243     }
 244     else
 245     {
 246         for (module = pcs->lmodules; module; module = module->next)
 247         {
 248             if (type == module->type && addr >= module->module.BaseOfImage &&
 249                 addr < module->module.BaseOfImage + module->module.ImageSize)
 250                 return module;
 251         }
 252     }
 253     SetLastError(ERROR_INVALID_ADDRESS);
 254     return module;
 255 }
 256
 257 static BOOL module_is_elf_container_loaded(struct process* pcs, const char* ImageName,
 258                                            const char* ModuleName)
 259 {
 260     char                buffer[MAX_PATH];
 261     size_t              len;
 262     struct module*      module;
 263
 264     if (!ModuleName)
 265     {
 266         module_fill_module(ImageName, buffer, sizeof(buffer));
 267         ModuleName = buffer;
 268     }
 269     len = strlen(ModuleName);
 270     for (module = pcs->lmodules; module; module = module->next)
 271     {
 272         if (!strncasecmp(module->module.ModuleName, ModuleName, len) &&
 273             module->type == DMT_ELF &&
 274             !strcmp(module->module.ModuleName + len, "<elf>"))
 275             return TRUE;
 276     }
 277     return FALSE;
 278 }
 279
 280 /***********************************************************************
 281  *                      SymLoadModule (DBGHELP.@)
 282  */
 283 DWORD WINAPI SymLoadModule(HANDLE hProcess, HANDLE hFile, char* ImageName,
 284                            char* ModuleName, DWORD BaseOfDll, DWORD SizeOfDll)
 285 {
 286     struct process*     pcs;
 287     struct module*      module = NULL;
 288
 289     TRACE("(%p %p %s %s %08lx %08lx)\n",
 290           hProcess, hFile, debugstr_a(ImageName), debugstr_a(ModuleName),
 291           BaseOfDll, SizeOfDll);
 292
 293     pcs = process_find_by_handle(hProcess);
 294     if (!pcs) return FALSE;
 295
 296     /* force transparent ELF loading / unloading */
 297     elf_synchronize_module_list(pcs);
 298
 299     /* this is a Wine extension to the API just to redo the synchronisation */
 300     if (!ImageName && !hFile) return 0;
 301
 302     if (module_is_elf_container_loaded(pcs, ImageName, ModuleName))
 303     {
 304         /* force the loading of DLL as builtin */
 305         if ((module = pe_load_module_from_pcs(pcs, ImageName, ModuleName, BaseOfDll, SizeOfDll)))
 306             goto done;
 307         WARN("Couldn't locate %s\n", ImageName);
 308         return 0;
 309     }
 310     TRACE("Assuming %s as native DLL\n", ImageName);
 311     if (!(module = pe_load_module(pcs, ImageName, hFile, BaseOfDll, SizeOfDll)))
 312     {
 313         unsigned        len = strlen(ImageName);
 314
 315         if (!strcmp(ImageName + len - 3, ".so") &&
 316             (module = elf_load_module(pcs, ImageName))) goto done;
 317         FIXME("should have successfully loaded some debug information for image %s\n", ImageName);
 318         if ((module = pe_load_module_from_pcs(pcs, ImageName, ModuleName, BaseOfDll, SizeOfDll)))
 319             goto done;
 320         WARN("Couldn't locate %s\n", ImageName);
 321         return 0;
 322     }
 323
 324 done:
 325     /* by default pe_load_module fills module.ModuleName from a derivation
 326      * of ImageName. Overwrite it, if we have better information
 327      */
 328     if (ModuleName)
 329     {
 330         strncpy(module->module.ModuleName, ModuleName,
 331                 sizeof(module->module.ModuleName));
 332         module->module.ModuleName[sizeof(module->module.ModuleName) - 1] = '\0';
 333     }
 334     strncpy(module->module.ImageName, ImageName, sizeof(module->module.ImageName));
 335     module->module.ImageName[sizeof(module->module.ImageName) - 1] = '\0';
 336
 337     return module->module.BaseOfImage;
 338 }
 339
 340 /******************************************************************
 341  *              module_remove
 342  *
 343  */
 344 BOOL module_remove(struct process* pcs, struct module* module)
 345 {
 346     struct module**     p;
 347
 348     TRACE("%s (%p)\n", module->module.ModuleName, module);
 349     hash_table_destroy(&module->ht_symbols);
 350     hash_table_destroy(&module->ht_types);
 351     HeapFree(GetProcessHeap(), 0, (char*)module->sources);
 352     HeapFree(GetProcessHeap(), 0, module->addr_sorttab);
 353     pool_destroy(&module->pool);
 354
 355     for (p = &pcs->lmodules; *p; p = &(*p)->next)
 356     {
 357         if (*p == module)
 358         {
 359             *p = module->next;
 360             HeapFree(GetProcessHeap(), 0, module);
 361             return TRUE;
 362         }
 363     }
 364     FIXME("This shouldn't happen\n");
 365     return FALSE;
 366 }
 367
 368 /******************************************************************
 369  *              SymUnloadModule (DBGHELP.@)
 370  *
 371  */
 372 BOOL WINAPI SymUnloadModule(HANDLE hProcess, DWORD BaseOfDll)
 373 {
 374     struct process*     pcs;
 375     struct module*      module;
 376
 377     pcs = process_find_by_handle(hProcess);
 378     if (!pcs) return FALSE;
 379     module = module_find_by_addr(pcs, BaseOfDll, DMT_UNKNOWN);
 380     if (!module) return FALSE;
 381     return module_remove(pcs, module);
 382 }
 383
 384 /******************************************************************
 385  *              SymEnumerateModules (DBGHELP.@)
 386  *
 387  */
 388 BOOL  WINAPI SymEnumerateModules(HANDLE hProcess,
 389                                  PSYM_ENUMMODULES_CALLBACK EnumModulesCallback,
 390                                  PVOID UserContext)
 391 {
 392     struct process*     pcs = process_find_by_handle(hProcess);
 393     struct module*      module;
 394
 395     if (!pcs) return FALSE;
 396
 397     for (module = pcs->lmodules; module; module = module->next)
 398     {
 399         if (!(dbghelp_options & SYMOPT_WINE_WITH_ELF_MODULES) && module->type != DMT_PE)
 400             continue;
 401         if (!EnumModulesCallback(module->module.ModuleName,
 402                                  module->module.BaseOfImage, UserContext))
 403             break;
 404     }
 405     return TRUE;
 406 }
 407
 408 /******************************************************************
 409  *              EnumerateLoadedModules (DBGHELP.@)
 410  *
 411  */
 412 BOOL  WINAPI EnumerateLoadedModules(HANDLE hProcess,
 413                                     PENUMLOADED_MODULES_CALLBACK EnumLoadedModulesCallback,
 414                                     PVOID UserContext)
 415 {
 416     HMODULE*    hMods;
 417     char        base[256], mod[256];
 418     DWORD       i, sz;
 419     MODULEINFO  mi;
 420
 421     hMods = HeapAlloc(GetProcessHeap(), 0, sz);
 422     if (!hMods) return FALSE;
 423
 424     if (!EnumProcessModules(hProcess, hMods, 256 * sizeof(hMods[0]), &sz))
 425     {
 426         /* hProcess should also be a valid process handle !! */
 427         FIXME("If this happens, bump the number in mod\n");
 428         HeapFree(GetProcessHeap(), 0, hMods);
 429         return FALSE;
 430     }
 431     sz /= sizeof(HMODULE);
 432     for (i = 0; i < sz; i++)
 433     {
 434         if (!GetModuleInformation(hProcess, hMods[i], &mi, sizeof(mi)) ||
 435             !GetModuleBaseNameA(hProcess, hMods[i], base, sizeof(base)))
 436             continue;
 437         module_fill_module(base, mod, sizeof(mod));
 438
 439         EnumLoadedModulesCallback(mod, (DWORD)mi.lpBaseOfDll, mi.SizeOfImage,
 440                                   UserContext);
 441     }
 442     HeapFree(GetProcessHeap(), 0, hMods);
 443
 444     return sz != 0 && i == sz;
 445 }
 446
 447 /******************************************************************
 448  *              SymGetModuleInfo (DBGHELP.@)
 449  *
 450  */
 451 BOOL  WINAPI SymGetModuleInfo(HANDLE hProcess, DWORD dwAddr,
 452                               PIMAGEHLP_MODULE ModuleInfo)
 453 {
 454     struct process*     pcs = process_find_by_handle(hProcess);
 455     struct module*      module;
 456
 457     if (!pcs) return FALSE;
 458     if (ModuleInfo->SizeOfStruct < sizeof(*ModuleInfo)) return FALSE;
 459     module = module_find_by_addr(pcs, dwAddr, DMT_UNKNOWN);
 460     if (!module) return FALSE;
 461
 462     *ModuleInfo = module->module;
 463     if (module->module.SymType == SymNone)
 464     {
 465         module = module_get_container(pcs, module);
 466         if (module && module->module.SymType != SymNone)
 467             ModuleInfo->SymType = module->module.SymType;
 468     }
 469
 470     return TRUE;
 471 }
 472
 473 /***********************************************************************
 474  *              SymGetModuleBase (IMAGEHLP.@)
 475  */
 476 DWORD WINAPI SymGetModuleBase(HANDLE hProcess, DWORD dwAddr)
 477 {
 478     struct process*     pcs = process_find_by_handle(hProcess);
 479     struct module*      module;
 480
 481     if (!pcs) return 0;
 482     module = module_find_by_addr(pcs, dwAddr, DMT_UNKNOWN);
 483     if (!module) return 0;
 484     return module->module.BaseOfImage;
 485 }
 486
 487 /******************************************************************
 488  *              module_reset_debug_info
 489  * Removes any debug information linked to a given module.
 490  */
 491 void module_reset_debug_info(struct module* module)
 492 {
 493     module->sortlist_valid = TRUE;
 494     module->addr_sorttab = NULL;
 495     hash_table_destroy(&module->ht_symbols);
 496     module->ht_symbols.num_buckets = 0;
 497     module->ht_symbols.buckets = NULL;
 498     hash_table_destroy(&module->ht_types);
 499     module->ht_types.num_buckets = 0;
 500     module->ht_types.buckets = NULL;
 501     module->vtypes.num_elts = 0;
 502     hash_table_destroy(&module->ht_symbols);
 503     module->sources_used = module->sources_alloc = 0;
 504     module->sources = NULL;
 505 }