Whamcloud - gitweb
LU-827 lov: Implement a per file data_version.
[fs/lustre-release.git] / lustre / lov / lov_internal.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 (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  *
32  * Copyright (c) 2011, 2012, Whamcloud, Inc.
33  */
34 /*
35  * This file is part of Lustre, http://www.lustre.org/
36  * Lustre is a trademark of Sun Microsystems, Inc.
37  */
38
39 #ifndef LOV_INTERNAL_H
40 #define LOV_INTERNAL_H
41
42 #include <obd_class.h>
43 #include <lustre/lustre_user.h>
44
45 struct lov_lock_handles {
46         struct portals_handle   llh_handle;
47         cfs_atomic_t            llh_refcount;
48         int                     llh_stripe_count;
49         struct lustre_handle    llh_handles[0];
50 };
51
52 struct lov_request {
53         struct obd_info          rq_oi;
54         struct lov_request_set  *rq_rqset;
55
56         cfs_list_t               rq_link;
57
58         int                      rq_idx;        /* index in lov->tgts array */
59         int                      rq_stripe;     /* stripe number */
60         int                      rq_complete;
61         int                      rq_rc;
62         int                      rq_buflen;     /* length of sub_md */
63
64         obd_count                rq_oabufs;
65         obd_count                rq_pgaidx;
66 };
67
68 struct lov_request_set {
69         struct ldlm_enqueue_info*set_ei;
70         struct obd_info         *set_oi;
71         cfs_atomic_t             set_refcount;
72         struct obd_export       *set_exp;
73         /* XXX: There is @set_exp already, however obd_statfs gets obd_device
74            only. */
75         struct obd_device       *set_obd;
76         int                      set_count;
77         cfs_atomic_t             set_completes;
78         cfs_atomic_t             set_success;
79         struct llog_cookie      *set_cookies;
80         int                      set_cookie_sent;
81         struct obd_trans_info   *set_oti;
82         obd_count                set_oabufs;
83         struct brw_page         *set_pga;
84         struct lov_lock_handles *set_lockh;
85         cfs_list_t               set_list;
86         cfs_waitq_t              set_waitq;
87         cfs_spinlock_t           set_lock;
88 };
89
90 extern cfs_mem_cache_t *lov_oinfo_slab;
91
92 static inline void lov_llh_addref(void *llhp)
93 {
94         struct lov_lock_handles *llh = llhp;
95         cfs_atomic_inc(&llh->llh_refcount);
96         CDEBUG(D_INFO, "GETting llh %p : new refcount %d\n", llh,
97                cfs_atomic_read(&llh->llh_refcount));
98 }
99
100 static inline struct lov_lock_handles *lov_llh_new(struct lov_stripe_md *lsm)
101 {
102         struct lov_lock_handles *llh;
103
104         OBD_ALLOC(llh, sizeof *llh +
105                   sizeof(*llh->llh_handles) * lsm->lsm_stripe_count);
106         if (llh == NULL)
107                 return NULL;
108         cfs_atomic_set(&llh->llh_refcount, 2);
109         llh->llh_stripe_count = lsm->lsm_stripe_count;
110         CFS_INIT_LIST_HEAD(&llh->llh_handle.h_link);
111         class_handle_hash(&llh->llh_handle, lov_llh_addref);
112         return llh;
113 }
114
115 void lov_finish_set(struct lov_request_set *set);
116
117 static inline void lov_get_reqset(struct lov_request_set *set)
118 {
119         LASSERT(set != NULL);
120         LASSERT(cfs_atomic_read(&set->set_refcount) > 0);
121         cfs_atomic_inc(&set->set_refcount);
122 }
123
124 static inline void lov_put_reqset(struct lov_request_set *set)
125 {
126         if (cfs_atomic_dec_and_test(&set->set_refcount))
127                 lov_finish_set(set);
128 }
129
130 static inline struct lov_lock_handles *
131 lov_handle2llh(struct lustre_handle *handle)
132 {
133         LASSERT(handle != NULL);
134         return(class_handle2object(handle->cookie));
135 }
136
137 static inline void lov_llh_put(struct lov_lock_handles *llh)
138 {
139         CDEBUG(D_INFO, "PUTting llh %p : new refcount %d\n", llh,
140                cfs_atomic_read(&llh->llh_refcount) - 1);
141         LASSERT(cfs_atomic_read(&llh->llh_refcount) > 0 &&
142                 cfs_atomic_read(&llh->llh_refcount) < 0x5a5a);
143         if (cfs_atomic_dec_and_test(&llh->llh_refcount)) {
144                 class_handle_unhash(&llh->llh_handle);
145                 /* The structure may be held by other threads because RCU.
146                  *   -jxiong */
147                 if (cfs_atomic_read(&llh->llh_refcount))
148                         return;
149
150                 OBD_FREE_RCU(llh, sizeof *llh +
151                              sizeof(*llh->llh_handles) * llh->llh_stripe_count,
152                              &llh->llh_handle);
153         }
154 }
155
156 #define lov_uuid2str(lv, index) \
157         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
158
159 /* lov_merge.c */
160 void lov_merge_attrs(struct obdo *tgt, struct obdo *src, obd_valid valid,
161                      struct lov_stripe_md *lsm, int stripeno, int *set);
162 int lov_merge_lvb(struct obd_export *exp, struct lov_stripe_md *lsm,
163                   struct ost_lvb *lvb, int kms_only);
164 int lov_adjust_kms(struct obd_export *exp, struct lov_stripe_md *lsm,
165                    obd_off size, int shrink);
166 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
167                       struct ost_lvb *lvb, __u64 *kms_place);
168
169 /* lov_offset.c */
170 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
171                          int stripeno);
172 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
173                       int stripeno, obd_off *obd_off);
174 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
175                            int stripeno);
176 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
177                           obd_off start, obd_off end,
178                           obd_off *obd_start, obd_off *obd_end);
179 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off);
180
181 /* lov_qos.c */
182 #define LOV_USES_ASSIGNED_STRIPE        0
183 #define LOV_USES_DEFAULT_STRIPE         1
184 int qos_add_tgt(struct obd_device *obd, __u32 index);
185 int qos_del_tgt(struct obd_device *obd, struct lov_tgt_desc *tgt);
186 void qos_shrink_lsm(struct lov_request_set *set);
187 int qos_prep_create(struct obd_export *exp, struct lov_request_set *set);
188 void qos_update(struct lov_obd *lov);
189 void qos_statfs_done(struct lov_obd *lov);
190 void qos_statfs_update(struct obd_device *obd, __u64 max_age, int wait);
191 int qos_remedy_create(struct lov_request_set *set, struct lov_request *req);
192
193 /* lov_request.c */
194 void lov_set_add_req(struct lov_request *req, struct lov_request_set *set);
195 int lov_finished_set(struct lov_request_set *set);
196 void lov_update_set(struct lov_request_set *set,
197                     struct lov_request *req, int rc);
198 int lov_update_common_set(struct lov_request_set *set,
199                           struct lov_request *req, int rc);
200 int lov_prep_create_set(struct obd_export *exp, struct obd_info *oifo,
201                         struct lov_stripe_md **ea, struct obdo *src_oa,
202                         struct obd_trans_info *oti,
203                         struct lov_request_set **reqset);
204 int cb_create_update(void *cookie, int rc);
205 int lov_fini_create_set(struct lov_request_set *set, struct lov_stripe_md **ea);
206 int lov_prep_brw_set(struct obd_export *exp, struct obd_info *oinfo,
207                      obd_count oa_bufs, struct brw_page *pga,
208                      struct obd_trans_info *oti,
209                      struct lov_request_set **reqset);
210 int lov_fini_brw_set(struct lov_request_set *set);
211 int lov_prep_getattr_set(struct obd_export *exp, struct obd_info *oinfo,
212                          struct lov_request_set **reqset);
213 int lov_fini_getattr_set(struct lov_request_set *set);
214 int lov_prep_destroy_set(struct obd_export *exp, struct obd_info *oinfo,
215                          struct obdo *src_oa, struct lov_stripe_md *lsm,
216                          struct obd_trans_info *oti,
217                          struct lov_request_set **reqset);
218 int lov_update_destroy_set(struct lov_request_set *set,
219                            struct lov_request *req, int rc);
220 int lov_fini_destroy_set(struct lov_request_set *set);
221 int lov_prep_setattr_set(struct obd_export *exp, struct obd_info *oinfo,
222                          struct obd_trans_info *oti,
223                          struct lov_request_set **reqset);
224 int lov_update_setattr_set(struct lov_request_set *set,
225                            struct lov_request *req, int rc);
226 int lov_fini_setattr_set(struct lov_request_set *set);
227 int lov_prep_punch_set(struct obd_export *exp, struct obd_info *oinfo,
228                        struct obd_trans_info *oti,
229                        struct lov_request_set **reqset);
230 int lov_fini_punch_set(struct lov_request_set *set);
231 int lov_prep_sync_set(struct obd_export *exp, struct obd_info *obd_info,
232                       obd_off start, obd_off end,
233                       struct lov_request_set **reqset);
234 int lov_fini_sync_set(struct lov_request_set *set);
235 int lov_prep_enqueue_set(struct obd_export *exp, struct obd_info *oinfo,
236                          struct ldlm_enqueue_info *einfo,
237                          struct lov_request_set **reqset);
238 int lov_fini_enqueue_set(struct lov_request_set *set, __u32 mode, int rc,
239                          struct ptlrpc_request_set *rqset);
240 int lov_prep_match_set(struct obd_export *exp, struct obd_info *oinfo,
241                        struct lov_stripe_md *lsm,
242                        ldlm_policy_data_t *policy, __u32 mode,
243                        struct lustre_handle *lockh,
244                        struct lov_request_set **reqset);
245 int lov_fini_match_set(struct lov_request_set *set, __u32 mode, int flags);
246 int lov_prep_cancel_set(struct obd_export *exp, struct obd_info *oinfo,
247                         struct lov_stripe_md *lsm,
248                         __u32 mode, struct lustre_handle *lockh,
249                         struct lov_request_set **reqset);
250 int lov_fini_cancel_set(struct lov_request_set *set);
251 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
252                         struct lov_request_set **reqset);
253 void lov_update_statfs(struct obd_statfs *osfs, struct obd_statfs *lov_sfs,
254                        int success);
255 int lov_fini_statfs(struct obd_device *obd, struct obd_statfs *osfs,
256                     int success);
257 int lov_fini_statfs_set(struct lov_request_set *set);
258 int lov_statfs_interpret(struct ptlrpc_request_set *rqset, void *data, int rc);
259
260 /* lov_obd.c */
261 void lov_fix_desc(struct lov_desc *desc);
262 void lov_fix_desc_stripe_size(__u64 *val);
263 void lov_fix_desc_stripe_count(__u32 *val);
264 void lov_fix_desc_pattern(__u32 *val);
265 void lov_fix_desc_qos_maxage(__u32 *val);
266 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count);
267 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
268                     struct obd_connect_data *data);
269 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
270 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
271                             __u32 *indexp, int *genp);
272 int lov_del_target(struct obd_device *obd, __u32 index,
273                    struct obd_uuid *uuidp, int gen);
274 /* lov_log.c */
275 int lov_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
276                   struct obd_device *tgt, int *idx);
277 int lov_llog_finish(struct obd_device *obd, int count);
278
279 /* lov_pack.c */
280 int lov_packmd(struct obd_export *exp, struct lov_mds_md **lmm,
281                struct lov_stripe_md *lsm);
282 int lov_unpackmd(struct obd_export *exp, struct lov_stripe_md **lsmp,
283                  struct lov_mds_md *lmm, int lmm_bytes);
284 int lov_setstripe(struct obd_export *exp, int max_lmm_size,
285                   struct lov_stripe_md **lsmp, struct lov_user_md *lump);
286 int lov_setea(struct obd_export *exp, struct lov_stripe_md **lsmp,
287               struct lov_user_md *lump);
288 int lov_getstripe(struct obd_export *exp,
289                   struct lov_stripe_md *lsm, struct lov_user_md *lump);
290 int lov_alloc_memmd(struct lov_stripe_md **lsmp, __u16 stripe_count,
291                     int pattern, int magic);
292 void lov_free_memmd(struct lov_stripe_md **lsmp);
293
294 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
295 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
296 void lov_dump_lmm(int level, void *lmm);
297
298 /* lov_ea.c */
299 struct lov_stripe_md *lsm_alloc_plain(__u16 stripe_count, int *size);
300 void lsm_free_plain(struct lov_stripe_md *lsm);
301
302 int lovea_destroy_object(struct lov_obd *lov, struct lov_stripe_md *lsm,
303                          struct obdo *oa, void *data);
304 /* lproc_lov.c */
305 extern struct file_operations lov_proc_target_fops;
306 #ifdef LPROCFS
307 void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars);
308 #else
309 static inline void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars)
310 {
311         memset(lvars, 0, sizeof(*lvars));
312 }
313 #endif
314
315 /* lov_cl.c */
316 extern struct lu_device_type lov_device_type;
317
318 /* pools */
319 extern cfs_hash_ops_t pool_hash_operations;
320 /* ost_pool methods */
321 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
322 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
323 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
324 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
325 int lov_ost_pool_free(struct ost_pool *op);
326
327 /* high level pool methods */
328 int lov_pool_new(struct obd_device *obd, char *poolname);
329 int lov_pool_del(struct obd_device *obd, char *poolname);
330 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
331 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
332 void lov_dump_pool(int level, struct pool_desc *pool);
333 struct pool_desc *lov_find_pool(struct lov_obd *lov, char *poolname);
334 int lov_check_index_in_pool(__u32 idx, struct pool_desc *pool);
335 void lov_pool_putref(struct pool_desc *pool);
336
337 #if BITS_PER_LONG == 64
338 # define ll_do_div64(n,base) ({                                 \
339         uint64_t __base = (base);                               \
340         uint64_t __rem;                                         \
341         __rem = ((uint64_t)(n)) % __base;                       \
342         (n) = ((uint64_t)(n)) / __base;                         \
343         __rem;                                                  \
344   })
345 #elif BITS_PER_LONG == 32
346 # define ll_do_div64(n,base) ({                                 \
347         uint64_t __rem;                                         \
348         if ((sizeof(base) > 4) && (((base)&0xffffffff00000000ULL) != 0)) { \
349                 int __remainder;                                \
350                 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), "64 bit lov "\
351                           "division %llu / %llu\n", (n), (base)); \
352                 __remainder = (n) & (LOV_MIN_STRIPE_SIZE - 1);  \
353                 (n) >>= LOV_MIN_STRIPE_BITS;                    \
354                 (base) >>= LOV_MIN_STRIPE_BITS;                 \
355                 __rem = do_div(n, base);                        \
356                 __rem <<= LOV_MIN_STRIPE_BITS;                  \
357                 __rem += __remainder;                           \
358         } else {                                                \
359                 __rem = do_div(n, base);                        \
360         }                                                       \
361         __rem;                                                  \
362   })
363 #else
364 #error Unsupported architecture.
365 #endif
366
367 #endif