Whamcloud - gitweb
LU-2240 mds: Assign special fid sequence to root.
[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, 2012, 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 __LINUX_FID_H
42 #define __LINUX_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 #include <lustre_req_layout.h>
158 #include <lustre_mdt.h>
159 #include <obd.h>
160
161
162 struct lu_site;
163 struct lu_context;
164
165 /* Whole sequences space range and zero range definitions */
166 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
167 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
168 extern const struct lu_fid LUSTRE_BFL_FID;
169 extern const struct lu_fid LU_OBF_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,
216         MDD_ORPHAN_OID          = 7UL,
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 };
237
238 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
239 {
240         fid->f_seq = FID_SEQ_LOCAL_FILE;
241         fid->f_oid = oid;
242         fid->f_ver = 0;
243 }
244
245 static inline void lu_local_name_obj_fid(struct lu_fid *fid, __u32 oid)
246 {
247         fid->f_seq = FID_SEQ_LOCAL_NAME;
248         fid->f_oid = oid;
249         fid->f_ver = 0;
250 }
251
252 /* For new FS (>= 2.4), the root FID will be changed to
253  * [FID_SEQ_ROOT:1:0], for existing FS, (upgraded to 2.4),
254  * the root FID will still be IGIF */
255 static inline int fid_is_root(const struct lu_fid *fid)
256 {
257         return unlikely((fid_seq(fid) == FID_SEQ_ROOT &&
258                          fid_oid(fid) == 1));
259 }
260
261 static inline int fid_is_dot_lustre(const struct lu_fid *fid)
262 {
263         return unlikely(fid_seq(fid) == FID_SEQ_DOT_LUSTRE &&
264                         fid_oid(fid) == FID_OID_DOT_LUSTRE);
265 }
266
267 static inline int fid_is_otable_it(const struct lu_fid *fid)
268 {
269         return unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
270                         fid_oid(fid) == OTABLE_IT_OID);
271 }
272
273 static inline int fid_is_acct(const struct lu_fid *fid)
274 {
275         return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
276                (fid_oid(fid) == ACCT_USER_OID ||
277                 fid_oid(fid) == ACCT_GROUP_OID);
278 }
279
280 static inline int fid_is_quota(const struct lu_fid *fid)
281 {
282         return fid_seq(fid) == FID_SEQ_QUOTA ||
283                fid_seq(fid) == FID_SEQ_QUOTA_GLB;
284 }
285
286 static inline int fid_is_client_mdt_visible(const struct lu_fid *fid)
287 {
288         const __u64 seq = fid_seq(fid);
289
290         /* Here, we cannot distinguish whether the normal FID is for OST
291          * object or not. It is caller's duty to check more if needed. */
292         return (!fid_is_last_id(fid) &&
293                 (fid_seq_is_norm(seq) || fid_seq_is_igif(seq))) ||
294                fid_is_root(fid) || fid_is_dot_lustre(fid);
295 }
296
297 static inline int fid_is_client_visible(const struct lu_fid *fid)
298 {
299         return fid_is_client_mdt_visible(fid) || fid_is_idif(fid);
300 }
301
302 static inline int fid_seq_in_fldb(__u64 seq)
303 {
304         return fid_seq_is_igif(seq) || fid_seq_is_norm(seq) ||
305                seq == FID_SEQ_ROOT;
306 }
307
308 static inline void lu_last_id_fid(struct lu_fid *fid, __u64 seq)
309 {
310         if (fid_seq_is_mdt0(seq)) {
311                 fid->f_seq = fid_idif_seq(0, 0);
312         } else {
313                 LASSERTF(fid_seq_is_norm(seq) || fid_seq_is_echo(seq) ||
314                          fid_seq_is_idif(seq), LPX64"\n", seq);
315                 fid->f_seq = seq;
316         }
317         fid->f_oid = 0;
318         fid->f_ver = 0;
319 }
320
321 enum lu_mgr_type {
322         LUSTRE_SEQ_SERVER,
323         LUSTRE_SEQ_CONTROLLER
324 };
325
326 struct lu_server_seq;
327
328 /* Client sequence manager interface. */
329 struct lu_client_seq {
330         /* Sequence-controller export. */
331         struct obd_export      *lcs_exp;
332         struct mutex            lcs_mutex;
333
334         /*
335          * Range of allowed for allocation sequeces. When using lu_client_seq on
336          * clients, this contains meta-sequence range. And for servers this
337          * contains super-sequence range.
338          */
339         struct lu_seq_range         lcs_space;
340
341         /* Seq related proc */
342         cfs_proc_dir_entry_t   *lcs_proc_dir;
343
344         /* This holds last allocated fid in last obtained seq */
345         struct lu_fid           lcs_fid;
346
347         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
348         enum lu_cli_type        lcs_type;
349
350         /*
351          * Service uuid, passed from MDT + seq name to form unique seq name to
352          * use it with procfs.
353          */
354         char                    lcs_name[80];
355
356         /*
357          * Sequence width, that is how many objects may be allocated in one
358          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
359          */
360         __u64                   lcs_width;
361
362         /* Seq-server for direct talking */
363         struct lu_server_seq   *lcs_srv;
364
365         /* wait queue for fid allocation and update indicator */
366         cfs_waitq_t             lcs_waitq;
367         int                     lcs_update;
368 };
369
370 /* server sequence manager interface */
371 struct lu_server_seq {
372         /* Available sequences space */
373         struct lu_seq_range         lss_space;
374
375         /* keeps highwater in lsr_end for seq allocation algorithm */
376         struct lu_seq_range         lss_lowater_set;
377         struct lu_seq_range         lss_hiwater_set;
378
379         /*
380          * Device for server side seq manager needs (saving sequences to backing
381          * store).
382          */
383         struct dt_device       *lss_dev;
384
385         /* /seq file object device */
386         struct dt_object       *lss_obj;
387
388         /* Seq related proc */
389         cfs_proc_dir_entry_t   *lss_proc_dir;
390
391         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
392         enum lu_mgr_type       lss_type;
393
394         /* Client interafce to request controller */
395         struct lu_client_seq   *lss_cli;
396
397         /* Mutex for protecting allocation */
398         struct mutex            lss_mutex;
399
400         /*
401          * Service uuid, passed from MDT + seq name to form unique seq name to
402          * use it with procfs.
403          */
404         char                    lss_name[80];
405
406         /*
407          * Allocation chunks for super and meta sequences. Default values are
408          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
409          */
410         __u64                   lss_width;
411
412         /*
413          * minimum lss_alloc_set size that should be allocated from
414          * lss_space
415          */
416         __u64                   lss_set_width;
417
418         /* sync is needed for update operation */
419         __u32                   lss_need_sync;
420
421         /**
422          * Pointer to site object, required to access site fld.
423          */
424         struct seq_server_site  *lss_site;
425 };
426
427 int seq_query(struct com_thread_info *info);
428 int seq_handle(struct ptlrpc_request *req);
429
430 /* Server methods */
431 int seq_server_init(struct lu_server_seq *seq,
432                     struct dt_device *dev,
433                     const char *prefix,
434                     enum lu_mgr_type type,
435                     struct seq_server_site *ss,
436                     const struct lu_env *env);
437
438 void seq_server_fini(struct lu_server_seq *seq,
439                      const struct lu_env *env);
440
441 int seq_server_alloc_super(struct lu_server_seq *seq,
442                            struct lu_seq_range *out,
443                            const struct lu_env *env);
444
445 int seq_server_alloc_meta(struct lu_server_seq *seq,
446                           struct lu_seq_range *out,
447                           const struct lu_env *env);
448
449 int seq_server_set_cli(struct lu_server_seq *seq,
450                        struct lu_client_seq *cli,
451                        const struct lu_env *env);
452
453 /* Client methods */
454 int seq_client_init(struct lu_client_seq *seq,
455                     struct obd_export *exp,
456                     enum lu_cli_type type,
457                     const char *prefix,
458                     struct lu_server_seq *srv);
459
460 void seq_client_fini(struct lu_client_seq *seq);
461
462 void seq_client_flush(struct lu_client_seq *seq);
463
464 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
465                          struct lu_fid *fid);
466 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
467                        seqno_t *seqnr);
468 int seq_site_fini(const struct lu_env *env, struct seq_server_site *ss);
469 /* Fids common stuff */
470 int fid_is_local(const struct lu_env *env,
471                  struct lu_site *site, const struct lu_fid *fid);
472
473 int client_fid_init(struct obd_device *obd, struct obd_export *exp,
474                     enum lu_cli_type type);
475 int client_fid_fini(struct obd_device *obd);
476
477 /* fid locking */
478
479 struct ldlm_namespace;
480
481 /*
482  * Build (DLM) resource name from FID.
483  *
484  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
485  * but was moved into name[1] along with the OID to avoid consuming the
486  * renaming name[2,3] fields that need to be used for the quota identifier.
487  */
488 static inline struct ldlm_res_id *
489 fid_build_reg_res_name(const struct lu_fid *f,
490                        struct ldlm_res_id *name)
491 {
492         memset(name, 0, sizeof *name);
493         name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
494         name->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(f);
495         return name;
496 }
497
498 /*
499  * Build (DLM) resource identifier from global quota FID and quota ID.
500  */
501 static inline struct ldlm_res_id *
502 fid_build_quota_resid(const struct lu_fid *glb_fid, union lquota_id *qid,
503                       struct ldlm_res_id *res)
504 {
505         fid_build_reg_res_name(glb_fid, res);
506         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
507         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
508         return res;
509 }
510
511 /*
512  * Extract global FID and quota ID from resource name
513  */
514 static inline void fid_extract_quota_resid(struct ldlm_res_id *res,
515                                            struct lu_fid *glb_fid,
516                                            union lquota_id *qid)
517 {
518         glb_fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
519         glb_fid->f_oid = (__u32)res->name[LUSTRE_RES_ID_VER_OID_OFF];
520         glb_fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
521
522         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
523         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
524         qid->qid_fid.f_ver =
525                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
526 }
527
528 /*
529  * Return true if resource is for object identified by fid.
530  */
531 static inline int fid_res_name_eq(const struct lu_fid *f,
532                                   const struct ldlm_res_id *name)
533 {
534         return name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
535                name->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(f);
536 }
537
538 /* reverse function of fid_build_reg_res_name() */
539 static inline void fid_build_from_res_name(struct lu_fid *f,
540                                            const struct ldlm_res_id *name)
541 {
542         fid_zero(f);
543         f->f_seq = name->name[LUSTRE_RES_ID_SEQ_OFF];
544         f->f_oid = name->name[LUSTRE_RES_ID_VER_OID_OFF] & 0xffffffff;
545         f->f_ver = name->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32;
546         LASSERT(fid_res_name_eq(f, name));
547 }
548
549 static inline struct ldlm_res_id *
550 fid_build_pdo_res_name(const struct lu_fid *f,
551                        unsigned int hash,
552                        struct ldlm_res_id *name)
553 {
554         fid_build_reg_res_name(f, name);
555         name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
556         return name;
557 }
558
559 /**
560  * Build DLM resource name from object id & seq, which will be removed
561  * finally, when we replace ost_id with FID in data stack.
562  *
563  * To keep the compatibility, res[0] = oid, res[1] = seq
564  */
565 static inline void ostid_build_res_name(struct ost_id *oid,
566                                         struct ldlm_res_id *name)
567 {
568         memset(name, 0, sizeof *name);
569         name->name[LUSTRE_RES_ID_SEQ_OFF] = oid->oi_id;
570         name->name[LUSTRE_RES_ID_VER_OID_OFF] = oid->oi_seq;
571 }
572
573 static inline void ostid_res_name_to_id(struct ost_id *oid,
574                                         struct ldlm_res_id *name)
575 {
576         oid->oi_id = name->name[LUSTRE_RES_ID_SEQ_OFF];
577         oid->oi_seq = name->name[LUSTRE_RES_ID_VER_OID_OFF];
578 }
579
580 /**
581  * Return true if the resource is for the object identified by this id & group.
582  */
583 static inline int ostid_res_name_eq(struct ost_id *oid,
584                                     struct ldlm_res_id *name)
585 {
586         return name->name[LUSTRE_RES_ID_SEQ_OFF] == oid->oi_id &&
587                name->name[LUSTRE_RES_ID_VER_OID_OFF] == oid->oi_seq;
588 }
589
590 /**
591  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
592  * For non-IGIF FIDs this starts just over 2^32, and continues without
593  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
594  * into the range where there may not be many OID values in use, to minimize
595  * the risk of conflict.
596  *
597  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
598  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
599  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
600  */
601 static inline __u64 fid_flatten(const struct lu_fid *fid)
602 {
603         __u64 ino;
604         __u64 seq;
605
606         if (fid_is_igif(fid)) {
607                 ino = lu_igif_ino(fid);
608                 RETURN(ino);
609         }
610
611         seq = fid_seq(fid);
612
613         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
614
615         RETURN(ino ? ino : fid_oid(fid));
616 }
617
618 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
619 {
620         /* all objects with same id and different versions will belong to same
621          * collisions list. */
622         return cfs_hash_long(fid_flatten(f), bits);
623 }
624
625 /**
626  * map fid to 32 bit value for ino on 32bit systems. */
627 static inline __u32 fid_flatten32(const struct lu_fid *fid)
628 {
629         __u32 ino;
630         __u64 seq;
631
632         if (fid_is_igif(fid)) {
633                 ino = lu_igif_ino(fid);
634                 RETURN(ino);
635         }
636
637         seq = fid_seq(fid) - FID_SEQ_START;
638
639         /* Map the high bits of the OID into higher bits of the inode number so
640          * that inodes generated at about the same time have a reduced chance
641          * of collisions. This will give a period of 2^12 = 1024 unique clients
642          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
643          * (from OID), or up to 128M inodes without collisions for new files. */
644         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
645                (seq >> (64 - (40-8)) & 0xffffff00) +
646                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
647
648         RETURN(ino ? ino : fid_oid(fid));
649 }
650
651 static inline int lu_fid_diff(struct lu_fid *fid1, struct lu_fid *fid2)
652 {
653         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:"DFID", fid2:"DFID"\n",
654                  PFID(fid1), PFID(fid2));
655
656         if (fid_is_idif(fid1) && fid_is_idif(fid2))
657                 return fid_idif_id(fid1->f_seq, fid1->f_oid, fid1->f_ver) -
658                        fid_idif_id(fid2->f_seq, fid2->f_oid, fid2->f_ver);
659
660         return fid_oid(fid1) - fid_oid(fid2);
661 }
662
663 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
664 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
665
666 /* Range common stuff */
667 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
668 {
669         dst->lsr_start = cpu_to_le64(src->lsr_start);
670         dst->lsr_end = cpu_to_le64(src->lsr_end);
671         dst->lsr_index = cpu_to_le32(src->lsr_index);
672         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
673 }
674
675 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
676 {
677         dst->lsr_start = le64_to_cpu(src->lsr_start);
678         dst->lsr_end = le64_to_cpu(src->lsr_end);
679         dst->lsr_index = le32_to_cpu(src->lsr_index);
680         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
681 }
682
683 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
684 {
685         dst->lsr_start = cpu_to_be64(src->lsr_start);
686         dst->lsr_end = cpu_to_be64(src->lsr_end);
687         dst->lsr_index = cpu_to_be32(src->lsr_index);
688         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
689 }
690
691 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
692 {
693         dst->lsr_start = be64_to_cpu(src->lsr_start);
694         dst->lsr_end = be64_to_cpu(src->lsr_end);
695         dst->lsr_index = be32_to_cpu(src->lsr_index);
696         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
697 }
698
699 /** @} fid */
700
701 #endif /* __LINUX_FID_H */