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.
46 #if @ac_cv_have_unistd_h@
51 // Annoying stuff for windows -- makes sure clients can import these functions
52 #ifndef GOOGLE_GLOG_DLL_DECL
53 # if defined(_WIN32) && !defined(__CYGWIN__)
54 # define GOOGLE_GLOG_DLL_DECL __declspec(dllimport)
56 # define GOOGLE_GLOG_DLL_DECL
60 #define GLOG_MSVC_PUSH_DISABLE_WARNING(n) __pragma(warning(push)) \
61 __pragma(warning(disable:n))
62 #define GLOG_MSVC_POP_WARNING() __pragma(warning(pop))
64 #define GLOG_MSVC_PUSH_DISABLE_WARNING(n)
65 #define GLOG_MSVC_POP_WARNING()
68 // We care a lot about number of bits things take up. Unfortunately,
69 // systems define their bit-specific ints in a lot of different ways.
70 // We use our own way, and have a typedef to get there.
71 // Note: these commands below may look like "#if 1" or "#if 0", but
72 // that's because they were constructed that way at ./configure time.
73 // Look at logging.h.in to see how they're calculated (based on your config).
74 #if @ac_cv_have_stdint_h@
75 #include <stdint.h> // the normal place uint16_t is defined
77 #if @ac_cv_have_systypes_h@
78 #include <sys/types.h> // the normal place u_int16_t is defined
80 #if @ac_cv_have_inttypes_h@
81 #include <inttypes.h> // a third place for uint16_t or u_int16_t
84 #if @ac_cv_have_libgflags@
85 #include <gflags/gflags.h>
88 @ac_google_start_namespace@
90 #if @ac_cv_have_uint16_t@ // the C99 format
91 typedef int32_t int32;
92 typedef uint32_t uint32;
93 typedef int64_t int64;
94 typedef uint64_t uint64;
95 #elif @ac_cv_have_u_int16_t@ // the BSD format
96 typedef int32_t int32;
97 typedef u_int32_t uint32;
98 typedef int64_t int64;
99 typedef u_int64_t uint64;
100 #elif @ac_cv_have___uint16@ // the windows (vc7) format
101 typedef __int32 int32;
102 typedef unsigned __int32 uint32;
103 typedef __int64 int64;
104 typedef unsigned __int64 uint64;
106 #error Do not know how to define a 32-bit integer quantity on your system
109 @ac_google_end_namespace@
111 // The global value of GOOGLE_STRIP_LOG. All the messages logged to
112 // LOG(XXX) with severity less than GOOGLE_STRIP_LOG will not be displayed.
113 // If it can be determined at compile time that the message will not be
114 // printed, the statement will be compiled out.
116 // Example: to strip out all INFO and WARNING messages, use the value
117 // of 2 below. To make an exception for WARNING messages from a single
118 // file, add "#define GOOGLE_STRIP_LOG 1" to that file _before_ including
120 #ifndef GOOGLE_STRIP_LOG
121 #define GOOGLE_STRIP_LOG 0
124 // GCC can be told that a certain branch is not likely to be taken (for
125 // instance, a CHECK failure), and use that information in static analysis.
126 // Giving it this information can help it optimize for the common case in
127 // the absence of better information (ie. -fprofile-arcs).
129 #ifndef GOOGLE_PREDICT_BRANCH_NOT_TAKEN
130 #if @ac_cv_have___builtin_expect@
131 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) (__builtin_expect(x, 0))
133 #define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) x
137 #ifndef GOOGLE_PREDICT_FALSE
138 #if @ac_cv_have___builtin_expect@
139 #define GOOGLE_PREDICT_FALSE(x) (__builtin_expect(x, 0))
141 #define GOOGLE_PREDICT_FALSE(x) x
145 #ifndef GOOGLE_PREDICT_TRUE
146 #if @ac_cv_have___builtin_expect@
147 #define GOOGLE_PREDICT_TRUE(x) (__builtin_expect(!!(x), 1))
149 #define GOOGLE_PREDICT_TRUE(x) x
154 // Make a bunch of macros for logging. The way to log things is to stream
155 // things to LOG(<a particular severity level>). E.g.,
157 // LOG(INFO) << "Found " << num_cookies << " cookies";
159 // You can capture log messages in a string, rather than reporting them
162 // vector<string> errors;
163 // LOG_STRING(ERROR, &errors) << "Couldn't parse cookie #" << cookie_num;
165 // This pushes back the new error onto 'errors'; if given a NULL pointer,
166 // it reports the error via LOG(ERROR).
168 // You can also do conditional logging:
170 // LOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
172 // You can also do occasional logging (log every n'th occurrence of an
175 // LOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
177 // The above will cause log messages to be output on the 1st, 11th, 21st, ...
178 // times it is executed. Note that the special google::COUNTER value is used
179 // to identify which repetition is happening.
181 // You can also do occasional conditional logging (log every n'th
182 // occurrence of an event, when condition is satisfied):
184 // LOG_IF_EVERY_N(INFO, (size > 1024), 10) << "Got the " << google::COUNTER
185 // << "th big cookie";
187 // You can log messages the first N times your code executes a line. E.g.
189 // LOG_FIRST_N(INFO, 20) << "Got the " << google::COUNTER << "th cookie";
191 // Outputs log messages for the first 20 times it is executed.
193 // Analogous SYSLOG, SYSLOG_IF, and SYSLOG_EVERY_N macros are available.
194 // These log to syslog as well as to the normal logs. If you use these at
195 // all, you need to be aware that syslog can drastically reduce performance,
196 // especially if it is configured for remote logging! Don't use these
197 // unless you fully understand this and have a concrete need to use them.
198 // Even then, try to minimize your use of them.
200 // There are also "debug mode" logging macros like the ones above:
202 // DLOG(INFO) << "Found cookies";
204 // DLOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
206 // DLOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
208 // All "debug mode" logging is compiled away to nothing for non-debug mode
213 // LOG_ASSERT(assertion);
214 // DLOG_ASSERT(assertion);
216 // which is syntactic sugar for {,D}LOG_IF(FATAL, assert fails) << assertion;
218 // There are "verbose level" logging macros. They look like
220 // VLOG(1) << "I'm printed when you run the program with --v=1 or more";
221 // VLOG(2) << "I'm printed when you run the program with --v=2 or more";
223 // These always log at the INFO log level (when they log at all).
224 // The verbose logging can also be turned on module-by-module. For instance,
225 // --vmodule=mapreduce=2,file=1,gfs*=3 --v=0
227 // a. VLOG(2) and lower messages to be printed from mapreduce.{h,cc}
228 // b. VLOG(1) and lower messages to be printed from file.{h,cc}
229 // c. VLOG(3) and lower messages to be printed from files prefixed with "gfs"
230 // d. VLOG(0) and lower messages to be printed from elsewhere
232 // The wildcarding functionality shown by (c) supports both '*' (match
233 // 0 or more characters) and '?' (match any single character) wildcards.
235 // There's also VLOG_IS_ON(n) "verbose level" condition macro. To be used as
237 // if (VLOG_IS_ON(2)) {
238 // // do some logging preparation and logging
239 // // that can't be accomplished with just VLOG(2) << ...;
242 // There are also VLOG_IF, VLOG_EVERY_N and VLOG_IF_EVERY_N "verbose level"
243 // condition macros for sample cases, when some extra computation and
244 // preparation for logs is not needed.
245 // VLOG_IF(1, (size > 1024))
246 // << "I'm printed when size is more than 1024 and when you run the "
247 // "program with --v=1 or more";
248 // VLOG_EVERY_N(1, 10)
249 // << "I'm printed every 10th occurrence, and when you run the program "
250 // "with --v=1 or more. Present occurence is " << google::COUNTER;
251 // VLOG_IF_EVERY_N(1, (size > 1024), 10)
252 // << "I'm printed on every 10th occurence of case when size is more "
253 // " than 1024, when you run the program with --v=1 or more. ";
254 // "Present occurence is " << google::COUNTER;
256 // The supported severity levels for macros that allow you to specify one
257 // are (in increasing order of severity) INFO, WARNING, ERROR, and FATAL.
258 // Note that messages of a given severity are logged not only in the
259 // logfile for that severity, but also in all logfiles of lower severity.
260 // E.g., a message of severity FATAL will be logged to the logfiles of
261 // severity FATAL, ERROR, WARNING, and INFO.
263 // There is also the special severity of DFATAL, which logs FATAL in
264 // debug mode, ERROR in normal mode.
266 // Very important: logging a message at the FATAL severity level causes
267 // the program to terminate (after the message is logged).
269 // Unless otherwise specified, logs will be written to the filename
270 // "<program name>.<hostname>.<user name>.log.<severity level>.", followed
271 // by the date, time, and pid (you can't prevent the date, time, and pid
272 // from being in the filename).
274 // The logging code takes two flags:
275 // --v=# set the verbose level
276 // --logtostderr log all the messages to stderr instead of to logfiles
278 // LOG LINE PREFIX FORMAT
280 // Log lines have this form:
282 // Lmmdd hh:mm:ss.uuuuuu threadid file:line] msg...
284 // where the fields are defined as follows:
286 // L A single character, representing the log level
288 // mm The month (zero padded; ie May is '05')
289 // dd The day (zero padded)
290 // hh:mm:ss.uuuuuu Time in hours, minutes and fractional seconds
291 // threadid The space-padded thread ID as returned by GetTID()
292 // (this matches the PID on Linux)
293 // file The file name
294 // line The line number
295 // msg The user-supplied message
299 // I1103 11:57:31.739339 24395 google.cc:2341] Command line: ./some_prog
300 // I1103 11:57:31.739403 24395 google.cc:2342] Process id 24395
302 // NOTE: although the microseconds are useful for comparing events on
303 // a single machine, clocks on different machines may not be well
304 // synchronized. Hence, use caution when comparing the low bits of
305 // timestamps from different machines.
307 #ifndef DECLARE_VARIABLE
308 #define MUST_UNDEF_GFLAGS_DECLARE_MACROS
309 #define DECLARE_VARIABLE(type, shorttype, name, tn) \
310 namespace fL##shorttype { \
311 extern GOOGLE_GLOG_DLL_DECL type FLAGS_##name; \
313 using fL##shorttype::FLAGS_##name
315 // bool specialization
316 #define DECLARE_bool(name) \
317 DECLARE_VARIABLE(bool, B, name, bool)
319 // int32 specialization
320 #define DECLARE_int32(name) \
321 DECLARE_VARIABLE(@ac_google_namespace@::int32, I, name, int32)
323 // Special case for string, because we have to specify the namespace
324 // std::string, which doesn't play nicely with our FLAG__namespace hackery.
325 #define DECLARE_string(name) \
327 extern GOOGLE_GLOG_DLL_DECL std::string& FLAGS_##name; \
329 using fLS::FLAGS_##name
332 // Set whether log messages go to stderr instead of logfiles
333 DECLARE_bool(logtostderr);
335 // Set whether log messages go to stderr in addition to logfiles.
336 DECLARE_bool(alsologtostderr);
338 // Set color messages logged to stderr (if supported by terminal).
339 DECLARE_bool(colorlogtostderr);
341 // Log messages at a level >= this flag are automatically sent to
342 // stderr in addition to log files.
343 DECLARE_int32(stderrthreshold);
345 // Set whether the log prefix should be prepended to each line of output.
346 DECLARE_bool(log_prefix);
348 // Log messages at a level <= this flag are buffered.
349 // Log messages at a higher level are flushed immediately.
350 DECLARE_int32(logbuflevel);
352 // Sets the maximum number of seconds which logs may be buffered for.
353 DECLARE_int32(logbufsecs);
355 // Log suppression level: messages logged at a lower level than this
357 DECLARE_int32(minloglevel);
359 // If specified, logfiles are written into this directory instead of the
360 // default logging directory.
361 DECLARE_string(log_dir);
363 // Sets the path of the directory into which to put additional links
365 DECLARE_string(log_link);
367 DECLARE_int32(v); // in vlog_is_on.cc
369 // Sets the maximum log file size (in MB).
370 DECLARE_int32(max_log_size);
372 // Sets whether to avoid logging to the disk if the disk is full.
373 DECLARE_bool(stop_logging_if_full_disk);
375 #ifdef MUST_UNDEF_GFLAGS_DECLARE_MACROS
376 #undef MUST_UNDEF_GFLAGS_DECLARE_MACROS
377 #undef DECLARE_VARIABLE
380 #undef DECLARE_string
383 // Log messages below the GOOGLE_STRIP_LOG level will be compiled away for
384 // security reasons. See LOG(severtiy) below.
386 // A few definitions of macros that don't generate much code. Since
387 // LOG(INFO) and its ilk are used all over our code, it's
388 // better to have compact code for these operations.
390 #if GOOGLE_STRIP_LOG == 0
391 #define COMPACT_GOOGLE_LOG_INFO @ac_google_namespace@::LogMessage( \
393 #define LOG_TO_STRING_INFO(message) @ac_google_namespace@::LogMessage( \
394 __FILE__, __LINE__, @ac_google_namespace@::GLOG_INFO, message)
396 #define COMPACT_GOOGLE_LOG_INFO @ac_google_namespace@::NullStream()
397 #define LOG_TO_STRING_INFO(message) @ac_google_namespace@::NullStream()
400 #if GOOGLE_STRIP_LOG <= 1
401 #define COMPACT_GOOGLE_LOG_WARNING @ac_google_namespace@::LogMessage( \
402 __FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING)
403 #define LOG_TO_STRING_WARNING(message) @ac_google_namespace@::LogMessage( \
404 __FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING, message)
406 #define COMPACT_GOOGLE_LOG_WARNING @ac_google_namespace@::NullStream()
407 #define LOG_TO_STRING_WARNING(message) @ac_google_namespace@::NullStream()
410 #if GOOGLE_STRIP_LOG <= 2
411 #define COMPACT_GOOGLE_LOG_ERROR @ac_google_namespace@::LogMessage( \
412 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR)
413 #define LOG_TO_STRING_ERROR(message) @ac_google_namespace@::LogMessage( \
414 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, message)
416 #define COMPACT_GOOGLE_LOG_ERROR @ac_google_namespace@::NullStream()
417 #define LOG_TO_STRING_ERROR(message) @ac_google_namespace@::NullStream()
420 #if GOOGLE_STRIP_LOG <= 3
421 #define COMPACT_GOOGLE_LOG_FATAL @ac_google_namespace@::LogMessageFatal( \
423 #define LOG_TO_STRING_FATAL(message) @ac_google_namespace@::LogMessage( \
424 __FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL, message)
426 #define COMPACT_GOOGLE_LOG_FATAL @ac_google_namespace@::NullStreamFatal()
427 #define LOG_TO_STRING_FATAL(message) @ac_google_namespace@::NullStreamFatal()
430 // For DFATAL, we want to use LogMessage (as opposed to
431 // LogMessageFatal), to be consistent with the original behavior.
433 #define COMPACT_GOOGLE_LOG_DFATAL COMPACT_GOOGLE_LOG_ERROR
434 #elif GOOGLE_STRIP_LOG <= 3
435 #define COMPACT_GOOGLE_LOG_DFATAL @ac_google_namespace@::LogMessage( \
436 __FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL)
438 #define COMPACT_GOOGLE_LOG_DFATAL @ac_google_namespace@::NullStreamFatal()
441 #define GOOGLE_LOG_INFO(counter) @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_INFO, counter, &@ac_google_namespace@::LogMessage::SendToLog)
442 #define SYSLOG_INFO(counter) \
443 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_INFO, counter, \
444 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
445 #define GOOGLE_LOG_WARNING(counter) \
446 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING, counter, \
447 &@ac_google_namespace@::LogMessage::SendToLog)
448 #define SYSLOG_WARNING(counter) \
449 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_WARNING, counter, \
450 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
451 #define GOOGLE_LOG_ERROR(counter) \
452 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, counter, \
453 &@ac_google_namespace@::LogMessage::SendToLog)
454 #define SYSLOG_ERROR(counter) \
455 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, counter, \
456 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
457 #define GOOGLE_LOG_FATAL(counter) \
458 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL, counter, \
459 &@ac_google_namespace@::LogMessage::SendToLog)
460 #define SYSLOG_FATAL(counter) \
461 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_FATAL, counter, \
462 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
463 #define GOOGLE_LOG_DFATAL(counter) \
464 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::DFATAL_LEVEL, counter, \
465 &@ac_google_namespace@::LogMessage::SendToLog)
466 #define SYSLOG_DFATAL(counter) \
467 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::DFATAL_LEVEL, counter, \
468 &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
470 #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
471 // A very useful logging macro to log windows errors:
472 #define LOG_SYSRESULT(result) \
473 if (FAILED(HRESULT_FROM_WIN32(result))) { \
474 LPSTR message = NULL; \
475 LPSTR msg = reinterpret_cast<LPSTR>(&message); \
476 DWORD message_length = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | \
477 FORMAT_MESSAGE_FROM_SYSTEM, \
478 0, result, 0, msg, 100, NULL); \
479 if (message_length > 0) { \
480 @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::GLOG_ERROR, 0, \
481 &@ac_google_namespace@::LogMessage::SendToLog).stream() \
482 << reinterpret_cast<const char*>(message); \
483 LocalFree(message); \
488 // We use the preprocessor's merging operator, "##", so that, e.g.,
489 // LOG(INFO) becomes the token GOOGLE_LOG_INFO. There's some funny
490 // subtle difference between ostream member streaming functions (e.g.,
491 // ostream::operator<<(int) and ostream non-member streaming functions
492 // (e.g., ::operator<<(ostream&, string&): it turns out that it's
493 // impossible to stream something like a string directly to an unnamed
494 // ostream. We employ a neat hack by calling the stream() member
495 // function of LogMessage which seems to avoid the problem.
496 #define LOG(severity) COMPACT_GOOGLE_LOG_ ## severity.stream()
497 #define SYSLOG(severity) SYSLOG_ ## severity(0).stream()
499 @ac_google_start_namespace@
501 // They need the definitions of integer types.
502 #include "glog/log_severity.h"
503 #include "glog/vlog_is_on.h"
505 // Initialize google's logging library. You will see the program name
506 // specified by argv0 in log outputs.
507 GOOGLE_GLOG_DLL_DECL void InitGoogleLogging(const char* argv0);
509 // Shutdown google's logging library.
510 GOOGLE_GLOG_DLL_DECL void ShutdownGoogleLogging();
512 // Install a function which will be called after LOG(FATAL).
513 GOOGLE_GLOG_DLL_DECL void InstallFailureFunction(void (*fail_func)());
515 class LogSink; // defined below
517 // If a non-NULL sink pointer is given, we push this message to that sink.
518 // For LOG_TO_SINK we then do normal LOG(severity) logging as well.
519 // This is useful for capturing messages and passing/storing them
520 // somewhere more specific than the global log of the process.
523 // LogSeverity severity;
524 // The cast is to disambiguate NULL arguments.
525 #define LOG_TO_SINK(sink, severity) \
526 @ac_google_namespace@::LogMessage( \
527 __FILE__, __LINE__, \
528 @ac_google_namespace@::GLOG_ ## severity, \
529 static_cast<@ac_google_namespace@::LogSink*>(sink), true).stream()
530 #define LOG_TO_SINK_BUT_NOT_TO_LOGFILE(sink, severity) \
531 @ac_google_namespace@::LogMessage( \
532 __FILE__, __LINE__, \
533 @ac_google_namespace@::GLOG_ ## severity, \
534 static_cast<@ac_google_namespace@::LogSink*>(sink), false).stream()
536 // If a non-NULL string pointer is given, we write this message to that string.
537 // We then do normal LOG(severity) logging as well.
538 // This is useful for capturing messages and storing them somewhere more
539 // specific than the global log of the process.
542 // LogSeverity severity;
543 // The cast is to disambiguate NULL arguments.
544 // NOTE: LOG(severity) expands to LogMessage().stream() for the specified
546 #define LOG_TO_STRING(severity, message) \
547 LOG_TO_STRING_##severity(static_cast<string*>(message)).stream()
549 // If a non-NULL pointer is given, we push the message onto the end
550 // of a vector of strings; otherwise, we report it with LOG(severity).
551 // This is handy for capturing messages and perhaps passing them back
552 // to the caller, rather than reporting them immediately.
554 // LogSeverity severity;
555 // vector<string> *outvec;
556 // The cast is to disambiguate NULL arguments.
557 #define LOG_STRING(severity, outvec) \
558 LOG_TO_STRING_##severity(static_cast<std::vector<std::string>*>(outvec)).stream()
560 #define LOG_IF(severity, condition) \
561 !(condition) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
562 #define SYSLOG_IF(severity, condition) \
563 !(condition) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & SYSLOG(severity)
565 #define LOG_ASSERT(condition) \
566 LOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
567 #define SYSLOG_ASSERT(condition) \
568 SYSLOG_IF(FATAL, !(condition)) << "Assert failed: " #condition
570 // CHECK dies with a fatal error if condition is not true. It is *not*
571 // controlled by NDEBUG, so the check will be executed regardless of
572 // compilation mode. Therefore, it is safe to do things like:
573 // CHECK(fp->Write(x) == 4)
574 #define CHECK(condition) \
575 LOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
576 << "Check failed: " #condition " "
578 // A container for a string pointer which can be evaluated to a bool -
579 // true iff the pointer is NULL.
580 struct CheckOpString {
581 CheckOpString(std::string* str) : str_(str) { }
582 // No destructor: if str_ is non-NULL, we're about to LOG(FATAL),
583 // so there's no point in cleaning up str_.
584 operator bool() const {
585 return GOOGLE_PREDICT_BRANCH_NOT_TAKEN(str_ != NULL);
590 // Function is overloaded for integral types to allow static const
591 // integrals declared in classes and not defined to be used as arguments to
592 // CHECK* macros. It's not encouraged though.
594 inline const T& GetReferenceableValue(const T& t) { return t; }
595 inline char GetReferenceableValue(char t) { return t; }
596 inline unsigned char GetReferenceableValue(unsigned char t) { return t; }
597 inline signed char GetReferenceableValue(signed char t) { return t; }
598 inline short GetReferenceableValue(short t) { return t; }
599 inline unsigned short GetReferenceableValue(unsigned short t) { return t; }
600 inline int GetReferenceableValue(int t) { return t; }
601 inline unsigned int GetReferenceableValue(unsigned int t) { return t; }
602 inline long GetReferenceableValue(long t) { return t; }
603 inline unsigned long GetReferenceableValue(unsigned long t) { return t; }
604 inline long long GetReferenceableValue(long long t) { return t; }
605 inline unsigned long long GetReferenceableValue(unsigned long long t) {
609 // This is a dummy class to define the following operator.
610 struct DummyClassToDefineOperator {};
612 @ac_google_end_namespace@
614 // Define global operator<< to declare using ::operator<<.
615 // This declaration will allow use to use CHECK macros for user
616 // defined classes which have operator<< (e.g., stl_logging.h).
617 inline std::ostream& operator<<(
618 std::ostream& out, const google::DummyClassToDefineOperator&) {
622 @ac_google_start_namespace@
624 // This formats a value for a failing CHECK_XX statement. Ordinarily,
625 // it uses the definition for operator<<, with a few special cases below.
626 template <typename T>
627 inline void MakeCheckOpValueString(std::ostream* os, const T& v) {
631 // Overrides for char types provide readable values for unprintable
633 template <> GOOGLE_GLOG_DLL_DECL
634 void MakeCheckOpValueString(std::ostream* os, const char& v);
635 template <> GOOGLE_GLOG_DLL_DECL
636 void MakeCheckOpValueString(std::ostream* os, const signed char& v);
637 template <> GOOGLE_GLOG_DLL_DECL
638 void MakeCheckOpValueString(std::ostream* os, const unsigned char& v);
640 // Build the error message string. Specify no inlining for code size.
641 template <typename T1, typename T2>
642 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext)
643 @ac_cv___attribute___noinline@;
648 // If "s" is less than base_logging::INFO, returns base_logging::INFO.
649 // If "s" is greater than base_logging::FATAL, returns
650 // base_logging::ERROR. Otherwise, returns "s".
651 LogSeverity NormalizeSeverity(LogSeverity s);
653 } // namespace internal
655 // A helper class for formatting "expr (V1 vs. V2)" in a CHECK_XX
656 // statement. See MakeCheckOpString for sample usage. Other
657 // approaches were considered: use of a template method (e.g.,
658 // base::BuildCheckOpString(exprtext, base::Print<T1>, &v1,
659 // base::Print<T2>, &v2), however this approach has complications
660 // related to volatile arguments and function-pointer arguments).
661 class GOOGLE_GLOG_DLL_DECL CheckOpMessageBuilder {
663 // Inserts "exprtext" and " (" to the stream.
664 explicit CheckOpMessageBuilder(const char *exprtext);
665 // Deletes "stream_".
666 ~CheckOpMessageBuilder();
667 // For inserting the first variable.
668 std::ostream* ForVar1() { return stream_; }
669 // For inserting the second variable (adds an intermediate " vs. ").
670 std::ostream* ForVar2();
671 // Get the result (inserts the closing ")").
672 std::string* NewString();
675 std::ostringstream *stream_;
680 template <typename T1, typename T2>
681 std::string* MakeCheckOpString(const T1& v1, const T2& v2, const char* exprtext) {
682 base::CheckOpMessageBuilder comb(exprtext);
683 MakeCheckOpValueString(comb.ForVar1(), v1);
684 MakeCheckOpValueString(comb.ForVar2(), v2);
685 return comb.NewString();
688 // Helper functions for CHECK_OP macro.
689 // The (int, int) specialization works around the issue that the compiler
690 // will not instantiate the template version of the function on values of
691 // unnamed enum type - see comment below.
692 #define DEFINE_CHECK_OP_IMPL(name, op) \
693 template <typename T1, typename T2> \
694 inline std::string* name##Impl(const T1& v1, const T2& v2, \
695 const char* exprtext) { \
696 if (GOOGLE_PREDICT_TRUE(v1 op v2)) return NULL; \
697 else return MakeCheckOpString(v1, v2, exprtext); \
699 inline std::string* name##Impl(int v1, int v2, const char* exprtext) { \
700 return name##Impl<int, int>(v1, v2, exprtext); \
703 // We use the full name Check_EQ, Check_NE, etc. in case the file including
704 // base/logging.h provides its own #defines for the simpler names EQ, NE, etc.
705 // This happens if, for example, those are used as token names in a
707 DEFINE_CHECK_OP_IMPL(Check_EQ, ==) // Compilation error with CHECK_EQ(NULL, x)?
708 DEFINE_CHECK_OP_IMPL(Check_NE, !=) // Use CHECK(x == NULL) instead.
709 DEFINE_CHECK_OP_IMPL(Check_LE, <=)
710 DEFINE_CHECK_OP_IMPL(Check_LT, < )
711 DEFINE_CHECK_OP_IMPL(Check_GE, >=)
712 DEFINE_CHECK_OP_IMPL(Check_GT, > )
713 #undef DEFINE_CHECK_OP_IMPL
715 // Helper macro for binary operators.
716 // Don't use this macro directly in your code, use CHECK_EQ et al below.
718 #if defined(STATIC_ANALYSIS)
719 // Only for static analysis tool to know that it is equivalent to assert
720 #define CHECK_OP_LOG(name, op, val1, val2, log) CHECK((val1) op (val2))
721 #elif !defined(NDEBUG)
722 // In debug mode, avoid constructing CheckOpStrings if possible,
723 // to reduce the overhead of CHECK statments by 2x.
724 // Real DCHECK-heavy tests have seen 1.5x speedups.
726 // The meaning of "string" might be different between now and
727 // when this macro gets invoked (e.g., if someone is experimenting
728 // with other string implementations that get defined after this
729 // file is included). Save the current meaning now and use it
731 typedef std::string _Check_string;
732 #define CHECK_OP_LOG(name, op, val1, val2, log) \
733 while (@ac_google_namespace@::_Check_string* _result = \
734 @ac_google_namespace@::Check##name##Impl( \
735 @ac_google_namespace@::GetReferenceableValue(val1), \
736 @ac_google_namespace@::GetReferenceableValue(val2), \
737 #val1 " " #op " " #val2)) \
738 log(__FILE__, __LINE__, \
739 @ac_google_namespace@::CheckOpString(_result)).stream()
741 // In optimized mode, use CheckOpString to hint to compiler that
742 // the while condition is unlikely.
743 #define CHECK_OP_LOG(name, op, val1, val2, log) \
744 while (@ac_google_namespace@::CheckOpString _result = \
745 @ac_google_namespace@::Check##name##Impl( \
746 @ac_google_namespace@::GetReferenceableValue(val1), \
747 @ac_google_namespace@::GetReferenceableValue(val2), \
748 #val1 " " #op " " #val2)) \
749 log(__FILE__, __LINE__, _result).stream()
750 #endif // STATIC_ANALYSIS, !NDEBUG
752 #if GOOGLE_STRIP_LOG <= 3
753 #define CHECK_OP(name, op, val1, val2) \
754 CHECK_OP_LOG(name, op, val1, val2, @ac_google_namespace@::LogMessageFatal)
756 #define CHECK_OP(name, op, val1, val2) \
757 CHECK_OP_LOG(name, op, val1, val2, @ac_google_namespace@::NullStreamFatal)
758 #endif // STRIP_LOG <= 3
760 // Equality/Inequality checks - compare two values, and log a FATAL message
761 // including the two values when the result is not as expected. The values
762 // must have operator<<(ostream, ...) defined.
764 // You may append to the error message like so:
765 // CHECK_NE(1, 2) << ": The world must be ending!";
767 // We are very careful to ensure that each argument is evaluated exactly
768 // once, and that anything which is legal to pass as a function argument is
769 // legal here. In particular, the arguments may be temporary expressions
770 // which will end up being destroyed at the end of the apparent statement,
772 // CHECK_EQ(string("abc")[1], 'b');
774 // WARNING: These don't compile correctly if one of the arguments is a pointer
775 // and the other is NULL. To work around this, simply static_cast NULL to the
776 // type of the desired pointer.
778 #define CHECK_EQ(val1, val2) CHECK_OP(_EQ, ==, val1, val2)
779 #define CHECK_NE(val1, val2) CHECK_OP(_NE, !=, val1, val2)
780 #define CHECK_LE(val1, val2) CHECK_OP(_LE, <=, val1, val2)
781 #define CHECK_LT(val1, val2) CHECK_OP(_LT, < , val1, val2)
782 #define CHECK_GE(val1, val2) CHECK_OP(_GE, >=, val1, val2)
783 #define CHECK_GT(val1, val2) CHECK_OP(_GT, > , val1, val2)
785 // Check that the input is non NULL. This very useful in constructor
786 // initializer lists.
788 #define CHECK_NOTNULL(val) \
789 @ac_google_namespace@::CheckNotNull(__FILE__, __LINE__, "'" #val "' Must be non NULL", (val))
791 // Helper functions for string comparisons.
792 // To avoid bloat, the definitions are in logging.cc.
793 #define DECLARE_CHECK_STROP_IMPL(func, expected) \
794 GOOGLE_GLOG_DLL_DECL std::string* Check##func##expected##Impl( \
795 const char* s1, const char* s2, const char* names);
796 DECLARE_CHECK_STROP_IMPL(strcmp, true)
797 DECLARE_CHECK_STROP_IMPL(strcmp, false)
798 DECLARE_CHECK_STROP_IMPL(strcasecmp, true)
799 DECLARE_CHECK_STROP_IMPL(strcasecmp, false)
800 #undef DECLARE_CHECK_STROP_IMPL
802 // Helper macro for string comparisons.
803 // Don't use this macro directly in your code, use CHECK_STREQ et al below.
804 #define CHECK_STROP(func, op, expected, s1, s2) \
805 while (@ac_google_namespace@::CheckOpString _result = \
806 @ac_google_namespace@::Check##func##expected##Impl((s1), (s2), \
807 #s1 " " #op " " #s2)) \
808 LOG(FATAL) << *_result.str_
811 // String (char*) equality/inequality checks.
812 // CASE versions are case-insensitive.
814 // Note that "s1" and "s2" may be temporary strings which are destroyed
815 // by the compiler at the end of the current "full expression"
816 // (e.g. CHECK_STREQ(Foo().c_str(), Bar().c_str())).
818 #define CHECK_STREQ(s1, s2) CHECK_STROP(strcmp, ==, true, s1, s2)
819 #define CHECK_STRNE(s1, s2) CHECK_STROP(strcmp, !=, false, s1, s2)
820 #define CHECK_STRCASEEQ(s1, s2) CHECK_STROP(strcasecmp, ==, true, s1, s2)
821 #define CHECK_STRCASENE(s1, s2) CHECK_STROP(strcasecmp, !=, false, s1, s2)
823 #define CHECK_INDEX(I,A) CHECK(I < (sizeof(A)/sizeof(A[0])))
824 #define CHECK_BOUND(B,A) CHECK(B <= (sizeof(A)/sizeof(A[0])))
826 #define CHECK_DOUBLE_EQ(val1, val2) \
828 CHECK_LE((val1), (val2)+0.000000000000001L); \
829 CHECK_GE((val1), (val2)-0.000000000000001L); \
832 #define CHECK_NEAR(val1, val2, margin) \
834 CHECK_LE((val1), (val2)+(margin)); \
835 CHECK_GE((val1), (val2)-(margin)); \
838 // perror()..googly style!
840 // PLOG() and PLOG_IF() and PCHECK() behave exactly like their LOG* and
841 // CHECK equivalents with the addition that they postpend a description
842 // of the current state of errno to their output lines.
844 #define PLOG(severity) GOOGLE_PLOG(severity, 0).stream()
846 #define GOOGLE_PLOG(severity, counter) \
847 @ac_google_namespace@::ErrnoLogMessage( \
848 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, counter, \
849 &@ac_google_namespace@::LogMessage::SendToLog)
851 #define PLOG_IF(severity, condition) \
852 !(condition) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & PLOG(severity)
854 // A CHECK() macro that postpends errno if the condition is false. E.g.
856 // if (poll(fds, nfds, timeout) == -1) { PCHECK(errno == EINTR); ... }
857 #define PCHECK(condition) \
858 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN(!(condition))) \
859 << "Check failed: " #condition " "
861 // A CHECK() macro that lets you assert the success of a function that
862 // returns -1 and sets errno in case of an error. E.g.
864 // CHECK_ERR(mkdir(path, 0700));
868 // int fd = open(filename, flags); CHECK_ERR(fd) << ": open " << filename;
869 #define CHECK_ERR(invocation) \
870 PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN((invocation) == -1)) \
873 // Use macro expansion to create, for each use of LOG_EVERY_N(), static
874 // variables with the __LINE__ expansion as part of the variable name.
875 #define LOG_EVERY_N_VARNAME(base, line) LOG_EVERY_N_VARNAME_CONCAT(base, line)
876 #define LOG_EVERY_N_VARNAME_CONCAT(base, line) base ## line
878 #define LOG_OCCURRENCES LOG_EVERY_N_VARNAME(occurrences_, __LINE__)
879 #define LOG_OCCURRENCES_MOD_N LOG_EVERY_N_VARNAME(occurrences_mod_n_, __LINE__)
881 #define SOME_KIND_OF_LOG_EVERY_N(severity, n, what_to_do) \
882 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
884 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
885 if (LOG_OCCURRENCES_MOD_N == 1) \
886 @ac_google_namespace@::LogMessage( \
887 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
888 &what_to_do).stream()
890 #define SOME_KIND_OF_LOG_IF_EVERY_N(severity, condition, n, what_to_do) \
891 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
894 ((LOG_OCCURRENCES_MOD_N=(LOG_OCCURRENCES_MOD_N + 1) % n) == (1 % n))) \
895 @ac_google_namespace@::LogMessage( \
896 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
897 &what_to_do).stream()
899 #define SOME_KIND_OF_PLOG_EVERY_N(severity, n, what_to_do) \
900 static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
902 if (++LOG_OCCURRENCES_MOD_N > n) LOG_OCCURRENCES_MOD_N -= n; \
903 if (LOG_OCCURRENCES_MOD_N == 1) \
904 @ac_google_namespace@::ErrnoLogMessage( \
905 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
906 &what_to_do).stream()
908 #define SOME_KIND_OF_LOG_FIRST_N(severity, n, what_to_do) \
909 static int LOG_OCCURRENCES = 0; \
910 if (LOG_OCCURRENCES <= n) \
912 if (LOG_OCCURRENCES <= n) \
913 @ac_google_namespace@::LogMessage( \
914 __FILE__, __LINE__, @ac_google_namespace@::GLOG_ ## severity, LOG_OCCURRENCES, \
915 &what_to_do).stream()
917 namespace glog_internal_namespace_ {
919 struct CompileAssert {
922 } // namespace glog_internal_namespace_
924 #define GOOGLE_GLOG_COMPILE_ASSERT(expr, msg) \
925 typedef @ac_google_namespace@::glog_internal_namespace_::CompileAssert<(bool(expr))> msg[bool(expr) ? 1 : -1]
927 #define LOG_EVERY_N(severity, n) \
928 GOOGLE_GLOG_COMPILE_ASSERT(@ac_google_namespace@::GLOG_ ## severity < \
929 @ac_google_namespace@::NUM_SEVERITIES, \
930 INVALID_REQUESTED_LOG_SEVERITY); \
931 SOME_KIND_OF_LOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
933 #define SYSLOG_EVERY_N(severity, n) \
934 SOME_KIND_OF_LOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToSyslogAndLog)
936 #define PLOG_EVERY_N(severity, n) \
937 SOME_KIND_OF_PLOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
939 #define LOG_FIRST_N(severity, n) \
940 SOME_KIND_OF_LOG_FIRST_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
942 #define LOG_IF_EVERY_N(severity, condition, n) \
943 SOME_KIND_OF_LOG_IF_EVERY_N(severity, (condition), (n), @ac_google_namespace@::LogMessage::SendToLog)
945 // We want the special COUNTER value available for LOG_EVERY_X()'ed messages
946 enum PRIVATE_Counter {COUNTER};
948 #ifdef GLOG_NO_ABBREVIATED_SEVERITIES
949 // wingdi.h defines ERROR to be 0. When we call LOG(ERROR), it gets
950 // substituted with 0, and it expands to COMPACT_GOOGLE_LOG_0. To allow us
951 // to keep using this syntax, we define this macro to do the same thing
952 // as COMPACT_GOOGLE_LOG_ERROR.
953 #define COMPACT_GOOGLE_LOG_0 COMPACT_GOOGLE_LOG_ERROR
954 #define SYSLOG_0 SYSLOG_ERROR
955 #define LOG_TO_STRING_0 LOG_TO_STRING_ERROR
956 // Needed for LOG_IS_ON(ERROR).
957 const LogSeverity GLOG_0 = GLOG_ERROR;
959 // Users may include windows.h after logging.h without
960 // GLOG_NO_ABBREVIATED_SEVERITIES nor WIN32_LEAN_AND_MEAN.
961 // For this case, we cannot detect if ERROR is defined before users
962 // actually use ERROR. Let's make an undefined symbol to warn users.
963 # define GLOG_ERROR_MSG ERROR_macro_is_defined_Define_GLOG_NO_ABBREVIATED_SEVERITIES_before_including_logging_h_See_the_document_for_detail
964 # define COMPACT_GOOGLE_LOG_0 GLOG_ERROR_MSG
965 # define SYSLOG_0 GLOG_ERROR_MSG
966 # define LOG_TO_STRING_0 GLOG_ERROR_MSG
967 # define GLOG_0 GLOG_ERROR_MSG
970 // Plus some debug-logging macros that get compiled to nothing for production
974 #define DLOG(severity) LOG(severity)
975 #define DVLOG(verboselevel) VLOG(verboselevel)
976 #define DLOG_IF(severity, condition) LOG_IF(severity, condition)
977 #define DLOG_EVERY_N(severity, n) LOG_EVERY_N(severity, n)
978 #define DLOG_IF_EVERY_N(severity, condition, n) \
979 LOG_IF_EVERY_N(severity, condition, n)
980 #define DLOG_ASSERT(condition) LOG_ASSERT(condition)
982 // debug-only checking. not executed in NDEBUG mode.
983 #define DCHECK(condition) CHECK(condition)
984 #define DCHECK_EQ(val1, val2) CHECK_EQ(val1, val2)
985 #define DCHECK_NE(val1, val2) CHECK_NE(val1, val2)
986 #define DCHECK_LE(val1, val2) CHECK_LE(val1, val2)
987 #define DCHECK_LT(val1, val2) CHECK_LT(val1, val2)
988 #define DCHECK_GE(val1, val2) CHECK_GE(val1, val2)
989 #define DCHECK_GT(val1, val2) CHECK_GT(val1, val2)
990 #define DCHECK_NOTNULL(val) CHECK_NOTNULL(val)
991 #define DCHECK_STREQ(str1, str2) CHECK_STREQ(str1, str2)
992 #define DCHECK_STRCASEEQ(str1, str2) CHECK_STRCASEEQ(str1, str2)
993 #define DCHECK_STRNE(str1, str2) CHECK_STRNE(str1, str2)
994 #define DCHECK_STRCASENE(str1, str2) CHECK_STRCASENE(str1, str2)
998 #define DLOG(severity) \
999 true ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
1001 #define DVLOG(verboselevel) \
1002 (true || !VLOG_IS_ON(verboselevel)) ?\
1003 (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(INFO)
1005 #define DLOG_IF(severity, condition) \
1006 (true || !(condition)) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
1008 #define DLOG_EVERY_N(severity, n) \
1009 true ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
1011 #define DLOG_IF_EVERY_N(severity, condition, n) \
1012 (true || !(condition))? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
1014 #define DLOG_ASSERT(condition) \
1015 true ? (void) 0 : LOG_ASSERT(condition)
1017 // MSVC warning C4127: conditional expression is constant
1018 #define DCHECK(condition) \
1019 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1021 GLOG_MSVC_POP_WARNING() CHECK(condition)
1023 #define DCHECK_EQ(val1, val2) \
1024 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1026 GLOG_MSVC_POP_WARNING() CHECK_EQ(val1, val2)
1028 #define DCHECK_NE(val1, val2) \
1029 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1031 GLOG_MSVC_POP_WARNING() CHECK_NE(val1, val2)
1033 #define DCHECK_LE(val1, val2) \
1034 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1036 GLOG_MSVC_POP_WARNING() CHECK_LE(val1, val2)
1038 #define DCHECK_LT(val1, val2) \
1039 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1041 GLOG_MSVC_POP_WARNING() CHECK_LT(val1, val2)
1043 #define DCHECK_GE(val1, val2) \
1044 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1046 GLOG_MSVC_POP_WARNING() CHECK_GE(val1, val2)
1048 #define DCHECK_GT(val1, val2) \
1049 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1051 GLOG_MSVC_POP_WARNING() CHECK_GT(val1, val2)
1053 // You may see warnings in release mode if you don't use the return
1054 // value of DCHECK_NOTNULL. Please just use DCHECK for such cases.
1055 #define DCHECK_NOTNULL(val) (val)
1057 #define DCHECK_STREQ(str1, str2) \
1058 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1060 GLOG_MSVC_POP_WARNING() CHECK_STREQ(str1, str2)
1062 #define DCHECK_STRCASEEQ(str1, str2) \
1063 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1065 GLOG_MSVC_POP_WARNING() CHECK_STRCASEEQ(str1, str2)
1067 #define DCHECK_STRNE(str1, str2) \
1068 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1070 GLOG_MSVC_POP_WARNING() CHECK_STRNE(str1, str2)
1072 #define DCHECK_STRCASENE(str1, str2) \
1073 GLOG_MSVC_PUSH_DISABLE_WARNING(4127) \
1075 GLOG_MSVC_POP_WARNING() CHECK_STRCASENE(str1, str2)
1079 // Log only in verbose mode.
1081 #define VLOG(verboselevel) LOG_IF(INFO, VLOG_IS_ON(verboselevel))
1083 #define VLOG_IF(verboselevel, condition) \
1084 LOG_IF(INFO, (condition) && VLOG_IS_ON(verboselevel))
1086 #define VLOG_EVERY_N(verboselevel, n) \
1087 LOG_IF_EVERY_N(INFO, VLOG_IS_ON(verboselevel), n)
1089 #define VLOG_IF_EVERY_N(verboselevel, condition, n) \
1090 LOG_IF_EVERY_N(INFO, (condition) && VLOG_IS_ON(verboselevel), n)
1092 namespace base_logging {
1094 // LogMessage::LogStream is a std::ostream backed by this streambuf.
1095 // This class ignores overflow and leaves two bytes at the end of the
1096 // buffer to allow for a '\n' and '\0'.
1097 class GOOGLE_GLOG_DLL_DECL LogStreamBuf : public std::streambuf {
1099 // REQUIREMENTS: "len" must be >= 2 to account for the '\n' and '\n'.
1100 LogStreamBuf(char *buf, int len) {
1101 setp(buf, buf + len - 2);
1103 // This effectively ignores overflow.
1104 virtual int_type overflow(int_type ch) {
1108 // Legacy public ostrstream method.
1109 size_t pcount() const { return pptr() - pbase(); }
1110 char* pbase() const { return std::streambuf::pbase(); }
1113 } // namespace base_logging
1116 // This class more or less represents a particular log message. You
1117 // create an instance of LogMessage and then stream stuff to it.
1118 // When you finish streaming to it, ~LogMessage is called and the
1119 // full message gets streamed to the appropriate destination.
1121 // You shouldn't actually use LogMessage's constructor to log things,
1122 // though. You should use the LOG() macro (and variants thereof)
1124 class GOOGLE_GLOG_DLL_DECL LogMessage {
1127 // Passing kNoLogPrefix for the line number disables the
1128 // log-message prefix. Useful for using the LogMessage
1129 // infrastructure as a printing utility. See also the --log_prefix
1130 // flag for controlling the log-message prefix on an
1131 // application-wide basis.
1135 // LogStream inherit from non-DLL-exported class (std::ostrstream)
1136 // and VC++ produces a warning for this situation.
1137 // However, MSDN says "C4275 can be ignored in Microsoft Visual C++
1138 // 2005 if you are deriving from a type in the Standard C++ Library"
1139 // http://msdn.microsoft.com/en-us/library/3tdb471s(VS.80).aspx
1140 // Let's just ignore the warning.
1142 # pragma warning(disable: 4275)
1144 class GOOGLE_GLOG_DLL_DECL LogStream : public std::ostream {
1146 # pragma warning(default: 4275)
1149 LogStream(char *buf, int len, int ctr)
1150 : std::ostream(NULL),
1151 streambuf_(buf, len),
1157 int ctr() const { return ctr_; }
1158 void set_ctr(int ctr) { ctr_ = ctr; }
1159 LogStream* self() const { return self_; }
1161 // Legacy std::streambuf methods.
1162 size_t pcount() const { return streambuf_.pcount(); }
1163 char* pbase() const { return streambuf_.pbase(); }
1164 char* str() const { return pbase(); }
1167 base_logging::LogStreamBuf streambuf_;
1168 int ctr_; // Counter hack (for the LOG_EVERY_X() macro)
1169 LogStream *self_; // Consistency check hack
1173 // icc 8 requires this typedef to avoid an internal compiler error.
1174 typedef void (LogMessage::*SendMethod)();
1176 LogMessage(const char* file, int line, LogSeverity severity, int ctr,
1177 SendMethod send_method);
1179 // Two special constructors that generate reduced amounts of code at
1180 // LOG call sites for common cases.
1182 // Used for LOG(INFO): Implied are:
1183 // severity = INFO, ctr = 0, send_method = &LogMessage::SendToLog.
1185 // Using this constructor instead of the more complex constructor above
1186 // saves 19 bytes per call site.
1187 LogMessage(const char* file, int line);
1189 // Used for LOG(severity) where severity != INFO. Implied
1190 // are: ctr = 0, send_method = &LogMessage::SendToLog
1192 // Using this constructor instead of the more complex constructor above
1193 // saves 17 bytes per call site.
1194 LogMessage(const char* file, int line, LogSeverity severity);
1196 // Constructor to log this message to a specified sink (if not NULL).
1197 // Implied are: ctr = 0, send_method = &LogMessage::SendToSinkAndLog if
1198 // also_send_to_log is true, send_method = &LogMessage::SendToSink otherwise.
1199 LogMessage(const char* file, int line, LogSeverity severity, LogSink* sink,
1200 bool also_send_to_log);
1202 // Constructor where we also give a vector<string> pointer
1203 // for storing the messages (if the pointer is not NULL).
1204 // Implied are: ctr = 0, send_method = &LogMessage::SaveOrSendToLog.
1205 LogMessage(const char* file, int line, LogSeverity severity,
1206 std::vector<std::string>* outvec);
1208 // Constructor where we also give a string pointer for storing the
1209 // message (if the pointer is not NULL). Implied are: ctr = 0,
1210 // send_method = &LogMessage::WriteToStringAndLog.
1211 LogMessage(const char* file, int line, LogSeverity severity,
1212 std::string* message);
1214 // A special constructor used for check failures
1215 LogMessage(const char* file, int line, const CheckOpString& result);
1219 // Flush a buffered message to the sink set in the constructor. Always
1220 // called by the destructor, it may also be called from elsewhere if
1221 // needed. Only the first call is actioned; any later ones are ignored.
1224 // An arbitrary limit on the length of a single log message. This
1225 // is so that streaming can be done more efficiently.
1226 static const size_t kMaxLogMessageLen;
1228 // Theses should not be called directly outside of logging.*,
1229 // only passed as SendMethod arguments to other LogMessage methods:
1230 void SendToLog(); // Actually dispatch to the logs
1231 void SendToSyslogAndLog(); // Actually dispatch to syslog and the logs
1233 // Call abort() or similar to perform LOG(FATAL) crash.
1234 static void Fail() @ac_cv___attribute___noreturn@;
1236 std::ostream& stream();
1238 int preserved_errno() const;
1240 // Must be called without the log_mutex held. (L < log_mutex)
1241 static int64 num_messages(int severity);
1243 struct LogMessageData;
1246 // Fully internal SendMethod cases:
1247 void SendToSinkAndLog(); // Send to sink if provided and dispatch to the logs
1248 void SendToSink(); // Send to sink if provided, do nothing otherwise.
1250 // Write to string if provided and dispatch to the logs.
1251 void WriteToStringAndLog();
1253 void SaveOrSendToLog(); // Save to stringvec if provided, else to logs
1255 void Init(const char* file, int line, LogSeverity severity,
1256 void (LogMessage::*send_method)());
1258 // Used to fill in crash information during LOG(FATAL) failures.
1259 void RecordCrashReason(glog_internal_namespace_::CrashReason* reason);
1261 // Counts of messages sent at each priority:
1262 static int64 num_messages_[NUM_SEVERITIES]; // under log_mutex
1264 // We keep the data in a separate struct so that each instance of
1265 // LogMessage uses less stack space.
1266 LogMessageData* allocated_;
1267 LogMessageData* data_;
1269 friend class LogDestination;
1271 LogMessage(const LogMessage&);
1272 void operator=(const LogMessage&);
1275 // This class happens to be thread-hostile because all instances share
1276 // a single data buffer, but since it can only be created just before
1277 // the process dies, we don't worry so much.
1278 class GOOGLE_GLOG_DLL_DECL LogMessageFatal : public LogMessage {
1280 LogMessageFatal(const char* file, int line);
1281 LogMessageFatal(const char* file, int line, const CheckOpString& result);
1282 ~LogMessageFatal() @ac_cv___attribute___noreturn@;
1285 // A non-macro interface to the log facility; (useful
1286 // when the logging level is not a compile-time constant).
1287 inline void LogAtLevel(int const severity, std::string const &msg) {
1288 LogMessage(__FILE__, __LINE__, severity).stream() << msg;
1291 // A macro alternative of LogAtLevel. New code may want to use this
1292 // version since there are two advantages: 1. this version outputs the
1293 // file name and the line number where this macro is put like other
1294 // LOG macros, 2. this macro can be used as C++ stream.
1295 #define LOG_AT_LEVEL(severity) @ac_google_namespace@::LogMessage(__FILE__, __LINE__, severity).stream()
1297 // A small helper for CHECK_NOTNULL().
1298 template <typename T>
1299 T* CheckNotNull(const char *file, int line, const char *names, T* t) {
1301 LogMessageFatal(file, line, new std::string(names));
1306 // Allow folks to put a counter in the LOG_EVERY_X()'ed messages. This
1307 // only works if ostream is a LogStream. If the ostream is not a
1308 // LogStream you'll get an assert saying as much at runtime.
1309 GOOGLE_GLOG_DLL_DECL std::ostream& operator<<(std::ostream &os,
1310 const PRIVATE_Counter&);
1313 // Derived class for PLOG*() above.
1314 class GOOGLE_GLOG_DLL_DECL ErrnoLogMessage : public LogMessage {
1317 ErrnoLogMessage(const char* file, int line, LogSeverity severity, int ctr,
1318 void (LogMessage::*send_method)());
1320 // Postpends ": strerror(errno) [errno]".
1324 ErrnoLogMessage(const ErrnoLogMessage&);
1325 void operator=(const ErrnoLogMessage&);
1329 // This class is used to explicitly ignore values in the conditional
1330 // logging macros. This avoids compiler warnings like "value computed
1331 // is not used" and "statement has no effect".
1333 class GOOGLE_GLOG_DLL_DECL LogMessageVoidify {
1335 LogMessageVoidify() { }
1336 // This has to be an operator with a precedence lower than << but
1338 void operator&(std::ostream&) { }
1342 // Flushes all log files that contains messages that are at least of
1343 // the specified severity level. Thread-safe.
1344 GOOGLE_GLOG_DLL_DECL void FlushLogFiles(LogSeverity min_severity);
1346 // Flushes all log files that contains messages that are at least of
1347 // the specified severity level. Thread-hostile because it ignores
1348 // locking -- used for catastrophic failures.
1349 GOOGLE_GLOG_DLL_DECL void FlushLogFilesUnsafe(LogSeverity min_severity);
1352 // Set the destination to which a particular severity level of log
1353 // messages is sent. If base_filename is "", it means "don't log this
1354 // severity". Thread-safe.
1356 GOOGLE_GLOG_DLL_DECL void SetLogDestination(LogSeverity severity,
1357 const char* base_filename);
1360 // Set the basename of the symlink to the latest log file at a given
1361 // severity. If symlink_basename is empty, do not make a symlink. If
1362 // you don't call this function, the symlink basename is the
1363 // invocation name of the program. Thread-safe.
1365 GOOGLE_GLOG_DLL_DECL void SetLogSymlink(LogSeverity severity,
1366 const char* symlink_basename);
1369 // Used to send logs to some other kind of destination
1370 // Users should subclass LogSink and override send to do whatever they want.
1371 // Implementations must be thread-safe because a shared instance will
1372 // be called from whichever thread ran the LOG(XXX) line.
1373 class GOOGLE_GLOG_DLL_DECL LogSink {
1377 // Sink's logging logic (message_len is such as to exclude '\n' at the end).
1378 // This method can't use LOG() or CHECK() as logging system mutex(s) are held
1379 // during this call.
1380 virtual void send(LogSeverity severity, const char* full_filename,
1381 const char* base_filename, int line,
1382 const struct ::tm* tm_time,
1383 const char* message, size_t message_len) = 0;
1385 // Redefine this to implement waiting for
1386 // the sink's logging logic to complete.
1387 // It will be called after each send() returns,
1388 // but before that LogMessage exits or crashes.
1389 // By default this function does nothing.
1390 // Using this function one can implement complex logic for send()
1391 // that itself involves logging; and do all this w/o causing deadlocks and
1392 // inconsistent rearrangement of log messages.
1393 // E.g. if a LogSink has thread-specific actions, the send() method
1394 // can simply add the message to a queue and wake up another thread that
1395 // handles real logging while itself making some LOG() calls;
1396 // WaitTillSent() can be implemented to wait for that logic to complete.
1397 // See our unittest for an example.
1398 virtual void WaitTillSent();
1400 // Returns the normal text output of the log message.
1401 // Can be useful to implement send().
1402 static std::string ToString(LogSeverity severity, const char* file, int line,
1403 const struct ::tm* tm_time,
1404 const char* message, size_t message_len);
1407 // Add or remove a LogSink as a consumer of logging data. Thread-safe.
1408 GOOGLE_GLOG_DLL_DECL void AddLogSink(LogSink *destination);
1409 GOOGLE_GLOG_DLL_DECL void RemoveLogSink(LogSink *destination);
1412 // Specify an "extension" added to the filename specified via
1413 // SetLogDestination. This applies to all severity levels. It's
1414 // often used to append the port we're listening on to the logfile
1415 // name. Thread-safe.
1417 GOOGLE_GLOG_DLL_DECL void SetLogFilenameExtension(
1418 const char* filename_extension);
1421 // Make it so that all log messages of at least a particular severity
1422 // are logged to stderr (in addition to logging to the usual log
1423 // file(s)). Thread-safe.
1425 GOOGLE_GLOG_DLL_DECL void SetStderrLogging(LogSeverity min_severity);
1428 // Make it so that all log messages go only to stderr. Thread-safe.
1430 GOOGLE_GLOG_DLL_DECL void LogToStderr();
1433 // Make it so that all log messages of at least a particular severity are
1434 // logged via email to a list of addresses (in addition to logging to the
1435 // usual log file(s)). The list of addresses is just a string containing
1436 // the email addresses to send to (separated by spaces, say). Thread-safe.
1438 GOOGLE_GLOG_DLL_DECL void SetEmailLogging(LogSeverity min_severity,
1439 const char* addresses);
1441 // A simple function that sends email. dest is a commma-separated
1442 // list of addressess. Thread-safe.
1443 GOOGLE_GLOG_DLL_DECL bool SendEmail(const char *dest,
1444 const char *subject, const char *body);
1446 GOOGLE_GLOG_DLL_DECL const std::vector<std::string>& GetLoggingDirectories();
1448 // For tests only: Clear the internal [cached] list of logging directories to
1449 // force a refresh the next time GetLoggingDirectories is called.
1451 void TestOnly_ClearLoggingDirectoriesList();
1453 // Returns a set of existing temporary directories, which will be a
1454 // subset of the directories returned by GetLogginDirectories().
1456 GOOGLE_GLOG_DLL_DECL void GetExistingTempDirectories(
1457 std::vector<std::string>* list);
1459 // Print any fatal message again -- useful to call from signal handler
1460 // so that the last thing in the output is the fatal message.
1461 // Thread-hostile, but a race is unlikely.
1462 GOOGLE_GLOG_DLL_DECL void ReprintFatalMessage();
1464 // Truncate a log file that may be the append-only output of multiple
1465 // processes and hence can't simply be renamed/reopened (typically a
1466 // stdout/stderr). If the file "path" is > "limit" bytes, copy the
1467 // last "keep" bytes to offset 0 and truncate the rest. Since we could
1468 // be racing with other writers, this approach has the potential to
1469 // lose very small amounts of data. For security, only follow symlinks
1470 // if the path is /proc/self/fd/*
1471 GOOGLE_GLOG_DLL_DECL void TruncateLogFile(const char *path,
1472 int64 limit, int64 keep);
1474 // Truncate stdout and stderr if they are over the value specified by
1475 // --max_log_size; keep the final 1MB. This function has the same
1476 // race condition as TruncateLogFile.
1477 GOOGLE_GLOG_DLL_DECL void TruncateStdoutStderr();
1479 // Return the string representation of the provided LogSeverity level.
1481 GOOGLE_GLOG_DLL_DECL const char* GetLogSeverityName(LogSeverity severity);
1483 // ---------------------------------------------------------------------
1484 // Implementation details that are not useful to most clients
1485 // ---------------------------------------------------------------------
1487 // A Logger is the interface used by logging modules to emit entries
1488 // to a log. A typical implementation will dump formatted data to a
1489 // sequence of files. We also provide interfaces that will forward
1490 // the data to another thread so that the invoker never blocks.
1491 // Implementations should be thread-safe since the logging system
1492 // will write to them from multiple threads.
1496 class GOOGLE_GLOG_DLL_DECL Logger {
1500 // Writes "message[0,message_len-1]" corresponding to an event that
1501 // occurred at "timestamp". If "force_flush" is true, the log file
1502 // is flushed immediately.
1504 // The input message has already been formatted as deemed
1505 // appropriate by the higher level logging facility. For example,
1506 // textual log messages already contain timestamps, and the
1507 // file:linenumber header.
1508 virtual void Write(bool force_flush,
1510 const char* message,
1511 int message_len) = 0;
1513 // Flush any buffered messages
1514 virtual void Flush() = 0;
1516 // Get the current LOG file size.
1517 // The returned value is approximate since some
1518 // logged data may not have been flushed to disk yet.
1519 virtual uint32 LogSize() = 0;
1522 // Get the logger for the specified severity level. The logger
1523 // remains the property of the logging module and should not be
1524 // deleted by the caller. Thread-safe.
1525 extern GOOGLE_GLOG_DLL_DECL Logger* GetLogger(LogSeverity level);
1527 // Set the logger for the specified severity level. The logger
1528 // becomes the property of the logging module and should not
1529 // be deleted by the caller. Thread-safe.
1530 extern GOOGLE_GLOG_DLL_DECL void SetLogger(LogSeverity level, Logger* logger);
1534 // glibc has traditionally implemented two incompatible versions of
1535 // strerror_r(). There is a poorly defined convention for picking the
1536 // version that we want, but it is not clear whether it even works with
1537 // all versions of glibc.
1538 // So, instead, we provide this wrapper that automatically detects the
1539 // version that is in use, and then implements POSIX semantics.
1540 // N.B. In addition to what POSIX says, we also guarantee that "buf" will
1541 // be set to an empty string, if this function failed. This means, in most
1542 // cases, you do not need to check the error code and you can directly
1543 // use the value of "buf". It will never have an undefined value.
1544 // DEPRECATED: Use StrError(int) instead.
1545 GOOGLE_GLOG_DLL_DECL int posix_strerror_r(int err, char *buf, size_t len);
1547 // A thread-safe replacement for strerror(). Returns a string describing the
1548 // given POSIX error code.
1549 GOOGLE_GLOG_DLL_DECL std::string StrError(int err);
1551 // A class for which we define operator<<, which does nothing.
1552 class GOOGLE_GLOG_DLL_DECL NullStream : public LogMessage::LogStream {
1554 // Initialize the LogStream so the messages can be written somewhere
1555 // (they'll never be actually displayed). This will be needed if a
1556 // NullStream& is implicitly converted to LogStream&, in which case
1557 // the overloaded NullStream::operator<< will not be invoked.
1558 NullStream() : LogMessage::LogStream(message_buffer_, 1, 0) { }
1559 NullStream(const char* /*file*/, int /*line*/,
1560 const CheckOpString& /*result*/) :
1561 LogMessage::LogStream(message_buffer_, 1, 0) { }
1562 NullStream &stream() { return *this; }
1564 // A very short buffer for messages (which we discard anyway). This
1565 // will be needed if NullStream& converted to LogStream& (e.g. as a
1566 // result of a conditional expression).
1567 char message_buffer_[2];
1570 // Do nothing. This operator is inline, allowing the message to be
1571 // compiled away. The message will not be compiled away if we do
1572 // something like (flag ? LOG(INFO) : LOG(ERROR)) << message; when
1573 // SKIP_LOG=WARNING. In those cases, NullStream will be implicitly
1574 // converted to LogStream and the message will be computed and then
1575 // quietly discarded.
1577 inline NullStream& operator<<(NullStream &str, const T &) { return str; }
1579 // Similar to NullStream, but aborts the program (without stack
1580 // trace), like LogMessageFatal.
1581 class GOOGLE_GLOG_DLL_DECL NullStreamFatal : public NullStream {
1583 NullStreamFatal() { }
1584 NullStreamFatal(const char* file, int line, const CheckOpString& result) :
1585 NullStream(file, line, result) { }
1586 @ac_cv___attribute___noreturn@ ~NullStreamFatal() { _exit(1); }
1589 // Install a signal handler that will dump signal information and a stack
1590 // trace when the program crashes on certain signals. We'll install the
1591 // signal handler for the following signals.
1593 // SIGSEGV, SIGILL, SIGFPE, SIGABRT, SIGBUS, and SIGTERM.
1595 // By default, the signal handler will write the failure dump to the
1596 // standard error. You can customize the destination by installing your
1597 // own writer function by InstallFailureWriter() below.
1599 // Note on threading:
1601 // The function should be called before threads are created, if you want
1602 // to use the failure signal handler for all threads. The stack trace
1603 // will be shown only for the thread that receives the signal. In other
1604 // words, stack traces of other threads won't be shown.
1605 GOOGLE_GLOG_DLL_DECL void InstallFailureSignalHandler();
1607 // Installs a function that is used for writing the failure dump. "data"
1608 // is the pointer to the beginning of a message to be written, and "size"
1609 // is the size of the message. You should not expect the data is
1610 // terminated with '\0'.
1611 GOOGLE_GLOG_DLL_DECL void InstallFailureWriter(
1612 void (*writer)(const char* data, int size));
1614 @ac_google_end_namespace@
1616 #endif // _LOGGING_H_