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
|
/*****************************************************************************
* *
* PrimeSense PSCommon Library *
* Copyright (C) 2012 PrimeSense Ltd. *
* *
* This file is part of PSCommon. *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
* You may obtain a copy of the License at *
* *
* http://www.apache.org/licenses/LICENSE-2.0 *
* *
* Unless required by applicable law or agreed to in writing, software *
* distributed under the License is distributed on an "AS IS" BASIS, *
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
* See the License for the specific language governing permissions and *
* limitations under the License. *
* *
*****************************************************************************/
#include "XnLib.h"
#include <dbghelp.h>
//---------------------------------------------------------------------------
// Types
//---------------------------------------------------------------------------
typedef BOOL (__stdcall *StackWalk64Prot)(
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
);
typedef BOOL (__stdcall *SymInitializeProt)(HANDLE hProcess, PSTR UserSearchPath, BOOL fInvadeProcess);
typedef DWORD (__stdcall *SymSetOptionsProt)(DWORD SymOptions);
typedef BOOL (__stdcall *SymFromAddrProt)(HANDLE hProcess, DWORD64 Address, PDWORD64 Displacement, PSYMBOL_INFO Symbol);
typedef PVOID (__stdcall *SymFunctionTableAccess64Prot)(HANDLE hProcess, DWORD64 AddrBase);
typedef DWORD64 (__stdcall *SymGetModuleBase64Prot)(HANDLE hProcess, DWORD64 qwAddr);
typedef BOOL (__stdcall *SymGetLineFromAddr64Prot)(HANDLE hProcess, DWORD64 qwAddr, PDWORD pdwDisplacement, PIMAGEHLP_LINE64 Line64);
//---------------------------------------------------------------------------
// Global Variables
//---------------------------------------------------------------------------
static XnBool g_bInitialized = FALSE;
StackWalk64Prot g_pStackWalk64 = NULL;
SymFromAddrProt g_pSymFromAddr = NULL;
SymFunctionTableAccess64Prot g_pSymFunctionTableAccess64 = NULL;
SymGetModuleBase64Prot g_pSymGetModuleBase64 = NULL;
SymGetLineFromAddr64Prot g_pSymGetLineFromAddr64 = NULL;
static XnBool g_bAvailable = FALSE;
//---------------------------------------------------------------------------
// Code
//---------------------------------------------------------------------------
static void Init()
{
// NOTE: we load dbghelp dynamically, so that it won't crash if a system doesn't have it
HMODULE hDbg = LoadLibrary("dbghelp.dll");
if (hDbg == NULL)
{
return;
}
SymInitializeProt pSymInitialize = (SymInitializeProt)GetProcAddress(hDbg, "SymInitialize");
SymSetOptionsProt pSymSetOptions = (SymSetOptionsProt)GetProcAddress(hDbg, "SymSetOptions");
if (FALSE == pSymInitialize(GetCurrentProcess(), NULL, TRUE))
{
return;
}
pSymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_UNDNAME);
g_pStackWalk64 = (StackWalk64Prot)GetProcAddress(hDbg, "StackWalk64");
g_pSymFromAddr = (SymFromAddrProt)GetProcAddress(hDbg, "SymFromAddr");
g_pSymFunctionTableAccess64 = (SymFunctionTableAccess64Prot)GetProcAddress(hDbg, "SymFunctionTableAccess64");
g_pSymGetModuleBase64 = (SymGetModuleBase64Prot)GetProcAddress(hDbg, "SymGetModuleBase64");
g_pSymGetLineFromAddr64 = (SymGetLineFromAddr64Prot)GetProcAddress(hDbg, "SymGetLineFromAddr64");
g_bAvailable =
(g_pStackWalk64 != NULL) &&
(g_pSymFromAddr != NULL) &&
(g_pSymFunctionTableAccess64 != NULL) &&
(g_pSymGetModuleBase64 != NULL);
}
XN_C_API XnStatus xnOSGetCurrentCallStack(XnInt32 nFramesToSkip, XnChar** astrFrames, XnUInt32 nMaxNameLength, XnInt32* pnFrames)
{
if (*pnFrames == 0 || nMaxNameLength == 0)
{
return XN_STATUS_OK;
}
// Init
if (!g_bInitialized)
{
Init();
g_bInitialized = TRUE;
}
if (!g_bAvailable)
{
xnOSStrNCopy(astrFrames[0], "dbghelp.dll unavailable!", nMaxNameLength-1, nMaxNameLength);
return XN_STATUS_ERROR;
}
// Get context
CONTEXT context;
RtlCaptureContext(&context);
// init STACKFRAME for first call - Fill data according to processor (see WalkTrace64 and STACKFRAME64 documentation)
STACKFRAME64 stackFrame;
memset(&stackFrame, 0, sizeof(stackFrame));
DWORD MachineType;
#ifdef _M_IX86
MachineType = IMAGE_FILE_MACHINE_I386;
stackFrame.AddrPC.Offset = context.Eip;
stackFrame.AddrPC.Mode = AddrModeFlat;
stackFrame.AddrFrame.Offset = context.Ebp;
stackFrame.AddrFrame.Mode = AddrModeFlat;
stackFrame.AddrStack.Offset = context.Esp;
stackFrame.AddrStack.Mode = AddrModeFlat;
#elif _M_X64
MachineType = IMAGE_FILE_MACHINE_AMD64;
stackFrame.AddrPC.Offset = context.Rip;
stackFrame.AddrPC.Mode = AddrModeFlat;
stackFrame.AddrFrame.Offset = context.Rsp;
stackFrame.AddrFrame.Mode = AddrModeFlat;
stackFrame.AddrStack.Offset = context.Rsp;
stackFrame.AddrStack.Mode = AddrModeFlat;
#elif _M_IA64
MachineType = IMAGE_FILE_MACHINE_IA64;
stackFrame.AddrPC.Offset = context.StIIP;
stackFrame.AddrPC.Mode = AddrModeFlat;
stackFrame.AddrFrame.Offset = context.IntSp;
stackFrame.AddrFrame.Mode = AddrModeFlat;
stackFrame.AddrBStore.Offset = context.RsBSP;
stackFrame.AddrBStore.Mode = AddrModeFlat;
stackFrame.AddrStack.Offset = context.IntSp;
stackFrame.AddrStack.Mode = AddrModeFlat;
#else
#error "Platform not supported!"
#endif
XnInt32 nFrames = 0;
XnInt32 iFrame = 0;
const XnUInt32 BUFFER_SIZE = 1024;
XnChar symbolBuffer[BUFFER_SIZE];
SYMBOL_INFO* pSymbolInfo = (SYMBOL_INFO*)symbolBuffer;
pSymbolInfo->SizeOfStruct = sizeof(SYMBOL_INFO);
pSymbolInfo->MaxNameLen = BUFFER_SIZE - sizeof(SYMBOL_INFO) - 1;
HANDLE currentProcess = GetCurrentProcess();
HANDLE currentThread = GetCurrentThread();
while (iFrame < *pnFrames)
{
// walk the stack
if (!g_pStackWalk64(MachineType, currentProcess, currentThread, &stackFrame, &context, NULL, g_pSymFunctionTableAccess64, g_pSymGetModuleBase64, NULL))
{
// probably reached end
break;
}
if (nFrames >= nFramesToSkip)
{
// resolve function name
BOOL found = g_pSymFromAddr(currentProcess, stackFrame.AddrPC.Offset, NULL, pSymbolInfo);
UINT32 lineNum = 0;
XnChar* strFileName = NULL;
if (g_pSymGetLineFromAddr64 != NULL)
{
IMAGEHLP_LINE64 line;
DWORD displacement;
if (g_pSymGetLineFromAddr64(currentProcess, stackFrame.AddrPC.Offset, &displacement, &line))
{
lineNum = line.LineNumber;
strFileName = line.FileName;
}
}
XnUInt32 nWritten;
if (found)
{
if (lineNum != 0)
{
xnOSStrFormat(astrFrames[iFrame], nMaxNameLength, &nWritten, "%s() Line %lu", pSymbolInfo->Name, lineNum);
}
else
{
xnOSStrFormat(astrFrames[iFrame], nMaxNameLength, &nWritten, "%s()", pSymbolInfo->Name);
}
}
else
{
if ((strFileName != NULL) && (lineNum != 0))
{
xnOSStrFormat(astrFrames[iFrame], nMaxNameLength, &nWritten, "%s Line %lu", strFileName, lineNum);
}
else if (strFileName != NULL)
{
xnOSStrFormat(astrFrames[iFrame], nMaxNameLength, &nWritten, "0x%x %s", stackFrame.AddrPC.Offset, strFileName);
}
else
{
xnOSStrFormat(astrFrames[iFrame], nMaxNameLength, &nWritten, "0x%x", stackFrame.AddrPC.Offset);
}
}
++iFrame;
}
++nFrames;
}
*pnFrames = iFrame;
return XN_STATUS_OK;
}
XN_C_API XnStatus xnOSPrintCurrentCallstack()
{
typedef XnChar XnFrame[80];
XnFrame aFrames[20];
XnChar* pstrFrames[20];
for (int i = 0; i < 20; ++i)
pstrFrames[i] = aFrames[i];
int nFrames = 20;
xnOSGetCurrentCallStack(0, pstrFrames, 80, &nFrames);
for (int i = 0; i < nFrames; ++i)
printf("%s\n", pstrFrames[i]);
return XN_STATUS_OK;
}
|
