blob: eac30d6bec17c78db77a050e269ae0336e00e372 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/sunrpc/auth.h>
17#include <linux/nfs_xdr.h>
18
Trond Myklebustc03b4022007-06-17 13:26:38 -040019#include <linux/kref.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21/*
22 * Valid flags for a dirty buffer
23 */
Trond Myklebuste468bae2008-06-13 13:25:22 -040024enum {
25 PG_BUSY = 0,
Trond Myklebust2df485a2010-12-07 22:39:17 -050026 PG_MAPPED,
Trond Myklebuste468bae2008-06-13 13:25:22 -040027 PG_CLEAN,
28 PG_NEED_COMMIT,
29 PG_NEED_RESCHED,
Trond Myklebustfba73002011-10-19 12:17:29 -070030 PG_PARTIAL_READ_FAILED,
Trond Myklebust8dd37752012-03-15 17:16:40 -040031 PG_COMMIT_TO_DS,
Trond Myklebuste468bae2008-06-13 13:25:22 -040032};
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Trond Myklebust3da28eb2005-06-22 17:16:31 +000034struct nfs_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035struct nfs_page {
Fred Isamand6d6dc72012-03-08 17:29:35 -050036 struct list_head wb_list; /* Defines state of page: */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 struct page *wb_page; /* page to read in/write out */
38 struct nfs_open_context *wb_context; /* File state context info */
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040039 struct nfs_lock_context *wb_lock_context; /* lock context info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 atomic_t wb_complete; /* i/os we're waiting for */
Trond Myklebustca52fec2007-04-17 17:22:13 -040041 pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */
43 wb_pgbase, /* Start of page data */
44 wb_bytes; /* Length of request */
Trond Myklebustc03b4022007-06-17 13:26:38 -040045 struct kref wb_kref; /* reference count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 unsigned long wb_flags;
47 struct nfs_writeverf wb_verf; /* Commit cookie */
48};
49
Trond Myklebust1751c362011-06-10 13:30:23 -040050struct nfs_pageio_descriptor;
51struct nfs_pageio_ops {
Trond Myklebustd8007d42011-06-10 13:30:23 -040052 void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
Trond Myklebust1751c362011-06-10 13:30:23 -040053 bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
54 int (*pg_doio)(struct nfs_pageio_descriptor *);
55};
56
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040057struct nfs_pageio_descriptor {
58 struct list_head pg_list;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040059 unsigned long pg_bytes_written;
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040060 size_t pg_count;
61 size_t pg_bsize;
62 unsigned int pg_base;
Trond Myklebustd9156f92011-07-12 13:42:02 -040063 unsigned char pg_moreio : 1,
64 pg_recoalesce : 1;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040065
66 struct inode *pg_inode;
Trond Myklebust1751c362011-06-10 13:30:23 -040067 const struct nfs_pageio_ops *pg_ops;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040068 int pg_ioflags;
69 int pg_error;
Trond Myklebust50828d72011-07-12 13:42:02 -040070 const struct rpc_call_ops *pg_rpc_callops;
Fred Isaman94ad1c82011-03-01 01:34:14 +000071 struct pnfs_layout_segment *pg_lseg;
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040072};
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074#define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
77 struct inode *inode,
78 struct page *page,
79 unsigned int offset,
80 unsigned int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081extern void nfs_release_request(struct nfs_page *req);
82
83
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040084extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
85 struct inode *inode,
Trond Myklebust1751c362011-06-10 13:30:23 -040086 const struct nfs_pageio_ops *pg_ops,
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040087 size_t bsize,
88 int how);
Trond Myklebust8b09bee2007-04-02 18:48:28 -040089extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
90 struct nfs_page *);
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040091extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
Trond Myklebust7fe7f842007-05-20 10:18:27 -040092extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
Benny Halevy19345cb2011-06-19 18:33:46 -040093extern bool nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
94 struct nfs_page *prev,
95 struct nfs_page *req);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096extern int nfs_wait_on_request(struct nfs_page *);
97extern void nfs_unlock_request(struct nfs_page *req);
Trond Myklebustc6a556b2005-06-22 17:16:30 +000098
Linus Torvalds1da177e2005-04-16 15:20:36 -070099/*
Trond Myklebustc03b4022007-06-17 13:26:38 -0400100 * Lock the page of an asynchronous request without getting a new reference
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 */
102static inline int
103nfs_lock_request_dontget(struct nfs_page *req)
104{
Chuck Levera911fd92005-11-30 18:08:59 -0500105 return !test_and_set_bit(PG_BUSY, &req->wb_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106}
107
Trond Myklebust8dd37752012-03-15 17:16:40 -0400108static inline int
109nfs_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
Trond Myklebust3da28eb2005-06-22 17:16:31 +0000118/**
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 */
123static inline void
124nfs_list_add_request(struct nfs_page *req, struct list_head *head)
125{
126 list_add_tail(&req->wb_list, head);
Trond Myklebust3da28eb2005-06-22 17:16:31 +0000127}
128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130/**
131 * nfs_list_remove_request - Remove a request from its wb_list
132 * @req: request
133 */
134static inline void
135nfs_list_remove_request(struct nfs_page *req)
136{
137 if (list_empty(&req->wb_list))
138 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 list_del_init(&req->wb_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140}
141
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142static inline struct nfs_page *
143nfs_list_entry(struct list_head *head)
144{
145 return list_entry(head, struct nfs_page, wb_list);
146}
147
148static inline
149loff_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 */