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
 12#define FF_FLAGS_NO_LAYOUTCOMMIT 1
 13#define FF_FLAGS_NO_IO_THRU_MDS  2
 14#define FF_FLAGS_NO_READ_IO      4
 15
 16#include "../pnfs.h"
 17
 18/* XXX: Let's filter out insanely large mirror count for now to avoid oom
 19 * due to network error etc. */
 20#define NFS4_FLEXFILE_LAYOUT_MAX_MIRROR_CNT 4096
 21
 22/* LAYOUTSTATS report interval in ms */
 23#define FF_LAYOUTSTATS_REPORT_INTERVAL (60000L)
 24#define FF_LAYOUTSTATS_MAXDEV 4
 25
 26struct nfs4_ff_ds_version {
 27	u32				version;
 28	u32				minor_version;
 29	u32				rsize;
 30	u32				wsize;
 31	bool				tightly_coupled;
 32};
 33
 34/* chained in global deviceid hlist */
 35struct nfs4_ff_layout_ds {
 36	struct nfs4_deviceid_node	id_node;
 37	u32				ds_versions_cnt;
 38	struct nfs4_ff_ds_version	*ds_versions;
 39	struct nfs4_pnfs_ds		*ds;
 40};
 41
 42struct nfs4_ff_layout_ds_err {
 43	struct list_head		list; /* linked in mirror error_list */
 44	u64				offset;
 45	u64				length;
 46	int				status;
 47	enum nfs_opnum4			opnum;
 48	nfs4_stateid			stateid;
 49	struct nfs4_deviceid		deviceid;
 50};
 51
 52struct nfs4_ff_io_stat {
 53	__u64				ops_requested;
 54	__u64				bytes_requested;
 55	__u64				ops_completed;
 56	__u64				bytes_completed;
 57	__u64				bytes_not_delivered;
 58	ktime_t				total_busy_time;
 59	ktime_t				aggregate_completion_time;
 60};
 61
 62struct nfs4_ff_busy_timer {
 63	ktime_t start_time;
 64	atomic_t n_ops;
 65};
 66
 67struct nfs4_ff_layoutstat {
 68	struct nfs4_ff_io_stat io_stat;
 69	struct nfs4_ff_busy_timer busy_timer;
 70};
 71
 72struct nfs4_ff_layout_mirror {
 73	struct pnfs_layout_hdr		*layout;
 74	struct list_head		mirrors;
 75	u32				ds_count;
 76	u32				efficiency;
 77	struct nfs4_deviceid		devid;
 78	struct nfs4_ff_layout_ds	*mirror_ds;
 79	u32				fh_versions_cnt;
 80	struct nfs_fh			*fh_versions;
 81	nfs4_stateid			stateid;
 82	struct rpc_cred	__rcu		*ro_cred;
 83	struct rpc_cred	__rcu		*rw_cred;
 84	atomic_t			ref;
 85	spinlock_t			lock;
 86	unsigned long			flags;
 87	struct nfs4_ff_layoutstat	read_stat;
 88	struct nfs4_ff_layoutstat	write_stat;
 89	ktime_t				start_time;
 90	u32				report_interval;
 91};
 92
 93#define NFS4_FF_MIRROR_STAT_AVAIL	(0)
 94
 95struct nfs4_ff_layout_segment {
 96	struct pnfs_layout_segment	generic_hdr;
 97	u64				stripe_unit;
 98	u32				flags;
 99	u32				mirror_array_cnt;
100	struct nfs4_ff_layout_mirror	**mirror_array;
101};
102
103struct nfs4_flexfile_layout {
104	struct pnfs_layout_hdr generic_hdr;
105	struct pnfs_ds_commit_info commit_info;
106	struct list_head	mirrors;
107	struct list_head	error_list; /* nfs4_ff_layout_ds_err */
108	ktime_t			last_report_time; /* Layoutstat report times */
109};
110
111struct nfs4_flexfile_layoutreturn_args {
112	struct list_head errors;
113	struct nfs42_layoutstat_devinfo devinfo[FF_LAYOUTSTATS_MAXDEV];
114	unsigned int num_errors;
115	unsigned int num_dev;
116	struct page *pages[1];
117};
118
119static inline struct nfs4_flexfile_layout *
120FF_LAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
121{
122	return container_of(lo, struct nfs4_flexfile_layout, generic_hdr);
123}
124
125static inline struct nfs4_ff_layout_segment *
126FF_LAYOUT_LSEG(struct pnfs_layout_segment *lseg)
127{
128	return container_of(lseg,
129			    struct nfs4_ff_layout_segment,
130			    generic_hdr);
131}
132
133static inline struct nfs4_deviceid_node *
134FF_LAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg, u32 idx)
135{
136	if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt ||
137	    FF_LAYOUT_LSEG(lseg)->mirror_array[idx] == NULL ||
138	    FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds == NULL)
139		return NULL;
140	return &FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds->id_node;
141}
142
143static inline struct nfs4_ff_layout_ds *
144FF_LAYOUT_MIRROR_DS(struct nfs4_deviceid_node *node)
145{
146	return container_of(node, struct nfs4_ff_layout_ds, id_node);
147}
148
149static inline struct nfs4_ff_layout_mirror *
150FF_LAYOUT_COMP(struct pnfs_layout_segment *lseg, u32 idx)
151{
152	if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt)
153		return NULL;
154	return FF_LAYOUT_LSEG(lseg)->mirror_array[idx];
155}
156
157static inline u32
158FF_LAYOUT_MIRROR_COUNT(struct pnfs_layout_segment *lseg)
159{
160	return FF_LAYOUT_LSEG(lseg)->mirror_array_cnt;
161}
162
163static inline bool
164ff_layout_no_fallback_to_mds(struct pnfs_layout_segment *lseg)
165{
166	return FF_LAYOUT_LSEG(lseg)->flags & FF_FLAGS_NO_IO_THRU_MDS;
167}
168
169static inline bool
170ff_layout_no_read_on_rw(struct pnfs_layout_segment *lseg)
171{
172	return FF_LAYOUT_LSEG(lseg)->flags & FF_FLAGS_NO_READ_IO;
173}
174
175static inline bool
176ff_layout_test_devid_unavailable(struct nfs4_deviceid_node *node)
177{
178	return nfs4_test_deviceid_unavailable(node);
179}
180
181static inline int
182nfs4_ff_layout_ds_version(struct pnfs_layout_segment *lseg, u32 ds_idx)
183{
184	return FF_LAYOUT_COMP(lseg, ds_idx)->mirror_ds->ds_versions[0].version;
185}
186
187struct nfs4_ff_layout_ds *
188nfs4_ff_alloc_deviceid_node(struct nfs_server *server, struct pnfs_device *pdev,
189			    gfp_t gfp_flags);
190void nfs4_ff_layout_put_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
191void nfs4_ff_layout_free_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
192int ff_layout_track_ds_error(struct nfs4_flexfile_layout *flo,
193			     struct nfs4_ff_layout_mirror *mirror, u64 offset,
194			     u64 length, int status, enum nfs_opnum4 opnum,
195			     gfp_t gfp_flags);
196int ff_layout_encode_ds_ioerr(struct xdr_stream *xdr, const struct list_head *head);
197void ff_layout_free_ds_ioerr(struct list_head *head);
198unsigned int ff_layout_fetch_ds_ioerr(struct pnfs_layout_hdr *lo,
199		const struct pnfs_layout_range *range,
200		struct list_head *head,
201		unsigned int maxnum);
202struct nfs_fh *
203nfs4_ff_layout_select_ds_fh(struct pnfs_layout_segment *lseg, u32 mirror_idx);
204
205struct nfs4_pnfs_ds *
206nfs4_ff_layout_prepare_ds(struct pnfs_layout_segment *lseg, u32 ds_idx,
207			  bool fail_return);
208
209struct rpc_clnt *
210nfs4_ff_find_or_create_ds_client(struct pnfs_layout_segment *lseg,
211				 u32 ds_idx,
212				 struct nfs_client *ds_clp,
213				 struct inode *inode);
214struct rpc_cred *ff_layout_get_ds_cred(struct pnfs_layout_segment *lseg,
215				       u32 ds_idx, struct rpc_cred *mdscred);
216bool ff_layout_avoid_mds_available_ds(struct pnfs_layout_segment *lseg);
217bool ff_layout_avoid_read_on_rw(struct pnfs_layout_segment *lseg);
218
219#endif /* FS_NFS_NFS4FLEXFILELAYOUT_H */