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 */
41 struct pnfs_layout_segment {
42 struct list_head pls_list;
43 struct pnfs_layout_range pls_range;
44 atomic_t pls_refcount;
45 unsigned long pls_flags;
46 struct pnfs_layout_hdr *pls_layout;
47 struct rpc_cred *pls_lc_cred; /* LAYOUTCOMMIT credential */
48 loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
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_DESTROYED, /* no new use of layout allowed */
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,
73 struct nfs4_deviceid_node;
75 /* Per-layout driver specific registration structure */
76 struct pnfs_layoutdriver_type {
77 struct list_head pnfs_tblid;
83 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
84 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
86 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
87 void (*free_lseg) (struct pnfs_layout_segment *lseg);
89 /* test for nfs page cache coalescing */
90 int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
92 /* Returns true if layoutdriver wants to divert this request to
93 * driver's commit routine.
95 bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
96 struct list_head * (*choose_commit_list) (struct nfs_page *req);
97 int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);
100 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
101 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
103 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
104 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
106 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
108 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
109 struct xdr_stream *xdr,
110 const struct nfs4_layoutreturn_args *args);
113 struct pnfs_layout_hdr {
114 atomic_t plh_refcount;
115 struct list_head plh_layouts; /* other client layouts */
116 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
117 struct list_head plh_segs; /* layout segments list */
118 nfs4_stateid plh_stateid;
119 atomic_t plh_outstanding; /* number of RPCs out */
120 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
121 u32 plh_barrier; /* ignore lower seqids */
122 unsigned long plh_flags;
123 struct inode *plh_inode;
127 struct nfs4_deviceid dev_id;
128 unsigned int layout_type;
129 unsigned int mincount;
135 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
136 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
139 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
140 struct pnfs_device *dev);
141 extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
142 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
145 void get_layout_hdr(struct pnfs_layout_hdr *lo);
146 void put_lseg(struct pnfs_layout_segment *lseg);
147 struct pnfs_layout_segment *
148 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
149 loff_t pos, u64 count, enum pnfs_iomode access_type,
151 void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
152 void unset_pnfs_layoutdriver(struct nfs_server *);
153 enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
154 const struct rpc_call_ops *, int);
155 enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
156 const struct rpc_call_ops *);
157 void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
158 void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
159 int pnfs_layout_process(struct nfs4_layoutget *lgp);
160 void pnfs_free_lseg_list(struct list_head *tmp_list);
161 void pnfs_destroy_layout(struct nfs_inode *);
162 void pnfs_destroy_all_layouts(struct nfs_client *);
163 void put_layout_hdr(struct pnfs_layout_hdr *lo);
164 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
165 const nfs4_stateid *new,
166 bool update_barrier);
167 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
168 struct pnfs_layout_hdr *lo,
169 struct nfs4_state *open_state);
170 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
171 struct list_head *tmp_list,
172 struct pnfs_layout_range *recall_range);
173 bool pnfs_roc(struct inode *ino);
174 void pnfs_roc_release(struct inode *ino);
175 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
176 bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
177 void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
178 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
179 int _pnfs_return_layout(struct inode *);
180 int pnfs_ld_write_done(struct nfs_write_data *);
181 int pnfs_ld_read_done(struct nfs_read_data *);
184 struct nfs4_deviceid_node {
185 struct hlist_node node;
186 const struct pnfs_layoutdriver_type *ld;
187 const struct nfs_client *nfs_client;
188 struct nfs4_deviceid deviceid;
192 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
193 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
194 struct nfs4_deviceid_node *nfs4_unhash_put_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
195 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
196 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
197 const struct pnfs_layoutdriver_type *,
198 const struct nfs_client *,
199 const struct nfs4_deviceid *);
200 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
201 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
202 void nfs4_deviceid_purge_client(const struct nfs_client *);
204 static inline int lo_fail_bit(u32 iomode)
206 return iomode == IOMODE_RW ?
207 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
210 static inline struct pnfs_layout_segment *
211 get_lseg(struct pnfs_layout_segment *lseg)
214 atomic_inc(&lseg->pls_refcount);
215 smp_mb__after_atomic_inc();
220 /* Return true if a layout driver is being used for this mountpoint */
221 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
223 return nfss->pnfs_curr_ld != NULL;
227 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
230 struct pnfs_layoutdriver_type *ld;
232 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
233 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
234 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
235 req->wb_commit_lseg = get_lseg(lseg);
241 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
243 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
244 return PNFS_NOT_ATTEMPTED;
245 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
248 static inline struct list_head *
249 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
251 struct list_head *rv;
253 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
254 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
256 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
257 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
258 /* matched by ref taken when PG_PNFS_COMMIT is set */
259 put_lseg(req->wb_commit_lseg);
265 static inline void pnfs_clear_request_commit(struct nfs_page *req)
267 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
268 put_lseg(req->wb_commit_lseg);
271 /* Should the pNFS client commit and return the layout upon a setattr */
273 pnfs_ld_layoutret_on_setattr(struct inode *inode)
275 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
277 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
278 PNFS_LAYOUTRET_ON_SETATTR;
281 static inline int pnfs_return_layout(struct inode *ino)
283 struct nfs_inode *nfsi = NFS_I(ino);
284 struct nfs_server *nfss = NFS_SERVER(ino);
286 if (pnfs_enabled_sb(nfss) && nfsi->layout)
287 return _pnfs_return_layout(ino);
292 #else /* CONFIG_NFS_V4_1 */
294 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
298 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
302 static inline struct pnfs_layout_segment *
303 get_lseg(struct pnfs_layout_segment *lseg)
308 static inline void put_lseg(struct pnfs_layout_segment *lseg)
312 static inline struct pnfs_layout_segment *
313 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
314 loff_t pos, u64 count, enum pnfs_iomode access_type,
320 static inline enum pnfs_try_status
321 pnfs_try_to_read_data(struct nfs_read_data *data,
322 const struct rpc_call_ops *call_ops)
324 return PNFS_NOT_ATTEMPTED;
327 static inline enum pnfs_try_status
328 pnfs_try_to_write_data(struct nfs_write_data *data,
329 const struct rpc_call_ops *call_ops, int how)
331 return PNFS_NOT_ATTEMPTED;
334 static inline int pnfs_return_layout(struct inode *ino)
340 pnfs_ld_layoutret_on_setattr(struct inode *inode)
346 pnfs_roc(struct inode *ino)
352 pnfs_roc_release(struct inode *ino)
357 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
362 pnfs_roc_drain(struct inode *ino, u32 *barrier)
367 static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
371 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
376 pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
378 pgio->pg_test = NULL;
382 pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
384 pgio->pg_test = NULL;
388 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
393 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
395 return PNFS_NOT_ATTEMPTED;
398 static inline struct list_head *
399 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
404 static inline void pnfs_clear_request_commit(struct nfs_page *req)
408 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
413 static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
416 #endif /* CONFIG_NFS_V4_1 */
418 #endif /* FS_NFS_PNFS_H */