Add note about yaz_log_mask_str_x
[yaz-moved-to-github.git] / src / log.c
index ab87c32..b439c4c 100644 (file)
--- a/src/log.c
+++ b/src/log.c
@@ -1,8 +1,6 @@
-/*
- * Copyright (C) 1995-2007, Index Data ApS
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) Index Data
  * See the file LICENSE for details.
- *
- * $Id: log.c,v 1.51 2007-05-06 20:12:20 adam Exp $
  */
 
 /**
 
 #ifdef WIN32
 #include <windows.h>
+#include <sys/stat.h>
 #endif
 
+#if HAVE_SYS_STAT_H
 #include <sys/stat.h>
+#endif
 #include <stdio.h>
 #include <stdlib.h>
-#include <ctype.h>
 #include <string.h>
 #include <stdarg.h>
 #include <errno.h>
 #include <time.h>
-#include <yaz/nmem.h>
+#include <yaz/yaz-iconv.h>
+#include <yaz/errno.h>
+#include <yaz/thread_id.h>
 #include <yaz/log.h>
+#include <yaz/mutex.h>
 #include <yaz/snprintf.h>
 #include <yaz/xmalloc.h>
-
-#define HAS_STRERROR 1
-
-
-#if HAS_STRERROR
-
-#else
-char *strerror(int n)
-{
-    extern char *sys_errlist[];
-    return sys_errlist[n];
-}
-
+#if YAZ_POSIX_THREADS
+#include <pthread.h>
 #endif
 
-
 static int l_level = YLOG_DEFAULT_LEVEL;
 
 enum l_file_type { use_stderr, use_none, use_file };
-static enum l_file_type yaz_file_type = use_stderr;
-static FILE *yaz_global_log_file = NULL;
+
+struct {
+    enum l_file_type type;
+    FILE *log_file;
+    char l_prefix[512];
+    char l_prefix2[512];
+    char l_fname[512];
+} yaz_log_info = {
+    use_stderr, 0, "", "", ""
+};
 
 static void (*start_hook_func)(int, const char *, void *) = NULL;
 static void *start_hook_info;
@@ -61,22 +60,21 @@ static void *end_hook_info;
 static void (*hook_func)(int, const char *, void *) = NULL;
 static void *hook_info;
 
-static char l_prefix[512] = "";
-static char l_prefix2[512] = "";
-static char l_fname[512] = "";
-
-
 static char l_old_default_format[] = "%H:%M:%S-%d/%m";
 static char l_new_default_format[] = "%Y%m%d-%H%M%S";
 #define TIMEFORMAT_LEN 50
+#define TID_LEN        30
 static char l_custom_format[TIMEFORMAT_LEN] = "";
 static char *l_actual_format = l_old_default_format;
 
-/** l_max_size tells when to rotate the log. Default is 1 GB 
-    This is almost the same as never, but it saves applications in the
-    case of 2 or 4 GB file size limits..
+/** l_max_size tells when to rotate the log. The default value is
+    0 which means DISABLED. This is to be preffered if YAZ runs
+    as a server using logrotate etc.
+    A positive size specifies the file size in bytes when a log rotate
+    will occur. Note that in order for this to work YAZ must have
+    permissions to do so.
  */
-static int l_max_size = 1024*1024*1024;
+static int l_max_size = 0;
 
 #define MAX_MASK_NAMES 35   /* 32 bits plus a few combo names */
 static struct {
@@ -90,74 +88,86 @@ static struct {
     { YLOG_LOG,    "log"  },
     { YLOG_ERRNO,  ""},
     { YLOG_MALLOC, "malloc"},
-    { YLOG_APP,    "app"  },
+    { YLOG_TID,    "tid"  },
+    { YLOG_APP,    "app"   },
     { YLOG_NOTIME, "notime" },
-    { YLOG_APP2,   "app2" }, 
+    { YLOG_APP2,   "app2" },
     { YLOG_APP3,   "app3" },
     { YLOG_ALL,    "all"  },
     { YLOG_FLUSH,  "flush" },
-    { YLOG_LOGLVL, "loglevel" }, 
+    { YLOG_LOGLVL, "loglevel" },
     { 0,           "none" },
     { 0, NULL }
     /* the rest will be filled in if the user defines dynamic modules*/
-};  
+};
 
 static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
 
