Move GLog/GFlags to extern/
[blender.git] / extern / glog / 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 static 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   if (IsFailureSignalHandlerInstalled()) {
142     // Set the default signal handler for SIGABRT, to avoid invoking our
143     // own signal handler installed by InstallFailureSignalHandler().
144     struct sigaction sig_action;
145     memset(&sig_action, 0, sizeof(sig_action));
146     sigemptyset(&sig_action.sa_mask);
147     sig_action.sa_handler = SIG_DFL;
148     sigaction(SIGABRT, &sig_action, NULL);
149   }
150 #endif  // HAVE_SIGACTION
151
152   abort();
153 }
154
155 _END_GOOGLE_NAMESPACE_
156
157 #endif  // HAVE_STACKTRACE
158
159 _START_GOOGLE_NAMESPACE_
160
161 namespace glog_internal_namespace_ {
162
163 const char* ProgramInvocationShortName() {
164   if (g_program_invocation_short_name != NULL) {
165     return g_program_invocation_short_name;
166   } else {
167     // TODO(hamaji): Use /proc/self/cmdline and so?
168     return "UNKNOWN";
169   }
170 }
171
172 bool IsGoogleLoggingInitialized() {
173   return g_program_invocation_short_name != NULL;
174 }
175
176 bool is_default_thread() {
177   if (g_program_invocation_short_name == NULL) {
178     // InitGoogleLogging() not yet called, so unlikely to be in a different
179     // thread
180     return true;
181   } else {
182     return pthread_equal(pthread_self(), g_main_thread_id);
183   }
184 }
185
186 #ifdef OS_WINDOWS
187 struct timeval {
188   long tv_sec, tv_usec;
189 };
190
191 // Based on: http://www.google.com/codesearch/p?hl=en#dR3YEbitojA/os_win32.c&q=GetSystemTimeAsFileTime%20license:bsd
192 // See COPYING for copyright information.
193 static int gettimeofday(struct timeval *tv, void* tz) {
194 #define EPOCHFILETIME (116444736000000000ULL)
195   FILETIME ft;
196   LARGE_INTEGER li;
197   uint64 tt;
198
199   GetSystemTimeAsFileTime(&ft);
200   li.LowPart = ft.dwLowDateTime;
201   li.HighPart = ft.dwHighDateTime;
202   tt = (li.QuadPart - EPOCHFILETIME) / 10;
203   tv->tv_sec = tt / 1000000;
204   tv->tv_usec = tt % 1000000;
205
206   return 0;
207 }
208 #endif
209
210 int64 CycleClock_Now() {
211   // TODO(hamaji): temporary impementation - it might be too slow.
212   struct timeval tv;
213   gettimeofday(&tv, NULL);
214   return static_cast<int64>(tv.tv_sec) * 1000000 + tv.tv_usec;
215 }
216
217 int64 UsecToCycles(int64 usec) {
218   return usec;
219 }
220
221 WallTime WallTime_Now() {
222   // Now, cycle clock is retuning microseconds since the epoch.
223   return CycleClock_Now() * 0.000001;
224 }
225
226 static int32 g_main_thread_pid = getpid();
227 int32 GetMainThreadPid() {
228   return g_main_thread_pid;
229 }
230
231 bool PidHasChanged() {
232   int32 pid = getpid();
233   if (g_main_thread_pid == pid) {
234     return false;
235   }
236   g_main_thread_pid = pid;
237   return true;
238 }
239
240 pid_t GetTID() {
241   // On Linux and MacOSX, we try to use gettid().
242 #if defined OS_LINUX || defined OS_MACOSX
243 #ifndef __NR_gettid
244 #ifdef OS_MACOSX
245 #define __NR_gettid SYS_gettid
246 #elif ! defined __i386__
247 #error "Must define __NR_gettid for non-x86 platforms"
248 #else
249 #define __NR_gettid 224
250 #endif
251 #endif
252   static bool lacks_gettid = false;
253   if (!lacks_gettid) {
254     pid_t tid = syscall(__NR_gettid);
255     if (tid != -1) {
256       return tid;
257     }
258     // Technically, this variable has to be volatile, but there is a small
259     // performance penalty in accessing volatile variables and there should
260     // not be any serious adverse effect if a thread does not immediately see
261     // the value change to "true".
262     lacks_gettid = true;
263   }
264 #endif  // OS_LINUX || OS_MACOSX
265
266   // If gettid() could not be used, we use one of the following.
267 #if defined OS_LINUX
268   return getpid();  // Linux:  getpid returns thread ID when gettid is absent
269 #elif defined OS_WINDOWS || defined OS_CYGWIN
270   return GetCurrentThreadId();
271 #else
272   // If none of the techniques above worked, we use pthread_self().
273   return (pid_t)(uintptr_t)pthread_self();
274 #endif
275 }
276
277 const char* const_basename(const char* filepath) {
278   const char* base = strrchr(filepath, '/');
279 #ifdef OS_WINDOWS  // Look for either path separator in Windows
280   if (!base)
281     base = strrchr(filepath, '\\');
282 #endif
283   return base ? (base+1) : filepath;
284 }
285
286 static string g_my_user_name;
287 const string& MyUserName() {
288   return g_my_user_name;
289 }
290 static void MyUserNameInitializer() {
291   // TODO(hamaji): Probably this is not portable.
292 #if defined(OS_WINDOWS)
293   const char* user = getenv("USERNAME");
294 #else
295   const char* user = getenv("USER");
296 #endif
297   if (user != NULL) {
298     g_my_user_name = user;
299   } else {
300     g_my_user_name = "invalid-user";
301   }
302 }
303 REGISTER_MODULE_INITIALIZER(utilities, MyUserNameInitializer());
304
305 #ifdef HAVE_STACKTRACE
306 void DumpStackTraceToString(string* stacktrace) {
307   DumpStackTrace(1, DebugWriteToString, stacktrace);
308 }
309 #endif
310
311 // We use an atomic operation to prevent problems with calling CrashReason
312 // from inside the Mutex implementation (potentially through RAW_CHECK).
313 static const CrashReason* g_reason = 0;
314
315 void SetCrashReason(const CrashReason* r) {
316   sync_val_compare_and_swap(&g_reason,
317                             reinterpret_cast<const CrashReason*>(0),
318                             r);
319 }
320
321 void InitGoogleLoggingUtilities(const char* argv0) {
322   CHECK(!IsGoogleLoggingInitialized())
323       << "You called InitGoogleLogging() twice!";
324   const char* slash = strrchr(argv0, '/');
325 #ifdef OS_WINDOWS
326   if (!slash)  slash = strrchr(argv0, '\\');
327 #endif
328   g_program_invocation_short_name = slash ? slash + 1 : argv0;
329   g_main_thread_id = pthread_self();
330
331 #ifdef HAVE_STACKTRACE
332   InstallFailureFunction(&DumpStackTraceAndExit);
333 #endif
334 }
335
336 void ShutdownGoogleLoggingUtilities() {
337   CHECK(IsGoogleLoggingInitialized())
338       << "You called ShutdownGoogleLogging() without calling InitGoogleLogging() first!";
339   g_program_invocation_short_name = NULL;
340 #ifdef HAVE_SYSLOG_H
341   closelog();
342 #endif
343 }
344
345 }  // namespace glog_internal_namespace_
346
347 _END_GOOGLE_NAMESPACE_
348
349 // Make an implementation of stacktrace compiled.
350 #ifdef STACKTRACE_H
351 # include STACKTRACE_H
352 #endif