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