2 * Copyright 2004-present Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
21 #include <type_traits>
23 #include <folly/Portability.h>
24 #include <folly/Range.h>
31 * Higher levels are more important than lower ones.
33 * However, the numbers in the DBG* level names are reversed, and can be
34 * thought of as debug verbosity levels. Increasing DBG* numbers mean
35 * increasing level of verbosity. DBG0 is the least verbose debug level,
36 * DBG1 is one level higher of verbosity, etc.
38 enum class LogLevel : uint32_t {
59 // Unfortunately Windows headers #define ERROR
60 // On Windows platforms we avoid defining ERROR. However we make it
61 // available on other platforms, to make it easier to convert code from
62 // other log libraries that also use ERROR as their log level name (e.g.,
71 // DFATAL log messages crash the program on debug builds.
73 // FATAL log messages always abort the program.
74 // This level is equivalent to MAX_LEVEL.
77 // The most significant bit is used by LogCategory to store a flag value,
78 // so the maximum value has that bit cleared.
80 // (We call this MAX_LEVEL instead of MAX just since MAX() is commonly
81 // defined as a preprocessor macro by some C headers.)
82 MAX_LEVEL = 0x7fffffff,
86 * Support adding and subtracting integers from LogLevels, to create slightly
87 * adjusted log level values.
89 inline constexpr LogLevel operator+(LogLevel level, uint32_t value) {
90 auto newValue = static_cast<uint32_t>(level) + value;
91 // Cap the result at LogLevel::MAX_LEVEL
92 if (newValue > static_cast<uint32_t>(LogLevel::MAX_LEVEL)) {
93 return LogLevel::MAX_LEVEL;
95 return static_cast<LogLevel>(newValue);
97 inline LogLevel& operator+=(LogLevel& level, uint32_t value) {
98 level = level + value;
101 inline constexpr LogLevel operator-(LogLevel level, uint32_t value) {
102 return static_cast<LogLevel>(static_cast<uint32_t>(level) - value);
104 inline LogLevel& operator-=(LogLevel& level, uint32_t value) {
105 level = level - value;
110 * Construct a LogLevel from a string name.
112 LogLevel stringToLogLevel(folly::StringPiece name);
115 * Get a human-readable string representing the LogLevel.
117 std::string logLevelToString(LogLevel level);
120 * Print a LogLevel in a human readable format.
122 std::ostream& operator<<(std::ostream& os, LogLevel level);
125 * Returns true if and only if a LogLevel is fatal.
127 inline constexpr bool isLogLevelFatal(LogLevel level) {
128 if (folly::kIsDebug) {
129 return level >= LogLevel::DFATAL;
131 return level >= LogLevel::FATAL;