WheatyExceptionReport Class Reference

#include "WheatyExceptionReport.h"

Public Member Functions
	WheatyExceptionReport ()
	~WheatyExceptionReport ()

Static Public Member Functions
static LONG WINAPI	WheatyUnhandledExceptionFilter (PEXCEPTION_POINTERS pExceptionInfo)
static void __cdecl	WheatyCrtHandler (wchar_t const *expression, wchar_t const *function, wchar_t const *file, unsigned int line, uintptr_t pReserved)
static void	printTracesForAllThreads (bool)

Private Types
typedef NTSTATUS(NTAPI *	pRtlGetVersion) (PRTL_OSVERSIONINFOW lpVersionInformation)

Static Private Member Functions
static void	GenerateExceptionReport (PEXCEPTION_POINTERS pExceptionInfo)
static void	PrintSystemInfo ()
static BOOL	_GetWindowsVersion (TCHAR *szVersion, DWORD cntMax)
static BOOL	_GetProcessorName (TCHAR *sProcessorName, DWORD maxcount)
static LPTSTR	GetExceptionString (DWORD dwCode)
static BOOL	GetLogicalAddress (PVOID addr, PTSTR szModule, DWORD len, DWORD &section, DWORD_PTR &offset)
static void	WriteStackDetails (PCONTEXT pContext, bool bWriteVariables, HANDLE pThreadHandle)
static BOOL CALLBACK	EnumerateSymbolsCallback (PSYMBOL_INFO, ULONG, PVOID)
static bool	FormatSymbolValue (PSYMBOL_INFO, STACKFRAME64 *)
static void	DumpTypeIndex (DWORD64, DWORD, DWORD_PTR, bool &, char const *, char *, bool, bool)
static void	FormatOutputValue (char *pszCurrBuffer, BasicType basicType, DWORD64 length, PVOID pAddress, std::size_t bufferSize, std::size_t countOverride=0)
static BasicType	GetBasicType (DWORD typeIndex, DWORD64 modBase)
static DWORD_PTR	DereferenceUnsafePointer (DWORD_PTR address)
static int __cdecl	Log (const TCHAR *format,...)
static int __cdecl	StackLog (const TCHAR *format, va_list argptr)
static int __cdecl	HeapLog (const TCHAR *format, va_list argptr)
static bool	StoreSymbol (DWORD type, DWORD_PTR offset)
static void	ClearSymbols ()
static void	PushSymbolDetail ()
static void	PopSymbolDetail ()
static void	PrintSymbolDetail ()

Static Private Attributes
static TCHAR	m_szLogFileName [MAX_PATH]
static TCHAR	m_szDumpFileName [MAX_PATH]
static LPTOP_LEVEL_EXCEPTION_FILTER	m_previousFilter
static _invalid_parameter_handler	m_previousCrtHandler
static HANDLE	m_hReportFile
static HANDLE	m_hDumpFile
static HANDLE	m_hProcess
static SymbolPairs	symbols
static std::stack< SymbolDetail >	symbolDetails
static bool	stackOverflowException
static bool	alreadyCrashed
static std::mutex	alreadyCrashedLock
static pRtlGetVersion	RtlGetVersion

Detailed Description

Member Typedef Documentation

pRtlGetVersion

typedef NTSTATUS(NTAPI * WheatyExceptionReport::pRtlGetVersion) (PRTL_OSVERSIONINFOW lpVersionInformation)

private

Constructor & Destructor Documentation

WheatyExceptionReport()

WheatyExceptionReport::WheatyExceptionReport

(

)

{
    // Install the unhandled exception filter function
    m_previousFilter = SetUnhandledExceptionFilter(WheatyUnhandledExceptionFilter);
    m_previousCrtHandler = _set_invalid_parameter_handler(WheatyCrtHandler);
    m_hProcess = GetCurrentProcess();
    stackOverflowException = false;
    alreadyCrashed = false;
    RtlGetVersion = (pRtlGetVersion)GetProcAddress(GetModuleHandle(_T("ntdll.dll")), "RtlGetVersion");
    if (!IsDebuggerPresent())
    {
        _CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_FILE);
        _CrtSetReportFile(_CRT_ERROR, _CRTDBG_FILE_STDERR);
        _CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_FILE);
        _CrtSetReportFile(_CRT_ASSERT, _CRTDBG_FILE_STDERR);
    }
}

References alreadyCrashed, m_hProcess, m_previousCrtHandler, m_previousFilter, RtlGetVersion, stackOverflowException, WheatyCrtHandler(), and WheatyUnhandledExceptionFilter().

~WheatyExceptionReport()

WheatyExceptionReport::~WheatyExceptionReport

(

)

{
    if (m_previousFilter)
    {
        SetUnhandledExceptionFilter(m_previousFilter);
    }
    if (m_previousCrtHandler)
    {
        _set_invalid_parameter_handler(m_previousCrtHandler);
    }
    ClearSymbols();
}

References ClearSymbols(), m_previousCrtHandler, and m_previousFilter.

Member Function Documentation

_GetProcessorName()

BOOL WheatyExceptionReport::_GetProcessorName ( TCHAR *  sProcessorName, DWORD  maxcount  )

staticprivate

{
    if (!sProcessorName)
    {
        return FALSE;
    }
 
    HKEY hKey;
    LONG lRet;
    lRet = ::RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0"),
                          0, KEY_QUERY_VALUE, &hKey);
    if (lRet != ERROR_SUCCESS)
    {
        return FALSE;
    }
    TCHAR szTmp[2048];
    DWORD cntBytes = sizeof(szTmp);
    lRet = ::RegQueryValueEx(hKey, _T("ProcessorNameString"), nullptr, nullptr,
                             (LPBYTE)szTmp, &cntBytes);
    if (lRet != ERROR_SUCCESS)
    {
        return FALSE;
    }
    ::RegCloseKey(hKey);
    sProcessorName[0] = '\0';
    // Skip spaces
    TCHAR* psz = szTmp;
    while (iswspace(*psz))
    {
        ++psz;
    }
    _tcsncpy(sProcessorName, psz, maxcount);
    return TRUE;
}

Referenced by PrintSystemInfo().

_GetWindowsVersion()

BOOL WheatyExceptionReport::_GetWindowsVersion ( TCHAR *  szVersion, DWORD  cntMax  )

staticprivate

