fcbacktrace.cpp

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 is free software: you can redistribute it
 \___  \____/   __/    and/or modify it under the terms of the GNU  General
     \_       _/          Public License  as published by the Free Software
       | @ @  \_               Foundation, either version 3 of the  License,
       |                              or (at your option) any later version.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
 
#include <QLoggingCategory>
#include <sstream>
 
#ifdef FREECIV_DEBUG
#include <backward.hpp>
#endif
 
// utility
#include "log.h"
 
#include "fcbacktrace.h"
 
// We don't want backtrace-spam to testmatic logs
#if defined(FREECIV_DEBUG) && !defined(FREECIV_TESTMATIC)
#define BACKTRACE_ACTIVE 1
#endif
 
#ifdef BACKTRACE_ACTIVE
#define MAX_NUM_FRAMES 64
 
Q_LOGGING_CATEGORY(stack_category, "freeciv.stacktrace")
 
namespace {
static QtMessageHandler previous = nullptr;
 
static void backtrace_log(QtMsgType type, const QMessageLogContext &context,
                          const QString &message);
void backtrace_print(QtMsgType type, const QMessageLogContext &context);
} // anonymous namespace
#endif // BACKTRACE_ACTIVE
 
void backtrace_init()
{
#ifdef BACKTRACE_ACTIVE
  previous = qInstallMessageHandler(backtrace_log);
#endif
}
 
void backtrace_deinit()
{
#ifdef BACKTRACE_ACTIVE
  qInstallMessageHandler(previous);
#endif // BACKTRACE_ACTIVE
}
 
#ifdef BACKTRACE_ACTIVE
namespace {
static void backtrace_log(QtMsgType type, const QMessageLogContext &context,
                          const QString &message)
{
  if (type == QtFatalMsg || type == QtCriticalMsg) {
    backtrace_print(type, context);
  }
 
  if (previous != nullptr) {
    // Call chained callback after printing the trace, because it might
    // abort()
    previous(type, context, message);
  }
}
} // anonymous namespace
 
namespace {
void backtrace_print(QtMsgType type, const QMessageLogContext &context)
{
  if (!stack_category().isEnabled(QtDebugMsg)) {
    // We won't print anything anyway. Since walking the stack is
    // expensive, return immediately.
    return;
  }
 
  using namespace backward;
  StackTrace st;
  st.load_here(MAX_NUM_FRAMES);
 
  // Generate the trace string
  Printer p;
  p.object = false;
  p.address = true;
 
  std::stringstream ss;
  p.print(st, ss);
 
  // Create a new context with the correct category name.
  QMessageLogContext modified_context(context.file, context.line,
                                      context.function,
                                      stack_category().categoryName());
 
  // Print
  std::string line;
  while (std::getline(ss, line)) {
    // Do the formatting manually (this is called from the message handler
    // and automatic formatting doesn't appear to work there).
    qCDebug(stack_category).noquote()
        << qFormatLogMessage(type, modified_context, line.data());
  }
}
 
} // anonymous namespace
#endif // BACKTRACE_ACTIVE