2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "stacktrace.h"
23 #include "stream/textstream.h"
25 #include "environment.h"
30 void write_stack_trace(TextOutputStream& outputStream)
32 const unsigned int MAX_SYMBOLS = 256;
33 void* symbols[MAX_SYMBOLS];
35 // get return addresses
36 int symbol_count = backtrace(symbols, MAX_SYMBOLS);
41 // resolve and print names
42 char** symbol_names = backtrace_symbols(symbols, symbol_count);
45 for(int i = 0; (i < symbol_count); ++i)
46 outputStream << symbol_names[i] << "\n";
48 // not a memleak, see www.gnu.org/software/libc/manual (Debugging Support, Backtraces)
54 #if defined (WIN32) && defined (_MSC_VER) && defined (DEBUG)
64 Address(void* value) : m_value(value)
69 /// \brief Writes an address \p p to \p ostream in hexadecimal form.
70 template<typename TextOutputStreamType>
71 inline TextOutputStreamType& ostream_write(TextOutputStreamType& ostream, const Address& p)
73 const std::size_t bufferSize = (sizeof(void*) * 2) + 1;
75 ostream.write(buf, snprintf(buf, bufferSize, "%0p", p.m_value));
83 Offset(void* value) : m_value(value)
88 /// \brief Writes an address \p p to \p ostream in hexadecimal form.
89 template<typename TextOutputStreamType>
90 inline TextOutputStreamType& ostream_write(TextOutputStreamType& ostream, const Offset& p)
92 const std::size_t bufferSize = (sizeof(void*) * 2) + 1;
94 ostream.write(buf, snprintf(buf, bufferSize, "%X", p.m_value));
98 /// \brief Writes a WCHAR string \p s to \p ostream.
99 template<typename TextOutputStreamType>
100 inline TextOutputStreamType& ostream_write(TextOutputStreamType& ostream, const WCHAR* s)
102 const std::size_t bufferSize = 1024;
103 char buf[bufferSize];
104 ostream.write(buf, snprintf(buf, bufferSize, "%ls", s));
108 struct EnumerateSymbolsContext
111 TextOutputStream& outputStream;
113 EnumerateSymbolsContext(STACKFRAME64& sf, TextOutputStream& outputStream) : sf(sf), outputStream(outputStream), count(0)
118 void write_symbol(PSYMBOL_INFO pSym, STACKFRAME64& sf, TextOutputStream& outputStream, std::size_t& count)
121 if ( pSym->Flags & SYMFLAG_PARAMETER )
125 if ( SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, pSym->TypeIndex,
126 TI_GET_BASETYPE, &basicType ) )
133 if(SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, pSym->TypeIndex,
134 TI_GET_TYPEID, &typeId ))
136 if ( SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, pSym->TypeIndex,
137 TI_GET_BASETYPE, &basicType ) )
143 const char* FormatGetLastError();
144 const char* error = FormatGetLastError();
148 if(SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, typeId,
149 TI_GET_SYMNAME, &name ))
151 outputStream << name << " ";
157 const char* FormatGetLastError();
158 const char* error = FormatGetLastError();
165 const char* FormatGetLastError();
166 const char* error = FormatGetLastError();
172 outputStream << ", ";
174 outputStream << pSym->Name;
181 EnumerateSymbolsCallback(
182 PSYMBOL_INFO pSymInfo,
186 write_symbol( pSymInfo, ((EnumerateSymbolsContext*)UserContext)->sf, ((EnumerateSymbolsContext*)UserContext)->outputStream, ((EnumerateSymbolsContext*)UserContext)->count);
192 void write_stack_trace(PCONTEXT pContext, TextOutputStream& outputStream)
194 HANDLE m_hProcess = GetCurrentProcess();
195 DWORD dwMachineType = 0;
197 CONTEXT context = *pContext;
199 // Could use SymSetOptions here to add the SYMOPT_DEFERRED_LOADS flag
200 if ( !SymInitialize( m_hProcess, (PSTR)environment_get_app_path(), TRUE ) )
206 memset( &sf, 0, sizeof(sf) );
207 sf.AddrPC.Mode = AddrModeFlat;
208 sf.AddrStack.Mode = AddrModeFlat;
209 sf.AddrFrame.Mode = AddrModeFlat;
212 // Initialize the STACKFRAME structure for the first call. This is only
213 // necessary for Intel CPUs, and isn't mentioned in the documentation.
214 sf.AddrPC.Offset = context.Eip;
215 sf.AddrStack.Offset = context.Esp;
216 sf.AddrFrame.Offset = context.Ebp;
218 dwMachineType = IMAGE_FILE_MACHINE_I386;
220 sf.AddrPC.Offset = context.Rip;
221 sf.AddrStack.Offset = context.Rsp;
223 // MSDN: x64: The frame pointer is RBP or RDI. This value is not always used.
224 // very funny, we'll try Rdi for now
225 sf.AddrFrame.Offset = context.Rdi;
227 dwMachineType = IMAGE_FILE_MACHINE_AMD64;
230 const unsigned int max_sym_name = 1024;// should be enough
234 // Get the next stack frame
235 if ( ! StackWalk64( dwMachineType,
241 SymFunctionTableAccess64,
246 if ( 0 == sf.AddrFrame.Offset ) // Basic sanity check to make sure
247 break; // the frame is OK. Bail if not.
249 // Get the name of the function for this stack frame entry
250 BYTE symbolBuffer[ sizeof(SYMBOL_INFO) + max_sym_name ];
251 PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)symbolBuffer;
252 pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
253 pSymbol->MaxNameLen = max_sym_name;
255 DWORD64 symDisplacement = 0; // Displacement of the input address,
256 // relative to the start of the symbol
258 IMAGEHLP_MODULE64 module = { sizeof(IMAGEHLP_MODULE64) };
259 if(SymGetModuleInfo64(m_hProcess, sf.AddrPC.Offset, &module))
261 outputStream << module.ModuleName << "!";
263 if ( SymFromAddr(m_hProcess, sf.AddrPC.Offset, &symDisplacement, pSymbol))
265 char undecoratedName[max_sym_name];
266 UnDecorateSymbolName(pSymbol->Name, undecoratedName, max_sym_name, UNDNAME_COMPLETE);
268 outputStream << undecoratedName;
271 // Use SymSetContext to get just the locals/params for this frame
272 IMAGEHLP_STACK_FRAME imagehlpStackFrame;
273 imagehlpStackFrame.InstructionOffset = sf.AddrPC.Offset;
274 SymSetContext( m_hProcess, &imagehlpStackFrame, 0 );
276 // Enumerate the locals/parameters
277 EnumerateSymbolsContext context(sf, outputStream);
278 SymEnumSymbols( m_hProcess, 0, 0, EnumerateSymbolsCallback, &context );
281 outputStream << " + " << Offset(reinterpret_cast<void*>(symDisplacement));
283 // Get the source line for this stack frame entry
284 IMAGEHLP_LINE64 lineInfo = { sizeof(IMAGEHLP_LINE64) };
285 DWORD dwLineDisplacement;
286 if ( SymGetLineFromAddr64( m_hProcess, sf.AddrPC.Offset,
287 &dwLineDisplacement, &lineInfo ) )
289 outputStream << " " << lineInfo.FileName << " line " << Unsigned(lineInfo.LineNumber);
294 outputStream << Address(reinterpret_cast<void*>(sf.AddrPC.Offset));
298 outputStream << "\n";
301 SymCleanup(m_hProcess);
306 void write_stack_trace(TextOutputStream& outputStream)
308 __try{ RaiseException(0,0,0,0); } __except(write_stack_trace((GetExceptionInformation())->ContextRecord, outputStream), EXCEPTION_CONTINUE_EXECUTION) {}
313 void write_stack_trace(TextOutputStream& outputStream)
315 outputStream << "\nStacktrace is disabled in release-builds\n";