/**********************************************************************

*

* StackWalker.cpp

* https://github.com/JochenKalmbach/StackWalker

*

* Old location: http://stackwalker.codeplex.com/

*

*

* History:

* 2005-07-27 v1 - First public release on http://www.codeproject.com/

* http://www.codeproject.com/threads/StackWalker.asp

* 2005-07-28 v2 - Changed the params of the constructor and ShowCallstack

* (to simplify the usage)

* 2005-08-01 v3 - Changed to use 'CONTEXT_FULL' instead of CONTEXT_ALL

* (should also be enough)

* - Changed to compile correctly with the PSDK of VC7.0

* (GetFileVersionInfoSizeA and GetFileVersionInfoA is wrongly defined:

* it uses LPSTR instead of LPCSTR as first parameter)

* - Added declarations to support VC5/6 without using 'dbghelp.h'

* - Added a 'pUserData' member to the ShowCallstack function and the

* PReadProcessMemoryRoutine declaration (to pass some user-defined data,

* which can be used in the readMemoryFunction-callback)

* 2005-08-02 v4 - OnSymInit now also outputs the OS-Version by default

* - Added example for doing an exception-callstack-walking in main.cpp

* (thanks to owillebo: http://www.codeproject.com/script/profile/whos_who.asp?id=536268)

* 2005-08-05 v5 - Removed most Lint (http://www.gimpel.com/) errors... thanks to Okko Willeboordse!

* 2008-08-04 v6 - Fixed Bug: Missing LEAK-end-tag

* http://www.codeproject.com/KB/applications/leakfinder.aspx?msg=2502890#xx2502890xx

* Fixed Bug: Compiled with "WIN32_LEAN_AND_MEAN"

* http://www.codeproject.com/KB/applications/leakfinder.aspx?msg=1824718#xx1824718xx

* Fixed Bug: Compiling with "/Wall"

* http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=2638243#xx2638243xx

* Fixed Bug: Now checking SymUseSymSrv

* http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=1388979#xx1388979xx

* Fixed Bug: Support for recursive function calls

* http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=1434538#xx1434538xx

* Fixed Bug: Missing FreeLibrary call in "GetModuleListTH32"

* http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=1326923#xx1326923xx

* Fixed Bug: SymDia is number 7, not 9!

* 2008-09-11 v7 For some (undocumented) reason, dbhelp.h is needing a packing of 8!

* Thanks to Teajay which reported the bug...

* http://www.codeproject.com/KB/applications/leakfinder.aspx?msg=2718933#xx2718933xx

* 2008-11-27 v8 Debugging Tools for Windows are now stored in a different directory

* Thanks to Luiz Salamon which reported this "bug"...

* http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=2822736#xx2822736xx

* 2009-04-10 v9 License slightly corrected (<ORGANIZATION> replaced)

* 2009-11-01 v10 Moved to http://stackwalker.codeplex.com/

* 2009-11-02 v11 Now try to use IMAGEHLP_MODULE64_V3 if available

* 2010-04-15 v12 Added support for VS2010 RTM

* 2010-05-25 v13 Now using secure MyStrcCpy. Thanks to luke.simon:

* http://www.codeproject.com/KB/applications/leakfinder.aspx?msg=3477467#xx3477467xx

* 2013-01-07 v14 Runtime Check Error VS2010 Debug Builds fixed:

* http://stackwalker.codeplex.com/workitem/10511

*

*

* LICENSE (http://www.opensource.org/licenses/bsd-license.php)

*

* Copyright (c) 2005-2013, Jochen Kalmbach

* All rights reserved.

*

* Redistribution and use in source and binary forms, with or without modification,

* are permitted provided that the following conditions are met:

*

* Redistributions of source code must retain the above copyright notice,

* this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,

* this list of conditions and the following disclaimer in the documentation

* and/or other materials provided with the distribution.

* Neither the name of Jochen Kalmbach nor the names of its contributors may be

* used to endorse or promote products derived from this software without

* specific prior written permission.

* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,

* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE

* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*

**********************************************************************/

#include "StackWalker.h"

#include <stdio.h>

#include <stdlib.h>

#include <tchar.h>

#include <windows.h>

#include <new>

#pragma comment(lib, "version.lib") // for "VerQueryValue"

#pragma warning(disable : 4826)

#if _MSC_VER >= 1900

#pragma warning(disable : 4091) // For fix unnamed enums from DbgHelp.h

#endif

// If VC7 and later, then use the shipped 'dbghelp.h'-file

#pragma pack(push, 8)

#if _MSC_VER >= 1300

#include <dbghelp.h>

#else

// inline the important dbghelp.h-declarations...

typedef enum

{

SymNone = 0,

SymCoff,

SymCv,

SymPdb,

SymExport,

SymDeferred,

SymSym,

SymDia,

SymVirtual,

NumSymTypes

} SYM_TYPE;

typedef struct _IMAGEHLP_LINE64

{

DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_LINE64)

PVOID Key; // internal

DWORD LineNumber; // line number in file

