1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* handling of writes to regular files and writing back to the server
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
8 #include <linux/backing-dev.h>
9 #include <linux/slab.h>
11 #include <linux/pagemap.h>
12 #include <linux/writeback.h>
13 #include <linux/pagevec.h>
17 * mark a page as having been made dirty and thus needing writeback
19 int afs_set_page_dirty(struct page *page)
22 return __set_page_dirty_nobuffers(page);
26 * partly or wholly fill a page that's under preparation for writing
28 static int afs_fill_page(struct afs_vnode *vnode, struct key *key,
29 loff_t pos, unsigned int len, struct page *page)
36 _enter(",,%llu", (unsigned long long)pos);
38 if (pos >= vnode->vfs_inode.i_size) {
40 ASSERTCMP(p + len, <=, PAGE_SIZE);
42 memset(data + p, 0, len);
47 req = kzalloc(struct_size(req, array, 1), GFP_KERNEL);
51 refcount_set(&req->usage, 1);
55 req->pages = req->array;
59 ret = afs_fetch_data(vnode, key, req);
63 _debug("got NOENT from server"
64 " - marking file deleted and stale");
65 set_bit(AFS_VNODE_DELETED, &vnode->flags);
75 * prepare to perform part of a write to a page
77 int afs_write_begin(struct file *file, struct address_space *mapping,
78 loff_t pos, unsigned len, unsigned flags,
79 struct page **_page, void **fsdata)
81 struct afs_vnode *vnode = AFS_FS_I(file_inode(file));
83 struct key *key = afs_file_key(file);
85 unsigned f, from = pos & (PAGE_SIZE - 1);
86 unsigned t, to = from + len;
87 pgoff_t index = pos >> PAGE_SHIFT;
90 _enter("{%llx:%llu},{%lx},%u,%u",
91 vnode->fid.vid, vnode->fid.vnode, index, from, to);
93 page = grab_cache_page_write_begin(mapping, index, flags);
97 if (!PageUptodate(page) && len != PAGE_SIZE) {
98 ret = afs_fill_page(vnode, key, pos & PAGE_MASK, PAGE_SIZE, page);
102 _leave(" = %d [prep]", ret);
105 SetPageUptodate(page);
109 /* See if this page is already partially written in a way that we can
110 * merge the new write with.
113 if (PagePrivate(page)) {
114 priv = page_private(page);
115 f = afs_page_dirty_from(priv);
116 t = afs_page_dirty_to(priv);
121 if (PageWriteback(page)) {
122 trace_afs_page_dirty(vnode, tracepoint_string("alrdy"),
124 goto flush_conflicting_write;
126 /* If the file is being filled locally, allow inter-write
127 * spaces to be merged into writes. If it's not, only write
128 * back what the user gives us.
130 if (!test_bit(AFS_VNODE_NEW_CONTENT, &vnode->flags) &&
131 (to < f || from > t))
132 goto flush_conflicting_write;
139 /* The previous write and this write aren't adjacent or overlapping, so
140 * flush the page out.
142 flush_conflicting_write:
143 _debug("flush conflict");
144 ret = write_one_page(page);
148 ret = lock_page_killable(page);
155 _leave(" = %d", ret);
160 * finalise part of a write to a page
162 int afs_write_end(struct file *file, struct address_space *mapping,
163 loff_t pos, unsigned len, unsigned copied,
164 struct page *page, void *fsdata)
166 struct afs_vnode *vnode = AFS_FS_I(file_inode(file));
167 struct key *key = afs_file_key(file);
169 unsigned int f, from = pos & (PAGE_SIZE - 1);
170 unsigned int t, to = from + copied;
171 loff_t i_size, maybe_i_size;
174 _enter("{%llx:%llu},{%lx}",
175 vnode->fid.vid, vnode->fid.vnode, page->index);
180 maybe_i_size = pos + copied;
182 i_size = i_size_read(&vnode->vfs_inode);
183 if (maybe_i_size > i_size) {
184 write_seqlock(&vnode->cb_lock);
185 i_size = i_size_read(&vnode->vfs_inode);
186 if (maybe_i_size > i_size)
187 i_size_write(&vnode->vfs_inode, maybe_i_size);
188 write_sequnlock(&vnode->cb_lock);
191 if (!PageUptodate(page)) {
193 /* Try and load any missing data from the server. The
194 * unmarshalling routine will take care of clearing any
195 * bits that are beyond the EOF.
197 ret = afs_fill_page(vnode, key, pos + copied,
202 SetPageUptodate(page);
205 if (PagePrivate(page)) {
206 priv = page_private(page);
207 f = afs_page_dirty_from(priv);
208 t = afs_page_dirty_to(priv);
213 priv = afs_page_dirty(f, t);
214 set_page_private(page, priv);
215 trace_afs_page_dirty(vnode, tracepoint_string("dirty+"),
218 priv = afs_page_dirty(from, to);
219 attach_page_private(page, (void *)priv);
220 trace_afs_page_dirty(vnode, tracepoint_string("dirty"),
224 set_page_dirty(page);
236 * kill all the pages in the given range
238 static void afs_kill_pages(struct address_space *mapping,
239 pgoff_t first, pgoff_t last)
241 struct afs_vnode *vnode = AFS_FS_I(mapping->host);
243 unsigned count, loop;
245 _enter("{%llx:%llu},%lx-%lx",
246 vnode->fid.vid, vnode->fid.vnode, first, last);
251 _debug("kill %lx-%lx", first, last);
253 count = last - first + 1;
254 if (count > PAGEVEC_SIZE)
255 count = PAGEVEC_SIZE;
256 pv.nr = find_get_pages_contig(mapping, first, count, pv.pages);
257 ASSERTCMP(pv.nr, ==, count);
259 for (loop = 0; loop < count; loop++) {
260 struct page *page = pv.pages[loop];
261 ClearPageUptodate(page);
263 end_page_writeback(page);
264 if (page->index >= first)
265 first = page->index + 1;
267 generic_error_remove_page(mapping, page);
271 __pagevec_release(&pv);
272 } while (first <= last);
278 * Redirty all the pages in a given range.
280 static void afs_redirty_pages(struct writeback_control *wbc,
281 struct address_space *mapping,
282 pgoff_t first, pgoff_t last)
284 struct afs_vnode *vnode = AFS_FS_I(mapping->host);
286 unsigned count, loop;
288 _enter("{%llx:%llu},%lx-%lx",
289 vnode->fid.vid, vnode->fid.vnode, first, last);
294 _debug("redirty %lx-%lx", first, last);
296 count = last - first + 1;
297 if (count > PAGEVEC_SIZE)
298 count = PAGEVEC_SIZE;
299 pv.nr = find_get_pages_contig(mapping, first, count, pv.pages);
300 ASSERTCMP(pv.nr, ==, count);
302 for (loop = 0; loop < count; loop++) {
303 struct page *page = pv.pages[loop];
305 redirty_page_for_writepage(wbc, page);
306 end_page_writeback(page);
307 if (page->index >= first)
308 first = page->index + 1;
311 __pagevec_release(&pv);
312 } while (first <= last);
318 * completion of write to server
320 static void afs_pages_written_back(struct afs_vnode *vnode,
321 pgoff_t first, pgoff_t last)
325 unsigned count, loop;
327 _enter("{%llx:%llu},{%lx-%lx}",
328 vnode->fid.vid, vnode->fid.vnode, first, last);
333 _debug("done %lx-%lx", first, last);
335 count = last - first + 1;
336 if (count > PAGEVEC_SIZE)
337 count = PAGEVEC_SIZE;
338 pv.nr = find_get_pages_contig(vnode->vfs_inode.i_mapping,
339 first, count, pv.pages);
340 ASSERTCMP(pv.nr, ==, count);
342 for (loop = 0; loop < count; loop++) {
343 priv = (unsigned long)detach_page_private(pv.pages[loop]);
344 trace_afs_page_dirty(vnode, tracepoint_string("clear"),
345 pv.pages[loop]->index, priv);
346 end_page_writeback(pv.pages[loop]);
349 __pagevec_release(&pv);
350 } while (first <= last);
352 afs_prune_wb_keys(vnode);
357 * Find a key to use for the writeback. We cached the keys used to author the
358 * writes on the vnode. *_wbk will contain the last writeback key used or NULL
359 * and we need to start from there if it's set.
361 static int afs_get_writeback_key(struct afs_vnode *vnode,
362 struct afs_wb_key **_wbk)
364 struct afs_wb_key *wbk = NULL;
366 int ret = -ENOKEY, ret2;
368 spin_lock(&vnode->wb_lock);
370 p = (*_wbk)->vnode_link.next;
372 p = vnode->wb_keys.next;
374 while (p != &vnode->wb_keys) {
375 wbk = list_entry(p, struct afs_wb_key, vnode_link);
376 _debug("wbk %u", key_serial(wbk->key));
377 ret2 = key_validate(wbk->key);
379 refcount_inc(&wbk->usage);
380 _debug("USE WB KEY %u", key_serial(wbk->key));
390 spin_unlock(&vnode->wb_lock);
392 afs_put_wb_key(*_wbk);
397 static void afs_store_data_success(struct afs_operation *op)
399 struct afs_vnode *vnode = op->file[0].vnode;
401 op->ctime = op->file[0].scb.status.mtime_client;
402 afs_vnode_commit_status(op, &op->file[0]);
403 if (op->error == 0) {
404 if (!op->store.laundering)
405 afs_pages_written_back(vnode, op->store.first, op->store.last);
406 afs_stat_v(vnode, n_stores);
407 atomic_long_add((op->store.last * PAGE_SIZE + op->store.last_to) -
408 (op->store.first * PAGE_SIZE + op->store.first_offset),
409 &afs_v2net(vnode)->n_store_bytes);
413 static const struct afs_operation_ops afs_store_data_operation = {
414 .issue_afs_rpc = afs_fs_store_data,
415 .issue_yfs_rpc = yfs_fs_store_data,
416 .success = afs_store_data_success,
422 static int afs_store_data(struct address_space *mapping,
423 pgoff_t first, pgoff_t last,
424 unsigned offset, unsigned to, bool laundering)
426 struct afs_vnode *vnode = AFS_FS_I(mapping->host);
427 struct afs_operation *op;
428 struct afs_wb_key *wbk = NULL;
431 _enter("%s{%llx:%llu.%u},%lx,%lx,%x,%x",
436 first, last, offset, to);
438 ret = afs_get_writeback_key(vnode, &wbk);
440 _leave(" = %d [no keys]", ret);
444 op = afs_alloc_operation(wbk->key, vnode->volume);
450 afs_op_set_vnode(op, 0, vnode);
451 op->file[0].dv_delta = 1;
452 op->store.mapping = mapping;
453 op->store.first = first;
454 op->store.last = last;
455 op->store.first_offset = offset;
456 op->store.last_to = to;
457 op->store.laundering = laundering;
458 op->mtime = vnode->vfs_inode.i_mtime;
459 op->flags |= AFS_OPERATION_UNINTR;
460 op->ops = &afs_store_data_operation;
463 afs_begin_vnode_operation(op);
464 afs_wait_for_operation(op);
475 ret = afs_get_writeback_key(vnode, &wbk);
478 op->key = key_get(wbk->key);
485 _leave(" = %d", op->error);
486 return afs_put_operation(op);
490 * Synchronously write back the locked page and any subsequent non-locked dirty
493 static int afs_write_back_from_locked_page(struct address_space *mapping,
494 struct writeback_control *wbc,
495 struct page *primary_page,
498 struct afs_vnode *vnode = AFS_FS_I(mapping->host);
499 struct page *pages[8], *page;
500 unsigned long count, priv;
501 unsigned n, offset, to, f, t;
502 pgoff_t start, first, last;
506 _enter(",%lx", primary_page->index);
509 if (test_set_page_writeback(primary_page))
512 /* Find all consecutive lockable dirty pages that have contiguous
513 * written regions, stopping when we find a page that is not
514 * immediately lockable, is not dirty or is missing, or we reach the
517 start = primary_page->index;
518 priv = page_private(primary_page);
519 offset = afs_page_dirty_from(priv);
520 to = afs_page_dirty_to(priv);
521 trace_afs_page_dirty(vnode, tracepoint_string("store"),
522 primary_page->index, priv);
524 WARN_ON(offset == to);
526 trace_afs_page_dirty(vnode, tracepoint_string("WARN"),
527 primary_page->index, priv);
529 if (start >= final_page ||
530 (to < PAGE_SIZE && !test_bit(AFS_VNODE_NEW_CONTENT, &vnode->flags)))
535 _debug("more %lx [%lx]", start, count);
536 n = final_page - start + 1;
537 if (n > ARRAY_SIZE(pages))
538 n = ARRAY_SIZE(pages);
539 n = find_get_pages_contig(mapping, start, ARRAY_SIZE(pages), pages);
540 _debug("fgpc %u", n);
543 if (pages[0]->index != start) {
545 put_page(pages[--n]);
550 for (loop = 0; loop < n; loop++) {
552 if (to != PAGE_SIZE &&
553 !test_bit(AFS_VNODE_NEW_CONTENT, &vnode->flags))
555 if (page->index > final_page)
557 if (!trylock_page(page))
559 if (!PageDirty(page) || PageWriteback(page)) {
564 priv = page_private(page);
565 f = afs_page_dirty_from(priv);
566 t = afs_page_dirty_to(priv);
568 !test_bit(AFS_VNODE_NEW_CONTENT, &vnode->flags)) {
574 trace_afs_page_dirty(vnode, tracepoint_string("store+"),
577 if (!clear_page_dirty_for_io(page))
579 if (test_set_page_writeback(page))
586 for (; loop < n; loop++)
587 put_page(pages[loop]);
592 } while (start <= final_page && count < 65536);
595 /* We now have a contiguous set of dirty pages, each with writeback
596 * set; the first page is still locked at this point, but all the rest
597 * have been unlocked.
599 unlock_page(primary_page);
601 first = primary_page->index;
602 last = first + count - 1;
604 end = (loff_t)last * PAGE_SIZE + to;
605 i_size = i_size_read(&vnode->vfs_inode);
607 _debug("write back %lx[%u..] to %lx[..%u]", first, offset, last, to);
609 to = i_size & ~PAGE_MASK;
611 ret = afs_store_data(mapping, first, last, offset, to, false);
618 pr_notice("kAFS: Unexpected error from FS.StoreData %d\n", ret);
626 afs_redirty_pages(wbc, mapping, first, last);
627 mapping_set_error(mapping, ret);
632 afs_redirty_pages(wbc, mapping, first, last);
633 mapping_set_error(mapping, -ENOSPC);
643 trace_afs_file_error(vnode, ret, afs_file_error_writeback_fail);
644 afs_kill_pages(mapping, first, last);
645 mapping_set_error(mapping, ret);
649 _leave(" = %d", ret);
654 * write a page back to the server
655 * - the caller locked the page for us
657 int afs_writepage(struct page *page, struct writeback_control *wbc)
661 _enter("{%lx},", page->index);
663 ret = afs_write_back_from_locked_page(page->mapping, wbc, page,
664 wbc->range_end >> PAGE_SHIFT);
666 _leave(" = %d", ret);
670 wbc->nr_to_write -= ret;
677 * write a region of pages back to the server
679 static int afs_writepages_region(struct address_space *mapping,
680 struct writeback_control *wbc,
681 pgoff_t index, pgoff_t end, pgoff_t *_next)
686 _enter(",,%lx,%lx,", index, end);
689 n = find_get_pages_range_tag(mapping, &index, end,
690 PAGECACHE_TAG_DIRTY, 1, &page);
694 _debug("wback %lx", page->index);
697 * at this point we hold neither the i_pages lock nor the
698 * page lock: the page may be truncated or invalidated
699 * (changing page->mapping to NULL), or even swizzled
700 * back from swapper_space to tmpfs file mapping
702 ret = lock_page_killable(page);
705 _leave(" = %d", ret);
709 if (page->mapping != mapping || !PageDirty(page)) {
715 if (PageWriteback(page)) {
717 if (wbc->sync_mode != WB_SYNC_NONE)
718 wait_on_page_writeback(page);
723 if (!clear_page_dirty_for_io(page))
725 ret = afs_write_back_from_locked_page(mapping, wbc, page, end);
728 _leave(" = %d", ret);
732 wbc->nr_to_write -= ret;
735 } while (index < end && wbc->nr_to_write > 0);
738 _leave(" = 0 [%lx]", *_next);
743 * write some of the pending data back to the server
745 int afs_writepages(struct address_space *mapping,
746 struct writeback_control *wbc)
748 struct afs_vnode *vnode = AFS_FS_I(mapping->host);
749 pgoff_t start, end, next;
754 /* We have to be careful as we can end up racing with setattr()
755 * truncating the pagecache since the caller doesn't take a lock here
758 if (wbc->sync_mode == WB_SYNC_ALL)
759 down_read(&vnode->validate_lock);
760 else if (!down_read_trylock(&vnode->validate_lock))
763 if (wbc->range_cyclic) {
764 start = mapping->writeback_index;
766 ret = afs_writepages_region(mapping, wbc, start, end, &next);
767 if (start > 0 && wbc->nr_to_write > 0 && ret == 0)
768 ret = afs_writepages_region(mapping, wbc, 0, start,
770 mapping->writeback_index = next;
771 } else if (wbc->range_start == 0 && wbc->range_end == LLONG_MAX) {
772 end = (pgoff_t)(LLONG_MAX >> PAGE_SHIFT);
773 ret = afs_writepages_region(mapping, wbc, 0, end, &next);
774 if (wbc->nr_to_write > 0)
775 mapping->writeback_index = next;
777 start = wbc->range_start >> PAGE_SHIFT;
778 end = wbc->range_end >> PAGE_SHIFT;
779 ret = afs_writepages_region(mapping, wbc, start, end, &next);
782 up_read(&vnode->validate_lock);
783 _leave(" = %d", ret);
788 * write to an AFS file
790 ssize_t afs_file_write(struct kiocb *iocb, struct iov_iter *from)
792 struct afs_vnode *vnode = AFS_FS_I(file_inode(iocb->ki_filp));
794 size_t count = iov_iter_count(from);
796 _enter("{%llx:%llu},{%zu},",
797 vnode->fid.vid, vnode->fid.vnode, count);
799 if (IS_SWAPFILE(&vnode->vfs_inode)) {
801 "AFS: Attempt to write to active swap file!\n");
808 result = generic_file_write_iter(iocb, from);
810 _leave(" = %zd", result);
815 * flush any dirty pages for this process, and check for write errors.
816 * - the return status from this call provides a reliable indication of
817 * whether any write errors occurred for this process.
819 int afs_fsync(struct file *file, loff_t start, loff_t end, int datasync)
821 struct inode *inode = file_inode(file);
822 struct afs_vnode *vnode = AFS_FS_I(inode);
824 _enter("{%llx:%llu},{n=%pD},%d",
825 vnode->fid.vid, vnode->fid.vnode, file,
828 return file_write_and_wait_range(file, start, end);
832 * notification that a previously read-only page is about to become writable
833 * - if it returns an error, the caller will deliver a bus error signal
835 vm_fault_t afs_page_mkwrite(struct vm_fault *vmf)
837 struct file *file = vmf->vma->vm_file;
838 struct inode *inode = file_inode(file);
839 struct afs_vnode *vnode = AFS_FS_I(inode);
842 _enter("{{%llx:%llu}},{%lx}",
843 vnode->fid.vid, vnode->fid.vnode, vmf->page->index);
845 sb_start_pagefault(inode->i_sb);
847 /* Wait for the page to be written to the cache before we allow it to
848 * be modified. We then assume the entire page will need writing back.
850 #ifdef CONFIG_AFS_FSCACHE
851 fscache_wait_on_page_write(vnode->cache, vmf->page);
854 if (PageWriteback(vmf->page) &&
855 wait_on_page_bit_killable(vmf->page, PG_writeback) < 0)
856 return VM_FAULT_RETRY;
858 if (lock_page_killable(vmf->page) < 0)
859 return VM_FAULT_RETRY;
861 /* We mustn't change page->private until writeback is complete as that
862 * details the portion of the page we need to write back and we might
863 * need to redirty the page if there's a problem.
865 wait_on_page_writeback(vmf->page);
867 priv = afs_page_dirty(0, PAGE_SIZE);
868 priv = afs_page_dirty_mmapped(priv);
869 trace_afs_page_dirty(vnode, tracepoint_string("mkwrite"),
870 vmf->page->index, priv);
871 if (PagePrivate(vmf->page))
872 set_page_private(vmf->page, priv);
874 attach_page_private(vmf->page, (void *)priv);
875 file_update_time(file);
877 sb_end_pagefault(inode->i_sb);
878 return VM_FAULT_LOCKED;
882 * Prune the keys cached for writeback. The caller must hold vnode->wb_lock.
884 void afs_prune_wb_keys(struct afs_vnode *vnode)
886 LIST_HEAD(graveyard);
887 struct afs_wb_key *wbk, *tmp;
889 /* Discard unused keys */
890 spin_lock(&vnode->wb_lock);
892 if (!mapping_tagged(&vnode->vfs_inode.i_data, PAGECACHE_TAG_WRITEBACK) &&
893 !mapping_tagged(&vnode->vfs_inode.i_data, PAGECACHE_TAG_DIRTY)) {
894 list_for_each_entry_safe(wbk, tmp, &vnode->wb_keys, vnode_link) {
895 if (refcount_read(&wbk->usage) == 1)
896 list_move(&wbk->vnode_link, &graveyard);
900 spin_unlock(&vnode->wb_lock);
902 while (!list_empty(&graveyard)) {
903 wbk = list_entry(graveyard.next, struct afs_wb_key, vnode_link);
904 list_del(&wbk->vnode_link);
910 * Clean up a page during invalidation.
912 int afs_launder_page(struct page *page)
914 struct address_space *mapping = page->mapping;
915 struct afs_vnode *vnode = AFS_FS_I(mapping->host);
920 _enter("{%lx}", page->index);
922 priv = page_private(page);
923 if (clear_page_dirty_for_io(page)) {
926 if (PagePrivate(page)) {
927 f = afs_page_dirty_from(priv);
928 t = afs_page_dirty_to(priv);
931 trace_afs_page_dirty(vnode, tracepoint_string("launder"),
933 ret = afs_store_data(mapping, page->index, page->index, t, f, true);
936 priv = (unsigned long)detach_page_private(page);
937 trace_afs_page_dirty(vnode, tracepoint_string("laundered"),
940 #ifdef CONFIG_AFS_FSCACHE
941 if (PageFsCache(page)) {
942 fscache_wait_on_page_write(vnode->cache, page);
943 fscache_uncache_page(vnode->cache, page);