include/logger.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 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 : public EventHandler
  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         /** Handle pending write events.
  47          * This will flush any waiting data to disk.
  48          * If any data remains after the fprintf call,
  49          * another write event is scheduled to write
  50          * the rest of the data when possible.
  51          */
  52         virtual void HandleEvent(EventType et, int errornum = 0);
  53
  54         /** Write one or more preformatted log lines.
  55          * If the data cannot be written immediately,
  56          * this class will insert itself into the
  57          * SocketEngine, and register a write event,
  58          * and when the write event occurs it will
  59          * attempt again to write the data.
  60          */
  61         void WriteLogLine(const std::string &line);
  62
  63         /** Close the log file and cancel any events.
  64          */
  65         virtual void Close();
  66
  67         /** Close the log file and cancel any events.
  68          */
  69         virtual ~FileWriter();
  70 };
  71
  72
  73
  74 /*
  75  * New world logging!
  76  * The brief summary:
  77  *  Logging used to be a simple affair, a FILE * handled by a nonblocking logging class inheriting from EventHandler, that was inserted
  78  *  into the socket engine, and wrote lines. If nofork was on, it was printf()'d.
  79  *
  80  *  We decided to horribly overcomplicate matters, and create vastly customisable logging. LogManager and LogStream form the visible basis
  81  *  of the new interface. Basically, a LogStream can be inherited to do different things with logging output. We inherit from it once in core
  82  *  to create a FileLogStream, that writes to a file, for example. Different LogStreams can hook different types of log messages, and different
  83  *  levels of output too, for extreme customisation. Multiple LogStreams can hook the same message/levels of output, meaning that e.g. output
  84  *  can go to a channel as well as a file.
  85  *
  86  *  HOW THIS WORKS
  87  *   LogManager handles all instances of LogStreams, classes derived from LogStream are instantiated and passed to it.
  88  */
  89
  90 /** LogStream base class. Modules (and other stuff) inherit from this to decide what logging they are interested in, and what to do with it.
  91  */
  92 class CoreExport LogStream : public classbase
  93 {
  94  protected:
  95         int loglvl;
  96  public:
  97         LogStream(int loglevel) : loglvl(loglevel)
  98         {
  99         }
 100
 101         /* 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
 102          * in the event that the resource is shared, see for example FileLogStream).
 103          */
 104         virtual ~LogStream() { }
 105
 106         /** Changes the loglevel for this LogStream on-the-fly.
 107          * This is needed for -nofork. But other LogStreams could use it to change loglevels.
 108          */
 109         void ChangeLevel(int lvl) { this->loglvl = lvl; }
 110
 111         /** Called when there is stuff to log for this particular logstream. The derived class may take no action with it, or do what it
 112          * wants with the output, basically. loglevel and type are primarily for informational purposes (the level and type of the event triggered)
 113          * and msg is, of course, the actual message to log.
 114          */
 115         virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) = 0;
 116 };
 117
 118 typedef std::map<FileWriter*, int> FileLogMap;
 119
 120 class CoreExport LogManager : public classbase
 121 {
 122  private:
 123         /** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop.
 124          */
 125         bool Logging;
 126
 127         /** LogStream for -nofork, logs to STDOUT when it's active.
 128          */
 129         LogStream* noforkstream;
 130
 131         /** Map of active log types and what LogStreams will receive them.
 132          */
 133         std::map<std::string, std::vector<LogStream *> > LogStreams;
 134
 135         /** Refcount map of all LogStreams managed by LogManager.
 136          * 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.
 137          */
 138         std::map<LogStream *, int> AllLogStreams;
 139
 140         /** LogStreams with type * (which means everything), and a list a logtypes they are excluded from (eg for "* -USERINPUT -USEROUTPUT").
 141          */
 142         std::map<LogStream *, std::vector<std::string> > GlobalLogStreams;
 143
 144         /** Refcounted map of all FileWriters in use by FileLogStreams, for file stream sharing.
 145          */
 146         FileLogMap FileLogs;
 147
 148  public:
 149
 150         LogManager()
 151         {
 152                 noforkstream = NULL;
 153                 Logging = false;
 154         }
 155
 156         ~LogManager()
 157         {
 158                 if (noforkstream)
 159                         delete noforkstream;
 160         }
 161
 162         /** Sets up the logstream for -nofork. Called by InspIRCd::OpenLog() and LogManager::OpenFileLogs().
 163          * First time called it creates the nofork stream and stores it in noforkstream. Each call thereafter just readds it to GlobalLogStreams
 164          * and updates the loglevel.
 165          */
 166         void SetupNoFork();
 167
 168         /** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance.
 169          * Used for file-stream sharing for FileLogStreams.
 170          */
 171         void AddLoggerRef(FileWriter* fw)
 172         {
 173                 FileLogMap::iterator i = FileLogs.find(fw);
 174                 if (i == FileLogs.end())
 175                 {
 176                         FileLogs.insert(std::make_pair(fw, 1));
 177                 }
 178                 else
 179                 {
 180                         ++i->second;
 181                 }
 182         }
 183
 184         /** Indicates that a FileWriter reference has been removed. Reference count is decreased, and if zeroed, the FileWriter is closed.
 185          */
 186         void DelLoggerRef(FileWriter* fw)
 187         {
 188                 FileLogMap::iterator i = FileLogs.find(fw);
 189                 if (i == FileLogs.end()) return; /* Maybe should log this? */
 190                 if (--i->second < 1)
 191                 {
 192                         delete i->first;
 193                         FileLogs.erase(i);
 194                 }
 195         }
 196
 197         /** Opens all logfiles defined in the configuration file using <log method="file">.
 198          */
 199         void OpenFileLogs();
 200
 201         /** Removes all LogStreams, meaning they have to be readded for logging to continue.
 202          * Only LogStreams that were listed in AllLogStreams are actually closed.
 203          */
 204         void CloseLogs();
 205
 206         /** Adds a single LogStream to multiple logtypes.
 207          * This automatically handles things like "* -USERINPUT -USEROUTPUT" to mean all but USERINPUT and USEROUTPUT types.
 208          * It is not a good idea to mix values of autoclose for the same LogStream.
 209          * @param type The type string (from configuration, or whatever) to parse.
 210          * @param l The LogStream to add.
 211          * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
 212          */
 213         void AddLogTypes(const std::string &type, LogStream *l, bool autoclose);
 214
 215         /** Registers a new logstream into the logging core, so it can be called for future events
 216          * It is not a good idea to mix values of autoclose for the same LogStream.
 217          * @param type The type to add this LogStream to.
 218          * @param l The LogStream to add.
 219          * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open.
 220          * @return True if the LogStream was added successfully, False otherwise.
 221          */
 222         bool AddLogType(const std::string &type, LogStream *l, bool autoclose);
 223
 224         /** Removes a logstream from the core. After removal, it will not recieve further events.
 225          * If the LogStream was ever added with autoclose, it will be closed after this call (this means the pointer won't be valid anymore).
 226          */
 227         void DelLogStream(LogStream* l);
 228
 229         /** 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.
 230          * 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).
 231          */
 232         bool DelLogType(const std::string &type, LogStream *l);
 233
 234         /** Logs an event, sending it to all LogStreams registered for the type.
 235          * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
 236          * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
 237          * @param msg The message to be logged (literal).
 238          */
 239         void Log(const std::string &type, int loglevel, const std::string &msg);
 240
 241         /** Logs an event, sending it to all LogStreams registered for the type.
 242          * @param type Log message type (ex: "USERINPUT", "MODULE", ...)
 243          * @param loglevel Log message level (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE)
 244          * @param msg The format of the message to be logged. See your C manual on printf() for details.
 245          */
 246         void Log(const std::string &type, int loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5);
 247 };
 248
 249 #endif