Commit | Line | Data |
---|---|---|
1da177e4 LT |
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> | |
1da177e4 LT |
16 | #include <linux/sunrpc/auth.h> |
17 | #include <linux/nfs_xdr.h> | |
18 | ||
c03b4024 | 19 | #include <linux/kref.h> |
1da177e4 LT |
20 | |
21 | /* | |
22 | * Valid flags for a dirty buffer | |
23 | */ | |
e468bae9 | 24 | enum { |
12c05792 WAA |
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 */ | |
b412ddf0 | 29 | PG_INODE_REF, /* extra ref held by inode when in writeback */ |
2bfc6e56 WAA |
30 | PG_HEADLOCK, /* page group lock of wb_head */ |
31 | PG_TEARDOWN, /* page group sync for destroy */ | |
67d0338e WAA |
32 | PG_UNLOCKPAGE, /* page group sync bit in read path */ |
33 | PG_UPTODATE, /* page group sync bit in read path */ | |
20633f04 WAA |
34 | PG_WB_END, /* page group sync bit in write path */ |
35 | PG_REMOVE, /* page group sync bit in write path */ | |
e468bae9 | 36 | }; |
1da177e4 | 37 | |
3da28eb1 | 38 | struct nfs_inode; |
1da177e4 | 39 | struct nfs_page { |
d6d6dc7c | 40 | struct list_head wb_list; /* Defines state of page: */ |
1da177e4 LT |
41 | struct page *wb_page; /* page to read in/write out */ |
42 | struct nfs_open_context *wb_context; /* File state context info */ | |
f11ac8db | 43 | struct nfs_lock_context *wb_lock_context; /* lock context info */ |
ca52fec1 | 44 | pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */ |
1da177e4 LT |
45 | unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */ |
46 | wb_pgbase, /* Start of page data */ | |
47 | wb_bytes; /* Length of request */ | |
c03b4024 | 48 | struct kref wb_kref; /* reference count */ |
1da177e4 | 49 | unsigned long wb_flags; |
2f2c63bc | 50 | struct nfs_write_verifier wb_verf; /* Commit cookie */ |
2bfc6e56 WAA |
51 | struct nfs_page *wb_this_page; /* list of reqs for this page */ |
52 | struct nfs_page *wb_head; /* head pointer for req list */ | |
1da177e4 LT |
53 | }; |
54 | ||
1751c363 TM |
55 | struct nfs_pageio_descriptor; |
56 | struct nfs_pageio_ops { | |
d8007d4d | 57 | void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *); |
b4fdac1a WAA |
58 | size_t (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, |
59 | struct nfs_page *); | |
1751c363 TM |
60 | int (*pg_doio)(struct nfs_pageio_descriptor *); |
61 | }; | |
62 | ||
4a0de55c | 63 | struct nfs_rw_ops { |
a4cdda59 | 64 | const fmode_t rw_mode; |
1e7f3a48 WAA |
65 | struct nfs_pgio_header *(*rw_alloc_header)(void); |
66 | void (*rw_free_header)(struct nfs_pgio_header *); | |
d45f60c6 WAA |
67 | void (*rw_release)(struct nfs_pgio_header *); |
68 | int (*rw_done)(struct rpc_task *, struct nfs_pgio_header *, | |
69 | struct inode *); | |
70 | void (*rw_result)(struct rpc_task *, struct nfs_pgio_header *); | |
71 | void (*rw_initiate)(struct nfs_pgio_header *, struct rpc_message *, | |
1ed26f33 | 72 | struct rpc_task_setup *, int); |
4a0de55c AS |
73 | }; |
74 | ||
d8a5ad75 TM |
75 | struct nfs_pageio_descriptor { |
76 | struct list_head pg_list; | |
bcb71bba | 77 | unsigned long pg_bytes_written; |
d8a5ad75 TM |
78 | size_t pg_count; |
79 | size_t pg_bsize; | |
80 | unsigned int pg_base; | |
d9156f9f TM |
81 | unsigned char pg_moreio : 1, |
82 | pg_recoalesce : 1; | |
bcb71bba TM |
83 | |
84 | struct inode *pg_inode; | |
1751c363 | 85 | const struct nfs_pageio_ops *pg_ops; |
4a0de55c | 86 | const struct nfs_rw_ops *pg_rw_ops; |
bcb71bba TM |
87 | int pg_ioflags; |
88 | int pg_error; | |
50828d7e | 89 | const struct rpc_call_ops *pg_rpc_callops; |
061ae2ed | 90 | const struct nfs_pgio_completion_ops *pg_completion_ops; |
94ad1c80 | 91 | struct pnfs_layout_segment *pg_lseg; |
584aa810 | 92 | struct nfs_direct_req *pg_dreq; |
f6166384 | 93 | void *pg_layout_private; |
d8a5ad75 TM |
94 | }; |
95 | ||
1da177e4 | 96 | #define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags)) |
1da177e4 LT |
97 | |
98 | extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx, | |
1da177e4 | 99 | struct page *page, |
2bfc6e56 | 100 | struct nfs_page *last, |
1da177e4 LT |
101 | unsigned int offset, |
102 | unsigned int count); | |
2bfc6e56 | 103 | extern void nfs_release_request(struct nfs_page *); |
1da177e4 LT |
104 | |
105 | ||
bcb71bba TM |
106 | extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc, |
107 | struct inode *inode, | |
1751c363 | 108 | const struct nfs_pageio_ops *pg_ops, |
061ae2ed | 109 | const struct nfs_pgio_completion_ops *compl_ops, |
4a0de55c | 110 | const struct nfs_rw_ops *rw_ops, |
bcb71bba TM |
111 | size_t bsize, |
112 | int how); | |
8b09bee3 TM |
113 | extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *, |
114 | struct nfs_page *); | |
53113ad3 WAA |
115 | extern int nfs_pageio_resend(struct nfs_pageio_descriptor *, |
116 | struct nfs_pgio_header *); | |
bcb71bba | 117 | extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc); |
7fe7f848 | 118 | extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t); |
b4fdac1a | 119 | extern size_t nfs_generic_pg_test(struct nfs_pageio_descriptor *desc, |
19345cb2 BH |
120 | struct nfs_page *prev, |
121 | struct nfs_page *req); | |
1da177e4 LT |
122 | extern int nfs_wait_on_request(struct nfs_page *); |
123 | extern void nfs_unlock_request(struct nfs_page *req); | |
2bfc6e56 | 124 | extern void nfs_unlock_and_release_request(struct nfs_page *); |
e7029206 | 125 | extern int nfs_page_group_lock(struct nfs_page *, bool); |
7c3af975 | 126 | extern void nfs_page_group_lock_wait(struct nfs_page *); |
2bfc6e56 WAA |
127 | extern void nfs_page_group_unlock(struct nfs_page *); |
128 | extern bool nfs_page_group_sync_on_bit(struct nfs_page *, unsigned int); | |
c6a556b8 | 129 | |
1da177e4 | 130 | /* |
7ad84aa9 | 131 | * Lock the page of an asynchronous request |
1da177e4 | 132 | */ |
8dd37758 TM |
133 | static inline int |
134 | nfs_lock_request(struct nfs_page *req) | |
135 | { | |
7ad84aa9 | 136 | return !test_and_set_bit(PG_BUSY, &req->wb_flags); |
8dd37758 TM |
137 | } |
138 | ||
3da28eb1 TM |
139 | /** |
140 | * nfs_list_add_request - Insert a request into a list | |
141 | * @req: request | |
142 | * @head: head of list into which to insert the request. | |
143 | */ | |
144 | static inline void | |
145 | nfs_list_add_request(struct nfs_page *req, struct list_head *head) | |
146 | { | |
147 | list_add_tail(&req->wb_list, head); | |
3da28eb1 TM |
148 | } |
149 | ||
1da177e4 LT |
150 | |
151 | /** | |
152 | * nfs_list_remove_request - Remove a request from its wb_list | |
153 | * @req: request | |
154 | */ | |
155 | static inline void | |
156 | nfs_list_remove_request(struct nfs_page *req) | |
157 | { | |
158 | if (list_empty(&req->wb_list)) | |
159 | return; | |
1da177e4 | 160 | list_del_init(&req->wb_list); |
1da177e4 LT |
161 | } |
162 | ||
1da177e4 LT |
163 | static inline struct nfs_page * |
164 | nfs_list_entry(struct list_head *head) | |
165 | { | |
166 | return list_entry(head, struct nfs_page, wb_list); | |
167 | } | |
168 | ||
169 | static inline | |
170 | loff_t req_offset(struct nfs_page *req) | |
171 | { | |
172 | return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset; | |
173 | } | |
174 | ||
175 | #endif /* _LINUX_NFS_PAGE_H */ |