blob: e027c718ca01adea87dbd12bd5fa7b2945fb9c0c [file] [log] [blame]
Thomas Gleixnerb4d0d232019-05-20 19:08:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
David Howells9ae326a2009-04-03 16:42:41 +01002/* Storage object read/write
3 *
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
David Howells9ae326a2009-04-03 16:42:41 +01006 */
7
8#include <linux/mount.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +09009#include <linux/slab.h>
David Howells9ae326a2009-04-03 16:42:41 +010010#include <linux/file.h>
Mel Gormana0b8cab32013-07-03 15:02:32 -070011#include <linux/swap.h>
David Howells9ae326a2009-04-03 16:42:41 +010012#include "internal.h"
13
14/*
15 * detect wake up events generated by the unlocking of pages in which we're
16 * interested
17 * - we use this to detect read completion of backing pages
18 * - the caller holds the waitqueue lock
19 */
Ingo Molnarac6424b2017-06-20 12:06:13 +020020static int cachefiles_read_waiter(wait_queue_entry_t *wait, unsigned mode,
David Howells9ae326a2009-04-03 16:42:41 +010021 int sync, void *_key)
22{
23 struct cachefiles_one_read *monitor =
24 container_of(wait, struct cachefiles_one_read, monitor);
25 struct cachefiles_object *object;
Kiran Kumar Modukuri934140a2017-07-18 16:25:49 -070026 struct fscache_retrieval *op = monitor->op;
David Howells9ae326a2009-04-03 16:42:41 +010027 struct wait_bit_key *key = _key;
28 struct page *page = wait->private;
29
30 ASSERT(key);
31
32 _enter("{%lu},%u,%d,{%p,%u}",
33 monitor->netfs_page->index, mode, sync,
34 key->flags, key->bit_nr);
35
36 if (key->flags != &page->flags ||
37 key->bit_nr != PG_locked)
38 return 0;
39
40 _debug("--- monitor %p %lx ---", page, page->flags);
41
David Howells5e929b32009-11-19 18:11:55 +000042 if (!PageUptodate(page) && !PageError(page)) {
43 /* unlocked, not uptodate and not erronous? */
44 _debug("page probably truncated");
45 }
David Howells9ae326a2009-04-03 16:42:41 +010046
47 /* remove from the waitqueue */
Ingo Molnar2055da92017-06-20 12:06:46 +020048 list_del(&wait->entry);
David Howells9ae326a2009-04-03 16:42:41 +010049
50 /* move onto the action list and queue for FS-Cache thread pool */
Kiran Kumar Modukuri934140a2017-07-18 16:25:49 -070051 ASSERT(op);
David Howells9ae326a2009-04-03 16:42:41 +010052
Kiran Kumar Modukuri934140a2017-07-18 16:25:49 -070053 /* We need to temporarily bump the usage count as we don't own a ref
54 * here otherwise cachefiles_read_copier() may free the op between the
55 * monitor being enqueued on the op->to_do list and the op getting
56 * enqueued on the work queue.
57 */
58 fscache_get_retrieval(op);
David Howells9ae326a2009-04-03 16:42:41 +010059
Kiran Kumar Modukuri934140a2017-07-18 16:25:49 -070060 object = container_of(op->op.object, struct cachefiles_object, fscache);
David Howells9ae326a2009-04-03 16:42:41 +010061 spin_lock(&object->work_lock);
Kiran Kumar Modukuri934140a2017-07-18 16:25:49 -070062 list_add_tail(&monitor->op_link, &op->to_do);
Lei Xue7bb0c532020-05-07 08:50:22 -040063 fscache_enqueue_retrieval(op);
David Howells9ae326a2009-04-03 16:42:41 +010064 spin_unlock(&object->work_lock);
65
Kiran Kumar Modukuri934140a2017-07-18 16:25:49 -070066 fscache_put_retrieval(op);
David Howells9ae326a2009-04-03 16:42:41 +010067 return 0;
68}
69
70/*
David Howells5e929b32009-11-19 18:11:55 +000071 * handle a probably truncated page
72 * - check to see if the page is still relevant and reissue the read if
73 * possible
74 * - return -EIO on error, -ENODATA if the page is gone, -EINPROGRESS if we
75 * must wait again and 0 if successful
76 */
77static int cachefiles_read_reissue(struct cachefiles_object *object,
78 struct cachefiles_one_read *monitor)
79{
David Howells466b77b2015-03-17 22:26:21 +000080 struct address_space *bmapping = d_backing_inode(object->backer)->i_mapping;
David Howells5e929b32009-11-19 18:11:55 +000081 struct page *backpage = monitor->back_page, *backpage2;
82 int ret;
83
David Howells37491a12012-12-20 21:52:34 +000084 _enter("{ino=%lx},{%lx,%lx}",
David Howells466b77b2015-03-17 22:26:21 +000085 d_backing_inode(object->backer)->i_ino,
David Howells5e929b32009-11-19 18:11:55 +000086 backpage->index, backpage->flags);
87
88 /* skip if the page was truncated away completely */
89 if (backpage->mapping != bmapping) {
David Howells37491a12012-12-20 21:52:34 +000090 _leave(" = -ENODATA [mapping]");
David Howells5e929b32009-11-19 18:11:55 +000091 return -ENODATA;
92 }
93
94 backpage2 = find_get_page(bmapping, backpage->index);
95 if (!backpage2) {
David Howells37491a12012-12-20 21:52:34 +000096 _leave(" = -ENODATA [gone]");
David Howells5e929b32009-11-19 18:11:55 +000097 return -ENODATA;
98 }
99
100 if (backpage != backpage2) {
101 put_page(backpage2);
David Howells37491a12012-12-20 21:52:34 +0000102 _leave(" = -ENODATA [different]");
David Howells5e929b32009-11-19 18:11:55 +0000103 return -ENODATA;
104 }
105
106 /* the page is still there and we already have a ref on it, so we don't
107 * need a second */
108 put_page(backpage2);
109
110 INIT_LIST_HEAD(&monitor->op_link);
111 add_page_wait_queue(backpage, &monitor->monitor);
112
113 if (trylock_page(backpage)) {
114 ret = -EIO;
115 if (PageError(backpage))
116 goto unlock_discard;
117 ret = 0;
118 if (PageUptodate(backpage))
119 goto unlock_discard;
120
David Howells37491a12012-12-20 21:52:34 +0000121 _debug("reissue read");
David Howells5e929b32009-11-19 18:11:55 +0000122 ret = bmapping->a_ops->readpage(NULL, backpage);
123 if (ret < 0)
Matthew Wilcox (Oracle)9480b4e2020-10-26 09:12:10 +0000124 goto discard;
David Howells5e929b32009-11-19 18:11:55 +0000125 }
126
127 /* but the page may have been read before the monitor was installed, so
128 * the monitor may miss the event - so we have to ensure that we do get
129 * one in such a case */
130 if (trylock_page(backpage)) {
131 _debug("jumpstart %p {%lx}", backpage, backpage->flags);
132 unlock_page(backpage);
133 }
134
135 /* it'll reappear on the todo list */
David Howells37491a12012-12-20 21:52:34 +0000136 _leave(" = -EINPROGRESS");
David Howells5e929b32009-11-19 18:11:55 +0000137 return -EINPROGRESS;
138
139unlock_discard:
140 unlock_page(backpage);
Matthew Wilcox (Oracle)9480b4e2020-10-26 09:12:10 +0000141discard:
David Howells5e929b32009-11-19 18:11:55 +0000142 spin_lock_irq(&object->work_lock);
143 list_del(&monitor->op_link);
144 spin_unlock_irq(&object->work_lock);
David Howells37491a12012-12-20 21:52:34 +0000145 _leave(" = %d", ret);
David Howells5e929b32009-11-19 18:11:55 +0000146 return ret;
147}
148
149/*
David Howells9ae326a2009-04-03 16:42:41 +0100150 * copy data from backing pages to netfs pages to complete a read operation
151 * - driven by FS-Cache's thread pool
152 */
153static void cachefiles_read_copier(struct fscache_operation *_op)
154{
155 struct cachefiles_one_read *monitor;
156 struct cachefiles_object *object;
157 struct fscache_retrieval *op;
David Howells9ae326a2009-04-03 16:42:41 +0100158 int error, max;
159
160 op = container_of(_op, struct fscache_retrieval, op);
161 object = container_of(op->op.object,
162 struct cachefiles_object, fscache);
163
David Howells466b77b2015-03-17 22:26:21 +0000164 _enter("{ino=%lu}", d_backing_inode(object->backer)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100165
David Howells9ae326a2009-04-03 16:42:41 +0100166 max = 8;
167 spin_lock_irq(&object->work_lock);
168
169 while (!list_empty(&op->to_do)) {
170 monitor = list_entry(op->to_do.next,
171 struct cachefiles_one_read, op_link);
172 list_del(&monitor->op_link);
173
174 spin_unlock_irq(&object->work_lock);
175
176 _debug("- copy {%lu}", monitor->back_page->index);
177
David Howells5e929b32009-11-19 18:11:55 +0000178 recheck:
David Howells9dc8d9b2012-12-20 21:52:36 +0000179 if (test_bit(FSCACHE_COOKIE_INVALIDATING,
180 &object->fscache.cookie->flags)) {
181 error = -ESTALE;
182 } else if (PageUptodate(monitor->back_page)) {
David Howells9ae326a2009-04-03 16:42:41 +0100183 copy_highpage(monitor->netfs_page, monitor->back_page);
David Howellsc4d6d8d2012-12-20 21:52:32 +0000184 fscache_mark_page_cached(monitor->op,
185 monitor->netfs_page);
David Howells9ae326a2009-04-03 16:42:41 +0100186 error = 0;
David Howells5e929b32009-11-19 18:11:55 +0000187 } else if (!PageError(monitor->back_page)) {
188 /* the page has probably been truncated */
189 error = cachefiles_read_reissue(object, monitor);
190 if (error == -EINPROGRESS)
191 goto next;
192 goto recheck;
193 } else {
David Howells9ae326a2009-04-03 16:42:41 +0100194 cachefiles_io_error_obj(
195 object,
196 "Readpage failed on backing file %lx",
197 (unsigned long) monitor->back_page->flags);
David Howells5e929b32009-11-19 18:11:55 +0000198 error = -EIO;
199 }
David Howells9ae326a2009-04-03 16:42:41 +0100200
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300201 put_page(monitor->back_page);
David Howells9ae326a2009-04-03 16:42:41 +0100202
203 fscache_end_io(op, monitor->netfs_page, error);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300204 put_page(monitor->netfs_page);
David Howells9f105232012-12-20 21:52:35 +0000205 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100206 fscache_put_retrieval(op);
207 kfree(monitor);
208
David Howells5e929b32009-11-19 18:11:55 +0000209 next:
David Howells9ae326a2009-04-03 16:42:41 +0100210 /* let the thread pool have some air occasionally */
211 max--;
212 if (max < 0 || need_resched()) {
213 if (!list_empty(&op->to_do))
214 fscache_enqueue_retrieval(op);
215 _leave(" [maxed out]");
216 return;
217 }
218
219 spin_lock_irq(&object->work_lock);
220 }
221
222 spin_unlock_irq(&object->work_lock);
223 _leave("");
224}
225
226/*
227 * read the corresponding page to the given set from the backing file
228 * - an uncertain page is simply discarded, to be tried again another time
229 */
230static int cachefiles_read_backing_file_one(struct cachefiles_object *object,
231 struct fscache_retrieval *op,
Mel Gormana0b8cab32013-07-03 15:02:32 -0700232 struct page *netpage)
David Howells9ae326a2009-04-03 16:42:41 +0100233{
234 struct cachefiles_one_read *monitor;
235 struct address_space *bmapping;
236 struct page *newpage, *backpage;
237 int ret;
238
239 _enter("");
240
David Howells9ae326a2009-04-03 16:42:41 +0100241 _debug("read back %p{%lu,%d}",
242 netpage, netpage->index, page_count(netpage));
243
David Howells5f4f9f42012-12-20 21:52:33 +0000244 monitor = kzalloc(sizeof(*monitor), cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100245 if (!monitor)
246 goto nomem;
247
248 monitor->netfs_page = netpage;
249 monitor->op = fscache_get_retrieval(op);
250
251 init_waitqueue_func_entry(&monitor->monitor, cachefiles_read_waiter);
252
253 /* attempt to get hold of the backing page */
David Howells466b77b2015-03-17 22:26:21 +0000254 bmapping = d_backing_inode(object->backer)->i_mapping;
David Howells9ae326a2009-04-03 16:42:41 +0100255 newpage = NULL;
256
257 for (;;) {
258 backpage = find_get_page(bmapping, netpage->index);
259 if (backpage)
260 goto backing_page_already_present;
261
262 if (!newpage) {
Mel Gorman453f85d2017-11-15 17:38:03 -0800263 newpage = __page_cache_alloc(cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100264 if (!newpage)
265 goto nomem_monitor;
266 }
267
Johannes Weiner55881bc2014-04-03 14:47:36 -0700268 ret = add_to_page_cache_lru(newpage, bmapping,
269 netpage->index, cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100270 if (ret == 0)
271 goto installed_new_backing_page;
272 if (ret != -EEXIST)
273 goto nomem_page;
274 }
275
Johannes Weiner55881bc2014-04-03 14:47:36 -0700276 /* we've installed a new backing page, so now we need to start
277 * it reading */
David Howells9ae326a2009-04-03 16:42:41 +0100278installed_new_backing_page:
279 _debug("- new %p", newpage);
280
281 backpage = newpage;
282 newpage = NULL;
283
David Howells9ae326a2009-04-03 16:42:41 +0100284read_backing_page:
285 ret = bmapping->a_ops->readpage(NULL, backpage);
286 if (ret < 0)
287 goto read_error;
288
289 /* set the monitor to transfer the data across */
290monitor_backing_page:
291 _debug("- monitor add");
292
293 /* install the monitor */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300294 get_page(monitor->netfs_page);
295 get_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100296 monitor->back_page = backpage;
297 monitor->monitor.private = backpage;
298 add_page_wait_queue(backpage, &monitor->monitor);
299 monitor = NULL;
300
301 /* but the page may have been read before the monitor was installed, so
302 * the monitor may miss the event - so we have to ensure that we do get
303 * one in such a case */
304 if (trylock_page(backpage)) {
305 _debug("jumpstart %p {%lx}", backpage, backpage->flags);
306 unlock_page(backpage);
307 }
308 goto success;
309
310 /* if the backing page is already present, it can be in one of
311 * three states: read in progress, read failed or read okay */
312backing_page_already_present:
313 _debug("- present");
314
315 if (newpage) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300316 put_page(newpage);
David Howells9ae326a2009-04-03 16:42:41 +0100317 newpage = NULL;
318 }
319
320 if (PageError(backpage))
321 goto io_error;
322
323 if (PageUptodate(backpage))
324 goto backing_page_already_uptodate;
325
326 if (!trylock_page(backpage))
327 goto monitor_backing_page;
328 _debug("read %p {%lx}", backpage, backpage->flags);
329 goto read_backing_page;
330
331 /* the backing page is already up to date, attach the netfs
332 * page to the pagecache and LRU and copy the data across */
333backing_page_already_uptodate:
334 _debug("- uptodate");
335
David Howellsc4d6d8d2012-12-20 21:52:32 +0000336 fscache_mark_page_cached(op, netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100337
338 copy_highpage(netpage, backpage);
339 fscache_end_io(op, netpage, 0);
David Howells9f105232012-12-20 21:52:35 +0000340 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100341
342success:
343 _debug("success");
344 ret = 0;
345
346out:
347 if (backpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300348 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100349 if (monitor) {
350 fscache_put_retrieval(monitor->op);
351 kfree(monitor);
352 }
353 _leave(" = %d", ret);
354 return ret;
355
356read_error:
357 _debug("read error %d", ret);
David Howellsb4cf1e02012-12-05 13:34:45 +0000358 if (ret == -ENOMEM) {
359 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100360 goto out;
David Howellsb4cf1e02012-12-05 13:34:45 +0000361 }
David Howells9ae326a2009-04-03 16:42:41 +0100362io_error:
363 cachefiles_io_error_obj(object, "Page read error on backing file");
David Howells9f105232012-12-20 21:52:35 +0000364 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100365 ret = -ENOBUFS;
366 goto out;
367
368nomem_page:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300369 put_page(newpage);
David Howells9ae326a2009-04-03 16:42:41 +0100370nomem_monitor:
371 fscache_put_retrieval(monitor->op);
372 kfree(monitor);
373nomem:
David Howells9f105232012-12-20 21:52:35 +0000374 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100375 _leave(" = -ENOMEM");
376 return -ENOMEM;
377}
378
379/*
380 * read a page from the cache or allocate a block in which to store it
381 * - cache withdrawal is prevented by the caller
382 * - returns -EINTR if interrupted
383 * - returns -ENOMEM if ran out of memory
384 * - returns -ENOBUFS if no buffers can be made available
385 * - returns -ENOBUFS if page is beyond EOF
386 * - if the page is backed by a block in the cache:
387 * - a read will be started which will call the callback on completion
388 * - 0 will be returned
389 * - else if the page is unbacked:
390 * - the metadata will be retained
391 * - -ENODATA will be returned
392 */
393int cachefiles_read_or_alloc_page(struct fscache_retrieval *op,
394 struct page *page,
395 gfp_t gfp)
396{
397 struct cachefiles_object *object;
398 struct cachefiles_cache *cache;
David Howells9ae326a2009-04-03 16:42:41 +0100399 struct inode *inode;
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100400 sector_t block;
David Howells9ae326a2009-04-03 16:42:41 +0100401 unsigned shift;
David Howellsc5f9d9d2020-05-04 16:12:55 +0100402 int ret, ret2;
David Howells9ae326a2009-04-03 16:42:41 +0100403
404 object = container_of(op->op.object,
405 struct cachefiles_object, fscache);
406 cache = container_of(object->fscache.cache,
407 struct cachefiles_cache, cache);
408
409 _enter("{%p},{%lx},,,", object, page->index);
410
411 if (!object->backer)
David Howells9f105232012-12-20 21:52:35 +0000412 goto enobufs;
David Howells9ae326a2009-04-03 16:42:41 +0100413
David Howells466b77b2015-03-17 22:26:21 +0000414 inode = d_backing_inode(object->backer);
David Howells9ae326a2009-04-03 16:42:41 +0100415 ASSERT(S_ISREG(inode->i_mode));
David Howells9ae326a2009-04-03 16:42:41 +0100416
417 /* calculate the shift required to use bmap */
David Howells9ae326a2009-04-03 16:42:41 +0100418 shift = PAGE_SHIFT - inode->i_sb->s_blocksize_bits;
419
David Howells4fbf4292009-11-19 18:11:04 +0000420 op->op.flags &= FSCACHE_OP_KEEP_FLAGS;
Tejun Heo8af7c122010-07-20 22:09:01 +0200421 op->op.flags |= FSCACHE_OP_ASYNC;
David Howells9ae326a2009-04-03 16:42:41 +0100422 op->op.processor = cachefiles_read_copier;
423
David Howells9ae326a2009-04-03 16:42:41 +0100424 /* we assume the absence or presence of the first block is a good
425 * enough indication for the page as a whole
426 * - TODO: don't use bmap() for this as it is _not_ actually good
427 * enough for this as it doesn't indicate errors, but it's all we've
428 * got for the moment
429 */
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100430 block = page->index;
431 block <<= shift;
David Howells9ae326a2009-04-03 16:42:41 +0100432
David Howellsc5f9d9d2020-05-04 16:12:55 +0100433 ret2 = bmap(inode, &block);
434 ASSERT(ret2 == 0);
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100435
David Howells9ae326a2009-04-03 16:42:41 +0100436 _debug("%llx -> %llx",
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100437 (unsigned long long) (page->index << shift),
David Howells9ae326a2009-04-03 16:42:41 +0100438 (unsigned long long) block);
439
440 if (block) {
441 /* submit the apparently valid page to the backing fs to be
442 * read from disk */
Mel Gormana0b8cab32013-07-03 15:02:32 -0700443 ret = cachefiles_read_backing_file_one(object, op, page);
David Howells9ae326a2009-04-03 16:42:41 +0100444 } else if (cachefiles_has_space(cache, 0, 1) == 0) {
445 /* there's space in the cache we can use */
David Howellsc4d6d8d2012-12-20 21:52:32 +0000446 fscache_mark_page_cached(op, page);
David Howells9f105232012-12-20 21:52:35 +0000447 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100448 ret = -ENODATA;
449 } else {
David Howells9f105232012-12-20 21:52:35 +0000450 goto enobufs;
David Howells9ae326a2009-04-03 16:42:41 +0100451 }
452
453 _leave(" = %d", ret);
454 return ret;
David Howells9f105232012-12-20 21:52:35 +0000455
456enobufs:
457 fscache_retrieval_complete(op, 1);
458 _leave(" = -ENOBUFS");
459 return -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100460}
461
462/*
463 * read the corresponding pages to the given set from the backing file
464 * - any uncertain pages are simply discarded, to be tried again another time
465 */
466static int cachefiles_read_backing_file(struct cachefiles_object *object,
467 struct fscache_retrieval *op,
David Howellsc4d6d8d2012-12-20 21:52:32 +0000468 struct list_head *list)
David Howells9ae326a2009-04-03 16:42:41 +0100469{
470 struct cachefiles_one_read *monitor = NULL;
David Howells466b77b2015-03-17 22:26:21 +0000471 struct address_space *bmapping = d_backing_inode(object->backer)->i_mapping;
David Howells9ae326a2009-04-03 16:42:41 +0100472 struct page *newpage = NULL, *netpage, *_n, *backpage = NULL;
473 int ret = 0;
474
475 _enter("");
476
David Howells9ae326a2009-04-03 16:42:41 +0100477 list_for_each_entry_safe(netpage, _n, list, lru) {
478 list_del(&netpage->lru);
479
480 _debug("read back %p{%lu,%d}",
481 netpage, netpage->index, page_count(netpage));
482
483 if (!monitor) {
David Howells5f4f9f42012-12-20 21:52:33 +0000484 monitor = kzalloc(sizeof(*monitor), cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100485 if (!monitor)
486 goto nomem;
487
488 monitor->op = fscache_get_retrieval(op);
489 init_waitqueue_func_entry(&monitor->monitor,
490 cachefiles_read_waiter);
491 }
492
493 for (;;) {
494 backpage = find_get_page(bmapping, netpage->index);
495 if (backpage)
496 goto backing_page_already_present;
497
498 if (!newpage) {
Mel Gorman453f85d2017-11-15 17:38:03 -0800499 newpage = __page_cache_alloc(cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100500 if (!newpage)
501 goto nomem;
502 }
503
Johannes Weiner55881bc2014-04-03 14:47:36 -0700504 ret = add_to_page_cache_lru(newpage, bmapping,
505 netpage->index,
506 cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100507 if (ret == 0)
508 goto installed_new_backing_page;
509 if (ret != -EEXIST)
510 goto nomem;
511 }
512
Johannes Weiner55881bc2014-04-03 14:47:36 -0700513 /* we've installed a new backing page, so now we need
514 * to start it reading */
David Howells9ae326a2009-04-03 16:42:41 +0100515 installed_new_backing_page:
516 _debug("- new %p", newpage);
517
518 backpage = newpage;
519 newpage = NULL;
520
David Howells9ae326a2009-04-03 16:42:41 +0100521 reread_backing_page:
522 ret = bmapping->a_ops->readpage(NULL, backpage);
523 if (ret < 0)
524 goto read_error;
525
526 /* add the netfs page to the pagecache and LRU, and set the
527 * monitor to transfer the data across */
528 monitor_backing_page:
529 _debug("- monitor add");
530
Johannes Weiner55881bc2014-04-03 14:47:36 -0700531 ret = add_to_page_cache_lru(netpage, op->mapping,
532 netpage->index, cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100533 if (ret < 0) {
534 if (ret == -EEXIST) {
Kiran Kumar Modukuri9a24ce5b2018-09-24 12:02:39 +1000535 put_page(backpage);
536 backpage = NULL;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300537 put_page(netpage);
Kiran Kumar Modukuri9a24ce5b2018-09-24 12:02:39 +1000538 netpage = NULL;
David Howellsb4cf1e02012-12-05 13:34:45 +0000539 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100540 continue;
541 }
542 goto nomem;
543 }
544
David Howells9ae326a2009-04-03 16:42:41 +0100545 /* install a monitor */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300546 get_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100547 monitor->netfs_page = netpage;
548
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300549 get_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100550 monitor->back_page = backpage;
551 monitor->monitor.private = backpage;
552 add_page_wait_queue(backpage, &monitor->monitor);
553 monitor = NULL;
554
555 /* but the page may have been read before the monitor was
556 * installed, so the monitor may miss the event - so we have to
557 * ensure that we do get one in such a case */
558 if (trylock_page(backpage)) {
559 _debug("2unlock %p {%lx}", backpage, backpage->flags);
560 unlock_page(backpage);
561 }
562
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300563 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100564 backpage = NULL;
565
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300566 put_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100567 netpage = NULL;
568 continue;
569
570 /* if the backing page is already present, it can be in one of
571 * three states: read in progress, read failed or read okay */
572 backing_page_already_present:
573 _debug("- present %p", backpage);
574
575 if (PageError(backpage))
576 goto io_error;
577
578 if (PageUptodate(backpage))
579 goto backing_page_already_uptodate;
580
581 _debug("- not ready %p{%lx}", backpage, backpage->flags);
582
583 if (!trylock_page(backpage))
584 goto monitor_backing_page;
585
586 if (PageError(backpage)) {
587 _debug("error %lx", backpage->flags);
588 unlock_page(backpage);
589 goto io_error;
590 }
591
592 if (PageUptodate(backpage))
593 goto backing_page_already_uptodate_unlock;
594
595 /* we've locked a page that's neither up to date nor erroneous,
596 * so we need to attempt to read it again */
597 goto reread_backing_page;
598
599 /* the backing page is already up to date, attach the netfs
600 * page to the pagecache and LRU and copy the data across */
601 backing_page_already_uptodate_unlock:
602 _debug("uptodate %lx", backpage->flags);
603 unlock_page(backpage);
604 backing_page_already_uptodate:
605 _debug("- uptodate");
606
Johannes Weiner55881bc2014-04-03 14:47:36 -0700607 ret = add_to_page_cache_lru(netpage, op->mapping,
608 netpage->index, cachefiles_gfp);
David Howells9ae326a2009-04-03 16:42:41 +0100609 if (ret < 0) {
610 if (ret == -EEXIST) {
Kiran Kumar Modukuri9a24ce5b2018-09-24 12:02:39 +1000611 put_page(backpage);
612 backpage = NULL;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300613 put_page(netpage);
Kiran Kumar Modukuri9a24ce5b2018-09-24 12:02:39 +1000614 netpage = NULL;
David Howellsb4cf1e02012-12-05 13:34:45 +0000615 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100616 continue;
617 }
618 goto nomem;
619 }
620
621 copy_highpage(netpage, backpage);
622
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300623 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100624 backpage = NULL;
625
David Howellsc4d6d8d2012-12-20 21:52:32 +0000626 fscache_mark_page_cached(op, netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100627
David Howellsc4d6d8d2012-12-20 21:52:32 +0000628 /* the netpage is unlocked and marked up to date here */
David Howells9ae326a2009-04-03 16:42:41 +0100629 fscache_end_io(op, netpage, 0);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300630 put_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100631 netpage = NULL;
David Howellsb4cf1e02012-12-05 13:34:45 +0000632 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100633 continue;
634 }
635
636 netpage = NULL;
637
638 _debug("out");
639
640out:
641 /* tidy up */
David Howells9ae326a2009-04-03 16:42:41 +0100642 if (newpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300643 put_page(newpage);
David Howells9ae326a2009-04-03 16:42:41 +0100644 if (netpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300645 put_page(netpage);
David Howells9ae326a2009-04-03 16:42:41 +0100646 if (backpage)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300647 put_page(backpage);
David Howells9ae326a2009-04-03 16:42:41 +0100648 if (monitor) {
649 fscache_put_retrieval(op);
650 kfree(monitor);
651 }
652
653 list_for_each_entry_safe(netpage, _n, list, lru) {
654 list_del(&netpage->lru);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300655 put_page(netpage);
David Howells9f105232012-12-20 21:52:35 +0000656 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100657 }
658
659 _leave(" = %d", ret);
660 return ret;
661
662nomem:
663 _debug("nomem");
664 ret = -ENOMEM;
David Howellsb4cf1e02012-12-05 13:34:45 +0000665 goto record_page_complete;
David Howells9ae326a2009-04-03 16:42:41 +0100666
667read_error:
668 _debug("read error %d", ret);
669 if (ret == -ENOMEM)
David Howellsb4cf1e02012-12-05 13:34:45 +0000670 goto record_page_complete;
David Howells9ae326a2009-04-03 16:42:41 +0100671io_error:
672 cachefiles_io_error_obj(object, "Page read error on backing file");
673 ret = -ENOBUFS;
David Howellsb4cf1e02012-12-05 13:34:45 +0000674record_page_complete:
675 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100676 goto out;
677}
678
679/*
680 * read a list of pages from the cache or allocate blocks in which to store
681 * them
682 */
683int cachefiles_read_or_alloc_pages(struct fscache_retrieval *op,
684 struct list_head *pages,
685 unsigned *nr_pages,
686 gfp_t gfp)
687{
688 struct cachefiles_object *object;
689 struct cachefiles_cache *cache;
690 struct list_head backpages;
691 struct pagevec pagevec;
692 struct inode *inode;
693 struct page *page, *_n;
694 unsigned shift, nrbackpages;
695 int ret, ret2, space;
696
697 object = container_of(op->op.object,
698 struct cachefiles_object, fscache);
699 cache = container_of(object->fscache.cache,
700 struct cachefiles_cache, cache);
701
702 _enter("{OBJ%x,%d},,%d,,",
703 object->fscache.debug_id, atomic_read(&op->op.usage),
704 *nr_pages);
705
706 if (!object->backer)
David Howells9f105232012-12-20 21:52:35 +0000707 goto all_enobufs;
David Howells9ae326a2009-04-03 16:42:41 +0100708
709 space = 1;
710 if (cachefiles_has_space(cache, 0, *nr_pages) < 0)
711 space = 0;
712
David Howells466b77b2015-03-17 22:26:21 +0000713 inode = d_backing_inode(object->backer);
David Howells9ae326a2009-04-03 16:42:41 +0100714 ASSERT(S_ISREG(inode->i_mode));
David Howells9ae326a2009-04-03 16:42:41 +0100715
716 /* calculate the shift required to use bmap */
David Howells9ae326a2009-04-03 16:42:41 +0100717 shift = PAGE_SHIFT - inode->i_sb->s_blocksize_bits;
718
Mel Gorman86679822017-11-15 17:37:52 -0800719 pagevec_init(&pagevec);
David Howells9ae326a2009-04-03 16:42:41 +0100720
David Howells4fbf4292009-11-19 18:11:04 +0000721 op->op.flags &= FSCACHE_OP_KEEP_FLAGS;
Tejun Heo8af7c122010-07-20 22:09:01 +0200722 op->op.flags |= FSCACHE_OP_ASYNC;
David Howells9ae326a2009-04-03 16:42:41 +0100723 op->op.processor = cachefiles_read_copier;
724
725 INIT_LIST_HEAD(&backpages);
726 nrbackpages = 0;
727
728 ret = space ? -ENODATA : -ENOBUFS;
729 list_for_each_entry_safe(page, _n, pages, lru) {
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100730 sector_t block;
David Howells9ae326a2009-04-03 16:42:41 +0100731
732 /* we assume the absence or presence of the first block is a
733 * good enough indication for the page as a whole
734 * - TODO: don't use bmap() for this as it is _not_ actually
735 * good enough for this as it doesn't indicate errors, but
736 * it's all we've got for the moment
737 */
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100738 block = page->index;
739 block <<= shift;
David Howells9ae326a2009-04-03 16:42:41 +0100740
David Howellsc5f9d9d2020-05-04 16:12:55 +0100741 ret2 = bmap(inode, &block);
742 ASSERT(ret2 == 0);
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100743
David Howells9ae326a2009-04-03 16:42:41 +0100744 _debug("%llx -> %llx",
Carlos Maiolino10d83e112020-01-09 14:30:42 +0100745 (unsigned long long) (page->index << shift),
David Howells9ae326a2009-04-03 16:42:41 +0100746 (unsigned long long) block);
747
748 if (block) {
749 /* we have data - add it to the list to give to the
750 * backing fs */
751 list_move(&page->lru, &backpages);
752 (*nr_pages)--;
753 nrbackpages++;
754 } else if (space && pagevec_add(&pagevec, page) == 0) {
755 fscache_mark_pages_cached(op, &pagevec);
David Howells9f105232012-12-20 21:52:35 +0000756 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100757 ret = -ENODATA;
David Howells9f105232012-12-20 21:52:35 +0000758 } else {
759 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100760 }
761 }
762
763 if (pagevec_count(&pagevec) > 0)
764 fscache_mark_pages_cached(op, &pagevec);
765
766 if (list_empty(pages))
767 ret = 0;
768
769 /* submit the apparently valid pages to the backing fs to be read from
770 * disk */
771 if (nrbackpages > 0) {
David Howellsc4d6d8d2012-12-20 21:52:32 +0000772 ret2 = cachefiles_read_backing_file(object, op, &backpages);
David Howells9ae326a2009-04-03 16:42:41 +0100773 if (ret2 == -ENOMEM || ret2 == -EINTR)
774 ret = ret2;
775 }
776
David Howells9ae326a2009-04-03 16:42:41 +0100777 _leave(" = %d [nr=%u%s]",
778 ret, *nr_pages, list_empty(pages) ? " empty" : "");
779 return ret;
David Howells9f105232012-12-20 21:52:35 +0000780
781all_enobufs:
782 fscache_retrieval_complete(op, *nr_pages);
783 return -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100784}
785
786/*
787 * allocate a block in the cache in which to store a page
788 * - cache withdrawal is prevented by the caller
789 * - returns -EINTR if interrupted
790 * - returns -ENOMEM if ran out of memory
791 * - returns -ENOBUFS if no buffers can be made available
792 * - returns -ENOBUFS if page is beyond EOF
793 * - otherwise:
794 * - the metadata will be retained
795 * - 0 will be returned
796 */
797int cachefiles_allocate_page(struct fscache_retrieval *op,
798 struct page *page,
799 gfp_t gfp)
800{
801 struct cachefiles_object *object;
802 struct cachefiles_cache *cache;
David Howells9ae326a2009-04-03 16:42:41 +0100803 int ret;
804
805 object = container_of(op->op.object,
806 struct cachefiles_object, fscache);
807 cache = container_of(object->fscache.cache,
808 struct cachefiles_cache, cache);
809
810 _enter("%p,{%lx},", object, page->index);
811
812 ret = cachefiles_has_space(cache, 0, 1);
David Howellsc4d6d8d2012-12-20 21:52:32 +0000813 if (ret == 0)
814 fscache_mark_page_cached(op, page);
815 else
David Howells9ae326a2009-04-03 16:42:41 +0100816 ret = -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100817
David Howells9f105232012-12-20 21:52:35 +0000818 fscache_retrieval_complete(op, 1);
David Howells9ae326a2009-04-03 16:42:41 +0100819 _leave(" = %d", ret);
820 return ret;
821}
822
823/*
824 * allocate blocks in the cache in which to store a set of pages
825 * - cache withdrawal is prevented by the caller
826 * - returns -EINTR if interrupted
827 * - returns -ENOMEM if ran out of memory
828 * - returns -ENOBUFS if some buffers couldn't be made available
829 * - returns -ENOBUFS if some pages are beyond EOF
830 * - otherwise:
831 * - -ENODATA will be returned
832 * - metadata will be retained for any page marked
833 */
834int cachefiles_allocate_pages(struct fscache_retrieval *op,
835 struct list_head *pages,
836 unsigned *nr_pages,
837 gfp_t gfp)
838{
839 struct cachefiles_object *object;
840 struct cachefiles_cache *cache;
841 struct pagevec pagevec;
842 struct page *page;
843 int ret;
844
845 object = container_of(op->op.object,
846 struct cachefiles_object, fscache);
847 cache = container_of(object->fscache.cache,
848 struct cachefiles_cache, cache);
849
850 _enter("%p,,,%d,", object, *nr_pages);
851
852 ret = cachefiles_has_space(cache, 0, *nr_pages);
853 if (ret == 0) {
Mel Gorman86679822017-11-15 17:37:52 -0800854 pagevec_init(&pagevec);
David Howells9ae326a2009-04-03 16:42:41 +0100855
856 list_for_each_entry(page, pages, lru) {
857 if (pagevec_add(&pagevec, page) == 0)
858 fscache_mark_pages_cached(op, &pagevec);
859 }
860
861 if (pagevec_count(&pagevec) > 0)
862 fscache_mark_pages_cached(op, &pagevec);
863 ret = -ENODATA;
864 } else {
865 ret = -ENOBUFS;
866 }
867
David Howells9f105232012-12-20 21:52:35 +0000868 fscache_retrieval_complete(op, *nr_pages);
David Howells9ae326a2009-04-03 16:42:41 +0100869 _leave(" = %d", ret);
870 return ret;
871}
872
873/*
874 * request a page be stored in the cache
875 * - cache withdrawal is prevented by the caller
876 * - this request may be ignored if there's no cache block available, in which
877 * case -ENOBUFS will be returned
878 * - if the op is in progress, 0 will be returned
879 */
880int cachefiles_write_page(struct fscache_storage *op, struct page *page)
881{
882 struct cachefiles_object *object;
883 struct cachefiles_cache *cache;
David Howells9ae326a2009-04-03 16:42:41 +0100884 struct file *file;
Al Viro765927b2012-06-26 21:58:53 +0400885 struct path path;
David Howellsa17754f2009-11-19 18:11:52 +0000886 loff_t pos, eof;
887 size_t len;
David Howells9ae326a2009-04-03 16:42:41 +0100888 void *data;
Geert Uytterhoevencf897522015-11-12 11:46:23 +0000889 int ret = -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100890
891 ASSERT(op != NULL);
892 ASSERT(page != NULL);
893
894 object = container_of(op->op.object,
895 struct cachefiles_object, fscache);
896
897 _enter("%p,%p{%lx},,,", object, page, page->index);
898
899 if (!object->backer) {
900 _leave(" = -ENOBUFS");
901 return -ENOBUFS;
902 }
903
David Howellsce40fa72015-01-29 12:02:36 +0000904 ASSERT(d_is_reg(object->backer));
David Howells9ae326a2009-04-03 16:42:41 +0100905
906 cache = container_of(object->fscache.cache,
907 struct cachefiles_cache, cache);
908
David Howells102f4d92015-11-04 15:20:42 +0000909 pos = (loff_t)page->index << PAGE_SHIFT;
910
911 /* We mustn't write more data than we have, so we have to beware of a
912 * partial page at EOF.
913 */
914 eof = object->fscache.store_limit_l;
915 if (pos >= eof)
916 goto error;
917
David Howells9ae326a2009-04-03 16:42:41 +0100918 /* write the page to the backing filesystem and let it store it in its
919 * own time */
Al Viro765927b2012-06-26 21:58:53 +0400920 path.mnt = cache->mnt;
921 path.dentry = object->backer;
Justin Lecher98c350c2012-07-30 14:42:53 -0700922 file = dentry_open(&path, O_RDWR | O_LARGEFILE, cache->cache_cred);
David Howells9ae326a2009-04-03 16:42:41 +0100923 if (IS_ERR(file)) {
924 ret = PTR_ERR(file);
David Howells102f4d92015-11-04 15:20:42 +0000925 goto error_2;
926 }
David Howellsa17754f2009-11-19 18:11:52 +0000927
David Howells102f4d92015-11-04 15:20:42 +0000928 len = PAGE_SIZE;
929 if (eof & ~PAGE_MASK) {
930 if (eof - pos < PAGE_SIZE) {
931 _debug("cut short %llx to %llx",
932 pos, eof);
933 len = eof - pos;
934 ASSERTCMP(pos + len, ==, eof);
David Howells9ae326a2009-04-03 16:42:41 +0100935 }
David Howells9ae326a2009-04-03 16:42:41 +0100936 }
937
David Howells102f4d92015-11-04 15:20:42 +0000938 data = kmap(page);
Christoph Hellwig97c79902020-05-13 08:42:36 +0200939 ret = kernel_write(file, data, len, &pos);
David Howells102f4d92015-11-04 15:20:42 +0000940 kunmap(page);
941 fput(file);
942 if (ret != len)
943 goto error_eio;
David Howells9ae326a2009-04-03 16:42:41 +0100944
David Howells102f4d92015-11-04 15:20:42 +0000945 _leave(" = 0");
946 return 0;
947
948error_eio:
949 ret = -EIO;
950error_2:
951 if (ret == -EIO)
952 cachefiles_io_error_obj(object,
953 "Write page to backing file failed");
954error:
955 _leave(" = -ENOBUFS [%d]", ret);
956 return -ENOBUFS;
David Howells9ae326a2009-04-03 16:42:41 +0100957}
958
959/*
960 * detach a backing block from a page
961 * - cache withdrawal is prevented by the caller
962 */
963void cachefiles_uncache_page(struct fscache_object *_object, struct page *page)
David Howellsbfa38372018-04-04 13:41:26 +0100964 __releases(&object->fscache.cookie->lock)
David Howells9ae326a2009-04-03 16:42:41 +0100965{
966 struct cachefiles_object *object;
David Howells9ae326a2009-04-03 16:42:41 +0100967
968 object = container_of(_object, struct cachefiles_object, fscache);
David Howells9ae326a2009-04-03 16:42:41 +0100969
970 _enter("%p,{%lu}", object, page->index);
971
972 spin_unlock(&object->fscache.cookie->lock);
973}