PageRenderTime 42ms CodeModel.GetById 17ms app.highlight 11ms RepoModel.GetById 1ms app.codeStats 1ms

/thirdparty/breakpad/third_party/glog/src/glog/logging.h.in

http://github.com/tomahawk-player/tomahawk
Autoconf | 1506 lines | 1058 code | 214 blank | 234 comment | 132 complexity | 536ad159c6712c6b5336a87db9159ae1 MD5 | raw file

Large files files are truncated, but you can click here to view the full file

   1// Copyright (c) 1999, Google Inc.
   2// All rights reserved.
   3//
   4// Redistribution and use in source and binary forms, with or without
   5// modification, are permitted provided that the following conditions are
   6// met:
   7//
   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
  13// distribution.
  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.
  17//
  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.
  29//
  30// Author: Ray Sidney
  31//
  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.
  35//
  36#ifndef _LOGGING_H_
  37#define _LOGGING_H_
  38
  39#include <errno.h>
  40#include <string.h>
  41#include <time.h>
  42#include <string>
  43#if @ac_cv_have_unistd_h@
  44# include <unistd.h>
  45#endif
  46#ifdef __DEPRECATED
  47// Make GCC quiet.
  48# undef __DEPRECATED
  49# include <strstream>
  50# define __DEPRECATED
  51#else
  52# include <strstream>
  53#endif
  54#include <vector>
  55
  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)
  60# else
  61#   define GOOGLE_GLOG_DLL_DECL
  62# endif
  63#endif
  64
  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
  73#endif
  74#if @ac_cv_have_systypes_h@
  75#include <sys/types.h>          // the normal place u_int16_t is defined
  76#endif
  77#if @ac_cv_have_inttypes_h@
  78#include <inttypes.h>           // a third place for uint16_t or u_int16_t
  79#endif
  80
  81#if @ac_cv_have_libgflags@
  82#include <gflags/gflags.h>
  83#endif
  84
  85@ac_google_start_namespace@
  86
  87#if @ac_cv_have_uint16_t@      // the C99 format
  88typedef int32_t int32;
  89typedef uint32_t uint32;
  90typedef int64_t int64;
  91typedef uint64_t uint64;
  92#elif @ac_cv_have_u_int16_t@   // the BSD format
  93typedef int32_t int32;
  94typedef u_int32_t uint32;
  95typedef int64_t int64;
  96typedef u_int64_t uint64;
  97#elif @ac_cv_have___uint16@    // the windows (vc7) format
  98typedef __int32 int32;
  99typedef unsigned __int32 uint32;
 100typedef __int64 int64;
 101typedef unsigned __int64 uint64;
 102#else
 103#error Do not know how to define a 32-bit integer quantity on your system
 104#endif
 105
 106@ac_google_end_namespace@
 107
 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.
 112//
 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
 116// base/logging.h
 117#ifndef GOOGLE_STRIP_LOG
 118#define GOOGLE_STRIP_LOG 0
 119#endif
 120
 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).
 125//
 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))
 129#else
 130#define GOOGLE_PREDICT_BRANCH_NOT_TAKEN(x) x
 131#endif
 132#endif
 133
 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.,
 136//
 137//   LOG(INFO) << "Found " << num_cookies << " cookies";
 138//
 139// You can capture log messages in a string, rather than reporting them
 140// immediately:
 141//
 142//   vector<string> errors;
 143//   LOG_STRING(ERROR, &errors) << "Couldn't parse cookie #" << cookie_num;
 144//
 145// This pushes back the new error onto 'errors'; if given a NULL pointer,
 146// it reports the error via LOG(ERROR).
 147//
 148// You can also do conditional logging:
 149//
 150//   LOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
 151//
 152// You can also do occasional logging (log every n'th occurrence of an
 153// event):
 154//
 155//   LOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
 156//
 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.
 160//
 161// You can also do occasional conditional logging (log every n'th
 162// occurrence of an event, when condition is satisfied):
 163//
 164//   LOG_IF_EVERY_N(INFO, (size > 1024), 10) << "Got the " << google::COUNTER
 165//                                           << "th big cookie";
 166//
 167// You can log messages the first N times your code executes a line. E.g.
 168//
 169//   LOG_FIRST_N(INFO, 20) << "Got the " << google::COUNTER << "th cookie";
 170//
 171// Outputs log messages for the first 20 times it is executed.
 172//
 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.
 179//
 180// There are also "debug mode" logging macros like the ones above:
 181//
 182//   DLOG(INFO) << "Found cookies";
 183//
 184//   DLOG_IF(INFO, num_cookies > 10) << "Got lots of cookies";
 185//
 186//   DLOG_EVERY_N(INFO, 10) << "Got the " << google::COUNTER << "th cookie";
 187//
 188// All "debug mode" logging is compiled away to nothing for non-debug mode
 189// compiles.
 190//
 191// We also have
 192//
 193//   LOG_ASSERT(assertion);
 194//   DLOG_ASSERT(assertion);
 195//
 196// which is syntactic sugar for {,D}LOG_IF(FATAL, assert fails) << assertion;
 197//
 198// There are "verbose level" logging macros.  They look like
 199//
 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";
 202//
 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
 206// will cause:
 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
 211//
 212// The wildcarding functionality shown by (c) supports both '*' (match
 213// 0 or more characters) and '?' (match any single character) wildcards.
 214//
 215// There's also VLOG_IS_ON(n) "verbose level" condition macro. To be used as
 216//
 217//   if (VLOG_IS_ON(2)) {
 218//     // do some logging preparation and logging
 219//     // that can't be accomplished with just VLOG(2) << ...;
 220//   }
 221//
 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;
 235//
 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.
 242//
 243// There is also the special severity of DFATAL, which logs FATAL in
 244// debug mode, ERROR in normal mode.
 245//
 246// Very important: logging a message at the FATAL severity level causes
 247// the program to terminate (after the message is logged).
 248//
 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).
 253//
 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
 257
 258// LOG LINE PREFIX FORMAT
 259//
 260// Log lines have this form:
 261//
 262//     Lmmdd hh:mm:ss.uuuuuu threadid file:line] msg...
 263//
 264// where the fields are defined as follows:
 265//
 266//   L                A single character, representing the log level
 267//                    (eg 'I' for INFO)
 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
 276//
 277// Example:
 278//
 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
 281//
 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.
 286
 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;                              \
 292  }                                                                           \
 293  using FLAG__namespace_do_not_use_directly_use_DECLARE_##tn##_instead::FLAGS_##name
 294
 295// bool specialization
 296#define DECLARE_bool(name) \
 297  DECLARE_VARIABLE(bool, name, bool)
 298
 299// int32 specialization
 300#define DECLARE_int32(name) \
 301  DECLARE_VARIABLE(@ac_google_namespace@::int32, name, int32)
 302
 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;                       \
 308  }                                                                           \
 309  using FLAG__namespace_do_not_use_directly_use_DECLARE_string_instead::FLAGS_##name
 310#endif
 311
 312// Set whether log messages go to stderr instead of logfiles
 313DECLARE_bool(logtostderr);
 314
 315// Set whether log messages go to stderr in addition to logfiles.
 316DECLARE_bool(alsologtostderr);
 317
 318// Log messages at a level >= this flag are automatically sent to
 319// stderr in addition to log files.
 320DECLARE_int32(stderrthreshold);
 321
 322// Set whether the log prefix should be prepended to each line of output.
 323DECLARE_bool(log_prefix);
 324
 325// Log messages at a level <= this flag are buffered.
 326// Log messages at a higher level are flushed immediately.
 327DECLARE_int32(logbuflevel);
 328
 329// Sets the maximum number of seconds which logs may be buffered for.
 330DECLARE_int32(logbufsecs);
 331
 332// Log suppression level: messages logged at a lower level than this
 333// are suppressed.
 334DECLARE_int32(minloglevel);
 335
 336// If specified, logfiles are written into this directory instead of the
 337// default logging directory.
 338DECLARE_string(log_dir);
 339
 340// Sets the path of the directory into which to put additional links
 341// to the log files.
 342DECLARE_string(log_link);
 343
 344DECLARE_int32(v);  // in vlog_is_on.cc
 345
 346// Sets the maximum log file size (in MB).
 347DECLARE_int32(max_log_size);
 348
 349// Sets whether to avoid logging to the disk if the disk is full.
 350DECLARE_bool(stop_logging_if_full_disk);
 351
 352#ifdef MUST_UNDEF_GFLAGS_DECLARE_MACROS
 353#undef MUST_UNDEF_GFLAGS_DECLARE_MACROS
 354#undef DECLARE_VARIABLE
 355#undef DECLARE_bool
 356#undef DECLARE_int32
 357#undef DECLARE_string
 358#endif
 359
 360// Log messages below the GOOGLE_STRIP_LOG level will be compiled away for
 361// security reasons. See LOG(severtiy) below.
 362
 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.
 366
 367#if GOOGLE_STRIP_LOG == 0
 368#define COMPACT_GOOGLE_LOG_INFO @ac_google_namespace@::LogMessage( \
 369      __FILE__, __LINE__)
 370#define LOG_TO_STRING_INFO(message) @ac_google_namespace@::LogMessage( \
 371      __FILE__, __LINE__, @ac_google_namespace@::INFO, message)
 372#else
 373#define COMPACT_GOOGLE_LOG_INFO @ac_google_namespace@::NullStream()
 374#define LOG_TO_STRING_INFO(message) @ac_google_namespace@::NullStream()
 375#endif
 376
 377#if GOOGLE_STRIP_LOG <= 1
 378#define COMPACT_GOOGLE_LOG_WARNING @ac_google_namespace@::LogMessage( \
 379      __FILE__, __LINE__, @ac_google_namespace@::WARNING)
 380#define LOG_TO_STRING_WARNING(message) @ac_google_namespace@::LogMessage( \
 381      __FILE__, __LINE__, @ac_google_namespace@::WARNING, message)
 382#else
 383#define COMPACT_GOOGLE_LOG_WARNING @ac_google_namespace@::NullStream()
 384#define LOG_TO_STRING_WARNING(message) @ac_google_namespace@::NullStream()
 385#endif
 386
 387#if GOOGLE_STRIP_LOG <= 2
 388#define COMPACT_GOOGLE_LOG_ERROR @ac_google_namespace@::LogMessage( \
 389      __FILE__, __LINE__, @ac_google_namespace@::ERROR)
 390#define LOG_TO_STRING_ERROR(message) @ac_google_namespace@::LogMessage( \
 391      __FILE__, __LINE__, @ac_google_namespace@::ERROR, message)
 392#else
 393#define COMPACT_GOOGLE_LOG_ERROR @ac_google_namespace@::NullStream()
 394#define LOG_TO_STRING_ERROR(message) @ac_google_namespace@::NullStream()
 395#endif
 396
 397#if GOOGLE_STRIP_LOG <= 3
 398#define COMPACT_GOOGLE_LOG_FATAL @ac_google_namespace@::LogMessageFatal( \
 399      __FILE__, __LINE__)
 400#define LOG_TO_STRING_FATAL(message) @ac_google_namespace@::LogMessage( \
 401      __FILE__, __LINE__, @ac_google_namespace@::FATAL, message)
 402#else
 403#define COMPACT_GOOGLE_LOG_FATAL @ac_google_namespace@::NullStreamFatal()
 404#define LOG_TO_STRING_FATAL(message) @ac_google_namespace@::NullStreamFatal()
 405#endif
 406
 407// For DFATAL, we want to use LogMessage (as opposed to
 408// LogMessageFatal), to be consistent with the original behavior.
 409#ifdef NDEBUG
 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@::FATAL)
 414#else
 415#define COMPACT_GOOGLE_LOG_DFATAL @ac_google_namespace@::NullStreamFatal()
 416#endif
 417
 418#define GOOGLE_LOG_INFO(counter) @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::INFO, counter, &@ac_google_namespace@::LogMessage::SendToLog)
 419#define SYSLOG_INFO(counter) \
 420  @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::INFO, counter, \
 421  &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
 422#define GOOGLE_LOG_WARNING(counter)  \
 423  @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::WARNING, counter, \
 424  &@ac_google_namespace@::LogMessage::SendToLog)
 425#define SYSLOG_WARNING(counter)  \
 426  @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::WARNING, counter, \
 427  &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
 428#define GOOGLE_LOG_ERROR(counter)  \
 429  @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::ERROR, counter, \
 430  &@ac_google_namespace@::LogMessage::SendToLog)
 431#define SYSLOG_ERROR(counter)  \
 432  @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::ERROR, counter, \
 433  &@ac_google_namespace@::LogMessage::SendToSyslogAndLog)
 434#define GOOGLE_LOG_FATAL(counter) \
 435  @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::FATAL, counter, \
 436  &@ac_google_namespace@::LogMessage::SendToLog)
 437#define SYSLOG_FATAL(counter) \
 438  @ac_google_namespace@::LogMessage(__FILE__, __LINE__, @ac_google_namespace@::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)
 446
 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__, ERROR, 0, \
 458          &@ac_google_namespace@::LogMessage::SendToLog).stream() << message; \
 459      LocalFree(message); \
 460    } \
 461  }
 462#endif
 463
 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()
 474
 475@ac_google_start_namespace@
 476
 477// They need the definitions of integer types.
 478#include "glog/log_severity.h"
 479#include "glog/vlog_is_on.h"
 480
 481// Initialize google's logging library. You will see the program name
 482// specified by argv0 in log outputs.
 483GOOGLE_GLOG_DLL_DECL void InitGoogleLogging(const char* argv0);
 484
 485// Shutdown google's logging library.
 486GOOGLE_GLOG_DLL_DECL void ShutdownGoogleLogging();
 487
 488// Install a function which will be called after LOG(FATAL).
 489GOOGLE_GLOG_DLL_DECL void InstallFailureFunction(void (*fail_func)());
 490
 491class LogSink;  // defined below
 492
 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.
 497// Argument types:
 498//   LogSink* sink;
 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@::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@::severity,                                  \
 510      static_cast<@ac_google_namespace@::LogSink*>(sink), false).stream()
 511
 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.
 516// Argument types:
 517//   string* message;
 518//   LogSeverity severity;
 519// The cast is to disambiguate NULL arguments.
 520// NOTE: LOG(severity) expands to LogMessage().stream() for the specified
 521// severity.
 522#define LOG_TO_STRING(severity, message) \
 523  LOG_TO_STRING_##severity(static_cast<string*>(message)).stream()
 524
 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.
 529// Argument types:
 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()
 535
 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)
 540
 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
 545
 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 " "
 553
 554// A container for a string pointer which can be evaluated to a bool -
 555// true iff the pointer is NULL.
 556struct 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);
 562  }
 563  std::string* str_;
 564};
 565
 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.
 569template <class T>
 570inline const T&       GetReferenceableValue(const T&           t) { return t; }
 571inline char           GetReferenceableValue(char               t) { return t; }
 572inline unsigned char  GetReferenceableValue(unsigned char      t) { return t; }
 573inline signed char    GetReferenceableValue(signed char        t) { return t; }
 574inline short          GetReferenceableValue(short              t) { return t; }
 575inline unsigned short GetReferenceableValue(unsigned short     t) { return t; }
 576inline int            GetReferenceableValue(int                t) { return t; }
 577inline unsigned int   GetReferenceableValue(unsigned int       t) { return t; }
 578inline long           GetReferenceableValue(long               t) { return t; }
 579inline unsigned long  GetReferenceableValue(unsigned long      t) { return t; }
 580inline long long      GetReferenceableValue(long long          t) { return t; }
 581inline unsigned long long GetReferenceableValue(unsigned long long t) {
 582  return t;
 583}
 584
 585// This is a dummy class to define the following operator.
 586struct DummyClassToDefineOperator {};
 587
 588@ac_google_end_namespace@
 589
 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).
 593inline std::ostream& operator<<(
 594    std::ostream& out, const google::DummyClassToDefineOperator&) {
 595  return out;
 596}
 597
 598@ac_google_start_namespace@
 599
 600// Build the error message string.
 601template<class t1, class t2>
 602std::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@
 607  using ::operator<<;
 608#endif
 609  std::strstream ss;
 610  ss << names << " (" << v1 << " vs. " << v2 << ")";
 611  return new std::string(ss.str(), ss.pcount());
 612}
 613
 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); \
 624  } \
 625  inline std::string* Check##name##Impl(int v1, int v2, const char* names) { \
 626    return Check##name##Impl<int, int>(v1, v2, names); \
 627  }
 628
 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
 632// yacc grammar.
 633DEFINE_CHECK_OP_IMPL(_EQ, ==)
 634DEFINE_CHECK_OP_IMPL(_NE, !=)
 635DEFINE_CHECK_OP_IMPL(_LE, <=)
 636DEFINE_CHECK_OP_IMPL(_LT, < )
 637DEFINE_CHECK_OP_IMPL(_GE, >=)
 638DEFINE_CHECK_OP_IMPL(_GT, > )
 639#undef DEFINE_CHECK_OP_IMPL
 640
 641// Helper macro for binary operators.
 642// Don't use this macro directly in your code, use CHECK_EQ et al below.
 643
 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.
 651
 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 
 656// in the macro.
 657typedef 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()
 666#else
 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
 677
 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)
 681#else
 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
 685
 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.
 689//
 690// You may append to the error message like so:
 691//   CHECK_NE(1, 2) << ": The world must be ending!";
 692//
 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,
 697// for example:
 698//   CHECK_EQ(string("abc")[1], 'b');
 699//
 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.
 703
 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)
 710
 711// Check that the input is non NULL.  This very useful in constructor
 712// initializer lists.
 713
 714#define CHECK_NOTNULL(val) \
 715  @ac_google_namespace@::CheckNotNull(__FILE__, __LINE__, "'" #val "' Must be non NULL", (val))
 716
 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);
 722DECLARE_CHECK_STROP_IMPL(strcmp, true)
 723DECLARE_CHECK_STROP_IMPL(strcmp, false)
 724DECLARE_CHECK_STROP_IMPL(strcasecmp, true)
 725DECLARE_CHECK_STROP_IMPL(strcasecmp, false)
 726#undef DECLARE_CHECK_STROP_IMPL
 727
 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_
 735
 736
 737// String (char*) equality/inequality checks.
 738// CASE versions are case-insensitive.
 739//
 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())).
 743
 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)
 748
 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])))
 751
 752#define CHECK_DOUBLE_EQ(val1, val2)              \
 753  do {                                           \
 754    CHECK_LE((val1), (val2)+0.000000000000001L); \
 755    CHECK_GE((val1), (val2)-0.000000000000001L); \
 756  } while (0)
 757
 758#define CHECK_NEAR(val1, val2, margin)           \
 759  do {                                           \
 760    CHECK_LE((val1), (val2)+(margin));           \
 761    CHECK_GE((val1), (val2)-(margin));           \
 762  } while (0)
 763
 764// perror()..googly style!
 765//
 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.
 769
 770#define PLOG(severity) GOOGLE_PLOG(severity, 0).stream()
 771
 772#define GOOGLE_PLOG(severity, counter)  \
 773  @ac_google_namespace@::ErrnoLogMessage( \
 774      __FILE__, __LINE__, @ac_google_namespace@::severity, counter, \
 775      &@ac_google_namespace@::LogMessage::SendToLog)
 776
 777#define PLOG_IF(severity, condition) \
 778  !(condition) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & PLOG(severity)
 779
 780// A CHECK() macro that postpends errno if the condition is false. E.g.
 781//
 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 " "
 786
 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.
 789//
 790// CHECK_ERR(mkdir(path, 0700));
 791//
 792// or
 793//
 794// int fd = open(filename, flags); CHECK_ERR(fd) << ": open " << filename;
 795#define CHECK_ERR(invocation)                                          \
 796PLOG_IF(FATAL, GOOGLE_PREDICT_BRANCH_NOT_TAKEN((invocation) == -1))    \
 797        << #invocation
 798
 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
 803
 804#define LOG_OCCURRENCES LOG_EVERY_N_VARNAME(occurrences_, __LINE__)
 805#define LOG_OCCURRENCES_MOD_N LOG_EVERY_N_VARNAME(occurrences_mod_n_, __LINE__)
 806
 807#define SOME_KIND_OF_LOG_EVERY_N(severity, n, what_to_do) \
 808  static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
 809  ++LOG_OCCURRENCES; \
 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@::severity, LOG_OCCURRENCES, \
 814        &what_to_do).stream()
 815
 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; \
 818  ++LOG_OCCURRENCES; \
 819  if (condition && \
 820      ((LOG_OCCURRENCES_MOD_N=(LOG_OCCURRENCES_MOD_N + 1) % n) == (1 % n))) \
 821    @ac_google_namespace@::LogMessage( \
 822        __FILE__, __LINE__, @ac_google_namespace@::severity, LOG_OCCURRENCES, \
 823                 &what_to_do).stream()
 824
 825#define SOME_KIND_OF_PLOG_EVERY_N(severity, n, what_to_do) \
 826  static int LOG_OCCURRENCES = 0, LOG_OCCURRENCES_MOD_N = 0; \
 827  ++LOG_OCCURRENCES; \
 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@::severity, LOG_OCCURRENCES, \
 832        &what_to_do).stream()
 833
 834#define SOME_KIND_OF_LOG_FIRST_N(severity, n, what_to_do) \
 835  static int LOG_OCCURRENCES = 0; \
 836  if (LOG_OCCURRENCES <= n) \
 837    ++LOG_OCCURRENCES; \
 838  if (LOG_OCCURRENCES <= n) \
 839    @ac_google_namespace@::LogMessage( \
 840        __FILE__, __LINE__, @ac_google_namespace@::severity, LOG_OCCURRENCES, \
 841        &what_to_do).stream()
 842
 843namespace glog_internal_namespace_ {
 844template <bool>
 845struct CompileAssert {
 846};
 847struct CrashReason;
 848}  // namespace glog_internal_namespace_
 849
 850#define GOOGLE_GLOG_COMPILE_ASSERT(expr, msg) \
 851  typedef @ac_google_namespace@::glog_internal_namespace_::CompileAssert<(bool(expr))> msg[bool(expr) ? 1 : -1]
 852
 853#define LOG_EVERY_N(severity, n)                                        \
 854  GOOGLE_GLOG_COMPILE_ASSERT(@ac_google_namespace@::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)
 858
 859#define SYSLOG_EVERY_N(severity, n) \
 860  SOME_KIND_OF_LOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToSyslogAndLog)
 861
 862#define PLOG_EVERY_N(severity, n) \
 863  SOME_KIND_OF_PLOG_EVERY_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
 864
 865#define LOG_FIRST_N(severity, n) \
 866  SOME_KIND_OF_LOG_FIRST_N(severity, (n), @ac_google_namespace@::LogMessage::SendToLog)
 867
 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)
 870
 871// We want the special COUNTER value available for LOG_EVERY_X()'ed messages
 872enum PRIVATE_Counter {COUNTER};
 873
 874
 875// Plus some debug-logging macros that get compiled to nothing for production
 876
 877#ifndef NDEBUG
 878
 879#define DLOG(severity) LOG(severity)
 880#define DVLOG(verboselevel) VLOG(verboselevel)
 881#define DLOG_IF(severity, condition) LOG_IF(severity, condition)
 882#define DLOG_EVERY_N(severity, n) LOG_EVERY_N(severity, n)
 883#define DLOG_IF_EVERY_N(severity, condition, n) \
 884  LOG_IF_EVERY_N(severity, condition, n)
 885#define DLOG_ASSERT(condition) LOG_ASSERT(condition)
 886
 887// debug-only checking.  not executed in NDEBUG mode.
 888#define DCHECK(condition) CHECK(condition)
 889#define DCHECK_EQ(val1, val2) CHECK_EQ(val1, val2)
 890#define DCHECK_NE(val1, val2) CHECK_NE(val1, val2)
 891#define DCHECK_LE(val1, val2) CHECK_LE(val1, val2)
 892#define DCHECK_LT(val1, val2) CHECK_LT(val1, val2)
 893#define DCHECK_GE(val1, val2) CHECK_GE(val1, val2)
 894#define DCHECK_GT(val1, val2) CHECK_GT(val1, val2)
 895#define DCHECK_NOTNULL(val) CHECK_NOTNULL(val)
 896#define DCHECK_STREQ(str1, str2) CHECK_STREQ(str1, str2)
 897#define DCHECK_STRCASEEQ(str1, str2) CHECK_STRCASEEQ(str1, str2)
 898#define DCHECK_STRNE(str1, str2) CHECK_STRNE(str1, str2)
 899#define DCHECK_STRCASENE(str1, str2) CHECK_STRCASENE(str1, str2)
 900
 901#else  // NDEBUG
 902
 903#define DLOG(severity) \
 904  true ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
 905
 906#define DVLOG(verboselevel) \
 907  (true || !VLOG_IS_ON(verboselevel)) ?\
 908    (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(INFO)
 909
 910#define DLOG_IF(severity, condition) \
 911  (true || !(condition)) ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
 912
 913#define DLOG_EVERY_N(severity, n) \
 914  true ? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
 915
 916#define DLOG_IF_EVERY_N(severity, condition, n) \
 917  (true || !(condition))? (void) 0 : @ac_google_namespace@::LogMessageVoidify() & LOG(severity)
 918
 919#define DLOG_ASSERT(condition) \
 920  true ? (void) 0 : LOG_ASSERT(condition)
 921
 922#define DCHECK(condition) \
 923  while (false) \
 924    CHECK(condition)
 925
 926#define DCHECK_EQ(val1, val2) \
 927  while (false) \
 928    CHECK_EQ(val1, val2)
 929
 930#define DCHECK_NE(val1, val2) \
 931  while (false) \
 932    CHECK_NE(val1, val2)
 933
 934#define DCHECK_LE(val1, val2) \
 935  while (false) \
 936    CHECK_LE(val1, val2)
 937
 938#define DCHECK_LT(val1, val2) \
 939  while (false) \
 940    CHECK_LT(val1, val2)
 941
 942#define DCHECK_GE(val1, val2) \
 943  while (false) \
 944    CHECK_GE(val1, val2)
 945
 946#define DCHECK_GT(val1, val2) \
 947  while (false) \
 948    CHECK_GT(val1, val2)
 949
 950#define DCHECK_NOTNULL(val) (val)
 951
 952#define DCHECK_STREQ(str1, str2) \
 953  while (false) \
 954    CHECK_STREQ(str1, str2)
 955
 956#define DCHECK_STRCASEEQ(str1, str2) \
 957  while (false) \
 958    CHECK_STRCASEEQ(str1, str2)
 959
 960#define DCHECK_STRNE(str1, str2) \
 961  while (false) \
 962    CHECK_STRNE(str1, str2)
 963
 964#define DCHECK_STRCASENE(str1, str2) \
 965  while (false) \
 966    CHECK_STRCASENE(str1, str2)
 967
 968
 969#endif  // NDEBUG
 970
 971// Log only in verbose mode.
 972
 973#define VLOG(verboselevel) LOG_IF(INFO, VLOG_IS_ON(verboselevel))
 974
 975#define VLOG_IF(verboselevel, condition) \
 976  LOG_IF(INFO, (condition) && VLOG_IS_ON(verboselevel))
 977
 978#define VLOG_EVERY_N(verboselevel, n) \
 979  LOG_IF_EVERY_N(INFO, VLOG_IS_ON(verboselevel), n)
 980
 981#define VLOG_IF_EVERY_N(verboselevel, condition, n) \
 982  LOG_IF_EVERY_N(INFO, (condition) && VLOG_IS_ON(verboselevel), n)
 983
 984//
 985// This class more or less represents a particular log message.  You
 986// create an instance of LogMessage and then stream stuff to it.
 987// When you finish streaming to it, ~LogMessage is called and the
 988// full message gets streamed to the appropriate destination.
 989//
 990// You shouldn't actually use LogMessage's constructor to log things,
 991// though.  You should use the LOG() macro (and variants thereof)
 992// above.
 993class GOOGLE_GLOG_DLL_DECL LogMessage {
 994public:
 995  enum {
 996    // Passing kNoLogPrefix for the line number disables the
 997    // log-message prefix. Useful for using the LogMessage
 998    // infrastructure as a printing utility. See also the --log_prefix
 999    // flag for controlling the log-message prefix on an
1000    // application-wide basis.
1001    kNoLogPrefix = -1
1002  };
1003
1004  // LogStream inherit from non-DLL-exported class (std::ostrstream)
1005  // and VC++ produces a warning for this situation.
1006  // However, MSDN says "C4275 can be ignored in Microsoft Visual C++
1007  // 2005 if you are deriving from a type in the Standard C++ Library"
1008  // http://msdn.microsoft.com/en-us/library/3tdb471s(VS.80).aspx
1009  // Let's just ignore the warning.
1010#ifdef _MSC_VER
1011# pragma warning(disable: 4275)
1012#endif
1013  class GOOGLE_GLOG_DLL_DECL LogStream : public std::ostrstream {
1014#ifdef _MSC_VER
1015# pragma warning(default: 4275)
1016#endif
1017  public:
1018    LogStream(char *buf, int len, int ctr)
1019      : ostrstream(buf, len),
1020        ctr_(ctr) {
1021      self_ = this;
1022    }
1023
1024    int ctr() const { return ctr_; }
1025    void set_ctr(int ctr) { ctr_ = ctr; }
1026    LogStream* self() const { return self_; }
1027
1028  private:
1029    int ctr_;  // Counter hack (for the LOG_EVERY_X() macro)
1030    LogStream *self_;  // Consistency check hack
1031  };
1032
1033public:
1034  // icc 8 requires this typedef to avoid an internal compiler error.
1035  typedef void (LogMessage::*SendMethod)();
1036
1037  LogMessage(const char* file, int line, LogSeverity severity, int ctr,
1038             SendMethod send_method);
1039
1040  // Two special constructors that generate reduced amounts of code at
1041  // LOG call sites for common cases.
1042
1043  // Used for LOG(INFO): Implied are:
1044  // severity = INFO, ctr = 0, send_method = &LogMessage::SendToLog.
1045  //
1046  // Using this constructor instead of the more complex constructor above
1047  // saves 19 bytes per call site.
1048  LogMessage(const char* file, int line);
1049
1050  // Used for LOG(severity) where severity != INFO.  Implied
1051  // are: ctr = 0, send_method = &LogMessage::SendToLog
1052  //
1053  // Using this constructor instead of the more complex constructor above
1054  // saves 17 bytes per call site.
1055  LogMessage(const char* file, int line, LogSeverity severity);
1056
1057  // Constructor to log this message to a specified sink (if not NULL).
1058  // Implied are: ctr = 0, send_method = &LogMessage::SendToSinkAndLog if
1059  // also_send_to_log is true, send_method = &LogMessage::SendToSink otherwise.
1060  LogMessage(const char* file, int line, LogSeverity severity, LogSink* sink,
1061             bool also_send_to_log);
1062
1063  // Constructor where we also give a vector<string> pointer
1064  // for storing the messages (if the pointer is not NULL).
1065  // Implied are: ctr = 0, send_method = &LogMessage::SaveOrSendToLog.
1066  LogMessage(const char* file, int line, LogSeverity severity,
1067             std::vector<std::string>* outvec);
1068
1069  // Constructor where we also give a string pointer for storing the
1070  // message (if the pointer is not NULL).  Implied are: ctr = 0,
1071  // send_method = &LogMessage::WriteToStringAndLog.
1072  LogMessage(const char* file, int line, LogSeverity severity,
1073             std::string* message);
1074
1075  // A special constructor used for check failures
1076  LogMessage(const char* file, int line, const CheckOpString& result);
1077
1078  ~LogMessage();
1079
1080  // Flush a buffered message to the sink set in the constructor.  Always
1081  // called by the destructor, it may also be called from elsewhere if
1082  // needed.  Only the first call is actioned; any later ones are ignored.
1083  void Flush();
1084
1085  // An arbitrary limit on the length of a single log message.  This
1086  // is so that streaming can be done more efficiently.
1087  static const size_t kMaxLogMessageLen;
1088
1089  // Theses should not be called directly outside of logging.*,
1090  // only passed as SendMethod arguments to other LogMessage methods:
1091  void SendToLog();  // Actually dispatch to the logs
1092  void SendToSyslogAndLog();  // Actually dispatch to syslog and the logs
1093
1094  // Call abort() or similar to perform LOG(FATAL) crash.
1095  static void Fail() @ac_cv___attribute___noreturn@;
1096
1097  std::ostream& stream() { return *(data_->stream_); }
1098
1099  int preserved_errno() const { return data_->preserved_errno_; }
1100
1101  // Must be called without the log_mutex held.  (L < log_mutex)
1102  static int64 num_messages(int severity);
1103
1104private:
1105  // Fully internal SendMethod cases:
1106  void SendToSinkAndLog();  // Send to sink if provided and dispatch to the logs
1107  void SendToSink();  // Send to sink if provided, do nothing otherwise.
1108
1109  // Write to string if provided and dispatch to the logs.
1110  void WriteToStringAndLog();
1111
1112  void SaveOrSendToLog();  // Save to stringvec if provided, else to logs
1113
1114  void Init(const char* file, int line, LogSeverity severity,
1115            void (LogMessage::*send_method)());
1116
1117  // Used to fill in crash information during LOG(FATAL) failures.
1118  void RecordCrashReason(glog_internal_namespace_::CrashReason* reason);
1119
1120  // Counts of messages sent at each priority:
1121  static int64 num_messages_[NUM_SEVERITIES];  // under log_mutex
1122
1123  // We keep the data in a separate struct so that each instance of
1124  // LogMessage uses less stack space.
1125  struct GOOGLE_GLOG_DLL_DECL LogMessageData {
1126    LogMessageData() {};
1127
1128    int preserved_errno_;      // preserved errno
1129    char* buf_;
1130    char* message_text_;  // Complete message text (points to selected buffer)
1131    LogStream* stream_alloc_;
1132    LogStream* stream_;
1133    char severity_;      // What level is this LogMessage logged at?
1134    int line_;                 // line number where logging call is.
1135    void (LogMessage::*send_method_)();  // Call this in destructor to send
1136    union {  // At most one of these is used: union to keep the size low.
1137      LogSink* sink_;             // NULL or sink to send message to
1138      std::vector<std::string>* outvec_; // NULL or vector to push message onto
1139      std::string* message_;             // NULL or string to write message into
1140    };
1141    time_t timestamp_;            // Time of creation of LogMessage
1142    struct ::tm tm_time_;         // Time of creation of LogMessage
1143    size_t num_prefix_chars_;     // # of chars of prefix in this message
1144    size_t num_chars_to_log_;     // # of chars of msg to send to log
1145    size_t num_chars_to_syslog_;  // # of chars of msg to send to syslog
1146    const char* basename_;        // basename of file that called LOG
1147    const char* fullname_;        // fullname of file that called LOG
1148    bool has_been_flushed_;       // false => data has not been flushed
1149    bool first_fatal_;            // true => this was first fatal msg
1150
1151    ~LogMessageData();
1152   private:
1153    LogMessageData(const LogMessageData&);
1154    void operator=(const LogMessageData&);
1155  };
1156
1157  static LogMessageData fatal_msg_data_exclusive_;
1158  static LogMessageData fatal_msg_data_shared_;
1159
1160  LogMessageData* allocated_;
1161  LogMessageData* data_;
1162
1163  friend class LogDestination;
1164
1165  LogMessage(const LogMessage&);
1166  void operator=(const LogMessage&);
1167};
1168
1169// This class happens to be thread-hostile because all instances share
1170// a single data buffer, but since it can only be created just before
1171// the process dies, we don't worry so much.
1172class GOOGLE_GLOG_DLL_DECL LogMessageFatal : public LogMessage {
1173 public:
1174  LogMessageFatal(const char* file, int line);
1175  LogMessageFatal(const char* file, int line, const CheckOpString& result);
1176  ~LogMessageFatal() @ac_cv___attribute___noreturn@;
1177};
1178
1179// A non-macro interface to the log facility; (useful
1180// when the logging level is not a compile-time constant).
1181inline void LogAtLevel(int const severity, std::string const &msg) {
1182  LogMessage(__FILE__, __LINE__, severity).stream() << msg;
1183}
1184
1185// A macro alternative of LogAtLevel. New code may want to use this
1186// version since there are two advantages: 1. this version outputs the
1187// file name and the line number where this macro is put like other
1188// LOG macros, 2. this macro can be used as C++ stream.
1189#define LOG_AT_LEVEL(severity) @ac_google_namespace@::LogMessage(__FILE__, __LINE__, severity).stream()
1190
1191// A small helper for CHECK_NOTNULL().
1192template <typename T>
1193T* CheckNotNull(const char *file, int line, const char *names, T* t) {
1194  if (t == NULL) {
1195    LogMessageFatal(file, line, new std::string(names));
1196  }
1197  return t;
1198}
1199
1200// Allow folks to put a counter in the LOG_EVERY_X()'ed messages. This
1201// only works if ostream is a LogStream. If the ostream is not a
1202// LogStream you'll get an assert saying as much at runtime.
1203GOOGLE_GLOG_DLL_DECL std::ostream& operator<<(std::ostream &os,
1204                                              const PRIVATE_Counter&);
1205
1206
1207// Derived class for PLOG*() above.
1208class GOOGLE_GLOG_DLL_DECL ErrnoLogMessage : public LogMessage {
1209 public:
1210
1211  ErrnoLogMessage(const char* file, int line, LogSeverity severity, int ctr,
1212                  void (LogMessage::*send_method)());
1213
1214  // Postpends ": strerror(errno) [errno]".
1215  ~ErrnoLogMessage();
1216
1217 private:
1218  ErrnoLogMessage(const ErrnoLogMessage&);
1219  void operator=(const ErrnoLogMessage&);
1220};
1221
1222
1223// This class is used to explicitly ignore values in the conditional
1224// logging macros.  This avoids compiler warnings like "value computed
1225// is not used" and "statement has no effect".
1226
1227class GOOGLE_GLOG_DLL_DECL LogMess…

Large files files are truncated, but you can click here to view the full file