src/gallium/auxiliary/util/u_debug_symbol.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * @file
  30  * Symbol lookup.
  31  *
  32  * @author Jose Fonseca <jfonseca@vmware.com>
  33  */
  34
  35 #include "pipe/p_compiler.h"
  36
  37 #include "u_debug.h"
  38 #include "u_debug_symbol.h"
  39
  40 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
  41
  42 #include <windows.h>
  43 #include <stddef.h>
  44 #include <imagehlp.h>
  45
  46 /*
  47  * TODO: Cleanup code.
  48  * TODO: Support x86_64
  49  */
  50
  51 static BOOL bSymInitialized = FALSE;
  52
  53 static HMODULE hModule_Imagehlp = NULL;
  54
  55 typedef BOOL (WINAPI *PFNSYMINITIALIZE)(HANDLE, LPSTR, BOOL);
  56 static PFNSYMINITIALIZE pfnSymInitialize = NULL;
  57
  58 static
  59 BOOL WINAPI j_SymInitialize(HANDLE hProcess, PSTR UserSearchPath, BOOL fInvadeProcess)
  60 {
  61    if(
  62       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
  63       (pfnSymInitialize || (pfnSymInitialize = (PFNSYMINITIALIZE) GetProcAddress(hModule_Imagehlp, "SymInitialize")))
  64    )
  65       return pfnSymInitialize(hProcess, UserSearchPath, fInvadeProcess);
  66    else
  67       return FALSE;
  68 }
  69
  70 typedef DWORD (WINAPI *PFNSYMSETOPTIONS)(DWORD);
  71 static PFNSYMSETOPTIONS pfnSymSetOptions = NULL;
  72
  73 static
  74 DWORD WINAPI j_SymSetOptions(DWORD SymOptions)
  75 {
  76    if(
  77       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
  78       (pfnSymSetOptions || (pfnSymSetOptions = (PFNSYMSETOPTIONS) GetProcAddress(hModule_Imagehlp, "SymSetOptions")))
  79    )
  80       return pfnSymSetOptions(SymOptions);
  81    else
  82       return FALSE;
  83 }
  84
  85 typedef PGET_MODULE_BASE_ROUTINE PFNSYMGETMODULEBASE;
  86 static PFNSYMGETMODULEBASE pfnSymGetModuleBase = NULL;
  87
  88 static
  89 DWORD WINAPI j_SymGetModuleBase(HANDLE hProcess, DWORD dwAddr)
  90 {
  91    if(
  92       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
  93       (pfnSymGetModuleBase || (pfnSymGetModuleBase = (PFNSYMGETMODULEBASE) GetProcAddress(hModule_Imagehlp, "SymGetModuleBase")))
  94    )
  95       return pfnSymGetModuleBase(hProcess, dwAddr);
  96    else
  97       return 0;
  98 }
  99
 100 typedef BOOL (WINAPI *PFNSYMGETSYMFROMADDR)(HANDLE, DWORD, LPDWORD, PIMAGEHLP_SYMBOL);
 101 static PFNSYMGETSYMFROMADDR pfnSymGetSymFromAddr = NULL;
 102
 103 static
 104 BOOL WINAPI j_SymGetSymFromAddr(HANDLE hProcess, DWORD Address, PDWORD Displacement, PIMAGEHLP_SYMBOL Symbol)
 105 {
 106    if(
 107       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
 108       (pfnSymGetSymFromAddr || (pfnSymGetSymFromAddr = (PFNSYMGETSYMFROMADDR) GetProcAddress(hModule_Imagehlp, "SymGetSymFromAddr")))
 109    )
 110       return pfnSymGetSymFromAddr(hProcess, Address, Displacement, Symbol);
 111    else
 112       return FALSE;
 113 }
 114
 115
 116 static INLINE boolean
 117 debug_symbol_print_imagehlp(const void *addr)
 118 {
 119    HANDLE hProcess;
 120    BYTE symbolBuffer[1024];
 121    PIMAGEHLP_SYMBOL pSymbol = (PIMAGEHLP_SYMBOL) symbolBuffer;
 122    DWORD dwDisplacement = 0;  /* Displacement of the input address, relative to the start of the symbol */
 123
 124    hProcess = GetCurrentProcess();
 125
 126    pSymbol->SizeOfStruct = sizeof(symbolBuffer);
 127    pSymbol->MaxNameLength = sizeof(symbolBuffer) - offsetof(IMAGEHLP_SYMBOL, Name);
 128
 129    if(!bSymInitialized) {
 130       j_SymSetOptions(/* SYMOPT_UNDNAME | */ SYMOPT_LOAD_LINES);
 131       if(j_SymInitialize(hProcess, NULL, TRUE))
 132          bSymInitialized = TRUE;
 133    }
 134
 135    if(!j_SymGetSymFromAddr(hProcess, (DWORD)addr, &dwDisplacement, pSymbol))
 136       return FALSE;
 137
 138    debug_printf("\t%s\n", pSymbol->Name);
 139
 140    return TRUE;
 141
 142 }
 143 #endif
 144
 145
 146 void
 147 debug_symbol_print(const void *addr)
 148 {
 149 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
 150    if(debug_symbol_print_imagehlp(addr))
 151       return;
 152 #endif
 153
 154    debug_printf("\t%p\n", addr);
 155 }