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>
41 #include <range_lock.h>
43 #define OFD_INIT_OBJID 0
44 #define OFD_PRECREATE_BATCH_DEFAULT (OBJ_SUBDIR_COUNT * 4)
46 /* on small filesystems we should not precreate too many objects in
47 * a single transaction, otherwise we can overflow transactions */
48 #define OFD_PRECREATE_SMALL_FS (1024ULL * 1024 * 1024)
49 #define OFD_PRECREATE_BATCH_SMALL 8
51 /* Limit the returned fields marked valid to those that we actually might set */
52 #define OFD_VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
53 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
55 #define OFD_SOFT_SYNC_LIMIT_DEFAULT 16
58 * update atime if on-disk value older than client's one
59 * by OFD_ATIME_DIFF or more
61 #define OFD_DEF_ATIME_DIFF 0 /* disabled */
65 LPROC_OFD_STATS_READ_BYTES = 0,
66 LPROC_OFD_STATS_WRITE_BYTES,
68 LPROC_OFD_STATS_WRITE,
69 LPROC_OFD_STATS_GETATTR,
70 LPROC_OFD_STATS_SETATTR,
71 LPROC_OFD_STATS_PUNCH,
73 LPROC_OFD_STATS_DESTROY,
74 LPROC_OFD_STATS_CREATE,
75 LPROC_OFD_STATS_STATFS,
76 LPROC_OFD_STATS_GET_INFO,
77 LPROC_OFD_STATS_SET_INFO,
78 LPROC_OFD_STATS_QUOTACTL,
79 LPROC_OFD_STATS_PREALLOC,
83 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
84 char *jobid, long amount)
86 if (exp->exp_obd && exp->exp_obd->obd_stats)
87 lprocfs_counter_add(exp->exp_obd->obd_stats, opcode, amount);
89 if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
90 (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
91 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
93 if (exp->exp_nid_stats != NULL &&
94 exp->exp_nid_stats->nid_stats != NULL) {
95 lprocfs_counter_add(exp->exp_nid_stats->nid_stats, opcode,
101 struct list_head os_list;
103 spinlock_t os_last_oid_lock;
104 struct mutex os_create_lock;
106 atomic_t os_precreate_in_progress;
107 struct dt_object *os_lastid_obj;
108 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 ofd_access_log *ofd_access_log;
128 unsigned int ofd_access_log_size;
129 unsigned int ofd_access_log_mask;
131 struct list_head ofd_seq_list;
132 rwlock_t ofd_seq_list_lock;
134 int ofd_precreate_batch;
135 spinlock_t ofd_batch_lock;
137 /* preferred BRW size, decided by storage type and capability */
139 spinlock_t ofd_flags_lock;
140 unsigned long ofd_raid_degraded:1,
141 /* sync journal on writes */
143 /* Protected by ofd_lastid_rwsem. */
144 ofd_lastid_rebuilding:1,
145 ofd_record_fid_accessed:1,
146 ofd_lfsck_verify_pfid:1,
149 struct seq_server_site ofd_seq_site;
150 /* the limit of SOFT_SYNC RPCs that will trigger a soft sync */
151 unsigned int ofd_soft_sync_limit;
152 /* Protect ::ofd_lastid_rebuilding */
153 struct rw_semaphore ofd_lastid_rwsem;
154 __u64 ofd_lastid_gen;
155 struct ptlrpc_thread ofd_inconsistency_thread;
156 struct list_head ofd_inconsistency_list;
157 spinlock_t ofd_inconsistency_lock;
158 /* Backwards compatibility */
159 struct attribute *ofd_read_cache_enable;
160 struct attribute *ofd_read_cache_max_filesize;
161 struct attribute *ofd_write_cache_enable;
162 time64_t ofd_atime_diff;
165 static inline struct ofd_device *ofd_dev(struct lu_device *d)
167 return container_of_safe(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
170 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
172 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
175 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
177 return ofd_dev(exp->exp_obd->obd_lu_dev);
180 static inline char *ofd_name(struct ofd_device *ofd)
182 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
186 struct lu_object_header ofo_header;
187 struct dt_object ofo_obj;
188 struct filter_fid ofo_ff;
189 time64_t ofo_atime_ondisk;
190 unsigned int ofo_pfid_checking:1,
192 struct range_lock_tree ofo_write_tree;
195 static inline struct ofd_object *ofd_obj(struct lu_object *o)
197 return container_of_safe(o, struct ofd_object, ofo_obj.do_lu);
200 static inline int ofd_object_exists(struct ofd_object *obj)
202 LASSERT(obj != NULL);
203 if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
205 return lu_object_exists(&obj->ofo_obj.do_lu);
208 static inline struct dt_object *fo2dt(struct ofd_object *obj)
210 return &obj->ofo_obj;
213 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
215 struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
217 return container_of(lu_object_next(lu), struct dt_object, do_lu);
220 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
222 return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
225 static inline void ofd_read_lock(const struct lu_env *env,
226 struct ofd_object *fo)
228 struct dt_object *next = ofd_object_child(fo);
230 next->do_ops->do_read_lock(env, next, 0);
233 static inline void ofd_read_unlock(const struct lu_env *env,
234 struct ofd_object *fo)
236 struct dt_object *next = ofd_object_child(fo);
238 next->do_ops->do_read_unlock(env, next);
241 static inline void ofd_write_lock(const struct lu_env *env,
242 struct ofd_object *fo)
244 struct dt_object *next = ofd_object_child(fo);
246 next->do_ops->do_write_lock(env, next, 0);
249 static inline void ofd_write_unlock(const struct lu_env *env,
250 struct ofd_object *fo)
252 struct dt_object *next = ofd_object_child(fo);
254 next->do_ops->do_write_unlock(env, next);
258 * Common data shared by obdofd-level handlers. This is allocated per-thread
259 * to reduce stack consumption.
261 struct ofd_thread_info {
262 const struct lu_env *fti_env;
264 struct obd_export *fti_exp;
266 __u64 fti_pre_version;
268 struct lu_fid fti_fid;
269 struct lu_attr fti_attr;
270 struct lu_attr fti_attr2;
271 struct ldlm_res_id fti_resid;
272 struct filter_fid fti_mds_fid;
273 struct ost_id fti_ostid;
274 struct ofd_object *fti_obj;
276 char name[64]; /* for ofd_init0() */
277 struct obd_statfs osfs; /* for obdofd_statfs() */
280 /* Ops object filename */
281 struct lu_name fti_name;
282 struct dt_object_format fti_dof;
283 struct lu_buf fti_buf;
286 struct ost_lvb fti_lvb;
288 struct lfsck_req_local fti_lrl;
289 struct obd_connect_data fti_ocd;
291 struct range_lock fti_write_range;
292 unsigned fti_range_locked:1;
295 extern void target_recovery_fini(struct obd_device *obd);
296 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
298 /* ofd_access_log.c */
299 bool ofd_access_log_size_is_valid(unsigned int size);
300 int ofd_access_log_module_init(void);
301 void ofd_access_log_module_exit(void);
303 struct ofd_access_log;
304 struct ofd_access_log *ofd_access_log_create(const char *ofd_name, size_t size);
305 void ofd_access_log_delete(struct ofd_access_log *oal);
306 void ofd_access(const struct lu_env *env, struct ofd_device *m,
307 const struct lu_fid *parent_fid, __u64 begin, __u64 end,
308 unsigned int size, unsigned int segment_count, int rw);
311 extern struct lu_context_key ofd_thread_key;
312 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
313 int ofd_fiemap_get(const struct lu_env *env, struct ofd_device *ofd,
314 struct lu_fid *fid, struct fiemap *fiemap);
317 extern const struct obd_ops ofd_obd_ops;
318 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
319 const struct lu_fid *fid, int orphan);
320 int ofd_statfs(const struct lu_env *env, struct obd_export *exp,
321 struct obd_statfs *osfs, time64_t max_age, __u32 flags);
322 int ofd_obd_disconnect(struct obd_export *exp);
325 u64 ofd_seq_last_oid(struct ofd_seq *oseq);
326 void ofd_seq_last_oid_set(struct ofd_seq *oseq, u64 id);
327 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
328 struct ofd_seq *oseq);
329 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
330 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, u64 seq);
331 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
333 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
334 struct obd_device *obd);
335 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
336 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
337 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
339 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
340 void ofd_seqs_free(const struct lu_env *env, struct ofd_device *ofd);
343 int ofd_start_inconsistency_verification_thread(struct ofd_device *ofd);
344 int ofd_stop_inconsistency_verification_thread(struct ofd_device *ofd);
345 int ofd_verify_ff(const struct lu_env *env, struct ofd_object *fo,
347 int ofd_verify_layout_version(const struct lu_env *env,
348 struct ofd_object *fo, const struct obdo *oa);
349 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
350 struct obdo *oa, int objcount, struct obd_ioobj *obj,
351 struct niobuf_remote *rnb, int *nr_local,
352 struct niobuf_local *lnb);
353 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
354 struct obdo *oa, int objcount, struct obd_ioobj *obj,
355 struct niobuf_remote *rnb, int npages,
356 struct niobuf_local *lnb, int old_rc);
359 struct thandle *ofd_trans_create(const struct lu_env *env,
360 struct ofd_device *ofd);
361 int ofd_trans_start(const struct lu_env *env,
362 struct ofd_device *ofd, struct ofd_object *fo,
364 int ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
365 struct thandle *th, int rc);
366 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
370 int ofd_tunables_init(struct ofd_device *ofd);
371 #ifdef CONFIG_PROC_FS
372 void ofd_stats_counter_init(struct lprocfs_stats *stats, unsigned int offset);
374 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats,
375 unsigned int offset) {}
379 struct ofd_object *ofd_object_find(const struct lu_env *env,
380 struct ofd_device *ofd,
381 const struct lu_fid *fid);
382 int ofd_object_ff_load(const struct lu_env *env, struct ofd_object *fo);
383 int ofd_object_ff_update(const struct lu_env *env, struct ofd_object *fo,
384 const struct obdo *oa, struct filter_fid *ff);
385 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
386 u64 id, struct ofd_seq *oseq, int nr, int sync);
388 static inline void ofd_object_put(const struct lu_env *env,
389 struct ofd_object *fo)
391 dt_object_put(env, &fo->ofo_obj);
393 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
394 struct lu_attr *la, struct obdo *oa);
395 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
396 __u64 start, __u64 end, struct lu_attr *la,
398 int ofd_object_fallocate(const struct lu_env *env, struct ofd_object *fo,
399 __u64 start, __u64 end, int mode, struct lu_attr *la,
401 int ofd_destroy(const struct lu_env *, struct ofd_object *, int);
402 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
404 int ofd_attr_handle_id(const struct lu_env *env, struct ofd_object *fo,
405 struct lu_attr *la, int is_setattr);
408 struct ofd_object *ofd_object_find_exists(const struct lu_env *env,
409 struct ofd_device *ofd,
410 const struct lu_fid *fid)
412 struct ofd_object *fo;
414 fo = ofd_object_find(env, ofd, fid);
415 if (!IS_ERR(fo) && !ofd_object_exists(fo)) {
416 ofd_object_put(env, fo);
417 fo = ERR_PTR(-ENOENT);
423 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
425 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
426 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
429 extern struct ldlm_valblock_ops ofd_lvbo;
432 extern struct kmem_cache *ldlm_glimpse_work_kmem;
434 int ofd_intent_policy(const struct lu_env *env, struct ldlm_namespace *ns,
435 struct ldlm_lock **lockp, void *req_cookie,
436 enum ldlm_mode mode, __u64 flags, void *data);
438 static inline struct ofd_thread_info *ofd_info(const struct lu_env *env)
440 return lu_env_info(env, &ofd_thread_key);
443 static inline struct ofd_thread_info *ofd_info_init(const struct lu_env *env,
444 struct obd_export *exp)
446 struct ofd_thread_info *info;
448 info = ofd_info(env);
449 LASSERT(info->fti_exp == NULL);
450 LASSERT(info->fti_env == NULL);
451 LASSERT(info->fti_attr.la_valid == 0);
455 info->fti_pre_version = 0;
459 static inline struct ofd_thread_info *tsi2ofd_info(struct tgt_session_info *tsi)
461 struct ptlrpc_request *req = tgt_ses_req(tsi);
462 struct ofd_thread_info *info;
464 info = ofd_info(tsi->tsi_env);
465 LASSERT(info->fti_exp == NULL);
466 LASSERT(info->fti_env == NULL);
467 LASSERT(info->fti_attr.la_valid == 0);
469 info->fti_env = tsi->tsi_env;
470 info->fti_exp = tsi->tsi_exp;
472 info->fti_xid = req->rq_xid;
473 /** VBR: take versions from request */
474 if (req->rq_reqmsg != NULL &&
475 lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
476 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
478 info->fti_pre_version = pre_version ? pre_version[0] : 0;
483 /* sync on lock cancel is useless when we force a journal flush,
484 * and if we enable async journal commit, we should also turn on
485 * sync on lock cancel if it is not enabled already. */
486 static inline void ofd_slc_set(struct ofd_device *ofd)
488 if (ofd->ofd_sync_journal == 1)
489 ofd->ofd_lut.lut_sync_lock_cancel = SYNC_LOCK_CANCEL_NEVER;
490 else if (ofd->ofd_lut.lut_sync_lock_cancel == SYNC_LOCK_CANCEL_NEVER)
491 ofd->ofd_lut.lut_sync_lock_cancel = SYNC_LOCK_CANCEL_ALWAYS;
494 static inline int ofd_validate_seq(struct obd_export *exp, __u64 seq)
496 struct filter_export_data *fed = &exp->exp_filter_data;
498 if (unlikely(seq == FID_SEQ_OST_MDT0 && fed->fed_group != 0)) {
499 /* IDIF request only operates on MDT0 group */
500 CERROR("%s: Invalid sequence %#llx for group %u\n",
501 exp->exp_obd->obd_name, seq, fed->fed_group);
508 #endif /* _OFD_INTERNAL_H */