68acbde3f914b16fe2a8959ce68f7c66e299e908
[linux-2.6-microblaze.git] / fs / nfs / dir.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  linux/fs/nfs/dir.c
4  *
5  *  Copyright (C) 1992  Rick Sladkey
6  *
7  *  nfs directory handling functions
8  *
9  * 10 Apr 1996  Added silly rename for unlink   --okir
10  * 28 Sep 1996  Improved directory cache --okir
11  * 23 Aug 1997  Claus Heine claus@momo.math.rwth-aachen.de 
12  *              Re-implemented silly rename for unlink, newly implemented
13  *              silly rename for nfs_rename() following the suggestions
14  *              of Olaf Kirch (okir) found in this file.
15  *              Following Linus comments on my original hack, this version
16  *              depends only on the dcache stuff and doesn't touch the inode
17  *              layer (iput() and friends).
18  *  6 Jun 1999  Cache readdir lookups in the page cache. -DaveM
19  */
20
21 #include <linux/module.h>
22 #include <linux/time.h>
23 #include <linux/errno.h>
24 #include <linux/stat.h>
25 #include <linux/fcntl.h>
26 #include <linux/string.h>
27 #include <linux/kernel.h>
28 #include <linux/slab.h>
29 #include <linux/mm.h>
30 #include <linux/sunrpc/clnt.h>
31 #include <linux/nfs_fs.h>
32 #include <linux/nfs_mount.h>
33 #include <linux/pagemap.h>
34 #include <linux/pagevec.h>
35 #include <linux/namei.h>
36 #include <linux/mount.h>
37 #include <linux/swap.h>
38 #include <linux/sched.h>
39 #include <linux/kmemleak.h>
40 #include <linux/xattr.h>
41
42 #include "delegation.h"
43 #include "iostat.h"
44 #include "internal.h"
45 #include "fscache.h"
46
47 #include "nfstrace.h"
48
49 /* #define NFS_DEBUG_VERBOSE 1 */
50
51 static int nfs_opendir(struct inode *, struct file *);
52 static int nfs_closedir(struct inode *, struct file *);
53 static int nfs_readdir(struct file *, struct dir_context *);
54 static int nfs_fsync_dir(struct file *, loff_t, loff_t, int);
55 static loff_t nfs_llseek_dir(struct file *, loff_t, int);
56 static void nfs_readdir_clear_array(struct page*);
57
58 const struct file_operations nfs_dir_operations = {
59         .llseek         = nfs_llseek_dir,
60         .read           = generic_read_dir,
61         .iterate_shared = nfs_readdir,
62         .open           = nfs_opendir,
63         .release        = nfs_closedir,
64         .fsync          = nfs_fsync_dir,
65 };
66
67 const struct address_space_operations nfs_dir_aops = {
68         .freepage = nfs_readdir_clear_array,
69 };
70
71 static struct nfs_open_dir_context *alloc_nfs_open_dir_context(struct inode *dir, const struct cred *cred)
72 {
73         struct nfs_inode *nfsi = NFS_I(dir);
74         struct nfs_open_dir_context *ctx;
75         ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
76         if (ctx != NULL) {
77                 ctx->duped = 0;
78                 ctx->attr_gencount = nfsi->attr_gencount;
79                 ctx->dir_cookie = 0;
80                 ctx->dup_cookie = 0;
81                 ctx->cred = get_cred(cred);
82                 spin_lock(&dir->i_lock);
83                 if (list_empty(&nfsi->open_files) &&
84                     (nfsi->cache_validity & NFS_INO_DATA_INVAL_DEFER))
85                         nfsi->cache_validity |= NFS_INO_INVALID_DATA |
86                                 NFS_INO_REVAL_FORCED;
87                 list_add(&ctx->list, &nfsi->open_files);
88                 spin_unlock(&dir->i_lock);
89                 return ctx;
90         }
91         return  ERR_PTR(-ENOMEM);
92 }
93
94 static void put_nfs_open_dir_context(struct inode *dir, struct nfs_open_dir_context *ctx)
95 {
96         spin_lock(&dir->i_lock);
97         list_del(&ctx->list);
98         spin_unlock(&dir->i_lock);
99         put_cred(ctx->cred);
100         kfree(ctx);
101 }
102
103 /*
104  * Open file
105  */
106 static int
107 nfs_opendir(struct inode *inode, struct file *filp)
108 {
109         int res = 0;
110         struct nfs_open_dir_context *ctx;
111
112         dfprintk(FILE, "NFS: open dir(%pD2)\n", filp);
113
114         nfs_inc_stats(inode, NFSIOS_VFSOPEN);
115
116         ctx = alloc_nfs_open_dir_context(inode, current_cred());
117         if (IS_ERR(ctx)) {
118                 res = PTR_ERR(ctx);
119                 goto out;
120         }
121         filp->private_data = ctx;
122 out:
123         return res;
124 }
125
126 static int
127 nfs_closedir(struct inode *inode, struct file *filp)
128 {
129         put_nfs_open_dir_context(file_inode(filp), filp->private_data);
130         return 0;
131 }
132
133 struct nfs_cache_array_entry {
134         u64 cookie;
135         u64 ino;
136         struct qstr string;
137         unsigned char d_type;
138 };
139
140 struct nfs_cache_array {
141         u64 last_cookie;
142         unsigned int size;
143         unsigned char page_full : 1,
144                       page_is_eof : 1;
145         struct nfs_cache_array_entry array[];
146 };
147
148 typedef struct nfs_readdir_descriptor {
149         struct file     *file;
150         struct page     *page;
151         struct dir_context *ctx;
152         unsigned long   page_index;
153         u64             dir_cookie;
154         u64             last_cookie;
155         u64             dup_cookie;
156         loff_t          current_index;
157         loff_t          prev_index;
158
159         unsigned long   dir_verifier;
160         unsigned long   timestamp;
161         unsigned long   gencount;
162         unsigned long   attr_gencount;
163         unsigned int    cache_entry_index;
164         signed char duped;
165         bool plus;
166         bool eof;
167 } nfs_readdir_descriptor_t;
168
169 static
170 void nfs_readdir_init_array(struct page *page)
171 {
172         struct nfs_cache_array *array;
173
174         array = kmap_atomic(page);
175         memset(array, 0, sizeof(struct nfs_cache_array));
176         kunmap_atomic(array);
177 }
178
179 /*
180  * we are freeing strings created by nfs_add_to_readdir_array()
181  */
182 static
183 void nfs_readdir_clear_array(struct page *page)
184 {
185         struct nfs_cache_array *array;
186         int i;
187
188         array = kmap_atomic(page);
189         for (i = 0; i < array->size; i++)
190                 kfree(array->array[i].string.name);
191         array->size = 0;
192         kunmap_atomic(array);
193 }
194
195 static void nfs_readdir_array_set_eof(struct nfs_cache_array *array)
196 {
197         array->page_is_eof = 1;
198         array->page_full = 1;
199 }
200
201 static bool nfs_readdir_array_is_full(struct nfs_cache_array *array)
202 {
203         return array->page_full;
204 }
205
206 /*
207  * the caller is responsible for freeing qstr.name
208  * when called by nfs_readdir_add_to_array, the strings will be freed in
209  * nfs_clear_readdir_array()
210  */
211 static
212 int nfs_readdir_make_qstr(struct qstr *string, const char *name, unsigned int len)
213 {
214         string->len = len;
215         string->name = kmemdup_nul(name, len, GFP_KERNEL);
216         if (string->name == NULL)
217                 return -ENOMEM;
218         /*
219          * Avoid a kmemleak false positive. The pointer to the name is stored
220          * in a page cache page which kmemleak does not scan.
221          */
222         kmemleak_not_leak(string->name);
223         string->hash = full_name_hash(NULL, name, len);
224         return 0;
225 }
226
227 /*
228  * Check that the next array entry lies entirely within the page bounds
229  */
230 static int nfs_readdir_array_can_expand(struct nfs_cache_array *array)
231 {
232         struct nfs_cache_array_entry *cache_entry;
233
234         if (array->page_full)
235                 return -ENOSPC;
236         cache_entry = &array->array[array->size + 1];
237         if ((char *)cache_entry - (char *)array > PAGE_SIZE) {
238                 array->page_full = 1;
239                 return -ENOSPC;
240         }
241         return 0;
242 }
243
244 static
245 int nfs_readdir_add_to_array(struct nfs_entry *entry, struct page *page)
246 {
247         struct nfs_cache_array *array = kmap(page);
248         struct nfs_cache_array_entry *cache_entry;
249         int ret;
250
251         ret = nfs_readdir_array_can_expand(array);
252         if (ret)
253                 goto out;
254
255         cache_entry = &array->array[array->size];
256         cache_entry->cookie = entry->prev_cookie;
257         cache_entry->ino = entry->ino;
258         cache_entry->d_type = entry->d_type;
259         ret = nfs_readdir_make_qstr(&cache_entry->string, entry->name, entry->len);
260         if (ret)
261                 goto out;
262         array->last_cookie = entry->cookie;
263         array->size++;
264         if (entry->eof != 0)
265                 nfs_readdir_array_set_eof(array);
266 out:
267         kunmap(page);
268         return ret;
269 }
270
271 static void nfs_readdir_page_set_eof(struct page *page)
272 {
273         struct nfs_cache_array *array;
274
275         array = kmap_atomic(page);
276         nfs_readdir_array_set_eof(array);
277         kunmap_atomic(array);
278 }
279
280 static inline
281 int is_32bit_api(void)
282 {
283 #ifdef CONFIG_COMPAT
284         return in_compat_syscall();
285 #else
286         return (BITS_PER_LONG == 32);
287 #endif
288 }
289
290 static
291 bool nfs_readdir_use_cookie(const struct file *filp)
292 {
293         if ((filp->f_mode & FMODE_32BITHASH) ||
294             (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
295                 return false;
296         return true;
297 }
298
299 static
300 int nfs_readdir_search_for_pos(struct nfs_cache_array *array, nfs_readdir_descriptor_t *desc)
301 {
302         loff_t diff = desc->ctx->pos - desc->current_index;
303         unsigned int index;
304
305         if (diff < 0)
306                 goto out_eof;
307         if (diff >= array->size) {
308                 if (array->page_is_eof)
309                         goto out_eof;
310                 return -EAGAIN;
311         }
312
313         index = (unsigned int)diff;
314         desc->dir_cookie = array->array[index].cookie;
315         desc->cache_entry_index = index;
316         return 0;
317 out_eof:
318         desc->eof = true;
319         return -EBADCOOKIE;
320 }
321
322 static bool
323 nfs_readdir_inode_mapping_valid(struct nfs_inode *nfsi)
324 {
325         if (nfsi->cache_validity & (NFS_INO_INVALID_ATTR|NFS_INO_INVALID_DATA))
326                 return false;
327         smp_rmb();
328         return !test_bit(NFS_INO_INVALIDATING, &nfsi->flags);
329 }
330
331 static
332 int nfs_readdir_search_for_cookie(struct nfs_cache_array *array, nfs_readdir_descriptor_t *desc)
333 {
334         int i;
335         loff_t new_pos;
336         int status = -EAGAIN;
337
338         for (i = 0; i < array->size; i++) {
339                 if (array->array[i].cookie == desc->dir_cookie) {
340                         struct nfs_inode *nfsi = NFS_I(file_inode(desc->file));
341
342                         new_pos = desc->current_index + i;
343                         if (desc->attr_gencount != nfsi->attr_gencount ||
344                             !nfs_readdir_inode_mapping_valid(nfsi)) {
345                                 desc->duped = 0;
346                                 desc->attr_gencount = nfsi->attr_gencount;
347                         } else if (new_pos < desc->prev_index) {
348                                 if (desc->duped > 0
349                                     && desc->dup_cookie == desc->dir_cookie) {
350                                         if (printk_ratelimit()) {
351                                                 pr_notice("NFS: directory %pD2 contains a readdir loop."
352                                                                 "Please contact your server vendor.  "
353                                                                 "The file: %.*s has duplicate cookie %llu\n",
354                                                                 desc->file, array->array[i].string.len,
355                                                                 array->array[i].string.name, desc->dir_cookie);
356                                         }
357                                         status = -ELOOP;
358                                         goto out;
359                                 }
360                                 desc->dup_cookie = desc->dir_cookie;
361                                 desc->duped = -1;
362                         }
363                         if (nfs_readdir_use_cookie(desc->file))
364                                 desc->ctx->pos = desc->dir_cookie;
365                         else
366                                 desc->ctx->pos = new_pos;
367                         desc->prev_index = new_pos;
368                         desc->cache_entry_index = i;
369                         return 0;
370                 }
371         }
372         if (array->page_is_eof) {
373                 status = -EBADCOOKIE;
374                 if (desc->dir_cookie == array->last_cookie)
375                         desc->eof = true;
376         }
377 out:
378         return status;
379 }
380
381 static
382 int nfs_readdir_search_array(nfs_readdir_descriptor_t *desc)
383 {
384         struct nfs_cache_array *array;
385         int status;
386
387         array = kmap(desc->page);
388
389         if (desc->dir_cookie == 0)
390                 status = nfs_readdir_search_for_pos(array, desc);
391         else
392                 status = nfs_readdir_search_for_cookie(array, desc);
393
394         if (status == -EAGAIN) {
395                 desc->last_cookie = array->last_cookie;
396                 desc->current_index += array->size;
397                 desc->page_index++;
398         }
399         kunmap(desc->page);
400         return status;
401 }
402
403 /* Fill a page with xdr information before transferring to the cache page */
404 static
405 int nfs_readdir_xdr_filler(struct page **pages, nfs_readdir_descriptor_t *desc,
406                         struct nfs_entry *entry, struct file *file, struct inode *inode)
407 {
408         struct nfs_open_dir_context *ctx = file->private_data;
409         const struct cred *cred = ctx->cred;
410         unsigned long   timestamp, gencount;
411         int             error;
412
413  again:
414         timestamp = jiffies;
415         gencount = nfs_inc_attr_generation_counter();
416         desc->dir_verifier = nfs_save_change_attribute(inode);
417         error = NFS_PROTO(inode)->readdir(file_dentry(file), cred, entry->cookie, pages,
418                                           NFS_SERVER(inode)->dtsize, desc->plus);
419         if (error < 0) {
420                 /* We requested READDIRPLUS, but the server doesn't grok it */
421                 if (error == -ENOTSUPP && desc->plus) {
422                         NFS_SERVER(inode)->caps &= ~NFS_CAP_READDIRPLUS;
423                         clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
424                         desc->plus = false;
425                         goto again;
426                 }
427                 goto error;
428         }
429         desc->timestamp = timestamp;
430         desc->gencount = gencount;
431 error:
432         return error;
433 }
434
435 static int xdr_decode(nfs_readdir_descriptor_t *desc,
436                       struct nfs_entry *entry, struct xdr_stream *xdr)
437 {
438         struct inode *inode = file_inode(desc->file);
439         int error;
440
441         error = NFS_PROTO(inode)->decode_dirent(xdr, entry, desc->plus);
442         if (error)
443                 return error;
444         entry->fattr->time_start = desc->timestamp;
445         entry->fattr->gencount = desc->gencount;
446         return 0;
447 }
448
449 /* Match file and dirent using either filehandle or fileid
450  * Note: caller is responsible for checking the fsid
451  */
452 static
453 int nfs_same_file(struct dentry *dentry, struct nfs_entry *entry)
454 {
455         struct inode *inode;
456         struct nfs_inode *nfsi;
457
458         if (d_really_is_negative(dentry))
459                 return 0;
460
461         inode = d_inode(dentry);
462         if (is_bad_inode(inode) || NFS_STALE(inode))
463                 return 0;
464
465         nfsi = NFS_I(inode);
466         if (entry->fattr->fileid != nfsi->fileid)
467                 return 0;
468         if (entry->fh->size && nfs_compare_fh(entry->fh, &nfsi->fh) != 0)
469                 return 0;
470         return 1;
471 }
472
473 static
474 bool nfs_use_readdirplus(struct inode *dir, struct dir_context *ctx)
475 {
476         if (!nfs_server_capable(dir, NFS_CAP_READDIRPLUS))
477                 return false;
478         if (test_and_clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(dir)->flags))
479                 return true;
480         if (ctx->pos == 0)
481                 return true;
482         return false;
483 }
484
485 /*
486  * This function is called by the lookup and getattr code to request the
487  * use of readdirplus to accelerate any future lookups in the same
488  * directory.
489  */
490 void nfs_advise_use_readdirplus(struct inode *dir)
491 {
492         struct nfs_inode *nfsi = NFS_I(dir);
493
494         if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
495             !list_empty(&nfsi->open_files))
496                 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
497 }
498
499 /*
500  * This function is mainly for use by nfs_getattr().
501  *
502  * If this is an 'ls -l', we want to force use of readdirplus.
503  * Do this by checking if there is an active file descriptor
504  * and calling nfs_advise_use_readdirplus, then forcing a
505  * cache flush.
506  */
507 void nfs_force_use_readdirplus(struct inode *dir)
508 {
509         struct nfs_inode *nfsi = NFS_I(dir);
510
511         if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
512             !list_empty(&nfsi->open_files)) {
513                 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
514                 invalidate_mapping_pages(dir->i_mapping,
515                         nfsi->page_index + 1, -1);
516         }
517 }
518
519 static
520 void nfs_prime_dcache(struct dentry *parent, struct nfs_entry *entry,
521                 unsigned long dir_verifier)
522 {
523         struct qstr filename = QSTR_INIT(entry->name, entry->len);
524         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
525         struct dentry *dentry;
526         struct dentry *alias;
527         struct inode *inode;
528         int status;
529
530         if (!(entry->fattr->valid & NFS_ATTR_FATTR_FILEID))
531                 return;
532         if (!(entry->fattr->valid & NFS_ATTR_FATTR_FSID))
533                 return;
534         if (filename.len == 0)
535                 return;
536         /* Validate that the name doesn't contain any illegal '\0' */
537         if (strnlen(filename.name, filename.len) != filename.len)
538                 return;
539         /* ...or '/' */
540         if (strnchr(filename.name, filename.len, '/'))
541                 return;
542         if (filename.name[0] == '.') {
543                 if (filename.len == 1)
544                         return;
545                 if (filename.len == 2 && filename.name[1] == '.')
546                         return;
547         }
548         filename.hash = full_name_hash(parent, filename.name, filename.len);
549
550         dentry = d_lookup(parent, &filename);
551 again:
552         if (!dentry) {
553                 dentry = d_alloc_parallel(parent, &filename, &wq);
554                 if (IS_ERR(dentry))
555                         return;
556         }
557         if (!d_in_lookup(dentry)) {
558                 /* Is there a mountpoint here? If so, just exit */
559                 if (!nfs_fsid_equal(&NFS_SB(dentry->d_sb)->fsid,
560                                         &entry->fattr->fsid))
561                         goto out;
562                 if (nfs_same_file(dentry, entry)) {
563                         if (!entry->fh->size)
564                                 goto out;
565                         nfs_set_verifier(dentry, dir_verifier);
566                         status = nfs_refresh_inode(d_inode(dentry), entry->fattr);
567                         if (!status)
568                                 nfs_setsecurity(d_inode(dentry), entry->fattr, entry->label);
569                         goto out;
570                 } else {
571                         d_invalidate(dentry);
572                         dput(dentry);
573                         dentry = NULL;
574                         goto again;
575                 }
576         }
577         if (!entry->fh->size) {
578                 d_lookup_done(dentry);
579                 goto out;
580         }
581
582         inode = nfs_fhget(dentry->d_sb, entry->fh, entry->fattr, entry->label);
583         alias = d_splice_alias(inode, dentry);
584         d_lookup_done(dentry);
585         if (alias) {
586                 if (IS_ERR(alias))
587                         goto out;
588                 dput(dentry);
589                 dentry = alias;
590         }
591         nfs_set_verifier(dentry, dir_verifier);
592 out:
593         dput(dentry);
594 }
595
596 /* Perform conversion from xdr to cache array */
597 static
598 int nfs_readdir_page_filler(nfs_readdir_descriptor_t *desc, struct nfs_entry *entry,
599                                 struct page **xdr_pages, struct page *page, unsigned int buflen)
600 {
601         struct xdr_stream stream;
602         struct xdr_buf buf;
603         struct page *scratch;
604         int status;
605
606         scratch = alloc_page(GFP_KERNEL);
607         if (scratch == NULL)
608                 return -ENOMEM;
609
610         xdr_init_decode_pages(&stream, &buf, xdr_pages, buflen);
611         xdr_set_scratch_buffer(&stream, page_address(scratch), PAGE_SIZE);
612
613         do {
614                 if (entry->label)
615                         entry->label->len = NFS4_MAXLABELLEN;
616
617                 status = xdr_decode(desc, entry, &stream);
618                 if (status != 0)
619                         break;
620
621                 if (desc->plus)
622                         nfs_prime_dcache(file_dentry(desc->file), entry,
623                                         desc->dir_verifier);
624
625                 status = nfs_readdir_add_to_array(entry, page);
626         } while (!status && !entry->eof);
627
628         switch (status) {
629         case -EBADCOOKIE:
630                 if (entry->eof) {
631                         nfs_readdir_page_set_eof(page);
632                         status = 0;
633                 }
634                 break;
635         case -ENOSPC:
636         case -EAGAIN:
637                 status = 0;
638                 break;
639         }
640
641         put_page(scratch);
642         return status;
643 }
644
645 static
646 void nfs_readdir_free_pages(struct page **pages, unsigned int npages)
647 {
648         unsigned int i;
649         for (i = 0; i < npages; i++)
650                 put_page(pages[i]);
651 }
652
653 /*
654  * nfs_readdir_alloc_pages() will allocate pages that must be freed with a call
655  * to nfs_readdir_free_pages()
656  */
657 static
658 int nfs_readdir_alloc_pages(struct page **pages, unsigned int npages)
659 {
660         unsigned int i;
661
662         for (i = 0; i < npages; i++) {
663                 struct page *page = alloc_page(GFP_KERNEL);
664                 if (page == NULL)
665                         goto out_freepages;
666                 pages[i] = page;
667         }
668         return 0;
669
670 out_freepages:
671         nfs_readdir_free_pages(pages, i);
672         return -ENOMEM;
673 }
674
675 static
676 int nfs_readdir_xdr_to_array(nfs_readdir_descriptor_t *desc, struct page *page, struct inode *inode)
677 {
678         struct page *pages[NFS_MAX_READDIR_PAGES];
679         struct nfs_entry entry;
680         struct file     *file = desc->file;
681         struct nfs_cache_array *array;
682         int status = -ENOMEM;
683         unsigned int array_size = ARRAY_SIZE(pages);
684
685         nfs_readdir_init_array(page);
686
687         entry.prev_cookie = 0;
688         entry.cookie = desc->last_cookie;
689         entry.eof = 0;
690         entry.fh = nfs_alloc_fhandle();
691         entry.fattr = nfs_alloc_fattr();
692         entry.server = NFS_SERVER(inode);
693         if (entry.fh == NULL || entry.fattr == NULL)
694                 goto out;
695
696         entry.label = nfs4_label_alloc(NFS_SERVER(inode), GFP_NOWAIT);
697         if (IS_ERR(entry.label)) {
698                 status = PTR_ERR(entry.label);
699                 goto out;
700         }
701
702         array = kmap(page);
703
704         status = nfs_readdir_alloc_pages(pages, array_size);
705         if (status < 0)
706                 goto out_release_array;
707         do {
708                 unsigned int pglen;
709                 status = nfs_readdir_xdr_filler(pages, desc, &entry, file, inode);
710
711                 if (status < 0)
712                         break;
713
714                 pglen = status;
715                 if (pglen == 0) {
716                         nfs_readdir_page_set_eof(page);
717                         break;
718                 }
719
720                 status = nfs_readdir_page_filler(desc, &entry, pages, page, pglen);
721         } while (!status && !nfs_readdir_array_is_full(array));
722
723         nfs_readdir_free_pages(pages, array_size);
724 out_release_array:
725         kunmap(page);
726         nfs4_label_free(entry.label);
727 out:
728         nfs_free_fattr(entry.fattr);
729         nfs_free_fhandle(entry.fh);
730         return status;
731 }
732
733 /*
734  * Now we cache directories properly, by converting xdr information
735  * to an array that can be used for lookups later.  This results in
736  * fewer cache pages, since we can store more information on each page.
737  * We only need to convert from xdr once so future lookups are much simpler
738  */
739 static
740 int nfs_readdir_filler(void *data, struct page* page)
741 {
742         nfs_readdir_descriptor_t *desc = data;
743         struct inode    *inode = file_inode(desc->file);
744         int ret;
745
746         ret = nfs_readdir_xdr_to_array(desc, page, inode);
747         if (ret < 0)
748                 goto error;
749         SetPageUptodate(page);
750
751         if (invalidate_inode_pages2_range(inode->i_mapping, page->index + 1, -1) < 0) {
752                 /* Should never happen */
753                 nfs_zap_mapping(inode, inode->i_mapping);
754         }
755         unlock_page(page);
756         return 0;
757  error:
758         nfs_readdir_clear_array(page);
759         unlock_page(page);
760         return ret;
761 }
762
763 static
764 void cache_page_release(nfs_readdir_descriptor_t *desc)
765 {
766         put_page(desc->page);
767         desc->page = NULL;
768 }
769
770 static
771 struct page *get_cache_page(nfs_readdir_descriptor_t *desc)
772 {
773         return read_cache_page(desc->file->f_mapping, desc->page_index,
774                         nfs_readdir_filler, desc);
775 }
776
777 /*
778  * Returns 0 if desc->dir_cookie was found on page desc->page_index
779  * and locks the page to prevent removal from the page cache.
780  */
781 static
782 int find_and_lock_cache_page(nfs_readdir_descriptor_t *desc)
783 {
784         struct inode *inode = file_inode(desc->file);
785         struct nfs_inode *nfsi = NFS_I(inode);
786         int res;
787
788         desc->page = get_cache_page(desc);
789         if (IS_ERR(desc->page))
790                 return PTR_ERR(desc->page);
791         res = lock_page_killable(desc->page);
792         if (res != 0)
793                 goto error;
794         res = -EAGAIN;
795         if (desc->page->mapping != NULL) {
796                 res = nfs_readdir_search_array(desc);
797                 if (res == 0) {
798                         nfsi->page_index = desc->page_index;
799                         return 0;
800                 }
801         }
802         unlock_page(desc->page);
803 error:
804         cache_page_release(desc);
805         return res;
806 }
807
808 /* Search for desc->dir_cookie from the beginning of the page cache */
809 static inline
810 int readdir_search_pagecache(nfs_readdir_descriptor_t *desc)
811 {
812         int res;
813
814         if (desc->page_index == 0) {
815                 desc->current_index = 0;
816                 desc->prev_index = 0;
817                 desc->last_cookie = 0;
818         }
819         do {
820                 res = find_and_lock_cache_page(desc);
821         } while (res == -EAGAIN);
822         return res;
823 }
824
825 /*
826  * Once we've found the start of the dirent within a page: fill 'er up...
827  */
828 static 
829 int nfs_do_filldir(nfs_readdir_descriptor_t *desc)
830 {
831         struct file     *file = desc->file;
832         int i = 0;
833         int res = 0;
834         struct nfs_cache_array *array = NULL;
835
836         array = kmap(desc->page);
837         for (i = desc->cache_entry_index; i < array->size; i++) {
838                 struct nfs_cache_array_entry *ent;
839
840                 ent = &array->array[i];
841                 if (!dir_emit(desc->ctx, ent->string.name, ent->string.len,
842                     nfs_compat_user_ino64(ent->ino), ent->d_type)) {
843                         desc->eof = true;
844                         break;
845                 }
846                 if (i < (array->size-1))
847                         desc->dir_cookie = array->array[i+1].cookie;
848                 else
849                         desc->dir_cookie = array->last_cookie;
850                 if (nfs_readdir_use_cookie(file))
851                         desc->ctx->pos = desc->dir_cookie;
852                 else
853                         desc->ctx->pos++;
854                 if (desc->duped != 0)
855                         desc->duped = 1;
856         }
857         if (array->page_is_eof)
858                 desc->eof = true;
859
860         kunmap(desc->page);
861         dfprintk(DIRCACHE, "NFS: nfs_do_filldir() filling ended @ cookie %Lu; returning = %d\n",
862                         (unsigned long long)desc->dir_cookie, res);
863         return res;
864 }
865
866 /*
867  * If we cannot find a cookie in our cache, we suspect that this is
868  * because it points to a deleted file, so we ask the server to return
869  * whatever it thinks is the next entry. We then feed this to filldir.
870  * If all goes well, we should then be able to find our way round the
871  * cache on the next call to readdir_search_pagecache();
872  *
873  * NOTE: we cannot add the anonymous page to the pagecache because
874  *       the data it contains might not be page aligned. Besides,
875  *       we should already have a complete representation of the
876  *       directory in the page cache by the time we get here.
877  */
878 static inline
879 int uncached_readdir(nfs_readdir_descriptor_t *desc)
880 {
881         struct page     *page = NULL;
882         int             status;
883         struct inode *inode = file_inode(desc->file);
884
885         dfprintk(DIRCACHE, "NFS: uncached_readdir() searching for cookie %Lu\n",
886                         (unsigned long long)desc->dir_cookie);
887
888         page = alloc_page(GFP_HIGHUSER);
889         if (!page) {
890                 status = -ENOMEM;
891                 goto out;
892         }
893
894         desc->page_index = 0;
895         desc->last_cookie = desc->dir_cookie;
896         desc->page = page;
897         desc->duped = 0;
898
899         status = nfs_readdir_xdr_to_array(desc, page, inode);
900         if (status < 0)
901                 goto out_release;
902
903         status = nfs_do_filldir(desc);
904
905  out_release:
906         nfs_readdir_clear_array(desc->page);
907         cache_page_release(desc);
908  out:
909         dfprintk(DIRCACHE, "NFS: %s: returns %d\n",
910                         __func__, status);
911         return status;
912 }
913
914 /* The file offset position represents the dirent entry number.  A
915    last cookie cache takes care of the common case of reading the
916    whole directory.
917  */
918 static int nfs_readdir(struct file *file, struct dir_context *ctx)
919 {
920         struct dentry   *dentry = file_dentry(file);
921         struct inode    *inode = d_inode(dentry);
922         struct nfs_open_dir_context *dir_ctx = file->private_data;
923         nfs_readdir_descriptor_t my_desc = {
924                 .file = file,
925                 .ctx = ctx,
926                 .plus = nfs_use_readdirplus(inode, ctx),
927         },
928                         *desc = &my_desc;
929         int res = 0;
930
931         dfprintk(FILE, "NFS: readdir(%pD2) starting at cookie %llu\n",
932                         file, (long long)ctx->pos);
933         nfs_inc_stats(inode, NFSIOS_VFSGETDENTS);
934
935         /*
936          * ctx->pos points to the dirent entry number.
937          * *desc->dir_cookie has the cookie for the next entry. We have
938          * to either find the entry with the appropriate number or
939          * revalidate the cookie.
940          */
941         if (ctx->pos == 0 || nfs_attribute_cache_expired(inode))
942                 res = nfs_revalidate_mapping(inode, file->f_mapping);
943         if (res < 0)
944                 goto out;
945
946         spin_lock(&file->f_lock);
947         desc->dir_cookie = dir_ctx->dir_cookie;
948         desc->dup_cookie = dir_ctx->dup_cookie;
949         desc->duped = dir_ctx->duped;
950         desc->attr_gencount = dir_ctx->attr_gencount;
951         spin_unlock(&file->f_lock);
952
953         do {
954                 res = readdir_search_pagecache(desc);
955
956                 if (res == -EBADCOOKIE) {
957                         res = 0;
958                         /* This means either end of directory */
959                         if (desc->dir_cookie && !desc->eof) {
960                                 /* Or that the server has 'lost' a cookie */
961                                 res = uncached_readdir(desc);
962                                 if (res == 0)
963                                         continue;
964                         }
965                         break;
966                 }
967                 if (res == -ETOOSMALL && desc->plus) {
968                         clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
969                         nfs_zap_caches(inode);
970                         desc->page_index = 0;
971                         desc->plus = false;
972                         desc->eof = false;
973                         continue;
974                 }
975                 if (res < 0)
976                         break;
977
978                 res = nfs_do_filldir(desc);
979                 unlock_page(desc->page);
980                 cache_page_release(desc);
981                 if (res < 0)
982                         break;
983         } while (!desc->eof);
984
985         spin_lock(&file->f_lock);
986         dir_ctx->dir_cookie = desc->dir_cookie;
987         dir_ctx->dup_cookie = desc->dup_cookie;
988         dir_ctx->duped = desc->duped;
989         dir_ctx->attr_gencount = desc->attr_gencount;
990         spin_unlock(&file->f_lock);
991
992 out:
993         if (res > 0)
994                 res = 0;
995         dfprintk(FILE, "NFS: readdir(%pD2) returns %d\n", file, res);
996         return res;
997 }
998
999 static loff_t nfs_llseek_dir(struct file *filp, loff_t offset, int whence)
1000 {
1001         struct nfs_open_dir_context *dir_ctx = filp->private_data;
1002
1003         dfprintk(FILE, "NFS: llseek dir(%pD2, %lld, %d)\n",
1004                         filp, offset, whence);
1005
1006         switch (whence) {
1007         default:
1008                 return -EINVAL;
1009         case SEEK_SET:
1010                 if (offset < 0)
1011                         return -EINVAL;
1012                 spin_lock(&filp->f_lock);
1013                 break;
1014         case SEEK_CUR:
1015                 if (offset == 0)
1016                         return filp->f_pos;
1017                 spin_lock(&filp->f_lock);
1018                 offset += filp->f_pos;
1019                 if (offset < 0) {
1020                         spin_unlock(&filp->f_lock);
1021                         return -EINVAL;
1022                 }
1023         }
1024         if (offset != filp->f_pos) {
1025                 filp->f_pos = offset;
1026                 if (nfs_readdir_use_cookie(filp))
1027                         dir_ctx->dir_cookie = offset;
1028                 else
1029                         dir_ctx->dir_cookie = 0;
1030                 dir_ctx->duped = 0;
1031         }
1032         spin_unlock(&filp->f_lock);
1033         return offset;
1034 }
1035
1036 /*
1037  * All directory operations under NFS are synchronous, so fsync()
1038  * is a dummy operation.
1039  */
1040 static int nfs_fsync_dir(struct file *filp, loff_t start, loff_t end,
1041                          int datasync)
1042 {
1043         dfprintk(FILE, "NFS: fsync dir(%pD2) datasync %d\n", filp, datasync);
1044
1045         nfs_inc_stats(file_inode(filp), NFSIOS_VFSFSYNC);
1046         return 0;
1047 }
1048
1049 /**
1050  * nfs_force_lookup_revalidate - Mark the directory as having changed
1051  * @dir: pointer to directory inode
1052  *
1053  * This forces the revalidation code in nfs_lookup_revalidate() to do a
1054  * full lookup on all child dentries of 'dir' whenever a change occurs
1055  * on the server that might have invalidated our dcache.
1056  *
1057  * Note that we reserve bit '0' as a tag to let us know when a dentry
1058  * was revalidated while holding a delegation on its inode.
1059  *
1060  * The caller should be holding dir->i_lock
1061  */
1062 void nfs_force_lookup_revalidate(struct inode *dir)
1063 {
1064         NFS_I(dir)->cache_change_attribute += 2;
1065 }
1066 EXPORT_SYMBOL_GPL(nfs_force_lookup_revalidate);
1067
1068 /**
1069  * nfs_verify_change_attribute - Detects NFS remote directory changes
1070  * @dir: pointer to parent directory inode
1071  * @verf: previously saved change attribute
1072  *
1073  * Return "false" if the verifiers doesn't match the change attribute.
1074  * This would usually indicate that the directory contents have changed on
1075  * the server, and that any dentries need revalidating.
1076  */
1077 static bool nfs_verify_change_attribute(struct inode *dir, unsigned long verf)
1078 {
1079         return (verf & ~1UL) == nfs_save_change_attribute(dir);
1080 }
1081
1082 static void nfs_set_verifier_delegated(unsigned long *verf)
1083 {
1084         *verf |= 1UL;
1085 }
1086
1087 #if IS_ENABLED(CONFIG_NFS_V4)
1088 static void nfs_unset_verifier_delegated(unsigned long *verf)
1089 {
1090         *verf &= ~1UL;
1091 }
1092 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
1093
1094 static bool nfs_test_verifier_delegated(unsigned long verf)
1095 {
1096         return verf & 1;
1097 }
1098
1099 static bool nfs_verifier_is_delegated(struct dentry *dentry)
1100 {
1101         return nfs_test_verifier_delegated(dentry->d_time);
1102 }
1103
1104 static void nfs_set_verifier_locked(struct dentry *dentry, unsigned long verf)
1105 {
1106         struct inode *inode = d_inode(dentry);
1107
1108         if (!nfs_verifier_is_delegated(dentry) &&
1109             !nfs_verify_change_attribute(d_inode(dentry->d_parent), verf))
1110                 goto out;
1111         if (inode && NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
1112                 nfs_set_verifier_delegated(&verf);
1113 out:
1114         dentry->d_time = verf;
1115 }
1116
1117 /**
1118  * nfs_set_verifier - save a parent directory verifier in the dentry
1119  * @dentry: pointer to dentry
1120  * @verf: verifier to save
1121  *
1122  * Saves the parent directory verifier in @dentry. If the inode has
1123  * a delegation, we also tag the dentry as having been revalidated
1124  * while holding a delegation so that we know we don't have to
1125  * look it up again after a directory change.
1126  */
1127 void nfs_set_verifier(struct dentry *dentry, unsigned long verf)
1128 {
1129
1130         spin_lock(&dentry->d_lock);
1131         nfs_set_verifier_locked(dentry, verf);
1132         spin_unlock(&dentry->d_lock);
1133 }
1134 EXPORT_SYMBOL_GPL(nfs_set_verifier);
1135
1136 #if IS_ENABLED(CONFIG_NFS_V4)
1137 /**
1138  * nfs_clear_verifier_delegated - clear the dir verifier delegation tag
1139  * @inode: pointer to inode
1140  *
1141  * Iterates through the dentries in the inode alias list and clears
1142  * the tag used to indicate that the dentry has been revalidated
1143  * while holding a delegation.
1144  * This function is intended for use when the delegation is being
1145  * returned or revoked.
1146  */
1147 void nfs_clear_verifier_delegated(struct inode *inode)
1148 {
1149         struct dentry *alias;
1150
1151         if (!inode)
1152                 return;
1153         spin_lock(&inode->i_lock);
1154         hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
1155                 spin_lock(&alias->d_lock);
1156                 nfs_unset_verifier_delegated(&alias->d_time);
1157                 spin_unlock(&alias->d_lock);
1158         }
1159         spin_unlock(&inode->i_lock);
1160 }
1161 EXPORT_SYMBOL_GPL(nfs_clear_verifier_delegated);
1162 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
1163
1164 /*
1165  * A check for whether or not the parent directory has changed.
1166  * In the case it has, we assume that the dentries are untrustworthy
1167  * and may need to be looked up again.
1168  * If rcu_walk prevents us from performing a full check, return 0.
1169  */
1170 static int nfs_check_verifier(struct inode *dir, struct dentry *dentry,
1171                               int rcu_walk)
1172 {
1173         if (IS_ROOT(dentry))
1174                 return 1;
1175         if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONE)
1176                 return 0;
1177         if (!nfs_verify_change_attribute(dir, dentry->d_time))
1178                 return 0;
1179         /* Revalidate nfsi->cache_change_attribute before we declare a match */
1180         if (nfs_mapping_need_revalidate_inode(dir)) {
1181                 if (rcu_walk)
1182                         return 0;
1183                 if (__nfs_revalidate_inode(NFS_SERVER(dir), dir) < 0)
1184                         return 0;
1185         }
1186         if (!nfs_verify_change_attribute(dir, dentry->d_time))
1187                 return 0;
1188         return 1;
1189 }
1190
1191 /*
1192  * Use intent information to check whether or not we're going to do
1193  * an O_EXCL create using this path component.
1194  */
1195 static int nfs_is_exclusive_create(struct inode *dir, unsigned int flags)
1196 {
1197         if (NFS_PROTO(dir)->version == 2)
1198                 return 0;
1199         return flags & LOOKUP_EXCL;
1200 }
1201
1202 /*
1203  * Inode and filehandle revalidation for lookups.
1204  *
1205  * We force revalidation in the cases where the VFS sets LOOKUP_REVAL,
1206  * or if the intent information indicates that we're about to open this
1207  * particular file and the "nocto" mount flag is not set.
1208  *
1209  */
1210 static
1211 int nfs_lookup_verify_inode(struct inode *inode, unsigned int flags)
1212 {
1213         struct nfs_server *server = NFS_SERVER(inode);
1214         int ret;
1215
1216         if (IS_AUTOMOUNT(inode))
1217                 return 0;
1218
1219         if (flags & LOOKUP_OPEN) {
1220                 switch (inode->i_mode & S_IFMT) {
1221                 case S_IFREG:
1222                         /* A NFSv4 OPEN will revalidate later */
1223                         if (server->caps & NFS_CAP_ATOMIC_OPEN)
1224                                 goto out;
1225                         fallthrough;
1226                 case S_IFDIR:
1227                         if (server->flags & NFS_MOUNT_NOCTO)
1228                                 break;
1229                         /* NFS close-to-open cache consistency validation */
1230                         goto out_force;
1231                 }
1232         }
1233
1234         /* VFS wants an on-the-wire revalidation */
1235         if (flags & LOOKUP_REVAL)
1236                 goto out_force;
1237 out:
1238         return (inode->i_nlink == 0) ? -ESTALE : 0;
1239 out_force:
1240         if (flags & LOOKUP_RCU)
1241                 return -ECHILD;
1242         ret = __nfs_revalidate_inode(server, inode);
1243         if (ret != 0)
1244                 return ret;
1245         goto out;
1246 }
1247
1248 /*
1249  * We judge how long we want to trust negative
1250  * dentries by looking at the parent inode mtime.
1251  *
1252  * If parent mtime has changed, we revalidate, else we wait for a
1253  * period corresponding to the parent's attribute cache timeout value.
1254  *
1255  * If LOOKUP_RCU prevents us from performing a full check, return 1
1256  * suggesting a reval is needed.
1257  *
1258  * Note that when creating a new file, or looking up a rename target,
1259  * then it shouldn't be necessary to revalidate a negative dentry.
1260  */
1261 static inline
1262 int nfs_neg_need_reval(struct inode *dir, struct dentry *dentry,
1263                        unsigned int flags)
1264 {
1265         if (flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
1266                 return 0;
1267         if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONEG)
1268                 return 1;
1269         return !nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU);
1270 }
1271
1272 static int
1273 nfs_lookup_revalidate_done(struct inode *dir, struct dentry *dentry,
1274                            struct inode *inode, int error)
1275 {
1276         switch (error) {
1277         case 1:
1278                 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is valid\n",
1279                         __func__, dentry);
1280                 return 1;
1281         case 0:
1282                 nfs_mark_for_revalidate(dir);
1283                 if (inode && S_ISDIR(inode->i_mode)) {
1284                         /* Purge readdir caches. */
1285                         nfs_zap_caches(inode);
1286                         /*
1287                          * We can't d_drop the root of a disconnected tree:
1288                          * its d_hash is on the s_anon list and d_drop() would hide
1289                          * it from shrink_dcache_for_unmount(), leading to busy
1290                          * inodes on unmount and further oopses.
1291                          */
1292                         if (IS_ROOT(dentry))
1293                                 return 1;
1294                 }
1295                 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is invalid\n",
1296                                 __func__, dentry);
1297                 return 0;
1298         }
1299         dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) lookup returned error %d\n",
1300                                 __func__, dentry, error);
1301         return error;
1302 }
1303
1304 static int
1305 nfs_lookup_revalidate_negative(struct inode *dir, struct dentry *dentry,
1306                                unsigned int flags)
1307 {
1308         int ret = 1;
1309         if (nfs_neg_need_reval(dir, dentry, flags)) {
1310                 if (flags & LOOKUP_RCU)
1311                         return -ECHILD;
1312                 ret = 0;
1313         }
1314         return nfs_lookup_revalidate_done(dir, dentry, NULL, ret);
1315 }
1316
1317 static int
1318 nfs_lookup_revalidate_delegated(struct inode *dir, struct dentry *dentry,
1319                                 struct inode *inode)
1320 {
1321         nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1322         return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1323 }
1324
1325 static int
1326 nfs_lookup_revalidate_dentry(struct inode *dir, struct dentry *dentry,
1327                              struct inode *inode)
1328 {
1329         struct nfs_fh *fhandle;
1330         struct nfs_fattr *fattr;
1331         struct nfs4_label *label;
1332         unsigned long dir_verifier;
1333         int ret;
1334
1335         ret = -ENOMEM;
1336         fhandle = nfs_alloc_fhandle();
1337         fattr = nfs_alloc_fattr();
1338         label = nfs4_label_alloc(NFS_SERVER(inode), GFP_KERNEL);
1339         if (fhandle == NULL || fattr == NULL || IS_ERR(label))
1340                 goto out;
1341
1342         dir_verifier = nfs_save_change_attribute(dir);
1343         ret = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
1344         if (ret < 0) {
1345                 switch (ret) {
1346                 case -ESTALE:
1347                 case -ENOENT:
1348                         ret = 0;
1349                         break;
1350                 case -ETIMEDOUT:
1351                         if (NFS_SERVER(inode)->flags & NFS_MOUNT_SOFTREVAL)
1352                                 ret = 1;
1353                 }
1354                 goto out;
1355         }
1356         ret = 0;
1357         if (nfs_compare_fh(NFS_FH(inode), fhandle))
1358                 goto out;
1359         if (nfs_refresh_inode(inode, fattr) < 0)
1360                 goto out;
1361
1362         nfs_setsecurity(inode, fattr, label);
1363         nfs_set_verifier(dentry, dir_verifier);
1364
1365         /* set a readdirplus hint that we had a cache miss */
1366         nfs_force_use_readdirplus(dir);
1367         ret = 1;
1368 out:
1369         nfs_free_fattr(fattr);
1370         nfs_free_fhandle(fhandle);
1371         nfs4_label_free(label);
1372         return nfs_lookup_revalidate_done(dir, dentry, inode, ret);
1373 }
1374
1375 /*
1376  * This is called every time the dcache has a lookup hit,
1377  * and we should check whether we can really trust that
1378  * lookup.
1379  *
1380  * NOTE! The hit can be a negative hit too, don't assume
1381  * we have an inode!
1382  *
1383  * If the parent directory is seen to have changed, we throw out the
1384  * cached dentry and do a new lookup.
1385  */
1386 static int
1387 nfs_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1388                          unsigned int flags)
1389 {
1390         struct inode *inode;
1391         int error;
1392
1393         nfs_inc_stats(dir, NFSIOS_DENTRYREVALIDATE);
1394         inode = d_inode(dentry);
1395
1396         if (!inode)
1397                 return nfs_lookup_revalidate_negative(dir, dentry, flags);
1398
1399         if (is_bad_inode(inode)) {
1400                 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1401                                 __func__, dentry);
1402                 goto out_bad;
1403         }
1404
1405         if (nfs_verifier_is_delegated(dentry))
1406                 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
1407
1408         /* Force a full look up iff the parent directory has changed */
1409         if (!(flags & (LOOKUP_EXCL | LOOKUP_REVAL)) &&
1410             nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU)) {
1411                 error = nfs_lookup_verify_inode(inode, flags);
1412                 if (error) {
1413                         if (error == -ESTALE)
1414                                 nfs_zap_caches(dir);
1415                         goto out_bad;
1416                 }
1417                 nfs_advise_use_readdirplus(dir);
1418                 goto out_valid;
1419         }
1420
1421         if (flags & LOOKUP_RCU)
1422                 return -ECHILD;
1423
1424         if (NFS_STALE(inode))
1425                 goto out_bad;
1426
1427         trace_nfs_lookup_revalidate_enter(dir, dentry, flags);
1428         error = nfs_lookup_revalidate_dentry(dir, dentry, inode);
1429         trace_nfs_lookup_revalidate_exit(dir, dentry, flags, error);
1430         return error;
1431 out_valid:
1432         return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1433 out_bad:
1434         if (flags & LOOKUP_RCU)
1435                 return -ECHILD;
1436         return nfs_lookup_revalidate_done(dir, dentry, inode, 0);
1437 }
1438
1439 static int
1440 __nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags,
1441                         int (*reval)(struct inode *, struct dentry *, unsigned int))
1442 {
1443         struct dentry *parent;
1444         struct inode *dir;
1445         int ret;
1446
1447         if (flags & LOOKUP_RCU) {
1448                 parent = READ_ONCE(dentry->d_parent);
1449                 dir = d_inode_rcu(parent);
1450                 if (!dir)
1451                         return -ECHILD;
1452                 ret = reval(dir, dentry, flags);
1453                 if (parent != READ_ONCE(dentry->d_parent))
1454                         return -ECHILD;
1455         } else {
1456                 parent = dget_parent(dentry);
1457                 ret = reval(d_inode(parent), dentry, flags);
1458                 dput(parent);
1459         }
1460         return ret;
1461 }
1462
1463 static int nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1464 {
1465         return __nfs_lookup_revalidate(dentry, flags, nfs_do_lookup_revalidate);
1466 }
1467
1468 /*
1469  * A weaker form of d_revalidate for revalidating just the d_inode(dentry)
1470  * when we don't really care about the dentry name. This is called when a
1471  * pathwalk ends on a dentry that was not found via a normal lookup in the
1472  * parent dir (e.g.: ".", "..", procfs symlinks or mountpoint traversals).
1473  *
1474  * In this situation, we just want to verify that the inode itself is OK
1475  * since the dentry might have changed on the server.
1476  */
1477 static int nfs_weak_revalidate(struct dentry *dentry, unsigned int flags)
1478 {
1479         struct inode *inode = d_inode(dentry);
1480         int error = 0;
1481
1482         /*
1483          * I believe we can only get a negative dentry here in the case of a
1484          * procfs-style symlink. Just assume it's correct for now, but we may
1485          * eventually need to do something more here.
1486          */
1487         if (!inode) {
1488                 dfprintk(LOOKUPCACHE, "%s: %pd2 has negative inode\n",
1489                                 __func__, dentry);
1490                 return 1;
1491         }
1492
1493         if (is_bad_inode(inode)) {
1494                 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1495                                 __func__, dentry);
1496                 return 0;
1497         }
1498
1499         error = nfs_lookup_verify_inode(inode, flags);
1500         dfprintk(LOOKUPCACHE, "NFS: %s: inode %lu is %s\n",
1501                         __func__, inode->i_ino, error ? "invalid" : "valid");
1502         return !error;
1503 }
1504
1505 /*
1506  * This is called from dput() when d_count is going to 0.
1507  */
1508 static int nfs_dentry_delete(const struct dentry *dentry)
1509 {
1510         dfprintk(VFS, "NFS: dentry_delete(%pd2, %x)\n",
1511                 dentry, dentry->d_flags);
1512
1513         /* Unhash any dentry with a stale inode */
1514         if (d_really_is_positive(dentry) && NFS_STALE(d_inode(dentry)))
1515                 return 1;
1516
1517         if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1518                 /* Unhash it, so that ->d_iput() would be called */
1519                 return 1;
1520         }
1521         if (!(dentry->d_sb->s_flags & SB_ACTIVE)) {
1522                 /* Unhash it, so that ancestors of killed async unlink
1523                  * files will be cleaned up during umount */
1524                 return 1;
1525         }
1526         return 0;
1527
1528 }
1529
1530 /* Ensure that we revalidate inode->i_nlink */
1531 static void nfs_drop_nlink(struct inode *inode)
1532 {
1533         spin_lock(&inode->i_lock);
1534         /* drop the inode if we're reasonably sure this is the last link */
1535         if (inode->i_nlink > 0)
1536                 drop_nlink(inode);
1537         NFS_I(inode)->attr_gencount = nfs_inc_attr_generation_counter();
1538         NFS_I(inode)->cache_validity |= NFS_INO_INVALID_CHANGE
1539                 | NFS_INO_INVALID_CTIME
1540                 | NFS_INO_INVALID_OTHER
1541                 | NFS_INO_REVAL_FORCED;
1542         spin_unlock(&inode->i_lock);
1543 }
1544
1545 /*
1546  * Called when the dentry loses inode.
1547  * We use it to clean up silly-renamed files.
1548  */
1549 static void nfs_dentry_iput(struct dentry *dentry, struct inode *inode)
1550 {
1551         if (S_ISDIR(inode->i_mode))
1552                 /* drop any readdir cache as it could easily be old */
1553                 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_DATA;
1554
1555         if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1556                 nfs_complete_unlink(dentry, inode);
1557                 nfs_drop_nlink(inode);
1558         }
1559         iput(inode);
1560 }
1561
1562 static void nfs_d_release(struct dentry *dentry)
1563 {
1564         /* free cached devname value, if it survived that far */
1565         if (unlikely(dentry->d_fsdata)) {
1566                 if (dentry->d_flags & DCACHE_NFSFS_RENAMED)
1567                         WARN_ON(1);
1568                 else
1569                         kfree(dentry->d_fsdata);
1570         }
1571 }
1572
1573 const struct dentry_operations nfs_dentry_operations = {
1574         .d_revalidate   = nfs_lookup_revalidate,
1575         .d_weak_revalidate      = nfs_weak_revalidate,
1576         .d_delete       = nfs_dentry_delete,
1577         .d_iput         = nfs_dentry_iput,
1578         .d_automount    = nfs_d_automount,
1579         .d_release      = nfs_d_release,
1580 };
1581 EXPORT_SYMBOL_GPL(nfs_dentry_operations);
1582
1583 struct dentry *nfs_lookup(struct inode *dir, struct dentry * dentry, unsigned int flags)
1584 {
1585         struct dentry *res;
1586         struct inode *inode = NULL;
1587         struct nfs_fh *fhandle = NULL;
1588         struct nfs_fattr *fattr = NULL;
1589         struct nfs4_label *label = NULL;
1590         unsigned long dir_verifier;
1591         int error;
1592
1593         dfprintk(VFS, "NFS: lookup(%pd2)\n", dentry);
1594         nfs_inc_stats(dir, NFSIOS_VFSLOOKUP);
1595
1596         if (unlikely(dentry->d_name.len > NFS_SERVER(dir)->namelen))
1597                 return ERR_PTR(-ENAMETOOLONG);
1598
1599         /*
1600          * If we're doing an exclusive create, optimize away the lookup
1601          * but don't hash the dentry.
1602          */
1603         if (nfs_is_exclusive_create(dir, flags) || flags & LOOKUP_RENAME_TARGET)
1604                 return NULL;
1605
1606         res = ERR_PTR(-ENOMEM);
1607         fhandle = nfs_alloc_fhandle();
1608         fattr = nfs_alloc_fattr();
1609         if (fhandle == NULL || fattr == NULL)
1610                 goto out;
1611
1612         label = nfs4_label_alloc(NFS_SERVER(dir), GFP_NOWAIT);
1613         if (IS_ERR(label))
1614                 goto out;
1615
1616         dir_verifier = nfs_save_change_attribute(dir);
1617         trace_nfs_lookup_enter(dir, dentry, flags);
1618         error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
1619         if (error == -ENOENT)
1620                 goto no_entry;
1621         if (error < 0) {
1622                 res = ERR_PTR(error);
1623                 goto out_label;
1624         }
1625         inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
1626         res = ERR_CAST(inode);
1627         if (IS_ERR(res))
1628                 goto out_label;
1629
1630         /* Notify readdir to use READDIRPLUS */
1631         nfs_force_use_readdirplus(dir);
1632
1633 no_entry:
1634         res = d_splice_alias(inode, dentry);
1635         if (res != NULL) {
1636                 if (IS_ERR(res))
1637                         goto out_label;
1638                 dentry = res;
1639         }
1640         nfs_set_verifier(dentry, dir_verifier);
1641 out_label:
1642         trace_nfs_lookup_exit(dir, dentry, flags, error);
1643         nfs4_label_free(label);
1644 out:
1645         nfs_free_fattr(fattr);
1646         nfs_free_fhandle(fhandle);
1647         return res;
1648 }
1649 EXPORT_SYMBOL_GPL(nfs_lookup);
1650
1651 #if IS_ENABLED(CONFIG_NFS_V4)
1652 static int nfs4_lookup_revalidate(struct dentry *, unsigned int);
1653
1654 const struct dentry_operations nfs4_dentry_operations = {
1655         .d_revalidate   = nfs4_lookup_revalidate,
1656         .d_weak_revalidate      = nfs_weak_revalidate,
1657         .d_delete       = nfs_dentry_delete,
1658         .d_iput         = nfs_dentry_iput,
1659         .d_automount    = nfs_d_automount,
1660         .d_release      = nfs_d_release,
1661 };
1662 EXPORT_SYMBOL_GPL(nfs4_dentry_operations);
1663
1664 static fmode_t flags_to_mode(int flags)
1665 {
1666         fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
1667         if ((flags & O_ACCMODE) != O_WRONLY)
1668                 res |= FMODE_READ;
1669         if ((flags & O_ACCMODE) != O_RDONLY)
1670                 res |= FMODE_WRITE;
1671         return res;
1672 }
1673
1674 static struct nfs_open_context *create_nfs_open_context(struct dentry *dentry, int open_flags, struct file *filp)
1675 {
1676         return alloc_nfs_open_context(dentry, flags_to_mode(open_flags), filp);
1677 }
1678
1679 static int do_open(struct inode *inode, struct file *filp)
1680 {
1681         nfs_fscache_open_file(inode, filp);
1682         return 0;
1683 }
1684
1685 static int nfs_finish_open(struct nfs_open_context *ctx,
1686                            struct dentry *dentry,
1687                            struct file *file, unsigned open_flags)
1688 {
1689         int err;
1690
1691         err = finish_open(file, dentry, do_open);
1692         if (err)
1693                 goto out;
1694         if (S_ISREG(file->f_path.dentry->d_inode->i_mode))
1695                 nfs_file_set_open_context(file, ctx);
1696         else
1697                 err = -EOPENSTALE;
1698 out:
1699         return err;
1700 }
1701
1702 int nfs_atomic_open(struct inode *dir, struct dentry *dentry,
1703                     struct file *file, unsigned open_flags,
1704                     umode_t mode)
1705 {
1706         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
1707         struct nfs_open_context *ctx;
1708         struct dentry *res;
1709         struct iattr attr = { .ia_valid = ATTR_OPEN };
1710         struct inode *inode;
1711         unsigned int lookup_flags = 0;
1712         bool switched = false;
1713         int created = 0;
1714         int err;
1715
1716         /* Expect a negative dentry */
1717         BUG_ON(d_inode(dentry));
1718
1719         dfprintk(VFS, "NFS: atomic_open(%s/%lu), %pd\n",
1720                         dir->i_sb->s_id, dir->i_ino, dentry);
1721
1722         err = nfs_check_flags(open_flags);
1723         if (err)
1724                 return err;
1725
1726         /* NFS only supports OPEN on regular files */
1727         if ((open_flags & O_DIRECTORY)) {
1728                 if (!d_in_lookup(dentry)) {
1729                         /*
1730                          * Hashed negative dentry with O_DIRECTORY: dentry was
1731                          * revalidated and is fine, no need to perform lookup
1732                          * again
1733                          */
1734                         return -ENOENT;
1735                 }
1736                 lookup_flags = LOOKUP_OPEN|LOOKUP_DIRECTORY;
1737                 goto no_open;
1738         }
1739
1740         if (dentry->d_name.len > NFS_SERVER(dir)->namelen)
1741                 return -ENAMETOOLONG;
1742
1743         if (open_flags & O_CREAT) {
1744                 struct nfs_server *server = NFS_SERVER(dir);
1745
1746                 if (!(server->attr_bitmask[2] & FATTR4_WORD2_MODE_UMASK))
1747                         mode &= ~current_umask();
1748
1749                 attr.ia_valid |= ATTR_MODE;
1750                 attr.ia_mode = mode;
1751         }
1752         if (open_flags & O_TRUNC) {
1753                 attr.ia_valid |= ATTR_SIZE;
1754                 attr.ia_size = 0;
1755         }
1756
1757         if (!(open_flags & O_CREAT) && !d_in_lookup(dentry)) {
1758                 d_drop(dentry);
1759                 switched = true;
1760                 dentry = d_alloc_parallel(dentry->d_parent,
1761                                           &dentry->d_name, &wq);
1762                 if (IS_ERR(dentry))
1763                         return PTR_ERR(dentry);
1764                 if (unlikely(!d_in_lookup(dentry)))
1765                         return finish_no_open(file, dentry);
1766         }
1767
1768         ctx = create_nfs_open_context(dentry, open_flags, file);
1769         err = PTR_ERR(ctx);
1770         if (IS_ERR(ctx))
1771                 goto out;
1772
1773         trace_nfs_atomic_open_enter(dir, ctx, open_flags);
1774         inode = NFS_PROTO(dir)->open_context(dir, ctx, open_flags, &attr, &created);
1775         if (created)
1776                 file->f_mode |= FMODE_CREATED;
1777         if (IS_ERR(inode)) {
1778                 err = PTR_ERR(inode);
1779                 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
1780                 put_nfs_open_context(ctx);
1781                 d_drop(dentry);
1782                 switch (err) {
1783                 case -ENOENT:
1784                         d_splice_alias(NULL, dentry);
1785                         nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1786                         break;
1787                 case -EISDIR:
1788                 case -ENOTDIR:
1789                         goto no_open;
1790                 case -ELOOP:
1791                         if (!(open_flags & O_NOFOLLOW))
1792                                 goto no_open;
1793                         break;
1794                         /* case -EINVAL: */
1795                 default:
1796                         break;
1797                 }
1798                 goto out;
1799         }
1800
1801         err = nfs_finish_open(ctx, ctx->dentry, file, open_flags);
1802         trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
1803         put_nfs_open_context(ctx);
1804 out:
1805         if (unlikely(switched)) {
1806                 d_lookup_done(dentry);
1807                 dput(dentry);
1808         }
1809         return err;
1810
1811 no_open:
1812         res = nfs_lookup(dir, dentry, lookup_flags);
1813         if (switched) {
1814                 d_lookup_done(dentry);
1815                 if (!res)
1816                         res = dentry;
1817                 else
1818                         dput(dentry);
1819         }
1820         if (IS_ERR(res))
1821                 return PTR_ERR(res);
1822         return finish_no_open(file, res);
1823 }
1824 EXPORT_SYMBOL_GPL(nfs_atomic_open);
1825
1826 static int
1827 nfs4_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1828                           unsigned int flags)
1829 {
1830         struct inode *inode;
1831
1832         if (!(flags & LOOKUP_OPEN) || (flags & LOOKUP_DIRECTORY))
1833                 goto full_reval;
1834         if (d_mountpoint(dentry))
1835                 goto full_reval;
1836
1837         inode = d_inode(dentry);
1838
1839         /* We can't create new files in nfs_open_revalidate(), so we
1840          * optimize away revalidation of negative dentries.
1841          */
1842         if (inode == NULL)
1843                 goto full_reval;
1844
1845         if (nfs_verifier_is_delegated(dentry))
1846                 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
1847
1848         /* NFS only supports OPEN on regular files */
1849         if (!S_ISREG(inode->i_mode))
1850                 goto full_reval;
1851
1852         /* We cannot do exclusive creation on a positive dentry */
1853         if (flags & (LOOKUP_EXCL | LOOKUP_REVAL))
1854                 goto reval_dentry;
1855
1856         /* Check if the directory changed */
1857         if (!nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU))
1858                 goto reval_dentry;
1859
1860         /* Let f_op->open() actually open (and revalidate) the file */
1861         return 1;
1862 reval_dentry:
1863         if (flags & LOOKUP_RCU)
1864                 return -ECHILD;
1865         return nfs_lookup_revalidate_dentry(dir, dentry, inode);
1866
1867 full_reval:
1868         return nfs_do_lookup_revalidate(dir, dentry, flags);
1869 }
1870
1871 static int nfs4_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1872 {
1873         return __nfs_lookup_revalidate(dentry, flags,
1874                         nfs4_do_lookup_revalidate);
1875 }
1876
1877 #endif /* CONFIG_NFSV4 */
1878
1879 struct dentry *
1880 nfs_add_or_obtain(struct dentry *dentry, struct nfs_fh *fhandle,
1881                                 struct nfs_fattr *fattr,
1882                                 struct nfs4_label *label)
1883 {
1884         struct dentry *parent = dget_parent(dentry);
1885         struct inode *dir = d_inode(parent);
1886         struct inode *inode;
1887         struct dentry *d;
1888         int error;
1889
1890         d_drop(dentry);
1891
1892         if (fhandle->size == 0) {
1893                 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, NULL);
1894                 if (error)
1895                         goto out_error;
1896         }
1897         nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1898         if (!(fattr->valid & NFS_ATTR_FATTR)) {
1899                 struct nfs_server *server = NFS_SB(dentry->d_sb);
1900                 error = server->nfs_client->rpc_ops->getattr(server, fhandle,
1901                                 fattr, NULL, NULL);
1902                 if (error < 0)
1903                         goto out_error;
1904         }
1905         inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
1906         d = d_splice_alias(inode, dentry);
1907 out:
1908         dput(parent);
1909         return d;
1910 out_error:
1911         nfs_mark_for_revalidate(dir);
1912         d = ERR_PTR(error);
1913         goto out;
1914 }
1915 EXPORT_SYMBOL_GPL(nfs_add_or_obtain);
1916
1917 /*
1918  * Code common to create, mkdir, and mknod.
1919  */
1920 int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fhandle,
1921                                 struct nfs_fattr *fattr,
1922                                 struct nfs4_label *label)
1923 {
1924         struct dentry *d;
1925
1926         d = nfs_add_or_obtain(dentry, fhandle, fattr, label);
1927         if (IS_ERR(d))
1928                 return PTR_ERR(d);
1929
1930         /* Callers don't care */
1931         dput(d);
1932         return 0;
1933 }
1934 EXPORT_SYMBOL_GPL(nfs_instantiate);
1935
1936 /*
1937  * Following a failed create operation, we drop the dentry rather
1938  * than retain a negative dentry. This avoids a problem in the event
1939  * that the operation succeeded on the server, but an error in the
1940  * reply path made it appear to have failed.
1941  */
1942 int nfs_create(struct inode *dir, struct dentry *dentry,
1943                 umode_t mode, bool excl)
1944 {
1945         struct iattr attr;
1946         int open_flags = excl ? O_CREAT | O_EXCL : O_CREAT;
1947         int error;
1948
1949         dfprintk(VFS, "NFS: create(%s/%lu), %pd\n",
1950                         dir->i_sb->s_id, dir->i_ino, dentry);
1951
1952         attr.ia_mode = mode;
1953         attr.ia_valid = ATTR_MODE;
1954
1955         trace_nfs_create_enter(dir, dentry, open_flags);
1956         error = NFS_PROTO(dir)->create(dir, dentry, &attr, open_flags);
1957         trace_nfs_create_exit(dir, dentry, open_flags, error);
1958         if (error != 0)
1959                 goto out_err;
1960         return 0;
1961 out_err:
1962         d_drop(dentry);
1963         return error;
1964 }
1965 EXPORT_SYMBOL_GPL(nfs_create);
1966
1967 /*
1968  * See comments for nfs_proc_create regarding failed operations.
1969  */
1970 int
1971 nfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t rdev)
1972 {
1973         struct iattr attr;
1974         int status;
1975
1976         dfprintk(VFS, "NFS: mknod(%s/%lu), %pd\n",
1977                         dir->i_sb->s_id, dir->i_ino, dentry);
1978
1979         attr.ia_mode = mode;
1980         attr.ia_valid = ATTR_MODE;
1981
1982         trace_nfs_mknod_enter(dir, dentry);
1983         status = NFS_PROTO(dir)->mknod(dir, dentry, &attr, rdev);
1984         trace_nfs_mknod_exit(dir, dentry, status);
1985         if (status != 0)
1986                 goto out_err;
1987         return 0;
1988 out_err:
1989         d_drop(dentry);
1990         return status;
1991 }
1992 EXPORT_SYMBOL_GPL(nfs_mknod);
1993
1994 /*
1995  * See comments for nfs_proc_create regarding failed operations.
1996  */
1997 int nfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
1998 {
1999         struct iattr attr;
2000         int error;
2001
2002         dfprintk(VFS, "NFS: mkdir(%s/%lu), %pd\n",
2003                         dir->i_sb->s_id, dir->i_ino, dentry);
2004
2005         attr.ia_valid = ATTR_MODE;
2006         attr.ia_mode = mode | S_IFDIR;
2007
2008         trace_nfs_mkdir_enter(dir, dentry);
2009         error = NFS_PROTO(dir)->mkdir(dir, dentry, &attr);
2010         trace_nfs_mkdir_exit(dir, dentry, error);
2011         if (error != 0)
2012                 goto out_err;
2013         return 0;
2014 out_err:
2015         d_drop(dentry);
2016         return error;
2017 }
2018 EXPORT_SYMBOL_GPL(nfs_mkdir);
2019
2020 static void nfs_dentry_handle_enoent(struct dentry *dentry)
2021 {
2022         if (simple_positive(dentry))
2023                 d_delete(dentry);
2024 }
2025
2026 int nfs_rmdir(struct inode *dir, struct dentry *dentry)
2027 {
2028         int error;
2029
2030         dfprintk(VFS, "NFS: rmdir(%s/%lu), %pd\n",
2031                         dir->i_sb->s_id, dir->i_ino, dentry);
2032
2033         trace_nfs_rmdir_enter(dir, dentry);
2034         if (d_really_is_positive(dentry)) {
2035                 down_write(&NFS_I(d_inode(dentry))->rmdir_sem);
2036                 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2037                 /* Ensure the VFS deletes this inode */
2038                 switch (error) {
2039                 case 0:
2040                         clear_nlink(d_inode(dentry));
2041                         break;
2042                 case -ENOENT:
2043                         nfs_dentry_handle_enoent(dentry);
2044                 }
2045                 up_write(&NFS_I(d_inode(dentry))->rmdir_sem);
2046         } else
2047                 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2048         trace_nfs_rmdir_exit(dir, dentry, error);
2049
2050         return error;
2051 }
2052 EXPORT_SYMBOL_GPL(nfs_rmdir);
2053
2054 /*
2055  * Remove a file after making sure there are no pending writes,
2056  * and after checking that the file has only one user. 
2057  *
2058  * We invalidate the attribute cache and free the inode prior to the operation
2059  * to avoid possible races if the server reuses the inode.
2060  */
2061 static int nfs_safe_remove(struct dentry *dentry)
2062 {
2063         struct inode *dir = d_inode(dentry->d_parent);
2064         struct inode *inode = d_inode(dentry);
2065         int error = -EBUSY;
2066                 
2067         dfprintk(VFS, "NFS: safe_remove(%pd2)\n", dentry);
2068
2069         /* If the dentry was sillyrenamed, we simply call d_delete() */
2070         if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
2071                 error = 0;
2072                 goto out;
2073         }
2074
2075         trace_nfs_remove_enter(dir, dentry);
2076         if (inode != NULL) {
2077                 error = NFS_PROTO(dir)->remove(dir, dentry);
2078                 if (error == 0)
2079                         nfs_drop_nlink(inode);
2080         } else
2081                 error = NFS_PROTO(dir)->remove(dir, dentry);
2082         if (error == -ENOENT)
2083                 nfs_dentry_handle_enoent(dentry);
2084         trace_nfs_remove_exit(dir, dentry, error);
2085 out:
2086         return error;
2087 }
2088
2089 /*  We do silly rename. In case sillyrename() returns -EBUSY, the inode
2090  *  belongs to an active ".nfs..." file and we return -EBUSY.
2091  *
2092  *  If sillyrename() returns 0, we do nothing, otherwise we unlink.
2093  */
2094 int nfs_unlink(struct inode *dir, struct dentry *dentry)
2095 {
2096         int error;
2097         int need_rehash = 0;
2098
2099         dfprintk(VFS, "NFS: unlink(%s/%lu, %pd)\n", dir->i_sb->s_id,
2100                 dir->i_ino, dentry);
2101
2102         trace_nfs_unlink_enter(dir, dentry);
2103         spin_lock(&dentry->d_lock);
2104         if (d_count(dentry) > 1) {
2105                 spin_unlock(&dentry->d_lock);
2106                 /* Start asynchronous writeout of the inode */
2107                 write_inode_now(d_inode(dentry), 0);
2108                 error = nfs_sillyrename(dir, dentry);
2109                 goto out;
2110         }
2111         if (!d_unhashed(dentry)) {
2112                 __d_drop(dentry);
2113                 need_rehash = 1;
2114         }
2115         spin_unlock(&dentry->d_lock);
2116         error = nfs_safe_remove(dentry);
2117         if (!error || error == -ENOENT) {
2118                 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2119         } else if (need_rehash)
2120                 d_rehash(dentry);
2121 out:
2122         trace_nfs_unlink_exit(dir, dentry, error);
2123         return error;
2124 }
2125 EXPORT_SYMBOL_GPL(nfs_unlink);
2126
2127 /*
2128  * To create a symbolic link, most file systems instantiate a new inode,
2129  * add a page to it containing the path, then write it out to the disk
2130  * using prepare_write/commit_write.
2131  *
2132  * Unfortunately the NFS client can't create the in-core inode first
2133  * because it needs a file handle to create an in-core inode (see
2134  * fs/nfs/inode.c:nfs_fhget).  We only have a file handle *after* the
2135  * symlink request has completed on the server.
2136  *
2137  * So instead we allocate a raw page, copy the symname into it, then do
2138  * the SYMLINK request with the page as the buffer.  If it succeeds, we
2139  * now have a new file handle and can instantiate an in-core NFS inode
2140  * and move the raw page into its mapping.
2141  */
2142 int nfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
2143 {
2144         struct page *page;
2145         char *kaddr;
2146         struct iattr attr;
2147         unsigned int pathlen = strlen(symname);
2148         int error;
2149
2150         dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s)\n", dir->i_sb->s_id,
2151                 dir->i_ino, dentry, symname);
2152
2153         if (pathlen > PAGE_SIZE)
2154                 return -ENAMETOOLONG;
2155
2156         attr.ia_mode = S_IFLNK | S_IRWXUGO;
2157         attr.ia_valid = ATTR_MODE;
2158
2159         page = alloc_page(GFP_USER);
2160         if (!page)
2161                 return -ENOMEM;
2162
2163         kaddr = page_address(page);
2164         memcpy(kaddr, symname, pathlen);
2165         if (pathlen < PAGE_SIZE)
2166                 memset(kaddr + pathlen, 0, PAGE_SIZE - pathlen);
2167
2168         trace_nfs_symlink_enter(dir, dentry);
2169         error = NFS_PROTO(dir)->symlink(dir, dentry, page, pathlen, &attr);
2170         trace_nfs_symlink_exit(dir, dentry, error);
2171         if (error != 0) {
2172                 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s) error %d\n",
2173                         dir->i_sb->s_id, dir->i_ino,
2174                         dentry, symname, error);
2175                 d_drop(dentry);
2176                 __free_page(page);
2177                 return error;
2178         }
2179
2180         /*
2181          * No big deal if we can't add this page to the page cache here.
2182          * READLINK will get the missing page from the server if needed.
2183          */
2184         if (!add_to_page_cache_lru(page, d_inode(dentry)->i_mapping, 0,
2185                                                         GFP_KERNEL)) {
2186                 SetPageUptodate(page);
2187                 unlock_page(page);
2188                 /*
2189                  * add_to_page_cache_lru() grabs an extra page refcount.
2190                  * Drop it here to avoid leaking this page later.
2191                  */
2192                 put_page(page);
2193         } else
2194                 __free_page(page);
2195
2196         return 0;
2197 }
2198 EXPORT_SYMBOL_GPL(nfs_symlink);
2199
2200 int
2201 nfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
2202 {
2203         struct inode *inode = d_inode(old_dentry);
2204         int error;
2205
2206         dfprintk(VFS, "NFS: link(%pd2 -> %pd2)\n",
2207                 old_dentry, dentry);
2208
2209         trace_nfs_link_enter(inode, dir, dentry);
2210         d_drop(dentry);
2211         error = NFS_PROTO(dir)->link(inode, dir, &dentry->d_name);
2212         if (error == 0) {
2213                 ihold(inode);
2214                 d_add(dentry, inode);
2215         }
2216         trace_nfs_link_exit(inode, dir, dentry, error);
2217         return error;
2218 }
2219 EXPORT_SYMBOL_GPL(nfs_link);
2220
2221 /*
2222  * RENAME
2223  * FIXME: Some nfsds, like the Linux user space nfsd, may generate a
2224  * different file handle for the same inode after a rename (e.g. when
2225  * moving to a different directory). A fail-safe method to do so would
2226  * be to look up old_dir/old_name, create a link to new_dir/new_name and
2227  * rename the old file using the sillyrename stuff. This way, the original
2228  * file in old_dir will go away when the last process iput()s the inode.
2229  *
2230  * FIXED.
2231  * 
2232  * It actually works quite well. One needs to have the possibility for
2233  * at least one ".nfs..." file in each directory the file ever gets
2234  * moved or linked to which happens automagically with the new
2235  * implementation that only depends on the dcache stuff instead of
2236  * using the inode layer
2237  *
2238  * Unfortunately, things are a little more complicated than indicated
2239  * above. For a cross-directory move, we want to make sure we can get
2240  * rid of the old inode after the operation.  This means there must be
2241  * no pending writes (if it's a file), and the use count must be 1.
2242  * If these conditions are met, we can drop the dentries before doing
2243  * the rename.
2244  */
2245 int nfs_rename(struct inode *old_dir, struct dentry *old_dentry,
2246                struct inode *new_dir, struct dentry *new_dentry,
2247                unsigned int flags)
2248 {
2249         struct inode *old_inode = d_inode(old_dentry);
2250         struct inode *new_inode = d_inode(new_dentry);
2251         struct dentry *dentry = NULL, *rehash = NULL;
2252         struct rpc_task *task;
2253         int error = -EBUSY;
2254
2255         if (flags)
2256                 return -EINVAL;
2257
2258         dfprintk(VFS, "NFS: rename(%pd2 -> %pd2, ct=%d)\n",
2259                  old_dentry, new_dentry,
2260                  d_count(new_dentry));
2261
2262         trace_nfs_rename_enter(old_dir, old_dentry, new_dir, new_dentry);
2263         /*
2264          * For non-directories, check whether the target is busy and if so,
2265          * make a copy of the dentry and then do a silly-rename. If the
2266          * silly-rename succeeds, the copied dentry is hashed and becomes
2267          * the new target.
2268          */
2269         if (new_inode && !S_ISDIR(new_inode->i_mode)) {
2270                 /*
2271                  * To prevent any new references to the target during the
2272                  * rename, we unhash the dentry in advance.
2273                  */
2274                 if (!d_unhashed(new_dentry)) {
2275                         d_drop(new_dentry);
2276                         rehash = new_dentry;
2277                 }
2278
2279                 if (d_count(new_dentry) > 2) {
2280                         int err;
2281
2282                         /* copy the target dentry's name */
2283                         dentry = d_alloc(new_dentry->d_parent,
2284                                          &new_dentry->d_name);
2285                         if (!dentry)
2286                                 goto out;
2287
2288                         /* silly-rename the existing target ... */
2289                         err = nfs_sillyrename(new_dir, new_dentry);
2290                         if (err)
2291                                 goto out;
2292
2293                         new_dentry = dentry;
2294                         rehash = NULL;
2295                         new_inode = NULL;
2296                 }
2297         }
2298
2299         task = nfs_async_rename(old_dir, new_dir, old_dentry, new_dentry, NULL);
2300         if (IS_ERR(task)) {
2301                 error = PTR_ERR(task);
2302                 goto out;
2303         }
2304
2305         error = rpc_wait_for_completion_task(task);
2306         if (error != 0) {
2307                 ((struct nfs_renamedata *)task->tk_calldata)->cancelled = 1;
2308                 /* Paired with the atomic_dec_and_test() barrier in rpc_do_put_task() */
2309                 smp_wmb();
2310         } else
2311                 error = task->tk_status;
2312         rpc_put_task(task);
2313         /* Ensure the inode attributes are revalidated */
2314         if (error == 0) {
2315                 spin_lock(&old_inode->i_lock);
2316                 NFS_I(old_inode)->attr_gencount = nfs_inc_attr_generation_counter();
2317                 NFS_I(old_inode)->cache_validity |= NFS_INO_INVALID_CHANGE
2318                         | NFS_INO_INVALID_CTIME
2319                         | NFS_INO_REVAL_FORCED;
2320                 spin_unlock(&old_inode->i_lock);
2321         }
2322 out:
2323         if (rehash)
2324                 d_rehash(rehash);
2325         trace_nfs_rename_exit(old_dir, old_dentry,
2326                         new_dir, new_dentry, error);
2327         if (!error) {
2328                 if (new_inode != NULL)
2329                         nfs_drop_nlink(new_inode);
2330                 /*
2331                  * The d_move() should be here instead of in an async RPC completion
2332                  * handler because we need the proper locks to move the dentry.  If
2333                  * we're interrupted by a signal, the async RPC completion handler
2334                  * should mark the directories for revalidation.
2335                  */
2336                 d_move(old_dentry, new_dentry);
2337                 nfs_set_verifier(old_dentry,
2338                                         nfs_save_change_attribute(new_dir));
2339         } else if (error == -ENOENT)
2340                 nfs_dentry_handle_enoent(old_dentry);
2341
2342         /* new dentry created? */
2343         if (dentry)
2344                 dput(dentry);
2345         return error;
2346 }
2347 EXPORT_SYMBOL_GPL(nfs_rename);
2348
2349 static DEFINE_SPINLOCK(nfs_access_lru_lock);
2350 static LIST_HEAD(nfs_access_lru_list);
2351 static atomic_long_t nfs_access_nr_entries;
2352
2353 static unsigned long nfs_access_max_cachesize = 4*1024*1024;
2354 module_param(nfs_access_max_cachesize, ulong, 0644);
2355 MODULE_PARM_DESC(nfs_access_max_cachesize, "NFS access maximum total cache length");
2356
2357 static void nfs_access_free_entry(struct nfs_access_entry *entry)
2358 {
2359         put_cred(entry->cred);
2360         kfree_rcu(entry, rcu_head);
2361         smp_mb__before_atomic();
2362         atomic_long_dec(&nfs_access_nr_entries);
2363         smp_mb__after_atomic();
2364 }
2365
2366 static void nfs_access_free_list(struct list_head *head)
2367 {
2368         struct nfs_access_entry *cache;
2369
2370         while (!list_empty(head)) {
2371                 cache = list_entry(head->next, struct nfs_access_entry, lru);
2372                 list_del(&cache->lru);
2373                 nfs_access_free_entry(cache);
2374         }
2375 }
2376
2377 static unsigned long
2378 nfs_do_access_cache_scan(unsigned int nr_to_scan)
2379 {
2380         LIST_HEAD(head);
2381         struct nfs_inode *nfsi, *next;
2382         struct nfs_access_entry *cache;
2383         long freed = 0;
2384
2385         spin_lock(&nfs_access_lru_lock);
2386         list_for_each_entry_safe(nfsi, next, &nfs_access_lru_list, access_cache_inode_lru) {
2387                 struct inode *inode;
2388
2389                 if (nr_to_scan-- == 0)
2390                         break;
2391                 inode = &nfsi->vfs_inode;
2392                 spin_lock(&inode->i_lock);
2393                 if (list_empty(&nfsi->access_cache_entry_lru))
2394                         goto remove_lru_entry;
2395                 cache = list_entry(nfsi->access_cache_entry_lru.next,
2396                                 struct nfs_access_entry, lru);
2397                 list_move(&cache->lru, &head);
2398                 rb_erase(&cache->rb_node, &nfsi->access_cache);
2399                 freed++;
2400                 if (!list_empty(&nfsi->access_cache_entry_lru))
2401                         list_move_tail(&nfsi->access_cache_inode_lru,
2402                                         &nfs_access_lru_list);
2403                 else {
2404 remove_lru_entry:
2405                         list_del_init(&nfsi->access_cache_inode_lru);
2406                         smp_mb__before_atomic();
2407                         clear_bit(NFS_INO_ACL_LRU_SET, &nfsi->flags);
2408                         smp_mb__after_atomic();
2409                 }
2410                 spin_unlock(&inode->i_lock);
2411         }
2412         spin_unlock(&nfs_access_lru_lock);
2413         nfs_access_free_list(&head);
2414         return freed;
2415 }
2416
2417 unsigned long
2418 nfs_access_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
2419 {
2420         int nr_to_scan = sc->nr_to_scan;
2421         gfp_t gfp_mask = sc->gfp_mask;
2422
2423         if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
2424                 return SHRINK_STOP;
2425         return nfs_do_access_cache_scan(nr_to_scan);
2426 }
2427
2428
2429 unsigned long
2430 nfs_access_cache_count(struct shrinker *shrink, struct shrink_control *sc)
2431 {
2432         return vfs_pressure_ratio(atomic_long_read(&nfs_access_nr_entries));
2433 }
2434
2435 static void
2436 nfs_access_cache_enforce_limit(void)
2437 {
2438         long nr_entries = atomic_long_read(&nfs_access_nr_entries);
2439         unsigned long diff;
2440         unsigned int nr_to_scan;
2441
2442         if (nr_entries < 0 || nr_entries <= nfs_access_max_cachesize)
2443                 return;
2444         nr_to_scan = 100;
2445         diff = nr_entries - nfs_access_max_cachesize;
2446         if (diff < nr_to_scan)
2447                 nr_to_scan = diff;
2448         nfs_do_access_cache_scan(nr_to_scan);
2449 }
2450
2451 static void __nfs_access_zap_cache(struct nfs_inode *nfsi, struct list_head *head)
2452 {
2453         struct rb_root *root_node = &nfsi->access_cache;
2454         struct rb_node *n;
2455         struct nfs_access_entry *entry;
2456
2457         /* Unhook entries from the cache */
2458         while ((n = rb_first(root_node)) != NULL) {
2459                 entry = rb_entry(n, struct nfs_access_entry, rb_node);
2460                 rb_erase(n, root_node);
2461                 list_move(&entry->lru, head);
2462         }
2463         nfsi->cache_validity &= ~NFS_INO_INVALID_ACCESS;
2464 }
2465
2466 void nfs_access_zap_cache(struct inode *inode)
2467 {
2468         LIST_HEAD(head);
2469
2470         if (test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags) == 0)
2471                 return;
2472         /* Remove from global LRU init */
2473         spin_lock(&nfs_access_lru_lock);
2474         if (test_and_clear_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2475                 list_del_init(&NFS_I(inode)->access_cache_inode_lru);
2476
2477         spin_lock(&inode->i_lock);
2478         __nfs_access_zap_cache(NFS_I(inode), &head);
2479         spin_unlock(&inode->i_lock);
2480         spin_unlock(&nfs_access_lru_lock);
2481         nfs_access_free_list(&head);
2482 }
2483 EXPORT_SYMBOL_GPL(nfs_access_zap_cache);
2484
2485 static struct nfs_access_entry *nfs_access_search_rbtree(struct inode *inode, const struct cred *cred)
2486 {
2487         struct rb_node *n = NFS_I(inode)->access_cache.rb_node;
2488
2489         while (n != NULL) {
2490                 struct nfs_access_entry *entry =
2491                         rb_entry(n, struct nfs_access_entry, rb_node);
2492                 int cmp = cred_fscmp(cred, entry->cred);
2493
2494                 if (cmp < 0)
2495                         n = n->rb_left;
2496                 else if (cmp > 0)
2497                         n = n->rb_right;
2498                 else
2499                         return entry;
2500         }
2501         return NULL;
2502 }
2503
2504 static int nfs_access_get_cached_locked(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res, bool may_block)
2505 {
2506         struct nfs_inode *nfsi = NFS_I(inode);
2507         struct nfs_access_entry *cache;
2508         bool retry = true;
2509         int err;
2510
2511         spin_lock(&inode->i_lock);
2512         for(;;) {
2513                 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2514                         goto out_zap;
2515                 cache = nfs_access_search_rbtree(inode, cred);
2516                 err = -ENOENT;
2517                 if (cache == NULL)
2518                         goto out;
2519                 /* Found an entry, is our attribute cache valid? */
2520                 if (!nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
2521                         break;
2522                 if (!retry)
2523                         break;
2524                 err = -ECHILD;
2525                 if (!may_block)
2526                         goto out;
2527                 spin_unlock(&inode->i_lock);
2528                 err = __nfs_revalidate_inode(NFS_SERVER(inode), inode);
2529                 if (err)
2530                         return err;
2531                 spin_lock(&inode->i_lock);
2532                 retry = false;
2533         }
2534         res->cred = cache->cred;
2535         res->mask = cache->mask;
2536         list_move_tail(&cache->lru, &nfsi->access_cache_entry_lru);
2537         err = 0;
2538 out:
2539         spin_unlock(&inode->i_lock);
2540         return err;
2541 out_zap:
2542         spin_unlock(&inode->i_lock);
2543         nfs_access_zap_cache(inode);
2544         return -ENOENT;
2545 }
2546
2547 static int nfs_access_get_cached_rcu(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res)
2548 {
2549         /* Only check the most recently returned cache entry,
2550          * but do it without locking.
2551          */
2552         struct nfs_inode *nfsi = NFS_I(inode);
2553         struct nfs_access_entry *cache;
2554         int err = -ECHILD;
2555         struct list_head *lh;
2556
2557         rcu_read_lock();
2558         if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2559                 goto out;
2560         lh = rcu_dereference(list_tail_rcu(&nfsi->access_cache_entry_lru));
2561         cache = list_entry(lh, struct nfs_access_entry, lru);
2562         if (lh == &nfsi->access_cache_entry_lru ||
2563             cred_fscmp(cred, cache->cred) != 0)
2564                 cache = NULL;
2565         if (cache == NULL)
2566                 goto out;
2567         if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
2568                 goto out;
2569         res->cred = cache->cred;
2570         res->mask = cache->mask;
2571         err = 0;
2572 out:
2573         rcu_read_unlock();
2574         return err;
2575 }
2576
2577 int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct
2578 nfs_access_entry *res, bool may_block)
2579 {
2580         int status;
2581
2582         status = nfs_access_get_cached_rcu(inode, cred, res);
2583         if (status != 0)
2584                 status = nfs_access_get_cached_locked(inode, cred, res,
2585                     may_block);
2586
2587         return status;
2588 }
2589 EXPORT_SYMBOL_GPL(nfs_access_get_cached);
2590
2591 static void nfs_access_add_rbtree(struct inode *inode, struct nfs_access_entry *set)
2592 {
2593         struct nfs_inode *nfsi = NFS_I(inode);
2594         struct rb_root *root_node = &nfsi->access_cache;
2595         struct rb_node **p = &root_node->rb_node;
2596         struct rb_node *parent = NULL;
2597         struct nfs_access_entry *entry;
2598         int cmp;
2599
2600         spin_lock(&inode->i_lock);
2601         while (*p != NULL) {
2602                 parent = *p;
2603                 entry = rb_entry(parent, struct nfs_access_entry, rb_node);
2604                 cmp = cred_fscmp(set->cred, entry->cred);
2605
2606                 if (cmp < 0)
2607                         p = &parent->rb_left;
2608                 else if (cmp > 0)
2609                         p = &parent->rb_right;
2610                 else
2611                         goto found;
2612         }
2613         rb_link_node(&set->rb_node, parent, p);
2614         rb_insert_color(&set->rb_node, root_node);
2615         list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2616         spin_unlock(&inode->i_lock);
2617         return;
2618 found:
2619         rb_replace_node(parent, &set->rb_node, root_node);
2620         list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2621         list_del(&entry->lru);
2622         spin_unlock(&inode->i_lock);
2623         nfs_access_free_entry(entry);
2624 }
2625
2626 void nfs_access_add_cache(struct inode *inode, struct nfs_access_entry *set)
2627 {
2628         struct nfs_access_entry *cache = kmalloc(sizeof(*cache), GFP_KERNEL);
2629         if (cache == NULL)
2630                 return;
2631         RB_CLEAR_NODE(&cache->rb_node);
2632         cache->cred = get_cred(set->cred);
2633         cache->mask = set->mask;
2634
2635         /* The above field assignments must be visible
2636          * before this item appears on the lru.  We cannot easily
2637          * use rcu_assign_pointer, so just force the memory barrier.
2638          */
2639         smp_wmb();
2640         nfs_access_add_rbtree(inode, cache);
2641
2642         /* Update accounting */
2643         smp_mb__before_atomic();
2644         atomic_long_inc(&nfs_access_nr_entries);
2645         smp_mb__after_atomic();
2646
2647         /* Add inode to global LRU list */
2648         if (!test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags)) {
2649                 spin_lock(&nfs_access_lru_lock);
2650                 if (!test_and_set_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2651                         list_add_tail(&NFS_I(inode)->access_cache_inode_lru,
2652                                         &nfs_access_lru_list);
2653                 spin_unlock(&nfs_access_lru_lock);
2654         }
2655         nfs_access_cache_enforce_limit();
2656 }
2657 EXPORT_SYMBOL_GPL(nfs_access_add_cache);
2658
2659 #define NFS_MAY_READ (NFS_ACCESS_READ)
2660 #define NFS_MAY_WRITE (NFS_ACCESS_MODIFY | \
2661                 NFS_ACCESS_EXTEND | \
2662                 NFS_ACCESS_DELETE)
2663 #define NFS_FILE_MAY_WRITE (NFS_ACCESS_MODIFY | \
2664                 NFS_ACCESS_EXTEND)
2665 #define NFS_DIR_MAY_WRITE NFS_MAY_WRITE
2666 #define NFS_MAY_LOOKUP (NFS_ACCESS_LOOKUP)
2667 #define NFS_MAY_EXECUTE (NFS_ACCESS_EXECUTE)
2668 static int
2669 nfs_access_calc_mask(u32 access_result, umode_t umode)
2670 {
2671         int mask = 0;
2672
2673         if (access_result & NFS_MAY_READ)
2674                 mask |= MAY_READ;
2675         if (S_ISDIR(umode)) {
2676                 if ((access_result & NFS_DIR_MAY_WRITE) == NFS_DIR_MAY_WRITE)
2677                         mask |= MAY_WRITE;
2678                 if ((access_result & NFS_MAY_LOOKUP) == NFS_MAY_LOOKUP)
2679                         mask |= MAY_EXEC;
2680         } else if (S_ISREG(umode)) {
2681                 if ((access_result & NFS_FILE_MAY_WRITE) == NFS_FILE_MAY_WRITE)
2682                         mask |= MAY_WRITE;
2683                 if ((access_result & NFS_MAY_EXECUTE) == NFS_MAY_EXECUTE)
2684                         mask |= MAY_EXEC;
2685         } else if (access_result & NFS_MAY_WRITE)
2686                         mask |= MAY_WRITE;
2687         return mask;
2688 }
2689
2690 void nfs_access_set_mask(struct nfs_access_entry *entry, u32 access_result)
2691 {
2692         entry->mask = access_result;
2693 }
2694 EXPORT_SYMBOL_GPL(nfs_access_set_mask);
2695
2696 static int nfs_do_access(struct inode *inode, const struct cred *cred, int mask)
2697 {
2698         struct nfs_access_entry cache;
2699         bool may_block = (mask & MAY_NOT_BLOCK) == 0;
2700         int cache_mask = -1;
2701         int status;
2702
2703         trace_nfs_access_enter(inode);
2704
2705         status = nfs_access_get_cached(inode, cred, &cache, may_block);
2706         if (status == 0)
2707                 goto out_cached;
2708
2709         status = -ECHILD;
2710         if (!may_block)
2711                 goto out;
2712
2713         /*
2714          * Determine which access bits we want to ask for...
2715          */
2716         cache.mask = NFS_ACCESS_READ | NFS_ACCESS_MODIFY | NFS_ACCESS_EXTEND;
2717         if (nfs_server_capable(inode, NFS_CAP_XATTR)) {
2718                 cache.mask |= NFS_ACCESS_XAREAD | NFS_ACCESS_XAWRITE |
2719                     NFS_ACCESS_XALIST;
2720         }
2721         if (S_ISDIR(inode->i_mode))
2722                 cache.mask |= NFS_ACCESS_DELETE | NFS_ACCESS_LOOKUP;
2723         else
2724                 cache.mask |= NFS_ACCESS_EXECUTE;
2725         cache.cred = cred;
2726         status = NFS_PROTO(inode)->access(inode, &cache);
2727         if (status != 0) {
2728                 if (status == -ESTALE) {
2729                         if (!S_ISDIR(inode->i_mode))
2730                                 nfs_set_inode_stale(inode);
2731                         else
2732                                 nfs_zap_caches(inode);
2733                 }
2734                 goto out;
2735         }
2736         nfs_access_add_cache(inode, &cache);
2737 out_cached:
2738         cache_mask = nfs_access_calc_mask(cache.mask, inode->i_mode);
2739         if ((mask & ~cache_mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) != 0)
2740                 status = -EACCES;
2741 out:
2742         trace_nfs_access_exit(inode, mask, cache_mask, status);
2743         return status;
2744 }
2745
2746 static int nfs_open_permission_mask(int openflags)
2747 {
2748         int mask = 0;
2749
2750         if (openflags & __FMODE_EXEC) {
2751                 /* ONLY check exec rights */
2752                 mask = MAY_EXEC;
2753         } else {
2754                 if ((openflags & O_ACCMODE) != O_WRONLY)
2755                         mask |= MAY_READ;
2756                 if ((openflags & O_ACCMODE) != O_RDONLY)
2757                         mask |= MAY_WRITE;
2758         }
2759
2760         return mask;
2761 }
2762
2763 int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags)
2764 {
2765         return nfs_do_access(inode, cred, nfs_open_permission_mask(openflags));
2766 }
2767 EXPORT_SYMBOL_GPL(nfs_may_open);
2768
2769 static int nfs_execute_ok(struct inode *inode, int mask)
2770 {
2771         struct nfs_server *server = NFS_SERVER(inode);
2772         int ret = 0;
2773
2774         if (S_ISDIR(inode->i_mode))
2775                 return 0;
2776         if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_OTHER)) {
2777                 if (mask & MAY_NOT_BLOCK)
2778                         return -ECHILD;
2779                 ret = __nfs_revalidate_inode(server, inode);
2780         }
2781         if (ret == 0 && !execute_ok(inode))
2782                 ret = -EACCES;
2783         return ret;
2784 }
2785
2786 int nfs_permission(struct inode *inode, int mask)
2787 {
2788         const struct cred *cred = current_cred();
2789         int res = 0;
2790
2791         nfs_inc_stats(inode, NFSIOS_VFSACCESS);
2792
2793         if ((mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
2794                 goto out;
2795         /* Is this sys_access() ? */
2796         if (mask & (MAY_ACCESS | MAY_CHDIR))
2797                 goto force_lookup;
2798
2799         switch (inode->i_mode & S_IFMT) {
2800                 case S_IFLNK:
2801                         goto out;
2802                 case S_IFREG:
2803                         if ((mask & MAY_OPEN) &&
2804                            nfs_server_capable(inode, NFS_CAP_ATOMIC_OPEN))
2805                                 return 0;
2806                         break;
2807                 case S_IFDIR:
2808                         /*
2809                          * Optimize away all write operations, since the server
2810                          * will check permissions when we perform the op.
2811                          */
2812                         if ((mask & MAY_WRITE) && !(mask & MAY_READ))
2813                                 goto out;
2814         }
2815
2816 force_lookup:
2817         if (!NFS_PROTO(inode)->access)
2818                 goto out_notsup;
2819
2820         res = nfs_do_access(inode, cred, mask);
2821 out:
2822         if (!res && (mask & MAY_EXEC))
2823                 res = nfs_execute_ok(inode, mask);
2824
2825         dfprintk(VFS, "NFS: permission(%s/%lu), mask=0x%x, res=%d\n",
2826                 inode->i_sb->s_id, inode->i_ino, mask, res);
2827         return res;
2828 out_notsup:
2829         if (mask & MAY_NOT_BLOCK)
2830                 return -ECHILD;
2831
2832         res = nfs_revalidate_inode(NFS_SERVER(inode), inode);
2833         if (res == 0)
2834                 res = generic_permission(inode, mask);
2835         goto out;
2836 }
2837 EXPORT_SYMBOL_GPL(nfs_permission);
2838
2839 /*
2840  * Local variables:
2841  *  version-control: t
2842  *  kept-new-versions: 5
2843  * End:
2844  */