f0edf5a36237d1465e717e12ca6ea962f52b2000
[linux-block.git] / fs / nfs / file.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  linux/fs/nfs/file.c
4  *
5  *  Copyright (C) 1992  Rick Sladkey
6  *
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.
12  *
13  *  Expire cache on write to a file by Wai S Kok (Oct 1994).
14  *
15  *  Total rewrite of read side for new NFS buffer cache.. Linus.
16  *
17  *  nfs regular file handling functions
18  */
19
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>
28 #include <linux/mm.h>
29 #include <linux/pagemap.h>
30 #include <linux/gfp.h>
31 #include <linux/swap.h>
32
33 #include <linux/uaccess.h>
34 #include <linux/filelock.h>
35
36 #include "delegation.h"
37 #include "internal.h"
38 #include "iostat.h"
39 #include "fscache.h"
40 #include "pnfs.h"
41
42 #include "nfstrace.h"
43
44 #define NFSDBG_FACILITY         NFSDBG_FILE
45
46 static const struct vm_operations_struct nfs_file_vm_ops;
47
48 int nfs_check_flags(int flags)
49 {
50         if ((flags & (O_APPEND | O_DIRECT)) == (O_APPEND | O_DIRECT))
51                 return -EINVAL;
52
53         return 0;
54 }
55 EXPORT_SYMBOL_GPL(nfs_check_flags);
56
57 /*
58  * Open file
59  */
60 static int
61 nfs_file_open(struct inode *inode, struct file *filp)
62 {
63         int res;
64
65         dprintk("NFS: open file(%pD2)\n", filp);
66
67         nfs_inc_stats(inode, NFSIOS_VFSOPEN);
68         res = nfs_check_flags(filp->f_flags);
69         if (res)
70                 return res;
71
72         res = nfs_open(inode, filp);
73         if (res == 0)
74                 filp->f_mode |= FMODE_CAN_ODIRECT;
75         return res;
76 }
77
78 int
79 nfs_file_release(struct inode *inode, struct file *filp)
80 {
81         dprintk("NFS: release(%pD2)\n", filp);
82
83         nfs_inc_stats(inode, NFSIOS_VFSRELEASE);
84         nfs_file_clear_open_context(filp);
85         nfs_fscache_release_file(inode, filp);
86         return 0;
87 }
88 EXPORT_SYMBOL_GPL(nfs_file_release);
89
90 /**
91  * nfs_revalidate_file_size - Revalidate the file size
92  * @inode: pointer to inode struct
93  * @filp: pointer to struct file
94  *
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).
100  */
101 static int nfs_revalidate_file_size(struct inode *inode, struct file *filp)
102 {
103         struct nfs_server *server = NFS_SERVER(inode);
104
105         if (filp->f_flags & O_DIRECT)
106                 goto force_reval;
107         if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_SIZE))
108                 goto force_reval;
109         return 0;
110 force_reval:
111         return __nfs_revalidate_inode(server, inode);
112 }
113
114 loff_t nfs_file_llseek(struct file *filp, loff_t offset, int whence)
115 {
116         dprintk("NFS: llseek file(%pD2, %lld, %d)\n",
117                         filp, offset, whence);
118
119         /*
120          * whence == SEEK_END || SEEK_DATA || SEEK_HOLE => we must revalidate
121          * the cached file length
122          */
123         if (whence != SEEK_SET && whence != SEEK_CUR) {
124                 struct inode *inode = filp->f_mapping->host;
125
126                 int retval = nfs_revalidate_file_size(inode, filp);
127                 if (retval < 0)
128                         return (loff_t)retval;
129         }
130
131         return generic_file_llseek(filp, offset, whence);
132 }
133 EXPORT_SYMBOL_GPL(nfs_file_llseek);
134
135 /*
136  * Flush all dirty pages, and check for write errors.
137  */
138 static int
139 nfs_file_flush(struct file *file, fl_owner_t id)
140 {
141         struct inode    *inode = file_inode(file);
142         errseq_t since;
143
144         dprintk("NFS: flush(%pD2)\n", file);
145
146         nfs_inc_stats(inode, NFSIOS_VFSFLUSH);
147         if ((file->f_mode & FMODE_WRITE) == 0)
148                 return 0;
149
150         /* Flush writes to the server and return any errors */
151         since = filemap_sample_wb_err(file->f_mapping);
152         nfs_wb_all(inode);
153         return filemap_check_wb_err(file->f_mapping, since);
154 }
155
156 ssize_t
157 nfs_file_read(struct kiocb *iocb, struct iov_iter *to)
158 {
159         struct inode *inode = file_inode(iocb->ki_filp);
160         ssize_t result;
161
162         if (iocb->ki_flags & IOCB_DIRECT)
163                 return nfs_file_direct_read(iocb, to, false);
164
165         dprintk("NFS: read(%pD2, %zu@%lu)\n",
166                 iocb->ki_filp,
167                 iov_iter_count(to), (unsigned long) iocb->ki_pos);
168
169         nfs_start_io_read(inode);
170         result = nfs_revalidate_mapping(inode, iocb->ki_filp->f_mapping);
171         if (!result) {
172                 result = generic_file_read_iter(iocb, to);
173                 if (result > 0)
174                         nfs_add_stats(inode, NFSIOS_NORMALREADBYTES, result);
175         }
176         nfs_end_io_read(inode);
177         return result;
178 }
179 EXPORT_SYMBOL_GPL(nfs_file_read);
180
181 int
182 nfs_file_mmap(struct file * file, struct vm_area_struct * vma)
183 {
184         struct inode *inode = file_inode(file);
185         int     status;
186
187         dprintk("NFS: mmap(%pD2)\n", file);
188
189         /* Note: generic_file_mmap() returns ENOSYS on nommu systems
190          *       so we call that before revalidating the mapping
191          */
192         status = generic_file_mmap(file, vma);
193         if (!status) {
194                 vma->vm_ops = &nfs_file_vm_ops;
195                 status = nfs_revalidate_mapping(inode, file->f_mapping);
196         }
197         return status;
198 }
199 EXPORT_SYMBOL_GPL(nfs_file_mmap);
200
201 /*
202  * Flush any dirty pages for this process, and check for write errors.
203  * The return status from this call provides a reliable indication of
204  * whether any write errors occurred for this process.
205  */
206 static int
207 nfs_file_fsync_commit(struct file *file, int datasync)
208 {
209         struct inode *inode = file_inode(file);
210         int ret, ret2;
211
212         dprintk("NFS: fsync file(%pD2) datasync %d\n", file, datasync);
213
214         nfs_inc_stats(inode, NFSIOS_VFSFSYNC);
215         ret = nfs_commit_inode(inode, FLUSH_SYNC);
216         ret2 = file_check_and_advance_wb_err(file);
217         if (ret2 < 0)
218                 return ret2;
219         return ret;
220 }
221
222 int
223 nfs_file_fsync(struct file *file, loff_t start, loff_t end, int datasync)
224 {
225         struct inode *inode = file_inode(file);
226         struct nfs_inode *nfsi = NFS_I(inode);
227         long save_nredirtied = atomic_long_read(&nfsi->redirtied_pages);
228         long nredirtied;
229         int ret;
230
231         trace_nfs_fsync_enter(inode);
232
233         for (;;) {
234                 ret = file_write_and_wait_range(file, start, end);
235                 if (ret != 0)
236                         break;
237                 ret = nfs_file_fsync_commit(file, datasync);
238                 if (ret != 0)
239                         break;
240                 ret = pnfs_sync_inode(inode, !!datasync);
241                 if (ret != 0)
242                         break;
243                 nredirtied = atomic_long_read(&nfsi->redirtied_pages);
244                 if (nredirtied == save_nredirtied)
245                         break;
246                 save_nredirtied = nredirtied;
247         }
248
249         trace_nfs_fsync_exit(inode, ret);
250         return ret;
251 }
252 EXPORT_SYMBOL_GPL(nfs_file_fsync);
253
254 /*
255  * Decide whether a read/modify/write cycle may be more efficient
256  * then a modify/write/read cycle when writing to a page in the
257  * page cache.
258  *
259  * Some pNFS layout drivers can only read/write at a certain block
260  * granularity like all block devices and therefore we must perform
261  * read/modify/write whenever a page hasn't read yet and the data
262  * to be written there is not aligned to a block boundary and/or
263  * smaller than the block size.
264  *
265  * The modify/write/read cycle may occur if a page is read before
266  * being completely filled by the writer.  In this situation, the
267  * page must be completely written to stable storage on the server
268  * before it can be refilled by reading in the page from the server.
269  * This can lead to expensive, small, FILE_SYNC mode writes being
270  * done.
271  *
272  * It may be more efficient to read the page first if the file is
273  * open for reading in addition to writing, the page is not marked
274  * as Uptodate, it is not dirty or waiting to be committed,
275  * indicating that it was previously allocated and then modified,
276  * that there were valid bytes of data in that range of the file,
277  * and that the new data won't completely replace the old data in
278  * that range of the file.
279  */
280 static bool nfs_folio_is_full_write(struct folio *folio, loff_t pos,
281                                     unsigned int len)
282 {
283         unsigned int pglen = nfs_folio_length(folio);
284         unsigned int offset = offset_in_folio(folio, pos);
285         unsigned int end = offset + len;
286
287         return !pglen || (end >= pglen && !offset);
288 }
289
290 static bool nfs_want_read_modify_write(struct file *file, struct folio *folio,
291                                        loff_t pos, unsigned int len)
292 {
293         /*
294          * Up-to-date pages, those with ongoing or full-page write
295          * don't need read/modify/write
296          */
297         if (folio_test_uptodate(folio) || folio_test_private(folio) ||
298             nfs_folio_is_full_write(folio, pos, len))
299                 return false;
300
301         if (pnfs_ld_read_whole_page(file_inode(file)))
302                 return true;
303         /* Open for reading too? */
304         if (file->f_mode & FMODE_READ)
305                 return true;
306         return false;
307 }
308
309 /*
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.
313  *
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.
316  */
317 static int nfs_write_begin(struct file *file, struct address_space *mapping,
318                            loff_t pos, unsigned len, struct page **pagep,
319                            void **fsdata)
320 {
321         struct folio *folio;
322         int once_thru = 0;
323         int ret;
324
325         dfprintk(PAGECACHE, "NFS: write_begin(%pD2(%lu), %u@%lld)\n",
326                 file, mapping->host->i_ino, len, (long long) pos);
327
328 start:
329         folio = __filemap_get_folio(mapping, pos >> PAGE_SHIFT, FGP_WRITEBEGIN,
330                                     mapping_gfp_mask(mapping));
331         if (IS_ERR(folio))
332                 return PTR_ERR(folio);
333         *pagep = &folio->page;
334
335         ret = nfs_flush_incompatible(file, folio);
336         if (ret) {
337                 folio_unlock(folio);
338                 folio_put(folio);
339         } else if (!once_thru &&
340                    nfs_want_read_modify_write(file, folio, pos, len)) {
341                 once_thru = 1;
342                 ret = nfs_read_folio(file, folio);
343                 folio_put(folio);
344                 if (!ret)
345                         goto start;
346         }
347         return ret;
348 }
349
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)
353 {
354         struct nfs_open_context *ctx = nfs_file_open_context(file);
355         struct folio *folio = page_folio(page);
356         unsigned offset = offset_in_folio(folio, pos);
357         int status;
358
359         dfprintk(PAGECACHE, "NFS: write_end(%pD2(%lu), %u@%lld)\n",
360                 file, mapping->host->i_ino, len, (long long) pos);
361
362         /*
363          * Zero any uninitialised parts of the page, and then mark the page
364          * as up to date if it turns out that we're extending the file.
365          */
366         if (!folio_test_uptodate(folio)) {
367                 size_t fsize = folio_size(folio);
368                 unsigned pglen = nfs_folio_length(folio);
369                 unsigned end = offset + copied;
370
371                 if (pglen == 0) {
372                         folio_zero_segments(folio, 0, offset, end, fsize);
373                         folio_mark_uptodate(folio);
374                 } else if (end >= pglen) {
375                         folio_zero_segment(folio, end, fsize);
376                         if (offset == 0)
377                                 folio_mark_uptodate(folio);
378                 } else
379                         folio_zero_segment(folio, pglen, fsize);
380         }
381
382         status = nfs_update_folio(file, folio, offset, copied);
383
384         folio_unlock(folio);
385         folio_put(folio);
386
387         if (status < 0)
388                 return status;
389         NFS_I(mapping->host)->write_io += copied;
390
391         if (nfs_ctx_key_to_expire(ctx, mapping->host))
392                 nfs_wb_all(mapping->host);
393
394         return copied;
395 }
396
397 /*
398  * Partially or wholly invalidate a page
399  * - Release the private state associated with a page if undergoing complete
400  *   page invalidation
401  * - Called if either PG_private or PG_fscache is set on the page
402  * - Caller holds page lock
403  */
404 static void nfs_invalidate_folio(struct folio *folio, size_t offset,
405                                 size_t length)
406 {
407         struct inode *inode = folio_file_mapping(folio)->host;
408         dfprintk(PAGECACHE, "NFS: invalidate_folio(%lu, %zu, %zu)\n",
409                  folio->index, offset, length);
410
411         if (offset != 0 || length < folio_size(folio))
412                 return;
413         /* Cancel any unstarted writes on this page */
414         nfs_wb_folio_cancel(inode, folio);
415         folio_wait_fscache(folio);
416         trace_nfs_invalidate_folio(inode, folio);
417 }
418
419 /*
420  * Attempt to release the private state associated with a folio
421  * - Called if either private or fscache flags are set on the folio
422  * - Caller holds folio lock
423  * - Return true (may release folio) or false (may not)
424  */
425 static bool nfs_release_folio(struct folio *folio, gfp_t gfp)
426 {
427         dfprintk(PAGECACHE, "NFS: release_folio(%p)\n", folio);
428
429         /* If the private flag is set, then the folio is not freeable */
430         if (folio_test_private(folio)) {
431                 if ((current_gfp_context(gfp) & GFP_KERNEL) != GFP_KERNEL ||
432                     current_is_kswapd())
433                         return false;
434                 if (nfs_wb_folio(folio_file_mapping(folio)->host, folio) < 0)
435                         return false;
436         }
437         return nfs_fscache_release_folio(folio, gfp);
438 }
439
440 static void nfs_check_dirty_writeback(struct folio *folio,
441                                 bool *dirty, bool *writeback)
442 {
443         struct nfs_inode *nfsi;
444         struct address_space *mapping = folio->mapping;
445
446         /*
447          * Check if an unstable folio is currently being committed and
448          * if so, have the VM treat it as if the folio is under writeback
449          * so it will not block due to folios that will shortly be freeable.
450          */
451         nfsi = NFS_I(mapping->host);
452         if (atomic_read(&nfsi->commit_info.rpcs_out)) {
453                 *writeback = true;
454                 return;
455         }
456
457         /*
458          * If the private flag is set, then the folio is not freeable
459          * and as the inode is not being committed, it's not going to
460          * be cleaned in the near future so treat it as dirty
461          */
462         if (folio_test_private(folio))
463                 *dirty = true;
464 }
465
466 /*
467  * Attempt to clear the private state associated with a page when an error
468  * occurs that requires the cached contents of an inode to be written back or
469  * destroyed
470  * - Called if either PG_private or fscache is set on the page
471  * - Caller holds page lock
472  * - Return 0 if successful, -error otherwise
473  */
474 static int nfs_launder_folio(struct folio *folio)
475 {
476         struct inode *inode = folio->mapping->host;
477         int ret;
478
479         dfprintk(PAGECACHE, "NFS: launder_folio(%ld, %llu)\n",
480                 inode->i_ino, folio_pos(folio));
481
482         folio_wait_fscache(folio);
483         ret = nfs_wb_folio(inode, folio);
484         trace_nfs_launder_folio_done(inode, folio, ret);
485         return ret;
486 }
487
488 static int nfs_swap_activate(struct swap_info_struct *sis, struct file *file,
489                                                 sector_t *span)
490 {
491         unsigned long blocks;
492         long long isize;
493         int ret;
494         struct inode *inode = file_inode(file);
495         struct rpc_clnt *clnt = NFS_CLIENT(inode);
496         struct nfs_client *cl = NFS_SERVER(inode)->nfs_client;
497
498         spin_lock(&inode->i_lock);
499         blocks = inode->i_blocks;
500         isize = inode->i_size;
501         spin_unlock(&inode->i_lock);
502         if (blocks*512 < isize) {
503                 pr_warn("swap activate: swapfile has holes\n");
504                 return -EINVAL;
505         }
506
507         ret = rpc_clnt_swap_activate(clnt);
508         if (ret)
509                 return ret;
510         ret = add_swap_extent(sis, 0, sis->max, 0);
511         if (ret < 0) {
512                 rpc_clnt_swap_deactivate(clnt);
513                 return ret;
514         }
515
516         *span = sis->pages;
517
518         if (cl->rpc_ops->enable_swap)
519                 cl->rpc_ops->enable_swap(inode);
520
521         sis->flags |= SWP_FS_OPS;
522         return ret;
523 }
524
525 static void nfs_swap_deactivate(struct file *file)
526 {
527         struct inode *inode = file_inode(file);
528         struct rpc_clnt *clnt = NFS_CLIENT(inode);
529         struct nfs_client *cl = NFS_SERVER(inode)->nfs_client;
530
531         rpc_clnt_swap_deactivate(clnt);
532         if (cl->rpc_ops->disable_swap)
533                 cl->rpc_ops->disable_swap(file_inode(file));
534 }
535
536 const struct address_space_operations nfs_file_aops = {
537         .read_folio = nfs_read_folio,
538         .readahead = nfs_readahead,
539         .dirty_folio = filemap_dirty_folio,
540         .writepage = nfs_writepage,
541         .writepages = nfs_writepages,
542         .write_begin = nfs_write_begin,
543         .write_end = nfs_write_end,
544         .invalidate_folio = nfs_invalidate_folio,
545         .release_folio = nfs_release_folio,
546         .migrate_folio = nfs_migrate_folio,
547         .launder_folio = nfs_launder_folio,
548         .is_dirty_writeback = nfs_check_dirty_writeback,
549         .error_remove_page = generic_error_remove_page,
550         .swap_activate = nfs_swap_activate,
551         .swap_deactivate = nfs_swap_deactivate,
552         .swap_rw = nfs_swap_rw,
553 };
554
555 /*
556  * Notification that a PTE pointing to an NFS page is about to be made
557  * writable, implying that someone is about to modify the page through a
558  * shared-writable mapping
559  */
560 static vm_fault_t nfs_vm_page_mkwrite(struct vm_fault *vmf)
561 {
562         struct file *filp = vmf->vma->vm_file;
563         struct inode *inode = file_inode(filp);
564         unsigned pagelen;
565         vm_fault_t ret = VM_FAULT_NOPAGE;
566         struct address_space *mapping;
567         struct folio *folio = page_folio(vmf->page);
568
569         dfprintk(PAGECACHE, "NFS: vm_page_mkwrite(%pD2(%lu), offset %lld)\n",
570                  filp, filp->f_mapping->host->i_ino,
571                  (long long)folio_file_pos(folio));
572
573         sb_start_pagefault(inode->i_sb);
574
575         /* make sure the cache has finished storing the page */
576         if (folio_test_fscache(folio) &&
577             folio_wait_fscache_killable(folio) < 0) {
578                 ret = VM_FAULT_RETRY;
579                 goto out;
580         }
581
582         wait_on_bit_action(&NFS_I(inode)->flags, NFS_INO_INVALIDATING,
583                            nfs_wait_bit_killable,
584                            TASK_KILLABLE|TASK_FREEZABLE_UNSAFE);
585
586         folio_lock(folio);
587         mapping = folio_file_mapping(folio);
588         if (mapping != inode->i_mapping)
589                 goto out_unlock;
590
591         folio_wait_writeback(folio);
592
593         pagelen = nfs_folio_length(folio);
594         if (pagelen == 0)
595                 goto out_unlock;
596
597         ret = VM_FAULT_LOCKED;
598         if (nfs_flush_incompatible(filp, folio) == 0 &&
599             nfs_update_folio(filp, folio, 0, pagelen) == 0)
600                 goto out;
601
602         ret = VM_FAULT_SIGBUS;
603 out_unlock:
604         folio_unlock(folio);
605 out:
606         sb_end_pagefault(inode->i_sb);
607         return ret;
608 }
609
610 static const struct vm_operations_struct nfs_file_vm_ops = {
611         .fault = filemap_fault,
612         .map_pages = filemap_map_pages,
613         .page_mkwrite = nfs_vm_page_mkwrite,
614 };
615
616 ssize_t nfs_file_write(struct kiocb *iocb, struct iov_iter *from)
617 {
618         struct file *file = iocb->ki_filp;
619         struct inode *inode = file_inode(file);
620         unsigned int mntflags = NFS_SERVER(inode)->flags;
621         ssize_t result, written;
622         errseq_t since;
623         int error;
624
625         result = nfs_key_timeout_notify(file, inode);
626         if (result)
627                 return result;
628
629         if (iocb->ki_flags & IOCB_DIRECT)
630                 return nfs_file_direct_write(iocb, from, false);
631
632         dprintk("NFS: write(%pD2, %zu@%Ld)\n",
633                 file, iov_iter_count(from), (long long) iocb->ki_pos);
634
635         if (IS_SWAPFILE(inode))
636                 goto out_swapfile;
637         /*
638          * O_APPEND implies that we must revalidate the file length.
639          */
640         if (iocb->ki_flags & IOCB_APPEND || iocb->ki_pos > i_size_read(inode)) {
641                 result = nfs_revalidate_file_size(inode, file);
642                 if (result)
643                         return result;
644         }
645
646         nfs_clear_invalid_mapping(file->f_mapping);
647
648         since = filemap_sample_wb_err(file->f_mapping);
649         nfs_start_io_write(inode);
650         result = generic_write_checks(iocb, from);
651         if (result > 0) {
652                 current->backing_dev_info = inode_to_bdi(inode);
653                 result = generic_perform_write(iocb, from);
654                 current->backing_dev_info = NULL;
655         }
656         nfs_end_io_write(inode);
657         if (result <= 0)
658                 goto out;
659
660         written = result;
661         iocb->ki_pos += written;
662         nfs_add_stats(inode, NFSIOS_NORMALWRITTENBYTES, written);
663
664         if (mntflags & NFS_MOUNT_WRITE_EAGER) {
665                 result = filemap_fdatawrite_range(file->f_mapping,
666                                                   iocb->ki_pos - written,
667                                                   iocb->ki_pos - 1);
668                 if (result < 0)
669                         goto out;
670         }
671         if (mntflags & NFS_MOUNT_WRITE_WAIT) {
672                 filemap_fdatawait_range(file->f_mapping,
673                                         iocb->ki_pos - written,
674                                         iocb->ki_pos - 1);
675         }
676         result = generic_write_sync(iocb, written);
677         if (result < 0)
678                 return result;
679
680 out:
681         /* Return error values */
682         error = filemap_check_wb_err(file->f_mapping, since);
683         switch (error) {
684         default:
685                 break;
686         case -EDQUOT:
687         case -EFBIG:
688         case -ENOSPC:
689                 nfs_wb_all(inode);
690                 error = file_check_and_advance_wb_err(file);
691                 if (error < 0)
692                         result = error;
693         }
694         return result;
695
696 out_swapfile:
697         printk(KERN_INFO "NFS: attempt to write to active swap file!\n");
698         return -ETXTBSY;
699 }
700 EXPORT_SYMBOL_GPL(nfs_file_write);
701
702 static int
703 do_getlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
704 {
705         struct inode *inode = filp->f_mapping->host;
706         int status = 0;
707         unsigned int saved_type = fl->fl_type;
708
709         /* Try local locking first */
710         posix_test_lock(filp, fl);
711         if (fl->fl_type != F_UNLCK) {
712                 /* found a conflict */
713                 goto out;
714         }
715         fl->fl_type = saved_type;
716
717         if (NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
718                 goto out_noconflict;
719
720         if (is_local)
721                 goto out_noconflict;
722
723         status = NFS_PROTO(inode)->lock(filp, cmd, fl);
724 out:
725         return status;
726 out_noconflict:
727         fl->fl_type = F_UNLCK;
728         goto out;
729 }
730
731 static int
732 do_unlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
733 {
734         struct inode *inode = filp->f_mapping->host;
735         struct nfs_lock_context *l_ctx;
736         int status;
737
738         /*
739          * Flush all pending writes before doing anything
740          * with locks..
741          */
742         nfs_wb_all(inode);
743
744         l_ctx = nfs_get_lock_context(nfs_file_open_context(filp));
745         if (!IS_ERR(l_ctx)) {
746                 status = nfs_iocounter_wait(l_ctx);
747                 nfs_put_lock_context(l_ctx);
748                 /*  NOTE: special case
749                  *      If we're signalled while cleaning up locks on process exit, we
750                  *      still need to complete the unlock.
751                  */
752                 if (status < 0 && !(fl->fl_flags & FL_CLOSE))
753                         return status;
754         }
755
756         /*
757          * Use local locking if mounted with "-onolock" or with appropriate
758          * "-olocal_lock="
759          */
760         if (!is_local)
761                 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
762         else
763                 status = locks_lock_file_wait(filp, fl);
764         return status;
765 }
766
767 static int
768 do_setlk(struct file *filp, int cmd, struct file_lock *fl, int is_local)
769 {
770         struct inode *inode = filp->f_mapping->host;
771         int status;
772
773         /*
774          * Flush all pending writes before doing anything
775          * with locks..
776          */
777         status = nfs_sync_mapping(filp->f_mapping);
778         if (status != 0)
779                 goto out;
780
781         /*
782          * Use local locking if mounted with "-onolock" or with appropriate
783          * "-olocal_lock="
784          */
785         if (!is_local)
786                 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
787         else
788                 status = locks_lock_file_wait(filp, fl);
789         if (status < 0)
790                 goto out;
791
792         /*
793          * Invalidate cache to prevent missing any changes.  If
794          * the file is mapped, clear the page cache as well so
795          * those mappings will be loaded.
796          *
797          * This makes locking act as a cache coherency point.
798          */
799         nfs_sync_mapping(filp->f_mapping);
800         if (!NFS_PROTO(inode)->have_delegation(inode, FMODE_READ)) {
801                 nfs_zap_caches(inode);
802                 if (mapping_mapped(filp->f_mapping))
803                         nfs_revalidate_mapping(inode, filp->f_mapping);
804         }
805 out:
806         return status;
807 }
808
809 /*
810  * Lock a (portion of) a file
811  */
812 int nfs_lock(struct file *filp, int cmd, struct file_lock *fl)
813 {
814         struct inode *inode = filp->f_mapping->host;
815         int ret = -ENOLCK;
816         int is_local = 0;
817
818         dprintk("NFS: lock(%pD2, t=%x, fl=%x, r=%lld:%lld)\n",
819                         filp, fl->fl_type, fl->fl_flags,
820                         (long long)fl->fl_start, (long long)fl->fl_end);
821
822         nfs_inc_stats(inode, NFSIOS_VFSLOCK);
823
824         if (fl->fl_flags & FL_RECLAIM)
825                 return -ENOGRACE;
826
827         if (NFS_SERVER(inode)->flags & NFS_MOUNT_LOCAL_FCNTL)
828                 is_local = 1;
829
830         if (NFS_PROTO(inode)->lock_check_bounds != NULL) {
831                 ret = NFS_PROTO(inode)->lock_check_bounds(fl);
832                 if (ret < 0)
833                         goto out_err;
834         }
835
836         if (IS_GETLK(cmd))
837                 ret = do_getlk(filp, cmd, fl, is_local);
838         else if (fl->fl_type == F_UNLCK)
839                 ret = do_unlk(filp, cmd, fl, is_local);
840         else
841                 ret = do_setlk(filp, cmd, fl, is_local);
842 out_err:
843         return ret;
844 }
845 EXPORT_SYMBOL_GPL(nfs_lock);
846
847 /*
848  * Lock a (portion of) a file
849  */
850 int nfs_flock(struct file *filp, int cmd, struct file_lock *fl)
851 {
852         struct inode *inode = filp->f_mapping->host;
853         int is_local = 0;
854
855         dprintk("NFS: flock(%pD2, t=%x, fl=%x)\n",
856                         filp, fl->fl_type, fl->fl_flags);
857
858         if (!(fl->fl_flags & FL_FLOCK))
859                 return -ENOLCK;
860
861         if (NFS_SERVER(inode)->flags & NFS_MOUNT_LOCAL_FLOCK)
862                 is_local = 1;
863
864         /* We're simulating flock() locks using posix locks on the server */
865         if (fl->fl_type == F_UNLCK)
866                 return do_unlk(filp, cmd, fl, is_local);
867         return do_setlk(filp, cmd, fl, is_local);
868 }
869 EXPORT_SYMBOL_GPL(nfs_flock);
870
871 const struct file_operations nfs_file_operations = {
872         .llseek         = nfs_file_llseek,
873         .read_iter      = nfs_file_read,
874         .write_iter     = nfs_file_write,
875         .mmap           = nfs_file_mmap,
876         .open           = nfs_file_open,
877         .flush          = nfs_file_flush,
878         .release        = nfs_file_release,
879         .fsync          = nfs_file_fsync,
880         .lock           = nfs_lock,
881         .flock          = nfs_flock,
882         .splice_read    = generic_file_splice_read,
883         .splice_write   = iter_file_splice_write,
884         .check_flags    = nfs_check_flags,
885         .setlease       = simple_nosetlease,
886 };
887 EXPORT_SYMBOL_GPL(nfs_file_operations);