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 (c) 2008, 2010, Oracle and/or its affiliates. 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/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>
44 # define EXPORT_SYMTAB
47 #ifndef AUTOCONF_INCLUDED
48 #include <linux/config.h>
50 #include <linux/module.h>
51 #include <linux/kernel.h>
53 #include <linux/string.h>
54 #include <linux/stat.h>
55 #include <linux/errno.h>
56 #include <linux/smp_lock.h>
57 #include <linux/unistd.h>
59 #include <linux/uio.h>
61 #include <asm/system.h>
62 #include <asm/uaccess.h>
65 #include <linux/file.h>
66 #include <linux/stat.h>
67 #include <linux/list.h>
68 #include <asm/uaccess.h>
70 #include <linux/proc_fs.h>
71 #include <linux/sysctl.h>
73 # define DEBUG_SUBSYSTEM S_LNET
75 #include <libcfs/libcfs.h>
76 #include <asm/div64.h>
77 #include "tracefile.h"
80 static cfs_sysctl_table_header_t *lnet_table_header = NULL;
82 extern char lnet_upcall[1024];
84 * The path of debug log dump upcall script.
86 extern char lnet_debug_log_upcall[1024];
88 #ifndef HAVE_SYSCTL_UNNUMBERED
89 #define CTL_LNET (0x100)
91 PSDEV_DEBUG = 1, /* control debugging */
92 PSDEV_SUBSYSTEM_DEBUG, /* control debugging */
93 PSDEV_PRINTK, /* force all messages to console */
94 PSDEV_CONSOLE_RATELIMIT, /* ratelimit console messages */
95 PSDEV_CONSOLE_MAX_DELAY_CS, /* maximum delay over which we skip messages */
96 PSDEV_CONSOLE_MIN_DELAY_CS, /* initial delay over which we skip messages */
97 PSDEV_CONSOLE_BACKOFF, /* delay increase factor */
98 PSDEV_DEBUG_PATH, /* crashdump log location */
99 PSDEV_DEBUG_DUMP_PATH, /* crashdump tracelog location */
100 PSDEV_LNET_UPCALL, /* User mode upcall script */
101 PSDEV_LNET_MEMUSED, /* bytes currently PORTAL_ALLOCated */
102 PSDEV_LNET_CATASTROPHE, /* if we have LBUGged or panic'd */
103 PSDEV_LNET_PANIC_ON_LBUG, /* flag to panic on LBUG */
104 PSDEV_LNET_DUMP_KERNEL, /* snapshot kernel debug buffer to file */
105 PSDEV_LNET_DAEMON_FILE, /* spool kernel debug buffer to file */
106 PSDEV_LNET_DEBUG_MB, /* size of debug buffer */
107 PSDEV_LNET_DEBUG_LOG_UPCALL, /* debug log upcall script */
108 PSDEV_LNET_WATCHDOG_RATELIMIT, /* ratelimit watchdog messages */
109 PSDEV_LNET_FORCE_LBUG, /* hook to force an LBUG */
112 #define CTL_LNET CTL_UNNUMBERED
113 #define PSDEV_DEBUG CTL_UNNUMBERED
114 #define PSDEV_SUBSYSTEM_DEBUG CTL_UNNUMBERED
115 #define PSDEV_PRINTK CTL_UNNUMBERED
116 #define PSDEV_CONSOLE_RATELIMIT CTL_UNNUMBERED
117 #define PSDEV_CONSOLE_MAX_DELAY_CS CTL_UNNUMBERED
118 #define PSDEV_CONSOLE_MIN_DELAY_CS CTL_UNNUMBERED
119 #define PSDEV_CONSOLE_BACKOFF CTL_UNNUMBERED
120 #define PSDEV_DEBUG_PATH CTL_UNNUMBERED
121 #define PSDEV_DEBUG_DUMP_PATH CTL_UNNUMBERED
122 #define PSDEV_LNET_UPCALL CTL_UNNUMBERED
123 #define PSDEV_LNET_MEMUSED CTL_UNNUMBERED
124 #define PSDEV_LNET_CATASTROPHE CTL_UNNUMBERED
125 #define PSDEV_LNET_PANIC_ON_LBUG CTL_UNNUMBERED
126 #define PSDEV_LNET_DUMP_KERNEL CTL_UNNUMBERED
127 #define PSDEV_LNET_DAEMON_FILE CTL_UNNUMBERED
128 #define PSDEV_LNET_DEBUG_MB CTL_UNNUMBERED
129 #define PSDEV_LNET_DEBUG_LOG_UPCALL CTL_UNNUMBERED
130 #define PSDEV_LNET_WATCHDOG_RATELIMIT CTL_UNNUMBERED
131 #define PSDEV_LNET_FORCE_LBUG CTL_UNNUMBERED
136 proc_call_handler(void *data, int write,
137 loff_t *ppos, void *buffer, size_t *lenp,
138 int (*handler)(void *data, int write,
139 loff_t pos, void *buffer, int len))
141 int rc = handler(data, write, *ppos, buffer, *lenp);
154 EXPORT_SYMBOL(proc_call_handler);
156 static int __proc_dobitmasks(void *data, int write,
157 loff_t pos, void *buffer, int nob)
159 const int tmpstrlen = 512;
162 unsigned int *mask = data;
163 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
164 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
166 rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
171 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
177 rc = cfs_trace_copyout_string(buffer, nob,
181 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
185 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
186 /* Always print LBUG/LASSERT to console, so keep this mask */
191 cfs_trace_free_string_buffer(tmpstr, tmpstrlen);
195 DECLARE_PROC_HANDLER(proc_dobitmasks)
197 static int min_watchdog_ratelimit = 0; /* disable ratelimiting */
198 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
200 static int __proc_dump_kernel(void *data, int write,
201 loff_t pos, void *buffer, int nob)
206 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
209 DECLARE_PROC_HANDLER(proc_dump_kernel)
211 static int __proc_daemon_file(void *data, int write,
212 loff_t pos, void *buffer, int nob)
215 int len = strlen(cfs_tracefile);
220 return cfs_trace_copyout_string(buffer, nob,
221 cfs_tracefile + pos, "\n");
224 return cfs_trace_daemon_command_usrstr(buffer, nob);
227 DECLARE_PROC_HANDLER(proc_daemon_file)
229 static int __proc_debug_mb(void *data, int write,
230 loff_t pos, void *buffer, int nob)
234 int len = snprintf(tmpstr, sizeof(tmpstr), "%d",
235 cfs_trace_get_debug_mb());
240 return cfs_trace_copyout_string(buffer, nob, tmpstr + pos,
244 return cfs_trace_set_debug_mb_usrstr(buffer, nob);
247 DECLARE_PROC_HANDLER(proc_debug_mb)
249 int LL_PROC_PROTO(proc_console_max_delay_cs)
251 int rc, max_delay_cs;
252 cfs_sysctl_table_t dummy = *table;
255 dummy.data = &max_delay_cs;
256 dummy.proc_handler = &proc_dointvec;
258 if (!write) { /* read */
259 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
260 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
266 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
269 if (max_delay_cs <= 0)
272 d = cfs_time_seconds(max_delay_cs) / 100;
273 if (d == 0 || d < libcfs_console_min_delay)
275 libcfs_console_max_delay = d;
280 int LL_PROC_PROTO(proc_console_min_delay_cs)
282 int rc, min_delay_cs;
283 cfs_sysctl_table_t dummy = *table;
286 dummy.data = &min_delay_cs;
287 dummy.proc_handler = &proc_dointvec;
289 if (!write) { /* read */
290 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
291 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
297 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
300 if (min_delay_cs <= 0)
303 d = cfs_time_seconds(min_delay_cs) / 100;
304 if (d == 0 || d > libcfs_console_max_delay)
306 libcfs_console_min_delay = d;
311 int LL_PROC_PROTO(proc_console_backoff)
314 cfs_sysctl_table_t dummy = *table;
316 dummy.data = &backoff;
317 dummy.proc_handler = &proc_dointvec;
319 if (!write) { /* read */
320 backoff= libcfs_console_backoff;
321 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
327 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
333 libcfs_console_backoff = backoff;
338 int LL_PROC_PROTO(libcfs_force_lbug)
345 static cfs_sysctl_table_t lnet_table[] = {
347 * NB No .strategy entries have been provided since sysctl(8) prefers
348 * to go via /proc for portability.
351 .ctl_name = PSDEV_DEBUG,
353 .data = &libcfs_debug,
354 .maxlen = sizeof(int),
356 .proc_handler = &proc_dobitmasks,
359 .ctl_name = PSDEV_SUBSYSTEM_DEBUG,
360 .procname = "subsystem_debug",
361 .data = &libcfs_subsystem_debug,
362 .maxlen = sizeof(int),
364 .proc_handler = &proc_dobitmasks,
367 .ctl_name = PSDEV_PRINTK,
368 .procname = "printk",
369 .data = &libcfs_printk,
370 .maxlen = sizeof(int),
372 .proc_handler = &proc_dobitmasks,
375 .ctl_name = PSDEV_CONSOLE_RATELIMIT,
376 .procname = "console_ratelimit",
377 .data = &libcfs_console_ratelimit,
378 .maxlen = sizeof(int),
380 .proc_handler = &proc_dointvec
383 .ctl_name = PSDEV_CONSOLE_MAX_DELAY_CS,
384 .procname = "console_max_delay_centisecs",
385 .maxlen = sizeof(int),
387 .proc_handler = &proc_console_max_delay_cs
390 .ctl_name = PSDEV_CONSOLE_MIN_DELAY_CS,
391 .procname = "console_min_delay_centisecs",
392 .maxlen = sizeof(int),
394 .proc_handler = &proc_console_min_delay_cs
397 .ctl_name = PSDEV_CONSOLE_BACKOFF,
398 .procname = "console_backoff",
399 .maxlen = sizeof(int),
401 .proc_handler = &proc_console_backoff
405 .ctl_name = PSDEV_DEBUG_PATH,
406 .procname = "debug_path",
407 .data = libcfs_debug_file_path_arr,
408 .maxlen = sizeof(libcfs_debug_file_path_arr),
410 .proc_handler = &proc_dostring,
414 .ctl_name = PSDEV_LNET_UPCALL,
415 .procname = "upcall",
417 .maxlen = sizeof(lnet_upcall),
419 .proc_handler = &proc_dostring,
422 .ctl_name = PSDEV_LNET_DEBUG_LOG_UPCALL,
423 .procname = "debug_log_upcall",
424 .data = lnet_debug_log_upcall,
425 .maxlen = sizeof(lnet_debug_log_upcall),
427 .proc_handler = &proc_dostring,
430 .ctl_name = PSDEV_LNET_MEMUSED,
431 .procname = "lnet_memused",
432 .data = (int *)&libcfs_kmemory.counter,
433 .maxlen = sizeof(int),
435 .proc_handler = &proc_dointvec,
436 .strategy = &sysctl_intvec,
439 .ctl_name = PSDEV_LNET_CATASTROPHE,
440 .procname = "catastrophe",
441 .data = &libcfs_catastrophe,
442 .maxlen = sizeof(int),
444 .proc_handler = &proc_dointvec,
445 .strategy = &sysctl_intvec,
448 .ctl_name = PSDEV_LNET_PANIC_ON_LBUG,
449 .procname = "panic_on_lbug",
450 .data = &libcfs_panic_on_lbug,
451 .maxlen = sizeof(int),
453 .proc_handler = &proc_dointvec,
454 .strategy = &sysctl_intvec,
457 .ctl_name = PSDEV_LNET_DUMP_KERNEL,
458 .procname = "dump_kernel",
461 .proc_handler = &proc_dump_kernel,
464 .ctl_name = PSDEV_LNET_DAEMON_FILE,
465 .procname = "daemon_file",
468 .proc_handler = &proc_daemon_file,
471 .ctl_name = PSDEV_LNET_DEBUG_MB,
472 .procname = "debug_mb",
474 .proc_handler = &proc_debug_mb,
477 .ctl_name = PSDEV_LNET_WATCHDOG_RATELIMIT,
478 .procname = "watchdog_ratelimit",
479 .data = &libcfs_watchdog_ratelimit,
480 .maxlen = sizeof(int),
482 .proc_handler = &proc_dointvec_minmax,
483 .extra1 = &min_watchdog_ratelimit,
484 .extra2 = &max_watchdog_ratelimit,
486 { .ctl_name = PSDEV_LNET_FORCE_LBUG,
487 .procname = "force_lbug",
491 .proc_handler = &libcfs_force_lbug
497 static cfs_sysctl_table_t top_table[] = {
499 .ctl_name = CTL_LNET,
511 int insert_proc(void)
513 if (lnet_table_header == NULL)
514 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
519 void remove_proc(void)
522 if (lnet_table_header != NULL)
523 cfs_unregister_sysctl_table(lnet_table_header);
525 lnet_table_header = NULL;