Whamcloud - gitweb
LU-12323 libcfs: check if save_stack_trace_tsk is exported
[fs/lustre-release.git] / libcfs / libcfs / linux / linux-debug.c
index 569bdf0..aa01487 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * version 2 along with this program; If not, see
- * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
  * GPL HEADER END
  */
@@ -27,7 +23,7 @@
  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2012, 2013, Intel Corporation.
+ * Copyright (c) 2012, 2017, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
  * Author: Phil Schwan <phil@clusterfs.com>
  */
 
-#include <linux/module.h>
+#include <linux/errno.h>
+#include <linux/interrupt.h>
+#include <linux/kallsyms.h>
 #include <linux/kmod.h>
+#include <linux/module.h>
 #include <linux/notifier.h>
-#include <linux/kernel.h>
-#include <linux/mm.h>
-#include <linux/string.h>
-#include <linux/stat.h>
-#include <linux/errno.h>
 #ifdef HAVE_KERNEL_LOCKED
 #include <linux/smp_lock.h>
 #endif
+#include <linux/string.h>
 #include <linux/unistd.h>
-#include <linux/interrupt.h>
-#include <asm/uaccess.h>
-#include <linux/completion.h>
-
-#include <linux/fs.h>
-#include <linux/stat.h>
-#include <asm/uaccess.h>
-#include <linux/miscdevice.h>
-#include <linux/version.h>
+#include <linux/stacktrace.h>
+#include <linux/utsname.h>
 
 # define DEBUG_SUBSYSTEM S_LNET
 
 #include <libcfs/libcfs.h>
-#include <libcfs/linux/portals_compat25.h>
 
 #include "tracefile.h"
 
-#include <linux/kallsyms.h>
-
-char lnet_upcall[1024] = "/usr/lib/lustre/lnet_upcall";
 char lnet_debug_log_upcall[1024] = "/usr/lib/lustre/lnet_debug_log_upcall";
 
 /**
@@ -94,7 +78,7 @@ void libcfs_run_debug_log_upcall(char *file)
 
         argv[2] = NULL;
 
-        rc = USERMODEHELPER(argv[0], argv, envp);
+        rc = call_usermodehelper(argv[0], argv, envp, 1);
         if (rc < 0 && rc != -ENOENT) {
                 CERROR("Error %d invoking LNET debug log upcall %s %s; "
                        "check /proc/sys/lnet/debug_log_upcall\n",
@@ -107,92 +91,74 @@ void libcfs_run_debug_log_upcall(char *file)
         EXIT;
 }
 
-void libcfs_run_upcall(char **argv)
+/* coverity[+kill] */
+void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
 {
-        int   rc;
-        int   argc;
-        char *envp[] = {
-                "HOME=/",
-                "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
-                NULL};
-        ENTRY;
-
-        argv[0] = lnet_upcall;
-        argc = 1;
-        while (argv[argc] != NULL)
-                argc++;
-
-        LASSERT(argc >= 2);
-
-        rc = USERMODEHELPER(argv[0], argv, envp);
-        if (rc < 0 && rc != -ENOENT) {
-                CERROR("Error %d invoking LNET upcall %s %s%s%s%s%s%s%s%s; "
-                       "check /proc/sys/lnet/upcall\n",
-                       rc, argv[0], argv[1],
-                       argc < 3 ? "" : ",", argc < 3 ? "" : argv[2],
-                       argc < 4 ? "" : ",", argc < 4 ? "" : argv[3],
-                       argc < 5 ? "" : ",", argc < 5 ? "" : argv[4],
-                       argc < 6 ? "" : ",...");
-        } else {
-                CDEBUG(D_HA, "Invoked LNET upcall %s %s%s%s%s%s%s%s%s\n",
-                       argv[0], argv[1],
-                       argc < 3 ? "" : ",", argc < 3 ? "" : argv[2],
-                       argc < 4 ? "" : ",", argc < 4 ? "" : argv[3],
-                       argc < 5 ? "" : ",", argc < 5 ? "" : argv[4],
-                       argc < 6 ? "" : ",...");
-        }
+       libcfs_catastrophe = 1;
+       libcfs_debug_msg(msgdata, "LBUG\n");
+
+       if (in_interrupt()) {
+               panic("LBUG in interrupt.\n");
+               /* not reached */
+       }
+
+       libcfs_debug_dumpstack(NULL);
+       if (libcfs_panic_on_lbug)
+               panic("LBUG");
+       else
+               libcfs_debug_dumplog();
+       set_current_state(TASK_UNINTERRUPTIBLE);
+       while (1)
+               schedule();
 }
