1 // Copyright (c) 1999, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
14 // * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 // This file contains #include information about logging-related stuff.
33 // Pretty much everybody needs to #include this file so that they can
34 // log various happenings.
43 #if @ac_cv_have_unistd_h@
56 // Annoying stuff for windows -- makes sure clients can import these functions
57 #ifndef GOOGLE_GLOG_DLL_DECL
58 # if defined(_WIN32) && !defined(__CYGWIN__)
59 # define GOOGLE_GLOG_DLL_DECL __declspec(dllimport)
61 # define GOOGLE_GLOG_DLL_DECL
65 // We care a lot about number of bits things take up. Unfortunately,
66 // systems define their bit-specific ints in a lot of different ways.
67 // We use our own way, and have a typedef to get there.
68 // Note: these commands below may look like "#if 1" or "#if 0", but
69 // that's because they were constructed that way at ./configure time.
70 // Look at logging.h.in to see how they're calculated (based on your config).
71 #if @ac_cv_have_stdint_h@
72 #include <stdint.h> // the normal place uint16_t is defined
74 #if @ac_cv_have_systypes_h@
75 #include <sys/types.h> // the normal place u_int16_t is defined
77 #if @ac_cv_have_inttypes_h@
78 #include <inttypes.h> // a third place for uint16_t or u_int16_t
81 #if @ac_cv_have_libgflags@
82 #include <gflags/gflags.h>
85 @ac_google_start_namespace@
87 #if @ac_cv_have_uint16_t@ // the C99 format
88 typedef int32_t int32;
89 typedef uint32_t uint32;
90 typedef int64_t int64;
91 typedef uint64_t uint64;
92 #elif @ac_cv_have_u_int16_t@ // the BSD format
93 typedef int32_t int32;
94 typedef u_int32_t uint32;
95 typedef int64_t int64;
96 typedef u_int64_t uint64;
97 #elif @ac_cv_have___uint16@ // the windows (vc7) format
98 typedef __int32 int32;
99 typedef unsigned __int32 uint32;
100 typedef __int64 int64;
101 typedef unsigned __int64 uint64;
103 #error Do not know how to define a 32-bit integer quantity on your system
106 @ac_google_end_namespace@
108 // The global value of GOOGLE_STRIP_LOG. All the messages logged to
109 // LOG(XXX) with severity less than GOOGLE_STRIP_LOG will not be displayed.
110 // If it can be determined at compile time that the message will not be
111 // printed, the statement will be compiled out.
113 // Example: to strip out all INFO and WARNING messages, use the value
114 // of 2 below. To make an exception for WARNING messages from a single
115 // file, add "#define GOOGLE_STRIP_LOG 1" to that file _before_ including
117 #ifndef GOOGLE_STRIP_LOG
118 #define GOOGLE_STRIP_LOG 0
121 // GCC can be told that a certain branch is not likely to be taken (for
122 // instance, a CHECK failure), and use that information in static analysis.
123 // Giving it this information can help it optimize for the common case in
124 // the absence of better information (ie. -fprofile-arcs).
126 #ifndef GOOGLE_PREDICT_BRANCH_NOT_TAKEN
127 #if @ac_cv_have___builtin_expect@
128 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) (__builtin_expect(x, 0))
130 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) x
134 // Make a bunch of macros for logging. The way to log things is to stream
135 // things to LOG(<a particular severity level>). E.g.,
137 // LOG(INFO) << "Found " << num_cookies << " cookies";
139 // You can capture log messages in a string, rather than reporting them
142 // vector<string> errors;
143 // LOG_STRING(ERROR, &errors) << "Couldn't parse cookie #" << cookie_num;
145 // This pushes back the new error onto 'errors'; if given a NULL pointer,
146 // it reports the error via LOG(ERROR).
148 // You can also do conditional logging:
150 // LOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
152 // You can also do occasional logging (log every n'th occurrence of an
155 // LOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
157 // The above will cause log messages to be output on the 1st, 11th, 21st, ...
158 // times it is executed. Note that the special google::COUNTER value is used
159 // to identify which repetition is happening.
161 // You can also do occasional conditional logging (log every n'th
162 // occurrence of an event, when condition is satisfied):
164 // LOG_IF_EVERY_N(INFO, (size > 1024), 10) << "Got the " << google::COUNTER
165 // << "th big cookie";
167 // You can log messages the first N times your code executes a line. E.g.
169 // LOG_FIRST_N(INFO, 20) << "Got the " << google::COUNTER << "th cookie";
171 // Outputs log messages for the first 20 times it is executed.
173 // Analogous SYSLOG, SYSLOG_IF, and SYSLOG_EVERY_N macros are available.
174 // These log to syslog as well as to the normal logs. If you use these at
175 // all, you need to be aware that syslog can drastically reduce performance,
176 // especially if it is configured for remote logging! Don't use these
177 // unless you fully understand this and have a concrete need to use them.
178 // Even then, try to minimize your use of them.
180 // There are also "debug mode" logging macros like the ones above:
182 // DLOG(INFO) << "Found cookies";
184 // DLOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
186 // DLOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
188 // All "debug mode" logging is compiled away to nothing for non-debug mode
193 // LOG_ASSERT(assertion);
194 // DLOG_ASSERT(assertion);
196 // which is syntactic sugar for {,D}LOG_IF(FATAL, assert fails) << assertion;
198 // There are "verbose level" logging macros. They look like
200 // VLOG(1) << "I'm printed when you run the program with --v=1 or more";
201 // VLOG(2) << "I'm printed when you run the program with --v=2 or more";
203 // These always log at the INFO log level (when they log at all).
204 // The verbose logging can also be turned on module-by-module. For instance,
205 // --vmodule=mapreduce=2,file=1,gfs*=3 --v=0
207 // a. VLOG(2) and lower messages to be printed from mapreduce.{h,cc}
208 // b. VLOG(1) and lower messages to be printed from file.{h,cc}
209 // c. VLOG(3) and lower messages to be printed from files prefixed with "gfs"
210 // d. VLOG(0) and lower messages to be printed from elsewhere
212 // The wildcarding functionality shown by (c) supports both '*' (match
213 // 0 or more characters) and '?' (match any single character) wildcards.
215 // There's also VLOG_IS_ON(n) "verbose level" condition macro. To be used as
217 // if (VLOG_IS_ON(2)) {
218 // // do some logging preparation and logging
219 // // that can't be accomplished with just VLOG(2) << ...;
222 // There are also VLOG_IF, VLOG_EVERY_N and VLOG_IF_EVERY_N "verbose level"
223 // condition macros for sample cases, when some extra computation and
224 // preparation for logs is not needed.
225 // VLOG_IF(1, (size > 1024))
226 // << "I'm printed when size is more than 1024 and when you run the "
227 // "program with --v=1 or more";
228 // VLOG_EVERY_N(1, 10)
229 // << "I'm printed every 10th occurrence, and when you run the program "
230 // "with --v=1 or more. Present occurence is " << google::COUNTER;
231 // VLOG_IF_EVERY_N(1, (size > 1024), 10)
232 // << "I'm printed on every 10th occurence of case when size is more "
233 // " than 1024, when you run the program with --v=1 or more. ";
234 // "Present occurence is " << google::COUNTER;
236 // The supported severity levels for macros that allow you to specify one
237 // are (in increasing order of severity) INFO, WARNING, ERROR, and FATAL.
238 // Note that messages of a given severity are logged not only in the
239 // logfile for that severity, but also in all logfiles of lower severity.
240 // E.g., a message of severity FATAL will be logged to the logfiles of
241 // severity FATAL, ERROR, WARNING, and INFO.
243 // There is also the special severity of DFATAL, which logs FATAL in
244 // debug mode, ERROR in normal mode.
246 // Very important: logging a message at the FATAL severity level causes
247 // the program to terminate (after the message is logged).
249 // Unless otherwise specified, logs will be written to the filename
250 // "<program name>.<hostname>.<user name>.log.<severity level>.", followed
251 // by the date, time, and pid (you can't prevent the date, time, and pid
252 // from being in the filename).
254 // The logging code takes two flags:
255 // --v=# set the verbose level
256 // --logtostderr log all the messages to stderr instead of to logfiles
258 // LOG LINE PREFIX FORMAT
260 // Log lines have this form:
262 // Lmmdd hh:mm:ss.uuuuuu threadid file:line] msg...
264 // where the fields are defined as follows:
266 // L A single character, representing the log level
268 // mm The month (zero padded; ie May is '05')
269 // dd The day (zero padded)
270 // hh:mm:ss.uuuuuu Time in hours, minutes and fractional seconds
271 // threadid The space-padded thread ID as returned by GetTID()
272 // (this matches the PID on Linux)
273 // file The file name
274 // line The line number
275 // msg The user-supplied message
279 // I1103 11:57:31.739339 24395 google.cc:2341] Command line: ./some_prog
280 // I1103 11:57:31.739403 24395 google.cc:2342] Process id 24395
282 // NOTE: although the microseconds are useful for comparing events on
283 // a single machine, clocks on different machines may not be well
284 // synchronized. Hence, use caution when comparing the low bits of
285 // timestamps from different machines.
287 #ifndef DECLARE_VARIABLE
288 #define MUST_UNDEF_GFLAGS_DECLARE_MACROS
289 #define DECLARE_VARIABLE(type, name, tn) \
290 namespace FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead { \
291 extern GOOGLE_GLOG_DLL_DECL type FLAGS_##name; \
293 using FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead::FLAGS_##name
295 // bool specialization
296 #define DECLARE_bool(name) \
297 DECLARE_VARIABLE(bool, name, bool)
299 // int32 specialization
300 #define DECLARE_int32(name) \
301 DECLARE_VARIABLE(@ac_google_namespace@::int32, name, int32)
303 // Special case for string, because we have to specify the namespace
304 // std::string, which doesn't play nicely with our FLAG__namespace hackery.
305 #define DECLARE_string(name) \
306 namespace FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead { \
307 extern GOOGLE_GLOG_DLL_DECL std::string FLAGS_##name; \
309 using FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead::FLAGS_##name
312 // Set whether log messages go to stderr instead of logfiles
313 DECLARE_bool(logtostderr);
315 // Set whether log messages go to stderr in addition to logfiles.
316 DECLARE_bool(alsologtostderr);
318 // Log messages at a level >= this flag are automatically sent to
319 // stderr in addition to log files.
320 DECLARE_int32(stderrthreshold);
322 // Set whether the log prefix should be prepended to each line of output.
323 DECLARE_bool(log_prefix);
325 // Log messages at a level <= this flag are buffered.
326 // Log messages at a higher level are flushed immediately.
327 DECLARE_int32(logbuflevel);
329 // Sets the maximum number of seconds which logs may be buffered for.
330 DECLARE_int32(logbufsecs);
332 // Log suppression level: messages logged at a lower level than this
334 DECLARE_int32(minloglevel);
336 // If specified, logfiles are written into this directory instead of the
337 // default logging directory.
338 DECLARE_string(log_dir);
340 // Sets the path of the directory into which to put additional links
342 DECLARE_string(log_link);
344 DECLARE_int32(v); // in vlog_is_on.cc
346 // Sets the maximum log file size (in MB).
347 DECLARE_int32(max_log_size);
349 // Sets whether to avoid logging to the disk if the disk is full.
350 DECLARE_bool(stop_logging_if_full_disk);
352 #ifdef MUST_UNDEF_GFLAGS_DECLARE_MACROS
353 #undef MUST_UNDEF_GFLAGS_DECLARE_MACROS
354 #undef DECLARE_VARIABLE
357 #undef DECLARE_string
360 // Log messages below the GOOGLE_STRIP_LOG level will be compiled away for
361 // security reasons. See LOG(severtiy) below.
363 // A few definitions of macros that don't generate much code. Since
364 // LOG(INFO) and its ilk are used all over our code, it's
365 // better to have compact code for these operations.
367 #if GOOGLE_STRIP_LOG == 0
368 #define COMPACT_GOOGLE_LOG_INFO @ac_google_namespace@::LogMessage( \
370 #define LOG_TO_STRING_INFO(message) @ac_google_namespace@::LogMessage( \
371 __FILE__, __LINE__, @ac_google_namespace@::GLOG_INFO, message)
373 #define COMPACT_GOOGLE_LOG_INFO @ac_google_namespace@::NullStream()
374 #define LOG_TO_STRING_INFO(message) @ac_google_namespace@::NullStream()
377 #if GOOGLE_STRIP_LOG <= 1
378 #define COMPACT_GOOGLE_LOG_WARNING @ac_google_namespace@::LogMessage( \
379 __FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING)
380 #define LOG_TO_STRING_WARNING(message) @ac_google_namespace@::LogMessage( \
381 __FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING, message)
383 #define COMPACT_GOOGLE_LOG_WARNING @ac_google_namespace@::NullStream()
384 #define LOG_TO_STRING_WARNING(message) @ac_google_namespace@::NullStream()
387 #if GOOGLE_STRIP_LOG <= 2
388 #define COMPACT_GOOGLE_LOG_ERROR @ac_google_namespace@::LogMessage( \
389 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR)
390 #define LOG_TO_STRING_ERROR(message) @ac_google_namespace@::LogMessage( \
391 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, message)
393 #define COMPACT_GOOGLE_LOG_ERROR @ac_google_namespace@::NullStream()
394 #define LOG_TO_STRING_ERROR(message) @ac_google_namespace@::NullStream()
397 #if GOOGLE_STRIP_LOG <= 3
398 #define COMPACT_GOOGLE_LOG_FATAL @ac_google_namespace@::LogMessageFatal( \
400 #define LOG_TO_STRING_FATAL(message) @ac_google_namespace@::LogMessage( \
401 __FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL, message)
403 #define COMPACT_GOOGLE_LOG_FATAL @ac_google_namespace@::NullStreamFatal()
404 #define LOG_TO_STRING_FATAL(message) @ac_google_namespace@::NullStreamFatal()
407 // For DFATAL, we want to use LogMessage (as opposed to
408 // LogMessageFatal), to be consistent with the original behavior.
410 #define COMPACT_GOOGLE_LOG_DFATAL COMPACT_GOOGLE_LOG_ERROR
411 #elif GOOGLE_STRIP_LOG <= 3
412 #define COMPACT_GOOGLE_LOG_DFATAL @ac_google_namespace@::LogMessage( \
413 __FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL)
415 #define COMPACT_GOOGLE_LOG_DFATAL @ac_google_namespace@::NullStreamFatal()
418 #define GOOGLE_LOG_INFO(counter) @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_INFO, counter, &@ac_google_namespace@::LogMessage::SendToLog)
419 #define SYSLOG_INFO(counter) \
420 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_INFO, counter, \
421 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
422 #define GOOGLE_LOG_WARNING(counter) \
423 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING, counter, \
424 &@ac_google_namespace@::LogMessage::SendToLog)
425 #define SYSLOG_WARNING(counter) \
426 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING, counter, \
427 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
428 #define GOOGLE_LOG_ERROR(counter) \
429 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, counter, \
430 &@ac_google_namespace@::LogMessage::SendToLog)
431 #define SYSLOG_ERROR(counter) \
432 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, counter, \
433 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
434 #define GOOGLE_LOG_FATAL(counter) \
435 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL, counter, \
436 &@ac_google_namespace@::LogMessage::SendToLog)
437 #define SYSLOG_FATAL(counter) \
438 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL, counter, \
439 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
440 #define GOOGLE_LOG_DFATAL(counter) \
441 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::DFATAL_LEVEL, counter, \
442 &@ac_google_namespace@::LogMessage::SendToLog)
443 #define SYSLOG_DFATAL(counter) \
444 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::DFATAL_LEVEL, counter, \
445 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
447 #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
448 // A very useful logging macro to log windows errors:
449 #define LOG_SYSRESULT(result) \
450 if (FAILED(result)) { \
451 LPTSTR message = NULL; \
452 LPTSTR msg = reinterpret_cast<LPTSTR>(&message); \
453 DWORD message_length = FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | \
454 FORMAT_MESSAGE_FROM_SYSTEM, \
455 0, result, 0, msg, 100, NULL); \
456 if (message_length > 0) { \
457 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, 0, \
458 &@ac_google_namespace@::LogMessage::SendToLog).stream() << message; \
459 LocalFree(message); \
464 // We use the preprocessor's merging operator, "##", so that, e.g.,
465 // LOG(INFO) becomes the token GOOGLE_LOG_INFO. There's some funny
466 // subtle difference between ostream member streaming functions (e.g.,
467 // ostream::operator<<(int) and ostream non-member streaming functions
468 // (e.g., ::operator<<(ostream&, string&): it turns out that it's
469 // impossible to stream something like a string directly to an unnamed
470 // ostream. We employ a neat hack by calling the stream() member
471 // function of LogMessage which seems to avoid the problem.
472 #define LOG(severity) COMPACT_GOOGLE_LOG_ ## severity.stream()
473 #define SYSLOG(severity) SYSLOG_ ## severity(0).stream()
475 @ac_google_start_namespace@
477 // They need the definitions of integer types.
478 #include "glog/log_severity.h"
479 #include "glog/vlog_is_on.h"
481 // Initialize google's logging library. You will see the program name
482 // specified by argv0 in log outputs.
483 GOOGLE_GLOG_DLL_DECL void InitGoogleLogging(const char* argv0);
485 // Shutdown google's logging library.
486 GOOGLE_GLOG_DLL_DECL void ShutdownGoogleLogging();
488 // Install a function which will be called after LOG(FATAL).
489 GOOGLE_GLOG_DLL_DECL void InstallFailureFunction(void (*fail_func)());
491 class LogSink; // defined below
493 // If a non-NULL sink pointer is given, we push this message to that sink.
494 // For LOG_TO_SINK we then do normal LOG(severity) logging as well.
495 // This is useful for capturing messages and passing/storing them
496 // somewhere more specific than the global log of the process.
499 // LogSeverity severity;
500 // The cast is to disambiguate NULL arguments.
501 #define LOG_TO_SINK(sink, severity) \
502 @ac_google_namespace@::LogMessage( \
503 __FILE__, __LINE__, \
504 @ac_google_namespace@::GLOG_ ## severity, \
505 static_cast<@ac_google_namespace@::LogSink*>(sink), true).stream()
506 #define LOG_TO_SINK_BUT_NOT_TO_LOGFILE(sink, severity) \
507 @ac_google_namespace@::LogMessage( \
508 __FILE__, __LINE__, \
509 @ac_google_namespace@::GLOG_ ## severity, \
510 static_cast<@ac_google_namespace@::LogSink*>(sink), false).stream()
512 // If a non-NULL string pointer is given, we write this message to that string.
513 // We then do normal LOG(severity) logging as well.
514 // This is useful for capturing messages and storing them somewhere more
515 // specific than the global log of the process.
518 // LogSeverity severity;
519 // The cast is to disambiguate NULL arguments.
520 // NOTE: LOG(severity) expands to LogMessage().stream() for the specified
522 #define LOG_TO_STRING(severity, message) \
523 LOG_TO_STRING_##severity(static_cast<string*>(message)).stream()
525 // If a non-NULL pointer is given, we push the message onto the end
526 // of a vector of strings; otherwise, we report it with LOG(severity).
527 // This is handy for capturing messages and perhaps passing them back
528 // to the caller, rather than reporting them immediately.
530 // LogSeverity severity;
531 // vector<string> *outvec;
532 // The cast is to disambiguate NULL arguments.
533 #define LOG_STRING(severity, outvec) \
534 LOG_TO_STRING_##severity(static_cast<vector<string>*>(outvec)).stream()
536 #define LOG_IF(severity, condition) \
537 !(condition) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
538 #define SYSLOG_IF(severity, condition) \
539 !(condition) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & SYSLOG(severity)
541 #define LOG_ASSERT(condition) \
542 LOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
543 #define SYSLOG_ASSERT(condition) \
544 SYSLOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
546 // CHECK dies with a fatal error if condition is not true. It is *not*
547 // controlled by NDEBUG, so the check will be executed regardless of
548 // compilation mode. Therefore, it is safe to do things like:
549 // CHECK(fp->Write(x) == 4)
550 #define CHECK(condition) \
551 LOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
552 << "Check failed: " #condition " "
554 // A container for a string pointer which can be evaluated to a bool -
555 // true iff the pointer is NULL.
556 struct CheckOpString {
557 CheckOpString(std::string* str) : str_(str) { }
558 // No destructor: if str_ is non-NULL, we're about to LOG(FATAL),
559 // so there's no point in cleaning up str_.
560 operator bool() const {
561 return GOOGLE_PREDICT_BRANCH_NOT_TAKEN(str_ != NULL);
566 // Function is overloaded for integral types to allow static const
567 // integrals declared in classes and not defined to be used as arguments to
568 // CHECK* macros. It's not encouraged though.
570 inline const T& GetReferenceableValue(const T& t) { return t; }
571 inline char GetReferenceableValue(char t) { return t; }
572 inline unsigned char GetReferenceableValue(unsigned char t) { return t; }
573 inline signed char GetReferenceableValue(signed char t) { return t; }
574 inline short GetReferenceableValue(short t) { return t; }
575 inline unsigned short GetReferenceableValue(unsigned short t) { return t; }
576 inline int GetReferenceableValue(int t) { return t; }
577 inline unsigned int GetReferenceableValue(unsigned int t) { return t; }
578 inline long GetReferenceableValue(long t) { return t; }
579 inline unsigned long GetReferenceableValue(unsigned long t) { return t; }
580 inline long long GetReferenceableValue(long long t) { return t; }
581 inline unsigned long long GetReferenceableValue(unsigned long long t) {
585 // This is a dummy class to define the following operator.
586 struct DummyClassToDefineOperator {};
588 @ac_google_end_namespace@
590 // Define global operator<< to declare using ::operator<<.
591 // This declaration will allow use to use CHECK macros for user
592 // defined classes which have operator<< (e.g., stl_logging.h).
593 inline std::ostream& operator<<(
594 std::ostream& out, const google::DummyClassToDefineOperator&) {
598 @ac_google_start_namespace@
600 // Build the error message string.
601 template<class t1, class t2>
602 std::string* MakeCheckOpString(const t1& v1, const t2& v2, const char* names) {
603 // It means that we cannot use stl_logging if compiler doesn't
604 // support using expression for operator.
605 // TODO(hamaji): Figure out a way to fix.
606 #if @ac_cv_cxx_using_operator@
610 ss << names << " (" << v1 << " vs. " << v2 << ")";
611 return new std::string(ss.str(), ss.pcount());
614 // Helper functions for CHECK_OP macro.
615 // The (int, int) specialization works around the issue that the compiler
616 // will not instantiate the template version of the function on values of
617 // unnamed enum type - see comment below.
618 #define DEFINE_CHECK_OP_IMPL(name, op) \
619 template <class t1, class t2> \
620 inline std::string* Check##name##Impl(const t1& v1, const t2& v2, \
621 const char* names) { \
622 if (v1 op v2) return NULL; \
623 else return MakeCheckOpString(v1, v2, names); \
625 inline std::string* Check##name##Impl(int v1, int v2, const char* names) { \
626 return Check##name##Impl<int, int>(v1, v2, names); \
629 // Use _EQ, _NE, _LE, etc. in case the file including base/logging.h
630 // provides its own #defines for the simpler names EQ, NE, LE, etc.
631 // This happens if, for example, those are used as token names in a
633 DEFINE_CHECK_OP_IMPL(_EQ, ==)
634 DEFINE_CHECK_OP_IMPL(_NE, !=)
635 DEFINE_CHECK_OP_IMPL(_LE, <=)
636 DEFINE_CHECK_OP_IMPL(_LT, < )
637 DEFINE_CHECK_OP_IMPL(_GE, >=)
638 DEFINE_CHECK_OP_IMPL(_GT, > )
639 #undef DEFINE_CHECK_OP_IMPL
641 // Helper macro for binary operators.
642 // Don't use this macro directly in your code, use CHECK_EQ et al below.
644 #if defined(STATIC_ANALYSIS)
645 // Only for static analysis tool to know that it is equivalent to assert
646 #define CHECK_OP_LOG(name, op, val1, val2, log) CHECK((val1) op (val2))
647 #elif !defined(NDEBUG)
648 // In debug mode, avoid constructing CheckOpStrings if possible,
649 // to reduce the overhead of CHECK statments by 2x.
650 // Real DCHECK-heavy tests have seen 1.5x speedups.
652 // The meaning of "string" might be different between now and
653 // when this macro gets invoked (e.g., if someone is experimenting
654 // with other string implementations that get defined after this
655 // file is included). Save the current meaning now and use it
657 typedef std::string _Check_string;
658 #define CHECK_OP_LOG(name, op, val1, val2, log) \
659 while (@ac_google_namespace@::_Check_string* _result = \
660 @ac_google_namespace@::Check##name##Impl( \
661 @ac_google_namespace@::GetReferenceableValue(val1), \
662 @ac_google_namespace@::GetReferenceableValue(val2), \
663 #val1 " " #op " " #val2)) \
664 log(__FILE__, __LINE__, \
665 @ac_google_namespace@::CheckOpString(_result)).stream()
667 // In optimized mode, use CheckOpString to hint to compiler that
668 // the while condition is unlikely.
669 #define CHECK_OP_LOG(name, op, val1, val2, log) \
670 while (@ac_google_namespace@::CheckOpString _result = \
671 @ac_google_namespace@::Check##name##Impl( \
672 @ac_google_namespace@::GetReferenceableValue(val1), \
673 @ac_google_namespace@::GetReferenceableValue(val2), \
674 #val1 " " #op " " #val2)) \
675 log(__FILE__, __LINE__, _result).stream()
676 #endif // STATIC_ANALYSIS, !NDEBUG
678 #if GOOGLE_STRIP_LOG <= 3
679 #define CHECK_OP(name, op, val1, val2) \
680 CHECK_OP_LOG(name, op, val1, val2, @ac_google_namespace@::LogMessageFatal)
682 #define CHECK_OP(name, op, val1, val2) \
683 CHECK_OP_LOG(name, op, val1, val2, @ac_google_namespace@::NullStreamFatal)
684 #endif // STRIP_LOG <= 3
686 // Equality/Inequality checks - compare two values, and log a FATAL message
687 // including the two values when the result is not as expected. The values
688 // must have operator<<(ostream, ...) defined.
690 // You may append to the error message like so:
691 // CHECK_NE(1, 2) << ": The world must be ending!";
693 // We are very careful to ensure that each argument is evaluated exactly
694 // once, and that anything which is legal to pass as a function argument is
695 // legal here. In particular, the arguments may be temporary expressions
696 // which will end up being destroyed at the end of the apparent statement,
698 // CHECK_EQ(string("abc")[1], 'b');
700 // WARNING: These don't compile correctly if one of the arguments is a pointer
701 // and the other is NULL. To work around this, simply static_cast NULL to the
702 // type of the desired pointer.
704 #define CHECK_EQ(val1, val2) CHECK_OP(_EQ, ==, val1, val2)
705 #define CHECK_NE(val1, val2) CHECK_OP(_NE, !=, val1, val2)
706 #define CHECK_LE(val1, val2) CHECK_OP(_LE, <=, val1, val2)
707 #define CHECK_LT(val1, val2) CHECK_OP(_LT, < , val1, val2)
708 #define CHECK_GE(val1, val2) CHECK_OP(_GE, >=, val1, val2)
709 #define CHECK_GT(val1, val2) CHECK_OP(_GT, > , val1, val2)
711 // Check that the input is non NULL. This very useful in constructor
712 // initializer lists.
714 #define CHECK_NOTNULL(val) \
715 @ac_google_namespace@::CheckNotNull(__FILE__, __LINE__, "'" #val "' Must be non NULL", (val))
717 // Helper functions for string comparisons.
718 // To avoid bloat, the definitions are in logging.cc.
719 #define DECLARE_CHECK_STROP_IMPL(func, expected) \
720 GOOGLE_GLOG_DLL_DECL std::string* Check##func##expected##Impl( \
721 const char* s1, const char* s2, const char* names);
722 DECLARE_CHECK_STROP_IMPL(strcmp, true)
723 DECLARE_CHECK_STROP_IMPL(strcmp, false)
724 DECLARE_CHECK_STROP_IMPL(strcasecmp, true)
725 DECLARE_CHECK_STROP_IMPL(strcasecmp, false)
726 #undef DECLARE_CHECK_STROP_IMPL
728 // Helper macro for string comparisons.
729 // Don't use this macro directly in your code, use CHECK_STREQ et al below.
730 #define CHECK_STROP(func, op, expected, s1, s2) \
731 while (@ac_google_namespace@::CheckOpString _result = \
732 @ac_google_namespace@::Check##func##expected##Impl((s1), (s2), \
733 #s1 " " #op " " #s2)) \
734 LOG(FATAL) << *_result.str_
737 // String (char*) equality/inequality checks.
738 // CASE versions are case-insensitive.
740 // Note that "s1" and "s2" may be temporary strings which are destroyed
741 // by the compiler at the end of the current "full expression"
742 // (e.g. CHECK_STREQ(Foo().c_str(), Bar().c_str())).
744 #define CHECK_STREQ(s1, s2) CHECK_STROP(strcmp, ==, true, s1, s2)
745 #define CHECK_STRNE(s1, s2) CHECK_STROP(strcmp, !=, false, s1, s2)
746 #define CHECK_STRCASEEQ(s1, s2) CHECK_STROP(strcasecmp, ==, true, s1, s2)
747 #define CHECK_STRCASENE(s1, s2) CHECK_STROP(strcasecmp, !=, false, s1, s2)
749 #define CHECK_INDEX(I,A) CHECK(I < (sizeof(A)/sizeof(A[0])))
750 #define CHECK_BOUND(B,A) CHECK(B <= (sizeof(A)/sizeof(A[0])))
752 #define CHECK_DOUBLE_EQ(val1, val2) \
754 CHECK_LE((val1), (val2)+0.000000000000001L); \
755 CHECK_GE((val1), (val2)-0.000000000000001L); \
758 #define CHECK_NEAR(val1, val2, margin) \
760 CHECK_LE((val1), (val2)+(margin)); \
761 CHECK_GE((val1), (val2)-(margin)); \
764 // perror()..googly style!
766 // PLOG() and PLOG_IF() and PCHECK() behave exactly like their LOG* and
767 // CHECK equivalents with the addition that they postpend a description
768 // of the current state of errno to their output lines.
770 #define PLOG(severity) GOOGLE_PLOG(severity, 0).stream()
772 #define GOOGLE_PLOG(severity, counter) \
773 @ac_google_namespace@::ErrnoLogMessage( \
774 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, counter, \
775 &@ac_google_namespace@::LogMessage::SendToLog)
777 #define PLOG_IF(severity, condition) \
778 !(condition) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & PLOG(severity)
780 // A CHECK() macro that postpends errno if the condition is false. E.g.
782 // if (poll(fds, nfds, timeout) == -1) { PCHECK(errno == EINTR); ... }
783 #define PCHECK(condition) \
784 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
785 << "Check failed: " #condition " "
787 // A CHECK() macro that lets you assert the success of a function that
788 // returns -1 and sets errno in case of an error. E.g.
790 // CHECK_ERR(mkdir(path, 0700));
794 // int fd = open(filename, flags); CHECK_ERR(fd) << ": open " << filename;
795 #define CHECK_ERR(invocation) \
796 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN((invocation) == -1)) \
799 // Use macro expansion to create, for each use of LOG_EVERY_N(), static
800 // variables with the __LINE__ expansion as part of the variable name.
801 #define LOG_EVERY_N_VARNAME(base, line) LOG_EVERY_N_VARNAME_CONCAT(base, line)
802 #define LOG_EVERY_N_VARNAME_CONCAT(base, line) base ## line
804 #define LOG_OCCURRENCES LOG_EVERY_N_VARNAME(occurrences_, __LINE__)
805 #define LOG_OCCURRENCES_MOD_N LOG_EVERY_N_VARNAME(occurrences_mod_n_, __LINE__)
807 #define SOME_KIND_OF_LOG_EVERY_N(severity, n, what_to_do) \
808 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
810 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
811 if (LOG_OCCURRENCES_MOD_N == 1) \
812 @ac_google_namespace@::LogMessage( \
813 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
814 &what_to_do).stream()
816 #define SOME_KIND_OF_LOG_IF_EVERY_N(severity, condition, n, what_to_do) \
817 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
820 ((LOG_OCCURRENCES_MOD_N=(LOG_OCCURRENCES_MOD_N + 1) % n) == (1 % n))) \
821 @ac_google_namespace@::LogMessage( \
822 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
823 &what_to_do).stream()
825 #define SOME_KIND_OF_PLOG_EVERY_N(severity, n, what_to_do) \
826 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
828 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
829 if (LOG_OCCURRENCES_MOD_N == 1) \
830 @ac_google_namespace@::ErrnoLogMessage( \
831 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
832 &what_to_do).stream()
834 #define SOME_KIND_OF_LOG_FIRST_N(severity, n, what_to_do) \
835 static int LOG_OCCURRENCES = 0; \
836 if (LOG_OCCURRENCES <= n) \
838 if (LOG_OCCURRENCES <= n) \
839 @ac_google_namespace@::LogMessage( \
840 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
841 &what_to_do).stream()
843 namespace glog_internal_namespace_ {
845 struct CompileAssert {
848 } // namespace glog_internal_namespace_
850 #define GOOGLE_GLOG_COMPILE_ASSERT(expr, msg) \
851 typedef @ac_google_namespace@::glog_internal_namespace_::CompileAssert<(bool(expr))> msg[bool(expr) ? 1 : -1]
853 #define LOG_EVERY_N(severity, n) \
854 GOOGLE_GLOG_COMPILE_ASSERT(@ac_google_namespace@::GLOG_ ## severity < \
855 @ac_google_namespace@::NUM_SEVERITIES, \
856 INVALID_REQUESTED_LOG_SEVERITY); \
857 SOME_KIND_OF_LOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
859 #define SYSLOG_EVERY_N(severity, n) \
860 SOME_KIND_OF_LOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToSyslogAndLog)
862 #define PLOG_EVERY_N(severity, n) \
863 SOME_KIND_OF_PLOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
865 #define LOG_FIRST_N(severity, n) \
866 SOME_KIND_OF_LOG_FIRST_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
868 #define LOG_IF_EVERY_N(severity, condition, n) \
869 SOME_KIND_OF_LOG_IF_EVERY_N(severity, (condition), (n), @ac_google_namespace@::LogMessage::SendToLog)
871 // We want the special COUNTER value available for LOG_EVERY_X()'ed messages
872 enum PRIVATE_Counter {COUNTER};
874 #ifdef GLOG_NO_ABBREVIATED_SEVERITIES
875 // wingdi.h defines ERROR to be 0. When we call LOG(ERROR), it gets
876 // substituted with 0, and it expands to COMPACT_GOOGLE_LOG_0. To allow us
877 // to keep using this syntax, we define this macro to do the same thing
878 // as COMPACT_GOOGLE_LOG_ERROR.
879 #define COMPACT_GOOGLE_LOG_0 COMPACT_GOOGLE_LOG_ERROR
880 #define SYSLOG_0 SYSLOG_ERROR
881 #define LOG_TO_STRING_0 LOG_TO_STRING_ERROR
882 // Needed for LOG_IS_ON(ERROR).
883 const LogSeverity GLOG_0 = GLOG_ERROR;
885 // Users may include windows.h after logging.h without
886 // GLOG_NO_ABBREVIATED_SEVERITIES nor WIN32_LEAN_AND_MEAN.
887 // For this case, we cannot detect if ERROR is defined before users
888 // actually use ERROR. Let's make an undefined symbol to warn users.
889 # define GLOG_ERROR_MSG ERROR_macro_is_defined_Define_GLOG_NO_ABBREVIATED_SEVERITIES_before_including_logging_h_See_the_document_for_detail
890 # define COMPACT_GOOGLE_LOG_0 GLOG_ERROR_MSG
891 # define SYSLOG_0 GLOG_ERROR_MSG
892 # define LOG_TO_STRING_0 GLOG_ERROR_MSG
893 # define GLOG_0 GLOG_ERROR_MSG
896 // Plus some debug-logging macros that get compiled to nothing for production
900 #define DLOG(severity) LOG(severity)
901 #define DVLOG(verboselevel) VLOG(verboselevel)
902 #define DLOG_IF(severity, condition) LOG_IF(severity, condition)
903 #define DLOG_EVERY_N(severity, n) LOG_EVERY_N(severity, n)
904 #define DLOG_IF_EVERY_N(severity, condition, n) \
905 LOG_IF_EVERY_N(severity, condition, n)
906 #define DLOG_ASSERT(condition) LOG_ASSERT(condition)
908 // debug-only checking. not executed in NDEBUG mode.
909 #define DCHECK(condition) CHECK(condition)
910 #define DCHECK_EQ(val1, val2) CHECK_EQ(val1, val2)
911 #define DCHECK_NE(val1, val2) CHECK_NE(val1, val2)
912 #define DCHECK_LE(val1, val2) CHECK_LE(val1, val2)
913 #define DCHECK_LT(val1, val2) CHECK_LT(val1, val2)
914 #define DCHECK_GE(val1, val2) CHECK_GE(val1, val2)
915 #define DCHECK_GT(val1, val2) CHECK_GT(val1, val2)
916 #define DCHECK_NOTNULL(val) CHECK_NOTNULL(val)
917 #define DCHECK_STREQ(str1, str2) CHECK_STREQ(str1, str2)
918 #define DCHECK_STRCASEEQ(str1, str2) CHECK_STRCASEEQ(str1, str2)
919 #define DCHECK_STRNE(str1, str2) CHECK_STRNE(str1, str2)
920 #define DCHECK_STRCASENE(str1, str2) CHECK_STRCASENE(str1, str2)
924 #define DLOG(severity) \
925 true ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
927 #define DVLOG(verboselevel) \
928 (true || !VLOG_IS_ON(verboselevel)) ?\
929 (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(INFO)
931 #define DLOG_IF(severity, condition) \
932 (true || !(condition)) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
934 #define DLOG_EVERY_N(severity, n) \
935 true ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
937 #define DLOG_IF_EVERY_N(severity, condition, n) \
938 (true || !(condition))? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
940 #define DLOG_ASSERT(condition) \
941 true ? (void) 0 : LOG_ASSERT(condition)
943 #define DCHECK(condition) \
947 #define DCHECK_EQ(val1, val2) \
951 #define DCHECK_NE(val1, val2) \
955 #define DCHECK_LE(val1, val2) \
959 #define DCHECK_LT(val1, val2) \
963 #define DCHECK_GE(val1, val2) \
967 #define DCHECK_GT(val1, val2) \
971 #define DCHECK_NOTNULL(val) (val)
973 #define DCHECK_STREQ(str1, str2) \
975 CHECK_STREQ(str1, str2)
977 #define DCHECK_STRCASEEQ(str1, str2) \
979 CHECK_STRCASEEQ(str1, str2)
981 #define DCHECK_STRNE(str1, str2) \
983 CHECK_STRNE(str1, str2)
985 #define DCHECK_STRCASENE(str1, str2) \
987 CHECK_STRCASENE(str1, str2)
992 // Log only in verbose mode.
994 #define VLOG(verboselevel) LOG_IF(INFO, VLOG_IS_ON(verboselevel))
996 #define VLOG_IF(verboselevel, condition) \
997 LOG_IF(INFO, (condition) && VLOG_IS_ON(verboselevel))
999 #define VLOG_EVERY_N(verboselevel, n) \
1000 LOG_IF_EVERY_N(INFO, VLOG_IS_ON(verboselevel), n)
1002 #define VLOG_IF_EVERY_N(verboselevel, condition, n) \
1003 LOG_IF_EVERY_N(INFO, (condition) && VLOG_IS_ON(verboselevel), n)
1006 // This class more or less represents a particular log message. You
1007 // create an instance of LogMessage and then stream stuff to it.
1008 // When you finish streaming to it, ~LogMessage is called and the
1009 // full message gets streamed to the appropriate destination.
1011 // You shouldn't actually use LogMessage's constructor to log things,
1012 // though. You should use the LOG() macro (and variants thereof)
1014 class GOOGLE_GLOG_DLL_DECL LogMessage {
1017 // Passing kNoLogPrefix for the line number disables the
1018 // log-message prefix. Useful for using the LogMessage
1019 // infrastructure as a printing utility. See also the --log_prefix
1020 // flag for controlling the log-message prefix on an
1021 // application-wide basis.
1025 // LogStream inherit from non-DLL-exported class (std::ostrstream)
1026 // and VC++ produces a warning for this situation.
1027 // However, MSDN says "C4275 can be ignored in Microsoft Visual C++
1028 // 2005 if you are deriving from a type in the Standard C++ Library"
1029 // http://msdn.microsoft.com/en-us/library/3tdb471s(VS.80).aspx
1030 // Let's just ignore the warning.
1032 # pragma warning(disable: 4275)
1034 class GOOGLE_GLOG_DLL_DECL LogStream : public std::ostrstream {
1036 # pragma warning(default: 4275)
1039 LogStream(char *buf, int len, int ctr_in)
1040 : ostrstream(buf, len),
1045 int ctr() const { return ctr_; }
1046 void set_ctr(int ctr_in) { ctr_ = ctr_in; }
1047 LogStream* self() const { return self_; }
1050 int ctr_; // Counter hack (for the LOG_EVERY_X() macro)
1051 LogStream *self_; // Consistency check hack
1055 // icc 8 requires this typedef to avoid an internal compiler error.
1056 typedef void (LogMessage::*SendMethod)();
1058 LogMessage(const char* file, int line, LogSeverity severity, int ctr,
1059 SendMethod send_method);
1061 // Two special constructors that generate reduced amounts of code at
1062 // LOG call sites for common cases.
1064 // Used for LOG(INFO): Implied are:
1065 // severity = INFO, ctr = 0, send_method = &LogMessage::SendToLog.
1067 // Using this constructor instead of the more complex constructor above
1068 // saves 19 bytes per call site.
1069 LogMessage(const char* file, int line);
1071 // Used for LOG(severity) where severity != INFO. Implied
1072 // are: ctr = 0, send_method = &LogMessage::SendToLog
1074 // Using this constructor instead of the more complex constructor above
1075 // saves 17 bytes per call site.
1076 LogMessage(const char* file, int line, LogSeverity severity);
1078 // Constructor to log this message to a specified sink (if not NULL).
1079 // Implied are: ctr = 0, send_method = &LogMessage::SendToSinkAndLog if
1080 // also_send_to_log is true, send_method = &LogMessage::SendToSink otherwise.
1081 LogMessage(const char* file, int line, LogSeverity severity, LogSink* sink,
1082 bool also_send_to_log);
1084 // Constructor where we also give a vector<string> pointer
1085 // for storing the messages (if the pointer is not NULL).
1086 // Implied are: ctr = 0, send_method = &LogMessage::SaveOrSendToLog.
1087 LogMessage(const char* file, int line, LogSeverity severity,
1088 std::vector<std::string>* outvec);
1090 // Constructor where we also give a string pointer for storing the
1091 // message (if the pointer is not NULL). Implied are: ctr = 0,
1092 // send_method = &LogMessage::WriteToStringAndLog.
1093 LogMessage(const char* file, int line, LogSeverity severity,
1094 std::string* message);
1096 // A special constructor used for check failures
1097 LogMessage(const char* file, int line, const CheckOpString& result);
1101 // Flush a buffered message to the sink set in the constructor. Always
1102 // called by the destructor, it may also be called from elsewhere if
1103 // needed. Only the first call is actioned; any later ones are ignored.
1106 // An arbitrary limit on the length of a single log message. This
1107 // is so that streaming can be done more efficiently.
1108 static const size_t kMaxLogMessageLen;
1110 // Theses should not be called directly outside of logging.*,
1111 // only passed as SendMethod arguments to other LogMessage methods:
1112 void SendToLog(); // Actually dispatch to the logs
1113 void SendToSyslogAndLog(); // Actually dispatch to syslog and the logs
1115 // Call abort() or similar to perform LOG(FATAL) crash.
1116 static void Fail() @ac_cv___attribute___noreturn@;
1118 std::ostream& stream() { return *(data_->stream_); }
1120 int preserved_errno() const { return data_->preserved_errno_; }
1122 // Must be called without the log_mutex held. (L < log_mutex)
1123 static int64 num_messages(int severity);
1126 // Fully internal SendMethod cases:
1127 void SendToSinkAndLog(); // Send to sink if provided and dispatch to the logs
1128 void SendToSink(); // Send to sink if provided, do nothing otherwise.
1130 // Write to string if provided and dispatch to the logs.
1131 void WriteToStringAndLog();
1133 void SaveOrSendToLog(); // Save to stringvec if provided, else to logs
1135 void Init(const char* file, int line, LogSeverity severity,
1136 void (LogMessage::*send_method)());
1138 // Used to fill in crash information during LOG(FATAL) failures.
1139 void RecordCrashReason(glog_internal_namespace_::CrashReason* reason);
1141 // Counts of messages sent at each priority:
1142 static int64 num_messages_[NUM_SEVERITIES]; // under log_mutex
1144 // We keep the data in a separate struct so that each instance of
1145 // LogMessage uses less stack space.
1146 struct GOOGLE_GLOG_DLL_DECL LogMessageData {
1147 LogMessageData() {};
1149 int preserved_errno_; // preserved errno
1151 char* message_text_; // Complete message text (points to selected buffer)
1152 LogStream* stream_alloc_;
1154 char severity_; // What level is this LogMessage logged at?
1155 int line_; // line number where logging call is.
1156 void (LogMessage::*send_method_)(); // Call this in destructor to send
1157 union { // At most one of these is used: union to keep the size low.
1158 LogSink* sink_; // NULL or sink to send message to
1159 std::vector<std::string>* outvec_; // NULL or vector to push message onto
1160 std::string* message_; // NULL or string to write message into
1162 time_t timestamp_; // Time of creation of LogMessage
1163 struct ::tm tm_time_; // Time of creation of LogMessage
1164 size_t num_prefix_chars_; // # of chars of prefix in this message
1165 size_t num_chars_to_log_; // # of chars of msg to send to log
1166 size_t num_chars_to_syslog_; // # of chars of msg to send to syslog
1167 const char* basename_; // basename of file that called LOG
1168 const char* fullname_; // fullname of file that called LOG
1169 bool has_been_flushed_; // false => data has not been flushed
1170 bool first_fatal_; // true => this was first fatal msg
1174 LogMessageData(const LogMessageData&);
1175 void operator=(const LogMessageData&);
1178 static LogMessageData fatal_msg_data_exclusive_;
1179 static LogMessageData fatal_msg_data_shared_;
1181 LogMessageData* allocated_;
1182 LogMessageData* data_;
1184 friend class LogDestination;
1186 LogMessage(const LogMessage&);
1187 void operator=(const LogMessage&);
1190 // This class happens to be thread-hostile because all instances share
1191 // a single data buffer, but since it can only be created just before
1192 // the process dies, we don't worry so much.
1193 class GOOGLE_GLOG_DLL_DECL LogMessageFatal : public LogMessage {
1195 LogMessageFatal(const char* file, int line);
1196 LogMessageFatal(const char* file, int line, const CheckOpString& result);
1197 ~LogMessageFatal() @ac_cv___attribute___noreturn@;
1200 // A non-macro interface to the log facility; (useful
1201 // when the logging level is not a compile-time constant).
1202 inline void LogAtLevel(int const severity, std::string const &msg) {
1203 LogMessage(__FILE__, __LINE__, severity).stream() << msg;
1206 // A macro alternative of LogAtLevel. New code may want to use this
1207 // version since there are two advantages: 1. this version outputs the
1208 // file name and the line number where this macro is put like other
1209 // LOG macros, 2. this macro can be used as C++ stream.
1210 #define LOG_AT_LEVEL(severity) @ac_google_namespace@::LogMessage(__FILE__, __LINE__, severity).stream()
1212 // A small helper for CHECK_NOTNULL().
1213 template <typename T>
1214 T* CheckNotNull(const char *file, int line, const char *names, T* t) {
1216 LogMessageFatal(file, line, new std::string(names));
1221 // Allow folks to put a counter in the LOG_EVERY_X()'ed messages. This
1222 // only works if ostream is a LogStream. If the ostream is not a
1223 // LogStream you'll get an assert saying as much at runtime.
1224 GOOGLE_GLOG_DLL_DECL std::ostream& operator<<(std::ostream &os,
1225 const PRIVATE_Counter&);
1228 // Derived class for PLOG*() above.
1229 class GOOGLE_GLOG_DLL_DECL ErrnoLogMessage : public LogMessage {
1232 ErrnoLogMessage(const char* file, int line, LogSeverity severity, int ctr,
1233 void (LogMessage::*send_method)());
1235 // Postpends ": strerror(errno) [errno]".
1239 ErrnoLogMessage(const ErrnoLogMessage&);
1240 void operator=(const ErrnoLogMessage&);
1244 // This class is used to explicitly ignore values in the conditional
1245 // logging macros. This avoids compiler warnings like "value computed
1246 // is not used" and "statement has no effect".
1248 class GOOGLE_GLOG_DLL_DECL LogMessageVoidify {
1250 LogMessageVoidify() { }
1251 // This has to be an operator with a precedence lower than << but
1253 void operator&(std::ostream&) { }
1257 // Flushes all log files that contains messages that are at least of
1258 // the specified severity level. Thread-safe.
1259 GOOGLE_GLOG_DLL_DECL void FlushLogFiles(LogSeverity min_severity);
1261 // Flushes all log files that contains messages that are at least of
1262 // the specified severity level. Thread-hostile because it ignores
1263 // locking -- used for catastrophic failures.
1264 GOOGLE_GLOG_DLL_DECL void FlushLogFilesUnsafe(LogSeverity min_severity);
1267 // Set the destination to which a particular severity level of log
1268 // messages is sent. If base_filename is "", it means "don't log this
1269 // severity". Thread-safe.
1271 GOOGLE_GLOG_DLL_DECL void SetLogDestination(LogSeverity severity,
1272 const char* base_filename);
1275 // Set the basename of the symlink to the latest log file at a given
1276 // severity. If symlink_basename is empty, do not make a symlink. If
1277 // you don't call this function, the symlink basename is the
1278 // invocation name of the program. Thread-safe.
1280 GOOGLE_GLOG_DLL_DECL void SetLogSymlink(LogSeverity severity,
1281 const char* symlink_basename);
1284 // Used to send logs to some other kind of destination
1285 // Users should subclass LogSink and override send to do whatever they want.
1286 // Implementations must be thread-safe because a shared instance will
1287 // be called from whichever thread ran the LOG(XXX) line.
1288 class GOOGLE_GLOG_DLL_DECL LogSink {
1292 // Sink's logging logic (message_len is such as to exclude '\n' at the end).
1293 // This method can't use LOG() or CHECK() as logging system mutex(s) are held
1294 // during this call.
1295 virtual void send(LogSeverity severity, const char* full_filename,
1296 const char* base_filename, int line,
1297 const struct ::tm* tm_time,
1298 const char* message, size_t message_len) = 0;
1300 // Redefine this to implement waiting for
1301 // the sink's logging logic to complete.
1302 // It will be called after each send() returns,
1303 // but before that LogMessage exits or crashes.
1304 // By default this function does nothing.
1305 // Using this function one can implement complex logic for send()
1306 // that itself involves logging; and do all this w/o causing deadlocks and
1307 // inconsistent rearrangement of log messages.
1308 // E.g. if a LogSink has thread-specific actions, the send() method
1309 // can simply add the message to a queue and wake up another thread that
1310 // handles real logging while itself making some LOG() calls;
1311 // WaitTillSent() can be implemented to wait for that logic to complete.
1312 // See our unittest for an example.
1313 virtual void WaitTillSent();
1315 // Returns the normal text output of the log message.
1316 // Can be useful to implement send().
1317 static std::string ToString(LogSeverity severity, const char* file, int line,
1318 const struct ::tm* tm_time,
1319 const char* message, size_t message_len);
1322 // Add or remove a LogSink as a consumer of logging data. Thread-safe.
1323 GOOGLE_GLOG_DLL_DECL void AddLogSink(LogSink *destination);
1324 GOOGLE_GLOG_DLL_DECL void RemoveLogSink(LogSink *destination);
1327 // Specify an "extension" added to the filename specified via
1328 // SetLogDestination. This applies to all severity levels. It's
1329 // often used to append the port we're listening on to the logfile
1330 // name. Thread-safe.
1332 GOOGLE_GLOG_DLL_DECL void SetLogFilenameExtension(
1333 const char* filename_extension);
1336 // Make it so that all log messages of at least a particular severity
1337 // are logged to stderr (in addition to logging to the usual log
1338 // file(s)). Thread-safe.
1340 GOOGLE_GLOG_DLL_DECL void SetStderrLogging(LogSeverity min_severity);
1343 // Make it so that all log messages go only to stderr. Thread-safe.
1345 GOOGLE_GLOG_DLL_DECL void LogToStderr();
1348 // Make it so that all log messages of at least a particular severity are
1349 // logged via email to a list of addresses (in addition to logging to the
1350 // usual log file(s)). The list of addresses is just a string containing
1351 // the email addresses to send to (separated by spaces, say). Thread-safe.
1353 GOOGLE_GLOG_DLL_DECL void SetEmailLogging(LogSeverity min_severity,
1354 const char* addresses);
1356 // A simple function that sends email. dest is a commma-separated
1357 // list of addressess. Thread-safe.
1358 GOOGLE_GLOG_DLL_DECL bool SendEmail(const char *dest,
1359 const char *subject, const char *body);
1361 GOOGLE_GLOG_DLL_DECL const std::vector<std::string>& GetLoggingDirectories();
1363 // For tests only: Clear the internal [cached] list of logging directories to
1364 // force a refresh the next time GetLoggingDirectories is called.
1366 void TestOnly_ClearLoggingDirectoriesList();
1368 // Returns a set of existing temporary directories, which will be a
1369 // subset of the directories returned by GetLogginDirectories().
1371 GOOGLE_GLOG_DLL_DECL void GetExistingTempDirectories(
1372 std::vector<std::string>* list);
1374 // Print any fatal message again -- useful to call from signal handler
1375 // so that the last thing in the output is the fatal message.
1376 // Thread-hostile, but a race is unlikely.
1377 GOOGLE_GLOG_DLL_DECL void ReprintFatalMessage();
1379 // Truncate a log file that may be the append-only output of multiple
1380 // processes and hence can't simply be renamed/reopened (typically a
1381 // stdout/stderr). If the file "path" is > "limit" bytes, copy the
1382 // last "keep" bytes to offset 0 and truncate the rest. Since we could
1383 // be racing with other writers, this approach has the potential to
1384 // lose very small amounts of data. For security, only follow symlinks
1385 // if the path is /proc/self/fd/*
1386 GOOGLE_GLOG_DLL_DECL void TruncateLogFile(const char *path,
1387 int64 limit, int64 keep);
1389 // Truncate stdout and stderr if they are over the value specified by
1390 // --max_log_size; keep the final 1MB. This function has the same
1391 // race condition as TruncateLogFile.
1392 GOOGLE_GLOG_DLL_DECL void TruncateStdoutStderr();
1394 // Return the string representation of the provided LogSeverity level.
1396 GOOGLE_GLOG_DLL_DECL const char* GetLogSeverityName(LogSeverity severity);
1398 // ---------------------------------------------------------------------
1399 // Implementation details that are not useful to most clients
1400 // ---------------------------------------------------------------------
1402 // A Logger is the interface used by logging modules to emit entries
1403 // to a log. A typical implementation will dump formatted data to a
1404 // sequence of files. We also provide interfaces that will forward
1405 // the data to another thread so that the invoker never blocks.
1406 // Implementations should be thread-safe since the logging system
1407 // will write to them from multiple threads.
1411 class GOOGLE_GLOG_DLL_DECL Logger {
1415 // Writes "message[0,message_len-1]" corresponding to an event that
1416 // occurred at "timestamp". If "force_flush" is true, the log file
1417 // is flushed immediately.
1419 // The input message has already been formatted as deemed
1420 // appropriate by the higher level logging facility. For example,
1421 // textual log messages already contain timestamps, and the
1422 // file:linenumber header.
1423 virtual void Write(bool force_flush,
1425 const char* message,
1426 int message_len) = 0;
1428 // Flush any buffered messages
1429 virtual void Flush() = 0;
1431 // Get the current LOG file size.
1432 // The returned value is approximate since some
1433 // logged data may not have been flushed to disk yet.
1434 virtual uint32 LogSize() = 0;
1437 // Get the logger for the specified severity level. The logger
1438 // remains the property of the logging module and should not be
1439 // deleted by the caller. Thread-safe.
1440 extern GOOGLE_GLOG_DLL_DECL Logger* GetLogger(LogSeverity level);
1442 // Set the logger for the specified severity level. The logger
1443 // becomes the property of the logging module and should not
1444 // be deleted by the caller. Thread-safe.
1445 extern GOOGLE_GLOG_DLL_DECL void SetLogger(LogSeverity level, Logger* logger);
1449 // glibc has traditionally implemented two incompatible versions of
1450 // strerror_r(). There is a poorly defined convention for picking the
1451 // version that we want, but it is not clear whether it even works with
1452 // all versions of glibc.
1453 // So, instead, we provide this wrapper that automatically detects the
1454 // version that is in use, and then implements POSIX semantics.
1455 // N.B. In addition to what POSIX says, we also guarantee that "buf" will
1456 // be set to an empty string, if this function failed. This means, in most
1457 // cases, you do not need to check the error code and you can directly
1458 // use the value of "buf". It will never have an undefined value.
1459 GOOGLE_GLOG_DLL_DECL int posix_strerror_r(int err, char *buf, size_t len);
1462 // A class for which we define operator<<, which does nothing.
1463 class GOOGLE_GLOG_DLL_DECL NullStream : public LogMessage::LogStream {
1465 // Initialize the LogStream so the messages can be written somewhere
1466 // (they'll never be actually displayed). This will be needed if a
1467 // NullStream& is implicitly converted to LogStream&, in which case
1468 // the overloaded NullStream::operator<< will not be invoked.
1469 NullStream() : LogMessage::LogStream(message_buffer_, 1, 0) { }
1470 NullStream(const char* /*file*/, int /*line*/,
1471 const CheckOpString& /*result*/) :
1472 LogMessage::LogStream(message_buffer_, 1, 0) { }
1473 NullStream &stream() { return *this; }
1475 // A very short buffer for messages (which we discard anyway). This
1476 // will be needed if NullStream& converted to LogStream& (e.g. as a
1477 // result of a conditional expression).
1478 char message_buffer_[2];
1481 // Do nothing. This operator is inline, allowing the message to be
1482 // compiled away. The message will not be compiled away if we do
1483 // something like (flag ? LOG(INFO) : LOG(ERROR)) << message; when
1484 // SKIP_LOG=WARNING. In those cases, NullStream will be implicitly
1485 // converted to LogStream and the message will be computed and then
1486 // quietly discarded.
1488 inline NullStream& operator<<(NullStream &str, const T &) { return str; }
1490 // Similar to NullStream, but aborts the program (without stack
1491 // trace), like LogMessageFatal.
1492 class GOOGLE_GLOG_DLL_DECL NullStreamFatal : public NullStream {
1494 NullStreamFatal() { }
1495 NullStreamFatal(const char* file, int line, const CheckOpString& result) :
1496 NullStream(file, line, result) { }
1497 @ac_cv___attribute___noreturn@ ~NullStreamFatal() { _exit(1); }
1500 // Install a signal handler that will dump signal information and a stack
1501 // trace when the program crashes on certain signals. We'll install the
1502 // signal handler for the following signals.
1504 // SIGSEGV, SIGILL, SIGFPE, SIGABRT, SIGBUS, and SIGTERM.
1506 // By default, the signal handler will write the failure dump to the
1507 // standard error. You can customize the destination by installing your
1508 // own writer function by InstallFailureWriter() below.
1510 // Note on threading:
1512 // The function should be called before threads are created, if you want
1513 // to use the failure signal handler for all threads. The stack trace
1514 // will be shown only for the thread that receives the signal. In other
1515 // words, stack traces of other threads won't be shown.
1516 GOOGLE_GLOG_DLL_DECL void InstallFailureSignalHandler();
1518 // Installs a function that is used for writing the failure dump. "data"
1519 // is the pointer to the beginning of a message to be written, and "size"
1520 // is the size of the message. You should not expect the data is
1521 // terminated with '\0'.
1522 GOOGLE_GLOG_DLL_DECL void InstallFailureWriter(
1523 void (*writer)(const char* data, int size));
1525 @ac_google_end_namespace@
1527 #endif // _LOGGING_H_