Whamcloud - gitweb
LU-12635 build: Support for gcc -Wimplicit-fallthrough
[fs/lustre-release.git] / 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  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/osd/osd_oi.h
33  *
34  * OSD Object Index
35  *
36  * Author: Nikita Danilov <nikita@clusterfs.com>
37  */
38
39 /*
40  * Object Index (oi) service runs in the bottom layer of server stack. In
41  * translates fid local to this service to the storage cookie that uniquely
42  * and efficiently identifies object (inode) of the underlying file system.
43  */
44
45 #ifndef _OSD_OI_H
46 #define _OSD_OI_H
47
48
49 /* struct rw_semaphore */
50 #include <linux/rwsem.h>
51 #include <linux/jbd2.h>
52 #include <lustre_fid.h>
53 #include <lu_object.h>
54 #include <md_object.h>
55
56 #define OSD_OI_FID_OID_BITS     6
57 #define OSD_OI_FID_NR           (1UL << OSD_OI_FID_OID_BITS)
58 #define OSD_OII_NOGEN           (0)
59
60 struct lu_fid;
61 struct osd_thread_info;
62 struct lu_site;
63
64 struct dt_device;
65 struct osd_device;
66 struct osd_oi;
67
68 /*
69  * Storage cookie. Datum uniquely identifying inode on the underlying file
70  * system.
71  *
72  * osd_inode_id is the internal ldiskfs identifier for an object. It should
73  * not be visible outside of the osd-ldiskfs. Other OSDs may have different
74  * identifiers, so this cannot form any part of the OSD API.
75  */
76 struct osd_inode_id {
77         __u32 oii_ino; /* inode number */
78         __u32 oii_gen; /* inode generation */
79 };
80
81 /* OI cache entry */
82 struct osd_idmap_cache {
83         struct lu_fid           oic_fid;
84         struct osd_inode_id     oic_lid;
85         struct osd_device       *oic_dev;
86         __u16                   oic_remote:1;   /* FID isn't local */
87 };
88
89 static inline void osd_id_pack(struct osd_inode_id *tgt,
90                                const struct osd_inode_id *src)
91 {
92         tgt->oii_ino = cpu_to_be32(src->oii_ino);
93         tgt->oii_gen = cpu_to_be32(src->oii_gen);
94 }
95
96 static inline void osd_id_unpack(struct osd_inode_id *tgt,
97                                  struct osd_inode_id *src)
98 {
99         tgt->oii_ino = be32_to_cpu(src->oii_ino);
100         tgt->oii_gen = be32_to_cpu(src->oii_gen);
101 }
102
103 static inline void osd_id_gen(struct osd_inode_id *id, __u32 ino, __u32 gen)
104 {
105         id->oii_ino = ino;
106         id->oii_gen = gen;
107 }
108
109 static inline void osd_id_to_inode(struct inode *inode,
110                                    const struct osd_inode_id *id)
111 {
112         inode->i_ino        = id->oii_ino;
113         inode->i_generation = id->oii_gen;
114 }
115
116 static inline int osd_id_eq(const struct osd_inode_id *id0,
117                             const struct osd_inode_id *id1)
118 {
119         return (id0->oii_ino == id1->oii_ino) &&
120                (id0->oii_gen == id1->oii_gen ||
121                 id0->oii_gen == OSD_OII_NOGEN ||
122                 id1->oii_gen == OSD_OII_NOGEN);
123 }
124
125 static inline int osd_id_eq_strict(const struct osd_inode_id *id0,
126                                    const struct osd_inode_id *id1)
127 {
128         return (id0->oii_ino == id1->oii_ino && id0->oii_gen == id1->oii_gen);
129 }
130
131 enum oi_check_flags {
132         OI_CHECK_FLD    = 0x00000001,
133         OI_KNOWN_ON_OST = 0x00000002,
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 */