LLVM API Documentation
Crash recovery helper object. More...
#include <CrashRecoveryContext.h>
Public Member Functions | |
CrashRecoveryContext () | |
~CrashRecoveryContext () | |
void | registerCleanup (CrashRecoveryContextCleanup *cleanup) |
void | unregisterCleanup (CrashRecoveryContextCleanup *cleanup) |
bool | RunSafely (void(*Fn)(void *), void *UserData) |
Execute the provide callback function (with the given arguments) in a protected context. More... | |
bool | RunSafelyOnThread (void(*Fn)(void *), void *UserData, unsigned RequestedStackSize=0) |
Execute the provide callback function (with the given arguments) in a protected context which is run in another thread (optionally with a requested stack size). More... | |
void | HandleCrash () |
Explicitly trigger a crash recovery in the current process, and return failure from RunSafely(). This function does not return. More... | |
const std::string & | getBacktrace () const |
Return a string containing the backtrace where the crash was detected; or empty if the backtrace wasn't recovered. More... | |
Static Public Member Functions | |
static void | Enable () |
Enable crash recovery. More... | |
static void | Disable () |
Disable crash recovery. More... | |
static CrashRecoveryContext * | GetCurrent () |
Return the active context, if the code is currently executing in a thread which is in a protected context. More... | |
static bool | isRecoveringFromCrash () |
Return true if the current thread is recovering from a crash. More... | |
Crash recovery helper object.
This class implements support for running operations in a safe context so that crashes (memory errors, stack overflow, assertion violations) can be detected and control restored to the crashing thread. Crash detection is purely "best effort", the exact set of failures which can be recovered from is platform dependent.
Clients make use of this code by first calling CrashRecoveryContext::Enable(), and then executing unsafe operations via a CrashRecoveryContext object. For example:
void actual_work(void *);
void foo() { CrashRecoveryContext CRC;
if (!CRC.RunSafely(actual_work, 0)) { ... a crash was detected, report error to user ... }
... no crash was detected ... }
Crash recovery contexts may not be nested.
Definition at line 45 of file CrashRecoveryContext.h.
|
inline |
Definition at line 50 of file CrashRecoveryContext.h.
CrashRecoveryContext::~CrashRecoveryContext | ( | ) |
Definition at line 74 of file CrashRecoveryContext.cpp.
References llvm::CrashRecoveryContextCleanup::cleanupFired, llvm::CrashRecoveryContextCleanup::recoverResources(), and tlIsRecoveringFromCrash.
|
static |
Disable crash recovery.
Definition at line 289 of file CrashRecoveryContext.cpp.
References gCrashRecoveryContextMutex, gCrashRecoveryEnabled, NumSignals, PrevActions, and Signals.
Referenced by CrashRecoverySignalHandler().
|
static |
Enable crash recovery.
Definition at line 270 of file CrashRecoveryContext.cpp.
References CrashRecoverySignalHandler(), gCrashRecoveryContextMutex, gCrashRecoveryEnabled, NumSignals, PrevActions, and Signals.
const std::string & CrashRecoveryContext::getBacktrace | ( | ) | const |
Return a string containing the backtrace where the crash was detected; or empty if the backtrace wasn't recovered.
This function is only valid when a crash has been detected (i.e., RunSafely() has returned false.
Definition at line 326 of file CrashRecoveryContext.cpp.
|
static |
Return the active context, if the code is currently executing in a thread which is in a protected context.
Definition at line 95 of file CrashRecoveryContext.cpp.
References gCrashRecoveryEnabled.
Referenced by llvm::CrashRecoveryContextCleanupBase< CrashRecoveryContextDestructorCleanup< T >, T >::create().
void CrashRecoveryContext::HandleCrash | ( | ) |
Explicitly trigger a crash recovery in the current process, and return failure from RunSafely(). This function does not return.
Definition at line 320 of file CrashRecoveryContext.cpp.
|
static |
Return true if the current thread is recovering from a crash.
Definition at line 91 of file CrashRecoveryContext.cpp.
References tlIsRecoveringFromCrash.
void CrashRecoveryContext::registerCleanup | ( | CrashRecoveryContextCleanup * | cleanup | ) |
Definition at line 106 of file CrashRecoveryContext.cpp.
Referenced by llvm::CrashRecoveryContextCleanupRegistrar< T, Cleanup >::CrashRecoveryContextCleanupRegistrar().
bool CrashRecoveryContext::RunSafely | ( | void(*)(void *) | Fn, |
void * | UserData | ||
) |
Execute the provide callback function (with the given arguments) in a protected context.
Definition at line 304 of file CrashRecoveryContext.cpp.
References gCrashRecoveryEnabled, and llvm::Intrinsic::setjmp.
bool CrashRecoveryContext::RunSafelyOnThread | ( | void(*)(void *) | Fn, |
void * | UserData, | ||
unsigned | RequestedStackSize = 0 |
||
) |
Execute the provide callback function (with the given arguments) in a protected context which is run in another thread (optionally with a requested stack size).
See RunSafely() and llvm_execute_on_thread().
Definition at line 349 of file CrashRecoveryContext.cpp.
References llvm::llvm_execute_on_thread(), and RunSafelyOnThread_Dispatch().
void CrashRecoveryContext::unregisterCleanup | ( | CrashRecoveryContextCleanup * | cleanup | ) |
Definition at line 117 of file CrashRecoveryContext.cpp.
Referenced by llvm::CrashRecoveryContextCleanupRegistrar< T, Cleanup >::unregister().