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/kmod.h> /* for request_module() */
38 #include <linux/sched.h>
40 #include <linux/slab.h>
41 #include <linux/ioport.h>
42 #include <linux/fcntl.h>
43 #include <linux/delay.h>
44 #include <linux/skbuff.h>
45 #include <linux/proc_fs.h>
46 #include <linux/vmalloc.h>
48 #include <linux/poll.h>
49 #include <linux/init.h>
50 #include <linux/list.h>
52 #include <asm/segment.h>
53 #include <asm/system.h>
55 #include <asm/uaccess.h>
57 #include <linux/obd_support.h>
58 #include <linux/obd_class.h>
60 static int obd_init_magic;
61 int obd_print_entry = 1;
62 int obd_debug_level = ~0;
64 struct obd_device obd_dev[MAX_OBD_DEVICES];
65 struct list_head obd_types;
67 /* called when opening /dev/obdNNN */
68 static int obd_class_open(struct inode * inode, struct file * file)
75 dev = MINOR(inode->i_rdev);
76 if (dev >= MAX_OBD_DEVICES)
78 obd_dev[dev].obd_refcnt++;
79 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
80 obd_dev[dev].obd_refcnt);
82 obd_dev[dev].obd_proc_entry =
83 proc_lustre_register_obd_device(&obd_dev[dev]);
90 /* called when closing /dev/obdNNN */
91 static int obd_class_release(struct inode * inode, struct file * file)
98 dev = MINOR(inode->i_rdev);
99 if (dev >= MAX_OBD_DEVICES)
101 fsync_dev(inode->i_rdev);
102 if (obd_dev[dev].obd_refcnt <= 0)
103 printk(KERN_ALERT __FUNCTION__ ": refcount(%d) <= 0\n",
104 obd_dev[dev].obd_refcnt);
105 obd_dev[dev].obd_refcnt--;
107 if (obd_dev[dev].obd_proc_entry && (obd_dev[dev].obd_refcnt==0))
108 proc_lustre_release_obd_device(&obd_dev[dev]);
110 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
111 obd_dev[dev].obd_refcnt);
118 /* support function */
119 static struct obd_type *obd_nm_to_type(char *nm)
121 struct list_head *tmp;
122 struct obd_type *type;
123 CDEBUG(D_INFO, "SEARCH %s\n", nm);
126 while ( (tmp = tmp->next) != &obd_types ) {
127 type = list_entry(tmp, struct obd_type, typ_chain);
128 CDEBUG(D_INFO, "TYP %s\n", type->typ_name);
129 if (strlen(type->typ_name) == strlen(nm) &&
130 strcmp(type->typ_name, nm) == 0 ) {
138 static int getdata(int len, void **data)
147 CDEBUG(D_MALLOC, "len %d, add %p\n", len, *data);
149 OBD_ALLOC(tmp, void *, len);
154 if ( copy_from_user(tmp, *data, len)) {
164 static int obd_devicename_from_path(obd_devicename* whoami,
170 err = user_path_walk(user_string, &nd);
172 whoami->dentry = nd.dentry;
178 /* to control /dev/obdNNN */
179 static int obd_class_ioctl (struct inode * inode, struct file * filp,
180 unsigned int cmd, unsigned long arg)
182 struct obd_device *obddev;
183 /* NOTE this must be larger than any of the ioctl data structs */
186 struct obd_conn conn;
188 long int cli_id; /* connect, disconnect */
191 CDEBUG(D_IOCTL, "invalid inode\n");
195 dev = MINOR(inode->i_rdev);
196 if (dev > MAX_OBD_DEVICES)
198 obddev = &obd_dev[dev];
199 conn.oc_dev = obddev;
204 case OBD_IOC_ATTACH: {
205 struct obd_type *type;
206 struct oic_generic *input = tmp_buf;
210 /* have we attached a type to this device */
211 if ( obddev->obd_type ||
212 (obddev->obd_flags & OBD_ATTACHED) ){
214 "OBD Device %d already attached to type %s.\n",
215 dev, obddev->obd_type->typ_name);
220 /* get data structures */
221 err = copy_from_user(input, (void *)arg, sizeof(*input));
227 err = getdata(input->att_typelen + 1, &input->att_type);
234 nm = input->att_type;
235 type = obd_nm_to_type(nm);
238 if ( !request_module(nm) ) {
239 CDEBUG(D_PSDEV, "Loaded module '%s'\n", nm);
240 type = obd_nm_to_type(nm);
242 CDEBUG(D_PSDEV, "Can't load module '%s'\n", nm);
247 OBD_FREE(input->att_type, input->att_typelen + 1);
249 printk(__FUNCTION__ ": unknown obd type dev %d\n",
254 obddev->obd_type = type;
256 /* get the attach data */
257 err = getdata(input->att_datalen, &input->att_data);
263 INIT_LIST_HEAD(&obddev->obd_gen_clients);
264 obddev->obd_multi_count = 0;
266 CDEBUG(D_IOCTL, "Attach %d, datalen %d, type %s\n",
267 dev, input->att_datalen, obddev->obd_type->typ_name);
268 /* maybe we are done */
269 if ( !OBT(obddev) || !OBP(obddev, attach) ) {
270 obddev->obd_flags |= OBD_ATTACHED;
272 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
275 OBD_FREE(input->att_data, input->att_datalen);
282 err = OBP(obddev, attach)(obddev, input->att_datalen,
285 OBD_FREE(input->att_data, input->att_datalen);
288 obddev->obd_flags &= ~OBD_ATTACHED;
289 obddev->obd_type = NULL;
292 obddev->obd_flags |= OBD_ATTACHED;
294 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
302 case OBD_IOC_DETACH: {
305 if (obddev->obd_flags & OBD_SET_UP) {
309 if (! (obddev->obd_flags & OBD_ATTACHED) ) {
310 CDEBUG(D_IOCTL, "Device not attached\n");
314 if ( !list_empty(&obddev->obd_gen_clients) ) {
315 CDEBUG(D_IOCTL, "Device has connected clients\n");
320 CDEBUG(D_PSDEV, "Detach %d, type %s\n", dev,
321 obddev->obd_type->typ_name);
322 obddev->obd_flags &= ~OBD_ATTACHED;
323 obddev->obd_type->typ_refcnt--;
324 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
325 obddev->obd_type->typ_refcnt);
326 obddev->obd_type = NULL;
332 case OBD_IOC_SETUP: {
342 /* have we attached a type to this device */
343 if (!(obddev->obd_flags & OBD_ATTACHED)) {
344 CDEBUG(D_IOCTL, "Device not attached\n");
349 /* has this been done already? */
350 if ( obddev->obd_flags & OBD_SET_UP ) {
351 CDEBUG(D_IOCTL, "Device %d already setup (type %s)\n",
352 dev, obddev->obd_type->typ_name);
359 /* get main structure */
360 err = copy_from_user(setup, (void *) arg, sizeof(*setup));
366 err = obd_devicename_from_path(&(obddev->obd_fsname),
367 (char*) setup->setup_data);
369 memset(&(obddev->obd_fsname), 0, sizeof(obd_devicename));
375 CDEBUG(D_PSDEV, "Setup %d, type %s\n", dev,
376 obddev->obd_type->typ_name);
377 if ( !OBT(obddev) || !OBP(obddev, setup) ) {
378 obddev->obd_type->typ_refcnt++;
379 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n",
380 dev, obddev->obd_type->typ_refcnt);
381 if (setup->setup_data)
382 OBD_FREE(setup->setup_data,
383 setup->setup_datalen);
384 obddev->obd_flags |= OBD_SET_UP;
389 err = OBP(obddev, setup)(obddev, 0, NULL);
392 obddev->obd_flags &= ~OBD_SET_UP;
395 obddev->obd_type->typ_refcnt++;
396 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n",
397 dev, obddev->obd_type->typ_refcnt);
398 obddev->obd_flags |= OBD_SET_UP;
404 case OBD_IOC_CLEANUP: {
406 /* has this minor been registered? */
407 if (!obddev->obd_type) {
408 CDEBUG(D_IOCTL, "OBD Device %d has no type.\n", dev);
413 if ( !obddev->obd_type->typ_refcnt ) {
414 CDEBUG(D_IOCTL, "dev %d has refcount (%d)!\n",
415 dev, obddev->obd_type->typ_refcnt);
420 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
421 (!(obddev->obd_flags & OBD_ATTACHED))) {
422 CDEBUG(D_IOCTL, "device not attached or set up\n");
427 if ( !OBT(obddev) || !OBP(obddev, cleanup) )
430 /* cleanup has no argument */
431 err = OBP(obddev, cleanup)(obddev);
438 obddev->obd_flags &= ~OBD_SET_UP;
439 obddev->obd_type->typ_refcnt--;
440 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
441 obddev->obd_type->typ_refcnt);
445 case OBD_IOC_CONNECT:
447 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
448 (!(obddev->obd_flags & OBD_ATTACHED))) {
449 CDEBUG(D_IOCTL, "Device not attached or set up\n");
453 if ( !OBT(obddev) || !OBP(obddev, connect) )
456 err = OBP(obddev, connect)(&conn);
460 return copy_to_user((int *)arg, &conn.oc_id,
463 case OBD_IOC_DISCONNECT:
464 /* frees data structures */
465 /* has this minor been registered? */
466 if (!obddev->obd_type)
469 get_user(cli_id, (int *) arg);
472 if ( !OBT(obddev) || !OBP(obddev, disconnect))
475 OBP(obddev, disconnect)(&conn);
479 struct oic_range_s *range = tmp_buf;
481 if (!obddev->obd_type)
484 err = copy_from_user(range, (const void *)arg, sizeof(*range));
491 if ( !OBT(obddev) || !OBP(obddev, sync) ) {
497 /* XXX sync needs to be tested/verified */
498 err = OBP(obddev, sync)(&conn, &range->obdo, range->count,
506 return put_user(err, (int *) arg);
508 case OBD_IOC_CREATE: {
509 struct oic_attr_s *attr = tmp_buf;
511 err = copy_from_user(attr, (const void *)arg, sizeof(*attr));
517 /* has this minor been registered? */
518 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
519 !(obddev->obd_flags & OBD_SET_UP)) {
520 CDEBUG(D_IOCTL, "Device not attached or set up\n");
523 conn.oc_id = attr->conn_id;
525 if ( !OBT(obddev) || !OBP(obddev, create) )
528 err = OBP(obddev, create)(&conn, &attr->obdo);
534 err = copy_to_user((int *)arg, attr, sizeof(*attr));
539 case OBD_IOC_DESTROY: {
540 struct oic_attr_s *attr = tmp_buf;
542 /* has this minor been registered? */
543 if (!obddev->obd_type)
546 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
552 if ( !OBT(obddev) || !OBP(obddev, destroy) )
555 conn.oc_id = attr->conn_id;
556 err = OBP(obddev, destroy)(&conn, &attr->obdo);
561 case OBD_IOC_SETATTR: {
562 struct oic_attr_s *attr = tmp_buf;
564 /* has this minor been registered? */
565 if (!obddev->obd_type)
568 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
572 if ( !OBT(obddev) || !OBP(obddev, setattr) )
575 conn.oc_id = attr->conn_id;
576 err = OBP(obddev, setattr)(&conn, &attr->obdo);
581 case OBD_IOC_GETATTR: {
582 struct oic_attr_s *attr = tmp_buf;
584 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
588 conn.oc_id = attr->conn_id;
590 err = OBP(obddev, getattr)(&conn, &attr->obdo);
596 err = copy_to_user((int *)arg, attr, sizeof(*attr));
603 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
605 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
611 conn.oc_id = rw_s->conn_id;
613 if ( !OBT(obddev) || !OBP(obddev, read) ) {
620 err = OBP(obddev, read)(&conn, &rw_s->obdo, rw_s->buf,
621 &rw_s->count, rw_s->offset);
624 CDEBUG(D_INFO, "READ: conn %d, count %Ld, offset %Ld, '%s'\n",
625 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
631 err = copy_to_user((int*)arg, &rw_s->count, sizeof(rw_s->count));
636 case OBD_IOC_WRITE: {
637 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
639 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
645 conn.oc_id = rw_s->conn_id;
647 if ( !OBT(obddev) || !OBP(obddev, write) ) {
652 CDEBUG(D_INFO, "WRITE: conn %d, count %Ld, offset %Ld, '%s'\n",
653 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
655 err = OBP(obddev, write)(&conn, &rw_s->obdo, rw_s->buf,
656 &rw_s->count, rw_s->offset);
663 err = copy_to_user((int *)arg, &rw_s->count,
664 sizeof(rw_s->count));
668 case OBD_IOC_PREALLOCATE: {
669 struct oic_prealloc_s *prealloc = tmp_buf;
671 /* has this minor been registered? */
672 if (!obddev->obd_type)
675 err = copy_from_user(prealloc, (int *)arg, sizeof(*prealloc));
679 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
680 !(obddev->obd_flags & OBD_SET_UP)) {
681 CDEBUG(D_IOCTL, "Device not attached or set up\n");
685 if ( !OBT(obddev) || !OBP(obddev, preallocate) )
688 conn.oc_id = prealloc->conn_id;
689 err = OBP(obddev, preallocate)(&conn, &prealloc->alloc,
696 err =copy_to_user((int *)arg, prealloc, sizeof(*prealloc));
700 case OBD_IOC_STATFS: {
702 unsigned int conn_id;
705 /* has this minor been registered? */
706 if (!obddev->obd_type)
709 tmp = (void *)arg + sizeof(unsigned int);
710 get_user(conn_id, (int *) arg);
712 if ( !OBT(obddev) || !OBP(obddev, statfs) )
715 conn.oc_id = conn_id;
716 err = OBP(obddev, statfs)(&conn, &buf);
721 err = copy_to_user(tmp, &buf, sizeof(buf));
727 struct ioc_mv_s *mvdata = tmp_buf;
729 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
730 (!(obddev->obd_flags & OBD_ATTACHED))) {
731 CDEBUG(D_IOCTL, "Device not attached or set up\n");
735 /* get main structure */
736 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
742 if ( !OBT(obddev) || !OBP(obddev, copy) )
745 /* do the partition */
746 CDEBUG(D_INFO, "Copy %d, type %s dst %Ld src %Ld\n", dev,
747 obddev->obd_type->typ_name, mvdata->dst.o_id,
750 conn.oc_id = mvdata->src_conn_id;
752 err = OBP(obddev, copy)(&conn, &mvdata->dst,
754 mvdata->src.o_size, 0);
759 struct ioc_mv_s *mvdata = tmp_buf;
761 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
762 (!(obddev->obd_flags & OBD_ATTACHED))) {
763 CDEBUG(D_IOCTL, "Device not attached or set up\n");
767 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
773 CDEBUG(D_INFO, "Migrate copying %d bytes\n", sizeof(*mvdata));
775 if ( !OBT(obddev) || !OBP(obddev, migrate) )
778 /* do the partition */
779 CDEBUG(D_INFO, "Migrate %d, type %s conn %d src %Ld dst %Ld\n",
780 dev, obddev->obd_type->typ_name, mvdata->src_conn_id,
781 mvdata->src.o_id, mvdata->dst.o_id);
783 conn.oc_id = mvdata->src_conn_id;
784 err = OBP(obddev, migrate)(&conn, &mvdata->dst, &mvdata->src,
785 mvdata->src.o_size, 0);
789 case OBD_IOC_PUNCH: {
790 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
792 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
798 conn.oc_id = rw_s->conn_id;
800 if ( !OBT(obddev) || !OBP(obddev, punch) ) {
805 CDEBUG(D_INFO, "PUNCH: conn %d, count %Ld, offset %Ld\n",
806 rw_s->conn_id, rw_s->count, rw_s->offset);
807 err = OBP(obddev, punch)(&conn, &rw_s->obdo, rw_s->count,
819 struct obd_type *type;
820 struct oic_generic input;
824 /* get data structures */
825 err = copy_from_user(&input, (void *)arg, sizeof(input));
831 err = getdata(input.att_typelen + 1, &input.att_type);
839 type = obd_nm_to_type(nm);
842 if ( !request_module(nm) ) {
843 CDEBUG(D_PSDEV, "Loaded module '%s'\n", nm);
844 type = obd_nm_to_type(nm);
846 CDEBUG(D_PSDEV, "Can't load module '%s'\n", nm);
850 OBD_FREE(input.att_type, input.att_typelen + 1);
852 printk(__FUNCTION__ ": unknown obd type dev %d\n", dev);
857 if ( !type->typ_ops || !type->typ_ops->o_iocontrol ) {
861 conn.oc_id = input.att_connid;
863 CDEBUG(D_INFO, "Calling ioctl %x for type %s, len %d\n",
864 cmd, type->typ_name, input.att_datalen);
866 /* get the generic data */
867 karg = input.att_data;
868 err = getdata(input.att_datalen, &karg);
874 err = type->typ_ops->o_iocontrol(cmd, &conn, input.att_datalen,
875 karg, input.att_data);
876 OBD_FREE(karg, input.att_datalen);
882 } /* obd_class_ioctl */
884 /* Driver interface done, utility functions follow */
886 int obd_register_type(struct obd_ops *ops, char *nm)
888 struct obd_type *type;
891 if (obd_init_magic != 0x11223344) {
892 printk(__FUNCTION__ ": bad magic for type\n");
897 if ( obd_nm_to_type(nm) ) {
898 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
903 OBD_ALLOC(type, struct obd_type * , sizeof(*type));
908 memset(type, 0, sizeof(*type));
909 INIT_LIST_HEAD(&type->typ_chain);
911 list_add(&type->typ_chain, obd_types.next);
918 int obd_unregister_type(char *nm)
920 struct obd_type *type = obd_nm_to_type(nm);
924 printk(KERN_INFO __FUNCTION__ ": unknown obd type\n");
929 if ( type->typ_refcnt ) {
931 printk(KERN_ALERT __FUNCTION__ ":type %s has refcount "
932 "(%d)\n", nm, type->typ_refcnt);
937 list_del(&type->typ_chain);
938 OBD_FREE(type, sizeof(*type));
941 } /* obd_unregister_type */
943 /* declare character device */
944 static struct file_operations obd_psdev_fops = {
945 ioctl: obd_class_ioctl, /* ioctl */
946 open: obd_class_open, /* open */
947 release: obd_class_release, /* release */
958 printk(KERN_INFO "OBD class driver v0.01, braam@stelias.com\n");
960 INIT_LIST_HEAD(&obd_types);
962 if (register_chrdev(OBD_PSDEV_MAJOR,"obd_psdev",
964 printk(KERN_ERR __FUNCTION__ ": unable to get major %d\n",
969 for (i = 0; i < MAX_OBD_DEVICES; i++) {
970 memset(&(obd_dev[i]), 0, sizeof(obd_dev[i]));
971 obd_dev[i].obd_minor = i;
972 INIT_LIST_HEAD(&obd_dev[i].obd_gen_clients);
975 err = obd_init_obdo_cache();
979 obd_init_magic = 0x11223344;
983 EXPORT_SYMBOL(obd_register_type);
984 EXPORT_SYMBOL(obd_unregister_type);
986 EXPORT_SYMBOL(obd_print_entry);
987 EXPORT_SYMBOL(obd_debug_level);
988 EXPORT_SYMBOL(obd_dev);
990 EXPORT_SYMBOL(gen_connect);
991 EXPORT_SYMBOL(gen_client);
992 EXPORT_SYMBOL(gen_cleanup);
993 EXPORT_SYMBOL(gen_disconnect);
994 EXPORT_SYMBOL(gen_copy_data);
995 EXPORT_SYMBOL(obdo_cachep);
997 /* EXPORT_SYMBOL(gen_multi_attach); */
998 EXPORT_SYMBOL(gen_multi_setup);
999 EXPORT_SYMBOL(gen_multi_cleanup);
1003 int init_module(void)
1008 void cleanup_module(void)
1013 unregister_chrdev(OBD_PSDEV_MAJOR, "obd_psdev");
1014 for (i = 0; i < MAX_OBD_DEVICES; i++) {
1015 struct obd_device *obddev = &obd_dev[i];
1016 if ( obddev->obd_type &&
1017 (obddev->obd_flags & OBD_SET_UP) &&
1018 OBT(obddev) && OBP(obddev, detach) ) {
1019 /* XXX should this call generic detach otherwise? */
1020 OBP(obddev, detach)(obddev);
1024 obd_cleanup_obdo_cache();
1026 CDEBUG(D_MALLOC, "CLASS mem used %ld\n", obd_memory);