From 8d57c383d5f05e759cb31b33a5b78b3cea2033d6 Mon Sep 17 00:00:00 2001 From: Heikki Levanto Date: Wed, 3 Nov 2004 14:25:06 +0000 Subject: [PATCH] Added dynamic log-levels: - yaz_log_mask_str (and _x) can now be called with a previously unknown name, which will get a new log bit assigned. This happens in most programs when parsing the -v command line option. - yaz_log_module_level can be called with a name, and if that name has got a bit defined, this bit will be returned, otherwise zero. This can then be used as the log_level in yaz_log and logf calls. - the names are cleaned from prefix paths and suffixes, so ./foo.c becomes foo. Also added a routine to set the maximum log size, and a few comments in log.h --- include/yaz/log.h | 48 +++++++++++++++++++++-- src/log.c | 113 +++++++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 137 insertions(+), 24 deletions(-) diff --git a/include/yaz/log.h b/include/yaz/log.h index e778932..bd4d516 100644 --- a/include/yaz/log.h +++ b/include/yaz/log.h @@ -23,7 +23,7 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: log.h,v 1.15 2004-11-02 12:55:04 heikki Exp $ + * $Id: log.h,v 1.16 2004-11-03 14:25:06 heikki Exp $ */ /** @@ -57,29 +57,71 @@ YAZ_BEGIN_CDECL #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN) +#define LOG_LAST_BIT LOG_FLUSH /* the last bit used for regular log bits */ + /* the rest are for dynamic modules */ + #define logf yaz_log +/** + * yaz_log_init is a shorthand for initializing the log level and prefixes */ YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *name); + +/** yaz_log_init_file sets the file name used for yaz_log */ YAZ_EXPORT void yaz_log_init_file (const char *fname); + +/** yaz_log_init_level sets the logging level. Use an OR of the bits above */ YAZ_EXPORT void yaz_log_init_level (int level); + +/** yaz_log_init_prefix sets the log prefix */ YAZ_EXPORT void yaz_log_init_prefix (const char *prefix); + +/** yaz_log_init_prefix2 sets an optional second prefix */ YAZ_EXPORT void yaz_log_init_prefix2 (const char *prefix); + /** * yaz_log_time_format sets the format of the timestamp. See man 3 strftime * Calling with "old" sets to the old format "11:55:06-02/11" * Calling with NULL or "" sets to the new format "20041102-115719" * If not called at all, the old format is used, for backward compatibility - * - * */ + */ YAZ_EXPORT void yaz_log_time_format(const char *fmt); +/** + * yaz_log_init_max_size sets the max size for a log file. + * zero means no limit. Negative means built-in limit (1GB) + */ +YAZ_EXPORT void yaz_log_init_max_size(int mx); + +/** + * yaz_log writes an entry in the log. Defaults to stderr if not initialized + * to a file with yaz_log_init_file. The level must match the level set via + * yaz_log_init_level, optionally defined via yaz_log_mask_str. */ YAZ_EXPORT void yaz_log(int level, const char *fmt, ...) #ifdef __GNUC__ __attribute__ ((format (printf, 2, 3))) #endif ; + +/** + * yaz_log_mask_str converts a comma-separated list of log levels to a bit + * mask. Starts from default level, and adds bits as specified, unless 'none' + * is specified, which clears the list. If a name matches the name of a + * LOG_BIT above, that one is set. Otherwise a new value is picked, and given + * to that name, to be found with yaz_log_module_level */ YAZ_EXPORT int yaz_log_mask_str (const char *str); + +/** yaz_log_mask_str_x is like yaz_log_mask_str, but with a given start value*/ YAZ_EXPORT int yaz_log_mask_str_x (const char *str, int level); + +/** + * yaz_log_module_level returns a log level mask corresponding to the module + * name. If that had been specified on the -v arguments (that is, passed to + * yaz_log_mask_str), then a non-zero mask is returned. If not, we get a + * zero. This can later be used in yaz_log for the level argument + */ +YAZ_EXPORT int yaz_log_module_level(const char *name); + +/** yaz_log_file returns the file handle for yaz_log. */ YAZ_EXPORT FILE *yaz_log_file(void); YAZ_EXPORT void log_event_start (void (*func)(int level, const char *msg, void *info), diff --git a/src/log.c b/src/log.c index 8c750a6..640b66b 100644 --- a/src/log.c +++ b/src/log.c @@ -2,7 +2,7 @@ * Copyright (c) 1995-2004, Index Data * See the file LICENSE for details. * - * $Id: log.c,v 1.8 2004-11-02 15:47:31 heikki Exp $ + * $Id: log.c,v 1.9 2004-11-03 14:25:06 heikki Exp $ */ /** @@ -38,7 +38,7 @@ #include static NMEM_MUTEX log_mutex=0; -static mutex_init_flag=0; /* not yet initialized */ +static int mutex_init_flag=0; /* not yet initialized */ #define HAS_STRERROR 1 @@ -68,29 +68,32 @@ 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 */ +static const int l_def_max_size=1024*1024*1024; +static int l_max_size=1024*1024*1024; +#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_FATAL, "fatal"}, + { LOG_DEBUG, "debug"}, + { LOG_WARN, "warn" }, + { LOG_LOG, "log" }, + { LOG_ERRNO, ""}, { LOG_MALLOC, "malloc"}, - { LOG_APP, "app" }, + { LOG_APP, "app" }, { LOG_NOTIME, "" }, - { LOG_APP2 , "app2" }, - { LOG_APP3 , "app3" }, - { LOG_ALL, "all" }, - { LOG_FLUSH, "flush" }, - { 0, "none" }, + { LOG_APP2, "app2" }, + { LOG_APP3, "app3" }, + { LOG_ALL, "all" }, + { LOG_FLUSH, "flush" }, + { 0, "none" }, { 0, NULL } + /* the rest will be filled in if the user defines dynamic modules*/ }; +static unsigned int next_log_bit=LOG_LAST_BIT<<1; /* first dynamic bit */ static void init_mutex() { @@ -197,6 +200,14 @@ void yaz_log_init(int level, const char *prefix, const char *fname) yaz_log_init_file (fname); } +void yaz_log_init_max_size(int mx) +{ + if (mx <0) + l_max_size=l_def_max_size; + else + l_max_size=mx; +} + 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; @@ -232,7 +243,7 @@ void yaz_log(int level, const char *fmt, ...) if (!l_file) l_file = stderr; - if (l_file != stderr) + if ((l_file != stderr) && (l_max_size>0)) { nmem_mutex_enter (log_mutex); flen=ftell(l_file); @@ -243,9 +254,10 @@ void yaz_log(int level, const char *fmt, ...) *flags = '\0'; for (i = 0; level && mask_names[i].name; i++) - if (mask_names[i].mask & level) + if ( mask_names[i].mask & level) { - if (*mask_names[i].name) + if (*mask_names[i].name && mask_names[i].mask && + mask_names[i].mask != LOG_ALL) sprintf(flags + strlen(flags), "[%s]", mask_names[i].name); level -= mask_names[i].mask; } @@ -303,6 +315,53 @@ void yaz_log_time_format(const char *fmt) l_actual_format = l_custom_format; } +/** cleans a loglevel name from leading paths and suffixes */ +static char *clean_name(const char *name, int len, char *namebuf, int buflen) +{ + char *p; + char *start; + if (buflen =MAX_MASK_NAMES) || (next_log_bit >= 1<<31 )) + { + yaz_log(LOG_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=xstrdup(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) +{ + int i; + char clean[255]; + char *n=clean_name(name, strlen(name), clean, sizeof(clean)); + for (i=0;mask_names[i].name;i++) + if (0==strcmp(n,mask_names[i].name)) + return mask_names[i].mask; + return 0; +} + int yaz_log_mask_str (const char *str) { return yaz_log_mask_str_x (str, LOG_DEFAULT_LEVEL); @@ -312,23 +371,35 @@ int yaz_log_mask_str_x (const char *str, int level) { const char *p; int i; + int found; + char clean[255]; + char *n; while (*str) { + found=0; for (p = str; *p && *p != ','; p++) ; if (*str == '-' || isdigit(*str)) + { level = atoi (str); + found=1; + } else + n=clean_name(str, p-str, clean, sizeof(clean)); 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 (strlen (mask_names[i].name) == (size_t) (p-str) && + memcmp (mask_names[i].name, str, p-str) == 0)*/ + if (0==strcmp (mask_names[i].name,n)) { if (mask_names[i].mask) level |= mask_names[i].mask; else level = 0; + found=1; } + if (!found) + level |= define_module_bit(n); if (*p == ',') p++; str = p; -- 1.7.10.4