PCHAR FileName; // full filename

DWORD64 Address; // first instruction of line

} IMAGEHLP_LINE64, *PIMAGEHLP_LINE64;

typedef struct _IMAGEHLP_MODULE64

{

DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_MODULE64)

DWORD64 BaseOfImage; // base load address of module

DWORD ImageSize; // virtual size of the loaded module

DWORD TimeDateStamp; // date/time stamp from pe header

DWORD CheckSum; // checksum from the pe header

DWORD NumSyms; // number of symbols in the symbol table

SYM_TYPE SymType; // type of symbols loaded

CHAR ModuleName[32]; // module name

CHAR ImageName[256]; // image name

CHAR LoadedImageName[256]; // symbol file name

} IMAGEHLP_MODULE64, *PIMAGEHLP_MODULE64;

typedef struct _IMAGEHLP_SYMBOL64

{

DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_SYMBOL64)

DWORD64 Address; // virtual address including dll base address

DWORD Size; // estimated size of symbol, can be zero

DWORD Flags; // info about the symbols, see the SYMF defines

DWORD MaxNameLength; // maximum size of symbol name in 'Name'

CHAR Name[1]; // symbol name (null terminated string)

} IMAGEHLP_SYMBOL64, *PIMAGEHLP_SYMBOL64;

typedef enum

{

AddrMode1616,

AddrMode1632,

AddrModeReal,

AddrModeFlat

} ADDRESS_MODE;

typedef struct _tagADDRESS64

{

DWORD64 Offset;

WORD Segment;

ADDRESS_MODE Mode;

} ADDRESS64, *LPADDRESS64;

typedef struct _KDHELP64

{

DWORD64 Thread;

DWORD ThCallbackStack;

DWORD ThCallbackBStore;

DWORD NextCallback;

DWORD FramePointer;

DWORD64 KiCallUserMode;

DWORD64 KeUserCallbackDispatcher;

DWORD64 SystemRangeStart;

DWORD64 Reserved[8];

} KDHELP64, *PKDHELP64;

typedef struct _tagSTACKFRAME64

{

ADDRESS64 AddrPC; // program counter

ADDRESS64 AddrReturn; // return address

ADDRESS64 AddrFrame; // frame pointer

ADDRESS64 AddrStack; // stack pointer

ADDRESS64 AddrBStore; // backing store pointer

PVOID FuncTableEntry; // pointer to pdata/fpo or NULL

DWORD64 Params[4]; // possible arguments to the function

BOOL Far; // WOW far call

BOOL Virtual; // is this a virtual frame?

DWORD64 Reserved[3];

KDHELP64 KdHelp;

} STACKFRAME64, *LPSTACKFRAME64;

typedef BOOL(__stdcall* PREAD_PROCESS_MEMORY_ROUTINE64)(HANDLE hProcess,

DWORD64 qwBaseAddress,

PVOID lpBuffer,

DWORD nSize,

LPDWORD lpNumberOfBytesRead);

typedef PVOID(__stdcall* PFUNCTION_TABLE_ACCESS_ROUTINE64)(HANDLE hProcess, DWORD64 AddrBase);

typedef DWORD64(__stdcall* PGET_MODULE_BASE_ROUTINE64)(HANDLE hProcess, DWORD64 Address);

typedef DWORD64(__stdcall* PTRANSLATE_ADDRESS_ROUTINE64)(HANDLE hProcess,

HANDLE hThread,

LPADDRESS64 lpaddr);

// clang-format off

#define SYMOPT_CASE_INSENSITIVE 0x00000001

#define SYMOPT_UNDNAME 0x00000002

#define SYMOPT_DEFERRED_LOADS 0x00000004

#define SYMOPT_NO_CPP 0x00000008

#define SYMOPT_LOAD_LINES 0x00000010

#define SYMOPT_OMAP_FIND_NEAREST 0x00000020

#define SYMOPT_LOAD_ANYTHING 0x00000040

#define SYMOPT_IGNORE_CVREC 0x00000080

#define SYMOPT_NO_UNQUALIFIED_LOADS 0x00000100

#define SYMOPT_FAIL_CRITICAL_ERRORS 0x00000200

#define SYMOPT_EXACT_SYMBOLS 0x00000400

#define SYMOPT_ALLOW_ABSOLUTE_SYMBOLS 0x00000800

#define SYMOPT_IGNORE_NT_SYMPATH 0x00001000

#define SYMOPT_INCLUDE_32BIT_MODULES 0x00002000

#define SYMOPT_PUBLICS_ONLY 0x00004000

#define SYMOPT_NO_PUBLICS 0x00008000

#define SYMOPT_AUTO_PUBLICS 0x00010000

#define SYMOPT_NO_IMAGE_SEARCH 0x00020000

#define SYMOPT_SECURE 0x00040000

#define SYMOPT_DEBUG 0x80000000

#define UNDNAME_COMPLETE (0x0000) // Enable full undecoration

#define UNDNAME_NAME_ONLY (0x1000) // Crack only the name for primary declaration;

