Whamcloud - gitweb
LU-928 fid: add comments describing different FIDs
[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, Whamcloud, Inc.
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
160
161 struct lu_site;
162 struct lu_context;
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_DOT_LUSTRE_FID;
170
171 enum {
172         /*
173          * This is how may FIDs may be allocated in one sequence(128k)
174          */
175         LUSTRE_SEQ_MAX_WIDTH = 0x0000000000020000ULL,
176
177         /*
178          * How many sequences to allocate to a client at once.
179          */
180         LUSTRE_SEQ_META_WIDTH = 0x0000000000000001ULL,
181
182          /*
183           * seq allocation pool size.
184           */
185         LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
186
187         /*
188          * This is how many sequences may be in one super-sequence allocated to
189          * MDTs.
190          */
191         LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
192 };
193
194 enum {
195         /** 2^6 FIDs for OI containers */
196         OSD_OI_FID_OID_BITS     = 6,
197         /** reserve enough FIDs in case we want more in the future */
198         OSD_OI_FID_OID_BITS_MAX = 10,
199 };
200
201 /** special OID for local objects */
202 enum local_oid {
203         /** \see fld_mod_init */
204         FLD_INDEX_OID           = 3UL,
205         /** \see fid_mod_init */
206         FID_SEQ_CTL_OID         = 4UL,
207         FID_SEQ_SRV_OID         = 5UL,
208         /** \see mdd_mod_init */
209         MDD_ROOT_INDEX_OID      = 6UL,
210         MDD_ORPHAN_OID          = 7UL,
211         MDD_LOV_OBJ_OID         = 8UL,
212         MDD_CAPA_KEYS_OID       = 9UL,
213         /** \see mdt_mod_init */
214         MDT_LAST_RECV_OID       = 11UL,
215         OSD_FS_ROOT_OID         = 13UL,
216         ACCT_USER_OID           = 15UL,
217         ACCT_GROUP_OID          = 16UL,
218         LFSCK_BOOKMARK_OID      = 17UL,
219         OTABLE_IT_OID           = 18UL,
220         OFD_LAST_RECV_OID       = 19UL,
221         OFD_GROUP0_LAST_OID     = 20UL,
222         OFD_GROUP4K_LAST_OID    = 20UL+4096,
223         OFD_LAST_GROUP_OID      = 4117UL,
224         LLOG_CATALOGS_OID       = 4118UL,
225         MGS_CONFIGS_OID         = 4119UL,
226         OFD_HEALTH_CHECK_OID    = 4120UL,
227 };
228
229 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
230 {
231         fid->f_seq = FID_SEQ_LOCAL_FILE;
232         fid->f_oid = oid;
233         fid->f_ver = 0;
234 }
235
236 static inline void lu_local_name_obj_fid(struct lu_fid *fid, __u32 oid)
237 {
238         fid->f_seq = FID_SEQ_LOCAL_NAME;
239         fid->f_oid = oid;
240         fid->f_ver = 0;
241 }
242
243 static inline int fid_is_otable_it(const struct lu_fid *fid)
244 {
245         return unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
246                         fid_oid(fid) == OTABLE_IT_OID);
247 }
248
249 static inline int fid_is_acct(const struct lu_fid *fid)
250 {
251         return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
252                (fid_oid(fid) == ACCT_USER_OID ||
253                 fid_oid(fid) == ACCT_GROUP_OID);
254 }
255
256 static inline int fid_is_quota(const struct lu_fid *fid)
257 {
258         return fid_seq(fid) == FID_SEQ_QUOTA ||
259                fid_seq(fid) == FID_SEQ_QUOTA_GLB;
260 }
261
262 enum lu_mgr_type {
263         LUSTRE_SEQ_SERVER,
264         LUSTRE_SEQ_CONTROLLER
265 };
266
267 enum lu_cli_type {
268         LUSTRE_SEQ_METADATA,
269         LUSTRE_SEQ_DATA
270 };
271
272 struct lu_server_seq;
273
274 /* Client sequence manager interface. */
275 struct lu_client_seq {
276         /* Sequence-controller export. */
277         struct obd_export      *lcs_exp;
278         cfs_mutex_t             lcs_mutex;
279
280         /*
281          * Range of allowed for allocation sequeces. When using lu_client_seq on
282          * clients, this contains meta-sequence range. And for servers this
283          * contains super-sequence range.
284          */
285         struct lu_seq_range         lcs_space;
286
287         /* Seq related proc */
288         cfs_proc_dir_entry_t   *lcs_proc_dir;
289
290         /* This holds last allocated fid in last obtained seq */
291         struct lu_fid           lcs_fid;
292
293         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
294         enum lu_cli_type        lcs_type;
295
296         /*
297          * Service uuid, passed from MDT + seq name to form unique seq name to
298          * use it with procfs.
299          */
300         char                    lcs_name[80];
301
302         /*
303          * Sequence width, that is how many objects may be allocated in one
304          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
305          */
306         __u64                   lcs_width;
307
308         /* Seq-server for direct talking */
309         struct lu_server_seq   *lcs_srv;
310
311         /* wait queue for fid allocation and update indicator */
312         cfs_waitq_t             lcs_waitq;
313         int                     lcs_update;
314 };
315
316 /* server sequence manager interface */
317 struct lu_server_seq {
318         /* Available sequences space */
319         struct lu_seq_range         lss_space;
320
321         /* keeps highwater in lsr_end for seq allocation algorithm */
322         struct lu_seq_range         lss_lowater_set;
323         struct lu_seq_range         lss_hiwater_set;
324
325         /*
326          * Device for server side seq manager needs (saving sequences to backing
327          * store).
328          */
329         struct dt_device       *lss_dev;
330
331         /* /seq file object device */
332         struct dt_object       *lss_obj;
333
334         /* Seq related proc */
335         cfs_proc_dir_entry_t   *lss_proc_dir;
336
337         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
338         enum lu_mgr_type       lss_type;
339
340         /* Client interafce to request controller */
341         struct lu_client_seq   *lss_cli;
342
343         /* Mutex for protecting allocation */
344         cfs_mutex_t             lss_mutex;
345
346         /*
347          * Service uuid, passed from MDT + seq name to form unique seq name to
348          * use it with procfs.
349          */
350         char                    lss_name[80];
351
352         /*
353          * Allocation chunks for super and meta sequences. Default values are
354          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
355          */
356         __u64                   lss_width;
357
358         /*
359          * minimum lss_alloc_set size that should be allocated from
360          * lss_space
361          */
362         __u64                   lss_set_width;
363
364         /* sync is needed for update operation */
365         __u32                   lss_need_sync;
366         /**
367          * Pointer to site object, required to access site fld.
368          */
369         struct md_site         *lss_site;
370 };
371
372 int seq_query(struct com_thread_info *info);
373
374 /* Server methods */
375 int seq_server_init(struct lu_server_seq *seq,
376                     struct dt_device *dev,
377                     const char *prefix,
378                     enum lu_mgr_type type,
379                     struct md_site *ls,
380                     const struct lu_env *env);
381
382 void seq_server_fini(struct lu_server_seq *seq,
383                      const struct lu_env *env);
384
385 int seq_server_alloc_super(struct lu_server_seq *seq,
386                            struct lu_seq_range *out,
387                            const struct lu_env *env);
388
389 int seq_server_alloc_meta(struct lu_server_seq *seq,
390                           struct lu_seq_range *out,
391                           const struct lu_env *env);
392
393 int seq_server_set_cli(struct lu_server_seq *seq,
394                        struct lu_client_seq *cli,
395                        const struct lu_env *env);
396
397 /* Client methods */
398 int seq_client_init(struct lu_client_seq *seq,
399                     struct obd_export *exp,
400                     enum lu_cli_type type,
401                     const char *prefix,
402                     struct lu_server_seq *srv);
403
404 void seq_client_fini(struct lu_client_seq *seq);
405
406 void seq_client_flush(struct lu_client_seq *seq);
407
408 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
409                          struct lu_fid *fid);
410 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
411                        seqno_t *seqnr);
412
413 /* Fids common stuff */
414 int fid_is_local(const struct lu_env *env,
415                  struct lu_site *site, const struct lu_fid *fid);
416
417 /* fid locking */
418
419 struct ldlm_namespace;
420
421 /*
422  * Build (DLM) resource name from FID.
423  *
424  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
425  * but was moved into name[1] along with the OID to avoid consuming the
426  * renaming name[2,3] fields that need to be used for the quota identifier.
427  */
428 static inline struct ldlm_res_id *
429 fid_build_reg_res_name(const struct lu_fid *f,
430                        struct ldlm_res_id *name)
431 {
432         memset(name, 0, sizeof *name);
433         name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
434         name->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(f);
435         return name;
436 }
437
438 /*
439  * Build (DLM) resource identifier from global quota FID and quota ID.
440  */
441 static inline struct ldlm_res_id *
442 fid_build_quota_resid(const struct lu_fid *glb_fid, union lquota_id *qid,
443                       struct ldlm_res_id *res)
444 {
445         fid_build_reg_res_name(glb_fid, res);
446         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
447         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
448         return res;
449 }
450
451 /*
452  * Extract global FID and quota ID from resource name
453  */
454 static inline void fid_extract_quota_resid(struct ldlm_res_id *res,
455                                            struct lu_fid *glb_fid,
456                                            union lquota_id *qid)
457 {
458         glb_fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
459         glb_fid->f_oid = (__u32)res->name[LUSTRE_RES_ID_VER_OID_OFF];
460         glb_fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
461
462         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
463         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
464         qid->qid_fid.f_ver =
465                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
466 }
467
468 /*
469  * Return true if resource is for object identified by fid.
470  */
471 static inline int fid_res_name_eq(const struct lu_fid *f,
472                                   const struct ldlm_res_id *name)
473 {
474         return name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
475                name->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(f);
476 }
477
478
479 static inline struct ldlm_res_id *
480 fid_build_pdo_res_name(const struct lu_fid *f,
481                        unsigned int hash,
482                        struct ldlm_res_id *name)
483 {
484         fid_build_reg_res_name(f, name);
485         name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
486         return name;
487 }
488
489
490 /**
491  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
492  * For non-IGIF FIDs this starts just over 2^32, and continues without
493  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
494  * into the range where there may not be many OID values in use, to minimize
495  * the risk of conflict.
496  *
497  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
498  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
499  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
500  */
501 static inline __u64 fid_flatten(const struct lu_fid *fid)
502 {
503         __u64 ino;
504         __u64 seq;
505
506         if (fid_is_igif(fid)) {
507                 ino = lu_igif_ino(fid);
508                 RETURN(ino);
509         }
510
511         seq = fid_seq(fid);
512
513         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
514
515         RETURN(ino ? ino : fid_oid(fid));
516 }
517
518 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
519 {
520         /* all objects with same id and different versions will belong to same
521          * collisions list. */
522         return cfs_hash_long(fid_flatten(f), bits);
523 }
524
525 /**
526  * map fid to 32 bit value for ino on 32bit systems. */
527 static inline __u32 fid_flatten32(const struct lu_fid *fid)
528 {
529         __u32 ino;
530         __u64 seq;
531
532         if (fid_is_igif(fid)) {
533                 ino = lu_igif_ino(fid);
534                 RETURN(ino);
535         }
536
537         seq = fid_seq(fid) - FID_SEQ_START;
538
539         /* Map the high bits of the OID into higher bits of the inode number so
540          * that inodes generated at about the same time have a reduced chance
541          * of collisions. This will give a period of 2^12 = 1024 unique clients
542          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
543          * (from OID), or up to 128M inodes without collisions for new files. */
544         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
545                (seq >> (64 - (40-8)) & 0xffffff00) +
546                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
547
548         RETURN(ino ? ino : fid_oid(fid));
549 }
550
551 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
552 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
553
554 /* Range common stuff */
555 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
556 {
557         dst->lsr_start = cpu_to_le64(src->lsr_start);
558         dst->lsr_end = cpu_to_le64(src->lsr_end);
559         dst->lsr_index = cpu_to_le32(src->lsr_index);
560         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
561 }
562
563 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
564 {
565         dst->lsr_start = le64_to_cpu(src->lsr_start);
566         dst->lsr_end = le64_to_cpu(src->lsr_end);
567         dst->lsr_index = le32_to_cpu(src->lsr_index);
568         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
569 }
570
571 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
572 {
573         dst->lsr_start = cpu_to_be64(src->lsr_start);
574         dst->lsr_end = cpu_to_be64(src->lsr_end);
575         dst->lsr_index = cpu_to_be32(src->lsr_index);
576         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
577 }
578
579 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
580 {
581         dst->lsr_start = be64_to_cpu(src->lsr_start);
582         dst->lsr_end = be64_to_cpu(src->lsr_end);
583         dst->lsr_index = be32_to_cpu(src->lsr_index);
584         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
585 }
586
587 /** @} fid */
588
589 #endif /* __LINUX_FID_H */