1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
|
#include <c10/util/Backtrace.h>
#include <c10/util/signal_handler.h>
#if defined(C10_SUPPORTS_SIGNAL_HANDLER)
// Normal signal handler implementation.
#include <cxxabi.h>
#include <dirent.h>
#include <dlfcn.h>
#include <fmt/format.h>
#include <sys/syscall.h>
#include <sys/types.h>
#include <unistd.h>
#include <unwind.h>
#include <cstdio>
#include <cstdlib>
#include <iostream>
#include <unordered_set>
#ifdef C10_ANDROID
#ifndef SYS_gettid
#define SYS_gettid __NR_gettid
#endif
#ifndef SYS_tgkill
#define SYS_tgkill __NR_tgkill
#endif
#endif
namespace {
struct sigaction previousSighup;
struct sigaction previousSigint;
std::atomic<int> sigintCount(0);
std::atomic<int> sighupCount(0);
std::atomic<int> hookedUpCount(0);
void handleSignal(int signal) {
switch (signal) {
// TODO: what if the previous handler uses sa_sigaction?
case SIGHUP:
sighupCount += 1;
if (previousSighup.sa_handler) {
previousSighup.sa_handler(signal);
}
break;
case SIGINT:
sigintCount += 1;
if (previousSigint.sa_handler) {
previousSigint.sa_handler(signal);
}
break;
}
}
void hookupHandler() {
if (hookedUpCount++) {
return;
}
struct sigaction sa;
// Setup the handler
sa.sa_handler = &handleSignal;
// Restart the system call, if at all possible
sa.sa_flags = SA_RESTART;
// Block every signal during the handler
sigfillset(&sa.sa_mask);
// Intercept SIGHUP and SIGINT
if (sigaction(SIGHUP, &sa, &previousSighup) == -1) {
LOG(FATAL) << "Cannot install SIGHUP handler.";
}
if (sigaction(SIGINT, &sa, &previousSigint) == -1) {
LOG(FATAL) << "Cannot install SIGINT handler.";
}
}
// Set the signal handlers to the default.
void unhookHandler() {
if (--hookedUpCount > 0) {
return;
}
struct sigaction sa;
// Setup the sighub handler
sa.sa_handler = SIG_DFL;
// Restart the system call, if at all possible
sa.sa_flags = SA_RESTART;
// Block every signal during the handler
sigfillset(&sa.sa_mask);
// Intercept SIGHUP and SIGINT
if (sigaction(SIGHUP, &previousSighup, nullptr) == -1) {
LOG(FATAL) << "Cannot uninstall SIGHUP handler.";
}
if (sigaction(SIGINT, &previousSigint, nullptr) == -1) {
LOG(FATAL) << "Cannot uninstall SIGINT handler.";
}
}
} // namespace
namespace c10 {
#if defined(C10_SUPPORTS_FATAL_SIGNAL_HANDLERS)
FatalSignalHandler& FatalSignalHandler::getInstance() {
// Leaky singleton to avoid module destructor race.
static FatalSignalHandler* handler = new FatalSignalHandler();
return *handler;
}
FatalSignalHandler::~FatalSignalHandler() {}
FatalSignalHandler::FatalSignalHandler()
: fatalSignalHandlersInstalled(false),
fatalSignalReceived(false),
fatalSignalName("<UNKNOWN>"),
writingCond(PTHREAD_COND_INITIALIZER),
writingMutex(PTHREAD_MUTEX_INITIALIZER) {}
FatalSignalHandler::signal_handler FatalSignalHandler::kSignalHandlers[] = {
{"SIGABRT", SIGABRT, {}},
{"SIGINT", SIGINT, {}},
{"SIGILL", SIGILL, {}},
{"SIGFPE", SIGFPE, {}},
{"SIGBUS", SIGBUS, {}},
{"SIGSEGV", SIGSEGV, {}},
{nullptr, 0, {}}};
struct sigaction* FatalSignalHandler::getPreviousSigaction(int signum) {
for (auto handler = kSignalHandlers; handler->name != nullptr; handler++) {
if (handler->signum == signum) {
return &handler->previous;
}
}
return nullptr;
}
const char* FatalSignalHandler::getSignalName(int signum) {
for (auto handler = kSignalHandlers; handler->name != nullptr; handler++) {
if (handler->signum == signum) {
return handler->name;
}
}
return nullptr;
}
void FatalSignalHandler::callPreviousSignalHandler(
struct sigaction* action,
int signum,
siginfo_t* info,
void* ctx) {
if (!action->sa_handler) {
return;
}
if ((action->sa_flags & SA_SIGINFO) == SA_SIGINFO) {
action->sa_sigaction(signum, info, ctx);
} else {
action->sa_handler(signum);
}
}
// needsLock signals whether we need to lock our writing mutex.
void FatalSignalHandler::stacktraceSignalHandler(bool needsLock) {
if (needsLock) {
pthread_mutex_lock(&writingMutex);
}
pid_t tid = syscall(SYS_gettid);
std::string backtrace = fmt::format(
"{}({}), PID: {}, Thread {}: \n {}",
fatalSignalName,
fatalSignum,
::getpid(),
tid,
c10::get_backtrace());
std::cerr << backtrace << std::endl;
if (needsLock) {
pthread_mutex_unlock(&writingMutex);
pthread_cond_signal(&writingCond);
}
}
void FatalSignalHandler::fatalSignalHandlerPostProcess() {}
void FatalSignalHandler::fatalSignalHandlerStatic(int signum) {
getInstance().fatalSignalHandler(signum);
}
// Our fatal signal entry point
void FatalSignalHandler::fatalSignalHandler(int signum) {
// Check if this is a proper signal that we declared above.
const char* name = getSignalName(signum);
if (!name) {
return;
}
if (fatalSignalReceived) {
return;
}
// Set the flag so that our SIGUSR2 handler knows that we're aborting and
// that it should intercept any SIGUSR2 signal.
fatalSignalReceived = true;
// Set state for other threads.
fatalSignum = signum;
fatalSignalName = name;
// Linux doesn't have a nice userland API for enumerating threads so we
// need to use the proc pseudo-filesystem.
DIR* procDir = opendir("/proc/self/task");
if (procDir) {
pid_t pid = getpid();
pid_t currentTid = syscall(SYS_gettid);
struct dirent* entry;
pthread_mutex_lock(&writingMutex);
while ((entry = readdir(procDir)) != nullptr) {
if (entry->d_name[0] == '.') {
continue;
}
pid_t tid = atoi(entry->d_name);
// If we've found the current thread then we'll jump into the SIGUSR2
// handler before calling pthread_cond_wait thus deadlocking, so branch
// our directly to the backtrace handler instead of signaling it.
if (tid != currentTid) {
syscall(SYS_tgkill, pid, tid, SIGUSR2);
pthread_cond_wait(&writingCond, &writingMutex);
} else {
stacktraceSignalHandler(false);
}
}
pthread_mutex_unlock(&writingMutex);
} else {
perror("Failed to open /proc/self/task");
}
fatalSignalHandlerPostProcess();
sigaction(signum, getPreviousSigaction(signum), nullptr);
raise(signum);
}
// Our SIGUSR2 entry point
void FatalSignalHandler::stacktraceSignalHandlerStatic(
int signum,
siginfo_t* info,
void* ctx) {
getInstance().stacktraceSignalHandler(signum, info, ctx);
}
void FatalSignalHandler::stacktraceSignalHandler(
int signum,
siginfo_t* info,
void* ctx) {
if (fatalSignalReceived) {
stacktraceSignalHandler(true);
} else {
// We don't want to actually change the signal handler as we want to
// remain the signal handler so that we may get the usr2 signal later.
callPreviousSignalHandler(&previousSigusr2, signum, info, ctx);
}
}
// Installs SIGABRT signal handler so that we get stack traces
// from every thread on SIGABRT caused exit. Also installs SIGUSR2 handler
// so that threads can communicate with each other (be sure if you use SIGUSR2)
// to install your handler before initing caffe2 (we properly fall back to
// the previous handler if we didn't initiate the SIGUSR2).
void FatalSignalHandler::installFatalSignalHandlers() {
std::lock_guard<std::mutex> locker(fatalSignalHandlersInstallationMutex);
if (fatalSignalHandlersInstalled) {
return;
}
fatalSignalHandlersInstalled = true;
struct sigaction sa;
sigemptyset(&sa.sa_mask);
// Since we'll be in an exiting situation it's possible there's memory
// corruption, so make our own stack just in case.
sa.sa_flags = SA_ONSTACK | SA_SIGINFO;
sa.sa_handler = FatalSignalHandler::fatalSignalHandlerStatic;
for (auto* handler = kSignalHandlers; handler->name != nullptr; handler++) {
if (sigaction(handler->signum, &sa, &handler->previous)) {
std::string str("Failed to add ");
str += handler->name;
str += " handler!";
perror(str.c_str());
}
}
sa.sa_sigaction = FatalSignalHandler::stacktraceSignalHandlerStatic;
if (sigaction(SIGUSR2, &sa, &previousSigusr2)) {
perror("Failed to add SIGUSR2 handler!");
}
}
void FatalSignalHandler::uninstallFatalSignalHandlers() {
std::lock_guard<std::mutex> locker(fatalSignalHandlersInstallationMutex);
if (!fatalSignalHandlersInstalled) {
return;
}
fatalSignalHandlersInstalled = false;
for (auto* handler = kSignalHandlers; handler->name != nullptr; handler++) {
if (sigaction(handler->signum, &handler->previous, nullptr)) {
std::string str("Failed to remove ");
str += handler->name;
str += " handler!";
perror(str.c_str());
} else {
handler->previous = {};
}
}
if (sigaction(SIGUSR2, &previousSigusr2, nullptr)) {
perror("Failed to add SIGUSR2 handler!");
} else {
previousSigusr2 = {};
}
}
#endif // defined(C10_SUPPORTS_FATAL_SIGNAL_HANDLERS)
SignalHandler::SignalHandler(
SignalHandler::Action SIGINT_action,
SignalHandler::Action SIGHUP_action)
: SIGINT_action_(SIGINT_action),
SIGHUP_action_(SIGHUP_action),
my_sigint_count_(sigintCount),
my_sighup_count_(sighupCount) {
hookupHandler();
}
SignalHandler::~SignalHandler() {
unhookHandler();
}
// Return true iff a SIGINT has been received since the last time this
// function was called.
bool SignalHandler::GotSIGINT() {
uint64_t count = sigintCount;
bool result = (count != my_sigint_count_);
my_sigint_count_ = count;
return result;
}
// Return true iff a SIGHUP has been received since the last time this
// function was called.
bool SignalHandler::GotSIGHUP() {
uint64_t count = sighupCount;
bool result = (count != my_sighup_count_);
my_sighup_count_ = count;
return result;
}
SignalHandler::Action SignalHandler::CheckForSignals() {
if (GotSIGHUP()) {
return SIGHUP_action_;
}
if (GotSIGINT()) {
return SIGINT_action_;
}
return SignalHandler::Action::NONE;
}
#if defined(C10_SUPPORTS_FATAL_SIGNAL_HANDLERS)
void FatalSignalHandler::setPrintStackTracesOnFatalSignal(bool print) {
if (print) {
installFatalSignalHandlers();
} else {
uninstallFatalSignalHandlers();
}
}
bool FatalSignalHandler::printStackTracesOnFatalSignal() {
std::lock_guard<std::mutex> locker(fatalSignalHandlersInstallationMutex);
return fatalSignalHandlersInstalled;
}
#endif // defined(C10_SUPPORTS_FATAL_SIGNAL_HANDLERS)
} // namespace c10
#else // defined(C10_SUPPORTS_SIGNAL_HANDLER)
// TODO: Currently we do not support signal handling in non-Linux yet - below is
// a minimal implementation that makes things compile.
namespace c10 {
SignalHandler::SignalHandler(
SignalHandler::Action SIGINT_action,
SignalHandler::Action SIGHUP_action) {
SIGINT_action_ = SIGINT_action;
SIGHUP_action_ = SIGHUP_action;
my_sigint_count_ = 0;
my_sighup_count_ = 0;
}
SignalHandler::~SignalHandler() {}
bool SignalHandler::GotSIGINT() {
return false;
}
bool SignalHandler::GotSIGHUP() {
return false;
}
SignalHandler::Action SignalHandler::CheckForSignals() {
return SignalHandler::Action::NONE;
}
} // namespace c10
#endif // defined(C10_SUPPORTS_SIGNAL_HANDLER)
|