blob: 799b59d96fe28e09f5ce07bbe60c8d3f1213dd2e [file] [log] [blame]
David Howells9ae326a2009-04-03 16:42:41 +01001/* Storage object read/write
2 *
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
10 */
11
12#include <linux/mount.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090013#include <linux/slab.h>
David Howells9ae326a2009-04-03 16:42:41 +010014#include <linux/file.h>
Mel Gormana0b8cab32013-07-03 15:02:32 -070015#include <linux/swap.h>
David Howells9ae326a2009-04-03 16:42:41 +010016#include "internal.h"
17
18/*
19 * detect wake up events generated by the unlocking of pages in which we're
20 * interested
21 * - we use this to detect read completion of backing pages
22 * - the caller holds the waitqueue lock
23 */
24static int cachefiles_read_waiter(wait_queue_t *wait, unsigned mode,
25 int sync, void *_key)
26{
27 struct cachefiles_one_read *monitor =
28 container_of(wait, struct cachefiles_one_read, monitor);
29 struct cachefiles_object *object;
Kiran Kumar Modukuri75960a42017-07-18 16:25:49 -070030 struct fscache_retrieval *op = monitor->op;
David Howells9ae326a2009-04-03 16:42:41 +010031 struct wait_bit_key *key = _key;
32 struct page *page = wait->private;
33
34 ASSERT(key);
35
36 _enter("{%lu},%u,%d,{%p,%u}",
37 monitor->netfs_page->index, mode, sync,
38 key->flags, key->bit_nr);
39
40 if (key->flags != &page->flags ||
41 key->bit_nr != PG_locked)
42 return 0;
43
44 _debug("--- monitor %p %lx ---", page, page->flags);
45
David Howells5e929b32009-11-19 18:11:55 +000046 if (!PageUptodate(page) && !PageError(page)) {
47 /* unlocked, not uptodate and not erronous? */
48 _debug("page probably truncated");
49 }
David Howells9ae326a2009-04-03 16:42:41 +010050
51 /* remove from the waitqueue */
52 list_del(&wait->task_list);
53
54 /* move onto the action list and queue for FS-Cache thread pool */
Kiran Kumar Modukuri75960a42017-07-18 16:25:49 -070055 ASSERT(op);
David Howells9ae326a2009-04-03 16:42:41 +010056
Kiran Kumar Modukuri75960a42017-07-18 16:25:49 -070057 /* We need to temporarily bump the usage count as we don't own a ref
58 * here otherwise cachefiles_read_copier() may free the op between the
59 * monitor being enqueued on the op->to_do list and the op getting
60 * enqueued on the work queue.
61 */
62 fscache_get_retrieval(op);
David Howells9ae326a2009-04-03 16:42:41 +010063
Kiran Kumar Modukuri75960a42017-07-18 16:25:49 -070064 object = container_of(op->op.object, struct cachefiles_object, fscache);
David Howells9ae326a2009-04-03 16:42:41 +010065 spin_lock(&object->work_lock);
Kiran Kumar Modukuri75960a42017-07-18 16:25:49 -070066 list_add_tail(&monitor->op_link, &op->to_do);
David Howells9ae326a2009-04-03 16:42:41 +010067 spin_unlock(&object->work_lock);
68
Kiran Kumar Modukuri75960a42017-07-18 16:25:49 -070069 fscache_enqueue_retrieval(op);
70 fscache_put_retrieval(op);
David Howells9ae326a2009-04-03 16:42:41 +010071 return 0;
72}
73
74/*
David Howells5e929b32009-11-19 18:11:55 +000075 * handle a probably truncated page
76 * - check to see if the page is still relevant and reissue the read if
77 * possible
78 * - return -EIO on error, -ENODATA if the page is gone, -EINPROGRESS if we
79 * must wait again and 0 if successful
80 */
81static int cachefiles_read_reissue(struct cachefiles_object *object,
82 struct cachefiles_one_read *monitor)
83{
David Howells466b77b2015-03-17 22:26:21 +000084 struct address_space *bmapping = d_backing_inode(object->backer)->i_mapping;
David Howells5e929b32009-11-19 18:11:55 +000085 struct page *backpage = monitor->back_page, *backpage2;
86 int ret;
87
David Howells37491a12012-12-20 21:52:34 +000088 _enter("{ino=%lx},{%lx,%lx}",
David Howells466b77b2015-03-17 22:26:21 +000089 d_backing_inode(object->backer)->i_ino,
David Howells5e929b32009-11-19 18:11:55 +000090 backpage->index, backpage->flags);
91
92 /* skip if the page was truncated away completely */
93 if (backpage->mapping != bmapping) {
David Howells37491a12012-12-20 21:52:34 +000094 _leave(" = -ENODATA [mapping]");
David Howells5e929b32009-11-19 18:11:55 +000095 return -ENODATA;
96 }
97
98 backpage2 = find_get_page(bmapping, backpage->index);
99 if (!backpage2) {
David Howells37491a12012-12-20 21:52:34 +0000100 _leave(" = -ENODATA [gone]");
David Howells5e929b32009-11-19 18:11:55 +0000101 return -ENODATA;
102 }
103
104 if (backpage != backpage2) {
105 put_page(backpage2);
David Howells37491a12012-12-20 21:52:34 +0000106 _leave(" = -ENODATA [different]");
David Howells5e929b32009-11-19 18:11:55 +0000107 return -ENODATA;
108 }
109
110 /* the page is still there and we already have a ref on it, so we don't
111 * need a second */
112 put_page(backpage2);
113
114 INIT_LIST_HEAD(&monitor->op_link);
115 add_page_wait_queue(backpage, &monitor->monitor);
116
117 if (trylock_page(backpage)) {
118 ret = -EIO;
119 if (PageError(backpage))
120 goto unlock_discard;
121 ret = 0;
122 if (PageUptodate(backpage))
123 goto unlock_discard;
124
David Howells37491a12012-12-20 21:52:34 +0000125 _debug("reissue read");
David Howells5e929b32009-11-19 18:11:55 +0000126 ret = bmapping->a_ops->readpage(NULL, backpage);
127 if (ret < 0)
128 goto unlock_discard;
129 }
130
131 /* but the page may have been read before the monitor was installed, so
132 * the monitor may miss the event - so we have to ensure that we do get
133 * one in such a case */
134 if (trylock_page(backpage)) {
135 _debug("jumpstart %p {%lx}", backpage, backpage->flags);
136 unlock_page(backpage);
137 }
138
139 /* it'll reappear on the todo list */
David Howells37491a12012-12-20 21:52:34 +0000140 _leave(" = -EINPROGRESS");
David Howells5e929b32009-11-19 18:11:55 +0000141 return -EINPROGRESS;
142
143unlock_discard:
144 unlock_page(backpage);
145 spin_lock_irq(&object->work_lock);
146 list_del(&monitor->op_link);
147 spin_unlock_irq(&object->work_lock);
David Howells37491a12012-12-20 21:52:34 +0000148 _leave(" = %d", ret);
David Howells5e929b32009-11-19 18:11:55 +0000149 return ret;
150}
151
152/*
David Howells9ae326a2009-04-03 16:42:41 +0100153 * copy data from backing pages to netfs pages to complete a read operation
154 * - driven by FS-Cache's thread pool
155 */
156static void cachefiles_read_copier(struct fscache_operation *_op)
157{
158 struct cachefiles_one_read *monitor;
159 struct cachefiles_object *object;
160 struct fscache_retrieval *op;
David Howells9ae326a2009-04-03 16:42:41 +0100161 int error, max;
162
163 op = container_of(_op, struct fscache_retrieval, op);
164 object = container_of(op->op.object,
165 struct cachefiles_object, fscache);
166
David Howells466b77b2015-03-17 22:26:21 +0000167 _enter("{ino=%lu}", d_backing_inode(object->backer)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100168
David Howells9ae326a2009-04-03 16:42:41 +0100169 max = 8;
170 spin_lock_irq(&object->work_lock);
171
172 while (!list_empty(&op->to_do)) {
173 monitor = list_entry(op->to_do.next,
174 struct cachefiles_one_read, op_link);
175 list_del(&monitor->op_link);
176
177 spin_unlock_irq(&object->work_lock);
178
179 _debug("- copy {%lu}", monitor->back_page->index);
180
David Howells5e929b32009-11-19 18:11:55 +0000181 recheck:
David Howells9dc8d9b2012-12-20 21:52:36 +0000182 if (test_bit(FSCACHE_COOKIE_INVALIDATING,
183 &object->fscache.cookie->flags)) {
184 error = -ESTALE;
185 } else if (PageUptodate(monitor->back_page)) {
David Howells9ae326a2009-04-03 16:42:41 +0100186 copy_highpage(monitor->netfs_page, monitor->back_page);
David Howellsc4d6d8d2012-12-20 21:52:32 +0000187 fscache_mark_page_cached(monitor->op,
188 monitor->netfs_page);
David Howells9ae326a2009-04-03 16:42:41 +0100189 error = 0;
David Howells5e929b32009-11-19 18:11:55 +0000190 } else if (!PageError(monitor->back_page)) {
191 /* the page has probably been truncated */
192 error = cachefiles_read_reissue(object, monitor);
193 if (error == -EINPROGRESS)
194 goto next;
195 goto recheck;
196 } else {
David Howells9ae326a2009-04-03 16:42:41 +0100197 cachefiles_io_error_obj(
198 object,
199 "Readpage failed on backing file %lx",
200 (unsigned long) monitor->back_page->flags);
David Howells5e929b32009-11-19 18:11:55 +0000201 error = -EIO;
202 }
David Howells9ae326a2009-04-03 16:42:41 +0100203
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300204 put_page(monitor->back_page);
David Howells9ae326a2009-04-03 16:42:41 +0100205
206 fscache_end_io(op, monitor->netfs_page, error);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300207 put_page(monitor->netfs_page);
David Howells9f105232012-12-20 21:52:35 +0000208 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100209 fscache_put_retrieval(op);
210 kfree(monitor);
211
David Howells5e929b32009-11-19 18:11:55 +0000212 next:
David Howells9ae326a2009-04-03 16:42:41 +0100213 /* let the thread pool have some air occasionally */
214 max--;
215 if (max < 0 || need_resched()) {
216 if (!list_empty(&op->to_do))
217 fscache_enqueue_retrieval(op);
218 _leave(" [maxed out]");
219 return;
220 }
221
222 spin_lock_irq(&object->work_lock);
223 }
224
225 spin_unlock_irq(&object->work_lock);
226 _leave("");
227}
228
229/*
230 * read the corresponding page to the given set from the backing file
231 * - an uncertain page is simply discarded, to be tried again another time
232 */
233static int cachefiles_read_backing_file_one(struct cachefiles_object *object,
234 struct fscache_retrieval *op,
Mel Gormana0b8cab32013-07-03 15:02:32 -0700235 struct page *netpage)
David Howells9ae326a2009-04-03 16:42:41 +0100236{
237 struct cachefiles_one_read *monitor;
238 struct address_space *bmapping;
239 struct page *newpage, *backpage;
240 int ret;
241
242 _enter("");
243
David Howells9ae326a2009-04-03 16:42:41 +0100244 _debug("read back %p{%lu,%d}",
245 netpage, netpage->index, page_count(netpage));
246
David Howells5f4f9f42012-12-20 21:52:33 +0000247 monitor = kzalloc(sizeof(*monitor), cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100248 if (!monitor)
249 goto nomem;
250
251 monitor->netfs_page = netpage;
252 monitor->op = fscache_get_retrieval(op);
253
254 init_waitqueue_func_entry(&monitor->monitor, cachefiles_read_waiter);
255
256 /* attempt to get hold of the backing page */
David Howells466b77b2015-03-17 22:26:21 +0000257 bmapping = d_backing_inode(object->backer)->i_mapping;
David Howells9ae326a2009-04-03 16:42:41 +0100258 newpage = NULL;
259
260 for (;;) {
261 backpage = find_get_page(bmapping, netpage->index);
262 if (backpage)
263 goto backing_page_already_present;
264
265 if (!newpage) {
David Howells5f4f9f42012-12-20 21:52:33 +0000266 newpage = __page_cache_alloc(cachefiles_gfp |
267 __GFP_COLD);
David Howells9ae326a2009-04-03 16:42:41 +0100268 if (!newpage)
269 goto nomem_monitor;
270 }
271
Johannes Weiner55881bc2014-04-03 14:47:36 -0700272 ret = add_to_page_cache_lru(newpage, bmapping,
273 netpage->index, cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100274 if (ret == 0)
275 goto installed_new_backing_page;
276 if (ret != -EEXIST)
277 goto nomem_page;
278 }
279
Johannes Weiner55881bc2014-04-03 14:47:36 -0700280 /* we've installed a new backing page, so now we need to start
281 * it reading */
David Howells9ae326a2009-04-03 16:42:41 +0100282installed_new_backing_page:
283 _debug("- new %p", newpage);
284
285 backpage = newpage;
286 newpage = NULL;
287
David Howells9ae326a2009-04-03 16:42:41 +0100288read_backing_page:
289 ret = bmapping->a_ops->readpage(NULL, backpage);
290 if (ret < 0)
291 goto read_error;
292
293 /* set the monitor to transfer the data across */
294monitor_backing_page:
295 _debug("- monitor add");
296
297 /* install the monitor */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300298 get_page(monitor->netfs_page);
299 get_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100300 monitor->back_page = backpage;
301 monitor->monitor.private = backpage;
302 add_page_wait_queue(backpage, &monitor->monitor);
303 monitor = NULL;
304
305 /* but the page may have been read before the monitor was installed, so
306 * the monitor may miss the event - so we have to ensure that we do get
307 * one in such a case */
308 if (trylock_page(backpage)) {
309 _debug("jumpstart %p {%lx}", backpage, backpage->flags);
310 unlock_page(backpage);
311 }
312 goto success;
313
314 /* if the backing page is already present, it can be in one of
315 * three states: read in progress, read failed or read okay */
316backing_page_already_present:
317 _debug("- present");
318
319 if (newpage) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300320 put_page(newpage);
David Howells9ae326a2009-04-03 16:42:41 +0100321 newpage = NULL;
322 }
323
324 if (PageError(backpage))
325 goto io_error;
326
327 if (PageUptodate(backpage))
328 goto backing_page_already_uptodate;
329
330 if (!trylock_page(backpage))
331 goto monitor_backing_page;
332 _debug("read %p {%lx}", backpage, backpage->flags);
333 goto read_backing_page;
334
335 /* the backing page is already up to date, attach the netfs
336 * page to the pagecache and LRU and copy the data across */
337backing_page_already_uptodate:
338 _debug("- uptodate");
339
David Howellsc4d6d8d2012-12-20 21:52:32 +0000340 fscache_mark_page_cached(op, netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100341
342 copy_highpage(netpage, backpage);
343 fscache_end_io(op, netpage, 0);
David Howells9f105232012-12-20 21:52:35 +0000344 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100345
346success:
347 _debug("success");
348 ret = 0;
349
350out:
351 if (backpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300352 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100353 if (monitor) {
354 fscache_put_retrieval(monitor->op);
355 kfree(monitor);
356 }
357 _leave(" = %d", ret);
358 return ret;
359
360read_error:
361 _debug("read error %d", ret);
David Howellsb4cf1e02012-12-05 13:34:45 +0000362 if (ret == -ENOMEM) {
363 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100364 goto out;
David Howellsb4cf1e02012-12-05 13:34:45 +0000365 }
David Howells9ae326a2009-04-03 16:42:41 +0100366io_error:
367 cachefiles_io_error_obj(object, "Page read error on backing file");
David Howells9f105232012-12-20 21:52:35 +0000368 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100369 ret = -ENOBUFS;
370 goto out;
371
372nomem_page:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300373 put_page(newpage);
David Howells9ae326a2009-04-03 16:42:41 +0100374nomem_monitor:
375 fscache_put_retrieval(monitor->op);
376 kfree(monitor);
377nomem:
David Howells9f105232012-12-20 21:52:35 +0000378 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100379 _leave(" = -ENOMEM");
380 return -ENOMEM;
381}
382
383/*
384 * read a page from the cache or allocate a block in which to store it
385 * - cache withdrawal is prevented by the caller
386 * - returns -EINTR if interrupted
387 * - returns -ENOMEM if ran out of memory
388 * - returns -ENOBUFS if no buffers can be made available
389 * - returns -ENOBUFS if page is beyond EOF
390 * - if the page is backed by a block in the cache:
391 * - a read will be started which will call the callback on completion
392 * - 0 will be returned
393 * - else if the page is unbacked:
394 * - the metadata will be retained
395 * - -ENODATA will be returned
396 */
397int cachefiles_read_or_alloc_page(struct fscache_retrieval *op,
398 struct page *page,
399 gfp_t gfp)
400{
401 struct cachefiles_object *object;
402 struct cachefiles_cache *cache;
David Howells9ae326a2009-04-03 16:42:41 +0100403 struct inode *inode;
404 sector_t block0, block;
405 unsigned shift;
406 int ret;
407
408 object = container_of(op->op.object,
409 struct cachefiles_object, fscache);
410 cache = container_of(object->fscache.cache,
411 struct cachefiles_cache, cache);
412
413 _enter("{%p},{%lx},,,", object, page->index);
414
415 if (!object->backer)
David Howells9f105232012-12-20 21:52:35 +0000416 goto enobufs;
David Howells9ae326a2009-04-03 16:42:41 +0100417
David Howells466b77b2015-03-17 22:26:21 +0000418 inode = d_backing_inode(object->backer);
David Howells9ae326a2009-04-03 16:42:41 +0100419 ASSERT(S_ISREG(inode->i_mode));
420 ASSERT(inode->i_mapping->a_ops->bmap);
421 ASSERT(inode->i_mapping->a_ops->readpages);
422
423 /* calculate the shift required to use bmap */
David Howells9ae326a2009-04-03 16:42:41 +0100424 shift = PAGE_SHIFT - inode->i_sb->s_blocksize_bits;
425
David Howells4fbf4292009-11-19 18:11:04 +0000426 op->op.flags &= FSCACHE_OP_KEEP_FLAGS;
Tejun Heo8af7c122010-07-20 22:09:01 +0200427 op->op.flags |= FSCACHE_OP_ASYNC;
David Howells9ae326a2009-04-03 16:42:41 +0100428 op->op.processor = cachefiles_read_copier;
429
David Howells9ae326a2009-04-03 16:42:41 +0100430 /* we assume the absence or presence of the first block is a good
431 * enough indication for the page as a whole
432 * - TODO: don't use bmap() for this as it is _not_ actually good
433 * enough for this as it doesn't indicate errors, but it's all we've
434 * got for the moment
435 */
436 block0 = page->index;
437 block0 <<= shift;
438
439 block = inode->i_mapping->a_ops->bmap(inode->i_mapping, block0);
440 _debug("%llx -> %llx",
441 (unsigned long long) block0,
442 (unsigned long long) block);
443
444 if (block) {
445 /* submit the apparently valid page to the backing fs to be
446 * read from disk */
Mel Gormana0b8cab32013-07-03 15:02:32 -0700447 ret = cachefiles_read_backing_file_one(object, op, page);
David Howells9ae326a2009-04-03 16:42:41 +0100448 } else if (cachefiles_has_space(cache, 0, 1) == 0) {
449 /* there's space in the cache we can use */
David Howellsc4d6d8d2012-12-20 21:52:32 +0000450 fscache_mark_page_cached(op, page);
David Howells9f105232012-12-20 21:52:35 +0000451 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100452 ret = -ENODATA;
453 } else {
David Howells9f105232012-12-20 21:52:35 +0000454 goto enobufs;
David Howells9ae326a2009-04-03 16:42:41 +0100455 }
456
457 _leave(" = %d", ret);
458 return ret;
David Howells9f105232012-12-20 21:52:35 +0000459
460enobufs:
461 fscache_retrieval_complete(op, 1);
462 _leave(" = -ENOBUFS");
463 return -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100464}
465
466/*
467 * read the corresponding pages to the given set from the backing file
468 * - any uncertain pages are simply discarded, to be tried again another time
469 */
470static int cachefiles_read_backing_file(struct cachefiles_object *object,
471 struct fscache_retrieval *op,
David Howellsc4d6d8d2012-12-20 21:52:32 +0000472 struct list_head *list)
David Howells9ae326a2009-04-03 16:42:41 +0100473{
474 struct cachefiles_one_read *monitor = NULL;
David Howells466b77b2015-03-17 22:26:21 +0000475 struct address_space *bmapping = d_backing_inode(object->backer)->i_mapping;
David Howells9ae326a2009-04-03 16:42:41 +0100476 struct page *newpage = NULL, *netpage, *_n, *backpage = NULL;
477 int ret = 0;
478
479 _enter("");
480
David Howells9ae326a2009-04-03 16:42:41 +0100481 list_for_each_entry_safe(netpage, _n, list, lru) {
482 list_del(&netpage->lru);
483
484 _debug("read back %p{%lu,%d}",
485 netpage, netpage->index, page_count(netpage));
486
487 if (!monitor) {
David Howells5f4f9f42012-12-20 21:52:33 +0000488 monitor = kzalloc(sizeof(*monitor), cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100489 if (!monitor)
490 goto nomem;
491
492 monitor->op = fscache_get_retrieval(op);
493 init_waitqueue_func_entry(&monitor->monitor,
494 cachefiles_read_waiter);
495 }
496
497 for (;;) {
498 backpage = find_get_page(bmapping, netpage->index);
499 if (backpage)
500 goto backing_page_already_present;
501
502 if (!newpage) {
David Howells5f4f9f42012-12-20 21:52:33 +0000503 newpage = __page_cache_alloc(cachefiles_gfp |
504 __GFP_COLD);
David Howells9ae326a2009-04-03 16:42:41 +0100505 if (!newpage)
506 goto nomem;
507 }
508
Johannes Weiner55881bc2014-04-03 14:47:36 -0700509 ret = add_to_page_cache_lru(newpage, bmapping,
510 netpage->index,
511 cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100512 if (ret == 0)
513 goto installed_new_backing_page;
514 if (ret != -EEXIST)
515 goto nomem;
516 }
517
Johannes Weiner55881bc2014-04-03 14:47:36 -0700518 /* we've installed a new backing page, so now we need
519 * to start it reading */
David Howells9ae326a2009-04-03 16:42:41 +0100520 installed_new_backing_page:
521 _debug("- new %p", newpage);
522
523 backpage = newpage;
524 newpage = NULL;
525
David Howells9ae326a2009-04-03 16:42:41 +0100526 reread_backing_page:
527 ret = bmapping->a_ops->readpage(NULL, backpage);
528 if (ret < 0)
529 goto read_error;
530
531 /* add the netfs page to the pagecache and LRU, and set the
532 * monitor to transfer the data across */
533 monitor_backing_page:
534 _debug("- monitor add");
535
Johannes Weiner55881bc2014-04-03 14:47:36 -0700536 ret = add_to_page_cache_lru(netpage, op->mapping,
537 netpage->index, cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100538 if (ret < 0) {
539 if (ret == -EEXIST) {
Kiran Kumar Modukuri5e3cd962018-09-24 12:02:39 +1000540 put_page(backpage);
541 backpage = NULL;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300542 put_page(netpage);
Kiran Kumar Modukuri5e3cd962018-09-24 12:02:39 +1000543 netpage = NULL;
David Howellsb4cf1e02012-12-05 13:34:45 +0000544 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100545 continue;
546 }
547 goto nomem;
548 }
549
David Howells9ae326a2009-04-03 16:42:41 +0100550 /* install a monitor */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300551 get_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100552 monitor->netfs_page = netpage;
553
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300554 get_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100555 monitor->back_page = backpage;
556 monitor->monitor.private = backpage;
557 add_page_wait_queue(backpage, &monitor->monitor);
558 monitor = NULL;
559
560 /* but the page may have been read before the monitor was
561 * installed, so the monitor may miss the event - so we have to
562 * ensure that we do get one in such a case */
563 if (trylock_page(backpage)) {
564 _debug("2unlock %p {%lx}", backpage, backpage->flags);
565 unlock_page(backpage);
566 }
567
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300568 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100569 backpage = NULL;
570
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300571 put_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100572 netpage = NULL;
573 continue;
574
575 /* if the backing page is already present, it can be in one of
576 * three states: read in progress, read failed or read okay */
577 backing_page_already_present:
578 _debug("- present %p", backpage);
579
580 if (PageError(backpage))
581 goto io_error;
582
583 if (PageUptodate(backpage))
584 goto backing_page_already_uptodate;
585
586 _debug("- not ready %p{%lx}", backpage, backpage->flags);
587
588 if (!trylock_page(backpage))
589 goto monitor_backing_page;
590
591 if (PageError(backpage)) {
592 _debug("error %lx", backpage->flags);
593 unlock_page(backpage);
594 goto io_error;
595 }
596
597 if (PageUptodate(backpage))
598 goto backing_page_already_uptodate_unlock;
599
600 /* we've locked a page that's neither up to date nor erroneous,
601 * so we need to attempt to read it again */
602 goto reread_backing_page;
603
604 /* the backing page is already up to date, attach the netfs
605 * page to the pagecache and LRU and copy the data across */
606 backing_page_already_uptodate_unlock:
607 _debug("uptodate %lx", backpage->flags);
608 unlock_page(backpage);
609 backing_page_already_uptodate:
610 _debug("- uptodate");
611
Johannes Weiner55881bc2014-04-03 14:47:36 -0700612 ret = add_to_page_cache_lru(netpage, op->mapping,
613 netpage->index, cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100614 if (ret < 0) {
615 if (ret == -EEXIST) {
Kiran Kumar Modukuri5e3cd962018-09-24 12:02:39 +1000616 put_page(backpage);
617 backpage = NULL;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300618 put_page(netpage);
Kiran Kumar Modukuri5e3cd962018-09-24 12:02:39 +1000619 netpage = NULL;
David Howellsb4cf1e02012-12-05 13:34:45 +0000620 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100621 continue;
622 }
623 goto nomem;
624 }
625
626 copy_highpage(netpage, backpage);
627
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300628 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100629 backpage = NULL;
630
David Howellsc4d6d8d2012-12-20 21:52:32 +0000631 fscache_mark_page_cached(op, netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100632
David Howellsc4d6d8d2012-12-20 21:52:32 +0000633 /* the netpage is unlocked and marked up to date here */
David Howells9ae326a2009-04-03 16:42:41 +0100634 fscache_end_io(op, netpage, 0);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300635 put_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100636 netpage = NULL;
David Howellsb4cf1e02012-12-05 13:34:45 +0000637 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100638 continue;
639 }
640
641 netpage = NULL;
642
643 _debug("out");
644
645out:
646 /* tidy up */
David Howells9ae326a2009-04-03 16:42:41 +0100647 if (newpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300648 put_page(newpage);
David Howells9ae326a2009-04-03 16:42:41 +0100649 if (netpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300650 put_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100651 if (backpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300652 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100653 if (monitor) {
654 fscache_put_retrieval(op);
655 kfree(monitor);
656 }
657
658 list_for_each_entry_safe(netpage, _n, list, lru) {
659 list_del(&netpage->lru);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300660 put_page(netpage);
David Howells9f105232012-12-20 21:52:35 +0000661 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100662 }
663
664 _leave(" = %d", ret);
665 return ret;
666
667nomem:
668 _debug("nomem");
669 ret = -ENOMEM;
David Howellsb4cf1e02012-12-05 13:34:45 +0000670 goto record_page_complete;
David Howells9ae326a2009-04-03 16:42:41 +0100671
672read_error:
673 _debug("read error %d", ret);
674 if (ret == -ENOMEM)
David Howellsb4cf1e02012-12-05 13:34:45 +0000675 goto record_page_complete;
David Howells9ae326a2009-04-03 16:42:41 +0100676io_error:
677 cachefiles_io_error_obj(object, "Page read error on backing file");
678 ret = -ENOBUFS;
David Howellsb4cf1e02012-12-05 13:34:45 +0000679record_page_complete:
680 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100681 goto out;
682}
683
684/*
685 * read a list of pages from the cache or allocate blocks in which to store
686 * them
687 */
688int cachefiles_read_or_alloc_pages(struct fscache_retrieval *op,
689 struct list_head *pages,
690 unsigned *nr_pages,
691 gfp_t gfp)
692{
693 struct cachefiles_object *object;
694 struct cachefiles_cache *cache;
695 struct list_head backpages;
696 struct pagevec pagevec;
697 struct inode *inode;
698 struct page *page, *_n;
699 unsigned shift, nrbackpages;
700 int ret, ret2, space;
701
702 object = container_of(op->op.object,
703 struct cachefiles_object, fscache);
704 cache = container_of(object->fscache.cache,
705 struct cachefiles_cache, cache);
706
707 _enter("{OBJ%x,%d},,%d,,",
708 object->fscache.debug_id, atomic_read(&op->op.usage),
709 *nr_pages);
710
711 if (!object->backer)
David Howells9f105232012-12-20 21:52:35 +0000712 goto all_enobufs;
David Howells9ae326a2009-04-03 16:42:41 +0100713
714 space = 1;
715 if (cachefiles_has_space(cache, 0, *nr_pages) < 0)
716 space = 0;
717
David Howells466b77b2015-03-17 22:26:21 +0000718 inode = d_backing_inode(object->backer);
David Howells9ae326a2009-04-03 16:42:41 +0100719 ASSERT(S_ISREG(inode->i_mode));
720 ASSERT(inode->i_mapping->a_ops->bmap);
721 ASSERT(inode->i_mapping->a_ops->readpages);
722
723 /* calculate the shift required to use bmap */
David Howells9ae326a2009-04-03 16:42:41 +0100724 shift = PAGE_SHIFT - inode->i_sb->s_blocksize_bits;
725
726 pagevec_init(&pagevec, 0);
727
David Howells4fbf4292009-11-19 18:11:04 +0000728 op->op.flags &= FSCACHE_OP_KEEP_FLAGS;
Tejun Heo8af7c122010-07-20 22:09:01 +0200729 op->op.flags |= FSCACHE_OP_ASYNC;
David Howells9ae326a2009-04-03 16:42:41 +0100730 op->op.processor = cachefiles_read_copier;
731
732 INIT_LIST_HEAD(&backpages);
733 nrbackpages = 0;
734
735 ret = space ? -ENODATA : -ENOBUFS;
736 list_for_each_entry_safe(page, _n, pages, lru) {
737 sector_t block0, block;
738
739 /* we assume the absence or presence of the first block is a
740 * good enough indication for the page as a whole
741 * - TODO: don't use bmap() for this as it is _not_ actually
742 * good enough for this as it doesn't indicate errors, but
743 * it's all we've got for the moment
744 */
745 block0 = page->index;
746 block0 <<= shift;
747
748 block = inode->i_mapping->a_ops->bmap(inode->i_mapping,
749 block0);
750 _debug("%llx -> %llx",
751 (unsigned long long) block0,
752 (unsigned long long) block);
753
754 if (block) {
755 /* we have data - add it to the list to give to the
756 * backing fs */
757 list_move(&page->lru, &backpages);
758 (*nr_pages)--;
759 nrbackpages++;
760 } else if (space && pagevec_add(&pagevec, page) == 0) {
761 fscache_mark_pages_cached(op, &pagevec);
David Howells9f105232012-12-20 21:52:35 +0000762 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100763 ret = -ENODATA;
David Howells9f105232012-12-20 21:52:35 +0000764 } else {
765 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100766 }
767 }
768
769 if (pagevec_count(&pagevec) > 0)
770 fscache_mark_pages_cached(op, &pagevec);
771
772 if (list_empty(pages))
773 ret = 0;
774
775 /* submit the apparently valid pages to the backing fs to be read from
776 * disk */
777 if (nrbackpages > 0) {
David Howellsc4d6d8d2012-12-20 21:52:32 +0000778 ret2 = cachefiles_read_backing_file(object, op, &backpages);
David Howells9ae326a2009-04-03 16:42:41 +0100779 if (ret2 == -ENOMEM || ret2 == -EINTR)
780 ret = ret2;
781 }
782
David Howells9ae326a2009-04-03 16:42:41 +0100783 _leave(" = %d [nr=%u%s]",
784 ret, *nr_pages, list_empty(pages) ? " empty" : "");
785 return ret;
David Howells9f105232012-12-20 21:52:35 +0000786
787all_enobufs:
788 fscache_retrieval_complete(op, *nr_pages);
789 return -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100790}
791
792/*
793 * allocate a block in the cache in which to store a page
794 * - cache withdrawal is prevented by the caller
795 * - returns -EINTR if interrupted
796 * - returns -ENOMEM if ran out of memory
797 * - returns -ENOBUFS if no buffers can be made available
798 * - returns -ENOBUFS if page is beyond EOF
799 * - otherwise:
800 * - the metadata will be retained
801 * - 0 will be returned
802 */
803int cachefiles_allocate_page(struct fscache_retrieval *op,
804 struct page *page,
805 gfp_t gfp)
806{
807 struct cachefiles_object *object;
808 struct cachefiles_cache *cache;
David Howells9ae326a2009-04-03 16:42:41 +0100809 int ret;
810
811 object = container_of(op->op.object,
812 struct cachefiles_object, fscache);
813 cache = container_of(object->fscache.cache,
814 struct cachefiles_cache, cache);
815
816 _enter("%p,{%lx},", object, page->index);
817
818 ret = cachefiles_has_space(cache, 0, 1);
David Howellsc4d6d8d2012-12-20 21:52:32 +0000819 if (ret == 0)
820 fscache_mark_page_cached(op, page);
821 else
David Howells9ae326a2009-04-03 16:42:41 +0100822 ret = -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100823
David Howells9f105232012-12-20 21:52:35 +0000824 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100825 _leave(" = %d", ret);
826 return ret;
827}
828
829/*
830 * allocate blocks in the cache in which to store a set of pages
831 * - cache withdrawal is prevented by the caller
832 * - returns -EINTR if interrupted
833 * - returns -ENOMEM if ran out of memory
834 * - returns -ENOBUFS if some buffers couldn't be made available
835 * - returns -ENOBUFS if some pages are beyond EOF
836 * - otherwise:
837 * - -ENODATA will be returned
838 * - metadata will be retained for any page marked
839 */
840int cachefiles_allocate_pages(struct fscache_retrieval *op,
841 struct list_head *pages,
842 unsigned *nr_pages,
843 gfp_t gfp)
844{
845 struct cachefiles_object *object;
846 struct cachefiles_cache *cache;
847 struct pagevec pagevec;
848 struct page *page;
849 int ret;
850
851 object = container_of(op->op.object,
852 struct cachefiles_object, fscache);
853 cache = container_of(object->fscache.cache,
854 struct cachefiles_cache, cache);
855
856 _enter("%p,,,%d,", object, *nr_pages);
857
858 ret = cachefiles_has_space(cache, 0, *nr_pages);
859 if (ret == 0) {
860 pagevec_init(&pagevec, 0);
861
862 list_for_each_entry(page, pages, lru) {
863 if (pagevec_add(&pagevec, page) == 0)
864 fscache_mark_pages_cached(op, &pagevec);
865 }
866
867 if (pagevec_count(&pagevec) > 0)
868 fscache_mark_pages_cached(op, &pagevec);
869 ret = -ENODATA;
870 } else {
871 ret = -ENOBUFS;
872 }
873
David Howells9f105232012-12-20 21:52:35 +0000874 fscache_retrieval_complete(op, *nr_pages);
David Howells9ae326a2009-04-03 16:42:41 +0100875 _leave(" = %d", ret);
876 return ret;
877}
878
879/*
880 * request a page be stored in the cache
881 * - cache withdrawal is prevented by the caller
882 * - this request may be ignored if there's no cache block available, in which
883 * case -ENOBUFS will be returned
884 * - if the op is in progress, 0 will be returned
885 */
886int cachefiles_write_page(struct fscache_storage *op, struct page *page)
887{
888 struct cachefiles_object *object;
889 struct cachefiles_cache *cache;
David Howells9ae326a2009-04-03 16:42:41 +0100890 struct file *file;
Al Viro765927b2012-06-26 21:58:53 +0400891 struct path path;
David Howellsa17754f2009-11-19 18:11:52 +0000892 loff_t pos, eof;
893 size_t len;
David Howells9ae326a2009-04-03 16:42:41 +0100894 void *data;
Geert Uytterhoevencf897522015-11-12 11:46:23 +0000895 int ret = -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100896
897 ASSERT(op != NULL);
898 ASSERT(page != NULL);
899
900 object = container_of(op->op.object,
901 struct cachefiles_object, fscache);
902
903 _enter("%p,%p{%lx},,,", object, page, page->index);
904
905 if (!object->backer) {
906 _leave(" = -ENOBUFS");
907 return -ENOBUFS;
908 }
909
David Howellsce40fa72015-01-29 12:02:36 +0000910 ASSERT(d_is_reg(object->backer));
David Howells9ae326a2009-04-03 16:42:41 +0100911
912 cache = container_of(object->fscache.cache,
913 struct cachefiles_cache, cache);
914
David Howells102f4d92015-11-04 15:20:42 +0000915 pos = (loff_t)page->index << PAGE_SHIFT;
916
917 /* We mustn't write more data than we have, so we have to beware of a
918 * partial page at EOF.
919 */
920 eof = object->fscache.store_limit_l;
921 if (pos >= eof)
922 goto error;
923
David Howells9ae326a2009-04-03 16:42:41 +0100924 /* write the page to the backing filesystem and let it store it in its
925 * own time */
Al Viro765927b2012-06-26 21:58:53 +0400926 path.mnt = cache->mnt;
927 path.dentry = object->backer;
Justin Lecher98c350c2012-07-30 14:42:53 -0700928 file = dentry_open(&path, O_RDWR | O_LARGEFILE, cache->cache_cred);
David Howells9ae326a2009-04-03 16:42:41 +0100929 if (IS_ERR(file)) {
930 ret = PTR_ERR(file);
David Howells102f4d92015-11-04 15:20:42 +0000931 goto error_2;
932 }
David Howellsa17754f2009-11-19 18:11:52 +0000933
David Howells102f4d92015-11-04 15:20:42 +0000934 len = PAGE_SIZE;
935 if (eof & ~PAGE_MASK) {
936 if (eof - pos < PAGE_SIZE) {
937 _debug("cut short %llx to %llx",
938 pos, eof);
939 len = eof - pos;
940 ASSERTCMP(pos + len, ==, eof);
David Howells9ae326a2009-04-03 16:42:41 +0100941 }
David Howells9ae326a2009-04-03 16:42:41 +0100942 }
943
David Howells102f4d92015-11-04 15:20:42 +0000944 data = kmap(page);
945 ret = __kernel_write(file, data, len, &pos);
946 kunmap(page);
947 fput(file);
948 if (ret != len)
949 goto error_eio;
David Howells9ae326a2009-04-03 16:42:41 +0100950
David Howells102f4d92015-11-04 15:20:42 +0000951 _leave(" = 0");
952 return 0;
953
954error_eio:
955 ret = -EIO;
956error_2:
957 if (ret == -EIO)
958 cachefiles_io_error_obj(object,
959 "Write page to backing file failed");
960error:
961 _leave(" = -ENOBUFS [%d]", ret);
962 return -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100963}
964
965/*
966 * detach a backing block from a page
967 * - cache withdrawal is prevented by the caller
968 */
969void cachefiles_uncache_page(struct fscache_object *_object, struct page *page)
970{
971 struct cachefiles_object *object;
David Howells9ae326a2009-04-03 16:42:41 +0100972
973 object = container_of(_object, struct cachefiles_object, fscache);
David Howells9ae326a2009-04-03 16:42:41 +0100974
975 _enter("%p,{%lu}", object, page->index);
976
977 spin_unlock(&object->fscache.cookie->lock);
978}