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 "globaldefs.h"
25 #include "stream/textstream.h"
27 #include "environment.h"
33 void write_stack_trace(TextOutputStream &outputStream)
35 const unsigned int MAX_SYMBOLS = 256;
36 void *symbols[MAX_SYMBOLS];
38 // get return addresses
39 int symbol_count = backtrace(symbols, MAX_SYMBOLS);
45 // resolve and print names
46 char **symbol_names = backtrace_symbols(symbols, symbol_count);
48 for (int i = 0; (i < symbol_count); ++i) {
49 outputStream << symbol_names[i] << "\n";
52 // not a memleak, see www.gnu.org/software/libc/manual (Debugging Support, Backtraces)
57 #elif GDEF_COMPILER_MSVC
67 Address( void* value ) : m_value( value ){
71 /// \brief Writes an address \p p to \p ostream in hexadecimal form.
72 template<typename TextOutputStreamType>
73 inline TextOutputStreamType& ostream_write( TextOutputStreamType& ostream, const Address& p ){
74 const std::size_t bufferSize = ( sizeof( void* ) * 2 ) + 1;
76 ostream.write( buf, snprintf( buf, bufferSize, "%0p", p.m_value ) );
84 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 ){
91 const std::size_t bufferSize = ( sizeof( void* ) * 2 ) + 1;
93 ostream.write( buf, snprintf( buf, bufferSize, "%X", p.m_value ) );
97 /// \brief Writes a WCHAR string \p s to \p ostream.
98 template<typename TextOutputStreamType>
99 inline TextOutputStreamType& ostream_write( TextOutputStreamType& ostream, const WCHAR* s ){
100 const std::size_t bufferSize = 1024;
101 char buf[bufferSize];
102 ostream.write( buf, snprintf( buf, bufferSize, "%ls", s ) );
106 struct EnumerateSymbolsContext
109 TextOutputStream& outputStream;
111 EnumerateSymbolsContext( STACKFRAME64& sf, TextOutputStream& outputStream ) : sf( sf ), outputStream( outputStream ), count( 0 ){
115 void write_symbol( PSYMBOL_INFO pSym, STACKFRAME64& sf, TextOutputStream& outputStream, std::size_t& count ){
117 if ( pSym->Flags & SYMFLAG_PARAMETER ) {
120 if ( SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, pSym->TypeIndex,
121 TI_GET_BASETYPE, &basicType ) ) {
127 if ( SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, pSym->TypeIndex,
128 TI_GET_TYPEID, &typeId ) ) {
129 if ( SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, pSym->TypeIndex,
130 TI_GET_BASETYPE, &basicType ) ) {
135 const char* FormatGetLastError();
136 const char* error = FormatGetLastError();
140 if ( SymGetTypeInfo( GetCurrentProcess(), pSym->ModBase, typeId,
141 TI_GET_SYMNAME, &name ) ) {
142 outputStream << name << " ";
148 const char* FormatGetLastError();
149 const char* error = FormatGetLastError();
156 const char* FormatGetLastError();
157 const char* error = FormatGetLastError();
162 outputStream << ", ";
164 outputStream << pSym->Name;
171 EnumerateSymbolsCallback(
172 PSYMBOL_INFO pSymInfo,
175 write_symbol( pSymInfo, ( (EnumerateSymbolsContext*)UserContext )->sf, ( (EnumerateSymbolsContext*)UserContext )->outputStream, ( (EnumerateSymbolsContext*)UserContext )->count );
181 void write_stack_trace( PCONTEXT pContext, TextOutputStream& outputStream ){
182 HANDLE m_hProcess = GetCurrentProcess();
183 DWORD dwMachineType = 0;
185 CONTEXT context = *pContext;
187 // Could use SymSetOptions here to add the SYMOPT_DEFERRED_LOADS flag
188 if ( !SymInitialize( m_hProcess, (PSTR)environment_get_app_path(), TRUE ) ) {
193 memset( &sf, 0, sizeof( sf ) );
194 sf.AddrPC.Mode = AddrModeFlat;
195 sf.AddrStack.Mode = AddrModeFlat;
196 sf.AddrFrame.Mode = AddrModeFlat;
199 // Initialize the STACKFRAME structure for the first call. This is only
200 // necessary for Intel CPUs, and isn't mentioned in the documentation.
201 sf.AddrPC.Offset = context.Eip;
202 sf.AddrStack.Offset = context.Esp;
203 sf.AddrFrame.Offset = context.Ebp;
205 dwMachineType = IMAGE_FILE_MACHINE_I386;
207 sf.AddrPC.Offset = context.Rip;
208 sf.AddrStack.Offset = context.Rsp;
210 // MSDN: x64: The frame pointer is RBP or RDI. This value is not always used.
211 // very funny, we'll try Rdi for now
212 sf.AddrFrame.Offset = context.Rdi;
214 dwMachineType = IMAGE_FILE_MACHINE_AMD64;
217 const unsigned int max_sym_name = 1024; // should be enough
221 // Get the next stack frame
222 if ( !StackWalk64( dwMachineType,
228 SymFunctionTableAccess64,
234 if ( 0 == sf.AddrFrame.Offset ) { // Basic sanity check to make sure
235 break; // the frame is OK. Bail if not.
238 // Get the name of the function for this stack frame entry
239 BYTE symbolBuffer[ sizeof( SYMBOL_INFO ) + max_sym_name ];
240 PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)symbolBuffer;
241 pSymbol->SizeOfStruct = sizeof( SYMBOL_INFO );
242 pSymbol->MaxNameLen = max_sym_name;
244 DWORD64 symDisplacement = 0; // Displacement of the input address,
245 // relative to the start of the symbol
247 IMAGEHLP_MODULE64 module = { sizeof( IMAGEHLP_MODULE64 ) };
248 if ( SymGetModuleInfo64( m_hProcess, sf.AddrPC.Offset, &module ) ) {
249 outputStream << module.ModuleName << "!";
251 if ( SymFromAddr( m_hProcess, sf.AddrPC.Offset, &symDisplacement, pSymbol ) ) {
252 char undecoratedName[max_sym_name];
253 UnDecorateSymbolName( pSymbol->Name, undecoratedName, max_sym_name, UNDNAME_COMPLETE );
255 outputStream << undecoratedName;
258 // Use SymSetContext to get just the locals/params for this frame
259 IMAGEHLP_STACK_FRAME imagehlpStackFrame;
260 imagehlpStackFrame.InstructionOffset = sf.AddrPC.Offset;
261 SymSetContext( m_hProcess, &imagehlpStackFrame, 0 );
263 // Enumerate the locals/parameters
264 EnumerateSymbolsContext context( sf, outputStream );
265 SymEnumSymbols( m_hProcess, 0, 0, EnumerateSymbolsCallback, &context );
268 outputStream << " + " << Offset( reinterpret_cast<void*>( symDisplacement ) );
270 // Get the source line for this stack frame entry
271 IMAGEHLP_LINE64 lineInfo = { sizeof( IMAGEHLP_LINE64 ) };
272 DWORD dwLineDisplacement;
273 if ( SymGetLineFromAddr64( m_hProcess, sf.AddrPC.Offset,
274 &dwLineDisplacement, &lineInfo ) ) {
275 outputStream << " " << lineInfo.FileName << " line " << Unsigned( lineInfo.LineNumber );
280 outputStream << Address( reinterpret_cast<void*>( sf.AddrPC.Offset ) );
284 outputStream << "\n";
287 SymCleanup( m_hProcess );
292 void write_stack_trace( TextOutputStream& outputStream ){
293 __try { RaiseException( 0,0,0,0 ); } __except( write_stack_trace( ( GetExceptionInformation() )->ContextRecord, outputStream ), EXCEPTION_CONTINUE_EXECUTION ) {
297 #elif GDEF_OS_WINDOWS
298 void write_stack_trace( TextOutputStream& outputStream ){
299 outputStream << "\nStacktrace is disabled on this compiler\n";
302 void write_stack_trace( TextOutputStream& outputStream ){
303 outputStream << "\nStacktrace is disabled on this platform\n";