2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: log.c,v 1.26 2005-09-09 10:33:45 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 */
168 rename(l_fname, newname);
173 void yaz_log_init_level (int level)
176 if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
179 yaz_log_reopen(); /* make sure we set buffering right */
182 if (l_level & YLOG_LOGLVL)
183 { /* dump the log level bits */
184 const char *bittype = "Static ";
187 yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
189 /* determine size of mask_names (locked) */
190 nmem_mutex_enter(log_mutex);
191 for (sz = 0; mask_names[sz].name; sz++)
193 nmem_mutex_leave(log_mutex);
194 /* second pass without lock */
195 for (i = 0; i < sz; i++)
196 if (mask_names[i].mask && *mask_names[i].name)
197 if (strcmp(mask_names[i].name, "all") != 0)
199 yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s",
200 bittype, mask_names[i].mask, mask_names[i].name,
201 (level & mask_names[i].mask)? "ON": "off");
202 if (mask_names[i].mask > YLOG_LAST_BIT)
208 void yaz_log_init_prefix (const char *prefix)
210 if (prefix && *prefix)
211 sprintf(l_prefix, "%.511s ", prefix);
216 void yaz_log_init_prefix2 (const char *prefix)
218 if (prefix && *prefix)
219 sprintf(l_prefix2, "%.511s ", prefix);
224 void yaz_log_init(int level, const char *prefix, const char *fname)
227 yaz_log_init_level (level);
228 yaz_log_init_prefix (prefix);
230 yaz_log_init_file (fname);
233 void yaz_log_init_max_size(int mx)
236 l_max_size = l_def_max_size;
241 static void (*start_hook_func)(int, const char *, void *) = NULL;
242 static void *start_hook_info;
243 static void (*end_hook_func)(int, const char *, void *) = NULL;
244 static void *end_hook_info;
246 void log_event_start (void (*func)(int, const char *, void *), void *info)
248 start_hook_func = func;
249 start_hook_info = info;
252 void log_event_end (void (*func)(int, const char *, void *), void *info)
254 end_hook_func = func;
255 end_hook_info = info;
258 void yaz_log(int level, const char *fmt, ...)
261 char buf[4096], flags[1024];
265 char tbuf[TIMEFORMAT_LEN] = "";
269 if (!(level & l_level))
272 nmem_mutex_enter(log_mutex);
276 if ((l_file != stderr) && (l_max_size>0))
278 flen = ftell(l_file);
284 for (i = 0; level && mask_names[i].name; i++)
285 if ( mask_names[i].mask & level)
287 if (*mask_names[i].name && mask_names[i].mask &&
288 mask_names[i].mask != YLOG_ALL)
290 sprintf(flags + strlen(flags), "[%s]", mask_names[i].name);
291 level &= ~mask_names[i].mask;
297 _vsnprintf(buf, sizeof(buf)-1, fmt, ap);
301 vsnprintf(buf, sizeof(buf), fmt, ap);
303 vsprintf(buf, fmt, ap);
307 if (o_level & YLOG_ERRNO)
310 yaz_strerror(buf+strlen(buf), 2048);
315 (*start_hook_func)(o_level, buf, start_hook_info);
317 tim = localtime(&ti);
318 if (l_level & YLOG_NOTIME)
321 strftime(tbuf, TIMEFORMAT_LEN-1, l_actual_format, tim);
322 tbuf[TIMEFORMAT_LEN-1] = '\0';
323 fprintf(l_file, "%s %s%s %s%s\n", tbuf, l_prefix, flags,
325 if (l_level & (YLOG_FLUSH|YLOG_DEBUG) )
328 (*end_hook_func)(o_level, buf, end_hook_info);
329 nmem_mutex_leave(log_mutex);
332 void yaz_log_time_format(const char *fmt)
335 { /* no format, default to new */
336 l_actual_format = l_new_default_format;
339 if (0==strcmp(fmt,"old"))
340 { /* force the old format */
341 l_actual_format = l_old_default_format;
344 /* else use custom format */
345 strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
346 l_custom_format[TIMEFORMAT_LEN-1] = '\0';
347 l_actual_format = l_custom_format;
350 /** cleans a loglevel name from leading paths and suffixes */
351 static char *clean_name(const char *name, int len, char *namebuf, int buflen)
354 char *start = namebuf;
357 strncpy(namebuf, name, len);
359 while ((p = strchr(start,'/')))
361 if ((p = strrchr(start,'.')))
366 static int define_module_bit(const char *name)
370 nmem_mutex_enter(log_mutex);
371 for (i = 0; mask_names[i].name; i++)
372 if (0 == strcmp(mask_names[i].name, name))
374 nmem_mutex_leave(log_mutex);
375 return mask_names[i].mask;
377 if ( (i>=MAX_MASK_NAMES) || (next_log_bit >= 1<<31 ))
379 nmem_mutex_leave(log_mutex);
380 yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
383 mask_names[i].mask = next_log_bit;
384 next_log_bit = next_log_bit<<1;
385 mask_names[i].name = malloc (strlen(name)+1);
386 strcpy(mask_names[i].name, name);
387 mask_names[i+1].name = NULL;
388 mask_names[i+1].mask = 0;
389 nmem_mutex_leave(log_mutex);
390 return mask_names[i].mask;
393 int yaz_log_module_level(const char *name)
397 char *n = clean_name(name, strlen(name), clean, sizeof(clean));
400 nmem_mutex_enter(log_mutex);
401 for (i = 0; mask_names[i].name; i++)
402 if (0==strcmp(n, mask_names[i].name))
404 nmem_mutex_leave(log_mutex);
405 yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
406 mask_names[i].mask, n,
407 strcmp(n,name) ? name : "");
408 return mask_names[i].mask;
410 nmem_mutex_leave(log_mutex);
411 yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
412 strcmp(n, name) ? name : "" );
416 int yaz_log_mask_str (const char *str)
418 return yaz_log_mask_str_x (str, YLOG_DEFAULT_LEVEL);
421 int yaz_log_mask_str_x (const char *str, int level)
428 for (p = str; *p && *p != ','; p++)
435 if (isdigit(*(unsigned char *) str))
442 char *n = clean_name(str, p-str, clean, sizeof(clean));
443 int mask = define_module_bit(n);
445 level = 0; /* 'none' clears them all */
460 * indent-tabs-mode: nil
462 * vim: shiftwidth=4 tabstop=8 expandtab