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/log-internal.h"
  14 #include "ucw/simple-lists.h"
  15
  16 #include <string.h>
  17
  18 /* Initial number of streams to allocate (must be >=2) */
  19 #define LS_INIT_STREAMS 8
  20
  21 /* Flag indicating initialization of the module */
  22 static int log_initialized = 0;
  23
  24 /* The head of the list of freed log_streams indexes in log_streams.ptr (~0U if none free).
  25  * Freed positions in log_streams.ptr are connected into a linked list in the following way:
  26  * log_streams.ptr[log_streams_free].levels is the index of next freed position (or ~0U) */
  27 static uns log_streams_free = ~0U;
  28
  29 /* Initialize the logstream module.
  30  * It is not neccessary to call this explicitely as it is called by
  31  * the first log_new_stream()  (for backward compatibility and ease of use). */
  32 static void
  33 log_init_module(void)
  34 {
  35   if (log_initialized)
  36     return;
  37
  38   /* Create the growing array */
  39   lsbuf_init(&log_streams);
  40   lsbuf_set_size(&log_streams, LS_INIT_STREAMS);
  41
  42   bzero(log_streams.ptr, sizeof(struct log_stream*) * (log_streams.len));
  43   log_streams_free = ~0U;
  44
  45   log_initialized = 1;
  46
  47   /* init the default stream (0) as forwarder to fd2 */
  48   struct log_stream *ls = log_new_stream(sizeof(*ls));
  49   ASSERT(ls == log_streams.ptr[0]);
  50   ASSERT(ls->regnum == 0);
  51   ls->name = "default";
  52   log_add_substream(ls, &log_stream_default);
  53 }
  54
  55 /* Close all open streams, un-initialize the module, free all memory,
  56  * and fall back to using only log_stream_default. */
  57 void
  58 log_close_all(void)
  59 {
  60   if (!log_initialized)
  61     return;
  62
  63   // FIXME!
  64   for (int i=0; i < log_streams_after; i++)
  65     {
  66       if (log_streams.ptr[i]->regnum >= 0)
  67         log_close_stream(log_streams.ptr[i]);
  68       xfree(log_streams.ptr[i]);
  69     }
  70
  71   /* Back to the default state */
  72   lsbuf_done(&log_streams);
  73   log_streams_after = 0;
  74   log_streams_free = ~0U;
  75   log_initialized = 0;
  76 }
  77
  78 /* Add a new substream. The parent stream takes a reference on the substream,
  79  * preventing it from being closed as long as it is linked. */
  80 void
  81 log_add_substream(struct log_stream *where, struct log_stream *what)
  82 {
  83   ASSERT(where);
  84   ASSERT(what);
  85
  86   simp_node *n = xmalloc(sizeof(simp_node));
  87   n->p = log_ref_stream(what);
  88   clist_add_tail(&where->substreams, &n->n);
  89 }
  90
  91 /* Remove all occurrences of a substream together with the references they
  92  * keep. If a substream becomes unreferenced, it is closed. If what is NULL,
  93  * all substreams are removed. Returns the number of deleted entries. */
  94 int
  95 log_rm_substream(struct log_stream *where, struct log_stream *what)
  96 {
  97   void *tmp;
  98   int cnt = 0;
  99   ASSERT(where);
 100
 101   CLIST_FOR_EACH_DELSAFE(simp_node *, i, where->substreams, tmp)
 102     if (i->p == what || !what)
 103       {
 104         clist_remove(&i->n);
 105         log_close_stream(i->p);
 106         xfree(i);
 107         cnt++;
 108       }
 109   return cnt;
 110 }
 111
 112 /* Return a pointer to a new stream with no handler and an empty substream list. */
 113 struct log_stream *
 114 log_new_stream(size_t size)
 115 {
 116   struct log_stream *l;
 117   int index;
 118
 119   /* Initialize the data structures if needed */
 120   log_init_module();
 121
 122   /* Get a free stream, possibly recycling a closed one */
 123   if (log_streams_free == ~0U)
 124     {
 125       lsbuf_grow(&log_streams, log_streams_after+1);
 126       index = log_streams_after++;
 127       l = log_streams.ptr[index] = xmalloc(size);
 128     }
 129   else
 130     {
 131       index = log_streams_free;
 132       l = xrealloc(log_streams.ptr[index], size);
 133       log_streams.ptr[index] = l;
 134       log_streams_free = l->levels;
 135     }
 136
 137   /* Initialize the stream */
 138   bzero(l, sizeof(*l));
 139   l->levels = ~0U;
 140   l->regnum = LS_SET_STRNUM(index);
 141   clist_init(&l->substreams);
 142   return log_ref_stream(l);
 143 }
 144
 145 /* Remove a reference on a stream and close it if it was the last reference.
 146  * Closing automatically unlinks all substreams and closes them if they are
 147  * no longer referenced. Returns 1 if the stream has been really closed. */
 148 int
 149 log_close_stream(struct log_stream *ls)
 150 {
 151   ASSERT(ls);
 152   ASSERT(ls->use_count);
 153   if (--ls->use_count)
 154     return 0;
 155
 156   /* Unlink all subtreams */
 157   log_rm_substream(ls, NULL);
 158
 159   /* Close the stream and add it to the free-list */
 160   if (ls->close)
 161     ls->close(ls);
 162   ls->levels = log_streams_free;
 163   log_streams_free = LS_GET_STRNUM(ls->regnum);
 164   ls->regnum = -1;
 165   return 1;
 166 }
 167
 168 void
 169 log_set_format(struct log_stream *ls, uns mask, uns data)
 170 {
 171   ls->msgfmt = (ls->msgfmt & mask) | data;
 172   CLIST_FOR_EACH(simp_node *, i, ls->substreams)
 173     log_set_format(i->p, mask, data);
 174 }