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#ifndef _SAMBA_DEBUG_H_ 21#define _SAMBA_DEBUG_H_ 22 23/** 24 * @file 25 * @brief Debugging macros 26 */ 27 28/* the debug operations structure - contains function pointers to 29 various debug implementations of each operation */ 30struct debug_ops { 31 /* function to log (using DEBUG) suspicious usage of data structure */ 32 void (*log_suspicious_usage)(const char* from, const char* info); 33 34 /* function to log (using printf) suspicious usage of data structure. 35 * To be used in circumstances when using DEBUG would cause loop. */ 36 void (*print_suspicious_usage)(const char* from, const char* info); 37 38 /* function to return process/thread id */ 39 uint32_t (*get_task_id)(void); 40 41 /* function to log process/thread id */ 42 void (*log_task_id)(int fd); 43}; 44 45#define DEBUGLEVEL *debug_level 46extern int DEBUGLEVEL; 47 48#define debug_ctx() (_debug_ctx?_debug_ctx:(_debug_ctx=talloc_new(NULL))) 49 50#define DEBUGLVL(level) ((level) <= DEBUGLEVEL) 51#define _DEBUG(level, body, header) do { \ 52 if (DEBUGLVL(level)) { \ 53 void* _debug_ctx=NULL; \ 54 if (header) { \ 55 dbghdr(level, __location__, __FUNCTION__); \ 56 } \ 57 dbgtext body; \ 58 talloc_free(_debug_ctx); \ 59 } \ 60} while (0) 61/** 62 * Write to the debug log. 63 */ 64#define DEBUG(level, body) _DEBUG(level, body, true) 65/** 66 * Add data to an existing debug log entry. 67 */ 68#define DEBUGADD(level, body) _DEBUG(level, body, false) 69 70/** 71 * Obtain indentation string for the debug log. 72 * 73 * Level specified by n. 74 */ 75#define DEBUGTAB(n) do_debug_tab(n) 76 77/** Possible destinations for the debug log (in order of precedence - 78 * once set to DEBUG_FILE, it is not possible to reset to DEBUG_STDOUT 79 * for example. This makes it easy to override for debug to stderr on 80 * the command line, as the smb.conf cannot reset it back to 81 * file-based logging */ 82enum debug_logtype {DEBUG_STDOUT = 0, DEBUG_FILE = 1, DEBUG_STDERR = 2}; 83 84/** 85 the backend for debug messages. Note that the DEBUG() macro has already 86 ensured that the log level has been met before this is called 87*/ 88_PUBLIC_ void dbghdr(int level, const char *location, const char *func); 89 90_PUBLIC_ void dbghdrclass(int level, int cls, const char *location, const char *func); 91 92/** 93 reopen the log file (usually called because the log file name might have changed) 94*/ 95_PUBLIC_ void reopen_logs(void); 96 97/** 98 * this global variable determines what messages are printed 99 */ 100_PUBLIC_ void debug_schedule_reopen_logs(void); 101 102/** 103 control the name of the logfile and whether logging will be to stdout, stderr 104 or a file 105*/ 106_PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype); 107 108/** 109 Just run logging to stdout for this program 110*/ 111_PUBLIC_ void setup_logging_stdout(void); 112 113/** 114 return a string constant containing n tabs 115 no more than 10 tabs are returned 116*/ 117_PUBLIC_ const char *do_debug_tab(int n); 118 119/** 120 log suspicious usage - print comments and backtrace 121*/ 122_PUBLIC_ void log_suspicious_usage(const char *from, const char *info); 123 124/** 125 print suspicious usage - print comments and backtrace 126*/ 127_PUBLIC_ void print_suspicious_usage(const char* from, const char* info); 128_PUBLIC_ uint32_t get_task_id(void); 129_PUBLIC_ void log_task_id(void); 130 131/** 132 register a set of debug handlers. 133*/ 134_PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops); 135 136/** 137 the backend for debug messages. Note that the DEBUG() macro has already 138 ensured that the log level has been met before this is called 139 140 @note You should never have to call this function directly. Call the DEBUG() 141 macro instead. 142*/ 143_PUBLIC_ void dbgtext(const char *format, ...) PRINTF_ATTRIBUTE(1,2); 144 145struct _XFILE; 146extern struct _XFILE *dbf; 147 148#endif 149