src/log.c

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: log.c,v 1.21 2005-01-15 19:47:13 adam Exp $
   6  */
   7
   8 /**
   9  * \file log.c
  10  * \brief Implements logging utility
  11  */
  12
  13 #if HAVE_CONFIG_H
  14 #include <config.h>
  15 #endif
  16
  17 #ifdef WIN32
  18 #include <windows.h>
  19 #endif
  20
  21 #if YAZ_POSIX_THREADS
  22 #include <pthread.h>
  23 #endif
  24
  25 #if YAZ_GNU_THREADS
  26 #include <pth.h>
  27 #endif
  28
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <ctype.h>
  32 #include <string.h>
  33 #include <stdarg.h>
  34 #include <errno.h>
  35 #include <time.h>
  36 #include <yaz/nmem.h>
  37 #include <yaz/log.h>
  38 #include <yaz/xmalloc.h>
  39
  40 static NMEM_MUTEX log_mutex = 0;
  41 static int mutex_init_flag = 0; /* not yet initialized */
  42
  43 #define HAS_STRERROR 1
  44
  45 #if HAS_STRERROR
  46
  47 #else
  48 char *strerror(int n)
  49 {
  50     extern char *sys_errlist[];
  51     return sys_errlist[n];
  52 }
  53
  54 #endif
  55
  56
  57
  58 static int l_level = YLOG_DEFAULT_LEVEL;
  59 static FILE *l_file = NULL;
  60 static char l_prefix[512] = "";
  61 static char l_prefix2[512] = "";
  62 static char l_fname[512] = "";
  63
  64 static char l_old_default_format[] = "%H:%M:%S-%d/%m";
  65 static char l_new_default_format[] = "%Y%m%d-%H%M%S";
  66 #define TIMEFORMAT_LEN 50
  67 static char l_custom_format[TIMEFORMAT_LEN] = "";
  68 static char *l_actual_format = l_old_default_format;
  69
  70 /** l_max_size tells when to rotate the log. Default to 1 GB */
  71 static const int l_def_max_size = 1024*1024*1024;
  72 static int l_max_size = 1024*1024*1024;
  73
  74 #define MAX_MASK_NAMES 35   /* 32 bits plus a few combo names */
  75 static struct {
  76     int mask;
  77     char *name;
  78 }  mask_names[MAX_MASK_NAMES] =
  79 {
  80     { YLOG_FATAL,  "fatal"},
  81     { YLOG_DEBUG,  "debug"},
  82     { YLOG_WARN,   "warn" },
  83     { YLOG_LOG,    "log"  },
  84     { YLOG_ERRNO,  ""},
  85     { YLOG_MALLOC, "malloc"},
  86  /*   { YLOG_APP,    "app"  }, */
  87     { YLOG_NOTIME, "notime" },
  88  /*   { YLOG_APP2,   "app2" }, */
  89  /*   { YLOG_APP3,   "app3" }, */
  90     { YLOG_ALL,    "all"  },
  91     { YLOG_FLUSH,  "flush" },
  92     { YLOG_LOGLVL, "loglevel" },
  93     { 0,          "none" },
  94     { 0, NULL }
  95     /* the rest will be filled in if the user defines dynamic modules*/
  96 };
  97 static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
  98
  99 static void init_mutex()
 100 {
 101     if (mutex_init_flag)
 102         return;
 103     nmem_mutex_create (&log_mutex);
 104     mutex_init_flag = 1;
 105 }
 106
 107
 108 FILE *yaz_log_file(void)
 109 {
 110     if (!l_file)
 111         l_file = stderr;
 112     return l_file;
 113 }
 114
 115 void yaz_log_init_file (const char *fname)
 116 {
 117     if (!mutex_init_flag)
 118         init_mutex();
 119     if (fname)
 120     {
 121         strncpy(l_fname, fname, sizeof(l_fname)-1);
 122         l_fname[sizeof(l_fname)-1] = '\0';
 123     }
 124     else
 125         l_fname[0] = '\0';
 126     yaz_log_reopen();
 127 }
 128
 129 void yaz_log_reopen(void)
 130 {
 131     FILE *new_file;
 132     if (!mutex_init_flag)
 133         init_mutex();
 134     if (!l_file)
 135         l_file = stderr;
 136     if (!*l_fname)
 137         new_file = stderr;
 138     else if (!(new_file = fopen(l_fname, "a")))
 139     {
 140         new_file=l_file;
 141         l_file=stderr;  /* just to be sure we don't rotate logs and recurse */
 142         yaz_log(YLOG_WARN|YLOG_ERRNO,"Could not open log file '%s'",l_fname);
 143         l_file=new_file; /* restore to old value, probably stderr as well */
 144         return;
 145     }
 146     if (l_file != stderr)
 147     {
 148         fclose (l_file);
 149     }
 150     if (l_level & YLOG_FLUSH)
 151         setvbuf(new_file, 0, _IONBF, 0);
 152     l_file = new_file;
 153 }
 154
 155 static void rotate_log()
 156 {
 157     char newname[512];
 158     if (l_file==stderr)
 159         return; /* can't rotate that */
 160     if (!*l_fname)
 161         return; /* hmm, no name, can't rotate */
 162     strncpy(newname, l_fname, 509);
 163     newname[509] = '\0'; /* make sure it is terminated */
 164     strcat(newname,".1");
 165 #ifdef WIN32
 166     /* windows can't rename a file if it is open */
 167     fclose(l_file);
 168     l_file = stderr;
 169 #endif
 170     rename(l_fname, newname);
 171     yaz_log_reopen();
 172 }
 173
 174
 175 void yaz_log_init_level (int level)
 176 {
 177     if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
 178     {
 179         l_level = level;
 180         yaz_log_reopen(); /* make sure we set buffering right */
 181     } else
 182         l_level = level;
 183     if (l_level  & YLOG_LOGLVL)
 184     {  /* dump the log level bits */
 185         char *bittype="Static ";
 186         int i;
 187         yaz_log(YLOG_LOGLVL,"Setting log level to %d = 0x%08x",l_level,l_level);
 188         for (i = 0; mask_names[i].name; i++)
 189             if (mask_names[i].mask && *mask_names[i].name)
 190                 if (strcmp(mask_names[i].name,"all")!=0)
 191                 {
 192                     yaz_log(YLOG_LOGLVL,"%s log bit %08x '%s' is %s",
 193                         bittype, mask_names[i].mask, mask_names[i].name,
 194                         (level & mask_names[i].mask)?  "ON": "off");
 195                 if (mask_names[i].mask>YLOG_LAST_BIT)
 196                     bittype="Dynamic";
 197                 }
 198     }
 199 }
 200
 201 void yaz_log_init_prefix (const char *prefix)
 202 {
 203     if (prefix && *prefix)
 204         sprintf(l_prefix, "%.511s ", prefix);
 205     else
 206         *l_prefix = 0;
 207 }
 208
 209 void yaz_log_init_prefix2 (const char *prefix)
 210 {
 211     if (prefix && *prefix)
 212         sprintf(l_prefix2, "%.511s ", prefix);
 213     else
 214         *l_prefix2 = 0;
 215 }
 216
 217 void yaz_log_init(int level, const char *prefix, const char *fname)
 218 {
 219     if (!mutex_init_flag)
 220         init_mutex();
 221     yaz_log_init_level (level);
 222     yaz_log_init_prefix (prefix);
 223     if (fname && *fname)
 224         yaz_log_init_file (fname);
 225 }
 226
 227 void yaz_log_init_max_size(int mx)
 228 {
 229     if (mx <0)
 230         l_max_size = l_def_max_size;
 231     else
 232         l_max_size = mx;
 233 }
 234
 235 static void (*start_hook_func)(int, const char *, void *) = NULL;
 236 static void *start_hook_info;
 237 static void (*end_hook_func)(int, const char *, void *) = NULL;
 238 static void *end_hook_info;
 239
 240 void log_event_start (void (*func)(int, const char *, void *), void *info)
 241 {
 242     start_hook_func = func;
 243     start_hook_info = info;
 244 }
 245
 246 void log_event_end (void (*func)(int, const char *, void *), void *info)
 247 {
 248     end_hook_func = func;
 249     end_hook_info = info;
 250 }
 251
 252 void yaz_log(int level, const char *fmt, ...)
 253 {
 254     va_list ap;
 255     char buf[4096], flags[1024];
 256     int i;
 257     time_t ti;
 258     struct tm *tim;
 259     char tbuf[TIMEFORMAT_LEN] = "";
 260     int o_level = level;
 261     int flen;
 262
 263     if (!(level & l_level))
 264         return;
 265     if (!mutex_init_flag)
 266         init_mutex();
 267     if (!l_file)
 268         l_file = stderr;
 269
 270     if ((l_file != stderr) && (l_max_size>0))
 271     {
 272         nmem_mutex_enter (log_mutex);
 273         flen = ftell(l_file);
 274         if (flen>l_max_size)
 275             rotate_log();
 276         nmem_mutex_leave (log_mutex);
 277     }
 278
 279     *flags = '\0';
 280     for (i = 0; level && mask_names[i].name; i++)
 281         if ( mask_names[i].mask & level)
 282         {
 283             if (*mask_names[i].name && mask_names[i].mask &&
 284                  mask_names[i].mask != YLOG_ALL)
 285             {
 286                 sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
 287                 level &= ~mask_names[i].mask;
 288             }
 289         }
 290     va_start(ap, fmt);
 291 #ifdef WIN32
 292     _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
 293 #else
 294 /* !WIN32 */
 295 #if HAVE_VSNPRINTF
 296     vsnprintf(buf, sizeof(buf), fmt, ap);
 297 #else
 298     vsprintf(buf, fmt, ap);
 299 #endif
 300 #endif
 301 /* WIN32 */
 302     if (o_level & YLOG_ERRNO)
 303     {
 304         strcat(buf, " [");
 305         yaz_strerror(buf+strlen(buf), 2048);
 306         strcat(buf, "]");
 307     }
 308     va_end (ap);
 309     if (start_hook_func)
 310         (*start_hook_func)(o_level, buf, start_hook_info);
 311     ti = time(0);
 312     tim = localtime(&ti);
 313     if (l_level & YLOG_NOTIME)
 314         tbuf[0] = '\0';
 315     else
 316         strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tim);
 317     tbuf[TIMEFORMAT_LEN-1] = '\0';
 318     fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags,
 319             l_prefix2, buf);
 320     if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
 321         fflush(l_file);
 322     if (end_hook_func)
 323         (*end_hook_func)(o_level, buf, end_hook_info);
 324 }
 325
 326 void yaz_log_time_format(const char *fmt)
 327 {
 328     if ( !fmt || !*fmt)
 329     { /* no format, default to new */
 330         l_actual_format = l_new_default_format;
 331         return;
 332     }
 333     if (0==strcmp(fmt,"old"))
 334     { /* force the old format */
 335         l_actual_format = l_old_default_format;
 336         return;
 337     }
 338     /* else use custom format */
 339     strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
 340     l_custom_format[TIMEFORMAT_LEN-1] = '\0';
 341     l_actual_format = l_custom_format;
 342 }
 343
 344 /** cleans a loglevel name from leading paths and suffixes */
 345 static char *clean_name(const char *name, int len, char *namebuf, int buflen)
 346 {
 347     char *p = namebuf;
 348     char *start = namebuf;
 349     if (buflen <len)
 350         len = buflen;
 351     strncpy(namebuf, name, len);
 352     namebuf[len] = '\0';
 353     while ((p = strchr(start,'/')))
 354         start = p+1;
 355     if ((p = strrchr(start,'.')))
 356         *p = '\0';
 357     return start;
 358
 359 }
 360
 361 static int define_module_bit(const char *name)
 362 {
 363     int i;
 364     for (i = 0; mask_names[i].name; i++)
 365         ;
 366     if ( (i>=MAX_MASK_NAMES) || (next_log_bit >= 1<<31 ))
 367     {
 368         yaz_log(YLOG_WARN,"No more log bits left, not logging '%s'", name);
 369         return 0;
 370     }
 371     mask_names[i].mask = next_log_bit;
 372     next_log_bit = next_log_bit<<1;
 373     mask_names[i].name = xstrdup(name);
 374     mask_names[i+1].name = NULL;
 375     mask_names[i+1].mask = 0;
 376     return mask_names[i].mask;
 377 }
 378
 379 int yaz_log_module_level(const char *name)
 380 {
 381     int i;
 382     char clean[255];
 383     char *n = clean_name(name, strlen(name), clean, sizeof(clean));
 384     for (i = 0; mask_names[i].name; i++)
 385         if (0==strcmp(n,mask_names[i].name))
 386         {
 387             yaz_log(YLOG_LOGLVL,"returning log bit 0x%x for '%s' %s",
 388                     mask_names[i].mask, n,
 389                     strcmp(n,name)?name:"" );
 390             return mask_names[i].mask;
 391         }
 392     yaz_log(YLOG_LOGLVL,"returning NO log bit for '%s' %s", n,
 393                     strcmp(n,name)?name:"" );
 394     return 0;
 395 }
 396
 397 int yaz_log_mask_str (const char *str)
 398 {
 399     return yaz_log_mask_str_x (str, YLOG_DEFAULT_LEVEL);
 400 }
 401
 402 int yaz_log_mask_str_x (const char *str, int level)
 403 {
 404     const char *p;
 405     int i;
 406     char clean[255] = "";
 407     char *n = clean;
 408
 409     while (*str)
 410     {
 411         int found = 0;
 412         int negated = 0;
 413         for (p = str; *p && *p != ','; p++)
 414             ;
 415         if (*str=='-')
 416         {
 417             negated=1;
 418             str++;
 419         }
 420         if (isdigit(*(unsigned char *) str))
 421         {
 422             level = atoi (str);
 423             found = 1;
 424         }
 425         else
 426         {
 427             n = clean_name(str, p-str, clean, sizeof(clean));
 428             for (i = 0; mask_names[i].name; i++)
 429                 if (0==strcmp (mask_names[i].name,n))
 430                 {
 431                     if (mask_names[i].mask)
 432                         if (negated)
 433                             level &= ~mask_names[i].mask;
 434                         else
 435                             level |= mask_names[i].mask;
 436                     else
 437                         level = 0; /* 'none' clears them all */
 438                     found = 1;
 439                 }
 440         }
 441         if (!found)
 442             level |= define_module_bit(n);
 443         if (*p == ',')
 444             p++;
 445         str = p;
 446     }
 447     return level;
 448 }