// clang-format on

#endif // _MSC_VER < 1300

#pragma pack(pop)

// Some missing defines (for VC5/6):

#ifndef INVALID_FILE_ATTRIBUTES

#define INVALID_FILE_ATTRIBUTES ((DWORD)-1)

#endif

// secure-CRT_functions are only available starting with VC8

#if _MSC_VER < 1400

#define strcpy_s(dst, len, src) strcpy(dst, src)

#define strncpy_s(dst, len, src, maxLen) strncpy(dst, len, src)

#define strcat_s(dst, len, src) strcat(dst, src)

#define _snprintf_s _snprintf

#define _tcscat_s _tcscat

#endif

static void MyStrCpy(char* szDest, size_t nMaxDestSize, const char* szSrc)

{

if (nMaxDestSize <= 0)

return;

strncpy_s(szDest, nMaxDestSize, szSrc, _TRUNCATE);

// INFO: _TRUNCATE will ensure that it is null-terminated;

// but with older compilers (<1400) it uses "strncpy" and this does not!)

szDest[nMaxDestSize - 1] = 0;

} // MyStrCpy

// Normally it should be enough to use 'CONTEXT_FULL' (better would be 'CONTEXT_ALL')

#define USED_CONTEXT_FLAGS CONTEXT_FULL

class StackWalkerInternal

{

public:

StackWalkerInternal(StackWalker* parent, HANDLE hProcess, PCONTEXT ctx)

{

m_parent = parent;

m_hDbhHelp = NULL;

pSC = NULL;

m_hProcess = hProcess;

pSFTA = NULL;

pSGLFA = NULL;

pSGMB = NULL;

pSGMI = NULL;

pSGO = NULL;

pSGSFA = NULL;

pSI = NULL;

pSLM = NULL;

pSSO = NULL;

pSW = NULL;

pUDSN = NULL;

pSGSP = NULL;

m_ctx.ContextFlags = 0;

if (ctx != NULL)

m_ctx = *ctx;

}

~StackWalkerInternal()

{

if (pSC != NULL)

pSC(m_hProcess); // SymCleanup

if (m_hDbhHelp != NULL)

FreeLibrary(m_hDbhHelp);

m_hDbhHelp = NULL;

m_parent = NULL;

}

BOOL Init(LPCSTR szSymPath)

{

if (m_parent == NULL)

return FALSE;

// Dynamically load the Entry-Points for dbghelp.dll:

// First try to load the newest one from

TCHAR szTemp[4096];

// But before we do this, we first check if the ".local" file exists

if (GetModuleFileName(NULL, szTemp, 4096) > 0)

{

_tcscat_s(szTemp, _T(".local"));

if (GetFileAttributes(szTemp) == INVALID_FILE_ATTRIBUTES)

{

// ".local" file does not exist, so we can try to load the dbghelp.dll from the "Debugging Tools for Windows"

// Ok, first try the new path according to the architecture:

#ifdef _M_IX86

if ((m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0))

{

_tcscat_s(szTemp, _T("\\Debugging Tools for Windows (x86)\\dbghelp.dll"));

// now check if the file exists:

if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)

{

m_hDbhHelp = LoadLibrary(szTemp);

}

}

#elif _M_X64

if ((m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0))

{

_tcscat_s(szTemp, _T("\\Debugging Tools for Windows (x64)\\dbghelp.dll"));

// now check if the file exists:

if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)

{

m_hDbhHelp = LoadLibrary(szTemp);

}

}

#elif _M_IA64

if ((m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0))

{

_tcscat_s(szTemp, _T("\\Debugging Tools for Windows (ia64)\\dbghelp.dll"));

// now check if the file exists:

if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)

{

m_hDbhHelp = LoadLibrary(szTemp);

}

}

#endif

// If still not found, try the old directories...

if ((m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0))

{

_tcscat_s(szTemp, _T("\\Debugging Tools for Windows\\dbghelp.dll"));

// now check if the file exists:

if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)

{

m_hDbhHelp = LoadLibrary(szTemp);

}

}

#if defined _M_X64 || defined _M_IA64

// Still not found? Then try to load the (old) 64-Bit version:

if ((m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0))

{

_tcscat_s(szTemp, _T("\\Debugging Tools for Windows 64-Bit\\dbghelp.dll"));

if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)

{

m_hDbhHelp = LoadLibrary(szTemp);

}

}

#endif

}

}

if (m_hDbhHelp == NULL) // if not already loaded, try to load a default-one

m_hDbhHelp = LoadLibrary(_T("dbghelp.dll"));

if (m_hDbhHelp == NULL)

return FALSE;

pSI = (tSI)GetProcAddress(m_hDbhHelp, "SymInitialize");

pSC = (tSC)GetProcAddress(m_hDbhHelp, "SymCleanup");

pSW = (tSW)GetProcAddress(m_hDbhHelp, "StackWalk64");

pSGO = (tSGO)GetProcAddress(m_hDbhHelp, "SymGetOptions");

