blob: ab465fe8c3d6fe2d3e9f204b3a013bd22fb14038 [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/*
Trond Myklebustc6a556b2005-06-22 17:16:30 +000022 * Valid flags for the radix tree
23 */
Trond Myklebust9fd367f2007-06-17 15:10:24 -040024#define NFS_PAGE_TAG_LOCKED 0
Trond Myklebust5c369682007-06-17 15:27:42 -040025#define NFS_PAGE_TAG_COMMIT 1
Trond Myklebustc6a556b2005-06-22 17:16:30 +000026
27/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * Valid flags for a dirty buffer
29 */
Trond Myklebuste468bae2008-06-13 13:25:22 -040030enum {
31 PG_BUSY = 0,
Trond Myklebust2df485a2010-12-07 22:39:17 -050032 PG_MAPPED,
Trond Myklebuste468bae2008-06-13 13:25:22 -040033 PG_CLEAN,
34 PG_NEED_COMMIT,
35 PG_NEED_RESCHED,
Fred Isamana861a1e2011-03-23 13:27:51 +000036 PG_PNFS_COMMIT,
Trond Myklebustfba73002011-10-19 12:17:29 -070037 PG_PARTIAL_READ_FAILED,
Trond Myklebuste468bae2008-06-13 13:25:22 -040038};
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Trond Myklebust3da28eb2005-06-22 17:16:31 +000040struct nfs_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041struct nfs_page {
Fred Isamana861a1e2011-03-23 13:27:51 +000042 union {
43 struct list_head wb_list; /* Defines state of page: */
44 struct pnfs_layout_segment *wb_commit_lseg; /* Used when PG_PNFS_COMMIT set */
45 };
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 struct page *wb_page; /* page to read in/write out */
47 struct nfs_open_context *wb_context; /* File state context info */
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040048 struct nfs_lock_context *wb_lock_context; /* lock context info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 atomic_t wb_complete; /* i/os we're waiting for */
Trond Myklebustca52fec2007-04-17 17:22:13 -040050 pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */
52 wb_pgbase, /* Start of page data */
53 wb_bytes; /* Length of request */
Trond Myklebustc03b4022007-06-17 13:26:38 -040054 struct kref wb_kref; /* reference count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 unsigned long wb_flags;
56 struct nfs_writeverf wb_verf; /* Commit cookie */
57};
58
Trond Myklebust1751c362011-06-10 13:30:23 -040059struct nfs_pageio_descriptor;
60struct nfs_pageio_ops {
Trond Myklebustd8007d42011-06-10 13:30:23 -040061 void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
Trond Myklebust1751c362011-06-10 13:30:23 -040062 bool (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
63 int (*pg_doio)(struct nfs_pageio_descriptor *);
64};
65
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040066struct nfs_pageio_descriptor {
67 struct list_head pg_list;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040068 unsigned long pg_bytes_written;
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040069 size_t pg_count;
70 size_t pg_bsize;
71 unsigned int pg_base;
Trond Myklebustd9156f92011-07-12 13:42:02 -040072 unsigned char pg_moreio : 1,
73 pg_recoalesce : 1;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040074
75 struct inode *pg_inode;
Trond Myklebust1751c362011-06-10 13:30:23 -040076 const struct nfs_pageio_ops *pg_ops;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040077 int pg_ioflags;
78 int pg_error;
Trond Myklebust50828d72011-07-12 13:42:02 -040079 const struct rpc_call_ops *pg_rpc_callops;
Fred Isaman94ad1c82011-03-01 01:34:14 +000080 struct pnfs_layout_segment *pg_lseg;
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040081};
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
86 struct inode *inode,
87 struct page *page,
88 unsigned int offset,
89 unsigned int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090extern void nfs_release_request(struct nfs_page *req);
91
92
Trond Myklebust5c369682007-06-17 15:27:42 -040093extern int nfs_scan_list(struct nfs_inode *nfsi, struct list_head *dst,
94 pgoff_t idx_start, unsigned int npages, int tag);
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040095extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
96 struct inode *inode,
Trond Myklebust1751c362011-06-10 13:30:23 -040097 const struct nfs_pageio_ops *pg_ops,
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040098 size_t bsize,
99 int how);
Trond Myklebust8b09bee2007-04-02 18:48:28 -0400100extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
101 struct nfs_page *);
Trond Myklebustbcb71bb2007-04-02 18:48:28 -0400102extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
Trond Myklebust7fe7f842007-05-20 10:18:27 -0400103extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
Benny Halevy19345cb2011-06-19 18:33:46 -0400104extern bool nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
105 struct nfs_page *prev,
106 struct nfs_page *req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107extern int nfs_wait_on_request(struct nfs_page *);
108extern void nfs_unlock_request(struct nfs_page *req);
Trond Myklebustacee4782008-01-22 17:13:07 -0500109extern int nfs_set_page_tag_locked(struct nfs_page *req);
Trond Myklebust9fd367f2007-06-17 15:10:24 -0400110extern void nfs_clear_page_tag_locked(struct nfs_page *req);
Trond Myklebustc6a556b2005-06-22 17:16:30 +0000111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/*
Trond Myklebustc03b4022007-06-17 13:26:38 -0400113 * Lock the page of an asynchronous request without getting a new reference
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 */
115static inline int
116nfs_lock_request_dontget(struct nfs_page *req)
117{
Chuck Levera911fd92005-11-30 18:08:59 -0500118 return !test_and_set_bit(PG_BUSY, &req->wb_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119}
120
Trond Myklebust3da28eb2005-06-22 17:16:31 +0000121/**
122 * nfs_list_add_request - Insert a request into a list
123 * @req: request
124 * @head: head of list into which to insert the request.
125 */
126static inline void
127nfs_list_add_request(struct nfs_page *req, struct list_head *head)
128{
129 list_add_tail(&req->wb_list, head);
Trond Myklebust3da28eb2005-06-22 17:16:31 +0000130}
131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133/**
134 * nfs_list_remove_request - Remove a request from its wb_list
135 * @req: request
136 */
137static inline void
138nfs_list_remove_request(struct nfs_page *req)
139{
140 if (list_empty(&req->wb_list))
141 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 list_del_init(&req->wb_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143}
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145static inline struct nfs_page *
146nfs_list_entry(struct list_head *head)
147{
148 return list_entry(head, struct nfs_page, wb_list);
149}
150
151static inline
152loff_t req_offset(struct nfs_page *req)
153{
154 return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
155}
156
157#endif /* _LINUX_NFS_PAGE_H */