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.27 2005-09-09 11:29:54 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     init_mutex();
 118     if (fname)
 119     {
 120         strncpy(l_fname, fname, sizeof(l_fname)-1);
 121         l_fname[sizeof(l_fname)-1] = '\0';
 122     }
 123     else
 124         l_fname[0] = '\0';
 125     yaz_log_reopen();
 126 }
 127
 128 void yaz_log_reopen(void)
 129 {
 130     FILE *new_file;
 131     init_mutex();
 132     if (!l_file)
 133         l_file = stderr;
 134     if (!*l_fname)
 135         new_file = stderr;
 136     else if (!(new_file = fopen(l_fname, "a")))
 137     {
 138         new_file=l_file;
 139         l_file=stderr;  /* just to be sure we don't rotate logs and recurse */
 140         yaz_log(YLOG_WARN|YLOG_ERRNO,"Could not open log file '%s'",l_fname);
 141         l_file=new_file; /* restore to old value, probably stderr as well */
 142         return;
 143     }
 144     if (l_file != stderr)
 145     {
 146         fclose (l_file);
 147     }
 148     if (l_level & YLOG_FLUSH)
 149         setvbuf(new_file, 0, _IONBF, 0);
 150     l_file = new_file;
 151 }
 152
 153 static void rotate_log()
 154 {
 155     char newname[512];
 156     if (l_file==stderr)
 157         return; /* can't rotate that */
 158     if (!*l_fname)
 159         return; /* hmm, no name, can't rotate */
 160     strncpy(newname, l_fname, 509);
 161     newname[509] = '\0'; /* make sure it is terminated */
 162     strcat(newname,".1");
 163 #ifdef WIN32
 164     /* windows can't rename a file if it is open */
 165     fclose(l_file);
 166     l_file = stderr;
 167     MoveFileEx(l_fname, newname, MOVEFILE_REPLACE_EXISTING);
 168 #else
 169     rename(l_fname, newname);
 170 #endif
 171     yaz_log_reopen();
 172 }
 173
 174
 175 void yaz_log_init_level (int level)
 176 {
 177     init_mutex();
 178     if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
 179     {
 180         l_level = level;
 181         yaz_log_reopen(); /* make sure we set buffering right */
 182     } else
 183         l_level = level;
 184     if (l_level  & YLOG_LOGLVL)
 185     {  /* dump the log level bits */
 186         const char *bittype = "Static ";
 187         int i, sz;
 188
 189         yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
 190                 l_level, l_level);
 191         /* determine size of mask_names (locked) */
 192         nmem_mutex_enter(log_mutex);
 193         for (sz = 0; mask_names[sz].name; sz++)
 194             ;
 195         nmem_mutex_leave(log_mutex);
 196         /* second pass without lock */
 197         for (i = 0; i < sz; i++)
 198             if (mask_names[i].mask && *mask_names[i].name)
 199                 if (strcmp(mask_names[i].name, "all") != 0)
 200                 {
 201                     yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s",
 202                             bittype, mask_names[i].mask, mask_names[i].name,
 203                             (level & mask_names[i].mask)?  "ON": "off");
 204                     if (mask_names[i].mask > YLOG_LAST_BIT)
 205                         bittype = "Dynamic";
 206                 }
 207     }
 208 }
 209
 210 void yaz_log_init_prefix (const char *prefix)
 211 {
 212     if (prefix && *prefix)
 213         sprintf(l_prefix, "%.511s ", prefix);
 214     else
 215         *l_prefix = 0;
 216 }
 217
 218 void yaz_log_init_prefix2 (const char *prefix)
 219 {
 220     if (prefix && *prefix)
 221         sprintf(l_prefix2, "%.511s ", prefix);
 222     else
 223         *l_prefix2 = 0;
 224 }
 225
 226 void yaz_log_init(int level, const char *prefix, const char *fname)
 227 {
 228     init_mutex();
 229     yaz_log_init_level (level);
 230     yaz_log_init_prefix (prefix);
 231     if (fname && *fname)
 232         yaz_log_init_file (fname);
 233 }
 234
 235 void yaz_log_init_max_size(int mx)
 236 {
 237     if (mx <0)
 238         l_max_size = l_def_max_size;
 239     else
 240         l_max_size = mx;
 241 }
 242
 243 static void (*start_hook_func)(int, const char *, void *) = NULL;
 244 static void *start_hook_info;
 245 static void (*end_hook_func)(int, const char *, void *) = NULL;
 246 static void *end_hook_info;
 247
 248 void log_event_start (void (*func)(int, const char *, void *), void *info)
 249 {
 250     start_hook_func = func;
 251     start_hook_info = info;
 252 }
 253
 254 void log_event_end (void (*func)(int, const char *, void *), void *info)
 255 {
 256     end_hook_func = func;
 257     end_hook_info = info;
 258 }
 259
 260 void yaz_log(int level, const char *fmt, ...)
 261 {
 262     va_list ap;
 263     char buf[4096], flags[1024];
 264     int i;
 265     time_t ti;
 266     struct tm *tim;
 267     char tbuf[TIMEFORMAT_LEN] = "";
 268     int o_level = level;
 269     int flen;
 270
 271     if (!(level & l_level))
 272         return;
 273     init_mutex();
 274     nmem_mutex_enter(log_mutex);
 275     if (!l_file)
 276         l_file = stderr;
 277
 278     if ((l_file != stderr) && (l_max_size>0))
 279     {
 280         flen = ftell(l_file);
 281         if (flen>l_max_size)
 282             rotate_log();
 283     }
 284
 285     *flags = '\0';
 286     for (i = 0; level && mask_names[i].name; i++)
 287         if ( mask_names[i].mask & level)
 288         {
 289             if (*mask_names[i].name && mask_names[i].mask &&
 290                  mask_names[i].mask != YLOG_ALL)
 291             {
 292                 sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
 293                 level &= ~mask_names[i].mask;
 294             }
 295         }
 296
 297     va_start(ap, fmt);
 298 #ifdef WIN32
 299     _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
 300 #else
 301 /* !WIN32 */
 302 #if HAVE_VSNPRINTF
 303     vsnprintf(buf, sizeof(buf), fmt, ap);
 304 #else
 305     vsprintf(buf, fmt, ap);
 306 #endif
 307 #endif
 308 /* WIN32 */
 309     if (o_level & YLOG_ERRNO)
 310     {
 311         strcat(buf, " [");
 312         yaz_strerror(buf+strlen(buf), 2048);
 313         strcat(buf, "]");
 314     }
 315     va_end (ap);
 316     if (start_hook_func)
 317         (*start_hook_func)(o_level, buf, start_hook_info);
 318     ti = time(0);
 319     tim = localtime(&ti);
 320     if (l_level & YLOG_NOTIME)
 321         tbuf[0] = '\0';
 322     else
 323         strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tim);
 324     tbuf[TIMEFORMAT_LEN-1] = '\0';
 325     fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags,
 326             l_prefix2, buf);
 327     if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
 328         fflush(l_file);
 329     if (end_hook_func)
 330         (*end_hook_func)(o_level, buf, end_hook_info);
 331     nmem_mutex_leave(log_mutex);
 332 }
 333
 334 void yaz_log_time_format(const char *fmt)
 335 {
 336     if ( !fmt || !*fmt)
 337     { /* no format, default to new */
 338         l_actual_format = l_new_default_format;
 339         return;
 340     }
 341     if (0==strcmp(fmt,"old"))
 342     { /* force the old format */
 343         l_actual_format = l_old_default_format;
 344         return;
 345     }
 346     /* else use custom format */
 347     strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
 348     l_custom_format[TIMEFORMAT_LEN-1] = '\0';
 349     l_actual_format = l_custom_format;
 350 }
 351
 352 /** cleans a loglevel name from leading paths and suffixes */
 353 static char *clean_name(const char *name, int len, char *namebuf, int buflen)
 354 {
 355     char *p = namebuf;
 356     char *start = namebuf;
 357     if (buflen <= len)
 358         len = buflen-1;
 359     strncpy(namebuf, name, len);
 360     namebuf[len] = '\0';
 361     while ((p = strchr(start,'/')))
 362         start = p+1;
 363     if ((p = strrchr(start,'.')))
 364         *p = '\0';
 365     return start;
 366 }
 367
 368 static int define_module_bit(const char *name)
 369 {
 370     int i;
 371     init_mutex();
 372     nmem_mutex_enter(log_mutex);
 373     for (i = 0; mask_names[i].name; i++)
 374         if (0 == strcmp(mask_names[i].name, name))
 375         {
 376             nmem_mutex_leave(log_mutex);
 377             return mask_names[i].mask;
 378         }
 379     if ( (i>=MAX_MASK_NAMES) || (next_log_bit >= 1<<31 ))
 380     {
 381         nmem_mutex_leave(log_mutex);
 382         yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
 383         return 0;
 384     }
 385     mask_names[i].mask = next_log_bit;
 386     next_log_bit = next_log_bit<<1;
 387     mask_names[i].name = malloc (strlen(name)+1);
 388     strcpy(mask_names[i].name, name);
 389     mask_names[i+1].name = NULL;
 390     mask_names[i+1].mask = 0;
 391     nmem_mutex_leave(log_mutex);
 392     return mask_names[i].mask;
 393 }
 394
 395 int yaz_log_module_level(const char *name)
 396 {
 397     int i;
 398     char clean[255];
 399     char *n = clean_name(name, strlen(name), clean, sizeof(clean));
 400     init_mutex();
 401
 402     nmem_mutex_enter(log_mutex);
 403     for (i = 0; mask_names[i].name; i++)
 404         if (0==strcmp(n, mask_names[i].name))
 405         {
 406             nmem_mutex_leave(log_mutex);
 407             yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
 408                     mask_names[i].mask, n,
 409                     strcmp(n,name) ? name : "");
 410             return mask_names[i].mask;
 411         }
 412     nmem_mutex_leave(log_mutex);
 413     yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
 414                     strcmp(n, name) ? name : "" );
 415     return 0;
 416 }
 417
 418 int yaz_log_mask_str (const char *str)
 419 {
 420     return yaz_log_mask_str_x (str, YLOG_DEFAULT_LEVEL);
 421 }
 422
 423 int yaz_log_mask_str_x (const char *str, int level)
 424 {
 425     const char *p;
 426
 427     while (*str)
 428     {
 429         int negated = 0;
 430         for (p = str; *p && *p != ','; p++)
 431             ;
 432         if (*str=='-')
 433         {
 434             negated = 1;
 435             str++;
 436         }
 437         if (isdigit(*(unsigned char *) str))
 438         {
 439             level = atoi(str);
 440         }
 441         else
 442         {
 443             char clean[509];
 444             char *n = clean_name(str, p-str, clean, sizeof(clean));
 445             int mask = define_module_bit(n);
 446             if (!mask)
 447                 level = 0;  /* 'none' clears them all */
 448             else if (negated)
 449                 level &= ~mask;
 450             else
 451                 level |= mask;
 452         }
 453         if (*p == ',')
 454             p++;
 455         str = p;
 456     }
 457     return level;
 458 }
 459 /*
 460  * Local variables:
 461  * c-basic-offset: 4
 462  * indent-tabs-mode: nil
 463  * End:
 464  * vim: shiftwidth=4 tabstop=8 expandtab
 465  */
 466