1 // SPDX-License-Identifier: GPL-2.0-only
5 * Write file data over NFS.
10 #include <linux/types.h>
11 #include <linux/slab.h>
13 #include <linux/pagemap.h>
14 #include <linux/file.h>
15 #include <linux/writeback.h>
16 #include <linux/swap.h>
17 #include <linux/migrate.h>
19 #include <linux/sunrpc/clnt.h>
20 #include <linux/nfs_fs.h>
21 #include <linux/nfs_mount.h>
22 #include <linux/nfs_page.h>
23 #include <linux/backing-dev.h>
24 #include <linux/export.h>
25 #include <linux/freezer.h>
26 #include <linux/wait.h>
27 #include <linux/iversion.h>
29 #include <linux/uaccess.h>
30 #include <linux/sched/mm.h>
32 #include "delegation.h"
41 #define NFSDBG_FACILITY NFSDBG_PAGECACHE
43 #define MIN_POOL_WRITE (32)
44 #define MIN_POOL_COMMIT (4)
46 struct nfs_io_completion {
47 void (*complete)(void *data);
53 * Local function declarations
55 static void nfs_redirty_request(struct nfs_page *req);
56 static const struct rpc_call_ops nfs_commit_ops;
57 static const struct nfs_pgio_completion_ops nfs_async_write_completion_ops;
58 static const struct nfs_commit_completion_ops nfs_commit_completion_ops;
59 static const struct nfs_rw_ops nfs_rw_write_ops;
60 static void nfs_inode_remove_request(struct nfs_page *req);
61 static void nfs_clear_request_commit(struct nfs_page *req);
62 static void nfs_init_cinfo_from_inode(struct nfs_commit_info *cinfo,
64 static struct nfs_page *
65 nfs_page_search_commits_for_head_request_locked(struct nfs_inode *nfsi,
68 static struct kmem_cache *nfs_wdata_cachep;
69 static mempool_t *nfs_wdata_mempool;
70 static struct kmem_cache *nfs_cdata_cachep;
71 static mempool_t *nfs_commit_mempool;
73 struct nfs_commit_data *nfs_commitdata_alloc(void)
75 struct nfs_commit_data *p;
77 p = kmem_cache_zalloc(nfs_cdata_cachep, nfs_io_gfp_mask());
79 p = mempool_alloc(nfs_commit_mempool, GFP_NOWAIT);
82 memset(p, 0, sizeof(*p));
84 INIT_LIST_HEAD(&p->pages);
87 EXPORT_SYMBOL_GPL(nfs_commitdata_alloc);
89 void nfs_commit_free(struct nfs_commit_data *p)
91 mempool_free(p, nfs_commit_mempool);
93 EXPORT_SYMBOL_GPL(nfs_commit_free);
95 static struct nfs_pgio_header *nfs_writehdr_alloc(void)
97 struct nfs_pgio_header *p;
99 p = kmem_cache_zalloc(nfs_wdata_cachep, nfs_io_gfp_mask());
101 p = mempool_alloc(nfs_wdata_mempool, GFP_NOWAIT);
104 memset(p, 0, sizeof(*p));
106 p->rw_mode = FMODE_WRITE;
110 static void nfs_writehdr_free(struct nfs_pgio_header *hdr)
112 mempool_free(hdr, nfs_wdata_mempool);
115 static struct nfs_io_completion *nfs_io_completion_alloc(gfp_t gfp_flags)
117 return kmalloc(sizeof(struct nfs_io_completion), gfp_flags);
120 static void nfs_io_completion_init(struct nfs_io_completion *ioc,
121 void (*complete)(void *), void *data)
123 ioc->complete = complete;
125 kref_init(&ioc->refcount);
128 static void nfs_io_completion_release(struct kref *kref)
130 struct nfs_io_completion *ioc = container_of(kref,
131 struct nfs_io_completion, refcount);
132 ioc->complete(ioc->data);
136 static void nfs_io_completion_get(struct nfs_io_completion *ioc)
139 kref_get(&ioc->refcount);
142 static void nfs_io_completion_put(struct nfs_io_completion *ioc)
145 kref_put(&ioc->refcount, nfs_io_completion_release);
149 nfs_page_set_inode_ref(struct nfs_page *req, struct inode *inode)
151 if (!test_and_set_bit(PG_INODE_REF, &req->wb_flags)) {
152 kref_get(&req->wb_kref);
153 atomic_long_inc(&NFS_I(inode)->nrequests);
158 nfs_cancel_remove_inode(struct nfs_page *req, struct inode *inode)
162 if (!test_bit(PG_REMOVE, &req->wb_flags))
164 ret = nfs_page_group_lock(req);
167 if (test_and_clear_bit(PG_REMOVE, &req->wb_flags))
168 nfs_page_set_inode_ref(req, inode);
169 nfs_page_group_unlock(req);
173 static struct nfs_page *
174 nfs_page_private_request(struct page *page)
176 if (!PagePrivate(page))
178 return (struct nfs_page *)page_private(page);
182 * nfs_page_find_head_request_locked - find head request associated with @page
184 * must be called while holding the inode lock.
186 * returns matching head request with reference held, or NULL if not found.
188 static struct nfs_page *
189 nfs_page_find_private_request(struct page *page)
191 struct address_space *mapping = page_file_mapping(page);
192 struct nfs_page *req;
194 if (!PagePrivate(page))
196 spin_lock(&mapping->private_lock);
197 req = nfs_page_private_request(page);
199 WARN_ON_ONCE(req->wb_head != req);
200 kref_get(&req->wb_kref);
202 spin_unlock(&mapping->private_lock);
206 static struct nfs_page *
207 nfs_page_find_swap_request(struct page *page)
209 struct inode *inode = page_file_mapping(page)->host;
210 struct nfs_inode *nfsi = NFS_I(inode);
211 struct nfs_page *req = NULL;
212 if (!PageSwapCache(page))
214 mutex_lock(&nfsi->commit_mutex);
215 if (PageSwapCache(page)) {
216 req = nfs_page_search_commits_for_head_request_locked(nfsi,
219 WARN_ON_ONCE(req->wb_head != req);
220 kref_get(&req->wb_kref);
223 mutex_unlock(&nfsi->commit_mutex);
228 * nfs_page_find_head_request - find head request associated with @page
230 * returns matching head request with reference held, or NULL if not found.
232 static struct nfs_page *nfs_page_find_head_request(struct page *page)
234 struct nfs_page *req;
236 req = nfs_page_find_private_request(page);
238 req = nfs_page_find_swap_request(page);
242 static struct nfs_page *nfs_find_and_lock_page_request(struct page *page)
244 struct inode *inode = page_file_mapping(page)->host;
245 struct nfs_page *req, *head;
249 req = nfs_page_find_head_request(page);
252 head = nfs_page_group_lock_head(req);
254 nfs_release_request(req);
257 ret = nfs_cancel_remove_inode(head, inode);
259 nfs_unlock_and_release_request(head);
262 /* Ensure that nobody removed the request before we locked it */
263 if (head == nfs_page_private_request(page))
265 if (PageSwapCache(page))
267 nfs_unlock_and_release_request(head);
272 /* Adjust the file length if we're writing beyond the end */
273 static void nfs_grow_file(struct page *page, unsigned int offset, unsigned int count)
275 struct inode *inode = page_file_mapping(page)->host;
279 spin_lock(&inode->i_lock);
280 i_size = i_size_read(inode);
281 end_index = (i_size - 1) >> PAGE_SHIFT;
282 if (i_size > 0 && page_index(page) < end_index)
284 end = page_file_offset(page) + ((loff_t)offset+count);
287 trace_nfs_size_grow(inode, end);
288 i_size_write(inode, end);
289 NFS_I(inode)->cache_validity &= ~NFS_INO_INVALID_SIZE;
290 nfs_inc_stats(inode, NFSIOS_EXTENDWRITE);
292 spin_unlock(&inode->i_lock);
293 nfs_fscache_invalidate(inode, 0);
296 /* A writeback failed: mark the page as bad, and invalidate the page cache */
297 static void nfs_set_pageerror(struct address_space *mapping)
299 struct inode *inode = mapping->host;
301 nfs_zap_mapping(mapping->host, mapping);
302 /* Force file size revalidation */
303 spin_lock(&inode->i_lock);
304 nfs_set_cache_invalid(inode, NFS_INO_REVAL_FORCED |
305 NFS_INO_INVALID_CHANGE |
306 NFS_INO_INVALID_SIZE);
307 spin_unlock(&inode->i_lock);
310 static void nfs_mapping_set_error(struct page *page, int error)
312 struct address_space *mapping = page_file_mapping(page);
315 filemap_set_wb_err(mapping, error);
317 errseq_set(&mapping->host->i_sb->s_wb_err,
318 error == -ENOSPC ? -ENOSPC : -EIO);
319 nfs_set_pageerror(mapping);
323 * nfs_page_group_search_locked
324 * @head - head request of page group
325 * @page_offset - offset into page
327 * Search page group with head @head to find a request that contains the
328 * page offset @page_offset.
330 * Returns a pointer to the first matching nfs request, or NULL if no
333 * Must be called with the page group lock held
335 static struct nfs_page *
336 nfs_page_group_search_locked(struct nfs_page *head, unsigned int page_offset)
338 struct nfs_page *req;
342 if (page_offset >= req->wb_pgbase &&
343 page_offset < (req->wb_pgbase + req->wb_bytes))
346 req = req->wb_this_page;
347 } while (req != head);
353 * nfs_page_group_covers_page
354 * @head - head request of page group
356 * Return true if the page group with head @head covers the whole page,
357 * returns false otherwise
359 static bool nfs_page_group_covers_page(struct nfs_page *req)
361 struct nfs_page *tmp;
362 unsigned int pos = 0;
363 unsigned int len = nfs_page_length(req->wb_page);
365 nfs_page_group_lock(req);
368 tmp = nfs_page_group_search_locked(req->wb_head, pos);
371 pos = tmp->wb_pgbase + tmp->wb_bytes;
374 nfs_page_group_unlock(req);
378 /* We can set the PG_uptodate flag if we see that a write request
379 * covers the full page.
381 static void nfs_mark_uptodate(struct nfs_page *req)
383 if (PageUptodate(req->wb_page))
385 if (!nfs_page_group_covers_page(req))
387 SetPageUptodate(req->wb_page);
390 static int wb_priority(struct writeback_control *wbc)
394 if (wbc->sync_mode == WB_SYNC_ALL)
395 ret = FLUSH_COND_STABLE;
400 * NFS congestion control
403 int nfs_congestion_kb;
405 #define NFS_CONGESTION_ON_THRESH (nfs_congestion_kb >> (PAGE_SHIFT-10))
406 #define NFS_CONGESTION_OFF_THRESH \
407 (NFS_CONGESTION_ON_THRESH - (NFS_CONGESTION_ON_THRESH >> 2))
409 static void nfs_set_page_writeback(struct page *page)
411 struct inode *inode = page_file_mapping(page)->host;
412 struct nfs_server *nfss = NFS_SERVER(inode);
413 int ret = test_set_page_writeback(page);
415 WARN_ON_ONCE(ret != 0);
417 if (atomic_long_inc_return(&nfss->writeback) >
418 NFS_CONGESTION_ON_THRESH)
419 nfss->write_congested = 1;
422 static void nfs_end_page_writeback(struct nfs_page *req)
424 struct inode *inode = page_file_mapping(req->wb_page)->host;
425 struct nfs_server *nfss = NFS_SERVER(inode);
428 is_done = nfs_page_group_sync_on_bit(req, PG_WB_END);
429 nfs_unlock_request(req);
433 end_page_writeback(req->wb_page);
434 if (atomic_long_dec_return(&nfss->writeback) < NFS_CONGESTION_OFF_THRESH)
435 nfss->write_congested = 0;
439 * nfs_destroy_unlinked_subrequests - destroy recently unlinked subrequests
441 * @destroy_list - request list (using wb_this_page) terminated by @old_head
442 * @old_head - the old head of the list
444 * All subrequests must be locked and removed from all lists, so at this point
445 * they are only "active" in this function, and possibly in nfs_wait_on_request
446 * with a reference held by some other context.
449 nfs_destroy_unlinked_subrequests(struct nfs_page *destroy_list,
450 struct nfs_page *old_head,
453 while (destroy_list) {
454 struct nfs_page *subreq = destroy_list;
456 destroy_list = (subreq->wb_this_page == old_head) ?
457 NULL : subreq->wb_this_page;
459 /* Note: lock subreq in order to change subreq->wb_head */
460 nfs_page_set_headlock(subreq);
461 WARN_ON_ONCE(old_head != subreq->wb_head);
463 /* make sure old group is not used */
464 subreq->wb_this_page = subreq;
465 subreq->wb_head = subreq;
467 clear_bit(PG_REMOVE, &subreq->wb_flags);
469 /* Note: races with nfs_page_group_destroy() */
470 if (!kref_read(&subreq->wb_kref)) {
471 /* Check if we raced with nfs_page_group_destroy() */
472 if (test_and_clear_bit(PG_TEARDOWN, &subreq->wb_flags)) {
473 nfs_page_clear_headlock(subreq);
474 nfs_free_request(subreq);
476 nfs_page_clear_headlock(subreq);
479 nfs_page_clear_headlock(subreq);
481 nfs_release_request(old_head);
483 if (test_and_clear_bit(PG_INODE_REF, &subreq->wb_flags)) {
484 nfs_release_request(subreq);
485 atomic_long_dec(&NFS_I(inode)->nrequests);
488 /* subreq is now totally disconnected from page group or any
489 * write / commit lists. last chance to wake any waiters */
490 nfs_unlock_and_release_request(subreq);
495 * nfs_join_page_group - destroy subrequests of the head req
496 * @head: the page used to lookup the "page group" of nfs_page structures
497 * @inode: Inode to which the request belongs.
499 * This function joins all sub requests to the head request by first
500 * locking all requests in the group, cancelling any pending operations
501 * and finally updating the head request to cover the whole range covered by
502 * the (former) group. All subrequests are removed from any write or commit
503 * lists, unlinked from the group and destroyed.
506 nfs_join_page_group(struct nfs_page *head, struct inode *inode)
508 struct nfs_page *subreq;
509 struct nfs_page *destroy_list = NULL;
510 unsigned int pgbase, off, bytes;
512 pgbase = head->wb_pgbase;
513 bytes = head->wb_bytes;
514 off = head->wb_offset;
515 for (subreq = head->wb_this_page; subreq != head;
516 subreq = subreq->wb_this_page) {
517 /* Subrequests should always form a contiguous range */
518 if (pgbase > subreq->wb_pgbase) {
519 off -= pgbase - subreq->wb_pgbase;
520 bytes += pgbase - subreq->wb_pgbase;
521 pgbase = subreq->wb_pgbase;
523 bytes = max(subreq->wb_pgbase + subreq->wb_bytes
527 /* Set the head request's range to cover the former page group */
528 head->wb_pgbase = pgbase;
529 head->wb_bytes = bytes;
530 head->wb_offset = off;
532 /* Now that all requests are locked, make sure they aren't on any list.
533 * Commit list removal accounting is done after locks are dropped */
536 nfs_clear_request_commit(subreq);
537 subreq = subreq->wb_this_page;
538 } while (subreq != head);
540 /* unlink subrequests from head, destroy them later */
541 if (head->wb_this_page != head) {
542 /* destroy list will be terminated by head */
543 destroy_list = head->wb_this_page;
544 head->wb_this_page = head;
547 nfs_destroy_unlinked_subrequests(destroy_list, head, inode);
551 * nfs_lock_and_join_requests - join all subreqs to the head req
552 * @page: the page used to lookup the "page group" of nfs_page structures
554 * This function joins all sub requests to the head request by first
555 * locking all requests in the group, cancelling any pending operations
556 * and finally updating the head request to cover the whole range covered by
557 * the (former) group. All subrequests are removed from any write or commit
558 * lists, unlinked from the group and destroyed.
560 * Returns a locked, referenced pointer to the head request - which after
561 * this call is guaranteed to be the only request associated with the page.
562 * Returns NULL if no requests are found for @page, or a ERR_PTR if an
563 * error was encountered.
565 static struct nfs_page *
566 nfs_lock_and_join_requests(struct page *page)
568 struct inode *inode = page_file_mapping(page)->host;
569 struct nfs_page *head;
573 * A reference is taken only on the head request which acts as a
574 * reference to the whole page group - the group will not be destroyed
575 * until the head reference is released.
577 head = nfs_find_and_lock_page_request(page);
578 if (IS_ERR_OR_NULL(head))
581 /* lock each request in the page group */
582 ret = nfs_page_group_lock_subrequests(head);
584 nfs_unlock_and_release_request(head);
588 nfs_join_page_group(head, inode);
593 static void nfs_write_error(struct nfs_page *req, int error)
595 trace_nfs_write_error(req, error);
596 nfs_mapping_set_error(req->wb_page, error);
597 nfs_inode_remove_request(req);
598 nfs_end_page_writeback(req);
599 nfs_release_request(req);
603 * Find an associated nfs write request, and prepare to flush it out
604 * May return an error if the user signalled nfs_wait_on_request().
606 static int nfs_page_async_flush(struct nfs_pageio_descriptor *pgio,
609 struct nfs_page *req;
612 req = nfs_lock_and_join_requests(page);
619 nfs_set_page_writeback(page);
620 WARN_ON_ONCE(test_bit(PG_CLEAN, &req->wb_flags));
622 /* If there is a fatal error that covers this write, just exit */
623 ret = pgio->pg_error;
624 if (nfs_error_is_fatal_on_server(ret))
628 if (!nfs_pageio_add_request(pgio, req)) {
629 ret = pgio->pg_error;
631 * Remove the problematic req upon fatal errors on the server
633 if (nfs_error_is_fatal(ret)) {
634 if (nfs_error_is_fatal_on_server(ret))
638 nfs_redirty_request(req);
641 nfs_add_stats(page_file_mapping(page)->host,
642 NFSIOS_WRITEPAGES, 1);
646 nfs_write_error(req, ret);
650 static int nfs_do_writepage(struct page *page, struct writeback_control *wbc,
651 struct nfs_pageio_descriptor *pgio)
655 nfs_pageio_cond_complete(pgio, page_index(page));
656 ret = nfs_page_async_flush(pgio, page);
657 if (ret == -EAGAIN) {
658 redirty_page_for_writepage(wbc, page);
659 ret = AOP_WRITEPAGE_ACTIVATE;
665 * Write an mmapped page to the server.
667 static int nfs_writepage_locked(struct page *page,
668 struct writeback_control *wbc)
670 struct nfs_pageio_descriptor pgio;
671 struct inode *inode = page_file_mapping(page)->host;
674 if (wbc->sync_mode == WB_SYNC_NONE &&
675 NFS_SERVER(inode)->write_congested)
676 return AOP_WRITEPAGE_ACTIVATE;
678 nfs_inc_stats(inode, NFSIOS_VFSWRITEPAGE);
679 nfs_pageio_init_write(&pgio, inode, 0,
680 false, &nfs_async_write_completion_ops);
681 err = nfs_do_writepage(page, wbc, &pgio);
683 nfs_pageio_complete(&pgio);
686 if (nfs_error_is_fatal(pgio.pg_error))
687 return pgio.pg_error;
691 int nfs_writepage(struct page *page, struct writeback_control *wbc)
695 ret = nfs_writepage_locked(page, wbc);
696 if (ret != AOP_WRITEPAGE_ACTIVATE)
701 static int nfs_writepages_callback(struct page *page, struct writeback_control *wbc, void *data)
705 ret = nfs_do_writepage(page, wbc, data);
706 if (ret != AOP_WRITEPAGE_ACTIVATE)
711 static void nfs_io_completion_commit(void *inode)
713 nfs_commit_inode(inode, 0);
716 int nfs_writepages(struct address_space *mapping, struct writeback_control *wbc)
718 struct inode *inode = mapping->host;
719 struct nfs_pageio_descriptor pgio;
720 struct nfs_io_completion *ioc = NULL;
721 unsigned int mntflags = NFS_SERVER(inode)->flags;
725 if (wbc->sync_mode == WB_SYNC_NONE &&
726 NFS_SERVER(inode)->write_congested)
729 nfs_inc_stats(inode, NFSIOS_VFSWRITEPAGES);
731 if (!(mntflags & NFS_MOUNT_WRITE_EAGER) || wbc->for_kupdate ||
732 wbc->for_background || wbc->for_sync || wbc->for_reclaim) {
733 ioc = nfs_io_completion_alloc(GFP_KERNEL);
735 nfs_io_completion_init(ioc, nfs_io_completion_commit,
737 priority = wb_priority(wbc);
740 nfs_pageio_init_write(&pgio, inode, priority, false,
741 &nfs_async_write_completion_ops);
742 pgio.pg_io_completion = ioc;
743 err = write_cache_pages(mapping, wbc, nfs_writepages_callback, &pgio);
745 nfs_pageio_complete(&pgio);
746 nfs_io_completion_put(ioc);
751 if (nfs_error_is_fatal(err))
759 * Insert a write request into an inode
761 static void nfs_inode_add_request(struct inode *inode, struct nfs_page *req)
763 struct address_space *mapping = page_file_mapping(req->wb_page);
764 struct nfs_inode *nfsi = NFS_I(inode);
766 WARN_ON_ONCE(req->wb_this_page != req);
768 /* Lock the request! */
769 nfs_lock_request(req);
772 * Swap-space should not get truncated. Hence no need to plug the race
773 * with invalidate/truncate.
775 spin_lock(&mapping->private_lock);
776 if (likely(!PageSwapCache(req->wb_page))) {
777 set_bit(PG_MAPPED, &req->wb_flags);
778 SetPagePrivate(req->wb_page);
779 set_page_private(req->wb_page, (unsigned long)req);
781 spin_unlock(&mapping->private_lock);
782 atomic_long_inc(&nfsi->nrequests);
783 /* this a head request for a page group - mark it as having an
784 * extra reference so sub groups can follow suit.
785 * This flag also informs pgio layer when to bump nrequests when
786 * adding subrequests. */
787 WARN_ON(test_and_set_bit(PG_INODE_REF, &req->wb_flags));
788 kref_get(&req->wb_kref);
792 * Remove a write request from an inode
794 static void nfs_inode_remove_request(struct nfs_page *req)
796 struct address_space *mapping = page_file_mapping(req->wb_page);
797 struct inode *inode = mapping->host;
798 struct nfs_inode *nfsi = NFS_I(inode);
799 struct nfs_page *head;
801 if (nfs_page_group_sync_on_bit(req, PG_REMOVE)) {
804 spin_lock(&mapping->private_lock);
805 if (likely(head->wb_page && !PageSwapCache(head->wb_page))) {
806 set_page_private(head->wb_page, 0);
807 ClearPagePrivate(head->wb_page);
808 clear_bit(PG_MAPPED, &head->wb_flags);
810 spin_unlock(&mapping->private_lock);
813 if (test_and_clear_bit(PG_INODE_REF, &req->wb_flags)) {
814 nfs_release_request(req);
815 atomic_long_dec(&nfsi->nrequests);
820 nfs_mark_request_dirty(struct nfs_page *req)
823 __set_page_dirty_nobuffers(req->wb_page);
827 * nfs_page_search_commits_for_head_request_locked
829 * Search through commit lists on @inode for the head request for @page.
830 * Must be called while holding the inode (which is cinfo) lock.
832 * Returns the head request if found, or NULL if not found.
834 static struct nfs_page *
835 nfs_page_search_commits_for_head_request_locked(struct nfs_inode *nfsi,
838 struct nfs_page *freq, *t;
839 struct nfs_commit_info cinfo;
840 struct inode *inode = &nfsi->vfs_inode;
842 nfs_init_cinfo_from_inode(&cinfo, inode);
844 /* search through pnfs commit lists */
845 freq = pnfs_search_commit_reqs(inode, &cinfo, page);
847 return freq->wb_head;
849 /* Linearly search the commit list for the correct request */
850 list_for_each_entry_safe(freq, t, &cinfo.mds->list, wb_list) {
851 if (freq->wb_page == page)
852 return freq->wb_head;
859 * nfs_request_add_commit_list_locked - add request to a commit list
860 * @req: pointer to a struct nfs_page
861 * @dst: commit list head
862 * @cinfo: holds list lock and accounting info
864 * This sets the PG_CLEAN bit, updates the cinfo count of
865 * number of outstanding requests requiring a commit as well as
868 * The caller must hold NFS_I(cinfo->inode)->commit_mutex, and the
872 nfs_request_add_commit_list_locked(struct nfs_page *req, struct list_head *dst,
873 struct nfs_commit_info *cinfo)
875 set_bit(PG_CLEAN, &req->wb_flags);
876 nfs_list_add_request(req, dst);
877 atomic_long_inc(&cinfo->mds->ncommit);
879 EXPORT_SYMBOL_GPL(nfs_request_add_commit_list_locked);
882 * nfs_request_add_commit_list - add request to a commit list
883 * @req: pointer to a struct nfs_page
884 * @cinfo: holds list lock and accounting info
886 * This sets the PG_CLEAN bit, updates the cinfo count of
887 * number of outstanding requests requiring a commit as well as
890 * The caller must _not_ hold the cinfo->lock, but must be
891 * holding the nfs_page lock.
894 nfs_request_add_commit_list(struct nfs_page *req, struct nfs_commit_info *cinfo)
896 mutex_lock(&NFS_I(cinfo->inode)->commit_mutex);
897 nfs_request_add_commit_list_locked(req, &cinfo->mds->list, cinfo);
898 mutex_unlock(&NFS_I(cinfo->inode)->commit_mutex);
900 nfs_mark_page_unstable(req->wb_page, cinfo);
902 EXPORT_SYMBOL_GPL(nfs_request_add_commit_list);
905 * nfs_request_remove_commit_list - Remove request from a commit list
906 * @req: pointer to a nfs_page
907 * @cinfo: holds list lock and accounting info
909 * This clears the PG_CLEAN bit, and updates the cinfo's count of
910 * number of outstanding requests requiring a commit
911 * It does not update the MM page stats.
913 * The caller _must_ hold the cinfo->lock and the nfs_page lock.
916 nfs_request_remove_commit_list(struct nfs_page *req,
917 struct nfs_commit_info *cinfo)
919 if (!test_and_clear_bit(PG_CLEAN, &(req)->wb_flags))
921 nfs_list_remove_request(req);
922 atomic_long_dec(&cinfo->mds->ncommit);
924 EXPORT_SYMBOL_GPL(nfs_request_remove_commit_list);
926 static void nfs_init_cinfo_from_inode(struct nfs_commit_info *cinfo,
929 cinfo->inode = inode;
930 cinfo->mds = &NFS_I(inode)->commit_info;
931 cinfo->ds = pnfs_get_ds_info(inode);
933 cinfo->completion_ops = &nfs_commit_completion_ops;
936 void nfs_init_cinfo(struct nfs_commit_info *cinfo,
938 struct nfs_direct_req *dreq)
941 nfs_init_cinfo_from_dreq(cinfo, dreq);
943 nfs_init_cinfo_from_inode(cinfo, inode);
945 EXPORT_SYMBOL_GPL(nfs_init_cinfo);
948 * Add a request to the inode's commit list.
951 nfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
952 struct nfs_commit_info *cinfo, u32 ds_commit_idx)
954 if (pnfs_mark_request_commit(req, lseg, cinfo, ds_commit_idx))
956 nfs_request_add_commit_list(req, cinfo);
960 nfs_clear_page_commit(struct page *page)
962 dec_node_page_state(page, NR_WRITEBACK);
963 dec_wb_stat(&inode_to_bdi(page_file_mapping(page)->host)->wb,
967 /* Called holding the request lock on @req */
969 nfs_clear_request_commit(struct nfs_page *req)
971 if (test_bit(PG_CLEAN, &req->wb_flags)) {
972 struct nfs_open_context *ctx = nfs_req_openctx(req);
973 struct inode *inode = d_inode(ctx->dentry);
974 struct nfs_commit_info cinfo;
976 nfs_init_cinfo_from_inode(&cinfo, inode);
977 mutex_lock(&NFS_I(inode)->commit_mutex);
978 if (!pnfs_clear_request_commit(req, &cinfo)) {
979 nfs_request_remove_commit_list(req, &cinfo);
981 mutex_unlock(&NFS_I(inode)->commit_mutex);
982 nfs_clear_page_commit(req->wb_page);
986 int nfs_write_need_commit(struct nfs_pgio_header *hdr)
988 if (hdr->verf.committed == NFS_DATA_SYNC)
989 return hdr->lseg == NULL;
990 return hdr->verf.committed != NFS_FILE_SYNC;
993 static void nfs_async_write_init(struct nfs_pgio_header *hdr)
995 nfs_io_completion_get(hdr->io_completion);
998 static void nfs_write_completion(struct nfs_pgio_header *hdr)
1000 struct nfs_commit_info cinfo;
1001 unsigned long bytes = 0;
1003 if (test_bit(NFS_IOHDR_REDO, &hdr->flags))
1005 nfs_init_cinfo_from_inode(&cinfo, hdr->inode);
1006 while (!list_empty(&hdr->pages)) {
1007 struct nfs_page *req = nfs_list_entry(hdr->pages.next);
1009 bytes += req->wb_bytes;
1010 nfs_list_remove_request(req);
1011 if (test_bit(NFS_IOHDR_ERROR, &hdr->flags) &&
1012 (hdr->good_bytes < bytes)) {
1013 trace_nfs_comp_error(req, hdr->error);
1014 nfs_mapping_set_error(req->wb_page, hdr->error);
1017 if (nfs_write_need_commit(hdr)) {
1018 /* Reset wb_nio, since the write was successful. */
1020 memcpy(&req->wb_verf, &hdr->verf.verifier, sizeof(req->wb_verf));
1021 nfs_mark_request_commit(req, hdr->lseg, &cinfo,
1022 hdr->pgio_mirror_idx);
1026 nfs_inode_remove_request(req);
1028 nfs_end_page_writeback(req);
1029 nfs_release_request(req);
1032 nfs_io_completion_put(hdr->io_completion);
1037 nfs_reqs_to_commit(struct nfs_commit_info *cinfo)
1039 return atomic_long_read(&cinfo->mds->ncommit);
1042 /* NFS_I(cinfo->inode)->commit_mutex held by caller */
1044 nfs_scan_commit_list(struct list_head *src, struct list_head *dst,
1045 struct nfs_commit_info *cinfo, int max)
1047 struct nfs_page *req, *tmp;
1050 list_for_each_entry_safe(req, tmp, src, wb_list) {
1051 kref_get(&req->wb_kref);
1052 if (!nfs_lock_request(req)) {
1053 nfs_release_request(req);
1056 nfs_request_remove_commit_list(req, cinfo);
1057 clear_bit(PG_COMMIT_TO_DS, &req->wb_flags);
1058 nfs_list_add_request(req, dst);
1060 if ((ret == max) && !cinfo->dreq)
1066 EXPORT_SYMBOL_GPL(nfs_scan_commit_list);
1069 * nfs_scan_commit - Scan an inode for commit requests
1070 * @inode: NFS inode to scan
1071 * @dst: mds destination list
1072 * @cinfo: mds and ds lists of reqs ready to commit
1074 * Moves requests from the inode's 'commit' request list.
1075 * The requests are *not* checked to ensure that they form a contiguous set.
1078 nfs_scan_commit(struct inode *inode, struct list_head *dst,
1079 struct nfs_commit_info *cinfo)
1083 if (!atomic_long_read(&cinfo->mds->ncommit))
1085 mutex_lock(&NFS_I(cinfo->inode)->commit_mutex);
1086 if (atomic_long_read(&cinfo->mds->ncommit) > 0) {
1087 const int max = INT_MAX;
1089 ret = nfs_scan_commit_list(&cinfo->mds->list, dst,
1091 ret += pnfs_scan_commit_lists(inode, cinfo, max - ret);
1093 mutex_unlock(&NFS_I(cinfo->inode)->commit_mutex);
1098 * Search for an existing write request, and attempt to update
1099 * it to reflect a new dirty region on a given page.
1101 * If the attempt fails, then the existing request is flushed out
1104 static struct nfs_page *nfs_try_to_update_request(struct inode *inode,
1106 unsigned int offset,
1109 struct nfs_page *req;
1114 end = offset + bytes;
1116 req = nfs_lock_and_join_requests(page);
1117 if (IS_ERR_OR_NULL(req))
1120 rqend = req->wb_offset + req->wb_bytes;
1122 * Tell the caller to flush out the request if
1123 * the offsets are non-contiguous.
1124 * Note: nfs_flush_incompatible() will already
1125 * have flushed out requests having wrong owners.
1127 if (offset > rqend || end < req->wb_offset)
1130 /* Okay, the request matches. Update the region */
1131 if (offset < req->wb_offset) {
1132 req->wb_offset = offset;
1133 req->wb_pgbase = offset;
1136 req->wb_bytes = end - req->wb_offset;
1138 req->wb_bytes = rqend - req->wb_offset;
1143 * Note: we mark the request dirty here because
1144 * nfs_lock_and_join_requests() cannot preserve
1145 * commit flags, so we have to replay the write.
1147 nfs_mark_request_dirty(req);
1148 nfs_unlock_and_release_request(req);
1149 error = nfs_wb_page(inode, page);
1150 return (error < 0) ? ERR_PTR(error) : NULL;
1154 * Try to update an existing write request, or create one if there is none.
1156 * Note: Should always be called with the Page Lock held to prevent races
1157 * if we have to add a new request. Also assumes that the caller has
1158 * already called nfs_flush_incompatible() if necessary.
1160 static struct nfs_page * nfs_setup_write_request(struct nfs_open_context* ctx,
1161 struct page *page, unsigned int offset, unsigned int bytes)
1163 struct inode *inode = page_file_mapping(page)->host;
1164 struct nfs_page *req;
1166 req = nfs_try_to_update_request(inode, page, offset, bytes);
1169 req = nfs_create_request(ctx, page, offset, bytes);
1172 nfs_inode_add_request(inode, req);
1177 static int nfs_writepage_setup(struct nfs_open_context *ctx, struct page *page,
1178 unsigned int offset, unsigned int count)
1180 struct nfs_page *req;
1182 req = nfs_setup_write_request(ctx, page, offset, count);
1184 return PTR_ERR(req);
1185 /* Update file length */
1186 nfs_grow_file(page, offset, count);
1187 nfs_mark_uptodate(req);
1188 nfs_mark_request_dirty(req);
1189 nfs_unlock_and_release_request(req);
1193 int nfs_flush_incompatible(struct file *file, struct page *page)
1195 struct nfs_open_context *ctx = nfs_file_open_context(file);
1196 struct nfs_lock_context *l_ctx;
1197 struct file_lock_context *flctx = file_inode(file)->i_flctx;
1198 struct nfs_page *req;
1199 int do_flush, status;
1201 * Look for a request corresponding to this page. If there
1202 * is one, and it belongs to another file, we flush it out
1203 * before we try to copy anything into the page. Do this
1204 * due to the lack of an ACCESS-type call in NFSv2.
1205 * Also do the same if we find a request from an existing
1209 req = nfs_page_find_head_request(page);
1212 l_ctx = req->wb_lock_context;
1213 do_flush = req->wb_page != page ||
1214 !nfs_match_open_context(nfs_req_openctx(req), ctx);
1215 if (l_ctx && flctx &&
1216 !(list_empty_careful(&flctx->flc_posix) &&
1217 list_empty_careful(&flctx->flc_flock))) {
1218 do_flush |= l_ctx->lockowner != current->files;
1220 nfs_release_request(req);
1223 status = nfs_wb_page(page_file_mapping(page)->host, page);
1224 } while (status == 0);
1229 * Avoid buffered writes when a open context credential's key would
1232 * Returns -EACCES if the key will expire within RPC_KEY_EXPIRE_FAIL.
1234 * Return 0 and set a credential flag which triggers the inode to flush
1235 * and performs NFS_FILE_SYNC writes if the key will expired within
1236 * RPC_KEY_EXPIRE_TIMEO.
1239 nfs_key_timeout_notify(struct file *filp, struct inode *inode)
1241 struct nfs_open_context *ctx = nfs_file_open_context(filp);
1243 if (nfs_ctx_key_to_expire(ctx, inode) &&
1244 !rcu_access_pointer(ctx->ll_cred))
1245 /* Already expired! */
1251 * Test if the open context credential key is marked to expire soon.
1253 bool nfs_ctx_key_to_expire(struct nfs_open_context *ctx, struct inode *inode)
1255 struct rpc_auth *auth = NFS_SERVER(inode)->client->cl_auth;
1256 struct rpc_cred *cred, *new, *old = NULL;
1257 struct auth_cred acred = {
1263 cred = rcu_dereference(ctx->ll_cred);
1264 if (cred && !(cred->cr_ops->crkey_timeout &&
1265 cred->cr_ops->crkey_timeout(cred)))
1269 new = auth->au_ops->lookup_cred(auth, &acred, 0);
1274 if (IS_ERR_OR_NULL(new)) {
1277 } else if (new->cr_ops->crkey_timeout &&
1278 new->cr_ops->crkey_timeout(new))
1282 old = rcu_dereference_protected(xchg(&ctx->ll_cred,
1283 RCU_INITIALIZER(new)), 1);
1291 * If the page cache is marked as unsafe or invalid, then we can't rely on
1292 * the PageUptodate() flag. In this case, we will need to turn off
1293 * write optimisations that depend on the page contents being correct.
1295 static bool nfs_write_pageuptodate(struct page *page, struct inode *inode,
1296 unsigned int pagelen)
1298 struct nfs_inode *nfsi = NFS_I(inode);
1300 if (nfs_have_delegated_attributes(inode))
1302 if (nfsi->cache_validity &
1303 (NFS_INO_INVALID_CHANGE | NFS_INO_INVALID_SIZE))
1306 if (test_bit(NFS_INO_INVALIDATING, &nfsi->flags) && pagelen != 0)
1309 if (nfsi->cache_validity & NFS_INO_INVALID_DATA && pagelen != 0)
1311 return PageUptodate(page) != 0;
1315 is_whole_file_wrlock(struct file_lock *fl)
1317 return fl->fl_start == 0 && fl->fl_end == OFFSET_MAX &&
1318 fl->fl_type == F_WRLCK;
1321 /* If we know the page is up to date, and we're not using byte range locks (or
1322 * if we have the whole file locked for writing), it may be more efficient to
1323 * extend the write to cover the entire page in order to avoid fragmentation
1326 * If the file is opened for synchronous writes then we can just skip the rest
1329 static int nfs_can_extend_write(struct file *file, struct page *page,
1330 struct inode *inode, unsigned int pagelen)
1333 struct file_lock_context *flctx = inode->i_flctx;
1334 struct file_lock *fl;
1336 if (file->f_flags & O_DSYNC)
1338 if (!nfs_write_pageuptodate(page, inode, pagelen))
1340 if (NFS_PROTO(inode)->have_delegation(inode, FMODE_WRITE))
1342 if (!flctx || (list_empty_careful(&flctx->flc_flock) &&
1343 list_empty_careful(&flctx->flc_posix)))
1346 /* Check to see if there are whole file write locks */
1348 spin_lock(&flctx->flc_lock);
1349 if (!list_empty(&flctx->flc_posix)) {
1350 fl = list_first_entry(&flctx->flc_posix, struct file_lock,
1352 if (is_whole_file_wrlock(fl))
1354 } else if (!list_empty(&flctx->flc_flock)) {
1355 fl = list_first_entry(&flctx->flc_flock, struct file_lock,
1357 if (fl->fl_type == F_WRLCK)
1360 spin_unlock(&flctx->flc_lock);
1365 * Update and possibly write a cached page of an NFS file.
1367 * XXX: Keep an eye on generic_file_read to make sure it doesn't do bad
1368 * things with a page scheduled for an RPC call (e.g. invalidate it).
1370 int nfs_updatepage(struct file *file, struct page *page,
1371 unsigned int offset, unsigned int count)
1373 struct nfs_open_context *ctx = nfs_file_open_context(file);
1374 struct address_space *mapping = page_file_mapping(page);
1375 struct inode *inode = mapping->host;
1376 unsigned int pagelen = nfs_page_length(page);
1379 nfs_inc_stats(inode, NFSIOS_VFSUPDATEPAGE);
1381 dprintk("NFS: nfs_updatepage(%pD2 %d@%lld)\n",
1382 file, count, (long long)(page_file_offset(page) + offset));
1387 if (nfs_can_extend_write(file, page, inode, pagelen)) {
1388 count = max(count + offset, pagelen);
1392 status = nfs_writepage_setup(ctx, page, offset, count);
1394 nfs_set_pageerror(mapping);
1396 dprintk("NFS: nfs_updatepage returns %d (isize %lld)\n",
1397 status, (long long)i_size_read(inode));
1401 static int flush_task_priority(int how)
1403 switch (how & (FLUSH_HIGHPRI|FLUSH_LOWPRI)) {
1405 return RPC_PRIORITY_HIGH;
1407 return RPC_PRIORITY_LOW;
1409 return RPC_PRIORITY_NORMAL;
1412 static void nfs_initiate_write(struct nfs_pgio_header *hdr,
1413 struct rpc_message *msg,
1414 const struct nfs_rpc_ops *rpc_ops,
1415 struct rpc_task_setup *task_setup_data, int how)
1417 int priority = flush_task_priority(how);
1419 if (IS_SWAPFILE(hdr->inode))
1420 task_setup_data->flags |= RPC_TASK_SWAPPER;
1421 task_setup_data->priority = priority;
1422 rpc_ops->write_setup(hdr, msg, &task_setup_data->rpc_client);
1423 trace_nfs_initiate_write(hdr);
1426 /* If a nfs_flush_* function fails, it should remove reqs from @head and
1427 * call this on each, which will prepare them to be retried on next
1428 * writeback using standard nfs.
1430 static void nfs_redirty_request(struct nfs_page *req)
1432 /* Bump the transmission count */
1434 nfs_mark_request_dirty(req);
1435 set_bit(NFS_CONTEXT_RESEND_WRITES, &nfs_req_openctx(req)->flags);
1436 nfs_end_page_writeback(req);
1437 nfs_release_request(req);
1440 static void nfs_async_write_error(struct list_head *head, int error)
1442 struct nfs_page *req;
1444 while (!list_empty(head)) {
1445 req = nfs_list_entry(head->next);
1446 nfs_list_remove_request(req);
1447 if (nfs_error_is_fatal(error))
1448 nfs_write_error(req, error);
1450 nfs_redirty_request(req);
1454 static void nfs_async_write_reschedule_io(struct nfs_pgio_header *hdr)
1456 nfs_async_write_error(&hdr->pages, 0);
1457 filemap_fdatawrite_range(hdr->inode->i_mapping, hdr->args.offset,
1458 hdr->args.offset + hdr->args.count - 1);
1461 static const struct nfs_pgio_completion_ops nfs_async_write_completion_ops = {
1462 .init_hdr = nfs_async_write_init,
1463 .error_cleanup = nfs_async_write_error,
1464 .completion = nfs_write_completion,
1465 .reschedule_io = nfs_async_write_reschedule_io,
1468 void nfs_pageio_init_write(struct nfs_pageio_descriptor *pgio,
1469 struct inode *inode, int ioflags, bool force_mds,
1470 const struct nfs_pgio_completion_ops *compl_ops)
1472 struct nfs_server *server = NFS_SERVER(inode);
1473 const struct nfs_pageio_ops *pg_ops = &nfs_pgio_rw_ops;
1475 #ifdef CONFIG_NFS_V4_1
1476 if (server->pnfs_curr_ld && !force_mds)
1477 pg_ops = server->pnfs_curr_ld->pg_write_ops;
1479 nfs_pageio_init(pgio, inode, pg_ops, compl_ops, &nfs_rw_write_ops,
1480 server->wsize, ioflags);
1482 EXPORT_SYMBOL_GPL(nfs_pageio_init_write);
1484 void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio)
1486 struct nfs_pgio_mirror *mirror;
1488 if (pgio->pg_ops && pgio->pg_ops->pg_cleanup)
1489 pgio->pg_ops->pg_cleanup(pgio);
1491 pgio->pg_ops = &nfs_pgio_rw_ops;
1493 nfs_pageio_stop_mirroring(pgio);
1495 mirror = &pgio->pg_mirrors[0];
1496 mirror->pg_bsize = NFS_SERVER(pgio->pg_inode)->wsize;
1498 EXPORT_SYMBOL_GPL(nfs_pageio_reset_write_mds);
1501 void nfs_commit_prepare(struct rpc_task *task, void *calldata)
1503 struct nfs_commit_data *data = calldata;
1505 NFS_PROTO(data->inode)->commit_rpc_prepare(task, data);
1509 * Special version of should_remove_suid() that ignores capabilities.
1511 static int nfs_should_remove_suid(const struct inode *inode)
1513 umode_t mode = inode->i_mode;
1516 /* suid always must be killed */
1517 if (unlikely(mode & S_ISUID))
1518 kill = ATTR_KILL_SUID;
1521 * sgid without any exec bits is just a mandatory locking mark; leave
1522 * it alone. If some exec bits are set, it's a real sgid; kill it.
1524 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1525 kill |= ATTR_KILL_SGID;
1527 if (unlikely(kill && S_ISREG(mode)))
1533 static void nfs_writeback_check_extend(struct nfs_pgio_header *hdr,
1534 struct nfs_fattr *fattr)
1536 struct nfs_pgio_args *argp = &hdr->args;
1537 struct nfs_pgio_res *resp = &hdr->res;
1538 u64 size = argp->offset + resp->count;
1540 if (!(fattr->valid & NFS_ATTR_FATTR_SIZE))
1542 if (nfs_size_to_loff_t(fattr->size) < i_size_read(hdr->inode)) {
1543 fattr->valid &= ~NFS_ATTR_FATTR_SIZE;
1546 if (size != fattr->size)
1548 /* Set attribute barrier */
1549 nfs_fattr_set_barrier(fattr);
1550 /* ...and update size */
1551 fattr->valid |= NFS_ATTR_FATTR_SIZE;
1554 void nfs_writeback_update_inode(struct nfs_pgio_header *hdr)
1556 struct nfs_fattr *fattr = &hdr->fattr;
1557 struct inode *inode = hdr->inode;
1559 spin_lock(&inode->i_lock);
1560 nfs_writeback_check_extend(hdr, fattr);
1561 nfs_post_op_update_inode_force_wcc_locked(inode, fattr);
1562 spin_unlock(&inode->i_lock);
1564 EXPORT_SYMBOL_GPL(nfs_writeback_update_inode);
1567 * This function is called when the WRITE call is complete.
1569 static int nfs_writeback_done(struct rpc_task *task,
1570 struct nfs_pgio_header *hdr,
1571 struct inode *inode)
1576 * ->write_done will attempt to use post-op attributes to detect
1577 * conflicting writes by other clients. A strict interpretation
1578 * of close-to-open would allow us to continue caching even if
1579 * another writer had changed the file, but some applications
1580 * depend on tighter cache coherency when writing.
1582 status = NFS_PROTO(inode)->write_done(task, hdr);
1586 nfs_add_stats(inode, NFSIOS_SERVERWRITTENBYTES, hdr->res.count);
1587 trace_nfs_writeback_done(task, hdr);
1589 if (hdr->res.verf->committed < hdr->args.stable &&
1590 task->tk_status >= 0) {
1591 /* We tried a write call, but the server did not
1592 * commit data to stable storage even though we
1594 * Note: There is a known bug in Tru64 < 5.0 in which
1595 * the server reports NFS_DATA_SYNC, but performs
1596 * NFS_FILE_SYNC. We therefore implement this checking
1597 * as a dprintk() in order to avoid filling syslog.
1599 static unsigned long complain;
1601 /* Note this will print the MDS for a DS write */
1602 if (time_before(complain, jiffies)) {
1603 dprintk("NFS: faulty NFS server %s:"
1604 " (committed = %d) != (stable = %d)\n",
1605 NFS_SERVER(inode)->nfs_client->cl_hostname,
1606 hdr->res.verf->committed, hdr->args.stable);
1607 complain = jiffies + 300 * HZ;
1611 /* Deal with the suid/sgid bit corner case */
1612 if (nfs_should_remove_suid(inode)) {
1613 spin_lock(&inode->i_lock);
1614 nfs_set_cache_invalid(inode, NFS_INO_INVALID_MODE);
1615 spin_unlock(&inode->i_lock);
1621 * This function is called when the WRITE call is complete.
1623 static void nfs_writeback_result(struct rpc_task *task,
1624 struct nfs_pgio_header *hdr)
1626 struct nfs_pgio_args *argp = &hdr->args;
1627 struct nfs_pgio_res *resp = &hdr->res;
1629 if (resp->count < argp->count) {
1630 static unsigned long complain;
1632 /* This a short write! */
1633 nfs_inc_stats(hdr->inode, NFSIOS_SHORTWRITE);
1635 /* Has the server at least made some progress? */
1636 if (resp->count == 0) {
1637 if (time_before(complain, jiffies)) {
1639 "NFS: Server wrote zero bytes, expected %u.\n",
1641 complain = jiffies + 300 * HZ;
1643 nfs_set_pgio_error(hdr, -EIO, argp->offset);
1644 task->tk_status = -EIO;
1648 /* For non rpc-based layout drivers, retry-through-MDS */
1649 if (!task->tk_ops) {
1650 hdr->pnfs_error = -EAGAIN;
1654 /* Was this an NFSv2 write or an NFSv3 stable write? */
1655 if (resp->verf->committed != NFS_UNSTABLE) {
1656 /* Resend from where the server left off */
1657 hdr->mds_offset += resp->count;
1658 argp->offset += resp->count;
1659 argp->pgbase += resp->count;
1660 argp->count -= resp->count;
1662 /* Resend as a stable write in order to avoid
1663 * headaches in the case of a server crash.
1665 argp->stable = NFS_FILE_SYNC;
1668 resp->verf->committed = 0;
1669 rpc_restart_call_prepare(task);
1673 static int wait_on_commit(struct nfs_mds_commit_info *cinfo)
1675 return wait_var_event_killable(&cinfo->rpcs_out,
1676 !atomic_read(&cinfo->rpcs_out));
1679 static void nfs_commit_begin(struct nfs_mds_commit_info *cinfo)
1681 atomic_inc(&cinfo->rpcs_out);
1684 bool nfs_commit_end(struct nfs_mds_commit_info *cinfo)
1686 if (atomic_dec_and_test(&cinfo->rpcs_out)) {
1687 wake_up_var(&cinfo->rpcs_out);
1693 void nfs_commitdata_release(struct nfs_commit_data *data)
1695 put_nfs_open_context(data->context);
1696 nfs_commit_free(data);
1698 EXPORT_SYMBOL_GPL(nfs_commitdata_release);
1700 int nfs_initiate_commit(struct rpc_clnt *clnt, struct nfs_commit_data *data,
1701 const struct nfs_rpc_ops *nfs_ops,
1702 const struct rpc_call_ops *call_ops,
1705 struct rpc_task *task;
1706 int priority = flush_task_priority(how);
1707 struct rpc_message msg = {
1708 .rpc_argp = &data->args,
1709 .rpc_resp = &data->res,
1710 .rpc_cred = data->cred,
1712 struct rpc_task_setup task_setup_data = {
1713 .task = &data->task,
1715 .rpc_message = &msg,
1716 .callback_ops = call_ops,
1717 .callback_data = data,
1718 .workqueue = nfsiod_workqueue,
1719 .flags = RPC_TASK_ASYNC | flags,
1720 .priority = priority,
1722 /* Set up the initial task struct. */
1723 nfs_ops->commit_setup(data, &msg, &task_setup_data.rpc_client);
1724 trace_nfs_initiate_commit(data);
1726 dprintk("NFS: initiated commit call\n");
1728 task = rpc_run_task(&task_setup_data);
1730 return PTR_ERR(task);
1731 if (how & FLUSH_SYNC)
1732 rpc_wait_for_completion_task(task);
1736 EXPORT_SYMBOL_GPL(nfs_initiate_commit);
1738 static loff_t nfs_get_lwb(struct list_head *head)
1741 struct nfs_page *req;
1743 list_for_each_entry(req, head, wb_list)
1744 if (lwb < (req_offset(req) + req->wb_bytes))
1745 lwb = req_offset(req) + req->wb_bytes;
1751 * Set up the argument/result storage required for the RPC call.
1753 void nfs_init_commit(struct nfs_commit_data *data,
1754 struct list_head *head,
1755 struct pnfs_layout_segment *lseg,
1756 struct nfs_commit_info *cinfo)
1758 struct nfs_page *first;
1759 struct nfs_open_context *ctx;
1760 struct inode *inode;
1762 /* Set up the RPC argument and reply structs
1763 * NB: take care not to mess about with data->commit et al. */
1766 list_splice_init(head, &data->pages);
1768 first = nfs_list_entry(data->pages.next);
1769 ctx = nfs_req_openctx(first);
1770 inode = d_inode(ctx->dentry);
1772 data->inode = inode;
1773 data->cred = ctx->cred;
1774 data->lseg = lseg; /* reference transferred */
1775 /* only set lwb for pnfs commit */
1777 data->lwb = nfs_get_lwb(&data->pages);
1778 data->mds_ops = &nfs_commit_ops;
1779 data->completion_ops = cinfo->completion_ops;
1780 data->dreq = cinfo->dreq;
1782 data->args.fh = NFS_FH(data->inode);
1783 /* Note: we always request a commit of the entire inode */
1784 data->args.offset = 0;
1785 data->args.count = 0;
1786 data->context = get_nfs_open_context(ctx);
1787 data->res.fattr = &data->fattr;
1788 data->res.verf = &data->verf;
1789 nfs_fattr_init(&data->fattr);
1790 nfs_commit_begin(cinfo->mds);
1792 EXPORT_SYMBOL_GPL(nfs_init_commit);
1794 void nfs_retry_commit(struct list_head *page_list,
1795 struct pnfs_layout_segment *lseg,
1796 struct nfs_commit_info *cinfo,
1799 struct nfs_page *req;
1801 while (!list_empty(page_list)) {
1802 req = nfs_list_entry(page_list->next);
1803 nfs_list_remove_request(req);
1804 nfs_mark_request_commit(req, lseg, cinfo, ds_commit_idx);
1806 nfs_clear_page_commit(req->wb_page);
1807 nfs_unlock_and_release_request(req);
1810 EXPORT_SYMBOL_GPL(nfs_retry_commit);
1813 nfs_commit_resched_write(struct nfs_commit_info *cinfo,
1814 struct nfs_page *req)
1816 __set_page_dirty_nobuffers(req->wb_page);
1820 * Commit dirty pages
1823 nfs_commit_list(struct inode *inode, struct list_head *head, int how,
1824 struct nfs_commit_info *cinfo)
1826 struct nfs_commit_data *data;
1827 unsigned short task_flags = 0;
1829 /* another commit raced with us */
1830 if (list_empty(head))
1833 data = nfs_commitdata_alloc();
1835 nfs_retry_commit(head, NULL, cinfo, -1);
1839 /* Set up the argument struct */
1840 nfs_init_commit(data, head, NULL, cinfo);
1841 if (NFS_SERVER(inode)->nfs_client->cl_minorversion)
1842 task_flags = RPC_TASK_MOVEABLE;
1843 return nfs_initiate_commit(NFS_CLIENT(inode), data, NFS_PROTO(inode),
1845 RPC_TASK_CRED_NOREF | task_flags);
1849 * COMMIT call returned
1851 static void nfs_commit_done(struct rpc_task *task, void *calldata)
1853 struct nfs_commit_data *data = calldata;
1855 /* Call the NFS version-specific code */
1856 NFS_PROTO(data->inode)->commit_done(task, data);
1857 trace_nfs_commit_done(task, data);
1860 static void nfs_commit_release_pages(struct nfs_commit_data *data)
1862 const struct nfs_writeverf *verf = data->res.verf;
1863 struct nfs_page *req;
1864 int status = data->task.tk_status;
1865 struct nfs_commit_info cinfo;
1866 struct nfs_server *nfss;
1868 while (!list_empty(&data->pages)) {
1869 req = nfs_list_entry(data->pages.next);
1870 nfs_list_remove_request(req);
1872 nfs_clear_page_commit(req->wb_page);
1874 dprintk("NFS: commit (%s/%llu %d@%lld)",
1875 nfs_req_openctx(req)->dentry->d_sb->s_id,
1876 (unsigned long long)NFS_FILEID(d_inode(nfs_req_openctx(req)->dentry)),
1878 (long long)req_offset(req));
1881 trace_nfs_commit_error(req, status);
1882 nfs_mapping_set_error(req->wb_page, status);
1883 nfs_inode_remove_request(req);
1885 dprintk_cont(", error = %d\n", status);
1889 /* Okay, COMMIT succeeded, apparently. Check the verifier
1890 * returned by the server against all stored verfs. */
1891 if (nfs_write_match_verf(verf, req)) {
1892 /* We have a match */
1894 nfs_inode_remove_request(req);
1895 dprintk_cont(" OK\n");
1898 /* We have a mismatch. Write the page again */
1899 dprintk_cont(" mismatch\n");
1900 nfs_mark_request_dirty(req);
1901 set_bit(NFS_CONTEXT_RESEND_WRITES, &nfs_req_openctx(req)->flags);
1903 nfs_unlock_and_release_request(req);
1904 /* Latency breaker */
1907 nfss = NFS_SERVER(data->inode);
1908 if (atomic_long_read(&nfss->writeback) < NFS_CONGESTION_OFF_THRESH)
1909 nfss->write_congested = 0;
1911 nfs_init_cinfo(&cinfo, data->inode, data->dreq);
1912 nfs_commit_end(cinfo.mds);
1915 static void nfs_commit_release(void *calldata)
1917 struct nfs_commit_data *data = calldata;
1919 data->completion_ops->completion(data);
1920 nfs_commitdata_release(calldata);
1923 static const struct rpc_call_ops nfs_commit_ops = {
1924 .rpc_call_prepare = nfs_commit_prepare,
1925 .rpc_call_done = nfs_commit_done,
1926 .rpc_release = nfs_commit_release,
1929 static const struct nfs_commit_completion_ops nfs_commit_completion_ops = {
1930 .completion = nfs_commit_release_pages,
1931 .resched_write = nfs_commit_resched_write,
1934 int nfs_generic_commit_list(struct inode *inode, struct list_head *head,
1935 int how, struct nfs_commit_info *cinfo)
1939 status = pnfs_commit_list(inode, head, how, cinfo);
1940 if (status == PNFS_NOT_ATTEMPTED)
1941 status = nfs_commit_list(inode, head, how, cinfo);
1945 static int __nfs_commit_inode(struct inode *inode, int how,
1946 struct writeback_control *wbc)
1949 struct nfs_commit_info cinfo;
1950 int may_wait = how & FLUSH_SYNC;
1954 nfs_init_cinfo_from_inode(&cinfo, inode);
1955 nfs_commit_begin(cinfo.mds);
1957 ret = nscan = nfs_scan_commit(inode, &head, &cinfo);
1960 ret = nfs_generic_commit_list(inode, &head, how, &cinfo);
1964 if (wbc && wbc->sync_mode == WB_SYNC_NONE) {
1965 if (nscan < wbc->nr_to_write)
1966 wbc->nr_to_write -= nscan;
1968 wbc->nr_to_write = 0;
1970 if (nscan < INT_MAX)
1974 nfs_commit_end(cinfo.mds);
1975 if (ret || !may_wait)
1977 return wait_on_commit(cinfo.mds);
1980 int nfs_commit_inode(struct inode *inode, int how)
1982 return __nfs_commit_inode(inode, how, NULL);
1984 EXPORT_SYMBOL_GPL(nfs_commit_inode);
1986 int nfs_write_inode(struct inode *inode, struct writeback_control *wbc)
1988 struct nfs_inode *nfsi = NFS_I(inode);
1989 int flags = FLUSH_SYNC;
1992 if (wbc->sync_mode == WB_SYNC_NONE) {
1993 /* no commits means nothing needs to be done */
1994 if (!atomic_long_read(&nfsi->commit_info.ncommit))
1995 goto check_requests_outstanding;
1997 /* Don't commit yet if this is a non-blocking flush and there
1998 * are a lot of outstanding writes for this mapping.
2000 if (mapping_tagged(inode->i_mapping, PAGECACHE_TAG_WRITEBACK))
2001 goto out_mark_dirty;
2003 /* don't wait for the COMMIT response */
2007 ret = __nfs_commit_inode(inode, flags, wbc);
2009 if (flags & FLUSH_SYNC)
2011 } else if (atomic_long_read(&nfsi->commit_info.ncommit))
2012 goto out_mark_dirty;
2014 check_requests_outstanding:
2015 if (!atomic_read(&nfsi->commit_info.rpcs_out))
2018 __mark_inode_dirty(inode, I_DIRTY_DATASYNC);
2021 EXPORT_SYMBOL_GPL(nfs_write_inode);
2024 * Wrapper for filemap_write_and_wait_range()
2026 * Needed for pNFS in order to ensure data becomes visible to the
2029 int nfs_filemap_write_and_wait_range(struct address_space *mapping,
2030 loff_t lstart, loff_t lend)
2034 ret = filemap_write_and_wait_range(mapping, lstart, lend);
2036 ret = pnfs_sync_inode(mapping->host, true);
2039 EXPORT_SYMBOL_GPL(nfs_filemap_write_and_wait_range);
2042 * flush the inode to disk.
2044 int nfs_wb_all(struct inode *inode)
2048 trace_nfs_writeback_inode_enter(inode);
2050 ret = filemap_write_and_wait(inode->i_mapping);
2053 ret = nfs_commit_inode(inode, FLUSH_SYNC);
2056 pnfs_sync_inode(inode, true);
2060 trace_nfs_writeback_inode_exit(inode, ret);
2063 EXPORT_SYMBOL_GPL(nfs_wb_all);
2065 int nfs_wb_folio_cancel(struct inode *inode, struct folio *folio)
2067 struct nfs_page *req;
2070 folio_wait_writeback(folio);
2072 /* blocking call to cancel all requests and join to a single (head)
2074 req = nfs_lock_and_join_requests(&folio->page);
2079 /* all requests from this folio have been cancelled by
2080 * nfs_lock_and_join_requests, so just remove the head
2081 * request from the inode / page_private pointer and
2083 nfs_inode_remove_request(req);
2084 nfs_unlock_and_release_request(req);
2091 * Write back all requests on one page - we do this before reading it.
2093 int nfs_wb_page(struct inode *inode, struct page *page)
2095 loff_t range_start = page_file_offset(page);
2096 loff_t range_end = range_start + (loff_t)(PAGE_SIZE - 1);
2097 struct writeback_control wbc = {
2098 .sync_mode = WB_SYNC_ALL,
2100 .range_start = range_start,
2101 .range_end = range_end,
2105 trace_nfs_writeback_page_enter(inode);
2108 wait_on_page_writeback(page);
2109 if (clear_page_dirty_for_io(page)) {
2110 ret = nfs_writepage_locked(page, &wbc);
2116 if (!PagePrivate(page))
2118 ret = nfs_commit_inode(inode, FLUSH_SYNC);
2123 trace_nfs_writeback_page_exit(inode, ret);
2127 #ifdef CONFIG_MIGRATION
2128 int nfs_migrate_page(struct address_space *mapping, struct page *newpage,
2129 struct page *page, enum migrate_mode mode)
2132 * If PagePrivate is set, then the page is currently associated with
2133 * an in-progress read or write request. Don't try to migrate it.
2135 * FIXME: we could do this in principle, but we'll need a way to ensure
2136 * that we can safely release the inode reference while holding
2139 if (PagePrivate(page))
2142 if (PageFsCache(page)) {
2143 if (mode == MIGRATE_ASYNC)
2145 wait_on_page_fscache(page);
2148 return migrate_page(mapping, newpage, page, mode);
2152 int __init nfs_init_writepagecache(void)
2154 nfs_wdata_cachep = kmem_cache_create("nfs_write_data",
2155 sizeof(struct nfs_pgio_header),
2156 0, SLAB_HWCACHE_ALIGN,
2158 if (nfs_wdata_cachep == NULL)
2161 nfs_wdata_mempool = mempool_create_slab_pool(MIN_POOL_WRITE,
2163 if (nfs_wdata_mempool == NULL)
2164 goto out_destroy_write_cache;
2166 nfs_cdata_cachep = kmem_cache_create("nfs_commit_data",
2167 sizeof(struct nfs_commit_data),
2168 0, SLAB_HWCACHE_ALIGN,
2170 if (nfs_cdata_cachep == NULL)
2171 goto out_destroy_write_mempool;
2173 nfs_commit_mempool = mempool_create_slab_pool(MIN_POOL_COMMIT,
2175 if (nfs_commit_mempool == NULL)
2176 goto out_destroy_commit_cache;
2179 * NFS congestion size, scale with available memory.
2191 * This allows larger machines to have larger/more transfers.
2192 * Limit the default to 256M
2194 nfs_congestion_kb = (16*int_sqrt(totalram_pages())) << (PAGE_SHIFT-10);
2195 if (nfs_congestion_kb > 256*1024)
2196 nfs_congestion_kb = 256*1024;
2200 out_destroy_commit_cache:
2201 kmem_cache_destroy(nfs_cdata_cachep);
2202 out_destroy_write_mempool:
2203 mempool_destroy(nfs_wdata_mempool);
2204 out_destroy_write_cache:
2205 kmem_cache_destroy(nfs_wdata_cachep);
2209 void nfs_destroy_writepagecache(void)
2211 mempool_destroy(nfs_commit_mempool);
2212 kmem_cache_destroy(nfs_cdata_cachep);
2213 mempool_destroy(nfs_wdata_mempool);
2214 kmem_cache_destroy(nfs_wdata_cachep);
2217 static const struct nfs_rw_ops nfs_rw_write_ops = {
2218 .rw_alloc_header = nfs_writehdr_alloc,
2219 .rw_free_header = nfs_writehdr_free,
2220 .rw_done = nfs_writeback_done,
2221 .rw_result = nfs_writeback_result,
2222 .rw_initiate = nfs_initiate_write,