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 <libcfs/libcfs.h>
 152 #include <lustre/lustre_idl.h>
 153
 154 struct lu_env;
 155 struct lu_site;
 156 struct lu_context;
 157 struct obd_device;
 158 struct obd_export;
 159
 160 /* Whole sequences space range and zero range definitions */
 161 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
 162 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
 163 extern const struct lu_fid LUSTRE_BFL_FID;
 164 extern const struct lu_fid LU_OBF_FID;
 165 extern const struct lu_fid LU_LPF_FID;
 166 extern const struct lu_fid LU_DOT_LUSTRE_FID;
 167 extern const struct lu_fid LU_BACKEND_LPF_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         OSD_LPF_OID             = 19UL,
 224         REPLY_DATA_OID          = 21UL,
 225         OFD_LAST_GROUP_OID      = 4117UL,
 226         LLOG_CATALOGS_OID       = 4118UL,
 227         MGS_CONFIGS_OID         = 4119UL,
 228         OFD_HEALTH_CHECK_OID    = 4120UL,
 229         MDD_LOV_OBJ_OSEQ        = 4121UL,
 230         LFSCK_NAMESPACE_OID     = 4122UL,
 231         REMOTE_PARENT_DIR_OID   = 4123UL,
 232         /* This definition is obsolete
 233          * SLAVE_LLOG_CATALOGS_OID      = 4124UL,
 234          */
 235         BATCHID_COMMITTED_OID   = 4125UL,
 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) == FID_OID_ROOT));
 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_name_llog(const struct lu_fid *fid)
 293 {
 294         return fid_seq(fid) == FID_SEQ_LLOG_NAME;
 295 }
 296
 297 static inline int fid_is_namespace_visible(const struct lu_fid *fid)
 298 {
 299         const __u64 seq = fid_seq(fid);
 300
 301         /* Here, we cannot distinguish whether the normal FID is for OST
 302          * object or not. It is caller's duty to check more if needed. */
 303         return (!fid_is_last_id(fid) &&
 304                 (fid_seq_is_norm(seq) || fid_seq_is_igif(seq))) ||
 305                fid_is_root(fid) || fid_seq_is_dot(seq);
 306 }
 307
 308 static inline int fid_seq_in_fldb(__u64 seq)
 309 {
 310         return fid_seq_is_igif(seq) || fid_seq_is_norm(seq) ||
 311                fid_seq_is_root(seq) || fid_seq_is_dot(seq);
 312 }
 313
 314 static inline void lu_last_id_fid(struct lu_fid *fid, __u64 seq, __u32 ost_idx)
 315 {
 316         if (fid_seq_is_mdt0(seq)) {
 317                 fid->f_seq = fid_idif_seq(0, ost_idx);
 318         } else {
 319                 LASSERTF(fid_seq_is_norm(seq) || fid_seq_is_echo(seq) ||
 320                          fid_seq_is_idif(seq), "%#llx\n", seq);
 321                 fid->f_seq = seq;
 322         }
 323         fid->f_oid = 0;
 324         fid->f_ver = 0;
 325 }
 326
 327 static inline bool fid_is_md_operative(const struct lu_fid *fid)
 328 {
 329         return fid_is_mdt0(fid) || fid_is_igif(fid) ||
 330                fid_is_norm(fid) || fid_is_root(fid);
 331 }
 332
 333 /* seq client type */
 334 enum lu_cli_type {
 335         LUSTRE_SEQ_METADATA = 1,
 336         LUSTRE_SEQ_DATA
 337 };
 338
 339 enum lu_mgr_type {
 340         LUSTRE_SEQ_SERVER,
 341         LUSTRE_SEQ_CONTROLLER
 342 };
 343
 344 struct lu_server_seq;
 345
 346 /* Client sequence manager interface. */
 347 struct lu_client_seq {
 348         /* Sequence-controller export. */
 349         struct obd_export      *lcs_exp;
 350         struct mutex            lcs_mutex;
 351
 352         /*
 353          * Range of allowed for allocation sequeces. When using lu_client_seq on
 354          * clients, this contains meta-sequence range. And for servers this
 355          * contains super-sequence range.
 356          */
 357         struct lu_seq_range         lcs_space;
 358
 359         /* Seq related proc */
 360         struct proc_dir_entry   *lcs_proc_dir;
 361
 362         /* This holds last allocated fid in last obtained seq */
 363         struct lu_fid           lcs_fid;
 364
 365         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 366         enum lu_cli_type        lcs_type;
 367
 368         /*
 369          * Service uuid, passed from MDT + seq name to form unique seq name to
 370          * use it with procfs.
 371          */
 372         char                    lcs_name[80];
 373
 374         /*
 375          * Sequence width, that is how many objects may be allocated in one
 376          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 377          */
 378         __u64                   lcs_width;
 379
 380         /* Seq-server for direct talking */
 381         struct lu_server_seq   *lcs_srv;
 382
 383         /* wait queue for fid allocation and update indicator */
 384         wait_queue_head_t       lcs_waitq;
 385         int                     lcs_update;
 386 };
 387
 388 /* server sequence manager interface */
 389 struct lu_server_seq {
 390         /* Available sequences space */
 391         struct lu_seq_range         lss_space;
 392
 393         /* keeps highwater in lsr_end for seq allocation algorithm */
 394         struct lu_seq_range         lss_lowater_set;
 395         struct lu_seq_range         lss_hiwater_set;
 396
 397         /*
 398          * Device for server side seq manager needs (saving sequences to backing
 399          * store).
 400          */
 401         struct dt_device       *lss_dev;
 402
 403         /* /seq file object device */
 404         struct dt_object       *lss_obj;
 405
 406         /* Seq related proc */
 407         struct proc_dir_entry   *lss_proc_dir;
 408
 409         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
 410         enum lu_mgr_type       lss_type;
 411
 412         /* Client interface to request controller */
 413         struct lu_client_seq   *lss_cli;
 414
 415         /* Mutex for protecting allocation */
 416         struct mutex            lss_mutex;
 417
 418         /*
 419          * Service uuid, passed from MDT + seq name to form unique seq name to
 420          * use it with procfs.
 421          */
 422         char                    lss_name[80];
 423
 424         /*
 425          * Allocation chunks for super and meta sequences. Default values are
 426          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
 427          */
 428         __u64                   lss_width;
 429
 430         /*
 431          * minimum lss_alloc_set size that should be allocated from
 432          * lss_space
 433          */
 434         __u64                   lss_set_width;
 435
 436         /* sync is needed for update operation */
 437         __u32                   lss_need_sync;
 438
 439         /**
 440          * Pointer to site object, required to access site fld.
 441          */
 442         struct seq_server_site  *lss_site;
 443 };
 444
 445 struct seq_server_site {
 446         struct lu_site       *ss_lu;
 447         /**
 448          * mds number of this site.
 449          */
 450         u32                   ss_node_id;
 451         /**
 452          * Fid location database
 453          */
 454         struct lu_server_fld *ss_server_fld;
 455         struct lu_client_fld *ss_client_fld;
 456
 457         /**
 458          * Server Seq Manager
 459          */
 460         struct lu_server_seq *ss_server_seq;
 461
 462         /**
 463          * Controller Seq Manager
 464          */
 465         struct lu_server_seq *ss_control_seq;
 466         struct obd_export    *ss_control_exp;
 467
 468         /**
 469          * Client Seq Manager
 470          */
 471         struct lu_client_seq *ss_client_seq;
 472 };
 473
 474 /* Server methods */
 475
 476 int seq_server_init(const struct lu_env *env,
 477                     struct lu_server_seq *seq,
 478                     struct dt_device *dev,
 479                     const char *prefix,
 480                     enum lu_mgr_type type,
 481                     struct seq_server_site *ss);
 482
 483 void seq_server_fini(struct lu_server_seq *seq,
 484                      const struct lu_env *env);
 485
 486 int seq_server_alloc_super(struct lu_server_seq *seq,
 487                            struct lu_seq_range *out,
 488                            const struct lu_env *env);
 489
 490 int seq_server_alloc_meta(struct lu_server_seq *seq,
 491                           struct lu_seq_range *out,
 492                           const struct lu_env *env);
 493
 494 int seq_server_set_cli(const struct lu_env *env,
 495                        struct lu_server_seq *seq,
 496                        struct lu_client_seq *cli);
 497
 498 int seq_server_check_and_alloc_super(const struct lu_env *env,
 499                                      struct lu_server_seq *seq);
 500 /* Client methods */
 501 int seq_client_init(struct lu_client_seq *seq,
 502                     struct obd_export *exp,
 503                     enum lu_cli_type type,
 504                     const char *prefix,
 505                     struct lu_server_seq *srv);
 506
 507 void seq_client_fini(struct lu_client_seq *seq);
 508
 509 void seq_client_flush(struct lu_client_seq *seq);
 510
 511 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
 512                          struct lu_fid *fid);
 513 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
 514                        u64 *seqnr);
 515 int seq_site_fini(const struct lu_env *env, struct seq_server_site *ss);
 516 /* Fids common stuff */
 517 int fid_is_local(const struct lu_env *env,
 518                  struct lu_site *site, const struct lu_fid *fid);
 519
 520 enum lu_cli_type;
 521 int client_fid_init(struct obd_device *obd, struct obd_export *exp,
 522                     enum lu_cli_type type);
 523 int client_fid_fini(struct obd_device *obd);
 524
 525 /* fid locking */
 526
 527 struct ldlm_namespace;
 528
 529 /*
 530  * Build (DLM) resource name from FID.
 531  *
 532  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
 533  * but was moved into name[1] along with the OID to avoid consuming the
 534  * renaming name[2,3] fields that need to be used for the quota identifier.
 535  */
 536 static inline void
 537 fid_build_reg_res_name(const struct lu_fid *fid, struct ldlm_res_id *res)
 538 {
 539         memset(res, 0, sizeof(*res));
 540         res->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(fid);
 541         res->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(fid);
 542 }
 543
 544 /*
 545  * Return true if resource is for object identified by FID.
 546  */
 547 static inline int fid_res_name_eq(const struct lu_fid *fid,
 548                                   const struct ldlm_res_id *res)
 549 {
 550         return res->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(fid) &&
 551                res->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(fid);
 552 }
 553
 554 /*
 555  * Extract FID from LDLM resource. Reverse of fid_build_reg_res_name().
 556  */
 557 static inline void
 558 fid_extract_from_res_name(struct lu_fid *fid, const struct ldlm_res_id *res)
 559 {
 560         fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
 561         fid->f_oid = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF]);
 562         fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
 563         LASSERT(fid_res_name_eq(fid, res));
 564 }
 565
 566 /*
 567  * Build (DLM) resource identifier from global quota FID and quota ID.
 568  */
 569 static inline void
 570 fid_build_quota_res_name(const struct lu_fid *glb_fid, union lquota_id *qid,
 571                       struct ldlm_res_id *res)
 572 {
 573         fid_build_reg_res_name(glb_fid, res);
 574         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
 575         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
 576 }
 577
 578 /*
 579  * Extract global FID and quota ID from resource name
 580  */
 581 static inline void fid_extract_from_quota_res(struct lu_fid *glb_fid,
 582                                               union lquota_id *qid,
 583                                               const struct ldlm_res_id *res)
 584 {
 585         fid_extract_from_res_name(glb_fid, res);
 586         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
 587         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
 588         qid->qid_fid.f_ver =
 589                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
 590 }
 591
 592 static inline void
 593 fid_build_pdo_res_name(const struct lu_fid *fid, unsigned int hash,
 594                        struct ldlm_res_id *res)
 595 {
 596         fid_build_reg_res_name(fid, res);
 597         res->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 598 }
 599
 600 /**
 601  * Build DLM resource name from object id & seq, which will be removed
 602  * finally, when we replace ost_id with FID in data stack.
 603  *
 604  * Currently, resid from the old client, whose res[0] = object_id,
 605  * res[1] = object_seq, is just oposite with Metatdata
 606  * resid, where, res[0] = fid->f_seq, res[1] = fid->f_oid.
 607  * To unifiy the resid identification, we will reverse the data
 608  * resid to keep it same with Metadata resid, i.e.
 609  *
 610  * For resid from the old client,
 611  *    res[0] = objid,  res[1] = 0, still keep the original order,
 612  *    for compatiblity.
 613  *
 614  * For new resid
 615  *    res will be built from normal FID directly, i.e. res[0] = f_seq,
 616  *    res[1] = f_oid + f_ver.
 617  */
 618 static inline void ostid_build_res_name(const struct ost_id *oi,
 619                                         struct ldlm_res_id *name)
 620 {
 621         memset(name, 0, sizeof *name);
 622         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 623                 name->name[LUSTRE_RES_ID_SEQ_OFF] = ostid_id(oi);
 624                 name->name[LUSTRE_RES_ID_VER_OID_OFF] = ostid_seq(oi);
 625         } else {
 626                 fid_build_reg_res_name(&oi->oi_fid, name);
 627         }
 628 }
 629
 630 /**
 631  * Return true if the resource is for the object identified by this id & group.
 632  */
 633 static inline bool ostid_res_name_eq(const struct ost_id *oi,
 634                                      const struct ldlm_res_id *name)
 635 {
 636         /* Note: it is just a trick here to save some effort, probably the
 637          * correct way would be turn them into the FID and compare */
 638         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 639                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_id(oi) &&
 640                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_seq(oi);
 641         } else {
 642                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_seq(oi) &&
 643                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_id(oi);
 644         }
 645 }
 646
 647 /* The same as osc_build_res_name() */
 648 static inline void ost_fid_build_resid(const struct lu_fid *fid,
 649                                        struct ldlm_res_id *resname)
 650 {
 651         if (fid_is_mdt0(fid) || fid_is_idif(fid)) {
 652                 struct ost_id oi;
 653                 oi.oi.oi_id = 0; /* gcc 4.7.2 complains otherwise */
 654                 if (fid_to_ostid(fid, &oi) != 0)
 655                         return;
 656                 ostid_build_res_name(&oi, resname);
 657         } else {
 658                 fid_build_reg_res_name(fid, resname);
 659         }
 660 }
 661
 662 static inline void ost_fid_from_resid(struct lu_fid *fid,
 663                                       const struct ldlm_res_id *name,
 664                                       int ost_idx)
 665 {
 666         if (fid_seq_is_mdt0(name->name[LUSTRE_RES_ID_VER_OID_OFF])) {
 667                 /* old resid */
 668                 struct ost_id oi;
 669                 ostid_set_seq(&oi, name->name[LUSTRE_RES_ID_VER_OID_OFF]);
 670                 ostid_set_id(&oi, name->name[LUSTRE_RES_ID_SEQ_OFF]);
 671                 ostid_to_fid(fid, &oi, ost_idx);
 672         } else {
 673                 /* new resid */
 674                 fid_extract_from_res_name(fid, name);
 675         }
 676 }
 677
 678 /**
 679  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
 680  * For non-IGIF FIDs this starts just over 2^32, and continues without
 681  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
 682  * into the range where there may not be many OID values in use, to minimize
 683  * the risk of conflict.
 684  *
 685  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
 686  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
 687  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
 688  */
 689 static inline __u64 fid_flatten(const struct lu_fid *fid)
 690 {
 691         __u64 ino;
 692         __u64 seq;
 693
 694         if (fid_is_igif(fid)) {
 695                 ino = lu_igif_ino(fid);
 696                 RETURN(ino);
 697         }
 698
 699         seq = fid_seq(fid);
 700
 701         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
 702
 703         RETURN(ino ? ino : fid_oid(fid));
 704 }
 705
 706 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
 707 {
 708         /* all objects with same id and different versions will belong to same
 709          * collisions list. */
 710         return hash_long(fid_flatten(f), bits);
 711 }
 712
 713 /**
 714  * map fid to 32 bit value for ino on 32bit systems. */
 715 static inline __u32 fid_flatten32(const struct lu_fid *fid)
 716 {
 717         __u32 ino;
 718         __u64 seq;
 719
 720         if (fid_is_igif(fid)) {
 721                 ino = lu_igif_ino(fid);
 722                 RETURN(ino);
 723         }
 724
 725         seq = fid_seq(fid) - FID_SEQ_START;
 726
 727         /* Map the high bits of the OID into higher bits of the inode number so
 728          * that inodes generated at about the same time have a reduced chance
 729          * of collisions. This will give a period of 2^12 = 1024 unique clients
 730          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
 731          * (from OID), or up to 128M inodes without collisions for new files. */
 732         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
 733                (seq >> (64 - (40-8)) & 0xffffff00) +
 734                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
 735
 736         RETURN(ino ? ino : fid_oid(fid));
 737 }
 738
 739 static inline int
 740 lu_fid_diff(const struct lu_fid *fid1, const struct lu_fid *fid2)
 741 {
 742         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:"DFID", fid2:"DFID"\n",
 743                  PFID(fid1), PFID(fid2));
 744
 745         if (fid_is_idif(fid1) && fid_is_idif(fid2))
 746                 return fid_idif_id(fid1->f_seq, fid1->f_oid, fid1->f_ver) -
 747                        fid_idif_id(fid2->f_seq, fid2->f_oid, fid2->f_ver);
 748
 749         return fid_oid(fid1) - fid_oid(fid2);
 750 }
 751
 752 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 753 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 754
 755 /* Range common stuff */
 756 static inline void
 757 range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 758 {
 759         dst->lsr_start = cpu_to_le64(src->lsr_start);
 760         dst->lsr_end = cpu_to_le64(src->lsr_end);
 761         dst->lsr_index = cpu_to_le32(src->lsr_index);
 762         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
 763 }
 764
 765 static inline void
 766 range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 767 {
 768         dst->lsr_start = le64_to_cpu(src->lsr_start);
 769         dst->lsr_end = le64_to_cpu(src->lsr_end);
 770         dst->lsr_index = le32_to_cpu(src->lsr_index);
 771         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
 772 }
 773
 774 static inline void
 775 range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 776 {
 777         dst->lsr_start = cpu_to_be64(src->lsr_start);
 778         dst->lsr_end = cpu_to_be64(src->lsr_end);
 779         dst->lsr_index = cpu_to_be32(src->lsr_index);
 780         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
 781 }
 782
 783 static inline void
 784 range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 785 {
 786         dst->lsr_start = be64_to_cpu(src->lsr_start);
 787         dst->lsr_end = be64_to_cpu(src->lsr_end);
 788         dst->lsr_index = be32_to_cpu(src->lsr_index);
 789         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
 790 }
 791
 792 static inline void range_array_cpu_to_le(struct lu_seq_range_array *dst,
 793                                          const struct lu_seq_range_array *src)
 794 {
 795         __u32 i;
 796
 797         for (i = 0; i < src->lsra_count; i++)
 798                 range_cpu_to_le(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
 799
 800         dst->lsra_count = cpu_to_le32(src->lsra_count);
 801 }
 802
 803 static inline void range_array_le_to_cpu(struct lu_seq_range_array *dst,
 804                                          const struct lu_seq_range_array *src)
 805 {
 806         __u32 i;
 807
 808         dst->lsra_count = le32_to_cpu(src->lsra_count);
 809         for (i = 0; i < dst->lsra_count; i++)
 810                 range_le_to_cpu(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
 811 }
 812
 813 /** @} fid */
 814
 815 #endif /* __LUSTRE_FID_H */