{
    // Try calling GetVersionEx using the OSVERSIONINFOEX structure.
    // If that fails, try using the OSVERSIONINFO structure.
    RTL_OSVERSIONINFOEXW osvi = { 0 };
    osvi.dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
    NTSTATUS bVersionEx = RtlGetVersion((PRTL_OSVERSIONINFOW)&osvi);
    if (bVersionEx < 0)
    {
        osvi.dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOW);
        if (!RtlGetVersion((PRTL_OSVERSIONINFOW)&osvi))
        {
            return FALSE;
        }
    }
    *szVersion = _T('\0');
 
    TCHAR szCSDVersion[256];
    ToTchar(osvi.szCSDVersion, szCSDVersion, std::is_same<TCHAR, char>::type());
 
    TCHAR wszTmp[128];
    switch (osvi.dwPlatformId)
    {
        // Windows NT product family.
        case VER_PLATFORM_WIN32_NT:
        {
#if WINVER < 0x0500
            BYTE suiteMask = osvi.wReserved[0];
            BYTE productType = osvi.wReserved[1];
#else
            WORD suiteMask = osvi.wSuiteMask;
            BYTE productType = osvi.wProductType;
#endif                                          // WINVER < 0x0500
 
            // Test for the specific product family.
            if (osvi.dwMajorVersion == 10)
            {
                if (productType == VER_NT_WORKSTATION)
                {
                    _tcsncat(szVersion, _T("Windows 10 "), cntMax);
                }
                else
                {
                    _tcsncat(szVersion, _T("Windows Server 2016 "), cntMax);
                }
            }
            else if (osvi.dwMajorVersion == 6)
            {
                if (productType == VER_NT_WORKSTATION)
                {
                    if (osvi.dwMinorVersion == 3)
                    {
                        _tcsncat(szVersion, _T("Windows 8.1 "), cntMax);
                    }
                    else if (osvi.dwMinorVersion == 2)
                    {
                        _tcsncat(szVersion, _T("Windows 8 "), cntMax);
                    }
                    else if (osvi.dwMinorVersion == 1)
                    {
                        _tcsncat(szVersion, _T("Windows 7 "), cntMax);
                    }
                    else
                    {
                        _tcsncat(szVersion, _T("Windows Vista "), cntMax);
                    }
                }
                else if (osvi.dwMinorVersion == 3)
                {
                    _tcsncat(szVersion, _T("Windows Server 2012 R2 "), cntMax);
                }
                else if (osvi.dwMinorVersion == 2)
                {
                    _tcsncat(szVersion, _T("Windows Server 2012 "), cntMax);
                }
                else if (osvi.dwMinorVersion == 1)
                {
                    _tcsncat(szVersion, _T("Windows Server 2008 R2 "), cntMax);
                }
                else
                {
                    _tcsncat(szVersion, _T("Windows Server 2008 "), cntMax);
                }
            }
            else if (osvi.dwMajorVersion == 5 && osvi.dwMinorVersion == 2)
            {
                _tcsncat(szVersion, _T("Microsoft Windows Server 2003 "), cntMax);
            }
            else if (osvi.dwMajorVersion == 5 && osvi.dwMinorVersion == 1)
            {
                _tcsncat(szVersion, _T("Microsoft Windows XP "), cntMax);
            }
            else if (osvi.dwMajorVersion == 5 && osvi.dwMinorVersion == 0)
            {
                _tcsncat(szVersion, _T("Microsoft Windows 2000 "), cntMax);
            }
            else if (osvi.dwMajorVersion <= 4)
            {
                _tcsncat(szVersion, _T("Microsoft Windows NT "), cntMax);
            }
 
            // Test for specific product on Windows NT 4.0 SP6 and later.
            if (bVersionEx >= 0)
            {
                // Test for the workstation type.
                if (productType == VER_NT_WORKSTATION)
                {
                    if (osvi.dwMajorVersion == 4)
                    {
                        _tcsncat(szVersion, _T("Workstation 4.0 "), cntMax);
                    }
                    else if (suiteMask & VER_SUITE_PERSONAL)
                    {
                        _tcsncat(szVersion, _T("Home Edition "), cntMax);
                    }
                    else if (suiteMask & VER_SUITE_EMBEDDEDNT)
                    {
                        _tcsncat(szVersion, _T("Embedded "), cntMax);
                    }
                    else
                    {
                        _tcsncat(szVersion, _T("Professional "), cntMax);
                    }
                }
                // Test for the server type.
                else if (productType == VER_NT_SERVER)
                {
                    if (osvi.dwMajorVersion == 6 || osvi.dwMajorVersion == 10)
                    {
                        if (suiteMask & VER_SUITE_SMALLBUSINESS_RESTRICTED)
                        {
                            _tcsncat(szVersion, _T("Essentials "), cntMax);
                        }
                        else if (suiteMask & VER_SUITE_DATACENTER)
                        {
                            _tcsncat(szVersion, _T("Datacenter "), cntMax);
                        }
                        else if (suiteMask & VER_SUITE_ENTERPRISE)
                        {
                            _tcsncat(szVersion, _T("Enterprise "), cntMax);
                        }
                        else
                        {
                            _tcsncat(szVersion, _T("Standard "), cntMax);
                        }
                    }
                    else if (osvi.dwMajorVersion == 5 && osvi.dwMinorVersion == 2)
                    {
                        if (suiteMask & VER_SUITE_DATACENTER)
                        {
                            _tcsncat(szVersion, _T("Datacenter Edition "), cntMax);
                        }
                        else if (suiteMask & VER_SUITE_ENTERPRISE)
                        {
                            _tcsncat(szVersion, _T("Enterprise Edition "), cntMax);
                        }
                        else if (suiteMask == VER_SUITE_BLADE)
                        {
                            _tcsncat(szVersion, _T("Web Edition "), cntMax);
                        }
                        else
                        {
                            _tcsncat(szVersion, _T("Standard Edition "), cntMax);
                        }
                    }
                    else if (osvi.dwMajorVersion == 5 && osvi.dwMinorVersion == 0)
                    {
                        if (suiteMask & VER_SUITE_DATACENTER)
                        {
                            _tcsncat(szVersion, _T("Datacenter Server "), cntMax);
                        }
                        else if (suiteMask & VER_SUITE_ENTERPRISE)
                        {
                            _tcsncat(szVersion, _T("Advanced Server "), cntMax);
                        }
                        else
                        {
                            _tcsncat(szVersion, _T("Server "), cntMax);
                        }
                    }
                    else                                        // Windows NT 4.0
                    {
                        if (suiteMask & VER_SUITE_ENTERPRISE)
                        {
                            _tcsncat(szVersion, _T("Server 4.0, Enterprise Edition "), cntMax);
                        }
                        else
                        {
                            _tcsncat(szVersion, _T("Server 4.0 "), cntMax);
                        }
                    }
                }
            }
 
            // Display service pack (if any) and build number.
            if (osvi.dwMajorVersion == 4 && _tcsicmp(szCSDVersion, _T("Service Pack 6")) == 0)
            {
                HKEY hKey;
                LONG lRet;
 
                // Test for SP6 versus SP6a.
                lRet = ::RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Hotfix\\Q246009"), 0, KEY_QUERY_VALUE, &hKey);
                if (lRet == ERROR_SUCCESS)
                {
                    _stprintf(wszTmp, _T("Service Pack 6a (Version %d.%d, Build %d)"),
                              osvi.dwMajorVersion, osvi.dwMinorVersion, osvi.dwBuildNumber & 0xFFFF);
                    _tcsncat(szVersion, wszTmp, cntMax);
                }
                else                                            // Windows NT 4.0 prior to SP6a
                {
                    _stprintf(wszTmp, _T("%s (Version %d.%d, Build %d)"),
                              szCSDVersion, osvi.dwMajorVersion, osvi.dwMinorVersion, osvi.dwBuildNumber & 0xFFFF);
                    _tcsncat(szVersion, wszTmp, cntMax);
                }
                ::RegCloseKey(hKey);
            }
            else                                                // Windows NT 3.51 and earlier or Windows 2000 and later
            {
                if (!_tcslen(szCSDVersion))
                    _stprintf(wszTmp, _T("(Version %d.%d, Build %d)"),
                              osvi.dwMajorVersion, osvi.dwMinorVersion, osvi.dwBuildNumber & 0xFFFF);
                else
                    _stprintf(wszTmp, _T("%s (Version %d.%d, Build %d)"),
                              szCSDVersion, osvi.dwMajorVersion, osvi.dwMinorVersion, osvi.dwBuildNumber & 0xFFFF);
                _tcsncat(szVersion, wszTmp, cntMax);
            }
            break;
        }
        default:
            _stprintf(wszTmp, _T("%s (Version %d.%d, Build %d)"),
                      szCSDVersion, osvi.dwMajorVersion, osvi.dwMinorVersion, osvi.dwBuildNumber & 0xFFFF);
            _tcsncat(szVersion, wszTmp, cntMax);
            break;
    }
 
    return TRUE;
}

References RtlGetVersion, and ToTchar().

Referenced by PrintSystemInfo().

ClearSymbols()

void WheatyExceptionReport::ClearSymbols ( )

staticprivate

{
    symbols.clear();
    while (!symbolDetails.empty())
    {
        symbolDetails.pop();
    }
}

References symbolDetails, and symbols.

Referenced by EnumerateSymbolsCallback(), and ~WheatyExceptionReport().

DereferenceUnsafePointer()

DWORD_PTR WheatyExceptionReport::DereferenceUnsafePointer ( DWORD_PTR  address )

staticprivate

{
    __try
    {
        return *(PDWORD_PTR)address;
    }
    __except (EXCEPTION_EXECUTE_HANDLER)
    {
        return DWORD_PTR(-1);
    }
}

Referenced by DumpTypeIndex().

DumpTypeIndex()

void WheatyExceptionReport::DumpTypeIndex ( DWORD64  modBase, DWORD  dwTypeIndex, DWORD_PTR  offset, bool &  bHandled, char const *  Name, char *  , bool  newSymbol, bool  logChildren  )

staticprivate

