blob: 408c3bb549b1e13428fa6ea219d62b3a8835b906 [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 Schumakerdd225cb2021-10-22 13:11:12 -0400685 nfs_setsecurity(d_inode(dentry), entry->fattr);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400686 goto out;
687 } else {
Eric W. Biederman5542aa22014-02-13 09:46:25 -0800688 d_invalidate(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400689 dput(dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400690 dentry = NULL;
691 goto again;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400692 }
693 }
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400694 if (!entry->fh->size) {
695 d_lookup_done(dentry);
696 goto out;
697 }
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400698
Anna Schumakercf7ab002021-10-22 13:11:11 -0400699 inode = nfs_fhget(dentry->d_sb, entry->fh, entry->fattr);
Al Viro41d28bc2014-10-12 22:24:21 -0400700 alias = d_splice_alias(inode, dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400701 d_lookup_done(dentry);
702 if (alias) {
703 if (IS_ERR(alias))
704 goto out;
705 dput(dentry);
706 dentry = alias;
707 }
Trond Myklebusta1147b82020-02-05 09:01:52 -0500708 nfs_set_verifier(dentry, dir_verifier);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400709out:
710 dput(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400711}
712
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400713/* Perform conversion from xdr to cache array */
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500714static int nfs_readdir_page_filler(struct nfs_readdir_descriptor *desc,
715 struct nfs_entry *entry,
716 struct page **xdr_pages,
Trond Myklebust35df59d2020-11-06 20:38:47 -0500717 unsigned int buflen,
718 struct page **arrays,
719 size_t narrays)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400720{
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500721 struct address_space *mapping = desc->file->f_mapping;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400722 struct xdr_stream stream;
Benny Halevyf7da7a12011-05-19 14:16:47 -0400723 struct xdr_buf buf;
Trond Myklebust35df59d2020-11-06 20:38:47 -0500724 struct page *scratch, *new, *page = *arrays;
Trond Myklebust5c346852010-11-20 12:43:45 -0500725 int status;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400726
Trond Myklebust66502392011-01-08 17:45:38 -0500727 scratch = alloc_page(GFP_KERNEL);
728 if (scratch == NULL)
729 return -ENOMEM;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400730
Benny Halevyf7da7a12011-05-19 14:16:47 -0400731 xdr_init_decode_pages(&stream, &buf, xdr_pages, buflen);
Chuck Lever0ae4c3e2020-11-11 15:52:47 -0500732 xdr_set_scratch_page(&stream, scratch);
Bryan Schumaker99424382010-10-21 16:33:16 -0400733
734 do {
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400735 if (entry->fattr->label)
736 entry->fattr->label->len = NFS4_MAXLABELLEN;
Jeffrey Mitchelld33030e2020-09-15 16:42:52 -0500737
Bryan Schumaker99424382010-10-21 16:33:16 -0400738 status = xdr_decode(desc, entry, &stream);
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500739 if (status != 0)
Bryan Schumaker99424382010-10-21 16:33:16 -0400740 break;
Trond Myklebust5c346852010-11-20 12:43:45 -0500741
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400742 if (desc->plus)
Trond Myklebusta1147b82020-02-05 09:01:52 -0500743 nfs_prime_dcache(file_dentry(desc->file), entry,
744 desc->dir_verifier);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500745
Max Kellermanndb531db2019-07-12 16:18:06 +0200746 status = nfs_readdir_add_to_array(entry, page);
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500747 if (status != -ENOSPC)
748 continue;
Bryan Schumaker99424382010-10-21 16:33:16 -0400749
Trond Myklebust35df59d2020-11-06 20:38:47 -0500750 if (page->mapping != mapping) {
751 if (!--narrays)
752 break;
753 new = nfs_readdir_page_array_alloc(entry->prev_cookie,
754 GFP_KERNEL);
755 if (!new)
756 break;
757 arrays++;
758 *arrays = page = new;
759 } else {
760 new = nfs_readdir_page_get_next(mapping,
761 page->index + 1,
762 entry->prev_cookie);
763 if (!new)
764 break;
765 if (page != *arrays)
766 nfs_readdir_page_unlock_and_put(page);
767 page = new;
768 }
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500769 status = nfs_readdir_add_to_array(entry, page);
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500770 } while (!status && !entry->eof);
Bryan Schumaker99424382010-10-21 16:33:16 -0400771
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500772 switch (status) {
773 case -EBADCOOKIE:
774 if (entry->eof) {
775 nfs_readdir_page_set_eof(page);
776 status = 0;
777 }
778 break;
779 case -ENOSPC:
780 case -EAGAIN:
Fabian Frederick0795bf82017-05-03 20:52:21 +0200781 status = 0;
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500782 break;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400783 }
Trond Myklebust66502392011-01-08 17:45:38 -0500784
Trond Myklebust35df59d2020-11-06 20:38:47 -0500785 if (page != *arrays)
Trond Myklebust3b2a09f2020-11-01 13:14:10 -0500786 nfs_readdir_page_unlock_and_put(page);
787
Trond Myklebust66502392011-01-08 17:45:38 -0500788 put_page(scratch);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500789 return status;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400790}
791
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500792static void nfs_readdir_free_pages(struct page **pages, size_t npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400793{
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500794 while (npages--)
795 put_page(pages[npages]);
796 kfree(pages);
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400797}
798
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400799/*
zhangliguangbf211ca2019-02-16 08:38:40 +0800800 * nfs_readdir_alloc_pages() will allocate pages that must be freed with a call
801 * to nfs_readdir_free_pages()
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400802 */
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500803static struct page **nfs_readdir_alloc_pages(size_t npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400804{
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500805 struct page **pages;
806 size_t i;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400807
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500808 pages = kmalloc_array(npages, sizeof(*pages), GFP_KERNEL);
809 if (!pages)
810 return NULL;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400811 for (i = 0; i < npages; i++) {
812 struct page *page = alloc_page(GFP_KERNEL);
813 if (page == NULL)
814 goto out_freepages;
815 pages[i] = page;
816 }
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500817 return pages;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400818
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400819out_freepages:
Anna Schumakerc7e96682015-07-13 14:01:25 -0400820 nfs_readdir_free_pages(pages, i);
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500821 return NULL;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400822}
823
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500824static int nfs_readdir_xdr_to_array(struct nfs_readdir_descriptor *desc,
Trond Myklebust35df59d2020-11-06 20:38:47 -0500825 __be32 *verf_arg, __be32 *verf_res,
826 struct page **arrays, size_t narrays)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400827{
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500828 struct page **pages;
Trond Myklebust35df59d2020-11-06 20:38:47 -0500829 struct page *page = *arrays;
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500830 struct nfs_entry *entry;
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500831 size_t array_size;
Trond Myklebustb593c092020-11-02 20:06:12 -0500832 struct inode *inode = file_inode(desc->file);
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500833 size_t dtsize = NFS_SERVER(inode)->dtsize;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500834 int status = -ENOMEM;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400835
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500836 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
837 if (!entry)
838 return -ENOMEM;
839 entry->cookie = nfs_readdir_page_last_cookie(page);
840 entry->fh = nfs_alloc_fhandle();
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400841 entry->fattr = nfs_alloc_fattr_with_label(NFS_SERVER(inode));
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500842 entry->server = NFS_SERVER(inode);
843 if (entry->fh == NULL || entry->fattr == NULL)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400844 goto out;
845
Trond Myklebust1a34c8c92020-11-01 14:26:47 -0500846 array_size = (dtsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
847 pages = nfs_readdir_alloc_pages(array_size);
848 if (!pages)
Anna Schumakerb1db9a42021-10-22 13:11:01 -0400849 goto out;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400850
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400851 do {
Trond Myklebustac396122010-11-15 20:26:22 -0500852 unsigned int pglen;
Trond Myklebustb593c092020-11-02 20:06:12 -0500853 status = nfs_readdir_xdr_filler(desc, verf_arg, entry->cookie,
854 pages, dtsize,
855 verf_res);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400856 if (status < 0)
857 break;
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500858
Trond Myklebustac396122010-11-15 20:26:22 -0500859 pglen = status;
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500860 if (pglen == 0) {
861 nfs_readdir_page_set_eof(page);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500862 break;
863 }
Trond Myklebust972bcdf2020-11-01 17:15:43 -0500864
Nagendra S Tomaree3707a2021-03-16 10:25:14 +0000865 verf_arg = verf_res;
866
Trond Myklebust35df59d2020-11-06 20:38:47 -0500867 status = nfs_readdir_page_filler(desc, entry, pages, pglen,
868 arrays, narrays);
Trond Myklebuste762a632020-11-01 13:31:20 -0500869 } while (!status && nfs_readdir_page_needs_filling(page));
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400870
Anna Schumakerc7e96682015-07-13 14:01:25 -0400871 nfs_readdir_free_pages(pages, array_size);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400872out:
Trond Myklebust6b75cf92020-11-02 08:55:03 -0500873 nfs_free_fattr(entry->fattr);
874 nfs_free_fhandle(entry->fh);
875 kfree(entry);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400876 return status;
877}
878
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500879static void nfs_readdir_page_put(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300881 put_page(desc->page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 desc->page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
884
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500885static void
886nfs_readdir_page_unlock_and_put_cached(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500888 unlock_page(desc->page);
889 nfs_readdir_page_put(desc);
890}
891
892static struct page *
893nfs_readdir_page_get_cached(struct nfs_readdir_descriptor *desc)
894{
895 return nfs_readdir_page_get_locked(desc->file->f_mapping,
896 desc->page_index,
897 desc->last_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898}
899
900/*
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400901 * Returns 0 if desc->dir_cookie was found on page desc->page_index
Trond Myklebust114de382020-02-02 17:53:54 -0500902 * and locks the page to prevent removal from the page cache.
Olivier Galibert00a92642005-06-22 17:16:29 +0000903 */
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500904static int find_and_lock_cache_page(struct nfs_readdir_descriptor *desc)
Olivier Galibert00a92642005-06-22 17:16:29 +0000905{
Dai Ngo227823d2020-01-22 20:45:39 -0500906 struct inode *inode = file_inode(desc->file);
907 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebustb593c092020-11-02 20:06:12 -0500908 __be32 verf[NFS_DIR_VERIFIER_SIZE];
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400909 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000910
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500911 desc->page = nfs_readdir_page_get_cached(desc);
912 if (!desc->page)
913 return -ENOMEM;
914 if (nfs_readdir_page_needs_filling(desc->page)) {
Trond Myklebust35df59d2020-11-06 20:38:47 -0500915 res = nfs_readdir_xdr_to_array(desc, nfsi->cookieverf, verf,
916 &desc->page, 1);
Trond Myklebust9fff59e2020-11-02 20:11:32 -0500917 if (res < 0) {
918 nfs_readdir_page_unlock_and_put_cached(desc);
919 if (res == -EBADCOOKIE || res == -ENOTSYNC) {
920 invalidate_inode_pages2(desc->file->f_mapping);
921 desc->page_index = 0;
922 return -EAGAIN;
923 }
924 return res;
Dai Ngo227823d2020-01-22 20:45:39 -0500925 }
Trond Myklebustf892c412021-03-17 08:46:19 -0400926 /*
927 * Set the cookie verifier if the page cache was empty
928 */
929 if (desc->page_index == 0)
930 memcpy(nfsi->cookieverf, verf,
931 sizeof(nfsi->cookieverf));
Trond Myklebust114de382020-02-02 17:53:54 -0500932 }
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500933 res = nfs_readdir_search_array(desc);
Trond Myklebustff81dfb2021-09-28 14:33:44 -0400934 if (res == 0)
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500935 return 0;
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -0500936 nfs_readdir_page_unlock_and_put_cached(desc);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400937 return res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000938}
939
Trond Myklebust794092c2020-11-06 20:47:05 -0500940static bool nfs_readdir_dont_search_cache(struct nfs_readdir_descriptor *desc)
941{
942 struct address_space *mapping = desc->file->f_mapping;
943 struct inode *dir = file_inode(desc->file);
944 unsigned int dtsize = NFS_SERVER(dir)->dtsize;
945 loff_t size = i_size_read(dir);
946
947 /*
948 * Default to uncached readdir if the page cache is empty, and
949 * we're looking for a non-zero cookie in a large directory.
950 */
951 return desc->dir_cookie != 0 && mapping->nrpages == 0 && size > dtsize;
952}
953
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400954/* Search for desc->dir_cookie from the beginning of the page cache */
Trond Myklebust6c981ef2020-11-03 07:42:04 -0500955static int readdir_search_pagecache(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956{
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500957 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000958
Trond Myklebust794092c2020-11-06 20:47:05 -0500959 if (nfs_readdir_dont_search_cache(desc))
960 return -EBADCOOKIE;
961
Trond Myklebust47c716c2010-12-07 12:44:56 -0500962 do {
Trond Myklebust9fff59e2020-11-02 20:11:32 -0500963 if (desc->page_index == 0) {
964 desc->current_index = 0;
965 desc->prev_index = 0;
966 desc->last_cookie = 0;
967 }
Trond Myklebust114de382020-02-02 17:53:54 -0500968 res = find_and_lock_cache_page(desc);
Trond Myklebust47c716c2010-12-07 12:44:56 -0500969 } while (res == -EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 return res;
971}
972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973/*
974 * Once we've found the start of the dirent within a page: fill 'er up...
975 */
Trond Myklebust13884ff2021-03-16 07:57:40 -0400976static void nfs_do_filldir(struct nfs_readdir_descriptor *desc,
977 const __be32 *verf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
979 struct file *file = desc->file;
Trond Myklebustdbeaf8c2020-11-01 18:20:03 -0500980 struct nfs_cache_array *array;
981 unsigned int i = 0;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400982
Fabian Frederick0795bf82017-05-03 20:52:21 +0200983 array = kmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400984 for (i = desc->cache_entry_index; i < array->size; i++) {
Trond Myklebustece0b422010-11-20 13:55:33 -0500985 struct nfs_cache_array_entry *ent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Trond Myklebustece0b422010-11-20 13:55:33 -0500987 ent = &array->array[i];
Trond Myklebusta52a8a62020-11-01 19:17:29 -0500988 if (!dir_emit(desc->ctx, ent->name, ent->name_len,
Al Viro23db8622013-05-17 16:34:50 -0400989 nfs_compat_user_ino64(ent->ino), ent->d_type)) {
Thomas Meyer6089dd02017-10-07 16:02:21 +0200990 desc->eof = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 break;
Trond Myklebustece0b422010-11-20 13:55:33 -0500992 }
Trond Myklebust13884ff2021-03-16 07:57:40 -0400993 memcpy(desc->verf, verf, sizeof(desc->verf));
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400994 if (i < (array->size-1))
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500995 desc->dir_cookie = array->array[i+1].cookie;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400996 else
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500997 desc->dir_cookie = array->last_cookie;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500998 if (nfs_readdir_use_cookie(file))
Trond Myklebust2e7a4642020-11-01 09:56:18 -0500999 desc->ctx->pos = desc->dir_cookie;
Trond Myklebust59e356a2020-02-03 14:49:33 -05001000 else
1001 desc->ctx->pos++;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001002 if (desc->duped != 0)
1003 desc->duped = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 }
Trond Myklebustb1e21c92020-11-01 13:45:55 -05001005 if (array->page_is_eof)
Thomas Meyer6089dd02017-10-07 16:02:21 +02001006 desc->eof = true;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -04001007
Fabian Frederick0795bf82017-05-03 20:52:21 +02001008 kunmap(desc->page);
Trond Myklebustdbeaf8c2020-11-01 18:20:03 -05001009 dfprintk(DIRCACHE, "NFS: nfs_do_filldir() filling ended @ cookie %llu\n",
1010 (unsigned long long)desc->dir_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011}
1012
1013/*
1014 * If we cannot find a cookie in our cache, we suspect that this is
1015 * because it points to a deleted file, so we ask the server to return
1016 * whatever it thinks is the next entry. We then feed this to filldir.
1017 * If all goes well, we should then be able to find our way round the
1018 * cache on the next call to readdir_search_pagecache();
1019 *
1020 * NOTE: we cannot add the anonymous page to the pagecache because
1021 * the data it contains might not be page aligned. Besides,
1022 * we should already have a complete representation of the
1023 * directory in the page cache by the time we get here.
1024 */
Trond Myklebust6c981ef2020-11-03 07:42:04 -05001025static int uncached_readdir(struct nfs_readdir_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026{
Trond Myklebust35df59d2020-11-06 20:38:47 -05001027 struct page **arrays;
1028 size_t i, sz = 512;
Trond Myklebustb593c092020-11-02 20:06:12 -05001029 __be32 verf[NFS_DIR_VERIFIER_SIZE];
Trond Myklebust35df59d2020-11-06 20:38:47 -05001030 int status = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Trond Myklebust35df59d2020-11-06 20:38:47 -05001032 dfprintk(DIRCACHE, "NFS: uncached_readdir() searching for cookie %llu\n",
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001033 (unsigned long long)desc->dir_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
Trond Myklebust35df59d2020-11-06 20:38:47 -05001035 arrays = kcalloc(sz, sizeof(*arrays), GFP_KERNEL);
1036 if (!arrays)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 goto out;
Trond Myklebust35df59d2020-11-06 20:38:47 -05001038 arrays[0] = nfs_readdir_page_array_alloc(desc->dir_cookie, GFP_KERNEL);
1039 if (!arrays[0])
1040 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -05001042 desc->page_index = 0;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001043 desc->last_cookie = desc->dir_cookie;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001044 desc->duped = 0;
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -05001045
Trond Myklebust35df59d2020-11-06 20:38:47 -05001046 status = nfs_readdir_xdr_to_array(desc, desc->verf, verf, arrays, sz);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -04001047
Trond Myklebust35df59d2020-11-06 20:38:47 -05001048 for (i = 0; !desc->eof && i < sz && arrays[i]; i++) {
1049 desc->page = arrays[i];
Trond Myklebust13884ff2021-03-16 07:57:40 -04001050 nfs_do_filldir(desc, verf);
Trond Myklebust35df59d2020-11-06 20:38:47 -05001051 }
1052 desc->page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053
Trond Myklebust35df59d2020-11-06 20:38:47 -05001054
1055 for (i = 0; i < sz && arrays[i]; i++)
1056 nfs_readdir_page_array_free(arrays[i]);
1057out:
1058 kfree(arrays);
1059 dfprintk(DIRCACHE, "NFS: %s: returns %d\n", __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061}
1062
Olivier Galibert00a92642005-06-22 17:16:29 +00001063/* The file offset position represents the dirent entry number. A
1064 last cookie cache takes care of the common case of reading the
1065 whole directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Al Viro23db8622013-05-17 16:34:50 -04001067static int nfs_readdir(struct file *file, struct dir_context *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
Miklos Szeredibe62a1a2016-03-26 16:14:39 -04001069 struct dentry *dentry = file_dentry(file);
David Howells2b0143b2015-03-17 22:25:59 +00001070 struct inode *inode = d_inode(dentry);
Trond Myklebust13884ff2021-03-16 07:57:40 -04001071 struct nfs_inode *nfsi = NFS_I(inode);
Al Viro23db8622013-05-17 16:34:50 -04001072 struct nfs_open_dir_context *dir_ctx = file->private_data;
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001073 struct nfs_readdir_descriptor *desc;
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001074 pgoff_t page_index;
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001075 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
Al Viro6de14722013-09-16 10:53:17 -04001077 dfprintk(FILE, "NFS: readdir(%pD2) starting at cookie %llu\n",
1078 file, (long long)ctx->pos);
Chuck Lever91d5b472006-03-20 13:44:14 -05001079 nfs_inc_stats(inode, NFSIOS_VFSGETDENTS);
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 /*
Al Viro23db8622013-05-17 16:34:50 -04001082 * ctx->pos points to the dirent entry number.
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001083 * *desc->dir_cookie has the cookie for the next entry. We have
Olivier Galibert00a92642005-06-22 17:16:29 +00001084 * to either find the entry with the appropriate number or
1085 * revalidate the cookie.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 */
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001087 if (ctx->pos == 0 || nfs_attribute_cache_expired(inode)) {
Scott Mayhew07b5ce82013-07-05 17:49:31 -04001088 res = nfs_revalidate_mapping(inode, file->f_mapping);
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001089 if (res < 0)
1090 goto out;
1091 }
1092
1093 res = -ENOMEM;
1094 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
1095 if (!desc)
Trond Myklebustfccca7f2008-01-26 17:37:47 -05001096 goto out;
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001097 desc->file = file;
1098 desc->ctx = ctx;
1099 desc->plus = nfs_use_readdirplus(inode, ctx);
Trond Myklebustfccca7f2008-01-26 17:37:47 -05001100
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001101 spin_lock(&file->f_lock);
1102 desc->dir_cookie = dir_ctx->dir_cookie;
1103 desc->dup_cookie = dir_ctx->dup_cookie;
1104 desc->duped = dir_ctx->duped;
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001105 page_index = dir_ctx->page_index;
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001106 desc->attr_gencount = dir_ctx->attr_gencount;
Trond Myklebustb593c092020-11-02 20:06:12 -05001107 memcpy(desc->verf, dir_ctx->verf, sizeof(desc->verf));
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001108 spin_unlock(&file->f_lock);
Trond Myklebust565277f2007-10-15 18:17:53 -04001109
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001110 if (test_and_clear_bit(NFS_INO_FORCE_READDIR, &nfsi->flags) &&
1111 list_is_singular(&nfsi->open_files))
1112 invalidate_mapping_pages(inode->i_mapping, page_index + 1, -1);
1113
Trond Myklebust47c716c2010-12-07 12:44:56 -05001114 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 res = readdir_search_pagecache(desc);
Olivier Galibert00a92642005-06-22 17:16:29 +00001116
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 if (res == -EBADCOOKIE) {
Trond Myklebustece0b422010-11-20 13:55:33 -05001118 res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 /* This means either end of directory */
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001120 if (desc->dir_cookie && !desc->eof) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 /* Or that the server has 'lost' a cookie */
Al Viro23db8622013-05-17 16:34:50 -04001122 res = uncached_readdir(desc);
Trond Myklebustece0b422010-11-20 13:55:33 -05001123 if (res == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 continue;
Trond Myklebust9fff59e2020-11-02 20:11:32 -05001125 if (res == -EBADCOOKIE || res == -ENOTSYNC)
1126 res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 break;
1129 }
1130 if (res == -ETOOSMALL && desc->plus) {
Trond Myklebust13884ff2021-03-16 07:57:40 -04001131 clear_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 nfs_zap_caches(inode);
Trond Myklebustbaf57a02010-09-24 18:49:43 -04001133 desc->page_index = 0;
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -04001134 desc->plus = false;
1135 desc->eof = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 continue;
1137 }
1138 if (res < 0)
1139 break;
1140
Trond Myklebust13884ff2021-03-16 07:57:40 -04001141 nfs_do_filldir(desc, nfsi->cookieverf);
Trond Myklebust1f1d4aa42020-11-01 12:34:43 -05001142 nfs_readdir_page_unlock_and_put_cached(desc);
Trond Myklebust47c716c2010-12-07 12:44:56 -05001143 } while (!desc->eof);
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001144
1145 spin_lock(&file->f_lock);
1146 dir_ctx->dir_cookie = desc->dir_cookie;
1147 dir_ctx->dup_cookie = desc->dup_cookie;
1148 dir_ctx->duped = desc->duped;
1149 dir_ctx->attr_gencount = desc->attr_gencount;
Trond Myklebustff81dfb2021-09-28 14:33:44 -04001150 dir_ctx->page_index = desc->page_index;
Trond Myklebustb593c092020-11-02 20:06:12 -05001151 memcpy(dir_ctx->verf, desc->verf, sizeof(dir_ctx->verf));
Trond Myklebust2e7a4642020-11-01 09:56:18 -05001152 spin_unlock(&file->f_lock);
1153
Trond Myklebust6b75cf92020-11-02 08:55:03 -05001154 kfree(desc);
1155
Trond Myklebustfccca7f2008-01-26 17:37:47 -05001156out:
Al Viro6de14722013-09-16 10:53:17 -04001157 dfprintk(FILE, "NFS: readdir(%pD2) returns %d\n", file, res);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001158 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159}
1160
Andrew Morton965c8e52012-12-17 15:59:39 -08001161static loff_t nfs_llseek_dir(struct file *filp, loff_t offset, int whence)
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001162{
Bryan Schumaker480c2002011-03-23 14:48:29 -04001163 struct nfs_open_dir_context *dir_ctx = filp->private_data;
Chuck Leverb84e06c2008-06-11 17:55:34 -04001164
Al Viro6de14722013-09-16 10:53:17 -04001165 dfprintk(FILE, "NFS: llseek dir(%pD2, %lld, %d)\n",
1166 filp, offset, whence);
Chuck Leverb84e06c2008-06-11 17:55:34 -04001167
Andrew Morton965c8e52012-12-17 15:59:39 -08001168 switch (whence) {
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001169 default:
1170 return -EINVAL;
1171 case SEEK_SET:
1172 if (offset < 0)
1173 return -EINVAL;
Trond Myklebust83f2c452020-10-30 17:57:29 -04001174 spin_lock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001175 break;
1176 case SEEK_CUR:
1177 if (offset == 0)
1178 return filp->f_pos;
Trond Myklebust83f2c452020-10-30 17:57:29 -04001179 spin_lock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001180 offset += filp->f_pos;
1181 if (offset < 0) {
Trond Myklebust83f2c452020-10-30 17:57:29 -04001182 spin_unlock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -04001183 return -EINVAL;
1184 }
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001185 }
1186 if (offset != filp->f_pos) {
1187 filp->f_pos = offset;
Trond Myklebust59e356a2020-02-03 14:49:33 -05001188 if (nfs_readdir_use_cookie(filp))
1189 dir_ctx->dir_cookie = offset;
1190 else
1191 dir_ctx->dir_cookie = 0;
Trond Myklebustb593c092020-11-02 20:06:12 -05001192 if (offset == 0)
1193 memset(dir_ctx->verf, 0, sizeof(dir_ctx->verf));
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -04001194 dir_ctx->duped = 0;
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001195 }
Trond Myklebust83f2c452020-10-30 17:57:29 -04001196 spin_unlock(&filp->f_lock);
Trond Myklebustf0dd2132005-06-22 17:16:29 +00001197 return offset;
1198}
1199
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200/*
1201 * All directory operations under NFS are synchronous, so fsync()
1202 * is a dummy operation.
1203 */
Josef Bacik02c24a82011-07-16 20:44:56 -04001204static int nfs_fsync_dir(struct file *filp, loff_t start, loff_t end,
1205 int datasync)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206{
Al Viro6de14722013-09-16 10:53:17 -04001207 dfprintk(FILE, "NFS: fsync dir(%pD2) datasync %d\n", filp, datasync);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001208
Trond Myklebust11decaf2020-10-30 17:57:30 -04001209 nfs_inc_stats(file_inode(filp), NFSIOS_VFSFSYNC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 return 0;
1211}
1212
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001213/**
1214 * nfs_force_lookup_revalidate - Mark the directory as having changed
Trond Myklebust302fad72019-02-18 13:32:38 -05001215 * @dir: pointer to directory inode
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001216 *
1217 * This forces the revalidation code in nfs_lookup_revalidate() to do a
1218 * full lookup on all child dentries of 'dir' whenever a change occurs
1219 * on the server that might have invalidated our dcache.
1220 *
Trond Myklebustefeda802020-02-05 09:01:54 -05001221 * Note that we reserve bit '0' as a tag to let us know when a dentry
1222 * was revalidated while holding a delegation on its inode.
1223 *
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001224 * The caller should be holding dir->i_lock
1225 */
1226void nfs_force_lookup_revalidate(struct inode *dir)
1227{
Trond Myklebustefeda802020-02-05 09:01:54 -05001228 NFS_I(dir)->cache_change_attribute += 2;
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001229}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001230EXPORT_SYMBOL_GPL(nfs_force_lookup_revalidate);
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001231
Trond Myklebustefeda802020-02-05 09:01:54 -05001232/**
1233 * nfs_verify_change_attribute - Detects NFS remote directory changes
1234 * @dir: pointer to parent directory inode
1235 * @verf: previously saved change attribute
1236 *
1237 * Return "false" if the verifiers doesn't match the change attribute.
1238 * This would usually indicate that the directory contents have changed on
1239 * the server, and that any dentries need revalidating.
1240 */
1241static bool nfs_verify_change_attribute(struct inode *dir, unsigned long verf)
1242{
1243 return (verf & ~1UL) == nfs_save_change_attribute(dir);
1244}
1245
1246static void nfs_set_verifier_delegated(unsigned long *verf)
1247{
1248 *verf |= 1UL;
1249}
1250
1251#if IS_ENABLED(CONFIG_NFS_V4)
1252static void nfs_unset_verifier_delegated(unsigned long *verf)
1253{
1254 *verf &= ~1UL;
1255}
1256#endif /* IS_ENABLED(CONFIG_NFS_V4) */
1257
1258static bool nfs_test_verifier_delegated(unsigned long verf)
1259{
1260 return verf & 1;
1261}
1262
1263static bool nfs_verifier_is_delegated(struct dentry *dentry)
1264{
1265 return nfs_test_verifier_delegated(dentry->d_time);
1266}
1267
1268static void nfs_set_verifier_locked(struct dentry *dentry, unsigned long verf)
1269{
1270 struct inode *inode = d_inode(dentry);
Trond Myklebustcec08f42021-09-29 08:12:53 -04001271 struct inode *dir = d_inode(dentry->d_parent);
Trond Myklebustefeda802020-02-05 09:01:54 -05001272
Trond Myklebustcec08f42021-09-29 08:12:53 -04001273 if (!nfs_verify_change_attribute(dir, verf))
1274 return;
Trond Myklebustefeda802020-02-05 09:01:54 -05001275 if (inode && NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
1276 nfs_set_verifier_delegated(&verf);
Trond Myklebustefeda802020-02-05 09:01:54 -05001277 dentry->d_time = verf;
1278}
1279
1280/**
1281 * nfs_set_verifier - save a parent directory verifier in the dentry
1282 * @dentry: pointer to dentry
1283 * @verf: verifier to save
1284 *
1285 * Saves the parent directory verifier in @dentry. If the inode has
1286 * a delegation, we also tag the dentry as having been revalidated
1287 * while holding a delegation so that we know we don't have to
1288 * look it up again after a directory change.
1289 */
1290void nfs_set_verifier(struct dentry *dentry, unsigned long verf)
1291{
1292
1293 spin_lock(&dentry->d_lock);
1294 nfs_set_verifier_locked(dentry, verf);
1295 spin_unlock(&dentry->d_lock);
1296}
1297EXPORT_SYMBOL_GPL(nfs_set_verifier);
1298
1299#if IS_ENABLED(CONFIG_NFS_V4)
1300/**
1301 * nfs_clear_verifier_delegated - clear the dir verifier delegation tag
1302 * @inode: pointer to inode
1303 *
1304 * Iterates through the dentries in the inode alias list and clears
1305 * the tag used to indicate that the dentry has been revalidated
1306 * while holding a delegation.
1307 * This function is intended for use when the delegation is being
1308 * returned or revoked.
1309 */
1310void nfs_clear_verifier_delegated(struct inode *inode)
1311{
1312 struct dentry *alias;
1313
1314 if (!inode)
1315 return;
1316 spin_lock(&inode->i_lock);
1317 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
1318 spin_lock(&alias->d_lock);
1319 nfs_unset_verifier_delegated(&alias->d_time);
1320 spin_unlock(&alias->d_lock);
1321 }
1322 spin_unlock(&inode->i_lock);
1323}
1324EXPORT_SYMBOL_GPL(nfs_clear_verifier_delegated);
1325#endif /* IS_ENABLED(CONFIG_NFS_V4) */
1326
Trond Myklebust8ce37ab2021-12-17 15:36:56 -05001327static int nfs_dentry_verify_change(struct inode *dir, struct dentry *dentry)
1328{
1329 if (nfs_server_capable(dir, NFS_CAP_CASE_INSENSITIVE) &&
1330 d_really_is_negative(dentry))
1331 return dentry->d_time == inode_peek_iversion_raw(dir);
1332 return nfs_verify_change_attribute(dir, dentry->d_time);
1333}
1334
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335/*
1336 * A check for whether or not the parent directory has changed.
1337 * In the case it has, we assume that the dentries are untrustworthy
1338 * and may need to be looked up again.
NeilBrown912a1082014-07-14 11:28:20 +10001339 * If rcu_walk prevents us from performing a full check, return 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 */
NeilBrown912a1082014-07-14 11:28:20 +10001341static int nfs_check_verifier(struct inode *dir, struct dentry *dentry,
1342 int rcu_walk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343{
1344 if (IS_ROOT(dentry))
1345 return 1;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001346 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONE)
1347 return 0;
Trond Myklebust8ce37ab2021-12-17 15:36:56 -05001348 if (!nfs_dentry_verify_change(dir, dentry))
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001349 return 0;
1350 /* Revalidate nfsi->cache_change_attribute before we declare a match */
Trond Myklebust1cd9cb02016-12-04 18:34:34 -05001351 if (nfs_mapping_need_revalidate_inode(dir)) {
1352 if (rcu_walk)
1353 return 0;
1354 if (__nfs_revalidate_inode(NFS_SERVER(dir), dir) < 0)
1355 return 0;
1356 }
Trond Myklebust8ce37ab2021-12-17 15:36:56 -05001357 if (!nfs_dentry_verify_change(dir, dentry))
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001358 return 0;
1359 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360}
1361
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362/*
Trond Myklebusta12802c2007-10-02 19:13:04 -04001363 * Use intent information to check whether or not we're going to do
1364 * an O_EXCL create using this path component.
1365 */
Al Virofa3c56b2012-06-10 15:36:40 -04001366static int nfs_is_exclusive_create(struct inode *dir, unsigned int flags)
Trond Myklebusta12802c2007-10-02 19:13:04 -04001367{
1368 if (NFS_PROTO(dir)->version == 2)
1369 return 0;
Al Virofa3c56b2012-06-10 15:36:40 -04001370 return flags & LOOKUP_EXCL;
Trond Myklebusta12802c2007-10-02 19:13:04 -04001371}
1372
1373/*
Trond Myklebust1d6757f2005-06-07 18:37:01 -04001374 * Inode and filehandle revalidation for lookups.
1375 *
1376 * We force revalidation in the cases where the VFS sets LOOKUP_REVAL,
1377 * or if the intent information indicates that we're about to open this
1378 * particular file and the "nocto" mount flag is not set.
1379 *
1380 */
Trond Myklebust65a0c142012-12-14 17:51:40 -05001381static
Al Virofa3c56b2012-06-10 15:36:40 -04001382int nfs_lookup_verify_inode(struct inode *inode, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383{
1384 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust65a0c142012-12-14 17:51:40 -05001385 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
David Howells36d43a42011-01-14 18:45:42 +00001387 if (IS_AUTOMOUNT(inode))
Trond Myklebust4e99a1f2008-03-06 12:34:59 -05001388 return 0;
Trond Myklebust47921922018-05-10 10:08:36 -04001389
1390 if (flags & LOOKUP_OPEN) {
1391 switch (inode->i_mode & S_IFMT) {
1392 case S_IFREG:
1393 /* A NFSv4 OPEN will revalidate later */
1394 if (server->caps & NFS_CAP_ATOMIC_OPEN)
1395 goto out;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001396 fallthrough;
Trond Myklebust47921922018-05-10 10:08:36 -04001397 case S_IFDIR:
1398 if (server->flags & NFS_MOUNT_NOCTO)
1399 break;
1400 /* NFS close-to-open cache consistency validation */
1401 goto out_force;
1402 }
1403 }
1404
Al Virofacc3532012-06-10 15:33:51 -04001405 /* VFS wants an on-the-wire revalidation */
Al Virofa3c56b2012-06-10 15:36:40 -04001406 if (flags & LOOKUP_REVAL)
Al Virofacc3532012-06-10 15:33:51 -04001407 goto out_force;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001408out:
Lance Sheltona61246c2018-07-16 13:05:36 -04001409 return (inode->i_nlink == 0) ? -ESTALE : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410out_force:
NeilBrown1fa1e382014-07-14 11:28:20 +10001411 if (flags & LOOKUP_RCU)
1412 return -ECHILD;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001413 ret = __nfs_revalidate_inode(server, inode);
1414 if (ret != 0)
1415 return ret;
1416 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
1418
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001419static void nfs_mark_dir_for_revalidate(struct inode *inode)
1420{
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001421 spin_lock(&inode->i_lock);
Trond Myklebusta6a361c2021-09-28 11:24:57 -04001422 nfs_set_cache_invalid(inode, NFS_INO_INVALID_CHANGE);
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001423 spin_unlock(&inode->i_lock);
1424}
1425
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426/*
1427 * We judge how long we want to trust negative
1428 * dentries by looking at the parent inode mtime.
1429 *
1430 * If parent mtime has changed, we revalidate, else we wait for a
1431 * period corresponding to the parent's attribute cache timeout value.
NeilBrown912a1082014-07-14 11:28:20 +10001432 *
1433 * If LOOKUP_RCU prevents us from performing a full check, return 1
1434 * suggesting a reval is needed.
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001435 *
1436 * Note that when creating a new file, or looking up a rename target,
1437 * then it shouldn't be necessary to revalidate a negative dentry.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 */
1439static inline
1440int nfs_neg_need_reval(struct inode *dir, struct dentry *dentry,
Al Virofa3c56b2012-06-10 15:36:40 -04001441 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442{
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001443 if (flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 return 0;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001445 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONEG)
1446 return 1;
Trond Myklebust98ca3ee2021-12-17 15:36:55 -05001447 /* Case insensitive server? Revalidate negative dentries */
1448 if (nfs_server_capable(dir, NFS_CAP_CASE_INSENSITIVE))
1449 return 1;
NeilBrown912a1082014-07-14 11:28:20 +10001450 return !nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451}
1452
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001453static int
1454nfs_lookup_revalidate_done(struct inode *dir, struct dentry *dentry,
1455 struct inode *inode, int error)
1456{
1457 switch (error) {
1458 case 1:
1459 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is valid\n",
1460 __func__, dentry);
1461 return 1;
1462 case 0:
Trond Myklebust47397912021-03-08 14:42:52 -05001463 /*
1464 * We can't d_drop the root of a disconnected tree:
1465 * its d_hash is on the s_anon list and d_drop() would hide
1466 * it from shrink_dcache_for_unmount(), leading to busy
1467 * inodes on unmount and further oopses.
1468 */
1469 if (inode && IS_ROOT(dentry))
1470 return 1;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001471 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is invalid\n",
1472 __func__, dentry);
1473 return 0;
1474 }
1475 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) lookup returned error %d\n",
1476 __func__, dentry, error);
1477 return error;
1478}
1479
1480static int
1481nfs_lookup_revalidate_negative(struct inode *dir, struct dentry *dentry,
1482 unsigned int flags)
1483{
1484 int ret = 1;
1485 if (nfs_neg_need_reval(dir, dentry, flags)) {
1486 if (flags & LOOKUP_RCU)
1487 return -ECHILD;
1488 ret = 0;
1489 }
1490 return nfs_lookup_revalidate_done(dir, dentry, NULL, ret);
1491}
1492
1493static int
1494nfs_lookup_revalidate_delegated(struct inode *dir, struct dentry *dentry,
1495 struct inode *inode)
1496{
1497 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1498 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1499}
1500
1501static int
1502nfs_lookup_revalidate_dentry(struct inode *dir, struct dentry *dentry,
1503 struct inode *inode)
1504{
1505 struct nfs_fh *fhandle;
1506 struct nfs_fattr *fattr;
Trond Myklebusta1147b82020-02-05 09:01:52 -05001507 unsigned long dir_verifier;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001508 int ret;
1509
1510 ret = -ENOMEM;
1511 fhandle = nfs_alloc_fhandle();
Anna Schumaker9558a002021-10-22 13:11:04 -04001512 fattr = nfs_alloc_fattr_with_label(NFS_SERVER(inode));
1513 if (fhandle == NULL || fattr == NULL)
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001514 goto out;
1515
Trond Myklebusta1147b82020-02-05 09:01:52 -05001516 dir_verifier = nfs_save_change_attribute(dir);
Anna Schumaker9558a002021-10-22 13:11:04 -04001517 ret = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001518 if (ret < 0) {
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001519 switch (ret) {
1520 case -ESTALE:
1521 case -ENOENT:
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001522 ret = 0;
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001523 break;
1524 case -ETIMEDOUT:
1525 if (NFS_SERVER(inode)->flags & NFS_MOUNT_SOFTREVAL)
1526 ret = 1;
1527 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001528 goto out;
1529 }
1530 ret = 0;
1531 if (nfs_compare_fh(NFS_FH(inode), fhandle))
1532 goto out;
1533 if (nfs_refresh_inode(inode, fattr) < 0)
1534 goto out;
1535
Anna Schumakerdd225cb2021-10-22 13:11:12 -04001536 nfs_setsecurity(inode, fattr);
Trond Myklebusta1147b82020-02-05 09:01:52 -05001537 nfs_set_verifier(dentry, dir_verifier);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001538
1539 /* set a readdirplus hint that we had a cache miss */
1540 nfs_force_use_readdirplus(dir);
1541 ret = 1;
1542out:
1543 nfs_free_fattr(fattr);
1544 nfs_free_fhandle(fhandle);
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001545
1546 /*
1547 * If the lookup failed despite the dentry change attribute being
1548 * a match, then we should revalidate the directory cache.
1549 */
Trond Myklebust8ce37ab2021-12-17 15:36:56 -05001550 if (!ret && nfs_dentry_verify_change(dir, dentry))
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001551 nfs_mark_dir_for_revalidate(dir);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001552 return nfs_lookup_revalidate_done(dir, dentry, inode, ret);
1553}
1554
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555/*
1556 * This is called every time the dcache has a lookup hit,
1557 * and we should check whether we can really trust that
1558 * lookup.
1559 *
1560 * NOTE! The hit can be a negative hit too, don't assume
1561 * we have an inode!
1562 *
1563 * If the parent directory is seen to have changed, we throw out the
1564 * cached dentry and do a new lookup.
1565 */
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001566static int
1567nfs_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1568 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Chuck Lever91d5b472006-03-20 13:44:14 -05001573 nfs_inc_stats(dir, NFSIOS_DENTRYREVALIDATE);
David Howells2b0143b2015-03-17 22:25:59 +00001574 inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001576 if (!inode)
1577 return nfs_lookup_revalidate_negative(dir, dentry, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
1579 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001580 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1581 __func__, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 goto out_bad;
1583 }
1584
Trond Myklebustefeda802020-02-05 09:01:54 -05001585 if (nfs_verifier_is_delegated(dentry))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001586 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust15860ab2008-12-23 15:21:54 -05001587
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 /* Force a full look up iff the parent directory has changed */
Trond Myklebust73dd6842018-05-10 10:13:09 -04001589 if (!(flags & (LOOKUP_EXCL | LOOKUP_REVAL)) &&
NeilBrown912a1082014-07-14 11:28:20 +10001590 nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU)) {
NeilBrowncc896842017-07-05 12:22:20 +10001591 error = nfs_lookup_verify_inode(inode, flags);
1592 if (error) {
NeilBrowncc896842017-07-05 12:22:20 +10001593 if (error == -ESTALE)
Trond Myklebust82e7ca12021-03-08 14:42:51 -05001594 nfs_mark_dir_for_revalidate(dir);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001595 goto out_bad;
NeilBrown1fa1e382014-07-14 11:28:20 +10001596 }
Trond Myklebust63519fb2016-11-19 11:21:54 -05001597 nfs_advise_use_readdirplus(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 goto out_valid;
1599 }
1600
NeilBrown912a1082014-07-14 11:28:20 +10001601 if (flags & LOOKUP_RCU)
1602 return -ECHILD;
1603
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 if (NFS_STALE(inode))
1605 goto out_bad;
1606
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001607 trace_nfs_lookup_revalidate_enter(dir, dentry, flags);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001608 error = nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001609 trace_nfs_lookup_revalidate_exit(dir, dentry, flags, error);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001610 return error;
1611out_valid:
1612 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1613out_bad:
1614 if (flags & LOOKUP_RCU)
1615 return -ECHILD;
1616 return nfs_lookup_revalidate_done(dir, dentry, inode, 0);
1617}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001619static int
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001620__nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags,
1621 int (*reval)(struct inode *, struct dentry *, unsigned int))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001622{
1623 struct dentry *parent;
1624 struct inode *dir;
1625 int ret;
David Quigleyaa9c2662013-05-22 12:50:44 -04001626
NeilBrownd51ac1a2014-07-14 11:28:20 +10001627 if (flags & LOOKUP_RCU) {
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001628 parent = READ_ONCE(dentry->d_parent);
1629 dir = d_inode_rcu(parent);
1630 if (!dir)
1631 return -ECHILD;
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001632 ret = reval(dir, dentry, flags);
Mark Rutland6aa7de02017-10-23 14:07:29 -07001633 if (parent != READ_ONCE(dentry->d_parent))
NeilBrownd51ac1a2014-07-14 11:28:20 +10001634 return -ECHILD;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001635 } else {
1636 parent = dget_parent(dentry);
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001637 ret = reval(d_inode(parent), dentry, flags);
NeilBrownd51ac1a2014-07-14 11:28:20 +10001638 dput(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001640 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641}
1642
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001643static int nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1644{
1645 return __nfs_lookup_revalidate(dentry, flags, nfs_do_lookup_revalidate);
1646}
1647
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648/*
David Howells2b0143b2015-03-17 22:25:59 +00001649 * A weaker form of d_revalidate for revalidating just the d_inode(dentry)
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001650 * when we don't really care about the dentry name. This is called when a
1651 * pathwalk ends on a dentry that was not found via a normal lookup in the
1652 * parent dir (e.g.: ".", "..", procfs symlinks or mountpoint traversals).
1653 *
1654 * In this situation, we just want to verify that the inode itself is OK
1655 * since the dentry might have changed on the server.
1656 */
1657static int nfs_weak_revalidate(struct dentry *dentry, unsigned int flags)
1658{
David Howells2b0143b2015-03-17 22:25:59 +00001659 struct inode *inode = d_inode(dentry);
Trond Myklebust9cdd1d32016-12-16 18:04:47 -05001660 int error = 0;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001661
1662 /*
1663 * I believe we can only get a negative dentry here in the case of a
1664 * procfs-style symlink. Just assume it's correct for now, but we may
1665 * eventually need to do something more here.
1666 */
1667 if (!inode) {
Al Viro6de14722013-09-16 10:53:17 -04001668 dfprintk(LOOKUPCACHE, "%s: %pd2 has negative inode\n",
1669 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001670 return 1;
1671 }
1672
1673 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001674 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1675 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001676 return 0;
1677 }
1678
NeilBrownb6887412017-08-25 17:34:41 +10001679 error = nfs_lookup_verify_inode(inode, flags);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001680 dfprintk(LOOKUPCACHE, "NFS: %s: inode %lu is %s\n",
1681 __func__, inode->i_ino, error ? "invalid" : "valid");
1682 return !error;
1683}
1684
1685/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 * This is called from dput() when d_count is going to 0.
1687 */
Nick Pigginfe15ce42011-01-07 17:49:23 +11001688static int nfs_dentry_delete(const struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689{
Al Viro6de14722013-09-16 10:53:17 -04001690 dfprintk(VFS, "NFS: dentry_delete(%pd2, %x)\n",
1691 dentry, dentry->d_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Trond Myklebust77f11192008-01-28 19:43:19 -05001693 /* Unhash any dentry with a stale inode */
David Howells2b0143b2015-03-17 22:25:59 +00001694 if (d_really_is_positive(dentry) && NFS_STALE(d_inode(dentry)))
Trond Myklebust77f11192008-01-28 19:43:19 -05001695 return 1;
1696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1698 /* Unhash it, so that ->d_iput() would be called */
1699 return 1;
1700 }
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001701 if (!(dentry->d_sb->s_flags & SB_ACTIVE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 /* Unhash it, so that ancestors of killed async unlink
1703 * files will be cleaned up during umount */
1704 return 1;
1705 }
1706 return 0;
1707
1708}
1709
Trond Myklebust1f018452012-12-14 16:38:46 -05001710/* Ensure that we revalidate inode->i_nlink */
Trond Myklebust1b83d702008-06-11 15:44:04 -04001711static void nfs_drop_nlink(struct inode *inode)
1712{
1713 spin_lock(&inode->i_lock);
Trond Myklebust1f018452012-12-14 16:38:46 -05001714 /* drop the inode if we're reasonably sure this is the last link */
Trond Myklebust59a707b2018-04-08 18:11:18 -04001715 if (inode->i_nlink > 0)
1716 drop_nlink(inode);
1717 NFS_I(inode)->attr_gencount = nfs_inc_attr_generation_counter();
Trond Myklebustac46b3d2021-03-08 14:42:54 -05001718 nfs_set_cache_invalid(
1719 inode, NFS_INO_INVALID_CHANGE | NFS_INO_INVALID_CTIME |
Trond Myklebust1301e422021-04-01 14:57:56 -04001720 NFS_INO_INVALID_NLINK);
Trond Myklebust1b83d702008-06-11 15:44:04 -04001721 spin_unlock(&inode->i_lock);
1722}
1723
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724/*
1725 * Called when the dentry loses inode.
1726 * We use it to clean up silly-renamed files.
1727 */
1728static void nfs_dentry_iput(struct dentry *dentry, struct inode *inode)
1729{
1730 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
Trond Myklebuste4eff1a2007-07-14 15:39:58 -04001731 nfs_complete_unlink(dentry, inode);
Trond Myklebust1f018452012-12-14 16:38:46 -05001732 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 iput(inode);
1735}
1736
Al Virob1942c52011-03-16 05:44:14 -04001737static void nfs_d_release(struct dentry *dentry)
1738{
1739 /* free cached devname value, if it survived that far */
1740 if (unlikely(dentry->d_fsdata)) {
1741 if (dentry->d_flags & DCACHE_NFSFS_RENAMED)
1742 WARN_ON(1);
1743 else
1744 kfree(dentry->d_fsdata);
1745 }
1746}
1747
Al Virof786aa92009-02-20 05:51:22 +00001748const struct dentry_operations nfs_dentry_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 .d_revalidate = nfs_lookup_revalidate,
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001750 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 .d_delete = nfs_dentry_delete,
1752 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001753 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001754 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755};
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001756EXPORT_SYMBOL_GPL(nfs_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757
Bryan Schumaker597d9282012-07-16 16:39:10 -04001758struct dentry *nfs_lookup(struct inode *dir, struct dentry * dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759{
1760 struct dentry *res;
1761 struct inode *inode = NULL;
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001762 struct nfs_fh *fhandle = NULL;
1763 struct nfs_fattr *fattr = NULL;
Trond Myklebusta1147b82020-02-05 09:01:52 -05001764 unsigned long dir_verifier;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
Al Viro6de14722013-09-16 10:53:17 -04001767 dfprintk(VFS, "NFS: lookup(%pd2)\n", dentry);
Chuck Lever91d5b472006-03-20 13:44:14 -05001768 nfs_inc_stats(dir, NFSIOS_VFSLOOKUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Al Viro130f9ab2016-03-07 22:40:43 -05001770 if (unlikely(dentry->d_name.len > NFS_SERVER(dir)->namelen))
1771 return ERR_PTR(-ENAMETOOLONG);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Trond Myklebustfd684072006-09-05 12:27:44 -04001773 /*
1774 * If we're doing an exclusive create, optimize away the lookup
1775 * but don't hash the dentry.
1776 */
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001777 if (nfs_is_exclusive_create(dir, flags) || flags & LOOKUP_RENAME_TARGET)
Al Viro130f9ab2016-03-07 22:40:43 -05001778 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001780 res = ERR_PTR(-ENOMEM);
1781 fhandle = nfs_alloc_fhandle();
Anna Schumaker9558a002021-10-22 13:11:04 -04001782 fattr = nfs_alloc_fattr_with_label(NFS_SERVER(dir));
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001783 if (fhandle == NULL || fattr == NULL)
1784 goto out;
1785
Trond Myklebusta1147b82020-02-05 09:01:52 -05001786 dir_verifier = nfs_save_change_attribute(dir);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001787 trace_nfs_lookup_enter(dir, dentry, flags);
Anna Schumaker9558a002021-10-22 13:11:04 -04001788 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr);
Trond Myklebust8ce37ab2021-12-17 15:36:56 -05001789 if (error == -ENOENT) {
1790 if (nfs_server_capable(dir, NFS_CAP_CASE_INSENSITIVE))
1791 dir_verifier = inode_peek_iversion_raw(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 goto no_entry;
Trond Myklebust8ce37ab2021-12-17 15:36:56 -05001793 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 if (error < 0) {
1795 res = ERR_PTR(error);
Anna Schumaker9558a002021-10-22 13:11:04 -04001796 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 }
Anna Schumakercf7ab002021-10-22 13:11:11 -04001798 inode = nfs_fhget(dentry->d_sb, fhandle, fattr);
Namhyung Kimbf0c84f2010-12-28 17:02:46 +00001799 res = ERR_CAST(inode);
Trond Myklebust03f28e32006-03-20 13:44:48 -05001800 if (IS_ERR(res))
Anna Schumaker9558a002021-10-22 13:11:04 -04001801 goto out;
David Howells54ceac42006-08-22 20:06:13 -04001802
Trond Myklebust63519fb2016-11-19 11:21:54 -05001803 /* Notify readdir to use READDIRPLUS */
1804 nfs_force_use_readdirplus(dir);
Trond Myklebustd69ee9b2012-05-01 17:37:59 -04001805
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806no_entry:
Al Viro41d28bc2014-10-12 22:24:21 -04001807 res = d_splice_alias(inode, dentry);
Trond Myklebust9eaef272006-10-21 10:24:20 -07001808 if (res != NULL) {
1809 if (IS_ERR(res))
Anna Schumaker9558a002021-10-22 13:11:04 -04001810 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 dentry = res;
Trond Myklebust9eaef272006-10-21 10:24:20 -07001812 }
Trond Myklebusta1147b82020-02-05 09:01:52 -05001813 nfs_set_verifier(dentry, dir_verifier);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814out:
Anna Schumaker9558a002021-10-22 13:11:04 -04001815 trace_nfs_lookup_exit(dir, dentry, flags, PTR_ERR_OR_ZERO(res));
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001816 nfs_free_fattr(fattr);
1817 nfs_free_fhandle(fhandle);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 return res;
1819}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001820EXPORT_SYMBOL_GPL(nfs_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
Trond Myklebust00bdadc2021-12-17 15:36:57 -05001822void nfs_d_prune_case_insensitive_aliases(struct inode *inode)
1823{
1824 /* Case insensitive server? Revalidate dentries */
1825 if (inode && nfs_server_capable(inode, NFS_CAP_CASE_INSENSITIVE))
1826 d_prune_aliases(inode);
1827}
1828EXPORT_SYMBOL_GPL(nfs_d_prune_case_insensitive_aliases);
1829
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001830#if IS_ENABLED(CONFIG_NFS_V4)
Al Viro0b728e12012-06-10 16:03:43 -04001831static int nfs4_lookup_revalidate(struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832
Al Virof786aa92009-02-20 05:51:22 +00001833const struct dentry_operations nfs4_dentry_operations = {
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02001834 .d_revalidate = nfs4_lookup_revalidate,
NeilBrownb6887412017-08-25 17:34:41 +10001835 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 .d_delete = nfs_dentry_delete,
1837 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001838 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001839 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840};
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001841EXPORT_SYMBOL_GPL(nfs4_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
Al Viro8a5e9292011-06-25 19:15:54 -04001843static fmode_t flags_to_mode(int flags)
1844{
1845 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
1846 if ((flags & O_ACCMODE) != O_WRONLY)
1847 res |= FMODE_READ;
1848 if ((flags & O_ACCMODE) != O_RDONLY)
1849 res |= FMODE_WRITE;
1850 return res;
1851}
1852
NeilBrown532d4de2016-10-13 15:26:47 +11001853static struct nfs_open_context *create_nfs_open_context(struct dentry *dentry, int open_flags, struct file *filp)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001854{
NeilBrown532d4de2016-10-13 15:26:47 +11001855 return alloc_nfs_open_context(dentry, flags_to_mode(open_flags), filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001856}
1857
1858static int do_open(struct inode *inode, struct file *filp)
1859{
David Howellsf1fe29b2013-09-27 11:20:03 +01001860 nfs_fscache_open_file(inode, filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001861 return 0;
1862}
1863
Al Virod9585272012-06-22 12:39:14 +04001864static int nfs_finish_open(struct nfs_open_context *ctx,
1865 struct dentry *dentry,
Al Virob452a452018-06-08 13:06:28 -04001866 struct file *file, unsigned open_flags)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001867{
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001868 int err;
1869
Al Virobe12af32018-06-08 11:44:56 -04001870 err = finish_open(file, dentry, do_open);
Al Viro30d90492012-06-22 12:40:19 +04001871 if (err)
Al Virod9585272012-06-22 12:39:14 +04001872 goto out;
NeilBrowneaa2b822017-07-03 15:27:26 +10001873 if (S_ISREG(file->f_path.dentry->d_inode->i_mode))
1874 nfs_file_set_open_context(file, ctx);
1875 else
Trond Myklebust98214212019-08-09 12:15:07 -04001876 err = -EOPENSTALE;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001877out:
Al Virod9585272012-06-22 12:39:14 +04001878 return err;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001879}
1880
Bryan Schumaker73a79702012-07-16 16:39:12 -04001881int nfs_atomic_open(struct inode *dir, struct dentry *dentry,
1882 struct file *file, unsigned open_flags,
Al Viro44907d72018-06-08 13:32:02 -04001883 umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884{
Al Viroc94c0952016-07-05 09:49:21 -04001885 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001886 struct nfs_open_context *ctx;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001887 struct dentry *res;
1888 struct iattr attr = { .ia_valid = ATTR_OPEN };
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001889 struct inode *inode;
Trond Myklebust1472b832013-08-20 11:59:41 -04001890 unsigned int lookup_flags = 0;
Trond Myklebust68eaba42021-12-17 15:36:58 -05001891 unsigned long dir_verifier;
Al Viroc94c0952016-07-05 09:49:21 -04001892 bool switched = false;
Al Viro73a09dd2018-06-08 13:22:02 -04001893 int created = 0;
Trond Myklebust898f6352010-10-23 11:24:25 -04001894 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001896 /* Expect a negative dentry */
David Howells2b0143b2015-03-17 22:25:59 +00001897 BUG_ON(d_inode(dentry));
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001898
Niels de Vos1e8968c2013-12-17 18:20:16 +01001899 dfprintk(VFS, "NFS: atomic_open(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001900 dir->i_sb->s_id, dir->i_ino, dentry);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001901
Jeff Layton9597c132013-08-02 11:39:32 -04001902 err = nfs_check_flags(open_flags);
1903 if (err)
1904 return err;
1905
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001906 /* NFS only supports OPEN on regular files */
1907 if ((open_flags & O_DIRECTORY)) {
Al Viro00699ad2016-07-05 09:44:53 -04001908 if (!d_in_lookup(dentry)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001909 /*
1910 * Hashed negative dentry with O_DIRECTORY: dentry was
1911 * revalidated and is fine, no need to perform lookup
1912 * again
1913 */
Al Virod9585272012-06-22 12:39:14 +04001914 return -ENOENT;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001915 }
Trond Myklebust1472b832013-08-20 11:59:41 -04001916 lookup_flags = LOOKUP_OPEN|LOOKUP_DIRECTORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 goto no_open;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001920 if (dentry->d_name.len > NFS_SERVER(dir)->namelen)
Al Virod9585272012-06-22 12:39:14 +04001921 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001923 if (open_flags & O_CREAT) {
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001924 struct nfs_server *server = NFS_SERVER(dir);
1925
1926 if (!(server->attr_bitmask[2] & FATTR4_WORD2_MODE_UMASK))
1927 mode &= ~current_umask();
1928
Trond Myklebust536e43d2012-01-17 22:04:26 -05001929 attr.ia_valid |= ATTR_MODE;
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001930 attr.ia_mode = mode;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001931 }
Trond Myklebust536e43d2012-01-17 22:04:26 -05001932 if (open_flags & O_TRUNC) {
1933 attr.ia_valid |= ATTR_SIZE;
1934 attr.ia_size = 0;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001935 }
1936
Al Viroc94c0952016-07-05 09:49:21 -04001937 if (!(open_flags & O_CREAT) && !d_in_lookup(dentry)) {
1938 d_drop(dentry);
1939 switched = true;
1940 dentry = d_alloc_parallel(dentry->d_parent,
1941 &dentry->d_name, &wq);
1942 if (IS_ERR(dentry))
1943 return PTR_ERR(dentry);
1944 if (unlikely(!d_in_lookup(dentry)))
1945 return finish_no_open(file, dentry);
1946 }
1947
NeilBrown532d4de2016-10-13 15:26:47 +11001948 ctx = create_nfs_open_context(dentry, open_flags, file);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001949 err = PTR_ERR(ctx);
1950 if (IS_ERR(ctx))
Al Virod9585272012-06-22 12:39:14 +04001951 goto out;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001952
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001953 trace_nfs_atomic_open_enter(dir, ctx, open_flags);
Al Viro73a09dd2018-06-08 13:22:02 -04001954 inode = NFS_PROTO(dir)->open_context(dir, ctx, open_flags, &attr, &created);
1955 if (created)
1956 file->f_mode |= FMODE_CREATED;
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001957 if (IS_ERR(inode)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001958 err = PTR_ERR(inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001959 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001960 put_nfs_open_context(ctx);
Al Virod20cb712016-06-20 13:14:36 -04001961 d_drop(dentry);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001962 switch (err) {
1963 case -ENOENT:
Peng Tao774d9512017-06-29 06:34:50 -07001964 d_splice_alias(NULL, dentry);
Trond Myklebust68eaba42021-12-17 15:36:58 -05001965 if (nfs_server_capable(dir, NFS_CAP_CASE_INSENSITIVE))
1966 dir_verifier = inode_peek_iversion_raw(dir);
1967 else
1968 dir_verifier = nfs_save_change_attribute(dir);
1969 nfs_set_verifier(dentry, dir_verifier);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001970 break;
1971 case -EISDIR:
1972 case -ENOTDIR:
1973 goto no_open;
1974 case -ELOOP:
1975 if (!(open_flags & O_NOFOLLOW))
Trond Myklebust6f926b52005-10-18 14:20:18 -07001976 goto no_open;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001977 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 /* case -EINVAL: */
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001979 default:
1980 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 }
Al Virod9585272012-06-22 12:39:14 +04001982 goto out;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001983 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001984
Al Virob452a452018-06-08 13:06:28 -04001985 err = nfs_finish_open(ctx, ctx->dentry, file, open_flags);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001986 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001987 put_nfs_open_context(ctx);
Al Virod9585272012-06-22 12:39:14 +04001988out:
Al Viroc94c0952016-07-05 09:49:21 -04001989 if (unlikely(switched)) {
1990 d_lookup_done(dentry);
1991 dput(dentry);
1992 }
Al Virod9585272012-06-22 12:39:14 +04001993 return err;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001994
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995no_open:
Trond Myklebust1472b832013-08-20 11:59:41 -04001996 res = nfs_lookup(dir, dentry, lookup_flags);
Trond Myklebustac795162022-01-06 18:24:02 -05001997 if (!res) {
1998 inode = d_inode(dentry);
1999 if ((lookup_flags & LOOKUP_DIRECTORY) && inode &&
2000 !S_ISDIR(inode->i_mode))
2001 res = ERR_PTR(-ENOTDIR);
2002 } else if (!IS_ERR(res)) {
2003 inode = d_inode(res);
2004 if ((lookup_flags & LOOKUP_DIRECTORY) && inode &&
2005 !S_ISDIR(inode->i_mode)) {
2006 dput(res);
2007 res = ERR_PTR(-ENOTDIR);
2008 }
2009 }
Al Viroc94c0952016-07-05 09:49:21 -04002010 if (switched) {
2011 d_lookup_done(dentry);
2012 if (!res)
2013 res = dentry;
2014 else
2015 dput(dentry);
2016 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02002017 if (IS_ERR(res))
Al Viroc94c0952016-07-05 09:49:21 -04002018 return PTR_ERR(res);
Al Viroe45198a2012-06-10 06:48:09 -04002019 return finish_no_open(file, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04002021EXPORT_SYMBOL_GPL(nfs_atomic_open);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002023static int
2024nfs4_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
2025 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026{
Nick Piggin657e94b2011-01-14 02:48:39 +00002027 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028
Al Virofa3c56b2012-06-10 15:36:40 -04002029 if (!(flags & LOOKUP_OPEN) || (flags & LOOKUP_DIRECTORY))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002030 goto full_reval;
Miklos Szeredieda72af2012-06-05 15:10:21 +02002031 if (d_mountpoint(dentry))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002032 goto full_reval;
Trond Myklebust2b484292010-09-17 10:56:51 -04002033
David Howells2b0143b2015-03-17 22:25:59 +00002034 inode = d_inode(dentry);
Trond Myklebust2b484292010-09-17 10:56:51 -04002035
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 /* We can't create new files in nfs_open_revalidate(), so we
2037 * optimize away revalidation of negative dentries.
2038 */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002039 if (inode == NULL)
2040 goto full_reval;
NeilBrown49317a72014-07-14 11:28:20 +10002041
Trond Myklebustefeda802020-02-05 09:01:54 -05002042 if (nfs_verifier_is_delegated(dentry))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002043 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust216d5d062007-10-01 20:10:12 -04002044
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 /* NFS only supports OPEN on regular files */
2046 if (!S_ISREG(inode->i_mode))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002047 goto full_reval;
2048
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 /* We cannot do exclusive creation on a positive dentry */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002050 if (flags & (LOOKUP_EXCL | LOOKUP_REVAL))
2051 goto reval_dentry;
2052
2053 /* Check if the directory changed */
2054 if (!nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU))
2055 goto reval_dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02002057 /* Let f_op->open() actually open (and revalidate) the file */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002058 return 1;
2059reval_dentry:
2060 if (flags & LOOKUP_RCU)
2061 return -ECHILD;
zhangliguang42f72cf2019-02-12 09:38:33 +08002062 return nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust536e43d2012-01-17 22:04:26 -05002063
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002064full_reval:
2065 return nfs_do_lookup_revalidate(dir, dentry, flags);
2066}
Trond Myklebust535918f2010-09-17 10:56:51 -04002067
Trond Myklebustc7944eb2018-09-28 12:42:51 -04002068static int nfs4_lookup_revalidate(struct dentry *dentry, unsigned int flags)
2069{
2070 return __nfs_lookup_revalidate(dentry, flags,
2071 nfs4_do_lookup_revalidate);
Trond Myklebustc0204fd2010-09-17 10:56:51 -04002072}
2073
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074#endif /* CONFIG_NFSV4 */
2075
Benjamin Coddington406cd912019-09-13 08:29:02 -04002076struct dentry *
2077nfs_add_or_obtain(struct dentry *dentry, struct nfs_fh *fhandle,
Anna Schumakercc6f3292021-10-22 13:11:10 -04002078 struct nfs_fattr *fattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079{
Trond Myklebustfab728e2007-09-29 17:41:33 -04002080 struct dentry *parent = dget_parent(dentry);
David Howells2b0143b2015-03-17 22:25:59 +00002081 struct inode *dir = d_inode(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 struct inode *inode;
Al Virob0c6108e2018-05-16 10:55:01 -04002083 struct dentry *d;
Benjamin Coddington406cd912019-09-13 08:29:02 -04002084 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
Trond Myklebustfab728e2007-09-29 17:41:33 -04002086 d_drop(dentry);
2087
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 if (fhandle->size == 0) {
Anna Schumaker9558a002021-10-22 13:11:04 -04002089 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 if (error)
Trond Myklebustfab728e2007-09-29 17:41:33 -04002091 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 }
Trond Myklebust5724ab32007-10-01 21:51:38 -04002093 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 if (!(fattr->valid & NFS_ATTR_FATTR)) {
2095 struct nfs_server *server = NFS_SB(dentry->d_sb);
Trond Myklebusta841b542018-04-07 13:50:59 -04002096 error = server->nfs_client->rpc_ops->getattr(server, fhandle,
Anna Schumaker2ef61e02021-10-22 13:11:07 -04002097 fattr, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 if (error < 0)
Trond Myklebustfab728e2007-09-29 17:41:33 -04002099 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 }
Anna Schumakercf7ab002021-10-22 13:11:11 -04002101 inode = nfs_fhget(dentry->d_sb, fhandle, fattr);
Al Virob0c6108e2018-05-16 10:55:01 -04002102 d = d_splice_alias(inode, dentry);
Trond Myklebustfab728e2007-09-29 17:41:33 -04002103out:
2104 dput(parent);
Benjamin Coddington406cd912019-09-13 08:29:02 -04002105 return d;
Trond Myklebustfab728e2007-09-29 17:41:33 -04002106out_error:
Benjamin Coddington406cd912019-09-13 08:29:02 -04002107 d = ERR_PTR(error);
2108 goto out;
2109}
2110EXPORT_SYMBOL_GPL(nfs_add_or_obtain);
2111
2112/*
2113 * Code common to create, mkdir, and mknod.
2114 */
2115int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fhandle,
Anna Schumakerd91bfc42021-10-22 13:11:09 -04002116 struct nfs_fattr *fattr)
Benjamin Coddington406cd912019-09-13 08:29:02 -04002117{
2118 struct dentry *d;
2119
Anna Schumakercc6f3292021-10-22 13:11:10 -04002120 d = nfs_add_or_obtain(dentry, fhandle, fattr);
Benjamin Coddington406cd912019-09-13 08:29:02 -04002121 if (IS_ERR(d))
2122 return PTR_ERR(d);
2123
2124 /* Callers don't care */
2125 dput(d);
2126 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002128EXPORT_SYMBOL_GPL(nfs_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129
2130/*
2131 * Following a failed create operation, we drop the dentry rather
2132 * than retain a negative dentry. This avoids a problem in the event
2133 * that the operation succeeded on the server, but an error in the
2134 * reply path made it appear to have failed.
2135 */
Christian Brauner549c7292021-01-21 14:19:43 +01002136int nfs_create(struct user_namespace *mnt_userns, struct inode *dir,
2137 struct dentry *dentry, umode_t mode, bool excl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138{
2139 struct iattr attr;
Al Viroebfc3b42012-06-10 18:05:36 -04002140 int open_flags = excl ? O_CREAT | O_EXCL : O_CREAT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142
Niels de Vos1e8968c2013-12-17 18:20:16 +01002143 dfprintk(VFS, "NFS: create(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002144 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145
2146 attr.ia_mode = mode;
2147 attr.ia_valid = ATTR_MODE;
2148
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04002149 trace_nfs_create_enter(dir, dentry, open_flags);
Miklos Szeredi8867fe52012-06-05 15:10:19 +02002150 error = NFS_PROTO(dir)->create(dir, dentry, &attr, open_flags);
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04002151 trace_nfs_create_exit(dir, dentry, open_flags, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 if (error != 0)
2153 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 return 0;
2155out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 d_drop(dentry);
2157 return error;
2158}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002159EXPORT_SYMBOL_GPL(nfs_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
2161/*
2162 * See comments for nfs_proc_create regarding failed operations.
2163 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002164int
Christian Brauner549c7292021-01-21 14:19:43 +01002165nfs_mknod(struct user_namespace *mnt_userns, struct inode *dir,
2166 struct dentry *dentry, umode_t mode, dev_t rdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167{
2168 struct iattr attr;
2169 int status;
2170
Niels de Vos1e8968c2013-12-17 18:20:16 +01002171 dfprintk(VFS, "NFS: mknod(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002172 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 attr.ia_mode = mode;
2175 attr.ia_valid = ATTR_MODE;
2176
Trond Myklebust1ca42382013-08-21 12:36:04 -04002177 trace_nfs_mknod_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 status = NFS_PROTO(dir)->mknod(dir, dentry, &attr, rdev);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002179 trace_nfs_mknod_exit(dir, dentry, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 if (status != 0)
2181 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 return 0;
2183out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 d_drop(dentry);
2185 return status;
2186}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002187EXPORT_SYMBOL_GPL(nfs_mknod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188
2189/*
2190 * See comments for nfs_proc_create regarding failed operations.
2191 */
Christian Brauner549c7292021-01-21 14:19:43 +01002192int nfs_mkdir(struct user_namespace *mnt_userns, struct inode *dir,
2193 struct dentry *dentry, umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194{
2195 struct iattr attr;
2196 int error;
2197
Niels de Vos1e8968c2013-12-17 18:20:16 +01002198 dfprintk(VFS, "NFS: mkdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002199 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
2201 attr.ia_valid = ATTR_MODE;
2202 attr.ia_mode = mode | S_IFDIR;
2203
Trond Myklebust1ca42382013-08-21 12:36:04 -04002204 trace_nfs_mkdir_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 error = NFS_PROTO(dir)->mkdir(dir, dentry, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002206 trace_nfs_mkdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 if (error != 0)
2208 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 return 0;
2210out_err:
2211 d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 return error;
2213}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002214EXPORT_SYMBOL_GPL(nfs_mkdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002216static void nfs_dentry_handle_enoent(struct dentry *dentry)
2217{
Al Virodc3f4192015-05-18 10:10:34 -04002218 if (simple_positive(dentry))
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002219 d_delete(dentry);
2220}
2221
Trond Myklebust9019fb32021-07-07 21:43:09 -04002222static void nfs_dentry_remove_handle_error(struct inode *dir,
2223 struct dentry *dentry, int error)
2224{
2225 switch (error) {
2226 case -ENOENT:
2227 d_delete(dentry);
Trond Myklebust00bdadc2021-12-17 15:36:57 -05002228 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2229 break;
Trond Myklebust9019fb32021-07-07 21:43:09 -04002230 case 0:
Trond Myklebust00bdadc2021-12-17 15:36:57 -05002231 nfs_d_prune_case_insensitive_aliases(d_inode(dentry));
Trond Myklebust9019fb32021-07-07 21:43:09 -04002232 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2233 }
2234}
2235
Bryan Schumaker597d9282012-07-16 16:39:10 -04002236int nfs_rmdir(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237{
2238 int error;
2239
Niels de Vos1e8968c2013-12-17 18:20:16 +01002240 dfprintk(VFS, "NFS: rmdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04002241 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242
Trond Myklebust1ca42382013-08-21 12:36:04 -04002243 trace_nfs_rmdir_enter(dir, dentry);
David Howells2b0143b2015-03-17 22:25:59 +00002244 if (d_really_is_positive(dentry)) {
Al Viro884be172016-04-28 23:56:31 -04002245 down_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04002246 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
2247 /* Ensure the VFS deletes this inode */
2248 switch (error) {
2249 case 0:
David Howells2b0143b2015-03-17 22:25:59 +00002250 clear_nlink(d_inode(dentry));
Trond Myklebustba6c0592013-08-30 12:24:25 -04002251 break;
2252 case -ENOENT:
2253 nfs_dentry_handle_enoent(dentry);
2254 }
Al Viro884be172016-04-28 23:56:31 -04002255 up_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04002256 } else
2257 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
Trond Myklebust9019fb32021-07-07 21:43:09 -04002258 nfs_dentry_remove_handle_error(dir, dentry, error);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002259 trace_nfs_rmdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260
2261 return error;
2262}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002263EXPORT_SYMBOL_GPL(nfs_rmdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265/*
2266 * Remove a file after making sure there are no pending writes,
2267 * and after checking that the file has only one user.
2268 *
2269 * We invalidate the attribute cache and free the inode prior to the operation
2270 * to avoid possible races if the server reuses the inode.
2271 */
2272static int nfs_safe_remove(struct dentry *dentry)
2273{
David Howells2b0143b2015-03-17 22:25:59 +00002274 struct inode *dir = d_inode(dentry->d_parent);
2275 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 int error = -EBUSY;
2277
Al Viro6de14722013-09-16 10:53:17 -04002278 dfprintk(VFS, "NFS: safe_remove(%pd2)\n", dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279
2280 /* If the dentry was sillyrenamed, we simply call d_delete() */
2281 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
2282 error = 0;
2283 goto out;
2284 }
2285
Trond Myklebust1ca42382013-08-21 12:36:04 -04002286 trace_nfs_remove_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 if (inode != NULL) {
Trond Myklebust912678d2018-03-20 16:43:15 -04002288 error = NFS_PROTO(dir)->remove(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 if (error == 0)
Trond Myklebust1b83d702008-06-11 15:44:04 -04002290 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 } else
Trond Myklebust912678d2018-03-20 16:43:15 -04002292 error = NFS_PROTO(dir)->remove(dir, dentry);
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002293 if (error == -ENOENT)
2294 nfs_dentry_handle_enoent(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002295 trace_nfs_remove_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296out:
2297 return error;
2298}
2299
2300/* We do silly rename. In case sillyrename() returns -EBUSY, the inode
2301 * belongs to an active ".nfs..." file and we return -EBUSY.
2302 *
2303 * If sillyrename() returns 0, we do nothing, otherwise we unlink.
2304 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002305int nfs_unlink(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306{
2307 int error;
2308 int need_rehash = 0;
2309
Niels de Vos1e8968c2013-12-17 18:20:16 +01002310 dfprintk(VFS, "NFS: unlink(%s/%lu, %pd)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04002311 dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
Trond Myklebust1ca42382013-08-21 12:36:04 -04002313 trace_nfs_unlink_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 spin_lock(&dentry->d_lock);
Al Viro84d08fa2013-07-05 18:59:33 +04002315 if (d_count(dentry) > 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 spin_unlock(&dentry->d_lock);
Trond Myklebustccfeb502007-01-13 02:28:12 -05002317 /* Start asynchronous writeout of the inode */
David Howells2b0143b2015-03-17 22:25:59 +00002318 write_inode_now(d_inode(dentry), 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 error = nfs_sillyrename(dir, dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002320 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 }
2322 if (!d_unhashed(dentry)) {
2323 __d_drop(dentry);
2324 need_rehash = 1;
2325 }
2326 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 error = nfs_safe_remove(dentry);
Trond Myklebust9019fb32021-07-07 21:43:09 -04002328 nfs_dentry_remove_handle_error(dir, dentry, error);
2329 if (need_rehash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 d_rehash(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002331out:
2332 trace_nfs_unlink_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 return error;
2334}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002335EXPORT_SYMBOL_GPL(nfs_unlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336
Chuck Lever873101b2006-08-22 20:06:23 -04002337/*
2338 * To create a symbolic link, most file systems instantiate a new inode,
2339 * add a page to it containing the path, then write it out to the disk
2340 * using prepare_write/commit_write.
2341 *
2342 * Unfortunately the NFS client can't create the in-core inode first
2343 * because it needs a file handle to create an in-core inode (see
2344 * fs/nfs/inode.c:nfs_fhget). We only have a file handle *after* the
2345 * symlink request has completed on the server.
2346 *
2347 * So instead we allocate a raw page, copy the symname into it, then do
2348 * the SYMLINK request with the page as the buffer. If it succeeds, we
2349 * now have a new file handle and can instantiate an in-core NFS inode
2350 * and move the raw page into its mapping.
2351 */
Christian Brauner549c7292021-01-21 14:19:43 +01002352int nfs_symlink(struct user_namespace *mnt_userns, struct inode *dir,
2353 struct dentry *dentry, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354{
Chuck Lever873101b2006-08-22 20:06:23 -04002355 struct page *page;
2356 char *kaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 struct iattr attr;
Chuck Lever873101b2006-08-22 20:06:23 -04002358 unsigned int pathlen = strlen(symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 int error;
2360
Niels de Vos1e8968c2013-12-17 18:20:16 +01002361 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04002362 dir->i_ino, dentry, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363
Chuck Lever873101b2006-08-22 20:06:23 -04002364 if (pathlen > PAGE_SIZE)
2365 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366
Chuck Lever873101b2006-08-22 20:06:23 -04002367 attr.ia_mode = S_IFLNK | S_IRWXUGO;
2368 attr.ia_valid = ATTR_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
Al Viroe8ecde22016-01-14 17:52:59 -05002370 page = alloc_page(GFP_USER);
Trond Myklebust76566992008-06-11 15:44:22 -04002371 if (!page)
Chuck Lever873101b2006-08-22 20:06:23 -04002372 return -ENOMEM;
Chuck Lever873101b2006-08-22 20:06:23 -04002373
Al Viroe8ecde22016-01-14 17:52:59 -05002374 kaddr = page_address(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002375 memcpy(kaddr, symname, pathlen);
2376 if (pathlen < PAGE_SIZE)
2377 memset(kaddr + pathlen, 0, PAGE_SIZE - pathlen);
Chuck Lever873101b2006-08-22 20:06:23 -04002378
Trond Myklebust1ca42382013-08-21 12:36:04 -04002379 trace_nfs_symlink_enter(dir, dentry);
Chuck Lever94a6d752006-08-22 20:06:23 -04002380 error = NFS_PROTO(dir)->symlink(dir, dentry, page, pathlen, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002381 trace_nfs_symlink_exit(dir, dentry, error);
Chuck Lever873101b2006-08-22 20:06:23 -04002382 if (error != 0) {
Niels de Vos1e8968c2013-12-17 18:20:16 +01002383 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s) error %d\n",
Chuck Lever873101b2006-08-22 20:06:23 -04002384 dir->i_sb->s_id, dir->i_ino,
Al Viro6de14722013-09-16 10:53:17 -04002385 dentry, symname, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 d_drop(dentry);
Chuck Lever873101b2006-08-22 20:06:23 -04002387 __free_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002388 return error;
2389 }
2390
Trond Myklebust342a67f2021-07-07 22:08:32 -04002391 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2392
Chuck Lever873101b2006-08-22 20:06:23 -04002393 /*
2394 * No big deal if we can't add this page to the page cache here.
2395 * READLINK will get the missing page from the server if needed.
2396 */
David Howells2b0143b2015-03-17 22:25:59 +00002397 if (!add_to_page_cache_lru(page, d_inode(dentry)->i_mapping, 0,
Chuck Lever873101b2006-08-22 20:06:23 -04002398 GFP_KERNEL)) {
Chuck Lever873101b2006-08-22 20:06:23 -04002399 SetPageUptodate(page);
2400 unlock_page(page);
Rafael Aquinia0b54add2014-02-10 14:25:48 -08002401 /*
2402 * add_to_page_cache_lru() grabs an extra page refcount.
2403 * Drop it here to avoid leaking this page later.
2404 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002405 put_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002406 } else
2407 __free_page(page);
2408
Chuck Lever873101b2006-08-22 20:06:23 -04002409 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002411EXPORT_SYMBOL_GPL(nfs_symlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412
Bryan Schumaker597d9282012-07-16 16:39:10 -04002413int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414nfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
2415{
David Howells2b0143b2015-03-17 22:25:59 +00002416 struct inode *inode = d_inode(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 int error;
2418
Al Viro6de14722013-09-16 10:53:17 -04002419 dfprintk(VFS, "NFS: link(%pd2 -> %pd2)\n",
2420 old_dentry, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421
Trond Myklebust1fd10852013-08-21 13:54:44 -04002422 trace_nfs_link_enter(inode, dir, dentry);
Trond Myklebust9697d232007-10-02 21:58:05 -04002423 d_drop(dentry);
Trond Myklebust20497502021-12-15 16:38:15 -05002424 if (S_ISREG(inode->i_mode))
2425 nfs_sync_inode(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 error = NFS_PROTO(dir)->link(inode, dir, &dentry->d_name);
Trond Myklebustcf809552005-10-27 22:12:42 -04002427 if (error == 0) {
Trond Myklebust342a67f2021-07-07 22:08:32 -04002428 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Al Viro7de9c6ee2010-10-23 11:11:40 -04002429 ihold(inode);
Trond Myklebust9697d232007-10-02 21:58:05 -04002430 d_add(dentry, inode);
Trond Myklebustcf809552005-10-27 22:12:42 -04002431 }
Trond Myklebust1fd10852013-08-21 13:54:44 -04002432 trace_nfs_link_exit(inode, dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433 return error;
2434}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002435EXPORT_SYMBOL_GPL(nfs_link);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
2437/*
2438 * RENAME
2439 * FIXME: Some nfsds, like the Linux user space nfsd, may generate a
2440 * different file handle for the same inode after a rename (e.g. when
2441 * moving to a different directory). A fail-safe method to do so would
2442 * be to look up old_dir/old_name, create a link to new_dir/new_name and
2443 * rename the old file using the sillyrename stuff. This way, the original
2444 * file in old_dir will go away when the last process iput()s the inode.
2445 *
2446 * FIXED.
2447 *
2448 * It actually works quite well. One needs to have the possibility for
2449 * at least one ".nfs..." file in each directory the file ever gets
2450 * moved or linked to which happens automagically with the new
2451 * implementation that only depends on the dcache stuff instead of
2452 * using the inode layer
2453 *
2454 * Unfortunately, things are a little more complicated than indicated
2455 * above. For a cross-directory move, we want to make sure we can get
2456 * rid of the old inode after the operation. This means there must be
2457 * no pending writes (if it's a file), and the use count must be 1.
2458 * If these conditions are met, we can drop the dentries before doing
2459 * the rename.
2460 */
Christian Brauner549c7292021-01-21 14:19:43 +01002461int nfs_rename(struct user_namespace *mnt_userns, struct inode *old_dir,
2462 struct dentry *old_dentry, struct inode *new_dir,
2463 struct dentry *new_dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464{
David Howells2b0143b2015-03-17 22:25:59 +00002465 struct inode *old_inode = d_inode(old_dentry);
2466 struct inode *new_inode = d_inode(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002467 struct dentry *dentry = NULL, *rehash = NULL;
Jeff Layton80a491f2014-03-17 07:06:56 -04002468 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 int error = -EBUSY;
2470
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02002471 if (flags)
2472 return -EINVAL;
2473
Al Viro6de14722013-09-16 10:53:17 -04002474 dfprintk(VFS, "NFS: rename(%pd2 -> %pd2, ct=%d)\n",
2475 old_dentry, new_dentry,
Al Viro84d08fa2013-07-05 18:59:33 +04002476 d_count(new_dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477
Trond Myklebust70ded202013-08-21 12:08:45 -04002478 trace_nfs_rename_enter(old_dir, old_dentry, new_dir, new_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 /*
Miklos Szeredi28f79a12009-12-03 15:58:56 -05002480 * For non-directories, check whether the target is busy and if so,
2481 * make a copy of the dentry and then do a silly-rename. If the
2482 * silly-rename succeeds, the copied dentry is hashed and becomes
2483 * the new target.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 */
Miklos Szeredi27226102009-12-03 15:58:56 -05002485 if (new_inode && !S_ISDIR(new_inode->i_mode)) {
2486 /*
2487 * To prevent any new references to the target during the
2488 * rename, we unhash the dentry in advance.
2489 */
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002490 if (!d_unhashed(new_dentry)) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002491 d_drop(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002492 rehash = new_dentry;
2493 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494
Al Viro84d08fa2013-07-05 18:59:33 +04002495 if (d_count(new_dentry) > 2) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002496 int err;
2497
2498 /* copy the target dentry's name */
2499 dentry = d_alloc(new_dentry->d_parent,
2500 &new_dentry->d_name);
2501 if (!dentry)
2502 goto out;
2503
2504 /* silly-rename the existing target ... */
2505 err = nfs_sillyrename(new_dir, new_dentry);
Miklos Szeredi24e93022009-12-03 15:58:56 -05002506 if (err)
Miklos Szeredi27226102009-12-03 15:58:56 -05002507 goto out;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002508
2509 new_dentry = dentry;
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002510 rehash = NULL;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002511 new_inode = NULL;
Miklos Szeredi27226102009-12-03 15:58:56 -05002512 }
Trond Myklebustb1e4adf2009-03-19 15:35:49 -04002513 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514
Trond Myklebust6ff9d992021-12-15 16:38:16 -05002515 if (S_ISREG(old_inode->i_mode))
2516 nfs_sync_inode(old_inode);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002517 task = nfs_async_rename(old_dir, new_dir, old_dentry, new_dentry, NULL);
Jeff Layton80a491f2014-03-17 07:06:56 -04002518 if (IS_ERR(task)) {
2519 error = PTR_ERR(task);
2520 goto out;
2521 }
2522
2523 error = rpc_wait_for_completion_task(task);
Benjamin Coddington818a8db2017-06-16 11:13:00 -04002524 if (error != 0) {
2525 ((struct nfs_renamedata *)task->tk_calldata)->cancelled = 1;
2526 /* Paired with the atomic_dec_and_test() barrier in rpc_do_put_task() */
2527 smp_wmb();
2528 } else
Jeff Layton80a491f2014-03-17 07:06:56 -04002529 error = task->tk_status;
2530 rpc_put_task(task);
Trond Myklebust59a707b2018-04-08 18:11:18 -04002531 /* Ensure the inode attributes are revalidated */
2532 if (error == 0) {
2533 spin_lock(&old_inode->i_lock);
2534 NFS_I(old_inode)->attr_gencount = nfs_inc_attr_generation_counter();
Trond Myklebustac46b3d2021-03-08 14:42:54 -05002535 nfs_set_cache_invalid(old_inode, NFS_INO_INVALID_CHANGE |
2536 NFS_INO_INVALID_CTIME |
2537 NFS_INO_REVAL_FORCED);
Trond Myklebust59a707b2018-04-08 18:11:18 -04002538 spin_unlock(&old_inode->i_lock);
2539 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540out:
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002541 if (rehash)
2542 d_rehash(rehash);
Trond Myklebust70ded202013-08-21 12:08:45 -04002543 trace_nfs_rename_exit(old_dir, old_dentry,
2544 new_dir, new_dentry, error);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002545 if (!error) {
2546 if (new_inode != NULL)
2547 nfs_drop_nlink(new_inode);
2548 /*
2549 * The d_move() should be here instead of in an async RPC completion
2550 * handler because we need the proper locks to move the dentry. If
2551 * we're interrupted by a signal, the async RPC completion handler
2552 * should mark the directories for revalidation.
2553 */
2554 d_move(old_dentry, new_dentry);
Trond Myklebustd8032242017-11-06 15:28:04 -05002555 nfs_set_verifier(old_dentry,
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002556 nfs_save_change_attribute(new_dir));
2557 } else if (error == -ENOENT)
2558 nfs_dentry_handle_enoent(old_dentry);
2559
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 /* new dentry created? */
2561 if (dentry)
2562 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 return error;
2564}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002565EXPORT_SYMBOL_GPL(nfs_rename);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002567static DEFINE_SPINLOCK(nfs_access_lru_lock);
2568static LIST_HEAD(nfs_access_lru_list);
2569static atomic_long_t nfs_access_nr_entries;
2570
Trond Myklebusta8b373e2020-02-08 09:14:11 -05002571static unsigned long nfs_access_max_cachesize = 4*1024*1024;
Trond Myklebust3a505842014-07-21 13:53:48 -04002572module_param(nfs_access_max_cachesize, ulong, 0644);
2573MODULE_PARM_DESC(nfs_access_max_cachesize, "NFS access maximum total cache length");
2574
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002575static void nfs_access_free_entry(struct nfs_access_entry *entry)
2576{
NeilBrown6238aec2021-09-28 09:47:57 +10002577 put_group_info(entry->group_info);
NeilBrownf682a392014-07-14 11:28:20 +10002578 kfree_rcu(entry, rcu_head);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002579 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002580 atomic_long_dec(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002581 smp_mb__after_atomic();
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002582}
2583
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002584static void nfs_access_free_list(struct list_head *head)
2585{
2586 struct nfs_access_entry *cache;
2587
2588 while (!list_empty(head)) {
2589 cache = list_entry(head->next, struct nfs_access_entry, lru);
2590 list_del(&cache->lru);
2591 nfs_access_free_entry(cache);
2592 }
2593}
2594
Trond Myklebust3a505842014-07-21 13:53:48 -04002595static unsigned long
2596nfs_do_access_cache_scan(unsigned int nr_to_scan)
Trond Myklebust979df722006-07-25 11:28:19 -04002597{
2598 LIST_HEAD(head);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002599 struct nfs_inode *nfsi, *next;
Trond Myklebust979df722006-07-25 11:28:19 -04002600 struct nfs_access_entry *cache;
Dave Chinner1ab6c492013-08-28 10:18:09 +10002601 long freed = 0;
Trond Myklebust979df722006-07-25 11:28:19 -04002602
Trond Myklebusta50f7952007-06-05 19:23:43 -04002603 spin_lock(&nfs_access_lru_lock);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002604 list_for_each_entry_safe(nfsi, next, &nfs_access_lru_list, access_cache_inode_lru) {
Trond Myklebust979df722006-07-25 11:28:19 -04002605 struct inode *inode;
2606
2607 if (nr_to_scan-- == 0)
2608 break;
Trond Myklebust9c7e7e22010-05-13 12:51:06 -04002609 inode = &nfsi->vfs_inode;
Trond Myklebust979df722006-07-25 11:28:19 -04002610 spin_lock(&inode->i_lock);
2611 if (list_empty(&nfsi->access_cache_entry_lru))
2612 goto remove_lru_entry;
2613 cache = list_entry(nfsi->access_cache_entry_lru.next,
2614 struct nfs_access_entry, lru);
2615 list_move(&cache->lru, &head);
2616 rb_erase(&cache->rb_node, &nfsi->access_cache);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002617 freed++;
Trond Myklebust979df722006-07-25 11:28:19 -04002618 if (!list_empty(&nfsi->access_cache_entry_lru))
2619 list_move_tail(&nfsi->access_cache_inode_lru,
2620 &nfs_access_lru_list);
2621 else {
2622remove_lru_entry:
2623 list_del_init(&nfsi->access_cache_inode_lru);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002624 smp_mb__before_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002625 clear_bit(NFS_INO_ACL_LRU_SET, &nfsi->flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002626 smp_mb__after_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002627 }
Trond Myklebust59844a92010-05-26 08:42:24 -04002628 spin_unlock(&inode->i_lock);
Trond Myklebust979df722006-07-25 11:28:19 -04002629 }
2630 spin_unlock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002631 nfs_access_free_list(&head);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002632 return freed;
2633}
2634
2635unsigned long
Trond Myklebust3a505842014-07-21 13:53:48 -04002636nfs_access_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
2637{
2638 int nr_to_scan = sc->nr_to_scan;
2639 gfp_t gfp_mask = sc->gfp_mask;
2640
2641 if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
2642 return SHRINK_STOP;
2643 return nfs_do_access_cache_scan(nr_to_scan);
2644}
2645
2646
2647unsigned long
Dave Chinner1ab6c492013-08-28 10:18:09 +10002648nfs_access_cache_count(struct shrinker *shrink, struct shrink_control *sc)
2649{
Glauber Costa55f841c2013-08-28 10:17:53 +10002650 return vfs_pressure_ratio(atomic_long_read(&nfs_access_nr_entries));
Trond Myklebust979df722006-07-25 11:28:19 -04002651}
2652
Trond Myklebust3a505842014-07-21 13:53:48 -04002653static void
2654nfs_access_cache_enforce_limit(void)
2655{
2656 long nr_entries = atomic_long_read(&nfs_access_nr_entries);
2657 unsigned long diff;
2658 unsigned int nr_to_scan;
2659
2660 if (nr_entries < 0 || nr_entries <= nfs_access_max_cachesize)
2661 return;
2662 nr_to_scan = 100;
2663 diff = nr_entries - nfs_access_max_cachesize;
2664 if (diff < nr_to_scan)
2665 nr_to_scan = diff;
2666 nfs_do_access_cache_scan(nr_to_scan);
2667}
2668
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002669static void __nfs_access_zap_cache(struct nfs_inode *nfsi, struct list_head *head)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002670{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002671 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002672 struct rb_node *n;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002673 struct nfs_access_entry *entry;
2674
2675 /* Unhook entries from the cache */
2676 while ((n = rb_first(root_node)) != NULL) {
2677 entry = rb_entry(n, struct nfs_access_entry, rb_node);
2678 rb_erase(n, root_node);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002679 list_move(&entry->lru, head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002680 }
2681 nfsi->cache_validity &= ~NFS_INO_INVALID_ACCESS;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002682}
2683
2684void nfs_access_zap_cache(struct inode *inode)
2685{
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002686 LIST_HEAD(head);
2687
2688 if (test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags) == 0)
2689 return;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002690 /* Remove from global LRU init */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002691 spin_lock(&nfs_access_lru_lock);
2692 if (test_and_clear_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002693 list_del_init(&NFS_I(inode)->access_cache_inode_lru);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002694
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002695 spin_lock(&inode->i_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002696 __nfs_access_zap_cache(NFS_I(inode), &head);
2697 spin_unlock(&inode->i_lock);
2698 spin_unlock(&nfs_access_lru_lock);
2699 nfs_access_free_list(&head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002700}
Bryan Schumaker1c606fb2012-07-30 16:05:24 -04002701EXPORT_SYMBOL_GPL(nfs_access_zap_cache);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002702
NeilBrown6238aec2021-09-28 09:47:57 +10002703static int access_cmp(const struct cred *a, const struct nfs_access_entry *b)
2704{
2705 struct group_info *ga, *gb;
2706 int g;
2707
2708 if (uid_lt(a->fsuid, b->fsuid))
2709 return -1;
2710 if (uid_gt(a->fsuid, b->fsuid))
2711 return 1;
2712
2713 if (gid_lt(a->fsgid, b->fsgid))
2714 return -1;
2715 if (gid_gt(a->fsgid, b->fsgid))
2716 return 1;
2717
2718 ga = a->group_info;
2719 gb = b->group_info;
2720 if (ga == gb)
2721 return 0;
2722 if (ga == NULL)
2723 return -1;
2724 if (gb == NULL)
2725 return 1;
2726 if (ga->ngroups < gb->ngroups)
2727 return -1;
2728 if (ga->ngroups > gb->ngroups)
2729 return 1;
2730
2731 for (g = 0; g < ga->ngroups; g++) {
2732 if (gid_lt(ga->gid[g], gb->gid[g]))
2733 return -1;
2734 if (gid_gt(ga->gid[g], gb->gid[g]))
2735 return 1;
2736 }
2737 return 0;
2738}
2739
NeilBrownb68572e2018-12-03 11:30:30 +11002740static struct nfs_access_entry *nfs_access_search_rbtree(struct inode *inode, const struct cred *cred)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002741{
2742 struct rb_node *n = NFS_I(inode)->access_cache.rb_node;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002743
2744 while (n != NULL) {
NeilBrownb68572e2018-12-03 11:30:30 +11002745 struct nfs_access_entry *entry =
2746 rb_entry(n, struct nfs_access_entry, rb_node);
NeilBrown6238aec2021-09-28 09:47:57 +10002747 int cmp = access_cmp(cred, entry);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002748
NeilBrownb68572e2018-12-03 11:30:30 +11002749 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002750 n = n->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002751 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002752 n = n->rb_right;
2753 else
2754 return entry;
2755 }
2756 return NULL;
2757}
2758
NeilBrownb5e7b592021-09-28 09:47:57 +10002759static int nfs_access_get_cached_locked(struct inode *inode, const struct cred *cred, u32 *mask, bool may_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760{
Chuck Lever55296802005-08-18 11:24:09 -07002761 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002762 struct nfs_access_entry *cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002763 bool retry = true;
2764 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002766 spin_lock(&inode->i_lock);
Trond Myklebust57b69182016-06-03 17:07:19 -04002767 for(;;) {
2768 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2769 goto out_zap;
2770 cache = nfs_access_search_rbtree(inode, cred);
2771 err = -ENOENT;
2772 if (cache == NULL)
2773 goto out;
2774 /* Found an entry, is our attribute cache valid? */
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002775 if (!nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
Trond Myklebust57b69182016-06-03 17:07:19 -04002776 break;
Trond Myklebust5c965db2020-01-06 15:39:36 -05002777 if (!retry)
2778 break;
Trond Myklebust57b69182016-06-03 17:07:19 -04002779 err = -ECHILD;
2780 if (!may_block)
2781 goto out;
Trond Myklebust57b69182016-06-03 17:07:19 -04002782 spin_unlock(&inode->i_lock);
2783 err = __nfs_revalidate_inode(NFS_SERVER(inode), inode);
2784 if (err)
2785 return err;
2786 spin_lock(&inode->i_lock);
2787 retry = false;
2788 }
NeilBrownb5e7b592021-09-28 09:47:57 +10002789 *mask = cache->mask;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002790 list_move_tail(&cache->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002791 err = 0;
2792out:
2793 spin_unlock(&inode->i_lock);
2794 return err;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002795out_zap:
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002796 spin_unlock(&inode->i_lock);
2797 nfs_access_zap_cache(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002798 return -ENOENT;
2799}
2800
NeilBrownb5e7b592021-09-28 09:47:57 +10002801static int nfs_access_get_cached_rcu(struct inode *inode, const struct cred *cred, u32 *mask)
NeilBrownf682a392014-07-14 11:28:20 +10002802{
2803 /* Only check the most recently returned cache entry,
2804 * but do it without locking.
2805 */
2806 struct nfs_inode *nfsi = NFS_I(inode);
2807 struct nfs_access_entry *cache;
2808 int err = -ECHILD;
2809 struct list_head *lh;
2810
2811 rcu_read_lock();
2812 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2813 goto out;
Madhuparna Bhowmik9f01eb52019-12-10 11:16:39 +05302814 lh = rcu_dereference(list_tail_rcu(&nfsi->access_cache_entry_lru));
NeilBrownf682a392014-07-14 11:28:20 +10002815 cache = list_entry(lh, struct nfs_access_entry, lru);
2816 if (lh == &nfsi->access_cache_entry_lru ||
NeilBrown6238aec2021-09-28 09:47:57 +10002817 access_cmp(cred, cache) != 0)
NeilBrownf682a392014-07-14 11:28:20 +10002818 cache = NULL;
2819 if (cache == NULL)
2820 goto out;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002821 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
NeilBrownf682a392014-07-14 11:28:20 +10002822 goto out;
NeilBrownb5e7b592021-09-28 09:47:57 +10002823 *mask = cache->mask;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002824 err = 0;
NeilBrownf682a392014-07-14 11:28:20 +10002825out:
2826 rcu_read_unlock();
2827 return err;
2828}
2829
NeilBrownb5e7b592021-09-28 09:47:57 +10002830int nfs_access_get_cached(struct inode *inode, const struct cred *cred,
2831 u32 *mask, bool may_block)
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002832{
2833 int status;
2834
NeilBrownb5e7b592021-09-28 09:47:57 +10002835 status = nfs_access_get_cached_rcu(inode, cred, mask);
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002836 if (status != 0)
NeilBrownb5e7b592021-09-28 09:47:57 +10002837 status = nfs_access_get_cached_locked(inode, cred, mask,
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002838 may_block);
2839
2840 return status;
2841}
2842EXPORT_SYMBOL_GPL(nfs_access_get_cached);
2843
NeilBrown73fbb3f2021-09-28 09:47:57 +10002844static void nfs_access_add_rbtree(struct inode *inode,
2845 struct nfs_access_entry *set,
2846 const struct cred *cred)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002847{
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002848 struct nfs_inode *nfsi = NFS_I(inode);
2849 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002850 struct rb_node **p = &root_node->rb_node;
2851 struct rb_node *parent = NULL;
2852 struct nfs_access_entry *entry;
NeilBrownb68572e2018-12-03 11:30:30 +11002853 int cmp;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002854
2855 spin_lock(&inode->i_lock);
2856 while (*p != NULL) {
2857 parent = *p;
2858 entry = rb_entry(parent, struct nfs_access_entry, rb_node);
NeilBrown6238aec2021-09-28 09:47:57 +10002859 cmp = access_cmp(cred, entry);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002860
NeilBrownb68572e2018-12-03 11:30:30 +11002861 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002862 p = &parent->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002863 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002864 p = &parent->rb_right;
2865 else
2866 goto found;
2867 }
2868 rb_link_node(&set->rb_node, parent, p);
2869 rb_insert_color(&set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002870 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002871 spin_unlock(&inode->i_lock);
2872 return;
2873found:
2874 rb_replace_node(parent, &set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002875 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2876 list_del(&entry->lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002877 spin_unlock(&inode->i_lock);
2878 nfs_access_free_entry(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879}
2880
NeilBrown73fbb3f2021-09-28 09:47:57 +10002881void nfs_access_add_cache(struct inode *inode, struct nfs_access_entry *set,
2882 const struct cred *cred)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002884 struct nfs_access_entry *cache = kmalloc(sizeof(*cache), GFP_KERNEL);
2885 if (cache == NULL)
2886 return;
2887 RB_CLEAR_NODE(&cache->rb_node);
NeilBrown6238aec2021-09-28 09:47:57 +10002888 cache->fsuid = cred->fsuid;
2889 cache->fsgid = cred->fsgid;
2890 cache->group_info = get_group_info(cred->group_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891 cache->mask = set->mask;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002892
NeilBrownf682a392014-07-14 11:28:20 +10002893 /* The above field assignments must be visible
2894 * before this item appears on the lru. We cannot easily
2895 * use rcu_assign_pointer, so just force the memory barrier.
2896 */
2897 smp_wmb();
NeilBrown73fbb3f2021-09-28 09:47:57 +10002898 nfs_access_add_rbtree(inode, cache, cred);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002899
2900 /* Update accounting */
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002901 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002902 atomic_long_inc(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002903 smp_mb__after_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002904
2905 /* Add inode to global LRU list */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002906 if (!test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags)) {
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002907 spin_lock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002908 if (!test_and_set_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2909 list_add_tail(&NFS_I(inode)->access_cache_inode_lru,
2910 &nfs_access_lru_list);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002911 spin_unlock(&nfs_access_lru_lock);
2912 }
Trond Myklebust3a505842014-07-21 13:53:48 -04002913 nfs_access_cache_enforce_limit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002914}
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002915EXPORT_SYMBOL_GPL(nfs_access_add_cache);
2916
Anna Schumaker3c181822017-07-26 10:14:55 -04002917#define NFS_MAY_READ (NFS_ACCESS_READ)
2918#define NFS_MAY_WRITE (NFS_ACCESS_MODIFY | \
2919 NFS_ACCESS_EXTEND | \
2920 NFS_ACCESS_DELETE)
2921#define NFS_FILE_MAY_WRITE (NFS_ACCESS_MODIFY | \
2922 NFS_ACCESS_EXTEND)
Trond Myklebustecbb9032017-07-11 17:54:35 -04002923#define NFS_DIR_MAY_WRITE NFS_MAY_WRITE
Anna Schumaker3c181822017-07-26 10:14:55 -04002924#define NFS_MAY_LOOKUP (NFS_ACCESS_LOOKUP)
2925#define NFS_MAY_EXECUTE (NFS_ACCESS_EXECUTE)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002926static int
Trond Myklebustecbb9032017-07-11 17:54:35 -04002927nfs_access_calc_mask(u32 access_result, umode_t umode)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002928{
2929 int mask = 0;
2930
2931 if (access_result & NFS_MAY_READ)
2932 mask |= MAY_READ;
Trond Myklebustecbb9032017-07-11 17:54:35 -04002933 if (S_ISDIR(umode)) {
2934 if ((access_result & NFS_DIR_MAY_WRITE) == NFS_DIR_MAY_WRITE)
2935 mask |= MAY_WRITE;
2936 if ((access_result & NFS_MAY_LOOKUP) == NFS_MAY_LOOKUP)
2937 mask |= MAY_EXEC;
2938 } else if (S_ISREG(umode)) {
2939 if ((access_result & NFS_FILE_MAY_WRITE) == NFS_FILE_MAY_WRITE)
2940 mask |= MAY_WRITE;
2941 if ((access_result & NFS_MAY_EXECUTE) == NFS_MAY_EXECUTE)
2942 mask |= MAY_EXEC;
2943 } else if (access_result & NFS_MAY_WRITE)
2944 mask |= MAY_WRITE;
Trond Myklebust15d4b732017-07-11 17:54:32 -04002945 return mask;
2946}
2947
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002948void nfs_access_set_mask(struct nfs_access_entry *entry, u32 access_result)
2949{
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002950 entry->mask = access_result;
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002951}
2952EXPORT_SYMBOL_GPL(nfs_access_set_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953
NeilBrownb68572e2018-12-03 11:30:30 +11002954static int nfs_do_access(struct inode *inode, const struct cred *cred, int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955{
2956 struct nfs_access_entry cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002957 bool may_block = (mask & MAY_NOT_BLOCK) == 0;
Trond Myklebuste8194b72020-01-06 15:25:12 -05002958 int cache_mask = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959 int status;
2960
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002961 trace_nfs_access_enter(inode);
2962
NeilBrownb5e7b592021-09-28 09:47:57 +10002963 status = nfs_access_get_cached(inode, cred, &cache.mask, may_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 if (status == 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002965 goto out_cached;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966
NeilBrownf3324a22014-07-14 11:28:20 +10002967 status = -ECHILD;
Trond Myklebust57b69182016-06-03 17:07:19 -04002968 if (!may_block)
NeilBrownf3324a22014-07-14 11:28:20 +10002969 goto out;
2970
Anna Schumaker1750d922017-07-26 12:00:21 -04002971 /*
2972 * Determine which access bits we want to ask for...
2973 */
2974 cache.mask = NFS_ACCESS_READ | NFS_ACCESS_MODIFY | NFS_ACCESS_EXTEND;
Frank van der Linden72832a22020-06-23 22:38:58 +00002975 if (nfs_server_capable(inode, NFS_CAP_XATTR)) {
2976 cache.mask |= NFS_ACCESS_XAREAD | NFS_ACCESS_XAWRITE |
2977 NFS_ACCESS_XALIST;
2978 }
Anna Schumaker1750d922017-07-26 12:00:21 -04002979 if (S_ISDIR(inode->i_mode))
2980 cache.mask |= NFS_ACCESS_DELETE | NFS_ACCESS_LOOKUP;
2981 else
2982 cache.mask |= NFS_ACCESS_EXECUTE;
NeilBrown73fbb3f2021-09-28 09:47:57 +10002983 status = NFS_PROTO(inode)->access(inode, &cache, cred);
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002984 if (status != 0) {
2985 if (status == -ESTALE) {
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002986 if (!S_ISDIR(inode->i_mode))
Trond Myklebust93ce4af2020-04-06 13:39:29 -04002987 nfs_set_inode_stale(inode);
2988 else
2989 nfs_zap_caches(inode);
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002990 }
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002991 goto out;
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002992 }
NeilBrown73fbb3f2021-09-28 09:47:57 +10002993 nfs_access_add_cache(inode, &cache, cred);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002994out_cached:
Trond Myklebustecbb9032017-07-11 17:54:35 -04002995 cache_mask = nfs_access_calc_mask(cache.mask, inode->i_mode);
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002996 if ((mask & ~cache_mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) != 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002997 status = -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998out:
Trond Myklebuste8194b72020-01-06 15:25:12 -05002999 trace_nfs_access_exit(inode, mask, cache_mask, status);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04003000 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001}
3002
Trond Myklebustaf22f942007-08-10 17:45:10 -04003003static int nfs_open_permission_mask(int openflags)
3004{
3005 int mask = 0;
3006
Weston Andros Adamsonf8d9a892013-01-03 16:42:29 -05003007 if (openflags & __FMODE_EXEC) {
3008 /* ONLY check exec rights */
3009 mask = MAY_EXEC;
3010 } else {
3011 if ((openflags & O_ACCMODE) != O_WRONLY)
3012 mask |= MAY_READ;
3013 if ((openflags & O_ACCMODE) != O_RDONLY)
3014 mask |= MAY_WRITE;
3015 }
3016
Trond Myklebustaf22f942007-08-10 17:45:10 -04003017 return mask;
3018}
3019
NeilBrownb68572e2018-12-03 11:30:30 +11003020int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags)
Trond Myklebustaf22f942007-08-10 17:45:10 -04003021{
3022 return nfs_do_access(inode, cred, nfs_open_permission_mask(openflags));
3023}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04003024EXPORT_SYMBOL_GPL(nfs_may_open);
Trond Myklebustaf22f942007-08-10 17:45:10 -04003025
Trond Myklebust5c5fc092015-12-28 19:30:05 -05003026static int nfs_execute_ok(struct inode *inode, int mask)
3027{
3028 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust21c3ba72016-12-16 18:40:03 -05003029 int ret = 0;
Trond Myklebust5c5fc092015-12-28 19:30:05 -05003030
Trond Myklebust38258272018-07-24 14:27:11 -04003031 if (S_ISDIR(inode->i_mode))
3032 return 0;
Trond Myklebust720869e2021-04-13 09:41:16 -04003033 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_MODE)) {
Trond Myklebust21c3ba72016-12-16 18:40:03 -05003034 if (mask & MAY_NOT_BLOCK)
3035 return -ECHILD;
3036 ret = __nfs_revalidate_inode(server, inode);
3037 }
Trond Myklebust5c5fc092015-12-28 19:30:05 -05003038 if (ret == 0 && !execute_ok(inode))
3039 ret = -EACCES;
3040 return ret;
3041}
3042
Christian Brauner549c7292021-01-21 14:19:43 +01003043int nfs_permission(struct user_namespace *mnt_userns,
3044 struct inode *inode,
3045 int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003046{
NeilBrownb68572e2018-12-03 11:30:30 +11003047 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048 int res = 0;
3049
Chuck Lever91d5b472006-03-20 13:44:14 -05003050 nfs_inc_stats(inode, NFSIOS_VFSACCESS);
3051
Al Viroe6305c42008-07-15 21:03:57 -04003052 if ((mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053 goto out;
3054 /* Is this sys_access() ? */
Eric Paris9cfcac82010-07-23 11:43:51 -04003055 if (mask & (MAY_ACCESS | MAY_CHDIR))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056 goto force_lookup;
3057
3058 switch (inode->i_mode & S_IFMT) {
3059 case S_IFLNK:
3060 goto out;
3061 case S_IFREG:
Trond Myklebust762674f2015-12-26 21:54:58 -05003062 if ((mask & MAY_OPEN) &&
3063 nfs_server_capable(inode, NFS_CAP_ATOMIC_OPEN))
3064 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065 break;
3066 case S_IFDIR:
3067 /*
3068 * Optimize away all write operations, since the server
3069 * will check permissions when we perform the op.
3070 */
3071 if ((mask & MAY_WRITE) && !(mask & MAY_READ))
3072 goto out;
3073 }
3074
3075force_lookup:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076 if (!NFS_PROTO(inode)->access)
3077 goto out_notsup;
3078
Zhouyi Zhoueb095c12020-03-06 03:45:26 +00003079 res = nfs_do_access(inode, cred, mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080out:
Trond Myklebust5c5fc092015-12-28 19:30:05 -05003081 if (!res && (mask & MAY_EXEC))
3082 res = nfs_execute_ok(inode, mask);
Miklos Szeredif696a362008-07-31 13:41:58 +02003083
Niels de Vos1e8968c2013-12-17 18:20:16 +01003084 dfprintk(VFS, "NFS: permission(%s/%lu), mask=0x%x, res=%d\n",
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05003085 inode->i_sb->s_id, inode->i_ino, mask, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086 return res;
3087out_notsup:
NeilBrownd51ac1a2014-07-14 11:28:20 +10003088 if (mask & MAY_NOT_BLOCK)
3089 return -ECHILD;
3090
Trond Myklebust720869e2021-04-13 09:41:16 -04003091 res = nfs_revalidate_inode(inode, NFS_INO_INVALID_MODE |
3092 NFS_INO_INVALID_OTHER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093 if (res == 0)
Christian Brauner47291ba2021-01-21 14:19:24 +01003094 res = generic_permission(&init_user_ns, inode, mask);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05003095 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04003097EXPORT_SYMBOL_GPL(nfs_permission);