From dfc517b05395d925a4d7b1ce9633a849f9468e70 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Thu, 23 Feb 2006 15:52:24 +0000 Subject: r13658: More moving around of files: - Collect the generic utility functions into a lib/util/ (a la GLib is for the GNOME folks) - Remove even more files from include/ (This used to be commit ba62880f5b05c2a505dc7f54676b231197a7e707) --- source4/lib/util/debug.h | 66 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 source4/lib/util/debug.h (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h new file mode 100644 index 0000000000..8ff937e7b9 --- /dev/null +++ b/source4/lib/util/debug.h @@ -0,0 +1,66 @@ +/* + Unix SMB/CIFS implementation. + Samba debug defines + Copyright (C) Andrew Tridgell 2003 + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +*/ + +/* If we have these macros, we can add additional info to the header. */ + +#ifdef HAVE_FUNCTION_MACRO +#define FUNCTION_MACRO (__FUNCTION__) +#else +#define FUNCTION_MACRO ("") +#endif + +/* the debug operations structure - contains function pointers to + various debug implementations of each operation */ +struct debug_ops { + /* function to log (using DEBUG) suspicious usage of data structure */ + void (*log_suspicious_usage)(const char* from, const char* info); + + /* function to log (using printf) suspicious usage of data structure. + * To be used in circumstances when using DEBUG would cause loop. */ + void (*print_suspicious_usage)(const char* from, const char* info); + + /* function to return process/thread id */ + uint32_t (*get_task_id)(void); + + /* function to log process/thread id */ + void (*log_task_id)(int fd); +}; + +void do_debug_header(int level, const char *location, const char *func); +void do_debug(const char *, ...) PRINTF_ATTRIBUTE(1,2); + +extern int DEBUGLEVEL; + +#define DEBUGLVL(level) ((level) <= DEBUGLEVEL) +#define _DEBUG(level, body, header) do { \ + if (DEBUGLVL(level)) { \ + if (header) { \ + do_debug_header(level, __location__, FUNCTION_MACRO); \ + } \ + do_debug body; \ + } \ +} while (0) +#define DEBUG(level, body) _DEBUG(level, body, True) +#define DEBUGADD(level, body) _DEBUG(level, body, False) +#define DEBUGC(class, level, body) DEBUG(level, body) +#define DEBUGADDC(class, level, body) DEBUGADD(level, body) +#define DEBUGTAB(n) do_debug_tab(n) + +enum debug_logtype {DEBUG_STDOUT = 0, DEBUG_FILE = 1, DEBUG_STDERR = 2}; -- cgit From 685b824aa88a03a8b70507d5d2454a744468075a Mon Sep 17 00:00:00 2001 From: Stefan Metzmacher Date: Wed, 1 Mar 2006 15:02:07 +0000 Subject: r13770: - do fsync() on the debug fd, as we do in samba3, I have an report that smbd memory usage grows to 1,5 GB or more without this... - make log_timestamp static metze (This used to be commit 551dd12baf9340ab070c8a8edca6b56770243a61) --- source4/lib/util/debug.h | 3 --- 1 file changed, 3 deletions(-) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 8ff937e7b9..4cd5759119 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -43,9 +43,6 @@ struct debug_ops { void (*log_task_id)(int fd); }; -void do_debug_header(int level, const char *location, const char *func); -void do_debug(const char *, ...) PRINTF_ATTRIBUTE(1,2); - extern int DEBUGLEVEL; #define DEBUGLVL(level) ((level) <= DEBUGLEVEL) -- cgit From c287cc247d90c996894cab18e870c992e7f84f85 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 6 Mar 2006 00:24:51 +0000 Subject: r13851: More doc improvements. (This used to be commit 936d26ae64b93ef8f8b2fbc632b1c2fd60840405) --- source4/lib/util/debug.h | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 4cd5759119..10d7d0697c 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -18,6 +18,11 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ +/** + * @file + * @brief Debugging macros + */ + /* If we have these macros, we can add additional info to the header. */ #ifdef HAVE_FUNCTION_MACRO @@ -54,10 +59,21 @@ extern int DEBUGLEVEL; do_debug body; \ } \ } while (0) +/** + * Write to the debug log. + */ #define DEBUG(level, body) _DEBUG(level, body, True) +/** + * Add data to an existing debug log entry. + */ #define DEBUGADD(level, body) _DEBUG(level, body, False) -#define DEBUGC(class, level, body) DEBUG(level, body) -#define DEBUGADDC(class, level, body) DEBUGADD(level, body) + +/** + * Obtain indentation string for the debug log. + * + * Level specified by n. + */ #define DEBUGTAB(n) do_debug_tab(n) +/** Possible destinations for the debug log */ enum debug_logtype {DEBUG_STDOUT = 0, DEBUG_FILE = 1, DEBUG_STDERR = 2}; -- cgit From 4ab73d6045aacd354894fe5edf0c5cfc75784064 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Sat, 8 Apr 2006 16:25:53 +0000 Subject: r15000: Move some more autoconf tests out of build/m4/rewrite.m4 Guarantee availability of __FUNCTION__ in libreplace (This used to be commit 76b1576541210f2bb306ae17e0876b254e8dcead) --- source4/lib/util/debug.h | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 10d7d0697c..80155cdccf 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -23,14 +23,6 @@ * @brief Debugging macros */ -/* If we have these macros, we can add additional info to the header. */ - -#ifdef HAVE_FUNCTION_MACRO -#define FUNCTION_MACRO (__FUNCTION__) -#else -#define FUNCTION_MACRO ("") -#endif - /* the debug operations structure - contains function pointers to various debug implementations of each operation */ struct debug_ops { @@ -54,7 +46,7 @@ extern int DEBUGLEVEL; #define _DEBUG(level, body, header) do { \ if (DEBUGLVL(level)) { \ if (header) { \ - do_debug_header(level, __location__, FUNCTION_MACRO); \ + do_debug_header(level, __location__, __FUNCTION__); \ } \ do_debug body; \ } \ -- cgit From 0479a2f1cbae51fcd8dbdc3c148c808421fb4d25 Mon Sep 17 00:00:00 2001 From: Andrew Tridgell Date: Tue, 10 Jul 2007 02:07:03 +0000 Subject: r23792: convert Samba4 to GPLv3 There are still a few tidyups of old FSF addresses to come (in both s3 and s4). More commits soon. (This used to be commit fcf38a38ac691abd0fa51b89dc951a08e89fdafa) --- source4/lib/util/debug.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 80155cdccf..2f090359a5 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -5,7 +5,7 @@ This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -14,8 +14,7 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with this program. If not, see . */ /** -- cgit From 4fb038b0b8e7a4bb69ac0d9022684eeaca8a491a Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 27 Aug 2007 17:21:16 +0000 Subject: r24710: Use standard boolean type for easier use by external users. (This used to be commit 99f4124137d4a61216e8189f26d4da32882c0f4a) --- source4/lib/util/debug.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 2f090359a5..4fa2e9f598 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -53,11 +53,11 @@ extern int DEBUGLEVEL; /** * Write to the debug log. */ -#define DEBUG(level, body) _DEBUG(level, body, True) +#define DEBUG(level, body) _DEBUG(level, body, true) /** * Add data to an existing debug log entry. */ -#define DEBUGADD(level, body) _DEBUG(level, body, False) +#define DEBUGADD(level, body) _DEBUG(level, body, false) /** * Obtain indentation string for the debug log. -- cgit From f26222df4db2055d267789655a7113a49c178071 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Sun, 14 Oct 2007 12:52:32 +0200 Subject: r25626: Move some debug-specific prototypes to debug.h. (This used to be commit 84a202754004ec618aa2663a4614d80eb2c7ce60) --- source4/lib/util/debug.h | 54 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 4fa2e9f598..25b28b65e9 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -68,3 +68,57 @@ extern int DEBUGLEVEL; /** Possible destinations for the debug log */ enum debug_logtype {DEBUG_STDOUT = 0, DEBUG_FILE = 1, DEBUG_STDERR = 2}; + +/** + the backend for debug messages. Note that the DEBUG() macro has already + ensured that the log level has been met before this is called +*/ +_PUBLIC_ void do_debug_header(int level, const char *location, const char *func); + +/** + reopen the log file (usually called because the log file name might have changed) +*/ +_PUBLIC_ void reopen_logs(void); + +/** + * this global variable determines what messages are printed + */ +_PUBLIC_ void debug_schedule_reopen_logs(void); + +/** + control the name of the logfile and whether logging will be to stdout, stderr + or a file +*/ +_PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype); + +/** + return a string constant containing n tabs + no more than 10 tabs are returned +*/ +_PUBLIC_ const char *do_debug_tab(int n); + +/** + log suspicious usage - print comments and backtrace +*/ +_PUBLIC_ void log_suspicious_usage(const char *from, const char *info); + +/** + print suspicious usage - print comments and backtrace +*/ +_PUBLIC_ void print_suspicious_usage(const char* from, const char* info); +_PUBLIC_ uint32_t get_task_id(void); +_PUBLIC_ void log_task_id(void); + +/** + register a set of debug handlers. +*/ +_PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops); + +/** + the backend for debug messages. Note that the DEBUG() macro has already + ensured that the log level has been met before this is called + + @note You should never have to call this function directly. Call the DEBUG() + macro instead. +*/ +_PUBLIC_ void do_debug(const char *format, ...) _PRINTF_ATTRIBUTE(1,2); -- cgit From 149190ff2108ba203f5cddd4414e2d02e469747a Mon Sep 17 00:00:00 2001 From: Stefan Metzmacher Date: Mon, 5 Nov 2007 10:10:17 +0100 Subject: r25830: fix compiler warning metze (This used to be commit 26bfdff48779447a2f4b552c5af32abf2b8c4c45) --- source4/lib/util/debug.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 25b28b65e9..1895ed53ad 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -121,4 +121,4 @@ _PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops); @note You should never have to call this function directly. Call the DEBUG() macro instead. */ -_PUBLIC_ void do_debug(const char *format, ...) _PRINTF_ATTRIBUTE(1,2); +_PUBLIC_ void do_debug(const char *format, ...) PRINTF_ATTRIBUTE(1,2); -- cgit From 77a2870186d3b10ea15ba5e001e7a703f0a5ccaf Mon Sep 17 00:00:00 2001 From: Amin Azez Date: Fri, 1 Feb 2008 16:19:36 +0000 Subject: Samba4 poor mans debug_ctx() DEBUG(), DEBUGADD() and friends can now use debug_ctx() in the formatting expressions again, e.g. DEBUG(5,("Guid failed to match: %s\n", GUID_string(debug_ctx(), r->guid))); Sadly it's done with macros (again) but when we need to save the 8 or 16 bytes of object code per DEBUG() expression we can do it the Samba 3 way with added thread-safety for Samba 4. That could save up to 200K, allowing 12 bytes for each occurrance of DEBUG... Signed-off-by: Amin Azez (This used to be commit 9781967542b00c279563d435aec72dac1e8c7e9a) --- source4/lib/util/debug.h | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'source4/lib/util/debug.h') diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h index 1895ed53ad..605628174a 100644 --- a/source4/lib/util/debug.h +++ b/source4/lib/util/debug.h @@ -41,13 +41,17 @@ struct debug_ops { extern int DEBUGLEVEL; +#define debug_ctx() (_debug_ctx?_debug_ctx:(_debug_ctx=talloc_new(NULL))) + #define DEBUGLVL(level) ((level) <= DEBUGLEVEL) #define _DEBUG(level, body, header) do { \ if (DEBUGLVL(level)) { \ + void* _debug_ctx=NULL; \ if (header) { \ do_debug_header(level, __location__, __FUNCTION__); \ } \ do_debug body; \ + talloc_free(_debug_ctx); \ } \ } while (0) /** -- cgit