[deliverable/linux.git] / fs / nfs / flexfilelayout / flexfilelayout.h

/*
 * NFSv4 flexfile layout driver data structures.
 *
 * Copyright (c) 2014, Primary Data, Inc. All rights reserved.
 *
 * Tao Peng <bergwolf@primarydata.com>
 */

#ifndef FS_NFS_NFS4FLEXFILELAYOUT_H
#define FS_NFS_NFS4FLEXFILELAYOUT_H

#define FF_FLAGS_NO_LAYOUTCOMMIT 1

#include "../pnfs.h"

/* XXX: Let's filter out insanely large mirror count for now to avoid oom
 * due to network error etc. */
#define NFS4_FLEXFILE_LAYOUT_MAX_MIRROR_CNT 4096

/* LAYOUTSTATS report interval in ms */
#define FF_LAYOUTSTATS_REPORT_INTERVAL (60000L)

struct nfs4_ff_ds_version {
	u32				version;
	u32				minor_version;
	u32				rsize;
	u32				wsize;
	bool				tightly_coupled;
};

/* chained in global deviceid hlist */
struct nfs4_ff_layout_ds {
	struct nfs4_deviceid_node	id_node;
	u32				ds_versions_cnt;
	struct nfs4_ff_ds_version	*ds_versions;
	struct nfs4_pnfs_ds		*ds;
};

struct nfs4_ff_layout_ds_err {
	struct list_head		list; /* linked in mirror error_list */
	u64				offset;
	u64				length;
	int				status;
	enum nfs_opnum4			opnum;
	nfs4_stateid			stateid;
	struct nfs4_deviceid		deviceid;
};

struct nfs4_ff_io_stat {
	__u64				ops_requested;
	__u64				bytes_requested;
	__u64				ops_completed;
	__u64				bytes_completed;
	__u64				bytes_not_delivered;
	ktime_t				total_busy_time;
	ktime_t				aggregate_completion_time;
};

struct nfs4_ff_busy_timer {
	ktime_t start_time;
	atomic_t n_ops;
};

struct nfs4_ff_layoutstat {
	struct nfs4_ff_io_stat io_stat;
	struct nfs4_ff_busy_timer busy_timer;
};

struct nfs4_ff_layout_mirror {
	struct pnfs_layout_segment	*lseg; /* back pointer */
	u32				ds_count;
	u32				efficiency;
	struct nfs4_ff_layout_ds	*mirror_ds;
	u32				fh_versions_cnt;
	struct nfs_fh			*fh_versions;
	nfs4_stateid			stateid;
	u32				uid;
	u32				gid;
	struct rpc_cred			*cred;
	spinlock_t			lock;
	struct nfs4_ff_layoutstat	read_stat;
	struct nfs4_ff_layoutstat	write_stat;
	ktime_t				start_time;
	ktime_t				last_report_time;
};

struct nfs4_ff_layout_segment {
	struct pnfs_layout_segment	generic_hdr;
	u64				stripe_unit;
	u32				flags;
	u32				mirror_array_cnt;
	struct nfs4_ff_layout_mirror	**mirror_array;
};

struct nfs4_flexfile_layout {
	struct pnfs_layout_hdr generic_hdr;
	struct pnfs_ds_commit_info commit_info;
	struct list_head	error_list; /* nfs4_ff_layout_ds_err */
};

static inline struct nfs4_flexfile_layout *
FF_LAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
{
	return container_of(lo, struct nfs4_flexfile_layout, generic_hdr);
}

static inline struct nfs4_ff_layout_segment *
FF_LAYOUT_LSEG(struct pnfs_layout_segment *lseg)
{
	return container_of(lseg,
			    struct nfs4_ff_layout_segment,
			    generic_hdr);
}

static inline struct nfs4_deviceid_node *
FF_LAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg, u32 idx)
{
	if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt ||
	    FF_LAYOUT_LSEG(lseg)->mirror_array[idx] == NULL ||
	    FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds == NULL)
		return NULL;
	return &FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds->id_node;
}

static inline struct nfs4_ff_layout_ds *
FF_LAYOUT_MIRROR_DS(struct nfs4_deviceid_node *node)
{
	return container_of(node, struct nfs4_ff_layout_ds, id_node);
}

static inline struct nfs4_ff_layout_mirror *
FF_LAYOUT_COMP(struct pnfs_layout_segment *lseg, u32 idx)
{
	if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt)
		return NULL;
	return FF_LAYOUT_LSEG(lseg)->mirror_array[idx];
}

static inline u32
FF_LAYOUT_MIRROR_COUNT(struct pnfs_layout_segment *lseg)
{
	return FF_LAYOUT_LSEG(lseg)->mirror_array_cnt;
}

static inline bool
ff_layout_test_devid_unavailable(struct nfs4_deviceid_node *node)
{
	return nfs4_test_deviceid_unavailable(node);
}

