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);
869 status = nfs_readdir_page_filler(desc, entry, pages, pglen,
871 } while (!status && nfs_readdir_page_needs_filling(page));
873 nfs_readdir_free_pages(pages, array_size);
875 nfs4_label_free(entry->label);
877 nfs_free_fattr(entry->fattr);
878 nfs_free_fhandle(entry->fh);
883 static void nfs_readdir_page_put(struct nfs_readdir_descriptor *desc)
885 put_page(desc->page);
890 nfs_readdir_page_unlock_and_put_cached(struct nfs_readdir_descriptor *desc)
892 unlock_page(desc->page);
893 nfs_readdir_page_put(desc);
897 nfs_readdir_page_get_cached(struct nfs_readdir_descriptor *desc)
899 return nfs_readdir_page_get_locked(desc->file->f_mapping,
905 * Returns 0 if desc->dir_cookie was found on page desc->page_index
906 * and locks the page to prevent removal from the page cache.
908 static int find_and_lock_cache_page(struct nfs_readdir_descriptor *desc)
910 struct inode *inode = file_inode(desc->file);
911 struct nfs_inode *nfsi = NFS_I(inode);
912 __be32 verf[NFS_DIR_VERIFIER_SIZE];
915 desc->page = nfs_readdir_page_get_cached(desc);
918 if (nfs_readdir_page_needs_filling(desc->page)) {
919 res = nfs_readdir_xdr_to_array(desc, nfsi->cookieverf, verf,
922 nfs_readdir_page_unlock_and_put_cached(desc);
923 if (res == -EBADCOOKIE || res == -ENOTSYNC) {
924 invalidate_inode_pages2(desc->file->f_mapping);
925 desc->page_index = 0;
930 memcpy(nfsi->cookieverf, verf, sizeof(nfsi->cookieverf));
932 res = nfs_readdir_search_array(desc);
934 nfsi->page_index = desc->page_index;
937 nfs_readdir_page_unlock_and_put_cached(desc);
941 static bool nfs_readdir_dont_search_cache(struct nfs_readdir_descriptor *desc)
943 struct address_space *mapping = desc->file->f_mapping;
944 struct inode *dir = file_inode(desc->file);
945 unsigned int dtsize = NFS_SERVER(dir)->dtsize;
946 loff_t size = i_size_read(dir);
949 * Default to uncached readdir if the page cache is empty, and
950 * we're looking for a non-zero cookie in a large directory.
952 return desc->dir_cookie != 0 && mapping->nrpages == 0 && size > dtsize;
955 /* Search for desc->dir_cookie from the beginning of the page cache */
956 static int readdir_search_pagecache(struct nfs_readdir_descriptor *desc)
960 if (nfs_readdir_dont_search_cache(desc))
964 if (desc->page_index == 0) {
965 desc->current_index = 0;
966 desc->prev_index = 0;
967 desc->last_cookie = 0;
969 res = find_and_lock_cache_page(desc);
970 } while (res == -EAGAIN);
975 * Once we've found the start of the dirent within a page: fill 'er up...
977 static void nfs_do_filldir(struct nfs_readdir_descriptor *desc)
979 struct file *file = desc->file;
980 struct nfs_inode *nfsi = NFS_I(file_inode(file));
981 struct nfs_cache_array *array;
984 array = kmap(desc->page);
985 for (i = desc->cache_entry_index; i < array->size; i++) {
986 struct nfs_cache_array_entry *ent;
988 ent = &array->array[i];
989 if (!dir_emit(desc->ctx, ent->name, ent->name_len,
990 nfs_compat_user_ino64(ent->ino), ent->d_type)) {
994 memcpy(desc->verf, nfsi->cookieverf, sizeof(desc->verf));
995 if (i < (array->size-1))
996 desc->dir_cookie = array->array[i+1].cookie;
998 desc->dir_cookie = array->last_cookie;
999 if (nfs_readdir_use_cookie(file))
1000 desc->ctx->pos = desc->dir_cookie;
1003 if (desc->duped != 0)
1006 if (array->page_is_eof)
1010 dfprintk(DIRCACHE, "NFS: nfs_do_filldir() filling ended @ cookie %llu\n",
1011 (unsigned long long)desc->dir_cookie);
1015 * If we cannot find a cookie in our cache, we suspect that this is
1016 * because it points to a deleted file, so we ask the server to return
1017 * whatever it thinks is the next entry. We then feed this to filldir.
1018 * If all goes well, we should then be able to find our way round the
1019 * cache on the next call to readdir_search_pagecache();
1021 * NOTE: we cannot add the anonymous page to the pagecache because
1022 * the data it contains might not be page aligned. Besides,
1023 * we should already have a complete representation of the
1024 * directory in the page cache by the time we get here.
1026 static int uncached_readdir(struct nfs_readdir_descriptor *desc)
1028 struct page **arrays;
1030 __be32 verf[NFS_DIR_VERIFIER_SIZE];
1031 int status = -ENOMEM;
1033 dfprintk(DIRCACHE, "NFS: uncached_readdir() searching for cookie %llu\n",
1034 (unsigned long long)desc->dir_cookie);
1036 arrays = kcalloc(sz, sizeof(*arrays), GFP_KERNEL);
1039 arrays[0] = nfs_readdir_page_array_alloc(desc->dir_cookie, GFP_KERNEL);
1043 desc->page_index = 0;
1044 desc->last_cookie = desc->dir_cookie;
1047 status = nfs_readdir_xdr_to_array(desc, desc->verf, verf, arrays, sz);
1049 for (i = 0; !desc->eof && i < sz && arrays[i]; i++) {
1050 desc->page = arrays[i];
1051 nfs_do_filldir(desc);
1056 for (i = 0; i < sz && arrays[i]; i++)
1057 nfs_readdir_page_array_free(arrays[i]);
1060 dfprintk(DIRCACHE, "NFS: %s: returns %d\n", __func__, status);
1064 /* The file offset position represents the dirent entry number. A
1065 last cookie cache takes care of the common case of reading the
1068 static int nfs_readdir(struct file *file, struct dir_context *ctx)
1070 struct dentry *dentry = file_dentry(file);
1071 struct inode *inode = d_inode(dentry);
1072 struct nfs_open_dir_context *dir_ctx = file->private_data;
1073 struct nfs_readdir_descriptor *desc;
1076 dfprintk(FILE, "NFS: readdir(%pD2) starting at cookie %llu\n",
1077 file, (long long)ctx->pos);
1078 nfs_inc_stats(inode, NFSIOS_VFSGETDENTS);
1081 * ctx->pos points to the dirent entry number.
1082 * *desc->dir_cookie has the cookie for the next entry. We have
1083 * to either find the entry with the appropriate number or
1084 * revalidate the cookie.
1086 if (ctx->pos == 0 || nfs_attribute_cache_expired(inode)) {
1087 res = nfs_revalidate_mapping(inode, file->f_mapping);
1093 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
1098 desc->plus = nfs_use_readdirplus(inode, ctx);
1100 spin_lock(&file->f_lock);
1101 desc->dir_cookie = dir_ctx->dir_cookie;
1102 desc->dup_cookie = dir_ctx->dup_cookie;
1103 desc->duped = dir_ctx->duped;
1104 desc->attr_gencount = dir_ctx->attr_gencount;
1105 memcpy(desc->verf, dir_ctx->verf, sizeof(desc->verf));
1106 spin_unlock(&file->f_lock);
1109 res = readdir_search_pagecache(desc);
1111 if (res == -EBADCOOKIE) {
1113 /* This means either end of directory */
1114 if (desc->dir_cookie && !desc->eof) {
1115 /* Or that the server has 'lost' a cookie */
1116 res = uncached_readdir(desc);
1119 if (res == -EBADCOOKIE || res == -ENOTSYNC)
1124 if (res == -ETOOSMALL && desc->plus) {
1125 clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
1126 nfs_zap_caches(inode);
1127 desc->page_index = 0;
1135 nfs_do_filldir(desc);
1136 nfs_readdir_page_unlock_and_put_cached(desc);
1137 } while (!desc->eof);
1139 spin_lock(&file->f_lock);
1140 dir_ctx->dir_cookie = desc->dir_cookie;
1141 dir_ctx->dup_cookie = desc->dup_cookie;
1142 dir_ctx->duped = desc->duped;
1143 dir_ctx->attr_gencount = desc->attr_gencount;
1144 memcpy(dir_ctx->verf, desc->verf, sizeof(dir_ctx->verf));
1145 spin_unlock(&file->f_lock);
1150 dfprintk(FILE, "NFS: readdir(%pD2) returns %d\n", file, res);
1154 static loff_t nfs_llseek_dir(struct file *filp, loff_t offset, int whence)
1156 struct nfs_open_dir_context *dir_ctx = filp->private_data;
1158 dfprintk(FILE, "NFS: llseek dir(%pD2, %lld, %d)\n",
1159 filp, offset, whence);
1167 spin_lock(&filp->f_lock);
1172 spin_lock(&filp->f_lock);
1173 offset += filp->f_pos;
1175 spin_unlock(&filp->f_lock);
1179 if (offset != filp->f_pos) {
1180 filp->f_pos = offset;
1181 if (nfs_readdir_use_cookie(filp))
1182 dir_ctx->dir_cookie = offset;
1184 dir_ctx->dir_cookie = 0;
1186 memset(dir_ctx->verf, 0, sizeof(dir_ctx->verf));
1189 spin_unlock(&filp->f_lock);
1194 * All directory operations under NFS are synchronous, so fsync()
1195 * is a dummy operation.
1197 static int nfs_fsync_dir(struct file *filp, loff_t start, loff_t end,
1200 dfprintk(FILE, "NFS: fsync dir(%pD2) datasync %d\n", filp, datasync);
1202 nfs_inc_stats(file_inode(filp), NFSIOS_VFSFSYNC);
1207 * nfs_force_lookup_revalidate - Mark the directory as having changed
1208 * @dir: pointer to directory inode
1210 * This forces the revalidation code in nfs_lookup_revalidate() to do a
1211 * full lookup on all child dentries of 'dir' whenever a change occurs
1212 * on the server that might have invalidated our dcache.
1214 * Note that we reserve bit '0' as a tag to let us know when a dentry
1215 * was revalidated while holding a delegation on its inode.
1217 * The caller should be holding dir->i_lock
1219 void nfs_force_lookup_revalidate(struct inode *dir)
1221 NFS_I(dir)->cache_change_attribute += 2;
1223 EXPORT_SYMBOL_GPL(nfs_force_lookup_revalidate);
1226 * nfs_verify_change_attribute - Detects NFS remote directory changes
1227 * @dir: pointer to parent directory inode
1228 * @verf: previously saved change attribute
1230 * Return "false" if the verifiers doesn't match the change attribute.
1231 * This would usually indicate that the directory contents have changed on
1232 * the server, and that any dentries need revalidating.
1234 static bool nfs_verify_change_attribute(struct inode *dir, unsigned long verf)
1236 return (verf & ~1UL) == nfs_save_change_attribute(dir);
1239 static void nfs_set_verifier_delegated(unsigned long *verf)
1244 #if IS_ENABLED(CONFIG_NFS_V4)
1245 static void nfs_unset_verifier_delegated(unsigned long *verf)
1249 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
1251 static bool nfs_test_verifier_delegated(unsigned long verf)
1256 static bool nfs_verifier_is_delegated(struct dentry *dentry)
1258 return nfs_test_verifier_delegated(dentry->d_time);
1261 static void nfs_set_verifier_locked(struct dentry *dentry, unsigned long verf)
1263 struct inode *inode = d_inode(dentry);
1265 if (!nfs_verifier_is_delegated(dentry) &&
1266 !nfs_verify_change_attribute(d_inode(dentry->d_parent), verf))
1268 if (inode && NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
1269 nfs_set_verifier_delegated(&verf);
1271 dentry->d_time = verf;
1275 * nfs_set_verifier - save a parent directory verifier in the dentry
1276 * @dentry: pointer to dentry
1277 * @verf: verifier to save
1279 * Saves the parent directory verifier in @dentry. If the inode has
1280 * a delegation, we also tag the dentry as having been revalidated
1281 * while holding a delegation so that we know we don't have to
1282 * look it up again after a directory change.
1284 void nfs_set_verifier(struct dentry *dentry, unsigned long verf)
1287 spin_lock(&dentry->d_lock);
1288 nfs_set_verifier_locked(dentry, verf);
1289 spin_unlock(&dentry->d_lock);
1291 EXPORT_SYMBOL_GPL(nfs_set_verifier);
1293 #if IS_ENABLED(CONFIG_NFS_V4)
1295 * nfs_clear_verifier_delegated - clear the dir verifier delegation tag
1296 * @inode: pointer to inode
1298 * Iterates through the dentries in the inode alias list and clears
1299 * the tag used to indicate that the dentry has been revalidated
1300 * while holding a delegation.
1301 * This function is intended for use when the delegation is being
1302 * returned or revoked.
1304 void nfs_clear_verifier_delegated(struct inode *inode)
1306 struct dentry *alias;
1310 spin_lock(&inode->i_lock);
1311 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
1312 spin_lock(&alias->d_lock);
1313 nfs_unset_verifier_delegated(&alias->d_time);
1314 spin_unlock(&alias->d_lock);
1316 spin_unlock(&inode->i_lock);
1318 EXPORT_SYMBOL_GPL(nfs_clear_verifier_delegated);
1319 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
1322 * A check for whether or not the parent directory has changed.
1323 * In the case it has, we assume that the dentries are untrustworthy
1324 * and may need to be looked up again.
1325 * If rcu_walk prevents us from performing a full check, return 0.
1327 static int nfs_check_verifier(struct inode *dir, struct dentry *dentry,
1330 if (IS_ROOT(dentry))
1332 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONE)
1334 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1336 /* Revalidate nfsi->cache_change_attribute before we declare a match */
1337 if (nfs_mapping_need_revalidate_inode(dir)) {
1340 if (__nfs_revalidate_inode(NFS_SERVER(dir), dir) < 0)
1343 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1349 * Use intent information to check whether or not we're going to do
1350 * an O_EXCL create using this path component.
1352 static int nfs_is_exclusive_create(struct inode *dir, unsigned int flags)
1354 if (NFS_PROTO(dir)->version == 2)
1356 return flags & LOOKUP_EXCL;
1360 * Inode and filehandle revalidation for lookups.
1362 * We force revalidation in the cases where the VFS sets LOOKUP_REVAL,
1363 * or if the intent information indicates that we're about to open this
1364 * particular file and the "nocto" mount flag is not set.
1368 int nfs_lookup_verify_inode(struct inode *inode, unsigned int flags)
1370 struct nfs_server *server = NFS_SERVER(inode);
1373 if (IS_AUTOMOUNT(inode))
1376 if (flags & LOOKUP_OPEN) {
1377 switch (inode->i_mode & S_IFMT) {
1379 /* A NFSv4 OPEN will revalidate later */
1380 if (server->caps & NFS_CAP_ATOMIC_OPEN)
1384 if (server->flags & NFS_MOUNT_NOCTO)
1386 /* NFS close-to-open cache consistency validation */
1391 /* VFS wants an on-the-wire revalidation */
1392 if (flags & LOOKUP_REVAL)
1395 return (inode->i_nlink == 0) ? -ESTALE : 0;
1397 if (flags & LOOKUP_RCU)
1399 ret = __nfs_revalidate_inode(server, inode);
1405 static void nfs_mark_dir_for_revalidate(struct inode *inode)
1407 spin_lock(&inode->i_lock);
1408 nfs_set_cache_invalid(inode, NFS_INO_REVAL_PAGECACHE);
1409 spin_unlock(&inode->i_lock);
1413 * We judge how long we want to trust negative
1414 * dentries by looking at the parent inode mtime.
1416 * If parent mtime has changed, we revalidate, else we wait for a
1417 * period corresponding to the parent's attribute cache timeout value.
1419 * If LOOKUP_RCU prevents us from performing a full check, return 1
1420 * suggesting a reval is needed.
1422 * Note that when creating a new file, or looking up a rename target,
1423 * then it shouldn't be necessary to revalidate a negative dentry.
1426 int nfs_neg_need_reval(struct inode *dir, struct dentry *dentry,
1429 if (flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
1431 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONEG)
1433 return !nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU);
1437 nfs_lookup_revalidate_done(struct inode *dir, struct dentry *dentry,
1438 struct inode *inode, int error)
1442 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is valid\n",
1447 * We can't d_drop the root of a disconnected tree:
1448 * its d_hash is on the s_anon list and d_drop() would hide
1449 * it from shrink_dcache_for_unmount(), leading to busy
1450 * inodes on unmount and further oopses.
1452 if (inode && IS_ROOT(dentry))
1454 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is invalid\n",
1458 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) lookup returned error %d\n",
1459 __func__, dentry, error);
1464 nfs_lookup_revalidate_negative(struct inode *dir, struct dentry *dentry,
1468 if (nfs_neg_need_reval(dir, dentry, flags)) {
1469 if (flags & LOOKUP_RCU)
1473 return nfs_lookup_revalidate_done(dir, dentry, NULL, ret);
1477 nfs_lookup_revalidate_delegated(struct inode *dir, struct dentry *dentry,
1478 struct inode *inode)
1480 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1481 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1485 nfs_lookup_revalidate_dentry(struct inode *dir, struct dentry *dentry,
1486 struct inode *inode)
1488 struct nfs_fh *fhandle;
1489 struct nfs_fattr *fattr;
1490 struct nfs4_label *label;
1491 unsigned long dir_verifier;
1495 fhandle = nfs_alloc_fhandle();
1496 fattr = nfs_alloc_fattr();
1497 label = nfs4_label_alloc(NFS_SERVER(inode), GFP_KERNEL);
1498 if (fhandle == NULL || fattr == NULL || IS_ERR(label))
1501 dir_verifier = nfs_save_change_attribute(dir);
1502 ret = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
1510 if (NFS_SERVER(inode)->flags & NFS_MOUNT_SOFTREVAL)
1516 if (nfs_compare_fh(NFS_FH(inode), fhandle))
1518 if (nfs_refresh_inode(inode, fattr) < 0)
1521 nfs_setsecurity(inode, fattr, label);
1522 nfs_set_verifier(dentry, dir_verifier);
1524 /* set a readdirplus hint that we had a cache miss */
1525 nfs_force_use_readdirplus(dir);
1528 nfs_free_fattr(fattr);
1529 nfs_free_fhandle(fhandle);
1530 nfs4_label_free(label);
1533 * If the lookup failed despite the dentry change attribute being
1534 * a match, then we should revalidate the directory cache.
1536 if (!ret && nfs_verify_change_attribute(dir, dentry->d_time))
1537 nfs_mark_dir_for_revalidate(dir);
1538 return nfs_lookup_revalidate_done(dir, dentry, inode, ret);
1542 * This is called every time the dcache has a lookup hit,
1543 * and we should check whether we can really trust that
1546 * NOTE! The hit can be a negative hit too, don't assume
1549 * If the parent directory is seen to have changed, we throw out the
1550 * cached dentry and do a new lookup.
1553 nfs_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1556 struct inode *inode;
1559 nfs_inc_stats(dir, NFSIOS_DENTRYREVALIDATE);
1560 inode = d_inode(dentry);
1563 return nfs_lookup_revalidate_negative(dir, dentry, flags);
1565 if (is_bad_inode(inode)) {
1566 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1571 if (nfs_verifier_is_delegated(dentry))
1572 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
1574 /* Force a full look up iff the parent directory has changed */
1575 if (!(flags & (LOOKUP_EXCL | LOOKUP_REVAL)) &&
1576 nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU)) {
1577 error = nfs_lookup_verify_inode(inode, flags);
1579 if (error == -ESTALE)
1580 nfs_mark_dir_for_revalidate(dir);
1583 nfs_advise_use_readdirplus(dir);
1587 if (flags & LOOKUP_RCU)
1590 if (NFS_STALE(inode))
1593 trace_nfs_lookup_revalidate_enter(dir, dentry, flags);
1594 error = nfs_lookup_revalidate_dentry(dir, dentry, inode);
1595 trace_nfs_lookup_revalidate_exit(dir, dentry, flags, error);
1598 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1600 if (flags & LOOKUP_RCU)
1602 return nfs_lookup_revalidate_done(dir, dentry, inode, 0);
1606 __nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags,
1607 int (*reval)(struct inode *, struct dentry *, unsigned int))
1609 struct dentry *parent;
1613 if (flags & LOOKUP_RCU) {
1614 parent = READ_ONCE(dentry->d_parent);
1615 dir = d_inode_rcu(parent);
1618 ret = reval(dir, dentry, flags);
1619 if (parent != READ_ONCE(dentry->d_parent))
1622 parent = dget_parent(dentry);
1623 ret = reval(d_inode(parent), dentry, flags);
1629 static int nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1631 return __nfs_lookup_revalidate(dentry, flags, nfs_do_lookup_revalidate);
1635 * A weaker form of d_revalidate for revalidating just the d_inode(dentry)
1636 * when we don't really care about the dentry name. This is called when a
1637 * pathwalk ends on a dentry that was not found via a normal lookup in the
1638 * parent dir (e.g.: ".", "..", procfs symlinks or mountpoint traversals).
1640 * In this situation, we just want to verify that the inode itself is OK
1641 * since the dentry might have changed on the server.
1643 static int nfs_weak_revalidate(struct dentry *dentry, unsigned int flags)
1645 struct inode *inode = d_inode(dentry);
1649 * I believe we can only get a negative dentry here in the case of a
1650 * procfs-style symlink. Just assume it's correct for now, but we may
1651 * eventually need to do something more here.
1654 dfprintk(LOOKUPCACHE, "%s: %pd2 has negative inode\n",
1659 if (is_bad_inode(inode)) {
1660 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1665 error = nfs_lookup_verify_inode(inode, flags);
1666 dfprintk(LOOKUPCACHE, "NFS: %s: inode %lu is %s\n",
1667 __func__, inode->i_ino, error ? "invalid" : "valid");
1672 * This is called from dput() when d_count is going to 0.
1674 static int nfs_dentry_delete(const struct dentry *dentry)
1676 dfprintk(VFS, "NFS: dentry_delete(%pd2, %x)\n",
1677 dentry, dentry->d_flags);
1679 /* Unhash any dentry with a stale inode */
1680 if (d_really_is_positive(dentry) && NFS_STALE(d_inode(dentry)))
1683 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1684 /* Unhash it, so that ->d_iput() would be called */
1687 if (!(dentry->d_sb->s_flags & SB_ACTIVE)) {
1688 /* Unhash it, so that ancestors of killed async unlink
1689 * files will be cleaned up during umount */
1696 /* Ensure that we revalidate inode->i_nlink */
1697 static void nfs_drop_nlink(struct inode *inode)
1699 spin_lock(&inode->i_lock);
1700 /* drop the inode if we're reasonably sure this is the last link */
1701 if (inode->i_nlink > 0)
1703 NFS_I(inode)->attr_gencount = nfs_inc_attr_generation_counter();
1704 nfs_set_cache_invalid(
1705 inode, NFS_INO_INVALID_CHANGE | NFS_INO_INVALID_CTIME |
1706 NFS_INO_INVALID_OTHER | NFS_INO_REVAL_FORCED);
1707 spin_unlock(&inode->i_lock);
1711 * Called when the dentry loses inode.
1712 * We use it to clean up silly-renamed files.
1714 static void nfs_dentry_iput(struct dentry *dentry, struct inode *inode)
1716 if (S_ISDIR(inode->i_mode))
1717 /* drop any readdir cache as it could easily be old */
1718 nfs_set_cache_invalid(inode, NFS_INO_INVALID_DATA);
1720 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1721 nfs_complete_unlink(dentry, inode);
1722 nfs_drop_nlink(inode);
1727 static void nfs_d_release(struct dentry *dentry)
1729 /* free cached devname value, if it survived that far */
1730 if (unlikely(dentry->d_fsdata)) {
1731 if (dentry->d_flags & DCACHE_NFSFS_RENAMED)
1734 kfree(dentry->d_fsdata);
1738 const struct dentry_operations nfs_dentry_operations = {
1739 .d_revalidate = nfs_lookup_revalidate,
1740 .d_weak_revalidate = nfs_weak_revalidate,
1741 .d_delete = nfs_dentry_delete,
1742 .d_iput = nfs_dentry_iput,
1743 .d_automount = nfs_d_automount,
1744 .d_release = nfs_d_release,
1746 EXPORT_SYMBOL_GPL(nfs_dentry_operations);
1748 struct dentry *nfs_lookup(struct inode *dir, struct dentry * dentry, unsigned int flags)
1751 struct inode *inode = NULL;
1752 struct nfs_fh *fhandle = NULL;
1753 struct nfs_fattr *fattr = NULL;
1754 struct nfs4_label *label = NULL;
1755 unsigned long dir_verifier;
1758 dfprintk(VFS, "NFS: lookup(%pd2)\n", dentry);
1759 nfs_inc_stats(dir, NFSIOS_VFSLOOKUP);
1761 if (unlikely(dentry->d_name.len > NFS_SERVER(dir)->namelen))
1762 return ERR_PTR(-ENAMETOOLONG);
1765 * If we're doing an exclusive create, optimize away the lookup
1766 * but don't hash the dentry.
1768 if (nfs_is_exclusive_create(dir, flags) || flags & LOOKUP_RENAME_TARGET)
1771 res = ERR_PTR(-ENOMEM);
1772 fhandle = nfs_alloc_fhandle();
1773 fattr = nfs_alloc_fattr();
1774 if (fhandle == NULL || fattr == NULL)
1777 label = nfs4_label_alloc(NFS_SERVER(dir), GFP_NOWAIT);
1781 dir_verifier = nfs_save_change_attribute(dir);
1782 trace_nfs_lookup_enter(dir, dentry, flags);
1783 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
1784 if (error == -ENOENT)
1787 res = ERR_PTR(error);
1790 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
1791 res = ERR_CAST(inode);
1795 /* Notify readdir to use READDIRPLUS */
1796 nfs_force_use_readdirplus(dir);
1799 res = d_splice_alias(inode, dentry);
1805 nfs_set_verifier(dentry, dir_verifier);
1807 trace_nfs_lookup_exit(dir, dentry, flags, error);
1808 nfs4_label_free(label);
1810 nfs_free_fattr(fattr);
1811 nfs_free_fhandle(fhandle);
1814 EXPORT_SYMBOL_GPL(nfs_lookup);
1816 #if IS_ENABLED(CONFIG_NFS_V4)
1817 static int nfs4_lookup_revalidate(struct dentry *, unsigned int);
1819 const struct dentry_operations nfs4_dentry_operations = {
1820 .d_revalidate = nfs4_lookup_revalidate,
1821 .d_weak_revalidate = nfs_weak_revalidate,
1822 .d_delete = nfs_dentry_delete,
1823 .d_iput = nfs_dentry_iput,
1824 .d_automount = nfs_d_automount,
1825 .d_release = nfs_d_release,
1827 EXPORT_SYMBOL_GPL(nfs4_dentry_operations);
1829 static fmode_t flags_to_mode(int flags)
1831 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
1832 if ((flags & O_ACCMODE) != O_WRONLY)
1834 if ((flags & O_ACCMODE) != O_RDONLY)
1839 static struct nfs_open_context *create_nfs_open_context(struct dentry *dentry, int open_flags, struct file *filp)
1841 return alloc_nfs_open_context(dentry, flags_to_mode(open_flags), filp);
1844 static int do_open(struct inode *inode, struct file *filp)
1846 nfs_fscache_open_file(inode, filp);
1850 static int nfs_finish_open(struct nfs_open_context *ctx,
1851 struct dentry *dentry,
1852 struct file *file, unsigned open_flags)
1856 err = finish_open(file, dentry, do_open);
1859 if (S_ISREG(file->f_path.dentry->d_inode->i_mode))
1860 nfs_file_set_open_context(file, ctx);
1867 int nfs_atomic_open(struct inode *dir, struct dentry *dentry,
1868 struct file *file, unsigned open_flags,
1871 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
1872 struct nfs_open_context *ctx;
1874 struct iattr attr = { .ia_valid = ATTR_OPEN };
1875 struct inode *inode;
1876 unsigned int lookup_flags = 0;
1877 bool switched = false;
1881 /* Expect a negative dentry */
1882 BUG_ON(d_inode(dentry));
1884 dfprintk(VFS, "NFS: atomic_open(%s/%lu), %pd\n",
1885 dir->i_sb->s_id, dir->i_ino, dentry);
1887 err = nfs_check_flags(open_flags);
1891 /* NFS only supports OPEN on regular files */
1892 if ((open_flags & O_DIRECTORY)) {
1893 if (!d_in_lookup(dentry)) {
1895 * Hashed negative dentry with O_DIRECTORY: dentry was
1896 * revalidated and is fine, no need to perform lookup
1901 lookup_flags = LOOKUP_OPEN|LOOKUP_DIRECTORY;
1905 if (dentry->d_name.len > NFS_SERVER(dir)->namelen)
1906 return -ENAMETOOLONG;
1908 if (open_flags & O_CREAT) {
1909 struct nfs_server *server = NFS_SERVER(dir);
1911 if (!(server->attr_bitmask[2] & FATTR4_WORD2_MODE_UMASK))
1912 mode &= ~current_umask();
1914 attr.ia_valid |= ATTR_MODE;
1915 attr.ia_mode = mode;
1917 if (open_flags & O_TRUNC) {
1918 attr.ia_valid |= ATTR_SIZE;
1922 if (!(open_flags & O_CREAT) && !d_in_lookup(dentry)) {
1925 dentry = d_alloc_parallel(dentry->d_parent,
1926 &dentry->d_name, &wq);
1928 return PTR_ERR(dentry);
1929 if (unlikely(!d_in_lookup(dentry)))
1930 return finish_no_open(file, dentry);
1933 ctx = create_nfs_open_context(dentry, open_flags, file);
1938 trace_nfs_atomic_open_enter(dir, ctx, open_flags);
1939 inode = NFS_PROTO(dir)->open_context(dir, ctx, open_flags, &attr, &created);
1941 file->f_mode |= FMODE_CREATED;
1942 if (IS_ERR(inode)) {
1943 err = PTR_ERR(inode);
1944 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
1945 put_nfs_open_context(ctx);
1949 d_splice_alias(NULL, dentry);
1950 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1956 if (!(open_flags & O_NOFOLLOW))
1966 err = nfs_finish_open(ctx, ctx->dentry, file, open_flags);
1967 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
1968 put_nfs_open_context(ctx);
1970 if (unlikely(switched)) {
1971 d_lookup_done(dentry);
1977 res = nfs_lookup(dir, dentry, lookup_flags);
1979 d_lookup_done(dentry);
1986 return PTR_ERR(res);
1987 return finish_no_open(file, res);
1989 EXPORT_SYMBOL_GPL(nfs_atomic_open);
1992 nfs4_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1995 struct inode *inode;
1997 if (!(flags & LOOKUP_OPEN) || (flags & LOOKUP_DIRECTORY))
1999 if (d_mountpoint(dentry))
2002 inode = d_inode(dentry);
2004 /* We can't create new files in nfs_open_revalidate(), so we
2005 * optimize away revalidation of negative dentries.
2010 if (nfs_verifier_is_delegated(dentry))
2011 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
2013 /* NFS only supports OPEN on regular files */
2014 if (!S_ISREG(inode->i_mode))
2017 /* We cannot do exclusive creation on a positive dentry */
2018 if (flags & (LOOKUP_EXCL | LOOKUP_REVAL))
2021 /* Check if the directory changed */
2022 if (!nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU))
2025 /* Let f_op->open() actually open (and revalidate) the file */
2028 if (flags & LOOKUP_RCU)
2030 return nfs_lookup_revalidate_dentry(dir, dentry, inode);
2033 return nfs_do_lookup_revalidate(dir, dentry, flags);
2036 static int nfs4_lookup_revalidate(struct dentry *dentry, unsigned int flags)
2038 return __nfs_lookup_revalidate(dentry, flags,
2039 nfs4_do_lookup_revalidate);
2042 #endif /* CONFIG_NFSV4 */
2045 nfs_add_or_obtain(struct dentry *dentry, struct nfs_fh *fhandle,
2046 struct nfs_fattr *fattr,
2047 struct nfs4_label *label)
2049 struct dentry *parent = dget_parent(dentry);
2050 struct inode *dir = d_inode(parent);
2051 struct inode *inode;
2057 if (fhandle->size == 0) {
2058 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, NULL);
2062 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2063 if (!(fattr->valid & NFS_ATTR_FATTR)) {
2064 struct nfs_server *server = NFS_SB(dentry->d_sb);
2065 error = server->nfs_client->rpc_ops->getattr(server, fhandle,
2070 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
2071 d = d_splice_alias(inode, dentry);
2079 EXPORT_SYMBOL_GPL(nfs_add_or_obtain);
2082 * Code common to create, mkdir, and mknod.
2084 int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fhandle,
2085 struct nfs_fattr *fattr,
2086 struct nfs4_label *label)
2090 d = nfs_add_or_obtain(dentry, fhandle, fattr, label);
2094 /* Callers don't care */
2098 EXPORT_SYMBOL_GPL(nfs_instantiate);
2101 * Following a failed create operation, we drop the dentry rather
2102 * than retain a negative dentry. This avoids a problem in the event
2103 * that the operation succeeded on the server, but an error in the
2104 * reply path made it appear to have failed.
2106 int nfs_create(struct user_namespace *mnt_userns, struct inode *dir,
2107 struct dentry *dentry, umode_t mode, bool excl)
2110 int open_flags = excl ? O_CREAT | O_EXCL : O_CREAT;
2113 dfprintk(VFS, "NFS: create(%s/%lu), %pd\n",
2114 dir->i_sb->s_id, dir->i_ino, dentry);
2116 attr.ia_mode = mode;
2117 attr.ia_valid = ATTR_MODE;
2119 trace_nfs_create_enter(dir, dentry, open_flags);
2120 error = NFS_PROTO(dir)->create(dir, dentry, &attr, open_flags);
2121 trace_nfs_create_exit(dir, dentry, open_flags, error);
2129 EXPORT_SYMBOL_GPL(nfs_create);
2132 * See comments for nfs_proc_create regarding failed operations.
2135 nfs_mknod(struct user_namespace *mnt_userns, struct inode *dir,
2136 struct dentry *dentry, umode_t mode, dev_t rdev)
2141 dfprintk(VFS, "NFS: mknod(%s/%lu), %pd\n",
2142 dir->i_sb->s_id, dir->i_ino, dentry);
2144 attr.ia_mode = mode;
2145 attr.ia_valid = ATTR_MODE;
2147 trace_nfs_mknod_enter(dir, dentry);
2148 status = NFS_PROTO(dir)->mknod(dir, dentry, &attr, rdev);
2149 trace_nfs_mknod_exit(dir, dentry, status);
2157 EXPORT_SYMBOL_GPL(nfs_mknod);
2160 * See comments for nfs_proc_create regarding failed operations.
2162 int nfs_mkdir(struct user_namespace *mnt_userns, struct inode *dir,
2163 struct dentry *dentry, umode_t mode)
2168 dfprintk(VFS, "NFS: mkdir(%s/%lu), %pd\n",
2169 dir->i_sb->s_id, dir->i_ino, dentry);
2171 attr.ia_valid = ATTR_MODE;
2172 attr.ia_mode = mode | S_IFDIR;
2174 trace_nfs_mkdir_enter(dir, dentry);
2175 error = NFS_PROTO(dir)->mkdir(dir, dentry, &attr);
2176 trace_nfs_mkdir_exit(dir, dentry, error);
2184 EXPORT_SYMBOL_GPL(nfs_mkdir);
2186 static void nfs_dentry_handle_enoent(struct dentry *dentry)
2188 if (simple_positive(dentry))
2192 int nfs_rmdir(struct inode *dir, struct dentry *dentry)
2196 dfprintk(VFS, "NFS: rmdir(%s/%lu), %pd\n",
2197 dir->i_sb->s_id, dir->i_ino, dentry);
2199 trace_nfs_rmdir_enter(dir, dentry);
2200 if (d_really_is_positive(dentry)) {
2201 down_write(&NFS_I(d_inode(dentry))->rmdir_sem);
2202 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2203 /* Ensure the VFS deletes this inode */
2206 clear_nlink(d_inode(dentry));
2209 nfs_dentry_handle_enoent(dentry);
2211 up_write(&NFS_I(d_inode(dentry))->rmdir_sem);
2213 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2214 trace_nfs_rmdir_exit(dir, dentry, error);
2218 EXPORT_SYMBOL_GPL(nfs_rmdir);
2221 * Remove a file after making sure there are no pending writes,
2222 * and after checking that the file has only one user.
2224 * We invalidate the attribute cache and free the inode prior to the operation
2225 * to avoid possible races if the server reuses the inode.
2227 static int nfs_safe_remove(struct dentry *dentry)
2229 struct inode *dir = d_inode(dentry->d_parent);
2230 struct inode *inode = d_inode(dentry);
2233 dfprintk(VFS, "NFS: safe_remove(%pd2)\n", dentry);
2235 /* If the dentry was sillyrenamed, we simply call d_delete() */
2236 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
2241 trace_nfs_remove_enter(dir, dentry);
2242 if (inode != NULL) {
2243 error = NFS_PROTO(dir)->remove(dir, dentry);
2245 nfs_drop_nlink(inode);
2247 error = NFS_PROTO(dir)->remove(dir, dentry);
2248 if (error == -ENOENT)
2249 nfs_dentry_handle_enoent(dentry);
2250 trace_nfs_remove_exit(dir, dentry, error);
2255 /* We do silly rename. In case sillyrename() returns -EBUSY, the inode
2256 * belongs to an active ".nfs..." file and we return -EBUSY.
2258 * If sillyrename() returns 0, we do nothing, otherwise we unlink.
2260 int nfs_unlink(struct inode *dir, struct dentry *dentry)
2263 int need_rehash = 0;
2265 dfprintk(VFS, "NFS: unlink(%s/%lu, %pd)\n", dir->i_sb->s_id,
2266 dir->i_ino, dentry);
2268 trace_nfs_unlink_enter(dir, dentry);
2269 spin_lock(&dentry->d_lock);
2270 if (d_count(dentry) > 1) {
2271 spin_unlock(&dentry->d_lock);
2272 /* Start asynchronous writeout of the inode */
2273 write_inode_now(d_inode(dentry), 0);
2274 error = nfs_sillyrename(dir, dentry);
2277 if (!d_unhashed(dentry)) {
2281 spin_unlock(&dentry->d_lock);
2282 error = nfs_safe_remove(dentry);
2283 if (!error || error == -ENOENT) {
2284 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2285 } else if (need_rehash)
2288 trace_nfs_unlink_exit(dir, dentry, error);
2291 EXPORT_SYMBOL_GPL(nfs_unlink);
2294 * To create a symbolic link, most file systems instantiate a new inode,
2295 * add a page to it containing the path, then write it out to the disk
2296 * using prepare_write/commit_write.
2298 * Unfortunately the NFS client can't create the in-core inode first
2299 * because it needs a file handle to create an in-core inode (see
2300 * fs/nfs/inode.c:nfs_fhget). We only have a file handle *after* the
2301 * symlink request has completed on the server.
2303 * So instead we allocate a raw page, copy the symname into it, then do
2304 * the SYMLINK request with the page as the buffer. If it succeeds, we
2305 * now have a new file handle and can instantiate an in-core NFS inode
2306 * and move the raw page into its mapping.
2308 int nfs_symlink(struct user_namespace *mnt_userns, struct inode *dir,
2309 struct dentry *dentry, const char *symname)
2314 unsigned int pathlen = strlen(symname);
2317 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s)\n", dir->i_sb->s_id,
2318 dir->i_ino, dentry, symname);
2320 if (pathlen > PAGE_SIZE)
2321 return -ENAMETOOLONG;
2323 attr.ia_mode = S_IFLNK | S_IRWXUGO;
2324 attr.ia_valid = ATTR_MODE;
2326 page = alloc_page(GFP_USER);
2330 kaddr = page_address(page);
2331 memcpy(kaddr, symname, pathlen);
2332 if (pathlen < PAGE_SIZE)
2333 memset(kaddr + pathlen, 0, PAGE_SIZE - pathlen);
2335 trace_nfs_symlink_enter(dir, dentry);
2336 error = NFS_PROTO(dir)->symlink(dir, dentry, page, pathlen, &attr);
2337 trace_nfs_symlink_exit(dir, dentry, error);
2339 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s) error %d\n",
2340 dir->i_sb->s_id, dir->i_ino,
2341 dentry, symname, error);
2348 * No big deal if we can't add this page to the page cache here.
2349 * READLINK will get the missing page from the server if needed.
2351 if (!add_to_page_cache_lru(page, d_inode(dentry)->i_mapping, 0,
2353 SetPageUptodate(page);
2356 * add_to_page_cache_lru() grabs an extra page refcount.
2357 * Drop it here to avoid leaking this page later.
2365 EXPORT_SYMBOL_GPL(nfs_symlink);
2368 nfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
2370 struct inode *inode = d_inode(old_dentry);
2373 dfprintk(VFS, "NFS: link(%pd2 -> %pd2)\n",
2374 old_dentry, dentry);
2376 trace_nfs_link_enter(inode, dir, dentry);
2378 error = NFS_PROTO(dir)->link(inode, dir, &dentry->d_name);
2381 d_add(dentry, inode);
2383 trace_nfs_link_exit(inode, dir, dentry, error);
2386 EXPORT_SYMBOL_GPL(nfs_link);
2390 * FIXME: Some nfsds, like the Linux user space nfsd, may generate a
2391 * different file handle for the same inode after a rename (e.g. when
2392 * moving to a different directory). A fail-safe method to do so would
2393 * be to look up old_dir/old_name, create a link to new_dir/new_name and
2394 * rename the old file using the sillyrename stuff. This way, the original
2395 * file in old_dir will go away when the last process iput()s the inode.
2399 * It actually works quite well. One needs to have the possibility for
2400 * at least one ".nfs..." file in each directory the file ever gets
2401 * moved or linked to which happens automagically with the new
2402 * implementation that only depends on the dcache stuff instead of
2403 * using the inode layer
2405 * Unfortunately, things are a little more complicated than indicated
2406 * above. For a cross-directory move, we want to make sure we can get
2407 * rid of the old inode after the operation. This means there must be
2408 * no pending writes (if it's a file), and the use count must be 1.
2409 * If these conditions are met, we can drop the dentries before doing
2412 int nfs_rename(struct user_namespace *mnt_userns, struct inode *old_dir,
2413 struct dentry *old_dentry, struct inode *new_dir,
2414 struct dentry *new_dentry, unsigned int flags)
2416 struct inode *old_inode = d_inode(old_dentry);
2417 struct inode *new_inode = d_inode(new_dentry);
2418 struct dentry *dentry = NULL, *rehash = NULL;
2419 struct rpc_task *task;
2425 dfprintk(VFS, "NFS: rename(%pd2 -> %pd2, ct=%d)\n",
2426 old_dentry, new_dentry,
2427 d_count(new_dentry));
2429 trace_nfs_rename_enter(old_dir, old_dentry, new_dir, new_dentry);
2431 * For non-directories, check whether the target is busy and if so,
2432 * make a copy of the dentry and then do a silly-rename. If the
2433 * silly-rename succeeds, the copied dentry is hashed and becomes
2436 if (new_inode && !S_ISDIR(new_inode->i_mode)) {
2438 * To prevent any new references to the target during the
2439 * rename, we unhash the dentry in advance.
2441 if (!d_unhashed(new_dentry)) {
2443 rehash = new_dentry;
2446 if (d_count(new_dentry) > 2) {
2449 /* copy the target dentry's name */
2450 dentry = d_alloc(new_dentry->d_parent,
2451 &new_dentry->d_name);
2455 /* silly-rename the existing target ... */
2456 err = nfs_sillyrename(new_dir, new_dentry);
2460 new_dentry = dentry;
2466 task = nfs_async_rename(old_dir, new_dir, old_dentry, new_dentry, NULL);
2468 error = PTR_ERR(task);
2472 error = rpc_wait_for_completion_task(task);
2474 ((struct nfs_renamedata *)task->tk_calldata)->cancelled = 1;
2475 /* Paired with the atomic_dec_and_test() barrier in rpc_do_put_task() */
2478 error = task->tk_status;
2480 /* Ensure the inode attributes are revalidated */
2482 spin_lock(&old_inode->i_lock);
2483 NFS_I(old_inode)->attr_gencount = nfs_inc_attr_generation_counter();
2484 nfs_set_cache_invalid(old_inode, NFS_INO_INVALID_CHANGE |
2485 NFS_INO_INVALID_CTIME |
2486 NFS_INO_REVAL_FORCED);
2487 spin_unlock(&old_inode->i_lock);
2492 trace_nfs_rename_exit(old_dir, old_dentry,
2493 new_dir, new_dentry, error);
2495 if (new_inode != NULL)
2496 nfs_drop_nlink(new_inode);
2498 * The d_move() should be here instead of in an async RPC completion
2499 * handler because we need the proper locks to move the dentry. If
2500 * we're interrupted by a signal, the async RPC completion handler
2501 * should mark the directories for revalidation.
2503 d_move(old_dentry, new_dentry);
2504 nfs_set_verifier(old_dentry,
2505 nfs_save_change_attribute(new_dir));
2506 } else if (error == -ENOENT)
2507 nfs_dentry_handle_enoent(old_dentry);
2509 /* new dentry created? */
2514 EXPORT_SYMBOL_GPL(nfs_rename);
2516 static DEFINE_SPINLOCK(nfs_access_lru_lock);
2517 static LIST_HEAD(nfs_access_lru_list);
2518 static atomic_long_t nfs_access_nr_entries;
2520 static unsigned long nfs_access_max_cachesize = 4*1024*1024;
2521 module_param(nfs_access_max_cachesize, ulong, 0644);
2522 MODULE_PARM_DESC(nfs_access_max_cachesize, "NFS access maximum total cache length");
2524 static void nfs_access_free_entry(struct nfs_access_entry *entry)
2526 put_cred(entry->cred);
2527 kfree_rcu(entry, rcu_head);
2528 smp_mb__before_atomic();
2529 atomic_long_dec(&nfs_access_nr_entries);
2530 smp_mb__after_atomic();
2533 static void nfs_access_free_list(struct list_head *head)
2535 struct nfs_access_entry *cache;
2537 while (!list_empty(head)) {
2538 cache = list_entry(head->next, struct nfs_access_entry, lru);
2539 list_del(&cache->lru);
2540 nfs_access_free_entry(cache);
2544 static unsigned long
2545 nfs_do_access_cache_scan(unsigned int nr_to_scan)
2548 struct nfs_inode *nfsi, *next;
2549 struct nfs_access_entry *cache;
2552 spin_lock(&nfs_access_lru_lock);
2553 list_for_each_entry_safe(nfsi, next, &nfs_access_lru_list, access_cache_inode_lru) {
2554 struct inode *inode;
2556 if (nr_to_scan-- == 0)
2558 inode = &nfsi->vfs_inode;
2559 spin_lock(&inode->i_lock);
2560 if (list_empty(&nfsi->access_cache_entry_lru))
2561 goto remove_lru_entry;
2562 cache = list_entry(nfsi->access_cache_entry_lru.next,
2563 struct nfs_access_entry, lru);
2564 list_move(&cache->lru, &head);
2565 rb_erase(&cache->rb_node, &nfsi->access_cache);
2567 if (!list_empty(&nfsi->access_cache_entry_lru))
2568 list_move_tail(&nfsi->access_cache_inode_lru,
2569 &nfs_access_lru_list);
2572 list_del_init(&nfsi->access_cache_inode_lru);
2573 smp_mb__before_atomic();
2574 clear_bit(NFS_INO_ACL_LRU_SET, &nfsi->flags);
2575 smp_mb__after_atomic();
2577 spin_unlock(&inode->i_lock);
2579 spin_unlock(&nfs_access_lru_lock);
2580 nfs_access_free_list(&head);
2585 nfs_access_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
2587 int nr_to_scan = sc->nr_to_scan;
2588 gfp_t gfp_mask = sc->gfp_mask;
2590 if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
2592 return nfs_do_access_cache_scan(nr_to_scan);
2597 nfs_access_cache_count(struct shrinker *shrink, struct shrink_control *sc)
2599 return vfs_pressure_ratio(atomic_long_read(&nfs_access_nr_entries));
2603 nfs_access_cache_enforce_limit(void)
2605 long nr_entries = atomic_long_read(&nfs_access_nr_entries);
2607 unsigned int nr_to_scan;
2609 if (nr_entries < 0 || nr_entries <= nfs_access_max_cachesize)
2612 diff = nr_entries - nfs_access_max_cachesize;
2613 if (diff < nr_to_scan)
2615 nfs_do_access_cache_scan(nr_to_scan);
2618 static void __nfs_access_zap_cache(struct nfs_inode *nfsi, struct list_head *head)
2620 struct rb_root *root_node = &nfsi->access_cache;
2622 struct nfs_access_entry *entry;
2624 /* Unhook entries from the cache */
2625 while ((n = rb_first(root_node)) != NULL) {
2626 entry = rb_entry(n, struct nfs_access_entry, rb_node);
2627 rb_erase(n, root_node);
2628 list_move(&entry->lru, head);
2630 nfsi->cache_validity &= ~NFS_INO_INVALID_ACCESS;
2633 void nfs_access_zap_cache(struct inode *inode)
2637 if (test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags) == 0)
2639 /* Remove from global LRU init */
2640 spin_lock(&nfs_access_lru_lock);
2641 if (test_and_clear_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2642 list_del_init(&NFS_I(inode)->access_cache_inode_lru);
2644 spin_lock(&inode->i_lock);
2645 __nfs_access_zap_cache(NFS_I(inode), &head);
2646 spin_unlock(&inode->i_lock);
2647 spin_unlock(&nfs_access_lru_lock);
2648 nfs_access_free_list(&head);
2650 EXPORT_SYMBOL_GPL(nfs_access_zap_cache);
2652 static struct nfs_access_entry *nfs_access_search_rbtree(struct inode *inode, const struct cred *cred)
2654 struct rb_node *n = NFS_I(inode)->access_cache.rb_node;
2657 struct nfs_access_entry *entry =
2658 rb_entry(n, struct nfs_access_entry, rb_node);
2659 int cmp = cred_fscmp(cred, entry->cred);
2671 static int nfs_access_get_cached_locked(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res, bool may_block)
2673 struct nfs_inode *nfsi = NFS_I(inode);
2674 struct nfs_access_entry *cache;
2678 spin_lock(&inode->i_lock);
2680 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2682 cache = nfs_access_search_rbtree(inode, cred);
2686 /* Found an entry, is our attribute cache valid? */
2687 if (!nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
2694 spin_unlock(&inode->i_lock);
2695 err = __nfs_revalidate_inode(NFS_SERVER(inode), inode);
2698 spin_lock(&inode->i_lock);
2701 res->cred = cache->cred;
2702 res->mask = cache->mask;
2703 list_move_tail(&cache->lru, &nfsi->access_cache_entry_lru);
2706 spin_unlock(&inode->i_lock);
2709 spin_unlock(&inode->i_lock);
2710 nfs_access_zap_cache(inode);
2714 static int nfs_access_get_cached_rcu(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res)
2716 /* Only check the most recently returned cache entry,
2717 * but do it without locking.
2719 struct nfs_inode *nfsi = NFS_I(inode);
2720 struct nfs_access_entry *cache;
2722 struct list_head *lh;
2725 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2727 lh = rcu_dereference(list_tail_rcu(&nfsi->access_cache_entry_lru));
2728 cache = list_entry(lh, struct nfs_access_entry, lru);
2729 if (lh == &nfsi->access_cache_entry_lru ||
2730 cred_fscmp(cred, cache->cred) != 0)
2734 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
2736 res->cred = cache->cred;
2737 res->mask = cache->mask;
2744 int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct
2745 nfs_access_entry *res, bool may_block)
2749 status = nfs_access_get_cached_rcu(inode, cred, res);
2751 status = nfs_access_get_cached_locked(inode, cred, res,
2756 EXPORT_SYMBOL_GPL(nfs_access_get_cached);
2758 static void nfs_access_add_rbtree(struct inode *inode, struct nfs_access_entry *set)
2760 struct nfs_inode *nfsi = NFS_I(inode);
2761 struct rb_root *root_node = &nfsi->access_cache;
2762 struct rb_node **p = &root_node->rb_node;
2763 struct rb_node *parent = NULL;
2764 struct nfs_access_entry *entry;
2767 spin_lock(&inode->i_lock);
2768 while (*p != NULL) {
2770 entry = rb_entry(parent, struct nfs_access_entry, rb_node);
2771 cmp = cred_fscmp(set->cred, entry->cred);
2774 p = &parent->rb_left;
2776 p = &parent->rb_right;
2780 rb_link_node(&set->rb_node, parent, p);
2781 rb_insert_color(&set->rb_node, root_node);
2782 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2783 spin_unlock(&inode->i_lock);
2786 rb_replace_node(parent, &set->rb_node, root_node);
2787 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2788 list_del(&entry->lru);
2789 spin_unlock(&inode->i_lock);
2790 nfs_access_free_entry(entry);
2793 void nfs_access_add_cache(struct inode *inode, struct nfs_access_entry *set)
2795 struct nfs_access_entry *cache = kmalloc(sizeof(*cache), GFP_KERNEL);
2798 RB_CLEAR_NODE(&cache->rb_node);
2799 cache->cred = get_cred(set->cred);
2800 cache->mask = set->mask;
2802 /* The above field assignments must be visible
2803 * before this item appears on the lru. We cannot easily
2804 * use rcu_assign_pointer, so just force the memory barrier.
2807 nfs_access_add_rbtree(inode, cache);
2809 /* Update accounting */
2810 smp_mb__before_atomic();
2811 atomic_long_inc(&nfs_access_nr_entries);
2812 smp_mb__after_atomic();
2814 /* Add inode to global LRU list */
2815 if (!test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags)) {
2816 spin_lock(&nfs_access_lru_lock);
2817 if (!test_and_set_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2818 list_add_tail(&NFS_I(inode)->access_cache_inode_lru,
2819 &nfs_access_lru_list);
2820 spin_unlock(&nfs_access_lru_lock);
2822 nfs_access_cache_enforce_limit();
2824 EXPORT_SYMBOL_GPL(nfs_access_add_cache);
2826 #define NFS_MAY_READ (NFS_ACCESS_READ)
2827 #define NFS_MAY_WRITE (NFS_ACCESS_MODIFY | \
2828 NFS_ACCESS_EXTEND | \
2830 #define NFS_FILE_MAY_WRITE (NFS_ACCESS_MODIFY | \
2832 #define NFS_DIR_MAY_WRITE NFS_MAY_WRITE
2833 #define NFS_MAY_LOOKUP (NFS_ACCESS_LOOKUP)
2834 #define NFS_MAY_EXECUTE (NFS_ACCESS_EXECUTE)
2836 nfs_access_calc_mask(u32 access_result, umode_t umode)
2840 if (access_result & NFS_MAY_READ)
2842 if (S_ISDIR(umode)) {
2843 if ((access_result & NFS_DIR_MAY_WRITE) == NFS_DIR_MAY_WRITE)
2845 if ((access_result & NFS_MAY_LOOKUP) == NFS_MAY_LOOKUP)
2847 } else if (S_ISREG(umode)) {
2848 if ((access_result & NFS_FILE_MAY_WRITE) == NFS_FILE_MAY_WRITE)
2850 if ((access_result & NFS_MAY_EXECUTE) == NFS_MAY_EXECUTE)
2852 } else if (access_result & NFS_MAY_WRITE)
2857 void nfs_access_set_mask(struct nfs_access_entry *entry, u32 access_result)
2859 entry->mask = access_result;
2861 EXPORT_SYMBOL_GPL(nfs_access_set_mask);
2863 static int nfs_do_access(struct inode *inode, const struct cred *cred, int mask)
2865 struct nfs_access_entry cache;
2866 bool may_block = (mask & MAY_NOT_BLOCK) == 0;
2867 int cache_mask = -1;
2870 trace_nfs_access_enter(inode);
2872 status = nfs_access_get_cached(inode, cred, &cache, may_block);
2881 * Determine which access bits we want to ask for...
2883 cache.mask = NFS_ACCESS_READ | NFS_ACCESS_MODIFY | NFS_ACCESS_EXTEND;
2884 if (nfs_server_capable(inode, NFS_CAP_XATTR)) {
2885 cache.mask |= NFS_ACCESS_XAREAD | NFS_ACCESS_XAWRITE |
2888 if (S_ISDIR(inode->i_mode))
2889 cache.mask |= NFS_ACCESS_DELETE | NFS_ACCESS_LOOKUP;
2891 cache.mask |= NFS_ACCESS_EXECUTE;
2893 status = NFS_PROTO(inode)->access(inode, &cache);
2895 if (status == -ESTALE) {
2896 if (!S_ISDIR(inode->i_mode))
2897 nfs_set_inode_stale(inode);
2899 nfs_zap_caches(inode);
2903 nfs_access_add_cache(inode, &cache);
2905 cache_mask = nfs_access_calc_mask(cache.mask, inode->i_mode);
2906 if ((mask & ~cache_mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) != 0)
2909 trace_nfs_access_exit(inode, mask, cache_mask, status);
2913 static int nfs_open_permission_mask(int openflags)
2917 if (openflags & __FMODE_EXEC) {
2918 /* ONLY check exec rights */
2921 if ((openflags & O_ACCMODE) != O_WRONLY)
2923 if ((openflags & O_ACCMODE) != O_RDONLY)
2930 int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags)
2932 return nfs_do_access(inode, cred, nfs_open_permission_mask(openflags));
2934 EXPORT_SYMBOL_GPL(nfs_may_open);
2936 static int nfs_execute_ok(struct inode *inode, int mask)
2938 struct nfs_server *server = NFS_SERVER(inode);
2941 if (S_ISDIR(inode->i_mode))
2943 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_OTHER)) {
2944 if (mask & MAY_NOT_BLOCK)
2946 ret = __nfs_revalidate_inode(server, inode);
2948 if (ret == 0 && !execute_ok(inode))
2953 int nfs_permission(struct user_namespace *mnt_userns,
2954 struct inode *inode,
2957 const struct cred *cred = current_cred();
2960 nfs_inc_stats(inode, NFSIOS_VFSACCESS);
2962 if ((mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
2964 /* Is this sys_access() ? */
2965 if (mask & (MAY_ACCESS | MAY_CHDIR))
2968 switch (inode->i_mode & S_IFMT) {
2972 if ((mask & MAY_OPEN) &&
2973 nfs_server_capable(inode, NFS_CAP_ATOMIC_OPEN))
2978 * Optimize away all write operations, since the server
2979 * will check permissions when we perform the op.
2981 if ((mask & MAY_WRITE) && !(mask & MAY_READ))
2986 if (!NFS_PROTO(inode)->access)
2989 res = nfs_do_access(inode, cred, mask);
2991 if (!res && (mask & MAY_EXEC))
2992 res = nfs_execute_ok(inode, mask);
2994 dfprintk(VFS, "NFS: permission(%s/%lu), mask=0x%x, res=%d\n",
2995 inode->i_sb->s_id, inode->i_ino, mask, res);
2998 if (mask & MAY_NOT_BLOCK)
3001 res = nfs_revalidate_inode(NFS_SERVER(inode), inode);
3003 res = generic_permission(&init_user_ns, inode, mask);
3006 EXPORT_SYMBOL_GPL(nfs_permission);
3010 * version-control: t
3011 * kept-new-versions: 5