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 * Default data server connection timeout and retrans vaules.
82 * Set by module parameters dataserver_timeo and dataserver_retrans.
84 #define NFS4_DEF_DS_TIMEO 600 /* in tenths of a second */
85 #define NFS4_DEF_DS_RETRANS 5
87 /* error codes for internal use */
88 #define NFS4ERR_RESET_TO_MDS 12001
89 #define NFS4ERR_RESET_TO_PNFS 12002
92 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
93 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
94 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
95 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
96 NFS_LAYOUT_RETURN, /* Return this layout ASAP */
97 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
100 enum layoutdriver_policy_flags {
101 /* Should the pNFS client commit and return the layout upon truncate to
103 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
104 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
105 PNFS_READ_WHOLE_PAGE = 1 << 2,
108 struct nfs4_deviceid_node;
110 /* Per-layout driver specific registration structure */
111 struct pnfs_layoutdriver_type {
112 struct list_head pnfs_tblid;
115 struct module *owner;
117 unsigned max_deviceinfo_size;
119 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
120 int (*clear_layoutdriver) (struct nfs_server *);
122 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
123 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
125 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
126 void (*free_lseg) (struct pnfs_layout_segment *lseg);
128 void (*return_range) (struct pnfs_layout_hdr *lo,
129 struct pnfs_layout_range *range);
131 /* test for nfs page cache coalescing */
132 const struct nfs_pageio_ops *pg_read_ops;
133 const struct nfs_pageio_ops *pg_write_ops;
135 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
136 void (*mark_request_commit) (struct nfs_page *req,
137 struct pnfs_layout_segment *lseg,
138 struct nfs_commit_info *cinfo);
139 void (*clear_request_commit) (struct nfs_page *req,
140 struct nfs_commit_info *cinfo);
141 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
143 void (*recover_commit_reqs) (struct list_head *list,
144 struct nfs_commit_info *cinfo);
145 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
147 int (*commit_pagelist)(struct inode *inode,
148 struct list_head *mds_pages,
150 struct nfs_commit_info *cinfo);
153 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
154 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
156 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
157 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
159 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
160 struct nfs4_deviceid_node * (*alloc_deviceid_node)
161 (struct nfs_server *server, struct pnfs_device *pdev,
164 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
165 struct xdr_stream *xdr,
166 const struct nfs4_layoutreturn_args *args);
168 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
169 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
170 void (*encode_layoutcommit) (struct pnfs_layout_hdr *lo,
171 struct xdr_stream *xdr,
172 const struct nfs4_layoutcommit_args *args);
175 struct pnfs_layout_hdr {
176 atomic_t plh_refcount;
177 struct list_head plh_layouts; /* other client layouts */
178 struct list_head plh_bulk_destroy;
179 struct list_head plh_segs; /* layout segments list */
180 nfs4_stateid plh_stateid;
181 atomic_t plh_outstanding; /* number of RPCs out */
182 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
183 u32 plh_barrier; /* ignore lower seqids */
184 unsigned long plh_retry_timestamp;
185 unsigned long plh_flags;
186 loff_t plh_lwb; /* last write byte for layoutcommit */
187 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
188 struct inode *plh_inode;
192 struct nfs4_deviceid dev_id;
193 unsigned int layout_type;
194 unsigned int mincount;
195 unsigned int maxcount; /* gdia_maxcount */
198 unsigned int pglen; /* reply buffer length */
201 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
203 struct pnfs_devicelist {
205 unsigned int num_devs;
206 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
209 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
210 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
213 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
214 struct pnfs_device *dev,
215 struct rpc_cred *cred);
216 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
217 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
220 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
221 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
222 void pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg);
224 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
225 void unset_pnfs_layoutdriver(struct nfs_server *);
226 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
227 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
228 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
229 struct nfs_page *req, u64 wb_size);
230 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
231 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
232 struct nfs_page *prev, struct nfs_page *req);
233 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
234 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
235 void pnfs_free_lseg_list(struct list_head *tmp_list);
236 void pnfs_destroy_layout(struct nfs_inode *);
237 void pnfs_destroy_all_layouts(struct nfs_client *);
238 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
239 struct nfs_fsid *fsid,
241 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
243 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
244 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
245 const nfs4_stateid *new,
246 bool update_barrier);
247 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
248 struct pnfs_layout_hdr *lo,
249 struct nfs4_state *open_state);
250 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
251 struct list_head *tmp_list,
252 struct pnfs_layout_range *recall_range);
253 bool pnfs_roc(struct inode *ino);
254 void pnfs_roc_release(struct inode *ino);
255 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
256 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
257 void pnfs_set_layoutcommit(struct nfs_pgio_header *);
258 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data);
259 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
260 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
261 int _pnfs_return_layout(struct inode *);
262 int pnfs_commit_and_return_layout(struct inode *);
263 void pnfs_ld_write_done(struct nfs_pgio_header *);
264 void pnfs_ld_read_done(struct nfs_pgio_header *);
265 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
266 struct nfs_open_context *ctx,
269 enum pnfs_iomode iomode,
272 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
273 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
274 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
275 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
277 /* nfs4_deviceid_flags */
279 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
280 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
284 struct nfs4_deviceid_node {
285 struct hlist_node node;
286 struct hlist_node tmpnode;
287 const struct pnfs_layoutdriver_type *ld;
288 const struct nfs_client *nfs_client;
290 unsigned long timestamp_unavailable;
291 struct nfs4_deviceid deviceid;
295 struct nfs4_deviceid_node *
296 nfs4_find_get_deviceid(struct nfs_server *server,
297 const struct nfs4_deviceid *id, struct rpc_cred *cred,
299 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
300 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
301 const struct nfs4_deviceid *);
302 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
303 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
304 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
305 void nfs4_deviceid_purge_client(const struct nfs_client *);
308 void pnfs_generic_clear_request_commit(struct nfs_page *req,
309 struct nfs_commit_info *cinfo);
310 void pnfs_generic_commit_release(void *calldata);
311 void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
312 void pnfs_generic_rw_release(void *data);
313 void pnfs_generic_recover_commit_reqs(struct list_head *dst,
314 struct nfs_commit_info *cinfo);
315 int pnfs_generic_commit_pagelist(struct inode *inode,
316 struct list_head *mds_pages,
318 struct nfs_commit_info *cinfo,
319 int (*initiate_commit)(struct nfs_commit_data *data,
321 int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
322 void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
323 void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
324 struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
326 void nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
327 struct nfs4_deviceid_node *devid, unsigned int timeo,
328 unsigned int retrans, rpc_authflavor_t au_flavor);
329 struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
330 struct xdr_stream *xdr,
333 static inline struct nfs4_deviceid_node *
334 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
340 static inline struct pnfs_layout_segment *
341 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
344 atomic_inc(&lseg->pls_refcount);
345 smp_mb__after_atomic();
350 /* Return true if a layout driver is being used for this mountpoint */
351 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
353 return nfss->pnfs_curr_ld != NULL;
357 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
358 struct nfs_commit_info *cinfo)
360 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
361 return PNFS_NOT_ATTEMPTED;
362 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
365 static inline struct pnfs_ds_commit_info *
366 pnfs_get_ds_info(struct inode *inode)
368 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
370 if (ld == NULL || ld->get_ds_info == NULL)
372 return ld->get_ds_info(inode);
376 pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
378 set_bit(NFS_DEVICEID_INVALID, &node->flags);
382 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
383 struct nfs_commit_info *cinfo)
385 struct inode *inode = req->wb_context->dentry->d_inode;
386 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
388 if (lseg == NULL || ld->mark_request_commit == NULL)
390 ld->mark_request_commit(req, lseg, cinfo);
395 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
397 struct inode *inode = req->wb_context->dentry->d_inode;
398 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
400 if (ld == NULL || ld->clear_request_commit == NULL)
402 ld->clear_request_commit(req, cinfo);
407 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
410 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
413 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
416 static inline struct nfs_page *
417 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
420 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
422 if (ld == NULL || ld->search_commit_reqs == NULL)
424 return ld->search_commit_reqs(cinfo, page);
427 /* Should the pNFS client commit and return the layout upon a setattr */
429 pnfs_ld_layoutret_on_setattr(struct inode *inode)
431 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
433 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
434 PNFS_LAYOUTRET_ON_SETATTR;
438 pnfs_ld_read_whole_page(struct inode *inode)
440 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
442 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
446 pnfs_layoutcommit_outstanding(struct inode *inode)
448 struct nfs_inode *nfsi = NFS_I(inode);
450 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
451 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
454 static inline int pnfs_return_layout(struct inode *ino)
456 struct nfs_inode *nfsi = NFS_I(ino);
457 struct nfs_server *nfss = NFS_SERVER(ino);
459 if (pnfs_enabled_sb(nfss) && nfsi->layout)
460 return _pnfs_return_layout(ino);
466 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
467 struct nfs_server *nfss)
469 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
470 nfss->pnfs_curr_ld->id == src->l_type);
474 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
476 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
479 #endif /* NFS_DEBUG */
480 #else /* CONFIG_NFS_V4_1 */
482 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
486 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
490 static inline struct pnfs_layout_segment *
491 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
496 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
500 static inline int pnfs_return_layout(struct inode *ino)
505 static inline int pnfs_commit_and_return_layout(struct inode *inode)
511 pnfs_ld_layoutret_on_setattr(struct inode *inode)
517 pnfs_ld_read_whole_page(struct inode *inode)
523 pnfs_roc(struct inode *ino)
529 pnfs_roc_release(struct inode *ino)
534 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
539 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
544 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
545 const struct nfs_fh *mntfh, u32 id)
549 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
554 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
555 struct nfs_commit_info *cinfo)
557 return PNFS_NOT_ATTEMPTED;
560 static inline struct pnfs_ds_commit_info *
561 pnfs_get_ds_info(struct inode *inode)
567 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
568 struct nfs_commit_info *cinfo)
574 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
580 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
586 static inline struct nfs_page *
587 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
593 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
599 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
600 struct nfs_server *nfss)
606 pnfs_layoutcommit_outstanding(struct inode *inode)
612 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
617 #endif /* CONFIG_NFS_V4_1 */
619 #endif /* FS_NFS_PNFS_H */