GLog: Workaround compilation error on Hurd
[blender.git] / extern / glog / src / raw_logging.cc
1 // Copyright (c) 2006, 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: Maxim Lifantsev
31 //
32 // logging_unittest.cc covers the functionality herein
33
34 #include "utilities.h"
35
36 #include <stdarg.h>
37 #include <stdio.h>
38 #include <errno.h>
39 #ifdef HAVE_UNISTD_H
40 # include <unistd.h>               // for close() and write()
41 #endif
42 #include <fcntl.h>                 // for open()
43 #include <time.h>
44 #include "config.h"
45 #include "glog/logging.h"          // To pick up flag settings etc.
46 #include "glog/raw_logging.h"
47 #include "base/commandlineflags.h"
48
49 #ifdef HAVE_STACKTRACE
50 # include "stacktrace.h"
51 #endif
52
53 #if defined(HAVE_SYSCALL_H)
54 #include <syscall.h>                 // for syscall()
55 #elif defined(HAVE_SYS_SYSCALL_H)
56 #include <sys/syscall.h>                 // for syscall()
57 #endif
58 #ifdef HAVE_UNISTD_H
59 # include <unistd.h>
60 #endif
61
62 // Hurd does not have SYS_write.
63 #if (defined(HAVE_SYSCALL_H) || defined(HAVE_SYS_SYSCALL_H)) && !defined(__GNU__)
64 # define safe_write(fd, s, len)  syscall(SYS_write, fd, s, len)
65 #else
66   // Not so safe, but what can you do?
67 # define safe_write(fd, s, len)  write(fd, s, len)
68 #endif
69
70 _START_GOOGLE_NAMESPACE_
71
72 // Data for RawLog__ below. We simply pick up the latest
73 // time data created by a normal log message to avoid calling
74 // localtime_r which can allocate memory.
75 static struct ::tm last_tm_time_for_raw_log;
76 static int last_usecs_for_raw_log;
77
78 void RawLog__SetLastTime(const struct ::tm& t, int usecs) {
79   memcpy(&last_tm_time_for_raw_log, &t, sizeof(last_tm_time_for_raw_log));
80   last_usecs_for_raw_log = usecs;
81 }
82
83 // CAVEAT: vsnprintf called from *DoRawLog below has some (exotic) code paths
84 // that invoke malloc() and getenv() that might acquire some locks.
85 // If this becomes a problem we should reimplement a subset of vsnprintf
86 // that does not need locks and malloc.
87
88 // Helper for RawLog__ below.
89 // *DoRawLog writes to *buf of *size and move them past the written portion.
90 // It returns true iff there was no overflow or error.
91 static bool DoRawLog(char** buf, int* size, const char* format, ...) {
92   va_list ap;
93   va_start(ap, format);
94   int n = vsnprintf(*buf, *size, format, ap);
95   va_end(ap);
96   if (n < 0 || n > *size) return false;
97   *size -= n;
98   *buf += n;
99   return true;
100 }
101
102 // Helper for RawLog__ below.
103 inline static bool VADoRawLog(char** buf, int* size,
104                               const char* format, va_list ap) {
105   int n = vsnprintf(*buf, *size, format, ap);
106   if (n < 0 || n > *size) return false;
107   *size -= n;
108   *buf += n;
109   return true;
110 }
111
112 static const int kLogBufSize = 3000;
113 static bool crashed = false;
114 static CrashReason crash_reason;
115 static char crash_buf[kLogBufSize + 1] = { 0 };  // Will end in '\0'
116
117 void RawLog__(LogSeverity severity, const char* file, int line,
118               const char* format, ...) {
119   if (!(FLAGS_logtostderr || severity >= FLAGS_stderrthreshold ||
120         FLAGS_alsologtostderr || !IsGoogleLoggingInitialized())) {
121     return;  // this stderr log message is suppressed
122   }
123   // can't call localtime_r here: it can allocate
124   struct ::tm& t = last_tm_time_for_raw_log;
125   char buffer[kLogBufSize];
126   char* buf = buffer;
127   int size = sizeof(buffer);
128
129   // NOTE: this format should match the specification in base/logging.h
130   DoRawLog(&buf, &size, "%c%02d%02d %02d:%02d:%02d.%06d %5u %s:%d] RAW: ",
131            LogSeverityNames[severity][0],
132            1 + t.tm_mon, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec,
133            last_usecs_for_raw_log,
134            static_cast<unsigned int>(GetTID()),
135            const_basename(const_cast<char *>(file)), line);
136
137   // Record the position and size of the buffer after the prefix
138   const char* msg_start = buf;
139   const int msg_size = size;
140
141   va_list ap;
142   va_start(ap, format);
143   bool no_chop = VADoRawLog(&buf, &size, format, ap);
144   va_end(ap);
145   if (no_chop) {
146     DoRawLog(&buf, &size, "\n");
147   } else {
148     DoRawLog(&buf, &size, "RAW_LOG ERROR: The Message was too long!\n");
149   }
150   // We make a raw syscall to write directly to the stderr file descriptor,
151   // avoiding FILE buffering (to avoid invoking malloc()), and bypassing
152   // libc (to side-step any libc interception).
153   // We write just once to avoid races with other invocations of RawLog__.
154   safe_write(STDERR_FILENO, buffer, strlen(buffer));
155   if (severity == GLOG_FATAL)  {
156     if (!sync_val_compare_and_swap(&crashed, false, true)) {
157       crash_reason.filename = file;
158       crash_reason.line_number = line;
159       memcpy(crash_buf, msg_start, msg_size);  // Don't include prefix
160       crash_reason.message = crash_buf;
161 #ifdef HAVE_STACKTRACE
162       crash_reason.depth =
163           GetStackTrace(crash_reason.stack, ARRAYSIZE(crash_reason.stack), 1);
164 #else
165       crash_reason.depth = 0;
166 #endif
167       SetCrashReason(&crash_reason);
168     }
169     LogMessage::Fail();  // abort()
170   }
171 }
172
173 _END_GOOGLE_NAMESPACE_