-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathstacktrace_win32.cpp
More file actions
556 lines (483 loc) · 15.7 KB
/
Copy pathstacktrace_win32.cpp
File metadata and controls
556 lines (483 loc) · 15.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
/**
*
* This code is modified from the original StackWalker code available at
* http://www.codeproject.com/threads/StackWalker.asp. That code does not
* seem to be distributed under any kind of license.
*/
#include "stacktrace.h"
#include <windows.h>
#include <dbghelp.h>
#include <stdlib.h>
#include <psapi.h>
#define STACKWALK_MAX_NAMELEN 1024
#define USED_CONTEXT_FLAGS CONTEXT_FULL
typedef struct CallstackEntry
{
DWORD64 offset; // if 0, we have no valid entry
CHAR name[STACKWALK_MAX_NAMELEN];
CHAR undName[STACKWALK_MAX_NAMELEN];
CHAR undFullName[STACKWALK_MAX_NAMELEN];
DWORD64 offsetFromSmybol;
DWORD offsetFromLine;
DWORD lineNumber;
CHAR lineFileName[STACKWALK_MAX_NAMELEN];
DWORD symType;
LPCSTR symTypeString;
CHAR moduleName[STACKWALK_MAX_NAMELEN];
DWORD64 baseOfImage;
CHAR loadedImageName[STACKWALK_MAX_NAMELEN];
} CallstackEntry;
#if defined(_M_IX86)
#ifdef CURRENT_THREAD_VIA_EXCEPTION
// TODO: The following is not a "good" implementation,
// because the callstack is only valid in the "__except" block...
#define GET_CURRENT_CONTEXT(c, contextFlags) \
do { \
memset(&c, 0, sizeof(CONTEXT)); \
EXCEPTION_POINTERS *pExp = NULL; \
__try { \
throw 0; \
} __except( ( (pExp = GetExceptionInformation()) ? EXCEPTION_EXECUTE_HANDLER : EXCEPTION_EXECUTE_HANDLER)) {} \
if (pExp != NULL) \
memcpy(&c, pExp->ContextRecord, sizeof(CONTEXT)); \
c.ContextFlags = contextFlags; \
} while(0);
#else
// The following should be enough for walking the callstack...
#define GET_CURRENT_CONTEXT(c, contextFlags) \
do { \
memset(&c, 0, sizeof(CONTEXT)); \
c.ContextFlags = contextFlags; \
__asm call x \
__asm x: pop eax \
__asm mov c.Eip, eax \
__asm mov c.Ebp, ebp \
__asm mov c.Esp, esp \
} while(0);
#endif
#else
// The following is defined for x86 (XP and higher), x64 and IA64:
#define GET_CURRENT_CONTEXT(c, contextFlags) \
do { \
memset(&c, 0, sizeof(CONTEXT)); \
c.ContextFlags = contextFlags; \
RtlCaptureContext(&c); \
} while(0);
#endif
// ---------------------------------------------------------------------------
typedef enum CallstackEntryType { firstEntry, nextEntry, lastEntry };
// ---------------------------------------------------------------------------
static void __safe_strcpy(char *dst, const char *src, size_t maxlen)
{
strncpy(dst, src, maxlen - 1);
dst[maxlen - 1] = 0;
}
// ---------------------------------------------------------------------------
static BOOL stacktrace_get_module_info(HANDLE hProcess, DWORD64 baseAddr,
IMAGEHLP_MODULE64 *pModuleInfo)
{
void *pData = malloc(4096); // reserve enough memory, so the bug in
// v6.3.5.1 does not lead to
// memory-overwrites...
pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64);
if(pData == NULL)
{
SetLastError(ERROR_NOT_ENOUGH_MEMORY);
return FALSE;
}
memcpy(pData, pModuleInfo, sizeof(IMAGEHLP_MODULE64));
if(SymGetModuleInfo64(hProcess, baseAddr, (IMAGEHLP_MODULE64 *)pData)
!= FALSE)
{
// only copy as much memory as is reserved...
memcpy(pModuleInfo, pData, sizeof(IMAGEHLP_MODULE64));
pModuleInfo->SizeOfStruct = sizeof(IMAGEHLP_MODULE64);
free(pData);
return TRUE;
}
free(pData);
SetLastError(ERROR_DLL_INIT_FAILED);
return FALSE;
}
// ---------------------------------------------------------------------------
static DWORD __stacktrace_load_module(HANDLE hProcess, LPCSTR img, LPCSTR mod,
DWORD64 baseAddr, DWORD size)
{
CHAR *szImg = _strdup(img);
CHAR *szMod = _strdup(mod);
DWORD result = ERROR_SUCCESS;
ULONGLONG fileVersion = 0;
IMAGEHLP_MODULE64 Module;
const char *szSymType = "-unknown-";
if((szImg == NULL) || (szMod == NULL))
result = ERROR_NOT_ENOUGH_MEMORY;
else
{
if(SymLoadModule64(hProcess, 0, szImg, szMod, baseAddr, size) == 0)
result = GetLastError();
}
if(szImg != NULL)
{
// Retrive some additional-infos about the module
if(stacktrace_get_module_info(hProcess, baseAddr, &Module) != FALSE)
{
switch(Module.SymType)
{
case SymNone:
szSymType = "-nosymbols-";
break;
case SymCoff:
szSymType = "COFF";
break;
case SymCv:
szSymType = "CV";
break;
case SymPdb:
szSymType = "PDB";
break;
case SymExport:
szSymType = "-exported-";
break;
case SymDeferred:
szSymType = "-deferred-";
break;
case SymSym:
szSymType = "SYM";
break;
case 8: //SymVirtual:
szSymType = "Virtual";
break;
case 9: // SymDia:
szSymType = "DIA";
break;
}
}
}
if(szImg != NULL)
free(szImg);
if(szMod != NULL)
free(szMod);
return result;
}
// ---------------------------------------------------------------------------
static BOOL __stacktrace_load_modules(HANDLE hProcess)
{
DWORD i;
DWORD cbNeeded;
MODULEINFO mi;
HMODULE *hMods = 0;
char *tt = NULL;
char *tt2 = NULL;
const DWORD TTBUFLEN = 8096;
int cnt = 0;
DWORD dwRes;
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(! EnumProcessModules(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
GetModuleInformation(hProcess, hMods[i], &mi, sizeof(mi));
// image file name
tt[0] = 0;
GetModuleFileNameExA(hProcess, hMods[i], tt, TTBUFLEN);
// module name
tt2[0] = 0;
GetModuleBaseNameA(hProcess, hMods[i], tt2, TTBUFLEN);
dwRes = __stacktrace_load_module(hProcess, tt, tt2,
(DWORD64)mi.lpBaseOfDll,
mi.SizeOfImage);
if (dwRes != ERROR_SUCCESS)
{
// this->m_parent->OnDbgHelpErr("LoadModule", dwRes, 0);
}
cnt++;
}
cleanup:
if(tt2 != NULL)
free(tt2);
if(tt != NULL)
free(tt);
if(hMods != NULL)
free(hMods);
return(cnt != 0);
}
// ---------------------------------------------------------------------------
static BOOL __stdcall __stacktrace_read_proc_mem(HANDLE hProcess,
DWORD64 qwBaseAddress,
PVOID lpBuffer, DWORD nSize,
LPDWORD lpNumberOfBytesRead)
{
DWORD st;
BOOL bRet = ReadProcessMemory(hProcess, (LPVOID)qwBaseAddress, lpBuffer,
nSize, &st);
*lpNumberOfBytesRead = st;
return(bRet);
}
// ---------------------------------------------------------------------------
static void __stacktrace_dump_callstack_entry(enum CallstackEntryType eType,
CallstackEntry *entry,
FILE *stream)
{
if((eType != lastEntry) && (entry->offset != 0))
{
if(entry->name[0] == 0)
__safe_strcpy(entry->name, "???", STACKWALK_MAX_NAMELEN);
if(entry->undName[0] != 0)
__safe_strcpy(entry->name, entry->undName, STACKWALK_MAX_NAMELEN);
if(entry->undFullName[0] != 0)
__safe_strcpy(entry->name, entry->undFullName, STACKWALK_MAX_NAMELEN);
if(entry->lineFileName[0] == 0)
{
__safe_strcpy(entry->lineFileName, "???", STACKWALK_MAX_NAMELEN);
if(entry->moduleName[0] == 0)
__safe_strcpy(entry->moduleName, "(module-name not available)",
STACKWALK_MAX_NAMELEN);
// fprintf(stream, "%p (%s): %s: %s()\n",
// (LPVOID)entry->offset, entry->moduleName, entry->lineFileName,
// entry->name);
fprintf(stream, "%s: %s()\n", entry->lineFileName, entry->name);
}
else
{
char *file = entry->lineFileName;
char *p = strrchr(file, '\\');
if(p)
file = ++p;
fprintf(stream, "%s(%d): %s()\n", file, entry->lineNumber, entry->name);
}
}
}
// ---------------------------------------------------------------------------
static BOOL __stacktrace_walk_stack(FILE *stream, unsigned int max_frames,
int flags)
{
CONTEXT c;
CallstackEntry csEntry;
IMAGEHLP_SYMBOL64 *pSym = NULL;
IMAGEHLP_MODULE64 Module;
IMAGEHLP_LINE64 Line;
unsigned int frameNum;
HANDLE hThread = GetCurrentThread();
HANDLE hProcess;
DWORD imageType;
enum CallstackEntryType et;
STACKFRAME64 s; // in/out stackframe
memset(&s, 0, sizeof(s));
GET_CURRENT_CONTEXT(c, USED_CONTEXT_FLAGS);
// init STACKFRAME for first call
#ifdef _M_IX86
// normally, call ImageNtHeader() and use machine info from PE header
imageType = IMAGE_FILE_MACHINE_I386;
s.AddrPC.Offset = c.Eip;
s.AddrPC.Mode = AddrModeFlat;
s.AddrFrame.Offset = c.Ebp;
s.AddrFrame.Mode = AddrModeFlat;
s.AddrStack.Offset = c.Esp;
s.AddrStack.Mode = AddrModeFlat;
#elif _M_X64
imageType = IMAGE_FILE_MACHINE_AMD64;
s.AddrPC.Offset = c.Rip;
s.AddrPC.Mode = AddrModeFlat;
s.AddrFrame.Offset = c.Rsp;
s.AddrFrame.Mode = AddrModeFlat;
s.AddrStack.Offset = c.Rsp;
s.AddrStack.Mode = AddrModeFlat;
#elif _M_IA64
imageType = IMAGE_FILE_MACHINE_IA64;
s.AddrPC.Offset = c.StIIP;
s.AddrPC.Mode = AddrModeFlat;
s.AddrFrame.Offset = c.IntSp;
s.AddrFrame.Mode = AddrModeFlat;
s.AddrBStore.Offset = c.RsBSP;
s.AddrBStore.Mode = AddrModeFlat;
s.AddrStack.Offset = c.IntSp;
s.AddrStack.Mode = AddrModeFlat;
#else
#error "Platform not supported!"
#endif
pSym = (IMAGEHLP_SYMBOL64 *)malloc(sizeof(IMAGEHLP_SYMBOL64)
+ STACKWALK_MAX_NAMELEN);
if (!pSym)
goto cleanup; // not enough memory...
memset(pSym, 0, sizeof(IMAGEHLP_SYMBOL64) + STACKWALK_MAX_NAMELEN);
pSym->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
pSym->MaxNameLength = STACKWALK_MAX_NAMELEN;
memset(&Line, 0, sizeof(Line));
Line.SizeOfStruct = sizeof(Line);
memset(&Module, 0, sizeof(Module));
Module.SizeOfStruct = sizeof(Module);
hProcess = GetCurrentProcess();
for(frameNum = 0; frameNum < max_frames; ++frameNum)
{
fprintf(stream, "% 3d: ", frameNum + 1);
// get next stack frame (StackWalk64(),
// SymFunctionTableAccess64(), SymGetModuleBase64()) if this
// returns ERROR_INVALID_ADDRESS (487) or ERROR_NOACCESS (998),
// you can assume that either you are done, or that the stack is
// so hosed that the next deeper frame could not be found.
// CONTEXT need not to be suplied if imageTyp is
// IMAGE_FILE_MACHINE_I386!
if(! StackWalk64(imageType, hProcess, hThread, &s, &c,
__stacktrace_read_proc_mem, SymFunctionTableAccess64,
SymGetModuleBase64, NULL))
{
// this->OnDbgHelpErr("StackWalk64", GetLastError(), s.AddrPC.Offset);
break;
}
csEntry.offset = s.AddrPC.Offset;
csEntry.name[0] = 0;
csEntry.undName[0] = 0;
csEntry.undFullName[0] = 0;
csEntry.offsetFromSmybol = 0;
csEntry.offsetFromLine = 0;
csEntry.lineFileName[0] = 0;
csEntry.lineNumber = 0;
csEntry.loadedImageName[0] = 0;
csEntry.moduleName[0] = 0;
if(s.AddrPC.Offset == s.AddrReturn.Offset)
{
// this->OnDbgHelpErr("StackWalk64-Endless-Callstack!", 0, s.AddrPC.Offset);
break;
}
if(s.AddrPC.Offset != 0)
{
// we seem to have a valid PC
// show procedure info (SymGetSymFromAddr64())
if(SymGetSymFromAddr64(hProcess, s.AddrPC.Offset,
&(csEntry.offsetFromSmybol), pSym) != FALSE)
{
__safe_strcpy(csEntry.name, pSym->Name, STACKWALK_MAX_NAMELEN);
UnDecorateSymbolName(pSym->Name, csEntry.undName,
STACKWALK_MAX_NAMELEN, UNDNAME_NAME_ONLY);
UnDecorateSymbolName(pSym->Name, csEntry.undFullName,
STACKWALK_MAX_NAMELEN, UNDNAME_COMPLETE);
}
else
{
// this->OnDbgHelpErr("SymGetSymFromAddr64", GetLastError(),
// s.AddrPC.Offset);
}
// show line number info, NT5.0-method (SymGetLineFromAddr64())
if(SymGetLineFromAddr64(hProcess, s.AddrPC.Offset,
&(csEntry.offsetFromLine), &Line) != FALSE)
{
csEntry.lineNumber = Line.LineNumber;
__safe_strcpy(csEntry.lineFileName, Line.FileName,
STACKWALK_MAX_NAMELEN);
}
else
{
// this->OnDbgHelpErr("SymGetLineFromAddr64", GetLastError(), s.AddrPC.Offset);
}
// show module info (SymGetModuleInfo64())
if(stacktrace_get_module_info(hProcess, s.AddrPC.Offset, &Module)
!= FALSE)
{ // got module info OK
switch(Module.SymType)
{
case SymNone:
csEntry.symTypeString = "-nosymbols-";
break;
case SymCoff:
csEntry.symTypeString = "COFF";
break;
case SymCv:
csEntry.symTypeString = "CV";
break;
case SymPdb:
csEntry.symTypeString = "PDB";
break;
case SymExport:
csEntry.symTypeString = "-exported-";
break;
case SymDeferred:
csEntry.symTypeString = "-deferred-";
break;
case SymSym:
csEntry.symTypeString = "SYM";
break;
#if API_VERSION_NUMBER >= 9
case SymDia:
csEntry.symTypeString = "DIA";
break;
#endif
case 8: //SymVirtual:
csEntry.symTypeString = "Virtual";
break;
default:
//_snprintf( ty, sizeof ty, "symtype=%ld", (long) Module.SymType );
csEntry.symTypeString = NULL;
break;
}
__safe_strcpy(csEntry.moduleName, Module.ModuleName,
STACKWALK_MAX_NAMELEN);
csEntry.baseOfImage = Module.BaseOfImage;
__safe_strcpy(csEntry.loadedImageName, Module.LoadedImageName,
STACKWALK_MAX_NAMELEN);
} // got module info OK
else
{
// this->OnDbgHelpErr("SymGetModuleInfo64", GetLastError(),
// s.AddrPC.Offset);
}
} // we seem to have a valid PC
et = nextEntry;
if(frameNum == 0)
et = firstEntry;
__stacktrace_dump_callstack_entry(et, &csEntry, stream);
if(s.AddrReturn.Offset == 0)
{
__stacktrace_dump_callstack_entry(lastEntry, &csEntry, stream);
SetLastError(ERROR_SUCCESS);
break;
}
} // for(frameNum)
cleanup:
if(pSym)
free(pSym);
return TRUE;
}
/*
*/
void stacktrace_init(void)
{
DWORD opts;
HANDLE hProcess = GetCurrentProcess();
if(SymInitialize(hProcess, NULL, FALSE) == FALSE)
{
fprintf(stderr, "SymInitialize() failed!\n");
return;
}
opts = SymGetOptions();
opts |= SYMOPT_LOAD_LINES;
opts |= SYMOPT_FAIL_CRITICAL_ERRORS;
SymSetOptions(opts);
__stacktrace_load_modules(hProcess);
}
/*
*/
void stacktrace_print(FILE *stream, unsigned int max_frames, int flags)
{
if(! __stacktrace_walk_stack(stream, max_frames, flags))
fprintf(stream, "(Stack tracing not implemented on this platform.)\n");
}
/*
*/
void stacktrace_cleanup(void)
{
HANDLE hProcess = GetCurrentProcess();
SymCleanup(hProcess);
}