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.
21 /****h* silcutil/SILC Logging Interface
25 * The SILC logging APIs provide a powerful and easy-to-use interface to
26 * the logging system and debugging output.
33 /****d* silcutil/SilcLogAPI/SilcLogType
37 * typedef enum { ... } SilcLogType;
41 * This is the main logging channel id. There are currently four known
42 * logging channels (plus the debugging output channel), and they are
43 * ordered by importance.
44 * See the source code for SILC coding conventions about how to choose
45 * the right output channel.
50 /* Generic info channel file */
53 /* This should be used for warnings and non critical failures */
56 /* Generic error and critical failure messages */
59 /* Fatal messages (usually situations that will lead to a program crash */
62 /* Total number logging channels */
67 /****f* silcutil/SilcLogAPI/SilcLogCb
71 * typedef bool (*SilcLogCb)(SilcLogType type, char *message,
76 * The logging custom callback function. The `type' is the channel ID
77 * that triggered the event, which allows you to use the same callback
78 * function for multiple logging channels.
79 * The `message' parameter points to a null-terminated buffer containing
80 * the received message, while `context' is the caller-specified context.
81 * The message must not be modified or freed by the callback function.
84 * silc_log_set_callback
87 typedef bool (*SilcLogCb)(SilcLogType type, char *message, void *context);
89 /****f* silcutil/SilcLogAPI/SilcLogDebugCb
93 * typedef bool (*SilcLogDebugCb)(char *file, char *function, int line,
94 * char *message, void *context);
98 * The debug logging callback function. The default behaviour is to
99 * output messages to stderr. `file', `function', and `line' are the
100 * corresponding offsets in the source files. `message' points to a
101 * null-terminated buffer containing the debugging message, and `context'
102 * is the caller-specified context.
103 * The message must not be modified or freed by the callback function.
104 * If the function returns TRUE, SilcLog will assume the message as handled
105 * and won't run its default handler.
108 * silc_debug, silc_log_set_debug_callbacks
111 typedef bool (*SilcLogDebugCb)(char *file, char *function, int line,
112 char *message, void *context);
114 /****f* silcutil/SilcLogAPI/SilcLogHexdumpCb
118 * typedef bool (*SilcDebugHexdumpCb)(char *file, char *function, int line,
119 * unsigned char *data, SilcUInt32 data_len,
120 * char *message, void *context;
124 * The hexdump logging callback function. The default behaviour is to
125 * print a formatted hexdump to stderr, and is commonly what you would
126 * like it to be. `file', `function', and `line' are the corresponding
127 * offsets in the source files. `data' is the begin of the buffer that
128 * should be hexdumped, which is `data_len' bytes long.
129 * The `message' parameter points to a null-terminated buffer containing
130 * the received message, while `context' is the caller-specified context.
131 * The message must not be modified or freed by the callback function.
132 * If the function returns TRUE, SilcLog will assume the message as handled
133 * and won't run its default handler.
136 * silc_debug_hexdump, silc_log_set_debug_callbacks
139 typedef bool (*SilcLogHexdumpCb)(char *file, char *function, int line,
140 unsigned char *data, SilcUInt32 data_len,
141 char *message, void *context);
143 /* Global Variables */
145 /****v* silcutil/SilcLogAPI/silc_log_quick
149 * bool silc_log_quick -- enable/disable fast logging output
153 * SilcLog makes use of libc stream buffering output, which means that it
154 * saves HD activity by buffering the logging messages and writing them
155 * all together every some minutes (default is 5 minutes).
156 * Setting this variable to TRUE will force SilcLog to write messages to the
157 * filesystem as soon as they are received. This increases the CPU activity
158 * notably on bigger servers, but reduces memory usage.
159 * If you want to change the logging style on-the-fly, make sure to call
160 * silc_log_flush_all() after setting this variable to TRUE.
163 extern DLLAPI bool silc_log_quick;
165 /****v* silcutil/SilcLogAPI/silc_log_flushdelay
169 * long silc_log_flushdelay -- flushing time delay
173 * Sets the logfiles flushing delay in seconds. As for now, changing this
174 * value AFTER logfiles initialization won't take effect until previous
175 * delay time will expire; for example if you change from 300 seconds to
176 * 60 seconds you will have to wait up to 300 seconds for this change to
178 * This value must be greater than 2 seconds.
181 extern DLLAPI long silc_log_flushdelay;
183 /****v* silcutil/SilcLogAPI/silc_debug
187 * bool silc_debug -- enable/disable debugging output
191 * If silc_debug is set to FALSE, debugging functions won't procude any
192 * output. This is useful when for example you compile in the debugging
193 * support but at a certain point you want to send the program in the
200 extern DLLAPI bool silc_debug;
202 /****v* silcutil/SilcLogAPI/silc_debug_hexdump
206 * bool silc_debug_hexdump -- enable/disable debugging output
210 * If silc_debug_hexdump is set to FALSE, debugging functions won't produce
211 * any output. This is useful when for example you compile in the debugging
212 * support but at a certain point you want to send the program in the
219 extern DLLAPI bool silc_debug_hexdump;
225 #define __FUNCTION__ ""
229 /****d* silcutil/SilcLogAPI/SILC_LOG_INFO
233 * #define SILC_LOG_INFO(...)
237 * This macro is a wrapper to the main logging function.
238 * It supports variable argument list formatting, and *automatically*
239 * appends newline at the end of the string.
243 * This macro requires double parenthesis to ensure that the VA list
244 * formatting would work correctly.
248 * SILC_LOG_INFO(("Today i feel %s", core->mood));
252 #define SILC_LOG_INFO(fmt) silc_log_output(SILC_LOG_INFO, silc_format fmt)
255 /****d* silcutil/SilcLogAPI/SILC_LOG_WARNING
259 * #define SILC_LOG_WARNING(...)
263 * Wrapper to the WARNING logging channel.
264 * Please see the SILC_LOG_INFO macro.
271 #define SILC_LOG_WARNING(fmt) silc_log_output(SILC_LOG_WARNING, silc_format fmt)
274 /****d* silcutil/SilcLogAPI/SILC_LOG_ERROR
278 * #define SILC_LOG_ERROR(...)
282 * Wrapper to the ERROR logging channel.
283 * Please see the SILC_LOG_INFO macro.
290 #define SILC_LOG_ERROR(fmt) silc_log_output(SILC_LOG_ERROR, silc_format fmt)
293 /****d* silcutil/SilcLogAPI/SILC_LOG_FATAL
297 * #define SILC_LOG_FATAL(...)
301 * Wrapper to the FATAL logging channel.
302 * Please see the SILC_LOG_INFO macro.
309 #define SILC_LOG_FATAL(fmt) silc_log_output(SILC_LOG_FATAL, silc_format fmt)
312 /****d* silcutil/SilcLogAPI/SILC_LOG_DEBUG
316 * #define SILC_LOG_DEBUG(...)
320 * This is a special wrapper to the debugging output (usually stderr).
321 * The standard behaviour is the same as SILC_LOG_INFO, with the difference
322 * that this macro also depends on the global define SILC_DEBUG.
323 * Undefining SILC_DEBUG causes these functions to be defined to an empty
324 * value, thus removing all debug logging calls from the compiled
326 * This macro is also affected by the global variable silc_debug.
331 #define SILC_LOG_DEBUG(fmt) silc_log_output_debug(__FILE__, \
335 #define SILC_NOT_IMPLEMENTED(string) \
336 SILC_LOG_DEBUG(("*********** %s: NOT IMPLEMENTED YET", string));
338 #define SILC_LOG_DEBUG(fmt)
339 #define SILC_NOT_IMPLEMENTED(string)
340 #endif /* SILC_DEBUG */
343 /****d* silcutil/SilcLogAPI/SILC_LOG_HEXDUMP
347 * #define SILC_LOG_HEXDUMP(...)
351 * This is a special wrapper to the hexdump output function. This macro
352 * behaves slightly differently from other logging wrappers.
353 * The first parameter, is composed by a group of parameters delimited by
355 * The second parameter is a `char *' pointer pointing to the beginning
356 * of the memory section that should be hexdumped, and the third parameter
357 * is the length of this memory section.
358 * Undefining the global SILC_DEBUG define causes these functions to be
359 * defined to an empty value, thus removing all debug logging calls from
360 * the compiled application.
361 * This macro is also affected by the global variable silc_debug_hexdump.
365 * SILC_LOG_HEXDUMP(("Outgoing packet [%d], len %d", pckt->seq, pckt->len),
366 * pckt->data, pckt->datalen);
371 #define SILC_LOG_HEXDUMP(fmt, data, len) silc_log_output_hexdump(__FILE__, \
377 #define SILC_LOG_HEXDUMP(fmt, data, len)
378 #endif /* SILC_DEBUG */
383 /****f* silcutil/SilcLogAPI/silc_log_output
387 * void silc_log_output(SilcLogType type, char *string);
391 * This is the main function for logging output. Please note that you
392 * should rather use one of the logging wrapper macros.
393 * If you really want to use this function, its usage is quite simple.
394 * The `type' parameter identifies the channel to use, while the `string'
395 * parameter must be a dynamic allocated (null-terminated) buffer, because
396 * it will be freed at the end of this function, for internal reasons.
397 * If there are registered callbacks for the specified type, this function
398 * will first trigger those callbacks. The callback functions must NOT
399 * free or modify the original buffer.
402 * SILC_LOG_INFO, SILC_LOG_WARNING, SILC_LOG_ERROR, SILC_LOG_FATAL
405 void silc_log_output(SilcLogType type, char *string);
407 /****f* silcutil/SilcLogAPI/silc_log_get_file
411 * char *silc_log_get_file(SilcLogType type);
415 * Returns the current logging file for the channel `type'.
416 * If there has been an error during the opening of this channel, NULL
417 * is returned, even if the file has been previously set with
418 * silc_log_set_file().
419 * The returned pointer points to internally allocated storage and must
420 * not be freed, modified or stored.
423 char *silc_log_get_file(SilcLogType type);
425 /****f* silcutil/SilcLogAPI/silc_log_set_file
429 * bool silc_log_set_file(SilcLogType type, char *filename,
430 * SilcUInt32 maxsize,
431 * SilcSchedule scheduler);
435 * Sets `filename', which can be maximum `maxsize' bytes long, as the new
436 * logging file for the channel `type'. If you specify an illegal filename
437 * a warning message is printed and FALSE is returned. In this case
438 * logging settings are not changed.
439 * You can disable logging for a channel by specifying NULL filename, the
440 * maxsize in this case is not important.
441 * The `scheduler' parameter is needed by the internal logging to allow
442 * buffered output and thus to save HD activity.
445 bool silc_log_set_file(SilcLogType type, char *filename, SilcUInt32 maxsize,
446 SilcSchedule scheduler);
448 /****f* silcutil/SilcLogAPI/silc_log_set_callback
452 * void silc_log_set_callback(SilcLogType type, SilcLogCb cb,
457 * Set `cb' as the default callback function for the logging channel
458 * `type'. When SilcLog receives a message for this channel, it will
459 * trigger the callback function. If the callback function returns TRUE
460 * SilcLog will assume the input as handled and won't run its default
462 * You can disable/remove a callback by setting it to NULL or calling the
463 * function silc_log_reset_callbacks.
464 * If set, the callback function must be in the form described by
468 * silc_log_reset_callbacks
471 void silc_log_set_callback(SilcLogType type, SilcLogCb cb, void *context);
473 /****f* silcutil/SilcLogAPI/silc_log_reset_callbacks
477 * void silc_log_reset_callbacks();
481 * Removes all logging callbacks for normal channels. This function does
482 * NOT remove callbacks for debugging channels (debug and hexdump), you
483 * rather need to call silc_log_set_debug_callbacks() with NULL callbacks.
486 void silc_log_reset_callbacks();
488 /****f* silcutil/SilcLogAPI/silc_log_flush_all
492 * void silc_log_flush_all();
496 * Forces flushing for all logging channels. This should be called for
497 * example after receiving special signals.
503 void silc_log_flush_all();
505 /****f* silcutil/SilcLogAPI/silc_log_reset_all
509 * void silc_log_reset_all();
513 * Forces all logging channels to close and reopen their streams. Useful
514 * for example after a SIGHUP signal.
515 * Please note that this function could generate some warning messages if
516 * one or more logging channels point to an illegal filename.
519 void silc_log_reset_all();
521 /****f* silcutil/SilcLogAPI/silc_log_output_debug
525 * void silc_log_output_debug(char *file, char *function,
526 * int line, char *string);
530 * This is the main function for debug output. Please note that you should
531 * rather use the wrapper macro SILC_LOG_DEBUG.
532 * If you want to use it anyway, the `file', `function', and `line' are the
533 * corresponding offsets in the source files, while `string' must be a
534 * dynamic allocated (null-terminated) buffer.
537 void silc_log_output_debug(char *file, char *function,
538 int line, char *string);
540 /****f* silcutil/SilcLogAPI/silc_log_output_hexdump
544 * void silc_log_output_hexdump(char *file, char *function,
545 * int line, void *data_in,
546 * SilcUInt32 len, char *string);
550 * This is the main function for hexdump output. Please note that you
551 * should rather use the wrapper macro SILC_LOG_HEXDUMP.
552 * If you want to use it anyway, the `file', `function', and `line' are the
553 * corresponding offsets in the source files, `data_in' is the beginning
554 * of the buffer you wish to hexdump, which is `len' bytes long.
555 * `string' must be a dynamic allocated (null-terminated) buffer.
558 void silc_log_output_hexdump(char *file, char *function,
559 int line, void *data_in,
560 SilcUInt32 len, char *string);
562 /****f* silcutil/SilcLogAPI/silc_log_set_debug_callbacks
566 * void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
567 * void *debug_context,
568 * SilcLogHexdumpCb hexdump_cb,
569 * void *hexdump_context);
573 * Sets `debug_cb' as the the default callback function for the debug
574 * output, that will be called with the `debug_context' parameter.
575 * When SilcLog receives a debug message, it will trigger the callback
576 * function. If the callback function returns TRUE SilcLog will assume
577 * the input as handled and won't run its default handler.
578 * `hexdump_cb' and `hexdump_context' works the same way, except that they
579 * are referred to SILC_LOG_HEXDUMP requests.
580 * You can disable/remove a callback by setting it to NULL.
581 * If set, each callback function must be either in the form described by
582 * SilcLogDebugCb or SilcLogHexdumpCb.
585 * SilcLogDebugCb, SilcLogHexdumpCb
588 void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
590 SilcLogHexdumpCb hexdump_cb,
591 void *hexdump_context);
593 /****f* silcutil/SilcLogAPI/silc_log_set_debug_string
597 * void silc_log_set_debug_string(const char *debug_string);
601 * Sets `debug_string' as the regexp string for filtering debugging
602 * output. The string is copied and it can be modified/destroyed after
603 * this function call.
606 void silc_log_set_debug_string(const char *debug_string);
608 #endif /* !SILCLOG_H */