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 if (data->ioc_hdr.ioc_len > BIT(30))
79 if (data->ioc_inllen1 > BIT(30))
82 if (data->ioc_inllen2 > BIT(30))
85 if (data->ioc_inlbuf1 && !data->ioc_inllen1)
88 if (data->ioc_inlbuf2 && !data->ioc_inllen2)
91 if (data->ioc_pbuf1 && !data->ioc_plen1)
94 if (data->ioc_pbuf2 && !data->ioc_plen2)
97 if (data->ioc_plen1 && !data->ioc_pbuf1)
100 if (data->ioc_plen2 && !data->ioc_pbuf2)
103 if (libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len)
106 if (data->ioc_inllen1 &&
107 data->ioc_bulk[((data->ioc_inllen1 + 7) & ~7) +
108 data->ioc_inllen2 - 1] != '\0')
114 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data)
118 if (libcfs_ioctl_is_invalid(data)) {
119 CERROR("libcfs ioctl: parameter not correctly formatted\n");
123 if (data->ioc_inllen1 != 0)
124 data->ioc_inlbuf1 = &data->ioc_bulk[0];
126 if (data->ioc_inllen2 != 0)
127 data->ioc_inlbuf2 = &data->ioc_bulk[0] +
128 cfs_size_round(data->ioc_inllen1);
133 int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
134 struct libcfs_ioctl_hdr __user *uhdr)
136 struct libcfs_ioctl_hdr hdr;
140 if (copy_from_user(&hdr, uhdr, sizeof(hdr)))
143 if (hdr.ioc_version != LIBCFS_IOCTL_VERSION &&
144 hdr.ioc_version != LIBCFS_IOCTL_VERSION2) {
145 CERROR("libcfs ioctl: version mismatch expected %#x, got %#x\n",
146 LIBCFS_IOCTL_VERSION, hdr.ioc_version);
150 if (hdr.ioc_len < sizeof(struct libcfs_ioctl_hdr)) {
151 CERROR("libcfs ioctl: user buffer too small for ioctl\n");
155 if (hdr.ioc_len > LIBCFS_IOC_DATA_MAX) {
156 CERROR("libcfs ioctl: user buffer is too large %d/%d\n",
157 hdr.ioc_len, LIBCFS_IOC_DATA_MAX);
161 LIBCFS_ALLOC(*hdr_pp, hdr.ioc_len);
165 if (copy_from_user(*hdr_pp, uhdr, hdr.ioc_len))
166 GOTO(free, err = -EFAULT);
168 if ((*hdr_pp)->ioc_version != hdr.ioc_version ||
169 (*hdr_pp)->ioc_len != hdr.ioc_len) {
170 GOTO(free, err = -EINVAL);
176 LIBCFS_FREE(*hdr_pp, hdr.ioc_len);
180 static int libcfs_ioctl(unsigned long cmd, void __user *uparam)
182 struct libcfs_ioctl_data *data = NULL;
183 struct libcfs_ioctl_hdr *hdr;
187 /* 'cmd' and permissions get checked in our arch-specific caller */
188 err = libcfs_ioctl_getdata(&hdr, uparam);
190 CDEBUG_LIMIT(D_ERROR,
191 "libcfs ioctl: data header error %d\n", err);
195 if (hdr->ioc_version == LIBCFS_IOCTL_VERSION) {
196 /* The libcfs_ioctl_data_adjust() function performs adjustment
197 * operations on the libcfs_ioctl_data structure to make
198 * it usable by the code. This doesn't need to be called
199 * for new data structures added. */
200 data = container_of(hdr, struct libcfs_ioctl_data, ioc_hdr);
201 err = libcfs_ioctl_data_adjust(data);
206 CDEBUG(D_IOCTL, "libcfs ioctl cmd %lu\n", cmd);
208 case IOC_LIBCFS_CLEAR_DEBUG:
209 libcfs_debug_clear_buffer();
211 case IOC_LIBCFS_MARK_DEBUG:
213 data->ioc_inlbuf1 == NULL ||
214 data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
215 GOTO(out, err = -EINVAL);
217 libcfs_debug_mark_buffer(data->ioc_inlbuf1);
221 err = blocking_notifier_call_chain(&libcfs_ioctl_list,
223 if (!(err & NOTIFY_STOP_MASK))
224 /* No-one claimed the ioctl */
227 err = notifier_to_errno(err);
228 if (copy_to_user(uparam, hdr, hdr->ioc_len) && !err)
233 LIBCFS_FREE(hdr, hdr->ioc_len);
238 libcfs_psdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
240 if (!capable(CAP_SYS_ADMIN))
243 if (_IOC_TYPE(cmd) != IOC_LIBCFS_TYPE ||
244 _IOC_NR(cmd) < IOC_LIBCFS_MIN_NR ||
245 _IOC_NR(cmd) > IOC_LIBCFS_MAX_NR) {
246 CDEBUG(D_IOCTL, "invalid ioctl ( type %d, nr %d, size %d )\n",
247 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
251 return libcfs_ioctl(cmd, (void __user *)arg);
254 static const struct file_operations libcfs_fops = {
255 .owner = THIS_MODULE,
256 .unlocked_ioctl = libcfs_psdev_ioctl,
259 static struct miscdevice libcfs_dev = {
260 .minor = MISC_DYNAMIC_MINOR,
262 .fops = &libcfs_fops,
265 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
266 void __user *buffer, size_t *lenp,
267 int (*handler)(void *data, int write, loff_t pos,
268 void __user *buffer, int len))
270 int rc = handler(data, write, *ppos, buffer, *lenp);
283 EXPORT_SYMBOL(lprocfs_call_handler);
285 static int __proc_dobitmasks(void *data, int write,
286 loff_t pos, void __user *buffer, int nob)
288 const int tmpstrlen = 512;
291 unsigned int *mask = data;
292 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
293 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
295 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 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
316 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
317 /* Always print LBUG/LASSERT to console, so keep this mask */
326 static int proc_dobitmasks(struct ctl_table *table, int write,
327 void __user *buffer, size_t *lenp, loff_t *ppos)
329 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
333 static int min_watchdog_ratelimit; /* disable ratelimiting */
334 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
336 static int __proc_dump_kernel(void *data, int write,
337 loff_t pos, void __user *buffer, int nob)
342 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
345 static int proc_dump_kernel(struct ctl_table *table, int write,
346 void __user *buffer, size_t *lenp, loff_t *ppos)
348 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
352 static int __proc_daemon_file(void *data, int write,
353 loff_t pos, void __user *buffer, int nob)
356 int len = strlen(cfs_tracefile);
361 return cfs_trace_copyout_string(buffer, nob,
362 cfs_tracefile + pos, "\n");
365 return cfs_trace_daemon_command_usrstr(buffer, nob);
368 static int proc_daemon_file(struct ctl_table *table, int write,
369 void __user *buffer, size_t *lenp, loff_t *ppos)
371 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
375 static int libcfs_force_lbug(struct ctl_table *table, int write,
377 size_t *lenp, loff_t *ppos)
384 static int proc_fail_loc(struct ctl_table *table, int write,
385 void __user *buffer, size_t *lenp, loff_t *ppos)
388 long old_fail_loc = cfs_fail_loc;
390 rc = proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
391 if (old_fail_loc != cfs_fail_loc) {
393 wake_up(&cfs_race_waitq);
398 static int __proc_cpt_table(void *data, int write,
399 loff_t pos, void __user *buffer, int nob)
408 LASSERT(cfs_cpt_tab);
411 LIBCFS_ALLOC(buf, len);
415 rc = cfs_cpt_table_print(cfs_cpt_tab, buf, len);
420 LIBCFS_FREE(buf, len);
432 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
435 LIBCFS_FREE(buf, len);
439 static int proc_cpt_table(struct ctl_table *table, int write,
440 void __user *buffer, size_t *lenp, loff_t *ppos)
442 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
446 static int __proc_cpt_distance(void *data, int write,
447 loff_t pos, void __user *buffer, int nob)
456 LASSERT(cfs_cpt_tab);
459 LIBCFS_ALLOC(buf, len);
463 rc = cfs_cpt_distance_print(cfs_cpt_tab, buf, len);
468 LIBCFS_FREE(buf, len);
480 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
483 LIBCFS_FREE(buf, len);
487 static int proc_cpt_distance(struct ctl_table *table, int write,
488 void __user *buffer, size_t *lenp, loff_t *ppos)
490 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
491 __proc_cpt_distance);
494 static struct ctl_table lnet_table[] = {
497 .data = &libcfs_debug,
498 .maxlen = sizeof(int),
500 .proc_handler = &proc_dobitmasks,
503 .procname = "subsystem_debug",
504 .data = &libcfs_subsystem_debug,
505 .maxlen = sizeof(int),
507 .proc_handler = &proc_dobitmasks,
510 .procname = "printk",
511 .data = &libcfs_printk,
512 .maxlen = sizeof(int),
514 .proc_handler = &proc_dobitmasks,
517 .procname = "cpu_partition_table",
520 .proc_handler = &proc_cpt_table,
523 .procname = "cpu_partition_distance",
526 .proc_handler = &proc_cpt_distance,
529 .procname = "debug_log_upcall",
530 .data = lnet_debug_log_upcall,
531 .maxlen = sizeof(lnet_debug_log_upcall),
533 .proc_handler = &proc_dostring,
536 .procname = "lnet_memused",
537 .data = (int *)&libcfs_kmemory.counter,
538 .maxlen = sizeof(int),
540 .proc_handler = &proc_dointvec,
543 .procname = "catastrophe",
544 .data = &libcfs_catastrophe,
545 .maxlen = sizeof(int),
547 .proc_handler = &proc_dointvec,
550 .procname = "dump_kernel",
553 .proc_handler = &proc_dump_kernel,
556 .procname = "daemon_file",
559 .proc_handler = &proc_daemon_file,
562 .procname = "watchdog_ratelimit",
563 .data = &libcfs_watchdog_ratelimit,
564 .maxlen = sizeof(int),
566 .proc_handler = &proc_dointvec_minmax,
567 .extra1 = &min_watchdog_ratelimit,
568 .extra2 = &max_watchdog_ratelimit,
571 .procname = "force_lbug",
575 .proc_handler = &libcfs_force_lbug
578 .procname = "fail_loc",
579 .data = &cfs_fail_loc,
580 .maxlen = sizeof(cfs_fail_loc),
582 .proc_handler = &proc_fail_loc
585 .procname = "fail_val",
586 .data = &cfs_fail_val,
587 .maxlen = sizeof(int),
589 .proc_handler = &proc_dointvec
592 .procname = "fail_err",
593 .data = &cfs_fail_err,
594 .maxlen = sizeof(cfs_fail_err),
596 .proc_handler = &proc_dointvec,
602 static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
603 { .name = "console_ratelimit",
604 .target = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
605 { .name = "debug_path",
606 .target = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
607 { .name = "panic_on_lbug",
608 .target = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
609 { .name = "console_backoff",
610 .target = "../../../module/libcfs/parameters/libcfs_console_backoff" },
611 { .name = "debug_mb",
612 .target = "../../../module/libcfs/parameters/libcfs_debug_mb" },
613 { .name = "console_min_delay_centisecs",
614 .target = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
615 { .name = "console_max_delay_centisecs",
616 .target = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
620 static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
621 size_t count, loff_t *ppos)
623 struct ctl_table *table = filp->private_data;
624 ssize_t rc = -EINVAL;
627 rc = table->proc_handler(table, 0, buf, &count, ppos);
635 static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
636 size_t count, loff_t *ppos)
638 struct ctl_table *table = filp->private_data;
639 ssize_t rc = -EINVAL;
642 rc = table->proc_handler(table, 1, (void __user *)buf, &count,
651 static const struct file_operations lnet_debugfs_file_operations_rw = {
653 .read = lnet_debugfs_read,
654 .write = lnet_debugfs_write,
655 .llseek = default_llseek,
658 static const struct file_operations lnet_debugfs_file_operations_ro = {
660 .read = lnet_debugfs_read,
661 .llseek = default_llseek,
664 static const struct file_operations lnet_debugfs_file_operations_wo = {
666 .write = lnet_debugfs_write,
667 .llseek = default_llseek,
670 static const struct file_operations *lnet_debugfs_fops_select(umode_t mode)
672 if (!(mode & S_IWUGO))
673 return &lnet_debugfs_file_operations_ro;
675 if (!(mode & S_IRUGO))
676 return &lnet_debugfs_file_operations_wo;
678 return &lnet_debugfs_file_operations_rw;
681 void lnet_insert_debugfs(struct ctl_table *table)
683 if (!lnet_debugfs_root)
684 lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
686 /* Even if we cannot create, just ignore it altogether) */
687 if (IS_ERR_OR_NULL(lnet_debugfs_root))
690 /* We don't save the dentry returned in next two calls, because
691 * we don't call debugfs_remove() but rather remove_recursive()
693 for (; table && table->procname; table++)
694 debugfs_create_file(table->procname, table->mode,
695 lnet_debugfs_root, table,
696 lnet_debugfs_fops_select(table->mode));
698 EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
700 static void lnet_insert_debugfs_links(
701 const struct lnet_debugfs_symlink_def *symlinks)
703 for (; symlinks && symlinks->name; symlinks++)
704 debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
708 void lnet_remove_debugfs(struct ctl_table *table)
710 for (; table && table->procname; table++) {
711 struct qstr dname = QSTR_INIT(table->procname,
712 strlen(table->procname));
713 struct dentry *dentry;
715 dentry = d_hash_and_lookup(lnet_debugfs_root, &dname);
716 debugfs_remove(dentry);
719 EXPORT_SYMBOL_GPL(lnet_remove_debugfs);
721 static int __init libcfs_init(void)
727 rc = libcfs_debug_init(5 * 1024 * 1024);
729 pr_err("LustreError: libcfs_debug_init: rc = %d\n", rc);
737 rc = misc_register(&libcfs_dev);
739 CERROR("misc_register: error %d\n", rc);
743 rc = cfs_wi_startup();
745 CERROR("initialize workitem: error %d\n", rc);
746 goto cleanup_deregister;
749 cfs_rehash_wq = alloc_workqueue("cfs_rh", WQ_SYSFS, 4);
750 if (!cfs_rehash_wq) {
752 CERROR("libcfs: failed to start rehash workqueue: rc = %d\n",
754 goto cleanup_deregister;
757 rc = cfs_crypto_register();
759 CERROR("cfs_crypto_regster: error %d\n", rc);
763 lnet_insert_debugfs(lnet_table);
764 if (!IS_ERR_OR_NULL(lnet_debugfs_root))
765 lnet_insert_debugfs_links(lnet_debugfs_symlinks);
769 CERROR("llcrypt_init: error %d\n", rc);
773 CDEBUG (D_OTHER, "portals setup OK\n");
778 misc_deregister(&libcfs_dev);
782 libcfs_debug_cleanup();
786 static void __exit libcfs_exit(void)
790 /* Remove everthing */
791 debugfs_remove_recursive(lnet_debugfs_root);
792 lnet_debugfs_root = NULL;
794 CDEBUG(D_MALLOC, "before Portals cleanup: kmem %d\n",
795 atomic_read(&libcfs_kmemory));
800 destroy_workqueue(cfs_rehash_wq);
801 cfs_rehash_wq = NULL;
804 cfs_crypto_unregister();
807 misc_deregister(&libcfs_dev);
811 /* the below message is checked in test-framework.sh check_mem_leak() */
812 if (atomic_read(&libcfs_kmemory) != 0)
813 CERROR("Portals memory leaked: %d bytes\n",
814 atomic_read(&libcfs_kmemory));
816 rc = libcfs_debug_cleanup();
818 pr_err("LustreError: libcfs_debug_cleanup: rc = %d\n", rc);
821 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
822 MODULE_DESCRIPTION("Lustre helper library");
823 MODULE_VERSION(LIBCFS_VERSION);
824 MODULE_LICENSE("GPL");
826 module_init(libcfs_init);
827 module_exit(libcfs_exit);