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