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>
43 #include <linux/lustre_dlm.h>
48 * ======== OBD Device Declarations ===========
50 #define MAX_OBD_DEVICES 128
51 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
53 #define OBD_ATTACHED 0x1
54 #define OBD_SET_UP 0x2
56 extern struct proc_dir_entry *
57 proc_lustre_register_obd_device(struct obd_device *obd);
58 extern void proc_lustre_release_obd_device(struct obd_device *obd);
59 extern void proc_lustre_remove_obd_entry(const char* name,
60 struct obd_device *obd);
63 * ======== OBD Operations Declarations ===========
67 static inline int obd_check_conn(struct lustre_handle *conn)
69 struct obd_device *obd;
71 CERROR("NULL conn\n");
74 obd = class_conn2obd(conn);
80 if (!obd->obd_flags & OBD_ATTACHED ) {
81 CERROR("obd %d not attached\n", obd->obd_minor);
85 if (!obd->obd_flags & OBD_SET_UP) {
86 CERROR("obd %d not setup\n", obd->obd_minor);
91 CERROR("obd %d not typed\n", obd->obd_minor);
95 if (!obd->obd_type->typ_ops) {
96 CERROR("obd_check_conn: obd %d no operations\n",
104 #define OBT(dev) (dev)->obd_type
105 #define OBP(dev,op) (dev)->obd_type->typ_ops->o_ ## op
107 #define OBD_CHECK_SETUP(conn, export) \
110 CERROR("NULL connection\n"); \
114 export = class_conn2export(conn); \
116 CERROR("No export\n"); \
120 if (!((export)->exp_obd->obd_flags & OBD_SET_UP)) { \
121 CERROR("Device %d not setup\n", \
122 (export)->exp_obd->obd_minor); \
127 #define OBD_CHECK_DEVSETUP(obd) \
130 CERROR("NULL device\n"); \
134 if ( !((obd)->obd_flags & OBD_SET_UP) ) { \
135 CERROR("Device %d not setup\n", \
141 #define OBD_CHECK_OP(obd,op) \
143 if (!OBP((obd),op)) { \
144 CERROR("obd_" #op ": dev %d no operation\n", \
146 RETURN(-EOPNOTSUPP); \
150 static inline int obd_get_info(struct lustre_handle *conn, obd_count keylen,
151 void *key, obd_count *vallen, void **val)
154 struct obd_export *export;
155 OBD_CHECK_SETUP(conn, export);
156 OBD_CHECK_OP(export->exp_obd,get_info);
158 rc = OBP(export->exp_obd, get_info)(conn, keylen, key, vallen, val);
162 static inline int obd_set_info(struct lustre_handle *conn, obd_count keylen,
163 void *key, obd_count vallen, void *val)
166 struct obd_export *export;
167 OBD_CHECK_SETUP(conn, export);
168 OBD_CHECK_OP(export->exp_obd,set_info);
170 rc = OBP(export->exp_obd, set_info)(conn, keylen, key, vallen, val);
174 static inline int obd_setup(struct obd_device *obd, int datalen, void *data)
178 OBD_CHECK_OP(obd,setup);
180 rc = OBP(obd, setup)(obd, datalen, data);
184 static inline int obd_cleanup(struct obd_device *obd)
188 OBD_CHECK_DEVSETUP(obd);
189 OBD_CHECK_OP(obd,cleanup);
191 rc = OBP(obd, cleanup)(obd);
195 static inline int obd_create(struct lustre_handle *conn, struct obdo *obdo,
196 struct lov_stripe_md **ea)
199 struct obd_export *export;
200 OBD_CHECK_SETUP(conn, export);
201 OBD_CHECK_OP(export->exp_obd,create);
203 #define OBD_MD_FLNEEDED (OBD_MD_FLID | OBD_MD_FLMODE)
204 //if (obdo->o_valid & OBD_MD_FLNEEDED != OBD_MD_FLNEEDED)
206 #undef OBD_MD_FLNEEDED
207 rc = OBP(export->exp_obd, create)(conn, obdo, ea);
211 static inline int obd_destroy(struct lustre_handle *conn, struct obdo *obdo,
212 struct lov_stripe_md *ea)
215 struct obd_export *export;
216 OBD_CHECK_SETUP(conn, export);
217 OBD_CHECK_OP(export->exp_obd,destroy);
219 rc = OBP(export->exp_obd, destroy)(conn, obdo, ea);
223 static inline int obd_getattr(struct lustre_handle *conn, struct obdo *obdo,
224 struct lov_stripe_md *ea)
227 struct obd_export *export;
228 OBD_CHECK_SETUP(conn, export);
229 OBD_CHECK_OP(export->exp_obd,getattr);
231 rc = OBP(export->exp_obd, getattr)(conn, obdo, ea);
235 static inline int obd_close(struct lustre_handle *conn, struct obdo *obdo,
236 struct lov_stripe_md *md)
239 struct obd_export *export;
240 OBD_CHECK_SETUP(conn, export);
241 OBD_CHECK_OP(export->exp_obd,close);
243 rc = OBP(export->exp_obd, close)(conn, obdo, md);
246 static inline int obd_open(struct lustre_handle *conn, struct obdo *obdo,
247 struct lov_stripe_md *md)
250 struct obd_export *export;
251 OBD_CHECK_SETUP(conn, export);
252 OBD_CHECK_OP(export->exp_obd,open);
254 rc = OBP(export->exp_obd, open) (conn, obdo, md);
258 static inline int obd_setattr(struct lustre_handle *conn, struct obdo *obdo,
259 struct lov_stripe_md *ea)
262 struct obd_export *export;
263 OBD_CHECK_SETUP(conn, export);
264 OBD_CHECK_OP(export->exp_obd,setattr);
266 rc = OBP(export->exp_obd, setattr)(conn, obdo, ea);
270 static inline int obd_connect(struct lustre_handle *conn, struct obd_device *obd,
274 OBD_CHECK_DEVSETUP(obd);
275 OBD_CHECK_OP(obd,connect);
277 rc = OBP(obd, connect)(conn, obd, cluuid);
281 static inline int obd_disconnect(struct lustre_handle *conn)
284 struct obd_export *export;
285 OBD_CHECK_SETUP(conn, export);
286 OBD_CHECK_OP(export->exp_obd,disconnect);
288 rc = OBP(export->exp_obd, disconnect)(conn);
292 static inline int obd_statfs(struct lustre_handle *conn,struct obd_statfs *osfs)
295 struct obd_export *export;
296 OBD_CHECK_SETUP(conn, export);
297 OBD_CHECK_OP(export->exp_obd,statfs);
299 rc = OBP(export->exp_obd, statfs)(conn, osfs);
303 static inline int obd_punch(struct lustre_handle *conn, struct obdo *tgt,
304 struct lov_stripe_md *ea,
305 obd_size count, obd_off offset)
308 struct obd_export *export;
309 OBD_CHECK_SETUP(conn, export);
310 OBD_CHECK_OP(export->exp_obd,punch);
312 rc = OBP(export->exp_obd, punch)(conn, tgt, ea, count, offset);
316 static inline int obd_brw(int cmd, struct lustre_handle *conn,
317 struct lov_stripe_md *ea, obd_count oa_bufs,
319 brw_callback_t callback, void *data)
322 struct obd_export *export;
323 OBD_CHECK_SETUP(conn, export);
324 OBD_CHECK_OP(export->exp_obd,brw);
326 if (!(cmd & OBD_BRW_RWMASK)) {
327 CERROR("obd_brw: cmd must be OBD_BRW_READ or OBD_BRW_WRITE\n");
331 rc = OBP(export->exp_obd, brw)(cmd, conn, ea, oa_bufs, pg, callback,
336 static inline int obd_preprw(int cmd, struct lustre_handle *conn,
337 int objcount, struct obd_ioobj *obj,
338 int niocount, struct niobuf_remote *remote,
339 struct niobuf_local *local, void **desc_private)
342 struct obd_export *export;
343 OBD_CHECK_SETUP(conn, export);
344 OBD_CHECK_OP(export->exp_obd,preprw);
346 rc = OBP(export->exp_obd, preprw)(cmd, conn, objcount, obj, niocount,
347 remote, local, desc_private);
351 static inline int obd_commitrw(int cmd, struct lustre_handle *conn,
352 int objcount, struct obd_ioobj *obj,
353 int niocount, struct niobuf_local *local,
357 struct obd_export *export;
358 OBD_CHECK_SETUP(conn, export);
359 OBD_CHECK_OP(export->exp_obd,commitrw);
361 rc = OBP(export->exp_obd, commitrw)(cmd, conn, objcount, obj, niocount,
362 local, desc_private);
366 static inline int obd_iocontrol(int cmd, struct lustre_handle *conn,
367 int len, void *karg, void *uarg)
370 struct obd_export *export;
371 OBD_CHECK_SETUP(conn, export);
372 OBD_CHECK_OP(export->exp_obd,iocontrol);
374 rc = OBP(export->exp_obd, iocontrol)(cmd, conn, len, karg, uarg);
378 static inline int obd_enqueue(struct lustre_handle *conn,
379 struct lov_stripe_md *ea,
380 struct lustre_handle *parent_lock,
381 __u32 type, void *cookie, int cookielen,
382 __u32 mode, int *flags, void *cb, void *data,
383 int datalen, struct lustre_handle *lockh)
386 struct obd_export *export;
387 OBD_CHECK_SETUP(conn, export);
388 OBD_CHECK_OP(export->exp_obd,enqueue);
390 rc = OBP(export->exp_obd, enqueue)(conn, ea, parent_lock, type,
391 cookie, cookielen, mode, flags, cb,
392 data, datalen, lockh);
396 static inline int obd_cancel(struct lustre_handle *conn,
397 struct lov_stripe_md *ea, __u32 mode,
398 struct lustre_handle *lockh)
401 struct obd_export *export;
402 OBD_CHECK_SETUP(conn, export);
403 OBD_CHECK_OP(export->exp_obd,cancel);
405 rc = OBP(export->exp_obd, cancel)(conn, ea, mode, lockh);
409 static inline int obd_cancel_unused(struct lustre_handle *conn,
410 struct lov_stripe_md *lsm)
413 struct obd_export *export;
414 OBD_CHECK_SETUP(conn, export);
415 OBD_CHECK_OP(export->exp_obd, cancel_unused);
417 rc = OBP(export->exp_obd, cancel_unused)(conn, lsm);
424 * ======== OBD Metadata Support ===========
427 extern int obd_init_caches(void);
428 extern void obd_cleanup_caches(void);
430 static inline int obdo_has_inline(struct obdo *obdo)
432 return (obdo->o_valid & OBD_MD_FLINLINE &&
433 obdo->o_obdflags & OBD_FL_INLINEDATA);
437 /* support routines */
438 extern kmem_cache_t *obdo_cachep;
439 static inline struct obdo *obdo_alloc(void)
441 struct obdo *oa = NULL;
443 oa = kmem_cache_alloc(obdo_cachep, SLAB_KERNEL);
446 memset(oa, 0, sizeof (*oa));
450 static inline void obdo_free(struct obdo *oa)
454 kmem_cache_free(obdo_cachep, oa);
458 static inline void obdo_from_iattr(struct obdo *oa, struct iattr *attr)
460 unsigned int ia_valid = attr->ia_valid;
462 if (ia_valid & ATTR_ATIME) {
463 oa->o_atime = attr->ia_atime;
464 oa->o_valid |= OBD_MD_FLATIME;
466 if (ia_valid & ATTR_MTIME) {
467 oa->o_mtime = attr->ia_mtime;
468 oa->o_valid |= OBD_MD_FLMTIME;
470 if (ia_valid & ATTR_CTIME) {
471 oa->o_ctime = attr->ia_ctime;
472 oa->o_valid |= OBD_MD_FLCTIME;
474 if (ia_valid & ATTR_SIZE) {
475 oa->o_size = attr->ia_size;
476 oa->o_valid |= OBD_MD_FLSIZE;
478 if (ia_valid & ATTR_MODE) {
479 oa->o_mode = attr->ia_mode;
480 oa->o_valid |= OBD_MD_FLMODE;
481 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
482 oa->o_mode &= ~S_ISGID;
484 if (ia_valid & ATTR_UID)
486 oa->o_uid = attr->ia_uid;
487 oa->o_valid |= OBD_MD_FLUID;
489 if (ia_valid & ATTR_GID) {
490 oa->o_gid = attr->ia_gid;
491 oa->o_valid |= OBD_MD_FLGID;
496 static inline void iattr_from_obdo(struct iattr *attr, struct obdo *oa,
499 memset(attr, 0, sizeof(*attr));
500 if (valid & OBD_MD_FLATIME) {
501 attr->ia_atime = oa->o_atime;
502 attr->ia_valid |= ATTR_ATIME;
504 if (valid & OBD_MD_FLMTIME) {
505 attr->ia_mtime = oa->o_mtime;
506 attr->ia_valid |= ATTR_MTIME;
508 if (valid & OBD_MD_FLCTIME) {
509 attr->ia_ctime = oa->o_ctime;
510 attr->ia_valid |= ATTR_CTIME;
512 if (valid & OBD_MD_FLSIZE) {
513 attr->ia_size = oa->o_size;
514 attr->ia_valid |= ATTR_SIZE;
516 if (valid & OBD_MD_FLMODE) {
517 attr->ia_mode = oa->o_mode;
518 attr->ia_valid |= ATTR_MODE;
519 if (!in_group_p(oa->o_gid) && !capable(CAP_FSETID))
520 attr->ia_mode &= ~S_ISGID;
522 if (valid & OBD_MD_FLUID)
524 attr->ia_uid = oa->o_uid;
525 attr->ia_valid |= ATTR_UID;
527 if (valid & OBD_MD_FLGID) {
528 attr->ia_gid = oa->o_gid;
529 attr->ia_valid |= ATTR_GID;
534 /* WARNING: the file systems must take care not to tinker with
535 attributes they don't manage (such as blocks). */
537 static inline void obdo_from_inode(struct obdo *dst, struct inode *src,
540 // if (valid & OBD_MD_FLID)
541 // dst->o_id = src->i_ino;
542 if (valid & OBD_MD_FLATIME)
543 dst->o_atime = src->i_atime;
544 if (valid & OBD_MD_FLMTIME)
545 dst->o_mtime = src->i_mtime;
546 if (valid & OBD_MD_FLCTIME)
547 dst->o_ctime = src->i_ctime;
548 if (valid & OBD_MD_FLSIZE)
549 dst->o_size = src->i_size;
550 if (valid & OBD_MD_FLBLOCKS) /* allocation of space */
551 dst->o_blocks = src->i_blocks;
552 if (valid & OBD_MD_FLBLKSZ)
553 dst->o_blksize = src->i_blksize;
554 if (valid & OBD_MD_FLMODE)
555 dst->o_mode = src->i_mode;
556 if (valid & OBD_MD_FLUID)
557 dst->o_uid = src->i_uid;
558 if (valid & OBD_MD_FLGID)
559 dst->o_gid = src->i_gid;
560 if (valid & OBD_MD_FLFLAGS)
561 dst->o_flags = src->i_flags;
562 if (valid & OBD_MD_FLNLINK)
563 dst->o_nlink = src->i_nlink;
564 if (valid & OBD_MD_FLGENER)
565 dst->o_generation = src->i_generation;
566 if (valid & OBD_MD_FLRDEV)
567 dst->o_rdev = src->i_rdev;
569 dst->o_valid |= (valid & ~OBD_MD_FLID);
572 static inline void obdo_to_inode(struct inode *dst, struct obdo *src,
575 // if (valid & OBD_MD_FLID)
576 // dst->i_ino = src->o_id;
577 if (valid & OBD_MD_FLATIME)
578 dst->i_atime = src->o_atime;
579 if (valid & OBD_MD_FLMTIME)
580 dst->i_mtime = src->o_mtime;
581 if (valid & OBD_MD_FLCTIME)
582 dst->i_ctime = src->o_ctime;
583 if (valid & OBD_MD_FLSIZE)
584 dst->i_size = src->o_size;
585 if (valid & OBD_MD_FLBLOCKS) /* allocation of space */
586 dst->i_blocks = src->o_blocks;
587 if (valid & OBD_MD_FLBLKSZ)
588 dst->i_blksize = src->o_blksize;
589 if (valid & OBD_MD_FLMODE)
590 dst->i_mode = src->o_mode;
591 if (valid & OBD_MD_FLUID)
592 dst->i_uid = src->o_uid;
593 if (valid & OBD_MD_FLGID)
594 dst->i_gid = src->o_gid;
595 if (valid & OBD_MD_FLFLAGS)
596 dst->i_flags = src->o_flags;
597 if (valid & OBD_MD_FLNLINK)
598 dst->i_nlink = src->o_nlink;
599 if (valid & OBD_MD_FLGENER)
600 dst->i_generation = src->o_generation;
601 if (valid & OBD_MD_FLRDEV)
602 dst->i_rdev = src->o_rdev;
606 static inline void obdo_cpy_md(struct obdo *dst, struct obdo *src,
610 CDEBUG(D_INODE, "src obdo %Ld valid 0x%x, dst obdo %Ld\n",
611 (unsigned long long)src->o_id, src->o_valid,
612 (unsigned long long)dst->o_id);
614 if (valid & OBD_MD_FLATIME)
615 dst->o_atime = src->o_atime;
616 if (valid & OBD_MD_FLMTIME)
617 dst->o_mtime = src->o_mtime;
618 if (valid & OBD_MD_FLCTIME)
619 dst->o_ctime = src->o_ctime;
620 if (valid & OBD_MD_FLSIZE)
621 dst->o_size = src->o_size;
622 if (valid & OBD_MD_FLBLOCKS) /* allocation of space */
623 dst->o_blocks = src->o_blocks;
624 if (valid & OBD_MD_FLBLKSZ)
625 dst->o_blksize = src->o_blksize;
626 if (valid & OBD_MD_FLMODE)
627 dst->o_mode = src->o_mode;
628 if (valid & OBD_MD_FLUID)
629 dst->o_uid = src->o_uid;
630 if (valid & OBD_MD_FLGID)
631 dst->o_gid = src->o_gid;
632 if (valid & OBD_MD_FLFLAGS)
633 dst->o_flags = src->o_flags;
635 if (valid & OBD_MD_FLOBDFLG)
636 dst->o_obdflags = src->o_obdflags;
638 if (valid & OBD_MD_FLNLINK)
639 dst->o_nlink = src->o_nlink;
640 if (valid & OBD_MD_FLGENER)
641 dst->o_generation = src->o_generation;
642 if (valid & OBD_MD_FLRDEV)
643 dst->o_rdev = src->o_rdev;
644 if (valid & OBD_MD_FLINLINE &&
645 src->o_obdflags & OBD_FL_INLINEDATA) {
646 memcpy(dst->o_inline, src->o_inline, sizeof(src->o_inline));
647 dst->o_obdflags |= OBD_FL_INLINEDATA;
650 dst->o_valid |= valid;
654 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
655 static inline int obdo_cmp_md(struct obdo *dst, struct obdo *src,
660 if ( compare & OBD_MD_FLATIME )
661 res = (res || (dst->o_atime != src->o_atime));
662 if ( compare & OBD_MD_FLMTIME )
663 res = (res || (dst->o_mtime != src->o_mtime));
664 if ( compare & OBD_MD_FLCTIME )
665 res = (res || (dst->o_ctime != src->o_ctime));
666 if ( compare & OBD_MD_FLSIZE )
667 res = (res || (dst->o_size != src->o_size));
668 if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
669 res = (res || (dst->o_blocks != src->o_blocks));
670 if ( compare & OBD_MD_FLBLKSZ )
671 res = (res || (dst->o_blksize != src->o_blksize));
672 if ( compare & OBD_MD_FLMODE )
673 res = (res || (dst->o_mode != src->o_mode));
674 if ( compare & OBD_MD_FLUID )
675 res = (res || (dst->o_uid != src->o_uid));
676 if ( compare & OBD_MD_FLGID )
677 res = (res || (dst->o_gid != src->o_gid));
678 if ( compare & OBD_MD_FLFLAGS )
679 res = (res || (dst->o_flags != src->o_flags));
680 if ( compare & OBD_MD_FLNLINK )
681 res = (res || (dst->o_nlink != src->o_nlink));
682 if ( compare & OBD_MD_FLGENER )
683 res = (res || (dst->o_generation != src->o_generation));
684 /* XXX Don't know if thses should be included here - wasn't previously
685 if ( compare & OBD_MD_FLINLINE )
686 res = (res || memcmp(dst->o_inline, src->o_inline));
693 int class_register_type(struct obd_ops *ops, char *nm);
694 int class_unregister_type(char *nm);
695 int class_name2dev(char *name);
696 int class_uuid2dev(char *name);
697 struct obd_device *class_uuid2obd(char *name);
698 struct obd_export *class_new_export(struct obd_device *obddev);
699 void class_destroy_export(struct obd_export *exp);
700 int class_connect(struct lustre_handle *conn, struct obd_device *obd,
702 int class_disconnect(struct lustre_handle *conn);
703 void class_disconnect_all(struct obd_device *obddev);
705 /* generic operations shared by various OBD types */
706 int class_multi_setup(struct obd_device *obddev, uint32_t len, void *data);
707 int class_multi_cleanup(struct obd_device *obddev);
709 extern void (*class_signal_connection_failure)(struct ptlrpc_connection *);
711 /* == mds_client_free if MDS running here */
712 extern int (*mds_destroy_export)(struct obd_export *exp);
713 /* == ldlm_client_free if(?) DLM running here */
714 extern int (*ldlm_destroy_export)(struct obd_export *exp);
716 static inline struct ptlrpc_connection *class_rd2conn(struct recovd_data *rd)
718 /* reuse list_entry's member-pointer offset stuff */
719 return list_entry(rd, struct ptlrpc_connection, c_recovd_data);
725 extern void obd_sysctl_init (void);
726 extern void obd_sysctl_clean (void);
729 /* XXX - should use uuid_t here, but already defined as char[37] */
730 typedef unsigned char class_uuid_t[16];
731 int class_uuid_parse(char *in, class_uuid_t out);
732 void class_uuid_unparse(class_uuid_t in, char *out);
733 #endif /* __LINUX_CLASS_OBD_H */