pSSO = (tSSO)GetProcAddress(m_hDbhHelp, "SymSetOptions");

pSFTA = (tSFTA)GetProcAddress(m_hDbhHelp, "SymFunctionTableAccess64");

pSGLFA = (tSGLFA)GetProcAddress(m_hDbhHelp, "SymGetLineFromAddr64");

pSGMB = (tSGMB)GetProcAddress(m_hDbhHelp, "SymGetModuleBase64");

pSGMI = (tSGMI)GetProcAddress(m_hDbhHelp, "SymGetModuleInfo64");

pSGSFA = (tSGSFA)GetProcAddress(m_hDbhHelp, "SymGetSymFromAddr64");

pUDSN = (tUDSN)GetProcAddress(m_hDbhHelp, "UnDecorateSymbolName");

pSLM = (tSLM)GetProcAddress(m_hDbhHelp, "SymLoadModule64");

pSGSP = (tSGSP)GetProcAddress(m_hDbhHelp, "SymGetSearchPath");

pSAIIT = NULL;

pSQIT = NULL;

pSFIC = NULL;

pSGLFIC = NULL;

if ((this->m_parent->m_options & StackWalker::SymGetInlineFrames) != 0)

{

pSAIIT = (tSAIIT)GetProcAddress(m_hDbhHelp, "SymAddrIncludeInlineTrace");

pSQIT = (tSQIT)GetProcAddress(m_hDbhHelp, "SymQueryInlineTrace");

pSFIC = (tSFIC)GetProcAddress(m_hDbhHelp, "SymFromInlineContext");

pSGLFIC = (tSGLFIC)GetProcAddress(m_hDbhHelp, "SymGetLineFromInlineContext");

if (pSAIIT == NULL || pSQIT == NULL || pSFIC == NULL || pSGLFIC == NULL)

{

pSAIIT = NULL;

pSQIT = NULL;

pSFIC = NULL;

pSGLFIC = NULL;

}

}

if (pSC == NULL || pSFTA == NULL || pSGMB == NULL || pSGMI == NULL || pSGO == NULL ||

pSGSFA == NULL || pSI == NULL || pSSO == NULL || pSW == NULL || pUDSN == NULL ||

pSLM == NULL)

{

FreeLibrary(m_hDbhHelp);

m_hDbhHelp = NULL;

pSC = NULL;

return FALSE;

}

// SymInitialize

if (this->pSI(m_hProcess, szSymPath, FALSE) == FALSE)

this->m_parent->OnDbgHelpErr("SymInitialize", GetLastError(), 0);

DWORD symOptions = this->pSGO(); // SymGetOptions

symOptions |= SYMOPT_LOAD_LINES;

symOptions |= SYMOPT_FAIL_CRITICAL_ERRORS;

//symOptions |= SYMOPT_NO_PROMPTS;

// SymSetOptions

symOptions = this->pSSO(symOptions);

char buf[StackWalker::STACKWALK_MAX_NAMELEN] = {0};

// SymGetSearchPath()

if (this->pSGSP != NULL)

{

if (this->pSGSP(m_hProcess, buf, StackWalker::STACKWALK_MAX_NAMELEN) == FALSE)

this->m_parent->OnDbgHelpErr("SymGetSearchPath", GetLastError(), 0);

}

char szUserName[1024] = {0};

DWORD dwSize = 1024;

GetUserNameA(szUserName, &dwSize);

this->m_parent->OnSymInit(buf, symOptions, szUserName);

return TRUE;

}

StackWalker* m_parent;

CONTEXT m_ctx;

HMODULE m_hDbhHelp;

HANDLE m_hProcess;

#pragma pack(push, 8)

typedef struct _IMAGEHLP_MODULE64_V3

{

DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_MODULE64)

DWORD64 BaseOfImage; // base load address of module

DWORD ImageSize; // virtual size of the loaded module

DWORD TimeDateStamp; // date/time stamp from pe header

DWORD CheckSum; // checksum from the pe header

DWORD NumSyms; // number of symbols in the symbol table

SYM_TYPE SymType; // type of symbols loaded

CHAR ModuleName[32]; // module name

CHAR ImageName[256]; // image name

CHAR LoadedImageName[256]; // symbol file name

// new elements: 07-Jun-2002

CHAR LoadedPdbName[256]; // pdb file name

DWORD CVSig; // Signature of the CV record in the debug directories

CHAR CVData[MAX_PATH * 3]; // Contents of the CV record

DWORD PdbSig; // Signature of PDB

GUID PdbSig70; // Signature of PDB (VC 7 and up)

DWORD PdbAge; // DBI age of pdb

BOOL PdbUnmatched; // loaded an unmatched pdb

BOOL DbgUnmatched; // loaded an unmatched dbg

BOOL LineNumbers; // we have line number information

BOOL GlobalSymbols; // we have internal symbol information

BOOL TypeInfo; // we have type information

// new elements: 17-Dec-2003

BOOL SourceIndexed; // pdb supports source server

