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