17e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 27e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#ifndef BASE_LOGGING_H_ 37e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define BASE_LOGGING_H_ 47e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 57e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#include <cassert> 67e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#include <string> 77e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#include <cstring> 87e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#include <sstream> 97e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 107e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#include "quipper/base/macros.h" 117e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#include "quipper/base/basictypes.h" 127e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 137e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 147e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Logging macros designed to mimic those used in chromium_org/base. 157e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 167e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 177e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Instructions 187e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// ------------ 197e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 207e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Make a bunch of macros for logging. The way to log things is to stream 217e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// things to LOG(<a particular severity level>). E.g., 227e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 237e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// LOG(INFO) << "Found " << num_cookies << " cookies"; 247e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 257e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// You can also do conditional logging: 267e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 277e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// LOG_IF(INFO, num_cookies > 10) << "Got lots of cookies"; 287e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 297e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The CHECK(condition) macro is active in both debug and release builds and 307e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// effectively performs a LOG(FATAL) which terminates the process and 317e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// generates a crashdump unless a debugger is attached. 327e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 337e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// There are also "debug mode" logging macros like the ones above: 347e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 357e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DLOG(INFO) << "Found cookies"; 367e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 377e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DLOG_IF(INFO, num_cookies > 10) << "Got lots of cookies"; 387e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 397e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// All "debug mode" logging is compiled away to nothing for non-debug mode 407e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// compiles. LOG_IF and development flags also work well together 417e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// because the code can be compiled away sometimes. 427e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 437e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// We also have 447e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 457e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// LOG_ASSERT(assertion); 467e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DLOG_ASSERT(assertion); 477e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 487e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// which is syntactic sugar for {,D}LOG_IF(FATAL, assert fails) << assertion; 497e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 507e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// There are "verbose level" logging macros. They look like 517e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 527e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// VLOG(1) << "I'm printed when you run the program with --v=1 or more"; 537e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// VLOG(2) << "I'm printed when you run the program with --v=2 or more"; 547e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 557e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// These always log at the INFO log level (when they log at all). 567e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The verbose logging can also be turned on module-by-module. For instance, 577e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// --vmodule=profile=2,icon_loader=1,browser_*=3,*/chromeos/*=4 --v=0 587e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// will cause: 597e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// a. VLOG(2) and lower messages to be printed from profile.{h,cc} 607e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// b. VLOG(1) and lower messages to be printed from icon_loader.{h,cc} 617e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// c. VLOG(3) and lower messages to be printed from files prefixed with 627e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// "browser" 637e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// d. VLOG(4) and lower messages to be printed from files under a 647e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// "chromeos" directory. 657e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// e. VLOG(0) and lower messages to be printed from elsewhere 667e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 677e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The wildcarding functionality shown by (c) supports both '*' (match 687e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 0 or more characters) and '?' (match any single character) 697e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// wildcards. Any pattern containing a forward or backward slash will 707e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// be tested against the whole pathname and not just the module. 717e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// E.g., "*/foo/bar/*=2" would change the logging level for all code 727e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// in source files under a "foo/bar" directory. 737e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 747e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// There's also VLOG_IS_ON(n) "verbose level" condition macro. To be used as 757e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 767e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// if (VLOG_IS_ON(2)) { 777e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// // do some logging preparation and logging 787e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// // that can't be accomplished with just VLOG(2) << ...; 797e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// } 807e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 817e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// There is also a VLOG_IF "verbose level" condition macro for sample 827e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// cases, when some extra computation and preparation for logs is not 837e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// needed. 847e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 857e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// VLOG_IF(1, (size > 1024)) 867e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// << "I'm printed when size is more than 1024 and when you run the " 877e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// "program with --v=1 or more"; 887e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 897e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// We also override the standard 'assert' to use 'DLOG_ASSERT'. 907e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 917e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Lastly, there is: 927e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 937e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// PLOG(ERROR) << "Couldn't do foo"; 947e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DPLOG(ERROR) << "Couldn't do foo"; 957e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// PLOG_IF(ERROR, cond) << "Couldn't do foo"; 967e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DPLOG_IF(ERROR, cond) << "Couldn't do foo"; 977e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// PCHECK(condition) << "Couldn't do foo"; 987e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DPCHECK(condition) << "Couldn't do foo"; 997e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 1007e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// which append the last system error to the message in string form (taken from 1017e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// GetLastError() on Windows and errno on POSIX). 1027e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 1037e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The supported severity levels for macros that allow you to specify one 1047e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// are (in increasing order of severity) INFO, WARNING, ERROR, and FATAL. 1057e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 1067e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Very important: logging a message at the FATAL severity level causes 1077e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// the program to terminate (after the message is logged). 1087e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 1097e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// There is the special severity of DFATAL, which logs FATAL in debug mode, 1107e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// ERROR in normal mode. 1117e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1127e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define BASE_EXPORT 1137e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1147e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshnamespace logging { 1157e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1167e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Sets the log level. Anything at or above this level will be written to the 1177e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// log file/displayed to the user (if applicable). Anything below this level 1187e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// will be silently ignored. The log level defaults to 0 (everything is logged 1197e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// up to level INFO) if this function is not called. 1207e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Note that log messages for VLOG(x) are logged at level -x, so setting 1217e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// the min log level to negative values enables verbose logging. 1227e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT void SetMinLogLevel(int level); 1237e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1247e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Gets the current log level. 1257e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT int GetMinLogLevel(); 1267e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1277e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Gets the VLOG default verbosity level. 1287e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT int GetVlogVerbosity(); 1297e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1307e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshtypedef int LogSeverity; 1317e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_VERBOSE = -1; // This is level 1 verbosity 1327e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Note: the log severities are used to index into the array of names, 1337e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// see log_severity_names. 1347e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_INFO = 0; 1357e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_WARNING = 1; 1367e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_ERROR = 2; 1377e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_FATAL = 3; 1387e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_NUM_SEVERITIES = 4; 1397e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1407e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// A few definitions of macros that don't generate much code. These are used 1417e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// by LOG() and LOG_IF, etc. Since these are used all over our code, it's 1427e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// better to have compact code for these operations. 1437e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_EX_INFO(ClassName, ...) \ 1447e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::ClassName(__FILE__, __LINE__, logging::LOG_INFO , ##__VA_ARGS__) 1457e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_EX_WARNING(ClassName, ...) \ 1467e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::ClassName(__FILE__, __LINE__, logging::LOG_WARNING , ##__VA_ARGS__) 1477e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_EX_ERROR(ClassName, ...) \ 1487e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::ClassName(__FILE__, __LINE__, logging::LOG_ERROR , ##__VA_ARGS__) 1497e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_EX_FATAL(ClassName, ...) \ 1507e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::ClassName(__FILE__, __LINE__, logging::LOG_FATAL , ##__VA_ARGS__) 1517e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_EX_DFATAL(ClassName, ...) \ 1527e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::ClassName(__FILE__, __LINE__, logging::LOG_DFATAL , ##__VA_ARGS__) 1537e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1547e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_INFO \ 1557e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh COMPACT_GOOGLE_LOG_EX_INFO(LogMessage) 1567e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_WARNING \ 1577e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh COMPACT_GOOGLE_LOG_EX_WARNING(LogMessage) 1587e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_ERROR \ 1597e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh COMPACT_GOOGLE_LOG_EX_ERROR(LogMessage) 1607e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_FATAL \ 1617e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh COMPACT_GOOGLE_LOG_EX_FATAL(LogMessage) 1627e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_DFATAL \ 1637e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh COMPACT_GOOGLE_LOG_EX_DFATAL(LogMessage) 1647e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1657e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// As special cases, we can assume that LOG_IS_ON(FATAL) always holds. Also, 1667e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// LOG_IS_ON(DFATAL) always holds in debug mode. In particular, CHECK()s will 1677e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// always fire if they fail. 1687e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define LOG_IS_ON(severity) \ 1697e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh ((::logging::LOG_ ## severity) >= ::logging::GetMinLogLevel()) 1707e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1717e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define VLOG_IS_ON(verboselevel) false 1727e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1737e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Helper macro which avoids evaluating the arguments to a stream if 1747e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// the condition doesn't hold. 1757e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define LAZY_STREAM(stream, condition) \ 17699c536d4a58a78ec7b4fdd988f8be87f705825d5Chih-Hung Hsieh !(condition) ? (void) 0 : ::logging::LogMessageVoidify() & (stream) /* NOLINT */ 1777e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1787e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// We use the preprocessor's merging operator, "##", so that, e.g., 1797e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// LOG(INFO) becomes the token COMPACT_GOOGLE_LOG_INFO. There's some funny 1807e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// subtle difference between ostream member streaming functions (e.g., 1817e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// ostream::operator<<(int) and ostream non-member streaming functions 1827e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// (e.g., ::operator<<(ostream&, string&): it turns out that it's 1837e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// impossible to stream something like a string directly to an unnamed 1847e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// ostream. We employ a neat hack by calling the stream() member 1857e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// function of LogMessage which seems to avoid the problem. 1867e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define LOG_STREAM(severity) COMPACT_GOOGLE_LOG_ ## severity.stream() 1877e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1887e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define LOG(severity) LAZY_STREAM(LOG_STREAM(severity), LOG_IS_ON(severity)) 1897e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define LOG_IF(severity, condition) \ 1907e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(LOG_STREAM(severity), LOG_IS_ON(severity) && (condition)) 1917e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1927e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The VLOG macros log with negative verbosities. 1937e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define VLOG_STREAM(verbose_level) \ 19499c536d4a58a78ec7b4fdd988f8be87f705825d5Chih-Hung Hsieh logging::LogMessage(__FILE__, __LINE__, -(verbose_level)).stream() 1957e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1967e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define VLOG(verbose_level) \ 1977e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(VLOG_STREAM(verbose_level), VLOG_IS_ON(verbose_level)) 1987e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 1997e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define VLOG_IF(verbose_level, condition) \ 2007e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(VLOG_STREAM(verbose_level), \ 2017e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh VLOG_IS_ON(verbose_level) && (condition)) 2027e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2037e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// TODO(akalin): Add more VLOG variants, e.g. VPLOG. 2047e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2057e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define LOG_ASSERT(condition) \ 2067e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LOG_IF(FATAL, !(condition)) << "Assert failed: " #condition ". " 2077e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define SYSLOG_ASSERT(condition) \ 2087e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh SYSLOG_IF(FATAL, !(condition)) << "Assert failed: " #condition ". " 2097e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2107e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define PLOG(severity) \ 2117e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(PLOG_STREAM(severity), LOG_IS_ON(severity)) 2127e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2137e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define PLOG_IF(severity, condition) \ 2147e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(PLOG_STREAM(severity), LOG_IS_ON(severity) && (condition)) 2157e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2167e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The actual stream used isn't important. 2177e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define EAT_STREAM_PARAMETERS \ 21899c536d4a58a78ec7b4fdd988f8be87f705825d5Chih-Hung Hsieh true ? (void) 0 : ::logging::LogMessageVoidify() & LOG_STREAM(FATAL) /* NOLINT */ 2197e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2207e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// CHECK dies with a fatal error if condition is not true. It is *not* 2217e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// controlled by NDEBUG, so the check will be executed regardless of 2227e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// compilation mode. 2237e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 2247e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// We make sure CHECK et al. always evaluates their arguments, as 2257e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// doing CHECK(FunctionWithSideEffect()) is a common idiom. 2267e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2277e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK(condition) \ 2287e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(LOG_STREAM(FATAL), !(condition)) \ 2297e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh << "Check failed: " #condition ". " 2307e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2317e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define PCHECK(condition) \ 2327e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(PLOG_STREAM(FATAL), !(condition)) \ 2337e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh << "Check failed: " #condition ". " 2347e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2357e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Helper macro for binary operators. 2367e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Don't use this macro directly in your code, use CHECK_EQ et al below. 2377e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 2387e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// TODO(akalin): Rewrite this so that constructs like if (...) 2397e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// CHECK_EQ(...) else { ... } work properly. 2407e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK_OP(name, op, val1, val2) \ 2417e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh if (std::string* _result = \ 2427e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::Check##name##Impl((val1), (val2), \ 2437e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh #val1 " " #op " " #val2)) \ 2447e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::LogMessage(__FILE__, __LINE__, _result).stream() 2457e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2467e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Build the error message string. This is separate from the "Impl" 2477e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// function template because it is not performance critical and so can 2487e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// be out of line, while the "Impl" code should be inline. Caller 2497e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// takes ownership of the returned string. 2507e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshtemplate<class t1, class t2> 2517e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshstd::string* MakeCheckOpString(const t1& v1, const t2& v2, const char* names) { 2527e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh std::ostringstream ss; 2537e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh ss << names << " (" << v1 << " vs. " << v2 << ")"; 2547e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh std::string* msg = new std::string(ss.str()); 2557e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh return msg; 2567e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh} 2577e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2587e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// MSVC doesn't like complex extern templates and DLLs. 2597e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if !defined(COMPILER_MSVC) 2607e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Commonly used instantiations of MakeCheckOpString<>. Explicitly instantiated 2617e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// in logging.cc. 2627e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshextern template BASE_EXPORT std::string* MakeCheckOpString<int, int>( 2637e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const int&, const int&, const char* names); 2647e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshextern template BASE_EXPORT 2657e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshstd::string* MakeCheckOpString<unsigned long, unsigned long>( 2667e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const unsigned long&, const unsigned long&, const char* names); 2677e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshextern template BASE_EXPORT 2687e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshstd::string* MakeCheckOpString<unsigned long, unsigned int>( 2697e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const unsigned long&, const unsigned int&, const char* names); 2707e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshextern template BASE_EXPORT 2717e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshstd::string* MakeCheckOpString<unsigned int, unsigned long>( 2727e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const unsigned int&, const unsigned long&, const char* names); 2737e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshextern template BASE_EXPORT 2747e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshstd::string* MakeCheckOpString<std::string, std::string>( 2757e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const std::string&, const std::string&, const char* name); 2767e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 2777e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 2787e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Helper functions for CHECK_OP macro. 2797e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The (int, int) specialization works around the issue that the compiler 2807e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// will not instantiate the template version of the function on values of 2817e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// unnamed enum type - see comment below. 2827e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DEFINE_CHECK_OP_IMPL(name, op) \ 2837e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh template <class t1, class t2> \ 2847e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh inline std::string* Check##name##Impl(const t1& v1, const t2& v2, \ 2857e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const char* names) { \ 2867e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh if (v1 op v2) return NULL; \ 2877e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh else return MakeCheckOpString(v1, v2, names); \ 2887e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh } \ 2897e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh inline std::string* Check##name##Impl(int v1, int v2, const char* names) { \ 2907e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh if (v1 op v2) return NULL; \ 2917e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh else return MakeCheckOpString(v1, v2, names); \ 2927e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh } 2937e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshDEFINE_CHECK_OP_IMPL(EQ, ==) 2947e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshDEFINE_CHECK_OP_IMPL(NE, !=) 2957e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshDEFINE_CHECK_OP_IMPL(LE, <=) 2967e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshDEFINE_CHECK_OP_IMPL(LT, < ) 2977e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshDEFINE_CHECK_OP_IMPL(GE, >=) 2987e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshDEFINE_CHECK_OP_IMPL(GT, > ) 2997e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#undef DEFINE_CHECK_OP_IMPL 3007e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3017e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK_EQ(val1, val2) CHECK_OP(EQ, ==, val1, val2) 3027e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK_NE(val1, val2) CHECK_OP(NE, !=, val1, val2) 3037e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK_LE(val1, val2) CHECK_OP(LE, <=, val1, val2) 3047e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK_LT(val1, val2) CHECK_OP(LT, < , val1, val2) 3057e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK_GE(val1, val2) CHECK_OP(GE, >=, val1, val2) 3067e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define CHECK_GT(val1, val2) CHECK_OP(GT, > , val1, val2) 3077e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3087e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(NDEBUG) 3097e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define ENABLE_DLOG 0 3107e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#else 3117e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define ENABLE_DLOG 1 3127e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 3137e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3147e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(NDEBUG) && !defined(DCHECK_ALWAYS_ON) 3157e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_IS_ON 0 3167e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#else 3177e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_IS_ON 1 3187e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 3197e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3207e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Definitions for DLOG et al. 3217e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3227e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if ENABLE_DLOG 3237e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3247e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DLOG_IS_ON(severity) LOG_IS_ON(severity) 3257e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DLOG_IF(severity, condition) LOG_IF(severity, condition) 3267e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DLOG_ASSERT(condition) LOG_ASSERT(condition) 3277e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DPLOG_IF(severity, condition) PLOG_IF(severity, condition) 3287e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DVLOG_IF(verboselevel, condition) VLOG_IF(verboselevel, condition) 3297e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DVPLOG_IF(verboselevel, condition) VPLOG_IF(verboselevel, condition) 3307e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3317e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#else // ENABLE_DLOG 3327e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3337e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// If ENABLE_DLOG is off, we want to avoid emitting any references to 3347e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// |condition| (which may reference a variable defined only if NDEBUG 3357e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// is not defined). Contrast this with DCHECK et al., which has 3367e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// different behavior. 3377e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3387e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DLOG_IS_ON(severity) false 3397e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DLOG_IF(severity, condition) EAT_STREAM_PARAMETERS 3407e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DLOG_ASSERT(condition) EAT_STREAM_PARAMETERS 3417e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DPLOG_IF(severity, condition) EAT_STREAM_PARAMETERS 3427e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DVLOG_IF(verboselevel, condition) EAT_STREAM_PARAMETERS 3437e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DVPLOG_IF(verboselevel, condition) EAT_STREAM_PARAMETERS 3447e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3457e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif // ENABLE_DLOG 3467e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3477e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DEBUG_MODE is for uses like 3487e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// if (DEBUG_MODE) foo.CheckThatFoo(); 3497e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// instead of 3507e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// #ifndef NDEBUG 3517e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// foo.CheckThatFoo(); 3527e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// #endif 3537e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 3547e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// We tie its state to ENABLE_DLOG. 3557e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshenum { DEBUG_MODE = ENABLE_DLOG }; 3567e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3577e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#undef ENABLE_DLOG 3587e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3597e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DLOG(severity) \ 3607e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(LOG_STREAM(severity), DLOG_IS_ON(severity)) 3617e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3627e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DPLOG(severity) \ 3637e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(PLOG_STREAM(severity), DLOG_IS_ON(severity)) 3647e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3657e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DVLOG(verboselevel) DVLOG_IF(verboselevel, VLOG_IS_ON(verboselevel)) 3667e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3677e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DVPLOG(verboselevel) DVPLOG_IF(verboselevel, VLOG_IS_ON(verboselevel)) 3687e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3697e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Definitions for DCHECK et al. 3707e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3717e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if DCHECK_IS_ON 3727e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3737e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_EX_DCHECK(ClassName, ...) \ 3747e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh COMPACT_GOOGLE_LOG_EX_FATAL(ClassName , ##__VA_ARGS__) 3757e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_DCHECK COMPACT_GOOGLE_LOG_FATAL 3767e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_DCHECK = LOG_FATAL; 3777e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3787e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#else // DCHECK_IS_ON 3797e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3807e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// These are just dummy values. 3817e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_EX_DCHECK(ClassName, ...) \ 3827e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh COMPACT_GOOGLE_LOG_EX_INFO(ClassName , ##__VA_ARGS__) 3837e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define COMPACT_GOOGLE_LOG_DCHECK COMPACT_GOOGLE_LOG_INFO 3847e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshconst LogSeverity LOG_DCHECK = LOG_INFO; 3857e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3867e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif // DCHECK_IS_ON 3877e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3887e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DCHECK et al. make sure to reference |condition| regardless of 3897e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// whether DCHECKs are enabled; this is so that we don't get unused 3907e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// variable warnings if the only use of a variable is in a DCHECK. 3917e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// This behavior is different from DLOG_IF et al. 3927e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3937e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK(condition) \ 3947e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(LOG_STREAM(DCHECK), DCHECK_IS_ON && !(condition)) \ 3957e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh << "Check failed: " #condition ". " 3967e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 3977e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DPCHECK(condition) \ 3987e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LAZY_STREAM(PLOG_STREAM(DCHECK), DCHECK_IS_ON && !(condition)) \ 3997e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh << "Check failed: " #condition ". " 4007e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4017e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Helper macro for binary operators. 4027e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Don't use this macro directly in your code, use DCHECK_EQ et al below. 4037e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_OP(name, op, val1, val2) \ 4047e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh if (DCHECK_IS_ON) \ 4057e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh if (std::string* _result = \ 4067e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::Check##name##Impl((val1), (val2), \ 4077e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh #val1 " " #op " " #val2)) \ 4087e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::LogMessage( \ 4097e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh __FILE__, __LINE__, ::logging::LOG_DCHECK, \ 4107e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh _result).stream() 4117e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4127e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Equality/Inequality checks - compare two values, and log a 4137e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// LOG_DCHECK message including the two values when the result is not 4147e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// as expected. The values must have operator<<(ostream, ...) 4157e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// defined. 4167e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 4177e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// You may append to the error message like so: 4187e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DCHECK_NE(1, 2) << ": The world must be ending!"; 4197e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 4207e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// We are very careful to ensure that each argument is evaluated exactly 4217e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// once, and that anything which is legal to pass as a function argument is 4227e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// legal here. In particular, the arguments may be temporary expressions 4237e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// which will end up being destroyed at the end of the apparent statement, 4247e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// for example: 4257e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// DCHECK_EQ(string("abc")[1], 'b'); 4267e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 4277e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// WARNING: These may not compile correctly if one of the arguments is a pointer 4287e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// and the other is NULL. To work around this, simply static_cast NULL to the 4297e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// type of the desired pointer. 4307e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4317e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_EQ(val1, val2) DCHECK_OP(EQ, ==, val1, val2) 4327e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_NE(val1, val2) DCHECK_OP(NE, !=, val1, val2) 4337e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_LE(val1, val2) DCHECK_OP(LE, <=, val1, val2) 4347e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_LT(val1, val2) DCHECK_OP(LT, < , val1, val2) 4357e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_GE(val1, val2) DCHECK_OP(GE, >=, val1, val2) 4367e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define DCHECK_GT(val1, val2) DCHECK_OP(GT, > , val1, val2) 4377e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4387e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(NDEBUG) && defined(OS_CHROMEOS) 4397e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTREACHED() LOG(ERROR) << "NOTREACHED() hit in " << \ 4407e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh __FUNCTION__ << ". " 4417e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#else 4427e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTREACHED() DCHECK(false) 4437e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 4447e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4457e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Redefine the standard assert to use our nice log files 4467e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#undef assert 4477e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define assert(x) DLOG_ASSERT(x) 4487e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4497e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// This class more or less represents a particular log message. You 4507e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// create an instance of LogMessage and then stream stuff to it. 4517e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// When you finish streaming to it, ~LogMessage is called and the 4527e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// full message gets streamed to the appropriate destination. 4537e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 4547e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// You shouldn't actually use LogMessage's constructor to log things, 4557e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// though. You should use the LOG() macro (and variants thereof) 4567e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// above. 4577e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshclass BASE_EXPORT LogMessage { 4587e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh public: 4597e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // Used for LOG(severity). 4607e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogMessage(const char* file, int line, LogSeverity severity); 4617e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4627e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // Used for CHECK_EQ(), etc. Takes ownership of the given string. 4637e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // Implied severity = LOG_FATAL. 4647e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogMessage(const char* file, int line, std::string* result); 4657e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4667e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // Used for DCHECK_EQ(), etc. Takes ownership of the given string. 4677e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogMessage(const char* file, int line, LogSeverity severity, 4687e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh std::string* result); 4697e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4707e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh ~LogMessage(); 4717e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4727e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh std::ostream& stream() { return stream_; } 4737e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4747e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh private: 4757e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh void Init(const char* file, int line); 4767e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4777e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogSeverity severity_; 4787e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh std::ostringstream stream_; 4797e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh size_t message_start_; // Offset of the start of the message (past prefix 4807e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // info). 4817e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // The file and line information passed in to the constructor. 4827e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const char* file_; 4837e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh const int line_; 4847e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4857e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(OS_WIN) 4867e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // Stores the current value of GetLastError in the constructor and restores 4877e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // it in the destructor by calling SetLastError. 4887e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // This is useful since the LogMessage class uses a lot of Win32 calls 4897e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // that will lose the value of GLE and the code that called the log function 4907e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // will have lost the thread error value when the log call returns. 4917e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh class SaveLastError { 4927e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh public: 4937e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh SaveLastError(); 4947e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh ~SaveLastError(); 4957e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4967e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh unsigned long get_error() const { return last_error_; } 4977e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 4987e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh protected: 4997e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh unsigned long last_error_; 5007e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh }; 5017e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5027e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh SaveLastError last_error_; 5037e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 5047e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5057e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh DISALLOW_COPY_AND_ASSIGN(LogMessage); 5067e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh}; 5077e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5087e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// A non-macro interface to the log facility; (useful 5097e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// when the logging level is not a compile-time constant). 5107e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshinline void LogAtLevel(int const log_level, std::string const &msg) { 5117e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogMessage(__FILE__, __LINE__, log_level).stream() << msg; 5127e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh} 5137e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5147e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// This class is used to explicitly ignore values in the conditional 5157e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// logging macros. This avoids compiler warnings like "value computed 5167e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// is not used" and "statement has no effect". 5177e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshclass LogMessageVoidify { 5187e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh public: 5197e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogMessageVoidify() { } 5207e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // This has to be an operator with a precedence lower than << but 5217e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // higher than ?: 5227e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh void operator&(std::ostream&) { } 5237e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh}; 5247e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5257e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(OS_WIN) 5267e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshtypedef unsigned long SystemErrorCode; 5277e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#elif defined(OS_POSIX) 5287e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshtypedef int SystemErrorCode; 5297e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 5307e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5317e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Alias for ::GetLastError() on Windows and errno on POSIX. Avoids having to 5327e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// pull in windows.h just for GetLastError() and DWORD. 5337e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT SystemErrorCode GetLastSystemErrorCode(); 5347e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT std::string SystemErrorCodeToString(SystemErrorCode error_code); 5357e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5367e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(OS_WIN) 5377e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Appends a formatted system message of the GetLastError() type. 5387e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshclass BASE_EXPORT Win32ErrorLogMessage { 5397e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh public: 5407e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh Win32ErrorLogMessage(const char* file, 5417e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh int line, 5427e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogSeverity severity, 5437e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh SystemErrorCode err); 5447e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5457e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // Appends the error message before destructing the encapsulated class. 5467e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh ~Win32ErrorLogMessage(); 5477e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5487e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh std::ostream& stream() { return log_message_.stream(); } 5497e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5507e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh private: 5517e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh SystemErrorCode err_; 5527e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogMessage log_message_; 5537e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5547e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh DISALLOW_COPY_AND_ASSIGN(Win32ErrorLogMessage); 5557e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh}; 5567e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#elif defined(OS_POSIX) 5577e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Appends a formatted system message of the errno type 5587e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshclass BASE_EXPORT ErrnoLogMessage { 5597e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh public: 5607e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh ErrnoLogMessage(const char* file, 5617e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh int line, 5627e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogSeverity severity, 5637e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh SystemErrorCode err); 5647e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5657e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh // Appends the error message before destructing the encapsulated class. 5667e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh ~ErrnoLogMessage(); 5677e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5687e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh std::ostream& stream() { return log_message_.stream(); } 5697e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5707e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh private: 5717e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh SystemErrorCode err_; 5727e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LogMessage log_message_; 5737e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5747e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh DISALLOW_COPY_AND_ASSIGN(ErrnoLogMessage); 5757e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh}; 5767e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif // OS_WIN 5777e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5787e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Closes the log file explicitly if open. 5797e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// NOTE: Since the log file is opened as necessary by the action of logging 5807e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// statements, there's no guarantee that it will stay closed 5817e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// after this call. 5827e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT void CloseLogFile(); 5837e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5847e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Async signal safe logging mechanism. 5857e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT void RawLog(int level, const char* message); 5867e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5877e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define RAW_LOG(level, message) logging::RawLog(logging::LOG_ ## level, message) 5887e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5897e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define RAW_CHECK(condition) \ 5907e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh do { \ 5917e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh if (!(condition)) \ 5927e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logging::RawLog(logging::LOG_FATAL, "Check failed: " #condition "\n"); \ 5937e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh } while (0) 5947e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 5957e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(OS_WIN) 5967e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Returns the default log file path. 5977e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT std::wstring GetLogFileFullPath(); 5987e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 5997e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 6007e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh} // namespace logging 6017e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 6027e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// Note that "The behavior of a C++ program is undefined if it adds declarations 6037e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// or definitions to namespace std or to a namespace within namespace std unless 6047e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// otherwise specified." --C++11[namespace.std] 6057e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 6067e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// We've checked that this particular definition has the intended behavior on 6077e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// our implementations, but it's prone to breaking in the future, and please 6087e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// don't imitate this in your own definitions without checking with some 6097e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// standard library experts. 6107e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshnamespace std { 6117e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// These functions are provided as a convenience for logging, which is where we 6127e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// use streams (it is against Google style to use streams in other places). It 6137e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// is designed to allow you to emit non-ASCII Unicode strings to the log file, 6147e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// which is normally ASCII. It is relatively slow, so try not to use it for 6157e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// common cases. Non-ASCII characters will be converted to UTF-8 by these 6167e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// operators. 6177e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshBASE_EXPORT std::ostream& operator<<(std::ostream& out, const wchar_t* wstr); 6187e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshinline std::ostream& operator<<(std::ostream& out, const std::wstring& wstr) { 6197e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh return out << wstr.c_str(); 6207e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh} 6217e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh} // namespace std 6227e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 6237e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The NOTIMPLEMENTED() macro annotates codepaths which have 6247e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// not been implemented yet. 6257e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 6267e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// The implementation of this macro is controlled by NOTIMPLEMENTED_POLICY: 6277e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 0 -- Do nothing (stripped by compiler) 6287e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 1 -- Warn at compile time 6297e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 2 -- Fail at compile time 6307e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 3 -- Fail at runtime (DCHECK) 6317e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 4 -- [default] LOG(ERROR) at runtime 6327e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// 5 -- LOG(ERROR) at runtime, only once per call-site 6337e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 6347e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#ifndef NOTIMPLEMENTED_POLICY 6357e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(OS_ANDROID) && defined(OFFICIAL_BUILD) 6367e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED_POLICY 0 6377e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#else 6387e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// WebView: Hide NOTIMPLEMENTED entirely in Android release branch. 6397e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED_POLICY 0 6407e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 6417e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 6427e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 6437e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if defined(COMPILER_GCC) 6447e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// On Linux, with GCC, we can use __PRETTY_FUNCTION__ to get the demangled name 6457e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// of the current function in the NOTIMPLEMENTED message. 6467e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED_MSG "Not implemented reached in " << __PRETTY_FUNCTION__ 6477e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#else 6487e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED_MSG "NOT IMPLEMENTED" 6497e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 6507e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 6517e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#if NOTIMPLEMENTED_POLICY == 0 6527e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED() EAT_STREAM_PARAMETERS 6537e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#elif NOTIMPLEMENTED_POLICY == 1 6547e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh// TODO, figure out how to generate a warning 6557e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED() COMPILE_ASSERT(false, NOT_IMPLEMENTED) 6567e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#elif NOTIMPLEMENTED_POLICY == 2 6577e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED() COMPILE_ASSERT(false, NOT_IMPLEMENTED) 6587e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#elif NOTIMPLEMENTED_POLICY == 3 6597e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED() NOTREACHED() 6607e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#elif NOTIMPLEMENTED_POLICY == 4 6617e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED() LOG(ERROR) << NOTIMPLEMENTED_MSG 6627e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#elif NOTIMPLEMENTED_POLICY == 5 6637e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#define NOTIMPLEMENTED() do {\ 6647e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh static bool logged_once = false;\ 6657e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh LOG_IF(ERROR, !logged_once) << NOTIMPLEMENTED_MSG;\ 6667e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh logged_once = true;\ 6677e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh} while(0);\ 6687e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntoshEAT_STREAM_PARAMETERS 6697e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif 6707e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh 6717e2f4e9d384d501cf86118ebac4b8de2b86eac53Than McIntosh#endif // BASE_LOGGING_H_ 672