bf8ce6acf2dbaf7fc19561380a046b9302228ea9
[asterisk/asterisk.git] / include / asterisk / logger.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20   \file logger.h
21   \brief Support for logging to various files, console and syslog
22         Configuration in file logger.conf
23 */
24
25 #ifndef _ASTERISK_LOGGER_H
26 #define _ASTERISK_LOGGER_H
27
28 #include "asterisk/options.h"   /* need option_debug */
29
30 #if defined(__cplusplus) || defined(c_plusplus)
31 extern "C" {
32 #endif
33
34 #define EVENTLOG "event_log"
35 #define QUEUELOG        "queue_log"
36
37 #define DEBUG_M(a) { \
38         a; \
39 }
40
41 #define VERBOSE_PREFIX_1 " "
42 #define VERBOSE_PREFIX_2 "  == "
43 #define VERBOSE_PREFIX_3 "    -- "
44 #define VERBOSE_PREFIX_4 "       > "
45
46 #define AST_CALLID_BUFFER_LENGTH 13
47
48 enum ast_logger_results {
49         AST_LOGGER_SUCCESS = 0, /*!< Log channel was created or deleted successfully*/
50         AST_LOGGER_FAILURE = 1, /*!< Log channel already exists for create or doesn't exist for deletion of log channel */
51         AST_LOGGER_DECLINE = -1, /*!< Log channel request was not accepted */
52         AST_LOGGER_ALLOC_ERROR = -2 /*!< filename allocation error */
53 };
54
55 /*! \brief Used for sending a log message
56         This is the standard logger function.  Probably the only way you will invoke it would be something like this:
57         ast_log(AST_LOG_WHATEVER, "Problem with the %s Captain.  We should get some more.  Will %d be enough?\n", "flux capacitor", 10);
58         where WHATEVER is one of ERROR, DEBUG, EVENT, NOTICE, or WARNING depending
59         on which log you wish to output to. These are implemented as macros, that
60         will provide the function with the needed arguments.
61
62         \param level    Type of log event
63         \param file     Will be provided by the AST_LOG_* macro
64         \param line     Will be provided by the AST_LOG_* macro
65         \param function Will be provided by the AST_LOG_* macro
66         \param fmt      This is what is important.  The format is the same as your favorite breed of printf.  You know how that works, right? :-)
67  */
68
69 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
70         __attribute__((format(printf, 5, 6)));
71
72 /*!
73  * \brief Used for sending a log message with protection against recursion.
74  *
75  * \note This function should be used by all error messages that might be directly
76  * or indirectly caused by logging.
77  *
78  * \see ast_log for documentation on the parameters.
79  */
80 void ast_log_safe(int level, const char *file, int line, const char *function, const char *fmt, ...)
81         __attribute__((format(printf, 5, 6)));
82
83 /* XXX needs documentation */
84 typedef unsigned int ast_callid;
85
86 /*! \brief Used for sending a log message with a known call_id
87         This is a modified logger function which is functionally identical to the above logger function,
88         it just include a call_id argument as well. If NULL is specified here, no attempt will be made to
89         join the log message with a call_id.
90
91         \param level    Type of log event
92         \param file     Will be provided by the AST_LOG_* macro
93         \param line     Will be provided by the AST_LOG_* macro
94         \param function Will be provided by the AST_LOG_* macro
95         \param callid   This is the ast_callid that is associated with the log message. May be NULL.
96         \param fmt      This is what is important.  The format is the same as your favorite breed of printf.  You know how that works, right? :-)
97 */
98 void ast_log_callid(int level, const char *file, int line, const char *function, ast_callid callid, const char *fmt, ...)
99         __attribute__((format(printf, 6, 7)));
100
101 /*!
102  * \brief Retrieve the existing log channels
103  * \param logentry A callback to an updater function
104  * \param data Data passed into the callback for manipulation
105  *
106  * For each of the logging channels, logentry will be executed with the
107  * channel file name, log type, status of the log, and configuration levels.
108  *
109  * \retval 0 on success
110  * \retval 1 on failure
111  * \retval -2 on allocation error
112  */
113 int ast_logger_get_channels(int (*logentry)(const char *channel, const char *type,
114         const char *status, const char *configuration, void *data), void *data);
115
116 /*!
117  * \brief Create a log channel
118  *
119  * \param log_channel Log channel to create
120  * \param components Logging config levels to add to the log channel
121  */
122 int ast_logger_create_channel(const char *log_channel, const char *components);
123
124 /*!
125  * \brief Delete the specified log channel
126  *
127  * \param log_channel The log channel to delete
128  */
129 int ast_logger_remove_channel(const char *log_channel);
130
131 /*!
132  * \brief Log a backtrace of the current thread's execution stack to the Asterisk log
133  */
134 void ast_log_backtrace(void);
135
136 /*! \brief Reload logger without rotating log files */
137 int logger_reload(void);
138
139 /*! \brief Reload logger while rotating log files */
140 int ast_logger_rotate(void);
141
142 /*!
143  * \brief Rotate the specified log channel.
144  *
145  * \param log_channel The log channel to rotate
146  */
147 int ast_logger_rotate_channel(const char *log_channel);
148
149 void __attribute__((format(printf, 5, 6))) ast_queue_log(const char *queuename, const char *callid, const char *agent, const char *event, const char *fmt, ...);
150
151 /*!
152  * \brief Send a verbose message (based on verbose level)
153  *
154  * \details This works like ast_log, but prints verbose messages to the console depending on verbosity level set.
155  *
156  * ast_verbose(VERBOSE_PREFIX_3 "Whatever %s is happening\n", "nothing");
157  *
158  * This will print the message to the console if the verbose level is set to a level >= 3
159  *
160  * Note the absence of a comma after the VERBOSE_PREFIX_3.  This is important.
161  * VERBOSE_PREFIX_1 through VERBOSE_PREFIX_4 are defined.
162  *
163  * \version 11 added level parameter
164  */
165 void __attribute__((format(printf, 5, 6))) __ast_verbose(const char *file, int line, const char *func, int level, const char *fmt, ...);
166
167 /*!
168  * \brief Send a verbose message (based on verbose level) with deliberately specified callid
169  *
170  * \details just like __ast_verbose, only __ast_verbose_callid allows you to specify which callid is being used
171  * for the log without needing to bind it to a thread. NULL is a valid argument for this function and will
172  * allow you to specify that a log will never display a call id even when there is a call id bound to the
173  * thread.
174  */
175 void __attribute__((format(printf, 6, 7))) __ast_verbose_callid(const char *file, int line, const char *func, int level, ast_callid callid, const char *fmt, ...);
176
177 #define ast_verbose(...) __ast_verbose(__FILE__, __LINE__, __PRETTY_FUNCTION__, -1, __VA_ARGS__)
178 #define ast_verbose_callid(callid, ...) __ast_verbose_callid(__FILE__, __LINE__, __PRETTY_FUNCTION__, -1, callid, __VA_ARGS__)
179
180 void __attribute__((format(printf, 6, 0))) __ast_verbose_ap(const char *file, int line, const char *func, int level, ast_callid callid, const char *fmt, va_list ap);
181
182 void __attribute__((format(printf, 2, 3))) ast_child_verbose(int level, const char *fmt, ...);
183
184 int ast_register_verbose(void (*verboser)(const char *string)) attribute_warn_unused_result;
185 int ast_unregister_verbose(void (*verboser)(const char *string)) attribute_warn_unused_result;
186
187 /*
188  * These gymnastics are due to platforms which designate char as unsigned by
189  * default.  Level is the negative character -- offset by 1, because \0 is
190  * the string terminator.
191  */
192 #define VERBOSE_MAGIC2LEVEL(x) (((char) -*(signed char *) (x)) - 1)
193 #define VERBOSE_HASMAGIC(x)     (*(signed char *) (x) < 0)
194
195 void ast_console_puts(const char *string);
196
197 /*!
198  * \brief log the string to the console, and all attached
199  * console clients
200  * \version 1.6.1 added level parameter
201  */
202 void ast_console_puts_mutable(const char *string, int level);
203 void ast_console_toggle_mute(int fd, int silent);
204
205 /*!
206  * \brief enables or disables logging of a specified level to the console
207  * fd specifies the index of the console receiving the level change
208  * level specifies the index of the logging level being toggled
209  * state indicates whether logging will be on or off (0 for off, 1 for on)
210  */
211 void ast_console_toggle_loglevel(int fd, int level, int state);
212
213 /* Note: The AST_LOG_* macros below are the same as
214  * the LOG_* macros and are intended to eventually replace
215  * the LOG_* macros to avoid name collisions with the syslog(3)
216  * log levels. However, please do NOT remove
217  * the LOG_* macros from the source since these may be still
218  * needed for third-party modules
219  */
220
221 #define _A_ __FILE__, __LINE__, __PRETTY_FUNCTION__
222
223 #ifdef LOG_DEBUG
224 #undef LOG_DEBUG
225 #endif
226 #define __LOG_DEBUG    0
227 #define LOG_DEBUG      __LOG_DEBUG, _A_
228
229 #ifdef AST_LOG_DEBUG
230 #undef AST_LOG_DEBUG
231 #endif
232 #define AST_LOG_DEBUG      __LOG_DEBUG, _A_
233
234 #ifdef LOG_NOTICE
235 #undef LOG_NOTICE
236 #endif
237 #define __LOG_NOTICE   2
238 #define LOG_NOTICE     __LOG_NOTICE, _A_
239
240 #ifdef AST_LOG_NOTICE
241 #undef AST_LOG_NOTICE
242 #endif
243 #define AST_LOG_NOTICE     __LOG_NOTICE, _A_
244
245 #ifdef LOG_WARNING
246 #undef LOG_WARNING
247 #endif
248 #define __LOG_WARNING  3
249 #define LOG_WARNING    __LOG_WARNING, _A_
250
251 #ifdef AST_LOG_WARNING
252 #undef AST_LOG_WARNING
253 #endif
254 #define AST_LOG_WARNING    __LOG_WARNING, _A_
255
256 #ifdef LOG_ERROR
257 #undef LOG_ERROR
258 #endif
259 #define __LOG_ERROR    4
260 #define LOG_ERROR      __LOG_ERROR, _A_
261
262 #ifdef AST_LOG_ERROR
263 #undef AST_LOG_ERROR
264 #endif
265 #define AST_LOG_ERROR      __LOG_ERROR, _A_
266
267 #ifdef LOG_VERBOSE
268 #undef LOG_VERBOSE
269 #endif
270 #define __LOG_VERBOSE  5
271 #define LOG_VERBOSE    __LOG_VERBOSE, _A_
272
273 #ifdef AST_LOG_VERBOSE
274 #undef AST_LOG_VERBOSE
275 #endif
276 #define AST_LOG_VERBOSE    __LOG_VERBOSE, _A_
277
278 #ifdef LOG_DTMF
279 #undef LOG_DTMF
280 #endif
281 #define __LOG_DTMF  6
282 #define LOG_DTMF    __LOG_DTMF, _A_
283
284 #ifdef AST_LOG_DTMF
285 #undef AST_LOG_DTMF
286 #endif
287 #define AST_LOG_DTMF    __LOG_DTMF, _A_
288
289 #define NUMLOGLEVELS 32
290
291 /*!
292  * \brief Get the debug level for a module
293  * \param module the name of module
294  * \return the debug level
295  */
296 unsigned int ast_debug_get_by_module(const char *module);
297
298 /*!
299  * \brief Get the verbose level for a module
300  * \param module the name of module
301  * \return the verbose level
302  * \version 11.0.0 deprecated
303  */
304 unsigned int ast_verbose_get_by_module(const char *module) __attribute__((deprecated));
305
306 /*!
307  * \brief Register a new logger level
308  * \param name The name of the level to be registered
309  * \retval -1 if an error occurs
310  * \retval non-zero level to be used with ast_log for sending messages to this level
311  * \since 1.8
312  */
313 int ast_logger_register_level(const char *name);
314
315 /*!
316  * \brief Unregister a previously registered logger level
317  * \param name The name of the level to be unregistered
318  * \return nothing
319  * \since 1.8
320  */
321 void ast_logger_unregister_level(const char *name);
322
323 /*!
324  * \brief Get the logger configured date format
325  *
326  * \retval The date format string
327  *
328  * \since 13.0.0
329  */
330 const char *ast_logger_get_dateformat(void);
331
332 /*!
333  * \brief factory function to create a new uniquely identifying callid.
334  *
335  * \retval The call id
336  */
337 ast_callid ast_create_callid(void);
338
339 /*!
340  * \brief extracts the callerid from the thread
341  *
342  * \retval Non-zero Call id related to the thread
343  * \retval 0 if no call_id is present in the thread
344  */
345 ast_callid ast_read_threadstorage_callid(void);
346
347 /*!
348  * \brief Sets what is stored in the thread storage to the given
349  *        callid if it does not match what is already there.
350  *
351  * \retval 0 - success
352  * \retval non-zero - failure
353  */
354 int ast_callid_threadassoc_change(ast_callid callid);
355
356 /*!
357  * \brief Adds a known callid to thread storage of the calling thread
358  *
359  * \retval 0 - success
360  * \retval non-zero - failure
361  */
362 int ast_callid_threadassoc_add(ast_callid callid);
363
364 /*!
365  * \brief Removes callid from thread storage of the calling thread
366  *
367  * \retval 0 - success
368  * \retval non-zero - failure
369  */
370 int ast_callid_threadassoc_remove(void);
371
372 /*!
373  * \brief Checks thread storage for a callid and stores a reference if it exists.
374  *        If not, then a new one will be created, bound to the thread, and a reference
375  *        to it will be stored.
376  *
377  * \param callid pointer to store the callid
378  * \retval 0 - callid was found
379  * \retval 1 - callid was created
380  * \retval -1 - the function failed somehow (presumably memory problems)
381  */
382 int ast_callid_threadstorage_auto(ast_callid *callid);
383
384 /*!
385  * \brief Use in conjunction with ast_callid_threadstorage_auto. Cleans up the
386  *        references and if the callid was created by threadstorage_auto, unbinds
387  *        the callid from the threadstorage
388  * \param callid The callid set by ast_callid_threadstorage_auto
389  * \param callid_created The integer returned through ast_callid_threadstorage_auto
390  */
391 void ast_callid_threadstorage_auto_clean(ast_callid callid, int callid_created);
392
393 /*!
394  * \brief copy a string representation of the callid into a target string
395  *
396  * \param buffer destination of callid string (should be able to store 13 characters or more)
397  * \param buffer_size maximum writable length of the string (Less than 13 will result in truncation)
398  * \param callid Callid for which string is being requested
399  */
400 void ast_callid_strnprint(char *buffer, size_t buffer_size, ast_callid callid);
401
402 /*!
403  * \brief Send a log message to a dynamically registered log level
404  * \param level The log level to send the message to
405  *
406  * Like ast_log, the log message may include printf-style formats, and
407  * the data for these must be provided as additional parameters after
408  * the log message.
409  *
410  * \return nothing
411  * \since 1.8
412  */
413
414 #define ast_log_dynamic_level(level, ...) ast_log(level, __FILE__, __LINE__, __PRETTY_FUNCTION__, __VA_ARGS__)
415
416 #define DEBUG_ATLEAST(level) \
417         (option_debug >= (level) \
418                 || (ast_opt_dbg_module && (int)ast_debug_get_by_module(AST_MODULE) >= (level)))
419
420 /*!
421  * \brief Log a DEBUG message
422  * \param level The minimum value of option_debug for this message
423  *        to get logged
424  */
425 #define ast_debug(level, ...) \
426         do { \
427                 if (DEBUG_ATLEAST(level)) { \
428                         ast_log(AST_LOG_DEBUG, __VA_ARGS__); \
429                 } \
430         } while (0)
431
432 extern int ast_verb_sys_level;
433
434 #define VERBOSITY_ATLEAST(level) ((level) <= ast_verb_sys_level)
435
436 #define ast_verb(level, ...) \
437         do { \
438                 if (VERBOSITY_ATLEAST(level) ) { \
439                         __ast_verbose(__FILE__, __LINE__, __PRETTY_FUNCTION__, level, __VA_ARGS__); \
440                 } \
441         } while (0)
442
443 #define ast_verb_callid(level, callid, ...) \
444         do { \
445                 if (VERBOSITY_ATLEAST(level) ) { \
446                         __ast_verbose_callid(__FILE__, __LINE__, __PRETTY_FUNCTION__, level, callid, __VA_ARGS__); \
447                 } \
448         } while (0)
449
450 /*!
451  * \brief Re-evaluate the system max verbosity level (ast_verb_sys_level).
452  *
453  * \return Nothing
454  */
455 void ast_verb_update(void);
456
457 /*!
458  * \brief Register this thread's console verbosity level pointer.
459  *
460  * \param level Where the verbose level value is.
461  *
462  * \return Nothing
463  */
464 void ast_verb_console_register(int *level);
465
466 /*!
467  * \brief Unregister this thread's console verbosity level.
468  *
469  * \return Nothing
470  */
471 void ast_verb_console_unregister(void);
472
473 /*!
474  * \brief Get this thread's console verbosity level.
475  *
476  * \retval verbosity level of the console.
477  */
478 int ast_verb_console_get(void);
479
480 /*!
481  * \brief Set this thread's console verbosity level.
482  *
483  * \param verb_level New level to set.
484  *
485  * \return Nothing
486  */
487 void ast_verb_console_set(int verb_level);
488
489 #if defined(__cplusplus) || defined(c_plusplus)
490 }
491 #endif
492
493 #endif /* _ASTERISK_LOGGER_H */