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