{
    bHandled = false;
 
    if (newSymbol)
    {
        PushSymbolDetail();
    }
 
    DWORD typeTag;
    if (!SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_SYMTAG, &typeTag))
    {
        return;
    }
 
    // Get the name of the symbol.  This will either be a Type name (if a UDT),
    // or the structure member name.
    WCHAR* pwszTypeName;
    if (SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_SYMNAME,
                       &pwszTypeName))
    {
        // handle special cases
        if (wcscmp(pwszTypeName, L"std::basic_string<char,std::char_traits<char>,std::allocator<char> >") == 0)
        {
            LocalFree(pwszTypeName);
            symbolDetails.top().Type = "std::string";
            char buffer[50];
            FormatOutputValue(buffer, btStdString, 0, (PVOID)offset, sizeof(buffer));
            symbolDetails.top().Value = buffer;
            if (Name != nullptr && Name[0] != '\0')
            {
                symbolDetails.top().Name = Name;
            }
            bHandled = true;
            return;
        }
 
        char buffer[WER_SMALL_BUFFER_SIZE];
        wcstombs(buffer, pwszTypeName, sizeof(buffer));
        buffer[WER_SMALL_BUFFER_SIZE - 1] = '\0';
        if (Name != nullptr && Name[0] != '\0')
        {
            symbolDetails.top().Type = buffer;
            symbolDetails.top().Name = Name;
        }
        else if (buffer[0] != '\0')
        {
            symbolDetails.top().Name = buffer;
        }
 
        LocalFree(pwszTypeName);
    }
    else if (Name != nullptr && Name[0] != '\0')
    {
        symbolDetails.top().Name = Name;
    }
 
    if (!StoreSymbol(dwTypeIndex, offset))
    {
        // Skip printing address and base class if it has been printed already
        if (typeTag == SymTagBaseClass)
        {
            bHandled = true;
        }
        return;
    }
 
    DWORD innerTypeID;
    switch (typeTag)
    {
        case SymTagPointerType:
            if (SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_TYPEID, &innerTypeID))
            {
                if (Name != nullptr && Name[0] != '\0')
                {
                    symbolDetails.top().Name = Name;
                }
 
                BOOL isReference;
                SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_IS_REFERENCE, &isReference);
 
                char addressStr[40];
                memset(addressStr, 0, sizeof(addressStr));
 
                if (isReference)
                {
                    symbolDetails.top().Suffix += "&";
                }
                else
                {
                    symbolDetails.top().Suffix += "*";
                }
 
                // Try to dereference the pointer in a try/except block since it might be invalid
                DWORD_PTR address = DereferenceUnsafePointer(offset);
 
                char buffer[WER_SMALL_BUFFER_SIZE];
                FormatOutputValue(buffer, btVoid, sizeof(PVOID), (PVOID)offset, sizeof(buffer));
                symbolDetails.top().Value = buffer;
 
                if (symbolDetails.size() >= WER_MAX_NESTING_LEVEL)
                {
                    logChildren = false;
                }
 
                // no need to log any children since the address is invalid anyway
                if (address == NULL || address == DWORD_PTR(-1))
                {
                    logChildren = false;
                }
 
                DumpTypeIndex(modBase, innerTypeID, address, bHandled, Name, addressStr, false, logChildren);
 
                if (!bHandled)
                {
                    BasicType basicType = GetBasicType(dwTypeIndex, modBase);
                    if (symbolDetails.top().Type.empty())
                    {
                        symbolDetails.top().Type = rgBaseType[basicType];
                    }
 
                    if (address == NULL)
                    {
                        symbolDetails.top().Value = "NULL";
                    }
                    else if (address == DWORD_PTR(-1))
                    {
                        symbolDetails.top().Value = "<Unable to read memory>";
                    }
                    else
                    {
                        // Get the size of the child member
                        ULONG64 length;
                        SymGetTypeInfo(m_hProcess, modBase, innerTypeID, TI_GET_LENGTH, &length);
                        char buffer2[50];
                        FormatOutputValue(buffer2, basicType, length, (PVOID)address, sizeof(buffer2));
                        symbolDetails.top().Value = buffer2;
                    }
                    bHandled = true;
                    return;
                }
                else if (address == NULL)
                {
                    symbolDetails.top().Value = "NULL";
                }
                else if (address == DWORD_PTR(-1))
                {
                    symbolDetails.top().Value = "<Unable to read memory>";
                    bHandled = true;
                    return;
                }
            }
            break;
        case SymTagData:
            if (SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_TYPEID, &innerTypeID))
            {
                DWORD innerTypeTag;
                if (!SymGetTypeInfo(m_hProcess, modBase, innerTypeID, TI_GET_SYMTAG, &innerTypeTag))
                {
                    break;
                }
 
                switch (innerTypeTag)
                {
                    case SymTagUDT:
                        if (symbolDetails.size() >= WER_MAX_NESTING_LEVEL)
                        {
                            logChildren = false;
                        }
                        DumpTypeIndex(modBase, innerTypeID,
                                      offset, bHandled, symbolDetails.top().Name.c_str(), (char*)"", false, logChildren);
                        break;
                    case SymTagPointerType:
                        if (Name != nullptr && Name[0] != '\0')
                        {
                            symbolDetails.top().Name = Name;
                        }
                        DumpTypeIndex(modBase, innerTypeID,
                                      offset, bHandled, symbolDetails.top().Name.c_str(), (char*)"", false, logChildren);
                        break;
                    case SymTagArrayType:
                        DumpTypeIndex(modBase, innerTypeID,
                                      offset, bHandled, symbolDetails.top().Name.c_str(), (char*)"", false, logChildren);
                        break;
                    default:
                        break;
                }
            }
            break;
        case SymTagArrayType:
            if (SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_TYPEID, &innerTypeID))
            {
                symbolDetails.top().HasChildren = true;
 
                BasicType basicType = btNoType;
                DumpTypeIndex(modBase, innerTypeID,
                              offset, bHandled, Name, (char*)"", false, false);
 
                // Set Value back to an empty string since the Array object itself has no value, only its elements have
                std::string firstElementValue = symbolDetails.top().Value;
                symbolDetails.top().Value.clear();
 
                DWORD elementsCount;
                if (SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_COUNT, &elementsCount))
                {
                    symbolDetails.top().Suffix += "[" + std::to_string(elementsCount) + "]";
                }
                else
                {
                    symbolDetails.top().Suffix += "[<unknown count>]";
                }
 
                if (!bHandled)
                {
                    basicType = GetBasicType(dwTypeIndex, modBase);
                    if (symbolDetails.top().Type.empty())
                    {
                        symbolDetails.top().Type = rgBaseType[basicType];
                    }
                    bHandled = true;
                }
 
                // Get the size of the child member
                ULONG64 length;
                SymGetTypeInfo(m_hProcess, modBase, innerTypeID, TI_GET_LENGTH, &length);
 
                char buffer[50];
                switch (basicType)
                {
                    case btChar:
                    case btStdString:
                        FormatOutputValue(buffer, basicType, length, (PVOID)offset, sizeof(buffer), elementsCount);
                        symbolDetails.top().Value = buffer;
                        break;
                    default:
                        for (DWORD index = 0; index < elementsCount && index < WER_MAX_ARRAY_ELEMENTS_COUNT; index++)
                        {
                            bool elementHandled = false;
                            PushSymbolDetail();
                            if (index == 0)
                            {
                                if (firstElementValue.empty())
                                {
                                    FormatOutputValue(buffer, basicType, length, (PVOID)(offset + length * index), sizeof(buffer));
                                    firstElementValue = buffer;
                                }
                                symbolDetails.top().Value = firstElementValue;
                            }
                            else
                            {
                                DumpTypeIndex(modBase, innerTypeID, offset + length * index, elementHandled, "", (char*)"", false, false);
                                if (!elementHandled)
                                {
                                    FormatOutputValue(buffer, basicType, length, (PVOID)(offset + length * index), sizeof(buffer));
                                    symbolDetails.top().Value = buffer;
                                }
                            }
                            symbolDetails.top().Prefix.clear();
                            symbolDetails.top().Type.clear();
                            symbolDetails.top().Suffix = "[" + std::to_string(index) + "]";
                            symbolDetails.top().Name.clear();
                            PopSymbolDetail();
                        }
                        break;
                }
 
                return;
            }
            break;
        case SymTagBaseType:
            break;
        case SymTagEnum:
            return;
        default:
            break;
    }
 
    // Determine how many children this type has.
    DWORD dwChildrenCount = 0;
    SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_GET_CHILDRENCOUNT, &dwChildrenCount);
 
    if (!dwChildrenCount)                                 // If no children, we're done
    {
        return;
    }
 
    // Prepare to get an array of "TypeIds", representing each of the children.
    // SymGetTypeInfo(TI_FINDCHILDREN) expects more memory than just a
    // TI_FINDCHILDREN_PARAMS struct has.  Use derivation to accomplish this.
    struct FINDCHILDREN : TI_FINDCHILDREN_PARAMS
    {
        ULONG   MoreChildIds[1024 * 2];
        FINDCHILDREN() {Count = sizeof(MoreChildIds) / sizeof(MoreChildIds[0]);}
    } children;
 
    children.Count = dwChildrenCount;
    children.Start = 0;
 
    // Get the array of TypeIds, one for each child type
    if (!SymGetTypeInfo(m_hProcess, modBase, dwTypeIndex, TI_FINDCHILDREN,
                        &children))
    {
        return;
    }
 
    // Iterate through each of the children
    for (unsigned i = 0; i < dwChildrenCount; i++)
    {
        DWORD symTag;
        SymGetTypeInfo(m_hProcess, modBase, children.ChildId[i], TI_GET_SYMTAG, &symTag);
 
        if (symTag == SymTagFunction ||
                symTag == SymTagEnum ||
                symTag == SymTagTypedef ||
                symTag == SymTagVTable)
        {
            continue;
        }
 
        // Ignore static fields
        DWORD dataKind;
        SymGetTypeInfo(m_hProcess, modBase, children.ChildId[i], TI_GET_DATAKIND, &dataKind);
        if (dataKind == DataIsStaticLocal ||
                dataKind == DataIsGlobal ||
                dataKind == DataIsStaticMember)
        {
            continue;
        }
 
        symbolDetails.top().HasChildren = true;
        if (!logChildren)
        {
            bHandled = false;
            return;
        }
 
        // Recurse for each of the child types
        bool bHandled2;
        BasicType basicType = GetBasicType(children.ChildId[i], modBase);
 
        // Get the offset of the child member, relative to its parent
        DWORD dwMemberOffset;
        SymGetTypeInfo(m_hProcess, modBase, children.ChildId[i],
                       TI_GET_OFFSET, &dwMemberOffset);
 
        // Calculate the address of the member
        DWORD_PTR dwFinalOffset = offset + dwMemberOffset;
 
        DumpTypeIndex(modBase,
                      children.ChildId[i],
                      dwFinalOffset, bHandled2, ""/*Name */, (char*)"", true, true);
 
        // If the child wasn't a UDT, format it appropriately
        if (!bHandled2)
        {
            if (symbolDetails.top().Type.empty())
            {
                symbolDetails.top().Type = rgBaseType[basicType];
            }
 
            // Get the real "TypeId" of the child.  We need this for the
            // SymGetTypeInfo(TI_GET_TYPEID) call below.
            DWORD typeId;
            SymGetTypeInfo(m_hProcess, modBase, children.ChildId[i],
                           TI_GET_TYPEID, &typeId);
 
            // Get the size of the child member
            ULONG64 length;
            SymGetTypeInfo(m_hProcess, modBase, typeId, TI_GET_LENGTH, &length);
 
            char buffer[50];
            FormatOutputValue(buffer, basicType, length, (PVOID)dwFinalOffset, sizeof(buffer));
            symbolDetails.top().Value = buffer;
        }
 
        PopSymbolDetail();
    }
 
    bHandled = true;
    return;
}