+EXPORT_SYMBOL(lbug_with_loc);
 
-void libcfs_run_lbug_upcall(struct libcfs_debug_msg_data *msgdata)
-{
-        char *argv[6];
-        char buf[32];
-
-        ENTRY;
-        snprintf (buf, sizeof buf, "%d", msgdata->msg_line);
+#ifdef CONFIG_STACKTRACE
 
-        argv[1] = "LBUG";
-        argv[2] = (char *)msgdata->msg_file;
-        argv[3] = (char *)msgdata->msg_fn;
-        argv[4] = buf;
-        argv[5] = NULL;
+#ifndef HAVE_SAVE_STACK_TRACE_TSK
+#define save_stack_trace_tsk(tsk, trace)                                      \
+do {                                                                          \
+       if (tsk == current)                                                    \
+               save_stack_trace(trace);                                       \
+       else                                                                   \
+               pr_info("No stack, save_stack_trace_tsk() not exported\n");    \
+} while (0)
+#endif
 
-        libcfs_run_upcall (argv);
-}
+#define MAX_ST_ENTRIES 100
+static DEFINE_SPINLOCK(st_lock);
 
-/* coverity[+kill] */
-void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
+static void libcfs_call_trace(struct task_struct *tsk)
 {
-        libcfs_catastrophe = 1;
-        libcfs_debug_msg(msgdata, "LBUG\n");
-
-        if (in_interrupt()) {
-                panic("LBUG in interrupt.\n");
-                /* not reached */
-        }
-
-        libcfs_debug_dumpstack(NULL);
-        if (!libcfs_panic_on_lbug)
-                libcfs_debug_dumplog();
-        libcfs_run_lbug_upcall(msgdata);
-        if (libcfs_panic_on_lbug)
-                panic("LBUG");
-        set_task_state(current, TASK_UNINTERRUPTIBLE);
-        while (1)
-                schedule();
+       struct stack_trace trace;
+       static unsigned long entries[MAX_ST_ENTRIES];
+
+       trace.nr_entries = 0;
+       trace.max_entries = MAX_ST_ENTRIES;
+       trace.entries = entries;
+       trace.skip = 0;
+
+       spin_lock(&st_lock);
+       pr_info("Pid: %d, comm: %.20s %s %s\n", tsk->pid, tsk->comm,
+              init_utsname()->release, init_utsname()->version);
+       pr_info("Call Trace:\n");
+       save_stack_trace_tsk(tsk, &trace);
+       print_stack_trace(&trace, 0);
+       spin_unlock(&st_lock);
 }
 
-#ifdef __KERNEL__
+#else /* !CONFIG_STACKTRACE */
 
-#ifdef HAVE_DUMP_TRACE
+#ifdef CONFIG_X86
 #include <linux/nmi.h>
 #include <asm/stacktrace.h>
 
+#ifdef HAVE_STACKTRACE_OPS
 #ifdef HAVE_STACKTRACE_WARNING
 static void
 print_trace_warning_symbol(void *data, char *msg, unsigned long symbol)
 {
-        printk("%s", (char *)data);
+       printk("%s", (char *)data);
        print_symbol(msg, symbol);
        printk("\n");
 }
@@ -209,24 +175,24 @@ static int print_trace_stack(void *data, char *name)
        return 0;
 }
 
-#ifdef HAVE_TRACE_ADDRESS_RELIABLE
-# define RELIABLE reliable
-# define DUMP_TRACE_CONST const
-static void print_trace_address(void *data, unsigned long addr, int reliable)
+#ifdef STACKTRACE_OPS_ADDRESS_RETURN_INT
+static int
 #else
-/* before 2.6.24 there was no reliable arg */
-# define RELIABLE 1
-# define DUMP_TRACE_CONST
-static void print_trace_address(void *data, unsigned long addr)
+static void
 #endif
+print_trace_address(void *data, unsigned long addr, int reliable)
 {
-        char fmt[32];
+       char fmt[32];
+
        touch_nmi_watchdog();
-        sprintf(fmt, " [<%016lx>] %s%%s\n", addr, RELIABLE ? "": "? ");
+       sprintf(fmt, " [<%016lx>] %s%%s\n", addr, reliable ? "": "? ");
        __print_symbol(fmt, addr);
+#ifdef STACKTRACE_OPS_ADDRESS_RETURN_INT
+       return 0;
+#endif
 }
 
