]>
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 | ||
45df3c8b | 33 | #include <linux/nfs_fs.h> |
94ad1c80 FI |
34 | #include <linux/nfs_page.h> |
35 | ||
4541d16c FI |
36 | enum { |
37 | NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */ | |
f7e8917a | 38 | NFS_LSEG_ROC, /* roc bit received from server */ |
4541d16c FI |
39 | }; |
40 | ||
974cec8c | 41 | struct pnfs_layout_segment { |
566052c5 FI |
42 | struct list_head pls_list; |
43 | struct pnfs_layout_range pls_range; | |
4541d16c FI |
44 | atomic_t pls_refcount; |
45 | unsigned long pls_flags; | |
566052c5 | 46 | struct pnfs_layout_hdr *pls_layout; |
863a3c6c AA |
47 | struct rpc_cred *pls_lc_cred; /* LAYOUTCOMMIT credential */ |
48 | loff_t pls_end_pos; /* LAYOUTCOMMIT write end */ | |
974cec8c AA |
49 | }; |
50 | ||
64419a9b AA |
51 | enum pnfs_try_status { |
52 | PNFS_ATTEMPTED = 0, | |
53 | PNFS_NOT_ATTEMPTED = 1, | |
54 | }; | |
55 | ||
85e174ba RL |
56 | #ifdef CONFIG_NFS_V4_1 |
57 | ||
58 | #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4" | |
59 | ||
e5e94017 BH |
60 | enum { |
61 | NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */ | |
62 | NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */ | |
43f1b3da | 63 | NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */ |
f7e8917a | 64 | NFS_LAYOUT_ROC, /* some lseg had roc bit set */ |
4541d16c | 65 | NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */ |
e5e94017 BH |
66 | }; |
67 | ||
8a1636c4 BH |
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 | }; | |
72 | ||
1775bc34 BH |
73 | struct nfs4_deviceid_node; |
74 | ||
85e174ba RL |
75 | /* Per-layout driver specific registration structure */ |
76 | struct pnfs_layoutdriver_type { | |
02c35fca FI |
77 | struct list_head pnfs_tblid; |
78 | const u32 id; | |
79 | const char *name; | |
80 | struct module *owner; | |
8a1636c4 | 81 | unsigned flags; |
636fb9c8 BH |
82 | |
83 | struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags); | |
84 | void (*free_layout_hdr) (struct pnfs_layout_hdr *); | |
85 | ||
a75b9df9 | 86 | struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags); |
b1f69b75 | 87 | void (*free_lseg) (struct pnfs_layout_segment *lseg); |
94ad1c80 FI |
88 | |
89 | /* test for nfs page cache coalescing */ | |
18ad0a9f | 90 | bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *); |
64419a9b | 91 | |
a861a1e1 FI |
92 | /* Returns true if layoutdriver wants to divert this request to |
93 | * driver's commit routine. | |
94 | */ | |
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); | |
98 | ||
64419a9b AA |
99 | /* |
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 | |
102 | */ | |
103 | enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data); | |
0382b744 | 104 | enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how); |
1775bc34 BH |
105 | |
106 | void (*free_deviceid_node) (struct nfs4_deviceid_node *); | |
04a55549 AA |
107 | |
108 | void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid, | |
109 | struct xdr_stream *xdr, | |
110 | const struct nfs4_layoutreturn_args *args); | |
ac7db726 BH |
111 | |
112 | void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid, | |
113 | struct xdr_stream *xdr, | |
114 | const struct nfs4_layoutcommit_args *args); | |
85e174ba RL |
115 | }; |
116 | ||
e5e94017 | 117 | struct pnfs_layout_hdr { |
cc6e5340 | 118 | atomic_t plh_refcount; |
b7edfaa1 | 119 | struct list_head plh_layouts; /* other client layouts */ |
43f1b3da | 120 | struct list_head plh_bulk_recall; /* clnt list of bulk recalls */ |
b7edfaa1 | 121 | struct list_head plh_segs; /* layout segments list */ |
b7edfaa1 | 122 | nfs4_stateid plh_stateid; |
cf7d63f1 | 123 | atomic_t plh_outstanding; /* number of RPCs out */ |
f7e8917a | 124 | unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */ |
43f1b3da | 125 | u32 plh_barrier; /* ignore lower seqids */ |
566052c5 | 126 | unsigned long plh_flags; |
b7edfaa1 | 127 | struct inode *plh_inode; |
e5e94017 BH |
128 | }; |
129 | ||
b1f69b75 AA |
130 | struct pnfs_device { |
131 | struct nfs4_deviceid dev_id; | |
132 | unsigned int layout_type; | |
133 | unsigned int mincount; | |
134 | struct page **pages; | |
b1f69b75 AA |
135 | unsigned int pgbase; |
136 | unsigned int pglen; | |
137 | }; | |
138 | ||
02c35fca FI |
139 | extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *); |
140 | extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *); | |
141 | ||
b1f69b75 AA |
142 | /* nfs4proc.c */ |
143 | extern int nfs4_proc_getdeviceinfo(struct nfs_server *server, | |
144 | struct pnfs_device *dev); | |
145 | extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp); | |
cbe82603 | 146 | extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp); |
b1f69b75 AA |
147 | |
148 | /* pnfs.c */ | |
43f1b3da | 149 | void get_layout_hdr(struct pnfs_layout_hdr *lo); |
bae724ef | 150 | void put_lseg(struct pnfs_layout_segment *lseg); |
e5e94017 BH |
151 | struct pnfs_layout_segment * |
152 | pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx, | |
fb3296eb BH |
153 | loff_t pos, u64 count, enum pnfs_iomode access_type, |
154 | gfp_t gfp_flags); | |
85e174ba RL |
155 | void set_pnfs_layoutdriver(struct nfs_server *, u32 id); |
156 | void unset_pnfs_layoutdriver(struct nfs_server *); | |
0382b744 AA |
157 | enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *, |
158 | const struct rpc_call_ops *, int); | |
64419a9b AA |
159 | enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *, |
160 | const struct rpc_call_ops *); | |
18ad0a9f | 161 | bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req); |
b1f69b75 | 162 | int pnfs_layout_process(struct nfs4_layoutget *lgp); |
43f1b3da | 163 | void pnfs_free_lseg_list(struct list_head *tmp_list); |
e5e94017 | 164 | void pnfs_destroy_layout(struct nfs_inode *); |
974cec8c | 165 | void pnfs_destroy_all_layouts(struct nfs_client *); |
cc6e5340 | 166 | void put_layout_hdr(struct pnfs_layout_hdr *lo); |
43f1b3da FI |
167 | void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, |
168 | const nfs4_stateid *new, | |
169 | bool update_barrier); | |
fd6002e9 FI |
170 | int pnfs_choose_layoutget_stateid(nfs4_stateid *dst, |
171 | struct pnfs_layout_hdr *lo, | |
172 | struct nfs4_state *open_state); | |
43f1b3da FI |
173 | int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo, |
174 | struct list_head *tmp_list, | |
778b5502 | 175 | struct pnfs_layout_range *recall_range); |
f7e8917a FI |
176 | bool pnfs_roc(struct inode *ino); |
177 | void pnfs_roc_release(struct inode *ino); | |
178 | void pnfs_roc_set_barrier(struct inode *ino, u32 barrier); | |
179 | bool pnfs_roc_drain(struct inode *ino, u32 *barrier); | |
863a3c6c | 180 | void pnfs_set_layoutcommit(struct nfs_write_data *wdata); |
ef311537 | 181 | int pnfs_layoutcommit_inode(struct inode *inode, bool sync); |
cbe82603 | 182 | int _pnfs_return_layout(struct inode *); |
d20581aa BH |
183 | int pnfs_ld_write_done(struct nfs_write_data *); |
184 | int pnfs_ld_read_done(struct nfs_read_data *); | |
e5e94017 | 185 | |
a1eaecbc BH |
186 | /* pnfs_dev.c */ |
187 | struct nfs4_deviceid_node { | |
188 | struct hlist_node node; | |
1775bc34 | 189 | const struct pnfs_layoutdriver_type *ld; |
a1eaecbc BH |
190 | const struct nfs_client *nfs_client; |
191 | struct nfs4_deviceid deviceid; | |
192 | atomic_t ref; | |
193 | }; | |
194 | ||
195 | void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id); | |
35c8bb54 BH |
196 | struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *); |
197 | struct nfs4_deviceid_node *nfs4_unhash_put_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *); | |
198 | void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *); | |
a1eaecbc | 199 | void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, |
1775bc34 | 200 | const struct pnfs_layoutdriver_type *, |
a1eaecbc BH |
201 | const struct nfs_client *, |
202 | const struct nfs4_deviceid *); | |
203 | struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *); | |
204 | bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *); | |
1775bc34 | 205 | void nfs4_deviceid_purge_client(const struct nfs_client *); |
a1eaecbc | 206 | |
e5e94017 BH |
207 | static inline int lo_fail_bit(u32 iomode) |
208 | { | |
209 | return iomode == IOMODE_RW ? | |
210 | NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED; | |
211 | } | |
212 | ||
d684d2ae FI |
213 | static inline struct pnfs_layout_segment * |
214 | get_lseg(struct pnfs_layout_segment *lseg) | |
215 | { | |
216 | if (lseg) { | |
217 | atomic_inc(&lseg->pls_refcount); | |
218 | smp_mb__after_atomic_inc(); | |
219 | } | |
220 | return lseg; | |
221 | } | |
222 | ||
e5e94017 BH |
223 | /* Return true if a layout driver is being used for this mountpoint */ |
224 | static inline int pnfs_enabled_sb(struct nfs_server *nfss) | |
225 | { | |
226 | return nfss->pnfs_curr_ld != NULL; | |
227 | } | |
85e174ba | 228 | |
a861a1e1 FI |
229 | static inline void |
230 | pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg) | |
231 | { | |
232 | if (lseg) { | |
233 | struct pnfs_layoutdriver_type *ld; | |
234 | ||
235 | ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld; | |
236 | if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) { | |
237 | set_bit(PG_PNFS_COMMIT, &req->wb_flags); | |
238 | req->wb_commit_lseg = get_lseg(lseg); | |
239 | } | |
240 | } | |
241 | } | |
242 | ||
243 | static inline int | |
244 | pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how) | |
245 | { | |
246 | if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags)) | |
247 | return PNFS_NOT_ATTEMPTED; | |
248 | return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how); | |
249 | } | |
250 | ||
251 | static inline struct list_head * | |
252 | pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds) | |
253 | { | |
254 | struct list_head *rv; | |
255 | ||
256 | if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) { | |
257 | struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode; | |
258 | ||
259 | set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags); | |
260 | rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req); | |
261 | /* matched by ref taken when PG_PNFS_COMMIT is set */ | |
262 | put_lseg(req->wb_commit_lseg); | |
263 | } else | |
264 | rv = mds; | |
265 | return rv; | |
266 | } | |
267 | ||
268 | static inline void pnfs_clear_request_commit(struct nfs_page *req) | |
269 | { | |
270 | if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) | |
271 | put_lseg(req->wb_commit_lseg); | |
272 | } | |
273 | ||
8a1636c4 BH |
274 | /* Should the pNFS client commit and return the layout upon a setattr */ |
275 | static inline bool | |
276 | pnfs_ld_layoutret_on_setattr(struct inode *inode) | |
277 | { | |
278 | if (!pnfs_enabled_sb(NFS_SERVER(inode))) | |
279 | return false; | |
280 | return NFS_SERVER(inode)->pnfs_curr_ld->flags & | |
281 | PNFS_LAYOUTRET_ON_SETATTR; | |
282 | } | |
283 | ||
cbe82603 BH |
284 | static inline int pnfs_return_layout(struct inode *ino) |
285 | { | |
286 | struct nfs_inode *nfsi = NFS_I(ino); | |
287 | struct nfs_server *nfss = NFS_SERVER(ino); | |
288 | ||
289 | if (pnfs_enabled_sb(nfss) && nfsi->layout) | |
290 | return _pnfs_return_layout(ino); | |
291 | ||
292 | return 0; | |
293 | } | |
294 | ||
dfed206b BH |
295 | static inline void pnfs_pageio_init(struct nfs_pageio_descriptor *pgio, |
296 | struct inode *inode) | |
297 | { | |
89a58e32 BH |
298 | struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld; |
299 | ||
300 | if (ld) | |
301 | pgio->pg_test = ld->pg_test; | |
dfed206b BH |
302 | } |
303 | ||
85e174ba RL |
304 | #else /* CONFIG_NFS_V4_1 */ |
305 | ||
974cec8c AA |
306 | static inline void pnfs_destroy_all_layouts(struct nfs_client *clp) |
307 | { | |
308 | } | |
309 | ||
e5e94017 BH |
310 | static inline void pnfs_destroy_layout(struct nfs_inode *nfsi) |
311 | { | |
312 | } | |
313 | ||
d684d2ae FI |
314 | static inline struct pnfs_layout_segment * |
315 | get_lseg(struct pnfs_layout_segment *lseg) | |
316 | { | |
317 | return NULL; | |
318 | } | |
319 | ||
320 | static inline void put_lseg(struct pnfs_layout_segment *lseg) | |
321 | { | |
322 | } | |
323 | ||
e5e94017 BH |
324 | static inline struct pnfs_layout_segment * |
325 | pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx, | |
fb3296eb BH |
326 | loff_t pos, u64 count, enum pnfs_iomode access_type, |
327 | gfp_t gfp_flags) | |
e5e94017 BH |
328 | { |
329 | return NULL; | |
330 | } | |
331 | ||
64419a9b AA |
332 | static inline enum pnfs_try_status |
333 | pnfs_try_to_read_data(struct nfs_read_data *data, | |
334 | const struct rpc_call_ops *call_ops) | |
335 | { | |
336 | return PNFS_NOT_ATTEMPTED; | |
337 | } | |
338 | ||
0382b744 AA |
339 | static inline enum pnfs_try_status |
340 | pnfs_try_to_write_data(struct nfs_write_data *data, | |
341 | const struct rpc_call_ops *call_ops, int how) | |
342 | { | |
343 | return PNFS_NOT_ATTEMPTED; | |
344 | } | |
345 | ||
cbe82603 BH |
346 | static inline int pnfs_return_layout(struct inode *ino) |
347 | { | |
348 | return 0; | |
349 | } | |
350 | ||
8a1636c4 BH |
351 | static inline bool |
352 | pnfs_ld_layoutret_on_setattr(struct inode *inode) | |
353 | { | |
354 | return false; | |
355 | } | |
356 | ||
f7e8917a FI |
357 | static inline bool |
358 | pnfs_roc(struct inode *ino) | |
359 | { | |
360 | return false; | |
361 | } | |
362 | ||
363 | static inline void | |
364 | pnfs_roc_release(struct inode *ino) | |
365 | { | |
366 | } | |
367 | ||
368 | static inline void | |
369 | pnfs_roc_set_barrier(struct inode *ino, u32 barrier) | |
370 | { | |
371 | } | |
372 | ||
373 | static inline bool | |
374 | pnfs_roc_drain(struct inode *ino, u32 *barrier) | |
375 | { | |
376 | return false; | |
377 | } | |
378 | ||
85e174ba RL |
379 | static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id) |
380 | { | |
381 | } | |
382 | ||
383 | static inline void unset_pnfs_layoutdriver(struct nfs_server *s) | |
384 | { | |
385 | } | |
386 | ||
dfed206b BH |
387 | static inline void pnfs_pageio_init(struct nfs_pageio_descriptor *pgio, |
388 | struct inode *inode) | |
44b83799 | 389 | { |
44b83799 FI |
390 | } |
391 | ||
a861a1e1 FI |
392 | static inline void |
393 | pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg) | |
394 | { | |
395 | } | |
396 | ||
397 | static inline int | |
398 | pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how) | |
399 | { | |
400 | return PNFS_NOT_ATTEMPTED; | |
401 | } | |
402 | ||
403 | static inline struct list_head * | |
404 | pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds) | |
405 | { | |
406 | return mds; | |
407 | } | |
408 | ||
409 | static inline void pnfs_clear_request_commit(struct nfs_page *req) | |
410 | { | |
411 | } | |
412 | ||
ef311537 | 413 | static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync) |
863a3c6c AA |
414 | { |
415 | return 0; | |
416 | } | |
1775bc34 BH |
417 | |
418 | static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl) | |
419 | { | |
420 | } | |
85e174ba RL |
421 | #endif /* CONFIG_NFS_V4_1 */ |
422 | ||
423 | #endif /* FS_NFS_PNFS_H */ |