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         NFS_LSEG_LAYOUTRETURN,  /* layoutreturn bit set for layoutreturn */
  42 };
  43
  44 /* Individual ip address */
  45 struct nfs4_pnfs_ds_addr {
  46         struct sockaddr_storage da_addr;
  47         size_t                  da_addrlen;
  48         struct list_head        da_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
  49         char                    *da_remotestr;  /* human readable addr+port */
  50 };
  51
  52 struct nfs4_pnfs_ds {
  53         struct list_head        ds_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
  54         char                    *ds_remotestr;  /* comma sep list of addrs */
  55         struct list_head        ds_addrs;
  56         struct nfs_client       *ds_clp;
  57         atomic_t                ds_count;
  58         unsigned long           ds_state;
  59 #define NFS4DS_CONNECTING       0       /* ds is establishing connection */
  60 };
  61
  62 struct pnfs_layout_segment {
  63         struct list_head pls_list;
  64         struct list_head pls_lc_list;
  65         struct pnfs_layout_range pls_range;
  66         atomic_t pls_refcount;
  67         u32 pls_seq;
  68         unsigned long pls_flags;
  69         struct pnfs_layout_hdr *pls_layout;
  70 };
  71
  72 enum pnfs_try_status {
  73         PNFS_ATTEMPTED     = 0,
  74         PNFS_NOT_ATTEMPTED = 1,
  75         PNFS_TRY_AGAIN     = 2,
  76 };
  77
  78 #ifdef CONFIG_NFS_V4_1
  79
  80 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
  81
  82 /*
  83  * Default data server connection timeout and retrans vaules.
  84  * Set by module parameters dataserver_timeo and dataserver_retrans.
  85  */
  86 #define NFS4_DEF_DS_TIMEO   600 /* in tenths of a second */
  87 #define NFS4_DEF_DS_RETRANS 5
  88
  89 /* error codes for internal use */
  90 #define NFS4ERR_RESET_TO_MDS   12001
  91 #define NFS4ERR_RESET_TO_PNFS  12002
  92
  93 enum {
  94         NFS_LAYOUT_RO_FAILED = 0,       /* get ro layout failed stop trying */
  95         NFS_LAYOUT_RW_FAILED,           /* get rw layout failed stop trying */
  96         NFS_LAYOUT_BULK_RECALL,         /* bulk recall affecting layout */
  97         NFS_LAYOUT_RETURN,              /* layoutreturn in progress */
  98         NFS_LAYOUT_RETURN_LOCK,         /* Serialise layoutreturn */
  99         NFS_LAYOUT_RETURN_REQUESTED,    /* Return this layout ASAP */
 100         NFS_LAYOUT_INVALID_STID,        /* layout stateid id is invalid */
 101         NFS_LAYOUT_FIRST_LAYOUTGET,     /* Serialize first layoutget */
 102 };
 103
 104 enum layoutdriver_policy_flags {
 105         /* Should the pNFS client commit and return the layout upon truncate to
 106          * a smaller size */
 107         PNFS_LAYOUTRET_ON_SETATTR       = 1 << 0,
 108         PNFS_LAYOUTRET_ON_ERROR         = 1 << 1,
 109         PNFS_READ_WHOLE_PAGE            = 1 << 2,
 110 };
 111
 112 struct nfs4_deviceid_node;
 113
 114 /* Per-layout driver specific registration structure */
 115 struct pnfs_layoutdriver_type {
 116         struct list_head pnfs_tblid;
 117         const u32 id;
 118         const char *name;
 119         struct module *owner;
 120         unsigned flags;
 121         unsigned max_deviceinfo_size;
 122
 123         int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
 124         int (*clear_layoutdriver) (struct nfs_server *);
 125
 126         struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
 127         void (*free_layout_hdr) (struct pnfs_layout_hdr *);
 128
 129         struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
 130         void (*free_lseg) (struct pnfs_layout_segment *lseg);
 131         void (*add_lseg) (struct pnfs_layout_hdr *layoutid,
 132                         struct pnfs_layout_segment *lseg,
 133                         struct list_head *free_me);
 134
 135         void (*return_range) (struct pnfs_layout_hdr *lo,
 136                               struct pnfs_layout_range *range);
 137
 138         /* test for nfs page cache coalescing */
 139         const struct nfs_pageio_ops *pg_read_ops;
 140         const struct nfs_pageio_ops *pg_write_ops;
 141
 142         struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
 143         void (*mark_request_commit) (struct nfs_page *req,
 144                                      struct pnfs_layout_segment *lseg,
 145                                      struct nfs_commit_info *cinfo,
 146                                      u32 ds_commit_idx);
 147         void (*clear_request_commit) (struct nfs_page *req,
 148                                       struct nfs_commit_info *cinfo);
 149         int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
 150                                   int max);
 151         void (*recover_commit_reqs) (struct list_head *list,
 152                                      struct nfs_commit_info *cinfo);
 153         struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
 154                                                 struct page *page);
 155         int (*commit_pagelist)(struct inode *inode,
 156                                struct list_head *mds_pages,
 157                                int how,
 158                                struct nfs_commit_info *cinfo);
 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
 181 struct pnfs_layout_hdr {
 182         atomic_t                plh_refcount;
 183         atomic_t                plh_outstanding; /* number of RPCs out */
 184         struct list_head        plh_layouts;   /* other client layouts */
 185         struct list_head        plh_bulk_destroy;
 186         struct list_head        plh_segs;      /* layout segments list */
 187         struct list_head        plh_return_segs; /* invalid layout segments */
 188         unsigned long           plh_block_lgets; /* block LAYOUTGET if >0 */
 189         unsigned long           plh_retry_timestamp;
 190         unsigned long           plh_flags;
 191         nfs4_stateid            plh_stateid;
 192         u32                     plh_barrier; /* ignore lower seqids */
 193         u32                     plh_return_seq;
 194         enum pnfs_iomode        plh_return_iomode;
 195         loff_t                  plh_lwb; /* last write byte for layoutcommit */
 196         struct rpc_cred         *plh_lc_cred; /* layoutcommit cred */
 197         struct inode            *plh_inode;
 198 };
 199
 200 struct pnfs_device {
 201         struct nfs4_deviceid dev_id;
 202         unsigned int  layout_type;
 203         unsigned int  mincount;
 204         unsigned int  maxcount; /* gdia_maxcount */
 205         struct page **pages;
 206         unsigned int  pgbase;
 207         unsigned int  pglen;    /* reply buffer length */
 208         unsigned char nocache : 1;/* May not be cached */
 209 };
 210
 211 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
 212
 213 struct pnfs_devicelist {
 214         unsigned int            eof;
 215         unsigned int            num_devs;
 216         struct nfs4_deviceid    dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
 217 };
 218
 219 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
 220 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
 221
 222 /* nfs4proc.c */
 223 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
 224                                    struct pnfs_device *dev,
 225                                    struct rpc_cred *cred);
 226 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, long *timeout, gfp_t gfp_flags);
 227 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp, bool sync);
 228
 229 /* pnfs.c */
 230 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
 231 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
 232
 233 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, struct nfs_fsinfo *);
 234 void unset_pnfs_layoutdriver(struct nfs_server *);
 235 void pnfs_generic_pg_check_layout(struct nfs_pageio_descriptor *pgio);
 236 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
 237 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
 238 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
 239                                 struct nfs_page *req, u64 wb_size);
 240 void pnfs_generic_pg_cleanup(struct nfs_pageio_descriptor *);
 241 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
 242 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
 243                             struct nfs_page *prev, struct nfs_page *req);
 244 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
 245 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
 246 void pnfs_free_lseg_list(struct list_head *tmp_list);
 247 void pnfs_destroy_layout(struct nfs_inode *);
 248 void pnfs_destroy_all_layouts(struct nfs_client *);
 249 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
 250                 struct nfs_fsid *fsid,
 251                 bool is_recall);
 252 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
 253                 bool is_recall);
 254 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
 255 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
 256                              const nfs4_stateid *new,
 257                              bool update_barrier);
 258 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
 259                                 struct list_head *tmp_list,
 260                                 const struct pnfs_layout_range *recall_range,
 261                                 u32 seq);
 262 int pnfs_mark_matching_lsegs_return(struct pnfs_layout_hdr *lo,
 263                                 struct list_head *tmp_list,
 264                                 const struct pnfs_layout_range *recall_range,
 265                                 u32 seq);
 266 int pnfs_mark_layout_stateid_invalid(struct pnfs_layout_hdr *lo,
 267                 struct list_head *lseg_list);
 268 bool pnfs_roc(struct inode *ino,
 269                 struct nfs4_layoutreturn_args *args,
 270                 struct nfs4_layoutreturn_res *res,
 271                 const struct rpc_cred *cred);
 272 void pnfs_roc_release(struct nfs4_layoutreturn_args *args,
 273                 struct nfs4_layoutreturn_res *res,
 274                 int ret);
 275 bool pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task);
 276 void pnfs_set_layoutcommit(struct inode *, struct pnfs_layout_segment *, loff_t);
 277 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
 278 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
 279 int pnfs_generic_sync(struct inode *inode, bool datasync);
 280 int pnfs_nfs_generic_sync(struct inode *inode, bool datasync);
 281 int _pnfs_return_layout(struct inode *);
 282 int pnfs_commit_and_return_layout(struct inode *);
 283 void pnfs_ld_write_done(struct nfs_pgio_header *);
 284 void pnfs_ld_read_done(struct nfs_pgio_header *);
 285 void pnfs_read_resend_pnfs(struct nfs_pgio_header *);
 286 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
 287                                                struct nfs_open_context *ctx,
 288                                                loff_t pos,
 289                                                u64 count,
 290                                                enum pnfs_iomode iomode,
 291                                                bool strict_iomode,
 292                                                gfp_t gfp_flags);
 293 void pnfs_layoutreturn_free_lsegs(struct pnfs_layout_hdr *lo,
 294                 const nfs4_stateid *arg_stateid,
 295                 const struct pnfs_layout_range *range,
 296                 const nfs4_stateid *stateid);
 297
 298 void pnfs_generic_layout_insert_lseg(struct pnfs_layout_hdr *lo,
 299                    struct pnfs_layout_segment *lseg,
 300                    bool (*is_after)(const struct pnfs_layout_range *lseg_range,
 301                            const struct pnfs_layout_range *old),
 302                    bool (*do_merge)(struct pnfs_layout_segment *lseg,
 303                            struct pnfs_layout_segment *old),
 304                    struct list_head *free_me);
 305
 306 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
 307 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
 308 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
 309 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
 310 void pnfs_error_mark_layout_for_return(struct inode *inode,
 311                                        struct pnfs_layout_segment *lseg);
 312 /* nfs4_deviceid_flags */
 313 enum {
 314         NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
 315         NFS_DEVICEID_UNAVAILABLE,       /* device temporarily unavailable */
 316         NFS_DEVICEID_NOCACHE,           /* device may not be cached */
 317 };
 318
 319 /* pnfs_dev.c */
 320 struct nfs4_deviceid_node {
 321         struct hlist_node               node;
 322         struct hlist_node               tmpnode;
 323         const struct pnfs_layoutdriver_type *ld;
 324         const struct nfs_client         *nfs_client;
 325         unsigned long                   flags;
 326         unsigned long                   timestamp_unavailable;
 327         struct nfs4_deviceid            deviceid;
 328         struct rcu_head                 rcu;
 329         atomic_t                        ref;
 330 };
 331
 332 struct nfs4_deviceid_node *
 333 nfs4_find_get_deviceid(struct nfs_server *server,
 334                 const struct nfs4_deviceid *id, struct rpc_cred *cred,
 335                 gfp_t gfp_mask);
 336 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 337 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *, struct nfs_server *,
 338                              const struct nfs4_deviceid *);
 339 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
 340 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
 341 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
 342 void nfs4_deviceid_purge_client(const struct nfs_client *);
 343
 344 /* pnfs_nfs.c */
 345 void pnfs_generic_clear_request_commit(struct nfs_page *req,
 346                                        struct nfs_commit_info *cinfo);
 347 void pnfs_generic_commit_release(void *calldata);
 348 void pnfs_generic_prepare_to_resend_writes(struct nfs_commit_data *data);
 349 void pnfs_generic_rw_release(void *data);
 350 void pnfs_generic_recover_commit_reqs(struct list_head *dst,
 351                                       struct nfs_commit_info *cinfo);
 352 int pnfs_generic_commit_pagelist(struct inode *inode,
 353                                  struct list_head *mds_pages,
 354                                  int how,
 355                                  struct nfs_commit_info *cinfo,
 356                                  int (*initiate_commit)(struct nfs_commit_data *data,
 357                                                         int how));
 358 int pnfs_generic_scan_commit_lists(struct nfs_commit_info *cinfo, int max);
 359 void pnfs_generic_write_commit_done(struct rpc_task *task, void *data);
 360 void nfs4_pnfs_ds_put(struct nfs4_pnfs_ds *ds);
 361 struct nfs4_pnfs_ds *nfs4_pnfs_ds_add(struct list_head *dsaddrs,
 362                                       gfp_t gfp_flags);
 363 void nfs4_pnfs_v3_ds_connect_unload(void);
 364 int nfs4_pnfs_ds_connect(struct nfs_server *mds_srv, struct nfs4_pnfs_ds *ds,
 365                           struct nfs4_deviceid_node *devid, unsigned int timeo,
 366                           unsigned int retrans, u32 version, u32 minor_version);
 367 struct nfs4_pnfs_ds_addr *nfs4_decode_mp_ds_addr(struct net *net,
 368                                                  struct xdr_stream *xdr,
 369                                                  gfp_t gfp_flags);
 370 void pnfs_layout_mark_request_commit(struct nfs_page *req,
 371                                      struct pnfs_layout_segment *lseg,
 372                                      struct nfs_commit_info *cinfo,
 373                                      u32 ds_commit_idx);
 374
 375 static inline bool nfs_have_layout(struct inode *inode)
 376 {
 377         return NFS_I(inode)->layout != NULL;
 378 }
 379
 380 static inline bool pnfs_layout_is_valid(const struct pnfs_layout_hdr *lo)
 381 {
 382         return test_bit(NFS_LAYOUT_INVALID_STID, &lo->plh_flags) == 0;
 383 }
 384
 385 static inline struct nfs4_deviceid_node *
 386 nfs4_get_deviceid(struct nfs4_deviceid_node *d)
 387 {
 388         atomic_inc(&d->ref);
 389         return d;
 390 }
 391
 392 static inline struct pnfs_layout_segment *
 393 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
 394 {
 395         if (lseg) {
 396                 atomic_inc(&lseg->pls_refcount);
 397                 smp_mb__after_atomic();
 398         }
 399         return lseg;
 400 }
 401
 402 static inline bool
 403 pnfs_is_valid_lseg(struct pnfs_layout_segment *lseg)
 404 {
 405         return test_bit(NFS_LSEG_VALID, &lseg->pls_flags) != 0;
 406 }
 407
 408 /* Return true if a layout driver is being used for this mountpoint */
 409 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
 410 {
 411         return nfss->pnfs_curr_ld != NULL;
 412 }
 413
 414 static inline int
 415 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 416                  struct nfs_commit_info *cinfo)
 417 {
 418         if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
 419                 return PNFS_NOT_ATTEMPTED;
 420         return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
 421 }
 422
 423 static inline struct pnfs_ds_commit_info *
 424 pnfs_get_ds_info(struct inode *inode)
 425 {
 426         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 427
 428         if (ld == NULL || ld->get_ds_info == NULL)
 429                 return NULL;
 430         return ld->get_ds_info(inode);
 431 }
 432
 433 static inline void
 434 pnfs_generic_mark_devid_invalid(struct nfs4_deviceid_node *node)
 435 {
 436         set_bit(NFS_DEVICEID_INVALID, &node->flags);
 437 }
 438
 439 static inline bool
 440 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 441                          struct nfs_commit_info *cinfo, u32 ds_commit_idx)
 442 {
 443         struct inode *inode = d_inode(req->wb_context->dentry);
 444         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 445
 446         if (lseg == NULL || ld->mark_request_commit == NULL)
 447                 return false;
 448         ld->mark_request_commit(req, lseg, cinfo, ds_commit_idx);
 449         return true;
 450 }
 451
 452 static inline bool
 453 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 454 {
 455         struct inode *inode = d_inode(req->wb_context->dentry);
 456         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 457
 458         if (ld == NULL || ld->clear_request_commit == NULL)
 459                 return false;
 460         ld->clear_request_commit(req, cinfo);
 461         return true;
 462 }
 463
 464 static inline int
 465 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 466                        int max)
 467 {
 468         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
 469                 return 0;
 470         else
 471                 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
 472 }
 473
 474 static inline struct nfs_page *
 475 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
 476                         struct page *page)
 477 {
 478         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 479
 480         if (ld == NULL || ld->search_commit_reqs == NULL)
 481                 return NULL;
 482         return ld->search_commit_reqs(cinfo, page);
 483 }
 484
 485 /* Should the pNFS client commit and return the layout upon a setattr */
 486 static inline bool
 487 pnfs_ld_layoutret_on_setattr(struct inode *inode)
 488 {
 489         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
 490                 return false;
 491         return NFS_SERVER(inode)->pnfs_curr_ld->flags &
 492                 PNFS_LAYOUTRET_ON_SETATTR;
 493 }
 494
 495 static inline bool
 496 pnfs_ld_read_whole_page(struct inode *inode)
 497 {
 498         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
 499                 return false;
 500         return NFS_SERVER(inode)->pnfs_curr_ld->flags & PNFS_READ_WHOLE_PAGE;
 501 }
 502
 503 static inline int
 504 pnfs_sync_inode(struct inode *inode, bool datasync)
 505 {
 506         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
 507                 return 0;
 508         return NFS_SERVER(inode)->pnfs_curr_ld->sync(inode, datasync);
 509 }
 510
 511 static inline bool
 512 pnfs_layoutcommit_outstanding(struct inode *inode)
 513 {
 514         struct nfs_inode *nfsi = NFS_I(inode);
 515
 516         return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
 517                 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
 518 }
 519
 520 static inline int pnfs_return_layout(struct inode *ino)
 521 {
 522         struct nfs_inode *nfsi = NFS_I(ino);
 523         struct nfs_server *nfss = NFS_SERVER(ino);
 524
 525         if (pnfs_enabled_sb(nfss) && nfsi->layout)
 526                 return _pnfs_return_layout(ino);
 527
 528         return 0;
 529 }
 530
 531 static inline bool
 532 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
 533                    struct nfs_server *nfss)
 534 {
 535         return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
 536                                         nfss->pnfs_curr_ld->id == src->l_type);
 537 }
 538
 539 static inline u64
 540 pnfs_calc_offset_end(u64 offset, u64 len)
 541 {
 542         if (len == NFS4_MAX_UINT64 || len >= NFS4_MAX_UINT64 - offset)
 543                 return NFS4_MAX_UINT64;
 544         return offset + len - 1;
 545 }
 546
 547 static inline u64
 548 pnfs_calc_offset_length(u64 offset, u64 end)
 549 {
 550         if (end == NFS4_MAX_UINT64 || end <= offset)
 551                 return NFS4_MAX_UINT64;
 552         return 1 + end - offset;
 553 }
 554
 555 static inline void
 556 pnfs_copy_range(struct pnfs_layout_range *dst,
 557                 const struct pnfs_layout_range *src)
 558 {
 559         memcpy(dst, src, sizeof(*dst));
 560 }
 561
 562 static inline u64
 563 pnfs_end_offset(u64 start, u64 len)
 564 {
 565         if (NFS4_MAX_UINT64 - start <= len)
 566                 return NFS4_MAX_UINT64;
 567         return start + len;
 568 }
 569
 570 /*
 571  * Are 2 ranges intersecting?
 572  *   start1                             end1
 573  *   [----------------------------------)
 574  *                                start2           end2
 575  *                                [----------------)
 576  */
 577 static inline bool
 578 pnfs_is_range_intersecting(u64 start1, u64 end1, u64 start2, u64 end2)
 579 {
 580         return (end1 == NFS4_MAX_UINT64 || start2 < end1) &&
 581                 (end2 == NFS4_MAX_UINT64 || start1 < end2);
 582 }
 583
 584 static inline bool
 585 pnfs_lseg_range_intersecting(const struct pnfs_layout_range *l1,
 586                 const struct pnfs_layout_range *l2)
 587 {
 588         u64 end1 = pnfs_end_offset(l1->offset, l1->length);
 589         u64 end2 = pnfs_end_offset(l2->offset, l2->length);
 590
 591         return pnfs_is_range_intersecting(l1->offset, end1, l2->offset, end2);
 592 }
 593
 594 static inline bool
 595 pnfs_lseg_request_intersecting(struct pnfs_layout_segment *lseg, struct nfs_page *req)
 596 {
 597         u64 seg_last = pnfs_end_offset(lseg->pls_range.offset, lseg->pls_range.length);
 598         u64 req_last = req_offset(req) + req->wb_bytes;
 599
 600         return pnfs_is_range_intersecting(lseg->pls_range.offset, seg_last,
 601                                 req_offset(req), req_last);
 602 }
 603
 604 extern unsigned int layoutstats_timer;
 605
 606 #ifdef NFS_DEBUG
 607 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
 608 #else
 609 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
 610 {
 611 }
 612
 613 #endif /* NFS_DEBUG */
 614 #else  /* CONFIG_NFS_V4_1 */
 615
 616 static inline bool nfs_have_layout(struct inode *inode)
 617 {
 618         return false;
 619 }
 620
 621 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
 622 {
 623 }
 624
 625 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
 626 {
 627 }
 628
 629 static inline struct pnfs_layout_segment *
 630 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
 631 {
 632         return NULL;
 633 }
 634
 635 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
 636 {
 637 }
 638
 639 static inline int pnfs_return_layout(struct inode *ino)
 640 {
 641         return 0;
 642 }
 643
 644 static inline int pnfs_commit_and_return_layout(struct inode *inode)
 645 {
 646         return 0;
 647 }
 648
 649 static inline bool
 650 pnfs_ld_layoutret_on_setattr(struct inode *inode)
 651 {
 652         return false;
 653 }
 654
 655 static inline bool
 656 pnfs_ld_read_whole_page(struct inode *inode)
 657 {
 658         return false;
 659 }
 660
 661 static inline int
 662 pnfs_sync_inode(struct inode *inode, bool datasync)
 663 {
 664         return 0;
 665 }
 666
 667 static inline bool
 668 pnfs_layoutcommit_outstanding(struct inode *inode)
 669 {
 670         return false;
 671 }
 672
 673
 674 static inline bool
 675 pnfs_roc(struct inode *ino,
 676                 struct nfs4_layoutreturn_args *args,
 677                 struct nfs4_layoutreturn_res *res,
 678                 const struct rpc_cred *cred)
 679 {
 680         return false;
 681 }
 682
 683 static inline void
 684 pnfs_roc_release(struct nfs4_layoutreturn_args *args,
 685                 struct nfs4_layoutreturn_res *res,
 686                 int ret)
 687 {
 688 }
 689
 690 static inline bool
 691 pnfs_wait_on_layoutreturn(struct inode *ino, struct rpc_task *task)
 692 {
 693         return false;
 694 }
 695
 696 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
 697                                          const struct nfs_fh *mntfh,
 698                                          struct nfs_fsinfo *fsinfo)
 699 {
 700 }
 701
 702 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
 703 {
 704 }
 705
 706 static inline int
 707 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 708                  struct nfs_commit_info *cinfo)
 709 {
 710         return PNFS_NOT_ATTEMPTED;
 711 }
 712
 713 static inline struct pnfs_ds_commit_info *
 714 pnfs_get_ds_info(struct inode *inode)
 715 {
 716         return NULL;
 717 }
 718
 719 static inline bool
 720 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 721                          struct nfs_commit_info *cinfo, u32 ds_commit_idx)
 722 {
 723         return false;
 724 }
 725
 726 static inline bool
 727 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 728 {
 729         return false;
 730 }
 731
 732 static inline int
 733 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 734                        int max)
 735 {
 736         return 0;
 737 }
 738
 739 static inline struct nfs_page *
 740 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
 741                         struct page *page)
 742 {
 743         return NULL;
 744 }
 745
 746 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
 747 {
 748         return 0;
 749 }
 750
 751 static inline bool
 752 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
 753                    struct nfs_server *nfss)
 754 {
 755         return false;
 756 }
 757
 758 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
 759 {
 760         return NULL;
 761 }
 762
 763 static inline void nfs4_pnfs_v3_ds_connect_unload(void)
 764 {
 765 }
 766
 767 #endif /* CONFIG_NFS_V4_1 */
 768
 769 #if IS_ENABLED(CONFIG_NFS_V4_2)
 770 int pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags);
 771 #else
 772 static inline int
 773 pnfs_report_layoutstat(struct inode *inode, gfp_t gfp_flags)
 774 {
 775         return 0;
 776 }
 777 #endif
 778
 779 #endif /* FS_NFS_PNFS_H */