Commit | Line | Data |
---|---|---|
85e174ba RL |
1 | /* |
2 | * pNFS client data structures. | |
3 | * | |
4 | * Copyright (c) 2002 | |
5 | * The Regents of the University of Michigan | |
6 | * All Rights Reserved | |
7 | * | |
8 | * Dean Hildebrand <dhildebz@umich.edu> | |
9 | * | |
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. | |
18 | * | |
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 | |
27 | * such damages. | |
28 | */ | |
29 | ||
30 | #ifndef FS_NFS_PNFS_H | |
31 | #define FS_NFS_PNFS_H | |
32 | ||
94ad1c80 FI |
33 | #include <linux/nfs_page.h> |
34 | ||
4541d16c FI |
35 | enum { |
36 | NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */ | |
f7e8917a | 37 | NFS_LSEG_ROC, /* roc bit received from server */ |
4541d16c FI |
38 | }; |
39 | ||
974cec8c | 40 | struct pnfs_layout_segment { |
566052c5 FI |
41 | struct list_head pls_list; |
42 | struct pnfs_layout_range pls_range; | |
4541d16c FI |
43 | atomic_t pls_refcount; |
44 | unsigned long pls_flags; | |
566052c5 | 45 | struct pnfs_layout_hdr *pls_layout; |
863a3c6c AA |
46 | struct rpc_cred *pls_lc_cred; /* LAYOUTCOMMIT credential */ |
47 | loff_t pls_end_pos; /* LAYOUTCOMMIT write end */ | |
974cec8c AA |
48 | }; |
49 | ||
64419a9b AA |
50 | enum pnfs_try_status { |
51 | PNFS_ATTEMPTED = 0, | |
52 | PNFS_NOT_ATTEMPTED = 1, | |
53 | }; | |
54 | ||
85e174ba RL |
55 | #ifdef CONFIG_NFS_V4_1 |
56 | ||
57 | #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4" | |
58 | ||
e5e94017 BH |
59 | enum { |
60 | NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */ | |
61 | NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */ | |
43f1b3da | 62 | NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */ |
f7e8917a | 63 | NFS_LAYOUT_ROC, /* some lseg had roc bit set */ |
4541d16c | 64 | NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */ |
e5e94017 BH |
65 | }; |
66 | ||
85e174ba RL |
67 | /* Per-layout driver specific registration structure */ |
68 | struct pnfs_layoutdriver_type { | |
02c35fca FI |
69 | struct list_head pnfs_tblid; |
70 | const u32 id; | |
71 | const char *name; | |
72 | struct module *owner; | |
b1f69b75 AA |
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); | |
94ad1c80 FI |
75 | |
76 | /* test for nfs page cache coalescing */ | |
77 | int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *); | |
64419a9b | 78 | |
a861a1e1 FI |
79 | /* Returns true if layoutdriver wants to divert this request to |
80 | * driver's commit routine. | |
81 | */ | |
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); | |
85 | ||
64419a9b AA |
86 | /* |
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 | |
89 | */ | |
90 | enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data); | |
0382b744 | 91 | enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how); |
85e174ba RL |
92 | }; |
93 | ||
e5e94017 | 94 | struct pnfs_layout_hdr { |
cc6e5340 | 95 | atomic_t plh_refcount; |
b7edfaa1 | 96 | struct list_head plh_layouts; /* other client layouts */ |
43f1b3da | 97 | struct list_head plh_bulk_recall; /* clnt list of bulk recalls */ |
b7edfaa1 | 98 | struct list_head plh_segs; /* layout segments list */ |
b7edfaa1 | 99 | nfs4_stateid plh_stateid; |
cf7d63f1 | 100 | atomic_t plh_outstanding; /* number of RPCs out */ |
f7e8917a | 101 | unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */ |
43f1b3da | 102 | u32 plh_barrier; /* ignore lower seqids */ |
566052c5 | 103 | unsigned long plh_flags; |
b7edfaa1 | 104 | struct inode *plh_inode; |
e5e94017 BH |
105 | }; |
106 | ||
b1f69b75 AA |
107 | struct pnfs_device { |
108 | struct nfs4_deviceid dev_id; | |
109 | unsigned int layout_type; | |
110 | unsigned int mincount; | |
111 | struct page **pages; | |
112 | void *area; | |
113 | unsigned int pgbase; | |
114 | unsigned int pglen; | |
115 | }; | |
116 | ||
02c35fca FI |
117 | extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *); |
118 | extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *); | |
119 | ||
b1f69b75 AA |
120 | /* nfs4proc.c */ |
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); | |
124 | ||
125 | /* pnfs.c */ | |
43f1b3da | 126 | void get_layout_hdr(struct pnfs_layout_hdr *lo); |
bae724ef | 127 | void put_lseg(struct pnfs_layout_segment *lseg); |
e5e94017 BH |
128 | struct pnfs_layout_segment * |
129 | pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx, | |
130 | enum pnfs_iomode access_type); | |
85e174ba RL |
131 | void set_pnfs_layoutdriver(struct nfs_server *, u32 id); |
132 | void unset_pnfs_layoutdriver(struct nfs_server *); | |
0382b744 AA |
133 | enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *, |
134 | const struct rpc_call_ops *, int); | |
64419a9b AA |
135 | enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *, |
136 | const struct rpc_call_ops *); | |
94ad1c80 | 137 | void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *); |
44b83799 | 138 | void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *); |
b1f69b75 | 139 | int pnfs_layout_process(struct nfs4_layoutget *lgp); |
43f1b3da | 140 | void pnfs_free_lseg_list(struct list_head *tmp_list); |
e5e94017 | 141 | void pnfs_destroy_layout(struct nfs_inode *); |
974cec8c | 142 | void pnfs_destroy_all_layouts(struct nfs_client *); |
cc6e5340 | 143 | void put_layout_hdr(struct pnfs_layout_hdr *lo); |
43f1b3da FI |
144 | void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, |
145 | const nfs4_stateid *new, | |
146 | bool update_barrier); | |
fd6002e9 FI |
147 | int pnfs_choose_layoutget_stateid(nfs4_stateid *dst, |
148 | struct pnfs_layout_hdr *lo, | |
149 | struct nfs4_state *open_state); | |
43f1b3da FI |
150 | int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo, |
151 | struct list_head *tmp_list, | |
152 | u32 iomode); | |
f7e8917a FI |
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); | |
863a3c6c | 157 | void pnfs_set_layoutcommit(struct nfs_write_data *wdata); |
ef311537 | 158 | int pnfs_layoutcommit_inode(struct inode *inode, bool sync); |
e5e94017 BH |
159 | |
160 | static inline int lo_fail_bit(u32 iomode) | |
161 | { | |
162 | return iomode == IOMODE_RW ? | |
163 | NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED; | |
164 | } | |
165 | ||
d684d2ae FI |
166 | static inline struct pnfs_layout_segment * |
167 | get_lseg(struct pnfs_layout_segment *lseg) | |
168 | { | |
169 | if (lseg) { | |
170 | atomic_inc(&lseg->pls_refcount); | |
171 | smp_mb__after_atomic_inc(); | |
172 | } | |
173 | return lseg; | |
174 | } | |
175 | ||
e5e94017 BH |
176 | /* Return true if a layout driver is being used for this mountpoint */ |
177 | static inline int pnfs_enabled_sb(struct nfs_server *nfss) | |
178 | { | |
179 | return nfss->pnfs_curr_ld != NULL; | |
180 | } | |
85e174ba | 181 | |
a861a1e1 FI |
182 | static inline void |
183 | pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg) | |
184 | { | |
185 | if (lseg) { | |
186 | struct pnfs_layoutdriver_type *ld; | |
187 | ||
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); | |
192 | } | |
193 | } | |
194 | } | |
195 | ||
196 | static inline int | |
197 | pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how) | |
198 | { | |
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); | |
202 | } | |
203 | ||
204 | static inline struct list_head * | |
205 | pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds) | |
206 | { | |
207 | struct list_head *rv; | |
208 | ||
209 | if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) { | |
210 | struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode; | |
211 | ||
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); | |
216 | } else | |
217 | rv = mds; | |
218 | return rv; | |
219 | } | |
220 | ||
221 | static inline void pnfs_clear_request_commit(struct nfs_page *req) | |
222 | { | |
223 | if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) | |
224 | put_lseg(req->wb_commit_lseg); | |
225 | } | |
226 | ||
85e174ba RL |
227 | #else /* CONFIG_NFS_V4_1 */ |
228 | ||
974cec8c AA |
229 | static inline void pnfs_destroy_all_layouts(struct nfs_client *clp) |
230 | { | |
231 | } | |
232 | ||
e5e94017 BH |
233 | static inline void pnfs_destroy_layout(struct nfs_inode *nfsi) |
234 | { | |
235 | } | |
236 | ||
d684d2ae FI |
237 | static inline struct pnfs_layout_segment * |
238 | get_lseg(struct pnfs_layout_segment *lseg) | |
239 | { | |
240 | return NULL; | |
241 | } | |
242 | ||
243 | static inline void put_lseg(struct pnfs_layout_segment *lseg) | |
244 | { | |
245 | } | |
246 | ||
e5e94017 BH |
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) | |
250 | { | |
251 | return NULL; | |
252 | } | |
253 | ||
64419a9b AA |
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) | |
257 | { | |
258 | return PNFS_NOT_ATTEMPTED; | |
259 | } | |
260 | ||
0382b744 AA |
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) | |
264 | { | |
265 | return PNFS_NOT_ATTEMPTED; | |
266 | } | |
267 | ||
f7e8917a FI |
268 | static inline bool |
269 | pnfs_roc(struct inode *ino) | |
270 | { | |
271 | return false; | |
272 | } | |
273 | ||
274 | static inline void | |
275 | pnfs_roc_release(struct inode *ino) | |
276 | { | |
277 | } | |
278 | ||
279 | static inline void | |
280 | pnfs_roc_set_barrier(struct inode *ino, u32 barrier) | |
281 | { | |
282 | } | |
283 | ||
284 | static inline bool | |
285 | pnfs_roc_drain(struct inode *ino, u32 *barrier) | |
286 | { | |
287 | return false; | |
288 | } | |
289 | ||
85e174ba RL |
290 | static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id) |
291 | { | |
292 | } | |
293 | ||
294 | static inline void unset_pnfs_layoutdriver(struct nfs_server *s) | |
295 | { | |
296 | } | |
297 | ||
94ad1c80 FI |
298 | static inline void |
299 | pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino) | |
300 | { | |
301 | pgio->pg_test = NULL; | |
302 | } | |
303 | ||
44b83799 FI |
304 | static inline void |
305 | pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino) | |
306 | { | |
307 | pgio->pg_test = NULL; | |
308 | } | |
309 | ||
a861a1e1 FI |
310 | static inline void |
311 | pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg) | |
312 | { | |
313 | } | |
314 | ||
315 | static inline int | |
316 | pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how) | |
317 | { | |
318 | return PNFS_NOT_ATTEMPTED; | |
319 | } | |
320 | ||
321 | static inline struct list_head * | |
322 | pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds) | |
323 | { | |
324 | return mds; | |
325 | } | |
326 | ||
327 | static inline void pnfs_clear_request_commit(struct nfs_page *req) | |
328 | { | |
329 | } | |
330 | ||
ef311537 | 331 | static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync) |
863a3c6c AA |
332 | { |
333 | return 0; | |
334 | } | |
85e174ba RL |
335 | #endif /* CONFIG_NFS_V4_1 */ |
336 | ||
337 | #endif /* FS_NFS_PNFS_H */ |