References btChar, btNoType, btStdString, btVoid, DataIsGlobal, DataIsStaticLocal, DataIsStaticMember, DereferenceUnsafePointer(), DumpTypeIndex(), FormatOutputValue(), GetBasicType(), m_hProcess, PopSymbolDetail(), PushSymbolDetail(), rgBaseType, StoreSymbol(), symbolDetails, WER_MAX_ARRAY_ELEMENTS_COUNT, WER_MAX_NESTING_LEVEL, and WER_SMALL_BUFFER_SIZE.

Referenced by DumpTypeIndex(), and FormatSymbolValue().

EnumerateSymbolsCallback()

BOOL CALLBACK WheatyExceptionReport::EnumerateSymbolsCallback ( PSYMBOL_INFO  pSymInfo, ULONG  , PVOID  UserContext  )

staticprivate

{
    __try
    {
        ClearSymbols();
        FormatSymbolValue(pSymInfo, (STACKFRAME64*)UserContext);
    }
    __except (EXCEPTION_EXECUTE_HANDLER)
    {
        Log(_T("punting on symbol %s, partial output:\r\n"), pSymInfo->Name);
    }
 
    return TRUE;
}

References ClearSymbols(), and FormatSymbolValue().

Referenced by WriteStackDetails().

FormatOutputValue()

void WheatyExceptionReport::FormatOutputValue ( char *  pszCurrBuffer, BasicType  basicType, DWORD64  length, PVOID  pAddress, std::size_t  bufferSize, std::size_t  countOverride = 0  )

staticprivate

{
    __try
    {
        switch (basicType)
        {
            case btChar:
            {
                // Special case handling for char[] type
                if (countOverride != 0)
                {
                    length = countOverride;
                }
                else
                {
                    length = strlen((char*)pAddress);
                }
                if (length > bufferSize - 6)
                {
                    pszCurrBuffer += sprintf(pszCurrBuffer, "\"%.*s...\"", (DWORD)(bufferSize - 6), (char*)pAddress);
                }
                else
                {
                    pszCurrBuffer += sprintf(pszCurrBuffer, "\"%.*s\"", (DWORD)length, (char*)pAddress);
                }
                break;
            }
            case btStdString:
            {
                std::string* value = static_cast<std::string*>(pAddress);
                if (value->length() > bufferSize - 6)
                {
                    pszCurrBuffer += sprintf(pszCurrBuffer, "\"%.*s...\"", (DWORD)(bufferSize - 6), value->c_str());
                }
                else
                {
                    pszCurrBuffer += sprintf(pszCurrBuffer, "\"%s\"", value->c_str());
                }
                break;
            }
            default:
                // Format appropriately (assuming it's a 1, 2, or 4 bytes (!!!)
                if (length == 1)
                {
                    pszCurrBuffer += sprintf(pszCurrBuffer, "0x%X", *(PBYTE)pAddress);
                }
                else if (length == 2)
                {
                    pszCurrBuffer += sprintf(pszCurrBuffer, "0x%X", *(PWORD)pAddress);
                }
                else if (length == 4)
                {
                    if (basicType == btFloat)
                    {
                        pszCurrBuffer += sprintf(pszCurrBuffer, "%f", *(PFLOAT)pAddress);
                    }
                    else
                    {
                        pszCurrBuffer += sprintf(pszCurrBuffer, "0x%X", *(PDWORD)pAddress);
                    }
                }
                else if (length == 8)
                {
                    if (basicType == btFloat)
                    {
                        pszCurrBuffer += sprintf(pszCurrBuffer, "%f",
                                                 *(double*)pAddress);
                    }
                    else
                        pszCurrBuffer += sprintf(pszCurrBuffer, "0x%I64X",
                                                 *(DWORD64*)pAddress);
                }
                else
                {
#if _WIN64
                    pszCurrBuffer += sprintf(pszCurrBuffer, "0x%I64X", (DWORD64)pAddress);
#else
                    pszCurrBuffer += sprintf(pszCurrBuffer, "0x%X", (DWORD)pAddress);
#endif
                }
                break;
        }
    }
    __except (EXCEPTION_EXECUTE_HANDLER)
    {
#if _WIN64
        pszCurrBuffer += sprintf(pszCurrBuffer, "0x%I64X <Unable to read memory>", (DWORD64)pAddress);
#else
        pszCurrBuffer += sprintf(pszCurrBuffer, "0x%X <Unable to read memory>", (DWORD)pAddress);
#endif
    }
}

References btChar, btFloat, btStdString, and bufferSize.

Referenced by DumpTypeIndex(), and FormatSymbolValue().

FormatSymbolValue()

bool WheatyExceptionReport::FormatSymbolValue ( PSYMBOL_INFO  pSym, STACKFRAME64 *  sf  )

staticprivate

