2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: log.c,v 1.21 2005-01-15 19:47:13 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"},
86 /* { YLOG_APP, "app" }, */
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)
117 if (!mutex_init_flag)
121 strncpy(l_fname, fname, sizeof(l_fname)-1);
122 l_fname[sizeof(l_fname)-1] = '\0';
129 void yaz_log_reopen(void)
132 if (!mutex_init_flag)
138 else if (!(new_file = fopen(l_fname, "a")))
141 l_file=stderr; /* just to be sure we don't rotate logs and recurse */
142 yaz_log(YLOG_WARN|YLOG_ERRNO,"Could not open log file '%s'",l_fname);
143 l_file=new_file; /* restore to old value, probably stderr as well */
146 if (l_file != stderr)
150 if (l_level & YLOG_FLUSH)
151 setvbuf(new_file, 0, _IONBF, 0);
155 static void rotate_log()
159 return; /* can't rotate that */
161 return; /* hmm, no name, can't rotate */
162 strncpy(newname, l_fname, 509);
163 newname[509] = '\0'; /* make sure it is terminated */
164 strcat(newname,".1");
166 /* windows can't rename a file if it is open */
170 rename(l_fname, newname);
175 void yaz_log_init_level (int level)
177 if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
180 yaz_log_reopen(); /* make sure we set buffering right */
183 if (l_level & YLOG_LOGLVL)
184 { /* dump the log level bits */
185 char *bittype="Static ";
187 yaz_log(YLOG_LOGLVL,"Setting log level to %d = 0x%08x",l_level,l_level);
188 for (i = 0; mask_names[i].name; i++)
189 if (mask_names[i].mask && *mask_names[i].name)
190 if (strcmp(mask_names[i].name,"all")!=0)
192 yaz_log(YLOG_LOGLVL,"%s log bit %08x '%s' is %s",
193 bittype, mask_names[i].mask, mask_names[i].name,
194 (level & mask_names[i].mask)? "ON": "off");
195 if (mask_names[i].mask>YLOG_LAST_BIT)
201 void yaz_log_init_prefix (const char *prefix)
203 if (prefix && *prefix)
204 sprintf(l_prefix, "%.511s ", prefix);
209 void yaz_log_init_prefix2 (const char *prefix)
211 if (prefix && *prefix)
212 sprintf(l_prefix2, "%.511s ", prefix);
217 void yaz_log_init(int level, const char *prefix, const char *fname)
219 if (!mutex_init_flag)
221 yaz_log_init_level (level);
222 yaz_log_init_prefix (prefix);
224 yaz_log_init_file (fname);
227 void yaz_log_init_max_size(int mx)
230 l_max_size = l_def_max_size;
235 static void (*start_hook_func)(int, const char *, void *) = NULL;
236 static void *start_hook_info;
237 static void (*end_hook_func)(int, const char *, void *) = NULL;
238 static void *end_hook_info;
240 void log_event_start (void (*func)(int, const char *, void *), void *info)
242 start_hook_func = func;
243 start_hook_info = info;
246 void log_event_end (void (*func)(int, const char *, void *), void *info)
248 end_hook_func = func;
249 end_hook_info = info;
252 void yaz_log(int level, const char *fmt, ...)
255 char buf[4096], flags[1024];
259 char tbuf[TIMEFORMAT_LEN] = "";
263 if (!(level & l_level))
265 if (!mutex_init_flag)
270 if ((l_file != stderr) && (l_max_size>0))
272 nmem_mutex_enter (log_mutex);
273 flen = ftell(l_file);
276 nmem_mutex_leave (log_mutex);
280 for (i = 0; level && mask_names[i].name; i++)
281 if ( mask_names[i].mask & level)
283 if (*mask_names[i].name && mask_names[i].mask &&
284 mask_names[i].mask != YLOG_ALL)
286 sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
287 level &= ~mask_names[i].mask;
292 _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
296 vsnprintf(buf, sizeof(buf), fmt, ap);
298 vsprintf(buf, fmt, ap);
302 if (o_level & YLOG_ERRNO)
305 yaz_strerror(buf+strlen(buf), 2048);
310 (*start_hook_func)(o_level, buf, start_hook_info);
312 tim = localtime(&ti);
313 if (l_level & YLOG_NOTIME)
316 strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tim);
317 tbuf[TIMEFORMAT_LEN-1] = '\0';
318 fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags,
320 if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
323 (*end_hook_func)(o_level, buf, end_hook_info);
326 void yaz_log_time_format(const char *fmt)
329 { /* no format, default to new */
330 l_actual_format = l_new_default_format;
333 if (0==strcmp(fmt,"old"))
334 { /* force the old format */
335 l_actual_format = l_old_default_format;
338 /* else use custom format */
339 strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
340 l_custom_format[TIMEFORMAT_LEN-1] = '\0';
341 l_actual_format = l_custom_format;
344 /** cleans a loglevel name from leading paths and suffixes */
345 static char *clean_name(const char *name, int len, char *namebuf, int buflen)
348 char *start = namebuf;
351 strncpy(namebuf, name, len);
353 while ((p = strchr(start,'/')))
355 if ((p = strrchr(start,'.')))
361 static int define_module_bit(const char *name)
364 for (i = 0; mask_names[i].name; i++)
366 if ( (i>=MAX_MASK_NAMES) || (next_log_bit >= 1<<31 ))
368 yaz_log(YLOG_WARN,"No more log bits left, not logging '%s'", name);
371 mask_names[i].mask = next_log_bit;
372 next_log_bit = next_log_bit<<1;
373 mask_names[i].name = xstrdup(name);
374 mask_names[i+1].name = NULL;
375 mask_names[i+1].mask = 0;
376 return mask_names[i].mask;
379 int yaz_log_module_level(const char *name)
383 char *n = clean_name(name, strlen(name), clean, sizeof(clean));
384 for (i = 0; mask_names[i].name; i++)
385 if (0==strcmp(n,mask_names[i].name))
387 yaz_log(YLOG_LOGLVL,"returning log bit 0x%x for '%s' %s",
388 mask_names[i].mask, n,
389 strcmp(n,name)?name:"" );
390 return mask_names[i].mask;
392 yaz_log(YLOG_LOGLVL,"returning NO log bit for '%s' %s", n,
393 strcmp(n,name)?name:"" );
397 int yaz_log_mask_str (const char *str)
399 return yaz_log_mask_str_x (str, YLOG_DEFAULT_LEVEL);
402 int yaz_log_mask_str_x (const char *str, int level)
406 char clean[255] = "";
413 for (p = str; *p && *p != ','; p++)
420 if (isdigit(*(unsigned char *) str))
427 n = clean_name(str, p-str, clean, sizeof(clean));
428 for (i = 0; mask_names[i].name; i++)
429 if (0==strcmp (mask_names[i].name,n))
431 if (mask_names[i].mask)
433 level &= ~mask_names[i].mask;
435 level |= mask_names[i].mask;
437 level = 0; /* 'none' clears them all */
442 level |= define_module_bit(n);