mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-11-11 22:50:59 +01:00
init: Signal-safe instant shutdown
Replace the 200ms polling loop with a faster and more efficient waiting operation. This was tried a few times before, but given up every time because solutions use a condition variable which is not safe for use in signals as they need to be reentrant. On UNIX-ish OSes, use a safe way: a pipe. When shutdown is requested write a dummy byte to the pipe. Waiting for shutdown is a matter of a blocking read from the pipe. On Windows, there are no signals so using a condition variable is safe.
This commit is contained in:
@@ -5,19 +5,108 @@
|
||||
|
||||
#include <shutdown.h>
|
||||
|
||||
#include <config/bitcoin-config.h>
|
||||
|
||||
#include <assert.h>
|
||||
#include <atomic>
|
||||
#ifdef WIN32
|
||||
#include <condition_variable>
|
||||
#else
|
||||
#include <errno.h>
|
||||
#include <fcntl.h>
|
||||
#include <unistd.h>
|
||||
#endif
|
||||
|
||||
static std::atomic<bool> fRequestShutdown(false);
|
||||
#ifdef WIN32
|
||||
/** On windows it is possible to simply use a condition variable. */
|
||||
std::mutex g_shutdown_mutex;
|
||||
std::condition_variable g_shutdown_cv;
|
||||
#else
|
||||
/** On UNIX-like operating systems use the self-pipe trick.
|
||||
* Index 0 will be the read end of the pipe, index 1 the write end.
|
||||
*/
|
||||
static int g_shutdown_pipe[2] = {-1, -1};
|
||||
#endif
|
||||
|
||||
bool InitShutdownState()
|
||||
{
|
||||
#ifndef WIN32
|
||||
#if HAVE_O_CLOEXEC
|
||||
// If we can, make sure that the file descriptors are closed on exec()
|
||||
// to prevent interference.
|
||||
if (pipe2(g_shutdown_pipe, O_CLOEXEC) != 0) {
|
||||
return false;
|
||||
}
|
||||
#else
|
||||
if (pipe(g_shutdown_pipe) != 0) {
|
||||
return false;
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
return true;
|
||||
}
|
||||
|
||||
void StartShutdown()
|
||||
{
|
||||
#ifdef WIN32
|
||||
std::unique_lock<std::mutex> lk(g_shutdown_mutex);
|
||||
fRequestShutdown = true;
|
||||
g_shutdown_cv.notify_one();
|
||||
#else
|
||||
// This must be reentrant and safe for calling in a signal handler, so using a condition variable is not safe.
|
||||
// Make sure that the token is only written once even if multiple threads call this concurrently or in
|
||||
// case of a reentrant signal.
|
||||
if (!fRequestShutdown.exchange(true)) {
|
||||
// Write an arbitrary byte to the write end of the shutdown pipe.
|
||||
const char token = 'x';
|
||||
while (true) {
|
||||
int result = write(g_shutdown_pipe[1], &token, 1);
|
||||
if (result < 0) {
|
||||
// Failure. It's possible that the write was interrupted by another signal.
|
||||
// Other errors are unexpected here.
|
||||
assert(errno == EINTR);
|
||||
} else {
|
||||
assert(result == 1);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
void AbortShutdown()
|
||||
{
|
||||
if (fRequestShutdown) {
|
||||
// Cancel existing shutdown by waiting for it, this will reset condition flags and remove
|
||||
// the shutdown token from the pipe.
|
||||
WaitForShutdown();
|
||||
}
|
||||
fRequestShutdown = false;
|
||||
}
|
||||
|
||||
bool ShutdownRequested()
|
||||
{
|
||||
return fRequestShutdown;
|
||||
}
|
||||
|
||||
void WaitForShutdown()
|
||||
{
|
||||
#ifdef WIN32
|
||||
std::unique_lock<std::mutex> lk(g_shutdown_mutex);
|
||||
g_shutdown_cv.wait(lk, [] { return fRequestShutdown.load(); });
|
||||
#else
|
||||
char token;
|
||||
while (true) {
|
||||
int result = read(g_shutdown_pipe[0], &token, 1);
|
||||
if (result < 0) {
|
||||
// Failure. Check if the read was interrupted by a signal.
|
||||
// Other errors are unexpected here.
|
||||
assert(errno == EINTR);
|
||||
} else {
|
||||
assert(result == 1);
|
||||
break;
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user