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