X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Flogger.h;h=6af842b791b11384150c7677baac24b601a199be;hb=b0f16081ccaef527ed4b5434a7264508cf455f39;hp=754fa26e8181f59d1ca7576e6cd97fbf073ef29d;hpb=36bccc570006216a144e2b15e898f2a65a1e7814;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/logger.h b/include/logger.h index 754fa26e8..6af842b79 100644 --- a/include/logger.h +++ b/include/logger.h @@ -1,67 +1,63 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2014 Attila Molnar + * Copyright (C) 2012-2013, 2017 Sadie Powell + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2010 Craig Edwards + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2008, 2012 Robin Burchell + * Copyright (C) 2008 Thomas Stagner * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * --------------------------------------------------- + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __LOGMANAGER_H -#define __LOGMANAGER_H - -/** This class implements a nonblocking writer. - * Most people writing an ircd give little thought to their disk - * i/o. On a congested system, disk writes can block for long - * periods of time (e.g. if the system is busy and/or swapping - * a lot). If we just use a blocking fprintf() call, this could - * block for undesirable amounts of time (half of a second through - * to whole seconds). We DO NOT want this, so we make our logfile - * nonblocking and hook it into the SocketEngine. - * NB: If the operating system does not support nonblocking file - * I/O (linux seems to, as does freebsd) this will default to - * blocking behaviour. + +#pragma once + +/** Levels at which messages can be logged. */ +enum LogLevel +{ + LOG_RAWIO = 5, + LOG_DEBUG = 10, + LOG_VERBOSE = 20, + LOG_DEFAULT = 30, + LOG_SPARSE = 40, + LOG_NONE = 50 +}; + +/** Simple wrapper providing periodic flushing to a disk-backed file. */ -class CoreExport FileWriter : public EventHandler +class CoreExport FileWriter { protected: - /** The creator/owner of this object - */ - InspIRCd* ServerInstance; - /** The log file (fd is inside this somewhere, * we get it out with fileno()) */ FILE* log; - /** Buffer of pending log lines to be written + /** The number of write operations after which we should flush. */ - std::string buffer; + unsigned int flush; - /** Number of write operations that have occured + /** Number of write operations that have occurred */ - int writeops; + unsigned int writeops; public: /** The constructor takes an already opened logfile. */ - FileWriter(InspIRCd* Instance, FILE* logfile); - - /** This returns false, logfiles are writeable. - */ - virtual bool Readable(); - - /** Handle pending write events. - * This will flush any waiting data to disk. - * If any data remains after the fprintf call, - * another write event is scheduled to write - * the rest of the data when possible. - */ - virtual void HandleEvent(EventType et, int errornum = 0); + FileWriter(FILE* logfile, unsigned int flushcount); /** Write one or more preformatted log lines. * If the data cannot be written immediately, @@ -74,11 +70,6 @@ class CoreExport FileWriter : public EventHandler /** Close the log file and cancel any events. */ - virtual void Close(); - - /** Close the log file and cancel any events. - * (indirectly call Close() - */ virtual ~FileWriter(); }; @@ -97,7 +88,7 @@ class CoreExport FileWriter : public EventHandler * can go to a channel as well as a file. * * HOW THIS WORKS - * LogManager handles all instances of LogStreams, LogStreams (or more likely, derived classes) are instantiated and passed to it. + * LogManager handles all instances of LogStreams, classes derived from LogStream are instantiated and passed to it. */ /** LogStream base class. Modules (and other stuff) inherit from this to decide what logging they are interested in, and what to do with it. @@ -105,50 +96,64 @@ class CoreExport FileWriter : public EventHandler class CoreExport LogStream : public classbase { protected: - InspIRCd *ServerInstance; - int loglvl; + LogLevel loglvl; public: - LogStream(InspIRCd *Instance, int loglevel) : loglvl(loglevel) + static const char LogHeader[]; + + LogStream(LogLevel loglevel) : loglvl(loglevel) { - this->ServerInstance = Instance; } + /* 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 + * in the event that the resource is shared, see for example FileLogStream). + */ virtual ~LogStream() { } - /** XXX document me properly. - * Used for on the fly changing of loglevel. + /** Changes the loglevel for this LogStream on-the-fly. + * This is needed for -nofork. But other LogStreams could use it to change loglevels. */ - void ChangeLevel(int lvl) { this->loglvl = lvl; } + void ChangeLevel(LogLevel lvl) { this->loglvl = lvl; } /** Called when there is stuff to log for this particular logstream. The derived class may take no action with it, or do what it * wants with the output, basically. loglevel and type are primarily for informational purposes (the level and type of the event triggered) * and msg is, of course, the actual message to log. */ - virtual void OnLog(int loglevel, const std::string &type, const std::string &msg) = 0; + virtual void OnLog(LogLevel loglevel, const std::string &type, const std::string &msg) = 0; }; typedef std::map FileLogMap; -class CoreExport LogManager : public classbase +class CoreExport LogManager : public fakederef { private: - bool Logging; // true when logging, avoids recursion - LogStream* noforkstream; // LogStream for nofork. - InspIRCd *ServerInstance; + /** Lock variable, set to true when a log is in progress, which prevents further logging from happening and creating a loop. + */ + bool Logging; + + /** Map of active log types and what LogStreams will receive them. + */ std::map > LogStreams; - std::map AllLogStreams; // holds all logstreams - std::vector GlobalLogStreams; //holds all logstreams with a type of * - FileLogMap FileLogs; // Holds all file logs, refcounted - public: - LogManager(InspIRCd *Instance) - { - ServerInstance = Instance; - Logging = false; - } - void SetupNoFork(); + /** Refcount map of all LogStreams managed by LogManager. + * 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. + */ + std::map AllLogStreams; + + /** LogStreams with type * (which means everything), and a list a logtypes they are excluded from (eg for "* -USERINPUT -USEROUTPUT"). + */ + std::map > GlobalLogStreams; - /** XXX document me properly. */ + /** Refcounted map of all FileWriters in use by FileLogStreams, for file stream sharing. + */ + FileLogMap FileLogs; + + public: + LogManager(); + ~LogManager(); + + /** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance. + * Used for file-stream sharing for FileLogStreams. + */ void AddLoggerRef(FileWriter* fw) { FileLogMap::iterator i = FileLogs.find(fw); @@ -162,7 +167,8 @@ class CoreExport LogManager : public classbase } } - /** XXX document me properly. */ + /** Indicates that a FileWriter reference has been removed. Reference count is decreased, and if zeroed, the FileWriter is closed. + */ void DelLoggerRef(FileWriter* fw) { FileLogMap::iterator i = FileLogs.find(fw); @@ -174,35 +180,54 @@ class CoreExport LogManager : public classbase } } - /** XXX document me properly. */ - void OpenSingleFile(FILE* f, const std::string& type, int loglevel); - - /** XXX document me properly. */ + /** Opens all logfiles defined in the configuration file using \. + */ void OpenFileLogs(); - - /** Gives all logstreams a chance to clear up (in destructors) while it deletes them. + + /** Removes all LogStreams, meaning they have to be readded for logging to continue. + * Only LogStreams that were listed in AllLogStreams are actually closed. */ void CloseLogs(); - + + /** Adds a single LogStream to multiple logtypes. + * This automatically handles things like "* -USERINPUT -USEROUTPUT" to mean all but USERINPUT and USEROUTPUT types. + * It is not a good idea to mix values of autoclose for the same LogStream. + * @param type The type string (from configuration, or whatever) to parse. + * @param l The LogStream to add. + * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open. + */ + void AddLogTypes(const std::string &type, LogStream *l, bool autoclose); + /** Registers a new logstream into the logging core, so it can be called for future events - * XXX document me properly. + * It is not a good idea to mix values of autoclose for the same LogStream. + * @param type The type to add this LogStream to. + * @param l The LogStream to add. + * @param autoclose True to have the LogStream automatically closed when all references to it are removed from LogManager. False to leave it open. + * @return True if the LogStream was added successfully, False otherwise. */ bool AddLogType(const std::string &type, LogStream *l, bool autoclose); - - /** Removes a logstream from the core. After removal, it will not recieve further events. + + /** Removes a logstream from the core. After removal, it will not receive further events. + * If the LogStream was ever added with autoclose, it will be closed after this call (this means the pointer won't be valid anymore). */ void DelLogStream(LogStream* l); - - /** XXX document me properly. */ + + /** 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. + * 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). + */ bool DelLogType(const std::string &type, LogStream *l); - - /** Pretty self explanatory. + + /** Logs an event, sending it to all LogStreams registered for the type. + * @param type Log message type (ex: "USERINPUT", "MODULE", ...) + * @param loglevel Log message level (LOG_DEBUG, LOG_VERBOSE, LOG_DEFAULT, LOG_SPARSE, LOG_NONE) + * @param msg The message to be logged (literal). */ - void Log(const std::string &type, int loglevel, const std::string &msg); - - /** Duh. + void Log(const std::string &type, LogLevel loglevel, const std::string &msg); + + /** Logs an event, sending it to all LogStreams registered for the type. + * @param type Log message type (ex: "USERINPUT", "MODULE", ...) + * @param loglevel Log message level (LOG_DEBUG, LOG_VERBOSE, LOG_DEFAULT, LOG_SPARSE, LOG_NONE) + * @param fmt The format of the message to be logged. See your C manual on printf() for details. */ - void Log(const std::string &type, int loglevel, const char *fmt, ...); + void Log(const std::string &type, LogLevel loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5); }; - -#endif