libcruft-util/debug.cpp

174 lines
4.5 KiB
C++

/*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* Copyright 2010-2018 Danny Robson <danny@nerdcruft.net>
*/
#include "backtrace.hpp"
#include "debug.hpp"
#include "log.hpp"
#include <cruft/util/preprocessor.hpp>
#include <cstdlib>
#include <iostream>
using namespace cruft::debug;
////////////////////////////////////////////////////////////////////////////////
void
cruft::debug::detail::panic (const char *msg)
{
std::cerr << "PANIC: " << msg << "\n" << ::debug::backtrace () << std::endl;
breakpoint ();
abort ();
}
////////////////////////////////////////////////////////////////////////////////
void
cruft::debug::detail::not_implemented (const char *msg)
{
panic (msg);
}
//-----------------------------------------------------------------------------
void
cruft::debug::detail::unreachable (const char *msg)
{
panic (msg);
}
////////////////////////////////////////////////////////////////////////////////
void
warn (void)
{
warn ("Unusual code path found.");
}
//-----------------------------------------------------------------------------
void
warn (const std::string &msg)
{
warn (msg.c_str ());
}
//-----------------------------------------------------------------------------
void
warn (const char *msg)
{
LOG_WARN (msg);
}
////////////////////////////////////////////////////////////////////////////////
static void abort_with_trace (void)
{
// Manually trigger a breakpoint if possible so that the debugger won't
// silently dump us some place without further information.
// eg, CLion/GDB/Win32 silently dropping us out of the session.
breakpoint ();
// If this is because of an exception we may as well rethrow and hope that
// the system will print exception data during the abort process.
//
// But we can at least try to print anything derived from std::exception
// (which is a likely guess) before we self-destruct.
if (auto ptr = std::current_exception (); ptr) {
try {
std::rethrow_exception (ptr);
} catch (std::exception const &x) {
LOG_EMERGENCY ("unhandled exception: %!\n%!", x.what (), debug::backtrace {});
} catch (...) {
LOG_EMERGENCY ("unhandled exception: %!\n", debug::backtrace {});
}
} else {
LOG_EMERGENCY ("aborting: %!", debug::backtrace {});
}
std::abort ();
}
//-----------------------------------------------------------------------------
void
cruft::debug::init [[gnu::constructor]] (void)
{
std::set_terminate (abort_with_trace);
if (!debug_enabled && !getenv ("DEBUG"))
return;
LOG_DEBUG ("setting debug environment");
//enable_fpe ();
force_console ();
prepare_debugger ();
if (getenv ("DEBUG_WAIT"))
await_debugger ();
}
///////////////////////////////////////////////////////////////////////////////
static void
debug_wait [[gnu::constructor]] (void)
{
if (auto val = getenv ("DEBUG_WAIT")) {
LOG_NOTICE ("awaiting debugger");
if (std::string ("0") != val)
await_debugger ();
}
}
///////////////////////////////////////////////////////////////////////////////
template <>
bool
cruft::debug::validator<float>::is_valid (const float &val) noexcept
{
return !std::isnan (val);
}
//-----------------------------------------------------------------------------
template <>
bool
cruft::debug::validator<double>::is_valid (const double &val) noexcept
{
return !std::isnan (val);
}
///////////////////////////////////////////////////////////////////////////////
#include "std.hpp"
//-----------------------------------------------------------------------------
#define INSTANTIATE(KLASS) \
template <> \
struct cruft::debug::validator<KLASS> { \
static bool is_valid(KLASS const&); \
}; \
\
bool \
cruft::debug::validator<KLASS>::is_valid(KLASS const&) \
{ \
return true; \
}
//-----------------------------------------------------------------------------
MAP0(INSTANTIATE,
u08, u16, u32, u64,
i08, i16, i32, i64,
char
)