Whamcloud - gitweb
LU-2675 lustre: remove lustre/include/linux/
[fs/lustre-release.git] / lustre / lod / lod_internal.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License version 2 for more details.  A copy is
14  * included in the COPYING file that accompanied this code.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright  2009 Sun Microsystems, Inc. All rights reserved
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2014, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/lod/lod_internal.h
33  *
34  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
35  * Author: Mikhail Pershin <mike.pershin@intel.com>
36  */
37
38 #ifndef _LOD_INTERNAL_H
39 #define _LOD_INTERNAL_H
40
41 #include <libcfs/libcfs.h>
42 #include <obd.h>
43 #include <dt_object.h>
44
45 #define LOV_USES_ASSIGNED_STRIPE        0
46 #define LOV_USES_DEFAULT_STRIPE         1
47
48 /* Special values to remove LOV EA from disk */
49 #define LOVEA_DELETE_VALUES(size, count, offset, pool)                  \
50         ((size) == 0 && (count) == 0 &&                                 \
51          (offset) == (typeof(offset))(-1) && (pool) == NULL)
52
53 #define LMVEA_DELETE_VALUES(count, offset)                              \
54         ((count) == 0 && (offset) == (typeof(offset))(-1))
55
56 #define LOV_OFFSET_DEFAULT              ((__u16)-1)
57
58 struct lod_qos_rr {
59         __u32                    lqr_start_idx; /* start index of new inode */
60         __u32                    lqr_offset_idx; /* aliasing for start_idx */
61         int                      lqr_start_count; /* reseed counter */
62         struct ost_pool          lqr_pool;      /* round-robin optimized list */
63         unsigned long            lqr_dirty:1;   /* recalc round-robin list */
64 };
65
66 struct pool_desc {
67         char                     pool_name[LOV_MAXPOOLNAME + 1];
68         struct ost_pool          pool_obds;     /* pool members */
69         atomic_t                 pool_refcount;
70         struct lod_qos_rr        pool_rr;
71         struct hlist_node        pool_hash;     /* access by poolname */
72         struct list_head         pool_list;
73         struct proc_dir_entry   *pool_proc_entry;
74         struct obd_device       *pool_lobd;     /* owner */
75 };
76
77 #define pool_tgt_size(p) ((p)->pool_obds.op_size)
78 #define pool_tgt_count(p) ((p)->pool_obds.op_count)
79 #define pool_tgt_array(p)  ((p)->pool_obds.op_array)
80 #define pool_tgt_rw_sem(p) ((p)->pool_obds.op_rw_sem)
81
82 struct lod_qos {
83         struct list_head         lq_oss_list;
84         struct rw_semaphore      lq_rw_sem;
85         __u32                    lq_active_oss_count;
86         unsigned int             lq_prio_free;   /* priority for free space */
87         unsigned int             lq_threshold_rr;/* priority for rr */
88         struct lod_qos_rr        lq_rr;          /* round robin qos data */
89         bool                     lq_dirty:1,     /* recalc qos data */
90                                  lq_same_space:1,/* the ost's all have approx.
91                                                     the same space avail */
92                                  lq_reset:1;     /* zero current penalties */
93 };
94
95 struct lod_qos_oss {
96         struct obd_uuid          lqo_uuid;      /* ptlrpc's c_remote_uuid */
97         struct list_head         lqo_oss_list;  /* link to lov_qos */
98         __u64                    lqo_bavail;    /* total bytes avail on OSS */
99         __u64                    lqo_penalty;   /* current penalty */
100         __u64                    lqo_penalty_per_obj; /* penalty decrease
101                                                          every obj*/
102         time_t                   lqo_used;      /* last used time, seconds */
103         __u32                    lqo_ost_count; /* number of osts on this oss */
104 };
105
106 struct ltd_qos {
107         struct lod_qos_oss      *ltq_oss;       /* oss info */
108         __u64                    ltq_penalty;   /* current penalty */
109         __u64                    ltq_penalty_per_obj; /* penalty decrease
110                                                          every obj*/
111         __u64                    ltq_weight;    /* net weighting */
112         time_t                   ltq_used;      /* last used time, seconds */
113         bool                     ltq_usable:1;  /* usable for striping */
114 };
115
116 struct lod_tgt_desc {
117         struct dt_device  *ltd_tgt;
118         struct list_head   ltd_kill;
119         struct obd_export *ltd_exp;
120         struct obd_uuid    ltd_uuid;
121         __u32              ltd_gen;
122         __u32              ltd_index;
123         struct ltd_qos     ltd_qos; /* qos info per target */
124         struct obd_statfs  ltd_statfs;
125         unsigned long      ltd_active:1,/* is this target up for requests */
126                            ltd_activate:1,/* should  target be activated */
127                            ltd_reap:1;  /* should this target be deleted */
128 };
129
130 #define TGT_PTRS                256     /* number of pointers at 1st level */
131 #define TGT_PTRS_PER_BLOCK      256     /* number of pointers at 2nd level */
132
133 struct lod_tgt_desc_idx {
134         struct lod_tgt_desc *ldi_tgt[TGT_PTRS_PER_BLOCK];
135 };
136
137 #define LTD_TGT(ltd, index)      \
138          ((ltd)->ltd_tgt_idx[(index) / \
139          TGT_PTRS_PER_BLOCK]->ldi_tgt[(index) % TGT_PTRS_PER_BLOCK])
140
141 #define OST_TGT(lod, index)   LTD_TGT(&lod->lod_ost_descs, index)
142 #define MDT_TGT(lod, index)   LTD_TGT(&lod->lod_mdt_descs, index)
143 struct lod_tgt_descs {
144         /* list of known TGTs */
145         struct lod_tgt_desc_idx *ltd_tgt_idx[TGT_PTRS];
146         /* Size of the lod_tgts array, granted to be a power of 2 */
147         __u32                   ltd_tgts_size;
148         /* number of registered TGTs */
149         __u32                   ltd_tgtnr;
150         /* bitmap of TGTs available */
151         cfs_bitmap_t            *ltd_tgt_bitmap;
152         /* TGTs scheduled to be deleted */
153         __u32                   ltd_death_row;
154         /* Table refcount used for delayed deletion */
155         int                     ltd_refcount;
156         /* mutex to serialize concurrent updates to the tgt table */
157         struct mutex            ltd_mutex;
158         /* read/write semaphore used for array relocation */
159         struct rw_semaphore     ltd_rw_sem;
160 };
161
162 struct lod_device {
163         struct dt_device      lod_dt_dev;
164         struct obd_export    *lod_child_exp;
165         struct dt_device     *lod_child;
166         struct proc_dir_entry *lod_proc_entry;
167         struct lprocfs_stats *lod_stats;
168         spinlock_t            lod_connects_lock;
169         int                   lod_connects;
170         unsigned int          lod_recovery_completed:1,
171                               lod_initialized:1,
172                               lod_lmv_failout:1;
173
174         /* lov settings descriptor storing static information */
175         struct lov_desc       lod_desc;
176
177         /* use to protect ld_active_tgt_count and all ltd_active */
178         spinlock_t           lod_desc_lock;
179
180         /* Description of OST */
181         struct lod_tgt_descs  lod_ost_descs;
182         /* Description of MDT */
183         struct lod_tgt_descs  lod_mdt_descs;
184
185         /* maximum EA size underlied OSD may have */
186         unsigned int          lod_osd_max_easize;
187
188         /*FIXME: When QOS and pool is implemented for MDT, probably these
189          * structure should be moved to lod_tgt_descs as well.
190          */
191         /* QoS info per LOD */
192         struct lod_qos        lod_qos; /* qos info per lod */
193
194         /* OST pool data */
195         struct ost_pool         lod_pool_info; /* all OSTs in a packed array */
196         int                     lod_pool_count;
197         cfs_hash_t             *lod_pools_hash_body; /* used for key access */
198         struct list_head        lod_pool_list; /* used for sequential access */
199         struct proc_dir_entry  *lod_pool_proc_entry;
200
201         enum lustre_sec_part   lod_sp_me;
202
203         struct proc_dir_entry *lod_symlink;
204 };
205
206 #define lod_osts        lod_ost_descs.ltd_tgts
207 #define lod_ost_bitmap  lod_ost_descs.ltd_tgt_bitmap
208 #define lod_ostnr       lod_ost_descs.ltd_tgtnr
209 #define lod_osts_size   lod_ost_descs.ltd_tgts_size
210 #define ltd_ost         ltd_tgt
211 #define lod_ost_desc    lod_tgt_desc
212
213 #define lod_mdts                lod_mdt_descs.ltd_tgts
214 #define lod_mdt_bitmap          lod_mdt_descs.ltd_tgt_bitmap
215 #define lod_remote_mdt_count    lod_mdt_descs.ltd_tgtnr
216 #define lod_mdts_size           lod_mdt_descs.ltd_tgts_size
217 #define ltd_mdt                 ltd_tgt
218 #define lod_mdt_desc            lod_tgt_desc
219
220 struct lod_dir_stripe_info {
221         __u32   ldsi_stripe_offset;
222         __u32   ldsi_def_stripenr;
223         __u32   ldsi_def_stripe_offset;
224         __u32   ldsi_def_hash_type;
225         __u32   ldsi_hash_type;
226
227         unsigned int ldsi_striping_cached:1,
228                      ldsi_def_striping_set:1,
229                      ldsi_striped:1;
230 };
231
232 /*
233  * XXX: shrink this structure, currently it's 72bytes on 32bit arch,
234  *      so, slab will be allocating 128bytes
235  */
236 struct lod_object {
237         struct dt_object   ldo_obj;
238
239         /* if object is striped, then the next fields describe stripes */
240         /* For striped directory, ldo_stripenr == slave stripe count */
241         __u16              ldo_stripenr;
242         __u16              ldo_layout_gen;
243         __u32              ldo_stripe_size;
244         __u32              ldo_pattern;
245         __u16              ldo_released_stripenr;
246         char              *ldo_pool;
247         struct dt_object **ldo_stripe;
248         /* to know how much memory to free, ldo_stripenr can be less */
249         /* default striping for directory represented by this object
250          * is cached in stripenr/stripe_size */
251         unsigned int       ldo_stripes_allocated:16,
252                            ldo_striping_cached:1,
253                            ldo_def_striping_set:1,
254         /* ldo_dir_slave_stripe indicate this is a slave stripe of
255          * a striped dir */
256                            ldo_dir_slave_stripe:1;
257         __u32              ldo_def_stripe_size;
258         __u16              ldo_def_stripenr;
259         __u16              ldo_def_stripe_offset;
260         struct lod_dir_stripe_info      *ldo_dir_stripe;
261 };
262
263 #define ldo_dir_stripe_offset   ldo_dir_stripe->ldsi_stripe_offset
264 #define ldo_dir_def_stripenr    ldo_dir_stripe->ldsi_def_stripenr
265 #define ldo_dir_hash_type       ldo_dir_stripe->ldsi_hash_type
266 #define ldo_dir_def_hash_type   ldo_dir_stripe->ldsi_def_hash_type
267 #define ldo_dir_striping_cached ldo_dir_stripe->ldsi_striping_cached
268 #define ldo_dir_striped         ldo_dir_stripe->ldsi_striped
269 #define ldo_dir_def_striping_set        ldo_dir_stripe->ldsi_def_striping_set
270 #define ldo_dir_def_stripe_offset       ldo_dir_stripe->ldsi_def_stripe_offset
271
272 struct lod_it {
273         struct dt_object        *lit_obj; /* object from the layer below */
274         /* stripe offset of iteration */
275         __u32                   lit_stripe_index;
276         __u32                   lit_attr;
277         struct dt_it            *lit_it;  /* iterator from the layer below */
278 };
279
280 struct lod_thread_info {
281         /* per-thread buffer for LOV EA */
282         void             *lti_ea_store;
283         __u32             lti_ea_store_size;
284         /* per-thread buffer for LMV EA */
285         struct lu_buf     lti_buf;
286         struct ost_id     lti_ostid;
287         struct lu_fid     lti_fid;
288         struct obd_statfs lti_osfs;
289         struct lu_attr    lti_attr;
290         struct lod_it     lti_it;
291         struct ldlm_res_id lti_res_id;
292         /* used to hold lu_dirent, sizeof(struct lu_dirent) + NAME_MAX */
293         char              lti_key[sizeof(struct lu_dirent) + NAME_MAX];
294         struct dt_object_format lti_format;
295         struct lu_name    lti_name;
296         struct lu_buf     lti_linkea_buf;
297         struct dt_insert_rec lti_dt_rec;
298 };
299
300 extern const struct lu_device_operations lod_lu_ops;
301
302 static inline int lu_device_is_lod(struct lu_device *d)
303 {
304         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &lod_lu_ops);
305 }
306
307 static inline struct lod_device* lu2lod_dev(struct lu_device *d)
308 {
309         LASSERT(lu_device_is_lod(d));
310         return container_of0(d, struct lod_device, lod_dt_dev.dd_lu_dev);
311 }
312
313 static inline struct lu_device *lod2lu_dev(struct lod_device *d)
314 {
315         return &d->lod_dt_dev.dd_lu_dev;
316 }
317
318 static inline struct obd_device *lod2obd(struct lod_device *d)
319 {
320         return d->lod_dt_dev.dd_lu_dev.ld_obd;
321 }
322
323 static inline struct lod_device *dt2lod_dev(struct dt_device *d)
324 {
325         LASSERT(lu_device_is_lod(&d->dd_lu_dev));
326         return container_of0(d, struct lod_device, lod_dt_dev);
327 }
328
329 static inline struct lod_object *lu2lod_obj(struct lu_object *o)
330 {
331         LASSERT(ergo(o != NULL, lu_device_is_lod(o->lo_dev)));
332         return container_of0(o, struct lod_object, ldo_obj.do_lu);
333 }
334
335 static inline struct lu_object *lod2lu_obj(struct lod_object *obj)
336 {
337         return &obj->ldo_obj.do_lu;
338 }
339
340 static inline struct lod_object *lod_obj(const struct lu_object *o)
341 {
342         LASSERT(lu_device_is_lod(o->lo_dev));
343         return container_of0(o, struct lod_object, ldo_obj.do_lu);
344 }
345
346 static inline struct lod_object *lod_dt_obj(const struct dt_object *d)
347 {
348         return lod_obj(&d->do_lu);
349 }
350
351 static inline struct dt_object* lod_object_child(struct lod_object *o)
352 {
353         return container_of0(lu_object_next(lod2lu_obj(o)),
354                         struct dt_object, do_lu);
355 }
356
357 static inline struct dt_object *dt_object_child(struct dt_object *o)
358 {
359         return container_of0(lu_object_next(&(o)->do_lu),
360                         struct dt_object, do_lu);
361 }
362
363 extern struct lu_context_key lod_thread_key;
364
365 static inline struct lod_thread_info *lod_env_info(const struct lu_env *env)
366 {
367         struct lod_thread_info *info;
368         info = lu_context_key_get(&env->le_ctx, &lod_thread_key);
369         LASSERT(info);
370         return info;
371 }
372
373 static inline struct lu_name *
374 lod_name_get(const struct lu_env *env, const void *area, int len)
375 {
376         struct lu_name *lname;
377
378         lname = &lod_env_info(env)->lti_name;
379         lname->ln_name = area;
380         lname->ln_namelen = len;
381         return lname;
382 }
383
384 #define lod_foreach_ost(__dev, index)   \
385         if ((__dev)->lod_osts_size > 0) \
386                 cfs_foreach_bit((__dev)->lod_ost_bitmap, (index))
387
388 /* lod_dev.c */
389 int lod_fld_lookup(const struct lu_env *env, struct lod_device *lod,
390                    const struct lu_fid *fid, __u32 *tgt, int *flags);
391 /* lod_lov.c */
392 void lod_getref(struct lod_tgt_descs *ltd);
393 void lod_putref(struct lod_device *lod, struct lod_tgt_descs *ltd);
394 int lod_add_device(const struct lu_env *env, struct lod_device *lod,
395                    char *osp, unsigned index, unsigned gen, int mdt_index,
396                    char *type, int active);
397 int lod_del_device(const struct lu_env *env, struct lod_device *lod,
398                    struct lod_tgt_descs *ltd, char *osp, unsigned idx,
399                    unsigned gen, bool for_ost);
400 int lod_fini_tgt(const struct lu_env *env, struct lod_device *lod,
401                  struct lod_tgt_descs *ltd, bool for_ost);
402 int lod_load_striping_locked(const struct lu_env *env, struct lod_object *lo);
403 int lod_load_striping(const struct lu_env *env, struct lod_object *lo);
404
405 int lod_get_ea(const struct lu_env *env, struct lod_object *lo,
406                const char *name);
407 static inline int
408 lod_get_lov_ea(const struct lu_env *env, struct lod_object *lo)
409 {
410         return lod_get_ea(env, lo, XATTR_NAME_LOV);
411 }
412
413 static inline int
414 lod_get_lmv_ea(const struct lu_env *env, struct lod_object *lo)
415 {
416         return lod_get_ea(env, lo, XATTR_NAME_LMV);
417 }
418
419 static inline int
420 lod_get_default_lmv_ea(const struct lu_env *env, struct lod_object *lo)
421 {
422         return lod_get_ea(env, lo, XATTR_NAME_DEFAULT_LMV);
423 }
424
425 void lod_fix_desc(struct lov_desc *desc);
426 void lod_fix_desc_qos_maxage(__u32 *val);
427 void lod_fix_desc_pattern(__u32 *val);
428 void lod_fix_desc_stripe_count(__u32 *val);
429 void lod_fix_desc_stripe_size(__u64 *val);
430 int lod_pools_init(struct lod_device *m, struct lustre_cfg *cfg);
431 int lod_pools_fini(struct lod_device *m);
432 int lod_parse_striping(const struct lu_env *env, struct lod_object *mo,
433                        const struct lu_buf *buf);
434 int lod_parse_dir_striping(const struct lu_env *env, struct lod_object *lo,
435                            const struct lu_buf *buf);
436 int lod_initialize_objects(const struct lu_env *env, struct lod_object *mo,
437                            struct lov_ost_data_v1 *objs);
438 int lod_verify_striping(struct lod_device *d, const struct lu_buf *buf,
439                         bool is_from_disk);
440 int lod_generate_and_set_lovea(const struct lu_env *env,
441                                struct lod_object *mo, struct thandle *th);
442 int lod_ea_store_resize(struct lod_thread_info *info, size_t size);
443 /* lod_pool.c */
444 int lod_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
445 int lod_ost_pool_remove(struct ost_pool *op, __u32 idx);
446 int lod_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
447 struct pool_desc *lod_find_pool(struct lod_device *lod, char *poolname);
448 void lod_pool_putref(struct pool_desc *pool);
449 int lod_ost_pool_free(struct ost_pool *op);
450 int lod_pool_del(struct obd_device *obd, char *poolname);
451 int lod_ost_pool_init(struct ost_pool *op, unsigned int count);
452 extern cfs_hash_ops_t pool_hash_operations;
453 int lod_check_index_in_pool(__u32 idx, struct pool_desc *pool);
454 int lod_pool_new(struct obd_device *obd, char *poolname);
455 int lod_pool_add(struct obd_device *obd, char *poolname, char *ostname);
456 int lod_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
457
458 /* lod_qos.c */
459 int lod_qos_prep_create(const struct lu_env *env, struct lod_object *lo,
460                         struct lu_attr *attr, const struct lu_buf *buf,
461                         struct thandle *th);
462 int qos_add_tgt(struct lod_device*, struct lod_tgt_desc *);
463 int qos_del_tgt(struct lod_device *, struct lod_tgt_desc *);
464
465 /* lproc_lod.c */
466 int lod_procfs_init(struct lod_device *lod);
467 void lod_procfs_fini(struct lod_device *lod);
468
469 /* lod_object.c */
470 int lod_load_lmv_shards(const struct lu_env *env, struct lod_object *lo,
471                         struct lu_buf *buf, bool resize);
472 int lod_object_set_pool(struct lod_object *o, char *pool);
473 int lod_declare_striped_object(const struct lu_env *env, struct dt_object *dt,
474                                struct lu_attr *attr,
475                                const struct lu_buf *lovea, struct thandle *th);
476 int lod_striping_create(const struct lu_env *env, struct dt_object *dt,
477                         struct lu_attr *attr, struct dt_object_format *dof,
478                         struct thandle *th);
479 void lod_object_free_striping(const struct lu_env *env, struct lod_object *lo);
480
481 #endif
482