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 #include "u_string.h"
  37
  38 #include "u_debug.h"
  39 #include "u_debug_symbol.h"
  40
  41 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
  42
  43 #include <windows.h>
  44 #include <stddef.h>
  45 #include <imagehlp.h>
  46
  47 /*
  48  * TODO: Cleanup code.
  49  * TODO: Support x86_64
  50  */
  51
  52 static BOOL bSymInitialized = FALSE;
  53
  54 static HMODULE hModule_Imagehlp = NULL;
  55
  56 typedef BOOL (WINAPI *PFNSYMINITIALIZE)(HANDLE, LPSTR, BOOL);
  57 static PFNSYMINITIALIZE pfnSymInitialize = NULL;
  58
  59 static
  60 BOOL WINAPI j_SymInitialize(HANDLE hProcess, PSTR UserSearchPath, BOOL fInvadeProcess)
  61 {
  62    if(
  63       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
  64       (pfnSymInitialize || (pfnSymInitialize = (PFNSYMINITIALIZE) GetProcAddress(hModule_Imagehlp, "SymInitialize")))
  65    )
  66       return pfnSymInitialize(hProcess, UserSearchPath, fInvadeProcess);
  67    else
  68       return FALSE;
  69 }
  70
  71 typedef DWORD (WINAPI *PFNSYMSETOPTIONS)(DWORD);
  72 static PFNSYMSETOPTIONS pfnSymSetOptions = NULL;
  73
  74 static
  75 DWORD WINAPI j_SymSetOptions(DWORD SymOptions)
  76 {
  77    if(
  78       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
  79       (pfnSymSetOptions || (pfnSymSetOptions = (PFNSYMSETOPTIONS) GetProcAddress(hModule_Imagehlp, "SymSetOptions")))
  80    )
  81       return pfnSymSetOptions(SymOptions);
  82    else
  83       return FALSE;
  84 }
  85
  86 typedef PGET_MODULE_BASE_ROUTINE PFNSYMGETMODULEBASE;
  87 static PFNSYMGETMODULEBASE pfnSymGetModuleBase = NULL;
  88
  89 static
  90 DWORD WINAPI j_SymGetModuleBase(HANDLE hProcess, DWORD dwAddr)
  91 {
  92    if(
  93       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
  94       (pfnSymGetModuleBase || (pfnSymGetModuleBase = (PFNSYMGETMODULEBASE) GetProcAddress(hModule_Imagehlp, "SymGetModuleBase")))
  95    )
  96       return pfnSymGetModuleBase(hProcess, dwAddr);
  97    else
  98       return 0;
  99 }
 100
 101 typedef BOOL (WINAPI *PFNSYMGETSYMFROMADDR)(HANDLE, DWORD, LPDWORD, PIMAGEHLP_SYMBOL);
 102 static PFNSYMGETSYMFROMADDR pfnSymGetSymFromAddr = NULL;
 103
 104 static
 105 BOOL WINAPI j_SymGetSymFromAddr(HANDLE hProcess, DWORD Address, PDWORD Displacement, PIMAGEHLP_SYMBOL Symbol)
 106 {
 107    if(
 108       (hModule_Imagehlp || (hModule_Imagehlp = LoadLibraryA("IMAGEHLP.DLL"))) &&
 109       (pfnSymGetSymFromAddr || (pfnSymGetSymFromAddr = (PFNSYMGETSYMFROMADDR) GetProcAddress(hModule_Imagehlp, "SymGetSymFromAddr")))
 110    )
 111       return pfnSymGetSymFromAddr(hProcess, Address, Displacement, Symbol);
 112    else
 113       return FALSE;
 114 }
 115
 116
 117 static INLINE void
 118 debug_symbol_name_imagehlp(const void *addr, char* buf, unsigned size)
 119 {
 120    HANDLE hProcess;
 121    BYTE symbolBuffer[1024];
 122    PIMAGEHLP_SYMBOL pSymbol = (PIMAGEHLP_SYMBOL) symbolBuffer;
 123    DWORD dwDisplacement = 0;  /* Displacement of the input address, relative to the start of the symbol */
 124
 125    hProcess = GetCurrentProcess();
 126
 127    pSymbol->SizeOfStruct = sizeof(symbolBuffer);
 128    pSymbol->MaxNameLength = sizeof(symbolBuffer) - offsetof(IMAGEHLP_SYMBOL, Name);
 129
 130    if(!bSymInitialized) {
 131       j_SymSetOptions(/* SYMOPT_UNDNAME | */ SYMOPT_LOAD_LINES);
 132       if(j_SymInitialize(hProcess, NULL, TRUE))
 133          bSymInitialized = TRUE;
 134    }
 135
 136    if(!j_SymGetSymFromAddr(hProcess, (DWORD)addr, &dwDisplacement, pSymbol))
 137       buf[0] = 0;
 138    else
 139    {
 140       strncpy(buf, pSymbol->Name, size);
 141       buf[size - 1] = 0;
 142    }
 143 }
 144 #endif
 145
 146 #ifdef __GLIBC__
 147 #include <execinfo.h>
 148
 149 /* This can only provide dynamic symbols, or binary offsets into a file.
 150  *
 151  * To fix this, post-process the output with tools/addr2line.sh
 152  */
 153 static INLINE void
 154 debug_symbol_name_glibc(const void *addr, char* buf, unsigned size)
 155 {
 156    char** syms = backtrace_symbols((void**)&addr, 1);
 157    strncpy(buf, syms[0], size);
 158    buf[size - 1] = 0;
 159    free(syms);
 160 }
 161 #endif
 162
 163 void
 164 debug_symbol_name(const void *addr, char* buf, unsigned size)
 165 {
 166 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
 167    debug_symbol_name_imagehlp(addr, buf, size);
 168    if(buf[0])
 169       return;
 170 #endif
 171
 172 #ifdef __GLIBC__
 173    debug_symbol_name_glibc(addr, buf, size);
 174    if(buf[0])
 175       return;
 176 #endif
 177
 178    util_snprintf(buf, size, "%p", addr);
 179    buf[size - 1] = 0;
 180 }
 181
 182 void
 183 debug_symbol_print(const void *addr)
 184 {
 185    char buf[1024];
 186    debug_symbol_name(addr, buf, sizeof(buf));
 187    debug_printf("\t%s\n", buf);
 188 }