yaz_log: Log level tid logs thread ID
[yaz-moved-to-github.git] / src / log.c
index 4ff5e18..b001c31 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) 1995-2010 Index Data
  * See the file LICENSE for details.
- *
- * $Id: log.c,v 1.46 2007-02-05 17:51:48 adam Exp $
  */
 
 /**
 
 #ifdef WIN32
 #include <windows.h>
+#include <sys/stat.h>
 #endif
 
-#if YAZ_POSIX_THREADS
-#include <pthread.h>
-#endif
-
-#if YAZ_GNU_THREADS
-#include <pth.h>
-#endif
-
+#if HAVE_SYS_STAT_H
 #include <sys/stat.h>
+#endif
 #include <stdio.h>
 #include <stdlib.h>
 #include <ctype.h>
 #include <stdarg.h>
 #include <errno.h>
 #include <time.h>
-#include <yaz/nmem.h>
+#include <yaz/errno.h>
+#include <yaz/thread_id.h>
 #include <yaz/log.h>
+#include <yaz/snprintf.h>
 #include <yaz/xmalloc.h>
 
-static NMEM_MUTEX log_mutex = 0;
-
-#define HAS_STRERROR 1
-
-
-#if HAS_STRERROR
-
-#else
-char *strerror(int n)
-{
-    extern char *sys_errlist[];
-    return sys_errlist[n];
-}
-
-#endif
-
-
 static int l_level = YLOG_DEFAULT_LEVEL;
 
 enum l_file_type { use_stderr, use_none, use_file };
@@ -78,14 +56,18 @@ 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 {
@@ -99,7 +81,8 @@ 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_APP3,   "app3" },
@@ -122,8 +105,6 @@ static void internal_log_init(void)
         return;
     mutex_init_flag = 1; /* here, 'cause nmem_mutex_create may call yaz_log */
 
-    nmem_mutex_create(&log_mutex);
-
     env = getenv("YAZ_LOG");
     if (env)
         l_level = yaz_log_mask_str_x(env, l_level);
@@ -186,7 +167,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;
     }
@@ -195,10 +176,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
@@ -227,10 +211,8 @@ void yaz_log_init_level(int level)
         yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
                 l_level, l_level);
         /* determine size of mask_names (locked) */
-        nmem_mutex_enter(log_mutex);
         for (sz = 0; mask_names[sz].name; sz++)
             ;
-        nmem_mutex_leave(log_mutex);
         /* second pass without lock */
         for (i = 0; i < sz; i++)
             if (mask_names[i].mask && *mask_names[i].name)
@@ -248,7 +230,7 @@ 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(l_prefix, sizeof(l_prefix), "%s ", prefix);
     else
         *l_prefix = 0;
 }
@@ -256,7 +238,7 @@ void yaz_log_init_prefix(const char *prefix)
 void yaz_log_init_prefix2(const char *prefix)
 {
     if (prefix && *prefix)
-        sprintf(l_prefix2, "%.511s ", prefix);
+        yaz_snprintf(l_prefix2, sizeof(l_prefix2), "%s ", prefix);
     else
         *l_prefix2 = 0;
 }
@@ -286,14 +268,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)
@@ -304,7 +286,7 @@ static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
     if (yaz_file_type != use_file)
         return;
 
-    if (l_fname && *l_fname)
+    if (*l_fname)
     {
         strftime(new_filename, sizeof(new_filename)-1, l_fname, tm);
         if (strcmp(new_filename, cur_filename))
@@ -354,14 +336,12 @@ static void yaz_log_do_reopen(const char *filemode)
     struct tm *tm;
 #endif
 
-    nmem_mutex_enter(log_mutex);
 #if HAVE_LOCALTIME_R
     localtime_r(&cur_time, tm);
 #else
     tm = localtime(&cur_time);
 #endif
     yaz_log_open_check(tm, 1, filemode);
-    nmem_mutex_leave(log_mutex);
 }
 
 
@@ -375,33 +355,10 @@ void yaz_log_trunc()
     yaz_log_do_reopen("w");
 }
 
