91ff877185c8afe462eb81f6571afd3ade14ffb4
[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/refcount.h>
34 #include <linux/nfs_fs.h>
35 #include <linux/nfs_page.h>
36 #include <linux/workqueue.h>
37
38 struct nfs4_exception;
39 struct nfs4_opendata;
40
41 enum {
42         NFS_LSEG_VALID = 0,     /* cleared when lseg is recalled/returned */
43         NFS_LSEG_ROC,           /* roc bit received from server */
44         NFS_LSEG_LAYOUTCOMMIT,  /* layoutcommit bit set for layoutcommit */
45         NFS_LSEG_LAYOUTRETURN,  /* layoutreturn bit set for layoutreturn */
46         NFS_LSEG_UNAVAILABLE,   /* unavailable bit set for temporary problem */
47 };
48
49 /* Individual ip address */
50 struct nfs4_pnfs_ds_addr {
51         struct sockaddr_storage da_addr;
52         size_t                  da_addrlen;
53         struct list_head        da_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
54         char                    *da_remotestr;  /* human readable addr+port */
55         const char              *da_netid;
56         int                     da_transport;
57 };
58
59 struct nfs4_pnfs_ds {
60         struct list_head        ds_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
61         char                    *ds_remotestr;  /* comma sep list of addrs */
62         struct list_head        ds_addrs;
63         const struct net        *ds_net;
64         struct nfs_client       *ds_clp;
65         refcount_t              ds_count;
66         unsigned long           ds_state;
67 #define NFS4DS_CONNECTING       0       /* ds is establishing connection */
68 };
69
70 struct pnfs_layout_segment {
71         struct list_head pls_list;
72         struct list_head pls_lc_list;
73         struct list_head pls_commits;
74         struct pnfs_layout_range pls_range;
75         refcount_t pls_refcount;
76         u32 pls_seq;
77         unsigned long pls_flags;
78         struct pnfs_layout_hdr *pls_layout;
79 };
80
81 enum pnfs_try_status {
82         PNFS_ATTEMPTED     = 0,
83         PNFS_NOT_ATTEMPTED = 1,
84         PNFS_TRY_AGAIN     = 2,
85 };
86
87 #ifdef CONFIG_NFS_V4_1
88
89 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
90
91 /*
92  * Default data server connection timeout and retrans vaules.
93  * Set by module parameters dataserver_timeo and dataserver_retrans.
94  */
95 #define NFS4_DEF_DS_TIMEO   600 /* in tenths of a second */
96 #define NFS4_DEF_DS_RETRANS 5
97 #define PNFS_DEVICE_RETRY_TIMEOUT (120*HZ)
98
99 enum {
100         NFS_LAYOUT_RO_FAILED = 0,       /* get ro layout failed stop trying */
101         NFS_LAYOUT_RW_FAILED,           /* get rw layout failed stop trying */
102         NFS_LAYOUT_BULK_RECALL,         /* bulk recall affecting layout */
103         NFS_LAYOUT_RETURN,              /* layoutreturn in progress */
104         NFS_LAYOUT_RETURN_LOCK,         /* Serialise layoutreturn */
105         NFS_LAYOUT_RETURN_REQUESTED,    /* Return this layout ASAP */
106         NFS_LAYOUT_INVALID_STID,        /* layout stateid id is invalid */
107         NFS_LAYOUT_FIRST_LAYOUTGET,     /* Serialize first layoutget */
108         NFS_LAYOUT_INODE_FREEING,       /* The inode is being freed */
109         NFS_LAYOUT_HASHED,              /* The layout visible */
110         NFS_LAYOUT_DRAIN,
111 };
112
113 enum layoutdriver_policy_flags {
114         /* Should the pNFS client commit and return the layout upon truncate to
115          * a smaller size */
116         PNFS_LAYOUTRET_ON_SETATTR       = 1 << 0,
117         PNFS_LAYOUTRET_ON_ERROR         = 1 << 1,
118         PNFS_READ_WHOLE_PAGE            = 1 << 2,
119         PNFS_LAYOUTGET_ON_OPEN          = 1 << 3,
120 };
121
122 enum pnfs_layout_destroy_mode {
123         PNFS_LAYOUT_INVALIDATE = 0,
124         PNFS_LAYOUT_BULK_RETURN,
125         PNFS_LAYOUT_FILE_BULK_RETURN,
126 };
127
128 struct nfs4_deviceid_node;
129
130 /* Per-layout driver specific registration structure */
131 struct pnfs_layoutdriver_type {
132         struct list_head pnfs_tblid;
133         const u32 id;
134         const char *name;
135         struct module *owner;
136         unsigned flags;
137         unsigned max_layoutget_response;
138
139         int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
140         int (*clear_layoutdriver) (struct nfs_server *);
141
142         struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
143         void (*free_layout_hdr) (struct pnfs_layout_hdr *);
144
145         struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
146         void (*free_lseg) (struct pnfs_layout_segment *lseg);
147         void (*add_lseg) (struct pnfs_layout_hdr *layoutid,
148                         struct pnfs_layout_segment *lseg,
149                         struct list_head *free_me);
150
151         void (*return_range) (struct pnfs_layout_hdr *lo,
152                               struct pnfs_layout_range *range);
153
154         /* test for nfs page cache coalescing */
155         const struct nfs_pageio_ops *pg_read_ops;
156         const struct nfs_pageio_ops *pg_write_ops;
157
158         struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
159
160         int (*sync)(struct inode *inode, bool datasync);
161
162         /*
163          * Return PNFS_ATTEMPTED to indicate the layout code has attempted
164          * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
165          */
166         enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
167         enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
168
169         void (*free_deviceid_node) (struct nfs4_deviceid_node *);
170         struct nfs4_deviceid_node * (*alloc_deviceid_node)
171                         (struct nfs_server *server, struct pnfs_device *pdev,
172                         gfp_t gfp_flags);
173
174         int (*prepare_layoutreturn) (struct nfs4_layoutreturn_args *);
175
176         void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
177         int (*prepare_layoutcommit) (struct nfs4_layoutcommit_args *args);
178         int (*prepare_layoutstats) (struct nfs42_layoutstat_args *args);
179
180         void (*cancel_io)(struct pnfs_layout_segment *lseg);
181 };
182
183 struct pnfs_commit_ops {
184         void (*setup_ds_info)(struct pnfs_ds_commit_info *,
185                               struct pnfs_layout_segment *);
186         void (*release_ds_info)(struct pnfs_ds_commit_info *,
187                                 struct inode *inode);
188         int (*commit_pagelist)(struct inode *inode,
189                                struct list_head *mds_pages,
190                                int how,
191                                struct nfs_commit_info *cinfo);
192         void (*mark_request_commit) (struct nfs_page *req,
193                                      struct pnfs_layout_segment *lseg,
194                                      struct nfs_commit_info *cinfo,
195                                      u32 ds_commit_idx);
196         void (*clear_request_commit) (struct nfs_page *req,
197                                       struct nfs_commit_info *cinfo);
198         int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
199                                   int max);
200         void (*recover_commit_reqs) (struct list_head *list,
201                                      struct nfs_commit_info *cinfo);
202 };
203
204 struct pnfs_layout_hdr {
205         refcount_t              plh_refcount;
206         atomic_t                plh_outstanding; /* number of RPCs out */
207         struct list_head        plh_layouts;   /* other client layouts */
208         struct list_head        plh_bulk_destroy;
209         struct list_head        plh_segs;      /* layout segments list */
210         struct list_head        plh_return_segs; /* invalid layout segments */
211         unsigned long           plh_block_lgets; /* block LAYOUTGET if >0 */
212         unsigned long           plh_retry_timestamp;
213         unsigned long           plh_flags;
214         nfs4_stateid            plh_stateid;
215         u32                     plh_barrier; /* ignore lower seqids */
216         u32                     plh_return_seq;
217         enum pnfs_iomode        plh_return_iomode;
218         loff_t                  plh_lwb; /* last write byte for layoutcommit */
219         const struct cred       *plh_lc_cred; /* layoutcommit cred */
220         struct inode            *plh_inode;
221         struct rcu_head         plh_rcu;
222 };
223
224 struct pnfs_device {
225         struct nfs4_deviceid dev_id;
226         unsigned int  layout_type;
227         unsigned int  mincount;
228         unsigned int  maxcount; /* gdia_maxcount */
229         struct page **pages;
230         unsigned int  pgbase;
231         unsigned int  pglen;    /* reply buffer length */
232         unsigned char nocache : 1;/* May not be cached */
233 };
234
235 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
236
237 struct pnfs_devicelist {
238         unsigned int            eof;
239         unsigned int            num_devs;
240         struct nfs4_deviceid    dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
241 };
242
243 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
244 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
245 extern const struct pnfs_layoutdriver_type *pnfs_find_layoutdriver(u32 id);
246 extern void pnfs_put_layoutdriver(const struct pnfs_layoutdriver_type *ld);
247
248 /* nfs4proc.c */
249 #define PNFS_FL_LAYOUTRETURN_ASYNC (1U << 0)
250 #define PNFS_FL_LAYOUTRETURN_PRIVILEGED (1U << 1)
251
252 extern size_t max_response_pages(struct nfs_server *server);
253 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
254                                    struct pnfs_device *dev,
255                                    const struct cred *cred);
256 extern struct pnfs_layout_segment *
257 nfs4_proc_layoutget(struct nfs4_layoutget *lgp,
258                     struct nfs4_exception *exception);
259 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp,
260                                   unsigned int flags);
261
262 /* pnfs.c */
263 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
264 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
265
266 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, struct nfs_fsinfo *);
267 void unset_pnfs_layoutdriver(struct nfs_server *);
268 void pnfs_generic_pg_check_layout(struct nfs_pageio_descriptor *pgio, struct nfs_page *req);
269 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
270 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
271 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
272                                 struct nfs_page *req, u64 wb_size);
273 void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
274 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
275 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
276                             struct nfs_page *prev, struct nfs_page *req);
277 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
278 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
279 void pnfs_layoutget_free(struct nfs4_layoutget *lgp);
280 void pnfs_free_lseg_list(struct list_head *tmp_list);
281 void pnfs_destroy_layout(struct nfs_inode *);
282 void pnfs_destroy_layout_final(struct nfs_inode *);
283 void pnfs_destroy_all_layouts(struct nfs_client *);
284 int pnfs_layout_destroy_byfsid(struct nfs_client *clp, struct nfs_fsid *fsid,
285                                enum pnfs_layout_destroy_mode mode);
286 int pnfs_layout_destroy_byclid(struct nfs_client *clp,
287                                enum pnfs_layout_destroy_mode mode);
288 bool nfs4_layout_refresh_old_stateid(nfs4_stateid *dst,
289                 struct pnfs_layout_range *dst_range,
290                 struct inode *inode);
291 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
292 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
293                              const nfs4_stateid *new,
294                              const struct cred *cred,
295                              bool update_barrier);
296 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
297                                 struct list_head *tmp_list,
298                                 const struct pnfs_layout_range *recall_range,
299                                 u32 seq);
300 int pnfs_mark_matching_lsegs_return(struct pnfs_layout_hdr *lo,
301                                 struct list_head *tmp_list,
302                                 const struct pnfs_layout_range *recall_range,
303                                 u32 seq);
304 int pnfs_mark_layout_stateid_invalid(struct pnfs_layout_hdr *lo,
305                 struct list_head *lseg_list);
306 bool pnfs_roc(struct inode *ino,
307                 struct nfs4_layoutreturn_args *args,
308                 struct nfs4_layoutreturn_res *res,
309                 const struct cred *cred);
310 int pnfs_roc_done(struct rpc_task *task, struct nfs4_layoutreturn_args **argpp,
311                   struct nfs4_layoutreturn_res **respp, int *ret);
312 void pnfs_roc_release(struct nfs4_layoutreturn_args *args,
313                 struct nfs4_layoutreturn_res *res,
314                 int ret);
315 bool pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task);
316 void pnfs_set_layoutcommit(struct inode *, struct pnfs_layout_segment *, loff_t);
317 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
318 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
319 int pnfs_generic_sync(struct inode *inode, bool datasync);
320 int pnfs_nfs_generic_sync(struct inode *inode, bool datasync);
321 int _pnfs_return_layout(struct inode *);
322 int pnfs_commit_and_return_layout(struct inode *);
323 void pnfs_ld_write_done(struct nfs_pgio_header *);
324 void pnfs_ld_read_done(struct nfs_pgio_header *);
325 void pnfs_read_resend_pnfs(struct nfs_pgio_header *, unsigned int mirror_idx);
326 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
327                                                struct nfs_open_context *ctx,
328                                                loff_t pos,
329                                                u64 count,
330                                                enum pnfs_iomode iomode,
331                                                bool strict_iomode,
332                                                gfp_t gfp_flags);
333 void pnfs_layoutreturn_retry_later(struct pnfs_layout_hdr *lo,
334                                    const nfs4_stateid *arg_stateid,
335                                    const struct pnfs_layout_range *range);
336 void pnfs_layoutreturn_free_lsegs(struct pnfs_layout_hdr *lo,
337                 const nfs4_stateid *arg_stateid,
338                 const struct pnfs_layout_range *range,
339                 const nfs4_stateid *stateid);
340
341 void pnfs_generic_layout_insert_lseg(struct pnfs_layout_hdr *lo,
342                    struct pnfs_layout_segment *lseg,
343                    bool (*is_after)(const struct pnfs_layout_range *lseg_range,
344                            const struct pnfs_layout_range *old),
345                    bool (*do_merge)(struct pnfs_layout_segment *lseg,
346                            struct pnfs_layout_segment *old),
347                    struct list_head *free_me);
348
349 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
350 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
351 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
352 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
353 void pnfs_error_mark_layout_for_return(struct inode *inode,
354                                        struct pnfs_layout_segment *lseg);
355 void pnfs_layout_return_unused_byclid(struct nfs_client *clp,
356                                       enum pnfs_iomode iomode);
357 int pnfs_layout_handle_reboot(struct nfs_client *clp);
358
359 /* nfs4_deviceid_flags */
360 enum {
361         NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
362         NFS_DEVICEID_UNAVAILABLE,       /* device temporarily unavailable */
363         NFS_DEVICEID_NOCACHE,           /* device may not be cached */
364 };
365
366 /* pnfs_dev.c */
367 struct nfs4_deviceid_node {
368         struct hlist_node               node;
369         struct hlist_node               tmpnode;
370         const struct pnfs_layoutdriver_type *ld;
371         const struct nfs_client         *nfs_client;
372         unsigned long                   flags;
373         unsigned long                   timestamp_unavailable;
374         struct nfs4_deviceid            deviceid;
375         struct rcu_head                 rcu;
376         atomic_t                        ref;
377 };
378
379 struct nfs4_deviceid_node *
380 nfs4_find_get_deviceid(struct nfs_server *server,
381                 const struct nfs4_deviceid *id, const struct cred *cred,
382                 gfp_t gfp_mask);
383 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
384 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
385                              const struct nfs4_deviceid *);
386 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
387 void nfs4_mark_deviceid_available(struct nfs4_deviceid_node *node);
388 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
389 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
390 void nfs4_deviceid_purge_client(const struct nfs_client *);
391
392 /* pnfs_nfs.c */
393 struct pnfs_commit_array *pnfs_alloc_commit_array(size_t n, gfp_t gfp_flags);
394 void pnfs_free_commit_array(struct pnfs_commit_array *p);
395 struct pnfs_commit_array *pnfs_add_commit_array(struct pnfs_ds_commit_info *,
396                                                 struct pnfs_commit_array *,
397                                                 struct pnfs_layout_segment *);
398
399 void pnfs_generic_ds_cinfo_release_lseg(struct pnfs_ds_commit_info *fl_cinfo,
400                 struct pnfs_layout_segment *lseg);
401 void pnfs_generic_ds_cinfo_destroy(struct pnfs_ds_commit_info *fl_cinfo);
402
403 void pnfs_generic_clear_request_commit(struct nfs_page *req,
404                                        struct nfs_commit_info *cinfo);
405 void pnfs_generic_commit_release(void *calldata);
406 void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
407 void pnfs_generic_rw_release(void *data);
408 void pnfs_generic_recover_commit_reqs(struct list_head *dst,
409                                       struct nfs_commit_info *cinfo);
410 int pnfs_generic_commit_pagelist(struct inode *inode,
411                                  struct list_head *mds_pages,
412                                  int how,
413                                  struct nfs_commit_info *cinfo,
414                                  int (*initiate_commit)(struct nfs_commit_data *data,
415                                                         int how));
416 int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
417 void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
418 void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
419 struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(const struct net *net,
420                                       struct list_head *dsaddrs,
421                                       gfp_t gfp_flags);
422 void nfs4_pnfs_v3_ds_connect_unload(void);
423 int nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
424                           struct nfs4_deviceid_node *devid, unsigned int timeo,
425                           unsigned int retrans, u32 version, u32 minor_version);
426 struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
427                                                  struct xdr_stream *xdr,
428                                                  gfp_t gfp_flags);
429 void pnfs_layout_mark_request_commit(struct nfs_page *req,
430                                      struct pnfs_layout_segment *lseg,
431                                      struct nfs_commit_info *cinfo,
432                                      u32 ds_commit_idx);
433 void pnfs_lgopen_prepare(struct nfs4_opendata *data,
434                          struct nfs_open_context *ctx);
435 void pnfs_parse_lgopen(struct inode *ino, struct nfs4_layoutget *lgp,
436                        struct nfs_open_context *ctx);
437 void nfs4_lgopen_release(struct nfs4_layoutget *lgp);
438
439 static inline bool nfs_have_layout(struct inode *inode)
440 {
441         return NFS_I(inode)->layout != NULL;
442 }
443
444 static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
445 {
446         return test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags) == 0;
447 }
448
449 static inline struct nfs4_deviceid_node *
450 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
451 {
452         atomic_inc(&d->ref);
453         return d;
454 }
455
456 static inline struct pnfs_layout_segment *
457 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
458 {
459         if (lseg) {
460                 refcount_inc(&lseg->pls_refcount);
461                 smp_mb__after_atomic();
462         }
463         return lseg;
464 }
465
466 static inline bool
467 pnfs_is_valid_lseg(struct pnfs_layout_segment *lseg)
468 {
469         return test_bit(NFS_LSEG_VALID, &lseg->pls_flags) != 0;
470 }
471
472 /* Return true if a layout driver is being used for this mountpoint */
473 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
474 {
475         return nfss->pnfs_curr_ld != NULL;
476 }
477
478 static inline int
479 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
480                  struct nfs_commit_info *cinfo)
481 {
482         struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
483
484         if (fl_cinfo == NULL || fl_cinfo->ncommitting == 0)
485                 return PNFS_NOT_ATTEMPTED;
486         return fl_cinfo->ops->commit_pagelist(inode, mds_pages, how, cinfo);
487 }
488
489 static inline struct pnfs_ds_commit_info *
490 pnfs_get_ds_info(struct inode *inode)
491 {
492         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
493
494         if (ld == NULL || ld->get_ds_info == NULL)
495                 return NULL;
496         return ld->get_ds_info(inode);
497 }
498
499 static inline void
500 pnfs_init_ds_commit_info_ops(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
501 {
502         struct pnfs_ds_commit_info *inode_cinfo = pnfs_get_ds_info(inode);
503         if (inode_cinfo != NULL)
504                 fl_cinfo->ops = inode_cinfo->ops;
505 }
506
507 static inline void
508 pnfs_init_ds_commit_info(struct pnfs_ds_commit_info *fl_cinfo)
509 {
510         INIT_LIST_HEAD(&fl_cinfo->commits);
511         fl_cinfo->ops = NULL;
512 }
513
514 static inline void
515 pnfs_release_ds_info(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
516 {
517         if (fl_cinfo->ops != NULL && fl_cinfo->ops->release_ds_info != NULL)
518                 fl_cinfo->ops->release_ds_info(fl_cinfo, inode);
519 }
520
521 static inline void
522 pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
523 {
524         set_bit(NFS_DEVICEID_INVALID, &node->flags);
525 }
526
527 static inline bool
528 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
529                          struct nfs_commit_info *cinfo, u32 ds_commit_idx)
530 {
531         struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
532
533         if (!lseg || !fl_cinfo->ops || !fl_cinfo->ops->mark_request_commit)
534                 return false;
535         fl_cinfo->ops->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
536         return true;
537 }
538
539 static inline bool
540 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
541 {
542         struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
543
544         if (!fl_cinfo || !fl_cinfo->ops || !fl_cinfo->ops->clear_request_commit)
545                 return false;
546         fl_cinfo->ops->clear_request_commit(req, cinfo);
547         return true;
548 }
549
550 static inline int
551 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
552                        int max)
553 {
554         struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
555
556         if (!fl_cinfo || fl_cinfo->nwritten == 0)
557                 return 0;
558         return fl_cinfo->ops->scan_commit_lists(cinfo, max);
559 }
560
561 static inline void
562 pnfs_recover_commit_reqs(struct list_head *head, struct nfs_commit_info *cinfo)
563 {
564         struct pnfs_ds_commit_info *fl_cinfo = cinfo->ds;
565
566         if (fl_cinfo && fl_cinfo->nwritten != 0)
567                 fl_cinfo->ops->recover_commit_reqs(head, cinfo);
568 }
569
570 /* Should the pNFS client commit and return the layout upon a setattr */
571 static inline bool
572 pnfs_ld_layoutret_on_setattr(struct inode *inode)
573 {
574         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
575                 return false;
576         return NFS_SERVER(inode)->pnfs_curr_ld->flags &
577                 PNFS_LAYOUTRET_ON_SETATTR;
578 }
579
580 static inline bool
581 pnfs_ld_read_whole_page(struct inode *inode)
582 {
583         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
584                 return false;
585         return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
586 }
587
588 static inline int
589 pnfs_sync_inode(struct inode *inode, bool datasync)
590 {
591         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
592                 return 0;
593         return NFS_SERVER(inode)->pnfs_curr_ld->sync(inode, datasync);
594 }
595
596 static inline bool
597 pnfs_layoutcommit_outstanding(struct inode *inode)
598 {
599         struct nfs_inode *nfsi = NFS_I(inode);
600
601         return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
602                 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
603 }
604
605 static inline int pnfs_return_layout(struct inode *ino)
606 {
607         struct nfs_inode *nfsi = NFS_I(ino);
608         struct nfs_server *nfss = NFS_SERVER(ino);
609
610         if (pnfs_enabled_sb(nfss) && nfsi->layout) {
611                 set_bit(NFS_LAYOUT_RETURN_REQUESTED, &nfsi->layout->plh_flags);
612                 return _pnfs_return_layout(ino);
613         }
614
615         return 0;
616 }
617
618 static inline bool
619 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
620                    struct nfs_server *nfss)
621 {
622         return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
623                                         nfss->pnfs_curr_ld->id == src->l_type);
624 }
625
626 static inline u64
627 pnfs_calc_offset_end(u64 offset, u64 len)
628 {
629         if (len == NFS4_MAX_UINT64 || len >= NFS4_MAX_UINT64 - offset)
630                 return NFS4_MAX_UINT64;
631         return offset + len - 1;
632 }
633
634 static inline u64
635 pnfs_calc_offset_length(u64 offset, u64 end)
636 {
637         if (end == NFS4_MAX_UINT64 || end <= offset)
638                 return NFS4_MAX_UINT64;
639         return 1 + end - offset;
640 }
641
642 static inline void
643 pnfs_copy_range(struct pnfs_layout_range *dst,
644                 const struct pnfs_layout_range *src)
645 {
646         memcpy(dst, src, sizeof(*dst));
647 }
648
649 static inline u64
650 pnfs_end_offset(u64 start, u64 len)
651 {
652         if (NFS4_MAX_UINT64 - start <= len)
653                 return NFS4_MAX_UINT64;
654         return start + len;
655 }
656
657 /*
658  * Are 2 ranges intersecting?
659  *   start1                             end1
660  *   [----------------------------------)
661  *                                start2           end2
662  *                                [----------------)
663  */
664 static inline bool
665 pnfs_is_range_intersecting(u64 start1, u64 end1, u64 start2, u64 end2)
666 {
667         return (end1 == NFS4_MAX_UINT64 || start2 < end1) &&
668                 (end2 == NFS4_MAX_UINT64 || start1 < end2);
669 }
670
671 static inline bool
672 pnfs_lseg_range_intersecting(const struct pnfs_layout_range *l1,
673                 const struct pnfs_layout_range *l2)
674 {
675         u64 end1 = pnfs_end_offset(l1->offset, l1->length);
676         u64 end2 = pnfs_end_offset(l2->offset, l2->length);
677
678         return pnfs_is_range_intersecting(l1->offset, end1, l2->offset, end2);
679 }
680
681 static inline bool
682 pnfs_lseg_request_intersecting(struct pnfs_layout_segment *lseg, struct nfs_page *req)
683 {
684         u64 seg_last = pnfs_end_offset(lseg->pls_range.offset, lseg->pls_range.length);
685         u64 req_last = req_offset(req) + req->wb_bytes;
686
687         return pnfs_is_range_intersecting(lseg->pls_range.offset, seg_last,
688                                 req_offset(req), req_last);
689 }
690
691 static inline void pnfs_lseg_cancel_io(struct nfs_server *server,
692                                        struct pnfs_layout_segment *lseg)
693 {
694         if (server->pnfs_curr_ld->cancel_io)
695                 server->pnfs_curr_ld->cancel_io(lseg);
696 }
697
698 extern unsigned int layoutstats_timer;
699
700 #ifdef NFS_DEBUG
701 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
702 #else
703 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
704 {
705 }
706
707 #endif /* NFS_DEBUG */
708 #else  /* CONFIG_NFS_V4_1 */
709
710 static inline bool nfs_have_layout(struct inode *inode)
711 {
712         return false;
713 }
714
715 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
716 {
717 }
718
719 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
720 {
721 }
722
723 static inline void pnfs_destroy_layout_final(struct nfs_inode *nfsi)
724 {
725 }
726
727 static inline int pnfs_layout_handle_reboot(struct nfs_client *clp)
728 {
729         return 0;
730 }
731
732 static inline struct pnfs_layout_segment *
733 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
734 {
735         return NULL;
736 }
737
738 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
739 {
740 }
741
742 static inline int pnfs_return_layout(struct inode *ino)
743 {
744         return 0;
745 }
746
747 static inline int pnfs_commit_and_return_layout(struct inode *inode)
748 {
749         return 0;
750 }
751
752 static inline bool
753 pnfs_ld_layoutret_on_setattr(struct inode *inode)
754 {
755         return false;
756 }
757
758 static inline bool
759 pnfs_ld_read_whole_page(struct inode *inode)
760 {
761         return false;
762 }
763
764 static inline int
765 pnfs_sync_inode(struct inode *inode, bool datasync)
766 {
767         return 0;
768 }
769
770 static inline bool
771 pnfs_layoutcommit_outstanding(struct inode *inode)
772 {
773         return false;
774 }
775
776
777 static inline bool
778 pnfs_roc(struct inode *ino,
779                 struct nfs4_layoutreturn_args *args,
780                 struct nfs4_layoutreturn_res *res,
781                 const struct cred *cred)
782 {
783         return false;
784 }
785
786 static inline int
787 pnfs_roc_done(struct rpc_task *task,
788                 struct nfs4_layoutreturn_args **argpp,
789                 struct nfs4_layoutreturn_res **respp,
790                 int *ret)
791 {
792         return 0;
793 }
794
795 static inline void
796 pnfs_roc_release(struct nfs4_layoutreturn_args *args,
797                 struct nfs4_layoutreturn_res *res,
798                 int ret)
799 {
800 }
801
802 static inline bool
803 pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task)
804 {
805         return false;
806 }
807
808 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
809                                          const struct nfs_fh *mntfh,
810                                          struct nfs_fsinfo *fsinfo)
811 {
812 }
813
814 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
815 {
816 }
817
818 static inline int
819 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
820                  struct nfs_commit_info *cinfo)
821 {
822         return PNFS_NOT_ATTEMPTED;
823 }
824
825 static inline struct pnfs_ds_commit_info *
826 pnfs_get_ds_info(struct inode *inode)
827 {
828         return NULL;
829 }
830
831 static inline void
832 pnfs_init_ds_commit_info_ops(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
833 {
834 }
835
836 static inline void
837 pnfs_init_ds_commit_info(struct pnfs_ds_commit_info *fl_cinfo)
838 {
839 }
840
841 static inline void
842 pnfs_release_ds_info(struct pnfs_ds_commit_info *fl_cinfo, struct inode *inode)
843 {
844 }
845
846 static inline bool
847 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
848                          struct nfs_commit_info *cinfo, u32 ds_commit_idx)
849 {
850         return false;
851 }
852
853 static inline bool
854 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
855 {
856         return false;
857 }
858
859 static inline int
860 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
861                        int max)
862 {
863         return 0;
864 }
865
866 static inline void
867 pnfs_recover_commit_reqs(struct list_head *head, struct nfs_commit_info *cinfo)
868 {
869 }
870
871 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
872 {
873         return 0;
874 }
875
876 static inline bool
877 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
878                    struct nfs_server *nfss)
879 {
880         return false;
881 }
882
883 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
884 {
885         return NULL;
886 }
887
888 static inline void nfs4_pnfs_v3_ds_connect_unload(void)
889 {
890 }
891
892 static inline bool nfs4_layout_refresh_old_stateid(nfs4_stateid *dst,
893                 struct pnfs_layout_range *dst_range,
894                 struct inode *inode)
895 {
896         return false;
897 }
898
899 static inline void pnfs_lgopen_prepare(struct nfs4_opendata *data,
900                 struct nfs_open_context *ctx)
901 {
902 }
903
904 static inline void pnfs_parse_lgopen(struct inode *ino,
905                 struct nfs4_layoutget *lgp,
906                 struct nfs_open_context *ctx)
907 {
908 }
909
910 static inline void nfs4_lgopen_release(struct nfs4_layoutget *lgp)
911 {
912 }
913
914 static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
915 {
916         return false;
917 }
918
919 #endif /* CONFIG_NFS_V4_1 */
920
921 #if IS_ENABLED(CONFIG_NFS_V4_2)
922 int pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags);
923 #else
924 static inline int
925 pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags)
926 {
927         return 0;
928 }
929 #endif
930
931 #endif /* FS_NFS_PNFS_H */