2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: log.c,v 1.27 2005-09-09 11:29:54 adam Exp $
10 * \brief Implements logging utility
38 #include <yaz/xmalloc.h>
40 static NMEM_MUTEX log_mutex = 0;
41 static int mutex_init_flag = 0; /* not yet initialized */
43 #define HAS_STRERROR 1
50 extern char *sys_errlist[];
51 return sys_errlist[n];
58 static int l_level = YLOG_DEFAULT_LEVEL;
59 static FILE *l_file = NULL;
60 static char l_prefix[512] = "";
61 static char l_prefix2[512] = "";
62 static char l_fname[512] = "";
64 static char l_old_default_format[] = "%H:%M:%S-%d/%m";
65 static char l_new_default_format[] = "%Y%m%d-%H%M%S";
66 #define TIMEFORMAT_LEN 50
67 static char l_custom_format[TIMEFORMAT_LEN] = "";
68 static char *l_actual_format = l_old_default_format;
70 /** l_max_size tells when to rotate the log. Default to 1 GB */
71 static const int l_def_max_size = 1024*1024*1024;
72 static int l_max_size = 1024*1024*1024;
74 #define MAX_MASK_NAMES 35 /* 32 bits plus a few combo names */
78 } mask_names[MAX_MASK_NAMES] =
80 { YLOG_FATAL, "fatal"},
81 { YLOG_DEBUG, "debug"},
82 { YLOG_WARN, "warn" },
85 { YLOG_MALLOC, "malloc"},
87 { YLOG_NOTIME, "notime" },
88 { YLOG_APP2, "app2" },
89 { YLOG_APP3, "app3" },
91 { YLOG_FLUSH, "flush" },
92 { YLOG_LOGLVL, "loglevel" },
95 /* the rest will be filled in if the user defines dynamic modules*/
97 static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
99 static void init_mutex()
103 nmem_mutex_create (&log_mutex);
108 FILE *yaz_log_file(void)
115 void yaz_log_init_file (const char *fname)
120 strncpy(l_fname, fname, sizeof(l_fname)-1);
121 l_fname[sizeof(l_fname)-1] = '\0';
128 void yaz_log_reopen(void)
136 else if (!(new_file = fopen(l_fname, "a")))
139 l_file=stderr; /* just to be sure we don't rotate logs and recurse */
140 yaz_log(YLOG_WARN|YLOG_ERRNO,"Could not open log file '%s'",l_fname);
141 l_file=new_file; /* restore to old value, probably stderr as well */
144 if (l_file != stderr)
148 if (l_level & YLOG_FLUSH)
149 setvbuf(new_file, 0, _IONBF, 0);
153 static void rotate_log()
157 return; /* can't rotate that */
159 return; /* hmm, no name, can't rotate */
160 strncpy(newname, l_fname, 509);
161 newname[509] = '\0'; /* make sure it is terminated */
162 strcat(newname,".1");
164 /* windows can't rename a file if it is open */
167 MoveFileEx(l_fname, newname, MOVEFILE_REPLACE_EXISTING);
169 rename(l_fname, newname);
175 void yaz_log_init_level (int level)
178 if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
181 yaz_log_reopen(); /* make sure we set buffering right */
184 if (l_level & YLOG_LOGLVL)
185 { /* dump the log level bits */
186 const char *bittype = "Static ";
189 yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
191 /* determine size of mask_names (locked) */
192 nmem_mutex_enter(log_mutex);
193 for (sz = 0; mask_names[sz].name; sz++)
195 nmem_mutex_leave(log_mutex);
196 /* second pass without lock */
197 for (i = 0; i < sz; i++)
198 if (mask_names[i].mask && *mask_names[i].name)
199 if (strcmp(mask_names[i].name, "all") != 0)
201 yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s",
202 bittype, mask_names[i].mask, mask_names[i].name,
203 (level & mask_names[i].mask)? "ON": "off");
204 if (mask_names[i].mask > YLOG_LAST_BIT)
210 void yaz_log_init_prefix (const char *prefix)
212 if (prefix && *prefix)
213 sprintf(l_prefix, "%.511s ", prefix);
218 void yaz_log_init_prefix2 (const char *prefix)
220 if (prefix && *prefix)
221 sprintf(l_prefix2, "%.511s ", prefix);
226 void yaz_log_init(int level, const char *prefix, const char *fname)
229 yaz_log_init_level (level);
230 yaz_log_init_prefix (prefix);
232 yaz_log_init_file (fname);
235 void yaz_log_init_max_size(int mx)
238 l_max_size = l_def_max_size;
243 static void (*start_hook_func)(int, const char *, void *) = NULL;
244 static void *start_hook_info;
245 static void (*end_hook_func)(int, const char *, void *) = NULL;
246 static void *end_hook_info;
248 void log_event_start (void (*func)(int, const char *, void *), void *info)
250 start_hook_func = func;
251 start_hook_info = info;
254 void log_event_end (void (*func)(int, const char *, void *), void *info)
256 end_hook_func = func;
257 end_hook_info = info;
260 void yaz_log(int level, const char *fmt, ...)
263 char buf[4096], flags[1024];
267 char tbuf[TIMEFORMAT_LEN] = "";
271 if (!(level & l_level))
274 nmem_mutex_enter(log_mutex);
278 if ((l_file != stderr) && (l_max_size>0))
280 flen = ftell(l_file);
286 for (i = 0; level && mask_names[i].name; i++)
287 if ( mask_names[i].mask & level)
289 if (*mask_names[i].name && mask_names[i].mask &&
290 mask_names[i].mask != YLOG_ALL)
292 sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
293 level &= ~mask_names[i].mask;
299 _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
303 vsnprintf(buf, sizeof(buf), fmt, ap);
305 vsprintf(buf, fmt, ap);
309 if (o_level & YLOG_ERRNO)
312 yaz_strerror(buf+strlen(buf), 2048);
317 (*start_hook_func)(o_level, buf, start_hook_info);
319 tim = localtime(&ti);
320 if (l_level & YLOG_NOTIME)
323 strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tim);
324 tbuf[TIMEFORMAT_LEN-1] = '\0';
325 fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags,
327 if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
330 (*end_hook_func)(o_level, buf, end_hook_info);
331 nmem_mutex_leave(log_mutex);
334 void yaz_log_time_format(const char *fmt)
337 { /* no format, default to new */
338 l_actual_format = l_new_default_format;
341 if (0==strcmp(fmt,"old"))
342 { /* force the old format */
343 l_actual_format = l_old_default_format;
346 /* else use custom format */
347 strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
348 l_custom_format[TIMEFORMAT_LEN-1] = '\0';
349 l_actual_format = l_custom_format;
352 /** cleans a loglevel name from leading paths and suffixes */
353 static char *clean_name(const char *name, int len, char *namebuf, int buflen)
356 char *start = namebuf;
359 strncpy(namebuf, name, len);
361 while ((p = strchr(start,'/')))
363 if ((p = strrchr(start,'.')))
368 static int define_module_bit(const char *name)
372 nmem_mutex_enter(log_mutex);
373 for (i = 0; mask_names[i].name; i++)
374 if (0 == strcmp(mask_names[i].name, name))
376 nmem_mutex_leave(log_mutex);
377 return mask_names[i].mask;
379 if ( (i>=MAX_MASK_NAMES) || (next_log_bit >= 1<<31 ))
381 nmem_mutex_leave(log_mutex);
382 yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
385 mask_names[i].mask = next_log_bit;
386 next_log_bit = next_log_bit<<1;
387 mask_names[i].name = malloc (strlen(name)+1);
388 strcpy(mask_names[i].name, name);
389 mask_names[i+1].name = NULL;
390 mask_names[i+1].mask = 0;
391 nmem_mutex_leave(log_mutex);
392 return mask_names[i].mask;
395 int yaz_log_module_level(const char *name)
399 char *n = clean_name(name, strlen(name), clean, sizeof(clean));
402 nmem_mutex_enter(log_mutex);
403 for (i = 0; mask_names[i].name; i++)
404 if (0==strcmp(n, mask_names[i].name))
406 nmem_mutex_leave(log_mutex);
407 yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
408 mask_names[i].mask, n,
409 strcmp(n,name) ? name : "");
410 return mask_names[i].mask;
412 nmem_mutex_leave(log_mutex);
413 yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
414 strcmp(n, name) ? name : "" );
418 int yaz_log_mask_str (const char *str)
420 return yaz_log_mask_str_x (str, YLOG_DEFAULT_LEVEL);
423 int yaz_log_mask_str_x (const char *str, int level)
430 for (p = str; *p && *p != ','; p++)
437 if (isdigit(*(unsigned char *) str))
444 char *n = clean_name(str, p-str, clean, sizeof(clean));
445 int mask = define_module_bit(n);
447 level = 0; /* 'none' clears them all */
462 * indent-tabs-mode: nil
464 * vim: shiftwidth=4 tabstop=8 expandtab