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, 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 <lustre_fid.h>
45 #include <lustre_capa.h>
47 #define OFD_INIT_OBJID 0
48 #define OFD_ROCOMPAT_SUPP (0)
49 #define OFD_INCOMPAT_SUPP (OBD_INCOMPAT_GROUPS | OBD_INCOMPAT_OST | \
50 OBD_INCOMPAT_COMMON_LR)
51 #define OFD_PRECREATE_BATCH_DEFAULT (FILTER_SUBDIR_COUNT * 4)
53 /* on small filesystems we should not precreate too many objects in
54 * a single transaction, otherwise we can overflow transactions */
55 #define OFD_PRECREATE_SMALL_FS (1024ULL * 1024 * 1024)
56 #define OFD_PRECREATE_BATCH_SMALL 8
58 /* Limit the returned fields marked valid to those that we actually might set */
59 #define OFD_VALID_FLAGS (LA_TYPE | LA_MODE | LA_SIZE | LA_BLOCKS | \
60 LA_BLKSIZE | LA_ATIME | LA_MTIME | LA_CTIME)
62 /* per-client-per-object persistent state (LRU) */
64 cfs_list_t fmd_list; /* linked to fed_mod_list */
65 struct lu_fid fmd_fid; /* FID being written to */
66 __u64 fmd_mactime_xid; /* xid highest {m,a,c}time setattr */
67 cfs_time_t fmd_expire; /* time when the fmd should expire */
68 int fmd_refcount; /* reference counter - list holds 1 */
71 #define OFD_FMD_MAX_NUM_DEFAULT 128
72 #define OFD_FMD_MAX_AGE_DEFAULT ((obd_timeout + 10) * CFS_HZ)
75 LPROC_OFD_READ_BYTES = 0,
76 LPROC_OFD_WRITE_BYTES = 1,
82 LPROC_OFD_STATS_READ = 0,
83 LPROC_OFD_STATS_WRITE = 1,
84 LPROC_OFD_STATS_SETATTR = 2,
85 LPROC_OFD_STATS_PUNCH = 3,
86 LPROC_OFD_STATS_SYNC = 4,
90 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
91 char *jobid, long amount)
93 if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
94 (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
95 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
97 if (exp->exp_nid_stats != NULL &&
98 exp->exp_nid_stats->nid_stats != NULL) {
99 if (opcode == LPROC_OFD_STATS_READ)
100 lprocfs_counter_add(exp->exp_nid_stats->nid_stats,
101 LPROC_OFD_READ_BYTES, amount);
102 else if (opcode == LPROC_OFD_STATS_WRITE)
103 lprocfs_counter_add(exp->exp_nid_stats->nid_stats,
104 LPROC_OFD_WRITE_BYTES, amount);
111 spinlock_t os_last_oid_lock;
112 struct mutex os_create_lock;
113 cfs_atomic_t os_refc;
114 struct dt_object *os_lastid_obj;
115 unsigned long os_destroys_in_progress:1;
118 #define os_seq os_oi.oi_seq
119 #define os_last_oid os_oi.oi_id
122 struct dt_device ofd_dt_dev;
123 struct dt_device *ofd_osd;
124 struct obd_export *ofd_osd_exp;
125 struct dt_device_param ofd_dt_conf;
126 /* DLM name-space for meta-data locks maintained by this server */
127 struct ldlm_namespace *ofd_namespace;
129 /* transaction callbacks */
130 struct dt_txn_callback ofd_txn_cb;
133 struct lu_target ofd_lut;
134 struct dt_object *ofd_health_check_file;
136 int ofd_subdir_count;
138 cfs_list_t ofd_seq_list;
139 rwlock_t ofd_seq_list_lock;
141 int ofd_precreate_batch;
142 spinlock_t ofd_batch_lock;
144 /* protect all statfs-related counters */
145 spinlock_t ofd_osfs_lock;
146 /* statfs optimization: we cache a bit */
147 struct obd_statfs ofd_osfs;
150 /* writes which might be be accounted twice in ofd_osfs.os_bavail */
151 obd_size ofd_osfs_unstable;
153 /* counters used during statfs update, protected by ofd_osfs_lock.
154 * record when some statfs refresh are in progress */
155 int ofd_statfs_inflight;
156 /* track writes completed while statfs refresh is underway.
157 * tracking is only effective when ofd_statfs_inflight > 1 */
158 obd_size ofd_osfs_inflight;
160 /* grants: all values in bytes */
161 /* grant lock to protect all grant counters */
162 spinlock_t ofd_grant_lock;
163 /* total amount of dirty data reported by clients in incoming obdo */
164 obd_size ofd_tot_dirty;
165 /* sum of filesystem space granted to clients for async writes */
166 obd_size ofd_tot_granted;
167 /* grant used by I/Os in progress (between prepare and commit) */
168 obd_size ofd_tot_pending;
169 /* free space threshold over which we stop granting space to clients
170 * ofd_grant_ratio is stored as a fixed-point fraction using
171 * OFD_GRANT_RATIO_SHIFT of the remaining free space, not in percentage
174 /* number of clients using grants */
175 int ofd_tot_granted_clients;
177 /* ofd mod data: ofd_device wide values */
178 int ofd_fmd_max_num; /* per ofd ofd_mod_data */
179 cfs_duration_t ofd_fmd_max_age; /* time to fmd expiry */
181 spinlock_t ofd_flags_lock;
182 unsigned long ofd_raid_degraded:1,
183 /* sync journal on writes */
185 /* sync on lock cancel */
186 ofd_sync_lock_cancel:2,
187 /* shall we grant space to clients not
188 * supporting OBD_CONNECT_GRANT_PARAM? */
189 ofd_grant_compat_disable:1;
190 struct seq_server_site ofd_seq_site;
193 static inline struct ofd_device *ofd_dev(struct lu_device *d)
195 return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
198 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
200 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
203 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
205 return ofd_dev(exp->exp_obd->obd_lu_dev);
208 static inline char *ofd_name(struct ofd_device *ofd)
210 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
214 struct lu_object_header ofo_header;
215 struct dt_object ofo_obj;
219 static inline struct ofd_object *ofd_obj(struct lu_object *o)
221 return container_of0(o, struct ofd_object, ofo_obj.do_lu);
224 static inline int ofd_object_exists(struct ofd_object *obj)
226 LASSERT(obj != NULL);
227 if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
229 return lu_object_exists(&obj->ofo_obj.do_lu);
232 static inline struct dt_object *fo2dt(struct ofd_object *obj)
234 return &obj->ofo_obj;
237 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
239 struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
241 return container_of0(lu_object_next(lu), struct dt_object, do_lu);
244 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
246 return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
249 static inline struct lustre_capa *ofd_object_capa(const struct lu_env *env,
250 const struct ofd_object *obj)
252 /* TODO: see mdd_object_capa() */
256 static inline void ofd_read_lock(const struct lu_env *env,
257 struct ofd_object *fo)
259 struct dt_object *next = ofd_object_child(fo);
261 next->do_ops->do_read_lock(env, next, 0);
264 static inline void ofd_read_unlock(const struct lu_env *env,
265 struct ofd_object *fo)
267 struct dt_object *next = ofd_object_child(fo);
269 next->do_ops->do_read_unlock(env, next);
272 static inline void ofd_write_lock(const struct lu_env *env,
273 struct ofd_object *fo)
275 struct dt_object *next = ofd_object_child(fo);
277 next->do_ops->do_write_lock(env, next, 0);
280 static inline void ofd_write_unlock(const struct lu_env *env,
281 struct ofd_object *fo)
283 struct dt_object *next = ofd_object_child(fo);
285 next->do_ops->do_write_unlock(env, next);
289 * Common data shared by obdofd-level handlers. This is allocated per-thread
290 * to reduce stack consumption.
292 struct ofd_thread_info {
293 const struct lu_env *fti_env;
295 struct obd_export *fti_exp;
298 __u64 fti_pre_version;
299 __u32 fti_has_trans:1, /* has txn already */
302 struct lu_fid fti_fid;
303 struct lu_attr fti_attr;
304 struct lu_attr fti_attr2;
305 struct ldlm_res_id fti_resid;
306 struct filter_fid fti_mds_fid;
307 struct filter_fid fti_mds_fid2;
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;
326 extern void target_recovery_fini(struct obd_device *obd);
327 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
330 int ofd_update_capa_key(struct ofd_device *ofd, struct lustre_capa_key *key);
331 int ofd_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
332 struct lustre_capa *capa, __u64 opc);
333 void ofd_free_capa_keys(struct ofd_device *ofd);
336 extern struct lu_context_key ofd_thread_key;
337 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
340 extern struct obd_ops ofd_obd_ops;
341 int ofd_statfs_internal(const struct lu_env *env, struct ofd_device *ofd,
342 struct obd_statfs *osfs, __u64 max_age,
346 obd_id ofd_seq_last_oid(struct ofd_seq *oseq);
347 void ofd_seq_last_oid_set(struct ofd_seq *oseq, obd_id id);
348 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
349 struct ofd_seq *oseq);
350 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
351 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, obd_seq seq);
352 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
354 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
355 struct obd_device *obd);
356 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
357 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
358 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
360 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
363 int ofd_preprw(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 *nr_local,
366 struct niobuf_local *lnb, struct obd_trans_info *oti,
367 struct lustre_capa *capa);
368 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
369 struct obdo *oa, int objcount, struct obd_ioobj *obj,
370 struct niobuf_remote *rnb, int npages,
371 struct niobuf_local *lnb, struct obd_trans_info *oti,
375 struct thandle *ofd_trans_create(const struct lu_env *env,
376 struct ofd_device *ofd);
377 int ofd_trans_start(const struct lu_env *env,
378 struct ofd_device *ofd, struct ofd_object *fo,
380 void ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
381 struct thandle *th, int rc);
382 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
387 void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars);
388 int lproc_ofd_attach_seqstat(struct obd_device *dev);
389 extern struct file_operations ofd_per_nid_stats_fops;
390 void ofd_stats_counter_init(struct lprocfs_stats *stats);
392 static void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars)
394 memset(lvars, 0, sizeof(*lvars));
396 static inline int lproc_ofd_attach_seqstat(struct obd_device *dev) {}
397 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
401 struct ofd_object *ofd_object_find(const struct lu_env *env,
402 struct ofd_device *ofd,
403 const struct lu_fid *fid);
404 struct ofd_object *ofd_object_find_or_create(const struct lu_env *env,
405 struct ofd_device *ofd,
406 const struct lu_fid *fid,
407 struct lu_attr *attr);
408 int ofd_object_ff_check(const struct lu_env *env, struct ofd_object *fo);
409 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
410 obd_id id, struct ofd_seq *oseq, int nr, int sync);
412 void ofd_object_put(const struct lu_env *env, struct ofd_object *fo);
413 int ofd_attr_set(const struct lu_env *env, struct ofd_object *fo,
414 struct lu_attr *la, struct filter_fid *ff);
415 int ofd_object_punch(const struct lu_env *env, struct ofd_object *fo,
416 __u64 start, __u64 end, struct lu_attr *la,
417 struct filter_fid *ff);
418 int ofd_object_destroy(const struct lu_env *, struct ofd_object *, int);
419 int ofd_attr_get(const struct lu_env *env, struct ofd_object *fo,
421 int ofd_attr_handle_ugid(const struct lu_env *env, struct ofd_object *fo,
422 struct lu_attr *la, int is_setattr);
425 #define OFD_GRANT_RATIO_SHIFT 8
426 static inline __u64 ofd_grant_reserved(struct ofd_device *ofd, obd_size bavail)
428 return (bavail * ofd->ofd_grant_ratio) >> OFD_GRANT_RATIO_SHIFT;
431 static inline int ofd_grant_ratio_conv(int percentage)
433 return (percentage << OFD_GRANT_RATIO_SHIFT) / 100;
436 static inline int ofd_grant_param_supp(struct obd_export *exp)
438 return !!(exp_connect_flags(exp) & OBD_CONNECT_GRANT_PARAM);
441 /* Blocksize used for client not supporting OBD_CONNECT_GRANT_PARAM.
442 * That's 4KB=2^12 which is the biggest block size known to work whatever
443 * the client's page size is. */
444 #define COMPAT_BSIZE_SHIFT 12
445 static inline int ofd_grant_compat(struct obd_export *exp,
446 struct ofd_device *ofd)
448 /* Clients which don't support OBD_CONNECT_GRANT_PARAM cannot handle
449 * a block size > page size and consume CFS_PAGE_SIZE of grant when
450 * dirtying a page regardless of the block size */
451 return !!(ofd_obd(ofd)->obd_self_export != exp &&
452 ofd->ofd_blockbits > COMPAT_BSIZE_SHIFT &&
453 !ofd_grant_param_supp(exp));
456 static inline int ofd_grant_prohibit(struct obd_export *exp,
457 struct ofd_device *ofd)
459 /* When ofd_grant_compat_disable is set, we don't grant any space to
460 * clients not supporting OBD_CONNECT_GRANT_PARAM.
461 * Otherwise, space granted to such a client is inflated since it
462 * consumes CFS_PAGE_SIZE of grant space per block */
463 return !!(ofd_grant_compat(exp, ofd) && ofd->ofd_grant_compat_disable);
466 void ofd_grant_sanity_check(struct obd_device *obd, const char *func);
467 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
469 void ofd_grant_discard(struct obd_export *exp);
470 void ofd_grant_prepare_read(const struct lu_env *env, struct obd_export *exp,
472 void ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp,
473 struct obdo *oa, struct niobuf_remote *rnb,
475 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp, int rc);
476 int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr);
479 int ofd_fmd_init(void);
480 void ofd_fmd_exit(void);
481 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
483 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
485 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
486 void ofd_fmd_expire(struct obd_export *exp);
487 void ofd_fmd_cleanup(struct obd_export *exp);
489 void ofd_fmd_drop(struct obd_export *exp, struct lu_fid *fid);
491 #define ofd_fmd_drop(exp, fid) do {} while (0)
495 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
497 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
498 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
501 extern struct ldlm_valblock_ops ofd_lvbo;
504 int ofd_intent_policy(struct ldlm_namespace *ns, struct ldlm_lock **lockp,
505 void *req_cookie, ldlm_mode_t mode, __u64 flags,
508 static inline struct ofd_thread_info * ofd_info(const struct lu_env *env)
510 struct ofd_thread_info *info;
512 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
514 LASSERT(info->fti_env);
515 LASSERT(info->fti_env == env);
519 static inline struct ofd_thread_info * ofd_info_init(const struct lu_env *env,
520 struct obd_export *exp)
522 struct ofd_thread_info *info;
524 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
526 LASSERT(info->fti_exp == NULL);
527 LASSERT(info->fti_env == NULL);
528 LASSERT(info->fti_attr.la_valid == 0);
532 info->fti_pre_version = 0;
533 info->fti_transno = 0;
534 info->fti_has_trans = 0;
538 /* The same as osc_build_res_name() */
539 static inline void ofd_build_resid(const struct lu_fid *fid,
540 struct ldlm_res_id *resname)
544 if (fid_is_idif(fid)) {
545 oid.oi_id = fid_idif_id(fid_seq(fid), fid_oid(fid),
547 oid.oi_seq = FID_SEQ_OST_MDT0;
549 oid.oi_id = fid_oid(fid);
550 oid.oi_seq = fid_seq(fid);
552 ostid_build_res_name(&oid, resname);
555 static inline void ofd_fid_from_resid(struct lu_fid *fid,
556 const struct ldlm_res_id *name)
558 /* To keep compatiblity, res[0] = oi_id, res[1] = oi_seq. */
561 ostid.oi_id = name->name[LUSTRE_RES_ID_SEQ_OFF];
562 ostid.oi_seq = name->name[LUSTRE_RES_ID_VER_OID_OFF];
563 fid_ostid_unpack(fid, &ostid, 0);
566 static inline void ofd_oti2info(struct ofd_thread_info *info,
567 struct obd_trans_info *oti)
569 info->fti_xid = oti->oti_xid;
570 info->fti_transno = oti->oti_transno;
571 info->fti_pre_version = oti->oti_pre_version;
574 static inline void ofd_info2oti(struct ofd_thread_info *info,
575 struct obd_trans_info *oti)
577 oti->oti_xid = info->fti_xid;
578 LASSERTF(ergo(oti->oti_transno > 0,
579 oti->oti_transno == info->fti_transno),
580 "Overwrite replay transno "LPX64" by "LPX64"\n",
581 oti->oti_transno, info->fti_transno);
582 oti->oti_transno = info->fti_transno;
583 oti->oti_pre_version = info->fti_pre_version;
586 /* sync on lock cancel is useless when we force a journal flush,
587 * and if we enable async journal commit, we should also turn on
588 * sync on lock cancel if it is not enabled already. */
589 static inline void ofd_slc_set(struct ofd_device *ofd)
591 if (ofd->ofd_syncjournal == 1)
592 ofd->ofd_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
593 else if (ofd->ofd_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
594 ofd->ofd_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
597 static inline void ofd_prepare_fidea(struct filter_fid *ff, struct obdo *oa)
599 if (!(oa->o_valid & OBD_MD_FLGROUP))
601 /* packing fid and converting it to LE for storing into EA.
602 * Here ->o_stripe_idx should be filled by LOV and rest of
603 * fields - by client. */
604 ff->ff_parent.f_seq = cpu_to_le64(oa->o_parent_seq);
605 ff->ff_parent.f_oid = cpu_to_le32(oa->o_parent_oid);
606 /* XXX: we are ignoring o_parent_ver here, since this should
607 * be the same for all objects in this fileset. */
608 ff->ff_parent.f_ver = cpu_to_le32(oa->o_stripe_idx);
609 ff->ff_objid = cpu_to_le64(oa->o_id);
610 ff->ff_seq = cpu_to_le64(oa->o_seq);
613 /* niobuf_remote has no rnb_ prefix in master */
614 #define rnb_offset offset
615 #define rnb_flags flags
617 /* the same for niobuf_local */
618 #define lnb_flags flags
621 #endif /* _OFD_INTERNAL_H */