exceptions_handler.cpp

Go to the documentation of this file.

 
#include "errors/exceptions_handler.h"
 
#include "filesystem/path.h"
#include "system/stack_trace.h"
#include "time/timestamp.h"
#include "utility/resource.h"
#include "utility/validate_aligned_storage.h"
 
#include <cstring>
#include <exception>
#include <iostream>
 
#if defined(unix) || defined(__unix) || defined(__unix__) || defined(__APPLE__)
#include "string/format.h"
#include "utility/countof.h"
#include <signal.h>
#include <unistd.h>
#elif defined(_WIN32) || defined(_WIN64)
#if defined(_MSC_VER)
#include <intrin.h>
#endif
#include <csignal>
#include <new.h>
#include <windows.h>
#if defined(DBGHELP_SUPPORT)
#include "string/format.h"
#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable:4091) // C4091: 'keyword' : ignored on left of 'type' when no variable is declared
#endif
#include <dbghelp.h>
#if defined(_MSC_VER)
#pragma warning(pop)
#endif
#endif
#endif
 
namespace CppCommon {
 
 
class ExceptionsHandler::Impl
{
public:
    Impl() : _initialized(false), _handler(ExceptionsHandler::Impl::DefaultHandler) {}
 
    static ExceptionsHandler::Impl& GetInstance()
    { return ExceptionsHandler::GetInstance().impl(); }
 
    void SetupHandler(const std::function<void (const SystemException&, const StackTrace&)>& handler)
    {
        assert((handler) && "Exceptions handler function must be valid!");
        if (!handler)
            return;
 
        _handler = handler;
    }
 
    void SetupProcess()
    {
        // Check for double initialization
        if (_initialized)
            return;
 
#if defined(_WIN32) || defined(_WIN64)
        // Install top-level SEH handler
        SetUnhandledExceptionFilter(SehHandler);
 
#if defined(_MSC_VER)
        // Catch pure virtual function calls
        // Because there is one _purecall_handler for the whole process,
        // calling this function immediately impacts all threads. The last
        // caller on any thread sets the handler.
        // http://msdn.microsoft.com/en-us/library/t296ys27.aspx
        _set_purecall_handler(PureCallHandler);
 
        // Catch new operator memory allocation exceptions
        _set_new_handler(NewHandler);
 
        // Catch invalid parameter exceptions
        _set_invalid_parameter_handler(InvalidParameterHandler);
 
        // Set up C++ signal handlers
        _set_abort_behavior(_CALL_REPORTFAULT, _CALL_REPORTFAULT);
#endif
 
        // Catch an abnormal program termination
        signal(SIGABRT, SigabrtHandler);
 
        // Catch an illegal instruction error
        signal(SIGINT, SigintHandler);
 
        // Catch a termination request
        signal(SIGTERM, SigtermHandler);
#elif defined(unix) || defined(__unix) || defined(__unix__) || defined(__APPLE__)
        // Prepare signal action structure
        struct sigaction sa;
        memset(&sa, 0, sizeof(sa));
        sa.sa_sigaction = SignalHandler;
        sa.sa_flags = SA_SIGINFO;
 
        // Define signals to catch
        int signals[] =
        {
            SIGABRT,
            SIGALRM,
            SIGBUS,
            SIGFPE,
            SIGHUP,
            SIGILL,
            SIGINT,
            SIGPIPE,
            SIGPROF,
            SIGQUIT,
            SIGSEGV,
            SIGSYS,
            SIGTERM,
            SIGXCPU,
            SIGXFSZ
        };
 
        // Setup corresponding signals handlers
        for (size_t i = 0; i < countof(signals); ++i)
        {
            int result = sigaction(signals[i], &sa, nullptr);
            if (result != 0)
                throwex SystemException(format("Failed to setup signal handler - {}", signals[i]));
        }
#endif
 
        _initialized = true;
    }
 
