Print stack trace on exceptions

if libunwind is found.

Useful for debugging logs.
This commit is contained in:
moneromooo-monero 2016-03-28 19:00:18 +01:00
parent ef4ff4252a
commit e409e59d29
No known key found for this signature in database
GPG Key ID: 686F07454D6CEFC3
5 changed files with 188 additions and 2 deletions

View File

@ -243,6 +243,14 @@ endif()
add_definitions("-DBLOCKCHAIN_DB=${BLOCKCHAIN_DB}") add_definitions("-DBLOCKCHAIN_DB=${BLOCKCHAIN_DB}")
find_package(Libunwind)
if(LIBUNWIND_FOUND)
message(STATUS "Using libunwind to provide stack traces")
add_definitions("-DHAVE_LIBUNWIND")
else()
message(STATUS "Stack traces disabled")
endif()
if (UNIX AND NOT APPLE) if (UNIX AND NOT APPLE)
# Note that at the time of this writing the -Wstrict-prototypes flag added below will make this fail # Note that at the time of this writing the -Wstrict-prototypes flag added below will make this fail
set(THREADS_PREFER_PTHREAD_FLAG ON) set(THREADS_PREFER_PTHREAD_FLAG ON)
@ -274,6 +282,10 @@ if (BERKELEY_DB)
include_directories(${BDB_INCLUDE}) include_directories(${BDB_INCLUDE})
endif() endif()
# Final setup for libunwind
include_directories(${LIBUNWIND_INCLUDE})
link_directories(${LIBUNWIND_LIBRARY_DIRS})
if(MSVC) if(MSVC)
add_definitions("/bigobj /MP /W3 /GS- /D_CRT_SECURE_NO_WARNINGS /wd4996 /wd4345 /D_WIN32_WINNT=0x0600 /DWIN32_LEAN_AND_MEAN /DGTEST_HAS_TR1_TUPLE=0 /FIinline_c.h /D__SSE4_1__") add_definitions("/bigobj /MP /W3 /GS- /D_CRT_SECURE_NO_WARNINGS /wd4996 /wd4345 /D_WIN32_WINNT=0x0600 /DWIN32_LEAN_AND_MEAN /DGTEST_HAS_TR1_TUPLE=0 /FIinline_c.h /D__SSE4_1__")
# set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /Dinline=__inline") # set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /Dinline=__inline")
@ -394,6 +406,7 @@ else()
set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} ${RELEASE_FLAGS}") set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} ${RELEASE_FLAGS}")
if(STATIC AND NOT APPLE AND NOT FREEBSD AND NOT OPENBSD) if(STATIC AND NOT APPLE AND NOT FREEBSD AND NOT OPENBSD)
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc -static-libstdc++") set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc -static-libstdc++")
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--wrap=__cxa_throw")
endif() endif()
endif() endif()
@ -431,6 +444,11 @@ elseif(NOT MSVC)
set(EXTRA_LIBRARIES ${RT}) set(EXTRA_LIBRARIES ${RT})
endif() endif()
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
find_library(DL dl)
set(EXTRA_LIBRARIES ${DL})
endif()
include(version.cmake) include(version.cmake)
add_subdirectory(contrib) add_subdirectory(contrib)

View File

