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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef _OFD_INTERNAL_H
38 #define _OFD_INTERNAL_H
41 #include <obd_class.h>
42 #include <dt_object.h>
43 #include <md_object.h>
44 #include <lustre_fid.h>
46 #define OFD_INIT_OBJID 0
47 #define OFD_PRECREATE_BATCH_DEFAULT (OBJ_SUBDIR_COUNT * 4)
49 /* on small filesystems we should not precreate too many objects in
50 * a single transaction, otherwise we can overflow transactions */
51 #define OFD_PRECREATE_SMALL_FS (1024ULL * 1024 * 1024)
52 #define OFD_PRECREATE_BATCH_SMALL 8
54 /* Limit the returned fields marked valid to those that we actually might set */
55 #define OFD_VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
56 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
58 /* per-client-per-object persistent state (LRU) */
60 struct list_head fmd_list; /* linked to fed_mod_list */
61 struct lu_fid fmd_fid; /* FID being written to */
62 __u64 fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
63 cfs_time_t fmd_expire; /* time when the fmd should expire */
64 int fmd_refcount; /* reference counter - list holds 1 */
67 #define OFD_FMD_MAX_NUM_DEFAULT 128
68 #define OFD_FMD_MAX_AGE_DEFAULT msecs_to_jiffies((obd_timeout+10)*MSEC_PER_SEC)
70 #define OFD_SOFT_SYNC_LIMIT_DEFAULT 16
74 LPROC_OFD_STATS_READ = 0,
75 LPROC_OFD_STATS_WRITE,
76 LPROC_OFD_STATS_GETATTR,
77 LPROC_OFD_STATS_SETATTR,
78 LPROC_OFD_STATS_PUNCH,
80 LPROC_OFD_STATS_DESTROY,
81 LPROC_OFD_STATS_CREATE,
82 LPROC_OFD_STATS_STATFS,
83 LPROC_OFD_STATS_GET_INFO,
84 LPROC_OFD_STATS_SET_INFO,
85 LPROC_OFD_STATS_QUOTACTL,
89 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
90 char *jobid, long amount)
92 if (exp->exp_obd && exp->exp_obd->obd_stats)
93 lprocfs_counter_add(exp->exp_obd->obd_stats, opcode, amount);
95 if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
96 (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
97 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
99 if (exp->exp_nid_stats != NULL &&
100 exp->exp_nid_stats->nid_stats != NULL) {
101 lprocfs_counter_add(exp->exp_nid_stats->nid_stats, opcode,
107 struct list_head os_list;
109 spinlock_t os_last_oid_lock;
110 struct mutex os_create_lock;
112 struct dt_object *os_lastid_obj;
113 unsigned long os_destroys_in_progress:1;
117 struct dt_device ofd_dt_dev;
118 struct dt_device *ofd_osd;
119 struct obd_export *ofd_osd_exp;
120 struct dt_device_param ofd_dt_conf;
121 /* DLM name-space for meta-data locks maintained by this server */
122 struct ldlm_namespace *ofd_namespace;
125 struct lu_target ofd_lut;
126 struct dt_object *ofd_health_check_file;
128 int ofd_subdir_count;
129 __u64 ofd_inconsistency_self_detected;
130 __u64 ofd_inconsistency_self_repaired;
132 struct list_head ofd_seq_list;
133 rwlock_t ofd_seq_list_lock;
135 int ofd_precreate_batch;
136 spinlock_t ofd_batch_lock;
138 /* protect all statfs-related counters */
139 spinlock_t ofd_osfs_lock;
140 /* statfs optimization: we cache a bit */
141 struct obd_statfs ofd_osfs;
144 /* writes between prep & commit which might be accounted twice in
145 * ofd_osfs.os_bavail */
146 u64 ofd_osfs_unstable;
148 /* counters used during statfs update, protected by ofd_osfs_lock.
149 * record when some statfs refresh are in progress */
150 int ofd_statfs_inflight;
151 /* track writes completed while statfs refresh is underway.
152 * tracking is only effective when ofd_statfs_inflight > 1 */
153 u64 ofd_osfs_inflight;
155 /* grants: all values in bytes */
156 /* grant lock to protect all grant counters */
157 spinlock_t ofd_grant_lock;
158 /* total amount of dirty data reported by clients in incoming obdo */
160 /* sum of filesystem space granted to clients for async writes */
162 /* grant used by I/Os in progress (between prepare and commit) */
164 /* free space threshold over which we stop granting space to clients
165 * ofd_grant_ratio is stored as a fixed-point fraction using
166 * OFD_GRANT_RATIO_SHIFT of the remaining free space, not in percentage
169 /* number of clients using grants */
170 int ofd_tot_granted_clients;
172 /* ofd mod data: ofd_device wide values */
173 int ofd_fmd_max_num; /* per ofd ofd_mod_data */
174 cfs_duration_t ofd_fmd_max_age; /* time to fmd expiry */
176 spinlock_t ofd_flags_lock;
177 unsigned long ofd_raid_degraded:1,
178 /* sync journal on writes */
180 /* shall we grant space to clients not
181 * supporting OBD_CONNECT_GRANT_PARAM? */
182 ofd_grant_compat_disable:1,
183 /* Protected by ofd_lastid_rwsem. */
184 ofd_lastid_rebuilding:1,
185 ofd_record_fid_accessed:1,
186 ofd_lfsck_verify_pfid:1,
188 struct seq_server_site ofd_seq_site;
189 /* the limit of SOFT_SYNC RPCs that will trigger a soft sync */
190 unsigned int ofd_soft_sync_limit;
191 /* Protect ::ofd_lastid_rebuilding */
192 struct rw_semaphore ofd_lastid_rwsem;
193 __u64 ofd_lastid_gen;
194 struct ptlrpc_thread ofd_inconsistency_thread;
195 struct list_head ofd_inconsistency_list;
196 spinlock_t ofd_inconsistency_lock;
199 static inline struct ofd_device *ofd_dev(struct lu_device *d)
201 return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
204 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
206 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
209 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
211 return ofd_dev(exp->exp_obd->obd_lu_dev);
214 static inline char *ofd_name(struct ofd_device *ofd)
216 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
220 struct lu_object_header ofo_header;
221 struct dt_object ofo_obj;
222 struct lu_fid ofo_pfid;
223 unsigned int ofo_pfid_checking:1,
227 static inline struct ofd_object *ofd_obj(struct lu_object *o)
229 return container_of0(o, struct ofd_object, ofo_obj.do_lu);
232 static inline int ofd_object_exists(struct ofd_object *obj)
234 LASSERT(obj != NULL);
235 if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
237 return lu_object_exists(&obj->ofo_obj.do_lu);
240 static inline struct dt_object *fo2dt(struct ofd_object *obj)
242 return &obj->ofo_obj;
245 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
247 struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
249 return container_of0(lu_object_next(lu), struct dt_object, do_lu);
252 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
254 return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
257 static inline void ofd_read_lock(const struct lu_env *env,
258 struct ofd_object *fo)
260 struct dt_object *next = ofd_object_child(fo);
262 next->do_ops->do_read_lock(env, next, 0);
265 static inline void ofd_read_unlock(const struct lu_env *env,
266 struct ofd_object *fo)
268 struct dt_object *next = ofd_object_child(fo);
270 next->do_ops->do_read_unlock(env, next);
273 static inline void ofd_write_lock(const struct lu_env *env,
274 struct ofd_object *fo)
276 struct dt_object *next = ofd_object_child(fo);
278 next->do_ops->do_write_lock(env, next, 0);
281 static inline void ofd_write_unlock(const struct lu_env *env,
282 struct ofd_object *fo)
284 struct dt_object *next = ofd_object_child(fo);
286 next->do_ops->do_write_unlock(env, next);
290 * Common data shared by obdofd-level handlers. This is allocated per-thread
291 * to reduce stack consumption.
293 struct ofd_thread_info {
294 const struct lu_env *fti_env;
296 struct obd_export *fti_exp;
298 __u64 fti_pre_version;
300 struct lu_fid fti_fid;
301 struct lu_attr fti_attr;
302 struct lu_attr fti_attr2;
303 struct ldlm_res_id fti_resid;
305 struct filter_fid fti_mds_fid;
306 struct filter_fid_old fti_mds_fid_old;
308 struct ost_id fti_ostid;
309 struct ofd_object *fti_obj;
311 char name[64]; /* for ofd_init0() */
312 struct obd_statfs osfs; /* for obdofd_statfs() */
315 /* Ops object filename */
316 struct lu_name fti_name;
317 struct dt_object_format fti_dof;
318 struct lu_buf fti_buf;
321 /* Space used by the I/O, used by grant code */
322 unsigned long fti_used;
323 struct ost_lvb fti_lvb;
324 struct lfsck_request fti_lr;
327 extern void target_recovery_fini(struct obd_device *obd);
328 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
331 extern struct lu_context_key ofd_thread_key;
332 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
333 int ofd_fiemap_get(const struct lu_env *env, struct ofd_device *ofd,
334 struct lu_fid *fid, struct fiemap *fiemap);
337 extern struct obd_ops ofd_obd_ops;
338 int ofd_statfs_internal(const struct lu_env *env, struct ofd_device *ofd,
339 struct obd_statfs *osfs, __u64 max_age,
341 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
342 const struct lu_fid *fid, int orphan);
343 int ofd_statfs(const struct lu_env *env, struct obd_export *exp,
344 struct obd_statfs *osfs, __u64 max_age, __u32 flags);
345 int ofd_obd_disconnect(struct obd_export *exp);
348 u64 ofd_seq_last_oid(struct ofd_seq *oseq);
349 void ofd_seq_last_oid_set(struct ofd_seq *oseq, u64 id);
350 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
351 struct ofd_seq *oseq);
352 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
353 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, u64 seq);
354 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
356 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
357 struct obd_device *obd);
358 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
359 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
360 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
362 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
363 void ofd_seqs_free(const struct lu_env *env, struct ofd_device *ofd);
366 int ofd_start_inconsistency_verification_thread(struct ofd_device *ofd);
367 int ofd_stop_inconsistency_verification_thread(struct ofd_device *ofd);
368 int ofd_verify_ff(const struct lu_env *env, struct ofd_object *fo,
370 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
371 struct obdo *oa, int objcount, struct obd_ioobj *obj,
372 struct niobuf_remote *rnb, int *nr_local,
373 struct niobuf_local *lnb);
374 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
375 struct obdo *oa, int objcount, struct obd_ioobj *obj,
376 struct niobuf_remote *rnb, int npages,
377 struct niobuf_local *lnb, int old_rc);
380 struct thandle *ofd_trans_create(const struct lu_env *env,
381 struct ofd_device *ofd);
382 int ofd_trans_start(const struct lu_env *env,
383 struct ofd_device *ofd, struct ofd_object *fo,
385 void ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
386 struct thandle *th, int rc);
387 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
391 #ifdef CONFIG_PROC_FS
392 extern struct lprocfs_vars lprocfs_ofd_obd_vars[];
393 void ofd_stats_counter_init(struct lprocfs_stats *stats);
395 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
399 struct ofd_object *ofd_object_find(const struct lu_env *env,
400 struct ofd_device *ofd,
401 const struct lu_fid *fid);
402 int ofd_object_ff_load(const struct lu_env *env, struct ofd_object *fo);
403 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
404 u64 id, struct ofd_seq *oseq, int nr, int sync);
406 void ofd_object_put(const struct lu_env *env, struct ofd_object *fo);
407 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
408 struct lu_attr *la, struct filter_fid *ff);
409 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
410 __u64 start, __u64 end, struct lu_attr *la,
411 struct filter_fid *ff, struct obdo *oa);
412 int ofd_object_destroy(const struct lu_env *, struct ofd_object *, int);
413 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
415 int ofd_attr_handle_ugid(const struct lu_env *env, struct ofd_object *fo,
416 struct lu_attr *la, int is_setattr);
419 struct ofd_object *ofd_object_find_exists(const struct lu_env *env,
420 struct ofd_device *ofd,
421 const struct lu_fid *fid)
423 struct ofd_object *fo;
425 fo = ofd_object_find(env, ofd, fid);
426 if (!IS_ERR(fo) && !ofd_object_exists(fo)) {
427 ofd_object_put(env, fo);
428 fo = ERR_PTR(-ENOENT);
434 #define OFD_GRANT_RATIO_SHIFT 8
435 static inline u64 ofd_grant_reserved(struct ofd_device *ofd, u64 bavail)
437 return (bavail * ofd->ofd_grant_ratio) >> OFD_GRANT_RATIO_SHIFT;
440 static inline int ofd_grant_ratio_conv(int percentage)
442 return (percentage << OFD_GRANT_RATIO_SHIFT) / 100;
445 static inline int ofd_grant_param_supp(struct obd_export *exp)
447 return !!(exp_connect_flags(exp) & OBD_CONNECT_GRANT_PARAM);
450 /* Blocksize used for client not supporting OBD_CONNECT_GRANT_PARAM.
451 * That's 4KB=2^12 which is the biggest block size known to work whatever
452 * the client's page size is. */
453 #define COMPAT_BSIZE_SHIFT 12
454 static inline int ofd_grant_compat(struct obd_export *exp,
455 struct ofd_device *ofd)
457 /* Clients which don't support OBD_CONNECT_GRANT_PARAM cannot handle
458 * a block size > page size and consume PAGE_CACHE_SIZE of grant when
459 * dirtying a page regardless of the block size */
460 return !!(ofd_obd(ofd)->obd_self_export != exp &&
461 ofd->ofd_blockbits > COMPAT_BSIZE_SHIFT &&
462 !ofd_grant_param_supp(exp));
465 static inline int ofd_grant_prohibit(struct obd_export *exp,
466 struct ofd_device *ofd)
468 /* When ofd_grant_compat_disable is set, we don't grant any space to
469 * clients not supporting OBD_CONNECT_GRANT_PARAM.
470 * Otherwise, space granted to such a client is inflated since it
471 * consumes PAGE_CACHE_SIZE of grant space per block */
472 return !!(ofd_grant_compat(exp, ofd) && ofd->ofd_grant_compat_disable);
475 void ofd_grant_sanity_check(struct obd_device *obd, const char *func);
476 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
477 u64 want, bool new_conn);
478 void ofd_grant_discard(struct obd_export *exp);
479 void ofd_grant_prepare_read(const struct lu_env *env, struct obd_export *exp,
481 void ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp,
482 struct obdo *oa, struct niobuf_remote *rnb,
484 void ofd_grant_commit(struct obd_export *exp, unsigned long grant_used, int rc);
485 int ofd_grant_commit_cb_add(struct thandle *th, struct obd_export *exp,
486 unsigned long grant);
487 long ofd_grant_create(const struct lu_env *env, struct obd_export *exp,
491 int ofd_fmd_init(void);
492 void ofd_fmd_exit(void);
493 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
494 const struct lu_fid *fid);
495 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
496 const struct lu_fid *fid);
497 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
498 void ofd_fmd_expire(struct obd_export *exp);
499 void ofd_fmd_cleanup(struct obd_export *exp);
501 void ofd_fmd_drop(struct obd_export *exp, const struct lu_fid *fid);
503 #define ofd_fmd_drop(exp, fid) do {} while (0)
507 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
509 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
510 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
513 extern struct ldlm_valblock_ops ofd_lvbo;
516 int ofd_intent_policy(struct ldlm_namespace *ns, struct ldlm_lock **lockp,
517 void *req_cookie, enum ldlm_mode mode, __u64 flags,
520 static inline struct ofd_thread_info *ofd_info(const struct lu_env *env)
522 struct ofd_thread_info *info;
524 lu_env_refill((void *)env);
525 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
530 static inline struct ofd_thread_info *ofd_info_init(const struct lu_env *env,
531 struct obd_export *exp)
533 struct ofd_thread_info *info;
535 info = ofd_info(env);
536 LASSERT(info->fti_exp == NULL);
537 LASSERT(info->fti_env == NULL);
538 LASSERT(info->fti_attr.la_valid == 0);
542 info->fti_pre_version = 0;
546 static inline struct ofd_thread_info *tsi2ofd_info(struct tgt_session_info *tsi)
548 struct ptlrpc_request *req = tgt_ses_req(tsi);
549 struct ofd_thread_info *info;
551 info = ofd_info(tsi->tsi_env);
552 LASSERT(info->fti_exp == NULL);
553 LASSERT(info->fti_env == NULL);
554 LASSERT(info->fti_attr.la_valid == 0);
556 info->fti_env = tsi->tsi_env;
557 info->fti_exp = tsi->tsi_exp;
559 info->fti_xid = req->rq_xid;
560 /** VBR: take versions from request */
561 if (req->rq_reqmsg != NULL &&
562 lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
563 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
565 info->fti_pre_version = pre_version ? pre_version[0] : 0;
570 /* sync on lock cancel is useless when we force a journal flush,
571 * and if we enable async journal commit, we should also turn on
572 * sync on lock cancel if it is not enabled already. */
573 static inline void ofd_slc_set(struct ofd_device *ofd)
575 if (ofd->ofd_syncjournal == 1)
576 ofd->ofd_lut.lut_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
577 else if (ofd->ofd_lut.lut_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
578 ofd->ofd_lut.lut_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
581 static inline void ofd_prepare_fidea(struct filter_fid *ff,
582 const struct obdo *oa)
584 /* packing fid and converting it to LE for storing into EA.
585 * Here ->o_stripe_idx should be filled by LOV and rest of
586 * fields - by client. */
587 ff->ff_parent.f_seq = cpu_to_le64(oa->o_parent_seq);
588 ff->ff_parent.f_oid = cpu_to_le32(oa->o_parent_oid);
589 /* XXX: we are ignoring o_parent_ver here, since this should
590 * be the same for all objects in this fileset. */
591 ff->ff_parent.f_ver = cpu_to_le32(oa->o_stripe_idx);
594 #endif /* _OFD_INTERNAL_H */