2 * pNFS client data structures.
5 * The Regents of the University of Michigan
8 * Dean Hildebrand <dhildebz@umich.edu>
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.
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
33 #include <linux/nfs_fs.h>
34 #include <linux/nfs_page.h>
35 #include <linux/workqueue.h>
38 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
39 NFS_LSEG_ROC, /* roc bit received from server */
40 NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
43 struct pnfs_layout_segment {
44 struct list_head pls_list;
45 struct list_head pls_lc_list;
46 struct pnfs_layout_range pls_range;
47 atomic_t pls_refcount;
48 unsigned long pls_flags;
49 struct pnfs_layout_hdr *pls_layout;
50 struct work_struct pls_work;
53 enum pnfs_try_status {
55 PNFS_NOT_ATTEMPTED = 1,
58 #ifdef CONFIG_NFS_V4_1
60 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
63 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
64 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
65 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
66 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
67 NFS_LAYOUT_RETURN, /* Return this layout ASAP */
68 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
71 enum layoutdriver_policy_flags {
72 /* Should the pNFS client commit and return the layout upon a setattr */
73 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
74 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
75 PNFS_READ_WHOLE_PAGE = 1 << 2,
78 struct nfs4_deviceid_node;
80 /* Per-layout driver specific registration structure */
81 struct pnfs_layoutdriver_type {
82 struct list_head pnfs_tblid;
88 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
89 int (*clear_layoutdriver) (struct nfs_server *);
91 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
92 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
94 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
95 void (*free_lseg) (struct pnfs_layout_segment *lseg);
97 void (*return_range) (struct pnfs_layout_hdr *lo,
98 struct pnfs_layout_range *range);
100 /* test for nfs page cache coalescing */
101 const struct nfs_pageio_ops *pg_read_ops;
102 const struct nfs_pageio_ops *pg_write_ops;
104 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
105 void (*mark_request_commit) (struct nfs_page *req,
106 struct pnfs_layout_segment *lseg,
107 struct nfs_commit_info *cinfo);
108 void (*clear_request_commit) (struct nfs_page *req,
109 struct nfs_commit_info *cinfo);
110 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
112 void (*recover_commit_reqs) (struct list_head *list,
113 struct nfs_commit_info *cinfo);
114 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
116 int (*commit_pagelist)(struct inode *inode,
117 struct list_head *mds_pages,
119 struct nfs_commit_info *cinfo);
122 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
123 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
125 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
126 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
128 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
130 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
131 struct xdr_stream *xdr,
132 const struct nfs4_layoutreturn_args *args);
134 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
135 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
136 void (*encode_layoutcommit) (struct pnfs_layout_hdr *lo,
137 struct xdr_stream *xdr,
138 const struct nfs4_layoutcommit_args *args);
141 struct pnfs_layout_hdr {
142 atomic_t plh_refcount;
143 struct list_head plh_layouts; /* other client layouts */
144 struct list_head plh_bulk_destroy;
145 struct list_head plh_segs; /* layout segments list */
146 nfs4_stateid plh_stateid;
147 atomic_t plh_outstanding; /* number of RPCs out */
148 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
149 u32 plh_barrier; /* ignore lower seqids */
150 unsigned long plh_retry_timestamp;
151 unsigned long plh_flags;
152 loff_t plh_lwb; /* last write byte for layoutcommit */
153 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
154 struct inode *plh_inode;
158 struct nfs4_deviceid dev_id;
159 unsigned int layout_type;
160 unsigned int mincount;
161 unsigned int maxcount; /* gdia_maxcount */
164 unsigned int pglen; /* reply buffer length */
167 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
169 struct pnfs_devicelist {
171 unsigned int num_devs;
172 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
175 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
176 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
179 extern int nfs4_proc_getdevicelist(struct nfs_server *server,
180 const struct nfs_fh *fh,
181 struct pnfs_devicelist *devlist);
182 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
183 struct pnfs_device *dev,
184 struct rpc_cred *cred);
185 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
186 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
189 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
190 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
191 void pnfs_put_lseg_async(struct pnfs_layout_segment *lseg);
193 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
194 void unset_pnfs_layoutdriver(struct nfs_server *);
195 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
196 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
197 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
198 struct nfs_page *req, u64 wb_size);
199 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
200 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
201 struct nfs_page *prev, struct nfs_page *req);
202 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
203 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
204 void pnfs_free_lseg_list(struct list_head *tmp_list);
205 void pnfs_destroy_layout(struct nfs_inode *);
206 void pnfs_destroy_all_layouts(struct nfs_client *);
207 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
208 struct nfs_fsid *fsid,
210 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
212 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
213 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
214 const nfs4_stateid *new,
215 bool update_barrier);
216 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
217 struct pnfs_layout_hdr *lo,
218 struct nfs4_state *open_state);
219 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
220 struct list_head *tmp_list,
221 struct pnfs_layout_range *recall_range);
222 bool pnfs_roc(struct inode *ino);
223 void pnfs_roc_release(struct inode *ino);
224 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
225 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
226 void pnfs_set_layoutcommit(struct nfs_pgio_header *);
227 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data);
228 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
229 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
230 int _pnfs_return_layout(struct inode *);
231 int pnfs_commit_and_return_layout(struct inode *);
232 void pnfs_ld_write_done(struct nfs_pgio_header *);
233 void pnfs_ld_read_done(struct nfs_pgio_header *);
234 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
235 struct nfs_open_context *ctx,
238 enum pnfs_iomode iomode,
241 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
242 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
243 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
244 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
246 /* nfs4_deviceid_flags */
248 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
249 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
253 struct nfs4_deviceid_node {
254 struct hlist_node node;
255 struct hlist_node tmpnode;
256 const struct pnfs_layoutdriver_type *ld;
257 const struct nfs_client *nfs_client;
259 unsigned long timestamp_unavailable;
260 struct nfs4_deviceid deviceid;
264 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
265 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
266 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
267 const struct pnfs_layoutdriver_type *,
268 const struct nfs_client *,
269 const struct nfs4_deviceid *);
270 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
271 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
272 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
273 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
274 void nfs4_deviceid_purge_client(const struct nfs_client *);
276 static inline struct pnfs_layout_segment *
277 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
280 atomic_inc(&lseg->pls_refcount);
281 smp_mb__after_atomic();
286 /* Return true if a layout driver is being used for this mountpoint */
287 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
289 return nfss->pnfs_curr_ld != NULL;
293 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
294 struct nfs_commit_info *cinfo)
296 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
297 return PNFS_NOT_ATTEMPTED;
298 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
301 static inline struct pnfs_ds_commit_info *
302 pnfs_get_ds_info(struct inode *inode)
304 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
306 if (ld == NULL || ld->get_ds_info == NULL)
308 return ld->get_ds_info(inode);
312 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
313 struct nfs_commit_info *cinfo)
315 struct inode *inode = req->wb_context->dentry->d_inode;
316 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
318 if (lseg == NULL || ld->mark_request_commit == NULL)
320 ld->mark_request_commit(req, lseg, cinfo);
325 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
327 struct inode *inode = req->wb_context->dentry->d_inode;
328 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
330 if (ld == NULL || ld->clear_request_commit == NULL)
332 ld->clear_request_commit(req, cinfo);
337 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
340 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
343 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
347 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
348 struct nfs_commit_info *cinfo)
350 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
352 NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
355 static inline struct nfs_page *
356 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
359 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
361 if (ld == NULL || ld->search_commit_reqs == NULL)
363 return ld->search_commit_reqs(cinfo, page);
366 /* Should the pNFS client commit and return the layout upon a setattr */
368 pnfs_ld_layoutret_on_setattr(struct inode *inode)
370 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
372 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
373 PNFS_LAYOUTRET_ON_SETATTR;
377 pnfs_ld_read_whole_page(struct inode *inode)
379 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
381 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
385 pnfs_layoutcommit_outstanding(struct inode *inode)
387 struct nfs_inode *nfsi = NFS_I(inode);
389 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
390 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
393 static inline int pnfs_return_layout(struct inode *ino)
395 struct nfs_inode *nfsi = NFS_I(ino);
396 struct nfs_server *nfss = NFS_SERVER(ino);
398 if (pnfs_enabled_sb(nfss) && nfsi->layout)
399 return _pnfs_return_layout(ino);
405 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
406 struct nfs_server *nfss)
408 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
409 nfss->pnfs_curr_ld->id == src->l_type);
413 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
415 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
418 #endif /* NFS_DEBUG */
419 #else /* CONFIG_NFS_V4_1 */
421 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
425 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
429 static inline struct pnfs_layout_segment *
430 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
435 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
439 static inline void pnfs_put_lseg_async(struct pnfs_layout_segment *lseg)
443 static inline int pnfs_return_layout(struct inode *ino)
448 static inline int pnfs_commit_and_return_layout(struct inode *inode)
454 pnfs_ld_layoutret_on_setattr(struct inode *inode)
460 pnfs_ld_read_whole_page(struct inode *inode)
466 pnfs_roc(struct inode *ino)
472 pnfs_roc_release(struct inode *ino)
477 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
482 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
487 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
488 const struct nfs_fh *mntfh, u32 id)
492 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
497 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
498 struct nfs_commit_info *cinfo)
500 return PNFS_NOT_ATTEMPTED;
503 static inline struct pnfs_ds_commit_info *
504 pnfs_get_ds_info(struct inode *inode)
510 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
511 struct nfs_commit_info *cinfo)
517 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
523 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
530 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
531 struct nfs_commit_info *cinfo)
535 static inline struct nfs_page *
536 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
542 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
548 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
549 struct nfs_server *nfss)
555 pnfs_layoutcommit_outstanding(struct inode *inode)
561 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
566 #endif /* CONFIG_NFS_V4_1 */
568 #endif /* FS_NFS_PNFS_H */