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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/obdclass/linux/linux-module.c
34 * Object Devices Class Driver
35 * These are the only exported functions, they provide some generic
36 * infrastructure for managing object devices
39 #define DEBUG_SUBSYSTEM S_CLASS
41 #include <linux/module.h>
42 #include <linux/errno.h>
43 #include <linux/kernel.h>
44 #include <linux/major.h>
45 #include <linux/sched.h>
47 #include <linux/slab.h>
48 #include <linux/ioport.h>
49 #include <linux/fcntl.h>
50 #include <linux/delay.h>
51 #include <linux/skbuff.h>
52 #include <linux/proc_fs.h>
54 #include <linux/poll.h>
55 #include <linux/init.h>
56 #include <linux/list.h>
57 #include <linux/highmem.h>
59 #include <asm/ioctls.h>
61 #include <asm/uaccess.h>
62 #include <linux/miscdevice.h>
63 #include <linux/seq_file.h>
64 #include <linux/kobject.h>
66 #include <libcfs/libcfs.h>
67 #include <obd_support.h>
68 #include <obd_class.h>
69 #include <lnet/lnetctl.h>
70 #include <lprocfs_status.h>
71 #include <lustre_ioctl.h>
72 #include <lustre_ver.h>
74 /* buffer MUST be at least the size of obd_ioctl_hdr */
75 int obd_ioctl_getdata(char **buf, int *len, void __user *arg)
77 struct obd_ioctl_hdr hdr;
78 struct obd_ioctl_data *data;
82 if (copy_from_user(&hdr, arg, sizeof(hdr)))
85 if (hdr.ioc_version != OBD_IOCTL_VERSION) {
86 CERROR("Version mismatch kernel (%x) vs application (%x)\n",
87 OBD_IOCTL_VERSION, hdr.ioc_version);
91 if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
92 CERROR("User buffer len %d exceeds %d max buffer\n",
93 hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
97 if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
98 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
102 /* When there are lots of processes calling vmalloc on multi-core
103 * system, the high lock contention will hurt performance badly,
104 * obdfilter-survey is an example, which relies on ioctl. So we'd
105 * better avoid vmalloc on ioctl path. LU-66 */
106 OBD_ALLOC_LARGE(*buf, hdr.ioc_len);
108 CERROR("Cannot allocate control buffer of len %d\n",
113 data = (struct obd_ioctl_data *)*buf;
115 if (copy_from_user(*buf, arg, hdr.ioc_len)) {
116 OBD_FREE_LARGE(*buf, hdr.ioc_len);
120 if (obd_ioctl_is_invalid(data)) {
121 CERROR("ioctl not correctly formatted\n");
122 OBD_FREE_LARGE(*buf, hdr.ioc_len);
126 if (data->ioc_inllen1) {
127 data->ioc_inlbuf1 = &data->ioc_bulk[0];
128 offset += cfs_size_round(data->ioc_inllen1);
131 if (data->ioc_inllen2) {
132 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
133 offset += cfs_size_round(data->ioc_inllen2);
136 if (data->ioc_inllen3) {
137 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
138 offset += cfs_size_round(data->ioc_inllen3);
141 if (data->ioc_inllen4)
142 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
146 EXPORT_SYMBOL(obd_ioctl_getdata);
148 int obd_ioctl_popdata(void __user *arg, void *data, int len)
153 err = copy_to_user(arg, data, len) ? -EFAULT : 0;
157 /* opening /dev/obd */
158 static int obd_class_open(struct inode * inode, struct file * file)
162 try_module_get(THIS_MODULE);
166 /* closing /dev/obd */
167 static int obd_class_release(struct inode * inode, struct file * file)
171 module_put(THIS_MODULE);
175 /* to control /dev/obd */
176 static long obd_class_ioctl(struct file *filp, unsigned int cmd,
182 /* Allow non-root access for OBD_IOC_PING_TARGET - used by lfs check */
183 if (!cfs_capable(CFS_CAP_SYS_ADMIN) && (cmd != OBD_IOC_PING_TARGET))
184 RETURN(err = -EACCES);
185 if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
186 RETURN(err = -ENOTTY);
188 err = class_handle_ioctl(cmd, (unsigned long)arg);
193 /* declare character device */
194 static struct file_operations obd_psdev_fops = {
195 .owner = THIS_MODULE,
196 .unlocked_ioctl = obd_class_ioctl, /* unlocked_ioctl */
197 .open = obd_class_open, /* open */
198 .release = obd_class_release, /* release */
202 struct miscdevice obd_psdev = {
203 .minor = OBD_DEV_MINOR,
204 .name = OBD_DEV_NAME,
205 .fops = &obd_psdev_fops,
208 static ssize_t version_show(struct kobject *kobj, struct attribute *attr,
211 return sprintf(buf, "%s\n", LUSTRE_VERSION_STRING);
214 static ssize_t pinger_show(struct kobject *kobj, struct attribute *attr,
218 const char *state = "on";
220 const char *state = "off";
222 return sprintf(buf, "%s\n", state);
226 * Check all obd devices health
231 * \retval number of characters printed if healthy
234 health_check_show(struct kobject *kobj, struct attribute *attr, char *buf)
240 if (libcfs_catastrophe) {
241 len = sprintf(buf, "LBUG\n");
245 read_lock(&obd_dev_lock);
246 for (i = 0; i < class_devno_max(); i++) {
247 struct obd_device *obd;
249 obd = class_num2obd(i);
250 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
253 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
254 if (obd->obd_stopping)
257 class_incref(obd, __FUNCTION__, current);
258 read_unlock(&obd_dev_lock);
260 if (obd_health_check(NULL, obd)) {
261 len = sprintf(buf, "device %s reported unhealthy\n",
265 class_decref(obd, __FUNCTION__, current);
266 read_lock(&obd_dev_lock);
268 read_unlock(&obd_dev_lock);
271 len = sprintf(buf, "healthy\n");
273 len = sprintf(buf, "NOT HEALTHY\n");
278 static ssize_t jobid_var_show(struct kobject *kobj, struct attribute *attr,
283 if (strlen(obd_jobid_var))
284 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_var);
288 static ssize_t jobid_var_store(struct kobject *kobj, struct attribute *attr,
289 const char *buffer, size_t count)
291 if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
294 memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
296 memcpy(obd_jobid_var, buffer, count);
298 /* Trim the trailing '\n' if any */
299 if (obd_jobid_var[count - 1] == '\n')
300 obd_jobid_var[count - 1] = 0;
305 static ssize_t jobid_name_show(struct kobject *kobj, struct attribute *attr,
310 if (strlen(obd_jobid_node))
311 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_node);
315 static ssize_t jobid_name_store(struct kobject *kobj, struct attribute *attr,
316 const char *buffer, size_t count)
318 if (!count || count > LUSTRE_JOBID_SIZE)
321 /* clear previous value */
322 memset(obd_jobid_node, 0, LUSTRE_JOBID_SIZE);
324 memcpy(obd_jobid_node, buffer, count);
326 /* Trim the trailing '\n' if any */
327 if (obd_jobid_node[count - 1] == '\n') {
328 /* Don't echo just a newline */
331 obd_jobid_node[count - 1] = 0;
337 /* Root for /sys/kernel/debug/lustre */
338 struct dentry *debugfs_lustre_root;
339 EXPORT_SYMBOL_GPL(debugfs_lustre_root);
341 #ifdef CONFIG_PROC_FS
342 /* Root for /proc/fs/lustre */
343 struct proc_dir_entry *proc_lustre_root = NULL;
344 EXPORT_SYMBOL(proc_lustre_root);
346 #define lprocfs_base NULL
347 #endif /* CONFIG_PROC_FS */
349 LUSTRE_RO_ATTR(version);
350 LUSTRE_RO_ATTR(pinger);
351 LUSTRE_RO_ATTR(health_check);
352 LUSTRE_RW_ATTR(jobid_var);
353 LUSTRE_RW_ATTR(jobid_name);
355 static struct attribute *lustre_attrs[] = {
356 &lustre_attr_version.attr,
357 &lustre_attr_pinger.attr,
358 &lustre_attr_health_check.attr,
359 &lustre_attr_jobid_name.attr,
360 &lustre_attr_jobid_var.attr,
364 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
366 if (*pos >= class_devno_max())
372 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
376 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
379 if (*pos >= class_devno_max())
385 static int obd_device_list_seq_show(struct seq_file *p, void *v)
387 loff_t index = *(loff_t *)v;
388 struct obd_device *obd = class_num2obd((int)index);
394 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
395 if (obd->obd_stopping)
397 else if (obd->obd_inactive)
399 else if (obd->obd_set_up)
401 else if (obd->obd_attached)
406 seq_printf(p, "%3d %s %s %s %s %d\n",
407 (int)index, status, obd->obd_type->typ_name,
408 obd->obd_name, obd->obd_uuid.uuid,
409 atomic_read(&obd->obd_refcount));
413 static const struct seq_operations obd_device_list_sops = {
414 .start = obd_device_list_seq_start,
415 .stop = obd_device_list_seq_stop,
416 .next = obd_device_list_seq_next,
417 .show = obd_device_list_seq_show,
420 static int obd_device_list_open(struct inode *inode, struct file *file)
422 struct seq_file *seq;
423 int rc = seq_open(file, &obd_device_list_sops);
428 seq = file->private_data;
429 seq->private = inode->i_private;
433 static const struct file_operations obd_device_list_fops = {
434 .owner = THIS_MODULE,
435 .open = obd_device_list_open,
438 .release = seq_release,
441 struct kobject *lustre_kobj;
442 EXPORT_SYMBOL_GPL(lustre_kobj);
444 static struct attribute_group lustre_attr_group = {
445 .attrs = lustre_attrs,
448 int class_procfs_init(void)
450 struct proc_dir_entry *entry;
455 lustre_kobj = kobject_create_and_add("lustre", fs_kobj);
456 if (lustre_kobj == NULL)
459 /* Create the files associated with this kobject */
460 rc = sysfs_create_group(lustre_kobj, &lustre_attr_group);
462 kobject_put(lustre_kobj);
466 rc = obd_sysctl_init();
468 kobject_put(lustre_kobj);
472 debugfs_lustre_root = debugfs_create_dir("lustre", NULL);
473 if (IS_ERR_OR_NULL(debugfs_lustre_root)) {
474 rc = debugfs_lustre_root ? PTR_ERR(debugfs_lustre_root)
476 debugfs_lustre_root = NULL;
477 kobject_put(lustre_kobj);
481 file = debugfs_create_file("devices", 0444, debugfs_lustre_root, NULL,
482 &obd_device_list_fops);
483 if (IS_ERR_OR_NULL(file)) {
484 rc = file ? PTR_ERR(file) : -ENOMEM;
485 kobject_put(lustre_kobj);
489 entry = lprocfs_register("fs/lustre", NULL, NULL, NULL);
492 CERROR("cannot create '/proc/fs/lustre': rc = %d\n", rc);
493 kobject_put(lustre_kobj);
497 proc_lustre_root = entry;
502 int class_procfs_clean(void)
506 debugfs_remove_recursive(debugfs_lustre_root);
508 debugfs_lustre_root = NULL;
510 if (proc_lustre_root)
511 lprocfs_remove(&proc_lustre_root);
513 kobject_put(lustre_kobj);