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 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);
123 libcfs_psdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
125 if (!capable(CAP_SYS_ADMIN))
128 if (_IOC_TYPE(cmd) != IOC_LIBCFS_TYPE ||
129 _IOC_NR(cmd) < IOC_LIBCFS_MIN_NR ||
130 _IOC_NR(cmd) > IOC_LIBCFS_MAX_NR) {
131 CDEBUG(D_IOCTL, "invalid ioctl ( type %d, nr %d, size %d )\n",
132 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd));
136 return libcfs_ioctl(cmd, (void __user *)arg);
139 static const struct file_operations libcfs_fops = {
140 .owner = THIS_MODULE,
141 .unlocked_ioctl = libcfs_psdev_ioctl,
144 static struct miscdevice libcfs_dev = {
145 .minor = MISC_DYNAMIC_MINOR,
147 .fops = &libcfs_fops,
150 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
151 void __user *buffer, size_t *lenp,
152 int (*handler)(void *data, int write, loff_t pos,
153 void __user *buffer, int len))
155 int rc = handler(data, write, *ppos, buffer, *lenp);
168 EXPORT_SYMBOL(lprocfs_call_handler);
170 static int __proc_dobitmasks(void *data, int write,
171 loff_t pos, void __user *buffer, int nob)
173 const int tmpstrlen = 512;
176 unsigned int *mask = data;
177 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
178 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
180 rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
185 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
191 rc = cfs_trace_copyout_string(buffer, nob,
195 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
201 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
202 /* Always print LBUG/LASSERT to console, so keep this mask */
211 static int proc_dobitmasks(struct ctl_table *table, int write,
212 void __user *buffer, size_t *lenp, loff_t *ppos)
214 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
218 static int min_watchdog_ratelimit; /* disable ratelimiting */
219 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
221 static int __proc_dump_kernel(void *data, int write,
222 loff_t pos, void __user *buffer, int nob)
227 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
230 static int proc_dump_kernel(struct ctl_table *table, int write,
231 void __user *buffer, size_t *lenp, loff_t *ppos)
233 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
237 static int __proc_daemon_file(void *data, int write,
238 loff_t pos, void __user *buffer, int nob)
241 int len = strlen(cfs_tracefile);
246 return cfs_trace_copyout_string(buffer, nob,
247 cfs_tracefile + pos, "\n");
250 return cfs_trace_daemon_command_usrstr(buffer, nob);
253 static int proc_daemon_file(struct ctl_table *table, int write,
254 void __user *buffer, size_t *lenp, loff_t *ppos)
256 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
260 static int libcfs_force_lbug(struct ctl_table *table, int write,
262 size_t *lenp, loff_t *ppos)
269 static int proc_fail_loc(struct ctl_table *table, int write,
270 void __user *buffer, size_t *lenp, loff_t *ppos)
273 long old_fail_loc = cfs_fail_loc;
275 rc = proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
276 if (old_fail_loc != cfs_fail_loc)
277 wake_up(&cfs_race_waitq);
281 static int __proc_cpt_table(void *data, int write,
282 loff_t pos, void __user *buffer, int nob)
291 LASSERT(cfs_cpt_table != NULL);
294 LIBCFS_ALLOC(buf, len);
298 rc = cfs_cpt_table_print(cfs_cpt_table, buf, len);
303 LIBCFS_FREE(buf, len);
315 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
318 LIBCFS_FREE(buf, len);
322 static int proc_cpt_table(struct ctl_table *table, int write,
323 void __user *buffer, size_t *lenp, loff_t *ppos)
325 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
329 static int __proc_cpt_distance(void *data, int write,
330 loff_t pos, void __user *buffer, int nob)
339 LASSERT(cfs_cpt_table != NULL);
342 LIBCFS_ALLOC(buf, len);
346 rc = cfs_cpt_distance_print(cfs_cpt_table, buf, len);
351 LIBCFS_FREE(buf, len);
363 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
366 LIBCFS_FREE(buf, len);
370 static int proc_cpt_distance(struct ctl_table *table, int write,
371 void __user *buffer, size_t *lenp, loff_t *ppos)
373 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
374 __proc_cpt_distance);
377 static struct ctl_table lnet_table[] = {
381 .data = &libcfs_debug,
382 .maxlen = sizeof(int),
384 .proc_handler = &proc_dobitmasks,
388 .procname = "subsystem_debug",
389 .data = &libcfs_subsystem_debug,
390 .maxlen = sizeof(int),
392 .proc_handler = &proc_dobitmasks,
396 .procname = "printk",
397 .data = &libcfs_printk,
398 .maxlen = sizeof(int),
400 .proc_handler = &proc_dobitmasks,
404 .procname = "cpu_partition_table",
407 .proc_handler = &proc_cpt_table,
411 .procname = "cpu_partition_distance",
414 .proc_handler = &proc_cpt_distance,
418 .procname = "debug_log_upcall",
419 .data = lnet_debug_log_upcall,
420 .maxlen = sizeof(lnet_debug_log_upcall),
422 .proc_handler = &proc_dostring,
426 .procname = "lnet_memused",
427 .data = (int *)&libcfs_kmemory.counter,
428 .maxlen = sizeof(int),
430 .proc_handler = &proc_dointvec,
434 .procname = "catastrophe",
435 .data = &libcfs_catastrophe,
436 .maxlen = sizeof(int),
438 .proc_handler = &proc_dointvec,
442 .procname = "dump_kernel",
445 .proc_handler = &proc_dump_kernel,
449 .procname = "daemon_file",
452 .proc_handler = &proc_daemon_file,
456 .procname = "watchdog_ratelimit",
457 .data = &libcfs_watchdog_ratelimit,
458 .maxlen = sizeof(int),
460 .proc_handler = &proc_dointvec_minmax,
461 .extra1 = &min_watchdog_ratelimit,
462 .extra2 = &max_watchdog_ratelimit,
466 .procname = "force_lbug",
470 .proc_handler = &libcfs_force_lbug
474 .procname = "fail_loc",
475 .data = &cfs_fail_loc,
476 .maxlen = sizeof(cfs_fail_loc),
478 .proc_handler = &proc_fail_loc
482 .procname = "fail_val",
483 .data = &cfs_fail_val,
484 .maxlen = sizeof(int),
486 .proc_handler = &proc_dointvec
490 .procname = "fail_err",
491 .data = &cfs_fail_err,
492 .maxlen = sizeof(cfs_fail_err),
494 .proc_handler = &proc_dointvec,
500 static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
501 { .name = "console_ratelimit",
502 .target = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
503 { .name = "debug_path",
504 .target = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
505 { .name = "panic_on_lbug",
506 .target = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
507 { .name = "console_backoff",
508 .target = "../../../module/libcfs/parameters/libcfs_console_backoff" },
509 { .name = "debug_mb",
510 .target = "../../../module/libcfs/parameters/libcfs_debug_mb" },
511 { .name = "console_min_delay_centisecs",
512 .target = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
513 { .name = "console_max_delay_centisecs",
514 .target = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
518 static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
519 size_t count, loff_t *ppos)
521 struct ctl_table *table = filp->private_data;
522 ssize_t rc = -EINVAL;
525 rc = table->proc_handler(table, 0, buf, &count, ppos);
533 static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
534 size_t count, loff_t *ppos)
536 struct ctl_table *table = filp->private_data;
537 ssize_t rc = -EINVAL;
540 rc = table->proc_handler(table, 1, (void __user *)buf, &count,
549 static const struct file_operations lnet_debugfs_file_operations_rw = {
551 .read = lnet_debugfs_read,
552 .write = lnet_debugfs_write,
553 .llseek = default_llseek,
556 static const struct file_operations lnet_debugfs_file_operations_ro = {
558 .read = lnet_debugfs_read,
559 .llseek = default_llseek,
562 static const struct file_operations lnet_debugfs_file_operations_wo = {
564 .write = lnet_debugfs_write,
565 .llseek = default_llseek,
568 static const struct file_operations *lnet_debugfs_fops_select(umode_t mode)
570 if (!(mode & S_IWUGO))
571 return &lnet_debugfs_file_operations_ro;
573 if (!(mode & S_IRUGO))
574 return &lnet_debugfs_file_operations_wo;
576 return &lnet_debugfs_file_operations_rw;
579 void lnet_insert_debugfs(struct ctl_table *table)
581 if (!lnet_debugfs_root)
582 lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
584 /* Even if we cannot create, just ignore it altogether) */
585 if (IS_ERR_OR_NULL(lnet_debugfs_root))
588 /* We don't save the dentry returned in next two calls, because
589 * we don't call debugfs_remove() but rather remove_recursive()
591 for (; table && table->procname; table++)
592 debugfs_create_file(table->procname, table->mode,
593 lnet_debugfs_root, table,
594 lnet_debugfs_fops_select(table->mode));
596 EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
598 static void lnet_insert_debugfs_links(
599 const struct lnet_debugfs_symlink_def *symlinks)
601 for (; symlinks && symlinks->name; symlinks++)
602 debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
606 void lnet_remove_debugfs(struct ctl_table *table)
608 for (; table && table->procname; table++) {
609 struct qstr dname = QSTR_INIT(table->procname,
610 strlen(table->procname));
611 struct dentry *dentry;
613 dentry = d_hash_and_lookup(lnet_debugfs_root, &dname);
614 debugfs_remove(dentry);
617 EXPORT_SYMBOL_GPL(lnet_remove_debugfs);
619 static int __init libcfs_init(void)
623 #ifndef HAVE_WAIT_VAR_EVENT
626 rc = libcfs_debug_init(5 * 1024 * 1024);
628 printk(KERN_ERR "LustreError: libcfs_debug_init: %d\n", rc);
636 rc = misc_register(&libcfs_dev);
638 CERROR("misc_register: error %d\n", rc);
642 rc = cfs_wi_startup();
644 CERROR("initialize workitem: error %d\n", rc);
645 goto cleanup_deregister;
648 cfs_rehash_wq = alloc_workqueue("cfs_rh", WQ_SYSFS, 4);
649 if (!cfs_rehash_wq) {
651 CERROR("libcfs: failed to start rehash workqueue: rc = %d\n",
653 goto cleanup_deregister;
656 rc = cfs_crypto_register();
658 CERROR("cfs_crypto_regster: error %d\n", rc);
662 lnet_insert_debugfs(lnet_table);
663 if (!IS_ERR_OR_NULL(lnet_debugfs_root))
664 lnet_insert_debugfs_links(lnet_debugfs_symlinks);
666 CDEBUG (D_OTHER, "portals setup OK\n");
671 misc_deregister(&libcfs_dev);
675 libcfs_debug_cleanup();
679 static void __exit libcfs_exit(void)
683 /* Remove everthing */
684 debugfs_remove_recursive(lnet_debugfs_root);
685 lnet_debugfs_root = NULL;
687 CDEBUG(D_MALLOC, "before Portals cleanup: kmem %d\n",
688 atomic_read(&libcfs_kmemory));
691 destroy_workqueue(cfs_rehash_wq);
692 cfs_rehash_wq = NULL;
695 cfs_crypto_unregister();
698 misc_deregister(&libcfs_dev);
702 /* the below message is checked in test-framework.sh check_mem_leak() */
703 if (atomic_read(&libcfs_kmemory) != 0)
704 CERROR("Portals memory leaked: %d bytes\n",
705 atomic_read(&libcfs_kmemory));
707 rc = libcfs_debug_cleanup();
709 printk(KERN_ERR "LustreError: libcfs_debug_cleanup: %d\n",
713 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
714 MODULE_DESCRIPTION("Lustre helper library");
715 MODULE_VERSION(LIBCFS_VERSION);
716 MODULE_LICENSE("GPL");
718 module_init(libcfs_init);
719 module_exit(libcfs_exit);