dlls/dbghelp/pe_module.c

   1 /*
   2  * File pe_module.c - handle PE module information
   3  *
   4  * Copyright (C) 1996,      Eric Youngdale.
   5  * Copyright (C) 1999-2000, Ulrich Weigand.
   6  * Copyright (C) 2004,      Eric Pouech.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "config.h"
  25 #include <stdlib.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <assert.h>
  29
  30 #include "dbghelp_private.h"
  31 #include "winreg.h"
  32 #include "winternl.h"
  33 #include "wine/debug.h"
  34
  35 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp);
  36
  37 /******************************************************************
  38  *              pe_load_stabs
  39  *
  40  * look for stabs information in PE header (it's how the mingw compiler provides
  41  * its debugging information)
  42  */
  43 static SYM_TYPE pe_load_stabs(const struct process* pcs, struct module* module,
  44                               const void* mapping, IMAGE_NT_HEADERS* nth)
  45 {
  46     IMAGE_SECTION_HEADER*       section;
  47     int                         i, stabsize = 0, stabstrsize = 0;
  48     unsigned int                stabs = 0, stabstr = 0;
  49     SYM_TYPE                    sym_type = SymNone;
  50
  51     section = (IMAGE_SECTION_HEADER*)
  52         ((char*)&nth->OptionalHeader + nth->FileHeader.SizeOfOptionalHeader);
  53     for (i = 0; i < nth->FileHeader.NumberOfSections; i++, section++)
  54     {
  55         if (!strcasecmp(section->Name, ".stab"))
  56         {
  57             stabs = section->VirtualAddress;
  58             stabsize = section->SizeOfRawData;
  59         }
  60         else if (!strncasecmp(section->Name, ".stabstr", 8))
  61         {
  62             stabstr = section->VirtualAddress;
  63             stabstrsize = section->SizeOfRawData;
  64         }
  65     }
  66
  67     if (stabstrsize && stabsize)
  68     {
  69         sym_type = stabs_parse(module, mapping, module->module.BaseOfImage,
  70                                stabs, stabsize, stabstr, stabstrsize);
  71     }
  72     return sym_type;
  73 }
  74
  75 /******************************************************************
  76  *              pe_load_dbg_file
  77  *
  78  * loads a .dbg file
  79  */
  80 static SYM_TYPE pe_load_dbg_file(const struct process* pcs, struct module* module,
  81                                  const char* dbg_name, DWORD timestamp)
  82 {
  83     char                                tmp[MAX_PATH];
  84     HANDLE                              hFile, hMap = 0;
  85     const BYTE*                         dbg_mapping = NULL;
  86     const IMAGE_SEPARATE_DEBUG_HEADER*  hdr;
  87     const IMAGE_DEBUG_DIRECTORY*        dbg;
  88     SYM_TYPE                            sym_type = -1;
  89
  90     WINE_TRACE("Processing DBG file %s\n", dbg_name);
  91
  92     if ((hFile = FindDebugInfoFile((char*)dbg_name, pcs->search_path, tmp)) != NULL &&
  93         ((hMap = CreateFileMappingA(hFile, NULL, PAGE_READONLY, 0, 0, NULL)) != 0) &&
  94         ((dbg_mapping = MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, 0)) != NULL))
  95     {
  96         hdr = (const IMAGE_SEPARATE_DEBUG_HEADER*)dbg_mapping;
  97         if (hdr->TimeDateStamp != timestamp)
  98         {
  99             WINE_ERR("Warning - %s has incorrect internal timestamp\n",
 100                      dbg_name);
 101             /*
 102              * Well, sometimes this happens to DBG files which ARE REALLY the
 103              * right .DBG files but nonetheless this check fails. Anyway,
 104              * WINDBG (debugger for Windows by Microsoft) loads debug symbols
 105              * which have incorrect timestamps.
 106              */
 107         }
 108         dbg = (const IMAGE_DEBUG_DIRECTORY*)
 109             (dbg_mapping + sizeof(*hdr) +
 110              hdr->NumberOfSections * sizeof(IMAGE_SECTION_HEADER) +
 111              hdr->ExportedNamesSize);
 112
 113         sym_type = pe_load_debug_directory(pcs, module, dbg_mapping, dbg,
 114                                            hdr->DebugDirectorySize / sizeof(*dbg));
 115     }
 116     else
 117     {
 118         WINE_ERR("-Unable to peruse .DBG file %s (%s)\n",
 119                  dbg_name, debugstr_a(tmp));
 120     }
 121     if (dbg_mapping) UnmapViewOfFile((void*)dbg_mapping);
 122     if (hMap) CloseHandle(hMap);
 123     if (hFile != NULL) CloseHandle(hFile);
 124     return sym_type;
 125 }
 126
 127 /******************************************************************
 128  *              pe_load_msc_debug_info
 129  *
 130  * Process MSC debug information in PE file.
 131  */
 132 static SYM_TYPE pe_load_msc_debug_info(const struct process* pcs,
 133                                        struct module* module,
 134                                        const void* mapping, IMAGE_NT_HEADERS* nth)
 135 {
 136     SYM_TYPE                    sym_type = -1;
 137     const IMAGE_DATA_DIRECTORY* dir;
 138     const IMAGE_DEBUG_DIRECTORY*dbg = NULL;
 139     int                         nDbg;
 140
 141     /* Read in debug directory */
 142     dir = nth->OptionalHeader.DataDirectory + IMAGE_DIRECTORY_ENTRY_DEBUG;
 143     nDbg = dir->Size / sizeof(IMAGE_DEBUG_DIRECTORY);
 144     if (!nDbg) return sym_type;
 145
 146     dbg = (const IMAGE_DEBUG_DIRECTORY*)((const char*)mapping + dir->VirtualAddress);
 147
 148     /* Parse debug directory */
 149     if (nth->FileHeader.Characteristics & IMAGE_FILE_DEBUG_STRIPPED)
 150     {
 151         /* Debug info is stripped to .DBG file */
 152         const IMAGE_DEBUG_MISC* misc = (const IMAGE_DEBUG_MISC*)
 153             ((const char*)mapping + dbg->PointerToRawData);
 154
 155         if (nDbg != 1 || dbg->Type != IMAGE_DEBUG_TYPE_MISC ||
 156             misc->DataType != IMAGE_DEBUG_MISC_EXENAME)
 157         {
 158             WINE_ERR("-Debug info stripped, but no .DBG file in module %s\n",
 159                      module->module.ModuleName);
 160         }
 161         else
 162         {
 163             sym_type = pe_load_dbg_file(pcs, module, misc->Data, nth->FileHeader.TimeDateStamp);
 164         }
 165     }
 166     else
 167     {
 168         /* Debug info is embedded into PE module */
 169         sym_type = pe_load_debug_directory(pcs, module, mapping, dbg, nDbg);
 170     }
 171
 172     return sym_type;
 173 }
 174
 175 /***********************************************************************
 176  *                      pe_load_export_debug_info
 177  */
 178 static SYM_TYPE pe_load_export_debug_info(const struct process* pcs,
 179                                           struct module* module,
 180                                           const void* mapping, IMAGE_NT_HEADERS* nth)
 181 {
 182     unsigned int                i;
 183     IMAGE_DATA_DIRECTORY*       dir;
 184     DWORD                       base = module->module.BaseOfImage;
 185     ADDRESS                     addr;
 186
 187     addr.Mode = AddrModeFlat;
 188     addr.Segment = 0;
 189
 190 #if 0
 191     /* Add start of DLL (better use the (yet unimplemented) Exe SymTag for this) */
 192     /* FIXME: module.ModuleName isn't correctly set yet if it's passed in SymLoadModule */
 193     symt_new_public(module, NULL, module->module.ModuleName, base, 0,
 194                     TRUE /* FIXME */, TRUE /* FIXME */);
 195 #endif
 196
 197     /* Add entry point */
 198     symt_new_public(module, NULL, "EntryPoint",
 199                     base + nth->OptionalHeader.AddressOfEntryPoint, 0,
 200                     TRUE /* FIXME */, TRUE /* FIXME */);
 201
 202 #if 0
 203     /* FIXME: we'd better store addresses linked to sections rather than
 204        absolute values */
 205     IMAGE_SECTION_HEADER*       section;
 206     /* Add start of sections */
 207     section = (IMAGE_SECTION_HEADER*)
 208         ((char*)&nth->OptionalHeader + nth->FileHeader.SizeOfOptionalHeader);
 209     for (i = 0; i < nth->FileHeader.NumberOfSections; i++, section++)
 210     {
 211         symt_new_public(module, NULL, section->Name, base + section->VirtualAddress, 0,
 212                         TRUE /* FIXME */, TRUE /* FIXME */);
 213     }
 214 #endif
 215
 216     /* Add exported functions */
 217     if ((dir = RtlImageDirectoryEntryToData((void*)mapping, TRUE,
 218                                             IMAGE_DIRECTORY_ENTRY_EXPORT, NULL)))
 219     {
 220         const IMAGE_EXPORT_DIRECTORY*   exports;
 221         const WORD*                     ordinals = NULL;
 222         const void* const*              functions = NULL;
 223         const DWORD*                    names = NULL;
 224         unsigned int                    j;
 225         char                            buffer[16];
 226
 227         exports   = (const void*)((const char*)mapping + dir->VirtualAddress);
 228         functions = (const void*)((const char*)mapping + exports->AddressOfFunctions);
 229         ordinals  = (const void*)((const char*)mapping + exports->AddressOfNameOrdinals);
 230         names     = (const void*)((const char*)mapping + exports->AddressOfNames);
 231
 232         for (i = 0; i < exports->NumberOfNames; i++)
 233         {
 234             if (!names[i]) continue;
 235             symt_new_public(module, NULL, (const char*)base + names[i],
 236                             base + (DWORD)functions[ordinals[i]], 0,
 237                             TRUE /* FIXME */, TRUE /* FIXME */);
 238         }
 239
 240         for (i = 0; i < exports->NumberOfFunctions; i++)
 241         {
 242             if (!functions[i]) continue;
 243             /* Check if we already added it with a name */
 244             for (j = 0; j < exports->NumberOfNames; j++)
 245                 if ((ordinals[j] == i) && names[j]) break;
 246             if (j < exports->NumberOfNames) continue;
 247             snprintf(buffer, sizeof(buffer), "%ld", i + exports->Base);
 248             symt_new_public(module, NULL, buffer, base + (DWORD)functions[i], 0,
 249                             TRUE /* FIXME */, TRUE /* FIXME */);
 250         }
 251     }
 252     /* no real debug info, only entry points */
 253     return module->module.SymType = SymExport;
 254 }
 255
 256 /******************************************************************
 257  *              pe_load_debug_info
 258  *
 259  */
 260 SYM_TYPE pe_load_debug_info(const struct process* pcs, struct module* module)
 261 {
 262     SYM_TYPE            sym_type = -1;
 263     HANDLE              hFile;
 264     HANDLE              hMap;
 265     void*               mapping;
 266     IMAGE_NT_HEADERS*   nth;
 267
 268     hFile = CreateFileA(module->module.LoadedImageName, GENERIC_READ, FILE_SHARE_READ,
 269                         NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
 270     if (hFile == INVALID_HANDLE_VALUE) return -1;
 271     if ((hMap = CreateFileMappingA(hFile, NULL, PAGE_READONLY, 0, 0, NULL)) != 0)
 272     {
 273         if ((mapping = MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, 0)) != NULL)
 274         {
 275             nth = RtlImageNtHeader(mapping);
 276
 277             if (!(dbghelp_options & SYMOPT_PUBLICS_ONLY))
 278             {
 279                 sym_type = pe_load_stabs(pcs, module, mapping, nth);
 280                 if (sym_type <= SymNone)
 281                     sym_type = pe_load_msc_debug_info(pcs, module, mapping, nth);
 282                 /* if we still have no debug info (we could only get SymExport at this
 283                  * point), then do the SymExport except if we have an ELF container,
 284                  * in which case we'll rely on the export's on the ELF side
 285                  */
 286             }
 287             if (sym_type <= SymNone && !module_get_debug(pcs, module))
 288                 sym_type = pe_load_export_debug_info(pcs, module, mapping, nth);
 289             UnmapViewOfFile(mapping);
 290         }
 291         CloseHandle(hMap);
 292     }
 293     CloseHandle(hFile);
 294
 295     module->module.SymType = (sym_type >= SymNone) ? sym_type : SymNone;
 296     return sym_type;
 297 }
 298
 299 /******************************************************************
 300  *              pe_load_module
 301  *
 302  */
 303 struct module* pe_load_module(struct process* pcs, char* name,
 304                               HANDLE hFile, DWORD base, DWORD size)
 305 {
 306     struct module*      module = NULL;
 307     BOOL                opened = FALSE;
 308     HANDLE              hMap;
 309     void*               mapping;
 310     char                loaded_name[MAX_PATH];
 311
 312     loaded_name[0] = '\0';
 313     if (!hFile)
 314     {
 315         if (!name)
 316         {
 317             /* FIXME SetLastError */
 318             return NULL;
 319         }
 320         if ((hFile = FindExecutableImage(name, NULL, loaded_name)) == NULL)
 321             return NULL;
 322         opened = TRUE;
 323     }
 324     else if (name) strcpy(loaded_name, name);
 325     else if (dbghelp_options & SYMOPT_DEFERRED_LOADS)
 326         FIXME("Trouble ahead (no module name passed in deferred mode)\n");
 327     if ((hMap = CreateFileMappingA(hFile, NULL, PAGE_READONLY, 0, 0, NULL)) != 0)
 328     {
 329         if ((mapping = MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, 0)) != NULL)
 330         {
 331             IMAGE_NT_HEADERS*   nth = RtlImageNtHeader(mapping);
 332
 333             if (nth)
 334             {
 335                 if (!base) base = nth->OptionalHeader.ImageBase;
 336                 if (!size) size = nth->OptionalHeader.SizeOfImage;
 337
 338                 module = module_new(pcs, loaded_name, DMT_PE, base, size,
 339                                     nth->FileHeader.TimeDateStamp,
 340                                     nth->OptionalHeader.CheckSum);
 341                 if (module)
 342                 {
 343                     module->module.SymType = (dbghelp_options & SYMOPT_DEFERRED_LOADS) ?
 344                         SymDeferred : pe_load_debug_info(pcs, module);
 345                 }
 346             }
 347             UnmapViewOfFile(mapping);
 348         }
 349         CloseHandle(hMap);
 350     }
 351     if (opened) CloseHandle(hFile);
 352
 353     return module;
 354 }
 355
 356 /******************************************************************
 357  *              pe_load_module_from_pcs
 358  *
 359  */
 360 struct module* pe_load_module_from_pcs(struct process* pcs, const char* name,
 361                                        const char* mod_name, DWORD base, DWORD size)
 362 {
 363     struct module*      module;
 364     const char*         ptr;
 365
 366     if ((module = module_find_by_name(pcs, name, DMT_PE))) return module;
 367     if (mod_name) ptr = mod_name;
 368     else
 369     {
 370         for (ptr = name + strlen(name) - 1; ptr >= name; ptr--)
 371         {
 372             if (*ptr == '/' || *ptr == '\\')
 373             {
 374                 ptr++;
 375                 break;
 376             }
 377         }
 378     }
 379     if (ptr && (module = module_find_by_name(pcs, ptr, DMT_PE))) return module;
 380     if (base && pcs->dbg_hdr_addr)
 381     {
 382         IMAGE_DOS_HEADER    dos;
 383         IMAGE_NT_HEADERS    nth;
 384
 385         if (read_mem(pcs->handle, base, &dos, sizeof(dos)) &&
 386             dos.e_magic == IMAGE_DOS_SIGNATURE &&
 387             read_mem(pcs->handle, base + dos.e_lfanew, &nth, sizeof(nth)) &&
 388             nth.Signature == IMAGE_NT_SIGNATURE)
 389         {
 390             if (!size) size = nth.OptionalHeader.SizeOfImage;
 391             module = module_new(pcs, name, DMT_PE, base, size,
 392                                 nth.FileHeader.TimeDateStamp, nth.OptionalHeader.CheckSum);
 393         }
 394     }
 395     return module;
 396 }