-
-
 static void yaz_strftime(char *dst, size_t sz,
                          const char *fmt, const struct tm *tm)
 {
-    const char *cp = strstr(fmt, "%!");
-    if (cp && strlen(fmt) < 60)
-    {
-        char fmt2[80];
-        char tpidstr[20];
-#ifdef WIN32
-        DWORD tid = GetCurrentThreadId();
-#else
-        long tid = 0;
-#if YAZ_POSIX_THREADS
-        tid = pthread_self();
-#endif
-#endif
-        memcpy(fmt2, fmt, cp-fmt);
-        fmt2[cp-fmt] = '\0';
-        sprintf(tpidstr, "%08lx", (long) tid);
-        strcat(fmt2, tpidstr);
-        strcat(fmt2, cp+2);
-        strftime(dst, sz, fmt2, tm);     
-    }
-    else
-        strftime(dst, sz, fmt, tm);
+    strftime(dst, sz, fmt, tm);
 }
                             
 static void yaz_log_to_file(int level, const char *log_message)
@@ -416,8 +373,6 @@ static void yaz_log_to_file(int level, const char *log_message)
 
     internal_log_init();
 
-    nmem_mutex_enter(log_mutex);
-    
 #if HAVE_LOCALTIME_R
     localtime_r(&ti, tm);
 #else
@@ -430,6 +385,7 @@ static void yaz_log_to_file(int level, const char *log_message)
     if (file)
     {
         char tbuf[TIMEFORMAT_LEN];
+        char tid[TID_LEN];
         char flags[1024];
         int i;
         
@@ -440,7 +396,13 @@ static void yaz_log_to_file(int level, const char *log_message)
                 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;
                 }
             }
@@ -453,12 +415,20 @@ 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, l_prefix, tid, flags, l_prefix2,
                 log_message);
         if (l_level & YLOG_FLUSH)
             fflush(file);
     }
-    nmem_mutex_leave(log_mutex);
 }
 
 void yaz_log(int level, const char *fmt, ...)
@@ -472,22 +442,21 @@ void yaz_log(int level, const char *fmt, ...)
     if (!(level & l_level))
         return;
     va_start(ap, fmt);
-#ifdef WIN32
-    _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
-#else
-/* !WIN32 */
-#if HAVE_VSNPRINTF
-    vsnprintf(buf, sizeof(buf), fmt, ap);
-#else
-    vsprintf(buf, fmt, ap);
-#endif
-#endif
-/* WIN32 */
+
+    /* 30 is enough for our 'rest of output' message */
+    yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
+    if (strlen(buf) >= sizeof(buf)-31)
+        strcat(buf, " [rest of output omitted]");
+
     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)
@@ -520,7 +489,7 @@ 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;
@@ -537,28 +506,24 @@ 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;
 
-    nmem_mutex_enter(log_mutex);
     for (i = 0; mask_names[i].name; i++)
         if (0 == strcmp(mask_names[i].name, name))
         {
-            nmem_mutex_leave(log_mutex);
             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) ))
     {
-        nmem_mutex_leave(log_mutex);
         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 = malloc(strlen(name)+1);
+    mask_names[i].name = (char *) malloc(strlen(name)+1);
     strcpy(mask_names[i].name, name);
     mask_names[i+1].name = NULL;
     mask_names[i+1].mask = 0;
-    nmem_mutex_leave(log_mutex);
     return mask_names[i].mask;
 }
 
@@ -569,17 +534,14 @@ int yaz_log_module_level(const char *name)
     char *n = clean_name(name, strlen(name), clean, sizeof(clean));
     internal_log_init();
     
-    nmem_mutex_enter(log_mutex);
     for (i = 0; mask_names[i].name; i++)
         if (0==strcmp(n, mask_names[i].name))
         {
-            nmem_mutex_leave(log_mutex);
             yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
                     mask_names[i].mask, n, 
                     strcmp(n,name) ? name : "");
             return mask_names[i].mask;
         }
-    nmem_mutex_leave(log_mutex);
     yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n, 
             strcmp(n, name) ? name : "" );
     return 0;
@@ -613,7 +575,7 @@ int yaz_log_mask_str_x(const char *str, int level)
         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 */
@@ -631,7 +593,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
  */
+