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 <uapi/linux/lustre_ioctl.h>
72 #include <lustre_ver.h>
74 static int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
76 if (data->ioc_len > BIT(30)) {
77 CERROR("OBD ioctl: ioc_len larger than 1<<30\n");
81 if (data->ioc_inllen1 > BIT(30)) {
82 CERROR("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
86 if (data->ioc_inllen2 > BIT(30)) {
87 CERROR("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
91 if (data->ioc_inllen3 > BIT(30)) {
92 CERROR("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
96 if (data->ioc_inllen4 > BIT(30)) {
97 CERROR("OBD ioctl: ioc_inllen4 larger than 1<<30\n");
101 if (data->ioc_inlbuf1 && data->ioc_inllen1 == 0) {
102 CERROR("OBD ioctl: inlbuf1 pointer but 0 length\n");
106 if (data->ioc_inlbuf2 && data->ioc_inllen2 == 0) {
107 CERROR("OBD ioctl: inlbuf2 pointer but 0 length\n");
111 if (data->ioc_inlbuf3 && data->ioc_inllen3 == 0) {
112 CERROR("OBD ioctl: inlbuf3 pointer but 0 length\n");
116 if (data->ioc_inlbuf4 && data->ioc_inllen4 == 0) {
117 CERROR("OBD ioctl: inlbuf4 pointer but 0 length\n");
121 if (data->ioc_pbuf1 && data->ioc_plen1 == 0) {
122 CERROR("OBD ioctl: pbuf1 pointer but 0 length\n");
126 if (data->ioc_pbuf2 && data->ioc_plen2 == 0) {
127 CERROR("OBD ioctl: pbuf2 pointer but 0 length\n");
131 if (!data->ioc_pbuf1 && data->ioc_plen1 != 0) {
132 CERROR("OBD ioctl: plen1 set but NULL pointer\n");
136 if (!data->ioc_pbuf2 && data->ioc_plen2 != 0) {
137 CERROR("OBD ioctl: plen2 set but NULL pointer\n");
141 if (obd_ioctl_packlen(data) > data->ioc_len) {
142 CERROR("OBD ioctl: packlen exceeds ioc_len (%d > %d)\n",
143 obd_ioctl_packlen(data), data->ioc_len);
150 /* buffer MUST be at least the size of obd_ioctl_hdr */
151 int obd_ioctl_getdata(char **buf, int *len, void __user *arg)
153 struct obd_ioctl_hdr hdr;
154 struct obd_ioctl_data *data;
158 if (copy_from_user(&hdr, arg, sizeof(hdr)))
161 if (hdr.ioc_version != OBD_IOCTL_VERSION) {
162 CERROR("Version mismatch kernel (%x) vs application (%x)\n",
163 OBD_IOCTL_VERSION, hdr.ioc_version);
167 if (hdr.ioc_len > OBD_MAX_IOCTL_BUFFER) {
168 CERROR("User buffer len %d exceeds %d max buffer\n",
169 hdr.ioc_len, OBD_MAX_IOCTL_BUFFER);
173 if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
174 CERROR("User buffer too small for ioctl (%d)\n", hdr.ioc_len);
178 /* When there are lots of processes calling vmalloc on multi-core
179 * system, the high lock contention will hurt performance badly,
180 * obdfilter-survey is an example, which relies on ioctl. So we'd
181 * better avoid vmalloc on ioctl path. LU-66 */
182 OBD_ALLOC_LARGE(*buf, hdr.ioc_len);
184 CERROR("Cannot allocate control buffer of len %d\n",
189 data = (struct obd_ioctl_data *)*buf;
191 if (copy_from_user(*buf, arg, hdr.ioc_len)) {
192 OBD_FREE_LARGE(*buf, hdr.ioc_len);
196 if (obd_ioctl_is_invalid(data)) {
197 CERROR("ioctl not correctly formatted\n");
198 OBD_FREE_LARGE(*buf, hdr.ioc_len);
202 if (data->ioc_inllen1) {
203 data->ioc_inlbuf1 = &data->ioc_bulk[0];
204 offset += cfs_size_round(data->ioc_inllen1);
207 if (data->ioc_inllen2) {
208 data->ioc_inlbuf2 = &data->ioc_bulk[0] + offset;
209 offset += cfs_size_round(data->ioc_inllen2);
212 if (data->ioc_inllen3) {
213 data->ioc_inlbuf3 = &data->ioc_bulk[0] + offset;
214 offset += cfs_size_round(data->ioc_inllen3);
217 if (data->ioc_inllen4)
218 data->ioc_inlbuf4 = &data->ioc_bulk[0] + offset;
222 EXPORT_SYMBOL(obd_ioctl_getdata);
224 /* opening /dev/obd */
225 static int obd_class_open(struct inode * inode, struct file * file)
229 try_module_get(THIS_MODULE);
233 /* closing /dev/obd */
234 static int obd_class_release(struct inode * inode, struct file * file)
238 module_put(THIS_MODULE);
242 /* to control /dev/obd */
243 static long obd_class_ioctl(struct file *filp, unsigned int cmd,
249 /* Allow non-root access for OBD_IOC_PING_TARGET - used by lfs check */
250 if (!cfs_capable(CFS_CAP_SYS_ADMIN) && (cmd != OBD_IOC_PING_TARGET))
251 RETURN(err = -EACCES);
252 if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
253 RETURN(err = -ENOTTY);
255 err = class_handle_ioctl(cmd, (unsigned long)arg);
260 /* declare character device */
261 static struct file_operations obd_psdev_fops = {
262 .owner = THIS_MODULE,
263 .unlocked_ioctl = obd_class_ioctl, /* unlocked_ioctl */
264 .open = obd_class_open, /* open */
265 .release = obd_class_release, /* release */
269 struct miscdevice obd_psdev = {
270 .minor = OBD_DEV_MINOR,
271 .name = OBD_DEV_NAME,
272 .fops = &obd_psdev_fops,
275 static ssize_t version_show(struct kobject *kobj, struct attribute *attr,
278 return sprintf(buf, "%s\n", LUSTRE_VERSION_STRING);
281 static ssize_t pinger_show(struct kobject *kobj, struct attribute *attr,
285 const char *state = "on";
287 const char *state = "off";
289 return sprintf(buf, "%s\n", state);
293 * Check all obd devices health
298 * \retval number of characters printed if healthy
301 health_check_show(struct kobject *kobj, struct attribute *attr, char *buf)
307 if (libcfs_catastrophe) {
308 len = sprintf(buf, "LBUG\n");
312 read_lock(&obd_dev_lock);
313 for (i = 0; i < class_devno_max(); i++) {
314 struct obd_device *obd;
316 obd = class_num2obd(i);
317 if (obd == NULL || !obd->obd_attached || !obd->obd_set_up)
320 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
321 if (obd->obd_stopping)
324 class_incref(obd, __FUNCTION__, current);
325 read_unlock(&obd_dev_lock);
327 if (obd_health_check(NULL, obd)) {
328 len = sprintf(buf, "device %s reported unhealthy\n",
332 class_decref(obd, __FUNCTION__, current);
333 read_lock(&obd_dev_lock);
335 read_unlock(&obd_dev_lock);
338 len = sprintf(buf, "healthy\n");
340 len = sprintf(buf, "NOT HEALTHY\n");
345 static ssize_t jobid_var_show(struct kobject *kobj, struct attribute *attr,
350 if (strlen(obd_jobid_var))
351 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_var);
355 static ssize_t jobid_var_store(struct kobject *kobj, struct attribute *attr,
356 const char *buffer, size_t count)
358 if (!count || count > JOBSTATS_JOBID_VAR_MAX_LEN)
361 memset(obd_jobid_var, 0, JOBSTATS_JOBID_VAR_MAX_LEN + 1);
363 memcpy(obd_jobid_var, buffer, count);
365 /* Trim the trailing '\n' if any */
366 if (obd_jobid_var[count - 1] == '\n')
367 obd_jobid_var[count - 1] = 0;
372 static ssize_t jobid_name_show(struct kobject *kobj, struct attribute *attr,
377 if (strlen(obd_jobid_node))
378 rc = snprintf(buf, PAGE_SIZE, "%s\n", obd_jobid_node);
382 static ssize_t jobid_name_store(struct kobject *kobj, struct attribute *attr,
383 const char *buffer, size_t count)
385 if (!count || count > LUSTRE_JOBID_SIZE)
388 /* clear previous value */
389 memset(obd_jobid_node, 0, LUSTRE_JOBID_SIZE);
391 memcpy(obd_jobid_node, buffer, count);
393 /* Trim the trailing '\n' if any */
394 if (obd_jobid_node[count - 1] == '\n') {
395 /* Don't echo just a newline */
398 obd_jobid_node[count - 1] = 0;
404 /* Root for /sys/kernel/debug/lustre */
405 struct dentry *debugfs_lustre_root;
406 EXPORT_SYMBOL_GPL(debugfs_lustre_root);
408 #ifdef CONFIG_PROC_FS
409 /* Root for /proc/fs/lustre */
410 struct proc_dir_entry *proc_lustre_root = NULL;
411 EXPORT_SYMBOL(proc_lustre_root);
413 #define lprocfs_base NULL
414 #endif /* CONFIG_PROC_FS */
416 LUSTRE_RO_ATTR(version);
417 LUSTRE_RO_ATTR(pinger);
418 LUSTRE_RO_ATTR(health_check);
419 LUSTRE_RW_ATTR(jobid_var);
420 LUSTRE_RW_ATTR(jobid_name);
422 static struct attribute *lustre_attrs[] = {
423 &lustre_attr_version.attr,
424 &lustre_attr_pinger.attr,
425 &lustre_attr_health_check.attr,
426 &lustre_attr_jobid_name.attr,
427 &lustre_attr_jobid_var.attr,
431 static void *obd_device_list_seq_start(struct seq_file *p, loff_t *pos)
433 if (*pos >= class_devno_max())
439 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
443 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
446 if (*pos >= class_devno_max())
452 static int obd_device_list_seq_show(struct seq_file *p, void *v)
454 loff_t index = *(loff_t *)v;
455 struct obd_device *obd = class_num2obd((int)index);
461 LASSERT(obd->obd_magic == OBD_DEVICE_MAGIC);
462 if (obd->obd_stopping)
464 else if (obd->obd_inactive)
466 else if (obd->obd_set_up)
468 else if (obd->obd_attached)
473 seq_printf(p, "%3d %s %s %s %s %d\n",
474 (int)index, status, obd->obd_type->typ_name,
475 obd->obd_name, obd->obd_uuid.uuid,
476 atomic_read(&obd->obd_refcount));
480 static const struct seq_operations obd_device_list_sops = {
481 .start = obd_device_list_seq_start,
482 .stop = obd_device_list_seq_stop,
483 .next = obd_device_list_seq_next,
484 .show = obd_device_list_seq_show,
487 static int obd_device_list_open(struct inode *inode, struct file *file)
489 struct seq_file *seq;
490 int rc = seq_open(file, &obd_device_list_sops);
495 seq = file->private_data;
496 seq->private = inode->i_private;
500 static const struct file_operations obd_device_list_fops = {
501 .owner = THIS_MODULE,
502 .open = obd_device_list_open,
505 .release = seq_release,
508 struct kobject *lustre_kobj;
509 EXPORT_SYMBOL_GPL(lustre_kobj);
511 static struct attribute_group lustre_attr_group = {
512 .attrs = lustre_attrs,
515 int class_procfs_init(void)
517 struct proc_dir_entry *entry;
522 lustre_kobj = kobject_create_and_add("lustre", fs_kobj);
523 if (lustre_kobj == NULL)
526 /* Create the files associated with this kobject */
527 rc = sysfs_create_group(lustre_kobj, &lustre_attr_group);
529 kobject_put(lustre_kobj);
533 rc = obd_sysctl_init();
535 kobject_put(lustre_kobj);
539 debugfs_lustre_root = debugfs_create_dir("lustre", NULL);
540 if (IS_ERR_OR_NULL(debugfs_lustre_root)) {
541 rc = debugfs_lustre_root ? PTR_ERR(debugfs_lustre_root)
543 debugfs_lustre_root = NULL;
544 kobject_put(lustre_kobj);
548 file = debugfs_create_file("devices", 0444, debugfs_lustre_root, NULL,
549 &obd_device_list_fops);
550 if (IS_ERR_OR_NULL(file)) {
551 rc = file ? PTR_ERR(file) : -ENOMEM;
552 kobject_put(lustre_kobj);
556 entry = lprocfs_register("fs/lustre", NULL, NULL, NULL);
559 CERROR("cannot create '/proc/fs/lustre': rc = %d\n", rc);
560 kobject_put(lustre_kobj);
564 proc_lustre_root = entry;
569 int class_procfs_clean(void)
573 debugfs_remove_recursive(debugfs_lustre_root);
575 debugfs_lustre_root = NULL;
577 if (proc_lustre_root)
578 lprocfs_remove(&proc_lustre_root);
580 kobject_put(lustre_kobj);