lustre/osd-ldiskfs/osd_oi.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/osd/osd_oi.h
  37  *
  38  * OSD Object Index
  39  *
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  */
  42
  43 /*
  44  * Object Index (oi) service runs in the bottom layer of server stack. In
  45  * translates fid local to this service to the storage cookie that uniquely
  46  * and efficiently identifies object (inode) of the underlying file system.
  47  */
  48
  49 #ifndef _OSD_OI_H
  50 #define _OSD_OI_H
  51
  52
  53 /* struct rw_semaphore */
  54 #include <linux/rwsem.h>
  55 #include <linux/jbd2.h>
  56 #include <lustre_fid.h>
  57 #include <lu_object.h>
  58 #include <md_object.h>
  59
  60 #define OSD_OI_FID_NR         (1UL << OSD_OI_FID_OID_BITS)
  61 #define OSD_OI_FID_NR_MAX     (1UL << OSD_OI_FID_OID_BITS_MAX)
  62
  63 #define OSD_OII_NOGEN (0)
  64
  65 struct lu_fid;
  66 struct osd_thread_info;
  67 struct lu_site;
  68
  69 struct dt_device;
  70 struct osd_device;
  71 struct osd_oi;
  72
  73 /*
  74  * Storage cookie. Datum uniquely identifying inode on the underlying file
  75  * system.
  76  *
  77  * osd_inode_id is the internal ldiskfs identifier for an object. It should
  78  * not be visible outside of the osd-ldiskfs. Other OSDs may have different
  79  * identifiers, so this cannot form any part of the OSD API.
  80  */
  81 struct osd_inode_id {
  82         __u32 oii_ino; /* inode number */
  83         __u32 oii_gen; /* inode generation */
  84 };
  85
  86 /* OI cache entry */
  87 struct osd_idmap_cache {
  88         struct lu_fid           oic_fid;
  89         struct osd_inode_id     oic_lid;
  90         struct osd_device       *oic_dev;
  91         __u16                   oic_remote:1;   /* FID isn't local */
  92 };
  93
  94 static inline void osd_id_pack(struct osd_inode_id *tgt,
  95                                const struct osd_inode_id *src)
  96 {
  97         tgt->oii_ino = cpu_to_be32(src->oii_ino);
  98         tgt->oii_gen = cpu_to_be32(src->oii_gen);
  99 }
 100
 101 static inline void osd_id_unpack(struct osd_inode_id *tgt,
 102                                  struct osd_inode_id *src)
 103 {
 104         tgt->oii_ino = be32_to_cpu(src->oii_ino);
 105         tgt->oii_gen = be32_to_cpu(src->oii_gen);
 106 }
 107
 108 static inline void osd_id_gen(struct osd_inode_id *id, __u32 ino, __u32 gen)
 109 {
 110         id->oii_ino = ino;
 111         id->oii_gen = gen;
 112 }
 113
 114 static inline void osd_id_to_inode(struct inode *inode,
 115                                    const struct osd_inode_id *id)
 116 {
 117         inode->i_ino        = id->oii_ino;
 118         inode->i_generation = id->oii_gen;
 119 }
 120
 121 static inline int osd_id_eq(const struct osd_inode_id *id0,
 122                             const struct osd_inode_id *id1)
 123 {
 124         return (id0->oii_ino == id1->oii_ino) &&
 125                (id0->oii_gen == id1->oii_gen ||
 126                 id0->oii_gen == OSD_OII_NOGEN ||
 127                 id1->oii_gen == OSD_OII_NOGEN);
 128 }
 129
 130 static inline int osd_id_eq_strict(const struct osd_inode_id *id0,
 131                                    const struct osd_inode_id *id1)
 132 {
 133         return (id0->oii_ino == id1->oii_ino && id0->oii_gen == id1->oii_gen);
 134 }
 135
 136 enum oi_check_flags {
 137         OI_CHECK_FLD    = 0x00000001,
 138         OI_KNOWN_ON_OST = 0x00000002,
 139 };
 140
 141 int osd_oi_mod_init(void);
 142 int osd_oi_init(struct osd_thread_info *info, struct osd_device *osd,
 143                 bool restored);
 144 void osd_oi_fini(struct osd_thread_info *info, struct osd_device *osd);
 145 int  osd_oi_lookup(struct osd_thread_info *info, struct osd_device *osd,
 146                    const struct lu_fid *fid, struct osd_inode_id *id,
 147                    enum oi_check_flags flags);
 148 int  osd_oi_insert(struct osd_thread_info *info, struct osd_device *osd,
 149                    const struct lu_fid *fid, const struct osd_inode_id *id,
 150                    handle_t *th, enum oi_check_flags flags, bool *exist);
 151 int  osd_oi_delete(struct osd_thread_info *info,
 152                    struct osd_device *osd, const struct lu_fid *fid,
 153                    handle_t *th, enum oi_check_flags flags);
 154 int  osd_oi_update(struct osd_thread_info *info, struct osd_device *osd,
 155                    const struct lu_fid *fid, const struct osd_inode_id *id,
 156                    handle_t *th, enum oi_check_flags flags);
 157
 158 int fid_is_on_ost(struct osd_thread_info *info, struct osd_device *osd,
 159                   const struct lu_fid *fid, enum oi_check_flags flags);
 160 #endif /* _OSD_OI_H */