4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2014, Intel Corporation.
28 * Copyright 2015 Cray Inc, all rights reserved.
31 * Define ost_id associated functions
34 #ifndef _UAPI_LUSTRE_OSTID_H_
35 #define _UAPI_LUSTRE_OSTID_H_
37 #include <linux/errno.h>
39 * This is due to us being out of kernel and the way the OpenSFS branch
43 #include <uapi/linux/lustre/lustre_fid.h>
45 #include <linux/lustre/lustre_fid.h>
48 static inline __u64 lmm_oi_id(const struct ost_id *oi)
53 static inline __u64 lmm_oi_seq(const struct ost_id *oi)
58 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
63 static inline void lmm_oi_set_id(struct ost_id *oi, __u64 oid)
68 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
69 const struct ost_id *src_oi)
71 dst_oi->oi.oi_id = __le64_to_cpu(src_oi->oi.oi_id);
72 dst_oi->oi.oi_seq = __le64_to_cpu(src_oi->oi.oi_seq);
75 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
76 const struct ost_id *src_oi)
78 dst_oi->oi.oi_id = __cpu_to_le64(src_oi->oi.oi_id);
79 dst_oi->oi.oi_seq = __cpu_to_le64(src_oi->oi.oi_seq);
82 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
83 static inline __u64 ostid_seq(const struct ost_id *ostid)
85 if (fid_seq_is_mdt0(ostid->oi.oi_seq))
86 return FID_SEQ_OST_MDT0;
88 if (fid_seq_is_default(ostid->oi.oi_seq))
89 return FID_SEQ_LOV_DEFAULT;
91 if (fid_is_idif(&ostid->oi_fid))
92 return FID_SEQ_OST_MDT0;
94 return fid_seq(&ostid->oi_fid);
97 /* extract OST objid from a wire ost_id (id/seq) pair */
98 static inline __u64 ostid_id(const struct ost_id *ostid)
100 if (fid_seq_is_mdt0(ostid->oi.oi_seq))
101 return ostid->oi.oi_id & IDIF_OID_MASK;
103 if (fid_seq_is_default(ostid->oi.oi_seq))
104 return ostid->oi.oi_id;
106 if (fid_is_idif(&ostid->oi_fid))
107 return fid_idif_id(fid_seq(&ostid->oi_fid),
108 fid_oid(&ostid->oi_fid), 0);
110 return fid_oid(&ostid->oi_fid);
113 static inline void ostid_set_seq(struct ost_id *oi, __u64 seq)
115 if (fid_seq_is_mdt0(seq) || fid_seq_is_default(seq)) {
118 oi->oi_fid.f_seq = seq;
120 * Note: if f_oid + f_ver is zero, we need init it
121 * to be 1, otherwise, ostid_seq will treat this
122 * as old ostid (oi_seq == 0)
124 if (!oi->oi_fid.f_oid && !oi->oi_fid.f_ver)
125 oi->oi_fid.f_oid = LUSTRE_FID_INIT_OID;
129 static inline void ostid_set_seq_mdt0(struct ost_id *oi)
131 ostid_set_seq(oi, FID_SEQ_OST_MDT0);
134 static inline void ostid_set_seq_echo(struct ost_id *oi)
136 ostid_set_seq(oi, FID_SEQ_ECHO);
139 static inline void ostid_set_seq_llog(struct ost_id *oi)
141 ostid_set_seq(oi, FID_SEQ_LLOG);
144 static inline void ostid_cpu_to_le(const struct ost_id *src_oi,
145 struct ost_id *dst_oi)
147 if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
148 dst_oi->oi.oi_id = __cpu_to_le64(src_oi->oi.oi_id);
149 dst_oi->oi.oi_seq = __cpu_to_le64(src_oi->oi.oi_seq);
151 fid_cpu_to_le(&dst_oi->oi_fid, &src_oi->oi_fid);
155 static inline void ostid_le_to_cpu(const struct ost_id *src_oi,
156 struct ost_id *dst_oi)
158 if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
159 dst_oi->oi.oi_id = __le64_to_cpu(src_oi->oi.oi_id);
160 dst_oi->oi.oi_seq = __le64_to_cpu(src_oi->oi.oi_seq);
162 fid_le_to_cpu(&dst_oi->oi_fid, &src_oi->oi_fid);
167 * Sigh, because pre-2.4 uses
168 * struct lov_mds_md_v1 {
170 * __u64 lmm_object_id;
171 * __u64 lmm_object_seq;
174 * to identify the LOV(MDT) object, and lmm_object_seq will
175 * be normal_fid, which make it hard to combine these conversion
176 * to ostid_to FID. so we will do lmm_oi/fid conversion separately
178 * We can tell the lmm_oi by this way,
179 * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
180 * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
181 * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
184 * But currently lmm_oi/lsm_oi does not have any "real" usages,
185 * except for printing some information, and the user can always
186 * get the real FID from LMA, besides this multiple case check might
187 * make swab more complicate. So we will keep using id/seq for lmm_oi.
190 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
193 oi->oi.oi_id = fid_oid(fid);
194 oi->oi.oi_seq = fid_seq(fid);
198 * Unpack an OST object id/seq (group) into a FID. This is needed for
199 * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
200 * FIDs. Note that if an id/seq is already in FID/IDIF format it will
201 * be passed through unchanged. Only legacy OST objects in "group 0"
202 * will be mapped into the IDIF namespace so that they can fit into the
203 * struct lu_fid fields without loss.
205 static inline int ostid_to_fid(struct lu_fid *fid, const struct ost_id *ostid,
208 __u64 seq = ostid_seq(ostid);
210 if (ost_idx > 0xffff)
213 if (fid_seq_is_mdt0(seq)) {
214 __u64 oid = ostid_id(ostid);
216 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
217 * that we map into the IDIF namespace. It allows up to 2^48
218 * objects per OST, as this is the object namespace that has
219 * been in production for years. This can handle create rates
220 * of 1M objects/s/OST for 9 years, or combinations thereof.
222 if (oid >= IDIF_MAX_OID)
225 fid->f_seq = fid_idif_seq(oid, ost_idx);
226 /* truncate to 32 bits by assignment */
228 /* in theory, not currently used */
229 fid->f_ver = oid >> 48;
230 } else if (!fid_seq_is_default(seq)) {
231 /* This is either an IDIF object, which identifies objects
232 * across all OSTs, or a regular FID. The IDIF namespace
233 * maps legacy OST objects into the FID namespace. In both
234 * cases, we just pass the FID through, no conversion needed.
236 if (ostid->oi_fid.f_ver)
239 *fid = ostid->oi_fid;
244 #endif /* _UAPI_LUSTRE_OSTID_H_ */