drivers/staging/lustre/lustre/include/lustre_fid.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, 2015, 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/include/lustre_fid.h
  33  *
  34  * Author: Yury Umanets <umka@clusterfs.com>
  35  */
  36
  37 #ifndef __LUSTRE_FID_H
  38 #define __LUSTRE_FID_H
  39
  40 /** \defgroup fid fid
  41  *
  42  * @{
  43  *
  44  * http://wiki.lustre.org/index.php/Architecture_-_Interoperability_fids_zfs
  45  * describes the FID namespace and interoperability requirements for FIDs.
  46  * The important parts of that document are included here for reference.
  47  *
  48  * FID
  49  *   File IDentifier generated by client from range allocated by the SEQuence
  50  *   service and stored in struct lu_fid. The FID is composed of three parts:
  51  *   SEQuence, ObjectID, and VERsion.  The SEQ component is a filesystem
  52  *   unique 64-bit integer, and only one client is ever assigned any SEQ value.
  53  *   The first 0x400 FID_SEQ_NORMAL [2^33, 2^33 + 0x400] values are reserved
  54  *   for system use.  The OID component is a 32-bit value generated by the
  55  *   client on a per-SEQ basis to allow creating many unique FIDs without
  56  *   communication with the server.  The VER component is a 32-bit value that
  57  *   distinguishes between different FID instantiations, such as snapshots or
  58  *   separate subtrees within the filesystem.  FIDs with the same VER field
  59  *   are considered part of the same namespace.
  60  *
  61  * OLD filesystems are those upgraded from Lustre 1.x that predate FIDs, and
  62  *   MDTs use 32-bit ldiskfs internal inode/generation numbers (IGIFs), while
  63  *   OSTs use 64-bit Lustre object IDs and generation numbers.
  64  *
  65  * NEW filesystems are those formatted since the introduction of FIDs.
  66  *
  67  * IGIF
  68  *   Inode and Generation In FID, a surrogate FID used to globally identify
  69  *   an existing object on OLD formatted MDT file system. This would only be
  70  *   used on MDT0 in a DNE filesystem, because there cannot be more than one
  71  *   MDT in an OLD formatted filesystem. Belongs to sequence in [12, 2^32 - 1]
  72  *   range, where inode number is stored in SEQ, and inode generation is in OID.
  73  *   NOTE: This assumes no more than 2^32-1 inodes exist in the MDT filesystem,
  74  *   which is the maximum possible for an ldiskfs backend.  It also assumes
  75  *   that the reserved ext3/ext4/ldiskfs inode numbers [0-11] are never visible
  76  *   to clients, which has always been true.
  77  *
  78  * IDIF
  79  *   object ID In FID, a surrogate FID used to globally identify an existing
  80  *   OST object on OLD formatted OST file system. Belongs to a sequence in
  81  *   [2^32, 2^33 - 1]. Sequence number is calculated as:
  82  *
  83  *      1 << 32 | (ost_index << 16) | ((objid >> 32) & 0xffff)
  84  *
  85  *   that is, SEQ consists of 16-bit OST index, and higher 16 bits of object
  86  *   ID. The generation of unique SEQ values per OST allows the IDIF FIDs to
  87  *   be identified in the FLD correctly. The OID field is calculated as:
  88  *
  89  *      objid & 0xffffffff
  90  *
  91  *   that is, it consists of lower 32 bits of object ID.  For objects within
  92  *   the IDIF range, object ID extraction will be:
  93  *
  94  *      o_id = (fid->f_seq & 0x7fff) << 16 | fid->f_oid;
  95  *      o_seq = 0;  // formerly group number
  96  *
  97  *   NOTE: This assumes that no more than 2^48-1 objects have ever been created
  98  *   on any OST, and that no more than 65535 OSTs are in use.  Both are very
  99  *   reasonable assumptions, i.e. an IDIF can uniquely map all objects assuming
 100  *   a maximum creation rate of 1M objects per second for a maximum of 9 years,
 101  *   or combinations thereof.
 102  *
 103  * OST_MDT0
 104  *   Surrogate FID used to identify an existing object on OLD formatted OST
 105  *   filesystem. Belongs to the reserved SEQuence 0, and is used prior to
 106  *   the introduction of FID-on-OST, at which point IDIF will be used to
 107  *   identify objects as residing on a specific OST.
 108  *
 109  * LLOG
 110  *   For Lustre Log objects the object sequence 1 is used. This is compatible
 111  *   with both OLD and NEW namespaces, as this SEQ number is in the
 112  *   ext3/ldiskfs reserved inode range and does not conflict with IGIF
 113  *   sequence numbers.
 114  *
 115  * ECHO
 116  *   For testing OST IO performance the object sequence 2 is used. This is
 117  *   compatible with both OLD and NEW namespaces, as this SEQ number is in
 118  *   the ext3/ldiskfs reserved inode range and does not conflict with IGIF
 119  *   sequence numbers.
 120  *
 121  * OST_MDT1 .. OST_MAX
 122  *   For testing with multiple MDTs the object sequence 3 through 9 is used,
 123  *   allowing direct mapping of MDTs 1 through 7 respectively, for a total
 124  *   of 8 MDTs including OST_MDT0. This matches the legacy CMD project "group"
 125  *   mappings. However, this SEQ range is only for testing prior to any
 126  *   production DNE release, as the objects in this range conflict across all
 127  *   OSTs, as the OST index is not part of the FID.  For production DNE usage,
 128  *   OST objects created by MDT1+ will use FID_SEQ_NORMAL FIDs.
 129  *
 130  * DLM OST objid to IDIF mapping
 131  *   For compatibility with existing OLD OST network protocol structures, the
 132  *   FID must map onto the o_id and o_seq in a manner that ensures existing
 133  *   objects are identified consistently for IO, as well as onto the LDLM
 134  *   namespace to ensure IDIFs there is only a single resource name for any
 135  *   object in the DLM.  The OLD OST object DLM resource mapping is:
 136  *
 137  *      resource[] = {o_id, o_seq, 0, 0}; // o_seq == 0 for production releases
 138  *
 139  *   The NEW OST object DLM resource mapping is the same for both MDT and OST:
 140  *
 141  *      resource[] = {SEQ, OID, VER, HASH};
 142  *
 143  *  NOTE: for mapping IDIF values to DLM resource names the o_id may be
 144  *  larger than the 2^33 reserved sequence numbers for IDIF, so it is possible
 145  *  for the o_id numbers to overlap FID SEQ numbers in the resource. However,
 146  *  in all production releases the OLD o_seq field is always zero, and all
 147  *  valid FID OID values are non-zero, so the lock resources will not collide.
 148  *  Even so, the MDT and OST resources are also in different LDLM namespaces.
 149  */
 150
 151 #include <linux/libcfs/libcfs.h>
 152 #include <uapi/linux/lustre/lustre_fid.h>
 153 #include <uapi/linux/lustre/lustre_idl.h>
 154 #include <uapi/linux/lustre/lustre_ostid.h>
 155
 156 struct lu_env;
 157 struct lu_site;
 158 struct lu_context;
 159 struct obd_device;
 160 struct obd_export;
 161
 162 /* Whole sequences space range and zero range definitions */
 163 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
 164 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
 165 extern const struct lu_fid LUSTRE_BFL_FID;
 166 extern const struct lu_fid LU_OBF_FID;
 167 extern const struct lu_fid LU_DOT_LUSTRE_FID;
 168
 169 enum {
 170         /*
 171          * This is how may metadata FIDs may be allocated in one sequence(128k)
 172          */
 173         LUSTRE_METADATA_SEQ_MAX_WIDTH = 0x0000000000020000ULL,
 174
 175         /*
 176          * This is how many data FIDs could be allocated in one sequence(4B - 1)
 177          */
 178         LUSTRE_DATA_SEQ_MAX_WIDTH = 0x00000000FFFFFFFFULL,
 179
 180         /*
 181          * How many sequences to allocate to a client at once.
 182          */
 183         LUSTRE_SEQ_META_WIDTH = 0x0000000000000001ULL,
 184
 185         /*
 186          * seq allocation pool size.
 187          */
 188         LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
 189
 190         /*
 191          * This is how many sequences may be in one super-sequence allocated to
 192          * MDTs.
 193          */
 194         LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
 195 };
 196
 197 enum {
 198         /** 2^6 FIDs for OI containers */
 199         OSD_OI_FID_OID_BITS     = 6,
 200         /** reserve enough FIDs in case we want more in the future */
 201         OSD_OI_FID_OID_BITS_MAX = 10,
 202 };
 203
 204 /** special OID for local objects */
 205 enum local_oid {
 206         /** \see fld_mod_init */
 207         FLD_INDEX_OID           = 3UL,
 208         /** \see fid_mod_init */
 209         FID_SEQ_CTL_OID         = 4UL,
 210         FID_SEQ_SRV_OID         = 5UL,
 211         /** \see mdd_mod_init */
 212         MDD_ROOT_INDEX_OID      = 6UL, /* deprecated in 2.4 */
 213         MDD_ORPHAN_OID          = 7UL, /* deprecated in 2.4 */
 214         MDD_LOV_OBJ_OID         = 8UL,
 215         MDD_CAPA_KEYS_OID       = 9UL,
 216         /** \see mdt_mod_init */
 217         LAST_RECV_OID           = 11UL,
 218         OSD_FS_ROOT_OID         = 13UL,
 219         ACCT_USER_OID           = 15UL,
 220         ACCT_GROUP_OID          = 16UL,
 221         LFSCK_BOOKMARK_OID      = 17UL,
 222         OTABLE_IT_OID           = 18UL,
 223         /* These two definitions are obsolete
 224          * OFD_GROUP0_LAST_OID     = 20UL,
 225          * OFD_GROUP4K_LAST_OID    = 20UL+4096,
 226          */
 227         OFD_LAST_GROUP_OID      = 4117UL,
 228         LLOG_CATALOGS_OID       = 4118UL,
 229         MGS_CONFIGS_OID         = 4119UL,
 230         OFD_HEALTH_CHECK_OID    = 4120UL,
 231         MDD_LOV_OBJ_OSEQ        = 4121UL,
 232         LFSCK_NAMESPACE_OID     = 4122UL,
 233         REMOTE_PARENT_DIR_OID   = 4123UL,
 234         SLAVE_LLOG_CATALOGS_OID = 4124UL,
 235 };
 236
 237 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
 238 {
 239         fid->f_seq = FID_SEQ_LOCAL_FILE;
 240         fid->f_oid = oid;
 241         fid->f_ver = 0;
 242 }
 243
 244 static inline void lu_local_name_obj_fid(struct lu_fid *fid, __u32 oid)
 245 {
 246         fid->f_seq = FID_SEQ_LOCAL_NAME;
 247         fid->f_oid = oid;
 248         fid->f_ver = 0;
 249 }
 250
 251 /* For new FS (>= 2.4), the root FID will be changed to
 252  * [FID_SEQ_ROOT:1:0], for existing FS, (upgraded to 2.4),
 253  * the root FID will still be IGIF
 254  */
 255 static inline int fid_is_root(const struct lu_fid *fid)
 256 {
 257         return unlikely((fid_seq(fid) == FID_SEQ_ROOT &&
 258                          fid_oid(fid) == 1));
 259 }
 260
 261 static inline int fid_is_dot_lustre(const struct lu_fid *fid)
 262 {
 263         return unlikely(fid_seq(fid) == FID_SEQ_DOT_LUSTRE &&
 264                         fid_oid(fid) == FID_OID_DOT_LUSTRE);
 265 }
 266
 267 static inline int fid_is_obf(const struct lu_fid *fid)
 268 {
 269         return unlikely(fid_seq(fid) == FID_SEQ_DOT_LUSTRE &&
 270                         fid_oid(fid) == FID_OID_DOT_LUSTRE_OBF);
 271 }
 272
 273 static inline int fid_is_otable_it(const struct lu_fid *fid)
 274 {
 275         return unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
 276                         fid_oid(fid) == OTABLE_IT_OID);
 277 }
 278
 279 static inline int fid_is_acct(const struct lu_fid *fid)
 280 {
 281         return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
 282                (fid_oid(fid) == ACCT_USER_OID ||
 283                 fid_oid(fid) == ACCT_GROUP_OID);
 284 }
 285
 286 static inline int fid_is_quota(const struct lu_fid *fid)
 287 {
 288         return fid_seq(fid) == FID_SEQ_QUOTA ||
 289                fid_seq(fid) == FID_SEQ_QUOTA_GLB;
 290 }
 291
 292 static inline int fid_seq_in_fldb(__u64 seq)
 293 {
 294         return fid_seq_is_igif(seq) || fid_seq_is_norm(seq) ||
 295                fid_seq_is_root(seq) || fid_seq_is_dot(seq);
 296 }
 297
 298 static inline void lu_last_id_fid(struct lu_fid *fid, __u64 seq, __u32 ost_idx)
 299 {
 300         if (fid_seq_is_mdt0(seq)) {
 301                 fid->f_seq = fid_idif_seq(0, ost_idx);
 302         } else {
 303                 LASSERTF(fid_seq_is_norm(seq) || fid_seq_is_echo(seq) ||
 304                          fid_seq_is_idif(seq), "%#llx\n", seq);
 305                 fid->f_seq = seq;
 306         }
 307         fid->f_oid = 0;
 308         fid->f_ver = 0;
 309 }
 310
 311 /* seq client type */
 312 enum lu_cli_type {
 313         LUSTRE_SEQ_METADATA = 1,
 314         LUSTRE_SEQ_DATA
 315 };
 316
 317 enum lu_mgr_type {
 318         LUSTRE_SEQ_SERVER,
 319         LUSTRE_SEQ_CONTROLLER
 320 };
 321
 322 /* Client sequence manager interface. */
 323 struct lu_client_seq {
 324         /* Sequence-controller export. */
 325         struct obd_export      *lcs_exp;
 326         struct mutex            lcs_mutex;
 327
 328         /*
 329          * Range of allowed for allocation sequences. When using lu_client_seq on
 330          * clients, this contains meta-sequence range. And for servers this
 331          * contains super-sequence range.
 332          */
 333         struct lu_seq_range      lcs_space;
 334
 335         /* Seq related proc */
 336         struct dentry           *lcs_debugfs_entry;
 337
 338         /* This holds last allocated fid in last obtained seq */
 339         struct lu_fid      lcs_fid;
 340
 341         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 342         enum lu_cli_type        lcs_type;
 343
 344         /*
 345          * Service uuid, passed from MDT + seq name to form unique seq name to
 346          * use it with procfs.
 347          */
 348         char                lcs_name[LUSTRE_MDT_MAXNAMELEN];
 349
 350         /*
 351          * Sequence width, that is how many objects may be allocated in one
 352          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 353          */
 354         __u64              lcs_width;
 355
 356         /* wait queue for fid allocation and update indicator */
 357         wait_queue_head_t            lcs_waitq;
 358         int                  lcs_update;
 359 };
 360
 361 /* Client methods */
 362 void seq_client_flush(struct lu_client_seq *seq);
 363
 364 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
 365                          struct lu_fid *fid);
 366 /* Fids common stuff */
 367 int fid_is_local(const struct lu_env *env,
 368                  struct lu_site *site, const struct lu_fid *fid);
 369
 370 enum lu_cli_type;
 371 int client_fid_init(struct obd_device *obd, struct obd_export *exp,
 372                     enum lu_cli_type type);
 373 int client_fid_fini(struct obd_device *obd);
 374
 375 /* fid locking */
 376
 377 struct ldlm_namespace;
 378
 379 /*
 380  * Build (DLM) resource name from FID.
 381  *
 382  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
 383  * but was moved into name[1] along with the OID to avoid consuming the
 384  * renaming name[2,3] fields that need to be used for the quota identifier.
 385  */
 386 static inline void
 387 fid_build_reg_res_name(const struct lu_fid *fid, struct ldlm_res_id *res)
 388 {
 389         memset(res, 0, sizeof(*res));
 390         res->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(fid);
 391         res->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(fid);
 392 }
 393
 394 /*
 395  * Return true if resource is for object identified by FID.
 396  */
 397 static inline bool fid_res_name_eq(const struct lu_fid *fid,
 398                                    const struct ldlm_res_id *res)
 399 {
 400         return res->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(fid) &&
 401                res->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(fid);
 402 }
 403
 404 /*
 405  * Extract FID from LDLM resource. Reverse of fid_build_reg_res_name().
 406  */
 407 static inline void
 408 fid_extract_from_res_name(struct lu_fid *fid, const struct ldlm_res_id *res)
 409 {
 410         fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
 411         fid->f_oid = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF]);
 412         fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
 413         LASSERT(fid_res_name_eq(fid, res));
 414 }
 415
 416 /*
 417  * Build (DLM) resource identifier from global quota FID and quota ID.
 418  */
 419 static inline void
 420 fid_build_quota_res_name(const struct lu_fid *glb_fid, union lquota_id *qid,
 421                          struct ldlm_res_id *res)
 422 {
 423         fid_build_reg_res_name(glb_fid, res);
 424         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
 425         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
 426 }
 427
 428 /*
 429  * Extract global FID and quota ID from resource name
 430  */
 431 static inline void fid_extract_from_quota_res(struct lu_fid *glb_fid,
 432                                               union lquota_id *qid,
 433                                               const struct ldlm_res_id *res)
 434 {
 435         fid_extract_from_res_name(glb_fid, res);
 436         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
 437         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
 438         qid->qid_fid.f_ver =
 439                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
 440 }
 441
 442 static inline void
 443 fid_build_pdo_res_name(const struct lu_fid *fid, unsigned int hash,
 444                        struct ldlm_res_id *res)
 445 {
 446         fid_build_reg_res_name(fid, res);
 447         res->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 448 }
 449
 450 /**
 451  * Build DLM resource name from object id & seq, which will be removed
 452  * finally, when we replace ost_id with FID in data stack.
 453  *
 454  * Currently, resid from the old client, whose res[0] = object_id,
 455  * res[1] = object_seq, is just opposite with Metatdata
 456  * resid, where, res[0] = fid->f_seq, res[1] = fid->f_oid.
 457  * To unify the resid identification, we will reverse the data
 458  * resid to keep it same with Metadata resid, i.e.
 459  *
 460  * For resid from the old client,
 461  *    res[0] = objid,  res[1] = 0, still keep the original order,
 462  *    for compatibility.
 463  *
 464  * For new resid
 465  *    res will be built from normal FID directly, i.e. res[0] = f_seq,
 466  *    res[1] = f_oid + f_ver.
 467  */
 468 static inline void ostid_build_res_name(const struct ost_id *oi,
 469                                         struct ldlm_res_id *name)
 470 {
 471         memset(name, 0, sizeof(*name));
 472         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 473                 name->name[LUSTRE_RES_ID_SEQ_OFF] = ostid_id(oi);
 474                 name->name[LUSTRE_RES_ID_VER_OID_OFF] = ostid_seq(oi);
 475         } else {
 476                 fid_build_reg_res_name(&oi->oi_fid, name);
 477         }
 478 }
 479
 480 /**
 481  * Return true if the resource is for the object identified by this id & group.
 482  */
 483 static inline int ostid_res_name_eq(const struct ost_id *oi,
 484                                     const struct ldlm_res_id *name)
 485 {
 486         /* Note: it is just a trick here to save some effort, probably the
 487          * correct way would be turn them into the FID and compare
 488          */
 489         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 490                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_id(oi) &&
 491                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_seq(oi);
 492         } else {
 493                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_seq(oi) &&
 494                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_id(oi);
 495         }
 496 }
 497
 498 /**
 499  * Note: we need check oi_seq to decide where to set oi_id,
 500  * so oi_seq should always be set ahead of oi_id.
 501  */
 502 static inline int ostid_set_id(struct ost_id *oi, __u64 oid)
 503 {
 504         if (fid_seq_is_mdt0(oi->oi.oi_seq)) {
 505                 if (oid >= IDIF_MAX_OID)
 506                         return -E2BIG;
 507                 oi->oi.oi_id = oid;
 508         } else if (fid_is_idif(&oi->oi_fid)) {
 509                 if (oid >= IDIF_MAX_OID)
 510                         return -E2BIG;
 511                 oi->oi_fid.f_seq = fid_idif_seq(oid,
 512                                                 fid_idif_ost_idx(&oi->oi_fid));
 513                 oi->oi_fid.f_oid = oid;
 514                 oi->oi_fid.f_ver = oid >> 48;
 515         } else {
 516                 if (oid >= OBIF_MAX_OID)
 517                         return -E2BIG;
 518                 oi->oi_fid.f_oid = oid;
 519         }
 520         return 0;
 521 }
 522
 523 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
 524 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
 525 {
 526         int rc = 0;
 527
 528         if (fid_seq_is_igif(fid->f_seq))
 529                 return -EBADF;
 530
 531         if (fid_is_idif(fid)) {
 532                 u64 objid = fid_idif_id(fid_seq(fid), fid_oid(fid),
 533                                         fid_ver(fid));
 534
 535                 ostid_set_seq_mdt0(ostid);
 536                 rc = ostid_set_id(ostid, objid);
 537         } else {
 538                 ostid->oi_fid = *fid;
 539         }
 540
 541         return rc;
 542 }
 543
 544 /* The same as osc_build_res_name() */
 545 static inline void ost_fid_build_resid(const struct lu_fid *fid,
 546                                        struct ldlm_res_id *resname)
 547 {
 548         if (fid_is_mdt0(fid) || fid_is_idif(fid)) {
 549                 struct ost_id oi;
 550
 551                 oi.oi.oi_id = 0; /* gcc 4.7.2 complains otherwise */
 552                 if (fid_to_ostid(fid, &oi) != 0)
 553                         return;
 554                 ostid_build_res_name(&oi, resname);
 555         } else {
 556                 fid_build_reg_res_name(fid, resname);
 557         }
 558 }
 559
 560 /**
 561  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
 562  * For non-IGIF FIDs this starts just over 2^32, and continues without
 563  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
 564  * into the range where there may not be many OID values in use, to minimize
 565  * the risk of conflict.
 566  *
 567  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
 568  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
 569  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
 570  */
 571 static inline __u64 fid_flatten(const struct lu_fid *fid)
 572 {
 573         __u64 ino;
 574         __u64 seq;
 575
 576         if (fid_is_igif(fid)) {
 577                 ino = lu_igif_ino(fid);
 578                 return ino;
 579         }
 580
 581         seq = fid_seq(fid);
 582
 583         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
 584
 585         return ino ? ino : fid_oid(fid);
 586 }
 587
 588 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
 589 {
 590         /* all objects with same id and different versions will belong to same
 591          * collisions list.
 592          */
 593         return hash_long(fid_flatten(f), bits);
 594 }
 595
 596 /**
 597  * map fid to 32 bit value for ino on 32bit systems.
 598  */
 599 static inline __u32 fid_flatten32(const struct lu_fid *fid)
 600 {
 601         __u32 ino;
 602         __u64 seq;
 603
 604         if (fid_is_igif(fid)) {
 605                 ino = lu_igif_ino(fid);
 606                 return ino;
 607         }
 608
 609         seq = fid_seq(fid) - FID_SEQ_START;
 610
 611         /* Map the high bits of the OID into higher bits of the inode number so
 612          * that inodes generated at about the same time have a reduced chance
 613          * of collisions. This will give a period of 2^12 = 1024 unique clients
 614          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
 615          * (from OID), or up to 128M inodes without collisions for new files.
 616          */
 617         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
 618                (seq >> (64 - (40 - 8)) & 0xffffff00) +
 619                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
 620
 621         return ino ? ino : fid_oid(fid);
 622 }
 623
 624 static inline int lu_fid_diff(const struct lu_fid *fid1,
 625                               const struct lu_fid *fid2)
 626 {
 627         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:" DFID ", fid2:" DFID "\n",
 628                  PFID(fid1), PFID(fid2));
 629
 630         if (fid_is_idif(fid1) && fid_is_idif(fid2))
 631                 return fid_idif_id(fid1->f_seq, fid1->f_oid, fid1->f_ver) -
 632                        fid_idif_id(fid2->f_seq, fid2->f_oid, fid2->f_ver);
 633
 634         return fid_oid(fid1) - fid_oid(fid2);
 635 }
 636
 637 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 638 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 639
 640 /* Range common stuff */
 641 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 642 {
 643         dst->lsr_start = cpu_to_le64(src->lsr_start);
 644         dst->lsr_end = cpu_to_le64(src->lsr_end);
 645         dst->lsr_index = cpu_to_le32(src->lsr_index);
 646         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
 647 }
 648
 649 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 650 {
 651         dst->lsr_start = le64_to_cpu(src->lsr_start);
 652         dst->lsr_end = le64_to_cpu(src->lsr_end);
 653         dst->lsr_index = le32_to_cpu(src->lsr_index);
 654         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
 655 }
 656
 657 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 658 {
 659         dst->lsr_start = cpu_to_be64(src->lsr_start);
 660         dst->lsr_end = cpu_to_be64(src->lsr_end);
 661         dst->lsr_index = cpu_to_be32(src->lsr_index);
 662         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
 663 }
 664
 665 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 666 {
 667         dst->lsr_start = be64_to_cpu(src->lsr_start);
 668         dst->lsr_end = be64_to_cpu(src->lsr_end);
 669         dst->lsr_index = be32_to_cpu(src->lsr_index);
 670         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
 671 }
 672
 673 /** @} fid */
 674
 675 #endif /* __LUSTRE_FID_H */