src/log.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) Index Data
   3  * See the file LICENSE for details.
   4  */
   5
   6 /**
   7  * \file log.c
   8  * \brief Logging utility
   9  */
  10
  11 #if HAVE_CONFIG_H
  12 #include <config.h>
  13 #endif
  14
  15 #ifdef WIN32
  16 #include <windows.h>
  17 #include <sys/stat.h>
  18 #endif
  19
  20 #if HAVE_SYS_STAT_H
  21 #include <sys/stat.h>
  22 #endif
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <stdarg.h>
  27 #include <errno.h>
  28 #include <time.h>
  29 #include <yaz/yaz-iconv.h>
  30 #include <yaz/errno.h>
  31 #include <yaz/thread_id.h>
  32 #include <yaz/log.h>
  33 #include <yaz/mutex.h>
  34 #include <yaz/snprintf.h>
  35 #include <yaz/xmalloc.h>
  36 #if YAZ_POSIX_THREADS
  37 #include <pthread.h>
  38 #endif
  39
  40 static int l_level = YLOG_DEFAULT_LEVEL;
  41
  42 enum l_file_type { use_stderr, use_none, use_file };
  43
  44 struct {
  45     enum l_file_type type;
  46     FILE *log_file;
  47     char l_prefix[512];
  48     char l_prefix2[512];
  49     char l_fname[512];
  50 } yaz_log_info = {
  51     use_stderr, 0, "", "", ""
  52 };
  53
  54 static void (*start_hook_func)(int, const char *, void *) = NULL;
  55 static void *start_hook_info;
  56
  57 static void (*end_hook_func)(int, const char *, void *) = NULL;
  58 static void *end_hook_info;
  59
  60 static void (*hook_func)(int, const char *, void *) = NULL;
  61 static void *hook_info;
  62
  63 static char l_old_default_format[] = "%H:%M:%S-%d/%m";
  64 static char l_new_default_format[] = "%Y%m%d-%H%M%S";
  65 #define TIMEFORMAT_LEN 50
  66 #define TID_LEN        30
  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. The default value is
  71     0 which means DISABLED. This is to be preffered if YAZ runs
  72     as a server using logrotate etc.
  73     A positive size specifies the file size in bytes when a log rotate
  74     will occur. Note that in order for this to work YAZ must have
  75     permissions to do so.
  76  */
  77 static int l_max_size = 0;
  78
  79 #define MAX_MASK_NAMES 35   /* 32 bits plus a few combo names */
  80 static struct {
  81     int mask;
  82     char *name;
  83 } mask_names[MAX_MASK_NAMES] =
  84 {
  85     { YLOG_FATAL,  "fatal"},
  86     { YLOG_DEBUG,  "debug"},
  87     { YLOG_WARN,   "warn" },
  88     { YLOG_LOG,    "log"  },
  89     { YLOG_ERRNO,  ""},
  90     { YLOG_MALLOC, "malloc"},
  91     { YLOG_TID,    "tid"  },
  92     { YLOG_APP,    "app"   },
  93     { YLOG_NOTIME, "notime" },
  94     { YLOG_APP2,   "app2" },
  95     { YLOG_APP3,   "app3" },
  96     { YLOG_ALL,    "all"  },
  97     { YLOG_FLUSH,  "flush" },
  98     { YLOG_LOGLVL, "loglevel" },
  99     { 0,           "none" },
 100     { 0, NULL }
 101     /* the rest will be filled in if the user defines dynamic modules*/
 102 };
 103
 104 static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
 105
 106 static YAZ_MUTEX log_mutex = 0;
 107
 108 static void yaz_log_lock(void)
 109 {
 110     yaz_mutex_enter(log_mutex);
 111 }
 112
 113 static void yaz_log_unlock(void)
 114 {
 115     yaz_mutex_leave(log_mutex);
 116 }
 117
 118 void yaz_log_init_globals(void)
 119 {
 120     char *env;
 121
 122     if (log_mutex == 0)
 123         yaz_mutex_create(&log_mutex);
 124 #if YAZ_POSIX_THREADS
 125     pthread_atfork(yaz_log_lock, yaz_log_unlock, yaz_log_unlock);
 126 #endif
 127     env = getenv("YAZ_LOG");
 128     if (env)
 129         l_level = yaz_log_mask_str_x(env, l_level);
 130 }
 131
 132 FILE *yaz_log_file(void)
 133 {
 134     FILE *f = 0;
 135     switch (yaz_log_info.type)
 136     {
 137         case use_stderr: f = stderr; break;
 138         case use_none: f = 0; break;
 139         case use_file: f = yaz_log_info.log_file; break;
 140     }
 141     return f;
 142 }
 143
 144 void yaz_log_close(void)
 145 {
 146     if (yaz_log_info.type == use_file && yaz_log_info.log_file)
 147     {
 148         fclose(yaz_log_info.log_file);
 149         yaz_log_info.log_file = 0;
 150     }
 151 }
 152
 153 void yaz_log_init_file(const char *fname)
 154 {
 155     yaz_init_globals();
 156
 157     yaz_log_close();
 158     if (fname)
 159     {
 160         if (*fname == '\0')
 161             yaz_log_info.type = use_stderr; /* empty name; use stderr */
 162         else
 163             yaz_log_info.type = use_file;
 164         strncpy(yaz_log_info.l_fname, fname, sizeof(yaz_log_info.l_fname)-1);
 165         yaz_log_info.l_fname[sizeof(yaz_log_info.l_fname)-1] = '\0';
 166     }
 167     else
 168     {
 169         yaz_log_info.type = use_none;  /* NULL name; use no file at all */
 170         yaz_log_info.l_fname[0] = '\0';
 171     }
 172     yaz_log_reopen();
 173 }
 174
 175 static void rotate_log(const char *cur_fname)
 176 {
 177     int i;
 178
 179 #ifdef WIN32
 180     /* windows can't rename a file if it is open */
 181     yaz_log_close();
 182 #endif
 183     for (i = 0; i<9; i++)
 184     {
 185         char fname_str[FILENAME_MAX];
 186         struct stat stat_buf;
 187
 188         yaz_snprintf(fname_str, sizeof(fname_str), "%s.%d", cur_fname, i);
 189         if (stat(fname_str, &stat_buf) != 0)
 190             break;
 191     }
 192     for (; i >= 0; --i)
 193     {
 194         char fname_str[2][FILENAME_MAX];
 195
 196         if (i > 0)
 197             yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
 198                          "%s.%d", cur_fname, i-1);
 199         else
 200             yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
 201                          "%s", cur_fname);
 202         yaz_snprintf(fname_str[1], sizeof(fname_str[1]),
 203                      "%s.%d", cur_fname, i);
 204 #ifdef WIN32
 205         MoveFileEx(fname_str[0], fname_str[1], MOVEFILE_REPLACE_EXISTING);
 206 #else
 207         rename(fname_str[0], fname_str[1]);
 208 #endif
 209     }
 210 }
 211
 212
 213 void yaz_log_init_level(int level)
 214 {
 215     yaz_init_globals();
 216     if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
 217     {
 218         l_level = level;
 219         yaz_log_reopen(); /* make sure we set buffering right */
 220     }
 221     else
 222         l_level = level;
 223
 224     if (l_level  & YLOG_LOGLVL)
 225     {  /* dump the log level bits */
 226         const char *bittype = "Static ";
 227         int i, sz;
 228
 229         yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
 230                 l_level, l_level);
 231         /* determine size of mask_names (locked) */
 232         for (sz = 0; mask_names[sz].name; sz++)
 233             ;
 234         /* second pass without lock */
 235         for (i = 0; i < sz; i++)
 236             if (mask_names[i].mask && *mask_names[i].name)
 237                 if (strcmp(mask_names[i].name, "all") != 0)
 238                 {
 239                     yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s",
 240                             bittype, mask_names[i].mask, mask_names[i].name,
 241                             (level & mask_names[i].mask)?  "ON": "off");
 242                     if (mask_names[i].mask > YLOG_LAST_BIT)
 243                         bittype = "Dynamic";
 244                 }
 245     }
 246 }
 247
 248 void yaz_log_init_prefix(const char *prefix)
 249 {
 250     if (prefix && *prefix)
 251         yaz_snprintf(yaz_log_info.l_prefix,
 252                      sizeof(yaz_log_info.l_prefix), "%s ", prefix);
 253     else
 254         *yaz_log_info.l_prefix = 0;
 255 }
 256
 257 void yaz_log_init_prefix2(const char *prefix)
 258 {
 259     if (prefix && *prefix)
 260         yaz_snprintf(yaz_log_info.l_prefix2,
 261                      sizeof(yaz_log_info.l_prefix2), "%s ", prefix);
 262     else
 263         *yaz_log_info.l_prefix2 = 0;
 264 }
 265
 266 void yaz_log_init(int level, const char *prefix, const char *fname)
 267 {
 268     yaz_init_globals();
 269     yaz_log_init_level(level);
 270     yaz_log_init_prefix(prefix);
 271     if (fname && *fname)
 272         yaz_log_init_file(fname);
 273 }
 274
 275 void yaz_log_init_max_size(int mx)
 276 {
 277     if (mx > 0)
 278         l_max_size = mx;
 279     else
 280         l_max_size = 0;
 281 }
 282
 283 void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info)
 284 {
 285     hook_func = func;
 286     hook_info = info;
 287 }
 288
 289 void log_event_start(void (*func)(int, const char *, void *), void *info)
 290 {
 291     start_hook_func = func;
 292     start_hook_info = info;
 293 }
 294
 295 void log_event_end(void (*func)(int, const char *, void *), void *info)
 296 {
 297     end_hook_func = func;
 298     end_hook_info = info;
 299 }
 300
 301 static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
 302 {
 303     char new_filename[512];
 304     static char cur_filename[512] = "";
 305
 306     if (yaz_log_info.type != use_file)
 307         return;
 308
 309     if (*yaz_log_info.l_fname)
 310     {
 311         strftime(new_filename, sizeof(new_filename)-1, yaz_log_info.l_fname,
 312                  tm);
 313         if (strcmp(new_filename, cur_filename))
 314         {
 315             strcpy(cur_filename, new_filename);
 316             force = 1;
 317         }
 318     }
 319
 320     if (l_max_size > 0 && yaz_log_info.log_file)
 321     {
 322         long flen = ftell(yaz_log_info.log_file);
 323         if (flen > l_max_size)
 324         {
 325             rotate_log(cur_filename);
 326             force = 1;
 327         }
 328     }
 329     if (force && *cur_filename)
 330     {
 331         FILE *new_file;
 332 #ifdef WIN32
 333         yaz_log_close();
 334 #endif
 335         new_file = fopen(cur_filename, filemode);
 336         if (new_file)
 337         {
 338             yaz_log_close();
 339             yaz_log_info.log_file = new_file;
 340             if (l_level & YLOG_FLUSH)
 341                 setvbuf(yaz_log_info.log_file, 0, _IONBF, 0);
 342         }
 343         else
 344         {
 345             /* disable log rotate */
 346             l_max_size = 0;
 347         }
 348     }
 349 }
 350
 351 static void yaz_log_do_reopen(const char *filemode)
 352 {
 353     time_t cur_time = time(0);
 354 #if HAVE_LOCALTIME_R
 355     struct tm tm0, *tm = &tm0;
 356 #else
 357     struct tm *tm;
 358 #endif
 359
 360     yaz_log_lock();
 361 #if HAVE_LOCALTIME_R
 362     localtime_r(&cur_time, tm);
 363 #else
 364     tm = localtime(&cur_time);
 365 #endif
 366     yaz_log_open_check(tm, 1, filemode);
 367     yaz_log_unlock();
 368 }
 369
 370
 371 void yaz_log_reopen()
 372 {
 373     yaz_log_do_reopen("a");
 374 }
 375
 376 void yaz_log_trunc()
 377 {
 378     yaz_log_do_reopen("w");
 379 }
 380
 381 static void yaz_strftime(char *dst, size_t sz,
 382                          const char *fmt, const struct tm *tm)
 383 {
 384     strftime(dst, sz, fmt, tm);
 385 }
 386
 387 static void yaz_log_to_file(int level, const char *log_message)
 388 {
 389     FILE *file;
 390     time_t ti = time(0);
 391 #if HAVE_LOCALTIME_R
 392     struct tm tm0, *tm = &tm0;
 393 #else
 394     struct tm *tm;
 395 #endif
 396
 397     yaz_log_lock();
 398 #if HAVE_LOCALTIME_R
 399     localtime_r(&ti, tm);
 400 #else
 401     tm = localtime(&ti);
 402 #endif
 403
 404     yaz_log_open_check(tm, 0, "a");
 405     file = yaz_log_file(); /* file may change in yaz_log_open_check */
 406
 407     if (file)
 408     {
 409         char tbuf[TIMEFORMAT_LEN];
 410         char tid[TID_LEN];
 411         char flags[1024];
 412         int i;
 413
 414         *flags = '\0';
 415         for (i = 0; level && mask_names[i].name; i++)
 416             if ( mask_names[i].mask & level)
 417             {
 418                 if (*mask_names[i].name && mask_names[i].mask &&
 419                     mask_names[i].mask != YLOG_ALL)
 420                 {
 421                     if (strlen(flags) + strlen(mask_names[i].name)
 422                                              <   sizeof(flags) - 4)
 423                     {
 424                         strcat(flags, "[");
 425                         strcat(flags, mask_names[i].name);
 426                         strcat(flags, "]");
 427                     }
 428                     level &= ~mask_names[i].mask;
 429                 }
 430             }
 431
 432         tbuf[0] = '\0';
 433         if (!(l_level & YLOG_NOTIME))
 434         {
 435             yaz_strftime(tbuf, TIMEFORMAT_LEN-2, l_actual_format, tm);
 436             tbuf[TIMEFORMAT_LEN-2] = '\0';
 437         }
 438         if (tbuf[0])
 439             strcat(tbuf, " ");
 440         tid[0] = '\0';
 441
 442         if (l_level & YLOG_TID)
 443         {
 444             yaz_thread_id_cstr(tid, sizeof(tid)-1);
 445             if (tid[0])
 446                 strcat(tid, " ");
 447         }
 448
 449         fprintf(file, "%s%s%s%s %s%s\n", tbuf, yaz_log_info.l_prefix,
 450                 tid, flags, yaz_log_info.l_prefix2,
 451                 log_message);
 452         if (l_level & YLOG_FLUSH)
 453             fflush(file);
 454     }
 455     yaz_log_unlock();
 456 }
 457
 458 void yaz_log(int level, const char *fmt, ...)
 459 {
 460     va_list ap;
 461     char buf[4096];
 462     FILE *file;
 463     int o_level = level;
 464
 465     yaz_init_globals();
 466     if (!(level & l_level))
 467         return;
 468     va_start(ap, fmt);
 469
 470     /* 30 is enough for our 'rest of output' message */
 471     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
 472     if (strlen(buf) >= sizeof(buf)-31)
 473         strcat(buf, " [rest of output omitted]");
 474
 475     if (o_level & YLOG_ERRNO)
 476     {
 477         size_t remain = sizeof(buf) - strlen(buf);
 478         if (remain > 100) /* reasonable minimum space for error */
 479         {
 480             strcat(buf, " [");
 481             yaz_strerror(buf+strlen(buf), remain-5); /* 5 due to extra [] */
 482             strcat(buf, "]");
 483         }
 484     }
 485     va_end (ap);
 486     if (start_hook_func)
 487         (*start_hook_func)(o_level, buf, start_hook_info);
 488     if (hook_func)
 489         (*hook_func)(o_level, buf, hook_info);
 490     file = yaz_log_file();
 491     if (file)
 492         yaz_log_to_file(level, buf);
 493     if (end_hook_func)
 494         (*end_hook_func)(o_level, buf, end_hook_info);
 495 }
 496
 497 void yaz_log_time_format(const char *fmt)
 498 {
 499     if ( !fmt || !*fmt)
 500     { /* no format, default to new */
 501         l_actual_format = l_new_default_format;
 502         return;
 503     }
 504     if (0==strcmp(fmt, "old"))
 505     { /* force the old format */
 506         l_actual_format = l_old_default_format;
 507         return;
 508     }
 509     /* else use custom format */
 510     strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
 511     l_custom_format[TIMEFORMAT_LEN-1] = '\0';
 512     l_actual_format = l_custom_format;
 513 }
 514
 515 /** cleans a loglevel name from leading paths and suffixes */
 516 static char *clean_name(const char *name, size_t len, char *namebuf, size_t buflen)
 517 {
 518     char *p = namebuf;
 519     char *start = namebuf;
 520     if (buflen <= len)
 521         len = buflen-1;
 522     strncpy(namebuf, name, len);
 523     namebuf[len] = '\0';
 524     while ((p = strchr(start, '/')))
 525         start = p+1;
 526     if ((p = strrchr(start, '.')))
 527         *p = '\0';
 528     return start;
 529 }
 530
 531 static int define_module_bit(const char *name)
 532 {
 533     size_t i;
 534
 535     for (i = 0; mask_names[i].name; i++)
 536         if (0 == strcmp(mask_names[i].name, name))
 537         {
 538             return mask_names[i].mask;
 539         }
 540     if ( (i>=MAX_MASK_NAMES) || (next_log_bit & (1U<<31) ))
 541     {
 542         yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
 543         return 0;
 544     }
 545     mask_names[i].mask = (int) next_log_bit; /* next_log_bit can hold int */
 546     next_log_bit = next_log_bit<<1;
 547     mask_names[i].name = (char *) malloc(strlen(name)+1);
 548     strcpy(mask_names[i].name, name);
 549     mask_names[i+1].name = NULL;
 550     mask_names[i+1].mask = 0;
 551     return mask_names[i].mask;
 552 }
 553
 554 int yaz_log_module_level(const char *name)
 555 {
 556     int i;
 557     char clean[255];
 558     char *n = clean_name(name, strlen(name), clean, sizeof(clean));
 559     yaz_init_globals();
 560
 561     for (i = 0; mask_names[i].name; i++)
 562         if (0==strcmp(n, mask_names[i].name))
 563         {
 564             yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
 565                     mask_names[i].mask, n,
 566                     strcmp(n,name) ? name : "");
 567             return mask_names[i].mask;
 568         }
 569     yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
 570             strcmp(n, name) ? name : "" );
 571     return 0;
 572 }
 573
 574 int yaz_log_mask_str(const char *str)
 575 {
 576     yaz_init_globals(); /* since l_level may be affected */
 577     return yaz_log_mask_str_x(str, l_level);
 578 }
 579
 580 int yaz_log_mask_str_x(const char *str, int level)
 581 {
 582     const char *p;
 583
 584     yaz_init_globals();
 585     while (*str)
 586     {
 587         int negated = 0;
 588         for (p = str; *p && *p != ','; p++)
 589             ;
 590         if (*str=='-')
 591         {
 592             negated = 1;
 593             str++;
 594         }
 595         if (yaz_isdigit(*str))
 596         {
 597             level = atoi(str);
 598         }
 599         else
 600         {
 601             char clean[509];
 602             char *n = clean_name(str, (size_t) (p - str), clean, sizeof(clean));
 603             int mask = define_module_bit(n);
 604             if (!mask)
 605                 level = 0;  /* 'none' clears them all */
 606             else if (negated)
 607                 level &= ~mask;
 608             else
 609                 level |= mask;
 610         }
 611         if (*p == ',')
 612             p++;
 613         str = p;
 614     }
 615     return level;
 616 }
 617 /*
 618  * Local variables:
 619  * c-basic-offset: 4
 620  * c-file-style: "Stroustrup"
 621  * indent-tabs-mode: nil
 622  * End:
 623  * vim: shiftwidth=4 tabstop=8 expandtab
 624  */
 625