4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * libcfs/libcfs/linux/linux-debug.c
34 * Author: Phil Schwan <phil@clusterfs.com>
37 #include <linux/module.h>
38 #include <linux/kmod.h>
39 #include <linux/notifier.h>
40 #include <linux/kernel.h>
42 #include <linux/string.h>
43 #include <linux/stat.h>
44 #include <linux/errno.h>
45 #ifdef HAVE_KERNEL_LOCKED
46 #include <linux/smp_lock.h>
48 #include <linux/unistd.h>
49 #include <linux/interrupt.h>
50 #include <asm/uaccess.h>
51 #include <linux/completion.h>
54 #include <linux/stat.h>
55 #include <asm/uaccess.h>
56 #include <linux/version.h>
58 # define DEBUG_SUBSYSTEM S_LNET
60 #include <libcfs/libcfs.h>
62 #include "tracefile.h"
64 #include <linux/kallsyms.h>
66 char lnet_debug_log_upcall[1024] = "/usr/lib/lustre/lnet_debug_log_upcall";
69 * Upcall function once a Lustre log has been dumped.
71 * \param file path of the dumped log
73 void libcfs_run_debug_log_upcall(char *file)
79 "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
83 argv[0] = lnet_debug_log_upcall;
85 LASSERTF(file != NULL, "called on a null filename\n");
86 argv[1] = file; //only need to pass the path of the file
90 rc = call_usermodehelper(argv[0], argv, envp, 1);
91 if (rc < 0 && rc != -ENOENT) {
92 CERROR("Error %d invoking LNET debug log upcall %s %s; "
93 "check /proc/sys/lnet/debug_log_upcall\n",
94 rc, argv[0], argv[1]);
96 CDEBUG(D_HA, "Invoked LNET debug log upcall %s %s\n",
103 /* coverity[+kill] */
104 void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
106 libcfs_catastrophe = 1;
107 libcfs_debug_msg(msgdata, "LBUG\n");
109 if (in_interrupt()) {
110 panic("LBUG in interrupt.\n");
114 libcfs_debug_dumpstack(NULL);
115 if (!libcfs_panic_on_lbug)
116 libcfs_debug_dumplog();
117 if (libcfs_panic_on_lbug)
119 set_current_state(TASK_UNINTERRUPTIBLE);
123 EXPORT_SYMBOL(lbug_with_loc);
126 #include <linux/nmi.h>
127 #include <asm/stacktrace.h>
129 #ifdef HAVE_STACKTRACE_OPS
130 #ifdef HAVE_STACKTRACE_WARNING
132 print_trace_warning_symbol(void *data, char *msg, unsigned long symbol)
134 printk("%s", (char *)data);
135 print_symbol(msg, symbol);
139 static void print_trace_warning(void *data, char *msg)
141 printk("%s%s\n", (char *)data, msg);
145 static int print_trace_stack(void *data, char *name)
147 printk(" <%s> ", name);
151 #ifdef STACKTRACE_OPS_ADDRESS_RETURN_INT
156 print_trace_address(void *data, unsigned long addr, int reliable)
160 touch_nmi_watchdog();
161 sprintf(fmt, " [<%016lx>] %s%%s\n", addr, reliable ? "": "? ");
162 __print_symbol(fmt, addr);
163 #ifdef STACKTRACE_OPS_ADDRESS_RETURN_INT
168 static const struct stacktrace_ops print_trace_ops = {
169 #ifdef HAVE_STACKTRACE_WARNING
170 .warning = print_trace_warning,
171 .warning_symbol = print_trace_warning_symbol,
173 .stack = print_trace_stack,
174 .address = print_trace_address,
175 #ifdef STACKTRACE_OPS_HAVE_WALK_STACK
176 .walk_stack = print_context_stack,
179 #endif /* HAVE_STACKTRACE_OPS */
181 static void libcfs_call_trace(struct task_struct *tsk)
183 #ifdef HAVE_STACKTRACE_OPS
184 printk("Pid: %d, comm: %.20s\n", tsk->pid, tsk->comm);
185 printk("\nCall Trace:\n");
186 dump_trace(tsk, NULL, NULL,
187 #ifdef HAVE_DUMP_TRACE_ADDRESS
189 #endif /* HAVE_DUMP_TRACE_ADDRESS */
190 &print_trace_ops, NULL);
192 #else /* !HAVE_STACKTRACE_OPS */
196 CWARN("can't show stack: kernel doesn't export show_task\n");
197 #endif /* HAVE_STACKTRACE_OPS */
200 #else /* !CONFIG_X86 */
202 static void libcfs_call_trace(struct task_struct *tsk)
207 CWARN("can't show stack: kernel doesn't export show_task\n");
210 #endif /* CONFIG_X86 */
212 void libcfs_debug_dumpstack(struct task_struct *tsk)
214 libcfs_call_trace(tsk ?: current);
216 EXPORT_SYMBOL(libcfs_debug_dumpstack);
218 static int panic_notifier(struct notifier_block *self, unsigned long unused1,
221 if (libcfs_panic_in_progress)
224 libcfs_panic_in_progress = 1;
227 #ifdef LNET_DUMP_ON_PANIC
228 /* This is currently disabled because it spews far too much to the
229 * console on the rare cases it is ever triggered. */
231 if (in_interrupt()) {
232 cfs_trace_debug_print();
234 #ifdef HAVE_KERNEL_LOCKED
235 while (kernel_locked())
238 libcfs_debug_dumplog_internal((void *)(long)current_pid());
244 static struct notifier_block libcfs_panic_notifier = {
245 .notifier_call = panic_notifier,
250 void libcfs_register_panic_notifier(void)
252 atomic_notifier_chain_register(&panic_notifier_list, &libcfs_panic_notifier);
255 void libcfs_unregister_panic_notifier(void)
257 atomic_notifier_chain_unregister(&panic_notifier_list, &libcfs_panic_notifier);