Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * linux/fs/nfs/pagelist.c | |
3 | * | |
4 | * A set of helper functions for managing NFS read and write requests. | |
5 | * The main purpose of these routines is to provide support for the | |
6 | * coalescing of several requests into a single RPC call. | |
7 | * | |
8 | * Copyright 2000, 2001 (c) Trond Myklebust <trond.myklebust@fys.uio.no> | |
9 | * | |
10 | */ | |
11 | ||
1da177e4 LT |
12 | #include <linux/slab.h> |
13 | #include <linux/file.h> | |
e8edc6e0 | 14 | #include <linux/sched.h> |
1da177e4 | 15 | #include <linux/sunrpc/clnt.h> |
1313e603 | 16 | #include <linux/nfs.h> |
1da177e4 LT |
17 | #include <linux/nfs3.h> |
18 | #include <linux/nfs4.h> | |
19 | #include <linux/nfs_page.h> | |
20 | #include <linux/nfs_fs.h> | |
21 | #include <linux/nfs_mount.h> | |
afeacc8c | 22 | #include <linux/export.h> |
1da177e4 | 23 | |
8d5658c9 | 24 | #include "internal.h" |
bae724ef | 25 | #include "pnfs.h" |
8d5658c9 | 26 | |
e18b890b | 27 | static struct kmem_cache *nfs_page_cachep; |
1da177e4 | 28 | |
30dd374f FI |
29 | bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount) |
30 | { | |
31 | p->npages = pagecount; | |
32 | if (pagecount <= ARRAY_SIZE(p->page_array)) | |
33 | p->pagevec = p->page_array; | |
34 | else { | |
35 | p->pagevec = kcalloc(pagecount, sizeof(struct page *), GFP_KERNEL); | |
36 | if (!p->pagevec) | |
37 | p->npages = 0; | |
38 | } | |
39 | return p->pagevec != NULL; | |
40 | } | |
41 | ||
4db6e0b7 FI |
42 | void nfs_pgheader_init(struct nfs_pageio_descriptor *desc, |
43 | struct nfs_pgio_header *hdr, | |
44 | void (*release)(struct nfs_pgio_header *hdr)) | |
45 | { | |
46 | hdr->req = nfs_list_entry(desc->pg_list.next); | |
47 | hdr->inode = desc->pg_inode; | |
48 | hdr->cred = hdr->req->wb_context->cred; | |
49 | hdr->io_start = req_offset(hdr->req); | |
50 | hdr->good_bytes = desc->pg_count; | |
584aa810 | 51 | hdr->dreq = desc->pg_dreq; |
4db6e0b7 | 52 | hdr->release = release; |
061ae2ed | 53 | hdr->completion_ops = desc->pg_completion_ops; |
584aa810 FI |
54 | if (hdr->completion_ops->init_hdr) |
55 | hdr->completion_ops->init_hdr(hdr); | |
4db6e0b7 FI |
56 | } |
57 | ||
58 | void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos) | |
59 | { | |
60 | spin_lock(&hdr->lock); | |
61 | if (pos < hdr->io_start + hdr->good_bytes) { | |
62 | set_bit(NFS_IOHDR_ERROR, &hdr->flags); | |
63 | clear_bit(NFS_IOHDR_EOF, &hdr->flags); | |
64 | hdr->good_bytes = pos - hdr->io_start; | |
65 | hdr->error = error; | |
66 | } | |
67 | spin_unlock(&hdr->lock); | |
68 | } | |
69 | ||
1da177e4 LT |
70 | static inline struct nfs_page * |
71 | nfs_page_alloc(void) | |
72 | { | |
72895b1a JJ |
73 | struct nfs_page *p = kmem_cache_zalloc(nfs_page_cachep, GFP_KERNEL); |
74 | if (p) | |
1da177e4 | 75 | INIT_LIST_HEAD(&p->wb_list); |
1da177e4 LT |
76 | return p; |
77 | } | |
78 | ||
79 | static inline void | |
80 | nfs_page_free(struct nfs_page *p) | |
81 | { | |
82 | kmem_cache_free(nfs_page_cachep, p); | |
83 | } | |
84 | ||
85 | /** | |
86 | * nfs_create_request - Create an NFS read/write request. | |
c02f557d | 87 | * @ctx: open context to use |
1da177e4 LT |
88 | * @inode: inode to which the request is attached |
89 | * @page: page to write | |
90 | * @offset: starting offset within the page for the write | |
91 | * @count: number of bytes to read/write | |
92 | * | |
93 | * The page must be locked by the caller. This makes sure we never | |
a19b89ca | 94 | * create two different requests for the same page. |
1da177e4 LT |
95 | * User should ensure it is safe to sleep in this function. |
96 | */ | |
97 | struct nfs_page * | |
98 | nfs_create_request(struct nfs_open_context *ctx, struct inode *inode, | |
99 | struct page *page, | |
100 | unsigned int offset, unsigned int count) | |
101 | { | |
1da177e4 LT |
102 | struct nfs_page *req; |
103 | ||
18eb8842 TM |
104 | /* try to allocate the request struct */ |
105 | req = nfs_page_alloc(); | |
106 | if (req == NULL) | |
107 | return ERR_PTR(-ENOMEM); | |
1da177e4 | 108 | |
015f0212 JL |
109 | /* get lock context early so we can deal with alloc failures */ |
110 | req->wb_lock_context = nfs_get_lock_context(ctx); | |
111 | if (req->wb_lock_context == NULL) { | |
112 | nfs_page_free(req); | |
113 | return ERR_PTR(-ENOMEM); | |
114 | } | |
115 | ||
1da177e4 LT |
116 | /* Initialize the request struct. Initially, we assume a |
117 | * long write-back delay. This will be adjusted in | |
118 | * update_nfs_request below if the region is not locked. */ | |
119 | req->wb_page = page; | |
1da177e4 LT |
120 | req->wb_index = page->index; |
121 | page_cache_get(page); | |
122 | req->wb_offset = offset; | |
123 | req->wb_pgbase = offset; | |
124 | req->wb_bytes = count; | |
1da177e4 | 125 | req->wb_context = get_nfs_open_context(ctx); |
c03b4024 | 126 | kref_init(&req->wb_kref); |
1da177e4 LT |
127 | return req; |
128 | } | |
129 | ||
130 | /** | |
1d1afcbc | 131 | * nfs_unlock_request - Unlock request and wake up sleepers. |
1da177e4 LT |
132 | * @req: |
133 | */ | |
1d1afcbc | 134 | void nfs_unlock_request(struct nfs_page *req) |
1da177e4 LT |
135 | { |
136 | if (!NFS_WBACK_BUSY(req)) { | |
137 | printk(KERN_ERR "NFS: Invalid unlock attempted\n"); | |
138 | BUG(); | |
139 | } | |
140 | smp_mb__before_clear_bit(); | |
141 | clear_bit(PG_BUSY, &req->wb_flags); | |
142 | smp_mb__after_clear_bit(); | |
464a98bd | 143 | wake_up_bit(&req->wb_flags, PG_BUSY); |
3aff4ebb TM |
144 | } |
145 | ||
146 | /** | |
1d1afcbc TM |
147 | * nfs_unlock_and_release_request - Unlock request and release the nfs_page |
148 | * @req: | |
3aff4ebb | 149 | */ |
1d1afcbc | 150 | void nfs_unlock_and_release_request(struct nfs_page *req) |
3aff4ebb | 151 | { |
1d1afcbc | 152 | nfs_unlock_request(req); |
1da177e4 LT |
153 | nfs_release_request(req); |
154 | } | |
155 | ||
4d65c520 | 156 | /* |
1da177e4 LT |
157 | * nfs_clear_request - Free up all resources allocated to the request |
158 | * @req: | |
159 | * | |
bb6fbc45 TM |
160 | * Release page and open context resources associated with a read/write |
161 | * request after it has completed. | |
1da177e4 | 162 | */ |
4d65c520 | 163 | static void nfs_clear_request(struct nfs_page *req) |
1da177e4 | 164 | { |
cd52ed35 | 165 | struct page *page = req->wb_page; |
bb6fbc45 | 166 | struct nfs_open_context *ctx = req->wb_context; |
f11ac8db | 167 | struct nfs_lock_context *l_ctx = req->wb_lock_context; |
bb6fbc45 | 168 | |
cd52ed35 | 169 | if (page != NULL) { |
cd52ed35 | 170 | page_cache_release(page); |
1da177e4 LT |
171 | req->wb_page = NULL; |
172 | } | |
f11ac8db TM |
173 | if (l_ctx != NULL) { |
174 | nfs_put_lock_context(l_ctx); | |
175 | req->wb_lock_context = NULL; | |
176 | } | |
bb6fbc45 TM |
177 | if (ctx != NULL) { |
178 | put_nfs_open_context(ctx); | |
179 | req->wb_context = NULL; | |
180 | } | |
1da177e4 LT |
181 | } |
182 | ||
183 | ||
184 | /** | |
185 | * nfs_release_request - Release the count on an NFS read/write request | |
186 | * @req: request to release | |
187 | * | |
188 | * Note: Should never be called with the spinlock held! | |
189 | */ | |
c03b4024 | 190 | static void nfs_free_request(struct kref *kref) |
1da177e4 | 191 | { |
c03b4024 | 192 | struct nfs_page *req = container_of(kref, struct nfs_page, wb_kref); |
1da177e4 | 193 | |
bb6fbc45 | 194 | /* Release struct file and open context */ |
1da177e4 | 195 | nfs_clear_request(req); |
1da177e4 LT |
196 | nfs_page_free(req); |
197 | } | |
198 | ||
c03b4024 TM |
199 | void nfs_release_request(struct nfs_page *req) |
200 | { | |
201 | kref_put(&req->wb_kref, nfs_free_request); | |
202 | } | |
203 | ||
9f557cd8 TM |
204 | static int nfs_wait_bit_uninterruptible(void *word) |
205 | { | |
206 | io_schedule(); | |
207 | return 0; | |
208 | } | |
209 | ||
1da177e4 LT |
210 | /** |
211 | * nfs_wait_on_request - Wait for a request to complete. | |
212 | * @req: request to wait upon. | |
213 | * | |
150030b7 | 214 | * Interruptible by fatal signals only. |
1da177e4 LT |
215 | * The user is responsible for holding a count on the request. |
216 | */ | |
217 | int | |
218 | nfs_wait_on_request(struct nfs_page *req) | |
219 | { | |
9f557cd8 TM |
220 | return wait_on_bit(&req->wb_flags, PG_BUSY, |
221 | nfs_wait_bit_uninterruptible, | |
222 | TASK_UNINTERRUPTIBLE); | |
1da177e4 LT |
223 | } |
224 | ||
19345cb2 | 225 | bool nfs_generic_pg_test(struct nfs_pageio_descriptor *desc, struct nfs_page *prev, struct nfs_page *req) |
5b36c7dc BH |
226 | { |
227 | /* | |
228 | * FIXME: ideally we should be able to coalesce all requests | |
229 | * that are not block boundary aligned, but currently this | |
230 | * is problematic for the case of bsize < PAGE_CACHE_SIZE, | |
231 | * since nfs_flush_multi and nfs_pagein_multi assume you | |
232 | * can have only one struct nfs_page. | |
233 | */ | |
234 | if (desc->pg_bsize < PAGE_SIZE) | |
235 | return 0; | |
236 | ||
237 | return desc->pg_count + req->wb_bytes <= desc->pg_bsize; | |
238 | } | |
19345cb2 | 239 | EXPORT_SYMBOL_GPL(nfs_generic_pg_test); |
5b36c7dc | 240 | |
1da177e4 | 241 | /** |
d8a5ad75 TM |
242 | * nfs_pageio_init - initialise a page io descriptor |
243 | * @desc: pointer to descriptor | |
bcb71bba TM |
244 | * @inode: pointer to inode |
245 | * @doio: pointer to io function | |
246 | * @bsize: io block size | |
247 | * @io_flags: extra parameters for the io function | |
d8a5ad75 | 248 | */ |
bcb71bba TM |
249 | void nfs_pageio_init(struct nfs_pageio_descriptor *desc, |
250 | struct inode *inode, | |
1751c363 | 251 | const struct nfs_pageio_ops *pg_ops, |
061ae2ed | 252 | const struct nfs_pgio_completion_ops *compl_ops, |
84dde76c | 253 | size_t bsize, |
bcb71bba | 254 | int io_flags) |
d8a5ad75 TM |
255 | { |
256 | INIT_LIST_HEAD(&desc->pg_list); | |
bcb71bba | 257 | desc->pg_bytes_written = 0; |
d8a5ad75 TM |
258 | desc->pg_count = 0; |
259 | desc->pg_bsize = bsize; | |
260 | desc->pg_base = 0; | |
b31268ac | 261 | desc->pg_moreio = 0; |
d9156f9f | 262 | desc->pg_recoalesce = 0; |
bcb71bba | 263 | desc->pg_inode = inode; |
1751c363 | 264 | desc->pg_ops = pg_ops; |
061ae2ed | 265 | desc->pg_completion_ops = compl_ops; |
bcb71bba TM |
266 | desc->pg_ioflags = io_flags; |
267 | desc->pg_error = 0; | |
94ad1c80 | 268 | desc->pg_lseg = NULL; |
584aa810 | 269 | desc->pg_dreq = NULL; |
d8a5ad75 TM |
270 | } |
271 | ||
272 | /** | |
273 | * nfs_can_coalesce_requests - test two requests for compatibility | |
274 | * @prev: pointer to nfs_page | |
275 | * @req: pointer to nfs_page | |
276 | * | |
277 | * The nfs_page structures 'prev' and 'req' are compared to ensure that the | |
278 | * page data area they describe is contiguous, and that their RPC | |
279 | * credentials, NFSv4 open state, and lockowners are the same. | |
280 | * | |
281 | * Return 'true' if this is the case, else return 'false'. | |
282 | */ | |
18ad0a9f BH |
283 | static bool nfs_can_coalesce_requests(struct nfs_page *prev, |
284 | struct nfs_page *req, | |
285 | struct nfs_pageio_descriptor *pgio) | |
d8a5ad75 TM |
286 | { |
287 | if (req->wb_context->cred != prev->wb_context->cred) | |
18ad0a9f | 288 | return false; |
f11ac8db | 289 | if (req->wb_lock_context->lockowner != prev->wb_lock_context->lockowner) |
18ad0a9f | 290 | return false; |
d8a5ad75 | 291 | if (req->wb_context->state != prev->wb_context->state) |
18ad0a9f | 292 | return false; |
d8a5ad75 | 293 | if (req->wb_pgbase != 0) |
18ad0a9f | 294 | return false; |
d8a5ad75 | 295 | if (prev->wb_pgbase + prev->wb_bytes != PAGE_CACHE_SIZE) |
18ad0a9f | 296 | return false; |
1825a0d0 FI |
297 | if (req_offset(req) != req_offset(prev) + prev->wb_bytes) |
298 | return false; | |
1751c363 | 299 | return pgio->pg_ops->pg_test(pgio, prev, req); |
d8a5ad75 TM |
300 | } |
301 | ||
302 | /** | |
bcb71bba | 303 | * nfs_pageio_do_add_request - Attempt to coalesce a request into a page list. |
d8a5ad75 TM |
304 | * @desc: destination io descriptor |
305 | * @req: request | |
306 | * | |
307 | * Returns true if the request 'req' was successfully coalesced into the | |
308 | * existing list of pages 'desc'. | |
309 | */ | |
bcb71bba TM |
310 | static int nfs_pageio_do_add_request(struct nfs_pageio_descriptor *desc, |
311 | struct nfs_page *req) | |
d8a5ad75 | 312 | { |
d8a5ad75 TM |
313 | if (desc->pg_count != 0) { |
314 | struct nfs_page *prev; | |
315 | ||
d8a5ad75 | 316 | prev = nfs_list_entry(desc->pg_list.prev); |
94ad1c80 | 317 | if (!nfs_can_coalesce_requests(prev, req, desc)) |
d8a5ad75 | 318 | return 0; |
5b36c7dc | 319 | } else { |
d8007d4d TM |
320 | if (desc->pg_ops->pg_init) |
321 | desc->pg_ops->pg_init(desc, req); | |
d8a5ad75 | 322 | desc->pg_base = req->wb_pgbase; |
5b36c7dc | 323 | } |
d8a5ad75 TM |
324 | nfs_list_remove_request(req); |
325 | nfs_list_add_request(req, &desc->pg_list); | |
5b36c7dc | 326 | desc->pg_count += req->wb_bytes; |
d8a5ad75 TM |
327 | return 1; |
328 | } | |
329 | ||
bcb71bba TM |
330 | /* |
331 | * Helper for nfs_pageio_add_request and nfs_pageio_complete | |
332 | */ | |
333 | static void nfs_pageio_doio(struct nfs_pageio_descriptor *desc) | |
334 | { | |
335 | if (!list_empty(&desc->pg_list)) { | |
1751c363 | 336 | int error = desc->pg_ops->pg_doio(desc); |
bcb71bba TM |
337 | if (error < 0) |
338 | desc->pg_error = error; | |
339 | else | |
340 | desc->pg_bytes_written += desc->pg_count; | |
341 | } | |
342 | if (list_empty(&desc->pg_list)) { | |
343 | desc->pg_count = 0; | |
344 | desc->pg_base = 0; | |
345 | } | |
346 | } | |
347 | ||
348 | /** | |
349 | * nfs_pageio_add_request - Attempt to coalesce a request into a page list. | |
350 | * @desc: destination io descriptor | |
351 | * @req: request | |
352 | * | |
353 | * Returns true if the request 'req' was successfully coalesced into the | |
354 | * existing list of pages 'desc'. | |
355 | */ | |
d9156f9f | 356 | static int __nfs_pageio_add_request(struct nfs_pageio_descriptor *desc, |
8b09bee3 | 357 | struct nfs_page *req) |
bcb71bba TM |
358 | { |
359 | while (!nfs_pageio_do_add_request(desc, req)) { | |
b31268ac | 360 | desc->pg_moreio = 1; |
bcb71bba TM |
361 | nfs_pageio_doio(desc); |
362 | if (desc->pg_error < 0) | |
363 | return 0; | |
b31268ac | 364 | desc->pg_moreio = 0; |
d9156f9f TM |
365 | if (desc->pg_recoalesce) |
366 | return 0; | |
bcb71bba TM |
367 | } |
368 | return 1; | |
369 | } | |
370 | ||
d9156f9f TM |
371 | static int nfs_do_recoalesce(struct nfs_pageio_descriptor *desc) |
372 | { | |
373 | LIST_HEAD(head); | |
374 | ||
375 | do { | |
376 | list_splice_init(&desc->pg_list, &head); | |
377 | desc->pg_bytes_written -= desc->pg_count; | |
378 | desc->pg_count = 0; | |
379 | desc->pg_base = 0; | |
380 | desc->pg_recoalesce = 0; | |
381 | ||
382 | while (!list_empty(&head)) { | |
383 | struct nfs_page *req; | |
384 | ||
385 | req = list_first_entry(&head, struct nfs_page, wb_list); | |
386 | nfs_list_remove_request(req); | |
387 | if (__nfs_pageio_add_request(desc, req)) | |
388 | continue; | |
389 | if (desc->pg_error < 0) | |
390 | return 0; | |
391 | break; | |
392 | } | |
393 | } while (desc->pg_recoalesce); | |
394 | return 1; | |
395 | } | |
396 | ||
397 | int nfs_pageio_add_request(struct nfs_pageio_descriptor *desc, | |
398 | struct nfs_page *req) | |
399 | { | |
400 | int ret; | |
401 | ||
402 | do { | |
403 | ret = __nfs_pageio_add_request(desc, req); | |
404 | if (ret) | |
405 | break; | |
406 | if (desc->pg_error < 0) | |
407 | break; | |
408 | ret = nfs_do_recoalesce(desc); | |
409 | } while (ret); | |
410 | return ret; | |
411 | } | |
412 | ||
bcb71bba TM |
413 | /** |
414 | * nfs_pageio_complete - Complete I/O on an nfs_pageio_descriptor | |
415 | * @desc: pointer to io descriptor | |
416 | */ | |
417 | void nfs_pageio_complete(struct nfs_pageio_descriptor *desc) | |
418 | { | |
d9156f9f TM |
419 | for (;;) { |
420 | nfs_pageio_doio(desc); | |
421 | if (!desc->pg_recoalesce) | |
422 | break; | |
423 | if (!nfs_do_recoalesce(desc)) | |
424 | break; | |
425 | } | |
bcb71bba TM |
426 | } |
427 | ||
7fe7f848 TM |
428 | /** |
429 | * nfs_pageio_cond_complete - Conditional I/O completion | |
430 | * @desc: pointer to io descriptor | |
431 | * @index: page index | |
432 | * | |
433 | * It is important to ensure that processes don't try to take locks | |
434 | * on non-contiguous ranges of pages as that might deadlock. This | |
435 | * function should be called before attempting to wait on a locked | |
436 | * nfs_page. It will complete the I/O if the page index 'index' | |
437 | * is not contiguous with the existing list of pages in 'desc'. | |
438 | */ | |
439 | void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *desc, pgoff_t index) | |
440 | { | |
441 | if (!list_empty(&desc->pg_list)) { | |
442 | struct nfs_page *prev = nfs_list_entry(desc->pg_list.prev); | |
443 | if (index != prev->wb_index + 1) | |
d9156f9f | 444 | nfs_pageio_complete(desc); |
7fe7f848 TM |
445 | } |
446 | } | |
447 | ||
f7b422b1 | 448 | int __init nfs_init_nfspagecache(void) |
1da177e4 LT |
449 | { |
450 | nfs_page_cachep = kmem_cache_create("nfs_page", | |
451 | sizeof(struct nfs_page), | |
452 | 0, SLAB_HWCACHE_ALIGN, | |
20c2df83 | 453 | NULL); |
1da177e4 LT |
454 | if (nfs_page_cachep == NULL) |
455 | return -ENOMEM; | |
456 | ||
457 | return 0; | |
458 | } | |
459 | ||
266bee88 | 460 | void nfs_destroy_nfspagecache(void) |
1da177e4 | 461 | { |
1a1d92c1 | 462 | kmem_cache_destroy(nfs_page_cachep); |
1da177e4 LT |
463 | } |
464 |