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