4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/osp/osp_internal.h
38 * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
41 #ifndef _OSP_INTERNAL_H
42 #define _OSP_INTERNAL_H
45 #include <obd_class.h>
46 #include <dt_object.h>
47 #include <md_object.h>
48 #include <lustre_fid.h>
51 * Infrastructure to support tracking of last committed llog record
53 struct osp_id_tracker {
56 __u32 otr_committed_id;
57 /* callback is register once per diskfs -- that's the whole point */
58 struct dt_txn_callback otr_tx_cb;
59 /* single node can run many clusters */
60 cfs_list_t otr_wakeup_list;
62 /* underlying shared device */
63 struct dt_device *otr_dev;
64 /* how many users of this tracker */
65 cfs_atomic_t otr_refcount;
69 struct dt_device opd_dt_dev;
70 /* corresponded OST index */
73 /* corrsponded MDT index, which will be used when connecting to OST
74 * for validating the connection (see ofd_parse_connect_data) */
76 /* device used to store persistent state (llogs, last ids) */
77 struct obd_export *opd_storage_exp;
78 struct dt_device *opd_storage;
79 struct dt_object *opd_last_used_oid_file;
80 struct dt_object *opd_last_used_seq_file;
82 /* stored persistently in LE format, updated directly to/from disk
83 * and required le64_to_cpu() conversion before use.
84 * Protected by opd_pre_lock */
85 struct lu_fid opd_last_used_fid;
86 struct lu_fid opd_gap_start_fid;
88 /* connection to OST */
89 struct obd_device *opd_obd;
90 struct obd_export *opd_exp;
91 struct obd_uuid opd_cluuid;
92 struct obd_connect_data *opd_connect_data;
94 cfs_proc_dir_entry_t *opd_proc_entry;
95 struct lprocfs_stats *opd_stats;
96 /* connection status. */
97 int opd_new_connection;
98 int opd_got_disconnected;
99 int opd_imp_connected;
101 unsigned int opd_imp_seen_connected:1,
104 /* whether local recovery is completed:
105 * reported via ->ldo_recovery_complete() */
106 int opd_recovery_completed;
111 spinlock_t opd_pre_lock;
113 /* last fid to assign in creation */
114 struct lu_fid opd_pre_used_fid;
115 /* last created id OST reported, next-created - available id's */
116 struct lu_fid opd_pre_last_created_fid;
117 /* how many ids are reserved in declare, we shouldn't block in create */
118 __u64 opd_pre_reserved;
119 /* dedicate precreate thread */
120 struct ptlrpc_thread opd_pre_thread;
121 /* thread waits for signals about pool going empty */
122 cfs_waitq_t opd_pre_waitq;
123 /* consumers (who needs new ids) wait here */
124 cfs_waitq_t opd_pre_user_waitq;
125 /* current precreation status: working, failed, stopping? */
127 /* how many to precreate next time */
128 int opd_pre_grow_count;
129 int opd_pre_min_grow_count;
130 int opd_pre_max_grow_count;
131 /* whether to grow precreation window next time or not */
132 int opd_pre_grow_slow;
133 /* cleaning up orphans or recreating missing objects */
134 int opd_pre_recovering;
137 * OST synchronization
139 spinlock_t opd_syn_lock;
140 /* unique generation, to recognize start of new records in the llog */
141 struct llog_gen opd_syn_generation;
142 /* number of changes to sync, used to wake up sync thread */
143 unsigned long opd_syn_changes;
144 /* processing of changes from previous mount is done? */
145 int opd_syn_prev_done;
147 struct ptlrpc_thread opd_syn_thread;
148 cfs_waitq_t opd_syn_waitq;
149 /* list of remotely committed rpc */
150 cfs_list_t opd_syn_committed_there;
151 /* number of changes being under sync */
152 int opd_syn_sync_in_progress;
153 /* number of RPCs in flight - flow control */
154 int opd_syn_rpc_in_flight;
155 int opd_syn_max_rpc_in_flight;
156 /* number of RPC in processing (including non-committed by OST) */
157 int opd_syn_rpc_in_progress;
158 int opd_syn_max_rpc_in_progress;
159 /* osd api's commit cb control structure */
160 struct dt_txn_callback opd_syn_txn_cb;
161 /* last used change number -- semantically similar to transno */
162 unsigned long opd_syn_last_used_id;
163 /* last committed change number -- semantically similar to
165 unsigned long opd_syn_last_committed_id;
166 /* last processed (taken from llog) id */
167 unsigned long opd_syn_last_processed_id;
168 struct osp_id_tracker *opd_syn_tracker;
169 cfs_list_t opd_syn_ontrack;
172 * statfs related fields: OSP maintains it on its own
174 struct obd_statfs opd_statfs;
175 cfs_time_t opd_statfs_fresh_till;
176 cfs_timer_t opd_statfs_timer;
177 int opd_statfs_update_in_progress;
178 /* how often to update statfs data */
179 int opd_statfs_maxage;
181 cfs_proc_dir_entry_t *opd_symlink;
184 extern cfs_mem_cache_t *osp_object_kmem;
186 /* this is a top object */
188 struct lu_object_header opo_header;
189 struct dt_object opo_obj;
190 unsigned int opo_reserved:1,
194 /* read/write lock for md osp object */
195 struct rw_semaphore opo_sem;
196 const struct lu_env *opo_owner;
199 extern struct lu_object_operations osp_lu_obj_ops;
200 extern const struct dt_device_operations osp_dt_ops;
201 extern struct dt_object_operations osp_md_obj_ops;
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;
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;
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;
225 static inline void osp_objid_buf_prep(struct lu_buf *buf, loff_t *off,
226 __u32 *id, int index)
228 buf->lb_buf = (void *)id;
229 buf->lb_len = sizeof(obd_id);
230 *off = sizeof(obd_id) * index;
233 static inline void osp_objseq_buf_prep(struct lu_buf *buf, loff_t *off,
234 __u64 *seq, int index)
236 buf->lb_buf = (void *)seq;
237 buf->lb_len = sizeof(obd_id);
238 *off = sizeof(obd_id) * index;
241 static inline void osp_buf_prep(struct lu_buf *lb, void *buf, int buf_len)
244 lb->lb_len = buf_len;
247 extern struct lu_context_key osp_thread_key;
249 static inline struct osp_thread_info *osp_env_info(const struct lu_env *env)
251 struct osp_thread_info *info;
253 info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
255 lu_env_refill((struct lu_env *)env);
256 info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
262 struct osp_txn_info {
263 __u32 oti_current_id;
266 extern struct lu_context_key osp_txn_key;
268 static inline struct osp_txn_info *osp_txn_info(struct lu_context *ctx)
270 struct osp_txn_info *info;
272 info = lu_context_key_get(ctx, &osp_txn_key);
276 extern const struct lu_device_operations osp_lu_ops;
278 static inline int lu_device_is_osp(struct lu_device *d)
280 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osp_lu_ops);
283 static inline struct osp_device *lu2osp_dev(struct lu_device *d)
285 LASSERT(lu_device_is_osp(d));
286 return container_of0(d, struct osp_device, opd_dt_dev.dd_lu_dev);
289 static inline struct lu_device *osp2lu_dev(struct osp_device *d)
291 return &d->opd_dt_dev.dd_lu_dev;
294 static inline struct osp_device *dt2osp_dev(struct dt_device *d)
296 LASSERT(lu_device_is_osp(&d->dd_lu_dev));
297 return container_of0(d, struct osp_device, opd_dt_dev);
300 static inline struct osp_object *lu2osp_obj(struct lu_object *o)
302 LASSERT(ergo(o != NULL, lu_device_is_osp(o->lo_dev)));
303 return container_of0(o, struct osp_object, opo_obj.do_lu);
306 static inline struct lu_object *osp2lu_obj(struct osp_object *obj)
308 return &obj->opo_obj.do_lu;
311 static inline struct osp_object *osp_obj(const struct lu_object *o)
313 LASSERT(lu_device_is_osp(o->lo_dev));
314 return container_of0(o, struct osp_object, opo_obj.do_lu);
317 static inline struct osp_object *dt2osp_obj(const struct dt_object *d)
319 return osp_obj(&d->do_lu);
322 static inline struct dt_object *osp_object_child(struct osp_object *o)
324 return container_of0(lu_object_next(osp2lu_obj(o)),
325 struct dt_object, do_lu);
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)
332 static inline void osp_update_last_fid(struct osp_device *d, struct lu_fid *fid)
334 int diff = lu_fid_diff(fid, &d->opd_last_used_fid);
336 * we might have lost precreated objects due to VBR and precreate
337 * orphans, the gap in objid can be calculated properly only here
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);
347 d->opd_last_used_fid = *fid;
351 static int osp_fid_end_seq(const struct lu_env *env, struct lu_fid *fid)
353 if (fid_is_idif(fid)) {
354 struct osp_thread_info *info = osp_env_info(env);
355 struct ost_id *oi = &info->osi_oi;
357 fid_to_ostid(fid, oi);
358 return ostid_id(oi) == IDIF_MAX_OID;
360 return fid_oid(fid) == LUSTRE_DATA_SEQ_MAX_WIDTH;
364 static inline int osp_precreate_end_seq_nolock(const struct lu_env *env,
365 struct osp_device *osp)
367 struct lu_fid *fid = &osp->opd_pre_last_created_fid;
369 return osp_fid_end_seq(env, fid);
372 static inline int osp_precreate_end_seq(const struct lu_env *env,
373 struct osp_device *osp)
377 spin_lock(&osp->opd_pre_lock);
378 rc = osp_precreate_end_seq_nolock(env, osp);
379 spin_unlock(&osp->opd_pre_lock);
383 static inline int osp_is_fid_client(struct osp_device *osp)
385 struct obd_import *imp = osp->opd_obd->u.cli.cl_import;
387 return imp->imp_connect_data.ocd_connect_flags & OBD_CONNECT_FID;
391 void osp_update_last_id(struct osp_device *d, obd_id objid);
392 extern struct llog_operations osp_mds_ost_orig_logops;
394 /* osp_md_object.c */
395 int osp_trans_start(const struct lu_env *env, struct dt_device *dt,
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,
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);
413 void lprocfs_osp_init_vars(struct lprocfs_static_vars *lvars);
414 void osp_lprocfs_init(struct osp_device *osp);
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);
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;