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 /* per-client-per-object persistent state (LRU) */
56 struct list_head fmd_list; /* linked to fed_mod_list */
57 struct lu_fid fmd_fid; /* FID being written to */
58 __u64 fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
59 time64_t fmd_expire; /* time when the fmd should expire */
60 int fmd_refcount; /* reference counter - list holds 1 */
63 #define OFD_FMD_MAX_NUM_DEFAULT 128
64 #define OFD_FMD_MAX_AGE_DEFAULT (obd_timeout + 10)
66 #define OFD_SOFT_SYNC_LIMIT_DEFAULT 16
70 LPROC_OFD_STATS_READ = 0,
71 LPROC_OFD_STATS_WRITE,
72 LPROC_OFD_STATS_GETATTR,
73 LPROC_OFD_STATS_SETATTR,
74 LPROC_OFD_STATS_PUNCH,
76 LPROC_OFD_STATS_DESTROY,
77 LPROC_OFD_STATS_CREATE,
78 LPROC_OFD_STATS_STATFS,
79 LPROC_OFD_STATS_GET_INFO,
80 LPROC_OFD_STATS_SET_INFO,
81 LPROC_OFD_STATS_QUOTACTL,
85 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
86 char *jobid, long amount)
88 if (exp->exp_obd && exp->exp_obd->obd_stats)
89 lprocfs_counter_add(exp->exp_obd->obd_stats, opcode, amount);
91 if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
92 (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
93 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
95 if (exp->exp_nid_stats != NULL &&
96 exp->exp_nid_stats->nid_stats != NULL) {
97 lprocfs_counter_add(exp->exp_nid_stats->nid_stats, opcode,
103 struct list_head os_list;
105 spinlock_t os_last_oid_lock;
106 struct mutex os_create_lock;
108 struct dt_object *os_lastid_obj;
109 unsigned long os_destroys_in_progress:1;
113 struct dt_device ofd_dt_dev;
114 struct dt_device *ofd_osd;
115 struct obd_export *ofd_osd_exp;
116 /* DLM name-space for meta-data locks maintained by this server */
117 struct ldlm_namespace *ofd_namespace;
120 struct lu_target ofd_lut;
121 struct dt_object *ofd_health_check_file;
122 struct local_oid_storage *ofd_los;
124 __u64 ofd_inconsistency_self_detected;
125 __u64 ofd_inconsistency_self_repaired;
127 struct list_head ofd_seq_list;
128 rwlock_t ofd_seq_list_lock;
130 int ofd_precreate_batch;
131 spinlock_t ofd_batch_lock;
133 /* preferred BRW size, decided by storage type and capability */
135 /* checksum types supported on this node */
136 enum cksum_types ofd_cksum_types_supported;
138 /* ofd mod data: ofd_device wide values */
139 int ofd_fmd_max_num; /* per ofd ofd_mod_data */
140 time64_t ofd_fmd_max_age; /* time to fmd expiry */
142 spinlock_t ofd_flags_lock;
143 unsigned long ofd_raid_degraded:1,
144 /* sync journal on writes */
146 /* Protected by ofd_lastid_rwsem. */
147 ofd_lastid_rebuilding:1,
148 ofd_record_fid_accessed:1,
149 ofd_lfsck_verify_pfid:1,
151 /* Whether to enforce T10PI checksum of RPC */
152 ofd_checksum_t10pi_enforce:1;
153 struct seq_server_site ofd_seq_site;
154 /* the limit of SOFT_SYNC RPCs that will trigger a soft sync */
155 unsigned int ofd_soft_sync_limit;
156 /* Protect ::ofd_lastid_rebuilding */
157 struct rw_semaphore ofd_lastid_rwsem;
158 __u64 ofd_lastid_gen;
159 struct ptlrpc_thread ofd_inconsistency_thread;
160 struct list_head ofd_inconsistency_list;
161 spinlock_t ofd_inconsistency_lock;
162 /* Backwards compatibility */
163 struct attribute *ofd_read_cache_enable;
164 struct attribute *ofd_read_cache_max_filesize;
165 struct attribute *ofd_write_cache_enable;
168 static inline struct ofd_device *ofd_dev(struct lu_device *d)
170 return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
173 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
175 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
178 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
180 return ofd_dev(exp->exp_obd->obd_lu_dev);
183 static inline char *ofd_name(struct ofd_device *ofd)
185 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
189 struct lu_object_header ofo_header;
190 struct dt_object ofo_obj;
191 struct filter_fid ofo_ff;
192 unsigned int ofo_pfid_checking:1,
196 static inline struct ofd_object *ofd_obj(struct lu_object *o)
198 return container_of0(o, struct ofd_object, ofo_obj.do_lu);
201 static inline int ofd_object_exists(struct ofd_object *obj)
203 LASSERT(obj != NULL);
204 if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
206 return lu_object_exists(&obj->ofo_obj.do_lu);
209 static inline struct dt_object *fo2dt(struct ofd_object *obj)
211 return &obj->ofo_obj;
214 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
216 struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
218 return container_of0(lu_object_next(lu), struct dt_object, do_lu);
221 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
223 return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
226 static inline void ofd_read_lock(const struct lu_env *env,
227 struct ofd_object *fo)
229 struct dt_object *next = ofd_object_child(fo);
231 next->do_ops->do_read_lock(env, next, 0);
234 static inline void ofd_read_unlock(const struct lu_env *env,
235 struct ofd_object *fo)
237 struct dt_object *next = ofd_object_child(fo);
239 next->do_ops->do_read_unlock(env, next);
242 static inline void ofd_write_lock(const struct lu_env *env,
243 struct ofd_object *fo)
245 struct dt_object *next = ofd_object_child(fo);
247 next->do_ops->do_write_lock(env, next, 0);
250 static inline void ofd_write_unlock(const struct lu_env *env,
251 struct ofd_object *fo)
253 struct dt_object *next = ofd_object_child(fo);
255 next->do_ops->do_write_unlock(env, next);
259 * Common data shared by obdofd-level handlers. This is allocated per-thread
260 * to reduce stack consumption.
262 struct ofd_thread_info {
263 const struct lu_env *fti_env;
265 struct obd_export *fti_exp;
267 __u64 fti_pre_version;
269 struct lu_fid fti_fid;
270 struct lu_attr fti_attr;
271 struct lu_attr fti_attr2;
272 struct ldlm_res_id fti_resid;
273 struct filter_fid fti_mds_fid;
274 struct ost_id fti_ostid;
275 struct ofd_object *fti_obj;
277 char name[64]; /* for ofd_init0() */
278 struct obd_statfs osfs; /* for obdofd_statfs() */
281 /* Ops object filename */
282 struct lu_name fti_name;
283 struct dt_object_format fti_dof;
284 struct lu_buf fti_buf;
287 struct ost_lvb fti_lvb;
289 struct lfsck_req_local fti_lrl;
290 struct obd_connect_data fti_ocd;
294 extern void target_recovery_fini(struct obd_device *obd);
295 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
298 extern struct lu_context_key ofd_thread_key;
299 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
300 int ofd_fiemap_get(const struct lu_env *env, struct ofd_device *ofd,
301 struct lu_fid *fid, struct fiemap *fiemap);
304 extern struct obd_ops ofd_obd_ops;
305 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
306 const struct lu_fid *fid, int orphan);
307 int ofd_statfs(const struct lu_env *env, struct obd_export *exp,
308 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
309 int ofd_obd_disconnect(struct obd_export *exp);
312 u64 ofd_seq_last_oid(struct ofd_seq *oseq);
313 void ofd_seq_last_oid_set(struct ofd_seq *oseq, u64 id);
314 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
315 struct ofd_seq *oseq);
316 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
317 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, u64 seq);
318 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
320 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
321 struct obd_device *obd);
322 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
323 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
324 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
326 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
327 void ofd_seqs_free(const struct lu_env *env, struct ofd_device *ofd);
330 int ofd_start_inconsistency_verification_thread(struct ofd_device *ofd);
331 int ofd_stop_inconsistency_verification_thread(struct ofd_device *ofd);
332 int ofd_verify_ff(const struct lu_env *env, struct ofd_object *fo,
334 int ofd_verify_layout_version(const struct lu_env *env,
335 struct ofd_object *fo, const struct obdo *oa);
336 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
337 struct obdo *oa, int objcount, struct obd_ioobj *obj,
338 struct niobuf_remote *rnb, int *nr_local,
339 struct niobuf_local *lnb);
340 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
341 struct obdo *oa, int objcount, struct obd_ioobj *obj,
342 struct niobuf_remote *rnb, int npages,
343 struct niobuf_local *lnb, int old_rc);
346 struct thandle *ofd_trans_create(const struct lu_env *env,
347 struct ofd_device *ofd);
348 int ofd_trans_start(const struct lu_env *env,
349 struct ofd_device *ofd, struct ofd_object *fo,
351 int ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
352 struct thandle *th, int rc);
353 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
357 int ofd_tunables_init(struct ofd_device *ofd);
358 #ifdef CONFIG_PROC_FS
359 void ofd_stats_counter_init(struct lprocfs_stats *stats);
361 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
365 struct ofd_object *ofd_object_find(const struct lu_env *env,
366 struct ofd_device *ofd,
367 const struct lu_fid *fid);
368 int ofd_object_ff_load(const struct lu_env *env, struct ofd_object *fo);
369 int ofd_object_ff_update(const struct lu_env *env, struct ofd_object *fo,
370 const struct obdo *oa, struct filter_fid *ff);
371 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
372 u64 id, struct ofd_seq *oseq, int nr, int sync);
374 static inline void ofd_object_put(const struct lu_env *env,
375 struct ofd_object *fo)
377 dt_object_put(env, &fo->ofo_obj);
379 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
380 struct lu_attr *la, struct obdo *oa);
381 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
382 __u64 start, __u64 end, struct lu_attr *la,
384 int ofd_destroy(const struct lu_env *, struct ofd_object *, int);
385 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
387 int ofd_attr_handle_id(const struct lu_env *env, struct ofd_object *fo,
388 struct lu_attr *la, int is_setattr);
391 struct ofd_object *ofd_object_find_exists(const struct lu_env *env,
392 struct ofd_device *ofd,
393 const struct lu_fid *fid)
395 struct ofd_object *fo;
397 fo = ofd_object_find(env, ofd, fid);
398 if (!IS_ERR(fo) && !ofd_object_exists(fo)) {
399 ofd_object_put(env, fo);
400 fo = ERR_PTR(-ENOENT);
406 int ofd_fmd_init(void);
407 void ofd_fmd_exit(void);
408 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
409 const struct lu_fid *fid);
410 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
411 const struct lu_fid *fid);
412 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
413 void ofd_fmd_expire(struct obd_export *exp);
414 void ofd_fmd_cleanup(struct obd_export *exp);
416 void ofd_fmd_drop(struct obd_export *exp, const struct lu_fid *fid);
418 #define ofd_fmd_drop(exp, fid) do {} while (0)
422 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
424 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
425 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
428 extern struct ldlm_valblock_ops ofd_lvbo;
431 extern struct kmem_cache *ldlm_glimpse_work_kmem;
433 int ofd_intent_policy(const struct lu_env *env, struct ldlm_namespace *ns,
434 struct ldlm_lock **lockp, void *req_cookie,
435 enum ldlm_mode mode, __u64 flags, void *data);
437 static inline struct ofd_thread_info *ofd_info(const struct lu_env *env)
439 struct ofd_thread_info *info;
441 lu_env_refill((void *)env);
442 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
447 static inline struct ofd_thread_info *ofd_info_init(const struct lu_env *env,
448 struct obd_export *exp)
450 struct ofd_thread_info *info;
452 info = ofd_info(env);
453 LASSERT(info->fti_exp == NULL);
454 LASSERT(info->fti_env == NULL);
455 LASSERT(info->fti_attr.la_valid == 0);
459 info->fti_pre_version = 0;
463 static inline struct ofd_thread_info *tsi2ofd_info(struct tgt_session_info *tsi)
465 struct ptlrpc_request *req = tgt_ses_req(tsi);
466 struct ofd_thread_info *info;
468 info = ofd_info(tsi->tsi_env);
469 LASSERT(info->fti_exp == NULL);
470 LASSERT(info->fti_env == NULL);
471 LASSERT(info->fti_attr.la_valid == 0);
473 info->fti_env = tsi->tsi_env;
474 info->fti_exp = tsi->tsi_exp;
476 info->fti_xid = req->rq_xid;
477 /** VBR: take versions from request */
478 if (req->rq_reqmsg != NULL &&
479 lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
480 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
482 info->fti_pre_version = pre_version ? pre_version[0] : 0;
487 /* sync on lock cancel is useless when we force a journal flush,
488 * and if we enable async journal commit, we should also turn on
489 * sync on lock cancel if it is not enabled already. */
490 static inline void ofd_slc_set(struct ofd_device *ofd)
492 if (ofd->ofd_sync_journal == 1)
493 ofd->ofd_lut.lut_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
494 else if (ofd->ofd_lut.lut_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
495 ofd->ofd_lut.lut_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
498 static inline int ofd_validate_seq(struct obd_export *exp, __u64 seq)
500 struct filter_export_data *fed = &exp->exp_filter_data;
502 if (unlikely(seq == FID_SEQ_OST_MDT0 && fed->fed_group != 0)) {
503 /* IDIF request only operates on MDT0 group */
504 CERROR("%s: Invalid sequence %#llx for group %u\n",
505 exp->exp_obd->obd_name, seq, fed->fed_group);
511 #endif /* _OFD_INTERNAL_H */