1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/wrapdbgh.h
3 // Purpose: wraps dbghelp.h standard file
4 // Author: Vadim Zeitlin
6 // Created: 2005-01-08 (extracted from msw/crashrpt.cpp)
8 // Copyright: (c) 2003-2005 Vadim Zeitlin <vadim@wxwindows.org>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_MSW_DEBUGHLPH_H_
13 #define _WX_MSW_DEBUGHLPH_H_
15 #include "wx/dynlib.h"
17 #include "wx/msw/wrapwin.h"
19 #include "wx/msw/private.h"
21 // we need to determine whether we have the declarations for the function in
22 // debughlp.dll version 5.81 (at least) and we check for DBHLPAPI to test this
25 // - VC6 version of imagehlp.h doesn't define it
27 // - testing for compiler version doesn't work as you can install and use
28 // the new SDK headers with VC6
30 // in any case, the user may override by defining wxUSE_DBGHELP himself
33 #define wxUSE_DBGHELP 1
35 #define wxUSE_DBGHELP 0
41 // ----------------------------------------------------------------------------
42 // wxDbgHelpDLL: dynamically load dbghelp.dll functions
43 // ----------------------------------------------------------------------------
45 // wrapper for some functions from dbghelp.dll
47 // MT note: this class is not MT safe and should be only used from a single
48 // thread at a time (this is so because dbghelp.dll is not MT-safe
53 // some useful constants not present in debughlp.h (stolen from DIA SDK)
67 BASICTYPE_CURRENCY
= 25,
69 BASICTYPE_VARIANT
= 27,
70 BASICTYPE_COMPLEX
= 28,
73 BASICTYPE_HRESULT
= 31,
82 SYMBOL_TAG_COMPILAND_DETAILS
,
83 SYMBOL_TAG_COMPILAND_ENV
,
87 SYMBOL_TAG_ANNOTATION
,
89 SYMBOL_TAG_PUBLIC_SYMBOL
,
92 SYMBOL_TAG_FUNCTION_TYPE
,
93 SYMBOL_TAG_POINTER_TYPE
,
94 SYMBOL_TAG_ARRAY_TYPE
,
97 SYMBOL_TAG_BASE_CLASS
,
99 SYMBOL_TAG_FUNCTION_ARG_TYPE
,
100 SYMBOL_TAG_FUNC_DEBUG_START
,
101 SYMBOL_TAG_FUNC_DEBUG_END
,
102 SYMBOL_TAG_USING_NAMESPACE
,
103 SYMBOL_TAG_VTABLE_SHAPE
,
107 SYMBOL_TAG_CUSTOM_TYPE
,
108 SYMBOL_TAG_MANAGED_TYPE
,
109 SYMBOL_TAG_DIMENSION
,
119 DATA_OBJECT_PTR
, // "this" pointer
138 typedef DWORD (WINAPI
*SymGetOptions_t
)();
139 typedef DWORD (WINAPI
*SymSetOptions_t
)(DWORD
);
140 typedef BOOL (WINAPI
*SymInitialize_t
)(HANDLE
, LPSTR
, BOOL
);
141 typedef BOOL (WINAPI
*StackWalk_t
)(DWORD
, HANDLE
, HANDLE
, LPSTACKFRAME
,
142 LPVOID
, PREAD_PROCESS_MEMORY_ROUTINE
,
143 PFUNCTION_TABLE_ACCESS_ROUTINE
,
144 PGET_MODULE_BASE_ROUTINE
,
145 PTRANSLATE_ADDRESS_ROUTINE
);
146 typedef BOOL (WINAPI
*SymFromAddr_t
)(HANDLE
, DWORD64
, PDWORD64
, PSYMBOL_INFO
);
147 typedef LPVOID (WINAPI
*SymFunctionTableAccess_t
)(HANDLE
, DWORD
);
148 typedef DWORD (WINAPI
*SymGetModuleBase_t
)(HANDLE
, DWORD
);
149 typedef BOOL (WINAPI
*SymGetLineFromAddr_t
)(HANDLE
, DWORD
,
150 PDWORD
, PIMAGEHLP_LINE
);
151 typedef BOOL (WINAPI
*SymSetContext_t
)(HANDLE
, PIMAGEHLP_STACK_FRAME
,
153 typedef BOOL (WINAPI
*SymEnumSymbols_t
)(HANDLE
, ULONG64
, PCSTR
,
154 PSYM_ENUMERATESYMBOLS_CALLBACK
, PVOID
);
155 typedef BOOL (WINAPI
*SymGetTypeInfo_t
)(HANDLE
, DWORD64
, ULONG
,
156 IMAGEHLP_SYMBOL_TYPE_INFO
, PVOID
);
157 typedef BOOL (WINAPI
*SymCleanup_t
)(HANDLE
);
158 typedef BOOL (WINAPI
*EnumerateLoadedModules_t
)(HANDLE
, PENUMLOADED_MODULES_CALLBACK
, PVOID
);
159 typedef BOOL (WINAPI
*MiniDumpWriteDump_t
)(HANDLE
, DWORD
, HANDLE
,
161 CONST PMINIDUMP_EXCEPTION_INFORMATION
,
162 CONST PMINIDUMP_USER_STREAM_INFORMATION
,
163 CONST PMINIDUMP_CALLBACK_INFORMATION
);
165 #define wxDO_FOR_ALL_SYM_FUNCS(what) \
166 what(SymGetOptions); \
167 what(SymSetOptions); \
168 what(SymInitialize); \
171 what(SymFunctionTableAccess); \
172 what(SymGetModuleBase); \
173 what(SymGetLineFromAddr); \
174 what(SymSetContext); \
175 what(SymEnumSymbols); \
176 what(SymGetTypeInfo); \
178 what(EnumerateLoadedModules); \
179 what(MiniDumpWriteDump)
181 #define wxDECLARE_SYM_FUNCTION(func) static func ## _t func
183 wxDO_FOR_ALL_SYM_FUNCS(wxDECLARE_SYM_FUNCTION
);
185 #undef wxDECLARE_SYM_FUNCTION
187 // load all functions from DLL, return true if ok
190 // return the string with the error message explaining why Init() failed
191 static const wxString
& GetErrorMessage();
193 // log error returned by the given function to debug output
194 static void LogError(const wxChar
*func
);
196 // return textual representation of the value of given symbol
197 static wxString
DumpSymbol(PSYMBOL_INFO pSymInfo
, void *pVariable
);
199 // return the name of the symbol with given type index
200 static wxString
GetSymbolName(PSYMBOL_INFO pSymInfo
);
203 // dereference the given symbol, i.e. return symbol which is not a
204 // pointer/reference any more
206 // if ppData != NULL, dereference the pointer as many times as we
207 // dereferenced the symbol
209 // return the tag of the dereferenced symbol
210 static SymbolTag
DereferenceSymbol(PSYMBOL_INFO pSymInfo
, void **ppData
);
212 static wxString
DumpField(PSYMBOL_INFO pSymInfo
,
216 static wxString
DumpBaseType(BasicType bt
, DWORD64 length
, void *pVariable
);
218 static wxString
DumpUDT(PSYMBOL_INFO pSymInfo
,
223 #endif // wxUSE_DBGHELP
225 #endif // _WX_MSW_DEBUGHLPH_H_