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