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.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 __LUSTRE_FID_H
  42 #define __LUSTRE_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 "../../include/linux/libcfs/libcfs.h"
 156 #include "lustre/lustre_idl.h"
 157
 158 struct lu_env;
 159 struct lu_site;
 160 struct lu_context;
 161 struct obd_device;
 162 struct obd_export;
 163
 164 /* Whole sequences space range and zero range definitions */
 165 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
 166 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
 167 extern const struct lu_fid LUSTRE_BFL_FID;
 168 extern const struct lu_fid LU_OBF_FID;
 169 extern const struct lu_fid LU_DOT_LUSTRE_FID;
 170
 171 enum {
 172         /*
 173          * This is how may metadata FIDs may be allocated in one sequence(128k)
 174          */
 175         LUSTRE_METADATA_SEQ_MAX_WIDTH = 0x0000000000020000ULL,
 176
 177         /*
 178          * This is how many data FIDs could be allocated in one sequence(4B - 1)
 179          */
 180         LUSTRE_DATA_SEQ_MAX_WIDTH = 0x00000000FFFFFFFFULL,
 181
 182         /*
 183          * How many sequences to allocate to a client at once.
 184          */
 185         LUSTRE_SEQ_META_WIDTH = 0x0000000000000001ULL,
 186
 187         /*
 188          * seq allocation pool size.
 189          */
 190         LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
 191
 192         /*
 193          * This is how many sequences may be in one super-sequence allocated to
 194          * MDTs.
 195          */
 196         LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
 197 };
 198
 199 enum {
 200         /** 2^6 FIDs for OI containers */
 201         OSD_OI_FID_OID_BITS     = 6,
 202         /** reserve enough FIDs in case we want more in the future */
 203         OSD_OI_FID_OID_BITS_MAX = 10,
 204 };
 205
 206 /** special OID for local objects */
 207 enum local_oid {
 208         /** \see fld_mod_init */
 209         FLD_INDEX_OID           = 3UL,
 210         /** \see fid_mod_init */
 211         FID_SEQ_CTL_OID         = 4UL,
 212         FID_SEQ_SRV_OID         = 5UL,
 213         /** \see mdd_mod_init */
 214         MDD_ROOT_INDEX_OID      = 6UL, /* deprecated in 2.4 */
 215         MDD_ORPHAN_OID          = 7UL, /* deprecated in 2.4 */
 216         MDD_LOV_OBJ_OID         = 8UL,
 217         MDD_CAPA_KEYS_OID       = 9UL,
 218         /** \see mdt_mod_init */
 219         LAST_RECV_OID           = 11UL,
 220         OSD_FS_ROOT_OID         = 13UL,
 221         ACCT_USER_OID           = 15UL,
 222         ACCT_GROUP_OID          = 16UL,
 223         LFSCK_BOOKMARK_OID      = 17UL,
 224         OTABLE_IT_OID           = 18UL,
 225         /* These two definitions are obsolete
 226          * OFD_GROUP0_LAST_OID     = 20UL,
 227          * OFD_GROUP4K_LAST_OID    = 20UL+4096,
 228          */
 229         OFD_LAST_GROUP_OID      = 4117UL,
 230         LLOG_CATALOGS_OID       = 4118UL,
 231         MGS_CONFIGS_OID         = 4119UL,
 232         OFD_HEALTH_CHECK_OID    = 4120UL,
 233         MDD_LOV_OBJ_OSEQ        = 4121UL,
 234         LFSCK_NAMESPACE_OID     = 4122UL,
 235         REMOTE_PARENT_DIR_OID   = 4123UL,
 236 };
 237
 238 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
 239 {
 240         fid->f_seq = FID_SEQ_LOCAL_FILE;
 241         fid->f_oid = oid;
 242         fid->f_ver = 0;
 243 }
 244
 245 static inline void lu_local_name_obj_fid(struct lu_fid *fid, __u32 oid)
 246 {
 247         fid->f_seq = FID_SEQ_LOCAL_NAME;
 248         fid->f_oid = oid;
 249         fid->f_ver = 0;
 250 }
 251
 252 /* For new FS (>= 2.4), the root FID will be changed to
 253  * [FID_SEQ_ROOT:1:0], for existing FS, (upgraded to 2.4),
 254  * the root FID will still be IGIF */
 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_is_namespace_visible(const struct lu_fid *fid)
 293 {
 294         const __u64 seq = fid_seq(fid);
 295
 296         /* Here, we cannot distinguish whether the normal FID is for OST
 297          * object or not. It is caller's duty to check more if needed. */
 298         return (!fid_is_last_id(fid) &&
 299                 (fid_seq_is_norm(seq) || fid_seq_is_igif(seq))) ||
 300                fid_is_root(fid) || fid_is_dot_lustre(fid);
 301 }
 302
 303 static inline int fid_seq_in_fldb(__u64 seq)
 304 {
 305         return fid_seq_is_igif(seq) || fid_seq_is_norm(seq) ||
 306                fid_seq_is_root(seq) || fid_seq_is_dot(seq);
 307 }
 308
 309 static inline void lu_last_id_fid(struct lu_fid *fid, __u64 seq)
 310 {
 311         if (fid_seq_is_mdt0(seq)) {
 312                 fid->f_seq = fid_idif_seq(0, 0);
 313         } else {
 314                 LASSERTF(fid_seq_is_norm(seq) || fid_seq_is_echo(seq) ||
 315                          fid_seq_is_idif(seq), "%#llx\n", seq);
 316                 fid->f_seq = seq;
 317         }
 318         fid->f_oid = 0;
 319         fid->f_ver = 0;
 320 }
 321
 322 /* seq client type */
 323 enum lu_cli_type {
 324         LUSTRE_SEQ_METADATA = 1,
 325         LUSTRE_SEQ_DATA
 326 };
 327
 328 enum lu_mgr_type {
 329         LUSTRE_SEQ_SERVER,
 330         LUSTRE_SEQ_CONTROLLER
 331 };
 332
 333 struct lu_server_seq;
 334
 335 /* Client sequence manager interface. */
 336 struct lu_client_seq {
 337         /* Sequence-controller export. */
 338         struct obd_export      *lcs_exp;
 339         struct mutex            lcs_mutex;
 340
 341         /*
 342          * Range of allowed for allocation sequences. When using lu_client_seq on
 343          * clients, this contains meta-sequence range. And for servers this
 344          * contains super-sequence range.
 345          */
 346         struct lu_seq_range      lcs_space;
 347
 348         /* Seq related proc */
 349         struct dentry           *lcs_debugfs_entry;
 350
 351         /* This holds last allocated fid in last obtained seq */
 352         struct lu_fid      lcs_fid;
 353
 354         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 355         enum lu_cli_type        lcs_type;
 356
 357         /*
 358          * Service uuid, passed from MDT + seq name to form unique seq name to
 359          * use it with procfs.
 360          */
 361         char                lcs_name[LUSTRE_MDT_MAXNAMELEN];
 362
 363         /*
 364          * Sequence width, that is how many objects may be allocated in one
 365          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 366          */
 367         __u64              lcs_width;
 368
 369         /* Seq-server for direct talking */
 370         struct lu_server_seq   *lcs_srv;
 371
 372         /* wait queue for fid allocation and update indicator */
 373         wait_queue_head_t            lcs_waitq;
 374         int                  lcs_update;
 375 };
 376
 377 /* server sequence manager interface */
 378 struct lu_server_seq {
 379         /* Available sequences space */
 380         struct lu_seq_range      lss_space;
 381
 382         /* keeps highwater in lsr_end for seq allocation algorithm */
 383         struct lu_seq_range      lss_lowater_set;
 384         struct lu_seq_range      lss_hiwater_set;
 385
 386         /*
 387          * Device for server side seq manager needs (saving sequences to backing
 388          * store).
 389          */
 390         struct dt_device       *lss_dev;
 391
 392         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
 393         enum lu_mgr_type       lss_type;
 394
 395         /* Client interface to request controller */
 396         struct lu_client_seq   *lss_cli;
 397
 398         /* Mutex for protecting allocation */
 399         struct mutex            lss_mutex;
 400
 401         /*
 402          * Service uuid, passed from MDT + seq name to form unique seq name to
 403          * use it with procfs.
 404          */
 405         char                lss_name[LUSTRE_MDT_MAXNAMELEN];
 406
 407         /*
 408          * Allocation chunks for super and meta sequences. Default values are
 409          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
 410          */
 411         __u64              lss_width;
 412
 413         /*
 414          * minimum lss_alloc_set size that should be allocated from
 415          * lss_space
 416          */
 417         __u64              lss_set_width;
 418
 419         /* sync is needed for update operation */
 420         __u32              lss_need_sync;
 421
 422         /**
 423          * Pointer to site object, required to access site fld.
 424          */
 425         struct seq_server_site  *lss_site;
 426 };
 427
 428 /* Server methods */
 429
 430 int seq_server_init(struct lu_server_seq *seq,
 431                     struct dt_device *dev,
 432                     const char *prefix,
 433                     enum lu_mgr_type type,
 434                     struct seq_server_site *ss,
 435                     const struct lu_env *env);
 436
 437 void seq_server_fini(struct lu_server_seq *seq,
 438                      const struct lu_env *env);
 439
 440 int seq_server_alloc_super(struct lu_server_seq *seq,
 441                            struct lu_seq_range *out,
 442                            const struct lu_env *env);
 443
 444 int seq_server_alloc_meta(struct lu_server_seq *seq,
 445                           struct lu_seq_range *out,
 446                           const struct lu_env *env);
 447
 448 int seq_server_set_cli(struct lu_server_seq *seq,
 449                        struct lu_client_seq *cli,
 450                        const struct lu_env *env);
 451
 452 /* Client methods */
 453 int seq_client_init(struct lu_client_seq *seq,
 454                     struct obd_export *exp,
 455                     enum lu_cli_type type,
 456                     const char *prefix,
 457                     struct lu_server_seq *srv);
 458
 459 void seq_client_fini(struct lu_client_seq *seq);
 460
 461 void seq_client_flush(struct lu_client_seq *seq);
 462
 463 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
 464                          struct lu_fid *fid);
 465 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
 466                        u64 *seqnr);
 467 int seq_site_fini(const struct lu_env *env, struct seq_server_site *ss);
 468 /* Fids common stuff */
 469 int fid_is_local(const struct lu_env *env,
 470                  struct lu_site *site, const struct lu_fid *fid);
 471
 472 enum lu_cli_type;
 473 int client_fid_init(struct obd_device *obd, struct obd_export *exp,
 474                     enum lu_cli_type type);
 475 int client_fid_fini(struct obd_device *obd);
 476
 477 /* fid locking */
 478
 479 struct ldlm_namespace;
 480
 481 /*
 482  * Build (DLM) resource name from FID.
 483  *
 484  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
 485  * but was moved into name[1] along with the OID to avoid consuming the
 486  * renaming name[2,3] fields that need to be used for the quota identifier.
 487  */
 488 static inline struct ldlm_res_id *
 489 fid_build_reg_res_name(const struct lu_fid *fid, struct ldlm_res_id *res)
 490 {
 491         memset(res, 0, sizeof(*res));
 492         res->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(fid);
 493         res->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(fid);
 494
 495         return res;
 496 }
 497
 498 /*
 499  * Return true if resource is for object identified by FID.
 500  */
 501 static inline int fid_res_name_eq(const struct lu_fid *fid,
 502                                   const struct ldlm_res_id *res)
 503 {
 504         return res->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(fid) &&
 505                res->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(fid);
 506 }
 507
 508 /*
 509  * Extract FID from LDLM resource. Reverse of fid_build_reg_res_name().
 510  */
 511 static inline struct lu_fid *
 512 fid_extract_from_res_name(struct lu_fid *fid, const struct ldlm_res_id *res)
 513 {
 514         fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
 515         fid->f_oid = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF]);
 516         fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
 517         LASSERT(fid_res_name_eq(fid, res));
 518
 519         return fid;
 520 }
 521
 522 /*
 523  * Build (DLM) resource identifier from global quota FID and quota ID.
 524  */
 525 static inline struct ldlm_res_id *
 526 fid_build_quota_res_name(const struct lu_fid *glb_fid, union lquota_id *qid,
 527                       struct ldlm_res_id *res)
 528 {
 529         fid_build_reg_res_name(glb_fid, res);
 530         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
 531         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
 532
 533         return res;
 534 }
 535
 536 /*
 537  * Extract global FID and quota ID from resource name
 538  */
 539 static inline void fid_extract_from_quota_res(struct lu_fid *glb_fid,
 540                                               union lquota_id *qid,
 541                                               const struct ldlm_res_id *res)
 542 {
 543         fid_extract_from_res_name(glb_fid, res);
 544         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
 545         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
 546         qid->qid_fid.f_ver =
 547                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
 548 }
 549
 550 static inline struct ldlm_res_id *
 551 fid_build_pdo_res_name(const struct lu_fid *fid, unsigned int hash,
 552                        struct ldlm_res_id *res)
 553 {
 554         fid_build_reg_res_name(fid, res);
 555         res->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 556
 557         return res;
 558 }
 559
 560 /**
 561  * Build DLM resource name from object id & seq, which will be removed
 562  * finally, when we replace ost_id with FID in data stack.
 563  *
 564  * Currently, resid from the old client, whose res[0] = object_id,
 565  * res[1] = object_seq, is just opposite with Metatdata
 566  * resid, where, res[0] = fid->f_seq, res[1] = fid->f_oid.
 567  * To unify the resid identification, we will reverse the data
 568  * resid to keep it same with Metadata resid, i.e.
 569  *
 570  * For resid from the old client,
 571  *    res[0] = objid,  res[1] = 0, still keep the original order,
 572  *    for compatibility.
 573  *
 574  * For new resid
 575  *    res will be built from normal FID directly, i.e. res[0] = f_seq,
 576  *    res[1] = f_oid + f_ver.
 577  */
 578 static inline void ostid_build_res_name(struct ost_id *oi,
 579                                         struct ldlm_res_id *name)
 580 {
 581         memset(name, 0, sizeof(*name));
 582         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 583                 name->name[LUSTRE_RES_ID_SEQ_OFF] = ostid_id(oi);
 584                 name->name[LUSTRE_RES_ID_VER_OID_OFF] = ostid_seq(oi);
 585         } else {
 586                 fid_build_reg_res_name(&oi->oi_fid, name);
 587         }
 588 }
 589
 590 static inline void ostid_res_name_to_id(struct ost_id *oi,
 591                                         struct ldlm_res_id *name)
 592 {
 593         if (fid_seq_is_mdt0(name->name[LUSTRE_RES_ID_SEQ_OFF])) {
 594                 /* old resid */
 595                 ostid_set_seq(oi, name->name[LUSTRE_RES_ID_VER_OID_OFF]);
 596                 ostid_set_id(oi, name->name[LUSTRE_RES_ID_SEQ_OFF]);
 597         } else {
 598                 /* new resid */
 599                 fid_extract_from_res_name(&oi->oi_fid, name);
 600         }
 601 }
 602
 603 /**
 604  * Return true if the resource is for the object identified by this id & group.
 605  */
 606 static inline int ostid_res_name_eq(struct ost_id *oi,
 607                                     struct ldlm_res_id *name)
 608 {
 609         /* Note: it is just a trick here to save some effort, probably the
 610          * correct way would be turn them into the FID and compare */
 611         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 612                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_id(oi) &&
 613                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_seq(oi);
 614         } else {
 615                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_seq(oi) &&
 616                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_id(oi);
 617         }
 618 }
 619
 620 /* The same as osc_build_res_name() */
 621 static inline void ost_fid_build_resid(const struct lu_fid *fid,
 622                                        struct ldlm_res_id *resname)
 623 {
 624         if (fid_is_mdt0(fid) || fid_is_idif(fid)) {
 625                 struct ost_id oi;
 626                 oi.oi.oi_id = 0; /* gcc 4.7.2 complains otherwise */
 627                 if (fid_to_ostid(fid, &oi) != 0)
 628                         return;
 629                 ostid_build_res_name(&oi, resname);
 630         } else {
 631                 fid_build_reg_res_name(fid, resname);
 632         }
 633 }
 634
 635 static inline void ost_fid_from_resid(struct lu_fid *fid,
 636                                       const struct ldlm_res_id *name)
 637 {
 638         if (fid_seq_is_mdt0(name->name[LUSTRE_RES_ID_VER_OID_OFF])) {
 639                 /* old resid */
 640                 struct ost_id oi;
 641                 ostid_set_seq(&oi, name->name[LUSTRE_RES_ID_VER_OID_OFF]);
 642                 ostid_set_id(&oi, name->name[LUSTRE_RES_ID_SEQ_OFF]);
 643                 ostid_to_fid(fid, &oi, 0);
 644         } else {
 645                 /* new resid */
 646                 fid_extract_from_res_name(fid, name);
 647         }
 648 }
 649
 650 /**
 651  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
 652  * For non-IGIF FIDs this starts just over 2^32, and continues without
 653  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
 654  * into the range where there may not be many OID values in use, to minimize
 655  * the risk of conflict.
 656  *
 657  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
 658  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
 659  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
 660  */
 661 static inline __u64 fid_flatten(const struct lu_fid *fid)
 662 {
 663         __u64 ino;
 664         __u64 seq;
 665
 666         if (fid_is_igif(fid)) {
 667                 ino = lu_igif_ino(fid);
 668                 return ino;
 669         }
 670
 671         seq = fid_seq(fid);
 672
 673         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
 674
 675         return ino ? ino : fid_oid(fid);
 676 }
 677
 678 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
 679 {
 680         /* all objects with same id and different versions will belong to same
 681          * collisions list. */
 682         return hash_long(fid_flatten(f), bits);
 683 }
 684
 685 /**
 686  * map fid to 32 bit value for ino on 32bit systems. */
 687 static inline __u32 fid_flatten32(const struct lu_fid *fid)
 688 {
 689         __u32 ino;
 690         __u64 seq;
 691
 692         if (fid_is_igif(fid)) {
 693                 ino = lu_igif_ino(fid);
 694                 return ino;
 695         }
 696
 697         seq = fid_seq(fid) - FID_SEQ_START;
 698
 699         /* Map the high bits of the OID into higher bits of the inode number so
 700          * that inodes generated at about the same time have a reduced chance
 701          * of collisions. This will give a period of 2^12 = 1024 unique clients
 702          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
 703          * (from OID), or up to 128M inodes without collisions for new files. */
 704         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
 705                (seq >> (64 - (40-8)) & 0xffffff00) +
 706                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
 707
 708         return ino ? ino : fid_oid(fid);
 709 }
 710
 711 static inline int lu_fid_diff(struct lu_fid *fid1, struct lu_fid *fid2)
 712 {
 713         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:"DFID", fid2:"DFID"\n",
 714                  PFID(fid1), PFID(fid2));
 715
 716         if (fid_is_idif(fid1) && fid_is_idif(fid2))
 717                 return fid_idif_id(fid1->f_seq, fid1->f_oid, fid1->f_ver) -
 718                        fid_idif_id(fid2->f_seq, fid2->f_oid, fid2->f_ver);
 719
 720         return fid_oid(fid1) - fid_oid(fid2);
 721 }
 722
 723 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 724 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 725
 726 /* Range common stuff */
 727 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 728 {
 729         dst->lsr_start = cpu_to_le64(src->lsr_start);
 730         dst->lsr_end = cpu_to_le64(src->lsr_end);
 731         dst->lsr_index = cpu_to_le32(src->lsr_index);
 732         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
 733 }
 734
 735 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 736 {
 737         dst->lsr_start = le64_to_cpu(src->lsr_start);
 738         dst->lsr_end = le64_to_cpu(src->lsr_end);
 739         dst->lsr_index = le32_to_cpu(src->lsr_index);
 740         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
 741 }
 742
 743 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 744 {
 745         dst->lsr_start = cpu_to_be64(src->lsr_start);
 746         dst->lsr_end = cpu_to_be64(src->lsr_end);
 747         dst->lsr_index = cpu_to_be32(src->lsr_index);
 748         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
 749 }
 750
 751 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 752 {
 753         dst->lsr_start = be64_to_cpu(src->lsr_start);
 754         dst->lsr_end = be64_to_cpu(src->lsr_end);
 755         dst->lsr_index = be32_to_cpu(src->lsr_index);
 756         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
 757 }
 758
 759 /** @} fid */
 760
 761 #endif /* __LUSTRE_FID_H */