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/SilcLogAPI
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 choosing
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 failures messages */
59 /* Fatal messages (usually situations that will lead to a program crash */
62 /* Total 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, uint32 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 it
126 * like 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, uint32 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 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
180 extern long silc_log_flushdelay;
182 /****v* silcutil/SilcLogAPI/silc_debug
186 * bool silc_debug -- enable/disable debugging output
190 * If silc_debug is set to FALSE, debugging functions won't procude any
191 * output. This is useful when for example you compile in the debugging
192 * support but at a certain point you want to send the program in the
199 extern bool silc_debug;
201 /****v* silcutil/SilcLogAPI/silc_debug_hexdump
205 * bool silc_debug_hexdump -- enable/disable debugging output
209 * If silc_debug_hexdump is set to FALSE, debugging functions won't produce
210 * any output. This is useful when for example you compile in the debugging
211 * support but at a certain point you want to send the program in the
218 extern bool silc_debug_hexdump;
223 #define __FUNCTION__ ""
226 /****d* silcutil/SilcLogAPI/SILC_LOG_INFO
230 * #define SILC_LOG_INFO(...)
234 * This macro is a wrapper to the main logging function.
235 * It supports variable argument list formatting, and *automatically*
236 * appends newline at the end of the string.
240 * This macro requires double parenthesis to ensure that the VA list
241 * formatting would work correctly.
245 * SILC_LOG_INFO(("Today i feel %s", core->mood));
249 #define SILC_LOG_INFO(fmt) silc_log_output(SILC_LOG_INFO, silc_format fmt)
252 /****d* silcutil/SilcLogAPI/SILC_LOG_WARNING
256 * #define SILC_LOG_WARNING(...)
260 * Wrapper to the WARNING logging channel.
261 * Please see the SILC_LOG_INFO macro.
268 #define SILC_LOG_WARNING(fmt) silc_log_output(SILC_LOG_WARNING, silc_format fmt)
271 /****d* silcutil/SilcLogAPI/SILC_LOG_ERROR
275 * #define SILC_LOG_ERROR(...)
279 * Wrapper to the ERROR logging channel.
280 * Please see the SILC_LOG_INFO macro.
287 #define SILC_LOG_ERROR(fmt) silc_log_output(SILC_LOG_ERROR, silc_format fmt)
290 /****d* silcutil/SilcLogAPI/SILC_LOG_FATAL
294 * #define SILC_LOG_FATAL(...)
298 * Wrapper to the FATAL logging channel.
299 * Please see the SILC_LOG_INFO macro.
306 #define SILC_LOG_FATAL(fmt) silc_log_output(SILC_LOG_FATAL, silc_format fmt)
309 /****d* silcutil/SilcLogAPI/SILC_LOG_DEBUG
313 * #define SILC_LOG_DEBUG(...)
317 * This is a special wrapper to the debugging output (usually stderr).
318 * The standard behaviour is the same as SILC_LOG_INFO, but this macro
319 * also depends on the global debugging macro SILC_DEBUG.
320 * Undefining the global SILC_DEBUG define causes these functions to be
321 * defined to an empty value, thus removing all logging calls from the
330 #define SILC_LOG_DEBUG(fmt) silc_log_output_debug(__FILE__, \
335 #define SILC_LOG_DEBUG(fmt)
336 #endif /* SILC_DEBUG */
339 /****d* silcutil/SilcLogAPI/SILC_LOG_HEXDUMP
343 * #define SILC_LOG_HEXDUMP(...)
347 * This is a special wrapper to the hexdump output function. This macro
348 * behaves slightly differently from other logging wrappers.
349 * The first parameter, is composed by a group of parameters delimited by
351 * The second parameter is a (char *) pointer to the beginning of the
352 * memory section that should be hexdumped, and the third parameter is
353 * the length of this memory section.
354 * This macro is also affected by the global variable silc_debug_hexdump.
355 * Undefining the global SILC_DEBUG define causes these functions to be
356 * defined to an empty value, thus removing all logging calls from the
361 * SILC_LOG_HEXDUMP(("Outgoing packet [%d], len %d", pckt->seq, pckt->len),
362 * pckt->data, pckt->datalen);
367 #define SILC_LOG_HEXDUMP(fmt, data, len) silc_log_output_hexdump(__FILE__, \
373 #define SILC_LOG_HEXDUMP(fmt, data, len)
374 #endif /* SILC_DEBUG */
379 /****f* silcutil/SilcLogAPI/silc_log_output
383 * void silc_log_output(SilcLogType type, char *string);
387 * This is the main function for logging output. Please note that you
388 * should rather use one of the logging wrapper macros.
389 * If you really want to use this function, its usage is quite simple.
390 * The `type' parameter identifies the channel to use, while the `string'
391 * parameter must be a dynamic allocated (null-terminated) buffer, because
392 * it will be freed at the end of this function, for internal reasons.
393 * If there are registered callbacks for the specified type, this function
394 * will first trigger those callbacks. The callback functions must NOT
395 * free or modify the original buffer.
398 * SILC_LOG_INFO, SILC_LOG_WARNING, SILC_LOG_ERROR, SILC_LOG_FATAL
401 void silc_log_output(SilcLogType type, char *string);
403 /****f* silcutil/SilcLogAPI/silc_log_get_file
407 * char *silc_log_get_file(SilcLogType type);
411 * Returns the current logging file for the channel `type'.
412 * If there has been an error during the opening of this channel, NULL
413 * is returned, even if the file has been previously set with
414 * silc_log_set_file().
415 * The returned pointer points to internally allocated storage and must
416 * must not be freed, modified or stored.
419 char *silc_log_get_file(SilcLogType type);
421 /****f* silcutil/SilcLogAPI/silc_log_set_file
425 * bool silc_log_set_file(SilcLogType type, char *filename, uint32 maxsize,
426 * SilcSchedule scheduler);
430 * Sets `filename', which can be maximum `maxsize' bytes long, as the new
431 * logging file for the channel `type'. If you specify an illegal filename
432 * a warning message is printed and FALSE is returned. In this case
433 * logging settings are not changed.
434 * You can disable logging for a channel by specifying NULL filename, the
435 * maxsize in this case is not important.
436 * The `scheduler' parameter is needed by the internal logging to allow
437 * buffered output and thus to save HD activity.
440 bool silc_log_set_file(SilcLogType type, char *filename, uint32 maxsize,
441 SilcSchedule scheduler);
443 /****f* silcutil/SilcLogAPI/silc_log_set_callback
447 * void silc_log_set_callback(SilcLogType type, SilcLogCb cb,
452 * Set `cb' as the default callback function for the logging channel
453 * `type'. When SilcLog receives a message for this channel, it will
454 * trigger the callback function. If the callback function returns TRUE
455 * SilcLog will assume the input as handled and won't run its default
457 * You can disable/remove a callback by setting it to NULL or calling the
458 * function silc_log_reset_callbacks.
459 * If set, the callback function must be in the form described by
463 * SilcLogCb, silc_log_reset_callbacks
466 void silc_log_set_callback(SilcLogType type, SilcLogCb cb, void *context);
468 /****f* silcutil/SilcLogAPI/silc_log_reset_callbacks
472 * void silc_log_reset_callbacks();
476 * Removes all logging callbacks for normal channels. This function does
477 * NOT remove callbacks for debugging channels (debug and hexdump), you
478 * rather need to call silc_log_set_debug_callbacks() with NULL callbacks.
481 void silc_log_reset_callbacks();
483 /****f* silcutil/SilcLogAPI/silc_log_flush_all
487 * void silc_log_flush_all();
491 * Forces flushing for all logging channels. This should be called for
492 * example after receiving special signals.
498 void silc_log_flush_all();
500 /****f* silcutil/SilcLogAPI/silc_log_reset_all
504 * void silc_log_reset_all();
508 * Forces all logging channels to close and reopen their streams. Useful
509 * for example after a SIGHUP signal.
510 * Please note that this function could cause some warning messages if
511 * some logging channel points to an illegal filename.
514 void silc_log_reset_all();
516 /****f* silcutil/SilcLogAPI/silc_log_output_debug
520 * void silc_log_output_debug(char *file, char *function,
521 * int line, char *string);
525 * This is the main function for debug output. Please note that you should
526 * rather use the wrapper macro SILC_LOG_DEBUG.
527 * If you want to use it anyway, the `file', `function', and `line' are the
528 * corresponding offsets in the source files, while `string' must be a
529 * dynamic allocated (null-terminated) buffer.
532 void silc_log_output_debug(char *file, char *function,
533 int line, char *string);
535 /****f* silcutil/SilcLogAPI/silc_log_output_hexdump
539 * void silc_log_output_hexdump(char *file, char *function,
540 * int line, void *data_in,
541 * uint32 len, char *string);
545 * This is the main function for hexdump output. Please note that you
546 * should rather use the wrapper macro SILC_LOG_HEXDUMP.
547 * If you want to use it anyway, the `file', `function', and `line' are the
548 * corresponding offsets in the source files, `data_in' is the beginning
549 * of the buffer you wish to hexdump, which is `len' bytes long.
550 * `string' must be a dynamic allocated (null-terminated) buffer.
553 void silc_log_output_hexdump(char *file, char *function,
554 int line, void *data_in,
555 uint32 len, char *string);
557 /****f* silcutil/SilcLogAPI/silc_log_set_debug_callbacks
561 * void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
562 * void *debug_context,
563 * SilcLogHexdumpCb hexdump_cb,
564 * void *hexdump_context);
568 * Sets `debug_cb' as the the default callback function for the debug
569 * output, that will be called with the `debug_context' parameter.
570 * When SilcLog receives a debug message, it will trigger the callback
571 * function. If the callback function returns TRUE SilcLog will assume
572 * the input as handled and won't run its default handler.
573 * `hexdump_cb' and `hexdump_context' works the same way, except that they
574 * are referred to SILC_LOG_HEXDUMP requests.
575 * You can disable/remove a callback by setting it to NULL.
576 * If set, each callback function must be either in the form described by
577 * SilcLogDebugCb or SilcLogHexdumpCb.
580 * SilcLogDebugCb, SilcLogHexdumpCb
583 void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
585 SilcLogHexdumpCb hexdump_cb,
586 void *hexdump_context);
588 /****f* silcutil/SilcLogAPI/silc_log_set_debug_string
592 * void silc_log_set_debug_string(const char *debug_string);
596 * Sets `debug_string' as the regexp string for filtering debugging
597 * output. The string is copied and it can be modified/destroyed after
598 * this function call.
601 void silc_log_set_debug_string(const char *debug_string);
603 #endif /* !SILCLOG_H */