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 DEBUGLVL(level) ((level) <= DEBUGLEVEL)
  45 #define _DEBUG(level, body, header) do { \
  46         if (DEBUGLVL(level)) { \
  47                 if (header) { \
  48                         do_debug_header(level, __location__, __FUNCTION__); \
  49                 } \
  50                 do_debug body; \
  51         } \
  52 } while (0)
  53 /**
  54  * Write to the debug log.
  55  */
  56 #define DEBUG(level, body) _DEBUG(level, body, True)
  57 /**
  58  * Add data to an existing debug log entry.
  59  */
  60 #define DEBUGADD(level, body) _DEBUG(level, body, False)
  61
  62 /**
  63  * Obtain indentation string for the debug log.
  64  *
  65  * Level specified by n.
  66  */
  67 #define DEBUGTAB(n) do_debug_tab(n)
  68
  69 /** Possible destinations for the debug log */
  70 enum debug_logtype {DEBUG_STDOUT = 0, DEBUG_FILE = 1, DEBUG_STDERR = 2};