Whamcloud - gitweb
ed3057fc16b0c45772c7eb01ad2530d525b529f2
[fs/lustre-release.git] / lustre / osp / osp_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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, 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  * lustre/osp/osp_internal.h
37  *
38  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
39  */
40
41 #ifndef _OSP_INTERNAL_H
42 #define _OSP_INTERNAL_H
43
44 #include <obd.h>
45 #include <obd_class.h>
46 #include <dt_object.h>
47 #include <lustre_fid.h>
48
49 /*
50  * Infrastructure to support tracking of last committed llog record
51  */
52 struct osp_id_tracker {
53         spinlock_t               otr_lock;
54         __u32                    otr_next_id;
55         __u32                    otr_committed_id;
56         /* callback is register once per diskfs -- that's the whole point */
57         struct dt_txn_callback   otr_tx_cb;
58         /* single node can run many clusters */
59         cfs_list_t               otr_wakeup_list;
60         cfs_list_t               otr_list;
61         /* underlying shared device */
62         struct dt_device        *otr_dev;
63         /* how many users of this tracker */
64         cfs_atomic_t             otr_refcount;
65 };
66
67 struct osp_device {
68         struct dt_device                 opd_dt_dev;
69         /* corresponded OST index */
70         int                              opd_index;
71
72         /* corrsponded MDT index, which will be used when connecting to OST
73          * for validating the connection (see ofd_parse_connect_data) */
74         int                              opd_group;
75         /* device used to store persistent state (llogs, last ids) */
76         struct obd_export               *opd_storage_exp;
77         struct dt_device                *opd_storage;
78         struct dt_object                *opd_last_used_oid_file;
79         struct dt_object                *opd_last_used_seq_file;
80
81         /* stored persistently in LE format, updated directly to/from disk
82          * and required le64_to_cpu() conversion before use.
83          * Protected by opd_pre_lock */
84         struct lu_fid                   opd_last_used_fid;
85         struct lu_fid                   opd_gap_start_fid;
86         int                              opd_gap_count;
87         /* connection to OST */
88         struct obd_device               *opd_obd;
89         struct obd_export               *opd_exp;
90         struct obd_uuid                  opd_cluuid;
91         struct obd_connect_data         *opd_connect_data;
92         int                              opd_connects;
93         cfs_proc_dir_entry_t            *opd_proc_entry;
94         struct lprocfs_stats            *opd_stats;
95         /* connection status. */
96         int                              opd_new_connection;
97         int                              opd_got_disconnected;
98         int                              opd_imp_connected;
99         int                              opd_imp_active;
100         int                              opd_imp_seen_connected:1,
101                                          opd_connect_mdt:1;
102
103         /* whether local recovery is completed:
104          * reported via ->ldo_recovery_complete() */
105         int                              opd_recovery_completed;
106
107         /*
108          * Precreation pool
109          */
110         spinlock_t                       opd_pre_lock;
111
112         /* last fid to assign in creation */
113         struct lu_fid                    opd_pre_used_fid;
114         /* last created id OST reported, next-created - available id's */
115         struct lu_fid                    opd_pre_last_created_fid;
116         /* how many ids are reserved in declare, we shouldn't block in create */
117         __u64                            opd_pre_reserved;
118         /* dedicate precreate thread */
119         struct ptlrpc_thread             opd_pre_thread;
120         /* thread waits for signals about pool going empty */
121         cfs_waitq_t                      opd_pre_waitq;
122         /* consumers (who needs new ids) wait here */
123         cfs_waitq_t                      opd_pre_user_waitq;
124         /* current precreation status: working, failed, stopping? */
125         int                              opd_pre_status;
126         /* how many to precreate next time */
127         int                              opd_pre_grow_count;
128         int                              opd_pre_min_grow_count;
129         int                              opd_pre_max_grow_count;
130         /* whether to grow precreation window next time or not */
131         int                              opd_pre_grow_slow;
132         /* cleaning up orphans or recreating missing objects */
133         int                              opd_pre_recovering;
134
135         /*
136          * OST synchronization
137          */
138         spinlock_t                       opd_syn_lock;
139         /* unique generation, to recognize start of new records in the llog */
140         struct llog_gen                  opd_syn_generation;
141         /* number of changes to sync, used to wake up sync thread */
142         unsigned long                    opd_syn_changes;
143         /* processing of changes from previous mount is done? */
144         int                              opd_syn_prev_done;
145         /* found records */
146         struct ptlrpc_thread             opd_syn_thread;
147         cfs_waitq_t                      opd_syn_waitq;
148         /* list of remotely committed rpc */
149         cfs_list_t                       opd_syn_committed_there;
150         /* number of changes being under sync */
151         int                              opd_syn_sync_in_progress;
152         /* number of RPCs in flight - flow control */
153         int                              opd_syn_rpc_in_flight;
154         int                              opd_syn_max_rpc_in_flight;
155         /* number of RPC in processing (including non-committed by OST) */
156         int                              opd_syn_rpc_in_progress;
157         int                              opd_syn_max_rpc_in_progress;
158         /* osd api's commit cb control structure */
159         struct dt_txn_callback           opd_syn_txn_cb;
160         /* last used change number -- semantically similar to transno */
161         unsigned long                    opd_syn_last_used_id;
162         /* last committed change number -- semantically similar to
163          * last_committed */
164         unsigned long                    opd_syn_last_committed_id;
165         /* last processed (taken from llog) id */
166         unsigned long                    opd_syn_last_processed_id;
167         struct osp_id_tracker           *opd_syn_tracker;
168         cfs_list_t                       opd_syn_ontrack;
169
170         /*
171          * statfs related fields: OSP maintains it on its own
172          */
173         struct obd_statfs                opd_statfs;
174         cfs_time_t                       opd_statfs_fresh_till;
175         cfs_timer_t                      opd_statfs_timer;
176         int                              opd_statfs_update_in_progress;
177         /* how often to update statfs data */
178         int                              opd_statfs_maxage;
179
180         cfs_proc_dir_entry_t            *opd_symlink;
181 };
182
183 extern cfs_mem_cache_t *osp_object_kmem;
184
185 /* this is a top object */
186 struct osp_object {
187         struct lu_object_header opo_header;
188         struct dt_object        opo_obj;
189         int                     opo_reserved:1,
190                                 opo_new:1,
191                                 opo_empty:1;
192
193         /* read/write lock for md osp object */
194         struct rw_semaphore     opo_sem;
195         const struct lu_env     *opo_owner;
196 };
197
198 extern struct lu_object_operations osp_lu_obj_ops;
199 extern const struct dt_device_operations osp_dt_ops;
200 extern struct dt_object_operations osp_md_obj_ops;
201 extern struct dt_lock_operations osp_md_lock_ops;
202
203 struct osp_thread_info {
204         struct lu_buf            osi_lb;
205         struct lu_buf            osi_lb2;
206         struct lu_fid            osi_fid;
207         struct lu_attr           osi_attr;
208         struct ost_id            osi_oi;
209         struct ost_id            osi_oi2;
210         obd_id                   osi_id;
211         loff_t                   osi_off;
212         union {
213                 struct llog_rec_hdr             osi_hdr;
214                 struct llog_unlink64_rec        osi_unlink;
215                 struct llog_setattr64_rec       osi_setattr;
216                 struct llog_gen_rec             osi_gen;
217         };
218         struct llog_cookie       osi_cookie;
219         struct llog_catid        osi_cid;
220         struct lu_seq_range      osi_seq;
221         struct ldlm_res_id       osi_resid;
222         struct obdo              osi_obdo;
223 };
224
225 static inline void osp_objid_buf_prep(struct lu_buf *buf, loff_t *off,
226                                       __u32 *id, int index)
227 {
228         buf->lb_buf = (void *)id;
229         buf->lb_len = sizeof(obd_id);
230         *off = sizeof(obd_id) * index;
231 }
232
233 static inline void osp_objseq_buf_prep(struct lu_buf *buf, loff_t *off,
234                                        __u64 *seq, int index)
235 {
236         buf->lb_buf = (void *)seq;
237         buf->lb_len = sizeof(obd_id);
238         *off = sizeof(obd_id) * index;
239 }
240
241 static inline void osp_buf_prep(struct lu_buf *lb, void *buf, int buf_len)
242 {
243         lb->lb_buf = buf;
244         lb->lb_len = buf_len;
245 }
246
247 extern struct lu_context_key osp_thread_key;
248
249 static inline struct osp_thread_info *osp_env_info(const struct lu_env *env)
250 {
251         struct osp_thread_info *info;
252
253         info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
254         if (info == NULL) {
255                 lu_env_refill((struct lu_env *)env);
256                 info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
257         }
258         LASSERT(info);
259         return info;
260 }
261
262 struct osp_txn_info {
263         __u32   oti_current_id;
264 };
265
266 extern struct lu_context_key osp_txn_key;
267
268 static inline struct osp_txn_info *osp_txn_info(struct lu_context *ctx)
269 {
270         struct osp_txn_info *info;
271
272         info = lu_context_key_get(ctx, &osp_txn_key);
273         return info;
274 }
275
276 extern const struct lu_device_operations osp_lu_ops;
277
278 static inline int lu_device_is_osp(struct lu_device *d)
279 {
280         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osp_lu_ops);
281 }
282
283 static inline struct osp_device *lu2osp_dev(struct lu_device *d)
284 {
285         LASSERT(lu_device_is_osp(d));
286         return container_of0(d, struct osp_device, opd_dt_dev.dd_lu_dev);
287 }
288
289 static inline struct lu_device *osp2lu_dev(struct osp_device *d)
290 {
291         return &d->opd_dt_dev.dd_lu_dev;
292 }
293
294 static inline struct osp_device *dt2osp_dev(struct dt_device *d)
295 {
296         LASSERT(lu_device_is_osp(&d->dd_lu_dev));
297         return container_of0(d, struct osp_device, opd_dt_dev);
298 }
299
300 static inline struct osp_object *lu2osp_obj(struct lu_object *o)
301 {
302         LASSERT(ergo(o != NULL, lu_device_is_osp(o->lo_dev)));
303         return container_of0(o, struct osp_object, opo_obj.do_lu);
304 }
305
306 static inline struct lu_object *osp2lu_obj(struct osp_object *obj)
307 {
308         return &obj->opo_obj.do_lu;
309 }
310
311 static inline struct osp_object *osp_obj(const struct lu_object *o)
312 {
313         LASSERT(lu_device_is_osp(o->lo_dev));
314         return container_of0(o, struct osp_object, opo_obj.do_lu);
315 }
316
317 static inline struct osp_object *dt2osp_obj(const struct dt_object *d)
318 {
319         return osp_obj(&d->do_lu);
320 }
321
322 static inline struct dt_object *osp_object_child(struct osp_object *o)
323 {
324         return container_of0(lu_object_next(osp2lu_obj(o)),
325                              struct dt_object, do_lu);
326 }
327
328 #define osp_init_rpc_lock(lck) mdc_init_rpc_lock(lck)
329 #define osp_get_rpc_lock(lck, it)  mdc_get_rpc_lock(lck, it)
330 #define osp_put_rpc_lock(lck, it) mdc_put_rpc_lock(lck, it)
331
332 static inline void osp_update_last_fid(struct osp_device *d, struct lu_fid *fid)
333 {
334         int diff = lu_fid_diff(fid, &d->opd_last_used_fid);
335         /*
336          * we might have lost precreated objects due to VBR and precreate
337          * orphans, the gap in objid can be calculated properly only here
338          */
339         if (diff > 0) {
340                 if (diff > 1) {
341                         d->opd_gap_start_fid = d->opd_last_used_fid;
342                         d->opd_gap_start_fid.f_oid++;
343                         d->opd_gap_count = diff - 1;
344                         CDEBUG(D_HA, "Gap in objids: start="DFID", count =%d\n",
345                                PFID(&d->opd_gap_start_fid), d->opd_gap_count);
346                 }
347                 d->opd_last_used_fid = *fid;
348         }
349 }
350
351 static int osp_fid_end_seq(const struct lu_env *env, struct lu_fid *fid)
352 {
353         if (fid_is_idif(fid)) {
354                 struct osp_thread_info *info = osp_env_info(env);
355                 struct ost_id *oi = &info->osi_oi;
356
357                 fid_ostid_pack(fid, oi);
358                 return oi->oi_id == IDIF_MAX_OID;
359         } else {
360                 return fid_oid(fid) == LUSTRE_DATA_SEQ_MAX_WIDTH;
361         }
362 }
363
364 static inline int osp_precreate_end_seq_nolock(const struct lu_env *env,
365                                                struct osp_device *osp)
366 {
367         struct lu_fid *fid = &osp->opd_pre_last_created_fid;
368
369         return osp_fid_end_seq(env, fid);
370 }
371
372 static inline int osp_precreate_end_seq(const struct lu_env *env,
373                                         struct osp_device *osp)
374 {
375         int rc;
376
377         spin_lock(&osp->opd_pre_lock);
378         rc = osp_precreate_end_seq_nolock(env, osp);
379         spin_unlock(&osp->opd_pre_lock);
380         return rc;
381 }
382
383 static inline int osp_is_fid_client(struct osp_device *osp)
384 {
385         struct obd_import *imp = osp->opd_obd->u.cli.cl_import;
386
387         return imp->imp_connect_data.ocd_connect_flags & OBD_CONNECT_FID;
388 }
389
390 /* osp_dev.c */
391 void osp_update_last_id(struct osp_device *d, obd_id objid);
392 extern struct llog_operations osp_mds_ost_orig_logops;
393
394 /* osp_md_object.c */
395 int osp_trans_start(const struct lu_env *env, struct dt_device *dt,
396                     struct thandle *th);
397 int osp_trans_stop(const struct lu_env *env, struct thandle *th);
398 /* osp_precreate.c */
399 int osp_init_precreate(struct osp_device *d);
400 int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d);
401 __u64 osp_precreate_get_id(struct osp_device *d);
402 int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
403                           struct lu_fid *fid);
404 void osp_precreate_fini(struct osp_device *d);
405 int osp_object_truncate(const struct lu_env *env, struct dt_object *dt, __u64);
406 void osp_pre_update_status(struct osp_device *d, int rc);
407 void osp_statfs_need_now(struct osp_device *d);
408 int osp_reset_last_used(const struct lu_env *env, struct osp_device *osp);
409 int osp_write_last_oid_seq_files(struct lu_env *env, struct osp_device *osp,
410                                  struct lu_fid *fid, int sync);
411
412 /* lproc_osp.c */
413 void lprocfs_osp_init_vars(struct lprocfs_static_vars *lvars);
414 void osp_lprocfs_init(struct osp_device *osp);
415
416 /* osp_sync.c */
417 int osp_sync_declare_add(const struct lu_env *env, struct osp_object *o,
418                          llog_op_type type, struct thandle *th);
419 int osp_sync_add(const struct lu_env *env, struct osp_object *o,
420                  llog_op_type type, struct thandle *th,
421                  const struct lu_attr *attr);
422 int osp_sync_init(const struct lu_env *env, struct osp_device *d);
423 int osp_sync_fini(struct osp_device *d);
424 void __osp_sync_check_for_work(struct osp_device *d);
425
426 /* lwp_dev.c */
427 void lprocfs_lwp_init_vars(struct lprocfs_static_vars *lvars);
428 extern struct obd_ops lwp_obd_device_ops;
429 extern struct lu_device_type lwp_device_type;
430
431 #endif