{
    // If it's a function, don't do anything.
    if (pSym->Tag == SymTagFunction)                      // SymTagFunction from CVCONST.H from the DIA SDK
    {
        return false;
    }
 
    DWORD_PTR pVariable = 0;                                // Will point to the variable's data in memory
 
    if (pSym->Flags & IMAGEHLP_SYMBOL_INFO_REGRELATIVE)
    {
        // if (pSym->Register == 8)   // EBP is the value 8 (in DBGHELP 5.1)
        {
            //  This may change!!!
#ifdef _M_IX86
            pVariable = sf->AddrFrame.Offset;
#elif _M_X64
            pVariable = sf->AddrStack.Offset;
#endif
            pVariable += (DWORD_PTR)pSym->Address;
        }
        // else
        //  return false;
    }
    else if (pSym->Flags & IMAGEHLP_SYMBOL_INFO_REGISTER)
    {
        return false;    // Don't try to report register variable
    }
    else
    {
        pVariable = (DWORD_PTR)pSym->Address;               // It must be a global variable
    }
 
    PushSymbolDetail();
 
    // Indicate if the variable is a local or parameter
    if (pSym->Flags & IMAGEHLP_SYMBOL_INFO_PARAMETER)
    {
        symbolDetails.top().Prefix = "Parameter ";
    }
    else if (pSym->Flags & IMAGEHLP_SYMBOL_INFO_LOCAL)
    {
        symbolDetails.top().Prefix = "Local ";
    }
 
    // Determine if the variable is a user defined type (UDT).  IF so, bHandled
    // will return true.
    bool bHandled;
    DumpTypeIndex(pSym->ModBase, pSym->TypeIndex, pVariable, bHandled, pSym->Name, (char*)"", false, true);
 
    if (!bHandled)
    {
        // The symbol wasn't a UDT, so do basic, stupid formatting of the
        // variable.  Based on the size, we're assuming it's a char, WORD, or
        // DWORD.
        BasicType basicType = GetBasicType(pSym->TypeIndex, pSym->ModBase);
        if (symbolDetails.top().Type.empty())
        {
            symbolDetails.top().Type = rgBaseType[basicType];
        }
 
        // Emit the variable name
        if (pSym->Name[0] != '\0')
        {
            symbolDetails.top().Name = pSym->Name;
        }
 
        char buffer[50];
        FormatOutputValue(buffer, basicType, pSym->Size, (PVOID)pVariable, sizeof(buffer));
        symbolDetails.top().Value = buffer;
    }
 
    PopSymbolDetail();
    return true;
}

References DumpTypeIndex(), FormatOutputValue(), GetBasicType(), PopSymbolDetail(), PushSymbolDetail(), rgBaseType, and symbolDetails.

Referenced by EnumerateSymbolsCallback().

GenerateExceptionReport()

void WheatyExceptionReport::GenerateExceptionReport ( PEXCEPTION_POINTERS  pExceptionInfo )

staticprivate

{
    __try
    {
        SYSTEMTIME systime;
        GetLocalTime(&systime);
 
        // Start out with a banner
        Log(_T("Revision: %s\r\n"), GitRevision::GetFullVersion());
        Log(_T("Date %u:%u:%u. Time %u:%u \r\n"), systime.wDay, systime.wMonth, systime.wYear, systime.wHour, systime.wMinute);
        PEXCEPTION_RECORD pExceptionRecord = pExceptionInfo->ExceptionRecord;
 
        PrintSystemInfo();
        // First print information about the type of fault
        Log(_T("\r\n//=====================================================\r\n"));
        Log(_T("Exception code: %08X %s\r\n"),
            pExceptionRecord->ExceptionCode,
            GetExceptionString(pExceptionRecord->ExceptionCode));
        if (pExceptionRecord->ExceptionCode == EXCEPTION_ASSERTION_FAILURE && pExceptionRecord->NumberParameters >= 2)
        {
            pExceptionRecord->ExceptionAddress = reinterpret_cast<PVOID>(pExceptionRecord->ExceptionInformation[1]);
            Log(_T("Assertion message: %s\r\n"), pExceptionRecord->ExceptionInformation[0]);
        }
 
        // Now print information about where the fault occured
        TCHAR szFaultingModule[MAX_PATH];
        DWORD section;
        DWORD_PTR offset;
        GetLogicalAddress(pExceptionRecord->ExceptionAddress,
                          szFaultingModule,
                          sizeof(szFaultingModule),
                          section, offset);
 
#ifdef _M_IX86
        Log(_T("Fault address:  %08X %02X:%08X %s\r\n"),
            pExceptionRecord->ExceptionAddress,
            section, offset, szFaultingModule);
#endif
#ifdef _M_X64
        Log(_T("Fault address:  %016I64X %02X:%016I64X %s\r\n"),
            pExceptionRecord->ExceptionAddress,
            section, offset, szFaultingModule);
#endif
 
        PCONTEXT pCtx = pExceptionInfo->ContextRecord;
 
        // Show the registers
#ifdef _M_IX86                                          // X86 Only!
        Log(_T("\r\nRegisters:\r\n"));
 
        Log(_T("EAX:%08X\r\nEBX:%08X\r\nECX:%08X\r\nEDX:%08X\r\nESI:%08X\r\nEDI:%08X\r\n")
            , pCtx->Eax, pCtx->Ebx, pCtx->Ecx, pCtx->Edx,
            pCtx->Esi, pCtx->Edi);
 
        Log(_T("CS:EIP:%04X:%08X\r\n"), pCtx->SegCs, pCtx->Eip);
        Log(_T("SS:ESP:%04X:%08X  EBP:%08X\r\n"),
            pCtx->SegSs, pCtx->Esp, pCtx->Ebp);
        Log(_T("DS:%04X  ES:%04X  FS:%04X  GS:%04X\r\n"),
            pCtx->SegDs, pCtx->SegEs, pCtx->SegFs, pCtx->SegGs);
        Log(_T("Flags:%08X\r\n"), pCtx->EFlags);
#endif
 
#ifdef _M_X64
        Log(_T("\r\nRegisters:\r\n"));
        Log(_T("RAX:%016I64X\r\nRBX:%016I64X\r\nRCX:%016I64X\r\nRDX:%016I64X\r\nRSI:%016I64X\r\nRDI:%016I64X\r\n")
            _T("R8: %016I64X\r\nR9: %016I64X\r\nR10:%016I64X\r\nR11:%016I64X\r\nR12:%016I64X\r\nR13:%016I64X\r\nR14:%016I64X\r\nR15:%016I64X\r\n")
            , pCtx->Rax, pCtx->Rbx, pCtx->Rcx, pCtx->Rdx,
            pCtx->Rsi, pCtx->Rdi, pCtx->R9, pCtx->R10, pCtx->R11, pCtx->R12, pCtx->R13, pCtx->R14, pCtx->R15);
        Log(_T("CS:RIP:%04X:%016I64X\r\n"), pCtx->SegCs, pCtx->Rip);
        Log(_T("SS:RSP:%04X:%016X  RBP:%08X\r\n"),
            pCtx->SegSs, pCtx->Rsp, pCtx->Rbp);
        Log(_T("DS:%04X  ES:%04X  FS:%04X  GS:%04X\r\n"),
            pCtx->SegDs, pCtx->SegEs, pCtx->SegFs, pCtx->SegGs);
        Log(_T("Flags:%08X\r\n"), pCtx->EFlags);
#endif
 
        SymSetOptions(SYMOPT_DEFERRED_LOADS);
 
        // Initialize DbgHelp
        if (!SymInitialize(GetCurrentProcess(), 0, TRUE))
        {
            Log(_T("\r\n"));
            Log(_T("----\r\n"));
            Log(_T("SYMBOL HANDLER ERROR (THIS IS NOT THE CRASH ERROR)\r\n\r\n"));
            Log(_T("Couldn't initialize symbol handler for process when generating crash report\r\n"));
            Log(_T("Error: %s\r\n"), ErrorMessage(GetLastError()));
            Log(_T("THE BELOW CALL STACKS MIGHT HAVE MISSING OR INACCURATE FILE/FUNCTION NAMES\r\n\r\n"));
            Log(_T("----\r\n"));
        }
 
        CONTEXT trashableContext = *pCtx;
 
        WriteStackDetails(&trashableContext, false, nullptr);
        printTracesForAllThreads(false);
 
        //    #ifdef _M_IX86                                          // X86 Only!
 
        Log(_T("========================\r\n"));
        Log(_T("Local Variables And Parameters\r\n"));
 
        trashableContext = *pCtx;
        WriteStackDetails(&trashableContext, true, nullptr);
        printTracesForAllThreads(true);
 
        SymCleanup(GetCurrentProcess());
 
        Log(_T("\r\n"));
    }
    __except (EXCEPTION_EXECUTE_HANDLER)
    {
        Log(_T("Error writing the crash log\r\n"));
    }
}

