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 };
  40
  41 struct pnfs_layout_segment {
  42         struct list_head pls_list;
  43         struct pnfs_layout_range pls_range;
  44         atomic_t pls_refcount;
  45         unsigned long pls_flags;
  46         struct pnfs_layout_hdr *pls_layout;
  47         struct rpc_cred *pls_lc_cred; /* LAYOUTCOMMIT credential */
  48         loff_t pls_end_pos; /* LAYOUTCOMMIT write end */
  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 struct nfs4_deviceid_node;
  69
  70 /* Per-layout driver specific registration structure */
  71 struct pnfs_layoutdriver_type {
  72         struct list_head pnfs_tblid;
  73         const u32 id;
  74         const char *name;
  75         struct module *owner;
  76
  77         struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
  78         void (*free_layout_hdr) (struct pnfs_layout_hdr *);
  79
  80         struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
  81         void (*free_lseg) (struct pnfs_layout_segment *lseg);
  82
  83         /* test for nfs page cache coalescing */
  84         int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
  85
  86         /* Returns true if layoutdriver wants to divert this request to
  87          * driver's commit routine.
  88          */
  89         bool (*mark_pnfs_commit)(struct pnfs_layout_segment *lseg);
  90         struct list_head * (*choose_commit_list) (struct nfs_page *req);
  91         int (*commit_pagelist)(struct inode *inode, struct list_head *mds_pages, int how);
  92
  93         /*
  94          * Return PNFS_ATTEMPTED to indicate the layout code has attempted
  95          * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
  96          */
  97         enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
  98         enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
  99
 100         void (*free_deviceid_node) (struct nfs4_deviceid_node *);
 101 };
 102
 103 struct pnfs_layout_hdr {
 104         atomic_t                plh_refcount;
 105         struct list_head        plh_layouts;   /* other client layouts */
 106         struct list_head        plh_bulk_recall; /* clnt list of bulk recalls */
 107         struct list_head        plh_segs;      /* layout segments list */
 108         nfs4_stateid            plh_stateid;
 109         atomic_t                plh_outstanding; /* number of RPCs out */
 110         unsigned long           plh_block_lgets; /* block LAYOUTGET if >0 */
 111         u32                     plh_barrier; /* ignore lower seqids */
 112         unsigned long           plh_flags;
 113         struct inode            *plh_inode;
 114 };
 115
 116 struct pnfs_device {
 117         struct nfs4_deviceid dev_id;
 118         unsigned int  layout_type;
 119         unsigned int  mincount;
 120         struct page **pages;
 121         unsigned int  pgbase;
 122         unsigned int  pglen;
 123 };
 124
 125 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
 126 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
 127
 128 /* nfs4proc.c */
 129 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
 130                                    struct pnfs_device *dev);
 131 extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
 132 extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
 133
 134 /* pnfs.c */
 135 void get_layout_hdr(struct pnfs_layout_hdr *lo);
 136 void put_lseg(struct pnfs_layout_segment *lseg);
 137 struct pnfs_layout_segment *
 138 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
 139                    loff_t pos, u64 count, enum pnfs_iomode access_type,
 140                    gfp_t gfp_flags);
 141 void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
 142 void unset_pnfs_layoutdriver(struct nfs_server *);
 143 enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
 144                                              const struct rpc_call_ops *, int);
 145 enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
 146                                             const struct rpc_call_ops *);
 147 void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
 148 void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
 149 int pnfs_layout_process(struct nfs4_layoutget *lgp);
 150 void pnfs_free_lseg_list(struct list_head *tmp_list);
 151 void pnfs_destroy_layout(struct nfs_inode *);
 152 void pnfs_destroy_all_layouts(struct nfs_client *);
 153 void put_layout_hdr(struct pnfs_layout_hdr *lo);
 154 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
 155                              const nfs4_stateid *new,
 156                              bool update_barrier);
 157 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
 158                                   struct pnfs_layout_hdr *lo,
 159                                   struct nfs4_state *open_state);
 160 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
 161                                 struct list_head *tmp_list,
 162                                 struct pnfs_layout_range *recall_range);
 163 bool pnfs_roc(struct inode *ino);
 164 void pnfs_roc_release(struct inode *ino);
 165 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
 166 bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
 167 void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
 168 int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
 169 int _pnfs_return_layout(struct inode *);
 170 int pnfs_ld_write_done(struct nfs_write_data *);
 171 int pnfs_ld_read_done(struct nfs_read_data *);
 172
 173 /* pnfs_dev.c */
 174 struct nfs4_deviceid_node {
 175         struct hlist_node               node;
 176         const struct pnfs_layoutdriver_type *ld;
 177         const struct nfs_client         *nfs_client;
 178         struct nfs4_deviceid            deviceid;
 179         atomic_t                        ref;
 180 };
 181
 182 void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
 183 struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 184 struct nfs4_deviceid_node *nfs4_unhash_put_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 185 void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
 186 void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
 187                              const struct pnfs_layoutdriver_type *,
 188                              const struct nfs_client *,
 189                              const struct nfs4_deviceid *);
 190 struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
 191 bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
 192 void nfs4_deviceid_purge_client(const struct nfs_client *);
 193
 194 static inline int lo_fail_bit(u32 iomode)
 195 {
 196         return iomode == IOMODE_RW ?
 197                          NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
 198 }
 199
 200 static inline struct pnfs_layout_segment *
 201 get_lseg(struct pnfs_layout_segment *lseg)
 202 {
 203         if (lseg) {
 204                 atomic_inc(&lseg->pls_refcount);
 205                 smp_mb__after_atomic_inc();
 206         }
 207         return lseg;
 208 }
 209
 210 /* Return true if a layout driver is being used for this mountpoint */
 211 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
 212 {
 213         return nfss->pnfs_curr_ld != NULL;
 214 }
 215
 216 static inline void
 217 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
 218 {
 219         if (lseg) {
 220                 struct pnfs_layoutdriver_type *ld;
 221
 222                 ld = NFS_SERVER(req->wb_page->mapping->host)->pnfs_curr_ld;
 223                 if (ld->mark_pnfs_commit && ld->mark_pnfs_commit(lseg)) {
 224                         set_bit(PG_PNFS_COMMIT, &req->wb_flags);
 225                         req->wb_commit_lseg = get_lseg(lseg);
 226                 }
 227         }
 228 }
 229
 230 static inline int
 231 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
 232 {
 233         if (!test_and_clear_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags))
 234                 return PNFS_NOT_ATTEMPTED;
 235         return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how);
 236 }
 237
 238 static inline struct list_head *
 239 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
 240 {
 241         struct list_head *rv;
 242
 243         if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags)) {
 244                 struct inode *inode = req->wb_commit_lseg->pls_layout->plh_inode;
 245
 246                 set_bit(NFS_INO_PNFS_COMMIT, &NFS_I(inode)->flags);
 247                 rv = NFS_SERVER(inode)->pnfs_curr_ld->choose_commit_list(req);
 248                 /* matched by ref taken when PG_PNFS_COMMIT is set */
 249                 put_lseg(req->wb_commit_lseg);
 250         } else
 251                 rv = mds;
 252         return rv;
 253 }
 254
 255 static inline void pnfs_clear_request_commit(struct nfs_page *req)
 256 {
 257         if (test_and_clear_bit(PG_PNFS_COMMIT, &req->wb_flags))
 258                 put_lseg(req->wb_commit_lseg);
 259 }
 260
 261 static inline int pnfs_return_layout(struct inode *ino)
 262 {
 263         struct nfs_inode *nfsi = NFS_I(ino);
 264         struct nfs_server *nfss = NFS_SERVER(ino);
 265
 266         if (pnfs_enabled_sb(nfss) && nfsi->layout)
 267                 return _pnfs_return_layout(ino);
 268
 269         return 0;
 270 }
 271
 272 #else  /* CONFIG_NFS_V4_1 */
 273
 274 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
 275 {
 276 }
 277
 278 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
 279 {
 280 }
 281
 282 static inline struct pnfs_layout_segment *
 283 get_lseg(struct pnfs_layout_segment *lseg)
 284 {
 285         return NULL;
 286 }
 287
 288 static inline void put_lseg(struct pnfs_layout_segment *lseg)
 289 {
 290 }
 291
 292 static inline struct pnfs_layout_segment *
 293 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
 294                    loff_t pos, u64 count, enum pnfs_iomode access_type,
 295                    gfp_t gfp_flags)
 296 {
 297         return NULL;
 298 }
 299
 300 static inline enum pnfs_try_status
 301 pnfs_try_to_read_data(struct nfs_read_data *data,
 302                       const struct rpc_call_ops *call_ops)
 303 {
 304         return PNFS_NOT_ATTEMPTED;
 305 }
 306
 307 static inline enum pnfs_try_status
 308 pnfs_try_to_write_data(struct nfs_write_data *data,
 309                        const struct rpc_call_ops *call_ops, int how)
 310 {
 311         return PNFS_NOT_ATTEMPTED;
 312 }
 313
 314 static inline int pnfs_return_layout(struct inode *ino)
 315 {
 316         return 0;
 317 }
 318
 319 static inline bool
 320 pnfs_roc(struct inode *ino)
 321 {
 322         return false;
 323 }
 324
 325 static inline void
 326 pnfs_roc_release(struct inode *ino)
 327 {
 328 }
 329
 330 static inline void
 331 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
 332 {
 333 }
 334
 335 static inline bool
 336 pnfs_roc_drain(struct inode *ino, u32 *barrier)
 337 {
 338         return false;
 339 }
 340
 341 static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
 342 {
 343 }
 344
 345 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
 346 {
 347 }
 348
 349 static inline void
 350 pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
 351 {
 352         pgio->pg_test = NULL;
 353 }
 354
 355 static inline void
 356 pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
 357 {
 358         pgio->pg_test = NULL;
 359 }
 360
 361 static inline void
 362 pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg)
 363 {
 364 }
 365
 366 static inline int
 367 pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how)
 368 {
 369         return PNFS_NOT_ATTEMPTED;
 370 }
 371
 372 static inline struct list_head *
 373 pnfs_choose_commit_list(struct nfs_page *req, struct list_head *mds)
 374 {
 375         return mds;
 376 }
 377
 378 static inline void pnfs_clear_request_commit(struct nfs_page *req)
 379 {
 380 }
 381
 382 static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
 383 {
 384         return 0;
 385 }
 386
 387 static inline void nfs4_deviceid_purge_client(struct nfs_client *ncl)
 388 {
 389 }
 390 #endif /* CONFIG_NFS_V4_1 */
 391
 392 #endif /* FS_NFS_PNFS_H */