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 * version 2 as published by the Free Software Foundation.
11 * Adapted to become the Linux 2.0 Coda pseudo device
12 * Peter Braam <braam@maths.ox.ac.uk>
13 * Michael Callahan <mjc@emmy.smith.edu>
15 * Changes for Linux 2.1
16 * Copyright (c) 1997 Carnegie-Mellon University
18 * Redone again for Intermezzo
19 * Copyright (c) 1998 Peter J. Braam
21 * Hacked up again for simulated OBD
22 * Copyright (c) 1999 Stelias Computing, Inc.
23 * (authors {pschwan,braam}@stelias.com)
24 * Copyright (C) 1999 Seagate Technology, Inc.
25 * Copyright (C) 2001 Cluster File Systems, Inc.
31 #include <linux/config.h> /* for CONFIG_PROC_FS */
32 #include <linux/module.h>
33 #include <linux/errno.h>
34 #include <linux/kernel.h>
35 #include <linux/major.h>
36 #include <linux/kmod.h> /* for request_module() */
37 #include <linux/sched.h>
39 #include <linux/slab.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/system.h>
53 #include <asm/uaccess.h>
54 #include <linux/miscdevice.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 = ~0;
63 struct obd_device obd_dev[MAX_OBD_DEVICES];
64 struct list_head obd_types;
66 /* opening /dev/obd */
67 static int obd_class_open(struct inode * inode, struct file * file)
71 file->private_data = NULL;
77 /* closing /dev/obd */
78 static int obd_class_release(struct inode * inode, struct file * file)
82 if (file->private_data)
83 file->private_data = NULL;
91 * support functions: we could use inter-module communication, but this
92 * is more portable to other OS's
94 static struct obd_type *obd_search_type(char *nm)
96 struct list_head *tmp;
97 struct obd_type *type;
98 CDEBUG(D_INFO, "SEARCH %s\n", nm);
101 while ( (tmp = tmp->next) != &obd_types ) {
102 type = list_entry(tmp, struct obd_type, typ_chain);
103 CDEBUG(D_INFO, "TYP %s\n", type->typ_name);
104 if (strlen(type->typ_name) == strlen(nm) &&
105 strcmp(type->typ_name, nm) == 0 ) {
112 static struct obd_type *obd_nm_to_type(char *nm)
114 struct obd_type *type = obd_search_type(nm);
118 if ( !request_module(nm) ) {
119 CDEBUG(D_PSDEV, "Loaded module '%s'\n", nm);
120 type = obd_search_type(nm);
122 CDEBUG(D_PSDEV, "Can't load module '%s'\n", nm);
129 /* to control /dev/obd */
130 static int obd_class_ioctl (struct inode * inode, struct file * filp,
131 unsigned int cmd, unsigned long arg)
133 /* NOTE this must be larger than any of the ioctl data structs */
135 struct obd_ioctl_data *data;
136 struct obd_device *obd = filp->private_data;
137 struct obd_conn conn;
141 memset(buf, 0, sizeof(buf));
143 if (!obd && cmd != OBD_IOC_DEVICE && cmd != TCGETS) {
144 printk("OBD ioctl: No device\n");
147 if (obd_ioctl_getdata(buf, buf + 800, (void *)arg)) {
148 printk("OBD ioctl: data error\n");
151 data = (struct obd_ioctl_data *)buf;
156 case OBD_IOC_DEVICE: {
157 CDEBUG(D_IOCTL, "\n");
158 if (data->ioc_dev >= MAX_OBD_DEVICES ||
160 printk("OBD ioctl: DEVICE insufficient devices\n");
163 CDEBUG(D_IOCTL, "device %d\n", data->ioc_dev);
165 filp->private_data = &obd_dev[data->ioc_dev];
170 case OBD_IOC_ATTACH: {
171 struct obd_type *type;
174 /* have we attached a type to this device */
175 if ( obd->obd_type || (obd->obd_flags & OBD_ATTACHED) ){
176 printk("OBD: Device %d already typed as %s.\n",
177 obd->obd_minor, MKSTR(obd->obd_type->typ_name));
181 printk("-----> attach %s %s\n", MKSTR(data->ioc_inlbuf1),
182 MKSTR(data->ioc_inlbuf2));
185 type = obd_nm_to_type(data->ioc_inlbuf1);
187 printk("OBD: unknown type dev %d\n", obd->obd_minor);
191 obd->obd_type = type;
192 obd->obd_multi_count = 0;
193 INIT_LIST_HEAD(&obd->obd_gen_clients);
196 if ( OBT(obd) && OBP(obd, attach) ) {
197 err = OBP(obd, attach)(obd, data);
201 obd->obd_flags &= ~OBD_ATTACHED;
202 obd->obd_type = NULL;
205 obd->obd_flags |= OBD_ATTACHED;
207 printk("OBD: dev %d attached type %s\n",
208 obd->obd_minor, data->ioc_inlbuf1);
209 obd->obd_proc_entry =
210 proc_lustre_register_obd_device(obd);
218 case OBD_IOC_DETACH: {
220 if (obd->obd_flags & OBD_SET_UP) {
221 printk("OBD device %d still set up\n", obd->obd_minor);
224 if (! (obd->obd_flags & OBD_ATTACHED) ) {
225 printk("OBD device %d not attached\n", obd->obd_minor);
228 if ( !list_empty(&obd->obd_gen_clients) ) {
229 printk("OBD device %d has connected clients\n", obd->obd_minor);
233 if (obd->obd_proc_entry)
234 proc_lustre_release_obd_device(obd);
236 obd->obd_flags &= ~OBD_ATTACHED;
237 obd->obd_type->typ_refcnt--;
238 obd->obd_type = NULL;
244 case OBD_IOC_SETUP: {
246 /* have we attached a type to this device? */
247 if (!(obd->obd_flags & OBD_ATTACHED)) {
248 printk("Device %d not attached\n", obd->obd_minor);
252 /* has this been done already? */
253 if ( obd->obd_flags & OBD_SET_UP ) {
254 printk("Device %d already setup (type %s)\n",
255 obd->obd_minor, obd->obd_type->typ_name);
259 if ( OBT(obd) && OBP(obd, setup) )
260 err = OBP(obd, setup)(obd, data);
263 obd->obd_type->typ_refcnt++;
264 obd->obd_flags |= OBD_SET_UP;
270 case OBD_IOC_CLEANUP: {
272 /* has this minor been registered? */
273 if (!obd->obd_type) {
274 printk("OBD cleanup dev %d has no type.\n",
280 if ( (!(obd->obd_flags & OBD_SET_UP)) ||
281 (!(obd->obd_flags & OBD_ATTACHED))) {
282 printk("OBD cleanup device %d not attached/set up\n",
288 if ( !OBT(obd) || !OBP(obd, cleanup) )
291 /* cleanup has no argument */
292 err = OBP(obd, cleanup)(obd);
299 obd->obd_flags &= ~OBD_SET_UP;
300 obd->obd_type->typ_refcnt--;
305 case OBD_IOC_CONNECT:
307 if ( (!(obd->obd_flags & OBD_SET_UP)) ||
308 (!(obd->obd_flags & OBD_ATTACHED))) {
309 CDEBUG(D_IOCTL, "Device not attached or set up\n");
313 if ( !OBT(obd) || !OBP(obd, connect) )
316 conn.oc_id = data->ioc_conn1;
319 err = OBP(obd, connect)(&conn);
320 CDEBUG(D_IOCTL, "assigned connection %d\n", conn.oc_id);
321 data->ioc_conn1 = conn.oc_id;
325 return copy_to_user((int *)arg, data, sizeof(*data));
327 case OBD_IOC_DISCONNECT: {
332 if ( !OBT(obd) || !OBP(obd, disconnect))
335 conn.oc_id = data->ioc_conn1;
337 OBP(obd, disconnect)(&conn);
341 case OBD_IOC_DEC_USE_COUNT: {
346 case OBD_IOC_CREATE: {
347 /* has this minor been registered? */
348 if ( !(obd->obd_flags & OBD_ATTACHED) ||
349 !(obd->obd_flags & OBD_SET_UP)) {
350 CDEBUG(D_IOCTL, "Device not attached or set up\n");
353 conn.oc_id = data->ioc_conn1;
356 if ( !OBT(obd) || !OBP(obd, create) )
359 err = OBP(obd, create)(&conn, &data->ioc_obdo1);
365 err = copy_to_user((int *)arg, data, sizeof(*data));
371 struct oic_range_s *range = tmp_buf;
376 err = copy_from_user(range, (const void *)arg, sizeof(*range));
383 if ( !OBT(obd) || !OBP(obd, sync) ) {
389 /* XXX sync needs to be tested/verified */
390 err = OBP(obd, sync)(&conn, &range->obdo, range->count,
398 return put_user(err, (int *) arg);
401 case OBD_IOC_DESTROY: {
402 struct oic_attr_s *attr = tmp_buf;
404 /* has this minor been registered? */
408 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
414 if ( !OBT(obd) || !OBP(obd, destroy) )
417 conn.oc_id = attr->conn_id;
418 err = OBP(obd, destroy)(&conn, &attr->obdo);
423 case OBD_IOC_SETATTR: {
424 struct oic_attr_s *attr = tmp_buf;
426 /* has this minor been registered? */
430 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
434 if ( !OBT(obd) || !OBP(obd, setattr) )
437 conn.oc_id = attr->conn_id;
438 err = OBP(obd, setattr)(&conn, &attr->obdo);
443 case OBD_IOC_GETATTR: {
444 struct oic_attr_s *attr = tmp_buf;
446 err = copy_from_user(attr, (int *)arg, sizeof(*attr));
450 conn.oc_id = attr->conn_id;
452 err = OBP(obd, getattr)(&conn, &attr->obdo);
458 err = copy_to_user((int *)arg, attr, sizeof(*attr));
465 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
467 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
473 conn.oc_id = rw_s->conn_id;
475 if ( !OBT(obd) || !OBP(obd, read) ) {
482 err = OBP(obd, read)(&conn, &rw_s->obdo, rw_s->buf,
483 &rw_s->count, rw_s->offset);
486 CDEBUG(D_INFO, "READ: conn %d, count %Ld, offset %Ld, '%s'\n",
487 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
493 err = copy_to_user((int*)arg, &rw_s->count, sizeof(rw_s->count));
498 case OBD_IOC_WRITE: {
499 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
501 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
507 conn.oc_id = rw_s->conn_id;
509 if ( !OBT(obd) || !OBP(obd, write) ) {
514 CDEBUG(D_INFO, "WRITE: conn %d, count %Ld, offset %Ld, '%s'\n",
515 rw_s->conn_id, rw_s->count, rw_s->offset, rw_s->buf);
517 err = OBP(obd, write)(&conn, &rw_s->obdo, rw_s->buf,
518 &rw_s->count, rw_s->offset);
525 err = copy_to_user((int *)arg, &rw_s->count,
526 sizeof(rw_s->count));
530 case OBD_IOC_PREALLOCATE: {
531 struct oic_prealloc_s *prealloc = tmp_buf;
533 /* has this minor been registered? */
537 err = copy_from_user(prealloc, (int *)arg, sizeof(*prealloc));
541 if ( !(obd->obd_flags & OBD_ATTACHED) ||
542 !(obd->obd_flags & OBD_SET_UP)) {
543 CDEBUG(D_IOCTL, "Device not attached or set up\n");
547 if ( !OBT(obd) || !OBP(obd, preallocate) )
550 conn.oc_id = prealloc->conn_id;
551 err = OBP(obd, preallocate)(&conn, &prealloc->alloc,
558 err =copy_to_user((int *)arg, prealloc, sizeof(*prealloc));
562 case OBD_IOC_STATFS: {
564 unsigned int conn_id;
567 /* has this minor been registered? */
571 tmp = (void *)arg + sizeof(unsigned int);
572 get_user(conn_id, (int *) arg);
574 if ( !OBT(obd) || !OBP(obd, statfs) )
577 conn.oc_id = conn_id;
578 err = OBP(obd, statfs)(&conn, &buf);
583 err = copy_to_user(tmp, &buf, sizeof(buf));
589 struct ioc_mv_s *mvdata = tmp_buf;
591 if ( (!(obd->obd_flags & OBD_SET_UP)) ||
592 (!(obd->obd_flags & OBD_ATTACHED))) {
593 CDEBUG(D_IOCTL, "Device not attached or set up\n");
597 /* get main structure */
598 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
604 if ( !OBT(obd) || !OBP(obd, copy) )
607 /* do the partition */
608 CDEBUG(D_INFO, "Copy %d, type %s dst %Ld src %Ld\n", dev,
609 obd->obd_type->typ_name, mvdata->dst.o_id,
612 conn.oc_id = mvdata->src_conn_id;
614 err = OBP(obd, copy)(&conn, &mvdata->dst,
616 mvdata->src.o_size, 0);
621 struct ioc_mv_s *mvdata = tmp_buf;
623 if ( (!(obd->obd_flags & OBD_SET_UP)) ||
624 (!(obd->obd_flags & OBD_ATTACHED))) {
625 CDEBUG(D_IOCTL, "Device not attached or set up\n");
629 err = copy_from_user(mvdata, (void *) arg, sizeof(*mvdata));
635 CDEBUG(D_INFO, "Migrate copying %d bytes\n", sizeof(*mvdata));
637 if ( !OBT(obd) || !OBP(obd, migrate) )
640 /* do the partition */
641 CDEBUG(D_INFO, "Migrate %d, type %s conn %d src %Ld dst %Ld\n",
642 dev, obd->obd_type->typ_name, mvdata->src_conn_id,
643 mvdata->src.o_id, mvdata->dst.o_id);
645 conn.oc_id = mvdata->src_conn_id;
646 err = OBP(obd, migrate)(&conn, &mvdata->dst, &mvdata->src,
647 mvdata->src.o_size, 0);
651 case OBD_IOC_PUNCH: {
652 struct oic_rw_s *rw_s = tmp_buf; /* read, write ioctl str */
654 err = copy_from_user(rw_s, (int *)arg, sizeof(*rw_s));
660 conn.oc_id = rw_s->conn_id;
662 if ( !OBT(obd) || !OBP(obd, punch) ) {
667 CDEBUG(D_INFO, "PUNCH: conn %d, count %Ld, offset %Ld\n",
668 rw_s->conn_id, rw_s->count, rw_s->offset);
669 err = OBP(obd, punch)(&conn, &rw_s->obdo, rw_s->count,
681 struct obd_type *type;
682 struct oic_generic input;
686 /* get data structures */
687 err = copy_from_user(&input, (void *)arg, sizeof(input));
693 err = getdata(input.att_typelen + 1, &input.att_type);
701 type = obd_nm_to_type(nm);
704 if ( !request_module(nm) ) {
705 CDEBUG(D_PSDEV, "Loaded module '%s'\n", nm);
706 type = obd_nm_to_type(nm);
708 CDEBUG(D_PSDEV, "Can't load module '%s'\n", nm);
712 OBD_FREE(input.att_type, input.att_typelen + 1);
714 printk(__FUNCTION__ ": unknown obd type dev %d\n", dev);
719 if ( !type->typ_ops || !type->typ_ops->o_iocontrol ) {
723 conn.oc_id = input.att_connid;
725 CDEBUG(D_INFO, "Calling ioctl %x for type %s, len %d\n",
726 cmd, type->typ_name, input.att_datalen);
728 /* get the generic data */
729 karg = input.att_data;
730 err = getdata(input.att_datalen, &karg);
736 err = type->typ_ops->o_iocontrol(cmd, &conn, input.att_datalen,
737 karg, input.att_data);
738 OBD_FREE(karg, input.att_datalen);
748 } /* obd_class_ioctl */
750 /* Driver interface done, utility functions follow */
752 int obd_register_type(struct obd_ops *ops, char *nm)
754 struct obd_type *type;
757 if (obd_init_magic != 0x11223344) {
758 printk(__FUNCTION__ ": bad magic for type\n");
763 if ( obd_nm_to_type(nm) ) {
764 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
769 OBD_ALLOC(type, struct obd_type * , sizeof(*type));
774 memset(type, 0, sizeof(*type));
775 INIT_LIST_HEAD(&type->typ_chain);
777 list_add(&type->typ_chain, obd_types.next);
784 int obd_unregister_type(char *nm)
786 struct obd_type *type = obd_nm_to_type(nm);
790 printk(KERN_INFO __FUNCTION__ ": unknown obd type\n");
795 if ( type->typ_refcnt ) {
797 printk(KERN_ALERT __FUNCTION__ ":type %s has refcount "
798 "(%d)\n", nm, type->typ_refcnt);
803 list_del(&type->typ_chain);
804 OBD_FREE(type, sizeof(*type));
807 } /* obd_unregister_type */
809 /* declare character device */
810 static struct file_operations obd_psdev_fops = {
811 ioctl: obd_class_ioctl, /* ioctl */
812 open: obd_class_open, /* open */
813 release: obd_class_release, /* release */
818 #define OBD_MINOR 241
819 static struct miscdevice obd_psdev = {
830 printk(KERN_INFO "OBD class driver v0.01, braam@stelias.com\n");
832 INIT_LIST_HEAD(&obd_types);
834 if ( (err = misc_register(&obd_psdev)) ) {
835 printk(KERN_ERR __FUNCTION__ ": cannot register %d err %d\n",
840 for (i = 0; i < MAX_OBD_DEVICES; i++) {
841 memset(&(obd_dev[i]), 0, sizeof(obd_dev[i]));
842 obd_dev[i].obd_minor = i;
843 INIT_LIST_HEAD(&obd_dev[i].obd_gen_clients);
846 err = obd_init_obdo_cache();
850 obd_init_magic = 0x11223344;
854 EXPORT_SYMBOL(obd_register_type);
855 EXPORT_SYMBOL(obd_unregister_type);
857 EXPORT_SYMBOL(obd_print_entry);
858 EXPORT_SYMBOL(obd_debug_level);
859 EXPORT_SYMBOL(obd_dev);
861 EXPORT_SYMBOL(gen_connect);
862 EXPORT_SYMBOL(gen_client);
863 EXPORT_SYMBOL(gen_cleanup);
864 EXPORT_SYMBOL(gen_disconnect);
865 EXPORT_SYMBOL(gen_copy_data);
866 EXPORT_SYMBOL(obdo_cachep);
868 /* EXPORT_SYMBOL(gen_multi_attach); */
869 EXPORT_SYMBOL(gen_multi_setup);
870 EXPORT_SYMBOL(gen_multi_cleanup);
874 int init_module(void)
879 void cleanup_module(void)
884 misc_deregister(&obd_psdev);
885 for (i = 0; i < MAX_OBD_DEVICES; i++) {
886 struct obd_device *obd = &obd_dev[i];
887 if ( obd->obd_type &&
888 (obd->obd_flags & OBD_SET_UP) &&
889 OBT(obd) && OBP(obd, detach) ) {
890 /* XXX should this call generic detach otherwise? */
891 OBP(obd, detach)(obd);
895 obd_cleanup_obdo_cache();
897 CDEBUG(D_MALLOC, "CLASS mem used %ld\n", obd_memory);