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 <libcfs/linux/linux-misc.h>
57 #include <lnet/lib-lnet.h>
58 #include "tracefile.h"
60 static struct dentry *lnet_debugfs_root;
62 static DECLARE_RWSEM(ioctl_list_sem);
63 static LIST_HEAD(ioctl_list);
65 int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand)
69 down_write(&ioctl_list_sem);
70 if (!list_empty(&hand->item))
73 list_add_tail(&hand->item, &ioctl_list);
74 up_write(&ioctl_list_sem);
78 EXPORT_SYMBOL(libcfs_register_ioctl);
80 int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand)
84 down_write(&ioctl_list_sem);
85 if (list_empty(&hand->item))
88 list_del_init(&hand->item);
89 up_write(&ioctl_list_sem);
93 EXPORT_SYMBOL(libcfs_deregister_ioctl);
95 int libcfs_ioctl(unsigned long cmd, void __user *uparam)
97 struct libcfs_ioctl_data *data = NULL;
98 struct libcfs_ioctl_hdr *hdr;
102 /* 'cmd' and permissions get checked in our arch-specific caller */
103 err = libcfs_ioctl_getdata(&hdr, uparam);
105 CDEBUG_LIMIT(D_ERROR,
106 "libcfs ioctl: data header error %d\n", err);
110 if (hdr->ioc_version == LIBCFS_IOCTL_VERSION) {
111 /* The libcfs_ioctl_data_adjust() function performs adjustment
112 * operations on the libcfs_ioctl_data structure to make
113 * it usable by the code. This doesn't need to be called
114 * for new data structures added. */
115 data = container_of(hdr, struct libcfs_ioctl_data, ioc_hdr);
116 err = libcfs_ioctl_data_adjust(data);
121 CDEBUG(D_IOCTL, "libcfs ioctl cmd %lu\n", cmd);
123 case IOC_LIBCFS_CLEAR_DEBUG:
124 libcfs_debug_clear_buffer();
126 case IOC_LIBCFS_MARK_DEBUG:
128 data->ioc_inlbuf1 == NULL ||
129 data->ioc_inlbuf1[data->ioc_inllen1 - 1] != '\0')
130 GOTO(out, err = -EINVAL);
132 libcfs_debug_mark_buffer(data->ioc_inlbuf1);
136 struct libcfs_ioctl_handler *hand;
139 down_read(&ioctl_list_sem);
140 list_for_each_entry(hand, &ioctl_list, item) {
141 err = hand->handle_ioctl(cmd, hdr);
145 if (copy_to_user(uparam, hdr, hdr->ioc_len))
149 up_read(&ioctl_list_sem);
153 LIBCFS_FREE(hdr, hdr->ioc_len);
157 int lprocfs_call_handler(void *data, int write, loff_t *ppos,
158 void __user *buffer, size_t *lenp,
159 int (*handler)(void *data, int write, loff_t pos,
160 void __user *buffer, int len))
162 int rc = handler(data, write, *ppos, buffer, *lenp);
175 EXPORT_SYMBOL(lprocfs_call_handler);
177 static int __proc_dobitmasks(void *data, int write,
178 loff_t pos, void __user *buffer, int nob)
180 const int tmpstrlen = 512;
183 unsigned int *mask = data;
184 int is_subsys = (mask == &libcfs_subsystem_debug) ? 1 : 0;
185 int is_printk = (mask == &libcfs_printk) ? 1 : 0;
187 rc = cfs_trace_allocate_string_buffer(&tmpstr, tmpstrlen);
192 libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
198 rc = cfs_trace_copyout_string(buffer, nob,
202 rc = cfs_trace_copyin_string(tmpstr, tmpstrlen, buffer, nob);
208 rc = libcfs_debug_str2mask(mask, tmpstr, is_subsys);
209 /* Always print LBUG/LASSERT to console, so keep this mask */
218 static int proc_dobitmasks(struct ctl_table *table, int write,
219 void __user *buffer, size_t *lenp, loff_t *ppos)
221 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
225 static int min_watchdog_ratelimit; /* disable ratelimiting */
226 static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
228 static int __proc_dump_kernel(void *data, int write,
229 loff_t pos, void __user *buffer, int nob)
234 return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
237 static int proc_dump_kernel(struct ctl_table *table, int write,
238 void __user *buffer, size_t *lenp, loff_t *ppos)
240 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
244 static int __proc_daemon_file(void *data, int write,
245 loff_t pos, void __user *buffer, int nob)
248 int len = strlen(cfs_tracefile);
253 return cfs_trace_copyout_string(buffer, nob,
254 cfs_tracefile + pos, "\n");
257 return cfs_trace_daemon_command_usrstr(buffer, nob);
260 static int proc_daemon_file(struct ctl_table *table, int write,
261 void __user *buffer, size_t *lenp, loff_t *ppos)
263 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
267 static int libcfs_force_lbug(struct ctl_table *table, int write,
269 size_t *lenp, loff_t *ppos)
276 static int proc_fail_loc(struct ctl_table *table, int write,
277 void __user *buffer, size_t *lenp, loff_t *ppos)
280 long old_fail_loc = cfs_fail_loc;
282 rc = proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
283 if (old_fail_loc != cfs_fail_loc)
284 wake_up(&cfs_race_waitq);
288 static int __proc_cpt_table(void *data, int write,
289 loff_t pos, void __user *buffer, int nob)
298 LASSERT(cfs_cpt_table != NULL);
301 LIBCFS_ALLOC(buf, len);
305 rc = cfs_cpt_table_print(cfs_cpt_table, buf, len);
310 LIBCFS_FREE(buf, len);
322 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
325 LIBCFS_FREE(buf, len);
329 static int proc_cpt_table(struct ctl_table *table, int write,
330 void __user *buffer, size_t *lenp, loff_t *ppos)
332 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
336 static int __proc_cpt_distance(void *data, int write,
337 loff_t pos, void __user *buffer, int nob)
346 LASSERT(cfs_cpt_table != NULL);
349 LIBCFS_ALLOC(buf, len);
353 rc = cfs_cpt_distance_print(cfs_cpt_table, buf, len);
358 LIBCFS_FREE(buf, len);
370 rc = cfs_trace_copyout_string(buffer, nob, buf + pos, NULL);
373 LIBCFS_FREE(buf, len);
377 static int proc_cpt_distance(struct ctl_table *table, int write,
378 void __user *buffer, size_t *lenp, loff_t *ppos)
380 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
381 __proc_cpt_distance);
384 static struct ctl_table lnet_table[] = {
388 .data = &libcfs_debug,
389 .maxlen = sizeof(int),
391 .proc_handler = &proc_dobitmasks,
395 .procname = "subsystem_debug",
396 .data = &libcfs_subsystem_debug,
397 .maxlen = sizeof(int),
399 .proc_handler = &proc_dobitmasks,
403 .procname = "printk",
404 .data = &libcfs_printk,
405 .maxlen = sizeof(int),
407 .proc_handler = &proc_dobitmasks,
411 .procname = "cpu_partition_table",
414 .proc_handler = &proc_cpt_table,
418 .procname = "cpu_partition_distance",
421 .proc_handler = &proc_cpt_distance,
425 .procname = "debug_log_upcall",
426 .data = lnet_debug_log_upcall,
427 .maxlen = sizeof(lnet_debug_log_upcall),
429 .proc_handler = &proc_dostring,
433 .procname = "lnet_memused",
434 .data = (int *)&libcfs_kmemory.counter,
435 .maxlen = sizeof(int),
437 .proc_handler = &proc_dointvec,
441 .procname = "catastrophe",
442 .data = &libcfs_catastrophe,
443 .maxlen = sizeof(int),
445 .proc_handler = &proc_dointvec,
449 .procname = "dump_kernel",
452 .proc_handler = &proc_dump_kernel,
456 .procname = "daemon_file",
459 .proc_handler = &proc_daemon_file,
463 .procname = "watchdog_ratelimit",
464 .data = &libcfs_watchdog_ratelimit,
465 .maxlen = sizeof(int),
467 .proc_handler = &proc_dointvec_minmax,
468 .extra1 = &min_watchdog_ratelimit,
469 .extra2 = &max_watchdog_ratelimit,
473 .procname = "force_lbug",
477 .proc_handler = &libcfs_force_lbug
481 .procname = "fail_loc",
482 .data = &cfs_fail_loc,
483 .maxlen = sizeof(cfs_fail_loc),
485 .proc_handler = &proc_fail_loc
489 .procname = "fail_val",
490 .data = &cfs_fail_val,
491 .maxlen = sizeof(int),
493 .proc_handler = &proc_dointvec
497 .procname = "fail_err",
498 .data = &cfs_fail_err,
499 .maxlen = sizeof(cfs_fail_err),
501 .proc_handler = &proc_dointvec,
507 static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
508 { .name = "console_ratelimit",
509 .target = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
510 { .name = "debug_path",
511 .target = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
512 { .name = "panic_on_lbug",
513 .target = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
514 { .name = "console_backoff",
515 .target = "../../../module/libcfs/parameters/libcfs_console_backoff" },
516 { .name = "debug_mb",
517 .target = "../../../module/libcfs/parameters/libcfs_debug_mb" },
518 { .name = "console_min_delay_centisecs",
519 .target = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
520 { .name = "console_max_delay_centisecs",
521 .target = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
525 static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
526 size_t count, loff_t *ppos)
528 struct ctl_table *table = filp->private_data;
531 rc = table->proc_handler(table, 0, buf, &count, ppos);
538 static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
539 size_t count, loff_t *ppos)
541 struct ctl_table *table = filp->private_data;
544 rc = table->proc_handler(table, 1, (void __user *)buf, &count, ppos);
551 static const struct file_operations lnet_debugfs_file_operations_rw = {
553 .read = lnet_debugfs_read,
554 .write = lnet_debugfs_write,
555 .llseek = default_llseek,
558 static const struct file_operations lnet_debugfs_file_operations_ro = {
560 .read = lnet_debugfs_read,
561 .llseek = default_llseek,
564 static const struct file_operations lnet_debugfs_file_operations_wo = {
566 .write = lnet_debugfs_write,
567 .llseek = default_llseek,
570 static const struct file_operations *lnet_debugfs_fops_select(umode_t mode)
572 if (!(mode & S_IWUGO))
573 return &lnet_debugfs_file_operations_ro;
575 if (!(mode & S_IRUGO))
576 return &lnet_debugfs_file_operations_wo;
578 return &lnet_debugfs_file_operations_rw;
581 void lnet_insert_debugfs(struct ctl_table *table,
582 const struct lnet_debugfs_symlink_def *symlinks)
584 if (!lnet_debugfs_root)
585 lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
587 /* Even if we cannot create, just ignore it altogether) */
588 if (IS_ERR_OR_NULL(lnet_debugfs_root))
591 /* We don't save the dentry returned in next two calls, because
592 * we don't call debugfs_remove() but rather remove_recursive()
594 for (; table && table->procname; table++)
595 debugfs_create_file(table->procname, table->mode,
596 lnet_debugfs_root, table,
597 lnet_debugfs_fops_select(table->mode));
599 for (; symlinks && symlinks->name; symlinks++)
600 debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
603 EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
605 static void lnet_remove_debugfs(void)
607 debugfs_remove_recursive(lnet_debugfs_root);
609 lnet_debugfs_root = NULL;
612 static int __init libcfs_init(void)
616 rc = libcfs_debug_init(5 * 1024 * 1024);
618 printk(KERN_ERR "LustreError: libcfs_debug_init: %d\n", rc);
626 rc = misc_register(&libcfs_dev);
628 CERROR("misc_register: error %d\n", rc);
632 rc = cfs_wi_startup();
634 CERROR("initialize workitem: error %d\n", rc);
635 goto cleanup_deregister;
638 /* max to 4 threads, should be enough for rehash */
639 rc = min(cfs_cpt_weight(cfs_cpt_table, CFS_CPT_ANY), 4);
640 rc = cfs_wi_sched_create("cfs_rh", cfs_cpt_table, CFS_CPT_ANY,
641 rc, &cfs_sched_rehash);
643 CERROR("Startup workitem scheduler: error: %d\n", rc);
644 goto cleanup_deregister;
647 rc = cfs_crypto_register();
649 CERROR("cfs_crypto_regster: error %d\n", rc);
653 lnet_insert_debugfs(lnet_table, lnet_debugfs_symlinks);
655 CDEBUG (D_OTHER, "portals setup OK\n");
660 misc_deregister(&libcfs_dev);
664 libcfs_debug_cleanup();
668 static void __exit libcfs_exit(void)
672 lnet_remove_debugfs();
674 CDEBUG(D_MALLOC, "before Portals cleanup: kmem %d\n",
675 atomic_read(&libcfs_kmemory));
677 if (cfs_sched_rehash != NULL) {
678 cfs_wi_sched_destroy(cfs_sched_rehash);
679 cfs_sched_rehash = NULL;
682 cfs_crypto_unregister();
685 misc_deregister(&libcfs_dev);
689 if (atomic_read(&libcfs_kmemory) != 0)
690 CERROR("Portals memory leaked: %d bytes\n",
691 atomic_read(&libcfs_kmemory));
693 rc = libcfs_debug_cleanup();
695 printk(KERN_ERR "LustreError: libcfs_debug_cleanup: %d\n",
699 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
700 MODULE_DESCRIPTION("Lustre helper library");
701 MODULE_VERSION(LIBCFS_VERSION);
702 MODULE_LICENSE("GPL");
704 module_init(libcfs_init);
705 module_exit(libcfs_exit);