tipc: Finish streamlining of debugging code

Completes the simplification of TIPC's debugging capabilities. By default
TIPC includes no debugging code, and any debugging code added by developers
that calls the dbg() and dbg_macros() is compiled out. If debugging support
is enabled, TIPC prints out some additional data about its internal state
when certain abnormal conditions occur, and any developer-added calls to the
TIPC debug macros are compiled in.

Signed-off-by: Allan Stephens <Allan.Stephens@windriver.com>
Signed-off-by: Paul Gortmaker <paul.gortmaker@windriver.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

diff --git a/net/tipc/Kconfig b/net/tipc/Kconfig
index c02d3e9c156d1a79bf58d845e67d81b5d0590d2a..0e7ce30fd567385bdb6f9888641f3e8c6c2074a5 100644 (file)
--- a/net/tipc/Kconfig
+++ b/net/tipc/Kconfig
@@ -67,12 +67,15 @@ config TIPC_LOG
          managed remotely via TIPC.
 
 config TIPC_DEBUG
-       bool "Enable debug messages"
+       bool "Enable debugging support"
        default n
        help
-         This enables debugging of TIPC.
+         Saying Y here enables TIPC debugging capabilities used by developers.
+         Most users do not need to bother; if unsure, just say N.
 
-         Only say Y here if you are having trouble with TIPC.  It will
-         enable the display of detailed information about what is going on.
+         Enabling debugging support causes TIPC to display data about its
+         internal state when certain abnormal conditions occur. It also
+         makes it easy for developers to capture additional information of
+         interest using the dbg() or msg_dbg() macros.
 
 endif # TIPC

diff --git a/net/tipc/core.h b/net/tipc/core.h
index 3af0b36e3f1ac0c7b4d532a7ea15045d3818fddd..997158546e257d912791d172359483a96fd38b69 100644 (file)
--- a/net/tipc/core.h
+++ b/net/tipc/core.h
@@ -83,6 +83,7 @@ struct print_buf;     /* log.h */
  *       user-defined buffers can be configured to do the same thing.
  */
 extern struct print_buf *const TIPC_NULL;
+extern struct print_buf *const TIPC_CONS;
 extern struct print_buf *const TIPC_LOG;
 
 void tipc_printf(struct print_buf *, const char *fmt, ...);
@@ -95,56 +96,26 @@ void tipc_printf(struct print_buf *, const char *fmt, ...);
 #define TIPC_OUTPUT TIPC_LOG
 #endif
 
-/*
- * TIPC can be configured to send system messages to TIPC_OUTPUT
- * or to the system console only.
- */
-
-#ifdef CONFIG_TIPC_DEBUG
-
 #define err(fmt, arg...)  tipc_printf(TIPC_OUTPUT, \
-                                       KERN_ERR "TIPC: " fmt, ## arg)
+                                     KERN_ERR "TIPC: " fmt, ## arg)
 #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
-                                       KERN_WARNING "TIPC: " fmt, ## arg)
+                                     KERN_WARNING "TIPC: " fmt, ## arg)
 #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
-                                       KERN_NOTICE "TIPC: " fmt, ## arg)
-
-#else
+                                     KERN_NOTICE "TIPC: " fmt, ## arg)
 
-#define err(fmt, arg...)  printk(KERN_ERR "TIPC: " fmt , ## arg)
-#define info(fmt, arg...) printk(KERN_INFO "TIPC: " fmt , ## arg)
-#define warn(fmt, arg...) printk(KERN_WARNING "TIPC: " fmt , ## arg)
-
-#endif
+#ifdef CONFIG_TIPC_DEBUG
 
 /*
  * DBG_OUTPUT is the destination print buffer for debug messages.
- * It defaults to the the null print buffer, but can be redefined
- * (typically in the individual .c files being debugged) to allow
- * selected debug messages to be generated where needed.
  */
 
 #ifndef DBG_OUTPUT
-#define DBG_OUTPUT TIPC_NULL
+#define DBG_OUTPUT TIPC_LOG
 #endif
 
-/*
- * TIPC can be configured to send debug messages to the specified print buffer
- * (typically DBG_OUTPUT) or to suppress them entirely.
- */
-
-#ifdef CONFIG_TIPC_DEBUG
+#define dbg(fmt, arg...)  tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg);
 
-#define dbg(fmt, arg...)  \
-       do { \
-               if (DBG_OUTPUT != TIPC_NULL) \
-                       tipc_printf(DBG_OUTPUT, fmt, ## arg); \
-       } while (0)
-#define msg_dbg(msg, txt) \
-       do { \
-               if (DBG_OUTPUT != TIPC_NULL) \
-                       tipc_msg_dbg(DBG_OUTPUT, msg, txt); \
-       } while (0)
+#define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt);
 
 void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
 
@@ -153,7 +124,7 @@ void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
 #define dbg(fmt, arg...)       do {} while (0)
 #define msg_dbg(msg, txt)      do {} while (0)
 
-#define tipc_msg_dbg(...)      do {} while (0)
+#define tipc_msg_dbg(buf, msg, txt) do {} while (0)
 
 #endif
 

diff --git a/net/tipc/log.c b/net/tipc/log.c
index 2796044f9941953ce894c15ac42263834a267728..952c39f643e695427db25c8ea37db115e0519acd 100644 (file)
--- a/net/tipc/log.c
+++ b/net/tipc/log.c
@@ -52,7 +52,7 @@ static struct print_buf null_buf = { NULL, 0, NULL, 0 };
 struct print_buf *const TIPC_NULL = &null_buf;
 
 static struct print_buf cons_buf = { NULL, 0, NULL, 1 };
-static struct print_buf *const TIPC_CONS = &cons_buf;
+struct print_buf *const TIPC_CONS = &cons_buf;
 
 static struct print_buf log_buf = { NULL, 0, NULL, 1 };
 struct print_buf *const TIPC_LOG = &log_buf;
@@ -76,8 +76,6 @@ struct print_buf *const TIPC_LOG = &log_buf;
 static char print_string[TIPC_PB_MAX_STR];
 static DEFINE_SPINLOCK(print_lock);
 
-static void tipc_printbuf_reset(struct print_buf *pb);
-static int  tipc_printbuf_empty(struct print_buf *pb);
 static void tipc_printbuf_move(struct print_buf *pb_to,
                               struct print_buf *pb_from);
 

diff --git a/net/tipc/msg.c b/net/tipc/msg.c
index ee6b4c68d4a403fb3b9331cd1e4a9810a5a0c6ce..a029cdc2df6d0663bcefa7c8a693d35f6ad819a1 100644 (file)
--- a/net/tipc/msg.c
+++ b/net/tipc/msg.c
@@ -138,6 +138,7 @@ int tipc_msg_build(struct tipc_msg *hdr,
 void tipc_msg_dbg(struct print_buf *buf, struct tipc_msg *msg, const char *str)
 {
        u32 usr = msg_user(msg);
+       tipc_printf(buf, KERN_DEBUG);
        tipc_printf(buf, str);
 
        switch (usr) {