ucw/log.h

   1 /*
   2  *      UCW Library -- Logging
   3  *
   4  *      (c) 1997--2009 Martin Mares <mj@ucw.cz>
   5  *      (c) 2008 Tomas Gavenciak <gavento@ucw.cz>
   6  *
   7  *      This software may be freely distributed and used according to the terms
   8  *      of the GNU Lesser General Public License.
   9  */
  10
  11 #ifndef _UCW_LOG_H_
  12 #define _UCW_LOG_H_
  13
  14 #include "ucw/clists.h"
  15
  16 /*** === Messages and streams ***/
  17
  18 /**
  19  * Inside the logging system, a log message is always represented by this structure.
  20  **/
  21 struct log_msg {
  22   char *m;                              // The formatted message itself, ending with \n\0
  23   int m_len;                            // Length without the \0
  24   struct tm *tm;                        // Current time
  25   uns flags;                            // Category and other flags as passed to msg()
  26   char *raw_msg;                        // Unformatted parts
  27   char *stime;
  28   char *sutime;
  29 };
  30
  31 /**
  32  * Each stream is represented by an instance of this structure.
  33  **/
  34 struct log_stream {
  35   char *name;                           // Optional name, allocated by the user (or constructor)
  36   int regnum;                           // Stream number, already encoded by LS_SET_STRNUM(); -1 if closed
  37   uns levels;                           // Bitmask of accepted severity levels (default: all)
  38   uns types;                            // Bitmask of accepted message types (default: all)
  39   uns msgfmt;                           // Formatting flags (LSFMT_xxx)
  40   uns use_count;                        // Number of references to the stream
  41   uns stream_flags;                     // Various other flags (LSFLAG_xxx)
  42   int (*filter)(struct log_stream* ls, struct log_msg *m);      // Filter function, return non-zero to discard the message
  43   clist substreams;                     // Pass the message to these streams (simple_list of pointers)
  44   int (*handler)(struct log_stream *ls, struct log_msg *m);     // Called to commit the message, return 0 for success, errno on error
  45   void (*close)(struct log_stream* ls); // Called upon log_close_stream()
  46   // Private data of the handler follow
  47 };
  48
  49 /**
  50  * Formatting flags specifying the format of the message passed to the handler.
  51  **/
  52 enum ls_fmt {
  53   LSFMT_LEVEL =         1,              // severity level (one letter) */
  54   LSFMT_TIME =          2,              // date and time (YYYY-mm-dd HH:MM:SS) */
  55   LSFMT_USEC =          4,              // also micro-seconds */
  56   LSFMT_TITLE =         8,              // program title (log_title) */
  57   LSFMT_PID =           16,             // program PID (log_pid) */
  58   LSFMT_LOGNAME =       32,             // name of the log_stream */
  59   LSFMT_TYPE =          64,             // message type
  60 };
  61
  62 #define LSFMT_DEFAULT (LSFMT_LEVEL | LSFMT_TIME | LSFMT_TITLE | LSFMT_PID)      /** Default format **/
  63
  64 /**
  65  * General stream flags.
  66  **/
  67 enum ls_flag {
  68   LSFLAG_ERR_IS_FATAL = 1,              // When a logging error occurs, die() immediately
  69   LSFLAG_ERR_REPORTED = 2,              // A logging error has been already reported on this stream
  70 };
  71
  72 /***
  73  * === Message flags
  74  *
  75  * The @flags parameter of msg() is divided to several groups of bits (from the LSB):
  76  * message severity level (`L_xxx`), destination stream, message type
  77  * and control bits (e.g., `L_SIGHANDLER`).
  78  ***/
  79
  80 enum ls_flagbits {                      // Bit widths of groups
  81   LS_LEVEL_BITS =       8,
  82   LS_STRNUM_BITS =      16,
  83   LS_TYPE_BITS =        5,
  84   LS_CTRL_BITS =        3,
  85 };
  86
  87 enum ls_flagpos {                       // Bit positions of groups
  88   LS_LEVEL_POS =        0,
  89   LS_STRNUM_POS =       LS_LEVEL_POS + LS_LEVEL_BITS,
  90   LS_TYPE_POS =         LS_STRNUM_POS + LS_STRNUM_BITS,
  91   LS_CTRL_POS =         LS_TYPE_POS + LS_TYPE_BITS,
  92 };
  93
  94 enum ls_flagmasks {                     // Bit masks of groups
  95   LS_LEVEL_MASK =       ((1 << LS_LEVEL_BITS) - 1) << LS_LEVEL_POS,
  96   LS_STRNUM_MASK =      ((1 << LS_STRNUM_BITS) - 1) << LS_STRNUM_POS,
  97   LS_TYPE_MASK =        ((1 << LS_TYPE_BITS) - 1) << LS_TYPE_POS,
  98   LS_CTRL_MASK =        ((1 << LS_CTRL_BITS) - 1) << LS_CTRL_POS,
  99 };
 100
 101 // "Get" macros (break flags to parts)
 102 #define LS_GET_LEVEL(flags)     (((flags) & LS_LEVEL_MASK) >> LS_LEVEL_POS)     /** Extract severity level **/
 103 #define LS_GET_STRNUM(flags)    (((flags) & LS_STRNUM_MASK) >> LS_STRNUM_POS)   /** Extract stream number **/
 104 #define LS_GET_TYPE(flags)      (((flags) & LS_TYPE_MASK) >> LS_TYPE_POS)       /** Extract message type **/
 105 #define LS_GET_CTRL(flags)      (((flags) & LS_CTRL_MASK) >> LS_CTRL_POS)       /** Extract control bits **/
 106
 107 // "Set" macros (parts to flags)
 108 #define LS_SET_LEVEL(level)     ((level) << LS_LEVEL_POS)                       /** Convert severity level to flags **/
 109 #define LS_SET_STRNUM(strnum)   ((strnum) << LS_STRNUM_POS)                     /** Convert stream number to flags **/
 110 #define LS_SET_TYPE(type)       ((type) << LS_TYPE_POS)                         /** Convert message type to flags **/
 111 #define LS_SET_CTRL(ctrl)       ((ctrl) << LS_CTRL_POS)                         /** Convert control bits to flags **/
 112
 113 /** Register a new message type and return the corresponding flag set (encoded by `LS_SET_TYPE`). **/
 114 int log_register_type(const char *name);
 115
 116 /** Find a message type by name and return the corresponding flag set. Returns -1 if no such type found. **/
 117 int log_find_type(const char *name);
 118
 119 /** Given a flag set, extract the message type ID and return its name. **/
 120 char *log_type_name(uns flags);
 121
 122 /*** === Operations on streams ***/
 123
 124 /**
 125  * Allocate a new log stream with no handler and an empty substream list.
 126  * Since struct log_stream is followed by private data, @size bytes of memory are allocated
 127  * for the whole structure. See below for functions creating specific stream types.
 128  **/
 129 struct log_stream *log_new_stream(size_t size);
 130
 131 /**
 132  * Decrement the use count of a stream. If it becomes zero, close the stream,
 133  * free its memory, and unlink all its substreams.
 134  **/
 135 int log_close_stream(struct log_stream *ls);
 136
 137 /**
 138  * Get a new reference on an existing stream. For convenience, the return value is
 139  * equal to the argument @ls.
 140  **/
 141 static inline struct log_stream *log_ref_stream(struct log_stream *ls)
 142 {
 143   ls->use_count++;
 144   return ls;
 145 }
 146
 147 /**
 148  * Link a substream to a stream. The substream gains a reference, preventing
 149  * it from being freed until it is unlinked.
 150  **/
 151 void log_add_substream(struct log_stream *where, struct log_stream *what);
 152
 153 /**
 154  * Unlink all occurrences of a substream @what from stream @where. Each
 155  * occurrence loses a reference. If @what is NULL, all substreams are unlinked.
 156  * Returns the number of unlinked substreams.
 157  **/
 158 int log_rm_substream(struct log_stream *where, struct log_stream *what);
 159
 160 /**
 161  * Set formatting flags of a given stream and all its substreams. The flags are
 162  * AND'ed with @mask and OR'ed with @data.
 163  **/
 164 void log_set_format(struct log_stream *ls, uns mask, uns data);
 165
 166 /**
 167  * Find a stream by its registration number (in the format of logging flags).
 168  * Returns NULL if there is no such stream.
 169  **/
 170 struct log_stream *log_stream_by_flags(uns flags);
 171
 172 /** Return a pointer to the default stream (stream #0). **/
 173 static inline struct log_stream *log_default_stream(void)
 174 {
 175   return log_stream_by_flags(0);
 176 }
 177
 178 /**
 179  * Close all open streams, un-initialize the module, free all memory and
 180  * reset the logging mechanism to use stderr only.
 181  **/
 182 void log_close_all(void);
 183
 184 /***
 185  * === Logging to files
 186  *
 187  * All log files are open in append mode, which guarantees atomicity of write()
 188  * even in multi-threaded programs.
 189  ***/
 190
 191 struct log_stream *log_new_file(const char *path);              /** Create a stream bound to a log file. **/
 192 struct log_stream *log_new_fd(int fd);                          /** Create a stream bound to a file descriptor. **/
 193
 194 /**
 195  * When a time-based name of the log file changes, the logger switches to a new
 196  * log file automatically. This can be sometimes inconvenient, so you can use
 197  * this function to disable the automatic switches. The calls to this function
 198  * can be nested.
 199  **/
 200 void log_switch_disable(void);
 201 void log_switch_enable(void);           /** Negate the effect of log_switch_disable(). **/
 202 int log_switch(void);                   /** Switch log files manually. **/
 203
 204 /***
 205  * === Logging to syslog
 206  *
 207  * This log stream uses the libc interface to the system logging daemon (`syslogd`).
 208  * This interface has several limitations:
 209  *
 210  *   * Syslog are poorer than our scheme, so they are translated with a slight
 211  *     loss of information (most importantly, the distinction between local and
 212  *     remote messages is lost). If you are interested in details, search the
 213  *     source for syslog_level().
 214  *   * Syslog options (especially logging of PID with each message) must be fixed
 215  *     during initialization of the logger
 216  *   * Syslog provides its own formatting, so we turn off all formatting flags
 217  *     of the LibUCW logger. You can override this manually by setting the @msgfmt
 218  *     field of the log stream, but the result won't be nice.
 219  *   * Syslog does not support timestamps with sub-second precision.
 220  ***/
 221
 222 /**
 223  * Create a log stream for logging to a selected syslog facility.
 224  * The @options are passed to openlog(). (Beware, due to limitations of the
 225  * syslog interface in libc, the @options are shared for all syslog streams
 226  * and they are applied when the first stream is created.)
 227  **/
 228 struct log_stream *log_new_syslog(const char *facility, int options);
 229
 230 /**
 231  * Verify that a facility of the given name exists. Return 1 if it does, 0 otherwise.
 232  **/
 233 int log_syslog_facility_exists(const char *facility);
 234
 235 /***
 236  * === Configuring log streams
 237  *
 238  * If you use the LibUCW mechanism for parsing config files, you can let your
 239  * user configure arbitrary log streams in the Logging section of the config file
 240  * (see examples in the default config file). LibUCW automatically verifies that
 241  * the configuration is consistent (this is performed in the commit hook of the
 242  * config section), but it opens the streams only upon request. The following
 243  * functions can be used to control that.
 244  ***/
 245
 246 /** Open a log stream configured under the specified name and increase its use count. **/
 247 struct log_stream *log_new_configured(const char *name);
 248
 249 /** Open a log stream configured under the specified name and use it as the default destination. **/
 250 void log_configured(const char *name);
 251
 252 /**
 253  * Verify that a stream called @name was configured. If it wasn't, return an error
 254  * message. This is intended to be used in configuration commit hooks.
 255  **/
 256 char *log_check_configured(const char *name);
 257
 258 #endif