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_DESTROYED,           /* no new use of layout allowed */
  66         NFS_LAYOUT_INVALID,             /* layout is being destroyed */
  67         NFS_LAYOUT_RETURNED,            /* layout has already been returned */
  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         int (*commit_pagelist)(struct inode *inode,
 110                                struct list_head *mds_pages,
 111                                int how,
 112                                struct nfs_commit_info *cinfo);
 113
 114         /*
 115          * Return PNFS_ATTEMPTED to indicate the layout code has attempted
 116          * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
 117          */
 118         enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
 119         enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
 120
 121         void (*free_deviceid_node) (struct nfs4_deviceid_node *);
 122
 123         void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
 124                                      struct xdr_stream *xdr,
 125                                      const struct nfs4_layoutreturn_args *args);
 126
 127         void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
 128
 129         void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
 130                                      struct xdr_stream *xdr,
 131                                      const struct nfs4_layoutcommit_args *args);
 132 };
 133
 134 struct pnfs_layout_hdr {
 135         atomic_t                plh_refcount;
 136         struct list_head        plh_layouts;   /* other client layouts */
 137         struct list_head        plh_bulk_recall; /* clnt list of bulk recalls */
 138         struct list_head        plh_segs;      /* layout segments list */
 139         nfs4_stateid            plh_stateid;
 140         atomic_t                plh_outstanding; /* number of RPCs out */
 141         unsigned long           plh_block_lgets; /* block LAYOUTGET if >0 */
 142         u32                     plh_barrier; /* ignore lower seqids */
 143         unsigned long           plh_retry_timestamp;
 144         unsigned long           plh_flags;
 145         loff_t                  plh_lwb; /* last write byte for layoutcommit */
 146         struct rpc_cred         *plh_lc_cred; /* layoutcommit cred */
 147         struct inode            *plh_inode;
 148 };
 149
 150 struct pnfs_device {
 151         struct nfs4_deviceid dev_id;
 152         unsigned int  layout_type;
 153         unsigned int  mincount;
 154         struct page **pages;
 155         unsigned int  pgbase;
 156         unsigned int  pglen;
 157 };
 158
 159 #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
 160
 161 struct pnfs_devicelist {
 162         unsigned int            eof;
 163         unsigned int            num_devs;
 164         struct nfs4_deviceid    dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
 165 };
 166
 167 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
 168 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
 169
 170 /* nfs4proc.c */
 171 extern int nfs4_proc_getdevicelist(struct nfs_server *server,
 172                                    const struct nfs_fh *fh,
 173                                    struct pnfs_devicelist *devlist);
 174 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
 175                                    struct pnfs_device *dev);
 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 pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
 184                            const struct nfs_pgio_completion_ops *);
 185 void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *,
 186                             int, const struct nfs_pgio_completion_ops *);
 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 *, struct nfs_page *);
 193 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
 194 bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
 195 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
 196 struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
 197 void pnfs_free_lseg_list(struct list_head *tmp_list);
 198 void pnfs_destroy_layout(struct nfs_inode *);
 199 void pnfs_destroy_all_layouts(struct nfs_client *);
 200 void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
 201 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
 202                              const nfs4_stateid *new,
 203                              bool update_barrier);
 204 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
 205                                   struct pnfs_layout_hdr *lo,
 206                                   struct nfs4_state *open_state);
 207 int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
 208                                 struct list_head *tmp_list,
 209                                 struct pnfs_layout_range *recall_range);
 210 bool pnfs_roc(struct inode *ino);
 211 void pnfs_roc_release(struct inode *ino);
 212 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
 213 bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
 214 void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
 215 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
 216 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
 217 int _pnfs_return_layout(struct inode *);
 218 void pnfs_ld_write_done(struct nfs_write_data *);
 219 void pnfs_ld_read_done(struct nfs_read_data *);
 220 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
 221                                                struct nfs_open_context *ctx,
 222                                                loff_t pos,
 223                                                u64 count,
 224                                                enum pnfs_iomode iomode,
 225                                                gfp_t gfp_flags);
 226
 227 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
 228 int pnfs_read_done_resend_to_mds(struct inode *inode, struct list_head *head,
 229                         const struct nfs_pgio_completion_ops *compl_ops);
 230 int pnfs_write_done_resend_to_mds(struct inode *inode, struct list_head *head,
 231                         const struct nfs_pgio_completion_ops *compl_ops);
 232 struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
 233
 234 /* nfs4_deviceid_flags */
 235 enum {
 236         NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
 237         NFS_DEVICEID_UNAVAILABLE,       /* device temporarily unavailable */
 238 };
 239
 240 /* pnfs_dev.c */
 241 struct nfs4_deviceid_node {
 242         struct hlist_node               node;
 243         struct hlist_node               tmpnode;
 244         const struct pnfs_layoutdriver_type *ld;
 245         const struct nfs_client         *nfs_client;
 246         unsigned long                   flags;
 247         unsigned long                   timestamp_unavailable;
 248         struct nfs4_deviceid            deviceid;
 249         atomic_t                        ref;
 250 };
 251
 252 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 253 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 254 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
 255                              const struct pnfs_layoutdriver_type *,
 256                              const struct nfs_client *,
 257                              const struct nfs4_deviceid *);
 258 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
 259 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
 260 void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
 261 bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
 262 void nfs4_deviceid_purge_client(const struct nfs_client *);
 263
 264 static inline void
 265 pnfs_mark_layout_returned(struct pnfs_layout_hdr *lo)
 266 {
 267         set_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
 268 }
 269
 270 static inline void
 271 pnfs_clear_layout_returned(struct pnfs_layout_hdr *lo)
 272 {
 273         clear_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
 274 }
 275
 276 static inline bool
 277 pnfs_test_layout_returned(struct pnfs_layout_hdr *lo)
 278 {
 279         return test_bit(NFS_LAYOUT_RETURNED, &lo->plh_flags);
 280 }
 281
 282 static inline struct pnfs_layout_segment *
 283 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
 284 {
 285         if (lseg) {
 286                 atomic_inc(&lseg->pls_refcount);
 287                 smp_mb__after_atomic_inc();
 288         }
 289         return lseg;
 290 }
 291
 292 /* Return true if a layout driver is being used for this mountpoint */
 293 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
 294 {
 295         return nfss->pnfs_curr_ld != NULL;
 296 }
 297
 298 static inline int
 299 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 300                  struct nfs_commit_info *cinfo)
 301 {
 302         if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
 303                 return PNFS_NOT_ATTEMPTED;
 304         return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
 305 }
 306
 307 static inline struct pnfs_ds_commit_info *
 308 pnfs_get_ds_info(struct inode *inode)
 309 {
 310         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 311
 312         if (ld == NULL || ld->get_ds_info == NULL)
 313                 return NULL;
 314         return ld->get_ds_info(inode);
 315 }
 316
 317 static inline bool
 318 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 319                          struct nfs_commit_info *cinfo)
 320 {
 321         struct inode *inode = req->wb_context->dentry->d_inode;
 322         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 323
 324         if (lseg == NULL || ld->mark_request_commit == NULL)
 325                 return false;
 326         ld->mark_request_commit(req, lseg, cinfo);
 327         return true;
 328 }
 329
 330 static inline bool
 331 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 332 {
 333         struct inode *inode = req->wb_context->dentry->d_inode;
 334         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 335
 336         if (ld == NULL || ld->clear_request_commit == NULL)
 337                 return false;
 338         ld->clear_request_commit(req, cinfo);
 339         return true;
 340 }
 341
 342 static inline int
 343 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 344                        int max)
 345 {
 346         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
 347                 return 0;
 348         else
 349                 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
 350 }
 351
 352 static inline void
 353 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
 354                          struct nfs_commit_info *cinfo)
 355 {
 356         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
 357                 return;
 358         NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
 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 int pnfs_return_layout(struct inode *ino)
 372 {
 373         struct nfs_inode *nfsi = NFS_I(ino);
 374         struct nfs_server *nfss = NFS_SERVER(ino);
 375
 376         if (pnfs_enabled_sb(nfss) && nfsi->layout)
 377                 return _pnfs_return_layout(ino);
 378
 379         return 0;
 380 }
 381
 382 static inline bool
 383 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
 384                    struct nfs_server *nfss)
 385 {
 386         return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
 387                                         nfss->pnfs_curr_ld->id == src->l_type);
 388 }
 389
 390 #ifdef NFS_DEBUG
 391 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
 392 #else
 393 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
 394 {
 395 }
 396 #endif /* NFS_DEBUG */
 397 #else  /* CONFIG_NFS_V4_1 */
 398
 399 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
 400 {
 401 }
 402
 403 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
 404 {
 405 }
 406
 407 static inline struct pnfs_layout_segment *
 408 pnfs_get_lseg(struct pnfs_layout_segment *lseg)
 409 {
 410         return NULL;
 411 }
 412
 413 static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
 414 {
 415 }
 416
 417 static inline int pnfs_return_layout(struct inode *ino)
 418 {
 419         return 0;
 420 }
 421
 422 static inline bool
 423 pnfs_ld_layoutret_on_setattr(struct inode *inode)
 424 {
 425         return false;
 426 }
 427
 428 static inline bool
 429 pnfs_roc(struct inode *ino)
 430 {
 431         return false;
 432 }
 433
 434 static inline void
 435 pnfs_roc_release(struct inode *ino)
 436 {
 437 }
 438
 439 static inline void
 440 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
 441 {
 442 }
 443
 444 static inline bool
 445 pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
 446 {
 447         return false;
 448 }
 449
 450 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
 451                                          const struct nfs_fh *mntfh, u32 id)
 452 {
 453 }
 454
 455 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
 456 {
 457 }
 458
 459 static inline void pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
 460                                          const struct nfs_pgio_completion_ops *compl_ops)
 461 {
 462         nfs_pageio_init_read(pgio, inode, compl_ops);
 463 }
 464
 465 static inline void pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags,
 466                                           const struct nfs_pgio_completion_ops *compl_ops)
 467 {
 468         nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
 469 }
 470
 471 static inline int
 472 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 473                  struct nfs_commit_info *cinfo)
 474 {
 475         return PNFS_NOT_ATTEMPTED;
 476 }
 477
 478 static inline struct pnfs_ds_commit_info *
 479 pnfs_get_ds_info(struct inode *inode)
 480 {
 481         return NULL;
 482 }
 483
 484 static inline bool
 485 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 486                          struct nfs_commit_info *cinfo)
 487 {
 488         return false;
 489 }
 490
 491 static inline bool
 492 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 493 {
 494         return false;
 495 }
 496
 497 static inline int
 498 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 499                        int max)
 500 {
 501         return 0;
 502 }
 503
 504 static inline void
 505 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
 506                          struct nfs_commit_info *cinfo)
 507 {
 508 }
 509
 510 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
 511 {
 512         return 0;
 513 }
 514
 515 static inline bool
 516 pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
 517                    struct nfs_server *nfss)
 518 {
 519         return false;
 520 }
 521
 522 static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
 523 {
 524         return NULL;
 525 }
 526
 527 #endif /* CONFIG_NFS_V4_1 */
 528
 529 #endif /* FS_NFS_PNFS_H */