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