src/glog/raw_logging.h.in

   1 // Copyright (c) 2006, 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: Maxim Lifantsev
  31 //
  32 // Thread-safe logging routines that do not allocate any memory or
  33 // acquire any locks, and can therefore be used by low-level memory
  34 // allocation and synchronization code.
  35
  36 #ifndef BASE_RAW_LOGGING_H_
  37 #define BASE_RAW_LOGGING_H_
  38
  39 @ac_google_start_namespace@
  40
  41 #include "glog/log_severity.h"
  42 #include "glog/vlog_is_on.h"
  43
  44 // Annoying stuff for windows -- makes sure clients can import these functions
  45 #ifndef GOOGLE_GLOG_DLL_DECL
  46 # if defined(_WIN32) && !defined(__CYGWIN__)
  47 #   define GOOGLE_GLOG_DLL_DECL  __declspec(dllimport)
  48 # else
  49 #   define GOOGLE_GLOG_DLL_DECL
  50 # endif
  51 #endif
  52
  53 // This is similar to LOG(severity) << format... and VLOG(level) << format..,
  54 // but
  55 // * it is to be used ONLY by low-level modules that can't use normal LOG()
  56 // * it is desiged to be a low-level logger that does not allocate any
  57 //   memory and does not need any locks, hence:
  58 // * it logs straight and ONLY to STDERR w/o buffering
  59 // * it uses an explicit format and arguments list
  60 // * it will silently chop off really long message strings
  61 // Usage example:
  62 //   RAW_LOG(ERROR, "Failed foo with %i: %s", status, error);
  63 //   RAW_VLOG(3, "status is %i", status);
  64 // These will print an almost standard log lines like this to stderr only:
  65 //   E0821 211317 file.cc:123] RAW: Failed foo with 22: bad_file
  66 //   I0821 211317 file.cc:142] RAW: status is 20
  67 #define RAW_LOG(severity, ...) \
  68   do { \
  69     switch (@ac_google_namespace@::severity) {  \
  70       case 0: \
  71         RAW_LOG_INFO(__VA_ARGS__); \
  72         break; \
  73       case 1: \
  74         RAW_LOG_WARNING(__VA_ARGS__); \
  75         break; \
  76       case 2: \
  77         RAW_LOG_ERROR(__VA_ARGS__); \
  78         break; \
  79       case 3: \
  80         RAW_LOG_FATAL(__VA_ARGS__); \
  81         break; \
  82       default: \
  83         break; \
  84     } \
  85   } while (0)
  86
  87 // The following STRIP_LOG testing is performed in the header file so that it's
  88 // possible to completely compile out the logging code and the log messages.
  89 #if STRIP_LOG == 0
  90 #define RAW_VLOG(verboselevel, ...) \
  91   do { \
  92     if (VLOG_IS_ON(verboselevel)) { \
  93       RAW_LOG_INFO(__VA_ARGS__); \
  94     } \
  95   } while (0)
  96 #else
  97 #define RAW_VLOG(verboselevel, ...) RawLogStub__(0, __VA_ARGS__)
  98 #endif // STRIP_LOG == 0
  99
 100 #if STRIP_LOG == 0
 101 #define RAW_LOG_INFO(...) @ac_google_namespace@::RawLog__(@ac_google_namespace@::INFO, \
 102                                    __FILE__, __LINE__, __VA_ARGS__)
 103 #else
 104 #define RAW_LOG_INFO(...) @ac_google_namespace@::RawLogStub__(0, __VA_ARGS__)
 105 #endif // STRIP_LOG == 0
 106
 107 #if STRIP_LOG <= 1
 108 #define RAW_LOG_WARNING(...) @ac_google_namespace@::RawLog__(@ac_google_namespace@::WARNING,   \
 109                                       __FILE__, __LINE__, __VA_ARGS__)
 110 #else
 111 #define RAW_LOG_WARNING(...) @ac_google_namespace@::RawLogStub__(0, __VA_ARGS__)
 112 #endif // STRIP_LOG <= 1
 113
 114 #if STRIP_LOG <= 2
 115 #define RAW_LOG_ERROR(...) @ac_google_namespace@::RawLog__(@ac_google_namespace@::ERROR,       \
 116                                     __FILE__, __LINE__, __VA_ARGS__)
 117 #else
 118 #define RAW_LOG_ERROR(...) @ac_google_namespace@::RawLogStub__(0, __VA_ARGS__)
 119 #endif // STRIP_LOG <= 2
 120
 121 #if STRIP_LOG <= 3
 122 #define RAW_LOG_FATAL(...) @ac_google_namespace@::RawLog__(@ac_google_namespace@::FATAL,       \
 123                                     __FILE__, __LINE__, __VA_ARGS__)
 124 #else
 125 #define RAW_LOG_FATAL(...) \
 126   do { \
 127     @ac_google_namespace@::RawLogStub__(0, __VA_ARGS__);        \
 128     exit(1); \
 129   } while (0)
 130 #endif // STRIP_LOG <= 3
 131
 132 // Similar to CHECK(condition) << message,
 133 // but for low-level modules: we use only RAW_LOG that does not allocate memory.
 134 // We do not want to provide args list here to encourage this usage:
 135 //   if (!cond)  RAW_LOG(FATAL, "foo ...", hard_to_compute_args);
 136 // so that the args are not computed when not needed.
 137 #define RAW_CHECK(condition, message)                                   \
 138   do {                                                                  \
 139     if (!(condition)) {                                                 \
 140       RAW_LOG(FATAL, "Check %s failed: %s", #condition, message);       \
 141     }                                                                   \
 142   } while (0)
 143
 144 // Debug versions of RAW_LOG and RAW_CHECK
 145 #ifndef NDEBUG
 146
 147 #define RAW_DLOG(severity, ...) RAW_LOG(severity, __VA_ARGS__)
 148 #define RAW_DCHECK(condition, message) RAW_CHECK(condition, message)
 149
 150 #else  // NDEBUG
 151
 152 #define RAW_DLOG(severity, ...)                                 \
 153   while (false)                                                 \
 154     RAW_LOG(severity, __VA_ARGS__)
 155 #define RAW_DCHECK(condition, message) \
 156   while (false) \
 157     RAW_CHECK(condition, message)
 158
 159 #endif  // NDEBUG
 160
 161 // Stub log function used to work around for unused variable warnings when
 162 // building with STRIP_LOG > 0.
 163 static inline void RawLogStub__(int ignored, ...) {
 164 }
 165
 166 // Helper function to implement RAW_LOG and RAW_VLOG
 167 // Logs format... at "severity" level, reporting it
 168 // as called from file:line.
 169 // This does not allocate memory or acquire locks.
 170 GOOGLE_GLOG_DLL_DECL void RawLog__(LogSeverity severity,
 171                                    const char* file,
 172                                    int line,
 173                                    const char* format, ...)
 174    @ac_cv___attribute___printf_4_5@;
 175
 176 // Hack to propagate time information into this module so that
 177 // this module does not have to directly call localtime_r(),
 178 // which could allocate memory.
 179 extern "C" struct ::tm;
 180 GOOGLE_GLOG_DLL_DECL void RawLog__SetLastTime(const struct ::tm& t, int usecs);
 181
 182 @ac_google_end_namespace@
 183
 184 #endif  // BASE_RAW_LOGGING_H_