src/utilities.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: Shinichiro Hamaji
  31
  32 #include "utilities.h"
  33
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36
  37 #include <signal.h>
  38 #ifdef HAVE_SYS_TIME_H
  39 # include <sys/time.h>
  40 #endif
  41 #include <time.h>
  42 #if defined(HAVE_SYSCALL_H)
  43 #include <syscall.h>                 // for syscall()
  44 #elif defined(HAVE_SYS_SYSCALL_H)
  45 #include <sys/syscall.h>                 // for syscall()
  46 #endif
  47 #ifdef HAVE_SYSLOG_H
  48 # include <syslog.h>
  49 #endif
  50
  51 #include "base/googleinit.h"
  52
  53 using std::string;
  54
  55 _START_GOOGLE_NAMESPACE_
  56
  57 static const char* g_program_invocation_short_name = NULL;
  58 static pthread_t g_main_thread_id;
  59
  60 _END_GOOGLE_NAMESPACE_
  61
  62 // The following APIs are all internal.
  63 #ifdef HAVE_STACKTRACE
  64
  65 #include "stacktrace.h"
  66 #include "symbolize.h"
  67 #include "base/commandlineflags.h"
  68
  69 GLOG_DEFINE_bool(symbolize_stacktrace, true,
  70                  "Symbolize the stack trace in the tombstone");
  71
  72 _START_GOOGLE_NAMESPACE_
  73
  74 typedef void DebugWriter(const char*, void*);
  75
  76 // The %p field width for printf() functions is two characters per byte.
  77 // For some environments, add two extra bytes for the leading "0x".
  78 static const int kPrintfPointerFieldWidth = 2 + 2 * sizeof(void*);
  79
  80 static void DebugWriteToStderr(const char* data, void *) {
  81   // This one is signal-safe.
  82   if (write(STDERR_FILENO, data, strlen(data)) < 0) {
  83     // Ignore errors.
  84   }
  85 }
  86
  87 void DebugWriteToString(const char* data, void *arg) {
  88   reinterpret_cast<string*>(arg)->append(data);
  89 }
  90
  91 #ifdef HAVE_SYMBOLIZE
  92 // Print a program counter and its symbol name.
  93 static void DumpPCAndSymbol(DebugWriter *writerfn, void *arg, void *pc,
  94                             const char * const prefix) {
  95   char tmp[1024];
  96   const char *symbol = "(unknown)";
  97   // Symbolizes the previous address of pc because pc may be in the
  98   // next function.  The overrun happens when the function ends with
  99   // a call to a function annotated noreturn (e.g. CHECK).
 100   if (Symbolize(reinterpret_cast<char *>(pc) - 1, tmp, sizeof(tmp))) {
 101       symbol = tmp;
 102   }
 103   char buf[1024];
 104   snprintf(buf, sizeof(buf), "%s@ %*p  %s\n",
 105            prefix, kPrintfPointerFieldWidth, pc, symbol);
 106   writerfn(buf, arg);
 107 }
 108 #endif
 109
 110 static void DumpPC(DebugWriter *writerfn, void *arg, void *pc,
 111                    const char * const prefix) {
 112   char buf[100];
 113   snprintf(buf, sizeof(buf), "%s@ %*p\n",
 114            prefix, kPrintfPointerFieldWidth, pc);
 115   writerfn(buf, arg);
 116 }
 117
 118 // Dump current stack trace as directed by writerfn
 119 static void DumpStackTrace(int skip_count, DebugWriter *writerfn, void *arg) {
 120   // Print stack trace
 121   void* stack[32];
 122   int depth = GetStackTrace(stack, ARRAYSIZE(stack), skip_count+1);
 123   for (int i = 0; i < depth; i++) {
 124 #if defined(HAVE_SYMBOLIZE)
 125     if (FLAGS_symbolize_stacktrace) {
 126       DumpPCAndSymbol(writerfn, arg, stack[i], "    ");
 127     } else {
 128       DumpPC(writerfn, arg, stack[i], "    ");
 129     }
 130 #else
 131     DumpPC(writerfn, arg, stack[i], "    ");
 132 #endif
 133   }
 134 }
 135
 136 static void DumpStackTraceAndExit() {
 137   DumpStackTrace(1, DebugWriteToStderr, NULL);
 138
 139   // TOOD(hamaji): Use signal instead of sigaction?
 140 #ifdef HAVE_SIGACTION
 141   // Set the default signal handler for SIGABRT, to avoid invoking our
 142   // own signal handler installed by InstallFailedSignalHandler().
 143   struct sigaction sig_action;
 144   memset(&sig_action, 0, sizeof(sig_action));
 145   sigemptyset(&sig_action.sa_mask);
 146   sig_action.sa_handler = SIG_DFL;
 147   sigaction(SIGABRT, &sig_action, NULL);
 148 #endif  // HAVE_SIGACTION
 149
 150   abort();
 151 }
 152
 153 _END_GOOGLE_NAMESPACE_
 154
 155 #endif  // HAVE_STACKTRACE
 156
 157 _START_GOOGLE_NAMESPACE_
 158
 159 namespace glog_internal_namespace_ {
 160
 161 const char* ProgramInvocationShortName() {
 162   if (g_program_invocation_short_name != NULL) {
 163     return g_program_invocation_short_name;
 164   } else {
 165     // TODO(hamaji): Use /proc/self/cmdline and so?
 166     return "UNKNOWN";
 167   }
 168 }
 169
 170 bool IsGoogleLoggingInitialized() {
 171   return g_program_invocation_short_name != NULL;
 172 }
 173
 174 bool is_default_thread() {
 175   if (g_program_invocation_short_name == NULL) {
 176     // InitGoogleLogging() not yet called, so unlikely to be in a different
 177     // thread
 178     return true;
 179   } else {
 180     return pthread_equal(pthread_self(), g_main_thread_id);
 181   }
 182 }
 183
 184 #ifdef OS_WINDOWS
 185 struct timeval {
 186   long tv_sec, tv_usec;
 187 };
 188
 189 // Based on: http://www.google.com/codesearch/p?hl=en#dR3YEbitojA/os_win32.c&q=GetSystemTimeAsFileTime%20license:bsd
 190 // See COPYING for copyright information.
 191 static int gettimeofday(struct timeval *tv, void* tz) {
 192 #define EPOCHFILETIME (116444736000000000ULL)
 193   FILETIME ft;
 194   LARGE_INTEGER li;
 195   uint64 tt;
 196
 197   GetSystemTimeAsFileTime(&ft);
 198   li.LowPart = ft.dwLowDateTime;
 199   li.HighPart = ft.dwHighDateTime;
 200   tt = (li.QuadPart - EPOCHFILETIME) / 10;
 201   tv->tv_sec = tt / 1000000;
 202   tv->tv_usec = tt % 1000000;
 203
 204   return 0;
 205 }
 206 #endif
 207
 208 int64 CycleClock_Now() {
 209   // TODO(hamaji): temporary impementation - it might be too slow.
 210   struct timeval tv;
 211   gettimeofday(&tv, NULL);
 212   return static_cast<int64>(tv.tv_sec) * 1000000 + tv.tv_usec;
 213 }
 214
 215 int64 UsecToCycles(int64 usec) {
 216   return usec;
 217 }
 218
 219 WallTime WallTime_Now() {
 220   // Now, cycle clock is retuning microseconds since the epoch.
 221   return CycleClock_Now() * 0.000001;
 222 }
 223
 224 static int32 g_main_thread_pid = getpid();
 225 int32 GetMainThreadPid() {
 226   return g_main_thread_pid;
 227 }
 228
 229 bool PidHasChanged() {
 230   int32 pid = getpid();
 231   if (g_main_thread_pid == pid) {
 232     return false;
 233   }
 234   g_main_thread_pid = pid;
 235   return true;
 236 }
 237
 238 pid_t GetTID() {
 239   // On Linux and MacOSX, we try to use gettid().
 240 #if defined OS_LINUX || defined OS_MACOSX
 241 #ifndef __NR_gettid
 242 #ifdef OS_MACOSX
 243 #define __NR_gettid SYS_gettid
 244 #elif ! defined __i386__
 245 #error "Must define __NR_gettid for non-x86 platforms"
 246 #else
 247 #define __NR_gettid 224
 248 #endif
 249 #endif
 250   static bool lacks_gettid = false;
 251   if (!lacks_gettid) {
 252     pid_t tid = syscall(__NR_gettid);
 253     if (tid != -1) {
 254       return tid;
 255     }
 256     // Technically, this variable has to be volatile, but there is a small
 257     // performance penalty in accessing volatile variables and there should
 258     // not be any serious adverse effect if a thread does not immediately see
 259     // the value change to "true".
 260     lacks_gettid = true;
 261   }
 262 #endif  // OS_LINUX || OS_MACOSX
 263
 264   // If gettid() could not be used, we use one of the following.
 265 #if defined OS_LINUX
 266   return getpid();  // Linux:  getpid returns thread ID when gettid is absent
 267 #elif defined OS_WINDOWS || defined OS_CYGWIN
 268   return GetCurrentThreadId();
 269 #else
 270   // If none of the techniques above worked, we use pthread_self().
 271   return (pid_t)(uintptr_t)pthread_self();
 272 #endif
 273 }
 274
 275 const char* const_basename(const char* filepath) {
 276   const char* base = strrchr(filepath, '/');
 277 #ifdef OS_WINDOWS  // Look for either path separator in Windows
 278   if (!base)
 279     base = strrchr(filepath, '\\');
 280 #endif
 281   return base ? (base+1) : filepath;
 282 }
 283
 284 static string g_my_user_name;
 285 const string& MyUserName() {
 286   return g_my_user_name;
 287 }
 288 static void MyUserNameInitializer() {
 289   // TODO(hamaji): Probably this is not portable.
 290 #if defined(OS_WINDOWS)
 291   const char* user = getenv("USERNAME");
 292 #else
 293   const char* user = getenv("USER");
 294 #endif
 295   if (user != NULL) {
 296     g_my_user_name = user;
 297   } else {
 298     g_my_user_name = "invalid-user";
 299   }
 300 }
 301 REGISTER_MODULE_INITIALIZER(utilities, MyUserNameInitializer());
 302
 303 #ifdef HAVE_STACKTRACE
 304 void DumpStackTraceToString(string* stacktrace) {
 305   DumpStackTrace(1, DebugWriteToString, stacktrace);
 306 }
 307 #endif
 308
 309 // We use an atomic operation to prevent problems with calling CrashReason
 310 // from inside the Mutex implementation (potentially through RAW_CHECK).
 311 static const CrashReason* g_reason = 0;
 312
 313 void SetCrashReason(const CrashReason* r) {
 314   sync_val_compare_and_swap(&g_reason,
 315                             reinterpret_cast<const CrashReason*>(0),
 316                             r);
 317 }
 318
 319 void InitGoogleLoggingUtilities(const char* argv0) {
 320   CHECK(!IsGoogleLoggingInitialized())
 321       << "You called InitGoogleLogging() twice!";
 322   const char* slash = strrchr(argv0, '/');
 323 #ifdef OS_WINDOWS
 324   if (!slash)  slash = strrchr(argv0, '\\');
 325 #endif
 326   g_program_invocation_short_name = slash ? slash + 1 : argv0;
 327   g_main_thread_id = pthread_self();
 328
 329 #ifdef HAVE_STACKTRACE
 330   InstallFailureFunction(&DumpStackTraceAndExit);
 331 #endif
 332 }
 333
 334 void ShutdownGoogleLoggingUtilities() {
 335   CHECK(IsGoogleLoggingInitialized())
 336       << "You called ShutdownGoogleLogging() without calling InitGoogleLogging() first!";
 337   g_program_invocation_short_name = NULL;
 338 #ifdef HAVE_SYSLOG_H
 339   closelog();
 340 #endif
 341 }
 342
 343 }  // namespace glog_internal_namespace_
 344
 345 _END_GOOGLE_NAMESPACE_
 346
 347 // Make an implementation of stacktrace compiled.
 348 #ifdef STACKTRACE_H
 349 # include STACKTRACE_H
 350 #endif