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 static inline size_t libcfs_ioctl_packlen(struct libcfs_ioctl_data *data)
66 size_t len = sizeof(*data);
68 len += (data->ioc_inllen1 + 7) & ~7;
69 len += (data->ioc_inllen2 + 7) & ~7;
73 static bool libcfs_ioctl_is_invalid(struct libcfs_ioctl_data *data)
75 if (data->ioc_hdr.ioc_len > BIT(30))
78 if (data->ioc_inllen1 > BIT(30))
81 if (data->ioc_inllen2 > BIT(30))
84 if (data->ioc_inlbuf1 && !data->ioc_inllen1)
87 if (data->ioc_inlbuf2 && !data->ioc_inllen2)
90 if (data->ioc_pbuf1 && !data->ioc_plen1)
93 if (data->ioc_pbuf2 && !data->ioc_plen2)
96 if (data->ioc_plen1 && !data->ioc_pbuf1)
99 if (data->ioc_plen2 && !data->ioc_pbuf2)
102 if (libcfs_ioctl_packlen(data) != data->ioc_hdr.ioc_len)
105 if (data->ioc_inllen1 &&
106 data->ioc_bulk[((data->ioc_inllen1 + 7) & ~7) +
107 data->ioc_inllen2 - 1] != '\0')
113 int libcfs_ioctl_data_adjust(struct libcfs_ioctl_data *data)
117 if (libcfs_ioctl_is_invalid(data)) {
118 CERROR("libcfs ioctl: parameter not correctly formatted\n");
122 if (data->ioc_inllen1 != 0)
123 data->ioc_inlbuf1 = &data->ioc_bulk[0];
125 if (data->ioc_inllen2 != 0)
126 data->ioc_inlbuf2 = &data->ioc_bulk[0] +
127 cfs_size_round(data->ioc_inllen1);
132 int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
133 struct libcfs_ioctl_hdr __user *uhdr)
135 struct libcfs_ioctl_hdr hdr;
139 if (copy_from_user(&hdr, uhdr, sizeof(hdr)))
142 if (hdr.ioc_version != LIBCFS_IOCTL_VERSION &&
143 hdr.ioc_version != LIBCFS_IOCTL_VERSION2) {
144 CERROR("libcfs ioctl: version mismatch expected %#x, got %#x\n",
145 LIBCFS_IOCTL_VERSION, hdr.ioc_version);
149 if (hdr.ioc_len < sizeof(struct libcfs_ioctl_hdr)) {
150 CERROR("libcfs ioctl: user buffer too small for ioctl\n");
154 if (hdr.ioc_len > LIBCFS_IOC_DATA_MAX) {
155 CERROR("libcfs ioctl: user buffer is too large %d/%d\n",
156 hdr.ioc_len, LIBCFS_IOC_DATA_MAX);
160 LIBCFS_ALLOC(*hdr_pp, hdr.ioc_len);
164 if (copy_from_user(*hdr_pp, uhdr, hdr.ioc_len))
165 GOTO(free, err = -EFAULT);
167 if ((*hdr_pp)->ioc_version != hdr.ioc_version ||
168 (*hdr_pp)->ioc_len != hdr.ioc_len) {
169 GOTO(free, err = -EINVAL);
175 LIBCFS_FREE(*hdr_pp, hdr.ioc_len);
179 static int libcfs_ioctl(unsigned long cmd, void __user *uparam)
181 struct libcfs_ioctl_data *data = NULL;
182 struct libcfs_ioctl_hdr *hdr;
186 /* 'cmd' and permissions get checked in our arch-specific caller */
187 err = libcfs_ioctl_getdata(&hdr, uparam);
189 CDEBUG_LIMIT(D_ERROR,
190 "libcfs ioctl: data header error %d\n", err);
194 if (hdr->ioc_version == LIBCFS_IOCTL_VERSION) {
195 /* The libcfs_ioctl_data_adjust() function performs adjustment
196 * operations on the libcfs_ioctl_data structure to make
197 * it usable by the code. This doesn't need to be called
198 * for new data structures added. */
199 data = container_of(hdr, struct libcfs_ioctl_data, ioc_hdr);
200 err = libcfs_ioctl_data_adjust(data);
205 CDEBUG(D_IOCTL, "libcfs ioctl cmd %lu\n", cmd);
207 case IOC_LIBCFS_CLEAR_DEBUG:
208 libcfs_debug_clear_buffer();
210 case IOC_LIBCFS_MARK_DEBUG:
212 data->ioc_inlbuf1 == NULL ||
213 data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
214 GOTO(out, err = -EINVAL);
216 libcfs_debug_mark_buffer(data->ioc_inlbuf1);
220 err = blocking_notifier_call_chain(&libcfs_ioctl_list,
222 if (!(err & NOTIFY_STOP_MASK))
223 /* No-one claimed the ioctl */
226 err = notifier_to_errno(err);
227 if (copy_to_user(uparam, hdr, hdr->ioc_len) && !err)
232 LIBCFS_FREE(hdr, hdr->ioc_len);
237 libcfs_psdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
239 if (!capable(CAP_SYS_ADMIN))
242 if (_IOC_TYPE(cmd) != IOC_LIBCFS_TYPE ||
243 _IOC_NR(cmd) < IOC_LIBCFS_MIN_NR ||
244 _IOC_NR(cmd) > IOC_LIBCFS_MAX_NR) {
245 CDEBUG(D_IOCTL, "invalid ioctl ( type %d, nr %d, size %d )\n",
246 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
250 return libcfs_ioctl(cmd, (void __user *)arg);
253 static const struct file_operations libcfs_fops = {
254 .owner = THIS_MODULE,
255 .unlocked_ioctl = libcfs_psdev_ioctl,
258 static struct miscdevice libcfs_dev = {
259 .minor = MISC_DYNAMIC_MINOR,
261 .fops = &libcfs_fops,
264 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
265 void __user *buffer, size_t *lenp,
266 int (*handler)(void *data, int write, loff_t pos,
267 void __user *buffer, int len))
269 int rc = handler(data, write, *ppos, buffer, *lenp);
282 EXPORT_SYMBOL(lprocfs_call_handler);
284 static int __proc_dobitmasks(void *data, int write,
285 loff_t pos, void __user *buffer, int nob)
287 const int tmpstrlen = 512;
290 unsigned int *mask = data;
291 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
292 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
294 rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
299 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
305 rc = cfs_trace_copyout_string(buffer, nob,
309 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
315 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
316 /* Always print LBUG/LASSERT to console, so keep this mask */
325 static int proc_dobitmasks(struct ctl_table *table, int write,
326 void __user *buffer, size_t *lenp, loff_t *ppos)
328 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
332 static int min_watchdog_ratelimit; /* disable ratelimiting */
333 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
335 static int __proc_dump_kernel(void *data, int write,
336 loff_t pos, void __user *buffer, int nob)
341 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
344 static int proc_dump_kernel(struct ctl_table *table, int write,
345 void __user *buffer, size_t *lenp, loff_t *ppos)
347 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
351 static int __proc_daemon_file(void *data, int write,
352 loff_t pos, void __user *buffer, int nob)
355 int len = strlen(cfs_tracefile);
360 return cfs_trace_copyout_string(buffer, nob,
361 cfs_tracefile + pos, "\n");
364 return cfs_trace_daemon_command_usrstr(buffer, nob);
367 static int proc_daemon_file(struct ctl_table *table, int write,
368 void __user *buffer, size_t *lenp, loff_t *ppos)
370 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
374 static int libcfs_force_lbug(struct ctl_table *table, int write,
376 size_t *lenp, loff_t *ppos)
383 static int proc_fail_loc(struct ctl_table *table, int write,
384 void __user *buffer, size_t *lenp, loff_t *ppos)
387 long old_fail_loc = cfs_fail_loc;
389 rc = proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
390 if (old_fail_loc != cfs_fail_loc)
391 wake_up(&cfs_race_waitq);
395 static int __proc_cpt_table(void *data, int write,
396 loff_t pos, void __user *buffer, int nob)
405 LASSERT(cfs_cpt_tab);
408 LIBCFS_ALLOC(buf, len);
412 rc = cfs_cpt_table_print(cfs_cpt_tab, buf, len);
417 LIBCFS_FREE(buf, len);
429 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
432 LIBCFS_FREE(buf, len);
436 static int proc_cpt_table(struct ctl_table *table, int write,
437 void __user *buffer, size_t *lenp, loff_t *ppos)
439 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
443 static int __proc_cpt_distance(void *data, int write,
444 loff_t pos, void __user *buffer, int nob)
453 LASSERT(cfs_cpt_tab);
456 LIBCFS_ALLOC(buf, len);
460 rc = cfs_cpt_distance_print(cfs_cpt_tab, buf, len);
465 LIBCFS_FREE(buf, len);
477 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
480 LIBCFS_FREE(buf, len);
484 static int proc_cpt_distance(struct ctl_table *table, int write,
485 void __user *buffer, size_t *lenp, loff_t *ppos)
487 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
488 __proc_cpt_distance);
491 static struct ctl_table lnet_table[] = {
494 .data = &libcfs_debug,
495 .maxlen = sizeof(int),
497 .proc_handler = &proc_dobitmasks,
500 .procname = "subsystem_debug",
501 .data = &libcfs_subsystem_debug,
502 .maxlen = sizeof(int),
504 .proc_handler = &proc_dobitmasks,
507 .procname = "printk",
508 .data = &libcfs_printk,
509 .maxlen = sizeof(int),
511 .proc_handler = &proc_dobitmasks,
514 .procname = "cpu_partition_table",
517 .proc_handler = &proc_cpt_table,
520 .procname = "cpu_partition_distance",
523 .proc_handler = &proc_cpt_distance,
526 .procname = "debug_log_upcall",
527 .data = lnet_debug_log_upcall,
528 .maxlen = sizeof(lnet_debug_log_upcall),
530 .proc_handler = &proc_dostring,
533 .procname = "lnet_memused",
534 .data = (int *)&libcfs_kmemory.counter,
535 .maxlen = sizeof(int),
537 .proc_handler = &proc_dointvec,
540 .procname = "catastrophe",
541 .data = &libcfs_catastrophe,
542 .maxlen = sizeof(int),
544 .proc_handler = &proc_dointvec,
547 .procname = "dump_kernel",
550 .proc_handler = &proc_dump_kernel,
553 .procname = "daemon_file",
556 .proc_handler = &proc_daemon_file,
559 .procname = "watchdog_ratelimit",
560 .data = &libcfs_watchdog_ratelimit,
561 .maxlen = sizeof(int),
563 .proc_handler = &proc_dointvec_minmax,
564 .extra1 = &min_watchdog_ratelimit,
565 .extra2 = &max_watchdog_ratelimit,
568 .procname = "force_lbug",
572 .proc_handler = &libcfs_force_lbug
575 .procname = "fail_loc",
576 .data = &cfs_fail_loc,
577 .maxlen = sizeof(cfs_fail_loc),
579 .proc_handler = &proc_fail_loc
582 .procname = "fail_val",
583 .data = &cfs_fail_val,
584 .maxlen = sizeof(int),
586 .proc_handler = &proc_dointvec
589 .procname = "fail_err",
590 .data = &cfs_fail_err,
591 .maxlen = sizeof(cfs_fail_err),
593 .proc_handler = &proc_dointvec,
599 static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
600 { .name = "console_ratelimit",
601 .target = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
602 { .name = "debug_path",
603 .target = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
604 { .name = "panic_on_lbug",
605 .target = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
606 { .name = "console_backoff",
607 .target = "../../../module/libcfs/parameters/libcfs_console_backoff" },
608 { .name = "debug_mb",
609 .target = "../../../module/libcfs/parameters/libcfs_debug_mb" },
610 { .name = "console_min_delay_centisecs",
611 .target = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
612 { .name = "console_max_delay_centisecs",
613 .target = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
617 static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
618 size_t count, loff_t *ppos)
620 struct ctl_table *table = filp->private_data;
621 ssize_t rc = -EINVAL;
624 rc = table->proc_handler(table, 0, buf, &count, ppos);
632 static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
633 size_t count, loff_t *ppos)
635 struct ctl_table *table = filp->private_data;
636 ssize_t rc = -EINVAL;
639 rc = table->proc_handler(table, 1, (void __user *)buf, &count,
648 static const struct file_operations lnet_debugfs_file_operations_rw = {
650 .read = lnet_debugfs_read,
651 .write = lnet_debugfs_write,
652 .llseek = default_llseek,
655 static const struct file_operations lnet_debugfs_file_operations_ro = {
657 .read = lnet_debugfs_read,
658 .llseek = default_llseek,
661 static const struct file_operations lnet_debugfs_file_operations_wo = {
663 .write = lnet_debugfs_write,
664 .llseek = default_llseek,
667 static const struct file_operations *lnet_debugfs_fops_select(umode_t mode)
669 if (!(mode & S_IWUGO))
670 return &lnet_debugfs_file_operations_ro;
672 if (!(mode & S_IRUGO))
673 return &lnet_debugfs_file_operations_wo;
675 return &lnet_debugfs_file_operations_rw;
678 void lnet_insert_debugfs(struct ctl_table *table)
680 if (!lnet_debugfs_root)
681 lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
683 /* Even if we cannot create, just ignore it altogether) */
684 if (IS_ERR_OR_NULL(lnet_debugfs_root))
687 /* We don't save the dentry returned in next two calls, because
688 * we don't call debugfs_remove() but rather remove_recursive()
690 for (; table && table->procname; table++)
691 debugfs_create_file(table->procname, table->mode,
692 lnet_debugfs_root, table,
693 lnet_debugfs_fops_select(table->mode));
695 EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
697 static void lnet_insert_debugfs_links(
698 const struct lnet_debugfs_symlink_def *symlinks)
700 for (; symlinks && symlinks->name; symlinks++)
701 debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
705 void lnet_remove_debugfs(struct ctl_table *table)
707 for (; table && table->procname; table++) {
708 struct qstr dname = QSTR_INIT(table->procname,
709 strlen(table->procname));
710 struct dentry *dentry;
712 dentry = d_hash_and_lookup(lnet_debugfs_root, &dname);
713 debugfs_remove(dentry);
716 EXPORT_SYMBOL_GPL(lnet_remove_debugfs);
718 static int __init libcfs_init(void)
724 rc = libcfs_debug_init(5 * 1024 * 1024);
726 pr_err("LustreError: libcfs_debug_init: rc = %d\n", rc);
734 rc = misc_register(&libcfs_dev);
736 CERROR("misc_register: error %d\n", rc);
740 rc = cfs_wi_startup();
742 CERROR("initialize workitem: error %d\n", rc);
743 goto cleanup_deregister;
746 cfs_rehash_wq = alloc_workqueue("cfs_rh", WQ_SYSFS, 4);
747 if (!cfs_rehash_wq) {
749 CERROR("libcfs: failed to start rehash workqueue: rc = %d\n",
751 goto cleanup_deregister;
754 rc = cfs_crypto_register();
756 CERROR("cfs_crypto_regster: error %d\n", rc);
760 lnet_insert_debugfs(lnet_table);
761 if (!IS_ERR_OR_NULL(lnet_debugfs_root))
762 lnet_insert_debugfs_links(lnet_debugfs_symlinks);
764 CDEBUG (D_OTHER, "portals setup OK\n");
769 misc_deregister(&libcfs_dev);
773 libcfs_debug_cleanup();
777 static void __exit libcfs_exit(void)
781 /* Remove everthing */
782 debugfs_remove_recursive(lnet_debugfs_root);
783 lnet_debugfs_root = NULL;
785 CDEBUG(D_MALLOC, "before Portals cleanup: kmem %d\n",
786 atomic_read(&libcfs_kmemory));
789 destroy_workqueue(cfs_rehash_wq);
790 cfs_rehash_wq = NULL;
793 cfs_crypto_unregister();
796 misc_deregister(&libcfs_dev);
800 /* the below message is checked in test-framework.sh check_mem_leak() */
801 if (atomic_read(&libcfs_kmemory) != 0)
802 CERROR("Portals memory leaked: %d bytes\n",
803 atomic_read(&libcfs_kmemory));
805 rc = libcfs_debug_cleanup();
807 pr_err("LustreError: libcfs_debug_cleanup: rc = %d\n", rc);
810 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
811 MODULE_DESCRIPTION("Lustre helper library");
812 MODULE_VERSION(LIBCFS_VERSION);
813 MODULE_LICENSE("GPL");
815 module_init(libcfs_init);
816 module_exit(libcfs_exit);