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 };
  42
  43 struct pnfs_layout_segment {
  44         struct list_head pls_list;
  45         struct list_head pls_lc_list;
  46         struct pnfs_layout_range pls_range;
  47         atomic_t pls_refcount;
  48         unsigned long pls_flags;
  49         struct pnfs_layout_hdr *pls_layout;
  50         struct work_struct pls_work;
  51 };
  52
  53 enum pnfs_try_status {
  54         PNFS_ATTEMPTED     = 0,
  55         PNFS_NOT_ATTEMPTED = 1,
  56 };
  57
  58 #ifdef CONFIG_NFS_V4_1
  59
  60 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
  61
  62 enum {
  63         NFS_LAYOUT_RO_FAILED = 0,       /* get ro layout failed stop trying */
  64         NFS_LAYOUT_RW_FAILED,           /* get rw layout failed stop trying */
  65         NFS_LAYOUT_BULK_RECALL,         /* bulk recall affecting layout */
  66         NFS_LAYOUT_ROC,                 /* some lseg had roc bit set */
  67         NFS_LAYOUT_RETURN,              /* Return this layout ASAP */
  68 };
  69
  70 enum layoutdriver_policy_flags {
  71         /* Should the pNFS client commit and return the layout upon a setattr */
  72         PNFS_LAYOUTRET_ON_SETATTR       = 1 << 0,
  73         PNFS_LAYOUTRET_ON_ERROR         = 1 << 1,
  74 };
  75
  76 struct nfs4_deviceid_node;
  77
  78 /* Per-layout driver specific registration structure */
  79 struct pnfs_layoutdriver_type {
  80         struct list_head pnfs_tblid;
  81         const u32 id;
  82         const char *name;
  83         struct module *owner;
  84         unsigned flags;
  85
  86         int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
  87         int (*clear_layoutdriver) (struct nfs_server *);
  88
  89         struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
  90         void (*free_layout_hdr) (struct pnfs_layout_hdr *);
  91
  92         struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
  93         void (*free_lseg) (struct pnfs_layout_segment *lseg);
  94
  95         /* test for nfs page cache coalescing */
  96         const struct nfs_pageio_ops *pg_read_ops;
  97         const struct nfs_pageio_ops *pg_write_ops;
  98
  99         struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
 100         void (*mark_request_commit) (struct nfs_page *req,
 101                                      struct pnfs_layout_segment *lseg,
 102                                      struct nfs_commit_info *cinfo);
 103         void (*clear_request_commit) (struct nfs_page *req,
 104                                       struct nfs_commit_info *cinfo);
 105         int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
 106                                   int max);
 107         void (*recover_commit_reqs) (struct list_head *list,
 108                                      struct nfs_commit_info *cinfo);
 109         struct nfs_page * (*search_commit_reqs)(struct nfs_commit_info *cinfo,
 110                                                 struct page *page);
 111         int (*commit_pagelist)(struct inode *inode,
 112                                struct list_head *mds_pages,
 113                                int how,
 114                                struct nfs_commit_info *cinfo);
 115
 116         /*
 117          * Return PNFS_ATTEMPTED to indicate the layout code has attempted
 118          * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
 119          */
 120         enum pnfs_try_status (*read_pagelist)(struct nfs_pgio_header *);
 121         enum pnfs_try_status (*write_pagelist)(struct nfs_pgio_header *, int);
 122
 123         void (*free_deviceid_node) (struct nfs4_deviceid_node *);
 124
 125         void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
 126                                      struct xdr_stream *xdr,
 127                                      const struct nfs4_layoutreturn_args *args);
 128
 129         void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
 130
 131         void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
 132                                      struct xdr_stream *xdr,
 133                                      const struct nfs4_layoutcommit_args *args);
 134 };
 135
 136 struct pnfs_layout_hdr {
 137         atomic_t                plh_refcount;
 138         struct list_head        plh_layouts;   /* other client layouts */
 139         struct list_head        plh_bulk_destroy;
 140         struct list_head        plh_segs;      /* layout segments list */
 141         nfs4_stateid            plh_stateid;
 142         atomic_t                plh_outstanding; /* number of RPCs out */
 143         unsigned long           plh_block_lgets; /* block LAYOUTGET if >0 */
 144         u32                     plh_barrier; /* ignore lower seqids */
 145         unsigned long           plh_retry_timestamp;
 146         unsigned long           plh_flags;
 147         loff_t                  plh_lwb; /* last write byte for layoutcommit */
 148         struct rpc_cred         *plh_lc_cred; /* layoutcommit cred */
 149         struct inode            *plh_inode;
 150 };
 151
 152 struct pnfs_device {
 153         struct nfs4_deviceid dev_id;
 154         unsigned int  layout_type;
 155         unsigned int  mincount;
 156         unsigned int  maxcount; /* gdia_maxcount */
 157         struct page **pages;
 158         unsigned int  pgbase;
 159         unsigned int  pglen;    /* reply buffer length */
 160 };
 161
 162 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
 163
 164 struct pnfs_devicelist {
 165         unsigned int            eof;
 166         unsigned int            num_devs;
 167         struct nfs4_deviceid    dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
 168 };
 169
 170 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
 171 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
 172
 173 /* nfs4proc.c */
 174 extern int nfs4_proc_getdevicelist(struct nfs_server *server,
 175                                    const struct nfs_fh *fh,
 176                                    struct pnfs_devicelist *devlist);
 177 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
 178                                    struct pnfs_device *dev,
 179                                    struct rpc_cred *cred);
 180 extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
 181 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
 182
 183 /* pnfs.c */
 184 void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
 185 void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
 186 void pnfs_put_lseg_async(struct pnfs_layout_segment *lseg);
 187
 188 void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
 189 void unset_pnfs_layoutdriver(struct nfs_server *);
 190 void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
 191 int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
 192 void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
 193                                 struct nfs_page *req, u64 wb_size);
 194 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
 195 size_t pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio,
 196                             struct nfs_page *prev, struct nfs_page *req);
 197 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
 198 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
 199 void pnfs_free_lseg_list(struct list_head *tmp_list);
 200 void pnfs_destroy_layout(struct nfs_inode *);
 201 void pnfs_destroy_all_layouts(struct nfs_client *);
 202 int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
 203                 struct nfs_fsid *fsid,
 204                 bool is_recall);
 205 int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
 206                 bool is_recall);
 207 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
 208 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
 209                              const nfs4_stateid *new,
 210                              bool update_barrier);
 211 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
 212                                   struct pnfs_layout_hdr *lo,
 213                                   struct nfs4_state *open_state);
 214 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
 215                                 struct list_head *tmp_list,
 216                                 struct pnfs_layout_range *recall_range);
 217 bool pnfs_roc(struct inode *ino);
 218 void pnfs_roc_release(struct inode *ino);
 219 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
 220 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
 221 void pnfs_set_layoutcommit(struct nfs_pgio_header *);
 222 void pnfs_commit_set_layoutcommit(struct nfs_commit_data *data);
 223 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
 224 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
 225 int _pnfs_return_layout(struct inode *);
 226 int pnfs_commit_and_return_layout(struct inode *);
 227 void pnfs_ld_write_done(struct nfs_pgio_header *);
 228 void pnfs_ld_read_done(struct nfs_pgio_header *);
 229 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
 230                                                struct nfs_open_context *ctx,
 231                                                loff_t pos,
 232                                                u64 count,
 233                                                enum pnfs_iomode iomode,
 234                                                gfp_t gfp_flags);
 235
 236 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
 237 int pnfs_read_done_resend_to_mds(struct nfs_pgio_header *);
 238 int pnfs_write_done_resend_to_mds(struct nfs_pgio_header *);
 239 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
 240
 241 /* nfs4_deviceid_flags */
 242 enum {
 243         NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
 244         NFS_DEVICEID_UNAVAILABLE,       /* device temporarily unavailable */
 245 };
 246
 247 /* pnfs_dev.c */
 248 struct nfs4_deviceid_node {
 249         struct hlist_node               node;
 250         struct hlist_node               tmpnode;
 251         const struct pnfs_layoutdriver_type *ld;
 252         const struct nfs_client         *nfs_client;
 253         unsigned long                   flags;
 254         unsigned long                   timestamp_unavailable;
 255         struct nfs4_deviceid            deviceid;
 256         atomic_t                        ref;
 257 };
 258
 259 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 260 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 261 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
 262                              const struct pnfs_layoutdriver_type *,
 263                              const struct nfs_client *,
 264                              const struct nfs4_deviceid *);
 265 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
 266 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
 267 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
 268 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
 269 void nfs4_deviceid_purge_client(const struct nfs_client *);
 270
 271 static inline struct pnfs_layout_segment *
 272 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
 273 {
 274         if (lseg) {
 275                 atomic_inc(&lseg->pls_refcount);
 276                 smp_mb__after_atomic();
 277         }
 278         return lseg;
 279 }
 280
 281 /* Return true if a layout driver is being used for this mountpoint */
 282 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
 283 {
 284         return nfss->pnfs_curr_ld != NULL;
 285 }
 286
 287 static inline int
 288 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 289                  struct nfs_commit_info *cinfo)
 290 {
 291         if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
 292                 return PNFS_NOT_ATTEMPTED;
 293         return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
 294 }
 295
 296 static inline struct pnfs_ds_commit_info *
 297 pnfs_get_ds_info(struct inode *inode)
 298 {
 299         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 300
 301         if (ld == NULL || ld->get_ds_info == NULL)
 302                 return NULL;
 303         return ld->get_ds_info(inode);
 304 }
 305
 306 static inline bool
 307 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 308                          struct nfs_commit_info *cinfo)
 309 {
 310         struct inode *inode = req->wb_context->dentry->d_inode;
 311         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 312
 313         if (lseg == NULL || ld->mark_request_commit == NULL)
 314                 return false;
 315         ld->mark_request_commit(req, lseg, cinfo);
 316         return true;
 317 }
 318
 319 static inline bool
 320 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 321 {
 322         struct inode *inode = req->wb_context->dentry->d_inode;
 323         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 324
 325         if (ld == NULL || ld->clear_request_commit == NULL)
 326                 return false;
 327         ld->clear_request_commit(req, cinfo);
 328         return true;
 329 }
 330
 331 static inline int
 332 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 333                        int max)
 334 {
 335         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
 336                 return 0;
 337         else
 338                 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
 339 }
 340
 341 static inline void
 342 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
 343                          struct nfs_commit_info *cinfo)
 344 {
 345         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
 346                 return;
 347         NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
 348 }
 349
 350 static inline struct nfs_page *
 351 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
 352                         struct page *page)
 353 {
 354         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 355
 356         if (ld == NULL || ld->search_commit_reqs == NULL)
 357                 return NULL;
 358         return ld->search_commit_reqs(cinfo, page);
 359 }
 360
 361 /* Should the pNFS client commit and return the layout upon a setattr */
 362 static inline bool
 363 pnfs_ld_layoutret_on_setattr(struct inode *inode)
 364 {
 365         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
 366                 return false;
 367         return NFS_SERVER(inode)->pnfs_curr_ld->flags &
 368                 PNFS_LAYOUTRET_ON_SETATTR;
 369 }
 370
 371 static inline bool
 372 pnfs_layoutcommit_outstanding(struct inode *inode)
 373 {
 374         struct nfs_inode *nfsi = NFS_I(inode);
 375
 376         return test_bit(NFS_INO_LAYOUTCOMMIT, &nfsi->flags) != 0 ||
 377                 test_bit(NFS_INO_LAYOUTCOMMITTING, &nfsi->flags) != 0;
 378 }
 379
 380 static inline int pnfs_return_layout(struct inode *ino)
 381 {
 382         struct nfs_inode *nfsi = NFS_I(ino);
 383         struct nfs_server *nfss = NFS_SERVER(ino);
 384
 385         if (pnfs_enabled_sb(nfss) && nfsi->layout)
 386                 return _pnfs_return_layout(ino);
 387
 388         return 0;
 389 }
 390
 391 static inline bool
 392 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
 393                    struct nfs_server *nfss)
 394 {
 395         return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
 396                                         nfss->pnfs_curr_ld->id == src->l_type);
 397 }
 398
 399 #ifdef NFS_DEBUG
 400 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
 401 #else
 402 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
 403 {
 404 }
 405 #endif /* NFS_DEBUG */
 406 #else  /* CONFIG_NFS_V4_1 */
 407
 408 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
 409 {
 410 }
 411
 412 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
 413 {
 414 }
 415
 416 static inline struct pnfs_layout_segment *
 417 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
 418 {
 419         return NULL;
 420 }
 421
 422 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
 423 {
 424 }
 425
 426 static inline void pnfs_put_lseg_async(struct pnfs_layout_segment *lseg)
 427 {
 428 }
 429
 430 static inline int pnfs_return_layout(struct inode *ino)
 431 {
 432         return 0;
 433 }
 434
 435 static inline int pnfs_commit_and_return_layout(struct inode *inode)
 436 {
 437         return 0;
 438 }
 439
 440 static inline bool
 441 pnfs_ld_layoutret_on_setattr(struct inode *inode)
 442 {
 443         return false;
 444 }
 445
 446 static inline bool
 447 pnfs_roc(struct inode *ino)
 448 {
 449         return false;
 450 }
 451
 452 static inline void
 453 pnfs_roc_release(struct inode *ino)
 454 {
 455 }
 456
 457 static inline void
 458 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
 459 {
 460 }
 461
 462 static inline bool
 463 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
 464 {
 465         return false;
 466 }
 467
 468 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
 469                                          const struct nfs_fh *mntfh, u32 id)
 470 {
 471 }
 472
 473 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
 474 {
 475 }
 476
 477 static inline int
 478 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 479                  struct nfs_commit_info *cinfo)
 480 {
 481         return PNFS_NOT_ATTEMPTED;
 482 }
 483
 484 static inline struct pnfs_ds_commit_info *
 485 pnfs_get_ds_info(struct inode *inode)
 486 {
 487         return NULL;
 488 }
 489
 490 static inline bool
 491 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 492                          struct nfs_commit_info *cinfo)
 493 {
 494         return false;
 495 }
 496
 497 static inline bool
 498 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 499 {
 500         return false;
 501 }
 502
 503 static inline int
 504 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 505                        int max)
 506 {
 507         return 0;
 508 }
 509
 510 static inline void
 511 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
 512                          struct nfs_commit_info *cinfo)
 513 {
 514 }
 515
 516 static inline struct nfs_page *
 517 pnfs_search_commit_reqs(struct inode *inode, struct nfs_commit_info *cinfo,
 518                         struct page *page)
 519 {
 520         return NULL;
 521 }
 522
 523 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
 524 {
 525         return 0;
 526 }
 527
 528 static inline bool
 529 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
 530                    struct nfs_server *nfss)
 531 {
 532         return false;
 533 }
 534
 535 static inline bool
 536 pnfs_layoutcommit_outstanding(struct inode *inode)
 537 {
 538         return false;
 539 }
 540
 541
 542 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
 543 {
 544         return NULL;
 545 }
 546
 547 #endif /* CONFIG_NFS_V4_1 */
 548
 549 #endif /* FS_NFS_PNFS_H */