1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/libcfs/debug.c
38 * Author: Phil Schwan <phil@clusterfs.com>
42 # define EXPORT_SYMTAB
45 # define DEBUG_SUBSYSTEM S_LNET
47 #include <libcfs/libcfs.h>
48 #include "tracefile.h"
50 static char debug_file_name[1024];
52 unsigned int libcfs_subsystem_debug = ~0;
53 CFS_MODULE_PARM(libcfs_subsystem_debug, "i", int, 0644,
54 "Lustre kernel debug subsystem mask");
55 EXPORT_SYMBOL(libcfs_subsystem_debug);
57 unsigned int libcfs_debug = (D_EMERG | D_ERROR | D_WARNING | D_CONSOLE |
58 D_NETERROR | D_HA | D_CONFIG | D_IOCTL);
59 CFS_MODULE_PARM(libcfs_debug, "i", int, 0644,
60 "Lustre kernel debug mask");
61 EXPORT_SYMBOL(libcfs_debug);
63 int libcfs_debug_mb = -1;
64 CFS_MODULE_PARM(libcfs_debug_mb, "i", int, 0644,
65 "Total debug buffer size.");
66 EXPORT_SYMBOL(libcfs_debug_mb);
68 unsigned int libcfs_printk = D_CANTMASK;
69 CFS_MODULE_PARM(libcfs_printk, "i", uint, 0644,
70 "Lustre kernel debug console mask");
71 EXPORT_SYMBOL(libcfs_printk);
73 unsigned int libcfs_console_ratelimit = 1;
74 CFS_MODULE_PARM(libcfs_console_ratelimit, "i", uint, 0644,
75 "Lustre kernel debug console ratelimit (0 to disable)");
76 EXPORT_SYMBOL(libcfs_console_ratelimit);
78 cfs_duration_t libcfs_console_max_delay;
79 CFS_MODULE_PARM(libcfs_console_max_delay, "l", ulong, 0644,
80 "Lustre kernel debug console max delay (jiffies)");
81 EXPORT_SYMBOL(libcfs_console_max_delay);
83 cfs_duration_t libcfs_console_min_delay;
84 CFS_MODULE_PARM(libcfs_console_min_delay, "l", ulong, 0644,
85 "Lustre kernel debug console min delay (jiffies)");
86 EXPORT_SYMBOL(libcfs_console_min_delay);
88 unsigned int libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
89 CFS_MODULE_PARM(libcfs_console_backoff, "i", uint, 0644,
90 "Lustre kernel debug console backoff factor");
91 EXPORT_SYMBOL(libcfs_console_backoff);
93 unsigned int libcfs_debug_binary = 1;
94 EXPORT_SYMBOL(libcfs_debug_binary);
96 unsigned int libcfs_stack;
97 EXPORT_SYMBOL(libcfs_stack);
99 unsigned int portal_enter_debugger;
100 EXPORT_SYMBOL(portal_enter_debugger);
102 unsigned int libcfs_catastrophe;
103 EXPORT_SYMBOL(libcfs_catastrophe);
105 unsigned int libcfs_panic_on_lbug = 0;
106 CFS_MODULE_PARM(libcfs_panic_on_lbug, "i", uint, 0644,
107 "Lustre kernel panic on LBUG");
108 EXPORT_SYMBOL(libcfs_panic_on_lbug);
110 atomic_t libcfs_kmemory = ATOMIC_INIT(0);
111 EXPORT_SYMBOL(libcfs_kmemory);
113 static cfs_waitq_t debug_ctlwq;
115 #ifdef HAVE_BGL_SUPPORT
116 char debug_file_path[1024] = "/bgl/ion/tmp/lustre-log";
117 #elif defined(__arch_um__)
118 char debug_file_path[1024] = "/r/tmp/lustre-log";
120 char debug_file_path[1024] = "/tmp/lustre-log";
122 char *debug_file_path_p = &debug_file_path[0];
124 CFS_MODULE_PARM(debug_file_path_p, "s", charp, 0644,
125 "Path for dumping debug logs, "
126 "set 'NONE' to prevent log dumping");
128 int libcfs_panic_in_progress;
130 /* libcfs_debug_token2mask() expects the returned
131 * string in lower-case */
133 libcfs_debug_subsys2str(int subsys)
187 /* libcfs_debug_token2mask() expects the returned
188 * string in lower-case */
190 libcfs_debug_dbg2str(int debug)
255 libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys)
257 const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
258 libcfs_debug_dbg2str;
264 if (mask == 0) { /* "0" */
268 } else { /* space-separated tokens */
269 for (i = 0; i < 32; i++) {
272 if ((mask & bit) == 0)
276 if (token == NULL) /* unused bit */
279 if (len > 0) { /* separator? */
285 while (*token != 0) {
294 /* terminate 'str' */
304 libcfs_debug_token2mask(int *mask, const char *str, int len, int is_subsys)
306 const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
307 libcfs_debug_dbg2str;
313 /* match against known tokens */
314 for (i = 0; i < 32; i++) {
318 if (token == NULL) /* unused? */
323 if (j == len) { /* end of token */
334 if (str[j] == token[j])
337 if (str[j] < 'A' || 'Z' < str[j])
340 if (str[j] - 'A' + 'a' != token[j])
345 return -EINVAL; /* no match */
349 libcfs_debug_str2mask(int *mask, const char *str, int is_subsys)
357 /* Allow a number for backwards compatibility */
359 for (n = strlen(str); n > 0; n--)
360 if (!isspace(str[n-1]))
364 if ((t = sscanf(str, "%i%n", &m, &matched)) >= 1 &&
370 /* <str> must be a list of debug tokens or numbers separated by
371 * whitespace and optionally an operator ('+' or '-'). If an operator
372 * appears first in <str>, '*mask' is used as the starting point
373 * (relative), otherwise 0 is used (absolute). An operator applies to
374 * all following tokens up to the next operator. */
378 while (isspace(*str)) /* skip whitespace */
384 if (*str == '+' || *str == '-') {
387 /* op on first token == relative */
391 while (isspace(*str)) /* skip whitespace */
394 if (*str == 0) /* trailing op */
398 /* find token length */
399 for (n = 0; str[n] != 0 && !isspace(str[n]); n++);
402 if (libcfs_debug_token2mask(&t, str, n, is_subsys) != 0)
421 void libcfs_debug_dumplog_internal(void *arg)
423 CFS_DECL_JOURNAL_DATA;
427 if (strncmp(debug_file_path, "NONE", 4) != 0) {
428 snprintf(debug_file_name, sizeof(debug_file_name) - 1,
429 "%s.%ld.%ld", debug_file_path, cfs_time_current_sec(),
431 printk(KERN_ALERT "LustreError: dumping log to %s\n",
433 tracefile_dump_all_pages(debug_file_name);
438 int libcfs_debug_dumplog_thread(void *arg)
441 libcfs_debug_dumplog_internal(arg);
442 cfs_waitq_signal(&debug_ctlwq);
446 void libcfs_debug_dumplog(void)
452 /* we're being careful to ensure that the kernel thread is
453 * able to set our state to running as it exits before we
454 * get to schedule() */
455 cfs_waitlink_init(&wait);
456 set_current_state(TASK_INTERRUPTIBLE);
457 cfs_waitq_add(&debug_ctlwq, &wait);
459 rc = cfs_kernel_thread(libcfs_debug_dumplog_thread,
460 (void *)(long)cfs_curproc_pid(),
461 CLONE_VM | CLONE_FS | CLONE_FILES);
463 printk(KERN_ERR "LustreError: cannot start log dump thread: "
466 cfs_waitq_wait(&wait, CFS_TASK_INTERRUPTIBLE);
468 /* be sure to teardown if kernel_thread() failed */
469 cfs_waitq_del(&debug_ctlwq, &wait);
470 set_current_state(TASK_RUNNING);
473 int libcfs_debug_init(unsigned long bufsize)
476 int max = libcfs_debug_mb;
478 cfs_waitq_init(&debug_ctlwq);
479 libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
480 libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
481 /* If libcfs_debug_mb is set to an invalid value or uninitialized
482 * then just make the total buffers smp_num_cpus * TCD_MAX_PAGES */
483 if (max > trace_max_debug_mb() || max < num_possible_cpus()) {
486 max = (max / num_possible_cpus());
487 max = (max << (20 - CFS_PAGE_SHIFT));
489 rc = tracefile_init(max);
492 libcfs_register_panic_notifier();
497 int libcfs_debug_cleanup(void)
499 libcfs_unregister_panic_notifier();
504 int libcfs_debug_clear_buffer(void)
510 /* Debug markers, although printed by S_LNET
511 * should not be be marked as such. */
512 #undef DEBUG_SUBSYSTEM
513 #define DEBUG_SUBSYSTEM S_UNDEFINED
514 int libcfs_debug_mark_buffer(char *text)
516 CDEBUG(D_TRACE,"***************************************************\n");
517 CDEBUG(D_WARNING, "DEBUG MARKER: %s\n", text);
518 CDEBUG(D_TRACE,"***************************************************\n");
522 #undef DEBUG_SUBSYSTEM
523 #define DEBUG_SUBSYSTEM S_LNET
525 void libcfs_debug_set_level(unsigned int debug_level)
527 printk(KERN_WARNING "Lustre: Setting portals debug level to %08x\n",
529 libcfs_debug = debug_level;
532 EXPORT_SYMBOL(libcfs_debug_dumplog);
533 EXPORT_SYMBOL(libcfs_debug_set_level);