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.
26 * Copyright (C) 2001 Cluster File Systems, Inc.
33 #include <linux/config.h> /* for CONFIG_PROC_FS */
34 #include <linux/module.h>
35 #include <linux/errno.h>
36 #include <linux/kernel.h>
37 #include <linux/major.h>
38 #include <linux/kmod.h> /* for request_module() */
39 #include <linux/sched.h>
41 #include <linux/slab.h>
42 #include <linux/ioport.h>
43 #include <linux/fcntl.h>
44 #include <linux/delay.h>
45 #include <linux/skbuff.h>
46 #include <linux/proc_fs.h>
47 #include <linux/vmalloc.h>
49 #include <linux/poll.h>
50 #include <linux/init.h>
51 #include <linux/list.h>
53 #include <asm/segment.h>
54 #include <asm/system.h>
56 #include <asm/uaccess.h>
58 #include <linux/obd_support.h>
59 #include <linux/obd_class.h>
61 static int obd_init_magic;
62 int obd_print_entry = 1;
63 int obd_debug_level = ~0;
65 struct obd_device obd_dev[MAX_OBD_DEVICES];
66 struct list_head obd_types;
68 /* called when opening /dev/obdNNN */
69 static int obd_class_open(struct inode * inode, struct file * file)
76 dev = MINOR(inode->i_rdev);
77 if (dev >= MAX_OBD_DEVICES)
79 obd_dev[dev].obd_refcnt++;
80 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
81 obd_dev[dev].obd_refcnt);
83 obd_dev[dev].obd_proc_entry =
84 proc_lustre_register_obd_device(&obd_dev[dev]);
91 /* called when closing /dev/obdNNN */
92 static int obd_class_release(struct inode * inode, struct file * file)
99 dev = MINOR(inode->i_rdev);
100 if (dev >= MAX_OBD_DEVICES)
102 fsync_dev(inode->i_rdev);
103 if (obd_dev[dev].obd_refcnt <= 0)
104 printk(KERN_ALERT __FUNCTION__ ": refcount(%d) <= 0\n",
105 obd_dev[dev].obd_refcnt);
106 obd_dev[dev].obd_refcnt--;
108 if (obd_dev[dev].obd_proc_entry && (obd_dev[dev].obd_refcnt==0))
109 proc_lustre_release_obd_device(&obd_dev[dev]);
111 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
112 obd_dev[dev].obd_refcnt);
120 * support functions: we could use inter-module communication, but this
121 * is more portable to other OS's
123 static struct obd_type *obd_search_type(char *nm)
125 struct list_head *tmp;
126 struct obd_type *type;
127 CDEBUG(D_INFO, "SEARCH %s\n", nm);
130 while ( (tmp = tmp->next) != &obd_types ) {
131 type = list_entry(tmp, struct obd_type, typ_chain);
132 CDEBUG(D_INFO, "TYP %s\n", type->typ_name);
133 if (strlen(type->typ_name) == strlen(nm) &&
134 strcmp(type->typ_name, nm) == 0 ) {
141 static struct obd_type *obd_nm_to_type(char *nm)
143 struct obd_type *type = obd_search_type(nm);
147 if ( !request_module(nm) ) {
148 CDEBUG(D_PSDEV, "Loaded module '%s'\n", nm);
149 type = obd_search_type(nm);
151 CDEBUG(D_PSDEV, "Can't load module '%s'\n", nm);
159 static int getdata(int len, void **data)
168 CDEBUG(D_MALLOC, "len %d, add %p\n", len, *data);
170 OBD_ALLOC(tmp, void *, len);
175 if ( copy_from_user(tmp, *data, len)) {
185 static int obd_devicename_from_path(obd_devicename* whoami,
187 char* kname, char *user_path)
192 whoami->name = kname;
194 #if (LINUX_VERSION_CODE <= 0x20403)
196 err = user_path_walk(user_path, &nd);
198 CDEBUG(D_INFO, "found dentry for %s\n", kname);
199 whoami->dentry = nd.dentry;
209 /* to control /dev/obdNNN */
210 static int obd_class_ioctl (struct inode * inode, struct file * filp,
211 unsigned int cmd, unsigned long arg)
213 struct obd_device *obddev;
214 /* NOTE this must be larger than any of the ioctl data structs */
217 struct obd_conn conn;
219 long int cli_id; /* connect, disconnect */
222 CDEBUG(D_IOCTL, "invalid inode\n");
226 dev = MINOR(inode->i_rdev);
227 if (dev > MAX_OBD_DEVICES)
229 obddev = &obd_dev[dev];
230 conn.oc_dev = obddev;
235 case OBD_IOC_ATTACH: {
236 struct obd_type *type;
237 struct oic_generic *input = tmp_buf;
241 /* have we attached a type to this device */
242 if ( obddev->obd_type ||
243 (obddev->obd_flags & OBD_ATTACHED) ){
245 "OBD Device %d already attached to type %s.\n",
246 dev, obddev->obd_type->typ_name);
251 /* get data structures */
252 err = copy_from_user(input, (void *)arg, sizeof(*input));
258 err = getdata(input->att_typelen + 1, &input->att_type);
265 nm = input->att_type;
266 type = obd_nm_to_type(nm);
268 OBD_FREE(input->att_type, input->att_typelen + 1);
270 printk(__FUNCTION__ ": unknown obd type dev %d\n",
275 obddev->obd_type = type;
277 /* get the attach data */
278 err = getdata(input->att_datalen, &input->att_data);
284 INIT_LIST_HEAD(&obddev->obd_gen_clients);
285 obddev->obd_multi_count = 0;
287 CDEBUG(D_IOCTL, "Attach %d, datalen %d, type %s\n",
288 dev, input->att_datalen, obddev->obd_type->typ_name);
289 /* maybe we are done */
290 if ( !OBT(obddev) || !OBP(obddev, attach) ) {
291 obddev->obd_flags |= OBD_ATTACHED;
293 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
296 OBD_FREE(input->att_data, input->att_datalen);
303 err = OBP(obddev, attach)(obddev, input->att_datalen,
306 OBD_FREE(input->att_data, input->att_datalen);
309 obddev->obd_flags &= ~OBD_ATTACHED;
310 obddev->obd_type = NULL;
313 obddev->obd_flags |= OBD_ATTACHED;
315 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
323 case OBD_IOC_DETACH: {
326 if (obddev->obd_flags & OBD_SET_UP) {
330 if (! (obddev->obd_flags & OBD_ATTACHED) ) {
331 CDEBUG(D_IOCTL, "Device not attached\n");
335 if ( !list_empty(&obddev->obd_gen_clients) ) {
336 CDEBUG(D_IOCTL, "Device has connected clients\n");
341 CDEBUG(D_PSDEV, "Detach %d, type %s\n", dev,
342 obddev->obd_type->typ_name);
343 obddev->obd_flags &= ~OBD_ATTACHED;
344 obddev->obd_type->typ_refcnt--;
345 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
346 obddev->obd_type->typ_refcnt);
347 obddev->obd_type = NULL;
353 case OBD_IOC_SETUP: {
364 /* have we attached a type to this device */
365 if (!(obddev->obd_flags & OBD_ATTACHED)) {
366 CDEBUG(D_IOCTL, "Device not attached\n");
371 /* has this been done already? */
372 if ( obddev->obd_flags & OBD_SET_UP ) {
373 CDEBUG(D_IOCTL, "Device %d already setup (type %s)\n",
374 dev, obddev->obd_type->typ_name);
381 /* get main structure */
382 err = copy_from_user(setup, (void *) arg, sizeof(*setup));
387 user_path = setup->setup_data;
389 /* get the attach data */
390 err = getdata(setup->setup_datalen, &setup->setup_data);
396 err = obd_devicename_from_path(&(obddev->obd_fsname),
397 setup->setup_datalen,
398 (char*) setup->setup_data,
401 memset(&(obddev->obd_fsname), 0, sizeof(obd_devicename));
407 CDEBUG(D_PSDEV, "Setup %d, type %s\n", dev,
408 obddev->obd_type->typ_name);
409 if ( !OBT(obddev) || !OBP(obddev, setup) ) {
410 obddev->obd_type->typ_refcnt++;
411 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n",
412 dev, obddev->obd_type->typ_refcnt);
413 if (setup->setup_data)
414 OBD_FREE(setup->setup_data,
415 setup->setup_datalen);
416 obddev->obd_flags |= OBD_SET_UP;
421 err = OBP(obddev, setup)(obddev, 0, NULL);
424 obddev->obd_flags &= ~OBD_SET_UP;
427 obddev->obd_type->typ_refcnt++;
428 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n",
429 dev, obddev->obd_type->typ_refcnt);
430 obddev->obd_flags |= OBD_SET_UP;
436 case OBD_IOC_CLEANUP: {
438 /* has this minor been registered? */
439 if (!obddev->obd_type) {
440 CDEBUG(D_IOCTL, "OBD Device %d has no type.\n", dev);
445 if ( !obddev->obd_type->typ_refcnt ) {
446 CDEBUG(D_IOCTL, "dev %d has refcount (%d)!\n",
447 dev, obddev->obd_type->typ_refcnt);
452 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
453 (!(obddev->obd_flags & OBD_ATTACHED))) {
454 CDEBUG(D_IOCTL, "device not attached or set up\n");
459 if ( !OBT(obddev) || !OBP(obddev, cleanup) )
462 /* cleanup has no argument */
463 err = OBP(obddev, cleanup)(obddev);
470 obddev->obd_flags &= ~OBD_SET_UP;
471 obddev->obd_type->typ_refcnt--;
472 CDEBUG(D_PSDEV, "Dev %d refcount now %d\n", dev,
473 obddev->obd_type->typ_refcnt);
477 case OBD_IOC_CONNECT:
479 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
480 (!(obddev->obd_flags & OBD_ATTACHED))) {
481 CDEBUG(D_IOCTL, "Device not attached or set up\n");
485 if ( !OBT(obddev) || !OBP(obddev, connect) )
488 err = OBP(obddev, connect)(&conn);
492 return copy_to_user((int *)arg, &conn.oc_id,
495 case OBD_IOC_DISCONNECT:
496 /* frees data structures */
497 /* has this minor been registered? */
498 if (!obddev->obd_type)
501 get_user(cli_id, (int *) arg);
504 if ( !OBT(obddev) || !OBP(obddev, disconnect))
507 OBP(obddev, disconnect)(&conn);
511 struct oic_range_s *range = tmp_buf;
513 if (!obddev->obd_type)
516 err = copy_from_user(range, (const void *)arg, sizeof(*range));
523 if ( !OBT(obddev) || !OBP(obddev, sync) ) {
529 /* XXX sync needs to be tested/verified */
530 err = OBP(obddev, sync)(&conn, &range->obdo, range->count,
538 return put_user(err, (int *) arg);
540 case OBD_IOC_CREATE: {
541 struct oic_attr_s *attr = tmp_buf;
543 err = copy_from_user(attr, (const void *)arg, sizeof(*attr));
549 /* has this minor been registered? */
550 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
551 !(obddev->obd_flags & OBD_SET_UP)) {
552 CDEBUG(D_IOCTL, "Device not attached or set up\n");
555 conn.oc_id = attr->conn_id;
557 if ( !OBT(obddev) || !OBP(obddev, create) )
560 err = OBP(obddev, create)(&conn, &attr->obdo);
566 err = copy_to_user((int *)arg, attr, sizeof(*attr));
571 case OBD_IOC_DESTROY: {
572 struct oic_attr_s *attr = tmp_buf;
574 /* has this minor been registered? */
575 if (!obddev->obd_type)
578 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
584 if ( !OBT(obddev) || !OBP(obddev, destroy) )
587 conn.oc_id = attr->conn_id;
588 err = OBP(obddev, destroy)(&conn, &attr->obdo);
593 case OBD_IOC_SETATTR: {
594 struct oic_attr_s *attr = tmp_buf;
596 /* has this minor been registered? */
597 if (!obddev->obd_type)
600 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
604 if ( !OBT(obddev) || !OBP(obddev, setattr) )
607 conn.oc_id = attr->conn_id;
608 err = OBP(obddev, setattr)(&conn, &attr->obdo);
613 case OBD_IOC_GETATTR: {
614 struct oic_attr_s *attr = tmp_buf;
616 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
620 conn.oc_id = attr->conn_id;
622 err = OBP(obddev, getattr)(&conn, &attr->obdo);
628 err = copy_to_user((int *)arg, attr, sizeof(*attr));
635 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
637 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
643 conn.oc_id = rw_s->conn_id;
645 if ( !OBT(obddev) || !OBP(obddev, read) ) {
652 err = OBP(obddev, read)(&conn, &rw_s->obdo, rw_s->buf,
653 &rw_s->count, rw_s->offset);
656 CDEBUG(D_INFO, "READ: conn %d, count %Ld, offset %Ld, '%s'\n",
657 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
663 err = copy_to_user((int*)arg, &rw_s->count, sizeof(rw_s->count));
668 case OBD_IOC_WRITE: {
669 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
671 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
677 conn.oc_id = rw_s->conn_id;
679 if ( !OBT(obddev) || !OBP(obddev, write) ) {
684 CDEBUG(D_INFO, "WRITE: conn %d, count %Ld, offset %Ld, '%s'\n",
685 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
687 err = OBP(obddev, write)(&conn, &rw_s->obdo, rw_s->buf,
688 &rw_s->count, rw_s->offset);
695 err = copy_to_user((int *)arg, &rw_s->count,
696 sizeof(rw_s->count));
700 case OBD_IOC_PREALLOCATE: {
701 struct oic_prealloc_s *prealloc = tmp_buf;
703 /* has this minor been registered? */
704 if (!obddev->obd_type)
707 err = copy_from_user(prealloc, (int *)arg, sizeof(*prealloc));
711 if ( !(obddev->obd_flags & OBD_ATTACHED) ||
712 !(obddev->obd_flags & OBD_SET_UP)) {
713 CDEBUG(D_IOCTL, "Device not attached or set up\n");
717 if ( !OBT(obddev) || !OBP(obddev, preallocate) )
720 conn.oc_id = prealloc->conn_id;
721 err = OBP(obddev, preallocate)(&conn, &prealloc->alloc,
728 err =copy_to_user((int *)arg, prealloc, sizeof(*prealloc));
732 case OBD_IOC_STATFS: {
734 unsigned int conn_id;
737 /* has this minor been registered? */
738 if (!obddev->obd_type)
741 tmp = (void *)arg + sizeof(unsigned int);
742 get_user(conn_id, (int *) arg);
744 if ( !OBT(obddev) || !OBP(obddev, statfs) )
747 conn.oc_id = conn_id;
748 err = OBP(obddev, statfs)(&conn, &buf);
753 err = copy_to_user(tmp, &buf, sizeof(buf));
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 /* get main structure */
768 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
774 if ( !OBT(obddev) || !OBP(obddev, copy) )
777 /* do the partition */
778 CDEBUG(D_INFO, "Copy %d, type %s dst %Ld src %Ld\n", dev,
779 obddev->obd_type->typ_name, mvdata->dst.o_id,
782 conn.oc_id = mvdata->src_conn_id;
784 err = OBP(obddev, copy)(&conn, &mvdata->dst,
786 mvdata->src.o_size, 0);
791 struct ioc_mv_s *mvdata = tmp_buf;
793 if ( (!(obddev->obd_flags & OBD_SET_UP)) ||
794 (!(obddev->obd_flags & OBD_ATTACHED))) {
795 CDEBUG(D_IOCTL, "Device not attached or set up\n");
799 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
805 CDEBUG(D_INFO, "Migrate copying %d bytes\n", sizeof(*mvdata));
807 if ( !OBT(obddev) || !OBP(obddev, migrate) )
810 /* do the partition */
811 CDEBUG(D_INFO, "Migrate %d, type %s conn %d src %Ld dst %Ld\n",
812 dev, obddev->obd_type->typ_name, mvdata->src_conn_id,
813 mvdata->src.o_id, mvdata->dst.o_id);
815 conn.oc_id = mvdata->src_conn_id;
816 err = OBP(obddev, migrate)(&conn, &mvdata->dst, &mvdata->src,
817 mvdata->src.o_size, 0);
821 case OBD_IOC_PUNCH: {
822 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
824 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
830 conn.oc_id = rw_s->conn_id;
832 if ( !OBT(obddev) || !OBP(obddev, punch) ) {
837 CDEBUG(D_INFO, "PUNCH: conn %d, count %Ld, offset %Ld\n",
838 rw_s->conn_id, rw_s->count, rw_s->offset);
839 err = OBP(obddev, punch)(&conn, &rw_s->obdo, rw_s->count,
851 struct obd_type *type;
852 struct oic_generic input;
856 /* get data structures */
857 err = copy_from_user(&input, (void *)arg, sizeof(input));
863 err = getdata(input.att_typelen + 1, &input.att_type);
871 type = obd_nm_to_type(nm);
874 if ( !request_module(nm) ) {
875 CDEBUG(D_PSDEV, "Loaded module '%s'\n", nm);
876 type = obd_nm_to_type(nm);
878 CDEBUG(D_PSDEV, "Can't load module '%s'\n", nm);
882 OBD_FREE(input.att_type, input.att_typelen + 1);
884 printk(__FUNCTION__ ": unknown obd type dev %d\n", dev);
889 if ( !type->typ_ops || !type->typ_ops->o_iocontrol ) {
893 conn.oc_id = input.att_connid;
895 CDEBUG(D_INFO, "Calling ioctl %x for type %s, len %d\n",
896 cmd, type->typ_name, input.att_datalen);
898 /* get the generic data */
899 karg = input.att_data;
900 err = getdata(input.att_datalen, &karg);
906 err = type->typ_ops->o_iocontrol(cmd, &conn, input.att_datalen,
907 karg, input.att_data);
908 OBD_FREE(karg, input.att_datalen);
914 } /* obd_class_ioctl */
916 /* Driver interface done, utility functions follow */
918 int obd_register_type(struct obd_ops *ops, char *nm)
920 struct obd_type *type;
923 if (obd_init_magic != 0x11223344) {
924 printk(__FUNCTION__ ": bad magic for type\n");
929 if ( obd_nm_to_type(nm) ) {
930 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
935 OBD_ALLOC(type, struct obd_type * , sizeof(*type));
940 memset(type, 0, sizeof(*type));
941 INIT_LIST_HEAD(&type->typ_chain);
943 list_add(&type->typ_chain, obd_types.next);
950 int obd_unregister_type(char *nm)
952 struct obd_type *type = obd_nm_to_type(nm);
956 printk(KERN_INFO __FUNCTION__ ": unknown obd type\n");
961 if ( type->typ_refcnt ) {
963 printk(KERN_ALERT __FUNCTION__ ":type %s has refcount "
964 "(%d)\n", nm, type->typ_refcnt);
969 list_del(&type->typ_chain);
970 OBD_FREE(type, sizeof(*type));
973 } /* obd_unregister_type */
975 /* declare character device */
976 static struct file_operations obd_psdev_fops = {
977 ioctl: obd_class_ioctl, /* ioctl */
978 open: obd_class_open, /* open */
979 release: obd_class_release, /* release */
990 printk(KERN_INFO "OBD class driver v0.01, braam@stelias.com\n");
992 INIT_LIST_HEAD(&obd_types);
994 if (register_chrdev(OBD_PSDEV_MAJOR,"obd_psdev",
996 printk(KERN_ERR __FUNCTION__ ": unable to get major %d\n",
1001 for (i = 0; i < MAX_OBD_DEVICES; i++) {
1002 memset(&(obd_dev[i]), 0, sizeof(obd_dev[i]));
1003 obd_dev[i].obd_minor = i;
1004 INIT_LIST_HEAD(&obd_dev[i].obd_gen_clients);
1007 err = obd_init_obdo_cache();
1011 obd_init_magic = 0x11223344;
1015 EXPORT_SYMBOL(obd_register_type);
1016 EXPORT_SYMBOL(obd_unregister_type);
1018 EXPORT_SYMBOL(obd_print_entry);
1019 EXPORT_SYMBOL(obd_debug_level);
1020 EXPORT_SYMBOL(obd_dev);
1022 EXPORT_SYMBOL(gen_connect);
1023 EXPORT_SYMBOL(gen_client);
1024 EXPORT_SYMBOL(gen_cleanup);
1025 EXPORT_SYMBOL(gen_disconnect);
1026 EXPORT_SYMBOL(gen_copy_data);
1027 EXPORT_SYMBOL(obdo_cachep);
1029 /* EXPORT_SYMBOL(gen_multi_attach); */
1030 EXPORT_SYMBOL(gen_multi_setup);
1031 EXPORT_SYMBOL(gen_multi_cleanup);
1035 int init_module(void)
1040 void cleanup_module(void)
1045 unregister_chrdev(OBD_PSDEV_MAJOR, "obd_psdev");
1046 for (i = 0; i < MAX_OBD_DEVICES; i++) {
1047 struct obd_device *obddev = &obd_dev[i];
1048 if ( obddev->obd_type &&
1049 (obddev->obd_flags & OBD_SET_UP) &&
1050 OBT(obddev) && OBP(obddev, detach) ) {
1051 /* XXX should this call generic detach otherwise? */
1052 OBP(obddev, detach)(obddev);
1056 obd_cleanup_obdo_cache();
1058 CDEBUG(D_MALLOC, "CLASS mem used %ld\n", obd_memory);