include/linux/nfs_page.h

   1 /*
   2  * linux/include/linux/nfs_page.h
   3  *
   4  * Copyright (C) 2000 Trond Myklebust
   5  *
   6  * NFS page cache wrapper.
   7  */
   8
   9 #ifndef _LINUX_NFS_PAGE_H
  10 #define _LINUX_NFS_PAGE_H
  11
  12
  13 #include <linux/list.h>
  14 #include <linux/pagemap.h>
  15 #include <linux/wait.h>
  16 #include <linux/sunrpc/auth.h>
  17 #include <linux/nfs_xdr.h>
  18
  19 #include <linux/kref.h>
  20
  21 /*
  22  * Valid flags for a dirty buffer
  23  */
  24 enum {
  25         PG_BUSY = 0,            /* nfs_{un}lock_request */
  26         PG_MAPPED,              /* page private set for buffered io */
  27         PG_CLEAN,               /* write succeeded */
  28         PG_COMMIT_TO_DS,        /* used by pnfs layouts */
  29         PG_INODE_REF,           /* extra ref held by inode when in writeback */
  30         PG_HEADLOCK,            /* page group lock of wb_head */
  31         PG_TEARDOWN,            /* page group sync for destroy */
  32         PG_UNLOCKPAGE,          /* page group sync bit in read path */
  33         PG_UPTODATE,            /* page group sync bit in read path */
  34         PG_WB_END,              /* page group sync bit in write path */
  35         PG_REMOVE,              /* page group sync bit in write path */
  36 };
  37
  38 struct nfs_inode;
  39 struct nfs_page {
  40         struct list_head        wb_list;        /* Defines state of page: */
  41         struct page             *wb_page;       /* page to read in/write out */
  42         struct nfs_open_context *wb_context;    /* File state context info */
  43         struct nfs_lock_context *wb_lock_context;       /* lock context info */
  44         pgoff_t                 wb_index;       /* Offset >> PAGE_CACHE_SHIFT */
  45         unsigned int            wb_offset,      /* Offset & ~PAGE_CACHE_MASK */
  46                                 wb_pgbase,      /* Start of page data */
  47                                 wb_bytes;       /* Length of request */
  48         struct kref             wb_kref;        /* reference count */
  49         unsigned long           wb_flags;
  50         struct nfs_write_verifier       wb_verf;        /* Commit cookie */
  51         struct nfs_page         *wb_this_page;  /* list of reqs for this page */
  52         struct nfs_page         *wb_head;       /* head pointer for req list */
  53 };
  54
  55 struct nfs_pageio_descriptor;
  56 struct nfs_pageio_ops {
  57         void    (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
  58         size_t  (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *,
  59                            struct nfs_page *);
  60         int     (*pg_doio)(struct nfs_pageio_descriptor *);
  61         void    (*pg_cleanup)(struct nfs_pageio_descriptor *);
  62 };
  63
  64 struct nfs_rw_ops {
  65         const fmode_t rw_mode;
  66         struct nfs_pgio_header *(*rw_alloc_header)(void);
  67         void (*rw_free_header)(struct nfs_pgio_header *);
  68         void (*rw_release)(struct nfs_pgio_header *);
  69         int  (*rw_done)(struct rpc_task *, struct nfs_pgio_header *,
  70                         struct inode *);
  71         void (*rw_result)(struct rpc_task *, struct nfs_pgio_header *);
  72         void (*rw_initiate)(struct nfs_pgio_header *, struct rpc_message *,
  73                             const struct nfs_rpc_ops *,
  74                             struct rpc_task_setup *, int);
  75 };
  76
  77 struct nfs_pageio_descriptor {
  78         struct list_head        pg_list;
  79         unsigned long           pg_bytes_written;
  80         size_t                  pg_count;
  81         size_t                  pg_bsize;
  82         unsigned int            pg_base;
  83         unsigned char           pg_moreio : 1,
  84                                 pg_recoalesce : 1;
  85
  86         struct inode            *pg_inode;
  87         const struct nfs_pageio_ops *pg_ops;
  88         const struct nfs_rw_ops *pg_rw_ops;
  89         int                     pg_ioflags;
  90         int                     pg_error;
  91         const struct rpc_call_ops *pg_rpc_callops;
  92         const struct nfs_pgio_completion_ops *pg_completion_ops;
  93         struct pnfs_layout_segment *pg_lseg;
  94         struct nfs_direct_req   *pg_dreq;
  95         void                    *pg_layout_private;
  96 };
  97
  98 #define NFS_WBACK_BUSY(req)     (test_bit(PG_BUSY,&(req)->wb_flags))
  99
 100 extern  struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
 101                                             struct page *page,
 102                                             struct nfs_page *last,
 103                                             unsigned int offset,
 104                                             unsigned int count);
 105 extern  void nfs_release_request(struct nfs_page *);
 106
 107
 108 extern  void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
 109                              struct inode *inode,
 110                              const struct nfs_pageio_ops *pg_ops,
 111                              const struct nfs_pgio_completion_ops *compl_ops,
 112                              const struct nfs_rw_ops *rw_ops,
 113                              size_t bsize,
 114                              int how);
 115 extern  int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
 116                                    struct nfs_page *);
 117 extern  int nfs_pageio_resend(struct nfs_pageio_descriptor *,
 118                               struct nfs_pgio_header *);
 119 extern  void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
 120 extern  void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
 121 extern size_t nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
 122                                 struct nfs_page *prev,
 123                                 struct nfs_page *req);
 124 extern  int nfs_wait_on_request(struct nfs_page *);
 125 extern  void nfs_unlock_request(struct nfs_page *req);
 126 extern  void nfs_unlock_and_release_request(struct nfs_page *);
 127 extern int nfs_page_group_lock(struct nfs_page *, bool);
 128 extern void nfs_page_group_lock_wait(struct nfs_page *);
 129 extern void nfs_page_group_unlock(struct nfs_page *);
 130 extern bool nfs_page_group_sync_on_bit(struct nfs_page *, unsigned int);
 131
 132 /*
 133  * Lock the page of an asynchronous request
 134  */
 135 static inline int
 136 nfs_lock_request(struct nfs_page *req)
 137 {
 138         return !test_and_set_bit(PG_BUSY, &req->wb_flags);
 139 }
 140
 141 /**
 142  * nfs_list_add_request - Insert a request into a list
 143  * @req: request
 144  * @head: head of list into which to insert the request.
 145  */
 146 static inline void
 147 nfs_list_add_request(struct nfs_page *req, struct list_head *head)
 148 {
 149         list_add_tail(&req->wb_list, head);
 150 }
 151
 152
 153 /**
 154  * nfs_list_remove_request - Remove a request from its wb_list
 155  * @req: request
 156  */
 157 static inline void
 158 nfs_list_remove_request(struct nfs_page *req)
 159 {
 160         if (list_empty(&req->wb_list))
 161                 return;
 162         list_del_init(&req->wb_list);
 163 }
 164
 165 static inline struct nfs_page *
 166 nfs_list_entry(struct list_head *head)
 167 {
 168         return list_entry(head, struct nfs_page, wb_list);
 169 }
 170
 171 static inline
 172 loff_t req_offset(struct nfs_page *req)
 173 {
 174         return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
 175 }
 176
 177 #endif /* _LINUX_NFS_PAGE_H */