BOOL Publics; // contains public symbols

} IMAGEHLP_MODULE64_V3, *PIMAGEHLP_MODULE64_V3;

typedef struct _IMAGEHLP_MODULE64_V2

{

DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_MODULE64)

DWORD64 BaseOfImage; // base load address of module

DWORD ImageSize; // virtual size of the loaded module

DWORD TimeDateStamp; // date/time stamp from pe header

DWORD CheckSum; // checksum from the pe header

DWORD NumSyms; // number of symbols in the symbol table

SYM_TYPE SymType; // type of symbols loaded

CHAR ModuleName[32]; // module name

CHAR ImageName[256]; // image name

CHAR LoadedImageName[256]; // symbol file name

} IMAGEHLP_MODULE64_V2, *PIMAGEHLP_MODULE64_V2;

#pragma pack(pop)

// SymCleanup()

typedef BOOL(__stdcall* tSC)(IN HANDLE hProcess);

tSC pSC;

// SymFunctionTableAccess64()

typedef PVOID(__stdcall* tSFTA)(HANDLE hProcess, DWORD64 AddrBase);

tSFTA pSFTA;

// SymGetLineFromAddr64()

typedef BOOL(__stdcall* tSGLFA)(IN HANDLE hProcess,

IN DWORD64 dwAddr,

OUT PDWORD pdwDisplacement,

OUT PIMAGEHLP_LINE64 Line);

tSGLFA pSGLFA;

// SymGetModuleBase64()

typedef DWORD64(__stdcall* tSGMB)(IN HANDLE hProcess, IN DWORD64 dwAddr);

tSGMB pSGMB;

// SymGetModuleInfo64()

typedef BOOL(__stdcall* tSGMI)(IN HANDLE hProcess,

IN DWORD64 dwAddr,

OUT IMAGEHLP_MODULE64_V3* ModuleInfo);

tSGMI pSGMI;

// SymGetOptions()

typedef DWORD(__stdcall* tSGO)(VOID);

tSGO pSGO;

// SymGetSymFromAddr64()

typedef BOOL(__stdcall* tSGSFA)(IN HANDLE hProcess,

IN DWORD64 dwAddr,

OUT PDWORD64 pdwDisplacement,

OUT PIMAGEHLP_SYMBOL64 Symbol);

tSGSFA pSGSFA;

// SymInitialize()

typedef BOOL(__stdcall* tSI)(IN HANDLE hProcess, IN LPCSTR UserSearchPath, IN BOOL fInvadeProcess);

tSI pSI;

// SymLoadModule64()

typedef DWORD64(__stdcall* tSLM)(IN HANDLE hProcess,

IN HANDLE hFile,

IN LPCSTR ImageName,

IN LPCSTR ModuleName,

IN DWORD64 BaseOfDll,

IN DWORD SizeOfDll);

tSLM pSLM;

// SymSetOptions()

typedef DWORD(__stdcall* tSSO)(IN DWORD SymOptions);

tSSO pSSO;

// StackWalk64()

typedef BOOL(__stdcall* tSW)(DWORD MachineType,

HANDLE hProcess,

HANDLE hThread,

LPSTACKFRAME64 StackFrame,

PVOID ContextRecord,

PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,

PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,

PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine,

PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress);

tSW pSW;

// UnDecorateSymbolName()

typedef DWORD(__stdcall WINAPI* tUDSN)(PCSTR DecoratedName,

PSTR UnDecoratedName,

DWORD UndecoratedLength,

DWORD Flags);

tUDSN pUDSN;

// SymGetSearchPath()

typedef BOOL(__stdcall WINAPI* tSGSP)(HANDLE hProcess, PSTR SearchPath, DWORD SearchPathLength);

tSGSP pSGSP;

// SymAddrIncludeInlineTrace()

typedef DWORD (__stdcall* tSAIIT)(IN HANDLE hProcess,

IN DWORD64 Address);

tSAIIT pSAIIT;

// SymQueryInlineTrace()

typedef BOOL (__stdcall* tSQIT)(IN HANDLE hProcess,

IN DWORD64 StartAddress,

IN DWORD StartContext,

IN DWORD64 StartRetAddress,

IN DWORD64 CurAddress,

OUT LPDWORD CurContext,

OUT LPDWORD CurFrameIndex);

tSQIT pSQIT;

// SymFromInlineContext()

typedef BOOL (__stdcall* tSFIC)(IN HANDLE hProcess,

IN DWORD64 Address,

IN ULONG InlineContext,

OUT PDWORD64 Displacement,

IN OUT PSYMBOL_INFO Symbol);

tSFIC pSFIC;

// SymGetLineFromInlineContext()

typedef BOOL (__stdcall* tSGLFIC)(IN HANDLE hProcess,

IN DWORD64 qwAddr,

IN ULONG InlineContext,

IN OPTIONAL DWORD64 qwModuleBaseAddress,

OUT PDWORD pdwDisplacement,

OUT PIMAGEHLP_LINE64 Line64);

tSGLFIC pSGLFIC;

private:

