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 CERROR("obd_check_conn: NULL conn\n");
85 CERROR("obd_check_conn: NULL obd\n");
89 if (!obd->obd_flags & OBD_ATTACHED ) {
90 CERROR("obd_check_conn: obd %d not attached\n", obd->obd_minor);
94 if (!obd->obd_flags & OBD_SET_UP) {
95 CERROR("obd_check_conn: obd %d not setup\n", obd->obd_minor);
100 CERROR("obd_check_conn: obd %d not typed\n", obd->obd_minor);
104 if (!obd->obd_type->typ_ops) {
105 CERROR("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 CERROR("obd: error in operation: " #op "\n"); \
141 if (!OBP(conn->oc_dev,op)) { \
142 CERROR("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);
159 static inline int obd_set_info(struct obd_conn *conn, obd_count keylen,
160 void *key, obd_count vallen, void *val)
163 OBD_CHECK_SETUP(conn);
164 OBD_CHECK_OP(conn,set_info);
166 rc = OBP(conn->oc_dev, set_info)(conn, keylen, key, vallen, val);
170 static inline int obd_setup(struct obd_device *obd, int datalen, void *data)
172 struct obd_conn conn;
176 OBD_CHECK_OP((&conn),setup);
178 rc = OBP(conn.oc_dev, setup)(obd, datalen, data);
182 static inline int obd_cleanup(struct obd_device *obd)
184 struct obd_conn conn;
188 OBD_CHECK_SETUP(&conn);
189 OBD_CHECK_OP((&conn),cleanup);
191 rc = OBP(conn.oc_dev, cleanup)(obd);
195 static inline int obd_create(struct obd_conn *conn, struct obdo *obdo)
198 OBD_CHECK_SETUP(conn);
199 OBD_CHECK_OP(conn,create);
201 rc = OBP(conn->oc_dev, create)(conn, obdo);
205 static inline int obd_destroy(struct obd_conn *conn, struct obdo *obdo)
208 OBD_CHECK_SETUP(conn);
209 OBD_CHECK_OP(conn,destroy);
211 rc = OBP(conn->oc_dev, destroy)(conn, obdo);
215 static inline int obd_getattr(struct obd_conn *conn, struct obdo *obdo)
218 OBD_CHECK_SETUP(conn);
219 OBD_CHECK_OP(conn,getattr);
221 rc = OBP(conn->oc_dev, getattr)(conn, obdo);
225 static inline int obd_close(struct obd_conn *conn, struct obdo *obdo)
228 OBD_CHECK_SETUP(conn);
229 OBD_CHECK_OP(conn,close);
231 rc = OBP(conn->oc_dev, close)(conn, obdo);
234 static inline int obd_open(struct obd_conn *conn, struct obdo *obdo)
237 OBD_CHECK_SETUP(conn);
238 OBD_CHECK_OP(conn,open);
240 rc = OBP(conn->oc_dev, open) (conn, obdo);
244 static inline int obd_setattr(struct obd_conn *conn, struct obdo *obdo)
247 OBD_CHECK_SETUP(conn);
248 OBD_CHECK_OP(conn,setattr);
250 rc = OBP(conn->oc_dev, setattr)(conn, obdo);
254 static inline int obd_connect(struct obd_conn *conn)
257 OBD_CHECK_SETUP(conn);
258 OBD_CHECK_OP(conn,connect);
260 rc = OBP(conn->oc_dev, connect)(conn);
264 static inline int obd_disconnect(struct obd_conn *conn)
267 OBD_CHECK_SETUP(conn);
268 OBD_CHECK_OP(conn,disconnect);
270 rc = OBP(conn->oc_dev, disconnect)(conn);
274 static inline int obd_statfs(struct obd_conn *conn, struct statfs *buf)
277 OBD_CHECK_SETUP(conn);
278 OBD_CHECK_OP(conn,statfs);
280 rc = OBP(conn->oc_dev, statfs)(conn, buf);
284 static inline int obd_punch(struct obd_conn *conn, struct obdo *tgt,
285 obd_size count, obd_off offset)
288 OBD_CHECK_SETUP(conn);
289 OBD_CHECK_OP(conn,punch);
291 rc = OBP(conn->oc_dev, punch)(conn, tgt, count, offset);
295 static inline int obd_brw(int rw, struct obd_conn *conn, obd_count num_oa,
296 struct obdo **oa, obd_count *oa_bufs,
297 struct page **buf, obd_size *count, obd_off *offset,
301 OBD_CHECK_SETUP(conn);
302 OBD_CHECK_OP(conn,brw);
304 rc = OBP(conn->oc_dev, brw)(rw, conn, num_oa, oa, oa_bufs, buf,
305 count, offset, flags);
309 static inline int obd_preprw(int cmd, struct obd_conn *conn,
310 int objcount, struct obd_ioobj *obj,
311 int niocount, struct niobuf *nb,
315 OBD_CHECK_SETUP(conn);
316 OBD_CHECK_OP(conn, preprw);
318 rc = OBP(conn->oc_dev, preprw)(cmd, conn, objcount, obj, niocount, nb,
323 static inline int obd_commitrw(int cmd, struct obd_conn *conn,
324 int objcount, struct obd_ioobj *obj,
325 int niocount, struct niobuf *res)
328 OBD_CHECK_SETUP(conn);
329 OBD_CHECK_OP(conn, commitrw);
331 rc = OBP(conn->oc_dev, commitrw)(cmd, conn, objcount, obj, niocount,
336 static inline int obd_iocontrol(int cmd, struct obd_conn *conn,
337 int len, void *karg, void *uarg)
340 OBD_CHECK_SETUP(conn);
341 OBD_CHECK_OP(conn, iocontrol);
343 rc = OBP(conn->oc_dev, iocontrol)(cmd, conn, len, karg, uarg);
350 * ======== OBD Metadata Support ===========
353 extern int obd_init_obdo_cache(void);
354 extern void obd_cleanup_obdo_cache(void);
357 static inline int obdo_has_inline(struct obdo *obdo)
359 return (obdo->o_valid & OBD_MD_FLINLINE &&
360 obdo->o_obdflags & OBD_FL_INLINEDATA);
363 static inline int obdo_has_obdmd(struct obdo *obdo)
365 return (obdo->o_valid & OBD_MD_FLOBDMD &&
366 obdo->o_obdflags & OBD_FL_OBDMDEXISTS);
370 /* support routines */
371 extern kmem_cache_t *obdo_cachep;
373 static __inline__ struct obdo *obdo_alloc(void)
375 struct obdo *oa = NULL;
377 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
378 memset(oa, 0, sizeof (*oa));
383 static __inline__ void obdo_free(struct obdo *oa)
387 kmem_cache_free(obdo_cachep, oa);
390 static __inline__ struct obdo *obdo_fromid(struct obd_conn *conn, obd_id id,
391 obd_mode mode, obd_flag valid)
400 return ERR_PTR(-ENOMEM);
406 if ((err = OBP(conn->oc_dev, getattr)(conn, oa))) {
415 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
417 unsigned int ia_valid = attr->ia_valid;
419 if (ia_valid & ATTR_ATIME) {
420 oa->o_atime = attr->ia_atime;
421 oa->o_valid |= OBD_MD_FLATIME;
423 if (ia_valid & ATTR_MTIME) {
424 oa->o_mtime = attr->ia_mtime;
425 oa->o_valid |= OBD_MD_FLMTIME;
427 if (ia_valid & ATTR_CTIME) {
428 oa->o_ctime = attr->ia_ctime;
429 oa->o_valid |= OBD_MD_FLCTIME;
431 if (ia_valid & ATTR_SIZE) {
432 oa->o_size = attr->ia_size;
433 oa->o_valid |= OBD_MD_FLSIZE;
435 if (ia_valid & ATTR_MODE) {
436 oa->o_mode = attr->ia_mode;
437 oa->o_valid |= OBD_MD_FLMODE;
438 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
439 oa->o_mode &= ~S_ISGID;
441 if (ia_valid & ATTR_UID)
443 oa->o_uid = attr->ia_uid;
444 oa->o_valid |= OBD_MD_FLUID;
446 if (ia_valid & ATTR_GID) {
447 oa->o_gid = attr->ia_gid;
448 oa->o_valid |= OBD_MD_FLGID;
453 static inline void iattr_from_obdo(struct iattr *attr, struct obdo *oa)
455 unsigned int ia_valid = oa->o_valid;
457 memset(attr, 0, sizeof(*attr));
458 if (ia_valid & OBD_MD_FLATIME) {
459 attr->ia_atime = oa->o_atime;
460 attr->ia_valid |= ATTR_ATIME;
462 if (ia_valid & OBD_MD_FLMTIME) {
463 attr->ia_mtime = oa->o_mtime;
464 attr->ia_valid |= ATTR_MTIME;
466 if (ia_valid & OBD_MD_FLCTIME) {
467 attr->ia_ctime = oa->o_ctime;
468 attr->ia_valid |= ATTR_CTIME;
470 if (ia_valid & OBD_MD_FLSIZE) {
471 attr->ia_size = oa->o_size;
472 attr->ia_valid |= ATTR_SIZE;
474 if (ia_valid & OBD_MD_FLMODE) {
475 attr->ia_mode = oa->o_mode;
476 attr->ia_valid |= ATTR_MODE;
477 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
478 attr->ia_mode &= ~S_ISGID;
480 if (ia_valid & OBD_MD_FLUID)
482 attr->ia_uid = oa->o_uid;
483 attr->ia_valid |= ATTR_UID;
485 if (ia_valid & OBD_MD_FLGID) {
486 attr->ia_gid = oa->o_gid;
487 attr->ia_valid |= ATTR_GID;
492 /* WARNING: the file systems must take care not to tinker with
493 attributes they don't manage (such as blocks). */
495 static __inline__ void obdo_from_inode(struct obdo *dst, struct inode *src)
497 if ( dst->o_valid & OBD_MD_FLID )
498 dst->o_id = src->i_ino;
499 if ( dst->o_valid & OBD_MD_FLATIME )
500 dst->o_atime = src->i_atime;
501 if ( dst->o_valid & OBD_MD_FLMTIME )
502 dst->o_mtime = src->i_mtime;
503 if ( dst->o_valid & OBD_MD_FLCTIME )
504 dst->o_ctime = src->i_ctime;
505 if ( dst->o_valid & OBD_MD_FLSIZE )
506 dst->o_size = src->i_size;
507 if ( dst->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
508 dst->o_blocks = src->i_blocks;
509 if ( dst->o_valid & OBD_MD_FLBLKSZ )
510 dst->o_blksize = src->i_blksize;
511 if ( dst->o_valid & OBD_MD_FLMODE )
512 dst->o_mode = src->i_mode;
513 if ( dst->o_valid & OBD_MD_FLUID )
514 dst->o_uid = src->i_uid;
515 if ( dst->o_valid & OBD_MD_FLGID )
516 dst->o_gid = src->i_gid;
517 if ( dst->o_valid & OBD_MD_FLFLAGS )
518 dst->o_flags = src->i_flags;
519 if ( dst->o_valid & OBD_MD_FLNLINK )
520 dst->o_nlink = src->i_nlink;
521 if ( dst->o_valid & OBD_MD_FLGENER )
522 dst->o_generation = src->i_generation;
525 static __inline__ void obdo_to_inode(struct inode *dst, struct obdo *src)
528 if ( src->o_valid & OBD_MD_FLID )
529 dst->i_ino = src->o_id;
530 if ( src->o_valid & OBD_MD_FLATIME )
531 dst->i_atime = src->o_atime;
532 if ( src->o_valid & OBD_MD_FLMTIME )
533 dst->i_mtime = src->o_mtime;
534 if ( src->o_valid & OBD_MD_FLCTIME )
535 dst->i_ctime = src->o_ctime;
536 if ( src->o_valid & OBD_MD_FLSIZE )
537 dst->i_size = src->o_size;
538 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
539 dst->i_blocks = src->o_blocks;
540 if ( src->o_valid & OBD_MD_FLBLKSZ )
541 dst->i_blksize = src->o_blksize;
542 if ( src->o_valid & OBD_MD_FLMODE )
543 dst->i_mode = src->o_mode;
544 if ( src->o_valid & OBD_MD_FLUID )
545 dst->i_uid = src->o_uid;
546 if ( src->o_valid & OBD_MD_FLGID )
547 dst->i_gid = src->o_gid;
548 if ( src->o_valid & OBD_MD_FLFLAGS )
549 dst->i_flags = src->o_flags;
550 if ( src->o_valid & OBD_MD_FLNLINK )
551 dst->i_nlink = src->o_nlink;
552 if ( src->o_valid & OBD_MD_FLGENER )
553 dst->i_generation = src->o_generation;
558 static __inline__ void obdo_cpy_md(struct obdo *dst, struct obdo *src)
561 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
562 (unsigned long long)src->o_id, src->o_valid,
563 (unsigned long long)dst->o_id);
565 if ( src->o_valid & OBD_MD_FLATIME )
566 dst->o_atime = src->o_atime;
567 if ( src->o_valid & OBD_MD_FLMTIME )
568 dst->o_mtime = src->o_mtime;
569 if ( src->o_valid & OBD_MD_FLCTIME )
570 dst->o_ctime = src->o_ctime;
571 if ( src->o_valid & OBD_MD_FLSIZE )
572 dst->o_size = src->o_size;
573 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
574 dst->o_blocks = src->o_blocks;
575 if ( src->o_valid & OBD_MD_FLBLKSZ )
576 dst->o_blksize = src->o_blksize;
577 if ( src->o_valid & OBD_MD_FLMODE )
578 dst->o_mode = src->o_mode;
579 if ( src->o_valid & OBD_MD_FLUID )
580 dst->o_uid = src->o_uid;
581 if ( src->o_valid & OBD_MD_FLGID )
582 dst->o_gid = src->o_gid;
583 if ( src->o_valid & OBD_MD_FLFLAGS )
584 dst->o_flags = src->o_flags;
586 if ( src->o_valid & OBD_MD_FLOBDFLG )
587 dst->o_obdflags = src->o_obdflags;
589 if ( src->o_valid & OBD_MD_FLNLINK )
590 dst->o_nlink = src->o_nlink;
591 if ( src->o_valid & OBD_MD_FLGENER )
592 dst->o_generation = src->o_generation;
593 if ( src->o_valid & OBD_MD_FLINLINE &&
594 src->o_obdflags & OBD_FL_INLINEDATA) {
595 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
596 dst->o_obdflags |= OBD_FL_INLINEDATA;
598 if ( src->o_valid & OBD_MD_FLOBDMD &&
599 src->o_obdflags & OBD_FL_OBDMDEXISTS) {
600 memcpy(dst->o_obdmd, src->o_obdmd, sizeof(src->o_obdmd));
601 dst->o_obdflags |= OBD_FL_OBDMDEXISTS;
604 dst->o_valid |= src->o_valid;
608 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
609 static __inline__ int obdo_cmp_md(struct obdo *dst, struct obdo *src,
614 if ( compare & OBD_MD_FLATIME )
615 res = (res || (dst->o_atime != src->o_atime));
616 if ( compare & OBD_MD_FLMTIME )
617 res = (res || (dst->o_mtime != src->o_mtime));
618 if ( compare & OBD_MD_FLCTIME )
619 res = (res || (dst->o_ctime != src->o_ctime));
620 if ( compare & OBD_MD_FLSIZE )
621 res = (res || (dst->o_size != src->o_size));
622 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
623 res = (res || (dst->o_blocks != src->o_blocks));
624 if ( compare & OBD_MD_FLBLKSZ )
625 res = (res || (dst->o_blksize != src->o_blksize));
626 if ( compare & OBD_MD_FLMODE )
627 res = (res || (dst->o_mode != src->o_mode));
628 if ( compare & OBD_MD_FLUID )
629 res = (res || (dst->o_uid != src->o_uid));
630 if ( compare & OBD_MD_FLGID )
631 res = (res || (dst->o_gid != src->o_gid));
632 if ( compare & OBD_MD_FLFLAGS )
633 res = (res || (dst->o_flags != src->o_flags));
634 if ( compare & OBD_MD_FLNLINK )
635 res = (res || (dst->o_nlink != src->o_nlink));
636 if ( compare & OBD_MD_FLGENER )
637 res = (res || (dst->o_generation != src->o_generation));
638 /* XXX Don't know if thses should be included here - wasn't previously
639 if ( compare & OBD_MD_FLINLINE )
640 res = (res || memcmp(dst->o_inline, src->o_inline));
641 if ( compare & OBD_MD_FLOBDMD )
642 res = (res || memcmp(dst->o_obdmd, src->o_obdmd));
649 int obd_register_type(struct obd_ops *ops, char *nm);
650 int obd_unregister_type(char *nm);
653 struct list_head cli_chain;
654 struct obd_device *cli_obd;
656 unsigned long cli_prealloc_quota;
657 struct list_head cli_prealloc_inodes;
661 struct obd_prealloc_inode {
662 struct list_head obd_prealloc_chain;
666 /* generic operations shared by various OBD types */
667 int gen_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
668 int gen_multi_cleanup(struct obd_device *obddev);
669 int gen_multi_attach(struct obd_device *obddev, uint32_t len, void *data);
670 int gen_multi_detach(struct obd_device *obddev);
671 int gen_connect (struct obd_conn *conn);
672 int gen_disconnect(struct obd_conn *conn);
673 struct obd_client *gen_client(const struct obd_conn *);
674 int gen_cleanup(struct obd_device *obddev);
675 int gen_copy_data(struct obd_conn *dst_conn, struct obdo *dst,
676 struct obd_conn *src_conn, struct obdo *src,
677 obd_size count, obd_off offset);
682 extern void obd_sysctl_init (void);
683 extern void obd_sysctl_clean (void);
685 #endif /* __LINUX_CLASS_OBD_H */