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, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/libcfs/linux/linux-proc.c
38 * Author: Zach Brown <zab@zabbo.net>
39 * Author: Peter J. Braam <braam@clusterfs.com>
40 * Author: Phil Schwan <phil@clusterfs.com>
43 #include <linux/module.h>
44 #include <linux/kernel.h>
46 #include <linux/string.h>
47 #include <linux/stat.h>
48 #include <linux/errno.h>
49 #include <linux/unistd.h>
51 #include <linux/uio.h>
53 #include <asm/system.h>
54 #include <asm/uaccess.h>
57 #include <linux/file.h>
58 #include <linux/stat.h>
59 #include <linux/list.h>
60 #include <asm/uaccess.h>
62 #include <linux/proc_fs.h>
63 #include <linux/sysctl.h>
65 # define DEBUG_SUBSYSTEM S_LNET
67 #include <libcfs/libcfs.h>
68 #include <asm/div64.h>
69 #include "tracefile.h"
72 static cfs_sysctl_table_header_t *lnet_table_header = NULL;
74 extern char lnet_upcall[1024];
76 * The path of debug log dump upcall script.
78 extern char lnet_debug_log_upcall[1024];
80 #ifndef HAVE_SYSCTL_UNNUMBERED
81 #define CTL_LNET (0x100)
83 PSDEV_DEBUG = 1, /* control debugging */
84 PSDEV_SUBSYSTEM_DEBUG, /* control debugging */
85 PSDEV_PRINTK, /* force all messages to console */
86 PSDEV_CONSOLE_RATELIMIT, /* ratelimit console messages */
87 PSDEV_CONSOLE_MAX_DELAY_CS, /* maximum delay over which we skip messages */
88 PSDEV_CONSOLE_MIN_DELAY_CS, /* initial delay over which we skip messages */
89 PSDEV_CONSOLE_BACKOFF, /* delay increase factor */
90 PSDEV_DEBUG_PATH, /* crashdump log location */
91 PSDEV_DEBUG_DUMP_PATH, /* crashdump tracelog location */
92 PSDEV_CPT_TABLE, /* information about cpu partitions */
93 PSDEV_LNET_UPCALL, /* User mode upcall script */
94 PSDEV_LNET_MEMUSED, /* bytes currently PORTAL_ALLOCated */
95 PSDEV_LNET_CATASTROPHE, /* if we have LBUGged or panic'd */
96 PSDEV_LNET_PANIC_ON_LBUG, /* flag to panic on LBUG */
97 PSDEV_LNET_DUMP_KERNEL, /* snapshot kernel debug buffer to file */
98 PSDEV_LNET_DAEMON_FILE, /* spool kernel debug buffer to file */
99 PSDEV_LNET_DEBUG_MB, /* size of debug buffer */
100 PSDEV_LNET_DEBUG_LOG_UPCALL, /* debug log upcall script */
101 PSDEV_LNET_WATCHDOG_RATELIMIT, /* ratelimit watchdog messages */
102 PSDEV_LNET_FORCE_LBUG, /* hook to force an LBUG */
103 PSDEV_LNET_FAIL_LOC, /* control test failures instrumentation */
104 PSDEV_LNET_FAIL_VAL, /* userdata for fail loc */
107 #define CTL_LNET CTL_UNNUMBERED
108 #define PSDEV_DEBUG CTL_UNNUMBERED
109 #define PSDEV_SUBSYSTEM_DEBUG CTL_UNNUMBERED
110 #define PSDEV_PRINTK CTL_UNNUMBERED
111 #define PSDEV_CONSOLE_RATELIMIT CTL_UNNUMBERED
112 #define PSDEV_CONSOLE_MAX_DELAY_CS CTL_UNNUMBERED
113 #define PSDEV_CONSOLE_MIN_DELAY_CS CTL_UNNUMBERED
114 #define PSDEV_CONSOLE_BACKOFF CTL_UNNUMBERED
115 #define PSDEV_DEBUG_PATH CTL_UNNUMBERED
116 #define PSDEV_DEBUG_DUMP_PATH CTL_UNNUMBERED
117 #define PSDEV_CPT_TABLE CTL_UNNUMBERED
118 #define PSDEV_LNET_UPCALL CTL_UNNUMBERED
119 #define PSDEV_LNET_MEMUSED CTL_UNNUMBERED
120 #define PSDEV_LNET_CATASTROPHE CTL_UNNUMBERED
121 #define PSDEV_LNET_PANIC_ON_LBUG CTL_UNNUMBERED
122 #define PSDEV_LNET_DUMP_KERNEL CTL_UNNUMBERED
123 #define PSDEV_LNET_DAEMON_FILE CTL_UNNUMBERED
124 #define PSDEV_LNET_DEBUG_MB CTL_UNNUMBERED
125 #define PSDEV_LNET_DEBUG_LOG_UPCALL CTL_UNNUMBERED
126 #define PSDEV_LNET_WATCHDOG_RATELIMIT CTL_UNNUMBERED
127 #define PSDEV_LNET_FORCE_LBUG CTL_UNNUMBERED
128 #define PSDEV_LNET_FAIL_LOC CTL_UNNUMBERED
129 #define PSDEV_LNET_FAIL_VAL CTL_UNNUMBERED
133 proc_call_handler(void *data, int write,
134 loff_t *ppos, void *buffer, size_t *lenp,
135 int (*handler)(void *data, int write,
136 loff_t pos, void *buffer, int len))
138 int rc = handler(data, write, *ppos, buffer, *lenp);
151 EXPORT_SYMBOL(proc_call_handler);
153 static int __proc_dobitmasks(void *data, int write,
154 loff_t pos, void *buffer, int nob)
156 const int tmpstrlen = 512;
159 unsigned int *mask = data;
160 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
161 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
163 rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
168 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
174 rc = cfs_trace_copyout_string(buffer, nob,
178 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
182 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
183 /* Always print LBUG/LASSERT to console, so keep this mask */
188 cfs_trace_free_string_buffer(tmpstr, tmpstrlen);
192 DECLARE_PROC_HANDLER(proc_dobitmasks)
194 static int min_watchdog_ratelimit = 0; /* disable ratelimiting */
195 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
197 static int __proc_dump_kernel(void *data, int write,
198 loff_t pos, void *buffer, int nob)
203 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
206 DECLARE_PROC_HANDLER(proc_dump_kernel)
208 static int __proc_daemon_file(void *data, int write,
209 loff_t pos, void *buffer, int nob)
212 int len = strlen(cfs_tracefile);
217 return cfs_trace_copyout_string(buffer, nob,
218 cfs_tracefile + pos, "\n");
221 return cfs_trace_daemon_command_usrstr(buffer, nob);
224 DECLARE_PROC_HANDLER(proc_daemon_file)
226 static int __proc_debug_mb(void *data, int write,
227 loff_t pos, void *buffer, int nob)
231 int len = snprintf(tmpstr, sizeof(tmpstr), "%d",
232 cfs_trace_get_debug_mb());
237 return cfs_trace_copyout_string(buffer, nob, tmpstr + pos,
241 return cfs_trace_set_debug_mb_usrstr(buffer, nob);
244 DECLARE_PROC_HANDLER(proc_debug_mb)
246 int LL_PROC_PROTO(proc_console_max_delay_cs)
248 int rc, max_delay_cs;
249 cfs_sysctl_table_t dummy = *table;
252 dummy.data = &max_delay_cs;
253 dummy.proc_handler = &proc_dointvec;
255 if (!write) { /* read */
256 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
257 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
263 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
266 if (max_delay_cs <= 0)
269 d = cfs_time_seconds(max_delay_cs) / 100;
270 if (d == 0 || d < libcfs_console_min_delay)
272 libcfs_console_max_delay = d;
277 int LL_PROC_PROTO(proc_console_min_delay_cs)
279 int rc, min_delay_cs;
280 cfs_sysctl_table_t dummy = *table;
283 dummy.data = &min_delay_cs;
284 dummy.proc_handler = &proc_dointvec;
286 if (!write) { /* read */
287 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
288 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
294 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
297 if (min_delay_cs <= 0)
300 d = cfs_time_seconds(min_delay_cs) / 100;
301 if (d == 0 || d > libcfs_console_max_delay)
303 libcfs_console_min_delay = d;
308 int LL_PROC_PROTO(proc_console_backoff)
311 cfs_sysctl_table_t dummy = *table;
313 dummy.data = &backoff;
314 dummy.proc_handler = &proc_dointvec;
316 if (!write) { /* read */
317 backoff= libcfs_console_backoff;
318 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
324 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
330 libcfs_console_backoff = backoff;
335 int LL_PROC_PROTO(libcfs_force_lbug)
342 int LL_PROC_PROTO(proc_fail_loc)
345 long old_fail_loc = cfs_fail_loc;
347 rc = ll_proc_dolongvec(table, write, filp, buffer, lenp, ppos);
348 if (old_fail_loc != cfs_fail_loc)
349 cfs_waitq_signal(&cfs_race_waitq);
353 static int __proc_cpt_table(void *data, int write,
354 loff_t pos, void *buffer, int nob)
363 LASSERT(cfs_cpt_table != NULL);
366 LIBCFS_ALLOC(buf, len);
370 rc = cfs_cpt_table_print(cfs_cpt_table, buf, len);
374 LIBCFS_FREE(buf, len);
387 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
390 LIBCFS_FREE(buf, len);
393 DECLARE_PROC_HANDLER(proc_cpt_table)
395 static cfs_sysctl_table_t lnet_table[] = {
397 * NB No .strategy entries have been provided since sysctl(8) prefers
398 * to go via /proc for portability.
401 INIT_CTL_NAME(PSDEV_DEBUG)
403 .data = &libcfs_debug,
404 .maxlen = sizeof(int),
406 .proc_handler = &proc_dobitmasks,
409 INIT_CTL_NAME(PSDEV_SUBSYSTEM_DEBUG)
410 .procname = "subsystem_debug",
411 .data = &libcfs_subsystem_debug,
412 .maxlen = sizeof(int),
414 .proc_handler = &proc_dobitmasks,
417 INIT_CTL_NAME(PSDEV_PRINTK)
418 .procname = "printk",
419 .data = &libcfs_printk,
420 .maxlen = sizeof(int),
422 .proc_handler = &proc_dobitmasks,
425 INIT_CTL_NAME(PSDEV_CONSOLE_RATELIMIT)
426 .procname = "console_ratelimit",
427 .data = &libcfs_console_ratelimit,
428 .maxlen = sizeof(int),
430 .proc_handler = &proc_dointvec
433 INIT_CTL_NAME(PSDEV_CONSOLE_MAX_DELAY_CS)
434 .procname = "console_max_delay_centisecs",
435 .maxlen = sizeof(int),
437 .proc_handler = &proc_console_max_delay_cs
440 INIT_CTL_NAME(PSDEV_CONSOLE_MIN_DELAY_CS)
441 .procname = "console_min_delay_centisecs",
442 .maxlen = sizeof(int),
444 .proc_handler = &proc_console_min_delay_cs
447 INIT_CTL_NAME(PSDEV_CONSOLE_BACKOFF)
448 .procname = "console_backoff",
449 .maxlen = sizeof(int),
451 .proc_handler = &proc_console_backoff
455 INIT_CTL_NAME(PSDEV_DEBUG_PATH)
456 .procname = "debug_path",
457 .data = libcfs_debug_file_path_arr,
458 .maxlen = sizeof(libcfs_debug_file_path_arr),
460 .proc_handler = &proc_dostring,
464 INIT_CTL_NAME(PSDEV_CPT_TABLE)
465 .procname = "cpu_partition_table",
468 .proc_handler = &proc_cpt_table,
472 INIT_CTL_NAME(PSDEV_LNET_UPCALL)
473 .procname = "upcall",
475 .maxlen = sizeof(lnet_upcall),
477 .proc_handler = &proc_dostring,
480 INIT_CTL_NAME(PSDEV_LNET_DEBUG_LOG_UPCALL)
481 .procname = "debug_log_upcall",
482 .data = lnet_debug_log_upcall,
483 .maxlen = sizeof(lnet_debug_log_upcall),
485 .proc_handler = &proc_dostring,
488 INIT_CTL_NAME(PSDEV_LNET_MEMUSED)
489 .procname = "lnet_memused",
490 .data = (int *)&libcfs_kmemory.counter,
491 .maxlen = sizeof(int),
493 .proc_handler = &proc_dointvec,
494 INIT_STRATEGY(&sysctl_intvec)
497 INIT_CTL_NAME(PSDEV_LNET_CATASTROPHE)
498 .procname = "catastrophe",
499 .data = &libcfs_catastrophe,
500 .maxlen = sizeof(int),
502 .proc_handler = &proc_dointvec,
503 INIT_STRATEGY(&sysctl_intvec)
506 INIT_CTL_NAME(PSDEV_LNET_PANIC_ON_LBUG)
507 .procname = "panic_on_lbug",
508 .data = &libcfs_panic_on_lbug,
509 .maxlen = sizeof(int),
511 .proc_handler = &proc_dointvec,
512 INIT_STRATEGY(&sysctl_intvec)
515 INIT_CTL_NAME(PSDEV_LNET_DUMP_KERNEL)
516 .procname = "dump_kernel",
519 .proc_handler = &proc_dump_kernel,
522 INIT_CTL_NAME(PSDEV_LNET_DAEMON_FILE)
523 .procname = "daemon_file",
526 .proc_handler = &proc_daemon_file,
529 INIT_CTL_NAME(PSDEV_LNET_DEBUG_MB)
530 .procname = "debug_mb",
532 .proc_handler = &proc_debug_mb,
535 INIT_CTL_NAME(PSDEV_LNET_WATCHDOG_RATELIMIT)
536 .procname = "watchdog_ratelimit",
537 .data = &libcfs_watchdog_ratelimit,
538 .maxlen = sizeof(int),
540 .proc_handler = &proc_dointvec_minmax,
541 .extra1 = &min_watchdog_ratelimit,
542 .extra2 = &max_watchdog_ratelimit,
544 { INIT_CTL_NAME(PSDEV_LNET_FORCE_LBUG)
545 .procname = "force_lbug",
549 .proc_handler = &libcfs_force_lbug
552 INIT_CTL_NAME(PSDEV_LNET_FAIL_LOC)
553 .procname = "fail_loc",
554 .data = &cfs_fail_loc,
555 .maxlen = sizeof(cfs_fail_loc),
557 .proc_handler = &proc_fail_loc
560 INIT_CTL_NAME(PSDEV_LNET_FAIL_VAL)
561 .procname = "fail_val",
562 .data = &cfs_fail_val,
563 .maxlen = sizeof(int),
565 .proc_handler = &proc_dointvec
573 static cfs_sysctl_table_t top_table[] = {
575 INIT_CTL_NAME(CTL_LNET)
587 int insert_proc(void)
589 if (lnet_table_header == NULL)
590 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
595 void remove_proc(void)
598 if (lnet_table_header != NULL)
599 cfs_unregister_sysctl_table(lnet_table_header);
601 lnet_table_header = NULL;