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