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