1 /**************************************************************************
3 * Copyright 2009 VMware, Inc.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
32 * @author Jose Fonseca <jfonseca@vmware.com>
35 #include "pipe/p_compiler.h"
36 #include "os/os_thread.h"
40 #include "u_debug_symbol.h"
41 #include "u_hash_table.h"
43 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
51 * TODO: Support x86_64
54 static BOOL bSymInitialized
= FALSE
;
56 static HMODULE hModule_Imagehlp
= NULL
;
58 typedef BOOL (WINAPI
*PFNSYMINITIALIZE
)(HANDLE
, LPSTR
, BOOL
);
59 static PFNSYMINITIALIZE pfnSymInitialize
= NULL
;
62 BOOL WINAPI
j_SymInitialize(HANDLE hProcess
, PSTR UserSearchPath
, BOOL fInvadeProcess
)
65 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
66 (pfnSymInitialize
|| (pfnSymInitialize
= (PFNSYMINITIALIZE
) GetProcAddress(hModule_Imagehlp
, "SymInitialize")))
68 return pfnSymInitialize(hProcess
, UserSearchPath
, fInvadeProcess
);
73 typedef DWORD (WINAPI
*PFNSYMSETOPTIONS
)(DWORD
);
74 static PFNSYMSETOPTIONS pfnSymSetOptions
= NULL
;
77 DWORD WINAPI
j_SymSetOptions(DWORD SymOptions
)
80 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
81 (pfnSymSetOptions
|| (pfnSymSetOptions
= (PFNSYMSETOPTIONS
) GetProcAddress(hModule_Imagehlp
, "SymSetOptions")))
83 return pfnSymSetOptions(SymOptions
);
88 typedef PGET_MODULE_BASE_ROUTINE PFNSYMGETMODULEBASE
;
89 static PFNSYMGETMODULEBASE pfnSymGetModuleBase
= NULL
;
92 DWORD WINAPI
j_SymGetModuleBase(HANDLE hProcess
, DWORD dwAddr
)
95 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
96 (pfnSymGetModuleBase
|| (pfnSymGetModuleBase
= (PFNSYMGETMODULEBASE
) GetProcAddress(hModule_Imagehlp
, "SymGetModuleBase")))
98 return pfnSymGetModuleBase(hProcess
, dwAddr
);
103 typedef BOOL (WINAPI
*PFNSYMGETSYMFROMADDR
)(HANDLE
, DWORD
, LPDWORD
, PIMAGEHLP_SYMBOL
);
104 static PFNSYMGETSYMFROMADDR pfnSymGetSymFromAddr
= NULL
;
107 BOOL WINAPI
j_SymGetSymFromAddr(HANDLE hProcess
, DWORD Address
, PDWORD Displacement
, PIMAGEHLP_SYMBOL Symbol
)
110 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
111 (pfnSymGetSymFromAddr
|| (pfnSymGetSymFromAddr
= (PFNSYMGETSYMFROMADDR
) GetProcAddress(hModule_Imagehlp
, "SymGetSymFromAddr")))
113 return pfnSymGetSymFromAddr(hProcess
, Address
, Displacement
, Symbol
);
120 debug_symbol_name_imagehlp(const void *addr
, char* buf
, unsigned size
)
123 BYTE symbolBuffer
[1024];
124 PIMAGEHLP_SYMBOL pSymbol
= (PIMAGEHLP_SYMBOL
) symbolBuffer
;
125 DWORD dwDisplacement
= 0; /* Displacement of the input address, relative to the start of the symbol */
127 hProcess
= GetCurrentProcess();
129 pSymbol
->SizeOfStruct
= sizeof(symbolBuffer
);
130 pSymbol
->MaxNameLength
= sizeof(symbolBuffer
) - offsetof(IMAGEHLP_SYMBOL
, Name
);
132 if(!bSymInitialized
) {
133 j_SymSetOptions(/* SYMOPT_UNDNAME | */ SYMOPT_LOAD_LINES
);
134 if(j_SymInitialize(hProcess
, NULL
, TRUE
))
135 bSymInitialized
= TRUE
;
138 if(!j_SymGetSymFromAddr(hProcess
, (DWORD
)addr
, &dwDisplacement
, pSymbol
))
142 strncpy(buf
, pSymbol
->Name
, size
);
149 #include <execinfo.h>
151 /* This can only provide dynamic symbols, or binary offsets into a file.
153 * To fix this, post-process the output with tools/addr2line.sh
156 debug_symbol_name_glibc(const void *addr
, char* buf
, unsigned size
)
158 char** syms
= backtrace_symbols((void**)&addr
, 1);
159 strncpy(buf
, syms
[0], size
);
166 debug_symbol_name(const void *addr
, char* buf
, unsigned size
)
168 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
169 debug_symbol_name_imagehlp(addr
, buf
, size
);
175 debug_symbol_name_glibc(addr
, buf
, size
);
180 util_snprintf(buf
, size
, "%p", addr
);
185 debug_symbol_print(const void *addr
)
188 debug_symbol_name(addr
, buf
, sizeof(buf
));
189 debug_printf("\t%s\n", buf
);
192 struct util_hash_table
* symbols_hash
;
193 pipe_mutex symbols_mutex
;
195 static unsigned hash_ptr(void* p
)
197 return (unsigned)(uintptr_t)p
;
200 static int compare_ptr(void* a
, void* b
)
211 debug_symbol_name_cached(const void *addr
)
214 pipe_mutex_lock(symbols_mutex
);
216 symbols_hash
= util_hash_table_create(hash_ptr
, compare_ptr
);
217 name
= util_hash_table_get(symbols_hash
, (void*)addr
);
221 debug_symbol_name(addr
, buf
, sizeof(buf
));
224 util_hash_table_set(symbols_hash
, (void*)addr
, (void*)name
);
226 pipe_mutex_unlock(symbols_mutex
);