blob: e56b1bd99537c64ca72a0b92f28c86ed3d9fd2a7 [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
NeilBrown684f39b2018-12-03 11:30:30 +110071static struct nfs_open_dir_context *alloc_nfs_open_dir_context(struct inode *dir, const struct cred *cred)
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;
NeilBrown684f39b2018-12-03 11:30:30 +110081 ctx->cred = get_cred(cred);
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))
85 nfsi->cache_validity |= NFS_INO_INVALID_DATA |
86 NFS_INO_REVAL_FORCED;
Trond Myklebust311324a2014-02-07 17:02:08 -050087 list_add(&ctx->list, &nfsi->open_files);
88 spin_unlock(&dir->i_lock);
Trond Myklebust0c030802011-07-30 12:45:35 -040089 return ctx;
90 }
91 return ERR_PTR(-ENOMEM);
Bryan Schumaker480c2002011-03-23 14:48:29 -040092}
93
Trond Myklebust311324a2014-02-07 17:02:08 -050094static void put_nfs_open_dir_context(struct inode *dir, struct nfs_open_dir_context *ctx)
Bryan Schumaker480c2002011-03-23 14:48:29 -040095{
Trond Myklebust311324a2014-02-07 17:02:08 -050096 spin_lock(&dir->i_lock);
97 list_del(&ctx->list);
98 spin_unlock(&dir->i_lock);
NeilBrown684f39b2018-12-03 11:30:30 +110099 put_cred(ctx->cred);
Bryan Schumaker480c2002011-03-23 14:48:29 -0400100 kfree(ctx);
101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103/*
104 * Open file
105 */
106static int
107nfs_opendir(struct inode *inode, struct file *filp)
108{
Bryan Schumaker480c2002011-03-23 14:48:29 -0400109 int res = 0;
110 struct nfs_open_dir_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Al Viro6de14722013-09-16 10:53:17 -0400112 dfprintk(FILE, "NFS: open dir(%pD2)\n", filp);
Chuck Levercc0dd2d2008-06-11 17:55:42 -0400113
114 nfs_inc_stats(inode, NFSIOS_VFSOPEN);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500115
NeilBrown684f39b2018-12-03 11:30:30 +1100116 ctx = alloc_nfs_open_dir_context(inode, current_cred());
Bryan Schumaker480c2002011-03-23 14:48:29 -0400117 if (IS_ERR(ctx)) {
118 res = PTR_ERR(ctx);
119 goto out;
120 }
121 filp->private_data = ctx;
Bryan Schumaker480c2002011-03-23 14:48:29 -0400122out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 return res;
124}
125
Bryan Schumaker480c2002011-03-23 14:48:29 -0400126static int
127nfs_closedir(struct inode *inode, struct file *filp)
128{
Al Viroa4555892014-10-21 20:11:25 -0400129 put_nfs_open_dir_context(file_inode(filp), filp->private_data);
Bryan Schumaker480c2002011-03-23 14:48:29 -0400130 return 0;
131}
132
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400133struct nfs_cache_array_entry {
134 u64 cookie;
135 u64 ino;
136 struct qstr string;
Trond Myklebust0b26a0b2010-11-20 14:26:44 -0500137 unsigned char d_type;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400138};
139
140struct nfs_cache_array {
Chuck Lever88b8e132012-03-01 17:00:23 -0500141 int size;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400142 int eof_index;
143 u64 last_cookie;
Gustavo A. R. Silva5601cda2020-03-09 13:24:42 -0500144 struct nfs_cache_array_entry array[];
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400145};
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147typedef struct {
148 struct file *file;
149 struct page *page;
Al Viro23db8622013-05-17 16:34:50 -0400150 struct dir_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 unsigned long page_index;
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000152 u64 *dir_cookie;
Trond Myklebust0aded702010-11-30 21:56:32 -0500153 u64 last_cookie;
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000154 loff_t current_index;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500155 loff_t prev_index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400156
Trond Myklebusta1147b82020-02-05 09:01:52 -0500157 unsigned long dir_verifier;
Neil Brown1f4eab72007-04-16 09:35:27 +1000158 unsigned long timestamp;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400159 unsigned long gencount;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400160 unsigned int cache_entry_index;
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400161 bool plus;
162 bool eof;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163} nfs_readdir_descriptor_t;
164
Trond Myklebust4b310312020-02-02 17:53:53 -0500165static
166void nfs_readdir_init_array(struct page *page)
167{
168 struct nfs_cache_array *array;
169
170 array = kmap_atomic(page);
171 memset(array, 0, sizeof(struct nfs_cache_array));
172 array->eof_index = -1;
173 kunmap_atomic(array);
174}
175
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400176/*
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400177 * we are freeing strings created by nfs_add_to_readdir_array()
178 */
179static
Trond Myklebust11de3b12010-12-01 14:17:06 -0500180void nfs_readdir_clear_array(struct page *page)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400181{
Trond Myklebust11de3b12010-12-01 14:17:06 -0500182 struct nfs_cache_array *array;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400183 int i;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500184
Cong Wang2b86ce22011-11-25 23:14:33 +0800185 array = kmap_atomic(page);
Benjamin Coddingtonb044f642017-03-10 17:07:46 -0500186 for (i = 0; i < array->size; i++)
187 kfree(array->array[i].string.name);
Trond Myklebust4b310312020-02-02 17:53:53 -0500188 array->size = 0;
Cong Wang2b86ce22011-11-25 23:14:33 +0800189 kunmap_atomic(array);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400190}
191
192/*
193 * the caller is responsible for freeing qstr.name
194 * when called by nfs_readdir_add_to_array, the strings will be freed in
195 * nfs_clear_readdir_array()
196 */
197static
Trond Myklebust4a201d62010-10-23 14:53:23 -0400198int nfs_readdir_make_qstr(struct qstr *string, const char *name, unsigned int len)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400199{
200 string->len = len;
Trond Myklebust3803d672020-02-02 17:53:55 -0500201 string->name = kmemdup_nul(name, len, GFP_KERNEL);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400202 if (string->name == NULL)
203 return -ENOMEM;
Catalin Marinas04e4bd12010-11-11 12:53:47 +0000204 /*
205 * Avoid a kmemleak false positive. The pointer to the name is stored
206 * in a page cache page which kmemleak does not scan.
207 */
208 kmemleak_not_leak(string->name);
Linus Torvalds8387ff22016-06-10 07:51:30 -0700209 string->hash = full_name_hash(NULL, name, len);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400210 return 0;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400211}
212
213static
214int nfs_readdir_add_to_array(struct nfs_entry *entry, struct page *page)
215{
Fabian Frederick0795bf82017-05-03 20:52:21 +0200216 struct nfs_cache_array *array = kmap(page);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400217 struct nfs_cache_array_entry *cache_entry;
218 int ret;
219
Trond Myklebust4a201d62010-10-23 14:53:23 -0400220 cache_entry = &array->array[array->size];
Trond Myklebust30200932010-11-20 15:18:22 -0500221
222 /* Check that this entry lies within the page bounds */
223 ret = -ENOSPC;
224 if ((char *)&cache_entry[1] - (char *)page_address(page) > PAGE_SIZE)
225 goto out;
226
Trond Myklebust4a201d62010-10-23 14:53:23 -0400227 cache_entry->cookie = entry->prev_cookie;
228 cache_entry->ino = entry->ino;
Trond Myklebust0b26a0b2010-11-20 14:26:44 -0500229 cache_entry->d_type = entry->d_type;
Trond Myklebust4a201d62010-10-23 14:53:23 -0400230 ret = nfs_readdir_make_qstr(&cache_entry->string, entry->name, entry->len);
231 if (ret)
232 goto out;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400233 array->last_cookie = entry->cookie;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500234 array->size++;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500235 if (entry->eof != 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400236 array->eof_index = array->size;
Trond Myklebust4a201d62010-10-23 14:53:23 -0400237out:
Fabian Frederick0795bf82017-05-03 20:52:21 +0200238 kunmap(page);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400239 return ret;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400240}
241
Trond Myklebust59e356a2020-02-03 14:49:33 -0500242static inline
243int is_32bit_api(void)
244{
245#ifdef CONFIG_COMPAT
246 return in_compat_syscall();
247#else
248 return (BITS_PER_LONG == 32);
249#endif
250}
251
252static
253bool nfs_readdir_use_cookie(const struct file *filp)
254{
255 if ((filp->f_mode & FMODE_32BITHASH) ||
256 (!(filp->f_mode & FMODE_64BITHASH) && is_32bit_api()))
257 return false;
258 return true;
259}
260
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400261static
262int nfs_readdir_search_for_pos(struct nfs_cache_array *array, nfs_readdir_descriptor_t *desc)
263{
Al Viro23db8622013-05-17 16:34:50 -0400264 loff_t diff = desc->ctx->pos - desc->current_index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400265 unsigned int index;
266
267 if (diff < 0)
268 goto out_eof;
269 if (diff >= array->size) {
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500270 if (array->eof_index >= 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400271 goto out_eof;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400272 return -EAGAIN;
273 }
274
275 index = (unsigned int)diff;
276 *desc->dir_cookie = array->array[index].cookie;
277 desc->cache_entry_index = index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400278 return 0;
279out_eof:
Thomas Meyer6089dd02017-10-07 16:02:21 +0200280 desc->eof = true;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400281 return -EBADCOOKIE;
282}
283
Jeff Layton4db72b42014-01-28 13:47:46 -0500284static bool
285nfs_readdir_inode_mapping_valid(struct nfs_inode *nfsi)
286{
287 if (nfsi->cache_validity & (NFS_INO_INVALID_ATTR|NFS_INO_INVALID_DATA))
288 return false;
289 smp_rmb();
290 return !test_bit(NFS_INO_INVALIDATING, &nfsi->flags);
291}
292
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400293static
294int nfs_readdir_search_for_cookie(struct nfs_cache_array *array, nfs_readdir_descriptor_t *desc)
295{
296 int i;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400297 loff_t new_pos;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400298 int status = -EAGAIN;
299
300 for (i = 0; i < array->size; i++) {
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400301 if (array->array[i].cookie == *desc->dir_cookie) {
Al Viro496ad9a2013-01-23 17:07:38 -0500302 struct nfs_inode *nfsi = NFS_I(file_inode(desc->file));
Trond Myklebust0c030802011-07-30 12:45:35 -0400303 struct nfs_open_dir_context *ctx = desc->file->private_data;
304
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400305 new_pos = desc->current_index + i;
Jeff Layton4db72b42014-01-28 13:47:46 -0500306 if (ctx->attr_gencount != nfsi->attr_gencount ||
307 !nfs_readdir_inode_mapping_valid(nfsi)) {
Trond Myklebust0c030802011-07-30 12:45:35 -0400308 ctx->duped = 0;
309 ctx->attr_gencount = nfsi->attr_gencount;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500310 } else if (new_pos < desc->prev_index) {
Trond Myklebust0c030802011-07-30 12:45:35 -0400311 if (ctx->duped > 0
312 && ctx->dup_cookie == *desc->dir_cookie) {
313 if (printk_ratelimit()) {
Al Viro6de14722013-09-16 10:53:17 -0400314 pr_notice("NFS: directory %pD2 contains a readdir loop."
Trond Myklebust0c030802011-07-30 12:45:35 -0400315 "Please contact your server vendor. "
Jeff Layton9581a4a2014-04-05 08:45:57 -0400316 "The file: %.*s has duplicate cookie %llu\n",
317 desc->file, array->array[i].string.len,
318 array->array[i].string.name, *desc->dir_cookie);
Trond Myklebust0c030802011-07-30 12:45:35 -0400319 }
320 status = -ELOOP;
321 goto out;
322 }
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400323 ctx->dup_cookie = *desc->dir_cookie;
Trond Myklebust0c030802011-07-30 12:45:35 -0400324 ctx->duped = -1;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400325 }
Trond Myklebust59e356a2020-02-03 14:49:33 -0500326 if (nfs_readdir_use_cookie(desc->file))
327 desc->ctx->pos = *desc->dir_cookie;
328 else
329 desc->ctx->pos = new_pos;
330 desc->prev_index = new_pos;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400331 desc->cache_entry_index = i;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500332 return 0;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400333 }
334 }
Trond Myklebust47c716c2010-12-07 12:44:56 -0500335 if (array->eof_index >= 0) {
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500336 status = -EBADCOOKIE;
Trond Myklebust18fb5fe2010-12-07 12:41:58 -0500337 if (*desc->dir_cookie == array->last_cookie)
Thomas Meyer6089dd02017-10-07 16:02:21 +0200338 desc->eof = true;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500339 }
Trond Myklebust0c030802011-07-30 12:45:35 -0400340out:
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400341 return status;
342}
343
344static
345int nfs_readdir_search_array(nfs_readdir_descriptor_t *desc)
346{
347 struct nfs_cache_array *array;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500348 int status;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400349
Fabian Frederick0795bf82017-05-03 20:52:21 +0200350 array = kmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400351
352 if (*desc->dir_cookie == 0)
353 status = nfs_readdir_search_for_pos(array, desc);
354 else
355 status = nfs_readdir_search_for_cookie(array, desc);
356
Trond Myklebust47c716c2010-12-07 12:44:56 -0500357 if (status == -EAGAIN) {
Trond Myklebust0aded702010-11-30 21:56:32 -0500358 desc->last_cookie = array->last_cookie;
Trond Myklebuste47c0852011-03-23 08:43:09 -0400359 desc->current_index += array->size;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500360 desc->page_index++;
361 }
Fabian Frederick0795bf82017-05-03 20:52:21 +0200362 kunmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400363 return status;
364}
365
366/* Fill a page with xdr information before transferring to the cache page */
367static
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400368int nfs_readdir_xdr_filler(struct page **pages, nfs_readdir_descriptor_t *desc,
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400369 struct nfs_entry *entry, struct file *file, struct inode *inode)
370{
Bryan Schumaker480c2002011-03-23 14:48:29 -0400371 struct nfs_open_dir_context *ctx = file->private_data;
NeilBrown684f39b2018-12-03 11:30:30 +1100372 const struct cred *cred = ctx->cred;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400373 unsigned long timestamp, gencount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 int error;
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 again:
377 timestamp = jiffies;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400378 gencount = nfs_inc_attr_generation_counter();
Trond Myklebusta1147b82020-02-05 09:01:52 -0500379 desc->dir_verifier = nfs_save_change_attribute(inode);
Miklos Szeredibe62a1a2016-03-26 16:14:39 -0400380 error = NFS_PROTO(inode)->readdir(file_dentry(file), cred, entry->cookie, pages,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 NFS_SERVER(inode)->dtsize, desc->plus);
382 if (error < 0) {
383 /* We requested READDIRPLUS, but the server doesn't grok it */
384 if (error == -ENOTSUPP && desc->plus) {
385 NFS_SERVER(inode)->caps &= ~NFS_CAP_READDIRPLUS;
Benny Halevy3a10c302008-01-23 08:58:59 +0200386 clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400387 desc->plus = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 goto again;
389 }
390 goto error;
391 }
Neil Brown1f4eab72007-04-16 09:35:27 +1000392 desc->timestamp = timestamp;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400393 desc->gencount = gencount;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400394error:
395 return error;
396}
397
Chuck Lever573c4e12010-12-14 14:58:11 +0000398static int xdr_decode(nfs_readdir_descriptor_t *desc,
399 struct nfs_entry *entry, struct xdr_stream *xdr)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400400{
Trond Myklebust59e356a2020-02-03 14:49:33 -0500401 struct inode *inode = file_inode(desc->file);
Chuck Lever573c4e12010-12-14 14:58:11 +0000402 int error;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400403
Trond Myklebust59e356a2020-02-03 14:49:33 -0500404 error = NFS_PROTO(inode)->decode_dirent(xdr, entry, desc->plus);
Chuck Lever573c4e12010-12-14 14:58:11 +0000405 if (error)
406 return error;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400407 entry->fattr->time_start = desc->timestamp;
408 entry->fattr->gencount = desc->gencount;
409 return 0;
410}
411
Trond Myklebustfa923362015-02-23 18:51:32 -0500412/* Match file and dirent using either filehandle or fileid
413 * Note: caller is responsible for checking the fsid
414 */
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400415static
416int nfs_same_file(struct dentry *dentry, struct nfs_entry *entry)
417{
Trond Myklebustd8fdb472016-06-17 16:48:27 -0400418 struct inode *inode;
Trond Myklebustfa923362015-02-23 18:51:32 -0500419 struct nfs_inode *nfsi;
420
David Howells2b0143b2015-03-17 22:25:59 +0000421 if (d_really_is_negative(dentry))
422 return 0;
Trond Myklebustfa923362015-02-23 18:51:32 -0500423
Trond Myklebustd8fdb472016-06-17 16:48:27 -0400424 inode = d_inode(dentry);
425 if (is_bad_inode(inode) || NFS_STALE(inode))
426 return 0;
427
428 nfsi = NFS_I(inode);
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400429 if (entry->fattr->fileid != nfsi->fileid)
430 return 0;
431 if (entry->fh->size && nfs_compare_fh(entry->fh, &nfsi->fh) != 0)
432 return 0;
433 return 1;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400434}
435
436static
Al Viro23db8622013-05-17 16:34:50 -0400437bool nfs_use_readdirplus(struct inode *dir, struct dir_context *ctx)
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400438{
439 if (!nfs_server_capable(dir, NFS_CAP_READDIRPLUS))
440 return false;
441 if (test_and_clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(dir)->flags))
442 return true;
Al Viro23db8622013-05-17 16:34:50 -0400443 if (ctx->pos == 0)
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400444 return true;
445 return false;
446}
447
448/*
Trond Myklebust63519fb2016-11-19 11:21:54 -0500449 * This function is called by the lookup and getattr code to request the
450 * use of readdirplus to accelerate any future lookups in the same
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400451 * directory.
452 */
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400453void nfs_advise_use_readdirplus(struct inode *dir)
454{
Trond Myklebust63519fb2016-11-19 11:21:54 -0500455 struct nfs_inode *nfsi = NFS_I(dir);
456
457 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
458 !list_empty(&nfsi->open_files))
459 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400460}
461
Trond Myklebust311324a2014-02-07 17:02:08 -0500462/*
463 * This function is mainly for use by nfs_getattr().
464 *
465 * If this is an 'ls -l', we want to force use of readdirplus.
466 * Do this by checking if there is an active file descriptor
467 * and calling nfs_advise_use_readdirplus, then forcing a
468 * cache flush.
469 */
470void nfs_force_use_readdirplus(struct inode *dir)
471{
Trond Myklebust63519fb2016-11-19 11:21:54 -0500472 struct nfs_inode *nfsi = NFS_I(dir);
473
474 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
475 !list_empty(&nfsi->open_files)) {
476 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Dai Ngo227823d2020-01-22 20:45:39 -0500477 invalidate_mapping_pages(dir->i_mapping,
478 nfsi->page_index + 1, -1);
Trond Myklebust311324a2014-02-07 17:02:08 -0500479 }
480}
481
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400482static
Trond Myklebusta1147b82020-02-05 09:01:52 -0500483void nfs_prime_dcache(struct dentry *parent, struct nfs_entry *entry,
484 unsigned long dir_verifier)
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400485{
Linus Torvalds26fe5752012-05-10 13:14:12 -0700486 struct qstr filename = QSTR_INIT(entry->name, entry->len);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400487 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400488 struct dentry *dentry;
489 struct dentry *alias;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400490 struct inode *inode;
David Quigleyaa9c2662013-05-22 12:50:44 -0400491 int status;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400492
Trond Myklebustfa923362015-02-23 18:51:32 -0500493 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FILEID))
494 return;
Trond Myklebust6c441c22015-02-22 16:35:36 -0500495 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FSID))
496 return;
Trond Myklebust78d04af2016-09-20 14:34:24 -0400497 if (filename.len == 0)
498 return;
499 /* Validate that the name doesn't contain any illegal '\0' */
500 if (strnlen(filename.name, filename.len) != filename.len)
501 return;
502 /* ...or '/' */
503 if (strnchr(filename.name, filename.len, '/'))
504 return;
Trond Myklebust4a201d62010-10-23 14:53:23 -0400505 if (filename.name[0] == '.') {
506 if (filename.len == 1)
507 return;
508 if (filename.len == 2 && filename.name[1] == '.')
509 return;
510 }
Linus Torvalds8387ff22016-06-10 07:51:30 -0700511 filename.hash = full_name_hash(parent, filename.name, filename.len);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400512
Trond Myklebust4a201d62010-10-23 14:53:23 -0400513 dentry = d_lookup(parent, &filename);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400514again:
515 if (!dentry) {
516 dentry = d_alloc_parallel(parent, &filename, &wq);
517 if (IS_ERR(dentry))
518 return;
519 }
520 if (!d_in_lookup(dentry)) {
Trond Myklebust6c441c22015-02-22 16:35:36 -0500521 /* Is there a mountpoint here? If so, just exit */
522 if (!nfs_fsid_equal(&NFS_SB(dentry->d_sb)->fsid,
523 &entry->fattr->fsid))
524 goto out;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400525 if (nfs_same_file(dentry, entry)) {
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400526 if (!entry->fh->size)
527 goto out;
Trond Myklebusta1147b82020-02-05 09:01:52 -0500528 nfs_set_verifier(dentry, dir_verifier);
David Howells2b0143b2015-03-17 22:25:59 +0000529 status = nfs_refresh_inode(d_inode(dentry), entry->fattr);
David Quigleyaa9c2662013-05-22 12:50:44 -0400530 if (!status)
David Howells2b0143b2015-03-17 22:25:59 +0000531 nfs_setsecurity(d_inode(dentry), entry->fattr, entry->label);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400532 goto out;
533 } else {
Eric W. Biederman5542aa22014-02-13 09:46:25 -0800534 d_invalidate(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400535 dput(dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400536 dentry = NULL;
537 goto again;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400538 }
539 }
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400540 if (!entry->fh->size) {
541 d_lookup_done(dentry);
542 goto out;
543 }
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400544
David Quigley1775fd32013-05-22 12:50:42 -0400545 inode = nfs_fhget(dentry->d_sb, entry->fh, entry->fattr, entry->label);
Al Viro41d28bc2014-10-12 22:24:21 -0400546 alias = d_splice_alias(inode, dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400547 d_lookup_done(dentry);
548 if (alias) {
549 if (IS_ERR(alias))
550 goto out;
551 dput(dentry);
552 dentry = alias;
553 }
Trond Myklebusta1147b82020-02-05 09:01:52 -0500554 nfs_set_verifier(dentry, dir_verifier);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400555out:
556 dput(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400557}
558
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400559/* Perform conversion from xdr to cache array */
560static
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500561int nfs_readdir_page_filler(nfs_readdir_descriptor_t *desc, struct nfs_entry *entry,
Trond Myklebust66502392011-01-08 17:45:38 -0500562 struct page **xdr_pages, struct page *page, unsigned int buflen)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400563{
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400564 struct xdr_stream stream;
Benny Halevyf7da7a12011-05-19 14:16:47 -0400565 struct xdr_buf buf;
Trond Myklebust66502392011-01-08 17:45:38 -0500566 struct page *scratch;
Bryan Schumaker99424382010-10-21 16:33:16 -0400567 struct nfs_cache_array *array;
Trond Myklebust5c346852010-11-20 12:43:45 -0500568 unsigned int count = 0;
569 int status;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400570
Trond Myklebust66502392011-01-08 17:45:38 -0500571 scratch = alloc_page(GFP_KERNEL);
572 if (scratch == NULL)
573 return -ENOMEM;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400574
Benjamin Coddingtonce85cfb2015-04-21 14:17:35 -0400575 if (buflen == 0)
576 goto out_nopages;
577
Benny Halevyf7da7a12011-05-19 14:16:47 -0400578 xdr_init_decode_pages(&stream, &buf, xdr_pages, buflen);
Trond Myklebust66502392011-01-08 17:45:38 -0500579 xdr_set_scratch_buffer(&stream, page_address(scratch), PAGE_SIZE);
Bryan Schumaker99424382010-10-21 16:33:16 -0400580
581 do {
Jeffrey Mitchelld33030e2020-09-15 16:42:52 -0500582 if (entry->label)
583 entry->label->len = NFS4_MAXLABELLEN;
584
Bryan Schumaker99424382010-10-21 16:33:16 -0400585 status = xdr_decode(desc, entry, &stream);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500586 if (status != 0) {
587 if (status == -EAGAIN)
588 status = 0;
Bryan Schumaker99424382010-10-21 16:33:16 -0400589 break;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500590 }
Bryan Schumaker99424382010-10-21 16:33:16 -0400591
Trond Myklebust5c346852010-11-20 12:43:45 -0500592 count++;
593
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400594 if (desc->plus)
Trond Myklebusta1147b82020-02-05 09:01:52 -0500595 nfs_prime_dcache(file_dentry(desc->file), entry,
596 desc->dir_verifier);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500597
Max Kellermanndb531db2019-07-12 16:18:06 +0200598 status = nfs_readdir_add_to_array(entry, page);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500599 if (status != 0)
600 break;
Bryan Schumaker99424382010-10-21 16:33:16 -0400601 } while (!entry->eof);
602
Benjamin Coddingtonce85cfb2015-04-21 14:17:35 -0400603out_nopages:
Trond Myklebust47c716c2010-12-07 12:44:56 -0500604 if (count == 0 || (status == -EBADCOOKIE && entry->eof != 0)) {
Max Kellermanndb531db2019-07-12 16:18:06 +0200605 array = kmap(page);
Fabian Frederick0795bf82017-05-03 20:52:21 +0200606 array->eof_index = array->size;
607 status = 0;
Max Kellermanndb531db2019-07-12 16:18:06 +0200608 kunmap(page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400609 }
Trond Myklebust66502392011-01-08 17:45:38 -0500610
611 put_page(scratch);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500612 return status;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400613}
614
615static
Anna Schumakerc7e96682015-07-13 14:01:25 -0400616void nfs_readdir_free_pages(struct page **pages, unsigned int npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400617{
618 unsigned int i;
619 for (i = 0; i < npages; i++)
620 put_page(pages[i]);
621}
622
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400623/*
zhangliguangbf211ca2019-02-16 08:38:40 +0800624 * nfs_readdir_alloc_pages() will allocate pages that must be freed with a call
625 * to nfs_readdir_free_pages()
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400626 */
627static
Anna Schumakerc7e96682015-07-13 14:01:25 -0400628int nfs_readdir_alloc_pages(struct page **pages, unsigned int npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400629{
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400630 unsigned int i;
631
632 for (i = 0; i < npages; i++) {
633 struct page *page = alloc_page(GFP_KERNEL);
634 if (page == NULL)
635 goto out_freepages;
636 pages[i] = page;
637 }
Trond Myklebust66502392011-01-08 17:45:38 -0500638 return 0;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400639
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400640out_freepages:
Anna Schumakerc7e96682015-07-13 14:01:25 -0400641 nfs_readdir_free_pages(pages, i);
Trond Myklebust66502392011-01-08 17:45:38 -0500642 return -ENOMEM;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400643}
644
645static
646int nfs_readdir_xdr_to_array(nfs_readdir_descriptor_t *desc, struct page *page, struct inode *inode)
647{
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400648 struct page *pages[NFS_MAX_READDIR_PAGES];
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400649 struct nfs_entry entry;
650 struct file *file = desc->file;
651 struct nfs_cache_array *array;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500652 int status = -ENOMEM;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400653 unsigned int array_size = ARRAY_SIZE(pages);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400654
Trond Myklebust4b310312020-02-02 17:53:53 -0500655 nfs_readdir_init_array(page);
656
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400657 entry.prev_cookie = 0;
Trond Myklebust0aded702010-11-30 21:56:32 -0500658 entry.cookie = desc->last_cookie;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400659 entry.eof = 0;
660 entry.fh = nfs_alloc_fhandle();
661 entry.fattr = nfs_alloc_fattr();
Chuck Lever573c4e12010-12-14 14:58:11 +0000662 entry.server = NFS_SERVER(inode);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400663 if (entry.fh == NULL || entry.fattr == NULL)
664 goto out;
665
David Quigley14c43f72013-05-22 12:50:43 -0400666 entry.label = nfs4_label_alloc(NFS_SERVER(inode), GFP_NOWAIT);
667 if (IS_ERR(entry.label)) {
668 status = PTR_ERR(entry.label);
669 goto out;
670 }
671
Fabian Frederick0795bf82017-05-03 20:52:21 +0200672 array = kmap(page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400673
Anna Schumakerc7e96682015-07-13 14:01:25 -0400674 status = nfs_readdir_alloc_pages(pages, array_size);
Trond Myklebust66502392011-01-08 17:45:38 -0500675 if (status < 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400676 goto out_release_array;
677 do {
Trond Myklebustac396122010-11-15 20:26:22 -0500678 unsigned int pglen;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400679 status = nfs_readdir_xdr_filler(pages, desc, &entry, file, inode);
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400680
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400681 if (status < 0)
682 break;
Trond Myklebustac396122010-11-15 20:26:22 -0500683 pglen = status;
Trond Myklebust66502392011-01-08 17:45:38 -0500684 status = nfs_readdir_page_filler(desc, &entry, pages, page, pglen);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500685 if (status < 0) {
686 if (status == -ENOSPC)
687 status = 0;
688 break;
689 }
690 } while (array->eof_index < 0);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400691
Anna Schumakerc7e96682015-07-13 14:01:25 -0400692 nfs_readdir_free_pages(pages, array_size);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400693out_release_array:
Fabian Frederick0795bf82017-05-03 20:52:21 +0200694 kunmap(page);
David Quigley14c43f72013-05-22 12:50:43 -0400695 nfs4_label_free(entry.label);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400696out:
697 nfs_free_fattr(entry.fattr);
698 nfs_free_fhandle(entry.fh);
699 return status;
700}
701
702/*
703 * Now we cache directories properly, by converting xdr information
704 * to an array that can be used for lookups later. This results in
705 * fewer cache pages, since we can store more information on each page.
706 * We only need to convert from xdr once so future lookups are much simpler
707 */
708static
Christoph Hellwiga46126c2019-05-01 12:06:35 -0400709int nfs_readdir_filler(void *data, struct page* page)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400710{
Christoph Hellwiga46126c2019-05-01 12:06:35 -0400711 nfs_readdir_descriptor_t *desc = data;
Al Viro496ad9a2013-01-23 17:07:38 -0500712 struct inode *inode = file_inode(desc->file);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500713 int ret;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400714
Max Kellermanndb531db2019-07-12 16:18:06 +0200715 ret = nfs_readdir_xdr_to_array(desc, page, inode);
716 if (ret < 0)
717 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 SetPageUptodate(page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400719
Trond Myklebust2aac05a2008-07-07 13:26:10 -0400720 if (invalidate_inode_pages2_range(inode->i_mapping, page->index + 1, -1) < 0) {
Trond Myklebustcd9ae2b2006-10-19 23:28:40 -0700721 /* Should never happen */
722 nfs_zap_mapping(inode, inode->i_mapping);
723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 unlock_page(page);
725 return 0;
726 error:
Trond Myklebust4b310312020-02-02 17:53:53 -0500727 nfs_readdir_clear_array(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 unlock_page(page);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500729 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730}
731
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400732static
733void cache_page_release(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300735 put_page(desc->page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 desc->page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737}
738
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400739static
740struct page *get_cache_page(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{
Christoph Hellwiga46126c2019-05-01 12:06:35 -0400742 return read_cache_page(desc->file->f_mapping, desc->page_index,
743 nfs_readdir_filler, desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744}
745
746/*
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400747 * Returns 0 if desc->dir_cookie was found on page desc->page_index
Trond Myklebust114de382020-02-02 17:53:54 -0500748 * and locks the page to prevent removal from the page cache.
Olivier Galibert00a92642005-06-22 17:16:29 +0000749 */
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400750static
Trond Myklebust114de382020-02-02 17:53:54 -0500751int find_and_lock_cache_page(nfs_readdir_descriptor_t *desc)
Olivier Galibert00a92642005-06-22 17:16:29 +0000752{
Dai Ngo227823d2020-01-22 20:45:39 -0500753 struct inode *inode = file_inode(desc->file);
754 struct nfs_inode *nfsi = NFS_I(inode);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400755 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000756
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400757 desc->page = get_cache_page(desc);
758 if (IS_ERR(desc->page))
759 return PTR_ERR(desc->page);
Trond Myklebust114de382020-02-02 17:53:54 -0500760 res = lock_page_killable(desc->page);
Trond Myklebust47c716c2010-12-07 12:44:56 -0500761 if (res != 0)
Trond Myklebust114de382020-02-02 17:53:54 -0500762 goto error;
763 res = -EAGAIN;
764 if (desc->page->mapping != NULL) {
765 res = nfs_readdir_search_array(desc);
Dai Ngo227823d2020-01-22 20:45:39 -0500766 if (res == 0) {
767 nfsi->page_index = desc->page_index;
Trond Myklebust114de382020-02-02 17:53:54 -0500768 return 0;
Dai Ngo227823d2020-01-22 20:45:39 -0500769 }
Trond Myklebust114de382020-02-02 17:53:54 -0500770 }
771 unlock_page(desc->page);
772error:
773 cache_page_release(desc);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400774 return res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000775}
776
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400777/* Search for desc->dir_cookie from the beginning of the page cache */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778static inline
779int readdir_search_pagecache(nfs_readdir_descriptor_t *desc)
780{
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500781 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000782
Trond Myklebust0aded702010-11-30 21:56:32 -0500783 if (desc->page_index == 0) {
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500784 desc->current_index = 0;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500785 desc->prev_index = 0;
Trond Myklebust0aded702010-11-30 21:56:32 -0500786 desc->last_cookie = 0;
787 }
Trond Myklebust47c716c2010-12-07 12:44:56 -0500788 do {
Trond Myklebust114de382020-02-02 17:53:54 -0500789 res = find_and_lock_cache_page(desc);
Trond Myklebust47c716c2010-12-07 12:44:56 -0500790 } while (res == -EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 return res;
792}
793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794/*
795 * Once we've found the start of the dirent within a page: fill 'er up...
796 */
797static
Al Viro23db8622013-05-17 16:34:50 -0400798int nfs_do_filldir(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
800 struct file *file = desc->file;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400801 int i = 0;
802 int res = 0;
803 struct nfs_cache_array *array = NULL;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400804 struct nfs_open_dir_context *ctx = file->private_data;
805
Fabian Frederick0795bf82017-05-03 20:52:21 +0200806 array = kmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400807 for (i = desc->cache_entry_index; i < array->size; i++) {
Trond Myklebustece0b422010-11-20 13:55:33 -0500808 struct nfs_cache_array_entry *ent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Trond Myklebustece0b422010-11-20 13:55:33 -0500810 ent = &array->array[i];
Al Viro23db8622013-05-17 16:34:50 -0400811 if (!dir_emit(desc->ctx, ent->string.name, ent->string.len,
812 nfs_compat_user_ino64(ent->ino), ent->d_type)) {
Thomas Meyer6089dd02017-10-07 16:02:21 +0200813 desc->eof = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 break;
Trond Myklebustece0b422010-11-20 13:55:33 -0500815 }
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400816 if (i < (array->size-1))
817 *desc->dir_cookie = array->array[i+1].cookie;
818 else
819 *desc->dir_cookie = array->last_cookie;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500820 if (nfs_readdir_use_cookie(file))
821 desc->ctx->pos = *desc->dir_cookie;
822 else
823 desc->ctx->pos++;
Trond Myklebust0c030802011-07-30 12:45:35 -0400824 if (ctx->duped != 0)
825 ctx->duped = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 }
Trond Myklebust47c716c2010-12-07 12:44:56 -0500827 if (array->eof_index >= 0)
Thomas Meyer6089dd02017-10-07 16:02:21 +0200828 desc->eof = true;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400829
Fabian Frederick0795bf82017-05-03 20:52:21 +0200830 kunmap(desc->page);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500831 dfprintk(DIRCACHE, "NFS: nfs_do_filldir() filling ended @ cookie %Lu; returning = %d\n",
832 (unsigned long long)*desc->dir_cookie, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 return res;
834}
835
836/*
837 * If we cannot find a cookie in our cache, we suspect that this is
838 * because it points to a deleted file, so we ask the server to return
839 * whatever it thinks is the next entry. We then feed this to filldir.
840 * If all goes well, we should then be able to find our way round the
841 * cache on the next call to readdir_search_pagecache();
842 *
843 * NOTE: we cannot add the anonymous page to the pagecache because
844 * the data it contains might not be page aligned. Besides,
845 * we should already have a complete representation of the
846 * directory in the page cache by the time we get here.
847 */
848static inline
Al Viro23db8622013-05-17 16:34:50 -0400849int uncached_readdir(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 struct page *page = NULL;
852 int status;
Al Viro496ad9a2013-01-23 17:07:38 -0500853 struct inode *inode = file_inode(desc->file);
Trond Myklebust0c030802011-07-30 12:45:35 -0400854 struct nfs_open_dir_context *ctx = desc->file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500856 dfprintk(DIRCACHE, "NFS: uncached_readdir() searching for cookie %Lu\n",
857 (unsigned long long)*desc->dir_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
859 page = alloc_page(GFP_HIGHUSER);
860 if (!page) {
861 status = -ENOMEM;
862 goto out;
863 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -0500865 desc->page_index = 0;
Trond Myklebust0aded702010-11-30 21:56:32 -0500866 desc->last_cookie = *desc->dir_cookie;
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -0500867 desc->page = page;
Trond Myklebust0c030802011-07-30 12:45:35 -0400868 ctx->duped = 0;
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -0500869
Trond Myklebust85f86072010-11-20 13:24:49 -0500870 status = nfs_readdir_xdr_to_array(desc, page, inode);
871 if (status < 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400872 goto out_release;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400873
Al Viro23db8622013-05-17 16:34:50 -0400874 status = nfs_do_filldir(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875
Trond Myklebust114de382020-02-02 17:53:54 -0500876 out_release:
877 nfs_readdir_clear_array(desc->page);
878 cache_page_release(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 out:
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500880 dfprintk(DIRCACHE, "NFS: %s: returns %d\n",
Harvey Harrison3110ff82008-05-02 13:42:44 -0700881 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
884
Olivier Galibert00a92642005-06-22 17:16:29 +0000885/* The file offset position represents the dirent entry number. A
886 last cookie cache takes care of the common case of reading the
887 whole directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 */
Al Viro23db8622013-05-17 16:34:50 -0400889static int nfs_readdir(struct file *file, struct dir_context *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890{
Miklos Szeredibe62a1a2016-03-26 16:14:39 -0400891 struct dentry *dentry = file_dentry(file);
David Howells2b0143b2015-03-17 22:25:59 +0000892 struct inode *inode = d_inode(dentry);
Al Viro23db8622013-05-17 16:34:50 -0400893 struct nfs_open_dir_context *dir_ctx = file->private_data;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500894 nfs_readdir_descriptor_t my_desc = {
895 .file = file,
896 .ctx = ctx,
897 .dir_cookie = &dir_ctx->dir_cookie,
898 .plus = nfs_use_readdirplus(inode, ctx),
899 },
900 *desc = &my_desc;
Scott Mayhew07b5ce82013-07-05 17:49:31 -0400901 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Al Viro6de14722013-09-16 10:53:17 -0400903 dfprintk(FILE, "NFS: readdir(%pD2) starting at cookie %llu\n",
904 file, (long long)ctx->pos);
Chuck Lever91d5b472006-03-20 13:44:14 -0500905 nfs_inc_stats(inode, NFSIOS_VFSGETDENTS);
906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 /*
Al Viro23db8622013-05-17 16:34:50 -0400908 * ctx->pos points to the dirent entry number.
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000909 * *desc->dir_cookie has the cookie for the next entry. We have
Olivier Galibert00a92642005-06-22 17:16:29 +0000910 * to either find the entry with the appropriate number or
911 * revalidate the cookie.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 */
Trond Myklebust79f687a32016-11-19 10:54:55 -0500913 if (ctx->pos == 0 || nfs_attribute_cache_expired(inode))
Scott Mayhew07b5ce82013-07-05 17:49:31 -0400914 res = nfs_revalidate_mapping(inode, file->f_mapping);
Trond Myklebustfccca7f2008-01-26 17:37:47 -0500915 if (res < 0)
916 goto out;
917
Trond Myklebust47c716c2010-12-07 12:44:56 -0500918 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 res = readdir_search_pagecache(desc);
Olivier Galibert00a92642005-06-22 17:16:29 +0000920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 if (res == -EBADCOOKIE) {
Trond Myklebustece0b422010-11-20 13:55:33 -0500922 res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 /* This means either end of directory */
Thomas Meyer6089dd02017-10-07 16:02:21 +0200924 if (*desc->dir_cookie && !desc->eof) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 /* Or that the server has 'lost' a cookie */
Al Viro23db8622013-05-17 16:34:50 -0400926 res = uncached_readdir(desc);
Trond Myklebustece0b422010-11-20 13:55:33 -0500927 if (res == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 continue;
929 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 break;
931 }
932 if (res == -ETOOSMALL && desc->plus) {
Benny Halevy3a10c302008-01-23 08:58:59 +0200933 clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 nfs_zap_caches(inode);
Trond Myklebustbaf57a02010-09-24 18:49:43 -0400935 desc->page_index = 0;
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400936 desc->plus = false;
937 desc->eof = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 continue;
939 }
940 if (res < 0)
941 break;
942
Al Viro23db8622013-05-17 16:34:50 -0400943 res = nfs_do_filldir(desc);
Trond Myklebust114de382020-02-02 17:53:54 -0500944 unlock_page(desc->page);
945 cache_page_release(desc);
Trond Myklebustece0b422010-11-20 13:55:33 -0500946 if (res < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 break;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500948 } while (!desc->eof);
Trond Myklebustfccca7f2008-01-26 17:37:47 -0500949out:
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500950 if (res > 0)
951 res = 0;
Al Viro6de14722013-09-16 10:53:17 -0400952 dfprintk(FILE, "NFS: readdir(%pD2) returns %d\n", file, res);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500953 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954}
955
Andrew Morton965c8e52012-12-17 15:59:39 -0800956static loff_t nfs_llseek_dir(struct file *filp, loff_t offset, int whence)
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000957{
Bryan Schumaker480c2002011-03-23 14:48:29 -0400958 struct nfs_open_dir_context *dir_ctx = filp->private_data;
Chuck Leverb84e06c2008-06-11 17:55:34 -0400959
Al Viro6de14722013-09-16 10:53:17 -0400960 dfprintk(FILE, "NFS: llseek dir(%pD2, %lld, %d)\n",
961 filp, offset, whence);
Chuck Leverb84e06c2008-06-11 17:55:34 -0400962
Andrew Morton965c8e52012-12-17 15:59:39 -0800963 switch (whence) {
Trond Myklebustb2b1ff32018-06-27 16:25:40 -0400964 default:
965 return -EINVAL;
966 case SEEK_SET:
967 if (offset < 0)
968 return -EINVAL;
Trond Myklebust83f2c452020-10-30 17:57:29 -0400969 spin_lock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -0400970 break;
971 case SEEK_CUR:
972 if (offset == 0)
973 return filp->f_pos;
Trond Myklebust83f2c452020-10-30 17:57:29 -0400974 spin_lock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -0400975 offset += filp->f_pos;
976 if (offset < 0) {
Trond Myklebust83f2c452020-10-30 17:57:29 -0400977 spin_unlock(&filp->f_lock);
Trond Myklebustb2b1ff32018-06-27 16:25:40 -0400978 return -EINVAL;
979 }
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000980 }
981 if (offset != filp->f_pos) {
982 filp->f_pos = offset;
Trond Myklebust59e356a2020-02-03 14:49:33 -0500983 if (nfs_readdir_use_cookie(filp))
984 dir_ctx->dir_cookie = offset;
985 else
986 dir_ctx->dir_cookie = 0;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400987 dir_ctx->duped = 0;
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000988 }
Trond Myklebust83f2c452020-10-30 17:57:29 -0400989 spin_unlock(&filp->f_lock);
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000990 return offset;
991}
992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993/*
994 * All directory operations under NFS are synchronous, so fsync()
995 * is a dummy operation.
996 */
Josef Bacik02c24a82011-07-16 20:44:56 -0400997static int nfs_fsync_dir(struct file *filp, loff_t start, loff_t end,
998 int datasync)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999{
Al Viro6de14722013-09-16 10:53:17 -04001000 struct inode *inode = file_inode(filp);
Christoph Hellwig7ea80852010-05-26 17:53:25 +02001001
Al Viro6de14722013-09-16 10:53:17 -04001002 dfprintk(FILE, "NFS: fsync dir(%pD2) datasync %d\n", filp, datasync);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001003
Al Viro59551022016-01-22 15:40:57 -05001004 inode_lock(inode);
Al Viro6de14722013-09-16 10:53:17 -04001005 nfs_inc_stats(inode, NFSIOS_VFSFSYNC);
Al Viro59551022016-01-22 15:40:57 -05001006 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 return 0;
1008}
1009
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001010/**
1011 * nfs_force_lookup_revalidate - Mark the directory as having changed
Trond Myklebust302fad72019-02-18 13:32:38 -05001012 * @dir: pointer to directory inode
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001013 *
1014 * This forces the revalidation code in nfs_lookup_revalidate() to do a
1015 * full lookup on all child dentries of 'dir' whenever a change occurs
1016 * on the server that might have invalidated our dcache.
1017 *
Trond Myklebustefeda802020-02-05 09:01:54 -05001018 * Note that we reserve bit '0' as a tag to let us know when a dentry
1019 * was revalidated while holding a delegation on its inode.
1020 *
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001021 * The caller should be holding dir->i_lock
1022 */
1023void nfs_force_lookup_revalidate(struct inode *dir)
1024{
Trond Myklebustefeda802020-02-05 09:01:54 -05001025 NFS_I(dir)->cache_change_attribute += 2;
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001026}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001027EXPORT_SYMBOL_GPL(nfs_force_lookup_revalidate);
Trond Myklebustbfc69a42007-10-15 18:18:29 -04001028
Trond Myklebustefeda802020-02-05 09:01:54 -05001029/**
1030 * nfs_verify_change_attribute - Detects NFS remote directory changes
1031 * @dir: pointer to parent directory inode
1032 * @verf: previously saved change attribute
1033 *
1034 * Return "false" if the verifiers doesn't match the change attribute.
1035 * This would usually indicate that the directory contents have changed on
1036 * the server, and that any dentries need revalidating.
1037 */
1038static bool nfs_verify_change_attribute(struct inode *dir, unsigned long verf)
1039{
1040 return (verf & ~1UL) == nfs_save_change_attribute(dir);
1041}
1042
1043static void nfs_set_verifier_delegated(unsigned long *verf)
1044{
1045 *verf |= 1UL;
1046}
1047
1048#if IS_ENABLED(CONFIG_NFS_V4)
1049static void nfs_unset_verifier_delegated(unsigned long *verf)
1050{
1051 *verf &= ~1UL;
1052}
1053#endif /* IS_ENABLED(CONFIG_NFS_V4) */
1054
1055static bool nfs_test_verifier_delegated(unsigned long verf)
1056{
1057 return verf & 1;
1058}
1059
1060static bool nfs_verifier_is_delegated(struct dentry *dentry)
1061{
1062 return nfs_test_verifier_delegated(dentry->d_time);
1063}
1064
1065static void nfs_set_verifier_locked(struct dentry *dentry, unsigned long verf)
1066{
1067 struct inode *inode = d_inode(dentry);
1068
1069 if (!nfs_verifier_is_delegated(dentry) &&
1070 !nfs_verify_change_attribute(d_inode(dentry->d_parent), verf))
1071 goto out;
1072 if (inode && NFS_PROTO(inode)->have_delegation(inode, FMODE_READ))
1073 nfs_set_verifier_delegated(&verf);
1074out:
1075 dentry->d_time = verf;
1076}
1077
1078/**
1079 * nfs_set_verifier - save a parent directory verifier in the dentry
1080 * @dentry: pointer to dentry
1081 * @verf: verifier to save
1082 *
1083 * Saves the parent directory verifier in @dentry. If the inode has
1084 * a delegation, we also tag the dentry as having been revalidated
1085 * while holding a delegation so that we know we don't have to
1086 * look it up again after a directory change.
1087 */
1088void nfs_set_verifier(struct dentry *dentry, unsigned long verf)
1089{
1090
1091 spin_lock(&dentry->d_lock);
1092 nfs_set_verifier_locked(dentry, verf);
1093 spin_unlock(&dentry->d_lock);
1094}
1095EXPORT_SYMBOL_GPL(nfs_set_verifier);
1096
1097#if IS_ENABLED(CONFIG_NFS_V4)
1098/**
1099 * nfs_clear_verifier_delegated - clear the dir verifier delegation tag
1100 * @inode: pointer to inode
1101 *
1102 * Iterates through the dentries in the inode alias list and clears
1103 * the tag used to indicate that the dentry has been revalidated
1104 * while holding a delegation.
1105 * This function is intended for use when the delegation is being
1106 * returned or revoked.
1107 */
1108void nfs_clear_verifier_delegated(struct inode *inode)
1109{
1110 struct dentry *alias;
1111
1112 if (!inode)
1113 return;
1114 spin_lock(&inode->i_lock);
1115 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
1116 spin_lock(&alias->d_lock);
1117 nfs_unset_verifier_delegated(&alias->d_time);
1118 spin_unlock(&alias->d_lock);
1119 }
1120 spin_unlock(&inode->i_lock);
1121}
1122EXPORT_SYMBOL_GPL(nfs_clear_verifier_delegated);
1123#endif /* IS_ENABLED(CONFIG_NFS_V4) */
1124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125/*
1126 * A check for whether or not the parent directory has changed.
1127 * In the case it has, we assume that the dentries are untrustworthy
1128 * and may need to be looked up again.
NeilBrown912a1082014-07-14 11:28:20 +10001129 * If rcu_walk prevents us from performing a full check, return 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 */
NeilBrown912a1082014-07-14 11:28:20 +10001131static int nfs_check_verifier(struct inode *dir, struct dentry *dentry,
1132 int rcu_walk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133{
1134 if (IS_ROOT(dentry))
1135 return 1;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001136 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONE)
1137 return 0;
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001138 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1139 return 0;
1140 /* Revalidate nfsi->cache_change_attribute before we declare a match */
Trond Myklebust1cd9cb02016-12-04 18:34:34 -05001141 if (nfs_mapping_need_revalidate_inode(dir)) {
1142 if (rcu_walk)
1143 return 0;
1144 if (__nfs_revalidate_inode(NFS_SERVER(dir), dir) < 0)
1145 return 0;
1146 }
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001147 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1148 return 0;
1149 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150}
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152/*
Trond Myklebusta12802c2007-10-02 19:13:04 -04001153 * Use intent information to check whether or not we're going to do
1154 * an O_EXCL create using this path component.
1155 */
Al Virofa3c56b2012-06-10 15:36:40 -04001156static int nfs_is_exclusive_create(struct inode *dir, unsigned int flags)
Trond Myklebusta12802c2007-10-02 19:13:04 -04001157{
1158 if (NFS_PROTO(dir)->version == 2)
1159 return 0;
Al Virofa3c56b2012-06-10 15:36:40 -04001160 return flags & LOOKUP_EXCL;
Trond Myklebusta12802c2007-10-02 19:13:04 -04001161}
1162
1163/*
Trond Myklebust1d6757f2005-06-07 18:37:01 -04001164 * Inode and filehandle revalidation for lookups.
1165 *
1166 * We force revalidation in the cases where the VFS sets LOOKUP_REVAL,
1167 * or if the intent information indicates that we're about to open this
1168 * particular file and the "nocto" mount flag is not set.
1169 *
1170 */
Trond Myklebust65a0c142012-12-14 17:51:40 -05001171static
Al Virofa3c56b2012-06-10 15:36:40 -04001172int nfs_lookup_verify_inode(struct inode *inode, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173{
1174 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust65a0c142012-12-14 17:51:40 -05001175 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
David Howells36d43a42011-01-14 18:45:42 +00001177 if (IS_AUTOMOUNT(inode))
Trond Myklebust4e99a1f2008-03-06 12:34:59 -05001178 return 0;
Trond Myklebust47921922018-05-10 10:08:36 -04001179
1180 if (flags & LOOKUP_OPEN) {
1181 switch (inode->i_mode & S_IFMT) {
1182 case S_IFREG:
1183 /* A NFSv4 OPEN will revalidate later */
1184 if (server->caps & NFS_CAP_ATOMIC_OPEN)
1185 goto out;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001186 fallthrough;
Trond Myklebust47921922018-05-10 10:08:36 -04001187 case S_IFDIR:
1188 if (server->flags & NFS_MOUNT_NOCTO)
1189 break;
1190 /* NFS close-to-open cache consistency validation */
1191 goto out_force;
1192 }
1193 }
1194
Al Virofacc3532012-06-10 15:33:51 -04001195 /* VFS wants an on-the-wire revalidation */
Al Virofa3c56b2012-06-10 15:36:40 -04001196 if (flags & LOOKUP_REVAL)
Al Virofacc3532012-06-10 15:33:51 -04001197 goto out_force;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001198out:
Lance Sheltona61246c2018-07-16 13:05:36 -04001199 return (inode->i_nlink == 0) ? -ESTALE : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200out_force:
NeilBrown1fa1e382014-07-14 11:28:20 +10001201 if (flags & LOOKUP_RCU)
1202 return -ECHILD;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001203 ret = __nfs_revalidate_inode(server, inode);
1204 if (ret != 0)
1205 return ret;
1206 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207}
1208
1209/*
1210 * We judge how long we want to trust negative
1211 * dentries by looking at the parent inode mtime.
1212 *
1213 * If parent mtime has changed, we revalidate, else we wait for a
1214 * period corresponding to the parent's attribute cache timeout value.
NeilBrown912a1082014-07-14 11:28:20 +10001215 *
1216 * If LOOKUP_RCU prevents us from performing a full check, return 1
1217 * suggesting a reval is needed.
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001218 *
1219 * Note that when creating a new file, or looking up a rename target,
1220 * then it shouldn't be necessary to revalidate a negative dentry.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 */
1222static inline
1223int nfs_neg_need_reval(struct inode *dir, struct dentry *dentry,
Al Virofa3c56b2012-06-10 15:36:40 -04001224 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225{
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001226 if (flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 return 0;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001228 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONEG)
1229 return 1;
NeilBrown912a1082014-07-14 11:28:20 +10001230 return !nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231}
1232
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001233static int
1234nfs_lookup_revalidate_done(struct inode *dir, struct dentry *dentry,
1235 struct inode *inode, int error)
1236{
1237 switch (error) {
1238 case 1:
1239 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is valid\n",
1240 __func__, dentry);
1241 return 1;
1242 case 0:
1243 nfs_mark_for_revalidate(dir);
1244 if (inode && S_ISDIR(inode->i_mode)) {
1245 /* Purge readdir caches. */
1246 nfs_zap_caches(inode);
1247 /*
1248 * We can't d_drop the root of a disconnected tree:
1249 * its d_hash is on the s_anon list and d_drop() would hide
1250 * it from shrink_dcache_for_unmount(), leading to busy
1251 * inodes on unmount and further oopses.
1252 */
1253 if (IS_ROOT(dentry))
1254 return 1;
1255 }
1256 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is invalid\n",
1257 __func__, dentry);
1258 return 0;
1259 }
1260 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) lookup returned error %d\n",
1261 __func__, dentry, error);
1262 return error;
1263}
1264
1265static int
1266nfs_lookup_revalidate_negative(struct inode *dir, struct dentry *dentry,
1267 unsigned int flags)
1268{
1269 int ret = 1;
1270 if (nfs_neg_need_reval(dir, dentry, flags)) {
1271 if (flags & LOOKUP_RCU)
1272 return -ECHILD;
1273 ret = 0;
1274 }
1275 return nfs_lookup_revalidate_done(dir, dentry, NULL, ret);
1276}
1277
1278static int
1279nfs_lookup_revalidate_delegated(struct inode *dir, struct dentry *dentry,
1280 struct inode *inode)
1281{
1282 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1283 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1284}
1285
1286static int
1287nfs_lookup_revalidate_dentry(struct inode *dir, struct dentry *dentry,
1288 struct inode *inode)
1289{
1290 struct nfs_fh *fhandle;
1291 struct nfs_fattr *fattr;
1292 struct nfs4_label *label;
Trond Myklebusta1147b82020-02-05 09:01:52 -05001293 unsigned long dir_verifier;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001294 int ret;
1295
1296 ret = -ENOMEM;
1297 fhandle = nfs_alloc_fhandle();
1298 fattr = nfs_alloc_fattr();
1299 label = nfs4_label_alloc(NFS_SERVER(inode), GFP_KERNEL);
1300 if (fhandle == NULL || fattr == NULL || IS_ERR(label))
1301 goto out;
1302
Trond Myklebusta1147b82020-02-05 09:01:52 -05001303 dir_verifier = nfs_save_change_attribute(dir);
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001304 ret = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001305 if (ret < 0) {
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001306 switch (ret) {
1307 case -ESTALE:
1308 case -ENOENT:
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001309 ret = 0;
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001310 break;
1311 case -ETIMEDOUT:
1312 if (NFS_SERVER(inode)->flags & NFS_MOUNT_SOFTREVAL)
1313 ret = 1;
1314 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001315 goto out;
1316 }
1317 ret = 0;
1318 if (nfs_compare_fh(NFS_FH(inode), fhandle))
1319 goto out;
1320 if (nfs_refresh_inode(inode, fattr) < 0)
1321 goto out;
1322
1323 nfs_setsecurity(inode, fattr, label);
Trond Myklebusta1147b82020-02-05 09:01:52 -05001324 nfs_set_verifier(dentry, dir_verifier);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001325
1326 /* set a readdirplus hint that we had a cache miss */
1327 nfs_force_use_readdirplus(dir);
1328 ret = 1;
1329out:
1330 nfs_free_fattr(fattr);
1331 nfs_free_fhandle(fhandle);
1332 nfs4_label_free(label);
1333 return nfs_lookup_revalidate_done(dir, dentry, inode, ret);
1334}
1335
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336/*
1337 * This is called every time the dcache has a lookup hit,
1338 * and we should check whether we can really trust that
1339 * lookup.
1340 *
1341 * NOTE! The hit can be a negative hit too, don't assume
1342 * we have an inode!
1343 *
1344 * If the parent directory is seen to have changed, we throw out the
1345 * cached dentry and do a new lookup.
1346 */
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001347static int
1348nfs_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1349 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
Chuck Lever91d5b472006-03-20 13:44:14 -05001354 nfs_inc_stats(dir, NFSIOS_DENTRYREVALIDATE);
David Howells2b0143b2015-03-17 22:25:59 +00001355 inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001357 if (!inode)
1358 return nfs_lookup_revalidate_negative(dir, dentry, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359
1360 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001361 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1362 __func__, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 goto out_bad;
1364 }
1365
Trond Myklebustefeda802020-02-05 09:01:54 -05001366 if (nfs_verifier_is_delegated(dentry))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001367 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust15860ab2008-12-23 15:21:54 -05001368
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 /* Force a full look up iff the parent directory has changed */
Trond Myklebust73dd6842018-05-10 10:13:09 -04001370 if (!(flags & (LOOKUP_EXCL | LOOKUP_REVAL)) &&
NeilBrown912a1082014-07-14 11:28:20 +10001371 nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU)) {
NeilBrowncc896842017-07-05 12:22:20 +10001372 error = nfs_lookup_verify_inode(inode, flags);
1373 if (error) {
NeilBrowncc896842017-07-05 12:22:20 +10001374 if (error == -ESTALE)
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001375 nfs_zap_caches(dir);
1376 goto out_bad;
NeilBrown1fa1e382014-07-14 11:28:20 +10001377 }
Trond Myklebust63519fb2016-11-19 11:21:54 -05001378 nfs_advise_use_readdirplus(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 goto out_valid;
1380 }
1381
NeilBrown912a1082014-07-14 11:28:20 +10001382 if (flags & LOOKUP_RCU)
1383 return -ECHILD;
1384
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 if (NFS_STALE(inode))
1386 goto out_bad;
1387
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001388 trace_nfs_lookup_revalidate_enter(dir, dentry, flags);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001389 error = nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001390 trace_nfs_lookup_revalidate_exit(dir, dentry, flags, error);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001391 return error;
1392out_valid:
1393 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1394out_bad:
1395 if (flags & LOOKUP_RCU)
1396 return -ECHILD;
1397 return nfs_lookup_revalidate_done(dir, dentry, inode, 0);
1398}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001400static int
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001401__nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags,
1402 int (*reval)(struct inode *, struct dentry *, unsigned int))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001403{
1404 struct dentry *parent;
1405 struct inode *dir;
1406 int ret;
David Quigleyaa9c2662013-05-22 12:50:44 -04001407
NeilBrownd51ac1a2014-07-14 11:28:20 +10001408 if (flags & LOOKUP_RCU) {
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001409 parent = READ_ONCE(dentry->d_parent);
1410 dir = d_inode_rcu(parent);
1411 if (!dir)
1412 return -ECHILD;
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001413 ret = reval(dir, dentry, flags);
Mark Rutland6aa7de02017-10-23 14:07:29 -07001414 if (parent != READ_ONCE(dentry->d_parent))
NeilBrownd51ac1a2014-07-14 11:28:20 +10001415 return -ECHILD;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001416 } else {
1417 parent = dget_parent(dentry);
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001418 ret = reval(d_inode(parent), dentry, flags);
NeilBrownd51ac1a2014-07-14 11:28:20 +10001419 dput(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001421 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422}
1423
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001424static int nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1425{
1426 return __nfs_lookup_revalidate(dentry, flags, nfs_do_lookup_revalidate);
1427}
1428
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429/*
David Howells2b0143b2015-03-17 22:25:59 +00001430 * A weaker form of d_revalidate for revalidating just the d_inode(dentry)
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001431 * when we don't really care about the dentry name. This is called when a
1432 * pathwalk ends on a dentry that was not found via a normal lookup in the
1433 * parent dir (e.g.: ".", "..", procfs symlinks or mountpoint traversals).
1434 *
1435 * In this situation, we just want to verify that the inode itself is OK
1436 * since the dentry might have changed on the server.
1437 */
1438static int nfs_weak_revalidate(struct dentry *dentry, unsigned int flags)
1439{
David Howells2b0143b2015-03-17 22:25:59 +00001440 struct inode *inode = d_inode(dentry);
Trond Myklebust9cdd1d32016-12-16 18:04:47 -05001441 int error = 0;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001442
1443 /*
1444 * I believe we can only get a negative dentry here in the case of a
1445 * procfs-style symlink. Just assume it's correct for now, but we may
1446 * eventually need to do something more here.
1447 */
1448 if (!inode) {
Al Viro6de14722013-09-16 10:53:17 -04001449 dfprintk(LOOKUPCACHE, "%s: %pd2 has negative inode\n",
1450 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001451 return 1;
1452 }
1453
1454 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001455 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1456 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001457 return 0;
1458 }
1459
NeilBrownb6887412017-08-25 17:34:41 +10001460 error = nfs_lookup_verify_inode(inode, flags);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001461 dfprintk(LOOKUPCACHE, "NFS: %s: inode %lu is %s\n",
1462 __func__, inode->i_ino, error ? "invalid" : "valid");
1463 return !error;
1464}
1465
1466/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 * This is called from dput() when d_count is going to 0.
1468 */
Nick Pigginfe15ce42011-01-07 17:49:23 +11001469static int nfs_dentry_delete(const struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470{
Al Viro6de14722013-09-16 10:53:17 -04001471 dfprintk(VFS, "NFS: dentry_delete(%pd2, %x)\n",
1472 dentry, dentry->d_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Trond Myklebust77f11192008-01-28 19:43:19 -05001474 /* Unhash any dentry with a stale inode */
David Howells2b0143b2015-03-17 22:25:59 +00001475 if (d_really_is_positive(dentry) && NFS_STALE(d_inode(dentry)))
Trond Myklebust77f11192008-01-28 19:43:19 -05001476 return 1;
1477
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1479 /* Unhash it, so that ->d_iput() would be called */
1480 return 1;
1481 }
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001482 if (!(dentry->d_sb->s_flags & SB_ACTIVE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 /* Unhash it, so that ancestors of killed async unlink
1484 * files will be cleaned up during umount */
1485 return 1;
1486 }
1487 return 0;
1488
1489}
1490
Trond Myklebust1f018452012-12-14 16:38:46 -05001491/* Ensure that we revalidate inode->i_nlink */
Trond Myklebust1b83d702008-06-11 15:44:04 -04001492static void nfs_drop_nlink(struct inode *inode)
1493{
1494 spin_lock(&inode->i_lock);
Trond Myklebust1f018452012-12-14 16:38:46 -05001495 /* drop the inode if we're reasonably sure this is the last link */
Trond Myklebust59a707b2018-04-08 18:11:18 -04001496 if (inode->i_nlink > 0)
1497 drop_nlink(inode);
1498 NFS_I(inode)->attr_gencount = nfs_inc_attr_generation_counter();
Trond Myklebust16e14372018-03-20 16:53:31 -04001499 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_CHANGE
1500 | NFS_INO_INVALID_CTIME
Trond Myklebust59a707b2018-04-08 18:11:18 -04001501 | NFS_INO_INVALID_OTHER
1502 | NFS_INO_REVAL_FORCED;
Trond Myklebust1b83d702008-06-11 15:44:04 -04001503 spin_unlock(&inode->i_lock);
1504}
1505
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506/*
1507 * Called when the dentry loses inode.
1508 * We use it to clean up silly-renamed files.
1509 */
1510static void nfs_dentry_iput(struct dentry *dentry, struct inode *inode)
1511{
Neil Brown83672d32007-02-26 12:48:25 +11001512 if (S_ISDIR(inode->i_mode))
1513 /* drop any readdir cache as it could easily be old */
1514 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_DATA;
1515
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
Trond Myklebuste4eff1a2007-07-14 15:39:58 -04001517 nfs_complete_unlink(dentry, inode);
Trond Myklebust1f018452012-12-14 16:38:46 -05001518 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 iput(inode);
1521}
1522
Al Virob1942c52011-03-16 05:44:14 -04001523static void nfs_d_release(struct dentry *dentry)
1524{
1525 /* free cached devname value, if it survived that far */
1526 if (unlikely(dentry->d_fsdata)) {
1527 if (dentry->d_flags & DCACHE_NFSFS_RENAMED)
1528 WARN_ON(1);
1529 else
1530 kfree(dentry->d_fsdata);
1531 }
1532}
1533
Al Virof786aa92009-02-20 05:51:22 +00001534const struct dentry_operations nfs_dentry_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 .d_revalidate = nfs_lookup_revalidate,
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001536 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 .d_delete = nfs_dentry_delete,
1538 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001539 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001540 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541};
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001542EXPORT_SYMBOL_GPL(nfs_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543
Bryan Schumaker597d9282012-07-16 16:39:10 -04001544struct dentry *nfs_lookup(struct inode *dir, struct dentry * dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545{
1546 struct dentry *res;
1547 struct inode *inode = NULL;
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001548 struct nfs_fh *fhandle = NULL;
1549 struct nfs_fattr *fattr = NULL;
David Quigley1775fd32013-05-22 12:50:42 -04001550 struct nfs4_label *label = NULL;
Trond Myklebusta1147b82020-02-05 09:01:52 -05001551 unsigned long dir_verifier;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
Al Viro6de14722013-09-16 10:53:17 -04001554 dfprintk(VFS, "NFS: lookup(%pd2)\n", dentry);
Chuck Lever91d5b472006-03-20 13:44:14 -05001555 nfs_inc_stats(dir, NFSIOS_VFSLOOKUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Al Viro130f9ab2016-03-07 22:40:43 -05001557 if (unlikely(dentry->d_name.len > NFS_SERVER(dir)->namelen))
1558 return ERR_PTR(-ENAMETOOLONG);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Trond Myklebustfd684072006-09-05 12:27:44 -04001560 /*
1561 * If we're doing an exclusive create, optimize away the lookup
1562 * but don't hash the dentry.
1563 */
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001564 if (nfs_is_exclusive_create(dir, flags) || flags & LOOKUP_RENAME_TARGET)
Al Viro130f9ab2016-03-07 22:40:43 -05001565 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001567 res = ERR_PTR(-ENOMEM);
1568 fhandle = nfs_alloc_fhandle();
1569 fattr = nfs_alloc_fattr();
1570 if (fhandle == NULL || fattr == NULL)
1571 goto out;
1572
David Quigley14c43f72013-05-22 12:50:43 -04001573 label = nfs4_label_alloc(NFS_SERVER(dir), GFP_NOWAIT);
1574 if (IS_ERR(label))
1575 goto out;
1576
Trond Myklebusta1147b82020-02-05 09:01:52 -05001577 dir_verifier = nfs_save_change_attribute(dir);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001578 trace_nfs_lookup_enter(dir, dentry, flags);
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001579 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 if (error == -ENOENT)
1581 goto no_entry;
1582 if (error < 0) {
1583 res = ERR_PTR(error);
Al Virobf130912016-05-29 15:14:14 -04001584 goto out_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 }
David Quigley1775fd32013-05-22 12:50:42 -04001586 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
Namhyung Kimbf0c84f2010-12-28 17:02:46 +00001587 res = ERR_CAST(inode);
Trond Myklebust03f28e32006-03-20 13:44:48 -05001588 if (IS_ERR(res))
Al Virobf130912016-05-29 15:14:14 -04001589 goto out_label;
David Howells54ceac42006-08-22 20:06:13 -04001590
Trond Myklebust63519fb2016-11-19 11:21:54 -05001591 /* Notify readdir to use READDIRPLUS */
1592 nfs_force_use_readdirplus(dir);
Trond Myklebustd69ee9b2012-05-01 17:37:59 -04001593
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594no_entry:
Al Viro41d28bc2014-10-12 22:24:21 -04001595 res = d_splice_alias(inode, dentry);
Trond Myklebust9eaef272006-10-21 10:24:20 -07001596 if (res != NULL) {
1597 if (IS_ERR(res))
Al Virobf130912016-05-29 15:14:14 -04001598 goto out_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 dentry = res;
Trond Myklebust9eaef272006-10-21 10:24:20 -07001600 }
Trond Myklebusta1147b82020-02-05 09:01:52 -05001601 nfs_set_verifier(dentry, dir_verifier);
Al Virobf130912016-05-29 15:14:14 -04001602out_label:
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001603 trace_nfs_lookup_exit(dir, dentry, flags, error);
David Quigley14c43f72013-05-22 12:50:43 -04001604 nfs4_label_free(label);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605out:
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001606 nfs_free_fattr(fattr);
1607 nfs_free_fhandle(fhandle);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 return res;
1609}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001610EXPORT_SYMBOL_GPL(nfs_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001612#if IS_ENABLED(CONFIG_NFS_V4)
Al Viro0b728e12012-06-10 16:03:43 -04001613static int nfs4_lookup_revalidate(struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
Al Virof786aa92009-02-20 05:51:22 +00001615const struct dentry_operations nfs4_dentry_operations = {
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02001616 .d_revalidate = nfs4_lookup_revalidate,
NeilBrownb6887412017-08-25 17:34:41 +10001617 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 .d_delete = nfs_dentry_delete,
1619 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001620 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001621 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622};
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001623EXPORT_SYMBOL_GPL(nfs4_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
Al Viro8a5e9292011-06-25 19:15:54 -04001625static fmode_t flags_to_mode(int flags)
1626{
1627 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
1628 if ((flags & O_ACCMODE) != O_WRONLY)
1629 res |= FMODE_READ;
1630 if ((flags & O_ACCMODE) != O_RDONLY)
1631 res |= FMODE_WRITE;
1632 return res;
1633}
1634
NeilBrown532d4de2016-10-13 15:26:47 +11001635static struct nfs_open_context *create_nfs_open_context(struct dentry *dentry, int open_flags, struct file *filp)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001636{
NeilBrown532d4de2016-10-13 15:26:47 +11001637 return alloc_nfs_open_context(dentry, flags_to_mode(open_flags), filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001638}
1639
1640static int do_open(struct inode *inode, struct file *filp)
1641{
David Howellsf1fe29b2013-09-27 11:20:03 +01001642 nfs_fscache_open_file(inode, filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001643 return 0;
1644}
1645
Al Virod9585272012-06-22 12:39:14 +04001646static int nfs_finish_open(struct nfs_open_context *ctx,
1647 struct dentry *dentry,
Al Virob452a452018-06-08 13:06:28 -04001648 struct file *file, unsigned open_flags)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001649{
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001650 int err;
1651
Al Virobe12af32018-06-08 11:44:56 -04001652 err = finish_open(file, dentry, do_open);
Al Viro30d90492012-06-22 12:40:19 +04001653 if (err)
Al Virod9585272012-06-22 12:39:14 +04001654 goto out;
NeilBrowneaa2b822017-07-03 15:27:26 +10001655 if (S_ISREG(file->f_path.dentry->d_inode->i_mode))
1656 nfs_file_set_open_context(file, ctx);
1657 else
Trond Myklebust98214212019-08-09 12:15:07 -04001658 err = -EOPENSTALE;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001659out:
Al Virod9585272012-06-22 12:39:14 +04001660 return err;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001661}
1662
Bryan Schumaker73a79702012-07-16 16:39:12 -04001663int nfs_atomic_open(struct inode *dir, struct dentry *dentry,
1664 struct file *file, unsigned open_flags,
Al Viro44907d72018-06-08 13:32:02 -04001665 umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666{
Al Viroc94c0952016-07-05 09:49:21 -04001667 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001668 struct nfs_open_context *ctx;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001669 struct dentry *res;
1670 struct iattr attr = { .ia_valid = ATTR_OPEN };
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001671 struct inode *inode;
Trond Myklebust1472b832013-08-20 11:59:41 -04001672 unsigned int lookup_flags = 0;
Al Viroc94c0952016-07-05 09:49:21 -04001673 bool switched = false;
Al Viro73a09dd2018-06-08 13:22:02 -04001674 int created = 0;
Trond Myklebust898f6352010-10-23 11:24:25 -04001675 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001677 /* Expect a negative dentry */
David Howells2b0143b2015-03-17 22:25:59 +00001678 BUG_ON(d_inode(dentry));
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001679
Niels de Vos1e8968c2013-12-17 18:20:16 +01001680 dfprintk(VFS, "NFS: atomic_open(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001681 dir->i_sb->s_id, dir->i_ino, dentry);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001682
Jeff Layton9597c132013-08-02 11:39:32 -04001683 err = nfs_check_flags(open_flags);
1684 if (err)
1685 return err;
1686
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001687 /* NFS only supports OPEN on regular files */
1688 if ((open_flags & O_DIRECTORY)) {
Al Viro00699ad2016-07-05 09:44:53 -04001689 if (!d_in_lookup(dentry)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001690 /*
1691 * Hashed negative dentry with O_DIRECTORY: dentry was
1692 * revalidated and is fine, no need to perform lookup
1693 * again
1694 */
Al Virod9585272012-06-22 12:39:14 +04001695 return -ENOENT;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001696 }
Trond Myklebust1472b832013-08-20 11:59:41 -04001697 lookup_flags = LOOKUP_OPEN|LOOKUP_DIRECTORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 goto no_open;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001701 if (dentry->d_name.len > NFS_SERVER(dir)->namelen)
Al Virod9585272012-06-22 12:39:14 +04001702 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001704 if (open_flags & O_CREAT) {
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001705 struct nfs_server *server = NFS_SERVER(dir);
1706
1707 if (!(server->attr_bitmask[2] & FATTR4_WORD2_MODE_UMASK))
1708 mode &= ~current_umask();
1709
Trond Myklebust536e43d2012-01-17 22:04:26 -05001710 attr.ia_valid |= ATTR_MODE;
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001711 attr.ia_mode = mode;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001712 }
Trond Myklebust536e43d2012-01-17 22:04:26 -05001713 if (open_flags & O_TRUNC) {
1714 attr.ia_valid |= ATTR_SIZE;
1715 attr.ia_size = 0;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001716 }
1717
Al Viroc94c0952016-07-05 09:49:21 -04001718 if (!(open_flags & O_CREAT) && !d_in_lookup(dentry)) {
1719 d_drop(dentry);
1720 switched = true;
1721 dentry = d_alloc_parallel(dentry->d_parent,
1722 &dentry->d_name, &wq);
1723 if (IS_ERR(dentry))
1724 return PTR_ERR(dentry);
1725 if (unlikely(!d_in_lookup(dentry)))
1726 return finish_no_open(file, dentry);
1727 }
1728
NeilBrown532d4de2016-10-13 15:26:47 +11001729 ctx = create_nfs_open_context(dentry, open_flags, file);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001730 err = PTR_ERR(ctx);
1731 if (IS_ERR(ctx))
Al Virod9585272012-06-22 12:39:14 +04001732 goto out;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001733
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001734 trace_nfs_atomic_open_enter(dir, ctx, open_flags);
Al Viro73a09dd2018-06-08 13:22:02 -04001735 inode = NFS_PROTO(dir)->open_context(dir, ctx, open_flags, &attr, &created);
1736 if (created)
1737 file->f_mode |= FMODE_CREATED;
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001738 if (IS_ERR(inode)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001739 err = PTR_ERR(inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001740 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001741 put_nfs_open_context(ctx);
Al Virod20cb712016-06-20 13:14:36 -04001742 d_drop(dentry);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001743 switch (err) {
1744 case -ENOENT:
Peng Tao774d9512017-06-29 06:34:50 -07001745 d_splice_alias(NULL, dentry);
Trond Myklebust809fd142014-10-23 19:33:14 +03001746 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001747 break;
1748 case -EISDIR:
1749 case -ENOTDIR:
1750 goto no_open;
1751 case -ELOOP:
1752 if (!(open_flags & O_NOFOLLOW))
Trond Myklebust6f926b52005-10-18 14:20:18 -07001753 goto no_open;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001754 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 /* case -EINVAL: */
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001756 default:
1757 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 }
Al Virod9585272012-06-22 12:39:14 +04001759 goto out;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001760 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001761
Al Virob452a452018-06-08 13:06:28 -04001762 err = nfs_finish_open(ctx, ctx->dentry, file, open_flags);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001763 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001764 put_nfs_open_context(ctx);
Al Virod9585272012-06-22 12:39:14 +04001765out:
Al Viroc94c0952016-07-05 09:49:21 -04001766 if (unlikely(switched)) {
1767 d_lookup_done(dentry);
1768 dput(dentry);
1769 }
Al Virod9585272012-06-22 12:39:14 +04001770 return err;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001771
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772no_open:
Trond Myklebust1472b832013-08-20 11:59:41 -04001773 res = nfs_lookup(dir, dentry, lookup_flags);
Al Viroc94c0952016-07-05 09:49:21 -04001774 if (switched) {
1775 d_lookup_done(dentry);
1776 if (!res)
1777 res = dentry;
1778 else
1779 dput(dentry);
1780 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001781 if (IS_ERR(res))
Al Viroc94c0952016-07-05 09:49:21 -04001782 return PTR_ERR(res);
Al Viroe45198a2012-06-10 06:48:09 -04001783 return finish_no_open(file, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001785EXPORT_SYMBOL_GPL(nfs_atomic_open);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001787static int
1788nfs4_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1789 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790{
Nick Piggin657e94b2011-01-14 02:48:39 +00001791 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792
Al Virofa3c56b2012-06-10 15:36:40 -04001793 if (!(flags & LOOKUP_OPEN) || (flags & LOOKUP_DIRECTORY))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001794 goto full_reval;
Miklos Szeredieda72af2012-06-05 15:10:21 +02001795 if (d_mountpoint(dentry))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001796 goto full_reval;
Trond Myklebust2b484292010-09-17 10:56:51 -04001797
David Howells2b0143b2015-03-17 22:25:59 +00001798 inode = d_inode(dentry);
Trond Myklebust2b484292010-09-17 10:56:51 -04001799
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 /* We can't create new files in nfs_open_revalidate(), so we
1801 * optimize away revalidation of negative dentries.
1802 */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001803 if (inode == NULL)
1804 goto full_reval;
NeilBrown49317a72014-07-14 11:28:20 +10001805
Trond Myklebustefeda802020-02-05 09:01:54 -05001806 if (nfs_verifier_is_delegated(dentry))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001807 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust216d5d062007-10-01 20:10:12 -04001808
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 /* NFS only supports OPEN on regular files */
1810 if (!S_ISREG(inode->i_mode))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001811 goto full_reval;
1812
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 /* We cannot do exclusive creation on a positive dentry */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001814 if (flags & (LOOKUP_EXCL | LOOKUP_REVAL))
1815 goto reval_dentry;
1816
1817 /* Check if the directory changed */
1818 if (!nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU))
1819 goto reval_dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02001821 /* Let f_op->open() actually open (and revalidate) the file */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001822 return 1;
1823reval_dentry:
1824 if (flags & LOOKUP_RCU)
1825 return -ECHILD;
zhangliguang42f72cf2019-02-12 09:38:33 +08001826 return nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust536e43d2012-01-17 22:04:26 -05001827
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001828full_reval:
1829 return nfs_do_lookup_revalidate(dir, dentry, flags);
1830}
Trond Myklebust535918f2010-09-17 10:56:51 -04001831
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001832static int nfs4_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1833{
1834 return __nfs_lookup_revalidate(dentry, flags,
1835 nfs4_do_lookup_revalidate);
Trond Myklebustc0204fd2010-09-17 10:56:51 -04001836}
1837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838#endif /* CONFIG_NFSV4 */
1839
Benjamin Coddington406cd912019-09-13 08:29:02 -04001840struct dentry *
1841nfs_add_or_obtain(struct dentry *dentry, struct nfs_fh *fhandle,
David Quigley1775fd32013-05-22 12:50:42 -04001842 struct nfs_fattr *fattr,
1843 struct nfs4_label *label)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844{
Trond Myklebustfab728e2007-09-29 17:41:33 -04001845 struct dentry *parent = dget_parent(dentry);
David Howells2b0143b2015-03-17 22:25:59 +00001846 struct inode *dir = d_inode(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 struct inode *inode;
Al Virob0c6108e2018-05-16 10:55:01 -04001848 struct dentry *d;
Benjamin Coddington406cd912019-09-13 08:29:02 -04001849 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850
Trond Myklebustfab728e2007-09-29 17:41:33 -04001851 d_drop(dentry);
1852
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 if (fhandle->size == 0) {
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001854 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 if (error)
Trond Myklebustfab728e2007-09-29 17:41:33 -04001856 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 }
Trond Myklebust5724ab32007-10-01 21:51:38 -04001858 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1860 struct nfs_server *server = NFS_SB(dentry->d_sb);
Trond Myklebusta841b542018-04-07 13:50:59 -04001861 error = server->nfs_client->rpc_ops->getattr(server, fhandle,
1862 fattr, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 if (error < 0)
Trond Myklebustfab728e2007-09-29 17:41:33 -04001864 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 }
David Quigley1775fd32013-05-22 12:50:42 -04001866 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
Al Virob0c6108e2018-05-16 10:55:01 -04001867 d = d_splice_alias(inode, dentry);
Trond Myklebustfab728e2007-09-29 17:41:33 -04001868out:
1869 dput(parent);
Benjamin Coddington406cd912019-09-13 08:29:02 -04001870 return d;
Trond Myklebustfab728e2007-09-29 17:41:33 -04001871out_error:
1872 nfs_mark_for_revalidate(dir);
Benjamin Coddington406cd912019-09-13 08:29:02 -04001873 d = ERR_PTR(error);
1874 goto out;
1875}
1876EXPORT_SYMBOL_GPL(nfs_add_or_obtain);
1877
1878/*
1879 * Code common to create, mkdir, and mknod.
1880 */
1881int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fhandle,
1882 struct nfs_fattr *fattr,
1883 struct nfs4_label *label)
1884{
1885 struct dentry *d;
1886
1887 d = nfs_add_or_obtain(dentry, fhandle, fattr, label);
1888 if (IS_ERR(d))
1889 return PTR_ERR(d);
1890
1891 /* Callers don't care */
1892 dput(d);
1893 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001895EXPORT_SYMBOL_GPL(nfs_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896
1897/*
1898 * Following a failed create operation, we drop the dentry rather
1899 * than retain a negative dentry. This avoids a problem in the event
1900 * that the operation succeeded on the server, but an error in the
1901 * reply path made it appear to have failed.
1902 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001903int nfs_create(struct inode *dir, struct dentry *dentry,
Al Viroebfc3b42012-06-10 18:05:36 -04001904 umode_t mode, bool excl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905{
1906 struct iattr attr;
Al Viroebfc3b42012-06-10 18:05:36 -04001907 int open_flags = excl ? O_CREAT | O_EXCL : O_CREAT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909
Niels de Vos1e8968c2013-12-17 18:20:16 +01001910 dfprintk(VFS, "NFS: create(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001911 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912
1913 attr.ia_mode = mode;
1914 attr.ia_valid = ATTR_MODE;
1915
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04001916 trace_nfs_create_enter(dir, dentry, open_flags);
Miklos Szeredi8867fe52012-06-05 15:10:19 +02001917 error = NFS_PROTO(dir)->create(dir, dentry, &attr, open_flags);
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04001918 trace_nfs_create_exit(dir, dentry, open_flags, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 if (error != 0)
1920 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 return 0;
1922out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 d_drop(dentry);
1924 return error;
1925}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001926EXPORT_SYMBOL_GPL(nfs_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927
1928/*
1929 * See comments for nfs_proc_create regarding failed operations.
1930 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001931int
Al Viro1a67aaf2011-07-26 01:52:52 -04001932nfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t rdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933{
1934 struct iattr attr;
1935 int status;
1936
Niels de Vos1e8968c2013-12-17 18:20:16 +01001937 dfprintk(VFS, "NFS: mknod(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001938 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 attr.ia_mode = mode;
1941 attr.ia_valid = ATTR_MODE;
1942
Trond Myklebust1ca42382013-08-21 12:36:04 -04001943 trace_nfs_mknod_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 status = NFS_PROTO(dir)->mknod(dir, dentry, &attr, rdev);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001945 trace_nfs_mknod_exit(dir, dentry, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 if (status != 0)
1947 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 return 0;
1949out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 d_drop(dentry);
1951 return status;
1952}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001953EXPORT_SYMBOL_GPL(nfs_mknod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954
1955/*
1956 * See comments for nfs_proc_create regarding failed operations.
1957 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001958int nfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959{
1960 struct iattr attr;
1961 int error;
1962
Niels de Vos1e8968c2013-12-17 18:20:16 +01001963 dfprintk(VFS, "NFS: mkdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001964 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
1966 attr.ia_valid = ATTR_MODE;
1967 attr.ia_mode = mode | S_IFDIR;
1968
Trond Myklebust1ca42382013-08-21 12:36:04 -04001969 trace_nfs_mkdir_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 error = NFS_PROTO(dir)->mkdir(dir, dentry, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001971 trace_nfs_mkdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 if (error != 0)
1973 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 return 0;
1975out_err:
1976 d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 return error;
1978}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001979EXPORT_SYMBOL_GPL(nfs_mkdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
Trond Myklebustd45b9d82008-01-28 19:43:18 -05001981static void nfs_dentry_handle_enoent(struct dentry *dentry)
1982{
Al Virodc3f4192015-05-18 10:10:34 -04001983 if (simple_positive(dentry))
Trond Myklebustd45b9d82008-01-28 19:43:18 -05001984 d_delete(dentry);
1985}
1986
Bryan Schumaker597d9282012-07-16 16:39:10 -04001987int nfs_rmdir(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988{
1989 int error;
1990
Niels de Vos1e8968c2013-12-17 18:20:16 +01001991 dfprintk(VFS, "NFS: rmdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001992 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993
Trond Myklebust1ca42382013-08-21 12:36:04 -04001994 trace_nfs_rmdir_enter(dir, dentry);
David Howells2b0143b2015-03-17 22:25:59 +00001995 if (d_really_is_positive(dentry)) {
Al Viro884be172016-04-28 23:56:31 -04001996 down_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04001997 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
1998 /* Ensure the VFS deletes this inode */
1999 switch (error) {
2000 case 0:
David Howells2b0143b2015-03-17 22:25:59 +00002001 clear_nlink(d_inode(dentry));
Trond Myklebustba6c0592013-08-30 12:24:25 -04002002 break;
2003 case -ENOENT:
2004 nfs_dentry_handle_enoent(dentry);
2005 }
Al Viro884be172016-04-28 23:56:31 -04002006 up_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04002007 } else
2008 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002009 trace_nfs_rmdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010
2011 return error;
2012}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002013EXPORT_SYMBOL_GPL(nfs_rmdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015/*
2016 * Remove a file after making sure there are no pending writes,
2017 * and after checking that the file has only one user.
2018 *
2019 * We invalidate the attribute cache and free the inode prior to the operation
2020 * to avoid possible races if the server reuses the inode.
2021 */
2022static int nfs_safe_remove(struct dentry *dentry)
2023{
David Howells2b0143b2015-03-17 22:25:59 +00002024 struct inode *dir = d_inode(dentry->d_parent);
2025 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 int error = -EBUSY;
2027
Al Viro6de14722013-09-16 10:53:17 -04002028 dfprintk(VFS, "NFS: safe_remove(%pd2)\n", dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029
2030 /* If the dentry was sillyrenamed, we simply call d_delete() */
2031 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
2032 error = 0;
2033 goto out;
2034 }
2035
Trond Myklebust1ca42382013-08-21 12:36:04 -04002036 trace_nfs_remove_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 if (inode != NULL) {
Trond Myklebust912678d2018-03-20 16:43:15 -04002038 error = NFS_PROTO(dir)->remove(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 if (error == 0)
Trond Myklebust1b83d702008-06-11 15:44:04 -04002040 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 } else
Trond Myklebust912678d2018-03-20 16:43:15 -04002042 error = NFS_PROTO(dir)->remove(dir, dentry);
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002043 if (error == -ENOENT)
2044 nfs_dentry_handle_enoent(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002045 trace_nfs_remove_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046out:
2047 return error;
2048}
2049
2050/* We do silly rename. In case sillyrename() returns -EBUSY, the inode
2051 * belongs to an active ".nfs..." file and we return -EBUSY.
2052 *
2053 * If sillyrename() returns 0, we do nothing, otherwise we unlink.
2054 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002055int nfs_unlink(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056{
2057 int error;
2058 int need_rehash = 0;
2059
Niels de Vos1e8968c2013-12-17 18:20:16 +01002060 dfprintk(VFS, "NFS: unlink(%s/%lu, %pd)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04002061 dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062
Trond Myklebust1ca42382013-08-21 12:36:04 -04002063 trace_nfs_unlink_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 spin_lock(&dentry->d_lock);
Al Viro84d08fa2013-07-05 18:59:33 +04002065 if (d_count(dentry) > 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 spin_unlock(&dentry->d_lock);
Trond Myklebustccfeb502007-01-13 02:28:12 -05002067 /* Start asynchronous writeout of the inode */
David Howells2b0143b2015-03-17 22:25:59 +00002068 write_inode_now(d_inode(dentry), 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 error = nfs_sillyrename(dir, dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002070 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 }
2072 if (!d_unhashed(dentry)) {
2073 __d_drop(dentry);
2074 need_rehash = 1;
2075 }
2076 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 error = nfs_safe_remove(dentry);
Trond Myklebustd45b9d82008-01-28 19:43:18 -05002078 if (!error || error == -ENOENT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
2080 } else if (need_rehash)
2081 d_rehash(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002082out:
2083 trace_nfs_unlink_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 return error;
2085}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002086EXPORT_SYMBOL_GPL(nfs_unlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
Chuck Lever873101b2006-08-22 20:06:23 -04002088/*
2089 * To create a symbolic link, most file systems instantiate a new inode,
2090 * add a page to it containing the path, then write it out to the disk
2091 * using prepare_write/commit_write.
2092 *
2093 * Unfortunately the NFS client can't create the in-core inode first
2094 * because it needs a file handle to create an in-core inode (see
2095 * fs/nfs/inode.c:nfs_fhget). We only have a file handle *after* the
2096 * symlink request has completed on the server.
2097 *
2098 * So instead we allocate a raw page, copy the symname into it, then do
2099 * the SYMLINK request with the page as the buffer. If it succeeds, we
2100 * now have a new file handle and can instantiate an in-core NFS inode
2101 * and move the raw page into its mapping.
2102 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002103int nfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104{
Chuck Lever873101b2006-08-22 20:06:23 -04002105 struct page *page;
2106 char *kaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 struct iattr attr;
Chuck Lever873101b2006-08-22 20:06:23 -04002108 unsigned int pathlen = strlen(symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 int error;
2110
Niels de Vos1e8968c2013-12-17 18:20:16 +01002111 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04002112 dir->i_ino, dentry, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
Chuck Lever873101b2006-08-22 20:06:23 -04002114 if (pathlen > PAGE_SIZE)
2115 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116
Chuck Lever873101b2006-08-22 20:06:23 -04002117 attr.ia_mode = S_IFLNK | S_IRWXUGO;
2118 attr.ia_valid = ATTR_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119
Al Viroe8ecde22016-01-14 17:52:59 -05002120 page = alloc_page(GFP_USER);
Trond Myklebust76566992008-06-11 15:44:22 -04002121 if (!page)
Chuck Lever873101b2006-08-22 20:06:23 -04002122 return -ENOMEM;
Chuck Lever873101b2006-08-22 20:06:23 -04002123
Al Viroe8ecde22016-01-14 17:52:59 -05002124 kaddr = page_address(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002125 memcpy(kaddr, symname, pathlen);
2126 if (pathlen < PAGE_SIZE)
2127 memset(kaddr + pathlen, 0, PAGE_SIZE - pathlen);
Chuck Lever873101b2006-08-22 20:06:23 -04002128
Trond Myklebust1ca42382013-08-21 12:36:04 -04002129 trace_nfs_symlink_enter(dir, dentry);
Chuck Lever94a6d752006-08-22 20:06:23 -04002130 error = NFS_PROTO(dir)->symlink(dir, dentry, page, pathlen, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04002131 trace_nfs_symlink_exit(dir, dentry, error);
Chuck Lever873101b2006-08-22 20:06:23 -04002132 if (error != 0) {
Niels de Vos1e8968c2013-12-17 18:20:16 +01002133 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s) error %d\n",
Chuck Lever873101b2006-08-22 20:06:23 -04002134 dir->i_sb->s_id, dir->i_ino,
Al Viro6de14722013-09-16 10:53:17 -04002135 dentry, symname, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 d_drop(dentry);
Chuck Lever873101b2006-08-22 20:06:23 -04002137 __free_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002138 return error;
2139 }
2140
2141 /*
2142 * No big deal if we can't add this page to the page cache here.
2143 * READLINK will get the missing page from the server if needed.
2144 */
David Howells2b0143b2015-03-17 22:25:59 +00002145 if (!add_to_page_cache_lru(page, d_inode(dentry)->i_mapping, 0,
Chuck Lever873101b2006-08-22 20:06:23 -04002146 GFP_KERNEL)) {
Chuck Lever873101b2006-08-22 20:06:23 -04002147 SetPageUptodate(page);
2148 unlock_page(page);
Rafael Aquinia0b54add2014-02-10 14:25:48 -08002149 /*
2150 * add_to_page_cache_lru() grabs an extra page refcount.
2151 * Drop it here to avoid leaking this page later.
2152 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002153 put_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002154 } else
2155 __free_page(page);
2156
Chuck Lever873101b2006-08-22 20:06:23 -04002157 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002159EXPORT_SYMBOL_GPL(nfs_symlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
Bryan Schumaker597d9282012-07-16 16:39:10 -04002161int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162nfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
2163{
David Howells2b0143b2015-03-17 22:25:59 +00002164 struct inode *inode = d_inode(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 int error;
2166
Al Viro6de14722013-09-16 10:53:17 -04002167 dfprintk(VFS, "NFS: link(%pd2 -> %pd2)\n",
2168 old_dentry, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
Trond Myklebust1fd10852013-08-21 13:54:44 -04002170 trace_nfs_link_enter(inode, dir, dentry);
Trond Myklebust9697d232007-10-02 21:58:05 -04002171 d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 error = NFS_PROTO(dir)->link(inode, dir, &dentry->d_name);
Trond Myklebustcf809552005-10-27 22:12:42 -04002173 if (error == 0) {
Al Viro7de9c6ee2010-10-23 11:11:40 -04002174 ihold(inode);
Trond Myklebust9697d232007-10-02 21:58:05 -04002175 d_add(dentry, inode);
Trond Myklebustcf809552005-10-27 22:12:42 -04002176 }
Trond Myklebust1fd10852013-08-21 13:54:44 -04002177 trace_nfs_link_exit(inode, dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 return error;
2179}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002180EXPORT_SYMBOL_GPL(nfs_link);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181
2182/*
2183 * RENAME
2184 * FIXME: Some nfsds, like the Linux user space nfsd, may generate a
2185 * different file handle for the same inode after a rename (e.g. when
2186 * moving to a different directory). A fail-safe method to do so would
2187 * be to look up old_dir/old_name, create a link to new_dir/new_name and
2188 * rename the old file using the sillyrename stuff. This way, the original
2189 * file in old_dir will go away when the last process iput()s the inode.
2190 *
2191 * FIXED.
2192 *
2193 * It actually works quite well. One needs to have the possibility for
2194 * at least one ".nfs..." file in each directory the file ever gets
2195 * moved or linked to which happens automagically with the new
2196 * implementation that only depends on the dcache stuff instead of
2197 * using the inode layer
2198 *
2199 * Unfortunately, things are a little more complicated than indicated
2200 * above. For a cross-directory move, we want to make sure we can get
2201 * rid of the old inode after the operation. This means there must be
2202 * no pending writes (if it's a file), and the use count must be 1.
2203 * If these conditions are met, we can drop the dentries before doing
2204 * the rename.
2205 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002206int nfs_rename(struct inode *old_dir, struct dentry *old_dentry,
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02002207 struct inode *new_dir, struct dentry *new_dentry,
2208 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209{
David Howells2b0143b2015-03-17 22:25:59 +00002210 struct inode *old_inode = d_inode(old_dentry);
2211 struct inode *new_inode = d_inode(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002212 struct dentry *dentry = NULL, *rehash = NULL;
Jeff Layton80a491f2014-03-17 07:06:56 -04002213 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 int error = -EBUSY;
2215
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02002216 if (flags)
2217 return -EINVAL;
2218
Al Viro6de14722013-09-16 10:53:17 -04002219 dfprintk(VFS, "NFS: rename(%pd2 -> %pd2, ct=%d)\n",
2220 old_dentry, new_dentry,
Al Viro84d08fa2013-07-05 18:59:33 +04002221 d_count(new_dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222
Trond Myklebust70ded202013-08-21 12:08:45 -04002223 trace_nfs_rename_enter(old_dir, old_dentry, new_dir, new_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 /*
Miklos Szeredi28f79a12009-12-03 15:58:56 -05002225 * For non-directories, check whether the target is busy and if so,
2226 * make a copy of the dentry and then do a silly-rename. If the
2227 * silly-rename succeeds, the copied dentry is hashed and becomes
2228 * the new target.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 */
Miklos Szeredi27226102009-12-03 15:58:56 -05002230 if (new_inode && !S_ISDIR(new_inode->i_mode)) {
2231 /*
2232 * To prevent any new references to the target during the
2233 * rename, we unhash the dentry in advance.
2234 */
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002235 if (!d_unhashed(new_dentry)) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002236 d_drop(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002237 rehash = new_dentry;
2238 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239
Al Viro84d08fa2013-07-05 18:59:33 +04002240 if (d_count(new_dentry) > 2) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002241 int err;
2242
2243 /* copy the target dentry's name */
2244 dentry = d_alloc(new_dentry->d_parent,
2245 &new_dentry->d_name);
2246 if (!dentry)
2247 goto out;
2248
2249 /* silly-rename the existing target ... */
2250 err = nfs_sillyrename(new_dir, new_dentry);
Miklos Szeredi24e93022009-12-03 15:58:56 -05002251 if (err)
Miklos Szeredi27226102009-12-03 15:58:56 -05002252 goto out;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002253
2254 new_dentry = dentry;
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002255 rehash = NULL;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002256 new_inode = NULL;
Miklos Szeredi27226102009-12-03 15:58:56 -05002257 }
Trond Myklebustb1e4adf2009-03-19 15:35:49 -04002258 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002260 task = nfs_async_rename(old_dir, new_dir, old_dentry, new_dentry, NULL);
Jeff Layton80a491f2014-03-17 07:06:56 -04002261 if (IS_ERR(task)) {
2262 error = PTR_ERR(task);
2263 goto out;
2264 }
2265
2266 error = rpc_wait_for_completion_task(task);
Benjamin Coddington818a8db2017-06-16 11:13:00 -04002267 if (error != 0) {
2268 ((struct nfs_renamedata *)task->tk_calldata)->cancelled = 1;
2269 /* Paired with the atomic_dec_and_test() barrier in rpc_do_put_task() */
2270 smp_wmb();
2271 } else
Jeff Layton80a491f2014-03-17 07:06:56 -04002272 error = task->tk_status;
2273 rpc_put_task(task);
Trond Myklebust59a707b2018-04-08 18:11:18 -04002274 /* Ensure the inode attributes are revalidated */
2275 if (error == 0) {
2276 spin_lock(&old_inode->i_lock);
2277 NFS_I(old_inode)->attr_gencount = nfs_inc_attr_generation_counter();
2278 NFS_I(old_inode)->cache_validity |= NFS_INO_INVALID_CHANGE
2279 | NFS_INO_INVALID_CTIME
2280 | NFS_INO_REVAL_FORCED;
2281 spin_unlock(&old_inode->i_lock);
2282 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283out:
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002284 if (rehash)
2285 d_rehash(rehash);
Trond Myklebust70ded202013-08-21 12:08:45 -04002286 trace_nfs_rename_exit(old_dir, old_dentry,
2287 new_dir, new_dentry, error);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002288 if (!error) {
2289 if (new_inode != NULL)
2290 nfs_drop_nlink(new_inode);
2291 /*
2292 * The d_move() should be here instead of in an async RPC completion
2293 * handler because we need the proper locks to move the dentry. If
2294 * we're interrupted by a signal, the async RPC completion handler
2295 * should mark the directories for revalidation.
2296 */
2297 d_move(old_dentry, new_dentry);
Trond Myklebustd8032242017-11-06 15:28:04 -05002298 nfs_set_verifier(old_dentry,
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002299 nfs_save_change_attribute(new_dir));
2300 } else if (error == -ENOENT)
2301 nfs_dentry_handle_enoent(old_dentry);
2302
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 /* new dentry created? */
2304 if (dentry)
2305 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 return error;
2307}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002308EXPORT_SYMBOL_GPL(nfs_rename);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002310static DEFINE_SPINLOCK(nfs_access_lru_lock);
2311static LIST_HEAD(nfs_access_lru_list);
2312static atomic_long_t nfs_access_nr_entries;
2313
Trond Myklebusta8b373e2020-02-08 09:14:11 -05002314static unsigned long nfs_access_max_cachesize = 4*1024*1024;
Trond Myklebust3a505842014-07-21 13:53:48 -04002315module_param(nfs_access_max_cachesize, ulong, 0644);
2316MODULE_PARM_DESC(nfs_access_max_cachesize, "NFS access maximum total cache length");
2317
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002318static void nfs_access_free_entry(struct nfs_access_entry *entry)
2319{
NeilBrownb68572e2018-12-03 11:30:30 +11002320 put_cred(entry->cred);
NeilBrownf682a392014-07-14 11:28:20 +10002321 kfree_rcu(entry, rcu_head);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002322 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002323 atomic_long_dec(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002324 smp_mb__after_atomic();
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002325}
2326
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002327static void nfs_access_free_list(struct list_head *head)
2328{
2329 struct nfs_access_entry *cache;
2330
2331 while (!list_empty(head)) {
2332 cache = list_entry(head->next, struct nfs_access_entry, lru);
2333 list_del(&cache->lru);
2334 nfs_access_free_entry(cache);
2335 }
2336}
2337
Trond Myklebust3a505842014-07-21 13:53:48 -04002338static unsigned long
2339nfs_do_access_cache_scan(unsigned int nr_to_scan)
Trond Myklebust979df722006-07-25 11:28:19 -04002340{
2341 LIST_HEAD(head);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002342 struct nfs_inode *nfsi, *next;
Trond Myklebust979df722006-07-25 11:28:19 -04002343 struct nfs_access_entry *cache;
Dave Chinner1ab6c492013-08-28 10:18:09 +10002344 long freed = 0;
Trond Myklebust979df722006-07-25 11:28:19 -04002345
Trond Myklebusta50f7952007-06-05 19:23:43 -04002346 spin_lock(&nfs_access_lru_lock);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002347 list_for_each_entry_safe(nfsi, next, &nfs_access_lru_list, access_cache_inode_lru) {
Trond Myklebust979df722006-07-25 11:28:19 -04002348 struct inode *inode;
2349
2350 if (nr_to_scan-- == 0)
2351 break;
Trond Myklebust9c7e7e22010-05-13 12:51:06 -04002352 inode = &nfsi->vfs_inode;
Trond Myklebust979df722006-07-25 11:28:19 -04002353 spin_lock(&inode->i_lock);
2354 if (list_empty(&nfsi->access_cache_entry_lru))
2355 goto remove_lru_entry;
2356 cache = list_entry(nfsi->access_cache_entry_lru.next,
2357 struct nfs_access_entry, lru);
2358 list_move(&cache->lru, &head);
2359 rb_erase(&cache->rb_node, &nfsi->access_cache);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002360 freed++;
Trond Myklebust979df722006-07-25 11:28:19 -04002361 if (!list_empty(&nfsi->access_cache_entry_lru))
2362 list_move_tail(&nfsi->access_cache_inode_lru,
2363 &nfs_access_lru_list);
2364 else {
2365remove_lru_entry:
2366 list_del_init(&nfsi->access_cache_inode_lru);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002367 smp_mb__before_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002368 clear_bit(NFS_INO_ACL_LRU_SET, &nfsi->flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002369 smp_mb__after_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002370 }
Trond Myklebust59844a92010-05-26 08:42:24 -04002371 spin_unlock(&inode->i_lock);
Trond Myklebust979df722006-07-25 11:28:19 -04002372 }
2373 spin_unlock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002374 nfs_access_free_list(&head);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002375 return freed;
2376}
2377
2378unsigned long
Trond Myklebust3a505842014-07-21 13:53:48 -04002379nfs_access_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
2380{
2381 int nr_to_scan = sc->nr_to_scan;
2382 gfp_t gfp_mask = sc->gfp_mask;
2383
2384 if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
2385 return SHRINK_STOP;
2386 return nfs_do_access_cache_scan(nr_to_scan);
2387}
2388
2389
2390unsigned long
Dave Chinner1ab6c492013-08-28 10:18:09 +10002391nfs_access_cache_count(struct shrinker *shrink, struct shrink_control *sc)
2392{
Glauber Costa55f841c2013-08-28 10:17:53 +10002393 return vfs_pressure_ratio(atomic_long_read(&nfs_access_nr_entries));
Trond Myklebust979df722006-07-25 11:28:19 -04002394}
2395
Trond Myklebust3a505842014-07-21 13:53:48 -04002396static void
2397nfs_access_cache_enforce_limit(void)
2398{
2399 long nr_entries = atomic_long_read(&nfs_access_nr_entries);
2400 unsigned long diff;
2401 unsigned int nr_to_scan;
2402
2403 if (nr_entries < 0 || nr_entries <= nfs_access_max_cachesize)
2404 return;
2405 nr_to_scan = 100;
2406 diff = nr_entries - nfs_access_max_cachesize;
2407 if (diff < nr_to_scan)
2408 nr_to_scan = diff;
2409 nfs_do_access_cache_scan(nr_to_scan);
2410}
2411
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002412static void __nfs_access_zap_cache(struct nfs_inode *nfsi, struct list_head *head)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002413{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002414 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002415 struct rb_node *n;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002416 struct nfs_access_entry *entry;
2417
2418 /* Unhook entries from the cache */
2419 while ((n = rb_first(root_node)) != NULL) {
2420 entry = rb_entry(n, struct nfs_access_entry, rb_node);
2421 rb_erase(n, root_node);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002422 list_move(&entry->lru, head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002423 }
2424 nfsi->cache_validity &= ~NFS_INO_INVALID_ACCESS;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002425}
2426
2427void nfs_access_zap_cache(struct inode *inode)
2428{
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002429 LIST_HEAD(head);
2430
2431 if (test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags) == 0)
2432 return;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002433 /* Remove from global LRU init */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002434 spin_lock(&nfs_access_lru_lock);
2435 if (test_and_clear_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002436 list_del_init(&NFS_I(inode)->access_cache_inode_lru);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002437
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002438 spin_lock(&inode->i_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002439 __nfs_access_zap_cache(NFS_I(inode), &head);
2440 spin_unlock(&inode->i_lock);
2441 spin_unlock(&nfs_access_lru_lock);
2442 nfs_access_free_list(&head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002443}
Bryan Schumaker1c606fb2012-07-30 16:05:24 -04002444EXPORT_SYMBOL_GPL(nfs_access_zap_cache);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002445
NeilBrownb68572e2018-12-03 11:30:30 +11002446static struct nfs_access_entry *nfs_access_search_rbtree(struct inode *inode, const struct cred *cred)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002447{
2448 struct rb_node *n = NFS_I(inode)->access_cache.rb_node;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002449
2450 while (n != NULL) {
NeilBrownb68572e2018-12-03 11:30:30 +11002451 struct nfs_access_entry *entry =
2452 rb_entry(n, struct nfs_access_entry, rb_node);
2453 int cmp = cred_fscmp(cred, entry->cred);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002454
NeilBrownb68572e2018-12-03 11:30:30 +11002455 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002456 n = n->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002457 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002458 n = n->rb_right;
2459 else
2460 return entry;
2461 }
2462 return NULL;
2463}
2464
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002465static int nfs_access_get_cached_locked(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res, bool may_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466{
Chuck Lever55296802005-08-18 11:24:09 -07002467 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002468 struct nfs_access_entry *cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002469 bool retry = true;
2470 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002472 spin_lock(&inode->i_lock);
Trond Myklebust57b69182016-06-03 17:07:19 -04002473 for(;;) {
2474 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2475 goto out_zap;
2476 cache = nfs_access_search_rbtree(inode, cred);
2477 err = -ENOENT;
2478 if (cache == NULL)
2479 goto out;
2480 /* Found an entry, is our attribute cache valid? */
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002481 if (!nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
Trond Myklebust57b69182016-06-03 17:07:19 -04002482 break;
Trond Myklebust5c965db2020-01-06 15:39:36 -05002483 if (!retry)
2484 break;
Trond Myklebust57b69182016-06-03 17:07:19 -04002485 err = -ECHILD;
2486 if (!may_block)
2487 goto out;
Trond Myklebust57b69182016-06-03 17:07:19 -04002488 spin_unlock(&inode->i_lock);
2489 err = __nfs_revalidate_inode(NFS_SERVER(inode), inode);
2490 if (err)
2491 return err;
2492 spin_lock(&inode->i_lock);
2493 retry = false;
2494 }
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002495 res->cred = cache->cred;
2496 res->mask = cache->mask;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002497 list_move_tail(&cache->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002498 err = 0;
2499out:
2500 spin_unlock(&inode->i_lock);
2501 return err;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002502out_zap:
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002503 spin_unlock(&inode->i_lock);
2504 nfs_access_zap_cache(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002505 return -ENOENT;
2506}
2507
NeilBrownb68572e2018-12-03 11:30:30 +11002508static int nfs_access_get_cached_rcu(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res)
NeilBrownf682a392014-07-14 11:28:20 +10002509{
2510 /* Only check the most recently returned cache entry,
2511 * but do it without locking.
2512 */
2513 struct nfs_inode *nfsi = NFS_I(inode);
2514 struct nfs_access_entry *cache;
2515 int err = -ECHILD;
2516 struct list_head *lh;
2517
2518 rcu_read_lock();
2519 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2520 goto out;
Madhuparna Bhowmik9f01eb52019-12-10 11:16:39 +05302521 lh = rcu_dereference(list_tail_rcu(&nfsi->access_cache_entry_lru));
NeilBrownf682a392014-07-14 11:28:20 +10002522 cache = list_entry(lh, struct nfs_access_entry, lru);
2523 if (lh == &nfsi->access_cache_entry_lru ||
Trond Myklebust9a206de2020-01-26 17:31:14 -05002524 cred_fscmp(cred, cache->cred) != 0)
NeilBrownf682a392014-07-14 11:28:20 +10002525 cache = NULL;
2526 if (cache == NULL)
2527 goto out;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002528 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
NeilBrownf682a392014-07-14 11:28:20 +10002529 goto out;
NeilBrownf682a392014-07-14 11:28:20 +10002530 res->cred = cache->cred;
2531 res->mask = cache->mask;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002532 err = 0;
NeilBrownf682a392014-07-14 11:28:20 +10002533out:
2534 rcu_read_unlock();
2535 return err;
2536}
2537
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002538int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct
2539nfs_access_entry *res, bool may_block)
2540{
2541 int status;
2542
2543 status = nfs_access_get_cached_rcu(inode, cred, res);
2544 if (status != 0)
2545 status = nfs_access_get_cached_locked(inode, cred, res,
2546 may_block);
2547
2548 return status;
2549}
2550EXPORT_SYMBOL_GPL(nfs_access_get_cached);
2551
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002552static void nfs_access_add_rbtree(struct inode *inode, struct nfs_access_entry *set)
2553{
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002554 struct nfs_inode *nfsi = NFS_I(inode);
2555 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002556 struct rb_node **p = &root_node->rb_node;
2557 struct rb_node *parent = NULL;
2558 struct nfs_access_entry *entry;
NeilBrownb68572e2018-12-03 11:30:30 +11002559 int cmp;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002560
2561 spin_lock(&inode->i_lock);
2562 while (*p != NULL) {
2563 parent = *p;
2564 entry = rb_entry(parent, struct nfs_access_entry, rb_node);
NeilBrownb68572e2018-12-03 11:30:30 +11002565 cmp = cred_fscmp(set->cred, entry->cred);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002566
NeilBrownb68572e2018-12-03 11:30:30 +11002567 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002568 p = &parent->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002569 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002570 p = &parent->rb_right;
2571 else
2572 goto found;
2573 }
2574 rb_link_node(&set->rb_node, parent, p);
2575 rb_insert_color(&set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002576 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002577 spin_unlock(&inode->i_lock);
2578 return;
2579found:
2580 rb_replace_node(parent, &set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002581 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2582 list_del(&entry->lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002583 spin_unlock(&inode->i_lock);
2584 nfs_access_free_entry(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585}
2586
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002587void nfs_access_add_cache(struct inode *inode, struct nfs_access_entry *set)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002589 struct nfs_access_entry *cache = kmalloc(sizeof(*cache), GFP_KERNEL);
2590 if (cache == NULL)
2591 return;
2592 RB_CLEAR_NODE(&cache->rb_node);
NeilBrownb68572e2018-12-03 11:30:30 +11002593 cache->cred = get_cred(set->cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 cache->mask = set->mask;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002595
NeilBrownf682a392014-07-14 11:28:20 +10002596 /* The above field assignments must be visible
2597 * before this item appears on the lru. We cannot easily
2598 * use rcu_assign_pointer, so just force the memory barrier.
2599 */
2600 smp_wmb();
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002601 nfs_access_add_rbtree(inode, cache);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002602
2603 /* Update accounting */
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002604 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002605 atomic_long_inc(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002606 smp_mb__after_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002607
2608 /* Add inode to global LRU list */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002609 if (!test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags)) {
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002610 spin_lock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002611 if (!test_and_set_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2612 list_add_tail(&NFS_I(inode)->access_cache_inode_lru,
2613 &nfs_access_lru_list);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002614 spin_unlock(&nfs_access_lru_lock);
2615 }
Trond Myklebust3a505842014-07-21 13:53:48 -04002616 nfs_access_cache_enforce_limit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617}
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002618EXPORT_SYMBOL_GPL(nfs_access_add_cache);
2619
Anna Schumaker3c181822017-07-26 10:14:55 -04002620#define NFS_MAY_READ (NFS_ACCESS_READ)
2621#define NFS_MAY_WRITE (NFS_ACCESS_MODIFY | \
2622 NFS_ACCESS_EXTEND | \
2623 NFS_ACCESS_DELETE)
2624#define NFS_FILE_MAY_WRITE (NFS_ACCESS_MODIFY | \
2625 NFS_ACCESS_EXTEND)
Trond Myklebustecbb9032017-07-11 17:54:35 -04002626#define NFS_DIR_MAY_WRITE NFS_MAY_WRITE
Anna Schumaker3c181822017-07-26 10:14:55 -04002627#define NFS_MAY_LOOKUP (NFS_ACCESS_LOOKUP)
2628#define NFS_MAY_EXECUTE (NFS_ACCESS_EXECUTE)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002629static int
Trond Myklebustecbb9032017-07-11 17:54:35 -04002630nfs_access_calc_mask(u32 access_result, umode_t umode)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002631{
2632 int mask = 0;
2633
2634 if (access_result & NFS_MAY_READ)
2635 mask |= MAY_READ;
Trond Myklebustecbb9032017-07-11 17:54:35 -04002636 if (S_ISDIR(umode)) {
2637 if ((access_result & NFS_DIR_MAY_WRITE) == NFS_DIR_MAY_WRITE)
2638 mask |= MAY_WRITE;
2639 if ((access_result & NFS_MAY_LOOKUP) == NFS_MAY_LOOKUP)
2640 mask |= MAY_EXEC;
2641 } else if (S_ISREG(umode)) {
2642 if ((access_result & NFS_FILE_MAY_WRITE) == NFS_FILE_MAY_WRITE)
2643 mask |= MAY_WRITE;
2644 if ((access_result & NFS_MAY_EXECUTE) == NFS_MAY_EXECUTE)
2645 mask |= MAY_EXEC;
2646 } else if (access_result & NFS_MAY_WRITE)
2647 mask |= MAY_WRITE;
Trond Myklebust15d4b732017-07-11 17:54:32 -04002648 return mask;
2649}
2650
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002651void nfs_access_set_mask(struct nfs_access_entry *entry, u32 access_result)
2652{
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002653 entry->mask = access_result;
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002654}
2655EXPORT_SYMBOL_GPL(nfs_access_set_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656
NeilBrownb68572e2018-12-03 11:30:30 +11002657static int nfs_do_access(struct inode *inode, const struct cred *cred, int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658{
2659 struct nfs_access_entry cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002660 bool may_block = (mask & MAY_NOT_BLOCK) == 0;
Trond Myklebuste8194b72020-01-06 15:25:12 -05002661 int cache_mask = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 int status;
2663
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002664 trace_nfs_access_enter(inode);
2665
Frank van der Lindend2ae4f82020-06-23 22:38:57 +00002666 status = nfs_access_get_cached(inode, cred, &cache, may_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667 if (status == 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002668 goto out_cached;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669
NeilBrownf3324a22014-07-14 11:28:20 +10002670 status = -ECHILD;
Trond Myklebust57b69182016-06-03 17:07:19 -04002671 if (!may_block)
NeilBrownf3324a22014-07-14 11:28:20 +10002672 goto out;
2673
Anna Schumaker1750d922017-07-26 12:00:21 -04002674 /*
2675 * Determine which access bits we want to ask for...
2676 */
2677 cache.mask = NFS_ACCESS_READ | NFS_ACCESS_MODIFY | NFS_ACCESS_EXTEND;
Frank van der Linden72832a22020-06-23 22:38:58 +00002678 if (nfs_server_capable(inode, NFS_CAP_XATTR)) {
2679 cache.mask |= NFS_ACCESS_XAREAD | NFS_ACCESS_XAWRITE |
2680 NFS_ACCESS_XALIST;
2681 }
Anna Schumaker1750d922017-07-26 12:00:21 -04002682 if (S_ISDIR(inode->i_mode))
2683 cache.mask |= NFS_ACCESS_DELETE | NFS_ACCESS_LOOKUP;
2684 else
2685 cache.mask |= NFS_ACCESS_EXECUTE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 cache.cred = cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 status = NFS_PROTO(inode)->access(inode, &cache);
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002688 if (status != 0) {
2689 if (status == -ESTALE) {
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002690 if (!S_ISDIR(inode->i_mode))
Trond Myklebust93ce4af2020-04-06 13:39:29 -04002691 nfs_set_inode_stale(inode);
2692 else
2693 nfs_zap_caches(inode);
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002694 }
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002695 goto out;
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 nfs_access_add_cache(inode, &cache);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002698out_cached:
Trond Myklebustecbb9032017-07-11 17:54:35 -04002699 cache_mask = nfs_access_calc_mask(cache.mask, inode->i_mode);
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002700 if ((mask & ~cache_mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) != 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002701 status = -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702out:
Trond Myklebuste8194b72020-01-06 15:25:12 -05002703 trace_nfs_access_exit(inode, mask, cache_mask, status);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002704 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002705}
2706
Trond Myklebustaf22f942007-08-10 17:45:10 -04002707static int nfs_open_permission_mask(int openflags)
2708{
2709 int mask = 0;
2710
Weston Andros Adamsonf8d9a892013-01-03 16:42:29 -05002711 if (openflags & __FMODE_EXEC) {
2712 /* ONLY check exec rights */
2713 mask = MAY_EXEC;
2714 } else {
2715 if ((openflags & O_ACCMODE) != O_WRONLY)
2716 mask |= MAY_READ;
2717 if ((openflags & O_ACCMODE) != O_RDONLY)
2718 mask |= MAY_WRITE;
2719 }
2720
Trond Myklebustaf22f942007-08-10 17:45:10 -04002721 return mask;
2722}
2723
NeilBrownb68572e2018-12-03 11:30:30 +11002724int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags)
Trond Myklebustaf22f942007-08-10 17:45:10 -04002725{
2726 return nfs_do_access(inode, cred, nfs_open_permission_mask(openflags));
2727}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04002728EXPORT_SYMBOL_GPL(nfs_may_open);
Trond Myklebustaf22f942007-08-10 17:45:10 -04002729
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002730static int nfs_execute_ok(struct inode *inode, int mask)
2731{
2732 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002733 int ret = 0;
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002734
Trond Myklebust38258272018-07-24 14:27:11 -04002735 if (S_ISDIR(inode->i_mode))
2736 return 0;
Trond Myklebustcf834022018-07-20 16:19:35 -04002737 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_OTHER)) {
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002738 if (mask & MAY_NOT_BLOCK)
2739 return -ECHILD;
2740 ret = __nfs_revalidate_inode(server, inode);
2741 }
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002742 if (ret == 0 && !execute_ok(inode))
2743 ret = -EACCES;
2744 return ret;
2745}
2746
Al Viro10556cb22011-06-20 19:28:19 -04002747int nfs_permission(struct inode *inode, int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748{
NeilBrownb68572e2018-12-03 11:30:30 +11002749 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 int res = 0;
2751
Chuck Lever91d5b472006-03-20 13:44:14 -05002752 nfs_inc_stats(inode, NFSIOS_VFSACCESS);
2753
Al Viroe6305c42008-07-15 21:03:57 -04002754 if ((mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755 goto out;
2756 /* Is this sys_access() ? */
Eric Paris9cfcac82010-07-23 11:43:51 -04002757 if (mask & (MAY_ACCESS | MAY_CHDIR))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 goto force_lookup;
2759
2760 switch (inode->i_mode & S_IFMT) {
2761 case S_IFLNK:
2762 goto out;
2763 case S_IFREG:
Trond Myklebust762674f2015-12-26 21:54:58 -05002764 if ((mask & MAY_OPEN) &&
2765 nfs_server_capable(inode, NFS_CAP_ATOMIC_OPEN))
2766 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 break;
2768 case S_IFDIR:
2769 /*
2770 * Optimize away all write operations, since the server
2771 * will check permissions when we perform the op.
2772 */
2773 if ((mask & MAY_WRITE) && !(mask & MAY_READ))
2774 goto out;
2775 }
2776
2777force_lookup:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 if (!NFS_PROTO(inode)->access)
2779 goto out_notsup;
2780
Zhouyi Zhoueb095c12020-03-06 03:45:26 +00002781 res = nfs_do_access(inode, cred, mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782out:
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002783 if (!res && (mask & MAY_EXEC))
2784 res = nfs_execute_ok(inode, mask);
Miklos Szeredif696a362008-07-31 13:41:58 +02002785
Niels de Vos1e8968c2013-12-17 18:20:16 +01002786 dfprintk(VFS, "NFS: permission(%s/%lu), mask=0x%x, res=%d\n",
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05002787 inode->i_sb->s_id, inode->i_ino, mask, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002788 return res;
2789out_notsup:
NeilBrownd51ac1a2014-07-14 11:28:20 +10002790 if (mask & MAY_NOT_BLOCK)
2791 return -ECHILD;
2792
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 res = nfs_revalidate_inode(NFS_SERVER(inode), inode);
2794 if (res == 0)
Al Viro2830ba72011-06-20 19:16:29 -04002795 res = generic_permission(inode, mask);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05002796 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002798EXPORT_SYMBOL_GPL(nfs_permission);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799
2800/*
2801 * Local variables:
2802 * version-control: t
2803 * kept-new-versions: 5
2804 * End:
2805 */