Whamcloud - gitweb
LU-14550 libcfs: fix setting of debug_path
[fs/lustre-release.git] / libcfs / libcfs / debug.c
index c1082ea..412a10c 100644 (file)
 
 # define DEBUG_SUBSYSTEM S_LNET
 
+#include <linux/module.h>
 #include <linux/ctype.h>
+#include <libcfs/libcfs_string.h>
 #include <linux/kthread.h>
 #include <linux/stacktrace.h>
 #include <linux/utsname.h>
-#include <libcfs/libcfs.h>
+#include <linux/kallsyms.h>
 #include "tracefile.h"
 
 static char debug_file_name[1024];
 
 unsigned int libcfs_subsystem_debug = ~0;
+EXPORT_SYMBOL(libcfs_subsystem_debug);
 module_param(libcfs_subsystem_debug, int, 0644);
 MODULE_PARM_DESC(libcfs_subsystem_debug, "Lustre kernel debug subsystem mask");
-EXPORT_SYMBOL(libcfs_subsystem_debug);
 
 unsigned int libcfs_debug = (D_CANTMASK | D_NETERROR | D_HA | D_CONFIG |
                             D_IOCTL | D_LFSCK | D_TTY);
+EXPORT_SYMBOL(libcfs_debug);
 module_param(libcfs_debug, int, 0644);
 MODULE_PARM_DESC(libcfs_debug, "Lustre kernel debug mask");
-EXPORT_SYMBOL(libcfs_debug);
 
 static int libcfs_param_debug_mb_set(const char *val,
                                     cfs_kernel_param_arg_t *kp)
@@ -78,12 +80,11 @@ static int libcfs_param_debug_mb_set(const char *val,
        return 0;
 }
 
-/*
- * While debug_mb setting look like unsigned int, in fact
+/* While debug_mb setting look like unsigned int, in fact
  * it needs quite a bunch of extra processing, so we define special
  * debug_mb parameter type with corresponding methods to handle this case
  */
-static struct kernel_param_ops param_ops_debug_mb = {
+static const struct kernel_param_ops param_ops_debug_mb = {
        .set = libcfs_param_debug_mb_set,
        .get = param_get_uint,
 };
@@ -149,7 +150,7 @@ static int param_set_console_max_delay(const char *val,
                                      libcfs_console_min_delay, INT_MAX);
 }
 
-static struct kernel_param_ops param_ops_console_max_delay = {
+static const struct kernel_param_ops param_ops_console_max_delay = {
        .set = param_set_console_max_delay,
        .get = param_get_delay,
 };
@@ -172,7 +173,7 @@ static int param_set_console_min_delay(const char *val,
                                      1, libcfs_console_max_delay);
 }
 
