blob: 8a327971d4858dc0424f2ec09bdd59b091b14cb0 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
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
Bryan Schumakerddda8e02012-07-30 16:05:23 -040021#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/time.h>
23#include <linux/errno.h>
24#include <linux/stat.h>
25#include <linux/fcntl.h>
26#include <linux/string.h>
27#include <linux/kernel.h>
28#include <linux/slab.h>
29#include <linux/mm.h>
30#include <linux/sunrpc/clnt.h>
31#include <linux/nfs_fs.h>
32#include <linux/nfs_mount.h>
33#include <linux/pagemap.h>
Chuck Lever873101b2006-08-22 20:06:23 -040034#include <linux/pagevec.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/namei.h>
David Howells54ceac42006-08-22 20:06:13 -040036#include <linux/mount.h>
Mel Gormana0b8cab32013-07-03 15:02:32 -070037#include <linux/swap.h>
Alexey Dobriyane8edc6e2007-05-21 01:22:52 +040038#include <linux/sched.h>
Catalin Marinas04e4bd12010-11-11 12:53:47 +000039#include <linux/kmemleak.h>
Aneesh Kumar K.V64c2ce82010-12-09 11:35:25 +000040#include <linux/xattr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42#include "delegation.h"
Chuck Lever91d5b472006-03-20 13:44:14 -050043#include "iostat.h"
Adrian Bunk4c30d562007-11-21 15:04:31 -080044#include "internal.h"
Trond Myklebustcd9a1c02010-09-17 10:56:50 -040045#include "fscache.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Trond Myklebustf4ce1292013-08-19 18:59:33 -040047#include "nfstrace.h"
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/* #define NFS_DEBUG_VERBOSE 1 */
50
51static int nfs_opendir(struct inode *, struct file *);
Bryan Schumaker480c2002011-03-23 14:48:29 -040052static int nfs_closedir(struct inode *, struct file *);
Al Viro23db8622013-05-17 16:34:50 -040053static int nfs_readdir(struct file *, struct dir_context *);
Josef Bacik02c24a82011-07-16 20:44:56 -040054static int nfs_fsync_dir(struct file *, loff_t, loff_t, int);
Trond Myklebustf0dd2132005-06-22 17:16:29 +000055static loff_t nfs_llseek_dir(struct file *, loff_t, int);
Trond Myklebust11de3b12010-12-01 14:17:06 -050056static void nfs_readdir_clear_array(struct page*);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -080058const struct file_operations nfs_dir_operations = {
Trond Myklebustf0dd2132005-06-22 17:16:29 +000059 .llseek = nfs_llseek_dir,
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 .read = generic_read_dir,
Trond Myklebust93a6ab72020-02-02 17:53:56 -050061 .iterate_shared = nfs_readdir,
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 .open = nfs_opendir,
Bryan Schumaker480c2002011-03-23 14:48:29 -040063 .release = nfs_closedir,
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 .fsync = nfs_fsync_dir,
65};
66
Trond Myklebust11de3b12010-12-01 14:17:06 -050067const struct address_space_operations nfs_dir_aops = {
68 .freepage = nfs_readdir_clear_array,
Bryan Schumakerd1bacf92010-09-24 14:48:42 -040069};
70
Trond Myklebust93b89592020-11-01 15:24:41 -050071static struct nfs_open_dir_context *alloc_nfs_open_dir_context(struct inode *dir)
Bryan Schumaker480c2002011-03-23 14:48:29 -040072{
Trond Myklebust311324a2014-02-07 17:02:08 -050073 struct nfs_inode *nfsi = NFS_I(dir);
Bryan Schumaker480c2002011-03-23 14:48:29 -040074 struct nfs_open_dir_context *ctx;
75 ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
76 if (ctx != NULL) {
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -040077 ctx->duped = 0;
Trond Myklebust311324a2014-02-07 17:02:08 -050078 ctx->attr_gencount = nfsi->attr_gencount;
Bryan Schumaker480c2002011-03-23 14:48:29 -040079 ctx->dir_cookie = 0;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -040080 ctx->dup_cookie = 0;
Trond Myklebustff81dfb2021-09-28 14:33:44 -040081 ctx->page_index = 0;
Trond Myklebust311324a2014-02-07 17:02:08 -050082 spin_lock(&dir->i_lock);
Trond Myklebust1c341b72019-05-22 08:38:57 -040083 if (list_empty(&nfsi->open_files) &&
84 (nfsi->cache_validity & NFS_INO_DATA_INVAL_DEFER))
Trond Myklebustac46b3d2021-03-08 14:42:54 -050085 nfs_set_cache_invalid(dir,
86 NFS_INO_INVALID_DATA |
87 NFS_INO_REVAL_FORCED);
Trond Myklebust311324a2014-02-07 17:02:08 -050088 list_add(&ctx->list, &nfsi->open_files);
Trond Myklebustff81dfb2021-09-28 14:33:44 -040089 clear_bit(NFS_INO_FORCE_READDIR, &nfsi->flags);
Trond Myklebust311324a2014-02-07 17:02:08 -050090 spin_unlock(&dir->i_lock);
Trond Myklebust0c030802011-07-30 12:45:35 -040091 return ctx;
92 }
93 return ERR_PTR(-ENOMEM);
Bryan Schumaker480c2002011-03-23 14:48:29 -040094}
95
Trond Myklebust311324a2014-02-07 17:02:08 -050096static void put_nfs_open_dir_context(struct inode *dir, struct nfs_open_dir_context *ctx)
Bryan Schumaker480c2002011-03-23 14:48:29 -040097{
Trond Myklebust311324a2014-02-07 17:02:08 -050098 spin_lock(&dir->i_lock);
99 list_del(&ctx->list);
100 spin_unlock(&dir->i_lock);
Bryan Schumaker480c2002011-03-23 14:48:29 -0400101 kfree(ctx);
102}
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104/*
105 * Open file
106 */
107static int
108nfs_opendir(struct inode *inode, struct file *filp)
109{
Bryan Schumaker480c2002011-03-23 14:48:29 -0400110 int res = 0;
111 struct nfs_open_dir_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Al Viro6de14722013-09-16 10:53:17 -0400113 dfprintk(FILE, "NFS: open dir(%pD2)\n", filp);
Chuck Levercc0dd2d2008-06-11 17:55:42 -0400114
115 nfs_inc_stats(inode, NFSIOS_VFSOPEN);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500116
Trond Myklebust93b89592020-11-01 15:24:41 -0500117 ctx = alloc_nfs_open_dir_context(inode);
Bryan Schumaker480c2002011-03-23 14:48:29 -0400118 if (IS_ERR(ctx)) {
119 res = PTR_ERR(ctx);
120 goto out;
121 }
122 filp->private_data = ctx;
Bryan Schumaker480c2002011-03-23 14:48:29 -0400123out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 return res;
125}
126
Bryan Schumaker480c2002011-03-23 14:48:29 -0400127static int
128nfs_closedir(struct inode *inode, struct file *filp)
129{
Al Viroa4555892014-10-21 20:11:25 -0400130 put_nfs_open_dir_context(file_inode(filp), filp->private_data);
Bryan Schumaker480c2002011-03-23 14:48:29 -0400131 return 0;
132}
133
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400134struct nfs_cache_array_entry {
135 u64 cookie;
136 u64 ino;
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500137 const char *name;
138 unsigned int name_len;
Trond Myklebust0b26a0b2010-11-20 14:26:44 -0500139 unsigned char d_type;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400140};
141
142struct nfs_cache_array {
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400143 u64 last_cookie;
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500144 unsigned int size;
145 unsigned char page_full : 1,
Trond Myklebust762567b2020-11-04 08:32:19 -0500146 page_is_eof : 1,
147 cookies_are_ordered : 1;
Gustavo A. R. Silva5601cda2020-03-09 13:24:42 -0500148 struct nfs_cache_array_entry array[];
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400149};
150
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500151struct nfs_readdir_descriptor {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 struct file *file;
153 struct page *page;
Al Viro23db8622013-05-17 16:34:50 -0400154 struct dir_context *ctx;
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500155 pgoff_t page_index;
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500156 u64 dir_cookie;
Trond Myklebust0aded702010-11-30 21:56:32 -0500157 u64 last_cookie;
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500158 u64 dup_cookie;
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000159 loff_t current_index;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500160 loff_t prev_index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400161
Trond Myklebustb593c092020-11-02 20:06:12 -0500162 __be32 verf[NFS_DIR_VERIFIER_SIZE];
Trond Myklebusta1147b82020-02-05 09:01:52 -0500163 unsigned long dir_verifier;
Neil Brown1f4eab72007-04-16 09:35:27 +1000164 unsigned long timestamp;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400165 unsigned long gencount;
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500166 unsigned long attr_gencount;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400167 unsigned int cache_entry_index;
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500168 signed char duped;
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400169 bool plus;
170 bool eof;
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500171};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500173static void nfs_readdir_array_init(struct nfs_cache_array *array)
174{
175 memset(array, 0, sizeof(struct nfs_cache_array));
176}
177
178static void nfs_readdir_page_init_array(struct page *page, u64 last_cookie)
Trond Myklebust4b310312020-02-02 17:53:53 -0500179{
180 struct nfs_cache_array *array;
181
182 array = kmap_atomic(page);
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500183 nfs_readdir_array_init(array);
184 array->last_cookie = last_cookie;
Trond Myklebust762567b2020-11-04 08:32:19 -0500185 array->cookies_are_ordered = 1;
Trond Myklebust4b310312020-02-02 17:53:53 -0500186 kunmap_atomic(array);
187}
188
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400189/*
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400190 * we are freeing strings created by nfs_add_to_readdir_array()
191 */
192static
Trond Myklebust11de3b12010-12-01 14:17:06 -0500193void nfs_readdir_clear_array(struct page *page)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400194{
Trond Myklebust11de3b12010-12-01 14:17:06 -0500195 struct nfs_cache_array *array;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400196 int i;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500197
Cong Wang2b86ce22011-11-25 23:14:33 +0800198 array = kmap_atomic(page);
Benjamin Coddingtonb044f642017-03-10 17:07:46 -0500199 for (i = 0; i < array->size; i++)
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500200 kfree(array->array[i].name);
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500201 nfs_readdir_array_init(array);
Cong Wang2b86ce22011-11-25 23:14:33 +0800202 kunmap_atomic(array);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400203}
204
Trond Myklebust35df59d2020-11-06 20:38:47 -0500205static struct page *
206nfs_readdir_page_array_alloc(u64 last_cookie, gfp_t gfp_flags)
207{
208 struct page *page = alloc_page(gfp_flags);
209 if (page)
210 nfs_readdir_page_init_array(page, last_cookie);
211 return page;
212}
213
214static void nfs_readdir_page_array_free(struct page *page)
215{
216 if (page) {
217 nfs_readdir_clear_array(page);
218 put_page(page);
219 }
220}
221
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500222static void nfs_readdir_array_set_eof(struct nfs_cache_array *array)
223{
224 array->page_is_eof = 1;
225 array->page_full = 1;
226}
227
228static bool nfs_readdir_array_is_full(struct nfs_cache_array *array)
229{
230 return array->page_full;
231}
232
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400233/*
234 * the caller is responsible for freeing qstr.name
235 * when called by nfs_readdir_add_to_array, the strings will be freed in
236 * nfs_clear_readdir_array()
237 */
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500238static const char *nfs_readdir_copy_name(const char *name, unsigned int len)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400239{
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500240 const char *ret = kmemdup_nul(name, len, GFP_KERNEL);
241
Catalin Marinas04e4bd12010-11-11 12:53:47 +0000242 /*
243 * Avoid a kmemleak false positive. The pointer to the name is stored
244 * in a page cache page which kmemleak does not scan.
245 */
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500246 if (ret != NULL)
247 kmemleak_not_leak(ret);
248 return ret;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400249}
250
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500251/*
252 * Check that the next array entry lies entirely within the page bounds
253 */
254static int nfs_readdir_array_can_expand(struct nfs_cache_array *array)
255{
256 struct nfs_cache_array_entry *cache_entry;
257
258 if (array->page_full)
259 return -ENOSPC;
260 cache_entry = &array->array[array->size + 1];
261 if ((char *)cache_entry - (char *)array > PAGE_SIZE) {
262 array->page_full = 1;
263 return -ENOSPC;
264 }
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400265 return 0;
266}
267
268static
269int nfs_readdir_add_to_array(struct nfs_entry *entry, struct page *page)
270{
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500271 struct nfs_cache_array *array;
Trond Myklebust4a201d62010-10-23 14:53:23 -0400272 struct nfs_cache_array_entry *cache_entry;
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500273 const char *name;
Trond Myklebust4a201d62010-10-23 14:53:23 -0400274 int ret;
275
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500276 name = nfs_readdir_copy_name(entry->name, entry->len);
277 if (!name)
278 return -ENOMEM;
Trond Myklebust30200932010-11-20 15:18:22 -0500279
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500280 array = kmap_atomic(page);
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500281 ret = nfs_readdir_array_can_expand(array);
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500282 if (ret) {
283 kfree(name);
Trond Myklebust30200932010-11-20 15:18:22 -0500284 goto out;
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500285 }
Trond Myklebust30200932010-11-20 15:18:22 -0500286
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500287 cache_entry = &array->array[array->size];
Trond Myklebust4a201d62010-10-23 14:53:23 -0400288 cache_entry->cookie = entry->prev_cookie;
289 cache_entry->ino = entry->ino;
Trond Myklebust0b26a0b2010-11-20 14:26:44 -0500290 cache_entry->d_type = entry->d_type;
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500291 cache_entry->name_len = entry->len;
292 cache_entry->name = name;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400293 array->last_cookie = entry->cookie;
Trond Myklebust762567b2020-11-04 08:32:19 -0500294 if (array->last_cookie <= cache_entry->cookie)
295 array->cookies_are_ordered = 0;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500296 array->size++;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500297 if (entry->eof != 0)
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500298 nfs_readdir_array_set_eof(array);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400299out:
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500300 kunmap_atomic(array);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400301 return ret;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400302}
303
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500304static struct page *nfs_readdir_page_get_locked(struct address_space *mapping,
305 pgoff_t index, u64 last_cookie)
306{
307 struct page *page;
308
309 page = grab_cache_page(mapping, index);
310 if (page && !PageUptodate(page)) {
311 nfs_readdir_page_init_array(page, last_cookie);
312 if (invalidate_inode_pages2_range(mapping, index + 1, -1) < 0)
313 nfs_zap_mapping(mapping->host, mapping);
314 SetPageUptodate(page);
315 }
316
317 return page;
318}
319
320static u64 nfs_readdir_page_last_cookie(struct page *page)
321{
322 struct nfs_cache_array *array;
323 u64 ret;
324
325 array = kmap_atomic(page);
326 ret = array->last_cookie;
327 kunmap_atomic(array);
328 return ret;
329}
330
331static bool nfs_readdir_page_needs_filling(struct page *page)
332{
333 struct nfs_cache_array *array;
334 bool ret;
335
336 array = kmap_atomic(page);
337 ret = !nfs_readdir_array_is_full(array);
338 kunmap_atomic(array);
339 return ret;
340}
341
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500342static void nfs_readdir_page_set_eof(struct page *page)
343{
344 struct nfs_cache_array *array;
345
346 array = kmap_atomic(page);
347 nfs_readdir_array_set_eof(array);
348 kunmap_atomic(array);
349}
350
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500351static void nfs_readdir_page_unlock_and_put(struct page *page)
352{
353 unlock_page(page);
354 put_page(page);
355}
356
357static struct page *nfs_readdir_page_get_next(struct address_space *mapping,
358 pgoff_t index, u64 cookie)
359{
360 struct page *page;
361
362 page = nfs_readdir_page_get_locked(mapping, index, cookie);
363 if (page) {
364 if (nfs_readdir_page_last_cookie(page) == cookie)
365 return page;
366 nfs_readdir_page_unlock_and_put(page);
367 }
368 return NULL;
369}
370
Trond Myklebust59e356a2020-02-03 14:49:33 -0500371static inline
372int is_32bit_api(void)
373{
374#ifdef CONFIG_COMPAT
375 return in_compat_syscall();
376#else
377 return (BITS_PER_LONG == 32);
378#endif
379}
380
381static
382bool nfs_readdir_use_cookie(const struct file *filp)
383{
384 if ((filp->f_mode & FMODE_32BITHASH) ||
385 (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
386 return false;
387 return true;
388}
389
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500390static int nfs_readdir_search_for_pos(struct nfs_cache_array *array,
391 struct nfs_readdir_descriptor *desc)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400392{
Al Viro23db8622013-05-17 16:34:50 -0400393 loff_t diff = desc->ctx->pos - desc->current_index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400394 unsigned int index;
395
396 if (diff < 0)
397 goto out_eof;
398 if (diff >= array->size) {
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500399 if (array->page_is_eof)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400400 goto out_eof;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400401 return -EAGAIN;
402 }
403
404 index = (unsigned int)diff;
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500405 desc->dir_cookie = array->array[index].cookie;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400406 desc->cache_entry_index = index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400407 return 0;
408out_eof:
Thomas Meyer6089dd02017-10-07 16:02:21 +0200409 desc->eof = true;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400410 return -EBADCOOKIE;
411}
412
Jeff Layton4db72b42014-01-28 13:47:46 -0500413static bool
414nfs_readdir_inode_mapping_valid(struct nfs_inode *nfsi)
415{
Trond Myklebust2929bc32021-09-28 12:37:05 -0400416 if (nfsi->cache_validity & (NFS_INO_INVALID_CHANGE |
417 NFS_INO_INVALID_DATA))
Jeff Layton4db72b42014-01-28 13:47:46 -0500418 return false;
419 smp_rmb();
420 return !test_bit(NFS_INO_INVALIDATING, &nfsi->flags);
421}
422
Trond Myklebust762567b2020-11-04 08:32:19 -0500423static bool nfs_readdir_array_cookie_in_range(struct nfs_cache_array *array,
424 u64 cookie)
425{
426 if (!array->cookies_are_ordered)
427 return true;
428 /* Optimisation for monotonically increasing cookies */
429 if (cookie >= array->last_cookie)
430 return false;
431 if (array->size && cookie < array->array[0].cookie)
432 return false;
433 return true;
434}
435
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500436static int nfs_readdir_search_for_cookie(struct nfs_cache_array *array,
437 struct nfs_readdir_descriptor *desc)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400438{
439 int i;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400440 loff_t new_pos;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400441 int status = -EAGAIN;
442
Trond Myklebust762567b2020-11-04 08:32:19 -0500443 if (!nfs_readdir_array_cookie_in_range(array, desc->dir_cookie))
444 goto check_eof;
445
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400446 for (i = 0; i < array->size; i++) {
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500447 if (array->array[i].cookie == desc->dir_cookie) {
Al Viro496ad9a2013-01-23 17:07:38 -0500448 struct nfs_inode *nfsi = NFS_I(file_inode(desc->file));
Trond Myklebust0c030802011-07-30 12:45:35 -0400449
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400450 new_pos = desc->current_index + i;
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500451 if (desc->attr_gencount != nfsi->attr_gencount ||
Jeff Layton4db72b42014-01-28 13:47:46 -0500452 !nfs_readdir_inode_mapping_valid(nfsi)) {
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500453 desc->duped = 0;
454 desc->attr_gencount = nfsi->attr_gencount;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500455 } else if (new_pos < desc->prev_index) {
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500456 if (desc->duped > 0
457 && desc->dup_cookie == desc->dir_cookie) {
Trond Myklebust0c030802011-07-30 12:45:35 -0400458 if (printk_ratelimit()) {
Al Viro6de14722013-09-16 10:53:17 -0400459 pr_notice("NFS: directory %pD2 contains a readdir loop."
Trond Myklebust0c030802011-07-30 12:45:35 -0400460 "Please contact your server vendor. "
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500461 "The file: %s has duplicate cookie %llu\n",
462 desc->file, array->array[i].name, desc->dir_cookie);
Trond Myklebust0c030802011-07-30 12:45:35 -0400463 }
464 status = -ELOOP;
465 goto out;
466 }
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500467 desc->dup_cookie = desc->dir_cookie;
468 desc->duped = -1;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400469 }
Trond Myklebust59e356a2020-02-03 14:49:33 -0500470 if (nfs_readdir_use_cookie(desc->file))
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500471 desc->ctx->pos = desc->dir_cookie;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500472 else
473 desc->ctx->pos = new_pos;
474 desc->prev_index = new_pos;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400475 desc->cache_entry_index = i;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500476 return 0;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400477 }
478 }
Trond Myklebust762567b2020-11-04 08:32:19 -0500479check_eof:
Trond Myklebustb1e21c92020-11-01 13:45:55 -0500480 if (array->page_is_eof) {
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500481 status = -EBADCOOKIE;
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500482 if (desc->dir_cookie == array->last_cookie)
Thomas Meyer6089dd02017-10-07 16:02:21 +0200483 desc->eof = true;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500484 }
Trond Myklebust0c030802011-07-30 12:45:35 -0400485out:
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400486 return status;
487}
488
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500489static int nfs_readdir_search_array(struct nfs_readdir_descriptor *desc)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400490{
491 struct nfs_cache_array *array;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500492 int status;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400493
Trond Myklebusted092222020-11-01 13:34:32 -0500494 array = kmap_atomic(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400495
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500496 if (desc->dir_cookie == 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400497 status = nfs_readdir_search_for_pos(array, desc);
498 else
499 status = nfs_readdir_search_for_cookie(array, desc);
500
Trond Myklebust47c716c2010-12-07 12:44:56 -0500501 if (status == -EAGAIN) {
Trond Myklebust0aded702010-11-30 21:56:32 -0500502 desc->last_cookie = array->last_cookie;
Trond Myklebuste47c0852011-03-23 08:43:09 -0400503 desc->current_index += array->size;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500504 desc->page_index++;
505 }
Trond Myklebusted092222020-11-01 13:34:32 -0500506 kunmap_atomic(array);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400507 return status;
508}
509
510/* Fill a page with xdr information before transferring to the cache page */
Trond Myklebust93b89592020-11-01 15:24:41 -0500511static int nfs_readdir_xdr_filler(struct nfs_readdir_descriptor *desc,
Trond Myklebustb593c092020-11-02 20:06:12 -0500512 __be32 *verf, u64 cookie,
513 struct page **pages, size_t bufsize,
514 __be32 *verf_res)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400515{
Trond Myklebust82e22a52020-11-02 17:34:23 -0500516 struct inode *inode = file_inode(desc->file);
Trond Myklebust82e22a52020-11-02 17:34:23 -0500517 struct nfs_readdir_arg arg = {
518 .dentry = file_dentry(desc->file),
519 .cred = desc->file->f_cred,
Trond Myklebustb593c092020-11-02 20:06:12 -0500520 .verf = verf,
Trond Myklebust82e22a52020-11-02 17:34:23 -0500521 .cookie = cookie,
522 .pages = pages,
523 .page_len = bufsize,
524 .plus = desc->plus,
525 };
526 struct nfs_readdir_res res = {
527 .verf = verf_res,
528 };
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400529 unsigned long timestamp, gencount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 int error;
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 again:
533 timestamp = jiffies;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400534 gencount = nfs_inc_attr_generation_counter();
Trond Myklebusta1147b82020-02-05 09:01:52 -0500535 desc->dir_verifier = nfs_save_change_attribute(inode);
Trond Myklebust82e22a52020-11-02 17:34:23 -0500536 error = NFS_PROTO(inode)->readdir(&arg, &res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 if (error < 0) {
538 /* We requested READDIRPLUS, but the server doesn't grok it */
539 if (error == -ENOTSUPP && desc->plus) {
540 NFS_SERVER(inode)->caps &= ~NFS_CAP_READDIRPLUS;
Benny Halevy3a10c302008-01-23 08:58:59 +0200541 clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
Trond Myklebust82e22a52020-11-02 17:34:23 -0500542 desc->plus = arg.plus = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 goto again;
544 }
545 goto error;
546 }
Neil Brown1f4eab72007-04-16 09:35:27 +1000547 desc->timestamp = timestamp;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400548 desc->gencount = gencount;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400549error:
550 return error;
551}
552
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500553static int xdr_decode(struct nfs_readdir_descriptor *desc,
Chuck Lever573c4e12010-12-14 14:58:11 +0000554 struct nfs_entry *entry, struct xdr_stream *xdr)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400555{
Trond Myklebust59e356a2020-02-03 14:49:33 -0500556 struct inode *inode = file_inode(desc->file);
Chuck Lever573c4e12010-12-14 14:58:11 +0000557 int error;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400558
Trond Myklebust59e356a2020-02-03 14:49:33 -0500559 error = NFS_PROTO(inode)->decode_dirent(xdr, entry, desc->plus);
Chuck Lever573c4e12010-12-14 14:58:11 +0000560 if (error)
561 return error;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400562 entry->fattr->time_start = desc->timestamp;
563 entry->fattr->gencount = desc->gencount;
564 return 0;
565}
566
Trond Myklebustfa923362015-02-23 18:51:32 -0500567/* Match file and dirent using either filehandle or fileid
568 * Note: caller is responsible for checking the fsid
569 */
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400570static
571int nfs_same_file(struct dentry *dentry, struct nfs_entry *entry)
572{
Trond Myklebustd8fdb472016-06-17 16:48:27 -0400573 struct inode *inode;
Trond Myklebustfa923362015-02-23 18:51:32 -0500574 struct nfs_inode *nfsi;
575
David Howells2b0143b2015-03-17 22:25:59 +0000576 if (d_really_is_negative(dentry))
577 return 0;
Trond Myklebustfa923362015-02-23 18:51:32 -0500578
Trond Myklebustd8fdb472016-06-17 16:48:27 -0400579 inode = d_inode(dentry);
580 if (is_bad_inode(inode) || NFS_STALE(inode))
581 return 0;
582
583 nfsi = NFS_I(inode);
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400584 if (entry->fattr->fileid != nfsi->fileid)
585 return 0;
586 if (entry->fh->size && nfs_compare_fh(entry->fh, &nfsi->fh) != 0)
587 return 0;
588 return 1;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400589}
590
591static
Al Viro23db8622013-05-17 16:34:50 -0400592bool nfs_use_readdirplus(struct inode *dir, struct dir_context *ctx)
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400593{
594 if (!nfs_server_capable(dir, NFS_CAP_READDIRPLUS))
595 return false;
596 if (test_and_clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(dir)->flags))
597 return true;
Al Viro23db8622013-05-17 16:34:50 -0400598 if (ctx->pos == 0)
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400599 return true;
600 return false;
601}
602
603/*
Trond Myklebust63519fb2016-11-19 11:21:54 -0500604 * This function is called by the lookup and getattr code to request the
605 * use of readdirplus to accelerate any future lookups in the same
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400606 * directory.
607 */
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400608void nfs_advise_use_readdirplus(struct inode *dir)
609{
Trond Myklebust63519fb2016-11-19 11:21:54 -0500610 struct nfs_inode *nfsi = NFS_I(dir);
611
612 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
613 !list_empty(&nfsi->open_files))
614 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400615}
616
Trond Myklebust311324a2014-02-07 17:02:08 -0500617/*
618 * This function is mainly for use by nfs_getattr().
619 *
620 * If this is an 'ls -l', we want to force use of readdirplus.
621 * Do this by checking if there is an active file descriptor
622 * and calling nfs_advise_use_readdirplus, then forcing a
623 * cache flush.
624 */
625void nfs_force_use_readdirplus(struct inode *dir)
626{
Trond Myklebust63519fb2016-11-19 11:21:54 -0500627 struct nfs_inode *nfsi = NFS_I(dir);
628
629 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
630 !list_empty(&nfsi->open_files)) {
631 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Trond Myklebustff81dfb2021-09-28 14:33:44 -0400632 set_bit(NFS_INO_FORCE_READDIR, &nfsi->flags);
Trond Myklebust311324a2014-02-07 17:02:08 -0500633 }
634}
635
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400636static
Trond Myklebusta1147b82020-02-05 09:01:52 -0500637void nfs_prime_dcache(struct dentry *parent, struct nfs_entry *entry,
638 unsigned long dir_verifier)
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400639{
Linus Torvalds26fe5752012-05-10 13:14:12 -0700640 struct qstr filename = QSTR_INIT(entry->name, entry->len);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400641 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400642 struct dentry *dentry;
643 struct dentry *alias;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400644 struct inode *inode;
David Quigleyaa9c2662013-05-22 12:50:44 -0400645 int status;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400646
Trond Myklebustfa923362015-02-23 18:51:32 -0500647 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FILEID))
648 return;
Trond Myklebust6c441c22015-02-22 16:35:36 -0500649 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FSID))
650 return;
Trond Myklebust78d04af2016-09-20 14:34:24 -0400651 if (filename.len == 0)
652 return;
653 /* Validate that the name doesn't contain any illegal '\0' */
654 if (strnlen(filename.name, filename.len) != filename.len)
655 return;
656 /* ...or '/' */
657 if (strnchr(filename.name, filename.len, '/'))
658 return;
Trond Myklebust4a201d62010-10-23 14:53:23 -0400659 if (filename.name[0] == '.') {
660 if (filename.len == 1)
661 return;
662 if (filename.len == 2 && filename.name[1] == '.')
663 return;
664 }
Linus Torvalds8387ff22016-06-10 07:51:30 -0700665 filename.hash = full_name_hash(parent, filename.name, filename.len);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400666
Trond Myklebust4a201d62010-10-23 14:53:23 -0400667 dentry = d_lookup(parent, &filename);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400668again:
669 if (!dentry) {
670 dentry = d_alloc_parallel(parent, &filename, &wq);
671 if (IS_ERR(dentry))
672 return;
673 }
674 if (!d_in_lookup(dentry)) {
Trond Myklebust6c441c22015-02-22 16:35:36 -0500675 /* Is there a mountpoint here? If so, just exit */
676 if (!nfs_fsid_equal(&NFS_SB(dentry->d_sb)->fsid,
677 &entry->fattr->fsid))
678 goto out;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400679 if (nfs_same_file(dentry, entry)) {
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400680 if (!entry->fh->size)
681 goto out;
Trond Myklebusta1147b82020-02-05 09:01:52 -0500682 nfs_set_verifier(dentry, dir_verifier);
David Howells2b0143b2015-03-17 22:25:59 +0000683 status = nfs_refresh_inode(d_inode(dentry), entry->fattr);
David Quigleyaa9c2662013-05-22 12:50:44 -0400684 if (!status)
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400685 nfs_setsecurity(d_inode(dentry), entry->fattr,
686 entry->fattr->label);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400687 goto out;
688 } else {
Eric W. Biederman5542aa22014-02-13 09:46:25 -0800689 d_invalidate(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400690 dput(dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400691 dentry = NULL;
692 goto again;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400693 }
694 }
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400695 if (!entry->fh->size) {
696 d_lookup_done(dentry);
697 goto out;
698 }
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400699
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400700 inode = nfs_fhget(dentry->d_sb, entry->fh, entry->fattr, entry->fattr->label);
Al Viro41d28bc2014-10-12 22:24:21 -0400701 alias = d_splice_alias(inode, dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400702 d_lookup_done(dentry);
703 if (alias) {
704 if (IS_ERR(alias))
705 goto out;
706 dput(dentry);
707 dentry = alias;
708 }
Trond Myklebusta1147b82020-02-05 09:01:52 -0500709 nfs_set_verifier(dentry, dir_verifier);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400710out:
711 dput(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400712}
713
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400714/* Perform conversion from xdr to cache array */
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500715static int nfs_readdir_page_filler(struct nfs_readdir_descriptor *desc,
716 struct nfs_entry *entry,
717 struct page **xdr_pages,
Trond Myklebust35df59d2020-11-06 20:38:47 -0500718 unsigned int buflen,
719 struct page **arrays,
720 size_t narrays)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400721{
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500722 struct address_space *mapping = desc->file->f_mapping;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400723 struct xdr_stream stream;
Benny Halevyf7da7a12011-05-19 14:16:47 -0400724 struct xdr_buf buf;
Trond Myklebust35df59d2020-11-06 20:38:47 -0500725 struct page *scratch, *new, *page = *arrays;
Trond Myklebust5c346852010-11-20 12:43:45 -0500726 int status;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400727
Trond Myklebust66502392011-01-08 17:45:38 -0500728 scratch = alloc_page(GFP_KERNEL);
729 if (scratch == NULL)
730 return -ENOMEM;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400731
Benny Halevyf7da7a12011-05-19 14:16:47 -0400732 xdr_init_decode_pages(&stream, &buf, xdr_pages, buflen);
Chuck Lever0ae4c3e2020-11-11 15:52:47 -0500733 xdr_set_scratch_page(&stream, scratch);
Bryan Schumaker99424382010-10-21 16:33:16 -0400734
735 do {
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400736 if (entry->fattr->label)
737 entry->fattr->label->len = NFS4_MAXLABELLEN;
Jeffrey Mitchelld33030e2020-09-15 16:42:52 -0500738
Bryan Schumaker99424382010-10-21 16:33:16 -0400739 status = xdr_decode(desc, entry, &stream);
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500740 if (status != 0)
Bryan Schumaker99424382010-10-21 16:33:16 -0400741 break;
Trond Myklebust5c346852010-11-20 12:43:45 -0500742
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400743 if (desc->plus)
Trond Myklebusta1147b82020-02-05 09:01:52 -0500744 nfs_prime_dcache(file_dentry(desc->file), entry,
745 desc->dir_verifier);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500746
Max Kellermanndb531db2019-07-12 16:18:06 +0200747 status = nfs_readdir_add_to_array(entry, page);
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500748 if (status != -ENOSPC)
749 continue;
Bryan Schumaker99424382010-10-21 16:33:16 -0400750
Trond Myklebust35df59d2020-11-06 20:38:47 -0500751 if (page->mapping != mapping) {
752 if (!--narrays)
753 break;
754 new = nfs_readdir_page_array_alloc(entry->prev_cookie,
755 GFP_KERNEL);
756 if (!new)
757 break;
758 arrays++;
759 *arrays = page = new;
760 } else {
761 new = nfs_readdir_page_get_next(mapping,
762 page->index + 1,
763 entry->prev_cookie);
764 if (!new)
765 break;
766 if (page != *arrays)
767 nfs_readdir_page_unlock_and_put(page);
768 page = new;
769 }
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500770 status = nfs_readdir_add_to_array(entry, page);
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500771 } while (!status && !entry->eof);
Bryan Schumaker99424382010-10-21 16:33:16 -0400772
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500773 switch (status) {
774 case -EBADCOOKIE:
775 if (entry->eof) {
776 nfs_readdir_page_set_eof(page);
777 status = 0;
778 }
779 break;
780 case -ENOSPC:
781 case -EAGAIN:
Fabian Frederick0795bf82017-05-03 20:52:21 +0200782 status = 0;
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500783 break;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400784 }
Trond Myklebust66502392011-01-08 17:45:38 -0500785
Trond Myklebust35df59d2020-11-06 20:38:47 -0500786 if (page != *arrays)
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500787 nfs_readdir_page_unlock_and_put(page);
788
Trond Myklebust66502392011-01-08 17:45:38 -0500789 put_page(scratch);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500790 return status;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400791}
792
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500793static void nfs_readdir_free_pages(struct page **pages, size_t npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400794{
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500795 while (npages--)
796 put_page(pages[npages]);
797 kfree(pages);
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400798}
799
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400800/*
zhangliguangbf211ca2019-02-16 08:38:40 +0800801 * nfs_readdir_alloc_pages() will allocate pages that must be freed with a call
802 * to nfs_readdir_free_pages()
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400803 */
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500804static struct page **nfs_readdir_alloc_pages(size_t npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400805{
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500806 struct page **pages;
807 size_t i;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400808
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500809 pages = kmalloc_array(npages, sizeof(*pages), GFP_KERNEL);
810 if (!pages)
811 return NULL;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400812 for (i = 0; i < npages; i++) {
813 struct page *page = alloc_page(GFP_KERNEL);
814 if (page == NULL)
815 goto out_freepages;
816 pages[i] = page;
817 }
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500818 return pages;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400819
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400820out_freepages:
Anna Schumakerc7e96682015-07-13 14:01:25 -0400821 nfs_readdir_free_pages(pages, i);
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500822 return NULL;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400823}
824
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500825static int nfs_readdir_xdr_to_array(struct nfs_readdir_descriptor *desc,
Trond Myklebust35df59d2020-11-06 20:38:47 -0500826 __be32 *verf_arg, __be32 *verf_res,
827 struct page **arrays, size_t narrays)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400828{
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500829 struct page **pages;
Trond Myklebust35df59d2020-11-06 20:38:47 -0500830 struct page *page = *arrays;
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500831 struct nfs_entry *entry;
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500832 size_t array_size;
Trond Myklebustb593c092020-11-02 20:06:12 -0500833 struct inode *inode = file_inode(desc->file);
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500834 size_t dtsize = NFS_SERVER(inode)->dtsize;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500835 int status = -ENOMEM;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400836
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500837 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
838 if (!entry)
839 return -ENOMEM;
840 entry->cookie = nfs_readdir_page_last_cookie(page);
841 entry->fh = nfs_alloc_fhandle();
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400842 entry->fattr = nfs_alloc_fattr_with_label(NFS_SERVER(inode));
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500843 entry->server = NFS_SERVER(inode);
844 if (entry->fh == NULL || entry->fattr == NULL)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400845 goto out;
846
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500847 array_size = (dtsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
848 pages = nfs_readdir_alloc_pages(array_size);
849 if (!pages)
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400850 goto out;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400851
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400852 do {
Trond Myklebustac396122010-11-15 20:26:22 -0500853 unsigned int pglen;
Trond Myklebustb593c092020-11-02 20:06:12 -0500854 status = nfs_readdir_xdr_filler(desc, verf_arg, entry->cookie,
855 pages, dtsize,
856 verf_res);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400857 if (status < 0)
858 break;
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500859
Trond Myklebustac396122010-11-15 20:26:22 -0500860 pglen = status;
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500861 if (pglen == 0) {
862 nfs_readdir_page_set_eof(page);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500863 break;
864 }
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500865
Nagendra S Tomaree3707a2021-03-16 10:25:14 +0000866 verf_arg = verf_res;
867
Trond Myklebust35df59d2020-11-06 20:38:47 -0500868 status = nfs_readdir_page_filler(desc, entry, pages, pglen,
869 arrays, narrays);
Trond Myklebuste762a632020-11-01 13:31:20 -0500870 } while (!status && nfs_readdir_page_needs_filling(page));
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400871
Anna Schumakerc7e96682015-07-13 14:01:25 -0400872 nfs_readdir_free_pages(pages, array_size);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400873out:
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500874 nfs_free_fattr(entry->fattr);
875 nfs_free_fhandle(entry->fh);
876 kfree(entry);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400877 return status;
878}
879
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500880static void nfs_readdir_page_put(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300882 put_page(desc->page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 desc->page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884}
885
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500886static void
887nfs_readdir_page_unlock_and_put_cached(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500889 unlock_page(desc->page);
890 nfs_readdir_page_put(desc);
891}
892
893static struct page *
894nfs_readdir_page_get_cached(struct nfs_readdir_descriptor *desc)
895{
896 return nfs_readdir_page_get_locked(desc->file->f_mapping,
897 desc->page_index,
898 desc->last_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899}
900
901/*
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400902 * Returns 0 if desc->dir_cookie was found on page desc->page_index
Trond Myklebust114de382020-02-02 17:53:54 -0500903 * and locks the page to prevent removal from the page cache.
Olivier Galibert00a92642005-06-22 17:16:29 +0000904 */
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500905static int find_and_lock_cache_page(struct nfs_readdir_descriptor *desc)
Olivier Galibert00a92642005-06-22 17:16:29 +0000906{
Dai Ngo227823d2020-01-22 20:45:39 -0500907 struct inode *inode = file_inode(desc->file);
908 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebustb593c092020-11-02 20:06:12 -0500909 __be32 verf[NFS_DIR_VERIFIER_SIZE];
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400910 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000911
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500912 desc->page = nfs_readdir_page_get_cached(desc);
913 if (!desc->page)
914 return -ENOMEM;
915 if (nfs_readdir_page_needs_filling(desc->page)) {
Trond Myklebust35df59d2020-11-06 20:38:47 -0500916 res = nfs_readdir_xdr_to_array(desc, nfsi->cookieverf, verf,
917 &desc->page, 1);
Trond Myklebust9fff59e2020-11-02 20:11:32 -0500918 if (res < 0) {
919 nfs_readdir_page_unlock_and_put_cached(desc);
920 if (res == -EBADCOOKIE || res == -ENOTSYNC) {
921 invalidate_inode_pages2(desc->file->f_mapping);
922 desc->page_index = 0;
923 return -EAGAIN;
924 }
925 return res;
Dai Ngo227823d2020-01-22 20:45:39 -0500926 }
Trond Myklebustf892c412021-03-17 08:46:19 -0400927 /*
928 * Set the cookie verifier if the page cache was empty
929 */
930 if (desc->page_index == 0)
931 memcpy(nfsi->cookieverf, verf,
932 sizeof(nfsi->cookieverf));
Trond Myklebust114de382020-02-02 17:53:54 -0500933 }
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500934 res = nfs_readdir_search_array(desc);
Trond Myklebustff81dfb2021-09-28 14:33:44 -0400935 if (res == 0)
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500936 return 0;
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500937 nfs_readdir_page_unlock_and_put_cached(desc);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400938 return res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000939}
940
Trond Myklebust794092c2020-11-06 20:47:05 -0500941static bool nfs_readdir_dont_search_cache(struct nfs_readdir_descriptor *desc)
942{
943 struct address_space *mapping = desc->file->f_mapping;
944 struct inode *dir = file_inode(desc->file);
945 unsigned int dtsize = NFS_SERVER(dir)->dtsize;
946 loff_t size = i_size_read(dir);
947
948 /*
949 * Default to uncached readdir if the page cache is empty, and
950 * we're looking for a non-zero cookie in a large directory.
951 */
952 return desc->dir_cookie != 0 && mapping->nrpages == 0 && size > dtsize;
953}
954
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400955/* Search for desc->dir_cookie from the beginning of the page cache */
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500956static int readdir_search_pagecache(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957{
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500958 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000959
Trond Myklebust794092c2020-11-06 20:47:05 -0500960 if (nfs_readdir_dont_search_cache(desc))
961 return -EBADCOOKIE;
962
Trond Myklebust47c716c2010-12-07 12:44:56 -0500963 do {
Trond Myklebust9fff59e2020-11-02 20:11:32 -0500964 if (desc->page_index == 0) {
965 desc->current_index = 0;
966 desc->prev_index = 0;
967 desc->last_cookie = 0;
968 }
Trond Myklebust114de382020-02-02 17:53:54 -0500969 res = find_and_lock_cache_page(desc);
Trond Myklebust47c716c2010-12-07 12:44:56 -0500970 } while (res == -EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 return res;
972}
973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974/*
975 * Once we've found the start of the dirent within a page: fill 'er up...
976 */
Trond Myklebust13884ff2021-03-16 07:57:40 -0400977static void nfs_do_filldir(struct nfs_readdir_descriptor *desc,
978 const __be32 *verf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
980 struct file *file = desc->file;
Trond Myklebustdbeaf8c2020-11-01 18:20:03 -0500981 struct nfs_cache_array *array;
982 unsigned int i = 0;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400983
Fabian Frederick0795bf82017-05-03 20:52:21 +0200984 array = kmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400985 for (i = desc->cache_entry_index; i < array->size; i++) {
Trond Myklebustece0b422010-11-20 13:55:33 -0500986 struct nfs_cache_array_entry *ent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Trond Myklebustece0b422010-11-20 13:55:33 -0500988 ent = &array->array[i];
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500989 if (!dir_emit(desc->ctx, ent->name, ent->name_len,
Al Viro23db8622013-05-17 16:34:50 -0400990 nfs_compat_user_ino64(ent->ino), ent->d_type)) {
Thomas Meyer6089dd02017-10-07 16:02:21 +0200991 desc->eof = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 break;
Trond Myklebustece0b422010-11-20 13:55:33 -0500993 }
Trond Myklebust13884ff2021-03-16 07:57:40 -0400994 memcpy(desc->verf, verf, sizeof(desc->verf));
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400995 if (i < (array->size-1))
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500996 desc->dir_cookie = array->array[i+1].cookie;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400997 else
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500998 desc->dir_cookie = array->last_cookie;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500999 if (nfs_readdir_use_cookie(file))
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001000 desc->ctx->pos = desc->dir_cookie;
Trond Myklebust59e356a2020-02-03 14:49:33 -05001001 else
1002 desc->ctx->pos++;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001003 if (desc->duped != 0)
1004 desc->duped = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 }
Trond Myklebustb1e21c92020-11-01 13:45:55 -05001006 if (array->page_is_eof)
Thomas Meyer6089dd02017-10-07 16:02:21 +02001007 desc->eof = true;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -04001008
Fabian Frederick0795bf82017-05-03 20:52:21 +02001009 kunmap(desc->page);
Trond Myklebustdbeaf8c2020-11-01 18:20:03 -05001010 dfprintk(DIRCACHE, "NFS: nfs_do_filldir() filling ended @ cookie %llu\n",
1011 (unsigned long long)desc->dir_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012}
1013
1014/*
1015 * If we cannot find a cookie in our cache, we suspect that this is
1016 * because it points to a deleted file, so we ask the server to return
1017 * whatever it thinks is the next entry. We then feed this to filldir.
1018 * If all goes well, we should then be able to find our way round the
1019 * cache on the next call to readdir_search_pagecache();
1020 *
1021 * NOTE: we cannot add the anonymous page to the pagecache because
1022 * the data it contains might not be page aligned. Besides,
1023 * we should already have a complete representation of the
1024 * directory in the page cache by the time we get here.
1025 */
Trond Myklebust6c981ef2020-11-03 07:42:04 -05001026static int uncached_readdir(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027{
Trond Myklebust35df59d2020-11-06 20:38:47 -05001028 struct page **arrays;
1029 size_t i, sz = 512;
Trond Myklebustb593c092020-11-02 20:06:12 -05001030 __be32 verf[NFS_DIR_VERIFIER_SIZE];
Trond Myklebust35df59d2020-11-06 20:38:47 -05001031 int status = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
Trond Myklebust35df59d2020-11-06 20:38:47 -05001033 dfprintk(DIRCACHE, "NFS: uncached_readdir() searching for cookie %llu\n",
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001034 (unsigned long long)desc->dir_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Trond Myklebust35df59d2020-11-06 20:38:47 -05001036 arrays = kcalloc(sz, sizeof(*arrays), GFP_KERNEL);
1037 if (!arrays)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 goto out;
Trond Myklebust35df59d2020-11-06 20:38:47 -05001039 arrays[0] = nfs_readdir_page_array_alloc(desc->dir_cookie, GFP_KERNEL);
1040 if (!arrays[0])
1041 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -05001043 desc->page_index = 0;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001044 desc->last_cookie = desc->dir_cookie;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001045 desc->duped = 0;
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -05001046
Trond Myklebust35df59d2020-11-06 20:38:47 -05001047 status = nfs_readdir_xdr_to_array(desc, desc->verf, verf, arrays, sz);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -04001048
Trond Myklebust35df59d2020-11-06 20:38:47 -05001049 for (i = 0; !desc->eof && i < sz && arrays[i]; i++) {
1050 desc->page = arrays[i];
Trond Myklebust13884ff2021-03-16 07:57:40 -04001051 nfs_do_filldir(desc, verf);
Trond Myklebust35df59d2020-11-06 20:38:47 -05001052 }
1053 desc->page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
Trond Myklebust35df59d2020-11-06 20:38:47 -05001055
1056 for (i = 0; i < sz && arrays[i]; i++)
1057 nfs_readdir_page_array_free(arrays[i]);
1058out:
1059 kfree(arrays);
1060 dfprintk(DIRCACHE, "NFS: %s: returns %d\n", __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062}
1063
Olivier Galibert00a92642005-06-22 17:16:29 +00001064/* The file offset position represents the dirent entry number. A
1065 last cookie cache takes care of the common case of reading the
1066 whole directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 */
Al Viro23db8622013-05-17 16:34:50 -04001068static int nfs_readdir(struct file *file, struct dir_context *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069{
Miklos Szeredibe62a1a2016-03-26 16:14:39 -04001070 struct dentry *dentry = file_dentry(file);
David Howells2b0143b2015-03-17 22:25:59 +00001071 struct inode *inode = d_inode(dentry);
Trond Myklebust13884ff2021-03-16 07:57:40 -04001072 struct nfs_inode *nfsi = NFS_I(inode);
Al Viro23db8622013-05-17 16:34:50 -04001073 struct nfs_open_dir_context *dir_ctx = file->private_data;
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001074 struct nfs_readdir_descriptor *desc;
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001075 pgoff_t page_index;
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001076 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Al Viro6de14722013-09-16 10:53:17 -04001078 dfprintk(FILE, "NFS: readdir(%pD2) starting at cookie %llu\n",
1079 file, (long long)ctx->pos);
Chuck Lever91d5b472006-03-20 13:44:14 -05001080 nfs_inc_stats(inode, NFSIOS_VFSGETDENTS);
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 /*
Al Viro23db8622013-05-17 16:34:50 -04001083 * ctx->pos points to the dirent entry number.
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001084 * *desc->dir_cookie has the cookie for the next entry. We have
Olivier Galibert00a92642005-06-22 17:16:29 +00001085 * to either find the entry with the appropriate number or
1086 * revalidate the cookie.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 */
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001088 if (ctx->pos == 0 || nfs_attribute_cache_expired(inode)) {
Scott Mayhew07b5ce82013-07-05 17:49:31 -04001089 res = nfs_revalidate_mapping(inode, file->f_mapping);
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001090 if (res < 0)
1091 goto out;
1092 }
1093
1094 res = -ENOMEM;
1095 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
1096 if (!desc)
Trond Myklebustfccca7f2008-01-26 17:37:47 -05001097 goto out;
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001098 desc->file = file;
1099 desc->ctx = ctx;
1100 desc->plus = nfs_use_readdirplus(inode, ctx);
Trond Myklebustfccca7f2008-01-26 17:37:47 -05001101
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001102 spin_lock(&file->f_lock);
1103 desc->dir_cookie = dir_ctx->dir_cookie;
1104 desc->dup_cookie = dir_ctx->dup_cookie;
1105 desc->duped = dir_ctx->duped;
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001106 page_index = dir_ctx->page_index;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001107 desc->attr_gencount = dir_ctx->attr_gencount;
Trond Myklebustb593c092020-11-02 20:06:12 -05001108 memcpy(desc->verf, dir_ctx->verf, sizeof(desc->verf));
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001109 spin_unlock(&file->f_lock);
Trond Myklebust565277f2007-10-15 18:17:53 -04001110
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001111 if (test_and_clear_bit(NFS_INO_FORCE_READDIR, &nfsi->flags) &&
1112 list_is_singular(&nfsi->open_files))
1113 invalidate_mapping_pages(inode->i_mapping, page_index + 1, -1);
1114
Trond Myklebust47c716c2010-12-07 12:44:56 -05001115 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 res = readdir_search_pagecache(desc);
Olivier Galibert00a92642005-06-22 17:16:29 +00001117
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 if (res == -EBADCOOKIE) {
Trond Myklebustece0b422010-11-20 13:55:33 -05001119 res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 /* This means either end of directory */
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001121 if (desc->dir_cookie && !desc->eof) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 /* Or that the server has 'lost' a cookie */
Al Viro23db8622013-05-17 16:34:50 -04001123 res = uncached_readdir(desc);
Trond Myklebustece0b422010-11-20 13:55:33 -05001124 if (res == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 continue;
Trond Myklebust9fff59e2020-11-02 20:11:32 -05001126 if (res == -EBADCOOKIE || res == -ENOTSYNC)
1127 res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 break;
1130 }
1131 if (res == -ETOOSMALL && desc->plus) {
Trond Myklebust13884ff2021-03-16 07:57:40 -04001132 clear_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 nfs_zap_caches(inode);
Trond Myklebustbaf57a02010-09-24 18:49:43 -04001134 desc->page_index = 0;
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -04001135 desc->plus = false;
1136 desc->eof = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 continue;
1138 }
1139 if (res < 0)
1140 break;
1141
Trond Myklebust13884ff2021-03-16 07:57:40 -04001142 nfs_do_filldir(desc, nfsi->cookieverf);
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -05001143 nfs_readdir_page_unlock_and_put_cached(desc);
Trond Myklebust47c716c2010-12-07 12:44:56 -05001144 } while (!desc->eof);
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001145
1146 spin_lock(&file->f_lock);
1147 dir_ctx->dir_cookie = desc->dir_cookie;
1148 dir_ctx->dup_cookie = desc->dup_cookie;
1149 dir_ctx->duped = desc->duped;
1150 dir_ctx->attr_gencount = desc->attr_gencount;
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001151 dir_ctx->page_index = desc->page_index;
Trond Myklebustb593c092020-11-02 20:06:12 -05001152 memcpy(dir_ctx->verf, desc->verf, sizeof(dir_ctx->verf));
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001153 spin_unlock(&file->f_lock);
1154
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001155 kfree(desc);
1156
Trond Myklebustfccca7f2008-01-26 17:37:47 -05001157out:
Al Viro6de14722013-09-16 10:53:17 -04001158 dfprintk(FILE, "NFS: readdir(%pD2) returns %d\n", file, res);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001159 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160}
1161
Andrew Morton965c8e52012-12-17 15:59:39 -08001162static loff_t nfs_llseek_dir(struct file *filp, loff_t offset, int whence)
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001163{
Bryan Schumaker480c2002011-03-23 14:48:29 -04001164 struct nfs_open_dir_context *dir_ctx = filp->private_data;
Chuck Leverb84e06c2008-06-11 17:55:34 -04001165
Al Viro6de14722013-09-16 10:53:17 -04001166 dfprintk(FILE, "NFS: llseek dir(%pD2, %lld, %d)\n",
1167 filp, offset, whence);
Chuck Leverb84e06c2008-06-11 17:55:34 -04001168
Andrew Morton965c8e52012-12-17 15:59:39 -08001169 switch (whence) {
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001170 default:
1171 return -EINVAL;
1172 case SEEK_SET:
1173 if (offset < 0)
1174 return -EINVAL;
Trond Myklebust83f2c452020-10-30 17:57:29 -04001175 spin_lock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001176 break;
1177 case SEEK_CUR:
1178 if (offset == 0)
1179 return filp->f_pos;
Trond Myklebust83f2c452020-10-30 17:57:29 -04001180 spin_lock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001181 offset += filp->f_pos;
1182 if (offset < 0) {
Trond Myklebust83f2c452020-10-30 17:57:29 -04001183 spin_unlock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001184 return -EINVAL;
1185 }
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001186 }
1187 if (offset != filp->f_pos) {
1188 filp->f_pos = offset;
Trond Myklebust59e356a2020-02-03 14:49:33 -05001189 if (nfs_readdir_use_cookie(filp))
1190 dir_ctx->dir_cookie = offset;
1191 else
1192 dir_ctx->dir_cookie = 0;
Trond Myklebustb593c092020-11-02 20:06:12 -05001193 if (offset == 0)
1194 memset(dir_ctx->verf, 0, sizeof(dir_ctx->verf));
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -04001195 dir_ctx->duped = 0;
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001196 }
Trond Myklebust83f2c452020-10-30 17:57:29 -04001197 spin_unlock(&filp->f_lock);
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001198 return offset;
1199}
1200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201/*
1202 * All directory operations under NFS are synchronous, so fsync()
1203 * is a dummy operation.
1204 */
Josef Bacik02c24a82011-07-16 20:44:56 -04001205static int nfs_fsync_dir(struct file *filp, loff_t start, loff_t end,
1206 int datasync)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207{
Al Viro6de14722013-09-16 10:53:17 -04001208 dfprintk(FILE, "NFS: fsync dir(%pD2) datasync %d\n", filp, datasync);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001209
Trond Myklebust11decaf2020-10-30 17:57:30 -04001210 nfs_inc_stats(file_inode(filp), NFSIOS_VFSFSYNC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 return 0;
1212}
1213
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001214/**
1215 * nfs_force_lookup_revalidate - Mark the directory as having changed
Trond Myklebust302fad72019-02-18 13:32:38 -05001216 * @dir: pointer to directory inode
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001217 *
1218 * This forces the revalidation code in nfs_lookup_revalidate() to do a
1219 * full lookup on all child dentries of 'dir' whenever a change occurs
1220 * on the server that might have invalidated our dcache.
1221 *
Trond Myklebustefeda802020-02-05 09:01:54 -05001222 * Note that we reserve bit '0' as a tag to let us know when a dentry
1223 * was revalidated while holding a delegation on its inode.
1224 *
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001225 * The caller should be holding dir->i_lock
1226 */
1227void nfs_force_lookup_revalidate(struct inode *dir)
1228{
Trond Myklebustefeda802020-02-05 09:01:54 -05001229 NFS_I(dir)->cache_change_attribute += 2;
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001230}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001231EXPORT_SYMBOL_GPL(nfs_force_lookup_revalidate);
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001232
Trond Myklebustefeda802020-02-05 09:01:54 -05001233/**
1234 * nfs_verify_change_attribute - Detects NFS remote directory changes
1235 * @dir: pointer to parent directory inode
1236 * @verf: previously saved change attribute
1237 *
1238 * Return "false" if the verifiers doesn't match the change attribute.
1239 * This would usually indicate that the directory contents have changed on
1240 * the server, and that any dentries need revalidating.
1241 */
1242static bool nfs_verify_change_attribute(struct inode *dir, unsigned long verf)
1243{
1244 return (verf & ~1UL) == nfs_save_change_attribute(dir);
1245}
1246
1247static void nfs_set_verifier_delegated(unsigned long *verf)
1248{
1249 *verf |= 1UL;
1250}
1251
1252#if IS_ENABLED(CONFIG_NFS_V4)
1253static void nfs_unset_verifier_delegated(unsigned long *verf)
1254{
1255 *verf &= ~1UL;
1256}
1257#endif /* IS_ENABLED(CONFIG_NFS_V4) */
1258
1259static bool nfs_test_verifier_delegated(unsigned long verf)
1260{
1261 return verf & 1;
1262}
1263
1264static bool nfs_verifier_is_delegated(struct dentry *dentry)
1265{
1266 return nfs_test_verifier_delegated(dentry->d_time);
1267}
1268
1269static void nfs_set_verifier_locked(struct dentry *dentry, unsigned long verf)
1270{
1271 struct inode *inode = d_inode(dentry);
Trond Myklebustcec08f42021-09-29 08:12:53 -04001272 struct inode *dir = d_inode(dentry->d_parent);
Trond Myklebustefeda802020-02-05 09:01:54 -05001273
Trond Myklebustcec08f42021-09-29 08:12:53 -04001274 if (!nfs_verify_change_attribute(dir, verf))
1275 return;
Trond Myklebustefeda802020-02-05 09:01:54 -05001276 if (inode && NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
1277 nfs_set_verifier_delegated(&verf);
Trond Myklebustefeda802020-02-05 09:01:54 -05001278 dentry->d_time = verf;
1279}
1280
1281/**
1282 * nfs_set_verifier - save a parent directory verifier in the dentry
1283 * @dentry: pointer to dentry
1284 * @verf: verifier to save
1285 *
1286 * Saves the parent directory verifier in @dentry. If the inode has
1287 * a delegation, we also tag the dentry as having been revalidated
1288 * while holding a delegation so that we know we don't have to
1289 * look it up again after a directory change.
1290 */
1291void nfs_set_verifier(struct dentry *dentry, unsigned long verf)
1292{
1293
1294 spin_lock(&dentry->d_lock);
1295 nfs_set_verifier_locked(dentry, verf);
1296 spin_unlock(&dentry->d_lock);
1297}
1298EXPORT_SYMBOL_GPL(nfs_set_verifier);
1299
1300#if IS_ENABLED(CONFIG_NFS_V4)
1301/**
1302 * nfs_clear_verifier_delegated - clear the dir verifier delegation tag
1303 * @inode: pointer to inode
1304 *
1305 * Iterates through the dentries in the inode alias list and clears
1306 * the tag used to indicate that the dentry has been revalidated
1307 * while holding a delegation.
1308 * This function is intended for use when the delegation is being
1309 * returned or revoked.
1310 */
1311void nfs_clear_verifier_delegated(struct inode *inode)
1312{
1313 struct dentry *alias;
1314
1315 if (!inode)
1316 return;
1317 spin_lock(&inode->i_lock);
1318 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
1319 spin_lock(&alias->d_lock);
1320 nfs_unset_verifier_delegated(&alias->d_time);
1321 spin_unlock(&alias->d_lock);
1322 }
1323 spin_unlock(&inode->i_lock);
1324}
1325EXPORT_SYMBOL_GPL(nfs_clear_verifier_delegated);
1326#endif /* IS_ENABLED(CONFIG_NFS_V4) */
1327
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328/*
1329 * A check for whether or not the parent directory has changed.
1330 * In the case it has, we assume that the dentries are untrustworthy
1331 * and may need to be looked up again.
NeilBrown912a1082014-07-14 11:28:20 +10001332 * If rcu_walk prevents us from performing a full check, return 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 */
NeilBrown912a1082014-07-14 11:28:20 +10001334static int nfs_check_verifier(struct inode *dir, struct dentry *dentry,
1335 int rcu_walk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336{
1337 if (IS_ROOT(dentry))
1338 return 1;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001339 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONE)
1340 return 0;
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001341 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1342 return 0;
1343 /* Revalidate nfsi->cache_change_attribute before we declare a match */
Trond Myklebust1cd9cb02016-12-04 18:34:34 -05001344 if (nfs_mapping_need_revalidate_inode(dir)) {
1345 if (rcu_walk)
1346 return 0;
1347 if (__nfs_revalidate_inode(NFS_SERVER(dir), dir) < 0)
1348 return 0;
1349 }
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001350 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1351 return 0;
1352 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353}
1354
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355/*
Trond Myklebusta12802c2007-10-02 19:13:04 -04001356 * Use intent information to check whether or not we're going to do
1357 * an O_EXCL create using this path component.
1358 */
Al Virofa3c56b2012-06-10 15:36:40 -04001359static int nfs_is_exclusive_create(struct inode *dir, unsigned int flags)
Trond Myklebusta12802c2007-10-02 19:13:04 -04001360{
1361 if (NFS_PROTO(dir)->version == 2)
1362 return 0;
Al Virofa3c56b2012-06-10 15:36:40 -04001363 return flags & LOOKUP_EXCL;
Trond Myklebusta12802c2007-10-02 19:13:04 -04001364}
1365
1366/*
Trond Myklebust1d6757f2005-06-07 18:37:01 -04001367 * Inode and filehandle revalidation for lookups.
1368 *
1369 * We force revalidation in the cases where the VFS sets LOOKUP_REVAL,
1370 * or if the intent information indicates that we're about to open this
1371 * particular file and the "nocto" mount flag is not set.
1372 *
1373 */
Trond Myklebust65a0c142012-12-14 17:51:40 -05001374static
Al Virofa3c56b2012-06-10 15:36:40 -04001375int nfs_lookup_verify_inode(struct inode *inode, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376{
1377 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust65a0c142012-12-14 17:51:40 -05001378 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
David Howells36d43a42011-01-14 18:45:42 +00001380 if (IS_AUTOMOUNT(inode))
Trond Myklebust4e99a1f2008-03-06 12:34:59 -05001381 return 0;
Trond Myklebust47921922018-05-10 10:08:36 -04001382
1383 if (flags & LOOKUP_OPEN) {
1384 switch (inode->i_mode & S_IFMT) {
1385 case S_IFREG:
1386 /* A NFSv4 OPEN will revalidate later */
1387 if (server->caps & NFS_CAP_ATOMIC_OPEN)
1388 goto out;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001389 fallthrough;
Trond Myklebust47921922018-05-10 10:08:36 -04001390 case S_IFDIR:
1391 if (server->flags & NFS_MOUNT_NOCTO)
1392 break;
1393 /* NFS close-to-open cache consistency validation */
1394 goto out_force;
1395 }
1396 }
1397
Al Virofacc3532012-06-10 15:33:51 -04001398 /* VFS wants an on-the-wire revalidation */
Al Virofa3c56b2012-06-10 15:36:40 -04001399 if (flags & LOOKUP_REVAL)
Al Virofacc3532012-06-10 15:33:51 -04001400 goto out_force;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001401out:
Lance Sheltona61246c2018-07-16 13:05:36 -04001402 return (inode->i_nlink == 0) ? -ESTALE : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403out_force:
NeilBrown1fa1e382014-07-14 11:28:20 +10001404 if (flags & LOOKUP_RCU)
1405 return -ECHILD;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001406 ret = __nfs_revalidate_inode(server, inode);
1407 if (ret != 0)
1408 return ret;
1409 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410}
1411
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001412static void nfs_mark_dir_for_revalidate(struct inode *inode)
1413{
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001414 spin_lock(&inode->i_lock);
Trond Myklebusta6a361c2021-09-28 11:24:57 -04001415 nfs_set_cache_invalid(inode, NFS_INO_INVALID_CHANGE);
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001416 spin_unlock(&inode->i_lock);
1417}
1418
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419/*
1420 * We judge how long we want to trust negative
1421 * dentries by looking at the parent inode mtime.
1422 *
1423 * If parent mtime has changed, we revalidate, else we wait for a
1424 * period corresponding to the parent's attribute cache timeout value.
NeilBrown912a1082014-07-14 11:28:20 +10001425 *
1426 * If LOOKUP_RCU prevents us from performing a full check, return 1
1427 * suggesting a reval is needed.
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001428 *
1429 * Note that when creating a new file, or looking up a rename target,
1430 * then it shouldn't be necessary to revalidate a negative dentry.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 */
1432static inline
1433int nfs_neg_need_reval(struct inode *dir, struct dentry *dentry,
Al Virofa3c56b2012-06-10 15:36:40 -04001434 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435{
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001436 if (flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 return 0;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001438 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONEG)
1439 return 1;
NeilBrown912a1082014-07-14 11:28:20 +10001440 return !nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441}
1442
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001443static int
1444nfs_lookup_revalidate_done(struct inode *dir, struct dentry *dentry,
1445 struct inode *inode, int error)
1446{
1447 switch (error) {
1448 case 1:
1449 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is valid\n",
1450 __func__, dentry);
1451 return 1;
1452 case 0:
Trond Myklebust47397912021-03-08 14:42:52 -05001453 /*
1454 * We can't d_drop the root of a disconnected tree:
1455 * its d_hash is on the s_anon list and d_drop() would hide
1456 * it from shrink_dcache_for_unmount(), leading to busy
1457 * inodes on unmount and further oopses.
1458 */
1459 if (inode && IS_ROOT(dentry))
1460 return 1;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001461 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is invalid\n",
1462 __func__, dentry);
1463 return 0;
1464 }
1465 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) lookup returned error %d\n",
1466 __func__, dentry, error);
1467 return error;
1468}
1469
1470static int
1471nfs_lookup_revalidate_negative(struct inode *dir, struct dentry *dentry,
1472 unsigned int flags)
1473{
1474 int ret = 1;
1475 if (nfs_neg_need_reval(dir, dentry, flags)) {
1476 if (flags & LOOKUP_RCU)
1477 return -ECHILD;
1478 ret = 0;
1479 }
1480 return nfs_lookup_revalidate_done(dir, dentry, NULL, ret);
1481}
1482
1483static int
1484nfs_lookup_revalidate_delegated(struct inode *dir, struct dentry *dentry,
1485 struct inode *inode)
1486{
1487 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1488 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1489}
1490
1491static int
1492nfs_lookup_revalidate_dentry(struct inode *dir, struct dentry *dentry,
1493 struct inode *inode)
1494{
1495 struct nfs_fh *fhandle;
1496 struct nfs_fattr *fattr;
Trond Myklebusta1147b82020-02-05 09:01:52 -05001497 unsigned long dir_verifier;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001498 int ret;
1499
1500 ret = -ENOMEM;
1501 fhandle = nfs_alloc_fhandle();
Anna Schumaker9558a002021-10-22 13:11:04 -04001502 fattr = nfs_alloc_fattr_with_label(NFS_SERVER(inode));
1503 if (fhandle == NULL || fattr == NULL)
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001504 goto out;
1505
Trond Myklebusta1147b82020-02-05 09:01:52 -05001506 dir_verifier = nfs_save_change_attribute(dir);
Anna Schumaker9558a002021-10-22 13:11:04 -04001507 ret = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001508 if (ret < 0) {
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001509 switch (ret) {
1510 case -ESTALE:
1511 case -ENOENT:
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001512 ret = 0;
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001513 break;
1514 case -ETIMEDOUT:
1515 if (NFS_SERVER(inode)->flags & NFS_MOUNT_SOFTREVAL)
1516 ret = 1;
1517 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001518 goto out;
1519 }
1520 ret = 0;
1521 if (nfs_compare_fh(NFS_FH(inode), fhandle))
1522 goto out;
1523 if (nfs_refresh_inode(inode, fattr) < 0)
1524 goto out;
1525
Anna Schumaker9558a002021-10-22 13:11:04 -04001526 nfs_setsecurity(inode, fattr, fattr->label);
Trond Myklebusta1147b82020-02-05 09:01:52 -05001527 nfs_set_verifier(dentry, dir_verifier);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001528
1529 /* set a readdirplus hint that we had a cache miss */
1530 nfs_force_use_readdirplus(dir);
1531 ret = 1;
1532out:
1533 nfs_free_fattr(fattr);
1534 nfs_free_fhandle(fhandle);
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001535
1536 /*
1537 * If the lookup failed despite the dentry change attribute being
1538 * a match, then we should revalidate the directory cache.
1539 */
1540 if (!ret && nfs_verify_change_attribute(dir, dentry->d_time))
1541 nfs_mark_dir_for_revalidate(dir);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001542 return nfs_lookup_revalidate_done(dir, dentry, inode, ret);
1543}
1544
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545/*
1546 * This is called every time the dcache has a lookup hit,
1547 * and we should check whether we can really trust that
1548 * lookup.
1549 *
1550 * NOTE! The hit can be a negative hit too, don't assume
1551 * we have an inode!
1552 *
1553 * If the parent directory is seen to have changed, we throw out the
1554 * cached dentry and do a new lookup.
1555 */
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001556static int
1557nfs_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1558 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Chuck Lever91d5b472006-03-20 13:44:14 -05001563 nfs_inc_stats(dir, NFSIOS_DENTRYREVALIDATE);
David Howells2b0143b2015-03-17 22:25:59 +00001564 inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001566 if (!inode)
1567 return nfs_lookup_revalidate_negative(dir, dentry, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
1569 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001570 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1571 __func__, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 goto out_bad;
1573 }
1574
Trond Myklebustefeda802020-02-05 09:01:54 -05001575 if (nfs_verifier_is_delegated(dentry))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001576 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust15860ab2008-12-23 15:21:54 -05001577
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 /* Force a full look up iff the parent directory has changed */
Trond Myklebust73dd6842018-05-10 10:13:09 -04001579 if (!(flags & (LOOKUP_EXCL | LOOKUP_REVAL)) &&
NeilBrown912a1082014-07-14 11:28:20 +10001580 nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU)) {
NeilBrowncc896842017-07-05 12:22:20 +10001581 error = nfs_lookup_verify_inode(inode, flags);
1582 if (error) {
NeilBrowncc896842017-07-05 12:22:20 +10001583 if (error == -ESTALE)
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001584 nfs_mark_dir_for_revalidate(dir);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001585 goto out_bad;
NeilBrown1fa1e382014-07-14 11:28:20 +10001586 }
Trond Myklebust63519fb2016-11-19 11:21:54 -05001587 nfs_advise_use_readdirplus(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 goto out_valid;
1589 }
1590
NeilBrown912a1082014-07-14 11:28:20 +10001591 if (flags & LOOKUP_RCU)
1592 return -ECHILD;
1593
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 if (NFS_STALE(inode))
1595 goto out_bad;
1596
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001597 trace_nfs_lookup_revalidate_enter(dir, dentry, flags);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001598 error = nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001599 trace_nfs_lookup_revalidate_exit(dir, dentry, flags, error);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001600 return error;
1601out_valid:
1602 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1603out_bad:
1604 if (flags & LOOKUP_RCU)
1605 return -ECHILD;
1606 return nfs_lookup_revalidate_done(dir, dentry, inode, 0);
1607}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001609static int
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001610__nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags,
1611 int (*reval)(struct inode *, struct dentry *, unsigned int))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001612{
1613 struct dentry *parent;
1614 struct inode *dir;
1615 int ret;
David Quigleyaa9c2662013-05-22 12:50:44 -04001616
NeilBrownd51ac1a2014-07-14 11:28:20 +10001617 if (flags & LOOKUP_RCU) {
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001618 parent = READ_ONCE(dentry->d_parent);
1619 dir = d_inode_rcu(parent);
1620 if (!dir)
1621 return -ECHILD;
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001622 ret = reval(dir, dentry, flags);
Mark Rutland6aa7de02017-10-23 14:07:29 -07001623 if (parent != READ_ONCE(dentry->d_parent))
NeilBrownd51ac1a2014-07-14 11:28:20 +10001624 return -ECHILD;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001625 } else {
1626 parent = dget_parent(dentry);
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001627 ret = reval(d_inode(parent), dentry, flags);
NeilBrownd51ac1a2014-07-14 11:28:20 +10001628 dput(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001630 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631}
1632
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001633static int nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1634{
1635 return __nfs_lookup_revalidate(dentry, flags, nfs_do_lookup_revalidate);
1636}
1637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638/*
David Howells2b0143b2015-03-17 22:25:59 +00001639 * A weaker form of d_revalidate for revalidating just the d_inode(dentry)
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001640 * when we don't really care about the dentry name. This is called when a
1641 * pathwalk ends on a dentry that was not found via a normal lookup in the
1642 * parent dir (e.g.: ".", "..", procfs symlinks or mountpoint traversals).
1643 *
1644 * In this situation, we just want to verify that the inode itself is OK
1645 * since the dentry might have changed on the server.
1646 */
1647static int nfs_weak_revalidate(struct dentry *dentry, unsigned int flags)
1648{
David Howells2b0143b2015-03-17 22:25:59 +00001649 struct inode *inode = d_inode(dentry);
Trond Myklebust9cdd1d32016-12-16 18:04:47 -05001650 int error = 0;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001651
1652 /*
1653 * I believe we can only get a negative dentry here in the case of a
1654 * procfs-style symlink. Just assume it's correct for now, but we may
1655 * eventually need to do something more here.
1656 */
1657 if (!inode) {
Al Viro6de14722013-09-16 10:53:17 -04001658 dfprintk(LOOKUPCACHE, "%s: %pd2 has negative inode\n",
1659 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001660 return 1;
1661 }
1662
1663 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001664 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1665 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001666 return 0;
1667 }
1668
NeilBrownb6887412017-08-25 17:34:41 +10001669 error = nfs_lookup_verify_inode(inode, flags);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001670 dfprintk(LOOKUPCACHE, "NFS: %s: inode %lu is %s\n",
1671 __func__, inode->i_ino, error ? "invalid" : "valid");
1672 return !error;
1673}
1674
1675/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 * This is called from dput() when d_count is going to 0.
1677 */
Nick Pigginfe15ce42011-01-07 17:49:23 +11001678static int nfs_dentry_delete(const struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679{
Al Viro6de14722013-09-16 10:53:17 -04001680 dfprintk(VFS, "NFS: dentry_delete(%pd2, %x)\n",
1681 dentry, dentry->d_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682
Trond Myklebust77f11192008-01-28 19:43:19 -05001683 /* Unhash any dentry with a stale inode */
David Howells2b0143b2015-03-17 22:25:59 +00001684 if (d_really_is_positive(dentry) && NFS_STALE(d_inode(dentry)))
Trond Myklebust77f11192008-01-28 19:43:19 -05001685 return 1;
1686
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1688 /* Unhash it, so that ->d_iput() would be called */
1689 return 1;
1690 }
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001691 if (!(dentry->d_sb->s_flags & SB_ACTIVE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 /* Unhash it, so that ancestors of killed async unlink
1693 * files will be cleaned up during umount */
1694 return 1;
1695 }
1696 return 0;
1697
1698}
1699
Trond Myklebust1f018452012-12-14 16:38:46 -05001700/* Ensure that we revalidate inode->i_nlink */
Trond Myklebust1b83d702008-06-11 15:44:04 -04001701static void nfs_drop_nlink(struct inode *inode)
1702{
1703 spin_lock(&inode->i_lock);
Trond Myklebust1f018452012-12-14 16:38:46 -05001704 /* drop the inode if we're reasonably sure this is the last link */
Trond Myklebust59a707b2018-04-08 18:11:18 -04001705 if (inode->i_nlink > 0)
1706 drop_nlink(inode);
1707 NFS_I(inode)->attr_gencount = nfs_inc_attr_generation_counter();
Trond Myklebustac46b3d2021-03-08 14:42:54 -05001708 nfs_set_cache_invalid(
1709 inode, NFS_INO_INVALID_CHANGE | NFS_INO_INVALID_CTIME |
Trond Myklebust1301e422021-04-01 14:57:56 -04001710 NFS_INO_INVALID_NLINK);
Trond Myklebust1b83d702008-06-11 15:44:04 -04001711 spin_unlock(&inode->i_lock);
1712}
1713
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714/*
1715 * Called when the dentry loses inode.
1716 * We use it to clean up silly-renamed files.
1717 */
1718static void nfs_dentry_iput(struct dentry *dentry, struct inode *inode)
1719{
1720 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
Trond Myklebuste4eff1a2007-07-14 15:39:58 -04001721 nfs_complete_unlink(dentry, inode);
Trond Myklebust1f018452012-12-14 16:38:46 -05001722 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 iput(inode);
1725}
1726
Al Virob1942c52011-03-16 05:44:14 -04001727static void nfs_d_release(struct dentry *dentry)
1728{
1729 /* free cached devname value, if it survived that far */
1730 if (unlikely(dentry->d_fsdata)) {
1731 if (dentry->d_flags & DCACHE_NFSFS_RENAMED)
1732 WARN_ON(1);
1733 else
1734 kfree(dentry->d_fsdata);
1735 }
1736}
1737
Al Virof786aa92009-02-20 05:51:22 +00001738const struct dentry_operations nfs_dentry_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 .d_revalidate = nfs_lookup_revalidate,
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001740 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 .d_delete = nfs_dentry_delete,
1742 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001743 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001744 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745};
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001746EXPORT_SYMBOL_GPL(nfs_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747
Bryan Schumaker597d9282012-07-16 16:39:10 -04001748struct dentry *nfs_lookup(struct inode *dir, struct dentry * dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749{
1750 struct dentry *res;
1751 struct inode *inode = NULL;
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001752 struct nfs_fh *fhandle = NULL;
1753 struct nfs_fattr *fattr = NULL;
Trond Myklebusta1147b82020-02-05 09:01:52 -05001754 unsigned long dir_verifier;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
Al Viro6de14722013-09-16 10:53:17 -04001757 dfprintk(VFS, "NFS: lookup(%pd2)\n", dentry);
Chuck Lever91d5b472006-03-20 13:44:14 -05001758 nfs_inc_stats(dir, NFSIOS_VFSLOOKUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
Al Viro130f9ab2016-03-07 22:40:43 -05001760 if (unlikely(dentry->d_name.len > NFS_SERVER(dir)->namelen))
1761 return ERR_PTR(-ENAMETOOLONG);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
Trond Myklebustfd684072006-09-05 12:27:44 -04001763 /*
1764 * If we're doing an exclusive create, optimize away the lookup
1765 * but don't hash the dentry.
1766 */
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001767 if (nfs_is_exclusive_create(dir, flags) || flags & LOOKUP_RENAME_TARGET)
Al Viro130f9ab2016-03-07 22:40:43 -05001768 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001770 res = ERR_PTR(-ENOMEM);
1771 fhandle = nfs_alloc_fhandle();
Anna Schumaker9558a002021-10-22 13:11:04 -04001772 fattr = nfs_alloc_fattr_with_label(NFS_SERVER(dir));
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001773 if (fhandle == NULL || fattr == NULL)
1774 goto out;
1775
Trond Myklebusta1147b82020-02-05 09:01:52 -05001776 dir_verifier = nfs_save_change_attribute(dir);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001777 trace_nfs_lookup_enter(dir, dentry, flags);
Anna Schumaker9558a002021-10-22 13:11:04 -04001778 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 if (error == -ENOENT)
1780 goto no_entry;
1781 if (error < 0) {
1782 res = ERR_PTR(error);
Anna Schumaker9558a002021-10-22 13:11:04 -04001783 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
Anna Schumaker9558a002021-10-22 13:11:04 -04001785 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, fattr->label);
Namhyung Kimbf0c84f2010-12-28 17:02:46 +00001786 res = ERR_CAST(inode);
Trond Myklebust03f28e32006-03-20 13:44:48 -05001787 if (IS_ERR(res))
Anna Schumaker9558a002021-10-22 13:11:04 -04001788 goto out;
David Howells54ceac42006-08-22 20:06:13 -04001789
Trond Myklebust63519fb2016-11-19 11:21:54 -05001790 /* Notify readdir to use READDIRPLUS */
1791 nfs_force_use_readdirplus(dir);
Trond Myklebustd69ee9b2012-05-01 17:37:59 -04001792
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793no_entry:
Al Viro41d28bc2014-10-12 22:24:21 -04001794 res = d_splice_alias(inode, dentry);
Trond Myklebust9eaef272006-10-21 10:24:20 -07001795 if (res != NULL) {
1796 if (IS_ERR(res))
Anna Schumaker9558a002021-10-22 13:11:04 -04001797 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 dentry = res;
Trond Myklebust9eaef272006-10-21 10:24:20 -07001799 }
Trond Myklebusta1147b82020-02-05 09:01:52 -05001800 nfs_set_verifier(dentry, dir_verifier);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801out:
Anna Schumaker9558a002021-10-22 13:11:04 -04001802 trace_nfs_lookup_exit(dir, dentry, flags, PTR_ERR_OR_ZERO(res));
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001803 nfs_free_fattr(fattr);
1804 nfs_free_fhandle(fhandle);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 return res;
1806}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001807EXPORT_SYMBOL_GPL(nfs_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001809#if IS_ENABLED(CONFIG_NFS_V4)
Al Viro0b728e12012-06-10 16:03:43 -04001810static int nfs4_lookup_revalidate(struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Al Virof786aa92009-02-20 05:51:22 +00001812const struct dentry_operations nfs4_dentry_operations = {
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02001813 .d_revalidate = nfs4_lookup_revalidate,
NeilBrownb6887412017-08-25 17:34:41 +10001814 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 .d_delete = nfs_dentry_delete,
1816 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001817 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001818 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819};
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001820EXPORT_SYMBOL_GPL(nfs4_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
Al Viro8a5e9292011-06-25 19:15:54 -04001822static fmode_t flags_to_mode(int flags)
1823{
1824 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
1825 if ((flags & O_ACCMODE) != O_WRONLY)
1826 res |= FMODE_READ;
1827 if ((flags & O_ACCMODE) != O_RDONLY)
1828 res |= FMODE_WRITE;
1829 return res;
1830}
1831
NeilBrown532d4de2016-10-13 15:26:47 +11001832static struct nfs_open_context *create_nfs_open_context(struct dentry *dentry, int open_flags, struct file *filp)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001833{
NeilBrown532d4de2016-10-13 15:26:47 +11001834 return alloc_nfs_open_context(dentry, flags_to_mode(open_flags), filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001835}
1836
1837static int do_open(struct inode *inode, struct file *filp)
1838{
David Howellsf1fe29b2013-09-27 11:20:03 +01001839 nfs_fscache_open_file(inode, filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001840 return 0;
1841}
1842
Al Virod9585272012-06-22 12:39:14 +04001843static int nfs_finish_open(struct nfs_open_context *ctx,
1844 struct dentry *dentry,
Al Virob452a452018-06-08 13:06:28 -04001845 struct file *file, unsigned open_flags)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001846{
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001847 int err;
1848
Al Virobe12af32018-06-08 11:44:56 -04001849 err = finish_open(file, dentry, do_open);
Al Viro30d90492012-06-22 12:40:19 +04001850 if (err)
Al Virod9585272012-06-22 12:39:14 +04001851 goto out;
NeilBrowneaa2b822017-07-03 15:27:26 +10001852 if (S_ISREG(file->f_path.dentry->d_inode->i_mode))
1853 nfs_file_set_open_context(file, ctx);
1854 else
Trond Myklebust98214212019-08-09 12:15:07 -04001855 err = -EOPENSTALE;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001856out:
Al Virod9585272012-06-22 12:39:14 +04001857 return err;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001858}
1859
Bryan Schumaker73a79702012-07-16 16:39:12 -04001860int nfs_atomic_open(struct inode *dir, struct dentry *dentry,
1861 struct file *file, unsigned open_flags,
Al Viro44907d72018-06-08 13:32:02 -04001862 umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863{
Al Viroc94c0952016-07-05 09:49:21 -04001864 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001865 struct nfs_open_context *ctx;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001866 struct dentry *res;
1867 struct iattr attr = { .ia_valid = ATTR_OPEN };
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001868 struct inode *inode;
Trond Myklebust1472b832013-08-20 11:59:41 -04001869 unsigned int lookup_flags = 0;
Al Viroc94c0952016-07-05 09:49:21 -04001870 bool switched = false;
Al Viro73a09dd2018-06-08 13:22:02 -04001871 int created = 0;
Trond Myklebust898f6352010-10-23 11:24:25 -04001872 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001874 /* Expect a negative dentry */
David Howells2b0143b2015-03-17 22:25:59 +00001875 BUG_ON(d_inode(dentry));
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001876
Niels de Vos1e8968c2013-12-17 18:20:16 +01001877 dfprintk(VFS, "NFS: atomic_open(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001878 dir->i_sb->s_id, dir->i_ino, dentry);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001879
Jeff Layton9597c132013-08-02 11:39:32 -04001880 err = nfs_check_flags(open_flags);
1881 if (err)
1882 return err;
1883
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001884 /* NFS only supports OPEN on regular files */
1885 if ((open_flags & O_DIRECTORY)) {
Al Viro00699ad2016-07-05 09:44:53 -04001886 if (!d_in_lookup(dentry)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001887 /*
1888 * Hashed negative dentry with O_DIRECTORY: dentry was
1889 * revalidated and is fine, no need to perform lookup
1890 * again
1891 */
Al Virod9585272012-06-22 12:39:14 +04001892 return -ENOENT;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001893 }
Trond Myklebust1472b832013-08-20 11:59:41 -04001894 lookup_flags = LOOKUP_OPEN|LOOKUP_DIRECTORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 goto no_open;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001898 if (dentry->d_name.len > NFS_SERVER(dir)->namelen)
Al Virod9585272012-06-22 12:39:14 +04001899 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001901 if (open_flags & O_CREAT) {
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001902 struct nfs_server *server = NFS_SERVER(dir);
1903
1904 if (!(server->attr_bitmask[2] & FATTR4_WORD2_MODE_UMASK))
1905 mode &= ~current_umask();
1906
Trond Myklebust536e43d2012-01-17 22:04:26 -05001907 attr.ia_valid |= ATTR_MODE;
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001908 attr.ia_mode = mode;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001909 }
Trond Myklebust536e43d2012-01-17 22:04:26 -05001910 if (open_flags & O_TRUNC) {
1911 attr.ia_valid |= ATTR_SIZE;
1912 attr.ia_size = 0;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001913 }
1914
Al Viroc94c0952016-07-05 09:49:21 -04001915 if (!(open_flags & O_CREAT) && !d_in_lookup(dentry)) {
1916 d_drop(dentry);
1917 switched = true;
1918 dentry = d_alloc_parallel(dentry->d_parent,
1919 &dentry->d_name, &wq);
1920 if (IS_ERR(dentry))
1921 return PTR_ERR(dentry);
1922 if (unlikely(!d_in_lookup(dentry)))
1923 return finish_no_open(file, dentry);
1924 }
1925
NeilBrown532d4de2016-10-13 15:26:47 +11001926 ctx = create_nfs_open_context(dentry, open_flags, file);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001927 err = PTR_ERR(ctx);
1928 if (IS_ERR(ctx))
Al Virod9585272012-06-22 12:39:14 +04001929 goto out;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001930
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001931 trace_nfs_atomic_open_enter(dir, ctx, open_flags);
Al Viro73a09dd2018-06-08 13:22:02 -04001932 inode = NFS_PROTO(dir)->open_context(dir, ctx, open_flags, &attr, &created);
1933 if (created)
1934 file->f_mode |= FMODE_CREATED;
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001935 if (IS_ERR(inode)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001936 err = PTR_ERR(inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001937 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001938 put_nfs_open_context(ctx);
Al Virod20cb712016-06-20 13:14:36 -04001939 d_drop(dentry);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001940 switch (err) {
1941 case -ENOENT:
Peng Tao774d9512017-06-29 06:34:50 -07001942 d_splice_alias(NULL, dentry);
Trond Myklebust809fd142014-10-23 19:33:14 +03001943 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001944 break;
1945 case -EISDIR:
1946 case -ENOTDIR:
1947 goto no_open;
1948 case -ELOOP:
1949 if (!(open_flags & O_NOFOLLOW))
Trond Myklebust6f926b52005-10-18 14:20:18 -07001950 goto no_open;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001951 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 /* case -EINVAL: */
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001953 default:
1954 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 }
Al Virod9585272012-06-22 12:39:14 +04001956 goto out;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001957 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001958
Al Virob452a452018-06-08 13:06:28 -04001959 err = nfs_finish_open(ctx, ctx->dentry, file, open_flags);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001960 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001961 put_nfs_open_context(ctx);
Al Virod9585272012-06-22 12:39:14 +04001962out:
Al Viroc94c0952016-07-05 09:49:21 -04001963 if (unlikely(switched)) {
1964 d_lookup_done(dentry);
1965 dput(dentry);
1966 }
Al Virod9585272012-06-22 12:39:14 +04001967 return err;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001968
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969no_open:
Trond Myklebust1472b832013-08-20 11:59:41 -04001970 res = nfs_lookup(dir, dentry, lookup_flags);
Al Viroc94c0952016-07-05 09:49:21 -04001971 if (switched) {
1972 d_lookup_done(dentry);
1973 if (!res)
1974 res = dentry;
1975 else
1976 dput(dentry);
1977 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001978 if (IS_ERR(res))
Al Viroc94c0952016-07-05 09:49:21 -04001979 return PTR_ERR(res);
Al Viroe45198a2012-06-10 06:48:09 -04001980 return finish_no_open(file, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001982EXPORT_SYMBOL_GPL(nfs_atomic_open);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001984static int
1985nfs4_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1986 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987{
Nick Piggin657e94b2011-01-14 02:48:39 +00001988 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
Al Virofa3c56b2012-06-10 15:36:40 -04001990 if (!(flags & LOOKUP_OPEN) || (flags & LOOKUP_DIRECTORY))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001991 goto full_reval;
Miklos Szeredieda72af2012-06-05 15:10:21 +02001992 if (d_mountpoint(dentry))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001993 goto full_reval;
Trond Myklebust2b484292010-09-17 10:56:51 -04001994
David Howells2b0143b2015-03-17 22:25:59 +00001995 inode = d_inode(dentry);
Trond Myklebust2b484292010-09-17 10:56:51 -04001996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 /* We can't create new files in nfs_open_revalidate(), so we
1998 * optimize away revalidation of negative dentries.
1999 */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002000 if (inode == NULL)
2001 goto full_reval;
NeilBrown49317a72014-07-14 11:28:20 +10002002
Trond Myklebustefeda802020-02-05 09:01:54 -05002003 if (nfs_verifier_is_delegated(dentry))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002004 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust216d5d062007-10-01 20:10:12 -04002005
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 /* NFS only supports OPEN on regular files */
2007 if (!S_ISREG(inode->i_mode))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002008 goto full_reval;
2009
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 /* We cannot do exclusive creation on a positive dentry */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002011 if (flags & (LOOKUP_EXCL | LOOKUP_REVAL))
2012 goto reval_dentry;
2013
2014 /* Check if the directory changed */
2015 if (!nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU))
2016 goto reval_dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02002018 /* Let f_op->open() actually open (and revalidate) the file */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002019 return 1;
2020reval_dentry:
2021 if (flags & LOOKUP_RCU)
2022 return -ECHILD;
zhangliguang42f72cf2019-02-12 09:38:33 +08002023 return nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust536e43d2012-01-17 22:04:26 -05002024
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002025full_reval:
2026 return nfs_do_lookup_revalidate(dir, dentry, flags);
2027}
Trond Myklebust535918f2010-09-17 10:56:51 -04002028
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002029static int nfs4_lookup_revalidate(struct dentry *dentry, unsigned int flags)
2030{
2031 return __nfs_lookup_revalidate(dentry, flags,
2032 nfs4_do_lookup_revalidate);
Trond Myklebustc0204fd2010-09-17 10:56:51 -04002033}
2034
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035#endif /* CONFIG_NFSV4 */
2036
Benjamin Coddington406cd912019-09-13 08:29:02 -04002037struct dentry *
2038nfs_add_or_obtain(struct dentry *dentry, struct nfs_fh *fhandle,
David Quigley1775fd32013-05-22 12:50:42 -04002039 struct nfs_fattr *fattr,
2040 struct nfs4_label *label)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041{
Trond Myklebustfab728e2007-09-29 17:41:33 -04002042 struct dentry *parent = dget_parent(dentry);
David Howells2b0143b2015-03-17 22:25:59 +00002043 struct inode *dir = d_inode(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 struct inode *inode;
Al Virob0c6108e2018-05-16 10:55:01 -04002045 struct dentry *d;
Benjamin Coddington406cd912019-09-13 08:29:02 -04002046 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047
Trond Myklebustfab728e2007-09-29 17:41:33 -04002048 d_drop(dentry);
2049
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 if (fhandle->size == 0) {
Anna Schumaker9558a002021-10-22 13:11:04 -04002051 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 if (error)
Trond Myklebustfab728e2007-09-29 17:41:33 -04002053 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 }
Trond Myklebust5724ab32007-10-01 21:51:38 -04002055 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 if (!(fattr->valid & NFS_ATTR_FATTR)) {
2057 struct nfs_server *server = NFS_SB(dentry->d_sb);
Trond Myklebusta841b542018-04-07 13:50:59 -04002058 error = server->nfs_client->rpc_ops->getattr(server, fhandle,
2059 fattr, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 if (error < 0)
Trond Myklebustfab728e2007-09-29 17:41:33 -04002061 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 }
David Quigley1775fd32013-05-22 12:50:42 -04002063 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
Al Virob0c6108e2018-05-16 10:55:01 -04002064 d = d_splice_alias(inode, dentry);
Trond Myklebustfab728e2007-09-29 17:41:33 -04002065out:
2066 dput(parent);
Benjamin Coddington406cd912019-09-13 08:29:02 -04002067 return d;
Trond Myklebustfab728e2007-09-29 17:41:33 -04002068out_error:
Benjamin Coddington406cd912019-09-13 08:29:02 -04002069 d = ERR_PTR(error);
2070 goto out;
2071}
2072EXPORT_SYMBOL_GPL(nfs_add_or_obtain);
2073
2074/*
2075 * Code common to create, mkdir, and mknod.
2076 */
2077int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fhandle,
2078 struct nfs_fattr *fattr,
2079 struct nfs4_label *label)
2080{
2081 struct dentry *d;
2082
2083 d = nfs_add_or_obtain(dentry, fhandle, fattr, label);
2084 if (IS_ERR(d))
2085 return PTR_ERR(d);
2086
2087 /* Callers don't care */
2088 dput(d);
2089 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002091EXPORT_SYMBOL_GPL(nfs_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
2093/*
2094 * Following a failed create operation, we drop the dentry rather
2095 * than retain a negative dentry. This avoids a problem in the event
2096 * that the operation succeeded on the server, but an error in the
2097 * reply path made it appear to have failed.
2098 */
Christian Brauner549c7292021-01-21 14:19:43 +01002099int nfs_create(struct user_namespace *mnt_userns, struct inode *dir,
2100 struct dentry *dentry, umode_t mode, bool excl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101{
2102 struct iattr attr;
Al Viroebfc3b42012-06-10 18:05:36 -04002103 int open_flags = excl ? O_CREAT | O_EXCL : O_CREAT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
Niels de Vos1e8968c2013-12-17 18:20:16 +01002106 dfprintk(VFS, "NFS: create(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002107 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
2109 attr.ia_mode = mode;
2110 attr.ia_valid = ATTR_MODE;
2111
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04002112 trace_nfs_create_enter(dir, dentry, open_flags);
Miklos Szeredi8867fe52012-06-05 15:10:19 +02002113 error = NFS_PROTO(dir)->create(dir, dentry, &attr, open_flags);
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04002114 trace_nfs_create_exit(dir, dentry, open_flags, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 if (error != 0)
2116 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 return 0;
2118out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 d_drop(dentry);
2120 return error;
2121}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002122EXPORT_SYMBOL_GPL(nfs_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
2124/*
2125 * See comments for nfs_proc_create regarding failed operations.
2126 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002127int
Christian Brauner549c7292021-01-21 14:19:43 +01002128nfs_mknod(struct user_namespace *mnt_userns, struct inode *dir,
2129 struct dentry *dentry, umode_t mode, dev_t rdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130{
2131 struct iattr attr;
2132 int status;
2133
Niels de Vos1e8968c2013-12-17 18:20:16 +01002134 dfprintk(VFS, "NFS: mknod(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002135 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 attr.ia_mode = mode;
2138 attr.ia_valid = ATTR_MODE;
2139
Trond Myklebust1ca42382013-08-21 12:36:04 -04002140 trace_nfs_mknod_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 status = NFS_PROTO(dir)->mknod(dir, dentry, &attr, rdev);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002142 trace_nfs_mknod_exit(dir, dentry, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 if (status != 0)
2144 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 return 0;
2146out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 d_drop(dentry);
2148 return status;
2149}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002150EXPORT_SYMBOL_GPL(nfs_mknod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151
2152/*
2153 * See comments for nfs_proc_create regarding failed operations.
2154 */
Christian Brauner549c7292021-01-21 14:19:43 +01002155int nfs_mkdir(struct user_namespace *mnt_userns, struct inode *dir,
2156 struct dentry *dentry, umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157{
2158 struct iattr attr;
2159 int error;
2160
Niels de Vos1e8968c2013-12-17 18:20:16 +01002161 dfprintk(VFS, "NFS: mkdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002162 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163
2164 attr.ia_valid = ATTR_MODE;
2165 attr.ia_mode = mode | S_IFDIR;
2166
Trond Myklebust1ca42382013-08-21 12:36:04 -04002167 trace_nfs_mkdir_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 error = NFS_PROTO(dir)->mkdir(dir, dentry, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002169 trace_nfs_mkdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 if (error != 0)
2171 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 return 0;
2173out_err:
2174 d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 return error;
2176}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002177EXPORT_SYMBOL_GPL(nfs_mkdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002179static void nfs_dentry_handle_enoent(struct dentry *dentry)
2180{
Al Virodc3f4192015-05-18 10:10:34 -04002181 if (simple_positive(dentry))
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002182 d_delete(dentry);
2183}
2184
Trond Myklebust9019fb32021-07-07 21:43:09 -04002185static void nfs_dentry_remove_handle_error(struct inode *dir,
2186 struct dentry *dentry, int error)
2187{
2188 switch (error) {
2189 case -ENOENT:
2190 d_delete(dentry);
2191 fallthrough;
2192 case 0:
2193 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2194 }
2195}
2196
Bryan Schumaker597d9282012-07-16 16:39:10 -04002197int nfs_rmdir(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198{
2199 int error;
2200
Niels de Vos1e8968c2013-12-17 18:20:16 +01002201 dfprintk(VFS, "NFS: rmdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002202 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203
Trond Myklebust1ca42382013-08-21 12:36:04 -04002204 trace_nfs_rmdir_enter(dir, dentry);
David Howells2b0143b2015-03-17 22:25:59 +00002205 if (d_really_is_positive(dentry)) {
Al Viro884be172016-04-28 23:56:31 -04002206 down_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04002207 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2208 /* Ensure the VFS deletes this inode */
2209 switch (error) {
2210 case 0:
David Howells2b0143b2015-03-17 22:25:59 +00002211 clear_nlink(d_inode(dentry));
Trond Myklebustba6c0592013-08-30 12:24:25 -04002212 break;
2213 case -ENOENT:
2214 nfs_dentry_handle_enoent(dentry);
2215 }
Al Viro884be172016-04-28 23:56:31 -04002216 up_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04002217 } else
2218 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
Trond Myklebust9019fb32021-07-07 21:43:09 -04002219 nfs_dentry_remove_handle_error(dir, dentry, error);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002220 trace_nfs_rmdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221
2222 return error;
2223}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002224EXPORT_SYMBOL_GPL(nfs_rmdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226/*
2227 * Remove a file after making sure there are no pending writes,
2228 * and after checking that the file has only one user.
2229 *
2230 * We invalidate the attribute cache and free the inode prior to the operation
2231 * to avoid possible races if the server reuses the inode.
2232 */
2233static int nfs_safe_remove(struct dentry *dentry)
2234{
David Howells2b0143b2015-03-17 22:25:59 +00002235 struct inode *dir = d_inode(dentry->d_parent);
2236 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 int error = -EBUSY;
2238
Al Viro6de14722013-09-16 10:53:17 -04002239 dfprintk(VFS, "NFS: safe_remove(%pd2)\n", dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240
2241 /* If the dentry was sillyrenamed, we simply call d_delete() */
2242 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
2243 error = 0;
2244 goto out;
2245 }
2246
Trond Myklebust1ca42382013-08-21 12:36:04 -04002247 trace_nfs_remove_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 if (inode != NULL) {
Trond Myklebust912678d2018-03-20 16:43:15 -04002249 error = NFS_PROTO(dir)->remove(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 if (error == 0)
Trond Myklebust1b83d702008-06-11 15:44:04 -04002251 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 } else
Trond Myklebust912678d2018-03-20 16:43:15 -04002253 error = NFS_PROTO(dir)->remove(dir, dentry);
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002254 if (error == -ENOENT)
2255 nfs_dentry_handle_enoent(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002256 trace_nfs_remove_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257out:
2258 return error;
2259}
2260
2261/* We do silly rename. In case sillyrename() returns -EBUSY, the inode
2262 * belongs to an active ".nfs..." file and we return -EBUSY.
2263 *
2264 * If sillyrename() returns 0, we do nothing, otherwise we unlink.
2265 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002266int nfs_unlink(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267{
2268 int error;
2269 int need_rehash = 0;
2270
Niels de Vos1e8968c2013-12-17 18:20:16 +01002271 dfprintk(VFS, "NFS: unlink(%s/%lu, %pd)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04002272 dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
Trond Myklebust1ca42382013-08-21 12:36:04 -04002274 trace_nfs_unlink_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 spin_lock(&dentry->d_lock);
Al Viro84d08fa2013-07-05 18:59:33 +04002276 if (d_count(dentry) > 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 spin_unlock(&dentry->d_lock);
Trond Myklebustccfeb502007-01-13 02:28:12 -05002278 /* Start asynchronous writeout of the inode */
David Howells2b0143b2015-03-17 22:25:59 +00002279 write_inode_now(d_inode(dentry), 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 error = nfs_sillyrename(dir, dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002281 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 }
2283 if (!d_unhashed(dentry)) {
2284 __d_drop(dentry);
2285 need_rehash = 1;
2286 }
2287 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 error = nfs_safe_remove(dentry);
Trond Myklebust9019fb32021-07-07 21:43:09 -04002289 nfs_dentry_remove_handle_error(dir, dentry, error);
2290 if (need_rehash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 d_rehash(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002292out:
2293 trace_nfs_unlink_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 return error;
2295}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002296EXPORT_SYMBOL_GPL(nfs_unlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297
Chuck Lever873101b2006-08-22 20:06:23 -04002298/*
2299 * To create a symbolic link, most file systems instantiate a new inode,
2300 * add a page to it containing the path, then write it out to the disk
2301 * using prepare_write/commit_write.
2302 *
2303 * Unfortunately the NFS client can't create the in-core inode first
2304 * because it needs a file handle to create an in-core inode (see
2305 * fs/nfs/inode.c:nfs_fhget). We only have a file handle *after* the
2306 * symlink request has completed on the server.
2307 *
2308 * So instead we allocate a raw page, copy the symname into it, then do
2309 * the SYMLINK request with the page as the buffer. If it succeeds, we
2310 * now have a new file handle and can instantiate an in-core NFS inode
2311 * and move the raw page into its mapping.
2312 */
Christian Brauner549c7292021-01-21 14:19:43 +01002313int nfs_symlink(struct user_namespace *mnt_userns, struct inode *dir,
2314 struct dentry *dentry, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315{
Chuck Lever873101b2006-08-22 20:06:23 -04002316 struct page *page;
2317 char *kaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 struct iattr attr;
Chuck Lever873101b2006-08-22 20:06:23 -04002319 unsigned int pathlen = strlen(symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 int error;
2321
Niels de Vos1e8968c2013-12-17 18:20:16 +01002322 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04002323 dir->i_ino, dentry, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324
Chuck Lever873101b2006-08-22 20:06:23 -04002325 if (pathlen > PAGE_SIZE)
2326 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
Chuck Lever873101b2006-08-22 20:06:23 -04002328 attr.ia_mode = S_IFLNK | S_IRWXUGO;
2329 attr.ia_valid = ATTR_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330
Al Viroe8ecde22016-01-14 17:52:59 -05002331 page = alloc_page(GFP_USER);
Trond Myklebust76566992008-06-11 15:44:22 -04002332 if (!page)
Chuck Lever873101b2006-08-22 20:06:23 -04002333 return -ENOMEM;
Chuck Lever873101b2006-08-22 20:06:23 -04002334
Al Viroe8ecde22016-01-14 17:52:59 -05002335 kaddr = page_address(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002336 memcpy(kaddr, symname, pathlen);
2337 if (pathlen < PAGE_SIZE)
2338 memset(kaddr + pathlen, 0, PAGE_SIZE - pathlen);
Chuck Lever873101b2006-08-22 20:06:23 -04002339
Trond Myklebust1ca42382013-08-21 12:36:04 -04002340 trace_nfs_symlink_enter(dir, dentry);
Chuck Lever94a6d752006-08-22 20:06:23 -04002341 error = NFS_PROTO(dir)->symlink(dir, dentry, page, pathlen, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002342 trace_nfs_symlink_exit(dir, dentry, error);
Chuck Lever873101b2006-08-22 20:06:23 -04002343 if (error != 0) {
Niels de Vos1e8968c2013-12-17 18:20:16 +01002344 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s) error %d\n",
Chuck Lever873101b2006-08-22 20:06:23 -04002345 dir->i_sb->s_id, dir->i_ino,
Al Viro6de14722013-09-16 10:53:17 -04002346 dentry, symname, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 d_drop(dentry);
Chuck Lever873101b2006-08-22 20:06:23 -04002348 __free_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002349 return error;
2350 }
2351
Trond Myklebust342a67f2021-07-07 22:08:32 -04002352 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2353
Chuck Lever873101b2006-08-22 20:06:23 -04002354 /*
2355 * No big deal if we can't add this page to the page cache here.
2356 * READLINK will get the missing page from the server if needed.
2357 */
David Howells2b0143b2015-03-17 22:25:59 +00002358 if (!add_to_page_cache_lru(page, d_inode(dentry)->i_mapping, 0,
Chuck Lever873101b2006-08-22 20:06:23 -04002359 GFP_KERNEL)) {
Chuck Lever873101b2006-08-22 20:06:23 -04002360 SetPageUptodate(page);
2361 unlock_page(page);
Rafael Aquinia0b54add2014-02-10 14:25:48 -08002362 /*
2363 * add_to_page_cache_lru() grabs an extra page refcount.
2364 * Drop it here to avoid leaking this page later.
2365 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002366 put_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002367 } else
2368 __free_page(page);
2369
Chuck Lever873101b2006-08-22 20:06:23 -04002370 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002372EXPORT_SYMBOL_GPL(nfs_symlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373
Bryan Schumaker597d9282012-07-16 16:39:10 -04002374int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375nfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
2376{
David Howells2b0143b2015-03-17 22:25:59 +00002377 struct inode *inode = d_inode(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 int error;
2379
Al Viro6de14722013-09-16 10:53:17 -04002380 dfprintk(VFS, "NFS: link(%pd2 -> %pd2)\n",
2381 old_dentry, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382
Trond Myklebust1fd10852013-08-21 13:54:44 -04002383 trace_nfs_link_enter(inode, dir, dentry);
Trond Myklebust9697d232007-10-02 21:58:05 -04002384 d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 error = NFS_PROTO(dir)->link(inode, dir, &dentry->d_name);
Trond Myklebustcf809552005-10-27 22:12:42 -04002386 if (error == 0) {
Trond Myklebust342a67f2021-07-07 22:08:32 -04002387 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Al Viro7de9c6ee2010-10-23 11:11:40 -04002388 ihold(inode);
Trond Myklebust9697d232007-10-02 21:58:05 -04002389 d_add(dentry, inode);
Trond Myklebustcf809552005-10-27 22:12:42 -04002390 }
Trond Myklebust1fd10852013-08-21 13:54:44 -04002391 trace_nfs_link_exit(inode, dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 return error;
2393}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002394EXPORT_SYMBOL_GPL(nfs_link);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395
2396/*
2397 * RENAME
2398 * FIXME: Some nfsds, like the Linux user space nfsd, may generate a
2399 * different file handle for the same inode after a rename (e.g. when
2400 * moving to a different directory). A fail-safe method to do so would
2401 * be to look up old_dir/old_name, create a link to new_dir/new_name and
2402 * rename the old file using the sillyrename stuff. This way, the original
2403 * file in old_dir will go away when the last process iput()s the inode.
2404 *
2405 * FIXED.
2406 *
2407 * It actually works quite well. One needs to have the possibility for
2408 * at least one ".nfs..." file in each directory the file ever gets
2409 * moved or linked to which happens automagically with the new
2410 * implementation that only depends on the dcache stuff instead of
2411 * using the inode layer
2412 *
2413 * Unfortunately, things are a little more complicated than indicated
2414 * above. For a cross-directory move, we want to make sure we can get
2415 * rid of the old inode after the operation. This means there must be
2416 * no pending writes (if it's a file), and the use count must be 1.
2417 * If these conditions are met, we can drop the dentries before doing
2418 * the rename.
2419 */
Christian Brauner549c7292021-01-21 14:19:43 +01002420int nfs_rename(struct user_namespace *mnt_userns, struct inode *old_dir,
2421 struct dentry *old_dentry, struct inode *new_dir,
2422 struct dentry *new_dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423{
David Howells2b0143b2015-03-17 22:25:59 +00002424 struct inode *old_inode = d_inode(old_dentry);
2425 struct inode *new_inode = d_inode(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002426 struct dentry *dentry = NULL, *rehash = NULL;
Jeff Layton80a491f2014-03-17 07:06:56 -04002427 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 int error = -EBUSY;
2429
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02002430 if (flags)
2431 return -EINVAL;
2432
Al Viro6de14722013-09-16 10:53:17 -04002433 dfprintk(VFS, "NFS: rename(%pd2 -> %pd2, ct=%d)\n",
2434 old_dentry, new_dentry,
Al Viro84d08fa2013-07-05 18:59:33 +04002435 d_count(new_dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
Trond Myklebust70ded202013-08-21 12:08:45 -04002437 trace_nfs_rename_enter(old_dir, old_dentry, new_dir, new_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 /*
Miklos Szeredi28f79a12009-12-03 15:58:56 -05002439 * For non-directories, check whether the target is busy and if so,
2440 * make a copy of the dentry and then do a silly-rename. If the
2441 * silly-rename succeeds, the copied dentry is hashed and becomes
2442 * the new target.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 */
Miklos Szeredi27226102009-12-03 15:58:56 -05002444 if (new_inode && !S_ISDIR(new_inode->i_mode)) {
2445 /*
2446 * To prevent any new references to the target during the
2447 * rename, we unhash the dentry in advance.
2448 */
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002449 if (!d_unhashed(new_dentry)) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002450 d_drop(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002451 rehash = new_dentry;
2452 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453
Al Viro84d08fa2013-07-05 18:59:33 +04002454 if (d_count(new_dentry) > 2) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002455 int err;
2456
2457 /* copy the target dentry's name */
2458 dentry = d_alloc(new_dentry->d_parent,
2459 &new_dentry->d_name);
2460 if (!dentry)
2461 goto out;
2462
2463 /* silly-rename the existing target ... */
2464 err = nfs_sillyrename(new_dir, new_dentry);
Miklos Szeredi24e93022009-12-03 15:58:56 -05002465 if (err)
Miklos Szeredi27226102009-12-03 15:58:56 -05002466 goto out;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002467
2468 new_dentry = dentry;
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002469 rehash = NULL;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002470 new_inode = NULL;
Miklos Szeredi27226102009-12-03 15:58:56 -05002471 }
Trond Myklebustb1e4adf2009-03-19 15:35:49 -04002472 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002474 task = nfs_async_rename(old_dir, new_dir, old_dentry, new_dentry, NULL);
Jeff Layton80a491f2014-03-17 07:06:56 -04002475 if (IS_ERR(task)) {
2476 error = PTR_ERR(task);
2477 goto out;
2478 }
2479
2480 error = rpc_wait_for_completion_task(task);
Benjamin Coddington818a8db2017-06-16 11:13:00 -04002481 if (error != 0) {
2482 ((struct nfs_renamedata *)task->tk_calldata)->cancelled = 1;
2483 /* Paired with the atomic_dec_and_test() barrier in rpc_do_put_task() */
2484 smp_wmb();
2485 } else
Jeff Layton80a491f2014-03-17 07:06:56 -04002486 error = task->tk_status;
2487 rpc_put_task(task);
Trond Myklebust59a707b2018-04-08 18:11:18 -04002488 /* Ensure the inode attributes are revalidated */
2489 if (error == 0) {
2490 spin_lock(&old_inode->i_lock);
2491 NFS_I(old_inode)->attr_gencount = nfs_inc_attr_generation_counter();
Trond Myklebustac46b3d2021-03-08 14:42:54 -05002492 nfs_set_cache_invalid(old_inode, NFS_INO_INVALID_CHANGE |
2493 NFS_INO_INVALID_CTIME |
2494 NFS_INO_REVAL_FORCED);
Trond Myklebust59a707b2018-04-08 18:11:18 -04002495 spin_unlock(&old_inode->i_lock);
2496 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497out:
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002498 if (rehash)
2499 d_rehash(rehash);
Trond Myklebust70ded202013-08-21 12:08:45 -04002500 trace_nfs_rename_exit(old_dir, old_dentry,
2501 new_dir, new_dentry, error);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002502 if (!error) {
2503 if (new_inode != NULL)
2504 nfs_drop_nlink(new_inode);
2505 /*
2506 * The d_move() should be here instead of in an async RPC completion
2507 * handler because we need the proper locks to move the dentry. If
2508 * we're interrupted by a signal, the async RPC completion handler
2509 * should mark the directories for revalidation.
2510 */
2511 d_move(old_dentry, new_dentry);
Trond Myklebustd8032242017-11-06 15:28:04 -05002512 nfs_set_verifier(old_dentry,
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002513 nfs_save_change_attribute(new_dir));
2514 } else if (error == -ENOENT)
2515 nfs_dentry_handle_enoent(old_dentry);
2516
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 /* new dentry created? */
2518 if (dentry)
2519 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 return error;
2521}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002522EXPORT_SYMBOL_GPL(nfs_rename);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002524static DEFINE_SPINLOCK(nfs_access_lru_lock);
2525static LIST_HEAD(nfs_access_lru_list);
2526static atomic_long_t nfs_access_nr_entries;
2527
Trond Myklebusta8b373e2020-02-08 09:14:11 -05002528static unsigned long nfs_access_max_cachesize = 4*1024*1024;
Trond Myklebust3a505842014-07-21 13:53:48 -04002529module_param(nfs_access_max_cachesize, ulong, 0644);
2530MODULE_PARM_DESC(nfs_access_max_cachesize, "NFS access maximum total cache length");
2531
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002532static void nfs_access_free_entry(struct nfs_access_entry *entry)
2533{
NeilBrownb68572e2018-12-03 11:30:30 +11002534 put_cred(entry->cred);
NeilBrownf682a392014-07-14 11:28:20 +10002535 kfree_rcu(entry, rcu_head);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002536 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002537 atomic_long_dec(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002538 smp_mb__after_atomic();
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002539}
2540
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002541static void nfs_access_free_list(struct list_head *head)
2542{
2543 struct nfs_access_entry *cache;
2544
2545 while (!list_empty(head)) {
2546 cache = list_entry(head->next, struct nfs_access_entry, lru);
2547 list_del(&cache->lru);
2548 nfs_access_free_entry(cache);
2549 }
2550}
2551
Trond Myklebust3a505842014-07-21 13:53:48 -04002552static unsigned long
2553nfs_do_access_cache_scan(unsigned int nr_to_scan)
Trond Myklebust979df722006-07-25 11:28:19 -04002554{
2555 LIST_HEAD(head);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002556 struct nfs_inode *nfsi, *next;
Trond Myklebust979df722006-07-25 11:28:19 -04002557 struct nfs_access_entry *cache;
Dave Chinner1ab6c492013-08-28 10:18:09 +10002558 long freed = 0;
Trond Myklebust979df722006-07-25 11:28:19 -04002559
Trond Myklebusta50f7952007-06-05 19:23:43 -04002560 spin_lock(&nfs_access_lru_lock);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002561 list_for_each_entry_safe(nfsi, next, &nfs_access_lru_list, access_cache_inode_lru) {
Trond Myklebust979df722006-07-25 11:28:19 -04002562 struct inode *inode;
2563
2564 if (nr_to_scan-- == 0)
2565 break;
Trond Myklebust9c7e7e22010-05-13 12:51:06 -04002566 inode = &nfsi->vfs_inode;
Trond Myklebust979df722006-07-25 11:28:19 -04002567 spin_lock(&inode->i_lock);
2568 if (list_empty(&nfsi->access_cache_entry_lru))
2569 goto remove_lru_entry;
2570 cache = list_entry(nfsi->access_cache_entry_lru.next,
2571 struct nfs_access_entry, lru);
2572 list_move(&cache->lru, &head);
2573 rb_erase(&cache->rb_node, &nfsi->access_cache);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002574 freed++;
Trond Myklebust979df722006-07-25 11:28:19 -04002575 if (!list_empty(&nfsi->access_cache_entry_lru))
2576 list_move_tail(&nfsi->access_cache_inode_lru,
2577 &nfs_access_lru_list);
2578 else {
2579remove_lru_entry:
2580 list_del_init(&nfsi->access_cache_inode_lru);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002581 smp_mb__before_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002582 clear_bit(NFS_INO_ACL_LRU_SET, &nfsi->flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002583 smp_mb__after_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002584 }
Trond Myklebust59844a92010-05-26 08:42:24 -04002585 spin_unlock(&inode->i_lock);
Trond Myklebust979df722006-07-25 11:28:19 -04002586 }
2587 spin_unlock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002588 nfs_access_free_list(&head);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002589 return freed;
2590}
2591
2592unsigned long
Trond Myklebust3a505842014-07-21 13:53:48 -04002593nfs_access_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
2594{
2595 int nr_to_scan = sc->nr_to_scan;
2596 gfp_t gfp_mask = sc->gfp_mask;
2597
2598 if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
2599 return SHRINK_STOP;
2600 return nfs_do_access_cache_scan(nr_to_scan);
2601}
2602
2603
2604unsigned long
Dave Chinner1ab6c492013-08-28 10:18:09 +10002605nfs_access_cache_count(struct shrinker *shrink, struct shrink_control *sc)
2606{
Glauber Costa55f841c2013-08-28 10:17:53 +10002607 return vfs_pressure_ratio(atomic_long_read(&nfs_access_nr_entries));
Trond Myklebust979df722006-07-25 11:28:19 -04002608}
2609
Trond Myklebust3a505842014-07-21 13:53:48 -04002610static void
2611nfs_access_cache_enforce_limit(void)
2612{
2613 long nr_entries = atomic_long_read(&nfs_access_nr_entries);
2614 unsigned long diff;
2615 unsigned int nr_to_scan;
2616
2617 if (nr_entries < 0 || nr_entries <= nfs_access_max_cachesize)
2618 return;
2619 nr_to_scan = 100;
2620 diff = nr_entries - nfs_access_max_cachesize;
2621 if (diff < nr_to_scan)
2622 nr_to_scan = diff;
2623 nfs_do_access_cache_scan(nr_to_scan);
2624}
2625
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002626static void __nfs_access_zap_cache(struct nfs_inode *nfsi, struct list_head *head)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002627{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002628 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002629 struct rb_node *n;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002630 struct nfs_access_entry *entry;
2631
2632 /* Unhook entries from the cache */
2633 while ((n = rb_first(root_node)) != NULL) {
2634 entry = rb_entry(n, struct nfs_access_entry, rb_node);
2635 rb_erase(n, root_node);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002636 list_move(&entry->lru, head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002637 }
2638 nfsi->cache_validity &= ~NFS_INO_INVALID_ACCESS;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002639}
2640
2641void nfs_access_zap_cache(struct inode *inode)
2642{
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002643 LIST_HEAD(head);
2644
2645 if (test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags) == 0)
2646 return;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002647 /* Remove from global LRU init */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002648 spin_lock(&nfs_access_lru_lock);
2649 if (test_and_clear_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002650 list_del_init(&NFS_I(inode)->access_cache_inode_lru);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002651
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002652 spin_lock(&inode->i_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002653 __nfs_access_zap_cache(NFS_I(inode), &head);
2654 spin_unlock(&inode->i_lock);
2655 spin_unlock(&nfs_access_lru_lock);
2656 nfs_access_free_list(&head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002657}
Bryan Schumaker1c606fb2012-07-30 16:05:24 -04002658EXPORT_SYMBOL_GPL(nfs_access_zap_cache);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002659
NeilBrownb68572e2018-12-03 11:30:30 +11002660static struct nfs_access_entry *nfs_access_search_rbtree(struct inode *inode, const struct cred *cred)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002661{
2662 struct rb_node *n = NFS_I(inode)->access_cache.rb_node;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002663
2664 while (n != NULL) {
NeilBrownb68572e2018-12-03 11:30:30 +11002665 struct nfs_access_entry *entry =
2666 rb_entry(n, struct nfs_access_entry, rb_node);
2667 int cmp = cred_fscmp(cred, entry->cred);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002668
NeilBrownb68572e2018-12-03 11:30:30 +11002669 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002670 n = n->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002671 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002672 n = n->rb_right;
2673 else
2674 return entry;
2675 }
2676 return NULL;
2677}
2678
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002679static int nfs_access_get_cached_locked(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res, bool may_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680{
Chuck Lever55296802005-08-18 11:24:09 -07002681 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002682 struct nfs_access_entry *cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002683 bool retry = true;
2684 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002686 spin_lock(&inode->i_lock);
Trond Myklebust57b69182016-06-03 17:07:19 -04002687 for(;;) {
2688 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2689 goto out_zap;
2690 cache = nfs_access_search_rbtree(inode, cred);
2691 err = -ENOENT;
2692 if (cache == NULL)
2693 goto out;
2694 /* Found an entry, is our attribute cache valid? */
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002695 if (!nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
Trond Myklebust57b69182016-06-03 17:07:19 -04002696 break;
Trond Myklebust5c965db2020-01-06 15:39:36 -05002697 if (!retry)
2698 break;
Trond Myklebust57b69182016-06-03 17:07:19 -04002699 err = -ECHILD;
2700 if (!may_block)
2701 goto out;
Trond Myklebust57b69182016-06-03 17:07:19 -04002702 spin_unlock(&inode->i_lock);
2703 err = __nfs_revalidate_inode(NFS_SERVER(inode), inode);
2704 if (err)
2705 return err;
2706 spin_lock(&inode->i_lock);
2707 retry = false;
2708 }
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002709 res->cred = cache->cred;
2710 res->mask = cache->mask;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002711 list_move_tail(&cache->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002712 err = 0;
2713out:
2714 spin_unlock(&inode->i_lock);
2715 return err;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002716out_zap:
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002717 spin_unlock(&inode->i_lock);
2718 nfs_access_zap_cache(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002719 return -ENOENT;
2720}
2721
NeilBrownb68572e2018-12-03 11:30:30 +11002722static int nfs_access_get_cached_rcu(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res)
NeilBrownf682a392014-07-14 11:28:20 +10002723{
2724 /* Only check the most recently returned cache entry,
2725 * but do it without locking.
2726 */
2727 struct nfs_inode *nfsi = NFS_I(inode);
2728 struct nfs_access_entry *cache;
2729 int err = -ECHILD;
2730 struct list_head *lh;
2731
2732 rcu_read_lock();
2733 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2734 goto out;
Madhuparna Bhowmik9f01eb52019-12-10 11:16:39 +05302735 lh = rcu_dereference(list_tail_rcu(&nfsi->access_cache_entry_lru));
NeilBrownf682a392014-07-14 11:28:20 +10002736 cache = list_entry(lh, struct nfs_access_entry, lru);
2737 if (lh == &nfsi->access_cache_entry_lru ||
Trond Myklebust9a206de2020-01-26 17:31:14 -05002738 cred_fscmp(cred, cache->cred) != 0)
NeilBrownf682a392014-07-14 11:28:20 +10002739 cache = NULL;
2740 if (cache == NULL)
2741 goto out;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002742 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
NeilBrownf682a392014-07-14 11:28:20 +10002743 goto out;
NeilBrownf682a392014-07-14 11:28:20 +10002744 res->cred = cache->cred;
2745 res->mask = cache->mask;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002746 err = 0;
NeilBrownf682a392014-07-14 11:28:20 +10002747out:
2748 rcu_read_unlock();
2749 return err;
2750}
2751
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002752int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct
2753nfs_access_entry *res, bool may_block)
2754{
2755 int status;
2756
2757 status = nfs_access_get_cached_rcu(inode, cred, res);
2758 if (status != 0)
2759 status = nfs_access_get_cached_locked(inode, cred, res,
2760 may_block);
2761
2762 return status;
2763}
2764EXPORT_SYMBOL_GPL(nfs_access_get_cached);
2765
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002766static void nfs_access_add_rbtree(struct inode *inode, struct nfs_access_entry *set)
2767{
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002768 struct nfs_inode *nfsi = NFS_I(inode);
2769 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002770 struct rb_node **p = &root_node->rb_node;
2771 struct rb_node *parent = NULL;
2772 struct nfs_access_entry *entry;
NeilBrownb68572e2018-12-03 11:30:30 +11002773 int cmp;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002774
2775 spin_lock(&inode->i_lock);
2776 while (*p != NULL) {
2777 parent = *p;
2778 entry = rb_entry(parent, struct nfs_access_entry, rb_node);
NeilBrownb68572e2018-12-03 11:30:30 +11002779 cmp = cred_fscmp(set->cred, entry->cred);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002780
NeilBrownb68572e2018-12-03 11:30:30 +11002781 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002782 p = &parent->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002783 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002784 p = &parent->rb_right;
2785 else
2786 goto found;
2787 }
2788 rb_link_node(&set->rb_node, parent, p);
2789 rb_insert_color(&set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002790 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002791 spin_unlock(&inode->i_lock);
2792 return;
2793found:
2794 rb_replace_node(parent, &set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002795 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2796 list_del(&entry->lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002797 spin_unlock(&inode->i_lock);
2798 nfs_access_free_entry(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799}
2800
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002801void nfs_access_add_cache(struct inode *inode, struct nfs_access_entry *set)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002803 struct nfs_access_entry *cache = kmalloc(sizeof(*cache), GFP_KERNEL);
2804 if (cache == NULL)
2805 return;
2806 RB_CLEAR_NODE(&cache->rb_node);
NeilBrownb68572e2018-12-03 11:30:30 +11002807 cache->cred = get_cred(set->cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808 cache->mask = set->mask;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002809
NeilBrownf682a392014-07-14 11:28:20 +10002810 /* The above field assignments must be visible
2811 * before this item appears on the lru. We cannot easily
2812 * use rcu_assign_pointer, so just force the memory barrier.
2813 */
2814 smp_wmb();
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002815 nfs_access_add_rbtree(inode, cache);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002816
2817 /* Update accounting */
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002818 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002819 atomic_long_inc(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002820 smp_mb__after_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002821
2822 /* Add inode to global LRU list */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002823 if (!test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags)) {
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002824 spin_lock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002825 if (!test_and_set_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2826 list_add_tail(&NFS_I(inode)->access_cache_inode_lru,
2827 &nfs_access_lru_list);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002828 spin_unlock(&nfs_access_lru_lock);
2829 }
Trond Myklebust3a505842014-07-21 13:53:48 -04002830 nfs_access_cache_enforce_limit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002831}
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002832EXPORT_SYMBOL_GPL(nfs_access_add_cache);
2833
Anna Schumaker3c181822017-07-26 10:14:55 -04002834#define NFS_MAY_READ (NFS_ACCESS_READ)
2835#define NFS_MAY_WRITE (NFS_ACCESS_MODIFY | \
2836 NFS_ACCESS_EXTEND | \
2837 NFS_ACCESS_DELETE)
2838#define NFS_FILE_MAY_WRITE (NFS_ACCESS_MODIFY | \
2839 NFS_ACCESS_EXTEND)
Trond Myklebustecbb9032017-07-11 17:54:35 -04002840#define NFS_DIR_MAY_WRITE NFS_MAY_WRITE
Anna Schumaker3c181822017-07-26 10:14:55 -04002841#define NFS_MAY_LOOKUP (NFS_ACCESS_LOOKUP)
2842#define NFS_MAY_EXECUTE (NFS_ACCESS_EXECUTE)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002843static int
Trond Myklebustecbb9032017-07-11 17:54:35 -04002844nfs_access_calc_mask(u32 access_result, umode_t umode)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002845{
2846 int mask = 0;
2847
2848 if (access_result & NFS_MAY_READ)
2849 mask |= MAY_READ;
Trond Myklebustecbb9032017-07-11 17:54:35 -04002850 if (S_ISDIR(umode)) {
2851 if ((access_result & NFS_DIR_MAY_WRITE) == NFS_DIR_MAY_WRITE)
2852 mask |= MAY_WRITE;
2853 if ((access_result & NFS_MAY_LOOKUP) == NFS_MAY_LOOKUP)
2854 mask |= MAY_EXEC;
2855 } else if (S_ISREG(umode)) {
2856 if ((access_result & NFS_FILE_MAY_WRITE) == NFS_FILE_MAY_WRITE)
2857 mask |= MAY_WRITE;
2858 if ((access_result & NFS_MAY_EXECUTE) == NFS_MAY_EXECUTE)
2859 mask |= MAY_EXEC;
2860 } else if (access_result & NFS_MAY_WRITE)
2861 mask |= MAY_WRITE;
Trond Myklebust15d4b732017-07-11 17:54:32 -04002862 return mask;
2863}
2864
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002865void nfs_access_set_mask(struct nfs_access_entry *entry, u32 access_result)
2866{
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002867 entry->mask = access_result;
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002868}
2869EXPORT_SYMBOL_GPL(nfs_access_set_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870
NeilBrownb68572e2018-12-03 11:30:30 +11002871static int nfs_do_access(struct inode *inode, const struct cred *cred, int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872{
2873 struct nfs_access_entry cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002874 bool may_block = (mask & MAY_NOT_BLOCK) == 0;
Trond Myklebuste8194b72020-01-06 15:25:12 -05002875 int cache_mask = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876 int status;
2877
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002878 trace_nfs_access_enter(inode);
2879
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002880 status = nfs_access_get_cached(inode, cred, &cache, may_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 if (status == 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002882 goto out_cached;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883
NeilBrownf3324a22014-07-14 11:28:20 +10002884 status = -ECHILD;
Trond Myklebust57b69182016-06-03 17:07:19 -04002885 if (!may_block)
NeilBrownf3324a22014-07-14 11:28:20 +10002886 goto out;
2887
Anna Schumaker1750d922017-07-26 12:00:21 -04002888 /*
2889 * Determine which access bits we want to ask for...
2890 */
2891 cache.mask = NFS_ACCESS_READ | NFS_ACCESS_MODIFY | NFS_ACCESS_EXTEND;
Frank van der Linden72832a22020-06-23 22:38:58 +00002892 if (nfs_server_capable(inode, NFS_CAP_XATTR)) {
2893 cache.mask |= NFS_ACCESS_XAREAD | NFS_ACCESS_XAWRITE |
2894 NFS_ACCESS_XALIST;
2895 }
Anna Schumaker1750d922017-07-26 12:00:21 -04002896 if (S_ISDIR(inode->i_mode))
2897 cache.mask |= NFS_ACCESS_DELETE | NFS_ACCESS_LOOKUP;
2898 else
2899 cache.mask |= NFS_ACCESS_EXECUTE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 cache.cred = cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901 status = NFS_PROTO(inode)->access(inode, &cache);
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002902 if (status != 0) {
2903 if (status == -ESTALE) {
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002904 if (!S_ISDIR(inode->i_mode))
Trond Myklebust93ce4af2020-04-06 13:39:29 -04002905 nfs_set_inode_stale(inode);
2906 else
2907 nfs_zap_caches(inode);
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002908 }
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002909 goto out;
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002910 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 nfs_access_add_cache(inode, &cache);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002912out_cached:
Trond Myklebustecbb9032017-07-11 17:54:35 -04002913 cache_mask = nfs_access_calc_mask(cache.mask, inode->i_mode);
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002914 if ((mask & ~cache_mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) != 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002915 status = -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916out:
Trond Myklebuste8194b72020-01-06 15:25:12 -05002917 trace_nfs_access_exit(inode, mask, cache_mask, status);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002918 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002919}
2920
Trond Myklebustaf22f942007-08-10 17:45:10 -04002921static int nfs_open_permission_mask(int openflags)
2922{
2923 int mask = 0;
2924
Weston Andros Adamsonf8d9a892013-01-03 16:42:29 -05002925 if (openflags & __FMODE_EXEC) {
2926 /* ONLY check exec rights */
2927 mask = MAY_EXEC;
2928 } else {
2929 if ((openflags & O_ACCMODE) != O_WRONLY)
2930 mask |= MAY_READ;
2931 if ((openflags & O_ACCMODE) != O_RDONLY)
2932 mask |= MAY_WRITE;
2933 }
2934
Trond Myklebustaf22f942007-08-10 17:45:10 -04002935 return mask;
2936}
2937
NeilBrownb68572e2018-12-03 11:30:30 +11002938int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags)
Trond Myklebustaf22f942007-08-10 17:45:10 -04002939{
2940 return nfs_do_access(inode, cred, nfs_open_permission_mask(openflags));
2941}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04002942EXPORT_SYMBOL_GPL(nfs_may_open);
Trond Myklebustaf22f942007-08-10 17:45:10 -04002943
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002944static int nfs_execute_ok(struct inode *inode, int mask)
2945{
2946 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002947 int ret = 0;
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002948
Trond Myklebust38258272018-07-24 14:27:11 -04002949 if (S_ISDIR(inode->i_mode))
2950 return 0;
Trond Myklebust720869e2021-04-13 09:41:16 -04002951 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_MODE)) {
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002952 if (mask & MAY_NOT_BLOCK)
2953 return -ECHILD;
2954 ret = __nfs_revalidate_inode(server, inode);
2955 }
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002956 if (ret == 0 && !execute_ok(inode))
2957 ret = -EACCES;
2958 return ret;
2959}
2960
Christian Brauner549c7292021-01-21 14:19:43 +01002961int nfs_permission(struct user_namespace *mnt_userns,
2962 struct inode *inode,
2963 int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964{
NeilBrownb68572e2018-12-03 11:30:30 +11002965 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966 int res = 0;
2967
Chuck Lever91d5b472006-03-20 13:44:14 -05002968 nfs_inc_stats(inode, NFSIOS_VFSACCESS);
2969
Al Viroe6305c42008-07-15 21:03:57 -04002970 if ((mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971 goto out;
2972 /* Is this sys_access() ? */
Eric Paris9cfcac82010-07-23 11:43:51 -04002973 if (mask & (MAY_ACCESS | MAY_CHDIR))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974 goto force_lookup;
2975
2976 switch (inode->i_mode & S_IFMT) {
2977 case S_IFLNK:
2978 goto out;
2979 case S_IFREG:
Trond Myklebust762674f2015-12-26 21:54:58 -05002980 if ((mask & MAY_OPEN) &&
2981 nfs_server_capable(inode, NFS_CAP_ATOMIC_OPEN))
2982 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983 break;
2984 case S_IFDIR:
2985 /*
2986 * Optimize away all write operations, since the server
2987 * will check permissions when we perform the op.
2988 */
2989 if ((mask & MAY_WRITE) && !(mask & MAY_READ))
2990 goto out;
2991 }
2992
2993force_lookup:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994 if (!NFS_PROTO(inode)->access)
2995 goto out_notsup;
2996
Zhouyi Zhoueb095c12020-03-06 03:45:26 +00002997 res = nfs_do_access(inode, cred, mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998out:
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002999 if (!res && (mask & MAY_EXEC))
3000 res = nfs_execute_ok(inode, mask);
Miklos Szeredif696a362008-07-31 13:41:58 +02003001
Niels de Vos1e8968c2013-12-17 18:20:16 +01003002 dfprintk(VFS, "NFS: permission(%s/%lu), mask=0x%x, res=%d\n",
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05003003 inode->i_sb->s_id, inode->i_ino, mask, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003004 return res;
3005out_notsup:
NeilBrownd51ac1a2014-07-14 11:28:20 +10003006 if (mask & MAY_NOT_BLOCK)
3007 return -ECHILD;
3008
Trond Myklebust720869e2021-04-13 09:41:16 -04003009 res = nfs_revalidate_inode(inode, NFS_INO_INVALID_MODE |
3010 NFS_INO_INVALID_OTHER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011 if (res == 0)
Christian Brauner47291ba2021-01-21 14:19:24 +01003012 res = generic_permission(&init_user_ns, inode, mask);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05003013 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04003015EXPORT_SYMBOL_GPL(nfs_permission);