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 struct nfs4_deviceid_node;
70 /* Per-layout driver specific registration structure */
71 struct pnfs_layoutdriver_type {
72 struct list_head pnfs_tblid;
76 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
77 void (*free_lseg) (struct pnfs_layout_segment *lseg);
79 /* test for nfs page cache coalescing */
80 int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
82 /* Returns true if layoutdriver wants to divert this request to
83 * driver's commit routine.
85 bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
86 struct list_head * (*choose_commit_list) (struct nfs_page *req);
87 int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);
90 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
91 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
93 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
94 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
96 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
99 struct pnfs_layout_hdr {
100 atomic_t plh_refcount;
101 struct list_head plh_layouts; /* other client layouts */
102 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
103 struct list_head plh_segs; /* layout segments list */
104 nfs4_stateid plh_stateid;
105 atomic_t plh_outstanding; /* number of RPCs out */
106 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
107 u32 plh_barrier; /* ignore lower seqids */
108 unsigned long plh_flags;
109 struct inode *plh_inode;
113 struct nfs4_deviceid dev_id;
114 unsigned int layout_type;
115 unsigned int mincount;
121 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
122 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
125 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
126 struct pnfs_device *dev);
127 extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
130 void get_layout_hdr(struct pnfs_layout_hdr *lo);
131 void put_lseg(struct pnfs_layout_segment *lseg);
132 struct pnfs_layout_segment *
133 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
134 enum pnfs_iomode access_type, gfp_t gfp_flags);
135 void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
136 void unset_pnfs_layoutdriver(struct nfs_server *);
137 enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
138 const struct rpc_call_ops *, int);
139 enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
140 const struct rpc_call_ops *);
141 void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
142 void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
143 int pnfs_layout_process(struct nfs4_layoutget *lgp);
144 void pnfs_free_lseg_list(struct list_head *tmp_list);
145 void pnfs_destroy_layout(struct nfs_inode *);
146 void pnfs_destroy_all_layouts(struct nfs_client *);
147 void put_layout_hdr(struct pnfs_layout_hdr *lo);
148 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
149 const nfs4_stateid *new,
150 bool update_barrier);
151 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
152 struct pnfs_layout_hdr *lo,
153 struct nfs4_state *open_state);
154 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
155 struct list_head *tmp_list,
157 bool pnfs_roc(struct inode *ino);
158 void pnfs_roc_release(struct inode *ino);
159 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
160 bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
161 void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
162 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
165 struct nfs4_deviceid_node {
166 struct hlist_node node;
167 const struct pnfs_layoutdriver_type *ld;
168 const struct nfs_client *nfs_client;
169 struct nfs4_deviceid deviceid;
173 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
174 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct nfs_client *, const struct nfs4_deviceid *);
175 struct nfs4_deviceid_node *nfs4_unhash_put_deviceid(const struct nfs_client *, const struct nfs4_deviceid *);
176 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
177 const struct pnfs_layoutdriver_type *,
178 const struct nfs_client *,
179 const struct nfs4_deviceid *);
180 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
181 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
182 void nfs4_deviceid_purge_client(const struct nfs_client *);
184 static inline int lo_fail_bit(u32 iomode)
186 return iomode == IOMODE_RW ?
187 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
190 static inline struct pnfs_layout_segment *
191 get_lseg(struct pnfs_layout_segment *lseg)
194 atomic_inc(&lseg->pls_refcount);
195 smp_mb__after_atomic_inc();
200 /* Return true if a layout driver is being used for this mountpoint */
201 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
203 return nfss->pnfs_curr_ld != NULL;
207 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
210 struct pnfs_layoutdriver_type *ld;
212 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
213 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
214 set_bit(PG_PNFS_COMMIT, &req->wb_flags);
215 req->wb_commit_lseg = get_lseg(lseg);
221 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
223 if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
224 return PNFS_NOT_ATTEMPTED;
225 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
228 static inline struct list_head *
229 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
231 struct list_head *rv;
233 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
234 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
236 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
237 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
238 /* matched by ref taken when PG_PNFS_COMMIT is set */
239 put_lseg(req->wb_commit_lseg);
245 static inline void pnfs_clear_request_commit(struct nfs_page *req)
247 if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
248 put_lseg(req->wb_commit_lseg);
251 #else /* CONFIG_NFS_V4_1 */
253 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
257 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
261 static inline struct pnfs_layout_segment *
262 get_lseg(struct pnfs_layout_segment *lseg)
267 static inline void put_lseg(struct pnfs_layout_segment *lseg)
271 static inline struct pnfs_layout_segment *
272 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
273 enum pnfs_iomode access_type, gfp_t gfp_flags)
278 static inline enum pnfs_try_status
279 pnfs_try_to_read_data(struct nfs_read_data *data,
280 const struct rpc_call_ops *call_ops)
282 return PNFS_NOT_ATTEMPTED;
285 static inline enum pnfs_try_status
286 pnfs_try_to_write_data(struct nfs_write_data *data,
287 const struct rpc_call_ops *call_ops, int how)
289 return PNFS_NOT_ATTEMPTED;
293 pnfs_roc(struct inode *ino)
299 pnfs_roc_release(struct inode *ino)
304 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
309 pnfs_roc_drain(struct inode *ino, u32 *barrier)
314 static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
318 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
323 pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
325 pgio->pg_test = NULL;
329 pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
331 pgio->pg_test = NULL;
335 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
340 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
342 return PNFS_NOT_ATTEMPTED;
345 static inline struct list_head *
346 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
351 static inline void pnfs_clear_request_commit(struct nfs_page *req)
355 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
360 static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
363 #endif /* CONFIG_NFS_V4_1 */
365 #endif /* FS_NFS_PNFS_H */