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 <libcfs/crypto/llcrypt.h>
58 #include "tracefile.h"
60 static struct dentry *lnet_debugfs_root;
62 BLOCKING_NOTIFIER_HEAD(libcfs_ioctl_list);
63 EXPORT_SYMBOL(libcfs_ioctl_list);
65 static inline size_t libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
67 size_t len = sizeof(*data);
69 len += (data->ioc_inllen1 + 7) & ~7;
70 len += (data->ioc_inllen2 + 7) & ~7;
74 static bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
76 const int maxlen = 1 << 30;
77 if (data->ioc_hdr.ioc_len > maxlen)
80 if (data->ioc_inllen1 > maxlen)
83 if (data->ioc_inllen2 > maxlen)
86 if (data->ioc_inlbuf1 && !data->ioc_inllen1)
89 if (data->ioc_inlbuf2 && !data->ioc_inllen2)
92 if (data->ioc_pbuf1 && !data->ioc_plen1)
95 if (data->ioc_pbuf2 && !data->ioc_plen2)
98 if (data->ioc_plen1 && !data->ioc_pbuf1)
101 if (data->ioc_plen2 && !data->ioc_pbuf2)
104 if (libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len)
107 if (data->ioc_inllen1 &&
108 data->ioc_bulk[((data->ioc_inllen1 + 7) & ~7) +
109 data->ioc_inllen2 - 1] != '\0')
115 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data)
119 if (libcfs_ioctl_is_invalid(data)) {
120 CERROR("libcfs ioctl: parameter not correctly formatted\n");
124 if (data->ioc_inllen1 != 0)
125 data->ioc_inlbuf1 = &data->ioc_bulk[0];
127 if (data->ioc_inllen2 != 0)
128 data->ioc_inlbuf2 = &data->ioc_bulk[0] +
129 cfs_size_round(data->ioc_inllen1);
134 int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
135 struct libcfs_ioctl_hdr __user *uhdr)
137 struct libcfs_ioctl_hdr hdr;
141 if (copy_from_user(&hdr, uhdr, sizeof(hdr)))
144 if (hdr.ioc_version != LIBCFS_IOCTL_VERSION &&
145 hdr.ioc_version != LIBCFS_IOCTL_VERSION2) {
146 CERROR("libcfs ioctl: version mismatch expected %#x, got %#x\n",
147 LIBCFS_IOCTL_VERSION, hdr.ioc_version);
151 if (hdr.ioc_len < sizeof(struct libcfs_ioctl_hdr)) {
152 CERROR("libcfs ioctl: user buffer too small for ioctl\n");
156 if (hdr.ioc_len > LIBCFS_IOC_DATA_MAX) {
157 CERROR("libcfs ioctl: user buffer is too large %d/%d\n",
158 hdr.ioc_len, LIBCFS_IOC_DATA_MAX);
162 LIBCFS_ALLOC(*hdr_pp, hdr.ioc_len);
166 if (copy_from_user(*hdr_pp, uhdr, hdr.ioc_len))
167 GOTO(free, err = -EFAULT);
169 if ((*hdr_pp)->ioc_version != hdr.ioc_version ||
170 (*hdr_pp)->ioc_len != hdr.ioc_len) {
171 GOTO(free, err = -EINVAL);
177 LIBCFS_FREE(*hdr_pp, hdr.ioc_len);
181 static int libcfs_ioctl(unsigned long cmd, void __user *uparam)
183 struct libcfs_ioctl_data *data = NULL;
184 struct libcfs_ioctl_hdr *hdr;
188 /* 'cmd' and permissions get checked in our arch-specific caller */
189 err = libcfs_ioctl_getdata(&hdr, uparam);
191 CDEBUG_LIMIT(D_ERROR,
192 "libcfs ioctl: data header error %d\n", err);
196 if (hdr->ioc_version == LIBCFS_IOCTL_VERSION) {
197 /* The libcfs_ioctl_data_adjust() function performs adjustment
198 * operations on the libcfs_ioctl_data structure to make
199 * it usable by the code. This doesn't need to be called
200 * for new data structures added. */
201 data = container_of(hdr, struct libcfs_ioctl_data, ioc_hdr);
202 err = libcfs_ioctl_data_adjust(data);
207 CDEBUG(D_IOCTL, "libcfs ioctl cmd %lu\n", cmd);
209 case IOC_LIBCFS_CLEAR_DEBUG:
210 libcfs_debug_clear_buffer();
212 case IOC_LIBCFS_MARK_DEBUG:
214 data->ioc_inlbuf1 == NULL ||
215 data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
216 GOTO(out, err = -EINVAL);
218 libcfs_debug_mark_buffer(data->ioc_inlbuf1);
222 err = blocking_notifier_call_chain(&libcfs_ioctl_list,
224 if (!(err & NOTIFY_STOP_MASK))
225 /* No-one claimed the ioctl */
228 err = notifier_to_errno(err);
229 if (copy_to_user(uparam, hdr, hdr->ioc_len) && !err)
234 LIBCFS_FREE(hdr, hdr->ioc_len);
239 libcfs_psdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
241 if (!capable(CAP_SYS_ADMIN))
244 if (_IOC_TYPE(cmd) != IOC_LIBCFS_TYPE ||
245 _IOC_NR(cmd) < IOC_LIBCFS_MIN_NR ||
246 _IOC_NR(cmd) > IOC_LIBCFS_MAX_NR) {
247 CDEBUG(D_IOCTL, "invalid ioctl ( type %d, nr %d, size %d )\n",
248 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
252 return libcfs_ioctl(cmd, (void __user *)arg);
255 static const struct file_operations libcfs_fops = {
256 .owner = THIS_MODULE,
257 .unlocked_ioctl = libcfs_psdev_ioctl,
260 static struct miscdevice libcfs_dev = {
261 .minor = MISC_DYNAMIC_MINOR,
263 .fops = &libcfs_fops,
266 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
267 void __user *buffer, size_t *lenp,
268 int (*handler)(void *data, int write, loff_t pos,
269 void __user *buffer, int len))
271 int rc = handler(data, write, *ppos, buffer, *lenp);
284 EXPORT_SYMBOL(lprocfs_call_handler);
286 static int __proc_dobitmasks(void *data, int write,
287 loff_t pos, void __user *buffer, int nob)
289 const int tmpstrlen = 512;
292 unsigned int *mask = data;
293 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
294 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
297 rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
300 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
306 rc = cfs_trace_copyout_string(buffer, nob,
310 tmpstr = memdup_user_nul(buffer, nob);
314 rc = libcfs_debug_str2mask(mask, strim(tmpstr), is_subsys);
315 /* Always print LBUG/LASSERT to console, so keep this mask */
324 static int proc_dobitmasks(struct ctl_table *table, int write,
325 void __user *buffer, size_t *lenp, loff_t *ppos)
327 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
331 static int min_watchdog_ratelimit; /* disable ratelimiting */
332 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
334 static int __proc_dump_kernel(void *data, int write,
335 loff_t pos, void __user *buffer, int nob)
340 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
343 static int proc_dump_kernel(struct ctl_table *table, int write,
344 void __user *buffer, size_t *lenp, loff_t *ppos)
346 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
350 static int __proc_daemon_file(void *data, int write,
351 loff_t pos, void __user *buffer, int nob)
354 int len = strlen(cfs_tracefile);
359 return cfs_trace_copyout_string(buffer, nob,
360 cfs_tracefile + pos, "\n");
363 return cfs_trace_daemon_command_usrstr(buffer, nob);
366 static int proc_daemon_file(struct ctl_table *table, int write,
367 void __user *buffer, size_t *lenp, loff_t *ppos)
369 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
373 static int libcfs_force_lbug(struct ctl_table *table, int write,
375 size_t *lenp, loff_t *ppos)
382 static int proc_fail_loc(struct ctl_table *table, int write,
383 void __user *buffer, size_t *lenp, loff_t *ppos)
386 long old_fail_loc = cfs_fail_loc;
388 if (!*lenp || *ppos) {
394 char *kbuf = memdup_user_nul(buffer, *lenp);
397 return PTR_ERR(kbuf);
398 rc = kstrtoul(kbuf, 0, &cfs_fail_loc);
404 rc = scnprintf(kbuf, sizeof(kbuf), "%lu\n", cfs_fail_loc);
405 if (copy_to_user(buffer, kbuf, rc))
413 if (old_fail_loc != cfs_fail_loc) {
415 wake_up(&cfs_race_waitq);
420 int debugfs_doint(struct ctl_table *table, int write,
421 void __user *buffer, size_t *lenp, loff_t *ppos)
425 if (!*lenp || *ppos) {
431 char *kbuf = memdup_user_nul(buffer, *lenp);
435 return PTR_ERR(kbuf);
437 rc = kstrtoint(kbuf, 0, &val);
440 if (table->extra1 && val < *(int *)table->extra1)
441 val = *(int *)table->extra1;
442 if (table->extra2 && val > *(int *)table->extra2)
443 val = *(int *)table->extra2;
444 *(int *)table->data = val;
450 rc = scnprintf(kbuf, sizeof(kbuf), "%u\n", *(int *)table->data);
451 if (copy_to_user(buffer, kbuf, rc))
461 EXPORT_SYMBOL(debugfs_doint);
463 static int debugfs_dou64(struct ctl_table *table, int write,
464 void __user *buffer, size_t *lenp, loff_t *ppos)
468 if (!*lenp || *ppos) {
474 char *kbuf = memdup_user_nul(buffer, *lenp);
475 unsigned long long val;
478 return PTR_ERR(kbuf);
480 rc = kstrtoull(kbuf, 0, &val);
483 *(u64 *)table->data = val;
488 rc = scnprintf(kbuf, sizeof(kbuf), "%llu\n",
489 (unsigned long long)*(u64 *)table->data);
490 if (copy_to_user(buffer, kbuf, rc))
501 static int debugfs_dostring(struct ctl_table *table, int write,
502 void __user *buffer, size_t *lenp, loff_t *ppos)
505 char *kbuf = table->data;
511 if (len > table->maxlen)
514 if (copy_from_user(kbuf, buffer, len))
516 memset(kbuf+len, 0, table->maxlen - len);
519 len = strnlen(kbuf, len);
520 if (copy_to_user(buffer, kbuf, len))
523 if (copy_to_user(buffer+len, "\n", 1))
533 static int __proc_cpt_table(void *data, int write,
534 loff_t pos, void __user *buffer, int nob)
544 LIBCFS_ALLOC(buf, len);
548 rc = cfs_cpt_table_print(cfs_cpt_tab, buf, len);
553 LIBCFS_FREE(buf, len);
565 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
568 LIBCFS_FREE(buf, len);
572 static int proc_cpt_table(struct ctl_table *table, int write,
573 void __user *buffer, size_t *lenp, loff_t *ppos)
575 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
579 static int __proc_cpt_distance(void *data, int write,
580 loff_t pos, void __user *buffer, int nob)
590 LIBCFS_ALLOC(buf, len);
594 rc = cfs_cpt_distance_print(cfs_cpt_tab, buf, len);
599 LIBCFS_FREE(buf, len);
611 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
614 LIBCFS_FREE(buf, len);
618 static int proc_cpt_distance(struct ctl_table *table, int write,
619 void __user *buffer, size_t *lenp, loff_t *ppos)
621 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
622 __proc_cpt_distance);
625 static struct ctl_table lnet_table[] = {
628 .data = &libcfs_debug,
629 .maxlen = sizeof(int),
631 .proc_handler = &proc_dobitmasks,
634 .procname = "subsystem_debug",
635 .data = &libcfs_subsystem_debug,
636 .maxlen = sizeof(int),
638 .proc_handler = &proc_dobitmasks,
641 .procname = "printk",
642 .data = &libcfs_printk,
643 .maxlen = sizeof(int),
645 .proc_handler = &proc_dobitmasks,
648 .procname = "cpu_partition_table",
651 .proc_handler = &proc_cpt_table,
654 .procname = "cpu_partition_distance",
657 .proc_handler = &proc_cpt_distance,
660 .procname = "debug_log_upcall",
661 .data = lnet_debug_log_upcall,
662 .maxlen = sizeof(lnet_debug_log_upcall),
664 .proc_handler = &debugfs_dostring,
667 .procname = "lnet_memused",
668 .data = (u64 *)&libcfs_kmem.counter,
669 .maxlen = sizeof(u64),
671 .proc_handler = &debugfs_dou64,
674 .procname = "catastrophe",
675 .data = &libcfs_catastrophe,
676 .maxlen = sizeof(int),
678 .proc_handler = &debugfs_doint,
681 .procname = "dump_kernel",
684 .proc_handler = &proc_dump_kernel,
687 .procname = "daemon_file",
690 .proc_handler = &proc_daemon_file,
693 .procname = "watchdog_ratelimit",
694 .data = &libcfs_watchdog_ratelimit,
695 .maxlen = sizeof(int),
697 .proc_handler = &debugfs_doint,
698 .extra1 = &min_watchdog_ratelimit,
699 .extra2 = &max_watchdog_ratelimit,
702 .procname = "force_lbug",
706 .proc_handler = &libcfs_force_lbug
709 .procname = "fail_loc",
710 .data = &cfs_fail_loc,
711 .maxlen = sizeof(cfs_fail_loc),
713 .proc_handler = &proc_fail_loc
716 .procname = "fail_val",
717 .data = &cfs_fail_val,
718 .maxlen = sizeof(int),
720 .proc_handler = &debugfs_doint
723 .procname = "fail_err",
724 .data = &cfs_fail_err,
725 .maxlen = sizeof(cfs_fail_err),
727 .proc_handler = &debugfs_doint,
733 static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
734 { .name = "console_ratelimit",
735 .target = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
736 { .name = "debug_path",
737 .target = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
738 { .name = "panic_on_lbug",
739 .target = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
740 { .name = "console_backoff",
741 .target = "../../../module/libcfs/parameters/libcfs_console_backoff" },
742 { .name = "debug_mb",
743 .target = "../../../module/libcfs/parameters/libcfs_debug_mb" },
744 { .name = "console_min_delay_centisecs",
745 .target = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
746 { .name = "console_max_delay_centisecs",
747 .target = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
751 static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
752 size_t count, loff_t *ppos)
754 struct ctl_table *table = filp->private_data;
755 ssize_t rc = -EINVAL;
758 rc = table->proc_handler(table, 0, buf, &count, ppos);
766 static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
767 size_t count, loff_t *ppos)
769 struct ctl_table *table = filp->private_data;
770 ssize_t rc = -EINVAL;
773 rc = table->proc_handler(table, 1, (void __user *)buf, &count,
782 static const struct file_operations lnet_debugfs_file_operations_rw = {
784 .read = lnet_debugfs_read,
785 .write = lnet_debugfs_write,
786 .llseek = default_llseek,
789 static const struct file_operations lnet_debugfs_file_operations_ro = {
791 .read = lnet_debugfs_read,
792 .llseek = default_llseek,
795 static const struct file_operations lnet_debugfs_file_operations_wo = {
797 .write = lnet_debugfs_write,
798 .llseek = default_llseek,
801 static const struct file_operations *lnet_debugfs_fops_select(umode_t mode)
803 if (!(mode & S_IWUGO))
804 return &lnet_debugfs_file_operations_ro;
806 if (!(mode & S_IRUGO))
807 return &lnet_debugfs_file_operations_wo;
809 return &lnet_debugfs_file_operations_rw;
812 void lnet_insert_debugfs(struct ctl_table *table)
814 if (!lnet_debugfs_root)
815 lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
817 /* Even if we cannot create, just ignore it altogether) */
818 if (IS_ERR_OR_NULL(lnet_debugfs_root))
821 /* We don't save the dentry returned in next two calls, because
822 * we don't call debugfs_remove() but rather remove_recursive()
824 for (; table && table->procname; table++)
825 debugfs_create_file(table->procname, table->mode,
826 lnet_debugfs_root, table,
827 lnet_debugfs_fops_select(table->mode));
829 EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
831 static void lnet_insert_debugfs_links(
832 const struct lnet_debugfs_symlink_def *symlinks)
834 for (; symlinks && symlinks->name; symlinks++)
835 debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
839 void lnet_remove_debugfs(struct ctl_table *table)
841 for (; table && table->procname; table++) {
842 struct qstr dname = QSTR_INIT(table->procname,
843 strlen(table->procname));
844 struct dentry *dentry;
846 dentry = d_hash_and_lookup(lnet_debugfs_root, &dname);
847 debugfs_remove(dentry);
850 EXPORT_SYMBOL_GPL(lnet_remove_debugfs);
852 static int __init libcfs_init(void)
858 init_libcfs_vfree_atomic();
860 rc = libcfs_debug_init(5 * 1024 * 1024);
862 pr_err("LustreError: libcfs_debug_init: rc = %d\n", rc);
872 rc = misc_register(&libcfs_dev);
874 CERROR("misc_register: error %d\n", rc);
878 rc = cfs_wi_startup();
880 CERROR("initialize workitem: error %d\n", rc);
881 goto cleanup_deregister;
884 cfs_rehash_wq = alloc_workqueue("cfs_rh", WQ_SYSFS, 4);
885 if (!cfs_rehash_wq) {
887 CERROR("libcfs: failed to start rehash workqueue: rc = %d\n",
889 goto cleanup_deregister;
892 rc = cfs_crypto_register();
894 CERROR("cfs_crypto_regster: error %d\n", rc);
898 lnet_insert_debugfs(lnet_table);
899 if (!IS_ERR_OR_NULL(lnet_debugfs_root))
900 lnet_insert_debugfs_links(lnet_debugfs_symlinks);
904 CERROR("llcrypt_init: error %d\n", rc);
908 CDEBUG (D_OTHER, "portals setup OK\n");
913 misc_deregister(&libcfs_dev);
917 libcfs_debug_cleanup();
921 static void __exit libcfs_exit(void)
925 /* Remove everthing */
926 debugfs_remove_recursive(lnet_debugfs_root);
927 lnet_debugfs_root = NULL;
929 CDEBUG(D_MALLOC, "before Portals cleanup: kmem %lld\n",
935 destroy_workqueue(cfs_rehash_wq);
936 cfs_rehash_wq = NULL;
939 cfs_crypto_unregister();
942 misc_deregister(&libcfs_dev);
946 /* the below message is checked in test-framework.sh check_mem_leak() */
947 if (libcfs_kmem_read() != 0)
948 CERROR("Portals memory leaked: %lld bytes\n",
951 rc = libcfs_debug_cleanup();
953 pr_err("LustreError: libcfs_debug_cleanup: rc = %d\n", rc);
955 exit_libcfs_vfree_atomic();
958 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
959 MODULE_DESCRIPTION("Lustre helper library");
960 MODULE_VERSION(LIBCFS_VERSION);
961 MODULE_LICENSE("GPL");
963 module_init(libcfs_init);
964 module_exit(libcfs_exit);