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  *
  31  * lustre/include/lustre_fid.h
  32  *
  33  * Author: Yury Umanets <umka@clusterfs.com>
  34  */
  35
  36 #ifndef __LUSTRE_FID_H
  37 #define __LUSTRE_FID_H
  38
  39 /** \defgroup fid fid
  40  *
  41  * @{
  42  *
  43  * http://wiki.lustre.org/index.php/Architecture_-_Interoperability_fids_zfs
  44  * describes the FID namespace and interoperability requirements for FIDs.
  45  * The important parts of that document are included here for reference.
  46  *
  47  * FID
  48  *   File IDentifier generated by client from range allocated by the SEQuence
  49  *   service and stored in struct lu_fid. The FID is composed of three parts:
  50  *   SEQuence, ObjectID, and VERsion.  The SEQ component is a filesystem
  51  *   unique 64-bit integer, and only one client is ever assigned any SEQ value.
  52  *   The first 0x400 FID_SEQ_NORMAL [2^33, 2^33 + 0x400] values are reserved
  53  *   for system use.  The OID component is a 32-bit value generated by the
  54  *   client on a per-SEQ basis to allow creating many unique FIDs without
  55  *   communication with the server.  The VER component is a 32-bit value that
  56  *   distinguishes between different FID instantiations, such as snapshots or
  57  *   separate subtrees within the filesystem.  FIDs with the same VER field
  58  *   are considered part of the same namespace.
  59  *
  60  * OLD filesystems are those upgraded from Lustre 1.x that predate FIDs, and
  61  *   MDTs use 32-bit ldiskfs internal inode/generation numbers (IGIFs), while
  62  *   OSTs use 64-bit Lustre object IDs and generation numbers.
  63  *
  64  * NEW filesystems are those formatted since the introduction of FIDs.
  65  *
  66  * IGIF
  67  *   Inode and Generation In FID, a surrogate FID used to globally identify
  68  *   an existing object on OLD formatted MDT file system. This would only be
  69  *   used on MDT0 in a DNE filesystem, because there cannot be more than one
  70  *   MDT in an OLD formatted filesystem. Belongs to sequence in [12, 2^32 - 1]
  71  *   range, where inode number is stored in SEQ, and inode generation is in OID.
  72  *   NOTE: This assumes no more than 2^32-1 inodes exist in the MDT filesystem,
  73  *   which is the maximum possible for an ldiskfs backend.  It also assumes
  74  *   that the reserved ext3/ext4/ldiskfs inode numbers [0-11] are never visible
  75  *   to clients, which has always been true.
  76  *
  77  * IDIF
  78  *   object ID In FID, a surrogate FID used to globally identify an existing
  79  *   OST object on OLD formatted OST file system. Belongs to a sequence in
  80  *   [2^32, 2^33 - 1]. Sequence number is calculated as:
  81  *
  82  *      1 << 32 | (ost_index << 16) | ((objid >> 32) & 0xffff)
  83  *
  84  *   that is, SEQ consists of 16-bit OST index, and higher 16 bits of object
  85  *   ID. The generation of unique SEQ values per OST allows the IDIF FIDs to
  86  *   be identified in the FLD correctly. The OID field is calculated as:
  87  *
  88  *      objid & 0xffffffff
  89  *
  90  *   that is, it consists of lower 32 bits of object ID.  For objects within
  91  *   the IDIF range, object ID extraction will be:
  92  *
  93  *      o_id = (fid->f_seq & 0x7fff) << 16 | fid->f_oid;
  94  *      o_seq = 0;  // formerly group number
  95  *
  96  *   NOTE: This assumes that no more than 2^48-1 objects have ever been created
  97  *   on any OST, and that no more than 65535 OSTs are in use.  Both are very
  98  *   reasonable assumptions, i.e. an IDIF can uniquely map all objects assuming
  99  *   a maximum creation rate of 1M objects per second for a maximum of 9 years,
 100  *   or combinations thereof.
 101  *
 102  * OST_MDT0
 103  *   Surrogate FID used to identify an existing object on OLD formatted OST
 104  *   filesystem. Belongs to the reserved SEQuence 0, and is used prior to
 105  *   the introduction of FID-on-OST, at which point IDIF will be used to
 106  *   identify objects as residing on a specific OST.
 107  *
 108  * LLOG
 109  *   For Lustre Log objects the object sequence 1 is used. This is compatible
 110  *   with both OLD and NEW namespaces, as this SEQ number is in the
 111  *   ext3/ldiskfs reserved inode range and does not conflict with IGIF
 112  *   sequence numbers.
 113  *
 114  * ECHO
 115  *   For testing OST IO performance the object sequence 2 is used. This is
 116  *   compatible with both OLD and NEW namespaces, as this SEQ number is in
 117  *   the ext3/ldiskfs reserved inode range and does not conflict with IGIF
 118  *   sequence numbers.
 119  *
 120  * OST_MDT1 .. OST_MAX
 121  *   For testing with multiple MDTs the object sequence 3 through 9 is used,
 122  *   allowing direct mapping of MDTs 1 through 7 respectively, for a total
 123  *   of 8 MDTs including OST_MDT0. This matches the legacy CMD project "group"
 124  *   mappings. However, this SEQ range is only for testing prior to any
 125  *   production DNE release, as the objects in this range conflict across all
 126  *   OSTs, as the OST index is not part of the FID.  For production DNE usage,
 127  *   OST objects created by MDT1+ will use FID_SEQ_NORMAL FIDs.
 128  *
 129  * DLM OST objid to IDIF mapping
 130  *   For compatibility with existing OLD OST network protocol structures, the
 131  *   FID must map onto the o_id and o_seq in a manner that ensures existing
 132  *   objects are identified consistently for IO, as well as onto the LDLM
 133  *   namespace to ensure IDIFs there is only a single resource name for any
 134  *   object in the DLM.  The OLD OST object DLM resource mapping is:
 135  *
 136  *      resource[] = {o_id, o_seq, 0, 0}; // o_seq == 0 for production releases
 137  *
 138  *   The NEW OST object DLM resource mapping is the same for both MDT and OST:
 139  *
 140  *      resource[] = {SEQ, OID, VER, HASH};
 141  *
 142  *  NOTE: for mapping IDIF values to DLM resource names the o_id may be
 143  *  larger than the 2^33 reserved sequence numbers for IDIF, so it is possible
 144  *  for the o_id numbers to overlap FID SEQ numbers in the resource. However,
 145  *  in all production releases the OLD o_seq field is always zero, and all
 146  *  valid FID OID values are non-zero, so the lock resources will not collide.
 147  *  Even so, the MDT and OST resources are also in different LDLM namespaces.
 148  */
 149
 150 #include <libcfs/libcfs.h>
 151 #include <uapi/linux/lustre/lustre_fid.h>
 152 #include <uapi/linux/lustre/lustre_idl.h>
 153 #include <uapi/linux/lustre/lustre_ostid.h>
 154
 155 /* Lustre service names are following the format
 156  * service name + MDT + seq name
 157  */
 158 #define LUSTRE_MDT_MAXNAMELEN           80
 159
 160 struct lu_env;
 161 struct lu_site;
 162 struct lu_context;
 163 struct obd_device;
 164 struct obd_export;
 165
 166 /* Whole sequences space range and zero range definitions */
 167 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
 168 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
 169 extern const struct lu_fid LUSTRE_BFL_FID;
 170 extern const struct lu_fid LU_LPF_FID;
 171 extern const struct lu_fid LU_BACKEND_LPF_FID;
 172
 173 enum {
 174         /* Max Number metadata FIDs allocated in one sequence(128k) */
 175         LUSTRE_METADATA_SEQ_MAX_WIDTH = 0x0000000000020000ULL,
 176
 177         /* Max Number data FIDs allocated in one sequence(32M - 1) */
 178         LUSTRE_DATA_SEQ_MAX_WIDTH = 0x0000000001FFFFFFULL,
 179
 180         /* How many sequences to allocate to a client at once */
 181         LUSTRE_SEQ_META_WIDTH = 0x0000000000000001ULL,
 182
 183         /* seq allocation pool size. */
 184         LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
 185
 186         /* Max number sequences in one super-sequence allocated to MDTs */
 187         LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
 188 };
 189
 190 /** special OID for local objects */
 191 enum local_oid {
 192         /** \see fld_mod_init */
 193         FLD_INDEX_OID           = 3UL,
 194         /** \see fid_mod_init */
 195         FID_SEQ_CTL_OID         = 4UL,
 196         FID_SEQ_SRV_OID         = 5UL,
 197         /** \see mdd_mod_init */
 198         MDD_ROOT_INDEX_OID      = 6UL, /* deprecated in 2.4 */
 199         MDD_ORPHAN_OID          = 7UL, /* deprecated in 2.4 */
 200         MDD_LOV_OBJ_OID         = 8UL,
 201         MDD_CAPA_KEYS_OID       = 9UL,
 202         /** \see mdt_mod_init */
 203         LAST_RECV_OID           = 11UL,
 204         OSD_FS_ROOT_OID         = 13UL,
 205         ACCT_USER_OID           = 15UL,
 206         ACCT_GROUP_OID          = 16UL,
 207         LFSCK_BOOKMARK_OID      = 17UL,
 208         OTABLE_IT_OID           = 18UL,
 209         OSD_LPF_OID             = 19UL,
 210         REPLY_DATA_OID          = 21UL,
 211         ACCT_PROJECT_OID        = 22UL,
 212         INDEX_BACKUP_OID        = 4116UL,
 213         OFD_LAST_GROUP_OID      = 4117UL,
 214         LLOG_CATALOGS_OID       = 4118UL,
 215         MGS_CONFIGS_OID         = 4119UL,
 216         OFD_HEALTH_CHECK_OID    = 4120UL,
 217         MDD_LOV_OBJ_OSEQ        = 4121UL,
 218         LFSCK_NAMESPACE_OID     = 4122UL,
 219         REMOTE_PARENT_DIR_OID   = 4123UL,
 220         /* This definition is obsolete
 221          * SLAVE_LLOG_CATALOGS_OID      = 4124UL,
 222          */
 223         BATCHID_COMMITTED_OID   = 4125UL,
 224 };
 225
 226 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
 227 {
 228         fid->f_seq = FID_SEQ_LOCAL_FILE;
 229         fid->f_oid = oid;
 230         fid->f_ver = 0;
 231 }
 232
 233 static inline void lu_local_name_obj_fid(struct lu_fid *fid, __u32 oid)
 234 {
 235         fid->f_seq = FID_SEQ_LOCAL_NAME;
 236         fid->f_oid = oid;
 237         fid->f_ver = 0;
 238 }
 239
 240 /* For new FS (>= 2.4), the root FID will be changed to
 241  * [FID_SEQ_ROOT:1:0], for existing FS, (upgraded to 2.4),
 242  * the root FID will still be IGIF
 243  */
 244 static inline int fid_is_root(const struct lu_fid *fid)
 245 {
 246         return unlikely(lu_fid_eq(fid, &LU_ROOT_FID));
 247 }
 248
 249 static inline int fid_is_dot_lustre(const struct lu_fid *fid)
 250 {
 251         return unlikely(lu_fid_eq(fid, &LU_DOT_LUSTRE_FID));
 252 }
 253
 254 static inline int fid_is_obf(const struct lu_fid *fid)
 255 {
 256         return unlikely(lu_fid_eq(fid, &LU_OBF_FID));
 257 }
 258
 259 static inline int fid_is_otable_it(const struct lu_fid *fid)
 260 {
 261         return unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
 262                         fid_oid(fid) == OTABLE_IT_OID);
 263 }
 264
 265 static inline int fid_oid_is_quota(const struct lu_fid *fid)
 266 {
 267         switch (fid_oid(fid)) {
 268         case ACCT_USER_OID:
 269         case ACCT_GROUP_OID:
 270         case ACCT_PROJECT_OID:
 271                 return 1;
 272         default:
 273                 return 0;
 274         }
 275 }
 276
 277 static inline int fid_is_acct(const struct lu_fid *fid)
 278 {
 279         return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
 280                fid_oid_is_quota(fid);
 281 }
 282
 283 static inline int fid_is_quota(const struct lu_fid *fid)
 284 {
 285         return fid_seq(fid) == FID_SEQ_QUOTA ||
 286                fid_seq(fid) == FID_SEQ_QUOTA_GLB;
 287 }
 288
 289 static inline int fid_is_name_llog(const struct lu_fid *fid)
 290 {
 291         return fid_seq(fid) == FID_SEQ_LLOG_NAME;
 292 }
 293
 294 static inline int fid_seq_in_fldb(u64 seq)
 295 {
 296         return fid_seq_is_igif(seq) || fid_seq_is_norm(seq) ||
 297                fid_seq_is_root(seq) || fid_seq_is_dot(seq);
 298 }
 299
 300 #ifdef HAVE_SERVER_SUPPORT
 301 static inline int fid_is_namespace_visible(const struct lu_fid *fid)
 302 {
 303         const __u64 seq = fid_seq(fid);
 304
 305         /* Here, we cannot distinguish whether the normal FID is for OST
 306          * object or not. It is caller's duty to check more if needed.
 307          */
 308         return (!fid_is_last_id(fid) &&
 309                 (fid_seq_is_norm(seq) || fid_seq_is_igif(seq))) ||
 310                fid_is_root(fid) || fid_seq_is_dot(seq);
 311 }
 312
 313 static inline void ost_layout_cpu_to_le(struct ost_layout *dst,
 314                                         const struct ost_layout *src)
 315 {
 316         dst->ol_stripe_size = __cpu_to_le32(src->ol_stripe_size);
 317         dst->ol_stripe_count = __cpu_to_le32(src->ol_stripe_count);
 318         dst->ol_comp_start = __cpu_to_le64(src->ol_comp_start);
 319         dst->ol_comp_end = __cpu_to_le64(src->ol_comp_end);
 320         dst->ol_comp_id = __cpu_to_le32(src->ol_comp_id);
 321 }
 322
 323 static inline void ost_layout_le_to_cpu(struct ost_layout *dst,
 324                                         const struct ost_layout *src)
 325 {
 326         dst->ol_stripe_size = __le32_to_cpu(src->ol_stripe_size);
 327         dst->ol_stripe_count = __le32_to_cpu(src->ol_stripe_count);
 328         dst->ol_comp_start = __le64_to_cpu(src->ol_comp_start);
 329         dst->ol_comp_end = __le64_to_cpu(src->ol_comp_end);
 330         dst->ol_comp_id = __le32_to_cpu(src->ol_comp_id);
 331 }
 332
 333 static inline void filter_fid_cpu_to_le(struct filter_fid *dst,
 334                                         const struct filter_fid *src, int size)
 335 {
 336         fid_cpu_to_le(&dst->ff_parent, &src->ff_parent);
 337
 338         if (size < sizeof(struct filter_fid)) {
 339                 memset(&dst->ff_layout, 0, sizeof(dst->ff_layout));
 340         } else {
 341                 ost_layout_cpu_to_le(&dst->ff_layout, &src->ff_layout);
 342                 dst->ff_layout_version = cpu_to_le32(src->ff_layout_version);
 343                 dst->ff_range = cpu_to_le32(src->ff_range);
 344         }
 345
 346         /* XXX: Add more if filter_fid is enlarged in the future. */
 347 }
 348
 349 static inline void filter_fid_le_to_cpu(struct filter_fid *dst,
 350                                         const struct filter_fid *src, int size)
 351 {
 352         fid_le_to_cpu(&dst->ff_parent, &src->ff_parent);
 353
 354         if (size < sizeof(struct filter_fid)) {
 355                 memset(&dst->ff_layout, 0, sizeof(dst->ff_layout));
 356         } else {
 357                 ost_layout_le_to_cpu(&dst->ff_layout, &src->ff_layout);
 358                 dst->ff_layout_version = le32_to_cpu(src->ff_layout_version);
 359                 dst->ff_range = le32_to_cpu(src->ff_range);
 360         }
 361
 362         /* XXX: Add more if filter_fid is enlarged in the future. */
 363 }
 364 #endif /* HAVE_SERVER_SUPPORT */
 365
 366 static inline void lu_last_id_fid(struct lu_fid *fid, __u64 seq, __u32 ost_idx)
 367 {
 368         if (fid_seq_is_mdt0(seq)) {
 369                 fid->f_seq = fid_idif_seq(0, ost_idx);
 370         } else {
 371                 LASSERTF(fid_seq_is_norm(seq) || fid_seq_is_echo(seq) ||
 372                          fid_seq_is_idif(seq), "%#llx\n", seq);
 373                 fid->f_seq = seq;
 374         }
 375         fid->f_oid = 0;
 376         fid->f_ver = 0;
 377 }
 378
 379 static inline bool fid_is_md_operative(const struct lu_fid *fid)
 380 {
 381         return fid_is_mdt0(fid) || fid_is_igif(fid) ||
 382                fid_is_norm(fid) || fid_is_root(fid);
 383 }
 384
 385 /* seq client type */
 386 enum lu_cli_type {
 387         LUSTRE_SEQ_METADATA = 1,
 388         LUSTRE_SEQ_DATA
 389 };
 390
 391 enum lu_mgr_type {
 392         LUSTRE_SEQ_SERVER,
 393         LUSTRE_SEQ_CONTROLLER
 394 };
 395
 396 struct lu_server_seq;
 397
 398 /* Client sequence manager interface. */
 399 struct lu_client_seq {
 400         /* Sequence-controller export. */
 401         struct obd_export       *lcs_exp;
 402         struct mutex            lcs_mutex;
 403
 404         /*
 405          * Range of allowed for allocation sequeces. When using lu_client_seq on
 406          * clients, this contains meta-sequence range. And for servers this
 407          * contains super-sequence range.
 408          */
 409         struct lu_seq_range     lcs_space;
 410
 411         /* Seq related debugfs */
 412         struct dentry           *lcs_debugfs_entry;
 413
 414         /* This holds last allocated fid in last obtained seq */
 415         struct lu_fid           lcs_fid;
 416
 417         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 418         enum lu_cli_type        lcs_type;
 419
 420         /*
 421          * Service uuid, passed from MDT + seq name to form unique seq name to
 422          * use it with debugfs.
 423          */
 424         char                    lcs_name[LUSTRE_MDT_MAXNAMELEN];
 425
 426         /*
 427          * Sequence width, that is how many objects may be allocated in one
 428          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 429          */
 430         __u64                   lcs_width;
 431
 432         /* Seq-server for direct talking */
 433         struct lu_server_seq    *lcs_srv;
 434 };
 435
 436 /* server sequence manager interface */
 437 struct lu_server_seq {
 438         /* Available sequences space */
 439         struct lu_seq_range         lss_space;
 440
 441         /* keeps highwater in lsr_end for seq allocation algorithm */
 442         struct lu_seq_range         lss_lowater_set;
 443         struct lu_seq_range         lss_hiwater_set;
 444
 445         /* Device for server side seq manager need saving seq to backingstore */
 446         struct dt_device       *lss_dev;
 447
 448         /* /seq file object device */
 449         struct dt_object       *lss_obj;
 450
 451         /* Seq related debugfs */
 452         struct dentry           *lss_debugfs_entry;
 453
 454         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
 455         enum lu_mgr_type       lss_type;
 456
 457         /* Client interface to request controller */
 458         struct lu_client_seq   *lss_cli;
 459
 460         /* Mutex for protecting allocation */
 461         struct mutex            lss_mutex;
 462
 463         /*
 464          * Service uuid, passed from MDT + seq name to form unique seq name to
 465          * use it with debugfs.
 466          */
 467         char                    lss_name[LUSTRE_MDT_MAXNAMELEN];
 468
 469         /*
 470          * Allocation chunks for super and meta sequences. Default values are
 471          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
 472          */
 473         __u64                   lss_width;
 474
 475         /* minimum lss_alloc_set size that should be allocated from lss_space */
 476         __u64                   lss_set_width;
 477
 478         /* sync is needed for update operation */
 479         __u32                   lss_need_sync;
 480
 481          /* Pointer to site object, required to access site fld */
 482         struct seq_server_site  *lss_site;
 483 };
 484
 485 struct seq_server_site {
 486         struct lu_site       *ss_lu;
 487         /* mds number of this site */
 488         u32                   ss_node_id;
 489         /* Fid location database */
 490         struct lu_server_fld *ss_server_fld;
 491         struct lu_client_fld *ss_client_fld;
 492
 493         /* Server Seq Manager */
 494         struct lu_server_seq *ss_server_seq;
 495
 496         /* Controller Seq Manager */
 497         struct lu_server_seq *ss_control_seq;
 498         struct obd_export    *ss_control_exp;
 499
 500         /* Client Seq Manager */
 501         struct lu_client_seq *ss_client_seq;
 502 };
 503
 504 /* Server methods */
 505
 506 int seq_server_init(const struct lu_env *env,
 507                     struct lu_server_seq *seq,
 508                     struct dt_device *dev,
 509                     const char *prefix,
 510                     enum lu_mgr_type type,
 511                     struct seq_server_site *ss);
 512
 513 void seq_server_fini(struct lu_server_seq *seq,
 514                      const struct lu_env *env);
 515
 516 int seq_server_alloc_super(struct lu_server_seq *seq,
 517                            struct lu_seq_range *out,
 518                            const struct lu_env *env);
 519
 520 int seq_server_alloc_meta(struct lu_server_seq *seq,
 521                           struct lu_seq_range *out, const struct lu_env *env);
 522
 523 int seq_server_set_cli(const struct lu_env *env,
 524                        struct lu_server_seq *seq,
 525                        struct lu_client_seq *cli);
 526
 527 int seq_server_check_and_alloc_super(const struct lu_env *env,
 528                                      struct lu_server_seq *seq);
 529 /* Client methods */
 530 void seq_client_init(struct lu_client_seq *seq,
 531                      struct obd_export *exp,
 532                      enum lu_cli_type type,
 533                      const char *prefix,
 534                      struct lu_server_seq *srv);
 535
 536 void seq_client_fini(struct lu_client_seq *seq);
 537
 538 void seq_client_flush(struct lu_client_seq *seq);
 539
 540 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
 541                          struct lu_fid *fid);
 542 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
 543                        u64 *seqnr);
 544 int seq_site_fini(const struct lu_env *env, struct seq_server_site *ss);
 545 /* Fids common stuff */
 546 int fid_is_local(const struct lu_env *env, struct lu_site *site,
 547                  const struct lu_fid *fid);
 548
 549 enum lu_cli_type;
 550 int client_fid_init(struct obd_device *obd, struct obd_export *exp,
 551                     enum lu_cli_type type);
 552 int client_fid_fini(struct obd_device *obd);
 553
 554 /* fid locking */
 555
 556 struct ldlm_namespace;
 557
 558 /*
 559  * Build (DLM) resource name from FID.
 560  *
 561  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
 562  * but was moved into name[1] along with the OID to avoid consuming the
 563  * renaming name[2,3] fields that need to be used for the quota identifier.
 564  */
 565 static inline void
 566 fid_build_reg_res_name(const struct lu_fid *fid, struct ldlm_res_id *res)
 567 {
 568         memset(res, 0, sizeof(*res));
 569         res->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(fid);
 570         res->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(fid);
 571 }
 572
 573 /*
 574  * Return true if resource is for object identified by FID.
 575  */
 576 static inline int fid_res_name_eq(const struct lu_fid *fid,
 577                                   const struct ldlm_res_id *res)
 578 {
 579         return res->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(fid) &&
 580                res->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(fid);
 581 }
 582
 583 /*
 584  * Extract FID from LDLM resource. Reverse of fid_build_reg_res_name().
 585  */
 586 static inline void
 587 fid_extract_from_res_name(struct lu_fid *fid, const struct ldlm_res_id *res)
 588 {
 589         fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
 590         fid->f_oid = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF]);
 591         fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
 592         LASSERT(fid_res_name_eq(fid, res));
 593 }
 594
 595 /*
 596  * Build (DLM) resource identifier from global quota FID and quota ID.
 597  */
 598 static inline void
 599 fid_build_quota_res_name(const struct lu_fid *glb_fid, union lquota_id *qid,
 600                       struct ldlm_res_id *res)
 601 {
 602         fid_build_reg_res_name(glb_fid, res);
 603         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
 604         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
 605 }
 606
 607 /*
 608  * Extract global FID and quota ID from resource name
 609  */
 610 static inline void fid_extract_from_quota_res(struct lu_fid *glb_fid,
 611                                               union lquota_id *qid,
 612                                               const struct ldlm_res_id *res)
 613 {
 614         fid_extract_from_res_name(glb_fid, res);
 615         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
 616         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
 617         qid->qid_fid.f_ver =
 618                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
 619 }
 620
 621 static inline void
 622 fid_build_pdo_res_name(const struct lu_fid *fid, unsigned int hash,
 623                        struct ldlm_res_id *res)
 624 {
 625         fid_build_reg_res_name(fid, res);
 626         res->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 627 }
 628
 629 /**
 630  * Build DLM resource name from object id & seq, which will be removed
 631  * finally, when we replace ost_id with FID in data stack.
 632  *
 633  * Currently, resid from the old client, whose res[0] = object_id,
 634  * res[1] = object_seq, is just oposite with Metatdata
 635  * resid, where, res[0] = fid->f_seq, res[1] = fid->f_oid.
 636  * To unifiy the resid identification, we will reverse the data
 637  * resid to keep it same with Metadata resid, i.e.
 638  *
 639  * For resid from the old client,
 640  *    res[0] = objid,  res[1] = 0, still keep the original order,
 641  *    for compatiblity.
 642  *
 643  * For new resid
 644  *    res will be built from normal FID directly, i.e. res[0] = f_seq,
 645  *    res[1] = f_oid + f_ver.
 646  */
 647 static inline void ostid_build_res_name(const struct ost_id *oi,
 648                                         struct ldlm_res_id *name)
 649 {
 650         memset(name, 0, sizeof(*name));
 651         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 652                 name->name[LUSTRE_RES_ID_SEQ_OFF] = ostid_id(oi);
 653                 name->name[LUSTRE_RES_ID_VER_OID_OFF] = ostid_seq(oi);
 654         } else {
 655                 fid_build_reg_res_name(&oi->oi_fid, name);
 656         }
 657 }
 658
 659 /**
 660  * Return true if the resource is for the object identified by this id & group.
 661  */
 662 static inline bool ostid_res_name_eq(const struct ost_id *oi,
 663                                      const struct ldlm_res_id *name)
 664 {
 665         /* Note: it is just a trick here to save some effort, probably the
 666          * correct way would be turn them into the FID and compare
 667          */
 668         if (fid_seq_is_mdt0(ostid_seq(oi))) {
 669                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_id(oi) &&
 670                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_seq(oi);
 671         } else {
 672                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_seq(oi) &&
 673                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_id(oi);
 674         }
 675 }
 676
 677 /**
 678  * Note: we need check oi_seq to decide where to set oi_id,
 679  * so oi_seq should always be set ahead of oi_id.
 680  */
 681 static inline int ostid_set_id(struct ost_id *oi, __u64 oid)
 682 {
 683         if (fid_seq_is_mdt0(oi->oi.oi_seq)) {
 684                 if (oid > IDIF_MAX_OID)
 685                         return -E2BIG;
 686                 oi->oi.oi_id = oid;
 687         } else if (fid_is_idif(&oi->oi_fid)) {
 688                 if (oid > IDIF_MAX_OID)
 689                         return -E2BIG;
 690                 oi->oi_fid.f_seq = fid_idif_seq(oid,
 691                                                 fid_idif_ost_idx(&oi->oi_fid));
 692                 oi->oi_fid.f_oid = oid;
 693                 oi->oi_fid.f_ver = oid >> 48;
 694         } else {
 695                 if (oid > OBIF_MAX_OID)
 696                         return -E2BIG;
 697                 oi->oi_fid.f_oid = oid;
 698         }
 699         return 0;
 700 }
 701
 702 /* pack any OST FID into an ostid (id/seq) for the wire/disk */
 703 static inline int fid_to_ostid(const struct lu_fid *fid, struct ost_id *ostid)
 704 {
 705         int rc = 0;
 706
 707         if (fid_seq_is_igif(fid->f_seq))
 708                 return -EBADF;
 709
 710         if (fid_is_idif(fid)) {
 711                 ostid_set_seq_mdt0(ostid);
 712                 rc = ostid_set_id(ostid, fid_idif_id(fid_seq(fid),
 713                                   fid_oid(fid), fid_ver(fid)));
 714         } else {
 715                 ostid->oi_fid = *fid;
 716         }
 717
 718         return rc;
 719 }
 720
 721 /* The same as osc_build_res_name() */
 722 static inline void ost_fid_build_resid(const struct lu_fid *fid,
 723                                        struct ldlm_res_id *resname)
 724 {
 725         if (fid_is_mdt0(fid) || fid_is_idif(fid)) {
 726                 struct ost_id oi;
 727
 728                 oi.oi.oi_id = 0; /* gcc 4.7.2 complains otherwise */
 729                 if (fid_to_ostid(fid, &oi) != 0)
 730                         return;
 731                 ostid_build_res_name(&oi, resname);
 732         } else {
 733                 fid_build_reg_res_name(fid, resname);
 734         }
 735 }
 736
 737 static inline void ost_fid_from_resid(struct lu_fid *fid,
 738                                       const struct ldlm_res_id *name,
 739                                       int ost_idx)
 740 {
 741         if (fid_seq_is_mdt0(name->name[LUSTRE_RES_ID_VER_OID_OFF])) {
 742                 /* old resid */
 743                 struct ost_id oi;
 744
 745                 memset(&oi, 0, sizeof(oi));
 746                 ostid_set_seq(&oi, name->name[LUSTRE_RES_ID_VER_OID_OFF]);
 747                 if (ostid_set_id(&oi, name->name[LUSTRE_RES_ID_SEQ_OFF])) {
 748                         CERROR("Bad %llu to set " DOSTID "\n",
 749                                name->name[LUSTRE_RES_ID_SEQ_OFF], POSTID(&oi));
 750                 }
 751                 ostid_to_fid(fid, &oi, ost_idx);
 752         } else {
 753                 /* new resid */
 754                 fid_extract_from_res_name(fid, name);
 755         }
 756 }
 757
 758 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
 759 {
 760         /*
 761          * All objects with same id and different versions will belong to same
 762          * collisions list.
 763          */
 764         return cfs_hash_long(fid_flatten64(f), bits);
 765 }
 766
 767 u32 lu_fid_hash(const void *data, u32 len, u32 seed);
 768
 769 static inline int fid_set_id(struct lu_fid *fid, u64 oid)
 770 {
 771         if (unlikely(fid_seq_is_igif(fid->f_seq))) {
 772                 CERROR("bad IGIF, "DFID"\n", PFID(fid));
 773                 return -EBADF;
 774         }
 775
 776         if (fid_is_idif(fid)) {
 777                 if (oid > IDIF_MAX_OID) {
 778                         CERROR("Too large OID %#llx to set IDIF "DFID"\n",
 779                                (unsigned long long)oid, PFID(fid));
 780                         return -EBADF;
 781                 }
 782                 fid->f_seq = fid_idif_seq(oid, fid_idif_ost_idx(fid));
 783                 fid->f_oid = oid;
 784                 fid->f_ver = oid >> 48;
 785         } else {
 786                 if (oid > OBIF_MAX_OID) {
 787                         CERROR("Too large OID %#llx to set REG "DFID"\n",
 788                                (unsigned long long)oid, PFID(fid));
 789                         return -EBADF;
 790                 }
 791                 fid->f_oid = oid;
 792         }
 793         return 0;
 794 }
 795
 796 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 797 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 798
 799 /* Range common stuff */
 800 static inline void
 801 range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 802 {
 803         dst->lsr_start = cpu_to_le64(src->lsr_start);
 804         dst->lsr_end = cpu_to_le64(src->lsr_end);
 805         dst->lsr_index = cpu_to_le32(src->lsr_index);
 806         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
 807 }
 808
 809 static inline void
 810 range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 811 {
 812         dst->lsr_start = le64_to_cpu(src->lsr_start);
 813         dst->lsr_end = le64_to_cpu(src->lsr_end);
 814         dst->lsr_index = le32_to_cpu(src->lsr_index);
 815         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
 816 }
 817
 818 static inline void
 819 range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 820 {
 821         dst->lsr_start = cpu_to_be64(src->lsr_start);
 822         dst->lsr_end = cpu_to_be64(src->lsr_end);
 823         dst->lsr_index = cpu_to_be32(src->lsr_index);
 824         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
 825 }
 826
 827 static inline void
 828 range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 829 {
 830         dst->lsr_start = be64_to_cpu(src->lsr_start);
 831         dst->lsr_end = be64_to_cpu(src->lsr_end);
 832         dst->lsr_index = be32_to_cpu(src->lsr_index);
 833         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
 834 }
 835
 836 static inline void range_array_cpu_to_le(struct lu_seq_range_array *dst,
 837                                          const struct lu_seq_range_array *src)
 838 {
 839         __u32 i;
 840
 841         for (i = 0; i < src->lsra_count; i++)
 842                 range_cpu_to_le(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
 843
 844         dst->lsra_count = cpu_to_le32(src->lsra_count);
 845 }
 846
 847 static inline void range_array_le_to_cpu(struct lu_seq_range_array *dst,
 848                                          const struct lu_seq_range_array *src)
 849 {
 850         __u32 i;
 851
 852         dst->lsra_count = le32_to_cpu(src->lsra_count);
 853         for (i = 0; i < dst->lsra_count; i++)
 854                 range_le_to_cpu(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
 855 }
 856
 857 /** @} fid */
 858
 859 #endif /* __LUSTRE_FID_H */