]>
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 */ |
a9bae566 | 39 | NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */ |
4541d16c FI |
40 | }; |
41 | ||
974cec8c | 42 | struct pnfs_layout_segment { |
566052c5 | 43 | struct list_head pls_list; |
a9bae566 | 44 | struct list_head pls_lc_list; |
566052c5 | 45 | struct pnfs_layout_range pls_range; |
4541d16c FI |
46 | atomic_t pls_refcount; |
47 | unsigned long pls_flags; | |
566052c5 | 48 | struct pnfs_layout_hdr *pls_layout; |
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, | |
fe0fe835 | 71 | PNFS_LAYOUTRET_ON_ERROR = 1 << 1, |
8a1636c4 BH |
72 | }; |
73 | ||
1775bc34 BH |
74 | struct nfs4_deviceid_node; |
75 | ||
85e174ba RL |
76 | /* Per-layout driver specific registration structure */ |
77 | struct pnfs_layoutdriver_type { | |
02c35fca FI |
78 | struct list_head pnfs_tblid; |
79 | const u32 id; | |
80 | const char *name; | |
81 | struct module *owner; | |
8a1636c4 | 82 | unsigned flags; |
636fb9c8 | 83 | |
738fd0f3 BH |
84 | int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *); |
85 | int (*clear_layoutdriver) (struct nfs_server *); | |
86 | ||
636fb9c8 BH |
87 | struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags); |
88 | void (*free_layout_hdr) (struct pnfs_layout_hdr *); | |
89 | ||
a75b9df9 | 90 | struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags); |
b1f69b75 | 91 | void (*free_lseg) (struct pnfs_layout_segment *lseg); |
94ad1c80 FI |
92 | |
93 | /* test for nfs page cache coalescing */ | |
1751c363 TM |
94 | const struct nfs_pageio_ops *pg_read_ops; |
95 | const struct nfs_pageio_ops *pg_write_ops; | |
64419a9b | 96 | |
d6d6dc7c FI |
97 | struct list_head * (*choose_commit_list) (struct nfs_page *req, |
98 | struct pnfs_layout_segment *lseg); | |
99 | struct pnfs_layout_segment *(*remove_commit_req) (struct nfs_page *req); | |
100 | int (*scan_commit_lists) (struct inode *inode, int max); | |
a861a1e1 FI |
101 | int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how); |
102 | ||
64419a9b AA |
103 | /* |
104 | * Return PNFS_ATTEMPTED to indicate the layout code has attempted | |
105 | * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS | |
106 | */ | |
107 | enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data); | |
0382b744 | 108 | enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how); |
1775bc34 BH |
109 | |
110 | void (*free_deviceid_node) (struct nfs4_deviceid_node *); | |
04a55549 AA |
111 | |
112 | void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid, | |
113 | struct xdr_stream *xdr, | |
114 | const struct nfs4_layoutreturn_args *args); | |
ac7db726 | 115 | |
db29c089 AA |
116 | void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data); |
117 | ||
ac7db726 BH |
118 | void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid, |
119 | struct xdr_stream *xdr, | |
120 | const struct nfs4_layoutcommit_args *args); | |
85e174ba RL |
121 | }; |
122 | ||
e5e94017 | 123 | struct pnfs_layout_hdr { |
cc6e5340 | 124 | atomic_t plh_refcount; |
b7edfaa1 | 125 | struct list_head plh_layouts; /* other client layouts */ |
43f1b3da | 126 | struct list_head plh_bulk_recall; /* clnt list of bulk recalls */ |
b7edfaa1 | 127 | struct list_head plh_segs; /* layout segments list */ |
b7edfaa1 | 128 | nfs4_stateid plh_stateid; |
cf7d63f1 | 129 | atomic_t plh_outstanding; /* number of RPCs out */ |
f7e8917a | 130 | unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */ |
43f1b3da | 131 | u32 plh_barrier; /* ignore lower seqids */ |
566052c5 | 132 | unsigned long plh_flags; |
acff5880 | 133 | loff_t plh_lwb; /* last write byte for layoutcommit */ |
9fa40758 | 134 | struct rpc_cred *plh_lc_cred; /* layoutcommit cred */ |
b7edfaa1 | 135 | struct inode *plh_inode; |
e5e94017 BH |
136 | }; |
137 | ||
b1f69b75 AA |
138 | struct pnfs_device { |
139 | struct nfs4_deviceid dev_id; | |
140 | unsigned int layout_type; | |
141 | unsigned int mincount; | |
142 | struct page **pages; | |
b1f69b75 AA |
143 | unsigned int pgbase; |
144 | unsigned int pglen; | |
145 | }; | |
146 | ||
7f11d8d3 AA |
147 | #define NFS4_PNFS_GETDEVLIST_MAXNUM 16 |
148 | ||
149 | struct pnfs_devicelist { | |
150 | unsigned int eof; | |
151 | unsigned int num_devs; | |
152 | struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM]; | |
153 | }; | |
154 | ||
02c35fca FI |
155 | extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *); |
156 | extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *); | |
157 | ||
b1f69b75 | 158 | /* nfs4proc.c */ |
7f11d8d3 AA |
159 | extern int nfs4_proc_getdevicelist(struct nfs_server *server, |
160 | const struct nfs_fh *fh, | |
161 | struct pnfs_devicelist *devlist); | |
b1f69b75 AA |
162 | extern int nfs4_proc_getdeviceinfo(struct nfs_server *server, |
163 | struct pnfs_device *dev); | |
164 | extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp); | |
cbe82603 | 165 | extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp); |
b1f69b75 AA |
166 | |
167 | /* pnfs.c */ | |
43f1b3da | 168 | void get_layout_hdr(struct pnfs_layout_hdr *lo); |
bae724ef | 169 | void put_lseg(struct pnfs_layout_segment *lseg); |
1751c363 TM |
170 | |
171 | bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *); | |
172 | bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *, int); | |
173 | ||
738fd0f3 | 174 | void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32); |
85e174ba | 175 | void unset_pnfs_layoutdriver(struct nfs_server *); |
d8007d4d | 176 | void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *); |
493292dd | 177 | int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc); |
d8007d4d | 178 | void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *, struct nfs_page *); |
dce81290 | 179 | int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc); |
18ad0a9f | 180 | bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req); |
1b0ae068 | 181 | void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg); |
b1f69b75 | 182 | int pnfs_layout_process(struct nfs4_layoutget *lgp); |
43f1b3da | 183 | void pnfs_free_lseg_list(struct list_head *tmp_list); |
e5e94017 | 184 | void pnfs_destroy_layout(struct nfs_inode *); |
974cec8c | 185 | void pnfs_destroy_all_layouts(struct nfs_client *); |
cc6e5340 | 186 | void put_layout_hdr(struct pnfs_layout_hdr *lo); |
43f1b3da FI |
187 | void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, |
188 | const nfs4_stateid *new, | |
189 | bool update_barrier); | |
fd6002e9 FI |
190 | int pnfs_choose_layoutget_stateid(nfs4_stateid *dst, |
191 | struct pnfs_layout_hdr *lo, | |
192 | struct nfs4_state *open_state); | |
43f1b3da FI |
193 | int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo, |
194 | struct list_head *tmp_list, | |
778b5502 | 195 | struct pnfs_layout_range *recall_range); |
f7e8917a FI |
196 | bool pnfs_roc(struct inode *ino); |
197 | void pnfs_roc_release(struct inode *ino); | |
198 | void pnfs_roc_set_barrier(struct inode *ino, u32 barrier); | |
199 | bool pnfs_roc_drain(struct inode *ino, u32 *barrier); | |
863a3c6c | 200 | void pnfs_set_layoutcommit(struct nfs_write_data *wdata); |
db29c089 | 201 | void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data); |
ef311537 | 202 | int pnfs_layoutcommit_inode(struct inode *inode, bool sync); |
cbe82603 | 203 | int _pnfs_return_layout(struct inode *); |
8ce160c5 | 204 | void pnfs_ld_write_done(struct nfs_write_data *); |
9b7eecdc | 205 | void pnfs_ld_read_done(struct nfs_read_data *); |
7c24d948 AA |
206 | struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino, |
207 | struct nfs_open_context *ctx, | |
208 | loff_t pos, | |
209 | u64 count, | |
210 | enum pnfs_iomode iomode, | |
211 | gfp_t gfp_flags); | |
e5e94017 | 212 | |
c47abcf8 AA |
213 | void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp); |
214 | ||
215 | /* nfs4_deviceid_flags */ | |
216 | enum { | |
217 | NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */ | |
218 | }; | |
219 | ||
a1eaecbc BH |
220 | /* pnfs_dev.c */ |
221 | struct nfs4_deviceid_node { | |
222 | struct hlist_node node; | |
9e3bd4e2 | 223 | struct hlist_node tmpnode; |
1775bc34 | 224 | const struct pnfs_layoutdriver_type *ld; |
a1eaecbc | 225 | const struct nfs_client *nfs_client; |
c47abcf8 | 226 | unsigned long flags; |
a1eaecbc BH |
227 | struct nfs4_deviceid deviceid; |
228 | atomic_t ref; | |
229 | }; | |
230 | ||
231 | void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id); | |
35c8bb54 | 232 | struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *); |
35c8bb54 | 233 | void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *); |
a1eaecbc | 234 | void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, |
1775bc34 | 235 | const struct pnfs_layoutdriver_type *, |
a1eaecbc BH |
236 | const struct nfs_client *, |
237 | const struct nfs4_deviceid *); | |
238 | struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *); | |
239 | bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *); | |
1775bc34 | 240 | void nfs4_deviceid_purge_client(const struct nfs_client *); |
a1eaecbc | 241 | |
e5e94017 BH |
242 | static inline int lo_fail_bit(u32 iomode) |
243 | { | |
244 | return iomode == IOMODE_RW ? | |
245 | NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED; | |
246 | } | |
247 | ||
d684d2ae FI |
248 | static inline struct pnfs_layout_segment * |
249 | get_lseg(struct pnfs_layout_segment *lseg) | |
250 | { | |
251 | if (lseg) { | |
252 | atomic_inc(&lseg->pls_refcount); | |
253 | smp_mb__after_atomic_inc(); | |
254 | } | |
255 | return lseg; | |
256 | } | |
257 | ||
e5e94017 BH |
258 | /* Return true if a layout driver is being used for this mountpoint */ |
259 | static inline int pnfs_enabled_sb(struct nfs_server *nfss) | |
260 | { | |
261 | return nfss->pnfs_curr_ld != NULL; | |
262 | } | |
85e174ba | 263 | |
a861a1e1 FI |
264 | static inline int |
265 | pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how) | |
266 | { | |
267 | if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags)) | |
268 | return PNFS_NOT_ATTEMPTED; | |
269 | return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how); | |
270 | } | |
271 | ||
272 | static inline struct list_head * | |
d6d6dc7c | 273 | pnfs_choose_commit_list(struct nfs_page *req, struct pnfs_layout_segment *lseg) |
a861a1e1 | 274 | { |
d6d6dc7c | 275 | struct inode *inode = req->wb_context->dentry->d_inode; |
a861a1e1 FI |
276 | struct list_head *rv; |
277 | ||
d6d6dc7c FI |
278 | if (lseg && NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list) |
279 | rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req, lseg); | |
280 | else | |
281 | rv = &NFS_I(inode)->commit_list; | |
a861a1e1 FI |
282 | return rv; |
283 | } | |
284 | ||
d6d6dc7c FI |
285 | static inline struct pnfs_layout_segment * |
286 | pnfs_clear_request_commit(struct nfs_page *req) | |
a861a1e1 | 287 | { |
d6d6dc7c FI |
288 | struct inode *inode = req->wb_context->dentry->d_inode; |
289 | ||
290 | if (NFS_SERVER(inode)->pnfs_curr_ld && | |
291 | NFS_SERVER(inode)->pnfs_curr_ld->remove_commit_req) | |
292 | return NFS_SERVER(inode)->pnfs_curr_ld->remove_commit_req(req); | |
293 | else | |
294 | return NULL; | |
295 | } | |
296 | ||
297 | static inline int | |
298 | pnfs_scan_commit_lists(struct inode *inode, int max) | |
299 | { | |
300 | if (NFS_SERVER(inode)->pnfs_curr_ld && | |
301 | NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists) | |
302 | return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(inode, max); | |
303 | else | |
304 | return 0; | |
a861a1e1 FI |
305 | } |
306 | ||
8a1636c4 BH |
307 | /* Should the pNFS client commit and return the layout upon a setattr */ |
308 | static inline bool | |
309 | pnfs_ld_layoutret_on_setattr(struct inode *inode) | |
310 | { | |
311 | if (!pnfs_enabled_sb(NFS_SERVER(inode))) | |
312 | return false; | |
313 | return NFS_SERVER(inode)->pnfs_curr_ld->flags & | |
314 | PNFS_LAYOUTRET_ON_SETATTR; | |
315 | } | |
316 | ||
cbe82603 BH |
317 | static inline int pnfs_return_layout(struct inode *ino) |
318 | { | |
319 | struct nfs_inode *nfsi = NFS_I(ino); | |
320 | struct nfs_server *nfss = NFS_SERVER(ino); | |
321 | ||
322 | if (pnfs_enabled_sb(nfss) && nfsi->layout) | |
323 | return _pnfs_return_layout(ino); | |
324 | ||
325 | return 0; | |
326 | } | |
327 | ||
85e174ba RL |
328 | #else /* CONFIG_NFS_V4_1 */ |
329 | ||
974cec8c AA |
330 | static inline void pnfs_destroy_all_layouts(struct nfs_client *clp) |
331 | { | |
332 | } | |
333 | ||
e5e94017 BH |
334 | static inline void pnfs_destroy_layout(struct nfs_inode *nfsi) |
335 | { | |
336 | } | |
337 | ||
d684d2ae FI |
338 | static inline struct pnfs_layout_segment * |
339 | get_lseg(struct pnfs_layout_segment *lseg) | |
340 | { | |
341 | return NULL; | |
342 | } | |
343 | ||
344 | static inline void put_lseg(struct pnfs_layout_segment *lseg) | |
345 | { | |
346 | } | |
347 | ||
cbe82603 BH |
348 | static inline int pnfs_return_layout(struct inode *ino) |
349 | { | |
350 | return 0; | |
351 | } | |
352 | ||
8a1636c4 BH |
353 | static inline bool |
354 | pnfs_ld_layoutret_on_setattr(struct inode *inode) | |
355 | { | |
356 | return false; | |
357 | } | |
358 | ||
f7e8917a FI |
359 | static inline bool |
360 | pnfs_roc(struct inode *ino) | |
361 | { | |
362 | return false; | |
363 | } | |
364 | ||
365 | static inline void | |
366 | pnfs_roc_release(struct inode *ino) | |
367 | { | |
368 | } | |
369 | ||
370 | static inline void | |
371 | pnfs_roc_set_barrier(struct inode *ino, u32 barrier) | |
372 | { | |
373 | } | |
374 | ||
375 | static inline bool | |
376 | pnfs_roc_drain(struct inode *ino, u32 *barrier) | |
377 | { | |
378 | return false; | |
379 | } | |
380 | ||
738fd0f3 | 381 | static inline void set_pnfs_layoutdriver(struct nfs_server *s, |
a00ed25c | 382 | const struct nfs_fh *mntfh, u32 id) |
85e174ba RL |
383 | { |
384 | } | |
385 | ||
386 | static inline void unset_pnfs_layoutdriver(struct nfs_server *s) | |
387 | { | |
388 | } | |
389 | ||
1751c363 | 390 | static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode) |
44b83799 | 391 | { |
1751c363 TM |
392 | return false; |
393 | } | |
394 | ||
395 | static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags) | |
396 | { | |
397 | return false; | |
44b83799 FI |
398 | } |
399 | ||
a861a1e1 FI |
400 | static inline int |
401 | pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how) | |
402 | { | |
403 | return PNFS_NOT_ATTEMPTED; | |
404 | } | |
405 | ||
406 | static inline struct list_head * | |
d6d6dc7c | 407 | pnfs_choose_commit_list(struct nfs_page *req, struct pnfs_layout_segment *lseg) |
a861a1e1 | 408 | { |
d6d6dc7c FI |
409 | struct inode *inode = req->wb_context->dentry->d_inode; |
410 | ||
411 | return &NFS_I(inode)->commit_list; | |
a861a1e1 FI |
412 | } |
413 | ||
d6d6dc7c FI |
414 | static inline struct pnfs_layout_segment * |
415 | pnfs_clear_request_commit(struct nfs_page *req) | |
a861a1e1 | 416 | { |
d6d6dc7c FI |
417 | return NULL; |
418 | } | |
419 | ||
420 | static inline int | |
421 | pnfs_scan_commit_lists(struct inode *inode, int max) | |
422 | { | |
423 | return 0; | |
a861a1e1 FI |
424 | } |
425 | ||
ef311537 | 426 | static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync) |
863a3c6c AA |
427 | { |
428 | return 0; | |
429 | } | |
1775bc34 | 430 | |
85e174ba RL |
431 | #endif /* CONFIG_NFS_V4_1 */ |
432 | ||
433 | #endif /* FS_NFS_PNFS_H */ |