1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre_fid.h
38 * Author: Yury Umanets <umka@clusterfs.com>
52 #include <libcfs/libcfs.h>
53 #include <lustre/lustre_idl.h>
54 #include <lustre_req_layout.h>
55 #include <lustre_mdt.h>
61 /* Whole sequences space range and zero range definitions */
62 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
63 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
64 extern const struct lu_fid LUSTRE_BFL_FID;
65 extern const struct lu_fid LU_OBF_FID;
66 extern const struct lu_fid LU_DOT_LUSTRE_FID;
70 * This is how may FIDs may be allocated in one sequence. 16384 for
73 LUSTRE_SEQ_MAX_WIDTH = 0x0000000000000400ULL,
76 * How many sequences may be allocate for meta-sequence (this is 128
79 /* changed to 16 to avoid overflow in test11 */
80 LUSTRE_SEQ_META_WIDTH = 0x0000000000000010ULL,
83 * seq allocation pool size.
85 LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
88 * This is how many sequences may be in one super-sequence allocated to
91 LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
94 /** special fid seq: used for local object create. */
95 #define FID_SEQ_LOCAL_FILE (FID_SEQ_START + 1)
97 /** special fid seq: used for .lustre objects. */
98 #define LU_DOT_LUSTRE_SEQ (FID_SEQ_START + 0x02ULL)
100 /* Note that reserved SEQ numbers below 12 will conflict with ldiskfs
101 * inodes in the IGIF namespace, so these reserved SEQ numbers must be
102 * used sparingly until ldiskfs-based MDT backends and/or IGIF FIDs
103 * have been completely removed. */
105 /** fid sequence for distributed fs objects */
106 #define FID_SEQ_DISTRIBUTED_START (FID_SEQ_START + 0x400ULL)
108 /** special OID for local objects */
110 /** \see osd_oi_index_create */
111 OSD_OI_FID_16_OID = 2UL,
112 /** \see fld_mod_init */
114 /** \see fid_mod_init */
115 FID_SEQ_CTL_OID = 4UL,
116 FID_SEQ_SRV_OID = 5UL,
117 /** \see mdd_mod_init */
118 MDD_ROOT_INDEX_OID = 6UL,
119 MDD_ORPHAN_OID = 7UL,
120 MDD_LOV_OBJ_OID = 8UL,
121 MDD_CAPA_KEYS_OID = 9UL,
122 MDD_OBJECTS_OID = 10UL,
123 /** \see mdt_mod_init */
124 MDT_LAST_RECV_OID = 11UL,
125 /** \see osd_mod_init */
126 OSD_REM_OBJ_DIR_OID = 12UL,
129 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
131 fid->f_seq = FID_SEQ_LOCAL_FILE;
138 LUSTRE_SEQ_CONTROLLER
146 struct lu_server_seq;
148 /* Client sequence manager interface. */
149 struct lu_client_seq {
150 /* Sequence-controller export. */
151 struct obd_export *lcs_exp;
152 cfs_semaphore_t lcs_sem;
155 * Range of allowed for allocation sequeces. When using lu_client_seq on
156 * clients, this contains meta-sequence range. And for servers this
157 * contains super-sequence range.
159 struct lu_seq_range lcs_space;
161 /* Seq related proc */
162 cfs_proc_dir_entry_t *lcs_proc_dir;
164 /* This holds last allocated fid in last obtained seq */
165 struct lu_fid lcs_fid;
167 /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
168 enum lu_cli_type lcs_type;
171 * Service uuid, passed from MDT + seq name to form unique seq name to
172 * use it with procfs.
177 * Sequence width, that is how many objects may be allocated in one
178 * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
182 /* Seq-server for direct talking */
183 struct lu_server_seq *lcs_srv;
186 /* server sequence manager interface */
187 struct lu_server_seq {
188 /* Available sequences space */
189 struct lu_seq_range lss_space;
191 /* keeps highwater in lsr_end for seq allocation algorithm */
192 struct lu_seq_range lss_lowater_set;
193 struct lu_seq_range lss_hiwater_set;
196 * Device for server side seq manager needs (saving sequences to backing
199 struct dt_device *lss_dev;
201 /* /seq file object device */
202 struct dt_object *lss_obj;
204 /* Seq related proc */
205 cfs_proc_dir_entry_t *lss_proc_dir;
207 /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
208 enum lu_mgr_type lss_type;
210 /* Client interafce to request controller */
211 struct lu_client_seq *lss_cli;
213 /* Semaphore for protecting allocation */
214 cfs_semaphore_t lss_sem;
217 * Service uuid, passed from MDT + seq name to form unique seq name to
218 * use it with procfs.
223 * Allocation chunks for super and meta sequences. Default values are
224 * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
229 * minimum lss_alloc_set size that should be allocated from
234 /* transaction no of seq update write operation */
235 __u64 lss_set_transno;
237 * Pointer to site object, required to access site fld.
239 struct md_site *lss_site;
242 int seq_query(struct com_thread_info *info);
245 int seq_server_init(struct lu_server_seq *seq,
246 struct dt_device *dev,
248 enum lu_mgr_type type,
250 const struct lu_env *env);
252 void seq_server_fini(struct lu_server_seq *seq,
253 const struct lu_env *env);
255 int seq_server_alloc_super(struct lu_server_seq *seq,
256 struct lu_seq_range *out,
257 const struct lu_env *env);
259 int seq_server_alloc_meta(struct lu_server_seq *seq,
260 struct lu_seq_range *out,
261 const struct lu_env *env);
263 int seq_server_set_cli(struct lu_server_seq *seq,
264 struct lu_client_seq *cli,
265 const struct lu_env *env);
268 int seq_client_init(struct lu_client_seq *seq,
269 struct obd_export *exp,
270 enum lu_cli_type type,
272 struct lu_server_seq *srv);
274 void seq_client_fini(struct lu_client_seq *seq);
276 void seq_client_flush(struct lu_client_seq *seq);
278 int seq_client_alloc_fid(struct lu_client_seq *seq,
281 /* Fids common stuff */
282 int fid_is_local(const struct lu_env *env,
283 struct lu_site *site, const struct lu_fid *fid);
287 struct ldlm_namespace;
290 LUSTRE_RES_ID_SEQ_OFF = 0,
291 LUSTRE_RES_ID_OID_OFF = 1,
292 LUSTRE_RES_ID_VER_OFF = 2,
293 LUSTRE_RES_ID_HSH_OFF = 3
297 * Build (DLM) resource name from fid.
299 static inline struct ldlm_res_id *
300 fid_build_reg_res_name(const struct lu_fid *f,
301 struct ldlm_res_id *name)
303 memset(name, 0, sizeof *name);
304 name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
305 name->name[LUSTRE_RES_ID_OID_OFF] = fid_oid(f);
306 name->name[LUSTRE_RES_ID_VER_OFF] = fid_ver(f);
311 * Return true if resource is for object identified by fid.
313 static inline int fid_res_name_eq(const struct lu_fid *f,
314 const struct ldlm_res_id *name)
317 name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
318 name->name[LUSTRE_RES_ID_OID_OFF] == fid_oid(f) &&
319 name->name[LUSTRE_RES_ID_VER_OFF] == fid_ver(f);
323 static inline struct ldlm_res_id *
324 fid_build_pdo_res_name(const struct lu_fid *f,
326 struct ldlm_res_id *name)
328 fid_build_reg_res_name(f, name);
329 name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
333 static inline __u64 fid_flatten(const struct lu_fid *fid)
335 return (fid_seq(fid) - 1) * LUSTRE_SEQ_MAX_WIDTH + fid_oid(fid);
338 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
339 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
341 /* Range common stuff */
342 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
344 dst->lsr_start = cpu_to_le64(src->lsr_start);
345 dst->lsr_end = cpu_to_le64(src->lsr_end);
346 dst->lsr_mdt = cpu_to_le32(src->lsr_mdt);
349 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
351 dst->lsr_start = le64_to_cpu(src->lsr_start);
352 dst->lsr_end = le64_to_cpu(src->lsr_end);
353 dst->lsr_mdt = le32_to_cpu(src->lsr_mdt);
356 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
358 dst->lsr_start = cpu_to_be64(src->lsr_start);
359 dst->lsr_end = cpu_to_be64(src->lsr_end);
360 dst->lsr_mdt = cpu_to_be32(src->lsr_mdt);
363 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
365 dst->lsr_start = be64_to_cpu(src->lsr_start);
366 dst->lsr_end = be64_to_cpu(src->lsr_end);
367 dst->lsr_mdt = be32_to_cpu(src->lsr_mdt);
372 #endif /* __LINUX_FID_H */