git.oblomov.eu Git - wine/blob - dlls/dbghelp/dbghelp.c

   1 /*
   2  * File dbghelp.c - generic routines (process) for dbghelp DLL
   3  *
   4  * Copyright (C) 2004, Eric Pouech
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include "config.h"
  22
  23 #include "dbghelp_private.h"
  24 #include "winerror.h"
  25 #include "psapi.h"
  26 #include "wine/debug.h"
  27
  28 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp);
  29
  30 /* TODO
  31  *  - support for symbols' types is still partly missing
  32  *      + C++ support
  33  *      + funcargtype:s are (partly) wrong: they should be a specific struct (like
  34  *        typedef) pointing to the actual type (and not a direct access)
  35  *      + we should store the underlying type for an enum in the symt_enum struct
  36  *      + for enums, we store the names & values (associated to the enum type),
  37  *        but those values are not directly usable from a debugger (that's why, I
  38  *        assume, that we have also to define constants for enum values, as
  39  *        Codeview does BTW.
  40  *      + SymGetType(TI_GET_LENGTH) takes a ULONG64 (yurk, ugly)
  41  *  - SymGetLine{Next|Prev} don't work as expected (they don't seem to work across
  42  *    functions, and even across function blocks...). Basically, for *Next* to work
  43  *    it requires an address after the prolog of the func (the base address of the
  44  *    func doesn't work)
  45  *  - most options (dbghelp_options) are not used (loading lines...)
  46  *  - in symbol lookup by name, we don't use RE everywhere we should. Moreover, when
  47  *    we're supposed to use RE, it doesn't make use of our hash tables. Therefore,
  48  *    we could use hash if name isn't a RE, and fall back to a full search when we
  49  *    get a full RE
  50  *  - msc:
  51  *      + we should add parameters' types to the function's signature
  52  *        while processing a function's parameters
  53  *      + add support for function-less labels (as MSC seems to define them)
  54  *      + C++ management
  55  *  - stabs:
  56  *      + when, in a same module, the same definition is used in several compilation
  57  *        units, we get several definitions of the same object (especially
  58  *        struct/union). we should find a way not to duplicate them
  59  *      + in some cases (dlls/user/dialog16.c DIALOG_GetControl16), the same static
  60  *        global variable is defined several times (at different scopes). We are
  61  *        getting several of those while looking for a unique symbol. Part of the
  62  *        issue is that we don't give a scope to a static variable inside a function
  63  *      + C++ management
  64  *  - implement the callback notification mechanism
  65  */
  66
  67 unsigned   dbghelp_options = SYMOPT_UNDNAME;
  68 HANDLE     hMsvcrt = NULL;
  69
  70 /***********************************************************************
  71  *           DllMain (DEBUGHLP.@)
  72  */
  73 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
  74 {
  75     switch (fdwReason)
  76     {
  77     case DLL_PROCESS_ATTACH:    break;
  78     case DLL_PROCESS_DETACH:
  79         if (hMsvcrt) FreeLibrary(hMsvcrt);
  80         break;
  81     case DLL_THREAD_ATTACH:     break;
  82     case DLL_THREAD_DETACH:     break;
  83     default:                    break;
  84     }
  85     return TRUE;
  86 }
  87
  88 static struct process* process_first /* = NULL */;
  89
  90 /******************************************************************
  91  *              process_find_by_handle
  92  *
  93  */
  94 struct process*    process_find_by_handle(HANDLE hProcess)
  95 {
  96     struct process* p;
  97
  98     for (p = process_first; p && p->handle != hProcess; p = p->next);
  99     if (!p) SetLastError(ERROR_INVALID_HANDLE);
 100     return p;
 101 }
 102
 103 /******************************************************************
 104  *              SymSetSearchPath (DBGHELP.@)
 105  *
 106  */
 107 BOOL WINAPI SymSetSearchPath(HANDLE hProcess, PSTR searchPath)
 108 {
 109     struct process* pcs = process_find_by_handle(hProcess);
 110
 111     if (!pcs) return FALSE;
 112     if (!searchPath) return FALSE;
 113
 114     HeapFree(GetProcessHeap(), 0, pcs->search_path);
 115     pcs->search_path = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(searchPath) + 1),
 116                               searchPath);
 117     return TRUE;
 118 }
 119
 120 /***********************************************************************
 121  *              SymGetSearchPath (DBGHELP.@)
 122  */
 123 BOOL WINAPI SymGetSearchPath(HANDLE hProcess, LPSTR szSearchPath,
 124                              DWORD SearchPathLength)
 125 {
 126     struct process* pcs = process_find_by_handle(hProcess);
 127     if (!pcs) return FALSE;
 128
 129     strncpy(szSearchPath, pcs->search_path, SearchPathLength);
 130     szSearchPath[SearchPathLength - 1] = '\0';
 131     return TRUE;
 132 }
 133
 134 /******************************************************************
 135  *              invade_process
 136  *
 137  * SymInitialize helper: loads in dbghelp all known (and loaded modules)
 138  * this assumes that hProcess is a handle on a valid process
 139  */
 140 static BOOL WINAPI process_invade_cb(char* name, DWORD base, DWORD size, void* user)
 141 {
 142     char        tmp[MAX_PATH];
 143     HANDLE      hProcess = (HANDLE)user;
 144
 145     if (!GetModuleFileNameExA(hProcess, (HMODULE)base,
 146                               tmp, sizeof(tmp)))
 147         lstrcpynA(tmp, name, sizeof(tmp));
 148
 149     SymLoadModule(hProcess, 0, tmp, name, base, size);
 150     return TRUE;
 151 }
 152
 153 /******************************************************************
 154  *              SymInitialize (DBGHELP.@)
 155  *
 156  * The initialisation of a dbghelp's context.
 157  * Note that hProcess doesn't need to be a valid process handle (except
 158  * when fInvadeProcess is TRUE).
 159  * Since, we're also allow to load ELF (pure) libraries and Wine ELF libraries
 160  * containing PE (and NE) module(s), here's how we handle it:
 161  * - we load every module (ELF, NE, PE) passed in SymLoadModule
 162  * - in fInvadeProcess (in SymInitialize) is TRUE, we set up what is called ELF
 163  *   synchronization: hProcess should be a valid process handle, and we hook
 164  *   ourselves on hProcess's loaded ELF-modules, and keep this list in sync with
 165  *   our internal ELF modules representation (loading / unloading). This way,
 166  *   we'll pair every loaded builtin PE module with its ELF counterpart (and
 167  *   access its debug information).
 168  * - if fInvadeProcess (in SymInitialize) is FALSE, we won't be able to
 169  *   make the peering between a builtin PE module and its ELF counterpart, hence
 170  *   we won't be able to provide the requested debug information. We'll
 171  *   however be able to load native PE modules (and their debug information)
 172  *   without any trouble.
 173  * Note also that this scheme can be intertwined with the deferred loading
 174  * mechanism (ie only load the debug information when we actually need it).
 175  */
 176 BOOL WINAPI SymInitialize(HANDLE hProcess, PSTR UserSearchPath, BOOL fInvadeProcess)
 177 {
 178     struct process*     pcs;
 179
 180     TRACE("(%p %s %u)\n", hProcess, debugstr_a(UserSearchPath), fInvadeProcess);
 181
 182     if (process_find_by_handle(hProcess))
 183         FIXME("what to do ??\n");
 184
 185     pcs = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*pcs));
 186     if (!pcs) return FALSE;
 187
 188     pcs->handle = hProcess;
 189
 190     if (UserSearchPath)
 191     {
 192         pcs->search_path = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(UserSearchPath) + 1),
 193                                   UserSearchPath);
 194     }
 195     else
 196     {
 197         unsigned        size;
 198         unsigned        len;
 199
 200         pcs->search_path = HeapAlloc(GetProcessHeap(), 0, len = MAX_PATH);
 201         while ((size = GetCurrentDirectoryA(len, pcs->search_path)) >= len)
 202             pcs->search_path = HeapReAlloc(GetProcessHeap(), 0, pcs->search_path, len *= 2);
 203         pcs->search_path = HeapReAlloc(GetProcessHeap(), 0, pcs->search_path, size + 1);
 204
 205         len = GetEnvironmentVariableA("_NT_SYMBOL_PATH", NULL, 0);
 206         if (len)
 207         {
 208             pcs->search_path = HeapReAlloc(GetProcessHeap(), 0, pcs->search_path, size + 1 + len + 1);
 209             pcs->search_path[size] = ';';
 210             GetEnvironmentVariableA("_NT_SYMBOL_PATH", pcs->search_path + size + 1, len);
 211             size += 1 + len;
 212         }
 213         len = GetEnvironmentVariableA("_NT_ALTERNATE_SYMBOL_PATH", NULL, 0);
 214         if (len)
 215         {
 216             pcs->search_path = HeapReAlloc(GetProcessHeap(), 0, pcs->search_path, size + 1 + len + 1);
 217             pcs->search_path[size] = ';';
 218             GetEnvironmentVariableA("_NT_ALTERNATE_SYMBOL_PATH", pcs->search_path + size + 1, len);
 219             size += 1 + len;
 220         }
 221     }
 222
 223     pcs->lmodules = NULL;
 224     pcs->dbg_hdr_addr = 0;
 225     pcs->next = process_first;
 226     process_first = pcs;
 227
 228     if (fInvadeProcess)
 229     {
 230         if (!elf_read_wine_loader_dbg_info(pcs))
 231         {
 232             SymCleanup(hProcess);
 233             return FALSE;
 234         }
 235         EnumerateLoadedModules(hProcess, process_invade_cb, (void*)hProcess);
 236         elf_synchronize_module_list(pcs);
 237     }
 238
 239     return TRUE;
 240 }
 241
 242 /******************************************************************
 243  *              SymCleanup (DBGHELP.@)
 244  *
 245  */
 246 BOOL WINAPI SymCleanup(HANDLE hProcess)
 247 {
 248     struct process**    ppcs;
 249     struct process*     next;
 250
 251     for (ppcs = &process_first; *ppcs; ppcs = &(*ppcs)->next)
 252     {
 253         if ((*ppcs)->handle == hProcess)
 254         {
 255             while ((*ppcs)->lmodules) module_remove(*ppcs, (*ppcs)->lmodules);
 256
 257             HeapFree(GetProcessHeap(), 0, (*ppcs)->search_path);
 258             next = (*ppcs)->next;
 259             HeapFree(GetProcessHeap(), 0, *ppcs);
 260             *ppcs = next;
 261             return TRUE;
 262         }
 263     }
 264     return FALSE;
 265 }
 266
 267 /******************************************************************
 268  *              SymSetOptions (DBGHELP.@)
 269  *
 270  */
 271 DWORD WINAPI SymSetOptions(DWORD opts)
 272 {
 273     return dbghelp_options = opts;
 274 }
 275
 276 /******************************************************************
 277  *              SymGetOptions (DBGHELP.@)
 278  *
 279  */
 280 DWORD WINAPI SymGetOptions(void)
 281 {
 282     return dbghelp_options;
 283 }
 284
 285 /******************************************************************
 286  *              SymSetContext (DBGHELP.@)
 287  *
 288  */
 289 BOOL WINAPI SymSetContext(HANDLE hProcess, PIMAGEHLP_STACK_FRAME StackFrame,
 290                           PIMAGEHLP_CONTEXT Context)
 291 {
 292     struct process* pcs = process_find_by_handle(hProcess);
 293     if (!pcs) return FALSE;
 294
 295     pcs->ctx_frame = *StackFrame;
 296     /* MSDN states that Context is not (no longer?) used */
 297     return TRUE;
 298 }
 299
 300 /***********************************************************************
 301  *              SymRegisterCallback (DBGHELP.@)
 302  */
 303 BOOL WINAPI SymRegisterCallback(HANDLE hProcess,
 304                                 PSYMBOL_REGISTERED_CALLBACK CallbackFunction,
 305                                 PVOID UserContext)
 306 {
 307     FIXME("(%p, %p, %p): stub\n", hProcess, CallbackFunction, UserContext);
 308     SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
 309     return FALSE;
 310 }
 311
 312 /* This is imagehlp version not dbghelp !! */
 313 static API_VERSION api_version = { 4, 0, 2, 0 };
 314
 315 /***********************************************************************
 316  *           ImagehlpApiVersion (DBGHELP.@)
 317  */
 318 LPAPI_VERSION WINAPI ImagehlpApiVersion(VOID)
 319 {
 320     return &api_version;
 321 }
 322
 323 /***********************************************************************
 324  *           ImagehlpApiVersionEx (DBGHELP.@)
 325  */
 326 LPAPI_VERSION WINAPI ImagehlpApiVersionEx(LPAPI_VERSION AppVersion)
 327 {
 328     if (!AppVersion) return NULL;
 329
 330     AppVersion->MajorVersion = api_version.MajorVersion;
 331     AppVersion->MinorVersion = api_version.MinorVersion;
 332     AppVersion->Revision = api_version.Revision;
 333     AppVersion->Reserved = api_version.Reserved;
 334
 335     return AppVersion;
 336 }