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 */
41 NFS_LSEG_LAYOUTRETURN, /* layoutreturn bit set for layoutreturn */
44 /* Individual ip address */
45 struct nfs4_pnfs_ds_addr {
46 struct sockaddr_storage da_addr;
48 struct list_head da_node; /* nfs4_pnfs_dev_hlist dev_dslist */
49 char *da_remotestr; /* human readable addr+port */
53 struct list_head ds_node; /* nfs4_pnfs_dev_hlist dev_dslist */
54 char *ds_remotestr; /* comma sep list of addrs */
55 struct list_head ds_addrs;
56 struct nfs_client *ds_clp;
58 unsigned long ds_state;
59 #define NFS4DS_CONNECTING 0 /* ds is establishing connection */
62 struct pnfs_layout_segment {
63 struct list_head pls_list;
64 struct list_head pls_lc_list;
65 struct pnfs_layout_range pls_range;
66 atomic_t pls_refcount;
67 unsigned long pls_flags;
68 struct pnfs_layout_hdr *pls_layout;
69 struct work_struct pls_work;
72 enum pnfs_try_status {
74 PNFS_NOT_ATTEMPTED = 1,
78 #ifdef CONFIG_NFS_V4_1
80 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
83 * Default data server connection timeout and retrans vaules.
84 * Set by module parameters dataserver_timeo and dataserver_retrans.
86 #define NFS4_DEF_DS_TIMEO 600 /* in tenths of a second */
87 #define NFS4_DEF_DS_RETRANS 5
89 /* error codes for internal use */
90 #define NFS4ERR_RESET_TO_MDS 12001
91 #define NFS4ERR_RESET_TO_PNFS 12002
94 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
95 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
96 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
97 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
98 NFS_LAYOUT_RETURN, /* Return this layout ASAP */
99 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
100 NFS_LAYOUT_FIRST_LAYOUTGET, /* Serialize first layoutget */
103 enum layoutdriver_policy_flags {
104 /* Should the pNFS client commit and return the layout upon truncate to
106 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
107 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
108 PNFS_READ_WHOLE_PAGE = 1 << 2,
111 struct nfs4_deviceid_node;
113 /* Per-layout driver specific registration structure */
114 struct pnfs_layoutdriver_type {
115 struct list_head pnfs_tblid;
118 struct module *owner;
120 unsigned max_deviceinfo_size;
122 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
123 int (*clear_layoutdriver) (struct nfs_server *);
125 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
126 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
128 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
129 void (*free_lseg) (struct pnfs_layout_segment *lseg);
131 void (*return_range) (struct pnfs_layout_hdr *lo,
132 struct pnfs_layout_range *range);
134 /* test for nfs page cache coalescing */
135 const struct nfs_pageio_ops *pg_read_ops;
136 const struct nfs_pageio_ops *pg_write_ops;
138 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
139 void (*mark_request_commit) (struct nfs_page *req,
140 struct pnfs_layout_segment *lseg,
141 struct nfs_commit_info *cinfo,
143 void (*clear_request_commit) (struct nfs_page *req,
144 struct nfs_commit_info *cinfo);
145 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
147 void (*recover_commit_reqs) (struct list_head *list,
148 struct nfs_commit_info *cinfo);
149 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
151 int (*commit_pagelist)(struct inode *inode,
152 struct list_head *mds_pages,
154 struct nfs_commit_info *cinfo);
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
160 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
161 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
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,
168 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
169 struct xdr_stream *xdr,
170 const struct nfs4_layoutreturn_args *args);
172 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
173 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
174 void (*encode_layoutcommit) (struct pnfs_layout_hdr *lo,
175 struct xdr_stream *xdr,
176 const struct nfs4_layoutcommit_args *args);
179 struct pnfs_layout_hdr {
180 atomic_t plh_refcount;
181 struct list_head plh_layouts; /* other client layouts */
182 struct list_head plh_bulk_destroy;
183 struct list_head plh_segs; /* layout segments list */
184 nfs4_stateid plh_stateid;
185 atomic_t plh_outstanding; /* number of RPCs out */
186 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
187 u32 plh_barrier; /* ignore lower seqids */
188 unsigned long plh_retry_timestamp;
189 unsigned long plh_flags;
190 enum pnfs_iomode plh_return_iomode;
191 loff_t plh_lwb; /* last write byte for layoutcommit */
192 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
193 struct inode *plh_inode;
197 struct nfs4_deviceid dev_id;
198 unsigned int layout_type;
199 unsigned int mincount;
200 unsigned int maxcount; /* gdia_maxcount */
203 unsigned int pglen; /* reply buffer length */
206 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
208 struct pnfs_devicelist {
210 unsigned int num_devs;
211 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
214 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
215 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
218 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
219 struct pnfs_device *dev,
220 struct rpc_cred *cred);
221 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
222 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp, bool sync);
225 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
226 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
227 void pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg);
229 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
230 void unset_pnfs_layoutdriver(struct nfs_server *);
231 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
232 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
233 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
234 struct nfs_page *req, u64 wb_size);
235 void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
236 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
237 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
238 struct nfs_page *prev, struct nfs_page *req);
239 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
240 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
241 void pnfs_free_lseg_list(struct list_head *tmp_list);
242 void pnfs_destroy_layout(struct nfs_inode *);
243 void pnfs_destroy_all_layouts(struct nfs_client *);
244 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
245 struct nfs_fsid *fsid,
247 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
249 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
250 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
251 const nfs4_stateid *new,
252 bool update_barrier);
253 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
254 struct pnfs_layout_hdr *lo,
255 struct pnfs_layout_range *range,
256 struct nfs4_state *open_state);
257 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
258 struct list_head *tmp_list,
259 struct pnfs_layout_range *recall_range);
260 bool pnfs_roc(struct inode *ino);
261 void pnfs_roc_release(struct inode *ino);
262 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
263 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
264 void pnfs_set_layoutcommit(struct nfs_pgio_header *);
265 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data);
266 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
267 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
268 int _pnfs_return_layout(struct inode *);
269 int pnfs_commit_and_return_layout(struct inode *);
270 void pnfs_ld_write_done(struct nfs_pgio_header *);
271 void pnfs_ld_read_done(struct nfs_pgio_header *);
272 int pnfs_read_resend_pnfs(struct nfs_pgio_header *);
273 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
274 struct nfs_open_context *ctx,
277 enum pnfs_iomode iomode,
280 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
281 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
282 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
283 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
284 void pnfs_error_mark_layout_for_return(struct inode *inode,
285 struct pnfs_layout_segment *lseg);
287 /* nfs4_deviceid_flags */
289 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
290 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
294 struct nfs4_deviceid_node {
295 struct hlist_node node;
296 struct hlist_node tmpnode;
297 const struct pnfs_layoutdriver_type *ld;
298 const struct nfs_client *nfs_client;
300 unsigned long timestamp_unavailable;
301 struct nfs4_deviceid deviceid;
305 struct nfs4_deviceid_node *
306 nfs4_find_get_deviceid(struct nfs_server *server,
307 const struct nfs4_deviceid *id, struct rpc_cred *cred,
309 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
310 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
311 const struct nfs4_deviceid *);
312 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
313 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
314 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
315 void nfs4_deviceid_purge_client(const struct nfs_client *);
318 void pnfs_generic_clear_request_commit(struct nfs_page *req,
319 struct nfs_commit_info *cinfo);
320 void pnfs_generic_commit_release(void *calldata);
321 void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
322 void pnfs_generic_rw_release(void *data);
323 void pnfs_generic_recover_commit_reqs(struct list_head *dst,
324 struct nfs_commit_info *cinfo);
325 int pnfs_generic_commit_pagelist(struct inode *inode,
326 struct list_head *mds_pages,
328 struct nfs_commit_info *cinfo,
329 int (*initiate_commit)(struct nfs_commit_data *data,
331 int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
332 void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
333 void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
334 struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
336 void nfs4_pnfs_v3_ds_connect_unload(void);
337 void nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
338 struct nfs4_deviceid_node *devid, unsigned int timeo,
339 unsigned int retrans, u32 version, u32 minor_version,
340 rpc_authflavor_t au_flavor);
341 struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
342 struct xdr_stream *xdr,
345 static inline struct nfs4_deviceid_node *
346 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
352 static inline struct pnfs_layout_segment *
353 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
356 atomic_inc(&lseg->pls_refcount);
357 smp_mb__after_atomic();
362 /* Return true if a layout driver is being used for this mountpoint */
363 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
365 return nfss->pnfs_curr_ld != NULL;
369 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
370 struct nfs_commit_info *cinfo)
372 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
373 return PNFS_NOT_ATTEMPTED;
374 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
377 static inline struct pnfs_ds_commit_info *
378 pnfs_get_ds_info(struct inode *inode)
380 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
382 if (ld == NULL || ld->get_ds_info == NULL)
384 return ld->get_ds_info(inode);
388 pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
390 set_bit(NFS_DEVICEID_INVALID, &node->flags);
394 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
395 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
397 struct inode *inode = req->wb_context->dentry->d_inode;
398 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
400 if (lseg == NULL || ld->mark_request_commit == NULL)
402 ld->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
407 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
409 struct inode *inode = req->wb_context->dentry->d_inode;
410 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
412 if (ld == NULL || ld->clear_request_commit == NULL)
414 ld->clear_request_commit(req, cinfo);
419 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
422 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
425 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
428 static inline struct nfs_page *
429 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
432 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
434 if (ld == NULL || ld->search_commit_reqs == NULL)
436 return ld->search_commit_reqs(cinfo, page);
439 /* Should the pNFS client commit and return the layout upon a setattr */
441 pnfs_ld_layoutret_on_setattr(struct inode *inode)
443 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
445 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
446 PNFS_LAYOUTRET_ON_SETATTR;
450 pnfs_ld_read_whole_page(struct inode *inode)
452 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
454 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
458 pnfs_layoutcommit_outstanding(struct inode *inode)
460 struct nfs_inode *nfsi = NFS_I(inode);
462 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
463 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
466 static inline int pnfs_return_layout(struct inode *ino)
468 struct nfs_inode *nfsi = NFS_I(ino);
469 struct nfs_server *nfss = NFS_SERVER(ino);
471 if (pnfs_enabled_sb(nfss) && nfsi->layout)
472 return _pnfs_return_layout(ino);
478 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
479 struct nfs_server *nfss)
481 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
482 nfss->pnfs_curr_ld->id == src->l_type);
486 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
488 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
491 #endif /* NFS_DEBUG */
492 #else /* CONFIG_NFS_V4_1 */
494 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
498 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
502 static inline struct pnfs_layout_segment *
503 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
508 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
512 static inline int pnfs_return_layout(struct inode *ino)
517 static inline int pnfs_commit_and_return_layout(struct inode *inode)
523 pnfs_ld_layoutret_on_setattr(struct inode *inode)
529 pnfs_ld_read_whole_page(struct inode *inode)
535 pnfs_roc(struct inode *ino)
541 pnfs_roc_release(struct inode *ino)
546 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
551 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
556 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
557 const struct nfs_fh *mntfh, u32 id)
561 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
566 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
567 struct nfs_commit_info *cinfo)
569 return PNFS_NOT_ATTEMPTED;
572 static inline struct pnfs_ds_commit_info *
573 pnfs_get_ds_info(struct inode *inode)
579 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
580 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
586 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
592 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
598 static inline struct nfs_page *
599 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
605 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
611 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
612 struct nfs_server *nfss)
618 pnfs_layoutcommit_outstanding(struct inode *inode)
624 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
629 static inline void nfs4_pnfs_v3_ds_connect_unload(void)
633 #endif /* CONFIG_NFS_V4_1 */
635 #endif /* FS_NFS_PNFS_H */