src/signalhandler.cc

   1 // Copyright (c) 2008, Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 //     * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //     * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //     * Neither the name of Google Inc. nor the names of its
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // Author: Satoru Takabayashi
  31 //
  32 // Implementation of InstallFailureSignalHandler().
  33
  34 #include "utilities.h"
  35 #include "stacktrace.h"
  36 #include "symbolize.h"
  37 #include "glog/logging.h"
  38
  39 #include <signal.h>
  40 #include <time.h>
  41 #ifdef HAVE_UCONTEXT_H
  42 # include <ucontext.h>
  43 #endif
  44 #ifdef HAVE_SYS_UCONTEXT_H
  45 # include <sys/ucontext.h>
  46 #endif
  47 #include <algorithm>
  48
  49 _START_GOOGLE_NAMESPACE_
  50
  51 namespace {
  52
  53 // We'll install the failure signal handler for these signals.  We could
  54 // use strsignal() to get signal names, but we don't use it to avoid
  55 // introducing yet another #ifdef complication.
  56 //
  57 // The list should be synced with the comment in signalhandler.h.
  58 const struct {
  59   int number;
  60   const char *name;
  61 } kFailureSignals[] = {
  62   { SIGSEGV, "SIGSEGV" },
  63   { SIGILL, "SIGILL" },
  64   { SIGFPE, "SIGFPE" },
  65   { SIGABRT, "SIGABRT" },
  66   { SIGBUS, "SIGBUS" },
  67   { SIGTERM, "SIGTERM" },
  68 };
  69
  70 // Returns the program counter from signal context, NULL if unknown.
  71 void* GetPC(void* ucontext_in_void) {
  72 #if (defined(HAVE_UCONTEXT_H) || defined(HAVE_SYS_UCONTEXT_H)) && defined(PC_FROM_UCONTEXT)
  73   if (ucontext_in_void != NULL) {
  74     ucontext_t *context = reinterpret_cast<ucontext_t *>(ucontext_in_void);
  75     return (void*)context->PC_FROM_UCONTEXT;
  76   }
  77 #endif
  78   return NULL;
  79 }
  80
  81 // The class is used for formatting error messages.  We don't use printf()
  82 // as it's not async signal safe.
  83 class MinimalFormatter {
  84  public:
  85   MinimalFormatter(char *buffer, int size)
  86       : buffer_(buffer),
  87         cursor_(buffer),
  88         end_(buffer + size) {
  89   }
  90
  91   // Returns the number of bytes written in the buffer.
  92   int num_bytes_written() const { return cursor_ - buffer_; }
  93
  94   // Appends string from "str" and updates the internal cursor.
  95   void AppendString(const char* str) {
  96     int i = 0;
  97     while (str[i] != '\0' && cursor_ + i < end_) {
  98       cursor_[i] = str[i];
  99       ++i;
 100     }
 101     cursor_ += i;
 102   }
 103
 104   // Formats "number" in "radix" and updates the internal cursor.
 105   // Lowercase letters are used for 'a' - 'z'.
 106   void AppendUint64(uint64 number, int radix) {
 107     int i = 0;
 108     while (cursor_ + i < end_) {
 109       const int tmp = number % radix;
 110       number /= radix;
 111       cursor_[i] = (tmp < 10 ? '0' + tmp : 'a' + tmp - 10);
 112       ++i;
 113       if (number == 0) {
 114         break;
 115       }
 116     }
 117     // Reverse the bytes written.
 118     std::reverse(cursor_, cursor_ + i);
 119     cursor_ += i;
 120   }
 121
 122   // Formats "number" as hexadecimal number, and updates the internal
 123   // cursor.  Padding will be added in front if needed.
 124   void AppendHexWithPadding(uint64 number, int width) {
 125     char* start = cursor_;
 126     AppendString("0x");
 127     AppendUint64(number, 16);
 128     // Move to right and add padding in front if needed.
 129     if (cursor_ < start + width) {
 130       const int64 delta = start + width - cursor_;
 131       std::copy(start, cursor_, start + delta);
 132       std::fill(start, start + delta, ' ');
 133       cursor_ = start + width;
 134     }
 135   }
 136
 137  private:
 138   char *buffer_;
 139   char *cursor_;
 140   const char * const end_;
 141 };
 142
 143 // Writes the given data with the size to the standard error.
 144 void WriteToStderr(const char* data, int size) {
 145   write(STDERR_FILENO, data, size);
 146 }
 147
 148 // The writer function can be changed by InstallFailureWriter().
 149 void (*g_failure_writer)(const char* data, int size) = WriteToStderr;
 150
 151 // Dumps time information.  We don't dump human-readable time information
 152 // as localtime() is not guaranteed to be async signal safe.
 153 void DumpTimeInfo() {
 154   time_t time_in_sec = time(NULL);
 155   char buf[256];  // Big enough for time info.
 156   MinimalFormatter formatter(buf, sizeof(buf));
 157   formatter.AppendString("*** Aborted at ");
 158   formatter.AppendUint64(time_in_sec, 10);
 159   formatter.AppendString(" (unix time)");
 160   formatter.AppendString(" try \"date -d @");
 161   formatter.AppendUint64(time_in_sec, 10);
 162   formatter.AppendString("\" if you are using GNU date ***\n");
 163   g_failure_writer(buf, formatter.num_bytes_written());
 164 }
 165
 166 // Dumps information about the signal to STDERR.
 167 void DumpSignalInfo(int signal_number, siginfo_t *siginfo) {
 168   // Get the signal name.
 169   const char* signal_name = NULL;
 170   for (int i = 0; i < ARRAYSIZE(kFailureSignals); ++i) {
 171     if (signal_number == kFailureSignals[i].number) {
 172       signal_name = kFailureSignals[i].name;
 173     }
 174   }
 175
 176   char buf[256];  // Big enough for signal info.
 177   MinimalFormatter formatter(buf, sizeof(buf));
 178
 179   formatter.AppendString("*** ");
 180   if (signal_name) {
 181     formatter.AppendString(signal_name);
 182   } else {
 183     // Use the signal number if the name is unknown.  The signal name
 184     // should be known, but just in case.
 185     formatter.AppendString("Signal ");
 186     formatter.AppendUint64(signal_number, 10);
 187   }
 188   formatter.AppendString(" (@0x");
 189   formatter.AppendUint64(reinterpret_cast<uintptr_t>(siginfo->si_addr), 16);
 190   formatter.AppendString(")");
 191   formatter.AppendString(" received by PID ");
 192   formatter.AppendUint64(getpid(), 10);
 193   formatter.AppendString(" (TID 0x");
 194   // We assume pthread_t is an integral number or a pointer, rather
 195   // than a complex struct.  In some environments, pthread_self()
 196   // returns an uint64 but in some other environments pthread_self()
 197   // returns a pointer.  Hence we use C-style cast here, rather than
 198   // reinterpret/static_cast, to support both types of environments.
 199   formatter.AppendUint64((uintptr_t)pthread_self(), 16);
 200   formatter.AppendString(") ");
 201   // Only linux has the PID of the signal sender in si_pid.
 202 #ifdef OS_LINUX
 203   formatter.AppendString("from PID ");
 204   formatter.AppendUint64(siginfo->si_pid, 10);
 205   formatter.AppendString("; ");
 206 #endif
 207   formatter.AppendString("stack trace: ***\n");
 208   g_failure_writer(buf, formatter.num_bytes_written());
 209 }
 210
 211 // Dumps information about the stack frame to STDERR.
 212 void DumpStackFrameInfo(const char* prefix, void* pc) {
 213   // Get the symbol name.
 214   const char *symbol = "(unknown)";
 215   char symbolized[1024];  // Big enough for a sane symbol.
 216   // Symbolizes the previous address of pc because pc may be in the
 217   // next function.
 218   if (Symbolize(reinterpret_cast<char *>(pc) - 1,
 219                 symbolized, sizeof(symbolized))) {
 220     symbol = symbolized;
 221   }
 222
 223   char buf[1024];  // Big enough for stack frame info.
 224   MinimalFormatter formatter(buf, sizeof(buf));
 225
 226   formatter.AppendString(prefix);
 227   formatter.AppendString("@ ");
 228   const int width = 2 * sizeof(void*) + 2;  // + 2  for "0x".
 229   formatter.AppendHexWithPadding(reinterpret_cast<uintptr_t>(pc), width);
 230   formatter.AppendString(" ");
 231   formatter.AppendString(symbol);
 232   formatter.AppendString("\n");
 233   g_failure_writer(buf, formatter.num_bytes_written());
 234 }
 235
 236 // Invoke the default signal handler.
 237 void InvokeDefaultSignalHandler(int signal_number) {
 238   struct sigaction sig_action;
 239   memset(&sig_action, 0, sizeof(sig_action));
 240   sigemptyset(&sig_action.sa_mask);
 241   sig_action.sa_handler = SIG_DFL;
 242   sigaction(signal_number, &sig_action, NULL);
 243   kill(getpid(), signal_number);
 244 }
 245
 246 // This variable is used for protecting FailureSignalHandler() from
 247 // dumping stuff while another thread is doing it.  Our policy is to let
 248 // the first thread dump stuff and let other threads wait.
 249 // See also comments in FailureSignalHandler().
 250 static pthread_t* g_entered_thread_id_pointer = NULL;
 251
 252 // Dumps signal and stack frame information, and invokes the default
 253 // signal handler once our job is done.
 254 void FailureSignalHandler(int signal_number,
 255                           siginfo_t *signal_info,
 256                           void *ucontext) {
 257   // First check if we've already entered the function.  We use an atomic
 258   // compare and swap operation for platforms that support it.  For other
 259   // platforms, we use a naive method that could lead to a subtle race.
 260
 261   // We assume pthread_self() is async signal safe, though it's not
 262   // officially guaranteed.
 263   pthread_t my_thread_id = pthread_self();
 264   // NOTE: We could simply use pthread_t rather than pthread_t* for this,
 265   // if pthread_self() is guaranteed to return non-zero value for thread
 266   // ids, but there is no such guarantee.  We need to distinguish if the
 267   // old value (value returned from __sync_val_compare_and_swap) is
 268   // different from the original value (in this case NULL).
 269   pthread_t* old_thread_id_pointer =
 270       glog_internal_namespace_::sync_val_compare_and_swap(
 271           &g_entered_thread_id_pointer,
 272           static_cast<pthread_t*>(NULL),
 273           &my_thread_id);
 274   if (old_thread_id_pointer != NULL) {
 275     // We've already entered the signal handler.  What should we do?
 276     if (pthread_equal(my_thread_id, *g_entered_thread_id_pointer)) {
 277       // It looks the current thread is reentering the signal handler.
 278       // Something must be going wrong (maybe we are reentering by another
 279       // type of signal?).  Kill ourself by the default signal handler.
 280       InvokeDefaultSignalHandler(signal_number);
 281     }
 282     // Another thread is dumping stuff.  Let's wait until that thread
 283     // finishes the job and kills the process.
 284     while (true) {
 285       sleep(1);
 286     }
 287   }
 288   // This is the first time we enter the signal handler.  We are going to
 289   // do some interesting stuff from here.
 290   // TODO(satorux): We might want to set timeout here using alarm(), but
 291   // mixing alarm() and sleep() can be a bad idea.
 292
 293   // First dump time info.
 294   DumpTimeInfo();
 295
 296   // Get the program counter from ucontext.
 297   void *pc = GetPC(ucontext);
 298   DumpStackFrameInfo("PC: ", pc);
 299
 300 #ifdef HAVE_STACKTRACE
 301   // Get the stack traces.
 302   void *stack[32];
 303   // +1 to exclude this function.
 304   const int depth = GetStackTrace(stack, ARRAYSIZE(stack), 1);
 305   DumpSignalInfo(signal_number, signal_info);
 306   // Dump the stack traces.
 307   for (int i = 0; i < depth; ++i) {
 308     DumpStackFrameInfo("    ", stack[i]);
 309   }
 310 #endif
 311
 312   // *** TRANSITION ***
 313   //
 314   // BEFORE this point, all code must be async-termination-safe!
 315   // (See WARNING above.)
 316   //
 317   // AFTER this point, we do unsafe things, like using LOG()!
 318   // The process could be terminated or hung at any time.  We try to
 319   // do more useful things first and riskier things later.
 320
 321   // Flush the logs before we do anything in case 'anything'
 322   // causes problems.
 323   FlushLogFilesUnsafe(0);
 324
 325   // Kill ourself by the default signal handler.
 326   InvokeDefaultSignalHandler(signal_number);
 327 }
 328
 329 }  // namespace
 330
 331 void InstallFailureSignalHandler() {
 332   // Build the sigaction struct.
 333   struct sigaction sig_action;
 334   memset(&sig_action, 0, sizeof(sig_action));
 335   sigemptyset(&sig_action.sa_mask);
 336   sig_action.sa_flags |= SA_SIGINFO;
 337   sig_action.sa_sigaction = &FailureSignalHandler;
 338
 339   for (int i = 0; i < ARRAYSIZE(kFailureSignals); ++i) {
 340     CHECK_ERR(sigaction(kFailureSignals[i].number, &sig_action, NULL));
 341   }
 342 }
 343
 344 void InstallFailureWriter(void (*writer)(const char* data, int size)) {
 345   g_failure_writer = writer;
 346 }
 347
 348 _END_GOOGLE_NAMESPACE_