5 Author: Johnny Mnemonic <johnny@themnemonic.org>
7 Copyright (C) 1997 - 2002 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
22 #include "silcincludes.h"
24 /* Minimum time delay for log flushing calls (in seconds) */
25 #define SILC_LOG_FLUSH_MIN_DELAY 2
27 /* nice macro for looping through all logs -- makes the code more readable */
28 #define SILC_FOREACH_LOG(__x__) for (__x__ = 0; __x__ < SILC_LOG_MAX; __x__++)
30 /* Our working struct -- at the moment we keep it private, but this could
31 * change in the future */
32 struct SilcLogStruct {
41 typedef struct SilcLogStruct *SilcLog;
43 /* These are the known logging channels. We initialize this struct with most
44 * of the fields set to NULL, because we'll fill in those values at runtime. */
45 static struct SilcLogStruct silclogs[SILC_LOG_MAX] = {
46 {"", NULL, 0, "Info", SILC_LOG_INFO, NULL, NULL},
47 {"", NULL, 0, "Warning", SILC_LOG_WARNING, NULL, NULL},
48 {"", NULL, 0, "Error", SILC_LOG_ERROR, NULL, NULL},
49 {"", NULL, 0, "Fatal", SILC_LOG_FATAL, NULL, NULL},
52 /* Causes logging output to contain timestamps */
53 bool silc_log_timestamp = TRUE;
55 /* If TRUE, log files will be flushed for each log input */
56 bool silc_log_quick = FALSE;
58 /* Set TRUE/FALSE to enable/disable debugging */
59 bool silc_debug = FALSE;
60 bool silc_debug_hexdump = FALSE;
62 /* Flush delay (in seconds) */
63 long silc_log_flushdelay = 300;
65 /* Regular pattern matching expression for the debug output */
66 char silc_log_debug_string[128];
68 /* Debug callbacks. If set, these are triggered for each specific output. */
69 static SilcLogDebugCb silc_log_debug_cb = NULL;
70 static void *silc_log_debug_context = NULL;
71 static SilcLogHexdumpCb silc_log_hexdump_cb = NULL;
72 static void *silc_log_hexdump_context = NULL;
74 /* Did we register already our functions to the scheduler? */
75 static bool silc_log_scheduled = FALSE;
76 static bool silc_log_no_init = FALSE;
78 /* This is only needed during starting up -- don't lose any logging message */
79 static bool silc_log_starting = TRUE;
81 /* The type wrapper utility. Translates a SilcLogType id to the corresponding
82 * logfile, or NULL if not found. */
83 static SilcLog silc_log_find_by_type(SilcLogType type)
85 /* this is not really needed, but i think it's more secure */
88 return &silclogs[SILC_LOG_INFO];
89 case SILC_LOG_WARNING:
90 return &silclogs[SILC_LOG_WARNING];
92 return &silclogs[SILC_LOG_ERROR];
94 return &silclogs[SILC_LOG_FATAL];
101 /* Given an open log file, checks the size and rotates it if there is a
102 * max size set lower then the current size */
103 static void silc_log_checksize(SilcLog log)
108 if (!log || !log->fp || !log->maxsize)
109 return; /* we are not interested */
111 if ((size = ftell(log->fp)) < 0) {
112 /* OMG, EBADF is here.. we'll try our best.. */
113 FILE *oldfp = log->fp;
114 fclose(oldfp); /* we can discard the error */
115 log->fp = NULL; /* make sure we don't get here recursively */
116 SILC_LOG_ERROR(("Error while checking size of the log file %s, fp=%p",
117 log->filename, oldfp));
120 if (size < log->maxsize) return;
123 fprintf(log->fp, "[%s] [%s] Cycling log file, over max "
124 "logsize (%lu kilobytes)\n",
125 silc_get_time(0), log->typename, log->maxsize / 1024);
128 snprintf(newname, sizeof(newname), "%s.old", log->filename);
131 /* I heard the following syscall may cause portability issues, but I don't
132 * have any other solution since SILC library doesn't provide any other
133 * function like this. -Johnny */
134 rename(log->filename, newname);
135 if (!(log->fp = fopen(log->filename, "w")))
136 SILC_LOG_WARNING(("Couldn't reopen logfile %s for type \"%s\": %s",
137 log->filename, log->typename, strerror(errno)));
140 /* Reset a logging channel (close and reopen) */
142 static bool silc_log_reset(SilcLog log)
144 if (!log) return FALSE;
149 if (!log->filename[0]) return FALSE;
150 if (!(log->fp = fopen(log->filename, "a+"))) {
151 SILC_LOG_WARNING(("Couldn't reset logfile %s for type \"%s\": %s",
152 log->filename, log->typename, strerror(errno)));
159 /* Internal timeout callback to flush log channels and check file sizes */
161 SILC_TASK_CALLBACK(silc_log_fflush_callback)
164 if (!silc_log_quick) {
165 silc_log_flush_all();
167 silc_log_checksize(&silclogs[u]);
169 silc_log_starting = FALSE;
170 if (silc_log_flushdelay < SILC_LOG_FLUSH_MIN_DELAY)
171 silc_log_flushdelay = SILC_LOG_FLUSH_MIN_DELAY;
172 silc_schedule_task_add((SilcSchedule) context, 0, silc_log_fflush_callback,
173 context, silc_log_flushdelay, 0, SILC_TASK_TIMEOUT,
174 SILC_TASK_PRI_NORMAL);
177 /* Outputs the log message to the first available channel. Channels are
178 * ordered by importance (see SilcLogType documentation).
179 * More important channels can be printed on less important ones, but not
182 void silc_log_output(SilcLogType type, char *string)
184 const char *typename = NULL;
188 if ((type > SILC_LOG_MAX) || !(log = silc_log_find_by_type(type)))
191 /* Save the original typename, because even if we redirect the message
192 * to another channel we'll keep however the original channel name */
193 typename = log->typename;
195 /* If there is a custom callback set, use it and return. */
197 if ((*log->cb)(type, string, log->context))
201 if (!silc_log_scheduled) {
202 if (silc_log_no_init == FALSE) {
204 "Warning, trying to output without log files initialization, "
205 "log output is going to stderr\n");
206 silc_log_no_init = TRUE;
208 /* redirect output */
214 /* ok, now we have to find an open stream */
216 if (log && (fp = log->fp)) goto found;
217 if (type == 0) break;
218 log = silc_log_find_by_type(--type);
221 /* Couldn't find any open stream.. sorry :( */
222 SILC_LOG_DEBUG(("Warning! couldn't find any available log channel!"));
226 /* writes the logging string to the selected channel */
227 if (silc_log_timestamp)
228 fprintf(fp, "[%s] [%s] %s\n", silc_get_time(0), typename, string);
230 fprintf(fp, "[%s] %s\n", typename, string);
232 if (silc_log_quick || silc_log_starting) {
234 if (log) /* we may have been redirected to stderr */
235 silc_log_checksize(log);
239 /* If debugging, also output the logging message to the console */
240 if (typename && silc_debug) {
241 fprintf(stderr, "[Logging] [%s] %s\n", typename, string);
247 /* returns an internally allocated pointer to a logging channel file */
248 char *silc_log_get_file(SilcLogType type)
252 if (!(log = silc_log_find_by_type(type)))
255 return log->filename;
259 /* Set and initialize the specified logging channel. See the API reference */
260 bool silc_log_set_file(SilcLogType type, char *filename, SilcUInt32 maxsize,
261 SilcSchedule scheduler)
266 log = silc_log_find_by_type(type);
270 SILC_LOG_DEBUG(("Setting \"%s\" file to %s (max size=%d)",
271 log->typename, filename, maxsize));
273 /* before assuming the new file, make sure we can open it */
275 if (!(fp = fopen(filename, "a+"))) {
276 fprintf(stderr, "warning: couldn't open log file %s: %s\n",
277 filename, strerror(errno));
282 /* clean the logging channel */
283 if (strlen(log->filename)) {
286 memset(log->filename, 0, sizeof(log->filename));
291 memset(log->filename, 0, sizeof(log->filename));
292 strncpy(log->filename, filename,
293 strlen(filename) < sizeof(log->filename) ? strlen(filename) :
294 sizeof(log->filename) - 1);
296 log->maxsize = maxsize;
300 if (silc_log_scheduled)
303 /* Add schedule hook with a short delay to make sure we'll use
305 silc_schedule_task_add(scheduler, 0, silc_log_fflush_callback,
306 (void *) scheduler, 10, 0,
307 SILC_TASK_TIMEOUT, SILC_TASK_PRI_NORMAL);
308 silc_log_scheduled = TRUE;
314 /* Sets a log callback, set callback to NULL to return to default behaviour */
316 void silc_log_set_callback(SilcLogType type, SilcLogCb cb, void *context)
320 if (!(log = silc_log_find_by_type(type)))
324 log->context = context;
327 /* Resets log callbacks */
329 void silc_log_reset_callbacks()
332 SILC_FOREACH_LOG(u) {
333 silclogs[u].cb = NULL;
334 silclogs[u].context = NULL;
338 /* Flushes all opened logging channels */
340 void silc_log_flush_all() {
342 SILC_LOG_DEBUG(("Flushing all logs"));
343 SILC_FOREACH_LOG(u) {
345 fflush(silclogs[u].fp);
349 /* Resets all known logging channels */
351 void silc_log_reset_all() {
353 SILC_LOG_DEBUG(("Resetting all logs"));
355 silc_log_reset(&silclogs[u]);
356 /* Immediately flush any possible warning message */
357 silc_log_flush_all();
360 /* Outputs the debug message to stderr. */
362 void silc_log_output_debug(char *file, char *function,
363 int line, char *string)
368 if (silc_log_debug_string &&
369 !silc_string_regex_match(silc_log_debug_string, file) &&
370 !silc_string_regex_match(silc_log_debug_string, function))
373 if (silc_log_debug_cb) {
374 if ((*silc_log_debug_cb)(file, function, line, string,
375 silc_log_debug_context))
379 fprintf(stderr, "%s:%d: %s\n", function, line, string);
386 /* Hexdumps a message */
388 void silc_log_output_hexdump(char *file, char *function,
389 int line, void *data_in,
390 SilcUInt32 len, char *string)
394 unsigned char *data = (unsigned char *)data_in;
396 if (!silc_debug_hexdump)
399 if (silc_log_debug_string &&
400 !silc_string_regex_match(silc_log_debug_string, file) &&
401 !silc_string_regex_match(silc_log_debug_string, function))
404 if (silc_log_hexdump_cb) {
405 if ((*silc_log_hexdump_cb)(file, function, line, data_in, len, string,
406 silc_log_hexdump_context))
410 fprintf(stderr, "%s:%d: %s\n", function, line, string);
418 if ((len - pos) < 16 && (len - pos <= len - off))
428 fprintf(stderr, "%08X ", k++ * 16);
430 for (i = 0; i < count; i++) {
431 fprintf(stderr, "%02X ", data[pos + i]);
433 if ((i + 1) % 4 == 0)
434 fprintf(stderr, " ");
437 if (count && count < 16) {
440 for (j = 0; j < 16 - count; j++) {
441 fprintf(stderr, " ");
443 if ((j + count + 1) % 4 == 0)
444 fprintf(stderr, " ");
448 for (i = 0; i < count; i++) {
451 if (data[pos] < 32 || data[pos] >= 127)
456 fprintf(stderr, "%c", ch);
461 fprintf(stderr, "\n");
471 /* Sets debug callbacks */
473 void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
475 SilcLogHexdumpCb hexdump_cb,
476 void *hexdump_context)
478 silc_log_debug_cb = debug_cb;
479 silc_log_debug_context = debug_context;
480 silc_log_hexdump_cb = hexdump_cb;
481 silc_log_hexdump_context = hexdump_context;
484 /* Resets debug callbacks */
486 void silc_log_reset_debug_callbacks()
488 silc_log_debug_cb = NULL;
489 silc_log_debug_context = NULL;
490 silc_log_hexdump_cb = NULL;
491 silc_log_hexdump_context = NULL;
494 /* Set current debug string */
496 void silc_log_set_debug_string(const char *debug_string)
500 if ((strchr(debug_string, '(') && strchr(debug_string, ')')) ||
501 strchr(debug_string, '$'))
502 string = strdup(debug_string);
504 string = silc_string_regexify(debug_string);
505 len = strlen(string);
506 if (len >= sizeof(silc_log_debug_string))
507 len = sizeof(silc_log_debug_string) - 1;
508 memset(silc_log_debug_string, 0, sizeof(silc_log_debug_string));
509 strncpy(silc_log_debug_string, string, len);