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 (FILTER_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) * CFS_HZ)
76 LPROC_OFD_READ_BYTES = 0,
77 LPROC_OFD_WRITE_BYTES = 1,
83 LPROC_OFD_STATS_READ = 0,
84 LPROC_OFD_STATS_WRITE = 1,
85 LPROC_OFD_STATS_SETATTR = 2,
86 LPROC_OFD_STATS_PUNCH = 3,
87 LPROC_OFD_STATS_SYNC = 4,
91 static inline void ofd_counter_incr(struct obd_export *exp, int opcode,
92 char *jobid, long amount)
94 if (exp->exp_obd && exp->exp_obd->u.obt.obt_jobstats.ojs_hash &&
95 (exp_connect_flags(exp) & OBD_CONNECT_JOBSTATS))
96 lprocfs_job_stats_log(exp->exp_obd, jobid, opcode, amount);
98 if (exp->exp_nid_stats != NULL &&
99 exp->exp_nid_stats->nid_stats != NULL) {
100 if (opcode == LPROC_OFD_STATS_READ)
101 lprocfs_counter_add(exp->exp_nid_stats->nid_stats,
102 LPROC_OFD_READ_BYTES, amount);
103 else if (opcode == LPROC_OFD_STATS_WRITE)
104 lprocfs_counter_add(exp->exp_nid_stats->nid_stats,
105 LPROC_OFD_WRITE_BYTES, amount);
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;
127 /* transaction callbacks */
128 struct dt_txn_callback ofd_txn_cb;
131 struct lu_target ofd_lut;
132 struct dt_object *ofd_health_check_file;
134 int ofd_subdir_count;
136 cfs_list_t ofd_seq_list;
137 rwlock_t ofd_seq_list_lock;
139 int ofd_precreate_batch;
140 spinlock_t ofd_batch_lock;
142 /* protect all statfs-related counters */
143 spinlock_t ofd_osfs_lock;
144 /* statfs optimization: we cache a bit */
145 struct obd_statfs ofd_osfs;
148 /* writes which might be be accounted twice in ofd_osfs.os_bavail */
149 obd_size ofd_osfs_unstable;
151 /* counters used during statfs update, protected by ofd_osfs_lock.
152 * record when some statfs refresh are in progress */
153 int ofd_statfs_inflight;
154 /* track writes completed while statfs refresh is underway.
155 * tracking is only effective when ofd_statfs_inflight > 1 */
156 obd_size ofd_osfs_inflight;
158 /* grants: all values in bytes */
159 /* grant lock to protect all grant counters */
160 spinlock_t ofd_grant_lock;
161 /* total amount of dirty data reported by clients in incoming obdo */
162 obd_size ofd_tot_dirty;
163 /* sum of filesystem space granted to clients for async writes */
164 obd_size ofd_tot_granted;
165 /* grant used by I/Os in progress (between prepare and commit) */
166 obd_size ofd_tot_pending;
167 /* free space threshold over which we stop granting space to clients
168 * ofd_grant_ratio is stored as a fixed-point fraction using
169 * OFD_GRANT_RATIO_SHIFT of the remaining free space, not in percentage
172 /* number of clients using grants */
173 int ofd_tot_granted_clients;
175 /* ofd mod data: ofd_device wide values */
176 int ofd_fmd_max_num; /* per ofd ofd_mod_data */
177 cfs_duration_t ofd_fmd_max_age; /* time to fmd expiry */
179 spinlock_t ofd_flags_lock;
180 unsigned long ofd_raid_degraded:1,
181 /* sync journal on writes */
183 /* sync on lock cancel */
184 ofd_sync_lock_cancel:2,
185 /* shall we grant space to clients not
186 * supporting OBD_CONNECT_GRANT_PARAM? */
187 ofd_grant_compat_disable:1;
188 struct seq_server_site ofd_seq_site;
191 static inline struct ofd_device *ofd_dev(struct lu_device *d)
193 return container_of0(d, struct ofd_device, ofd_dt_dev.dd_lu_dev);
196 static inline struct obd_device *ofd_obd(struct ofd_device *ofd)
198 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd;
201 static inline struct ofd_device *ofd_exp(struct obd_export *exp)
203 return ofd_dev(exp->exp_obd->obd_lu_dev);
206 static inline char *ofd_name(struct ofd_device *ofd)
208 return ofd->ofd_dt_dev.dd_lu_dev.ld_obd->obd_name;
212 struct lu_object_header ofo_header;
213 struct dt_object ofo_obj;
217 static inline struct ofd_object *ofd_obj(struct lu_object *o)
219 return container_of0(o, struct ofd_object, ofo_obj.do_lu);
222 static inline int ofd_object_exists(struct ofd_object *obj)
224 LASSERT(obj != NULL);
225 if (lu_object_is_dying(obj->ofo_obj.do_lu.lo_header))
227 return lu_object_exists(&obj->ofo_obj.do_lu);
230 static inline struct dt_object *fo2dt(struct ofd_object *obj)
232 return &obj->ofo_obj;
235 static inline struct dt_object *ofd_object_child(struct ofd_object *_obj)
237 struct lu_object *lu = &(_obj)->ofo_obj.do_lu;
239 return container_of0(lu_object_next(lu), struct dt_object, do_lu);
242 static inline struct ofd_device *ofd_obj2dev(const struct ofd_object *fo)
244 return ofd_dev(fo->ofo_obj.do_lu.lo_dev);
247 static inline struct lustre_capa *ofd_object_capa(const struct lu_env *env,
248 const struct ofd_object *obj)
250 /* TODO: see mdd_object_capa() */
254 static inline void ofd_read_lock(const struct lu_env *env,
255 struct ofd_object *fo)
257 struct dt_object *next = ofd_object_child(fo);
259 next->do_ops->do_read_lock(env, next, 0);
262 static inline void ofd_read_unlock(const struct lu_env *env,
263 struct ofd_object *fo)
265 struct dt_object *next = ofd_object_child(fo);
267 next->do_ops->do_read_unlock(env, next);
270 static inline void ofd_write_lock(const struct lu_env *env,
271 struct ofd_object *fo)
273 struct dt_object *next = ofd_object_child(fo);
275 next->do_ops->do_write_lock(env, next, 0);
278 static inline void ofd_write_unlock(const struct lu_env *env,
279 struct ofd_object *fo)
281 struct dt_object *next = ofd_object_child(fo);
283 next->do_ops->do_write_unlock(env, next);
287 * Common data shared by obdofd-level handlers. This is allocated per-thread
288 * to reduce stack consumption.
290 struct ofd_thread_info {
291 const struct lu_env *fti_env;
293 struct obd_export *fti_exp;
296 __u64 fti_pre_version;
297 __u32 fti_has_trans:1, /* has txn already */
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;
304 struct filter_fid fti_mds_fid;
305 struct ost_id fti_ostid;
306 struct ofd_object *fti_obj;
308 char name[64]; /* for ofd_init0() */
309 struct obd_statfs osfs; /* for obdofd_statfs() */
312 /* Ops object filename */
313 struct lu_name fti_name;
314 struct dt_object_format fti_dof;
315 struct lu_buf fti_buf;
318 /* Space used by the I/O, used by grant code */
319 unsigned long fti_used;
320 struct ost_lvb fti_lvb;
323 extern void target_recovery_fini(struct obd_device *obd);
324 extern void target_recovery_init(struct lu_target *lut, svc_handler_t handler);
327 int ofd_update_capa_key(struct ofd_device *ofd, struct lustre_capa_key *key);
328 int ofd_auth_capa(struct obd_export *exp, struct lu_fid *fid, obd_seq seq,
329 struct lustre_capa *capa, __u64 opc);
330 void ofd_free_capa_keys(struct ofd_device *ofd);
333 extern struct lu_context_key ofd_thread_key;
334 int ofd_postrecov(const struct lu_env *env, struct ofd_device *ofd);
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,
343 obd_id ofd_seq_last_oid(struct ofd_seq *oseq);
344 void ofd_seq_last_oid_set(struct ofd_seq *oseq, obd_id id);
345 int ofd_seq_last_oid_write(const struct lu_env *env, struct ofd_device *ofd,
346 struct ofd_seq *oseq);
347 int ofd_seqs_init(const struct lu_env *env, struct ofd_device *ofd);
348 struct ofd_seq *ofd_seq_get(struct ofd_device *ofd, obd_seq seq);
349 void ofd_seq_put(const struct lu_env *env, struct ofd_seq *oseq);
351 int ofd_fs_setup(const struct lu_env *env, struct ofd_device *ofd,
352 struct obd_device *obd);
353 void ofd_fs_cleanup(const struct lu_env *env, struct ofd_device *ofd);
354 int ofd_precreate_batch(struct ofd_device *ofd, int batch);
355 struct ofd_seq *ofd_seq_load(const struct lu_env *env, struct ofd_device *ofd,
357 void ofd_seqs_fini(const struct lu_env *env, struct ofd_device *ofd);
360 int ofd_preprw(const struct lu_env *env,int cmd, struct obd_export *exp,
361 struct obdo *oa, int objcount, struct obd_ioobj *obj,
362 struct niobuf_remote *rnb, int *nr_local,
363 struct niobuf_local *lnb, struct obd_trans_info *oti,
364 struct lustre_capa *capa);
365 int ofd_commitrw(const struct lu_env *env, int cmd, struct obd_export *exp,
366 struct obdo *oa, int objcount, struct obd_ioobj *obj,
367 struct niobuf_remote *rnb, int npages,
368 struct niobuf_local *lnb, struct obd_trans_info *oti,
372 struct thandle *ofd_trans_create(const struct lu_env *env,
373 struct ofd_device *ofd);
374 int ofd_trans_start(const struct lu_env *env,
375 struct ofd_device *ofd, struct ofd_object *fo,
377 void ofd_trans_stop(const struct lu_env *env, struct ofd_device *ofd,
378 struct thandle *th, int rc);
379 int ofd_txn_stop_cb(const struct lu_env *env, struct thandle *txn,
384 void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars);
385 void ofd_stats_counter_init(struct lprocfs_stats *stats);
387 static void lprocfs_ofd_init_vars(struct lprocfs_static_vars *lvars)
389 memset(lvars, 0, sizeof(*lvars));
391 static inline void ofd_stats_counter_init(struct lprocfs_stats *stats) {}
395 struct ofd_object *ofd_object_find(const struct lu_env *env,
396 struct ofd_device *ofd,
397 const struct lu_fid *fid);
398 struct ofd_object *ofd_object_find_or_create(const struct lu_env *env,
399 struct ofd_device *ofd,
400 const struct lu_fid *fid,
401 struct lu_attr *attr);
402 int ofd_object_ff_check(const struct lu_env *env, struct ofd_object *fo);
403 int ofd_precreate_objects(const struct lu_env *env, struct ofd_device *ofd,
404 obd_id 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);
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 #define OFD_GRANT_RATIO_SHIFT 8
420 static inline __u64 ofd_grant_reserved(struct ofd_device *ofd, obd_size bavail)
422 return (bavail * ofd->ofd_grant_ratio) >> OFD_GRANT_RATIO_SHIFT;
425 static inline int ofd_grant_ratio_conv(int percentage)
427 return (percentage << OFD_GRANT_RATIO_SHIFT) / 100;
430 static inline int ofd_grant_param_supp(struct obd_export *exp)
432 return !!(exp_connect_flags(exp) & OBD_CONNECT_GRANT_PARAM);
435 /* Blocksize used for client not supporting OBD_CONNECT_GRANT_PARAM.
436 * That's 4KB=2^12 which is the biggest block size known to work whatever
437 * the client's page size is. */
438 #define COMPAT_BSIZE_SHIFT 12
439 static inline int ofd_grant_compat(struct obd_export *exp,
440 struct ofd_device *ofd)
442 /* Clients which don't support OBD_CONNECT_GRANT_PARAM cannot handle
443 * a block size > page size and consume PAGE_CACHE_SIZE of grant when
444 * dirtying a page regardless of the block size */
445 return !!(ofd_obd(ofd)->obd_self_export != exp &&
446 ofd->ofd_blockbits > COMPAT_BSIZE_SHIFT &&
447 !ofd_grant_param_supp(exp));
450 static inline int ofd_grant_prohibit(struct obd_export *exp,
451 struct ofd_device *ofd)
453 /* When ofd_grant_compat_disable is set, we don't grant any space to
454 * clients not supporting OBD_CONNECT_GRANT_PARAM.
455 * Otherwise, space granted to such a client is inflated since it
456 * consumes PAGE_CACHE_SIZE of grant space per block */
457 return !!(ofd_grant_compat(exp, ofd) && ofd->ofd_grant_compat_disable);
460 void ofd_grant_sanity_check(struct obd_device *obd, const char *func);
461 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
462 obd_size want, bool conservative);
463 void ofd_grant_discard(struct obd_export *exp);
464 void ofd_grant_prepare_read(const struct lu_env *env, struct obd_export *exp,
466 void ofd_grant_prepare_write(const struct lu_env *env, struct obd_export *exp,
467 struct obdo *oa, struct niobuf_remote *rnb,
469 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp, int rc);
470 int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr);
473 int ofd_fmd_init(void);
474 void ofd_fmd_exit(void);
475 struct ofd_mod_data *ofd_fmd_find(struct obd_export *exp,
477 struct ofd_mod_data *ofd_fmd_get(struct obd_export *exp,
479 void ofd_fmd_put(struct obd_export *exp, struct ofd_mod_data *fmd);
480 void ofd_fmd_expire(struct obd_export *exp);
481 void ofd_fmd_cleanup(struct obd_export *exp);
483 void ofd_fmd_drop(struct obd_export *exp, struct lu_fid *fid);
485 #define ofd_fmd_drop(exp, fid) do {} while (0)
489 int ofd_fid_set_index(const struct lu_env *env, struct ofd_device *ofd,
491 int ofd_fid_init(const struct lu_env *env, struct ofd_device *ofd);
492 int ofd_fid_fini(const struct lu_env *env, struct ofd_device *ofd);
495 extern struct ldlm_valblock_ops ofd_lvbo;
498 int ofd_intent_policy(struct ldlm_namespace *ns, struct ldlm_lock **lockp,
499 void *req_cookie, ldlm_mode_t mode, __u64 flags,
502 static inline struct ofd_thread_info * ofd_info(const struct lu_env *env)
504 struct ofd_thread_info *info;
506 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
508 LASSERT(info->fti_env);
509 LASSERT(info->fti_env == env);
513 static inline struct ofd_thread_info * ofd_info_init(const struct lu_env *env,
514 struct obd_export *exp)
516 struct ofd_thread_info *info;
518 info = lu_context_key_get(&env->le_ctx, &ofd_thread_key);
520 LASSERT(info->fti_exp == NULL);
521 LASSERT(info->fti_env == NULL);
522 LASSERT(info->fti_attr.la_valid == 0);
526 info->fti_pre_version = 0;
527 info->fti_transno = 0;
528 info->fti_has_trans = 0;
532 static inline void ofd_oti2info(struct ofd_thread_info *info,
533 struct obd_trans_info *oti)
535 info->fti_xid = oti->oti_xid;
536 info->fti_transno = oti->oti_transno;
537 info->fti_pre_version = oti->oti_pre_version;
540 static inline void ofd_info2oti(struct ofd_thread_info *info,
541 struct obd_trans_info *oti)
543 oti->oti_xid = info->fti_xid;
544 LASSERTF(ergo(oti->oti_transno > 0,
545 oti->oti_transno == info->fti_transno),
546 "Overwrite replay transno "LPX64" by "LPX64"\n",
547 oti->oti_transno, info->fti_transno);
548 oti->oti_transno = info->fti_transno;
549 oti->oti_pre_version = info->fti_pre_version;
552 /* sync on lock cancel is useless when we force a journal flush,
553 * and if we enable async journal commit, we should also turn on
554 * sync on lock cancel if it is not enabled already. */
555 static inline void ofd_slc_set(struct ofd_device *ofd)
557 if (ofd->ofd_syncjournal == 1)
558 ofd->ofd_sync_lock_cancel = NEVER_SYNC_ON_CANCEL;
559 else if (ofd->ofd_sync_lock_cancel == NEVER_SYNC_ON_CANCEL)
560 ofd->ofd_sync_lock_cancel = ALWAYS_SYNC_ON_CANCEL;
563 static inline void ofd_prepare_fidea(struct filter_fid *ff, struct obdo *oa)
565 if (!(oa->o_valid & OBD_MD_FLGROUP))
566 ostid_set_seq_mdt0(&oa->o_oi);
567 /* packing fid and converting it to LE for storing into EA.
568 * Here ->o_stripe_idx should be filled by LOV and rest of
569 * fields - by client. */
570 ff->ff_parent.f_seq = cpu_to_le64(oa->o_parent_seq);
571 ff->ff_parent.f_oid = cpu_to_le32(oa->o_parent_oid);
572 /* XXX: we are ignoring o_parent_ver here, since this should
573 * be the same for all objects in this fileset. */
574 ff->ff_parent.f_ver = cpu_to_le32(oa->o_stripe_idx);
577 /* niobuf_remote has no rnb_ prefix in master */
578 #define rnb_offset offset
579 #define rnb_flags flags
581 /* the same for niobuf_local */
582 #define lnb_flags flags
585 #endif /* _OFD_INTERNAL_H */