Whamcloud - gitweb
46fbc2911821ba8aa92ed28b18b4cdc878f0f406
[fs/lustre-release.git] / libcfs / libcfs / linux / linux-debug.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * libcfs/libcfs/linux/linux-debug.c
33  *
34  * Author: Phil Schwan <phil@clusterfs.com>
35  */
36
37 #include <linux/errno.h>
38 #include <linux/interrupt.h>
39 #include <linux/kallsyms.h>
40 #include <linux/kmod.h>
41 #include <linux/module.h>
42 #include <linux/notifier.h>
43 #ifdef HAVE_KERNEL_LOCKED
44 #include <linux/smp_lock.h>
45 #endif
46 #include <linux/string.h>
47 #include <linux/unistd.h>
48 #include <linux/stacktrace.h>
49 #include <linux/utsname.h>
50
51 # define DEBUG_SUBSYSTEM S_LNET
52
53 #include <libcfs/libcfs.h>
54
55 #include "tracefile.h"
56
57 char lnet_debug_log_upcall[1024] = "/usr/lib/lustre/lnet_debug_log_upcall";
58
59 /**
60  * Upcall function once a Lustre log has been dumped.
61  *
62  * \param file  path of the dumped log
63  */
64 void libcfs_run_debug_log_upcall(char *file)
65 {
66         char *argv[3];
67         int   rc;
68         char *envp[] = {
69                 "HOME=/",
70                 "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
71                 NULL};
72         ENTRY;
73
74         argv[0] = lnet_debug_log_upcall;
75
76         LASSERTF(file != NULL, "called on a null filename\n");
77         argv[1] = file; //only need to pass the path of the file
78
79         argv[2] = NULL;
80
81         rc = call_usermodehelper(argv[0], argv, envp, 1);
82         if (rc < 0 && rc != -ENOENT) {
83                 CERROR("Error %d invoking LNET debug log upcall %s %s; "
84                        "check /proc/sys/lnet/debug_log_upcall\n",
85                        rc, argv[0], argv[1]);
86         } else {
87                 CDEBUG(D_HA, "Invoked LNET debug log upcall %s %s\n",
88                        argv[0], argv[1]);
89         }
90
91         EXIT;
92 }
93
94 /* coverity[+kill] */
95 void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
96 {
97         libcfs_catastrophe = 1;
98         libcfs_debug_msg(msgdata, "LBUG\n");
99
100         if (in_interrupt()) {
101                 panic("LBUG in interrupt.\n");
102                 /* not reached */
103         }
104
105         libcfs_debug_dumpstack(NULL);
106         if (libcfs_panic_on_lbug)
107                 panic("LBUG");
108         else
109                 libcfs_debug_dumplog();
110         set_current_state(TASK_UNINTERRUPTIBLE);
111         while (1)
112                 schedule();
113 }
114 EXPORT_SYMBOL(lbug_with_loc);
115
116 #ifdef CONFIG_STACKTRACE
117
118 #define MAX_ST_ENTRIES  100
119 static DEFINE_SPINLOCK(st_lock);
120
121 static void libcfs_call_trace(struct task_struct *tsk)
122 {
123         struct stack_trace trace;
124         static unsigned long entries[MAX_ST_ENTRIES];
125
126         trace.nr_entries = 0;
127         trace.max_entries = MAX_ST_ENTRIES;
128         trace.entries = entries;
129         trace.skip = 0;
130
131         spin_lock(&st_lock);
132         pr_info("Pid: %d, comm: %.20s %s %s\n", tsk->pid, tsk->comm,
133                init_utsname()->release, init_utsname()->version);
134         pr_info("Call Trace:\n");
135         save_stack_trace_tsk(tsk, &trace);
136         print_stack_trace(&trace, 0);
137         spin_unlock(&st_lock);
138 }
139
140 #else /* !CONFIG_STACKTRACE */
141
142 #ifdef CONFIG_X86
143 #include <linux/nmi.h>
144 #include <asm/stacktrace.h>
145
146 #ifdef HAVE_STACKTRACE_OPS
147 #ifdef HAVE_STACKTRACE_WARNING
148 static void
149 print_trace_warning_symbol(void *data, char *msg, unsigned long symbol)
150 {
151         printk("%s", (char *)data);
152         print_symbol(msg, symbol);
153         printk("\n");
154 }
155
156 static void print_trace_warning(void *data, char *msg)
157 {
158         printk("%s%s\n", (char *)data, msg);
159 }
160 #endif
161
162 static int print_trace_stack(void *data, char *name)
163 {
164         printk(" <%s> ", name);
165         return 0;
166 }
167
168 #ifdef STACKTRACE_OPS_ADDRESS_RETURN_INT
169 static int
170 #else
171 static void
172 #endif
173 print_trace_address(void *data, unsigned long addr, int reliable)
174 {
175         char fmt[32];
176
177         touch_nmi_watchdog();
178         sprintf(fmt, " [<%016lx>] %s%%s\n", addr, reliable ? "": "? ");
179         __print_symbol(fmt, addr);
180 #ifdef STACKTRACE_OPS_ADDRESS_RETURN_INT
181         return 0;
182 #endif
183 }
184
185 static const struct stacktrace_ops print_trace_ops = {
186 #ifdef HAVE_STACKTRACE_WARNING
187         .warning = print_trace_warning,
188         .warning_symbol = print_trace_warning_symbol,
189 #endif
190         .stack = print_trace_stack,
191         .address = print_trace_address,
192 #ifdef STACKTRACE_OPS_HAVE_WALK_STACK
193         .walk_stack = print_context_stack,
194 #endif
195 };
196 #endif /* HAVE_STACKTRACE_OPS */
197
198 static void libcfs_call_trace(struct task_struct *tsk)
199 {
200 #ifdef HAVE_STACKTRACE_OPS
201         printk("Pid: %d, comm: %.20s\n", tsk->pid, tsk->comm);
202         printk("\nCall Trace:\n");
203         dump_trace(tsk, NULL, NULL,
204 #ifdef HAVE_DUMP_TRACE_ADDRESS
205                    0,
206 #endif /* HAVE_DUMP_TRACE_ADDRESS */
207                    &print_trace_ops, NULL);
208         printk("\n");
209 #else /* !HAVE_STACKTRACE_OPS */
210         if (tsk == current)
211                 dump_stack();
212         else
213                 CWARN("can't show stack: kernel doesn't export show_task\n");
214 #endif /* HAVE_STACKTRACE_OPS */
215 }
216
217 #else /* !CONFIG_X86 */
218
219 static void libcfs_call_trace(struct task_struct *tsk)
220 {
221         if (tsk == current)
222                 dump_stack();
223         else
224                 CWARN("can't show stack: kernel doesn't export show_task\n");
225 }
226
227 #endif /* CONFIG_X86 */
228
229 #endif /* CONFIG_STACKTRACE */
230
231 void libcfs_debug_dumpstack(struct task_struct *tsk)
232 {
233         libcfs_call_trace(tsk ?: current);
234 }
235 EXPORT_SYMBOL(libcfs_debug_dumpstack);
236
237 static int panic_notifier(struct notifier_block *self, unsigned long unused1,
238                          void *unused2)
239 {
240         if (libcfs_panic_in_progress)
241                 return 0;
242
243         libcfs_panic_in_progress = 1;
244         mb();
245
246 #ifdef LNET_DUMP_ON_PANIC
247         /* This is currently disabled because it spews far too much to the
248          * console on the rare cases it is ever triggered. */
249
250         if (in_interrupt()) {
251                 cfs_trace_debug_print();
252         } else {
253 #ifdef HAVE_KERNEL_LOCKED
254                 while (kernel_locked())
255                         unlock_kernel();
256 #endif
257                 libcfs_debug_dumplog_internal((void *)(long)current_pid());
258         }
259 #endif
260         return 0;
261 }
262
263 static struct notifier_block libcfs_panic_notifier = {
264         .notifier_call  = panic_notifier,
265         .next           = NULL,
266         .priority       = 10000
267 };
268
269 void libcfs_register_panic_notifier(void)
270 {
271         atomic_notifier_chain_register(&panic_notifier_list, &libcfs_panic_notifier);
272 }
273
274 void libcfs_unregister_panic_notifier(void)
275 {
276         atomic_notifier_chain_unregister(&panic_notifier_list, &libcfs_panic_notifier);
277 }