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