-static DUMP_TRACE_CONST struct stacktrace_ops print_trace_ops = {
+static const struct stacktrace_ops print_trace_ops = {
 #ifdef HAVE_STACKTRACE_WARNING
        .warning = print_trace_warning,
        .warning_symbol = print_trace_warning_symbol,
@@ -237,45 +203,46 @@ static DUMP_TRACE_CONST struct stacktrace_ops print_trace_ops = {
        .walk_stack = print_context_stack,
 #endif
 };
-#endif
+#endif /* HAVE_STACKTRACE_OPS */
 
-void libcfs_debug_dumpstack(struct task_struct *tsk)
+static void libcfs_call_trace(struct task_struct *tsk)
 {
-#if defined(HAVE_DUMP_TRACE)
-        /* dump_stack() */
-        /* show_trace() */
-        if (tsk == NULL)
-                tsk = current;
+#ifdef HAVE_STACKTRACE_OPS
        printk("Pid: %d, comm: %.20s\n", tsk->pid, tsk->comm);
-        /* show_trace_log_lvl() */
        printk("\nCall Trace:\n");
        dump_trace(tsk, NULL, NULL,
 #ifdef HAVE_DUMP_TRACE_ADDRESS
-                   0,
+                  0,
 #endif /* HAVE_DUMP_TRACE_ADDRESS */
-                   &print_trace_ops, NULL);
+                  &print_trace_ops, NULL);
        printk("\n");
-#elif defined(HAVE_SHOW_TASK)
-        /* this is exported by lustre kernel version 42 */
-        extern void show_task(struct task_struct *);
-
-        if (tsk == NULL)
-                tsk = current;
-        CWARN("showing stack for process %d\n", tsk->pid);
-        show_task(tsk);
-#else
-        if ((tsk == NULL) || (tsk == current))
-                dump_stack();
-        else
-                CWARN("can't show stack: kernel doesn't export show_task\n");
-#endif
+#else /* !HAVE_STACKTRACE_OPS */
+       if (tsk == current)
+               dump_stack();
+       else
+               CWARN("can't show stack: kernel doesn't export show_task\n");
+#endif /* HAVE_STACKTRACE_OPS */
 }
 
-cfs_task_t *libcfs_current(void)
+#else /* !CONFIG_X86 */
+
+static void libcfs_call_trace(struct task_struct *tsk)
+{
+       if (tsk == current)
+               dump_stack();
+       else
+               CWARN("can't show stack: kernel doesn't export show_task\n");
+}
+
+#endif /* CONFIG_X86 */
+
+#endif /* CONFIG_STACKTRACE */
+
+void libcfs_debug_dumpstack(struct task_struct *tsk)
 {
-        CWARN("current task struct is %p\n", current);
-        return current;
+       libcfs_call_trace(tsk ?: current);
 }
+EXPORT_SYMBOL(libcfs_debug_dumpstack);
 
 static int panic_notifier(struct notifier_block *self, unsigned long unused1,
                          void *unused2)
@@ -293,20 +260,20 @@ static int panic_notifier(struct notifier_block *self, unsigned long unused1,
         if (in_interrupt()) {
                 cfs_trace_debug_print();
         } else {
-# ifdef HAVE_KERNEL_LOCKED
+#ifdef HAVE_KERNEL_LOCKED
                while (kernel_locked())
                        unlock_kernel();
-# endif
-                libcfs_debug_dumplog_internal((void *)(long)cfs_curproc_pid());
+#endif
+               libcfs_debug_dumplog_internal((void *)(long)current_pid());
         }
 #endif
         return 0;
 }
 
 static struct notifier_block libcfs_panic_notifier = {
-        notifier_call :     panic_notifier,
-        next :              NULL,
-        priority :          10000
+       .notifier_call  = panic_notifier,
+       .next           = NULL,
+       .priority       = 10000
 };
 
 void libcfs_register_panic_notifier(void)
@@ -318,12 +285,3 @@ void libcfs_unregister_panic_notifier(void)
 {
         atomic_notifier_chain_unregister(&panic_notifier_list, &libcfs_panic_notifier);
 }
-
-EXPORT_SYMBOL(libcfs_debug_dumpstack);
-EXPORT_SYMBOL(libcfs_current);
-
-#endif /* __KERNEL__ */
-
-EXPORT_SYMBOL(libcfs_run_upcall);
-EXPORT_SYMBOL(libcfs_run_lbug_upcall);
-EXPORT_SYMBOL(lbug_with_loc);