/*
- * Copyright (C) 1995-2005, Index Data ApS
+ * Copyright (C) 1995-2007, Index Data ApS
* See the file LICENSE for details.
*
- * $Id: log.c,v 1.32 2006-03-21 12:54:02 adam Exp $
+ * $Id: log.c,v 1.54 2007-06-05 06:42:26 adam Exp $
*/
/**
* \file log.c
- * \brief Implements logging utility
+ * \brief Logging utility
*/
#if HAVE_CONFIG_H
#include <windows.h>
#endif
-#if YAZ_POSIX_THREADS
-#include <pthread.h>
-#endif
-
-#if YAZ_GNU_THREADS
-#include <pth.h>
-#endif
-
+#include <sys/stat.h>
#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>
#include <time.h>
#include <yaz/nmem.h>
#include <yaz/log.h>
+#include <yaz/snprintf.h>
#include <yaz/xmalloc.h>
-static NMEM_MUTEX log_mutex = 0;
-static int mutex_init_flag = 0; /* not yet initialized */
-
#define HAS_STRERROR 1
#endif
-static int default_log_level() {
- char *env = getenv("YAZ_LOG");
- if (env != 0)
- return yaz_log_mask_str_x(env, YLOG_DEFAULT_LEVEL);
- else
- return YLOG_DEFAULT_LEVEL;
-}
-
-
-static int l_level = -1; /* will be set from default_log_level() */
+static int l_level = YLOG_DEFAULT_LEVEL;
-enum l_file_type { use_stderr, use_none, use_file };
+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;
+static void (*start_hook_func)(int, const char *, void *) = NULL;
+static void *start_hook_info;
+
+static void (*end_hook_func)(int, const char *, void *) = NULL;
+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_custom_format[TIMEFORMAT_LEN] = "";
static char *l_actual_format = l_old_default_format;
-/** l_max_size tells when to rotate the log. Default to 1 GB */
-static const int l_def_max_size = 1024*1024*1024;
+/** 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..
+ */
static int l_max_size = 1024*1024*1024;
#define MAX_MASK_NAMES 35 /* 32 bits plus a few combo names */
static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
-static void init_mutex()
+static void internal_log_init(void)
{
+ static int mutex_init_flag = 0; /* not yet initialized */
+ char *env;
+
if (mutex_init_flag)
return;
- nmem_mutex_create(&log_mutex);
- mutex_init_flag = 1;
+ mutex_init_flag = 1; /* here, 'cause nmem_mutex_create may call yaz_log */
+
+ env = getenv("YAZ_LOG");
+ if (env)
+ l_level = yaz_log_mask_str_x(env, l_level);
}
+
FILE *yaz_log_file(void)
{
FILE *f = 0;
return f;
}
-void yaz_log_close()
+void yaz_log_close(void)
{
if (yaz_file_type == use_file && yaz_global_log_file)
{
void yaz_log_init_file(const char *fname)
{
- init_mutex();
+ internal_log_init();
yaz_log_close();
if (fname)
static void rotate_log(const char *cur_fname)
{
- char newname[512];
- strncpy(newname, cur_fname, 509);
- newname[509] = '\0'; /* make sure it is terminated */
- strcat(newname, ".1");
+ int i;
+
#ifdef WIN32
/* windows can't rename a file if it is open */
- fclose(l_file);
- l_file = 0;
- MoveFileEx(cur_fname, newname, MOVEFILE_REPLACE_EXISTING);
+ yaz_log_close();
+#endif
+ for (i = 0; i<9; i++)
+ {
+ char fname_str[FILENAME_MAX];
+ struct stat stat_buf;
+
+ yaz_snprintf(fname_str, sizeof(fname_str), "%s.%d", cur_fname, i);
+ if (stat(fname_str, &stat_buf) != 0)
+ break;
+ }
+ for (; i >= 0; --i)
+ {
+ char fname_str[2][FILENAME_MAX];
+
+ if (i > 0)
+ yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
+ "%s.%d", cur_fname, i-1);
+ else
+ 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
- rename(cur_fname, newname);
+ rename(fname_str[0], fname_str[1]);
#endif
+ }
}
+
void yaz_log_init_level(int level)
{
- init_mutex();
- if (l_level < 0) l_level = default_log_level();
+ internal_log_init();
if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
{
l_level = level;
yaz_log_reopen(); /* make sure we set buffering right */
- } else
+ }
+ else
l_level = level;
+
if (l_level & YLOG_LOGLVL)
{ /* dump the log level bits */
const char *bittype = "Static ";
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)
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;
}
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;
}
void yaz_log_init(int level, const char *prefix, const char *fname)
{
- init_mutex();
+ internal_log_init();
yaz_log_init_level(level);
yaz_log_init_prefix(prefix);
if (fname && *fname)
void yaz_log_init_max_size(int mx)
{
- if (mx <0)
- l_max_size = l_def_max_size;
- else
+ if (mx > 0)
l_max_size = mx;
+ else
+ l_max_size = 0;
}
-static void (*hook_func)(int, const char *, void *) = NULL;
-static void *hook_info;
-
void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info)
{
hook_func = func;
hook_info = info;
}
-static void yaz_log_open_check(struct tm *tm, int force)
+void log_event_start(void (*func)(int, const char *, void *), void *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;
+}
+
+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)
+ return;
+
if (l_fname && *l_fname)
{
strftime(new_filename, sizeof(new_filename)-1, l_fname, tm);
}
}
- if (l_max_size > 0 && yaz_global_log_file && yaz_file_type == use_file)
+ if (l_max_size > 0 && yaz_global_log_file)
{
long flen = ftell(yaz_global_log_file);
if (flen > l_max_size)
force = 1;
}
}
- if (force && yaz_file_type == use_file && *cur_filename)
+ if (force && *cur_filename)
{
+ FILE *new_file;
+#ifdef WIN32
yaz_log_close();
- yaz_global_log_file = fopen(cur_filename, "a");
- if (l_level < 0) l_level = default_log_level();
- if (l_level & YLOG_FLUSH)
- setvbuf(yaz_global_log_file, 0, _IONBF, 0);
+#endif
+ new_file = fopen(cur_filename, filemode);
+ if (new_file)
+ {
+ yaz_log_close();
+ yaz_global_log_file = new_file;
+ if (l_level & YLOG_FLUSH)
+ setvbuf(yaz_global_log_file, 0, _IONBF, 0);
+ }
+ else
+ {
+ /* disable log rotate */
+ l_max_size = 0;
+ }
}
}
-void yaz_log_reopen()
+static void yaz_log_do_reopen(const char *filemode)
{
time_t cur_time = time(0);
#if HAVE_LOCALTIME_R
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);
- nmem_mutex_leave(log_mutex);
+ yaz_log_open_check(tm, 1, filemode);
+}
+
+
+void yaz_log_reopen()
+{
+ yaz_log_do_reopen("a");
}
-static void yaz_log_to_file(int level, FILE *file, const char *buf)
+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)
+{
+ strftime(dst, sz, fmt, tm);
+}
+
+static void yaz_log_to_file(int level, const char *log_message)
{
+ FILE *file;
time_t ti = time(0);
- int i;
#if HAVE_LOCALTIME_R
struct tm tm0, *tm = &tm0;
#else
struct tm *tm;
#endif
- init_mutex();
-
- nmem_mutex_enter(log_mutex);
+ internal_log_init();
- #if HAVE_LOCALTIME_R
+#if HAVE_LOCALTIME_R
localtime_r(&ti, tm);
#else
tm = localtime(&ti);
#endif
- yaz_log_open_check(tm, 0);
+ 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 flags[1024];
+ int i;
*flags = '\0';
for (i = 0; level && mask_names[i].name; i++)
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;
}
}
-
- if (l_level & YLOG_NOTIME)
- tbuf[0] = '\0';
- else
- strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tm);
- tbuf[TIMEFORMAT_LEN-1] = '\0';
-
- fprintf(file, "%s %s%s %s%s\n", tbuf, l_prefix, flags, l_prefix2, buf);
- if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
+
+ tbuf[0] = '\0';
+ if (!(l_level & YLOG_NOTIME))
+ {
+ yaz_strftime(tbuf, TIMEFORMAT_LEN-2, l_actual_format, tm);
+ tbuf[TIMEFORMAT_LEN-2] = '\0';
+ }
+ if (tbuf[0])
+ strcat(tbuf, " ");
+ fprintf(file, "%s%s%s %s%s\n", tbuf, l_prefix, 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, ...)
FILE *file;
int o_level = level;
- if (l_level < 0)
- l_level = default_log_level();
+ internal_log_init();
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, "]");
+ int 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)
+ (*start_hook_func)(o_level, buf, start_hook_info);
if (hook_func)
(*hook_func)(o_level, buf, hook_info);
-
file = yaz_log_file();
if (file)
- yaz_log_to_file(level, file, buf);
+ yaz_log_to_file(level, buf);
+ if (end_hook_func)
+ (*end_hook_func)(o_level, buf, end_hook_info);
}
void yaz_log_time_format(const char *fmt)
static int define_module_bit(const char *name)
{
int i;
- init_mutex();
- 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 & (1<<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;
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;
}
int i;
char clean[255];
char *n = clean_name(name, strlen(name), clean, sizeof(clean));
- init_mutex();
+ 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 : "" );
+ strcmp(n, name) ? name : "" );
return 0;
}
int yaz_log_mask_str(const char *str)
{
- return yaz_log_mask_str_x(str, default_log_level());
+ internal_log_init(); /* since l_level may be affected */
+ return yaz_log_mask_str_x(str, l_level);
}
int yaz_log_mask_str_x(const char *str, int level)
{
const char *p;
+ internal_log_init();
while (*str)
{
int negated = 0;