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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * lustre/osd/osd_oi.h
  32  *
  33  * OSD Object Index
  34  *
  35  * Author: Nikita Danilov <nikita@clusterfs.com>
  36  */
  37
  38 /*
  39  * Object Index (oi) service runs in the bottom layer of server stack. In
  40  * translates fid local to this service to the storage cookie that uniquely
  41  * and efficiently identifies object (inode) of the underlying file system.
  42  */
  43
  44 #ifndef _OSD_OI_H
  45 #define _OSD_OI_H
  46
  47
  48 /* struct rw_semaphore */
  49 #include <linux/rwsem.h>
  50 #include <linux/jbd2.h>
  51 #include <lustre_fid.h>
  52 #include <lu_object.h>
  53 #include <md_object.h>
  54
  55 #define OSD_OI_FID_OID_BITS     6
  56 #define OSD_OI_FID_NR           (1UL << OSD_OI_FID_OID_BITS)
  57 #define OSD_OII_NOGEN           (0)
  58
  59 struct lu_fid;
  60 struct osd_thread_info;
  61 struct lu_site;
  62
  63 struct dt_device;
  64 struct osd_device;
  65 struct osd_oi;
  66
  67 /*
  68  * Storage cookie. Datum uniquely identifying inode on the underlying file
  69  * system.
  70  *
  71  * osd_inode_id is the internal ldiskfs identifier for an object. It should
  72  * not be visible outside of the osd-ldiskfs. Other OSDs may have different
  73  * identifiers, so this cannot form any part of the OSD API.
  74  */
  75 struct osd_inode_id {
  76         __u32 oii_ino; /* inode number */
  77         __u32 oii_gen; /* inode generation */
  78 };
  79
  80 /* OI cache entry */
  81 struct osd_idmap_cache {
  82         struct lu_fid           oic_fid;
  83         struct osd_inode_id     oic_lid;
  84         struct osd_device       *oic_dev;
  85         __u16                   oic_remote:1;   /* FID isn't local */
  86 };
  87
  88 static inline void osd_id_pack(struct osd_inode_id *tgt,
  89                                const struct osd_inode_id *src)
  90 {
  91         tgt->oii_ino = cpu_to_be32(src->oii_ino);
  92         tgt->oii_gen = cpu_to_be32(src->oii_gen);
  93 }
  94
  95 static inline void osd_id_unpack(struct osd_inode_id *tgt,
  96                                  struct osd_inode_id *src)
  97 {
  98         tgt->oii_ino = be32_to_cpu(src->oii_ino);
  99         tgt->oii_gen = be32_to_cpu(src->oii_gen);
 100 }
 101
 102 static inline void osd_id_gen(struct osd_inode_id *id, __u32 ino, __u32 gen)
 103 {
 104         id->oii_ino = ino;
 105         id->oii_gen = gen;
 106 }
 107
 108 static inline void osd_id_to_inode(struct inode *inode,
 109                                    const struct osd_inode_id *id)
 110 {
 111         inode->i_ino        = id->oii_ino;
 112         inode->i_generation = id->oii_gen;
 113 }
 114
 115 static inline int osd_id_eq(const struct osd_inode_id *id0,
 116                             const struct osd_inode_id *id1)
 117 {
 118         return (id0->oii_ino == id1->oii_ino) &&
 119                (id0->oii_gen == id1->oii_gen ||
 120                 id0->oii_gen == OSD_OII_NOGEN ||
 121                 id1->oii_gen == OSD_OII_NOGEN);
 122 }
 123
 124 static inline int osd_id_eq_strict(const struct osd_inode_id *id0,
 125                                    const struct osd_inode_id *id1)
 126 {
 127         return (id0->oii_ino == id1->oii_ino && id0->oii_gen == id1->oii_gen);
 128 }
 129
 130 enum oi_check_flags {
 131         OI_CHECK_FLD    = 0x00000001,
 132         OI_KNOWN_ON_OST = 0x00000002,
 133         OI_LOCKED       = 0x00000004,
 134 };
 135
 136 extern unsigned int osd_oi_count;
 137
 138 int osd_oi_mod_init(void);
 139 int osd_oi_init(struct osd_thread_info *info, struct osd_device *osd,
 140                 bool restored);
 141 void osd_oi_fini(struct osd_thread_info *info, struct osd_device *osd);
 142 int  osd_oi_lookup(struct osd_thread_info *info, struct osd_device *osd,
 143                    const struct lu_fid *fid, struct osd_inode_id *id,
 144                    enum oi_check_flags flags);
 145 int  osd_oi_insert(struct osd_thread_info *info, struct osd_device *osd,
 146                    const struct lu_fid *fid, const struct osd_inode_id *id,
 147                    handle_t *th, enum oi_check_flags flags, bool *exist);
 148 int  osd_oi_delete(struct osd_thread_info *info,
 149                    struct osd_device *osd, const struct lu_fid *fid,
 150                    handle_t *th, enum oi_check_flags flags);
 151 int  osd_oi_update(struct osd_thread_info *info, struct osd_device *osd,
 152                    const struct lu_fid *fid, const struct osd_inode_id *id,
 153                    handle_t *th, enum oi_check_flags flags);
 154
 155 int fid_is_on_ost(struct osd_thread_info *info, struct osd_device *osd,
 156                   const struct lu_fid *fid, enum oi_check_flags flags);
 157 #endif /* _OSD_OI_H */