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