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 | /* |
Trond Myklebust | c6a556b | 2005-06-22 17:16:30 +0000 | [diff] [blame] | 22 | * Valid flags for the radix tree |
| 23 | */ |
Trond Myklebust | 9fd367f | 2007-06-17 15:10:24 -0400 | [diff] [blame] | 24 | #define NFS_PAGE_TAG_LOCKED 0 |
Trond Myklebust | 5c36968 | 2007-06-17 15:27:42 -0400 | [diff] [blame] | 25 | #define NFS_PAGE_TAG_COMMIT 1 |
Trond Myklebust | c6a556b | 2005-06-22 17:16:30 +0000 | [diff] [blame] | 26 | |
| 27 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | * Valid flags for a dirty buffer |
| 29 | */ |
Trond Myklebust | e468bae | 2008-06-13 13:25:22 -0400 | [diff] [blame] | 30 | enum { |
| 31 | PG_BUSY = 0, |
Trond Myklebust | 2df485a | 2010-12-07 22:39:17 -0500 | [diff] [blame] | 32 | PG_MAPPED, |
Trond Myklebust | e468bae | 2008-06-13 13:25:22 -0400 | [diff] [blame] | 33 | PG_CLEAN, |
| 34 | PG_NEED_COMMIT, |
| 35 | PG_NEED_RESCHED, |
Fred Isaman | a861a1e | 2011-03-23 13:27:51 +0000 | [diff] [blame] | 36 | PG_PNFS_COMMIT, |
Trond Myklebust | e468bae | 2008-06-13 13:25:22 -0400 | [diff] [blame] | 37 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | |
Trond Myklebust | 3da28eb | 2005-06-22 17:16:31 +0000 | [diff] [blame] | 39 | struct nfs_inode; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 40 | struct nfs_page { |
Fred Isaman | a861a1e | 2011-03-23 13:27:51 +0000 | [diff] [blame] | 41 | union { |
| 42 | struct list_head wb_list; /* Defines state of page: */ |
| 43 | struct pnfs_layout_segment *wb_commit_lseg; /* Used when PG_PNFS_COMMIT set */ |
| 44 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | struct page *wb_page; /* page to read in/write out */ |
| 46 | struct nfs_open_context *wb_context; /* File state context info */ |
Trond Myklebust | f11ac8d | 2010-06-25 16:35:53 -0400 | [diff] [blame] | 47 | struct nfs_lock_context *wb_lock_context; /* lock context info */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | atomic_t wb_complete; /* i/os we're waiting for */ |
Trond Myklebust | ca52fec | 2007-04-17 17:22:13 -0400 | [diff] [blame] | 49 | pgoff_t wb_index; /* Offset >> PAGE_CACHE_SHIFT */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | unsigned int wb_offset, /* Offset & ~PAGE_CACHE_MASK */ |
| 51 | wb_pgbase, /* Start of page data */ |
| 52 | wb_bytes; /* Length of request */ |
Trond Myklebust | c03b402 | 2007-06-17 13:26:38 -0400 | [diff] [blame] | 53 | struct kref wb_kref; /* reference count */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | unsigned long wb_flags; |
| 55 | struct nfs_writeverf wb_verf; /* Commit cookie */ |
| 56 | }; |
| 57 | |
Trond Myklebust | d8a5ad7 | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 58 | struct nfs_pageio_descriptor { |
| 59 | struct list_head pg_list; |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 60 | unsigned long pg_bytes_written; |
Trond Myklebust | d8a5ad7 | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 61 | size_t pg_count; |
| 62 | size_t pg_bsize; |
| 63 | unsigned int pg_base; |
Trond Myklebust | b31268a | 2011-03-21 17:02:00 -0400 | [diff] [blame] | 64 | char pg_moreio; |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 65 | |
| 66 | struct inode *pg_inode; |
Fred Isaman | c76069b | 2011-03-03 15:13:48 +0000 | [diff] [blame] | 67 | int (*pg_doio)(struct nfs_pageio_descriptor *); |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 68 | int pg_ioflags; |
| 69 | int pg_error; |
Fred Isaman | 94ad1c8 | 2011-03-01 01:34:14 +0000 | [diff] [blame] | 70 | struct pnfs_layout_segment *pg_lseg; |
| 71 | int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *); |
Trond Myklebust | d8a5ad7 | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 72 | }; |
| 73 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | #define NFS_WBACK_BUSY(req) (test_bit(PG_BUSY,&(req)->wb_flags)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | |
| 76 | extern 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | extern void nfs_release_request(struct nfs_page *req); |
| 82 | |
| 83 | |
Trond Myklebust | 5c36968 | 2007-06-17 15:27:42 -0400 | [diff] [blame] | 84 | extern int nfs_scan_list(struct nfs_inode *nfsi, struct list_head *dst, |
| 85 | pgoff_t idx_start, unsigned int npages, int tag); |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 86 | extern void nfs_pageio_init(struct nfs_pageio_descriptor *desc, |
| 87 | struct inode *inode, |
Fred Isaman | c76069b | 2011-03-03 15:13:48 +0000 | [diff] [blame] | 88 | int (*doio)(struct nfs_pageio_descriptor *desc), |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 89 | size_t bsize, |
| 90 | int how); |
Trond Myklebust | 8b09bee | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 91 | extern int nfs_pageio_add_request(struct nfs_pageio_descriptor *, |
| 92 | struct nfs_page *); |
Trond Myklebust | bcb71bb | 2007-04-02 18:48:28 -0400 | [diff] [blame] | 93 | extern void nfs_pageio_complete(struct nfs_pageio_descriptor *desc); |
Trond Myklebust | 7fe7f84 | 2007-05-20 10:18:27 -0400 | [diff] [blame] | 94 | extern void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *, pgoff_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | extern int nfs_wait_on_request(struct nfs_page *); |
| 96 | extern void nfs_unlock_request(struct nfs_page *req); |
Trond Myklebust | acee478 | 2008-01-22 17:13:07 -0500 | [diff] [blame] | 97 | extern int nfs_set_page_tag_locked(struct nfs_page *req); |
Trond Myklebust | 9fd367f | 2007-06-17 15:10:24 -0400 | [diff] [blame] | 98 | extern void nfs_clear_page_tag_locked(struct nfs_page *req); |
Trond Myklebust | c6a556b | 2005-06-22 17:16:30 +0000 | [diff] [blame] | 99 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | |
| 101 | /* |
Trond Myklebust | c03b402 | 2007-06-17 13:26:38 -0400 | [diff] [blame] | 102 | * Lock the page of an asynchronous request without getting a new reference |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | */ |
| 104 | static inline int |
| 105 | nfs_lock_request_dontget(struct nfs_page *req) |
| 106 | { |
Chuck Lever | a911fd9 | 2005-11-30 18:08:59 -0500 | [diff] [blame] | 107 | return !test_and_set_bit(PG_BUSY, &req->wb_flags); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | } |
| 109 | |
Trond Myklebust | 3da28eb | 2005-06-22 17:16:31 +0000 | [diff] [blame] | 110 | /** |
| 111 | * nfs_list_add_request - Insert a request into a list |
| 112 | * @req: request |
| 113 | * @head: head of list into which to insert the request. |
| 114 | */ |
| 115 | static inline void |
| 116 | nfs_list_add_request(struct nfs_page *req, struct list_head *head) |
| 117 | { |
| 118 | list_add_tail(&req->wb_list, head); |
Trond Myklebust | 3da28eb | 2005-06-22 17:16:31 +0000 | [diff] [blame] | 119 | } |
| 120 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | |
| 122 | /** |
| 123 | * nfs_list_remove_request - Remove a request from its wb_list |
| 124 | * @req: request |
| 125 | */ |
| 126 | static inline void |
| 127 | nfs_list_remove_request(struct nfs_page *req) |
| 128 | { |
| 129 | if (list_empty(&req->wb_list)) |
| 130 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | list_del_init(&req->wb_list); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 132 | } |
| 133 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | static inline struct nfs_page * |
| 135 | nfs_list_entry(struct list_head *head) |
| 136 | { |
| 137 | return list_entry(head, struct nfs_page, wb_list); |
| 138 | } |
| 139 | |
| 140 | static inline |
| 141 | loff_t req_offset(struct nfs_page *req) |
| 142 | { |
| 143 | return (((loff_t)req->wb_index) << PAGE_CACHE_SHIFT) + req->wb_offset; |
| 144 | } |
| 145 | |
| 146 | #endif /* _LINUX_NFS_PAGE_H */ |