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