References ErrorMessage(), EXCEPTION_ASSERTION_FAILURE, GetExceptionString(), GitRevision::GetFullVersion(), GetLogicalAddress(), PrintSystemInfo(), printTracesForAllThreads(), and WriteStackDetails().

Referenced by WheatyUnhandledExceptionFilter().

GetBasicType()

BasicType WheatyExceptionReport::GetBasicType ( DWORD  typeIndex, DWORD64  modBase  )

staticprivate

{
    BasicType basicType;
    if (SymGetTypeInfo(m_hProcess, modBase, typeIndex,
                       TI_GET_BASETYPE, &basicType))
    {
        return basicType;
    }
 
    // Get the real "TypeId" of the child.  We need this for the
    // SymGetTypeInfo(TI_GET_TYPEID) call below.
    DWORD typeId;
    if (SymGetTypeInfo(m_hProcess, modBase, typeIndex, TI_GET_TYPEID, &typeId))
    {
        if (SymGetTypeInfo(m_hProcess, modBase, typeId, TI_GET_BASETYPE,
                           &basicType))
        {
            return basicType;
        }
    }
 
    return btNoType;
}

References btNoType, and m_hProcess.

Referenced by DumpTypeIndex(), and FormatSymbolValue().

GetExceptionString()

LPTSTR WheatyExceptionReport::GetExceptionString ( DWORD  dwCode )

staticprivate

{
#define EXCEPTION(x) case EXCEPTION_##x: return LPTSTR(_T(#x));
 
    switch (dwCode)
    {
            EXCEPTION(ACCESS_VIOLATION)
            EXCEPTION(DATATYPE_MISALIGNMENT)
            EXCEPTION(BREAKPOINT)
            EXCEPTION(SINGLE_STEP)
            EXCEPTION(ARRAY_BOUNDS_EXCEEDED)
            EXCEPTION(FLT_DENORMAL_OPERAND)
            EXCEPTION(FLT_DIVIDE_BY_ZERO)
            EXCEPTION(FLT_INEXACT_RESULT)
            EXCEPTION(FLT_INVALID_OPERATION)
            EXCEPTION(FLT_OVERFLOW)
            EXCEPTION(FLT_STACK_CHECK)
            EXCEPTION(FLT_UNDERFLOW)
            EXCEPTION(INT_DIVIDE_BY_ZERO)
            EXCEPTION(INT_OVERFLOW)
            EXCEPTION(PRIV_INSTRUCTION)
            EXCEPTION(IN_PAGE_ERROR)
            EXCEPTION(ILLEGAL_INSTRUCTION)
            EXCEPTION(NONCONTINUABLE_EXCEPTION)
            EXCEPTION(STACK_OVERFLOW)
            EXCEPTION(INVALID_DISPOSITION)
            EXCEPTION(GUARD_PAGE)
            EXCEPTION(INVALID_HANDLE)
    }
 
    // If not one of the "known" exceptions, try to get the string
    // from NTDLL.DLL's message table.
 
    static TCHAR szBuffer[512] = { 0 };
 
    FormatMessage(FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_FROM_HMODULE,
                  GetModuleHandle(_T("NTDLL.DLL")),
                  dwCode, 0, szBuffer, sizeof(szBuffer), 0);
 
    return szBuffer;
}

References EXCEPTION.

Referenced by GenerateExceptionReport().

GetLogicalAddress()

BOOL WheatyExceptionReport::GetLogicalAddress ( PVOID  addr, PTSTR  szModule, DWORD  len, DWORD &  section, DWORD_PTR &  offset  )

staticprivate

{
    MEMORY_BASIC_INFORMATION mbi;
 
    if (!VirtualQuery(addr, &mbi, sizeof(mbi)))
    {
        return FALSE;
    }
 
    DWORD_PTR hMod = (DWORD_PTR)mbi.AllocationBase;
 
    if (!hMod)
    {
        return FALSE;
    }
 
    if (!GetModuleFileName((HMODULE)hMod, szModule, len))
    {
        return FALSE;
    }
 
    // Point to the DOS header in memory
    PIMAGE_DOS_HEADER pDosHdr = (PIMAGE_DOS_HEADER)hMod;
 
    // From the DOS header, find the NT (PE) header
    PIMAGE_NT_HEADERS pNtHdr = (PIMAGE_NT_HEADERS)(hMod + DWORD_PTR(pDosHdr->e_lfanew));
 
    PIMAGE_SECTION_HEADER pSection = IMAGE_FIRST_SECTION(pNtHdr);
 
    DWORD_PTR rva = (DWORD_PTR)addr - hMod;                         // RVA is offset from module load address
 
    // Iterate through the section table, looking for the one that encompasses
    // the linear address.
    for (unsigned i = 0;
            i < pNtHdr->FileHeader.NumberOfSections;
            i++, pSection++)
    {
        DWORD_PTR sectionStart = pSection->VirtualAddress;
        DWORD_PTR sectionEnd = sectionStart
                               + DWORD_PTR(std::max(pSection->SizeOfRawData, pSection->Misc.VirtualSize));
 
        // Is the address in this section???
        if ((rva >= sectionStart) && (rva <= sectionEnd))
        {
            // Yes, address is in the section.  Calculate section and offset,
            // and store in the "section" & "offset" params, which were
            // passed by reference.
            section = i + 1;
            offset = rva - sectionStart;
            return TRUE;
        }
    }
 
    return FALSE;                                           // Should never get here!
}

Referenced by GenerateExceptionReport(), and WriteStackDetails().

HeapLog()

int __cdecl WheatyExceptionReport::HeapLog ( const TCHAR *  format, va_list  argptr  )

staticprivate

{
    int retValue = 0;
    DWORD cbWritten;
    TCHAR* szBuff = (TCHAR*)malloc(sizeof(TCHAR) * WER_LARGE_BUFFER_SIZE);
    if (szBuff != nullptr)
    {
        retValue = vsprintf(szBuff, format, argptr);
        WriteFile(m_hReportFile, szBuff, retValue * sizeof(TCHAR), &cbWritten, 0);
        free(szBuff);
    }
 
    return retValue;
}

References m_hReportFile, and WER_LARGE_BUFFER_SIZE.

Referenced by Log().

Log()

int __cdecl WheatyExceptionReport::Log ( const TCHAR *  format,   ...  )

staticprivate

{
    int retValue;
    va_list argptr;
    va_start(argptr, format);
 
    if (stackOverflowException)
    {
        retValue = HeapLog(format, argptr);
    }
    else
    {
        retValue = StackLog(format, argptr);
    }
 
    va_end(argptr);
 
    return retValue;
}

References HeapLog(), StackLog(), and stackOverflowException.

PopSymbolDetail()

void WheatyExceptionReport::PopSymbolDetail ( )

staticprivate

{
    PrintSymbolDetail();
    symbolDetails.pop();
}

References PrintSymbolDetail(), and symbolDetails.

Referenced by DumpTypeIndex(), and FormatSymbolValue().

PrintSymbolDetail()

void WheatyExceptionReport::PrintSymbolDetail ( )

staticprivate

{
    if (symbolDetails.empty())
    {
        return;
    }
 
    // Don't log anything if has been logged already or if it's empty
    if (symbolDetails.top().Logged || symbolDetails.top().empty())
    {
        return;
    }
 
    // Add appropriate indentation level (since this routine is recursive)
    for (std::size_t i = 0; i < symbolDetails.size(); i++)
    {
        Log(_T("\t"));
    }
 
    Log(_T("%s\r\n"), symbolDetails.top().ToString().c_str());
 
    return;
}

References symbolDetails.

Referenced by PopSymbolDetail(), and PushSymbolDetail().

PrintSystemInfo()

void WheatyExceptionReport::PrintSystemInfo ( )

staticprivate

