Whamcloud - gitweb
b=17670
[fs/lustre-release.git] / lustre / include / lustre_fid.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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 /*
45  * struct lu_fid
46  */
47 #include <lustre/lustre_idl.h>
48 #include <lustre_req_layout.h>
49 #include <lustre_mdt.h>
50
51 #include <libcfs/libcfs.h>
52
53 struct lu_site;
54 struct lu_context;
55
56 /* Whole sequences space range and zero range definitions */
57 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
58 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
59 extern const struct lu_fid LUSTRE_BFL_FID;
60 extern const struct lu_fid LU_OBF_FID;
61 extern const struct lu_fid LU_DOT_LUSTRE_FID;
62
63 enum {
64         /*
65          * This is how may FIDs may be allocated in one sequence. 16384 for
66          * now.
67          */
68         LUSTRE_SEQ_MAX_WIDTH = 0x0000000000000400ULL,
69
70         /*
71          * How many sequences may be allocate for meta-sequence (this is 128
72          * sequences).
73          */
74         /* changed to 16 to avoid overflow in test11 */
75         LUSTRE_SEQ_META_WIDTH = 0x0000000000000010ULL,
76
77         /*
78          * This is how many sequences may be in one super-sequence allocated to
79          * MDTs.
80          */
81         LUSTRE_SEQ_SUPER_WIDTH = (LUSTRE_SEQ_META_WIDTH * LUSTRE_SEQ_META_WIDTH)
82 };
83
84 /** special fid seq: used for local object create. */
85 #define FID_SEQ_LOCAL_FILE      (FID_SEQ_START + 1)
86
87 /** special fid seq: used for .lustre objects. */
88 #define LU_DOT_LUSTRE_SEQ       (FID_SEQ_START + 0x02ULL)
89
90 /* Note that reserved SEQ numbers below 12 will conflict with ldiskfs
91  * inodes in the IGIF namespace, so these reserved SEQ numbers must be
92  * used sparingly until ldiskfs-based MDT backends and/or IGIF FIDs 
93  * have been completely removed. */
94
95 /** fid sequence for distributed fs objects */
96 #define FID_SEQ_DISTRIBUTED_START     (FID_SEQ_START + 0x400ULL)
97
98 /** special OID for local objects */
99 enum {
100         /** \see osd_oi_index_create */
101         OSD_OI_FID_16_OID       = 2UL,
102         /** \see fld_mod_init */
103         FLD_INDEX_OID           = 3UL,
104         /** \see fid_mod_init */
105         FID_SEQ_CTL_OID         = 4UL,
106         FID_SEQ_SRV_OID         = 5UL,
107         /** \see mdd_mod_init */
108         MDD_ROOT_INDEX_OID      = 6UL,
109         MDD_ORPHAN_OID          = 7UL,
110         MDD_LOV_OBJ_OID         = 8UL,
111         MDD_CAPA_KEYS_OID       = 9UL,
112         MDD_OBJECTS_OID         = 10UL,
113         /** \see mdt_mod_init */
114         MDT_LAST_RECV_OID       = 11UL,
115         /** \see osd_mod_init */
116         OSD_REM_OBJ_DIR_OID     = 12UL,
117 };
118
119 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
120 {
121         fid->f_seq = FID_SEQ_LOCAL_FILE;
122         fid->f_oid = oid;
123         fid->f_ver = 0;
124 }
125
126 enum lu_mgr_type {
127         LUSTRE_SEQ_SERVER,
128         LUSTRE_SEQ_CONTROLLER
129 };
130
131 enum lu_cli_type {
132         LUSTRE_SEQ_METADATA,
133         LUSTRE_SEQ_DATA
134 };
135
136 struct lu_server_seq;
137
138 /* Client sequence manager interface. */
139 struct lu_client_seq {
140         /* Sequence-controller export. */
141         struct obd_export      *lcs_exp;
142         cfs_semaphore_t         lcs_sem;
143
144         /*
145          * Range of allowed for allocation sequeces. When using lu_client_seq on
146          * clients, this contains meta-sequence range. And for servers this
147          * contains super-sequence range.
148          */
149         struct lu_seq_range         lcs_space;
150
151         /* Seq related proc */
152         cfs_proc_dir_entry_t   *lcs_proc_dir;
153
154         /* This holds last allocated fid in last obtained seq */
155         struct lu_fid           lcs_fid;
156
157         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
158         enum lu_cli_type        lcs_type;
159
160         /*
161          * Service uuid, passed from MDT + seq name to form unique seq name to
162          * use it with procfs.
163          */
164         char                    lcs_name[80];
165
166         /*
167          * Sequence width, that is how many objects may be allocated in one
168          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
169          */
170         __u64                   lcs_width;
171
172         /* Seq-server for direct talking */
173         struct lu_server_seq   *lcs_srv;
174 };
175
176 /* server sequence manager interface */
177 struct lu_server_seq {
178         /* Available sequences space */
179         struct lu_seq_range         lss_space;
180
181         /*
182          * Device for server side seq manager needs (saving sequences to backing
183          * store).
184          */
185         struct dt_device       *lss_dev;
186
187         /* /seq file object device */
188         struct dt_object       *lss_obj;
189
190         /* Seq related proc */
191         cfs_proc_dir_entry_t   *lss_proc_dir;
192
193         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
194         enum lu_mgr_type       lss_type;
195
196         /* Client interafce to request controller */
197         struct lu_client_seq   *lss_cli;
198
199         /* Semaphore for protecting allocation */
200         cfs_semaphore_t         lss_sem;
201
202         /*
203          * Service uuid, passed from MDT + seq name to form unique seq name to
204          * use it with procfs.
205          */
206         char                    lss_name[80];
207
208         /*
209          * Allocation chunks for super and meta sequences. Default values are
210          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
211          */
212         __u64                   lss_width;
213
214         /**
215          * Pointer to site object, required to access site fld.
216          */
217         struct md_site         *lss_site;
218 };
219
220 int seq_query(struct com_thread_info *info);
221
222 /* Server methods */
223 int seq_server_init(struct lu_server_seq *seq,
224                     struct dt_device *dev,
225                     const char *prefix,
226                     enum lu_mgr_type type,
227                     struct md_site *ls,
228                     const struct lu_env *env);
229
230 void seq_server_fini(struct lu_server_seq *seq,
231                      const struct lu_env *env);
232
233 int seq_server_alloc_super(struct lu_server_seq *seq,
234                            struct lu_seq_range *in,
235                            struct lu_seq_range *out,
236                            const struct lu_env *env);
237
238 int seq_server_alloc_meta(struct lu_server_seq *seq,
239                           struct lu_seq_range *in,
240                           struct lu_seq_range *out,
241                           const struct lu_env *env);
242
243 int seq_server_set_cli(struct lu_server_seq *seq,
244                        struct lu_client_seq *cli,
245                        const struct lu_env *env);
246
247 /* Client methods */
248 int seq_client_init(struct lu_client_seq *seq,
249                     struct obd_export *exp,
250                     enum lu_cli_type type,
251                     const char *prefix,
252                     struct lu_server_seq *srv);
253
254 void seq_client_fini(struct lu_client_seq *seq);
255
256 void seq_client_flush(struct lu_client_seq *seq);
257
258 int seq_client_alloc_fid(struct lu_client_seq *seq,
259                          struct lu_fid *fid);
260
261 /* Fids common stuff */
262 int fid_is_local(const struct lu_env *env,
263                  struct lu_site *site, const struct lu_fid *fid);
264
265 /* fid locking */
266
267 struct ldlm_namespace;
268
269 enum {
270         LUSTRE_RES_ID_SEQ_OFF = 0,
271         LUSTRE_RES_ID_OID_OFF = 1,
272         LUSTRE_RES_ID_VER_OFF = 2,
273         LUSTRE_RES_ID_HSH_OFF = 3
274 };
275
276 /*
277  * Build (DLM) resource name from fid.
278  */
279 static inline struct ldlm_res_id *
280 fid_build_reg_res_name(const struct lu_fid *f,
281                        struct ldlm_res_id *name)
282 {
283         memset(name, 0, sizeof *name);
284         name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
285         name->name[LUSTRE_RES_ID_OID_OFF] = fid_oid(f);
286         name->name[LUSTRE_RES_ID_VER_OFF] = fid_ver(f);
287         return name;
288 }
289
290 /*
291  * Return true if resource is for object identified by fid.
292  */
293 static inline int fid_res_name_eq(const struct lu_fid *f,
294                                   const struct ldlm_res_id *name)
295 {
296         return
297                 name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
298                 name->name[LUSTRE_RES_ID_OID_OFF] == fid_oid(f) &&
299                 name->name[LUSTRE_RES_ID_VER_OFF] == fid_ver(f);
300 }
301
302
303 static inline struct ldlm_res_id *
304 fid_build_pdo_res_name(const struct lu_fid *f,
305                        unsigned int hash,
306                        struct ldlm_res_id *name)
307 {
308         fid_build_reg_res_name(f, name);
309         name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
310         return name;
311 }
312
313 static inline __u64 fid_flatten(const struct lu_fid *fid)
314 {
315         return (fid_seq(fid) - 1) * LUSTRE_SEQ_MAX_WIDTH + fid_oid(fid);
316 }
317
318 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
319 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
320
321 /* Range common stuff */
322 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
323 {
324         dst->lsr_start = cpu_to_le64(src->lsr_start);
325         dst->lsr_end = cpu_to_le64(src->lsr_end);
326         dst->lsr_mdt = cpu_to_le32(src->lsr_mdt);
327 }
328
329 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
330 {
331         dst->lsr_start = le64_to_cpu(src->lsr_start);
332         dst->lsr_end = le64_to_cpu(src->lsr_end);
333         dst->lsr_mdt = le32_to_cpu(src->lsr_mdt);
334 }
335
336 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
337 {
338         dst->lsr_start = cpu_to_be64(src->lsr_start);
339         dst->lsr_end = cpu_to_be64(src->lsr_end);
340         dst->lsr_mdt = cpu_to_be32(src->lsr_mdt);
341 }
342
343 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
344 {
345         dst->lsr_start = be64_to_cpu(src->lsr_start);
346         dst->lsr_end = be64_to_cpu(src->lsr_end);
347         dst->lsr_mdt = be32_to_cpu(src->lsr_mdt);
348 }
349
350 #endif /* __LINUX_FID_H */