src/common/logbacktrace_win.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
   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 #if _MSC_VER >= 1500
  53 BOOL CALLBACK EnumModulesCB(PCTSTR ModuleName, DWORD64 BaseOfDll, PVOID UserContext) {
  54 #else
  55 BOOL CALLBACK EnumModulesCB(PSTR ModuleName, DWORD64 BaseOfDll, PVOID UserContext) {
  56 #endif
  57   IMAGEHLP_MODULE64 mod;
  58   EnumModulesContext *context = (EnumModulesContext *)UserContext;
  59   mod.SizeOfStruct = sizeof(IMAGEHLP_MODULE64);
  60   if(SymGetModuleInfo64(context->hProcess, BaseOfDll, &mod)) {
  61     QString line = QString("%1 0x%2 Image: %3").arg(mod.ModuleName, -14)
  62       .arg(BaseOfDll, 8, 16, QLatin1Char('0'))
  63       .arg(mod.LoadedImageName);
  64     // qDebug() << qPrintable(line);
  65     context->stream  << line << '\n';
  66
  67     QString pdbName(mod.LoadedPdbName);
  68     if(!pdbName.isEmpty()) {
  69       QString line2 = QString("%1 %2").arg("", 32).arg(pdbName);
  70       // qDebug() << qPrintable(line2);
  71       context->stream  << line2 << '\n';
  72     }
  73   }
  74   return TRUE;
  75 }
  76
  77 #ifdef _M_IX86
  78   // Disable global optimization and ignore /GS waning caused by
  79   // inline assembly.
  80   #pragma optimize("g", off)
  81   #pragma warning(push)
  82   #pragma warning(disable : 4748)
  83 #endif
  84 void Quassel::logBacktrace(const QString &filename) {
  85   DWORD MachineType;
  86   CONTEXT Context;
  87   STACKFRAME64 StackFrame;
  88
  89 #ifdef _M_IX86
  90     ZeroMemory(&Context, sizeof(CONTEXT));
  91     Context.ContextFlags = CONTEXT_CONTROL;
  92     __asm {
  93     Label:
  94       mov [Context.Ebp], ebp;
  95       mov [Context.Esp], esp;
  96       mov eax, [Label];
  97       mov [Context.Eip], eax;
  98     }
  99 #else
 100     RtlCaptureContext(&Context);
 101 #endif
 102
 103   ZeroMemory(&StackFrame, sizeof(STACKFRAME64));
 104 #ifdef _M_IX86
 105   MachineType                 = IMAGE_FILE_MACHINE_I386;
 106   StackFrame.AddrPC.Offset    = Context.Eip;
 107   StackFrame.AddrPC.Mode      = AddrModeFlat;
 108   StackFrame.AddrFrame.Offset = Context.Ebp;
 109   StackFrame.AddrFrame.Mode   = AddrModeFlat;
 110   StackFrame.AddrStack.Offset = Context.Esp;
 111   StackFrame.AddrStack.Mode   = AddrModeFlat;
 112 #elif _M_X64
 113   MachineType                 = IMAGE_FILE_MACHINE_AMD64;
 114   StackFrame.AddrPC.Offset    = Context.Rip;
 115   StackFrame.AddrPC.Mode      = AddrModeFlat;
 116   StackFrame.AddrFrame.Offset = Context.Rsp;
 117   StackFrame.AddrFrame.Mode   = AddrModeFlat;
 118   StackFrame.AddrStack.Offset = Context.Rsp;
 119   StackFrame.AddrStack.Mode   = AddrModeFlat;
 120 #elif _M_IA64
 121   MachineType                 = IMAGE_FILE_MACHINE_IA64;
 122   StackFrame.AddrPC.Offset    = Context.StIIP;
 123   StackFrame.AddrPC.Mode      = AddrModeFlat;
 124   StackFrame.AddrFrame.Offset = Context.IntSp;
 125   StackFrame.AddrFrame.Mode   = AddrModeFlat;
 126   StackFrame.AddrBStore.Offset= Context.RsBSP;
 127   StackFrame.AddrBStore.Mode  = AddrModeFlat;
 128   StackFrame.AddrStack.Offset = Context.IntSp;
 129   StackFrame.AddrStack.Mode   = AddrModeFlat;
 130 #else
 131   #error "Unsupported platform"
 132 #endif
 133
 134   //EnterCriticalSection(&DbgHelpLock);
 135
 136   QFile logFile(filename);
 137   logFile.open(QIODevice::Append);
 138   QTextStream logStream(&logFile);
 139
 140   HANDLE hProcess = GetCurrentProcess();
 141   HANDLE hThread = GetCurrentThread();
 142   SymInitialize(hProcess, NULL, TRUE);
 143
 144   DWORD64 dwDisplacement;
 145
 146   ULONG64 buffer[(sizeof(SYMBOL_INFO) +
 147                   MAX_SYM_NAME*sizeof(TCHAR) +
 148                   sizeof(ULONG64) - 1) /  sizeof(ULONG64)];
 149   PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)buffer;
 150   pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
 151   pSymbol->MaxNameLen = MAX_SYM_NAME;
 152
 153   IMAGEHLP_MODULE64 mod;
 154   mod.SizeOfStruct = sizeof(IMAGEHLP_MODULE64);
 155
 156   IMAGEHLP_STACK_FRAME ihsf;
 157   ZeroMemory(&ihsf, sizeof(IMAGEHLP_STACK_FRAME));
 158
 159   int i = 0;
 160   while(StackWalk64(MachineType, hProcess, hThread, &StackFrame, &Context, NULL, NULL, NULL, NULL)) {
 161     if(i == 128)
 162       break;
 163
 164     loadHelpStackFrame(ihsf, StackFrame);
 165     if(StackFrame.AddrPC.Offset != 0) { // Valid frame.
 166
 167       QString fileName("???");
 168       if(SymGetModuleInfo64(hProcess, ihsf.InstructionOffset, &mod)) {
 169         fileName = QString(mod.ImageName);
 170         int slashPos = fileName.lastIndexOf('\\');
 171         if(slashPos != -1)
 172           fileName = fileName.mid(slashPos + 1);
 173       }
 174       QString funcName;
 175       if(SymFromAddr(hProcess, ihsf.InstructionOffset, &dwDisplacement, pSymbol)) {
 176         funcName = QString(pSymbol->Name);
 177       } else {
 178         funcName = QString("0x%1").arg(ihsf.InstructionOffset, 8, 16, QLatin1Char('0'));
 179       }
 180       QStringList params;
 181       SymSetContext(hProcess, &ihsf, NULL);
 182       SymEnumSymbols(hProcess, 0, NULL, EnumSymbolsCB, (PVOID)&params);
 183
 184       QString debugLine = QString("#%1 %2 0x%3 %4(%5)").arg(i, 3, 10)
 185         .arg(fileName, -20)
 186         .arg(ihsf.InstructionOffset, 8, 16, QLatin1Char('0'))
 187         .arg(funcName)
 188         .arg(params.join(", "));
 189       // qDebug() << qPrintable(debugLine);
 190       logStream << debugLine << '\n';
 191       i++;
 192     } else {
 193       break; // we're at the end.
 194     }
 195   }
 196
 197   // qDebug() << "List of linked Modules:";
 198   logStream << "\n\nList of linked Modules:\n";
 199   EnumModulesContext modulesContext(hProcess, logStream);
 200   SymEnumerateModules64(hProcess, EnumModulesCB, (PVOID)&modulesContext);
 201
 202   logFile.close();
 203 }
 204 #ifdef _M_IX86
 205   #pragma warning(pop)
 206   #pragma optimize("g", on)
 207 #endif