lustre/include/uapi/linux/lustre/lustre_ostid.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) 2011, 2017, Intel Corporation.
  27  *
  28  * Copyright 2015 Cray Inc, all rights reserved.
  29  * Author: Ben Evans.
  30  *
  31  * Define ost_id  associated functions
  32  */
  33
  34 #ifndef _UAPI_LUSTRE_OSTID_H_
  35 #define _UAPI_LUSTRE_OSTID_H_
  36
  37 #include <linux/errno.h>
  38 #include <linux/types.h>
  39 #include <linux/lustre/lustre_fid.h>
  40
  41 static inline __u64 lmm_oi_id(const struct ost_id *oi)
  42 {
  43         return oi->oi.oi_id;
  44 }
  45
  46 static inline __u64 lmm_oi_seq(const struct ost_id *oi)
  47 {
  48         return oi->oi.oi_seq;
  49 }
  50
  51 static inline void lmm_oi_set_seq(struct ost_id *oi, __u64 seq)
  52 {
  53         oi->oi.oi_seq = seq;
  54 }
  55
  56 static inline void lmm_oi_set_id(struct ost_id *oi, __u64 oid)
  57 {
  58         oi->oi.oi_id = oid;
  59 }
  60
  61 static inline void lmm_oi_le_to_cpu(struct ost_id *dst_oi,
  62                                     const struct ost_id *src_oi)
  63 {
  64         dst_oi->oi.oi_id = __le64_to_cpu(src_oi->oi.oi_id);
  65         dst_oi->oi.oi_seq = __le64_to_cpu(src_oi->oi.oi_seq);
  66 }
  67
  68 static inline void lmm_oi_cpu_to_le(struct ost_id *dst_oi,
  69                                     const struct ost_id *src_oi)
  70 {
  71         dst_oi->oi.oi_id = __cpu_to_le64(src_oi->oi.oi_id);
  72         dst_oi->oi.oi_seq = __cpu_to_le64(src_oi->oi.oi_seq);
  73 }
  74
  75 /* extract OST sequence (group) from a wire ost_id (id/seq) pair */
  76 static inline __u64 ostid_seq(const struct ost_id *ostid)
  77 {
  78         if (fid_seq_is_mdt0(ostid->oi.oi_seq))
  79                 return FID_SEQ_OST_MDT0;
  80
  81         if (fid_seq_is_default(ostid->oi.oi_seq))
  82                 return FID_SEQ_LOV_DEFAULT;
  83
  84         if (fid_is_idif(&ostid->oi_fid))
  85                 return FID_SEQ_OST_MDT0;
  86
  87         return fid_seq(&ostid->oi_fid);
  88 }
  89
  90 /* extract OST objid from a wire ost_id (id/seq) pair */
  91 static inline __u64 ostid_id(const struct ost_id *ostid)
  92 {
  93         if (fid_seq_is_mdt0(ostid->oi.oi_seq))
  94                 return ostid->oi.oi_id & IDIF_OID_MASK;
  95
  96         if (fid_seq_is_default(ostid->oi.oi_seq))
  97                 return ostid->oi.oi_id;
  98
  99         if (fid_is_idif(&ostid->oi_fid))
 100                 return fid_idif_id(fid_seq(&ostid->oi_fid),
 101                                    fid_oid(&ostid->oi_fid), 0);
 102
 103         return fid_oid(&ostid->oi_fid);
 104 }
 105
 106 static inline void ostid_set_seq(struct ost_id *oi, __u64 seq)
 107 {
 108         if (fid_seq_is_mdt0(seq) || fid_seq_is_default(seq)) {
 109                 oi->oi.oi_seq = seq;
 110         } else {
 111                 oi->oi_fid.f_seq = seq;
 112                 /*
 113                  * Note: if f_oid + f_ver is zero, we need init it
 114                  * to be 1, otherwise, ostid_seq will treat this
 115                  * as old ostid (oi_seq == 0)
 116                  */
 117                 if (!oi->oi_fid.f_oid && !oi->oi_fid.f_ver)
 118                         oi->oi_fid.f_oid = LUSTRE_FID_INIT_OID;
 119         }
 120 }
 121
 122 static inline void ostid_set_seq_mdt0(struct ost_id *oi)
 123 {
 124         ostid_set_seq(oi, FID_SEQ_OST_MDT0);
 125 }
 126
 127 static inline void ostid_set_seq_echo(struct ost_id *oi)
 128 {
 129         ostid_set_seq(oi, FID_SEQ_ECHO);
 130 }
 131
 132 static inline void ostid_set_seq_llog(struct ost_id *oi)
 133 {
 134         ostid_set_seq(oi, FID_SEQ_LLOG);
 135 }
 136
 137 static inline void ostid_cpu_to_le(const struct ost_id *src_oi,
 138                                    struct ost_id *dst_oi)
 139 {
 140         if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
 141                 dst_oi->oi.oi_id = __cpu_to_le64(src_oi->oi.oi_id);
 142                 dst_oi->oi.oi_seq = __cpu_to_le64(src_oi->oi.oi_seq);
 143         } else {
 144                 fid_cpu_to_le(&dst_oi->oi_fid, &src_oi->oi_fid);
 145         }
 146 }
 147
 148 static inline void ostid_le_to_cpu(const struct ost_id *src_oi,
 149                                    struct ost_id *dst_oi)
 150 {
 151         if (fid_seq_is_mdt0(src_oi->oi.oi_seq)) {
 152                 dst_oi->oi.oi_id = __le64_to_cpu(src_oi->oi.oi_id);
 153                 dst_oi->oi.oi_seq = __le64_to_cpu(src_oi->oi.oi_seq);
 154         } else {
 155                 fid_le_to_cpu(&dst_oi->oi_fid, &src_oi->oi_fid);
 156         }
 157 }
 158
 159 /**
 160  * Sigh, because pre-2.4 uses
 161  * struct lov_mds_md_v1 {
 162  *      ........
 163  *      __u64 lmm_object_id;
 164  *      __u64 lmm_object_seq;
 165  *      ......
 166  *      }
 167  * to identify the LOV(MDT) object, and lmm_object_seq will
 168  * be normal_fid, which make it hard to combine these conversion
 169  * to ostid_to FID. so we will do lmm_oi/fid conversion separately
 170  *
 171  * We can tell the lmm_oi by this way,
 172  * 1.8: lmm_object_id = {inode}, lmm_object_gr = 0
 173  * 2.1: lmm_object_id = {oid < 128k}, lmm_object_seq = FID_SEQ_NORMAL
 174  * 2.4: lmm_oi.f_seq = FID_SEQ_NORMAL, lmm_oi.f_oid = {oid < 128k},
 175  *      lmm_oi.f_ver = 0
 176  *
 177  * But currently lmm_oi/lsm_oi does not have any "real" usages,
 178  * except for printing some information, and the user can always
 179  * get the real FID from LMA, besides this multiple case check might
 180  * make swab more complicate. So we will keep using id/seq for lmm_oi.
 181  */
 182
 183 static inline void fid_to_lmm_oi(const struct lu_fid *fid,
 184                                  struct ost_id *oi)
 185 {
 186         oi->oi.oi_id = fid_oid(fid);
 187         oi->oi.oi_seq = fid_seq(fid);
 188 }
 189
 190 /**
 191  * Unpack an OST object id/seq (group) into a FID.  This is needed for
 192  * converting all obdo, lmm, lsm, etc. 64-bit id/seq pairs into proper
 193  * FIDs.  Note that if an id/seq is already in FID/IDIF format it will
 194  * be passed through unchanged.  Only legacy OST objects in "group 0"
 195  * will be mapped into the IDIF namespace so that they can fit into the
 196  * struct lu_fid fields without loss.
 197  */
 198 static inline int ostid_to_fid(struct lu_fid *fid, const struct ost_id *ostid,
 199                                __u32 ost_idx)
 200 {
 201         __u64 seq = ostid_seq(ostid);
 202
 203         if (ost_idx > 0xffff)
 204                 return -EBADF;
 205
 206         if (fid_seq_is_mdt0(seq)) {
 207                 __u64 oid = ostid_id(ostid);
 208
 209                 /* This is a "legacy" (old 1.x/2.early) OST object in "group 0"
 210                  * that we map into the IDIF namespace.  It allows up to 2^48
 211                  * objects per OST, as this is the object namespace that has
 212                  * been in production for years.  This can handle create rates
 213                  * of 1M objects/s/OST for 9 years, or combinations thereof.
 214                  */
 215                 if (oid >= IDIF_MAX_OID)
 216                         return -EBADF;
 217
 218                 fid->f_seq = fid_idif_seq(oid, ost_idx);
 219                 /* truncate to 32 bits by assignment */
 220                 fid->f_oid = oid;
 221                 /* in theory, not currently used */
 222                 fid->f_ver = oid >> 48;
 223         } else if (!fid_seq_is_default(seq)) {
 224                 /* This is either an IDIF object, which identifies objects
 225                  * across all OSTs, or a regular FID.  The IDIF namespace
 226                  * maps legacy OST objects into the FID namespace.  In both
 227                  * cases, we just pass the FID through, no conversion needed.
 228                  */
 229                 if (ostid->oi_fid.f_ver)
 230                         return -EBADF;
 231
 232                 *fid = ostid->oi_fid;
 233         }
 234
 235         return 0;
 236 }
 237 #endif /* _UAPI_LUSTRE_OSTID_H_ */