@ -31,7 +31,8 @@ set(common_sources
command_line.cpp command_line.cpp
dns_utils.cpp dns_utils.cpp
util.cpp util.cpp
i18n.cpp) i18n.cpp
stack_trace.cpp)
set(common_headers) set(common_headers)
@ -48,7 +49,8 @@ set(common_private_headers
unordered_containers_boost_serialization.h unordered_containers_boost_serialization.h
util.h util.h
varint.h varint.h
i18n.h) i18n.h
stack_trace.h)
bitmonero_private_headers(common bitmonero_private_headers(common
${common_private_headers}) ${common_private_headers})
@ -60,6 +62,7 @@ target_link_libraries(common
LINK_PRIVATE LINK_PRIVATE
crypto crypto
${UNBOUND_LIBRARY} ${UNBOUND_LIBRARY}
${LIBUNWIND_LIBRARIES}
${Boost_DATE_TIME_LIBRARY} ${Boost_DATE_TIME_LIBRARY}
${Boost_FILESYSTEM_LIBRARY} ${Boost_FILESYSTEM_LIBRARY}
${Boost_SYSTEM_LIBRARY} ${Boost_SYSTEM_LIBRARY}

120
src/common/stack_trace.cpp Normal file
View File

@ -0,0 +1,120 @@
// Copyright (c) 2016, The Monero Project
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
// of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be
// used to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#include "common/stack_trace.h"
#include "misc_log_ex.h"
#define UNW_LOCAL_ONLY
#include <libunwind.h>
#include <cxxabi.h>
#include <dlfcn.h>
// from http://stackoverflow.com/questions/11665829/how-can-i-print-stack-trace-for-caught-exceptions-in-c-code-injection-in-c
#ifdef STATICLIB
#define CXA_THROW __wrap___cxa_throw
extern "C" void __real___cxa_throw(void *ex, void *info, void (*dest)(void*));
#else
#define CXA_THROW __cxa_throw
#endif
extern "C" void CXA_THROW(void *ex, void *info, void (*dest)(void*))
{
int status;
char *dsym = abi::__cxa_demangle(((const std::type_info*)info)->name(), NULL, NULL, &status);
tools::log_stack_trace((std::string("Exception: ")+((!status && dsym) ? dsym : (const char*)info)).c_str());
free(dsym);
#ifdef STATICLIB
__real___cxa_throw(ex, info, dest);
#else
static void (*const rethrow)(void*, void*, void(*)(void*)) __attribute__((noreturn)) = (void(*)(void*, void*, void(*)(void*)))dlsym(RTLD_NEXT, "__cxa_throw");
rethrow(ex, info, dest);
#endif
}
namespace
{
std::string stack_trace_log;
}
namespace tools
{
void set_stack_trace_log(const std::string &log)
{
stack_trace_log = log;
}
void log_stack_trace(const char *msg)
{
#ifdef HAVE_LIBUNWIND
unw_context_t ctx;
unw_cursor_t cur;
unw_word_t ip, off;
unsigned level;
char sym[512], *dsym;
int status;
const char *log = stack_trace_log.empty() ? NULL : stack_trace_log.c_str();
if (msg)
LOG_PRINT2(log, msg, LOG_LEVEL_0);
LOG_PRINT2(log, "Unwinded call stack:", LOG_LEVEL_0);
if (unw_getcontext(&ctx) < 0) {
LOG_PRINT2(log, "Failed to create unwind context", LOG_LEVEL_0);
return;
}
if (unw_init_local(&cur, &ctx) < 0) {
LOG_PRINT2(log, "Failed to find the first unwind frame", LOG_LEVEL_0);
return;
}
for (level = 1; level < 999; ++level) { // 999 for safety
int ret = unw_step(&cur);
if (ret < 0) {
LOG_PRINT2(log, "Failed to find the next frame", LOG_LEVEL_0);
return;
}
if (ret == 0)
break;
if (unw_get_reg(&cur, UNW_REG_IP, &ip) < 0) {
LOG_PRINT2(log, " " << std::setw(4) << level, LOG_LEVEL_0);
continue;
}
if (unw_get_proc_name(&cur, sym, sizeof(sym), &off) < 0) {
LOG_PRINT2(log, " " << std::setw(4) << level << std::setbase(16) << std::setw(20) << "0x" << ip, LOG_LEVEL_0);
continue;
}
dsym = abi::__cxa_demangle(sym, NULL, NULL, &status);
LOG_PRINT2(log, " " << std::setw(4) << level << std::setbase(16) << std::setw(20) << "0x" << ip << " " << (!status && dsym ? dsym : sym) << " + " << "0x" << off, LOG_LEVEL_0);
free(dsym);
}
#else
#warning libunwind disabled, no stack traces
#endif
}
} // namespace tools

43
src/common/stack_trace.h Normal file
View File

@ -0,0 +1,43 @@
// Copyright (c) 2016, The Monero Project
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
// of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be
// used to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef MONERO_EXCEPTION_H
#define MONERO_EXCEPTION_H
#include <stdexcept>
#include <string>
namespace tools
{
void set_stack_trace_log(const std::string &log);
void log_stack_trace(const char *msg);
} // namespace tools
#endif

View File

@ -31,6 +31,7 @@
#include "common/command_line.h" #include "common/command_line.h"
#include "common/scoped_message_writer.h" #include "common/scoped_message_writer.h"
#include "common/util.h" #include "common/util.h"
#include "common/stack_trace.h"
#include "cryptonote_core/cryptonote_core.h" #include "cryptonote_core/cryptonote_core.h"
#include "cryptonote_core/miner.h" #include "cryptonote_core/miner.h"
#include "daemon/command_server.h" #include "daemon/command_server.h"
@ -258,6 +259,7 @@ int main(int argc, char const * argv[])
, log_file_path.filename().string().c_str() , log_file_path.filename().string().c_str()
, log_file_path.parent_path().string().c_str() , log_file_path.parent_path().string().c_str()
); );
tools::set_stack_trace_log(log_file_path.filename().string());
} }
_note_c("dbg/main", "Moving from main() into the daemonize now."); _note_c("dbg/main", "Moving from main() into the daemonize now.");