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 2008 Sun Microsystems, Inc. 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>
47 #include <lustre/lustre_idl.h>
48 #include <lustre_req_layout.h>
49 #include <lustre_mdt.h>
51 #include <libcfs/libcfs.h>
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;
65 * This is how may FIDs may be allocated in one sequence. 16384 for
68 LUSTRE_SEQ_MAX_WIDTH = 0x0000000000000400ULL,
71 * How many sequences may be allocate for meta-sequence (this is 128
74 /* changed to 16 to avoid overflow in test11 */
75 LUSTRE_SEQ_META_WIDTH = 0x0000000000000010ULL,
78 * This is how many sequences may be in one super-sequence allocated to
81 LUSTRE_SEQ_SUPER_WIDTH = (LUSTRE_SEQ_META_WIDTH * LUSTRE_SEQ_META_WIDTH)
84 /** special fid seq: used for local object create. */
85 #define FID_SEQ_LOCAL_FILE (FID_SEQ_START + 1)
87 /** special fid seq: used for .lustre objects. */
88 #define LU_DOT_LUSTRE_SEQ (FID_SEQ_START + 0x02ULL)
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. */
95 /** fid sequence for distributed fs objects */
96 #define FID_SEQ_DISTRIBUTED_START (FID_SEQ_START + 0x400ULL)
98 /** special OID for local objects */
100 /** \see osd_oi_index_create */
101 OSD_OI_FID_16_OID = 2UL,
102 /** \see fld_mod_init */
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,
119 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
121 fid->f_seq = FID_SEQ_LOCAL_FILE;
128 LUSTRE_SEQ_CONTROLLER
136 struct lu_server_seq;
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;
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.
149 struct lu_seq_range lcs_space;
151 /* Seq related proc */
152 cfs_proc_dir_entry_t *lcs_proc_dir;
154 /* This holds last allocated fid in last obtained seq */
155 struct lu_fid lcs_fid;
157 /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
158 enum lu_cli_type lcs_type;
161 * Service uuid, passed from MDT + seq name to form unique seq name to
162 * use it with procfs.
167 * Sequence width, that is how many objects may be allocated in one
168 * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
172 /* Seq-server for direct talking */
173 struct lu_server_seq *lcs_srv;
176 /* server sequence manager interface */
177 struct lu_server_seq {
178 /* Available sequences space */
179 struct lu_seq_range lss_space;
182 * Device for server side seq manager needs (saving sequences to backing
185 struct dt_device *lss_dev;
187 /* /seq file object device */
188 struct dt_object *lss_obj;
190 /* Seq related proc */
191 cfs_proc_dir_entry_t *lss_proc_dir;
193 /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
194 enum lu_mgr_type lss_type;
196 /* Client interafce to request controller */
197 struct lu_client_seq *lss_cli;
199 /* Semaphore for protecting allocation */
200 cfs_semaphore_t lss_sem;
203 * Service uuid, passed from MDT + seq name to form unique seq name to
204 * use it with procfs.
209 * Allocation chunks for super and meta sequences. Default values are
210 * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
215 * Pointer to site object, required to access site fld.
217 struct md_site *lss_site;
220 int seq_query(struct com_thread_info *info);
223 int seq_server_init(struct lu_server_seq *seq,
224 struct dt_device *dev,
226 enum lu_mgr_type type,
228 const struct lu_env *env);
230 void seq_server_fini(struct lu_server_seq *seq,
231 const struct lu_env *env);
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);
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);
243 int seq_server_set_cli(struct lu_server_seq *seq,
244 struct lu_client_seq *cli,
245 const struct lu_env *env);
248 int seq_client_init(struct lu_client_seq *seq,
249 struct obd_export *exp,
250 enum lu_cli_type type,
252 struct lu_server_seq *srv);
254 void seq_client_fini(struct lu_client_seq *seq);
256 void seq_client_flush(struct lu_client_seq *seq);
258 int seq_client_alloc_fid(struct lu_client_seq *seq,
261 /* Fids common stuff */
262 int fid_is_local(const struct lu_env *env,
263 struct lu_site *site, const struct lu_fid *fid);
267 struct ldlm_namespace;
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
277 * Build (DLM) resource name from fid.
279 static inline struct ldlm_res_id *
280 fid_build_reg_res_name(const struct lu_fid *f,
281 struct ldlm_res_id *name)
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);
291 * Return true if resource is for object identified by fid.
293 static inline int fid_res_name_eq(const struct lu_fid *f,
294 const struct ldlm_res_id *name)
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);
303 static inline struct ldlm_res_id *
304 fid_build_pdo_res_name(const struct lu_fid *f,
306 struct ldlm_res_id *name)
308 fid_build_reg_res_name(f, name);
309 name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
313 static inline __u64 fid_flatten(const struct lu_fid *fid)
315 return (fid_seq(fid) - 1) * LUSTRE_SEQ_MAX_WIDTH + fid_oid(fid);
318 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
319 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
321 /* Range common stuff */
322 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
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);
329 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
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);
336 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
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);
343 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
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);
350 #endif /* __LINUX_FID_H */