debug: new debug class for kerberos
[kai/samba-autobuild/.git] / lib / util / debug.h
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB debug stuff
4    Copyright (C) Andrew Tridgell 1992-1998
5    Copyright (C) John H Terpstra 1996-1998
6    Copyright (C) Luke Kenneth Casson Leighton 1996-1998
7    Copyright (C) Paul Ashton 1998
8
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 3 of the License, or
12    (at your option) any later version.
13
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.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 */
22
23 #ifndef _SAMBA_DEBUG_H
24 #define _SAMBA_DEBUG_H
25
26 #include <stdbool.h>
27 #include <stddef.h>
28 #include <stdarg.h>
29 #include "attr.h"
30
31
32 /* -------------------------------------------------------------------------- **
33  * Debugging code.  See also debug.c
34  */
35
36 /* the maximum debug level to compile into the code. This assumes a good
37    optimising compiler that can remove unused code
38    for embedded or low-memory systems set this to a value like 2 to get
39    only important messages. This gives *much* smaller binaries
40 */
41 #ifndef MAX_DEBUG_LEVEL
42 #define MAX_DEBUG_LEVEL 1000
43 #endif
44
45 bool dbgtext_va(const char *, va_list ap) PRINTF_ATTRIBUTE(1,0);
46 bool dbgtext( const char *, ... ) PRINTF_ATTRIBUTE(1,2);
47 bool dbghdrclass( int level, int cls, const char *location, const char *func);
48 bool dbghdr( int level, const char *location, const char *func);
49
50 /*
51  * Redefine DEBUGLEVEL because so we don't have to change every source file
52  * that *unnecessarily* references it.
53  */
54 #define DEBUGLEVEL DEBUGLEVEL_CLASS[DBGC_ALL]
55
56 /*
57  * Define all new debug classes here. A class is represented by an entry in
58  * the DEBUGLEVEL_CLASS array. Index zero of this arrray is equivalent to the
59  * old DEBUGLEVEL. Any source file that does NOT add the following lines:
60  *
61  *   #undef  DBGC_CLASS
62  *   #define DBGC_CLASS DBGC_<your class name here>
63  *
64  * at the start of the file (after #include "includes.h") will default to
65  * using index zero, so it will behaive just like it always has.
66  */
67 #define DBGC_ALL                0 /* index equivalent to DEBUGLEVEL */
68
69 #define DBGC_TDB                1
70 #define DBGC_PRINTDRIVERS       2
71 #define DBGC_LANMAN             3
72 #define DBGC_SMB                4
73 #define DBGC_RPC_PARSE          5
74 #define DBGC_RPC_SRV            6
75 #define DBGC_RPC_CLI            7
76 #define DBGC_PASSDB             8
77 #define DBGC_SAM                9
78 #define DBGC_AUTH               10
79 #define DBGC_WINBIND            11
80 #define DBGC_VFS                12
81 #define DBGC_IDMAP              13
82 #define DBGC_QUOTA              14
83 #define DBGC_ACLS               15
84 #define DBGC_LOCKING            16
85 #define DBGC_MSDFS              17
86 #define DBGC_DMAPI              18
87 #define DBGC_REGISTRY           19
88 #define DBGC_SCAVENGER          20
89 #define DBGC_DNS                21
90 #define DBGC_LDB                22
91 #define DBGC_TEVENT             23
92 #define DBGC_AUTH_AUDIT         24
93 #define DBGC_AUTH_AUDIT_JSON    25
94 #define DBGC_KERBEROS           26
95
96 /* So you can define DBGC_CLASS before including debug.h */
97 #ifndef DBGC_CLASS
98 #define DBGC_CLASS            0     /* override as shown above */
99 #endif
100
101 extern int  *DEBUGLEVEL_CLASS;
102
103 /* Debugging macros
104  *
105  * DEBUGLVL()
106  *   If the 'file specific' debug class level >= level OR the system-wide
107  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
108  *   generate a header using the default macros for file, line, and
109  *   function name. Returns True if the debug level was <= DEBUGLEVEL.
110  *
111  *   Example: if( DEBUGLVL( 2 ) ) dbgtext( "Some text.\n" );
112  *
113  * DEBUG()
114  *   If the 'file specific' debug class level >= level OR the system-wide
115  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
116  *   generate a header using the default macros for file, line, and
117  *   function name. Each call to DEBUG() generates a new header *unless* the
118  *   previous debug output was unterminated (i.e. no '\n').
119  *   See debug.c:dbghdr() for more info.
120  *
121  *   Example: DEBUG( 2, ("Some text and a value %d.\n", value) );
122  *
123  * DEBUGC()
124  *   If the 'macro specified' debug class level >= level OR the system-wide
125  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
126  *   generate a header using the default macros for file, line, and
127  *   function name. Each call to DEBUG() generates a new header *unless* the
128  *   previous debug output was unterminated (i.e. no '\n').
129  *   See debug.c:dbghdr() for more info.
130  *
131  *   Example: DEBUGC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
132  *
133  *  DEBUGADD(), DEBUGADDC()
134  *    Same as DEBUG() and DEBUGC() except the text is appended to the previous
135  *    DEBUG(), DEBUGC(), DEBUGADD(), DEBUGADDC() with out another interviening
136  *    header.
137  *
138  *    Example: DEBUGADD( 2, ("Some text and a value %d.\n", value) );
139  *             DEBUGADDC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
140  *
141  * Note: If the debug class has not be redeined (see above) then the optimizer
142  * will remove the extra conditional test.
143  */
144
145 /*
146  * From talloc.c:
147  */
148
149 /* these macros gain us a few percent of speed on gcc */
150 #if (__GNUC__ >= 3)
151 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
152    as its first argument */
153 #ifndef likely
154 #define likely(x)   __builtin_expect(!!(x), 1)
155 #endif
156 #ifndef unlikely
157 #define unlikely(x) __builtin_expect(!!(x), 0)
158 #endif
159 #else
160 #ifndef likely
161 #define likely(x) (x)
162 #endif
163 #ifndef unlikely
164 #define unlikely(x) (x)
165 #endif
166 #endif
167
168 #define CHECK_DEBUGLVL( level ) \
169   ( ((level) <= MAX_DEBUG_LEVEL) && \
170     unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level)))
171
172 #define CHECK_DEBUGLVLC( dbgc_class, level ) \
173   ( ((level) <= MAX_DEBUG_LEVEL) && \
174     unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level)))
175
176 #define DEBUGLVL( level ) \
177   ( CHECK_DEBUGLVL(level) \
178    && dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ ) )
179
180 #define DEBUGLVLC( dbgc_class, level ) \
181   ( CHECK_DEBUGLVLC( dbgc_class, level ) \
182    && dbghdrclass( level, dbgc_class, __location__, __FUNCTION__ ) )
183
184 #define DEBUG( level, body ) \
185   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
186           unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))           \
187        && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
188        && (dbgtext body) )
189
190 #define DEBUGC( dbgc_class, level, body ) \
191   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
192           unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))           \
193        && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
194        && (dbgtext body) )
195
196 #define DEBUGADD( level, body ) \
197   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
198           unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))   \
199        && (dbgtext body) )
200
201 #define DEBUGADDC( dbgc_class, level, body ) \
202   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
203           unlikely((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))) \
204        && (dbgtext body) )
205
206 /* Print a separator to the debug log. */
207 #define DEBUGSEP(level)\
208         DEBUG((level),("===============================================================\n"))
209
210 /* Prefix messages with the function name */
211 #define DBG_PREFIX(level, body ) \
212         (void)( ((level) <= MAX_DEBUG_LEVEL) &&                 \
213                 unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))     \
214                 && (dbghdrclass(level, DBGC_CLASS, __location__, __func__ )) \
215                 && (dbgtext("%s: ", __func__))                          \
216                 && (dbgtext body) )
217
218 /*
219  * Debug levels matching RFC 3164
220  */
221 #define DBGLVL_ERR       0      /* error conditions */
222 #define DBGLVL_WARNING   1      /* warning conditions */
223 #define DBGLVL_NOTICE    3      /* normal, but significant, condition */
224 #define DBGLVL_INFO      5      /* informational message */
225 #define DBGLVL_DEBUG    10      /* debug-level message */
226
227 #define DBG_ERR(...)            DBG_PREFIX(DBGLVL_ERR,          (__VA_ARGS__))
228 #define DBG_WARNING(...)        DBG_PREFIX(DBGLVL_WARNING,      (__VA_ARGS__))
229 #define DBG_NOTICE(...)         DBG_PREFIX(DBGLVL_NOTICE,       (__VA_ARGS__))
230 #define DBG_INFO(...)           DBG_PREFIX(DBGLVL_INFO,         (__VA_ARGS__))
231 #define DBG_DEBUG(...)          DBG_PREFIX(DBGLVL_DEBUG,        (__VA_ARGS__))
232
233 #define D_ERR(...)              DEBUG(DBGLVL_ERR,       (__VA_ARGS__))
234 #define D_WARNING(...)          DEBUG(DBGLVL_WARNING,   (__VA_ARGS__))
235 #define D_NOTICE(...)           DEBUG(DBGLVL_NOTICE,    (__VA_ARGS__))
236 #define D_INFO(...)             DEBUG(DBGLVL_INFO,      (__VA_ARGS__))
237 #define D_DEBUG(...)            DEBUG(DBGLVL_DEBUG,     (__VA_ARGS__))
238
239 /* The following definitions come from lib/debug.c  */
240
241 /** Possible destinations for the debug log (in order of precedence -
242  * once set to DEBUG_FILE, it is not possible to reset to DEBUG_STDOUT
243  * for example.  This makes it easy to override for debug to stderr on
244  * the command line, as the smb.conf cannot reset it back to
245  * file-based logging */
246 enum debug_logtype {
247         DEBUG_DEFAULT_STDERR = 0,
248         DEBUG_DEFAULT_STDOUT = 1,
249         DEBUG_FILE = 2,
250         DEBUG_STDOUT = 3,
251         DEBUG_STDERR = 4,
252         DEBUG_CALLBACK = 5
253 };
254
255 struct debug_settings {
256         size_t max_log_size;
257         bool timestamp_logs;
258         bool debug_prefix_timestamp;
259         bool debug_hires_timestamp;
260         bool debug_pid;
261         bool debug_uid;
262         bool debug_class;
263 };
264
265 void setup_logging(const char *prog_name, enum debug_logtype new_logtype);
266
267 void gfree_debugsyms(void);
268 int debug_add_class(const char *classname);
269 bool debug_parse_levels(const char *params_str);
270 void debug_setup_talloc_log(void);
271 void debug_set_logfile(const char *name);
272 void debug_set_settings(struct debug_settings *settings,
273                         const char *logging_param,
274                         int syslog_level, bool syslog_only);
275 bool reopen_logs_internal( void );
276 void force_check_log_size( void );
277 bool need_to_check_log_size( void );
278 void check_log_size( void );
279 void dbgflush( void );
280 bool dbghdrclass(int level, int cls, const char *location, const char *func);
281 bool debug_get_output_is_stderr(void);
282 bool debug_get_output_is_stdout(void);
283 void debug_schedule_reopen_logs(void);
284 char *debug_list_class_names_and_levels(void);
285
286 typedef void (*debug_callback_fn)(void *private_ptr, int level, const char *msg);
287
288 /**
289    Set a callback for all debug messages.  Use in dlz_bind9 to push output to the bind logs
290  */
291 void debug_set_callback(void *private_ptr, debug_callback_fn fn);
292
293 char *debug_get_ringbuf(void);
294 size_t debug_get_ringbuf_size(void);
295
296 #endif /* _SAMBA_DEBUG_H */