include/logger.h

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