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