r23784: use the GPLv3 boilerplate as recommended by the FSF and the license text
[tprouty/samba.git] / source / include / 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 _DEBUG_H
24 #define _DEBUG_H
25
26 /* -------------------------------------------------------------------------- **
27  * Debugging code.  See also debug.c
28  */
29
30 /* mkproto.awk has trouble with ifdef'd function definitions (it ignores
31  * the #ifdef directive and will read both definitions, thus creating two
32  * diffferent prototype declarations), so we must do these by hand.
33  */
34 /* I know the __attribute__ stuff is ugly, but it does ensure we get the 
35    arguments to DEBUG() right. We have got them wrong too often in the 
36    past.
37    The PRINTFLIKE comment does the equivalent for SGI MIPSPro.
38  */
39 /* PRINTFLIKE1 */
40 int  Debug1( const char *, ... ) PRINTF_ATTRIBUTE(1,2);
41 /* PRINTFLIKE1 */
42 BOOL dbgtext( const char *, ... ) PRINTF_ATTRIBUTE(1,2);
43 BOOL dbghdr( int level, const char *file, const char *func, int line );
44
45 #if defined(sgi) && (_COMPILER_VERSION >= 730)
46 #pragma mips_frequency_hint NEVER Debug1
47 #pragma mips_frequency_hint NEVER dbgtext
48 #pragma mips_frequency_hint NEVER dbghdr
49 #endif
50
51 extern XFILE *dbf;
52 extern pstring debugf;
53
54 /* If we have these macros, we can add additional info to the header. */
55
56 #ifdef HAVE_FUNCTION_MACRO
57 #define FUNCTION_MACRO  (__FUNCTION__)
58 #else
59 #define FUNCTION_MACRO  ("")
60 #endif
61
62 /* 
63  * Redefine DEBUGLEVEL because so we don't have to change every source file
64  * that *unnecessarily* references it. Source files neeed not extern reference 
65  * DEBUGLEVEL, as it's extern in includes.h (which all source files include).
66  * Eventually, all these references should be removed, and all references to
67  * DEBUGLEVEL should be references to DEBUGLEVEL_CLASS[DBGC_ALL]. This could
68  * still be through a macro still called DEBUGLEVEL. This cannot be done now
69  * because some references would expand incorrectly.
70  */
71 #define DEBUGLEVEL *debug_level
72 extern int DEBUGLEVEL;
73
74 /*
75  * Define all new debug classes here. A class is represented by an entry in
76  * the DEBUGLEVEL_CLASS array. Index zero of this arrray is equivalent to the
77  * old DEBUGLEVEL. Any source file that does NOT add the following lines:
78  *
79  *   #undef  DBGC_CLASS
80  *   #define DBGC_CLASS DBGC_<your class name here>
81  *
82  * at the start of the file (after #include "includes.h") will default to
83  * using index zero, so it will behaive just like it always has. 
84  */
85 #define DBGC_ALL                0 /* index equivalent to DEBUGLEVEL */
86
87 #define DBGC_TDB                1
88 #define DBGC_PRINTDRIVERS       2
89 #define DBGC_LANMAN             3
90 #define DBGC_SMB                4
91 #define DBGC_RPC_PARSE          5
92 #define DBGC_RPC_SRV            6
93 #define DBGC_RPC_CLI            7
94 #define DBGC_PASSDB             8
95 #define DBGC_SAM                9
96 #define DBGC_AUTH               10
97 #define DBGC_WINBIND            11
98 #define DBGC_VFS                12
99 #define DBGC_IDMAP              13
100 #define DBGC_QUOTA              14
101 #define DBGC_ACLS               15
102 #define DBGC_LOCKING            16
103 #define DBGC_MSDFS              17
104 #define DBGC_DMAPI              18
105
106 /* So you can define DBGC_CLASS before including debug.h */
107 #ifndef DBGC_CLASS
108 #define DBGC_CLASS            0     /* override as shown above */
109 #endif
110
111 extern int  *DEBUGLEVEL_CLASS;
112 extern BOOL *DEBUGLEVEL_CLASS_ISSET;
113
114 /* Debugging macros
115  *
116  * DEBUGLVL()
117  *   If the 'file specific' debug class level >= level OR the system-wide 
118  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
119  *   generate a header using the default macros for file, line, and 
120  *   function name. Returns True if the debug level was <= DEBUGLEVEL.
121  * 
122  *   Example: if( DEBUGLVL( 2 ) ) dbgtext( "Some text.\n" );
123  *
124  * DEBUGLVLC()
125  *   If the 'macro specified' debug class level >= level OR the system-wide 
126  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then 
127  *   generate a header using the default macros for file, line, and 
128  *   function name. Returns True if the debug level was <= DEBUGLEVEL.
129  * 
130  *   Example: if( DEBUGLVLC( DBGC_TDB, 2 ) ) dbgtext( "Some text.\n" );
131  *
132  * DEBUG()
133  *   If the 'file specific' debug class level >= level OR the system-wide 
134  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then 
135  *   generate a header using the default macros for file, line, and 
136  *   function name. Each call to DEBUG() generates a new header *unless* the 
137  *   previous debug output was unterminated (i.e. no '\n').
138  *   See debug.c:dbghdr() for more info.
139  *
140  *   Example: DEBUG( 2, ("Some text and a value %d.\n", value) );
141  *
142  * DEBUGC()
143  *   If the 'macro specified' debug class level >= level OR the system-wide 
144  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then 
145  *   generate a header using the default macros for file, line, and 
146  *   function name. Each call to DEBUG() generates a new header *unless* the 
147  *   previous debug output was unterminated (i.e. no '\n').
148  *   See debug.c:dbghdr() for more info.
149  *
150  *   Example: DEBUGC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
151  *
152  *  DEBUGADD(), DEBUGADDC()
153  *    Same as DEBUG() and DEBUGC() except the text is appended to the previous
154  *    DEBUG(), DEBUGC(), DEBUGADD(), DEBUGADDC() with out another interviening 
155  *    header.
156  *
157  *    Example: DEBUGADD( 2, ("Some text and a value %d.\n", value) );
158  *             DEBUGADDC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
159  *
160  * Note: If the debug class has not be redeined (see above) then the optimizer 
161  * will remove the extra conditional test.
162  */
163
164 #define DEBUGLVL( level ) \
165   ( ((level) <= MAX_DEBUG_LEVEL) && \
166      ((DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))||  \
167      (!DEBUGLEVEL_CLASS_ISSET[ DBGC_CLASS ] && \
168       DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
169    && dbghdr( level, __FILE__, FUNCTION_MACRO, (__LINE__) ) )
170
171
172 #define DEBUGLVLC( dbgc_class, level ) \
173   ( ((level) <= MAX_DEBUG_LEVEL) && \
174      ((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))||  \
175      (!DEBUGLEVEL_CLASS_ISSET[ dbgc_class ] && \
176       DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
177    && dbghdr( level, __FILE__, FUNCTION_MACRO, (__LINE__) ) )
178
179
180 #define DEBUG( level, body ) \
181   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
182            ((DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))||  \
183            (!DEBUGLEVEL_CLASS_ISSET[ DBGC_CLASS ] && \
184             DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
185        && (dbghdr( level, __FILE__, FUNCTION_MACRO, (__LINE__) )) \
186        && (dbgtext body) )
187
188 #define DEBUGC( dbgc_class, level, body ) \
189   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
190            ((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))||  \
191            (!DEBUGLEVEL_CLASS_ISSET[ dbgc_class ] && \
192             DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
193        && (dbghdr( level, __FILE__, FUNCTION_MACRO, (__LINE__) )) \
194        && (dbgtext body) )
195
196 #define DEBUGADD( level, body ) \
197   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
198            ((DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))||  \
199            (!DEBUGLEVEL_CLASS_ISSET[ DBGC_CLASS ] && \
200             DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
201        && (dbgtext body) )
202
203 #define DEBUGADDC( dbgc_class, level, body ) \
204   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
205           ((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))||  \
206            (!DEBUGLEVEL_CLASS_ISSET[ dbgc_class ] && \
207             DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
208        && (dbgtext body) )
209
210 /* Print a separator to the debug log. */
211 #define DEBUGSEP(level)\
212         DEBUG((level),("===============================================================\n"))
213
214 #endif