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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/libcfs/linux/linux-debug.c
  37  *
  38  * Author: Phil Schwan <phil@clusterfs.com>
  39  */
  40
  41 #include <linux/module.h>
  42 #include <linux/kmod.h>
  43 #include <linux/notifier.h>
  44 #include <linux/kernel.h>
  45 #include <linux/mm.h>
  46 #include <linux/string.h>
  47 #include <linux/stat.h>
  48 #include <linux/errno.h>
  49 #ifdef HAVE_KERNEL_LOCKED
  50 #include <linux/smp_lock.h>
  51 #endif
  52 #include <linux/unistd.h>
  53 #include <linux/interrupt.h>
  54 #include <asm/uaccess.h>
  55 #include <linux/completion.h>
  56
  57 #include <linux/fs.h>
  58 #include <linux/stat.h>
  59 #include <asm/uaccess.h>
  60 #include <linux/miscdevice.h>
  61 #include <linux/version.h>
  62
  63 # define DEBUG_SUBSYSTEM S_LNET
  64
  65 #include <libcfs/libcfs.h>
  66 #include <libcfs/linux/portals_compat25.h>
  67
  68 #include "tracefile.h"
  69
  70 #include <linux/kallsyms.h>
  71
  72 char lnet_upcall[1024] = "/usr/lib/lustre/lnet_upcall";
  73 char lnet_debug_log_upcall[1024] = "/usr/lib/lustre/lnet_debug_log_upcall";
  74
  75 /**
  76  * Upcall function once a Lustre log has been dumped.
  77  *
  78  * \param file  path of the dumped log
  79  */
  80 void libcfs_run_debug_log_upcall(char *file)
  81 {
  82         char *argv[3];
  83         int   rc;
  84         char *envp[] = {
  85                 "HOME=/",
  86                 "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
  87                 NULL};
  88         ENTRY;
  89
  90         argv[0] = lnet_debug_log_upcall;
  91
  92         LASSERTF(file != NULL, "called on a null filename\n");
  93         argv[1] = file; //only need to pass the path of the file
  94
  95         argv[2] = NULL;
  96
  97         rc = USERMODEHELPER(argv[0], argv, envp);
  98         if (rc < 0 && rc != -ENOENT) {
  99                 CERROR("Error %d invoking LNET debug log upcall %s %s; "
 100                        "check /proc/sys/lnet/debug_log_upcall\n",
 101                        rc, argv[0], argv[1]);
 102         } else {
 103                 CDEBUG(D_HA, "Invoked LNET debug log upcall %s %s\n",
 104                        argv[0], argv[1]);
 105         }
 106
 107         EXIT;
 108 }
 109
 110 void libcfs_run_upcall(char **argv)
 111 {
 112         int   rc;
 113         int   argc;
 114         char *envp[] = {
 115                 "HOME=/",
 116                 "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
 117                 NULL};
 118         ENTRY;
 119
 120         argv[0] = lnet_upcall;
 121         argc = 1;
 122         while (argv[argc] != NULL)
 123                 argc++;
 124
 125         LASSERT(argc >= 2);
 126
 127         rc = USERMODEHELPER(argv[0], argv, envp);
 128         if (rc < 0 && rc != -ENOENT) {
 129                 CERROR("Error %d invoking LNET upcall %s %s%s%s%s%s%s%s%s; "
 130                        "check /proc/sys/lnet/upcall\n",
 131                        rc, argv[0], argv[1],
 132                        argc < 3 ? "" : ",", argc < 3 ? "" : argv[2],
 133                        argc < 4 ? "" : ",", argc < 4 ? "" : argv[3],
 134                        argc < 5 ? "" : ",", argc < 5 ? "" : argv[4],
 135                        argc < 6 ? "" : ",...");
 136         } else {
 137                 CDEBUG(D_HA, "Invoked LNET upcall %s %s%s%s%s%s%s%s%s\n",
 138                        argv[0], argv[1],
 139                        argc < 3 ? "" : ",", argc < 3 ? "" : argv[2],
 140                        argc < 4 ? "" : ",", argc < 4 ? "" : argv[3],
 141                        argc < 5 ? "" : ",", argc < 5 ? "" : argv[4],
 142                        argc < 6 ? "" : ",...");
 143         }
 144 }
 145
 146 void libcfs_run_lbug_upcall(struct libcfs_debug_msg_data *msgdata)
 147 {
 148         char *argv[6];
 149         char buf[32];
 150
 151         ENTRY;
 152         snprintf (buf, sizeof buf, "%d", msgdata->msg_line);
 153
 154         argv[1] = "LBUG";
 155         argv[2] = (char *)msgdata->msg_file;
 156         argv[3] = (char *)msgdata->msg_fn;
 157         argv[4] = buf;
 158         argv[5] = NULL;
 159
 160         libcfs_run_upcall (argv);
 161 }
 162
 163 /* coverity[+kill] */
 164 void lbug_with_loc(struct libcfs_debug_msg_data *msgdata)
 165 {
 166         libcfs_catastrophe = 1;
 167         libcfs_debug_msg(msgdata, "LBUG\n");
 168
 169         if (in_interrupt()) {
 170                 panic("LBUG in interrupt.\n");
 171                 /* not reached */
 172         }
 173
 174         libcfs_debug_dumpstack(NULL);
 175         if (!libcfs_panic_on_lbug)
 176                 libcfs_debug_dumplog();
 177         libcfs_run_lbug_upcall(msgdata);
 178         if (libcfs_panic_on_lbug)
 179                 panic("LBUG");
 180         set_task_state(current, TASK_UNINTERRUPTIBLE);
 181         while (1)
 182                 schedule();
 183 }
 184
 185 #ifdef __KERNEL__
 186
 187 #ifdef HAVE_DUMP_TRACE
 188 #include <linux/nmi.h>
 189 #include <asm/stacktrace.h>
 190
 191 #ifdef HAVE_STACKTRACE_WARNING
 192 static void
 193 print_trace_warning_symbol(void *data, char *msg, unsigned long symbol)
 194 {
 195         printk("%s", (char *)data);
 196         print_symbol(msg, symbol);
 197         printk("\n");
 198 }
 199
 200 static void print_trace_warning(void *data, char *msg)
 201 {
 202         printk("%s%s\n", (char *)data, msg);
 203 }
 204 #endif
 205
 206 static int print_trace_stack(void *data, char *name)
 207 {
 208         printk(" <%s> ", name);
 209         return 0;
 210 }
 211
 212 #ifdef HAVE_TRACE_ADDRESS_RELIABLE
 213 # define RELIABLE reliable
 214 # define DUMP_TRACE_CONST const
 215 static void print_trace_address(void *data, unsigned long addr, int reliable)
 216 #else
 217 /* before 2.6.24 there was no reliable arg */
 218 # define RELIABLE 1
 219 # define DUMP_TRACE_CONST
 220 static void print_trace_address(void *data, unsigned long addr)
 221 #endif
 222 {
 223         char fmt[32];
 224         touch_nmi_watchdog();
 225         sprintf(fmt, " [<%016lx>] %s%%s\n", addr, RELIABLE ? "": "? ");
 226         __print_symbol(fmt, addr);
 227 }
 228
 229 static DUMP_TRACE_CONST struct stacktrace_ops print_trace_ops = {
 230 #ifdef HAVE_STACKTRACE_WARNING
 231         .warning = print_trace_warning,
 232         .warning_symbol = print_trace_warning_symbol,
 233 #endif
 234         .stack = print_trace_stack,
 235         .address = print_trace_address,
 236 #ifdef STACKTRACE_OPS_HAVE_WALK_STACK
 237         .walk_stack = print_context_stack,
 238 #endif
 239 };
 240 #endif
 241
 242 void libcfs_debug_dumpstack(struct task_struct *tsk)
 243 {
 244 #if defined(HAVE_DUMP_TRACE)
 245         /* dump_stack() */
 246         /* show_trace() */
 247         if (tsk == NULL)
 248                 tsk = current;
 249         printk("Pid: %d, comm: %.20s\n", tsk->pid, tsk->comm);
 250         /* show_trace_log_lvl() */
 251         printk("\nCall Trace:\n");
 252         dump_trace(tsk, NULL, NULL,
 253 #ifdef HAVE_DUMP_TRACE_ADDRESS
 254                    0,
 255 #endif /* HAVE_DUMP_TRACE_ADDRESS */
 256                    &print_trace_ops, NULL);
 257         printk("\n");
 258 #elif defined(HAVE_SHOW_TASK)
 259         /* this is exported by lustre kernel version 42 */
 260         extern void show_task(struct task_struct *);
 261
 262         if (tsk == NULL)
 263                 tsk = current;
 264         CWARN("showing stack for process %d\n", tsk->pid);
 265         show_task(tsk);
 266 #else
 267         if ((tsk == NULL) || (tsk == current))
 268                 dump_stack();
 269         else
 270                 CWARN("can't show stack: kernel doesn't export show_task\n");
 271 #endif
 272 }
 273
 274 cfs_task_t *libcfs_current(void)
 275 {
 276         CWARN("current task struct is %p\n", current);
 277         return current;
 278 }
 279
 280 static int panic_notifier(struct notifier_block *self, unsigned long unused1,
 281                          void *unused2)
 282 {
 283         if (libcfs_panic_in_progress)
 284                 return 0;
 285
 286         libcfs_panic_in_progress = 1;
 287         mb();
 288
 289 #ifdef LNET_DUMP_ON_PANIC
 290         /* This is currently disabled because it spews far too much to the
 291          * console on the rare cases it is ever triggered. */
 292
 293         if (in_interrupt()) {
 294                 cfs_trace_debug_print();
 295         } else {
 296 # ifdef HAVE_KERNEL_LOCKED
 297                 while (kernel_locked())
 298                         unlock_kernel();
 299 # endif
 300                 libcfs_debug_dumplog_internal((void *)(long)cfs_curproc_pid());
 301         }
 302 #endif
 303         return 0;
 304 }
 305
 306 static struct notifier_block libcfs_panic_notifier = {
 307         notifier_call :     panic_notifier,
 308         next :              NULL,
 309         priority :          10000
 310 };
 311
 312 void libcfs_register_panic_notifier(void)
 313 {
 314         atomic_notifier_chain_register(&panic_notifier_list, &libcfs_panic_notifier);
 315 }
 316
 317 void libcfs_unregister_panic_notifier(void)
 318 {
 319         atomic_notifier_chain_unregister(&panic_notifier_list, &libcfs_panic_notifier);
 320 }
 321
 322 EXPORT_SYMBOL(libcfs_debug_dumpstack);
 323 EXPORT_SYMBOL(libcfs_current);
 324
 325 #endif /* __KERNEL__ */
 326
 327 EXPORT_SYMBOL(libcfs_run_upcall);
 328 EXPORT_SYMBOL(libcfs_run_lbug_upcall);
 329 EXPORT_SYMBOL(lbug_with_loc);