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 #define PSDEV_LNET (0x100)
88 PSDEV_DEBUG = 1, /* control debugging */
89 PSDEV_SUBSYSTEM_DEBUG, /* control debugging */
90 PSDEV_PRINTK, /* force all messages to console */
91 PSDEV_CONSOLE_RATELIMIT, /* ratelimit console messages */
92 PSDEV_CONSOLE_MAX_DELAY_CS, /* maximum delay over which we skip messages */
93 PSDEV_CONSOLE_MIN_DELAY_CS, /* initial delay over which we skip messages */
94 PSDEV_CONSOLE_BACKOFF, /* delay increase factor */
95 PSDEV_DEBUG_PATH, /* crashdump log location */
96 PSDEV_DEBUG_DUMP_PATH, /* crashdump tracelog location */
97 PSDEV_LNET_UPCALL, /* User mode upcall script */
98 PSDEV_LNET_MEMUSED, /* bytes currently PORTAL_ALLOCated */
99 PSDEV_LNET_CATASTROPHE, /* if we have LBUGged or panic'd */
100 PSDEV_LNET_PANIC_ON_LBUG, /* flag to panic on LBUG */
101 PSDEV_LNET_DUMP_KERNEL, /* snapshot kernel debug buffer to file */
102 PSDEV_LNET_DAEMON_FILE, /* spool kernel debug buffer to file */
103 PSDEV_LNET_DEBUG_MB, /* size of debug buffer */
104 PSDEV_LNET_DEBUG_LOG_UPCALL, /* debug log upcall script */
108 proc_call_handler(void *data, int write,
109 loff_t *ppos, void *buffer, size_t *lenp,
110 int (*handler)(void *data, int write,
111 loff_t pos, void *buffer, int len))
113 int rc = handler(data, write, *ppos, buffer, *lenp);
127 #define DECLARE_PROC_HANDLER(name) \
129 LL_PROC_PROTO(name) \
131 DECLARE_LL_PROC_PPOS_DECL; \
133 return proc_call_handler(table->data, write, \
134 ppos, buffer, lenp, \
138 static int __proc_dobitmasks(void *data, int write,
139 loff_t pos, void *buffer, int nob)
141 const int tmpstrlen = 512;
144 unsigned int *mask = data;
145 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
146 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
148 rc = trace_allocate_string_buffer(&tmpstr, tmpstrlen);
153 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
159 rc = trace_copyout_string(buffer, nob,
163 rc = trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
167 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
168 /* Always print LBUG/LASSERT to console, so keep this mask */
173 trace_free_string_buffer(tmpstr, tmpstrlen);
177 DECLARE_PROC_HANDLER(proc_dobitmasks)
179 static int __proc_dump_kernel(void *data, int write,
180 loff_t pos, void *buffer, int nob)
185 return trace_dump_debug_buffer_usrstr(buffer, nob);
188 DECLARE_PROC_HANDLER(proc_dump_kernel)
190 static int __proc_daemon_file(void *data, int write,
191 loff_t pos, void *buffer, int nob)
194 int len = strlen(tracefile);
199 return trace_copyout_string(buffer, nob,
200 tracefile + pos, "\n");
203 return trace_daemon_command_usrstr(buffer, nob);
206 DECLARE_PROC_HANDLER(proc_daemon_file)
208 static int __proc_debug_mb(void *data, int write,
209 loff_t pos, void *buffer, int nob)
213 int len = snprintf(tmpstr, sizeof(tmpstr), "%d",
214 trace_get_debug_mb());
219 return trace_copyout_string(buffer, nob, tmpstr + pos, "\n");
222 return trace_set_debug_mb_usrstr(buffer, nob);
225 DECLARE_PROC_HANDLER(proc_debug_mb)
227 int LL_PROC_PROTO(proc_console_max_delay_cs)
229 int rc, max_delay_cs;
230 cfs_sysctl_table_t dummy = *table;
233 dummy.data = &max_delay_cs;
234 dummy.proc_handler = &proc_dointvec;
236 if (!write) { /* read */
237 max_delay_cs = cfs_duration_sec(libcfs_console_max_delay * 100);
238 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
244 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
247 if (max_delay_cs <= 0)
250 d = cfs_time_seconds(max_delay_cs) / 100;
251 if (d == 0 || d < libcfs_console_min_delay)
253 libcfs_console_max_delay = d;
258 int LL_PROC_PROTO(proc_console_min_delay_cs)
260 int rc, min_delay_cs;
261 cfs_sysctl_table_t dummy = *table;
264 dummy.data = &min_delay_cs;
265 dummy.proc_handler = &proc_dointvec;
267 if (!write) { /* read */
268 min_delay_cs = cfs_duration_sec(libcfs_console_min_delay * 100);
269 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
275 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
278 if (min_delay_cs <= 0)
281 d = cfs_time_seconds(min_delay_cs) / 100;
282 if (d == 0 || d > libcfs_console_max_delay)
284 libcfs_console_min_delay = d;
289 int LL_PROC_PROTO(proc_console_backoff)
292 cfs_sysctl_table_t dummy = *table;
294 dummy.data = &backoff;
295 dummy.proc_handler = &proc_dointvec;
297 if (!write) { /* read */
298 backoff= libcfs_console_backoff;
299 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
305 rc = ll_proc_dointvec(&dummy, write, filp, buffer, lenp, ppos);
311 libcfs_console_backoff = backoff;
316 static cfs_sysctl_table_t lnet_table[] = {
318 * NB No .strategy entries have been provided since sysctl(8) prefers
319 * to go via /proc for portability.
322 .ctl_name = PSDEV_DEBUG,
324 .data = &libcfs_debug,
325 .maxlen = sizeof(int),
327 .proc_handler = &proc_dobitmasks
330 .ctl_name = PSDEV_SUBSYSTEM_DEBUG,
331 .procname = "subsystem_debug",
332 .data = &libcfs_subsystem_debug,
333 .maxlen = sizeof(int),
335 .proc_handler = &proc_dobitmasks
338 .ctl_name = PSDEV_PRINTK,
339 .procname = "printk",
340 .data = &libcfs_printk,
341 .maxlen = sizeof(int),
343 .proc_handler = &proc_dobitmasks
346 .ctl_name = PSDEV_CONSOLE_RATELIMIT,
347 .procname = "console_ratelimit",
348 .data = &libcfs_console_ratelimit,
349 .maxlen = sizeof(int),
351 .proc_handler = &proc_dointvec
354 .ctl_name = PSDEV_CONSOLE_MAX_DELAY_CS,
355 .procname = "console_max_delay_centisecs",
356 .maxlen = sizeof(int),
358 .proc_handler = &proc_console_max_delay_cs
361 .ctl_name = PSDEV_CONSOLE_MIN_DELAY_CS,
362 .procname = "console_min_delay_centisecs",
363 .maxlen = sizeof(int),
365 .proc_handler = &proc_console_min_delay_cs
368 .ctl_name = PSDEV_CONSOLE_BACKOFF,
369 .procname = "console_backoff",
370 .maxlen = sizeof(int),
372 .proc_handler = &proc_console_backoff
376 .ctl_name = PSDEV_DEBUG_PATH,
377 .procname = "debug_path",
378 .data = debug_file_path,
379 .maxlen = sizeof(debug_file_path),
381 .proc_handler = &proc_dostring,
385 .ctl_name = PSDEV_LNET_UPCALL,
386 .procname = "upcall",
388 .maxlen = sizeof(lnet_upcall),
390 .proc_handler = &proc_dostring,
393 .ctl_name = PSDEV_LNET_DEBUG_LOG_UPCALL,
394 .procname = "debug_log_upcall",
395 .data = lnet_debug_log_upcall,
396 .maxlen = sizeof(lnet_debug_log_upcall),
398 .proc_handler = &proc_dostring,
401 .ctl_name = PSDEV_LNET_MEMUSED,
402 .procname = "memused",
403 .data = (int *)&libcfs_kmemory.counter,
404 .maxlen = sizeof(int),
406 .proc_handler = &proc_dointvec
409 .ctl_name = PSDEV_LNET_CATASTROPHE,
410 .procname = "catastrophe",
411 .data = &libcfs_catastrophe,
412 .maxlen = sizeof(int),
414 .proc_handler = &proc_dointvec
417 .ctl_name = PSDEV_LNET_PANIC_ON_LBUG,
418 .procname = "panic_on_lbug",
419 .data = &libcfs_panic_on_lbug,
420 .maxlen = sizeof(int),
422 .proc_handler = &proc_dointvec
425 .ctl_name = PSDEV_LNET_DUMP_KERNEL,
426 .procname = "dump_kernel",
428 .proc_handler = &proc_dump_kernel,
431 .ctl_name = PSDEV_LNET_DAEMON_FILE,
432 .procname = "daemon_file",
434 .proc_handler = &proc_daemon_file,
437 .ctl_name = PSDEV_LNET_DEBUG_MB,
438 .procname = "debug_mb",
440 .proc_handler = &proc_debug_mb,
445 static cfs_sysctl_table_t top_table[2] = {
447 .ctl_name = PSDEV_LNET,
457 int insert_proc(void)
460 if (lnet_table_header == NULL)
461 lnet_table_header = cfs_register_sysctl_table(top_table, 0);
466 void remove_proc(void)
469 if (lnet_table_header != NULL)
470 cfs_unregister_sysctl_table(lnet_table_header);
472 lnet_table_header = NULL;