cpp_src/debug/backtrace.cc - master - uzer_007/reindexer

cpp_src/debug/backtrace.cc
385 строк10 KB
Sannikov Ilya
Update to version v5.9.0
21 ноя 2025, 13:07
21 ноя 2025, 13:07940cef0
#include "backtrace.h"
#include <cassert>
#include <cstring>
#include <iostream>
#include <sstream>
#include "estl/lock.h"
#include "estl/mutex.h"
#include "tools/fsops.h"

namespace reindexer {
namespace debug {

static recursive_mutex g_mutex;
static crash_query_reporter_t g_crash_query_reporter = [](std::ostream& sout) { sout << "<Empty crash query reporter>" << std::endl; };
static backtrace_writer_t g_writer = [](std::string_view sv) { std::cerr << sv; };
static std::string g_assertion_message("<empty>");

void backtrace_set_assertion_message(std::string&& msg) noexcept {
	lock_guard lck(g_mutex);
	g_assertion_message = std::move(msg);
}

static void print_assertion_message(std::ostream& sout) {
	std::string msg("<empty>");
	{
		lock_guard lck(g_mutex);
		std::swap(msg, g_assertion_message);
	}
	sout << "Assertion message: " << msg << std::endl;
}
}  // namespace debug
}  // namespace reindexer

#ifndef _WIN32
#include <signal.h>
#include <unistd.h>
#include <limits>
#include <span>
#include "resolver.h"

// There are 3 backtrace methods are available:
// 1. stangalone libunwind ( https://github.com/libunwind/libunwind )
// 2. libgcc's/llvm built in unwind
// 3. GNU's execinfo backtrace() call

#if REINDEX_WITH_LIBUNWIND
#define UNW_LOCAL_ONLY
#include <libunwind.h>
#endif

#if REINDEX_WITH_UNWIND
#ifndef _GNU_SOURCE
#define _GNU_SOURCE
#endif
#include <unwind.h>
#endif

#if REINDEX_WITH_EXECINFO
#include <execinfo.h>
#endif

#if REINDEX_OVERRIDE_ABORT
#include <syscall.h>
// Override abort/__assert_fail for musl build for correct backtrace
extern "C" void abort() {
	pid_t tid = syscall(SYS_gettid);
	syscall(SYS_tkill, tid, SIGABRT);
	for (;;) {
	}
}

extern "C" void __assert_fail(const char* expr, const char* file, int line, const char* func) {
	fprintf(stderr, "reindexer error: assertion failed: %s (%s: %s: %d)\n", expr, file, func, line);
	fflush(NULL);
	abort();
}
#endif

namespace reindexer {
namespace debug {

#if REINDEX_WITH_UNWIND
class [[nodiscard]] Unwinder {
public:
	size_t operator()(std::span<void*> trace) {
		trace_ = trace;
		index_ = -1;
		_Unwind_Backtrace(&this->backtrace_trampoline, this);
		return static_cast<size_t>(index_);
	}

private:
	static _Unwind_Reason_Code backtrace_trampoline(_Unwind_Context* ctx, void* self) {
		return (static_cast<Unwinder*>(self))->backtrace(ctx);
	}

