3d2c66b5e5621be4624538403883025cf39f23da
[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/compat.h"
29
30 #include <stdarg.h>
31
32 #if defined(__cplusplus) || defined(c_plusplus)
33 extern "C" {
34 #endif
35
36 #define EVENTLOG "event_log"
37 #define QUEUELOG        "queue_log"
38
39 #define DEBUG_M(a) { \
40         a; \
41 }
42
43 #define VERBOSE_PREFIX_1 " "
44 #define VERBOSE_PREFIX_2 "  == "
45 #define VERBOSE_PREFIX_3 "    -- "
46 #define VERBOSE_PREFIX_4 "       > "
47
48 /*! Used for sending a log message */
49 /*!
50         \brief This is the standard logger function.  Probably the only way you will invoke it would be something like this:
51         ast_log(LOG_WHATEVER, "Problem with the %s Captain.  We should get some more.  Will %d be enough?\n", "flux capacitor", 10);
52         where WHATEVER is one of ERROR, DEBUG, EVENT, NOTICE, or WARNING depending
53         on which log you wish to output to. These are implemented as macros, that
54         will provide the function with the needed arguments.
55
56         \param level    Type of log event
57         \param file     Will be provided by the LOG_* macro
58         \param line     Will be provided by the LOG_* macro
59         \param function Will be provided by the LOG_* macro
60         \param fmt      This is what is important.  The format is the same as your favorite breed of printf.  You know how that works, right? :-)
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 void ast_backtrace(void);
66
67 void ast_queue_log(const char *queuename, const char *callid, const char *agent, const char *event, const char *fmt, ...)
68         __attribute__ ((format (printf, 5, 6)));
69
70 /*! Send a verbose message (based on verbose level)
71         \brief This works like ast_log, but prints verbose messages to the console depending on verbosity level set.
72         ast_verbose(VERBOSE_PREFIX_3 "Whatever %s is happening\n", "nothing");
73         This will print the message to the console if the verbose level is set to a level >= 3
74         Note the abscence of a comma after the VERBOSE_PREFIX_3.  This is important.
75         VERBOSE_PREFIX_1 through VERBOSE_PREFIX_3 are defined.
76  */
77 void ast_verbose(const char *fmt, ...)
78         __attribute__ ((format (printf, 1, 2)));
79
80 int ast_register_verbose(void (*verboser)(const char *string));
81 int ast_unregister_verbose(void (*verboser)(const char *string));
82
83 void ast_console_puts(const char *string);
84
85 void ast_console_puts_mutable(const char *string);
86 void ast_console_toggle_mute(int fd);
87
88 #define _A_ __FILE__, __LINE__, __PRETTY_FUNCTION__
89
90 #ifdef LOG_DEBUG
91 #undef LOG_DEBUG
92 #endif
93 #define __LOG_DEBUG    0
94 #define LOG_DEBUG      __LOG_DEBUG, _A_
95
96 #ifdef LOG_EVENT
97 #undef LOG_EVENT
98 #endif
99 #define __LOG_EVENT    1
100 #define LOG_EVENT      __LOG_EVENT, _A_
101
102 #ifdef LOG_NOTICE
103 #undef LOG_NOTICE
104 #endif
105 #define __LOG_NOTICE   2
106 #define LOG_NOTICE     __LOG_NOTICE, _A_
107
108 #ifdef LOG_WARNING
109 #undef LOG_WARNING
110 #endif
111 #define __LOG_WARNING  3
112 #define LOG_WARNING    __LOG_WARNING, _A_
113
114 #ifdef LOG_ERROR
115 #undef LOG_ERROR
116 #endif
117 #define __LOG_ERROR    4
118 #define LOG_ERROR      __LOG_ERROR, _A_
119
120 #ifdef LOG_VERBOSE
121 #undef LOG_VERBOSE
122 #endif
123 #define __LOG_VERBOSE  5
124 #define LOG_VERBOSE    __LOG_VERBOSE, _A_
125
126 #ifdef LOG_DTMF
127 #undef LOG_DTMF
128 #endif
129 #define __LOG_DTMF  6
130 #define LOG_DTMF    __LOG_DTMF, _A_
131
132 /*!
133  * \brief Log a DEBUG message
134  * \param level The minimum value of option_debug for this message
135  *        to get logged
136  */
137 #define ast_debug(level, ...) do {       \
138         if (option_debug >= (level)) {       \
139                 ast_log(LOG_DEBUG, __VA_ARGS__); \
140         }                                    \
141 } while (0)
142
143 #if defined(__cplusplus) || defined(c_plusplus)
144 }
145 #endif
146
147 #endif /* _ASTERISK_LOGGER_H */