// **************************************** ToolHelp32 ************************

#define MAX_MODULE_NAME32 255

#define TH32CS_SNAPMODULE 0x00000008

#pragma pack(push, 8)

typedef struct tagMODULEENTRY32

{

DWORD dwSize;

DWORD th32ModuleID; // This module

DWORD th32ProcessID; // owning process

DWORD GlblcntUsage; // Global usage count on the module

DWORD ProccntUsage; // Module usage count in th32ProcessID's context

BYTE* modBaseAddr; // Base address of module in th32ProcessID's context

DWORD modBaseSize; // Size in bytes of module starting at modBaseAddr

HMODULE hModule; // The hModule of this module in th32ProcessID's context

char szModule[MAX_MODULE_NAME32 + 1];

char szExePath[MAX_PATH];

} MODULEENTRY32;

typedef MODULEENTRY32* PMODULEENTRY32;

typedef MODULEENTRY32* LPMODULEENTRY32;

#pragma pack(pop)

BOOL GetModuleListTH32(HANDLE hProcess, DWORD pid)

{

// CreateToolhelp32Snapshot()

typedef HANDLE(__stdcall * tCT32S)(DWORD dwFlags, DWORD th32ProcessID);

// Module32First()

typedef BOOL(__stdcall * tM32F)(HANDLE hSnapshot, LPMODULEENTRY32 lpme);

// Module32Next()

typedef BOOL(__stdcall * tM32N)(HANDLE hSnapshot, LPMODULEENTRY32 lpme);

// try both dlls...

const TCHAR* dllname[] = {_T("kernel32.dll"), _T("tlhelp32.dll")};

HINSTANCE hToolhelp = NULL;

tCT32S pCT32S = NULL;

tM32F pM32F = NULL;

tM32N pM32N = NULL;

HANDLE hSnap;

MODULEENTRY32 me;

me.dwSize = sizeof(me);

BOOL keepGoing;

size_t i;

for (i = 0; i < (sizeof(dllname) / sizeof(dllname[0])); i++)

{

hToolhelp = LoadLibrary(dllname[i]);

if (hToolhelp == NULL)

continue;

pCT32S = (tCT32S)GetProcAddress(hToolhelp, "CreateToolhelp32Snapshot");

pM32F = (tM32F)GetProcAddress(hToolhelp, "Module32First");

pM32N = (tM32N)GetProcAddress(hToolhelp, "Module32Next");

if ((pCT32S != NULL) && (pM32F != NULL) && (pM32N != NULL))

break; // found the functions!

FreeLibrary(hToolhelp);

hToolhelp = NULL;

}

if (hToolhelp == NULL)

return FALSE;

hSnap = pCT32S(TH32CS_SNAPMODULE, pid);

if (hSnap == (HANDLE)-1)

{

FreeLibrary(hToolhelp);

return FALSE;

}

keepGoing = !!pM32F(hSnap, &me);

int cnt = 0;

while (keepGoing)

{

this->LoadModule(hProcess, me.szExePath, me.szModule, (DWORD64)me.modBaseAddr,

me.modBaseSize);

cnt++;

keepGoing = !!pM32N(hSnap, &me);

}

CloseHandle(hSnap);

FreeLibrary(hToolhelp);

if (cnt <= 0)

return FALSE;

return TRUE;

} // GetModuleListTH32

// **************************************** PSAPI ************************

typedef struct _MODULEINFO

{

LPVOID lpBaseOfDll;

DWORD SizeOfImage;

LPVOID EntryPoint;

} MODULEINFO, *LPMODULEINFO;

BOOL GetModuleListPSAPI(HANDLE hProcess)

