2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: log.c,v 1.24 2005-05-18 12:30:00 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)
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 (!mutex_init_flag)
179 if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
182 yaz_log_reopen(); /* make sure we set buffering right */
185 if (l_level & YLOG_LOGLVL)
186 { /* dump the log level bits */
187 char *bittype="Static ";
189 yaz_log(YLOG_LOGLVL,"Setting log level to %d = 0x%08x",l_level,l_level);
190 for (i = 0; mask_names[i].name; i++)
191 if (mask_names[i].mask && *mask_names[i].name)
192 if (strcmp(mask_names[i].name,"all")!=0)
194 yaz_log(YLOG_LOGLVL,"%s log bit %08x '%s' is %s",
195 bittype, mask_names[i].mask, mask_names[i].name,
196 (level & mask_names[i].mask)? "ON": "off");
197 if (mask_names[i].mask>YLOG_LAST_BIT)
203 void yaz_log_init_prefix (const char *prefix)
205 if (prefix && *prefix)
206 sprintf(l_prefix, "%.511s ", prefix);
211 void yaz_log_init_prefix2 (const char *prefix)
213 if (prefix && *prefix)
214 sprintf(l_prefix2, "%.511s ", prefix);
219 void yaz_log_init(int level, const char *prefix, const char *fname)
221 if (!mutex_init_flag)
223 yaz_log_init_level (level);
224 yaz_log_init_prefix (prefix);
226 yaz_log_init_file (fname);
229 void yaz_log_init_max_size(int mx)
232 l_max_size = l_def_max_size;
237 static void (*start_hook_func)(int, const char *, void *) = NULL;
238 static void *start_hook_info;
239 static void (*end_hook_func)(int, const char *, void *) = NULL;
240 static void *end_hook_info;
242 void log_event_start (void (*func)(int, const char *, void *), void *info)
244 start_hook_func = func;
245 start_hook_info = info;
248 void log_event_end (void (*func)(int, const char *, void *), void *info)
250 end_hook_func = func;
251 end_hook_info = info;
254 void yaz_log(int level, const char *fmt, ...)
257 char buf[4096], flags[1024];
261 char tbuf[TIMEFORMAT_LEN] = "";
265 if (!(level & l_level))
267 if (!mutex_init_flag)
272 if ((l_file != stderr) && (l_max_size>0))
274 nmem_mutex_enter (log_mutex);
275 flen = ftell(l_file);
278 nmem_mutex_leave (log_mutex);
282 for (i = 0; level && mask_names[i].name; i++)
283 if ( mask_names[i].mask & level)
285 if (*mask_names[i].name && mask_names[i].mask &&
286 mask_names[i].mask != YLOG_ALL)
288 sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
289 level &= ~mask_names[i].mask;
294 _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
298 vsnprintf(buf, sizeof(buf), fmt, ap);
300 vsprintf(buf, fmt, ap);
304 if (o_level & YLOG_ERRNO)
307 yaz_strerror(buf+strlen(buf), 2048);
312 (*start_hook_func)(o_level, buf, start_hook_info);
314 tim = localtime(&ti);
315 if (l_level & YLOG_NOTIME)
318 strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tim);
319 tbuf[TIMEFORMAT_LEN-1] = '\0';
320 fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags,
322 if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
325 (*end_hook_func)(o_level, buf, end_hook_info);
328 void yaz_log_time_format(const char *fmt)
331 { /* no format, default to new */
332 l_actual_format = l_new_default_format;
335 if (0==strcmp(fmt,"old"))
336 { /* force the old format */
337 l_actual_format = l_old_default_format;
340 /* else use custom format */
341 strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
342 l_custom_format[TIMEFORMAT_LEN-1] = '\0';
343 l_actual_format = l_custom_format;
346 /** cleans a loglevel name from leading paths and suffixes */
347 static char *clean_name(const char *name, int len, char *namebuf, int buflen)
350 char *start = namebuf;
353 strncpy(namebuf, name, len);
355 while ((p = strchr(start,'/')))
357 if ((p = strrchr(start,'.')))
363 static int define_module_bit(const char *name)
366 if (!mutex_init_flag)
368 for (i = 0; mask_names[i].name; i++)
370 if ( (i>=MAX_MASK_NAMES) || (next_log_bit >= 1<<31 ))
372 yaz_log(YLOG_WARN,"No more log bits left, not logging '%s'", name);
375 mask_names[i].mask = next_log_bit;
376 next_log_bit = next_log_bit<<1;
377 mask_names[i].name = xstrdup(name);
378 mask_names[i+1].name = NULL;
379 mask_names[i+1].mask = 0;
380 return mask_names[i].mask;
383 int yaz_log_module_level(const char *name)
387 char *n = clean_name(name, strlen(name), clean, sizeof(clean));
388 if (!mutex_init_flag)
390 for (i = 0; mask_names[i].name; i++)
391 if (0==strcmp(n,mask_names[i].name))
393 yaz_log(YLOG_LOGLVL,"returning log bit 0x%x for '%s' %s",
394 mask_names[i].mask, n,
395 strcmp(n,name)?name:"" );
396 return mask_names[i].mask;
398 yaz_log(YLOG_LOGLVL,"returning NO log bit for '%s' %s", n,
399 strcmp(n,name)?name:"" );
403 int yaz_log_mask_str (const char *str)
405 return yaz_log_mask_str_x (str, YLOG_DEFAULT_LEVEL);
408 int yaz_log_mask_str_x (const char *str, int level)
412 char clean[255] = "";
419 for (p = str; *p && *p != ','; p++)
426 if (isdigit(*(unsigned char *) str))
433 n = clean_name(str, p-str, clean, sizeof(clean));
434 for (i = 0; mask_names[i].name; i++)
435 if (0==strcmp (mask_names[i].name,n))
437 if (mask_names[i].mask)
439 level &= ~mask_names[i].mask;
441 level |= mask_names[i].mask;
443 level = 0; /* 'none' clears them all */
448 level |= define_module_bit(n);