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