{

// EnumProcessModules()

typedef BOOL(__stdcall * tEPM)(HANDLE hProcess, HMODULE * lphModule, DWORD cb,

LPDWORD lpcbNeeded);

// GetModuleFileNameEx()

typedef DWORD(__stdcall * tGMFNE)(HANDLE hProcess, HMODULE hModule, LPSTR lpFilename,

DWORD nSize);

// GetModuleBaseName()

typedef DWORD(__stdcall * tGMBN)(HANDLE hProcess, HMODULE hModule, LPSTR lpFilename,

DWORD nSize);

// GetModuleInformation()

typedef BOOL(__stdcall * tGMI)(HANDLE hProcess, HMODULE hModule, LPMODULEINFO pmi, DWORD nSize);

HINSTANCE hPsapi;

tEPM pEPM;

tGMFNE pGMFNE;

tGMBN pGMBN;

tGMI pGMI;

DWORD i;

//ModuleEntry e;

DWORD cbNeeded;

MODULEINFO mi;

HMODULE* hMods = NULL;

char* tt = NULL;

char* tt2 = NULL;

const SIZE_T TTBUFLEN = 8096;

int cnt = 0;

hPsapi = LoadLibrary(_T("psapi.dll"));

if (hPsapi == NULL)

return FALSE;

pEPM = (tEPM)GetProcAddress(hPsapi, "EnumProcessModules");

pGMFNE = (tGMFNE)GetProcAddress(hPsapi, "GetModuleFileNameExA");

pGMBN = (tGMFNE)GetProcAddress(hPsapi, "GetModuleBaseNameA");

pGMI = (tGMI)GetProcAddress(hPsapi, "GetModuleInformation");

if ((pEPM == NULL) || (pGMFNE == NULL) || (pGMBN == NULL) || (pGMI == NULL))

{

// we couldn't find all functions

FreeLibrary(hPsapi);

return FALSE;

}

hMods = (HMODULE*)malloc(sizeof(HMODULE) * (TTBUFLEN / sizeof(HMODULE)));

tt = (char*)malloc(sizeof(char) * TTBUFLEN);

tt2 = (char*)malloc(sizeof(char) * TTBUFLEN);

if ((hMods == NULL) || (tt == NULL) || (tt2 == NULL))

goto cleanup;

if (!pEPM(hProcess, hMods, TTBUFLEN, &cbNeeded))

{

//_ftprintf(fLogFile, _T("%lu: EPM failed, GetLastError = %lu\n"), g_dwShowCount, gle );

goto cleanup;

}

if (cbNeeded > TTBUFLEN)

{

//_ftprintf(fLogFile, _T("%lu: More than %lu module handles. Huh?\n"), g_dwShowCount, lenof( hMods ) );

goto cleanup;

}

for (i = 0; i < cbNeeded / sizeof(hMods[0]); i++)

{

// base address, size

pGMI(hProcess, hMods[i], &mi, sizeof(mi));

// image file name

tt[0] = 0;

pGMFNE(hProcess, hMods[i], tt, TTBUFLEN);

// module name

tt2[0] = 0;

pGMBN(hProcess, hMods[i], tt2, TTBUFLEN);

DWORD dwRes = this->LoadModule(hProcess, tt, tt2, (DWORD64)mi.lpBaseOfDll, mi.SizeOfImage);

if (dwRes != ERROR_SUCCESS)

this->m_parent->OnDbgHelpErr("LoadModule", dwRes, 0);

cnt++;

}

cleanup:

if (hPsapi != NULL)

FreeLibrary(hPsapi);

if (tt2 != NULL)

free(tt2);

if (tt != NULL)

free(tt);

if (hMods != NULL)

free(hMods);

return cnt != 0;

} // GetModuleListPSAPI

DWORD LoadModule(HANDLE hProcess, LPCSTR img, LPCSTR mod, DWORD64 baseAddr, DWORD size)

{

CHAR* szImg = _strdup(img);

CHAR* szMod = _strdup(mod);

DWORD result = ERROR_SUCCESS;

if ((szImg == NULL) || (szMod == NULL))

result = ERROR_NOT_ENOUGH_MEMORY;

else

{

if (pSLM(hProcess, 0, szImg, szMod, baseAddr, size) == 0)

result = GetLastError();

}

ULONGLONG fileVersion = 0;

if ((m_parent != NULL) && (szImg != NULL))

{

// try to retrieve the file-version:

if ((this->m_parent->m_options & StackWalker::RetrieveFileVersion) != 0)

{

VS_FIXEDFILEINFO* fInfo = NULL;

DWORD dwHandle;

DWORD dwSize = GetFileVersionInfoSizeA(szImg, &dwHandle);

if (dwSize > 0)

{

LPVOID vData = malloc(dwSize);

if (vData != NULL)

{

if (GetFileVersionInfoA(szImg, dwHandle, dwSize, vData) != 0)

{

UINT len;

TCHAR szSubBlock[] = _T("\\");

if (VerQueryValue(vData, szSubBlock, (LPVOID*)&fInfo, &len) == 0)

fInfo = NULL;

else

{

fileVersion =

((ULONGLONG)fInfo->dwFileVersionLS) + ((ULONGLONG)fInfo->dwFileVersionMS << 32);

}

}

free(vData);

}

}

}

// Retrieve some additional-infos about the module

IMAGEHLP_MODULE64_V3 Module;

const char* szSymType = "-unknown-";

if (this->GetModuleInfo(hProcess, baseAddr, &Module) != FALSE)

{

switch (Module.SymType)

{

case SymNone:

szSymType = "-nosymbols-";

break;

case SymCoff: // 1

szSymType = "COFF";

break;

case SymCv: // 2

szSymType = "CV";

break;

case SymPdb: // 3

szSymType = "PDB";

break;

case SymExport: // 4

szSymType = "-exported-";

break;

case SymDeferred: // 5

szSymType = "-deferred-";

break;

case SymSym: // 6

szSymType = "SYM";

break;

case 7: // SymDia:

szSymType = "DIA";

break;

case 8: //SymVirtual:

szSymType = "Virtual";

break;

}

}

LPCSTR pdbName = Module.LoadedImageName;

if (Module.LoadedPdbName[0] != 0)

pdbName = Module.LoadedPdbName;

this->m_parent->OnLoadModule(img, mod, baseAddr, size, result, szSymType, pdbName,

fileVersion);

}

if (szImg != NULL)

free(szImg);

if (szMod != NULL)

free(szMod);

return result;

}

