sen::kernel::crash Namespace Reference

Crash reporting, which belongs to the process rather than to any one kernel: a process has one crash reporter however many kernels it builds. More...

Functions
bool	arm (const std::filesystem::path &reportDirectory={})
	Turns on crash reporting for this process: a terminate handler for an uncaught exception, and an out-of-process Crashpad handler for a fault. Both write under reportDirectory, or under the system temporary directory when it is empty.
std::optional< int >	runHandlerIfRequested (int argc, char *argv[])
	Give main() its own arguments here, before anything else, and leave with the value it returns when it returns one. Sen has no separate handler program, so on Windows the handler is this executable run again, and this call is what recognises that and becomes it. On other platforms it never claims the process, so the call costs nothing and the code stays the same.

Detailed Description

Crash reporting, which belongs to the process rather than to any one kernel: a process has one crash reporter however many kernels it builds.

Function Documentation

arm()

bool sen::kernel::crash::arm

(

const std::filesystem::path &

reportDirectory = {}

)

Turns on crash reporting for this process: a terminate handler for an uncaught exception, and an out-of-process Crashpad handler for a fault. Both write under reportDirectory, or under the system temporary directory when it is empty.

Call it while the process is still single threaded. On POSIX the handler is started by forking, and a fork keeps every lock another thread was holding at that moment, which can leave the handler unable to start. Sen warns if it is armed in a process that already runs more than one thread.

Returns true when the handler is running. False means a fault will not be dumped, and the reason has been logged. The terminate handler is still in place either way, so an uncaught exception is still reported.

The handler process outlives this call and stays for the life of the process that armed it. Sen also creates and registers a process-global spdlog logger named "kernel" at trace level when no logger by that name exists, and takes over an existing one of that name.

On Windows, runHandlerIfRequested() must already have been called from main, or no dump is written and Sen warns as it arms.

A second call does not move a running handler: the first directory is kept, and Sen warns.

runHandlerIfRequested()

std::optional< int > sen::kernel::crash::runHandlerIfRequested ( int argc, char * argv[] )

nodiscard

Give main() its own arguments here, before anything else, and leave with the value it returns when it returns one. Sen has no separate handler program, so on Windows the handler is this executable run again, and this call is what recognises that and becomes it. On other platforms it never claims the process, so the call costs nothing and the code stays the same.