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.
56 #define GLOG_MSVC_PUSH_DISABLE_WARNING(n) __pragma(warning(push)) \
57 __pragma(warning(disable:n))
58 #define GLOG_MSVC_POP_WARNING() __pragma(warning(pop))
60 #define GLOG_MSVC_PUSH_DISABLE_WARNING(n)
61 #define GLOG_MSVC_POP_WARNING()
64 // Annoying stuff for windows -- makes sure clients can import these functions
65 #ifndef GOOGLE_GLOG_DLL_DECL
66 # if defined(_WIN32) && !defined(__CYGWIN__)
67 # define GOOGLE_GLOG_DLL_DECL __declspec(dllimport)
69 # define GOOGLE_GLOG_DLL_DECL
73 // We care a lot about number of bits things take up. Unfortunately,
74 // systems define their bit-specific ints in a lot of different ways.
75 // We use our own way, and have a typedef to get there.
76 // Note: these commands below may look like "#if 1" or "#if 0", but
77 // that's because they were constructed that way at ./configure time.
78 // Look at logging.h.in to see how they're calculated (based on your config).
80 #include <stdint.h> // the normal place uint16_t is defined
83 #include <sys/types.h> // the normal place u_int16_t is defined
86 #include <inttypes.h> // a third place for uint16_t or u_int16_t
90 #include <gflags/gflags.h>
95 #if 0 // the C99 format
96 typedef int32_t int32;
97 typedef uint32_t uint32;
98 typedef int64_t int64;
99 typedef uint64_t uint64;
100 #elif 0 // the BSD format
101 typedef int32_t int32;
102 typedef u_int32_t uint32;
103 typedef int64_t int64;
104 typedef u_int64_t uint64;
105 #elif 1 // the windows (vc7) format
106 typedef __int32 int32;
107 typedef unsigned __int32 uint32;
108 typedef __int64 int64;
109 typedef unsigned __int64 uint64;
111 #error Do not know how to define a 32-bit integer quantity on your system
116 // The global value of GOOGLE_STRIP_LOG. All the messages logged to
117 // LOG(XXX) with severity less than GOOGLE_STRIP_LOG will not be displayed.
118 // If it can be determined at compile time that the message will not be
119 // printed, the statement will be compiled out.
121 // Example: to strip out all INFO and WARNING messages, use the value
122 // of 2 below. To make an exception for WARNING messages from a single
123 // file, add "#define GOOGLE_STRIP_LOG 1" to that file _before_ including
125 #ifndef GOOGLE_STRIP_LOG
126 #define GOOGLE_STRIP_LOG 0
129 // GCC can be told that a certain branch is not likely to be taken (for
130 // instance, a CHECK failure), and use that information in static analysis.
131 // Giving it this information can help it optimize for the common case in
132 // the absence of better information (ie. -fprofile-arcs).
134 #ifndef GOOGLE_PREDICT_BRANCH_NOT_TAKEN
136 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) (__builtin_expect(x, 0))
138 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) x
142 #ifndef GOOGLE_PREDICT_FALSE
144 #define GOOGLE_PREDICT_FALSE(x) (__builtin_expect(x, 0))
146 #define GOOGLE_PREDICT_FALSE(x) x
150 #ifndef GOOGLE_PREDICT_TRUE
152 #define GOOGLE_PREDICT_TRUE(x) (__builtin_expect(!!(x), 1))
154 #define GOOGLE_PREDICT_TRUE(x) x
159 // Make a bunch of macros for logging. The way to log things is to stream
160 // things to LOG(<a particular severity level>). E.g.,
162 // LOG(INFO) << "Found " << num_cookies << " cookies";
164 // You can capture log messages in a string, rather than reporting them
167 // vector<string> errors;
168 // LOG_STRING(ERROR, &errors) << "Couldn't parse cookie #" << cookie_num;
170 // This pushes back the new error onto 'errors'; if given a NULL pointer,
171 // it reports the error via LOG(ERROR).
173 // You can also do conditional logging:
175 // LOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
177 // You can also do occasional logging (log every n'th occurrence of an
180 // LOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
182 // The above will cause log messages to be output on the 1st, 11th, 21st, ...
183 // times it is executed. Note that the special google::COUNTER value is used
184 // to identify which repetition is happening.
186 // You can also do occasional conditional logging (log every n'th
187 // occurrence of an event, when condition is satisfied):
189 // LOG_IF_EVERY_N(INFO, (size > 1024), 10) << "Got the " << google::COUNTER
190 // << "th big cookie";
192 // You can log messages the first N times your code executes a line. E.g.
194 // LOG_FIRST_N(INFO, 20) << "Got the " << google::COUNTER << "th cookie";
196 // Outputs log messages for the first 20 times it is executed.
198 // Analogous SYSLOG, SYSLOG_IF, and SYSLOG_EVERY_N macros are available.
199 // These log to syslog as well as to the normal logs. If you use these at
200 // all, you need to be aware that syslog can drastically reduce performance,
201 // especially if it is configured for remote logging! Don't use these
202 // unless you fully understand this and have a concrete need to use them.
203 // Even then, try to minimize your use of them.
205 // There are also "debug mode" logging macros like the ones above:
207 // DLOG(INFO) << "Found cookies";
209 // DLOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
211 // DLOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
213 // All "debug mode" logging is compiled away to nothing for non-debug mode
218 // LOG_ASSERT(assertion);
219 // DLOG_ASSERT(assertion);
221 // which is syntactic sugar for {,D}LOG_IF(FATAL, assert fails) << assertion;
223 // There are "verbose level" logging macros. They look like
225 // VLOG(1) << "I'm printed when you run the program with --v=1 or more";
226 // VLOG(2) << "I'm printed when you run the program with --v=2 or more";
228 // These always log at the INFO log level (when they log at all).
229 // The verbose logging can also be turned on module-by-module. For instance,
230 // --vmodule=mapreduce=2,file=1,gfs*=3 --v=0
232 // a. VLOG(2) and lower messages to be printed from mapreduce.{h,cc}
233 // b. VLOG(1) and lower messages to be printed from file.{h,cc}
234 // c. VLOG(3) and lower messages to be printed from files prefixed with "gfs"
235 // d. VLOG(0) and lower messages to be printed from elsewhere
237 // The wildcarding functionality shown by (c) supports both '*' (match
238 // 0 or more characters) and '?' (match any single character) wildcards.
240 // There's also VLOG_IS_ON(n) "verbose level" condition macro. To be used as
242 // if (VLOG_IS_ON(2)) {
243 // // do some logging preparation and logging
244 // // that can't be accomplished with just VLOG(2) << ...;
247 // There are also VLOG_IF, VLOG_EVERY_N and VLOG_IF_EVERY_N "verbose level"
248 // condition macros for sample cases, when some extra computation and
249 // preparation for logs is not needed.
250 // VLOG_IF(1, (size > 1024))
251 // << "I'm printed when size is more than 1024 and when you run the "
252 // "program with --v=1 or more";
253 // VLOG_EVERY_N(1, 10)
254 // << "I'm printed every 10th occurrence, and when you run the program "
255 // "with --v=1 or more. Present occurence is " << google::COUNTER;
256 // VLOG_IF_EVERY_N(1, (size > 1024), 10)
257 // << "I'm printed on every 10th occurence of case when size is more "
258 // " than 1024, when you run the program with --v=1 or more. ";
259 // "Present occurence is " << google::COUNTER;
261 // The supported severity levels for macros that allow you to specify one
262 // are (in increasing order of severity) INFO, WARNING, ERROR, and FATAL.
263 // Note that messages of a given severity are logged not only in the
264 // logfile for that severity, but also in all logfiles of lower severity.
265 // E.g., a message of severity FATAL will be logged to the logfiles of
266 // severity FATAL, ERROR, WARNING, and INFO.
268 // There is also the special severity of DFATAL, which logs FATAL in
269 // debug mode, ERROR in normal mode.
271 // Very important: logging a message at the FATAL severity level causes
272 // the program to terminate (after the message is logged).
274 // Unless otherwise specified, logs will be written to the filename
275 // "<program name>.<hostname>.<user name>.log.<severity level>.", followed
276 // by the date, time, and pid (you can't prevent the date, time, and pid
277 // from being in the filename).
279 // The logging code takes two flags:
280 // --v=# set the verbose level
281 // --logtostderr log all the messages to stderr instead of to logfiles
283 // LOG LINE PREFIX FORMAT
285 // Log lines have this form:
287 // Lmmdd hh:mm:ss.uuuuuu threadid file:line] msg...
289 // where the fields are defined as follows:
291 // L A single character, representing the log level
293 // mm The month (zero padded; ie May is '05')
294 // dd The day (zero padded)
295 // hh:mm:ss.uuuuuu Time in hours, minutes and fractional seconds
296 // threadid The space-padded thread ID as returned by GetTID()
297 // (this matches the PID on Linux)
298 // file The file name
299 // line The line number
300 // msg The user-supplied message
304 // I1103 11:57:31.739339 24395 google.cc:2341] Command line: ./some_prog
305 // I1103 11:57:31.739403 24395 google.cc:2342] Process id 24395
307 // NOTE: although the microseconds are useful for comparing events on
308 // a single machine, clocks on different machines may not be well
309 // synchronized. Hence, use caution when comparing the low bits of
310 // timestamps from different machines.
312 #ifndef DECLARE_VARIABLE
313 #define MUST_UNDEF_GFLAGS_DECLARE_MACROS
314 #define DECLARE_VARIABLE(type, shorttype, name, tn) \
315 namespace fL##shorttype { \
316 extern GOOGLE_GLOG_DLL_DECL type FLAGS_##name; \
318 using fL##shorttype::FLAGS_##name
320 // bool specialization
321 #define DECLARE_bool(name) \
322 DECLARE_VARIABLE(bool, B, name, bool)
324 // int32 specialization
325 #define DECLARE_int32(name) \
326 DECLARE_VARIABLE(google::int32, I, name, int32)
328 // Special case for string, because we have to specify the namespace
329 // std::string, which doesn't play nicely with our FLAG__namespace hackery.
330 #define DECLARE_string(name) \
332 extern GOOGLE_GLOG_DLL_DECL std::string& FLAGS_##name; \
334 using fLS::FLAGS_##name
337 // Set whether log messages go to stderr instead of logfiles
338 DECLARE_bool(logtostderr);
340 // Set whether log messages go to stderr in addition to logfiles.
341 DECLARE_bool(alsologtostderr);
343 // Set color messages logged to stderr (if supported by terminal).
344 DECLARE_bool(colorlogtostderr);
346 // Log messages at a level >= this flag are automatically sent to
347 // stderr in addition to log files.
348 DECLARE_int32(stderrthreshold);
350 // Set whether the log prefix should be prepended to each line of output.
351 DECLARE_bool(log_prefix);
353 // Log messages at a level <= this flag are buffered.
354 // Log messages at a higher level are flushed immediately.
355 DECLARE_int32(logbuflevel);
357 // Sets the maximum number of seconds which logs may be buffered for.
358 DECLARE_int32(logbufsecs);
360 // Log suppression level: messages logged at a lower level than this
362 DECLARE_int32(minloglevel);
364 // If specified, logfiles are written into this directory instead of the
365 // default logging directory.
366 DECLARE_string(log_dir);
368 // Set the log file mode.
369 DECLARE_int32(logfile_mode);
371 // Sets the path of the directory into which to put additional links
373 DECLARE_string(log_link);
375 DECLARE_int32(v); // in vlog_is_on.cc
377 // Sets the maximum log file size (in MB).
378 DECLARE_int32(max_log_size);
380 // Sets whether to avoid logging to the disk if the disk is full.
381 DECLARE_bool(stop_logging_if_full_disk);
383 #ifdef MUST_UNDEF_GFLAGS_DECLARE_MACROS
384 #undef MUST_UNDEF_GFLAGS_DECLARE_MACROS
385 #undef DECLARE_VARIABLE
388 #undef DECLARE_string
391 // Log messages below the GOOGLE_STRIP_LOG level will be compiled away for
392 // security reasons. See LOG(severtiy) below.
394 // A few definitions of macros that don't generate much code. Since
395 // LOG(INFO) and its ilk are used all over our code, it's
396 // better to have compact code for these operations.
398 #if GOOGLE_STRIP_LOG == 0
399 #define COMPACT_GOOGLE_LOG_INFO google::LogMessage( \
401 #define LOG_TO_STRING_INFO(message) google::LogMessage( \
402 __FILE__, __LINE__, google::GLOG_INFO, message)
404 #define COMPACT_GOOGLE_LOG_INFO google::NullStream()
405 #define LOG_TO_STRING_INFO(message) google::NullStream()
408 #if GOOGLE_STRIP_LOG <= 1
409 #define COMPACT_GOOGLE_LOG_WARNING google::LogMessage( \
410 __FILE__, __LINE__, google::GLOG_WARNING)
411 #define LOG_TO_STRING_WARNING(message) google::LogMessage( \
412 __FILE__, __LINE__, google::GLOG_WARNING, message)
414 #define COMPACT_GOOGLE_LOG_WARNING google::NullStream()
415 #define LOG_TO_STRING_WARNING(message) google::NullStream()
418 #if GOOGLE_STRIP_LOG <= 2
419 #define COMPACT_GOOGLE_LOG_ERROR google::LogMessage( \
420 __FILE__, __LINE__, google::GLOG_ERROR)
421 #define LOG_TO_STRING_ERROR(message) google::LogMessage( \
422 __FILE__, __LINE__, google::GLOG_ERROR, message)
424 #define COMPACT_GOOGLE_LOG_ERROR google::NullStream()
425 #define LOG_TO_STRING_ERROR(message) google::NullStream()
428 #if GOOGLE_STRIP_LOG <= 3
429 #define COMPACT_GOOGLE_LOG_FATAL google::LogMessageFatal( \
431 #define LOG_TO_STRING_FATAL(message) google::LogMessage( \
432 __FILE__, __LINE__, google::GLOG_FATAL, message)
434 #define COMPACT_GOOGLE_LOG_FATAL google::NullStreamFatal()
435 #define LOG_TO_STRING_FATAL(message) google::NullStreamFatal()
438 #if defined(NDEBUG) && !defined(DCHECK_ALWAYS_ON)
439 #define DCHECK_IS_ON() 0
441 #define DCHECK_IS_ON() 1
444 // For DFATAL, we want to use LogMessage (as opposed to
445 // LogMessageFatal), to be consistent with the original behavior.
447 #define COMPACT_GOOGLE_LOG_DFATAL COMPACT_GOOGLE_LOG_ERROR
448 #elif GOOGLE_STRIP_LOG <= 3
449 #define COMPACT_GOOGLE_LOG_DFATAL google::LogMessage( \
450 __FILE__, __LINE__, google::GLOG_FATAL)
452 #define COMPACT_GOOGLE_LOG_DFATAL google::NullStreamFatal()
455 #define GOOGLE_LOG_INFO(counter) google::LogMessage(__FILE__, __LINE__, google::GLOG_INFO, counter, &google::LogMessage::SendToLog)
456 #define SYSLOG_INFO(counter) \
457 google::LogMessage(__FILE__, __LINE__, google::GLOG_INFO, counter, \
458 &google::LogMessage::SendToSyslogAndLog)
459 #define GOOGLE_LOG_WARNING(counter) \
460 google::LogMessage(__FILE__, __LINE__, google::GLOG_WARNING, counter, \
461 &google::LogMessage::SendToLog)
462 #define SYSLOG_WARNING(counter) \
463 google::LogMessage(__FILE__, __LINE__, google::GLOG_WARNING, counter, \
464 &google::LogMessage::SendToSyslogAndLog)
465 #define GOOGLE_LOG_ERROR(counter) \
466 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, counter, \
467 &google::LogMessage::SendToLog)
468 #define SYSLOG_ERROR(counter) \
469 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, counter, \
470 &google::LogMessage::SendToSyslogAndLog)
471 #define GOOGLE_LOG_FATAL(counter) \
472 google::LogMessage(__FILE__, __LINE__, google::GLOG_FATAL, counter, \
473 &google::LogMessage::SendToLog)
474 #define SYSLOG_FATAL(counter) \
475 google::LogMessage(__FILE__, __LINE__, google::GLOG_FATAL, counter, \
476 &google::LogMessage::SendToSyslogAndLog)
477 #define GOOGLE_LOG_DFATAL(counter) \
478 google::LogMessage(__FILE__, __LINE__, google::DFATAL_LEVEL, counter, \
479 &google::LogMessage::SendToLog)
480 #define SYSLOG_DFATAL(counter) \
481 google::LogMessage(__FILE__, __LINE__, google::DFATAL_LEVEL, counter, \
482 &google::LogMessage::SendToSyslogAndLog)
484 #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
485 // A very useful logging macro to log windows errors:
486 #define LOG_SYSRESULT(result) \
487 if (FAILED(HRESULT_FROM_WIN32(result))) { \
488 LPSTR message = NULL; \
489 LPSTR msg = reinterpret_cast<LPSTR>(&message); \
490 DWORD message_length = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | \
491 FORMAT_MESSAGE_FROM_SYSTEM, \
492 0, result, 0, msg, 100, NULL); \
493 if (message_length > 0) { \
494 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, 0, \
495 &google::LogMessage::SendToLog).stream() \
496 << reinterpret_cast<const char*>(message); \
497 LocalFree(message); \
502 // We use the preprocessor's merging operator, "##", so that, e.g.,
503 // LOG(INFO) becomes the token GOOGLE_LOG_INFO. There's some funny
504 // subtle difference between ostream member streaming functions (e.g.,
505 // ostream::operator<<(int) and ostream non-member streaming functions
506 // (e.g., ::operator<<(ostream&, string&): it turns out that it's
507 // impossible to stream something like a string directly to an unnamed
508 // ostream. We employ a neat hack by calling the stream() member
509 // function of LogMessage which seems to avoid the problem.
510 #define LOG(severity) COMPACT_GOOGLE_LOG_ ## severity.stream()
511 #define SYSLOG(severity) SYSLOG_ ## severity(0).stream()
515 // They need the definitions of integer types.
516 #include "glog/log_severity.h"
517 #include "glog/vlog_is_on.h"
519 // Initialize google's logging library. You will see the program name
520 // specified by argv0 in log outputs.
521 GOOGLE_GLOG_DLL_DECL void InitGoogleLogging(const char* argv0);
523 // Shutdown google's logging library.
524 GOOGLE_GLOG_DLL_DECL void ShutdownGoogleLogging();
526 // Install a function which will be called after LOG(FATAL).
527 GOOGLE_GLOG_DLL_DECL void InstallFailureFunction(void (*fail_func)());
529 class LogSink; // defined below
531 // If a non-NULL sink pointer is given, we push this message to that sink.
532 // For LOG_TO_SINK we then do normal LOG(severity) logging as well.
533 // This is useful for capturing messages and passing/storing them
534 // somewhere more specific than the global log of the process.
537 // LogSeverity severity;
538 // The cast is to disambiguate NULL arguments.
539 #define LOG_TO_SINK(sink, severity) \
540 google::LogMessage( \
541 __FILE__, __LINE__, \
542 google::GLOG_ ## severity, \
543 static_cast<google::LogSink*>(sink), true).stream()
544 #define LOG_TO_SINK_BUT_NOT_TO_LOGFILE(sink, severity) \
545 google::LogMessage( \
546 __FILE__, __LINE__, \
547 google::GLOG_ ## severity, \
548 static_cast<google::LogSink*>(sink), false).stream()
550 // If a non-NULL string pointer is given, we write this message to that string.
551 // We then do normal LOG(severity) logging as well.
552 // This is useful for capturing messages and storing them somewhere more
553 // specific than the global log of the process.
556 // LogSeverity severity;
557 // The cast is to disambiguate NULL arguments.
558 // NOTE: LOG(severity) expands to LogMessage().stream() for the specified
560 #define LOG_TO_STRING(severity, message) \
561 LOG_TO_STRING_##severity(static_cast<string*>(message)).stream()
563 // If a non-NULL pointer is given, we push the message onto the end
564 // of a vector of strings; otherwise, we report it with LOG(severity).
565 // This is handy for capturing messages and perhaps passing them back
566 // to the caller, rather than reporting them immediately.
568 // LogSeverity severity;
569 // vector<string> *outvec;
570 // The cast is to disambiguate NULL arguments.
571 #define LOG_STRING(severity, outvec) \
572 LOG_TO_STRING_##severity(static_cast<std::vector<std::string>*>(outvec)).stream()
574 #define LOG_IF(severity, condition) \
575 !(condition) ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
576 #define SYSLOG_IF(severity, condition) \
577 !(condition) ? (void) 0 : google::LogMessageVoidify() & SYSLOG(severity)
579 #define LOG_ASSERT(condition) \
580 LOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
581 #define SYSLOG_ASSERT(condition) \
582 SYSLOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
584 // CHECK dies with a fatal error if condition is not true. It is *not*
585 // controlled by DCHECK_IS_ON(), so the check will be executed regardless of
586 // compilation mode. Therefore, it is safe to do things like:
587 // CHECK(fp->Write(x) == 4)
588 #define CHECK(condition) \
589 LOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
590 << "Check failed: " #condition " "
592 // A container for a string pointer which can be evaluated to a bool -
593 // true iff the pointer is NULL.
594 struct CheckOpString {
595 CheckOpString(std::string* str) : str_(str) { }
596 // No destructor: if str_ is non-NULL, we're about to LOG(FATAL),
597 // so there's no point in cleaning up str_.
598 operator bool() const {
599 return GOOGLE_PREDICT_BRANCH_NOT_TAKEN(str_ != NULL);
604 // Function is overloaded for integral types to allow static const
605 // integrals declared in classes and not defined to be used as arguments to
606 // CHECK* macros. It's not encouraged though.
608 inline const T& GetReferenceableValue(const T& t) { return t; }
609 inline char GetReferenceableValue(char t) { return t; }
610 inline unsigned char GetReferenceableValue(unsigned char t) { return t; }
611 inline signed char GetReferenceableValue(signed char t) { return t; }
612 inline short GetReferenceableValue(short t) { return t; }
613 inline unsigned short GetReferenceableValue(unsigned short t) { return t; }
614 inline int GetReferenceableValue(int t) { return t; }
615 inline unsigned int GetReferenceableValue(unsigned int t) { return t; }
616 inline long GetReferenceableValue(long t) { return t; }
617 inline unsigned long GetReferenceableValue(unsigned long t) { return t; }
618 inline long long GetReferenceableValue(long long t) { return t; }
619 inline unsigned long long GetReferenceableValue(unsigned long long t) {
623 // This is a dummy class to define the following operator.
624 struct DummyClassToDefineOperator {};
628 // Define global operator<< to declare using ::operator<<.
629 // This declaration will allow use to use CHECK macros for user
630 // defined classes which have operator<< (e.g., stl_logging.h).
631 inline std::ostream& operator<<(
632 std::ostream& out, const google::DummyClassToDefineOperator&) {
638 // This formats a value for a failing CHECK_XX statement. Ordinarily,
639 // it uses the definition for operator<<, with a few special cases below.
640 template <typename T>
641 inline void MakeCheckOpValueString(std::ostream* os, const T& v) {
645 // Overrides for char types provide readable values for unprintable
647 template <> GOOGLE_GLOG_DLL_DECL
648 void MakeCheckOpValueString(std::ostream* os, const char& v);
649 template <> GOOGLE_GLOG_DLL_DECL
650 void MakeCheckOpValueString(std::ostream* os, const signed char& v);
651 template <> GOOGLE_GLOG_DLL_DECL
652 void MakeCheckOpValueString(std::ostream* os, const unsigned char& v);
654 // Build the error message string. Specify no inlining for code size.
655 template <typename T1, typename T2>
656 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext)
662 // If "s" is less than base_logging::INFO, returns base_logging::INFO.
663 // If "s" is greater than base_logging::FATAL, returns
664 // base_logging::ERROR. Otherwise, returns "s".
665 LogSeverity NormalizeSeverity(LogSeverity s);
667 } // namespace internal
669 // A helper class for formatting "expr (V1 vs. V2)" in a CHECK_XX
670 // statement. See MakeCheckOpString for sample usage. Other
671 // approaches were considered: use of a template method (e.g.,
672 // base::BuildCheckOpString(exprtext, base::Print<T1>, &v1,
673 // base::Print<T2>, &v2), however this approach has complications
674 // related to volatile arguments and function-pointer arguments).
675 class GOOGLE_GLOG_DLL_DECL CheckOpMessageBuilder {
677 // Inserts "exprtext" and " (" to the stream.
678 explicit CheckOpMessageBuilder(const char *exprtext);
679 // Deletes "stream_".
680 ~CheckOpMessageBuilder();
681 // For inserting the first variable.
682 std::ostream* ForVar1() { return stream_; }
683 // For inserting the second variable (adds an intermediate " vs. ").
684 std::ostream* ForVar2();
685 // Get the result (inserts the closing ")").
686 std::string* NewString();
689 std::ostringstream *stream_;
694 template <typename T1, typename T2>
695 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext) {
696 base::CheckOpMessageBuilder comb(exprtext);
697 MakeCheckOpValueString(comb.ForVar1(), v1);
698 MakeCheckOpValueString(comb.ForVar2(), v2);
699 return comb.NewString();
702 // Helper functions for CHECK_OP macro.
703 // The (int, int) specialization works around the issue that the compiler
704 // will not instantiate the template version of the function on values of
705 // unnamed enum type - see comment below.
706 #define DEFINE_CHECK_OP_IMPL(name, op) \
707 template <typename T1, typename T2> \
708 inline std::string* name##Impl(const T1& v1, const T2& v2, \
709 const char* exprtext) { \
710 if (GOOGLE_PREDICT_TRUE(v1 op v2)) return NULL; \
711 else return MakeCheckOpString(v1, v2, exprtext); \
713 inline std::string* name##Impl(int v1, int v2, const char* exprtext) { \
714 return name##Impl<int, int>(v1, v2, exprtext); \
717 // We use the full name Check_EQ, Check_NE, etc. in case the file including
718 // base/logging.h provides its own #defines for the simpler names EQ, NE, etc.
719 // This happens if, for example, those are used as token names in a
721 DEFINE_CHECK_OP_IMPL(Check_EQ, ==) // Compilation error with CHECK_EQ(NULL, x)?
722 DEFINE_CHECK_OP_IMPL(Check_NE, !=) // Use CHECK(x == NULL) instead.
723 DEFINE_CHECK_OP_IMPL(Check_LE, <=)
724 DEFINE_CHECK_OP_IMPL(Check_LT, < )
725 DEFINE_CHECK_OP_IMPL(Check_GE, >=)
726 DEFINE_CHECK_OP_IMPL(Check_GT, > )
727 #undef DEFINE_CHECK_OP_IMPL
729 // Helper macro for binary operators.
730 // Don't use this macro directly in your code, use CHECK_EQ et al below.
732 #if defined(STATIC_ANALYSIS)
733 // Only for static analysis tool to know that it is equivalent to assert
734 #define CHECK_OP_LOG(name, op, val1, val2, log) CHECK((val1) op (val2))
736 // In debug mode, avoid constructing CheckOpStrings if possible,
737 // to reduce the overhead of CHECK statments by 2x.
738 // Real DCHECK-heavy tests have seen 1.5x speedups.
740 // The meaning of "string" might be different between now and
741 // when this macro gets invoked (e.g., if someone is experimenting
742 // with other string implementations that get defined after this
743 // file is included). Save the current meaning now and use it
745 typedef std::string _Check_string;
746 #define CHECK_OP_LOG(name, op, val1, val2, log) \
747 while (google::_Check_string* _result = \
748 google::Check##name##Impl( \
749 google::GetReferenceableValue(val1), \
750 google::GetReferenceableValue(val2), \
751 #val1 " " #op " " #val2)) \
752 log(__FILE__, __LINE__, \
753 google::CheckOpString(_result)).stream()
755 // In optimized mode, use CheckOpString to hint to compiler that
756 // the while condition is unlikely.
757 #define CHECK_OP_LOG(name, op, val1, val2, log) \
758 while (google::CheckOpString _result = \
759 google::Check##name##Impl( \
760 google::GetReferenceableValue(val1), \
761 google::GetReferenceableValue(val2), \
762 #val1 " " #op " " #val2)) \
763 log(__FILE__, __LINE__, _result).stream()
764 #endif // STATIC_ANALYSIS, DCHECK_IS_ON()
766 #if GOOGLE_STRIP_LOG <= 3
767 #define CHECK_OP(name, op, val1, val2) \
768 CHECK_OP_LOG(name, op, val1, val2, google::LogMessageFatal)
770 #define CHECK_OP(name, op, val1, val2) \
771 CHECK_OP_LOG(name, op, val1, val2, google::NullStreamFatal)
772 #endif // STRIP_LOG <= 3
774 // Equality/Inequality checks - compare two values, and log a FATAL message
775 // including the two values when the result is not as expected. The values
776 // must have operator<<(ostream, ...) defined.
778 // You may append to the error message like so:
779 // CHECK_NE(1, 2) << ": The world must be ending!";
781 // We are very careful to ensure that each argument is evaluated exactly
782 // once, and that anything which is legal to pass as a function argument is
783 // legal here. In particular, the arguments may be temporary expressions
784 // which will end up being destroyed at the end of the apparent statement,
786 // CHECK_EQ(string("abc")[1], 'b');
788 // WARNING: These don't compile correctly if one of the arguments is a pointer
789 // and the other is NULL. To work around this, simply static_cast NULL to the
790 // type of the desired pointer.
792 #define CHECK_EQ(val1, val2) CHECK_OP(_EQ, ==, val1, val2)
793 #define CHECK_NE(val1, val2) CHECK_OP(_NE, !=, val1, val2)
794 #define CHECK_LE(val1, val2) CHECK_OP(_LE, <=, val1, val2)
795 #define CHECK_LT(val1, val2) CHECK_OP(_LT, < , val1, val2)
796 #define CHECK_GE(val1, val2) CHECK_OP(_GE, >=, val1, val2)
797 #define CHECK_GT(val1, val2) CHECK_OP(_GT, > , val1, val2)
799 // Check that the input is non NULL. This very useful in constructor
800 // initializer lists.
802 #define CHECK_NOTNULL(val) \
803 google::CheckNotNull(__FILE__, __LINE__, "'" #val "' Must be non NULL", (val))
805 // Helper functions for string comparisons.
806 // To avoid bloat, the definitions are in logging.cc.
807 #define DECLARE_CHECK_STROP_IMPL(func, expected) \
808 GOOGLE_GLOG_DLL_DECL std::string* Check##func##expected##Impl( \
809 const char* s1, const char* s2, const char* names);
810 DECLARE_CHECK_STROP_IMPL(strcmp, true)
811 DECLARE_CHECK_STROP_IMPL(strcmp, false)
812 DECLARE_CHECK_STROP_IMPL(strcasecmp, true)
813 DECLARE_CHECK_STROP_IMPL(strcasecmp, false)
814 #undef DECLARE_CHECK_STROP_IMPL
816 // Helper macro for string comparisons.
817 // Don't use this macro directly in your code, use CHECK_STREQ et al below.
818 #define CHECK_STROP(func, op, expected, s1, s2) \
819 while (google::CheckOpString _result = \
820 google::Check##func##expected##Impl((s1), (s2), \
821 #s1 " " #op " " #s2)) \
822 LOG(FATAL) << *_result.str_
825 // String (char*) equality/inequality checks.
826 // CASE versions are case-insensitive.
828 // Note that "s1" and "s2" may be temporary strings which are destroyed
829 // by the compiler at the end of the current "full expression"
830 // (e.g. CHECK_STREQ(Foo().c_str(), Bar().c_str())).
832 #define CHECK_STREQ(s1, s2) CHECK_STROP(strcmp, ==, true, s1, s2)
833 #define CHECK_STRNE(s1, s2) CHECK_STROP(strcmp, !=, false, s1, s2)
834 #define CHECK_STRCASEEQ(s1, s2) CHECK_STROP(strcasecmp, ==, true, s1, s2)
835 #define CHECK_STRCASENE(s1, s2) CHECK_STROP(strcasecmp, !=, false, s1, s2)
837 #define CHECK_INDEX(I,A) CHECK(I < (sizeof(A)/sizeof(A[0])))
838 #define CHECK_BOUND(B,A) CHECK(B <= (sizeof(A)/sizeof(A[0])))
840 #define CHECK_DOUBLE_EQ(val1, val2) \
842 CHECK_LE((val1), (val2)+0.000000000000001L); \
843 CHECK_GE((val1), (val2)-0.000000000000001L); \
846 #define CHECK_NEAR(val1, val2, margin) \
848 CHECK_LE((val1), (val2)+(margin)); \
849 CHECK_GE((val1), (val2)-(margin)); \
852 // perror()..googly style!
854 // PLOG() and PLOG_IF() and PCHECK() behave exactly like their LOG* and
855 // CHECK equivalents with the addition that they postpend a description
856 // of the current state of errno to their output lines.
858 #define PLOG(severity) GOOGLE_PLOG(severity, 0).stream()
860 #define GOOGLE_PLOG(severity, counter) \
861 google::ErrnoLogMessage( \
862 __FILE__, __LINE__, google::GLOG_ ## severity, counter, \
863 &google::LogMessage::SendToLog)
865 #define PLOG_IF(severity, condition) \
866 !(condition) ? (void) 0 : google::LogMessageVoidify() & PLOG(severity)
868 // A CHECK() macro that postpends errno if the condition is false. E.g.
870 // if (poll(fds, nfds, timeout) == -1) { PCHECK(errno == EINTR); ... }
871 #define PCHECK(condition) \
872 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
873 << "Check failed: " #condition " "
875 // A CHECK() macro that lets you assert the success of a function that
876 // returns -1 and sets errno in case of an error. E.g.
878 // CHECK_ERR(mkdir(path, 0700));
882 // int fd = open(filename, flags); CHECK_ERR(fd) << ": open " << filename;
883 #define CHECK_ERR(invocation) \
884 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN((invocation) == -1)) \
887 // Use macro expansion to create, for each use of LOG_EVERY_N(), static
888 // variables with the __LINE__ expansion as part of the variable name.
889 #define LOG_EVERY_N_VARNAME(base, line) LOG_EVERY_N_VARNAME_CONCAT(base, line)
890 #define LOG_EVERY_N_VARNAME_CONCAT(base, line) base ## line
892 #define LOG_OCCURRENCES LOG_EVERY_N_VARNAME(occurrences_, __LINE__)
893 #define LOG_OCCURRENCES_MOD_N LOG_EVERY_N_VARNAME(occurrences_mod_n_, __LINE__)
895 #define SOME_KIND_OF_LOG_EVERY_N(severity, n, what_to_do) \
896 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
898 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
899 if (LOG_OCCURRENCES_MOD_N == 1) \
900 google::LogMessage( \
901 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
902 &what_to_do).stream()
904 #define SOME_KIND_OF_LOG_IF_EVERY_N(severity, condition, n, what_to_do) \
905 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
908 ((LOG_OCCURRENCES_MOD_N=(LOG_OCCURRENCES_MOD_N + 1) % n) == (1 % n))) \
909 google::LogMessage( \
910 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
911 &what_to_do).stream()
913 #define SOME_KIND_OF_PLOG_EVERY_N(severity, n, what_to_do) \
914 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
916 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
917 if (LOG_OCCURRENCES_MOD_N == 1) \
918 google::ErrnoLogMessage( \
919 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
920 &what_to_do).stream()
922 #define SOME_KIND_OF_LOG_FIRST_N(severity, n, what_to_do) \
923 static int LOG_OCCURRENCES = 0; \
924 if (LOG_OCCURRENCES <= n) \
926 if (LOG_OCCURRENCES <= n) \
927 google::LogMessage( \
928 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
929 &what_to_do).stream()
931 namespace glog_internal_namespace_ {
933 struct CompileAssert {
937 // Returns true if FailureSignalHandler is installed.
938 bool IsFailureSignalHandlerInstalled();
939 } // namespace glog_internal_namespace_
941 #define GOOGLE_GLOG_COMPILE_ASSERT(expr, msg) \
942 typedef google::glog_internal_namespace_::CompileAssert<(bool(expr))> msg[bool(expr) ? 1 : -1]
944 #define LOG_EVERY_N(severity, n) \
945 SOME_KIND_OF_LOG_EVERY_N(severity, (n), google::LogMessage::SendToLog)
947 #define SYSLOG_EVERY_N(severity, n) \
948 SOME_KIND_OF_LOG_EVERY_N(severity, (n), google::LogMessage::SendToSyslogAndLog)
950 #define PLOG_EVERY_N(severity, n) \
951 SOME_KIND_OF_PLOG_EVERY_N(severity, (n), google::LogMessage::SendToLog)
953 #define LOG_FIRST_N(severity, n) \
954 SOME_KIND_OF_LOG_FIRST_N(severity, (n), google::LogMessage::SendToLog)
956 #define LOG_IF_EVERY_N(severity, condition, n) \
957 SOME_KIND_OF_LOG_IF_EVERY_N(severity, (condition), (n), google::LogMessage::SendToLog)
959 // We want the special COUNTER value available for LOG_EVERY_X()'ed messages
960 enum PRIVATE_Counter {COUNTER};
962 #ifdef GLOG_NO_ABBREVIATED_SEVERITIES
963 // wingdi.h defines ERROR to be 0. When we call LOG(ERROR), it gets
964 // substituted with 0, and it expands to COMPACT_GOOGLE_LOG_0. To allow us
965 // to keep using this syntax, we define this macro to do the same thing
966 // as COMPACT_GOOGLE_LOG_ERROR.
967 #define COMPACT_GOOGLE_LOG_0 COMPACT_GOOGLE_LOG_ERROR
968 #define SYSLOG_0 SYSLOG_ERROR
969 #define LOG_TO_STRING_0 LOG_TO_STRING_ERROR
970 // Needed for LOG_IS_ON(ERROR).
971 const LogSeverity GLOG_0 = GLOG_ERROR;
973 // Users may include windows.h after logging.h without
974 // GLOG_NO_ABBREVIATED_SEVERITIES nor WIN32_LEAN_AND_MEAN.
975 // For this case, we cannot detect if ERROR is defined before users
976 // actually use ERROR. Let's make an undefined symbol to warn users.
977 # define GLOG_ERROR_MSG ERROR_macro_is_defined_Define_GLOG_NO_ABBREVIATED_SEVERITIES_before_including_logging_h_See_the_document_for_detail
978 # define COMPACT_GOOGLE_LOG_0 GLOG_ERROR_MSG
979 # define SYSLOG_0 GLOG_ERROR_MSG
980 # define LOG_TO_STRING_0 GLOG_ERROR_MSG
981 # define GLOG_0 GLOG_ERROR_MSG
984 // Plus some debug-logging macros that get compiled to nothing for production
988 #define DLOG(severity) LOG(severity)
989 #define DVLOG(verboselevel) VLOG(verboselevel)
990 #define DLOG_IF(severity, condition) LOG_IF(severity, condition)
991 #define DLOG_EVERY_N(severity, n) LOG_EVERY_N(severity, n)
992 #define DLOG_IF_EVERY_N(severity, condition, n) \
993 LOG_IF_EVERY_N(severity, condition, n)
994 #define DLOG_ASSERT(condition) LOG_ASSERT(condition)
996 // debug-only checking. executed if DCHECK_IS_ON().
997 #define DCHECK(condition) CHECK(condition)
998 #define DCHECK_EQ(val1, val2) CHECK_EQ(val1, val2)
999 #define DCHECK_NE(val1, val2) CHECK_NE(val1, val2)
1000 #define DCHECK_LE(val1, val2) CHECK_LE(val1, val2)
1001 #define DCHECK_LT(val1, val2) CHECK_LT(val1, val2)
1002 #define DCHECK_GE(val1, val2) CHECK_GE(val1, val2)
1003 #define DCHECK_GT(val1, val2) CHECK_GT(val1, val2)
1004 #define DCHECK_NOTNULL(val) CHECK_NOTNULL(val)
1005 #define DCHECK_STREQ(str1, str2) CHECK_STREQ(str1, str2)
1006 #define DCHECK_STRCASEEQ(str1, str2) CHECK_STRCASEEQ(str1, str2)
1007 #define DCHECK_STRNE(str1, str2) CHECK_STRNE(str1, str2)
1008 #define DCHECK_STRCASENE(str1, str2) CHECK_STRCASENE(str1, str2)
1010 #else // !DCHECK_IS_ON()
1012 #define DLOG(severity) \
1013 true ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1015 #define DVLOG(verboselevel) \
1016 (true || !VLOG_IS_ON(verboselevel)) ?\
1017 (void) 0 : google::LogMessageVoidify() & LOG(INFO)
1019 #define DLOG_IF(severity, condition) \
1020 (true || !(condition)) ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1022 #define DLOG_EVERY_N(severity, n) \
1023 true ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1025 #define DLOG_IF_EVERY_N(severity, condition, n) \
1026 (true || !(condition))? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1028 #define DLOG_ASSERT(condition) \
1029 true ? (void) 0 : LOG_ASSERT(condition)
1031 // MSVC warning C4127: conditional expression is constant
1032 #define DCHECK(condition) \
1033 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1035 GLOG_MSVC_POP_WARNING() CHECK(condition)
1037 #define DCHECK_EQ(val1, val2) \
1038 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1040 GLOG_MSVC_POP_WARNING() CHECK_EQ(val1, val2)
1042 #define DCHECK_NE(val1, val2) \
1043 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1045 GLOG_MSVC_POP_WARNING() CHECK_NE(val1, val2)
1047 #define DCHECK_LE(val1, val2) \
1048 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1050 GLOG_MSVC_POP_WARNING() CHECK_LE(val1, val2)
1052 #define DCHECK_LT(val1, val2) \
1053 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1055 GLOG_MSVC_POP_WARNING() CHECK_LT(val1, val2)
1057 #define DCHECK_GE(val1, val2) \
1058 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1060 GLOG_MSVC_POP_WARNING() CHECK_GE(val1, val2)
1062 #define DCHECK_GT(val1, val2) \
1063 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1065 GLOG_MSVC_POP_WARNING() CHECK_GT(val1, val2)
1067 // You may see warnings in release mode if you don't use the return
1068 // value of DCHECK_NOTNULL. Please just use DCHECK for such cases.
1069 #define DCHECK_NOTNULL(val) (val)
1071 #define DCHECK_STREQ(str1, str2) \
1072 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1074 GLOG_MSVC_POP_WARNING() CHECK_STREQ(str1, str2)
1076 #define DCHECK_STRCASEEQ(str1, str2) \
1077 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1079 GLOG_MSVC_POP_WARNING() CHECK_STRCASEEQ(str1, str2)
1081 #define DCHECK_STRNE(str1, str2) \
1082 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1084 GLOG_MSVC_POP_WARNING() CHECK_STRNE(str1, str2)
1086 #define DCHECK_STRCASENE(str1, str2) \
1087 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1089 GLOG_MSVC_POP_WARNING() CHECK_STRCASENE(str1, str2)
1091 #endif // DCHECK_IS_ON()
1093 // Log only in verbose mode.
1095 #define VLOG(verboselevel) LOG_IF(INFO, VLOG_IS_ON(verboselevel))
1097 #define VLOG_IF(verboselevel, condition) \
1098 LOG_IF(INFO, (condition) && VLOG_IS_ON(verboselevel))
1100 #define VLOG_EVERY_N(verboselevel, n) \
1101 LOG_IF_EVERY_N(INFO, VLOG_IS_ON(verboselevel), n)
1103 #define VLOG_IF_EVERY_N(verboselevel, condition, n) \
1104 LOG_IF_EVERY_N(INFO, (condition) && VLOG_IS_ON(verboselevel), n)
1106 namespace base_logging {
1108 // LogMessage::LogStream is a std::ostream backed by this streambuf.
1109 // This class ignores overflow and leaves two bytes at the end of the
1110 // buffer to allow for a '\n' and '\0'.
1111 class GOOGLE_GLOG_DLL_DECL LogStreamBuf : public std::streambuf {
1113 // REQUIREMENTS: "len" must be >= 2 to account for the '\n' and '\n'.
1114 LogStreamBuf(char *buf, int len) {
1115 setp(buf, buf + len - 2);
1117 // This effectively ignores overflow.
1118 virtual int_type overflow(int_type ch) {
1122 // Legacy public ostrstream method.
1123 size_t pcount() const { return pptr() - pbase(); }
1124 char* pbase() const { return std::streambuf::pbase(); }
1127 } // namespace base_logging
1130 // This class more or less represents a particular log message. You
1131 // create an instance of LogMessage and then stream stuff to it.
1132 // When you finish streaming to it, ~LogMessage is called and the
1133 // full message gets streamed to the appropriate destination.
1135 // You shouldn't actually use LogMessage's constructor to log things,
1136 // though. You should use the LOG() macro (and variants thereof)
1138 class GOOGLE_GLOG_DLL_DECL LogMessage {
1141 // Passing kNoLogPrefix for the line number disables the
1142 // log-message prefix. Useful for using the LogMessage
1143 // infrastructure as a printing utility. See also the --log_prefix
1144 // flag for controlling the log-message prefix on an
1145 // application-wide basis.
1149 // LogStream inherit from non-DLL-exported class (std::ostrstream)
1150 // and VC++ produces a warning for this situation.
1151 // However, MSDN says "C4275 can be ignored in Microsoft Visual C++
1152 // 2005 if you are deriving from a type in the Standard C++ Library"
1153 // http://msdn.microsoft.com/en-us/library/3tdb471s(VS.80).aspx
1154 // Let's just ignore the warning.
1156 # pragma warning(disable: 4275)
1158 class GOOGLE_GLOG_DLL_DECL LogStream : public std::ostream {
1160 # pragma warning(default: 4275)
1163 LogStream(char *buf, int len, int ctr)
1164 : std::ostream(NULL),
1165 streambuf_(buf, len),
1171 int ctr() const { return ctr_; }
1172 void set_ctr(int ctr) { ctr_ = ctr; }
1173 LogStream* self() const { return self_; }
1175 // Legacy std::streambuf methods.
1176 size_t pcount() const { return streambuf_.pcount(); }
1177 char* pbase() const { return streambuf_.pbase(); }
1178 char* str() const { return pbase(); }
1181 LogStream(const LogStream&);
1182 LogStream& operator=(const LogStream&);
1183 base_logging::LogStreamBuf streambuf_;
1184 int ctr_; // Counter hack (for the LOG_EVERY_X() macro)
1185 LogStream *self_; // Consistency check hack
1189 // icc 8 requires this typedef to avoid an internal compiler error.
1190 typedef void (LogMessage::*SendMethod)();
1192 LogMessage(const char* file, int line, LogSeverity severity, int ctr,
1193 SendMethod send_method);
1195 // Two special constructors that generate reduced amounts of code at
1196 // LOG call sites for common cases.
1198 // Used for LOG(INFO): Implied are:
1199 // severity = INFO, ctr = 0, send_method = &LogMessage::SendToLog.
1201 // Using this constructor instead of the more complex constructor above
1202 // saves 19 bytes per call site.
1203 LogMessage(const char* file, int line);
1205 // Used for LOG(severity) where severity != INFO. Implied
1206 // are: ctr = 0, send_method = &LogMessage::SendToLog
1208 // Using this constructor instead of the more complex constructor above
1209 // saves 17 bytes per call site.
1210 LogMessage(const char* file, int line, LogSeverity severity);
1212 // Constructor to log this message to a specified sink (if not NULL).
1213 // Implied are: ctr = 0, send_method = &LogMessage::SendToSinkAndLog if
1214 // also_send_to_log is true, send_method = &LogMessage::SendToSink otherwise.
1215 LogMessage(const char* file, int line, LogSeverity severity, LogSink* sink,
1216 bool also_send_to_log);
1218 // Constructor where we also give a vector<string> pointer
1219 // for storing the messages (if the pointer is not NULL).
1220 // Implied are: ctr = 0, send_method = &LogMessage::SaveOrSendToLog.
1221 LogMessage(const char* file, int line, LogSeverity severity,
1222 std::vector<std::string>* outvec);
1224 // Constructor where we also give a string pointer for storing the
1225 // message (if the pointer is not NULL). Implied are: ctr = 0,
1226 // send_method = &LogMessage::WriteToStringAndLog.
1227 LogMessage(const char* file, int line, LogSeverity severity,
1228 std::string* message);
1230 // A special constructor used for check failures
1231 LogMessage(const char* file, int line, const CheckOpString& result);
1235 // Flush a buffered message to the sink set in the constructor. Always
1236 // called by the destructor, it may also be called from elsewhere if
1237 // needed. Only the first call is actioned; any later ones are ignored.
1240 // An arbitrary limit on the length of a single log message. This
1241 // is so that streaming can be done more efficiently.
1242 static const size_t kMaxLogMessageLen;
1244 // Theses should not be called directly outside of logging.*,
1245 // only passed as SendMethod arguments to other LogMessage methods:
1246 void SendToLog(); // Actually dispatch to the logs
1247 void SendToSyslogAndLog(); // Actually dispatch to syslog and the logs
1249 // Call abort() or similar to perform LOG(FATAL) crash.
1250 static void __declspec(noreturn) Fail();
1252 std::ostream& stream();
1254 int preserved_errno() const;
1256 // Must be called without the log_mutex held. (L < log_mutex)
1257 static int64 num_messages(int severity);
1259 struct LogMessageData;
1262 // Fully internal SendMethod cases:
1263 void SendToSinkAndLog(); // Send to sink if provided and dispatch to the logs
1264 void SendToSink(); // Send to sink if provided, do nothing otherwise.
1266 // Write to string if provided and dispatch to the logs.
1267 void WriteToStringAndLog();
1269 void SaveOrSendToLog(); // Save to stringvec if provided, else to logs
1271 void Init(const char* file, int line, LogSeverity severity,
1272 void (LogMessage::*send_method)());
1274 // Used to fill in crash information during LOG(FATAL) failures.
1275 void RecordCrashReason(glog_internal_namespace_::CrashReason* reason);
1277 // Counts of messages sent at each priority:
1278 static int64 num_messages_[NUM_SEVERITIES]; // under log_mutex
1280 // We keep the data in a separate struct so that each instance of
1281 // LogMessage uses less stack space.
1282 LogMessageData* allocated_;
1283 LogMessageData* data_;
1285 friend class LogDestination;
1287 LogMessage(const LogMessage&);
1288 void operator=(const LogMessage&);
1291 // This class happens to be thread-hostile because all instances share
1292 // a single data buffer, but since it can only be created just before
1293 // the process dies, we don't worry so much.
1294 class GOOGLE_GLOG_DLL_DECL LogMessageFatal : public LogMessage {
1296 LogMessageFatal(const char* file, int line);
1297 LogMessageFatal(const char* file, int line, const CheckOpString& result);
1298 __declspec(noreturn) ~LogMessageFatal();
1301 // A non-macro interface to the log facility; (useful
1302 // when the logging level is not a compile-time constant).
1303 inline void LogAtLevel(int const severity, std::string const &msg) {
1304 LogMessage(__FILE__, __LINE__, severity).stream() << msg;
1307 // A macro alternative of LogAtLevel. New code may want to use this
1308 // version since there are two advantages: 1. this version outputs the
1309 // file name and the line number where this macro is put like other
1310 // LOG macros, 2. this macro can be used as C++ stream.
1311 #define LOG_AT_LEVEL(severity) google::LogMessage(__FILE__, __LINE__, severity).stream()
1313 // Check if it's compiled in C++11 mode.
1315 // GXX_EXPERIMENTAL_CXX0X is defined by gcc and clang up to at least
1316 // gcc-4.7 and clang-3.1 (2011-12-13). __cplusplus was defined to 1
1317 // in gcc before 4.7 (Crosstool 16) and clang before 3.1, but is
1318 // defined according to the language version in effect thereafter.
1319 // Microsoft Visual Studio 14 (2015) sets __cplusplus==199711 despite
1320 // reasonably good C++11 support, so we set LANG_CXX for it and
1321 // newer versions (_MSC_VER >= 1900).
1322 #if (defined(__GXX_EXPERIMENTAL_CXX0X__) || __cplusplus >= 201103L || \
1323 (defined(_MSC_VER) && _MSC_VER >= 1900))
1324 // Helper for CHECK_NOTNULL().
1326 // In C++11, all cases can be handled by a single function. Since the value
1327 // category of the argument is preserved (also for rvalue references),
1328 // member initializer lists like the one below will compile correctly:
1331 // : x_(CHECK_NOTNULL(MethodReturningUniquePtr())) {}
1332 template <typename T>
1333 T CheckNotNull(const char* file, int line, const char* names, T&& t) {
1335 LogMessageFatal(file, line, new std::string(names));
1337 return std::forward<T>(t);
1342 // A small helper for CHECK_NOTNULL().
1343 template <typename T>
1344 T* CheckNotNull(const char *file, int line, const char *names, T* t) {
1346 LogMessageFatal(file, line, new std::string(names));
1352 // Allow folks to put a counter in the LOG_EVERY_X()'ed messages. This
1353 // only works if ostream is a LogStream. If the ostream is not a
1354 // LogStream you'll get an assert saying as much at runtime.
1355 GOOGLE_GLOG_DLL_DECL std::ostream& operator<<(std::ostream &os,
1356 const PRIVATE_Counter&);
1359 // Derived class for PLOG*() above.
1360 class GOOGLE_GLOG_DLL_DECL ErrnoLogMessage : public LogMessage {
1363 ErrnoLogMessage(const char* file, int line, LogSeverity severity, int ctr,
1364 void (LogMessage::*send_method)());
1366 // Postpends ": strerror(errno) [errno]".
1370 ErrnoLogMessage(const ErrnoLogMessage&);
1371 void operator=(const ErrnoLogMessage&);
1375 // This class is used to explicitly ignore values in the conditional
1376 // logging macros. This avoids compiler warnings like "value computed
1377 // is not used" and "statement has no effect".
1379 class GOOGLE_GLOG_DLL_DECL LogMessageVoidify {
1381 LogMessageVoidify() { }
1382 // This has to be an operator with a precedence lower than << but
1384 void operator&(std::ostream&) { }
1388 // Flushes all log files that contains messages that are at least of
1389 // the specified severity level. Thread-safe.
1390 GOOGLE_GLOG_DLL_DECL void FlushLogFiles(LogSeverity min_severity);
1392 // Flushes all log files that contains messages that are at least of
1393 // the specified severity level. Thread-hostile because it ignores
1394 // locking -- used for catastrophic failures.
1395 GOOGLE_GLOG_DLL_DECL void FlushLogFilesUnsafe(LogSeverity min_severity);
1398 // Set the destination to which a particular severity level of log
1399 // messages is sent. If base_filename is "", it means "don't log this
1400 // severity". Thread-safe.
1402 GOOGLE_GLOG_DLL_DECL void SetLogDestination(LogSeverity severity,
1403 const char* base_filename);
1406 // Set the basename of the symlink to the latest log file at a given
1407 // severity. If symlink_basename is empty, do not make a symlink. If
1408 // you don't call this function, the symlink basename is the
1409 // invocation name of the program. Thread-safe.
1411 GOOGLE_GLOG_DLL_DECL void SetLogSymlink(LogSeverity severity,
1412 const char* symlink_basename);
1415 // Used to send logs to some other kind of destination
1416 // Users should subclass LogSink and override send to do whatever they want.
1417 // Implementations must be thread-safe because a shared instance will
1418 // be called from whichever thread ran the LOG(XXX) line.
1419 class GOOGLE_GLOG_DLL_DECL LogSink {
1423 // Sink's logging logic (message_len is such as to exclude '\n' at the end).
1424 // This method can't use LOG() or CHECK() as logging system mutex(s) are held
1425 // during this call.
1426 virtual void send(LogSeverity severity, const char* full_filename,
1427 const char* base_filename, int line,
1428 const struct ::tm* tm_time,
1429 const char* message, size_t message_len) = 0;
1431 // Redefine this to implement waiting for
1432 // the sink's logging logic to complete.
1433 // It will be called after each send() returns,
1434 // but before that LogMessage exits or crashes.
1435 // By default this function does nothing.
1436 // Using this function one can implement complex logic for send()
1437 // that itself involves logging; and do all this w/o causing deadlocks and
1438 // inconsistent rearrangement of log messages.
1439 // E.g. if a LogSink has thread-specific actions, the send() method
1440 // can simply add the message to a queue and wake up another thread that
1441 // handles real logging while itself making some LOG() calls;
1442 // WaitTillSent() can be implemented to wait for that logic to complete.
1443 // See our unittest for an example.
1444 virtual void WaitTillSent();
1446 // Returns the normal text output of the log message.
1447 // Can be useful to implement send().
1448 static std::string ToString(LogSeverity severity, const char* file, int line,
1449 const struct ::tm* tm_time,
1450 const char* message, size_t message_len);
1453 // Add or remove a LogSink as a consumer of logging data. Thread-safe.
1454 GOOGLE_GLOG_DLL_DECL void AddLogSink(LogSink *destination);
1455 GOOGLE_GLOG_DLL_DECL void RemoveLogSink(LogSink *destination);
1458 // Specify an "extension" added to the filename specified via
1459 // SetLogDestination. This applies to all severity levels. It's
1460 // often used to append the port we're listening on to the logfile
1461 // name. Thread-safe.
1463 GOOGLE_GLOG_DLL_DECL void SetLogFilenameExtension(
1464 const char* filename_extension);
1467 // Make it so that all log messages of at least a particular severity
1468 // are logged to stderr (in addition to logging to the usual log
1469 // file(s)). Thread-safe.
1471 GOOGLE_GLOG_DLL_DECL void SetStderrLogging(LogSeverity min_severity);
1474 // Make it so that all log messages go only to stderr. Thread-safe.
1476 GOOGLE_GLOG_DLL_DECL void LogToStderr();
1479 // Make it so that all log messages of at least a particular severity are
1480 // logged via email to a list of addresses (in addition to logging to the
1481 // usual log file(s)). The list of addresses is just a string containing
1482 // the email addresses to send to (separated by spaces, say). Thread-safe.
1484 GOOGLE_GLOG_DLL_DECL void SetEmailLogging(LogSeverity min_severity,
1485 const char* addresses);
1487 // A simple function that sends email. dest is a commma-separated
1488 // list of addressess. Thread-safe.
1489 GOOGLE_GLOG_DLL_DECL bool SendEmail(const char *dest,
1490 const char *subject, const char *body);
1492 GOOGLE_GLOG_DLL_DECL const std::vector<std::string>& GetLoggingDirectories();
1494 // For tests only: Clear the internal [cached] list of logging directories to
1495 // force a refresh the next time GetLoggingDirectories is called.
1497 void TestOnly_ClearLoggingDirectoriesList();
1499 // Returns a set of existing temporary directories, which will be a
1500 // subset of the directories returned by GetLogginDirectories().
1502 GOOGLE_GLOG_DLL_DECL void GetExistingTempDirectories(
1503 std::vector<std::string>* list);
1505 // Print any fatal message again -- useful to call from signal handler
1506 // so that the last thing in the output is the fatal message.
1507 // Thread-hostile, but a race is unlikely.
1508 GOOGLE_GLOG_DLL_DECL void ReprintFatalMessage();
1510 // Truncate a log file that may be the append-only output of multiple
1511 // processes and hence can't simply be renamed/reopened (typically a
1512 // stdout/stderr). If the file "path" is > "limit" bytes, copy the
1513 // last "keep" bytes to offset 0 and truncate the rest. Since we could
1514 // be racing with other writers, this approach has the potential to
1515 // lose very small amounts of data. For security, only follow symlinks
1516 // if the path is /proc/self/fd/*
1517 GOOGLE_GLOG_DLL_DECL void TruncateLogFile(const char *path,
1518 int64 limit, int64 keep);
1520 // Truncate stdout and stderr if they are over the value specified by
1521 // --max_log_size; keep the final 1MB. This function has the same
1522 // race condition as TruncateLogFile.
1523 GOOGLE_GLOG_DLL_DECL void TruncateStdoutStderr();
1525 // Return the string representation of the provided LogSeverity level.
1527 GOOGLE_GLOG_DLL_DECL const char* GetLogSeverityName(LogSeverity severity);
1529 // ---------------------------------------------------------------------
1530 // Implementation details that are not useful to most clients
1531 // ---------------------------------------------------------------------
1533 // A Logger is the interface used by logging modules to emit entries
1534 // to a log. A typical implementation will dump formatted data to a
1535 // sequence of files. We also provide interfaces that will forward
1536 // the data to another thread so that the invoker never blocks.
1537 // Implementations should be thread-safe since the logging system
1538 // will write to them from multiple threads.
1542 class GOOGLE_GLOG_DLL_DECL Logger {
1546 // Writes "message[0,message_len-1]" corresponding to an event that
1547 // occurred at "timestamp". If "force_flush" is true, the log file
1548 // is flushed immediately.
1550 // The input message has already been formatted as deemed
1551 // appropriate by the higher level logging facility. For example,
1552 // textual log messages already contain timestamps, and the
1553 // file:linenumber header.
1554 virtual void Write(bool force_flush,
1556 const char* message,
1557 int message_len) = 0;
1559 // Flush any buffered messages
1560 virtual void Flush() = 0;
1562 // Get the current LOG file size.
1563 // The returned value is approximate since some
1564 // logged data may not have been flushed to disk yet.
1565 virtual uint32 LogSize() = 0;
1568 // Get the logger for the specified severity level. The logger
1569 // remains the property of the logging module and should not be
1570 // deleted by the caller. Thread-safe.
1571 extern GOOGLE_GLOG_DLL_DECL Logger* GetLogger(LogSeverity level);
1573 // Set the logger for the specified severity level. The logger
1574 // becomes the property of the logging module and should not
1575 // be deleted by the caller. Thread-safe.
1576 extern GOOGLE_GLOG_DLL_DECL void SetLogger(LogSeverity level, Logger* logger);
1580 // glibc has traditionally implemented two incompatible versions of
1581 // strerror_r(). There is a poorly defined convention for picking the
1582 // version that we want, but it is not clear whether it even works with
1583 // all versions of glibc.
1584 // So, instead, we provide this wrapper that automatically detects the
1585 // version that is in use, and then implements POSIX semantics.
1586 // N.B. In addition to what POSIX says, we also guarantee that "buf" will
1587 // be set to an empty string, if this function failed. This means, in most
1588 // cases, you do not need to check the error code and you can directly
1589 // use the value of "buf". It will never have an undefined value.
1590 // DEPRECATED: Use StrError(int) instead.
1591 GOOGLE_GLOG_DLL_DECL int posix_strerror_r(int err, char *buf, size_t len);
1593 // A thread-safe replacement for strerror(). Returns a string describing the
1594 // given POSIX error code.
1595 GOOGLE_GLOG_DLL_DECL std::string StrError(int err);
1597 // A class for which we define operator<<, which does nothing.
1598 class GOOGLE_GLOG_DLL_DECL NullStream : public LogMessage::LogStream {
1600 // Initialize the LogStream so the messages can be written somewhere
1601 // (they'll never be actually displayed). This will be needed if a
1602 // NullStream& is implicitly converted to LogStream&, in which case
1603 // the overloaded NullStream::operator<< will not be invoked.
1604 NullStream() : LogMessage::LogStream(message_buffer_, 1, 0) { }
1605 NullStream(const char* /*file*/, int /*line*/,
1606 const CheckOpString& /*result*/) :
1607 LogMessage::LogStream(message_buffer_, 1, 0) { }
1608 NullStream &stream() { return *this; }
1610 // A very short buffer for messages (which we discard anyway). This
1611 // will be needed if NullStream& converted to LogStream& (e.g. as a
1612 // result of a conditional expression).
1613 char message_buffer_[2];
1616 // Do nothing. This operator is inline, allowing the message to be
1617 // compiled away. The message will not be compiled away if we do
1618 // something like (flag ? LOG(INFO) : LOG(ERROR)) << message; when
1619 // SKIP_LOG=WARNING. In those cases, NullStream will be implicitly
1620 // converted to LogStream and the message will be computed and then
1621 // quietly discarded.
1623 inline NullStream& operator<<(NullStream &str, const T &) { return str; }
1625 // Similar to NullStream, but aborts the program (without stack
1626 // trace), like LogMessageFatal.
1627 class GOOGLE_GLOG_DLL_DECL NullStreamFatal : public NullStream {
1629 NullStreamFatal() { }
1630 NullStreamFatal(const char* file, int line, const CheckOpString& result) :
1631 NullStream(file, line, result) { }
1632 __declspec(noreturn) ~NullStreamFatal() throw () { _exit(1); }
1635 // Install a signal handler that will dump signal information and a stack
1636 // trace when the program crashes on certain signals. We'll install the
1637 // signal handler for the following signals.
1639 // SIGSEGV, SIGILL, SIGFPE, SIGABRT, SIGBUS, and SIGTERM.
1641 // By default, the signal handler will write the failure dump to the
1642 // standard error. You can customize the destination by installing your
1643 // own writer function by InstallFailureWriter() below.
1645 // Note on threading:
1647 // The function should be called before threads are created, if you want
1648 // to use the failure signal handler for all threads. The stack trace
1649 // will be shown only for the thread that receives the signal. In other
1650 // words, stack traces of other threads won't be shown.
1651 GOOGLE_GLOG_DLL_DECL void InstallFailureSignalHandler();
1653 // Installs a function that is used for writing the failure dump. "data"
1654 // is the pointer to the beginning of a message to be written, and "size"
1655 // is the size of the message. You should not expect the data is
1656 // terminated with '\0'.
1657 GOOGLE_GLOG_DLL_DECL void InstallFailureWriter(
1658 void (*writer)(const char* data, int size));
1662 #endif // _LOGGING_H_