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 _DEBUG_H
  24 #define _DEBUG_H
  25
  26 /* -------------------------------------------------------------------------- **
  27  * Debugging code.  See also debug.c
  28  */
  29
  30 /* the maximum debug level to compile into the code. This assumes a good
  31    optimising compiler that can remove unused code
  32    for embedded or low-memory systems set this to a value like 2 to get
  33    only important messages. This gives *much* smaller binaries
  34 */
  35 #ifndef MAX_DEBUG_LEVEL
  36 #define MAX_DEBUG_LEVEL 1000
  37 #endif
  38
  39 int  Debug1( const char *, ... ) PRINTF_ATTRIBUTE(1,2);
  40 bool dbgtext( const char *, ... ) PRINTF_ATTRIBUTE(1,2);
  41 bool dbghdrclass( int level, int cls, const char *location, const char *func);
  42 bool dbghdr( int level, const char *location, const char *func);
  43
  44 /*
  45  * Redefine DEBUGLEVEL because so we don't have to change every source file
  46  * that *unnecessarily* references it.
  47  */
  48 #define DEBUGLEVEL DEBUGLEVEL_CLASS[DBGC_ALL]
  49
  50 /*
  51  * Define all new debug classes here. A class is represented by an entry in
  52  * the DEBUGLEVEL_CLASS array. Index zero of this arrray is equivalent to the
  53  * old DEBUGLEVEL. Any source file that does NOT add the following lines:
  54  *
  55  *   #undef  DBGC_CLASS
  56  *   #define DBGC_CLASS DBGC_<your class name here>
  57  *
  58  * at the start of the file (after #include "includes.h") will default to
  59  * using index zero, so it will behaive just like it always has.
  60  */
  61 #define DBGC_ALL                0 /* index equivalent to DEBUGLEVEL */
  62
  63 #define DBGC_TDB                1
  64 #define DBGC_PRINTDRIVERS       2
  65 #define DBGC_LANMAN             3
  66 #define DBGC_SMB                4
  67 #define DBGC_RPC_PARSE          5
  68 #define DBGC_RPC_SRV            6
  69 #define DBGC_RPC_CLI            7
  70 #define DBGC_PASSDB             8
  71 #define DBGC_SAM                9
  72 #define DBGC_AUTH               10
  73 #define DBGC_WINBIND            11
  74 #define DBGC_VFS                12
  75 #define DBGC_IDMAP              13
  76 #define DBGC_QUOTA              14
  77 #define DBGC_ACLS               15
  78 #define DBGC_LOCKING            16
  79 #define DBGC_MSDFS              17
  80 #define DBGC_DMAPI              18
  81 #define DBGC_REGISTRY           19
  82 #define DBGC_SCAVENGER          20
  83 #define DBGC_DNS                21
  84 #define DBGC_LDB                22
  85
  86 /* Always ensure this is updated when new fixed classes area added, to ensure the array in debug.c is the right size */
  87 #define DBGC_MAX_FIXED          22
  88
  89 /* So you can define DBGC_CLASS before including debug.h */
  90 #ifndef DBGC_CLASS
  91 #define DBGC_CLASS            0     /* override as shown above */
  92 #endif
  93
  94 extern int  *DEBUGLEVEL_CLASS;
  95
  96 /* Debugging macros
  97  *
  98  * DEBUGLVL()
  99  *   If the 'file specific' debug class level >= level OR the system-wide
 100  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
 101  *   generate a header using the default macros for file, line, and
 102  *   function name. Returns True if the debug level was <= DEBUGLEVEL.
 103  *
 104  *   Example: if( DEBUGLVL( 2 ) ) dbgtext( "Some text.\n" );
 105  *
 106  * DEBUG()
 107  *   If the 'file specific' debug class level >= level OR the system-wide
 108  *   DEBUGLEVEL (synomym for DEBUGLEVEL_CLASS[ DBGC_ALL ]) >= level then
 109  *   generate a header using the default macros for file, line, and
 110  *   function name. Each call to DEBUG() generates a new header *unless* the
 111  *   previous debug output was unterminated (i.e. no '\n').
 112  *   See debug.c:dbghdr() for more info.
 113  *
 114  *   Example: DEBUG( 2, ("Some text and a value %d.\n", value) );
 115  *
 116  * DEBUGC()
 117  *   If the 'macro specified' 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. Each call to DEBUG() generates a new header *unless* the
 121  *   previous debug output was unterminated (i.e. no '\n').
 122  *   See debug.c:dbghdr() for more info.
 123  *
 124  *   Example: DEBUGC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
 125  *
 126  *  DEBUGADD(), DEBUGADDC()
 127  *    Same as DEBUG() and DEBUGC() except the text is appended to the previous
 128  *    DEBUG(), DEBUGC(), DEBUGADD(), DEBUGADDC() with out another interviening
 129  *    header.
 130  *
 131  *    Example: DEBUGADD( 2, ("Some text and a value %d.\n", value) );
 132  *             DEBUGADDC( DBGC_TDB, 2, ("Some text and a value %d.\n", value) );
 133  *
 134  * Note: If the debug class has not be redeined (see above) then the optimizer
 135  * will remove the extra conditional test.
 136  */
 137
 138 /*
 139  * From talloc.c:
 140  */
 141
 142 /* these macros gain us a few percent of speed on gcc */
 143 #if (__GNUC__ >= 3)
 144 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
 145    as its first argument */
 146 #ifndef likely
 147 #define likely(x)   __builtin_expect(!!(x), 1)
 148 #endif
 149 #ifndef unlikely
 150 #define unlikely(x) __builtin_expect(!!(x), 0)
 151 #endif
 152 #else
 153 #ifndef likely
 154 #define likely(x) (x)
 155 #endif
 156 #ifndef unlikely
 157 #define unlikely(x) (x)
 158 #endif
 159 #endif
 160
 161 #define CHECK_DEBUGLVL( level ) \
 162   ( ((level) <= MAX_DEBUG_LEVEL) && \
 163     unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level)))
 164
 165 #define CHECK_DEBUGLVLC( dbgc_class, level ) \
 166   ( ((level) <= MAX_DEBUG_LEVEL) && \
 167     unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level)))
 168
 169 #define DEBUGLVL( level ) \
 170   ( CHECK_DEBUGLVL(level) \
 171    && dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ ) )
 172
 173 #define DEBUGLVLC( dbgc_class, level ) \
 174   ( CHECK_DEBUGLVLC( dbgc_class, level ) \
 175    && dbghdrclass( level, dbgc_class, __location__, __FUNCTION__ ) )
 176
 177 #define DEBUG( level, body ) \
 178   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 179           unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))           \
 180        && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
 181        && (dbgtext body) )
 182
 183 #define DEBUGC( dbgc_class, level, body ) \
 184   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 185           unlikely(DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))           \
 186        && (dbghdrclass( level, DBGC_CLASS, __location__, __FUNCTION__ )) \
 187        && (dbgtext body) )
 188
 189 #define DEBUGADD( level, body ) \
 190   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 191           unlikely(DEBUGLEVEL_CLASS[ DBGC_CLASS ] >= (level))   \
 192        && (dbgtext body) )
 193
 194 #define DEBUGADDC( dbgc_class, level, body ) \
 195   (void)( ((level) <= MAX_DEBUG_LEVEL) && \
 196           unlikely((DEBUGLEVEL_CLASS[ dbgc_class ] >= (level))) \
 197        && (dbgtext body) )
 198
 199 /* Print a separator to the debug log. */
 200 #define DEBUGSEP(level)\
 201         DEBUG((level),("===============================================================\n"))
 202
 203 /* The following definitions come from lib/debug.c  */
 204
 205 /** Possible destinations for the debug log (in order of precedence -
 206  * once set to DEBUG_FILE, it is not possible to reset to DEBUG_STDOUT
 207  * for example.  This makes it easy to override for debug to stderr on
 208  * the command line, as the smb.conf cannot reset it back to
 209  * file-based logging */
 210 enum debug_logtype {DEBUG_DEFAULT_STDERR = 0, DEBUG_DEFAULT_STDOUT = 1, DEBUG_FILE = 2, DEBUG_STDOUT = 3, DEBUG_STDERR = 4, DEBUG_CALLBACK = 5};
 211
 212 struct debug_settings {
 213         size_t max_log_size;
 214         int syslog;
 215         bool syslog_only;
 216         bool timestamp_logs;
 217         bool debug_prefix_timestamp;
 218         bool debug_hires_timestamp;
 219         bool debug_pid;
 220         bool debug_uid;
 221         bool debug_class;
 222 };
 223
 224 void setup_logging(const char *prog_name, enum debug_logtype new_logtype);
 225
 226 void debug_close_dbf(void);
 227 void gfree_debugsyms(void);
 228 int debug_add_class(const char *classname);
 229 int debug_lookup_classname(const char *classname);
 230 bool debug_parse_levels(const char *params_str);
 231 void debug_setup_talloc_log(void);
 232 void debug_set_logfile(const char *name);
 233 void debug_set_settings(struct debug_settings *settings);
 234 bool reopen_logs_internal( void );
 235 void force_check_log_size( void );
 236 bool need_to_check_log_size( void );
 237 void check_log_size( void );
 238 void dbgflush( void );
 239 bool dbghdrclass(int level, int cls, const char *location, const char *func);
 240 bool dbghdr(int level, const char *location, const char *func);
 241 bool debug_get_output_is_stderr(void);
 242 bool debug_get_output_is_stdout(void);
 243 void debug_schedule_reopen_logs(void);
 244 char *debug_list_class_names_and_levels(void);
 245
 246 typedef void (*debug_callback_fn)(void *private_ptr, int level, const char *msg);
 247
 248 /**
 249    Set a callback for all debug messages.  Use in dlz_bind9 to push output to the bind logs
 250  */
 251 void debug_set_callback(void *private_ptr, debug_callback_fn fn);
 252
 253 /**
 254   log suspicious usage - print comments and backtrace
 255 */
 256 _PUBLIC_ void log_suspicious_usage(const char *from, const char *info);
 257
 258 /**
 259   print suspicious usage - print comments and backtrace
 260 */
 261 _PUBLIC_ void print_suspicious_usage(const char* from, const char* info);
 262 _PUBLIC_ uint32_t get_task_id(void);
 263 _PUBLIC_ void log_task_id(void);
 264
 265 /* the debug operations structure - contains function pointers to
 266    various debug implementations of each operation */
 267 struct debug_ops {
 268         /* function to log (using DEBUG) suspicious usage of data structure */
 269         void (*log_suspicious_usage)(const char* from, const char* info);
 270
 271         /* function to log (using printf) suspicious usage of data structure.
 272          * To be used in circumstances when using DEBUG would cause loop. */
 273         void (*print_suspicious_usage)(const char* from, const char* info);
 274
 275         /* function to return process/thread id */
 276         uint32_t (*get_task_id)(void);
 277
 278         /* function to log process/thread id */
 279         void (*log_task_id)(int fd);
 280 };
 281
 282 /**
 283   register a set of debug handlers.
 284 */
 285 _PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops);
 286
 287 #endif