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 /* Individual ip address */
44 struct nfs4_pnfs_ds_addr {
45 struct sockaddr_storage da_addr;
47 struct list_head da_node; /* nfs4_pnfs_dev_hlist dev_dslist */
48 char *da_remotestr; /* human readable addr+port */
52 struct list_head ds_node; /* nfs4_pnfs_dev_hlist dev_dslist */
53 char *ds_remotestr; /* comma sep list of addrs */
54 struct list_head ds_addrs;
55 struct nfs_client *ds_clp;
57 unsigned long ds_state;
58 #define NFS4DS_CONNECTING 0 /* ds is establishing connection */
61 struct pnfs_layout_segment {
62 struct list_head pls_list;
63 struct list_head pls_lc_list;
64 struct pnfs_layout_range pls_range;
65 atomic_t pls_refcount;
66 unsigned long pls_flags;
67 struct pnfs_layout_hdr *pls_layout;
68 struct work_struct pls_work;
71 enum pnfs_try_status {
73 PNFS_NOT_ATTEMPTED = 1,
76 #ifdef CONFIG_NFS_V4_1
78 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
81 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
82 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
83 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
84 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
85 NFS_LAYOUT_RETURN, /* Return this layout ASAP */
86 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
89 enum layoutdriver_policy_flags {
90 /* Should the pNFS client commit and return the layout upon truncate to
92 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
93 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
94 PNFS_READ_WHOLE_PAGE = 1 << 2,
97 struct nfs4_deviceid_node;
99 /* Per-layout driver specific registration structure */
100 struct pnfs_layoutdriver_type {
101 struct list_head pnfs_tblid;
104 struct module *owner;
106 unsigned max_deviceinfo_size;
108 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
109 int (*clear_layoutdriver) (struct nfs_server *);
111 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
112 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
114 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
115 void (*free_lseg) (struct pnfs_layout_segment *lseg);
117 void (*return_range) (struct pnfs_layout_hdr *lo,
118 struct pnfs_layout_range *range);
120 /* test for nfs page cache coalescing */
121 const struct nfs_pageio_ops *pg_read_ops;
122 const struct nfs_pageio_ops *pg_write_ops;
124 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
125 void (*mark_request_commit) (struct nfs_page *req,
126 struct pnfs_layout_segment *lseg,
127 struct nfs_commit_info *cinfo);
128 void (*clear_request_commit) (struct nfs_page *req,
129 struct nfs_commit_info *cinfo);
130 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
132 void (*recover_commit_reqs) (struct list_head *list,
133 struct nfs_commit_info *cinfo);
134 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
136 int (*commit_pagelist)(struct inode *inode,
137 struct list_head *mds_pages,
139 struct nfs_commit_info *cinfo);
142 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
143 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
145 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
146 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
148 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
149 struct nfs4_deviceid_node * (*alloc_deviceid_node)
150 (struct nfs_server *server, struct pnfs_device *pdev,
153 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
154 struct xdr_stream *xdr,
155 const struct nfs4_layoutreturn_args *args);
157 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
158 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
159 void (*encode_layoutcommit) (struct pnfs_layout_hdr *lo,
160 struct xdr_stream *xdr,
161 const struct nfs4_layoutcommit_args *args);
164 struct pnfs_layout_hdr {
165 atomic_t plh_refcount;
166 struct list_head plh_layouts; /* other client layouts */
167 struct list_head plh_bulk_destroy;
168 struct list_head plh_segs; /* layout segments list */
169 nfs4_stateid plh_stateid;
170 atomic_t plh_outstanding; /* number of RPCs out */
171 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
172 u32 plh_barrier; /* ignore lower seqids */
173 unsigned long plh_retry_timestamp;
174 unsigned long plh_flags;
175 loff_t plh_lwb; /* last write byte for layoutcommit */
176 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
177 struct inode *plh_inode;
181 struct nfs4_deviceid dev_id;
182 unsigned int layout_type;
183 unsigned int mincount;
184 unsigned int maxcount; /* gdia_maxcount */
187 unsigned int pglen; /* reply buffer length */
190 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
192 struct pnfs_devicelist {
194 unsigned int num_devs;
195 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
198 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
199 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
202 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
203 struct pnfs_device *dev,
204 struct rpc_cred *cred);
205 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
206 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
209 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
210 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
211 void pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg);
213 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
214 void unset_pnfs_layoutdriver(struct nfs_server *);
215 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
216 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
217 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
218 struct nfs_page *req, u64 wb_size);
219 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
220 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
221 struct nfs_page *prev, struct nfs_page *req);
222 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
223 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
224 void pnfs_free_lseg_list(struct list_head *tmp_list);
225 void pnfs_destroy_layout(struct nfs_inode *);
226 void pnfs_destroy_all_layouts(struct nfs_client *);
227 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
228 struct nfs_fsid *fsid,
230 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
232 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
233 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
234 const nfs4_stateid *new,
235 bool update_barrier);
236 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
237 struct pnfs_layout_hdr *lo,
238 struct nfs4_state *open_state);
239 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
240 struct list_head *tmp_list,
241 struct pnfs_layout_range *recall_range);
242 bool pnfs_roc(struct inode *ino);
243 void pnfs_roc_release(struct inode *ino);
244 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
245 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
246 void pnfs_set_layoutcommit(struct nfs_pgio_header *);
247 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data);
248 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
249 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
250 int _pnfs_return_layout(struct inode *);
251 int pnfs_commit_and_return_layout(struct inode *);
252 void pnfs_ld_write_done(struct nfs_pgio_header *);
253 void pnfs_ld_read_done(struct nfs_pgio_header *);
254 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
255 struct nfs_open_context *ctx,
258 enum pnfs_iomode iomode,
261 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
262 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
263 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
264 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
266 /* nfs4_deviceid_flags */
268 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
269 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
273 struct nfs4_deviceid_node {
274 struct hlist_node node;
275 struct hlist_node tmpnode;
276 const struct pnfs_layoutdriver_type *ld;
277 const struct nfs_client *nfs_client;
279 unsigned long timestamp_unavailable;
280 struct nfs4_deviceid deviceid;
284 struct nfs4_deviceid_node *
285 nfs4_find_get_deviceid(struct nfs_server *server,
286 const struct nfs4_deviceid *id, struct rpc_cred *cred,
288 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
289 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
290 const struct nfs4_deviceid *);
291 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
292 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
293 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
294 void nfs4_deviceid_purge_client(const struct nfs_client *);
297 void pnfs_generic_clear_request_commit(struct nfs_page *req,
298 struct nfs_commit_info *cinfo);
299 void pnfs_generic_commit_release(void *calldata);
300 void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
301 void pnfs_generic_rw_release(void *data);
302 void pnfs_generic_recover_commit_reqs(struct list_head *dst,
303 struct nfs_commit_info *cinfo);
304 int pnfs_generic_commit_pagelist(struct inode *inode,
305 struct list_head *mds_pages,
307 struct nfs_commit_info *cinfo,
308 int (*initiate_commit)(struct nfs_commit_data *data,
310 int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
311 void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
312 void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
313 struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
315 void nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
316 struct nfs4_deviceid_node *devid, unsigned int timeo,
317 unsigned int retrans, rpc_authflavor_t au_flavor);
318 struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
319 struct xdr_stream *xdr,
322 static inline struct nfs4_deviceid_node *
323 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
329 static inline struct pnfs_layout_segment *
330 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
333 atomic_inc(&lseg->pls_refcount);
334 smp_mb__after_atomic();
339 /* Return true if a layout driver is being used for this mountpoint */
340 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
342 return nfss->pnfs_curr_ld != NULL;
346 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
347 struct nfs_commit_info *cinfo)
349 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
350 return PNFS_NOT_ATTEMPTED;
351 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
354 static inline struct pnfs_ds_commit_info *
355 pnfs_get_ds_info(struct inode *inode)
357 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
359 if (ld == NULL || ld->get_ds_info == NULL)
361 return ld->get_ds_info(inode);
365 pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
367 set_bit(NFS_DEVICEID_INVALID, &node->flags);
371 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
372 struct nfs_commit_info *cinfo)
374 struct inode *inode = req->wb_context->dentry->d_inode;
375 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
377 if (lseg == NULL || ld->mark_request_commit == NULL)
379 ld->mark_request_commit(req, lseg, cinfo);
384 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
386 struct inode *inode = req->wb_context->dentry->d_inode;
387 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
389 if (ld == NULL || ld->clear_request_commit == NULL)
391 ld->clear_request_commit(req, cinfo);
396 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
399 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
402 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
405 static inline struct nfs_page *
406 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
409 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
411 if (ld == NULL || ld->search_commit_reqs == NULL)
413 return ld->search_commit_reqs(cinfo, page);
416 /* Should the pNFS client commit and return the layout upon a setattr */
418 pnfs_ld_layoutret_on_setattr(struct inode *inode)
420 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
422 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
423 PNFS_LAYOUTRET_ON_SETATTR;
427 pnfs_ld_read_whole_page(struct inode *inode)
429 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
431 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
435 pnfs_layoutcommit_outstanding(struct inode *inode)
437 struct nfs_inode *nfsi = NFS_I(inode);
439 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
440 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
443 static inline int pnfs_return_layout(struct inode *ino)
445 struct nfs_inode *nfsi = NFS_I(ino);
446 struct nfs_server *nfss = NFS_SERVER(ino);
448 if (pnfs_enabled_sb(nfss) && nfsi->layout)
449 return _pnfs_return_layout(ino);
455 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
456 struct nfs_server *nfss)
458 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
459 nfss->pnfs_curr_ld->id == src->l_type);
463 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
465 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
468 #endif /* NFS_DEBUG */
469 #else /* CONFIG_NFS_V4_1 */
471 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
475 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
479 static inline struct pnfs_layout_segment *
480 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
485 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
489 static inline int pnfs_return_layout(struct inode *ino)
494 static inline int pnfs_commit_and_return_layout(struct inode *inode)
500 pnfs_ld_layoutret_on_setattr(struct inode *inode)
506 pnfs_ld_read_whole_page(struct inode *inode)
512 pnfs_roc(struct inode *ino)
518 pnfs_roc_release(struct inode *ino)
523 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
528 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
533 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
534 const struct nfs_fh *mntfh, u32 id)
538 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
543 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
544 struct nfs_commit_info *cinfo)
546 return PNFS_NOT_ATTEMPTED;
549 static inline struct pnfs_ds_commit_info *
550 pnfs_get_ds_info(struct inode *inode)
556 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
557 struct nfs_commit_info *cinfo)
563 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
569 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
575 static inline struct nfs_page *
576 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
582 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
588 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
589 struct nfs_server *nfss)
595 pnfs_layoutcommit_outstanding(struct inode *inode)
601 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
606 #endif /* CONFIG_NFS_V4_1 */
608 #endif /* FS_NFS_PNFS_H */