    static void SetupThread()
    {
#if defined(_WIN32) || defined(_WIN64)
#if defined(_MSC_VER)
        // Catch std::terminate() calls
        // In a multithreaded environment, terminate functions are maintained
        // separately for each thread. Each new thread needs to install its own
        // terminate function. Thus, each thread is in charge of its own termination handling.
        // http://msdn.microsoft.com/en-us/library/t6fk7h29.aspx
        std::set_terminate(TerminateHandler);
 
#if (__cplusplus < 201703L)
        // Catch std::unexpected() calls
        // In a multithreaded environment, unexpected functions are maintained
        // separately for each thread. Each new thread needs to install its own
        // unexpected function. Thus, each thread is in charge of its own unexpected handling.
        // http://msdn.microsoft.com/en-us/library/h46t5b69.aspx
        std::set_unexpected(UnexpectedHandler);
#endif
#endif
 
        // Catch a floating point exception
        typedef void (*sigh)(int);
        signal(SIGFPE, (sigh)SigfpeHandler);
 
        // Catch an illegal instruction
        signal(SIGILL, SigillHandler);
 
        // Catch an illegal storage access error
        signal(SIGSEGV, SigsegvHandler);
#endif
    }
 
private:
    // Initialization flag for the current process
    bool _initialized;
    // Exception handler function
    std::function<void (const SystemException&, const StackTrace&)> _handler;
 
    // Default exception handler function
    static void DefaultHandler(const SystemException& exception, const StackTrace& trace)
    {
        std::cerr << exception;
        std::cerr << "Stack trace:" << std::endl;
        std::cerr << trace;
    }
 
#if defined(_WIN32) || defined(_WIN64)
 
    // Structured exception handler
    static LONG WINAPI SehHandler(PEXCEPTION_POINTERS pExceptionPtrs)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Unhandled SEH exception"), StackTrace(1));
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
 
        // Unreacheable code
        return EXCEPTION_EXECUTE_HANDLER;
    }
 
#if defined(_MSC_VER)
    // CRT terminate() call handler
    static void __cdecl TerminateHandler()
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Abnormal program termination (terminate() function was called)"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT unexpected() call handler
    static void __cdecl UnexpectedHandler()
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Unexpected error (unexpected() function was called)"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
#endif
 
    // CRT Pure virtual method call handler
    static void __cdecl PureCallHandler()
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Pure virtual function call"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT invalid parameter handler
    static void __cdecl InvalidParameterHandler(const wchar_t* expression, const wchar_t* function, const wchar_t* file, unsigned int line, uintptr_t pReserved)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Invalid parameter exception"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT new operator fault handler
    static int __cdecl NewHandler(size_t)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("'new' operator memory allocation exception"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
 
        // Unreacheable code
        return 0;
    }
 
    // CRT SIGABRT signal handler
    static void SigabrtHandler(int signum)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Caught abort (SIGABRT) signal"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT SIGFPE signal handler
    static void SigfpeHandler(int signum, int subcode)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Caught floating point exception (SIGFPE) signal"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = (PEXCEPTION_POINTERS)_pxcptinfoptrs;
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT sigill signal handler
    static void SigillHandler(int signum)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Caught illegal instruction (SIGILL) signal"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT sigint signal handler
    static void SigintHandler(int signum)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Caught interruption (SIGINT) signal"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT SIGSEGV signal handler
    static void SigsegvHandler(int signum)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Caught invalid storage access (SIGSEGV) signal"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    // CRT SIGTERM signal handler
    static void SigtermHandler(int signum)
    {
        // Output error
        GetInstance()._handler(__LOCATION__ + SystemException("Caught termination request (SIGTERM) signal"), StackTrace(1));
 
        // Retrieve exception information
        EXCEPTION_POINTERS* pExceptionPtrs = nullptr;
        GetExceptionPointers(0, &pExceptionPtrs);
 
        // Write dump file
        CreateDumpFile(pExceptionPtrs);
 
        // Delete exception information
        DeleteExceptionPointers(pExceptionPtrs);
 
        // Terminate process
        TerminateProcess(GetCurrentProcess(), 1);
    }
 
