1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) Index Data
3 * See the file LICENSE for details.
8 * \brief Logging utility
29 #include <yaz/yaz-iconv.h>
30 #include <yaz/errno.h>
31 #include <yaz/thread_id.h>
33 #include <yaz/mutex.h>
34 #include <yaz/snprintf.h>
35 #include <yaz/xmalloc.h>
40 static int l_level = YLOG_DEFAULT_LEVEL;
42 enum l_file_type { use_stderr, use_none, use_file };
45 enum l_file_type type;
51 use_stderr, 0, "", "", ""
54 static void (*start_hook_func)(int, const char *, void *) = NULL;
55 static void *start_hook_info;
57 static void (*end_hook_func)(int, const char *, void *) = NULL;
58 static void *end_hook_info;
60 static void (*hook_func)(int, const char *, void *) = NULL;
61 static void *hook_info;
63 static char l_old_default_format[] = "%H:%M:%S-%d/%m";
64 static char l_new_default_format[] = "%Y%m%d-%H%M%S";
65 #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. The default value is
71 0 which means DISABLED. This is to be preffered if YAZ runs
72 as a server using logrotate etc.
73 A positive size specifies the file size in bytes when a log rotate
74 will occur. Note that in order for this to work YAZ must have
77 static int l_max_size = 0;
79 #define MAX_MASK_NAMES 35 /* 32 bits plus a few combo names */
83 } mask_names[MAX_MASK_NAMES] =
85 { YLOG_FATAL, "fatal"},
86 { YLOG_DEBUG, "debug"},
87 { YLOG_WARN, "warn" },
90 { YLOG_MALLOC, "malloc"},
93 { YLOG_NOTIME, "notime" },
94 { YLOG_APP2, "app2" },
95 { YLOG_APP3, "app3" },
97 { YLOG_FLUSH, "flush" },
98 { YLOG_LOGLVL, "loglevel" },
101 /* the rest will be filled in if the user defines dynamic modules*/
104 static unsigned int next_log_bit = YLOG_LAST_BIT<<1; /* first dynamic bit */
106 static YAZ_MUTEX log_mutex = 0;
108 static void yaz_log_lock(void)
110 yaz_mutex_enter(log_mutex);
113 static void yaz_log_unlock(void)
115 yaz_mutex_leave(log_mutex);
118 void yaz_log_init_globals(void)
123 yaz_mutex_create(&log_mutex);
124 #if YAZ_POSIX_THREADS
125 pthread_atfork(yaz_log_lock, yaz_log_unlock, yaz_log_unlock);
127 env = getenv("YAZ_LOG");
129 l_level = yaz_log_mask_str_x(env, l_level);
132 FILE *yaz_log_file(void)
135 switch (yaz_log_info.type)
137 case use_stderr: f = stderr; break;
138 case use_none: f = 0; break;
139 case use_file: f = yaz_log_info.log_file; break;
144 void yaz_log_close(void)
146 if (yaz_log_info.type == use_file && yaz_log_info.log_file)
148 fclose(yaz_log_info.log_file);
149 yaz_log_info.log_file = 0;
153 void yaz_log_init_file(const char *fname)
161 yaz_log_info.type = use_stderr; /* empty name; use stderr */
163 yaz_log_info.type = use_file;
164 strncpy(yaz_log_info.l_fname, fname, sizeof(yaz_log_info.l_fname)-1);
165 yaz_log_info.l_fname[sizeof(yaz_log_info.l_fname)-1] = '\0';
169 yaz_log_info.type = use_none; /* NULL name; use no file at all */
170 yaz_log_info.l_fname[0] = '\0';
175 static void rotate_log(const char *cur_fname)
180 /* windows can't rename a file if it is open */
183 for (i = 0; i<9; i++)
185 char fname_str[FILENAME_MAX];
186 struct stat stat_buf;
188 yaz_snprintf(fname_str, sizeof(fname_str), "%s.%d", cur_fname, i);
189 if (stat(fname_str, &stat_buf) != 0)
194 char fname_str[2][FILENAME_MAX];
197 yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
198 "%s.%d", cur_fname, i-1);
200 yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
202 yaz_snprintf(fname_str[1], sizeof(fname_str[1]),
203 "%s.%d", cur_fname, i);
205 MoveFileEx(fname_str[0], fname_str[1], MOVEFILE_REPLACE_EXISTING);
207 rename(fname_str[0], fname_str[1]);
213 void yaz_log_init_level(int level)
216 if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
219 yaz_log_reopen(); /* make sure we set buffering right */
224 if (l_level & YLOG_LOGLVL)
225 { /* dump the log level bits */
226 const char *bittype = "Static ";
229 yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
231 /* determine size of mask_names (locked) */
232 for (sz = 0; mask_names[sz].name; sz++)
234 /* second pass without lock */
235 for (i = 0; i < sz; i++)
236 if (mask_names[i].mask && *mask_names[i].name)
237 if (strcmp(mask_names[i].name, "all") != 0)
239 yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s",
240 bittype, mask_names[i].mask, mask_names[i].name,
241 (level & mask_names[i].mask)? "ON": "off");
242 if (mask_names[i].mask > YLOG_LAST_BIT)
248 void yaz_log_init_prefix(const char *prefix)
250 if (prefix && *prefix)
251 yaz_snprintf(yaz_log_info.l_prefix,
252 sizeof(yaz_log_info.l_prefix), "%s ", prefix);
254 *yaz_log_info.l_prefix = 0;
257 void yaz_log_init_prefix2(const char *prefix)
259 if (prefix && *prefix)
260 yaz_snprintf(yaz_log_info.l_prefix2,
261 sizeof(yaz_log_info.l_prefix2), "%s ", prefix);
263 *yaz_log_info.l_prefix2 = 0;
266 void yaz_log_init(int level, const char *prefix, const char *fname)
269 yaz_log_init_level(level);
270 yaz_log_init_prefix(prefix);
272 yaz_log_init_file(fname);
275 void yaz_log_init_max_size(int mx)
283 void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info)
289 void log_event_start(void (*func)(int, const char *, void *), void *info)
291 start_hook_func = func;
292 start_hook_info = info;
295 void log_event_end(void (*func)(int, const char *, void *), void *info)
297 end_hook_func = func;
298 end_hook_info = info;
301 static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
303 char new_filename[512];
304 static char cur_filename[512] = "";
306 if (yaz_log_info.type != use_file)
309 if (*yaz_log_info.l_fname)
311 strftime(new_filename, sizeof(new_filename)-1, yaz_log_info.l_fname,
313 if (strcmp(new_filename, cur_filename))
315 strcpy(cur_filename, new_filename);
320 if (l_max_size > 0 && yaz_log_info.log_file)
322 long flen = ftell(yaz_log_info.log_file);
323 if (flen > l_max_size)
325 rotate_log(cur_filename);
329 if (force && *cur_filename)
335 new_file = fopen(cur_filename, filemode);
339 yaz_log_info.log_file = new_file;
340 if (l_level & YLOG_FLUSH)
341 setvbuf(yaz_log_info.log_file, 0, _IONBF, 0);
345 /* disable log rotate */
351 static void yaz_log_do_reopen(const char *filemode)
353 time_t cur_time = time(0);
355 struct tm tm0, *tm = &tm0;
362 localtime_r(&cur_time, tm);
364 tm = localtime(&cur_time);
366 yaz_log_open_check(tm, 1, filemode);
371 void yaz_log_reopen()
373 yaz_log_do_reopen("a");
378 yaz_log_do_reopen("w");
381 static void yaz_strftime(char *dst, size_t sz,
382 const char *fmt, const struct tm *tm)
384 strftime(dst, sz, fmt, tm);
387 static void yaz_log_to_file(int level, const char *log_message)
392 struct tm tm0, *tm = &tm0;
399 localtime_r(&ti, tm);
404 yaz_log_open_check(tm, 0, "a");
405 file = yaz_log_file(); /* file may change in yaz_log_open_check */
409 char tbuf[TIMEFORMAT_LEN];
415 for (i = 0; level && mask_names[i].name; i++)
416 if ( mask_names[i].mask & level)
418 if (*mask_names[i].name && mask_names[i].mask &&
419 mask_names[i].mask != YLOG_ALL)
421 if (strlen(flags) + strlen(mask_names[i].name)
425 strcat(flags, mask_names[i].name);
428 level &= ~mask_names[i].mask;
433 if (!(l_level & YLOG_NOTIME))
435 yaz_strftime(tbuf, TIMEFORMAT_LEN-2, l_actual_format, tm);
436 tbuf[TIMEFORMAT_LEN-2] = '\0';
442 if (l_level & YLOG_TID)
444 yaz_thread_id_cstr(tid, sizeof(tid)-1);
449 fprintf(file, "%s%s%s%s %s%s\n", tbuf, yaz_log_info.l_prefix,
450 tid, flags, yaz_log_info.l_prefix2,
452 if (l_level & YLOG_FLUSH)
458 void yaz_log(int level, const char *fmt, ...)
466 if (!(level & l_level))
470 /* 30 is enough for our 'rest of output' message */
471 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
472 if (strlen(buf) >= sizeof(buf)-31)
473 strcat(buf, " [rest of output omitted]");
475 if (o_level & YLOG_ERRNO)
477 size_t remain = sizeof(buf) - strlen(buf);
478 if (remain > 100) /* reasonable minimum space for error */
481 yaz_strerror(buf+strlen(buf), remain-5); /* 5 due to extra [] */
487 (*start_hook_func)(o_level, buf, start_hook_info);
489 (*hook_func)(o_level, buf, hook_info);
490 file = yaz_log_file();
492 yaz_log_to_file(level, buf);
494 (*end_hook_func)(o_level, buf, end_hook_info);
497 void yaz_log_time_format(const char *fmt)
500 { /* no format, default to new */
501 l_actual_format = l_new_default_format;
504 if (0==strcmp(fmt, "old"))
505 { /* force the old format */
506 l_actual_format = l_old_default_format;
509 /* else use custom format */
510 strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
511 l_custom_format[TIMEFORMAT_LEN-1] = '\0';
512 l_actual_format = l_custom_format;
515 /** cleans a loglevel name from leading paths and suffixes */
516 static char *clean_name(const char *name, size_t len, char *namebuf, size_t buflen)
519 char *start = namebuf;
522 strncpy(namebuf, name, len);
524 while ((p = strchr(start, '/')))
526 if ((p = strrchr(start, '.')))
531 static int define_module_bit(const char *name)
535 for (i = 0; mask_names[i].name; i++)
536 if (0 == strcmp(mask_names[i].name, name))
538 return mask_names[i].mask;
540 if ( (i>=MAX_MASK_NAMES) || (next_log_bit & (1U<<31) ))
542 yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
545 mask_names[i].mask = (int) next_log_bit; /* next_log_bit can hold int */
546 next_log_bit = next_log_bit<<1;
547 mask_names[i].name = (char *) malloc(strlen(name)+1);
548 strcpy(mask_names[i].name, name);
549 mask_names[i+1].name = NULL;
550 mask_names[i+1].mask = 0;
551 return mask_names[i].mask;
554 int yaz_log_module_level(const char *name)
558 char *n = clean_name(name, strlen(name), clean, sizeof(clean));
561 for (i = 0; mask_names[i].name; i++)
562 if (0==strcmp(n, mask_names[i].name))
564 yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
565 mask_names[i].mask, n,
566 strcmp(n,name) ? name : "");
567 return mask_names[i].mask;
569 yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
570 strcmp(n, name) ? name : "" );
574 int yaz_log_mask_str(const char *str)
576 yaz_init_globals(); /* since l_level may be affected */
577 return yaz_log_mask_str_x(str, l_level);
580 /* this function is called by yaz_log_init_globals & yaz_init_globals
581 and, thus, may not call any of them indirectly */
582 int yaz_log_mask_str_x(const char *str, int level)
589 for (p = str; *p && *p != ','; p++)
596 if (yaz_isdigit(*str))
603 char *n = clean_name(str, (size_t) (p - str), clean, sizeof(clean));
604 int mask = define_module_bit(n);
606 level = 0; /* 'none' clears them all */
621 * c-file-style: "Stroustrup"
622 * indent-tabs-mode: nil
624 * vim: shiftwidth=4 tabstop=8 expandtab