Viewing: module.c
// SPDX-License-Identifier: GPL-2.0
/*
* Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
* Use is subject to license terms.
*
* Copyright (c) 2012, 2017, Intel Corporation.
*/
/*
* This file is part of Lustre, http://www.lustre.org/
*/
#include <linux/init.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/mm.h>
#include <linux/string.h>
#include <linux/stat.h>
#include <linux/errno.h>
#include <linux/unistd.h>
#include <net/sock.h>
#include <linux/uio.h>
#include <linux/uaccess.h>
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/list.h>
#include <linux/namei.h>
#include <linux/sysctl.h>
#include <linux/debugfs.h>
#include <asm/div64.h>
#define DEBUG_SUBSYSTEM S_LNET
#include <linux/libcfs/libcfs.h>
#include <lustre_compat/linux/linux-misc.h>
#include <linux/lnet/lib-lnet.h>
#include "tracefile.h"
struct lnet_debugfs_symlink_def {
const char *name;
const char *target;
};
static struct dentry *lnet_debugfs_root;
static int proc_dobitmasks(const struct ctl_table *table,
int write, void __user *buffer, size_t *lenp,
loff_t *ppos)
{
unsigned int *mask = table->data;
int is_subsys = (mask == &libcfs_subsystem_debug ||
mask == &libcfs_subsystem_printk) ? 1 : 0;
int is_printk = (mask == &libcfs_printk) ? 1 : 0;
const int tmpstrlen = 512;
char *tmpstr = NULL;
size_t nob = *lenp;
loff_t pos = *ppos;
int rc;
if (!write) {
tmpstr = kmalloc(tmpstrlen, GFP_KERNEL | __GFP_ZERO);
if (!tmpstr)
return -ENOMEM;
libcfs_debug_mask2str(tmpstr, tmpstrlen, *mask, is_subsys);
rc = strlen(tmpstr);
if (pos >= rc) {
rc = 0;
} else {
rc = cfs_trace_copyout_string(buffer, nob,
tmpstr + pos, NULL);
}
} else {
if (nob > USHRT_MAX)
return -E2BIG;
tmpstr = memdup_user_nul(buffer, nob);
if (IS_ERR(tmpstr))
return PTR_ERR(tmpstr);
rc = libcfs_debug_str2mask(mask, strim(tmpstr), is_subsys);
/* Always print LBUG/LASSERT to console, so keep this mask */
if (is_printk)
*mask |= D_EMERG;
}
kfree(tmpstr);
return rc;
}
static int min_watchdog_ratelimit; /* disable ratelimiting */
static int max_watchdog_ratelimit = (24*60*60); /* limit to once per day */
static int proc_dump_kernel(const struct ctl_table *table,
int write, void __user *buffer, size_t *lenp,
loff_t *ppos)
{
size_t nob = *lenp;
if (!write)
return 0;
return cfs_trace_dump_debug_buffer_usrstr(buffer, nob);
}
static int proc_daemon_file(const struct ctl_table *table,
int write, void __user *buffer, size_t *lenp,
loff_t *ppos)
{
size_t nob = *lenp;
loff_t pos = *ppos;
if (!write) {
int len = strlen(cfs_tracefile);
if (pos >= len)
return 0;
return cfs_trace_copyout_string(buffer, nob,
cfs_tracefile + pos, "\n");
}
return cfs_trace_daemon_command_usrstr(buffer, nob);
}
static int libcfs_force_lbug(const struct ctl_table *table,
int write, void __user *buffer, size_t *lenp,
loff_t *ppos)
{
if (write)
LBUG();
return 0;
}
static int proc_fail_loc(const struct ctl_table *table,
int write, void __user *buffer, size_t *lenp,
loff_t *ppos)
{
int rc;
long old_fail_loc = cfs_fail_loc;
if (!*lenp || *ppos) {
*lenp = 0;
return 0;
}
if (write) {
char kbuf[sizeof(cfs_fail_loc) * 4] = { '\0' };
if (*lenp > sizeof(kbuf))
return -E2BIG;
if (copy_from_user(kbuf, buffer, *lenp))
return -EFAULT;
rc = kstrtoul(kbuf, 0, &cfs_fail_loc);
*ppos += *lenp;
} else {
char kbuf[64/3+3];
rc = scnprintf(kbuf, sizeof(kbuf), "%lu\n", cfs_fail_loc);
if (copy_to_user(buffer, kbuf, rc))
rc = -EFAULT;
else {
*lenp = rc;
*ppos += rc;
}
}
if (old_fail_loc != cfs_fail_loc) {
cfs_race_state = 1;
wake_up(&cfs_race_waitq);
}
return rc;
}
static int libcfs_debug_marker(const struct ctl_table *table,
int write, void __user *buffer,
size_t *lenp, loff_t *ppos)
{
size_t len = min(*lenp, 4000UL);
char *kbuf;
if (!*lenp || *ppos) {
*lenp = 0;
return 0;
}
if (!write)
return 0;
kbuf = strndup_user(buffer, len);
if (IS_ERR(kbuf))
return PTR_ERR(kbuf);
if (strcmp(kbuf, "clear") == 0)
libcfs_debug_clear_buffer();
else
libcfs_debug_mark_buffer(kbuf);
kfree(kbuf);
*ppos += len;
return *lenp > 4000 ? -EOVERFLOW : 0;
}
int debugfs_doint(const struct ctl_table *table, int write,
void __user *buffer, size_t *lenp, loff_t *ppos)
{
int rc;
if (!*lenp || *ppos) {
*lenp = 0;
return 0;
}
if (write) {
int val;
char kbuf[sizeof(val) * 4] = { '\0' };
if (*lenp > sizeof(kbuf))
return -E2BIG;
if (copy_from_user(kbuf, buffer, *lenp))
return -EFAULT;
rc = kstrtoint(kbuf, 0, &val);
if (!rc) {
if (table->extra1 && val < *(int *)table->extra1)
val = *(int *)table->extra1;
if (table->extra2 && val > *(int *)table->extra2)
val = *(int *)table->extra2;
*(int *)table->data = val;
}
*ppos += *lenp;
} else {
char kbuf[64/3+3];
rc = scnprintf(kbuf, sizeof(kbuf), "%u\n", *(int *)table->data);
if (copy_to_user(buffer, kbuf, rc))
rc = -EFAULT;
else {
*lenp = rc;
*ppos += rc;
}
}
return rc;
}
EXPORT_SYMBOL(debugfs_doint);
static int debugfs_dou64(const struct ctl_table *table, int write,
void __user *buffer, size_t *lenp, loff_t *ppos)
{
int rc;
if (!*lenp || *ppos) {
*lenp = 0;
return 0;
}
if (write) {
unsigned long long val;
char kbuf[sizeof(val) * 4] = { '\0' };
if (*lenp > sizeof(kbuf))
return -E2BIG;
if (copy_from_user(kbuf, buffer, *lenp))
return -EFAULT;
rc = kstrtoull(kbuf, 0, &val);
if (!rc)
*(u64 *)table->data = val;
*ppos += *lenp;
} else {
char kbuf[64/3+3];
rc = scnprintf(kbuf, sizeof(kbuf), "%llu\n",
(unsigned long long)*(u64 *)table->data);
if (copy_to_user(buffer, kbuf, rc))
rc = -EFAULT;
else {
*lenp = rc;
*ppos += rc;
}
}
return rc;
}
static int debugfs_dostring(const struct ctl_table *table,
int write, void __user *buffer, size_t *lenp,
loff_t *ppos)
{
int len = *lenp;
char *kbuf = table->data;
if (!len || *ppos) {
*lenp = 0;
return 0;
}
if (len > table->maxlen)
len = table->maxlen;
if (write) {
if (copy_from_user(kbuf, buffer, len))
return -EFAULT;
memset(kbuf+len, 0, table->maxlen - len);
*ppos = *lenp;
} else {
len = strnlen(kbuf, len);
if (copy_to_user(buffer, kbuf, len))
return -EFAULT;
if (len < *lenp) {
if (copy_to_user(buffer+len, "\n", 1))
return -EFAULT;
len += 1;
}
*ppos += len;
*lenp -= len;
}
return len;
}
static struct ctl_table lnet_table[] = {
{
.procname = "debug",
.data = &libcfs_debug,
.maxlen = sizeof(int),
.mode = 0644,
.proc_handler = cfs_proc_handler(&proc_dobitmasks),
},
{
.procname = "subsystem_debug",
.data = &libcfs_subsystem_debug,
.maxlen = sizeof(int),
.mode = 0644,
.proc_handler = cfs_proc_handler(&proc_dobitmasks),
},
{
.procname = "printk",
.data = &libcfs_printk,
.maxlen = sizeof(int),
.mode = 0644,
.proc_handler = cfs_proc_handler(&proc_dobitmasks),
},
{
.procname = "subsystem_printk",
.data = &libcfs_subsystem_printk,
.maxlen = sizeof(int),
.mode = 0644,
.proc_handler = cfs_proc_handler(&proc_dobitmasks),
},
{
.procname = "debug_log_upcall",
.data = lnet_debug_log_upcall,
.maxlen = sizeof(lnet_debug_log_upcall),
.mode = 0644,
.proc_handler = cfs_proc_handler(&debugfs_dostring),
},
{
.procname = "lnet_memused",
.data = (u64 *)&libcfs_kmem.counter,
.maxlen = sizeof(u64),
.mode = 0444,
.proc_handler = cfs_proc_handler(&debugfs_dou64),
},
{
.procname = "catastrophe",
.data = &libcfs_catastrophe,
.maxlen = sizeof(int),
.mode = 0444,
.proc_handler = cfs_proc_handler(&debugfs_doint),
},
{
.procname = "dump_kernel",
.maxlen = 256,
.mode = 0200,
.proc_handler = cfs_proc_handler(&proc_dump_kernel),
},
{
.procname = "daemon_file",
.mode = 0644,
.maxlen = 256,
.proc_handler = cfs_proc_handler(&proc_daemon_file),
},
{
.procname = "watchdog_ratelimit",
.data = &libcfs_watchdog_ratelimit,
.maxlen = sizeof(int),
.mode = 0644,
.proc_handler = cfs_proc_handler(&debugfs_doint),
.extra1 = &min_watchdog_ratelimit,
.extra2 = &max_watchdog_ratelimit,
},
{
.procname = "debug_marker",
.mode = 0200,
.proc_handler = cfs_proc_handler(&libcfs_debug_marker)
},
{
.procname = "force_lbug",
.data = NULL,
.maxlen = 0,
.mode = 0200,
.proc_handler = cfs_proc_handler(&libcfs_force_lbug)
},
{
.procname = "fail_loc",
.data = &cfs_fail_loc,
.maxlen = sizeof(cfs_fail_loc),
.mode = 0644,
.proc_handler = cfs_proc_handler(&proc_fail_loc)
},
{
.procname = "fail_val",
.data = &cfs_fail_val,
.maxlen = sizeof(int),
.mode = 0644,
.proc_handler = cfs_proc_handler(&debugfs_doint)
},
{
.procname = "fail_err",
.data = &cfs_fail_err,
.maxlen = sizeof(cfs_fail_err),
.mode = 0644,
.proc_handler = cfs_proc_handler(&debugfs_doint),
},
{
}
};
static const struct lnet_debugfs_symlink_def lnet_debugfs_symlinks[] = {
{ .name = "console_ratelimit",
.target = "../../../module/libcfs/parameters/libcfs_console_ratelimit" },
{ .name = "debug_path",
.target = "../../../module/libcfs/parameters/libcfs_debug_file_path" },
{ .name = "panic_on_lbug",
.target = "../../../module/libcfs/parameters/libcfs_panic_on_lbug" },
{ .name = "console_backoff",
.target = "../../../module/libcfs/parameters/libcfs_console_backoff" },
{ .name = "debug_mb",
.target = "../../../module/libcfs/parameters/libcfs_debug_mb" },
{ .name = "console_min_delay_centisecs",
.target = "../../../module/libcfs/parameters/libcfs_console_min_delay" },
{ .name = "console_max_delay_centisecs",
.target = "../../../module/libcfs/parameters/libcfs_console_max_delay" },
{ .name = NULL },
};
static ssize_t lnet_debugfs_read(struct file *filp, char __user *buf,
size_t count, loff_t *ppos)
{
DEFINE_CTL_TABLE_INIT(table, filp->private_data);
loff_t old_pos = *ppos;
ssize_t rc = -EINVAL;
if (table)
rc = table->proc_handler(table, 0, (void __user *)buf,
&count, ppos);
/*
* On success, the length read is either in error or in count.
* If ppos changed, then use count, else use error
*/
if (!rc && *ppos != old_pos)
rc = count;
else if (rc > 0)
*ppos += rc;
return rc;
}
static ssize_t lnet_debugfs_write(struct file *filp, const char __user *buf,
size_t count, loff_t *ppos)
{
DEFINE_CTL_TABLE_INIT(table, filp->private_data);
loff_t old_pos = *ppos;
ssize_t rc = -EINVAL;
if (table)
rc = table->proc_handler(table, 1, (void __user *)buf, &count,
ppos);
if (rc)
return rc;
if (*ppos == old_pos)
*ppos += count;
return count;
}
static const struct file_operations lnet_debugfs_file_operations_rw = {
.open = simple_open,
.read = lnet_debugfs_read,
.write = lnet_debugfs_write,
.llseek = default_llseek,
};
static const struct file_operations lnet_debugfs_file_operations_ro = {
.open = simple_open,
.read = lnet_debugfs_read,
.llseek = default_llseek,
};
static const struct file_operations lnet_debugfs_file_operations_wo = {
.open = simple_open,
.write = lnet_debugfs_write,
.llseek = default_llseek,
};
static const struct file_operations *lnet_debugfs_fops_select(
umode_t mode, const struct file_operations state[3])
{
if (!(mode & S_IWUGO))
return &state[0];
if (!(mode & S_IRUGO))
return &state[1];
return &state[2];
}
void lnet_insert_debugfs(const struct ctl_table *table,
struct module *mod, void **statep)
{
struct file_operations *state = *statep;
if (!lnet_debugfs_root)
lnet_debugfs_root = debugfs_create_dir("lnet", NULL);
/* Even if we cannot create, just ignore it altogether) */
if (IS_ERR_OR_NULL(lnet_debugfs_root))
return;
if (!state) {
state = kmalloc(3 * sizeof(*state), GFP_KERNEL);
if (!state)
return;
state[0] = lnet_debugfs_file_operations_ro;
state[0].owner = mod;
state[1] = lnet_debugfs_file_operations_wo;
state[1].owner = mod;
state[2] = lnet_debugfs_file_operations_rw;
state[2].owner = mod;
*statep = state;
}
/* We don't save the dentry returned in next two calls, because
* we don't call debugfs_remove() but rather remove_recursive()
*/
for (; table && table->procname; table++)
debugfs_create_file(table->procname, table->mode,
lnet_debugfs_root, (void *)table,
lnet_debugfs_fops_select(table->mode,
(const struct file_operations *)state));
}
EXPORT_SYMBOL_GPL(lnet_insert_debugfs);
void lnet_debugfs_fini(void **state)
{
kfree(*state);
*state = NULL;
}
EXPORT_SYMBOL_GPL(lnet_debugfs_fini);
static void lnet_insert_debugfs_links(
const struct lnet_debugfs_symlink_def *symlinks)
{
for (; symlinks && symlinks->name; symlinks++)
debugfs_create_symlink(symlinks->name, lnet_debugfs_root,
symlinks->target);
}
void lnet_remove_debugfs(const struct ctl_table *table)
{
for (; table && table->procname; table++) {
struct qstr dname = QSTR_INIT(table->procname,
strlen(table->procname));
struct dentry *dentry;
dentry = try_lookup_noperm(&dname, lnet_debugfs_root);
debugfs_remove(dentry);
}
}
EXPORT_SYMBOL_GPL(lnet_remove_debugfs);
static DEFINE_MUTEX(libcfs_startup);
static int libcfs_active;
static void *debugfs_state;
int libcfs_setup(void)
{
int rc = 0;
mutex_lock(&libcfs_startup);
if (libcfs_active)
goto cleanup_lock;
rc = libcfs_debug_init(5 * 1024 * 1024);
if (rc < 0) {
pr_err("LustreError: libcfs_debug_init: rc = %d\n", rc);
goto cleanup_lock;
}
CDEBUG(D_OTHER, "libcfs setup OK\n");
libcfs_active = 1;
cleanup_lock:
mutex_unlock(&libcfs_startup);
return rc;
}
EXPORT_SYMBOL(libcfs_setup);
int debug_module_init(void)
{
int rc;
mutex_lock(&libcfs_startup);
rc = libcfs_debug_init(5 * 1024 * 1024);
mutex_unlock(&libcfs_startup);
if (rc < 0) {
pr_err("LustreError: libcfs_debug_init: rc = %d\n", rc);
return rc;
}
lnet_insert_debugfs(lnet_table, THIS_MODULE, &debugfs_state);
if (!IS_ERR_OR_NULL(lnet_debugfs_root))
lnet_insert_debugfs_links(lnet_debugfs_symlinks);
return 0;
}
void debug_module_exit(void)
{
int rc;
/* Remove everthing */
debugfs_remove_recursive(lnet_debugfs_root);
lnet_debugfs_root = NULL;
lnet_debugfs_fini(&debugfs_state);
CDEBUG(D_MALLOC, "before Portals cleanup: kmem %lld\n",
libcfs_kmem_read());
/* the below message is checked in test-framework.sh check_mem_leak() */
if (libcfs_kmem_read() != 0)
CERROR("Portals memory leaked: %lld bytes\n",
libcfs_kmem_read());
rc = libcfs_debug_cleanup();
if (rc)
pr_err("LustreError: libcfs_debug_cleanup: rc = %d\n", rc);
debug_format_buffer_free_buffers();
}
static int __init libcfs_init(void)
{
return debug_module_init();
}
static void __exit libcfs_exit(void)
{
debug_module_exit();
}
MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
MODULE_DESCRIPTION("Lustre helper library");
MODULE_VERSION(LIBCFS_VERSION);
MODULE_LICENSE("GPL");
compat_module_init(libcfs_init);
compat_module_exit(libcfs_exit);