    static void GetExceptionPointers(DWORD dwExceptionCode, EXCEPTION_POINTERS** ppExceptionPointers)
    {
        CONTEXT ContextRecord;
        memset(&ContextRecord, 0, sizeof(CONTEXT));
 
        EXCEPTION_RECORD ExceptionRecord;
        memset(&ExceptionRecord, 0, sizeof(EXCEPTION_RECORD));
 
#if defined(_M_IX86)
        // On x86, we reserve some extra stack which won't be used.  That is to
        // preserve as much of the call frame as possible when the function with
        // the buffer overrun entered __security_check_cookie with a JMP instead
        // of a CALL, after the calling frame has been released in the epilogue
        // of that function.
        volatile ULONG dw[(sizeof(CONTEXT) + sizeof(EXCEPTION_RECORD)) / sizeof(ULONG)];
 
        // Save the state in the context record immediately.  Hopefully, since
        // opts are disabled, this will happen without modifying ECX, which has
        // the local cookie which failed the check.
        __asm
        {
            mov dword ptr [ContextRecord.Eax  ], eax
            mov dword ptr [ContextRecord.Ecx  ], ecx
            mov dword ptr [ContextRecord.Edx  ], edx
            mov dword ptr [ContextRecord.Ebx  ], ebx
            mov dword ptr [ContextRecord.Esi  ], esi
            mov dword ptr [ContextRecord.Edi  ], edi
            mov word ptr  [ContextRecord.SegSs], ss
            mov word ptr  [ContextRecord.SegCs], cs
            mov word ptr  [ContextRecord.SegDs], ds
            mov word ptr  [ContextRecord.SegEs], es
            mov word ptr  [ContextRecord.SegFs], fs
            mov word ptr  [ContextRecord.SegGs], gs
            pushfd
            pop [ContextRecord.EFlags]
 
            // Set the context EBP/EIP/ESP to the values which would be found
            // in the caller to __security_check_cookie.
            mov eax, [ebp]
            mov dword ptr [ContextRecord.Ebp], eax
            mov eax, [ebp + 4]
            mov dword ptr [ContextRecord.Eip], eax
            lea eax, [ebp + 8]
            mov dword ptr [ContextRecord.Esp], eax
 
            // Make sure the dummy stack space looks referenced.
            mov eax, dword ptr dw
        }
 
        ContextRecord.ContextFlags       = CONTEXT_CONTROL;
        ExceptionRecord.ExceptionAddress = (PVOID)(ULONG_PTR)ContextRecord.Eip;
#elif defined(_M_X64)
        ULONG64           ControlPc;
        ULONG64           EstablisherFrame;
        ULONG64           ImageBase;
        PRUNTIME_FUNCTION FunctionEntry;
        PVOID             HandlerData;
 
        RtlCaptureContext(&ContextRecord);
 
        ControlPc     = ContextRecord.Rip;
        FunctionEntry = RtlLookupFunctionEntry(ControlPc, &ImageBase, nullptr);
 
        if (FunctionEntry != nullptr)
            RtlVirtualUnwind(UNW_FLAG_NHANDLER, ImageBase, ControlPc, FunctionEntry, &ContextRecord, &HandlerData, &EstablisherFrame, nullptr);
 
#if defined(__GNUC__)
        void* return_address = __builtin_return_address(0);
        ContextRecord.Rip = (ULONGLONG)return_address;
        ContextRecord.Rsp = (ULONGLONG)__builtin_extract_return_addr(return_address) + 8;
#elif defined(_MSC_VER)
        ContextRecord.Rip = (ULONGLONG)_ReturnAddress();
        ContextRecord.Rsp = (ULONGLONG)_AddressOfReturnAddress() + 8;
#endif
        ExceptionRecord.ExceptionAddress = (PVOID)ContextRecord.Rip;
#else
        #error Unsupported architecture
#endif
        ExceptionRecord.ExceptionCode = dwExceptionCode;
#if defined(__GNUC__)
        ExceptionRecord.ExceptionAddress = __builtin_return_address(0);
#elif defined(_MSC_VER)
        ExceptionRecord.ExceptionAddress = _ReturnAddress();
#endif
 
        CONTEXT* pContextRecord = new CONTEXT;
        memcpy(pContextRecord, &ContextRecord, sizeof(CONTEXT));
 
        EXCEPTION_RECORD* pExceptionRecord = new EXCEPTION_RECORD;
        memcpy(pExceptionRecord, &ExceptionRecord, sizeof(EXCEPTION_RECORD));
 
        *ppExceptionPointers = new EXCEPTION_POINTERS;
        (*ppExceptionPointers)->ContextRecord = pContextRecord;
        (*ppExceptionPointers)->ExceptionRecord = pExceptionRecord;
    }
 
    static void DeleteExceptionPointers(EXCEPTION_POINTERS* pExceptionPointers)
    {
        delete pExceptionPointers->ContextRecord;
        delete pExceptionPointers->ExceptionRecord;
        delete pExceptionPointers;
    }
 