	_Unwind_Reason_Code backtrace(_Unwind_Context* ctx) {
		if (index_ >= 0 && size_t(index_) >= trace_.size()) {
			return _URC_END_OF_STACK;
		}

		int ip_before_instruction = 0;
		uintptr_t ip = _Unwind_GetIPInfo(ctx, &ip_before_instruction);

		if (!ip_before_instruction) {
			if (ip == 0) {
				ip = std::numeric_limits<uintptr_t>::max();
			} else {
				ip -= 1;
			}
		}

		if (index_ >= 0) {
			trace_[index_] = reinterpret_cast<void*>(ip);
		}
		index_++;
		return _URC_NO_REASON;
	}
	ssize_t index_;
	std::span<void*> trace_;
};
#endif

int backtrace_internal(void** addrlist, size_t size, void* ctx, std::string_view& method) {
	using namespace std::string_view_literals;
	(void)ctx;
	size_t addrlen = 0;
	(void)size;
	(void)method;
	(void)addrlist;

#if REINDEX_WITH_LIBUNWIND
	method = "libunwind"sv;
	unw_cursor_t cursor;
	unw_context_t uc;

	if (!ctx) {
		unw_getcontext(&uc);
		ctx = &uc;
	}

	unw_init_local(&cursor, reinterpret_cast<unw_context_t*>(ctx));

	addrlen = 1;
	do {
		unw_word_t ip;
		unw_get_reg(&cursor, UNW_REG_IP, &ip);
		addrlist[addrlen++] = reinterpret_cast<void*>(ip);
	} while (unw_step(&cursor) && addrlen < size);
#endif
#if REINDEX_WITH_UNWIND
	Unwinder unw;
	if (addrlen < 3) {	// -V547
		method = "unwind"sv;
		addrlen = unw(std::span<void*>(addrlist, size));
	}
#endif
#if REINDEX_WITH_EXECINFO
	if (addrlen < 3) {	// -V547
		method = "execinfo"sv;
		addrlen = ::backtrace(addrlist, size);
	}
#endif
	return addrlen;
}

void print_backtrace(std::ostream& sout, void* ctx, int sig) {
#if !REINDEX_WITH_EXECINFO && !REINDEX_WITH_UNWIND && !REINDEX_WITH_LIBUNWIND
	sout << "Sorry, reindexer has been compiled without any backtrace methods." << std::endl;
#else
	void* addrlist[64] = {};
	auto resolver = TraceResolver::New();
	std::string_view method;
	int addrlen = backtrace_internal(addrlist, sizeof(addrlist) / sizeof(addrlist[0]), ctx, method);

	if (sig >= 0) {
		sout << "Signal " << sig << " ";
	}
	sout << "backtrace (" << method << "):" << std::endl;
	for (int i = 1; i < addrlen; i++) {
		auto te = TraceEntry(uintptr_t(addrlist[i]));
		std::ignore = resolver->Resolve(te);
		sout << " #" << i << " " << te << std::endl;
	}
#endif
}

void print_crash_query(std::ostream& sout) {
	auto crash_query_reporter = backtrace_get_crash_query_reporter();
	if (crash_query_reporter) {
		crash_query_reporter(sout);
	} else {
		sout << "<No crash query reporter set>" << std::endl;
	}
}

static void sighandler(int sig, siginfo_t*, void* ctx) {
	const auto writer = backtrace_get_writer();
	std::ostringstream sout;
	sout << "*** Backtrace on signal: " << sig << " ***" << std::endl;
	writer(sout.str());
	sout.str(std::string());
	sout.clear();
	print_crash_query(sout);
	writer(sout.str());
	sout.str(std::string());
	sout.clear();
	print_assertion_message(sout);
	writer(sout.str());
	sout.str(std::string());
	sout.clear();
	print_backtrace(sout, ctx, sig);
	writer(sout.str());

	exit(-1);
}

void backtrace_init() noexcept {
	struct sigaction sa;
	memset(&sa, 0, sizeof(sa));
	sa.sa_sigaction = sighandler;
	sa.sa_flags = SA_SIGINFO | SA_NODEFER | SA_RESETHAND;
	sigaction(SIGSEGV, &sa, nullptr);
	sigaction(SIGABRT, &sa, nullptr);
	sigaction(SIGBUS, &sa, nullptr);
}

void set_minidump_path(const std::string&) { assert(false); }

void backtrace_set_writer(backtrace_writer_t writer) {
	lock_guard lck(g_mutex);
	g_writer = std::move(writer);
}
void backtrace_set_crash_query_reporter(crash_query_reporter_t reporter) {
	lock_guard lck(g_mutex);
	g_crash_query_reporter = std::move(reporter);
}
backtrace_writer_t backtrace_get_writer() {
	lock_guard lck(g_mutex);
	return g_writer;
}
crash_query_reporter_t backtrace_get_crash_query_reporter() {
	lock_guard lck(g_mutex);
	return g_crash_query_reporter;
}

}  // namespace debug
}  // namespace reindexer

#elif defined(_WIN32) && defined(REINDEX_WITH_CPPTRACE)

#include <windows.h>
// Headers order matters: windows.h must be included before dbghelp.h
#include <dbghelp.h>
#undef min
#undef max
#include <csignal>
#include <memory>
#include "cpptrace/cpptrace.hpp"
#include "tools/clock.h"

