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 /* user de/allocated program/process name for use in the logsystem */
  17 extern char *ls_title;
  18
  19 struct log_stream
  20 {
  21   /* optional name, 0-term, de/allocated by constr./destr. or user */
  22   char *name;
  23   /* number for use with msg parameter (from LS_SET_STRNUM()), -1 for closed log_stream */
  24   int regnum;
  25   /* arbitrary data for filter/handler */
  26   int idata;
  27   void *pdata;
  28   uns udata;
  29   /* severity levels to accept - bitmask of (1<<LEVEL) */
  30   int levels;
  31   /* if filter returns nonzero, discard the message */
  32   int (*filter)(struct log_stream* ls, const char *m, uns cat);
  33   /* pass the message to these streams (simple-list of pointers) */
  34   struct clist substreams;
  35   /* what kind of string to format to pass to the handler (bitmask of LSFMT_xxx ) */
  36   int msgfmt;
  37   /* what to do to commit the message (ret 0 on success, nonzero on error)
  38    * msg is 0-term string, with desired info, one line, ending with "\n\0". */
  39   int (*handler)(struct log_stream* ls, const char *m, uns cat);
  40   /* close the log_stream file/connection */
  41   void (*close)(struct log_stream* ls);
  42 };
  43
  44 /* the default logger */
  45 extern const struct log_stream log_stream_default;
  46
  47 /* A message is processed as follows:
  48  *  1. Discard if message level not in levels
  49  *  2. Run filter (if any), discard if ret. nonzero
  50  *  3. Pass the message to all log_streams in substreams
  51  *  4. Format the message informaion acc. to msgfmt
  52  *  5. Run the handler
  53  */
  54
  55 /* log header verbosity specifying message passed to handler */
  56 enum ls_fmt
  57 {
  58   LSFMT_LEVEL=1,       /* log severity level (one letter) */
  59   LSFMT_TIME=2,        /* log time (date-seconds) */
  60   LSFMT_USEC=4,        /* log also micro-seconds */
  61   LSFMT_TITLE=8,       /* log program title (global string) */
  62   LSFMT_PID=16,        /* log program PID */
  63   LSFMT_LOGNAME=32,    /* log log_stream name */
  64   LSFMT_NONE=0,
  65   LSFMT_FULL=LSFMT_LEVEL+LSFMT_TIME+LSFMT_USEC+LSFMT_TITLE+LSFMT_PID+LSFMT_LOGNAME,
  66   LSFMT_DEFAULT=LSFMT_LEVEL+LSFMT_TIME
  67 };
  68
  69 /* Mask of containing all existing levels. */
  70 #define LS_ALL_LEVELS 0xfff
  71
  72 // return the letter associated with the severity level
  73 #define LS_LEVEL_LETTER(level) ("DIiWwEe!###"[( level )])
  74
  75 ///// Macros for extracting parts of the flags parameter
  76 // The division of the flags parameter is decided only here
  77 // The current division is (for 32 bit flags):
  78 // MSB <5 bits: any internal log flags> <8 bits: "user" flags> <10 bits: stream number>
  79 //     <8 bits: severity level> LSB
  80
  81 // Bits per section
  82 enum ls_flagbits {
  83   LS_LEVEL_BITS    = 8,
  84   LS_STRNUM_BITS   = 16,
  85   LS_FLAGS_BITS    = 5,
  86   LS_INTERNAL_BITS = 4,
  87 };
  88
  89 // Section shifts
  90 enum ls_flagpos {
  91   LS_LEVEL_POS     = 0,
  92   LS_STRNUM_POS    = LS_LEVEL_POS + LS_LEVEL_BITS,
  93   LS_FLAGS_POS     = LS_STRNUM_POS + LS_STRNUM_BITS,
  94   LS_INTERNAL_POS  = LS_FLAGS_POS + LS_FLAGS_BITS,
  95 };
  96
  97 // Bitmasks
  98 enum ls_flagmasks {
  99   LS_LEVEL_MASK    = (( 1 << LS_LEVEL_BITS ) - 1 ) << LS_LEVEL_POS,
 100   LS_STRNUM_MASK   = (( 1 << LS_STRNUM_BITS ) - 1 ) << LS_STRNUM_POS,
 101   LS_FLAGS_MASK    = (( 1 << LS_FLAGS_BITS ) - 1 ) << LS_FLAGS_POS,
 102   LS_INTERNAL_MASK = (( 1 << LS_INTERNAL_BITS ) - 1 ) << LS_INTERNAL_POS,
 103 };
 104
 105 // "Get" macros (break flags to parts)
 106 #define LS_GET_LEVEL(flags)     ((( flags ) & LS_LEVEL_MASK ) >> LS_LEVEL_POS )
 107 #define LS_GET_STRNUM(flags)    ((( flags ) & LS_STRNUM_MASK ) >> LS_STRNUM_POS )
 108 #define LS_GET_FLAGS(flags)     ((( flags ) & LS_FLAGS_MASK ) >> LS_FLAGS_POS )
 109 #define LS_GET_INTERNAL(flags)  ((( flags ) & LS_INTERNAL_MASK ) >> LS_INTERNAL_POS )
 110
 111 // "Set" macros (parts to flags)
 112 #define LS_SET_LEVEL(level)     (( level ) << LS_LEVEL_POS )
 113 #define LS_SET_STRNUM(strnum)   (( strnum ) << LS_STRNUM_POS )
 114 #define LS_SET_FLAGS(flags)     (( flags ) << LS_FLAGS_POS )
 115 #define LS_SET_INTERNAL(intern) (( intern ) << LS_INTERNAL_POS )
 116
 117 // Internal flags of the logsystem
 118 // Avoid operations that are unsafe in signal handlers
 119 #define LSFLAG_SIGHANDLER LS_SET_INTERNAL(0x001)
 120
 121 // The module is initialized when a first stream is created.
 122 // Before that only the default stream exists.
 123
 124 /* Return pointer a new (xmalloc()-ated) stream with no handler and an empty substream list. */
 125 struct log_stream *log_new_stream(void);
 126
 127 /* Close and xfree() given log_stream */
 128 /* Does not affect substreams */
 129 void log_close_stream(struct log_stream *ls);
 130
 131 /* close all open streams, un-initialize the module, free all memory,
 132  * use only ls_default_log */
 133 void log_close_all(void);
 134
 135 /* add a new substream, xmalloc()-ate a new simp_node */
 136 void log_add_substream(struct log_stream *where, struct log_stream *what);
 137
 138 /* remove all occurences of a substream, free() the simp_node */
 139 /* return number of deleted entries */
 140 int log_rm_substream(struct log_stream *where, struct log_stream *what);
 141
 142 /* get a stream by its number (regnum) */
 143 /* returns NULL for free numbers */
 144 /* defaults to ls_default_stream for 0 when stream number 0 not set */
 145 struct log_stream *log_stream_by_flags(uns flags);
 146
 147 /* process a message (string) (INTERNAL) */
 148 /* depth prevents undetected looping */
 149 /* returns 1 in case of loop detection or other fatal error
 150  *         0 otherwise */
 151 int log_pass_msg(int depth, struct log_stream *ls, const char *stime, const char *sutime,
 152     const char *msg, uns cat);
 153
 154 /* Define an array (growing buffer) for pointers to log_streams. */
 155 #define GBUF_TYPE struct log_stream*
 156 #define GBUF_PREFIX(x) lsbuf_##x
 157 #include "ucw/gbuf.h"
 158
 159 extern struct lsbuf_t log_streams;
 160 extern int log_streams_after;
 161
 162 /********* Individual handler types (constructors, handlers, destructors) */
 163
 164 /**** standard (filedes) files */
 165
 166 // NOTE:
 167 // under unix, for ordinary files open in append mode, the writes
 168 // are atomic (unless you meet the quota or other bad things happen),
 169 // so using a single log_stream is thread-safe and the file can be shared
 170 // among multiple processes
 171
 172 /* assign log to a file descriptor */
 173 /* initialize with the default formatting, does NOT close the descriptor */
 174 struct log_stream *log_new_fd(int fd);
 175
 176 /* open() a file (append mode) */
 177 /* initialize with the default formatting */
 178 struct log_stream *log_new_file(const char *path);
 179
 180
 181 /**** syslog */
 182
 183 // NOTE:
 184 // The syslog uses a bit different severity levels, for details, see
 185 // ls_syslog_convert_level().
 186 // syslog also prepends it's own time and severity info, so the default
 187 // messaging passes only clean message
 188
 189 /* assign log to a syslog facility */
 190 /* initialize with no formatting (syslog adds these inforamtion) */
 191 /* name is optional prefix (NULL for none) */
 192 struct log_stream *log_new_syslog(int facility, const char *name);
 193
 194 #endif