4 * Copyright (C) 1992 Rick Sladkey
6 * Changes Copyright (C) 1994 by Florian La Roche
7 * - Do not copy data too often around in the kernel.
8 * - In nfs_file_read the return value of kmalloc wasn't checked.
9 * - Put in a better version of read look-ahead buffering. Original idea
12 * Expire cache on write to a file by Wai S Kok (Oct 1994).
14 * Total rewrite of read side for new NFS buffer cache.. Linus.
16 * nfs regular file handling functions
19 #include <linux/module.h>
20 #include <linux/time.h>
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
23 #include <linux/fcntl.h>
24 #include <linux/stat.h>
25 #include <linux/nfs_fs.h>
26 #include <linux/nfs_mount.h>
28 #include <linux/pagemap.h>
29 #include <linux/gfp.h>
30 #include <linux/swap.h>
32 #include <linux/uaccess.h>
34 #include "delegation.h"
42 #define NFSDBG_FACILITY NFSDBG_FILE
44 static const struct vm_operations_struct nfs_file_vm_ops;
46 /* Hack for future NFS swap support */
48 # define IS_SWAPFILE(inode) (0)
51 int nfs_check_flags(int flags)
53 if ((flags & (O_APPEND | O_DIRECT)) == (O_APPEND | O_DIRECT))
58 EXPORT_SYMBOL_GPL(nfs_check_flags);
64 nfs_file_open(struct inode *inode, struct file *filp)
68 dprintk("NFS: open file(%pD2)\n", filp);
70 nfs_inc_stats(inode, NFSIOS_VFSOPEN);
71 res = nfs_check_flags(filp->f_flags);
75 res = nfs_open(inode, filp);
80 nfs_file_release(struct inode *inode, struct file *filp)
82 dprintk("NFS: release(%pD2)\n", filp);
84 nfs_inc_stats(inode, NFSIOS_VFSRELEASE);
85 nfs_file_clear_open_context(filp);
88 EXPORT_SYMBOL_GPL(nfs_file_release);
91 * nfs_revalidate_size - Revalidate the file size
92 * @inode: pointer to inode struct
93 * @filp: pointer to struct file
95 * Revalidates the file length. This is basically a wrapper around
96 * nfs_revalidate_inode() that takes into account the fact that we may
97 * have cached writes (in which case we don't care about the server's
98 * idea of what the file length is), or O_DIRECT (in which case we
99 * shouldn't trust the cache).
101 static int nfs_revalidate_file_size(struct inode *inode, struct file *filp)
103 struct nfs_server *server = NFS_SERVER(inode);
105 if (filp->f_flags & O_DIRECT)
107 if (nfs_check_cache_invalid(inode, NFS_INO_REVAL_PAGECACHE))
111 return __nfs_revalidate_inode(server, inode);
114 loff_t nfs_file_llseek(struct file *filp, loff_t offset, int whence)
116 dprintk("NFS: llseek file(%pD2, %lld, %d)\n",
117 filp, offset, whence);
120 * whence == SEEK_END || SEEK_DATA || SEEK_HOLE => we must revalidate
121 * the cached file length
123 if (whence != SEEK_SET && whence != SEEK_CUR) {
124 struct inode *inode = filp->f_mapping->host;
126 int retval = nfs_revalidate_file_size(inode, filp);
128 return (loff_t)retval;
131 return generic_file_llseek(filp, offset, whence);
133 EXPORT_SYMBOL_GPL(nfs_file_llseek);
136 * Flush all dirty pages, and check for write errors.
139 nfs_file_flush(struct file *file, fl_owner_t id)
141 struct inode *inode = file_inode(file);
143 dprintk("NFS: flush(%pD2)\n", file);
145 nfs_inc_stats(inode, NFSIOS_VFSFLUSH);
146 if ((file->f_mode & FMODE_WRITE) == 0)
149 /* Flush writes to the server and return any errors */
150 return vfs_fsync(file, 0);
154 nfs_file_read(struct kiocb *iocb, struct iov_iter *to)
156 struct inode *inode = file_inode(iocb->ki_filp);
159 if (iocb->ki_flags & IOCB_DIRECT)
160 return nfs_file_direct_read(iocb, to);
162 dprintk("NFS: read(%pD2, %zu@%lu)\n",
164 iov_iter_count(to), (unsigned long) iocb->ki_pos);
166 nfs_start_io_read(inode);
167 result = nfs_revalidate_mapping(inode, iocb->ki_filp->f_mapping);
169 result = generic_file_read_iter(iocb, to);
171 nfs_add_stats(inode, NFSIOS_NORMALREADBYTES, result);
173 nfs_end_io_read(inode);
176 EXPORT_SYMBOL_GPL(nfs_file_read);
179 nfs_file_mmap(struct file * file, struct vm_area_struct * vma)
181 struct inode *inode = file_inode(file);
184 dprintk("NFS: mmap(%pD2)\n", file);
186 /* Note: generic_file_mmap() returns ENOSYS on nommu systems
187 * so we call that before revalidating the mapping
189 status = generic_file_mmap(file, vma);
191 vma->vm_ops = &nfs_file_vm_ops;
192 status = nfs_revalidate_mapping(inode, file->f_mapping);
196 EXPORT_SYMBOL_GPL(nfs_file_mmap);
199 * Flush any dirty pages for this process, and check for write errors.
200 * The return status from this call provides a reliable indication of
201 * whether any write errors occurred for this process.
203 * Notice that it clears the NFS_CONTEXT_ERROR_WRITE before synching to
204 * disk, but it retrieves and clears ctx->error after synching, despite
205 * the two being set at the same time in nfs_context_set_write_error().
206 * This is because the former is used to notify the _next_ call to
207 * nfs_file_write() that a write error occurred, and hence cause it to
208 * fall back to doing a synchronous write.
211 nfs_file_fsync_commit(struct file *file, int datasync)
213 struct nfs_open_context *ctx = nfs_file_open_context(file);
214 struct inode *inode = file_inode(file);
215 int do_resend, status;
218 dprintk("NFS: fsync file(%pD2) datasync %d\n", file, datasync);
220 nfs_inc_stats(inode, NFSIOS_VFSFSYNC);
221 do_resend = test_and_clear_bit(NFS_CONTEXT_RESEND_WRITES, &ctx->flags);
222 status = nfs_commit_inode(inode, FLUSH_SYNC);
223 if (test_bit(NFS_CONTEXT_ERROR_WRITE, &ctx->flags)) {
224 ret = xchg(&ctx->error, 0);
232 do_resend |= test_bit(NFS_CONTEXT_RESEND_WRITES, &ctx->flags);
240 nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync)
243 struct inode *inode = file_inode(file);
245 trace_nfs_fsync_enter(inode);
248 struct nfs_open_context *ctx = nfs_file_open_context(file);
249 ret = filemap_write_and_wait_range(inode->i_mapping, start, end);
250 if (test_and_clear_bit(NFS_CONTEXT_ERROR_WRITE, &ctx->flags)) {
251 int ret2 = xchg(&ctx->error, 0);
257 ret = nfs_file_fsync_commit(file, datasync);
259 ret = pnfs_sync_inode(inode, !!datasync);
261 * If nfs_file_fsync_commit detected a server reboot, then
262 * resend all dirty pages that might have been covered by
263 * the NFS_CONTEXT_RESEND_WRITES flag
267 } while (ret == -EAGAIN);
269 trace_nfs_fsync_exit(inode, ret);
272 EXPORT_SYMBOL_GPL(nfs_file_fsync);
275 * Decide whether a read/modify/write cycle may be more efficient
276 * then a modify/write/read cycle when writing to a page in the
279 * Some pNFS layout drivers can only read/write at a certain block
280 * granularity like all block devices and therefore we must perform
281 * read/modify/write whenever a page hasn't read yet and the data
282 * to be written there is not aligned to a block boundary and/or
283 * smaller than the block size.
285 * The modify/write/read cycle may occur if a page is read before
286 * being completely filled by the writer. In this situation, the
287 * page must be completely written to stable storage on the server
288 * before it can be refilled by reading in the page from the server.
289 * This can lead to expensive, small, FILE_SYNC mode writes being
292 * It may be more efficient to read the page first if the file is
293 * open for reading in addition to writing, the page is not marked
294 * as Uptodate, it is not dirty or waiting to be committed,
295 * indicating that it was previously allocated and then modified,
296 * that there were valid bytes of data in that range of the file,
297 * and that the new data won't completely replace the old data in
298 * that range of the file.
300 static bool nfs_full_page_write(struct page *page, loff_t pos, unsigned int len)
302 unsigned int pglen = nfs_page_length(page);
303 unsigned int offset = pos & (PAGE_SIZE - 1);
304 unsigned int end = offset + len;
306 return !pglen || (end >= pglen && !offset);
309 static bool nfs_want_read_modify_write(struct file *file, struct page *page,
310 loff_t pos, unsigned int len)
313 * Up-to-date pages, those with ongoing or full-page write
314 * don't need read/modify/write
316 if (PageUptodate(page) || PagePrivate(page) ||
317 nfs_full_page_write(page, pos, len))
320 if (pnfs_ld_read_whole_page(file->f_mapping->host))
322 /* Open for reading too? */
323 if (file->f_mode & FMODE_READ)
329 * This does the "real" work of the write. We must allocate and lock the
330 * page to be sent back to the generic routine, which then copies the
331 * data from user space.
333 * If the writer ends up delaying the write, the writer needs to
334 * increment the page use counts until he is done with the page.
336 static int nfs_write_begin(struct file *file, struct address_space *mapping,
337 loff_t pos, unsigned len, unsigned flags,
338 struct page **pagep, void **fsdata)
341 pgoff_t index = pos >> PAGE_SHIFT;
345 dfprintk(PAGECACHE, "NFS: write_begin(%pD2(%lu), %u@%lld)\n",
346 file, mapping->host->i_ino, len, (long long) pos);
349 page = grab_cache_page_write_begin(mapping, index, flags);
354 ret = nfs_flush_incompatible(file, page);
358 } else if (!once_thru &&
359 nfs_want_read_modify_write(file, page, pos, len)) {
361 ret = nfs_readpage(file, page);
369 static int nfs_write_end(struct file *file, struct address_space *mapping,
370 loff_t pos, unsigned len, unsigned copied,
371 struct page *page, void *fsdata)
373 unsigned offset = pos & (PAGE_SIZE - 1);
374 struct nfs_open_context *ctx = nfs_file_open_context(file);
377 dfprintk(PAGECACHE, "NFS: write_end(%pD2(%lu), %u@%lld)\n",
378 file, mapping->host->i_ino, len, (long long) pos);
381 * Zero any uninitialised parts of the page, and then mark the page
382 * as up to date if it turns out that we're extending the file.
384 if (!PageUptodate(page)) {
385 unsigned pglen = nfs_page_length(page);
386 unsigned end = offset + copied;
389 zero_user_segments(page, 0, offset,
391 SetPageUptodate(page);
392 } else if (end >= pglen) {
393 zero_user_segment(page, end, PAGE_SIZE);
395 SetPageUptodate(page);
397 zero_user_segment(page, pglen, PAGE_SIZE);
400 status = nfs_updatepage(file, page, offset, copied);
407 NFS_I(mapping->host)->write_io += copied;
409 if (nfs_ctx_key_to_expire(ctx, mapping->host)) {
410 status = nfs_wb_all(mapping->host);
419 * Partially or wholly invalidate a page
420 * - Release the private state associated with a page if undergoing complete
422 * - Called if either PG_private or PG_fscache is set on the page
423 * - Caller holds page lock
425 static void nfs_invalidate_page(struct page *page, unsigned int offset,
428 dfprintk(PAGECACHE, "NFS: invalidate_page(%p, %u, %u)\n",
429 page, offset, length);
431 if (offset != 0 || length < PAGE_SIZE)
433 /* Cancel any unstarted writes on this page */
434 nfs_wb_page_cancel(page_file_mapping(page)->host, page);
436 nfs_fscache_invalidate_page(page, page->mapping->host);
440 * Attempt to release the private state associated with a page
441 * - Called if either PG_private or PG_fscache is set on the page
442 * - Caller holds page lock
443 * - Return true (may release page) or false (may not)
445 static int nfs_release_page(struct page *page, gfp_t gfp)
447 dfprintk(PAGECACHE, "NFS: release_page(%p)\n", page);
449 /* If PagePrivate() is set, then the page is not freeable */
450 if (PagePrivate(page))
452 return nfs_fscache_release_page(page, gfp);
455 static void nfs_check_dirty_writeback(struct page *page,
456 bool *dirty, bool *writeback)
458 struct nfs_inode *nfsi;
459 struct address_space *mapping = page_file_mapping(page);
461 if (!mapping || PageSwapCache(page))
465 * Check if an unstable page is currently being committed and
466 * if so, have the VM treat it as if the page is under writeback
467 * so it will not block due to pages that will shortly be freeable.
469 nfsi = NFS_I(mapping->host);
470 if (atomic_read(&nfsi->commit_info.rpcs_out)) {
476 * If PagePrivate() is set, then the page is not freeable and as the
477 * inode is not being committed, it's not going to be cleaned in the
478 * near future so treat it as dirty
480 if (PagePrivate(page))
485 * Attempt to clear the private state associated with a page when an error
486 * occurs that requires the cached contents of an inode to be written back or
488 * - Called if either PG_private or fscache is set on the page
489 * - Caller holds page lock
490 * - Return 0 if successful, -error otherwise
492 static int nfs_launder_page(struct page *page)
494 struct inode *inode = page_file_mapping(page)->host;
495 struct nfs_inode *nfsi = NFS_I(inode);
497 dfprintk(PAGECACHE, "NFS: launder_page(%ld, %llu)\n",
498 inode->i_ino, (long long)page_offset(page));
500 nfs_fscache_wait_on_page_write(nfsi, page);
501 return nfs_wb_page(inode, page);
504 static int nfs_swap_activate(struct swap_info_struct *sis, struct file *file,
507 struct rpc_clnt *clnt = NFS_CLIENT(file->f_mapping->host);
511 return rpc_clnt_swap_activate(clnt);
514 static void nfs_swap_deactivate(struct file *file)
516 struct rpc_clnt *clnt = NFS_CLIENT(file->f_mapping->host);
518 rpc_clnt_swap_deactivate(clnt);
521 const struct address_space_operations nfs_file_aops = {
522 .readpage = nfs_readpage,
523 .readpages = nfs_readpages,
524 .set_page_dirty = __set_page_dirty_nobuffers,
525 .writepage = nfs_writepage,
526 .writepages = nfs_writepages,
527 .write_begin = nfs_write_begin,
528 .write_end = nfs_write_end,
529 .invalidatepage = nfs_invalidate_page,
530 .releasepage = nfs_release_page,
531 .direct_IO = nfs_direct_IO,
532 #ifdef CONFIG_MIGRATION
533 .migratepage = nfs_migrate_page,
535 .launder_page = nfs_launder_page,
536 .is_dirty_writeback = nfs_check_dirty_writeback,
537 .error_remove_page = generic_error_remove_page,
538 .swap_activate = nfs_swap_activate,
539 .swap_deactivate = nfs_swap_deactivate,
543 * Notification that a PTE pointing to an NFS page is about to be made
544 * writable, implying that someone is about to modify the page through a
545 * shared-writable mapping
547 static vm_fault_t nfs_vm_page_mkwrite(struct vm_fault *vmf)
549 struct page *page = vmf->page;
550 struct file *filp = vmf->vma->vm_file;
551 struct inode *inode = file_inode(filp);
553 vm_fault_t ret = VM_FAULT_NOPAGE;
554 struct address_space *mapping;
556 dfprintk(PAGECACHE, "NFS: vm_page_mkwrite(%pD2(%lu), offset %lld)\n",
557 filp, filp->f_mapping->host->i_ino,
558 (long long)page_offset(page));
560 sb_start_pagefault(inode->i_sb);
562 /* make sure the cache has finished storing the page */
563 nfs_fscache_wait_on_page_write(NFS_I(inode), page);
565 wait_on_bit_action(&NFS_I(inode)->flags, NFS_INO_INVALIDATING,
566 nfs_wait_bit_killable, TASK_KILLABLE);
569 mapping = page_file_mapping(page);
570 if (mapping != inode->i_mapping)
573 wait_on_page_writeback(page);
575 pagelen = nfs_page_length(page);
579 ret = VM_FAULT_LOCKED;
580 if (nfs_flush_incompatible(filp, page) == 0 &&
581 nfs_updatepage(filp, page, 0, pagelen) == 0)
584 ret = VM_FAULT_SIGBUS;
588 sb_end_pagefault(inode->i_sb);
592 static const struct vm_operations_struct nfs_file_vm_ops = {
593 .fault = filemap_fault,
594 .map_pages = filemap_map_pages,
595 .page_mkwrite = nfs_vm_page_mkwrite,
598 static int nfs_need_check_write(struct file *filp, struct inode *inode)
600 struct nfs_open_context *ctx;
602 ctx = nfs_file_open_context(filp);
603 if (test_bit(NFS_CONTEXT_ERROR_WRITE, &ctx->flags) ||
604 nfs_ctx_key_to_expire(ctx, inode))
609 ssize_t nfs_file_write(struct kiocb *iocb, struct iov_iter *from)
611 struct file *file = iocb->ki_filp;
612 struct inode *inode = file_inode(file);
613 unsigned long written = 0;
616 result = nfs_key_timeout_notify(file, inode);
620 if (iocb->ki_flags & IOCB_DIRECT)
621 return nfs_file_direct_write(iocb, from);
623 dprintk("NFS: write(%pD2, %zu@%Ld)\n",
624 file, iov_iter_count(from), (long long) iocb->ki_pos);
626 if (IS_SWAPFILE(inode))
629 * O_APPEND implies that we must revalidate the file length.
631 if (iocb->ki_flags & IOCB_APPEND) {
632 result = nfs_revalidate_file_size(inode, file);
636 if (iocb->ki_pos > i_size_read(inode))
637 nfs_revalidate_mapping(inode, file->f_mapping);
639 nfs_start_io_write(inode);
640 result = generic_write_checks(iocb, from);
642 current->backing_dev_info = inode_to_bdi(inode);
643 result = generic_perform_write(file, from, iocb->ki_pos);
644 current->backing_dev_info = NULL;
646 nfs_end_io_write(inode);
651 iocb->ki_pos += written;
652 result = generic_write_sync(iocb, written);
656 /* Return error values */
657 if (nfs_need_check_write(file, inode)) {
658 int err = vfs_fsync(file, 0);
662 nfs_add_stats(inode, NFSIOS_NORMALWRITTENBYTES, written);
667 printk(KERN_INFO "NFS: attempt to write to active swap file!\n");
670 EXPORT_SYMBOL_GPL(nfs_file_write);
673 do_getlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
675 struct inode *inode = filp->f_mapping->host;
677 unsigned int saved_type = fl->fl_type;
679 /* Try local locking first */
680 posix_test_lock(filp, fl);
681 if (fl->fl_type != F_UNLCK) {
682 /* found a conflict */
685 fl->fl_type = saved_type;
687 if (NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
693 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
697 fl->fl_type = F_UNLCK;
702 do_unlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
704 struct inode *inode = filp->f_mapping->host;
705 struct nfs_lock_context *l_ctx;
709 * Flush all pending writes before doing anything
714 l_ctx = nfs_get_lock_context(nfs_file_open_context(filp));
715 if (!IS_ERR(l_ctx)) {
716 status = nfs_iocounter_wait(l_ctx);
717 nfs_put_lock_context(l_ctx);
718 /* NOTE: special case
719 * If we're signalled while cleaning up locks on process exit, we
720 * still need to complete the unlock.
722 if (status < 0 && !(fl->fl_flags & FL_CLOSE))
727 * Use local locking if mounted with "-onolock" or with appropriate
731 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
733 status = locks_lock_file_wait(filp, fl);
738 do_setlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
740 struct inode *inode = filp->f_mapping->host;
744 * Flush all pending writes before doing anything
747 status = nfs_sync_mapping(filp->f_mapping);
752 * Use local locking if mounted with "-onolock" or with appropriate
756 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
758 status = locks_lock_file_wait(filp, fl);
763 * Invalidate cache to prevent missing any changes. If
764 * the file is mapped, clear the page cache as well so
765 * those mappings will be loaded.
767 * This makes locking act as a cache coherency point.
769 nfs_sync_mapping(filp->f_mapping);
770 if (!NFS_PROTO(inode)->have_delegation(inode, FMODE_READ)) {
771 nfs_zap_caches(inode);
772 if (mapping_mapped(filp->f_mapping))
773 nfs_revalidate_mapping(inode, filp->f_mapping);
780 * Lock a (portion of) a file
782 int nfs_lock(struct file *filp, int cmd, struct file_lock *fl)
784 struct inode *inode = filp->f_mapping->host;
788 dprintk("NFS: lock(%pD2, t=%x, fl=%x, r=%lld:%lld)\n",
789 filp, fl->fl_type, fl->fl_flags,
790 (long long)fl->fl_start, (long long)fl->fl_end);
792 nfs_inc_stats(inode, NFSIOS_VFSLOCK);
794 /* No mandatory locks over NFS */
795 if (__mandatory_lock(inode) && fl->fl_type != F_UNLCK)
798 if (NFS_SERVER(inode)->flags & NFS_MOUNT_LOCAL_FCNTL)
801 if (NFS_PROTO(inode)->lock_check_bounds != NULL) {
802 ret = NFS_PROTO(inode)->lock_check_bounds(fl);
808 ret = do_getlk(filp, cmd, fl, is_local);
809 else if (fl->fl_type == F_UNLCK)
810 ret = do_unlk(filp, cmd, fl, is_local);
812 ret = do_setlk(filp, cmd, fl, is_local);
816 EXPORT_SYMBOL_GPL(nfs_lock);
819 * Lock a (portion of) a file
821 int nfs_flock(struct file *filp, int cmd, struct file_lock *fl)
823 struct inode *inode = filp->f_mapping->host;
826 dprintk("NFS: flock(%pD2, t=%x, fl=%x)\n",
827 filp, fl->fl_type, fl->fl_flags);
829 if (!(fl->fl_flags & FL_FLOCK))
833 * The NFSv4 protocol doesn't support LOCK_MAND, which is not part of
834 * any standard. In principle we might be able to support LOCK_MAND
835 * on NFSv2/3 since NLMv3/4 support DOS share modes, but for now the
836 * NFS code is not set up for it.
838 if (fl->fl_type & LOCK_MAND)
841 if (NFS_SERVER(inode)->flags & NFS_MOUNT_LOCAL_FLOCK)
844 /* We're simulating flock() locks using posix locks on the server */
845 if (fl->fl_type == F_UNLCK)
846 return do_unlk(filp, cmd, fl, is_local);
847 return do_setlk(filp, cmd, fl, is_local);
849 EXPORT_SYMBOL_GPL(nfs_flock);
851 const struct file_operations nfs_file_operations = {
852 .llseek = nfs_file_llseek,
853 .read_iter = nfs_file_read,
854 .write_iter = nfs_file_write,
855 .mmap = nfs_file_mmap,
856 .open = nfs_file_open,
857 .flush = nfs_file_flush,
858 .release = nfs_file_release,
859 .fsync = nfs_file_fsync,
862 .splice_read = generic_file_splice_read,
863 .splice_write = iter_file_splice_write,
864 .check_flags = nfs_check_flags,
865 .setlease = simple_nosetlease,
867 EXPORT_SYMBOL_GPL(nfs_file_operations);