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, 2013, 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 #include <lustre_capa.h>
48 #define OFD_INIT_OBJID 0
49 #define OFD_ROCOMPAT_SUPP (0)
50 #define OFD_INCOMPAT_SUPP (OBD_INCOMPAT_GROUPS | OBD_INCOMPAT_OST | \
51 OBD_INCOMPAT_COMMON_LR)
52 #define OFD_PRECREATE_BATCH_DEFAULT (OBJ_SUBDIR_COUNT * 4)
54 /* on small filesystems we should not precreate too many objects in
55 * a single transaction, otherwise we can overflow transactions */
56 #define OFD_PRECREATE_SMALL_FS (1024ULL * 1024 * 1024)
57 #define OFD_PRECREATE_BATCH_SMALL 8
59 /* Limit the returned fields marked valid to those that we actually might set */
60 #define OFD_VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
61 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
63 /* per-client-per-object persistent state (LRU) */
65 cfs_list_t fmd_list; /* linked to fed_mod_list */
66 struct lu_fid fmd_fid; /* FID being written to */
67 __u64 fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
68 cfs_time_t fmd_expire; /* time when the fmd should expire */
69 int fmd_refcount; /* reference counter - list holds 1 */
72 #define OFD_FMD_MAX_NUM_DEFAULT 128
73 #define OFD_FMD_MAX_AGE_DEFAULT ((obd_timeout + 10) * HZ)
77 LPROC_OFD_STATS_READ = 0,
78 LPROC_OFD_STATS_WRITE,
79 LPROC_OFD_STATS_GETATTR,
80 LPROC_OFD_STATS_SETATTR,
81 LPROC_OFD_STATS_PUNCH,
83 LPROC_OFD_STATS_DESTROY,
84 LPROC_OFD_STATS_CREATE,
85 LPROC_OFD_STATS_STATFS,
86 LPROC_OFD_STATS_GET_INFO,
87 LPROC_OFD_STATS_SET_INFO,
88 LPROC_OFD_STATS_QUOTACTL,
92 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
93 char *jobid, long amount)
95 if (exp->exp_obd && exp->exp_obd->obd_stats)
96 lprocfs_counter_add(exp->exp_obd->obd_stats, opcode, amount);
98 if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
99 (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
100 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
102 if (exp->exp_nid_stats != NULL &&
103 exp->exp_nid_stats->nid_stats != NULL) {
104 lprocfs_counter_add(exp->exp_nid_stats->nid_stats, opcode,
112 spinlock_t os_last_oid_lock;
113 struct mutex os_create_lock;
114 cfs_atomic_t os_refc;
115 struct dt_object *os_lastid_obj;
116 unsigned long os_destroys_in_progress:1;
120 struct dt_device ofd_dt_dev;
121 struct dt_device *ofd_osd;
122 struct obd_export *ofd_osd_exp;
123 struct dt_device_param ofd_dt_conf;
124 /* DLM name-space for meta-data locks maintained by this server */
125 struct ldlm_namespace *ofd_namespace;
128 struct lu_target ofd_lut;
129 struct dt_object *ofd_health_check_file;
131 int ofd_subdir_count;
133 cfs_list_t ofd_seq_list;
134 rwlock_t ofd_seq_list_lock;
136 int ofd_precreate_batch;
137 spinlock_t ofd_batch_lock;
139 /* protect all statfs-related counters */
140 spinlock_t ofd_osfs_lock;
141 /* statfs optimization: we cache a bit */
142 struct obd_statfs ofd_osfs;
145 /* writes which might be be accounted twice in ofd_osfs.os_bavail */
146 obd_size 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 obd_size 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 */
159 obd_size ofd_tot_dirty;
160 /* sum of filesystem space granted to clients for async writes */
161 obd_size ofd_tot_granted;
162 /* grant used by I/Os in progress (between prepare and commit) */
163 obd_size ofd_tot_pending;
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 struct seq_server_site ofd_seq_site;
186 static inline struct ofd_device *ofd_dev(struct lu_device *d)
188 return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
191 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
193 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
196 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
198 return ofd_dev(exp->exp_obd->obd_lu_dev);
201 static inline char *ofd_name(struct ofd_device *ofd)
203 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
207 struct lu_object_header ofo_header;
208 struct dt_object ofo_obj;
212 static inline struct ofd_object *ofd_obj(struct lu_object *o)
214 return container_of0(o, struct ofd_object, ofo_obj.do_lu);
217 static inline int ofd_object_exists(struct ofd_object *obj)
219 LASSERT(obj != NULL);
220 if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
222 return lu_object_exists(&obj->ofo_obj.do_lu);
225 static inline struct dt_object *fo2dt(struct ofd_object *obj)
227 return &obj->ofo_obj;
230 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
232 struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
234 return container_of0(lu_object_next(lu), struct dt_object, do_lu);
237 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
239 return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
242 static inline struct lustre_capa *ofd_object_capa(const struct lu_env *env,
243 const struct ofd_object *obj)
245 /* TODO: see mdd_object_capa() */
249 static inline void ofd_read_lock(const struct lu_env *env,
250 struct ofd_object *fo)
252 struct dt_object *next = ofd_object_child(fo);
254 next->do_ops->do_read_lock(env, next, 0);
257 static inline void ofd_read_unlock(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_unlock(env, next);
265 static inline void ofd_write_lock(const struct lu_env *env,
266 struct ofd_object *fo)
268 struct dt_object *next = ofd_object_child(fo);
270 next->do_ops->do_write_lock(env, next, 0);
273 static inline void ofd_write_unlock(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_unlock(env, next);
282 * Common data shared by obdofd-level handlers. This is allocated per-thread
283 * to reduce stack consumption.
285 struct ofd_thread_info {
286 const struct lu_env *fti_env;
288 struct obd_export *fti_exp;
290 __u64 fti_pre_version;
292 struct lu_fid fti_fid;
293 struct lu_attr fti_attr;
294 struct lu_attr fti_attr2;
295 struct ldlm_res_id fti_resid;
296 struct filter_fid fti_mds_fid;
297 struct ost_id fti_ostid;
298 struct ofd_object *fti_obj;
300 char name[64]; /* for ofd_init0() */
301 struct obd_statfs osfs; /* for obdofd_statfs() */
304 /* Ops object filename */
305 struct lu_name fti_name;
306 struct dt_object_format fti_dof;
307 struct lu_buf fti_buf;
310 /* Space used by the I/O, used by grant code */
311 unsigned long fti_used;
312 struct ost_lvb fti_lvb;
315 extern void target_recovery_fini(struct obd_device *obd);
316 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
319 int ofd_update_capa_key(struct ofd_device *ofd, struct lustre_capa_key *key);
320 int ofd_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
321 struct lustre_capa *capa, __u64 opc);
322 void ofd_free_capa_keys(struct ofd_device *ofd);
325 extern struct lu_context_key ofd_thread_key;
326 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
329 extern struct obd_ops ofd_obd_ops;
330 int ofd_statfs_internal(const struct lu_env *env, struct ofd_device *ofd,
331 struct obd_statfs *osfs, __u64 max_age,
333 int ofd_orphans_destroy(const struct lu_env *env, struct obd_export *exp,
334 struct ofd_device *ofd, struct obdo *oa);
335 int ofd_destroy_by_fid(const struct lu_env *env, struct ofd_device *ofd,
336 const struct lu_fid *fid, int orphan);
337 int ofd_statfs(const struct lu_env *env, struct obd_export *exp,
338 struct obd_statfs *osfs, __u64 max_age, __u32 flags);
341 obd_id ofd_seq_last_oid(struct ofd_seq *oseq);
342 void ofd_seq_last_oid_set(struct ofd_seq *oseq, obd_id id);
343 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
344 struct ofd_seq *oseq);
345 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
346 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, obd_seq seq);
347 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
349 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
350 struct obd_device *obd);
351 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
352 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
353 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
355 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
358 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
359 struct obdo *oa, int objcount, struct obd_ioobj *obj,
360 struct niobuf_remote *rnb, int *nr_local,
361 struct niobuf_local *lnb, struct obd_trans_info *oti,
362 struct lustre_capa *capa);
363 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
364 struct obdo *oa, int objcount, struct obd_ioobj *obj,
365 struct niobuf_remote *rnb, int npages,
366 struct niobuf_local *lnb, struct obd_trans_info *oti,
370 struct thandle *ofd_trans_create(const struct lu_env *env,
371 struct ofd_device *ofd);
372 int ofd_trans_start(const struct lu_env *env,
373 struct ofd_device *ofd, struct ofd_object *fo,
375 void ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
376 struct thandle *th, int rc);
377 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
382 void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars);
383 void ofd_stats_counter_init(struct lprocfs_stats *stats);
385 static void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars)
387 memset(lvars, 0, sizeof(*lvars));
389 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
393 struct ofd_object *ofd_object_find(const struct lu_env *env,
394 struct ofd_device *ofd,
395 const struct lu_fid *fid);
396 struct ofd_object *ofd_object_find_or_create(const struct lu_env *env,
397 struct ofd_device *ofd,
398 const struct lu_fid *fid,
399 struct lu_attr *attr);
400 int ofd_object_ff_check(const struct lu_env *env, struct ofd_object *fo);
401 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
402 obd_id id, struct ofd_seq *oseq, int nr, int sync);
404 void ofd_object_put(const struct lu_env *env, struct ofd_object *fo);
405 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
406 struct lu_attr *la, struct filter_fid *ff);
407 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
408 __u64 start, __u64 end, struct lu_attr *la,
409 struct filter_fid *ff);
410 int ofd_object_destroy(const struct lu_env *, struct ofd_object *, int);
411 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
413 int ofd_attr_handle_ugid(const struct lu_env *env, struct ofd_object *fo,
414 struct lu_attr *la, int is_setattr);
417 struct ofd_object *ofd_object_find_exists(const struct lu_env *env,
418 struct ofd_device *ofd,
421 struct ofd_object *fo;
423 fo = ofd_object_find(env, ofd, fid);
424 if (!IS_ERR(fo) && !ofd_object_exists(fo)) {
425 ofd_object_put(env, fo);
426 fo = ERR_PTR(-ENOENT);
432 #define OFD_GRANT_RATIO_SHIFT 8
433 static inline __u64 ofd_grant_reserved(struct ofd_device *ofd, obd_size bavail)
435 return (bavail * ofd->ofd_grant_ratio) >> OFD_GRANT_RATIO_SHIFT;
438 static inline int ofd_grant_ratio_conv(int percentage)
440 return (percentage << OFD_GRANT_RATIO_SHIFT) / 100;
443 static inline int ofd_grant_param_supp(struct obd_export *exp)
445 return !!(exp_connect_flags(exp) & OBD_CONNECT_GRANT_PARAM);
448 /* Blocksize used for client not supporting OBD_CONNECT_GRANT_PARAM.
449 * That's 4KB=2^12 which is the biggest block size known to work whatever
450 * the client's page size is. */
451 #define COMPAT_BSIZE_SHIFT 12
452 static inline int ofd_grant_compat(struct obd_export *exp,
453 struct ofd_device *ofd)
455 /* Clients which don't support OBD_CONNECT_GRANT_PARAM cannot handle
456 * a block size > page size and consume PAGE_CACHE_SIZE of grant when
457 * dirtying a page regardless of the block size */
458 return !!(ofd_obd(ofd)->obd_self_export != exp &&
459 ofd->ofd_blockbits > COMPAT_BSIZE_SHIFT &&
460 !ofd_grant_param_supp(exp));
463 static inline int ofd_grant_prohibit(struct obd_export *exp,
464 struct ofd_device *ofd)
466 /* When ofd_grant_compat_disable is set, we don't grant any space to
467 * clients not supporting OBD_CONNECT_GRANT_PARAM.
468 * Otherwise, space granted to such a client is inflated since it
469 * consumes PAGE_CACHE_SIZE of grant space per block */
470 return !!(ofd_grant_compat(exp, ofd) && ofd->ofd_grant_compat_disable);
473 void ofd_grant_sanity_check(struct obd_device *obd, const char *func);
474 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
475 obd_size want, bool conservative);
476 void ofd_grant_discard(struct obd_export *exp);
477 void ofd_grant_prepare_read(const struct lu_env *env, struct obd_export *exp,
479 void ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp,
480 struct obdo *oa, struct niobuf_remote *rnb,
482 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp, int rc);
483 int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr);
486 int ofd_fmd_init(void);
487 void ofd_fmd_exit(void);
488 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
490 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
492 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
493 void ofd_fmd_expire(struct obd_export *exp);
494 void ofd_fmd_cleanup(struct obd_export *exp);
496 void ofd_fmd_drop(struct obd_export *exp, struct lu_fid *fid);
498 #define ofd_fmd_drop(exp, fid) do {} while (0)
502 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
504 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
505 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
508 extern struct ldlm_valblock_ops ofd_lvbo;
511 int ofd_intent_policy(struct ldlm_namespace *ns, struct ldlm_lock **lockp,
512 void *req_cookie, ldlm_mode_t mode, __u64 flags,
515 static inline struct ofd_thread_info *ofd_info(const struct lu_env *env)
517 struct ofd_thread_info *info;
519 lu_env_refill((void *)env);
520 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
525 static inline struct ofd_thread_info *ofd_info_init(const struct lu_env *env,
526 struct obd_export *exp)
528 struct ofd_thread_info *info;
530 info = ofd_info(env);
531 LASSERT(info->fti_exp == NULL);
532 LASSERT(info->fti_env == NULL);
533 LASSERT(info->fti_attr.la_valid == 0);
537 info->fti_pre_version = 0;
541 static inline struct ofd_thread_info *tsi2ofd_info(struct tgt_session_info *tsi)
543 struct ptlrpc_request *req = tgt_ses_req(tsi);
544 struct ofd_thread_info *info;
546 info = ofd_info(tsi->tsi_env);
547 LASSERT(info->fti_exp == NULL);
548 LASSERT(info->fti_env == NULL);
549 LASSERT(info->fti_attr.la_valid == 0);
551 info->fti_env = tsi->tsi_env;
552 info->fti_exp = tsi->tsi_exp;
554 info->fti_xid = req->rq_xid;
555 /** VBR: take versions from request */
556 if (req->rq_reqmsg != NULL &&
557 lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY) {
558 __u64 *pre_version = lustre_msg_get_versions(req->rq_reqmsg);
560 info->fti_pre_version = pre_version ? pre_version[0] : 0;
565 static inline void ofd_oti2info(struct ofd_thread_info *info,
566 struct obd_trans_info *oti)
568 info->fti_xid = oti->oti_xid;
569 info->fti_pre_version = oti->oti_pre_version;
572 static inline void ofd_info2oti(struct ofd_thread_info *info,
573 struct obd_trans_info *oti)
575 oti->oti_xid = info->fti_xid;
576 oti->oti_pre_version = info->fti_pre_version;
579 /* sync on lock cancel is useless when we force a journal flush,
580 * and if we enable async journal commit, we should also turn on
581 * sync on lock cancel if it is not enabled already. */
582 static inline void ofd_slc_set(struct ofd_device *ofd)
584 if (ofd->ofd_syncjournal == 1)
585 ofd->ofd_lut.lut_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
586 else if (ofd->ofd_lut.lut_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
587 ofd->ofd_lut.lut_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
590 static inline void ofd_prepare_fidea(struct filter_fid *ff,
591 const struct obdo *oa)
593 /* packing fid and converting it to LE for storing into EA.
594 * Here ->o_stripe_idx should be filled by LOV and rest of
595 * fields - by client. */
596 ff->ff_parent.f_seq = cpu_to_le64(oa->o_parent_seq);
597 ff->ff_parent.f_oid = cpu_to_le32(oa->o_parent_oid);
598 /* XXX: we are ignoring o_parent_ver here, since this should
599 * be the same for all objects in this fileset. */
600 ff->ff_parent.f_ver = cpu_to_le32(oa->o_stripe_idx);
603 /* niobuf_remote has no rnb_ prefix in master */
604 #define rnb_offset offset
605 #define rnb_flags flags
607 /* the same for niobuf_local */
608 #define lnb_flags flags
611 #endif /* _OFD_INTERNAL_H */