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_page.h>
36 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
37 NFS_LSEG_ROC, /* roc bit received from server */
40 struct pnfs_layout_segment {
41 struct list_head pls_list;
42 struct pnfs_layout_range pls_range;
43 atomic_t pls_refcount;
44 unsigned long pls_flags;
45 struct pnfs_layout_hdr *pls_layout;
46 struct rpc_cred *pls_lc_cred; /* LAYOUTCOMMIT credential */
47 loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
50 enum pnfs_try_status {
52 PNFS_NOT_ATTEMPTED = 1,
55 #ifdef CONFIG_NFS_V4_1
57 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
60 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
61 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
62 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
63 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
64 NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
67 /* Per-layout driver specific registration structure */
68 struct pnfs_layoutdriver_type {
69 struct list_head pnfs_tblid;
73 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr);
74 void (*free_lseg) (struct pnfs_layout_segment *lseg);
76 /* test for nfs page cache coalescing */
77 int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
79 /* Returns true if layoutdriver wants to divert this request to
80 * driver's commit routine.
82 bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
83 struct list_head * (*choose_commit_list) (struct nfs_page *req);
84 int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);
87 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
88 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
90 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
91 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
94 struct pnfs_layout_hdr {
95 atomic_t plh_refcount;
96 struct list_head plh_layouts; /* other client layouts */
97 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
98 struct list_head plh_segs; /* layout segments list */
99 nfs4_stateid plh_stateid;
100 atomic_t plh_outstanding; /* number of RPCs out */
101 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
102 u32 plh_barrier; /* ignore lower seqids */
103 unsigned long plh_flags;
104 struct inode *plh_inode;
108 struct nfs4_deviceid dev_id;
109 unsigned int layout_type;
110 unsigned int mincount;
117 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
118 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
121 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
122 struct pnfs_device *dev);
123 extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
126 void get_layout_hdr(struct pnfs_layout_hdr *lo);
127 void put_lseg(struct pnfs_layout_segment *lseg);
128 struct pnfs_layout_segment *
129 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
130 enum pnfs_iomode access_type);
131 void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
132 void unset_pnfs_layoutdriver(struct nfs_server *);
133 enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
134 const struct rpc_call_ops *, int);
135 enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
136 const struct rpc_call_ops *);
137 void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
138 void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
139 int pnfs_layout_process(struct nfs4_layoutget *lgp);
140 void pnfs_free_lseg_list(struct list_head *tmp_list);
141 void pnfs_destroy_layout(struct nfs_inode *);
142 void pnfs_destroy_all_layouts(struct nfs_client *);
143 void put_layout_hdr(struct pnfs_layout_hdr *lo);
144 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
145 const nfs4_stateid *new,
146 bool update_barrier);
147 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
148 struct pnfs_layout_hdr *lo,
149 struct nfs4_state *open_state);
150 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
151 struct list_head *tmp_list,
153 bool pnfs_roc(struct inode *ino);
154 void pnfs_roc_release(struct inode *ino);
155 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
156 bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
157 void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
158 int pnfs_layoutcommit_inode(struct inode *inode, int sync);
160 static inline int lo_fail_bit(u32 iomode)
162 return iomode == IOMODE_RW ?
163 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
166 static inline struct pnfs_layout_segment *
167 get_lseg(struct pnfs_layout_segment *lseg)
170 atomic_inc(&lseg->pls_refcount);
171 smp_mb__after_atomic_inc();
176 /* Return true if a layout driver is being used for this mountpoint */
177 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
179 return nfss->pnfs_curr_ld != NULL;
183 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
186 struct pnfs_layoutdriver_type *ld;
188 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
189 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
190 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
191 req->wb_commit_lseg = get_lseg(lseg);
197 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
199 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
200 return PNFS_NOT_ATTEMPTED;
201 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
204 static inline struct list_head *
205 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
207 struct list_head *rv;
209 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
210 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
212 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
213 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
214 /* matched by ref taken when PG_PNFS_COMMIT is set */
215 put_lseg(req->wb_commit_lseg);
221 static inline void pnfs_clear_request_commit(struct nfs_page *req)
223 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
224 put_lseg(req->wb_commit_lseg);
227 #else /* CONFIG_NFS_V4_1 */
229 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
233 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
237 static inline struct pnfs_layout_segment *
238 get_lseg(struct pnfs_layout_segment *lseg)
243 static inline void put_lseg(struct pnfs_layout_segment *lseg)
247 static inline struct pnfs_layout_segment *
248 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
249 enum pnfs_iomode access_type)
254 static inline enum pnfs_try_status
255 pnfs_try_to_read_data(struct nfs_read_data *data,
256 const struct rpc_call_ops *call_ops)
258 return PNFS_NOT_ATTEMPTED;
261 static inline enum pnfs_try_status
262 pnfs_try_to_write_data(struct nfs_write_data *data,
263 const struct rpc_call_ops *call_ops, int how)
265 return PNFS_NOT_ATTEMPTED;
269 pnfs_roc(struct inode *ino)
275 pnfs_roc_release(struct inode *ino)
280 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
285 pnfs_roc_drain(struct inode *ino, u32 *barrier)
290 static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
294 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
299 pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
301 pgio->pg_test = NULL;
305 pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
307 pgio->pg_test = NULL;
311 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
316 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
318 return PNFS_NOT_ATTEMPTED;
321 static inline struct list_head *
322 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
327 static inline void pnfs_clear_request_commit(struct nfs_page *req)
331 static inline int pnfs_layoutcommit_inode(struct inode *inode, int sync)
335 #endif /* CONFIG_NFS_V4_1 */
337 #endif /* FS_NFS_PNFS_H */