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 TM |
24 | enum { |
25 | PG_BUSY = 0, | |
2df485a7 | 26 | PG_MAPPED, |
e468bae9 TM |
27 | PG_CLEAN, |
28 | PG_NEED_COMMIT, | |
29 | PG_NEED_RESCHED, | |
8dd37758 | 30 | PG_COMMIT_TO_DS, |
e468bae9 | 31 | }; |
1da177e4 | 32 | |
3da28eb1 | 33 | struct nfs_inode; |
1da177e4 | 34 | struct nfs_page { |
d6d6dc7c | 35 | struct list_head wb_list; /* Defines state of page: */ |
1da177e4 LT |
36 | struct page *wb_page; /* page to read in/write out */ |
37 | struct nfs_open_context *wb_context; /* File state context info */ | |
f11ac8db | 38 | struct nfs_lock_context *wb_lock_context; /* lock context info */ |
ca52fec1 | 39 | pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */ |
1da177e4 LT |
40 | unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */ |
41 | wb_pgbase, /* Start of page data */ | |
42 | wb_bytes; /* Length of request */ | |
c03b4024 | 43 | struct kref wb_kref; /* reference count */ |
1da177e4 LT |
44 | unsigned long wb_flags; |
45 | struct nfs_writeverf wb_verf; /* Commit cookie */ | |
46 | }; | |
47 | ||
1751c363 TM |
48 | struct nfs_pageio_descriptor; |
49 | struct nfs_pageio_ops { | |
d8007d4d | 50 | void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *); |
1751c363 TM |
51 | bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *); |
52 | int (*pg_doio)(struct nfs_pageio_descriptor *); | |
53 | }; | |
54 | ||
d8a5ad75 TM |
55 | struct nfs_pageio_descriptor { |
56 | struct list_head pg_list; | |
bcb71bba | 57 | unsigned long pg_bytes_written; |
d8a5ad75 TM |
58 | size_t pg_count; |
59 | size_t pg_bsize; | |
60 | unsigned int pg_base; | |
d9156f9f TM |
61 | unsigned char pg_moreio : 1, |
62 | pg_recoalesce : 1; | |
bcb71bba TM |
63 | |
64 | struct inode *pg_inode; | |
1751c363 | 65 | const struct nfs_pageio_ops *pg_ops; |
bcb71bba TM |
66 | int pg_ioflags; |
67 | int pg_error; | |
50828d7e | 68 | const struct rpc_call_ops *pg_rpc_callops; |
061ae2ed | 69 | const struct nfs_pgio_completion_ops *pg_completion_ops; |
94ad1c80 | 70 | struct pnfs_layout_segment *pg_lseg; |
d8a5ad75 TM |
71 | }; |
72 | ||
1da177e4 | 73 | #define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags)) |
1da177e4 LT |
74 | |
75 | extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx, | |
76 | struct inode *inode, | |
77 | struct page *page, | |
78 | unsigned int offset, | |
79 | unsigned int count); | |
1da177e4 LT |
80 | extern void nfs_release_request(struct nfs_page *req); |
81 | ||
82 | ||
bcb71bba TM |
83 | extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc, |
84 | struct inode *inode, | |
1751c363 | 85 | const struct nfs_pageio_ops *pg_ops, |
061ae2ed | 86 | const struct nfs_pgio_completion_ops *compl_ops, |
bcb71bba TM |
87 | size_t bsize, |
88 | int how); | |
8b09bee3 TM |
89 | extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *, |
90 | struct nfs_page *); | |
bcb71bba | 91 | extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc); |
7fe7f848 | 92 | extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t); |
19345cb2 BH |
93 | extern bool nfs_generic_pg_test(struct nfs_pageio_descriptor *desc, |
94 | struct nfs_page *prev, | |
95 | struct nfs_page *req); | |
1da177e4 LT |
96 | extern int nfs_wait_on_request(struct nfs_page *); |
97 | extern void nfs_unlock_request(struct nfs_page *req); | |
c6a556b8 | 98 | |
1da177e4 | 99 | /* |
c03b4024 | 100 | * Lock the page of an asynchronous request without getting a new reference |
1da177e4 LT |
101 | */ |
102 | static inline int | |
103 | nfs_lock_request_dontget(struct nfs_page *req) | |
104 | { | |
a911fd9a | 105 | return !test_and_set_bit(PG_BUSY, &req->wb_flags); |
1da177e4 LT |
106 | } |
107 | ||
8dd37758 TM |
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 | kref_get(&req->wb_kref); | |
114 | return 1; | |
115 | } | |
116 | ||
117 | ||
3da28eb1 TM |
118 | /** |
119 | * nfs_list_add_request - Insert a request into a list | |
120 | * @req: request | |
121 | * @head: head of list into which to insert the request. | |
122 | */ | |
123 | static inline void | |
124 | nfs_list_add_request(struct nfs_page *req, struct list_head *head) | |
125 | { | |
126 | list_add_tail(&req->wb_list, head); | |
3da28eb1 TM |
127 | } |
128 | ||
1da177e4 LT |
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; | |
1da177e4 | 139 | list_del_init(&req->wb_list); |
1da177e4 LT |
140 | } |
141 | ||
1da177e4 LT |
142 | static inline struct nfs_page * |
143 | nfs_list_entry(struct list_head *head) | |
144 | { | |
145 | return list_entry(head, struct nfs_page, wb_list); | |
146 | } | |
147 | ||
148 | static inline | |
149 | loff_t req_offset(struct nfs_page *req) | |
150 | { | |
151 | return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset; | |
152 | } | |
153 | ||
154 | #endif /* _LINUX_NFS_PAGE_H */ |