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 };
  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_read_data *nfs_data);
 117         enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
 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_recall; /* clnt list of bulk recalls */
 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_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 int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
 174 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
 175
 176 /* pnfs.c */
 177 void get_layout_hdr(struct pnfs_layout_hdr *lo);
 178 void put_lseg(struct pnfs_layout_segment *lseg);
 179
 180 bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
 181                            const struct nfs_pgio_completion_ops *);
 182 bool 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 *, struct nfs_page *);
 190 int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
 191 bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
 192 void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
 193 int 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 void put_layout_hdr(struct pnfs_layout_hdr *lo);
 198 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
 199                              const nfs4_stateid *new,
 200                              bool update_barrier);
 201 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
 202                                   struct pnfs_layout_hdr *lo,
 203                                   struct nfs4_state *open_state);
 204 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
 205                                 struct list_head *tmp_list,
 206                                 struct pnfs_layout_range *recall_range);
 207 bool pnfs_roc(struct inode *ino);
 208 void pnfs_roc_release(struct inode *ino);
 209 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
 210 bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
 211 void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
 212 void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
 213 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
 214 int _pnfs_return_layout(struct inode *);
 215 void pnfs_ld_write_done(struct nfs_write_data *);
 216 void pnfs_ld_read_done(struct nfs_read_data *);
 217 struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
 218                                                struct nfs_open_context *ctx,
 219                                                loff_t pos,
 220                                                u64 count,
 221                                                enum pnfs_iomode iomode,
 222                                                gfp_t gfp_flags);
 223
 224 void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
 225
 226 /* nfs4_deviceid_flags */
 227 enum {
 228         NFS_DEVICEID_INVALID = 0,       /* set when MDS clientid recalled */
 229 };
 230
 231 /* pnfs_dev.c */
 232 struct nfs4_deviceid_node {
 233         struct hlist_node               node;
 234         struct hlist_node               tmpnode;
 235         const struct pnfs_layoutdriver_type *ld;
 236         const struct nfs_client         *nfs_client;
 237         unsigned long                   flags;
 238         struct nfs4_deviceid            deviceid;
 239         atomic_t                        ref;
 240 };
 241
 242 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 243 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 244 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
 245                              const struct pnfs_layoutdriver_type *,
 246                              const struct nfs_client *,
 247                              const struct nfs4_deviceid *);
 248 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
 249 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
 250 void nfs4_deviceid_purge_client(const struct nfs_client *);
 251
 252 static inline int lo_fail_bit(u32 iomode)
 253 {
 254         return iomode == IOMODE_RW ?
 255                          NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
 256 }
 257
 258 static inline struct pnfs_layout_segment *
 259 get_lseg(struct pnfs_layout_segment *lseg)
 260 {
 261         if (lseg) {
 262                 atomic_inc(&lseg->pls_refcount);
 263                 smp_mb__after_atomic_inc();
 264         }
 265         return lseg;
 266 }
 267
 268 /* Return true if a layout driver is being used for this mountpoint */
 269 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
 270 {
 271         return nfss->pnfs_curr_ld != NULL;
 272 }
 273
 274 static inline int
 275 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 276                  struct nfs_commit_info *cinfo)
 277 {
 278         if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
 279                 return PNFS_NOT_ATTEMPTED;
 280         return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
 281 }
 282
 283 static inline struct pnfs_ds_commit_info *
 284 pnfs_get_ds_info(struct inode *inode)
 285 {
 286         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 287
 288         if (ld == NULL || ld->get_ds_info == NULL)
 289                 return NULL;
 290         return ld->get_ds_info(inode);
 291 }
 292
 293 static inline bool
 294 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 295                          struct nfs_commit_info *cinfo)
 296 {
 297         struct inode *inode = req->wb_context->dentry->d_inode;
 298         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 299
 300         if (lseg == NULL || ld->mark_request_commit == NULL)
 301                 return false;
 302         ld->mark_request_commit(req, lseg, cinfo);
 303         return true;
 304 }
 305
 306 static inline bool
 307 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 308 {
 309         struct inode *inode = req->wb_context->dentry->d_inode;
 310         struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
 311
 312         if (ld == NULL || ld->clear_request_commit == NULL)
 313                 return false;
 314         ld->clear_request_commit(req, cinfo);
 315         return true;
 316 }
 317
 318 static inline int
 319 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 320                        int max)
 321 {
 322         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
 323                 return 0;
 324         else
 325                 return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
 326 }
 327
 328 static inline void
 329 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
 330                          struct nfs_commit_info *cinfo)
 331 {
 332         if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
 333                 return;
 334         NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
 335 }
 336
 337 /* Should the pNFS client commit and return the layout upon a setattr */
 338 static inline bool
 339 pnfs_ld_layoutret_on_setattr(struct inode *inode)
 340 {
 341         if (!pnfs_enabled_sb(NFS_SERVER(inode)))
 342                 return false;
 343         return NFS_SERVER(inode)->pnfs_curr_ld->flags &
 344                 PNFS_LAYOUTRET_ON_SETATTR;
 345 }
 346
 347 static inline int pnfs_return_layout(struct inode *ino)
 348 {
 349         struct nfs_inode *nfsi = NFS_I(ino);
 350         struct nfs_server *nfss = NFS_SERVER(ino);
 351
 352         if (pnfs_enabled_sb(nfss) && nfsi->layout)
 353                 return _pnfs_return_layout(ino);
 354
 355         return 0;
 356 }
 357
 358 #ifdef NFS_DEBUG
 359 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
 360 #else
 361 static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
 362 {
 363 }
 364 #endif /* NFS_DEBUG */
 365 #else  /* CONFIG_NFS_V4_1 */
 366
 367 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
 368 {
 369 }
 370
 371 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
 372 {
 373 }
 374
 375 static inline struct pnfs_layout_segment *
 376 get_lseg(struct pnfs_layout_segment *lseg)
 377 {
 378         return NULL;
 379 }
 380
 381 static inline void put_lseg(struct pnfs_layout_segment *lseg)
 382 {
 383 }
 384
 385 static inline int pnfs_return_layout(struct inode *ino)
 386 {
 387         return 0;
 388 }
 389
 390 static inline bool
 391 pnfs_ld_layoutret_on_setattr(struct inode *inode)
 392 {
 393         return false;
 394 }
 395
 396 static inline bool
 397 pnfs_roc(struct inode *ino)
 398 {
 399         return false;
 400 }
 401
 402 static inline void
 403 pnfs_roc_release(struct inode *ino)
 404 {
 405 }
 406
 407 static inline void
 408 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
 409 {
 410 }
 411
 412 static inline bool
 413 pnfs_roc_drain(struct inode *ino, u32 *barrier)
 414 {
 415         return false;
 416 }
 417
 418 static inline void set_pnfs_layoutdriver(struct nfs_server *s,
 419                                          const struct nfs_fh *mntfh, u32 id)
 420 {
 421 }
 422
 423 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
 424 {
 425 }
 426
 427 static inline bool pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
 428                                          const struct nfs_pgio_completion_ops *compl_ops)
 429 {
 430         return false;
 431 }
 432
 433 static inline bool pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags,
 434                                           const struct nfs_pgio_completion_ops *compl_ops)
 435 {
 436         return false;
 437 }
 438
 439 static inline int
 440 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
 441                  struct nfs_commit_info *cinfo)
 442 {
 443         return PNFS_NOT_ATTEMPTED;
 444 }
 445
 446 static inline struct pnfs_ds_commit_info *
 447 pnfs_get_ds_info(struct inode *inode)
 448 {
 449         return NULL;
 450 }
 451
 452 static inline bool
 453 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
 454                          struct nfs_commit_info *cinfo)
 455 {
 456         return false;
 457 }
 458
 459 static inline bool
 460 pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
 461 {
 462         return false;
 463 }
 464
 465 static inline int
 466 pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
 467                        int max)
 468 {
 469         return 0;
 470 }
 471
 472 static inline void
 473 pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
 474                          struct nfs_commit_info *cinfo)
 475 {
 476 }
 477
 478 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
 479 {
 480         return 0;
 481 }
 482
 483 #endif /* CONFIG_NFS_V4_1 */
 484
 485 #endif /* FS_NFS_PNFS_H */