folly/experimental/symbolizer/SignalHandler.cpp

   1 /*
   2  * Copyright 2013 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 // This is heavily inspired by the signal handler from google-glog
  18
  19 #include "folly/experimental/symbolizer/SignalHandler.h"
  20
  21 #include <sys/types.h>
  22 #include <atomic>
  23 #include <ctime>
  24 #include <mutex>
  25 #include <pthread.h>
  26 #include <signal.h>
  27 #include <unistd.h>
  28 #include <vector>
  29
  30 #include <glog/logging.h>
  31
  32 #include "folly/Conv.h"
  33 #include "folly/FileUtil.h"
  34 #include "folly/Portability.h"
  35 #include "folly/ScopeGuard.h"
  36 #include "folly/experimental/symbolizer/Symbolizer.h"
  37
  38 namespace folly { namespace symbolizer {
  39
  40 namespace {
  41
  42 /**
  43  * Fatal signal handler registry.
  44  */
  45 class FatalSignalCallbackRegistry {
  46  public:
  47   FatalSignalCallbackRegistry();
  48
  49   void add(SignalCallback func);
  50   void markInstalled();
  51   void run();
  52
  53  private:
  54   std::atomic<bool> installed_;
  55   std::mutex mutex_;
  56   std::vector<SignalCallback> handlers_;
  57 };
  58
  59 FatalSignalCallbackRegistry::FatalSignalCallbackRegistry()
  60   : installed_(false) {
  61 }
  62
  63 void FatalSignalCallbackRegistry::add(SignalCallback func) {
  64   std::lock_guard<std::mutex> lock(mutex_);
  65   CHECK(!installed_)
  66     << "FatalSignalCallbackRegistry::add may not be used "
  67        "after installing the signal handlers.";
  68   handlers_.push_back(func);
  69 }
  70
  71 void FatalSignalCallbackRegistry::markInstalled() {
  72   std::lock_guard<std::mutex> lock(mutex_);
  73   CHECK(!installed_.exchange(true))
  74     << "FatalSignalCallbackRegistry::markInstalled must be called "
  75     << "at most once";
  76 }
  77
  78 void FatalSignalCallbackRegistry::run() {
  79   if (!installed_) {
  80     return;
  81   }
  82
  83   for (auto& fn : handlers_) {
  84     fn();
  85   }
  86 }
  87
  88 // Leak it so we don't have to worry about destruction order
  89 FatalSignalCallbackRegistry* gFatalSignalCallbackRegistry =
  90   new FatalSignalCallbackRegistry;
  91
  92 struct {
  93   int number;
  94   const char* name;
  95   struct sigaction oldAction;
  96 } kFatalSignals[] = {
  97   { SIGSEGV, "SIGSEGV" },
  98   { SIGILL,  "SIGILL"  },
  99   { SIGFPE,  "SIGFPE"  },
 100   { SIGABRT, "SIGABRT" },
 101   { SIGBUS,  "SIGBUS"  },
 102   { SIGTERM, "SIGTERM" },
 103   { 0,       nullptr   }
 104 };
 105
 106 void callPreviousSignalHandler(int signum) {
 107   // Restore disposition to old disposition, then kill ourselves with the same
 108   // signal. The signal will be blocked until we return from our handler,
 109   // then it will invoke the default handler and abort.
 110   for (auto p = kFatalSignals; p->name; ++p) {
 111     if (p->number == signum) {
 112       sigaction(signum, &p->oldAction, nullptr);
 113       return;
 114     }
 115   }
 116
 117   // Not one of the signals we know about. Oh well. Reset to default.
 118   struct sigaction sa;
 119   memset(&sa, 0, sizeof(sa));
 120   sa.sa_handler = SIG_DFL;
 121   sigaction(signum, &sa, nullptr);
 122   raise(signum);
 123 }
 124
 125 void printDec(uint64_t val) {
 126   char buf[20];
 127   uint32_t n = uint64ToBufferUnsafe(val, buf);
 128   writeFull(STDERR_FILENO, buf, n);
 129 }
 130
 131 const char kHexChars[] = "0123456789abcdef";
 132 void printHex(uint64_t val) {
 133   // TODO(tudorb): Add this to folly/Conv.h
 134   char buf[2 + 2 * sizeof(uint64_t)];  // "0x" prefix, 2 digits for each byte
 135
 136   char* end = buf + sizeof(buf);
 137   char* p = end;
 138   do {
 139     *--p = kHexChars[val & 0x0f];
 140     val >>= 4;
 141   } while (val != 0);
 142   *--p = 'x';
 143   *--p = '0';
 144
 145   writeFull(STDERR_FILENO, p, end - p);
 146 }
 147
 148 void print(StringPiece sp) {
 149   writeFull(STDERR_FILENO, sp.data(), sp.size());
 150 }
 151
 152 void dumpTimeInfo() {
 153   SCOPE_EXIT { fsyncNoInt(STDERR_FILENO); };
 154   time_t now = time(nullptr);
 155   print("*** Aborted at ");
 156   printDec(now);
 157   print(" (Unix time, try 'date -d @");
 158   printDec(now);
 159   print("') ***\n");
 160 }
 161
 162 void dumpSignalInfo(int signum, siginfo_t* siginfo) {
 163   SCOPE_EXIT { fsyncNoInt(STDERR_FILENO); };
 164   // Get the signal name, if possible.
 165   const char* name = nullptr;
 166   for (auto p = kFatalSignals; p->name; ++p) {
 167     if (p->number == signum) {
 168       name = p->name;
 169       break;
 170     }
 171   }
 172
 173   print("*** Signal ");
 174   printDec(signum);
 175   if (name) {
 176     print(" (");
 177     print(name);
 178     print(")");
 179   }
 180
 181   print(" (");
 182   printHex(reinterpret_cast<uint64_t>(siginfo->si_addr));
 183   print(") received by PID ");
 184   printDec(getpid());
 185   print(" (TID ");
 186   printHex((uint64_t)pthread_self());
 187   print("), stack trace: ***\n");
 188 }
 189
 190 void dumpStackTrace() {
 191   SCOPE_EXIT { fsyncNoInt(STDERR_FILENO); };
 192   // Get and symbolize stack trace
 193   constexpr size_t kMaxStackTraceDepth = 100;
 194   FrameArray<kMaxStackTraceDepth> addresses;
 195
 196   // Skip the getStackTrace frame
 197   if (!getStackTrace(addresses)) {
 198     print("(error retrieving stack trace)\n");
 199   } else {
 200     Symbolizer symbolizer;
 201     symbolizer.symbolize(addresses);
 202
 203     FDSymbolizePrinter printer(STDERR_FILENO);
 204     printer.println(addresses);
 205   }
 206 }
 207
 208 std::atomic<pthread_t*> gSignalThread;
 209
 210 // Here be dragons.
 211 void innerSignalHandler(int signum, siginfo_t* info, void* uctx) {
 212   // First, let's only let one thread in here at a time.
 213   pthread_t myId = pthread_self();
 214
 215   pthread_t* prevSignalThread = nullptr;
 216   while (!gSignalThread.compare_exchange_strong(prevSignalThread, &myId)) {
 217     if (pthread_equal(*prevSignalThread, myId)) {
 218       print("Entered fatal signal handler recursively. We're in trouble.\n");
 219       return;
 220     }
 221
 222     // Wait a while, try again.
 223     timespec ts;
 224     ts.tv_sec = 0;
 225     ts.tv_nsec = 100L * 1000 * 1000;  // 100ms
 226     nanosleep(&ts, nullptr);
 227
 228     prevSignalThread = nullptr;
 229   }
 230
 231   dumpTimeInfo();
 232   dumpSignalInfo(signum, info);
 233   dumpStackTrace();
 234
 235   // Run user callbacks
 236   gFatalSignalCallbackRegistry->run();
 237 }
 238
 239 void signalHandler(int signum, siginfo_t* info, void* uctx) {
 240   SCOPE_EXIT { fsyncNoInt(STDERR_FILENO); };
 241   innerSignalHandler(signum, info, uctx);
 242
 243   gSignalThread = nullptr;
 244   // Kill ourselves with the previous handler.
 245   callPreviousSignalHandler(signum);
 246 }
 247
 248 }  // namespace
 249
 250 void addFatalSignalCallback(SignalCallback cb) {
 251   gFatalSignalCallbackRegistry->add(cb);
 252 }
 253
 254 void installFatalSignalCallbacks() {
 255   gFatalSignalCallbackRegistry->markInstalled();
 256 }
 257
 258 namespace {
 259
 260 std::atomic<bool> gAlreadyInstalled;
 261
 262 }  // namespace
 263
 264 void installFatalSignalHandler() {
 265   if (gAlreadyInstalled.exchange(true)) {
 266     // Already done.
 267     return;
 268   }
 269
 270   struct sigaction sa;
 271   memset(&sa, 0, sizeof(sa));
 272   sigemptyset(&sa.sa_mask);
 273   sa.sa_flags |= SA_SIGINFO;
 274   sa.sa_sigaction = &signalHandler;
 275
 276   for (auto p = kFatalSignals; p->name; ++p) {
 277     CHECK_ERR(sigaction(p->number, &sa, &p->oldAction));
 278   }
 279 }
 280
 281 }}  // namespaces
 282