2 * linux/include/linux/nfs_page.h
4 * Copyright (C) 2000 Trond Myklebust
6 * NFS page cache wrapper.
9 #ifndef _LINUX_NFS_PAGE_H
10 #define _LINUX_NFS_PAGE_H
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>
19 #include <linux/kref.h>
22 * Valid flags for a dirty buffer
35 struct list_head wb_list; /* Defines state of page: */
36 struct page *wb_page; /* page to read in/write out */
37 struct nfs_open_context *wb_context; /* File state context info */
38 struct nfs_lock_context *wb_lock_context; /* lock context info */
39 pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */
40 unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */
41 wb_pgbase, /* Start of page data */
42 wb_bytes; /* Length of request */
43 struct kref wb_kref; /* reference count */
44 unsigned long wb_flags;
45 struct nfs_write_verifier wb_verf; /* Commit cookie */
48 struct nfs_pageio_descriptor;
49 struct nfs_pageio_ops {
50 void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
51 bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
52 int (*pg_doio)(struct nfs_pageio_descriptor *);
56 const fmode_t rw_mode;
57 struct nfs_rw_header *(*rw_alloc_header)(void);
58 void (*rw_free_header)(struct nfs_rw_header *);
59 void (*rw_release)(struct nfs_pgio_data *);
60 int (*rw_done)(struct rpc_task *, struct nfs_pgio_data *, struct inode *);
61 void (*rw_result)(struct rpc_task *, struct nfs_pgio_data *);
64 struct nfs_pageio_descriptor {
65 struct list_head pg_list;
66 unsigned long pg_bytes_written;
70 unsigned char pg_moreio : 1,
73 struct inode *pg_inode;
74 const struct nfs_pageio_ops *pg_ops;
75 const struct nfs_rw_ops *pg_rw_ops;
78 const struct rpc_call_ops *pg_rpc_callops;
79 const struct nfs_pgio_completion_ops *pg_completion_ops;
80 struct pnfs_layout_segment *pg_lseg;
81 struct nfs_direct_req *pg_dreq;
82 void *pg_layout_private;
85 #define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags))
87 extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
92 extern void nfs_release_request(struct nfs_page *req);
95 extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
97 const struct nfs_pageio_ops *pg_ops,
98 const struct nfs_pgio_completion_ops *compl_ops,
99 const struct nfs_rw_ops *rw_ops,
102 extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
104 extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
105 extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
106 extern bool nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
107 struct nfs_page *prev,
108 struct nfs_page *req);
109 extern int nfs_wait_on_request(struct nfs_page *);
110 extern void nfs_unlock_request(struct nfs_page *req);
111 extern void nfs_unlock_and_release_request(struct nfs_page *req);
114 * Lock the page of an asynchronous request
117 nfs_lock_request(struct nfs_page *req)
119 return !test_and_set_bit(PG_BUSY, &req->wb_flags);
123 * nfs_list_add_request - Insert a request into a list
125 * @head: head of list into which to insert the request.
128 nfs_list_add_request(struct nfs_page *req, struct list_head *head)
130 list_add_tail(&req->wb_list, head);
135 * nfs_list_remove_request - Remove a request from its wb_list
139 nfs_list_remove_request(struct nfs_page *req)
141 if (list_empty(&req->wb_list))
143 list_del_init(&req->wb_list);
146 static inline struct nfs_page *
147 nfs_list_entry(struct list_head *head)
149 return list_entry(head, struct nfs_page, wb_list);
153 loff_t req_offset(struct nfs_page *req)
155 return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
158 #endif /* _LINUX_NFS_PAGE_H */