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