1 // This file is automatically generated from src/glog/logging.h.in
2 // using src/windows/preprocess.sh.
5 // Copyright (c) 1999, Google Inc.
6 // All rights reserved.
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions are
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above
15 // copyright notice, this list of conditions and the following disclaimer
16 // in the documentation and/or other materials provided with the
18 // * Neither the name of Google Inc. nor the names of its
19 // contributors may be used to endorse or promote products derived from
20 // this software without specific prior written permission.
22 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 // This file contains #include information about logging-related stuff.
37 // Pretty much everybody needs to #include this file so that they can
38 // log various happenings.
55 // Annoying stuff for windows -- makes sure clients can import these functions
56 #ifndef GOOGLE_GLOG_DLL_DECL
57 # if defined(_WIN32) && !defined(__CYGWIN__)
58 # define GOOGLE_GLOG_DLL_DECL __declspec(dllimport)
60 # define GOOGLE_GLOG_DLL_DECL
64 #define GLOG_MSVC_PUSH_DISABLE_WARNING(n) __pragma(warning(push)) \
65 __pragma(warning(disable:n))
66 #define GLOG_MSVC_POP_WARNING() __pragma(warning(pop))
68 #define GLOG_MSVC_PUSH_DISABLE_WARNING(n)
69 #define GLOG_MSVC_POP_WARNING()
72 // We care a lot about number of bits things take up. Unfortunately,
73 // systems define their bit-specific ints in a lot of different ways.
74 // We use our own way, and have a typedef to get there.
75 // Note: these commands below may look like "#if 1" or "#if 0", but
76 // that's because they were constructed that way at ./configure time.
77 // Look at logging.h.in to see how they're calculated (based on your config).
79 #include <stdint.h> // the normal place uint16_t is defined
82 #include <sys/types.h> // the normal place u_int16_t is defined
85 #include <inttypes.h> // a third place for uint16_t or u_int16_t
89 #include <gflags/gflags.h>
94 #if 0 // the C99 format
95 typedef int32_t int32;
96 typedef uint32_t uint32;
97 typedef int64_t int64;
98 typedef uint64_t uint64;
99 #elif 0 // the BSD format
100 typedef int32_t int32;
101 typedef u_int32_t uint32;
102 typedef int64_t int64;
103 typedef u_int64_t uint64;
104 #elif 1 // the windows (vc7) format
105 typedef __int32 int32;
106 typedef unsigned __int32 uint32;
107 typedef __int64 int64;
108 typedef unsigned __int64 uint64;
110 #error Do not know how to define a 32-bit integer quantity on your system
115 // The global value of GOOGLE_STRIP_LOG. All the messages logged to
116 // LOG(XXX) with severity less than GOOGLE_STRIP_LOG will not be displayed.
117 // If it can be determined at compile time that the message will not be
118 // printed, the statement will be compiled out.
120 // Example: to strip out all INFO and WARNING messages, use the value
121 // of 2 below. To make an exception for WARNING messages from a single
122 // file, add "#define GOOGLE_STRIP_LOG 1" to that file _before_ including
124 #ifndef GOOGLE_STRIP_LOG
125 #define GOOGLE_STRIP_LOG 0
128 // GCC can be told that a certain branch is not likely to be taken (for
129 // instance, a CHECK failure), and use that information in static analysis.
130 // Giving it this information can help it optimize for the common case in
131 // the absence of better information (ie. -fprofile-arcs).
133 #ifndef GOOGLE_PREDICT_BRANCH_NOT_TAKEN
135 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) (__builtin_expect(x, 0))
136 #define GOOGLE_PREDICT_FALSE(x) (__builtin_expect(x, 0))
137 #define GOOGLE_PREDICT_TRUE(x) (__builtin_expect(!!(x), 1))
139 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) x
140 #define GOOGLE_PREDICT_FALSE(x) x
141 #define GOOGLE_PREDICT_TRUE(x) x
145 // Make a bunch of macros for logging. The way to log things is to stream
146 // things to LOG(<a particular severity level>). E.g.,
148 // LOG(INFO) << "Found " << num_cookies << " cookies";
150 // You can capture log messages in a string, rather than reporting them
153 // vector<string> errors;
154 // LOG_STRING(ERROR, &errors) << "Couldn't parse cookie #" << cookie_num;
156 // This pushes back the new error onto 'errors'; if given a NULL pointer,
157 // it reports the error via LOG(ERROR).
159 // You can also do conditional logging:
161 // LOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
163 // You can also do occasional logging (log every n'th occurrence of an
166 // LOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
168 // The above will cause log messages to be output on the 1st, 11th, 21st, ...
169 // times it is executed. Note that the special google::COUNTER value is used
170 // to identify which repetition is happening.
172 // You can also do occasional conditional logging (log every n'th
173 // occurrence of an event, when condition is satisfied):
175 // LOG_IF_EVERY_N(INFO, (size > 1024), 10) << "Got the " << google::COUNTER
176 // << "th big cookie";
178 // You can log messages the first N times your code executes a line. E.g.
180 // LOG_FIRST_N(INFO, 20) << "Got the " << google::COUNTER << "th cookie";
182 // Outputs log messages for the first 20 times it is executed.
184 // Analogous SYSLOG, SYSLOG_IF, and SYSLOG_EVERY_N macros are available.
185 // These log to syslog as well as to the normal logs. If you use these at
186 // all, you need to be aware that syslog can drastically reduce performance,
187 // especially if it is configured for remote logging! Don't use these
188 // unless you fully understand this and have a concrete need to use them.
189 // Even then, try to minimize your use of them.
191 // There are also "debug mode" logging macros like the ones above:
193 // DLOG(INFO) << "Found cookies";
195 // DLOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
197 // DLOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
199 // All "debug mode" logging is compiled away to nothing for non-debug mode
204 // LOG_ASSERT(assertion);
205 // DLOG_ASSERT(assertion);
207 // which is syntactic sugar for {,D}LOG_IF(FATAL, assert fails) << assertion;
209 // There are "verbose level" logging macros. They look like
211 // VLOG(1) << "I'm printed when you run the program with --v=1 or more";
212 // VLOG(2) << "I'm printed when you run the program with --v=2 or more";
214 // These always log at the INFO log level (when they log at all).
215 // The verbose logging can also be turned on module-by-module. For instance,
216 // --vmodule=mapreduce=2,file=1,gfs*=3 --v=0
218 // a. VLOG(2) and lower messages to be printed from mapreduce.{h,cc}
219 // b. VLOG(1) and lower messages to be printed from file.{h,cc}
220 // c. VLOG(3) and lower messages to be printed from files prefixed with "gfs"
221 // d. VLOG(0) and lower messages to be printed from elsewhere
223 // The wildcarding functionality shown by (c) supports both '*' (match
224 // 0 or more characters) and '?' (match any single character) wildcards.
226 // There's also VLOG_IS_ON(n) "verbose level" condition macro. To be used as
228 // if (VLOG_IS_ON(2)) {
229 // // do some logging preparation and logging
230 // // that can't be accomplished with just VLOG(2) << ...;
233 // There are also VLOG_IF, VLOG_EVERY_N and VLOG_IF_EVERY_N "verbose level"
234 // condition macros for sample cases, when some extra computation and
235 // preparation for logs is not needed.
236 // VLOG_IF(1, (size > 1024))
237 // << "I'm printed when size is more than 1024 and when you run the "
238 // "program with --v=1 or more";
239 // VLOG_EVERY_N(1, 10)
240 // << "I'm printed every 10th occurrence, and when you run the program "
241 // "with --v=1 or more. Present occurence is " << google::COUNTER;
242 // VLOG_IF_EVERY_N(1, (size > 1024), 10)
243 // << "I'm printed on every 10th occurence of case when size is more "
244 // " than 1024, when you run the program with --v=1 or more. ";
245 // "Present occurence is " << google::COUNTER;
247 // The supported severity levels for macros that allow you to specify one
248 // are (in increasing order of severity) INFO, WARNING, ERROR, and FATAL.
249 // Note that messages of a given severity are logged not only in the
250 // logfile for that severity, but also in all logfiles of lower severity.
251 // E.g., a message of severity FATAL will be logged to the logfiles of
252 // severity FATAL, ERROR, WARNING, and INFO.
254 // There is also the special severity of DFATAL, which logs FATAL in
255 // debug mode, ERROR in normal mode.
257 // Very important: logging a message at the FATAL severity level causes
258 // the program to terminate (after the message is logged).
260 // Unless otherwise specified, logs will be written to the filename
261 // "<program name>.<hostname>.<user name>.log.<severity level>.", followed
262 // by the date, time, and pid (you can't prevent the date, time, and pid
263 // from being in the filename).
265 // The logging code takes two flags:
266 // --v=# set the verbose level
267 // --logtostderr log all the messages to stderr instead of to logfiles
269 // LOG LINE PREFIX FORMAT
271 // Log lines have this form:
273 // Lmmdd hh:mm:ss.uuuuuu threadid file:line] msg...
275 // where the fields are defined as follows:
277 // L A single character, representing the log level
279 // mm The month (zero padded; ie May is '05')
280 // dd The day (zero padded)
281 // hh:mm:ss.uuuuuu Time in hours, minutes and fractional seconds
282 // threadid The space-padded thread ID as returned by GetTID()
283 // (this matches the PID on Linux)
284 // file The file name
285 // line The line number
286 // msg The user-supplied message
290 // I1103 11:57:31.739339 24395 google.cc:2341] Command line: ./some_prog
291 // I1103 11:57:31.739403 24395 google.cc:2342] Process id 24395
293 // NOTE: although the microseconds are useful for comparing events on
294 // a single machine, clocks on different machines may not be well
295 // synchronized. Hence, use caution when comparing the low bits of
296 // timestamps from different machines.
298 #ifndef DECLARE_VARIABLE
299 #define MUST_UNDEF_GFLAGS_DECLARE_MACROS
300 #define DECLARE_VARIABLE(type, name, tn) \
301 namespace FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead { \
302 extern GOOGLE_GLOG_DLL_DECL type FLAGS_##name; \
304 using FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead::FLAGS_##name
306 // bool specialization
307 #define DECLARE_bool(name) \
308 DECLARE_VARIABLE(bool, name, bool)
310 // int32 specialization
311 #define DECLARE_int32(name) \
312 DECLARE_VARIABLE(google::int32, name, int32)
314 // Special case for string, because we have to specify the namespace
315 // std::string, which doesn't play nicely with our FLAG__namespace hackery.
316 #define DECLARE_string(name) \
317 namespace FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead { \
318 extern GOOGLE_GLOG_DLL_DECL std::string FLAGS_##name; \
320 using FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead::FLAGS_##name
323 // Set whether log messages go to stderr instead of logfiles
324 DECLARE_bool(logtostderr);
326 // Set whether log messages go to stderr in addition to logfiles.
327 DECLARE_bool(alsologtostderr);
329 // Log messages at a level >= this flag are automatically sent to
330 // stderr in addition to log files.
331 DECLARE_int32(stderrthreshold);
333 // Set whether the log prefix should be prepended to each line of output.
334 DECLARE_bool(log_prefix);
336 // Log messages at a level <= this flag are buffered.
337 // Log messages at a higher level are flushed immediately.
338 DECLARE_int32(logbuflevel);
340 // Sets the maximum number of seconds which logs may be buffered for.
341 DECLARE_int32(logbufsecs);
343 // Log suppression level: messages logged at a lower level than this
345 DECLARE_int32(minloglevel);
347 // If specified, logfiles are written into this directory instead of the
348 // default logging directory.
349 DECLARE_string(log_dir);
351 // Sets the path of the directory into which to put additional links
353 DECLARE_string(log_link);
355 DECLARE_int32(v); // in vlog_is_on.cc
357 // Sets the maximum log file size (in MB).
358 DECLARE_int32(max_log_size);
360 // Sets whether to avoid logging to the disk if the disk is full.
361 DECLARE_bool(stop_logging_if_full_disk);
363 #ifdef MUST_UNDEF_GFLAGS_DECLARE_MACROS
364 #undef MUST_UNDEF_GFLAGS_DECLARE_MACROS
365 #undef DECLARE_VARIABLE
368 #undef DECLARE_string
371 // Log messages below the GOOGLE_STRIP_LOG level will be compiled away for
372 // security reasons. See LOG(severtiy) below.
374 // A few definitions of macros that don't generate much code. Since
375 // LOG(INFO) and its ilk are used all over our code, it's
376 // better to have compact code for these operations.
378 #if GOOGLE_STRIP_LOG == 0
379 #define COMPACT_GOOGLE_LOG_INFO google::LogMessage( \
381 #define LOG_TO_STRING_INFO(message) google::LogMessage( \
382 __FILE__, __LINE__, google::GLOG_INFO, message)
384 #define COMPACT_GOOGLE_LOG_INFO google::NullStream()
385 #define LOG_TO_STRING_INFO(message) google::NullStream()
388 #if GOOGLE_STRIP_LOG <= 1
389 #define COMPACT_GOOGLE_LOG_WARNING google::LogMessage( \
390 __FILE__, __LINE__, google::GLOG_WARNING)
391 #define LOG_TO_STRING_WARNING(message) google::LogMessage( \
392 __FILE__, __LINE__, google::GLOG_WARNING, message)
394 #define COMPACT_GOOGLE_LOG_WARNING google::NullStream()
395 #define LOG_TO_STRING_WARNING(message) google::NullStream()
398 #if GOOGLE_STRIP_LOG <= 2
399 #define COMPACT_GOOGLE_LOG_ERROR google::LogMessage( \
400 __FILE__, __LINE__, google::GLOG_ERROR)
401 #define LOG_TO_STRING_ERROR(message) google::LogMessage( \
402 __FILE__, __LINE__, google::GLOG_ERROR, message)
404 #define COMPACT_GOOGLE_LOG_ERROR google::NullStream()
405 #define LOG_TO_STRING_ERROR(message) google::NullStream()
408 #if GOOGLE_STRIP_LOG <= 3
409 #define COMPACT_GOOGLE_LOG_FATAL google::LogMessageFatal( \
411 #define LOG_TO_STRING_FATAL(message) google::LogMessage( \
412 __FILE__, __LINE__, google::GLOG_FATAL, message)
414 #define COMPACT_GOOGLE_LOG_FATAL google::NullStreamFatal()
415 #define LOG_TO_STRING_FATAL(message) google::NullStreamFatal()
418 // For DFATAL, we want to use LogMessage (as opposed to
419 // LogMessageFatal), to be consistent with the original behavior.
421 #define COMPACT_GOOGLE_LOG_DFATAL COMPACT_GOOGLE_LOG_ERROR
422 #elif GOOGLE_STRIP_LOG <= 3
423 #define COMPACT_GOOGLE_LOG_DFATAL google::LogMessage( \
424 __FILE__, __LINE__, google::GLOG_FATAL)
426 #define COMPACT_GOOGLE_LOG_DFATAL google::NullStreamFatal()
429 #define GOOGLE_LOG_INFO(counter) google::LogMessage(__FILE__, __LINE__, google::GLOG_INFO, counter, &google::LogMessage::SendToLog)
430 #define SYSLOG_INFO(counter) \
431 google::LogMessage(__FILE__, __LINE__, google::GLOG_INFO, counter, \
432 &google::LogMessage::SendToSyslogAndLog)
433 #define GOOGLE_LOG_WARNING(counter) \
434 google::LogMessage(__FILE__, __LINE__, google::GLOG_WARNING, counter, \
435 &google::LogMessage::SendToLog)
436 #define SYSLOG_WARNING(counter) \
437 google::LogMessage(__FILE__, __LINE__, google::GLOG_WARNING, counter, \
438 &google::LogMessage::SendToSyslogAndLog)
439 #define GOOGLE_LOG_ERROR(counter) \
440 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, counter, \
441 &google::LogMessage::SendToLog)
442 #define SYSLOG_ERROR(counter) \
443 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, counter, \
444 &google::LogMessage::SendToSyslogAndLog)
445 #define GOOGLE_LOG_FATAL(counter) \
446 google::LogMessage(__FILE__, __LINE__, google::GLOG_FATAL, counter, \
447 &google::LogMessage::SendToLog)
448 #define SYSLOG_FATAL(counter) \
449 google::LogMessage(__FILE__, __LINE__, google::GLOG_FATAL, counter, \
450 &google::LogMessage::SendToSyslogAndLog)
451 #define GOOGLE_LOG_DFATAL(counter) \
452 google::LogMessage(__FILE__, __LINE__, google::DFATAL_LEVEL, counter, \
453 &google::LogMessage::SendToLog)
454 #define SYSLOG_DFATAL(counter) \
455 google::LogMessage(__FILE__, __LINE__, google::DFATAL_LEVEL, counter, \
456 &google::LogMessage::SendToSyslogAndLog)
458 #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
459 // A very useful logging macro to log windows errors:
460 #define LOG_SYSRESULT(result) \
461 if (FAILED(HRESULT_FROM_WIN32(result))) { \
462 LPSTR message = NULL; \
463 LPSTR msg = reinterpret_cast<LPSTR>(&message); \
464 DWORD message_length = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | \
465 FORMAT_MESSAGE_FROM_SYSTEM, \
466 0, result, 0, msg, 100, NULL); \
467 if (message_length > 0) { \
468 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, 0, \
469 &google::LogMessage::SendToLog).stream() \
470 << reinterpret_cast<const char*>(message); \
471 LocalFree(message); \
476 // We use the preprocessor's merging operator, "##", so that, e.g.,
477 // LOG(INFO) becomes the token GOOGLE_LOG_INFO. There's some funny
478 // subtle difference between ostream member streaming functions (e.g.,
479 // ostream::operator<<(int) and ostream non-member streaming functions
480 // (e.g., ::operator<<(ostream&, string&): it turns out that it's
481 // impossible to stream something like a string directly to an unnamed
482 // ostream. We employ a neat hack by calling the stream() member
483 // function of LogMessage which seems to avoid the problem.
484 #define LOG(severity) COMPACT_GOOGLE_LOG_ ## severity.stream()
485 #define SYSLOG(severity) SYSLOG_ ## severity(0).stream()
489 // They need the definitions of integer types.
490 #include "glog/log_severity.h"
491 #include "glog/vlog_is_on.h"
493 // Initialize google's logging library. You will see the program name
494 // specified by argv0 in log outputs.
495 GOOGLE_GLOG_DLL_DECL void InitGoogleLogging(const char* argv0);
497 // Shutdown google's logging library.
498 GOOGLE_GLOG_DLL_DECL void ShutdownGoogleLogging();
500 // Install a function which will be called after LOG(FATAL).
501 GOOGLE_GLOG_DLL_DECL void InstallFailureFunction(void (*fail_func)());
503 class LogSink; // defined below
505 // If a non-NULL sink pointer is given, we push this message to that sink.
506 // For LOG_TO_SINK we then do normal LOG(severity) logging as well.
507 // This is useful for capturing messages and passing/storing them
508 // somewhere more specific than the global log of the process.
511 // LogSeverity severity;
512 // The cast is to disambiguate NULL arguments.
513 #define LOG_TO_SINK(sink, severity) \
514 google::LogMessage( \
515 __FILE__, __LINE__, \
516 google::GLOG_ ## severity, \
517 static_cast<google::LogSink*>(sink), true).stream()
518 #define LOG_TO_SINK_BUT_NOT_TO_LOGFILE(sink, severity) \
519 google::LogMessage( \
520 __FILE__, __LINE__, \
521 google::GLOG_ ## severity, \
522 static_cast<google::LogSink*>(sink), false).stream()
524 // If a non-NULL string pointer is given, we write this message to that string.
525 // We then do normal LOG(severity) logging as well.
526 // This is useful for capturing messages and storing them somewhere more
527 // specific than the global log of the process.
530 // LogSeverity severity;
531 // The cast is to disambiguate NULL arguments.
532 // NOTE: LOG(severity) expands to LogMessage().stream() for the specified
534 #define LOG_TO_STRING(severity, message) \
535 LOG_TO_STRING_##severity(static_cast<string*>(message)).stream()
537 // If a non-NULL pointer is given, we push the message onto the end
538 // of a vector of strings; otherwise, we report it with LOG(severity).
539 // This is handy for capturing messages and perhaps passing them back
540 // to the caller, rather than reporting them immediately.
542 // LogSeverity severity;
543 // vector<string> *outvec;
544 // The cast is to disambiguate NULL arguments.
545 #define LOG_STRING(severity, outvec) \
546 LOG_TO_STRING_##severity(static_cast<vector<string>*>(outvec)).stream()
548 #define LOG_IF(severity, condition) \
549 !(condition) ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
550 #define SYSLOG_IF(severity, condition) \
551 !(condition) ? (void) 0 : google::LogMessageVoidify() & SYSLOG(severity)
553 #define LOG_ASSERT(condition) \
554 LOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
555 #define SYSLOG_ASSERT(condition) \
556 SYSLOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
558 // CHECK dies with a fatal error if condition is not true. It is *not*
559 // controlled by NDEBUG, so the check will be executed regardless of
560 // compilation mode. Therefore, it is safe to do things like:
561 // CHECK(fp->Write(x) == 4)
562 #define CHECK(condition) \
563 LOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
564 << "Check failed: " #condition " "
566 // A container for a string pointer which can be evaluated to a bool -
567 // true iff the pointer is NULL.
568 struct CheckOpString {
569 CheckOpString(std::string* str) : str_(str) { }
570 // No destructor: if str_ is non-NULL, we're about to LOG(FATAL),
571 // so there's no point in cleaning up str_.
572 operator bool() const {
573 return GOOGLE_PREDICT_BRANCH_NOT_TAKEN(str_ != NULL);
578 // Function is overloaded for integral types to allow static const
579 // integrals declared in classes and not defined to be used as arguments to
580 // CHECK* macros. It's not encouraged though.
582 inline const T& GetReferenceableValue(const T& t) { return t; }
583 inline char GetReferenceableValue(char t) { return t; }
584 inline unsigned char GetReferenceableValue(unsigned char t) { return t; }
585 inline signed char GetReferenceableValue(signed char t) { return t; }
586 inline short GetReferenceableValue(short t) { return t; }
587 inline unsigned short GetReferenceableValue(unsigned short t) { return t; }
588 inline int GetReferenceableValue(int t) { return t; }
589 inline unsigned int GetReferenceableValue(unsigned int t) { return t; }
590 inline long GetReferenceableValue(long t) { return t; }
591 inline unsigned long GetReferenceableValue(unsigned long t) { return t; }
592 inline long long GetReferenceableValue(long long t) { return t; }
593 inline unsigned long long GetReferenceableValue(unsigned long long t) {
597 // This is a dummy class to define the following operator.
598 struct DummyClassToDefineOperator {};
602 // Define global operator<< to declare using ::operator<<.
603 // This declaration will allow use to use CHECK macros for user
604 // defined classes which have operator<< (e.g., stl_logging.h).
605 inline std::ostream& operator<<(
606 std::ostream& out, const google::DummyClassToDefineOperator&) {
612 // This formats a value for a failing CHECK_XX statement. Ordinarily,
613 // it uses the definition for operator<<, with a few special cases below.
614 template <typename T>
615 inline void MakeCheckOpValueString(std::ostream* os, const T& v) {
619 // Overrides for char types provide readable values for unprintable
622 void MakeCheckOpValueString(std::ostream* os, const char& v);
624 void MakeCheckOpValueString(std::ostream* os, const signed char& v);
626 void MakeCheckOpValueString(std::ostream* os, const unsigned char& v);
628 // Build the error message string. Specify no inlining for code size.
629 template <typename T1, typename T2>
630 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext)
636 // If "s" is less than base_logging::INFO, returns base_logging::INFO.
637 // If "s" is greater than base_logging::FATAL, returns
638 // base_logging::ERROR. Otherwise, returns "s".
639 LogSeverity NormalizeSeverity(LogSeverity s);
641 } // namespace internal
643 // A helper class for formatting "expr (V1 vs. V2)" in a CHECK_XX
644 // statement. See MakeCheckOpString for sample usage. Other
645 // approaches were considered: use of a template method (e.g.,
646 // base::BuildCheckOpString(exprtext, base::Print<T1>, &v1,
647 // base::Print<T2>, &v2), however this approach has complications
648 // related to volatile arguments and function-pointer arguments).
649 class CheckOpMessageBuilder {
651 // Inserts "exprtext" and " (" to the stream.
652 explicit CheckOpMessageBuilder(const char *exprtext);
653 // Deletes "stream_".
654 ~CheckOpMessageBuilder();
655 // For inserting the first variable.
656 std::ostream* ForVar1() { return stream_; }
657 // For inserting the second variable (adds an intermediate " vs. ").
658 std::ostream* ForVar2();
659 // Get the result (inserts the closing ")").
660 std::string* NewString();
663 std::ostringstream *stream_;
668 template <typename T1, typename T2>
669 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext) {
670 base::CheckOpMessageBuilder comb(exprtext);
671 MakeCheckOpValueString(comb.ForVar1(), v1);
672 MakeCheckOpValueString(comb.ForVar2(), v2);
673 return comb.NewString();
676 // Helper functions for CHECK_OP macro.
677 // The (int, int) specialization works around the issue that the compiler
678 // will not instantiate the template version of the function on values of
679 // unnamed enum type - see comment below.
680 #define DEFINE_CHECK_OP_IMPL(name, op) \
681 template <typename T1, typename T2> \
682 inline std::string* name##Impl(const T1& v1, const T2& v2, \
683 const char* exprtext) { \
684 if (GOOGLE_PREDICT_TRUE(v1 op v2)) return NULL; \
685 else return MakeCheckOpString(v1, v2, exprtext); \
687 inline std::string* name##Impl(int v1, int v2, const char* exprtext) { \
688 return name##Impl<int, int>(v1, v2, exprtext); \
691 // We use the full name Check_EQ, Check_NE, etc. in case the file including
692 // base/logging.h provides its own #defines for the simpler names EQ, NE, etc.
693 // This happens if, for example, those are used as token names in a
695 DEFINE_CHECK_OP_IMPL(Check_EQ, ==) // Compilation error with CHECK_EQ(NULL, x)?
696 DEFINE_CHECK_OP_IMPL(Check_NE, !=) // Use CHECK(x == NULL) instead.
697 DEFINE_CHECK_OP_IMPL(Check_LE, <=)
698 DEFINE_CHECK_OP_IMPL(Check_LT, < )
699 DEFINE_CHECK_OP_IMPL(Check_GE, >=)
700 DEFINE_CHECK_OP_IMPL(Check_GT, > )
701 #undef DEFINE_CHECK_OP_IMPL
703 // Helper macro for binary operators.
704 // Don't use this macro directly in your code, use CHECK_EQ et al below.
706 #if defined(STATIC_ANALYSIS)
707 // Only for static analysis tool to know that it is equivalent to assert
708 #define CHECK_OP_LOG(name, op, val1, val2, log) CHECK((val1) op (val2))
709 #elif !defined(NDEBUG)
710 // In debug mode, avoid constructing CheckOpStrings if possible,
711 // to reduce the overhead of CHECK statments by 2x.
712 // Real DCHECK-heavy tests have seen 1.5x speedups.
714 // The meaning of "string" might be different between now and
715 // when this macro gets invoked (e.g., if someone is experimenting
716 // with other string implementations that get defined after this
717 // file is included). Save the current meaning now and use it
719 typedef std::string _Check_string;
720 #define CHECK_OP_LOG(name, op, val1, val2, log) \
721 while (google::_Check_string* _result = \
722 google::Check##name##Impl( \
723 google::GetReferenceableValue(val1), \
724 google::GetReferenceableValue(val2), \
725 #val1 " " #op " " #val2)) \
726 log(__FILE__, __LINE__, \
727 google::CheckOpString(_result)).stream()
729 // In optimized mode, use CheckOpString to hint to compiler that
730 // the while condition is unlikely.
731 #define CHECK_OP_LOG(name, op, val1, val2, log) \
732 while (google::CheckOpString _result = \
733 google::Check##name##Impl( \
734 google::GetReferenceableValue(val1), \
735 google::GetReferenceableValue(val2), \
736 #val1 " " #op " " #val2)) \
737 log(__FILE__, __LINE__, _result).stream()
738 #endif // STATIC_ANALYSIS, !NDEBUG
740 #if GOOGLE_STRIP_LOG <= 3
741 #define CHECK_OP(name, op, val1, val2) \
742 CHECK_OP_LOG(name, op, val1, val2, google::LogMessageFatal)
744 #define CHECK_OP(name, op, val1, val2) \
745 CHECK_OP_LOG(name, op, val1, val2, google::NullStreamFatal)
746 #endif // STRIP_LOG <= 3
748 // Equality/Inequality checks - compare two values, and log a FATAL message
749 // including the two values when the result is not as expected. The values
750 // must have operator<<(ostream, ...) defined.
752 // You may append to the error message like so:
753 // CHECK_NE(1, 2) << ": The world must be ending!";
755 // We are very careful to ensure that each argument is evaluated exactly
756 // once, and that anything which is legal to pass as a function argument is
757 // legal here. In particular, the arguments may be temporary expressions
758 // which will end up being destroyed at the end of the apparent statement,
760 // CHECK_EQ(string("abc")[1], 'b');
762 // WARNING: These don't compile correctly if one of the arguments is a pointer
763 // and the other is NULL. To work around this, simply static_cast NULL to the
764 // type of the desired pointer.
766 #define CHECK_EQ(val1, val2) CHECK_OP(_EQ, ==, val1, val2)
767 #define CHECK_NE(val1, val2) CHECK_OP(_NE, !=, val1, val2)
768 #define CHECK_LE(val1, val2) CHECK_OP(_LE, <=, val1, val2)
769 #define CHECK_LT(val1, val2) CHECK_OP(_LT, < , val1, val2)
770 #define CHECK_GE(val1, val2) CHECK_OP(_GE, >=, val1, val2)
771 #define CHECK_GT(val1, val2) CHECK_OP(_GT, > , val1, val2)
773 // Check that the input is non NULL. This very useful in constructor
774 // initializer lists.
776 #define CHECK_NOTNULL(val) \
777 google::CheckNotNull(__FILE__, __LINE__, "'" #val "' Must be non NULL", (val))
779 // Helper functions for string comparisons.
780 // To avoid bloat, the definitions are in logging.cc.
781 #define DECLARE_CHECK_STROP_IMPL(func, expected) \
782 GOOGLE_GLOG_DLL_DECL std::string* Check##func##expected##Impl( \
783 const char* s1, const char* s2, const char* names);
784 DECLARE_CHECK_STROP_IMPL(strcmp, true)
785 DECLARE_CHECK_STROP_IMPL(strcmp, false)
786 DECLARE_CHECK_STROP_IMPL(strcasecmp, true)
787 DECLARE_CHECK_STROP_IMPL(strcasecmp, false)
788 #undef DECLARE_CHECK_STROP_IMPL
790 // Helper macro for string comparisons.
791 // Don't use this macro directly in your code, use CHECK_STREQ et al below.
792 #define CHECK_STROP(func, op, expected, s1, s2) \
793 while (google::CheckOpString _result = \
794 google::Check##func##expected##Impl((s1), (s2), \
795 #s1 " " #op " " #s2)) \
796 LOG(FATAL) << *_result.str_
799 // String (char*) equality/inequality checks.
800 // CASE versions are case-insensitive.
802 // Note that "s1" and "s2" may be temporary strings which are destroyed
803 // by the compiler at the end of the current "full expression"
804 // (e.g. CHECK_STREQ(Foo().c_str(), Bar().c_str())).
806 #define CHECK_STREQ(s1, s2) CHECK_STROP(strcmp, ==, true, s1, s2)
807 #define CHECK_STRNE(s1, s2) CHECK_STROP(strcmp, !=, false, s1, s2)
808 #define CHECK_STRCASEEQ(s1, s2) CHECK_STROP(strcasecmp, ==, true, s1, s2)
809 #define CHECK_STRCASENE(s1, s2) CHECK_STROP(strcasecmp, !=, false, s1, s2)
811 #define CHECK_INDEX(I,A) CHECK(I < (sizeof(A)/sizeof(A[0])))
812 #define CHECK_BOUND(B,A) CHECK(B <= (sizeof(A)/sizeof(A[0])))
814 #define CHECK_DOUBLE_EQ(val1, val2) \
816 CHECK_LE((val1), (val2)+0.000000000000001L); \
817 CHECK_GE((val1), (val2)-0.000000000000001L); \
820 #define CHECK_NEAR(val1, val2, margin) \
822 CHECK_LE((val1), (val2)+(margin)); \
823 CHECK_GE((val1), (val2)-(margin)); \
826 // perror()..googly style!
828 // PLOG() and PLOG_IF() and PCHECK() behave exactly like their LOG* and
829 // CHECK equivalents with the addition that they postpend a description
830 // of the current state of errno to their output lines.
832 #define PLOG(severity) GOOGLE_PLOG(severity, 0).stream()
834 #define GOOGLE_PLOG(severity, counter) \
835 google::ErrnoLogMessage( \
836 __FILE__, __LINE__, google::GLOG_ ## severity, counter, \
837 &google::LogMessage::SendToLog)
839 #define PLOG_IF(severity, condition) \
840 !(condition) ? (void) 0 : google::LogMessageVoidify() & PLOG(severity)
842 // A CHECK() macro that postpends errno if the condition is false. E.g.
844 // if (poll(fds, nfds, timeout) == -1) { PCHECK(errno == EINTR); ... }
845 #define PCHECK(condition) \
846 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
847 << "Check failed: " #condition " "
849 // A CHECK() macro that lets you assert the success of a function that
850 // returns -1 and sets errno in case of an error. E.g.
852 // CHECK_ERR(mkdir(path, 0700));
856 // int fd = open(filename, flags); CHECK_ERR(fd) << ": open " << filename;
857 #define CHECK_ERR(invocation) \
858 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN((invocation) == -1)) \
861 // Use macro expansion to create, for each use of LOG_EVERY_N(), static
862 // variables with the __LINE__ expansion as part of the variable name.
863 #define LOG_EVERY_N_VARNAME(base, line) LOG_EVERY_N_VARNAME_CONCAT(base, line)
864 #define LOG_EVERY_N_VARNAME_CONCAT(base, line) base ## line
866 #define LOG_OCCURRENCES LOG_EVERY_N_VARNAME(occurrences_, __LINE__)
867 #define LOG_OCCURRENCES_MOD_N LOG_EVERY_N_VARNAME(occurrences_mod_n_, __LINE__)
869 #define SOME_KIND_OF_LOG_EVERY_N(severity, n, what_to_do) \
870 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
872 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
873 if (LOG_OCCURRENCES_MOD_N == 1) \
874 google::LogMessage( \
875 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
876 &what_to_do).stream()
878 #define SOME_KIND_OF_LOG_IF_EVERY_N(severity, condition, n, what_to_do) \
879 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
882 ((LOG_OCCURRENCES_MOD_N=(LOG_OCCURRENCES_MOD_N + 1) % n) == (1 % n))) \
883 google::LogMessage( \
884 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
885 &what_to_do).stream()
887 #define SOME_KIND_OF_PLOG_EVERY_N(severity, n, what_to_do) \
888 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
890 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
891 if (LOG_OCCURRENCES_MOD_N == 1) \
892 google::ErrnoLogMessage( \
893 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
894 &what_to_do).stream()
896 #define SOME_KIND_OF_LOG_FIRST_N(severity, n, what_to_do) \
897 static int LOG_OCCURRENCES = 0; \
898 if (LOG_OCCURRENCES <= n) \
900 if (LOG_OCCURRENCES <= n) \
901 google::LogMessage( \
902 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
903 &what_to_do).stream()
905 namespace glog_internal_namespace_ {
907 struct CompileAssert {
910 } // namespace glog_internal_namespace_
912 #define GOOGLE_GLOG_COMPILE_ASSERT(expr, msg) \
913 typedef google::glog_internal_namespace_::CompileAssert<(bool(expr))> msg[bool(expr) ? 1 : -1]
915 #define LOG_EVERY_N(severity, n) \
916 GOOGLE_GLOG_COMPILE_ASSERT(google::GLOG_ ## severity < \
917 google::NUM_SEVERITIES, \
918 INVALID_REQUESTED_LOG_SEVERITY); \
919 SOME_KIND_OF_LOG_EVERY_N(severity, (n), google::LogMessage::SendToLog)
921 #define SYSLOG_EVERY_N(severity, n) \
922 SOME_KIND_OF_LOG_EVERY_N(severity, (n), google::LogMessage::SendToSyslogAndLog)
924 #define PLOG_EVERY_N(severity, n) \
925 SOME_KIND_OF_PLOG_EVERY_N(severity, (n), google::LogMessage::SendToLog)
927 #define LOG_FIRST_N(severity, n) \
928 SOME_KIND_OF_LOG_FIRST_N(severity, (n), google::LogMessage::SendToLog)
930 #define LOG_IF_EVERY_N(severity, condition, n) \
931 SOME_KIND_OF_LOG_IF_EVERY_N(severity, (condition), (n), google::LogMessage::SendToLog)
933 // We want the special COUNTER value available for LOG_EVERY_X()'ed messages
934 enum PRIVATE_Counter {COUNTER};
936 #ifdef GLOG_NO_ABBREVIATED_SEVERITIES
937 // wingdi.h defines ERROR to be 0. When we call LOG(ERROR), it gets
938 // substituted with 0, and it expands to COMPACT_GOOGLE_LOG_0. To allow us
939 // to keep using this syntax, we define this macro to do the same thing
940 // as COMPACT_GOOGLE_LOG_ERROR.
941 #define COMPACT_GOOGLE_LOG_0 COMPACT_GOOGLE_LOG_ERROR
942 #define SYSLOG_0 SYSLOG_ERROR
943 #define LOG_TO_STRING_0 LOG_TO_STRING_ERROR
944 // Needed for LOG_IS_ON(ERROR).
945 const LogSeverity GLOG_0 = GLOG_ERROR;
947 // Users may include windows.h after logging.h without
948 // GLOG_NO_ABBREVIATED_SEVERITIES nor WIN32_LEAN_AND_MEAN.
949 // For this case, we cannot detect if ERROR is defined before users
950 // actually use ERROR. Let's make an undefined symbol to warn users.
951 # define GLOG_ERROR_MSG ERROR_macro_is_defined_Define_GLOG_NO_ABBREVIATED_SEVERITIES_before_including_logging_h_See_the_document_for_detail
952 # define COMPACT_GOOGLE_LOG_0 GLOG_ERROR_MSG
953 # define SYSLOG_0 GLOG_ERROR_MSG
954 # define LOG_TO_STRING_0 GLOG_ERROR_MSG
955 # define GLOG_0 GLOG_ERROR_MSG
958 // Plus some debug-logging macros that get compiled to nothing for production
962 #define DLOG(severity) LOG(severity)
963 #define DVLOG(verboselevel) VLOG(verboselevel)
964 #define DLOG_IF(severity, condition) LOG_IF(severity, condition)
965 #define DLOG_EVERY_N(severity, n) LOG_EVERY_N(severity, n)
966 #define DLOG_IF_EVERY_N(severity, condition, n) \
967 LOG_IF_EVERY_N(severity, condition, n)
968 #define DLOG_ASSERT(condition) LOG_ASSERT(condition)
970 // debug-only checking. not executed in NDEBUG mode.
971 #define DCHECK(condition) CHECK(condition)
972 #define DCHECK_EQ(val1, val2) CHECK_EQ(val1, val2)
973 #define DCHECK_NE(val1, val2) CHECK_NE(val1, val2)
974 #define DCHECK_LE(val1, val2) CHECK_LE(val1, val2)
975 #define DCHECK_LT(val1, val2) CHECK_LT(val1, val2)
976 #define DCHECK_GE(val1, val2) CHECK_GE(val1, val2)
977 #define DCHECK_GT(val1, val2) CHECK_GT(val1, val2)
978 #define DCHECK_NOTNULL(val) CHECK_NOTNULL(val)
979 #define DCHECK_STREQ(str1, str2) CHECK_STREQ(str1, str2)
980 #define DCHECK_STRCASEEQ(str1, str2) CHECK_STRCASEEQ(str1, str2)
981 #define DCHECK_STRNE(str1, str2) CHECK_STRNE(str1, str2)
982 #define DCHECK_STRCASENE(str1, str2) CHECK_STRCASENE(str1, str2)
986 #define DLOG(severity) \
987 true ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
989 #define DVLOG(verboselevel) \
990 (true || !VLOG_IS_ON(verboselevel)) ?\
991 (void) 0 : google::LogMessageVoidify() & LOG(INFO)
993 #define DLOG_IF(severity, condition) \
994 (true || !(condition)) ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
996 #define DLOG_EVERY_N(severity, n) \
997 true ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
999 #define DLOG_IF_EVERY_N(severity, condition, n) \
1000 (true || !(condition))? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1002 #define DLOG_ASSERT(condition) \
1003 true ? (void) 0 : LOG_ASSERT(condition)
1005 // MSVC warning C4127: conditional expression is constant
1006 #define DCHECK(condition) \
1007 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1009 GLOG_MSVC_POP_WARNING() CHECK(condition)
1011 #define DCHECK_EQ(val1, val2) \
1012 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1014 GLOG_MSVC_POP_WARNING() CHECK_EQ(val1, val2)
1016 #define DCHECK_NE(val1, val2) \
1017 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1019 GLOG_MSVC_POP_WARNING() CHECK_NE(val1, val2)
1021 #define DCHECK_LE(val1, val2) \
1022 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1024 GLOG_MSVC_POP_WARNING() CHECK_LE(val1, val2)
1026 #define DCHECK_LT(val1, val2) \
1027 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1029 GLOG_MSVC_POP_WARNING() CHECK_LT(val1, val2)
1031 #define DCHECK_GE(val1, val2) \
1032 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1034 GLOG_MSVC_POP_WARNING() CHECK_GE(val1, val2)
1036 #define DCHECK_GT(val1, val2) \
1037 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1039 GLOG_MSVC_POP_WARNING() CHECK_GT(val1, val2)
1041 #define DCHECK_NOTNULL(val) (val)
1043 #define DCHECK_STREQ(str1, str2) \
1044 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1046 GLOG_MSVC_POP_WARNING() CHECK_STREQ(str1, str2)
1048 #define DCHECK_STRCASEEQ(str1, str2) \
1049 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1051 GLOG_MSVC_POP_WARNING() CHECK_STRCASEEQ(str1, str2)
1053 #define DCHECK_STRNE(str1, str2) \
1054 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1056 GLOG_MSVC_POP_WARNING() CHECK_STRNE(str1, str2)
1058 #define DCHECK_STRCASENE(str1, str2) \
1059 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1061 GLOG_MSVC_POP_WARNING() CHECK_STRCASENE(str1, str2)
1065 // Log only in verbose mode.
1067 #define VLOG(verboselevel) LOG_IF(INFO, VLOG_IS_ON(verboselevel))
1069 #define VLOG_IF(verboselevel, condition) \
1070 LOG_IF(INFO, (condition) && VLOG_IS_ON(verboselevel))
1072 #define VLOG_EVERY_N(verboselevel, n) \
1073 LOG_IF_EVERY_N(INFO, VLOG_IS_ON(verboselevel), n)
1075 #define VLOG_IF_EVERY_N(verboselevel, condition, n) \
1076 LOG_IF_EVERY_N(INFO, (condition) && VLOG_IS_ON(verboselevel), n)
1078 namespace base_logging {
1080 // LogMessage::LogStream is a std::ostream backed by this streambuf.
1081 // This class ignores overflow and leaves two bytes at the end of the
1082 // buffer to allow for a '\n' and '\0'.
1083 class LogStreamBuf : public std::streambuf {
1085 // REQUIREMENTS: "len" must be >= 2 to account for the '\n' and '\n'.
1086 LogStreamBuf(char *buf, int len) {
1087 setp(buf, buf + len - 2);
1089 // This effectively ignores overflow.
1090 virtual int_type overflow(int_type ch) {
1094 // Legacy public ostrstream method.
1095 size_t pcount() const { return pptr() - pbase(); }
1096 char* pbase() const { return std::streambuf::pbase(); }
1099 } // namespace base_logging
1102 // This class more or less represents a particular log message. You
1103 // create an instance of LogMessage and then stream stuff to it.
1104 // When you finish streaming to it, ~LogMessage is called and the
1105 // full message gets streamed to the appropriate destination.
1107 // You shouldn't actually use LogMessage's constructor to log things,
1108 // though. You should use the LOG() macro (and variants thereof)
1110 class GOOGLE_GLOG_DLL_DECL LogMessage {
1113 // Passing kNoLogPrefix for the line number disables the
1114 // log-message prefix. Useful for using the LogMessage
1115 // infrastructure as a printing utility. See also the --log_prefix
1116 // flag for controlling the log-message prefix on an
1117 // application-wide basis.
1121 // LogStream inherit from non-DLL-exported class (std::ostrstream)
1122 // and VC++ produces a warning for this situation.
1123 // However, MSDN says "C4275 can be ignored in Microsoft Visual C++
1124 // 2005 if you are deriving from a type in the Standard C++ Library"
1125 // http://msdn.microsoft.com/en-us/library/3tdb471s(VS.80).aspx
1126 // Let's just ignore the warning.
1128 # pragma warning(disable: 4275)
1130 class GOOGLE_GLOG_DLL_DECL LogStream : public std::ostream {
1132 # pragma warning(default: 4275)
1135 LogStream(char *buf, int len, int ctr)
1136 : std::ostream(NULL),
1137 streambuf_(buf, len),
1143 int ctr() const { return ctr_; }
1144 void set_ctr(int ctr) { ctr_ = ctr; }
1145 LogStream* self() const { return self_; }
1147 // Legacy std::streambuf methods.
1148 size_t pcount() const { return streambuf_.pcount(); }
1149 char* pbase() const { return streambuf_.pbase(); }
1150 char* str() const { return pbase(); }
1153 base_logging::LogStreamBuf streambuf_;
1154 int ctr_; // Counter hack (for the LOG_EVERY_X() macro)
1155 LogStream *self_; // Consistency check hack
1159 // icc 8 requires this typedef to avoid an internal compiler error.
1160 typedef void (LogMessage::*SendMethod)();
1162 LogMessage(const char* file, int line, LogSeverity severity, int ctr,
1163 SendMethod send_method);
1165 // Two special constructors that generate reduced amounts of code at
1166 // LOG call sites for common cases.
1168 // Used for LOG(INFO): Implied are:
1169 // severity = INFO, ctr = 0, send_method = &LogMessage::SendToLog.
1171 // Using this constructor instead of the more complex constructor above
1172 // saves 19 bytes per call site.
1173 LogMessage(const char* file, int line);
1175 // Used for LOG(severity) where severity != INFO. Implied
1176 // are: ctr = 0, send_method = &LogMessage::SendToLog
1178 // Using this constructor instead of the more complex constructor above
1179 // saves 17 bytes per call site.
1180 LogMessage(const char* file, int line, LogSeverity severity);
1182 // Constructor to log this message to a specified sink (if not NULL).
1183 // Implied are: ctr = 0, send_method = &LogMessage::SendToSinkAndLog if
1184 // also_send_to_log is true, send_method = &LogMessage::SendToSink otherwise.
1185 LogMessage(const char* file, int line, LogSeverity severity, LogSink* sink,
1186 bool also_send_to_log);
1188 // Constructor where we also give a vector<string> pointer
1189 // for storing the messages (if the pointer is not NULL).
1190 // Implied are: ctr = 0, send_method = &LogMessage::SaveOrSendToLog.
1191 LogMessage(const char* file, int line, LogSeverity severity,
1192 std::vector<std::string>* outvec);
1194 // Constructor where we also give a string pointer for storing the
1195 // message (if the pointer is not NULL). Implied are: ctr = 0,
1196 // send_method = &LogMessage::WriteToStringAndLog.
1197 LogMessage(const char* file, int line, LogSeverity severity,
1198 std::string* message);
1200 // A special constructor used for check failures
1201 LogMessage(const char* file, int line, const CheckOpString& result);
1205 // Flush a buffered message to the sink set in the constructor. Always
1206 // called by the destructor, it may also be called from elsewhere if
1207 // needed. Only the first call is actioned; any later ones are ignored.
1210 // An arbitrary limit on the length of a single log message. This
1211 // is so that streaming can be done more efficiently.
1212 static const size_t kMaxLogMessageLen;
1214 // Theses should not be called directly outside of logging.*,
1215 // only passed as SendMethod arguments to other LogMessage methods:
1216 void SendToLog(); // Actually dispatch to the logs
1217 void SendToSyslogAndLog(); // Actually dispatch to syslog and the logs
1219 // Call abort() or similar to perform LOG(FATAL) crash.
1220 static void Fail() ;
1222 std::ostream& stream() { return *(data_->stream_); }
1224 int preserved_errno() const { return data_->preserved_errno_; }
1226 // Must be called without the log_mutex held. (L < log_mutex)
1227 static int64 num_messages(int severity);
1230 // Fully internal SendMethod cases:
1231 void SendToSinkAndLog(); // Send to sink if provided and dispatch to the logs
1232 void SendToSink(); // Send to sink if provided, do nothing otherwise.
1234 // Write to string if provided and dispatch to the logs.
1235 void WriteToStringAndLog();
1237 void SaveOrSendToLog(); // Save to stringvec if provided, else to logs
1239 void Init(const char* file, int line, LogSeverity severity,
1240 void (LogMessage::*send_method)());
1242 // Used to fill in crash information during LOG(FATAL) failures.
1243 void RecordCrashReason(glog_internal_namespace_::CrashReason* reason);
1245 // Counts of messages sent at each priority:
1246 static int64 num_messages_[NUM_SEVERITIES]; // under log_mutex
1248 // We keep the data in a separate struct so that each instance of
1249 // LogMessage uses less stack space.
1250 struct GOOGLE_GLOG_DLL_DECL LogMessageData {
1251 LogMessageData() {};
1253 int preserved_errno_; // preserved errno
1255 char* message_text_; // Complete message text (points to selected buffer)
1256 LogStream* stream_alloc_;
1258 char severity_; // What level is this LogMessage logged at?
1259 int line_; // line number where logging call is.
1260 void (LogMessage::*send_method_)(); // Call this in destructor to send
1261 union { // At most one of these is used: union to keep the size low.
1262 LogSink* sink_; // NULL or sink to send message to
1263 std::vector<std::string>* outvec_; // NULL or vector to push message onto
1264 std::string* message_; // NULL or string to write message into
1266 time_t timestamp_; // Time of creation of LogMessage
1267 struct ::tm tm_time_; // Time of creation of LogMessage
1268 size_t num_prefix_chars_; // # of chars of prefix in this message
1269 size_t num_chars_to_log_; // # of chars of msg to send to log
1270 size_t num_chars_to_syslog_; // # of chars of msg to send to syslog
1271 const char* basename_; // basename of file that called LOG
1272 const char* fullname_; // fullname of file that called LOG
1273 bool has_been_flushed_; // false => data has not been flushed
1274 bool first_fatal_; // true => this was first fatal msg
1278 LogMessageData(const LogMessageData&);
1279 void operator=(const LogMessageData&);
1282 static LogMessageData fatal_msg_data_exclusive_;
1283 static LogMessageData fatal_msg_data_shared_;
1285 LogMessageData* allocated_;
1286 LogMessageData* data_;
1288 friend class LogDestination;
1290 LogMessage(const LogMessage&);
1291 void operator=(const LogMessage&);
1294 // This class happens to be thread-hostile because all instances share
1295 // a single data buffer, but since it can only be created just before
1296 // the process dies, we don't worry so much.
1297 class GOOGLE_GLOG_DLL_DECL LogMessageFatal : public LogMessage {
1299 LogMessageFatal(const char* file, int line);
1300 LogMessageFatal(const char* file, int line, const CheckOpString& result);
1301 ~LogMessageFatal() ;
1304 // A non-macro interface to the log facility; (useful
1305 // when the logging level is not a compile-time constant).
1306 inline void LogAtLevel(int const severity, std::string const &msg) {
1307 LogMessage(__FILE__, __LINE__, severity).stream() << msg;
1310 // A macro alternative of LogAtLevel. New code may want to use this
1311 // version since there are two advantages: 1. this version outputs the
1312 // file name and the line number where this macro is put like other
1313 // LOG macros, 2. this macro can be used as C++ stream.
1314 #define LOG_AT_LEVEL(severity) google::LogMessage(__FILE__, __LINE__, severity).stream()
1316 // A small helper for CHECK_NOTNULL().
1317 template <typename T>
1318 T* CheckNotNull(const char *file, int line, const char *names, T* t) {
1320 LogMessageFatal(file, line, new std::string(names));
1325 // Allow folks to put a counter in the LOG_EVERY_X()'ed messages. This
1326 // only works if ostream is a LogStream. If the ostream is not a
1327 // LogStream you'll get an assert saying as much at runtime.
1328 GOOGLE_GLOG_DLL_DECL std::ostream& operator<<(std::ostream &os,
1329 const PRIVATE_Counter&);
1332 // Derived class for PLOG*() above.
1333 class GOOGLE_GLOG_DLL_DECL ErrnoLogMessage : public LogMessage {
1336 ErrnoLogMessage(const char* file, int line, LogSeverity severity, int ctr,
1337 void (LogMessage::*send_method)());
1339 // Postpends ": strerror(errno) [errno]".
1343 ErrnoLogMessage(const ErrnoLogMessage&);
1344 void operator=(const ErrnoLogMessage&);
1348 // This class is used to explicitly ignore values in the conditional
1349 // logging macros. This avoids compiler warnings like "value computed
1350 // is not used" and "statement has no effect".
1352 class GOOGLE_GLOG_DLL_DECL LogMessageVoidify {
1354 LogMessageVoidify() { }
1355 // This has to be an operator with a precedence lower than << but
1357 void operator&(std::ostream&) { }
1361 // Flushes all log files that contains messages that are at least of
1362 // the specified severity level. Thread-safe.
1363 GOOGLE_GLOG_DLL_DECL void FlushLogFiles(LogSeverity min_severity);
1365 // Flushes all log files that contains messages that are at least of
1366 // the specified severity level. Thread-hostile because it ignores
1367 // locking -- used for catastrophic failures.
1368 GOOGLE_GLOG_DLL_DECL void FlushLogFilesUnsafe(LogSeverity min_severity);
1371 // Set the destination to which a particular severity level of log
1372 // messages is sent. If base_filename is "", it means "don't log this
1373 // severity". Thread-safe.
1375 GOOGLE_GLOG_DLL_DECL void SetLogDestination(LogSeverity severity,
1376 const char* base_filename);
1379 // Set the basename of the symlink to the latest log file at a given
1380 // severity. If symlink_basename is empty, do not make a symlink. If
1381 // you don't call this function, the symlink basename is the
1382 // invocation name of the program. Thread-safe.
1384 GOOGLE_GLOG_DLL_DECL void SetLogSymlink(LogSeverity severity,
1385 const char* symlink_basename);
1388 // Used to send logs to some other kind of destination
1389 // Users should subclass LogSink and override send to do whatever they want.
1390 // Implementations must be thread-safe because a shared instance will
1391 // be called from whichever thread ran the LOG(XXX) line.
1392 class GOOGLE_GLOG_DLL_DECL LogSink {
1396 // Sink's logging logic (message_len is such as to exclude '\n' at the end).
1397 // This method can't use LOG() or CHECK() as logging system mutex(s) are held
1398 // during this call.
1399 virtual void send(LogSeverity severity, const char* full_filename,
1400 const char* base_filename, int line,
1401 const struct ::tm* tm_time,
1402 const char* message, size_t message_len) = 0;
1404 // Redefine this to implement waiting for
1405 // the sink's logging logic to complete.
1406 // It will be called after each send() returns,
1407 // but before that LogMessage exits or crashes.
1408 // By default this function does nothing.
1409 // Using this function one can implement complex logic for send()
1410 // that itself involves logging; and do all this w/o causing deadlocks and
1411 // inconsistent rearrangement of log messages.
1412 // E.g. if a LogSink has thread-specific actions, the send() method
1413 // can simply add the message to a queue and wake up another thread that
1414 // handles real logging while itself making some LOG() calls;
1415 // WaitTillSent() can be implemented to wait for that logic to complete.
1416 // See our unittest for an example.
1417 virtual void WaitTillSent();
1419 // Returns the normal text output of the log message.
1420 // Can be useful to implement send().
1421 static std::string ToString(LogSeverity severity, const char* file, int line,
1422 const struct ::tm* tm_time,
1423 const char* message, size_t message_len);
1426 // Add or remove a LogSink as a consumer of logging data. Thread-safe.
1427 GOOGLE_GLOG_DLL_DECL void AddLogSink(LogSink *destination);
1428 GOOGLE_GLOG_DLL_DECL void RemoveLogSink(LogSink *destination);
1431 // Specify an "extension" added to the filename specified via
1432 // SetLogDestination. This applies to all severity levels. It's
1433 // often used to append the port we're listening on to the logfile
1434 // name. Thread-safe.
1436 GOOGLE_GLOG_DLL_DECL void SetLogFilenameExtension(
1437 const char* filename_extension);
1440 // Make it so that all log messages of at least a particular severity
1441 // are logged to stderr (in addition to logging to the usual log
1442 // file(s)). Thread-safe.
1444 GOOGLE_GLOG_DLL_DECL void SetStderrLogging(LogSeverity min_severity);
1447 // Make it so that all log messages go only to stderr. Thread-safe.
1449 GOOGLE_GLOG_DLL_DECL void LogToStderr();
1452 // Make it so that all log messages of at least a particular severity are
1453 // logged via email to a list of addresses (in addition to logging to the
1454 // usual log file(s)). The list of addresses is just a string containing
1455 // the email addresses to send to (separated by spaces, say). Thread-safe.
1457 GOOGLE_GLOG_DLL_DECL void SetEmailLogging(LogSeverity min_severity,
1458 const char* addresses);
1460 // A simple function that sends email. dest is a commma-separated
1461 // list of addressess. Thread-safe.
1462 GOOGLE_GLOG_DLL_DECL bool SendEmail(const char *dest,
1463 const char *subject, const char *body);
1465 GOOGLE_GLOG_DLL_DECL const std::vector<std::string>& GetLoggingDirectories();
1467 // For tests only: Clear the internal [cached] list of logging directories to
1468 // force a refresh the next time GetLoggingDirectories is called.
1470 void TestOnly_ClearLoggingDirectoriesList();
1472 // Returns a set of existing temporary directories, which will be a
1473 // subset of the directories returned by GetLogginDirectories().
1475 GOOGLE_GLOG_DLL_DECL void GetExistingTempDirectories(
1476 std::vector<std::string>* list);
1478 // Print any fatal message again -- useful to call from signal handler
1479 // so that the last thing in the output is the fatal message.
1480 // Thread-hostile, but a race is unlikely.
1481 GOOGLE_GLOG_DLL_DECL void ReprintFatalMessage();
1483 // Truncate a log file that may be the append-only output of multiple
1484 // processes and hence can't simply be renamed/reopened (typically a
1485 // stdout/stderr). If the file "path" is > "limit" bytes, copy the
1486 // last "keep" bytes to offset 0 and truncate the rest. Since we could
1487 // be racing with other writers, this approach has the potential to
1488 // lose very small amounts of data. For security, only follow symlinks
1489 // if the path is /proc/self/fd/*
1490 GOOGLE_GLOG_DLL_DECL void TruncateLogFile(const char *path,
1491 int64 limit, int64 keep);
1493 // Truncate stdout and stderr if they are over the value specified by
1494 // --max_log_size; keep the final 1MB. This function has the same
1495 // race condition as TruncateLogFile.
1496 GOOGLE_GLOG_DLL_DECL void TruncateStdoutStderr();
1498 // Return the string representation of the provided LogSeverity level.
1500 GOOGLE_GLOG_DLL_DECL const char* GetLogSeverityName(LogSeverity severity);
1502 // ---------------------------------------------------------------------
1503 // Implementation details that are not useful to most clients
1504 // ---------------------------------------------------------------------
1506 // A Logger is the interface used by logging modules to emit entries
1507 // to a log. A typical implementation will dump formatted data to a
1508 // sequence of files. We also provide interfaces that will forward
1509 // the data to another thread so that the invoker never blocks.
1510 // Implementations should be thread-safe since the logging system
1511 // will write to them from multiple threads.
1515 class GOOGLE_GLOG_DLL_DECL Logger {
1519 // Writes "message[0,message_len-1]" corresponding to an event that
1520 // occurred at "timestamp". If "force_flush" is true, the log file
1521 // is flushed immediately.
1523 // The input message has already been formatted as deemed
1524 // appropriate by the higher level logging facility. For example,
1525 // textual log messages already contain timestamps, and the
1526 // file:linenumber header.
1527 virtual void Write(bool force_flush,
1529 const char* message,
1530 int message_len) = 0;
1532 // Flush any buffered messages
1533 virtual void Flush() = 0;
1535 // Get the current LOG file size.
1536 // The returned value is approximate since some
1537 // logged data may not have been flushed to disk yet.
1538 virtual uint32 LogSize() = 0;
1541 // Get the logger for the specified severity level. The logger
1542 // remains the property of the logging module and should not be
1543 // deleted by the caller. Thread-safe.
1544 extern GOOGLE_GLOG_DLL_DECL Logger* GetLogger(LogSeverity level);
1546 // Set the logger for the specified severity level. The logger
1547 // becomes the property of the logging module and should not
1548 // be deleted by the caller. Thread-safe.
1549 extern GOOGLE_GLOG_DLL_DECL void SetLogger(LogSeverity level, Logger* logger);
1553 // glibc has traditionally implemented two incompatible versions of
1554 // strerror_r(). There is a poorly defined convention for picking the
1555 // version that we want, but it is not clear whether it even works with
1556 // all versions of glibc.
1557 // So, instead, we provide this wrapper that automatically detects the
1558 // version that is in use, and then implements POSIX semantics.
1559 // N.B. In addition to what POSIX says, we also guarantee that "buf" will
1560 // be set to an empty string, if this function failed. This means, in most
1561 // cases, you do not need to check the error code and you can directly
1562 // use the value of "buf". It will never have an undefined value.
1563 GOOGLE_GLOG_DLL_DECL int posix_strerror_r(int err, char *buf, size_t len);
1566 // A class for which we define operator<<, which does nothing.
1567 class GOOGLE_GLOG_DLL_DECL NullStream : public LogMessage::LogStream {
1569 // Initialize the LogStream so the messages can be written somewhere
1570 // (they'll never be actually displayed). This will be needed if a
1571 // NullStream& is implicitly converted to LogStream&, in which case
1572 // the overloaded NullStream::operator<< will not be invoked.
1573 NullStream() : LogMessage::LogStream(message_buffer_, 1, 0) { }
1574 NullStream(const char* /*file*/, int /*line*/,
1575 const CheckOpString& /*result*/) :
1576 LogMessage::LogStream(message_buffer_, 1, 0) { }
1577 NullStream &stream() { return *this; }
1579 // A very short buffer for messages (which we discard anyway). This
1580 // will be needed if NullStream& converted to LogStream& (e.g. as a
1581 // result of a conditional expression).
1582 char message_buffer_[2];
1585 // Do nothing. This operator is inline, allowing the message to be
1586 // compiled away. The message will not be compiled away if we do
1587 // something like (flag ? LOG(INFO) : LOG(ERROR)) << message; when
1588 // SKIP_LOG=WARNING. In those cases, NullStream will be implicitly
1589 // converted to LogStream and the message will be computed and then
1590 // quietly discarded.
1592 inline NullStream& operator<<(NullStream &str, const T &) { return str; }
1594 // Similar to NullStream, but aborts the program (without stack
1595 // trace), like LogMessageFatal.
1596 class GOOGLE_GLOG_DLL_DECL NullStreamFatal : public NullStream {
1598 NullStreamFatal() { }
1599 NullStreamFatal(const char* file, int line, const CheckOpString& result) :
1600 NullStream(file, line, result) { }
1601 ~NullStreamFatal() { _exit(1); }
1604 // Install a signal handler that will dump signal information and a stack
1605 // trace when the program crashes on certain signals. We'll install the
1606 // signal handler for the following signals.
1608 // SIGSEGV, SIGILL, SIGFPE, SIGABRT, SIGBUS, and SIGTERM.
1610 // By default, the signal handler will write the failure dump to the
1611 // standard error. You can customize the destination by installing your
1612 // own writer function by InstallFailureWriter() below.
1614 // Note on threading:
1616 // The function should be called before threads are created, if you want
1617 // to use the failure signal handler for all threads. The stack trace
1618 // will be shown only for the thread that receives the signal. In other
1619 // words, stack traces of other threads won't be shown.
1620 GOOGLE_GLOG_DLL_DECL void InstallFailureSignalHandler();
1622 // Installs a function that is used for writing the failure dump. "data"
1623 // is the pointer to the beginning of a message to be written, and "size"
1624 // is the size of the message. You should not expect the data is
1625 // terminated with '\0'.
1626 GOOGLE_GLOG_DLL_DECL void InstallFailureWriter(
1627 void (*writer)(const char* data, int size));
1631 #endif // _LOGGING_H_