source4/lib/util/debug.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba debug defines
   4    Copyright (C) Andrew Tridgell 2003
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 /**
  21  * @file
  22  * @brief Debugging macros
  23  */
  24
  25 /* the debug operations structure - contains function pointers to
  26    various debug implementations of each operation */
  27 struct debug_ops {
  28         /* function to log (using DEBUG) suspicious usage of data structure */
  29         void (*log_suspicious_usage)(const char* from, const char* info);
  30
  31         /* function to log (using printf) suspicious usage of data structure.
  32          * To be used in circumstances when using DEBUG would cause loop. */
  33         void (*print_suspicious_usage)(const char* from, const char* info);
  34
  35         /* function to return process/thread id */
  36         uint32_t (*get_task_id)(void);
  37
  38         /* function to log process/thread id */
  39         void (*log_task_id)(int fd);
  40 };
  41
  42 extern int DEBUGLEVEL;
  43
  44 #define debug_ctx() (_debug_ctx?_debug_ctx:(_debug_ctx=talloc_new(NULL)))
  45
  46 #define DEBUGLVL(level) ((level) <= DEBUGLEVEL)
  47 #define _DEBUG(level, body, header) do { \
  48         if (DEBUGLVL(level)) { \
  49                 void* _debug_ctx=NULL; \
  50                 if (header) { \
  51                         do_debug_header(level, __location__, __FUNCTION__); \
  52                 } \
  53                 do_debug body; \
  54                 talloc_free(_debug_ctx); \
  55         } \
  56 } while (0)
  57 /**
  58  * Write to the debug log.
  59  */
  60 #define DEBUG(level, body) _DEBUG(level, body, true)
  61 /**
  62  * Add data to an existing debug log entry.
  63  */
  64 #define DEBUGADD(level, body) _DEBUG(level, body, false)
  65
  66 /**
  67  * Obtain indentation string for the debug log.
  68  *
  69  * Level specified by n.
  70  */
  71 #define DEBUGTAB(n) do_debug_tab(n)
  72
  73 /** Possible destinations for the debug log */
  74 enum debug_logtype {DEBUG_STDOUT = 0, DEBUG_FILE = 1, DEBUG_STDERR = 2};
  75
  76 /**
  77   the backend for debug messages. Note that the DEBUG() macro has already
  78   ensured that the log level has been met before this is called
  79 */
  80 _PUBLIC_ void do_debug_header(int level, const char *location, const char *func);
  81
  82 /**
  83   reopen the log file (usually called because the log file name might have changed)
  84 */
  85 _PUBLIC_ void reopen_logs(void);
  86
  87 /**
  88  * this global variable determines what messages are printed
  89  */
  90 _PUBLIC_ void debug_schedule_reopen_logs(void);
  91
  92 /**
  93   control the name of the logfile and whether logging will be to stdout, stderr
  94   or a file
  95 */
  96 _PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype);
  97
  98 /**
  99   return a string constant containing n tabs
 100   no more than 10 tabs are returned
 101 */
 102 _PUBLIC_ const char *do_debug_tab(int n);
 103
 104 /**
 105   log suspicious usage - print comments and backtrace
 106 */
 107 _PUBLIC_ void log_suspicious_usage(const char *from, const char *info);
 108
 109 /**
 110   print suspicious usage - print comments and backtrace
 111 */
 112 _PUBLIC_ void print_suspicious_usage(const char* from, const char* info);
 113 _PUBLIC_ uint32_t get_task_id(void);
 114 _PUBLIC_ void log_task_id(void);
 115
 116 /**
 117   register a set of debug handlers.
 118 */
 119 _PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops);
 120
 121 /**
 122   the backend for debug messages. Note that the DEBUG() macro has already
 123   ensured that the log level has been met before this is called
 124
 125   @note You should never have to call this function directly. Call the DEBUG()
 126   macro instead.
 127 */
 128 _PUBLIC_ void do_debug(const char *format, ...) PRINTF_ATTRIBUTE(1,2);