ucw/log-stream.c

   1 /*
   2  *      UCW Library -- Logging: Management of Log Streams
   3  *
   4  *      (c) 2008 Tomas Gavenciak <gavento@ucw.cz>
   5  *      (c) 2009 Martin Mares <mj@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 #include "ucw/lib.h"
  12 #include "ucw/log.h"
  13 #include "ucw/simple-lists.h"
  14
  15 #include <string.h>
  16
  17 /* Initial number of streams to allocate (must be >=2) */
  18 #define LS_INIT_STREAMS 8
  19
  20 /* Flag indicating initialization of the module */
  21 static int log_initialized = 0;
  22
  23 /* The head of the list of freed log_streams indexes in log_streams.ptr (-1 if none free).
  24  * Freed positions in log_streams.ptr are connected into a linked list in the following way:
  25  * log_streams.ptr[log_streams_free].idata is the index of next freed position (or -1) */
  26 static int log_streams_free = -1;
  27
  28 /* Initialize the logstream module.
  29  * It is not neccessary to call this explicitely as it is called by
  30  * the first log_new_stream()  (for backward compatibility and ease of use). */
  31 static void
  32 log_init_module(void)
  33 {
  34   if (log_initialized)
  35     return;
  36
  37   /* Create the growing array */
  38   lsbuf_init(&log_streams);
  39   lsbuf_set_size(&log_streams, LS_INIT_STREAMS);
  40
  41   bzero(log_streams.ptr, sizeof(struct log_stream*) * (log_streams.len));
  42   log_streams_free = -1;
  43
  44   log_initialized = 1;
  45
  46   /* init the default stream (0) as forwarder to fd2 */
  47   struct log_stream *ls = log_new_stream();
  48   ASSERT(ls == log_streams.ptr[0]);
  49   ASSERT(ls->regnum == 0);
  50   ls->name = "default";
  51   log_add_substream(ls, (struct log_stream *) &log_stream_default);
  52 }
  53
  54 /* Close all open streams, un-initialize the module, free all memory,
  55  * and fall back to using only log_stream_default. */
  56 void
  57 log_close_all(void)
  58 {
  59   if (!log_initialized)
  60     return;
  61
  62   for (int i=0; i < log_streams_after; i++)
  63     {
  64       if (log_streams.ptr[i]->regnum >= 0)
  65         log_close_stream(log_streams.ptr[i]);
  66       xfree(log_streams.ptr[i]);
  67     }
  68
  69   /* Back to the default state */
  70   lsbuf_done(&log_streams);
  71   log_streams_after = 0;
  72   log_streams_free = -1;
  73   log_initialized = 0;
  74 }
  75
  76 /* Add a new substream, xmalloc()-ate a new simp_node. */
  77 void
  78 log_add_substream(struct log_stream *where, struct log_stream *what)
  79 {
  80   ASSERT(where);
  81   ASSERT(what);
  82
  83   simp_node *n = xmalloc(sizeof(simp_node));
  84   n->p = what;
  85   clist_add_tail(&where->substreams, &n->n);
  86 }
  87
  88 /* Remove all occurences of a substream, xfree() the simp_node. */
  89 /* Return the number of deleted entries. */
  90 int
  91 log_rm_substream(struct log_stream *where, struct log_stream *what)
  92 {
  93   void *tmp;
  94   int cnt = 0;
  95   ASSERT(where);
  96   ASSERT(what);
  97
  98   CLIST_FOR_EACH_DELSAFE(simp_node *, i, where->substreams, tmp)
  99     if (i->p == what)
 100       {
 101         clist_remove(&i->n);
 102         xfree(i);
 103         cnt++;
 104       }
 105   return cnt;
 106 }
 107
 108 /* Return a pointer to a new stream with no handler and an empty substream list. */
 109 struct log_stream *
 110 log_new_stream(void)
 111 {
 112   struct log_stream *l;
 113   int index;
 114
 115   /* Initialize the data structures if needed */
 116   log_init_module();
 117
 118   /* Get a free stream, possibly recycling a closed one */
 119   if (log_streams_free < 0)
 120     {
 121       lsbuf_grow(&log_streams, log_streams_after+1);
 122       index = log_streams_after++;
 123       l = log_streams.ptr[index] = xmalloc(sizeof(struct log_stream));
 124     }
 125   else
 126     {
 127       index = log_streams_free;
 128   l = log_streams.ptr[index];
 129       log_streams_free = l->idata;
 130     }
 131
 132   /* Initialize the stream */
 133   bzero(l, sizeof(*l));
 134   l->levels = LS_ALL_LEVELS;
 135   l->regnum = LS_SET_STRNUM(index);
 136   clist_init(&l->substreams);
 137   return l;
 138 }
 139
 140 /* Close a stream, unlink (but do not close) all its substreams */
 141 void
 142 log_close_stream(struct log_stream *ls)
 143 {
 144   void *tmp;
 145   ASSERT(ls);
 146
 147   /* xfree() all the simp_nodes from substreams */
 148   CLIST_FOR_EACH_DELSAFE(simp_node *, i, ls->substreams, tmp)
 149     {
 150       clist_remove(&i->n);
 151       xfree(i);
 152     }
 153
 154   /* Close the stream and add it to the free-list */
 155   if (ls->close)
 156     ls->close(ls);
 157   ls->idata = log_streams_free;
 158   log_streams_free = LS_GET_STRNUM(ls->regnum);
 159   ls->regnum = -1;
 160 }