Whamcloud - gitweb
b=19902
[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 /** special OID for local objects */
91 enum {
92         /** \see osd_oi_index_create */
93         OSD_OI_FID_16_OID       = 2UL,
94         /** \see fld_mod_init */
95         FLD_INDEX_OID           = 3UL,
96         /** \see fid_mod_init */
97         FID_SEQ_CTL_OID         = 4UL,
98         FID_SEQ_SRV_OID         = 5UL,
99         /** \see mdd_mod_init */
100         MDD_ROOT_INDEX_OID      = 6UL,
101         MDD_ORPHAN_OID          = 7UL,
102         MDD_LOV_OBJ_OID         = 8UL,
103         MDD_CAPA_KEYS_OID       = 9UL,
104         MDD_OBJECTS_OID         = 10UL,
105         /** \see mdt_mod_init */
106         MDT_LAST_RECV_OID       = 11UL,
107         /** \see osd_mod_init */
108         OSD_REM_OBJ_DIR_OID     = 12UL,
109 };
110
111 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
112 {
113         fid->f_seq = FID_SEQ_LOCAL_FILE;
114         fid->f_oid = oid;
115         fid->f_ver = 0;
116 }
117
118 enum lu_mgr_type {
119         LUSTRE_SEQ_SERVER,
120         LUSTRE_SEQ_CONTROLLER
121 };
122
123 enum lu_cli_type {
124         LUSTRE_SEQ_METADATA,
125         LUSTRE_SEQ_DATA
126 };
127
128 struct lu_server_seq;
129
130 /* Client sequence manager interface. */
131 struct lu_client_seq {
132         /* Sequence-controller export. */
133         struct obd_export      *lcs_exp;
134         struct semaphore        lcs_sem;
135
136         /*
137          * Range of allowed for allocation sequeces. When using lu_client_seq on
138          * clients, this contains meta-sequence range. And for servers this
139          * contains super-sequence range.
140          */
141         struct lu_seq_range         lcs_space;
142
143         /* Seq related proc */
144         cfs_proc_dir_entry_t   *lcs_proc_dir;
145
146         /* This holds last allocated fid in last obtained seq */
147         struct lu_fid           lcs_fid;
148
149         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
150         enum lu_cli_type        lcs_type;
151
152         /*
153          * Service uuid, passed from MDT + seq name to form unique seq name to
154          * use it with procfs.
155          */
156         char                    lcs_name[80];
157
158         /*
159          * Sequence width, that is how many objects may be allocated in one
160          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
161          */
162         __u64                   lcs_width;
163
164         /* Seq-server for direct talking */
165         struct lu_server_seq   *lcs_srv;
166 };
167
168 /* server sequence manager interface */
169 struct lu_server_seq {
170         /* Available sequences space */
171         struct lu_seq_range         lss_space;
172
173         /*
174          * Device for server side seq manager needs (saving sequences to backing
175          * store).
176          */
177         struct dt_device       *lss_dev;
178
179         /* /seq file object device */
180         struct dt_object       *lss_obj;
181
182         /* Seq related proc */
183         cfs_proc_dir_entry_t   *lss_proc_dir;
184
185         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
186         enum lu_mgr_type       lss_type;
187
188         /* Client interafce to request controller */
189         struct lu_client_seq   *lss_cli;
190
191         /* Semaphore for protecting allocation */
192         struct semaphore        lss_sem;
193
194         /*
195          * Service uuid, passed from MDT + seq name to form unique seq name to
196          * use it with procfs.
197          */
198         char                    lss_name[80];
199
200         /*
201          * Allocation chunks for super and meta sequences. Default values are
202          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
203          */
204         __u64                   lss_width;
205
206         /**
207          * Pointer to site object, required to access site fld.
208          */
209         struct md_site         *lss_site;
210 };
211
212 int seq_query(struct com_thread_info *info);
213
214 /* Server methods */
215 int seq_server_init(struct lu_server_seq *seq,
216                     struct dt_device *dev,
217                     const char *prefix,
218                     enum lu_mgr_type type,
219                     struct md_site *ls,
220                     const struct lu_env *env);
221
222 void seq_server_fini(struct lu_server_seq *seq,
223                      const struct lu_env *env);
224
225 int seq_server_alloc_super(struct lu_server_seq *seq,
226                            struct lu_seq_range *in,
227                            struct lu_seq_range *out,
228                            const struct lu_env *env);
229
230 int seq_server_alloc_meta(struct lu_server_seq *seq,
231                           struct lu_seq_range *in,
232                           struct lu_seq_range *out,
233                           const struct lu_env *env);
234
235 int seq_server_set_cli(struct lu_server_seq *seq,
236                        struct lu_client_seq *cli,
237                        const struct lu_env *env);
238
239 /* Client methods */
240 int seq_client_init(struct lu_client_seq *seq,
241                     struct obd_export *exp,
242                     enum lu_cli_type type,
243                     const char *prefix,
244                     struct lu_server_seq *srv);
245
246 void seq_client_fini(struct lu_client_seq *seq);
247
248 void seq_client_flush(struct lu_client_seq *seq);
249
250 int seq_client_alloc_fid(struct lu_client_seq *seq,
251                          struct lu_fid *fid);
252
253 /* Fids common stuff */
254 int fid_is_local(const struct lu_env *env,
255                  struct lu_site *site, const struct lu_fid *fid);
256
257 /* fid locking */
258
259 struct ldlm_namespace;
260
261 enum {
262         LUSTRE_RES_ID_SEQ_OFF = 0,
263         LUSTRE_RES_ID_OID_OFF = 1,
264         LUSTRE_RES_ID_VER_OFF = 2,
265         LUSTRE_RES_ID_HSH_OFF = 3
266 };
267
268 /*
269  * Build (DLM) resource name from fid.
270  */
271 static inline struct ldlm_res_id *
272 fid_build_reg_res_name(const struct lu_fid *f,
273                        struct ldlm_res_id *name)
274 {
275         memset(name, 0, sizeof *name);
276         name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
277         name->name[LUSTRE_RES_ID_OID_OFF] = fid_oid(f);
278         name->name[LUSTRE_RES_ID_VER_OFF] = fid_ver(f);
279         return name;
280 }
281
282 /*
283  * Return true if resource is for object identified by fid.
284  */
285 static inline int fid_res_name_eq(const struct lu_fid *f,
286                                   const struct ldlm_res_id *name)
287 {
288         return
289                 name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
290                 name->name[LUSTRE_RES_ID_OID_OFF] == fid_oid(f) &&
291                 name->name[LUSTRE_RES_ID_VER_OFF] == fid_ver(f);
292 }
293
294
295 static inline struct ldlm_res_id *
296 fid_build_pdo_res_name(const struct lu_fid *f,
297                        unsigned int hash,
298                        struct ldlm_res_id *name)
299 {
300         fid_build_reg_res_name(f, name);
301         name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
302         return name;
303 }
304
305 static inline __u64 fid_flatten(const struct lu_fid *fid)
306 {
307         return (fid_seq(fid) - 1) * LUSTRE_SEQ_MAX_WIDTH + fid_oid(fid);
308 }
309
310 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
311 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
312
313 /* Range common stuff */
314 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
315 {
316         dst->lsr_start = cpu_to_le64(src->lsr_start);
317         dst->lsr_end = cpu_to_le64(src->lsr_end);
318         dst->lsr_mdt = cpu_to_le32(src->lsr_mdt);
319 }
320
321 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
322 {
323         dst->lsr_start = le64_to_cpu(src->lsr_start);
324         dst->lsr_end = le64_to_cpu(src->lsr_end);
325         dst->lsr_mdt = le32_to_cpu(src->lsr_mdt);
326 }
327
328 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
329 {
330         dst->lsr_start = cpu_to_be64(src->lsr_start);
331         dst->lsr_end = cpu_to_be64(src->lsr_end);
332         dst->lsr_mdt = cpu_to_be32(src->lsr_mdt);
333 }
334
335 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
336 {
337         dst->lsr_start = be64_to_cpu(src->lsr_start);
338         dst->lsr_end = be64_to_cpu(src->lsr_end);
339         dst->lsr_mdt = be32_to_cpu(src->lsr_mdt);
340 }
341
342 #endif /* __LINUX_FID_H */