namespace reindexer {
namespace debug {
static std::string g_pathMiniDump;

void outputDebugInfo(const backtrace_writer_t& writer, EXCEPTION_POINTERS* ExceptionInfo) {
	std::ostringstream sout;
	print_crash_query(sout);
	writer(sout.str());
	sout.str(std::string());
	sout.clear();
	print_assertion_message(sout);
	writer(sout.str());
	sout.str(std::string());
	sout.clear();
	print_backtrace(sout, nullptr, 0);
	writer(sout.str());

	const auto tm = system_clock_w::now();
	const auto duration = tm.time_since_epoch();
	int64_t now = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();

	std::string fileName = fs::JoinPath(g_pathMiniDump, std::string("crash") + std::to_string(now) + ".dmp");
	HANDLE hFile = CreateFile(fileName.c_str(), GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
	std::shared_ptr<void> fileClose{hFile, CloseHandle};
	if (ExceptionInfo) {
		MINIDUMP_EXCEPTION_INFORMATION mei;
		mei.ThreadId = GetCurrentThreadId();
		mei.ClientPointers = TRUE;
		mei.ExceptionPointers = ExceptionInfo;
		MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), hFile, MiniDumpNormal, &mei, NULL, NULL);
	} else {
		MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), hFile, MiniDumpNormal, NULL, NULL, NULL);
	}

	sout.clear();
	sout << "MiniDump file " << fileName.c_str() << std::endl;
	writer(sout.str());
}

LONG WINAPI exceptionHandler(PEXCEPTION_POINTERS pExceptionInfo) {
	const auto writer = backtrace_get_writer();
	std::ostringstream sout;
	sout << "*** Backtrace on: " << std::hex << pExceptionInfo->ExceptionRecord->ExceptionCode << std::dec << " ***" << std::endl;
	writer(sout.str());
	outputDebugInfo(writer, pExceptionInfo);
	return EXCEPTION_CONTINUE_SEARCH;
}

void signalAbortHandler(int /*signal*/) {
	const auto writer = backtrace_get_writer();
	std::ostringstream sout;
	sout << "*** Backtrace on: abort SIGNAL ***" << std::endl;
	writer(sout.str());
	outputDebugInfo(writer, nullptr);
}

void backtrace_init() noexcept {
	std::signal(SIGABRT, signalAbortHandler);
	SetUnhandledExceptionFilter(exceptionHandler);
}

void set_minidump_path(const std::string& p) { g_pathMiniDump = p; }

void backtrace_set_writer(backtrace_writer_t writer) {
	lock_guard lck(g_mutex);
	g_writer = std::move(writer);
}
int backtrace_internal(void**, size_t, void*, std::string_view&) { return 0; }
void backtrace_set_crash_query_reporter(crash_query_reporter_t reporter) {
	lock_guard lck(g_mutex);
	g_crash_query_reporter = std::move(reporter);
}
backtrace_writer_t backtrace_get_writer() {
	lock_guard lck(g_mutex);
	return g_writer;
}
crash_query_reporter_t backtrace_get_crash_query_reporter() {
	lock_guard lck(g_mutex);
	return g_crash_query_reporter;
}
void print_backtrace(std::ostream& sout, void*, int) { cpptrace::generate_trace().print(sout, false); }
void print_crash_query(std::ostream& sout) {
	auto reporter = backtrace_get_crash_query_reporter();
	if (reporter) {
		reporter(sout);
	}
}

}  // namespace debug
}  // namespace reindexer
#else
namespace reindexer {
namespace debug {
static recursive_mutex g_mutex;
static crash_query_reporter_t g_crash_query_reporter = [](std::ostream&) {};
static backtrace_writer_t g_writer = [](std::string_view sv) { std::cerr << sv; };

void backtrace_init() noexcept {}
void set_minidump_path(const std::string&) { assert(false); }
void backtrace_set_writer(backtrace_writer_t) {}
int backtrace_internal(void**, size_t, void*, std::string_view&) { return 0; }
void backtrace_set_crash_query_reporter(crash_query_reporter_t reporter) {
	lock_guard lck(g_mutex);
	g_crash_query_reporter = std::move(reporter);
}
backtrace_writer_t backtrace_get_writer() {
	lock_guard lck(g_mutex);
	return g_writer;
}
crash_query_reporter_t backtrace_get_crash_query_reporter() {
	lock_guard lck(g_mutex);
	return g_crash_query_reporter;
}
void print_backtrace(std::ostream&, void*, int) {}
void print_crash_query(std::ostream& sout) {
	auto reporter = backtrace_get_crash_query_reporter();
	if (reporter) {
		reporter(sout);
	}
}

}  // namespace debug
}  // namespace reindexer
#endif