2 Copyright (c) 2004 Andrei Polushin
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 /* X86_64 is ccurrently missing some meachine-dependent code below. */
26 #include "private/msvc_dbg.h"
28 #define WIN32_LEAN_AND_MEAN
35 #pragma comment(lib, "dbghelp.lib")
36 #pragma optimize("gy", off)
39 typedef ULONG_PTR ULONG_ADDR;
41 typedef ULONG ULONG_ADDR;
44 static HANDLE GetSymHandle()
46 static HANDLE symHandle = NULL;
48 BOOL bRet = SymInitialize(symHandle = GetCurrentProcess(), NULL, FALSE);
50 DWORD dwOptions = SymGetOptions();
51 dwOptions &= ~SYMOPT_UNDNAME;
52 dwOptions |= SYMOPT_LOAD_LINES;
53 SymSetOptions(dwOptions);
59 static void* CALLBACK FunctionTableAccess(HANDLE hProcess, ULONG_ADDR dwAddrBase)
61 return SymFunctionTableAccess(hProcess, dwAddrBase);
64 static ULONG_ADDR CALLBACK GetModuleBase(HANDLE hProcess, ULONG_ADDR dwAddress)
66 MEMORY_BASIC_INFORMATION memoryInfo;
67 ULONG_ADDR dwAddrBase = SymGetModuleBase(hProcess, dwAddress);
71 if (VirtualQueryEx(hProcess, (void*)(ULONG_PTR)dwAddress, &memoryInfo, sizeof(memoryInfo))) {
72 char filePath[_MAX_PATH];
73 char curDir[_MAX_PATH];
74 char exePath[_MAX_PATH];
75 DWORD size = GetModuleFileNameA((HINSTANCE)memoryInfo.AllocationBase, filePath, sizeof(filePath));
77 // Save and restore current directory around SymLoadModule, see KB article Q189780
78 GetCurrentDirectoryA(sizeof(curDir), curDir);
79 GetModuleFileNameA(NULL, exePath, sizeof(exePath));
80 #if defined(_MSC_VER) && _MSC_VER == 1200
81 /* use strcat for VC6 */
82 strcat(exePath, "\\..");
84 strcat_s(exePath, sizeof(exePath), "\\..");
85 #endif /* _MSC_VER >= 1200 */
86 SetCurrentDirectoryA(exePath);
88 GetCurrentDirectoryA(sizeof(exePath), exePath);
90 SymLoadModule(hProcess, NULL, size ? filePath : NULL, NULL, (ULONG_ADDR)(ULONG_PTR)memoryInfo.AllocationBase, 0);
91 SetCurrentDirectoryA(curDir);
93 return (ULONG_ADDR)(ULONG_PTR)memoryInfo.AllocationBase;
96 static ULONG_ADDR CheckAddress(void* address)
98 ULONG_ADDR dwAddress = (ULONG_ADDR)(ULONG_PTR)address;
99 GetModuleBase(GetSymHandle(), dwAddress);
103 size_t GetStackFrames(size_t skip, void* frames[], size_t maxFrames)
105 HANDLE hProcess = GetSymHandle();
106 HANDLE hThread = GetCurrentThread();
108 context.ContextFlags = CONTEXT_FULL;
109 if (!GetThreadContext(hThread, &context)) {
112 // GetThreadContext might return invalid context for the current thread
114 __asm mov context.Ebp, ebp
116 return GetStackFramesFromContext(hProcess, hThread, &context, skip + 1, frames, maxFrames);
119 size_t GetStackFramesFromContext(HANDLE hProcess, HANDLE hThread, CONTEXT* context, size_t skip, void* frames[], size_t maxFrames)
123 STACKFRAME stackFrame = { 0 };
124 stackFrame.AddrPC.Mode = AddrModeFlat;
126 machineType = IMAGE_FILE_MACHINE_I386;
127 stackFrame.AddrPC.Offset = context->Eip;
128 stackFrame.AddrStack.Mode = AddrModeFlat;
129 stackFrame.AddrStack.Offset = context->Esp;
130 stackFrame.AddrFrame.Mode = AddrModeFlat;
131 stackFrame.AddrFrame.Offset = context->Ebp;
132 #elif defined(_M_MRX000)
133 machineType = IMAGE_FILE_MACHINE_R4000;
134 stackFrame.AddrPC.Offset = context->Fir;
135 #elif defined(_M_ALPHA)
136 machineType = IMAGE_FILE_MACHINE_ALPHA;
137 stackFrame.AddrPC.Offset = (unsigned long)context->Fir;
138 #elif defined(_M_PPC)
139 machineType = IMAGE_FILE_MACHINE_POWERPC;
140 stackFrame.AddrPC.Offset = context->Iar;
141 #elif defined(_M_IA64)
142 machineType = IMAGE_FILE_MACHINE_IA64;
143 stackFrame.AddrPC.Offset = context->StIIP;
144 #elif defined(_M_ALPHA64)
145 machineType = IMAGE_FILE_MACHINE_ALPHA64;
146 stackFrame.AddrPC.Offset = context->Fir;
150 for (frameIndex = 0; frameIndex < maxFrames; ) {
151 BOOL bRet = StackWalk(machineType, hProcess, hThread, &stackFrame, &context, NULL, FunctionTableAccess, GetModuleBase, NULL);
158 frames[frameIndex++] = (void*)(ULONG_PTR)stackFrame.AddrPC.Offset;
164 size_t GetModuleNameFromAddress(void* address, char* moduleName, size_t size)
166 if (size) *moduleName = 0;
168 const char* sourceName;
169 IMAGEHLP_MODULE moduleInfo = { sizeof (moduleInfo) };
170 if (!SymGetModuleInfo(GetSymHandle(), CheckAddress(address), &moduleInfo)) {
173 sourceName = strrchr(moduleInfo.ImageName, '\\');
177 sourceName = moduleInfo.ImageName;
180 strncpy(moduleName, sourceName, size)[size - 1] = 0;
182 return strlen(sourceName);
186 size_t GetModuleNameFromStack(size_t skip, char* moduleName, size_t size)
188 void* address = NULL;
189 GetStackFrames(skip + 1, &address, 1);
191 return GetModuleNameFromAddress(address, moduleName, size);
196 size_t GetSymbolNameFromAddress(void* address, char* symbolName, size_t size, size_t* offsetBytes)
198 if (size) *symbolName = 0;
199 if (offsetBytes) *offsetBytes = 0;
201 ULONG_ADDR dwOffset = 0;
204 char symNameBuffer[sizeof(IMAGEHLP_SYMBOL) + MAX_SYM_NAME];
206 u.sym.SizeOfStruct = sizeof(u.sym);
207 u.sym.MaxNameLength = sizeof(u.symNameBuffer) - sizeof(u.sym);
209 if (!SymGetSymFromAddr(GetSymHandle(), CheckAddress(address), &dwOffset, &u.sym)) {
212 const char* sourceName = u.sym.Name;
214 if (UnDecorateSymbolName(u.sym.Name, undName, sizeof(undName), UNDNAME_NO_MS_KEYWORDS | UNDNAME_NO_ACCESS_SPECIFIERS)) {
215 sourceName = undName;
216 } else if (SymUnDName(&u.sym, undName, sizeof(undName))) {
217 sourceName = undName;
220 *offsetBytes = dwOffset;
223 strncpy(symbolName, sourceName, size)[size - 1] = 0;
225 return strlen(sourceName);
227 } __except (EXCEPTION_EXECUTE_HANDLER) {
228 SetLastError(GetExceptionCode());
233 size_t GetSymbolNameFromStack(size_t skip, char* symbolName, size_t size, size_t* offsetBytes)
235 void* address = NULL;
236 GetStackFrames(skip + 1, &address, 1);
238 return GetSymbolNameFromAddress(address, symbolName, size, offsetBytes);
243 size_t GetFileLineFromAddress(void* address, char* fileName, size_t size, size_t* lineNumber, size_t* offsetBytes)
245 if (size) *fileName = 0;
246 if (lineNumber) *lineNumber = 0;
247 if (offsetBytes) *offsetBytes = 0;
250 IMAGEHLP_LINE line = { sizeof (line) };
251 ULONG_PTR dwOffset = 0;
252 if (!SymGetLineFromAddr(GetSymHandle(), CheckAddress(address), &dwOffset, &line)) {
256 *lineNumber = line.LineNumber;
259 *offsetBytes = dwOffset;
261 sourceName = line.FileName;
262 // TODO: resolve relative filenames, found in 'source directories' registered with MSVC IDE.
264 strncpy(fileName, sourceName, size)[size - 1] = 0;
266 return strlen(sourceName);
270 size_t GetFileLineFromStack(size_t skip, char* fileName, size_t size, size_t* lineNumber, size_t* offsetBytes)
272 void* address = NULL;
273 GetStackFrames(skip + 1, &address, 1);
275 return GetFileLineFromAddress(address, fileName, size, lineNumber, offsetBytes);
280 size_t GetDescriptionFromAddress(void* address, const char* format, char* buffer, size_t size)
282 char*const begin = buffer;
283 char*const end = buffer + size;
284 size_t line_number = 0;
290 buffer += GetFileLineFromAddress(address, buffer, size, &line_number, NULL);
291 size = end < buffer ? 0 : end - buffer;
294 wsprintf(str, "(%d) : ", line_number);
296 strncpy(buffer, str, size)[size - 1] = 0;
298 buffer += strlen(str);
299 size = end < buffer ? 0 : end - buffer;
303 strncpy(buffer, "at ", size)[size - 1] = 0;
305 buffer += strlen("at ");
306 size = end < buffer ? 0 : end - buffer;
308 buffer += GetSymbolNameFromAddress(address, buffer, size, NULL);
309 size = end < buffer ? 0 : end - buffer;
312 strncpy(buffer, " in ", size)[size - 1] = 0;
314 buffer += strlen(" in ");
315 size = end < buffer ? 0 : end - buffer;
317 buffer += GetModuleNameFromAddress(address, buffer, size);
318 size = end < buffer ? 0 : end - buffer;
320 return buffer - begin;
323 size_t GetDescriptionFromStack(void*const frames[], size_t count, const char* format, char* description[], size_t size)
325 char*const begin = (char*)description;
326 char*const end = begin + size;
327 char* buffer = begin + (count + 1) * sizeof(char*);
329 for (i = 0; i < count; ++i) {
330 if (description) description[i] = buffer;
331 size = end < buffer ? 0 : end - buffer;
332 buffer += 1 + GetDescriptionFromAddress(frames[i], NULL, buffer, size);
334 if (description) description[count] = NULL;
335 return buffer - begin;
338 /* Compatibility with <execinfo.h> */
340 int backtrace(void* addresses[], int count)
342 return GetStackFrames(1, addresses, count);
345 char** backtrace_symbols(void*const* addresses, int count)
347 size_t size = GetDescriptionFromStack(addresses, count, NULL, NULL, 0);
348 char** symbols = (char**)malloc(size);
349 GetDescriptionFromStack(addresses, count, NULL, symbols, size);
353 #endif /* !_M_AMD64 */