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 #define DBGC_DRS_REPL           27
  96 #define DBGC_SMB2               28
  97 #define DBGC_SMB2_CREDITS       29
  98 #define DBGC_DSDB_AUDIT 30
  99 #define DBGC_DSDB_AUDIT_JSON    31
 100 #define DBGC_DSDB_PWD_AUDIT             32
 101 #define DBGC_DSDB_PWD_AUDIT_JSON        33
 102 #define DBGC_DSDB_TXN_AUDIT             34
 103 #define DBGC_DSDB_TXN_AUDIT_JSON        35
 104
 105 /* So you can define DBGC_CLASS before including debug.h */
 106 #ifndef DBGC_CLASS
 107 #define DBGC_CLASS            0     /* override as shown above */
 108 #endif
 109
 110 extern int  *DEBUGLEVEL_CLASS;
 111
 112 /* Debugging macros
 113  *
 114  * DEBUGLVL()
 115  *   If the 'file specific' debug class level >= level OR the system-wide
 116  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
 117  *   generate a header using the default macros for file, line, and
 118  *   function name. Returns True if the debug level was <= DEBUGLEVEL.
 119  *
 120  *   Example: if( DEBUGLVL( 2 ) ) dbgtext( "Some text.\n" );
 121  *
 122  * DEBUG()
 123  *   If the 'file specific' 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.
 129  *
 130  *   Example: DEBUG( 2, ("Some text and a value %d.\n", value) );
 131  *
 132  * DEBUGC()
 133  *   If the 'macro specified' 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: DEBUGC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
 141  *
 142  *  DEBUGADD(), DEBUGADDC()
 143  *    Same as DEBUG() and DEBUGC() except the text is appended to the previous
 144  *    DEBUG(), DEBUGC(), DEBUGADD(), DEBUGADDC() with out another interviening
 145  *    header.
 146  *
 147  *    Example: DEBUGADD( 2, ("Some text and a value %d.\n", value) );
 148  *             DEBUGADDC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
 149  *
 150  * Note: If the debug class has not be redeined (see above) then the optimizer
 151  * will remove the extra conditional test.
 152  */
 153
 154 /*
 155  * From talloc.c:
 156  */
 157
 158 /* these macros gain us a few percent of speed on gcc */
 159 #if (__GNUC__ >= 3)
 160 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
 161    as its first argument */
 162 #ifndef likely
 163 #define likely(x)   __builtin_expect(!!(x), 1)
 164 #endif
 165 #ifndef unlikely
 166 #define unlikely(x) __builtin_expect(!!(x), 0)
 167 #endif
 168 #else
 169 #ifndef likely
 170 #define likely(x) (x)
 171 #endif
 172 #ifndef unlikely
 173 #define unlikely(x) (x)
 174 #endif
 175 #endif
 176
 177 #define CHECK_DEBUGLVL( level ) \
 178   ( ((level) <= MAX_DEBUG_LEVEL) && \
 179     unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level)))
 180
 181 #define CHECK_DEBUGLVLC( dbgc_class, level ) \
 182   ( ((level) <= MAX_DEBUG_LEVEL) && \
 183     unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level)))
 184
 185 #define DEBUGLVL( level ) \
 186   ( CHECK_DEBUGLVL(level) \
 187    && dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ ) )
 188
 189 #define DEBUGLVLC( dbgc_class, level ) \
 190   ( CHECK_DEBUGLVLC( dbgc_class, level ) \
 191    && dbghdrclass( level, dbgc_class, __location__, __FUNCTION__ ) )
 192
 193 #define DEBUG( level, body ) \
 194   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 195           unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))           \
 196        && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
 197        && (dbgtext body) )
 198
 199 #define DEBUGC( dbgc_class, level, body ) \
 200   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 201           unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))           \
 202        && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
 203        && (dbgtext body) )
 204
 205 #define DEBUGADD( level, body ) \
 206   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 207           unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))   \
 208        && (dbgtext body) )
 209
 210 #define DEBUGADDC( dbgc_class, level, body ) \
 211   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 212           unlikely((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))) \
 213        && (dbgtext body) )
 214
 215 /* Print a separator to the debug log. */
 216 #define DEBUGSEP(level)\
 217         DEBUG((level),("===============================================================\n"))
 218
 219 /* Prefix messages with the function name */
 220 #define DBG_PREFIX(level, body ) \
 221         (void)( ((level) <= MAX_DEBUG_LEVEL) &&                 \
 222                 unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))     \
 223                 && (dbghdrclass(level, DBGC_CLASS, __location__, __func__ )) \
 224                 && (dbgtext("%s: ", __func__))                          \
 225                 && (dbgtext body) )
 226
 227 /* Prefix messages with the function name - class specific */
 228 #define DBGC_PREFIX(dbgc_class, level, body ) \
 229         (void)( ((level) <= MAX_DEBUG_LEVEL) &&                 \
 230                 unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))     \
 231                 && (dbghdrclass(level, dbgc_class, __location__, __func__ )) \
 232                 && (dbgtext("%s: ", __func__))                          \
 233                 && (dbgtext body) )
 234
 235 /*
 236  * Debug levels matching RFC 3164
 237  */
 238 #define DBGLVL_ERR       0      /* error conditions */
 239 #define DBGLVL_WARNING   1      /* warning conditions */
 240 #define DBGLVL_NOTICE    3      /* normal, but significant, condition */
 241 #define DBGLVL_INFO      5      /* informational message */
 242 #define DBGLVL_DEBUG    10      /* debug-level message */
 243
 244 #define DBG_ERR(...)            DBG_PREFIX(DBGLVL_ERR,          (__VA_ARGS__))
 245 #define DBG_WARNING(...)        DBG_PREFIX(DBGLVL_WARNING,      (__VA_ARGS__))
 246 #define DBG_NOTICE(...)         DBG_PREFIX(DBGLVL_NOTICE,       (__VA_ARGS__))
 247 #define DBG_INFO(...)           DBG_PREFIX(DBGLVL_INFO,         (__VA_ARGS__))
 248 #define DBG_DEBUG(...)          DBG_PREFIX(DBGLVL_DEBUG,        (__VA_ARGS__))
 249
 250 #define DBGC_ERR(dbgc_class, ...)       DBGC_PREFIX(dbgc_class, \
 251                                                 DBGLVL_ERR, (__VA_ARGS__))
 252 #define DBGC_WARNING(dbgc_class, ...)   DBGC_PREFIX(dbgc_class, \
 253                                                 DBGLVL_WARNING, (__VA_ARGS__))
 254 #define DBGC_NOTICE(dbgc_class, ...)    DBGC_PREFIX(dbgc_class, \
 255                                                 DBGLVL_NOTICE,  (__VA_ARGS__))
 256 #define DBGC_INFO(dbgc_class, ...)      DBGC_PREFIX(dbgc_class, \
 257                                                 DBGLVL_INFO,    (__VA_ARGS__))
 258 #define DBGC_DEBUG(dbgc_class, ...)     DBGC_PREFIX(dbgc_class, \
 259                                                 DBGLVL_DEBUG,   (__VA_ARGS__))
 260
 261 #define D_ERR(...)              DEBUG(DBGLVL_ERR,       (__VA_ARGS__))
 262 #define D_WARNING(...)          DEBUG(DBGLVL_WARNING,   (__VA_ARGS__))
 263 #define D_NOTICE(...)           DEBUG(DBGLVL_NOTICE,    (__VA_ARGS__))
 264 #define D_INFO(...)             DEBUG(DBGLVL_INFO,      (__VA_ARGS__))
 265 #define D_DEBUG(...)            DEBUG(DBGLVL_DEBUG,     (__VA_ARGS__))
 266
 267 #define DC_ERR(...)             DEBUGC(dbgc_class, \
 268                                         DBGLVL_ERR,     (__VA_ARGS__))
 269 #define DC_WARNING(...)         DEBUGC(dbgc_class, \
 270                                         DBGLVL_WARNING, (__VA_ARGS__))
 271 #define DC_NOTICE(...)          DEBUGC(dbgc_class, \
 272                                         DBGLVL_NOTICE,  (__VA_ARGS__))
 273 #define DC_INFO(...)            DEBUGC(dbgc_class, \
 274                                         DBGLVL_INFO,    (__VA_ARGS__))
 275 #define DC_DEBUG(...)           DEBUGC(dbgc_class, \
 276                                         DBGLVL_DEBUG,   (__VA_ARGS__))
 277
 278 /* The following definitions come from lib/debug.c  */
 279
 280 /** Possible destinations for the debug log (in order of precedence -
 281  * once set to DEBUG_FILE, it is not possible to reset to DEBUG_STDOUT
 282  * for example.  This makes it easy to override for debug to stderr on
 283  * the command line, as the smb.conf cannot reset it back to
 284  * file-based logging */
 285 enum debug_logtype {
 286         DEBUG_DEFAULT_STDERR = 0,
 287         DEBUG_DEFAULT_STDOUT = 1,
 288         DEBUG_FILE = 2,
 289         DEBUG_STDOUT = 3,
 290         DEBUG_STDERR = 4,
 291         DEBUG_CALLBACK = 5
 292 };
 293
 294 struct debug_settings {
 295         size_t max_log_size;
 296         bool timestamp_logs;
 297         bool debug_prefix_timestamp;
 298         bool debug_hires_timestamp;
 299         bool debug_pid;
 300         bool debug_uid;
 301         bool debug_class;
 302 };
 303
 304 void setup_logging(const char *prog_name, enum debug_logtype new_logtype);
 305
 306 void gfree_debugsyms(void);
 307 int debug_add_class(const char *classname);
 308 bool debug_parse_levels(const char *params_str);
 309 void debug_setup_talloc_log(void);
 310 void debug_set_logfile(const char *name);
 311 void debug_set_settings(struct debug_settings *settings,
 312                         const char *logging_param,
 313                         int syslog_level, bool syslog_only);
 314 bool reopen_logs_internal( void );
 315 void force_check_log_size( void );
 316 bool need_to_check_log_size( void );
 317 void check_log_size( void );
 318 void dbgflush( void );
 319 bool dbghdrclass(int level, int cls, const char *location, const char *func);
 320 bool debug_get_output_is_stderr(void);
 321 bool debug_get_output_is_stdout(void);
 322 void debug_schedule_reopen_logs(void);
 323 char *debug_list_class_names_and_levels(void);
 324
 325 typedef void (*debug_callback_fn)(void *private_ptr, int level, const char *msg);
 326
 327 /**
 328    Set a callback for all debug messages.  Use in dlz_bind9 to push output to the bind logs
 329  */
 330 void debug_set_callback(void *private_ptr, debug_callback_fn fn);
 331
 332 char *debug_get_ringbuf(void);
 333 size_t debug_get_ringbuf_size(void);
 334
 335 #endif /* _SAMBA_DEBUG_H */