1 #ifndef __LINUX_CLASS_OBD_H
2 #define __LINUX_CLASS_OBD_H
4 * Copyright (C) 2001 Cluster File Systems, Inc.
6 * This code is issued under the GNU General Public License.
7 * See the file COPYING in this distribution
13 #include <linux/list.h>
16 #include <asm/segment.h>
17 #include <asm/uaccess.h>
18 #include <linux/types.h>
20 #include <linux/time.h>
22 #include <linux/lustre_lib.h>
23 #include <linux/lustre_idl.h>
24 #include <linux/obd.h>
28 * ======== OBD Device Declarations ===========
30 #define MAX_OBD_DEVICES 8
32 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
34 #define OBD_ATTACHED 0x1
35 #define OBD_SET_UP 0x2
38 struct obd_device *oc_dev;
45 struct dentry *dentry; /* file system obd device names */
46 __u8 _uuid[16]; /* uuid obd device names */
49 #include <linux/obd_ext2.h>
50 #include <linux/obd_filter.h>
51 #include <linux/lustre_mds.h>
52 #include <linux/obd_snap.h>
53 #include <linux/obd_trace.h>
54 /* #include <linux/obd_fc.h> */
55 #include <linux/obd_raid1.h>
56 #include <linux/obd_ost.h>
59 /* corresponds to one of the obdx */
61 struct obd_type *obd_type;
65 obd_devicename obd_fsname;
66 struct proc_dir_entry *obd_proc_entry;
68 struct obd_conn obd_multi_conn[MAX_MULTI];
69 unsigned int obd_gen_last_id;
70 unsigned long obd_gen_prealloc_quota;
71 struct list_head obd_gen_clients;
74 struct filter_obd filter;
76 struct raid1_obd raid1;
78 struct trace_obd trace;
84 extern struct proc_dir_entry *proc_lustre_register_obd_device(struct obd_device *obd);
85 extern void proc_lustre_release_obd_device(struct obd_device *obd);
86 extern void proc_lustre_remove_obd_entry(const char* name, struct obd_device *obd);
89 * ======== OBD Operations Declarations ===========
92 #define OBD_BRW_READ (READ)
93 #define OBD_BRW_WRITE (WRITE)
94 #define OBD_BRW_RWMASK (READ | WRITE)
95 #define OBD_BRW_CREATE (0x00000010UL)
98 int (*o_iocontrol)(int cmd, struct obd_conn *, int len, void *karg,
100 int (*o_get_info)(struct obd_conn *, obd_count keylen, void *key,
101 obd_count *vallen, void **val);
102 int (*o_set_info)(struct obd_conn *, obd_count keylen, void *key,
103 obd_count vallen, void *val);
104 int (*o_attach)(struct obd_device *dev, obd_count len, void *data);
105 int (*o_detach)(struct obd_device *dev);
106 int (*o_setup) (struct obd_device *dev, obd_count len, void *data);
107 int (*o_cleanup)(struct obd_device *dev);
108 int (*o_connect)(struct obd_conn *conn);
109 int (*o_disconnect)(struct obd_conn *conn);
110 int (*o_statfs)(struct obd_conn *conn, struct statfs *statfs);
111 int (*o_preallocate)(struct obd_conn *, obd_count *req, obd_id *ids);
112 int (*o_create)(struct obd_conn *conn, struct obdo *oa);
113 int (*o_destroy)(struct obd_conn *conn, struct obdo *oa);
114 int (*o_setattr)(struct obd_conn *conn, struct obdo *oa);
115 int (*o_getattr)(struct obd_conn *conn, struct obdo *oa);
116 int (*o_read)(struct obd_conn *conn, struct obdo *oa, char *buf,
117 obd_size *count, obd_off offset);
118 int (*o_write)(struct obd_conn *conn, struct obdo *oa, char *buf,
119 obd_size *count, obd_off offset);
120 int (*o_brw)(int rw, struct obd_conn *conn, obd_count num_oa,
121 struct obdo **oa, obd_count *oa_bufs, struct page **buf,
122 obd_size *count, obd_off *offset, obd_flag *flags);
123 int (*o_punch)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
125 int (*o_sync)(struct obd_conn *conn, struct obdo *tgt, obd_size count,
127 int (*o_migrate)(struct obd_conn *conn, struct obdo *dst,
128 struct obdo *src, obd_size count, obd_off offset);
129 int (*o_copy)(struct obd_conn *dstconn, struct obdo *dst,
130 struct obd_conn *srconn, struct obdo *src,
131 obd_size count, obd_off offset);
132 int (*o_iterate)(struct obd_conn *conn, int (*)(obd_id, obd_gr, void *),
133 obd_id *startid, obd_gr group, void *data);
134 int (*o_dmaread)(struct obd_conn *conn, int count, struct obd_buf **dest,
135 struct obd_bufref **source);
136 int (*o_pre_dmawrite)(struct obd_conn *conn, int count, struct obd_buf **dstbufs,
137 struct obd_bufref **dest);
138 int (*o_dmawrite)(struct obd_conn *conn, int count, struct obd_buf **dstbufs,
139 struct obd_buf **dest);
144 struct obd_conn *conn;
149 static inline int obd_check_conn(struct obd_conn *conn)
151 struct obd_device *obd;
153 printk("obd_check_conn: NULL conn\n");
158 printk("obd_check_conn: NULL obd\n");
162 if (!obd->obd_flags & OBD_ATTACHED ) {
163 printk("obd_check_conn: obd %d not attached\n", obd->obd_minor);
167 if (!obd->obd_flags & OBD_SET_UP) {
168 printk("obd_check_conn: obd %d not setup\n", obd->obd_minor);
172 if (!obd->obd_type) {
173 printk("obd_check_conn: obd %d not typed\n", obd->obd_minor);
177 if (!obd->obd_type->typ_ops) {
178 printk("obd_check_conn: obd %d no operations\n", obd->obd_minor);
184 #define OBT(dev) dev->obd_type->typ_ops
185 #define OBP(dev,op) dev->obd_type->typ_ops->o_ ## op
187 #define OBD_CHECK_OP(conn,op) do { \
188 int rc = obd_check_conn(conn);\
189 if (rc) { printk("obd: error in operation: " #op "\n"); return rc; }\
190 if (!OBP(conn->oc_dev,op)) { printk("obd_" #op ": dev %d no operation\n", conn->oc_dev->obd_minor); \
195 static inline int obd_get_info(struct obd_conn *conn, obd_count keylen, void *key,
196 obd_count *vallen, void **val)
199 OBD_CHECK_OP(conn,get_info);
201 rc = OBP(conn->oc_dev, get_info)(conn, keylen, key, vallen, val);
206 static inline int obd_set_info(struct obd_conn *conn, obd_count keylen, void *key,
207 obd_count vallen, void *val)
210 OBD_CHECK_OP(conn,set_info);
212 rc = OBP(conn->oc_dev, set_info)(conn, keylen, key, vallen, val);
217 static inline int obd_cleanup(struct obd_device *obd)
219 struct obd_conn conn;
223 OBD_CHECK_OP((&conn),cleanup);
225 rc = OBP(conn.oc_dev, cleanup)(obd);
230 static inline int obd_create(struct obd_conn *conn, struct obdo *obdo)
233 OBD_CHECK_OP(conn,create);
235 rc = OBP(conn->oc_dev, create)(conn, obdo);
240 static inline int obd_destroy(struct obd_conn *conn, struct obdo *obdo)
243 OBD_CHECK_OP(conn,destroy);
245 rc = OBP(conn->oc_dev, destroy)(conn, obdo);
250 static inline int obd_getattr(struct obd_conn *conn, struct obdo *obdo)
253 OBD_CHECK_OP(conn,getattr);
255 rc = OBP(conn->oc_dev, getattr)(conn, obdo);
260 static inline int obd_setattr(struct obd_conn *conn, struct obdo *obdo)
263 OBD_CHECK_OP(conn,setattr);
265 rc = OBP(conn->oc_dev, setattr)(conn, obdo);
270 static inline int obd_connect(struct obd_conn *conn)
273 OBD_CHECK_OP(conn,connect);
275 rc = OBP(conn->oc_dev, connect)(conn);
280 static inline int obd_disconnect(struct obd_conn *conn)
283 OBD_CHECK_OP(conn,disconnect);
285 rc = OBP(conn->oc_dev, disconnect)(conn);
290 static inline int obd_statfs(struct obd_conn *conn, struct statfs *buf)
293 OBD_CHECK_OP(conn,statfs);
295 rc = OBP(conn->oc_dev, statfs)(conn, buf);
300 static inline int obd_punch(struct obd_conn *conn, struct obdo *tgt, obd_size count, obd_off offset)
303 OBD_CHECK_OP(conn,punch);
305 rc = OBP(conn->oc_dev, punch)(conn, tgt, count, offset);
310 static inline int obd_brw(int rw, struct obd_conn *conn, obd_count num_oa,
311 struct obdo **oa, obd_count *oa_bufs, struct page **buf,
312 obd_size *count, obd_off *offset, obd_flag *flags)
315 OBD_CHECK_OP(conn,brw);
317 rc = OBP(conn->oc_dev, brw)(rw, conn, num_oa, oa, oa_bufs, buf,
318 count, offset, flags);
326 /* This value is not arbitrarily chosen. KIO_STATIC_PAGES from linux/iobuf.h */
327 #define MAX_IOVEC (KIO_STATIC_PAGES - 1)
331 * ======== OBD Metadata Support ===========
334 extern int obd_init_obdo_cache(void);
335 extern void obd_cleanup_obdo_cache(void);
338 static inline int obdo_has_inline(struct obdo *obdo)
340 return (obdo->o_valid & OBD_MD_FLINLINE &&
341 obdo->o_obdflags & OBD_FL_INLINEDATA);
344 static inline int obdo_has_obdmd(struct obdo *obdo)
346 return (obdo->o_valid & OBD_MD_FLOBDMD &&
347 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
351 /* support routines */
352 extern kmem_cache_t *obdo_cachep;
354 static __inline__ struct obdo *obdo_alloc(void)
356 struct obdo *oa = NULL;
358 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
359 memset(oa, 0, sizeof (*oa));
364 static __inline__ void obdo_free(struct obdo *oa)
368 kmem_cache_free(obdo_cachep, oa);
371 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
372 obd_mode mode, obd_flag valid)
381 return ERR_PTR(-ENOMEM);
387 if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
396 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
398 unsigned int ia_valid = attr->ia_valid;
400 if (ia_valid & ATTR_ATIME) {
401 oa->o_atime = attr->ia_atime;
402 oa->o_valid |= OBD_MD_FLATIME;
404 if (ia_valid & ATTR_MTIME) {
405 oa->o_mtime = attr->ia_mtime;
406 oa->o_valid |= OBD_MD_FLMTIME;
408 if (ia_valid & ATTR_CTIME) {
409 oa->o_ctime = attr->ia_ctime;
410 oa->o_valid |= OBD_MD_FLCTIME;
412 if (ia_valid & ATTR_SIZE) {
413 oa->o_size = attr->ia_size;
414 oa->o_valid |= OBD_MD_FLSIZE;
416 if (ia_valid & ATTR_MODE) {
417 oa->o_mode = attr->ia_mode;
418 oa->o_valid |= OBD_MD_FLMODE;
419 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
420 oa->o_mode &= ~S_ISGID;
422 if (ia_valid & ATTR_UID)
424 oa->o_uid = attr->ia_uid;
425 oa->o_valid |= OBD_MD_FLUID;
427 if (ia_valid & ATTR_GID) {
428 oa->o_gid = attr->ia_gid;
429 oa->o_valid |= OBD_MD_FLGID;
434 static inline void iattr_from_obdo(struct iattr *attr, struct obdo *oa)
436 unsigned int ia_valid = oa->o_valid;
438 memset(attr, 0, sizeof(*attr));
439 if (ia_valid & OBD_MD_FLATIME) {
440 attr->ia_atime = oa->o_atime;
441 attr->ia_valid |= ATTR_ATIME;
443 if (ia_valid & OBD_MD_FLMTIME) {
444 attr->ia_mtime = oa->o_mtime;
445 attr->ia_valid |= ATTR_MTIME;
447 if (ia_valid & OBD_MD_FLCTIME) {
448 attr->ia_ctime = oa->o_ctime;
449 attr->ia_valid |= ATTR_CTIME;
451 if (ia_valid & OBD_MD_FLSIZE) {
452 attr->ia_size = oa->o_size;
453 attr->ia_valid |= ATTR_SIZE;
455 if (ia_valid & OBD_MD_FLMODE) {
456 attr->ia_mode = oa->o_mode;
457 attr->ia_valid |= ATTR_MODE;
458 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
459 attr->ia_mode &= ~S_ISGID;
461 if (ia_valid & OBD_MD_FLUID)
463 attr->ia_uid = oa->o_uid;
464 attr->ia_valid |= ATTR_UID;
466 if (ia_valid & OBD_MD_FLGID) {
467 attr->ia_gid = oa->o_gid;
468 attr->ia_valid |= ATTR_GID;
473 /* WARNING: the file systems must take care not to tinker with
474 attributes they don't manage (such as blocks). */
476 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
478 if ( dst->o_valid & OBD_MD_FLID )
479 dst->o_id = src->i_ino;
480 if ( dst->o_valid & OBD_MD_FLATIME )
481 dst->o_atime = src->i_atime;
482 if ( dst->o_valid & OBD_MD_FLMTIME )
483 dst->o_mtime = src->i_mtime;
484 if ( dst->o_valid & OBD_MD_FLCTIME )
485 dst->o_ctime = src->i_ctime;
486 if ( dst->o_valid & OBD_MD_FLSIZE )
487 dst->o_size = src->i_size;
488 if ( dst->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
489 dst->o_blocks = src->i_blocks;
490 if ( dst->o_valid & OBD_MD_FLBLKSZ )
491 dst->o_blksize = src->i_blksize;
492 if ( dst->o_valid & OBD_MD_FLMODE )
493 dst->o_mode = src->i_mode;
494 if ( dst->o_valid & OBD_MD_FLUID )
495 dst->o_uid = src->i_uid;
496 if ( dst->o_valid & OBD_MD_FLGID )
497 dst->o_gid = src->i_gid;
498 if ( dst->o_valid & OBD_MD_FLFLAGS )
499 dst->o_flags = src->i_flags;
500 if ( dst->o_valid & OBD_MD_FLNLINK )
501 dst->o_nlink = src->i_nlink;
502 if ( dst->o_valid & OBD_MD_FLGENER )
503 dst->o_generation = src->i_generation;
506 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
509 if ( src->o_valid & OBD_MD_FLID )
510 dst->i_ino = src->o_id;
511 if ( src->o_valid & OBD_MD_FLATIME )
512 dst->i_atime = src->o_atime;
513 if ( src->o_valid & OBD_MD_FLMTIME )
514 dst->i_mtime = src->o_mtime;
515 if ( src->o_valid & OBD_MD_FLCTIME )
516 dst->i_ctime = src->o_ctime;
517 if ( src->o_valid & OBD_MD_FLSIZE )
518 dst->i_size = src->o_size;
519 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
520 dst->i_blocks = src->o_blocks;
521 if ( src->o_valid & OBD_MD_FLBLKSZ )
522 dst->i_blksize = src->o_blksize;
523 if ( src->o_valid & OBD_MD_FLMODE )
524 dst->i_mode = src->o_mode;
525 if ( src->o_valid & OBD_MD_FLUID )
526 dst->i_uid = src->o_uid;
527 if ( src->o_valid & OBD_MD_FLGID )
528 dst->i_gid = src->o_gid;
529 if ( src->o_valid & OBD_MD_FLFLAGS )
530 dst->i_flags = src->o_flags;
531 if ( src->o_valid & OBD_MD_FLNLINK )
532 dst->i_nlink = src->o_nlink;
533 if ( src->o_valid & OBD_MD_FLGENER )
534 dst->i_generation = src->o_generation;
539 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
542 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
543 src->o_id, src->o_valid, dst->o_id);
545 if ( src->o_valid & OBD_MD_FLATIME )
546 dst->o_atime = src->o_atime;
547 if ( src->o_valid & OBD_MD_FLMTIME )
548 dst->o_mtime = src->o_mtime;
549 if ( src->o_valid & OBD_MD_FLCTIME )
550 dst->o_ctime = src->o_ctime;
551 if ( src->o_valid & OBD_MD_FLSIZE )
552 dst->o_size = src->o_size;
553 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
554 dst->o_blocks = src->o_blocks;
555 if ( src->o_valid & OBD_MD_FLBLKSZ )
556 dst->o_blksize = src->o_blksize;
557 if ( src->o_valid & OBD_MD_FLMODE )
558 dst->o_mode = src->o_mode;
559 if ( src->o_valid & OBD_MD_FLUID )
560 dst->o_uid = src->o_uid;
561 if ( src->o_valid & OBD_MD_FLGID )
562 dst->o_gid = src->o_gid;
563 if ( src->o_valid & OBD_MD_FLFLAGS )
564 dst->o_flags = src->o_flags;
566 if ( src->o_valid & OBD_MD_FLOBDFLG )
567 dst->o_obdflags = src->o_obdflags;
569 if ( src->o_valid & OBD_MD_FLNLINK )
570 dst->o_nlink = src->o_nlink;
571 if ( src->o_valid & OBD_MD_FLGENER )
572 dst->o_generation = src->o_generation;
573 if ( src->o_valid & OBD_MD_FLINLINE &&
574 src->o_obdflags & OBD_FL_INLINEDATA) {
575 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
576 dst->o_obdflags |= OBD_FL_INLINEDATA;
578 if ( src->o_valid & OBD_MD_FLOBDMD &&
579 src->o_obdflags & OBD_FL_OBDMDEXISTS) {
580 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
581 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
584 dst->o_valid |= src->o_valid;
588 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
589 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
594 if ( compare & OBD_MD_FLATIME )
595 res = (res || (dst->o_atime != src->o_atime));
596 if ( compare & OBD_MD_FLMTIME )
597 res = (res || (dst->o_mtime != src->o_mtime));
598 if ( compare & OBD_MD_FLCTIME )
599 res = (res || (dst->o_ctime != src->o_ctime));
600 if ( compare & OBD_MD_FLSIZE )
601 res = (res || (dst->o_size != src->o_size));
602 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
603 res = (res || (dst->o_blocks != src->o_blocks));
604 if ( compare & OBD_MD_FLBLKSZ )
605 res = (res || (dst->o_blksize != src->o_blksize));
606 if ( compare & OBD_MD_FLMODE )
607 res = (res || (dst->o_mode != src->o_mode));
608 if ( compare & OBD_MD_FLUID )
609 res = (res || (dst->o_uid != src->o_uid));
610 if ( compare & OBD_MD_FLGID )
611 res = (res || (dst->o_gid != src->o_gid));
612 if ( compare & OBD_MD_FLFLAGS )
613 res = (res || (dst->o_flags != src->o_flags));
614 if ( compare & OBD_MD_FLNLINK )
615 res = (res || (dst->o_nlink != src->o_nlink));
616 if ( compare & OBD_MD_FLGENER )
617 res = (res || (dst->o_generation != src->o_generation));
618 /* XXX Don't know if thses should be included here - wasn't previously
619 if ( compare & OBD_MD_FLINLINE )
620 res = (res || memcmp(dst->o_inline, src->o_inline));
621 if ( compare & OBD_MD_FLOBDMD )
622 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
629 int obd_register_type(struct obd_ops *ops, char *nm);
630 int obd_unregister_type(char *nm);
633 struct list_head cli_chain;
634 struct obd_device *cli_obd;
636 unsigned long cli_prealloc_quota;
637 struct list_head cli_prealloc_inodes;
641 struct obd_prealloc_inode {
642 struct list_head obd_prealloc_chain;
646 /* generic operations shared by various OBD types */
647 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
648 int gen_multi_cleanup(struct obd_device *obddev);
649 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
650 int gen_multi_detach(struct obd_device *obddev);
651 int gen_connect (struct obd_conn *conn);
652 int gen_disconnect(struct obd_conn *conn);
653 struct obd_client *gen_client(const struct obd_conn *);
654 int gen_cleanup(struct obd_device *obddev);
655 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
656 struct obd_conn *src_conn, struct obdo *src,
657 obd_size count, obd_off offset);
662 extern void obd_sysctl_init (void);
663 extern void obd_sysctl_clean (void);
665 #define CHKCONN(conn) do { if (!gen_client(conn)) {\
666 printk("%s %d invalid client %u\n", __FILE__, __LINE__, \
668 return -EINVAL; }} while (0)
672 #endif /* __LINUX_CLASS_OBD_H */