Whamcloud - gitweb
LU-4972 lfsck: skip .lustre and children for namespace check
[fs/lustre-release.git] / lustre / include / lustre_fid.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/include/lustre_fid.h
37  *
38  * Author: Yury Umanets <umka@clusterfs.com>
39  */
40
41 #ifndef __LUSTRE_FID_H
42 #define __LUSTRE_FID_H
43
44 /** \defgroup fid fid
45  *
46  * @{
47  *
48  * http://wiki.lustre.org/index.php/Architecture_-_Interoperability_fids_zfs
49  * describes the FID namespace and interoperability requirements for FIDs.
50  * The important parts of that document are included here for reference.
51  *
52  * FID
53  *   File IDentifier generated by client from range allocated by the SEQuence
54  *   service and stored in struct lu_fid. The FID is composed of three parts:
55  *   SEQuence, ObjectID, and VERsion.  The SEQ component is a filesystem
56  *   unique 64-bit integer, and only one client is ever assigned any SEQ value.
57  *   The first 0x400 FID_SEQ_NORMAL [2^33, 2^33 + 0x400] values are reserved
58  *   for system use.  The OID component is a 32-bit value generated by the
59  *   client on a per-SEQ basis to allow creating many unique FIDs without
60  *   communication with the server.  The VER component is a 32-bit value that
61  *   distinguishes between different FID instantiations, such as snapshots or
62  *   separate subtrees within the filesystem.  FIDs with the same VER field
63  *   are considered part of the same namespace.
64  *
65  * OLD filesystems are those upgraded from Lustre 1.x that predate FIDs, and
66  *   MDTs use 32-bit ldiskfs internal inode/generation numbers (IGIFs), while
67  *   OSTs use 64-bit Lustre object IDs and generation numbers.
68  *
69  * NEW filesystems are those formatted since the introduction of FIDs.
70  *
71  * IGIF
72  *   Inode and Generation In FID, a surrogate FID used to globally identify
73  *   an existing object on OLD formatted MDT file system. This would only be
74  *   used on MDT0 in a DNE filesystem, because there cannot be more than one
75  *   MDT in an OLD formatted filesystem. Belongs to sequence in [12, 2^32 - 1]
76  *   range, where inode number is stored in SEQ, and inode generation is in OID.
77  *   NOTE: This assumes no more than 2^32-1 inodes exist in the MDT filesystem,
78  *   which is the maximum possible for an ldiskfs backend.  It also assumes
79  *   that the reserved ext3/ext4/ldiskfs inode numbers [0-11] are never visible
80  *   to clients, which has always been true.
81  *
82  * IDIF
83  *   object ID In FID, a surrogate FID used to globally identify an existing
84  *   OST object on OLD formatted OST file system. Belongs to a sequence in
85  *   [2^32, 2^33 - 1]. Sequence number is calculated as:
86  *
87  *      1 << 32 | (ost_index << 16) | ((objid >> 32) & 0xffff)
88  *
89  *   that is, SEQ consists of 16-bit OST index, and higher 16 bits of object
90  *   ID. The generation of unique SEQ values per OST allows the IDIF FIDs to
91  *   be identified in the FLD correctly. The OID field is calculated as:
92  *
93  *      objid & 0xffffffff
94  *
95  *   that is, it consists of lower 32 bits of object ID.  For objects within
96  *   the IDIF range, object ID extraction will be:
97  *
98  *      o_id = (fid->f_seq & 0x7fff) << 16 | fid->f_oid;
99  *      o_seq = 0;  // formerly group number
100  *
101  *   NOTE: This assumes that no more than 2^48-1 objects have ever been created
102  *   on any OST, and that no more than 65535 OSTs are in use.  Both are very
103  *   reasonable assumptions, i.e. an IDIF can uniquely map all objects assuming
104  *   a maximum creation rate of 1M objects per second for a maximum of 9 years,
105  *   or combinations thereof.
106  *
107  * OST_MDT0
108  *   Surrogate FID used to identify an existing object on OLD formatted OST
109  *   filesystem. Belongs to the reserved SEQuence 0, and is used prior to
110  *   the introduction of FID-on-OST, at which point IDIF will be used to
111  *   identify objects as residing on a specific OST.
112  *
113  * LLOG
114  *   For Lustre Log objects the object sequence 1 is used. This is compatible
115  *   with both OLD and NEW namespaces, as this SEQ number is in the
116  *   ext3/ldiskfs reserved inode range and does not conflict with IGIF
117  *   sequence numbers.
118  *
119  * ECHO
120  *   For testing OST IO performance the object sequence 2 is used. This is
121  *   compatible with both OLD and NEW namespaces, as this SEQ number is in
122  *   the ext3/ldiskfs reserved inode range and does not conflict with IGIF
123  *   sequence numbers.
124  *
125  * OST_MDT1 .. OST_MAX
126  *   For testing with multiple MDTs the object sequence 3 through 9 is used,
127  *   allowing direct mapping of MDTs 1 through 7 respectively, for a total
128  *   of 8 MDTs including OST_MDT0. This matches the legacy CMD project "group"
129  *   mappings. However, this SEQ range is only for testing prior to any
130  *   production DNE release, as the objects in this range conflict across all
131  *   OSTs, as the OST index is not part of the FID.  For production DNE usage,
132  *   OST objects created by MDT1+ will use FID_SEQ_NORMAL FIDs.
133  *
134  * DLM OST objid to IDIF mapping
135  *   For compatibility with existing OLD OST network protocol structures, the
136  *   FID must map onto the o_id and o_seq in a manner that ensures existing
137  *   objects are identified consistently for IO, as well as onto the LDLM
138  *   namespace to ensure IDIFs there is only a single resource name for any
139  *   object in the DLM.  The OLD OST object DLM resource mapping is:
140  *
141  *      resource[] = {o_id, o_seq, 0, 0}; // o_seq == 0 for production releases
142  *
143  *   The NEW OST object DLM resource mapping is the same for both MDT and OST:
144  *
145  *      resource[] = {SEQ, OID, VER, HASH};
146  *
147  *  NOTE: for mapping IDIF values to DLM resource names the o_id may be
148  *  larger than the 2^33 reserved sequence numbers for IDIF, so it is possible
149  *  for the o_id numbers to overlap FID SEQ numbers in the resource. However,
150  *  in all production releases the OLD o_seq field is always zero, and all
151  *  valid FID OID values are non-zero, so the lock resources will not collide.
152  *  Even so, the MDT and OST resources are also in different LDLM namespaces.
153  */
154
155 #include <libcfs/libcfs.h>
156 #include <lustre/lustre_idl.h>
157
158 struct lu_env;
159 struct lu_site;
160 struct lu_context;
161 struct obd_device;
162 struct obd_export;
163
164 /* Whole sequences space range and zero range definitions */
165 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
166 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
167 extern const struct lu_fid LUSTRE_BFL_FID;
168 extern const struct lu_fid LU_OBF_FID;
169 extern const struct lu_fid LU_LPF_FID;
170 extern const struct lu_fid LU_DOT_LUSTRE_FID;
171
172 enum {
173         /*
174          * This is how may metadata FIDs may be allocated in one sequence(128k)
175          */
176         LUSTRE_METADATA_SEQ_MAX_WIDTH = 0x0000000000020000ULL,
177
178         /*
179          * This is how many data FIDs could be allocated in one sequence(4B - 1)
180          */
181         LUSTRE_DATA_SEQ_MAX_WIDTH = 0x00000000FFFFFFFFULL,
182
183         /*
184          * How many sequences to allocate to a client at once.
185          */
186         LUSTRE_SEQ_META_WIDTH = 0x0000000000000001ULL,
187
188         /*
189          * seq allocation pool size.
190          */
191         LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
192
193         /*
194          * This is how many sequences may be in one super-sequence allocated to
195          * MDTs.
196          */
197         LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
198 };
199
200 enum {
201         /** 2^6 FIDs for OI containers */
202         OSD_OI_FID_OID_BITS     = 6,
203         /** reserve enough FIDs in case we want more in the future */
204         OSD_OI_FID_OID_BITS_MAX = 10,
205 };
206
207 /** special OID for local objects */
208 enum local_oid {
209         /** \see fld_mod_init */
210         FLD_INDEX_OID           = 3UL,
211         /** \see fid_mod_init */
212         FID_SEQ_CTL_OID         = 4UL,
213         FID_SEQ_SRV_OID         = 5UL,
214         /** \see mdd_mod_init */
215         MDD_ROOT_INDEX_OID      = 6UL, /* deprecated in 2.4 */
216         MDD_ORPHAN_OID          = 7UL, /* deprecated in 2.4 */
217         MDD_LOV_OBJ_OID         = 8UL,
218         MDD_CAPA_KEYS_OID       = 9UL,
219         /** \see mdt_mod_init */
220         LAST_RECV_OID           = 11UL,
221         OSD_FS_ROOT_OID         = 13UL,
222         ACCT_USER_OID           = 15UL,
223         ACCT_GROUP_OID          = 16UL,
224         LFSCK_BOOKMARK_OID      = 17UL,
225         OTABLE_IT_OID           = 18UL,
226         /* These two definitions are obsolete
227          * OFD_GROUP0_LAST_OID     = 20UL,
228          * OFD_GROUP4K_LAST_OID    = 20UL+4096,
229          */
230         OFD_LAST_GROUP_OID      = 4117UL,
231         LLOG_CATALOGS_OID       = 4118UL,
232         MGS_CONFIGS_OID         = 4119UL,
233         OFD_HEALTH_CHECK_OID    = 4120UL,
234         MDD_LOV_OBJ_OSEQ        = 4121UL,
235         LFSCK_NAMESPACE_OID     = 4122UL,
236         REMOTE_PARENT_DIR_OID   = 4123UL,
237         SLAVE_LLOG_CATALOGS_OID = 4124UL,
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) == 1));
261 }
262
263 static inline int fid_seq_is_dot_lustre(__u64 seq)
264 {
265         return unlikely(seq == FID_SEQ_DOT_LUSTRE);
266 }
267
268 static inline int fid_is_dot_lustre(const struct lu_fid *fid)
269 {
270         return unlikely(fid_seq(fid) == FID_SEQ_DOT_LUSTRE &&
271                         fid_oid(fid) == FID_OID_DOT_LUSTRE);
272 }
273
274 static inline int fid_is_obf(const struct lu_fid *fid)
275 {
276         return unlikely(fid_seq(fid) == FID_SEQ_DOT_LUSTRE &&
277                         fid_oid(fid) == FID_OID_DOT_LUSTRE_OBF);
278 }
279
280 static inline int fid_is_otable_it(const struct lu_fid *fid)
281 {
282         return unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
283                         fid_oid(fid) == OTABLE_IT_OID);
284 }
285
286 static inline int fid_is_acct(const struct lu_fid *fid)
287 {
288         return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
289                (fid_oid(fid) == ACCT_USER_OID ||
290                 fid_oid(fid) == ACCT_GROUP_OID);
291 }
292
293 static inline int fid_is_quota(const struct lu_fid *fid)
294 {
295         return fid_seq(fid) == FID_SEQ_QUOTA ||
296                fid_seq(fid) == FID_SEQ_QUOTA_GLB;
297 }
298
299 static inline int fid_is_name_llog(const struct lu_fid *fid)
300 {
301         return fid_seq(fid) == FID_SEQ_LLOG_NAME;
302 }
303
304 static inline int fid_is_namespace_visible(const struct lu_fid *fid)
305 {
306         const __u64 seq = fid_seq(fid);
307
308         /* Here, we cannot distinguish whether the normal FID is for OST
309          * object or not. It is caller's duty to check more if needed. */
310         return (!fid_is_last_id(fid) &&
311                 (fid_seq_is_norm(seq) || fid_seq_is_igif(seq))) ||
312                fid_is_root(fid) || fid_seq_is_dot_lustre(seq);
313 }
314
315 static inline int fid_seq_in_fldb(__u64 seq)
316 {
317         return fid_seq_is_igif(seq) || fid_seq_is_norm(seq) ||
318                fid_seq_is_root(seq) || fid_seq_is_dot(seq);
319 }
320
321 static inline void lu_last_id_fid(struct lu_fid *fid, __u64 seq, __u32 ost_idx)
322 {
323         if (fid_seq_is_mdt0(seq)) {
324                 fid->f_seq = fid_idif_seq(0, ost_idx);
325         } else {
326                 LASSERTF(fid_seq_is_norm(seq) || fid_seq_is_echo(seq) ||
327                          fid_seq_is_idif(seq), LPX64"\n", seq);
328                 fid->f_seq = seq;
329         }
330         fid->f_oid = 0;
331         fid->f_ver = 0;
332 }
333
334 static inline bool fid_is_md_operative(const struct lu_fid *fid)
335 {
336         return fid_is_mdt0(fid) || fid_is_igif(fid) ||
337                fid_is_norm(fid) || fid_is_root(fid);
338 }
339
340 /* seq client type */
341 enum lu_cli_type {
342         LUSTRE_SEQ_METADATA = 1,
343         LUSTRE_SEQ_DATA
344 };
345
346 enum lu_mgr_type {
347         LUSTRE_SEQ_SERVER,
348         LUSTRE_SEQ_CONTROLLER
349 };
350
351 struct lu_server_seq;
352
353 /* Client sequence manager interface. */
354 struct lu_client_seq {
355         /* Sequence-controller export. */
356         struct obd_export      *lcs_exp;
357         struct mutex            lcs_mutex;
358
359         /*
360          * Range of allowed for allocation sequeces. When using lu_client_seq on
361          * clients, this contains meta-sequence range. And for servers this
362          * contains super-sequence range.
363          */
364         struct lu_seq_range         lcs_space;
365
366         /* Seq related proc */
367         cfs_proc_dir_entry_t   *lcs_proc_dir;
368
369         /* This holds last allocated fid in last obtained seq */
370         struct lu_fid           lcs_fid;
371
372         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
373         enum lu_cli_type        lcs_type;
374
375         /*
376          * Service uuid, passed from MDT + seq name to form unique seq name to
377          * use it with procfs.
378          */
379         char                    lcs_name[80];
380
381         /*
382          * Sequence width, that is how many objects may be allocated in one
383          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
384          */
385         __u64                   lcs_width;
386
387         /* Seq-server for direct talking */
388         struct lu_server_seq   *lcs_srv;
389
390         /* wait queue for fid allocation and update indicator */
391         wait_queue_head_t       lcs_waitq;
392         int                     lcs_update;
393 };
394
395 /* server sequence manager interface */
396 struct lu_server_seq {
397         /* Available sequences space */
398         struct lu_seq_range         lss_space;
399
400         /* keeps highwater in lsr_end for seq allocation algorithm */
401         struct lu_seq_range         lss_lowater_set;
402         struct lu_seq_range         lss_hiwater_set;
403
404         /*
405          * Device for server side seq manager needs (saving sequences to backing
406          * store).
407          */
408         struct dt_device       *lss_dev;
409
410         /* /seq file object device */
411         struct dt_object       *lss_obj;
412
413         /* Seq related proc */
414         cfs_proc_dir_entry_t   *lss_proc_dir;
415
416         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
417         enum lu_mgr_type       lss_type;
418
419         /* Client interafce to request controller */
420         struct lu_client_seq   *lss_cli;
421
422         /* Mutex for protecting allocation */
423         struct mutex            lss_mutex;
424
425         /*
426          * Service uuid, passed from MDT + seq name to form unique seq name to
427          * use it with procfs.
428          */
429         char                    lss_name[80];
430
431         /*
432          * Allocation chunks for super and meta sequences. Default values are
433          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
434          */
435         __u64                   lss_width;
436
437         /*
438          * minimum lss_alloc_set size that should be allocated from
439          * lss_space
440          */
441         __u64                   lss_set_width;
442
443         /* sync is needed for update operation */
444         __u32                   lss_need_sync;
445
446         /**
447          * Pointer to site object, required to access site fld.
448          */
449         struct seq_server_site  *lss_site;
450 };
451
452 /* Server methods */
453
454 int seq_server_init(const struct lu_env *env,
455                     struct lu_server_seq *seq,
456                     struct dt_device *dev,
457                     const char *prefix,
458                     enum lu_mgr_type type,
459                     struct seq_server_site *ss);
460
461 void seq_server_fini(struct lu_server_seq *seq,
462                      const struct lu_env *env);
463
464 int seq_server_alloc_super(struct lu_server_seq *seq,
465                            struct lu_seq_range *out,
466                            const struct lu_env *env);
467
468 int seq_server_alloc_meta(struct lu_server_seq *seq,
469                           struct lu_seq_range *out,
470                           const struct lu_env *env);
471
472 int seq_server_set_cli(const struct lu_env *env,
473                        struct lu_server_seq *seq,
474                        struct lu_client_seq *cli);
475
476 /* Client methods */
477 int seq_client_init(struct lu_client_seq *seq,
478                     struct obd_export *exp,
479                     enum lu_cli_type type,
480                     const char *prefix,
481                     struct lu_server_seq *srv);
482
483 void seq_client_fini(struct lu_client_seq *seq);
484
485 void seq_client_flush(struct lu_client_seq *seq);
486
487 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
488                          struct lu_fid *fid);
489 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
490                        seqno_t *seqnr);
491 int seq_site_fini(const struct lu_env *env, struct seq_server_site *ss);
492 /* Fids common stuff */
493 int fid_is_local(const struct lu_env *env,
494                  struct lu_site *site, const struct lu_fid *fid);
495
496 enum lu_cli_type;
497 int client_fid_init(struct obd_device *obd, struct obd_export *exp,
498                     enum lu_cli_type type);
499 int client_fid_fini(struct obd_device *obd);
500
501 /* fid locking */
502
503 struct ldlm_namespace;
504
505 /*
506  * Build (DLM) resource name from FID.
507  *
508  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
509  * but was moved into name[1] along with the OID to avoid consuming the
510  * renaming name[2,3] fields that need to be used for the quota identifier.
511  */
512 static inline void
513 fid_build_reg_res_name(const struct lu_fid *fid, struct ldlm_res_id *res)
514 {
515         memset(res, 0, sizeof(*res));
516         res->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(fid);
517         res->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(fid);
518 }
519
520 /*
521  * Return true if resource is for object identified by FID.
522  */
523 static inline int fid_res_name_eq(const struct lu_fid *fid,
524                                   const struct ldlm_res_id *res)
525 {
526         return res->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(fid) &&
527                res->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(fid);
528 }
529
530 /*
531  * Extract FID from LDLM resource. Reverse of fid_build_reg_res_name().
532  */
533 static inline void
534 fid_extract_from_res_name(struct lu_fid *fid, const struct ldlm_res_id *res)
535 {
536         fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
537         fid->f_oid = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF]);
538         fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
539         LASSERT(fid_res_name_eq(fid, res));
540 }
541
542 /*
543  * Build (DLM) resource identifier from global quota FID and quota ID.
544  */
545 static inline void
546 fid_build_quota_res_name(const struct lu_fid *glb_fid, union lquota_id *qid,
547                       struct ldlm_res_id *res)
548 {
549         fid_build_reg_res_name(glb_fid, res);
550         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
551         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
552 }
553
554 /*
555  * Extract global FID and quota ID from resource name
556  */
557 static inline void fid_extract_from_quota_res(struct lu_fid *glb_fid,
558                                               union lquota_id *qid,
559                                               const struct ldlm_res_id *res)
560 {
561         fid_extract_from_res_name(glb_fid, res);
562         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
563         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
564         qid->qid_fid.f_ver =
565                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
566 }
567
568 static inline void
569 fid_build_pdo_res_name(const struct lu_fid *fid, unsigned int hash,
570                        struct ldlm_res_id *res)
571 {
572         fid_build_reg_res_name(fid, res);
573         res->name[LUSTRE_RES_ID_HSH_OFF] = hash;
574 }
575
576 /**
577  * Build DLM resource name from object id & seq, which will be removed
578  * finally, when we replace ost_id with FID in data stack.
579  *
580  * Currently, resid from the old client, whose res[0] = object_id,
581  * res[1] = object_seq, is just oposite with Metatdata
582  * resid, where, res[0] = fid->f_seq, res[1] = fid->f_oid.
583  * To unifiy the resid identification, we will reverse the data
584  * resid to keep it same with Metadata resid, i.e.
585  *
586  * For resid from the old client,
587  *    res[0] = objid,  res[1] = 0, still keep the original order,
588  *    for compatiblity.
589  *
590  * For new resid
591  *    res will be built from normal FID directly, i.e. res[0] = f_seq,
592  *    res[1] = f_oid + f_ver.
593  */
594 static inline void ostid_build_res_name(const struct ost_id *oi,
595                                         struct ldlm_res_id *name)
596 {
597         memset(name, 0, sizeof *name);
598         if (fid_seq_is_mdt0(ostid_seq(oi))) {
599                 name->name[LUSTRE_RES_ID_SEQ_OFF] = ostid_id(oi);
600                 name->name[LUSTRE_RES_ID_VER_OID_OFF] = ostid_seq(oi);
601         } else {
602                 fid_build_reg_res_name(&oi->oi_fid, name);
603         }
604 }
605
606 /**
607  * Return true if the resource is for the object identified by this id & group.
608  */
609 static inline bool ostid_res_name_eq(const struct ost_id *oi,
610                                      const struct ldlm_res_id *name)
611 {
612         /* Note: it is just a trick here to save some effort, probably the
613          * correct way would be turn them into the FID and compare */
614         if (fid_seq_is_mdt0(ostid_seq(oi))) {
615                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_id(oi) &&
616                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_seq(oi);
617         } else {
618                 return name->name[LUSTRE_RES_ID_SEQ_OFF] == ostid_seq(oi) &&
619                        name->name[LUSTRE_RES_ID_VER_OID_OFF] == ostid_id(oi);
620         }
621 }
622
623 /* The same as osc_build_res_name() */
624 static inline void ost_fid_build_resid(const struct lu_fid *fid,
625                                        struct ldlm_res_id *resname)
626 {
627         if (fid_is_mdt0(fid) || fid_is_idif(fid)) {
628                 struct ost_id oi;
629                 oi.oi.oi_id = 0; /* gcc 4.7.2 complains otherwise */
630                 if (fid_to_ostid(fid, &oi) != 0)
631                         return;
632                 ostid_build_res_name(&oi, resname);
633         } else {
634                 fid_build_reg_res_name(fid, resname);
635         }
636 }
637
638 static inline void ost_fid_from_resid(struct lu_fid *fid,
639                                       const struct ldlm_res_id *name,
640                                       int ost_idx)
641 {
642         if (fid_seq_is_mdt0(name->name[LUSTRE_RES_ID_VER_OID_OFF])) {
643                 /* old resid */
644                 struct ost_id oi;
645                 ostid_set_seq(&oi, name->name[LUSTRE_RES_ID_VER_OID_OFF]);
646                 ostid_set_id(&oi, name->name[LUSTRE_RES_ID_SEQ_OFF]);
647                 ostid_to_fid(fid, &oi, ost_idx);
648         } else {
649                 /* new resid */
650                 fid_extract_from_res_name(fid, name);
651         }
652 }
653
654 /**
655  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
656  * For non-IGIF FIDs this starts just over 2^32, and continues without
657  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
658  * into the range where there may not be many OID values in use, to minimize
659  * the risk of conflict.
660  *
661  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
662  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
663  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
664  */
665 static inline __u64 fid_flatten(const struct lu_fid *fid)
666 {
667         __u64 ino;
668         __u64 seq;
669
670         if (fid_is_igif(fid)) {
671                 ino = lu_igif_ino(fid);
672                 RETURN(ino);
673         }
674
675         seq = fid_seq(fid);
676
677         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
678
679         RETURN(ino ? ino : fid_oid(fid));
680 }
681
682 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
683 {
684         /* all objects with same id and different versions will belong to same
685          * collisions list. */
686         return hash_long(fid_flatten(f), bits);
687 }
688
689 /**
690  * map fid to 32 bit value for ino on 32bit systems. */
691 static inline __u32 fid_flatten32(const struct lu_fid *fid)
692 {
693         __u32 ino;
694         __u64 seq;
695
696         if (fid_is_igif(fid)) {
697                 ino = lu_igif_ino(fid);
698                 RETURN(ino);
699         }
700
701         seq = fid_seq(fid) - FID_SEQ_START;
702
703         /* Map the high bits of the OID into higher bits of the inode number so
704          * that inodes generated at about the same time have a reduced chance
705          * of collisions. This will give a period of 2^12 = 1024 unique clients
706          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
707          * (from OID), or up to 128M inodes without collisions for new files. */
708         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
709                (seq >> (64 - (40-8)) & 0xffffff00) +
710                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
711
712         RETURN(ino ? ino : fid_oid(fid));
713 }
714
715 static inline int
716 lu_fid_diff(const struct lu_fid *fid1, const struct lu_fid *fid2)
717 {
718         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:"DFID", fid2:"DFID"\n",
719                  PFID(fid1), PFID(fid2));
720
721         if (fid_is_idif(fid1) && fid_is_idif(fid2))
722                 return fid_idif_id(fid1->f_seq, fid1->f_oid, fid1->f_ver) -
723                        fid_idif_id(fid2->f_seq, fid2->f_oid, fid2->f_ver);
724
725         return fid_oid(fid1) - fid_oid(fid2);
726 }
727
728 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
729 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
730
731 /* Range common stuff */
732 static inline void
733 range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
734 {
735         dst->lsr_start = cpu_to_le64(src->lsr_start);
736         dst->lsr_end = cpu_to_le64(src->lsr_end);
737         dst->lsr_index = cpu_to_le32(src->lsr_index);
738         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
739 }
740
741 static inline void
742 range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
743 {
744         dst->lsr_start = le64_to_cpu(src->lsr_start);
745         dst->lsr_end = le64_to_cpu(src->lsr_end);
746         dst->lsr_index = le32_to_cpu(src->lsr_index);
747         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
748 }
749
750 static inline void
751 range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
752 {
753         dst->lsr_start = cpu_to_be64(src->lsr_start);
754         dst->lsr_end = cpu_to_be64(src->lsr_end);
755         dst->lsr_index = cpu_to_be32(src->lsr_index);
756         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
757 }
758
759 static inline void
760 range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
761 {
762         dst->lsr_start = be64_to_cpu(src->lsr_start);
763         dst->lsr_end = be64_to_cpu(src->lsr_end);
764         dst->lsr_index = be32_to_cpu(src->lsr_index);
765         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
766 }
767
768 static inline void range_array_cpu_to_le(struct lu_seq_range_array *dst,
769                                          const struct lu_seq_range_array *src)
770 {
771         int i;
772
773         for (i = 0; i < src->lsra_count; i++)
774                 range_cpu_to_le(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
775
776         dst->lsra_count = cpu_to_le32(src->lsra_count);
777 }
778
779 static inline void range_array_le_to_cpu(struct lu_seq_range_array *dst,
780                                          const struct lu_seq_range_array *src)
781 {
782         int i;
783
784         dst->lsra_count = le32_to_cpu(src->lsra_count);
785         for (i = 0; i < dst->lsra_count; i++)
786                 range_le_to_cpu(&dst->lsra_lsr[i], &src->lsra_lsr[i]);
787 }
788
789 /** @} fid */
790
791 #endif /* __LUSTRE_FID_H */