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