Merge tag 'iwlwifi-next-for-john-2014-10-29' of git://git.kernel.org/pub/scm/linux...
[deliverable/linux.git] / fs / nfs / pnfs.h
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
33 #include <linux/nfs_fs.h>
34 #include <linux/nfs_page.h>
35 #include <linux/workqueue.h>
36
37 enum {
38 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
39 NFS_LSEG_ROC, /* roc bit received from server */
40 NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
41 };
42
43 struct pnfs_layout_segment {
44 struct list_head pls_list;
45 struct list_head pls_lc_list;
46 struct pnfs_layout_range pls_range;
47 atomic_t pls_refcount;
48 unsigned long pls_flags;
49 struct pnfs_layout_hdr *pls_layout;
50 struct work_struct pls_work;
51 };
52
53 enum pnfs_try_status {
54 PNFS_ATTEMPTED = 0,
55 PNFS_NOT_ATTEMPTED = 1,
56 };
57
58 #ifdef CONFIG_NFS_V4_1
59
60 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
61
62 enum {
63 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
64 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
65 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
66 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
67 NFS_LAYOUT_RETURN, /* Return this layout ASAP */
68 NFS_LAYOUT_INVALID_STID, /* layout stateid id is invalid */
69 };
70
71 enum layoutdriver_policy_flags {
72 /* Should the pNFS client commit and return the layout upon truncate to
73 * a smaller size */
74 PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
75 PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
76 PNFS_READ_WHOLE_PAGE = 1 << 2,
77 };
78
79 struct nfs4_deviceid_node;
80
81 /* Per-layout driver specific registration structure */
82 struct pnfs_layoutdriver_type {
83 struct list_head pnfs_tblid;
84 const u32 id;
85 const char *name;
86 struct module *owner;
87 unsigned flags;
88 unsigned max_deviceinfo_size;
89
90 int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
91 int (*clear_layoutdriver) (struct nfs_server *);
92
93 struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
94 void (*free_layout_hdr) (struct pnfs_layout_hdr *);
95
96 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
97 void (*free_lseg) (struct pnfs_layout_segment *lseg);
98
99 void (*return_range) (struct pnfs_layout_hdr *lo,
100 struct pnfs_layout_range *range);
101
102 /* test for nfs page cache coalescing */
103 const struct nfs_pageio_ops *pg_read_ops;
104 const struct nfs_pageio_ops *pg_write_ops;
105
106 struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
107 void (*mark_request_commit) (struct nfs_page *req,
108 struct pnfs_layout_segment *lseg,
109 struct nfs_commit_info *cinfo);
110 void (*clear_request_commit) (struct nfs_page *req,
111 struct nfs_commit_info *cinfo);
112 int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
113 int max);
114 void (*recover_commit_reqs) (struct list_head *list,
115 struct nfs_commit_info *cinfo);
116 struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
117 struct page *page);
118 int (*commit_pagelist)(struct inode *inode,
119 struct list_head *mds_pages,
120 int how,
121 struct nfs_commit_info *cinfo);
122
123 /*
124 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
125 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
126 */
127 enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
128 enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
129
130 void (*free_deviceid_node) (struct nfs4_deviceid_node *);
131 struct nfs4_deviceid_node * (*alloc_deviceid_node)
132 (struct nfs_server *server, struct pnfs_device *pdev,
133 gfp_t gfp_flags);
134
135 void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
136 struct xdr_stream *xdr,
137 const struct nfs4_layoutreturn_args *args);
138
139 void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
140 int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
141 void (*encode_layoutcommit) (struct pnfs_layout_hdr *lo,
142 struct xdr_stream *xdr,
143 const struct nfs4_layoutcommit_args *args);
144 };
145
146 struct pnfs_layout_hdr {
147 atomic_t plh_refcount;
148 struct list_head plh_layouts; /* other client layouts */
149 struct list_head plh_bulk_destroy;
150 struct list_head plh_segs; /* layout segments list */
151 nfs4_stateid plh_stateid;
152 atomic_t plh_outstanding; /* number of RPCs out */
153 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
154 u32 plh_barrier; /* ignore lower seqids */
155 unsigned long plh_retry_timestamp;
156 unsigned long plh_flags;
157 loff_t plh_lwb; /* last write byte for layoutcommit */
158 struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
159 struct inode *plh_inode;
160 };
161
162 struct pnfs_device {
163 struct nfs4_deviceid dev_id;
164 unsigned int layout_type;
165 unsigned int mincount;
166 unsigned int maxcount; /* gdia_maxcount */
167 struct page **pages;
168 unsigned int pgbase;
169 unsigned int pglen; /* reply buffer length */
170 };
171
172 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
173
174 struct pnfs_devicelist {
175 unsigned int eof;
176 unsigned int num_devs;
177 struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
178 };
179
180 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
181 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
182
183 /* nfs4proc.c */
184 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
185 struct pnfs_device *dev,
186 struct rpc_cred *cred);
187 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
188 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
189
190 /* pnfs.c */
191 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
192 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
193 void pnfs_put_lseg_locked(struct pnfs_layout_segment *lseg);
194
195 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
196 void unset_pnfs_layoutdriver(struct nfs_server *);
197 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
198 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
199 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
200 struct nfs_page *req, u64 wb_size);
201 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
202 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
203 struct nfs_page *prev, struct nfs_page *req);
204 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
205 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
206 void pnfs_free_lseg_list(struct list_head *tmp_list);
207 void pnfs_destroy_layout(struct nfs_inode *);
208 void pnfs_destroy_all_layouts(struct nfs_client *);
209 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
210 struct nfs_fsid *fsid,
211 bool is_recall);
212 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
213 bool is_recall);
214 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
215 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
216 const nfs4_stateid *new,
217 bool update_barrier);
218 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
219 struct pnfs_layout_hdr *lo,
220 struct nfs4_state *open_state);
221 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
222 struct list_head *tmp_list,
223 struct pnfs_layout_range *recall_range);
224 bool pnfs_roc(struct inode *ino);
225 void pnfs_roc_release(struct inode *ino);
226 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
227 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
228 void pnfs_set_layoutcommit(struct nfs_pgio_header *);
229 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data);
230 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
231 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
232 int _pnfs_return_layout(struct inode *);
233 int pnfs_commit_and_return_layout(struct inode *);
234 void pnfs_ld_write_done(struct nfs_pgio_header *);
235 void pnfs_ld_read_done(struct nfs_pgio_header *);
236 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
237 struct nfs_open_context *ctx,
238 loff_t pos,
239 u64 count,
240 enum pnfs_iomode iomode,
241 gfp_t gfp_flags);
242
243 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
244 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
245 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
246 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
247
248 /* nfs4_deviceid_flags */
249 enum {
250 NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
251 NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
252 };
253
254 /* pnfs_dev.c */
255 struct nfs4_deviceid_node {
256 struct hlist_node node;
257 struct hlist_node tmpnode;
258 const struct pnfs_layoutdriver_type *ld;
259 const struct nfs_client *nfs_client;
260 unsigned long flags;
261 unsigned long timestamp_unavailable;
262 struct nfs4_deviceid deviceid;
263 atomic_t ref;
264 };
265
266 struct nfs4_deviceid_node *
267 nfs4_find_get_deviceid(struct nfs_server *server,
268 const struct nfs4_deviceid *id, struct rpc_cred *cred,
269 gfp_t gfp_mask);
270 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
271 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
272 const struct nfs4_deviceid *);
273 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
274 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
275 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
276 void nfs4_deviceid_purge_client(const struct nfs_client *);
277
278 static inline struct nfs4_deviceid_node *
279 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
280 {
281 atomic_inc(&d->ref);
282 return d;
283 }
284
285 static inline struct pnfs_layout_segment *
286 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
287 {
288 if (lseg) {
289 atomic_inc(&lseg->pls_refcount);
290 smp_mb__after_atomic();
291 }
292 return lseg;
293 }
294
295 /* Return true if a layout driver is being used for this mountpoint */
296 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
297 {
298 return nfss->pnfs_curr_ld != NULL;
299 }
300
301 static inline int
302 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
303 struct nfs_commit_info *cinfo)
304 {
305 if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
306 return PNFS_NOT_ATTEMPTED;
307 return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
308 }
309
310 static inline struct pnfs_ds_commit_info *
311 pnfs_get_ds_info(struct inode *inode)
312 {
313 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
314
315 if (ld == NULL || ld->get_ds_info == NULL)
316 return NULL;
317 return ld->get_ds_info(inode);
318 }
319
320 static inline bool
321 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
322 struct nfs_commit_info *cinfo)
323 {
324 struct inode *inode = req->wb_context->dentry->d_inode;
325 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
326
327 if (lseg == NULL || ld->mark_request_commit == NULL)
328 return false;
329 ld->mark_request_commit(req, lseg, cinfo);
330 return true;
331 }
332
333 static inline bool
334 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
335 {
336 struct inode *inode = req->wb_context->dentry->d_inode;
337 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
338
339 if (ld == NULL || ld->clear_request_commit == NULL)
340 return false;
341 ld->clear_request_commit(req, cinfo);
342 return true;
343 }
344
345 static inline int
346 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
347 int max)
348 {
349 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
350 return 0;
351 else
352 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
353 }
354
355 static inline void
356 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
357 struct nfs_commit_info *cinfo)
358 {
359 if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
360 return;
361 NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
362 }
363
364 static inline struct nfs_page *
365 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
366 struct page *page)
367 {
368 struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
369
370 if (ld == NULL || ld->search_commit_reqs == NULL)
371 return NULL;
372 return ld->search_commit_reqs(cinfo, page);
373 }
374
375 /* Should the pNFS client commit and return the layout upon a setattr */
376 static inline bool
377 pnfs_ld_layoutret_on_setattr(struct inode *inode)
378 {
379 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
380 return false;
381 return NFS_SERVER(inode)->pnfs_curr_ld->flags &
382 PNFS_LAYOUTRET_ON_SETATTR;
383 }
384
385 static inline bool
386 pnfs_ld_read_whole_page(struct inode *inode)
387 {
388 if (!pnfs_enabled_sb(NFS_SERVER(inode)))
389 return false;
390 return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
391 }
392
393 static inline bool
394 pnfs_layoutcommit_outstanding(struct inode *inode)
395 {
396 struct nfs_inode *nfsi = NFS_I(inode);
397
398 return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
399 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
400 }
401
402 static inline int pnfs_return_layout(struct inode *ino)
403 {
404 struct nfs_inode *nfsi = NFS_I(ino);
405 struct nfs_server *nfss = NFS_SERVER(ino);
406
407 if (pnfs_enabled_sb(nfss) && nfsi->layout)
408 return _pnfs_return_layout(ino);
409
410 return 0;
411 }
412
413 static inline bool
414 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
415 struct nfs_server *nfss)
416 {
417 return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
418 nfss->pnfs_curr_ld->id == src->l_type);
419 }
420
421 #ifdef NFS_DEBUG
422 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
423 #else
424 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
425 {
426 }
427 #endif /* NFS_DEBUG */
428 #else /* CONFIG_NFS_V4_1 */
429
430 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
431 {
432 }
433
434 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
435 {
436 }
437
438 static inline struct pnfs_layout_segment *
439 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
440 {
441 return NULL;
442 }
443
444 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
445 {
446 }
447
448 static inline int pnfs_return_layout(struct inode *ino)
449 {
450 return 0;
451 }
452
453 static inline int pnfs_commit_and_return_layout(struct inode *inode)
454 {
455 return 0;
456 }
457
458 static inline bool
459 pnfs_ld_layoutret_on_setattr(struct inode *inode)
460 {
461 return false;
462 }
463
464 static inline bool
465 pnfs_ld_read_whole_page(struct inode *inode)
466 {
467 return false;
468 }
469
470 static inline bool
471 pnfs_roc(struct inode *ino)
472 {
473 return false;
474 }
475
476 static inline void
477 pnfs_roc_release(struct inode *ino)
478 {
479 }
480
481 static inline void
482 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
483 {
484 }
485
486 static inline bool
487 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
488 {
489 return false;
490 }
491
492 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
493 const struct nfs_fh *mntfh, u32 id)
494 {
495 }
496
497 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
498 {
499 }
500
501 static inline int
502 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
503 struct nfs_commit_info *cinfo)
504 {
505 return PNFS_NOT_ATTEMPTED;
506 }
507
508 static inline struct pnfs_ds_commit_info *
509 pnfs_get_ds_info(struct inode *inode)
510 {
511 return NULL;
512 }
513
514 static inline bool
515 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
516 struct nfs_commit_info *cinfo)
517 {
518 return false;
519 }
520
521 static inline bool
522 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
523 {
524 return false;
525 }
526
527 static inline int
528 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
529 int max)
530 {
531 return 0;
532 }
533
534 static inline void
535 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
536 struct nfs_commit_info *cinfo)
537 {
538 }
539
540 static inline struct nfs_page *
541 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
542 struct page *page)
543 {
544 return NULL;
545 }
546
547 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
548 {
549 return 0;
550 }
551
552 static inline bool
553 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
554 struct nfs_server *nfss)
555 {
556 return false;
557 }
558
559 static inline bool
560 pnfs_layoutcommit_outstanding(struct inode *inode)
561 {
562 return false;
563 }
564
565
566 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
567 {
568 return NULL;
569 }
570
571 #endif /* CONFIG_NFS_V4_1 */
572
573 #endif /* FS_NFS_PNFS_H */
This page took 0.057734 seconds and 6 git commands to generate.