pnfs.h

  1/*
  2 *  pNFS client data structures.
  3 *
  4 *  Copyright (c) 2002
  5 *  The Regents of the University of Michigan
  6 *  All Rights Reserved
  7 *
  8 *  Dean Hildebrand <dhildebz@umich.edu>
  9 *
 10 *  Permission is granted to use, copy, create derivative works, and
 11 *  redistribute this software and such derivative works for any purpose,
 12 *  so long as the name of the University of Michigan is not used in
 13 *  any advertising or publicity pertaining to the use or distribution
 14 *  of this software without specific, written prior authorization. If
 15 *  the above copyright notice or any other identification of the
 16 *  University of Michigan is included in any copy of any portion of
 17 *  this software, then the disclaimer below must also be included.
 18 *
 19 *  This software is provided as is, without representation or warranty
 20 *  of any kind either express or implied, including without limitation
 21 *  the implied warranties of merchantability, fitness for a particular
 22 *  purpose, or noninfringement.  The Regents of the University of
 23 *  Michigan shall not be liable for any damages, including special,
 24 *  indirect, incidental, or consequential damages, with respect to any
 25 *  claim arising out of or in connection with the use of the software,
 26 *  even if it has been or is hereafter advised of the possibility of
 27 *  such damages.
 28 */
 29
 30#ifndef FS_NFS_PNFS_H
 31#define FS_NFS_PNFS_H
 32
 33#include <linux/refcount.h>
 34#include <linux/nfs_fs.h>
 35#include <linux/nfs_page.h>
 36#include <linux/workqueue.h>
 37
 38struct nfs4_exception;
 39struct nfs4_opendata;
 40
 41enum {
 42	NFS_LSEG_VALID = 0,	/* cleared when lseg is recalled/returned */
 43	NFS_LSEG_ROC,		/* roc bit received from server */
 44	NFS_LSEG_LAYOUTCOMMIT,	/* layoutcommit bit set for layoutcommit */
 45	NFS_LSEG_LAYOUTRETURN,	/* layoutreturn bit set for layoutreturn */
 46	NFS_LSEG_UNAVAILABLE,	/* unavailable bit set for temporary problem */
 47};
 48
 49/* Individual ip address */
 50struct nfs4_pnfs_ds_addr {
 51	struct sockaddr_storage	da_addr;
 52	size_t			da_addrlen;
 53	struct list_head	da_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
 54	char			*da_remotestr;	/* human readable addr+port */
 55	const char		*da_netid;
 56	int			da_transport;
 57};
 58
 59struct nfs4_pnfs_ds {
 60	struct list_head	ds_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
 61	char			*ds_remotestr;	/* comma sep list of addrs */
 62	struct list_head	ds_addrs;
 63	const struct net	*ds_net;
 64	struct nfs_client	*ds_clp;
 65	refcount_t		ds_count;
 66	unsigned long		ds_state;
 67#define NFS4DS_CONNECTING	0	/* ds is establishing connection */
 68};
 69
 70struct pnfs_layout_segment {
 71	struct list_head pls_list;
 72	struct list_head pls_lc_list;
 73	struct list_head pls_commits;
 74	struct pnfs_layout_range pls_range;
 75	refcount_t pls_refcount;
 76	u32 pls_seq;
 77	unsigned long pls_flags;
 78	struct pnfs_layout_hdr *pls_layout;
 79};
 80
 81enum pnfs_try_status {
 82	PNFS_ATTEMPTED     = 0,
 83	PNFS_NOT_ATTEMPTED = 1,
 84	PNFS_TRY_AGAIN     = 2,
 85};
 86
 87#ifdef CONFIG_NFS_V4_1
 88
 89#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
 90
 91/*
 92 * Default data server connection timeout and retrans vaules.
 93 * Set by module parameters dataserver_timeo and dataserver_retrans.
 94 */
 95#define NFS4_DEF_DS_TIMEO   600 /* in tenths of a second */
 96#define NFS4_DEF_DS_RETRANS 5
 97#define PNFS_DEVICE_RETRY_TIMEOUT (120*HZ)
 98
 99enum {
100	NFS_LAYOUT_RO_FAILED = 0,	/* get ro layout failed stop trying */
101	NFS_LAYOUT_RW_FAILED,		/* get rw layout failed stop trying */
102	NFS_LAYOUT_BULK_RECALL,		/* bulk recall affecting layout */
103	NFS_LAYOUT_RETURN,		/* layoutreturn in progress */
104	NFS_LAYOUT_RETURN_LOCK,		/* Serialise layoutreturn */
105	NFS_LAYOUT_RETURN_REQUESTED,	/* Return this layout ASAP */
106	NFS_LAYOUT_INVALID_STID,	/* layout stateid id is invalid */
107	NFS_LAYOUT_FIRST_LAYOUTGET,	/* Serialize first layoutget */
108	NFS_LAYOUT_INODE_FREEING,	/* The inode is being freed */
109	NFS_LAYOUT_HASHED,		/* The layout visible */
110	NFS_LAYOUT_DRAIN,
111};
112
113enum layoutdriver_policy_flags {
114	/* Should the pNFS client commit and return the layout upon truncate to
115	 * a smaller size */
116	PNFS_LAYOUTRET_ON_SETATTR	= 1 << 0,
117	PNFS_LAYOUTRET_ON_ERROR		= 1 << 1,
118	PNFS_READ_WHOLE_PAGE		= 1 << 2,
119	PNFS_LAYOUTGET_ON_OPEN		= 1 << 3,
120};
121
122enum pnfs_layout_destroy_mode {
123	PNFS_LAYOUT_INVALIDATE = 0,
124	PNFS_LAYOUT_BULK_RETURN,
125	PNFS_LAYOUT_FILE_BULK_RETURN,
126};
127
128struct nfs4_deviceid_node;
129
130/* Per-layout driver specific registration structure */
131struct pnfs_layoutdriver_type {
132	struct list_head pnfs_tblid;
133	const u32 id;
134	const char *name;
135	struct module *owner;
136	unsigned flags;
137	unsigned max_layoutget_response;
138
139	int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
140	int (*clear_layoutdriver) (struct nfs_server *);
141
142	struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
143	void (*free_layout_hdr) (struct pnfs_layout_hdr *);
144
145	struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
146	void (*free_lseg) (struct pnfs_layout_segment *lseg);
147	void (*add_lseg) (struct pnfs_layout_hdr *layoutid,
148			struct pnfs_layout_segment *lseg,
149			struct list_head *free_me);
150
151	void (*return_range) (struct pnfs_layout_hdr *lo,
152			      struct pnfs_layout_range *range);
153
154	/* test for nfs page cache coalescing */
155	const struct nfs_pageio_ops *pg_read_ops;
156	const struct nfs_pageio_ops *pg_write_ops;
157
158	struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
159
160	int (*sync)(struct inode *inode, bool datasync);
161
162	/*
163	 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
164	 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
165	 */
166	enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
167	enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
168
169	void (*free_deviceid_node) (struct nfs4_deviceid_node *);
170	struct nfs4_deviceid_node * (*alloc_deviceid_node)
171			(struct nfs_server *server, struct pnfs_device *pdev,
172			gfp_t gfp_flags);
173
174	int (*prepare_layoutreturn) (struct nfs4_layoutreturn_args *);
175
176	void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
177	int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
178	int (*prepare_layoutstats) (struct nfs42_layoutstat_args *args);
179
180	void (*cancel_io)(struct pnfs_layout_segment *lseg);
181};
182
183struct pnfs_commit_ops {
184	void (*setup_ds_info)(struct pnfs_ds_commit_info *,
185			      struct pnfs_layout_segment *);
186	void (*release_ds_info)(struct pnfs_ds_commit_info *,
187				struct inode *inode);
188	int (*commit_pagelist)(struct inode *inode,
189			       struct list_head *mds_pages,
190			       int how,
191			       struct nfs_commit_info *cinfo);
192	void (*mark_request_commit) (struct nfs_page *req,
193				     struct pnfs_layout_segment *lseg,
194				     struct nfs_commit_info *cinfo,
195				     u32 ds_commit_idx);
196	void (*clear_request_commit) (struct nfs_page *req,
197				      struct nfs_commit_info *cinfo);
198	int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
199				  int max);
200	void (*recover_commit_reqs) (struct list_head *list,
201				     struct nfs_commit_info *cinfo);
202};
203
204struct pnfs_layout_hdr {
205	refcount_t		plh_refcount;
206	atomic_t		plh_outstanding; /* number of RPCs out */
207	struct list_head	plh_layouts;   /* other client layouts */
208	struct list_head	plh_bulk_destroy;
209	struct list_head	plh_segs;      /* layout segments list */
210	struct list_head	plh_return_segs; /* invalid layout segments */
211	unsigned long		plh_block_lgets; /* block LAYOUTGET if >0 */
212	unsigned long		plh_retry_timestamp;
213	unsigned long		plh_flags;
214	nfs4_stateid		plh_stateid;
215	u32			plh_barrier; /* ignore lower seqids */
216	u32			plh_return_seq;
217	enum pnfs_iomode	plh_return_iomode;
218	loff_t			plh_lwb; /* last write byte for layoutcommit */
219	const struct cred	*plh_lc_cred; /* layoutcommit cred */
220	struct inode		*plh_inode;
221	struct rcu_head		plh_rcu;
222};
223
224struct pnfs_device {
225	struct nfs4_deviceid dev_id;
226	unsigned int  layout_type;
227	unsigned int  mincount;
228	unsigned int  maxcount;	/* gdia_maxcount */
229	struct page **pages;
230	unsigned int  pgbase;
231	unsigned int  pglen;	/* reply buffer length */
232	unsigned char nocache : 1;/* May not be cached */
233};
234
235#define NFS4_PNFS_GETDEVLIST_MAXNUM 16
236
237struct pnfs_devicelist {
238	unsigned int		eof;
239	unsigned int		num_devs;
240	struct nfs4_deviceid	dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
241};
242
243extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
244extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
245extern const struct pnfs_layoutdriver_type *pnfs_find_layoutdriver(u32 id);
246extern void pnfs_put_layoutdriver(const struct pnfs_layoutdriver_type *ld);
247
248/* nfs4proc.c */
249#define PNFS_FL_LAYOUTRETURN_ASYNC (1U << 0)
250#define PNFS_FL_LAYOUTRETURN_PRIVILEGED (1U << 1)
251
252extern size_t max_response_pages(struct nfs_server *server);
253extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
254				   struct pnfs_device *dev,
255				   const struct cred *cred);
256extern struct pnfs_layout_segment *
257nfs4_proc_layoutget(struct nfs4_layoutget *lgp,
258		    struct nfs4_exception *exception);
259extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp,
260				  unsigned int flags);
261
262/* pnfs.c */
263void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
264void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
265
266void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, struct nfs_fsinfo *);
267void unset_pnfs_layoutdriver(struct nfs_server *);
268void pnfs_generic_pg_check_layout(struct nfs_pageio_descriptor *pgio, struct nfs_page *req);
269void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
270int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
271void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
272			        struct nfs_page *req, u64 wb_size);
273void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
274int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
275size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
276			    struct nfs_page *prev, struct nfs_page *req);
277void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
278struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
279void pnfs_layoutget_free(struct nfs4_layoutget *lgp);
280void pnfs_free_lseg_list(struct list_head *tmp_list);
281void pnfs_destroy_layout(struct nfs_inode *);
282void pnfs_destroy_layout_final(struct nfs_inode *);
283void pnfs_destroy_all_layouts(struct nfs_client *);
284int pnfs_layout_destroy_byfsid(struct nfs_client *clp, struct nfs_fsid *fsid,
285			       enum pnfs_layout_destroy_mode mode);
286int pnfs_layout_destroy_byclid(struct nfs_client *clp,
287			       enum pnfs_layout_destroy_mode mode);
288bool nfs4_layout_refresh_old_stateid(nfs4_stateid *dst,
289		struct pnfs_layout_range *dst_range,
290		struct inode *inode);
291void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
292void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
293			     const nfs4_stateid *new,
294			     const struct cred *cred,
295			     bool update_barrier);
296int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
297				struct list_head *tmp_list,
298				const struct pnfs_layout_range *recall_range,
299				u32 seq);
300int pnfs_mark_matching_lsegs_return(struct pnfs_layout_hdr *lo,
301				struct list_head *tmp_list,
302				const struct pnfs_layout_range *recall_range,
303				u32 seq);
304int pnfs_mark_layout_stateid_invalid(struct pnfs_layout_hdr *lo,
305		struct list_head *lseg_list);
306bool pnfs_roc(struct inode *ino, struct nfs4_layoutreturn_args *args,
307	      struct nfs4_layoutreturn_res *res, const struct cred *cred,
308	      bool sync);
309int pnfs_roc_done(struct rpc_task *task, struct nfs4_layoutreturn_args **argpp,
310		  struct nfs4_layoutreturn_res **respp, int *ret);
311void pnfs_roc_release(struct nfs4_layoutreturn_args *args,
312		struct nfs4_layoutreturn_res *res,
313		int ret);
314bool pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task);
315void pnfs_set_layoutcommit(struct inode *, struct pnfs_layout_segment *, loff_t);
316void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
317int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
318int pnfs_generic_sync(struct inode *inode, bool datasync);
319int pnfs_nfs_generic_sync(struct inode *inode, bool datasync);
320int _pnfs_return_layout(struct inode *);
321int pnfs_commit_and_return_layout(struct inode *);
322void pnfs_ld_write_done(struct nfs_pgio_header *);
323void pnfs_ld_read_done(struct nfs_pgio_header *);
324void pnfs_read_resend_pnfs(struct nfs_pgio_header *, unsigned int mirror_idx);
325struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
326					       struct nfs_open_context *ctx,
327					       loff_t pos,
328					       u64 count,
329					       enum pnfs_iomode iomode,
330					       bool strict_iomode,
331					       gfp_t gfp_flags);
332void pnfs_layoutreturn_retry_later(struct pnfs_layout_hdr *lo,
333				   const nfs4_stateid *arg_stateid,
334				   const struct pnfs_layout_range *range);
335void pnfs_layoutreturn_free_lsegs(struct pnfs_layout_hdr *lo,
336		const nfs4_stateid *arg_stateid,
337		const struct pnfs_layout_range *range,
338		const nfs4_stateid *stateid);
339
340void pnfs_generic_layout_insert_lseg(struct pnfs_layout_hdr *lo,
341		   struct pnfs_layout_segment *lseg,
342		   bool (*is_after)(const struct pnfs_layout_range *lseg_range,
343			   const struct pnfs_layout_range *old),
344		   bool (*do_merge)(struct pnfs_layout_segment *lseg,
345			   struct pnfs_layout_segment *old),
346		   struct list_head *free_me);
347
348void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
349int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
350int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
351struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
352void pnfs_error_mark_layout_for_return(struct inode *inode,
353				       struct pnfs_layout_segment *lseg);
354void pnfs_layout_return_unused_byclid(struct nfs_client *clp,
355				      enum pnfs_iomode iomode);
356int pnfs_layout_handle_reboot(struct nfs_client *clp);
357
358/* nfs4_deviceid_flags */
359enum {
360	NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
361	NFS_DEVICEID_UNAVAILABLE,	/* device temporarily unavailable */
362	NFS_DEVICEID_NOCACHE,		/* device may not be cached */
363};
364
365/* pnfs_dev.c */
366struct nfs4_deviceid_node {
367	struct hlist_node		node;
368	struct hlist_node		tmpnode;
369	const struct pnfs_layoutdriver_type *ld;
370	const struct nfs_client		*nfs_client;
371	unsigned long 			flags;
372	unsigned long			timestamp_unavailable;
373	struct nfs4_deviceid		deviceid;
374	struct rcu_head			rcu;
375	atomic_t			ref;
376};
377
378struct nfs4_deviceid_node *
379nfs4_find_get_deviceid(struct nfs_server *server,
380		const struct nfs4_deviceid *id, const struct cred *cred,
381		gfp_t gfp_mask);
382void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
383void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
384			     const struct nfs4_deviceid *);
385bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
386void nfs4_mark_deviceid_available(struct nfs4_deviceid_node *node);
387void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
388bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
389void nfs4_deviceid_purge_client(const struct nfs_client *);
390
391/* pnfs_nfs.c */
392struct pnfs_commit_array *pnfs_alloc_commit_array(size_t n, gfp_t gfp_flags);
393void pnfs_free_commit_array(struct pnfs_commit_array *p);
394struct pnfs_commit_array *pnfs_add_commit_array(struct pnfs_ds_commit_info *,
395						struct pnfs_commit_array *,
396						struct pnfs_layout_segment *);
397
398void pnfs_generic_ds_cinfo_release_lseg(struct pnfs_ds_commit_info *fl_cinfo,
399		struct pnfs_layout_segment *lseg);
400void pnfs_generic_ds_cinfo_destroy(struct pnfs_ds_commit_info *fl_cinfo);
401
402void pnfs_generic_clear_request_commit(struct nfs_page *req,
403				       struct nfs_commit_info *cinfo);
404void pnfs_generic_commit_release(void *calldata);
405void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
406void pnfs_generic_rw_release(void *data);
407void pnfs_generic_recover_commit_reqs(struct list_head *dst,
408				      struct nfs_commit_info *cinfo);
409int pnfs_generic_commit_pagelist(struct inode *inode,
410				 struct list_head *mds_pages,
411				 int how,
412				 struct nfs_commit_info *cinfo,
413				 int (*initiate_commit)(struct nfs_commit_data *data,
414							int how));
415int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
416void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
417void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
418struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(const struct net *net,
419				      struct list_head *dsaddrs,
420				      gfp_t gfp_flags);
421void nfs4_pnfs_v3_ds_connect_unload(void);
422int nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
423			  struct nfs4_deviceid_node *devid, unsigned int timeo,
424			  unsigned int retrans, u32 version, u32 minor_version);
425struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
426						 struct xdr_stream *xdr,
427						 gfp_t gfp_flags);
428void pnfs_layout_mark_request_commit(struct nfs_page *req,
429				     struct pnfs_layout_segment *lseg,
430				     struct nfs_commit_info *cinfo,
431				     u32 ds_commit_idx);
432void pnfs_lgopen_prepare(struct nfs4_opendata *data,
433			 struct nfs_open_context *ctx);
434void pnfs_parse_lgopen(struct inode *ino, struct nfs4_layoutget *lgp,
435		       struct nfs_open_context *ctx);
436void nfs4_lgopen_release(struct nfs4_layoutget *lgp);
437
438static inline bool nfs_have_layout(struct inode *inode)
439{
440	return NFS_I(inode)->layout != NULL;
441}
442
443static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
444{
445	return test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags) == 0;
446}
447
448static inline struct nfs4_deviceid_node *
449nfs4_get_deviceid(struct nfs4_deviceid_node *d)
450{
451	atomic_inc(&d->ref);
452	return d;
453}
454
455static inline struct pnfs_layout_segment *
456pnfs_get_lseg(struct pnfs_layout_segment *lseg)
457{
458	if (lseg) {
459		refcount_inc(&lseg->pls_refcount);
460		smp_mb__after_atomic();
461	}
462	return lseg;
463}
464
465static inline bool
466pnfs_is_valid_lseg(struct pnfs_layout_segment *lseg)
467{
468	return test_bit(NFS_LSEG_VALID, &lseg->pls_flags) != 0;
469}
470
471/* Return true if a layout driver is being used for this mountpoint */
472static inline int pnfs_enabled_sb(struct nfs_server *nfss)
473{
474	return nfss->pnfs_curr_ld != NULL;
475}
476
477static inline int
478pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
479		 struct nfs_commit_info *cinfo)
480{
481	struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
482
483	if (fl_cinfo == NULL || fl_cinfo->ncommitting == 0)
484		return PNFS_NOT_ATTEMPTED;
485	return fl_cinfo->ops->commit_pagelist(inode, mds_pages, how, cinfo);
486}
487
488static inline struct pnfs_ds_commit_info *
489pnfs_get_ds_info(struct inode *inode)
490{
491	struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
492
493	if (ld == NULL || ld->get_ds_info == NULL)
494		return NULL;
495	return ld->get_ds_info(inode);
496}
497
498static inline void
499pnfs_init_ds_commit_info_ops(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
500{
501	struct pnfs_ds_commit_info *inode_cinfo = pnfs_get_ds_info(inode);
502	if (inode_cinfo != NULL)
503		fl_cinfo->ops = inode_cinfo->ops;
504}
505
506static inline void
507pnfs_init_ds_commit_info(struct pnfs_ds_commit_info *fl_cinfo)
508{
509	INIT_LIST_HEAD(&fl_cinfo->commits);
510	fl_cinfo->ops = NULL;
511}
512
513static inline void
514pnfs_release_ds_info(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
515{
516	if (fl_cinfo->ops != NULL && fl_cinfo->ops->release_ds_info != NULL)
517		fl_cinfo->ops->release_ds_info(fl_cinfo, inode);
518}
519
520static inline void
521pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
522{
523	set_bit(NFS_DEVICEID_INVALID, &node->flags);
524}
525
526static inline bool
527pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
528			 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
529{
530	struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
531
532	if (!lseg || !fl_cinfo->ops || !fl_cinfo->ops->mark_request_commit)
533		return false;
534	fl_cinfo->ops->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
535	return true;
536}
537
538static inline bool
539pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
540{
541	struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
542
543	if (!fl_cinfo || !fl_cinfo->ops || !fl_cinfo->ops->clear_request_commit)
544		return false;
545	fl_cinfo->ops->clear_request_commit(req, cinfo);
546	return true;
547}
548
549static inline int
550pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
551		       int max)
552{
553	struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
554
555	if (!fl_cinfo || fl_cinfo->nwritten == 0)
556		return 0;
557	return fl_cinfo->ops->scan_commit_lists(cinfo, max);
558}
559
560static inline void
561pnfs_recover_commit_reqs(struct list_head *head, struct nfs_commit_info *cinfo)
562{
563	struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
564
565	if (fl_cinfo && fl_cinfo->nwritten != 0)
566		fl_cinfo->ops->recover_commit_reqs(head, cinfo);
567}
568
569/* Should the pNFS client commit and return the layout upon a setattr */
570static inline bool
571pnfs_ld_layoutret_on_setattr(struct inode *inode)
572{
573	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
574		return false;
575	return NFS_SERVER(inode)->pnfs_curr_ld->flags &
576		PNFS_LAYOUTRET_ON_SETATTR;
577}
578
579static inline bool
580pnfs_ld_read_whole_page(struct inode *inode)
581{
582	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
583		return false;
584	return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
585}
586
587static inline int
588pnfs_sync_inode(struct inode *inode, bool datasync)
589{
590	if (!pnfs_enabled_sb(NFS_SERVER(inode)))
591		return 0;
592	return NFS_SERVER(inode)->pnfs_curr_ld->sync(inode, datasync);
593}
594
595static inline bool
596pnfs_layoutcommit_outstanding(struct inode *inode)
597{
598	struct nfs_inode *nfsi = NFS_I(inode);
599
600	return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
601		test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
602}
603
604static inline int pnfs_return_layout(struct inode *ino)
605{
606	struct nfs_inode *nfsi = NFS_I(ino);
607	struct nfs_server *nfss = NFS_SERVER(ino);
608
609	if (pnfs_enabled_sb(nfss) && nfsi->layout) {
610		set_bit(NFS_LAYOUT_RETURN_REQUESTED, &nfsi->layout->plh_flags);
611		return _pnfs_return_layout(ino);
612	}
613
614	return 0;
615}
616
617static inline bool
618pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
619		   struct nfs_server *nfss)
620{
621	return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
622					nfss->pnfs_curr_ld->id == src->l_type);
623}
624
625static inline u64
626pnfs_calc_offset_end(u64 offset, u64 len)
627{
628	if (len == NFS4_MAX_UINT64 || len >= NFS4_MAX_UINT64 - offset)
629		return NFS4_MAX_UINT64;
630	return offset + len - 1;
631}
632
633static inline u64
634pnfs_calc_offset_length(u64 offset, u64 end)
635{
636	if (end == NFS4_MAX_UINT64 || end <= offset)
637		return NFS4_MAX_UINT64;
638	return 1 + end - offset;
639}
640
641static inline void
642pnfs_copy_range(struct pnfs_layout_range *dst,
643		const struct pnfs_layout_range *src)
644{
645	memcpy(dst, src, sizeof(*dst));
646}
647
648static inline u64
649pnfs_end_offset(u64 start, u64 len)
650{
651	if (NFS4_MAX_UINT64 - start <= len)
652		return NFS4_MAX_UINT64;
653	return start + len;
654}
655
656/*
657 * Are 2 ranges intersecting?
658 *   start1                             end1
659 *   [----------------------------------)
660 *                                start2           end2
661 *                                [----------------)
662 */
663static inline bool
664pnfs_is_range_intersecting(u64 start1, u64 end1, u64 start2, u64 end2)
665{
666	return (end1 == NFS4_MAX_UINT64 || start2 < end1) &&
667		(end2 == NFS4_MAX_UINT64 || start1 < end2);
668}
669
670static inline bool
671pnfs_lseg_range_intersecting(const struct pnfs_layout_range *l1,
672		const struct pnfs_layout_range *l2)
673{
674	u64 end1 = pnfs_end_offset(l1->offset, l1->length);
675	u64 end2 = pnfs_end_offset(l2->offset, l2->length);
676
677	return pnfs_is_range_intersecting(l1->offset, end1, l2->offset, end2);
678}
679
680static inline bool
681pnfs_lseg_request_intersecting(struct pnfs_layout_segment *lseg, struct nfs_page *req)
682{
683	u64 seg_last = pnfs_end_offset(lseg->pls_range.offset, lseg->pls_range.length);
684	u64 req_last = req_offset(req) + req->wb_bytes;
685
686	return pnfs_is_range_intersecting(lseg->pls_range.offset, seg_last,
687				req_offset(req), req_last);
688}
689
690static inline void pnfs_lseg_cancel_io(struct nfs_server *server,
691				       struct pnfs_layout_segment *lseg)
692{
693	if (server->pnfs_curr_ld->cancel_io)
694		server->pnfs_curr_ld->cancel_io(lseg);
695}
696
697extern unsigned int layoutstats_timer;
698
699#ifdef NFS_DEBUG
700void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
701#else
702static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
703{
704}
705
706#endif /* NFS_DEBUG */
707#else  /* CONFIG_NFS_V4_1 */
708
709static inline bool nfs_have_layout(struct inode *inode)
710{
711	return false;
712}
713
714static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
715{
716}
717
718static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
719{
720}
721
722static inline void pnfs_destroy_layout_final(struct nfs_inode *nfsi)
723{
724}
725
726static inline int pnfs_layout_handle_reboot(struct nfs_client *clp)
727{
728	return 0;
729}
730
731static inline struct pnfs_layout_segment *
732pnfs_get_lseg(struct pnfs_layout_segment *lseg)
733{
734	return NULL;
735}
736
737static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
738{
739}
740
741static inline int pnfs_return_layout(struct inode *ino)
742{
743	return 0;
744}
745
746static inline int pnfs_commit_and_return_layout(struct inode *inode)
747{
748	return 0;
749}
750
751static inline bool
752pnfs_ld_layoutret_on_setattr(struct inode *inode)
753{
754	return false;
755}
756
757static inline bool
758pnfs_ld_read_whole_page(struct inode *inode)
759{
760	return false;
761}
762
763static inline int
764pnfs_sync_inode(struct inode *inode, bool datasync)
765{
766	return 0;
767}
768
769static inline bool
770pnfs_layoutcommit_outstanding(struct inode *inode)
771{
772	return false;
773}
774
775static inline bool pnfs_roc(struct inode *ino,
776			    struct nfs4_layoutreturn_args *args,
777			    struct nfs4_layoutreturn_res *res,
778			    const struct cred *cred, bool sync)
779{
780	return false;
781}
782
783static inline int
784pnfs_roc_done(struct rpc_task *task,
785		struct nfs4_layoutreturn_args **argpp,
786		struct nfs4_layoutreturn_res **respp,
787		int *ret)
788{
789	return 0;
790}
791
792static inline void
793pnfs_roc_release(struct nfs4_layoutreturn_args *args,
794		struct nfs4_layoutreturn_res *res,
795		int ret)
796{
797}
798
799static inline bool
800pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task)
801{
802	return false;
803}
804
805static inline void set_pnfs_layoutdriver(struct nfs_server *s,
806					 const struct nfs_fh *mntfh,
807					 struct nfs_fsinfo *fsinfo)
808{
809}
810
811static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
812{
813}
814
815static inline int
816pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
817		 struct nfs_commit_info *cinfo)
818{
819	return PNFS_NOT_ATTEMPTED;
820}
821
822static inline struct pnfs_ds_commit_info *
823pnfs_get_ds_info(struct inode *inode)
824{
825	return NULL;
826}
827
828static inline void
829pnfs_init_ds_commit_info_ops(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
830{
831}
832
833static inline void
834pnfs_init_ds_commit_info(struct pnfs_ds_commit_info *fl_cinfo)
835{
836}
837
838static inline void
839pnfs_release_ds_info(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
840{
841}
842
843static inline bool
844pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
845			 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
846{
847	return false;
848}
849
850static inline bool
851pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
852{
853	return false;
854}
855
856static inline int
857pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
858		       int max)
859{
860	return 0;
861}
862
863static inline void
864pnfs_recover_commit_reqs(struct list_head *head, struct nfs_commit_info *cinfo)
865{
866}
867
868static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
869{
870	return 0;
871}
872
873static inline bool
874pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
875		   struct nfs_server *nfss)
876{
877	return false;
878}
879
880static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
881{
882	return NULL;
883}
884
885static inline void nfs4_pnfs_v3_ds_connect_unload(void)
886{
887}
888
889static inline bool nfs4_layout_refresh_old_stateid(nfs4_stateid *dst,
890		struct pnfs_layout_range *dst_range,
891		struct inode *inode)
892{
893	return false;
894}
895
896static inline void pnfs_lgopen_prepare(struct nfs4_opendata *data,
897		struct nfs_open_context *ctx)
898{
899}
900
901static inline void pnfs_parse_lgopen(struct inode *ino,
902		struct nfs4_layoutget *lgp,
903		struct nfs_open_context *ctx)
904{
905}
906
907static inline void nfs4_lgopen_release(struct nfs4_layoutget *lgp)
908{
909}
910
911static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
912{
913	return false;
914}
915
916#endif /* CONFIG_NFS_V4_1 */
917
918#if IS_ENABLED(CONFIG_NFS_V4_2)
919int pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags);
920#else
921static inline int
922pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags)
923{
924	return 0;
925}
926#endif
927
928#endif /* FS_NFS_PNFS_H */