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/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"
79 static cfs_sysctl_table_header_t *lnet_table_header = NULL;
80 extern char lnet_upcall[1024];
82 * The path of debug log dump upcall script.
84 extern char lnet_debug_log_upcall[1024];
86 #ifndef HAVE_SYSCTL_UNNUMBERED
87 #define CTL_LNET (0x100)
89 PSDEV_DEBUG = 1, /* control debugging */
90 PSDEV_SUBSYSTEM_DEBUG, /* control debugging */
91 PSDEV_PRINTK, /* force all messages to console */
92 PSDEV_CONSOLE_RATELIMIT, /* ratelimit console messages */
93 PSDEV_CONSOLE_MAX_DELAY_CS, /* maximum delay over which we skip messages */
94 PSDEV_CONSOLE_MIN_DELAY_CS, /* initial delay over which we skip messages */
95 PSDEV_CONSOLE_BACKOFF, /* delay increase factor */
96 PSDEV_DEBUG_PATH, /* crashdump log location */
97 PSDEV_DEBUG_DUMP_PATH, /* crashdump tracelog location */
98 PSDEV_LNET_UPCALL, /* User mode upcall script */
99 PSDEV_LNET_MEMUSED, /* bytes currently PORTAL_ALLOCated */
100 PSDEV_LNET_CATASTROPHE, /* if we have LBUGged or panic'd */
101 PSDEV_LNET_PANIC_ON_LBUG, /* flag to panic on LBUG */
102 PSDEV_LNET_DUMP_KERNEL, /* snapshot kernel debug buffer to file */
103 PSDEV_LNET_DAEMON_FILE, /* spool kernel debug buffer to file */
104 PSDEV_LNET_DEBUG_MB, /* size of debug buffer */
105 PSDEV_LNET_DEBUG_LOG_UPCALL, /* debug log upcall script */
108 #define CTL_LNET CTL_UNNUMBERED
109 #define PSDEV_DEBUG CTL_UNNUMBERED
110 #define PSDEV_SUBSYSTEM_DEBUG CTL_UNNUMBERED
111 #define PSDEV_PRINTK CTL_UNNUMBERED
112 #define PSDEV_CONSOLE_RATELIMIT CTL_UNNUMBERED
113 #define PSDEV_CONSOLE_MAX_DELAY_CS CTL_UNNUMBERED
114 #define PSDEV_CONSOLE_MIN_DELAY_CS CTL_UNNUMBERED
115 #define PSDEV_CONSOLE_BACKOFF CTL_UNNUMBERED
116 #define PSDEV_DEBUG_PATH CTL_UNNUMBERED
117 #define PSDEV_DEBUG_DUMP_PATH 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
130 proc_call_handler(void *data, int write,
131 loff_t *ppos, void *buffer, size_t *lenp,
132 int (*handler)(void *data, int write,
133 loff_t pos, void *buffer, int len))
135 int rc = handler(data, write, *ppos, buffer, *lenp);
148 EXPORT_SYMBOL(proc_call_handler);
150 static int __proc_dobitmasks(void *data, int write,
151 loff_t pos, void *buffer, int nob)
153 const int tmpstrlen = 512;
156 unsigned int *mask = data;
157 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
158 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
160 rc = trace_allocate_string_buffer(&tmpstr, tmpstrlen);
165 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
171 rc = trace_copyout_string(buffer, nob,
175 rc = trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
179 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
180 /* Always print LBUG/LASSERT to console, so keep this mask */
185 trace_free_string_buffer(tmpstr, tmpstrlen);
189 DECLARE_PROC_HANDLER(proc_dobitmasks)
191 static int __proc_dump_kernel(void *data, int write,
192 loff_t pos, void *buffer, int nob)
197 return trace_dump_debug_buffer_usrstr(buffer, nob);
200 DECLARE_PROC_HANDLER(proc_dump_kernel)
202 static int __proc_daemon_file(void *data, int write,
203 loff_t pos, void *buffer, int nob)
206 int len = strlen(tracefile);
211 return trace_copyout_string(buffer, nob,
212 tracefile + pos, "\n");
215 return trace_daemon_command_usrstr(buffer, nob);
218 DECLARE_PROC_HANDLER(proc_daemon_file)
220 static int __proc_debug_mb(void *data, int write,
221 loff_t pos, void *buffer, int nob)
225 int len = snprintf(tmpstr, sizeof(tmpstr), "%d",
226 trace_get_debug_mb());
231 return trace_copyout_string(buffer, nob, tmpstr + pos, "\n");
234 return trace_set_debug_mb_usrstr(buffer, nob);
237 DECLARE_PROC_HANDLER(proc_debug_mb)
239 int LL_PROC_PROTO(proc_console_max_delay_cs)
241 int rc, max_delay_cs;
242 cfs_sysctl_table_t dummy = *table;
245 dummy.data = &max_delay_cs;
246 dummy.proc_handler = &proc_dointvec;
248 if (!write) { /* read */
249 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
250 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
256 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
259 if (max_delay_cs <= 0)
262 d = cfs_time_seconds(max_delay_cs) / 100;
263 if (d == 0 || d < libcfs_console_min_delay)
265 libcfs_console_max_delay = d;
270 int LL_PROC_PROTO(proc_console_min_delay_cs)
272 int rc, min_delay_cs;
273 cfs_sysctl_table_t dummy = *table;
276 dummy.data = &min_delay_cs;
277 dummy.proc_handler = &proc_dointvec;
279 if (!write) { /* read */
280 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
281 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
287 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
290 if (min_delay_cs <= 0)
293 d = cfs_time_seconds(min_delay_cs) / 100;
294 if (d == 0 || d > libcfs_console_max_delay)
296 libcfs_console_min_delay = d;
301 int LL_PROC_PROTO(proc_console_backoff)
304 cfs_sysctl_table_t dummy = *table;
306 dummy.data = &backoff;
307 dummy.proc_handler = &proc_dointvec;
309 if (!write) { /* read */
310 backoff= libcfs_console_backoff;
311 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
317 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
323 libcfs_console_backoff = backoff;
328 static cfs_sysctl_table_t lnet_table[] = {
330 * NB No .strategy entries have been provided since sysctl(8) prefers
331 * to go via /proc for portability.
334 .ctl_name = PSDEV_DEBUG,
336 .data = &libcfs_debug,
337 .maxlen = sizeof(int),
339 .proc_handler = &proc_dobitmasks,
342 .ctl_name = PSDEV_SUBSYSTEM_DEBUG,
343 .procname = "subsystem_debug",
344 .data = &libcfs_subsystem_debug,
345 .maxlen = sizeof(int),
347 .proc_handler = &proc_dobitmasks,
350 .ctl_name = PSDEV_PRINTK,
351 .procname = "printk",
352 .data = &libcfs_printk,
353 .maxlen = sizeof(int),
355 .proc_handler = &proc_dobitmasks,
358 .ctl_name = PSDEV_CONSOLE_RATELIMIT,
359 .procname = "console_ratelimit",
360 .data = &libcfs_console_ratelimit,
361 .maxlen = sizeof(int),
363 .proc_handler = &proc_dointvec
366 .ctl_name = PSDEV_CONSOLE_MAX_DELAY_CS,
367 .procname = "console_max_delay_centisecs",
368 .maxlen = sizeof(int),
370 .proc_handler = &proc_console_max_delay_cs
373 .ctl_name = PSDEV_CONSOLE_MIN_DELAY_CS,
374 .procname = "console_min_delay_centisecs",
375 .maxlen = sizeof(int),
377 .proc_handler = &proc_console_min_delay_cs
380 .ctl_name = PSDEV_CONSOLE_BACKOFF,
381 .procname = "console_backoff",
382 .maxlen = sizeof(int),
384 .proc_handler = &proc_console_backoff
388 .ctl_name = PSDEV_DEBUG_PATH,
389 .procname = "debug_path",
390 .data = debug_file_path_arr,
391 .maxlen = sizeof(debug_file_path_arr),
393 .proc_handler = &proc_dostring,
397 .ctl_name = PSDEV_LNET_UPCALL,
398 .procname = "upcall",
400 .maxlen = sizeof(lnet_upcall),
402 .proc_handler = &proc_dostring,
405 .ctl_name = PSDEV_LNET_DEBUG_LOG_UPCALL,
406 .procname = "debug_log_upcall",
407 .data = lnet_debug_log_upcall,
408 .maxlen = sizeof(lnet_debug_log_upcall),
410 .proc_handler = &proc_dostring,
413 .ctl_name = PSDEV_LNET_MEMUSED,
414 .procname = "memused",
415 .data = (int *)&libcfs_kmemory.counter,
416 .maxlen = sizeof(int),
418 .proc_handler = &proc_dointvec,
419 .strategy = &sysctl_intvec,
422 .ctl_name = PSDEV_LNET_CATASTROPHE,
423 .procname = "catastrophe",
424 .data = &libcfs_catastrophe,
425 .maxlen = sizeof(int),
427 .proc_handler = &proc_dointvec,
428 .strategy = &sysctl_intvec,
431 .ctl_name = PSDEV_LNET_PANIC_ON_LBUG,
432 .procname = "panic_on_lbug",
433 .data = &libcfs_panic_on_lbug,
434 .maxlen = sizeof(int),
436 .proc_handler = &proc_dointvec,
437 .strategy = &sysctl_intvec,
440 .ctl_name = PSDEV_LNET_DUMP_KERNEL,
441 .procname = "dump_kernel",
444 .proc_handler = &proc_dump_kernel,
447 .ctl_name = PSDEV_LNET_DAEMON_FILE,
448 .procname = "daemon_file",
451 .proc_handler = &proc_daemon_file,
454 .ctl_name = PSDEV_LNET_DEBUG_MB,
455 .procname = "debug_mb",
457 .proc_handler = &proc_debug_mb,
462 static cfs_sysctl_table_t top_table[] = {
464 .ctl_name = CTL_LNET,
476 int insert_proc(void)
479 printk("call register\n");
480 if (lnet_table_header == NULL)
481 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
486 void remove_proc(void)
489 if (lnet_table_header != NULL)
490 cfs_unregister_sysctl_table(lnet_table_header);
492 lnet_table_header = NULL;