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