2 Unix SMB/CIFS implementation.
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
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.
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.
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/>.
23 #ifndef _SAMBA_DEBUG_H
24 #define _SAMBA_DEBUG_H
32 /* -------------------------------------------------------------------------- **
33 * Debugging code. See also debug.c
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
41 #ifndef MAX_DEBUG_LEVEL
42 #define MAX_DEBUG_LEVEL 1000
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
);
51 * Redefine DEBUGLEVEL because so we don't have to change every source file
52 * that *unnecessarily* references it.
54 #define DEBUGLEVEL DEBUGLEVEL_CLASS[DBGC_ALL]
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:
62 * #define DBGC_CLASS DBGC_<your class name here>
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.
67 #define DBGC_ALL 0 /* index equivalent to DEBUGLEVEL */
70 #define DBGC_PRINTDRIVERS 2
73 #define DBGC_RPC_PARSE 5
74 #define DBGC_RPC_SRV 6
75 #define DBGC_RPC_CLI 7
79 #define DBGC_WINBIND 11
84 #define DBGC_LOCKING 16
87 #define DBGC_REGISTRY 19
88 #define DBGC_SCAVENGER 20
92 /* Always ensure this is updated when new fixed classes area added, to ensure the array in debug.c is the right size */
93 #define DBGC_MAX_FIXED 22
95 /* So you can define DBGC_CLASS before including debug.h */
97 #define DBGC_CLASS 0 /* override as shown above */
100 extern int *DEBUGLEVEL_CLASS
;
105 * If the 'file specific' debug class level >= level OR the system-wide
106 * DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
107 * generate a header using the default macros for file, line, and
108 * function name. Returns True if the debug level was <= DEBUGLEVEL.
110 * Example: if( DEBUGLVL( 2 ) ) dbgtext( "Some text.\n" );
113 * If the 'file specific' debug class level >= level OR the system-wide
114 * DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
115 * generate a header using the default macros for file, line, and
116 * function name. Each call to DEBUG() generates a new header *unless* the
117 * previous debug output was unterminated (i.e. no '\n').
118 * See debug.c:dbghdr() for more info.
120 * Example: DEBUG( 2, ("Some text and a value %d.\n", value) );
123 * If the 'macro specified' debug class level >= level OR the system-wide
124 * DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
125 * generate a header using the default macros for file, line, and
126 * function name. Each call to DEBUG() generates a new header *unless* the
127 * previous debug output was unterminated (i.e. no '\n').
128 * See debug.c:dbghdr() for more info.
130 * Example: DEBUGC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
132 * DEBUGADD(), DEBUGADDC()
133 * Same as DEBUG() and DEBUGC() except the text is appended to the previous
134 * DEBUG(), DEBUGC(), DEBUGADD(), DEBUGADDC() with out another interviening
137 * Example: DEBUGADD( 2, ("Some text and a value %d.\n", value) );
138 * DEBUGADDC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
140 * Note: If the debug class has not be redeined (see above) then the optimizer
141 * will remove the extra conditional test.
148 /* these macros gain us a few percent of speed on gcc */
150 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
151 as its first argument */
153 #define likely(x) __builtin_expect(!!(x), 1)
156 #define unlikely(x) __builtin_expect(!!(x), 0)
160 #define likely(x) (x)
163 #define unlikely(x) (x)
167 #define CHECK_DEBUGLVL( level ) \
168 ( ((level) <= MAX_DEBUG_LEVEL) && \
169 unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level)))
171 #define CHECK_DEBUGLVLC( dbgc_class, level ) \
172 ( ((level) <= MAX_DEBUG_LEVEL) && \
173 unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level)))
175 #define DEBUGLVL( level ) \
176 ( CHECK_DEBUGLVL(level) \
177 && dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ ) )
179 #define DEBUGLVLC( dbgc_class, level ) \
180 ( CHECK_DEBUGLVLC( dbgc_class, level ) \
181 && dbghdrclass( level, dbgc_class, __location__, __FUNCTION__ ) )
183 #define DEBUG( level, body ) \
184 (void)( ((level) <= MAX_DEBUG_LEVEL) && \
185 unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level)) \
186 && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
189 #define DEBUGC( dbgc_class, level, body ) \
190 (void)( ((level) <= MAX_DEBUG_LEVEL) && \
191 unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level)) \
192 && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
195 #define DEBUGADD( level, body ) \
196 (void)( ((level) <= MAX_DEBUG_LEVEL) && \
197 unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level)) \
200 #define DEBUGADDC( dbgc_class, level, body ) \
201 (void)( ((level) <= MAX_DEBUG_LEVEL) && \
202 unlikely((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))) \
205 /* Print a separator to the debug log. */
206 #define DEBUGSEP(level)\
207 DEBUG((level),("===============================================================\n"))
209 /* The following definitions come from lib/debug.c */
211 /** Possible destinations for the debug log (in order of precedence -
212 * once set to DEBUG_FILE, it is not possible to reset to DEBUG_STDOUT
213 * for example. This makes it easy to override for debug to stderr on
214 * the command line, as the smb.conf cannot reset it back to
215 * file-based logging */
217 DEBUG_DEFAULT_STDERR
= 0,
218 DEBUG_DEFAULT_STDOUT
= 1,
225 struct debug_settings
{
228 bool debug_prefix_timestamp
;
229 bool debug_hires_timestamp
;
235 void setup_logging(const char *prog_name
, enum debug_logtype new_logtype
);
237 void gfree_debugsyms(void);
238 int debug_add_class(const char *classname
);
239 bool debug_parse_levels(const char *params_str
);
240 void debug_setup_talloc_log(void);
241 void debug_set_logfile(const char *name
);
242 void debug_set_settings(struct debug_settings
*settings
,
243 const char *logging_param
,
244 int syslog_level
, bool syslog_only
);
245 bool reopen_logs_internal( void );
246 void force_check_log_size( void );
247 bool need_to_check_log_size( void );
248 void check_log_size( void );
249 void dbgflush( void );
250 bool dbghdrclass(int level
, int cls
, const char *location
, const char *func
);
251 bool debug_get_output_is_stderr(void);
252 bool debug_get_output_is_stdout(void);
253 void debug_schedule_reopen_logs(void);
254 char *debug_list_class_names_and_levels(void);
256 typedef void (*debug_callback_fn
)(void *private_ptr
, int level
, const char *msg
);
259 Set a callback for all debug messages. Use in dlz_bind9 to push output to the bind logs
261 void debug_set_callback(void *private_ptr
, debug_callback_fn fn
);
263 #endif /* _SAMBA_DEBUG_H */