static inline int
nfs4_ff_layout_ds_version(struct pnfs_layout_segment *lseg, u32 ds_idx)
{
	return FF_LAYOUT_COMP(lseg, ds_idx)->mirror_ds->ds_versions[0].version;
}

struct nfs4_ff_layout_ds *
nfs4_ff_alloc_deviceid_node(struct nfs_server *server, struct pnfs_device *pdev,
			    gfp_t gfp_flags);
void nfs4_ff_layout_put_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
void nfs4_ff_layout_free_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
int ff_layout_track_ds_error(struct nfs4_flexfile_layout *flo,
			     struct nfs4_ff_layout_mirror *mirror, u64 offset,
			     u64 length, int status, enum nfs_opnum4 opnum,
			     gfp_t gfp_flags);
int ff_layout_encode_ds_ioerr(struct nfs4_flexfile_layout *flo,
			      struct xdr_stream *xdr, int *count,
			      const struct pnfs_layout_range *range);
struct nfs_fh *
nfs4_ff_layout_select_ds_fh(struct pnfs_layout_segment *lseg, u32 mirror_idx);

struct nfs4_pnfs_ds *
nfs4_ff_layout_prepare_ds(struct pnfs_layout_segment *lseg, u32 ds_idx,
			  bool fail_return);

struct rpc_clnt *
nfs4_ff_find_or_create_ds_client(struct pnfs_layout_segment *lseg,
				 u32 ds_idx,
				 struct nfs_client *ds_clp,
				 struct inode *inode);
struct rpc_cred *ff_layout_get_ds_cred(struct pnfs_layout_segment *lseg,
				       u32 ds_idx, struct rpc_cred *mdscred);
bool ff_layout_has_available_ds(struct pnfs_layout_segment *lseg);
#endif /* FS_NFS_NFS4FLEXFILELAYOUT_H */
Commit	Line	Data
d67ae825 TH	1	/*
	2	* NFSv4 flexfile layout driver data structures.
	3	*
	4	* Copyright (c) 2014, Primary Data, Inc. All rights reserved.
	5	*
	6	* Tao Peng <bergwolf@primarydata.com>
	7	*/
	8
	9	#ifndef FS_NFS_NFS4FLEXFILELAYOUT_H
	10	#define FS_NFS_NFS4FLEXFILELAYOUT_H
	11
c0f5f505 TM	12	#define FF_FLAGS_NO_LAYOUTCOMMIT 1
c0f5f505 TM	13
d67ae825 TH	14	#include "../pnfs.h"
	15
	16	/* XXX: Let's filter out insanely large mirror count for now to avoid oom
	17	* due to network error etc. */
	18	#define NFS4_FLEXFILE_LAYOUT_MAX_MIRROR_CNT 4096
	19
97ba375b PT	20	/* LAYOUTSTATS report interval in ms */
	21	#define FF_LAYOUTSTATS_REPORT_INTERVAL (60000L)
	22
d67ae825 TH	23	struct nfs4_ff_ds_version {
	24	u32 version;
	25	u32 minor_version;
	26	u32 rsize;
	27	u32 wsize;
	28	bool tightly_coupled;
	29	};
	30
	31	/* chained in global deviceid hlist */
	32	struct nfs4_ff_layout_ds {
	33	struct nfs4_deviceid_node id_node;
	34	u32 ds_versions_cnt;
	35	struct nfs4_ff_ds_version *ds_versions;
	36	struct nfs4_pnfs_ds *ds;
	37	};
	38
	39	struct nfs4_ff_layout_ds_err {
	40	struct list_head list; /* linked in mirror error_list */
	41	u64 offset;
	42	u64 length;
	43	int status;
	44	enum nfs_opnum4 opnum;
	45	nfs4_stateid stateid;
	46	struct nfs4_deviceid deviceid;
	47	};
	48
abcb7bfc TM	49	struct nfs4_ff_io_stat {
	50	__u64 ops_requested;
	51	__u64 bytes_requested;
	52	__u64 ops_completed;
	53	__u64 bytes_completed;
	54	__u64 bytes_not_delivered;
	55	ktime_t total_busy_time;
	56	ktime_t aggregate_completion_time;
	57	};
	58
	59	struct nfs4_ff_busy_timer {
	60	ktime_t start_time;
	61	atomic_t n_ops;
	62	};
	63
	64	struct nfs4_ff_layoutstat {
	65	struct nfs4_ff_io_stat io_stat;
	66	struct nfs4_ff_busy_timer busy_timer;
	67	};
	68
