NFSv4.1: Optimise layout return-on-close
[linux-2.6-block.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 bool nfs_have_layout(struct inode *inode)
279 {
280         return NFS_I(inode)->layout != NULL;
281 }
282
283 static inline struct nfs4_deviceid_node *
284 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
285 {
286         atomic_inc(&d->ref);
287         return d;
288 }
289
290 static inline struct pnfs_layout_segment *
291 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
292 {
293         if (lseg) {
294                 atomic_inc(&lseg->pls_refcount);
295                 smp_mb__after_atomic();
296         }
297         return lseg;
298 }
299
300 /* Return true if a layout driver is being used for this mountpoint */
301 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
302 {
303         return nfss->pnfs_curr_ld != NULL;
304 }
305
306 static inline int
307 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
308                  struct nfs_commit_info *cinfo)
309 {
310         if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
311                 return PNFS_NOT_ATTEMPTED;
312         return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
313 }
314
315 static inline struct pnfs_ds_commit_info *
316 pnfs_get_ds_info(struct inode *inode)
317 {
318         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
319
320         if (ld == NULL || ld->get_ds_info == NULL)
321                 return NULL;
322         return ld->get_ds_info(inode);
323 }
324
325 static inline bool
326 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
327                          struct nfs_commit_info *cinfo)
328 {
329         struct inode *inode = req->wb_context->dentry->d_inode;
330         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
331
332         if (lseg == NULL || ld->mark_request_commit == NULL)
333                 return false;
334         ld->mark_request_commit(req, lseg, cinfo);
335         return true;
336 }
337
338 static inline bool
339 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
340 {
341         struct inode *inode = req->wb_context->dentry->d_inode;
342         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
343
344         if (ld == NULL || ld->clear_request_commit == NULL)
345                 return false;
346         ld->clear_request_commit(req, cinfo);
347         return true;
348 }
349
350 static inline int
351 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
352                        int max)
353 {
354         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
355                 return 0;
356         else
357                 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
358 }
359
360 static inline void
361 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
362                          struct nfs_commit_info *cinfo)
363 {
364         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
365                 return;
366         NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
367 }
368
369 static inline struct nfs_page *
370 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
371                         struct page *page)
372 {
373         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
374
375         if (ld == NULL || ld->search_commit_reqs == NULL)
376                 return NULL;
377         return ld->search_commit_reqs(cinfo, page);
378 }
379
380 /* Should the pNFS client commit and return the layout upon a setattr */
381 static inline bool
382 pnfs_ld_layoutret_on_setattr(struct inode *inode)
383 {
384         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
385                 return false;
386         return NFS_SERVER(inode)->pnfs_curr_ld->flags &
387                 PNFS_LAYOUTRET_ON_SETATTR;
388 }
389
390 static inline bool
391 pnfs_ld_read_whole_page(struct inode *inode)
392 {
393         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
394                 return false;
395         return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
396 }
397
398 static inline bool
399 pnfs_layoutcommit_outstanding(struct inode *inode)
400 {
401         struct nfs_inode *nfsi = NFS_I(inode);
402
403         return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
404                 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
405 }
406
407 static inline int pnfs_return_layout(struct inode *ino)
408 {
409         struct nfs_inode *nfsi = NFS_I(ino);
410         struct nfs_server *nfss = NFS_SERVER(ino);
411
412         if (pnfs_enabled_sb(nfss) && nfsi->layout)
413                 return _pnfs_return_layout(ino);
414
415         return 0;
416 }
417
418 static inline bool
419 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
420                    struct nfs_server *nfss)
421 {
422         return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
423                                         nfss->pnfs_curr_ld->id == src->l_type);
424 }
425
426 #ifdef NFS_DEBUG
427 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
428 #else
429 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
430 {
431 }
432 #endif /* NFS_DEBUG */
433 #else  /* CONFIG_NFS_V4_1 */
434
435 static inline bool nfs_have_layout(struct inode *inode)
436 {
437         return false;
438 }
439
440 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
441 {
442 }
443
444 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
445 {
446 }
447
448 static inline struct pnfs_layout_segment *
449 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
450 {
451         return NULL;
452 }
453
454 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
455 {
456 }
457
458 static inline int pnfs_return_layout(struct inode *ino)
459 {
460         return 0;
461 }
462
463 static inline int pnfs_commit_and_return_layout(struct inode *inode)
464 {
465         return 0;
466 }
467
468 static inline bool
469 pnfs_ld_layoutret_on_setattr(struct inode *inode)
470 {
471         return false;
472 }
473
474 static inline bool
475 pnfs_ld_read_whole_page(struct inode *inode)
476 {
477         return false;
478 }
479
480 static inline bool
481 pnfs_roc(struct inode *ino)
482 {
483         return false;
484 }
485
486 static inline void
487 pnfs_roc_release(struct inode *ino)
488 {
489 }
490
491 static inline void
492 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
493 {
494 }
495
496 static inline bool
497 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
498 {
499         return false;
500 }
501
502 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
503                                          const struct nfs_fh *mntfh, u32 id)
504 {
505 }
506
507 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
508 {
509 }
510
511 static inline int
512 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
513                  struct nfs_commit_info *cinfo)
514 {
515         return PNFS_NOT_ATTEMPTED;
516 }
517
518 static inline struct pnfs_ds_commit_info *
519 pnfs_get_ds_info(struct inode *inode)
520 {
521         return NULL;
522 }
523
524 static inline bool
525 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
526                          struct nfs_commit_info *cinfo)
527 {
528         return false;
529 }
530
531 static inline bool
532 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
533 {
534         return false;
535 }
536
537 static inline int
538 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
539                        int max)
540 {
541         return 0;
542 }
543
544 static inline void
545 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
546                          struct nfs_commit_info *cinfo)
547 {
548 }
549
550 static inline struct nfs_page *
551 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
552                         struct page *page)
553 {
554         return NULL;
555 }
556
557 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
558 {
559         return 0;
560 }
561
562 static inline bool
563 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
564                    struct nfs_server *nfss)
565 {
566         return false;
567 }
568
569 static inline bool
570 pnfs_layoutcommit_outstanding(struct inode *inode)
571 {
572         return false;
573 }
574
575
576 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
577 {
578         return NULL;
579 }
580
581 #endif /* CONFIG_NFS_V4_1 */
582
583 #endif /* FS_NFS_PNFS_H */