{
    SYSTEM_INFO SystemInfo;
    ::GetSystemInfo(&SystemInfo);
 
    MEMORYSTATUS MemoryStatus;
    MemoryStatus.dwLength = sizeof (MEMORYSTATUS);
    ::GlobalMemoryStatus(&MemoryStatus);
    TCHAR sString[1024];
    Log(_T("//=====================================================\r\n"));
    if (_GetProcessorName(sString, countof(sString)))
        Log(_T("*** Hardware ***\r\nProcessor: %s\r\nNumber Of Processors: %d\r\nPhysical Memory: %d KB (Available: %d KB)\r\nCommit Charge Limit: %d KB\r\n"),
            sString, SystemInfo.dwNumberOfProcessors, MemoryStatus.dwTotalPhys / 0x400, MemoryStatus.dwAvailPhys / 0x400, MemoryStatus.dwTotalPageFile / 0x400);
    else
        Log(_T("*** Hardware ***\r\nProcessor: <unknown>\r\nNumber Of Processors: %d\r\nPhysical Memory: %d KB (Available: %d KB)\r\nCommit Charge Limit: %d KB\r\n"),
            SystemInfo.dwNumberOfProcessors, MemoryStatus.dwTotalPhys / 0x400, MemoryStatus.dwAvailPhys / 0x400, MemoryStatus.dwTotalPageFile / 0x400);
 
    if (_GetWindowsVersion(sString, countof(sString)))
    {
        Log(_T("\r\n*** Operation System ***\r\n%s\r\n"), sString);
    }
    else
    {
        Log(_T("\r\n*** Operation System:\r\n<unknown>\r\n"));
    }
}

References _GetProcessorName(), _GetWindowsVersion(), and countof.

Referenced by GenerateExceptionReport().

printTracesForAllThreads()

void WheatyExceptionReport::printTracesForAllThreads ( bool  bWriteVariables )

static

{
    THREADENTRY32 te32;
 
    DWORD dwOwnerPID = GetCurrentProcessId();
    m_hProcess = GetCurrentProcess();
    // Take a snapshot of all running threads
    HANDLE hThreadSnap = CreateToolhelp32Snapshot(TH32CS_SNAPTHREAD, 0);
    if (hThreadSnap == INVALID_HANDLE_VALUE)
    {
        return;
    }
 
    // Fill in the size of the structure before using it.
    te32.dwSize = sizeof(THREADENTRY32);
 
    // Retrieve information about the first thread,
    // and exit if unsuccessful
    if (!Thread32First(hThreadSnap, &te32))
    {
        CloseHandle(hThreadSnap);    // Must clean up the
        //   snapshot object!
        return;
    }
 
    // Now walk the thread list of the system,
    // and display information about each thread
    // associated with the specified process
    do
    {
        if (te32.th32OwnerProcessID == dwOwnerPID)
        {
            CONTEXT context;
            context.ContextFlags = 0xffffffff;
            HANDLE threadHandle = OpenThread(THREAD_GET_CONTEXT | THREAD_QUERY_INFORMATION, false, te32.th32ThreadID);
            if (threadHandle)
            {
                if (GetThreadContext(threadHandle, &context))
                {
                    WriteStackDetails(&context, bWriteVariables, threadHandle);
                }
                CloseHandle(threadHandle);
            }
        }
    } while (Thread32Next(hThreadSnap, &te32));
 
    //  Don't forget to clean up the snapshot object.
    CloseHandle(hThreadSnap);
}

References m_hProcess, and WriteStackDetails().

Referenced by GenerateExceptionReport().

PushSymbolDetail()

void WheatyExceptionReport::PushSymbolDetail ( )

staticprivate

{
    // Log current symbol and then add another to the stack to keep the hierarchy format
    PrintSymbolDetail();
    symbolDetails.emplace();
}

References PrintSymbolDetail(), and symbolDetails.

Referenced by DumpTypeIndex(), and FormatSymbolValue().

StackLog()

int __cdecl WheatyExceptionReport::StackLog ( const TCHAR *  format, va_list  argptr  )

staticprivate

{
    int retValue;
    DWORD cbWritten;
 
    TCHAR szBuff[WER_LARGE_BUFFER_SIZE];
    retValue = vsprintf(szBuff, format, argptr);
    WriteFile(m_hReportFile, szBuff, retValue * sizeof(TCHAR), &cbWritten, 0);
 
    return retValue;
}

References m_hReportFile, and WER_LARGE_BUFFER_SIZE.

Referenced by Log().

StoreSymbol()

bool WheatyExceptionReport::StoreSymbol ( DWORD  type, DWORD_PTR  offset  )

staticprivate

{
    return symbols.insert(SymbolPair(type, offset)).second;
}

References symbols.

Referenced by DumpTypeIndex().

WheatyCrtHandler()

void __cdecl WheatyExceptionReport::WheatyCrtHandler ( wchar_t const *  expression, wchar_t const *  function, wchar_t const *  file, unsigned int  line, uintptr_t  pReserved  )

static

{
    RaiseException(EXCEPTION_ACCESS_VIOLATION, 0, 0, nullptr);
}

Referenced by WheatyExceptionReport().

WheatyUnhandledExceptionFilter()

LONG WINAPI WheatyExceptionReport::WheatyUnhandledExceptionFilter ( PEXCEPTION_POINTERS  pExceptionInfo )

static

{
    std::unique_lock<std::mutex> guard(alreadyCrashedLock);
    // Handle only 1 exception in the whole process lifetime
    if (alreadyCrashed)
    {
        return EXCEPTION_EXECUTE_HANDLER;
    }
 
    alreadyCrashed = true;
 
    if (pExceptionInfo->ExceptionRecord->ExceptionCode == STATUS_STACK_OVERFLOW)
    {
        stackOverflowException = true;
    }
 
    TCHAR module_folder_name[MAX_PATH];
    GetModuleFileName(0, module_folder_name, MAX_PATH);
    TCHAR* pos = _tcsrchr(module_folder_name, '\\');
    if (!pos)
    {
        return 0;
    }
    pos[0] = '\0';
    ++pos;
 
    TCHAR crash_folder_path[MAX_PATH];
    sprintf_s(crash_folder_path, "%s\\%s", module_folder_name, CrashFolder);
    if (!CreateDirectory(crash_folder_path, nullptr))
    {
        if (GetLastError() != ERROR_ALREADY_EXISTS)
        {
            return 0;
        }
    }
 
    SYSTEMTIME systime;
    GetLocalTime(&systime);
    sprintf(m_szDumpFileName, "%s\\%s_%s_[%u-%u_%u-%u-%u].dmp",
            crash_folder_path, GitRevision::GetHash(), pos, systime.wDay, systime.wMonth, systime.wHour, systime.wMinute, systime.wSecond);
 
    sprintf(m_szLogFileName, "%s\\%s_%s_[%u-%u_%u-%u-%u].txt",
            crash_folder_path, GitRevision::GetHash(), pos, systime.wDay, systime.wMonth, systime.wHour, systime.wMinute, systime.wSecond);
 
    m_hDumpFile = CreateFile(m_szDumpFileName,
                             GENERIC_WRITE,
                             0,
                             0,
                             OPEN_ALWAYS,
                             FILE_FLAG_WRITE_THROUGH,
                             0);
 
    m_hReportFile = CreateFile(m_szLogFileName,
                               GENERIC_WRITE,
                               0,
                               0,
                               OPEN_ALWAYS,
                               FILE_FLAG_WRITE_THROUGH,
                               0);
 
    if (m_hDumpFile)
    {
        MINIDUMP_EXCEPTION_INFORMATION info;
        info.ClientPointers = FALSE;
        info.ExceptionPointers = pExceptionInfo;
        info.ThreadId = GetCurrentThreadId();
 
        MINIDUMP_USER_STREAM additionalStream = {};
        MINIDUMP_USER_STREAM_INFORMATION additionalStreamInfo = {};
 
        if (pExceptionInfo->ExceptionRecord->ExceptionCode == EXCEPTION_ASSERTION_FAILURE && pExceptionInfo->ExceptionRecord->NumberParameters > 0)
        {
            additionalStream.Type = CommentStreamA;
            additionalStream.Buffer = reinterpret_cast<PVOID>(pExceptionInfo->ExceptionRecord->ExceptionInformation[0]);
            additionalStream.BufferSize = strlen(reinterpret_cast<char const*>(pExceptionInfo->ExceptionRecord->ExceptionInformation[0])) + 1;
 
            additionalStreamInfo.UserStreamArray = &additionalStream;
            additionalStreamInfo.UserStreamCount = 1;
        }
 
        MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(),
                          m_hDumpFile, MiniDumpWithIndirectlyReferencedMemory, &info, &additionalStreamInfo, 0);
 
        CloseHandle(m_hDumpFile);
    }
 
    if (m_hReportFile)
    {
        SetFilePointer(m_hReportFile, 0, 0, FILE_END);
 
        GenerateExceptionReport(pExceptionInfo);
 
        CloseHandle(m_hReportFile);
        m_hReportFile = 0;
    }
 
    if (m_previousFilter)
    {
        return m_previousFilter(pExceptionInfo);
    }
    else
    {
        return EXCEPTION_EXECUTE_HANDLER/*EXCEPTION_CONTINUE_SEARCH*/;
    }
}

