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