4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
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 DEBUG_SUBSYSTEM S_LNET
44 #include "../../include/linux/libcfs/libcfs.h"
45 #include "tracefile.h"
47 static char debug_file_name
[1024];
49 unsigned int libcfs_subsystem_debug
= ~0;
50 module_param(libcfs_subsystem_debug
, int, 0644);
51 MODULE_PARM_DESC(libcfs_subsystem_debug
, "Lustre kernel debug subsystem mask");
52 EXPORT_SYMBOL(libcfs_subsystem_debug
);
54 unsigned int libcfs_debug
= (D_CANTMASK
|
55 D_NETERROR
| D_HA
| D_CONFIG
| D_IOCTL
);
56 module_param(libcfs_debug
, int, 0644);
57 MODULE_PARM_DESC(libcfs_debug
, "Lustre kernel debug mask");
58 EXPORT_SYMBOL(libcfs_debug
);
60 unsigned int libcfs_debug_mb
= 0;
61 module_param(libcfs_debug_mb
, uint
, 0644);
62 MODULE_PARM_DESC(libcfs_debug_mb
, "Total debug buffer size.");
63 EXPORT_SYMBOL(libcfs_debug_mb
);
65 unsigned int libcfs_printk
= D_CANTMASK
;
66 module_param(libcfs_printk
, uint
, 0644);
67 MODULE_PARM_DESC(libcfs_printk
, "Lustre kernel debug console mask");
68 EXPORT_SYMBOL(libcfs_printk
);
70 unsigned int libcfs_console_ratelimit
= 1;
71 module_param(libcfs_console_ratelimit
, uint
, 0644);
72 MODULE_PARM_DESC(libcfs_console_ratelimit
, "Lustre kernel debug console ratelimit (0 to disable)");
73 EXPORT_SYMBOL(libcfs_console_ratelimit
);
75 unsigned int libcfs_console_max_delay
;
76 module_param(libcfs_console_max_delay
, uint
, 0644);
77 MODULE_PARM_DESC(libcfs_console_max_delay
, "Lustre kernel debug console max delay (jiffies)");
78 EXPORT_SYMBOL(libcfs_console_max_delay
);
80 unsigned int libcfs_console_min_delay
;
81 module_param(libcfs_console_min_delay
, uint
, 0644);
82 MODULE_PARM_DESC(libcfs_console_min_delay
, "Lustre kernel debug console min delay (jiffies)");
83 EXPORT_SYMBOL(libcfs_console_min_delay
);
85 unsigned int libcfs_console_backoff
= CDEBUG_DEFAULT_BACKOFF
;
86 module_param(libcfs_console_backoff
, uint
, 0644);
87 MODULE_PARM_DESC(libcfs_console_backoff
, "Lustre kernel debug console backoff factor");
88 EXPORT_SYMBOL(libcfs_console_backoff
);
90 unsigned int libcfs_debug_binary
= 1;
91 EXPORT_SYMBOL(libcfs_debug_binary
);
93 unsigned int libcfs_stack
= 3 * THREAD_SIZE
/ 4;
94 EXPORT_SYMBOL(libcfs_stack
);
96 unsigned int portal_enter_debugger
;
97 EXPORT_SYMBOL(portal_enter_debugger
);
99 unsigned int libcfs_catastrophe
;
100 EXPORT_SYMBOL(libcfs_catastrophe
);
102 unsigned int libcfs_watchdog_ratelimit
= 300;
103 EXPORT_SYMBOL(libcfs_watchdog_ratelimit
);
105 unsigned int libcfs_panic_on_lbug
= 1;
106 module_param(libcfs_panic_on_lbug
, uint
, 0644);
107 MODULE_PARM_DESC(libcfs_panic_on_lbug
, "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 wait_queue_head_t debug_ctlwq
;
115 char libcfs_debug_file_path_arr
[PATH_MAX
] = LIBCFS_DEBUG_FILE_PATH_DEFAULT
;
117 /* We need to pass a pointer here, but elsewhere this must be a const */
118 char *libcfs_debug_file_path
;
119 module_param(libcfs_debug_file_path
, charp
, 0644);
120 MODULE_PARM_DESC(libcfs_debug_file_path
,
121 "Path for dumping debug logs, 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
) {
186 /* libcfs_debug_token2mask() expects the returned
187 * string in lower-case */
189 libcfs_debug_dbg2str(int debug
)
191 switch (1 << debug
) {
256 libcfs_debug_mask2str(char *str
, int size
, int mask
, int is_subsys
)
258 const char *(*fn
)(int bit
) = is_subsys
? libcfs_debug_subsys2str
:
259 libcfs_debug_dbg2str
;
264 if (mask
== 0) { /* "0" */
268 } else { /* space-separated tokens */
269 for (i
= 0; i
< 32; i
++) {
270 if ((mask
& (1 << i
)) == 0)
274 if (token
== NULL
) /* unused bit */
277 if (len
> 0) { /* separator? */
283 while (*token
!= 0) {
292 /* terminate 'str' */
302 libcfs_debug_str2mask(int *mask
, const char *str
, int is_subsys
)
304 const char *(*fn
)(int bit
) = is_subsys
? libcfs_debug_subsys2str
:
305 libcfs_debug_dbg2str
;
311 /* Allow a number for backwards compatibility */
313 for (n
= strlen(str
); n
> 0; n
--)
314 if (!isspace(str
[n
-1]))
317 t
= sscanf(str
, "%i%n", &m
, &matched
);
318 if (t
>= 1 && matched
== n
) {
319 /* don't print warning for lctl set_param debug=0 or -1 */
320 if (m
!= 0 && m
!= -1)
321 CWARN("You are trying to use a numerical value for the mask - this will be deprecated in a future release.\n");
326 return cfs_str2mask(str
, fn
, mask
, is_subsys
? 0 : D_CANTMASK
,
331 * Dump Lustre log to ::debug_file_path by calling tracefile_dump_all_pages()
333 void libcfs_debug_dumplog_internal(void *arg
)
337 journal_info
= current
->journal_info
;
338 current
->journal_info
= NULL
;
340 if (strncmp(libcfs_debug_file_path_arr
, "NONE", 4) != 0) {
341 snprintf(debug_file_name
, sizeof(debug_file_name
) - 1,
342 "%s.%ld.%ld", libcfs_debug_file_path_arr
,
343 get_seconds(), (long_ptr_t
)arg
);
344 pr_alert("LustreError: dumping log to %s\n",
346 cfs_tracefile_dump_all_pages(debug_file_name
);
347 libcfs_run_debug_log_upcall(debug_file_name
);
350 current
->journal_info
= journal_info
;
353 int libcfs_debug_dumplog_thread(void *arg
)
355 libcfs_debug_dumplog_internal(arg
);
356 wake_up(&debug_ctlwq
);
360 void libcfs_debug_dumplog(void)
363 struct task_struct
*dumper
;
365 /* we're being careful to ensure that the kernel thread is
366 * able to set our state to running as it exits before we
367 * get to schedule() */
368 init_waitqueue_entry(&wait
, current
);
369 set_current_state(TASK_INTERRUPTIBLE
);
370 add_wait_queue(&debug_ctlwq
, &wait
);
372 dumper
= kthread_run(libcfs_debug_dumplog_thread
,
373 (void *)(long)current_pid(),
374 "libcfs_debug_dumper");
376 pr_err("LustreError: cannot start log dump thread: %ld\n",
381 /* be sure to teardown if cfs_create_thread() failed */
382 remove_wait_queue(&debug_ctlwq
, &wait
);
383 set_current_state(TASK_RUNNING
);
385 EXPORT_SYMBOL(libcfs_debug_dumplog
);
387 int libcfs_debug_init(unsigned long bufsize
)
390 unsigned int max
= libcfs_debug_mb
;
392 init_waitqueue_head(&debug_ctlwq
);
394 if (libcfs_console_max_delay
<= 0 || /* not set by user or */
395 libcfs_console_min_delay
<= 0 || /* set to invalid values */
396 libcfs_console_min_delay
>= libcfs_console_max_delay
) {
397 libcfs_console_max_delay
= CDEBUG_DEFAULT_MAX_DELAY
;
398 libcfs_console_min_delay
= CDEBUG_DEFAULT_MIN_DELAY
;
401 if (libcfs_debug_file_path
!= NULL
) {
402 strncpy(libcfs_debug_file_path_arr
,
403 libcfs_debug_file_path
, PATH_MAX
-1);
404 libcfs_debug_file_path_arr
[PATH_MAX
- 1] = '\0';
407 /* If libcfs_debug_mb is set to an invalid value or uninitialized
408 * then just make the total buffers smp_num_cpus * TCD_MAX_PAGES */
409 if (max
> cfs_trace_max_debug_mb() || max
< num_possible_cpus()) {
412 max
= (max
/ num_possible_cpus());
413 max
= max
<< (20 - PAGE_CACHE_SHIFT
);
415 rc
= cfs_tracefile_init(max
);
418 libcfs_register_panic_notifier();
423 int libcfs_debug_cleanup(void)
425 libcfs_unregister_panic_notifier();
426 cfs_tracefile_exit();
430 int libcfs_debug_clear_buffer(void)
432 cfs_trace_flush_pages();
436 /* Debug markers, although printed by S_LNET
437 * should not be be marked as such. */
438 #undef DEBUG_SUBSYSTEM
439 #define DEBUG_SUBSYSTEM S_UNDEFINED
440 int libcfs_debug_mark_buffer(const char *text
)
443 "***************************************************\n");
444 LCONSOLE(D_WARNING
, "DEBUG MARKER: %s\n", text
);
446 "***************************************************\n");
450 #undef DEBUG_SUBSYSTEM
451 #define DEBUG_SUBSYSTEM S_LNET
453 void libcfs_debug_set_level(unsigned int debug_level
)
455 pr_warn("Lustre: Setting portals debug level to %08x\n",
457 libcfs_debug
= debug_level
;
460 EXPORT_SYMBOL(libcfs_debug_set_level
);