-static void internal_log_init(void)
+static YAZ_MUTEX log_mutex = 0;
+
+static void yaz_log_lock(void)
 {
-    static int mutex_init_flag = 0; /* not yet initialized */
-    char *env;
+    yaz_mutex_enter(log_mutex);
+}
 
-    if (mutex_init_flag)
-        return;
-    mutex_init_flag = 1; /* here, 'cause nmem_mutex_create may call yaz_log */
+static void yaz_log_unlock(void)
+{
+    yaz_mutex_leave(log_mutex);
+}
+
+void yaz_log_init_globals(void)
+{
+    char *env;
 
+    if (log_mutex == 0)
+        yaz_mutex_create(&log_mutex);
+#if YAZ_POSIX_THREADS
+    pthread_atfork(yaz_log_lock, yaz_log_unlock, yaz_log_unlock);
+#endif
     env = getenv("YAZ_LOG");
     if (env)
         l_level = yaz_log_mask_str_x(env, l_level);
 }
 
-
 FILE *yaz_log_file(void)
 {
     FILE *f = 0;
-    switch(yaz_file_type)
+    switch (yaz_log_info.type)
     {
         case use_stderr: f = stderr; break;
         case use_none: f = 0; break;
-        case use_file: f = yaz_global_log_file; break;
+        case use_file: f = yaz_log_info.log_file; break;
     }
     return f;
 }
 
 void yaz_log_close(void)
 {
-    if (yaz_file_type == use_file && yaz_global_log_file)
+    if (yaz_log_info.type == use_file && yaz_log_info.log_file)
     {
-        fclose(yaz_global_log_file);
-        yaz_global_log_file = 0;
+        fclose(yaz_log_info.log_file);
+        yaz_log_info.log_file = 0;
     }
 }
 
 void yaz_log_init_file(const char *fname)
 {
-    internal_log_init();
+    yaz_init_globals();
 
     yaz_log_close();
     if (fname)
     {
         if (*fname == '\0')
-            yaz_file_type = use_stderr; /* empty name; use stderr */
+            yaz_log_info.type = use_stderr; /* empty name; use stderr */
         else
-            yaz_file_type = use_file;
-        strncpy(l_fname, fname, sizeof(l_fname)-1);
-        l_fname[sizeof(l_fname)-1] = '\0';
+            yaz_log_info.type = use_file;
+        strncpy(yaz_log_info.l_fname, fname, sizeof(yaz_log_info.l_fname)-1);
+        yaz_log_info.l_fname[sizeof(yaz_log_info.l_fname)-1] = '\0';
     }
     else
     {
-        yaz_file_type = use_none;  /* NULL name; use no file at all */
-        l_fname[0] = '\0'; 
+        yaz_log_info.type = use_none;  /* NULL name; use no file at all */
+        yaz_log_info.l_fname[0] = '\0';
     }
     yaz_log_reopen();
 }
@@ -175,7 +185,7 @@ static void rotate_log(const char *cur_fname)
         char fname_str[FILENAME_MAX];
         struct stat stat_buf;
 
-        sprintf(fname_str, "%s.%d", cur_fname, i);
+        yaz_snprintf(fname_str, sizeof(fname_str), "%s.%d", cur_fname, i);
         if (stat(fname_str, &stat_buf) != 0)
             break;
     }
@@ -184,10 +194,13 @@ static void rotate_log(const char *cur_fname)
         char fname_str[2][FILENAME_MAX];
 
         if (i > 0)
-            sprintf(fname_str[0], "%s.%d", cur_fname, i-1);
+            yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
+                         "%s.%d", cur_fname, i-1);
         else