-static struct kernel_param_ops param_ops_console_min_delay = {
+static const struct kernel_param_ops param_ops_console_min_delay = {
        .set = param_set_console_min_delay,
        .get = param_get_delay,
 };
@@ -212,7 +213,7 @@ static int param_set_uintpos(const char *val,
        return param_set_uint_minmax(val, kp, 1, -1);
 }
 
-static struct kernel_param_ops param_ops_uintpos = {
+static const struct kernel_param_ops param_ops_uintpos = {
        .set = param_set_uintpos,
        .get = param_get_uint,
 };
@@ -244,29 +245,25 @@ unsigned int libcfs_panic_on_lbug = 1;
 module_param(libcfs_panic_on_lbug, uint, 0644);
 MODULE_PARM_DESC(libcfs_panic_on_lbug, "Lustre kernel panic on LBUG");
 
-atomic_t libcfs_kmemory = ATOMIC_INIT(0);
-EXPORT_SYMBOL(libcfs_kmemory);
+atomic64_t libcfs_kmem = ATOMIC64_INIT(0);
+EXPORT_SYMBOL(libcfs_kmem);
 
 static DECLARE_COMPLETION(debug_complete);
 
-char libcfs_debug_file_path_arr[PATH_MAX] = LIBCFS_DEBUG_FILE_PATH_DEFAULT;
-EXPORT_SYMBOL(libcfs_debug_file_path_arr);
-
 /* We need to pass a pointer here, but elsewhere this must be a const */
-static char *libcfs_debug_file_path = LIBCFS_DEBUG_FILE_PATH_DEFAULT;
+char *libcfs_debug_file_path = LIBCFS_DEBUG_FILE_PATH_DEFAULT;
+EXPORT_SYMBOL(libcfs_debug_file_path);
 module_param(libcfs_debug_file_path, charp, 0644);
 MODULE_PARM_DESC(libcfs_debug_file_path,
                 "Path for dumping debug logs, set 'NONE' to prevent log dumping");
 
 int libcfs_panic_in_progress;
 
-/*
- * libcfs_debug_token2mask() expects the returned
- * string in lower-case
- */
+/* libcfs_debug_token2mask() expects the returned string in lower-case */
 static const char *libcfs_debug_subsys2str(int subsys)
 {
-       static const char *libcfs_debug_subsystems[] = LIBCFS_DEBUG_SUBSYS_NAMES;
+       static const char * const libcfs_debug_subsystems[] =
+               LIBCFS_DEBUG_SUBSYS_NAMES;
 
        if (subsys >= ARRAY_SIZE(libcfs_debug_subsystems))
                return NULL;
@@ -274,13 +271,11 @@ static const char *libcfs_debug_subsys2str(int subsys)
        return libcfs_debug_subsystems[subsys];
 }
 
-/*
- * libcfs_debug_token2mask() expects the returned
- * string in lower-case
- */
+/* libcfs_debug_token2mask() expects the returned string in lower-case */
 static const char *libcfs_debug_dbg2str(int debug)
 {
-       static const char *libcfs_debug_masks[] = LIBCFS_DEBUG_MASKS_NAMES;
+       static const char * const libcfs_debug_masks[] =
+               LIBCFS_DEBUG_MASKS_NAMES;
 
        if (debug >= ARRAY_SIZE(libcfs_debug_masks))
                return NULL;
@@ -307,7 +302,7 @@ libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys)
                                continue;
 
                        token = fn(i);
-                       if (token == NULL)      /* unused bit */
+                       if (!token)     /* unused bit */
                                continue;
 
                        if (len > 0) {          /* separator? */
@@ -349,14 +344,11 @@ libcfs_debug_str2mask(int *mask, const char *str, int is_subsys)
                if (!isspace(str[n-1]))
                        break;
        matched = n;
-
        t = sscanf(str, "%i%n", &m, &matched);
        if (t >= 1 && matched == n) {
                /* don't print warning for lctl set_param debug=0 or -1 */
                if (m != 0 && m != -1)
-                       CWARN("You are trying to use a numerical value for the "
-                             "mask - this will be deprecated in a future "
-                             "release.\n");
+                       CWARN("You are trying to use a numerical value for the mask - this will be deprecated in a future release.\n");
                *mask = m;
                return 0;
        }
@@ -371,11 +363,11 @@ char lnet_debug_log_upcall[1024] = "/usr/lib/lustre/lnet_debug_log_upcall";
  *
  * @file       path of the dumped log
  */
-void libcfs_run_debug_log_upcall(char *file)
+static void libcfs_run_debug_log_upcall(char *file)
 {
        char *argv[3];
        int rc;
-       char *envp[] = {
+       static const char * const envp[] = {
                "HOME=/",
                "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
                NULL
@@ -385,11 +377,11 @@ void libcfs_run_debug_log_upcall(char *file)
        argv[0] = lnet_debug_log_upcall;
 
        LASSERTF(file, "called on a null filename\n");
-       argv[1] = file; //only need to pass the path of the file
+       argv[1] = file; /* only need to pass the path of the file */
 
        argv[2] = NULL;
 
-       rc = call_usermodehelper(argv[0], argv, envp, 1);
+       rc = call_usermodehelper(argv[0], argv, (char **)envp, 1);
        if (rc < 0 && rc != -ENOENT) {
                CERROR("Error %d invoking LNET debug log upcall %s %s; check /sys/kernel/debug/lnet/debug_log_upcall\n",
                       rc, argv[0], argv[1]);
@@ -402,27 +394,23 @@ void libcfs_run_debug_log_upcall(char *file)
 /**
  * Dump Lustre log to ::debug_file_path by calling tracefile_dump_all_pages()
  */
-void libcfs_debug_dumplog_internal(void *arg)
+static void libcfs_debug_dumplog_internal(void *arg)
 {
        static time64_t last_dump_time;
        time64_t current_time;
-       void *journal_info;
 
-       journal_info = current->journal_info;
-       current->journal_info = NULL;
        current_time = ktime_get_real_seconds();
 
-       if (strncmp(libcfs_debug_file_path_arr, "NONE", 4) != 0 &&
+       if (strncmp(libcfs_debug_file_path, "NONE", 4) != 0 &&
            current_time > last_dump_time) {
                last_dump_time = current_time;
                snprintf(debug_file_name, sizeof(debug_file_name) - 1,
-                        "%s.%lld.%ld", libcfs_debug_file_path_arr,
+                        "%s.%lld.%ld", libcfs_debug_file_path,
                         (s64)current_time, (uintptr_t)arg);
                pr_alert("LustreError: dumping log to %s\n", debug_file_name);
                cfs_tracefile_dump_all_pages(debug_file_name);
                libcfs_run_debug_log_upcall(debug_file_name);
        }
-       current->journal_info = journal_info;
 }
 
 static int libcfs_debug_dumplog_thread(void *arg)
@@ -464,7 +452,7 @@ void libcfs_debug_dumplog(void)
 EXPORT_SYMBOL(libcfs_debug_dumplog);
 
 /* coverity[+kill] */
-void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
+void __noreturn lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
 {
        libcfs_catastrophe = 1;
        libcfs_debug_msg(msgdata, "LBUG\n");
@@ -497,6 +485,18 @@ do {                                                                              \
 } while (0)
 #endif
 
+static void cfs_print_stack_trace(unsigned long *entries, unsigned int nr)
+{
+       unsigned int i;
+
+       /* Prefer %pB for backtraced symbolic names since it was added in:
+        * Linux v2.6.38-6557-g0f77a8d37825
+        * vsprintf: Introduce %pB format specifier
+        */
+       for (i = 0; i < nr; i++)
+               pr_info("[<0>] %pB\n", (void *)entries[i]);
+}
+
 #define MAX_ST_ENTRIES 100
 static DEFINE_SPINLOCK(st_lock);
 
@@ -512,15 +512,20 @@ typedef unsigned int (stack_trace_save_tsk_t)(struct task_struct *task,
 static stack_trace_save_tsk_t *task_dump_stack;
 #endif
 
-static void libcfs_call_trace(struct task_struct *tsk)
+void __init cfs_debug_init(void)
 {
 #ifdef CONFIG_ARCH_STACKWALK
-       static unsigned long entries[MAX_ST_ENTRIES];
-       unsigned int i, nr_entries;
+       task_dump_stack = (void *)
+                       kallsyms_lookup_name("stack_trace_save_tsk");
+
+#endif
+}
 
-       if (!task_dump_stack)
-               task_dump_stack = (stack_trace_save_tsk_t *)
-                                 symbol_get("stack_trace_save_tsk");
+static void libcfs_call_trace(struct task_struct *tsk)
+{
+       static unsigned long entries[MAX_ST_ENTRIES];
+#ifdef CONFIG_ARCH_STACKWALK
+       unsigned int nr_entries;
 
        spin_lock(&st_lock);
        pr_info("Pid: %d, comm: %.20s %s %s\n", tsk->pid, tsk->comm,
@@ -528,13 +533,11 @@ static void libcfs_call_trace(struct task_struct *tsk)
        pr_info("Call Trace TBD:\n");
        if (task_dump_stack) {
                nr_entries = task_dump_stack(tsk, entries, MAX_ST_ENTRIES, 0);
-               for (i = 0; i < nr_entries; i++)
-                       pr_info("[<0>] %pB\n", (void *)entries[i]);
+               cfs_print_stack_trace(entries, nr_entries);
        }
        spin_unlock(&st_lock);
 #else
        struct stack_trace trace;
-       static unsigned long entries[MAX_ST_ENTRIES];
 
        trace.nr_entries = 0;
        trace.max_entries = MAX_ST_ENTRIES;
@@ -546,7 +549,7 @@ static void libcfs_call_trace(struct task_struct *tsk)
                init_utsname()->release, init_utsname()->version);
        pr_info("Call Trace:\n");
        save_stack_trace_tsk(tsk, &trace);
-       print_stack_trace(&trace, 0);
+       cfs_print_stack_trace(trace.entries, trace.nr_entries);
        spin_unlock(&st_lock);
 #endif
 }
@@ -632,6 +635,16 @@ static int panic_notifier(struct notifier_block *self, unsigned long unused1,
        libcfs_panic_in_progress = 1;
        mb();
 
+#ifdef LNET_DUMP_ON_PANIC
+       /* This is currently disabled because it spews far too much to the
+        * console on the rare cases it is ever triggered. */
+
+       if (in_interrupt()) {
+               cfs_trace_debug_print();
+       } else {
+               libcfs_debug_dumplog_internal((void *)(long)current->pid);
+       }
+#endif
        return 0;
 }
 
@@ -655,8 +668,8 @@ static void libcfs_unregister_panic_notifier(void)
 
 int libcfs_debug_init(unsigned long bufsize)
 {
-       int rc = 0;
        unsigned int max = libcfs_debug_mb;
+       int rc = 0;
 
        if (libcfs_console_max_delay <= 0 || /* not set by user or */
            libcfs_console_min_delay <= 0 || /* set to invalid values */
@@ -665,12 +678,6 @@ int libcfs_debug_init(unsigned long bufsize)
                libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
        }
 
-       if (libcfs_debug_file_path != NULL) {
-               strlcpy(libcfs_debug_file_path_arr,
-                       libcfs_debug_file_path,
-                       sizeof(libcfs_debug_file_path_arr));
-       }
-
        /* If libcfs_debug_mb is uninitialized then just make the
         * total buffers smp_num_cpus * TCD_MAX_PAGES
         */
@@ -678,7 +685,7 @@ int libcfs_debug_init(unsigned long bufsize)
                max = TCD_MAX_PAGES;
        } else {
                max = (max / num_possible_cpus());
-               max = (max << (20 - PAGE_SHIFT));
+               max <<= (20 - PAGE_SHIFT);
        }
 
        rc = cfs_tracefile_init(max);
@@ -708,20 +715,20 @@ int libcfs_debug_clear_buffer(void)
        return 0;
 }
 
-/*
- * Debug markers, although printed by S_LNET
- * should not be be marked as such.
- */
+/* Debug markers, although printed by S_LNET should not be be marked as such. */
 #undef DEBUG_SUBSYSTEM
 #define DEBUG_SUBSYSTEM S_UNDEFINED
 int libcfs_debug_mark_buffer(const char *text)
 {
-       CDEBUG(D_TRACE, "**************************************************\n");
+       CDEBUG(D_TRACE,
+              "**************************************************\n");
        LCONSOLE(D_WARNING, "DEBUG MARKER: %s\n", text);
-       CDEBUG(D_TRACE, "**************************************************\n");
+       CDEBUG(D_TRACE,
+              "**************************************************\n");
 
        return 0;
 }
+
 #undef DEBUG_SUBSYSTEM
 #define DEBUG_SUBSYSTEM S_LNET