NFS: Remove the buggy lock-if-signalled case from do_setlk()
[safe/jmp/linux-2.6] / fs / nfs / file.c
1 /*
2  *  linux/fs/nfs/file.c
3  *
4  *  Copyright (C) 1992  Rick Sladkey
5  *
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
10  *     and implementation by Wai S Kok elekokws@ee.nus.sg.
11  *
12  *  Expire cache on write to a file by Wai S Kok (Oct 1994).
13  *
14  *  Total rewrite of read side for new NFS buffer cache.. Linus.
15  *
16  *  nfs regular file handling functions
17  */
18
19 #include <linux/time.h>
20 #include <linux/kernel.h>
21 #include <linux/errno.h>
22 #include <linux/fcntl.h>
23 #include <linux/stat.h>
24 #include <linux/nfs_fs.h>
25 #include <linux/nfs_mount.h>
26 #include <linux/mm.h>
27 #include <linux/slab.h>
28 #include <linux/pagemap.h>
29 #include <linux/smp_lock.h>
30 #include <linux/aio.h>
31
32 #include <asm/uaccess.h>
33 #include <asm/system.h>
34
35 #include "delegation.h"
36 #include "internal.h"
37 #include "iostat.h"
38
39 #define NFSDBG_FACILITY         NFSDBG_FILE
40
41 static int nfs_file_open(struct inode *, struct file *);
42 static int nfs_file_release(struct inode *, struct file *);
43 static loff_t nfs_file_llseek(struct file *file, loff_t offset, int origin);
44 static int  nfs_file_mmap(struct file *, struct vm_area_struct *);
45 static ssize_t nfs_file_splice_read(struct file *filp, loff_t *ppos,
46                                         struct pipe_inode_info *pipe,
47                                         size_t count, unsigned int flags);
48 static ssize_t nfs_file_read(struct kiocb *, const struct iovec *iov,
49                                 unsigned long nr_segs, loff_t pos);
50 static ssize_t nfs_file_write(struct kiocb *, const struct iovec *iov,
51                                 unsigned long nr_segs, loff_t pos);
52 static int  nfs_file_flush(struct file *, fl_owner_t id);
53 static int  nfs_fsync(struct file *, struct dentry *dentry, int datasync);
54 static int nfs_check_flags(int flags);
55 static int nfs_lock(struct file *filp, int cmd, struct file_lock *fl);
56 static int nfs_flock(struct file *filp, int cmd, struct file_lock *fl);
57 static int nfs_setlease(struct file *file, long arg, struct file_lock **fl);
58
59 static struct vm_operations_struct nfs_file_vm_ops;
60
61 const struct file_operations nfs_file_operations = {
62         .llseek         = nfs_file_llseek,
63         .read           = do_sync_read,
64         .write          = do_sync_write,
65         .aio_read       = nfs_file_read,
66         .aio_write      = nfs_file_write,
67         .mmap           = nfs_file_mmap,
68         .open           = nfs_file_open,
69         .flush          = nfs_file_flush,
70         .release        = nfs_file_release,
71         .fsync          = nfs_fsync,
72         .lock           = nfs_lock,
73         .flock          = nfs_flock,
74         .splice_read    = nfs_file_splice_read,
75         .check_flags    = nfs_check_flags,
76         .setlease       = nfs_setlease,
77 };
78
79 const struct inode_operations nfs_file_inode_operations = {
80         .permission     = nfs_permission,
81         .getattr        = nfs_getattr,
82         .setattr        = nfs_setattr,
83 };
84
85 #ifdef CONFIG_NFS_V3
86 const struct inode_operations nfs3_file_inode_operations = {
87         .permission     = nfs_permission,
88         .getattr        = nfs_getattr,
89         .setattr        = nfs_setattr,
90         .listxattr      = nfs3_listxattr,
91         .getxattr       = nfs3_getxattr,
92         .setxattr       = nfs3_setxattr,
93         .removexattr    = nfs3_removexattr,
94 };
95 #endif  /* CONFIG_NFS_v3 */
96
97 /* Hack for future NFS swap support */
98 #ifndef IS_SWAPFILE
99 # define IS_SWAPFILE(inode)     (0)
100 #endif
101
102 static int nfs_check_flags(int flags)
103 {
104         if ((flags & (O_APPEND | O_DIRECT)) == (O_APPEND | O_DIRECT))
105                 return -EINVAL;
106
107         return 0;
108 }
109
110 /*
111  * Open file
112  */
113 static int
114 nfs_file_open(struct inode *inode, struct file *filp)
115 {
116         int res;
117
118         res = nfs_check_flags(filp->f_flags);
119         if (res)
120                 return res;
121
122         nfs_inc_stats(inode, NFSIOS_VFSOPEN);
123         lock_kernel();
124         res = NFS_PROTO(inode)->file_open(inode, filp);
125         unlock_kernel();
126         return res;
127 }
128
129 static int
130 nfs_file_release(struct inode *inode, struct file *filp)
131 {
132         /* Ensure that dirty pages are flushed out with the right creds */
133         if (filp->f_mode & FMODE_WRITE)
134                 nfs_wb_all(filp->f_path.dentry->d_inode);
135         nfs_inc_stats(inode, NFSIOS_VFSRELEASE);
136         return NFS_PROTO(inode)->file_release(inode, filp);
137 }
138
139 /**
140  * nfs_revalidate_size - Revalidate the file size
141  * @inode - pointer to inode struct
142  * @file - pointer to struct file
143  *
144  * Revalidates the file length. This is basically a wrapper around
145  * nfs_revalidate_inode() that takes into account the fact that we may
146  * have cached writes (in which case we don't care about the server's
147  * idea of what the file length is), or O_DIRECT (in which case we
148  * shouldn't trust the cache).
149  */
150 static int nfs_revalidate_file_size(struct inode *inode, struct file *filp)
151 {
152         struct nfs_server *server = NFS_SERVER(inode);
153         struct nfs_inode *nfsi = NFS_I(inode);
154
155         if (server->flags & NFS_MOUNT_NOAC)
156                 goto force_reval;
157         if (filp->f_flags & O_DIRECT)
158                 goto force_reval;
159         if (nfsi->npages != 0)
160                 return 0;
161         if (!(nfsi->cache_validity & NFS_INO_REVAL_PAGECACHE) && !nfs_attribute_timeout(inode))
162                 return 0;
163 force_reval:
164         return __nfs_revalidate_inode(server, inode);
165 }
166
167 static loff_t nfs_file_llseek(struct file *filp, loff_t offset, int origin)
168 {
169         /* origin == SEEK_END => we must revalidate the cached file length */
170         if (origin == SEEK_END) {
171                 struct inode *inode = filp->f_mapping->host;
172                 int retval = nfs_revalidate_file_size(inode, filp);
173                 if (retval < 0)
174                         return (loff_t)retval;
175         }
176         return remote_llseek(filp, offset, origin);
177 }
178
179 /*
180  * Helper for nfs_file_flush() and nfs_fsync()
181  *
182  * Notice that it clears the NFS_CONTEXT_ERROR_WRITE before synching to
183  * disk, but it retrieves and clears ctx->error after synching, despite
184  * the two being set at the same time in nfs_context_set_write_error().
185  * This is because the former is used to notify the _next_ call to
186  * nfs_file_write() that a write error occured, and hence cause it to
187  * fall back to doing a synchronous write.
188  */
189 static int nfs_do_fsync(struct nfs_open_context *ctx, struct inode *inode)
190 {
191         int have_error, status;
192         int ret = 0;
193
194         have_error = test_and_clear_bit(NFS_CONTEXT_ERROR_WRITE, &ctx->flags);
195         status = nfs_wb_all(inode);
196         have_error |= test_bit(NFS_CONTEXT_ERROR_WRITE, &ctx->flags);
197         if (have_error)
198                 ret = xchg(&ctx->error, 0);
199         if (!ret)
200                 ret = status;
201         return ret;
202 }
203
204 /*
205  * Flush all dirty pages, and check for write errors.
206  *
207  */
208 static int
209 nfs_file_flush(struct file *file, fl_owner_t id)
210 {
211         struct nfs_open_context *ctx = nfs_file_open_context(file);
212         struct inode    *inode = file->f_path.dentry->d_inode;
213         int             status;
214
215         dfprintk(VFS, "nfs: flush(%s/%ld)\n", inode->i_sb->s_id, inode->i_ino);
216
217         if ((file->f_mode & FMODE_WRITE) == 0)
218                 return 0;
219         nfs_inc_stats(inode, NFSIOS_VFSFLUSH);
220
221         /* Ensure that data+attribute caches are up to date after close() */
222         status = nfs_do_fsync(ctx, inode);
223         if (!status)
224                 nfs_revalidate_inode(NFS_SERVER(inode), inode);
225         return status;
226 }
227
228 static ssize_t
229 nfs_file_read(struct kiocb *iocb, const struct iovec *iov,
230                 unsigned long nr_segs, loff_t pos)
231 {
232         struct dentry * dentry = iocb->ki_filp->f_path.dentry;
233         struct inode * inode = dentry->d_inode;
234         ssize_t result;
235         size_t count = iov_length(iov, nr_segs);
236
237         if (iocb->ki_filp->f_flags & O_DIRECT)
238                 return nfs_file_direct_read(iocb, iov, nr_segs, pos);
239
240         dfprintk(VFS, "nfs: read(%s/%s, %lu@%lu)\n",
241                 dentry->d_parent->d_name.name, dentry->d_name.name,
242                 (unsigned long) count, (unsigned long) pos);
243
244         result = nfs_revalidate_mapping(inode, iocb->ki_filp->f_mapping);
245         nfs_add_stats(inode, NFSIOS_NORMALREADBYTES, count);
246         if (!result)
247                 result = generic_file_aio_read(iocb, iov, nr_segs, pos);
248         return result;
249 }
250
251 static ssize_t
252 nfs_file_splice_read(struct file *filp, loff_t *ppos,
253                      struct pipe_inode_info *pipe, size_t count,
254                      unsigned int flags)
255 {
256         struct dentry *dentry = filp->f_path.dentry;
257         struct inode *inode = dentry->d_inode;
258         ssize_t res;
259
260         dfprintk(VFS, "nfs: splice_read(%s/%s, %lu@%Lu)\n",
261                 dentry->d_parent->d_name.name, dentry->d_name.name,
262                 (unsigned long) count, (unsigned long long) *ppos);
263
264         res = nfs_revalidate_mapping(inode, filp->f_mapping);
265         if (!res)
266                 res = generic_file_splice_read(filp, ppos, pipe, count, flags);
267         return res;
268 }
269
270 static int
271 nfs_file_mmap(struct file * file, struct vm_area_struct * vma)
272 {
273         struct dentry *dentry = file->f_path.dentry;
274         struct inode *inode = dentry->d_inode;
275         int     status;
276
277         dfprintk(VFS, "nfs: mmap(%s/%s)\n",
278                 dentry->d_parent->d_name.name, dentry->d_name.name);
279
280         status = nfs_revalidate_mapping(inode, file->f_mapping);
281         if (!status) {
282                 vma->vm_ops = &nfs_file_vm_ops;
283                 vma->vm_flags |= VM_CAN_NONLINEAR;
284                 file_accessed(file);
285         }
286         return status;
287 }
288
289 /*
290  * Flush any dirty pages for this process, and check for write errors.
291  * The return status from this call provides a reliable indication of
292  * whether any write errors occurred for this process.
293  */
294 static int
295 nfs_fsync(struct file *file, struct dentry *dentry, int datasync)
296 {
297         struct nfs_open_context *ctx = nfs_file_open_context(file);
298         struct inode *inode = dentry->d_inode;
299
300         dfprintk(VFS, "nfs: fsync(%s/%ld)\n", inode->i_sb->s_id, inode->i_ino);
301
302         nfs_inc_stats(inode, NFSIOS_VFSFSYNC);
303         return nfs_do_fsync(ctx, inode);
304 }
305
306 /*
307  * This does the "real" work of the write. We must allocate and lock the
308  * page to be sent back to the generic routine, which then copies the
309  * data from user space.
310  *
311  * If the writer ends up delaying the write, the writer needs to
312  * increment the page use counts until he is done with the page.
313  */
314 static int nfs_write_begin(struct file *file, struct address_space *mapping,
315                         loff_t pos, unsigned len, unsigned flags,
316                         struct page **pagep, void **fsdata)
317 {
318         int ret;
319         pgoff_t index;
320         struct page *page;
321         index = pos >> PAGE_CACHE_SHIFT;
322
323         page = __grab_cache_page(mapping, index);
324         if (!page)
325                 return -ENOMEM;
326         *pagep = page;
327
328         ret = nfs_flush_incompatible(file, page);
329         if (ret) {
330                 unlock_page(page);
331                 page_cache_release(page);
332         }
333         return ret;
334 }
335
336 static int nfs_write_end(struct file *file, struct address_space *mapping,
337                         loff_t pos, unsigned len, unsigned copied,
338                         struct page *page, void *fsdata)
339 {
340         unsigned offset = pos & (PAGE_CACHE_SIZE - 1);
341         int status;
342
343         lock_kernel();
344         status = nfs_updatepage(file, page, offset, copied);
345         unlock_kernel();
346
347         unlock_page(page);
348         page_cache_release(page);
349
350         if (status < 0)
351                 return status;
352         return copied;
353 }
354
355 static void nfs_invalidate_page(struct page *page, unsigned long offset)
356 {
357         if (offset != 0)
358                 return;
359         /* Cancel any unstarted writes on this page */
360         nfs_wb_page_cancel(page->mapping->host, page);
361 }
362
363 static int nfs_release_page(struct page *page, gfp_t gfp)
364 {
365         /* If PagePrivate() is set, then the page is not freeable */
366         return 0;
367 }
368
369 static int nfs_launder_page(struct page *page)
370 {
371         return nfs_wb_page(page->mapping->host, page);
372 }
373
374 const struct address_space_operations nfs_file_aops = {
375         .readpage = nfs_readpage,
376         .readpages = nfs_readpages,
377         .set_page_dirty = __set_page_dirty_nobuffers,
378         .writepage = nfs_writepage,
379         .writepages = nfs_writepages,
380         .write_begin = nfs_write_begin,
381         .write_end = nfs_write_end,
382         .invalidatepage = nfs_invalidate_page,
383         .releasepage = nfs_release_page,
384         .direct_IO = nfs_direct_IO,
385         .launder_page = nfs_launder_page,
386 };
387
388 static int nfs_vm_page_mkwrite(struct vm_area_struct *vma, struct page *page)
389 {
390         struct file *filp = vma->vm_file;
391         unsigned pagelen;
392         int ret = -EINVAL;
393         struct address_space *mapping;
394
395         lock_page(page);
396         mapping = page->mapping;
397         if (mapping != vma->vm_file->f_path.dentry->d_inode->i_mapping)
398                 goto out_unlock;
399
400         ret = 0;
401         pagelen = nfs_page_length(page);
402         if (pagelen == 0)
403                 goto out_unlock;
404
405         ret = nfs_flush_incompatible(filp, page);
406         if (ret != 0)
407                 goto out_unlock;
408
409         ret = nfs_updatepage(filp, page, 0, pagelen);
410         if (ret == 0)
411                 ret = pagelen;
412 out_unlock:
413         unlock_page(page);
414         return ret;
415 }
416
417 static struct vm_operations_struct nfs_file_vm_ops = {
418         .fault = filemap_fault,
419         .page_mkwrite = nfs_vm_page_mkwrite,
420 };
421
422 static int nfs_need_sync_write(struct file *filp, struct inode *inode)
423 {
424         struct nfs_open_context *ctx;
425
426         if (IS_SYNC(inode) || (filp->f_flags & O_SYNC))
427                 return 1;
428         ctx = nfs_file_open_context(filp);
429         if (test_bit(NFS_CONTEXT_ERROR_WRITE, &ctx->flags))
430                 return 1;
431         return 0;
432 }
433
434 static ssize_t nfs_file_write(struct kiocb *iocb, const struct iovec *iov,
435                                 unsigned long nr_segs, loff_t pos)
436 {
437         struct dentry * dentry = iocb->ki_filp->f_path.dentry;
438         struct inode * inode = dentry->d_inode;
439         ssize_t result;
440         size_t count = iov_length(iov, nr_segs);
441
442         if (iocb->ki_filp->f_flags & O_DIRECT)
443                 return nfs_file_direct_write(iocb, iov, nr_segs, pos);
444
445         dfprintk(VFS, "nfs: write(%s/%s(%ld), %lu@%Ld)\n",
446                 dentry->d_parent->d_name.name, dentry->d_name.name,
447                 inode->i_ino, (unsigned long) count, (long long) pos);
448
449         result = -EBUSY;
450         if (IS_SWAPFILE(inode))
451                 goto out_swapfile;
452         /*
453          * O_APPEND implies that we must revalidate the file length.
454          */
455         if (iocb->ki_filp->f_flags & O_APPEND) {
456                 result = nfs_revalidate_file_size(inode, iocb->ki_filp);
457                 if (result)
458                         goto out;
459         }
460
461         result = count;
462         if (!count)
463                 goto out;
464
465         nfs_add_stats(inode, NFSIOS_NORMALWRITTENBYTES, count);
466         result = generic_file_aio_write(iocb, iov, nr_segs, pos);
467         /* Return error values for O_SYNC and IS_SYNC() */
468         if (result >= 0 && nfs_need_sync_write(iocb->ki_filp, inode)) {
469                 int err = nfs_do_fsync(nfs_file_open_context(iocb->ki_filp), inode);
470                 if (err < 0)
471                         result = err;
472         }
473 out:
474         return result;
475
476 out_swapfile:
477         printk(KERN_INFO "NFS: attempt to write to active swap file!\n");
478         goto out;
479 }
480
481 static int do_getlk(struct file *filp, int cmd, struct file_lock *fl)
482 {
483         struct inode *inode = filp->f_mapping->host;
484         int status = 0;
485
486         lock_kernel();
487         /* Try local locking first */
488         posix_test_lock(filp, fl);
489         if (fl->fl_type != F_UNLCK) {
490                 /* found a conflict */
491                 goto out;
492         }
493
494         if (nfs_have_delegation(inode, FMODE_READ))
495                 goto out_noconflict;
496
497         if (NFS_SERVER(inode)->flags & NFS_MOUNT_NONLM)
498                 goto out_noconflict;
499
500         status = NFS_PROTO(inode)->lock(filp, cmd, fl);
501 out:
502         unlock_kernel();
503         return status;
504 out_noconflict:
505         fl->fl_type = F_UNLCK;
506         goto out;
507 }
508
509 static int do_vfs_lock(struct file *file, struct file_lock *fl)
510 {
511         int res = 0;
512         switch (fl->fl_flags & (FL_POSIX|FL_FLOCK)) {
513                 case FL_POSIX:
514                         res = posix_lock_file_wait(file, fl);
515                         break;
516                 case FL_FLOCK:
517                         res = flock_lock_file_wait(file, fl);
518                         break;
519                 default:
520                         BUG();
521         }
522         if (res < 0)
523                 dprintk(KERN_WARNING "%s: VFS is out of sync with lock manager"
524                         " - error %d!\n",
525                                 __FUNCTION__, res);
526         return res;
527 }
528
529 static int do_unlk(struct file *filp, int cmd, struct file_lock *fl)
530 {
531         struct inode *inode = filp->f_mapping->host;
532         int status;
533
534         /*
535          * Flush all pending writes before doing anything
536          * with locks..
537          */
538         nfs_sync_mapping(filp->f_mapping);
539
540         /* NOTE: special case
541          *      If we're signalled while cleaning up locks on process exit, we
542          *      still need to complete the unlock.
543          */
544         lock_kernel();
545         /* Use local locking if mounted with "-onolock" */
546         if (!(NFS_SERVER(inode)->flags & NFS_MOUNT_NONLM))
547                 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
548         else
549                 status = do_vfs_lock(filp, fl);
550         unlock_kernel();
551         return status;
552 }
553
554 static int do_setlk(struct file *filp, int cmd, struct file_lock *fl)
555 {
556         struct inode *inode = filp->f_mapping->host;
557         int status;
558
559         /*
560          * Flush all pending writes before doing anything
561          * with locks..
562          */
563         status = nfs_sync_mapping(filp->f_mapping);
564         if (status != 0)
565                 goto out;
566
567         lock_kernel();
568         /* Use local locking if mounted with "-onolock" */
569         if (!(NFS_SERVER(inode)->flags & NFS_MOUNT_NONLM))
570                 status = NFS_PROTO(inode)->lock(filp, cmd, fl);
571         else
572                 status = do_vfs_lock(filp, fl);
573         unlock_kernel();
574         if (status < 0)
575                 goto out;
576         /*
577          * Make sure we clear the cache whenever we try to get the lock.
578          * This makes locking act as a cache coherency point.
579          */
580         nfs_sync_mapping(filp->f_mapping);
581         nfs_zap_caches(inode);
582 out:
583         return status;
584 }
585
586 /*
587  * Lock a (portion of) a file
588  */
589 static int nfs_lock(struct file *filp, int cmd, struct file_lock *fl)
590 {
591         struct inode * inode = filp->f_mapping->host;
592
593         dprintk("NFS: nfs_lock(f=%s/%ld, t=%x, fl=%x, r=%Ld:%Ld)\n",
594                         inode->i_sb->s_id, inode->i_ino,
595                         fl->fl_type, fl->fl_flags,
596                         (long long)fl->fl_start, (long long)fl->fl_end);
597         nfs_inc_stats(inode, NFSIOS_VFSLOCK);
598
599         /* No mandatory locks over NFS */
600         if (__mandatory_lock(inode) && fl->fl_type != F_UNLCK)
601                 return -ENOLCK;
602
603         if (IS_GETLK(cmd))
604                 return do_getlk(filp, cmd, fl);
605         if (fl->fl_type == F_UNLCK)
606                 return do_unlk(filp, cmd, fl);
607         return do_setlk(filp, cmd, fl);
608 }
609
610 /*
611  * Lock a (portion of) a file
612  */
613 static int nfs_flock(struct file *filp, int cmd, struct file_lock *fl)
614 {
615         dprintk("NFS: nfs_flock(f=%s/%ld, t=%x, fl=%x)\n",
616                         filp->f_path.dentry->d_inode->i_sb->s_id,
617                         filp->f_path.dentry->d_inode->i_ino,
618                         fl->fl_type, fl->fl_flags);
619
620         /*
621          * No BSD flocks over NFS allowed.
622          * Note: we could try to fake a POSIX lock request here by
623          * using ((u32) filp | 0x80000000) or some such as the pid.
624          * Not sure whether that would be unique, though, or whether
625          * that would break in other places.
626          */
627         if (!(fl->fl_flags & FL_FLOCK))
628                 return -ENOLCK;
629
630         /* We're simulating flock() locks using posix locks on the server */
631         fl->fl_owner = (fl_owner_t)filp;
632         fl->fl_start = 0;
633         fl->fl_end = OFFSET_MAX;
634
635         if (fl->fl_type == F_UNLCK)
636                 return do_unlk(filp, cmd, fl);
637         return do_setlk(filp, cmd, fl);
638 }
639
640 static int nfs_setlease(struct file *file, long arg, struct file_lock **fl)
641 {
642         /*
643          * There is no protocol support for leases, so we have no way
644          * to implement them correctly in the face of opens by other
645          * clients.
646          */
647         return -EINVAL;
648 }