2 * An implementation of a loadable kernel mode driver providing
3 * multiple kernel/user space bidirectional communications links.
5 * Author: Alan Cox <alan@cymru.net>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
12 * Adapted to become the Linux 2.0 Coda pseudo device
13 * Peter Braam <braam@maths.ox.ac.uk>
14 * Michael Callahan <mjc@emmy.smith.edu>
16 * Changes for Linux 2.1
17 * Copyright (c) 1997 Carnegie-Mellon University
19 * Redone again for Intermezzo
20 * Copyright (c) 1998 Peter J. Braam
22 * Hacked up again for simulated OBD
23 * Copyright (c) 1999 Stelias Computing, Inc.
24 * (authors {pschwan,braam}@stelias.com)
25 * Copyright (C) 1999 Seagate Technology, Inc.
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/malloc.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>
45 #include <linux/vmalloc.h>
47 #include <linux/poll.h>
48 #include <linux/init.h>
49 #include <linux/list.h>
51 #include <asm/segment.h>
52 #include <asm/system.h>
54 #include <asm/uaccess.h>
56 #include <linux/obd_support.h>
57 #include <linux/obd_class.h>
59 static int obd_init_magic;
60 int obd_print_entry = 1;
61 int obd_debug_level = 4095;
62 struct obd_device obd_dev[MAX_OBD_DEVICES];
63 struct list_head obd_types;
65 /* called when opening /dev/obdNNN */
66 static int obd_class_open(struct inode * inode, struct file * file)
73 dev = MINOR(inode->i_rdev);
74 if (dev >= MAX_OBD_DEVICES)
76 obd_dev[dev].obd_refcnt++;
77 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
78 obd_dev[dev].obd_refcnt);
85 /* called when closing /dev/obdNNN */
86 static int obd_class_release(struct inode * inode, struct file * file)
93 dev = MINOR(inode->i_rdev);
94 if (dev >= MAX_OBD_DEVICES)
96 fsync_dev(inode->i_rdev);
97 if (obd_dev[dev].obd_refcnt <= 0)
98 printk(KERN_ALERT "obd_class_release: refcount(%d) <= 0\n",
99 obd_dev[dev].obd_refcnt);
100 obd_dev[dev].obd_refcnt--;
102 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
103 obd_dev[dev].obd_refcnt);
110 /* support function */
111 static struct obd_type *obd_nm_to_type(char *nm)
113 struct list_head *tmp;
114 struct obd_type *type;
115 CDEBUG(D_IOCTL, "SEARCH %s\n", nm);
118 while ( (tmp = tmp->next) != &obd_types ) {
119 type = list_entry(tmp, struct obd_type, typ_chain);
120 CDEBUG(D_IOCTL, "TYP %s\n", type->typ_name);
121 if (strlen(type->typ_name) == strlen(nm) &&
122 strcmp(type->typ_name, nm) == 0 ) {
130 static int getdata(int len, void **data)
137 CDEBUG(D_IOCTL, "getdata: len %d, add %p\n", len, *data);
139 OBD_ALLOC(tmp, void *, len);
144 if ( copy_from_user(tmp, *data, len)) {
153 /* to control /dev/obdNNN */
154 static int obd_class_ioctl (struct inode * inode, struct file * filp,
155 unsigned int cmd, unsigned long arg)
157 struct obd_device *obddev;
158 /* NOTE this must be larger than any of the ioctl data structs */
161 struct obd_conn conn;
163 long int cli_id; /* connect, disconnect */
168 dev = MINOR(inode->i_rdev);
169 if (dev > MAX_OBD_DEVICES)
171 obddev = &obd_dev[dev];
172 conn.oc_dev = obddev;
177 case OBD_IOC_ATTACH: {
178 struct obd_type *type;
179 struct oic_generic *input = karg;
182 /* have we attached a type to this device */
183 if ( obddev->obd_type ||
184 (obddev->obd_flags & OBD_ATTACHED) ){
186 "OBD Device %d already attached to type %s.\n",
187 dev, obddev->obd_type->typ_name);
193 /* get data structures */
194 err = copy_from_user(&input, (void *)arg, sizeof(input));
201 err = getdata(input->att_typelen + 1, &input->att_type);
209 type = obd_nm_to_type(input->att_type);
210 OBD_FREE(input->att_type, input->att_typelen + 1);
212 printk("Unknown obd type dev %d\n", dev);
216 obddev->obd_type = type;
218 /* get the attach data */
219 err = getdata(input->att_datalen, &input->att_data);
225 INIT_LIST_HEAD(&obddev->obd_gen_clients);
226 obddev->obd_multi_count = 0;
228 CDEBUG(D_IOCTL, "Attach %d, datalen %d, type %s\n",
229 dev, input->att_datalen, obddev->obd_type->typ_name);
230 /* maybe we are done */
231 if ( !OBT(obddev) || !OBP(obddev, attach) ) {
232 obddev->obd_flags |= OBD_ATTACHED;
234 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
242 err = OBP(obddev, attach)(obddev, input->att_datalen,
244 OBD_FREE(input->att_data, input->att_datalen);
247 obddev->obd_flags &= ~OBD_ATTACHED;
248 obddev->obd_type = NULL;
251 obddev->obd_flags |= OBD_ATTACHED;
253 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
261 case OBD_IOC_DETACH: {
264 if (obddev->obd_flags & OBD_SET_UP) {
268 if (! (obddev->obd_flags & OBD_ATTACHED) ) {
269 CDEBUG(D_IOCTL, "Device not attached\n");
273 if ( !list_empty(&obddev->obd_gen_clients) ) {
274 CDEBUG(D_IOCTL, "Device has connected clients\n");
279 CDEBUG(D_IOCTL, "Detach %d, type %s\n", dev,
280 obddev->obd_type->typ_name);
281 obddev->obd_flags &= ~OBD_ATTACHED;
282 obddev->obd_type->typ_refcnt--;
283 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
284 obddev->obd_type->typ_refcnt);
285 obddev->obd_type = NULL;
291 case OBD_IOC_SETUP: {
299 /* have we attached a type to this device */
300 if (!(obddev->obd_flags & OBD_ATTACHED)) {
301 CDEBUG(D_IOCTL, "Device not attached\n");
306 /* has this been done already? */
307 if ( obddev->obd_flags & OBD_SET_UP ) {
308 CDEBUG(D_IOCTL, "Device %d already setup (type %s)\n",
309 dev, obddev->obd_type->typ_name);
314 /* get main structure */
315 err = copy_from_user(&input, (void *) arg, sizeof(input));
321 err = getdata(input->setup_datalen, &input->setup_data);
328 CDEBUG(D_IOCTL, "Setup %d, type %s\n", dev,
329 obddev->obd_type->typ_name);
330 if ( !OBT(obddev) || !OBP(obddev, setup) ) {
331 obddev->obd_type->typ_refcnt++;
332 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n",
333 dev, obddev->obd_type->typ_refcnt);
334 obddev->obd_flags |= OBD_SET_UP;
339 err = OBP(obddev, setup)(obddev, input->setup_datalen,
343 obddev->obd_flags &= ~OBD_SET_UP;
346 obddev->obd_type->typ_refcnt++;
347 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n",
348 dev, obddev->obd_type->typ_refcnt);
349 obddev->obd_flags |= OBD_SET_UP;
354 case OBD_IOC_CLEANUP: {
356 /* has this minor been registered? */
357 if (!obddev->obd_type) {
358 CDEBUG(D_IOCTL, "OBD Device %d has no type.\n", dev);
363 if ( !obddev->obd_type->typ_refcnt ) {
364 printk("OBD_CLEANUP: Dev %d has refcount (%d)!\n",
365 dev, obddev->obd_type->typ_refcnt);
370 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
371 (!(obddev->obd_flags & OBD_ATTACHED))) {
372 CDEBUG(D_IOCTL, "Device not attached or set up\n");
377 if ( !OBT(obddev) || !OBP(obddev, cleanup) )
380 /* cleanup has no argument */
381 err = OBP(obddev, cleanup)(obddev);
388 obddev->obd_flags &= ~OBD_SET_UP;
389 obddev->obd_type->typ_refcnt--;
390 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
391 obddev->obd_type->typ_refcnt);
395 case OBD_IOC_CONNECT:
397 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
398 (!(obddev->obd_flags & OBD_ATTACHED))) {
399 CDEBUG(D_IOCTL, "Device not attached or set up\n");
403 if ( !OBT(obddev) || !OBP(obddev, connect) )
406 err = OBP(obddev, connect)(&conn);
410 return copy_to_user((int *)arg, &conn.oc_id,
413 case OBD_IOC_DISCONNECT:
414 /* frees data structures */
415 /* has this minor been registered? */
416 if (!obddev->obd_type)
419 get_user(cli_id, (int *) arg);
422 if ( !OBT(obddev) || !OBP(obddev, disconnect))
425 OBP(obddev, disconnect)(&conn);
428 /* XXX sync needs to be done */
430 struct oic_range_s *foo = karg;
432 if (!obddev->obd_type)
435 err = copy_from_user(&foo, (const void *)arg, sizeof(foo));
441 return put_user(err, (int *) arg);
443 case OBD_IOC_CREATE: {
444 struct oic_attr_s *foo = karg;
446 err = copy_from_user(&foo, (const void *)arg, sizeof(foo));
452 /* has this minor been registered? */
453 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
454 !(obddev->obd_flags & OBD_SET_UP)) {
455 CDEBUG(D_IOCTL, "Device not attached or set up\n");
458 conn.oc_id = foo->conn_id;
460 if ( !OBT(obddev) || !OBP(obddev, create) )
463 err = OBP(obddev, create)(&conn, &foo->obdo);
469 err = copy_to_user((int *)arg, &foo, sizeof(foo));
474 case OBD_IOC_DESTROY: {
475 struct oic_attr_s *foo = karg;
477 /* has this minor been registered? */
478 if (!obddev->obd_type)
481 err = copy_from_user(&foo, (int *)arg, sizeof(*foo));
487 if ( !OBT(obddev) || !OBP(obddev, destroy) )
490 conn.oc_id = foo->conn_id;
491 err = OBP(obddev, destroy)(&conn, &foo->obdo);
496 case OBD_IOC_SETATTR: {
497 struct oic_attr_s *foo = karg;
499 /* has this minor been registered? */
500 if (!obddev->obd_type)
503 err = copy_from_user(&foo, (int *)arg, sizeof(foo));
507 if ( !OBT(obddev) || !OBP(obddev, setattr) )
510 conn.oc_id = foo->conn_id;
511 err = OBP(obddev, setattr)(&conn, &foo->obdo);
516 case OBD_IOC_GETATTR: {
517 struct oic_attr_s *foo = karg;
519 err = copy_from_user(&foo, (int *)arg, sizeof(foo));
523 conn.oc_id = foo->conn_id;
524 err = OBP(obddev, getattr)(&conn, &foo->obdo);
530 err = copy_to_user((int *)arg, &foo, sizeof(foo));
537 struct oic_rw_s *rw_s = karg; /* read, write ioctl str */
539 err = copy_from_user(&rw_s, (int *)arg, sizeof(rw_s));
545 conn.oc_id = rw_s->conn_id;
547 if ( !OBT(obddev) || !OBP(obddev, read) ) {
553 err = OBP(obddev, read)(&conn, &rw_s->obdo, rw_s->buf,
554 &rw_s->count, rw_s->offset);
560 err = copy_to_user((int*)arg, &rw_s->count, sizeof(rw_s->count));
565 case OBD_IOC_WRITE: {
566 struct oic_rw_s *rw_s = karg; /* read, write ioctl str */
568 err = copy_from_user(&rw_s, (int *)arg, sizeof(rw_s));
574 conn.oc_id = rw_s->conn_id;
576 if ( !OBT(obddev) || !OBP(obddev, write) ) {
581 err = OBP(obddev, write)(&conn, &rw_s->obdo, rw_s->buf,
582 &rw_s->count, rw_s->offset);
588 err = copy_to_user((int*)arg, &rw_s->count, sizeof(rw_s->count));
592 case OBD_IOC_PREALLOCATE: {
593 struct oic_prealloc_s *prealloc = karg;
595 /* has this minor been registered? */
596 if (!obddev->obd_type)
599 err = copy_from_user(&prealloc, (int *)arg, sizeof(prealloc));
603 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
604 !(obddev->obd_flags & OBD_SET_UP)) {
605 CDEBUG(D_IOCTL, "Device not attached or set up\n");
609 if ( !OBT(obddev) || !OBP(obddev, preallocate) )
612 conn.oc_id = prealloc->cli_id;
613 err = OBP(obddev, preallocate)(&conn, &prealloc->alloc,
620 err =copy_to_user((int *)arg, &prealloc, sizeof(prealloc));
624 case OBD_IOC_STATFS: {
626 unsigned int conn_id;
629 /* has this minor been registered? */
630 if (!obddev->obd_type)
633 tmp = (void *)arg + sizeof(unsigned int);
634 get_user(conn_id, (int *) arg);
636 if ( !OBT(obddev) || !OBP(obddev, statfs) )
639 conn.oc_id = conn_id;
640 err = OBP(obddev, statfs)(&conn, &buf);
645 err = copy_to_user(tmp, &buf, sizeof(buf));
651 struct ioc_mv_s *mvdata = karg;
653 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
654 (!(obddev->obd_flags & OBD_ATTACHED))) {
655 CDEBUG(D_IOCTL, "Device not attached or set up\n");
659 /* get main structure */
660 err = copy_from_user(&mvdata, (void *) arg, sizeof(*mvdata));
666 if ( !OBT(obddev) || !OBP(obddev, copy) )
669 /* do the partition */
670 CDEBUG(D_IOCTL, "Copy %d, type %s dst %Ld src %Ld\n", dev,
671 obddev->obd_type->typ_name, mvdata->dst.o_id,
674 conn.oc_id = mvdata->src_conn_id;
676 err = OBP(obddev, copy)(&conn, &mvdata->dst,
678 mvdata->src.o_size, 0);
683 struct ioc_mv_s *mvdata = karg;
685 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
686 (!(obddev->obd_flags & OBD_ATTACHED))) {
687 CDEBUG(D_IOCTL, "Device not attached or set up\n");
691 err = copy_from_user(&mvdata, (void *) arg, sizeof(*mvdata));
697 CDEBUG(D_IOCTL, "Migrate copying %d\n", sizeof(mvdata));
699 if ( !OBT(obddev) || !OBP(obddev, migrate) )
702 /* do the partition */
703 CDEBUG(D_IOCTL, "Migrate %d, type %s conn %d src %Ld dst %Ld\n",
704 dev, obddev->obd_type->typ_name, mvdata->src_conn_id,
705 mvdata->src.o_id, mvdata->dst.o_id);
707 conn.oc_id = mvdata->src_conn_id;
708 err = OBP(obddev, migrate)(&conn, &mvdata->dst, &mvdata->src,
709 mvdata->dst.o_size, 0);
715 struct obd_type *type;
716 struct oic_generic input;
719 /* get data structures */
720 err = copy_from_user(&input, (void *)arg, sizeof(input));
726 err = getdata(input.att_typelen + 1, &input.att_type);
733 type = obd_nm_to_type(input.att_type);
734 OBD_FREE(input.att_type, input.att_typelen + 1);
736 printk("Unknown obd type dev %d\n", dev);
741 if ( !type->typ_ops || !type->typ_ops->o_iocontrol ) {
745 conn.oc_id = input.att_connid;
747 CDEBUG(D_IOCTL, "Calling ioctl %x for type %s, len %d\n",
748 cmd, type->typ_name, input.att_datalen);
750 /* get the generic data */
751 karg = input.att_data;
752 err = getdata(input.att_datalen, karg);
758 err = type->typ_ops->o_iocontrol(cmd, &conn, input.att_datalen,
759 karg, input.att_data);
760 OBD_FREE(karg, input.att_datalen);
768 /* Driver interface done, utility functions follow */
770 int obd_register_type(struct obd_ops *ops, char *nm)
772 struct obd_type *type;
775 if (obd_init_magic != 0x11223344) {
780 if ( obd_nm_to_type(nm) ) {
781 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
786 OBD_ALLOC(type, struct obd_type * , sizeof(*type));
791 memset(type, 0, sizeof(*type));
792 INIT_LIST_HEAD(&type->typ_chain);
794 list_add(&type->typ_chain, obd_types.next);
801 int obd_unregister_type(char *nm)
803 struct obd_type *type = obd_nm_to_type(nm);
807 printk("Unknown obd type\n");
812 if ( type->typ_refcnt ) {
814 printk("OBD: Type %s has refcount (%d)\n", nm,
820 list_del(&type->typ_chain);
821 OBD_FREE(type, sizeof(*type));
826 /* declare character device */
827 static struct file_operations obd_psdev_fops = {
831 NULL, /* presto_psdev_readdir */
833 obd_class_ioctl, /* ioctl */
834 NULL, /* presto_psdev_mmap */
835 obd_class_open, /* open */
837 obd_class_release, /* release */
840 NULL, /* check_media_change */
841 NULL, /* revalidate */
852 printk(KERN_INFO "OBD class driver v0.01, braam@stelias.com\n");
854 INIT_LIST_HEAD(&obd_types);
856 if (register_chrdev(OBD_PSDEV_MAJOR,"obd_psdev",
858 printk(KERN_ERR "obd_psdev: unable to get major %d\n",
863 for (i = 0; i < MAX_OBD_DEVICES; i++) {
864 memset(&(obd_dev[i]), 0, sizeof(obd_dev[i]));
865 obd_dev[i].obd_minor = i;
866 INIT_LIST_HEAD(&obd_dev[i].obd_gen_clients);
869 obd_init_obdo_cache();
871 obd_init_magic = 0x11223344;
875 EXPORT_SYMBOL(obd_register_type);
876 EXPORT_SYMBOL(obd_unregister_type);
878 EXPORT_SYMBOL(obd_print_entry);
879 EXPORT_SYMBOL(obd_debug_level);
880 EXPORT_SYMBOL(obd_dev);
882 EXPORT_SYMBOL(gen_connect);
883 EXPORT_SYMBOL(gen_client);
884 EXPORT_SYMBOL(gen_cleanup);
885 EXPORT_SYMBOL(gen_disconnect);
886 EXPORT_SYMBOL(gen_copy_data);
887 EXPORT_SYMBOL(obdo_cachep);
889 /* EXPORT_SYMBOL(gen_multi_attach); */
890 EXPORT_SYMBOL(gen_multi_setup);
891 EXPORT_SYMBOL(gen_multi_cleanup);
895 int init_module(void)
900 void cleanup_module(void)
905 unregister_chrdev(OBD_PSDEV_MAJOR, "obd_psdev");
906 for (i = 0; i < MAX_OBD_DEVICES; i++) {
907 struct obd_device *obddev = &obd_dev[i];
908 if ( obddev->obd_type &&
909 (obddev->obd_flags & OBD_SET_UP) &&
910 OBT(obddev) && OBP(obddev, detach) ) {
911 /* XXX should this call generic detach otherwise? */
912 OBP(obddev, detach)(obddev);