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