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