blob: f2f650f136ee6fe181dfa27b71d7b944fc1f9357 [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 {
Weston Andros Adamson12c05792014-05-15 11:56:41 -040025 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 */
Weston Andros Adamsonb412ddf2014-07-17 20:42:16 -040029 PG_INODE_REF, /* extra ref held by inode when in writeback */
Weston Andros Adamson2bfc6e52014-05-15 11:56:45 -040030 PG_HEADLOCK, /* page group lock of wb_head */
31 PG_TEARDOWN, /* page group sync for destroy */
Weston Andros Adamson67d03382014-05-15 11:56:46 -040032 PG_UNLOCKPAGE, /* page group sync bit in read path */
33 PG_UPTODATE, /* page group sync bit in read path */
Weston Andros Adamson20633f02014-05-15 11:56:47 -040034 PG_WB_END, /* page group sync bit in write path */
35 PG_REMOVE, /* page group sync bit in write path */
Trond Myklebuste468bae2008-06-13 13:25:22 -040036};
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Trond Myklebust3da28eb2005-06-22 17:16:31 +000038struct nfs_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039struct nfs_page {
Fred Isamand6d6dc72012-03-08 17:29:35 -050040 struct list_head wb_list; /* Defines state of page: */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 struct page *wb_page; /* page to read in/write out */
42 struct nfs_open_context *wb_context; /* File state context info */
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040043 struct nfs_lock_context *wb_lock_context; /* lock context info */
Trond Myklebustca52fec2007-04-17 17:22:13 -040044 pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */
46 wb_pgbase, /* Start of page data */
47 wb_bytes; /* Length of request */
Trond Myklebustc03b4022007-06-17 13:26:38 -040048 struct kref wb_kref; /* reference count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 unsigned long wb_flags;
Trond Myklebust2f2c63b2012-06-08 11:56:09 -040050 struct nfs_write_verifier wb_verf; /* Commit cookie */
Weston Andros Adamson2bfc6e52014-05-15 11:56:45 -040051 struct nfs_page *wb_this_page; /* list of reqs for this page */
52 struct nfs_page *wb_head; /* head pointer for req list */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053};
54
Trond Myklebust1751c362011-06-10 13:30:23 -040055struct nfs_pageio_descriptor;
56struct nfs_pageio_ops {
Trond Myklebustd8007d42011-06-10 13:30:23 -040057 void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *);
Weston Andros Adamsonb4fdac12014-05-15 11:56:43 -040058 size_t (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *,
59 struct nfs_page *);
Trond Myklebust1751c362011-06-10 13:30:23 -040060 int (*pg_doio)(struct nfs_pageio_descriptor *);
Weston Andros Adamsona7d42dd2014-09-19 10:55:07 -040061 unsigned int (*pg_get_mirror_count)(struct nfs_pageio_descriptor *,
62 struct nfs_page *);
Weston Andros Adamson2176bf42014-09-10 15:44:18 -040063 void (*pg_cleanup)(struct nfs_pageio_descriptor *);
Trond Myklebust1751c362011-06-10 13:30:23 -040064};
65
Anna Schumaker4a0de552014-05-06 09:12:30 -040066struct nfs_rw_ops {
Anna Schumakera4cdda52014-05-06 09:12:31 -040067 const fmode_t rw_mode;
Weston Andros Adamson1e7f3a42014-06-09 11:48:33 -040068 struct nfs_pgio_header *(*rw_alloc_header)(void);
69 void (*rw_free_header)(struct nfs_pgio_header *);
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -040070 int (*rw_done)(struct rpc_task *, struct nfs_pgio_header *,
71 struct inode *);
72 void (*rw_result)(struct rpc_task *, struct nfs_pgio_header *);
73 void (*rw_initiate)(struct nfs_pgio_header *, struct rpc_message *,
Tom Haynesabde71f2014-06-09 13:12:20 -070074 const struct nfs_rpc_ops *,
Anna Schumaker1ed26f32014-05-06 09:12:37 -040075 struct rpc_task_setup *, int);
Anna Schumaker4a0de552014-05-06 09:12:30 -040076};
77
Weston Andros Adamsona7d42dd2014-09-19 10:55:07 -040078struct nfs_pgio_mirror {
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040079 struct list_head pg_list;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040080 unsigned long pg_bytes_written;
Trond Myklebustd8a5ad72007-04-02 18:48:28 -040081 size_t pg_count;
82 size_t pg_bsize;
83 unsigned int pg_base;
Weston Andros Adamsona7d42dd2014-09-19 10:55:07 -040084 unsigned char pg_recoalesce : 1;
85};
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040086
Weston Andros Adamsona7d42dd2014-09-19 10:55:07 -040087struct nfs_pageio_descriptor {
88 unsigned char pg_moreio : 1;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040089 struct inode *pg_inode;
Trond Myklebust1751c362011-06-10 13:30:23 -040090 const struct nfs_pageio_ops *pg_ops;
Anna Schumaker4a0de552014-05-06 09:12:30 -040091 const struct nfs_rw_ops *pg_rw_ops;
Trond Myklebustbcb71bb2007-04-02 18:48:28 -040092 int pg_ioflags;
93 int pg_error;
Trond Myklebust50828d72011-07-12 13:42:02 -040094 const struct rpc_call_ops *pg_rpc_callops;
Fred Isaman061ae2e2012-04-20 14:47:48 -040095 const struct nfs_pgio_completion_ops *pg_completion_ops;
Fred Isaman94ad1c82011-03-01 01:34:14 +000096 struct pnfs_layout_segment *pg_lseg;
Fred Isaman584aa812012-04-20 14:47:51 -040097 struct nfs_direct_req *pg_dreq;
Peng Taof6166382012-08-02 15:36:09 +030098 void *pg_layout_private;
Weston Andros Adamsona7d42dd2014-09-19 10:55:07 -040099 unsigned int pg_bsize; /* default bsize for mirrors */
100
101 u32 pg_mirror_count;
102 struct nfs_pgio_mirror *pg_mirrors;
103 struct nfs_pgio_mirror pg_mirrors_static[1];
104 struct nfs_pgio_mirror *pg_mirrors_dynamic;
105 u32 pg_mirror_idx; /* current mirror */
Trond Myklebustd8a5ad72007-04-02 18:48:28 -0400106};
107
Weston Andros Adamsona7d42dd2014-09-19 10:55:07 -0400108/* arbitrarily selected limit to number of mirrors */
109#define NFS_PAGEIO_DESCRIPTOR_MIRROR_MAX 16
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 struct page *page,
Weston Andros Adamson2bfc6e52014-05-15 11:56:45 -0400115 struct nfs_page *last,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 unsigned int offset,
117 unsigned int count);
Weston Andros Adamson2bfc6e52014-05-15 11:56:45 -0400118extern void nfs_release_request(struct nfs_page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120
Trond Myklebustbcb71bb2007-04-02 18:48:28 -0400121extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
122 struct inode *inode,
Trond Myklebust1751c362011-06-10 13:30:23 -0400123 const struct nfs_pageio_ops *pg_ops,
Fred Isaman061ae2e2012-04-20 14:47:48 -0400124 const struct nfs_pgio_completion_ops *compl_ops,
Anna Schumaker4a0de552014-05-06 09:12:30 -0400125 const struct nfs_rw_ops *rw_ops,
Trond Myklebustbcb71bb2007-04-02 18:48:28 -0400126 size_t bsize,
127 int how);
Trond Myklebust8b09bee2007-04-02 18:48:28 -0400128extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *,
129 struct nfs_page *);
Weston Andros Adamson53113ad2014-06-09 11:48:38 -0400130extern int nfs_pageio_resend(struct nfs_pageio_descriptor *,
131 struct nfs_pgio_header *);
Trond Myklebustbcb71bb2007-04-02 18:48:28 -0400132extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc);
Trond Myklebust7fe7f842007-05-20 10:18:27 -0400133extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t);
Weston Andros Adamsonb4fdac12014-05-15 11:56:43 -0400134extern size_t nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
Benny Halevy19345cb2011-06-19 18:33:46 -0400135 struct nfs_page *prev,
136 struct nfs_page *req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137extern int nfs_wait_on_request(struct nfs_page *);
138extern void nfs_unlock_request(struct nfs_page *req);
Weston Andros Adamson2bfc6e52014-05-15 11:56:45 -0400139extern void nfs_unlock_and_release_request(struct nfs_page *);
Weston Andros Adamsone7029202014-07-17 20:42:15 -0400140extern int nfs_page_group_lock(struct nfs_page *, bool);
Weston Andros Adamson7c3af972014-08-08 11:00:57 -0400141extern void nfs_page_group_lock_wait(struct nfs_page *);
Weston Andros Adamson2bfc6e52014-05-15 11:56:45 -0400142extern void nfs_page_group_unlock(struct nfs_page *);
143extern bool nfs_page_group_sync_on_bit(struct nfs_page *, unsigned int);
Trond Myklebustc6a556b2005-06-22 17:16:30 +0000144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145/*
Trond Myklebust7ad84aa2012-05-09 13:19:15 -0400146 * Lock the page of an asynchronous request
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 */
148static inline int
Trond Myklebust8dd37752012-03-15 17:16:40 -0400149nfs_lock_request(struct nfs_page *req)
150{
Trond Myklebust7ad84aa2012-05-09 13:19:15 -0400151 return !test_and_set_bit(PG_BUSY, &req->wb_flags);
Trond Myklebust8dd37752012-03-15 17:16:40 -0400152}
153
Trond Myklebust3da28eb2005-06-22 17:16:31 +0000154/**
155 * nfs_list_add_request - Insert a request into a list
156 * @req: request
157 * @head: head of list into which to insert the request.
158 */
159static inline void
160nfs_list_add_request(struct nfs_page *req, struct list_head *head)
161{
162 list_add_tail(&req->wb_list, head);
Trond Myklebust3da28eb2005-06-22 17:16:31 +0000163}
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
166/**
167 * nfs_list_remove_request - Remove a request from its wb_list
168 * @req: request
169 */
170static inline void
171nfs_list_remove_request(struct nfs_page *req)
172{
173 if (list_empty(&req->wb_list))
174 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 list_del_init(&req->wb_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176}
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178static inline struct nfs_page *
179nfs_list_entry(struct list_head *head)
180{
181 return list_entry(head, struct nfs_page, wb_list);
182}
183
184static inline
185loff_t req_offset(struct nfs_page *req)
186{
187 return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset;
188}
189
190#endif /* _LINUX_NFS_PAGE_H */