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