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