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_timestamp
149 * bool silc_log_timestamp -- enable/disable fast logging timestamp
153 * Causes SilcLog to add a timestamp as returned by silc_get_time().
154 * This may be useful for example if you run your application under a
155 * daemon helper like watchdog that adds its own timestamp. Defaults to
159 extern DLLAPI bool silc_log_timestamp;
161 /****v* silcutil/SilcLogAPI/silc_log_quick
165 * bool silc_log_quick -- enable/disable fast logging output
169 * SilcLog makes use of libc stream buffering output, which means that it
170 * saves HD activity by buffering the logging messages and writing them
171 * all together every some minutes (default is 5 minutes).
172 * Setting this variable to TRUE will force SilcLog to write messages to the
173 * filesystem as soon as they are received. This increases the CPU activity
174 * notably on bigger servers, but reduces memory usage.
175 * If you want to change the logging style on-the-fly, make sure to call
176 * silc_log_flush_all() after setting this variable to TRUE.
179 extern DLLAPI bool silc_log_quick;
181 /****v* silcutil/SilcLogAPI/silc_log_flushdelay
185 * long silc_log_flushdelay -- flushing time delay
189 * Sets the logfiles flushing delay in seconds. As for now, changing this
190 * value AFTER logfiles initialization won't take effect until previous
191 * delay time will expire; for example if you change from 300 seconds to
192 * 60 seconds you will have to wait up to 300 seconds for this change to
194 * This value must be greater than 2 seconds.
197 extern DLLAPI long silc_log_flushdelay;
199 /****v* silcutil/SilcLogAPI/silc_debug
203 * bool silc_debug -- enable/disable debugging output
207 * If silc_debug is set to FALSE, debugging functions won't procude any
208 * output. This is useful when for example you compile in the debugging
209 * support but at a certain point you want to send the program in the
216 extern DLLAPI bool silc_debug;
218 /****v* silcutil/SilcLogAPI/silc_debug_hexdump
222 * bool silc_debug_hexdump -- enable/disable debugging output
226 * If silc_debug_hexdump is set to FALSE, debugging functions won't produce
227 * any output. This is useful when for example you compile in the debugging
228 * support but at a certain point you want to send the program in the
235 extern DLLAPI bool silc_debug_hexdump;
241 #define __FUNCTION__ ""
245 /****d* silcutil/SilcLogAPI/SILC_LOG_INFO
249 * #define SILC_LOG_INFO(...)
253 * This macro is a wrapper to the main logging function.
254 * It supports variable argument list formatting, and *automatically*
255 * appends newline at the end of the string.
259 * This macro requires double parenthesis to ensure that the VA list
260 * formatting would work correctly.
264 * SILC_LOG_INFO(("Today i feel %s", core->mood));
268 #define SILC_LOG_INFO(fmt) silc_log_output(SILC_LOG_INFO, silc_format fmt)
271 /****d* silcutil/SilcLogAPI/SILC_LOG_WARNING
275 * #define SILC_LOG_WARNING(...)
279 * Wrapper to the WARNING logging channel.
280 * Please see the SILC_LOG_INFO macro.
287 #define SILC_LOG_WARNING(fmt) silc_log_output(SILC_LOG_WARNING, silc_format fmt)
290 /****d* silcutil/SilcLogAPI/SILC_LOG_ERROR
294 * #define SILC_LOG_ERROR(...)
298 * Wrapper to the ERROR logging channel.
299 * Please see the SILC_LOG_INFO macro.
306 #define SILC_LOG_ERROR(fmt) silc_log_output(SILC_LOG_ERROR, silc_format fmt)
309 /****d* silcutil/SilcLogAPI/SILC_LOG_FATAL
313 * #define SILC_LOG_FATAL(...)
317 * Wrapper to the FATAL logging channel.
318 * Please see the SILC_LOG_INFO macro.
325 #define SILC_LOG_FATAL(fmt) silc_log_output(SILC_LOG_FATAL, silc_format fmt)
328 /****d* silcutil/SilcLogAPI/SILC_LOG_DEBUG
332 * #define SILC_LOG_DEBUG(...)
336 * This is a special wrapper to the debugging output (usually stderr).
337 * The standard behaviour is the same as SILC_LOG_INFO, with the difference
338 * that this macro also depends on the global define SILC_DEBUG.
339 * Undefining SILC_DEBUG causes these functions to be defined to an empty
340 * value, thus removing all debug logging calls from the compiled
342 * This macro is also affected by the global variable silc_debug.
347 #define SILC_LOG_DEBUG(fmt) silc_log_output_debug(__FILE__, \
351 #define SILC_NOT_IMPLEMENTED(string) \
352 SILC_LOG_DEBUG(("*********** %s: NOT IMPLEMENTED YET", string));
354 #define SILC_LOG_DEBUG(fmt)
355 #define SILC_NOT_IMPLEMENTED(string)
356 #endif /* SILC_DEBUG */
359 /****d* silcutil/SilcLogAPI/SILC_LOG_HEXDUMP
363 * #define SILC_LOG_HEXDUMP(...)
367 * This is a special wrapper to the hexdump output function. This macro
368 * behaves slightly differently from other logging wrappers.
369 * The first parameter, is composed by a group of parameters delimited by
371 * The second parameter is a `char *' pointer pointing to the beginning
372 * of the memory section that should be hexdumped, and the third parameter
373 * is the length of this memory section.
374 * Undefining the global SILC_DEBUG define causes these functions to be
375 * defined to an empty value, thus removing all debug logging calls from
376 * the compiled application.
377 * This macro is also affected by the global variable silc_debug_hexdump.
381 * SILC_LOG_HEXDUMP(("Outgoing packet [%d], len %d", pckt->seq, pckt->len),
382 * pckt->data, pckt->datalen);
387 #define SILC_LOG_HEXDUMP(fmt, data, len) silc_log_output_hexdump(__FILE__, \
393 #define SILC_LOG_HEXDUMP(fmt, data, len)
394 #endif /* SILC_DEBUG */
399 /****f* silcutil/SilcLogAPI/silc_log_output
403 * void silc_log_output(SilcLogType type, char *string);
407 * This is the main function for logging output. Please note that you
408 * should rather use one of the logging wrapper macros.
409 * If you really want to use this function, its usage is quite simple.
410 * The `type' parameter identifies the channel to use, while the `string'
411 * parameter must be a dynamic allocated (null-terminated) buffer, because
412 * it will be freed at the end of this function, for internal reasons.
413 * If there are registered callbacks for the specified type, this function
414 * will first trigger those callbacks. The callback functions must NOT
415 * free or modify the original buffer.
418 * SILC_LOG_INFO, SILC_LOG_WARNING, SILC_LOG_ERROR, SILC_LOG_FATAL
421 void silc_log_output(SilcLogType type, char *string);
423 /****f* silcutil/SilcLogAPI/silc_log_get_file
427 * char *silc_log_get_file(SilcLogType type);
431 * Returns the current logging file for the channel `type'.
432 * If there has been an error during the opening of this channel, NULL
433 * is returned, even if the file has been previously set with
434 * silc_log_set_file().
435 * The returned pointer points to internally allocated storage and must
436 * not be freed, modified or stored.
439 char *silc_log_get_file(SilcLogType type);
441 /****f* silcutil/SilcLogAPI/silc_log_set_file
445 * bool silc_log_set_file(SilcLogType type, char *filename,
446 * SilcUInt32 maxsize,
447 * SilcSchedule scheduler);
451 * Sets `filename', which can be maximum `maxsize' bytes long, as the new
452 * logging file for the channel `type'. If you specify an illegal filename
453 * a warning message is printed and FALSE is returned. In this case
454 * logging settings are not changed.
455 * You can disable logging for a channel by specifying NULL filename, the
456 * maxsize in this case is not important.
457 * The `scheduler' parameter is needed by the internal logging to allow
458 * buffered output and thus to save HD activity.
461 bool silc_log_set_file(SilcLogType type, char *filename, SilcUInt32 maxsize,
462 SilcSchedule scheduler);
464 /****f* silcutil/SilcLogAPI/silc_log_set_callback
468 * void silc_log_set_callback(SilcLogType type, SilcLogCb cb,
473 * Set `cb' as the default callback function for the logging channel
474 * `type'. When SilcLog receives a message for this channel, it will
475 * trigger the callback function. If the callback function returns TRUE
476 * SilcLog will assume the input as handled and won't run its default
478 * You can disable/remove a callback by setting it to NULL or calling the
479 * function silc_log_reset_callbacks.
480 * If set, the callback function must be in the form described by
484 * silc_log_reset_callbacks
487 void silc_log_set_callback(SilcLogType type, SilcLogCb cb, void *context);
489 /****f* silcutil/SilcLogAPI/silc_log_reset_callbacks
493 * void silc_log_reset_callbacks();
497 * Removes all logging callbacks for normal channels. This function does
498 * NOT remove callbacks for debugging channels (debug and hexdump), you
499 * rather need to call silc_log_set_debug_callbacks() with NULL callbacks.
502 void silc_log_reset_callbacks();
504 /****f* silcutil/SilcLogAPI/silc_log_flush_all
508 * void silc_log_flush_all();
512 * Forces flushing for all logging channels. This should be called for
513 * example after receiving special signals.
519 void silc_log_flush_all();
521 /****f* silcutil/SilcLogAPI/silc_log_reset_all
525 * void silc_log_reset_all();
529 * Forces all logging channels to close and reopen their streams. Useful
530 * for example after a SIGHUP signal.
531 * Please note that this function could generate some warning messages if
532 * one or more logging channels point to an illegal filename.
535 void silc_log_reset_all();
537 /****f* silcutil/SilcLogAPI/silc_log_output_debug
541 * void silc_log_output_debug(char *file, char *function,
542 * int line, char *string);
546 * This is the main function for debug output. Please note that you should
547 * rather use the wrapper macro SILC_LOG_DEBUG.
548 * If you want to use it anyway, the `file', `function', and `line' are the
549 * corresponding offsets in the source files, while `string' must be a
550 * dynamic allocated (null-terminated) buffer.
553 void silc_log_output_debug(char *file, char *function,
554 int line, char *string);
556 /****f* silcutil/SilcLogAPI/silc_log_output_hexdump
560 * void silc_log_output_hexdump(char *file, char *function,
561 * int line, void *data_in,
562 * SilcUInt32 len, char *string);
566 * This is the main function for hexdump output. Please note that you
567 * should rather use the wrapper macro SILC_LOG_HEXDUMP.
568 * If you want to use it anyway, the `file', `function', and `line' are the
569 * corresponding offsets in the source files, `data_in' is the beginning
570 * of the buffer you wish to hexdump, which is `len' bytes long.
571 * `string' must be a dynamic allocated (null-terminated) buffer.
574 void silc_log_output_hexdump(char *file, char *function,
575 int line, void *data_in,
576 SilcUInt32 len, char *string);
578 /****f* silcutil/SilcLogAPI/silc_log_set_debug_callbacks
582 * void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
583 * void *debug_context,
584 * SilcLogHexdumpCb hexdump_cb,
585 * void *hexdump_context);
589 * Sets `debug_cb' as the the default callback function for the debug
590 * output, that will be called with the `debug_context' parameter.
591 * When SilcLog receives a debug message, it will trigger the callback
592 * function. If the callback function returns TRUE SilcLog will assume
593 * the input as handled and won't run its default handler.
594 * `hexdump_cb' and `hexdump_context' works the same way, except that they
595 * are referred to SILC_LOG_HEXDUMP requests.
596 * You can disable/remove a callback by setting it to NULL.
597 * If set, each callback function must be either in the form described by
598 * SilcLogDebugCb or SilcLogHexdumpCb.
601 * SilcLogDebugCb, SilcLogHexdumpCb
604 void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
606 SilcLogHexdumpCb hexdump_cb,
607 void *hexdump_context);
609 /****f* silcutil/SilcLogAPI/silc_log_set_debug_string
613 * void silc_log_set_debug_string(const char *debug_string);
617 * Sets `debug_string' as the regexp string for filtering debugging
618 * output. The string is copied and it can be modified/destroyed after
619 * this function call.
622 void silc_log_set_debug_string(const char *debug_string);
624 #endif /* !SILCLOG_H */