1 /////////////////////////////////////////////////////////////////////////////
2 // Name: msw/debughlp.cpp
3 // Purpose: various Win32 debug helpers
4 // Author: Vadim Zeitlin
6 // Created: 2005-01-08 (extracted from crashrpt.cpp)
8 // Copyright: (c) 2003-2005 Vadim Zeitlin <vadim@wxwindows.org>
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #include "wx/wxprec.h"
26 #include "wx/msw/debughlp.h"
30 // ----------------------------------------------------------------------------
32 // ----------------------------------------------------------------------------
34 // to prevent recursion which could result from corrupted data we limit
35 // ourselves to that many levels of embedded fields inside structs
36 static const unsigned MAX_DUMP_DEPTH
= 20;
38 // ----------------------------------------------------------------------------
40 // ----------------------------------------------------------------------------
42 // error message from Init()
43 static wxString gs_errMsg
;
45 // ============================================================================
46 // wxDbgHelpDLL implementation
47 // ============================================================================
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
53 #define DEFINE_SYM_FUNCTION(func) wxDbgHelpDLL::func ## _t wxDbgHelpDLL::func = 0
55 wxDO_FOR_ALL_SYM_FUNCS(DEFINE_SYM_FUNCTION
);
57 #undef DEFINE_SYM_FUNCTION
59 // ----------------------------------------------------------------------------
60 // initialization methods
61 // ----------------------------------------------------------------------------
63 // load all function we need from the DLL
65 static bool BindDbgHelpFunctions(const wxDynamicLibrary
& dllDbgHelp
)
67 #define LOAD_SYM_FUNCTION(name) \
68 wxDbgHelpDLL::name = (wxDbgHelpDLL::name ## _t) \
69 dllDbgHelp.GetSymbol(_T(#name)); \
70 if ( !wxDbgHelpDLL::name ) \
72 gs_errMsg += _T("Function ") _T(#name) _T("() not found.\n"); \
76 wxDO_FOR_ALL_SYM_FUNCS(LOAD_SYM_FUNCTION
);
78 #undef LOAD_SYM_FUNCTION
83 // called by Init() if we hadn't done this before
86 wxDynamicLibrary
dllDbgHelp(_T("dbghelp.dll"), wxDL_VERBATIM
);
87 if ( dllDbgHelp
.IsLoaded() )
89 if ( BindDbgHelpFunctions(dllDbgHelp
) )
91 // turn on default options
92 DWORD options
= wxDbgHelpDLL::SymGetOptions();
94 options
|= SYMOPT_DEFERRED_LOADS
| SYMOPT_UNDNAME
| SYMOPT_DEBUG
;
96 wxDbgHelpDLL::SymSetOptions(options
);
102 gs_errMsg
+= _T("\nPlease update your dbghelp.dll version, ")
103 _T("at least version 5.1 is needed!\n")
104 _T("(if you already have a new version, please ")
105 _T("put it in the same directory where the program is.)\n");
107 else // failed to load dbghelp.dll
109 gs_errMsg
+= _T("Please install dbghelp.dll available free of charge ")
110 _T("from Microsoft to get more detailed crash information!");
113 gs_errMsg
+= _T("\nLatest dbghelp.dll is available at ")
114 _T("http://www.microsoft.com/whdc/ddk/debugging/\n");
120 bool wxDbgHelpDLL::Init()
122 // this flag is -1 until Init() is called for the first time, then it's set
123 // to either false or true depending on whether we could load the functions
124 static int s_loaded
= -1;
126 if ( s_loaded
== -1 )
131 return s_loaded
!= 0;
134 // ----------------------------------------------------------------------------
136 // ----------------------------------------------------------------------------
139 const wxString
& wxDbgHelpDLL::GetErrorMessage()
145 void wxDbgHelpDLL::LogError(const wxChar
*func
)
147 ::OutputDebugString(wxString::Format(_T("dbghelp: %s() failed: %s\r\n"),
148 func
, wxSysErrorMsg(::GetLastError())));
151 // ----------------------------------------------------------------------------
153 // ----------------------------------------------------------------------------
157 DoGetTypeInfo(DWORD64 base
, ULONG ti
, IMAGEHLP_SYMBOL_TYPE_INFO type
, void *rc
)
159 static HANDLE s_hProcess
= ::GetCurrentProcess();
161 return wxDbgHelpDLL::SymGetTypeInfo
173 DoGetTypeInfo(PSYMBOL_INFO pSym
, IMAGEHLP_SYMBOL_TYPE_INFO type
, void *rc
)
175 return DoGetTypeInfo(pSym
->ModBase
, pSym
->TypeIndex
, type
, rc
);
179 wxDbgHelpDLL::BasicType
GetBasicType(PSYMBOL_INFO pSym
)
181 wxDbgHelpDLL::BasicType bt
;
182 return DoGetTypeInfo(pSym
, TI_GET_BASETYPE
, &bt
)
184 : wxDbgHelpDLL::BASICTYPE_NOTYPE
;
188 wxString
wxDbgHelpDLL::GetSymbolName(PSYMBOL_INFO pSym
)
202 s
= wxConvCurrent
->cWC2WX(pwszTypeName
);
204 ::LocalFree(pwszTypeName
);
210 /* static */ wxString
211 wxDbgHelpDLL::DumpBaseType(BasicType bt
, DWORD64 length
, PVOID pAddress
)
218 if ( ::IsBadReadPtr(pAddress
, length
) != 0 )
229 const BYTE b
= *(PBYTE
)pAddress
;
231 if ( bt
== BASICTYPE_BOOL
)
232 s
= b
? _T("true") : _T("false");
234 s
.Printf(_T("%#04x"), b
);
236 else if ( length
== 2 )
238 s
.Printf(bt
== BASICTYPE_UINT
? _T("%#06x") : _T("%d"),
241 else if ( length
== 4 )
243 bool handled
= false;
245 if ( bt
== BASICTYPE_FLOAT
)
247 s
.Printf(_T("%f"), *(PFLOAT
)pAddress
);
251 else if ( bt
== BASICTYPE_CHAR
)
253 // don't take more than 32 characters of a string
254 static const size_t NUM_CHARS
= 64;
256 const char *pc
= *(PSTR
*)pAddress
;
257 if ( ::IsBadStringPtrA(pc
, NUM_CHARS
) == 0 )
260 for ( size_t n
= 0; n
< NUM_CHARS
&& *pc
; n
++, pc
++ )
272 // treat just as an opaque DWORD
273 s
.Printf(_T("%#x"), *(PDWORD
)pAddress
);
276 else if ( length
== 8 )
278 if ( bt
== BASICTYPE_FLOAT
)
280 s
.Printf(_T("%lf"), *(double *)pAddress
);
282 else // opaque 64 bit value
284 s
.Printf(_T("%#" wxLongLongFmtSpec
_T("x")), *(PDWORD
*)pAddress
);
292 wxDbgHelpDLL::DumpField(PSYMBOL_INFO pSym
, void *pVariable
, unsigned level
)
296 // avoid infinite recursion
297 if ( level
> MAX_DUMP_DEPTH
)
302 SymbolTag tag
= SYMBOL_TAG_NULL
;
303 if ( !DoGetTypeInfo(pSym
, TI_GET_SYMTAG
, &tag
) )
311 case SYMBOL_TAG_BASE_CLASS
:
312 s
= DumpUDT(pSym
, pVariable
, level
);
315 case SYMBOL_TAG_DATA
:
320 else // valid location
322 wxDbgHelpDLL::DataKind kind
;
323 if ( !DoGetTypeInfo(pSym
, TI_GET_DATAKIND
, &kind
) ||
324 kind
!= DATA_MEMBER
)
326 // maybe it's a static member? we're not interested in them...
330 // get the offset of the child member, relative to its parent
332 if ( !DoGetTypeInfo(pSym
, TI_GET_OFFSET
, &ofs
) )
335 pVariable
= (void *)((DWORD_PTR
)pVariable
+ ofs
);
338 // now pass to the type representing the type of this member
339 SYMBOL_INFO sym
= *pSym
;
340 if ( !DoGetTypeInfo(pSym
, TI_GET_TYPEID
, &sym
.TypeIndex
) )
344 DoGetTypeInfo(&sym
, TI_GET_LENGTH
, &size
);
346 switch ( DereferenceSymbol(&sym
, &pVariable
) )
348 case SYMBOL_TAG_BASE_TYPE
:
350 BasicType bt
= GetBasicType(&sym
);
353 s
= DumpBaseType(bt
, size
, pVariable
);
359 case SYMBOL_TAG_BASE_CLASS
:
360 s
= DumpUDT(&sym
, pVariable
, level
);
367 s
= GetSymbolName(pSym
) + _T(" = ") + s
;
374 s
= wxString(_T('\t'), level
+ 1) + s
+ _T('\n');
380 /* static */ wxString
381 wxDbgHelpDLL::DumpUDT(PSYMBOL_INFO pSym
, void *pVariable
, unsigned level
)
385 // we have to limit the depth of UDT dumping as otherwise we get in
386 // infinite loops trying to dump linked lists... 10 levels seems quite
387 // reasonable, full information is in minidump file anyhow
392 s
= GetSymbolName(pSym
);
395 // special handling for ubiquitous wxString: although the code below works
396 // for it as well, it shows the wxStringBase class and takes 4 lines
397 // instead of only one as this branch
398 if ( s
== _T("wxString") )
400 wxString
*ps
= (wxString
*)pVariable
;
402 // we can't just dump wxString directly as it could be corrupted or
403 // invalid and it could also be locked for writing (i.e. if we're
404 // between GetWriteBuf() and UngetWriteBuf() calls) and assert when we
405 // try to access it contents using public methods, so instead use our
406 // knowledge of its internals
407 const wxChar
*p
= ps
->data();
408 wxStringData
*data
= (wxStringData
*)p
- 1;
409 if ( ::IsBadReadPtr(data
, sizeof(wxStringData
)) ||
410 ::IsBadReadPtr(p
, sizeof(wxChar
*)*data
->nAllocLength
) )
415 s
<< _T("(\"") << p
<< _T(")\"");
417 else // any other UDT
420 // Determine how many children this type has.
421 DWORD dwChildrenCount
= 0;
422 DoGetTypeInfo(pSym
, TI_GET_CHILDRENCOUNT
, &dwChildrenCount
);
424 // Prepare to get an array of "TypeIds", representing each of the children.
425 TI_FINDCHILDREN_PARAMS
*children
= (TI_FINDCHILDREN_PARAMS
*)
426 malloc(sizeof(TI_FINDCHILDREN_PARAMS
) +
427 (dwChildrenCount
- 1)*sizeof(ULONG
));
431 children
->Count
= dwChildrenCount
;
434 // Get the array of TypeIds, one for each child type
435 if ( !DoGetTypeInfo(pSym
, TI_FINDCHILDREN
, children
) )
443 // Iterate through all children
446 sym
.ModBase
= pSym
->ModBase
;
447 for ( unsigned i
= 0; i
< dwChildrenCount
; i
++ )
449 sym
.TypeIndex
= children
->ChildId
[i
];
451 // children here are in lexicographic sense, i.e. we get all our nested
452 // classes and not only our member fields, but we can't get the values
453 // for the members of the nested classes, of course!
455 if ( DoGetTypeInfo(&sym
, TI_GET_NESTED
, &nested
) && nested
)
458 // avoid infinite recursion: this does seem to happen sometimes with
459 // complex typedefs...
460 if ( sym
.TypeIndex
== pSym
->TypeIndex
)
463 s
+= DumpField(&sym
, pVariable
, level
+ 1);
468 s
<< wxString(_T('\t'), level
+ 1) << _T('}');
475 wxDbgHelpDLL::SymbolTag
476 wxDbgHelpDLL::DereferenceSymbol(PSYMBOL_INFO pSym
, void **ppData
)
478 SymbolTag tag
= SYMBOL_TAG_NULL
;
481 if ( !DoGetTypeInfo(pSym
, TI_GET_SYMTAG
, &tag
) )
484 if ( tag
!= SYMBOL_TAG_POINTER_TYPE
)
488 if ( !DoGetTypeInfo(pSym
, TI_GET_TYPEID
, &tiNew
) ||
489 tiNew
== pSym
->TypeIndex
)
492 pSym
->TypeIndex
= tiNew
;
494 // remove one level of indirection except for the char strings: we want
495 // to dump "char *" and not a single "char" for them
496 if ( ppData
&& *ppData
&& GetBasicType(pSym
) != BASICTYPE_CHAR
)
498 DWORD_PTR
*pData
= (DWORD_PTR
*)*ppData
;
500 if ( ::IsBadReadPtr(pData
, sizeof(DWORD_PTR
*)) )
505 *ppData
= (void *)*pData
;
512 /* static */ wxString
513 wxDbgHelpDLL::DumpSymbol(PSYMBOL_INFO pSym
, void *pVariable
)
516 SYMBOL_INFO symDeref
= *pSym
;
517 switch ( DereferenceSymbol(&symDeref
, &pVariable
) )
520 // show UDT recursively
521 s
= DumpUDT(&symDeref
, pVariable
);
524 case SYMBOL_TAG_BASE_TYPE
:
525 // variable of simple type, show directly
526 BasicType bt
= GetBasicType(&symDeref
);
529 s
= DumpBaseType(bt
, pSym
->Size
, pVariable
);
537 // ----------------------------------------------------------------------------
539 // ----------------------------------------------------------------------------
541 // this code is very useful when debugging debughlp.dll-related code but
542 // probably not worth having compiled in normally, please do not remove it!
545 static wxString
TagString(wxDbgHelpDLL::SymbolTag tag
)
547 static const wxChar
*tags
[] =
552 _T("compiland details"),
569 _T("function arg type"),
570 _T("func debug start"),
571 _T("func debug end"),
572 _T("using namespace"),
582 wxCOMPILE_TIME_ASSERT( WXSIZEOF(tags
) == wxDbgHelpDLL::SYMBOL_TAG_MAX
,
583 SymbolTagStringMismatch
);
586 if ( tag
< WXSIZEOF(tags
) )
589 s
.Printf(_T("unrecognized tag (%d)"), tag
);
594 static wxString
KindString(wxDbgHelpDLL::DataKind kind
)
596 static const wxChar
*kinds
[] =
610 wxCOMPILE_TIME_ASSERT( WXSIZEOF(kinds
) == wxDbgHelpDLL::DATA_MAX
,
611 DataKindStringMismatch
);
614 if ( kind
< WXSIZEOF(kinds
) )
617 s
.Printf(_T("unrecognized kind (%d)"), kind
);
622 static wxString
UdtKindString(wxDbgHelpDLL::UdtKind kind
)
624 static const wxChar
*kinds
[] =
631 wxCOMPILE_TIME_ASSERT( WXSIZEOF(kinds
) == wxDbgHelpDLL::UDT_MAX
,
632 UDTKindStringMismatch
);
635 if ( kind
< WXSIZEOF(kinds
) )
638 s
.Printf(_T("unrecognized UDT (%d)"), kind
);
643 static wxString
TypeString(wxDbgHelpDLL::BasicType bt
)
645 static const wxChar
*types
[] =
681 wxCOMPILE_TIME_ASSERT( WXSIZEOF(types
) == wxDbgHelpDLL::BASICTYPE_MAX
,
682 BasicTypeStringMismatch
);
685 if ( bt
< WXSIZEOF(types
) )
689 s
.Printf(_T("unrecognized type (%d)"), bt
);
694 // this function is meant to be called from under debugger to see the
695 // proprieties of the given type id
696 extern "C" void DumpTI(ULONG ti
)
698 SYMBOL_INFO sym
= { sizeof(SYMBOL_INFO
) };
699 sym
.ModBase
= 0x400000; // it's a constant under Win32
702 wxDbgHelpDLL::SymbolTag tag
= wxDbgHelpDLL::SYMBOL_TAG_NULL
;
703 DoGetTypeInfo(&sym
, TI_GET_SYMTAG
, &tag
);
704 DoGetTypeInfo(&sym
, TI_GET_TYPEID
, &ti
);
706 OutputDebugString(wxString::Format(_T("Type 0x%x: "), sym
.TypeIndex
));
707 wxString name
= wxDbgHelpDLL::GetSymbolName(&sym
);
710 OutputDebugString(wxString::Format(_T("name=\"%s\", "), name
.c_str()));
714 if ( !DoGetTypeInfo(&sym
, TI_GET_NESTED
, &nested
) )
719 OutputDebugString(wxString::Format(_T("tag=%s%s"),
720 nested
? _T("nested ") : wxEmptyString
,
721 TagString(tag
).c_str()));
722 if ( tag
== wxDbgHelpDLL::SYMBOL_TAG_UDT
)
724 wxDbgHelpDLL::UdtKind udtKind
;
725 if ( DoGetTypeInfo(&sym
, TI_GET_UDTKIND
, &udtKind
) )
727 OutputDebugString(_T(" (") + UdtKindString(udtKind
) + _T(')'));
731 wxDbgHelpDLL::DataKind kind
= wxDbgHelpDLL::DATA_UNKNOWN
;
732 if ( DoGetTypeInfo(&sym
, TI_GET_DATAKIND
, &kind
) )
734 OutputDebugString(wxString::Format(
735 _T(", kind=%s"), KindString(kind
).c_str()));
736 if ( kind
== wxDbgHelpDLL::DATA_MEMBER
)
739 if ( DoGetTypeInfo(&sym
, TI_GET_OFFSET
, &ofs
) )
741 OutputDebugString(wxString::Format(_T(" (ofs=0x%x)"), ofs
));
746 wxDbgHelpDLL::BasicType bt
= GetBasicType(&sym
);
749 OutputDebugString(wxString::Format(_T(", type=%s"),
750 TypeString(bt
).c_str()));
753 if ( ti
!= sym
.TypeIndex
)
755 OutputDebugString(wxString::Format(_T(", next ti=0x%x"), ti
));
758 OutputDebugString(_T("\r\n"));
763 #endif // wxUSE_DBGHELP