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 int yaz_log_reopen_flag = 0;
108 static YAZ_MUTEX log_mutex = 0;
110 static void yaz_log_open(void);
112 void yaz_log_lock(void)
114 yaz_mutex_enter(log_mutex);
117 void yaz_log_unlock(void)
119 yaz_mutex_leave(log_mutex);
122 void yaz_log_init_globals(void)
127 yaz_mutex_create(&log_mutex);
128 #if YAZ_POSIX_THREADS
129 pthread_atfork(yaz_log_lock, yaz_log_unlock, yaz_log_unlock);
131 env = getenv("YAZ_LOG");
133 l_level = yaz_log_mask_str_x(env, l_level);
136 FILE *yaz_log_file(void)
139 switch (yaz_log_info.type)
141 case use_stderr: f = stderr; break;
142 case use_none: f = 0; break;
143 case use_file: f = yaz_log_info.log_file; break;
148 void yaz_log_close(void)
150 if (yaz_log_info.type == use_file && yaz_log_info.log_file)
152 fclose(yaz_log_info.log_file);
153 yaz_log_info.log_file = 0;
157 void yaz_log_deinit_globals(void)
161 yaz_mutex_destroy(&log_mutex);
166 void yaz_log_init_file(const char *fname)
174 yaz_log_info.type = use_stderr; /* empty name; use stderr */
176 yaz_log_info.type = use_file;
177 strncpy(yaz_log_info.l_fname, fname, sizeof(yaz_log_info.l_fname)-1);
178 yaz_log_info.l_fname[sizeof(yaz_log_info.l_fname)-1] = '\0';
182 yaz_log_info.type = use_none; /* NULL name; use no file at all */
183 yaz_log_info.l_fname[0] = '\0';
188 static void rotate_log(const char *cur_fname)
193 /* windows can't rename a file if it is open */
196 for (i = 0; i<9; i++)
198 char fname_str[FILENAME_MAX];
199 struct stat stat_buf;
201 yaz_snprintf(fname_str, sizeof(fname_str), "%s.%d", cur_fname, i);
202 if (stat(fname_str, &stat_buf) != 0)
207 char fname_str[2][FILENAME_MAX];
210 yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
211 "%s.%d", cur_fname, i-1);
213 yaz_snprintf(fname_str[0], sizeof(fname_str[0]),
215 yaz_snprintf(fname_str[1], sizeof(fname_str[1]),
216 "%s.%d", cur_fname, i);
218 MoveFileEx(fname_str[0], fname_str[1], MOVEFILE_REPLACE_EXISTING);
220 rename(fname_str[0], fname_str[1]);
226 void yaz_log_init_level(int level)
229 if ( (l_level & YLOG_FLUSH) != (level & YLOG_FLUSH) )
232 yaz_log_open(); /* make sure we set buffering right */
237 if (l_level & YLOG_LOGLVL)
238 { /* dump the log level bits */
239 const char *bittype = "Static ";
242 yaz_log(YLOG_LOGLVL, "Setting log level to %d = 0x%08x",
244 /* determine size of mask_names (locked) */
245 for (sz = 0; mask_names[sz].name; sz++)
247 /* second pass without lock */
248 for (i = 0; i < sz; i++)
249 if (mask_names[i].mask && *mask_names[i].name)
250 if (strcmp(mask_names[i].name, "all") != 0)
252 yaz_log(YLOG_LOGLVL, "%s log bit %08x '%s' is %s",
253 bittype, mask_names[i].mask, mask_names[i].name,
254 (level & mask_names[i].mask)? "ON": "off");
255 if (mask_names[i].mask > YLOG_LAST_BIT)
261 void yaz_log_init_prefix(const char *prefix)
263 if (prefix && *prefix)
264 yaz_snprintf(yaz_log_info.l_prefix,
265 sizeof(yaz_log_info.l_prefix), "%s ", prefix);
267 *yaz_log_info.l_prefix = 0;
270 void yaz_log_init_prefix2(const char *prefix)
272 if (prefix && *prefix)
273 yaz_snprintf(yaz_log_info.l_prefix2,
274 sizeof(yaz_log_info.l_prefix2), "%s ", prefix);
276 *yaz_log_info.l_prefix2 = 0;
279 void yaz_log_init(int level, const char *prefix, const char *fname)
282 yaz_log_init_level(level);
283 yaz_log_init_prefix(prefix);
285 yaz_log_init_file(fname);
288 void yaz_log_init_max_size(int mx)
296 void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info)
302 void log_event_start(void (*func)(int, const char *, void *), void *info)
304 start_hook_func = func;
305 start_hook_info = info;
308 void log_event_end(void (*func)(int, const char *, void *), void *info)
310 end_hook_func = func;
311 end_hook_info = info;
314 static void yaz_log_open_check(struct tm *tm, int force, const char *filemode)
316 char new_filename[512];
317 static char cur_filename[512] = "";
319 if (yaz_log_info.type != use_file)
322 if (yaz_log_reopen_flag)
325 yaz_log_reopen_flag = 0;
327 if (*yaz_log_info.l_fname)
329 strftime(new_filename, sizeof(new_filename)-1, yaz_log_info.l_fname,
331 if (strcmp(new_filename, cur_filename))
333 strcpy(cur_filename, new_filename);
338 if (l_max_size > 0 && yaz_log_info.log_file)
340 long flen = ftell(yaz_log_info.log_file);
341 if (flen > l_max_size)
343 rotate_log(cur_filename);
347 if (force && *cur_filename)
353 if (!strncmp(cur_filename, "fd=", 3))
354 new_file = fdopen(atoi(cur_filename + 3), filemode);
356 new_file = fopen(cur_filename, filemode);
360 yaz_log_info.log_file = new_file;
364 /* disable log rotate */
370 static void yaz_log_do_reopen(const char *filemode)
372 time_t cur_time = time(0);
374 struct tm tm0, *tm = &tm0;
381 localtime_r(&cur_time, tm);
383 tm = localtime(&cur_time);
385 yaz_log_open_check(tm, 1, filemode);
389 void yaz_log_reopen()
391 yaz_log_reopen_flag = 1;
394 static void yaz_log_open()
396 yaz_log_do_reopen("a");
401 yaz_log_do_reopen("w");
404 static void yaz_strftime(char *dst, size_t sz,
405 const char *fmt, const struct tm *tm)
407 strftime(dst, sz, fmt, tm);
410 static void yaz_log_to_file(int level, const char *fmt, va_list ap,
411 const char *error_cp)
416 struct tm tm0, *tm = &tm0;
423 localtime_r(&ti, tm);
428 yaz_log_open_check(tm, 0, "a");
429 file = yaz_log_file(); /* file may change in yaz_log_open_check */
433 char tbuf[TIMEFORMAT_LEN];
439 for (i = 0; level && mask_names[i].name; i++)
440 if ( mask_names[i].mask & level)
442 if (*mask_names[i].name && mask_names[i].mask &&
443 mask_names[i].mask != YLOG_ALL)
445 if (strlen(flags) + strlen(mask_names[i].name)
449 strcat(flags, mask_names[i].name);
452 level &= ~mask_names[i].mask;
457 if (!(l_level & YLOG_NOTIME))
459 yaz_strftime(tbuf, TIMEFORMAT_LEN-2, l_actual_format, tm);
460 tbuf[TIMEFORMAT_LEN-2] = '\0';
466 if (l_level & YLOG_TID)
468 yaz_thread_id_cstr(tid, sizeof(tid)-1);
473 fprintf(file, "%s%s%s%s %s", tbuf, yaz_log_info.l_prefix,
474 tid, flags, yaz_log_info.l_prefix2);
475 vfprintf(file, fmt, ap);
477 fprintf(file, " [%s]", error_cp);
479 if (l_level & YLOG_FLUSH)
485 void yaz_log(int level, const char *fmt, ...)
490 char *error_cp = 0, error_buf[128];
492 if (o_level & YLOG_ERRNO)
494 yaz_strerror(error_buf, sizeof(error_buf));
495 error_cp = error_buf;
498 if (!(level & l_level))
502 file = yaz_log_file();
503 if (start_hook_func || hook_func || end_hook_func)
506 /* 30 is enough for our 'rest of output' message */
507 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
508 if (strlen(buf) >= sizeof(buf)-31)
509 strcat(buf, " [rest of output omitted]");
511 (*start_hook_func)(o_level, buf, start_hook_info);
513 (*hook_func)(o_level, buf, hook_info);
515 yaz_log_to_file(level, fmt, ap, error_cp);
517 (*end_hook_func)(o_level, buf, end_hook_info);
522 yaz_log_to_file(level, fmt, ap, error_cp);
527 void yaz_log_time_format(const char *fmt)
530 { /* no format, default to new */
531 l_actual_format = l_new_default_format;
534 if (0==strcmp(fmt, "old"))
535 { /* force the old format */
536 l_actual_format = l_old_default_format;
539 /* else use custom format */
540 strncpy(l_custom_format, fmt, TIMEFORMAT_LEN-1);
541 l_custom_format[TIMEFORMAT_LEN-1] = '\0';
542 l_actual_format = l_custom_format;
545 /** cleans a loglevel name from leading paths and suffixes */
546 static char *clean_name(const char *name, size_t len, char *namebuf, size_t buflen)
549 char *start = namebuf;
552 strncpy(namebuf, name, len);
554 while ((p = strchr(start, '/')))
556 if ((p = strrchr(start, '.')))
561 static int define_module_bit(const char *name)
565 for (i = 0; mask_names[i].name; i++)
566 if (0 == strcmp(mask_names[i].name, name))
568 return mask_names[i].mask;
570 if ( (i>=MAX_MASK_NAMES) || (next_log_bit & (1U<<31) ))
572 yaz_log(YLOG_WARN, "No more log bits left, not logging '%s'", name);
575 mask_names[i].mask = (int) next_log_bit; /* next_log_bit can hold int */
576 next_log_bit = next_log_bit<<1;
577 mask_names[i].name = (char *) malloc(strlen(name)+1);
578 strcpy(mask_names[i].name, name);
579 mask_names[i+1].name = NULL;
580 mask_names[i+1].mask = 0;
581 return mask_names[i].mask;
584 int yaz_log_module_level(const char *name)
588 char *n = clean_name(name, strlen(name), clean, sizeof(clean));
591 for (i = 0; mask_names[i].name; i++)
592 if (0==strcmp(n, mask_names[i].name))
594 yaz_log(YLOG_LOGLVL, "returning log bit 0x%x for '%s' %s",
595 mask_names[i].mask, n,
596 strcmp(n,name) ? name : "");
597 return mask_names[i].mask;
599 yaz_log(YLOG_LOGLVL, "returning NO log bit for '%s' %s", n,
600 strcmp(n, name) ? name : "" );
604 int yaz_log_mask_str(const char *str)
606 yaz_init_globals(); /* since l_level may be affected */
607 return yaz_log_mask_str_x(str, l_level);
610 /* this function is called by yaz_log_init_globals & yaz_init_globals
611 and, thus, may not call any of them indirectly */
612 int yaz_log_mask_str_x(const char *str, int level)
619 for (p = str; *p && *p != ','; p++)
626 if (yaz_isdigit(*str))
633 char *n = clean_name(str, (size_t) (p - str), clean, sizeof(clean));
634 int mask = define_module_bit(n);
636 level = 0; /* 'none' clears them all */
651 * c-file-style: "Stroustrup"
652 * indent-tabs-mode: nil
654 * vim: shiftwidth=4 tabstop=8 expandtab