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 // For DFATAL, we want to use LogMessage (as opposed to
439 // LogMessageFatal), to be consistent with the original behavior.
441 #define COMPACT_GOOGLE_LOG_DFATAL COMPACT_GOOGLE_LOG_ERROR
442 #elif GOOGLE_STRIP_LOG <= 3
443 #define COMPACT_GOOGLE_LOG_DFATAL google::LogMessage( \
444 __FILE__, __LINE__, google::GLOG_FATAL)
446 #define COMPACT_GOOGLE_LOG_DFATAL google::NullStreamFatal()
449 #define GOOGLE_LOG_INFO(counter) google::LogMessage(__FILE__, __LINE__, google::GLOG_INFO, counter, &google::LogMessage::SendToLog)
450 #define SYSLOG_INFO(counter) \
451 google::LogMessage(__FILE__, __LINE__, google::GLOG_INFO, counter, \
452 &google::LogMessage::SendToSyslogAndLog)
453 #define GOOGLE_LOG_WARNING(counter) \
454 google::LogMessage(__FILE__, __LINE__, google::GLOG_WARNING, counter, \
455 &google::LogMessage::SendToLog)
456 #define SYSLOG_WARNING(counter) \
457 google::LogMessage(__FILE__, __LINE__, google::GLOG_WARNING, counter, \
458 &google::LogMessage::SendToSyslogAndLog)
459 #define GOOGLE_LOG_ERROR(counter) \
460 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, counter, \
461 &google::LogMessage::SendToLog)
462 #define SYSLOG_ERROR(counter) \
463 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, counter, \
464 &google::LogMessage::SendToSyslogAndLog)
465 #define GOOGLE_LOG_FATAL(counter) \
466 google::LogMessage(__FILE__, __LINE__, google::GLOG_FATAL, counter, \
467 &google::LogMessage::SendToLog)
468 #define SYSLOG_FATAL(counter) \
469 google::LogMessage(__FILE__, __LINE__, google::GLOG_FATAL, counter, \
470 &google::LogMessage::SendToSyslogAndLog)
471 #define GOOGLE_LOG_DFATAL(counter) \
472 google::LogMessage(__FILE__, __LINE__, google::DFATAL_LEVEL, counter, \
473 &google::LogMessage::SendToLog)
474 #define SYSLOG_DFATAL(counter) \
475 google::LogMessage(__FILE__, __LINE__, google::DFATAL_LEVEL, counter, \
476 &google::LogMessage::SendToSyslogAndLog)
478 #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
479 // A very useful logging macro to log windows errors:
480 #define LOG_SYSRESULT(result) \
481 if (FAILED(HRESULT_FROM_WIN32(result))) { \
482 LPSTR message = NULL; \
483 LPSTR msg = reinterpret_cast<LPSTR>(&message); \
484 DWORD message_length = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | \
485 FORMAT_MESSAGE_FROM_SYSTEM, \
486 0, result, 0, msg, 100, NULL); \
487 if (message_length > 0) { \
488 google::LogMessage(__FILE__, __LINE__, google::GLOG_ERROR, 0, \
489 &google::LogMessage::SendToLog).stream() \
490 << reinterpret_cast<const char*>(message); \
491 LocalFree(message); \
496 // We use the preprocessor's merging operator, "##", so that, e.g.,
497 // LOG(INFO) becomes the token GOOGLE_LOG_INFO. There's some funny
498 // subtle difference between ostream member streaming functions (e.g.,
499 // ostream::operator<<(int) and ostream non-member streaming functions
500 // (e.g., ::operator<<(ostream&, string&): it turns out that it's
501 // impossible to stream something like a string directly to an unnamed
502 // ostream. We employ a neat hack by calling the stream() member
503 // function of LogMessage which seems to avoid the problem.
504 #define LOG(severity) COMPACT_GOOGLE_LOG_ ## severity.stream()
505 #define SYSLOG(severity) SYSLOG_ ## severity(0).stream()
509 // They need the definitions of integer types.
510 #include "glog/log_severity.h"
511 #include "glog/vlog_is_on.h"
513 // Initialize google's logging library. You will see the program name
514 // specified by argv0 in log outputs.
515 GOOGLE_GLOG_DLL_DECL void InitGoogleLogging(const char* argv0);
517 // Shutdown google's logging library.
518 GOOGLE_GLOG_DLL_DECL void ShutdownGoogleLogging();
520 // Install a function which will be called after LOG(FATAL).
521 GOOGLE_GLOG_DLL_DECL void InstallFailureFunction(void (*fail_func)());
523 class LogSink; // defined below
525 // If a non-NULL sink pointer is given, we push this message to that sink.
526 // For LOG_TO_SINK we then do normal LOG(severity) logging as well.
527 // This is useful for capturing messages and passing/storing them
528 // somewhere more specific than the global log of the process.
531 // LogSeverity severity;
532 // The cast is to disambiguate NULL arguments.
533 #define LOG_TO_SINK(sink, severity) \
534 google::LogMessage( \
535 __FILE__, __LINE__, \
536 google::GLOG_ ## severity, \
537 static_cast<google::LogSink*>(sink), true).stream()
538 #define LOG_TO_SINK_BUT_NOT_TO_LOGFILE(sink, severity) \
539 google::LogMessage( \
540 __FILE__, __LINE__, \
541 google::GLOG_ ## severity, \
542 static_cast<google::LogSink*>(sink), false).stream()
544 // If a non-NULL string pointer is given, we write this message to that string.
545 // We then do normal LOG(severity) logging as well.
546 // This is useful for capturing messages and storing them somewhere more
547 // specific than the global log of the process.
550 // LogSeverity severity;
551 // The cast is to disambiguate NULL arguments.
552 // NOTE: LOG(severity) expands to LogMessage().stream() for the specified
554 #define LOG_TO_STRING(severity, message) \
555 LOG_TO_STRING_##severity(static_cast<string*>(message)).stream()
557 // If a non-NULL pointer is given, we push the message onto the end
558 // of a vector of strings; otherwise, we report it with LOG(severity).
559 // This is handy for capturing messages and perhaps passing them back
560 // to the caller, rather than reporting them immediately.
562 // LogSeverity severity;
563 // vector<string> *outvec;
564 // The cast is to disambiguate NULL arguments.
565 #define LOG_STRING(severity, outvec) \
566 LOG_TO_STRING_##severity(static_cast<std::vector<std::string>*>(outvec)).stream()
568 #define LOG_IF(severity, condition) \
569 !(condition) ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
570 #define SYSLOG_IF(severity, condition) \
571 !(condition) ? (void) 0 : google::LogMessageVoidify() & SYSLOG(severity)
573 #define LOG_ASSERT(condition) \
574 LOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
575 #define SYSLOG_ASSERT(condition) \
576 SYSLOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
578 // CHECK dies with a fatal error if condition is not true. It is *not*
579 // controlled by NDEBUG, so the check will be executed regardless of
580 // compilation mode. Therefore, it is safe to do things like:
581 // CHECK(fp->Write(x) == 4)
582 #define CHECK(condition) \
583 LOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
584 << "Check failed: " #condition " "
586 // A container for a string pointer which can be evaluated to a bool -
587 // true iff the pointer is NULL.
588 struct CheckOpString {
589 CheckOpString(std::string* str) : str_(str) { }
590 // No destructor: if str_ is non-NULL, we're about to LOG(FATAL),
591 // so there's no point in cleaning up str_.
592 operator bool() const {
593 return GOOGLE_PREDICT_BRANCH_NOT_TAKEN(str_ != NULL);
598 // Function is overloaded for integral types to allow static const
599 // integrals declared in classes and not defined to be used as arguments to
600 // CHECK* macros. It's not encouraged though.
602 inline const T& GetReferenceableValue(const T& t) { return t; }
603 inline char GetReferenceableValue(char t) { return t; }
604 inline unsigned char GetReferenceableValue(unsigned char t) { return t; }
605 inline signed char GetReferenceableValue(signed char t) { return t; }
606 inline short GetReferenceableValue(short t) { return t; }
607 inline unsigned short GetReferenceableValue(unsigned short t) { return t; }
608 inline int GetReferenceableValue(int t) { return t; }
609 inline unsigned int GetReferenceableValue(unsigned int t) { return t; }
610 inline long GetReferenceableValue(long t) { return t; }
611 inline unsigned long GetReferenceableValue(unsigned long t) { return t; }
612 inline long long GetReferenceableValue(long long t) { return t; }
613 inline unsigned long long GetReferenceableValue(unsigned long long t) {
617 // This is a dummy class to define the following operator.
618 struct DummyClassToDefineOperator {};
622 // Define global operator<< to declare using ::operator<<.
623 // This declaration will allow use to use CHECK macros for user
624 // defined classes which have operator<< (e.g., stl_logging.h).
625 inline std::ostream& operator<<(
626 std::ostream& out, const google::DummyClassToDefineOperator&) {
632 // This formats a value for a failing CHECK_XX statement. Ordinarily,
633 // it uses the definition for operator<<, with a few special cases below.
634 template <typename T>
635 inline void MakeCheckOpValueString(std::ostream* os, const T& v) {
639 // Overrides for char types provide readable values for unprintable
641 template <> GOOGLE_GLOG_DLL_DECL
642 void MakeCheckOpValueString(std::ostream* os, const char& v);
643 template <> GOOGLE_GLOG_DLL_DECL
644 void MakeCheckOpValueString(std::ostream* os, const signed char& v);
645 template <> GOOGLE_GLOG_DLL_DECL
646 void MakeCheckOpValueString(std::ostream* os, const unsigned char& v);
648 // Build the error message string. Specify no inlining for code size.
649 template <typename T1, typename T2>
650 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext)
656 // If "s" is less than base_logging::INFO, returns base_logging::INFO.
657 // If "s" is greater than base_logging::FATAL, returns
658 // base_logging::ERROR. Otherwise, returns "s".
659 LogSeverity NormalizeSeverity(LogSeverity s);
661 } // namespace internal
663 // A helper class for formatting "expr (V1 vs. V2)" in a CHECK_XX
664 // statement. See MakeCheckOpString for sample usage. Other
665 // approaches were considered: use of a template method (e.g.,
666 // base::BuildCheckOpString(exprtext, base::Print<T1>, &v1,
667 // base::Print<T2>, &v2), however this approach has complications
668 // related to volatile arguments and function-pointer arguments).
669 class GOOGLE_GLOG_DLL_DECL CheckOpMessageBuilder {
671 // Inserts "exprtext" and " (" to the stream.
672 explicit CheckOpMessageBuilder(const char *exprtext);
673 // Deletes "stream_".
674 ~CheckOpMessageBuilder();
675 // For inserting the first variable.
676 std::ostream* ForVar1() { return stream_; }
677 // For inserting the second variable (adds an intermediate " vs. ").
678 std::ostream* ForVar2();
679 // Get the result (inserts the closing ")").
680 std::string* NewString();
683 std::ostringstream *stream_;
688 template <typename T1, typename T2>
689 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext) {
690 base::CheckOpMessageBuilder comb(exprtext);
691 MakeCheckOpValueString(comb.ForVar1(), v1);
692 MakeCheckOpValueString(comb.ForVar2(), v2);
693 return comb.NewString();
696 // Helper functions for CHECK_OP macro.
697 // The (int, int) specialization works around the issue that the compiler
698 // will not instantiate the template version of the function on values of
699 // unnamed enum type - see comment below.
700 #define DEFINE_CHECK_OP_IMPL(name, op) \
701 template <typename T1, typename T2> \
702 inline std::string* name##Impl(const T1& v1, const T2& v2, \
703 const char* exprtext) { \
704 if (GOOGLE_PREDICT_TRUE(v1 op v2)) return NULL; \
705 else return MakeCheckOpString(v1, v2, exprtext); \
707 inline std::string* name##Impl(int v1, int v2, const char* exprtext) { \
708 return name##Impl<int, int>(v1, v2, exprtext); \
711 // We use the full name Check_EQ, Check_NE, etc. in case the file including
712 // base/logging.h provides its own #defines for the simpler names EQ, NE, etc.
713 // This happens if, for example, those are used as token names in a
715 DEFINE_CHECK_OP_IMPL(Check_EQ, ==) // Compilation error with CHECK_EQ(NULL, x)?
716 DEFINE_CHECK_OP_IMPL(Check_NE, !=) // Use CHECK(x == NULL) instead.
717 DEFINE_CHECK_OP_IMPL(Check_LE, <=)
718 DEFINE_CHECK_OP_IMPL(Check_LT, < )
719 DEFINE_CHECK_OP_IMPL(Check_GE, >=)
720 DEFINE_CHECK_OP_IMPL(Check_GT, > )
721 #undef DEFINE_CHECK_OP_IMPL
723 // Helper macro for binary operators.
724 // Don't use this macro directly in your code, use CHECK_EQ et al below.
726 #if defined(STATIC_ANALYSIS)
727 // Only for static analysis tool to know that it is equivalent to assert
728 #define CHECK_OP_LOG(name, op, val1, val2, log) CHECK((val1) op (val2))
729 #elif !defined(NDEBUG)
730 // In debug mode, avoid constructing CheckOpStrings if possible,
731 // to reduce the overhead of CHECK statments by 2x.
732 // Real DCHECK-heavy tests have seen 1.5x speedups.
734 // The meaning of "string" might be different between now and
735 // when this macro gets invoked (e.g., if someone is experimenting
736 // with other string implementations that get defined after this
737 // file is included). Save the current meaning now and use it
739 typedef std::string _Check_string;
740 #define CHECK_OP_LOG(name, op, val1, val2, log) \
741 while (google::_Check_string* _result = \
742 google::Check##name##Impl( \
743 google::GetReferenceableValue(val1), \
744 google::GetReferenceableValue(val2), \
745 #val1 " " #op " " #val2)) \
746 log(__FILE__, __LINE__, \
747 google::CheckOpString(_result)).stream()
749 // In optimized mode, use CheckOpString to hint to compiler that
750 // the while condition is unlikely.
751 #define CHECK_OP_LOG(name, op, val1, val2, log) \
752 while (google::CheckOpString _result = \
753 google::Check##name##Impl( \
754 google::GetReferenceableValue(val1), \
755 google::GetReferenceableValue(val2), \
756 #val1 " " #op " " #val2)) \
757 log(__FILE__, __LINE__, _result).stream()
758 #endif // STATIC_ANALYSIS, !NDEBUG
760 #if GOOGLE_STRIP_LOG <= 3
761 #define CHECK_OP(name, op, val1, val2) \
762 CHECK_OP_LOG(name, op, val1, val2, google::LogMessageFatal)
764 #define CHECK_OP(name, op, val1, val2) \
765 CHECK_OP_LOG(name, op, val1, val2, google::NullStreamFatal)
766 #endif // STRIP_LOG <= 3
768 // Equality/Inequality checks - compare two values, and log a FATAL message
769 // including the two values when the result is not as expected. The values
770 // must have operator<<(ostream, ...) defined.
772 // You may append to the error message like so:
773 // CHECK_NE(1, 2) << ": The world must be ending!";
775 // We are very careful to ensure that each argument is evaluated exactly
776 // once, and that anything which is legal to pass as a function argument is
777 // legal here. In particular, the arguments may be temporary expressions
778 // which will end up being destroyed at the end of the apparent statement,
780 // CHECK_EQ(string("abc")[1], 'b');
782 // WARNING: These don't compile correctly if one of the arguments is a pointer
783 // and the other is NULL. To work around this, simply static_cast NULL to the
784 // type of the desired pointer.
786 #define CHECK_EQ(val1, val2) CHECK_OP(_EQ, ==, val1, val2)
787 #define CHECK_NE(val1, val2) CHECK_OP(_NE, !=, val1, val2)
788 #define CHECK_LE(val1, val2) CHECK_OP(_LE, <=, val1, val2)
789 #define CHECK_LT(val1, val2) CHECK_OP(_LT, < , val1, val2)
790 #define CHECK_GE(val1, val2) CHECK_OP(_GE, >=, val1, val2)
791 #define CHECK_GT(val1, val2) CHECK_OP(_GT, > , val1, val2)
793 // Check that the input is non NULL. This very useful in constructor
794 // initializer lists.
796 #define CHECK_NOTNULL(val) \
797 google::CheckNotNull(__FILE__, __LINE__, "'" #val "' Must be non NULL", (val))
799 // Helper functions for string comparisons.
800 // To avoid bloat, the definitions are in logging.cc.
801 #define DECLARE_CHECK_STROP_IMPL(func, expected) \
802 GOOGLE_GLOG_DLL_DECL std::string* Check##func##expected##Impl( \
803 const char* s1, const char* s2, const char* names);
804 DECLARE_CHECK_STROP_IMPL(strcmp, true)
805 DECLARE_CHECK_STROP_IMPL(strcmp, false)
806 DECLARE_CHECK_STROP_IMPL(strcasecmp, true)
807 DECLARE_CHECK_STROP_IMPL(strcasecmp, false)
808 #undef DECLARE_CHECK_STROP_IMPL
810 // Helper macro for string comparisons.
811 // Don't use this macro directly in your code, use CHECK_STREQ et al below.
812 #define CHECK_STROP(func, op, expected, s1, s2) \
813 while (google::CheckOpString _result = \
814 google::Check##func##expected##Impl((s1), (s2), \
815 #s1 " " #op " " #s2)) \
816 LOG(FATAL) << *_result.str_
819 // String (char*) equality/inequality checks.
820 // CASE versions are case-insensitive.
822 // Note that "s1" and "s2" may be temporary strings which are destroyed
823 // by the compiler at the end of the current "full expression"
824 // (e.g. CHECK_STREQ(Foo().c_str(), Bar().c_str())).
826 #define CHECK_STREQ(s1, s2) CHECK_STROP(strcmp, ==, true, s1, s2)
827 #define CHECK_STRNE(s1, s2) CHECK_STROP(strcmp, !=, false, s1, s2)
828 #define CHECK_STRCASEEQ(s1, s2) CHECK_STROP(strcasecmp, ==, true, s1, s2)
829 #define CHECK_STRCASENE(s1, s2) CHECK_STROP(strcasecmp, !=, false, s1, s2)
831 #define CHECK_INDEX(I,A) CHECK(I < (sizeof(A)/sizeof(A[0])))
832 #define CHECK_BOUND(B,A) CHECK(B <= (sizeof(A)/sizeof(A[0])))
834 #define CHECK_DOUBLE_EQ(val1, val2) \
836 CHECK_LE((val1), (val2)+0.000000000000001L); \
837 CHECK_GE((val1), (val2)-0.000000000000001L); \
840 #define CHECK_NEAR(val1, val2, margin) \
842 CHECK_LE((val1), (val2)+(margin)); \
843 CHECK_GE((val1), (val2)-(margin)); \
846 // perror()..googly style!
848 // PLOG() and PLOG_IF() and PCHECK() behave exactly like their LOG* and
849 // CHECK equivalents with the addition that they postpend a description
850 // of the current state of errno to their output lines.
852 #define PLOG(severity) GOOGLE_PLOG(severity, 0).stream()
854 #define GOOGLE_PLOG(severity, counter) \
855 google::ErrnoLogMessage( \
856 __FILE__, __LINE__, google::GLOG_ ## severity, counter, \
857 &google::LogMessage::SendToLog)
859 #define PLOG_IF(severity, condition) \
860 !(condition) ? (void) 0 : google::LogMessageVoidify() & PLOG(severity)
862 // A CHECK() macro that postpends errno if the condition is false. E.g.
864 // if (poll(fds, nfds, timeout) == -1) { PCHECK(errno == EINTR); ... }
865 #define PCHECK(condition) \
866 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
867 << "Check failed: " #condition " "
869 // A CHECK() macro that lets you assert the success of a function that
870 // returns -1 and sets errno in case of an error. E.g.
872 // CHECK_ERR(mkdir(path, 0700));
876 // int fd = open(filename, flags); CHECK_ERR(fd) << ": open " << filename;
877 #define CHECK_ERR(invocation) \
878 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN((invocation) == -1)) \
881 // Use macro expansion to create, for each use of LOG_EVERY_N(), static
882 // variables with the __LINE__ expansion as part of the variable name.
883 #define LOG_EVERY_N_VARNAME(base, line) LOG_EVERY_N_VARNAME_CONCAT(base, line)
884 #define LOG_EVERY_N_VARNAME_CONCAT(base, line) base ## line
886 #define LOG_OCCURRENCES LOG_EVERY_N_VARNAME(occurrences_, __LINE__)
887 #define LOG_OCCURRENCES_MOD_N LOG_EVERY_N_VARNAME(occurrences_mod_n_, __LINE__)
889 #define SOME_KIND_OF_LOG_EVERY_N(severity, n, what_to_do) \
890 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
892 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
893 if (LOG_OCCURRENCES_MOD_N == 1) \
894 google::LogMessage( \
895 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
896 &what_to_do).stream()
898 #define SOME_KIND_OF_LOG_IF_EVERY_N(severity, condition, n, what_to_do) \
899 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
902 ((LOG_OCCURRENCES_MOD_N=(LOG_OCCURRENCES_MOD_N + 1) % n) == (1 % n))) \
903 google::LogMessage( \
904 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
905 &what_to_do).stream()
907 #define SOME_KIND_OF_PLOG_EVERY_N(severity, n, what_to_do) \
908 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
910 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
911 if (LOG_OCCURRENCES_MOD_N == 1) \
912 google::ErrnoLogMessage( \
913 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
914 &what_to_do).stream()
916 #define SOME_KIND_OF_LOG_FIRST_N(severity, n, what_to_do) \
917 static int LOG_OCCURRENCES = 0; \
918 if (LOG_OCCURRENCES <= n) \
920 if (LOG_OCCURRENCES <= n) \
921 google::LogMessage( \
922 __FILE__, __LINE__, google::GLOG_ ## severity, LOG_OCCURRENCES, \
923 &what_to_do).stream()
925 namespace glog_internal_namespace_ {
927 struct CompileAssert {
931 // Returns true if FailureSignalHandler is installed.
932 bool IsFailureSignalHandlerInstalled();
933 } // namespace glog_internal_namespace_
935 #define GOOGLE_GLOG_COMPILE_ASSERT(expr, msg) \
936 typedef google::glog_internal_namespace_::CompileAssert<(bool(expr))> msg[bool(expr) ? 1 : -1]
938 #define LOG_EVERY_N(severity, n) \
939 GOOGLE_GLOG_COMPILE_ASSERT(google::GLOG_ ## severity < \
940 google::NUM_SEVERITIES, \
941 INVALID_REQUESTED_LOG_SEVERITY); \
942 SOME_KIND_OF_LOG_EVERY_N(severity, (n), google::LogMessage::SendToLog)
944 #define SYSLOG_EVERY_N(severity, n) \
945 SOME_KIND_OF_LOG_EVERY_N(severity, (n), google::LogMessage::SendToSyslogAndLog)
947 #define PLOG_EVERY_N(severity, n) \
948 SOME_KIND_OF_PLOG_EVERY_N(severity, (n), google::LogMessage::SendToLog)
950 #define LOG_FIRST_N(severity, n) \
951 SOME_KIND_OF_LOG_FIRST_N(severity, (n), google::LogMessage::SendToLog)
953 #define LOG_IF_EVERY_N(severity, condition, n) \
954 SOME_KIND_OF_LOG_IF_EVERY_N(severity, (condition), (n), google::LogMessage::SendToLog)
956 // We want the special COUNTER value available for LOG_EVERY_X()'ed messages
957 enum PRIVATE_Counter {COUNTER};
959 #ifdef GLOG_NO_ABBREVIATED_SEVERITIES
960 // wingdi.h defines ERROR to be 0. When we call LOG(ERROR), it gets
961 // substituted with 0, and it expands to COMPACT_GOOGLE_LOG_0. To allow us
962 // to keep using this syntax, we define this macro to do the same thing
963 // as COMPACT_GOOGLE_LOG_ERROR.
964 #define COMPACT_GOOGLE_LOG_0 COMPACT_GOOGLE_LOG_ERROR
965 #define SYSLOG_0 SYSLOG_ERROR
966 #define LOG_TO_STRING_0 LOG_TO_STRING_ERROR
967 // Needed for LOG_IS_ON(ERROR).
968 const LogSeverity GLOG_0 = GLOG_ERROR;
970 // Users may include windows.h after logging.h without
971 // GLOG_NO_ABBREVIATED_SEVERITIES nor WIN32_LEAN_AND_MEAN.
972 // For this case, we cannot detect if ERROR is defined before users
973 // actually use ERROR. Let's make an undefined symbol to warn users.
974 # define GLOG_ERROR_MSG ERROR_macro_is_defined_Define_GLOG_NO_ABBREVIATED_SEVERITIES_before_including_logging_h_See_the_document_for_detail
975 # define COMPACT_GOOGLE_LOG_0 GLOG_ERROR_MSG
976 # define SYSLOG_0 GLOG_ERROR_MSG
977 # define LOG_TO_STRING_0 GLOG_ERROR_MSG
978 # define GLOG_0 GLOG_ERROR_MSG
981 // Plus some debug-logging macros that get compiled to nothing for production
985 #define DLOG(severity) LOG(severity)
986 #define DVLOG(verboselevel) VLOG(verboselevel)
987 #define DLOG_IF(severity, condition) LOG_IF(severity, condition)
988 #define DLOG_EVERY_N(severity, n) LOG_EVERY_N(severity, n)
989 #define DLOG_IF_EVERY_N(severity, condition, n) \
990 LOG_IF_EVERY_N(severity, condition, n)
991 #define DLOG_ASSERT(condition) LOG_ASSERT(condition)
993 // debug-only checking. not executed in NDEBUG mode.
994 #define DCHECK(condition) CHECK(condition)
995 #define DCHECK_EQ(val1, val2) CHECK_EQ(val1, val2)
996 #define DCHECK_NE(val1, val2) CHECK_NE(val1, val2)
997 #define DCHECK_LE(val1, val2) CHECK_LE(val1, val2)
998 #define DCHECK_LT(val1, val2) CHECK_LT(val1, val2)
999 #define DCHECK_GE(val1, val2) CHECK_GE(val1, val2)
1000 #define DCHECK_GT(val1, val2) CHECK_GT(val1, val2)
1001 #define DCHECK_NOTNULL(val) CHECK_NOTNULL(val)
1002 #define DCHECK_STREQ(str1, str2) CHECK_STREQ(str1, str2)
1003 #define DCHECK_STRCASEEQ(str1, str2) CHECK_STRCASEEQ(str1, str2)
1004 #define DCHECK_STRNE(str1, str2) CHECK_STRNE(str1, str2)
1005 #define DCHECK_STRCASENE(str1, str2) CHECK_STRCASENE(str1, str2)
1009 #define DLOG(severity) \
1010 true ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1012 #define DVLOG(verboselevel) \
1013 (true || !VLOG_IS_ON(verboselevel)) ?\
1014 (void) 0 : google::LogMessageVoidify() & LOG(INFO)
1016 #define DLOG_IF(severity, condition) \
1017 (true || !(condition)) ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1019 #define DLOG_EVERY_N(severity, n) \
1020 true ? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1022 #define DLOG_IF_EVERY_N(severity, condition, n) \
1023 (true || !(condition))? (void) 0 : google::LogMessageVoidify() & LOG(severity)
1025 #define DLOG_ASSERT(condition) \
1026 true ? (void) 0 : LOG_ASSERT(condition)
1028 // MSVC warning C4127: conditional expression is constant
1029 #define DCHECK(condition) \
1030 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1032 GLOG_MSVC_POP_WARNING() CHECK(condition)
1034 #define DCHECK_EQ(val1, val2) \
1035 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1037 GLOG_MSVC_POP_WARNING() CHECK_EQ(val1, val2)
1039 #define DCHECK_NE(val1, val2) \
1040 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1042 GLOG_MSVC_POP_WARNING() CHECK_NE(val1, val2)
1044 #define DCHECK_LE(val1, val2) \
1045 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1047 GLOG_MSVC_POP_WARNING() CHECK_LE(val1, val2)
1049 #define DCHECK_LT(val1, val2) \
1050 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1052 GLOG_MSVC_POP_WARNING() CHECK_LT(val1, val2)
1054 #define DCHECK_GE(val1, val2) \
1055 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1057 GLOG_MSVC_POP_WARNING() CHECK_GE(val1, val2)
1059 #define DCHECK_GT(val1, val2) \
1060 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1062 GLOG_MSVC_POP_WARNING() CHECK_GT(val1, val2)
1064 // You may see warnings in release mode if you don't use the return
1065 // value of DCHECK_NOTNULL. Please just use DCHECK for such cases.
1066 #define DCHECK_NOTNULL(val) (val)
1068 #define DCHECK_STREQ(str1, str2) \
1069 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1071 GLOG_MSVC_POP_WARNING() CHECK_STREQ(str1, str2)
1073 #define DCHECK_STRCASEEQ(str1, str2) \
1074 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1076 GLOG_MSVC_POP_WARNING() CHECK_STRCASEEQ(str1, str2)
1078 #define DCHECK_STRNE(str1, str2) \
1079 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1081 GLOG_MSVC_POP_WARNING() CHECK_STRNE(str1, str2)
1083 #define DCHECK_STRCASENE(str1, str2) \
1084 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1086 GLOG_MSVC_POP_WARNING() CHECK_STRCASENE(str1, str2)
1090 // Log only in verbose mode.
1092 #define VLOG(verboselevel) LOG_IF(INFO, VLOG_IS_ON(verboselevel))
1094 #define VLOG_IF(verboselevel, condition) \
1095 LOG_IF(INFO, (condition) && VLOG_IS_ON(verboselevel))
1097 #define VLOG_EVERY_N(verboselevel, n) \
1098 LOG_IF_EVERY_N(INFO, VLOG_IS_ON(verboselevel), n)
1100 #define VLOG_IF_EVERY_N(verboselevel, condition, n) \
1101 LOG_IF_EVERY_N(INFO, (condition) && VLOG_IS_ON(verboselevel), n)
1103 namespace base_logging {
1105 // LogMessage::LogStream is a std::ostream backed by this streambuf.
1106 // This class ignores overflow and leaves two bytes at the end of the
1107 // buffer to allow for a '\n' and '\0'.
1108 class GOOGLE_GLOG_DLL_DECL LogStreamBuf : public std::streambuf {
1110 // REQUIREMENTS: "len" must be >= 2 to account for the '\n' and '\n'.
1111 LogStreamBuf(char *buf, int len) {
1112 setp(buf, buf + len - 2);
1114 // This effectively ignores overflow.
1115 virtual int_type overflow(int_type ch) {
1119 // Legacy public ostrstream method.
1120 size_t pcount() const { return pptr() - pbase(); }
1121 char* pbase() const { return std::streambuf::pbase(); }
1124 } // namespace base_logging
1127 // This class more or less represents a particular log message. You
1128 // create an instance of LogMessage and then stream stuff to it.
1129 // When you finish streaming to it, ~LogMessage is called and the
1130 // full message gets streamed to the appropriate destination.
1132 // You shouldn't actually use LogMessage's constructor to log things,
1133 // though. You should use the LOG() macro (and variants thereof)
1135 class GOOGLE_GLOG_DLL_DECL LogMessage {
1138 // Passing kNoLogPrefix for the line number disables the
1139 // log-message prefix. Useful for using the LogMessage
1140 // infrastructure as a printing utility. See also the --log_prefix
1141 // flag for controlling the log-message prefix on an
1142 // application-wide basis.
1146 // LogStream inherit from non-DLL-exported class (std::ostrstream)
1147 // and VC++ produces a warning for this situation.
1148 // However, MSDN says "C4275 can be ignored in Microsoft Visual C++
1149 // 2005 if you are deriving from a type in the Standard C++ Library"
1150 // http://msdn.microsoft.com/en-us/library/3tdb471s(VS.80).aspx
1151 // Let's just ignore the warning.
1153 # pragma warning(disable: 4275)
1155 class GOOGLE_GLOG_DLL_DECL LogStream : public std::ostream {
1157 # pragma warning(default: 4275)
1160 LogStream(char *buf, int len, int ctr)
1161 : std::ostream(NULL),
1162 streambuf_(buf, len),
1168 int ctr() const { return ctr_; }
1169 void set_ctr(int ctr) { ctr_ = ctr; }
1170 LogStream* self() const { return self_; }
1172 // Legacy std::streambuf methods.
1173 size_t pcount() const { return streambuf_.pcount(); }
1174 char* pbase() const { return streambuf_.pbase(); }
1175 char* str() const { return pbase(); }
1178 LogStream(const LogStream&);
1179 LogStream& operator=(const LogStream&);
1180 base_logging::LogStreamBuf streambuf_;
1181 int ctr_; // Counter hack (for the LOG_EVERY_X() macro)
1182 LogStream *self_; // Consistency check hack
1186 // icc 8 requires this typedef to avoid an internal compiler error.
1187 typedef void (LogMessage::*SendMethod)();
1189 LogMessage(const char* file, int line, LogSeverity severity, int ctr,
1190 SendMethod send_method);
1192 // Two special constructors that generate reduced amounts of code at
1193 // LOG call sites for common cases.
1195 // Used for LOG(INFO): Implied are:
1196 // severity = INFO, ctr = 0, send_method = &LogMessage::SendToLog.
1198 // Using this constructor instead of the more complex constructor above
1199 // saves 19 bytes per call site.
1200 LogMessage(const char* file, int line);
1202 // Used for LOG(severity) where severity != INFO. Implied
1203 // are: ctr = 0, send_method = &LogMessage::SendToLog
1205 // Using this constructor instead of the more complex constructor above
1206 // saves 17 bytes per call site.
1207 LogMessage(const char* file, int line, LogSeverity severity);
1209 // Constructor to log this message to a specified sink (if not NULL).
1210 // Implied are: ctr = 0, send_method = &LogMessage::SendToSinkAndLog if
1211 // also_send_to_log is true, send_method = &LogMessage::SendToSink otherwise.
1212 LogMessage(const char* file, int line, LogSeverity severity, LogSink* sink,
1213 bool also_send_to_log);
1215 // Constructor where we also give a vector<string> pointer
1216 // for storing the messages (if the pointer is not NULL).
1217 // Implied are: ctr = 0, send_method = &LogMessage::SaveOrSendToLog.
1218 LogMessage(const char* file, int line, LogSeverity severity,
1219 std::vector<std::string>* outvec);
1221 // Constructor where we also give a string pointer for storing the
1222 // message (if the pointer is not NULL). Implied are: ctr = 0,
1223 // send_method = &LogMessage::WriteToStringAndLog.
1224 LogMessage(const char* file, int line, LogSeverity severity,
1225 std::string* message);
1227 // A special constructor used for check failures
1228 LogMessage(const char* file, int line, const CheckOpString& result);
1232 // Flush a buffered message to the sink set in the constructor. Always
1233 // called by the destructor, it may also be called from elsewhere if
1234 // needed. Only the first call is actioned; any later ones are ignored.
1237 // An arbitrary limit on the length of a single log message. This
1238 // is so that streaming can be done more efficiently.
1239 static const size_t kMaxLogMessageLen;
1241 // Theses should not be called directly outside of logging.*,
1242 // only passed as SendMethod arguments to other LogMessage methods:
1243 void SendToLog(); // Actually dispatch to the logs
1244 void SendToSyslogAndLog(); // Actually dispatch to syslog and the logs
1246 // Call abort() or similar to perform LOG(FATAL) crash.
1249 std::ostream& stream();
1251 int preserved_errno() const;
1253 // Must be called without the log_mutex held. (L < log_mutex)
1254 static int64 num_messages(int severity);
1256 struct LogMessageData;
1259 // Fully internal SendMethod cases:
1260 void SendToSinkAndLog(); // Send to sink if provided and dispatch to the logs
1261 void SendToSink(); // Send to sink if provided, do nothing otherwise.
1263 // Write to string if provided and dispatch to the logs.
1264 void WriteToStringAndLog();
1266 void SaveOrSendToLog(); // Save to stringvec if provided, else to logs
1268 void Init(const char* file, int line, LogSeverity severity,
1269 void (LogMessage::*send_method)());
1271 // Used to fill in crash information during LOG(FATAL) failures.
1272 void RecordCrashReason(glog_internal_namespace_::CrashReason* reason);
1274 // Counts of messages sent at each priority:
1275 static int64 num_messages_[NUM_SEVERITIES]; // under log_mutex
1277 // We keep the data in a separate struct so that each instance of
1278 // LogMessage uses less stack space.
1279 LogMessageData* allocated_;
1280 LogMessageData* data_;
1282 friend class LogDestination;
1284 LogMessage(const LogMessage&);
1285 void operator=(const LogMessage&);
1288 // This class happens to be thread-hostile because all instances share
1289 // a single data buffer, but since it can only be created just before
1290 // the process dies, we don't worry so much.
1291 class GOOGLE_GLOG_DLL_DECL LogMessageFatal : public LogMessage {
1293 LogMessageFatal(const char* file, int line);
1294 LogMessageFatal(const char* file, int line, const CheckOpString& result);
1298 // A non-macro interface to the log facility; (useful
1299 // when the logging level is not a compile-time constant).
1300 inline void LogAtLevel(int const severity, std::string const &msg) {
1301 LogMessage(__FILE__, __LINE__, severity).stream() << msg;
1304 // A macro alternative of LogAtLevel. New code may want to use this
1305 // version since there are two advantages: 1. this version outputs the
1306 // file name and the line number where this macro is put like other
1307 // LOG macros, 2. this macro can be used as C++ stream.
1308 #define LOG_AT_LEVEL(severity) google::LogMessage(__FILE__, __LINE__, severity).stream()
1310 // A small helper for CHECK_NOTNULL().
1311 template <typename T>
1312 T* CheckNotNull(const char *file, int line, const char *names, T* t) {
1314 LogMessageFatal(file, line, new std::string(names));
1319 // Allow folks to put a counter in the LOG_EVERY_X()'ed messages. This
1320 // only works if ostream is a LogStream. If the ostream is not a
1321 // LogStream you'll get an assert saying as much at runtime.
1322 GOOGLE_GLOG_DLL_DECL std::ostream& operator<<(std::ostream &os,
1323 const PRIVATE_Counter&);
1326 // Derived class for PLOG*() above.
1327 class GOOGLE_GLOG_DLL_DECL ErrnoLogMessage : public LogMessage {
1330 ErrnoLogMessage(const char* file, int line, LogSeverity severity, int ctr,
1331 void (LogMessage::*send_method)());
1333 // Postpends ": strerror(errno) [errno]".
1337 ErrnoLogMessage(const ErrnoLogMessage&);
1338 void operator=(const ErrnoLogMessage&);
1342 // This class is used to explicitly ignore values in the conditional
1343 // logging macros. This avoids compiler warnings like "value computed
1344 // is not used" and "statement has no effect".
1346 class GOOGLE_GLOG_DLL_DECL LogMessageVoidify {
1348 LogMessageVoidify() { }
1349 // This has to be an operator with a precedence lower than << but
1351 void operator&(std::ostream&) { }
1355 // Flushes all log files that contains messages that are at least of
1356 // the specified severity level. Thread-safe.
1357 GOOGLE_GLOG_DLL_DECL void FlushLogFiles(LogSeverity min_severity);
1359 // Flushes all log files that contains messages that are at least of
1360 // the specified severity level. Thread-hostile because it ignores
1361 // locking -- used for catastrophic failures.
1362 GOOGLE_GLOG_DLL_DECL void FlushLogFilesUnsafe(LogSeverity min_severity);
1365 // Set the destination to which a particular severity level of log
1366 // messages is sent. If base_filename is "", it means "don't log this
1367 // severity". Thread-safe.
1369 GOOGLE_GLOG_DLL_DECL void SetLogDestination(LogSeverity severity,
1370 const char* base_filename);
1373 // Set the basename of the symlink to the latest log file at a given
1374 // severity. If symlink_basename is empty, do not make a symlink. If
1375 // you don't call this function, the symlink basename is the
1376 // invocation name of the program. Thread-safe.
1378 GOOGLE_GLOG_DLL_DECL void SetLogSymlink(LogSeverity severity,
1379 const char* symlink_basename);
1382 // Used to send logs to some other kind of destination
1383 // Users should subclass LogSink and override send to do whatever they want.
1384 // Implementations must be thread-safe because a shared instance will
1385 // be called from whichever thread ran the LOG(XXX) line.
1386 class GOOGLE_GLOG_DLL_DECL LogSink {
1390 // Sink's logging logic (message_len is such as to exclude '\n' at the end).
1391 // This method can't use LOG() or CHECK() as logging system mutex(s) are held
1392 // during this call.
1393 virtual void send(LogSeverity severity, const char* full_filename,
1394 const char* base_filename, int line,
1395 const struct ::tm* tm_time,
1396 const char* message, size_t message_len) = 0;
1398 // Redefine this to implement waiting for
1399 // the sink's logging logic to complete.
1400 // It will be called after each send() returns,
1401 // but before that LogMessage exits or crashes.
1402 // By default this function does nothing.
1403 // Using this function one can implement complex logic for send()
1404 // that itself involves logging; and do all this w/o causing deadlocks and
1405 // inconsistent rearrangement of log messages.
1406 // E.g. if a LogSink has thread-specific actions, the send() method
1407 // can simply add the message to a queue and wake up another thread that
1408 // handles real logging while itself making some LOG() calls;
1409 // WaitTillSent() can be implemented to wait for that logic to complete.
1410 // See our unittest for an example.
1411 virtual void WaitTillSent();
1413 // Returns the normal text output of the log message.
1414 // Can be useful to implement send().
1415 static std::string ToString(LogSeverity severity, const char* file, int line,
1416 const struct ::tm* tm_time,
1417 const char* message, size_t message_len);
1420 // Add or remove a LogSink as a consumer of logging data. Thread-safe.
1421 GOOGLE_GLOG_DLL_DECL void AddLogSink(LogSink *destination);
1422 GOOGLE_GLOG_DLL_DECL void RemoveLogSink(LogSink *destination);
1425 // Specify an "extension" added to the filename specified via
1426 // SetLogDestination. This applies to all severity levels. It's
1427 // often used to append the port we're listening on to the logfile
1428 // name. Thread-safe.
1430 GOOGLE_GLOG_DLL_DECL void SetLogFilenameExtension(
1431 const char* filename_extension);
1434 // Make it so that all log messages of at least a particular severity
1435 // are logged to stderr (in addition to logging to the usual log
1436 // file(s)). Thread-safe.
1438 GOOGLE_GLOG_DLL_DECL void SetStderrLogging(LogSeverity min_severity);
1441 // Make it so that all log messages go only to stderr. Thread-safe.
1443 GOOGLE_GLOG_DLL_DECL void LogToStderr();
1446 // Make it so that all log messages of at least a particular severity are
1447 // logged via email to a list of addresses (in addition to logging to the
1448 // usual log file(s)). The list of addresses is just a string containing
1449 // the email addresses to send to (separated by spaces, say). Thread-safe.
1451 GOOGLE_GLOG_DLL_DECL void SetEmailLogging(LogSeverity min_severity,
1452 const char* addresses);
1454 // A simple function that sends email. dest is a commma-separated
1455 // list of addressess. Thread-safe.
1456 GOOGLE_GLOG_DLL_DECL bool SendEmail(const char *dest,
1457 const char *subject, const char *body);
1459 GOOGLE_GLOG_DLL_DECL const std::vector<std::string>& GetLoggingDirectories();
1461 // For tests only: Clear the internal [cached] list of logging directories to
1462 // force a refresh the next time GetLoggingDirectories is called.
1464 void TestOnly_ClearLoggingDirectoriesList();
1466 // Returns a set of existing temporary directories, which will be a
1467 // subset of the directories returned by GetLogginDirectories().
1469 GOOGLE_GLOG_DLL_DECL void GetExistingTempDirectories(
1470 std::vector<std::string>* list);
1472 // Print any fatal message again -- useful to call from signal handler
1473 // so that the last thing in the output is the fatal message.
1474 // Thread-hostile, but a race is unlikely.
1475 GOOGLE_GLOG_DLL_DECL void ReprintFatalMessage();
1477 // Truncate a log file that may be the append-only output of multiple
1478 // processes and hence can't simply be renamed/reopened (typically a
1479 // stdout/stderr). If the file "path" is > "limit" bytes, copy the
1480 // last "keep" bytes to offset 0 and truncate the rest. Since we could
1481 // be racing with other writers, this approach has the potential to
1482 // lose very small amounts of data. For security, only follow symlinks
1483 // if the path is /proc/self/fd/*
1484 GOOGLE_GLOG_DLL_DECL void TruncateLogFile(const char *path,
1485 int64 limit, int64 keep);
1487 // Truncate stdout and stderr if they are over the value specified by
1488 // --max_log_size; keep the final 1MB. This function has the same
1489 // race condition as TruncateLogFile.
1490 GOOGLE_GLOG_DLL_DECL void TruncateStdoutStderr();
1492 // Return the string representation of the provided LogSeverity level.
1494 GOOGLE_GLOG_DLL_DECL const char* GetLogSeverityName(LogSeverity severity);
1496 // ---------------------------------------------------------------------
1497 // Implementation details that are not useful to most clients
1498 // ---------------------------------------------------------------------
1500 // A Logger is the interface used by logging modules to emit entries
1501 // to a log. A typical implementation will dump formatted data to a
1502 // sequence of files. We also provide interfaces that will forward
1503 // the data to another thread so that the invoker never blocks.
1504 // Implementations should be thread-safe since the logging system
1505 // will write to them from multiple threads.
1509 class GOOGLE_GLOG_DLL_DECL Logger {
1513 // Writes "message[0,message_len-1]" corresponding to an event that
1514 // occurred at "timestamp". If "force_flush" is true, the log file
1515 // is flushed immediately.
1517 // The input message has already been formatted as deemed
1518 // appropriate by the higher level logging facility. For example,
1519 // textual log messages already contain timestamps, and the
1520 // file:linenumber header.
1521 virtual void Write(bool force_flush,
1523 const char* message,
1524 int message_len) = 0;
1526 // Flush any buffered messages
1527 virtual void Flush() = 0;
1529 // Get the current LOG file size.
1530 // The returned value is approximate since some
1531 // logged data may not have been flushed to disk yet.
1532 virtual uint32 LogSize() = 0;
1535 // Get the logger for the specified severity level. The logger
1536 // remains the property of the logging module and should not be
1537 // deleted by the caller. Thread-safe.
1538 extern GOOGLE_GLOG_DLL_DECL Logger* GetLogger(LogSeverity level);
1540 // Set the logger for the specified severity level. The logger
1541 // becomes the property of the logging module and should not
1542 // be deleted by the caller. Thread-safe.
1543 extern GOOGLE_GLOG_DLL_DECL void SetLogger(LogSeverity level, Logger* logger);
1547 // glibc has traditionally implemented two incompatible versions of
1548 // strerror_r(). There is a poorly defined convention for picking the
1549 // version that we want, but it is not clear whether it even works with
1550 // all versions of glibc.
1551 // So, instead, we provide this wrapper that automatically detects the
1552 // version that is in use, and then implements POSIX semantics.
1553 // N.B. In addition to what POSIX says, we also guarantee that "buf" will
1554 // be set to an empty string, if this function failed. This means, in most
1555 // cases, you do not need to check the error code and you can directly
1556 // use the value of "buf". It will never have an undefined value.
1557 // DEPRECATED: Use StrError(int) instead.
1558 GOOGLE_GLOG_DLL_DECL int posix_strerror_r(int err, char *buf, size_t len);
1560 // A thread-safe replacement for strerror(). Returns a string describing the
1561 // given POSIX error code.
1562 GOOGLE_GLOG_DLL_DECL std::string StrError(int err);
1564 // A class for which we define operator<<, which does nothing.
1565 class GOOGLE_GLOG_DLL_DECL NullStream : public LogMessage::LogStream {
1567 // Initialize the LogStream so the messages can be written somewhere
1568 // (they'll never be actually displayed). This will be needed if a
1569 // NullStream& is implicitly converted to LogStream&, in which case
1570 // the overloaded NullStream::operator<< will not be invoked.
1571 NullStream() : LogMessage::LogStream(message_buffer_, 1, 0) { }
1572 NullStream(const char* /*file*/, int /*line*/,
1573 const CheckOpString& /*result*/) :
1574 LogMessage::LogStream(message_buffer_, 1, 0) { }
1575 NullStream &stream() { return *this; }
1577 // A very short buffer for messages (which we discard anyway). This
1578 // will be needed if NullStream& converted to LogStream& (e.g. as a
1579 // result of a conditional expression).
1580 char message_buffer_[2];
1583 // Do nothing. This operator is inline, allowing the message to be
1584 // compiled away. The message will not be compiled away if we do
1585 // something like (flag ? LOG(INFO) : LOG(ERROR)) << message; when
1586 // SKIP_LOG=WARNING. In those cases, NullStream will be implicitly
1587 // converted to LogStream and the message will be computed and then
1588 // quietly discarded.
1590 inline NullStream& operator<<(NullStream &str, const T &) { return str; }
1592 // Similar to NullStream, but aborts the program (without stack
1593 // trace), like LogMessageFatal.
1594 class GOOGLE_GLOG_DLL_DECL NullStreamFatal : public NullStream {
1596 NullStreamFatal() { }
1597 NullStreamFatal(const char* file, int line, const CheckOpString& result) :
1598 NullStream(file, line, result) { }
1599 ~NullStreamFatal() throw () { _exit(1); }
1602 // Install a signal handler that will dump signal information and a stack
1603 // trace when the program crashes on certain signals. We'll install the
1604 // signal handler for the following signals.
1606 // SIGSEGV, SIGILL, SIGFPE, SIGABRT, SIGBUS, and SIGTERM.
1608 // By default, the signal handler will write the failure dump to the
1609 // standard error. You can customize the destination by installing your
1610 // own writer function by InstallFailureWriter() below.
1612 // Note on threading:
1614 // The function should be called before threads are created, if you want
1615 // to use the failure signal handler for all threads. The stack trace
1616 // will be shown only for the thread that receives the signal. In other
1617 // words, stack traces of other threads won't be shown.
1618 GOOGLE_GLOG_DLL_DECL void InstallFailureSignalHandler();
1620 // Installs a function that is used for writing the failure dump. "data"
1621 // is the pointer to the beginning of a message to be written, and "size"
1622 // is the size of the message. You should not expect the data is
1623 // terminated with '\0'.
1624 GOOGLE_GLOG_DLL_DECL void InstallFailureWriter(
1625 void (*writer)(const char* data, int size));
1629 #endif // _LOGGING_H_