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 = 0;
51 /* The following are visible and mutable through /proc/sys/lustre/. */
52 unsigned long obd_fail_loc = 0;
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)
170 l = snprintf(buf2, remains, "%2d %s %s %s %s\n",
171 i, status, obd->obd_type->typ_name,
172 obd->obd_name, obd->obd_uuid);
176 CERROR("not enough space for device listing\n");
181 err = copy_to_user((int *)arg, data, len);
186 case OBD_IOC_NAME2DEV: {
187 /* Resolve a device name. This does not change the
188 * currently selected device.
192 if (!data->ioc_inllen1 || !data->ioc_inlbuf1 ) {
193 CERROR("No name passed,!\n");
194 GOTO(out, err=-EINVAL);
196 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
197 CERROR("Name not nul terminated!\n");
198 GOTO(out, err=-EINVAL);
201 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
202 dev = class_name2dev(data->ioc_inlbuf1);
205 CDEBUG(D_IOCTL, "No device for name %s!\n",
207 GOTO(out, err=-EINVAL);
210 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
212 err = copy_to_user((int *)arg, data, sizeof(*data));
216 case OBD_IOC_UUID2DEV: {
217 /* Resolve a device uuid. This does not change the
218 * currently selected device.
222 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
223 CERROR("No UUID passed!\n");
224 GOTO(out, err=-EINVAL);
226 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
227 CERROR("Name not nul terminated!\n");
228 GOTO(out, err=-EINVAL);
231 CDEBUG(D_IOCTL, "device name %s\n", data->ioc_inlbuf1);
232 dev = class_uuid2dev(data->ioc_inlbuf1);
235 CDEBUG(D_IOCTL, "No device for name %s!\n",
237 GOTO(out, err=-EINVAL);
240 CDEBUG(D_IOCTL, "device name %s, dev %d\n", data->ioc_inlbuf1,
242 err = copy_to_user((int *)arg, data, sizeof(*data));
246 case OBD_IOC_NEWDEV: {
250 filp->private_data = NULL;
251 for (i = 0 ; i < MAX_OBD_DEVICES ; i++) {
252 struct obd_device *obd = &obd_dev[i];
253 if (!obd->obd_type) {
254 filp->private_data = obd;
263 GOTO(out, err=-EINVAL);
265 err = copy_to_user((int *)arg, data, sizeof(*data));
269 case OBD_IOC_ATTACH: {
270 struct obd_type *type;
272 /* have we attached a type to this device */
273 if (obd->obd_flags & OBD_ATTACHED) {
274 CERROR("OBD: Device %d already typed as %s.\n",
275 obd->obd_minor, MKSTR(obd->obd_type->typ_name));
276 GOTO(out, err=-EBUSY);
279 if (!data->ioc_inllen1 || !data->ioc_inlbuf1) {
280 CERROR("No type passed!\n");
281 GOTO(out, err=-EINVAL);
283 if (data->ioc_inlbuf1[data->ioc_inllen1-1] !=0) {
284 CERROR("Type not nul terminated!\n");
285 GOTO(out, err=-EINVAL);
288 CDEBUG(D_IOCTL, "attach type %s name: %s uuid: %s\n",
289 MKSTR(data->ioc_inlbuf1),
290 MKSTR(data->ioc_inlbuf2), MKSTR(data->ioc_inlbuf3));
293 type = class_nm_to_type(data->ioc_inlbuf1);
295 CERROR("OBD: unknown type dev %d\n", obd->obd_minor);
296 GOTO(out, err=-EINVAL);
299 obd->obd_type = type;
300 INIT_LIST_HEAD(&obd->obd_exports);
303 if (OBP(obd, attach))
304 err = OBP(obd,attach)(obd, sizeof(*data), data);
306 obd->obd_type = NULL;
308 obd->obd_flags |= OBD_ATTACHED;
310 CDEBUG(D_IOCTL, "OBD: dev %d attached type %s\n",
311 obd->obd_minor, data->ioc_inlbuf1);
312 if (data->ioc_inlbuf2) {
313 int len = strlen(data->ioc_inlbuf2) + 1;
314 OBD_ALLOC(obd->obd_name, len);
315 if (!obd->obd_name) {
316 CERROR("no memory\n");
319 memcpy(obd->obd_name, data->ioc_inlbuf2, len);
320 obd->obd_proc_entry =
321 proc_lustre_register_obd_device(obd);
323 CERROR("WARNING: unnamed obd device\n");
324 obd->obd_proc_entry = NULL;
327 if (data->ioc_inlbuf3) {
328 int len = strlen(data->ioc_inlbuf3);
330 CERROR("uuid should be shorter than 37 bytes\n");
332 OBD_FREE(obd->obd_name,
333 strlen(obd->obd_name) + 1);
334 GOTO(out, err=-EINVAL);
336 memcpy(obd->obd_uuid, data->ioc_inlbuf3,
337 sizeof(obd->obd_uuid));
346 case OBD_IOC_DETACH: {
348 if (obd->obd_flags & OBD_SET_UP) {
349 CERROR("OBD device %d still set up\n", obd->obd_minor);
350 GOTO(out, err=-EBUSY);
352 if (! (obd->obd_flags & OBD_ATTACHED) ) {
353 CERROR("OBD device %d not attached\n", obd->obd_minor);
354 GOTO(out, err=-ENODEV);
356 if ( !list_empty(&obd->obd_exports) ) {
357 CERROR("OBD device %d has exports\n",
359 GOTO(out, err=-EBUSY);
363 OBD_FREE(obd->obd_name, strlen(obd->obd_name)+1);
364 obd->obd_name = NULL;
367 if (obd->obd_proc_entry)
368 proc_lustre_release_obd_device(obd);
370 obd->obd_flags &= ~OBD_ATTACHED;
371 obd->obd_type->typ_refcnt--;
372 obd->obd_type = NULL;
377 case OBD_IOC_SETUP: {
378 /* have we attached a type to this device? */
379 if (!(obd->obd_flags & OBD_ATTACHED)) {
380 CERROR("Device %d not attached\n", obd->obd_minor);
381 GOTO(out, err=-ENODEV);
384 /* has this been done already? */
385 if ( obd->obd_flags & OBD_SET_UP ) {
386 CERROR("Device %d already setup (type %s)\n",
387 obd->obd_minor, obd->obd_type->typ_name);
388 GOTO(out, err=-EBUSY);
391 if ( OBT(obd) && OBP(obd, setup) )
392 err = obd_setup(obd, sizeof(*data), data);
395 obd->obd_type->typ_refcnt++;
396 obd->obd_flags |= OBD_SET_UP;
401 case OBD_IOC_CLEANUP: {
402 /* have we attached a type to this device? */
403 if (!(obd->obd_flags & OBD_ATTACHED)) {
404 CERROR("Device %d not attached\n", obd->obd_minor);
405 GOTO(out, err=-ENODEV);
408 if ( OBT(obd) && OBP(obd, cleanup) )
409 err = obd_cleanup(obd);
412 obd->obd_flags &= ~OBD_SET_UP;
413 obd->obd_type->typ_refcnt--;
418 case OBD_IOC_CONNECT: {
419 char * cluuid = "OBD_CLASS_UUID";
420 obd_data2conn(&conn, data);
422 err = obd_connect(&conn, obd, cluuid);
424 CDEBUG(D_IOCTL, "assigned export %Lx\n", conn.addr);
425 obd_conn2data(data, &conn);
429 err = copy_to_user((int *)arg, data, sizeof(*data));
433 case OBD_IOC_DISCONNECT: {
434 obd_data2conn(&conn, data);
435 err = obd_disconnect(&conn);
439 case OBD_IOC_DEC_USE_COUNT: {
444 case OBD_IOC_CREATE: {
445 struct lov_stripe_md *ea;
446 obd_data2conn(&conn, data);
449 err = obd_create(&conn, &data->ioc_obdo1, &ea);
453 err = copy_to_user((int *)arg, data, sizeof(*data));
457 case OBD_IOC_GETATTR: {
459 obd_data2conn(&conn, data);
460 err = obd_getattr(&conn, &data->ioc_obdo1, NULL);
464 err = copy_to_user((int *)arg, data, sizeof(*data));
468 case OBD_IOC_SETATTR: {
469 obd_data2conn(&conn, data);
470 err = obd_setattr(&conn, &data->ioc_obdo1, NULL);
474 err = copy_to_user((int *)arg, data, sizeof(*data));
478 case OBD_IOC_DESTROY: {
480 obd_data2conn(&conn, data);
482 err = obd_destroy(&conn, &data->ioc_obdo1, NULL);
486 err = copy_to_user((int *)arg, data, sizeof(*data));
490 case OBD_IOC_BRW_WRITE:
492 case OBD_IOC_BRW_READ: {
493 struct lov_stripe_md smd;
494 struct io_cb_data *cbd = ll_init_cb();
496 struct brw_page *pga, *pgp;
502 GOTO(out, err = -ENOMEM);
504 obd_data2conn(&conn, data);
506 pages = data->ioc_count / PAGE_SIZE;
508 CDEBUG(D_INODE, "BRW %s with %d pages\n",
509 rw == OBD_BRW_READ ? "read" : "write", pages);
510 OBD_ALLOC(pga, pages * sizeof(*pga));
512 CERROR("no memory for %d BRW per-page data\n", pages);
513 GOTO(brw_free, err = -ENOMEM);
516 memset(&smd, 0, sizeof(smd));
517 id = smd.lmd_object_id = data->ioc_obdo1.o_id;
519 off = data->ioc_offset;
521 for (j = 0, pgp = pga; j < pages; j++, off += PAGE_SIZE, pgp++){
522 pgp->pg = alloc_pages(GFP_KERNEL, 0);
524 CERROR("no memory for brw pages\n");
525 GOTO(brw_cleanup, err = -ENOMEM);
527 pgp->count = PAGE_SIZE;
531 if (rw == OBD_BRW_WRITE) {
532 page_debug_setup(kmap(pgp->pg), pgp->count,
538 err = obd_brw(rw, &conn, &smd, j, pga, ll_sync_io_cb, cbd);
541 for (j = 0, pgp = pga; j < pages; j++, pgp++) {
542 if (pgp->pg != NULL) {
544 void *addr = kmap(pgp->pg);
546 err2 = page_debug_check("test_brw", addr,
547 PAGE_SIZE, pgp->off,id);
549 __free_pages(pgp->pg, 0);
555 OBD_FREE(pga, pages * sizeof(*pga));
559 obd_data2conn(&conn, data);
561 err = obd_iocontrol(cmd, &conn, len, data, NULL);
565 err = copy_to_user((int *)arg, data, len);
575 } /* obd_class_ioctl */
579 /* declare character device */
580 static struct file_operations obd_psdev_fops = {
581 ioctl: obd_class_ioctl, /* ioctl */
582 open: obd_class_open, /* open */
583 release: obd_class_release, /* release */
587 #define OBD_MINOR 241
588 static struct miscdevice obd_psdev = {
594 void (*class_signal_client_failure)(struct ptlrpc_client *);
596 EXPORT_SYMBOL(obd_dev);
597 EXPORT_SYMBOL(obdo_cachep);
598 EXPORT_SYMBOL(obd_memory);
599 EXPORT_SYMBOL(obd_fail_loc);
600 EXPORT_SYMBOL(obd_timeout);
601 EXPORT_SYMBOL(obd_recovery_upcall);
603 EXPORT_SYMBOL(class_register_type);
604 EXPORT_SYMBOL(class_unregister_type);
605 EXPORT_SYMBOL(class_name2dev);
606 EXPORT_SYMBOL(class_uuid2dev);
607 EXPORT_SYMBOL(class_uuid2obd);
608 EXPORT_SYMBOL(class_new_export);
609 EXPORT_SYMBOL(class_connect);
610 EXPORT_SYMBOL(class_conn2export);
611 EXPORT_SYMBOL(class_rconn2export);
612 EXPORT_SYMBOL(class_conn2obd);
613 EXPORT_SYMBOL(class_disconnect);
614 EXPORT_SYMBOL(class_disconnect_all);
615 EXPORT_SYMBOL(class_uuid_parse);
616 EXPORT_SYMBOL(class_uuid_unparse);
617 //EXPORT_SYMBOL(class_multi_setup);
618 //EXPORT_SYMBOL(class_multi_cleanup);
620 EXPORT_SYMBOL(class_signal_client_failure);
622 static int __init init_obdclass(void)
627 printk(KERN_INFO "OBD class driver v0.9, info@clusterfs.com\n");
629 sema_init(&obd_conf_sem, 1);
630 INIT_LIST_HEAD(&obd_types);
632 if ((err = misc_register(&obd_psdev))) {
633 CERROR("cannot register %d err %d\n", OBD_MINOR, err);
637 for (i = 0; i < MAX_OBD_DEVICES; i++) {
638 memset(&(obd_dev[i]), 0, sizeof(obd_dev[i]));
639 obd_dev[i].obd_minor = i;
640 INIT_LIST_HEAD(&obd_dev[i].obd_exports);
643 err = obd_init_caches();
650 static void __exit cleanup_obdclass(void)
655 misc_deregister(&obd_psdev);
656 for (i = 0; i < MAX_OBD_DEVICES; i++) {
657 struct obd_device *obd = &obd_dev[i];
658 if (obd->obd_type && (obd->obd_flags & OBD_SET_UP) &&
659 OBT(obd) && OBP(obd, detach)) {
660 /* XXX should this call generic detach otherwise? */
661 OBP(obd, detach)(obd);
665 obd_cleanup_caches();
667 CERROR("obd memory leaked: %ld bytes\n", obd_memory);
671 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
672 MODULE_DESCRIPTION("Lustre Class Driver v1.0");
673 MODULE_LICENSE("GPL");
675 module_init(init_obdclass);
676 module_exit(cleanup_obdclass);