Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | #include <linux/sunrpc/auth.h> |
| 17 | #include <linux/nfs_xdr.h> |
| 18 | |
Trond Myklebust | c03b402 | 2007-06-17 13:26:38 -0400 | [diff] [blame] | 19 | #include <linux/kref.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | |
| 21 | /* |
| 22 | * Valid flags for a dirty buffer |
| 23 | */ |
Trond Myklebust | e468bae | 2008-06-13 13:25:22 -0400 | [diff] [blame] | 24 | enum { |
Weston Andros Adamson | 12c0579 | 2014-05-15 11:56:41 -0400 | [diff] [blame] | 25 | 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 Adamson | 2bfc6e5 | 2014-05-15 11:56:45 -0400 | [diff] [blame^] | 29 | PG_INODE_REF, /* extra ref held by inode (head req only) */ |
| 30 | PG_HEADLOCK, /* page group lock of wb_head */ |
| 31 | PG_TEARDOWN, /* page group sync for destroy */ |
Trond Myklebust | e468bae | 2008-06-13 13:25:22 -0400 | [diff] [blame] | 32 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | |
Trond Myklebust | 3da28eb | 2005-06-22 17:16:31 +0000 | [diff] [blame] | 34 | struct nfs_inode; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | struct nfs_page { |
Fred Isaman | d6d6dc7 | 2012-03-08 17:29:35 -0500 | [diff] [blame] | 36 | struct list_head wb_list; /* Defines state of page: */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | struct page *wb_page; /* page to read in/write out */ |
| 38 | struct nfs_open_context *wb_context; /* File state context info */ |
Trond Myklebust | f11ac8d | 2010-06-25 16:35:53 -0400 | [diff] [blame] | 39 | struct nfs_lock_context *wb_lock_context; /* lock context info */ |
Trond Myklebust | ca52fec | 2007-04-17 17:22:13 -0400 | [diff] [blame] | 40 | pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */ |
| 42 | wb_pgbase, /* Start of page data */ |
| 43 | wb_bytes; /* Length of request */ |
Trond Myklebust | c03b402 | 2007-06-17 13:26:38 -0400 | [diff] [blame] | 44 | struct kref wb_kref; /* reference count */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | unsigned long wb_flags; |
Trond Myklebust | 2f2c63b | 2012-06-08 11:56:09 -0400 | [diff] [blame] | 46 | struct nfs_write_verifier wb_verf; /* Commit cookie */ |
Weston Andros Adamson | 2bfc6e5 | 2014-05-15 11:56:45 -0400 | [diff] [blame^] | 47 | struct nfs_page *wb_this_page; /* list of reqs for this page */ |
| 48 | struct nfs_page *wb_head; /* head pointer for req list */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | }; |
| 50 | |
Trond Myklebust | 1751c36 | 2011-06-10 13:30:23 -0400 | [diff] [blame] | 51 | struct nfs_pageio_descriptor; |
| 52 | struct nfs_pageio_ops { |
Trond Myklebust | d8007d4 | 2011-06-10 13:30:23 -0400 | [diff] [blame] | 53 | void (*pg_init)(struct nfs_pageio_descriptor *, struct nfs_page *); |
Weston Andros Adamson | b4fdac1 | 2014-05-15 11:56:43 -0400 | [diff] [blame] | 54 | size_t (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, |
| 55 | struct nfs_page *); |
Trond Myklebust | 1751c36 | 2011-06-10 13:30:23 -0400 | [diff] [blame] | 56 | int (*pg_doio)(struct nfs_pageio_descriptor *); |
| 57 | }; |
| 58 | |
Anna Schumaker | 4a0de55 | 2014-05-06 09:12:30 -0400 | [diff] [blame] | 59 | struct nfs_rw_ops { |
Anna Schumaker | a4cdda5 | 2014-05-06 09:12:31 -0400 | [diff] [blame] | 60 | const fmode_t rw_mode; |
Anna Schumaker | 4a0de55 | 2014-05-06 09:12:30 -0400 | [diff] [blame] | 61 | struct nfs_rw_header *(*rw_alloc_header)(void); |
| 62 | void (*rw_free_header)(struct nfs_rw_header *); |
Anna Schumaker | a4cdda5 | 2014-05-06 09:12:31 -0400 | [diff] [blame] | 63 | void (*rw_release)(struct nfs_pgio_data *); |
Anna Schumaker | 0eecb21 | 2014-05-06 09:12:32 -0400 | [diff] [blame] | 64 | int (*rw_done)(struct rpc_task *, struct nfs_pgio_data *, struct inode *); |
| 65 | void (*rw_result)(struct rpc_task *, struct nfs_pgio_data *); |
Anna Schumaker | 1ed26f3 | 2014-05-06 09:12:37 -0400 | [diff] [blame] | 66 | void (*rw_initiate)(struct nfs_pgio_data *, struct rpc_message *, |
| 67 | struct rpc_task_setup *, int); |
Anna Schumaker | 4a0de55 | 2014-05-06 09:12:30 -0400 | [diff] [blame] | 68 | }; |
| 69 | |
Trond Myklebust | d8a5ad7 | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 70 | struct nfs_pageio_descriptor { |
| 71 | struct list_head pg_list; |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 72 | unsigned long pg_bytes_written; |
Trond Myklebust | d8a5ad7 | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 73 | size_t pg_count; |
| 74 | size_t pg_bsize; |
| 75 | unsigned int pg_base; |
Trond Myklebust | d9156f9 | 2011-07-12 13:42:02 -0400 | [diff] [blame] | 76 | unsigned char pg_moreio : 1, |
| 77 | pg_recoalesce : 1; |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 78 | |
| 79 | struct inode *pg_inode; |
Trond Myklebust | 1751c36 | 2011-06-10 13:30:23 -0400 | [diff] [blame] | 80 | const struct nfs_pageio_ops *pg_ops; |
Anna Schumaker | 4a0de55 | 2014-05-06 09:12:30 -0400 | [diff] [blame] | 81 | const struct nfs_rw_ops *pg_rw_ops; |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 82 | int pg_ioflags; |
| 83 | int pg_error; |
Trond Myklebust | 50828d7 | 2011-07-12 13:42:02 -0400 | [diff] [blame] | 84 | const struct rpc_call_ops *pg_rpc_callops; |
Fred Isaman | 061ae2e | 2012-04-20 14:47:48 -0400 | [diff] [blame] | 85 | const struct nfs_pgio_completion_ops *pg_completion_ops; |
Fred Isaman | 94ad1c8 | 2011-03-01 01:34:14 +0000 | [diff] [blame] | 86 | struct pnfs_layout_segment *pg_lseg; |
Fred Isaman | 584aa81 | 2012-04-20 14:47:51 -0400 | [diff] [blame] | 87 | struct nfs_direct_req *pg_dreq; |
Peng Tao | f616638 | 2012-08-02 15:36:09 +0300 | [diff] [blame] | 88 | void *pg_layout_private; |
Trond Myklebust | d8a5ad7 | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 89 | }; |
| 90 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | #define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 92 | |
| 93 | extern struct nfs_page *nfs_create_request(struct nfs_open_context *ctx, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | struct page *page, |
Weston Andros Adamson | 2bfc6e5 | 2014-05-15 11:56:45 -0400 | [diff] [blame^] | 95 | struct nfs_page *last, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 96 | unsigned int offset, |
| 97 | unsigned int count); |
Weston Andros Adamson | 2bfc6e5 | 2014-05-15 11:56:45 -0400 | [diff] [blame^] | 98 | extern void nfs_release_request(struct nfs_page *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 99 | |
| 100 | |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 101 | extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc, |
| 102 | struct inode *inode, |
Trond Myklebust | 1751c36 | 2011-06-10 13:30:23 -0400 | [diff] [blame] | 103 | const struct nfs_pageio_ops *pg_ops, |
Fred Isaman | 061ae2e | 2012-04-20 14:47:48 -0400 | [diff] [blame] | 104 | const struct nfs_pgio_completion_ops *compl_ops, |
Anna Schumaker | 4a0de55 | 2014-05-06 09:12:30 -0400 | [diff] [blame] | 105 | const struct nfs_rw_ops *rw_ops, |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 106 | size_t bsize, |
| 107 | int how); |
Trond Myklebust | 8b09bee | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 108 | extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *, |
| 109 | struct nfs_page *); |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 110 | extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc); |
Trond Myklebust | 7fe7f84 | 2007-05-20 10:18:27 -0400 | [diff] [blame] | 111 | extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t); |
Weston Andros Adamson | b4fdac1 | 2014-05-15 11:56:43 -0400 | [diff] [blame] | 112 | extern size_t nfs_generic_pg_test(struct nfs_pageio_descriptor *desc, |
Benny Halevy | 19345cb | 2011-06-19 18:33:46 -0400 | [diff] [blame] | 113 | struct nfs_page *prev, |
| 114 | struct nfs_page *req); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 115 | extern int nfs_wait_on_request(struct nfs_page *); |
| 116 | extern void nfs_unlock_request(struct nfs_page *req); |
Weston Andros Adamson | 2bfc6e5 | 2014-05-15 11:56:45 -0400 | [diff] [blame^] | 117 | extern void nfs_unlock_and_release_request(struct nfs_page *); |
| 118 | extern void nfs_page_group_lock(struct nfs_page *); |
| 119 | extern void nfs_page_group_unlock(struct nfs_page *); |
| 120 | extern bool nfs_page_group_sync_on_bit(struct nfs_page *, unsigned int); |
Trond Myklebust | c6a556b | 2005-06-22 17:16:30 +0000 | [diff] [blame] | 121 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | /* |
Trond Myklebust | 7ad84aa | 2012-05-09 13:19:15 -0400 | [diff] [blame] | 123 | * Lock the page of an asynchronous request |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | */ |
| 125 | static inline int |
Trond Myklebust | 8dd3775 | 2012-03-15 17:16:40 -0400 | [diff] [blame] | 126 | nfs_lock_request(struct nfs_page *req) |
| 127 | { |
Trond Myklebust | 7ad84aa | 2012-05-09 13:19:15 -0400 | [diff] [blame] | 128 | return !test_and_set_bit(PG_BUSY, &req->wb_flags); |
Trond Myklebust | 8dd3775 | 2012-03-15 17:16:40 -0400 | [diff] [blame] | 129 | } |
| 130 | |
Trond Myklebust | 3da28eb | 2005-06-22 17:16:31 +0000 | [diff] [blame] | 131 | /** |
| 132 | * nfs_list_add_request - Insert a request into a list |
| 133 | * @req: request |
| 134 | * @head: head of list into which to insert the request. |
| 135 | */ |
| 136 | static inline void |
| 137 | nfs_list_add_request(struct nfs_page *req, struct list_head *head) |
| 138 | { |
| 139 | list_add_tail(&req->wb_list, head); |
Trond Myklebust | 3da28eb | 2005-06-22 17:16:31 +0000 | [diff] [blame] | 140 | } |
| 141 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | |
| 143 | /** |
| 144 | * nfs_list_remove_request - Remove a request from its wb_list |
| 145 | * @req: request |
| 146 | */ |
| 147 | static inline void |
| 148 | nfs_list_remove_request(struct nfs_page *req) |
| 149 | { |
| 150 | if (list_empty(&req->wb_list)) |
| 151 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | list_del_init(&req->wb_list); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | } |
| 154 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | static inline struct nfs_page * |
| 156 | nfs_list_entry(struct list_head *head) |
| 157 | { |
| 158 | return list_entry(head, struct nfs_page, wb_list); |
| 159 | } |
| 160 | |
| 161 | static inline |
| 162 | loff_t req_offset(struct nfs_page *req) |
| 163 | { |
| 164 | return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset; |
| 165 | } |
| 166 | |
| 167 | #endif /* _LINUX_NFS_PAGE_H */ |