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 <asm/atomic.h>
  20
  21 /*
  22  * Valid flags for the radix tree
  23  */
  24 #define NFS_PAGE_TAG_DIRTY      0
  25 #define NFS_PAGE_TAG_WRITEBACK  1
  26
  27 /*
  28  * Valid flags for a dirty buffer
  29  */
  30 #define PG_BUSY                 0
  31 #define PG_NEED_COMMIT          1
  32 #define PG_NEED_RESCHED         2
  33 #define PG_NEED_FLUSH           3
  34
  35 struct nfs_inode;
  36 struct nfs_page {
  37         struct list_head        wb_list,        /* Defines state of page: */
  38                                 *wb_list_head;  /*      read/write/commit */
  39         struct page             *wb_page;       /* page to read in/write out */
  40         struct nfs_open_context *wb_context;    /* File state context info */
  41         atomic_t                wb_complete;    /* i/os we're waiting for */
  42         unsigned long           wb_index;       /* Offset >> PAGE_CACHE_SHIFT */
  43         unsigned int            wb_offset,      /* Offset & ~PAGE_CACHE_MASK */
  44                                 wb_pgbase,      /* Start of page data */
  45                                 wb_bytes;       /* Length of request */
  46         atomic_t                wb_count;       /* reference count */
  47         unsigned long           wb_flags;
  48         struct nfs_writeverf    wb_verf;        /* Commit cookie */
  49 };
  50
  51 struct nfs_pageio_descriptor {
  52         struct list_head        pg_list;
  53         unsigned long           pg_bytes_written;
  54         size_t                  pg_count;
  55         size_t                  pg_bsize;
  56         unsigned int            pg_base;
  57
  58         struct inode            *pg_inode;
  59         int                     (*pg_doio)(struct inode *, struct list_head *, size_t, int);
  60         int                     pg_ioflags;
  61         int                     pg_error;
  62 };
  63
  64 #define NFS_WBACK_BUSY(req)     (test_bit(PG_BUSY,&(req)->wb_flags))
  65
  66 extern  struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
  67                                             struct inode *inode,
  68                                             struct page *page,
  69                                             unsigned int offset,
  70                                             unsigned int count);
  71 extern  void nfs_clear_request(struct nfs_page *req);
  72 extern  void nfs_release_request(struct nfs_page *req);
  73
  74
  75 extern  long nfs_scan_dirty(struct address_space *mapping,
  76                                 struct writeback_control *wbc,
  77                                 struct list_head *dst);
  78 extern  int nfs_scan_list(struct nfs_inode *nfsi, struct list_head *head, struct list_head *dst,
  79                           unsigned long idx_start, unsigned int npages);
  80 extern  void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
  81                              struct inode *inode,
  82                              int (*doio)(struct inode *, struct list_head *, size_t, int),
  83                              size_t bsize,
  84                              int how);
  85 extern  int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
  86                                    struct nfs_page *);
  87 extern  void nfs_pageio_add_list(struct nfs_pageio_descriptor *,
  88                                  struct list_head *);
  89 extern  void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
  90 extern  int nfs_wait_on_request(struct nfs_page *);
  91 extern  void nfs_unlock_request(struct nfs_page *req);
  92 extern  int nfs_set_page_writeback_locked(struct nfs_page *req);
  93 extern  void nfs_clear_page_writeback(struct nfs_page *req);
  94
  95
  96 /*
  97  * Lock the page of an asynchronous request without incrementing the wb_count
  98  */
  99 static inline int
 100 nfs_lock_request_dontget(struct nfs_page *req)
 101 {
 102         return !test_and_set_bit(PG_BUSY, &req->wb_flags);
 103 }
 104
 105 /*
 106  * Lock the page of an asynchronous request
 107  */
 108 static inline int
 109 nfs_lock_request(struct nfs_page *req)
 110 {
 111         if (test_and_set_bit(PG_BUSY, &req->wb_flags))
 112                 return 0;
 113         atomic_inc(&req->wb_count);
 114         return 1;
 115 }
 116
 117 /**
 118  * nfs_list_add_request - Insert a request into a list
 119  * @req: request
 120  * @head: head of list into which to insert the request.
 121  */
 122 static inline void
 123 nfs_list_add_request(struct nfs_page *req, struct list_head *head)
 124 {
 125         list_add_tail(&req->wb_list, head);
 126         req->wb_list_head = head;
 127 }
 128
 129
 130 /**
 131  * nfs_list_remove_request - Remove a request from its wb_list
 132  * @req: request
 133  */
 134 static inline void
 135 nfs_list_remove_request(struct nfs_page *req)
 136 {
 137         if (list_empty(&req->wb_list))
 138                 return;
 139         list_del_init(&req->wb_list);
 140         req->wb_list_head = NULL;
 141 }
 142
 143 static inline struct nfs_page *
 144 nfs_list_entry(struct list_head *head)
 145 {
 146         return list_entry(head, struct nfs_page, wb_list);
 147 }
 148
 149 static inline
 150 loff_t req_offset(struct nfs_page *req)
 151 {
 152         return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
 153 }
 154
 155 #endif /* _LINUX_NFS_PAGE_H */