1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Object Devices Class Driver
6 * Copyright (C) 2001-2003 Cluster File Systems, Inc.
8 * This file is part of Lustre, http://www.lustre.org.
10 * Lustre is free software; you can redistribute it and/or
11 * modify it under the terms of version 2 of the GNU General Public
12 * License as published by the Free Software Foundation.
14 * Lustre is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with Lustre; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * These are the only exported functions, they provide some generic
24 * infrastructure for managing object devices
27 #define DEBUG_SUBSYSTEM S_CLASS
29 # define EXPORT_SYMTAB
32 #include <linux/config.h> /* for CONFIG_PROC_FS */
33 #include <linux/module.h>
34 #include <linux/errno.h>
35 #include <linux/kernel.h>
36 #include <linux/major.h>
37 #include <linux/sched.h>
39 #include <linux/slab.h>
40 #include <linux/ioport.h>
41 #include <linux/fcntl.h>
42 #include <linux/delay.h>
43 #include <linux/skbuff.h>
44 #include <linux/proc_fs.h>
46 #include <linux/poll.h>
47 #include <linux/init.h>
48 #include <linux/list.h>
49 #include <linux/highmem.h>
51 #include <asm/ioctls.h>
52 #include <asm/system.h>
54 #include <asm/uaccess.h>
55 #include <linux/miscdevice.h>
56 #include <linux/smp_lock.h>
57 #include <linux/seq_file.h>
59 # include <liblustre.h>
62 #include <linux/obd_support.h>
63 #include <linux/obd_class.h>
64 #include <linux/lustre_debug.h>
65 #include <linux/lprocfs_status.h>
67 #include <linux/lustre_build_version.h>
69 #include <portals/list.h>
70 #include "llog_internal.h"
73 /* liblustre workaround */
74 atomic_t portal_kmemory = {0};
77 struct semaphore obd_conf_sem; /* serialize configuration commands */
78 struct obd_device obd_dev[MAX_OBD_DEVICES];
79 struct list_head obd_types;
87 /* The following are visible and mutable through /proc/sys/lustre/. */
88 unsigned int obd_fail_loc;
89 unsigned int obd_timeout = 100;
90 char obd_lustre_upcall[128] = "DEFAULT"; /* or NONE or /full/path/to/upcall */
91 unsigned int obd_sync_filter; /* = 0, don't sync by default */
93 DECLARE_WAIT_QUEUE_HEAD(obd_race_waitq);
96 /* opening /dev/obd */
97 static int obd_class_open(struct inode * inode, struct file * file)
105 /* closing /dev/obd */
106 static int obd_class_release(struct inode * inode, struct file * file)
115 static inline void obd_data2conn(struct lustre_handle *conn,
116 struct obd_ioctl_data *data)
118 memset(conn, 0, sizeof *conn);
119 conn->cookie = data->ioc_cookie;
122 static inline void obd_conn2data(struct obd_ioctl_data *data,
123 struct lustre_handle *conn)
125 data->ioc_cookie = conn->cookie;
128 int class_resolve_dev_name(uint32_t len, char *name)
134 CERROR("No name passed,!\n");
135 GOTO(out, rc = -EINVAL);
137 if (name[len - 1] != 0) {
138 CERROR("Name not nul terminated!\n");
139 GOTO(out, rc = -EINVAL);
142 CDEBUG(D_IOCTL, "device name %s\n", name);
143 dev = class_name2dev(name);
145 CDEBUG(D_IOCTL, "No device for name %s!\n", name);
146 GOTO(out, rc = -EINVAL);
149 CDEBUG(D_IOCTL, "device name %s, dev %d\n", name, dev);
156 int class_handle_ioctl(unsigned int cmd, unsigned long arg)
159 struct obd_ioctl_data *data;
160 struct portals_debug_ioctl_data *debug_data;
161 struct obd_device *obd = NULL;
162 int err = 0, len = 0, serialised = 0;
165 if (current->fsuid != 0)
166 RETURN(err = -EACCES);
168 if ((cmd & 0xffffff00) == ((int)'T') << 8) /* ignore all tty ioctls */
169 RETURN(err = -ENOTTY);
171 /* only for debugging */
172 if (cmd == PTL_IOC_DEBUG_MASK) {
173 debug_data = (struct portals_debug_ioctl_data*)arg;
174 portal_subsystem_debug = debug_data->subs;
175 portal_debug = debug_data->debug;
180 case OBD_IOC_BRW_WRITE:
181 case OBD_IOC_BRW_READ:
182 case OBD_IOC_GETATTR:
183 case ECHO_IOC_ENQUEUE:
184 case ECHO_IOC_CANCEL:
185 case OBD_IOC_CLIENT_RECOVER:
186 case OBD_IOC_CATLOGLIST:
187 case OBD_IOC_LLOG_INFO:
188 case OBD_IOC_LLOG_PRINT:
189 case OBD_IOC_LLOG_CANCEL:
190 case OBD_IOC_LLOG_CHECK:
191 case OBD_IOC_LLOG_REMOVE:
199 CDEBUG(D_IOCTL, "cmd = %x, obd = %p\n", cmd, obd);
200 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
201 CERROR("OBD ioctl: data error\n");
202 GOTO(out, err = -EINVAL);
204 data = (struct obd_ioctl_data *)buf;
207 case OBD_IOC_PROCESS_CFG: {
209 struct lustre_cfg *lcfg;
211 if (!data->ioc_plen1 || !data->ioc_pbuf1) {
212 CERROR("No config buffer passed!\n");
213 GOTO(out, err = -EINVAL);
215 err = lustre_cfg_getdata(&buf, data->ioc_plen1,
219 lcfg = (struct lustre_cfg* ) buf;
221 err = class_process_config(lcfg);
222 lustre_cfg_freedata(buf, data->ioc_plen1);
226 case OBD_GET_VERSION:
227 if (!data->ioc_inlbuf1) {
228 CERROR("No buffer passed in ioctl\n");
229 GOTO(out, err = -EINVAL);
232 if (strlen(BUILD_VERSION) + 1 > data->ioc_inllen1) {
233 CERROR("ioctl buffer too small to hold version\n");
234 GOTO(out, err = -EINVAL);
237 memcpy(data->ioc_bulk, BUILD_VERSION,
238 strlen(BUILD_VERSION) + 1);
240 err = copy_to_user((void *)arg, data, len);
245 case OBD_IOC_NAME2DEV: {
246 /* Resolve a device name. This does not change the
247 * currently selected device.
251 dev = class_resolve_dev_name(data->ioc_inllen1,
255 GOTO(out, err = -EINVAL);
257 err = copy_to_user((void *)arg, data, sizeof(*data));
263 case OBD_IOC_UUID2DEV: {
264 /* Resolve a device uuid. This does not change the
265 * currently selected device.
268 struct obd_uuid uuid;
270 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
271 CERROR("No UUID passed!\n");
272 GOTO(out, err = -EINVAL);
274 if (data->ioc_inlbuf1[data->ioc_inllen1 - 1] != 0) {
275 CERROR("UUID not NUL terminated!\n");
276 GOTO(out, err = -EINVAL);
279 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
280 obd_str2uuid(&uuid, data->ioc_inlbuf1);
281 dev = class_uuid2dev(&uuid);
284 CDEBUG(D_IOCTL, "No device for UUID %s!\n",
286 GOTO(out, err = -EINVAL);
289 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
291 err = copy_to_user((void *)arg, data, sizeof(*data));
298 case OBD_IOC_CLOSE_UUID: {
301 CDEBUG(D_IOCTL, "closing all connections to uuid %s\n",
303 lustre_uuid_to_peer(data->ioc_inlbuf1, &peer_nal, &peer_nid);
309 if (data->ioc_dev >= MAX_OBD_DEVICES) {
310 CERROR("OBD ioctl: No device\n");
311 GOTO(out, err = -EINVAL);
313 obd = &obd_dev[data->ioc_dev];
314 if (!(obd && obd->obd_set_up) || obd->obd_stopping) {
315 CERROR("OBD ioctl: device not setup %d \n", data->ioc_dev);
316 GOTO(out, err = -EINVAL);
320 case OBD_IOC_NO_TRANSNO: {
321 if (!obd->obd_attached) {
322 CERROR("Device %d not attached\n", obd->obd_minor);
323 GOTO(out, err = -ENODEV);
326 "disabling committed-transno notifications on %d\n",
328 obd->obd_no_transno = 1;
333 err = obd_iocontrol(cmd, obd->obd_self_export, len, data, NULL);
337 err = copy_to_user((void *)arg, data, len);
346 obd_ioctl_freedata(buf, len);
350 } /* class_handle_ioctl */
354 #define OBD_MINOR 241
356 /* to control /dev/obd */
357 static int obd_class_ioctl(struct inode *inode, struct file *filp,
358 unsigned int cmd, unsigned long arg)
360 return class_handle_ioctl(cmd, arg);
363 /* declare character device */
364 static struct file_operations obd_psdev_fops = {
365 .owner = THIS_MODULE,
366 .ioctl = obd_class_ioctl, /* ioctl */
367 .open = obd_class_open, /* open */
368 .release = obd_class_release, /* release */
372 static struct miscdevice obd_psdev = {
375 .fops = &obd_psdev_fops,
378 void *obd_psdev = NULL;
381 EXPORT_SYMBOL(obd_dev);
382 EXPORT_SYMBOL(obdo_cachep);
383 EXPORT_SYMBOL(obd_fail_loc);
384 EXPORT_SYMBOL(obd_race_waitq);
385 EXPORT_SYMBOL(obd_timeout);
386 EXPORT_SYMBOL(obd_lustre_upcall);
387 EXPORT_SYMBOL(obd_sync_filter);
388 EXPORT_SYMBOL(ptlrpc_put_connection_superhack);
389 EXPORT_SYMBOL(ptlrpc_abort_inflight_superhack);
390 EXPORT_SYMBOL(proc_lustre_root);
392 EXPORT_SYMBOL(class_register_type);
393 EXPORT_SYMBOL(class_unregister_type);
394 EXPORT_SYMBOL(class_get_type);
395 EXPORT_SYMBOL(class_put_type);
396 EXPORT_SYMBOL(class_name2dev);
397 EXPORT_SYMBOL(class_name2obd);
398 EXPORT_SYMBOL(class_uuid2dev);
399 EXPORT_SYMBOL(class_uuid2obd);
400 EXPORT_SYMBOL(class_find_client_obd);
401 EXPORT_SYMBOL(class_devices_in_group);
402 EXPORT_SYMBOL(__class_export_put);
403 EXPORT_SYMBOL(class_new_export);
404 EXPORT_SYMBOL(class_unlink_export);
405 EXPORT_SYMBOL(class_import_get);
406 EXPORT_SYMBOL(class_import_put);
407 EXPORT_SYMBOL(class_new_import);
408 EXPORT_SYMBOL(class_destroy_import);
409 EXPORT_SYMBOL(class_connect);
410 EXPORT_SYMBOL(class_conn2export);
411 EXPORT_SYMBOL(class_exp2obd);
412 EXPORT_SYMBOL(class_conn2obd);
413 EXPORT_SYMBOL(class_exp2cliimp);
414 EXPORT_SYMBOL(class_conn2cliimp);
415 EXPORT_SYMBOL(class_disconnect);
416 EXPORT_SYMBOL(class_disconnect_exports);
418 EXPORT_SYMBOL(oig_init);
419 EXPORT_SYMBOL(oig_release);
420 EXPORT_SYMBOL(oig_add_one);
421 EXPORT_SYMBOL(oig_wait);
422 EXPORT_SYMBOL(oig_complete_one);
425 EXPORT_SYMBOL(class_uuid_unparse);
426 EXPORT_SYMBOL(lustre_uuid_to_peer);
428 EXPORT_SYMBOL(class_handle_hash);
429 EXPORT_SYMBOL(class_handle_unhash);
430 EXPORT_SYMBOL(class_handle2object);
433 EXPORT_SYMBOL(class_get_profile);
434 EXPORT_SYMBOL(class_del_profile);
435 EXPORT_SYMBOL(class_process_config);
436 EXPORT_SYMBOL(class_config_parse_llog);
437 EXPORT_SYMBOL(class_config_dump_llog);
438 EXPORT_SYMBOL(class_attach);
439 EXPORT_SYMBOL(class_setup);
440 EXPORT_SYMBOL(class_cleanup);
441 EXPORT_SYMBOL(class_detach);
444 int obd_proc_read_version(char *page, char **start, off_t off, int count,
445 int *eof, void *data)
448 return snprintf(page, count, "%s\n", BUILD_VERSION);
451 int obd_proc_read_pinger(char *page, char **start, off_t off, int count,
452 int *eof, void *data)
455 return snprintf(page, count, "%s\n",
464 /* Root for /proc/fs/lustre */
465 struct proc_dir_entry *proc_lustre_root = NULL;
466 struct lprocfs_vars lprocfs_base[] = {
467 { "version", obd_proc_read_version, NULL, NULL },
468 { "pinger", obd_proc_read_pinger, NULL, NULL },
472 static void *obd_device_list_seq_start(struct seq_file *p, loff_t*pos)
474 if (*pos >= MAX_OBD_DEVICES)
476 return &obd_dev[*pos];
479 static void obd_device_list_seq_stop(struct seq_file *p, void *v)
483 static void *obd_device_list_seq_next(struct seq_file *p, void *v, loff_t *pos)
486 if (*pos >= MAX_OBD_DEVICES)
488 return &obd_dev[*pos];
491 static int obd_device_list_seq_show(struct seq_file *p, void *v)
493 struct obd_device *obd = (struct obd_device *)v;
494 int index = obd - &obd_dev[0];
499 if (obd->obd_stopping)
501 else if (obd->obd_set_up)
503 else if (obd->obd_attached)
508 return seq_printf(p, "%3d %s %s %s %s %d\n",
509 (int)index, status, obd->obd_type->typ_name,
510 obd->obd_name, obd->obd_uuid.uuid,
511 atomic_read(&obd->obd_refcount));
514 struct seq_operations obd_device_list_sops = {
515 .start = obd_device_list_seq_start,
516 .stop = obd_device_list_seq_stop,
517 .next = obd_device_list_seq_next,
518 .show = obd_device_list_seq_show,
521 static int obd_device_list_open(struct inode *inode, struct file *file)
523 struct proc_dir_entry *dp = PDE(inode);
524 struct seq_file *seq;
525 int rc = seq_open(file, &obd_device_list_sops);
530 seq = file->private_data;
531 seq->private = dp->data;
536 struct file_operations obd_device_list_fops = {
537 .owner = THIS_MODULE,
538 .open = obd_device_list_open,
541 .release = seq_release,
546 static int __init init_obdclass(void)
548 int init_obdclass(void)
551 struct obd_device *obd;
553 struct proc_dir_entry *entry;
558 printk(KERN_INFO "Lustre: OBD class driver Build Version: "
559 BUILD_VERSION", info@clusterfs.com\n");
561 class_init_uuidlist();
562 err = class_handle_init();
566 sema_init(&obd_conf_sem, 1);
567 INIT_LIST_HEAD(&obd_types);
569 err = misc_register(&obd_psdev);
571 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
575 /* This struct is already zerod for us (static global) */
576 for (i = 0, obd = obd_dev; i < MAX_OBD_DEVICES; i++, obd++)
579 err = obd_init_caches();
588 proc_lustre_root = proc_mkdir("lustre", proc_root_fs);
589 if (!proc_lustre_root) {
591 "LustreError: error registering /proc/fs/lustre\n");
594 proc_version = lprocfs_add_vars(proc_lustre_root, lprocfs_base, NULL);
595 entry = create_proc_entry("devices", 0444, proc_lustre_root);
597 printk(KERN_ERR "LustreError: error registering "
598 "/proc/fs/lustre/devices\n");
599 lprocfs_remove(proc_lustre_root);
602 entry->proc_fops = &obd_device_list_fops;
607 /* liblustre doesn't call cleanup_obdclass, apparently. we carry on in this
608 * ifdef to the end of the file to cover module and versioning goo.*/
611 static void cleanup_obdclass(void)
617 misc_deregister(&obd_psdev);
618 for (i = 0; i < MAX_OBD_DEVICES; i++) {
619 struct obd_device *obd = &obd_dev[i];
620 if (obd->obd_type && obd->obd_set_up &&
621 OBT(obd) && OBP(obd, detach)) {
622 /* XXX should this call generic detach otherwise? */
623 OBP(obd, detach)(obd);
627 obd_cleanup_caches();
630 if (proc_lustre_root) {
631 lprocfs_remove(proc_lustre_root);
632 proc_lustre_root = NULL;
636 class_handle_cleanup();
637 class_exit_uuidlist();
639 leaked = atomic_read(&obd_memory);
640 CDEBUG(leaked ? D_ERROR : D_INFO,
641 "obd mem max: %d leaked: %d\n", obd_memmax, leaked);
646 /* Check that we're building against the appropriate version of the Lustre
648 #include <linux/lustre_version.h>
649 #define LUSTRE_MIN_VERSION 28
650 #define LUSTRE_MAX_VERSION 34
651 #if (LUSTRE_KERNEL_VERSION < LUSTRE_MIN_VERSION)
652 # error Cannot continue: Your Lustre kernel patch is older than the sources
653 #elif (LUSTRE_KERNEL_VERSION > LUSTRE_MAX_VERSION)
654 # error Cannot continue: Your Lustre sources are older than the kernel patch
657 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
658 MODULE_DESCRIPTION("Lustre Class Driver Build Version: " BUILD_VERSION);
659 MODULE_LICENSE("GPL");
661 module_init(init_obdclass);
662 module_exit(cleanup_obdclass);