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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 #include <linux/miscdevice.h>
33 #include <linux/module.h>
34 #include <linux/kernel.h>
36 #include <linux/string.h>
37 #include <linux/stat.h>
38 #include <linux/errno.h>
39 #include <linux/unistd.h>
41 #include <linux/uio.h>
42 #include <linux/uaccess.h>
45 #include <linux/file.h>
46 #include <linux/list.h>
48 #include <linux/sysctl.h>
49 #include <linux/debugfs.h>
50 #include <asm/div64.h>
52 #define DEBUG_SUBSYSTEM S_LNET
54 #include <libcfs/libcfs.h>
55 #include <libcfs/libcfs_crypto.h>
56 #include <lnet/lib-lnet.h>
57 #include "tracefile.h"
59 static struct dentry *lnet_debugfs_root;
61 BLOCKING_NOTIFIER_HEAD(libcfs_ioctl_list);
62 EXPORT_SYMBOL(libcfs_ioctl_list);
64 int libcfs_ioctl(unsigned long cmd, void __user *uparam)
66 struct libcfs_ioctl_data *data = NULL;
67 struct libcfs_ioctl_hdr *hdr;
71 /* 'cmd' and permissions get checked in our arch-specific caller */
72 err = libcfs_ioctl_getdata(&hdr, uparam);
75 "libcfs ioctl: data header error %d\n", err);
79 if (hdr->ioc_version == LIBCFS_IOCTL_VERSION) {
80 /* The libcfs_ioctl_data_adjust() function performs adjustment
81 * operations on the libcfs_ioctl_data structure to make
82 * it usable by the code. This doesn't need to be called
83 * for new data structures added. */
84 data = container_of(hdr, struct libcfs_ioctl_data, ioc_hdr);
85 err = libcfs_ioctl_data_adjust(data);
90 CDEBUG(D_IOCTL, "libcfs ioctl cmd %lu\n", cmd);
92 case IOC_LIBCFS_CLEAR_DEBUG:
93 libcfs_debug_clear_buffer();
95 case IOC_LIBCFS_MARK_DEBUG:
97 data->ioc_inlbuf1 == NULL ||
98 data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
99 GOTO(out, err = -EINVAL);
101 libcfs_debug_mark_buffer(data->ioc_inlbuf1);
105 err = blocking_notifier_call_chain(&libcfs_ioctl_list,
107 if (!(err & NOTIFY_STOP_MASK))
108 /* No-one claimed the ioctl */
111 err = notifier_to_errno(err);
113 if (copy_to_user(uparam, hdr, hdr->ioc_len))
118 LIBCFS_FREE(hdr, hdr->ioc_len);
122 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
123 void __user *buffer, size_t *lenp,
124 int (*handler)(void *data, int write, loff_t pos,
125 void __user *buffer, int len))
127 int rc = handler(data, write, *ppos, buffer, *lenp);
140 EXPORT_SYMBOL(lprocfs_call_handler);
142 static int __proc_dobitmasks(void *data, int write,
143 loff_t pos, void __user *buffer, int nob)
145 const int tmpstrlen = 512;
148 unsigned int *mask = data;
149 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
150 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
152 rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
157 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
163 rc = cfs_trace_copyout_string(buffer, nob,
167 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
173 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
174 /* Always print LBUG/LASSERT to console, so keep this mask */
183 static int proc_dobitmasks(struct ctl_table *table, int write,
184 void __user *buffer, size_t *lenp, loff_t *ppos)
186 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
190 static int min_watchdog_ratelimit; /* disable ratelimiting */
191 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
193 static int __proc_dump_kernel(void *data, int write,
194 loff_t pos, void __user *buffer, int nob)
199 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
202 static int proc_dump_kernel(struct ctl_table *table, int write,
203 void __user *buffer, size_t *lenp, loff_t *ppos)
205 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
209 static int __proc_daemon_file(void *data, int write,
210 loff_t pos, void __user *buffer, int nob)
213 int len = strlen(cfs_tracefile);
218 return cfs_trace_copyout_string(buffer, nob,
219 cfs_tracefile + pos, "\n");
222 return cfs_trace_daemon_command_usrstr(buffer, nob);
225 static int proc_daemon_file(struct ctl_table *table, int write,
226 void __user *buffer, size_t *lenp, loff_t *ppos)
228 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
232 static int libcfs_force_lbug(struct ctl_table *table, int write,
234 size_t *lenp, loff_t *ppos)
241 static int proc_fail_loc(struct ctl_table *table, int write,
242 void __user *buffer, size_t *lenp, loff_t *ppos)
245 long old_fail_loc = cfs_fail_loc;
247 rc = proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
248 if (old_fail_loc != cfs_fail_loc)
249 wake_up(&cfs_race_waitq);
253 static int __proc_cpt_table(void *data, int write,
254 loff_t pos, void __user *buffer, int nob)
263 LASSERT(cfs_cpt_table != NULL);
266 LIBCFS_ALLOC(buf, len);
270 rc = cfs_cpt_table_print(cfs_cpt_table, buf, len);
275 LIBCFS_FREE(buf, len);
287 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
290 LIBCFS_FREE(buf, len);
294 static int proc_cpt_table(struct ctl_table *table, int write,
295 void __user *buffer, size_t *lenp, loff_t *ppos)
297 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
301 static int __proc_cpt_distance(void *data, int write,
302 loff_t pos, void __user *buffer, int nob)
311 LASSERT(cfs_cpt_table != NULL);
314 LIBCFS_ALLOC(buf, len);
318 rc = cfs_cpt_distance_print(cfs_cpt_table, buf, len);
323 LIBCFS_FREE(buf, len);
335 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
338 LIBCFS_FREE(buf, len);
342 static int proc_cpt_distance(struct ctl_table *table, int write,
343 void __user *buffer, size_t *lenp, loff_t *ppos)
345 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
346 __proc_cpt_distance);
349 static struct ctl_table lnet_table[] = {
353 .data = &libcfs_debug,
354 .maxlen = sizeof(int),
356 .proc_handler = &proc_dobitmasks,
360 .procname = "subsystem_debug",
361 .data = &libcfs_subsystem_debug,
362 .maxlen = sizeof(int),
364 .proc_handler = &proc_dobitmasks,
368 .procname = "printk",
369 .data = &libcfs_printk,
370 .maxlen = sizeof(int),
372 .proc_handler = &proc_dobitmasks,
376 .procname = "cpu_partition_table",
379 .proc_handler = &proc_cpt_table,
383 .procname = "cpu_partition_distance",
386 .proc_handler = &proc_cpt_distance,
390 .procname = "debug_log_upcall",
391 .data = lnet_debug_log_upcall,
392 .maxlen = sizeof(lnet_debug_log_upcall),
394 .proc_handler = &proc_dostring,
398 .procname = "lnet_memused",
399 .data = (int *)&libcfs_kmemory.counter,
400 .maxlen = sizeof(int),
402 .proc_handler = &proc_dointvec,
406 .procname = "catastrophe",
407 .data = &libcfs_catastrophe,
408 .maxlen = sizeof(int),
410 .proc_handler = &proc_dointvec,
414 .procname = "dump_kernel",
417 .proc_handler = &proc_dump_kernel,
421 .procname = "daemon_file",
424 .proc_handler = &proc_daemon_file,
428 .procname = "watchdog_ratelimit",
429 .data = &libcfs_watchdog_ratelimit,
430 .maxlen = sizeof(int),
432 .proc_handler = &proc_dointvec_minmax,
433 .extra1 = &min_watchdog_ratelimit,
434 .extra2 = &max_watchdog_ratelimit,
438 .procname = "force_lbug",
442 .proc_handler = &libcfs_force_lbug
446 .procname = "fail_loc",
447 .data = &cfs_fail_loc,
448 .maxlen = sizeof(cfs_fail_loc),
450 .proc_handler = &proc_fail_loc
454 .procname = "fail_val",
455 .data = &cfs_fail_val,
456 .maxlen = sizeof(int),
458 .proc_handler = &proc_dointvec
462 .procname = "fail_err",
463 .data = &cfs_fail_err,
464 .maxlen = sizeof(cfs_fail_err),
466 .proc_handler = &proc_dointvec,
472 static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
473 { .name = "console_ratelimit",
474 .target = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
475 { .name = "debug_path",
476 .target = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
477 { .name = "panic_on_lbug",
478 .target = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
479 { .name = "console_backoff",
480 .target = "../../../module/libcfs/parameters/libcfs_console_backoff" },
481 { .name = "debug_mb",
482 .target = "../../../module/libcfs/parameters/libcfs_debug_mb" },
483 { .name = "console_min_delay_centisecs",
484 .target = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
485 { .name = "console_max_delay_centisecs",
486 .target = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
490 static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
491 size_t count, loff_t *ppos)
493 struct ctl_table *table = filp->private_data;
494 ssize_t rc = -EINVAL;
497 rc = table->proc_handler(table, 0, buf, &count, ppos);
505 static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
506 size_t count, loff_t *ppos)
508 struct ctl_table *table = filp->private_data;
509 ssize_t rc = -EINVAL;
512 rc = table->proc_handler(table, 1, (void __user *)buf, &count,
521 static const struct file_operations lnet_debugfs_file_operations_rw = {
523 .read = lnet_debugfs_read,
524 .write = lnet_debugfs_write,
525 .llseek = default_llseek,
528 static const struct file_operations lnet_debugfs_file_operations_ro = {
530 .read = lnet_debugfs_read,
531 .llseek = default_llseek,
534 static const struct file_operations lnet_debugfs_file_operations_wo = {
536 .write = lnet_debugfs_write,
537 .llseek = default_llseek,
540 static const struct file_operations *lnet_debugfs_fops_select(umode_t mode)
542 if (!(mode & S_IWUGO))
543 return &lnet_debugfs_file_operations_ro;
545 if (!(mode & S_IRUGO))
546 return &lnet_debugfs_file_operations_wo;
548 return &lnet_debugfs_file_operations_rw;
551 void lnet_insert_debugfs(struct ctl_table *table)
553 if (!lnet_debugfs_root)
554 lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
556 /* Even if we cannot create, just ignore it altogether) */
557 if (IS_ERR_OR_NULL(lnet_debugfs_root))
560 /* We don't save the dentry returned in next two calls, because
561 * we don't call debugfs_remove() but rather remove_recursive()
563 for (; table && table->procname; table++)
564 debugfs_create_file(table->procname, table->mode,
565 lnet_debugfs_root, table,
566 lnet_debugfs_fops_select(table->mode));
568 EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
570 static void lnet_insert_debugfs_links(
571 const struct lnet_debugfs_symlink_def *symlinks)
573 for (; symlinks && symlinks->name; symlinks++)
574 debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
578 void lnet_remove_debugfs(struct ctl_table *table)
580 for (; table && table->procname; table++) {
581 struct qstr dname = QSTR_INIT(table->procname,
582 strlen(table->procname));
583 struct dentry *dentry;
585 dentry = d_hash_and_lookup(lnet_debugfs_root, &dname);
586 debugfs_remove(dentry);
589 EXPORT_SYMBOL_GPL(lnet_remove_debugfs);
591 static int __init libcfs_init(void)
595 #ifndef HAVE_WAIT_VAR_EVENT
598 rc = libcfs_debug_init(5 * 1024 * 1024);
600 printk(KERN_ERR "LustreError: libcfs_debug_init: %d\n", rc);
608 rc = misc_register(&libcfs_dev);
610 CERROR("misc_register: error %d\n", rc);
614 rc = cfs_wi_startup();
616 CERROR("initialize workitem: error %d\n", rc);
617 goto cleanup_deregister;
620 cfs_rehash_wq = alloc_workqueue("cfs_rh", WQ_SYSFS, 4);
621 if (!cfs_rehash_wq) {
623 CERROR("libcfs: failed to start rehash workqueue: rc = %d\n",
625 goto cleanup_deregister;
628 rc = cfs_crypto_register();
630 CERROR("cfs_crypto_regster: error %d\n", rc);
634 lnet_insert_debugfs(lnet_table);
635 if (!IS_ERR_OR_NULL(lnet_debugfs_root))
636 lnet_insert_debugfs_links(lnet_debugfs_symlinks);
638 CDEBUG (D_OTHER, "portals setup OK\n");
643 misc_deregister(&libcfs_dev);
647 libcfs_debug_cleanup();
651 static void __exit libcfs_exit(void)
655 /* Remove everthing */
656 debugfs_remove_recursive(lnet_debugfs_root);
657 lnet_debugfs_root = NULL;
659 CDEBUG(D_MALLOC, "before Portals cleanup: kmem %d\n",
660 atomic_read(&libcfs_kmemory));
663 destroy_workqueue(cfs_rehash_wq);
664 cfs_rehash_wq = NULL;
667 cfs_crypto_unregister();
670 misc_deregister(&libcfs_dev);
674 if (atomic_read(&libcfs_kmemory) != 0)
675 CERROR("Portals memory leaked: %d bytes\n",
676 atomic_read(&libcfs_kmemory));
678 rc = libcfs_debug_cleanup();
680 printk(KERN_ERR "LustreError: libcfs_debug_cleanup: %d\n",
684 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
685 MODULE_DESCRIPTION("Lustre helper library");
686 MODULE_VERSION(LIBCFS_VERSION);
687 MODULE_LICENSE("GPL");
689 module_init(libcfs_init);
690 module_exit(libcfs_exit);