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