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