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>
42 #include <linux/lustre_mds.h>
47 * ======== OBD Device Declarations ===========
49 #define MAX_OBD_DEVICES 128
50 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
52 #define OBD_ATTACHED 0x1
53 #define OBD_SET_UP 0x2
55 extern struct proc_dir_entry *
56 proc_lustre_register_obd_device(struct obd_device *obd);
57 extern void proc_lustre_release_obd_device(struct obd_device *obd);
58 extern void proc_lustre_remove_obd_entry(const char* name,
59 struct obd_device *obd);
62 * ======== OBD Operations Declarations ===========
66 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
67 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
68 extern int class_rconn2export(struct lustre_handle *conn,
69 struct lustre_handle *rconn);
73 struct lustre_handle exp_rconnh; /* remote connection handle */
74 struct lustre_handle exp_impconnh;
75 struct list_head exp_chain;
76 struct obd_device *exp_obd;
77 struct ptlrpc_connection *exp_connection;
78 struct mds_export_data exp_mds_data;
80 struct ldlm_export_data exp_ldlm_data;
81 struct ost_export_data exp_ost_data;
83 void *exp_data; /* device specific data */
91 struct lustre_handle imp_expconnh;
92 struct list_head imp_chain;
93 struct obd_device *imp_obd;
95 void *imp_data; /* device specific data */
98 static inline int obd_check_conn(struct lustre_handle *conn)
100 struct obd_device *obd;
102 CERROR("NULL conn\n");
105 obd = class_conn2obd(conn);
107 CERROR("NULL obd\n");
111 if (!obd->obd_flags & OBD_ATTACHED ) {
112 CERROR("obd %d not attached\n", obd->obd_minor);
116 if (!obd->obd_flags & OBD_SET_UP) {
117 CERROR("obd %d not setup\n", obd->obd_minor);
121 if (!obd->obd_type) {
122 CERROR("obd %d not typed\n", obd->obd_minor);
126 if (!obd->obd_type->typ_ops) {
127 CERROR("obd_check_conn: obd %d no operations\n",
135 #define OBT(dev) (dev)->obd_type
136 #define OBP(dev,op) (dev)->obd_type->typ_ops->o_ ## op
138 #define OBD_CHECK_SETUP(conn, export) \
141 CERROR("NULL connection\n"); \
145 export = class_conn2export(conn); \
147 CERROR("No export\n"); \
151 if (!((export)->exp_obd->obd_flags & OBD_SET_UP)) { \
152 CERROR("Device %d not setup\n", \
153 (export)->exp_obd->obd_minor); \
158 #define OBD_CHECK_DEVSETUP(obd) \
161 CERROR("NULL device\n"); \
165 if ( !((obd)->obd_flags & OBD_SET_UP) ) { \
166 CERROR("Device %d not setup\n", \
172 #define OBD_CHECK_OP(obd,op) \
174 if (!OBP((obd),op)) { \
175 CERROR("obd_" #op ": dev %d no operation\n", \
177 RETURN(-EOPNOTSUPP); \
181 static inline int obd_get_info(struct lustre_handle *conn, obd_count keylen,
182 void *key, obd_count *vallen, void **val)
185 struct obd_export *export;
186 OBD_CHECK_SETUP(conn, export);
187 OBD_CHECK_OP(export->exp_obd,get_info);
189 rc = OBP(export->exp_obd, get_info)(conn, keylen, key, vallen, val);
193 static inline int obd_set_info(struct lustre_handle *conn, obd_count keylen,
194 void *key, obd_count vallen, void *val)
197 struct obd_export *export;
198 OBD_CHECK_SETUP(conn, export);
199 OBD_CHECK_OP(export->exp_obd,set_info);
201 rc = OBP(export->exp_obd, set_info)(conn, keylen, key, vallen, val);
205 static inline int obd_setup(struct obd_device *obd, int datalen, void *data)
209 OBD_CHECK_OP(obd,setup);
211 rc = OBP(obd, setup)(obd, datalen, data);
215 static inline int obd_cleanup(struct obd_device *obd)
219 OBD_CHECK_DEVSETUP(obd);
220 OBD_CHECK_OP(obd,cleanup);
222 rc = OBP(obd, cleanup)(obd);
226 static inline int obd_create(struct lustre_handle *conn, struct obdo *obdo, struct lov_stripe_md **ea)
229 struct obd_export *export;
230 OBD_CHECK_SETUP(conn, export);
231 OBD_CHECK_OP(export->exp_obd,create);
233 rc = OBP(export->exp_obd, create)(conn, obdo, ea);
237 static inline int obd_destroy(struct lustre_handle *conn, struct obdo *obdo, struct lov_stripe_md *ea)
240 struct obd_export *export;
241 OBD_CHECK_SETUP(conn, export);
242 OBD_CHECK_OP(export->exp_obd,destroy);
244 rc = OBP(export->exp_obd, destroy)(conn, obdo, ea);
248 static inline int obd_getattr(struct lustre_handle *conn,
250 struct lov_stripe_md *ea)
253 struct obd_export *export;
254 OBD_CHECK_SETUP(conn, export);
255 OBD_CHECK_OP(export->exp_obd,getattr);
257 rc = OBP(export->exp_obd, getattr)(conn, obdo, ea);
261 static inline int obd_close(struct lustre_handle *conn, struct obdo *obdo, struct lov_stripe_md *md)
264 struct obd_export *export;
265 OBD_CHECK_SETUP(conn, export);
266 OBD_CHECK_OP(export->exp_obd,close);
268 rc = OBP(export->exp_obd, close)(conn, obdo, md);
271 static inline int obd_open(struct lustre_handle *conn, struct obdo *obdo,
272 struct lov_stripe_md *md)
275 struct obd_export *export;
276 OBD_CHECK_SETUP(conn, export);
277 OBD_CHECK_OP(export->exp_obd,open);
279 rc = OBP(export->exp_obd, open) (conn, obdo, md);
283 static inline int obd_setattr(struct lustre_handle *conn,
285 struct lov_stripe_md *ea)
288 struct obd_export *export;
289 OBD_CHECK_SETUP(conn, export);
290 OBD_CHECK_OP(export->exp_obd,setattr);
292 rc = OBP(export->exp_obd, setattr)(conn, obdo, ea);
296 static inline int obd_connect(struct lustre_handle *conn, struct obd_device *obd,
300 OBD_CHECK_DEVSETUP(obd);
301 OBD_CHECK_OP(obd,connect);
303 rc = OBP(obd, connect)(conn, obd, cluuid);
307 static inline int obd_disconnect(struct lustre_handle *conn)
310 struct obd_export *export;
311 OBD_CHECK_SETUP(conn, export);
312 OBD_CHECK_OP(export->exp_obd,disconnect);
314 rc = OBP(export->exp_obd, disconnect)(conn);
318 static inline int obd_statfs(struct lustre_handle *conn, struct statfs *buf)
321 struct obd_export *export;
322 OBD_CHECK_SETUP(conn, export);
323 OBD_CHECK_OP(export->exp_obd,statfs);
325 rc = OBP(export->exp_obd, statfs)(conn, buf);
329 static inline int obd_punch(struct lustre_handle *conn, struct obdo *tgt,
330 struct lov_stripe_md *md,
331 obd_size count, obd_off offset)
334 struct obd_export *export;
335 OBD_CHECK_SETUP(conn, export);
336 OBD_CHECK_OP(export->exp_obd,punch);
338 rc = OBP(export->exp_obd, punch)(conn, tgt, md, count, offset);
342 static inline int obd_brw(int cmd, struct lustre_handle *conn,
343 struct lov_stripe_md *md,
349 brw_callback_t callback, void *data)
352 struct obd_export *export;
353 OBD_CHECK_SETUP(conn, export);
354 OBD_CHECK_OP(export->exp_obd,brw);
356 if (!(cmd & OBD_BRW_RWMASK)) {
357 CERROR("obd_brw: cmd must be OBD_BRW_READ or OBD_BRW_WRITE\n");
361 rc = OBP(export->exp_obd, brw)(cmd, conn, md, oa_bufs, buf,
362 count, offset, flags, callback, data);
366 static inline int obd_preprw(int cmd, struct lustre_handle *conn,
367 int objcount, struct obd_ioobj *obj,
368 int niocount, struct niobuf_remote *remote,
369 struct niobuf_local *local, void **desc_private)
372 struct obd_export *export;
373 OBD_CHECK_SETUP(conn, export);
374 OBD_CHECK_OP(export->exp_obd,preprw);
376 rc = OBP(export->exp_obd, preprw)(cmd, conn, objcount, obj, niocount,
377 remote, local, desc_private);
381 static inline int obd_commitrw(int cmd, struct lustre_handle *conn,
382 int objcount, struct obd_ioobj *obj,
383 int niocount, struct niobuf_local *local,
387 struct obd_export *export;
388 OBD_CHECK_SETUP(conn, export);
389 OBD_CHECK_OP(export->exp_obd,commitrw);
391 rc = OBP(export->exp_obd, commitrw)(cmd, conn, objcount, obj, niocount,
392 local, desc_private);
396 static inline int obd_iocontrol(int cmd, struct lustre_handle *conn,
397 int len, void *karg, void *uarg)
400 struct obd_export *export;
401 OBD_CHECK_SETUP(conn, export);
402 OBD_CHECK_OP(export->exp_obd,iocontrol);
404 rc = OBP(export->exp_obd, iocontrol)(cmd, conn, len, karg, uarg);
408 static inline int obd_enqueue(struct lustre_handle *conn,
409 struct lustre_handle *parent_lock, __u64 *res_id,
410 __u32 type, void *cookie, int cookielen,
411 __u32 mode, int *flags, void *cb, void *data,
412 int datalen, struct lustre_handle *lockh)
415 struct obd_export *export;
416 OBD_CHECK_SETUP(conn, export);
417 OBD_CHECK_OP(export->exp_obd,enqueue);
419 rc = OBP(export->exp_obd, enqueue)(conn, parent_lock, res_id, type,
420 cookie, cookielen, mode, flags, cb,
421 data, datalen, lockh);
425 static inline int obd_cancel(struct lustre_handle *conn, __u32 mode,
426 struct lustre_handle *lockh)
429 struct obd_export *export;
430 OBD_CHECK_SETUP(conn, export);
431 OBD_CHECK_OP(export->exp_obd,cancel);
433 rc = OBP(export->exp_obd, cancel)(conn, mode, lockh);
440 * ======== OBD Metadata Support ===========
443 extern int obd_init_caches(void);
444 extern void obd_cleanup_caches(void);
446 static inline int obdo_has_inline(struct obdo *obdo)
448 return (obdo->o_valid & OBD_MD_FLINLINE &&
449 obdo->o_obdflags & OBD_FL_INLINEDATA);
453 /* support routines */
454 extern kmem_cache_t *obdo_cachep;
455 static inline struct obdo *obdo_alloc(void)
457 struct obdo *oa = NULL;
459 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
462 memset(oa, 0, sizeof (*oa));
466 static inline void obdo_free(struct obdo *oa)
470 kmem_cache_free(obdo_cachep, oa);
474 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
476 unsigned int ia_valid = attr->ia_valid;
478 if (ia_valid & ATTR_ATIME) {
479 oa->o_atime = attr->ia_atime;
480 oa->o_valid |= OBD_MD_FLATIME;
482 if (ia_valid & ATTR_MTIME) {
483 oa->o_mtime = attr->ia_mtime;
484 oa->o_valid |= OBD_MD_FLMTIME;
486 if (ia_valid & ATTR_CTIME) {
487 oa->o_ctime = attr->ia_ctime;
488 oa->o_valid |= OBD_MD_FLCTIME;
490 if (ia_valid & ATTR_SIZE) {
491 oa->o_size = attr->ia_size;
492 oa->o_valid |= OBD_MD_FLSIZE;
494 if (ia_valid & ATTR_MODE) {
495 oa->o_mode = attr->ia_mode;
496 oa->o_valid |= OBD_MD_FLMODE;
497 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
498 oa->o_mode &= ~S_ISGID;
500 if (ia_valid & ATTR_UID)
502 oa->o_uid = attr->ia_uid;
503 oa->o_valid |= OBD_MD_FLUID;
505 if (ia_valid & ATTR_GID) {
506 oa->o_gid = attr->ia_gid;
507 oa->o_valid |= OBD_MD_FLGID;
512 static inline void iattr_from_obdo(struct iattr *attr, struct obdo *oa)
514 unsigned int ia_valid = oa->o_valid;
516 memset(attr, 0, sizeof(*attr));
517 if (ia_valid & OBD_MD_FLATIME) {
518 attr->ia_atime = oa->o_atime;
519 attr->ia_valid |= ATTR_ATIME;
521 if (ia_valid & OBD_MD_FLMTIME) {
522 attr->ia_mtime = oa->o_mtime;
523 attr->ia_valid |= ATTR_MTIME;
525 if (ia_valid & OBD_MD_FLCTIME) {
526 attr->ia_ctime = oa->o_ctime;
527 attr->ia_valid |= ATTR_CTIME;
529 if (ia_valid & OBD_MD_FLSIZE) {
530 attr->ia_size = oa->o_size;
531 attr->ia_valid |= ATTR_SIZE;
533 if (ia_valid & OBD_MD_FLMODE) {
534 attr->ia_mode = oa->o_mode;
535 attr->ia_valid |= ATTR_MODE;
536 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
537 attr->ia_mode &= ~S_ISGID;
539 if (ia_valid & OBD_MD_FLUID)
541 attr->ia_uid = oa->o_uid;
542 attr->ia_valid |= ATTR_UID;
544 if (ia_valid & OBD_MD_FLGID) {
545 attr->ia_gid = oa->o_gid;
546 attr->ia_valid |= ATTR_GID;
551 /* WARNING: the file systems must take care not to tinker with
552 attributes they don't manage (such as blocks). */
554 static inline void obdo_from_inode(struct obdo *dst, struct inode *src)
556 if ( dst->o_valid & OBD_MD_FLID )
557 dst->o_id = src->i_ino;
558 if ( dst->o_valid & OBD_MD_FLATIME )
559 dst->o_atime = src->i_atime;
560 if ( dst->o_valid & OBD_MD_FLMTIME )
561 dst->o_mtime = src->i_mtime;
562 if ( dst->o_valid & OBD_MD_FLCTIME )
563 dst->o_ctime = src->i_ctime;
564 if ( dst->o_valid & OBD_MD_FLSIZE )
565 dst->o_size = src->i_size;
566 if ( dst->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
567 dst->o_blocks = src->i_blocks;
568 if ( dst->o_valid & OBD_MD_FLBLKSZ )
569 dst->o_blksize = src->i_blksize;
570 if ( dst->o_valid & OBD_MD_FLMODE )
571 dst->o_mode = src->i_mode;
572 if ( dst->o_valid & OBD_MD_FLUID )
573 dst->o_uid = src->i_uid;
574 if ( dst->o_valid & OBD_MD_FLGID )
575 dst->o_gid = src->i_gid;
576 if ( dst->o_valid & OBD_MD_FLFLAGS )
577 dst->o_flags = src->i_flags;
578 if ( dst->o_valid & OBD_MD_FLNLINK )
579 dst->o_nlink = src->i_nlink;
580 if ( dst->o_valid & OBD_MD_FLGENER )
581 dst->o_generation = src->i_generation;
582 if ( dst->o_valid & OBD_MD_FLRDEV )
583 dst->o_rdev = src->i_rdev;
586 static inline void obdo_to_inode(struct inode *dst, struct obdo *src)
589 if ( src->o_valid & OBD_MD_FLID )
590 dst->i_ino = src->o_id;
591 if ( src->o_valid & OBD_MD_FLATIME )
592 dst->i_atime = src->o_atime;
593 if ( src->o_valid & OBD_MD_FLMTIME )
594 dst->i_mtime = src->o_mtime;
595 if ( src->o_valid & OBD_MD_FLCTIME )
596 dst->i_ctime = src->o_ctime;
597 if ( src->o_valid & OBD_MD_FLSIZE )
598 dst->i_size = src->o_size;
599 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
600 dst->i_blocks = src->o_blocks;
601 if ( src->o_valid & OBD_MD_FLBLKSZ )
602 dst->i_blksize = src->o_blksize;
603 if ( src->o_valid & OBD_MD_FLMODE )
604 dst->i_mode = src->o_mode;
605 if ( src->o_valid & OBD_MD_FLUID )
606 dst->i_uid = src->o_uid;
607 if ( src->o_valid & OBD_MD_FLGID )
608 dst->i_gid = src->o_gid;
609 if ( src->o_valid & OBD_MD_FLFLAGS )
610 dst->i_flags = src->o_flags;
611 if ( src->o_valid & OBD_MD_FLNLINK )
612 dst->i_nlink = src->o_nlink;
613 if ( src->o_valid & OBD_MD_FLGENER )
614 dst->i_generation = src->o_generation;
615 if ( src->o_valid & OBD_MD_FLRDEV )
616 dst->i_rdev = src->o_rdev;
621 static inline void obdo_cpy_md(struct obdo *dst, struct obdo *src)
624 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
625 (unsigned long long)src->o_id, src->o_valid,
626 (unsigned long long)dst->o_id);
628 if ( src->o_valid & OBD_MD_FLATIME )
629 dst->o_atime = src->o_atime;
630 if ( src->o_valid & OBD_MD_FLMTIME )
631 dst->o_mtime = src->o_mtime;
632 if ( src->o_valid & OBD_MD_FLCTIME )
633 dst->o_ctime = src->o_ctime;
634 if ( src->o_valid & OBD_MD_FLSIZE )
635 dst->o_size = src->o_size;
636 if ( src->o_valid & OBD_MD_FLBLOCKS ) /* allocation of space */
637 dst->o_blocks = src->o_blocks;
638 if ( src->o_valid & OBD_MD_FLBLKSZ )
639 dst->o_blksize = src->o_blksize;
640 if ( src->o_valid & OBD_MD_FLMODE )
641 dst->o_mode = src->o_mode;
642 if ( src->o_valid & OBD_MD_FLUID )
643 dst->o_uid = src->o_uid;
644 if ( src->o_valid & OBD_MD_FLGID )
645 dst->o_gid = src->o_gid;
646 if ( src->o_valid & OBD_MD_FLFLAGS )
647 dst->o_flags = src->o_flags;
649 if ( src->o_valid & OBD_MD_FLOBDFLG )
650 dst->o_obdflags = src->o_obdflags;
652 if ( src->o_valid & OBD_MD_FLNLINK )
653 dst->o_nlink = src->o_nlink;
654 if ( src->o_valid & OBD_MD_FLGENER )
655 dst->o_generation = src->o_generation;
656 if ( src->o_valid & OBD_MD_FLRDEV )
657 dst->o_rdev = src->o_rdev;
658 if ( src->o_valid & OBD_MD_FLINLINE &&
659 src->o_obdflags & OBD_FL_INLINEDATA) {
660 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
661 dst->o_obdflags |= OBD_FL_INLINEDATA;
664 dst->o_valid |= src->o_valid;
668 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
669 static inline int obdo_cmp_md(struct obdo *dst, struct obdo *src,
674 if ( compare & OBD_MD_FLATIME )
675 res = (res || (dst->o_atime != src->o_atime));
676 if ( compare & OBD_MD_FLMTIME )
677 res = (res || (dst->o_mtime != src->o_mtime));
678 if ( compare & OBD_MD_FLCTIME )
679 res = (res || (dst->o_ctime != src->o_ctime));
680 if ( compare & OBD_MD_FLSIZE )
681 res = (res || (dst->o_size != src->o_size));
682 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
683 res = (res || (dst->o_blocks != src->o_blocks));
684 if ( compare & OBD_MD_FLBLKSZ )
685 res = (res || (dst->o_blksize != src->o_blksize));
686 if ( compare & OBD_MD_FLMODE )
687 res = (res || (dst->o_mode != src->o_mode));
688 if ( compare & OBD_MD_FLUID )
689 res = (res || (dst->o_uid != src->o_uid));
690 if ( compare & OBD_MD_FLGID )
691 res = (res || (dst->o_gid != src->o_gid));
692 if ( compare & OBD_MD_FLFLAGS )
693 res = (res || (dst->o_flags != src->o_flags));
694 if ( compare & OBD_MD_FLNLINK )
695 res = (res || (dst->o_nlink != src->o_nlink));
696 if ( compare & OBD_MD_FLGENER )
697 res = (res || (dst->o_generation != src->o_generation));
698 /* XXX Don't know if thses should be included here - wasn't previously
699 if ( compare & OBD_MD_FLINLINE )
700 res = (res || memcmp(dst->o_inline, src->o_inline));
707 int class_register_type(struct obd_ops *ops, char *nm);
708 int class_unregister_type(char *nm);
709 int class_name2dev(char *name);
710 int class_uuid2dev(char *name);
711 struct obd_device *class_uuid2obd(char *name);
712 struct obd_export *class_new_export(struct obd_device *obddev);
713 int class_connect(struct lustre_handle *conn, struct obd_device *obd,
715 int class_disconnect(struct lustre_handle *conn);
716 struct obd_export *class_conn2export(struct lustre_handle *);
718 /* generic operations shared by various OBD types */
719 int class_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
720 int class_multi_cleanup(struct obd_device *obddev);
726 extern void obd_sysctl_init (void);
727 extern void obd_sysctl_clean (void);
729 #endif /* __LINUX_CLASS_OBD_H */