-            sprintf(fname_str[0], "%s", cur_fname);
-        sprintf(fname_str[1], "%s.%d", cur_fname, i);
+            yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
+                         "%s", cur_fname);
+        yaz_snprintf(fname_str[1], sizeof(fname_str[1]),
+                     "%s.%d", cur_fname, i);
 #ifdef WIN32
         MoveFileEx(fname_str[0], fname_str[1], MOVEFILE_REPLACE_EXISTING);
 #else
@@ -199,12 +212,12 @@ static void rotate_log(const char *cur_fname)
 
 void yaz_log_init_level(int level)
 {
-    internal_log_init();
+    yaz_init_globals();
     if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
     {
         l_level = level;
         yaz_log_reopen(); /* make sure we set buffering right */
-    } 
+    }
     else
         l_level = level;
 
@@ -235,22 +248,24 @@ void yaz_log_init_level(int level)
 void yaz_log_init_prefix(const char *prefix)
 {
     if (prefix && *prefix)
-        sprintf(l_prefix, "%.511s ", prefix);
+        yaz_snprintf(yaz_log_info.l_prefix,
+                     sizeof(yaz_log_info.l_prefix), "%s ", prefix);
     else
-        *l_prefix = 0;
+        *yaz_log_info.l_prefix = 0;
 }
 
 void yaz_log_init_prefix2(const char *prefix)
 {
     if (prefix && *prefix)
-        sprintf(l_prefix2, "%.511s ", prefix);
+        yaz_snprintf(yaz_log_info.l_prefix2,
+                     sizeof(yaz_log_info.l_prefix2), "%s ", prefix);
     else
-        *l_prefix2 = 0;
+        *yaz_log_info.l_prefix2 = 0;
 }
 
 void yaz_log_init(int level, const char *prefix, const char *fname)
 {
-    internal_log_init();
+    yaz_init_globals();
     yaz_log_init_level(level);
     yaz_log_init_prefix(prefix);
     if (fname && *fname)
@@ -273,14 +288,14 @@ void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info)
 
 void log_event_start(void (*func)(int, const char *, void *), void *info)
 {
-     start_hook_func = func;
-     start_hook_info = info;
+    start_hook_func = func;
+    start_hook_info = info;
 }
 
 void log_event_end(void (*func)(int, const char *, void *), void *info)
 {
-     end_hook_func = func;
-     end_hook_info = info;
+    end_hook_func = func;
+    end_hook_info = info;
 }
 
 static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
@@ -288,12 +303,13 @@ static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
     char new_filename[512];
     static char cur_filename[512] = "";
 
-    if (yaz_file_type != use_file)
+    if (yaz_log_info.type != use_file)
         return;
 
-    if (l_fname && *l_fname)
+    if (*yaz_log_info.l_fname)
     {
-        strftime(new_filename, sizeof(new_filename)-1, l_fname, tm);
+        strftime(new_filename, sizeof(new_filename)-1, yaz_log_info.l_fname,
+                 tm);
         if (strcmp(new_filename, cur_filename))
         {
             strcpy(cur_filename, new_filename);
@@ -301,9 +317,9 @@ static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
         }
     }
 
