X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Flogger.h;h=6af842b791b11384150c7677baac24b601a199be;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=709d00aed92bd28d1784995f58e45ba52b81d930;hpb=93a78a57ada6d5dab410c2bd3c4b02f4fa15684c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/logger.h b/include/logger.h index 709d00aed..6af842b79 100644 --- a/include/logger.h +++ b/include/logger.h @@ -1,32 +1,44 @@ -/* +------------------------------------+ - * | 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-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/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 log file (fd is inside this somewhere, @@ -34,22 +46,18 @@ class CoreExport FileWriter : public EventHandler */ FILE* log; - /** Number of write operations that have occured + /** The number of write operations after which we should flush. */ - int writeops; + unsigned int flush; - public: - /** The constructor takes an already opened logfile. + /** Number of write operations that have occurred */ - FileWriter(FILE* logfile); + unsigned int writeops; - /** 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. + public: + /** The constructor takes an already opened logfile. */ - 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, @@ -60,10 +68,6 @@ class CoreExport FileWriter : public EventHandler */ void WriteLogLine(const std::string &line); - /** Close the log file and cancel any events. - */ - virtual void Close(); - /** Close the log file and cancel any events. */ virtual ~FileWriter(); @@ -92,9 +96,11 @@ class CoreExport FileWriter : public EventHandler class CoreExport LogStream : public classbase { protected: - int loglvl; + LogLevel loglvl; public: - LogStream(int loglevel) : loglvl(loglevel) + static const char LogHeader[]; + + LogStream(LogLevel loglevel) : loglvl(loglevel) { } @@ -106,28 +112,24 @@ class CoreExport LogStream : public classbase /** 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: - /** Lock variable, set to true when a log is in progress, which prevents further loggging from happening and creating a loop. + /** Lock variable, set to true when a log is in progress, which prevents further logging from happening and creating a loop. */ bool Logging; - /** LogStream for -nofork, logs to STDOUT when it's active. - */ - LogStream* noforkstream; - /** Map of active log types and what LogStreams will receive them. */ std::map > LogStreams; @@ -146,25 +148,8 @@ class CoreExport LogManager : public classbase FileLogMap FileLogs; public: - - LogManager() - { - noforkstream = NULL; - Logging = false; - } - - ~LogManager() - { - if (noforkstream) - delete noforkstream; - Logging = true; - } - - /** Sets up the logstream for -nofork. Called by InspIRCd::OpenLog() and LogManager::OpenFileLogs(). - * First time called it creates the nofork stream and stores it in noforkstream. Each call thereafter just readds it to GlobalLogStreams - * and updates the loglevel. - */ - void SetupNoFork(); + LogManager(); + ~LogManager(); /** Adds a FileWriter instance to LogManager, or increments the reference count of an existing instance. * Used for file-stream sharing for FileLogStreams. @@ -195,7 +180,7 @@ class CoreExport LogManager : public classbase } } - /** Opens all logfiles defined in the configuration file using . + /** Opens all logfiles defined in the configuration file using \. */ void OpenFileLogs(); @@ -222,7 +207,7 @@ class CoreExport LogManager : public classbase */ 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); @@ -234,17 +219,15 @@ class CoreExport LogManager : public classbase /** 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 (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE) + * @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); + 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 (DEBUG, VERBOSE, DEFAULT, SPARSE, NONE) - * @param msg The format of the message to be logged. See your C manual on printf() for details. + * @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, ...) CUSTOM_PRINTF(4, 5); + void Log(const std::string &type, LogLevel loglevel, const char *fmt, ...) CUSTOM_PRINTF(4, 5); }; - -#endif