1 /* Cache page management and data I/O routines
3 * Copyright (C) 2004-2008 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #define FSCACHE_DEBUG_LEVEL PAGE
13 #include <linux/module.h>
14 #include <linux/fscache-cache.h>
15 #include <linux/buffer_head.h>
16 #include <linux/pagevec.h>
17 #include <linux/slab.h>
21 * check to see if a page is being written to the cache
23 bool __fscache_check_page_write(struct fscache_cookie
*cookie
, struct page
*page
)
28 val
= radix_tree_lookup(&cookie
->stores
, page
->index
);
33 EXPORT_SYMBOL(__fscache_check_page_write
);
36 * wait for a page to finish being written to the cache
38 void __fscache_wait_on_page_write(struct fscache_cookie
*cookie
, struct page
*page
)
40 wait_queue_head_t
*wq
= bit_waitqueue(&cookie
->flags
, 0);
42 wait_event(*wq
, !__fscache_check_page_write(cookie
, page
));
44 EXPORT_SYMBOL(__fscache_wait_on_page_write
);
47 * wait for a page to finish being written to the cache. Put a timeout here
48 * since we might be called recursively via parent fs.
51 bool release_page_wait_timeout(struct fscache_cookie
*cookie
, struct page
*page
)
53 wait_queue_head_t
*wq
= bit_waitqueue(&cookie
->flags
, 0);
55 return wait_event_timeout(*wq
, !__fscache_check_page_write(cookie
, page
),
60 * decide whether a page can be released, possibly by cancelling a store to it
61 * - we're allowed to sleep if __GFP_WAIT is flagged
63 bool __fscache_maybe_release_page(struct fscache_cookie
*cookie
,
70 _enter("%p,%p,%x", cookie
, page
, gfp
);
74 val
= radix_tree_lookup(&cookie
->stores
, page
->index
);
77 fscache_stat(&fscache_n_store_vmscan_not_storing
);
78 __fscache_uncache_page(cookie
, page
);
82 /* see if the page is actually undergoing storage - if so we can't get
83 * rid of it till the cache has finished with it */
84 if (radix_tree_tag_get(&cookie
->stores
, page
->index
,
85 FSCACHE_COOKIE_STORING_TAG
)) {
90 /* the page is pending storage, so we attempt to cancel the store and
91 * discard the store request so that the page can be reclaimed */
92 spin_lock(&cookie
->stores_lock
);
95 if (radix_tree_tag_get(&cookie
->stores
, page
->index
,
96 FSCACHE_COOKIE_STORING_TAG
)) {
97 /* the page started to undergo storage whilst we were looking,
98 * so now we can only wait or return */
99 spin_unlock(&cookie
->stores_lock
);
103 xpage
= radix_tree_delete(&cookie
->stores
, page
->index
);
104 spin_unlock(&cookie
->stores_lock
);
107 fscache_stat(&fscache_n_store_vmscan_cancelled
);
108 fscache_stat(&fscache_n_store_radix_deletes
);
109 ASSERTCMP(xpage
, ==, page
);
111 fscache_stat(&fscache_n_store_vmscan_gone
);
114 wake_up_bit(&cookie
->flags
, 0);
116 page_cache_release(xpage
);
117 __fscache_uncache_page(cookie
, page
);
121 /* We will wait here if we're allowed to, but that could deadlock the
122 * allocator as the work threads writing to the cache may all end up
123 * sleeping on memory allocation, so we may need to impose a timeout
125 if (!(gfp
& __GFP_WAIT
) || !(gfp
& __GFP_FS
)) {
126 fscache_stat(&fscache_n_store_vmscan_busy
);
130 fscache_stat(&fscache_n_store_vmscan_wait
);
131 if (!release_page_wait_timeout(cookie
, page
))
132 _debug("fscache writeout timeout page: %p{%lx}",
138 EXPORT_SYMBOL(__fscache_maybe_release_page
);
141 * note that a page has finished being written to the cache
143 static void fscache_end_page_write(struct fscache_object
*object
,
146 struct fscache_cookie
*cookie
;
147 struct page
*xpage
= NULL
;
149 spin_lock(&object
->lock
);
150 cookie
= object
->cookie
;
152 /* delete the page from the tree if it is now no longer
154 spin_lock(&cookie
->stores_lock
);
155 radix_tree_tag_clear(&cookie
->stores
, page
->index
,
156 FSCACHE_COOKIE_STORING_TAG
);
157 if (!radix_tree_tag_get(&cookie
->stores
, page
->index
,
158 FSCACHE_COOKIE_PENDING_TAG
)) {
159 fscache_stat(&fscache_n_store_radix_deletes
);
160 xpage
= radix_tree_delete(&cookie
->stores
, page
->index
);
162 spin_unlock(&cookie
->stores_lock
);
163 wake_up_bit(&cookie
->flags
, 0);
165 spin_unlock(&object
->lock
);
167 page_cache_release(xpage
);
171 * actually apply the changed attributes to a cache object
173 static void fscache_attr_changed_op(struct fscache_operation
*op
)
175 struct fscache_object
*object
= op
->object
;
178 _enter("{OBJ%x OP%x}", object
->debug_id
, op
->debug_id
);
180 fscache_stat(&fscache_n_attr_changed_calls
);
182 if (fscache_object_is_active(object
)) {
183 fscache_stat(&fscache_n_cop_attr_changed
);
184 ret
= object
->cache
->ops
->attr_changed(object
);
185 fscache_stat_d(&fscache_n_cop_attr_changed
);
187 fscache_abort_object(object
);
190 fscache_op_complete(op
, true);
195 * notification that the attributes on an object have changed
197 int __fscache_attr_changed(struct fscache_cookie
*cookie
)
199 struct fscache_operation
*op
;
200 struct fscache_object
*object
;
201 bool wake_cookie
= false;
203 _enter("%p", cookie
);
205 ASSERTCMP(cookie
->def
->type
, !=, FSCACHE_COOKIE_TYPE_INDEX
);
207 fscache_stat(&fscache_n_attr_changed
);
209 op
= kzalloc(sizeof(*op
), GFP_KERNEL
);
211 fscache_stat(&fscache_n_attr_changed_nomem
);
212 _leave(" = -ENOMEM");
216 fscache_operation_init(op
, fscache_attr_changed_op
, NULL
);
217 op
->flags
= FSCACHE_OP_ASYNC
|
218 (1 << FSCACHE_OP_EXCLUSIVE
) |
219 (1 << FSCACHE_OP_UNUSE_COOKIE
);
221 spin_lock(&cookie
->lock
);
223 if (!fscache_cookie_enabled(cookie
) ||
224 hlist_empty(&cookie
->backing_objects
))
226 object
= hlist_entry(cookie
->backing_objects
.first
,
227 struct fscache_object
, cookie_link
);
229 __fscache_use_cookie(cookie
);
230 if (fscache_submit_exclusive_op(object
, op
) < 0)
232 spin_unlock(&cookie
->lock
);
233 fscache_stat(&fscache_n_attr_changed_ok
);
234 fscache_put_operation(op
);
239 wake_cookie
= __fscache_unuse_cookie(cookie
);
241 spin_unlock(&cookie
->lock
);
244 __fscache_wake_unused_cookie(cookie
);
245 fscache_stat(&fscache_n_attr_changed_nobufs
);
246 _leave(" = %d", -ENOBUFS
);
249 EXPORT_SYMBOL(__fscache_attr_changed
);
252 * release a retrieval op reference
254 static void fscache_release_retrieval_op(struct fscache_operation
*_op
)
256 struct fscache_retrieval
*op
=
257 container_of(_op
, struct fscache_retrieval
, op
);
259 _enter("{OP%x}", op
->op
.debug_id
);
261 ASSERTCMP(atomic_read(&op
->n_pages
), ==, 0);
263 fscache_hist(fscache_retrieval_histogram
, op
->start_time
);
265 fscache_put_context(op
->op
.object
->cookie
, op
->context
);
271 * allocate a retrieval op
273 static struct fscache_retrieval
*fscache_alloc_retrieval(
274 struct fscache_cookie
*cookie
,
275 struct address_space
*mapping
,
276 fscache_rw_complete_t end_io_func
,
279 struct fscache_retrieval
*op
;
281 /* allocate a retrieval operation and attempt to submit it */
282 op
= kzalloc(sizeof(*op
), GFP_NOIO
);
284 fscache_stat(&fscache_n_retrievals_nomem
);
288 fscache_operation_init(&op
->op
, NULL
, fscache_release_retrieval_op
);
289 op
->op
.flags
= FSCACHE_OP_MYTHREAD
|
290 (1UL << FSCACHE_OP_WAITING
) |
291 (1UL << FSCACHE_OP_UNUSE_COOKIE
);
292 op
->mapping
= mapping
;
293 op
->end_io_func
= end_io_func
;
294 op
->context
= context
;
295 op
->start_time
= jiffies
;
296 INIT_LIST_HEAD(&op
->to_do
);
301 * wait for a deferred lookup to complete
303 int fscache_wait_for_deferred_lookup(struct fscache_cookie
*cookie
)
309 if (!test_bit(FSCACHE_COOKIE_LOOKING_UP
, &cookie
->flags
)) {
310 _leave(" = 0 [imm]");
314 fscache_stat(&fscache_n_retrievals_wait
);
317 if (wait_on_bit(&cookie
->flags
, FSCACHE_COOKIE_LOOKING_UP
,
318 TASK_INTERRUPTIBLE
) != 0) {
319 fscache_stat(&fscache_n_retrievals_intr
);
320 _leave(" = -ERESTARTSYS");
324 ASSERT(!test_bit(FSCACHE_COOKIE_LOOKING_UP
, &cookie
->flags
));
327 fscache_hist(fscache_retrieval_delay_histogram
, jif
);
328 _leave(" = 0 [dly]");
333 * Handle cancellation of a pending retrieval op
335 static void fscache_do_cancel_retrieval(struct fscache_operation
*_op
)
337 struct fscache_retrieval
*op
=
338 container_of(_op
, struct fscache_retrieval
, op
);
340 atomic_set(&op
->n_pages
, 0);
344 * wait for an object to become active (or dead)
346 int fscache_wait_for_operation_activation(struct fscache_object
*object
,
347 struct fscache_operation
*op
,
348 atomic_t
*stat_op_waits
,
349 atomic_t
*stat_object_dead
,
350 void (*do_cancel
)(struct fscache_operation
*))
354 if (!test_bit(FSCACHE_OP_WAITING
, &op
->flags
))
359 fscache_stat(stat_op_waits
);
360 if (wait_on_bit(&op
->flags
, FSCACHE_OP_WAITING
,
361 TASK_INTERRUPTIBLE
) != 0) {
362 ret
= fscache_cancel_op(op
, do_cancel
);
366 /* it's been removed from the pending queue by another party,
367 * so we should get to run shortly */
368 wait_on_bit(&op
->flags
, FSCACHE_OP_WAITING
,
369 TASK_UNINTERRUPTIBLE
);
374 if (op
->state
== FSCACHE_OP_ST_CANCELLED
) {
375 if (stat_object_dead
)
376 fscache_stat(stat_object_dead
);
377 _leave(" = -ENOBUFS [cancelled]");
380 if (unlikely(fscache_object_is_dead(object
))) {
381 pr_err("%s() = -ENOBUFS [obj dead %d]\n", __func__
, op
->state
);
382 fscache_cancel_op(op
, do_cancel
);
383 if (stat_object_dead
)
384 fscache_stat(stat_object_dead
);
391 * read a page from the cache or allocate a block in which to store it
393 * -ENOMEM - out of memory, nothing done
394 * -ERESTARTSYS - interrupted
395 * -ENOBUFS - no backing object available in which to cache the block
396 * -ENODATA - no data available in the backing object for this block
397 * 0 - dispatched a read - it'll call end_io_func() when finished
399 int __fscache_read_or_alloc_page(struct fscache_cookie
*cookie
,
401 fscache_rw_complete_t end_io_func
,
405 struct fscache_retrieval
*op
;
406 struct fscache_object
*object
;
407 bool wake_cookie
= false;
410 _enter("%p,%p,,,", cookie
, page
);
412 fscache_stat(&fscache_n_retrievals
);
414 if (hlist_empty(&cookie
->backing_objects
))
417 if (test_bit(FSCACHE_COOKIE_INVALIDATING
, &cookie
->flags
)) {
418 _leave(" = -ENOBUFS [invalidating]");
422 ASSERTCMP(cookie
->def
->type
, !=, FSCACHE_COOKIE_TYPE_INDEX
);
423 ASSERTCMP(page
, !=, NULL
);
425 if (fscache_wait_for_deferred_lookup(cookie
) < 0)
428 op
= fscache_alloc_retrieval(cookie
, page
->mapping
,
429 end_io_func
, context
);
431 _leave(" = -ENOMEM");
434 atomic_set(&op
->n_pages
, 1);
436 spin_lock(&cookie
->lock
);
438 if (!fscache_cookie_enabled(cookie
) ||
439 hlist_empty(&cookie
->backing_objects
))
441 object
= hlist_entry(cookie
->backing_objects
.first
,
442 struct fscache_object
, cookie_link
);
444 ASSERT(test_bit(FSCACHE_OBJECT_IS_LOOKED_UP
, &object
->flags
));
446 __fscache_use_cookie(cookie
);
447 atomic_inc(&object
->n_reads
);
448 __set_bit(FSCACHE_OP_DEC_READ_CNT
, &op
->op
.flags
);
450 if (fscache_submit_op(object
, &op
->op
) < 0)
451 goto nobufs_unlock_dec
;
452 spin_unlock(&cookie
->lock
);
454 fscache_stat(&fscache_n_retrieval_ops
);
456 /* pin the netfs read context in case we need to do the actual netfs
457 * read because we've encountered a cache read failure */
458 fscache_get_context(object
->cookie
, op
->context
);
460 /* we wait for the operation to become active, and then process it
461 * *here*, in this thread, and not in the thread pool */
462 ret
= fscache_wait_for_operation_activation(
464 __fscache_stat(&fscache_n_retrieval_op_waits
),
465 __fscache_stat(&fscache_n_retrievals_object_dead
),
466 fscache_do_cancel_retrieval
);
470 /* ask the cache to honour the operation */
471 if (test_bit(FSCACHE_COOKIE_NO_DATA_YET
, &object
->cookie
->flags
)) {
472 fscache_stat(&fscache_n_cop_allocate_page
);
473 ret
= object
->cache
->ops
->allocate_page(op
, page
, gfp
);
474 fscache_stat_d(&fscache_n_cop_allocate_page
);
478 fscache_stat(&fscache_n_cop_read_or_alloc_page
);
479 ret
= object
->cache
->ops
->read_or_alloc_page(op
, page
, gfp
);
480 fscache_stat_d(&fscache_n_cop_read_or_alloc_page
);
485 fscache_stat(&fscache_n_retrievals_nomem
);
486 else if (ret
== -ERESTARTSYS
)
487 fscache_stat(&fscache_n_retrievals_intr
);
488 else if (ret
== -ENODATA
)
489 fscache_stat(&fscache_n_retrievals_nodata
);
491 fscache_stat(&fscache_n_retrievals_nobufs
);
493 fscache_stat(&fscache_n_retrievals_ok
);
495 fscache_put_retrieval(op
);
496 _leave(" = %d", ret
);
500 atomic_dec(&object
->n_reads
);
501 wake_cookie
= __fscache_unuse_cookie(cookie
);
503 spin_unlock(&cookie
->lock
);
505 __fscache_wake_unused_cookie(cookie
);
508 fscache_stat(&fscache_n_retrievals_nobufs
);
509 _leave(" = -ENOBUFS");
512 EXPORT_SYMBOL(__fscache_read_or_alloc_page
);
515 * read a list of page from the cache or allocate a block in which to store
518 * -ENOMEM - out of memory, some pages may be being read
519 * -ERESTARTSYS - interrupted, some pages may be being read
520 * -ENOBUFS - no backing object or space available in which to cache any
521 * pages not being read
522 * -ENODATA - no data available in the backing object for some or all of
524 * 0 - dispatched a read on all pages
526 * end_io_func() will be called for each page read from the cache as it is
527 * finishes being read
529 * any pages for which a read is dispatched will be removed from pages and
532 int __fscache_read_or_alloc_pages(struct fscache_cookie
*cookie
,
533 struct address_space
*mapping
,
534 struct list_head
*pages
,
536 fscache_rw_complete_t end_io_func
,
540 struct fscache_retrieval
*op
;
541 struct fscache_object
*object
;
542 bool wake_cookie
= false;
545 _enter("%p,,%d,,,", cookie
, *nr_pages
);
547 fscache_stat(&fscache_n_retrievals
);
549 if (hlist_empty(&cookie
->backing_objects
))
552 if (test_bit(FSCACHE_COOKIE_INVALIDATING
, &cookie
->flags
)) {
553 _leave(" = -ENOBUFS [invalidating]");
557 ASSERTCMP(cookie
->def
->type
, !=, FSCACHE_COOKIE_TYPE_INDEX
);
558 ASSERTCMP(*nr_pages
, >, 0);
559 ASSERT(!list_empty(pages
));
561 if (fscache_wait_for_deferred_lookup(cookie
) < 0)
564 op
= fscache_alloc_retrieval(cookie
, mapping
, end_io_func
, context
);
567 atomic_set(&op
->n_pages
, *nr_pages
);
569 spin_lock(&cookie
->lock
);
571 if (!fscache_cookie_enabled(cookie
) ||
572 hlist_empty(&cookie
->backing_objects
))
574 object
= hlist_entry(cookie
->backing_objects
.first
,
575 struct fscache_object
, cookie_link
);
577 __fscache_use_cookie(cookie
);
578 atomic_inc(&object
->n_reads
);
579 __set_bit(FSCACHE_OP_DEC_READ_CNT
, &op
->op
.flags
);
581 if (fscache_submit_op(object
, &op
->op
) < 0)
582 goto nobufs_unlock_dec
;
583 spin_unlock(&cookie
->lock
);
585 fscache_stat(&fscache_n_retrieval_ops
);
587 /* pin the netfs read context in case we need to do the actual netfs
588 * read because we've encountered a cache read failure */
589 fscache_get_context(object
->cookie
, op
->context
);
591 /* we wait for the operation to become active, and then process it
592 * *here*, in this thread, and not in the thread pool */
593 ret
= fscache_wait_for_operation_activation(
595 __fscache_stat(&fscache_n_retrieval_op_waits
),
596 __fscache_stat(&fscache_n_retrievals_object_dead
),
597 fscache_do_cancel_retrieval
);
601 /* ask the cache to honour the operation */
602 if (test_bit(FSCACHE_COOKIE_NO_DATA_YET
, &object
->cookie
->flags
)) {
603 fscache_stat(&fscache_n_cop_allocate_pages
);
604 ret
= object
->cache
->ops
->allocate_pages(
605 op
, pages
, nr_pages
, gfp
);
606 fscache_stat_d(&fscache_n_cop_allocate_pages
);
608 fscache_stat(&fscache_n_cop_read_or_alloc_pages
);
609 ret
= object
->cache
->ops
->read_or_alloc_pages(
610 op
, pages
, nr_pages
, gfp
);
611 fscache_stat_d(&fscache_n_cop_read_or_alloc_pages
);
616 fscache_stat(&fscache_n_retrievals_nomem
);
617 else if (ret
== -ERESTARTSYS
)
618 fscache_stat(&fscache_n_retrievals_intr
);
619 else if (ret
== -ENODATA
)
620 fscache_stat(&fscache_n_retrievals_nodata
);
622 fscache_stat(&fscache_n_retrievals_nobufs
);
624 fscache_stat(&fscache_n_retrievals_ok
);
626 fscache_put_retrieval(op
);
627 _leave(" = %d", ret
);
631 atomic_dec(&object
->n_reads
);
632 wake_cookie
= __fscache_unuse_cookie(cookie
);
634 spin_unlock(&cookie
->lock
);
637 __fscache_wake_unused_cookie(cookie
);
639 fscache_stat(&fscache_n_retrievals_nobufs
);
640 _leave(" = -ENOBUFS");
643 EXPORT_SYMBOL(__fscache_read_or_alloc_pages
);
646 * allocate a block in the cache on which to store a page
648 * -ENOMEM - out of memory, nothing done
649 * -ERESTARTSYS - interrupted
650 * -ENOBUFS - no backing object available in which to cache the block
651 * 0 - block allocated
653 int __fscache_alloc_page(struct fscache_cookie
*cookie
,
657 struct fscache_retrieval
*op
;
658 struct fscache_object
*object
;
659 bool wake_cookie
= false;
662 _enter("%p,%p,,,", cookie
, page
);
664 fscache_stat(&fscache_n_allocs
);
666 if (hlist_empty(&cookie
->backing_objects
))
669 ASSERTCMP(cookie
->def
->type
, !=, FSCACHE_COOKIE_TYPE_INDEX
);
670 ASSERTCMP(page
, !=, NULL
);
672 if (test_bit(FSCACHE_COOKIE_INVALIDATING
, &cookie
->flags
)) {
673 _leave(" = -ENOBUFS [invalidating]");
677 if (fscache_wait_for_deferred_lookup(cookie
) < 0)
680 op
= fscache_alloc_retrieval(cookie
, page
->mapping
, NULL
, NULL
);
683 atomic_set(&op
->n_pages
, 1);
685 spin_lock(&cookie
->lock
);
687 if (!fscache_cookie_enabled(cookie
) ||
688 hlist_empty(&cookie
->backing_objects
))
690 object
= hlist_entry(cookie
->backing_objects
.first
,
691 struct fscache_object
, cookie_link
);
693 __fscache_use_cookie(cookie
);
694 if (fscache_submit_op(object
, &op
->op
) < 0)
695 goto nobufs_unlock_dec
;
696 spin_unlock(&cookie
->lock
);
698 fscache_stat(&fscache_n_alloc_ops
);
700 ret
= fscache_wait_for_operation_activation(
702 __fscache_stat(&fscache_n_alloc_op_waits
),
703 __fscache_stat(&fscache_n_allocs_object_dead
),
704 fscache_do_cancel_retrieval
);
708 /* ask the cache to honour the operation */
709 fscache_stat(&fscache_n_cop_allocate_page
);
710 ret
= object
->cache
->ops
->allocate_page(op
, page
, gfp
);
711 fscache_stat_d(&fscache_n_cop_allocate_page
);
714 if (ret
== -ERESTARTSYS
)
715 fscache_stat(&fscache_n_allocs_intr
);
717 fscache_stat(&fscache_n_allocs_nobufs
);
719 fscache_stat(&fscache_n_allocs_ok
);
721 fscache_put_retrieval(op
);
722 _leave(" = %d", ret
);
726 wake_cookie
= __fscache_unuse_cookie(cookie
);
728 spin_unlock(&cookie
->lock
);
731 __fscache_wake_unused_cookie(cookie
);
733 fscache_stat(&fscache_n_allocs_nobufs
);
734 _leave(" = -ENOBUFS");
737 EXPORT_SYMBOL(__fscache_alloc_page
);
740 * Unmark pages allocate in the readahead code path (via:
741 * fscache_readpages_or_alloc) after delegating to the base filesystem
743 void __fscache_readpages_cancel(struct fscache_cookie
*cookie
,
744 struct list_head
*pages
)
748 list_for_each_entry(page
, pages
, lru
) {
749 if (PageFsCache(page
))
750 __fscache_uncache_page(cookie
, page
);
753 EXPORT_SYMBOL(__fscache_readpages_cancel
);
756 * release a write op reference
758 static void fscache_release_write_op(struct fscache_operation
*_op
)
760 _enter("{OP%x}", _op
->debug_id
);
764 * perform the background storage of a page into the cache
766 static void fscache_write_op(struct fscache_operation
*_op
)
768 struct fscache_storage
*op
=
769 container_of(_op
, struct fscache_storage
, op
);
770 struct fscache_object
*object
= op
->op
.object
;
771 struct fscache_cookie
*cookie
;
777 _enter("{OP%x,%d}", op
->op
.debug_id
, atomic_read(&op
->op
.usage
));
779 spin_lock(&object
->lock
);
780 cookie
= object
->cookie
;
782 if (!fscache_object_is_active(object
)) {
783 /* If we get here, then the on-disk cache object likely longer
784 * exists, so we should just cancel this write operation.
786 spin_unlock(&object
->lock
);
787 fscache_op_complete(&op
->op
, false);
788 _leave(" [inactive]");
793 /* If we get here, then the cookie belonging to the object was
794 * detached, probably by the cookie being withdrawn due to
795 * memory pressure, which means that the pages we might write
796 * to the cache from no longer exist - therefore, we can just
797 * cancel this write operation.
799 spin_unlock(&object
->lock
);
800 fscache_op_complete(&op
->op
, false);
801 _leave(" [cancel] op{f=%lx s=%u} obj{s=%s f=%lx}",
802 _op
->flags
, _op
->state
, object
->state
->short_name
,
807 spin_lock(&cookie
->stores_lock
);
809 fscache_stat(&fscache_n_store_calls
);
811 /* find a page to store */
813 n
= radix_tree_gang_lookup_tag(&cookie
->stores
, results
, 0, 1,
814 FSCACHE_COOKIE_PENDING_TAG
);
818 _debug("gang %d [%lx]", n
, page
->index
);
819 if (page
->index
> op
->store_limit
) {
820 fscache_stat(&fscache_n_store_pages_over_limit
);
824 radix_tree_tag_set(&cookie
->stores
, page
->index
,
825 FSCACHE_COOKIE_STORING_TAG
);
826 radix_tree_tag_clear(&cookie
->stores
, page
->index
,
827 FSCACHE_COOKIE_PENDING_TAG
);
829 spin_unlock(&cookie
->stores_lock
);
830 spin_unlock(&object
->lock
);
832 fscache_stat(&fscache_n_store_pages
);
833 fscache_stat(&fscache_n_cop_write_page
);
834 ret
= object
->cache
->ops
->write_page(op
, page
);
835 fscache_stat_d(&fscache_n_cop_write_page
);
836 fscache_end_page_write(object
, page
);
838 fscache_abort_object(object
);
839 fscache_op_complete(&op
->op
, true);
841 fscache_enqueue_operation(&op
->op
);
848 /* this writer is going away and there aren't any more things to
851 spin_unlock(&cookie
->stores_lock
);
852 clear_bit(FSCACHE_OBJECT_PENDING_WRITE
, &object
->flags
);
853 spin_unlock(&object
->lock
);
854 fscache_op_complete(&op
->op
, true);
859 * Clear the pages pending writing for invalidation
861 void fscache_invalidate_writes(struct fscache_cookie
*cookie
)
870 spin_lock(&cookie
->stores_lock
);
871 n
= radix_tree_gang_lookup_tag(&cookie
->stores
, results
, 0,
873 FSCACHE_COOKIE_PENDING_TAG
);
875 spin_unlock(&cookie
->stores_lock
);
879 for (i
= n
- 1; i
>= 0; i
--) {
881 radix_tree_delete(&cookie
->stores
, page
->index
);
884 spin_unlock(&cookie
->stores_lock
);
886 for (i
= n
- 1; i
>= 0; i
--)
887 page_cache_release(results
[i
]);
894 * request a page be stored in the cache
896 * -ENOMEM - out of memory, nothing done
897 * -ENOBUFS - no backing object available in which to cache the page
898 * 0 - dispatched a write - it'll call end_io_func() when finished
900 * if the cookie still has a backing object at this point, that object can be
901 * in one of a few states with respect to storage processing:
903 * (1) negative lookup, object not yet created (FSCACHE_COOKIE_CREATING is
908 * (b) writes deferred till post-creation (mark page for writing and
909 * return immediately)
911 * (2) negative lookup, object created, initial fill being made from netfs
913 * (a) fill point not yet reached this page (mark page for writing and
916 * (b) fill point passed this page (queue op to store this page)
918 * (3) object extant (queue op to store this page)
920 * any other state is invalid
922 int __fscache_write_page(struct fscache_cookie
*cookie
,
926 struct fscache_storage
*op
;
927 struct fscache_object
*object
;
928 bool wake_cookie
= false;
931 _enter("%p,%x,", cookie
, (u32
) page
->flags
);
933 ASSERTCMP(cookie
->def
->type
, !=, FSCACHE_COOKIE_TYPE_INDEX
);
934 ASSERT(PageFsCache(page
));
936 fscache_stat(&fscache_n_stores
);
938 if (test_bit(FSCACHE_COOKIE_INVALIDATING
, &cookie
->flags
)) {
939 _leave(" = -ENOBUFS [invalidating]");
943 op
= kzalloc(sizeof(*op
), GFP_NOIO
| __GFP_NOMEMALLOC
| __GFP_NORETRY
);
947 fscache_operation_init(&op
->op
, fscache_write_op
,
948 fscache_release_write_op
);
949 op
->op
.flags
= FSCACHE_OP_ASYNC
|
950 (1 << FSCACHE_OP_WAITING
) |
951 (1 << FSCACHE_OP_UNUSE_COOKIE
);
953 ret
= radix_tree_maybe_preload(gfp
& ~__GFP_HIGHMEM
);
958 spin_lock(&cookie
->lock
);
960 if (!fscache_cookie_enabled(cookie
) ||
961 hlist_empty(&cookie
->backing_objects
))
963 object
= hlist_entry(cookie
->backing_objects
.first
,
964 struct fscache_object
, cookie_link
);
965 if (test_bit(FSCACHE_IOERROR
, &object
->cache
->flags
))
968 /* add the page to the pending-storage radix tree on the backing
970 spin_lock(&object
->lock
);
971 spin_lock(&cookie
->stores_lock
);
973 _debug("store limit %llx", (unsigned long long) object
->store_limit
);
975 ret
= radix_tree_insert(&cookie
->stores
, page
->index
, page
);
979 _debug("insert failed %d", ret
);
980 goto nobufs_unlock_obj
;
983 radix_tree_tag_set(&cookie
->stores
, page
->index
,
984 FSCACHE_COOKIE_PENDING_TAG
);
985 page_cache_get(page
);
987 /* we only want one writer at a time, but we do need to queue new
988 * writers after exclusive ops */
989 if (test_and_set_bit(FSCACHE_OBJECT_PENDING_WRITE
, &object
->flags
))
990 goto already_pending
;
992 spin_unlock(&cookie
->stores_lock
);
993 spin_unlock(&object
->lock
);
995 op
->op
.debug_id
= atomic_inc_return(&fscache_op_debug_id
);
996 op
->store_limit
= object
->store_limit
;
998 __fscache_use_cookie(cookie
);
999 if (fscache_submit_op(object
, &op
->op
) < 0)
1002 spin_unlock(&cookie
->lock
);
1003 radix_tree_preload_end();
1004 fscache_stat(&fscache_n_store_ops
);
1005 fscache_stat(&fscache_n_stores_ok
);
1007 /* the work queue now carries its own ref on the object */
1008 fscache_put_operation(&op
->op
);
1013 fscache_stat(&fscache_n_stores_again
);
1015 spin_unlock(&cookie
->stores_lock
);
1016 spin_unlock(&object
->lock
);
1017 spin_unlock(&cookie
->lock
);
1018 radix_tree_preload_end();
1020 fscache_stat(&fscache_n_stores_ok
);
1025 spin_lock(&cookie
->stores_lock
);
1026 radix_tree_delete(&cookie
->stores
, page
->index
);
1027 spin_unlock(&cookie
->stores_lock
);
1028 wake_cookie
= __fscache_unuse_cookie(cookie
);
1029 page_cache_release(page
);
1034 spin_unlock(&cookie
->stores_lock
);
1035 spin_unlock(&object
->lock
);
1037 spin_unlock(&cookie
->lock
);
1038 radix_tree_preload_end();
1041 __fscache_wake_unused_cookie(cookie
);
1042 fscache_stat(&fscache_n_stores_nobufs
);
1043 _leave(" = -ENOBUFS");
1049 fscache_stat(&fscache_n_stores_oom
);
1050 _leave(" = -ENOMEM");
1053 EXPORT_SYMBOL(__fscache_write_page
);
1056 * remove a page from the cache
1058 void __fscache_uncache_page(struct fscache_cookie
*cookie
, struct page
*page
)
1060 struct fscache_object
*object
;
1062 _enter(",%p", page
);
1064 ASSERTCMP(cookie
->def
->type
, !=, FSCACHE_COOKIE_TYPE_INDEX
);
1065 ASSERTCMP(page
, !=, NULL
);
1067 fscache_stat(&fscache_n_uncaches
);
1069 /* cache withdrawal may beat us to it */
1070 if (!PageFsCache(page
))
1073 /* get the object */
1074 spin_lock(&cookie
->lock
);
1076 if (hlist_empty(&cookie
->backing_objects
)) {
1077 ClearPageFsCache(page
);
1081 object
= hlist_entry(cookie
->backing_objects
.first
,
1082 struct fscache_object
, cookie_link
);
1084 /* there might now be stuff on disk we could read */
1085 clear_bit(FSCACHE_COOKIE_NO_DATA_YET
, &cookie
->flags
);
1087 /* only invoke the cache backend if we managed to mark the page
1088 * uncached here; this deals with synchronisation vs withdrawal */
1089 if (TestClearPageFsCache(page
) &&
1090 object
->cache
->ops
->uncache_page
) {
1091 /* the cache backend releases the cookie lock */
1092 fscache_stat(&fscache_n_cop_uncache_page
);
1093 object
->cache
->ops
->uncache_page(object
, page
);
1094 fscache_stat_d(&fscache_n_cop_uncache_page
);
1099 spin_unlock(&cookie
->lock
);
1103 EXPORT_SYMBOL(__fscache_uncache_page
);
1106 * fscache_mark_page_cached - Mark a page as being cached
1107 * @op: The retrieval op pages are being marked for
1108 * @page: The page to be marked
1110 * Mark a netfs page as being cached. After this is called, the netfs
1111 * must call fscache_uncache_page() to remove the mark.
1113 void fscache_mark_page_cached(struct fscache_retrieval
*op
, struct page
*page
)
1115 struct fscache_cookie
*cookie
= op
->op
.object
->cookie
;
1117 #ifdef CONFIG_FSCACHE_STATS
1118 atomic_inc(&fscache_n_marks
);
1121 _debug("- mark %p{%lx}", page
, page
->index
);
1122 if (TestSetPageFsCache(page
)) {
1123 static bool once_only
;
1126 pr_warn("Cookie type %s marked page %lx multiple times\n",
1127 cookie
->def
->name
, page
->index
);
1131 if (cookie
->def
->mark_page_cached
)
1132 cookie
->def
->mark_page_cached(cookie
->netfs_data
,
1135 EXPORT_SYMBOL(fscache_mark_page_cached
);
1138 * fscache_mark_pages_cached - Mark pages as being cached
1139 * @op: The retrieval op pages are being marked for
1140 * @pagevec: The pages to be marked
1142 * Mark a bunch of netfs pages as being cached. After this is called,
1143 * the netfs must call fscache_uncache_page() to remove the mark.
1145 void fscache_mark_pages_cached(struct fscache_retrieval
*op
,
1146 struct pagevec
*pagevec
)
1150 for (loop
= 0; loop
< pagevec
->nr
; loop
++)
1151 fscache_mark_page_cached(op
, pagevec
->pages
[loop
]);
1153 pagevec_reinit(pagevec
);
1155 EXPORT_SYMBOL(fscache_mark_pages_cached
);
1158 * Uncache all the pages in an inode that are marked PG_fscache, assuming them
1159 * to be associated with the given cookie.
1161 void __fscache_uncache_all_inode_pages(struct fscache_cookie
*cookie
,
1162 struct inode
*inode
)
1164 struct address_space
*mapping
= inode
->i_mapping
;
1165 struct pagevec pvec
;
1169 _enter("%p,%p", cookie
, inode
);
1171 if (!mapping
|| mapping
->nrpages
== 0) {
1172 _leave(" [no pages]");
1176 pagevec_init(&pvec
, 0);
1179 if (!pagevec_lookup(&pvec
, mapping
, next
, PAGEVEC_SIZE
))
1181 for (i
= 0; i
< pagevec_count(&pvec
); i
++) {
1182 struct page
*page
= pvec
.pages
[i
];
1184 if (PageFsCache(page
)) {
1185 __fscache_wait_on_page_write(cookie
, page
);
1186 __fscache_uncache_page(cookie
, page
);
1189 pagevec_release(&pvec
);
1195 EXPORT_SYMBOL(__fscache_uncache_all_inode_pages
);