-    if (l_max_size > 0 && yaz_global_log_file)
+    if (l_max_size > 0 && yaz_log_info.log_file)
     {
-        long flen = ftell(yaz_global_log_file);
+        long flen = ftell(yaz_log_info.log_file);
         if (flen > l_max_size)
         {
             rotate_log(cur_filename);
@@ -320,9 +336,9 @@ static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
         if (new_file)
         {
             yaz_log_close();
-            yaz_global_log_file = new_file;
+            yaz_log_info.log_file = new_file;
             if (l_level & YLOG_FLUSH)
-                setvbuf(yaz_global_log_file, 0, _IONBF, 0);
+                setvbuf(yaz_log_info.log_file, 0, _IONBF, 0);
         }
         else
         {
@@ -341,12 +357,14 @@ static void yaz_log_do_reopen(const char *filemode)
     struct tm *tm;
 #endif
 
+    yaz_log_lock();
 #if HAVE_LOCALTIME_R
     localtime_r(&cur_time, tm);
 #else
     tm = localtime(&cur_time);
 #endif
     yaz_log_open_check(tm, 1, filemode);
+    yaz_log_unlock();
 }
 
 
@@ -365,7 +383,7 @@ static void yaz_strftime(char *dst, size_t sz,
 {
     strftime(dst, sz, fmt, tm);
 }
-                            
+
 static void yaz_log_to_file(int level, const char *log_message)
 {
     FILE *file;
@@ -376,35 +394,41 @@ static void yaz_log_to_file(int level, const char *log_message)
     struct tm *tm;
 #endif
 
-    internal_log_init();
-
+    yaz_log_lock();
 #if HAVE_LOCALTIME_R
     localtime_r(&ti, tm);
 #else
     tm = localtime(&ti);
 #endif
-    
-    yaz_log_open_check(tm, 0, "a");  
+
+    yaz_log_open_check(tm, 0, "a");
     file = yaz_log_file(); /* file may change in yaz_log_open_check */
 
     if (file)
     {
         char tbuf[TIMEFORMAT_LEN];
+        char tid[TID_LEN];
         char flags[1024];
         int i;
-        
+
         *flags = '\0';
         for (i = 0; level && mask_names[i].name; i++)
             if ( mask_names[i].mask & level)
             {
-                if (*mask_names[i].name && mask_names[i].mask && 
+                if (*mask_names[i].name && mask_names[i].mask &&
                     mask_names[i].mask != YLOG_ALL)
                 {
-                    sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
+                    if (strlen(flags) + strlen(mask_names[i].name)
+                                             <   sizeof(flags) - 4)
+                    {
+                        strcat(flags, "[");
+                        strcat(flags, mask_names[i].name);
+                        strcat(flags, "]");
+                    }
                     level &= ~mask_names[i].mask;
                 }
             }
-       
+
         tbuf[0] = '\0';
         if (!(l_level & YLOG_NOTIME))
         {
@@ -413,11 +437,22 @@ static void yaz_log_to_file(int level, const char *log_message)
         }
         if (tbuf[0])
             strcat(tbuf, " ");
-        fprintf(file, "%s%s%s %s%s\n", tbuf, l_prefix, flags, l_prefix2,
+        tid[0] = '\0';
+
+        if (l_level & YLOG_TID)
+        {
+            yaz_thread_id_cstr(tid, sizeof(tid)-1);
+            if (tid[0])
+                strcat(tid, " ");
+        }
+
+        fprintf(file, "%s%s%s%s %s%s\n", tbuf, yaz_log_info.l_prefix,
+                tid, flags, yaz_log_info.l_prefix2,
                 log_message);
         if (l_level & YLOG_FLUSH)
             fflush(file);
     }
+    yaz_log_unlock();
 }
 
 void yaz_log(int level, const char *fmt, ...)
@@ -427,7 +462,7 @@ void yaz_log(int level, const char *fmt, ...)
     FILE *file;
     int o_level = level;
 
-    internal_log_init();
+    yaz_init_globals();
     if (!(level & l_level))
         return;
     va_start(ap, fmt);
@@ -439,9 +474,13 @@ void yaz_log(int level, const char *fmt, ...)
 
     if (o_level & YLOG_ERRNO)
     {
-        strcat(buf, " [");
-        yaz_strerror(buf+strlen(buf), 2048);
-        strcat(buf, "]");
+        size_t remain = sizeof(buf) - strlen(buf);
+        if (remain > 100) /* reasonable minimum space for error */
+        {
+            strcat(buf, " [");
+            yaz_strerror(buf+strlen(buf), remain-5); /* 5 due to extra [] */
+            strcat(buf, "]");
+        }
     }
     va_end (ap);
     if (start_hook_func)
@@ -457,15 +496,15 @@ void yaz_log(int level, const char *fmt, ...)
 
 void yaz_log_time_format(const char *fmt)
 {
-    if ( !fmt || !*fmt) 
+    if ( !fmt || !*fmt)
     { /* no format, default to new */
         l_actual_format = l_new_default_format;
-        return; 
+        return;
     }
     if (0==strcmp(fmt, "old"))
     { /* force the old format */
         l_actual_format = l_old_default_format;
-        return; 
+        return;
     }
     /* else use custom format */
     strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
@@ -474,12 +513,12 @@ void yaz_log_time_format(const char *fmt)
 }
 
 /** cleans a loglevel name from leading paths and suffixes */
-static char *clean_name(const char *name, int len, char *namebuf, int buflen)
+static char *clean_name(const char *name, size_t len, char *namebuf, size_t buflen)
 {
     char *p = namebuf;
     char *start = namebuf;
     if (buflen <= len)
-        len = buflen-1; 
+        len = buflen-1;
     strncpy(namebuf, name, len);
     namebuf[len] = '\0';
     while ((p = strchr(start, '/')))
@@ -491,19 +530,19 @@ static char *clean_name(const char *name, int len, char *namebuf, int buflen)
 
 static int define_module_bit(const char *name)
 {
-    int i;
+    size_t i;
 
     for (i = 0; mask_names[i].name; i++)
         if (0 == strcmp(mask_names[i].name, name))
         {
             return mask_names[i].mask;
         }
-    if ( (i>=MAX_MASK_NAMES) || (next_log_bit & (1<<31) ))
+    if ( (i>=MAX_MASK_NAMES) || (next_log_bit & (1U<<31) ))
     {
         yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
         return 0;
     }
-    mask_names[i].mask = next_log_bit;
+    mask_names[i].mask = (int) next_log_bit; /* next_log_bit can hold int */
     next_log_bit = next_log_bit<<1;
     mask_names[i].name = (char *) malloc(strlen(name)+1);
     strcpy(mask_names[i].name, name);
@@ -517,32 +556,33 @@ int yaz_log_module_level(const char *name)
     int i;
     char clean[255];
     char *n = clean_name(name, strlen(name), clean, sizeof(clean));
-    internal_log_init();
-    
+    yaz_init_globals();
+
     for (i = 0; mask_names[i].name; i++)
         if (0==strcmp(n, mask_names[i].name))
         {
             yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
-                    mask_names[i].mask, n, 
+                    mask_names[i].mask, n,
                     strcmp(n,name) ? name : "");
             return mask_names[i].mask;
         }
-    yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n, 
+    yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
             strcmp(n, name) ? name : "" );
     return 0;
 }
 
 int yaz_log_mask_str(const char *str)
 {
-    internal_log_init(); /* since l_level may be affected */
+    yaz_init_globals(); /* since l_level may be affected */
     return yaz_log_mask_str_x(str, l_level);
 }
 
+/* this function is called by yaz_log_init_globals & yaz_init_globals
+   and, thus, may not call any of them indirectly */
 int yaz_log_mask_str_x(const char *str, int level)
 {
     const char *p;
 
-    internal_log_init();
     while (*str)
     {
         int negated = 0;
@@ -553,14 +593,14 @@ int yaz_log_mask_str_x(const char *str, int level)
             negated = 1;
             str++;
         }
-        if (isdigit(*(unsigned char *) str))
+        if (yaz_isdigit(*str))
         {
             level = atoi(str);
         }
-        else 
+        else
         {
             char clean[509];
-            char *n = clean_name(str, p-str, clean, sizeof(clean));
+            char *n = clean_name(str, (size_t) (p - str), clean, sizeof(clean));
             int mask = define_module_bit(n);
             if (!mask)
                 level = 0;  /* 'none' clears them all */
@@ -578,7 +618,9 @@ int yaz_log_mask_str_x(const char *str, int level)
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  */
+