1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
6 * This code is issued under the GNU General Public License.
7 * See the file COPYING in this distribution
9 * These are the only exported functions, they provide some generic
10 * infrastructure for managing object devices
12 * Object Devices Class Driver
16 #include <linux/config.h> /* for CONFIG_PROC_FS */
17 #include <linux/module.h>
18 #include <linux/errno.h>
19 #include <linux/kernel.h>
20 #include <linux/major.h>
21 #include <linux/sched.h>
23 #include <linux/slab.h>
24 #include <linux/ioport.h>
25 #include <linux/fcntl.h>
26 #include <linux/delay.h>
27 #include <linux/skbuff.h>
28 #include <linux/proc_fs.h>
30 #include <linux/poll.h>
31 #include <linux/init.h>
32 #include <linux/list.h>
34 #include <asm/system.h>
36 #include <asm/uaccess.h>
37 #include <linux/miscdevice.h>
39 #define DEBUG_SUBSYSTEM S_CLASS
41 #include <linux/obd_support.h>
42 #include <linux/obd_class.h>
43 #include <linux/lustre_debug.h>
44 #include <linux/smp_lock.h>
46 struct semaphore obd_conf_sem; /* serialize configuration commands */
47 struct obd_device obd_dev[MAX_OBD_DEVICES];
48 struct list_head obd_types;
49 unsigned long obd_memory;
51 /* The following are visible and mutable through /proc/sys/lustre/. */
52 unsigned long obd_fail_loc;
53 unsigned long obd_timeout = 100;
54 char obd_recovery_upcall[128] = "/usr/lib/lustre/ha_assist";
56 extern struct obd_type *class_nm_to_type(char *nm);
58 /* opening /dev/obd */
59 static int obd_class_open(struct inode * inode, struct file * file)
63 file->private_data = NULL;
68 /* closing /dev/obd */
69 static int obd_class_release(struct inode * inode, struct file * file)
73 if (file->private_data)
74 file->private_data = NULL;
81 inline void obd_data2conn(struct lustre_handle *conn, struct obd_ioctl_data *data)
83 conn->addr = data->ioc_addr;
84 conn->cookie = data->ioc_cookie;
88 inline void obd_conn2data(struct obd_ioctl_data *data, struct lustre_handle *conn)
90 data->ioc_addr = conn->addr;
91 data->ioc_cookie = conn->cookie;
95 /* to control /dev/obd */
96 static int obd_class_ioctl (struct inode * inode, struct file * filp,
97 unsigned int cmd, unsigned long arg)
101 struct obd_ioctl_data *data;
102 struct obd_device *obd = filp->private_data;
104 struct lustre_handle conn;
105 int rw = OBD_BRW_READ;
112 case OBD_IOC_BRW_WRITE:
113 case OBD_IOC_BRW_READ:
114 case OBD_IOC_GETATTR:
122 if (!obd && cmd != OBD_IOC_DEVICE && cmd != TCGETS &&
123 cmd != OBD_IOC_LIST &&
124 cmd != OBD_IOC_NAME2DEV && cmd != OBD_IOC_NEWDEV) {
125 CERROR("OBD ioctl: No device\n");
126 GOTO(out, err=-EINVAL);
128 if (obd_ioctl_getdata(&buf, &len, (void *)arg)) {
129 CERROR("OBD ioctl: data error\n");
130 GOTO(out, err=-EINVAL);
132 data = (struct obd_ioctl_data *)buf;
136 GOTO(out, err=-EINVAL);
137 case OBD_IOC_DEVICE: {
138 CDEBUG(D_IOCTL, "\n");
139 if (data->ioc_dev >= MAX_OBD_DEVICES || data->ioc_dev < 0) {
140 CERROR("OBD ioctl: DEVICE insufficient devices\n");
141 GOTO(out, err=-EINVAL);
143 CDEBUG(D_IOCTL, "device %d\n", data->ioc_dev);
145 filp->private_data = &obd_dev[data->ioc_dev];
151 char *buf2 = data->ioc_bulk;
152 int remains = data->ioc_inllen1;
154 if (!data->ioc_inlbuf1) {
155 CERROR("No buffer passed!\n");
156 GOTO(out, err=-EINVAL);
160 for (i = 0 ; i < MAX_OBD_DEVICES ; i++) {
163 struct obd_device *obd = &obd_dev[i];
166 if (obd->obd_flags & OBD_SET_UP)
168 else if (obd->obd_flags & OBD_ATTACHED)
172 l = snprintf(buf2, remains, "%2d %s %s %s %s %d\n",
173 i, status, obd->obd_type->typ_name,
174 obd->obd_name, obd->obd_uuid, obd->obd_type->typ_refcnt);
178 CERROR("not enough space for device listing\n");
183 err = copy_to_user((int *)arg, data, len);
188 case OBD_IOC_NAME2DEV: {
189 /* Resolve a device name. This does not change the
190 * currently selected device.
194 if (!data->ioc_inllen1 || !data->ioc_inlbuf1 ) {
195 CERROR("No name passed,!\n");
196 GOTO(out, err=-EINVAL);
198 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
199 CERROR("Name not nul terminated!\n");
200 GOTO(out, err=-EINVAL);
203 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
204 dev = class_name2dev(data->ioc_inlbuf1);
207 CDEBUG(D_IOCTL, "No device for name %s!\n",
209 GOTO(out, err=-EINVAL);
212 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
214 err = copy_to_user((int *)arg, data, sizeof(*data));
218 case OBD_IOC_UUID2DEV: {
219 /* Resolve a device uuid. This does not change the
220 * currently selected device.
224 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
225 CERROR("No UUID passed!\n");
226 GOTO(out, err=-EINVAL);
228 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
229 CERROR("Name not nul terminated!\n");
230 GOTO(out, err=-EINVAL);
233 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
234 dev = class_uuid2dev(data->ioc_inlbuf1);
237 CDEBUG(D_IOCTL, "No device for name %s!\n",
239 GOTO(out, err=-EINVAL);
242 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
244 err = copy_to_user((int *)arg, data, sizeof(*data));
248 case OBD_IOC_NEWDEV: {
252 filp->private_data = NULL;
253 for (i = 0 ; i < MAX_OBD_DEVICES ; i++) {
254 struct obd_device *obd = &obd_dev[i];
255 if (!obd->obd_type) {
256 filp->private_data = obd;
265 GOTO(out, err=-EINVAL);
267 err = copy_to_user((int *)arg, data, sizeof(*data));
271 case OBD_IOC_ATTACH: {
272 struct obd_type *type;
275 /* have we attached a type to this device */
276 if (obd->obd_flags & OBD_ATTACHED || obd->obd_type) {
277 CERROR("OBD: Device %d already typed as %s.\n",
278 obd->obd_minor, MKSTR(obd->obd_type->typ_name));
279 GOTO(out, err=-EBUSY);
282 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
283 CERROR("No type passed!\n");
284 GOTO(out, err=-EINVAL);
286 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
287 CERROR("Type not nul terminated!\n");
288 GOTO(out, err=-EINVAL);
291 CDEBUG(D_IOCTL, "attach type %s name: %s uuid: %s\n",
292 MKSTR(data->ioc_inlbuf1),
293 MKSTR(data->ioc_inlbuf2), MKSTR(data->ioc_inlbuf3));
296 type = class_nm_to_type(data->ioc_inlbuf1);
298 CERROR("OBD: unknown type dev %d\n", obd->obd_minor);
299 GOTO(out, err=-EINVAL);
302 minor = obd->obd_minor;
303 memset(obd, 0, sizeof(*obd));
304 obd->obd_minor = minor;
305 obd->obd_type = type;
306 INIT_LIST_HEAD(&obd->obd_exports);
307 INIT_LIST_HEAD(&obd->obd_imports);
308 spin_lock_init(&obd->obd_dev_lock);
311 if (OBP(obd, attach))
312 err = OBP(obd,attach)(obd, sizeof(*data), data);
314 obd->obd_type = NULL;
316 obd->obd_flags |= OBD_ATTACHED;
319 CDEBUG(D_IOCTL, "OBD: dev %d attached type %s\n",
320 obd->obd_minor, data->ioc_inlbuf1);
321 if (data->ioc_inlbuf2) {
322 int len = strlen(data->ioc_inlbuf2) + 1;
323 OBD_ALLOC(obd->obd_name, len);
324 if (!obd->obd_name) {
325 CERROR("no memory\n");
328 memcpy(obd->obd_name, data->ioc_inlbuf2, len);
329 obd->obd_proc_entry =
330 proc_lustre_register_obd_device(obd);
332 CERROR("WARNING: unnamed obd device\n");
333 obd->obd_proc_entry = NULL;
336 if (data->ioc_inlbuf3) {
337 int len = strlen(data->ioc_inlbuf3);
338 if (len >= sizeof(obd->obd_uuid)) {
339 CERROR("uuid must be < %d bytes long\n",
340 sizeof(obd->obd_uuid));
342 OBD_FREE(obd->obd_name,
343 strlen(obd->obd_name) + 1);
344 GOTO(out, err=-EINVAL);
346 memcpy(obd->obd_uuid, data->ioc_inlbuf3, len);
354 case OBD_IOC_DETACH: {
356 if (obd->obd_flags & OBD_SET_UP) {
357 CERROR("OBD device %d still set up\n", obd->obd_minor);
358 GOTO(out, err=-EBUSY);
360 if (!(obd->obd_flags & OBD_ATTACHED) ) {
361 CERROR("OBD device %d not attached\n", obd->obd_minor);
362 GOTO(out, err=-ENODEV);
364 #warning FIXME: Mike, we probably need some sort of "force detach" here
365 if (!list_empty(&obd->obd_exports) ) {
366 CERROR("OBD device %d (%p) has exports\n",
367 obd->obd_minor, obd);
368 GOTO(out, err=-EBUSY);
372 OBD_FREE(obd->obd_name, strlen(obd->obd_name)+1);
373 obd->obd_name = NULL;
376 if (obd->obd_proc_entry)
377 proc_lustre_release_obd_device(obd);
379 obd->obd_flags &= ~OBD_ATTACHED;
380 obd->obd_type->typ_refcnt--;
381 obd->obd_type = NULL;
386 case OBD_IOC_SETUP: {
387 /* have we attached a type to this device? */
388 if (!(obd->obd_flags & OBD_ATTACHED)) {
389 CERROR("Device %d not attached\n", obd->obd_minor);
390 GOTO(out, err=-ENODEV);
393 /* has this been done already? */
394 if ( obd->obd_flags & OBD_SET_UP ) {
395 CERROR("Device %d already setup (type %s)\n",
396 obd->obd_minor, obd->obd_type->typ_name);
397 GOTO(out, err=-EBUSY);
400 if ( OBT(obd) && OBP(obd, setup) )
401 err = obd_setup(obd, sizeof(*data), data);
404 obd->obd_type->typ_refcnt++;
405 obd->obd_flags |= OBD_SET_UP;
410 case OBD_IOC_CLEANUP: {
411 /* have we attached a type to this device? */
412 if (!(obd->obd_flags & OBD_ATTACHED)) {
413 CERROR("Device %d not attached\n", obd->obd_minor);
414 GOTO(out, err=-ENODEV);
417 if ( OBT(obd) && OBP(obd, cleanup) )
418 err = obd_cleanup(obd);
421 obd->obd_flags &= ~OBD_SET_UP;
422 obd->obd_type->typ_refcnt--;
427 case OBD_IOC_CONNECT: {
428 char * cluuid = "OBD_CLASS_UUID";
429 obd_data2conn(&conn, data);
431 err = obd_connect(&conn, obd, cluuid);
433 CDEBUG(D_IOCTL, "assigned export %Lx\n", conn.addr);
434 obd_conn2data(data, &conn);
438 err = copy_to_user((int *)arg, data, sizeof(*data));
442 case OBD_IOC_DISCONNECT: {
443 obd_data2conn(&conn, data);
444 err = obd_disconnect(&conn);
448 case OBD_IOC_DEC_USE_COUNT: {
453 case OBD_IOC_CREATE: {
454 struct lov_stripe_md *ea;
455 obd_data2conn(&conn, data);
458 err = obd_create(&conn, &data->ioc_obdo1, &ea);
462 err = copy_to_user((int *)arg, data, sizeof(*data));
466 case OBD_IOC_GETATTR: {
468 obd_data2conn(&conn, data);
469 err = obd_getattr(&conn, &data->ioc_obdo1, NULL);
473 err = copy_to_user((int *)arg, data, sizeof(*data));
477 case OBD_IOC_SETATTR: {
478 obd_data2conn(&conn, data);
479 err = obd_setattr(&conn, &data->ioc_obdo1, NULL);
483 err = copy_to_user((int *)arg, data, sizeof(*data));
487 case OBD_IOC_DESTROY: {
489 obd_data2conn(&conn, data);
491 err = obd_destroy(&conn, &data->ioc_obdo1, NULL);
495 err = copy_to_user((int *)arg, data, sizeof(*data));
499 case OBD_IOC_BRW_WRITE:
501 case OBD_IOC_BRW_READ: {
502 struct lov_stripe_md smd;
503 struct io_cb_data *cbd = ll_init_cb();
505 struct brw_page *pga, *pgp;
506 __u64 id = data->ioc_obdo1.o_id;
507 int gfp_mask = (id & 1) ? GFP_HIGHUSER : GFP_KERNEL;
508 int verify = (id != 0);
513 GOTO(out, err = -ENOMEM);
515 obd_data2conn(&conn, data);
517 pages = data->ioc_count / PAGE_SIZE;
519 CDEBUG(D_INODE, "BRW %s with %d pages\n",
520 rw == OBD_BRW_READ ? "read" : "write", pages);
521 OBD_ALLOC(pga, pages * sizeof(*pga));
523 CERROR("no memory for %d BRW per-page data\n", pages);
524 GOTO(brw_free, err = -ENOMEM);
527 memset(&smd, 0, sizeof(smd));
528 smd.lmd_object_id = id;
530 off = data->ioc_offset;
532 for (j = 0, pgp = pga; j < pages; j++, off += PAGE_SIZE, pgp++){
533 pgp->pg = alloc_pages(gfp_mask, 0);
535 CERROR("no memory for brw pages\n");
536 GOTO(brw_cleanup, err = -ENOMEM);
538 pgp->count = PAGE_SIZE;
543 void *addr = kmap(pgp->pg);
545 if (rw == OBD_BRW_WRITE)
546 page_debug_setup(addr, pgp->count,
549 page_debug_setup(addr, pgp->count,
556 err = obd_brw(rw, &conn, &smd, j, pga, ll_sync_io_cb, cbd);
558 CERROR("test_brw: error from obd_brw: err = %d\n", err);
561 for (j = 0, pgp = pga; j < pages; j++, pgp++) {
562 if (pgp->pg != NULL) {
563 if (verify && !err) {
564 void *addr = kmap(pgp->pg);
566 err = page_debug_check("test_brw",
572 __free_pages(pgp->pg, 0);
576 OBD_FREE(pga, pages * sizeof(*pga));
580 obd_data2conn(&conn, data);
582 err = obd_iocontrol(cmd, &conn, len, data, NULL);
586 err = copy_to_user((int *)arg, data, len);
596 } /* obd_class_ioctl */
600 /* declare character device */
601 static struct file_operations obd_psdev_fops = {
602 ioctl: obd_class_ioctl, /* ioctl */
603 open: obd_class_open, /* open */
604 release: obd_class_release, /* release */
608 #define OBD_MINOR 241
609 static struct miscdevice obd_psdev = {
615 void (*class_signal_connection_failure)(struct ptlrpc_connection *);
616 int (*mds_destroy_export)(struct obd_export *exp);
617 int (*ldlm_destroy_export)(struct obd_export *exp);
619 EXPORT_SYMBOL(obd_dev);
620 EXPORT_SYMBOL(obdo_cachep);
621 EXPORT_SYMBOL(obd_memory);
622 EXPORT_SYMBOL(obd_fail_loc);
623 EXPORT_SYMBOL(obd_timeout);
624 EXPORT_SYMBOL(obd_recovery_upcall);
626 EXPORT_SYMBOL(class_register_type);
627 EXPORT_SYMBOL(class_unregister_type);
628 EXPORT_SYMBOL(class_name2dev);
629 EXPORT_SYMBOL(class_uuid2dev);
630 EXPORT_SYMBOL(class_uuid2obd);
631 EXPORT_SYMBOL(class_new_export);
632 EXPORT_SYMBOL(class_destroy_export);
633 EXPORT_SYMBOL(class_connect);
634 EXPORT_SYMBOL(class_conn2export);
635 EXPORT_SYMBOL(class_conn2obd);
636 EXPORT_SYMBOL(class_conn2cliimp);
637 EXPORT_SYMBOL(class_conn2ldlmimp);
638 EXPORT_SYMBOL(class_disconnect);
639 EXPORT_SYMBOL(class_disconnect_all);
640 //EXPORT_SYMBOL(class_uuid_parse);
641 EXPORT_SYMBOL(class_uuid_unparse);
642 //EXPORT_SYMBOL(class_multi_setup);
643 //EXPORT_SYMBOL(class_multi_cleanup);
645 EXPORT_SYMBOL(class_signal_connection_failure);
646 EXPORT_SYMBOL(mds_destroy_export);
647 EXPORT_SYMBOL(ldlm_destroy_export);
648 EXPORT_SYMBOL(ll_sync_io_cb);
649 EXPORT_SYMBOL(ll_init_cb);
651 static int __init init_obdclass(void)
653 struct obd_device *obd;
657 printk(KERN_INFO "OBD class driver v0.9, info@clusterfs.com\n");
659 sema_init(&obd_conf_sem, 1);
660 INIT_LIST_HEAD(&obd_types);
662 if ((err = misc_register(&obd_psdev))) {
663 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
667 /* This struct is already zerod for us (static global) */
668 for (i = 0, obd = obd_dev; i < MAX_OBD_DEVICES; i++, obd++)
671 err = obd_init_caches();
678 static void __exit cleanup_obdclass(void)
683 misc_deregister(&obd_psdev);
684 for (i = 0; i < MAX_OBD_DEVICES; i++) {
685 struct obd_device *obd = &obd_dev[i];
686 if (obd->obd_type && (obd->obd_flags & OBD_SET_UP) &&
687 OBT(obd) && OBP(obd, detach)) {
688 /* XXX should this call generic detach otherwise? */
689 OBP(obd, detach)(obd);
693 obd_cleanup_caches();
695 CERROR("obd memory leaked: %ld bytes\n", obd_memory);
699 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
700 MODULE_DESCRIPTION("Lustre Class Driver v1.0");
701 MODULE_LICENSE("GPL");
703 module_init(init_obdclass);
704 module_exit(cleanup_obdclass);