1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
6 * This file is part of Lustre, http://www.lustre.org.
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #ifndef __LINUX_CLASS_OBD_H
24 #define __LINUX_CLASS_OBD_H
29 #include <linux/list.h>
32 #include <asm/segment.h>
33 #include <asm/uaccess.h>
34 #include <linux/types.h>
36 #include <linux/time.h>
38 #include <linux/obd_support.h>
39 #include <linux/obd.h>
40 #include <linux/lustre_lib.h>
41 #include <linux/lustre_idl.h>
45 * ======== OBD Device Declarations ===========
47 #define MAX_OBD_DEVICES 8
48 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
50 #define OBD_ATTACHED 0x1
51 #define OBD_SET_UP 0x2
53 extern struct proc_dir_entry *
54 proc_lustre_register_obd_device(struct obd_device *obd);
55 extern void proc_lustre_release_obd_device(struct obd_device *obd);
56 extern void proc_lustre_remove_obd_entry(const char* name,
57 struct obd_device *obd);
60 * ======== OBD Operations Declarations ===========
63 #define OBD_BRW_READ 1
64 #define OBD_BRW_WRITE 2
65 #define OBD_BRW_RWMASK OBD_BRW_READ | OBD_BRW_WRITE
66 #define OBD_BRW_CREATE 4
71 struct obd_conn *conn;
76 static inline int obd_check_conn(struct obd_conn *conn)
78 struct obd_device *obd;
80 printk("obd_check_conn: NULL conn\n");
85 printk("obd_check_conn: NULL obd\n");
89 if (!obd->obd_flags & OBD_ATTACHED ) {
90 printk("obd_check_conn: obd %d not attached\n", obd->obd_minor);
94 if (!obd->obd_flags & OBD_SET_UP) {
95 printk("obd_check_conn: obd %d not setup\n", obd->obd_minor);
100 printk("obd_check_conn: obd %d not typed\n", obd->obd_minor);
104 if (!obd->obd_type->typ_ops) {
105 printk("obd_check_conn: obd %d no operations\n",
112 #define OBT(dev) dev->obd_type
113 #define OBP(dev,op) dev->obd_type->typ_ops->o_ ## op
115 #define OBD_CHECK_SETUP(conn) \
118 CERROR("NULL connection\n"); \
122 if (!((conn)->oc_dev)) { \
123 CERROR("NULL device\n"); \
127 if ( !((conn)->oc_dev->obd_flags & OBD_SET_UP) ) { \
128 CERROR("Device %d not setup\n", \
129 (conn)->oc_dev->obd_minor); \
134 #define OBD_CHECK_OP(conn,op) \
136 int rc = obd_check_conn(conn); \
138 printk("obd: error in operation: " #op "\n"); \
141 if (!OBP(conn->oc_dev,op)) { \
142 printk("obd_" #op ": dev %d no operation\n", \
143 conn->oc_dev->obd_minor); \
144 return -EOPNOTSUPP; \
148 static inline int obd_get_info(struct obd_conn *conn, obd_count keylen,
149 void *key, obd_count *vallen, void **val)
152 OBD_CHECK_SETUP(conn);
153 OBD_CHECK_OP(conn,get_info);
155 rc = OBP(conn->oc_dev, get_info)(conn, keylen, key, vallen, val);
160 static inline int obd_set_info(struct obd_conn *conn, obd_count keylen,
161 void *key, obd_count vallen, void *val)
164 OBD_CHECK_SETUP(conn);
165 OBD_CHECK_OP(conn,set_info);
167 rc = OBP(conn->oc_dev, set_info)(conn, keylen, key, vallen, val);
172 static inline int obd_setup(struct obd_device *obd, int datalen, void *data)
174 struct obd_conn conn;
178 OBD_CHECK_OP((&conn),setup);
180 rc = OBP(conn.oc_dev, setup)(obd, datalen, data);
185 static inline int obd_cleanup(struct obd_device *obd)
187 struct obd_conn conn;
191 OBD_CHECK_SETUP(&conn);
192 OBD_CHECK_OP((&conn),cleanup);
194 rc = OBP(conn.oc_dev, cleanup)(obd);
199 static inline int obd_create(struct obd_conn *conn, struct obdo *obdo)
202 OBD_CHECK_SETUP(conn);
203 OBD_CHECK_OP(conn,create);
205 rc = OBP(conn->oc_dev, create)(conn, obdo);
210 static inline int obd_destroy(struct obd_conn *conn, struct obdo *obdo)
213 OBD_CHECK_SETUP(conn);
214 OBD_CHECK_OP(conn,destroy);
216 rc = OBP(conn->oc_dev, destroy)(conn, obdo);
221 static inline int obd_getattr(struct obd_conn *conn, struct obdo *obdo)
224 OBD_CHECK_SETUP(conn);
225 OBD_CHECK_OP(conn,getattr);
227 rc = OBP(conn->oc_dev, getattr)(conn, obdo);
232 static inline int obd_close(struct obd_conn *conn, struct obdo *obdo)
235 OBD_CHECK_SETUP(conn);
236 OBD_CHECK_OP(conn,close);
238 rc = OBP(conn->oc_dev, close)(conn, obdo);
242 static inline int obd_open(struct obd_conn *conn, struct obdo *obdo)
245 OBD_CHECK_SETUP(conn);
246 OBD_CHECK_OP(conn,open);
248 rc = OBP(conn->oc_dev, open) (conn, obdo);
253 static inline int obd_setattr(struct obd_conn *conn, struct obdo *obdo)
256 OBD_CHECK_SETUP(conn);
257 OBD_CHECK_OP(conn,setattr);
259 rc = OBP(conn->oc_dev, setattr)(conn, obdo);
264 static inline int obd_connect(struct obd_conn *conn)
267 OBD_CHECK_SETUP(conn);
268 OBD_CHECK_OP(conn,connect);
270 rc = OBP(conn->oc_dev, connect)(conn);
275 static inline int obd_disconnect(struct obd_conn *conn)
278 OBD_CHECK_SETUP(conn);
279 OBD_CHECK_OP(conn,disconnect);
281 rc = OBP(conn->oc_dev, disconnect)(conn);
286 static inline int obd_statfs(struct obd_conn *conn, struct statfs *buf)
289 OBD_CHECK_SETUP(conn);
290 OBD_CHECK_OP(conn,statfs);
292 rc = OBP(conn->oc_dev, statfs)(conn, buf);
297 static inline int obd_punch(struct obd_conn *conn, struct obdo *tgt,
298 obd_size count, obd_off offset)
301 OBD_CHECK_SETUP(conn);
302 OBD_CHECK_OP(conn,punch);
304 rc = OBP(conn->oc_dev, punch)(conn, tgt, count, offset);
309 static inline int obd_brw(int rw, struct obd_conn *conn, obd_count num_oa,
310 struct obdo **oa, obd_count *oa_bufs,
311 struct page **buf, obd_size *count, obd_off *offset,
315 OBD_CHECK_SETUP(conn);
316 OBD_CHECK_OP(conn,brw);
318 rc = OBP(conn->oc_dev, brw)(rw, conn, num_oa, oa, oa_bufs, buf,
319 count, offset, flags);
324 static inline int obd_preprw(int cmd, struct obd_conn *conn,
325 int objcount, struct obd_ioobj *obj,
326 int niocount, struct niobuf *nb,
330 OBD_CHECK_SETUP(conn);
331 OBD_CHECK_OP(conn, preprw);
333 rc = OBP(conn->oc_dev, preprw)(cmd, conn, objcount, obj, niocount, nb,
339 static inline int obd_commitrw(int cmd, struct obd_conn *conn,
340 int objcount, struct obd_ioobj *obj,
341 int niocount, struct niobuf *res)
344 OBD_CHECK_SETUP(conn);
345 OBD_CHECK_OP(conn, commitrw);
347 rc = OBP(conn->oc_dev, commitrw)(cmd, conn, objcount, obj, niocount,
353 static inline int obd_iocontrol(int cmd, struct obd_conn *conn,
354 int len, void *karg, void *uarg)
357 OBD_CHECK_SETUP(conn);
358 OBD_CHECK_OP(conn, iocontrol);
360 rc = OBP(conn->oc_dev, iocontrol)(cmd, conn, len, karg, uarg);
368 * ======== OBD Metadata Support ===========
371 extern int obd_init_obdo_cache(void);
372 extern void obd_cleanup_obdo_cache(void);
375 static inline int obdo_has_inline(struct obdo *obdo)
377 return (obdo->o_valid & OBD_MD_FLINLINE &&
378 obdo->o_obdflags & OBD_FL_INLINEDATA);
381 static inline int obdo_has_obdmd(struct obdo *obdo)
383 return (obdo->o_valid & OBD_MD_FLOBDMD &&
384 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
388 /* support routines */
389 extern kmem_cache_t *obdo_cachep;
391 static __inline__ struct obdo *obdo_alloc(void)
393 struct obdo *oa = NULL;
395 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
396 memset(oa, 0, sizeof (*oa));
401 static __inline__ void obdo_free(struct obdo *oa)
405 kmem_cache_free(obdo_cachep, oa);
408 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
409 obd_mode mode, obd_flag valid)
418 return ERR_PTR(-ENOMEM);
424 if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
433 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
435 unsigned int ia_valid = attr->ia_valid;
437 if (ia_valid & ATTR_ATIME) {
438 oa->o_atime = attr->ia_atime;
439 oa->o_valid |= OBD_MD_FLATIME;
441 if (ia_valid & ATTR_MTIME) {
442 oa->o_mtime = attr->ia_mtime;
443 oa->o_valid |= OBD_MD_FLMTIME;
445 if (ia_valid & ATTR_CTIME) {
446 oa->o_ctime = attr->ia_ctime;
447 oa->o_valid |= OBD_MD_FLCTIME;
449 if (ia_valid & ATTR_SIZE) {
450 oa->o_size = attr->ia_size;
451 oa->o_valid |= OBD_MD_FLSIZE;
453 if (ia_valid & ATTR_MODE) {
454 oa->o_mode = attr->ia_mode;
455 oa->o_valid |= OBD_MD_FLMODE;
456 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
457 oa->o_mode &= ~S_ISGID;
459 if (ia_valid & ATTR_UID)
461 oa->o_uid = attr->ia_uid;
462 oa->o_valid |= OBD_MD_FLUID;
464 if (ia_valid & ATTR_GID) {
465 oa->o_gid = attr->ia_gid;
466 oa->o_valid |= OBD_MD_FLGID;
471 static inline void iattr_from_obdo(struct iattr *attr, struct obdo *oa)
473 unsigned int ia_valid = oa->o_valid;
475 memset(attr, 0, sizeof(*attr));
476 if (ia_valid & OBD_MD_FLATIME) {
477 attr->ia_atime = oa->o_atime;
478 attr->ia_valid |= ATTR_ATIME;
480 if (ia_valid & OBD_MD_FLMTIME) {
481 attr->ia_mtime = oa->o_mtime;
482 attr->ia_valid |= ATTR_MTIME;
484 if (ia_valid & OBD_MD_FLCTIME) {
485 attr->ia_ctime = oa->o_ctime;
486 attr->ia_valid |= ATTR_CTIME;
488 if (ia_valid & OBD_MD_FLSIZE) {
489 attr->ia_size = oa->o_size;
490 attr->ia_valid |= ATTR_SIZE;
492 if (ia_valid & OBD_MD_FLMODE) {
493 attr->ia_mode = oa->o_mode;
494 attr->ia_valid |= ATTR_MODE;
495 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
496 attr->ia_mode &= ~S_ISGID;
498 if (ia_valid & OBD_MD_FLUID)
500 attr->ia_uid = oa->o_uid;
501 attr->ia_valid |= ATTR_UID;
503 if (ia_valid & OBD_MD_FLGID) {
504 attr->ia_gid = oa->o_gid;
505 attr->ia_valid |= ATTR_GID;
510 /* WARNING: the file systems must take care not to tinker with
511 attributes they don't manage (such as blocks). */
513 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
515 if ( dst->o_valid & OBD_MD_FLID )
516 dst->o_id = src->i_ino;
517 if ( dst->o_valid & OBD_MD_FLATIME )
518 dst->o_atime = src->i_atime;
519 if ( dst->o_valid & OBD_MD_FLMTIME )
520 dst->o_mtime = src->i_mtime;
521 if ( dst->o_valid & OBD_MD_FLCTIME )
522 dst->o_ctime = src->i_ctime;
523 if ( dst->o_valid & OBD_MD_FLSIZE )
524 dst->o_size = src->i_size;
525 if ( dst->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
526 dst->o_blocks = src->i_blocks;
527 if ( dst->o_valid & OBD_MD_FLBLKSZ )
528 dst->o_blksize = src->i_blksize;
529 if ( dst->o_valid & OBD_MD_FLMODE )
530 dst->o_mode = src->i_mode;
531 if ( dst->o_valid & OBD_MD_FLUID )
532 dst->o_uid = src->i_uid;
533 if ( dst->o_valid & OBD_MD_FLGID )
534 dst->o_gid = src->i_gid;
535 if ( dst->o_valid & OBD_MD_FLFLAGS )
536 dst->o_flags = src->i_flags;
537 if ( dst->o_valid & OBD_MD_FLNLINK )
538 dst->o_nlink = src->i_nlink;
539 if ( dst->o_valid & OBD_MD_FLGENER )
540 dst->o_generation = src->i_generation;
543 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
546 if ( src->o_valid & OBD_MD_FLID )
547 dst->i_ino = src->o_id;
548 if ( src->o_valid & OBD_MD_FLATIME )
549 dst->i_atime = src->o_atime;
550 if ( src->o_valid & OBD_MD_FLMTIME )
551 dst->i_mtime = src->o_mtime;
552 if ( src->o_valid & OBD_MD_FLCTIME )
553 dst->i_ctime = src->o_ctime;
554 if ( src->o_valid & OBD_MD_FLSIZE )
555 dst->i_size = src->o_size;
556 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
557 dst->i_blocks = src->o_blocks;
558 if ( src->o_valid & OBD_MD_FLBLKSZ )
559 dst->i_blksize = src->o_blksize;
560 if ( src->o_valid & OBD_MD_FLMODE )
561 dst->i_mode = src->o_mode;
562 if ( src->o_valid & OBD_MD_FLUID )
563 dst->i_uid = src->o_uid;
564 if ( src->o_valid & OBD_MD_FLGID )
565 dst->i_gid = src->o_gid;
566 if ( src->o_valid & OBD_MD_FLFLAGS )
567 dst->i_flags = src->o_flags;
568 if ( src->o_valid & OBD_MD_FLNLINK )
569 dst->i_nlink = src->o_nlink;
570 if ( src->o_valid & OBD_MD_FLGENER )
571 dst->i_generation = src->o_generation;
576 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
579 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
580 src->o_id, src->o_valid, dst->o_id);
582 if ( src->o_valid & OBD_MD_FLATIME )
583 dst->o_atime = src->o_atime;
584 if ( src->o_valid & OBD_MD_FLMTIME )
585 dst->o_mtime = src->o_mtime;
586 if ( src->o_valid & OBD_MD_FLCTIME )
587 dst->o_ctime = src->o_ctime;
588 if ( src->o_valid & OBD_MD_FLSIZE )
589 dst->o_size = src->o_size;
590 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
591 dst->o_blocks = src->o_blocks;
592 if ( src->o_valid & OBD_MD_FLBLKSZ )
593 dst->o_blksize = src->o_blksize;
594 if ( src->o_valid & OBD_MD_FLMODE )
595 dst->o_mode = src->o_mode;
596 if ( src->o_valid & OBD_MD_FLUID )
597 dst->o_uid = src->o_uid;
598 if ( src->o_valid & OBD_MD_FLGID )
599 dst->o_gid = src->o_gid;
600 if ( src->o_valid & OBD_MD_FLFLAGS )
601 dst->o_flags = src->o_flags;
603 if ( src->o_valid & OBD_MD_FLOBDFLG )
604 dst->o_obdflags = src->o_obdflags;
606 if ( src->o_valid & OBD_MD_FLNLINK )
607 dst->o_nlink = src->o_nlink;
608 if ( src->o_valid & OBD_MD_FLGENER )
609 dst->o_generation = src->o_generation;
610 if ( src->o_valid & OBD_MD_FLINLINE &&
611 src->o_obdflags & OBD_FL_INLINEDATA) {
612 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
613 dst->o_obdflags |= OBD_FL_INLINEDATA;
615 if ( src->o_valid & OBD_MD_FLOBDMD &&
616 src->o_obdflags & OBD_FL_OBDMDEXISTS) {
617 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
618 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
621 dst->o_valid |= src->o_valid;
625 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
626 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
631 if ( compare & OBD_MD_FLATIME )
632 res = (res || (dst->o_atime != src->o_atime));
633 if ( compare & OBD_MD_FLMTIME )
634 res = (res || (dst->o_mtime != src->o_mtime));
635 if ( compare & OBD_MD_FLCTIME )
636 res = (res || (dst->o_ctime != src->o_ctime));
637 if ( compare & OBD_MD_FLSIZE )
638 res = (res || (dst->o_size != src->o_size));
639 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
640 res = (res || (dst->o_blocks != src->o_blocks));
641 if ( compare & OBD_MD_FLBLKSZ )
642 res = (res || (dst->o_blksize != src->o_blksize));
643 if ( compare & OBD_MD_FLMODE )
644 res = (res || (dst->o_mode != src->o_mode));
645 if ( compare & OBD_MD_FLUID )
646 res = (res || (dst->o_uid != src->o_uid));
647 if ( compare & OBD_MD_FLGID )
648 res = (res || (dst->o_gid != src->o_gid));
649 if ( compare & OBD_MD_FLFLAGS )
650 res = (res || (dst->o_flags != src->o_flags));
651 if ( compare & OBD_MD_FLNLINK )
652 res = (res || (dst->o_nlink != src->o_nlink));
653 if ( compare & OBD_MD_FLGENER )
654 res = (res || (dst->o_generation != src->o_generation));
655 /* XXX Don't know if thses should be included here - wasn't previously
656 if ( compare & OBD_MD_FLINLINE )
657 res = (res || memcmp(dst->o_inline, src->o_inline));
658 if ( compare & OBD_MD_FLOBDMD )
659 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
666 int obd_register_type(struct obd_ops *ops, char *nm);
667 int obd_unregister_type(char *nm);
670 struct list_head cli_chain;
671 struct obd_device *cli_obd;
673 unsigned long cli_prealloc_quota;
674 struct list_head cli_prealloc_inodes;
678 struct obd_prealloc_inode {
679 struct list_head obd_prealloc_chain;
683 /* generic operations shared by various OBD types */
684 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
685 int gen_multi_cleanup(struct obd_device *obddev);
686 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
687 int gen_multi_detach(struct obd_device *obddev);
688 int gen_connect (struct obd_conn *conn);
689 int gen_disconnect(struct obd_conn *conn);
690 struct obd_client *gen_client(const struct obd_conn *);
691 int gen_cleanup(struct obd_device *obddev);
692 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
693 struct obd_conn *src_conn, struct obdo *src,
694 obd_size count, obd_off offset);
699 extern void obd_sysctl_init (void);
700 extern void obd_sysctl_clean (void);
703 int lustre_pack_msg(int count, int *lens, char **bufs, int *len, char **buf);
704 int lustre_unpack_msg(char *buf, int len);
705 void *lustre_msg_buf(int n, struct lustre_msg *m);
707 #endif /* __LINUX_CLASS_OBD_H */