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