lguest: documentation II: Guest
[linux-2.6] / 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 the radix tree
23  */
24 #define NFS_PAGE_TAG_LOCKED     0
25 #define NFS_PAGE_TAG_COMMIT     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         struct page             *wb_page;       /* page to read in/write out */
39         struct nfs_open_context *wb_context;    /* File state context info */
40         atomic_t                wb_complete;    /* i/os we're waiting for */
41         pgoff_t                 wb_index;       /* Offset >> PAGE_CACHE_SHIFT */
42         unsigned int            wb_offset,      /* Offset & ~PAGE_CACHE_MASK */
43                                 wb_pgbase,      /* Start of page data */
44                                 wb_bytes;       /* Length of request */
45         struct kref             wb_kref;        /* reference count */
46         unsigned long           wb_flags;
47         struct nfs_writeverf    wb_verf;        /* Commit cookie */
48 };
49
50 struct nfs_pageio_descriptor {
51         struct list_head        pg_list;
52         unsigned long           pg_bytes_written;
53         size_t                  pg_count;
54         size_t                  pg_bsize;
55         unsigned int            pg_base;
56
57         struct inode            *pg_inode;
58         int                     (*pg_doio)(struct inode *, struct list_head *, unsigned int, size_t, int);
59         int                     pg_ioflags;
60         int                     pg_error;
61 };
62
63 #define NFS_WBACK_BUSY(req)     (test_bit(PG_BUSY,&(req)->wb_flags))
64
65 extern  struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
66                                             struct inode *inode,
67                                             struct page *page,
68                                             unsigned int offset,
69                                             unsigned int count);
70 extern  void nfs_clear_request(struct nfs_page *req);
71 extern  void nfs_release_request(struct nfs_page *req);
72
73
74 extern  int nfs_scan_list(struct nfs_inode *nfsi, struct list_head *dst,
75                           pgoff_t idx_start, unsigned int npages, int tag);
76 extern  void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
77                              struct inode *inode,
78                              int (*doio)(struct inode *, struct list_head *, unsigned int, size_t, int),
79                              size_t bsize,
80                              int how);
81 extern  int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
82                                    struct nfs_page *);
83 extern  void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
84 extern  void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
85 extern  int nfs_wait_on_request(struct nfs_page *);
86 extern  void nfs_unlock_request(struct nfs_page *req);
87 extern  void nfs_clear_page_tag_locked(struct nfs_page *req);
88
89
90 /*
91  * Lock the page of an asynchronous request without getting a new reference
92  */
93 static inline int
94 nfs_lock_request_dontget(struct nfs_page *req)
95 {
96         return !test_and_set_bit(PG_BUSY, &req->wb_flags);
97 }
98
99 /*
100  * Lock the page of an asynchronous request and take a reference
101  */
102 static inline int
103 nfs_lock_request(struct nfs_page *req)
104 {
105         if (test_and_set_bit(PG_BUSY, &req->wb_flags))
106                 return 0;
107         kref_get(&req->wb_kref);
108         return 1;
109 }
110
111 /**
112  * nfs_list_add_request - Insert a request into a list
113  * @req: request
114  * @head: head of list into which to insert the request.
115  */
116 static inline void
117 nfs_list_add_request(struct nfs_page *req, struct list_head *head)
118 {
119         list_add_tail(&req->wb_list, head);
120 }
121
122
123 /**
124  * nfs_list_remove_request - Remove a request from its wb_list
125  * @req: request
126  */
127 static inline void
128 nfs_list_remove_request(struct nfs_page *req)
129 {
130         if (list_empty(&req->wb_list))
131                 return;
132         list_del_init(&req->wb_list);
133 }
134
135 static inline struct nfs_page *
136 nfs_list_entry(struct list_head *head)
137 {
138         return list_entry(head, struct nfs_page, wb_list);
139 }
140
141 static inline
142 loff_t req_offset(struct nfs_page *req)
143 {
144         return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
145 }
146
147 #endif /* _LINUX_NFS_PAGE_H */