src/common/logbacktrace_win.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #include "quassel.h"
  22
  23 #include <windows.h>
  24 #include <dbghelp.h>
  25 #include <stdio.h>
  26
  27 // #include <QDebug>
  28 #include <QFile>
  29 #include <QTextStream>
  30
  31 void loadHelpStackFrame(IMAGEHLP_STACK_FRAME &ihsf, const STACKFRAME64 &stackFrame) {
  32   ZeroMemory(&ihsf, sizeof(IMAGEHLP_STACK_FRAME));
  33   ihsf.InstructionOffset = stackFrame.AddrPC.Offset;
  34   ihsf.FrameOffset = stackFrame.AddrFrame.Offset;
  35 }
  36
  37 BOOL CALLBACK EnumSymbolsCB(PSYMBOL_INFO symInfo, ULONG size, PVOID user) {
  38   QStringList *params = (QStringList *)user;
  39   if(symInfo->Flags & SYMFLAG_PARAMETER) {
  40     params->append(symInfo->Name);
  41   }
  42   return TRUE;
  43 }
  44
  45
  46 struct EnumModulesContext {
  47   HANDLE hProcess;
  48   QTextStream &stream;
  49   EnumModulesContext(HANDLE hProcess, QTextStream &stream) : hProcess(hProcess), stream(stream) {}
  50 };
  51
  52 BOOL CALLBACK EnumModulesCB(PCTSTR ModuleName, DWORD64 BaseOfDll, PVOID UserContext) {
  53   IMAGEHLP_MODULE64 mod;
  54   EnumModulesContext *context = (EnumModulesContext *)UserContext;
  55   mod.SizeOfStruct = sizeof(IMAGEHLP_MODULE64);
  56   if(SymGetModuleInfo64(context->hProcess, BaseOfDll, &mod)) {
  57     QString line = QString("%1 0x%2 Image: %3").arg(mod.ModuleName, -14)
  58       .arg(BaseOfDll, 8, 16, QLatin1Char('0'))
  59       .arg(mod.LoadedImageName);
  60     // qDebug() << qPrintable(line);
  61     context->stream  << line << '\n';
  62
  63     QString pdbName(mod.LoadedPdbName);
  64     if(!pdbName.isEmpty()) {
  65       QString line2 = QString("%1 %2").arg("", 32).arg(pdbName);
  66       // qDebug() << qPrintable(line2);
  67       context->stream  << line2 << '\n';
  68     }
  69   }
  70   return TRUE;
  71 }
  72
  73 // we don't use the ModuleName anyways so we can easily "convert" this
  74 inline BOOL CALLBACK EnumModulesCB(PSTR ModuleName, DWORD64 BaseOfDll, PVOID UserContext) {
  75   return EnumModulesCB(PCTSTR(0), BaseOfDll, UserContext);
  76 }
  77
  78 #ifdef _M_IX86
  79   // Disable global optimization and ignore /GS waning caused by
  80   // inline assembly.
  81   #pragma optimize("g", off)
  82   #pragma warning(push)
  83   #pragma warning(disable : 4748)
  84 #endif
  85 void Quassel::logBacktrace(const QString &filename) {
  86   DWORD MachineType;
  87   CONTEXT Context;
  88   STACKFRAME64 StackFrame;
  89
  90 #ifdef _M_IX86
  91     ZeroMemory(&Context, sizeof(CONTEXT));
  92     Context.ContextFlags = CONTEXT_CONTROL;
  93     __asm {
  94     Label:
  95       mov [Context.Ebp], ebp;
  96       mov [Context.Esp], esp;
  97       mov eax, [Label];
  98       mov [Context.Eip], eax;
  99     }
 100 #else
 101     RtlCaptureContext(&Context);
 102 #endif
 103
 104   ZeroMemory(&StackFrame, sizeof(STACKFRAME64));
 105 #ifdef _M_IX86
 106   MachineType                 = IMAGE_FILE_MACHINE_I386;
 107   StackFrame.AddrPC.Offset    = Context.Eip;
 108   StackFrame.AddrPC.Mode      = AddrModeFlat;
 109   StackFrame.AddrFrame.Offset = Context.Ebp;
 110   StackFrame.AddrFrame.Mode   = AddrModeFlat;
 111   StackFrame.AddrStack.Offset = Context.Esp;
 112   StackFrame.AddrStack.Mode   = AddrModeFlat;
 113 #elif _M_X64
 114   MachineType                 = IMAGE_FILE_MACHINE_AMD64;
 115   StackFrame.AddrPC.Offset    = Context.Rip;
 116   StackFrame.AddrPC.Mode      = AddrModeFlat;
 117   StackFrame.AddrFrame.Offset = Context.Rsp;
 118   StackFrame.AddrFrame.Mode   = AddrModeFlat;
 119   StackFrame.AddrStack.Offset = Context.Rsp;
 120   StackFrame.AddrStack.Mode   = AddrModeFlat;
 121 #elif _M_IA64
 122   MachineType                 = IMAGE_FILE_MACHINE_IA64;
 123   StackFrame.AddrPC.Offset    = Context.StIIP;
 124   StackFrame.AddrPC.Mode      = AddrModeFlat;
 125   StackFrame.AddrFrame.Offset = Context.IntSp;
 126   StackFrame.AddrFrame.Mode   = AddrModeFlat;
 127   StackFrame.AddrBStore.Offset= Context.RsBSP;
 128   StackFrame.AddrBStore.Mode  = AddrModeFlat;
 129   StackFrame.AddrStack.Offset = Context.IntSp;
 130   StackFrame.AddrStack.Mode   = AddrModeFlat;
 131 #else
 132   #error "Unsupported platform"
 133 #endif
 134
 135   //EnterCriticalSection(&DbgHelpLock);
 136
 137   QFile logFile(filename);
 138   logFile.open(QIODevice::Append);
 139   QTextStream logStream(&logFile);
 140
 141   HANDLE hProcess = GetCurrentProcess();
 142   HANDLE hThread = GetCurrentThread();
 143   SymInitialize(hProcess, NULL, TRUE);
 144
 145   DWORD64 dwDisplacement;
 146
 147   ULONG64 buffer[(sizeof(SYMBOL_INFO) +
 148                   MAX_SYM_NAME*sizeof(TCHAR) +
 149                   sizeof(ULONG64) - 1) /  sizeof(ULONG64)];
 150   PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)buffer;
 151   pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
 152   pSymbol->MaxNameLen = MAX_SYM_NAME;
 153
 154   IMAGEHLP_MODULE64 mod;
 155   mod.SizeOfStruct = sizeof(IMAGEHLP_MODULE64);
 156
 157   IMAGEHLP_STACK_FRAME ihsf;
 158   ZeroMemory(&ihsf, sizeof(IMAGEHLP_STACK_FRAME));
 159
 160   int i = 0;
 161   while(StackWalk64(MachineType, hProcess, hThread, &StackFrame, &Context, NULL, NULL, NULL, NULL)) {
 162     if(i == 128)
 163       break;
 164
 165     loadHelpStackFrame(ihsf, StackFrame);
 166     if(StackFrame.AddrPC.Offset != 0) { // Valid frame.
 167
 168       QString fileName("???");
 169       if(SymGetModuleInfo64(hProcess, ihsf.InstructionOffset, &mod)) {
 170         fileName = QString(mod.ImageName);
 171         int slashPos = fileName.lastIndexOf('\\');
 172         if(slashPos != -1)
 173           fileName = fileName.mid(slashPos + 1);
 174       }
 175       QString funcName;
 176       if(SymFromAddr(hProcess, ihsf.InstructionOffset, &dwDisplacement, pSymbol)) {
 177         funcName = QString(pSymbol->Name);
 178       } else {
 179         funcName = QString("0x%1").arg(ihsf.InstructionOffset, 8, 16, QLatin1Char('0'));
 180       }
 181       QStringList params;
 182       SymSetContext(hProcess, &ihsf, NULL);
 183       SymEnumSymbols(hProcess, 0, NULL, EnumSymbolsCB, (PVOID)&params);
 184
 185       QString debugLine = QString("#%1 %2 0x%3 %4(%5)").arg(i, 3, 10)
 186         .arg(fileName, -20)
 187         .arg(ihsf.InstructionOffset, 8, 16, QLatin1Char('0'))
 188         .arg(funcName)
 189         .arg(params.join(", "));
 190       // qDebug() << qPrintable(debugLine);
 191       logStream << debugLine << '\n';
 192       i++;
 193     } else {
 194       break; // we're at the end.
 195     }
 196   }
 197
 198   // qDebug() << "List of linked Modules:";
 199   logStream << "\n\nList of linked Modules:\n";
 200   EnumModulesContext modulesContext(hProcess, logStream);
 201   SymEnumerateModules64(hProcess, EnumModulesCB, (PVOID)&modulesContext);
 202
 203   logFile.close();
 204 }
 205 #ifdef _M_IX86
 206   #pragma warning(pop)
 207   #pragma optimize("g", on)
 208 #endif