include/logger.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __LOGMANAGER_H
  15 #define __LOGMANAGER_H
  16
  17 /** This class implements a nonblocking writer.
  18  * Most people writing an ircd give little thought to their disk
  19  * i/o. On a congested system, disk writes can block for long
  20  * periods of time (e.g. if the system is busy and/or swapping
  21  * a lot). If we just use a blocking fprintf() call, this could
  22  * block for undesirable amounts of time (half of a second through
  23  * to whole seconds). We DO NOT want this, so we make our logfile
  24  * nonblocking and hook it into the SocketEngine.
  25  * NB: If the operating system does not support nonblocking file
  26  * I/O (linux seems to, as does freebsd) this will default to
  27  * blocking behaviour.
  28  */
  29 class CoreExport FileWriter
  30 {
  31  protected:
  32         /** The log file (fd is inside this somewhere,
  33          * we get it out with fileno())
  34          */
  35         FILE* log;
  36
  37         /** Number of write operations that have occured
  38          */
  39         int writeops;
  40
  41  public:
  42         /** The constructor takes an already opened logfile.
  43          */
  44         FileWriter(FILE* logfile);
  45
  46         /** Write one or more preformatted log lines.
  47          * If the data cannot be written immediately,
  48          * this class will insert itself into the
  49          * SocketEngine, and register a write event,
  50          * and when the write event occurs it will
  51          * attempt again to write the data.
  52          */
  53         void WriteLogLine(const std::string &line);
  54
  55         /** Close the log file and cancel any events.
  56          */
  57         virtual ~FileWriter();
  58 };
  59
  60
  61
  62 /*
  63  * New world logging!
  64  * The brief summary:
  65  *  Logging used to be a simple affair, a FILE * handled by a nonblocking logging class inheriting from EventHandler, that was inserted
  66  *  into the socket engine, and wrote lines. If nofork was on, it was printf()'d.
  67  *
  68  *  We decided to horribly overcomplicate matters, and create vastly customisable logging. LogManager and LogStream form the visible basis
  69  *  of the new interface. Basically, a LogStream can be inherited to do different things with logging output. We inherit from it once in core
  70  *  to create a FileLogStream, that writes to a file, for example. Different LogStreams can hook different types of log messages, and different
  71  *  levels of output too, for extreme customisation. Multiple LogStreams can hook the same message/levels of output, meaning that e.g. output
  72  *  can go to a channel as well as a file.
  73  *
  74  *  HOW THIS WORKS
  75  *   LogManager handles all instances of LogStreams, classes derived from LogStream are instantiated and passed to it.
  76  */
  77
  78 /** LogStream base class. Modules (and other stuff) inherit from this to decide what logging they are interested in, and what to do with it.
  79  */
  80 class CoreExport LogStream : public classbase
  81 {
  82  protected:
  83         int loglvl;
  84  public:
  85         LogStream(int loglevel) : loglvl(loglevel)
  86         {
  87         }
  88
  89         /* A LogStream's destructor should do whatever it needs to close any resources it was using (or indicate that it is no longer using a resource
  90          * in the event that the resource is shared, see for example FileLogStream).
  91          */
  92         virtual ~LogStream() { }
  93
  94         /** Changes the loglevel for this LogStream on-the-fly.
  95          * This is needed for -nofork. But other LogStreams could use it to change loglevels.
  96          */
  97         void ChangeLevel(int lvl) { this->loglvl = lvl; }
  98
  99         /** Called when there is stuff to log for this particular logstream. The derived class may take no action with it, or do what it
 100          * wants with the output, basically. loglevel and type are primarily for informational purposes (the level and type of the event triggered)
 101          * and msg is, of course, the actual message to log.
 102          */
 103         virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) = 0;
 104 };
 105
 106 typedef std::map<FileWriter*, int> FileLogMap;
 107
 108 class CoreExport LogManager
 109 {
 110  private:
 111         /** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop.
 112          */
 113         bool Logging;
 114
 115         /** Map of active log types and what LogStreams will receive them.
 116          */
 117         std::map<std::string, std::vector<LogStream *> > LogStreams;
 118
 119         /** Refcount map of all LogStreams managed by LogManager.
 120          * If a logstream is not listed here, it won't be automatically closed by LogManager, even if it's loaded in one of the other lists.
 121          */
 122         std::map<LogStream *, int> AllLogStreams;
 123
 124         /** LogStreams with type * (which means everything), and a list a logtypes they are excluded from (eg for "* -USERINPUT -USEROUTPUT").
 125          */
 126         std::map<LogStream *, std::vector<std::string> > GlobalLogStreams;
 127
 128         /** Refcounted map of all FileWriters in use by FileLogStreams, for file stream sharing.
 129          */
 130         FileLogMap FileLogs;
 131
 132  public:
 133
 134         LogManager();
 135         ~LogManager();
 136
 137         /** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance.
 138          * Used for file-stream sharing for FileLogStreams.
 139          */
 140         void AddLoggerRef(FileWriter* fw)
 141         {
 142                 FileLogMap::iterator i = FileLogs.find(fw);
 143                 if (i == FileLogs.end())
 144                 {
 145                         FileLogs.insert(std::make_pair(fw, 1));
 146                 }
 147                 else
 148                 {
 149                         ++i->second;
 150                 }
 151         }
 152
 153         /** Indicates that a FileWriter reference has been removed. Reference count is decreased, and if zeroed, the FileWriter is closed.
 154          */
 155         void DelLoggerRef(FileWriter* fw)
 156         {
 157                 FileLogMap::iterator i = FileLogs.find(fw);
 158                 if (i == FileLogs.end()) return; /* Maybe should log this? */
 159                 if (--i->second < 1)
 160                 {
 161                         delete i->first;
 162                         FileLogs.erase(i);
 163                 }
 164         }
 165
 166         /** Opens all logfiles defined in the configuration file using <log method="file">.
 167          */
 168         void OpenFileLogs();
 169
 170         /** Removes all LogStreams, meaning they have to be readded for logging to continue.
 171          * Only LogStreams that were listed in AllLogStreams are actually closed.
 172          */
 173         void CloseLogs();
 174
 175         /** Adds a single LogStream to multiple logtypes.
 176          * This automatically handles things like "* -USERINPUT -USEROUTPUT" to mean all but USERINPUT and USEROUTPUT types.
 177          * It is not a good idea to mix values of autoclose for the same LogStream.
 178          * @param type The type string (from configuration, or whatever) to parse.
 179          * @param l The LogStream to add.
 180          * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
 181          */
 182         void AddLogTypes(const std::string &type, LogStream *l, bool autoclose);
 183
 184         /** Registers a new logstream into the logging core, so it can be called for future events
 185          * It is not a good idea to mix values of autoclose for the same LogStream.
 186          * @param type The type to add this LogStream to.
 187          * @param l The LogStream to add.
 188          * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
 189          * @return True if the LogStream was added successfully, False otherwise.
 190          */
 191         bool AddLogType(const std::string &type, LogStream *l, bool autoclose);
 192
 193         /** Removes a logstream from the core. After removal, it will not recieve further events.
 194          * If the LogStream was ever added with autoclose, it will be closed after this call (this means the pointer won't be valid anymore).
 195          */
 196         void DelLogStream(LogStream* l);
 197
 198         /** Removes a LogStream from a single type. If the LogStream has been registered for "*" it will still receive the type unless you remove it from "*" specifically.
 199          * If the LogStream was added with autoclose set to true, then when the last occurrence of the stream is removed it will automatically be closed (freed).
 200          */
 201         bool DelLogType(const std::string &type, LogStream *l);
 202
 203         /** Logs an event, sending it to all LogStreams registered for the type.
 204          * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
 205          * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
 206          * @param msg The message to be logged (literal).
 207          */
 208         void Log(const std::string &type, int loglevel, const std::string &msg);
 209
 210         /** Logs an event, sending it to all LogStreams registered for the type.
 211          * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
 212          * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
 213          * @param msg The format of the message to be logged. See your C manual on printf() for details.
 214          */
 215         void Log(const std::string &type, int loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5);
 216 };
 217
 218 #endif