X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=src%2Flog.c;h=38ecac7ef6f4a7962cd29828e4e3701cdae29500;hp=ea3b9f8319c04a7b4b5a29a5d90408aac5a93b53;hb=05193e78a2553c93a61da19a39e1276b1a509bac;hpb=0e967e932ab262eb724f19922594359a4bb3336e diff --git a/src/log.c b/src/log.c index ea3b9f8..38ecac7 100644 --- a/src/log.c +++ b/src/log.c @@ -1,13 +1,11 @@ -/* - * Copyright (c) 1995-2004, Index Data +/* This file is part of the YAZ toolkit. + * Copyright (C) Index Data * See the file LICENSE for details. - * - * $Id: log.c,v 1.7 2004-11-02 14:13:09 heikki Exp $ */ /** * \file log.c - * \brief Implements logging utility + * \brief Logging utility */ #if HAVE_CONFIG_H @@ -16,291 +14,620 @@ #ifdef WIN32 #include +#include #endif +#if HAVE_SYS_STAT_H +#include +#endif #include #include -#include #include #include #include #include -#include +#include +#include +#include #include +#include +#include +#include +#if YAZ_POSIX_THREADS +#include +#endif -#define HAS_STRERROR 1 +static int l_level = YLOG_DEFAULT_LEVEL; -#if HAS_STRERROR +enum l_file_type { use_stderr, use_none, use_file }; -#else -char *strerror(int n) -{ - extern char *sys_errlist[]; - return sys_errlist[n]; -} +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, "", "", "" +}; -#endif +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 int l_level = LOG_DEFAULT_LEVEL; -static FILE *l_file = NULL; -static char l_prefix[512] = ""; -static char l_prefix2[512] = ""; -static char l_fname[512] = ""; +static void (*hook_func)(int, const char *, void *) = NULL; +static void *hook_info; -static char l_old_default_format[]="%H:%M:%S-%d/%m"; -static char l_new_default_format[]="%Y%m%d-%H%M%S"; +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 -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 int l_max_size=1024*1024*1024; -/* static int l_max_size=1024; */ /* while testing */ +#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. 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 = 0; +#define MAX_MASK_NAMES 35 /* 32 bits plus a few combo names */ static struct { int mask; char *name; -} mask_names[] = +} mask_names[MAX_MASK_NAMES] = { - { LOG_FATAL, "fatal"}, - { LOG_DEBUG, "debug"}, - { LOG_WARN, "warn" }, - { LOG_LOG, "log" }, - { LOG_ERRNO, ""}, - { LOG_MALLOC, "malloc"}, - { LOG_APP, "app" }, - { LOG_NOTIME, "" }, - { LOG_APP2 , "app2" }, - { LOG_APP3 , "app3" }, - { LOG_ALL, "all" }, - { LOG_FLUSH, "flush" }, - { 0, "none" }, + { YLOG_FATAL, "fatal"}, + { YLOG_DEBUG, "debug"}, + { YLOG_WARN, "warn" }, + { YLOG_LOG, "log" }, + { YLOG_ERRNO, ""}, + { YLOG_MALLOC, "malloc"}, + { YLOG_TID, "tid" }, + { YLOG_APP, "app" }, + { YLOG_NOTIME, "notime" }, + { YLOG_APP2, "app2" }, + { YLOG_APP3, "app3" }, + { YLOG_ALL, "all" }, + { YLOG_FLUSH, "flush" }, + { 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 YAZ_MUTEX log_mutex = 0; + +static void yaz_log_lock(void) +{ + yaz_mutex_enter(log_mutex); +} + +static void yaz_log_unlock(void) +{ + yaz_mutex_leave(log_mutex); +} + +static void internal_log_init(void) +{ + static int mutex_init_flag = 0; /* not yet initialized */ + char *env; + + if (mutex_init_flag) + return; + mutex_init_flag = 1; /* here, 'cause nmem_mutex_create may call yaz_log */ + + 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) { - if (!l_file) - l_file = stderr; - return l_file; + FILE *f = 0; + switch (yaz_log_info.type) + { + case use_stderr: f = stderr; break; + case use_none: f = 0; break; + case use_file: f = yaz_log_info.log_file; break; + } + return f; } -void yaz_log_init_file (const char *fname) +void yaz_log_close(void) { + if (yaz_log_info.type == use_file && yaz_log_info.log_file) + { + fclose(yaz_log_info.log_file); + yaz_log_info.log_file = 0; + } +} + +void yaz_log_init_file(const char *fname) +{ + internal_log_init(); + + yaz_log_close(); if (fname) { - strncpy(l_fname, fname, sizeof(l_fname)-1); - l_fname[sizeof(l_fname)-1] = '\0'; + if (*fname == '\0') + yaz_log_info.type = use_stderr; /* empty name; use stderr */ + else + 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 - 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(); } -void yaz_log_reopen(void) +static void rotate_log(const char *cur_fname) { - FILE *new_file; - if (!l_file) - l_file = stderr; + int i; - if (!*l_fname) - new_file=stderr; - else if (!(new_file = fopen(l_fname, "a"))) - return; - if (l_file != stderr) +#ifdef WIN32 + /* windows can't rename a file if it is open */ + yaz_log_close(); +#endif + for (i = 0; i<9; i++) { - fclose (l_file); + 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; } - if (l_level & LOG_FLUSH) - setvbuf(new_file, 0, _IONBF, 0); - l_file = new_file; -} + for (; i >= 0; --i) + { + char fname_str[2][FILENAME_MAX]; -static void rotate_log() -{ - char newname[512]; - if (l_file==stderr) - return; /* can't rotate that */ - if (!*l_fname) - return; /* hmm, no name, can't rotate */ - strncpy(newname, l_fname, 510); - newname[510]='\0'; /* make sure it is terminated */ - strcat(newname,".1"); + 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 - fclose(l_file); - l_file=stderr; + MoveFileEx(fname_str[0], fname_str[1], MOVEFILE_REPLACE_EXISTING); +#else + rename(fname_str[0], fname_str[1]); #endif - rename(l_fname, newname); - yaz_log_reopen(); + } } -void yaz_log_init_level (int level) +void yaz_log_init_level(int level) { - if ( (l_level & LOG_FLUSH) != (level & LOG_FLUSH) ) + 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 "; + int i, sz; + + yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x", + l_level, l_level); + /* determine size of mask_names (locked) */ + for (sz = 0; mask_names[sz].name; sz++) + ; + /* second pass without lock */ + for (i = 0; i < sz; i++) + if (mask_names[i].mask && *mask_names[i].name) + if (strcmp(mask_names[i].name, "all") != 0) + { + yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s", + bittype, mask_names[i].mask, mask_names[i].name, + (level & mask_names[i].mask)? "ON": "off"); + if (mask_names[i].mask > YLOG_LAST_BIT) + bittype = "Dynamic"; + } + } } -void yaz_log_init_prefix (const char *prefix) +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) +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) { - yaz_log_init_level (level); - yaz_log_init_prefix (prefix); + internal_log_init(); + yaz_log_init_level(level); + yaz_log_init_prefix(prefix); if (fname && *fname) - yaz_log_init_file (fname); + yaz_log_init_file(fname); } -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; +void yaz_log_init_max_size(int mx) +{ + if (mx > 0) + l_max_size = mx; + else + l_max_size = 0; +} -void log_event_start (void (*func)(int, const char *, void *), void *info) +void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info) +{ + hook_func = func; + hook_info = info; +} + +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) +void log_event_end(void (*func)(int, const char *, void *), void *info) { end_hook_func = func; end_hook_info = info; } -void yaz_log(int level, const char *fmt, ...) +static void yaz_log_open_check(struct tm *tm, int force, const char *filemode) { - va_list ap; - char buf[4096], flags[1024]; - int i; - time_t ti; - struct tm *tim; - char tbuf[TIMEFORMAT_LEN]=""; - int o_level = level; - int flen; + char new_filename[512]; + static char cur_filename[512] = ""; - if (!(level & l_level)) - return; - if (!l_file) - l_file = stderr; - - if (l_file != stderr) + if (yaz_log_info.type != use_file) + return; + + if (*yaz_log_info.l_fname) { - flen=ftell(l_file); - if (flen>l_max_size) - rotate_log(); + strftime(new_filename, sizeof(new_filename)-1, yaz_log_info.l_fname, + tm); + if (strcmp(new_filename, cur_filename)) + { + strcpy(cur_filename, new_filename); + force = 1; + } } - *flags = '\0'; - for (i = 0; level && mask_names[i].name; i++) - if (mask_names[i].mask & level) - { - if (*mask_names[i].name) - sprintf(flags + strlen(flags), "[%s]", mask_names[i].name); - level -= mask_names[i].mask; - } - va_start(ap, fmt); + if (l_max_size > 0 && yaz_log_info.log_file) + { + long flen = ftell(yaz_log_info.log_file); + if (flen > l_max_size) + { + rotate_log(cur_filename); + force = 1; + } + } + if (force && *cur_filename) + { + FILE *new_file; #ifdef WIN32 - _vsnprintf(buf, sizeof(buf)-1, fmt, ap); + yaz_log_close(); +#endif + new_file = fopen(cur_filename, filemode); + if (new_file) + { + yaz_log_close(); + yaz_log_info.log_file = new_file; + if (l_level & YLOG_FLUSH) + setvbuf(yaz_log_info.log_file, 0, _IONBF, 0); + } + else + { + /* disable log rotate */ + l_max_size = 0; + } + } +} + +static void yaz_log_do_reopen(const char *filemode) +{ + time_t cur_time = time(0); +#if HAVE_LOCALTIME_R + struct tm tm0, *tm = &tm0; #else -/* !WIN32 */ -#if HAVE_VSNPRINTF - vsnprintf(buf, sizeof(buf), fmt, ap); + struct tm *tm; +#endif + + yaz_log_lock(); +#if HAVE_LOCALTIME_R + localtime_r(&cur_time, tm); #else - vsprintf(buf, fmt, ap); + tm = localtime(&cur_time); #endif + yaz_log_open_check(tm, 1, filemode); + yaz_log_unlock(); +} + + +void yaz_log_reopen() +{ + yaz_log_do_reopen("a"); +} + +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); +#if HAVE_LOCALTIME_R + struct tm tm0, *tm = &tm0; +#else + struct tm *tm; #endif -/* WIN32 */ - if (o_level & LOG_ERRNO) + + 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"); + file = yaz_log_file(); /* file may change in yaz_log_open_check */ + + if (file) { - strcat(buf, " ["); - yaz_strerror(buf+strlen(buf), 2048); - strcat(buf, "]"); + 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 && + mask_names[i].mask != YLOG_ALL) + { + 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)) + { + yaz_strftime(tbuf, TIMEFORMAT_LEN-2, l_actual_format, tm); + tbuf[TIMEFORMAT_LEN-2] = '\0'; + } + if (tbuf[0]) + strcat(tbuf, " "); + 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, ...) +{ + va_list ap; + char buf[4096]; + FILE *file; + int o_level = level; + + internal_log_init(); + if (!(level & l_level)) + return; + va_start(ap, fmt); + + /* 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) + { + 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) (*start_hook_func)(o_level, buf, start_hook_info); - ti = time(0); - tim = localtime(&ti); - if (l_level & LOG_NOTIME) - tbuf[0]='\0'; - else - strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tim); - tbuf[TIMEFORMAT_LEN-1]='\0'; - fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags, - l_prefix2, buf); - if (l_level & (LOG_FLUSH|LOG_DEBUG) ) - fflush(l_file); + if (hook_func) + (*hook_func)(o_level, buf, hook_info); + file = yaz_log_file(); + if (file) + yaz_log_to_file(level, buf); if (end_hook_func) - (*end_hook_func)(o_level, buf, end_hook_info); + (*end_hook_func)(o_level, buf, end_hook_info); } 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")) + 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); - l_custom_format[TIMEFORMAT_LEN-1]='\0'; + l_custom_format[TIMEFORMAT_LEN-1] = '\0'; l_actual_format = l_custom_format; } -int yaz_log_mask_str (const char *str) +/** cleans a loglevel name from leading paths and suffixes */ +static char *clean_name(const char *name, size_t len, char *namebuf, size_t buflen) { - return yaz_log_mask_str_x (str, LOG_DEFAULT_LEVEL); + char *p = namebuf; + char *start = namebuf; + if (buflen <= len) + len = buflen-1; + strncpy(namebuf, name, len); + namebuf[len] = '\0'; + while ((p = strchr(start, '/'))) + start = p+1; + if ((p = strrchr(start, '.'))) + *p = '\0'; + return start; } -int yaz_log_mask_str_x (const char *str, int level) +static int define_module_bit(const char *name) +{ + 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 & (1U<<31) )) + { + yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name); + return 0; + } + 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); + mask_names[i+1].name = NULL; + mask_names[i+1].mask = 0; + return mask_names[i].mask; +} + +int yaz_log_module_level(const char *name) { - const char *p; int i; + char clean[255]; + char *n = clean_name(name, strlen(name), clean, sizeof(clean)); + internal_log_init(); + + 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, + strcmp(n,name) ? name : ""); + return mask_names[i].mask; + } + 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 */ + 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; for (p = str; *p && *p != ','; p++) ; - if (*str == '-' || isdigit(*str)) - level = atoi (str); + if (*str=='-') + { + negated = 1; + str++; + } + if (yaz_isdigit(*str)) + { + level = atoi(str); + } else - for (i = 0; mask_names[i].name; i++) - if (strlen (mask_names[i].name) == (size_t) (p-str) && - memcmp (mask_names[i].name, str, p-str) == 0) - { - if (mask_names[i].mask) - level |= mask_names[i].mask; - else - level = 0; - } + { + char clean[509]; + 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 */ + else if (negated) + level &= ~mask; + else + level |= mask; + } if (*p == ',') p++; str = p; } return level; } +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +