4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 #ifndef LOV_INTERNAL_H
33 #define LOV_INTERNAL_H
35 #include <obd_class.h>
36 #include <uapi/linux/lustre/lustre_user.h>
38 /* If we are unable to get the maximum object size from the OST in
39 * ocd_maxbytes using OBD_CONNECT_MAXBYTES, then we fall back to using
40 * the old maximum object size from ext3. */
41 #define LUSTRE_EXT3_STRIPE_MAXBYTES 0x1fffffff000ULL
43 struct lov_stripe_md_entry {
44 struct lu_extent lsme_extent;
51 u16 lsme_stripe_count;
53 char lsme_pool_name[LOV_MAXPOOLNAME + 1];
54 struct lov_oinfo *lsme_oinfo[];
57 static inline bool lsme_is_dom(struct lov_stripe_md_entry *lsme)
59 return (lov_pattern(lsme->lsme_pattern) & LOV_PATTERN_MDT);
62 static inline void copy_lsm_entry(struct lov_stripe_md_entry *dst,
63 struct lov_stripe_md_entry *src)
67 for (i = 0; i < src->lsme_stripe_count; i++)
68 *dst->lsme_oinfo[i] = *src->lsme_oinfo[i];
69 memcpy(dst, src, offsetof(typeof(*src), lsme_oinfo));
72 struct lov_stripe_md {
75 pid_t lsm_lock_owner; /* debugging */
78 /* maximum possible file size, might change as OSTs status
79 * changes, e.g. disconnected, deactivated
82 /* size of full foreign LOV */
83 size_t lsm_foreign_size;
92 struct lov_stripe_md_entry *lsm_entries[];
95 #define lsm_foreign(lsm) (lsm->lsm_entries[0])
97 static inline bool lsme_is_foreign(const struct lov_stripe_md_entry *lsme)
99 return lsme->lsme_magic == LOV_MAGIC_FOREIGN;
102 static inline bool lsm_entry_is_foreign(const struct lov_stripe_md *lsm,
105 return lsme_is_foreign(lsm->lsm_entries[index]);
108 static inline bool lsme_inited(const struct lov_stripe_md_entry *lsme)
110 return lsme->lsme_flags & LCME_FL_INIT;
113 static inline bool lsm_entry_inited(const struct lov_stripe_md *lsm, int index)
115 return lsme_inited(lsm->lsm_entries[index]);
118 static inline bool lsm_is_composite(__u32 magic)
120 return magic == LOV_MAGIC_COMP_V1;
123 static inline size_t lov_comp_md_size(const struct lov_stripe_md *lsm)
125 struct lov_stripe_md_entry *lsme;
129 if (lsm->lsm_magic == LOV_MAGIC_V1 || lsm->lsm_magic == LOV_MAGIC_V3)
130 return lov_mds_md_size(lsm->lsm_entries[0]->lsme_stripe_count,
131 lsm->lsm_entries[0]->lsme_magic);
133 if (lsm->lsm_magic == LOV_MAGIC_FOREIGN)
134 return lsm->lsm_foreign_size;
136 LASSERT(lsm->lsm_magic == LOV_MAGIC_COMP_V1);
138 size = sizeof(struct lov_comp_md_v1) +
139 sizeof(struct lov_comp_md_entry_v1) * lsm->lsm_entry_count;
140 for (entry = 0; entry < lsm->lsm_entry_count; entry++) {
143 lsme = lsm->lsm_entries[entry];
145 if (lsme_inited(lsme))
146 stripe_count = lsme->lsme_stripe_count;
150 size += lov_mds_md_size(stripe_count,
157 static inline bool lsm_has_objects(struct lov_stripe_md *lsm)
159 return lsm != NULL && !lsm->lsm_is_released;
162 static inline unsigned int lov_comp_index(int entry, int stripe)
164 LASSERT(entry >= 0 && entry <= SHRT_MAX);
165 LASSERT(stripe >= 0 && stripe < USHRT_MAX);
167 return entry << 16 | stripe;
170 static inline int lov_comp_stripe(int index)
172 return index & 0xffff;
175 static inline int lov_comp_entry(int index)
180 struct lsm_operations {
181 struct lov_stripe_md *(*lsm_unpackmd)(struct lov_obd *, void *, size_t);
184 const struct lsm_operations *lsm_op_find(int magic);
185 void lsm_free(struct lov_stripe_md *lsm);
187 static inline bool lov_supported_comp_magic(unsigned int magic)
189 return magic == LOV_MAGIC_V1 || magic == LOV_MAGIC_V3 ||
190 magic == LOV_MAGIC_FOREIGN;
193 /* lov_do_div64(a, b) returns a % b, and a = a / b.
194 * The 32-bit code is LOV-specific due to knowing about stripe limits in
195 * order to reduce the divisor to a 32-bit number. If the divisor is
196 * already a 32-bit value the compiler handles this directly. */
197 #if BITS_PER_LONG == 64
198 # define lov_do_div64(n, base) ({ \
199 uint64_t __base = (base); \
201 __rem = ((uint64_t)(n)) % __base; \
202 (n) = ((uint64_t)(n)) / __base; \
205 #elif BITS_PER_LONG == 32
206 # define lov_do_div64(n, base) ({ \
207 uint64_t __num = (n); \
209 if ((sizeof(base) > 4) && (((base) & 0xffffffff00000000ULL) != 0)) { \
211 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), \
212 "64 bit lov division %llu / %llu\n", \
213 __num, (uint64_t)(base)); \
214 __remainder = __num & (LOV_MIN_STRIPE_SIZE - 1); \
215 __num >>= LOV_MIN_STRIPE_BITS; \
216 __rem = do_div(__num, (base) >> LOV_MIN_STRIPE_BITS); \
217 __rem <<= LOV_MIN_STRIPE_BITS; \
218 __rem += __remainder; \
220 __rem = do_div(__num, base); \
227 #define pool_tgt_count(p) ((p)->pool_obds.op_count)
228 #define pool_tgt_array(p) ((p)->pool_obds.op_array)
229 #define pool_tgt_rw_sem(p) ((p)->pool_obds.op_rw_sem)
232 char pool_name[LOV_MAXPOOLNAME + 1];
233 struct lu_tgt_pool pool_obds;
234 atomic_t pool_refcount;
235 struct rhash_head pool_hash; /* access by poolname */
236 struct list_head pool_list; /* serial access */
237 struct rcu_head pool_rcu;
238 struct proc_dir_entry *pool_proc_entry;
239 struct obd_device *pool_lobd; /* owner */
242 int lov_pool_hash_init(struct rhashtable *tbl);
243 void lov_pool_hash_destroy(struct rhashtable *tbl);
246 struct obd_info rq_oi;
247 struct lov_request_set *rq_rqset;
248 struct list_head rq_link;
249 int rq_idx; /* index in lov->tgts array */
252 struct lov_request_set {
253 struct obd_info *set_oi;
254 struct obd_device *set_obd;
256 atomic_t set_completes;
257 atomic_t set_success;
258 struct list_head set_list;
261 extern struct kmem_cache *lov_oinfo_slab;
263 extern struct lu_kmem_descr lov_caches[];
265 #define lov_uuid2str(lv, index) \
266 (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
269 int lov_merge_lvb_kms(struct lov_stripe_md *lsm, int index,
270 struct cl_attr *attr);
273 loff_t stripe_width(struct lov_stripe_md *lsm, unsigned int index);
274 u64 lov_stripe_size(struct lov_stripe_md *lsm, int index,
275 u64 ost_size, int stripeno);
276 int lov_stripe_offset(struct lov_stripe_md *lsm, int index, loff_t lov_off,
277 int stripeno, loff_t *obd_off);
278 loff_t lov_size_to_stripe(struct lov_stripe_md *lsm, int index, u64 file_size,
280 int lov_stripe_intersects(struct lov_stripe_md *lsm, int index, int stripeno,
281 struct lu_extent *ext, u64 *obd_start, u64 *obd_end);
282 int lov_stripe_number(struct lov_stripe_md *lsm, int index, loff_t lov_off);
283 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, int index,
284 pgoff_t stripe_index, int stripe);
287 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
288 struct lov_request_set **reqset);
289 int lov_fini_statfs_set(struct lov_request_set *set);
292 void lov_tgts_getref(struct obd_device *obd);
293 void lov_tgts_putref(struct obd_device *obd);
294 void lov_stripe_lock(struct lov_stripe_md *md);
295 void lov_stripe_unlock(struct lov_stripe_md *md);
296 void lov_fix_desc(struct lov_desc *desc);
297 void lov_fix_desc_stripe_size(__u64 *val);
298 void lov_fix_desc_stripe_count(__u32 *val);
299 void lov_fix_desc_pattern(__u32 *val);
300 void lov_fix_desc_qos_maxage(__u32 *val);
301 __u16 lov_get_stripe_count(struct lov_obd *lov, __u32 magic,
303 int lov_connect_obd(struct obd_device *obd, u32 index, int activate,
304 struct obd_connect_data *data);
305 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
306 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
307 u32 *indexp, int *genp);
308 int lov_del_target(struct obd_device *obd, u32 index,
309 struct obd_uuid *uuidp, int gen);
312 ssize_t lov_lsm_pack(const struct lov_stripe_md *lsm, void *buf,
314 struct lov_stripe_md *lov_unpackmd(struct lov_obd *lov, void *buf,
316 int lov_free_memmd(struct lov_stripe_md **lsmp);
318 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
319 void lov_dump_lmm_common(int level, void *lmmp);
322 void lsm_free_plain(struct lov_stripe_md *lsm);
323 void dump_lsm(unsigned int level, const struct lov_stripe_md *lsm);
326 int lov_tunables_init(struct obd_device *obd);
329 extern struct lu_device_type lov_device_type;
331 #define LOV_MDC_TGT_MAX 256
333 /* high level pool methods */
334 int lov_pool_new(struct obd_device *obd, char *poolname);
335 int lov_pool_del(struct obd_device *obd, char *poolname);
336 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
337 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
339 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
341 LASSERT(atomic_read(&lsm->lsm_refc) > 0);
342 atomic_inc(&lsm->lsm_refc);
346 static inline bool lov_oinfo_is_dummy(const struct lov_oinfo *loi)
348 if (unlikely(loi->loi_oi.oi.oi_id == 0 &&
349 loi->loi_oi.oi.oi_seq == 0 &&
350 loi->loi_ost_idx == 0 &&
351 loi->loi_ost_gen == 0))
357 static inline struct obd_device *lov2obd(const struct lov_obd *lov)
359 return container_of_safe(lov, struct obd_device, u.lov);
362 static inline void lov_lsm2layout(struct lov_stripe_md *lsm,
363 struct lov_stripe_md_entry *lsme,
364 struct ost_layout *ol)
366 ol->ol_stripe_size = lsme->lsme_stripe_size;
367 ol->ol_stripe_count = lsme->lsme_stripe_count;
368 if (lsm->lsm_magic == LOV_MAGIC_COMP_V1) {
369 ol->ol_comp_start = lsme->lsme_extent.e_start;
370 ol->ol_comp_end = lsme->lsme_extent.e_end;
371 ol->ol_comp_id = lsme->lsme_id;
373 ol->ol_comp_start = 0;
379 struct pool_desc *lov_pool_find(struct obd_device *obd, char *poolname);
380 void lov_pool_putref(struct pool_desc *pool);