Skyscraper 2.0
stackwalker.cpp
Go to the documentation of this file.
1/**********************************************************************
2 *
3 * StackWalker.cpp
4 *
5 *
6 * History:
7 * 2005-07-27 v1 - First public release on http://www.codeproject.com/
8 * http://www.codeproject.com/threads/StackWalker.asp
9 * 2005-07-28 v2 - Changed the params of the constructor and ShowCallstack
10 * (to simplify the usage)
11 * 2005-08-01 v3 - Changed to use 'CONTEXT_FULL' instead of CONTEXT_ALL
12 * (should also be enough)
13 * - Changed to compile correctly with the PSDK of VC7.0
14 * (GetFileVersionInfoSizeA and GetFileVersionInfoA is wrongly defined:
15 * it uses LPSTR instead of LPCSTR as first paremeter)
16 * - Added declarations to support VC5/6 without using 'dbghelp.h'
17 * - Added a 'pUserData' member to the ShowCallstack function and the
18 * PReadProcessMemoryRoutine declaration (to pass some user-defined data,
19 * which can be used in the readMemoryFunction-callback)
20 * 2005-08-02 v4 - OnSymInit now also outputs the OS-Version by default
21 * - Added example for doing an exception-callstack-walking in main.cpp
22 * (thanks to owillebo: http://www.codeproject.com/script/profile/whos_who.asp?id=536268)
23 * 2005-08-05 v5 - Removed most Lint (http://www.gimpel.com/) errors... thanks to Okko Willeboordse!
24 * 2008-08-04 v6 - Fixed Bug: Missing LEAK-end-tag
25 * http://www.codeproject.com/KB/applications/leakfinder.aspx?msg=2502890#xx2502890xx
26 * Fixed Bug: Compiled with "WIN32_LEAN_AND_MEAN"
27 * http://www.codeproject.com/KB/applications/leakfinder.aspx?msg=1824718#xx1824718xx
28 * Fixed Bug: Compiling with "/Wall"
29 * http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=2638243#xx2638243xx
30 * Fixed Bug: Now checking SymUseSymSrv
31 * http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=1388979#xx1388979xx
32 * Fixed Bug: Support for recursive function calls
33 * http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=1434538#xx1434538xx
34 * Fixed Bug: Missing FreeLibrary call in "GetModuleListTH32"
35 * http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=1326923#xx1326923xx
36 * Fixed Bug: SymDia is number 7, not 9!
37 * 2008-09-11 v7 For some (undocumented) reason, dbhelp.h is needing a packing of 8!
38 * Thanks to Teajay which reported the bug...
39 * http://www.codeproject.com/KB/applications/leakfinder.aspx?msg=2718933#xx2718933xx
40 * 2008-11-27 v8 Debugging Tools for Windows are now stored in a different directory
41 * Thanks to Luiz Salamon which reported this "bug"...
42 * http://www.codeproject.com/KB/threads/StackWalker.aspx?msg=2822736#xx2822736xx
43 * 2009-04-10 v9 License slihtly corrected (<ORGANIZATION> replaced)
44 * 2009-11-01- v10 Moved to stackwalker.codeplex.com
45 *
46 * LICENSE (http://www.opensource.org/licenses/bsd-license.php)
47 *
48 * Copyright (c) 2005-2009, Jochen Kalmbach
49 * All rights reserved.
50 *
51 * Redistribution and use in source and binary forms, with or without modification,
52 * are permitted provided that the following conditions are met:
53 *
54 * Redistributions of source code must retain the above copyright notice,
55 * this list of conditions and the following disclaimer.
56 * Redistributions in binary form must reproduce the above copyright notice,
57 * this list of conditions and the following disclaimer in the documentation
58 * and/or other materials provided with the distribution.
59 * Neither the name of Jochen Kalmbach nor the names of its contributors may be
60 * used to endorse or promote products derived from this software without
61 * specific prior written permission.
62 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
63 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
64 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
65 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
66 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
67 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
68 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
69 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
70 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
71 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
72 *
73 **********************************************************************/
74#include "globals.h"
75
76#if OGRE_CPU != OGRE_CPU_ARM
77#ifdef _WIN32
78#include <windows.h>
79#include <tchar.h>
80#include <stdio.h>
81#include <stdlib.h>
82#pragma comment(lib, "version.lib") // for "VerQueryValue"
83#pragma warning(disable:4826)
84
85#include "StackWalker.h"
86
87
88// If VC7 and later, then use the shipped 'dbghelp.h'-file
89#pragma pack(push,8)
90#if _MSC_VER >= 1300
91#include <dbghelp.h>
92#else
93// inline the important dbghelp.h-declarations...
94typedef enum {
95 SymNone = 0,
96 SymCoff,
97 SymCv,
98 SymPdb,
99 SymExport,
100 SymDeferred,
101 SymSym,
102 SymDia,
103 SymVirtual,
104 NumSymTypes
105} SYM_TYPE;
106typedef struct _IMAGEHLP_LINE64 {
107 DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_LINE64)
108 PVOID Key; // internal
109 DWORD LineNumber; // line number in file
110 PCHAR FileName; // full filename
111 DWORD64 Address; // first instruction of line
112} IMAGEHLP_LINE64, *PIMAGEHLP_LINE64;
113typedef struct _IMAGEHLP_MODULE64 {
114 DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_MODULE64)
115 DWORD64 BaseOfImage; // base load address of module
116 DWORD ImageSize; // virtual size of the loaded module
117 DWORD TimeDateStamp; // date/time stamp from pe header
118 DWORD CheckSum; // checksum from the pe header
119 DWORD NumSyms; // number of symbols in the symbol table
120 SYM_TYPE SymType; // type of symbols loaded
121 CHAR ModuleName[32]; // module name
122 CHAR ImageName[256]; // image name
123 CHAR LoadedImageName[256]; // symbol file name
124} IMAGEHLP_MODULE64, *PIMAGEHLP_MODULE64;
125typedef struct _IMAGEHLP_SYMBOL64 {
126 DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_SYMBOL64)
127 DWORD64 Address; // virtual address including dll base address
128 DWORD Size; // estimated size of symbol, can be zero
129 DWORD Flags; // info about the symbols, see the SYMF defines
130 DWORD MaxNameLength; // maximum size of symbol name in 'Name'
131 CHAR Name[1]; // symbol name (null terminated string)
132} IMAGEHLP_SYMBOL64, *PIMAGEHLP_SYMBOL64;
133typedef enum {
134 AddrMode1616,
135 AddrMode1632,
136 AddrModeReal,
137 AddrModeFlat
138} ADDRESS_MODE;
139typedef struct _tagADDRESS64 {
140 DWORD64 Offset;
141 WORD Segment;
142 ADDRESS_MODE Mode;
143} ADDRESS64, *LPADDRESS64;
144typedef struct _KDHELP64 {
145 DWORD64 Thread;
146 DWORD ThCallbackStack;
147 DWORD ThCallbackBStore;
148 DWORD NextCallback;
149 DWORD FramePointer;
150 DWORD64 KiCallUserMode;
151 DWORD64 KeUserCallbackDispatcher;
152 DWORD64 SystemRangeStart;
153 DWORD64 Reserved[8];
154} KDHELP64, *PKDHELP64;
155typedef struct _tagSTACKFRAME64 {
156 ADDRESS64 AddrPC; // program counter
157 ADDRESS64 AddrReturn; // return address
158 ADDRESS64 AddrFrame; // frame pointer
159 ADDRESS64 AddrStack; // stack pointer
160 ADDRESS64 AddrBStore; // backing store pointer
161 PVOID FuncTableEntry; // pointer to pdata/fpo or NULL
162 DWORD64 Params[4]; // possible arguments to the function
163 BOOL Far; // WOW far call
164 BOOL Virtual; // is this a virtual frame?
165 DWORD64 Reserved[3];
166 KDHELP64 KdHelp;
167} STACKFRAME64, *LPSTACKFRAME64;
168typedef
169BOOL
170(__stdcall *PREAD_PROCESS_MEMORY_ROUTINE64)(
171 HANDLE hProcess,
172 DWORD64 qwBaseAddress,
173 PVOID lpBuffer,
174 DWORD nSize,
175 LPDWORD lpNumberOfBytesRead
176 );
177typedef
178PVOID
179(__stdcall *PFUNCTION_TABLE_ACCESS_ROUTINE64)(
180 HANDLE hProcess,
181 DWORD64 AddrBase
182 );
183typedef
184DWORD64
185(__stdcall *PGET_MODULE_BASE_ROUTINE64)(
186 HANDLE hProcess,
187 DWORD64 Address
188 );
189typedef
190DWORD64
191(__stdcall *PTRANSLATE_ADDRESS_ROUTINE64)(
192 HANDLE hProcess,
193 HANDLE hThread,
194 LPADDRESS64 lpaddr
195 );
196#define SYMOPT_CASE_INSENSITIVE 0x00000001
197#define SYMOPT_UNDNAME 0x00000002
198#define SYMOPT_DEFERRED_LOADS 0x00000004
199#define SYMOPT_NO_CPP 0x00000008
200#define SYMOPT_LOAD_LINES 0x00000010
201#define SYMOPT_OMAP_FIND_NEAREST 0x00000020
202#define SYMOPT_LOAD_ANYTHING 0x00000040
203#define SYMOPT_IGNORE_CVREC 0x00000080
204#define SYMOPT_NO_UNQUALIFIED_LOADS 0x00000100
205#define SYMOPT_FAIL_CRITICAL_ERRORS 0x00000200
206#define SYMOPT_EXACT_SYMBOLS 0x00000400
207#define SYMOPT_ALLOW_ABSOLUTE_SYMBOLS 0x00000800
208#define SYMOPT_IGNORE_NT_SYMPATH 0x00001000
209#define SYMOPT_INCLUDE_32BIT_MODULES 0x00002000
210#define SYMOPT_PUBLICS_ONLY 0x00004000
211#define SYMOPT_NO_PUBLICS 0x00008000
212#define SYMOPT_AUTO_PUBLICS 0x00010000
213#define SYMOPT_NO_IMAGE_SEARCH 0x00020000
214#define SYMOPT_SECURE 0x00040000
215#define SYMOPT_DEBUG 0x80000000
216#define UNDNAME_COMPLETE (0x0000) // Enable full undecoration
217#define UNDNAME_NAME_ONLY (0x1000) // Crack only the name for primary declaration;
218#endif // _MSC_VER < 1300
219#pragma pack(pop)
220
221// Some missing defines (for VC5/6):
222#ifndef INVALID_FILE_ATTRIBUTES
223#define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
224#endif
225
226
227// secure-CRT_functions are only available starting with VC8
228#if _MSC_VER < 1400
229#define strcpy_s strcpy
230#define strcat_s(dst, len, src) strcat(dst, src)
231#define _snprintf_s _snprintf
232#define _tcscat_s _tcscat
233#endif
234
235// Normally it should be enough to use 'CONTEXT_FULL' (better would be 'CONTEXT_ALL')
236#define USED_CONTEXT_FLAGS CONTEXT_FULL
237
238
239class StackWalkerInternal
240{
241public:
242 StackWalkerInternal(StackWalker *parent, HANDLE hProcess)
243 {
244 m_parent = parent;
245 m_hDbhHelp = NULL;
246 pSC = NULL;
247 m_hProcess = hProcess;
248 m_szSymPath = NULL;
249 pSFTA = NULL;
250 pSGLFA = NULL;
251 pSGMB = NULL;
252 pSGMI = NULL;
253 pSGO = NULL;
254 pSGSFA = NULL;
255 pSI = NULL;
256 pSLM = NULL;
257 pSSO = NULL;
258 pSW = NULL;
259 pUDSN = NULL;
260 pSGSP = NULL;
261 }
262 ~StackWalkerInternal()
263 {
264 if (pSC != NULL)
265 pSC(m_hProcess); // SymCleanup
266 if (m_hDbhHelp != NULL)
267 FreeLibrary(m_hDbhHelp);
268 m_hDbhHelp = NULL;
269 m_parent = NULL;
270 if(m_szSymPath != NULL)
271 free(m_szSymPath);
272 m_szSymPath = NULL;
273 }
274 BOOL Init(LPCSTR szSymPath)
275 {
276 if (m_parent == NULL)
277 return FALSE;
278 // Dynamically load the Entry-Points for dbghelp.dll:
279 // First try to load the newsest one from
280 TCHAR szTemp[4096];
281 // But before wqe do this, we first check if the ".local" file exists
282 if (GetModuleFileName(NULL, szTemp, 4096) > 0)
283 {
284 _tcscat_s(szTemp, _T(".local"));
285 if (GetFileAttributes(szTemp) == INVALID_FILE_ATTRIBUTES)
286 {
287 // ".local" file does not exist, so we can try to load the dbghelp.dll from the "Debugging Tools for Windows"
288 // Ok, first try the new path according to the archtitecture:
289#ifdef _M_IX86
290 if ( (m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0) )
291 {
292 _tcscat_s(szTemp, _T("\\Debugging Tools for Windows (x86)\\dbghelp.dll"));
293 // now check if the file exists:
294 if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)
295 {
296 m_hDbhHelp = LoadLibrary(szTemp);
297 }
298 }
299#elif _M_X64
300 if ( (m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0) )
301 {
302 _tcscat_s(szTemp, _T("\\Debugging Tools for Windows (x64)\\dbghelp.dll"));
303 // now check if the file exists:
304 if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)
305 {
306 m_hDbhHelp = LoadLibrary(szTemp);
307 }
308 }
309#elif _M_IA64
310 if ( (m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0) )
311 {
312 _tcscat_s(szTemp, _T("\\Debugging Tools for Windows (ia64)\\dbghelp.dll"));
313 // now check if the file exists:
314 if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)
315 {
316 m_hDbhHelp = LoadLibrary(szTemp);
317 }
318 }
319#endif
320 // If still not found, try the old directories...
321 if ( (m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0) )
322 {
323 _tcscat_s(szTemp, _T("\\Debugging Tools for Windows\\dbghelp.dll"));
324 // now check if the file exists:
325 if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)
326 {
327 m_hDbhHelp = LoadLibrary(szTemp);
328 }
329 }
330#if defined _M_X64 || defined _M_IA64
331 // Still not found? Then try to load the (old) 64-Bit version:
332 if ( (m_hDbhHelp == NULL) && (GetEnvironmentVariable(_T("ProgramFiles"), szTemp, 4096) > 0) )
333 {
334 _tcscat_s(szTemp, _T("\\Debugging Tools for Windows 64-Bit\\dbghelp.dll"));
335 if (GetFileAttributes(szTemp) != INVALID_FILE_ATTRIBUTES)
336 {
337 m_hDbhHelp = LoadLibrary(szTemp);
338 }
339 }
340#endif
341 }
342 }
343 if (m_hDbhHelp == NULL) // if not already loaded, try to load a default-one
344 m_hDbhHelp = LoadLibrary( _T("dbghelp.dll") );
345 if (m_hDbhHelp == NULL)
346 return FALSE;
347 pSI = (tSI) GetProcAddress(m_hDbhHelp, "SymInitialize" );
348 pSC = (tSC) GetProcAddress(m_hDbhHelp, "SymCleanup" );
349
350 pSW = (tSW) GetProcAddress(m_hDbhHelp, "StackWalk64" );
351 pSGO = (tSGO) GetProcAddress(m_hDbhHelp, "SymGetOptions" );
352 pSSO = (tSSO) GetProcAddress(m_hDbhHelp, "SymSetOptions" );
353
354 pSFTA = (tSFTA) GetProcAddress(m_hDbhHelp, "SymFunctionTableAccess64" );
355 pSGLFA = (tSGLFA) GetProcAddress(m_hDbhHelp, "SymGetLineFromAddr64" );
356 pSGMB = (tSGMB) GetProcAddress(m_hDbhHelp, "SymGetModuleBase64" );
357 pSGMI = (tSGMI) GetProcAddress(m_hDbhHelp, "SymGetModuleInfo64" );
358 //pSGMI_V3 = (tSGMI_V3) GetProcAddress(m_hDbhHelp, "SymGetModuleInfo64" );
359 pSGSFA = (tSGSFA) GetProcAddress(m_hDbhHelp, "SymGetSymFromAddr64" );
360 pUDSN = (tUDSN) GetProcAddress(m_hDbhHelp, "UnDecorateSymbolName" );
361 pSLM = (tSLM) GetProcAddress(m_hDbhHelp, "SymLoadModule64" );
362 pSGSP =(tSGSP) GetProcAddress(m_hDbhHelp, "SymGetSearchPath" );
363
364 if ( pSC == NULL || pSFTA == NULL || pSGMB == NULL || pSGMI == NULL ||
365 pSGO == NULL || pSGSFA == NULL || pSI == NULL || pSSO == NULL ||
366 pSW == NULL || pUDSN == NULL || pSLM == NULL )
367 {
368 FreeLibrary(m_hDbhHelp);
369 m_hDbhHelp = NULL;
370 pSC = NULL;
371 return FALSE;
372 }
373
374 // SymInitialize
375 if (szSymPath != NULL)
376 m_szSymPath = _strdup(szSymPath);
377 if (this->pSI(m_hProcess, m_szSymPath, FALSE) == FALSE)
378 this->m_parent->OnDbgHelpErr("SymInitialize", GetLastError(), 0);
379
380 DWORD symOptions = this->pSGO(); // SymGetOptions
381 symOptions |= SYMOPT_LOAD_LINES;
382 symOptions |= SYMOPT_FAIL_CRITICAL_ERRORS;
383 //symOptions |= SYMOPT_NO_PROMPTS;
384 // SymSetOptions
385 symOptions = this->pSSO(symOptions);
386
387 char buf[StackWalker::STACKWALK_MAX_NAMELEN] = {0};
388 if (this->pSGSP != NULL)
389 {
390 if (this->pSGSP(m_hProcess, buf, StackWalker::STACKWALK_MAX_NAMELEN) == FALSE)
391 this->m_parent->OnDbgHelpErr("SymGetSearchPath", GetLastError(), 0);
392 }
393 char szUserName[1024] = {0};
394 DWORD dwSize = 1024;
395 GetUserNameA(szUserName, &dwSize);
396 this->m_parent->OnSymInit(buf, symOptions, szUserName);
397
398 return TRUE;
399 }
400
401 StackWalker *m_parent;
402
403 HMODULE m_hDbhHelp;
404 HANDLE m_hProcess;
405 LPSTR m_szSymPath;
406
407/*typedef struct IMAGEHLP_MODULE64_V3 {
408 DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_MODULE64)
409 DWORD64 BaseOfImage; // base load address of module
410 DWORD ImageSize; // virtual size of the loaded module
411 DWORD TimeDateStamp; // date/time stamp from pe header
412 DWORD CheckSum; // checksum from the pe header
413 DWORD NumSyms; // number of symbols in the symbol table
414 SYM_TYPE SymType; // type of symbols loaded
415 CHAR ModuleName[32]; // module name
416 CHAR ImageName[256]; // image name
417 // new elements: 07-Jun-2002
418 CHAR LoadedImageName[256]; // symbol file name
419 CHAR LoadedPdbName[256]; // pdb file name
420 DWORD CVSig; // Signature of the CV record in the debug directories
421 CHAR CVData[MAX_PATH * 3]; // Contents of the CV record
422 DWORD PdbSig; // Signature of PDB
423 GUID PdbSig70; // Signature of PDB (VC 7 and up)
424 DWORD PdbAge; // DBI age of pdb
425 BOOL PdbUnmatched; // loaded an unmatched pdb
426 BOOL DbgUnmatched; // loaded an unmatched dbg
427 BOOL LineNumbers; // we have line number information
428 BOOL GlobalSymbols; // we have internal symbol information
429 BOOL TypeInfo; // we have type information
430 // new elements: 17-Dec-2003
431 BOOL SourceIndexed; // pdb supports source server
432 BOOL Publics; // contains public symbols
433};
434*/
435
436#pragma pack(push,8)
437typedef struct IMAGEHLP_MODULE64_V2 {
438 DWORD SizeOfStruct; // set to sizeof(IMAGEHLP_MODULE64)
439 DWORD64 BaseOfImage; // base load address of module
440 DWORD ImageSize; // virtual size of the loaded module
441 DWORD TimeDateStamp; // date/time stamp from pe header
442 DWORD CheckSum; // checksum from the pe header
443 DWORD NumSyms; // number of symbols in the symbol table
444 SYM_TYPE SymType; // type of symbols loaded
445 CHAR ModuleName[32]; // module name
446 CHAR ImageName[256]; // image name
447 CHAR LoadedImageName[256]; // symbol file name
448};
449#pragma pack(pop)
450
451
452 // SymCleanup()
453 typedef BOOL (__stdcall *tSC)( IN HANDLE hProcess );
454 tSC pSC;
455
456 // SymFunctionTableAccess64()
457 typedef PVOID (__stdcall *tSFTA)( HANDLE hProcess, DWORD64 AddrBase );
458 tSFTA pSFTA;
459
460 // SymGetLineFromAddr64()
461 typedef BOOL (__stdcall *tSGLFA)( IN HANDLE hProcess, IN DWORD64 dwAddr,
462 OUT PDWORD pdwDisplacement, OUT PIMAGEHLP_LINE64 Line );
463 tSGLFA pSGLFA;
464
465 // SymGetModuleBase64()
466 typedef DWORD64 (__stdcall *tSGMB)( IN HANDLE hProcess, IN DWORD64 dwAddr );
467 tSGMB pSGMB;
468
469 // SymGetModuleInfo64()
470 typedef BOOL (__stdcall *tSGMI)( IN HANDLE hProcess, IN DWORD64 dwAddr, OUT IMAGEHLP_MODULE64_V2 *ModuleInfo );
471 tSGMI pSGMI;
472
473// // SymGetModuleInfo64()
474// typedef BOOL (__stdcall *tSGMI_V3)( IN HANDLE hProcess, IN DWORD64 dwAddr, OUT IMAGEHLP_MODULE64_V3 *ModuleInfo );
475// tSGMI_V3 pSGMI_V3;
476
477 // SymGetOptions()
478 typedef DWORD (__stdcall *tSGO)( VOID );
479 tSGO pSGO;
480
481 // SymGetSymFromAddr64()
482 typedef BOOL (__stdcall *tSGSFA)( IN HANDLE hProcess, IN DWORD64 dwAddr,
483 OUT PDWORD64 pdwDisplacement, OUT PIMAGEHLP_SYMBOL64 Symbol );
484 tSGSFA pSGSFA;
485
486 // SymInitialize()
487 typedef BOOL (__stdcall *tSI)( IN HANDLE hProcess, IN PSTR UserSearchPath, IN BOOL fInvadeProcess );
488 tSI pSI;
489
490 // SymLoadModule64()
491 typedef DWORD64 (__stdcall *tSLM)( IN HANDLE hProcess, IN HANDLE hFile,
492 IN PSTR ImageName, IN PSTR ModuleName, IN DWORD64 BaseOfDll, IN DWORD SizeOfDll );
493 tSLM pSLM;
494
495 // SymSetOptions()
496 typedef DWORD (__stdcall *tSSO)( IN DWORD SymOptions );
497 tSSO pSSO;
498
499 // StackWalk64()
500 typedef BOOL (__stdcall *tSW)(
501 DWORD MachineType,
502 HANDLE hProcess,
503 HANDLE hThread,
504 LPSTACKFRAME64 StackFrame,
505 PVOID ContextRecord,
506 PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,
507 PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,
508 PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine,
509 PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress );
510 tSW pSW;
511
512 // UnDecorateSymbolName()
513 typedef DWORD (__stdcall WINAPI *tUDSN)( PCSTR DecoratedName, PSTR UnDecoratedName,
514 DWORD UndecoratedLength, DWORD Flags );
515 tUDSN pUDSN;
516
517 typedef BOOL (__stdcall WINAPI *tSGSP)(HANDLE hProcess, PSTR SearchPath, DWORD SearchPathLength);
518 tSGSP pSGSP;
519
520
521private:
522 // **************************************** ToolHelp32 ************************
523 #define MAX_MODULE_NAME32 255
524 #define TH32CS_SNAPMODULE 0x00000008
525 #pragma pack( push, 8 )
526 typedef struct tagMODULEENTRY32
527 {
528 DWORD dwSize;
529 DWORD th32ModuleID; // This module
530 DWORD th32ProcessID; // owning process
531 DWORD GlblcntUsage; // Global usage count on the module
532 DWORD ProccntUsage; // Module usage count in th32ProcessID's context
533 BYTE * modBaseAddr; // Base address of module in th32ProcessID's context
534 DWORD modBaseSize; // Size in bytes of module starting at modBaseAddr
535 HMODULE hModule; // The hModule of this module in th32ProcessID's context
536 char szModule[MAX_MODULE_NAME32 + 1];
537 char szExePath[MAX_PATH];
538 } MODULEENTRY32;
539 typedef MODULEENTRY32 * PMODULEENTRY32;
540 typedef MODULEENTRY32 * LPMODULEENTRY32;
541 #pragma pack( pop )
542
543 BOOL GetModuleListTH32(HANDLE hProcess, DWORD pid)
544 {
545 // CreateToolhelp32Snapshot()
546 typedef HANDLE (__stdcall *tCT32S)(DWORD dwFlags, DWORD th32ProcessID);
547 // Module32First()
548 typedef BOOL (__stdcall *tM32F)(HANDLE hSnapshot, LPMODULEENTRY32 lpme);
549 // Module32Next()
550 typedef BOOL (__stdcall *tM32N)(HANDLE hSnapshot, LPMODULEENTRY32 lpme);
551
552 // try both dlls...
553 const TCHAR *dllname[] = { _T("kernel32.dll"), _T("tlhelp32.dll") };
554 HINSTANCE hToolhelp = NULL;
555 tCT32S pCT32S = NULL;
556 tM32F pM32F = NULL;
557 tM32N pM32N = NULL;
558
559 HANDLE hSnap;
560 MODULEENTRY32 me;
561 me.dwSize = sizeof(me);
562 BOOL keepGoing;
563 size_t i;
564
565 for (i = 0; i<(sizeof(dllname) / sizeof(dllname[0])); i++ )
566 {
567 hToolhelp = LoadLibrary( dllname[i] );
568 if (hToolhelp == NULL)
569 continue;
570 pCT32S = (tCT32S) GetProcAddress(hToolhelp, "CreateToolhelp32Snapshot");
571 pM32F = (tM32F) GetProcAddress(hToolhelp, "Module32First");
572 pM32N = (tM32N) GetProcAddress(hToolhelp, "Module32Next");
573 if ( (pCT32S != NULL) && (pM32F != NULL) && (pM32N != NULL) )
574 break; // found the functions!
575 FreeLibrary(hToolhelp);
576 hToolhelp = NULL;
577 }
578
579 if (hToolhelp == NULL)
580 return FALSE;
581
582 hSnap = pCT32S( TH32CS_SNAPMODULE, pid );
583 if (hSnap == (HANDLE) -1)
584 {
585 FreeLibrary(hToolhelp);
586 return FALSE;
587 }
588
589 keepGoing = !!pM32F( hSnap, &me );
590 int cnt = 0;
591 while (keepGoing)
592 {
593 this->LoadModule(hProcess, me.szExePath, me.szModule, (DWORD64) me.modBaseAddr, me.modBaseSize);
594 cnt++;
595 keepGoing = !!pM32N( hSnap, &me );
596 }
597 CloseHandle(hSnap);
598 FreeLibrary(hToolhelp);
599 if (cnt <= 0)
600 return FALSE;
601 return TRUE;
602 } // GetModuleListTH32
603
604 // **************************************** PSAPI ************************
605 typedef struct _MODULEINFO {
606 LPVOID lpBaseOfDll;
607 DWORD SizeOfImage;
608 LPVOID EntryPoint;
609 } MODULEINFO, *LPMODULEINFO;
610
611 BOOL GetModuleListPSAPI(HANDLE hProcess)
612 {
613 // EnumProcessModules()
614 typedef BOOL (__stdcall *tEPM)(HANDLE hProcess, HMODULE *lphModule, DWORD cb, LPDWORD lpcbNeeded );
615 // GetModuleFileNameEx()
616 typedef DWORD (__stdcall *tGMFNE)(HANDLE hProcess, HMODULE hModule, LPSTR lpFilename, DWORD nSize );
617 // GetModuleBaseName()
618 typedef DWORD (__stdcall *tGMBN)(HANDLE hProcess, HMODULE hModule, LPSTR lpFilename, DWORD nSize );
619 // GetModuleInformation()
620 typedef BOOL (__stdcall *tGMI)(HANDLE hProcess, HMODULE hModule, LPMODULEINFO pmi, DWORD nSize );
621
622 HINSTANCE hPsapi;
623 tEPM pEPM;
624 tGMFNE pGMFNE;
625 tGMBN pGMBN;
626 tGMI pGMI;
627
628 DWORD i;
629 //ModuleEntry e;
630 DWORD cbNeeded;
631 MODULEINFO mi;
632 HMODULE *hMods = 0;
633 char *tt = NULL;
634 char *tt2 = NULL;
635 const SIZE_T TTBUFLEN = 8096;
636 int cnt = 0;
637
638 hPsapi = LoadLibrary( _T("psapi.dll") );
639 if (hPsapi == NULL)
640 return FALSE;
641
642 pEPM = (tEPM) GetProcAddress( hPsapi, "EnumProcessModules" );
643 pGMFNE = (tGMFNE) GetProcAddress( hPsapi, "GetModuleFileNameExA" );
644 pGMBN = (tGMFNE) GetProcAddress( hPsapi, "GetModuleBaseNameA" );
645 pGMI = (tGMI) GetProcAddress( hPsapi, "GetModuleInformation" );
646 if ( (pEPM == NULL) || (pGMFNE == NULL) || (pGMBN == NULL) || (pGMI == NULL) )
647 {
648 // we couldn�t find all functions
649 FreeLibrary(hPsapi);
650 return FALSE;
651 }
652
653 hMods = (HMODULE*) malloc(sizeof(HMODULE) * (TTBUFLEN / sizeof HMODULE));
654 tt = (char*) malloc(sizeof(char) * TTBUFLEN);
655 tt2 = (char*) malloc(sizeof(char) * TTBUFLEN);
656 if ( (hMods == NULL) || (tt == NULL) || (tt2 == NULL) )
657 goto cleanup;
658
659 if ( ! pEPM( hProcess, hMods, TTBUFLEN, &cbNeeded ) )
660 {
661 //_ftprintf(fLogFile, _T("%lu: EPM failed, GetLastError = %lu\n"), g_dwShowCount, gle );
662 goto cleanup;
663 }
664
665 if ( cbNeeded > TTBUFLEN )
666 {
667 //_ftprintf(fLogFile, _T("%lu: More than %lu module handles. Huh?\n"), g_dwShowCount, lenof( hMods ) );
668 goto cleanup;
669 }
670
671 for ( i = 0; i < cbNeeded / sizeof hMods[0]; i++ )
672 {
673 // base address, size
674 pGMI(hProcess, hMods[i], &mi, sizeof mi );
675 // image file name
676 tt[0] = 0;
677 pGMFNE(hProcess, hMods[i], tt, TTBUFLEN );
678 // module name
679 tt2[0] = 0;
680 pGMBN(hProcess, hMods[i], tt2, TTBUFLEN );
681
682 DWORD dwRes = this->LoadModule(hProcess, tt, tt2, (DWORD64) mi.lpBaseOfDll, mi.SizeOfImage);
683 if (dwRes != ERROR_SUCCESS)
684 this->m_parent->OnDbgHelpErr("LoadModule", dwRes, 0);
685 cnt++;
686 }
687
688 cleanup:
689 if (hPsapi != NULL) FreeLibrary(hPsapi);
690 if (tt2 != NULL) free(tt2);
691 if (tt != NULL) free(tt);
692 if (hMods != NULL) free(hMods);
693
694 return cnt != 0;
695 } // GetModuleListPSAPI
696
697 DWORD LoadModule(HANDLE hProcess, LPCSTR img, LPCSTR mod, DWORD64 baseAddr, DWORD size)
698 {
699 CHAR *szImg = _strdup(img);
700 CHAR *szMod = _strdup(mod);
701 DWORD result = ERROR_SUCCESS;
702 if ( (szImg == NULL) || (szMod == NULL) )
703 result = ERROR_NOT_ENOUGH_MEMORY;
704 else
705 {
706 if (pSLM(hProcess, 0, szImg, szMod, baseAddr, size) == 0)
707 result = GetLastError();
708 }
709 ULONGLONG fileVersion = 0;
710 if ( (m_parent != NULL) && (szImg != NULL) )
711 {
712 // try to retrive the file-version:
713 if ( (this->m_parent->m_options & StackWalker::RetrieveFileVersion) != 0)
714 {
715 VS_FIXEDFILEINFO *fInfo = NULL;
716 DWORD dwHandle;
717 DWORD dwSize = GetFileVersionInfoSizeA(szImg, &dwHandle);
718 if (dwSize > 0)
719 {
720 LPVOID vData = malloc(dwSize);
721 if (vData != NULL)
722 {
723 if (GetFileVersionInfoA(szImg, dwHandle, dwSize, vData) != 0)
724 {
725 UINT len;
726 TCHAR szSubBlock[] = _T("\\");
727 if (VerQueryValue(vData, szSubBlock, (LPVOID*) &fInfo, &len) == 0)
728 fInfo = NULL;
729 else
730 {
731 fileVersion = ((ULONGLONG)fInfo->dwFileVersionLS) + ((ULONGLONG)fInfo->dwFileVersionMS << 32);
732 }
733 }
734 free(vData);
735 }
736 }
737 }
738
739 // Retrive some additional-infos about the module
740 IMAGEHLP_MODULE64_V2 Module;
741 const char *szSymType = "-unknown-";
742 if (this->GetModuleInfo(hProcess, baseAddr, &Module) != FALSE)
743 {
744 switch(Module.SymType)
745 {
746 case SymNone:
747 szSymType = "-nosymbols-";
748 break;
749 case SymCoff: // 1
750 szSymType = "COFF";
751 break;
752 case SymCv: // 2
753 szSymType = "CV";
754 break;
755 case SymPdb: // 3
756 szSymType = "PDB";
757 break;
758 case SymExport: // 4
759 szSymType = "-exported-";
760 break;
761 case SymDeferred: // 5
762 szSymType = "-deferred-";
763 break;
764 case SymSym: // 6
765 szSymType = "SYM";
766 break;
767 case 7: // SymDia:
768 szSymType = "DIA";
769 break;
770 case 8: //SymVirtual:
771 szSymType = "Virtual";
772 break;
773 }
774 }
775 this->m_parent->OnLoadModule(img, mod, baseAddr, size, result, szSymType, Module.LoadedImageName, fileVersion);
776 }
777 if (szImg != NULL) free(szImg);
778 if (szMod != NULL) free(szMod);
779 return result;
780 }
781public:
782 BOOL LoadModules(HANDLE hProcess, DWORD dwProcessId)
783 {
784 // first try toolhelp32
785 if (GetModuleListTH32(hProcess, dwProcessId))
786 return true;
787 // then try psapi
788 return GetModuleListPSAPI(hProcess);
789 }
790
791
792 BOOL GetModuleInfo(HANDLE hProcess, DWORD64 baseAddr, IMAGEHLP_MODULE64_V2 *pModuleInfo)
793 {
794 if(this->pSGMI == NULL)
795 {
796 SetLastError(ERROR_DLL_INIT_FAILED);
797 return FALSE;
798 }
799 // First try to use the larger ModuleInfo-Structure
800// memset(pModuleInfo, 0, sizeof(IMAGEHLP_MODULE64_V3));
801// pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64_V3);
802// if (this->pSGMI_V3 != NULL)
803// {
804// if (this->pSGMI_V3(hProcess, baseAddr, pModuleInfo) != FALSE)
805// return TRUE;
806// // check if the parameter was wrong (size is bad...)
807// if (GetLastError() != ERROR_INVALID_PARAMETER)
808// return FALSE;
809// }
810 // could not retrive the bigger structure, try with the smaller one (as defined in VC7.1)...
811 pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64_V2);
812 void *pData = malloc(4096); // reserve enough memory, so the bug in v6.3.5.1 does not lead to memory-overwrites...
813 if (pData == NULL)
814 {
815 SetLastError(ERROR_NOT_ENOUGH_MEMORY);
816 return FALSE;
817 }
818 memcpy(pData, pModuleInfo, sizeof(IMAGEHLP_MODULE64_V2));
819 if (this->pSGMI(hProcess, baseAddr, (IMAGEHLP_MODULE64_V2*) pData) != FALSE)
820 {
821 // only copy as much memory as is reserved...
822 memcpy(pModuleInfo, pData, sizeof(IMAGEHLP_MODULE64_V2));
823 pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64_V2);
824 free(pData);
825 return TRUE;
826 }
827 free(pData);
828 SetLastError(ERROR_DLL_INIT_FAILED);
829 return FALSE;
830 }
831};
832
833// #############################################################
834StackWalker::StackWalker(DWORD dwProcessId, HANDLE hProcess)
835{
836 this->m_options = OptionsAll;
837 this->m_modulesLoaded = FALSE;
838 this->m_hProcess = hProcess;
839 this->m_sw = new StackWalkerInternal(this, this->m_hProcess);
840 this->m_dwProcessId = dwProcessId;
841 this->m_szSymPath = NULL;
842 this->m_MaxRecursionCount = 1000;
843}
844StackWalker::StackWalker(int options, LPCSTR szSymPath, DWORD dwProcessId, HANDLE hProcess)
845{
846 this->m_options = options;
847 this->m_modulesLoaded = FALSE;
848 this->m_hProcess = hProcess;
849 this->m_sw = new StackWalkerInternal(this, this->m_hProcess);
850 this->m_dwProcessId = dwProcessId;
851 if (szSymPath != NULL)
852 {
853 this->m_szSymPath = _strdup(szSymPath);
854 this->m_options |= SymBuildPath;
855 }
856 else
857 this->m_szSymPath = NULL;
858 this->m_MaxRecursionCount = 1000;
859}
860
861StackWalker::~StackWalker()
862{
863 if (m_szSymPath != NULL)
864 free(m_szSymPath);
865 m_szSymPath = NULL;
866 if (this->m_sw != NULL)
867 delete this->m_sw;
868 this->m_sw = NULL;
869}
870
871BOOL StackWalker::LoadModules()
872{
873 if (this->m_sw == NULL)
874 {
875 SetLastError(ERROR_DLL_INIT_FAILED);
876 return FALSE;
877 }
878 if (m_modulesLoaded != FALSE)
879 return TRUE;
880
881 // Build the sym-path:
882 char *szSymPath = NULL;
883 if ( (this->m_options & SymBuildPath) != 0)
884 {
885 const size_t nSymPathLen = 4096;
886 szSymPath = (char*) malloc(nSymPathLen);
887 if (szSymPath == NULL)
888 {
889 SetLastError(ERROR_NOT_ENOUGH_MEMORY);
890 return FALSE;
891 }
892 szSymPath[0] = 0;
893 // Now first add the (optional) provided sympath:
894 if (this->m_szSymPath != NULL)
895 {
896 strcat_s(szSymPath, nSymPathLen, this->m_szSymPath);
897 strcat_s(szSymPath, nSymPathLen, ";");
898 }
899
900 strcat_s(szSymPath, nSymPathLen, ".;");
901
902 const size_t nTempLen = 1024;
903 char szTemp[nTempLen];
904 // Now add the current directory:
905 if (GetCurrentDirectoryA(nTempLen, szTemp) > 0)
906 {
907 szTemp[nTempLen-1] = 0;
908 strcat_s(szSymPath, nSymPathLen, szTemp);
909 strcat_s(szSymPath, nSymPathLen, ";");
910 }
911
912 // Now add the path for the main-module:
913 if (GetModuleFileNameA(NULL, szTemp, nTempLen) > 0)
914 {
915 szTemp[nTempLen-1] = 0;
916 for (char *p = (szTemp+strlen(szTemp)-1); p >= szTemp; --p)
917 {
918 // locate the rightmost path separator
919 if ( (*p == '\\') || (*p == '/') || (*p == ':') )
920 {
921 *p = 0;
922 break;
923 }
924 } // for (search for path separator...)
925 if (strlen(szTemp) > 0)
926 {
927 strcat_s(szSymPath, nSymPathLen, szTemp);
928 strcat_s(szSymPath, nSymPathLen, ";");
929 }
930 }
931 if (GetEnvironmentVariableA("_NT_SYMBOL_PATH", szTemp, nTempLen) > 0)
932 {
933 szTemp[nTempLen-1] = 0;
934 strcat_s(szSymPath, nSymPathLen, szTemp);
935 strcat_s(szSymPath, nSymPathLen, ";");
936 }
937 if (GetEnvironmentVariableA("_NT_ALTERNATE_SYMBOL_PATH", szTemp, nTempLen) > 0)
938 {
939 szTemp[nTempLen-1] = 0;
940 strcat_s(szSymPath, nSymPathLen, szTemp);
941 strcat_s(szSymPath, nSymPathLen, ";");
942 }
943 if (GetEnvironmentVariableA("SYSTEMROOT", szTemp, nTempLen) > 0)
944 {
945 szTemp[nTempLen-1] = 0;
946 strcat_s(szSymPath, nSymPathLen, szTemp);
947 strcat_s(szSymPath, nSymPathLen, ";");
948 // also add the "system32"-directory:
949 strcat_s(szTemp, nTempLen, "\\system32");
950 strcat_s(szSymPath, nSymPathLen, szTemp);
951 strcat_s(szSymPath, nSymPathLen, ";");
952 }
953
954 if ( (this->m_options & SymUseSymSrv) != 0)
955 {
956 if (GetEnvironmentVariableA("SYSTEMDRIVE", szTemp, nTempLen) > 0)
957 {
958 szTemp[nTempLen-1] = 0;
959 strcat_s(szSymPath, nSymPathLen, "SRV*");
960 strcat_s(szSymPath, nSymPathLen, szTemp);
961 strcat_s(szSymPath, nSymPathLen, "\\websymbols");
962 strcat_s(szSymPath, nSymPathLen, "*http://msdl.microsoft.com/download/symbols;");
963 }
964 else
965 strcat_s(szSymPath, nSymPathLen, "SRV*c:\\websymbols*http://msdl.microsoft.com/download/symbols;");
966 }
967 } // if SymBuildPath
968
969 // First Init the whole stuff...
970 BOOL bRet = this->m_sw->Init(szSymPath);
971 if (szSymPath != NULL) free(szSymPath); szSymPath = NULL;
972 if (bRet == FALSE)
973 {
974 this->OnDbgHelpErr("Error while initializing dbghelp.dll", 0, 0);
975 SetLastError(ERROR_DLL_INIT_FAILED);
976 return FALSE;
977 }
978
979 CHAR buffer[STACKWALK_MAX_NAMELEN];
980 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "Loading symbols");
981 OnOutput(buffer);
982
983 bRet = this->m_sw->LoadModules(this->m_hProcess, this->m_dwProcessId);
984 if (bRet != FALSE)
985 m_modulesLoaded = TRUE;
986
987 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "\n\n");
988 OnOutput(buffer);
989
990 return bRet;
991}
992
993
994// The following is used to pass the "userData"-Pointer to the user-provided readMemoryFunction
995// This has to be done due to a problem with the "hProcess"-parameter in x64...
996// Because this class is in no case multi-threading-enabled (because of the limitations
997// of dbghelp.dll) it is "safe" to use a static-variable
998static StackWalker::PReadProcessMemoryRoutine s_readMemoryFunction = NULL;
999static LPVOID s_readMemoryFunction_UserData = NULL;
1000
1001BOOL StackWalker::ShowCallstack(HANDLE hThread, const CONTEXT *context, PReadProcessMemoryRoutine readMemoryFunction, LPVOID pUserData)
1002{
1003 CONTEXT c;
1004 CallstackEntry csEntry;
1005 IMAGEHLP_SYMBOL64 *pSym = NULL;
1006 StackWalkerInternal::IMAGEHLP_MODULE64_V2 Module;
1007 IMAGEHLP_LINE64 Line;
1008 int frameNum;
1009 bool bLastEntryCalled = true;
1010 int curRecursionCount = 0;
1011
1012 if (m_modulesLoaded == FALSE)
1013 this->LoadModules(); // ignore the result...
1014
1015 if (this->m_sw->m_hDbhHelp == NULL)
1016 {
1017 SetLastError(ERROR_DLL_INIT_FAILED);
1018 return FALSE;
1019 }
1020
1021 s_readMemoryFunction = readMemoryFunction;
1022 s_readMemoryFunction_UserData = pUserData;
1023
1024 if (context == NULL)
1025 {
1026 // If no context is provided, capture the context
1027 if (hThread == GetCurrentThread())
1028 {
1029#ifndef _M_X64
1030 GET_CURRENT_CONTEXT(c, USED_CONTEXT_FLAGS);
1031#endif
1032 }
1033 else
1034 {
1035 SuspendThread(hThread);
1036 memset(&c, 0, sizeof(CONTEXT));
1037 c.ContextFlags = USED_CONTEXT_FLAGS;
1038 if (GetThreadContext(hThread, &c) == FALSE)
1039 {
1040 ResumeThread(hThread);
1041 return FALSE;
1042 }
1043 }
1044 }
1045 else
1046 c = *context;
1047
1048 // init STACKFRAME for first call
1049 STACKFRAME64 s; // in/out stackframe
1050 memset(&s, 0, sizeof(s));
1051 DWORD imageType;
1052#ifdef _M_IX86
1053 // normally, call ImageNtHeader() and use machine info from PE header
1054 imageType = IMAGE_FILE_MACHINE_I386;
1055 s.AddrPC.Offset = c.Eip;
1056 s.AddrPC.Mode = AddrModeFlat;
1057 s.AddrFrame.Offset = c.Ebp;
1058 s.AddrFrame.Mode = AddrModeFlat;
1059 s.AddrStack.Offset = c.Esp;
1060 s.AddrStack.Mode = AddrModeFlat;
1061#elif _M_X64
1062 imageType = IMAGE_FILE_MACHINE_AMD64;
1063 s.AddrPC.Offset = c.Rip;
1064 s.AddrPC.Mode = AddrModeFlat;
1065 s.AddrFrame.Offset = c.Rsp;
1066 s.AddrFrame.Mode = AddrModeFlat;
1067 s.AddrStack.Offset = c.Rsp;
1068 s.AddrStack.Mode = AddrModeFlat;
1069#elif _M_IA64
1070 imageType = IMAGE_FILE_MACHINE_IA64;
1071 s.AddrPC.Offset = c.StIIP;
1072 s.AddrPC.Mode = AddrModeFlat;
1073 s.AddrFrame.Offset = c.IntSp;
1074 s.AddrFrame.Mode = AddrModeFlat;
1075 s.AddrBStore.Offset = c.RsBSP;
1076 s.AddrBStore.Mode = AddrModeFlat;
1077 s.AddrStack.Offset = c.IntSp;
1078 s.AddrStack.Mode = AddrModeFlat;
1079#else
1080#error "Platform not supported!"
1081#endif
1082
1083 pSym = (IMAGEHLP_SYMBOL64 *) malloc(sizeof(IMAGEHLP_SYMBOL64) + STACKWALK_MAX_NAMELEN);
1084 if (!pSym) goto cleanup; // not enough memory...
1085 memset(pSym, 0, sizeof(IMAGEHLP_SYMBOL64) + STACKWALK_MAX_NAMELEN);
1086 pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
1087 pSym->MaxNameLength = STACKWALK_MAX_NAMELEN;
1088
1089 memset(&Line, 0, sizeof(Line));
1090 Line.SizeOfStruct = sizeof(Line);
1091
1092 memset(&Module, 0, sizeof(Module));
1093 Module.SizeOfStruct = sizeof(Module);
1094
1095 CHAR buffer[STACKWALK_MAX_NAMELEN];
1096 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "Call stack:\n");
1097 OnOutput(buffer);
1098
1099 for (frameNum = 0; ; ++frameNum )
1100 {
1101 // get next stack frame (StackWalk64(), SymFunctionTableAccess64(), SymGetModuleBase64())
1102 // if this returns ERROR_INVALID_ADDRESS (487) or ERROR_NOACCESS (998), you can
1103 // assume that either you are done, or that the stack is so hosed that the next
1104 // deeper frame could not be found.
1105 // CONTEXT need not to be suplied if imageTyp is IMAGE_FILE_MACHINE_I386!
1106 if ( ! this->m_sw->pSW(imageType, this->m_hProcess, hThread, &s, &c, myReadProcMem, this->m_sw->pSFTA, this->m_sw->pSGMB, NULL) )
1107 {
1108 // INFO: "StackWalk64" does not set "GetLastError"...
1109 this->OnDbgHelpErr("StackWalk64", 0, s.AddrPC.Offset);
1110 break;
1111 }
1112
1113 csEntry.offset = s.AddrPC.Offset;
1114 csEntry.name[0] = 0;
1115 csEntry.undName[0] = 0;
1116 csEntry.undFullName[0] = 0;
1117 csEntry.offsetFromSmybol = 0;
1118 csEntry.offsetFromLine = 0;
1119 csEntry.lineFileName[0] = 0;
1120 csEntry.lineNumber = 0;
1121 csEntry.loadedImageName[0] = 0;
1122 csEntry.moduleName[0] = 0;
1123 if (s.AddrPC.Offset == s.AddrReturn.Offset)
1124 {
1125 if ( (this->m_MaxRecursionCount > 0) && (curRecursionCount > m_MaxRecursionCount) )
1126 {
1127 this->OnDbgHelpErr("StackWalk64-Endless-Callstack!", 0, s.AddrPC.Offset);
1128 break;
1129 }
1130 curRecursionCount++;
1131 }
1132 else
1133 curRecursionCount = 0;
1134 if (s.AddrPC.Offset != 0)
1135 {
1136 // we seem to have a valid PC
1137 // show procedure info (SymGetSymFromAddr64())
1138 if (this->m_sw->pSGSFA(this->m_hProcess, s.AddrPC.Offset, &(csEntry.offsetFromSmybol), pSym) != FALSE)
1139 {
1140 strcpy_s(csEntry.name, pSym->Name);
1141 // UnDecorateSymbolName()
1142 this->m_sw->pUDSN( pSym->Name, csEntry.undName, STACKWALK_MAX_NAMELEN, UNDNAME_NAME_ONLY );
1143 this->m_sw->pUDSN( pSym->Name, csEntry.undFullName, STACKWALK_MAX_NAMELEN, UNDNAME_COMPLETE );
1144 }
1145 else
1146 {
1147 //this->OnDbgHelpErr("SymGetSymFromAddr64", GetLastError(), s.AddrPC.Offset);
1148 }
1149
1150 // show line number info, NT5.0-method (SymGetLineFromAddr64())
1151 if (this->m_sw->pSGLFA != NULL )
1152 { // yes, we have SymGetLineFromAddr64()
1153 if (this->m_sw->pSGLFA(this->m_hProcess, s.AddrPC.Offset, &(csEntry.offsetFromLine), &Line) != FALSE)
1154 {
1155 csEntry.lineNumber = Line.LineNumber;
1156 // TODO: Mache dies sicher...!
1157 strcpy_s(csEntry.lineFileName, Line.FileName);
1158 }
1159 else
1160 {
1161 //this->OnDbgHelpErr("SymGetLineFromAddr64", GetLastError(), s.AddrPC.Offset);
1162 }
1163 } // yes, we have SymGetLineFromAddr64()
1164
1165 // show module info (SymGetModuleInfo64())
1166 if (this->m_sw->GetModuleInfo(this->m_hProcess, s.AddrPC.Offset, &Module ) != FALSE)
1167 { // got module info OK
1168 switch ( Module.SymType )
1169 {
1170 case SymNone:
1171 csEntry.symTypeString = "-nosymbols-";
1172 break;
1173 case SymCoff:
1174 csEntry.symTypeString = "COFF";
1175 break;
1176 case SymCv:
1177 csEntry.symTypeString = "CV";
1178 break;
1179 case SymPdb:
1180 csEntry.symTypeString = "PDB";
1181 break;
1182 case SymExport:
1183 csEntry.symTypeString = "-exported-";
1184 break;
1185 case SymDeferred:
1186 csEntry.symTypeString = "-deferred-";
1187 break;
1188 case SymSym:
1189 csEntry.symTypeString = "SYM";
1190 break;
1191#if API_VERSION_NUMBER >= 9
1192 case SymDia:
1193 csEntry.symTypeString = "DIA";
1194 break;
1195#endif
1196 case 8: //SymVirtual:
1197 csEntry.symTypeString = "Virtual";
1198 break;
1199 default:
1200 //_snprintf( ty, sizeof ty, "symtype=%ld", (long) Module.SymType );
1201 csEntry.symTypeString = NULL;
1202 break;
1203 }
1204
1205 // TODO: Mache dies sicher...!
1206 strcpy_s(csEntry.moduleName, Module.ModuleName);
1207 csEntry.baseOfImage = Module.BaseOfImage;
1208 strcpy_s(csEntry.loadedImageName, Module.LoadedImageName);
1209 } // got module info OK
1210 else
1211 {
1212 this->OnDbgHelpErr("SymGetModuleInfo64", GetLastError(), s.AddrPC.Offset);
1213 }
1214 } // we seem to have a valid PC
1215
1216 CallstackEntryType et = nextEntry;
1217 if (frameNum == 0)
1218 et = firstEntry;
1219 bLastEntryCalled = false;
1220 this->OnCallstackEntry(et, csEntry);
1221
1222 if (s.AddrReturn.Offset == 0)
1223 {
1224 bLastEntryCalled = true;
1225 this->OnCallstackEntry(lastEntry, csEntry);
1226 SetLastError(ERROR_SUCCESS);
1227 break;
1228 }
1229 } // for ( frameNum )
1230
1231 cleanup:
1232 if (pSym) free( pSym );
1233
1234 if (bLastEntryCalled == false)
1235 this->OnCallstackEntry(lastEntry, csEntry);
1236
1237 if (context == NULL)
1238 ResumeThread(hThread);
1239
1240 return TRUE;
1241}
1242
1243BOOL __stdcall StackWalker::myReadProcMem(
1244 HANDLE hProcess,
1245 DWORD64 qwBaseAddress,
1246 PVOID lpBuffer,
1247 DWORD nSize,
1248 LPDWORD lpNumberOfBytesRead
1249 )
1250{
1251 if (s_readMemoryFunction == NULL)
1252 {
1253 SIZE_T st;
1254 BOOL bRet = ReadProcessMemory(hProcess, (LPVOID) qwBaseAddress, lpBuffer, nSize, &st);
1255 *lpNumberOfBytesRead = (DWORD) st;
1256 //printf("ReadMemory: hProcess: %p, baseAddr: %p, buffer: %p, size: %d, read: %d, result: %d\n", hProcess, (LPVOID) qwBaseAddress, lpBuffer, nSize, (DWORD) st, (DWORD) bRet);
1257 return bRet;
1258 }
1259 else
1260 {
1261 return s_readMemoryFunction(hProcess, qwBaseAddress, lpBuffer, nSize, lpNumberOfBytesRead, s_readMemoryFunction_UserData);
1262 }
1263}
1264
1265void StackWalker::OnLoadModule(LPCSTR img, LPCSTR mod, DWORD64 baseAddr, DWORD size, DWORD result, LPCSTR symType, LPCSTR pdbName, ULONGLONG fileVersion)
1266{
1267 CHAR buffer[STACKWALK_MAX_NAMELEN];
1268/* if (fileVersion == 0)
1269 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "%s:%s (%p), size: %d (result: %d), SymType: '%s', PDB: '%s'\n", img, mod, (LPVOID) baseAddr, size, result, symType, pdbName);
1270 else
1271 {
1272 DWORD v4 = (DWORD) fileVersion & 0xFFFF;
1273 DWORD v3 = (DWORD) (fileVersion>>16) & 0xFFFF;
1274 DWORD v2 = (DWORD) (fileVersion>>32) & 0xFFFF;
1275 DWORD v1 = (DWORD) (fileVersion>>48) & 0xFFFF;
1276 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "%s:%s (%p), size: %d (result: %d), SymType: '%s', PDB: '%s', fileVersion: %d.%d.%d.%d\n", img, mod, (LPVOID) baseAddr, size, result, symType, pdbName, v1, v2, v3, v4);
1277 }*/
1278 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, ".");
1279 OnOutput(buffer);
1280}
1281
1282void StackWalker::OnCallstackEntry(CallstackEntryType eType, CallstackEntry &entry)
1283{
1284 CHAR buffer[STACKWALK_MAX_NAMELEN];
1285 if ( (eType != lastEntry) && (entry.offset != 0) )
1286 {
1287 if (entry.name[0] == 0)
1288 strcpy_s(entry.name, "(function-name not available)");
1289 if (entry.undName[0] != 0)
1290 strcpy_s(entry.name, entry.undName);
1291 if (entry.undFullName[0] != 0)
1292 strcpy_s(entry.name, entry.undFullName);
1293 if (entry.lineFileName[0] == 0)
1294 {
1295 strcpy_s(entry.lineFileName, "(filename not available)");
1296 if (entry.moduleName[0] == 0)
1297 strcpy_s(entry.moduleName, "(module-name not available)");
1298 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "%p (%s): %s: %s\n", (LPVOID) entry.offset, entry.moduleName, entry.lineFileName, entry.name);
1299 }
1300 else
1301 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "%s (%d): %s\n", entry.lineFileName, entry.lineNumber, entry.name);
1302 OnOutput(buffer);
1303 }
1304}
1305
1306void StackWalker::OnDbgHelpErr(LPCSTR szFuncName, DWORD gle, DWORD64 addr)
1307{
1308 CHAR buffer[STACKWALK_MAX_NAMELEN];
1309 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "ERROR: %s, GetLastError: %d (Address: %p)\n\n", szFuncName, gle, (LPVOID) addr);
1310 OnOutput(buffer);
1311}
1312
1313void StackWalker::OnSymInit(LPCSTR szSearchPath, DWORD symOptions, LPCSTR szUserName)
1314{
1315 CHAR buffer[STACKWALK_MAX_NAMELEN];
1316 //_snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "SymInit: Symbol SearchPath: '%s', symOptions: %d, UserName: '%s'\n\n", szSearchPath, symOptions, szUserName);
1317 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "SymInit: Symbol SearchPath: '%s', symOptions: %d, \n\n", szSearchPath, symOptions);
1318 OnOutput(buffer);
1319 // Also display the OS-version
1320#if _MSC_VER <= 1200
1321 OSVERSIONINFOA ver;
1322 ZeroMemory(&ver, sizeof(OSVERSIONINFOA));
1323 ver.dwOSVersionInfoSize = sizeof(ver);
1324 if (GetVersionExA(&ver) != FALSE)
1325 {
1326 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "OS Version: %d.%d.%d (%s)\n\n",
1327 ver.dwMajorVersion, ver.dwMinorVersion, ver.dwBuildNumber,
1328 ver.szCSDVersion);
1329 OnOutput(buffer);
1330 }
1331#else
1332 OSVERSIONINFOEXA ver;
1333 ZeroMemory(&ver, sizeof(OSVERSIONINFOEXA));
1334 ver.dwOSVersionInfoSize = sizeof(ver);
1335 if (GetVersionExA( (OSVERSIONINFOA*) &ver) != FALSE)
1336 {
1337 /*_snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "OS-Version: %d.%d.%d (%s) 0x%x-0x%x\n\n",
1338 ver.dwMajorVersion, ver.dwMinorVersion, ver.dwBuildNumber,
1339 ver.szCSDVersion, ver.wSuiteMask, ver.wProductType);*/
1340 _snprintf_s(buffer, STACKWALK_MAX_NAMELEN, "OS Version: %d.%d.%d (%s)\n\n",
1341 ver.dwMajorVersion, ver.dwMinorVersion, ver.dwBuildNumber,
1342 ver.szCSDVersion);
1343 OnOutput(buffer);
1344 }
1345#endif
1346}
1347
1348void StackWalker::OnOutput(LPCSTR buffer)
1349{
1350 OutputDebugStringA(buffer);
1351}
1352#endif
1353#endif
StackWalker::StackWalker
StackWalker(int options=RetrieveNone, LPCSTR szSymPath=NULL, DWORD dwProcessId=GetCurrentProcessId(), HANDLE hProcess=GetCurrentProcess())
StackWalker::m_sw
StackWalkerInternal * m_sw
Definition stackwalker.h:151
StackWalker::STACKWALK_MAX_NAMELEN
@ STACKWALK_MAX_NAMELEN
Definition stackwalker.h:122
StackWalker::~StackWalker
virtual ~StackWalker()
StackWalker::m_modulesLoaded
BOOL m_modulesLoaded
Definition stackwalker.h:154
StackWalker::ShowCallstack
BOOL ShowCallstack(HANDLE hThread=GetCurrentThread(), const CONTEXT *context=NULL, PReadProcessMemoryRoutine readMemoryFunction=NULL, LPVOID pUserData=NULL)
StackWalker::LoadModules
BOOL LoadModules()
StackWalker::OnCallstackEntry
virtual void OnCallstackEntry(CallstackEntryType eType, CallstackEntry &entry)
StackWalker::CallstackEntry
struct StackWalker::CallstackEntry CallstackEntry
StackWalker::myReadProcMem
static BOOL __stdcall myReadProcMem(HANDLE hProcess, DWORD64 qwBaseAddress, PVOID lpBuffer, DWORD nSize, LPDWORD lpNumberOfBytesRead)
StackWalker::OnOutput
virtual void OnOutput(LPCSTR szText)
StackWalker::RetrieveFileVersion
@ RetrieveFileVersion
Definition stackwalker.h:71
StackWalker::StackWalkerInternal
friend StackWalkerInternal
Definition stackwalker.h:162
StackWalker::PReadProcessMemoryRoutine
BOOL(__stdcall * PReadProcessMemoryRoutine)(HANDLE hProcess, DWORD64 qwBaseAddress, PVOID lpBuffer, DWORD nSize, LPDWORD lpNumberOfBytesRead, LPVOID pUserData)
Definition stackwalker.h:99
StackWalker::OnDbgHelpErr
virtual void OnDbgHelpErr(LPCSTR szFuncName, DWORD gle, DWORD64 addr)
StackWalker::m_MaxRecursionCount
int m_MaxRecursionCount
Definition stackwalker.h:158
StackWalker::m_dwProcessId
DWORD m_dwProcessId
Definition stackwalker.h:153
StackWalker::OnSymInit
virtual void OnSymInit(LPCSTR szSearchPath, DWORD symOptions, LPCSTR szUserName)
StackWalker::OnLoadModule
virtual void OnLoadModule(LPCSTR img, LPCSTR mod, DWORD64 baseAddr, DWORD size, DWORD result, LPCSTR symType, LPCSTR pdbName, ULONGLONG fileVersion)
StackWalker::m_szSymPath
LPSTR m_szSymPath
Definition stackwalker.h:155
GET_CURRENT_CONTEXT
#define GET_CURRENT_CONTEXT(c, contextFlags)
Definition stackwalker.h:209
DWORD64
unsigned __int64 DWORD64
Definition stackwalker.h:43
SIZE_T
unsigned long SIZE_T
Definition stackwalker.h:47
PDWORD64
unsigned __int64 * PDWORD64
Definition stackwalker.h:43
Generated by doxygen 1.11.0