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