1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 1992 Rick Sladkey
7 * nfs directory handling functions
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
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>
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>
42 #include "delegation.h"
49 /* #define NFS_DEBUG_VERBOSE 1 */
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*);
58 const struct file_operations nfs_dir_operations = {
59 .llseek = nfs_llseek_dir,
60 .read = generic_read_dir,
61 .iterate_shared = nfs_readdir,
63 .release = nfs_closedir,
64 .fsync = nfs_fsync_dir,
67 const struct address_space_operations nfs_dir_aops = {
68 .freepage = nfs_readdir_clear_array,
71 static struct nfs_open_dir_context *alloc_nfs_open_dir_context(struct inode *dir)
73 struct nfs_inode *nfsi = NFS_I(dir);
74 struct nfs_open_dir_context *ctx;
75 ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
78 ctx->attr_gencount = nfsi->attr_gencount;
81 spin_lock(&dir->i_lock);
82 if (list_empty(&nfsi->open_files) &&
83 (nfsi->cache_validity & NFS_INO_DATA_INVAL_DEFER))
84 nfs_set_cache_invalid(dir,
85 NFS_INO_INVALID_DATA |
86 NFS_INO_REVAL_FORCED);
87 list_add(&ctx->list, &nfsi->open_files);
88 spin_unlock(&dir->i_lock);
91 return ERR_PTR(-ENOMEM);
94 static void put_nfs_open_dir_context(struct inode *dir, struct nfs_open_dir_context *ctx)
96 spin_lock(&dir->i_lock);
98 spin_unlock(&dir->i_lock);
106 nfs_opendir(struct inode *inode, struct file *filp)
109 struct nfs_open_dir_context *ctx;
111 dfprintk(FILE, "NFS: open dir(%pD2)\n", filp);
113 nfs_inc_stats(inode, NFSIOS_VFSOPEN);
115 ctx = alloc_nfs_open_dir_context(inode);
120 filp->private_data = ctx;
126 nfs_closedir(struct inode *inode, struct file *filp)
128 put_nfs_open_dir_context(file_inode(filp), filp->private_data);
132 struct nfs_cache_array_entry {
136 unsigned int name_len;
137 unsigned char d_type;
140 struct nfs_cache_array {
143 unsigned char page_full : 1,
145 cookies_are_ordered : 1;
146 struct nfs_cache_array_entry array[];
149 struct nfs_readdir_descriptor {
152 struct dir_context *ctx;
157 loff_t current_index;
160 __be32 verf[NFS_DIR_VERIFIER_SIZE];
161 unsigned long dir_verifier;
162 unsigned long timestamp;
163 unsigned long gencount;
164 unsigned long attr_gencount;
165 unsigned int cache_entry_index;
171 static void nfs_readdir_array_init(struct nfs_cache_array *array)
173 memset(array, 0, sizeof(struct nfs_cache_array));
176 static void nfs_readdir_page_init_array(struct page *page, u64 last_cookie)
178 struct nfs_cache_array *array;
180 array = kmap_atomic(page);
181 nfs_readdir_array_init(array);
182 array->last_cookie = last_cookie;
183 array->cookies_are_ordered = 1;
184 kunmap_atomic(array);
188 * we are freeing strings created by nfs_add_to_readdir_array()
191 void nfs_readdir_clear_array(struct page *page)
193 struct nfs_cache_array *array;
196 array = kmap_atomic(page);
197 for (i = 0; i < array->size; i++)
198 kfree(array->array[i].name);
199 nfs_readdir_array_init(array);
200 kunmap_atomic(array);
204 nfs_readdir_page_array_alloc(u64 last_cookie, gfp_t gfp_flags)
206 struct page *page = alloc_page(gfp_flags);
208 nfs_readdir_page_init_array(page, last_cookie);
212 static void nfs_readdir_page_array_free(struct page *page)
215 nfs_readdir_clear_array(page);
220 static void nfs_readdir_array_set_eof(struct nfs_cache_array *array)
222 array->page_is_eof = 1;
223 array->page_full = 1;
226 static bool nfs_readdir_array_is_full(struct nfs_cache_array *array)
228 return array->page_full;
232 * the caller is responsible for freeing qstr.name
233 * when called by nfs_readdir_add_to_array, the strings will be freed in
234 * nfs_clear_readdir_array()
236 static const char *nfs_readdir_copy_name(const char *name, unsigned int len)
238 const char *ret = kmemdup_nul(name, len, GFP_KERNEL);
241 * Avoid a kmemleak false positive. The pointer to the name is stored
242 * in a page cache page which kmemleak does not scan.
245 kmemleak_not_leak(ret);
250 * Check that the next array entry lies entirely within the page bounds
252 static int nfs_readdir_array_can_expand(struct nfs_cache_array *array)
254 struct nfs_cache_array_entry *cache_entry;
256 if (array->page_full)
258 cache_entry = &array->array[array->size + 1];
259 if ((char *)cache_entry - (char *)array > PAGE_SIZE) {
260 array->page_full = 1;
267 int nfs_readdir_add_to_array(struct nfs_entry *entry, struct page *page)
269 struct nfs_cache_array *array;
270 struct nfs_cache_array_entry *cache_entry;
274 name = nfs_readdir_copy_name(entry->name, entry->len);
278 array = kmap_atomic(page);
279 ret = nfs_readdir_array_can_expand(array);
285 cache_entry = &array->array[array->size];
286 cache_entry->cookie = entry->prev_cookie;
287 cache_entry->ino = entry->ino;
288 cache_entry->d_type = entry->d_type;
289 cache_entry->name_len = entry->len;
290 cache_entry->name = name;
291 array->last_cookie = entry->cookie;
292 if (array->last_cookie <= cache_entry->cookie)
293 array->cookies_are_ordered = 0;
296 nfs_readdir_array_set_eof(array);
298 kunmap_atomic(array);
302 static struct page *nfs_readdir_page_get_locked(struct address_space *mapping,
303 pgoff_t index, u64 last_cookie)
307 page = grab_cache_page(mapping, index);
308 if (page && !PageUptodate(page)) {
309 nfs_readdir_page_init_array(page, last_cookie);
310 if (invalidate_inode_pages2_range(mapping, index + 1, -1) < 0)
311 nfs_zap_mapping(mapping->host, mapping);
312 SetPageUptodate(page);
318 static u64 nfs_readdir_page_last_cookie(struct page *page)
320 struct nfs_cache_array *array;
323 array = kmap_atomic(page);
324 ret = array->last_cookie;
325 kunmap_atomic(array);
329 static bool nfs_readdir_page_needs_filling(struct page *page)
331 struct nfs_cache_array *array;
334 array = kmap_atomic(page);
335 ret = !nfs_readdir_array_is_full(array);
336 kunmap_atomic(array);
340 static void nfs_readdir_page_set_eof(struct page *page)
342 struct nfs_cache_array *array;
344 array = kmap_atomic(page);
345 nfs_readdir_array_set_eof(array);
346 kunmap_atomic(array);
349 static void nfs_readdir_page_unlock_and_put(struct page *page)
355 static struct page *nfs_readdir_page_get_next(struct address_space *mapping,
356 pgoff_t index, u64 cookie)
360 page = nfs_readdir_page_get_locked(mapping, index, cookie);
362 if (nfs_readdir_page_last_cookie(page) == cookie)
364 nfs_readdir_page_unlock_and_put(page);
370 int is_32bit_api(void)
373 return in_compat_syscall();
375 return (BITS_PER_LONG == 32);
380 bool nfs_readdir_use_cookie(const struct file *filp)
382 if ((filp->f_mode & FMODE_32BITHASH) ||
383 (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
388 static int nfs_readdir_search_for_pos(struct nfs_cache_array *array,
389 struct nfs_readdir_descriptor *desc)
391 loff_t diff = desc->ctx->pos - desc->current_index;
396 if (diff >= array->size) {
397 if (array->page_is_eof)
402 index = (unsigned int)diff;
403 desc->dir_cookie = array->array[index].cookie;
404 desc->cache_entry_index = index;
412 nfs_readdir_inode_mapping_valid(struct nfs_inode *nfsi)
414 if (nfsi->cache_validity & (NFS_INO_INVALID_ATTR|NFS_INO_INVALID_DATA))
417 return !test_bit(NFS_INO_INVALIDATING, &nfsi->flags);
420 static bool nfs_readdir_array_cookie_in_range(struct nfs_cache_array *array,
423 if (!array->cookies_are_ordered)
425 /* Optimisation for monotonically increasing cookies */
426 if (cookie >= array->last_cookie)
428 if (array->size && cookie < array->array[0].cookie)
433 static int nfs_readdir_search_for_cookie(struct nfs_cache_array *array,
434 struct nfs_readdir_descriptor *desc)
438 int status = -EAGAIN;
440 if (!nfs_readdir_array_cookie_in_range(array, desc->dir_cookie))
443 for (i = 0; i < array->size; i++) {
444 if (array->array[i].cookie == desc->dir_cookie) {
445 struct nfs_inode *nfsi = NFS_I(file_inode(desc->file));
447 new_pos = desc->current_index + i;
448 if (desc->attr_gencount != nfsi->attr_gencount ||
449 !nfs_readdir_inode_mapping_valid(nfsi)) {
451 desc->attr_gencount = nfsi->attr_gencount;
452 } else if (new_pos < desc->prev_index) {
454 && desc->dup_cookie == desc->dir_cookie) {
455 if (printk_ratelimit()) {
456 pr_notice("NFS: directory %pD2 contains a readdir loop."
457 "Please contact your server vendor. "
458 "The file: %s has duplicate cookie %llu\n",
459 desc->file, array->array[i].name, desc->dir_cookie);
464 desc->dup_cookie = desc->dir_cookie;
467 if (nfs_readdir_use_cookie(desc->file))
468 desc->ctx->pos = desc->dir_cookie;
470 desc->ctx->pos = new_pos;
471 desc->prev_index = new_pos;
472 desc->cache_entry_index = i;
477 if (array->page_is_eof) {
478 status = -EBADCOOKIE;
479 if (desc->dir_cookie == array->last_cookie)
486 static int nfs_readdir_search_array(struct nfs_readdir_descriptor *desc)
488 struct nfs_cache_array *array;
491 array = kmap_atomic(desc->page);
493 if (desc->dir_cookie == 0)
494 status = nfs_readdir_search_for_pos(array, desc);
496 status = nfs_readdir_search_for_cookie(array, desc);
498 if (status == -EAGAIN) {
499 desc->last_cookie = array->last_cookie;
500 desc->current_index += array->size;
503 kunmap_atomic(array);
507 /* Fill a page with xdr information before transferring to the cache page */
508 static int nfs_readdir_xdr_filler(struct nfs_readdir_descriptor *desc,
509 __be32 *verf, u64 cookie,
510 struct page **pages, size_t bufsize,
513 struct inode *inode = file_inode(desc->file);
514 struct nfs_readdir_arg arg = {
515 .dentry = file_dentry(desc->file),
516 .cred = desc->file->f_cred,
523 struct nfs_readdir_res res = {
526 unsigned long timestamp, gencount;
531 gencount = nfs_inc_attr_generation_counter();
532 desc->dir_verifier = nfs_save_change_attribute(inode);
533 error = NFS_PROTO(inode)->readdir(&arg, &res);
535 /* We requested READDIRPLUS, but the server doesn't grok it */
536 if (error == -ENOTSUPP && desc->plus) {
537 NFS_SERVER(inode)->caps &= ~NFS_CAP_READDIRPLUS;
538 clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
539 desc->plus = arg.plus = false;
544 desc->timestamp = timestamp;
545 desc->gencount = gencount;
550 static int xdr_decode(struct nfs_readdir_descriptor *desc,
551 struct nfs_entry *entry, struct xdr_stream *xdr)
553 struct inode *inode = file_inode(desc->file);
556 error = NFS_PROTO(inode)->decode_dirent(xdr, entry, desc->plus);
559 entry->fattr->time_start = desc->timestamp;
560 entry->fattr->gencount = desc->gencount;
564 /* Match file and dirent using either filehandle or fileid
565 * Note: caller is responsible for checking the fsid
568 int nfs_same_file(struct dentry *dentry, struct nfs_entry *entry)
571 struct nfs_inode *nfsi;
573 if (d_really_is_negative(dentry))
576 inode = d_inode(dentry);
577 if (is_bad_inode(inode) || NFS_STALE(inode))
581 if (entry->fattr->fileid != nfsi->fileid)
583 if (entry->fh->size && nfs_compare_fh(entry->fh, &nfsi->fh) != 0)
589 bool nfs_use_readdirplus(struct inode *dir, struct dir_context *ctx)
591 if (!nfs_server_capable(dir, NFS_CAP_READDIRPLUS))
593 if (test_and_clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(dir)->flags))
601 * This function is called by the lookup and getattr code to request the
602 * use of readdirplus to accelerate any future lookups in the same
605 void nfs_advise_use_readdirplus(struct inode *dir)
607 struct nfs_inode *nfsi = NFS_I(dir);
609 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
610 !list_empty(&nfsi->open_files))
611 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
615 * This function is mainly for use by nfs_getattr().
617 * If this is an 'ls -l', we want to force use of readdirplus.
618 * Do this by checking if there is an active file descriptor
619 * and calling nfs_advise_use_readdirplus, then forcing a
622 void nfs_force_use_readdirplus(struct inode *dir)
624 struct nfs_inode *nfsi = NFS_I(dir);
626 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
627 !list_empty(&nfsi->open_files)) {
628 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
629 invalidate_mapping_pages(dir->i_mapping,
630 nfsi->page_index + 1, -1);
635 void nfs_prime_dcache(struct dentry *parent, struct nfs_entry *entry,
636 unsigned long dir_verifier)
638 struct qstr filename = QSTR_INIT(entry->name, entry->len);
639 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
640 struct dentry *dentry;
641 struct dentry *alias;
645 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FILEID))
647 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FSID))
649 if (filename.len == 0)
651 /* Validate that the name doesn't contain any illegal '\0' */
652 if (strnlen(filename.name, filename.len) != filename.len)
655 if (strnchr(filename.name, filename.len, '/'))
657 if (filename.name[0] == '.') {
658 if (filename.len == 1)
660 if (filename.len == 2 && filename.name[1] == '.')
663 filename.hash = full_name_hash(parent, filename.name, filename.len);
665 dentry = d_lookup(parent, &filename);
668 dentry = d_alloc_parallel(parent, &filename, &wq);
672 if (!d_in_lookup(dentry)) {
673 /* Is there a mountpoint here? If so, just exit */
674 if (!nfs_fsid_equal(&NFS_SB(dentry->d_sb)->fsid,
675 &entry->fattr->fsid))
677 if (nfs_same_file(dentry, entry)) {
678 if (!entry->fh->size)
680 nfs_set_verifier(dentry, dir_verifier);
681 status = nfs_refresh_inode(d_inode(dentry), entry->fattr);
683 nfs_setsecurity(d_inode(dentry), entry->fattr, entry->label);
686 d_invalidate(dentry);
692 if (!entry->fh->size) {
693 d_lookup_done(dentry);
697 inode = nfs_fhget(dentry->d_sb, entry->fh, entry->fattr, entry->label);
698 alias = d_splice_alias(inode, dentry);
699 d_lookup_done(dentry);
706 nfs_set_verifier(dentry, dir_verifier);
711 /* Perform conversion from xdr to cache array */
712 static int nfs_readdir_page_filler(struct nfs_readdir_descriptor *desc,
713 struct nfs_entry *entry,
714 struct page **xdr_pages,
716 struct page **arrays,
719 struct address_space *mapping = desc->file->f_mapping;
720 struct xdr_stream stream;
722 struct page *scratch, *new, *page = *arrays;
725 scratch = alloc_page(GFP_KERNEL);
729 xdr_init_decode_pages(&stream, &buf, xdr_pages, buflen);
730 xdr_set_scratch_page(&stream, scratch);
734 entry->label->len = NFS4_MAXLABELLEN;
736 status = xdr_decode(desc, entry, &stream);
741 nfs_prime_dcache(file_dentry(desc->file), entry,
744 status = nfs_readdir_add_to_array(entry, page);
745 if (status != -ENOSPC)
748 if (page->mapping != mapping) {
751 new = nfs_readdir_page_array_alloc(entry->prev_cookie,
756 *arrays = page = new;
758 new = nfs_readdir_page_get_next(mapping,
764 nfs_readdir_page_unlock_and_put(page);
767 status = nfs_readdir_add_to_array(entry, page);
768 } while (!status && !entry->eof);
773 nfs_readdir_page_set_eof(page);
784 nfs_readdir_page_unlock_and_put(page);
790 static void nfs_readdir_free_pages(struct page **pages, size_t npages)
793 put_page(pages[npages]);
798 * nfs_readdir_alloc_pages() will allocate pages that must be freed with a call
799 * to nfs_readdir_free_pages()
801 static struct page **nfs_readdir_alloc_pages(size_t npages)
806 pages = kmalloc_array(npages, sizeof(*pages), GFP_KERNEL);
809 for (i = 0; i < npages; i++) {
810 struct page *page = alloc_page(GFP_KERNEL);
818 nfs_readdir_free_pages(pages, i);
822 static int nfs_readdir_xdr_to_array(struct nfs_readdir_descriptor *desc,
823 __be32 *verf_arg, __be32 *verf_res,
824 struct page **arrays, size_t narrays)
827 struct page *page = *arrays;
828 struct nfs_entry *entry;
830 struct inode *inode = file_inode(desc->file);
831 size_t dtsize = NFS_SERVER(inode)->dtsize;
832 int status = -ENOMEM;
834 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
837 entry->cookie = nfs_readdir_page_last_cookie(page);
838 entry->fh = nfs_alloc_fhandle();
839 entry->fattr = nfs_alloc_fattr();
840 entry->server = NFS_SERVER(inode);
841 if (entry->fh == NULL || entry->fattr == NULL)
844 entry->label = nfs4_label_alloc(NFS_SERVER(inode), GFP_NOWAIT);
845 if (IS_ERR(entry->label)) {
846 status = PTR_ERR(entry->label);
850 array_size = (dtsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
851 pages = nfs_readdir_alloc_pages(array_size);
853 goto out_release_label;
857 status = nfs_readdir_xdr_filler(desc, verf_arg, entry->cookie,
865 nfs_readdir_page_set_eof(page);
871 status = nfs_readdir_page_filler(desc, entry, pages, pglen,
873 } while (!status && nfs_readdir_page_needs_filling(page));
875 nfs_readdir_free_pages(pages, array_size);
877 nfs4_label_free(entry->label);
879 nfs_free_fattr(entry->fattr);
880 nfs_free_fhandle(entry->fh);
885 static void nfs_readdir_page_put(struct nfs_readdir_descriptor *desc)
887 put_page(desc->page);
892 nfs_readdir_page_unlock_and_put_cached(struct nfs_readdir_descriptor *desc)
894 unlock_page(desc->page);
895 nfs_readdir_page_put(desc);
899 nfs_readdir_page_get_cached(struct nfs_readdir_descriptor *desc)
901 return nfs_readdir_page_get_locked(desc->file->f_mapping,
907 * Returns 0 if desc->dir_cookie was found on page desc->page_index
908 * and locks the page to prevent removal from the page cache.
910 static int find_and_lock_cache_page(struct nfs_readdir_descriptor *desc)
912 struct inode *inode = file_inode(desc->file);
913 struct nfs_inode *nfsi = NFS_I(inode);
914 __be32 verf[NFS_DIR_VERIFIER_SIZE];
917 desc->page = nfs_readdir_page_get_cached(desc);
920 if (nfs_readdir_page_needs_filling(desc->page)) {
921 res = nfs_readdir_xdr_to_array(desc, nfsi->cookieverf, verf,
924 nfs_readdir_page_unlock_and_put_cached(desc);
925 if (res == -EBADCOOKIE || res == -ENOTSYNC) {
926 invalidate_inode_pages2(desc->file->f_mapping);
927 desc->page_index = 0;
933 * Set the cookie verifier if the page cache was empty
935 if (desc->page_index == 0)
936 memcpy(nfsi->cookieverf, verf,
937 sizeof(nfsi->cookieverf));
939 res = nfs_readdir_search_array(desc);
941 nfsi->page_index = desc->page_index;
944 nfs_readdir_page_unlock_and_put_cached(desc);
948 static bool nfs_readdir_dont_search_cache(struct nfs_readdir_descriptor *desc)
950 struct address_space *mapping = desc->file->f_mapping;
951 struct inode *dir = file_inode(desc->file);
952 unsigned int dtsize = NFS_SERVER(dir)->dtsize;
953 loff_t size = i_size_read(dir);
956 * Default to uncached readdir if the page cache is empty, and
957 * we're looking for a non-zero cookie in a large directory.
959 return desc->dir_cookie != 0 && mapping->nrpages == 0 && size > dtsize;
962 /* Search for desc->dir_cookie from the beginning of the page cache */
963 static int readdir_search_pagecache(struct nfs_readdir_descriptor *desc)
967 if (nfs_readdir_dont_search_cache(desc))
971 if (desc->page_index == 0) {
972 desc->current_index = 0;
973 desc->prev_index = 0;
974 desc->last_cookie = 0;
976 res = find_and_lock_cache_page(desc);
977 } while (res == -EAGAIN);
982 * Once we've found the start of the dirent within a page: fill 'er up...
984 static void nfs_do_filldir(struct nfs_readdir_descriptor *desc,
987 struct file *file = desc->file;
988 struct nfs_cache_array *array;
991 array = kmap(desc->page);
992 for (i = desc->cache_entry_index; i < array->size; i++) {
993 struct nfs_cache_array_entry *ent;
995 ent = &array->array[i];
996 if (!dir_emit(desc->ctx, ent->name, ent->name_len,
997 nfs_compat_user_ino64(ent->ino), ent->d_type)) {
1001 memcpy(desc->verf, verf, sizeof(desc->verf));
1002 if (i < (array->size-1))
1003 desc->dir_cookie = array->array[i+1].cookie;
1005 desc->dir_cookie = array->last_cookie;
1006 if (nfs_readdir_use_cookie(file))
1007 desc->ctx->pos = desc->dir_cookie;
1010 if (desc->duped != 0)
1013 if (array->page_is_eof)
1017 dfprintk(DIRCACHE, "NFS: nfs_do_filldir() filling ended @ cookie %llu\n",
1018 (unsigned long long)desc->dir_cookie);
1022 * If we cannot find a cookie in our cache, we suspect that this is
1023 * because it points to a deleted file, so we ask the server to return
1024 * whatever it thinks is the next entry. We then feed this to filldir.
1025 * If all goes well, we should then be able to find our way round the
1026 * cache on the next call to readdir_search_pagecache();
1028 * NOTE: we cannot add the anonymous page to the pagecache because
1029 * the data it contains might not be page aligned. Besides,
1030 * we should already have a complete representation of the
1031 * directory in the page cache by the time we get here.
1033 static int uncached_readdir(struct nfs_readdir_descriptor *desc)
1035 struct page **arrays;
1037 __be32 verf[NFS_DIR_VERIFIER_SIZE];
1038 int status = -ENOMEM;
1040 dfprintk(DIRCACHE, "NFS: uncached_readdir() searching for cookie %llu\n",
1041 (unsigned long long)desc->dir_cookie);
1043 arrays = kcalloc(sz, sizeof(*arrays), GFP_KERNEL);
1046 arrays[0] = nfs_readdir_page_array_alloc(desc->dir_cookie, GFP_KERNEL);
1050 desc->page_index = 0;
1051 desc->last_cookie = desc->dir_cookie;
1054 status = nfs_readdir_xdr_to_array(desc, desc->verf, verf, arrays, sz);
1056 for (i = 0; !desc->eof && i < sz && arrays[i]; i++) {
1057 desc->page = arrays[i];
1058 nfs_do_filldir(desc, verf);
1063 for (i = 0; i < sz && arrays[i]; i++)
1064 nfs_readdir_page_array_free(arrays[i]);
1067 dfprintk(DIRCACHE, "NFS: %s: returns %d\n", __func__, status);
1071 /* The file offset position represents the dirent entry number. A
1072 last cookie cache takes care of the common case of reading the
1075 static int nfs_readdir(struct file *file, struct dir_context *ctx)
1077 struct dentry *dentry = file_dentry(file);
1078 struct inode *inode = d_inode(dentry);
1079 struct nfs_inode *nfsi = NFS_I(inode);
1080 struct nfs_open_dir_context *dir_ctx = file->private_data;
1081 struct nfs_readdir_descriptor *desc;
1084 dfprintk(FILE, "NFS: readdir(%pD2) starting at cookie %llu\n",
1085 file, (long long)ctx->pos);
1086 nfs_inc_stats(inode, NFSIOS_VFSGETDENTS);
1089 * ctx->pos points to the dirent entry number.
1090 * *desc->dir_cookie has the cookie for the next entry. We have
1091 * to either find the entry with the appropriate number or
1092 * revalidate the cookie.
1094 if (ctx->pos == 0 || nfs_attribute_cache_expired(inode)) {
1095 res = nfs_revalidate_mapping(inode, file->f_mapping);
1101 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
1106 desc->plus = nfs_use_readdirplus(inode, ctx);
1108 spin_lock(&file->f_lock);
1109 desc->dir_cookie = dir_ctx->dir_cookie;
1110 desc->dup_cookie = dir_ctx->dup_cookie;
1111 desc->duped = dir_ctx->duped;
1112 desc->attr_gencount = dir_ctx->attr_gencount;
1113 memcpy(desc->verf, dir_ctx->verf, sizeof(desc->verf));
1114 spin_unlock(&file->f_lock);
1117 res = readdir_search_pagecache(desc);
1119 if (res == -EBADCOOKIE) {
1121 /* This means either end of directory */
1122 if (desc->dir_cookie && !desc->eof) {
1123 /* Or that the server has 'lost' a cookie */
1124 res = uncached_readdir(desc);
1127 if (res == -EBADCOOKIE || res == -ENOTSYNC)
1132 if (res == -ETOOSMALL && desc->plus) {
1133 clear_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
1134 nfs_zap_caches(inode);
1135 desc->page_index = 0;
1143 nfs_do_filldir(desc, nfsi->cookieverf);
1144 nfs_readdir_page_unlock_and_put_cached(desc);
1145 } while (!desc->eof);
1147 spin_lock(&file->f_lock);
1148 dir_ctx->dir_cookie = desc->dir_cookie;
1149 dir_ctx->dup_cookie = desc->dup_cookie;
1150 dir_ctx->duped = desc->duped;
1151 dir_ctx->attr_gencount = desc->attr_gencount;
1152 memcpy(dir_ctx->verf, desc->verf, sizeof(dir_ctx->verf));
1153 spin_unlock(&file->f_lock);
1158 dfprintk(FILE, "NFS: readdir(%pD2) returns %d\n", file, res);
1162 static loff_t nfs_llseek_dir(struct file *filp, loff_t offset, int whence)
1164 struct nfs_open_dir_context *dir_ctx = filp->private_data;
1166 dfprintk(FILE, "NFS: llseek dir(%pD2, %lld, %d)\n",
1167 filp, offset, whence);
1175 spin_lock(&filp->f_lock);
1180 spin_lock(&filp->f_lock);
1181 offset += filp->f_pos;
1183 spin_unlock(&filp->f_lock);
1187 if (offset != filp->f_pos) {
1188 filp->f_pos = offset;
1189 if (nfs_readdir_use_cookie(filp))
1190 dir_ctx->dir_cookie = offset;
1192 dir_ctx->dir_cookie = 0;
1194 memset(dir_ctx->verf, 0, sizeof(dir_ctx->verf));
1197 spin_unlock(&filp->f_lock);
1202 * All directory operations under NFS are synchronous, so fsync()
1203 * is a dummy operation.
1205 static int nfs_fsync_dir(struct file *filp, loff_t start, loff_t end,
1208 dfprintk(FILE, "NFS: fsync dir(%pD2) datasync %d\n", filp, datasync);
1210 nfs_inc_stats(file_inode(filp), NFSIOS_VFSFSYNC);
1215 * nfs_force_lookup_revalidate - Mark the directory as having changed
1216 * @dir: pointer to directory inode
1218 * This forces the revalidation code in nfs_lookup_revalidate() to do a
1219 * full lookup on all child dentries of 'dir' whenever a change occurs
1220 * on the server that might have invalidated our dcache.
1222 * Note that we reserve bit '0' as a tag to let us know when a dentry
1223 * was revalidated while holding a delegation on its inode.
1225 * The caller should be holding dir->i_lock
1227 void nfs_force_lookup_revalidate(struct inode *dir)
1229 NFS_I(dir)->cache_change_attribute += 2;
1231 EXPORT_SYMBOL_GPL(nfs_force_lookup_revalidate);
1234 * nfs_verify_change_attribute - Detects NFS remote directory changes
1235 * @dir: pointer to parent directory inode
1236 * @verf: previously saved change attribute
1238 * Return "false" if the verifiers doesn't match the change attribute.
1239 * This would usually indicate that the directory contents have changed on
1240 * the server, and that any dentries need revalidating.
1242 static bool nfs_verify_change_attribute(struct inode *dir, unsigned long verf)
1244 return (verf & ~1UL) == nfs_save_change_attribute(dir);
1247 static void nfs_set_verifier_delegated(unsigned long *verf)
1252 #if IS_ENABLED(CONFIG_NFS_V4)
1253 static void nfs_unset_verifier_delegated(unsigned long *verf)
1257 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
1259 static bool nfs_test_verifier_delegated(unsigned long verf)
1264 static bool nfs_verifier_is_delegated(struct dentry *dentry)
1266 return nfs_test_verifier_delegated(dentry->d_time);
1269 static void nfs_set_verifier_locked(struct dentry *dentry, unsigned long verf)
1271 struct inode *inode = d_inode(dentry);
1273 if (!nfs_verifier_is_delegated(dentry) &&
1274 !nfs_verify_change_attribute(d_inode(dentry->d_parent), verf))
1276 if (inode && NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
1277 nfs_set_verifier_delegated(&verf);
1279 dentry->d_time = verf;
1283 * nfs_set_verifier - save a parent directory verifier in the dentry
1284 * @dentry: pointer to dentry
1285 * @verf: verifier to save
1287 * Saves the parent directory verifier in @dentry. If the inode has
1288 * a delegation, we also tag the dentry as having been revalidated
1289 * while holding a delegation so that we know we don't have to
1290 * look it up again after a directory change.
1292 void nfs_set_verifier(struct dentry *dentry, unsigned long verf)
1295 spin_lock(&dentry->d_lock);
1296 nfs_set_verifier_locked(dentry, verf);
1297 spin_unlock(&dentry->d_lock);
1299 EXPORT_SYMBOL_GPL(nfs_set_verifier);
1301 #if IS_ENABLED(CONFIG_NFS_V4)
1303 * nfs_clear_verifier_delegated - clear the dir verifier delegation tag
1304 * @inode: pointer to inode
1306 * Iterates through the dentries in the inode alias list and clears
1307 * the tag used to indicate that the dentry has been revalidated
1308 * while holding a delegation.
1309 * This function is intended for use when the delegation is being
1310 * returned or revoked.
1312 void nfs_clear_verifier_delegated(struct inode *inode)
1314 struct dentry *alias;
1318 spin_lock(&inode->i_lock);
1319 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
1320 spin_lock(&alias->d_lock);
1321 nfs_unset_verifier_delegated(&alias->d_time);
1322 spin_unlock(&alias->d_lock);
1324 spin_unlock(&inode->i_lock);
1326 EXPORT_SYMBOL_GPL(nfs_clear_verifier_delegated);
1327 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
1330 * A check for whether or not the parent directory has changed.
1331 * In the case it has, we assume that the dentries are untrustworthy
1332 * and may need to be looked up again.
1333 * If rcu_walk prevents us from performing a full check, return 0.
1335 static int nfs_check_verifier(struct inode *dir, struct dentry *dentry,
1338 if (IS_ROOT(dentry))
1340 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONE)
1342 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1344 /* Revalidate nfsi->cache_change_attribute before we declare a match */
1345 if (nfs_mapping_need_revalidate_inode(dir)) {
1348 if (__nfs_revalidate_inode(NFS_SERVER(dir), dir) < 0)
1351 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1357 * Use intent information to check whether or not we're going to do
1358 * an O_EXCL create using this path component.
1360 static int nfs_is_exclusive_create(struct inode *dir, unsigned int flags)
1362 if (NFS_PROTO(dir)->version == 2)
1364 return flags & LOOKUP_EXCL;
1368 * Inode and filehandle revalidation for lookups.
1370 * We force revalidation in the cases where the VFS sets LOOKUP_REVAL,
1371 * or if the intent information indicates that we're about to open this
1372 * particular file and the "nocto" mount flag is not set.
1376 int nfs_lookup_verify_inode(struct inode *inode, unsigned int flags)
1378 struct nfs_server *server = NFS_SERVER(inode);
1381 if (IS_AUTOMOUNT(inode))
1384 if (flags & LOOKUP_OPEN) {
1385 switch (inode->i_mode & S_IFMT) {
1387 /* A NFSv4 OPEN will revalidate later */
1388 if (server->caps & NFS_CAP_ATOMIC_OPEN)
1392 if (server->flags & NFS_MOUNT_NOCTO)
1394 /* NFS close-to-open cache consistency validation */
1399 /* VFS wants an on-the-wire revalidation */
1400 if (flags & LOOKUP_REVAL)
1403 return (inode->i_nlink == 0) ? -ESTALE : 0;
1405 if (flags & LOOKUP_RCU)
1407 ret = __nfs_revalidate_inode(server, inode);
1413 static void nfs_mark_dir_for_revalidate(struct inode *inode)
1415 spin_lock(&inode->i_lock);
1416 nfs_set_cache_invalid(inode, NFS_INO_REVAL_PAGECACHE);
1417 spin_unlock(&inode->i_lock);
1421 * We judge how long we want to trust negative
1422 * dentries by looking at the parent inode mtime.
1424 * If parent mtime has changed, we revalidate, else we wait for a
1425 * period corresponding to the parent's attribute cache timeout value.
1427 * If LOOKUP_RCU prevents us from performing a full check, return 1
1428 * suggesting a reval is needed.
1430 * Note that when creating a new file, or looking up a rename target,
1431 * then it shouldn't be necessary to revalidate a negative dentry.
1434 int nfs_neg_need_reval(struct inode *dir, struct dentry *dentry,
1437 if (flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
1439 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONEG)
1441 return !nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU);
1445 nfs_lookup_revalidate_done(struct inode *dir, struct dentry *dentry,
1446 struct inode *inode, int error)
1450 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is valid\n",
1455 * We can't d_drop the root of a disconnected tree:
1456 * its d_hash is on the s_anon list and d_drop() would hide
1457 * it from shrink_dcache_for_unmount(), leading to busy
1458 * inodes on unmount and further oopses.
1460 if (inode && IS_ROOT(dentry))
1462 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is invalid\n",
1466 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) lookup returned error %d\n",
1467 __func__, dentry, error);
1472 nfs_lookup_revalidate_negative(struct inode *dir, struct dentry *dentry,
1476 if (nfs_neg_need_reval(dir, dentry, flags)) {
1477 if (flags & LOOKUP_RCU)
1481 return nfs_lookup_revalidate_done(dir, dentry, NULL, ret);
1485 nfs_lookup_revalidate_delegated(struct inode *dir, struct dentry *dentry,
1486 struct inode *inode)
1488 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1489 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1493 nfs_lookup_revalidate_dentry(struct inode *dir, struct dentry *dentry,
1494 struct inode *inode)
1496 struct nfs_fh *fhandle;
1497 struct nfs_fattr *fattr;
1498 struct nfs4_label *label;
1499 unsigned long dir_verifier;
1503 fhandle = nfs_alloc_fhandle();
1504 fattr = nfs_alloc_fattr();
1505 label = nfs4_label_alloc(NFS_SERVER(inode), GFP_KERNEL);
1506 if (fhandle == NULL || fattr == NULL || IS_ERR(label))
1509 dir_verifier = nfs_save_change_attribute(dir);
1510 ret = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
1518 if (NFS_SERVER(inode)->flags & NFS_MOUNT_SOFTREVAL)
1524 if (nfs_compare_fh(NFS_FH(inode), fhandle))
1526 if (nfs_refresh_inode(inode, fattr) < 0)
1529 nfs_setsecurity(inode, fattr, label);
1530 nfs_set_verifier(dentry, dir_verifier);
1532 /* set a readdirplus hint that we had a cache miss */
1533 nfs_force_use_readdirplus(dir);
1536 nfs_free_fattr(fattr);
1537 nfs_free_fhandle(fhandle);
1538 nfs4_label_free(label);
1541 * If the lookup failed despite the dentry change attribute being
1542 * a match, then we should revalidate the directory cache.
1544 if (!ret && nfs_verify_change_attribute(dir, dentry->d_time))
1545 nfs_mark_dir_for_revalidate(dir);
1546 return nfs_lookup_revalidate_done(dir, dentry, inode, ret);
1550 * This is called every time the dcache has a lookup hit,
1551 * and we should check whether we can really trust that
1554 * NOTE! The hit can be a negative hit too, don't assume
1557 * If the parent directory is seen to have changed, we throw out the
1558 * cached dentry and do a new lookup.
1561 nfs_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1564 struct inode *inode;
1567 nfs_inc_stats(dir, NFSIOS_DENTRYREVALIDATE);
1568 inode = d_inode(dentry);
1571 return nfs_lookup_revalidate_negative(dir, dentry, flags);
1573 if (is_bad_inode(inode)) {
1574 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1579 if (nfs_verifier_is_delegated(dentry))
1580 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
1582 /* Force a full look up iff the parent directory has changed */
1583 if (!(flags & (LOOKUP_EXCL | LOOKUP_REVAL)) &&
1584 nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU)) {
1585 error = nfs_lookup_verify_inode(inode, flags);
1587 if (error == -ESTALE)
1588 nfs_mark_dir_for_revalidate(dir);
1591 nfs_advise_use_readdirplus(dir);
1595 if (flags & LOOKUP_RCU)
1598 if (NFS_STALE(inode))
1601 trace_nfs_lookup_revalidate_enter(dir, dentry, flags);
1602 error = nfs_lookup_revalidate_dentry(dir, dentry, inode);
1603 trace_nfs_lookup_revalidate_exit(dir, dentry, flags, error);
1606 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1608 if (flags & LOOKUP_RCU)
1610 return nfs_lookup_revalidate_done(dir, dentry, inode, 0);
1614 __nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags,
1615 int (*reval)(struct inode *, struct dentry *, unsigned int))
1617 struct dentry *parent;
1621 if (flags & LOOKUP_RCU) {
1622 parent = READ_ONCE(dentry->d_parent);
1623 dir = d_inode_rcu(parent);
1626 ret = reval(dir, dentry, flags);
1627 if (parent != READ_ONCE(dentry->d_parent))
1630 parent = dget_parent(dentry);
1631 ret = reval(d_inode(parent), dentry, flags);
1637 static int nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1639 return __nfs_lookup_revalidate(dentry, flags, nfs_do_lookup_revalidate);
1643 * A weaker form of d_revalidate for revalidating just the d_inode(dentry)
1644 * when we don't really care about the dentry name. This is called when a
1645 * pathwalk ends on a dentry that was not found via a normal lookup in the
1646 * parent dir (e.g.: ".", "..", procfs symlinks or mountpoint traversals).
1648 * In this situation, we just want to verify that the inode itself is OK
1649 * since the dentry might have changed on the server.
1651 static int nfs_weak_revalidate(struct dentry *dentry, unsigned int flags)
1653 struct inode *inode = d_inode(dentry);
1657 * I believe we can only get a negative dentry here in the case of a
1658 * procfs-style symlink. Just assume it's correct for now, but we may
1659 * eventually need to do something more here.
1662 dfprintk(LOOKUPCACHE, "%s: %pd2 has negative inode\n",
1667 if (is_bad_inode(inode)) {
1668 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1673 error = nfs_lookup_verify_inode(inode, flags);
1674 dfprintk(LOOKUPCACHE, "NFS: %s: inode %lu is %s\n",
1675 __func__, inode->i_ino, error ? "invalid" : "valid");
1680 * This is called from dput() when d_count is going to 0.
1682 static int nfs_dentry_delete(const struct dentry *dentry)
1684 dfprintk(VFS, "NFS: dentry_delete(%pd2, %x)\n",
1685 dentry, dentry->d_flags);
1687 /* Unhash any dentry with a stale inode */
1688 if (d_really_is_positive(dentry) && NFS_STALE(d_inode(dentry)))
1691 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1692 /* Unhash it, so that ->d_iput() would be called */
1695 if (!(dentry->d_sb->s_flags & SB_ACTIVE)) {
1696 /* Unhash it, so that ancestors of killed async unlink
1697 * files will be cleaned up during umount */
1704 /* Ensure that we revalidate inode->i_nlink */
1705 static void nfs_drop_nlink(struct inode *inode)
1707 spin_lock(&inode->i_lock);
1708 /* drop the inode if we're reasonably sure this is the last link */
1709 if (inode->i_nlink > 0)
1711 NFS_I(inode)->attr_gencount = nfs_inc_attr_generation_counter();
1712 nfs_set_cache_invalid(
1713 inode, NFS_INO_INVALID_CHANGE | NFS_INO_INVALID_CTIME |
1714 NFS_INO_INVALID_NLINK);
1715 spin_unlock(&inode->i_lock);
1719 * Called when the dentry loses inode.
1720 * We use it to clean up silly-renamed files.
1722 static void nfs_dentry_iput(struct dentry *dentry, struct inode *inode)
1724 if (S_ISDIR(inode->i_mode))
1725 /* drop any readdir cache as it could easily be old */
1726 nfs_set_cache_invalid(inode, NFS_INO_INVALID_DATA);
1728 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1729 nfs_complete_unlink(dentry, inode);
1730 nfs_drop_nlink(inode);
1735 static void nfs_d_release(struct dentry *dentry)
1737 /* free cached devname value, if it survived that far */
1738 if (unlikely(dentry->d_fsdata)) {
1739 if (dentry->d_flags & DCACHE_NFSFS_RENAMED)
1742 kfree(dentry->d_fsdata);
1746 const struct dentry_operations nfs_dentry_operations = {
1747 .d_revalidate = nfs_lookup_revalidate,
1748 .d_weak_revalidate = nfs_weak_revalidate,
1749 .d_delete = nfs_dentry_delete,
1750 .d_iput = nfs_dentry_iput,
1751 .d_automount = nfs_d_automount,
1752 .d_release = nfs_d_release,
1754 EXPORT_SYMBOL_GPL(nfs_dentry_operations);
1756 struct dentry *nfs_lookup(struct inode *dir, struct dentry * dentry, unsigned int flags)
1759 struct inode *inode = NULL;
1760 struct nfs_fh *fhandle = NULL;
1761 struct nfs_fattr *fattr = NULL;
1762 struct nfs4_label *label = NULL;
1763 unsigned long dir_verifier;
1766 dfprintk(VFS, "NFS: lookup(%pd2)\n", dentry);
1767 nfs_inc_stats(dir, NFSIOS_VFSLOOKUP);
1769 if (unlikely(dentry->d_name.len > NFS_SERVER(dir)->namelen))
1770 return ERR_PTR(-ENAMETOOLONG);
1773 * If we're doing an exclusive create, optimize away the lookup
1774 * but don't hash the dentry.
1776 if (nfs_is_exclusive_create(dir, flags) || flags & LOOKUP_RENAME_TARGET)
1779 res = ERR_PTR(-ENOMEM);
1780 fhandle = nfs_alloc_fhandle();
1781 fattr = nfs_alloc_fattr();
1782 if (fhandle == NULL || fattr == NULL)
1785 label = nfs4_label_alloc(NFS_SERVER(dir), GFP_NOWAIT);
1789 dir_verifier = nfs_save_change_attribute(dir);
1790 trace_nfs_lookup_enter(dir, dentry, flags);
1791 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
1792 if (error == -ENOENT)
1795 res = ERR_PTR(error);
1798 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
1799 res = ERR_CAST(inode);
1803 /* Notify readdir to use READDIRPLUS */
1804 nfs_force_use_readdirplus(dir);
1807 res = d_splice_alias(inode, dentry);
1813 nfs_set_verifier(dentry, dir_verifier);
1815 trace_nfs_lookup_exit(dir, dentry, flags, error);
1816 nfs4_label_free(label);
1818 nfs_free_fattr(fattr);
1819 nfs_free_fhandle(fhandle);
1822 EXPORT_SYMBOL_GPL(nfs_lookup);
1824 #if IS_ENABLED(CONFIG_NFS_V4)
1825 static int nfs4_lookup_revalidate(struct dentry *, unsigned int);
1827 const struct dentry_operations nfs4_dentry_operations = {
1828 .d_revalidate = nfs4_lookup_revalidate,
1829 .d_weak_revalidate = nfs_weak_revalidate,
1830 .d_delete = nfs_dentry_delete,
1831 .d_iput = nfs_dentry_iput,
1832 .d_automount = nfs_d_automount,
1833 .d_release = nfs_d_release,
1835 EXPORT_SYMBOL_GPL(nfs4_dentry_operations);
1837 static fmode_t flags_to_mode(int flags)
1839 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
1840 if ((flags & O_ACCMODE) != O_WRONLY)
1842 if ((flags & O_ACCMODE) != O_RDONLY)
1847 static struct nfs_open_context *create_nfs_open_context(struct dentry *dentry, int open_flags, struct file *filp)
1849 return alloc_nfs_open_context(dentry, flags_to_mode(open_flags), filp);
1852 static int do_open(struct inode *inode, struct file *filp)
1854 nfs_fscache_open_file(inode, filp);
1858 static int nfs_finish_open(struct nfs_open_context *ctx,
1859 struct dentry *dentry,
1860 struct file *file, unsigned open_flags)
1864 err = finish_open(file, dentry, do_open);
1867 if (S_ISREG(file->f_path.dentry->d_inode->i_mode))
1868 nfs_file_set_open_context(file, ctx);
1875 int nfs_atomic_open(struct inode *dir, struct dentry *dentry,
1876 struct file *file, unsigned open_flags,
1879 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
1880 struct nfs_open_context *ctx;
1882 struct iattr attr = { .ia_valid = ATTR_OPEN };
1883 struct inode *inode;
1884 unsigned int lookup_flags = 0;
1885 bool switched = false;
1889 /* Expect a negative dentry */
1890 BUG_ON(d_inode(dentry));
1892 dfprintk(VFS, "NFS: atomic_open(%s/%lu), %pd\n",
1893 dir->i_sb->s_id, dir->i_ino, dentry);
1895 err = nfs_check_flags(open_flags);
1899 /* NFS only supports OPEN on regular files */
1900 if ((open_flags & O_DIRECTORY)) {
1901 if (!d_in_lookup(dentry)) {
1903 * Hashed negative dentry with O_DIRECTORY: dentry was
1904 * revalidated and is fine, no need to perform lookup
1909 lookup_flags = LOOKUP_OPEN|LOOKUP_DIRECTORY;
1913 if (dentry->d_name.len > NFS_SERVER(dir)->namelen)
1914 return -ENAMETOOLONG;
1916 if (open_flags & O_CREAT) {
1917 struct nfs_server *server = NFS_SERVER(dir);
1919 if (!(server->attr_bitmask[2] & FATTR4_WORD2_MODE_UMASK))
1920 mode &= ~current_umask();
1922 attr.ia_valid |= ATTR_MODE;
1923 attr.ia_mode = mode;
1925 if (open_flags & O_TRUNC) {
1926 attr.ia_valid |= ATTR_SIZE;
1930 if (!(open_flags & O_CREAT) && !d_in_lookup(dentry)) {
1933 dentry = d_alloc_parallel(dentry->d_parent,
1934 &dentry->d_name, &wq);
1936 return PTR_ERR(dentry);
1937 if (unlikely(!d_in_lookup(dentry)))
1938 return finish_no_open(file, dentry);
1941 ctx = create_nfs_open_context(dentry, open_flags, file);
1946 trace_nfs_atomic_open_enter(dir, ctx, open_flags);
1947 inode = NFS_PROTO(dir)->open_context(dir, ctx, open_flags, &attr, &created);
1949 file->f_mode |= FMODE_CREATED;
1950 if (IS_ERR(inode)) {
1951 err = PTR_ERR(inode);
1952 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
1953 put_nfs_open_context(ctx);
1957 d_splice_alias(NULL, dentry);
1958 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1964 if (!(open_flags & O_NOFOLLOW))
1974 err = nfs_finish_open(ctx, ctx->dentry, file, open_flags);
1975 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
1976 put_nfs_open_context(ctx);
1978 if (unlikely(switched)) {
1979 d_lookup_done(dentry);
1985 res = nfs_lookup(dir, dentry, lookup_flags);
1987 d_lookup_done(dentry);
1994 return PTR_ERR(res);
1995 return finish_no_open(file, res);
1997 EXPORT_SYMBOL_GPL(nfs_atomic_open);
2000 nfs4_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
2003 struct inode *inode;
2005 if (!(flags & LOOKUP_OPEN) || (flags & LOOKUP_DIRECTORY))
2007 if (d_mountpoint(dentry))
2010 inode = d_inode(dentry);
2012 /* We can't create new files in nfs_open_revalidate(), so we
2013 * optimize away revalidation of negative dentries.
2018 if (nfs_verifier_is_delegated(dentry))
2019 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
2021 /* NFS only supports OPEN on regular files */
2022 if (!S_ISREG(inode->i_mode))
2025 /* We cannot do exclusive creation on a positive dentry */
2026 if (flags & (LOOKUP_EXCL | LOOKUP_REVAL))
2029 /* Check if the directory changed */
2030 if (!nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU))
2033 /* Let f_op->open() actually open (and revalidate) the file */
2036 if (flags & LOOKUP_RCU)
2038 return nfs_lookup_revalidate_dentry(dir, dentry, inode);
2041 return nfs_do_lookup_revalidate(dir, dentry, flags);
2044 static int nfs4_lookup_revalidate(struct dentry *dentry, unsigned int flags)
2046 return __nfs_lookup_revalidate(dentry, flags,
2047 nfs4_do_lookup_revalidate);
2050 #endif /* CONFIG_NFSV4 */
2053 nfs_add_or_obtain(struct dentry *dentry, struct nfs_fh *fhandle,
2054 struct nfs_fattr *fattr,
2055 struct nfs4_label *label)
2057 struct dentry *parent = dget_parent(dentry);
2058 struct inode *dir = d_inode(parent);
2059 struct inode *inode;
2065 if (fhandle->size == 0) {
2066 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, NULL);
2070 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2071 if (!(fattr->valid & NFS_ATTR_FATTR)) {
2072 struct nfs_server *server = NFS_SB(dentry->d_sb);
2073 error = server->nfs_client->rpc_ops->getattr(server, fhandle,
2078 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
2079 d = d_splice_alias(inode, dentry);
2087 EXPORT_SYMBOL_GPL(nfs_add_or_obtain);
2090 * Code common to create, mkdir, and mknod.
2092 int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fhandle,
2093 struct nfs_fattr *fattr,
2094 struct nfs4_label *label)
2098 d = nfs_add_or_obtain(dentry, fhandle, fattr, label);
2102 /* Callers don't care */
2106 EXPORT_SYMBOL_GPL(nfs_instantiate);
2109 * Following a failed create operation, we drop the dentry rather
2110 * than retain a negative dentry. This avoids a problem in the event
2111 * that the operation succeeded on the server, but an error in the
2112 * reply path made it appear to have failed.
2114 int nfs_create(struct user_namespace *mnt_userns, struct inode *dir,
2115 struct dentry *dentry, umode_t mode, bool excl)
2118 int open_flags = excl ? O_CREAT | O_EXCL : O_CREAT;
2121 dfprintk(VFS, "NFS: create(%s/%lu), %pd\n",
2122 dir->i_sb->s_id, dir->i_ino, dentry);
2124 attr.ia_mode = mode;
2125 attr.ia_valid = ATTR_MODE;
2127 trace_nfs_create_enter(dir, dentry, open_flags);
2128 error = NFS_PROTO(dir)->create(dir, dentry, &attr, open_flags);
2129 trace_nfs_create_exit(dir, dentry, open_flags, error);
2137 EXPORT_SYMBOL_GPL(nfs_create);
2140 * See comments for nfs_proc_create regarding failed operations.
2143 nfs_mknod(struct user_namespace *mnt_userns, struct inode *dir,
2144 struct dentry *dentry, umode_t mode, dev_t rdev)
2149 dfprintk(VFS, "NFS: mknod(%s/%lu), %pd\n",
2150 dir->i_sb->s_id, dir->i_ino, dentry);
2152 attr.ia_mode = mode;
2153 attr.ia_valid = ATTR_MODE;
2155 trace_nfs_mknod_enter(dir, dentry);
2156 status = NFS_PROTO(dir)->mknod(dir, dentry, &attr, rdev);
2157 trace_nfs_mknod_exit(dir, dentry, status);
2165 EXPORT_SYMBOL_GPL(nfs_mknod);
2168 * See comments for nfs_proc_create regarding failed operations.
2170 int nfs_mkdir(struct user_namespace *mnt_userns, struct inode *dir,
2171 struct dentry *dentry, umode_t mode)
2176 dfprintk(VFS, "NFS: mkdir(%s/%lu), %pd\n",
2177 dir->i_sb->s_id, dir->i_ino, dentry);
2179 attr.ia_valid = ATTR_MODE;
2180 attr.ia_mode = mode | S_IFDIR;
2182 trace_nfs_mkdir_enter(dir, dentry);
2183 error = NFS_PROTO(dir)->mkdir(dir, dentry, &attr);
2184 trace_nfs_mkdir_exit(dir, dentry, error);
2192 EXPORT_SYMBOL_GPL(nfs_mkdir);
2194 static void nfs_dentry_handle_enoent(struct dentry *dentry)
2196 if (simple_positive(dentry))
2200 int nfs_rmdir(struct inode *dir, struct dentry *dentry)
2204 dfprintk(VFS, "NFS: rmdir(%s/%lu), %pd\n",
2205 dir->i_sb->s_id, dir->i_ino, dentry);
2207 trace_nfs_rmdir_enter(dir, dentry);
2208 if (d_really_is_positive(dentry)) {
2209 down_write(&NFS_I(d_inode(dentry))->rmdir_sem);
2210 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2211 /* Ensure the VFS deletes this inode */
2214 clear_nlink(d_inode(dentry));
2217 nfs_dentry_handle_enoent(dentry);
2219 up_write(&NFS_I(d_inode(dentry))->rmdir_sem);
2221 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2222 trace_nfs_rmdir_exit(dir, dentry, error);
2226 EXPORT_SYMBOL_GPL(nfs_rmdir);
2229 * Remove a file after making sure there are no pending writes,
2230 * and after checking that the file has only one user.
2232 * We invalidate the attribute cache and free the inode prior to the operation
2233 * to avoid possible races if the server reuses the inode.
2235 static int nfs_safe_remove(struct dentry *dentry)
2237 struct inode *dir = d_inode(dentry->d_parent);
2238 struct inode *inode = d_inode(dentry);
2241 dfprintk(VFS, "NFS: safe_remove(%pd2)\n", dentry);
2243 /* If the dentry was sillyrenamed, we simply call d_delete() */
2244 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
2249 trace_nfs_remove_enter(dir, dentry);
2250 if (inode != NULL) {
2251 error = NFS_PROTO(dir)->remove(dir, dentry);
2253 nfs_drop_nlink(inode);
2255 error = NFS_PROTO(dir)->remove(dir, dentry);
2256 if (error == -ENOENT)
2257 nfs_dentry_handle_enoent(dentry);
2258 trace_nfs_remove_exit(dir, dentry, error);
2263 /* We do silly rename. In case sillyrename() returns -EBUSY, the inode
2264 * belongs to an active ".nfs..." file and we return -EBUSY.
2266 * If sillyrename() returns 0, we do nothing, otherwise we unlink.
2268 int nfs_unlink(struct inode *dir, struct dentry *dentry)
2271 int need_rehash = 0;
2273 dfprintk(VFS, "NFS: unlink(%s/%lu, %pd)\n", dir->i_sb->s_id,
2274 dir->i_ino, dentry);
2276 trace_nfs_unlink_enter(dir, dentry);
2277 spin_lock(&dentry->d_lock);
2278 if (d_count(dentry) > 1) {
2279 spin_unlock(&dentry->d_lock);
2280 /* Start asynchronous writeout of the inode */
2281 write_inode_now(d_inode(dentry), 0);
2282 error = nfs_sillyrename(dir, dentry);
2285 if (!d_unhashed(dentry)) {
2289 spin_unlock(&dentry->d_lock);
2290 error = nfs_safe_remove(dentry);
2291 if (!error || error == -ENOENT) {
2292 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2293 } else if (need_rehash)
2296 trace_nfs_unlink_exit(dir, dentry, error);
2299 EXPORT_SYMBOL_GPL(nfs_unlink);
2302 * To create a symbolic link, most file systems instantiate a new inode,
2303 * add a page to it containing the path, then write it out to the disk
2304 * using prepare_write/commit_write.
2306 * Unfortunately the NFS client can't create the in-core inode first
2307 * because it needs a file handle to create an in-core inode (see
2308 * fs/nfs/inode.c:nfs_fhget). We only have a file handle *after* the
2309 * symlink request has completed on the server.
2311 * So instead we allocate a raw page, copy the symname into it, then do
2312 * the SYMLINK request with the page as the buffer. If it succeeds, we
2313 * now have a new file handle and can instantiate an in-core NFS inode
2314 * and move the raw page into its mapping.
2316 int nfs_symlink(struct user_namespace *mnt_userns, struct inode *dir,
2317 struct dentry *dentry, const char *symname)
2322 unsigned int pathlen = strlen(symname);
2325 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s)\n", dir->i_sb->s_id,
2326 dir->i_ino, dentry, symname);
2328 if (pathlen > PAGE_SIZE)
2329 return -ENAMETOOLONG;
2331 attr.ia_mode = S_IFLNK | S_IRWXUGO;
2332 attr.ia_valid = ATTR_MODE;
2334 page = alloc_page(GFP_USER);
2338 kaddr = page_address(page);
2339 memcpy(kaddr, symname, pathlen);
2340 if (pathlen < PAGE_SIZE)
2341 memset(kaddr + pathlen, 0, PAGE_SIZE - pathlen);
2343 trace_nfs_symlink_enter(dir, dentry);
2344 error = NFS_PROTO(dir)->symlink(dir, dentry, page, pathlen, &attr);
2345 trace_nfs_symlink_exit(dir, dentry, error);
2347 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s) error %d\n",
2348 dir->i_sb->s_id, dir->i_ino,
2349 dentry, symname, error);
2356 * No big deal if we can't add this page to the page cache here.
2357 * READLINK will get the missing page from the server if needed.
2359 if (!add_to_page_cache_lru(page, d_inode(dentry)->i_mapping, 0,
2361 SetPageUptodate(page);
2364 * add_to_page_cache_lru() grabs an extra page refcount.
2365 * Drop it here to avoid leaking this page later.
2373 EXPORT_SYMBOL_GPL(nfs_symlink);
2376 nfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
2378 struct inode *inode = d_inode(old_dentry);
2381 dfprintk(VFS, "NFS: link(%pd2 -> %pd2)\n",
2382 old_dentry, dentry);
2384 trace_nfs_link_enter(inode, dir, dentry);
2386 error = NFS_PROTO(dir)->link(inode, dir, &dentry->d_name);
2389 d_add(dentry, inode);
2391 trace_nfs_link_exit(inode, dir, dentry, error);
2394 EXPORT_SYMBOL_GPL(nfs_link);
2398 * FIXME: Some nfsds, like the Linux user space nfsd, may generate a
2399 * different file handle for the same inode after a rename (e.g. when
2400 * moving to a different directory). A fail-safe method to do so would
2401 * be to look up old_dir/old_name, create a link to new_dir/new_name and
2402 * rename the old file using the sillyrename stuff. This way, the original
2403 * file in old_dir will go away when the last process iput()s the inode.
2407 * It actually works quite well. One needs to have the possibility for
2408 * at least one ".nfs..." file in each directory the file ever gets
2409 * moved or linked to which happens automagically with the new
2410 * implementation that only depends on the dcache stuff instead of
2411 * using the inode layer
2413 * Unfortunately, things are a little more complicated than indicated
2414 * above. For a cross-directory move, we want to make sure we can get
2415 * rid of the old inode after the operation. This means there must be
2416 * no pending writes (if it's a file), and the use count must be 1.
2417 * If these conditions are met, we can drop the dentries before doing
2420 int nfs_rename(struct user_namespace *mnt_userns, struct inode *old_dir,
2421 struct dentry *old_dentry, struct inode *new_dir,
2422 struct dentry *new_dentry, unsigned int flags)
2424 struct inode *old_inode = d_inode(old_dentry);
2425 struct inode *new_inode = d_inode(new_dentry);
2426 struct dentry *dentry = NULL, *rehash = NULL;
2427 struct rpc_task *task;
2433 dfprintk(VFS, "NFS: rename(%pd2 -> %pd2, ct=%d)\n",
2434 old_dentry, new_dentry,
2435 d_count(new_dentry));
2437 trace_nfs_rename_enter(old_dir, old_dentry, new_dir, new_dentry);
2439 * For non-directories, check whether the target is busy and if so,
2440 * make a copy of the dentry and then do a silly-rename. If the
2441 * silly-rename succeeds, the copied dentry is hashed and becomes
2444 if (new_inode && !S_ISDIR(new_inode->i_mode)) {
2446 * To prevent any new references to the target during the
2447 * rename, we unhash the dentry in advance.
2449 if (!d_unhashed(new_dentry)) {
2451 rehash = new_dentry;
2454 if (d_count(new_dentry) > 2) {
2457 /* copy the target dentry's name */
2458 dentry = d_alloc(new_dentry->d_parent,
2459 &new_dentry->d_name);
2463 /* silly-rename the existing target ... */
2464 err = nfs_sillyrename(new_dir, new_dentry);
2468 new_dentry = dentry;
2474 task = nfs_async_rename(old_dir, new_dir, old_dentry, new_dentry, NULL);
2476 error = PTR_ERR(task);
2480 error = rpc_wait_for_completion_task(task);
2482 ((struct nfs_renamedata *)task->tk_calldata)->cancelled = 1;
2483 /* Paired with the atomic_dec_and_test() barrier in rpc_do_put_task() */
2486 error = task->tk_status;
2488 /* Ensure the inode attributes are revalidated */
2490 spin_lock(&old_inode->i_lock);
2491 NFS_I(old_inode)->attr_gencount = nfs_inc_attr_generation_counter();
2492 nfs_set_cache_invalid(old_inode, NFS_INO_INVALID_CHANGE |
2493 NFS_INO_INVALID_CTIME |
2494 NFS_INO_REVAL_FORCED);
2495 spin_unlock(&old_inode->i_lock);
2500 trace_nfs_rename_exit(old_dir, old_dentry,
2501 new_dir, new_dentry, error);
2503 if (new_inode != NULL)
2504 nfs_drop_nlink(new_inode);
2506 * The d_move() should be here instead of in an async RPC completion
2507 * handler because we need the proper locks to move the dentry. If
2508 * we're interrupted by a signal, the async RPC completion handler
2509 * should mark the directories for revalidation.
2511 d_move(old_dentry, new_dentry);
2512 nfs_set_verifier(old_dentry,
2513 nfs_save_change_attribute(new_dir));
2514 } else if (error == -ENOENT)
2515 nfs_dentry_handle_enoent(old_dentry);
2517 /* new dentry created? */
2522 EXPORT_SYMBOL_GPL(nfs_rename);
2524 static DEFINE_SPINLOCK(nfs_access_lru_lock);
2525 static LIST_HEAD(nfs_access_lru_list);
2526 static atomic_long_t nfs_access_nr_entries;
2528 static unsigned long nfs_access_max_cachesize = 4*1024*1024;
2529 module_param(nfs_access_max_cachesize, ulong, 0644);
2530 MODULE_PARM_DESC(nfs_access_max_cachesize, "NFS access maximum total cache length");
2532 static void nfs_access_free_entry(struct nfs_access_entry *entry)
2534 put_cred(entry->cred);
2535 kfree_rcu(entry, rcu_head);
2536 smp_mb__before_atomic();
2537 atomic_long_dec(&nfs_access_nr_entries);
2538 smp_mb__after_atomic();
2541 static void nfs_access_free_list(struct list_head *head)
2543 struct nfs_access_entry *cache;
2545 while (!list_empty(head)) {
2546 cache = list_entry(head->next, struct nfs_access_entry, lru);
2547 list_del(&cache->lru);
2548 nfs_access_free_entry(cache);
2552 static unsigned long
2553 nfs_do_access_cache_scan(unsigned int nr_to_scan)
2556 struct nfs_inode *nfsi, *next;
2557 struct nfs_access_entry *cache;
2560 spin_lock(&nfs_access_lru_lock);
2561 list_for_each_entry_safe(nfsi, next, &nfs_access_lru_list, access_cache_inode_lru) {
2562 struct inode *inode;
2564 if (nr_to_scan-- == 0)
2566 inode = &nfsi->vfs_inode;
2567 spin_lock(&inode->i_lock);
2568 if (list_empty(&nfsi->access_cache_entry_lru))
2569 goto remove_lru_entry;
2570 cache = list_entry(nfsi->access_cache_entry_lru.next,
2571 struct nfs_access_entry, lru);
2572 list_move(&cache->lru, &head);
2573 rb_erase(&cache->rb_node, &nfsi->access_cache);
2575 if (!list_empty(&nfsi->access_cache_entry_lru))
2576 list_move_tail(&nfsi->access_cache_inode_lru,
2577 &nfs_access_lru_list);
2580 list_del_init(&nfsi->access_cache_inode_lru);
2581 smp_mb__before_atomic();
2582 clear_bit(NFS_INO_ACL_LRU_SET, &nfsi->flags);
2583 smp_mb__after_atomic();
2585 spin_unlock(&inode->i_lock);
2587 spin_unlock(&nfs_access_lru_lock);
2588 nfs_access_free_list(&head);
2593 nfs_access_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
2595 int nr_to_scan = sc->nr_to_scan;
2596 gfp_t gfp_mask = sc->gfp_mask;
2598 if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
2600 return nfs_do_access_cache_scan(nr_to_scan);
2605 nfs_access_cache_count(struct shrinker *shrink, struct shrink_control *sc)
2607 return vfs_pressure_ratio(atomic_long_read(&nfs_access_nr_entries));
2611 nfs_access_cache_enforce_limit(void)
2613 long nr_entries = atomic_long_read(&nfs_access_nr_entries);
2615 unsigned int nr_to_scan;
2617 if (nr_entries < 0 || nr_entries <= nfs_access_max_cachesize)
2620 diff = nr_entries - nfs_access_max_cachesize;
2621 if (diff < nr_to_scan)
2623 nfs_do_access_cache_scan(nr_to_scan);
2626 static void __nfs_access_zap_cache(struct nfs_inode *nfsi, struct list_head *head)
2628 struct rb_root *root_node = &nfsi->access_cache;
2630 struct nfs_access_entry *entry;
2632 /* Unhook entries from the cache */
2633 while ((n = rb_first(root_node)) != NULL) {
2634 entry = rb_entry(n, struct nfs_access_entry, rb_node);
2635 rb_erase(n, root_node);
2636 list_move(&entry->lru, head);
2638 nfsi->cache_validity &= ~NFS_INO_INVALID_ACCESS;
2641 void nfs_access_zap_cache(struct inode *inode)
2645 if (test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags) == 0)
2647 /* Remove from global LRU init */
2648 spin_lock(&nfs_access_lru_lock);
2649 if (test_and_clear_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2650 list_del_init(&NFS_I(inode)->access_cache_inode_lru);
2652 spin_lock(&inode->i_lock);
2653 __nfs_access_zap_cache(NFS_I(inode), &head);
2654 spin_unlock(&inode->i_lock);
2655 spin_unlock(&nfs_access_lru_lock);
2656 nfs_access_free_list(&head);
2658 EXPORT_SYMBOL_GPL(nfs_access_zap_cache);
2660 static struct nfs_access_entry *nfs_access_search_rbtree(struct inode *inode, const struct cred *cred)
2662 struct rb_node *n = NFS_I(inode)->access_cache.rb_node;
2665 struct nfs_access_entry *entry =
2666 rb_entry(n, struct nfs_access_entry, rb_node);
2667 int cmp = cred_fscmp(cred, entry->cred);
2679 static int nfs_access_get_cached_locked(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res, bool may_block)
2681 struct nfs_inode *nfsi = NFS_I(inode);
2682 struct nfs_access_entry *cache;
2686 spin_lock(&inode->i_lock);
2688 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2690 cache = nfs_access_search_rbtree(inode, cred);
2694 /* Found an entry, is our attribute cache valid? */
2695 if (!nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
2702 spin_unlock(&inode->i_lock);
2703 err = __nfs_revalidate_inode(NFS_SERVER(inode), inode);
2706 spin_lock(&inode->i_lock);
2709 res->cred = cache->cred;
2710 res->mask = cache->mask;
2711 list_move_tail(&cache->lru, &nfsi->access_cache_entry_lru);
2714 spin_unlock(&inode->i_lock);
2717 spin_unlock(&inode->i_lock);
2718 nfs_access_zap_cache(inode);
2722 static int nfs_access_get_cached_rcu(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res)
2724 /* Only check the most recently returned cache entry,
2725 * but do it without locking.
2727 struct nfs_inode *nfsi = NFS_I(inode);
2728 struct nfs_access_entry *cache;
2730 struct list_head *lh;
2733 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2735 lh = rcu_dereference(list_tail_rcu(&nfsi->access_cache_entry_lru));
2736 cache = list_entry(lh, struct nfs_access_entry, lru);
2737 if (lh == &nfsi->access_cache_entry_lru ||
2738 cred_fscmp(cred, cache->cred) != 0)
2742 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
2744 res->cred = cache->cred;
2745 res->mask = cache->mask;
2752 int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct
2753 nfs_access_entry *res, bool may_block)
2757 status = nfs_access_get_cached_rcu(inode, cred, res);
2759 status = nfs_access_get_cached_locked(inode, cred, res,
2764 EXPORT_SYMBOL_GPL(nfs_access_get_cached);
2766 static void nfs_access_add_rbtree(struct inode *inode, struct nfs_access_entry *set)
2768 struct nfs_inode *nfsi = NFS_I(inode);
2769 struct rb_root *root_node = &nfsi->access_cache;
2770 struct rb_node **p = &root_node->rb_node;
2771 struct rb_node *parent = NULL;
2772 struct nfs_access_entry *entry;
2775 spin_lock(&inode->i_lock);
2776 while (*p != NULL) {
2778 entry = rb_entry(parent, struct nfs_access_entry, rb_node);
2779 cmp = cred_fscmp(set->cred, entry->cred);
2782 p = &parent->rb_left;
2784 p = &parent->rb_right;
2788 rb_link_node(&set->rb_node, parent, p);
2789 rb_insert_color(&set->rb_node, root_node);
2790 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2791 spin_unlock(&inode->i_lock);
2794 rb_replace_node(parent, &set->rb_node, root_node);
2795 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2796 list_del(&entry->lru);
2797 spin_unlock(&inode->i_lock);
2798 nfs_access_free_entry(entry);
2801 void nfs_access_add_cache(struct inode *inode, struct nfs_access_entry *set)
2803 struct nfs_access_entry *cache = kmalloc(sizeof(*cache), GFP_KERNEL);
2806 RB_CLEAR_NODE(&cache->rb_node);
2807 cache->cred = get_cred(set->cred);
2808 cache->mask = set->mask;
2810 /* The above field assignments must be visible
2811 * before this item appears on the lru. We cannot easily
2812 * use rcu_assign_pointer, so just force the memory barrier.
2815 nfs_access_add_rbtree(inode, cache);
2817 /* Update accounting */
2818 smp_mb__before_atomic();
2819 atomic_long_inc(&nfs_access_nr_entries);
2820 smp_mb__after_atomic();
2822 /* Add inode to global LRU list */
2823 if (!test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags)) {
2824 spin_lock(&nfs_access_lru_lock);
2825 if (!test_and_set_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2826 list_add_tail(&NFS_I(inode)->access_cache_inode_lru,
2827 &nfs_access_lru_list);
2828 spin_unlock(&nfs_access_lru_lock);
2830 nfs_access_cache_enforce_limit();
2832 EXPORT_SYMBOL_GPL(nfs_access_add_cache);
2834 #define NFS_MAY_READ (NFS_ACCESS_READ)
2835 #define NFS_MAY_WRITE (NFS_ACCESS_MODIFY | \
2836 NFS_ACCESS_EXTEND | \
2838 #define NFS_FILE_MAY_WRITE (NFS_ACCESS_MODIFY | \
2840 #define NFS_DIR_MAY_WRITE NFS_MAY_WRITE
2841 #define NFS_MAY_LOOKUP (NFS_ACCESS_LOOKUP)
2842 #define NFS_MAY_EXECUTE (NFS_ACCESS_EXECUTE)
2844 nfs_access_calc_mask(u32 access_result, umode_t umode)
2848 if (access_result & NFS_MAY_READ)
2850 if (S_ISDIR(umode)) {
2851 if ((access_result & NFS_DIR_MAY_WRITE) == NFS_DIR_MAY_WRITE)
2853 if ((access_result & NFS_MAY_LOOKUP) == NFS_MAY_LOOKUP)
2855 } else if (S_ISREG(umode)) {
2856 if ((access_result & NFS_FILE_MAY_WRITE) == NFS_FILE_MAY_WRITE)
2858 if ((access_result & NFS_MAY_EXECUTE) == NFS_MAY_EXECUTE)
2860 } else if (access_result & NFS_MAY_WRITE)
2865 void nfs_access_set_mask(struct nfs_access_entry *entry, u32 access_result)
2867 entry->mask = access_result;
2869 EXPORT_SYMBOL_GPL(nfs_access_set_mask);
2871 static int nfs_do_access(struct inode *inode, const struct cred *cred, int mask)
2873 struct nfs_access_entry cache;
2874 bool may_block = (mask & MAY_NOT_BLOCK) == 0;
2875 int cache_mask = -1;
2878 trace_nfs_access_enter(inode);
2880 status = nfs_access_get_cached(inode, cred, &cache, may_block);
2889 * Determine which access bits we want to ask for...
2891 cache.mask = NFS_ACCESS_READ | NFS_ACCESS_MODIFY | NFS_ACCESS_EXTEND;
2892 if (nfs_server_capable(inode, NFS_CAP_XATTR)) {
2893 cache.mask |= NFS_ACCESS_XAREAD | NFS_ACCESS_XAWRITE |
2896 if (S_ISDIR(inode->i_mode))
2897 cache.mask |= NFS_ACCESS_DELETE | NFS_ACCESS_LOOKUP;
2899 cache.mask |= NFS_ACCESS_EXECUTE;
2901 status = NFS_PROTO(inode)->access(inode, &cache);
2903 if (status == -ESTALE) {
2904 if (!S_ISDIR(inode->i_mode))
2905 nfs_set_inode_stale(inode);
2907 nfs_zap_caches(inode);
2911 nfs_access_add_cache(inode, &cache);
2913 cache_mask = nfs_access_calc_mask(cache.mask, inode->i_mode);
2914 if ((mask & ~cache_mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) != 0)
2917 trace_nfs_access_exit(inode, mask, cache_mask, status);
2921 static int nfs_open_permission_mask(int openflags)
2925 if (openflags & __FMODE_EXEC) {
2926 /* ONLY check exec rights */
2929 if ((openflags & O_ACCMODE) != O_WRONLY)
2931 if ((openflags & O_ACCMODE) != O_RDONLY)
2938 int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags)
2940 return nfs_do_access(inode, cred, nfs_open_permission_mask(openflags));
2942 EXPORT_SYMBOL_GPL(nfs_may_open);
2944 static int nfs_execute_ok(struct inode *inode, int mask)
2946 struct nfs_server *server = NFS_SERVER(inode);
2949 if (S_ISDIR(inode->i_mode))
2951 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_MODE)) {
2952 if (mask & MAY_NOT_BLOCK)
2954 ret = __nfs_revalidate_inode(server, inode);
2956 if (ret == 0 && !execute_ok(inode))
2961 int nfs_permission(struct user_namespace *mnt_userns,
2962 struct inode *inode,
2965 const struct cred *cred = current_cred();
2968 nfs_inc_stats(inode, NFSIOS_VFSACCESS);
2970 if ((mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
2972 /* Is this sys_access() ? */
2973 if (mask & (MAY_ACCESS | MAY_CHDIR))
2976 switch (inode->i_mode & S_IFMT) {
2980 if ((mask & MAY_OPEN) &&
2981 nfs_server_capable(inode, NFS_CAP_ATOMIC_OPEN))
2986 * Optimize away all write operations, since the server
2987 * will check permissions when we perform the op.
2989 if ((mask & MAY_WRITE) && !(mask & MAY_READ))
2994 if (!NFS_PROTO(inode)->access)
2997 res = nfs_do_access(inode, cred, mask);
2999 if (!res && (mask & MAY_EXEC))
3000 res = nfs_execute_ok(inode, mask);
3002 dfprintk(VFS, "NFS: permission(%s/%lu), mask=0x%x, res=%d\n",
3003 inode->i_sb->s_id, inode->i_ino, mask, res);
3006 if (mask & MAY_NOT_BLOCK)
3009 res = nfs_revalidate_inode(inode, NFS_INO_INVALID_MODE |
3010 NFS_INO_INVALID_OTHER);
3012 res = generic_permission(&init_user_ns, inode, mask);
3015 EXPORT_SYMBOL_GPL(nfs_permission);