source/include/debug.h

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    SMB debug stuff
   5    Copyright (C) Andrew Tridgell 1992-1998
   6    Copyright (C) John H Terpstra 1996-1998
   7    Copyright (C) Luke Kenneth Casson Leighton 1996-1998
   8    Copyright (C) Paul Ashton 1998
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25 #ifndef _DEBUG_H
  26 #define _DEBUG_H
  27
  28 /* -------------------------------------------------------------------------- **
  29  * Debugging code.  See also debug.c
  30  */
  31
  32 /* mkproto.awk has trouble with ifdef'd function definitions (it ignores
  33  * the #ifdef directive and will read both definitions, thus creating two
  34  * diffferent prototype declarations), so we must do these by hand.
  35  */
  36 /* I know the __attribute__ stuff is ugly, but it does ensure we get the
  37    arguemnts to DEBUG() right. We have got them wrong too often in the
  38    past.
  39  */
  40 #ifdef HAVE_STDARG_H
  41 int  Debug1( char *, ... )
  42 #ifdef __GNUC__
  43      __attribute__ ((format (__printf__, 1, 2)))
  44 #endif
  45 ;
  46 BOOL dbgtext( char *, ... )
  47 #ifdef __GNUC__
  48      __attribute__ ((format (__printf__, 1, 2)))
  49 #endif
  50 ;
  51 #else
  52 int  Debug1();
  53 BOOL dbgtext();
  54 #endif
  55
  56 /* If we have these macros, we can add additional info to the header. */
  57 #ifdef HAVE_FILE_MACRO
  58 #define FILE_MACRO (__FILE__)
  59 #else
  60 #define FILE_MACRO ("")
  61 #endif
  62
  63 #ifdef HAVE_FUNCTION_MACRO
  64 #define FUNCTION_MACRO  (__FUNCTION__)
  65 #else
  66 #define FUNCTION_MACRO  ("")
  67 #endif
  68
  69 /*
  70  * Redefine DEBUGLEVEL because so we don't have to change every source file
  71  * that *unnecessarily* references it. Source files neeed not extern reference
  72  * DEBUGLEVEL, as it's extern in includes.h (which all source files include).
  73  * Eventually, all these references should be removed, and all references to
  74  * DEBUGLEVEL should be references to DEBUGLEVEL_CLASS[DBGC_ALL]. This could
  75  * still be through a macro still called DEBUGLEVEL. This cannot be done now
  76  * because some references would expand incorrectly.
  77  */
  78 #define DEBUGLEVEL *debug_level
  79
  80
  81 /*
  82  * Define all new debug classes here. A class is represented by an entry in
  83  * the DEBUGLEVEL_CLASS array. Index zero of this arrray is equivalent to the
  84  * old DEBUGLEVEL. Any source file that does NOT add the following lines:
  85  *
  86  *   #undef  DBGC_CLASS
  87  *   #define DBGC_CLASS DBGC_<your class name here>
  88  *
  89  * at the start of the file (after #include "includes.h") will default to
  90  * using index zero, so it will behaive just like it always has.
  91  */
  92 #define DBGC_CLASS            0     /* override as shown above */
  93 #define DBGC_ALL              0     /* index equivalent to DEBUGLEVEL */
  94
  95 #define DBGC_TDB              1
  96 #define DBGC_PRINTDRIVERS     2
  97 #define DBGC_LANMAN           3
  98
  99 #define DBGC_LAST             4     /* MUST be last class value + 1 */
 100
 101
 102 extern int DEBUGLEVEL_CLASS[DBGC_LAST];
 103
 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( DEBUGLVL( 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 valu %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: DEBUG( DBGC_TDB, 2, ("Some text and a valu %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 valu %d.\n", value) );
 149  *             DEBUGADDC( DBGC_TDB, 2, ("Some text and a valu %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   ( ((DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))||  \
 157      (DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
 158    && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) )
 159
 160
 161 #define DEBUGLVLC( dbgc_class, level ) \
 162   ( ((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))||  \
 163      (DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
 164    && dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) ) )
 165
 166
 167 #define DEBUG( level, body ) \
 168   (void)( ((DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))||  \
 169            (DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
 170        && (dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) )) \
 171        && (dbgtext body) )
 172
 173 #define DEBUGC( dbgc_class, level, body ) \
 174   (void)( ((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))||  \
 175            (DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
 176        && (dbghdr( level, FILE_MACRO, FUNCTION_MACRO, (__LINE__) )) \
 177        && (dbgtext body) )
 178
 179 #define DEBUGADD( level, body ) \
 180   (void)( ((DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))||  \
 181            (DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
 182        && (dbgtext body) )
 183
 184 #define DEBUGADDC( dbgc_class, level, body ) \
 185   (void)( ((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))||  \
 186            (DEBUGLEVEL_CLASS[ DBGC_ALL   ] >= (level))  ) \
 187        && (dbgtext body) )
 188
 189 #endif