libcfs/libcfs/linux/linux-debug.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 #ifndef EXPORT_SYMTAB
  42 # define EXPORT_SYMTAB
  43 #endif
  44
  45 #ifndef AUTOCONF_INCLUDED
  46 #include <linux/config.h>
  47 #endif
  48 #include <linux/module.h>
  49 #include <linux/kmod.h>
  50 #include <linux/notifier.h>
  51 #include <linux/kernel.h>
  52 #include <linux/mm.h>
  53 #include <linux/string.h>
  54 #include <linux/stat.h>
  55 #include <linux/errno.h>
  56 #include <linux/smp_lock.h>
  57 #include <linux/unistd.h>
  58 #include <linux/interrupt.h>
  59 #include <asm/system.h>
  60 #include <asm/uaccess.h>
  61 #include <linux/completion.h>
  62
  63 #include <linux/fs.h>
  64 #include <linux/stat.h>
  65 #include <asm/uaccess.h>
  66 #include <linux/miscdevice.h>
  67 #include <linux/version.h>
  68
  69 # define DEBUG_SUBSYSTEM S_LNET
  70
  71 #include <libcfs/libcfs.h>
  72 #include <libcfs/linux/portals_compat25.h>
  73
  74 #include "tracefile.h"
  75
  76 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,5,0))
  77 #include <linux/kallsyms.h>
  78 #endif
  79
  80 char lnet_upcall[1024] = "/usr/lib/lustre/lnet_upcall";
  81 char lnet_debug_log_upcall[1024] = "/usr/lib/lustre/lnet_debug_log_upcall";
  82
  83 /**
  84  * Upcall function once a Lustre log has been dumped.
  85  *
  86  * \param file  path of the dumped log
  87  */
  88 void libcfs_run_debug_log_upcall(char *file)
  89 {
  90         char *argv[3];
  91         int   rc;
  92         char *envp[] = {
  93                 "HOME=/",
  94                 "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
  95                 NULL};
  96         ENTRY;
  97
  98         argv[0] = lnet_debug_log_upcall;
  99
 100         LASSERTF(file != NULL, "called on a null filename\n");
 101         argv[1] = file; //only need to pass the path of the file
 102
 103         argv[2] = NULL;
 104
 105         rc = USERMODEHELPER(argv[0], argv, envp);
 106         if (rc < 0 && rc != -ENOENT) {
 107                 CERROR("Error %d invoking LNET debug log upcall %s %s; "
 108                        "check /proc/sys/lnet/debug_log_upcall\n",
 109                        rc, argv[0], argv[1]);
 110         } else {
 111                 CDEBUG(D_HA, "Invoked LNET debug log upcall %s %s\n",
 112                        argv[0], argv[1]);
 113         }
 114
 115         EXIT;
 116 }
 117
 118 void libcfs_run_upcall(char **argv)
 119 {
 120         int   rc;
 121         int   argc;
 122         char *envp[] = {
 123                 "HOME=/",
 124                 "PATH=/sbin:/bin:/usr/sbin:/usr/bin",
 125                 NULL};
 126         ENTRY;
 127
 128         argv[0] = lnet_upcall;
 129         argc = 1;
 130         while (argv[argc] != NULL)
 131                 argc++;
 132
 133         LASSERT(argc >= 2);
 134
 135         rc = USERMODEHELPER(argv[0], argv, envp);
 136         if (rc < 0 && rc != -ENOENT) {
 137                 CERROR("Error %d invoking LNET upcall %s %s%s%s%s%s%s%s%s; "
 138                        "check /proc/sys/lnet/upcall\n",
 139                        rc, argv[0], argv[1],
 140                        argc < 3 ? "" : ",", argc < 3 ? "" : argv[2],
 141                        argc < 4 ? "" : ",", argc < 4 ? "" : argv[3],
 142                        argc < 5 ? "" : ",", argc < 5 ? "" : argv[4],
 143                        argc < 6 ? "" : ",...");
 144         } else {
 145                 CDEBUG(D_HA, "Invoked LNET upcall %s %s%s%s%s%s%s%s%s\n",
 146                        argv[0], argv[1],
 147                        argc < 3 ? "" : ",", argc < 3 ? "" : argv[2],
 148                        argc < 4 ? "" : ",", argc < 4 ? "" : argv[3],
 149                        argc < 5 ? "" : ",", argc < 5 ? "" : argv[4],
 150                        argc < 6 ? "" : ",...");
 151         }
 152 }
 153
 154 void libcfs_run_lbug_upcall(const char *file, const char *fn, const int line)
 155 {
 156         char *argv[6];
 157         char buf[32];
 158
 159         ENTRY;
 160         snprintf (buf, sizeof buf, "%d", line);
 161
 162         argv[1] = "LBUG";
 163         argv[2] = (char *)file;
 164         argv[3] = (char *)fn;
 165         argv[4] = buf;
 166         argv[5] = NULL;
 167
 168         libcfs_run_upcall (argv);
 169 }
 170
 171 #ifdef __arch_um__
 172 void lbug_with_loc(const char *file, const char *func, const int line)
 173 {
 174         libcfs_catastrophe = 1;
 175         libcfs_debug_msg(NULL, 0, D_EMERG, file, func, line,
 176                          "LBUG - trying to dump log to %s\n",
 177                          libcfs_debug_file_path);
 178         libcfs_debug_dumplog();
 179         libcfs_run_lbug_upcall(file, func, line);
 180         asm("int $3");
 181         panic("LBUG");
 182 }
 183 #else
 184 /* coverity[+kill] */
 185 void lbug_with_loc(const char *file, const char *func, const int line)
 186 {
 187         libcfs_catastrophe = 1;
 188         libcfs_debug_msg(NULL, 0, D_EMERG, file, func, line, "LBUG\n");
 189
 190         if (in_interrupt()) {
 191                 panic("LBUG in interrupt.\n");
 192                 /* not reached */
 193         }
 194
 195         libcfs_debug_dumpstack(NULL);
 196         if (!libcfs_panic_on_lbug)
 197                 libcfs_debug_dumplog();
 198         libcfs_run_lbug_upcall(file, func, line);
 199         if (libcfs_panic_on_lbug)
 200                 panic("LBUG");
 201         set_task_state(current, TASK_UNINTERRUPTIBLE);
 202         while (1)
 203                 schedule();
 204 }
 205 #endif /* __arch_um__ */
 206
 207 #ifdef __KERNEL__
 208
 209 #ifdef HAVE_DUMP_TRACE
 210 #include <linux/nmi.h>
 211 #include <asm/stacktrace.h>
 212
 213 static void
 214 print_trace_warning_symbol(void *data, char *msg, unsigned long symbol)
 215 {
 216         printk("%s", (char *)data);
 217         print_symbol(msg, symbol);
 218         printk("\n");
 219 }
 220
 221 static void print_trace_warning(void *data, char *msg)
 222 {
 223         printk("%s%s\n", (char *)data, msg);
 224 }
 225
 226 static int print_trace_stack(void *data, char *name)
 227 {
 228         printk(" <%s> ", name);
 229         return 0;
 230 }
 231
 232 #ifdef HAVE_TRACE_ADDRESS_RELIABLE
 233 # define RELIABLE reliable
 234 # define DUMP_TRACE_CONST const
 235 static void print_trace_address(void *data, unsigned long addr, int reliable)
 236 #else
 237 /* before 2.6.24 there was no reliable arg */
 238 # define RELIABLE 1
 239 # define DUMP_TRACE_CONST
 240 static void print_trace_address(void *data, unsigned long addr)
 241 #endif
 242 {
 243         char fmt[32];
 244         touch_nmi_watchdog();
 245         sprintf(fmt, " [<%016lx>] %s%%s\n", addr, RELIABLE ? "": "? ");
 246         __print_symbol(fmt, addr);
 247 }
 248
 249 static DUMP_TRACE_CONST struct stacktrace_ops print_trace_ops = {
 250         .warning = print_trace_warning,
 251         .warning_symbol = print_trace_warning_symbol,
 252         .stack = print_trace_stack,
 253         .address = print_trace_address,
 254 };
 255 #endif
 256
 257 void libcfs_debug_dumpstack(struct task_struct *tsk)
 258 {
 259 #if defined(__arch_um__)
 260         if (tsk != NULL)
 261                 CWARN("stack dump for pid %d (%d) requested; wake up gdb.\n",
 262                       tsk->pid, UML_PID(tsk));
 263         //asm("int $3");
 264 #elif defined(HAVE_DUMP_TRACE)
 265         /* dump_stack() */
 266         /* show_trace() */
 267         if (tsk == NULL)
 268                 tsk = current;
 269         printk("Pid: %d, comm: %.20s\n", tsk->pid, tsk->comm);
 270         /* show_trace_log_lvl() */
 271         printk("\nCall Trace:\n");
 272         dump_trace(tsk, NULL, NULL,
 273 #ifdef HAVE_TRACE_ADDRESS_RELIABLE
 274                    0,
 275 #endif /* HAVE_TRACE_ADDRESS_RELIABLE */
 276                    &print_trace_ops, NULL);
 277         printk("\n");
 278 #elif defined(HAVE_SHOW_TASK)
 279         /* this is exported by lustre kernel version 42 */
 280         extern void show_task(struct task_struct *);
 281
 282         if (tsk == NULL)
 283                 tsk = current;
 284         CWARN("showing stack for process %d\n", tsk->pid);
 285         show_task(tsk);
 286 #else
 287         if ((tsk == NULL) || (tsk == current))
 288                 dump_stack();
 289         else
 290                 CWARN("can't show stack: kernel doesn't export show_task\n");
 291 #endif
 292 }
 293
 294 cfs_task_t *libcfs_current(void)
 295 {
 296         CWARN("current task struct is %p\n", current);
 297         return current;
 298 }
 299
 300 static int panic_notifier(struct notifier_block *self, unsigned long unused1,
 301                          void *unused2)
 302 {
 303         if (libcfs_panic_in_progress)
 304                 return 0;
 305
 306         libcfs_panic_in_progress = 1;
 307         mb();
 308
 309 #ifdef LNET_DUMP_ON_PANIC
 310         /* This is currently disabled because it spews far too much to the
 311          * console on the rare cases it is ever triggered. */
 312
 313         if (in_interrupt()) {
 314                 cfs_trace_debug_print();
 315         } else {
 316                 while (current->lock_depth >= 0)
 317                         unlock_kernel();
 318
 319                 libcfs_debug_dumplog_internal((void *)(long)cfs_curproc_pid());
 320         }
 321 #endif
 322         return 0;
 323 }
 324
 325 static struct notifier_block libcfs_panic_notifier = {
 326         notifier_call :     panic_notifier,
 327         next :              NULL,
 328         priority :          10000
 329 };
 330
 331 void libcfs_register_panic_notifier(void)
 332 {
 333 #ifdef HAVE_ATOMIC_PANIC_NOTIFIER
 334         atomic_notifier_chain_register(&panic_notifier_list, &libcfs_panic_notifier);
 335 #else
 336         notifier_chain_register(&panic_notifier_list, &libcfs_panic_notifier);
 337 #endif
 338 }
 339
 340 void libcfs_unregister_panic_notifier(void)
 341 {
 342 #ifdef HAVE_ATOMIC_PANIC_NOTIFIER
 343         atomic_notifier_chain_unregister(&panic_notifier_list, &libcfs_panic_notifier);
 344 #else
 345         notifier_chain_unregister(&panic_notifier_list, &libcfs_panic_notifier);
 346 #endif
 347 }
 348
 349 EXPORT_SYMBOL(libcfs_debug_dumpstack);
 350 EXPORT_SYMBOL(libcfs_current);
 351
 352 #endif /* __KERNEL__ */
 353
 354 EXPORT_SYMBOL(libcfs_run_upcall);
 355 EXPORT_SYMBOL(libcfs_run_lbug_upcall);
 356 EXPORT_SYMBOL(lbug_with_loc);