1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 1992 Rick Sladkey
7 * Changes Copyright (C) 1994 by Florian La Roche
8 * - Do not copy data too often around in the kernel.
9 * - In nfs_file_read the return value of kmalloc wasn't checked.
10 * - Put in a better version of read look-ahead buffering. Original idea
11 * and implementation by Wai S Kok elekokws@ee.nus.sg.
13 * Expire cache on write to a file by Wai S Kok (Oct 1994).
15 * Total rewrite of read side for new NFS buffer cache.. Linus.
17 * nfs regular file handling functions
20 #include <linux/module.h>
21 #include <linux/time.h>
22 #include <linux/kernel.h>
23 #include <linux/errno.h>
24 #include <linux/fcntl.h>
25 #include <linux/stat.h>
26 #include <linux/nfs_fs.h>
27 #include <linux/nfs_mount.h>
29 #include <linux/pagemap.h>
30 #include <linux/gfp.h>
31 #include <linux/swap.h>
33 #include <linux/uaccess.h>
35 #include "delegation.h"
43 #define NFSDBG_FACILITY NFSDBG_FILE
45 static const struct vm_operations_struct nfs_file_vm_ops;
47 /* Hack for future NFS swap support */
49 # define IS_SWAPFILE(inode) (0)
52 int nfs_check_flags(int flags)
54 if ((flags & (O_APPEND | O_DIRECT)) == (O_APPEND | O_DIRECT))
59 EXPORT_SYMBOL_GPL(nfs_check_flags);
65 nfs_file_open(struct inode *inode, struct file *filp)
69 dprintk("NFS: open file(%pD2)\n", filp);
71 nfs_inc_stats(inode, NFSIOS_VFSOPEN);
72 res = nfs_check_flags(filp->f_flags);
76 res = nfs_open(inode, filp);
81 nfs_file_release(struct inode *inode, struct file *filp)
83 dprintk("NFS: release(%pD2)\n", filp);
85 nfs_inc_stats(inode, NFSIOS_VFSRELEASE);
86 nfs_file_clear_open_context(filp);
89 EXPORT_SYMBOL_GPL(nfs_file_release);
92 * nfs_revalidate_file_size - Revalidate the file size
93 * @inode: pointer to inode struct
94 * @filp: pointer to struct file
96 * Revalidates the file length. This is basically a wrapper around
97 * nfs_revalidate_inode() that takes into account the fact that we may
98 * have cached writes (in which case we don't care about the server's
99 * idea of what the file length is), or O_DIRECT (in which case we
100 * shouldn't trust the cache).
102 static int nfs_revalidate_file_size(struct inode *inode, struct file *filp)
104 struct nfs_server *server = NFS_SERVER(inode);
106 if (filp->f_flags & O_DIRECT)
108 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_SIZE))
112 return __nfs_revalidate_inode(server, inode);
115 loff_t nfs_file_llseek(struct file *filp, loff_t offset, int whence)
117 dprintk("NFS: llseek file(%pD2, %lld, %d)\n",
118 filp, offset, whence);
121 * whence == SEEK_END || SEEK_DATA || SEEK_HOLE => we must revalidate
122 * the cached file length
124 if (whence != SEEK_SET && whence != SEEK_CUR) {
125 struct inode *inode = filp->f_mapping->host;
127 int retval = nfs_revalidate_file_size(inode, filp);
129 return (loff_t)retval;
132 return generic_file_llseek(filp, offset, whence);
134 EXPORT_SYMBOL_GPL(nfs_file_llseek);
137 * Flush all dirty pages, and check for write errors.
140 nfs_file_flush(struct file *file, fl_owner_t id)
142 struct inode *inode = file_inode(file);
145 dprintk("NFS: flush(%pD2)\n", file);
147 nfs_inc_stats(inode, NFSIOS_VFSFLUSH);
148 if ((file->f_mode & FMODE_WRITE) == 0)
151 /* Flush writes to the server and return any errors */
152 since = filemap_sample_wb_err(file->f_mapping);
154 return filemap_check_wb_err(file->f_mapping, since);
158 nfs_file_read(struct kiocb *iocb, struct iov_iter *to)
160 struct inode *inode = file_inode(iocb->ki_filp);
163 if (iocb->ki_flags & IOCB_DIRECT)
164 return nfs_file_direct_read(iocb, to, false);
166 dprintk("NFS: read(%pD2, %zu@%lu)\n",
168 iov_iter_count(to), (unsigned long) iocb->ki_pos);
170 nfs_start_io_read(inode);
171 result = nfs_revalidate_mapping(inode, iocb->ki_filp->f_mapping);
173 result = generic_file_read_iter(iocb, to);
175 nfs_add_stats(inode, NFSIOS_NORMALREADBYTES, result);
177 nfs_end_io_read(inode);
180 EXPORT_SYMBOL_GPL(nfs_file_read);
183 nfs_file_mmap(struct file * file, struct vm_area_struct * vma)
185 struct inode *inode = file_inode(file);
188 dprintk("NFS: mmap(%pD2)\n", file);
190 /* Note: generic_file_mmap() returns ENOSYS on nommu systems
191 * so we call that before revalidating the mapping
193 status = generic_file_mmap(file, vma);
195 vma->vm_ops = &nfs_file_vm_ops;
196 status = nfs_revalidate_mapping(inode, file->f_mapping);
200 EXPORT_SYMBOL_GPL(nfs_file_mmap);
203 * Flush any dirty pages for this process, and check for write errors.
204 * The return status from this call provides a reliable indication of
205 * whether any write errors occurred for this process.
208 nfs_file_fsync_commit(struct file *file, int datasync)
210 struct inode *inode = file_inode(file);
213 dprintk("NFS: fsync file(%pD2) datasync %d\n", file, datasync);
215 nfs_inc_stats(inode, NFSIOS_VFSFSYNC);
216 ret = nfs_commit_inode(inode, FLUSH_SYNC);
217 ret2 = file_check_and_advance_wb_err(file);
224 nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync)
226 struct inode *inode = file_inode(file);
227 struct nfs_inode *nfsi = NFS_I(inode);
228 long save_nredirtied = atomic_long_read(&nfsi->redirtied_pages);
232 trace_nfs_fsync_enter(inode);
235 ret = file_write_and_wait_range(file, start, end);
238 ret = nfs_file_fsync_commit(file, datasync);
241 ret = pnfs_sync_inode(inode, !!datasync);
244 nredirtied = atomic_long_read(&nfsi->redirtied_pages);
245 if (nredirtied == save_nredirtied)
247 save_nredirtied = nredirtied;
250 trace_nfs_fsync_exit(inode, ret);
253 EXPORT_SYMBOL_GPL(nfs_file_fsync);
256 * Decide whether a read/modify/write cycle may be more efficient
257 * then a modify/write/read cycle when writing to a page in the
260 * Some pNFS layout drivers can only read/write at a certain block
261 * granularity like all block devices and therefore we must perform
262 * read/modify/write whenever a page hasn't read yet and the data
263 * to be written there is not aligned to a block boundary and/or
264 * smaller than the block size.
266 * The modify/write/read cycle may occur if a page is read before
267 * being completely filled by the writer. In this situation, the
268 * page must be completely written to stable storage on the server
269 * before it can be refilled by reading in the page from the server.
270 * This can lead to expensive, small, FILE_SYNC mode writes being
273 * It may be more efficient to read the page first if the file is
274 * open for reading in addition to writing, the page is not marked
275 * as Uptodate, it is not dirty or waiting to be committed,
276 * indicating that it was previously allocated and then modified,
277 * that there were valid bytes of data in that range of the file,
278 * and that the new data won't completely replace the old data in
279 * that range of the file.
281 static bool nfs_full_page_write(struct page *page, loff_t pos, unsigned int len)
283 unsigned int pglen = nfs_page_length(page);
284 unsigned int offset = pos & (PAGE_SIZE - 1);
285 unsigned int end = offset + len;
287 return !pglen || (end >= pglen && !offset);
290 static bool nfs_want_read_modify_write(struct file *file, struct page *page,
291 loff_t pos, unsigned int len)
294 * Up-to-date pages, those with ongoing or full-page write
295 * don't need read/modify/write
297 if (PageUptodate(page) || PagePrivate(page) ||
298 nfs_full_page_write(page, pos, len))
301 if (pnfs_ld_read_whole_page(file->f_mapping->host))
303 /* Open for reading too? */
304 if (file->f_mode & FMODE_READ)
310 * This does the "real" work of the write. We must allocate and lock the
311 * page to be sent back to the generic routine, which then copies the
312 * data from user space.
314 * If the writer ends up delaying the write, the writer needs to
315 * increment the page use counts until he is done with the page.
317 static int nfs_write_begin(struct file *file, struct address_space *mapping,
318 loff_t pos, unsigned len, unsigned flags,
319 struct page **pagep, void **fsdata)
322 pgoff_t index = pos >> PAGE_SHIFT;
326 dfprintk(PAGECACHE, "NFS: write_begin(%pD2(%lu), %u@%lld)\n",
327 file, mapping->host->i_ino, len, (long long) pos);
330 page = grab_cache_page_write_begin(mapping, index, flags);
335 ret = nfs_flush_incompatible(file, page);
339 } else if (!once_thru &&
340 nfs_want_read_modify_write(file, page, pos, len)) {
342 ret = nfs_readpage(file, page);
350 static int nfs_write_end(struct file *file, struct address_space *mapping,
351 loff_t pos, unsigned len, unsigned copied,
352 struct page *page, void *fsdata)
354 unsigned offset = pos & (PAGE_SIZE - 1);
355 struct nfs_open_context *ctx = nfs_file_open_context(file);
358 dfprintk(PAGECACHE, "NFS: write_end(%pD2(%lu), %u@%lld)\n",
359 file, mapping->host->i_ino, len, (long long) pos);
362 * Zero any uninitialised parts of the page, and then mark the page
363 * as up to date if it turns out that we're extending the file.
365 if (!PageUptodate(page)) {
366 unsigned pglen = nfs_page_length(page);
367 unsigned end = offset + copied;
370 zero_user_segments(page, 0, offset,
372 SetPageUptodate(page);
373 } else if (end >= pglen) {
374 zero_user_segment(page, end, PAGE_SIZE);
376 SetPageUptodate(page);
378 zero_user_segment(page, pglen, PAGE_SIZE);
381 status = nfs_updatepage(file, page, offset, copied);
388 NFS_I(mapping->host)->write_io += copied;
390 if (nfs_ctx_key_to_expire(ctx, mapping->host))
391 nfs_wb_all(mapping->host);
397 * Partially or wholly invalidate a page
398 * - Release the private state associated with a page if undergoing complete
400 * - Called if either PG_private or PG_fscache is set on the page
401 * - Caller holds page lock
403 static void nfs_invalidate_page(struct page *page, unsigned int offset,
406 dfprintk(PAGECACHE, "NFS: invalidate_page(%p, %u, %u)\n",
407 page, offset, length);
409 if (offset != 0 || length < PAGE_SIZE)
411 /* Cancel any unstarted writes on this page */
412 nfs_wb_page_cancel(page_file_mapping(page)->host, page);
414 nfs_fscache_invalidate_page(page, page->mapping->host);
418 * Attempt to release the private state associated with a page
419 * - Called if either PG_private or PG_fscache is set on the page
420 * - Caller holds page lock
421 * - Return true (may release page) or false (may not)
423 static int nfs_release_page(struct page *page, gfp_t gfp)
425 dfprintk(PAGECACHE, "NFS: release_page(%p)\n", page);
427 /* If PagePrivate() is set, then the page is not freeable */
428 if (PagePrivate(page))
430 return nfs_fscache_release_page(page, gfp);
433 static void nfs_check_dirty_writeback(struct page *page,
434 bool *dirty, bool *writeback)
436 struct nfs_inode *nfsi;
437 struct address_space *mapping = page_file_mapping(page);
439 if (!mapping || PageSwapCache(page))
443 * Check if an unstable page is currently being committed and
444 * if so, have the VM treat it as if the page is under writeback
445 * so it will not block due to pages that will shortly be freeable.
447 nfsi = NFS_I(mapping->host);
448 if (atomic_read(&nfsi->commit_info.rpcs_out)) {
454 * If PagePrivate() is set, then the page is not freeable and as the
455 * inode is not being committed, it's not going to be cleaned in the
456 * near future so treat it as dirty
458 if (PagePrivate(page))
463 * Attempt to clear the private state associated with a page when an error
464 * occurs that requires the cached contents of an inode to be written back or
466 * - Called if either PG_private or fscache is set on the page
467 * - Caller holds page lock
468 * - Return 0 if successful, -error otherwise
470 static int nfs_launder_page(struct page *page)
472 struct inode *inode = page_file_mapping(page)->host;
473 struct nfs_inode *nfsi = NFS_I(inode);
475 dfprintk(PAGECACHE, "NFS: launder_page(%ld, %llu)\n",
476 inode->i_ino, (long long)page_offset(page));
478 nfs_fscache_wait_on_page_write(nfsi, page);
479 return nfs_wb_page(inode, page);
482 static int nfs_swap_activate(struct swap_info_struct *sis, struct file *file,
485 unsigned long blocks;
487 struct rpc_clnt *clnt = NFS_CLIENT(file->f_mapping->host);
488 struct inode *inode = file->f_mapping->host;
490 spin_lock(&inode->i_lock);
491 blocks = inode->i_blocks;
492 isize = inode->i_size;
493 spin_unlock(&inode->i_lock);
494 if (blocks*512 < isize) {
495 pr_warn("swap activate: swapfile has holes\n");
501 return rpc_clnt_swap_activate(clnt);
504 static void nfs_swap_deactivate(struct file *file)
506 struct rpc_clnt *clnt = NFS_CLIENT(file->f_mapping->host);
508 rpc_clnt_swap_deactivate(clnt);
511 const struct address_space_operations nfs_file_aops = {
512 .readpage = nfs_readpage,
513 .readpages = nfs_readpages,
514 .set_page_dirty = __set_page_dirty_nobuffers,
515 .writepage = nfs_writepage,
516 .writepages = nfs_writepages,
517 .write_begin = nfs_write_begin,
518 .write_end = nfs_write_end,
519 .invalidatepage = nfs_invalidate_page,
520 .releasepage = nfs_release_page,
521 .direct_IO = nfs_direct_IO,
522 #ifdef CONFIG_MIGRATION
523 .migratepage = nfs_migrate_page,
525 .launder_page = nfs_launder_page,
526 .is_dirty_writeback = nfs_check_dirty_writeback,
527 .error_remove_page = generic_error_remove_page,
528 .swap_activate = nfs_swap_activate,
529 .swap_deactivate = nfs_swap_deactivate,
533 * Notification that a PTE pointing to an NFS page is about to be made
534 * writable, implying that someone is about to modify the page through a
535 * shared-writable mapping
537 static vm_fault_t nfs_vm_page_mkwrite(struct vm_fault *vmf)
539 struct page *page = vmf->page;
540 struct file *filp = vmf->vma->vm_file;
541 struct inode *inode = file_inode(filp);
543 vm_fault_t ret = VM_FAULT_NOPAGE;
544 struct address_space *mapping;
546 dfprintk(PAGECACHE, "NFS: vm_page_mkwrite(%pD2(%lu), offset %lld)\n",
547 filp, filp->f_mapping->host->i_ino,
548 (long long)page_offset(page));
550 sb_start_pagefault(inode->i_sb);
552 /* make sure the cache has finished storing the page */
553 nfs_fscache_wait_on_page_write(NFS_I(inode), page);
555 wait_on_bit_action(&NFS_I(inode)->flags, NFS_INO_INVALIDATING,
556 nfs_wait_bit_killable, TASK_KILLABLE);
559 mapping = page_file_mapping(page);
560 if (mapping != inode->i_mapping)
563 wait_on_page_writeback(page);
565 pagelen = nfs_page_length(page);
569 ret = VM_FAULT_LOCKED;
570 if (nfs_flush_incompatible(filp, page) == 0 &&
571 nfs_updatepage(filp, page, 0, pagelen) == 0)
574 ret = VM_FAULT_SIGBUS;
578 sb_end_pagefault(inode->i_sb);
582 static const struct vm_operations_struct nfs_file_vm_ops = {
583 .fault = filemap_fault,
584 .map_pages = filemap_map_pages,
585 .page_mkwrite = nfs_vm_page_mkwrite,
588 ssize_t nfs_file_write(struct kiocb *iocb, struct iov_iter *from)
590 struct file *file = iocb->ki_filp;
591 struct inode *inode = file_inode(file);
592 unsigned int mntflags = NFS_SERVER(inode)->flags;
593 ssize_t result, written;
597 result = nfs_key_timeout_notify(file, inode);
601 if (iocb->ki_flags & IOCB_DIRECT)
602 return nfs_file_direct_write(iocb, from, false);
604 dprintk("NFS: write(%pD2, %zu@%Ld)\n",
605 file, iov_iter_count(from), (long long) iocb->ki_pos);
607 if (IS_SWAPFILE(inode))
610 * O_APPEND implies that we must revalidate the file length.
612 if (iocb->ki_flags & IOCB_APPEND || iocb->ki_pos > i_size_read(inode)) {
613 result = nfs_revalidate_file_size(inode, file);
618 nfs_clear_invalid_mapping(file->f_mapping);
620 since = filemap_sample_wb_err(file->f_mapping);
621 nfs_start_io_write(inode);
622 result = generic_write_checks(iocb, from);
624 current->backing_dev_info = inode_to_bdi(inode);
625 result = generic_perform_write(file, from, iocb->ki_pos);
626 current->backing_dev_info = NULL;
628 nfs_end_io_write(inode);
633 iocb->ki_pos += written;
634 nfs_add_stats(inode, NFSIOS_NORMALWRITTENBYTES, written);
636 if (mntflags & NFS_MOUNT_WRITE_EAGER) {
637 result = filemap_fdatawrite_range(file->f_mapping,
638 iocb->ki_pos - written,
643 if (mntflags & NFS_MOUNT_WRITE_WAIT) {
644 result = filemap_fdatawait_range(file->f_mapping,
645 iocb->ki_pos - written,
650 result = generic_write_sync(iocb, written);
655 /* Return error values */
656 error = filemap_check_wb_err(file->f_mapping, since);
664 error = file_check_and_advance_wb_err(file);
671 printk(KERN_INFO "NFS: attempt to write to active swap file!\n");
674 EXPORT_SYMBOL_GPL(nfs_file_write);
677 do_getlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
679 struct inode *inode = filp->f_mapping->host;
681 unsigned int saved_type = fl->fl_type;
683 /* Try local locking first */
684 posix_test_lock(filp, fl);
685 if (fl->fl_type != F_UNLCK) {
686 /* found a conflict */
689 fl->fl_type = saved_type;
691 if (NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
697 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
701 fl->fl_type = F_UNLCK;
706 do_unlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
708 struct inode *inode = filp->f_mapping->host;
709 struct nfs_lock_context *l_ctx;
713 * Flush all pending writes before doing anything
718 l_ctx = nfs_get_lock_context(nfs_file_open_context(filp));
719 if (!IS_ERR(l_ctx)) {
720 status = nfs_iocounter_wait(l_ctx);
721 nfs_put_lock_context(l_ctx);
722 /* NOTE: special case
723 * If we're signalled while cleaning up locks on process exit, we
724 * still need to complete the unlock.
726 if (status < 0 && !(fl->fl_flags & FL_CLOSE))
731 * Use local locking if mounted with "-onolock" or with appropriate
735 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
737 status = locks_lock_file_wait(filp, fl);
742 do_setlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
744 struct inode *inode = filp->f_mapping->host;
748 * Flush all pending writes before doing anything
751 status = nfs_sync_mapping(filp->f_mapping);
756 * Use local locking if mounted with "-onolock" or with appropriate
760 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
762 status = locks_lock_file_wait(filp, fl);
767 * Invalidate cache to prevent missing any changes. If
768 * the file is mapped, clear the page cache as well so
769 * those mappings will be loaded.
771 * This makes locking act as a cache coherency point.
773 nfs_sync_mapping(filp->f_mapping);
774 if (!NFS_PROTO(inode)->have_delegation(inode, FMODE_READ)) {
775 nfs_zap_caches(inode);
776 if (mapping_mapped(filp->f_mapping))
777 nfs_revalidate_mapping(inode, filp->f_mapping);
784 * Lock a (portion of) a file
786 int nfs_lock(struct file *filp, int cmd, struct file_lock *fl)
788 struct inode *inode = filp->f_mapping->host;
792 dprintk("NFS: lock(%pD2, t=%x, fl=%x, r=%lld:%lld)\n",
793 filp, fl->fl_type, fl->fl_flags,
794 (long long)fl->fl_start, (long long)fl->fl_end);
796 nfs_inc_stats(inode, NFSIOS_VFSLOCK);
798 if (fl->fl_flags & FL_RECLAIM)
801 if (NFS_SERVER(inode)->flags & NFS_MOUNT_LOCAL_FCNTL)
804 if (NFS_PROTO(inode)->lock_check_bounds != NULL) {
805 ret = NFS_PROTO(inode)->lock_check_bounds(fl);
811 ret = do_getlk(filp, cmd, fl, is_local);
812 else if (fl->fl_type == F_UNLCK)
813 ret = do_unlk(filp, cmd, fl, is_local);
815 ret = do_setlk(filp, cmd, fl, is_local);
819 EXPORT_SYMBOL_GPL(nfs_lock);
822 * Lock a (portion of) a file
824 int nfs_flock(struct file *filp, int cmd, struct file_lock *fl)
826 struct inode *inode = filp->f_mapping->host;
829 dprintk("NFS: flock(%pD2, t=%x, fl=%x)\n",
830 filp, fl->fl_type, fl->fl_flags);
832 if (!(fl->fl_flags & FL_FLOCK))
836 * The NFSv4 protocol doesn't support LOCK_MAND, which is not part of
837 * any standard. In principle we might be able to support LOCK_MAND
838 * on NFSv2/3 since NLMv3/4 support DOS share modes, but for now the
839 * NFS code is not set up for it.
841 if (fl->fl_type & LOCK_MAND)
844 if (NFS_SERVER(inode)->flags & NFS_MOUNT_LOCAL_FLOCK)
847 /* We're simulating flock() locks using posix locks on the server */
848 if (fl->fl_type == F_UNLCK)
849 return do_unlk(filp, cmd, fl, is_local);
850 return do_setlk(filp, cmd, fl, is_local);
852 EXPORT_SYMBOL_GPL(nfs_flock);
854 const struct file_operations nfs_file_operations = {
855 .llseek = nfs_file_llseek,
856 .read_iter = nfs_file_read,
857 .write_iter = nfs_file_write,
858 .mmap = nfs_file_mmap,
859 .open = nfs_file_open,
860 .flush = nfs_file_flush,
861 .release = nfs_file_release,
862 .fsync = nfs_file_fsync,
865 .splice_read = generic_file_splice_read,
866 .splice_write = iter_file_splice_write,
867 .check_flags = nfs_check_flags,
868 .setlease = simple_nosetlease,
870 EXPORT_SYMBOL_GPL(nfs_file_operations);