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 | D_NETERROR);
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 char debug_file_path_arr[1024] = DEBUG_FILE_PATH_DEFAULT;
117 /* We need to pass a pointer here, but elsewhere this must be a const */
118 static char *debug_file_path = &debug_file_path_arr[0];
119 CFS_MODULE_PARM(debug_file_path, "s", charp, 0644,
120 "Path for dumping debug logs, "
121 "set 'NONE' to prevent log dumping");
123 int libcfs_panic_in_progress;
125 /* libcfs_debug_token2mask() expects the returned
126 * string in lower-case */
128 libcfs_debug_subsys2str(int subsys)
130 switch (1 << subsys) {
184 /* libcfs_debug_token2mask() expects the returned
185 * string in lower-case */
187 libcfs_debug_dbg2str(int debug)
189 switch (1 << debug) {
252 libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys)
254 const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
255 libcfs_debug_dbg2str;
260 if (mask == 0) { /* "0" */
264 } else { /* space-separated tokens */
265 for (i = 0; i < 32; i++) {
266 if ((mask & (1 << i)) == 0)
270 if (token == NULL) /* unused bit */
273 if (len > 0) { /* separator? */
279 while (*token != 0) {
288 /* terminate 'str' */
298 libcfs_debug_str2mask(int *mask, const char *str, int is_subsys)
300 const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
301 libcfs_debug_dbg2str;
307 /* Allow a number for backwards compatibility */
309 for (n = strlen(str); n > 0; n--)
310 if (!isspace(str[n-1]))
314 if ((t = sscanf(str, "%i%n", &m, &matched)) >= 1 &&
320 return libcfs_str2mask(str, fn, mask, is_subsys ? 0 : D_CANTMASK,
325 * Dump Lustre log to ::debug_file_path by calling tracefile_dump_all_pages()
327 void libcfs_debug_dumplog_internal(void *arg)
329 CFS_DECL_JOURNAL_DATA;
333 if (strncmp(debug_file_path_arr, "NONE", 4) != 0) {
334 snprintf(debug_file_name, sizeof(debug_file_name) - 1,
335 "%s.%ld." LPLD, debug_file_path_arr,
336 cfs_time_current_sec(), (long_ptr_t)arg);
337 printk(KERN_ALERT "LustreError: dumping log to %s\n",
339 tracefile_dump_all_pages(debug_file_name);
340 libcfs_run_debug_log_upcall(debug_file_name);
345 int libcfs_debug_dumplog_thread(void *arg)
348 libcfs_debug_dumplog_internal(arg);
349 cfs_waitq_signal(&debug_ctlwq);
353 void libcfs_debug_dumplog(void)
359 /* we're being careful to ensure that the kernel thread is
360 * able to set our state to running as it exits before we
361 * get to schedule() */
362 cfs_waitlink_init(&wait);
363 set_current_state(TASK_INTERRUPTIBLE);
364 cfs_waitq_add(&debug_ctlwq, &wait);
366 rc = cfs_kernel_thread(libcfs_debug_dumplog_thread,
367 (void *)(long_ptr_t)cfs_curproc_pid(),
368 CLONE_VM | CLONE_FS | CLONE_FILES);
370 printk(KERN_ERR "LustreError: cannot start log dump thread: "
373 cfs_waitq_wait(&wait, CFS_TASK_INTERRUPTIBLE);
375 /* be sure to teardown if kernel_thread() failed */
376 cfs_waitq_del(&debug_ctlwq, &wait);
377 set_current_state(TASK_RUNNING);
380 int libcfs_debug_init(unsigned long bufsize)
383 int max = libcfs_debug_mb;
385 cfs_waitq_init(&debug_ctlwq);
386 libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
387 libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
388 /* If libcfs_debug_mb is set to an invalid value or uninitialized
389 * then just make the total buffers smp_num_cpus * TCD_MAX_PAGES */
390 if (max > trace_max_debug_mb() || max < num_possible_cpus()) {
393 max = (max / num_possible_cpus());
394 max = (max << (20 - CFS_PAGE_SHIFT));
396 rc = tracefile_init(max);
399 libcfs_register_panic_notifier();
404 int libcfs_debug_cleanup(void)
406 libcfs_unregister_panic_notifier();
411 int libcfs_debug_clear_buffer(void)
417 /* Debug markers, although printed by S_LNET
418 * should not be be marked as such. */
419 #undef DEBUG_SUBSYSTEM
420 #define DEBUG_SUBSYSTEM S_UNDEFINED
421 int libcfs_debug_mark_buffer(const char *text)
423 CDEBUG(D_TRACE,"***************************************************\n");
424 CDEBUG(D_WARNING, "DEBUG MARKER: %s\n", text);
425 CDEBUG(D_TRACE,"***************************************************\n");
429 #undef DEBUG_SUBSYSTEM
430 #define DEBUG_SUBSYSTEM S_LNET
432 void libcfs_debug_set_level(unsigned int debug_level)
434 printk(KERN_WARNING "Lustre: Setting portals debug level to %08x\n",
436 libcfs_debug = debug_level;
439 EXPORT_SYMBOL(libcfs_debug_dumplog);
440 EXPORT_SYMBOL(libcfs_debug_set_level);