folly/experimental/logging/LogCategory.h

   1 /*
   2  * Copyright 2004-present Facebook, Inc.
   3  *
   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
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16 #pragma once
  17
  18 #include <atomic>
  19 #include <cstdint>
  20 #include <list>
  21 #include <string>
  22
  23 #include <folly/Range.h>
  24 #include <folly/Synchronized.h>
  25 #include <folly/experimental/logging/LogLevel.h>
  26
  27 namespace folly {
  28
  29 class LoggerDB;
  30 class LogHandler;
  31 class LogMessage;
  32
  33 /**
  34  * LogCategory stores all of the logging configuration for a specific
  35  * log category.
  36  *
  37  * This class is separate from Logger to allow multiple Logger objects to all
  38  * refer to the same log category.  Logger can be thought of as a small wrapper
  39  * class that behaves like a pointer to a LogCategory object.
  40  */
  41 class LogCategory {
  42  public:
  43   /**
  44    * Create the root LogCategory.
  45    *
  46    * This should generally only be invoked by LoggerDB.
  47    */
  48   explicit LogCategory(LoggerDB* db);
  49
  50   /**
  51    * Create a new LogCategory.
  52    *
  53    * This should only be invoked by LoggerDB, while holding the main LoggerDB
  54    * lock.
  55    *
  56    * The name argument should already be in canonical form.
  57    *
  58    * This constructor automatically adds this new LogCategory to the parent
  59    * category's firstChild_ linked-list.
  60    */
  61   LogCategory(folly::StringPiece name, LogCategory* parent);
  62
  63   /**
  64    * Get the name of this log category.
  65    */
  66   const std::string& getName() const {
  67     return name_;
  68   }
  69
  70   /**
  71    * Get the level for this log category.
  72    */
  73   LogLevel getLevel() const {
  74     return static_cast<LogLevel>(
  75         level_.load(std::memory_order_acquire) & ~FLAG_INHERIT);
  76   }
  77
  78   /**
  79    * Get the effective level for this log category.
  80    *
  81    * This is the minimum log level of this category and all of its parents.
  82    * Log messages below this level will be ignored, while messages at or
  83    * above this level need to be processed by this category or one of its
  84    * parents.
  85    */
  86   LogLevel getEffectiveLevel() const {
  87     return effectiveLevel_.load(std::memory_order_acquire);
  88   }
  89
  90   /**
  91    * Get the effective log level using std::memory_order_relaxed.
  92    *
  93    * This is primarily used for log message checks.  Most other callers should
  94    * use getEffectiveLevel() above to be more conservative with regards to
  95    * memory ordering.
  96    */
  97   LogLevel getEffectiveLevelRelaxed() const {
  98     return effectiveLevel_.load(std::memory_order_relaxed);
  99   }
 100
 101   /**
 102    * Check whether this Logger or any of its parent Loggers would do anything
 103    * with a log message at the given level.
 104    */
 105   bool logCheck(LogLevel level) const {
 106     // We load the effective level using std::memory_order_relaxed.
 107     //
 108     // We want to make log checks as lightweight as possible.  It's fine if we
 109     // don't immediately respond to changes made to the log level from other
 110     // threads.  We can wait until some other operation triggers a memory
 111     // barrier before we honor the new log level setting.  No other memory
 112     // accesses depend on the log level value.  Callers should not rely on all
 113     // other threads to immediately stop logging as soon as they decrease the
 114     // log level for a given category.
 115     return effectiveLevel_.load(std::memory_order_relaxed) <= level;
 116   }
 117
 118   /**
 119    * Set the log level for this LogCategory.
 120    *
 121    * Messages logged to a specific log category will be ignored unless the
 122    * message log level is greater than the LogCategory's effective log level.
 123    *
 124    * If inherit is true, LogCategory's effective log level is the minimum of
 125    * its level and its parent category's effective log level.  If inherit is
 126    * false, the LogCategory's effective log level is simply its log level.
 127    * (Setting inherit to false is necessary if you want a child LogCategory to
 128    * use a less verbose level than its parent categories.)
 129    */
 130   void setLevel(LogLevel level, bool inherit = true);
 131
 132   /**
 133    * Get the LoggerDB that this LogCategory belongs to.
 134    *
 135    * This is almost always the main LoggerDB singleton returned by
 136    * LoggerDB::get().  The logging unit tests are the main location that
 137    * creates alternative LoggerDB objects.
 138    */
 139   LoggerDB* getDB() const {
 140     return db_;
 141   }
 142
 143   /**
 144    * Attach a LogHandler to this category.
 145    */
 146   void addHandler(std::shared_ptr<LogHandler> handler);
 147
 148   /**
 149    * Remove all LogHandlers from this category.
 150    */
 151   void clearHandlers();
 152
 153   /**
 154    * Get the list of LogHandlers attached to this category.
 155    */
 156   std::vector<std::shared_ptr<LogHandler>> getHandlers() const;
 157
 158   /* Internal methods for use by other parts of the logging library code */
 159
 160   /**
 161    * Admit a message into the LogCategory hierarchy to be logged.
 162    *
 163    * The caller is responsible for having already performed log level
 164    * admittance checks.
 165    *
 166    * This method generally should be invoked only through the logging macros,
 167    * rather than calling this directly.
 168    */
 169   void admitMessage(const LogMessage& message) const;
 170
 171   /**
 172    * Note: setLevelLocked() may only be called while holding the main
 173    * LoggerDB lock.
 174    *
 175    * This method should only be invoked by LoggerDB.
 176    */
 177   void setLevelLocked(LogLevel level, bool inherit);
 178
 179   /**
 180    * Register a std::atomic<LogLevel> value used by XLOG*() macros to check the
 181    * effective level for this category.
 182    *
 183    * The LogCategory will keep this value updated whenever its effective log
 184    * level changes.
 185    *
 186    * This function should only be invoked by LoggerDB, and the LoggerDB lock
 187    * must be held when calling it.
 188    */
 189   void registerXlogLevel(std::atomic<LogLevel>* levelPtr);
 190
 191  private:
 192   enum : uint32_t { FLAG_INHERIT = 0x80000000 };
 193
 194   // Forbidden copy constructor and assignment operator
 195   LogCategory(LogCategory const&) = delete;
 196   LogCategory& operator=(LogCategory const&) = delete;
 197
 198   void processMessage(const LogMessage& message) const;
 199   void updateEffectiveLevel(LogLevel newEffectiveLevel);
 200   void parentLevelUpdated(LogLevel parentEffectiveLevel);
 201
 202   /**
 203    * The minimum log level of this category and all of its parents.
 204    */
 205   std::atomic<LogLevel> effectiveLevel_{LogLevel::MAX_LEVEL};
 206
 207   /**
 208    * The current log level for this category.
 209    *
 210    * The most significant bit is used to indicate if this logger should
 211    * inherit its parent's effective log level.
 212    */
 213   std::atomic<uint32_t> level_{0};
 214
 215   /**
 216    * Our parent LogCategory in the category hierarchy.
 217    *
 218    * For instance, if our log name is "foo.bar.abc", our parent category
 219    * is "foo.bar".
 220    */
 221   LogCategory* const parent_{nullptr};
 222
 223   /**
 224    * Our log category name.
 225    */
 226   const std::string name_;
 227
 228   /**
 229    * The list of LogHandlers attached to this category.
 230    */
 231   folly::Synchronized<std::vector<std::shared_ptr<LogHandler>>> handlers_;
 232
 233   /**
 234    * A pointer to the LoggerDB that we belong to.
 235    *
 236    * This is almost always the main LoggerDB singleton.  Unit tests are the
 237    * main place where we use other LoggerDB objects besides the singleton.
 238    */
 239   LoggerDB* const db_{nullptr};
 240
 241   /**
 242    * Pointers to children and sibling loggers.
 243    * These pointers should only ever be accessed while holding the main
 244    * LoggerDB lock.  (These are only modified when creating new loggers,
 245    * which occurs with the main LoggerDB lock held.)
 246    */
 247   LogCategory* firstChild_{nullptr};
 248   LogCategory* nextSibling_{nullptr};
 249
 250   /**
 251    * A list of LogLevel values used by XLOG*() statements for this LogCategory.
 252    * The XLOG*() statements will check these values.  We ensure they are kept
 253    * up-to-date each time the effective log level changes for this category.
 254    *
 255    * This list may only be accessed while holding the main LoggerDB lock.
 256    */
 257   std::vector<std::atomic<LogLevel>*> xlogLevels_;
 258 };
 259 }