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 [sun.com URL with a
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 #define PSDEV_LNET (0x100)
84 PSDEV_DEBUG = 1, /* control debugging */
85 PSDEV_SUBSYSTEM_DEBUG, /* control debugging */
86 PSDEV_PRINTK, /* force all messages to console */
87 PSDEV_CONSOLE_RATELIMIT, /* ratelimit console messages */
88 PSDEV_CONSOLE_MAX_DELAY_CS, /* maximum delay over which we skip messages */
89 PSDEV_CONSOLE_MIN_DELAY_CS, /* initial delay over which we skip messages */
90 PSDEV_CONSOLE_BACKOFF, /* delay increase factor */
91 PSDEV_DEBUG_PATH, /* crashdump log location */
92 PSDEV_DEBUG_DUMP_PATH, /* crashdump tracelog location */
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 */
103 proc_call_handler(void *data, int write,
104 loff_t *ppos, void *buffer, size_t *lenp,
105 int (*handler)(void *data, int write,
106 loff_t pos, void *buffer, int len))
108 int rc = handler(data, write, *ppos, buffer, *lenp);
122 #define DECLARE_PROC_HANDLER(name) \
124 LL_PROC_PROTO(name) \
126 DECLARE_LL_PROC_PPOS_DECL; \
128 return proc_call_handler(table->data, write, \
129 ppos, buffer, lenp, \
133 static int __proc_dobitmasks(void *data, int write,
134 loff_t pos, void *buffer, int nob)
136 const int tmpstrlen = 512;
139 unsigned int *mask = data;
140 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
141 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
143 rc = trace_allocate_string_buffer(&tmpstr, tmpstrlen);
148 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
154 rc = trace_copyout_string(buffer, nob,
158 rc = trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
162 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
163 /* Always print LBUG/LASSERT to console, so keep this mask */
168 trace_free_string_buffer(tmpstr, tmpstrlen);
172 DECLARE_PROC_HANDLER(proc_dobitmasks)
174 static int __proc_dump_kernel(void *data, int write,
175 loff_t pos, void *buffer, int nob)
180 return trace_dump_debug_buffer_usrstr(buffer, nob);
183 DECLARE_PROC_HANDLER(proc_dump_kernel)
185 static int __proc_daemon_file(void *data, int write,
186 loff_t pos, void *buffer, int nob)
189 int len = strlen(tracefile);
194 return trace_copyout_string(buffer, nob,
195 tracefile + pos, "\n");
198 return trace_daemon_command_usrstr(buffer, nob);
201 DECLARE_PROC_HANDLER(proc_daemon_file)
203 static int __proc_debug_mb(void *data, int write,
204 loff_t pos, void *buffer, int nob)
208 int len = snprintf(tmpstr, sizeof(tmpstr), "%d",
209 trace_get_debug_mb());
214 return trace_copyout_string(buffer, nob, tmpstr + pos, "\n");
217 return trace_set_debug_mb_usrstr(buffer, nob);
220 DECLARE_PROC_HANDLER(proc_debug_mb)
222 int LL_PROC_PROTO(proc_console_max_delay_cs)
224 int rc, max_delay_cs;
225 cfs_sysctl_table_t dummy = *table;
228 dummy.data = &max_delay_cs;
229 dummy.proc_handler = &proc_dointvec;
231 if (!write) { /* read */
232 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
233 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
239 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
242 if (max_delay_cs <= 0)
245 d = cfs_time_seconds(max_delay_cs) / 100;
246 if (d == 0 || d < libcfs_console_min_delay)
248 libcfs_console_max_delay = d;
253 int LL_PROC_PROTO(proc_console_min_delay_cs)
255 int rc, min_delay_cs;
256 cfs_sysctl_table_t dummy = *table;
259 dummy.data = &min_delay_cs;
260 dummy.proc_handler = &proc_dointvec;
262 if (!write) { /* read */
263 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
264 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
270 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
273 if (min_delay_cs <= 0)
276 d = cfs_time_seconds(min_delay_cs) / 100;
277 if (d == 0 || d > libcfs_console_max_delay)
279 libcfs_console_min_delay = d;
284 int LL_PROC_PROTO(proc_console_backoff)
287 cfs_sysctl_table_t dummy = *table;
289 dummy.data = &backoff;
290 dummy.proc_handler = &proc_dointvec;
292 if (!write) { /* read */
293 backoff= libcfs_console_backoff;
294 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
300 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
306 libcfs_console_backoff = backoff;
311 static cfs_sysctl_table_t lnet_table[] = {
313 * NB No .strategy entries have been provided since sysctl(8) prefers
314 * to go via /proc for portability.
317 .ctl_name = PSDEV_DEBUG,
319 .data = &libcfs_debug,
320 .maxlen = sizeof(int),
322 .proc_handler = &proc_dobitmasks
325 .ctl_name = PSDEV_SUBSYSTEM_DEBUG,
326 .procname = "subsystem_debug",
327 .data = &libcfs_subsystem_debug,
328 .maxlen = sizeof(int),
330 .proc_handler = &proc_dobitmasks
333 .ctl_name = PSDEV_PRINTK,
334 .procname = "printk",
335 .data = &libcfs_printk,
336 .maxlen = sizeof(int),
338 .proc_handler = &proc_dobitmasks
341 .ctl_name = PSDEV_CONSOLE_RATELIMIT,
342 .procname = "console_ratelimit",
343 .data = &libcfs_console_ratelimit,
344 .maxlen = sizeof(int),
346 .proc_handler = &proc_dointvec
349 .ctl_name = PSDEV_CONSOLE_MAX_DELAY_CS,
350 .procname = "console_max_delay_centisecs",
351 .maxlen = sizeof(int),
353 .proc_handler = &proc_console_max_delay_cs
356 .ctl_name = PSDEV_CONSOLE_MIN_DELAY_CS,
357 .procname = "console_min_delay_centisecs",
358 .maxlen = sizeof(int),
360 .proc_handler = &proc_console_min_delay_cs
363 .ctl_name = PSDEV_CONSOLE_BACKOFF,
364 .procname = "console_backoff",
365 .maxlen = sizeof(int),
367 .proc_handler = &proc_console_backoff
371 .ctl_name = PSDEV_DEBUG_PATH,
372 .procname = "debug_path",
373 .data = debug_file_path,
374 .maxlen = sizeof(debug_file_path),
376 .proc_handler = &proc_dostring,
380 .ctl_name = PSDEV_LNET_UPCALL,
381 .procname = "upcall",
383 .maxlen = sizeof(lnet_upcall),
385 .proc_handler = &proc_dostring,
388 .ctl_name = PSDEV_LNET_MEMUSED,
389 .procname = "memused",
390 .data = (int *)&libcfs_kmemory.counter,
391 .maxlen = sizeof(int),
393 .proc_handler = &proc_dointvec
396 .ctl_name = PSDEV_LNET_CATASTROPHE,
397 .procname = "catastrophe",
398 .data = &libcfs_catastrophe,
399 .maxlen = sizeof(int),
401 .proc_handler = &proc_dointvec
404 .ctl_name = PSDEV_LNET_PANIC_ON_LBUG,
405 .procname = "panic_on_lbug",
406 .data = &libcfs_panic_on_lbug,
407 .maxlen = sizeof(int),
409 .proc_handler = &proc_dointvec
412 .ctl_name = PSDEV_LNET_DUMP_KERNEL,
413 .procname = "dump_kernel",
415 .proc_handler = &proc_dump_kernel,
418 .ctl_name = PSDEV_LNET_DAEMON_FILE,
419 .procname = "daemon_file",
421 .proc_handler = &proc_daemon_file,
424 .ctl_name = PSDEV_LNET_DEBUG_MB,
425 .procname = "debug_mb",
427 .proc_handler = &proc_debug_mb,
432 static cfs_sysctl_table_t top_table[2] = {
434 .ctl_name = PSDEV_LNET,
444 int insert_proc(void)
447 if (lnet_table_header == NULL)
448 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
453 void remove_proc(void)
456 if (lnet_table_header != NULL)
457 cfs_unregister_sysctl_table(lnet_table_header);
459 lnet_table_header = NULL;