    static void CreateDumpFile(EXCEPTION_POINTERS* pExcPtrs)
    {
#if defined(DBGHELP_SUPPORT)
        // Generate dump file name based on the current timestamp
        Path dump = Path::executable().parent() / format("crash.{}.dmp", Timestamp::utc());
 
        // Create the dump file
        HANDLE hDumpFile = CreateFileW(dump.wstring().c_str(), GENERIC_WRITE, 0, nullptr, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, nullptr);
        if (hDumpFile == INVALID_HANDLE_VALUE)
            throwex FileSystemException("Cannot create a dump file!").Attach(dump);
 
        // Smart resource cleaner pattern
        auto file = resource(hDumpFile, [](HANDLE hObject) { CloseHandle(hObject); });
 
        MINIDUMP_EXCEPTION_INFORMATION mei;
        MINIDUMP_CALLBACK_INFORMATION mci;
 
        // Prepare dump file information
        mei.ThreadId = GetCurrentThreadId();
        mei.ExceptionPointers = pExcPtrs;
        mei.ClientPointers = FALSE;
        mci.CallbackRoutine = nullptr;
        mci.CallbackParam = nullptr;
 
        // Write dump file information
        if (!MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), file.get(), MiniDumpNormal, &mei, nullptr, &mci))
            throwex FileSystemException("Cannot write a dump file!").Attach(dump);
 
        // Release the resource manually
        if (!CloseHandle(hDumpFile))
            throwex FileSystemException("Cannot close a dump file!").Attach(dump);
        file.release();
#endif
    }
 
#elif defined(unix) || defined(__unix) || defined(__unix__) || defined(__APPLE__)
 
    // Signal handler
    static void SignalHandler(int signo, siginfo_t* info, void* context)
    {
        // Output error
        switch (signo)
        {
            case SIGABRT:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught abnormal program termination (SIGABRT) signal"), StackTrace(1));
                break;
            case SIGALRM:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught alarm clock (SIGALRM) signal"), StackTrace(1));
                break;
            case SIGBUS:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught memory access error (SIGBUS) signal"), StackTrace(1));
                break;
            case SIGFPE:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught floating point exception (SIGFPE) signal"), StackTrace(1));
                break;
            case SIGHUP:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught hangup instruction (SIGHUP) signal"), StackTrace(1));
                break;
            case SIGILL:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught illegal instruction (SIGILL) signal"), StackTrace(1));
                break;
            case SIGINT:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught terminal interrupt (SIGINT) signal"), StackTrace(1));
                break;
            case SIGPIPE:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught pipe write error (SIGPIPE) signal"), StackTrace(1));
                break;
            case SIGPROF:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught profiling timer expired error (SIGPROF) signal"), StackTrace(1));
                break;
            case SIGQUIT:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught terminal quit (SIGQUIT) signal"), StackTrace(1));
                break;
            case SIGSEGV:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught illegal storage access error (SIGSEGV) signal"), StackTrace(1));
                break;
            case SIGSYS:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught bad system call (SIGSYS) signal"), StackTrace(1));
                break;
            case SIGTERM:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught termination request (SIGTERM) signal"), StackTrace(1));
                break;
            case SIGXCPU:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught CPU time limit exceeded (SIGXCPU) signal"), StackTrace(1));
                break;
            case SIGXFSZ:
                GetInstance()._handler(__LOCATION__ + SystemException("Caught file size limit exceeded (SIGXFSZ) signal"), StackTrace(1));
                break;
            default:
                GetInstance()._handler(__LOCATION__ + SystemException(format("Caught unknown signal - {}", signo)), StackTrace(1));
                break;
        }
 
        // Prepare signal action structure
        struct sigaction sa;
        memset(&sa, 0, sizeof(sa));
        sa.sa_handler = SIG_DFL;
 
        // Setup the default signal handler and rise it!
        int result = sigaction(signo, &sa, nullptr);
        if (result == 0)
            raise(signo);
        else
            kill(getpid(), SIGKILL);
    }
 
#endif
};
 
 
ExceptionsHandler::ExceptionsHandler()
{
    // Check implementation storage parameters
    [[maybe_unused]] ValidateAlignedStorage<sizeof(Impl), alignof(Impl), StorageSize, StorageAlign> _;
    static_assert((StorageSize >= sizeof(Impl)), "ExceptionsHandler::StorageSize must be increased!");
    static_assert(((StorageAlign % alignof(Impl)) == 0), "ExceptionsHandler::StorageAlign must be adjusted!");
 
    // Create the implementation instance
    new(&_storage)Impl();
}
 
ExceptionsHandler::~ExceptionsHandler()
{
    // Delete the implementation instance
    reinterpret_cast<Impl*>(&_storage)->~Impl();
}
 
void ExceptionsHandler::SetupHandler(const std::function<void (const SystemException&, const StackTrace&)>& handler) { GetInstance().impl().SetupHandler(handler); }
void ExceptionsHandler::SetupProcess() { GetInstance().impl().SetupProcess(); }
void ExceptionsHandler::SetupThread() { GetInstance().impl().SetupThread(); }
 
} // namespace CppCommon