Whamcloud - gitweb
440ee7d047652cf50c445e11315f077d57a1593e
[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, 2013, Intel Corporation.
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 #define pool_tgt_size(p) ((p)->pool_obds.op_size)
45 #define pool_tgt_count(p) ((p)->pool_obds.op_count)
46 #define pool_tgt_array(p) ((p)->pool_obds.op_array)
47 #define pool_tgt_rw_sem(p) ((p)->pool_obds.op_rw_sem)
48
49 struct pool_desc {
50         char                     pool_name[LOV_MAXPOOLNAME + 1];
51         struct ost_pool          pool_obds;
52         atomic_t                 pool_refcount;
53         cfs_hlist_node_t         pool_hash;     /* access by poolname */
54         struct list_head         pool_list;     /* serial access */
55         struct proc_dir_entry   *pool_proc_entry;
56         struct obd_device       *pool_lobd;     /* owner */
57 };
58
59 struct lov_lock_handles {
60         struct portals_handle   llh_handle;
61         cfs_atomic_t            llh_refcount;
62         int                     llh_stripe_count;
63         struct lustre_handle    llh_handles[0];
64 };
65
66 struct lov_request {
67         struct obd_info          rq_oi;
68         struct lov_request_set  *rq_rqset;
69
70         cfs_list_t               rq_link;
71
72         int                      rq_idx;        /* index in lov->tgts array */
73         int                      rq_stripe;     /* stripe number */
74         int                      rq_complete;
75         int                      rq_rc;
76         int                      rq_buflen;     /* length of sub_md */
77
78         obd_count                rq_oabufs;
79         obd_count                rq_pgaidx;
80 };
81
82 struct lov_request_set {
83         struct ldlm_enqueue_info        *set_ei;
84         struct obd_info                 *set_oi;
85         cfs_atomic_t                    set_refcount;
86         struct obd_export               *set_exp;
87         /* XXX: There is @set_exp already, however obd_statfs gets obd_device
88            only. */
89         struct obd_device               *set_obd;
90         int                             set_count;
91         cfs_atomic_t                    set_completes;
92         cfs_atomic_t                    set_success;
93         cfs_atomic_t                    set_finish_checked;
94         struct llog_cookie              *set_cookies;
95         int                             set_cookie_sent;
96         struct obd_trans_info           *set_oti;
97         obd_count                       set_oabufs;
98         struct brw_page                 *set_pga;
99         struct lov_lock_handles         *set_lockh;
100         cfs_list_t                      set_list;
101         wait_queue_head_t               set_waitq;
102         spinlock_t                      set_lock;
103 };
104
105 extern struct kmem_cache *lov_oinfo_slab;
106
107 void lov_finish_set(struct lov_request_set *set);
108
109 static inline void lov_get_reqset(struct lov_request_set *set)
110 {
111         LASSERT(set != NULL);
112         LASSERT(cfs_atomic_read(&set->set_refcount) > 0);
113         cfs_atomic_inc(&set->set_refcount);
114 }
115
116 static inline void lov_put_reqset(struct lov_request_set *set)
117 {
118         if (cfs_atomic_dec_and_test(&set->set_refcount))
119                 lov_finish_set(set);
120 }
121
122 static inline struct lov_lock_handles *
123 lov_handle2llh(const struct lustre_handle *handle)
124 {
125         LASSERT(handle != NULL);
126         return class_handle2object(handle->cookie, NULL);
127 }
128
129 static inline void lov_llh_put(struct lov_lock_handles *llh)
130 {
131         CDEBUG(D_INFO, "PUTting llh %p : new refcount %d\n", llh,
132                cfs_atomic_read(&llh->llh_refcount) - 1);
133         LASSERT(cfs_atomic_read(&llh->llh_refcount) > 0 &&
134                 cfs_atomic_read(&llh->llh_refcount) < 0x5a5a);
135         if (cfs_atomic_dec_and_test(&llh->llh_refcount)) {
136                 class_handle_unhash(&llh->llh_handle);
137                 /* The structure may be held by other threads because RCU.
138                  *   -jxiong */
139                 if (cfs_atomic_read(&llh->llh_refcount))
140                         return;
141
142                 OBD_FREE_RCU(llh, sizeof *llh +
143                              sizeof(*llh->llh_handles) * llh->llh_stripe_count,
144                              &llh->llh_handle);
145         }
146 }
147
148 #define lov_uuid2str(lv, index) \
149         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
150
151 /* lov_merge.c */
152 void lov_merge_attrs(struct obdo *tgt, struct obdo *src, obd_valid valid,
153                      struct lov_stripe_md *lsm, int stripeno, int *set);
154 int lov_merge_lvb(struct obd_export *exp, struct lov_stripe_md *lsm,
155                   struct ost_lvb *lvb, int kms_only);
156 int lov_adjust_kms(struct obd_export *exp, struct lov_stripe_md *lsm,
157                    obd_off size, int shrink);
158 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
159                       struct ost_lvb *lvb, __u64 *kms_place);
160
161 /* lov_offset.c */
162 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
163                          int stripeno);
164 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
165                       int stripeno, obd_off *obd_off);
166 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
167                            int stripeno);
168 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
169                           obd_off start, obd_off end,
170                           obd_off *obd_start, obd_off *obd_end);
171 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off);
172
173 /* lov_request.c */
174 void lov_set_add_req(struct lov_request *req, struct lov_request_set *set);
175 int lov_set_finished(struct lov_request_set *set, int idempotent);
176 void lov_update_set(struct lov_request_set *set,
177                     struct lov_request *req, int rc);
178 int lov_update_common_set(struct lov_request_set *set,
179                           struct lov_request *req, int rc);
180 int lov_check_and_wait_active(struct lov_obd *lov, int ost_idx);
181 int lov_prep_create_set(struct obd_export *exp, struct obd_info *oifo,
182                         struct lov_stripe_md **ea, struct obdo *src_oa,
183                         struct obd_trans_info *oti,
184                         struct lov_request_set **reqset);
185 int cb_create_update(void *cookie, int rc);
186 int lov_fini_create_set(struct lov_request_set *set, struct lov_stripe_md **ea);
187 int lov_prep_brw_set(struct obd_export *exp, struct obd_info *oinfo,
188                      obd_count oa_bufs, struct brw_page *pga,
189                      struct obd_trans_info *oti,
190                      struct lov_request_set **reqset);
191 int lov_fini_brw_set(struct lov_request_set *set);
192 int lov_prep_getattr_set(struct obd_export *exp, struct obd_info *oinfo,
193                          struct lov_request_set **reqset);
194 int lov_fini_getattr_set(struct lov_request_set *set);
195 int lov_prep_destroy_set(struct obd_export *exp, struct obd_info *oinfo,
196                          struct obdo *src_oa, struct lov_stripe_md *lsm,
197                          struct obd_trans_info *oti,
198                          struct lov_request_set **reqset);
199 int lov_update_destroy_set(struct lov_request_set *set,
200                            struct lov_request *req, int rc);
201 int lov_fini_destroy_set(struct lov_request_set *set);
202 int lov_prep_setattr_set(struct obd_export *exp, struct obd_info *oinfo,
203                          struct obd_trans_info *oti,
204                          struct lov_request_set **reqset);
205 int lov_update_setattr_set(struct lov_request_set *set,
206                            struct lov_request *req, int rc);
207 int lov_fini_setattr_set(struct lov_request_set *set);
208 int lov_prep_punch_set(struct obd_export *exp, struct obd_info *oinfo,
209                        struct obd_trans_info *oti,
210                        struct lov_request_set **reqset);
211 int lov_fini_punch_set(struct lov_request_set *set);
212 int lov_prep_sync_set(struct obd_export *exp, struct obd_info *obd_info,
213                       obd_off start, obd_off end,
214                       struct lov_request_set **reqset);
215 int lov_fini_sync_set(struct lov_request_set *set);
216 int lov_prep_enqueue_set(struct obd_export *exp, struct obd_info *oinfo,
217                          struct ldlm_enqueue_info *einfo,
218                          struct lov_request_set **reqset);
219 int lov_fini_enqueue_set(struct lov_request_set *set, __u32 mode, int rc,
220                          struct ptlrpc_request_set *rqset);
221 int lov_prep_match_set(struct obd_export *exp, struct obd_info *oinfo,
222                        struct lov_stripe_md *lsm,
223                        ldlm_policy_data_t *policy, __u32 mode,
224                        struct lustre_handle *lockh,
225                        struct lov_request_set **reqset);
226 int lov_fini_match_set(struct lov_request_set *set, __u32 mode, __u64 flags);
227 int lov_prep_cancel_set(struct obd_export *exp, struct obd_info *oinfo,
228                         struct lov_stripe_md *lsm,
229                         __u32 mode, struct lustre_handle *lockh,
230                         struct lov_request_set **reqset);
231 int lov_fini_cancel_set(struct lov_request_set *set);
232 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
233                         struct lov_request_set **reqset);
234 void lov_update_statfs(struct obd_statfs *osfs, struct obd_statfs *lov_sfs,
235                        int success);
236 int lov_fini_statfs(struct obd_device *obd, struct obd_statfs *osfs,
237                     int success);
238 int lov_fini_statfs_set(struct lov_request_set *set);
239 int lov_statfs_interpret(struct ptlrpc_request_set *rqset, void *data, int rc);
240
241 /* lov_obd.c */
242 void lov_stripe_lock(struct lov_stripe_md *md);
243 void lov_stripe_unlock(struct lov_stripe_md *md);
244 void lov_fix_desc(struct lov_desc *desc);
245 void lov_fix_desc_stripe_size(__u64 *val);
246 void lov_fix_desc_stripe_count(__u32 *val);
247 void lov_fix_desc_pattern(__u32 *val);
248 void lov_fix_desc_qos_maxage(__u32 *val);
249 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count);
250 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
251                     struct obd_connect_data *data);
252 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
253 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
254                             __u32 *indexp, int *genp);
255 int lov_del_target(struct obd_device *obd, __u32 index,
256                    struct obd_uuid *uuidp, int gen);
257
258 /* lov_pack.c */
259 int lov_packmd(struct obd_export *exp, struct lov_mds_md **lmm,
260                struct lov_stripe_md *lsm);
261 int lov_unpackmd(struct obd_export *exp, struct lov_stripe_md **lsmp,
262                  struct lov_mds_md *lmm, int lmm_bytes);
263 int lov_setstripe(struct obd_export *exp, int max_lmm_size,
264                   struct lov_stripe_md **lsmp, struct lov_user_md *lump);
265 int lov_setea(struct obd_export *exp, struct lov_stripe_md **lsmp,
266               struct lov_user_md *lump);
267 int lov_getstripe(struct obd_export *exp,
268                   struct lov_stripe_md *lsm, struct lov_user_md *lump);
269 int lov_alloc_memmd(struct lov_stripe_md **lsmp, __u16 stripe_count,
270                     int pattern, int magic);
271 int lov_free_memmd(struct lov_stripe_md **lsmp);
272
273 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
274 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
275 void lov_dump_lmm_common(int level, void *lmmp);
276 void lov_dump_lmm(int level, void *lmm);
277
278 /* lov_ea.c */
279 struct lov_stripe_md *lsm_alloc_plain(__u16 stripe_count, int *size);
280 void lsm_free_plain(struct lov_stripe_md *lsm);
281
282 int lovea_destroy_object(struct lov_obd *lov, struct lov_stripe_md *lsm,
283                          struct obdo *oa, void *data);
284 /* lproc_lov.c */
285 extern struct file_operations lov_proc_target_fops;
286 #ifdef LPROCFS
287 extern struct lprocfs_seq_vars lprocfs_lov_obd_vars[];
288 #endif
289
290 /* lov_cl.c */
291 extern struct lu_device_type lov_device_type;
292
293 /* pools */
294 extern cfs_hash_ops_t pool_hash_operations;
295 /* ost_pool methods */
296 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
297 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
298 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
299 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
300 int lov_ost_pool_free(struct ost_pool *op);
301
302 /* high level pool methods */
303 int lov_pool_new(struct obd_device *obd, char *poolname);
304 int lov_pool_del(struct obd_device *obd, char *poolname);
305 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
306 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
307 void lov_dump_pool(int level, struct pool_desc *pool);
308 struct pool_desc *lov_find_pool(struct lov_obd *lov, char *poolname);
309 int lov_check_index_in_pool(__u32 idx, struct pool_desc *pool);
310 void lov_pool_putref(struct pool_desc *pool);
311
312 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
313 {
314         LASSERT(cfs_atomic_read(&lsm->lsm_refc) > 0);
315         cfs_atomic_inc(&lsm->lsm_refc);
316         return lsm;
317 }
318
319 #endif