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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #ifndef _OFD_INTERNAL_H
34 #define _OFD_INTERNAL_H
37 #include <obd_class.h>
38 #include <dt_object.h>
39 #include <md_object.h>
40 #include <lustre_fid.h>
42 #define OFD_INIT_OBJID 0
43 #define OFD_PRECREATE_BATCH_DEFAULT (OBJ_SUBDIR_COUNT * 4)
45 /* on small filesystems we should not precreate too many objects in
46 * a single transaction, otherwise we can overflow transactions */
47 #define OFD_PRECREATE_SMALL_FS (1024ULL * 1024 * 1024)
48 #define OFD_PRECREATE_BATCH_SMALL 8
50 /* Limit the returned fields marked valid to those that we actually might set */
51 #define OFD_VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
52 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
54 #define OFD_SOFT_SYNC_LIMIT_DEFAULT 16
58 LPROC_OFD_STATS_READ = 0,
59 LPROC_OFD_STATS_WRITE,
60 LPROC_OFD_STATS_GETATTR,
61 LPROC_OFD_STATS_SETATTR,
62 LPROC_OFD_STATS_PUNCH,
64 LPROC_OFD_STATS_DESTROY,
65 LPROC_OFD_STATS_CREATE,
66 LPROC_OFD_STATS_STATFS,
67 LPROC_OFD_STATS_GET_INFO,
68 LPROC_OFD_STATS_SET_INFO,
69 LPROC_OFD_STATS_QUOTACTL,
73 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
74 char *jobid, long amount)
76 if (exp->exp_obd && exp->exp_obd->obd_stats)
77 lprocfs_counter_add(exp->exp_obd->obd_stats, opcode, amount);
79 if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
80 (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
81 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
83 if (exp->exp_nid_stats != NULL &&
84 exp->exp_nid_stats->nid_stats != NULL) {
85 lprocfs_counter_add(exp->exp_nid_stats->nid_stats, opcode,
91 struct list_head os_list;
93 spinlock_t os_last_oid_lock;
94 struct mutex os_create_lock;
96 struct dt_object *os_lastid_obj;
97 unsigned long os_destroys_in_progress:1,
102 struct dt_device ofd_dt_dev;
103 struct dt_device *ofd_osd;
104 struct obd_export *ofd_osd_exp;
105 /* DLM name-space for meta-data locks maintained by this server */
106 struct ldlm_namespace *ofd_namespace;
109 struct lu_target ofd_lut;
110 struct dt_object *ofd_health_check_file;
111 struct local_oid_storage *ofd_los;
113 __u64 ofd_inconsistency_self_detected;
114 __u64 ofd_inconsistency_self_repaired;
116 struct list_head ofd_seq_list;
117 rwlock_t ofd_seq_list_lock;
119 int ofd_precreate_batch;
120 spinlock_t ofd_batch_lock;
122 /* preferred BRW size, decided by storage type and capability */
124 /* checksum types supported on this node */
125 enum cksum_types ofd_cksum_types_supported;
127 spinlock_t ofd_flags_lock;
128 unsigned long ofd_raid_degraded:1,
129 /* sync journal on writes */
131 /* Protected by ofd_lastid_rwsem. */
132 ofd_lastid_rebuilding:1,
133 ofd_record_fid_accessed:1,
134 ofd_lfsck_verify_pfid:1,
136 /* Whether to enforce T10PI checksum of RPC */
137 ofd_checksum_t10pi_enforce:1;
138 struct seq_server_site ofd_seq_site;
139 /* the limit of SOFT_SYNC RPCs that will trigger a soft sync */
140 unsigned int ofd_soft_sync_limit;
141 /* Protect ::ofd_lastid_rebuilding */
142 struct rw_semaphore ofd_lastid_rwsem;
143 __u64 ofd_lastid_gen;
144 struct ptlrpc_thread ofd_inconsistency_thread;
145 struct list_head ofd_inconsistency_list;
146 spinlock_t ofd_inconsistency_lock;
147 /* Backwards compatibility */
148 struct attribute *ofd_read_cache_enable;
149 struct attribute *ofd_read_cache_max_filesize;
150 struct attribute *ofd_write_cache_enable;
153 static inline struct ofd_device *ofd_dev(struct lu_device *d)
155 return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
158 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
160 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
163 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
165 return ofd_dev(exp->exp_obd->obd_lu_dev);
168 static inline char *ofd_name(struct ofd_device *ofd)
170 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
174 struct lu_object_header ofo_header;
175 struct dt_object ofo_obj;
176 struct filter_fid ofo_ff;
177 unsigned int ofo_pfid_checking:1,
181 static inline struct ofd_object *ofd_obj(struct lu_object *o)
183 return container_of0(o, struct ofd_object, ofo_obj.do_lu);
186 static inline int ofd_object_exists(struct ofd_object *obj)
188 LASSERT(obj != NULL);
189 if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
191 return lu_object_exists(&obj->ofo_obj.do_lu);
194 static inline struct dt_object *fo2dt(struct ofd_object *obj)
196 return &obj->ofo_obj;
199 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
201 struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
203 return container_of0(lu_object_next(lu), struct dt_object, do_lu);
206 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
208 return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
211 static inline void ofd_read_lock(const struct lu_env *env,
212 struct ofd_object *fo)
214 struct dt_object *next = ofd_object_child(fo);
216 next->do_ops->do_read_lock(env, next, 0);
219 static inline void ofd_read_unlock(const struct lu_env *env,
220 struct ofd_object *fo)
222 struct dt_object *next = ofd_object_child(fo);
224 next->do_ops->do_read_unlock(env, next);
227 static inline void ofd_write_lock(const struct lu_env *env,
228 struct ofd_object *fo)
230 struct dt_object *next = ofd_object_child(fo);
232 next->do_ops->do_write_lock(env, next, 0);
235 static inline void ofd_write_unlock(const struct lu_env *env,
236 struct ofd_object *fo)
238 struct dt_object *next = ofd_object_child(fo);
240 next->do_ops->do_write_unlock(env, next);
244 * Common data shared by obdofd-level handlers. This is allocated per-thread
245 * to reduce stack consumption.
247 struct ofd_thread_info {
248 const struct lu_env *fti_env;
250 struct obd_export *fti_exp;
252 __u64 fti_pre_version;
254 struct lu_fid fti_fid;
255 struct lu_attr fti_attr;
256 struct lu_attr fti_attr2;
257 struct ldlm_res_id fti_resid;
258 struct filter_fid fti_mds_fid;
259 struct ost_id fti_ostid;
260 struct ofd_object *fti_obj;
262 char name[64]; /* for ofd_init0() */
263 struct obd_statfs osfs; /* for obdofd_statfs() */
266 /* Ops object filename */
267 struct lu_name fti_name;
268 struct dt_object_format fti_dof;
269 struct lu_buf fti_buf;
272 struct ost_lvb fti_lvb;
274 struct lfsck_req_local fti_lrl;
275 struct obd_connect_data fti_ocd;
279 extern void target_recovery_fini(struct obd_device *obd);
280 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
283 extern struct lu_context_key ofd_thread_key;
284 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
285 int ofd_fiemap_get(const struct lu_env *env, struct ofd_device *ofd,
286 struct lu_fid *fid, struct fiemap *fiemap);
289 extern struct obd_ops ofd_obd_ops;
290 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
291 const struct lu_fid *fid, int orphan);
292 int ofd_statfs(const struct lu_env *env, struct obd_export *exp,
293 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
294 int ofd_obd_disconnect(struct obd_export *exp);
297 u64 ofd_seq_last_oid(struct ofd_seq *oseq);
298 void ofd_seq_last_oid_set(struct ofd_seq *oseq, u64 id);
299 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
300 struct ofd_seq *oseq);
301 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
302 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, u64 seq);
303 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
305 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
306 struct obd_device *obd);
307 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
308 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
309 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
311 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
312 void ofd_seqs_free(const struct lu_env *env, struct ofd_device *ofd);
315 int ofd_start_inconsistency_verification_thread(struct ofd_device *ofd);
316 int ofd_stop_inconsistency_verification_thread(struct ofd_device *ofd);
317 int ofd_verify_ff(const struct lu_env *env, struct ofd_object *fo,
319 int ofd_verify_layout_version(const struct lu_env *env,
320 struct ofd_object *fo, const struct obdo *oa);
321 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
322 struct obdo *oa, int objcount, struct obd_ioobj *obj,
323 struct niobuf_remote *rnb, int *nr_local,
324 struct niobuf_local *lnb);
325 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
326 struct obdo *oa, int objcount, struct obd_ioobj *obj,
327 struct niobuf_remote *rnb, int npages,
328 struct niobuf_local *lnb, int old_rc);
331 struct thandle *ofd_trans_create(const struct lu_env *env,
332 struct ofd_device *ofd);
333 int ofd_trans_start(const struct lu_env *env,
334 struct ofd_device *ofd, struct ofd_object *fo,
336 int ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
337 struct thandle *th, int rc);
338 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
342 int ofd_tunables_init(struct ofd_device *ofd);
343 #ifdef CONFIG_PROC_FS
344 void ofd_stats_counter_init(struct lprocfs_stats *stats);
346 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
350 struct ofd_object *ofd_object_find(const struct lu_env *env,
351 struct ofd_device *ofd,
352 const struct lu_fid *fid);
353 int ofd_object_ff_load(const struct lu_env *env, struct ofd_object *fo);
354 int ofd_object_ff_update(const struct lu_env *env, struct ofd_object *fo,
355 const struct obdo *oa, struct filter_fid *ff);
356 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
357 u64 id, struct ofd_seq *oseq, int nr, int sync);
359 static inline void ofd_object_put(const struct lu_env *env,
360 struct ofd_object *fo)
362 dt_object_put(env, &fo->ofo_obj);
364 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
365 struct lu_attr *la, struct obdo *oa);
366 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
367 __u64 start, __u64 end, struct lu_attr *la,
369 int ofd_destroy(const struct lu_env *, struct ofd_object *, int);
370 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
372 int ofd_attr_handle_id(const struct lu_env *env, struct ofd_object *fo,
373 struct lu_attr *la, int is_setattr);
376 struct ofd_object *ofd_object_find_exists(const struct lu_env *env,
377 struct ofd_device *ofd,
378 const struct lu_fid *fid)
380 struct ofd_object *fo;
382 fo = ofd_object_find(env, ofd, fid);
383 if (!IS_ERR(fo) && !ofd_object_exists(fo)) {
384 ofd_object_put(env, fo);
385 fo = ERR_PTR(-ENOENT);
391 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
393 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
394 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
397 extern struct ldlm_valblock_ops ofd_lvbo;
400 extern struct kmem_cache *ldlm_glimpse_work_kmem;
402 int ofd_intent_policy(const struct lu_env *env, struct ldlm_namespace *ns,
403 struct ldlm_lock **lockp, void *req_cookie,
404 enum ldlm_mode mode, __u64 flags, void *data);
406 static inline struct ofd_thread_info *ofd_info(const struct lu_env *env)
408 struct ofd_thread_info *info;
410 lu_env_refill((void *)env);
411 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
416 static inline struct ofd_thread_info *ofd_info_init(const struct lu_env *env,
417 struct obd_export *exp)
419 struct ofd_thread_info *info;
421 info = ofd_info(env);
422 LASSERT(info->fti_exp == NULL);
423 LASSERT(info->fti_env == NULL);
424 LASSERT(info->fti_attr.la_valid == 0);
428 info->fti_pre_version = 0;
432 static inline struct ofd_thread_info *tsi2ofd_info(struct tgt_session_info *tsi)
434 struct ptlrpc_request *req = tgt_ses_req(tsi);
435 struct ofd_thread_info *info;
437 info = ofd_info(tsi->tsi_env);
438 LASSERT(info->fti_exp == NULL);
439 LASSERT(info->fti_env == NULL);
440 LASSERT(info->fti_attr.la_valid == 0);
442 info->fti_env = tsi->tsi_env;
443 info->fti_exp = tsi->tsi_exp;
445 info->fti_xid = req->rq_xid;
446 /** VBR: take versions from request */
447 if (req->rq_reqmsg != NULL &&
448 lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
449 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
451 info->fti_pre_version = pre_version ? pre_version[0] : 0;
456 /* sync on lock cancel is useless when we force a journal flush,
457 * and if we enable async journal commit, we should also turn on
458 * sync on lock cancel if it is not enabled already. */
459 static inline void ofd_slc_set(struct ofd_device *ofd)
461 if (ofd->ofd_sync_journal == 1)
462 ofd->ofd_lut.lut_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
463 else if (ofd->ofd_lut.lut_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
464 ofd->ofd_lut.lut_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
467 static inline int ofd_validate_seq(struct obd_export *exp, __u64 seq)
469 struct filter_export_data *fed = &exp->exp_filter_data;
471 if (unlikely(seq == FID_SEQ_OST_MDT0 && fed->fed_group != 0)) {
472 /* IDIF request only operates on MDT0 group */
473 CERROR("%s: Invalid sequence %#llx for group %u\n",
474 exp->exp_obd->obd_name, seq, fed->fed_group);
480 #endif /* _OFD_INTERNAL_H */