Avi Drissman | e4622aa | 2022-09-08 20:36:06 | [diff] [blame] | 1 | // Copyright 2012 The Chromium Authors |
license.bot | bf09a50 | 2008-08-24 00:55:55 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 4 | |
brettw@google.com | 39be424 | 2008-08-07 18:31:40 | [diff] [blame] | 5 | #ifndef BASE_LOGGING_H_ |
| 6 | #define BASE_LOGGING_H_ |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 7 | |
avi | 9b6f4293 | 2015-12-26 22:15:14 | [diff] [blame] | 8 | #include <stddef.h> |
| 9 | |
tzik@chromium.org | e7972d1 | 2011-06-18 11:53:14 | [diff] [blame] | 10 | #include <cassert> |
Sharon Yang | 7cb919a | 2019-05-20 20:27:15 | [diff] [blame] | 11 | #include <cstdint> |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 12 | #include <sstream> |
avi | 9b6f4293 | 2015-12-26 22:15:14 | [diff] [blame] | 13 | #include <string> |
David Benjamin | b1ccd0cb | 2023-06-22 23:08:45 | [diff] [blame] | 14 | #include <string_view> |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 15 | |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 16 | #include "base/base_export.h" |
danakj | cb7c529 | 2016-12-20 19:05:35 | [diff] [blame] | 17 | #include "base/compiler_specific.h" |
Hans Wennborg | 944479f | 2020-06-25 21:39:25 | [diff] [blame] | 18 | #include "base/dcheck_is_on.h" |
Avi Drissman | 63e1f99 | 2023-01-13 18:54:43 | [diff] [blame] | 19 | #include "base/functional/callback_forward.h" |
Etienne Pierre-Doray | d120ebf | 2018-09-14 23:38:21 | [diff] [blame] | 20 | #include "base/scoped_clear_last_error.h" |
Lei Zhang | c5f765d5 | 2023-11-08 00:53:33 | [diff] [blame] | 21 | #include "base/strings/string_piece.h" |
David Benjamin | b1ccd0cb | 2023-06-22 23:08:45 | [diff] [blame] | 22 | #include "base/strings/utf_ostream_operators.h" |
Eric Willigers | 026d7ea | 2021-12-07 21:44:54 | [diff] [blame] | 23 | #include "build/build_config.h" |
Yuta Hijikata | 000df18f | 2020-11-18 06:55:58 | [diff] [blame] | 24 | #include "build/chromeos_buildflags.h" |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 25 | |
Georg Neis | ffe34f65 | 2021-12-27 21:42:36 | [diff] [blame] | 26 | #if BUILDFLAG(IS_CHROMEOS) |
Robbie McElrath | 8bf4984 | 2019-08-20 22:22:53 | [diff] [blame] | 27 | #include <cstdio> |
| 28 | #endif |
| 29 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 30 | // |
| 31 | // Optional message capabilities |
| 32 | // ----------------------------- |
| 33 | // Assertion failed messages and fatal errors are displayed in a dialog box |
| 34 | // before the application exits. However, running this UI creates a message |
| 35 | // loop, which causes application messages to be processed and potentially |
| 36 | // dispatched to existing application windows. Since the application is in a |
| 37 | // bad state when this assertion dialog is displayed, these messages may not |
| 38 | // get processed and hang the dialog, or the application might go crazy. |
| 39 | // |
| 40 | // Therefore, it can be beneficial to display the error dialog in a separate |
| 41 | // process from the main application. When the logging system needs to display |
| 42 | // a fatal error dialog box, it will look for a program called |
| 43 | // "DebugMessage.exe" in the same directory as the application executable. It |
| 44 | // will run this application with the message as the command line, and will |
| 45 | // not include the name of the application as is traditional for easier |
| 46 | // parsing. |
| 47 | // |
| 48 | // The code for DebugMessage.exe is only one line. In WinMain, do: |
| 49 | // MessageBox(NULL, GetCommandLineW(), L"Fatal Error", 0); |
| 50 | // |
| 51 | // If DebugMessage.exe is not found, the logging code will use a normal |
| 52 | // MessageBox, potentially causing the problems discussed above. |
| 53 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 54 | // Instructions |
| 55 | // ------------ |
| 56 | // |
| 57 | // Make a bunch of macros for logging. The way to log things is to stream |
| 58 | // things to LOG(<a particular severity level>). E.g., |
| 59 | // |
| 60 | // LOG(INFO) << "Found " << num_cookies << " cookies"; |
| 61 | // |
| 62 | // You can also do conditional logging: |
| 63 | // |
| 64 | // LOG_IF(INFO, num_cookies > 10) << "Got lots of cookies"; |
| 65 | // |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 66 | // The CHECK(condition) macro is active in both debug and release builds and |
| 67 | // effectively performs a LOG(FATAL) which terminates the process and |
| 68 | // generates a crashdump unless a debugger is attached. |
| 69 | // |
| 70 | // There are also "debug mode" logging macros like the ones above: |
| 71 | // |
| 72 | // DLOG(INFO) << "Found cookies"; |
| 73 | // |
| 74 | // DLOG_IF(INFO, num_cookies > 10) << "Got lots of cookies"; |
| 75 | // |
| 76 | // All "debug mode" logging is compiled away to nothing for non-debug mode |
| 77 | // compiles. LOG_IF and development flags also work well together |
| 78 | // because the code can be compiled away sometimes. |
| 79 | // |
| 80 | // We also have |
| 81 | // |
| 82 | // LOG_ASSERT(assertion); |
| 83 | // DLOG_ASSERT(assertion); |
| 84 | // |
| 85 | // which is syntactic sugar for {,D}LOG_IF(FATAL, assert fails) << assertion; |
| 86 | // |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 87 | // There are "verbose level" logging macros. They look like |
| 88 | // |
| 89 | // VLOG(1) << "I'm printed when you run the program with --v=1 or more"; |
| 90 | // VLOG(2) << "I'm printed when you run the program with --v=2 or more"; |
| 91 | // |
| 92 | // These always log at the INFO log level (when they log at all). |
Xiyuan Xia | a0559da | 2022-05-05 19:42:45 | [diff] [blame] | 93 | // |
Xiyuan Xia | 28d809d | 2023-11-02 22:00:42 | [diff] [blame] | 94 | // The verbose logging can also be turned on module-by-module. For instance, |
akalin@chromium.org | b0d38d4 | 2010-10-29 00:39:48 | [diff] [blame] | 95 | // --vmodule=profile=2,icon_loader=1,browser_*=3,*/chromeos/*=4 --v=0 |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 96 | // will cause: |
| 97 | // a. VLOG(2) and lower messages to be printed from profile.{h,cc} |
| 98 | // b. VLOG(1) and lower messages to be printed from icon_loader.{h,cc} |
| 99 | // c. VLOG(3) and lower messages to be printed from files prefixed with |
| 100 | // "browser" |
akalin@chromium.org | e11de72 | 2010-11-01 20:50:55 | [diff] [blame] | 101 | // d. VLOG(4) and lower messages to be printed from files under a |
akalin@chromium.org | b0d38d4 | 2010-10-29 00:39:48 | [diff] [blame] | 102 | // "chromeos" directory. |
akalin@chromium.org | e11de72 | 2010-11-01 20:50:55 | [diff] [blame] | 103 | // e. VLOG(0) and lower messages to be printed from elsewhere |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 104 | // |
| 105 | // The wildcarding functionality shown by (c) supports both '*' (match |
akalin@chromium.org | b0d38d4 | 2010-10-29 00:39:48 | [diff] [blame] | 106 | // 0 or more characters) and '?' (match any single character) |
| 107 | // wildcards. Any pattern containing a forward or backward slash will |
| 108 | // be tested against the whole pathname and not just the module. |
| 109 | // E.g., "*/foo/bar/*=2" would change the logging level for all code |
| 110 | // in source files under a "foo/bar" directory. |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 111 | // |
Mason Freed | 14240d16 | 2020-08-12 13:06:34 | [diff] [blame] | 112 | // Note that for a Chromium binary built in release mode (is_debug = false) you |
| 113 | // must pass "--enable-logging=stderr" in order to see the output of VLOG |
| 114 | // statements. |
| 115 | // |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 116 | // There's also VLOG_IS_ON(n) "verbose level" condition macro. To be used as |
| 117 | // |
| 118 | // if (VLOG_IS_ON(2)) { |
| 119 | // // do some logging preparation and logging |
| 120 | // // that can't be accomplished with just VLOG(2) << ...; |
| 121 | // } |
| 122 | // |
| 123 | // There is also a VLOG_IF "verbose level" condition macro for sample |
| 124 | // cases, when some extra computation and preparation for logs is not |
| 125 | // needed. |
| 126 | // |
| 127 | // VLOG_IF(1, (size > 1024)) |
| 128 | // << "I'm printed when size is more than 1024 and when you run the " |
| 129 | // "program with --v=1 or more"; |
| 130 | // |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 131 | // We also override the standard 'assert' to use 'DLOG_ASSERT'. |
| 132 | // |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 133 | // Lastly, there is: |
| 134 | // |
| 135 | // PLOG(ERROR) << "Couldn't do foo"; |
| 136 | // DPLOG(ERROR) << "Couldn't do foo"; |
| 137 | // PLOG_IF(ERROR, cond) << "Couldn't do foo"; |
| 138 | // DPLOG_IF(ERROR, cond) << "Couldn't do foo"; |
| 139 | // PCHECK(condition) << "Couldn't do foo"; |
| 140 | // DPCHECK(condition) << "Couldn't do foo"; |
| 141 | // |
| 142 | // which append the last system error to the message in string form (taken from |
| 143 | // GetLastError() on Windows and errno on POSIX). |
| 144 | // |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 145 | // The supported severity levels for macros that allow you to specify one |
viettrungluu@chromium.org | f2c0549 | 2014-06-17 12:04:23 | [diff] [blame] | 146 | // are (in increasing order of severity) INFO, WARNING, ERROR, and FATAL. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 147 | // |
| 148 | // Very important: logging a message at the FATAL severity level causes |
| 149 | // the program to terminate (after the message is logged). |
huanr@chromium.org | fb62a53 | 2009-02-12 01:19:05 | [diff] [blame] | 150 | // |
danakj | f8e9c30 | 2021-01-27 21:37:23 | [diff] [blame] | 151 | // There is the special severity of DFATAL, which logs FATAL in DCHECK-enabled |
| 152 | // builds, ERROR in normal mode. |
Rob Schonberger | 4563721 | 2018-12-03 04:46:25 | [diff] [blame] | 153 | // |
Yuta Hijikata | 9b7279a | 2020-08-26 16:10:54 | [diff] [blame] | 154 | // Output is formatted as per the following example, except on Chrome OS. |
Rob Schonberger | 4563721 | 2018-12-03 04:46:25 | [diff] [blame] | 155 | // [3816:3877:0812/234555.406952:VERBOSE1:drm_device_handle.cc(90)] Succeeded |
| 156 | // authenticating /dev/dri/card0 in 0 ms with 1 attempt(s) |
| 157 | // |
| 158 | // The colon separated fields inside the brackets are as follows: |
| 159 | // 0. An optional Logfile prefix (not included in this example) |
| 160 | // 1. Process ID |
| 161 | // 2. Thread ID |
| 162 | // 3. The date/time of the log message, in MMDD/HHMMSS.Milliseconds format |
| 163 | // 4. The log level |
| 164 | // 5. The filename and line number where the log was instantiated |
| 165 | // |
Yuta Hijikata | 9b7279a | 2020-08-26 16:10:54 | [diff] [blame] | 166 | // Output for Chrome OS can be switched to syslog-like format. See |
Georg Neis | ffe34f65 | 2021-12-27 21:42:36 | [diff] [blame] | 167 | // InitWithSyslogPrefix() in logging_chromeos.cc for details. |
Yuta Hijikata | 9b7279a | 2020-08-26 16:10:54 | [diff] [blame] | 168 | // |
Rob Schonberger | 4563721 | 2018-12-03 04:46:25 | [diff] [blame] | 169 | // Note that the visibility can be changed by setting preferences in |
| 170 | // SetLogItems() |
Mason Freed | 14240d16 | 2020-08-12 13:06:34 | [diff] [blame] | 171 | // |
| 172 | // Additional logging-related information can be found here: |
John Palmer | d29fc436 | 2021-05-20 03:29:22 | [diff] [blame] | 173 | // https://chromium.googlesource.com/chromium/src/+/main/docs/linux/debugging.md#Logging |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 174 | |
| 175 | namespace logging { |
| 176 | |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 177 | // TODO(avi): do we want to do a unification of character types here? |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 178 | #if BUILDFLAG(IS_WIN) |
Jan Wilken Dörrie | b630aca | 2019-12-04 10:59:11 | [diff] [blame] | 179 | typedef wchar_t PathChar; |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 180 | #elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA) |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 181 | typedef char PathChar; |
| 182 | #endif |
| 183 | |
Sharon Yang | 7cb919a | 2019-05-20 20:27:15 | [diff] [blame] | 184 | // A bitmask of potential logging destinations. |
| 185 | using LoggingDestination = uint32_t; |
| 186 | // Specifies where logs will be written. Multiple destinations can be specified |
| 187 | // with bitwise OR. |
| 188 | // Unless destination is LOG_NONE, all logs with severity ERROR and above will |
| 189 | // be written to stderr in addition to the specified destination. |
| 190 | enum : uint32_t { |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 191 | LOG_NONE = 0, |
| 192 | LOG_TO_FILE = 1 << 0, |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 193 | LOG_TO_SYSTEM_DEBUG_LOG = 1 << 1, |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 194 | LOG_TO_STDERR = 1 << 2, |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 195 | |
Sharon Yang | 7cb919a | 2019-05-20 20:27:15 | [diff] [blame] | 196 | LOG_TO_ALL = LOG_TO_FILE | LOG_TO_SYSTEM_DEBUG_LOG | LOG_TO_STDERR, |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 197 | |
Sharon Yang | 7cb919a | 2019-05-20 20:27:15 | [diff] [blame] | 198 | // On Windows, use a file next to the exe. |
| 199 | // On POSIX platforms, where it may not even be possible to locate the |
| 200 | // executable on disk, use stderr. |
| 201 | // On Fuchsia, use the Fuchsia logging service. |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 202 | #if BUILDFLAG(IS_FUCHSIA) || BUILDFLAG(IS_NACL) |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 203 | LOG_DEFAULT = LOG_TO_SYSTEM_DEBUG_LOG, |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 204 | #elif BUILDFLAG(IS_WIN) |
Sharon Yang | 7cb919a | 2019-05-20 20:27:15 | [diff] [blame] | 205 | LOG_DEFAULT = LOG_TO_FILE, |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 206 | #elif BUILDFLAG(IS_POSIX) |
Sharon Yang | 7cb919a | 2019-05-20 20:27:15 | [diff] [blame] | 207 | LOG_DEFAULT = LOG_TO_SYSTEM_DEBUG_LOG | LOG_TO_STDERR, |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 208 | #endif |
| 209 | }; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 210 | |
| 211 | // Indicates that the log file should be locked when being written to. |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 212 | // Unless there is only one single-threaded process that is logging to |
| 213 | // the log file, the file should be locked during writes to make each |
wangxianzhu@chromium.org | 3ee50d1 | 2014-03-05 01:43:27 | [diff] [blame] | 214 | // log output atomic. Other writers will block. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 215 | // |
| 216 | // All processes writing to the log file must have their locking set for it to |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 217 | // work properly. Defaults to LOCK_LOG_FILE. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 218 | enum LogLockingState { LOCK_LOG_FILE, DONT_LOCK_LOG_FILE }; |
| 219 | |
| 220 | // On startup, should we delete or append to an existing log file (if any)? |
| 221 | // Defaults to APPEND_TO_OLD_LOG_FILE. |
| 222 | enum OldFileDeletionState { DELETE_OLD_LOG_FILE, APPEND_TO_OLD_LOG_FILE }; |
| 223 | |
Georg Neis | ffe34f65 | 2021-12-27 21:42:36 | [diff] [blame] | 224 | #if BUILDFLAG(IS_CHROMEOS) |
Yuta Hijikata | 1fc8f634 | 2020-09-01 03:25:56 | [diff] [blame] | 225 | // Defines the log message prefix format to use. |
| 226 | // LOG_FORMAT_SYSLOG indicates syslog-like message prefixes. |
| 227 | // LOG_FORMAT_CHROME indicates the normal Chrome format. |
Yuta Hijikata | 9b7279a | 2020-08-26 16:10:54 | [diff] [blame] | 228 | enum class BASE_EXPORT LogFormat { LOG_FORMAT_CHROME, LOG_FORMAT_SYSLOG }; |
| 229 | #endif |
| 230 | |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 231 | struct BASE_EXPORT LoggingSettings { |
Sharon Yang | 7cb919a | 2019-05-20 20:27:15 | [diff] [blame] | 232 | // Equivalent to logging destination enum, but allows for multiple |
| 233 | // destinations. |
Wez | 7e12562 | 2019-05-29 22:11:28 | [diff] [blame] | 234 | uint32_t logging_dest = LOG_DEFAULT; |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 235 | |
Robbie McElrath | 8bf4984 | 2019-08-20 22:22:53 | [diff] [blame] | 236 | // The four settings below have an effect only when LOG_TO_FILE is |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 237 | // set in |logging_dest|. |
Robbie McElrath | 8bf4984 | 2019-08-20 22:22:53 | [diff] [blame] | 238 | const PathChar* log_file_path = nullptr; |
Wez | 7e12562 | 2019-05-29 22:11:28 | [diff] [blame] | 239 | LogLockingState lock_log = LOCK_LOG_FILE; |
| 240 | OldFileDeletionState delete_old = APPEND_TO_OLD_LOG_FILE; |
Georg Neis | ffe34f65 | 2021-12-27 21:42:36 | [diff] [blame] | 241 | #if BUILDFLAG(IS_CHROMEOS) |
Robbie McElrath | 8bf4984 | 2019-08-20 22:22:53 | [diff] [blame] | 242 | // Contains an optional file that logs should be written to. If present, |
| 243 | // |log_file_path| will be ignored, and the logging system will take ownership |
| 244 | // of the FILE. If there's an error writing to this file, no fallback paths |
| 245 | // will be opened. |
| 246 | FILE* log_file = nullptr; |
Yuta Hijikata | 1fc8f634 | 2020-09-01 03:25:56 | [diff] [blame] | 247 | // ChromeOS uses the syslog log format by default. |
| 248 | LogFormat log_format = LogFormat::LOG_FORMAT_SYSLOG; |
Robbie McElrath | 8bf4984 | 2019-08-20 22:22:53 | [diff] [blame] | 249 | #endif |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 250 | }; |
derat@chromium.org | ff3d0c3 | 2010-08-23 19:57:46 | [diff] [blame] | 251 | |
| 252 | // Define different names for the BaseInitLoggingImpl() function depending on |
| 253 | // whether NDEBUG is defined or not so that we'll fail to link if someone tries |
| 254 | // to compile logging.cc with NDEBUG but includes logging.h without defining it, |
| 255 | // or vice versa. |
wez | a245bd07 | 2017-06-18 23:26:34 | [diff] [blame] | 256 | #if defined(NDEBUG) |
derat@chromium.org | ff3d0c3 | 2010-08-23 19:57:46 | [diff] [blame] | 257 | #define BaseInitLoggingImpl BaseInitLoggingImpl_built_with_NDEBUG |
| 258 | #else |
| 259 | #define BaseInitLoggingImpl BaseInitLoggingImpl_built_without_NDEBUG |
| 260 | #endif |
| 261 | |
| 262 | // Implementation of the InitLogging() method declared below. We use a |
| 263 | // more-specific name so we can #define it above without affecting other code |
| 264 | // that has named stuff "InitLogging". |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 265 | BASE_EXPORT bool BaseInitLoggingImpl(const LoggingSettings& settings); |
derat@chromium.org | ff3d0c3 | 2010-08-23 19:57:46 | [diff] [blame] | 266 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 267 | // Sets the log file name and other global logging state. Calling this function |
| 268 | // is recommended, and is normally done at the beginning of application init. |
| 269 | // If you don't call it, all the flags will be initialized to their default |
| 270 | // values, and there is a race condition that may leak a critical section |
| 271 | // object if two threads try to do the first log at the same time. |
| 272 | // See the definition of the enums above for descriptions and default values. |
| 273 | // |
| 274 | // The default log file is initialized to "debug.log" in the application |
| 275 | // directory. You probably don't want this, especially since the program |
| 276 | // directory may not be writable on an enduser's system. |
stevenjb@chromium.org | 064aa16 | 2011-12-03 00:30:08 | [diff] [blame] | 277 | // |
| 278 | // This function may be called a second time to re-direct logging (e.g after |
| 279 | // loging in to a user partition), however it should never be called more than |
| 280 | // twice. |
akalin@chromium.org | 5e3f7c2 | 2013-06-21 21:15:33 | [diff] [blame] | 281 | inline bool InitLogging(const LoggingSettings& settings) { |
| 282 | return BaseInitLoggingImpl(settings); |
derat@chromium.org | ff3d0c3 | 2010-08-23 19:57:46 | [diff] [blame] | 283 | } |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 284 | |
| 285 | // Sets the log level. Anything at or above this level will be written to the |
| 286 | // log file/displayed to the user (if applicable). Anything below this level |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 287 | // will be silently ignored. The log level defaults to 0 (everything is logged |
| 288 | // up to level INFO) if this function is not called. |
| 289 | // Note that log messages for VLOG(x) are logged at level -x, so setting |
Fergal Daly | caf92ba | 2022-05-17 20:11:52 | [diff] [blame] | 290 | // the min log level to negative values enables verbose logging and conversely, |
| 291 | // setting the VLOG default level will set this min level to a negative number, |
| 292 | // effectively enabling all levels of logging. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 293 | BASE_EXPORT void SetMinLogLevel(int level); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 294 | |
ericroman@google.com | 8a2986ca | 2009-04-10 19:13:42 | [diff] [blame] | 295 | // Gets the current log level. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 296 | BASE_EXPORT int GetMinLogLevel(); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 297 | |
skobes | c78c0ad7 | 2015-12-07 20:21:23 | [diff] [blame] | 298 | // Used by LOG_IS_ON to lazy-evaluate stream arguments. |
| 299 | BASE_EXPORT bool ShouldCreateLogMessage(int severity); |
| 300 | |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 301 | // Gets the VLOG default verbosity level. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 302 | BASE_EXPORT int GetVlogVerbosity(); |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 303 | |
akalin@chromium.org | 2f4e9a6 | 2010-09-29 21:25:14 | [diff] [blame] | 304 | // Note that |N| is the size *with* the null terminator. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 305 | BASE_EXPORT int GetVlogLevelHelper(const char* file_start, size_t N); |
akalin@chromium.org | 2f4e9a6 | 2010-09-29 21:25:14 | [diff] [blame] | 306 | |
tnagel | 270da92 | 2017-05-24 12:10:44 | [diff] [blame] | 307 | // Gets the current vlog level for the given file (usually taken from __FILE__). |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 308 | template <size_t N> |
| 309 | int GetVlogLevel(const char (&file)[N]) { |
| 310 | return GetVlogLevelHelper(file, N); |
| 311 | } |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 312 | |
| 313 | // Sets the common items you want to be prepended to each log message. |
| 314 | // process and thread IDs default to off, the timestamp defaults to on. |
| 315 | // If this function is not called, logging defaults to writing the timestamp |
| 316 | // only. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 317 | BASE_EXPORT void SetLogItems(bool enable_process_id, bool enable_thread_id, |
| 318 | bool enable_timestamp, bool enable_tickcount); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 319 | |
James Cook | a0536c3 | 2018-08-01 20:13:31 | [diff] [blame] | 320 | // Sets an optional prefix to add to each log message. |prefix| is not copied |
| 321 | // and should be a raw string constant. |prefix| must only contain ASCII letters |
| 322 | // to avoid confusion with PIDs and timestamps. Pass null to remove the prefix. |
| 323 | // Logging defaults to no prefix. |
| 324 | BASE_EXPORT void SetLogPrefix(const char* prefix); |
| 325 | |
cmasone@google.com | 81e0a85 | 2010-08-17 00:38:12 | [diff] [blame] | 326 | // Sets whether or not you'd like to see fatal debug messages popped up in |
| 327 | // a dialog box or not. |
| 328 | // Dialogs are not shown by default. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 329 | BASE_EXPORT void SetShowErrorDialogs(bool enable_dialogs); |
cmasone@google.com | 81e0a85 | 2010-08-17 00:38:12 | [diff] [blame] | 330 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 331 | // Sets the Log Assert Handler that will be used to notify of check failures. |
alex-ac | cc1bde6 | 2017-04-19 08:33:55 | [diff] [blame] | 332 | // Resets Log Assert Handler on object destruction. |
huanr@chromium.org | fb62a53 | 2009-02-12 01:19:05 | [diff] [blame] | 333 | // The default handler shows a dialog box and then terminate the process, |
| 334 | // however clients can use this function to override with their own handling |
| 335 | // (e.g. a silent one for Unit Tests) |
alex-ac | cc1bde6 | 2017-04-19 08:33:55 | [diff] [blame] | 336 | using LogAssertHandlerFunction = |
kylechar | 83fb51e5 | 2019-03-14 15:30:43 | [diff] [blame] | 337 | base::RepeatingCallback<void(const char* file, |
| 338 | int line, |
| 339 | const base::StringPiece message, |
| 340 | const base::StringPiece stack_trace)>; |
alex-ac | cc1bde6 | 2017-04-19 08:33:55 | [diff] [blame] | 341 | |
| 342 | class BASE_EXPORT ScopedLogAssertHandler { |
| 343 | public: |
| 344 | explicit ScopedLogAssertHandler(LogAssertHandlerFunction handler); |
David Bienvenu | b4b441e | 2020-09-23 05:49:57 | [diff] [blame] | 345 | ScopedLogAssertHandler(const ScopedLogAssertHandler&) = delete; |
| 346 | ScopedLogAssertHandler& operator=(const ScopedLogAssertHandler&) = delete; |
alex-ac | cc1bde6 | 2017-04-19 08:33:55 | [diff] [blame] | 347 | ~ScopedLogAssertHandler(); |
alex-ac | cc1bde6 | 2017-04-19 08:33:55 | [diff] [blame] | 348 | }; |
hansl@google.com | 64e5cc0 | 2010-11-03 19:20:27 | [diff] [blame] | 349 | |
siggi@chromium.org | 2b07b841 | 2009-11-25 15:26:34 | [diff] [blame] | 350 | // Sets the Log Message Handler that gets passed every log message before |
| 351 | // it's sent to other log destinations (if any). |
| 352 | // Returns true to signal that it handled the message and the message |
| 353 | // should not be sent to other log destinations. |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 354 | typedef bool (*LogMessageHandlerFunction)(int severity, |
| 355 | const char* file, int line, size_t message_start, const std::string& str); |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 356 | BASE_EXPORT void SetLogMessageHandler(LogMessageHandlerFunction handler); |
| 357 | BASE_EXPORT LogMessageHandlerFunction GetLogMessageHandler(); |
siggi@chromium.org | 2b07b841 | 2009-11-25 15:26:34 | [diff] [blame] | 358 | |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 359 | using LogSeverity = int; |
Lei Zhang | 4d9e1857 | 2021-04-30 08:57:06 | [diff] [blame] | 360 | constexpr LogSeverity LOGGING_VERBOSE = -1; // This is level 1 verbosity |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 361 | // Note: the log severities are used to index into the array of names, |
| 362 | // see log_severity_names. |
Lei Zhang | 4d9e1857 | 2021-04-30 08:57:06 | [diff] [blame] | 363 | constexpr LogSeverity LOGGING_INFO = 0; |
| 364 | constexpr LogSeverity LOGGING_WARNING = 1; |
| 365 | constexpr LogSeverity LOGGING_ERROR = 2; |
| 366 | constexpr LogSeverity LOGGING_FATAL = 3; |
| 367 | constexpr LogSeverity LOGGING_NUM_SEVERITIES = 4; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 368 | |
danakj | f8e9c30 | 2021-01-27 21:37:23 | [diff] [blame] | 369 | // LOGGING_DFATAL is LOGGING_FATAL in DCHECK-enabled builds, ERROR in normal |
| 370 | // mode. |
| 371 | #if DCHECK_IS_ON() |
Lei Zhang | 4d9e1857 | 2021-04-30 08:57:06 | [diff] [blame] | 372 | constexpr LogSeverity LOGGING_DFATAL = LOGGING_FATAL; |
danakj | f8e9c30 | 2021-01-27 21:37:23 | [diff] [blame] | 373 | #else |
Lei Zhang | 4d9e1857 | 2021-04-30 08:57:06 | [diff] [blame] | 374 | constexpr LogSeverity LOGGING_DFATAL = LOGGING_ERROR; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 375 | #endif |
| 376 | |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 377 | // This block duplicates the above entries to facilitate incremental conversion |
| 378 | // from LOG_FOO to LOGGING_FOO. |
| 379 | // TODO(thestig): Convert existing users to LOGGING_FOO and remove this block. |
Lei Zhang | 4d9e1857 | 2021-04-30 08:57:06 | [diff] [blame] | 380 | constexpr LogSeverity LOG_VERBOSE = LOGGING_VERBOSE; |
| 381 | constexpr LogSeverity LOG_INFO = LOGGING_INFO; |
| 382 | constexpr LogSeverity LOG_WARNING = LOGGING_WARNING; |
| 383 | constexpr LogSeverity LOG_ERROR = LOGGING_ERROR; |
| 384 | constexpr LogSeverity LOG_FATAL = LOGGING_FATAL; |
| 385 | constexpr LogSeverity LOG_DFATAL = LOGGING_DFATAL; |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 386 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 387 | // A few definitions of macros that don't generate much code. These are used |
| 388 | // by LOG() and LOG_IF, etc. Since these are used all over our code, it's |
| 389 | // better to have compact code for these operations. |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 390 | #define COMPACT_GOOGLE_LOG_EX_INFO(ClassName, ...) \ |
| 391 | ::logging::ClassName(__FILE__, __LINE__, ::logging::LOGGING_INFO, \ |
tsniatowski | 612550f | 2016-07-21 18:26:20 | [diff] [blame] | 392 | ##__VA_ARGS__) |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 393 | #define COMPACT_GOOGLE_LOG_EX_WARNING(ClassName, ...) \ |
| 394 | ::logging::ClassName(__FILE__, __LINE__, ::logging::LOGGING_WARNING, \ |
| 395 | ##__VA_ARGS__) |
| 396 | #define COMPACT_GOOGLE_LOG_EX_ERROR(ClassName, ...) \ |
| 397 | ::logging::ClassName(__FILE__, __LINE__, ::logging::LOGGING_ERROR, \ |
| 398 | ##__VA_ARGS__) |
| 399 | #define COMPACT_GOOGLE_LOG_EX_FATAL(ClassName, ...) \ |
| 400 | ::logging::ClassName(__FILE__, __LINE__, ::logging::LOGGING_FATAL, \ |
| 401 | ##__VA_ARGS__) |
| 402 | #define COMPACT_GOOGLE_LOG_EX_DFATAL(ClassName, ...) \ |
| 403 | ::logging::ClassName(__FILE__, __LINE__, ::logging::LOGGING_DFATAL, \ |
| 404 | ##__VA_ARGS__) |
| 405 | #define COMPACT_GOOGLE_LOG_EX_DCHECK(ClassName, ...) \ |
| 406 | ::logging::ClassName(__FILE__, __LINE__, ::logging::LOGGING_DCHECK, \ |
| 407 | ##__VA_ARGS__) |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 408 | |
Wez | 289477f | 2017-08-24 20:51:30 | [diff] [blame] | 409 | #define COMPACT_GOOGLE_LOG_INFO COMPACT_GOOGLE_LOG_EX_INFO(LogMessage) |
| 410 | #define COMPACT_GOOGLE_LOG_WARNING COMPACT_GOOGLE_LOG_EX_WARNING(LogMessage) |
| 411 | #define COMPACT_GOOGLE_LOG_ERROR COMPACT_GOOGLE_LOG_EX_ERROR(LogMessage) |
| 412 | #define COMPACT_GOOGLE_LOG_FATAL COMPACT_GOOGLE_LOG_EX_FATAL(LogMessage) |
| 413 | #define COMPACT_GOOGLE_LOG_DFATAL COMPACT_GOOGLE_LOG_EX_DFATAL(LogMessage) |
| 414 | #define COMPACT_GOOGLE_LOG_DCHECK COMPACT_GOOGLE_LOG_EX_DCHECK(LogMessage) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 415 | |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 416 | #if BUILDFLAG(IS_WIN) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 417 | // wingdi.h defines ERROR to be 0. When we call LOG(ERROR), it gets |
| 418 | // substituted with 0, and it expands to COMPACT_GOOGLE_LOG_0. To allow us |
| 419 | // to keep using this syntax, we define this macro to do the same thing |
| 420 | // as COMPACT_GOOGLE_LOG_ERROR, and also define ERROR the same way that |
| 421 | // the Windows SDK does for consistency. |
| 422 | #define ERROR 0 |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 423 | #define COMPACT_GOOGLE_LOG_EX_0(ClassName, ...) \ |
| 424 | COMPACT_GOOGLE_LOG_EX_ERROR(ClassName , ##__VA_ARGS__) |
| 425 | #define COMPACT_GOOGLE_LOG_0 COMPACT_GOOGLE_LOG_ERROR |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 426 | // Needed for LOG_IS_ON(ERROR). |
Lei Zhang | 4d9e1857 | 2021-04-30 08:57:06 | [diff] [blame] | 427 | constexpr LogSeverity LOGGING_0 = LOGGING_ERROR; |
joth@chromium.org | 8d12730 | 2013-01-10 02:41:57 | [diff] [blame] | 428 | #endif |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 429 | |
viettrungluu@chromium.org | f2c0549 | 2014-06-17 12:04:23 | [diff] [blame] | 430 | // As special cases, we can assume that LOG_IS_ON(FATAL) always holds. Also, |
| 431 | // LOG_IS_ON(DFATAL) always holds in debug mode. In particular, CHECK()s will |
| 432 | // always fire if they fail. |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 433 | #define LOG_IS_ON(severity) \ |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 434 | (::logging::ShouldCreateLogMessage(::logging::LOGGING_##severity)) |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 435 | |
Xiyuan Xia | 28d809d | 2023-11-02 22:00:42 | [diff] [blame] | 436 | // Define a default ENABLED_VLOG_LEVEL if it is not defined. The macros allows |
| 437 | // code to enable vlog level at build time without the need of --vmodule |
| 438 | // switch at runtime. This is intended for VLOGs that needed from production |
| 439 | // code without the cpu overhead to match vmodule patterns on every VLOG |
| 440 | // instance. |
Xiyuan Xia | a0559da | 2022-05-05 19:42:45 | [diff] [blame] | 441 | #if !defined(ENABLED_VLOG_LEVEL) |
Xiyuan Xia | 28d809d | 2023-11-02 22:00:42 | [diff] [blame] | 442 | #define ENABLED_VLOG_LEVEL -1 |
Xiyuan Xia | a0559da | 2022-05-05 19:42:45 | [diff] [blame] | 443 | #endif // !defined(ENABLED_VLOG_LEVEL) |
| 444 | |
Ken MacKay | 70e886700 | 2019-01-16 00:22:15 | [diff] [blame] | 445 | // We don't do any caching tricks with VLOG_IS_ON() like the |
| 446 | // google-glog version since it increases binary size. This means |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 447 | // that using the v-logging functions in conjunction with --vmodule |
| 448 | // may be slow. |
Xiyuan Xia | 28d809d | 2023-11-02 22:00:42 | [diff] [blame] | 449 | #define VLOG_IS_ON(verboselevel) \ |
| 450 | ((verboselevel) <= (ENABLED_VLOG_LEVEL) || \ |
| 451 | (verboselevel) <= ::logging::GetVlogLevel(__FILE__)) |
Xiyuan Xia | a0559da | 2022-05-05 19:42:45 | [diff] [blame] | 452 | |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 453 | // Helper macro which avoids evaluating the arguments to a stream if |
chcunningham | f6a9608 | 2015-02-07 01:58:37 | [diff] [blame] | 454 | // the condition doesn't hold. Condition is evaluated once and only once. |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 455 | #define LAZY_STREAM(stream, condition) \ |
| 456 | !(condition) ? (void) 0 : ::logging::LogMessageVoidify() & (stream) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 457 | |
| 458 | // We use the preprocessor's merging operator, "##", so that, e.g., |
| 459 | // LOG(INFO) becomes the token COMPACT_GOOGLE_LOG_INFO. There's some funny |
| 460 | // subtle difference between ostream member streaming functions (e.g., |
| 461 | // ostream::operator<<(int) and ostream non-member streaming functions |
| 462 | // (e.g., ::operator<<(ostream&, string&): it turns out that it's |
| 463 | // impossible to stream something like a string directly to an unnamed |
| 464 | // ostream. We employ a neat hack by calling the stream() member |
| 465 | // function of LogMessage which seems to avoid the problem. |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 466 | #define LOG_STREAM(severity) COMPACT_GOOGLE_LOG_ ## severity.stream() |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 467 | |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 468 | #define LOG(severity) LAZY_STREAM(LOG_STREAM(severity), LOG_IS_ON(severity)) |
| 469 | #define LOG_IF(severity, condition) \ |
| 470 | LAZY_STREAM(LOG_STREAM(severity), LOG_IS_ON(severity) && (condition)) |
| 471 | |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 472 | // The VLOG macros log with negative verbosities. |
| 473 | #define VLOG_STREAM(verbose_level) \ |
Artem Bolgar | 30e5d69 | 2020-12-12 01:15:58 | [diff] [blame] | 474 | ::logging::LogMessage(__FILE__, __LINE__, -(verbose_level)).stream() |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 475 | |
| 476 | #define VLOG(verbose_level) \ |
| 477 | LAZY_STREAM(VLOG_STREAM(verbose_level), VLOG_IS_ON(verbose_level)) |
| 478 | |
| 479 | #define VLOG_IF(verbose_level, condition) \ |
| 480 | LAZY_STREAM(VLOG_STREAM(verbose_level), \ |
| 481 | VLOG_IS_ON(verbose_level) && (condition)) |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 482 | |
Peter Boström | 3ed27e8 | 2022-11-17 01:13:23 | [diff] [blame] | 483 | #if BUILDFLAG(IS_WIN) |
sail@chromium.org | fb879b1a | 2011-03-06 18:16:31 | [diff] [blame] | 484 | #define VPLOG_STREAM(verbose_level) \ |
Artem Bolgar | 30e5d69 | 2020-12-12 01:15:58 | [diff] [blame] | 485 | ::logging::Win32ErrorLogMessage(__FILE__, __LINE__, -(verbose_level), \ |
sail@chromium.org | fb879b1a | 2011-03-06 18:16:31 | [diff] [blame] | 486 | ::logging::GetLastSystemErrorCode()).stream() |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 487 | #elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA) |
sail@chromium.org | fb879b1a | 2011-03-06 18:16:31 | [diff] [blame] | 488 | #define VPLOG_STREAM(verbose_level) \ |
Artem Bolgar | 30e5d69 | 2020-12-12 01:15:58 | [diff] [blame] | 489 | ::logging::ErrnoLogMessage(__FILE__, __LINE__, -(verbose_level), \ |
sail@chromium.org | fb879b1a | 2011-03-06 18:16:31 | [diff] [blame] | 490 | ::logging::GetLastSystemErrorCode()).stream() |
| 491 | #endif |
| 492 | |
| 493 | #define VPLOG(verbose_level) \ |
| 494 | LAZY_STREAM(VPLOG_STREAM(verbose_level), VLOG_IS_ON(verbose_level)) |
| 495 | |
| 496 | #define VPLOG_IF(verbose_level, condition) \ |
| 497 | LAZY_STREAM(VPLOG_STREAM(verbose_level), \ |
| 498 | VLOG_IS_ON(verbose_level) && (condition)) |
| 499 | |
akalin@chromium.org | 99b7c57f | 2010-09-29 19:26:36 | [diff] [blame] | 500 | // TODO(akalin): Add more VLOG variants, e.g. VPLOG. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 501 | |
kmarshall | fe2f09f8 | 2017-04-20 21:05:26 | [diff] [blame] | 502 | #define LOG_ASSERT(condition) \ |
| 503 | LOG_IF(FATAL, !(ANALYZER_ASSUME_TRUE(condition))) \ |
| 504 | << "Assert failed: " #condition ". " |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 505 | |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 506 | #if BUILDFLAG(IS_WIN) |
vitalybuka@chromium.org | c914d8a | 2014-04-23 01:11:01 | [diff] [blame] | 507 | #define PLOG_STREAM(severity) \ |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 508 | COMPACT_GOOGLE_LOG_EX_ ## severity(Win32ErrorLogMessage, \ |
| 509 | ::logging::GetLastSystemErrorCode()).stream() |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 510 | #elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA) |
vitalybuka@chromium.org | c914d8a | 2014-04-23 01:11:01 | [diff] [blame] | 511 | #define PLOG_STREAM(severity) \ |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 512 | COMPACT_GOOGLE_LOG_EX_ ## severity(ErrnoLogMessage, \ |
| 513 | ::logging::GetLastSystemErrorCode()).stream() |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 514 | #endif |
| 515 | |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 516 | #define PLOG(severity) \ |
| 517 | LAZY_STREAM(PLOG_STREAM(severity), LOG_IS_ON(severity)) |
| 518 | |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 519 | #define PLOG_IF(severity, condition) \ |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 520 | LAZY_STREAM(PLOG_STREAM(severity), LOG_IS_ON(severity) && (condition)) |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 521 | |
scottmg | 3c957a5 | 2016-12-10 20:57:59 | [diff] [blame] | 522 | BASE_EXPORT extern std::ostream* g_swallow_stream; |
| 523 | |
| 524 | // Note that g_swallow_stream is used instead of an arbitrary LOG() stream to |
| 525 | // avoid the creation of an object with a non-trivial destructor (LogMessage). |
| 526 | // On MSVC x86 (checked on 2015 Update 3), this causes a few additional |
| 527 | // pointless instructions to be emitted even at full optimization level, even |
| 528 | // though the : arm of the ternary operator is clearly never executed. Using a |
| 529 | // simpler object to be &'d with Voidify() avoids these extra instructions. |
| 530 | // Using a simpler POD object with a templated operator<< also works to avoid |
| 531 | // these instructions. However, this causes warnings on statically defined |
| 532 | // implementations of operator<<(std::ostream, ...) in some .cc files, because |
| 533 | // they become defined-but-unreferenced functions. A reinterpret_cast of 0 to an |
| 534 | // ostream* also is not suitable, because some compilers warn of undefined |
| 535 | // behavior. |
| 536 | #define EAT_STREAM_PARAMETERS \ |
| 537 | true ? (void)0 \ |
| 538 | : ::logging::LogMessageVoidify() & (*::logging::g_swallow_stream) |
akalin@chromium.org | ddb9b33 | 2011-12-02 07:31:09 | [diff] [blame] | 539 | |
akalin@chromium.org | d15e56c | 2010-09-30 21:12:33 | [diff] [blame] | 540 | // Definitions for DLOG et al. |
| 541 | |
gab | 190f754 | 2016-08-01 20:03:41 | [diff] [blame] | 542 | #if DCHECK_IS_ON() |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 543 | |
akalin@chromium.org | 5e98780 | 2010-11-01 19:49:22 | [diff] [blame] | 544 | #define DLOG_IS_ON(severity) LOG_IS_ON(severity) |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 545 | #define DLOG_IF(severity, condition) LOG_IF(severity, condition) |
| 546 | #define DLOG_ASSERT(condition) LOG_ASSERT(condition) |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 547 | #define DPLOG_IF(severity, condition) PLOG_IF(severity, condition) |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 548 | #define DVLOG_IF(verboselevel, condition) VLOG_IF(verboselevel, condition) |
sail@chromium.org | fb879b1a | 2011-03-06 18:16:31 | [diff] [blame] | 549 | #define DVPLOG_IF(verboselevel, condition) VPLOG_IF(verboselevel, condition) |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 550 | |
gab | 190f754 | 2016-08-01 20:03:41 | [diff] [blame] | 551 | #else // DCHECK_IS_ON() |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 552 | |
gab | 190f754 | 2016-08-01 20:03:41 | [diff] [blame] | 553 | // If !DCHECK_IS_ON(), we want to avoid emitting any references to |condition| |
| 554 | // (which may reference a variable defined only if DCHECK_IS_ON()). |
| 555 | // Contrast this with DCHECK et al., which has different behavior. |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 556 | |
akalin@chromium.org | 5e98780 | 2010-11-01 19:49:22 | [diff] [blame] | 557 | #define DLOG_IS_ON(severity) false |
akalin@chromium.org | ddb9b33 | 2011-12-02 07:31:09 | [diff] [blame] | 558 | #define DLOG_IF(severity, condition) EAT_STREAM_PARAMETERS |
| 559 | #define DLOG_ASSERT(condition) EAT_STREAM_PARAMETERS |
| 560 | #define DPLOG_IF(severity, condition) EAT_STREAM_PARAMETERS |
| 561 | #define DVLOG_IF(verboselevel, condition) EAT_STREAM_PARAMETERS |
| 562 | #define DVPLOG_IF(verboselevel, condition) EAT_STREAM_PARAMETERS |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 563 | |
gab | 190f754 | 2016-08-01 20:03:41 | [diff] [blame] | 564 | #endif // DCHECK_IS_ON() |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 565 | |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 566 | #define DLOG(severity) \ |
| 567 | LAZY_STREAM(LOG_STREAM(severity), DLOG_IS_ON(severity)) |
| 568 | |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 569 | #define DPLOG(severity) \ |
| 570 | LAZY_STREAM(PLOG_STREAM(severity), DLOG_IS_ON(severity)) |
| 571 | |
Ken MacKay | 70e886700 | 2019-01-16 00:22:15 | [diff] [blame] | 572 | #define DVLOG(verboselevel) DVLOG_IF(verboselevel, true) |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 573 | |
Ken MacKay | 70e886700 | 2019-01-16 00:22:15 | [diff] [blame] | 574 | #define DVPLOG(verboselevel) DVPLOG_IF(verboselevel, true) |
sail@chromium.org | fb879b1a | 2011-03-06 18:16:31 | [diff] [blame] | 575 | |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 576 | // Definitions for DCHECK et al. |
akalin@chromium.org | d926c20 | 2010-10-01 02:58:24 | [diff] [blame] | 577 | |
Wez | 02cedeba | 2022-07-26 12:48:38 | [diff] [blame] | 578 | #if BUILDFLAG(DCHECK_IS_CONFIGURABLE) |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 579 | BASE_EXPORT extern LogSeverity LOGGING_DCHECK; |
Wez | 289477f | 2017-08-24 20:51:30 | [diff] [blame] | 580 | #else |
Lei Zhang | 4d9e1857 | 2021-04-30 08:57:06 | [diff] [blame] | 581 | constexpr LogSeverity LOGGING_DCHECK = LOGGING_FATAL; |
Wez | 02cedeba | 2022-07-26 12:48:38 | [diff] [blame] | 582 | #endif // BUILDFLAG(DCHECK_IS_CONFIGURABLE) |
akalin@chromium.org | 521b0c4 | 2010-10-01 23:02:36 | [diff] [blame] | 583 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 584 | // Redefine the standard assert to use our nice log files |
| 585 | #undef assert |
| 586 | #define assert(x) DLOG_ASSERT(x) |
| 587 | |
| 588 | // This class more or less represents a particular log message. You |
| 589 | // create an instance of LogMessage and then stream stuff to it. |
| 590 | // When you finish streaming to it, ~LogMessage is called and the |
| 591 | // full message gets streamed to the appropriate destination. |
| 592 | // |
| 593 | // You shouldn't actually use LogMessage's constructor to log things, |
| 594 | // though. You should use the LOG() macro (and variants thereof) |
| 595 | // above. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 596 | class BASE_EXPORT LogMessage { |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 597 | public: |
viettrungluu@chromium.org | bf8ddf13a | 2014-06-18 15:02:22 | [diff] [blame] | 598 | // Used for LOG(severity). |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 599 | LogMessage(const char* file, int line, LogSeverity severity); |
| 600 | |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 601 | // Used for CHECK(). Implied severity = LOGGING_FATAL. |
tnagel | 4a045d3f | 2015-07-12 14:19:28 | [diff] [blame] | 602 | LogMessage(const char* file, int line, const char* condition); |
David Bienvenu | b4b441e | 2020-09-23 05:49:57 | [diff] [blame] | 603 | LogMessage(const LogMessage&) = delete; |
| 604 | LogMessage& operator=(const LogMessage&) = delete; |
Hans Wennborg | 12aea3e | 2020-04-14 15:29:00 | [diff] [blame] | 605 | virtual ~LogMessage(); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 606 | |
| 607 | std::ostream& stream() { return stream_; } |
| 608 | |
Peter Boström | 6c0094d1 | 2022-07-07 16:03:39 | [diff] [blame] | 609 | LogSeverity severity() const { return severity_; } |
| 610 | std::string str() const { return stream_.str(); } |
Peter Boström | 1d3b6d8 | 2022-07-11 17:59:49 | [diff] [blame] | 611 | const char* file() const { return file_; } |
| 612 | int line() const { return line_; } |
Peter Boström | 6c0094d1 | 2022-07-07 16:03:39 | [diff] [blame] | 613 | |
Peter Boström | 3748296 | 2022-07-14 16:09:54 | [diff] [blame] | 614 | // Gets file:line: message in a format suitable for crash reporting. |
| 615 | std::string BuildCrashString() const; |
pastarmovj | 89f7ee1 | 2016-09-20 14:58:13 | [diff] [blame] | 616 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 617 | private: |
| 618 | void Init(const char* file, int line); |
| 619 | |
David Dorwin | 11e7c2c1 | 2021-04-10 17:01:09 | [diff] [blame] | 620 | const LogSeverity severity_; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 621 | std::ostringstream stream_; |
maruel@google.com | c8887392 | 2008-07-30 13:02:03 | [diff] [blame] | 622 | size_t message_start_; // Offset of the start of the message (past prefix |
| 623 | // info). |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 624 | // The file and line information passed in to the constructor. |
David Dorwin | 11e7c2c1 | 2021-04-10 17:01:09 | [diff] [blame] | 625 | const char* const file_; |
siggi@chromium.org | 162ac0f | 2010-11-04 15:50:49 | [diff] [blame] | 626 | const int line_; |
| 627 | |
tommi@google.com | 3f85caa | 2009-04-14 16:52:11 | [diff] [blame] | 628 | // This is useful since the LogMessage class uses a lot of Win32 calls |
| 629 | // that will lose the value of GLE and the code that called the log function |
| 630 | // will have lost the thread error value when the log call returns. |
Joshua Peraza | b427af26 | 2020-04-13 21:54:42 | [diff] [blame] | 631 | base::ScopedClearLastError last_error_; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 632 | |
Georg Neis | ffe34f65 | 2021-12-27 21:42:36 | [diff] [blame] | 633 | #if BUILDFLAG(IS_CHROMEOS) |
Yuta Hijikata | 9b7279a | 2020-08-26 16:10:54 | [diff] [blame] | 634 | void InitWithSyslogPrefix(base::StringPiece filename, |
| 635 | int line, |
| 636 | uint64_t tick_count, |
| 637 | const char* log_severity_name_c_str, |
| 638 | const char* log_prefix, |
| 639 | bool enable_process_id, |
| 640 | bool enable_thread_id, |
| 641 | bool enable_timestamp, |
| 642 | bool enable_tickcount); |
| 643 | #endif |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 644 | }; |
| 645 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 646 | // This class is used to explicitly ignore values in the conditional |
| 647 | // logging macros. This avoids compiler warnings like "value computed |
| 648 | // is not used" and "statement has no effect". |
rvargas@google.com | 23bb71f | 2011-04-21 22:22:10 | [diff] [blame] | 649 | class LogMessageVoidify { |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 650 | public: |
Chris Watkins | 091d629 | 2017-12-13 04:25:58 | [diff] [blame] | 651 | LogMessageVoidify() = default; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 652 | // This has to be an operator with a precedence lower than << but |
| 653 | // higher than ?: |
| 654 | void operator&(std::ostream&) { } |
| 655 | }; |
| 656 | |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 657 | #if BUILDFLAG(IS_WIN) |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 658 | typedef unsigned long SystemErrorCode; |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 659 | #elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA) |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 660 | typedef int SystemErrorCode; |
| 661 | #endif |
| 662 | |
| 663 | // Alias for ::GetLastError() on Windows and errno on POSIX. Avoids having to |
| 664 | // pull in windows.h just for GetLastError() and DWORD. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 665 | BASE_EXPORT SystemErrorCode GetLastSystemErrorCode(); |
vitalybuka@chromium.org | c914d8a | 2014-04-23 01:11:01 | [diff] [blame] | 666 | BASE_EXPORT std::string SystemErrorCodeToString(SystemErrorCode error_code); |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 667 | |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 668 | #if BUILDFLAG(IS_WIN) |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 669 | // Appends a formatted system message of the GetLastError() type. |
Hans Wennborg | 12aea3e | 2020-04-14 15:29:00 | [diff] [blame] | 670 | class BASE_EXPORT Win32ErrorLogMessage : public LogMessage { |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 671 | public: |
| 672 | Win32ErrorLogMessage(const char* file, |
| 673 | int line, |
| 674 | LogSeverity severity, |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 675 | SystemErrorCode err); |
David Bienvenu | b4b441e | 2020-09-23 05:49:57 | [diff] [blame] | 676 | Win32ErrorLogMessage(const Win32ErrorLogMessage&) = delete; |
| 677 | Win32ErrorLogMessage& operator=(const Win32ErrorLogMessage&) = delete; |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 678 | // Appends the error message before destructing the encapsulated class. |
Hans Wennborg | 12aea3e | 2020-04-14 15:29:00 | [diff] [blame] | 679 | ~Win32ErrorLogMessage() override; |
erg@google.com | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 680 | |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 681 | private: |
| 682 | SystemErrorCode err_; |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 683 | }; |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 684 | #elif BUILDFLAG(IS_POSIX) || BUILDFLAG(IS_FUCHSIA) |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 685 | // Appends a formatted system message of the errno type |
Hans Wennborg | 12aea3e | 2020-04-14 15:29:00 | [diff] [blame] | 686 | class BASE_EXPORT ErrnoLogMessage : public LogMessage { |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 687 | public: |
| 688 | ErrnoLogMessage(const char* file, |
| 689 | int line, |
| 690 | LogSeverity severity, |
| 691 | SystemErrorCode err); |
David Bienvenu | b4b441e | 2020-09-23 05:49:57 | [diff] [blame] | 692 | ErrnoLogMessage(const ErrnoLogMessage&) = delete; |
| 693 | ErrnoLogMessage& operator=(const ErrnoLogMessage&) = delete; |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 694 | // Appends the error message before destructing the encapsulated class. |
Hans Wennborg | 12aea3e | 2020-04-14 15:29:00 | [diff] [blame] | 695 | ~ErrnoLogMessage() override; |
erg@google.com | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 696 | |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 697 | private: |
| 698 | SystemErrorCode err_; |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 699 | }; |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 700 | #endif // BUILDFLAG(IS_WIN) |
tschmelcher@chromium.org | d8617a6 | 2009-10-09 23:52:20 | [diff] [blame] | 701 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 702 | // Closes the log file explicitly if open. |
| 703 | // NOTE: Since the log file is opened as necessary by the action of logging |
| 704 | // statements, there's no guarantee that it will stay closed |
| 705 | // after this call. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 706 | BASE_EXPORT void CloseLogFile(); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 707 | |
Yuta Hijikata | 000df18f | 2020-11-18 06:55:58 | [diff] [blame] | 708 | #if BUILDFLAG(IS_CHROMEOS_ASH) |
Robbie McElrath | 8bf4984 | 2019-08-20 22:22:53 | [diff] [blame] | 709 | // Returns a new file handle that will write to the same destination as the |
| 710 | // currently open log file. Returns nullptr if logging to a file is disabled, |
| 711 | // or if opening the file failed. This is intended to be used to initialize |
| 712 | // logging in child processes that are unable to open files. |
| 713 | BASE_EXPORT FILE* DuplicateLogFILE(); |
| 714 | #endif |
| 715 | |
willchan@chromium.org | e36ddc8 | 2009-12-08 04:22:50 | [diff] [blame] | 716 | // Async signal safe logging mechanism. |
darin@chromium.org | 0bea725 | 2011-08-05 15:34:00 | [diff] [blame] | 717 | BASE_EXPORT void RawLog(int level, const char* message); |
willchan@chromium.org | e36ddc8 | 2009-12-08 04:22:50 | [diff] [blame] | 718 | |
tsniatowski | 612550f | 2016-07-21 18:26:20 | [diff] [blame] | 719 | #define RAW_LOG(level, message) \ |
Lei Zhang | 93dd4257 | 2020-10-23 18:45:53 | [diff] [blame] | 720 | ::logging::RawLog(::logging::LOGGING_##level, message) |
willchan@chromium.org | e36ddc8 | 2009-12-08 04:22:50 | [diff] [blame] | 721 | |
Xiaohan Wang | 38e4ebb | 2022-01-19 06:57:43 | [diff] [blame] | 722 | #if BUILDFLAG(IS_WIN) |
ananta | 61762fb | 2015-09-18 01:00:09 | [diff] [blame] | 723 | // Returns true if logging to file is enabled. |
| 724 | BASE_EXPORT bool IsLoggingToFileEnabled(); |
| 725 | |
ananta@chromium.org | f01b88a | 2013-02-27 22:04:00 | [diff] [blame] | 726 | // Returns the default log file path. |
Jan Wilken Dörrie | b630aca | 2019-12-04 10:59:11 | [diff] [blame] | 727 | BASE_EXPORT std::wstring GetLogFileFullPath(); |
ananta@chromium.org | f01b88a | 2013-02-27 22:04:00 | [diff] [blame] | 728 | #endif |
| 729 | |
brettw@google.com | 39be424 | 2008-08-07 18:31:40 | [diff] [blame] | 730 | } // namespace logging |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 731 | |
brettw@google.com | 39be424 | 2008-08-07 18:31:40 | [diff] [blame] | 732 | #endif // BASE_LOGGING_H_ |