References alreadyCrashed, alreadyCrashedLock, CrashFolder, EXCEPTION_ASSERTION_FAILURE, GenerateExceptionReport(), GitRevision::GetHash(), m_hDumpFile, m_hReportFile, m_previousFilter, m_szDumpFileName, m_szLogFileName, and stackOverflowException.

Referenced by WheatyExceptionReport().

WriteStackDetails()

void WheatyExceptionReport::WriteStackDetails ( PCONTEXT  pContext, bool  bWriteVariables, HANDLE  pThreadHandle  )

staticprivate

{
    Log(_T("\r\nCall stack:\r\n"));
 
    Log(_T("Address   Frame     Function      SourceFile\r\n"));
 
    DWORD dwMachineType = 0;
    // Could use SymSetOptions here to add the SYMOPT_DEFERRED_LOADS flag
 
    STACKFRAME64 sf;
    memset(&sf, 0, sizeof(sf));
 
#ifdef _M_IX86
    // Initialize the STACKFRAME structure for the first call.  This is only
    // necessary for Intel CPUs, and isn't mentioned in the documentation.
    sf.AddrPC.Offset       = pContext->Eip;
    sf.AddrPC.Mode         = AddrModeFlat;
    sf.AddrStack.Offset    = pContext->Esp;
    sf.AddrStack.Mode      = AddrModeFlat;
    sf.AddrFrame.Offset    = pContext->Ebp;
    sf.AddrFrame.Mode      = AddrModeFlat;
 
    dwMachineType = IMAGE_FILE_MACHINE_I386;
#endif
 
#ifdef _M_X64
    sf.AddrPC.Offset    = pContext->Rip;
    sf.AddrPC.Mode = AddrModeFlat;
    sf.AddrStack.Offset    = pContext->Rsp;
    sf.AddrStack.Mode      = AddrModeFlat;
    sf.AddrFrame.Offset    = pContext->Rbp;
    sf.AddrFrame.Mode      = AddrModeFlat;
    dwMachineType = IMAGE_FILE_MACHINE_AMD64;
#endif
 
    for (;;)
    {
        // Get the next stack frame
        if (! StackWalk64(dwMachineType,
                          m_hProcess,
                          pThreadHandle != nullptr ? pThreadHandle : GetCurrentThread(),
                          &sf,
                          pContext,
                          0,
                          SymFunctionTableAccess64,
                          SymGetModuleBase64,
                          0))
        {
            break;
        }
        if (0 == sf.AddrFrame.Offset)                     // Basic sanity check to make sure
        {
            break;    // the frame is OK.  Bail if not.
        }
#ifdef _M_IX86
        Log(_T("%08X  %08X  "), sf.AddrPC.Offset, sf.AddrFrame.Offset);
#endif
#ifdef _M_X64
        Log(_T("%016I64X  %016I64X  "), sf.AddrPC.Offset, sf.AddrFrame.Offset);
#endif
 
        DWORD64 symDisplacement = 0;                        // Displacement of the input address,
        // relative to the start of the symbol
 
        // Get the name of the function for this stack frame entry
        CSymbolInfoPackage sip;
        if (SymFromAddr(
                    m_hProcess,                                     // Process handle of the current process
                    sf.AddrPC.Offset,                               // Symbol address
                    &symDisplacement,                               // Address of the variable that will receive the displacement
                    &sip.si))                                       // Address of the SYMBOL_INFO structure (inside "sip" object)
        {
            Log(_T("%hs+%I64X"), sip.si.Name, symDisplacement);
        }
        else                                                // No symbol found.  Print out the logical address instead.
        {
            TCHAR szModule[MAX_PATH] = _T("");
            DWORD section = 0;
            DWORD_PTR offset = 0;
 
            GetLogicalAddress((PVOID)sf.AddrPC.Offset,
                              szModule, sizeof(szModule), section, offset);
#ifdef _M_IX86
            Log(_T("%04X:%08X %s"), section, offset, szModule);
#endif
#ifdef _M_X64
            Log(_T("%04X:%016I64X %s"), section, offset, szModule);
#endif
        }
 
        // Get the source line for this stack frame entry
        IMAGEHLP_LINE64 lineInfo = { sizeof(IMAGEHLP_LINE64) };
        DWORD dwLineDisplacement;
        if (SymGetLineFromAddr64(m_hProcess, sf.AddrPC.Offset,
                                 &dwLineDisplacement, &lineInfo))
        {
            Log(_T("  %s line %u"), lineInfo.FileName, lineInfo.LineNumber);
        }
 
        Log(_T("\r\n"));
 
        // Write out the variables, if desired
        if (bWriteVariables)
        {
            // Use SymSetContext to get just the locals/params for this frame
            IMAGEHLP_STACK_FRAME imagehlpStackFrame;
            imagehlpStackFrame.InstructionOffset = sf.AddrPC.Offset;
            SymSetContext(m_hProcess, &imagehlpStackFrame, 0);
 
            // Enumerate the locals/parameters
            SymEnumSymbols(m_hProcess, 0, 0, EnumerateSymbolsCallback, &sf);
 
            Log(_T("\r\n"));
        }
    }
}

References EnumerateSymbolsCallback(), GetLogicalAddress(), and m_hProcess.

Referenced by GenerateExceptionReport(), and printTracesForAllThreads().

Member Data Documentation

alreadyCrashed

bool WheatyExceptionReport::alreadyCrashed

staticprivate

Referenced by WheatyExceptionReport(), and WheatyUnhandledExceptionFilter().

alreadyCrashedLock

std::mutex WheatyExceptionReport::alreadyCrashedLock

staticprivate

Referenced by WheatyUnhandledExceptionFilter().

m_hDumpFile

HANDLE WheatyExceptionReport::m_hDumpFile

staticprivate

Referenced by WheatyUnhandledExceptionFilter().

m_hProcess

HANDLE WheatyExceptionReport::m_hProcess

staticprivate

Referenced by DumpTypeIndex(), GetBasicType(), printTracesForAllThreads(), WheatyExceptionReport(), and WriteStackDetails().

m_hReportFile

HANDLE WheatyExceptionReport::m_hReportFile

staticprivate

Referenced by HeapLog(), StackLog(), and WheatyUnhandledExceptionFilter().

m_previousCrtHandler

_invalid_parameter_handler WheatyExceptionReport::m_previousCrtHandler

staticprivate

Referenced by WheatyExceptionReport(), and ~WheatyExceptionReport().

m_previousFilter

LPTOP_LEVEL_EXCEPTION_FILTER WheatyExceptionReport::m_previousFilter

staticprivate

Referenced by WheatyExceptionReport(), WheatyUnhandledExceptionFilter(), and ~WheatyExceptionReport().

m_szDumpFileName

TCHAR WheatyExceptionReport::m_szDumpFileName

staticprivate

Referenced by WheatyUnhandledExceptionFilter().

m_szLogFileName

TCHAR WheatyExceptionReport::m_szLogFileName

staticprivate

Referenced by WheatyUnhandledExceptionFilter().

RtlGetVersion

WheatyExceptionReport::pRtlGetVersion WheatyExceptionReport::RtlGetVersion

staticprivate

Referenced by _GetWindowsVersion(), and WheatyExceptionReport().

stackOverflowException

bool WheatyExceptionReport::stackOverflowException

staticprivate

Referenced by Log(), WheatyExceptionReport(), and WheatyUnhandledExceptionFilter().

symbolDetails

std::stack< SymbolDetail > WheatyExceptionReport::symbolDetails

staticprivate

Referenced by ClearSymbols(), DumpTypeIndex(), FormatSymbolValue(), PopSymbolDetail(), PrintSymbolDetail(), and PushSymbolDetail().

symbols

SymbolPairs WheatyExceptionReport::symbols

staticprivate

Referenced by ClearSymbols(), and StoreSymbol().