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, 2017, 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 <uapi/linux/lustre/lustre_fid.h>
 153 #include <uapi/linux/lustre/lustre_idl.h>
 154 #include <uapi/linux/lustre/lustre_ostid.h>
 155
 156 /* Lustre service names are following the format
 157  * service name + MDT + seq name
 158  */
 159 #define LUSTRE_MDT_MAXNAMELEN           80
 160
 161 struct lu_env;
 162 struct lu_site;
 163 struct lu_context;
 164 struct obd_device;
 165 struct obd_export;
 166
 167 /* Whole sequences space range and zero range definitions */
 168 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
 169 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
 170 extern const struct lu_fid LUSTRE_BFL_FID;
 171 extern const struct lu_fid LU_OBF_FID;
 172 extern const struct lu_fid LU_LPF_FID;
 173 extern const struct lu_fid LU_DOT_LUSTRE_FID;
 174 extern const struct lu_fid LU_BACKEND_LPF_FID;
 175
 176 enum {
 177         /*
 178          * This is how may metadata FIDs may be allocated in one sequence(128k)
 179          */
 180         LUSTRE_METADATA_SEQ_MAX_WIDTH = 0x0000000000020000ULL,
 181
 182         /*
 183          * This is how many data FIDs could be allocated in one sequence(4B - 1)
 184          */
 185         LUSTRE_DATA_SEQ_MAX_WIDTH = 0x00000000FFFFFFFFULL,
 186
 187         /*
 188          * How many sequences to allocate to a client at once.
 189          */
 190         LUSTRE_SEQ_META_WIDTH = 0x0000000000000001ULL,
 191
 192         /*
 193          * seq allocation pool size.
 194          */
 195         LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
 196
 197         /*
 198          * This is how many sequences may be in one super-sequence allocated to
 199          * MDTs.
 200          */
 201         LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
 202 };
 203
 204 /** special OID for local objects */
 205 enum local_oid {
 206         /** \see fld_mod_init */
 207         FLD_INDEX_OID           = 3UL,
 208         /** \see fid_mod_init */
 209         FID_SEQ_CTL_OID         = 4UL,
 210         FID_SEQ_SRV_OID         = 5UL,
 211         /** \see mdd_mod_init */
 212         MDD_ROOT_INDEX_OID      = 6UL, /* deprecated in 2.4 */
 213         MDD_ORPHAN_OID          = 7UL, /* deprecated in 2.4 */
 214         MDD_LOV_OBJ_OID         = 8UL,
 215         MDD_CAPA_KEYS_OID       = 9UL,
 216         /** \see mdt_mod_init */
 217         LAST_RECV_OID           = 11UL,
 218         OSD_FS_ROOT_OID         = 13UL,
 219         ACCT_USER_OID           = 15UL,
 220         ACCT_GROUP_OID          = 16UL,
 221         LFSCK_BOOKMARK_OID      = 17UL,
 222         OTABLE_IT_OID           = 18UL,
 223         OSD_LPF_OID             = 19UL,
 224         REPLY_DATA_OID          = 21UL,
 225         ACCT_PROJECT_OID        = 22UL,
 226         INDEX_BACKUP_OID        = 4116UL,
 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_oid_is_quota(const struct lu_fid *fid)
 282 {
 283         switch (fid_oid(fid)) {
 284         case ACCT_USER_OID:
 285         case ACCT_GROUP_OID:
 286         case ACCT_PROJECT_OID:
 287                 return 1;
 288         default:
 289                 return 0;
 290         }
 291 }
 292
 293 static inline int fid_is_acct(const struct lu_fid *fid)
 294 {
 295         return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
 296                fid_oid_is_quota(fid);
 297 }
 298
 299 static inline int fid_is_quota(const struct lu_fid *fid)
 300 {
 301         return fid_seq(fid) == FID_SEQ_QUOTA ||
 302                fid_seq(fid) == FID_SEQ_QUOTA_GLB;
 303 }
 304
 305 static inline int fid_is_name_llog(const struct lu_fid *fid)
 306 {
 307         return fid_seq(fid) == FID_SEQ_LLOG_NAME;
 308 }
 309
 310 static inline int fid_is_namespace_visible(const struct lu_fid *fid)
 311 {
 312         const __u64 seq = fid_seq(fid);
 313
 314         /* Here, we cannot distinguish whether the normal FID is for OST
 315          * object or not. It is caller's duty to check more if needed. */
 316         return (!fid_is_last_id(fid) &&
 317                 (fid_seq_is_norm(seq) || fid_seq_is_igif(seq))) ||
 318                fid_is_root(fid) || fid_seq_is_dot(seq);
 319 }
 320
 321 static inline int fid_seq_in_fldb(__u64 seq)
 322 {
 323         return fid_seq_is_igif(seq) || fid_seq_is_norm(seq) ||
 324                fid_seq_is_root(seq) || fid_seq_is_dot(seq);
 325 }
 326
 327 static inline void ost_layout_cpu_to_le(struct ost_layout *dst,
 328                                         const struct ost_layout *src)
 329 {
 330         dst->ol_stripe_size = __cpu_to_le32(src->ol_stripe_size);
 331         dst->ol_stripe_count = __cpu_to_le32(src->ol_stripe_count);
 332         dst->ol_comp_start = __cpu_to_le64(src->ol_comp_start);
 333         dst->ol_comp_end = __cpu_to_le64(src->ol_comp_end);
 334         dst->ol_comp_id = __cpu_to_le32(src->ol_comp_id);
 335 }
 336
 337 static inline void ost_layout_le_to_cpu(struct ost_layout *dst,
 338                                         const struct ost_layout *src)
 339 {
 340         dst->ol_stripe_size = __le32_to_cpu(src->ol_stripe_size);
 341         dst->ol_stripe_count = __le32_to_cpu(src->ol_stripe_count);
 342         dst->ol_comp_start = __le64_to_cpu(src->ol_comp_start);
 343         dst->ol_comp_end = __le64_to_cpu(src->ol_comp_end);
 344         dst->ol_comp_id = __le32_to_cpu(src->ol_comp_id);
 345 }
 346
 347 static inline void filter_fid_cpu_to_le(struct filter_fid *dst,
 348                                         const struct filter_fid *src, int size)
 349 {
 350         fid_cpu_to_le(&dst->ff_parent, &src->ff_parent);
 351
 352         if (size < sizeof(struct filter_fid)) {
 353                 memset(&dst->ff_layout, 0, sizeof(dst->ff_layout));
 354         } else {
 355                 ost_layout_cpu_to_le(&dst->ff_layout, &src->ff_layout);
 356                 dst->ff_layout_version = cpu_to_le32(src->ff_layout_version);
 357                 dst->ff_range = cpu_to_le32(src->ff_range);
 358         }
 359
 360         /* XXX: Add more if filter_fid is enlarged in the future. */
 361 }
 362
 363 static inline void filter_fid_le_to_cpu(struct filter_fid *dst,
 364                                         const struct filter_fid *src, int size)
 365 {
 366         fid_le_to_cpu(&dst->ff_parent, &src->ff_parent);
 367
 368         if (size < sizeof(struct filter_fid)) {
 369                 memset(&dst->ff_layout, 0, sizeof(dst->ff_layout));
 370         } else {
 371                 ost_layout_le_to_cpu(&dst->ff_layout, &src->ff_layout);
 372                 dst->ff_layout_version = le32_to_cpu(src->ff_layout_version);
 373                 dst->ff_range = le32_to_cpu(src->ff_range);
 374         }
 375
 376         /* XXX: Add more if filter_fid is enlarged in the future. */
 377 }
 378
 379 static inline void lu_last_id_fid(struct lu_fid *fid, __u64 seq, __u32 ost_idx)
 380 {
 381         if (fid_seq_is_mdt0(seq)) {
 382                 fid->f_seq = fid_idif_seq(0, ost_idx);
 383         } else {
 384                 LASSERTF(fid_seq_is_norm(seq) || fid_seq_is_echo(seq) ||
 385                          fid_seq_is_idif(seq), "%#llx\n", seq);
 386                 fid->f_seq = seq;
 387         }
 388         fid->f_oid = 0;
 389         fid->f_ver = 0;
 390 }
 391
 392 static inline bool fid_is_md_operative(const struct lu_fid *fid)
 393 {
 394         return fid_is_mdt0(fid) || fid_is_igif(fid) ||
 395                fid_is_norm(fid) || fid_is_root(fid);
 396 }
 397
 398 /* seq client type */
 399 enum lu_cli_type {
 400         LUSTRE_SEQ_METADATA = 1,
 401         LUSTRE_SEQ_DATA
 402 };
 403
 404 enum lu_mgr_type {
 405         LUSTRE_SEQ_SERVER,
 406         LUSTRE_SEQ_CONTROLLER
 407 };
 408
 409 struct lu_server_seq;
 410
 411 /* Client sequence manager interface. */
 412 struct lu_client_seq {
 413         /* Sequence-controller export. */
 414         struct obd_export      *lcs_exp;
 415         struct mutex            lcs_mutex;
 416
 417         /*
 418          * Range of allowed for allocation sequeces. When using lu_client_seq on
 419          * clients, this contains meta-sequence range. And for servers this
 420          * contains super-sequence range.
 421          */
 422         struct lu_seq_range         lcs_space;
 423
 424         /* Seq related debugfs */
 425         struct dentry           *lcs_debugfs_entry;
 426
 427         /* This holds last allocated fid in last obtained seq */
 428         struct lu_fid           lcs_fid;
 429
 430         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 431         enum lu_cli_type        lcs_type;
 432
 433         /*
 434          * Service uuid, passed from MDT + seq name to form unique seq name to
 435          * use it with debugfs.
 436          */
 437         char                    lcs_name[LUSTRE_MDT_MAXNAMELEN];
 438
 439         /*
 440          * Sequence width, that is how many objects may be allocated in one
 441          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 442          */
 443         __u64                   lcs_width;
 444
 445         /* Seq-server for direct talking */
 446         struct lu_server_seq   *lcs_srv;
 447
 448         /* wait queue for fid allocation and update indicator */
 449         wait_queue_head_t       lcs_waitq;
 450         int                     lcs_update;
 451 };
 452
 453 /* server sequence manager interface */
 454 struct lu_server_seq {
 455         /* Available sequences space */
 456         struct lu_seq_range         lss_space;
 457
 458         /* keeps highwater in lsr_end for seq allocation algorithm */
 459         struct lu_seq_range         lss_lowater_set;
 460         struct lu_seq_range         lss_hiwater_set;
 461
 462         /*
 463          * Device for server side seq manager needs (saving sequences to backing
 464          * store).
 465          */
 466         struct dt_device       *lss_dev;
 467
 468         /* /seq file object device */
 469         struct dt_object       *lss_obj;
 470
 471         /* Seq related debugfs */
 472         struct dentry           *lss_debugfs_entry;
 473
 474         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
 475         enum lu_mgr_type       lss_type;
 476
 477         /* Client interface to request controller */
 478         struct lu_client_seq   *lss_cli;
 479
 480         /* Mutex for protecting allocation */
 481         struct mutex            lss_mutex;
 482
 483         /*
 484          * Service uuid, passed from MDT + seq name to form unique seq name to
 485          * use it with debugfs.
 486          */
 487         char                    lss_name[LUSTRE_MDT_MAXNAMELEN];
 488
 489         /*
 490          * Allocation chunks for super and meta sequences. Default values are
 491          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
 492          */
 493         __u64                   lss_width;
 494
 495         /*
 496          * minimum lss_alloc_set size that should be allocated from
 497          * lss_space
 498          */
 499         __u64                   lss_set_width;
 500
 501         /* sync is needed for update operation */
 502         __u32                   lss_need_sync;
 503
 504         /**
 505          * Pointer to site object, required to access site fld.
 506          */
 507         struct seq_server_site  *lss_site;
 508 };
 509
 510 struct seq_server_site {
 511         struct lu_site       *ss_lu;
 512         /**
 513          * mds number of this site.
 514          */
 515         u32                   ss_node_id;
 516         /**
 517          * Fid location database
 518          */
 519         struct lu_server_fld *ss_server_fld;
 520         struct lu_client_fld *ss_client_fld;
 521
 522         /**
 523          * Server Seq Manager
 524          */
 525         struct lu_server_seq *ss_server_seq;
 526
 527         /**
 528          * Controller Seq Manager
 529          */
 530         struct lu_server_seq *ss_control_seq;
 531         struct obd_export    *ss_control_exp;
 532
 533         /**
 534          * Client Seq Manager
 535          */
 536         struct lu_client_seq *ss_client_seq;
 537 };
 538
 539 /* Server methods */
 540
 541 int seq_server_init(const struct lu_env *env,
 542                     struct lu_server_seq *seq,
 543                     struct dt_device *dev,
 544                     const char *prefix,
 545                     enum lu_mgr_type type,
 546                     struct seq_server_site *ss);
 547
 548 void seq_server_fini(struct lu_server_seq *seq,
 549                      const struct lu_env *env);
 550
 551 int seq_server_alloc_super(struct lu_server_seq *seq,
 552                            struct lu_seq_range *out,
 553                            const struct lu_env *env);
 554
 555 int seq_server_alloc_meta(struct lu_server_seq *seq,
 556                           struct lu_seq_range *out,
 557                           const struct lu_env *env);
 558
 559 int seq_server_set_cli(const struct lu_env *env,
 560                        struct lu_server_seq *seq,
 561                        struct lu_client_seq *cli);
 562
 563 int seq_server_check_and_alloc_super(const struct lu_env *env,
 564                                      struct lu_server_seq *seq);
 565 /* Client methods */
 566 void seq_client_init(struct lu_client_seq *seq,
 567                      struct obd_export *exp,
 568                      enum lu_cli_type type,
 569                      const char *prefix,
 570                      struct lu_server_seq *srv);
 571
 572 void seq_client_fini(struct lu_client_seq *seq);
 573
 574 void seq_client_flush(struct lu_client_seq *seq);
 575
 576 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
 577                          struct lu_fid *fid);
 578 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
 579                        u64 *seqnr);
 580 int seq_site_fini(const struct lu_env *env, struct seq_server_site *ss);
 581 /* Fids common stuff */
 582 int fid_is_local(const struct lu_env *env,
 583                  struct lu_site *site, const struct lu_fid *fid);
 584
 585 enum lu_cli_type;
 586 int client_fid_init(struct obd_device *obd, struct obd_export *exp,
 587                     enum lu_cli_type type);
 588 int client_fid_fini(struct obd_device *obd);
 589
 590 /* fid locking */
 591
 592 struct ldlm_namespace;
 593
 594 /*
 595  * Build (DLM) resource name from FID.
 596  *
 597  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
 598  * but was moved into name[1] along with the OID to avoid consuming the
 599  * renaming name[2,3] fields that need to be used for the quota identifier.
 600  */
 601 static inline void
 602 fid_build_reg_res_name(const struct lu_fid *fid, struct ldlm_res_id *res)
 603 {
 604         memset(res, 0, sizeof(*res));
 605         res->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(fid);
 606         res->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(fid);
 607 }
 608
 609 /*
 610  * Return true if resource is for object identified by FID.
 611  */
 612 static inline int fid_res_name_eq(const struct lu_fid *fid,
 613                                   const struct ldlm_res_id *res)
 614 {
 615         return res->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(fid) &&
 616                res->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(fid);
 617 }
 618
 619 /*
 620  * Extract FID from LDLM resource. Reverse of fid_build_reg_res_name().
 621  */
 622 static inline void
 623 fid_extract_from_res_name(struct lu_fid *fid, const struct ldlm_res_id *res)
 624 {
 625         fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
 626         fid->f_oid = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF]);
 627         fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
 628         LASSERT(fid_res_name_eq(fid, res));
 629 }
 630
 631 /*
 632  * Build (DLM) resource identifier from global quota FID and quota ID.
 633  */
 634 static inline void
 635 fid_build_quota_res_name(const struct lu_fid *glb_fid, union lquota_id *qid,
 636                       struct ldlm_res_id *res)
 637 {
 638         fid_build_reg_res_name(glb_fid, res);
 639         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
 640         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
 641 }
 642
 643 /*
 644  * Extract global FID and quota ID from resource name
 645  */
 646 static inline void fid_extract_from_quota_res(struct lu_fid *glb_fid,
 647                                               union lquota_id *qid,
 648                                               const struct ldlm_res_id *res)
 649 {
 650         fid_extract_from_res_name(glb_fid, res);
 651         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
 652         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
 653         qid->qid_fid.f_ver =
 654                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
 655 }
 656
 657 static inline void
 658 fid_build_pdo_res_name(const struct lu_fid *fid, unsigned int hash,
 659                        struct ldlm_res_id *res)
 660 {
 661         fid_build_reg_res_name(fid, res);
 662         res->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 663 }
 664
 665 /**
 666  * Build DLM resource name from object id & seq, which will be removed
 667  * finally, when we replace ost_id with FID in data stack.
 668  *
 669  * Currently, resid from the old client, whose res[0] = object_id,
 670  * res[1] = object_seq, is just oposite with Metatdata
 671  * resid, where, res[0] = fid->f_seq, res[1] = fid->f_oid.
 672  * To unifiy the resid identification, we will reverse the data
 673  * resid to keep it same with Metadata resid, i.e.
 674  *
 675  * For resid from the old client,
 676  *    res[0] = objid,  res[1] = 0, still keep the original order,
 677  *    for compatiblity.
 678  *
 679  * For new resid
 680  *    res will be built from normal FID directly, i.e. res[0] = f_seq,
 681  *    res[1] = f_oid + f_ver.
 682  */
 683 static inline void ostid_build_res_name(const struct ost_id *oi,
 684                                         struct ldlm_res_id *name)
 685 {
 686         memset(name, 0, sizeof *name);
 687         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 688                 name->name[LUSTRE_RES_ID_SEQ_OFF] = ostid_id(oi);
 689                 name->name[LUSTRE_RES_ID_VER_OID_OFF] = ostid_seq(oi);
 690         } else {
 691                 fid_build_reg_res_name(&oi->oi_fid, name);
 692         }
 693 }
 694
 695 /**
 696  * Return true if the resource is for the object identified by this id & group.
 697  */
 698 static inline bool ostid_res_name_eq(const struct ost_id *oi,
 699                                      const struct ldlm_res_id *name)
 700 {
 701         /* Note: it is just a trick here to save some effort, probably the
 702          * correct way would be turn them into the FID and compare */
 703         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 704                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_id(oi) &&
 705                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_seq(oi);
 706         } else {
 707                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_seq(oi) &&
 708                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_id(oi);
 709         }
 710 }
 711
 712 /**
 713  * Note: we need check oi_seq to decide where to set oi_id,
 714  * so oi_seq should always be set ahead of oi_id.
 715  */
 716 static inline int ostid_set_id(struct ost_id *oi, __u64 oid)
 717 {
 718         if (fid_seq_is_mdt0(oi->oi.oi_seq)) {
 719                 if (oid >= IDIF_MAX_OID)
 720                         return -E2BIG;
 721                 oi->oi.oi_id = oid;
 722         } else if (fid_is_idif(&oi->oi_fid)) {
 723                 if (oid >= IDIF_MAX_OID)
 724                         return -E2BIG;
 725                 oi->oi_fid.f_seq = fid_idif_seq(oid,
 726                                                 fid_idif_ost_idx(&oi->oi_fid));
 727                 oi->oi_fid.f_oid = oid;
 728                 oi->oi_fid.f_ver = oid >> 48;
 729         } else {
 730                 if (oid >= OBIF_MAX_OID)
 731                         return -E2BIG;
 732                 oi->oi_fid.f_oid = oid;
 733         }
 734         return 0;
 735 }
 736
 737 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
 738 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
 739 {
 740         int rc = 0;
 741
 742         if (fid_seq_is_igif(fid->f_seq))
 743                 return -EBADF;
 744
 745         if (fid_is_idif(fid)) {
 746                 ostid_set_seq_mdt0(ostid);
 747                 rc = ostid_set_id(ostid, fid_idif_id(fid_seq(fid),
 748                                   fid_oid(fid), fid_ver(fid)));
 749         } else {
 750                 ostid->oi_fid = *fid;
 751         }
 752
 753         return rc;
 754 }
 755
 756 /* The same as osc_build_res_name() */
 757 static inline void ost_fid_build_resid(const struct lu_fid *fid,
 758                                        struct ldlm_res_id *resname)
 759 {
 760         if (fid_is_mdt0(fid) || fid_is_idif(fid)) {
 761                 struct ost_id oi;
 762                 oi.oi.oi_id = 0; /* gcc 4.7.2 complains otherwise */
 763                 if (fid_to_ostid(fid, &oi) != 0)
 764                         return;
 765                 ostid_build_res_name(&oi, resname);
 766         } else {
 767                 fid_build_reg_res_name(fid, resname);
 768         }
 769 }
 770
 771 static inline void ost_fid_from_resid(struct lu_fid *fid,
 772                                       const struct ldlm_res_id *name,
 773                                       int ost_idx)
 774 {
 775         if (fid_seq_is_mdt0(name->name[LUSTRE_RES_ID_VER_OID_OFF])) {
 776                 /* old resid */
 777                 struct ost_id oi;
 778
 779                 memset(&oi, 0, sizeof(oi));
 780                 ostid_set_seq(&oi, name->name[LUSTRE_RES_ID_VER_OID_OFF]);
 781                 if (ostid_set_id(&oi, name->name[LUSTRE_RES_ID_SEQ_OFF])) {
 782                         CERROR("Bad %llu to set " DOSTID "\n",
 783                                name->name[LUSTRE_RES_ID_SEQ_OFF], POSTID(&oi));
 784                 }
 785                 ostid_to_fid(fid, &oi, ost_idx);
 786         } else {
 787                 /* new resid */
 788                 fid_extract_from_res_name(fid, name);
 789         }
 790 }
 791
 792 /**
 793  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
 794  * For non-IGIF FIDs this starts just over 2^32, and continues without
 795  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
 796  * into the range where there may not be many OID values in use, to minimize
 797  * the risk of conflict.
 798  *
 799  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
 800  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
 801  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
 802  */
 803 static inline __u64 fid_flatten(const struct lu_fid *fid)
 804 {
 805         __u64 ino;
 806         __u64 seq;
 807
 808         if (fid_is_igif(fid)) {
 809                 ino = lu_igif_ino(fid);
 810                 return ino;
 811         }
 812
 813         seq = fid_seq(fid);
 814
 815         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
 816
 817         return ino ?: fid_oid(fid);
 818 }
 819
 820 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
 821 {
 822         /* all objects with same id and different versions will belong to same
 823          * collisions list. */
 824         return hash_long(fid_flatten(f), bits);
 825 }
 826
 827 /**
 828  * map fid to 32 bit value for ino on 32bit systems. */
 829 static inline __u32 fid_flatten32(const struct lu_fid *fid)
 830 {
 831         __u32 ino;
 832         __u64 seq;
 833
 834         if (fid_is_igif(fid)) {
 835                 ino = lu_igif_ino(fid);
 836                 return ino;
 837         }
 838
 839         seq = fid_seq(fid) - FID_SEQ_START;
 840
 841         /* Map the high bits of the OID into higher bits of the inode number so
 842          * that inodes generated at about the same time have a reduced chance
 843          * of collisions. This will give a period of 2^12 = 1024 unique clients
 844          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
 845          * (from OID), or up to 128M inodes without collisions for new files. */
 846         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
 847               (seq >> (64 - (40-8)) & 0xffffff00) +
 848               (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
 849
 850         return ino ?: fid_oid(fid);
 851 }
 852
 853 static inline int
 854 lu_fid_diff(const struct lu_fid *fid1, const struct lu_fid *fid2)
 855 {
 856         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:"DFID", fid2:"DFID"\n",
 857                  PFID(fid1), PFID(fid2));
 858
 859         if (fid_is_idif(fid1) && fid_is_idif(fid2))
 860                 return fid_idif_id(fid1->f_seq, fid1->f_oid, fid1->f_ver) -
 861                        fid_idif_id(fid2->f_seq, fid2->f_oid, fid2->f_ver);
 862
 863         return fid_oid(fid1) - fid_oid(fid2);
 864 }
 865
 866 static inline int fid_set_id(struct lu_fid *fid, u64 oid)
 867 {
 868         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
 869                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
 870                 return -EBADF;
 871         }
 872
 873         if (fid_is_idif(fid)) {
 874                 if (oid >= IDIF_MAX_OID) {
 875                         CERROR("Too large OID %#llx to set IDIF "DFID"\n",
 876                                (unsigned long long)oid, PFID(fid));
 877                         return -EBADF;
 878                 }
 879                 fid->f_seq = fid_idif_seq(oid, fid_idif_ost_idx(fid));
 880                 fid->f_oid = oid;
 881                 fid->f_ver = oid >> 48;
 882         } else {
 883                 if (oid > OBIF_MAX_OID) {
 884                         CERROR("Too large OID %#llx to set REG "DFID"\n",
 885                                (unsigned long long)oid, PFID(fid));
 886                         return -EBADF;
 887                 }
 888                 fid->f_oid = oid;
 889         }
 890         return 0;
 891 }
 892
 893 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 894 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 895
 896 /* Range common stuff */
 897 static inline void
 898 range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 899 {
 900         dst->lsr_start = cpu_to_le64(src->lsr_start);
 901         dst->lsr_end = cpu_to_le64(src->lsr_end);
 902         dst->lsr_index = cpu_to_le32(src->lsr_index);
 903         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
 904 }
 905
 906 static inline void
 907 range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 908 {
 909         dst->lsr_start = le64_to_cpu(src->lsr_start);
 910         dst->lsr_end = le64_to_cpu(src->lsr_end);
 911         dst->lsr_index = le32_to_cpu(src->lsr_index);
 912         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
 913 }
 914
 915 static inline void
 916 range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 917 {
 918         dst->lsr_start = cpu_to_be64(src->lsr_start);
 919         dst->lsr_end = cpu_to_be64(src->lsr_end);
 920         dst->lsr_index = cpu_to_be32(src->lsr_index);
 921         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
 922 }
 923
 924 static inline void
 925 range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 926 {
 927         dst->lsr_start = be64_to_cpu(src->lsr_start);
 928         dst->lsr_end = be64_to_cpu(src->lsr_end);
 929         dst->lsr_index = be32_to_cpu(src->lsr_index);
 930         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
 931 }
 932
 933 static inline void range_array_cpu_to_le(struct lu_seq_range_array *dst,
 934                                          const struct lu_seq_range_array *src)
 935 {
 936         __u32 i;
 937
 938         for (i = 0; i < src->lsra_count; i++)
 939                 range_cpu_to_le(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
 940
 941         dst->lsra_count = cpu_to_le32(src->lsra_count);
 942 }
 943
 944 static inline void range_array_le_to_cpu(struct lu_seq_range_array *dst,
 945                                          const struct lu_seq_range_array *src)
 946 {
 947         __u32 i;
 948
 949         dst->lsra_count = le32_to_cpu(src->lsra_count);
 950         for (i = 0; i < dst->lsra_count; i++)
 951                 range_le_to_cpu(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
 952 }
 953
 954 /** @} fid */
 955
 956 #endif /* __LUSTRE_FID_H */