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