d67ae825	69	struct nfs4_ff_layout_mirror {
97ba375b	70	struct pnfs_layout_segment lseg; / back pointer */
d67ae825 TH	71	u32 ds_count;
	72	u32 efficiency;
	73	struct nfs4_ff_layout_ds *mirror_ds;
	74	u32 fh_versions_cnt;
	75	struct nfs_fh *fh_versions;
	76	nfs4_stateid stateid;
d67ae825 TH	77	u32 uid;
	78	u32 gid;
	79	struct rpc_cred *cred;
	80	spinlock_t lock;
abcb7bfc TM	81	struct nfs4_ff_layoutstat read_stat;
abcb7bfc TM	82	struct nfs4_ff_layoutstat write_stat;
d983803d	83	ktime_t start_time;
97ba375b	84	ktime_t last_report_time;
d67ae825 TH	85	};
	86
	87	struct nfs4_ff_layout_segment {
	88	struct pnfs_layout_segment generic_hdr;
	89	u64 stripe_unit;
c0f5f505	90	u32 flags;
d67ae825 TH	91	u32 mirror_array_cnt;
	92	struct nfs4_ff_layout_mirror **mirror_array;
	93	};
	94
	95	struct nfs4_flexfile_layout {
	96	struct pnfs_layout_hdr generic_hdr;
	97	struct pnfs_ds_commit_info commit_info;
	98	struct list_head error_list; /* nfs4_ff_layout_ds_err */
	99	};
	100
	101	static inline struct nfs4_flexfile_layout *
	102	FF_LAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
	103	{
	104	return container_of(lo, struct nfs4_flexfile_layout, generic_hdr);
	105	}
	106
	107	static inline struct nfs4_ff_layout_segment *
	108	FF_LAYOUT_LSEG(struct pnfs_layout_segment *lseg)
	109	{
	110	return container_of(lseg,
	111	struct nfs4_ff_layout_segment,
	112	generic_hdr);
	113	}
	114
	115	static inline struct nfs4_deviceid_node *
	116	FF_LAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg, u32 idx)
	117	{
	118	if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt \|\|
	119	FF_LAYOUT_LSEG(lseg)->mirror_array[idx] == NULL \|\|
	120	FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds == NULL)
	121	return NULL;
	122	return &FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds->id_node;
	123	}
	124
	125	static inline struct nfs4_ff_layout_ds *
	126	FF_LAYOUT_MIRROR_DS(struct nfs4_deviceid_node *node)
	127	{
	128	return container_of(node, struct nfs4_ff_layout_ds, id_node);
	129	}
	130
	131	static inline struct nfs4_ff_layout_mirror *
	132	FF_LAYOUT_COMP(struct pnfs_layout_segment *lseg, u32 idx)
	133	{
	134	if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt)
	135	return NULL;
	136	return FF_LAYOUT_LSEG(lseg)->mirror_array[idx];
	137	}
	138
	139	static inline u32
	140	FF_LAYOUT_MIRROR_COUNT(struct pnfs_layout_segment *lseg)
	141	{
	142	return FF_LAYOUT_LSEG(lseg)->mirror_array_cnt;
	143	}
	144
	145	static inline bool
	146	ff_layout_test_devid_unavailable(struct nfs4_deviceid_node *node)
	147	{
	148	return nfs4_test_deviceid_unavailable(node);
	149	}
	150
	151	static inline int
	152	nfs4_ff_layout_ds_version(struct pnfs_layout_segment *lseg, u32 ds_idx)
	153	{
	154	return FF_LAYOUT_COMP(lseg, ds_idx)->mirror_ds->ds_versions[0].version;
155	}
156
157	struct nfs4_ff_layout_ds *
158	nfs4_ff_alloc_deviceid_node(struct nfs_server server, struct pnfs_device pdev,
159	gfp_t gfp_flags);
160	void nfs4_ff_layout_put_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
161	void nfs4_ff_layout_free_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
162	int ff_layout_track_ds_error(struct nfs4_flexfile_layout *flo,
163	struct nfs4_ff_layout_mirror *mirror, u64 offset,
164	u64 length, int status, enum nfs_opnum4 opnum,
165	gfp_t gfp_flags);
166	int ff_layout_encode_ds_ioerr(struct nfs4_flexfile_layout *flo,
167	struct xdr_stream xdr, int count,
168	const struct pnfs_layout_range *range);
169	struct nfs_fh *
170	nfs4_ff_layout_select_ds_fh(struct pnfs_layout_segment *lseg, u32 mirror_idx);
171
172	struct nfs4_pnfs_ds *
173	nfs4_ff_layout_prepare_ds(struct pnfs_layout_segment *lseg, u32 ds_idx,
174	bool fail_return);
175
176	struct rpc_clnt *
177	nfs4_ff_find_or_create_ds_client(struct pnfs_layout_segment *lseg,
178	u32 ds_idx,
179	struct nfs_client *ds_clp,
180	struct inode *inode);
181	struct rpc_cred ff_layout_get_ds_cred(struct pnfs_layout_segment lseg,
182	u32 ds_idx, struct rpc_cred *mdscred);
183	bool ff_layout_has_available_ds(struct pnfs_layout_segment *lseg);
184	#endif /* FS_NFS_NFS4FLEXFILELAYOUT_H */