libcfs/libcfs/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) 2011, Whamcloud, Inc.
  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/debug.c
  37  *
  38  * Author: Phil Schwan <phil@clusterfs.com>
  39  *
  40  */
  41
  42 # define DEBUG_SUBSYSTEM S_LNET
  43
  44 #include <libcfs/libcfs.h>
  45 #include "tracefile.h"
  46
  47 static char debug_file_name[1024];
  48
  49 unsigned int libcfs_subsystem_debug = ~0;
  50 CFS_MODULE_PARM(libcfs_subsystem_debug, "i", int, 0644,
  51                 "Lustre kernel debug subsystem mask");
  52 EXPORT_SYMBOL(libcfs_subsystem_debug);
  53
  54 unsigned int libcfs_debug = (D_CANTMASK |
  55                              D_NETERROR | D_HA | D_CONFIG | D_IOCTL);
  56 CFS_MODULE_PARM(libcfs_debug, "i", int, 0644,
  57                 "Lustre kernel debug mask");
  58 EXPORT_SYMBOL(libcfs_debug);
  59
  60 unsigned int libcfs_debug_mb = 0;
  61 CFS_MODULE_PARM(libcfs_debug_mb, "i", uint, 0644,
  62                 "Total debug buffer size.");
  63 EXPORT_SYMBOL(libcfs_debug_mb);
  64
  65 unsigned int libcfs_printk = D_CANTMASK;
  66 CFS_MODULE_PARM(libcfs_printk, "i", uint, 0644,
  67                 "Lustre kernel debug console mask");
  68 EXPORT_SYMBOL(libcfs_printk);
  69
  70 unsigned int libcfs_console_ratelimit = 1;
  71 CFS_MODULE_PARM(libcfs_console_ratelimit, "i", uint, 0644,
  72                 "Lustre kernel debug console ratelimit (0 to disable)");
  73 EXPORT_SYMBOL(libcfs_console_ratelimit);
  74
  75 unsigned int libcfs_console_max_delay;
  76 CFS_MODULE_PARM(libcfs_console_max_delay, "l", uint, 0644,
  77                 "Lustre kernel debug console max delay (jiffies)");
  78 EXPORT_SYMBOL(libcfs_console_max_delay);
  79
  80 unsigned int libcfs_console_min_delay;
  81 CFS_MODULE_PARM(libcfs_console_min_delay, "l", uint, 0644,
  82                 "Lustre kernel debug console min delay (jiffies)");
  83 EXPORT_SYMBOL(libcfs_console_min_delay);
  84
  85 unsigned int libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
  86 CFS_MODULE_PARM(libcfs_console_backoff, "i", uint, 0644,
  87                 "Lustre kernel debug console backoff factor");
  88 EXPORT_SYMBOL(libcfs_console_backoff);
  89
  90 unsigned int libcfs_debug_binary = 1;
  91 EXPORT_SYMBOL(libcfs_debug_binary);
  92
  93 unsigned int libcfs_stack = 3 * THREAD_SIZE / 4;
  94 EXPORT_SYMBOL(libcfs_stack);
  95
  96 unsigned int portal_enter_debugger;
  97 EXPORT_SYMBOL(portal_enter_debugger);
  98
  99 unsigned int libcfs_catastrophe;
 100 EXPORT_SYMBOL(libcfs_catastrophe);
 101
 102 unsigned int libcfs_watchdog_ratelimit = 300;
 103 EXPORT_SYMBOL(libcfs_watchdog_ratelimit);
 104
 105 unsigned int libcfs_panic_on_lbug = 1;
 106 CFS_MODULE_PARM(libcfs_panic_on_lbug, "i", uint, 0644,
 107                 "Lustre kernel panic on LBUG");
 108 EXPORT_SYMBOL(libcfs_panic_on_lbug);
 109
 110 cfs_atomic_t libcfs_kmemory = CFS_ATOMIC_INIT(0);
 111 EXPORT_SYMBOL(libcfs_kmemory);
 112
 113 static cfs_waitq_t debug_ctlwq;
 114
 115 char libcfs_debug_file_path_arr[PATH_MAX] = LIBCFS_DEBUG_FILE_PATH_DEFAULT;
 116
 117 /* We need to pass a pointer here, but elsewhere this must be a const */
 118 char *libcfs_debug_file_path;
 119 CFS_MODULE_PARM(libcfs_debug_file_path, "s", charp, 0644,
 120                 "Path for dumping debug logs, "
 121                 "set 'NONE' to prevent log dumping");
 122
 123 int libcfs_panic_in_progress;
 124
 125 /* libcfs_debug_token2mask() expects the returned
 126  * string in lower-case */
 127 const char *
 128 libcfs_debug_subsys2str(int subsys)
 129 {
 130         switch (1 << subsys) {
 131         default:
 132                 return NULL;
 133         case S_UNDEFINED:
 134                 return "undefined";
 135         case S_MDC:
 136                 return "mdc";
 137         case S_MDS:
 138                 return "mds";
 139         case S_OSC:
 140                 return "osc";
 141         case S_OST:
 142                 return "ost";
 143         case S_CLASS:
 144                 return "class";
 145         case S_LOG:
 146                 return "log";
 147         case S_LLITE:
 148                 return "llite";
 149         case S_RPC:
 150                 return "rpc";
 151         case S_LNET:
 152                 return "lnet";
 153         case S_LND:
 154                 return "lnd";
 155         case S_PINGER:
 156                 return "pinger";
 157         case S_FILTER:
 158                 return "filter";
 159         case S_ECHO:
 160                 return "echo";
 161         case S_LDLM:
 162                 return "ldlm";
 163         case S_LOV:
 164                 return "lov";
 165         case S_LQUOTA:
 166                 return "lquota";
 167         case S_LMV:
 168                 return "lmv";
 169         case S_SEC:
 170                 return "sec";
 171         case S_GSS:
 172                 return "gss";
 173         case S_MGC:
 174                 return "mgc";
 175         case S_MGS:
 176                 return "mgs";
 177         case S_FID:
 178                 return "fid";
 179         case S_FLD:
 180                 return "fld";
 181         }
 182 }
 183
 184 /* libcfs_debug_token2mask() expects the returned
 185  * string in lower-case */
 186 const char *
 187 libcfs_debug_dbg2str(int debug)
 188 {
 189         switch (1 << debug) {
 190         default:
 191                 return NULL;
 192         case D_TRACE:
 193                 return "trace";
 194         case D_INODE:
 195                 return "inode";
 196         case D_SUPER:
 197                 return "super";
 198         case D_EXT2:
 199                 return "ext2";
 200         case D_MALLOC:
 201                 return "malloc";
 202         case D_CACHE:
 203                 return "cache";
 204         case D_INFO:
 205                 return "info";
 206         case D_IOCTL:
 207                 return "ioctl";
 208         case D_NETERROR:
 209                 return "neterror";
 210         case D_NET:
 211                 return "net";
 212         case D_WARNING:
 213                 return "warning";
 214         case D_BUFFS:
 215                 return "buffs";
 216         case D_OTHER:
 217                 return "other";
 218         case D_DENTRY:
 219                 return "dentry";
 220         case D_NETTRACE:
 221                 return "nettrace";
 222         case D_PAGE:
 223                 return "page";
 224         case D_DLMTRACE:
 225                 return "dlmtrace";
 226         case D_ERROR:
 227                 return "error";
 228         case D_EMERG:
 229                 return "emerg";
 230         case D_HA:
 231                 return "ha";
 232         case D_RPCTRACE:
 233                 return "rpctrace";
 234         case D_VFSTRACE:
 235                 return "vfstrace";
 236         case D_READA:
 237                 return "reada";
 238         case D_MMAP:
 239                 return "mmap";
 240         case D_CONFIG:
 241                 return "config";
 242         case D_CONSOLE:
 243                 return "console";
 244         case D_QUOTA:
 245                 return "quota";
 246         case D_SEC:
 247                 return "sec";
 248         }
 249 }
 250
 251 int
 252 libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys)
 253 {
 254         const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
 255                                                  libcfs_debug_dbg2str;
 256         int           len = 0;
 257         const char   *token;
 258         int           i;
 259
 260         if (mask == 0) {                        /* "0" */
 261                 if (size > 0)
 262                         str[0] = '0';
 263                 len = 1;
 264         } else {                                /* space-separated tokens */
 265                 for (i = 0; i < 32; i++) {
 266                         if ((mask & (1 << i)) == 0)
 267                                 continue;
 268
 269                         token = fn(i);
 270                         if (token == NULL)              /* unused bit */
 271                                 continue;
 272
 273                         if (len > 0) {                  /* separator? */
 274                                 if (len < size)
 275                                         str[len] = ' ';
 276                                 len++;
 277                         }
 278
 279                         while (*token != 0) {
 280                                 if (len < size)
 281                                         str[len] = *token;
 282                                 token++;
 283                                 len++;
 284                         }
 285                 }
 286         }
 287
 288         /* terminate 'str' */
 289         if (len < size)
 290                 str[len] = 0;
 291         else
 292                 str[size - 1] = 0;
 293
 294         return len;
 295 }
 296
 297 int
 298 libcfs_debug_str2mask(int *mask, const char *str, int is_subsys)
 299 {
 300         const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
 301                                                  libcfs_debug_dbg2str;
 302         int         m = 0;
 303         int         matched;
 304         int         n;
 305         int         t;
 306
 307         /* Allow a number for backwards compatibility */
 308
 309         for (n = strlen(str); n > 0; n--)
 310                 if (!isspace(str[n-1]))
 311                         break;
 312         matched = n;
 313
 314         if ((t = sscanf(str, "%i%n", &m, &matched)) >= 1 &&
 315             matched == n) {
 316                 /* don't print warning for lctl set_param debug=0 or -1 */
 317                 if (m != 0 && m != -1)
 318                         CWARN("You are trying to use a numerical value for the "
 319                               "mask - this will be deprecated in a future "
 320                               "release.\n");
 321                 *mask = m;
 322                 return 0;
 323         }
 324
 325         return cfs_str2mask(str, fn, mask, is_subsys ? 0 : D_CANTMASK,
 326                             0xffffffff);
 327 }
 328
 329 /**
 330  * Dump Lustre log to ::debug_file_path by calling tracefile_dump_all_pages()
 331  */
 332 void libcfs_debug_dumplog_internal(void *arg)
 333 {
 334         CFS_DECL_JOURNAL_DATA;
 335
 336         CFS_PUSH_JOURNAL;
 337
 338         if (strncmp(libcfs_debug_file_path_arr, "NONE", 4) != 0) {
 339                 snprintf(debug_file_name, sizeof(debug_file_name) - 1,
 340                          "%s.%ld." LPLD, libcfs_debug_file_path_arr,
 341                          cfs_time_current_sec(), (long_ptr_t)arg);
 342                 printk(CFS_KERN_ALERT "LustreError: dumping log to %s\n",
 343                        debug_file_name);
 344                 cfs_tracefile_dump_all_pages(debug_file_name);
 345                 libcfs_run_debug_log_upcall(debug_file_name);
 346         }
 347         CFS_POP_JOURNAL;
 348 }
 349
 350 int libcfs_debug_dumplog_thread(void *arg)
 351 {
 352         libcfs_debug_dumplog_internal(arg);
 353         cfs_waitq_signal(&debug_ctlwq);
 354         return 0;
 355 }
 356
 357 void libcfs_debug_dumplog(void)
 358 {
 359         cfs_waitlink_t wait;
 360         cfs_task_t    *dumper;
 361         ENTRY;
 362
 363         /* we're being careful to ensure that the kernel thread is
 364          * able to set our state to running as it exits before we
 365          * get to schedule() */
 366         cfs_waitlink_init(&wait);
 367         cfs_set_current_state(CFS_TASK_INTERRUPTIBLE);
 368         cfs_waitq_add(&debug_ctlwq, &wait);
 369
 370         dumper = cfs_kthread_run(libcfs_debug_dumplog_thread,
 371                                  (void*)(long)cfs_curproc_pid(),
 372                                  "libcfs_debug_dumper");
 373         if (IS_ERR(dumper))
 374                 printk(CFS_KERN_ERR "LustreError: cannot start log dump thread:"
 375                        " %ld\n", PTR_ERR(dumper));
 376         else
 377                 cfs_waitq_wait(&wait, CFS_TASK_INTERRUPTIBLE);
 378
 379         /* be sure to teardown if cfs_create_thread() failed */
 380         cfs_waitq_del(&debug_ctlwq, &wait);
 381         cfs_set_current_state(CFS_TASK_RUNNING);
 382 }
 383 EXPORT_SYMBOL(libcfs_debug_dumplog);
 384
 385 int libcfs_debug_init(unsigned long bufsize)
 386 {
 387         int    rc = 0;
 388         unsigned int max = libcfs_debug_mb;
 389
 390         cfs_waitq_init(&debug_ctlwq);
 391
 392         if (libcfs_console_max_delay <= 0 || /* not set by user or */
 393             libcfs_console_min_delay <= 0 || /* set to invalid values */
 394             libcfs_console_min_delay >= libcfs_console_max_delay) {
 395                 libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
 396                 libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
 397         }
 398
 399         if (libcfs_debug_file_path != NULL) {
 400                 memset(libcfs_debug_file_path_arr, 0, PATH_MAX);
 401                 strncpy(libcfs_debug_file_path_arr,
 402                         libcfs_debug_file_path, PATH_MAX-1);
 403         }
 404
 405         /* If libcfs_debug_mb is set to an invalid value or uninitialized
 406          * then just make the total buffers smp_num_cpus * TCD_MAX_PAGES */
 407         if (max > cfs_trace_max_debug_mb() || max < cfs_num_possible_cpus()) {
 408                 max = TCD_MAX_PAGES;
 409         } else {
 410                 max = (max / cfs_num_possible_cpus());
 411                 max = (max << (20 - CFS_PAGE_SHIFT));
 412         }
 413         rc = cfs_tracefile_init(max);
 414
 415         if (rc == 0)
 416                 libcfs_register_panic_notifier();
 417
 418         return rc;
 419 }
 420
 421 int libcfs_debug_cleanup(void)
 422 {
 423         libcfs_unregister_panic_notifier();
 424         cfs_tracefile_exit();
 425         return 0;
 426 }
 427
 428 int libcfs_debug_clear_buffer(void)
 429 {
 430         cfs_trace_flush_pages();
 431         return 0;
 432 }
 433
 434 /* Debug markers, although printed by S_LNET
 435  * should not be be marked as such. */
 436 #undef DEBUG_SUBSYSTEM
 437 #define DEBUG_SUBSYSTEM S_UNDEFINED
 438 int libcfs_debug_mark_buffer(const char *text)
 439 {
 440         CDEBUG(D_TRACE,"***************************************************\n");
 441         LCONSOLE(D_WARNING, "DEBUG MARKER: %s\n", text);
 442         CDEBUG(D_TRACE,"***************************************************\n");
 443
 444         return 0;
 445 }
 446 #undef DEBUG_SUBSYSTEM
 447 #define DEBUG_SUBSYSTEM S_LNET
 448
 449 void libcfs_debug_set_level(unsigned int debug_level)
 450 {
 451         printk(CFS_KERN_WARNING "Lustre: Setting portals debug level to %08x\n",
 452                debug_level);
 453         libcfs_debug = debug_level;
 454 }
 455
 456 EXPORT_SYMBOL(libcfs_debug_set_level);
 457
 458 long libcfs_log_return(struct libcfs_debug_msg_data *msgdata, long rc)
 459 {
 460         libcfs_debug_msg(msgdata, "Process leaving (rc=%lu : %ld : %lx)\n",
 461                          rc, rc, rc);
 462         return rc;
 463 }
 464 EXPORT_SYMBOL(libcfs_log_return);
 465
 466 void libcfs_log_goto(struct libcfs_debug_msg_data *msgdata, const char *label,
 467                      long_ptr_t rc)
 468 {
 469         libcfs_debug_msg(msgdata, "Process leaving via %s (rc=" LPLU " : " LPLD
 470                          " : " LPLX ")\n", label, (ulong_ptr_t)rc, rc, rc);
 471 }
 472 EXPORT_SYMBOL(libcfs_log_goto);