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_RETURN_BEFORE_CLOSE, /* Return this layout before close */
100 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
101 NFS_LAYOUT_FIRST_LAYOUTGET, /* Serialize first layoutget */
104 enum layoutdriver_policy_flags {
105 /* Should the pNFS client commit and return the layout upon truncate to
107 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
108 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
109 PNFS_READ_WHOLE_PAGE = 1 << 2,
112 struct nfs4_deviceid_node;
114 /* Per-layout driver specific registration structure */
115 struct pnfs_layoutdriver_type {
116 struct list_head pnfs_tblid;
119 struct module *owner;
121 unsigned max_deviceinfo_size;
123 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
124 int (*clear_layoutdriver) (struct nfs_server *);
126 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
127 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
129 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
130 void (*free_lseg) (struct pnfs_layout_segment *lseg);
132 void (*return_range) (struct pnfs_layout_hdr *lo,
133 struct pnfs_layout_range *range);
135 /* test for nfs page cache coalescing */
136 const struct nfs_pageio_ops *pg_read_ops;
137 const struct nfs_pageio_ops *pg_write_ops;
139 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
140 void (*mark_request_commit) (struct nfs_page *req,
141 struct pnfs_layout_segment *lseg,
142 struct nfs_commit_info *cinfo,
144 void (*clear_request_commit) (struct nfs_page *req,
145 struct nfs_commit_info *cinfo);
146 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
148 void (*recover_commit_reqs) (struct list_head *list,
149 struct nfs_commit_info *cinfo);
150 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
152 int (*commit_pagelist)(struct inode *inode,
153 struct list_head *mds_pages,
155 struct nfs_commit_info *cinfo);
158 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
159 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
161 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
162 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
164 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
165 struct nfs4_deviceid_node * (*alloc_deviceid_node)
166 (struct nfs_server *server, struct pnfs_device *pdev,
169 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
170 struct xdr_stream *xdr,
171 const struct nfs4_layoutreturn_args *args);
173 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
174 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
175 void (*encode_layoutcommit) (struct pnfs_layout_hdr *lo,
176 struct xdr_stream *xdr,
177 const struct nfs4_layoutcommit_args *args);
180 struct pnfs_layout_hdr {
181 atomic_t plh_refcount;
182 struct list_head plh_layouts; /* other client layouts */
183 struct list_head plh_bulk_destroy;
184 struct list_head plh_segs; /* layout segments list */
185 nfs4_stateid plh_stateid;
186 atomic_t plh_outstanding; /* number of RPCs out */
187 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
188 u32 plh_barrier; /* ignore lower seqids */
189 unsigned long plh_retry_timestamp;
190 unsigned long plh_flags;
191 enum pnfs_iomode plh_return_iomode;
192 loff_t plh_lwb; /* last write byte for layoutcommit */
193 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
194 struct inode *plh_inode;
198 struct nfs4_deviceid dev_id;
199 unsigned int layout_type;
200 unsigned int mincount;
201 unsigned int maxcount; /* gdia_maxcount */
204 unsigned int pglen; /* reply buffer length */
207 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
209 struct pnfs_devicelist {
211 unsigned int num_devs;
212 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
215 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
216 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
219 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
220 struct pnfs_device *dev,
221 struct rpc_cred *cred);
222 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
223 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp, bool sync);
226 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
227 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
228 void pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg);
230 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
231 void unset_pnfs_layoutdriver(struct nfs_server *);
232 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
233 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
234 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
235 struct nfs_page *req, u64 wb_size);
236 void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
237 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
238 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
239 struct nfs_page *prev, struct nfs_page *req);
240 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
241 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
242 void pnfs_free_lseg_list(struct list_head *tmp_list);
243 void pnfs_destroy_layout(struct nfs_inode *);
244 void pnfs_destroy_all_layouts(struct nfs_client *);
245 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
246 struct nfs_fsid *fsid,
248 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
250 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
251 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
252 const nfs4_stateid *new,
253 bool update_barrier);
254 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
255 struct pnfs_layout_hdr *lo,
256 struct pnfs_layout_range *range,
257 struct nfs4_state *open_state);
258 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
259 struct list_head *tmp_list,
260 struct pnfs_layout_range *recall_range);
261 bool pnfs_roc(struct inode *ino);
262 void pnfs_roc_release(struct inode *ino);
263 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
264 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
265 void pnfs_set_layoutcommit(struct nfs_pgio_header *);
266 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data);
267 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
268 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
269 int _pnfs_return_layout(struct inode *);
270 int pnfs_commit_and_return_layout(struct inode *);
271 void pnfs_ld_write_done(struct nfs_pgio_header *);
272 void pnfs_ld_read_done(struct nfs_pgio_header *);
273 int pnfs_read_resend_pnfs(struct nfs_pgio_header *);
274 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
275 struct nfs_open_context *ctx,
278 enum pnfs_iomode iomode,
281 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
282 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
283 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
284 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
285 void pnfs_error_mark_layout_for_return(struct inode *inode,
286 struct pnfs_layout_segment *lseg);
288 /* nfs4_deviceid_flags */
290 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
291 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
295 struct nfs4_deviceid_node {
296 struct hlist_node node;
297 struct hlist_node tmpnode;
298 const struct pnfs_layoutdriver_type *ld;
299 const struct nfs_client *nfs_client;
301 unsigned long timestamp_unavailable;
302 struct nfs4_deviceid deviceid;
306 struct nfs4_deviceid_node *
307 nfs4_find_get_deviceid(struct nfs_server *server,
308 const struct nfs4_deviceid *id, struct rpc_cred *cred,
310 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
311 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
312 const struct nfs4_deviceid *);
313 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
314 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
315 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
316 void nfs4_deviceid_purge_client(const struct nfs_client *);
319 void pnfs_generic_clear_request_commit(struct nfs_page *req,
320 struct nfs_commit_info *cinfo);
321 void pnfs_generic_commit_release(void *calldata);
322 void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
323 void pnfs_generic_rw_release(void *data);
324 void pnfs_generic_recover_commit_reqs(struct list_head *dst,
325 struct nfs_commit_info *cinfo);
326 int pnfs_generic_commit_pagelist(struct inode *inode,
327 struct list_head *mds_pages,
329 struct nfs_commit_info *cinfo,
330 int (*initiate_commit)(struct nfs_commit_data *data,
332 int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
333 void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
334 void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
335 struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
337 void nfs4_pnfs_v3_ds_connect_unload(void);
338 void nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
339 struct nfs4_deviceid_node *devid, unsigned int timeo,
340 unsigned int retrans, u32 version, u32 minor_version,
341 rpc_authflavor_t au_flavor);
342 struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
343 struct xdr_stream *xdr,
346 static inline struct nfs4_deviceid_node *
347 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
353 static inline struct pnfs_layout_segment *
354 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
357 atomic_inc(&lseg->pls_refcount);
358 smp_mb__after_atomic();
363 /* Return true if a layout driver is being used for this mountpoint */
364 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
366 return nfss->pnfs_curr_ld != NULL;
370 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
371 struct nfs_commit_info *cinfo)
373 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
374 return PNFS_NOT_ATTEMPTED;
375 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
378 static inline struct pnfs_ds_commit_info *
379 pnfs_get_ds_info(struct inode *inode)
381 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
383 if (ld == NULL || ld->get_ds_info == NULL)
385 return ld->get_ds_info(inode);
389 pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
391 set_bit(NFS_DEVICEID_INVALID, &node->flags);
395 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
396 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
398 struct inode *inode = req->wb_context->dentry->d_inode;
399 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
401 if (lseg == NULL || ld->mark_request_commit == NULL)
403 ld->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
408 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
410 struct inode *inode = req->wb_context->dentry->d_inode;
411 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
413 if (ld == NULL || ld->clear_request_commit == NULL)
415 ld->clear_request_commit(req, cinfo);
420 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
423 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
426 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
429 static inline struct nfs_page *
430 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
433 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
435 if (ld == NULL || ld->search_commit_reqs == NULL)
437 return ld->search_commit_reqs(cinfo, page);
440 /* Should the pNFS client commit and return the layout upon a setattr */
442 pnfs_ld_layoutret_on_setattr(struct inode *inode)
444 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
446 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
447 PNFS_LAYOUTRET_ON_SETATTR;
451 pnfs_ld_read_whole_page(struct inode *inode)
453 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
455 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
459 pnfs_layoutcommit_outstanding(struct inode *inode)
461 struct nfs_inode *nfsi = NFS_I(inode);
463 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
464 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
467 static inline int pnfs_return_layout(struct inode *ino)
469 struct nfs_inode *nfsi = NFS_I(ino);
470 struct nfs_server *nfss = NFS_SERVER(ino);
472 if (pnfs_enabled_sb(nfss) && nfsi->layout)
473 return _pnfs_return_layout(ino);
479 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
480 struct nfs_server *nfss)
482 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
483 nfss->pnfs_curr_ld->id == src->l_type);
487 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
489 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
492 #endif /* NFS_DEBUG */
493 #else /* CONFIG_NFS_V4_1 */
495 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
499 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
503 static inline struct pnfs_layout_segment *
504 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
509 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
513 static inline int pnfs_return_layout(struct inode *ino)
518 static inline int pnfs_commit_and_return_layout(struct inode *inode)
524 pnfs_ld_layoutret_on_setattr(struct inode *inode)
530 pnfs_ld_read_whole_page(struct inode *inode)
536 pnfs_roc(struct inode *ino)
542 pnfs_roc_release(struct inode *ino)
547 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
552 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
557 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
558 const struct nfs_fh *mntfh, u32 id)
562 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
567 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
568 struct nfs_commit_info *cinfo)
570 return PNFS_NOT_ATTEMPTED;
573 static inline struct pnfs_ds_commit_info *
574 pnfs_get_ds_info(struct inode *inode)
580 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
581 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
587 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
593 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
599 static inline struct nfs_page *
600 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
606 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
612 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
613 struct nfs_server *nfss)
619 pnfs_layoutcommit_outstanding(struct inode *inode)
625 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
630 static inline void nfs4_pnfs_v3_ds_connect_unload(void)
634 #endif /* CONFIG_NFS_V4_1 */
636 #endif /* FS_NFS_PNFS_H */