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"
38 #include "u_debug_symbol.h"
40 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
48 * TODO: Support x86_64
51 static BOOL bSymInitialized
= FALSE
;
53 static HMODULE hModule_Imagehlp
= NULL
;
55 typedef BOOL (WINAPI
*PFNSYMINITIALIZE
)(HANDLE
, LPSTR
, BOOL
);
56 static PFNSYMINITIALIZE pfnSymInitialize
= NULL
;
59 BOOL WINAPI
j_SymInitialize(HANDLE hProcess
, PSTR UserSearchPath
, BOOL fInvadeProcess
)
62 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
63 (pfnSymInitialize
|| (pfnSymInitialize
= (PFNSYMINITIALIZE
) GetProcAddress(hModule_Imagehlp
, "SymInitialize")))
65 return pfnSymInitialize(hProcess
, UserSearchPath
, fInvadeProcess
);
70 typedef BOOL (WINAPI
*PFNSYMCLEANUP
)(HANDLE
);
71 static PFNSYMCLEANUP pfnSymCleanup
= NULL
;
74 BOOL WINAPI
j_SymCleanup(HANDLE hProcess
)
77 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
78 (pfnSymCleanup
|| (pfnSymCleanup
= (PFNSYMCLEANUP
) GetProcAddress(hModule_Imagehlp
, "SymCleanup")))
80 return pfnSymCleanup(hProcess
);
85 typedef DWORD (WINAPI
*PFNSYMSETOPTIONS
)(DWORD
);
86 static PFNSYMSETOPTIONS pfnSymSetOptions
= NULL
;
89 DWORD WINAPI
j_SymSetOptions(DWORD SymOptions
)
92 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
93 (pfnSymSetOptions
|| (pfnSymSetOptions
= (PFNSYMSETOPTIONS
) GetProcAddress(hModule_Imagehlp
, "SymSetOptions")))
95 return pfnSymSetOptions(SymOptions
);
100 typedef BOOL (WINAPI
*PFNSYMUNDNAME
)(PIMAGEHLP_SYMBOL
, PSTR
, DWORD
);
101 static PFNSYMUNDNAME pfnSymUnDName
= NULL
;
104 BOOL WINAPI
j_SymUnDName(PIMAGEHLP_SYMBOL Symbol
, PSTR UnDecName
, DWORD UnDecNameLength
)
107 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
108 (pfnSymUnDName
|| (pfnSymUnDName
= (PFNSYMUNDNAME
) GetProcAddress(hModule_Imagehlp
, "SymUnDName")))
110 return pfnSymUnDName(Symbol
, UnDecName
, UnDecNameLength
);
115 typedef PFUNCTION_TABLE_ACCESS_ROUTINE PFNSYMFUNCTIONTABLEACCESS
;
116 static PFNSYMFUNCTIONTABLEACCESS pfnSymFunctionTableAccess
= NULL
;
119 PVOID WINAPI
j_SymFunctionTableAccess(HANDLE hProcess
, DWORD AddrBase
)
122 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
123 (pfnSymFunctionTableAccess
|| (pfnSymFunctionTableAccess
= (PFNSYMFUNCTIONTABLEACCESS
) GetProcAddress(hModule_Imagehlp
, "SymFunctionTableAccess")))
125 return pfnSymFunctionTableAccess(hProcess
, AddrBase
);
130 typedef PGET_MODULE_BASE_ROUTINE PFNSYMGETMODULEBASE
;
131 static PFNSYMGETMODULEBASE pfnSymGetModuleBase
= NULL
;
134 DWORD WINAPI
j_SymGetModuleBase(HANDLE hProcess
, DWORD dwAddr
)
137 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
138 (pfnSymGetModuleBase
|| (pfnSymGetModuleBase
= (PFNSYMGETMODULEBASE
) GetProcAddress(hModule_Imagehlp
, "SymGetModuleBase")))
140 return pfnSymGetModuleBase(hProcess
, dwAddr
);
145 typedef BOOL (WINAPI
*PFNSTACKWALK
)(DWORD
, HANDLE
, HANDLE
, LPSTACKFRAME
, LPVOID
, PREAD_PROCESS_MEMORY_ROUTINE
, PFUNCTION_TABLE_ACCESS_ROUTINE
, PGET_MODULE_BASE_ROUTINE
, PTRANSLATE_ADDRESS_ROUTINE
);
146 static PFNSTACKWALK pfnStackWalk
= NULL
;
149 BOOL WINAPI
j_StackWalk(
153 LPSTACKFRAME StackFrame
,
155 PREAD_PROCESS_MEMORY_ROUTINE ReadMemoryRoutine
,
156 PFUNCTION_TABLE_ACCESS_ROUTINE FunctionTableAccessRoutine
,
157 PGET_MODULE_BASE_ROUTINE GetModuleBaseRoutine
,
158 PTRANSLATE_ADDRESS_ROUTINE TranslateAddress
162 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
163 (pfnStackWalk
|| (pfnStackWalk
= (PFNSTACKWALK
) GetProcAddress(hModule_Imagehlp
, "StackWalk")))
172 FunctionTableAccessRoutine
,
173 GetModuleBaseRoutine
,
180 typedef BOOL (WINAPI
*PFNSYMGETSYMFROMADDR
)(HANDLE
, DWORD
, LPDWORD
, PIMAGEHLP_SYMBOL
);
181 static PFNSYMGETSYMFROMADDR pfnSymGetSymFromAddr
= NULL
;
184 BOOL WINAPI
j_SymGetSymFromAddr(HANDLE hProcess
, DWORD Address
, PDWORD Displacement
, PIMAGEHLP_SYMBOL Symbol
)
187 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
188 (pfnSymGetSymFromAddr
|| (pfnSymGetSymFromAddr
= (PFNSYMGETSYMFROMADDR
) GetProcAddress(hModule_Imagehlp
, "SymGetSymFromAddr")))
190 return pfnSymGetSymFromAddr(hProcess
, Address
, Displacement
, Symbol
);
195 typedef BOOL (WINAPI
*PFNSYMGETLINEFROMADDR
)(HANDLE
, DWORD
, LPDWORD
, PIMAGEHLP_LINE
);
196 static PFNSYMGETLINEFROMADDR pfnSymGetLineFromAddr
= NULL
;
199 BOOL WINAPI
j_SymGetLineFromAddr(HANDLE hProcess
, DWORD dwAddr
, PDWORD pdwDisplacement
, PIMAGEHLP_LINE Line
)
202 (hModule_Imagehlp
|| (hModule_Imagehlp
= LoadLibraryA("IMAGEHLP.DLL"))) &&
203 (pfnSymGetLineFromAddr
|| (pfnSymGetLineFromAddr
= (PFNSYMGETLINEFROMADDR
) GetProcAddress(hModule_Imagehlp
, "SymGetLineFromAddr")))
205 return pfnSymGetLineFromAddr(hProcess
, dwAddr
, pdwDisplacement
, Line
);
211 static INLINE boolean
212 debug_symbol_print_imagehlp(const void *addr
)
215 BYTE symbolBuffer
[1024];
216 PIMAGEHLP_SYMBOL pSymbol
= (PIMAGEHLP_SYMBOL
) symbolBuffer
;
217 DWORD dwDisplacement
= 0; /* Displacement of the input address, relative to the start of the symbol */
219 hProcess
= GetCurrentProcess();
221 pSymbol
->SizeOfStruct
= sizeof(symbolBuffer
);
222 pSymbol
->MaxNameLength
= sizeof(symbolBuffer
) - offsetof(IMAGEHLP_SYMBOL
, Name
);
224 if(!bSymInitialized
) {
225 j_SymSetOptions(/* SYMOPT_UNDNAME | */ SYMOPT_LOAD_LINES
);
226 if(j_SymInitialize(hProcess
, NULL
, TRUE
))
227 bSymInitialized
= TRUE
;
230 if(!j_SymGetSymFromAddr(hProcess
, (DWORD
)addr
, &dwDisplacement
, pSymbol
))
233 debug_printf("\t%s\n", pSymbol
->Name
);
242 debug_symbol_print(const void *addr
)
244 #if defined(PIPE_SUBSYSTEM_WINDOWS_USER) && defined(PIPE_ARCH_X86)
245 if(debug_symbol_print_imagehlp(addr
))
249 debug_printf("\t%p\n", addr
);