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);
180 cfs_trace_free_string_buffer(tmpstr, tmpstrlen);
184 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
185 /* Always print LBUG/LASSERT to console, so keep this mask */
190 cfs_trace_free_string_buffer(tmpstr, tmpstrlen);
194 DECLARE_PROC_HANDLER(proc_dobitmasks)
196 static int min_watchdog_ratelimit = 0; /* disable ratelimiting */
197 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
199 static int __proc_dump_kernel(void *data, int write,
200 loff_t pos, void *buffer, int nob)
205 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
208 DECLARE_PROC_HANDLER(proc_dump_kernel)
210 static int __proc_daemon_file(void *data, int write,
211 loff_t pos, void *buffer, int nob)
214 int len = strlen(cfs_tracefile);
219 return cfs_trace_copyout_string(buffer, nob,
220 cfs_tracefile + pos, "\n");
223 return cfs_trace_daemon_command_usrstr(buffer, nob);
226 DECLARE_PROC_HANDLER(proc_daemon_file)
228 static int __proc_debug_mb(void *data, int write,
229 loff_t pos, void *buffer, int nob)
233 int len = snprintf(tmpstr, sizeof(tmpstr), "%d",
234 cfs_trace_get_debug_mb());
239 return cfs_trace_copyout_string(buffer, nob, tmpstr + pos,
243 return cfs_trace_set_debug_mb_usrstr(buffer, nob);
246 DECLARE_PROC_HANDLER(proc_debug_mb)
248 int LL_PROC_PROTO(proc_console_max_delay_cs)
250 int rc, max_delay_cs;
251 cfs_sysctl_table_t dummy = *table;
254 dummy.data = &max_delay_cs;
255 dummy.proc_handler = &proc_dointvec;
257 if (!write) { /* read */
258 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
259 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
265 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
268 if (max_delay_cs <= 0)
271 d = cfs_time_seconds(max_delay_cs) / 100;
272 if (d == 0 || d < libcfs_console_min_delay)
274 libcfs_console_max_delay = d;
279 int LL_PROC_PROTO(proc_console_min_delay_cs)
281 int rc, min_delay_cs;
282 cfs_sysctl_table_t dummy = *table;
285 dummy.data = &min_delay_cs;
286 dummy.proc_handler = &proc_dointvec;
288 if (!write) { /* read */
289 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
290 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
296 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
299 if (min_delay_cs <= 0)
302 d = cfs_time_seconds(min_delay_cs) / 100;
303 if (d == 0 || d > libcfs_console_max_delay)
305 libcfs_console_min_delay = d;
310 int LL_PROC_PROTO(proc_console_backoff)
313 cfs_sysctl_table_t dummy = *table;
315 dummy.data = &backoff;
316 dummy.proc_handler = &proc_dointvec;
318 if (!write) { /* read */
319 backoff= libcfs_console_backoff;
320 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
326 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
332 libcfs_console_backoff = backoff;
337 int LL_PROC_PROTO(libcfs_force_lbug)
344 int LL_PROC_PROTO(proc_fail_loc)
347 long old_fail_loc = cfs_fail_loc;
349 rc = ll_proc_dolongvec(table, write, filp, buffer, lenp, ppos);
350 if (old_fail_loc != cfs_fail_loc)
351 cfs_waitq_signal(&cfs_race_waitq);
355 static int __proc_cpt_table(void *data, int write,
356 loff_t pos, void *buffer, int nob)
365 LASSERT(cfs_cpt_table != NULL);
368 LIBCFS_ALLOC(buf, len);
372 rc = cfs_cpt_table_print(cfs_cpt_table, buf, len);
376 LIBCFS_FREE(buf, len);
389 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
392 LIBCFS_FREE(buf, len);
395 DECLARE_PROC_HANDLER(proc_cpt_table)
397 static cfs_sysctl_table_t lnet_table[] = {
399 * NB No .strategy entries have been provided since sysctl(8) prefers
400 * to go via /proc for portability.
403 INIT_CTL_NAME(PSDEV_DEBUG)
405 .data = &libcfs_debug,
406 .maxlen = sizeof(int),
408 .proc_handler = &proc_dobitmasks,
411 INIT_CTL_NAME(PSDEV_SUBSYSTEM_DEBUG)
412 .procname = "subsystem_debug",
413 .data = &libcfs_subsystem_debug,
414 .maxlen = sizeof(int),
416 .proc_handler = &proc_dobitmasks,
419 INIT_CTL_NAME(PSDEV_PRINTK)
420 .procname = "printk",
421 .data = &libcfs_printk,
422 .maxlen = sizeof(int),
424 .proc_handler = &proc_dobitmasks,
427 INIT_CTL_NAME(PSDEV_CONSOLE_RATELIMIT)
428 .procname = "console_ratelimit",
429 .data = &libcfs_console_ratelimit,
430 .maxlen = sizeof(int),
432 .proc_handler = &proc_dointvec
435 INIT_CTL_NAME(PSDEV_CONSOLE_MAX_DELAY_CS)
436 .procname = "console_max_delay_centisecs",
437 .maxlen = sizeof(int),
439 .proc_handler = &proc_console_max_delay_cs
442 INIT_CTL_NAME(PSDEV_CONSOLE_MIN_DELAY_CS)
443 .procname = "console_min_delay_centisecs",
444 .maxlen = sizeof(int),
446 .proc_handler = &proc_console_min_delay_cs
449 INIT_CTL_NAME(PSDEV_CONSOLE_BACKOFF)
450 .procname = "console_backoff",
451 .maxlen = sizeof(int),
453 .proc_handler = &proc_console_backoff
457 INIT_CTL_NAME(PSDEV_DEBUG_PATH)
458 .procname = "debug_path",
459 .data = libcfs_debug_file_path_arr,
460 .maxlen = sizeof(libcfs_debug_file_path_arr),
462 .proc_handler = &proc_dostring,
466 INIT_CTL_NAME(PSDEV_CPT_TABLE)
467 .procname = "cpu_partition_table",
470 .proc_handler = &proc_cpt_table,
474 INIT_CTL_NAME(PSDEV_LNET_UPCALL)
475 .procname = "upcall",
477 .maxlen = sizeof(lnet_upcall),
479 .proc_handler = &proc_dostring,
482 INIT_CTL_NAME(PSDEV_LNET_DEBUG_LOG_UPCALL)
483 .procname = "debug_log_upcall",
484 .data = lnet_debug_log_upcall,
485 .maxlen = sizeof(lnet_debug_log_upcall),
487 .proc_handler = &proc_dostring,
490 INIT_CTL_NAME(PSDEV_LNET_MEMUSED)
491 .procname = "lnet_memused",
492 .data = (int *)&libcfs_kmemory.counter,
493 .maxlen = sizeof(int),
495 .proc_handler = &proc_dointvec,
496 INIT_STRATEGY(&sysctl_intvec)
499 INIT_CTL_NAME(PSDEV_LNET_CATASTROPHE)
500 .procname = "catastrophe",
501 .data = &libcfs_catastrophe,
502 .maxlen = sizeof(int),
504 .proc_handler = &proc_dointvec,
505 INIT_STRATEGY(&sysctl_intvec)
508 INIT_CTL_NAME(PSDEV_LNET_PANIC_ON_LBUG)
509 .procname = "panic_on_lbug",
510 .data = &libcfs_panic_on_lbug,
511 .maxlen = sizeof(int),
513 .proc_handler = &proc_dointvec,
514 INIT_STRATEGY(&sysctl_intvec)
517 INIT_CTL_NAME(PSDEV_LNET_DUMP_KERNEL)
518 .procname = "dump_kernel",
521 .proc_handler = &proc_dump_kernel,
524 INIT_CTL_NAME(PSDEV_LNET_DAEMON_FILE)
525 .procname = "daemon_file",
528 .proc_handler = &proc_daemon_file,
531 INIT_CTL_NAME(PSDEV_LNET_DEBUG_MB)
532 .procname = "debug_mb",
534 .proc_handler = &proc_debug_mb,
537 INIT_CTL_NAME(PSDEV_LNET_WATCHDOG_RATELIMIT)
538 .procname = "watchdog_ratelimit",
539 .data = &libcfs_watchdog_ratelimit,
540 .maxlen = sizeof(int),
542 .proc_handler = &proc_dointvec_minmax,
543 .extra1 = &min_watchdog_ratelimit,
544 .extra2 = &max_watchdog_ratelimit,
546 { INIT_CTL_NAME(PSDEV_LNET_FORCE_LBUG)
547 .procname = "force_lbug",
551 .proc_handler = &libcfs_force_lbug
554 INIT_CTL_NAME(PSDEV_LNET_FAIL_LOC)
555 .procname = "fail_loc",
556 .data = &cfs_fail_loc,
557 .maxlen = sizeof(cfs_fail_loc),
559 .proc_handler = &proc_fail_loc
562 INIT_CTL_NAME(PSDEV_LNET_FAIL_VAL)
563 .procname = "fail_val",
564 .data = &cfs_fail_val,
565 .maxlen = sizeof(int),
567 .proc_handler = &proc_dointvec
575 static cfs_sysctl_table_t top_table[] = {
577 INIT_CTL_NAME(CTL_LNET)
589 int insert_proc(void)
591 if (lnet_table_header == NULL)
592 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
597 void remove_proc(void)
600 if (lnet_table_header != NULL)
601 cfs_unregister_sysctl_table(lnet_table_header);
603 lnet_table_header = NULL;