public:

BOOL LoadModules(HANDLE hProcess, DWORD dwProcessId)

{

// first try toolhelp32

if (GetModuleListTH32(hProcess, dwProcessId))

return true;

// then try psapi

return GetModuleListPSAPI(hProcess);

}

BOOL GetModuleInfo(HANDLE hProcess, DWORD64 baseAddr, IMAGEHLP_MODULE64_V3* pModuleInfo)

{

memset(pModuleInfo, 0, sizeof(IMAGEHLP_MODULE64_V3));

if (this->pSGMI == NULL)

{

SetLastError(ERROR_DLL_INIT_FAILED);

return FALSE;

}

// First try to use the larger ModuleInfo-Structure

pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64_V3);

void* pData = malloc(

4096); // reserve enough memory, so the bug in v6.3.5.1 does not lead to memory-overwrites...

if (pData == NULL)

{

SetLastError(ERROR_NOT_ENOUGH_MEMORY);

return FALSE;

}

memcpy(pData, pModuleInfo, sizeof(IMAGEHLP_MODULE64_V3));

static bool s_useV3Version = true;

if (s_useV3Version)

{

if (this->pSGMI(hProcess, baseAddr, (IMAGEHLP_MODULE64_V3*)pData) != FALSE)

{

// only copy as much memory as is reserved...

memcpy(pModuleInfo, pData, sizeof(IMAGEHLP_MODULE64_V3));

pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64_V3);

free(pData);

return TRUE;

}

s_useV3Version = false; // to prevent unnecessary calls with the larger struct...

}

// could not retrieve the bigger structure, try with the smaller one (as defined in VC7.1)...

pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64_V2);

memcpy(pData, pModuleInfo, sizeof(IMAGEHLP_MODULE64_V2));

if (this->pSGMI(hProcess, baseAddr, (IMAGEHLP_MODULE64_V3*)pData) != FALSE)

{

// only copy as much memory as is reserved...

memcpy(pModuleInfo, pData, sizeof(IMAGEHLP_MODULE64_V2));

pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64_V2);

free(pData);

return TRUE;

}

free(pData);

SetLastError(ERROR_DLL_INIT_FAILED);

return FALSE;

}

};

// #############################################################

#if defined(_MSC_VER) && _MSC_VER >= 1400 && _MSC_VER < 1900

extern "C" void* __cdecl _getptd();

#endif

#if defined(_MSC_VER) && _MSC_VER >= 1900

extern "C" void** __cdecl __current_exception_context();

#endif

static PCONTEXT get_current_exception_context()

{

PCONTEXT * pctx = NULL;

#if defined(_MSC_VER) && _MSC_VER >= 1400 && _MSC_VER < 1900

LPSTR ptd = (LPSTR)_getptd();

if (ptd)

pctx = (PCONTEXT *)(ptd + (sizeof(void*) == 4 ? 0x8C : 0xF8));

#endif

#if defined(_MSC_VER) && _MSC_VER >= 1900

pctx = (PCONTEXT *)__current_exception_context();

#endif

return pctx ? *pctx : NULL;

}

bool StackWalker::Init(ExceptType extype, int options, LPCSTR szSymPath, DWORD dwProcessId,

HANDLE hProcess, PEXCEPTION_POINTERS exp)

{

PCONTEXT ctx = NULL;

if (extype == AfterCatch)

ctx = get_current_exception_context();

if (extype == AfterExcept && exp)

ctx = exp->ContextRecord;

this->m_options = options;

this->m_modulesLoaded = FALSE;

this->m_szSymPath = NULL;

this->m_MaxRecursionCount = 1000;

this->m_sw = NULL;

SetTargetProcess(dwProcessId, hProcess);

SetSymPath(szSymPath);

/* MSVC ignore std::nothrow specifier for `new` operator */

LPVOID buf = malloc(sizeof(StackWalkerInternal));

if (!buf)

return false;

memset(buf, 0, sizeof(StackWalkerInternal));

this->m_sw = new(buf) StackWalkerInternal(this, this->m_hProcess, ctx); // placement new

return true;

}

StackWalker::StackWalker(DWORD dwProcessId, HANDLE hProcess)

{

Init(NonExcept, OptionsAll, NULL, dwProcessId, hProcess);

}

StackWalker::StackWalker(int options, LPCSTR szSymPath, DWORD dwProcessId, HANDLE hProcess)

{

Init(NonExcept, options, szSymPath, dwProcessId, hProcess);

}

StackWalker::StackWalker(ExceptType extype, int options, PEXCEPTION_POINTERS exp)

{

Init(extype, options, NULL, GetCurrentProcessId(), GetCurrentProcess(), exp);

}

StackWalker::~StackWalker()

{

SetSymPath(NULL);

if (m_sw != NULL) {

m_sw->~StackWalkerInternal(); // call the object's destructor

free(m_sw);

}

m_sw = NULL;

}