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 __FUNCTION__ ": 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 = tmp_buf;
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);
192 /* get data structures */
193 err = copy_from_user(input, (void *)arg, sizeof(*input));
199 err = getdata(input->att_typelen + 1, &input->att_type);
206 type = obd_nm_to_type(input->att_type);
207 OBD_FREE(input->att_type, input->att_typelen + 1);
209 printk(__FUNCTION__ ": unknown obd type dev %d\n",
214 obddev->obd_type = type;
216 /* get the attach data */
217 err = getdata(input->att_datalen, &input->att_data);
223 INIT_LIST_HEAD(&obddev->obd_gen_clients);
224 obddev->obd_multi_count = 0;
226 CDEBUG(D_IOCTL, "Attach %d, datalen %d, type %s\n",
227 dev, input->att_datalen, obddev->obd_type->typ_name);
228 /* maybe we are done */
229 if ( !OBT(obddev) || !OBP(obddev, attach) ) {
230 obddev->obd_flags |= OBD_ATTACHED;
232 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
240 err = OBP(obddev, attach)(obddev, input->att_datalen,
242 OBD_FREE(input->att_data, input->att_datalen);
245 obddev->obd_flags &= ~OBD_ATTACHED;
246 obddev->obd_type = NULL;
249 obddev->obd_flags |= OBD_ATTACHED;
251 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
259 case OBD_IOC_DETACH: {
262 if (obddev->obd_flags & OBD_SET_UP) {
266 if (! (obddev->obd_flags & OBD_ATTACHED) ) {
267 CDEBUG(D_IOCTL, "Device not attached\n");
271 if ( !list_empty(&obddev->obd_gen_clients) ) {
272 CDEBUG(D_IOCTL, "Device has connected clients\n");
277 CDEBUG(D_IOCTL, "Detach %d, type %s\n", dev,
278 obddev->obd_type->typ_name);
279 obddev->obd_flags &= ~OBD_ATTACHED;
280 obddev->obd_type->typ_refcnt--;
281 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
282 obddev->obd_type->typ_refcnt);
283 obddev->obd_type = NULL;
289 case OBD_IOC_SETUP: {
297 /* have we attached a type to this device */
298 if (!(obddev->obd_flags & OBD_ATTACHED)) {
299 CDEBUG(D_IOCTL, "Device not attached\n");
304 /* has this been done already? */
305 if ( obddev->obd_flags & OBD_SET_UP ) {
306 CDEBUG(D_IOCTL, "Device %d already setup (type %s)\n",
307 dev, obddev->obd_type->typ_name);
312 /* get main structure */
313 err = copy_from_user(setup, (void *) arg, sizeof(*setup));
319 err = getdata(setup->setup_datalen, &setup->setup_data);
326 CDEBUG(D_IOCTL, "Setup %d, type %s\n", dev,
327 obddev->obd_type->typ_name);
328 if ( !OBT(obddev) || !OBP(obddev, setup) ) {
329 obddev->obd_type->typ_refcnt++;
330 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n",
331 dev, obddev->obd_type->typ_refcnt);
332 obddev->obd_flags |= OBD_SET_UP;
337 err = OBP(obddev, setup)(obddev, setup->setup_datalen,
341 obddev->obd_flags &= ~OBD_SET_UP;
344 obddev->obd_type->typ_refcnt++;
345 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n",
346 dev, obddev->obd_type->typ_refcnt);
347 obddev->obd_flags |= OBD_SET_UP;
352 case OBD_IOC_CLEANUP: {
354 /* has this minor been registered? */
355 if (!obddev->obd_type) {
356 CDEBUG(D_IOCTL, "OBD Device %d has no type.\n", dev);
361 if ( !obddev->obd_type->typ_refcnt ) {
362 CDEBUG(D_IOCTL, "dev %d has refcount (%d)!\n",
363 dev, obddev->obd_type->typ_refcnt);
368 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
369 (!(obddev->obd_flags & OBD_ATTACHED))) {
370 CDEBUG(D_IOCTL, "device not attached or set up\n");
375 if ( !OBT(obddev) || !OBP(obddev, cleanup) )
378 /* cleanup has no argument */
379 err = OBP(obddev, cleanup)(obddev);
386 obddev->obd_flags &= ~OBD_SET_UP;
387 obddev->obd_type->typ_refcnt--;
388 CDEBUG(D_IOCTL, "Dev %d refcount now %d\n", dev,
389 obddev->obd_type->typ_refcnt);
393 case OBD_IOC_CONNECT:
395 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
396 (!(obddev->obd_flags & OBD_ATTACHED))) {
397 CDEBUG(D_IOCTL, "Device not attached or set up\n");
401 if ( !OBT(obddev) || !OBP(obddev, connect) )
404 err = OBP(obddev, connect)(&conn);
408 return copy_to_user((int *)arg, &conn.oc_id,
411 case OBD_IOC_DISCONNECT:
412 /* frees data structures */
413 /* has this minor been registered? */
414 if (!obddev->obd_type)
417 get_user(cli_id, (int *) arg);
420 if ( !OBT(obddev) || !OBP(obddev, disconnect))
423 OBP(obddev, disconnect)(&conn);
427 struct oic_range_s *range = tmp_buf;
429 if (!obddev->obd_type)
432 err = copy_from_user(range, (const void *)arg, sizeof(*range));
439 if ( !OBT(obddev) || !OBP(obddev, sync) ) {
445 /* XXX sync needs to be tested/verified */
446 err = OBP(obddev, sync)(&conn, &range->obdo, range->count,
454 return put_user(err, (int *) arg);
456 case OBD_IOC_CREATE: {
457 struct oic_attr_s *attr = tmp_buf;
459 err = copy_from_user(attr, (const void *)arg, sizeof(*attr));
465 /* has this minor been registered? */
466 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
467 !(obddev->obd_flags & OBD_SET_UP)) {
468 CDEBUG(D_IOCTL, "Device not attached or set up\n");
471 conn.oc_id = attr->conn_id;
473 if ( !OBT(obddev) || !OBP(obddev, create) )
476 err = OBP(obddev, create)(&conn, &attr->obdo);
482 err = copy_to_user((int *)arg, attr, sizeof(*attr));
487 case OBD_IOC_DESTROY: {
488 struct oic_attr_s *attr = tmp_buf;
490 /* has this minor been registered? */
491 if (!obddev->obd_type)
494 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
500 if ( !OBT(obddev) || !OBP(obddev, destroy) )
503 conn.oc_id = attr->conn_id;
504 err = OBP(obddev, destroy)(&conn, &attr->obdo);
509 case OBD_IOC_SETATTR: {
510 struct oic_attr_s *attr = tmp_buf;
512 /* has this minor been registered? */
513 if (!obddev->obd_type)
516 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
520 if ( !OBT(obddev) || !OBP(obddev, setattr) )
523 conn.oc_id = attr->conn_id;
524 err = OBP(obddev, setattr)(&conn, &attr->obdo);
529 case OBD_IOC_GETATTR: {
530 struct oic_attr_s *attr = tmp_buf;
532 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
536 conn.oc_id = attr->conn_id;
538 err = OBP(obddev, getattr)(&conn, &attr->obdo);
544 err = copy_to_user((int *)arg, attr, sizeof(*attr));
551 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
553 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
559 conn.oc_id = rw_s->conn_id;
561 if ( !OBT(obddev) || !OBP(obddev, read) ) {
568 err = OBP(obddev, read)(&conn, &rw_s->obdo, rw_s->buf,
569 &rw_s->count, rw_s->offset);
572 CDEBUG(D_INODE, "READ: conn %d, count %Ld, offset %Ld, '%s'\n",
573 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
579 err = copy_to_user((int*)arg, &rw_s->count, sizeof(rw_s->count));
584 case OBD_IOC_WRITE: {
585 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
587 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
593 conn.oc_id = rw_s->conn_id;
595 if ( !OBT(obddev) || !OBP(obddev, write) ) {
600 CDEBUG(D_INODE, "WRITE: conn %d, count %Ld, offset %Ld, '%s'\n",
601 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
602 err = OBP(obddev, write)(&conn, &rw_s->obdo, rw_s->buf,
603 &rw_s->count, rw_s->offset);
610 err = copy_to_user((int *)arg, &rw_s->count,
611 sizeof(rw_s->count));
615 case OBD_IOC_PREALLOCATE: {
616 struct oic_prealloc_s *prealloc = tmp_buf;
618 /* has this minor been registered? */
619 if (!obddev->obd_type)
622 err = copy_from_user(prealloc, (int *)arg, sizeof(*prealloc));
626 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
627 !(obddev->obd_flags & OBD_SET_UP)) {
628 CDEBUG(D_IOCTL, "Device not attached or set up\n");
632 if ( !OBT(obddev) || !OBP(obddev, preallocate) )
635 conn.oc_id = prealloc->conn_id;
636 err = OBP(obddev, preallocate)(&conn, &prealloc->alloc,
643 err =copy_to_user((int *)arg, prealloc, sizeof(*prealloc));
647 case OBD_IOC_STATFS: {
649 unsigned int conn_id;
652 /* has this minor been registered? */
653 if (!obddev->obd_type)
656 tmp = (void *)arg + sizeof(unsigned int);
657 get_user(conn_id, (int *) arg);
659 if ( !OBT(obddev) || !OBP(obddev, statfs) )
662 conn.oc_id = conn_id;
663 err = OBP(obddev, statfs)(&conn, &buf);
668 err = copy_to_user(tmp, &buf, sizeof(buf));
674 struct ioc_mv_s *mvdata = tmp_buf;
676 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
677 (!(obddev->obd_flags & OBD_ATTACHED))) {
678 CDEBUG(D_IOCTL, "Device not attached or set up\n");
682 /* get main structure */
683 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
689 if ( !OBT(obddev) || !OBP(obddev, copy) )
692 /* do the partition */
693 CDEBUG(D_IOCTL, "Copy %d, type %s dst %Ld src %Ld\n", dev,
694 obddev->obd_type->typ_name, mvdata->dst.o_id,
697 conn.oc_id = mvdata->src_conn_id;
699 err = OBP(obddev, copy)(&conn, &mvdata->dst,
701 mvdata->src.o_size, 0);
706 struct ioc_mv_s *mvdata = tmp_buf;
708 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
709 (!(obddev->obd_flags & OBD_ATTACHED))) {
710 CDEBUG(D_IOCTL, "Device not attached or set up\n");
714 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
720 CDEBUG(D_IOCTL, "Migrate copying %d bytes\n", sizeof(*mvdata));
722 if ( !OBT(obddev) || !OBP(obddev, migrate) )
725 /* do the partition */
726 CDEBUG(D_IOCTL, "Migrate %d, type %s conn %d src %Ld dst %Ld\n",
727 dev, obddev->obd_type->typ_name, mvdata->src_conn_id,
728 mvdata->src.o_id, mvdata->dst.o_id);
730 conn.oc_id = mvdata->src_conn_id;
731 err = OBP(obddev, migrate)(&conn, &mvdata->dst, &mvdata->src,
732 mvdata->src.o_size, 0);
738 struct obd_type *type;
739 struct oic_generic input;
742 /* get data structures */
743 err = copy_from_user(&input, (void *)arg, sizeof(input));
749 err = getdata(input.att_typelen + 1, &input.att_type);
756 type = obd_nm_to_type(input.att_type);
757 OBD_FREE(input.att_type, input.att_typelen + 1);
759 printk(__FUNCTION__ ": unknown obd type dev %d\n", dev);
764 if ( !type->typ_ops || !type->typ_ops->o_iocontrol ) {
768 conn.oc_id = input.att_connid;
770 CDEBUG(D_IOCTL, "Calling ioctl %x for type %s, len %d\n",
771 cmd, type->typ_name, input.att_datalen);
773 /* get the generic data */
774 karg = input.att_data;
775 err = getdata(input.att_datalen, &karg);
781 err = type->typ_ops->o_iocontrol(cmd, &conn, input.att_datalen,
782 karg, input.att_data);
783 OBD_FREE(karg, input.att_datalen);
789 } /* obd_class_ioctl */
791 /* Driver interface done, utility functions follow */
793 int obd_register_type(struct obd_ops *ops, char *nm)
795 struct obd_type *type;
798 if (obd_init_magic != 0x11223344) {
803 if ( obd_nm_to_type(nm) ) {
804 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
809 OBD_ALLOC(type, struct obd_type * , sizeof(*type));
814 memset(type, 0, sizeof(*type));
815 INIT_LIST_HEAD(&type->typ_chain);
817 list_add(&type->typ_chain, obd_types.next);
824 int obd_unregister_type(char *nm)
826 struct obd_type *type = obd_nm_to_type(nm);
830 printk(KERN_INFO __FUNCTION__ ": unknown obd type\n");
835 if ( type->typ_refcnt ) {
837 printk(KERN_ALERT __FUNCTION__ ":type %s has refcount "
838 "(%d)\n", nm, type->typ_refcnt);
843 list_del(&type->typ_chain);
844 OBD_FREE(type, sizeof(*type));
847 } /* obd_unregister_type */
849 /* declare character device */
850 static struct file_operations obd_psdev_fops = {
854 NULL, /* presto_psdev_readdir */
856 obd_class_ioctl, /* ioctl */
857 NULL, /* presto_psdev_mmap */
858 obd_class_open, /* open */
860 obd_class_release, /* release */
863 NULL, /* check_media_change */
864 NULL, /* revalidate */
876 printk(KERN_INFO "OBD class driver v0.01, braam@stelias.com\n");
878 INIT_LIST_HEAD(&obd_types);
880 if (register_chrdev(OBD_PSDEV_MAJOR,"obd_psdev",
882 printk(KERN_ERR __FUNCTION__ ": unable to get major %d\n",
887 for (i = 0; i < MAX_OBD_DEVICES; i++) {
888 memset(&(obd_dev[i]), 0, sizeof(obd_dev[i]));
889 obd_dev[i].obd_minor = i;
890 INIT_LIST_HEAD(&obd_dev[i].obd_gen_clients);
893 err = obd_init_obdo_cache();
897 obd_init_magic = 0x11223344;
901 EXPORT_SYMBOL(obd_register_type);
902 EXPORT_SYMBOL(obd_unregister_type);
904 EXPORT_SYMBOL(obd_print_entry);
905 EXPORT_SYMBOL(obd_debug_level);
906 EXPORT_SYMBOL(obd_dev);
908 EXPORT_SYMBOL(gen_connect);
909 EXPORT_SYMBOL(gen_client);
910 EXPORT_SYMBOL(gen_cleanup);
911 EXPORT_SYMBOL(gen_disconnect);
912 EXPORT_SYMBOL(gen_copy_data);
913 EXPORT_SYMBOL(obdo_cachep);
915 /* EXPORT_SYMBOL(gen_multi_attach); */
916 EXPORT_SYMBOL(gen_multi_setup);
917 EXPORT_SYMBOL(gen_multi_cleanup);
921 int init_module(void)
926 void cleanup_module(void)
931 unregister_chrdev(OBD_PSDEV_MAJOR, "obd_psdev");
932 for (i = 0; i < MAX_OBD_DEVICES; i++) {
933 struct obd_device *obddev = &obd_dev[i];
934 if ( obddev->obd_type &&
935 (obddev->obd_flags & OBD_SET_UP) &&
936 OBT(obddev) && OBP(obddev, detach) ) {
937 /* XXX should this call generic detach otherwise? */
938 OBP(obddev, detach)(obddev);
942 obd_cleanup_obdo_cache();