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>
37 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
38 NFS_LSEG_ROC, /* roc bit received from server */
39 NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
42 struct pnfs_layout_segment {
43 struct list_head pls_list;
44 struct list_head pls_lc_list;
45 struct pnfs_layout_range pls_range;
46 atomic_t pls_refcount;
47 unsigned long pls_flags;
48 struct pnfs_layout_hdr *pls_layout;
51 enum pnfs_try_status {
53 PNFS_NOT_ATTEMPTED = 1,
56 #ifdef CONFIG_NFS_V4_1
58 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
61 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
62 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
63 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
64 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
65 NFS_LAYOUT_RETURNED, /* layout has already been returned */
68 enum layoutdriver_policy_flags {
69 /* Should the pNFS client commit and return the layout upon a setattr */
70 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
71 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
74 struct nfs4_deviceid_node;
76 /* Per-layout driver specific registration structure */
77 struct pnfs_layoutdriver_type {
78 struct list_head pnfs_tblid;
84 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
85 int (*clear_layoutdriver) (struct nfs_server *);
87 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
88 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
90 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
91 void (*free_lseg) (struct pnfs_layout_segment *lseg);
93 /* test for nfs page cache coalescing */
94 const struct nfs_pageio_ops *pg_read_ops;
95 const struct nfs_pageio_ops *pg_write_ops;
97 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
98 void (*mark_request_commit) (struct nfs_page *req,
99 struct pnfs_layout_segment *lseg,
100 struct nfs_commit_info *cinfo);
101 void (*clear_request_commit) (struct nfs_page *req,
102 struct nfs_commit_info *cinfo);
103 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
105 void (*recover_commit_reqs) (struct list_head *list,
106 struct nfs_commit_info *cinfo);
107 int (*commit_pagelist)(struct inode *inode,
108 struct list_head *mds_pages,
110 struct nfs_commit_info *cinfo);
113 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
114 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
116 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
117 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
119 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
121 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
122 struct xdr_stream *xdr,
123 const struct nfs4_layoutreturn_args *args);
125 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
127 void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
128 struct xdr_stream *xdr,
129 const struct nfs4_layoutcommit_args *args);
132 struct pnfs_layout_hdr {
133 atomic_t plh_refcount;
134 struct list_head plh_layouts; /* other client layouts */
135 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
136 struct list_head plh_segs; /* layout segments list */
137 nfs4_stateid plh_stateid;
138 atomic_t plh_outstanding; /* number of RPCs out */
139 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
140 u32 plh_barrier; /* ignore lower seqids */
141 unsigned long plh_retry_timestamp;
142 unsigned long plh_flags;
143 loff_t plh_lwb; /* last write byte for layoutcommit */
144 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
145 struct inode *plh_inode;
149 struct nfs4_deviceid dev_id;
150 unsigned int layout_type;
151 unsigned int mincount;
157 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
159 struct pnfs_devicelist {
161 unsigned int num_devs;
162 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
165 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
166 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
169 extern int nfs4_proc_getdevicelist(struct nfs_server *server,
170 const struct nfs_fh *fh,
171 struct pnfs_devicelist *devlist);
172 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
173 struct pnfs_device *dev);
174 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
175 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
178 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
179 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
181 void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
182 const struct nfs_pgio_completion_ops *);
183 void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *,
184 int, const struct nfs_pgio_completion_ops *);
186 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
187 void unset_pnfs_layoutdriver(struct nfs_server *);
188 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
189 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
190 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *);
191 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
192 bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
193 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
194 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
195 void pnfs_free_lseg_list(struct list_head *tmp_list);
196 void pnfs_destroy_layout(struct nfs_inode *);
197 void pnfs_destroy_all_layouts(struct nfs_client *);
198 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
199 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
200 const nfs4_stateid *new,
201 bool update_barrier);
202 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
203 struct pnfs_layout_hdr *lo,
204 struct nfs4_state *open_state);
205 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
206 struct list_head *tmp_list,
207 struct pnfs_layout_range *recall_range);
208 bool pnfs_roc(struct inode *ino);
209 void pnfs_roc_release(struct inode *ino);
210 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
211 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
212 void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
213 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
214 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
215 int _pnfs_return_layout(struct inode *);
216 void pnfs_ld_write_done(struct nfs_write_data *);
217 void pnfs_ld_read_done(struct nfs_read_data *);
218 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
219 struct nfs_open_context *ctx,
222 enum pnfs_iomode iomode,
225 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
226 int pnfs_read_done_resend_to_mds(struct inode *inode, struct list_head *head,
227 const struct nfs_pgio_completion_ops *compl_ops);
228 int pnfs_write_done_resend_to_mds(struct inode *inode, struct list_head *head,
229 const struct nfs_pgio_completion_ops *compl_ops);
230 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
232 /* nfs4_deviceid_flags */
234 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
235 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
239 struct nfs4_deviceid_node {
240 struct hlist_node node;
241 struct hlist_node tmpnode;
242 const struct pnfs_layoutdriver_type *ld;
243 const struct nfs_client *nfs_client;
245 unsigned long timestamp_unavailable;
246 struct nfs4_deviceid deviceid;
250 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
251 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
252 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
253 const struct pnfs_layoutdriver_type *,
254 const struct nfs_client *,
255 const struct nfs4_deviceid *);
256 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
257 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
258 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
259 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
260 void nfs4_deviceid_purge_client(const struct nfs_client *);
263 pnfs_mark_layout_returned(struct pnfs_layout_hdr *lo)
265 set_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
269 pnfs_clear_layout_returned(struct pnfs_layout_hdr *lo)
271 clear_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
275 pnfs_test_layout_returned(struct pnfs_layout_hdr *lo)
277 return test_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
280 static inline struct pnfs_layout_segment *
281 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
284 atomic_inc(&lseg->pls_refcount);
285 smp_mb__after_atomic_inc();
290 /* Return true if a layout driver is being used for this mountpoint */
291 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
293 return nfss->pnfs_curr_ld != NULL;
297 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
298 struct nfs_commit_info *cinfo)
300 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
301 return PNFS_NOT_ATTEMPTED;
302 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
305 static inline struct pnfs_ds_commit_info *
306 pnfs_get_ds_info(struct inode *inode)
308 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
310 if (ld == NULL || ld->get_ds_info == NULL)
312 return ld->get_ds_info(inode);
316 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
317 struct nfs_commit_info *cinfo)
319 struct inode *inode = req->wb_context->dentry->d_inode;
320 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
322 if (lseg == NULL || ld->mark_request_commit == NULL)
324 ld->mark_request_commit(req, lseg, cinfo);
329 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
331 struct inode *inode = req->wb_context->dentry->d_inode;
332 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
334 if (ld == NULL || ld->clear_request_commit == NULL)
336 ld->clear_request_commit(req, cinfo);
341 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
344 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
347 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
351 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
352 struct nfs_commit_info *cinfo)
354 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
356 NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
359 /* Should the pNFS client commit and return the layout upon a setattr */
361 pnfs_ld_layoutret_on_setattr(struct inode *inode)
363 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
365 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
366 PNFS_LAYOUTRET_ON_SETATTR;
369 static inline int pnfs_return_layout(struct inode *ino)
371 struct nfs_inode *nfsi = NFS_I(ino);
372 struct nfs_server *nfss = NFS_SERVER(ino);
374 if (pnfs_enabled_sb(nfss) && nfsi->layout)
375 return _pnfs_return_layout(ino);
381 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
382 struct nfs_server *nfss)
384 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
385 nfss->pnfs_curr_ld->id == src->l_type);
389 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
391 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
394 #endif /* NFS_DEBUG */
395 #else /* CONFIG_NFS_V4_1 */
397 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
401 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
405 static inline struct pnfs_layout_segment *
406 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
411 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
415 static inline int pnfs_return_layout(struct inode *ino)
421 pnfs_ld_layoutret_on_setattr(struct inode *inode)
427 pnfs_roc(struct inode *ino)
433 pnfs_roc_release(struct inode *ino)
438 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
443 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
448 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
449 const struct nfs_fh *mntfh, u32 id)
453 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
457 static inline void pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
458 const struct nfs_pgio_completion_ops *compl_ops)
460 nfs_pageio_init_read(pgio, inode, compl_ops);
463 static inline void pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags,
464 const struct nfs_pgio_completion_ops *compl_ops)
466 nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
470 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
471 struct nfs_commit_info *cinfo)
473 return PNFS_NOT_ATTEMPTED;
476 static inline struct pnfs_ds_commit_info *
477 pnfs_get_ds_info(struct inode *inode)
483 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
484 struct nfs_commit_info *cinfo)
490 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
496 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
503 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
504 struct nfs_commit_info *cinfo)
508 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
514 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
515 struct nfs_server *nfss)
520 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
525 #endif /* CONFIG_NFS_V4_1 */
527 #endif /* FS_NFS_PNFS_H */