blob: 5a8ff7e97ce34a611430cf723d86e0674930cc9f [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,
Benjamin Coddingtonb044f642017-03-10 17:07:46 -050061 .iterate = 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;
144 struct nfs_cache_array_entry array[0];
145};
146
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400147typedef int (*decode_dirent_t)(struct xdr_stream *, struct nfs_entry *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148typedef struct {
149 struct file *file;
150 struct page *page;
Al Viro23db8622013-05-17 16:34:50 -0400151 struct dir_context *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 unsigned long page_index;
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000153 u64 *dir_cookie;
Trond Myklebust0aded702010-11-30 21:56:32 -0500154 u64 last_cookie;
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000155 loff_t current_index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 decode_dirent_t decode;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400157
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
242static
243int nfs_readdir_search_for_pos(struct nfs_cache_array *array, nfs_readdir_descriptor_t *desc)
244{
Al Viro23db8622013-05-17 16:34:50 -0400245 loff_t diff = desc->ctx->pos - desc->current_index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400246 unsigned int index;
247
248 if (diff < 0)
249 goto out_eof;
250 if (diff >= array->size) {
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500251 if (array->eof_index >= 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400252 goto out_eof;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400253 return -EAGAIN;
254 }
255
256 index = (unsigned int)diff;
257 *desc->dir_cookie = array->array[index].cookie;
258 desc->cache_entry_index = index;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400259 return 0;
260out_eof:
Thomas Meyer6089dd02017-10-07 16:02:21 +0200261 desc->eof = true;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400262 return -EBADCOOKIE;
263}
264
Jeff Layton4db72b42014-01-28 13:47:46 -0500265static bool
266nfs_readdir_inode_mapping_valid(struct nfs_inode *nfsi)
267{
268 if (nfsi->cache_validity & (NFS_INO_INVALID_ATTR|NFS_INO_INVALID_DATA))
269 return false;
270 smp_rmb();
271 return !test_bit(NFS_INO_INVALIDATING, &nfsi->flags);
272}
273
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400274static
275int nfs_readdir_search_for_cookie(struct nfs_cache_array *array, nfs_readdir_descriptor_t *desc)
276{
277 int i;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400278 loff_t new_pos;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400279 int status = -EAGAIN;
280
281 for (i = 0; i < array->size; i++) {
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400282 if (array->array[i].cookie == *desc->dir_cookie) {
Al Viro496ad9a2013-01-23 17:07:38 -0500283 struct nfs_inode *nfsi = NFS_I(file_inode(desc->file));
Trond Myklebust0c030802011-07-30 12:45:35 -0400284 struct nfs_open_dir_context *ctx = desc->file->private_data;
285
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400286 new_pos = desc->current_index + i;
Jeff Layton4db72b42014-01-28 13:47:46 -0500287 if (ctx->attr_gencount != nfsi->attr_gencount ||
288 !nfs_readdir_inode_mapping_valid(nfsi)) {
Trond Myklebust0c030802011-07-30 12:45:35 -0400289 ctx->duped = 0;
290 ctx->attr_gencount = nfsi->attr_gencount;
Al Viro23db8622013-05-17 16:34:50 -0400291 } else if (new_pos < desc->ctx->pos) {
Trond Myklebust0c030802011-07-30 12:45:35 -0400292 if (ctx->duped > 0
293 && ctx->dup_cookie == *desc->dir_cookie) {
294 if (printk_ratelimit()) {
Al Viro6de14722013-09-16 10:53:17 -0400295 pr_notice("NFS: directory %pD2 contains a readdir loop."
Trond Myklebust0c030802011-07-30 12:45:35 -0400296 "Please contact your server vendor. "
Jeff Layton9581a4a2014-04-05 08:45:57 -0400297 "The file: %.*s has duplicate cookie %llu\n",
298 desc->file, array->array[i].string.len,
299 array->array[i].string.name, *desc->dir_cookie);
Trond Myklebust0c030802011-07-30 12:45:35 -0400300 }
301 status = -ELOOP;
302 goto out;
303 }
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400304 ctx->dup_cookie = *desc->dir_cookie;
Trond Myklebust0c030802011-07-30 12:45:35 -0400305 ctx->duped = -1;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400306 }
Al Viro23db8622013-05-17 16:34:50 -0400307 desc->ctx->pos = new_pos;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400308 desc->cache_entry_index = i;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500309 return 0;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400310 }
311 }
Trond Myklebust47c716c2010-12-07 12:44:56 -0500312 if (array->eof_index >= 0) {
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500313 status = -EBADCOOKIE;
Trond Myklebust18fb5fe2010-12-07 12:41:58 -0500314 if (*desc->dir_cookie == array->last_cookie)
Thomas Meyer6089dd02017-10-07 16:02:21 +0200315 desc->eof = true;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500316 }
Trond Myklebust0c030802011-07-30 12:45:35 -0400317out:
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400318 return status;
319}
320
321static
322int nfs_readdir_search_array(nfs_readdir_descriptor_t *desc)
323{
324 struct nfs_cache_array *array;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500325 int status;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400326
Fabian Frederick0795bf82017-05-03 20:52:21 +0200327 array = kmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400328
329 if (*desc->dir_cookie == 0)
330 status = nfs_readdir_search_for_pos(array, desc);
331 else
332 status = nfs_readdir_search_for_cookie(array, desc);
333
Trond Myklebust47c716c2010-12-07 12:44:56 -0500334 if (status == -EAGAIN) {
Trond Myklebust0aded702010-11-30 21:56:32 -0500335 desc->last_cookie = array->last_cookie;
Trond Myklebuste47c0852011-03-23 08:43:09 -0400336 desc->current_index += array->size;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500337 desc->page_index++;
338 }
Fabian Frederick0795bf82017-05-03 20:52:21 +0200339 kunmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400340 return status;
341}
342
343/* Fill a page with xdr information before transferring to the cache page */
344static
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400345int nfs_readdir_xdr_filler(struct page **pages, nfs_readdir_descriptor_t *desc,
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400346 struct nfs_entry *entry, struct file *file, struct inode *inode)
347{
Bryan Schumaker480c2002011-03-23 14:48:29 -0400348 struct nfs_open_dir_context *ctx = file->private_data;
NeilBrown684f39b2018-12-03 11:30:30 +1100349 const struct cred *cred = ctx->cred;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400350 unsigned long timestamp, gencount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 int error;
352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 again:
354 timestamp = jiffies;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400355 gencount = nfs_inc_attr_generation_counter();
Miklos Szeredibe62a1a2016-03-26 16:14:39 -0400356 error = NFS_PROTO(inode)->readdir(file_dentry(file), cred, entry->cookie, pages,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 NFS_SERVER(inode)->dtsize, desc->plus);
358 if (error < 0) {
359 /* We requested READDIRPLUS, but the server doesn't grok it */
360 if (error == -ENOTSUPP && desc->plus) {
361 NFS_SERVER(inode)->caps &= ~NFS_CAP_READDIRPLUS;
Benny Halevy3a10c302008-01-23 08:58:59 +0200362 clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400363 desc->plus = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 goto again;
365 }
366 goto error;
367 }
Neil Brown1f4eab72007-04-16 09:35:27 +1000368 desc->timestamp = timestamp;
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400369 desc->gencount = gencount;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400370error:
371 return error;
372}
373
Chuck Lever573c4e12010-12-14 14:58:11 +0000374static int xdr_decode(nfs_readdir_descriptor_t *desc,
375 struct nfs_entry *entry, struct xdr_stream *xdr)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400376{
Chuck Lever573c4e12010-12-14 14:58:11 +0000377 int error;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400378
Chuck Lever573c4e12010-12-14 14:58:11 +0000379 error = desc->decode(xdr, entry, desc->plus);
380 if (error)
381 return error;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400382 entry->fattr->time_start = desc->timestamp;
383 entry->fattr->gencount = desc->gencount;
384 return 0;
385}
386
Trond Myklebustfa923362015-02-23 18:51:32 -0500387/* Match file and dirent using either filehandle or fileid
388 * Note: caller is responsible for checking the fsid
389 */
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400390static
391int nfs_same_file(struct dentry *dentry, struct nfs_entry *entry)
392{
Trond Myklebustd8fdb472016-06-17 16:48:27 -0400393 struct inode *inode;
Trond Myklebustfa923362015-02-23 18:51:32 -0500394 struct nfs_inode *nfsi;
395
David Howells2b0143b2015-03-17 22:25:59 +0000396 if (d_really_is_negative(dentry))
397 return 0;
Trond Myklebustfa923362015-02-23 18:51:32 -0500398
Trond Myklebustd8fdb472016-06-17 16:48:27 -0400399 inode = d_inode(dentry);
400 if (is_bad_inode(inode) || NFS_STALE(inode))
401 return 0;
402
403 nfsi = NFS_I(inode);
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400404 if (entry->fattr->fileid != nfsi->fileid)
405 return 0;
406 if (entry->fh->size && nfs_compare_fh(entry->fh, &nfsi->fh) != 0)
407 return 0;
408 return 1;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400409}
410
411static
Al Viro23db8622013-05-17 16:34:50 -0400412bool nfs_use_readdirplus(struct inode *dir, struct dir_context *ctx)
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400413{
414 if (!nfs_server_capable(dir, NFS_CAP_READDIRPLUS))
415 return false;
416 if (test_and_clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(dir)->flags))
417 return true;
Al Viro23db8622013-05-17 16:34:50 -0400418 if (ctx->pos == 0)
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400419 return true;
420 return false;
421}
422
423/*
Trond Myklebust63519fb2016-11-19 11:21:54 -0500424 * This function is called by the lookup and getattr code to request the
425 * use of readdirplus to accelerate any future lookups in the same
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400426 * directory.
427 */
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400428void nfs_advise_use_readdirplus(struct inode *dir)
429{
Trond Myklebust63519fb2016-11-19 11:21:54 -0500430 struct nfs_inode *nfsi = NFS_I(dir);
431
432 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
433 !list_empty(&nfsi->open_files))
434 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400435}
436
Trond Myklebust311324a2014-02-07 17:02:08 -0500437/*
438 * This function is mainly for use by nfs_getattr().
439 *
440 * If this is an 'ls -l', we want to force use of readdirplus.
441 * Do this by checking if there is an active file descriptor
442 * and calling nfs_advise_use_readdirplus, then forcing a
443 * cache flush.
444 */
445void nfs_force_use_readdirplus(struct inode *dir)
446{
Trond Myklebust63519fb2016-11-19 11:21:54 -0500447 struct nfs_inode *nfsi = NFS_I(dir);
448
449 if (nfs_server_capable(dir, NFS_CAP_READDIRPLUS) &&
450 !list_empty(&nfsi->open_files)) {
451 set_bit(NFS_INO_ADVISE_RDPLUS, &nfsi->flags);
Trond Myklebust79f687a32016-11-19 10:54:55 -0500452 invalidate_mapping_pages(dir->i_mapping, 0, -1);
Trond Myklebust311324a2014-02-07 17:02:08 -0500453 }
454}
455
Trond Myklebustd69ee9b2012-05-01 17:37:59 -0400456static
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400457void nfs_prime_dcache(struct dentry *parent, struct nfs_entry *entry)
458{
Linus Torvalds26fe5752012-05-10 13:14:12 -0700459 struct qstr filename = QSTR_INIT(entry->name, entry->len);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400460 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
Trond Myklebust4a201d62010-10-23 14:53:23 -0400461 struct dentry *dentry;
462 struct dentry *alias;
David Howells2b0143b2015-03-17 22:25:59 +0000463 struct inode *dir = d_inode(parent);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400464 struct inode *inode;
David Quigleyaa9c2662013-05-22 12:50:44 -0400465 int status;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400466
Trond Myklebustfa923362015-02-23 18:51:32 -0500467 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FILEID))
468 return;
Trond Myklebust6c441c22015-02-22 16:35:36 -0500469 if (!(entry->fattr->valid & NFS_ATTR_FATTR_FSID))
470 return;
Trond Myklebust78d04af2016-09-20 14:34:24 -0400471 if (filename.len == 0)
472 return;
473 /* Validate that the name doesn't contain any illegal '\0' */
474 if (strnlen(filename.name, filename.len) != filename.len)
475 return;
476 /* ...or '/' */
477 if (strnchr(filename.name, filename.len, '/'))
478 return;
Trond Myklebust4a201d62010-10-23 14:53:23 -0400479 if (filename.name[0] == '.') {
480 if (filename.len == 1)
481 return;
482 if (filename.len == 2 && filename.name[1] == '.')
483 return;
484 }
Linus Torvalds8387ff22016-06-10 07:51:30 -0700485 filename.hash = full_name_hash(parent, filename.name, filename.len);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400486
Trond Myklebust4a201d62010-10-23 14:53:23 -0400487 dentry = d_lookup(parent, &filename);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400488again:
489 if (!dentry) {
490 dentry = d_alloc_parallel(parent, &filename, &wq);
491 if (IS_ERR(dentry))
492 return;
493 }
494 if (!d_in_lookup(dentry)) {
Trond Myklebust6c441c22015-02-22 16:35:36 -0500495 /* Is there a mountpoint here? If so, just exit */
496 if (!nfs_fsid_equal(&NFS_SB(dentry->d_sb)->fsid,
497 &entry->fattr->fsid))
498 goto out;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400499 if (nfs_same_file(dentry, entry)) {
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400500 if (!entry->fh->size)
501 goto out;
Jeff Laytoncda57a12013-07-04 06:35:23 -0400502 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
David Howells2b0143b2015-03-17 22:25:59 +0000503 status = nfs_refresh_inode(d_inode(dentry), entry->fattr);
David Quigleyaa9c2662013-05-22 12:50:44 -0400504 if (!status)
David Howells2b0143b2015-03-17 22:25:59 +0000505 nfs_setsecurity(d_inode(dentry), entry->fattr, entry->label);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400506 goto out;
507 } else {
Eric W. Biederman5542aa22014-02-13 09:46:25 -0800508 d_invalidate(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400509 dput(dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400510 dentry = NULL;
511 goto again;
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400512 }
513 }
Trond Myklebust7dc72d52016-09-22 13:38:52 -0400514 if (!entry->fh->size) {
515 d_lookup_done(dentry);
516 goto out;
517 }
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400518
David Quigley1775fd32013-05-22 12:50:42 -0400519 inode = nfs_fhget(dentry->d_sb, entry->fh, entry->fattr, entry->label);
Al Viro41d28bc2014-10-12 22:24:21 -0400520 alias = d_splice_alias(inode, dentry);
Al Viro9ac3d3e2016-04-28 19:52:56 -0400521 d_lookup_done(dentry);
522 if (alias) {
523 if (IS_ERR(alias))
524 goto out;
525 dput(dentry);
526 dentry = alias;
527 }
528 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400529out:
530 dput(dentry);
Bryan Schumakerd39ab9d2010-09-24 18:50:01 -0400531}
532
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400533/* Perform conversion from xdr to cache array */
534static
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500535int nfs_readdir_page_filler(nfs_readdir_descriptor_t *desc, struct nfs_entry *entry,
Trond Myklebust66502392011-01-08 17:45:38 -0500536 struct page **xdr_pages, struct page *page, unsigned int buflen)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400537{
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400538 struct xdr_stream stream;
Benny Halevyf7da7a12011-05-19 14:16:47 -0400539 struct xdr_buf buf;
Trond Myklebust66502392011-01-08 17:45:38 -0500540 struct page *scratch;
Bryan Schumaker99424382010-10-21 16:33:16 -0400541 struct nfs_cache_array *array;
Trond Myklebust5c346852010-11-20 12:43:45 -0500542 unsigned int count = 0;
543 int status;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400544
Trond Myklebust66502392011-01-08 17:45:38 -0500545 scratch = alloc_page(GFP_KERNEL);
546 if (scratch == NULL)
547 return -ENOMEM;
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400548
Benjamin Coddingtonce85cfb2015-04-21 14:17:35 -0400549 if (buflen == 0)
550 goto out_nopages;
551
Benny Halevyf7da7a12011-05-19 14:16:47 -0400552 xdr_init_decode_pages(&stream, &buf, xdr_pages, buflen);
Trond Myklebust66502392011-01-08 17:45:38 -0500553 xdr_set_scratch_buffer(&stream, page_address(scratch), PAGE_SIZE);
Bryan Schumaker99424382010-10-21 16:33:16 -0400554
555 do {
556 status = xdr_decode(desc, entry, &stream);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500557 if (status != 0) {
558 if (status == -EAGAIN)
559 status = 0;
Bryan Schumaker99424382010-10-21 16:33:16 -0400560 break;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500561 }
Bryan Schumaker99424382010-10-21 16:33:16 -0400562
Trond Myklebust5c346852010-11-20 12:43:45 -0500563 count++;
564
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400565 if (desc->plus)
Miklos Szeredibe62a1a2016-03-26 16:14:39 -0400566 nfs_prime_dcache(file_dentry(desc->file), entry);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500567
Max Kellermanndb531db2019-07-12 16:18:06 +0200568 status = nfs_readdir_add_to_array(entry, page);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500569 if (status != 0)
570 break;
Bryan Schumaker99424382010-10-21 16:33:16 -0400571 } while (!entry->eof);
572
Benjamin Coddingtonce85cfb2015-04-21 14:17:35 -0400573out_nopages:
Trond Myklebust47c716c2010-12-07 12:44:56 -0500574 if (count == 0 || (status == -EBADCOOKIE && entry->eof != 0)) {
Max Kellermanndb531db2019-07-12 16:18:06 +0200575 array = kmap(page);
Fabian Frederick0795bf82017-05-03 20:52:21 +0200576 array->eof_index = array->size;
577 status = 0;
Max Kellermanndb531db2019-07-12 16:18:06 +0200578 kunmap(page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400579 }
Trond Myklebust66502392011-01-08 17:45:38 -0500580
581 put_page(scratch);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500582 return status;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400583}
584
585static
Anna Schumakerc7e96682015-07-13 14:01:25 -0400586void nfs_readdir_free_pages(struct page **pages, unsigned int npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400587{
588 unsigned int i;
589 for (i = 0; i < npages; i++)
590 put_page(pages[i]);
591}
592
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400593/*
zhangliguangbf211ca2019-02-16 08:38:40 +0800594 * nfs_readdir_alloc_pages() will allocate pages that must be freed with a call
595 * to nfs_readdir_free_pages()
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400596 */
597static
Anna Schumakerc7e96682015-07-13 14:01:25 -0400598int nfs_readdir_alloc_pages(struct page **pages, unsigned int npages)
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400599{
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400600 unsigned int i;
601
602 for (i = 0; i < npages; i++) {
603 struct page *page = alloc_page(GFP_KERNEL);
604 if (page == NULL)
605 goto out_freepages;
606 pages[i] = page;
607 }
Trond Myklebust66502392011-01-08 17:45:38 -0500608 return 0;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400609
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400610out_freepages:
Anna Schumakerc7e96682015-07-13 14:01:25 -0400611 nfs_readdir_free_pages(pages, i);
Trond Myklebust66502392011-01-08 17:45:38 -0500612 return -ENOMEM;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400613}
614
615static
616int nfs_readdir_xdr_to_array(nfs_readdir_descriptor_t *desc, struct page *page, struct inode *inode)
617{
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400618 struct page *pages[NFS_MAX_READDIR_PAGES];
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400619 struct nfs_entry entry;
620 struct file *file = desc->file;
621 struct nfs_cache_array *array;
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500622 int status = -ENOMEM;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400623 unsigned int array_size = ARRAY_SIZE(pages);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400624
Trond Myklebust4b310312020-02-02 17:53:53 -0500625 nfs_readdir_init_array(page);
626
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400627 entry.prev_cookie = 0;
Trond Myklebust0aded702010-11-30 21:56:32 -0500628 entry.cookie = desc->last_cookie;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400629 entry.eof = 0;
630 entry.fh = nfs_alloc_fhandle();
631 entry.fattr = nfs_alloc_fattr();
Chuck Lever573c4e12010-12-14 14:58:11 +0000632 entry.server = NFS_SERVER(inode);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400633 if (entry.fh == NULL || entry.fattr == NULL)
634 goto out;
635
David Quigley14c43f72013-05-22 12:50:43 -0400636 entry.label = nfs4_label_alloc(NFS_SERVER(inode), GFP_NOWAIT);
637 if (IS_ERR(entry.label)) {
638 status = PTR_ERR(entry.label);
639 goto out;
640 }
641
Fabian Frederick0795bf82017-05-03 20:52:21 +0200642 array = kmap(page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400643
Anna Schumakerc7e96682015-07-13 14:01:25 -0400644 status = nfs_readdir_alloc_pages(pages, array_size);
Trond Myklebust66502392011-01-08 17:45:38 -0500645 if (status < 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400646 goto out_release_array;
647 do {
Trond Myklebustac396122010-11-15 20:26:22 -0500648 unsigned int pglen;
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -0400649 status = nfs_readdir_xdr_filler(pages, desc, &entry, file, inode);
Bryan Schumakerbabddc72010-10-20 15:44:29 -0400650
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400651 if (status < 0)
652 break;
Trond Myklebustac396122010-11-15 20:26:22 -0500653 pglen = status;
Trond Myklebust66502392011-01-08 17:45:38 -0500654 status = nfs_readdir_page_filler(desc, &entry, pages, page, pglen);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500655 if (status < 0) {
656 if (status == -ENOSPC)
657 status = 0;
658 break;
659 }
660 } while (array->eof_index < 0);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400661
Anna Schumakerc7e96682015-07-13 14:01:25 -0400662 nfs_readdir_free_pages(pages, array_size);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400663out_release_array:
Fabian Frederick0795bf82017-05-03 20:52:21 +0200664 kunmap(page);
David Quigley14c43f72013-05-22 12:50:43 -0400665 nfs4_label_free(entry.label);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400666out:
667 nfs_free_fattr(entry.fattr);
668 nfs_free_fhandle(entry.fh);
669 return status;
670}
671
672/*
673 * Now we cache directories properly, by converting xdr information
674 * to an array that can be used for lookups later. This results in
675 * fewer cache pages, since we can store more information on each page.
676 * We only need to convert from xdr once so future lookups are much simpler
677 */
678static
Christoph Hellwiga46126c2019-05-01 12:06:35 -0400679int nfs_readdir_filler(void *data, struct page* page)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400680{
Christoph Hellwiga46126c2019-05-01 12:06:35 -0400681 nfs_readdir_descriptor_t *desc = data;
Al Viro496ad9a2013-01-23 17:07:38 -0500682 struct inode *inode = file_inode(desc->file);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500683 int ret;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400684
Max Kellermanndb531db2019-07-12 16:18:06 +0200685 ret = nfs_readdir_xdr_to_array(desc, page, inode);
686 if (ret < 0)
687 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 SetPageUptodate(page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400689
Trond Myklebust2aac05a2008-07-07 13:26:10 -0400690 if (invalidate_inode_pages2_range(inode->i_mapping, page->index + 1, -1) < 0) {
Trond Myklebustcd9ae2b2006-10-19 23:28:40 -0700691 /* Should never happen */
692 nfs_zap_mapping(inode, inode->i_mapping);
693 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 unlock_page(page);
695 return 0;
696 error:
Trond Myklebust4b310312020-02-02 17:53:53 -0500697 nfs_readdir_clear_array(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 unlock_page(page);
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500699 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700}
701
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400702static
703void cache_page_release(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300705 put_page(desc->page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 desc->page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707}
708
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400709static
710struct page *get_cache_page(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711{
Christoph Hellwiga46126c2019-05-01 12:06:35 -0400712 return read_cache_page(desc->file->f_mapping, desc->page_index,
713 nfs_readdir_filler, desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714}
715
716/*
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400717 * Returns 0 if desc->dir_cookie was found on page desc->page_index
Trond Myklebust114de382020-02-02 17:53:54 -0500718 * and locks the page to prevent removal from the page cache.
Olivier Galibert00a92642005-06-22 17:16:29 +0000719 */
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400720static
Trond Myklebust114de382020-02-02 17:53:54 -0500721int find_and_lock_cache_page(nfs_readdir_descriptor_t *desc)
Olivier Galibert00a92642005-06-22 17:16:29 +0000722{
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400723 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000724
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400725 desc->page = get_cache_page(desc);
726 if (IS_ERR(desc->page))
727 return PTR_ERR(desc->page);
Trond Myklebust114de382020-02-02 17:53:54 -0500728 res = lock_page_killable(desc->page);
Trond Myklebust47c716c2010-12-07 12:44:56 -0500729 if (res != 0)
Trond Myklebust114de382020-02-02 17:53:54 -0500730 goto error;
731 res = -EAGAIN;
732 if (desc->page->mapping != NULL) {
733 res = nfs_readdir_search_array(desc);
734 if (res == 0)
735 return 0;
736 }
737 unlock_page(desc->page);
738error:
739 cache_page_release(desc);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400740 return res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000741}
742
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400743/* Search for desc->dir_cookie from the beginning of the page cache */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744static inline
745int readdir_search_pagecache(nfs_readdir_descriptor_t *desc)
746{
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500747 int res;
Olivier Galibert00a92642005-06-22 17:16:29 +0000748
Trond Myklebust0aded702010-11-30 21:56:32 -0500749 if (desc->page_index == 0) {
Trond Myklebust8cd51a02010-11-15 20:26:22 -0500750 desc->current_index = 0;
Trond Myklebust0aded702010-11-30 21:56:32 -0500751 desc->last_cookie = 0;
752 }
Trond Myklebust47c716c2010-12-07 12:44:56 -0500753 do {
Trond Myklebust114de382020-02-02 17:53:54 -0500754 res = find_and_lock_cache_page(desc);
Trond Myklebust47c716c2010-12-07 12:44:56 -0500755 } while (res == -EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 return res;
757}
758
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759/*
760 * Once we've found the start of the dirent within a page: fill 'er up...
761 */
762static
Al Viro23db8622013-05-17 16:34:50 -0400763int nfs_do_filldir(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764{
765 struct file *file = desc->file;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400766 int i = 0;
767 int res = 0;
768 struct nfs_cache_array *array = NULL;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400769 struct nfs_open_dir_context *ctx = file->private_data;
770
Fabian Frederick0795bf82017-05-03 20:52:21 +0200771 array = kmap(desc->page);
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400772 for (i = desc->cache_entry_index; i < array->size; i++) {
Trond Myklebustece0b422010-11-20 13:55:33 -0500773 struct nfs_cache_array_entry *ent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Trond Myklebustece0b422010-11-20 13:55:33 -0500775 ent = &array->array[i];
Al Viro23db8622013-05-17 16:34:50 -0400776 if (!dir_emit(desc->ctx, ent->string.name, ent->string.len,
777 nfs_compat_user_ino64(ent->ino), ent->d_type)) {
Thomas Meyer6089dd02017-10-07 16:02:21 +0200778 desc->eof = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 break;
Trond Myklebustece0b422010-11-20 13:55:33 -0500780 }
Al Viro23db8622013-05-17 16:34:50 -0400781 desc->ctx->pos++;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400782 if (i < (array->size-1))
783 *desc->dir_cookie = array->array[i+1].cookie;
784 else
785 *desc->dir_cookie = array->last_cookie;
Trond Myklebust0c030802011-07-30 12:45:35 -0400786 if (ctx->duped != 0)
787 ctx->duped = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 }
Trond Myklebust47c716c2010-12-07 12:44:56 -0500789 if (array->eof_index >= 0)
Thomas Meyer6089dd02017-10-07 16:02:21 +0200790 desc->eof = true;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400791
Fabian Frederick0795bf82017-05-03 20:52:21 +0200792 kunmap(desc->page);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500793 dfprintk(DIRCACHE, "NFS: nfs_do_filldir() filling ended @ cookie %Lu; returning = %d\n",
794 (unsigned long long)*desc->dir_cookie, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 return res;
796}
797
798/*
799 * If we cannot find a cookie in our cache, we suspect that this is
800 * because it points to a deleted file, so we ask the server to return
801 * whatever it thinks is the next entry. We then feed this to filldir.
802 * If all goes well, we should then be able to find our way round the
803 * cache on the next call to readdir_search_pagecache();
804 *
805 * NOTE: we cannot add the anonymous page to the pagecache because
806 * the data it contains might not be page aligned. Besides,
807 * we should already have a complete representation of the
808 * directory in the page cache by the time we get here.
809 */
810static inline
Al Viro23db8622013-05-17 16:34:50 -0400811int uncached_readdir(nfs_readdir_descriptor_t *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 struct page *page = NULL;
814 int status;
Al Viro496ad9a2013-01-23 17:07:38 -0500815 struct inode *inode = file_inode(desc->file);
Trond Myklebust0c030802011-07-30 12:45:35 -0400816 struct nfs_open_dir_context *ctx = desc->file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500818 dfprintk(DIRCACHE, "NFS: uncached_readdir() searching for cookie %Lu\n",
819 (unsigned long long)*desc->dir_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821 page = alloc_page(GFP_HIGHUSER);
822 if (!page) {
823 status = -ENOMEM;
824 goto out;
825 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -0500827 desc->page_index = 0;
Trond Myklebust0aded702010-11-30 21:56:32 -0500828 desc->last_cookie = *desc->dir_cookie;
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -0500829 desc->page = page;
Trond Myklebust0c030802011-07-30 12:45:35 -0400830 ctx->duped = 0;
Trond Myklebust7a8e1dc2010-11-20 13:24:46 -0500831
Trond Myklebust85f86072010-11-20 13:24:49 -0500832 status = nfs_readdir_xdr_to_array(desc, page, inode);
833 if (status < 0)
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400834 goto out_release;
Bryan Schumakerd1bacf92010-09-24 14:48:42 -0400835
Al Viro23db8622013-05-17 16:34:50 -0400836 status = nfs_do_filldir(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Trond Myklebust114de382020-02-02 17:53:54 -0500838 out_release:
839 nfs_readdir_clear_array(desc->page);
840 cache_page_release(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 out:
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500842 dfprintk(DIRCACHE, "NFS: %s: returns %d\n",
Harvey Harrison3110ff82008-05-02 13:42:44 -0700843 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845}
846
Olivier Galibert00a92642005-06-22 17:16:29 +0000847/* The file offset position represents the dirent entry number. A
848 last cookie cache takes care of the common case of reading the
849 whole directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 */
Al Viro23db8622013-05-17 16:34:50 -0400851static int nfs_readdir(struct file *file, struct dir_context *ctx)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852{
Miklos Szeredibe62a1a2016-03-26 16:14:39 -0400853 struct dentry *dentry = file_dentry(file);
David Howells2b0143b2015-03-17 22:25:59 +0000854 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 nfs_readdir_descriptor_t my_desc,
856 *desc = &my_desc;
Al Viro23db8622013-05-17 16:34:50 -0400857 struct nfs_open_dir_context *dir_ctx = file->private_data;
Scott Mayhew07b5ce82013-07-05 17:49:31 -0400858 int res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Al Viro6de14722013-09-16 10:53:17 -0400860 dfprintk(FILE, "NFS: readdir(%pD2) starting at cookie %llu\n",
861 file, (long long)ctx->pos);
Chuck Lever91d5b472006-03-20 13:44:14 -0500862 nfs_inc_stats(inode, NFSIOS_VFSGETDENTS);
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 /*
Al Viro23db8622013-05-17 16:34:50 -0400865 * ctx->pos points to the dirent entry number.
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000866 * *desc->dir_cookie has the cookie for the next entry. We have
Olivier Galibert00a92642005-06-22 17:16:29 +0000867 * to either find the entry with the appropriate number or
868 * revalidate the cookie.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 */
870 memset(desc, 0, sizeof(*desc));
871
Al Viro23db8622013-05-17 16:34:50 -0400872 desc->file = file;
873 desc->ctx = ctx;
Bryan Schumaker480c2002011-03-23 14:48:29 -0400874 desc->dir_cookie = &dir_ctx->dir_cookie;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 desc->decode = NFS_PROTO(inode)->decode_dirent;
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400876 desc->plus = nfs_use_readdirplus(inode, ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Trond Myklebust79f687a32016-11-19 10:54:55 -0500878 if (ctx->pos == 0 || nfs_attribute_cache_expired(inode))
Scott Mayhew07b5ce82013-07-05 17:49:31 -0400879 res = nfs_revalidate_mapping(inode, file->f_mapping);
Trond Myklebustfccca7f2008-01-26 17:37:47 -0500880 if (res < 0)
881 goto out;
882
Trond Myklebust47c716c2010-12-07 12:44:56 -0500883 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 res = readdir_search_pagecache(desc);
Olivier Galibert00a92642005-06-22 17:16:29 +0000885
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 if (res == -EBADCOOKIE) {
Trond Myklebustece0b422010-11-20 13:55:33 -0500887 res = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 /* This means either end of directory */
Thomas Meyer6089dd02017-10-07 16:02:21 +0200889 if (*desc->dir_cookie && !desc->eof) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 /* Or that the server has 'lost' a cookie */
Al Viro23db8622013-05-17 16:34:50 -0400891 res = uncached_readdir(desc);
Trond Myklebustece0b422010-11-20 13:55:33 -0500892 if (res == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 continue;
894 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 break;
896 }
897 if (res == -ETOOSMALL && desc->plus) {
Benny Halevy3a10c302008-01-23 08:58:59 +0200898 clear_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 nfs_zap_caches(inode);
Trond Myklebustbaf57a02010-09-24 18:49:43 -0400900 desc->page_index = 0;
Benjamin Coddingtona7a3b1e2017-06-20 08:33:44 -0400901 desc->plus = false;
902 desc->eof = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 continue;
904 }
905 if (res < 0)
906 break;
907
Al Viro23db8622013-05-17 16:34:50 -0400908 res = nfs_do_filldir(desc);
Trond Myklebust114de382020-02-02 17:53:54 -0500909 unlock_page(desc->page);
910 cache_page_release(desc);
Trond Myklebustece0b422010-11-20 13:55:33 -0500911 if (res < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 break;
Trond Myklebust47c716c2010-12-07 12:44:56 -0500913 } while (!desc->eof);
Trond Myklebustfccca7f2008-01-26 17:37:47 -0500914out:
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500915 if (res > 0)
916 res = 0;
Al Viro6de14722013-09-16 10:53:17 -0400917 dfprintk(FILE, "NFS: readdir(%pD2) returns %d\n", file, res);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500918 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919}
920
Andrew Morton965c8e52012-12-17 15:59:39 -0800921static loff_t nfs_llseek_dir(struct file *filp, loff_t offset, int whence)
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000922{
Benjamin Coddingtonb044f642017-03-10 17:07:46 -0500923 struct inode *inode = file_inode(filp);
Bryan Schumaker480c2002011-03-23 14:48:29 -0400924 struct nfs_open_dir_context *dir_ctx = filp->private_data;
Chuck Leverb84e06c2008-06-11 17:55:34 -0400925
Al Viro6de14722013-09-16 10:53:17 -0400926 dfprintk(FILE, "NFS: llseek dir(%pD2, %lld, %d)\n",
927 filp, offset, whence);
Chuck Leverb84e06c2008-06-11 17:55:34 -0400928
Andrew Morton965c8e52012-12-17 15:59:39 -0800929 switch (whence) {
Trond Myklebustb2b1ff32018-06-27 16:25:40 -0400930 default:
931 return -EINVAL;
932 case SEEK_SET:
933 if (offset < 0)
934 return -EINVAL;
935 inode_lock(inode);
936 break;
937 case SEEK_CUR:
938 if (offset == 0)
939 return filp->f_pos;
940 inode_lock(inode);
941 offset += filp->f_pos;
942 if (offset < 0) {
943 inode_unlock(inode);
944 return -EINVAL;
945 }
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000946 }
947 if (offset != filp->f_pos) {
948 filp->f_pos = offset;
Bryan Schumaker480c2002011-03-23 14:48:29 -0400949 dir_ctx->dir_cookie = 0;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400950 dir_ctx->duped = 0;
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000951 }
Benjamin Coddingtonb044f642017-03-10 17:07:46 -0500952 inode_unlock(inode);
Trond Myklebustf0dd2132005-06-22 17:16:29 +0000953 return offset;
954}
955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956/*
957 * All directory operations under NFS are synchronous, so fsync()
958 * is a dummy operation.
959 */
Josef Bacik02c24a82011-07-16 20:44:56 -0400960static int nfs_fsync_dir(struct file *filp, loff_t start, loff_t end,
961 int datasync)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962{
Al Viro6de14722013-09-16 10:53:17 -0400963 struct inode *inode = file_inode(filp);
Christoph Hellwig7ea80852010-05-26 17:53:25 +0200964
Al Viro6de14722013-09-16 10:53:17 -0400965 dfprintk(FILE, "NFS: fsync dir(%pD2) datasync %d\n", filp, datasync);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -0500966
Al Viro59551022016-01-22 15:40:57 -0500967 inode_lock(inode);
Al Viro6de14722013-09-16 10:53:17 -0400968 nfs_inc_stats(inode, NFSIOS_VFSFSYNC);
Al Viro59551022016-01-22 15:40:57 -0500969 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 return 0;
971}
972
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400973/**
974 * nfs_force_lookup_revalidate - Mark the directory as having changed
Trond Myklebust302fad72019-02-18 13:32:38 -0500975 * @dir: pointer to directory inode
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400976 *
977 * This forces the revalidation code in nfs_lookup_revalidate() to do a
978 * full lookup on all child dentries of 'dir' whenever a change occurs
979 * on the server that might have invalidated our dcache.
980 *
981 * The caller should be holding dir->i_lock
982 */
983void nfs_force_lookup_revalidate(struct inode *dir)
984{
Trond Myklebust011935a2008-10-14 19:24:50 -0400985 NFS_I(dir)->cache_change_attribute++;
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400986}
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400987EXPORT_SYMBOL_GPL(nfs_force_lookup_revalidate);
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400988
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989/*
990 * A check for whether or not the parent directory has changed.
991 * In the case it has, we assume that the dentries are untrustworthy
992 * and may need to be looked up again.
NeilBrown912a1082014-07-14 11:28:20 +1000993 * If rcu_walk prevents us from performing a full check, return 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 */
NeilBrown912a1082014-07-14 11:28:20 +1000995static int nfs_check_verifier(struct inode *dir, struct dentry *dentry,
996 int rcu_walk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997{
998 if (IS_ROOT(dentry))
999 return 1;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001000 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONE)
1001 return 0;
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001002 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1003 return 0;
1004 /* Revalidate nfsi->cache_change_attribute before we declare a match */
Trond Myklebust1cd9cb02016-12-04 18:34:34 -05001005 if (nfs_mapping_need_revalidate_inode(dir)) {
1006 if (rcu_walk)
1007 return 0;
1008 if (__nfs_revalidate_inode(NFS_SERVER(dir), dir) < 0)
1009 return 0;
1010 }
Trond Myklebustf2c77f42007-10-02 12:54:39 -04001011 if (!nfs_verify_change_attribute(dir, dentry->d_time))
1012 return 0;
1013 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014}
1015
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016/*
Trond Myklebusta12802c2007-10-02 19:13:04 -04001017 * Use intent information to check whether or not we're going to do
1018 * an O_EXCL create using this path component.
1019 */
Al Virofa3c56b2012-06-10 15:36:40 -04001020static int nfs_is_exclusive_create(struct inode *dir, unsigned int flags)
Trond Myklebusta12802c2007-10-02 19:13:04 -04001021{
1022 if (NFS_PROTO(dir)->version == 2)
1023 return 0;
Al Virofa3c56b2012-06-10 15:36:40 -04001024 return flags & LOOKUP_EXCL;
Trond Myklebusta12802c2007-10-02 19:13:04 -04001025}
1026
1027/*
Trond Myklebust1d6757f2005-06-07 18:37:01 -04001028 * Inode and filehandle revalidation for lookups.
1029 *
1030 * We force revalidation in the cases where the VFS sets LOOKUP_REVAL,
1031 * or if the intent information indicates that we're about to open this
1032 * particular file and the "nocto" mount flag is not set.
1033 *
1034 */
Trond Myklebust65a0c142012-12-14 17:51:40 -05001035static
Al Virofa3c56b2012-06-10 15:36:40 -04001036int nfs_lookup_verify_inode(struct inode *inode, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037{
1038 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust65a0c142012-12-14 17:51:40 -05001039 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040
David Howells36d43a42011-01-14 18:45:42 +00001041 if (IS_AUTOMOUNT(inode))
Trond Myklebust4e99a1f2008-03-06 12:34:59 -05001042 return 0;
Trond Myklebust47921922018-05-10 10:08:36 -04001043
1044 if (flags & LOOKUP_OPEN) {
1045 switch (inode->i_mode & S_IFMT) {
1046 case S_IFREG:
1047 /* A NFSv4 OPEN will revalidate later */
1048 if (server->caps & NFS_CAP_ATOMIC_OPEN)
1049 goto out;
1050 /* Fallthrough */
1051 case S_IFDIR:
1052 if (server->flags & NFS_MOUNT_NOCTO)
1053 break;
1054 /* NFS close-to-open cache consistency validation */
1055 goto out_force;
1056 }
1057 }
1058
Al Virofacc3532012-06-10 15:33:51 -04001059 /* VFS wants an on-the-wire revalidation */
Al Virofa3c56b2012-06-10 15:36:40 -04001060 if (flags & LOOKUP_REVAL)
Al Virofacc3532012-06-10 15:33:51 -04001061 goto out_force;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001062out:
Lance Sheltona61246c2018-07-16 13:05:36 -04001063 return (inode->i_nlink == 0) ? -ESTALE : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064out_force:
NeilBrown1fa1e382014-07-14 11:28:20 +10001065 if (flags & LOOKUP_RCU)
1066 return -ECHILD;
Trond Myklebust65a0c142012-12-14 17:51:40 -05001067 ret = __nfs_revalidate_inode(server, inode);
1068 if (ret != 0)
1069 return ret;
1070 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071}
1072
1073/*
1074 * We judge how long we want to trust negative
1075 * dentries by looking at the parent inode mtime.
1076 *
1077 * If parent mtime has changed, we revalidate, else we wait for a
1078 * period corresponding to the parent's attribute cache timeout value.
NeilBrown912a1082014-07-14 11:28:20 +10001079 *
1080 * If LOOKUP_RCU prevents us from performing a full check, return 1
1081 * suggesting a reval is needed.
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001082 *
1083 * Note that when creating a new file, or looking up a rename target,
1084 * then it shouldn't be necessary to revalidate a negative dentry.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 */
1086static inline
1087int nfs_neg_need_reval(struct inode *dir, struct dentry *dentry,
Al Virofa3c56b2012-06-10 15:36:40 -04001088 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089{
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001090 if (flags & (LOOKUP_CREATE | LOOKUP_RENAME_TARGET))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 return 0;
Trond Myklebust4eec9522008-07-15 17:58:13 -04001092 if (NFS_SERVER(dir)->flags & NFS_MOUNT_LOOKUP_CACHE_NONEG)
1093 return 1;
NeilBrown912a1082014-07-14 11:28:20 +10001094 return !nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095}
1096
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001097static int
1098nfs_lookup_revalidate_done(struct inode *dir, struct dentry *dentry,
1099 struct inode *inode, int error)
1100{
1101 switch (error) {
1102 case 1:
1103 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is valid\n",
1104 __func__, dentry);
1105 return 1;
1106 case 0:
1107 nfs_mark_for_revalidate(dir);
1108 if (inode && S_ISDIR(inode->i_mode)) {
1109 /* Purge readdir caches. */
1110 nfs_zap_caches(inode);
1111 /*
1112 * We can't d_drop the root of a disconnected tree:
1113 * its d_hash is on the s_anon list and d_drop() would hide
1114 * it from shrink_dcache_for_unmount(), leading to busy
1115 * inodes on unmount and further oopses.
1116 */
1117 if (IS_ROOT(dentry))
1118 return 1;
1119 }
1120 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) is invalid\n",
1121 __func__, dentry);
1122 return 0;
1123 }
1124 dfprintk(LOOKUPCACHE, "NFS: %s(%pd2) lookup returned error %d\n",
1125 __func__, dentry, error);
1126 return error;
1127}
1128
1129static int
1130nfs_lookup_revalidate_negative(struct inode *dir, struct dentry *dentry,
1131 unsigned int flags)
1132{
1133 int ret = 1;
1134 if (nfs_neg_need_reval(dir, dentry, flags)) {
1135 if (flags & LOOKUP_RCU)
1136 return -ECHILD;
1137 ret = 0;
1138 }
1139 return nfs_lookup_revalidate_done(dir, dentry, NULL, ret);
1140}
1141
1142static int
1143nfs_lookup_revalidate_delegated(struct inode *dir, struct dentry *dentry,
1144 struct inode *inode)
1145{
1146 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1147 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1148}
1149
1150static int
1151nfs_lookup_revalidate_dentry(struct inode *dir, struct dentry *dentry,
1152 struct inode *inode)
1153{
1154 struct nfs_fh *fhandle;
1155 struct nfs_fattr *fattr;
1156 struct nfs4_label *label;
1157 int ret;
1158
1159 ret = -ENOMEM;
1160 fhandle = nfs_alloc_fhandle();
1161 fattr = nfs_alloc_fattr();
1162 label = nfs4_label_alloc(NFS_SERVER(inode), GFP_KERNEL);
1163 if (fhandle == NULL || fattr == NULL || IS_ERR(label))
1164 goto out;
1165
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001166 ret = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001167 if (ret < 0) {
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001168 switch (ret) {
1169 case -ESTALE:
1170 case -ENOENT:
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001171 ret = 0;
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001172 break;
1173 case -ETIMEDOUT:
1174 if (NFS_SERVER(inode)->flags & NFS_MOUNT_SOFTREVAL)
1175 ret = 1;
1176 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001177 goto out;
1178 }
1179 ret = 0;
1180 if (nfs_compare_fh(NFS_FH(inode), fhandle))
1181 goto out;
1182 if (nfs_refresh_inode(inode, fattr) < 0)
1183 goto out;
1184
1185 nfs_setsecurity(inode, fattr, label);
1186 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1187
1188 /* set a readdirplus hint that we had a cache miss */
1189 nfs_force_use_readdirplus(dir);
1190 ret = 1;
1191out:
1192 nfs_free_fattr(fattr);
1193 nfs_free_fhandle(fhandle);
1194 nfs4_label_free(label);
1195 return nfs_lookup_revalidate_done(dir, dentry, inode, ret);
1196}
1197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198/*
1199 * This is called every time the dcache has a lookup hit,
1200 * and we should check whether we can really trust that
1201 * lookup.
1202 *
1203 * NOTE! The hit can be a negative hit too, don't assume
1204 * we have an inode!
1205 *
1206 * If the parent directory is seen to have changed, we throw out the
1207 * cached dentry and do a new lookup.
1208 */
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001209static int
1210nfs_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1211 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Chuck Lever91d5b472006-03-20 13:44:14 -05001216 nfs_inc_stats(dir, NFSIOS_DENTRYREVALIDATE);
David Howells2b0143b2015-03-17 22:25:59 +00001217 inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001219 if (!inode)
1220 return nfs_lookup_revalidate_negative(dir, dentry, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
1222 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001223 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1224 __func__, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 goto out_bad;
1226 }
1227
Bryan Schumaker011e2a72012-06-20 15:53:43 -04001228 if (NFS_PROTO(dir)->have_delegation(inode, FMODE_READ))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001229 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust15860ab2008-12-23 15:21:54 -05001230
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 /* Force a full look up iff the parent directory has changed */
Trond Myklebust73dd6842018-05-10 10:13:09 -04001232 if (!(flags & (LOOKUP_EXCL | LOOKUP_REVAL)) &&
NeilBrown912a1082014-07-14 11:28:20 +10001233 nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU)) {
NeilBrowncc896842017-07-05 12:22:20 +10001234 error = nfs_lookup_verify_inode(inode, flags);
1235 if (error) {
NeilBrowncc896842017-07-05 12:22:20 +10001236 if (error == -ESTALE)
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001237 nfs_zap_caches(dir);
1238 goto out_bad;
NeilBrown1fa1e382014-07-14 11:28:20 +10001239 }
Trond Myklebust63519fb2016-11-19 11:21:54 -05001240 nfs_advise_use_readdirplus(dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 goto out_valid;
1242 }
1243
NeilBrown912a1082014-07-14 11:28:20 +10001244 if (flags & LOOKUP_RCU)
1245 return -ECHILD;
1246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 if (NFS_STALE(inode))
1248 goto out_bad;
1249
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001250 trace_nfs_lookup_revalidate_enter(dir, dentry, flags);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001251 error = nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001252 trace_nfs_lookup_revalidate_exit(dir, dentry, flags, error);
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001253 return error;
1254out_valid:
1255 return nfs_lookup_revalidate_done(dir, dentry, inode, 1);
1256out_bad:
1257 if (flags & LOOKUP_RCU)
1258 return -ECHILD;
1259 return nfs_lookup_revalidate_done(dir, dentry, inode, 0);
1260}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001262static int
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001263__nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags,
1264 int (*reval)(struct inode *, struct dentry *, unsigned int))
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001265{
1266 struct dentry *parent;
1267 struct inode *dir;
1268 int ret;
David Quigleyaa9c2662013-05-22 12:50:44 -04001269
NeilBrownd51ac1a2014-07-14 11:28:20 +10001270 if (flags & LOOKUP_RCU) {
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001271 parent = READ_ONCE(dentry->d_parent);
1272 dir = d_inode_rcu(parent);
1273 if (!dir)
1274 return -ECHILD;
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001275 ret = reval(dir, dentry, flags);
Mark Rutland6aa7de02017-10-23 14:07:29 -07001276 if (parent != READ_ONCE(dentry->d_parent))
NeilBrownd51ac1a2014-07-14 11:28:20 +10001277 return -ECHILD;
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001278 } else {
1279 parent = dget_parent(dentry);
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001280 ret = reval(d_inode(parent), dentry, flags);
NeilBrownd51ac1a2014-07-14 11:28:20 +10001281 dput(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 }
Trond Myklebust5ceb9d72018-09-28 09:04:05 -04001283 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284}
1285
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001286static int nfs_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1287{
1288 return __nfs_lookup_revalidate(dentry, flags, nfs_do_lookup_revalidate);
1289}
1290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291/*
David Howells2b0143b2015-03-17 22:25:59 +00001292 * A weaker form of d_revalidate for revalidating just the d_inode(dentry)
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001293 * when we don't really care about the dentry name. This is called when a
1294 * pathwalk ends on a dentry that was not found via a normal lookup in the
1295 * parent dir (e.g.: ".", "..", procfs symlinks or mountpoint traversals).
1296 *
1297 * In this situation, we just want to verify that the inode itself is OK
1298 * since the dentry might have changed on the server.
1299 */
1300static int nfs_weak_revalidate(struct dentry *dentry, unsigned int flags)
1301{
David Howells2b0143b2015-03-17 22:25:59 +00001302 struct inode *inode = d_inode(dentry);
Trond Myklebust9cdd1d32016-12-16 18:04:47 -05001303 int error = 0;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001304
1305 /*
1306 * I believe we can only get a negative dentry here in the case of a
1307 * procfs-style symlink. Just assume it's correct for now, but we may
1308 * eventually need to do something more here.
1309 */
1310 if (!inode) {
Al Viro6de14722013-09-16 10:53:17 -04001311 dfprintk(LOOKUPCACHE, "%s: %pd2 has negative inode\n",
1312 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001313 return 1;
1314 }
1315
1316 if (is_bad_inode(inode)) {
Al Viro6de14722013-09-16 10:53:17 -04001317 dfprintk(LOOKUPCACHE, "%s: %pd2 has dud inode\n",
1318 __func__, dentry);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001319 return 0;
1320 }
1321
NeilBrownb6887412017-08-25 17:34:41 +10001322 error = nfs_lookup_verify_inode(inode, flags);
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001323 dfprintk(LOOKUPCACHE, "NFS: %s: inode %lu is %s\n",
1324 __func__, inode->i_ino, error ? "invalid" : "valid");
1325 return !error;
1326}
1327
1328/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 * This is called from dput() when d_count is going to 0.
1330 */
Nick Pigginfe15ce42011-01-07 17:49:23 +11001331static int nfs_dentry_delete(const struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332{
Al Viro6de14722013-09-16 10:53:17 -04001333 dfprintk(VFS, "NFS: dentry_delete(%pd2, %x)\n",
1334 dentry, dentry->d_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Trond Myklebust77f11192008-01-28 19:43:19 -05001336 /* Unhash any dentry with a stale inode */
David Howells2b0143b2015-03-17 22:25:59 +00001337 if (d_really_is_positive(dentry) && NFS_STALE(d_inode(dentry)))
Trond Myklebust77f11192008-01-28 19:43:19 -05001338 return 1;
1339
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1341 /* Unhash it, so that ->d_iput() would be called */
1342 return 1;
1343 }
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001344 if (!(dentry->d_sb->s_flags & SB_ACTIVE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 /* Unhash it, so that ancestors of killed async unlink
1346 * files will be cleaned up during umount */
1347 return 1;
1348 }
1349 return 0;
1350
1351}
1352
Trond Myklebust1f018452012-12-14 16:38:46 -05001353/* Ensure that we revalidate inode->i_nlink */
Trond Myklebust1b83d702008-06-11 15:44:04 -04001354static void nfs_drop_nlink(struct inode *inode)
1355{
1356 spin_lock(&inode->i_lock);
Trond Myklebust1f018452012-12-14 16:38:46 -05001357 /* drop the inode if we're reasonably sure this is the last link */
Trond Myklebust59a707b2018-04-08 18:11:18 -04001358 if (inode->i_nlink > 0)
1359 drop_nlink(inode);
1360 NFS_I(inode)->attr_gencount = nfs_inc_attr_generation_counter();
Trond Myklebust16e14372018-03-20 16:53:31 -04001361 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_CHANGE
1362 | NFS_INO_INVALID_CTIME
Trond Myklebust59a707b2018-04-08 18:11:18 -04001363 | NFS_INO_INVALID_OTHER
1364 | NFS_INO_REVAL_FORCED;
Trond Myklebust1b83d702008-06-11 15:44:04 -04001365 spin_unlock(&inode->i_lock);
1366}
1367
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368/*
1369 * Called when the dentry loses inode.
1370 * We use it to clean up silly-renamed files.
1371 */
1372static void nfs_dentry_iput(struct dentry *dentry, struct inode *inode)
1373{
Neil Brown83672d32007-02-26 12:48:25 +11001374 if (S_ISDIR(inode->i_mode))
1375 /* drop any readdir cache as it could easily be old */
1376 NFS_I(inode)->cache_validity |= NFS_INO_INVALID_DATA;
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
Trond Myklebuste4eff1a2007-07-14 15:39:58 -04001379 nfs_complete_unlink(dentry, inode);
Trond Myklebust1f018452012-12-14 16:38:46 -05001380 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 iput(inode);
1383}
1384
Al Virob1942c52011-03-16 05:44:14 -04001385static void nfs_d_release(struct dentry *dentry)
1386{
1387 /* free cached devname value, if it survived that far */
1388 if (unlikely(dentry->d_fsdata)) {
1389 if (dentry->d_flags & DCACHE_NFSFS_RENAMED)
1390 WARN_ON(1);
1391 else
1392 kfree(dentry->d_fsdata);
1393 }
1394}
1395
Al Virof786aa92009-02-20 05:51:22 +00001396const struct dentry_operations nfs_dentry_operations = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 .d_revalidate = nfs_lookup_revalidate,
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001398 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 .d_delete = nfs_dentry_delete,
1400 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001401 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001402 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403};
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001404EXPORT_SYMBOL_GPL(nfs_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Bryan Schumaker597d9282012-07-16 16:39:10 -04001406struct dentry *nfs_lookup(struct inode *dir, struct dentry * dentry, unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407{
1408 struct dentry *res;
1409 struct inode *inode = NULL;
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001410 struct nfs_fh *fhandle = NULL;
1411 struct nfs_fattr *fattr = NULL;
David Quigley1775fd32013-05-22 12:50:42 -04001412 struct nfs4_label *label = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Al Viro6de14722013-09-16 10:53:17 -04001415 dfprintk(VFS, "NFS: lookup(%pd2)\n", dentry);
Chuck Lever91d5b472006-03-20 13:44:14 -05001416 nfs_inc_stats(dir, NFSIOS_VFSLOOKUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417
Al Viro130f9ab2016-03-07 22:40:43 -05001418 if (unlikely(dentry->d_name.len > NFS_SERVER(dir)->namelen))
1419 return ERR_PTR(-ENAMETOOLONG);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Trond Myklebustfd684072006-09-05 12:27:44 -04001421 /*
1422 * If we're doing an exclusive create, optimize away the lookup
1423 * but don't hash the dentry.
1424 */
Trond Myklebust9f6d44d2018-05-10 10:34:21 -04001425 if (nfs_is_exclusive_create(dir, flags) || flags & LOOKUP_RENAME_TARGET)
Al Viro130f9ab2016-03-07 22:40:43 -05001426 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001428 res = ERR_PTR(-ENOMEM);
1429 fhandle = nfs_alloc_fhandle();
1430 fattr = nfs_alloc_fattr();
1431 if (fhandle == NULL || fattr == NULL)
1432 goto out;
1433
David Quigley14c43f72013-05-22 12:50:43 -04001434 label = nfs4_label_alloc(NFS_SERVER(dir), GFP_NOWAIT);
1435 if (IS_ERR(label))
1436 goto out;
1437
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001438 trace_nfs_lookup_enter(dir, dentry, flags);
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001439 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, label);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 if (error == -ENOENT)
1441 goto no_entry;
1442 if (error < 0) {
1443 res = ERR_PTR(error);
Al Virobf130912016-05-29 15:14:14 -04001444 goto out_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 }
David Quigley1775fd32013-05-22 12:50:42 -04001446 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
Namhyung Kimbf0c84f2010-12-28 17:02:46 +00001447 res = ERR_CAST(inode);
Trond Myklebust03f28e32006-03-20 13:44:48 -05001448 if (IS_ERR(res))
Al Virobf130912016-05-29 15:14:14 -04001449 goto out_label;
David Howells54ceac42006-08-22 20:06:13 -04001450
Trond Myklebust63519fb2016-11-19 11:21:54 -05001451 /* Notify readdir to use READDIRPLUS */
1452 nfs_force_use_readdirplus(dir);
Trond Myklebustd69ee9b2012-05-01 17:37:59 -04001453
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454no_entry:
Al Viro41d28bc2014-10-12 22:24:21 -04001455 res = d_splice_alias(inode, dentry);
Trond Myklebust9eaef272006-10-21 10:24:20 -07001456 if (res != NULL) {
1457 if (IS_ERR(res))
Al Virobf130912016-05-29 15:14:14 -04001458 goto out_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 dentry = res;
Trond Myklebust9eaef272006-10-21 10:24:20 -07001460 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Al Virobf130912016-05-29 15:14:14 -04001462out_label:
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001463 trace_nfs_lookup_exit(dir, dentry, flags, error);
David Quigley14c43f72013-05-22 12:50:43 -04001464 nfs4_label_free(label);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465out:
Trond Myklebuste1fb4d02010-04-16 16:22:47 -04001466 nfs_free_fattr(fattr);
1467 nfs_free_fhandle(fhandle);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 return res;
1469}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001470EXPORT_SYMBOL_GPL(nfs_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001472#if IS_ENABLED(CONFIG_NFS_V4)
Al Viro0b728e12012-06-10 16:03:43 -04001473static int nfs4_lookup_revalidate(struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
Al Virof786aa92009-02-20 05:51:22 +00001475const struct dentry_operations nfs4_dentry_operations = {
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02001476 .d_revalidate = nfs4_lookup_revalidate,
NeilBrownb6887412017-08-25 17:34:41 +10001477 .d_weak_revalidate = nfs_weak_revalidate,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 .d_delete = nfs_dentry_delete,
1479 .d_iput = nfs_dentry_iput,
David Howells36d43a42011-01-14 18:45:42 +00001480 .d_automount = nfs_d_automount,
Al Virob1942c52011-03-16 05:44:14 -04001481 .d_release = nfs_d_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482};
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001483EXPORT_SYMBOL_GPL(nfs4_dentry_operations);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
Al Viro8a5e9292011-06-25 19:15:54 -04001485static fmode_t flags_to_mode(int flags)
1486{
1487 fmode_t res = (__force fmode_t)flags & FMODE_EXEC;
1488 if ((flags & O_ACCMODE) != O_WRONLY)
1489 res |= FMODE_READ;
1490 if ((flags & O_ACCMODE) != O_RDONLY)
1491 res |= FMODE_WRITE;
1492 return res;
1493}
1494
NeilBrown532d4de2016-10-13 15:26:47 +11001495static struct nfs_open_context *create_nfs_open_context(struct dentry *dentry, int open_flags, struct file *filp)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001496{
NeilBrown532d4de2016-10-13 15:26:47 +11001497 return alloc_nfs_open_context(dentry, flags_to_mode(open_flags), filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001498}
1499
1500static int do_open(struct inode *inode, struct file *filp)
1501{
David Howellsf1fe29b2013-09-27 11:20:03 +01001502 nfs_fscache_open_file(inode, filp);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001503 return 0;
1504}
1505
Al Virod9585272012-06-22 12:39:14 +04001506static int nfs_finish_open(struct nfs_open_context *ctx,
1507 struct dentry *dentry,
Al Virob452a452018-06-08 13:06:28 -04001508 struct file *file, unsigned open_flags)
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001509{
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001510 int err;
1511
Al Virobe12af32018-06-08 11:44:56 -04001512 err = finish_open(file, dentry, do_open);
Al Viro30d90492012-06-22 12:40:19 +04001513 if (err)
Al Virod9585272012-06-22 12:39:14 +04001514 goto out;
NeilBrowneaa2b822017-07-03 15:27:26 +10001515 if (S_ISREG(file->f_path.dentry->d_inode->i_mode))
1516 nfs_file_set_open_context(file, ctx);
1517 else
Trond Myklebust98214212019-08-09 12:15:07 -04001518 err = -EOPENSTALE;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001519out:
Al Virod9585272012-06-22 12:39:14 +04001520 return err;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001521}
1522
Bryan Schumaker73a79702012-07-16 16:39:12 -04001523int nfs_atomic_open(struct inode *dir, struct dentry *dentry,
1524 struct file *file, unsigned open_flags,
Al Viro44907d72018-06-08 13:32:02 -04001525 umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526{
Al Viroc94c0952016-07-05 09:49:21 -04001527 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001528 struct nfs_open_context *ctx;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001529 struct dentry *res;
1530 struct iattr attr = { .ia_valid = ATTR_OPEN };
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001531 struct inode *inode;
Trond Myklebust1472b832013-08-20 11:59:41 -04001532 unsigned int lookup_flags = 0;
Al Viroc94c0952016-07-05 09:49:21 -04001533 bool switched = false;
Al Viro73a09dd2018-06-08 13:22:02 -04001534 int created = 0;
Trond Myklebust898f6352010-10-23 11:24:25 -04001535 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001537 /* Expect a negative dentry */
David Howells2b0143b2015-03-17 22:25:59 +00001538 BUG_ON(d_inode(dentry));
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001539
Niels de Vos1e8968c2013-12-17 18:20:16 +01001540 dfprintk(VFS, "NFS: atomic_open(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001541 dir->i_sb->s_id, dir->i_ino, dentry);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05001542
Jeff Layton9597c132013-08-02 11:39:32 -04001543 err = nfs_check_flags(open_flags);
1544 if (err)
1545 return err;
1546
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001547 /* NFS only supports OPEN on regular files */
1548 if ((open_flags & O_DIRECTORY)) {
Al Viro00699ad2016-07-05 09:44:53 -04001549 if (!d_in_lookup(dentry)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001550 /*
1551 * Hashed negative dentry with O_DIRECTORY: dentry was
1552 * revalidated and is fine, no need to perform lookup
1553 * again
1554 */
Al Virod9585272012-06-22 12:39:14 +04001555 return -ENOENT;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001556 }
Trond Myklebust1472b832013-08-20 11:59:41 -04001557 lookup_flags = LOOKUP_OPEN|LOOKUP_DIRECTORY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 goto no_open;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001561 if (dentry->d_name.len > NFS_SERVER(dir)->namelen)
Al Virod9585272012-06-22 12:39:14 +04001562 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001564 if (open_flags & O_CREAT) {
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001565 struct nfs_server *server = NFS_SERVER(dir);
1566
1567 if (!(server->attr_bitmask[2] & FATTR4_WORD2_MODE_UMASK))
1568 mode &= ~current_umask();
1569
Trond Myklebust536e43d2012-01-17 22:04:26 -05001570 attr.ia_valid |= ATTR_MODE;
Andreas Gruenbacherdff25dd2016-12-02 22:53:30 -05001571 attr.ia_mode = mode;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001572 }
Trond Myklebust536e43d2012-01-17 22:04:26 -05001573 if (open_flags & O_TRUNC) {
1574 attr.ia_valid |= ATTR_SIZE;
1575 attr.ia_size = 0;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001576 }
1577
Al Viroc94c0952016-07-05 09:49:21 -04001578 if (!(open_flags & O_CREAT) && !d_in_lookup(dentry)) {
1579 d_drop(dentry);
1580 switched = true;
1581 dentry = d_alloc_parallel(dentry->d_parent,
1582 &dentry->d_name, &wq);
1583 if (IS_ERR(dentry))
1584 return PTR_ERR(dentry);
1585 if (unlikely(!d_in_lookup(dentry)))
1586 return finish_no_open(file, dentry);
1587 }
1588
NeilBrown532d4de2016-10-13 15:26:47 +11001589 ctx = create_nfs_open_context(dentry, open_flags, file);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001590 err = PTR_ERR(ctx);
1591 if (IS_ERR(ctx))
Al Virod9585272012-06-22 12:39:14 +04001592 goto out;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001593
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001594 trace_nfs_atomic_open_enter(dir, ctx, open_flags);
Al Viro73a09dd2018-06-08 13:22:02 -04001595 inode = NFS_PROTO(dir)->open_context(dir, ctx, open_flags, &attr, &created);
1596 if (created)
1597 file->f_mode |= FMODE_CREATED;
Trond Myklebustf46e0bd2010-09-17 10:56:50 -04001598 if (IS_ERR(inode)) {
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001599 err = PTR_ERR(inode);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001600 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001601 put_nfs_open_context(ctx);
Al Virod20cb712016-06-20 13:14:36 -04001602 d_drop(dentry);
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001603 switch (err) {
1604 case -ENOENT:
Peng Tao774d9512017-06-29 06:34:50 -07001605 d_splice_alias(NULL, dentry);
Trond Myklebust809fd142014-10-23 19:33:14 +03001606 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001607 break;
1608 case -EISDIR:
1609 case -ENOTDIR:
1610 goto no_open;
1611 case -ELOOP:
1612 if (!(open_flags & O_NOFOLLOW))
Trond Myklebust6f926b52005-10-18 14:20:18 -07001613 goto no_open;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001614 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 /* case -EINVAL: */
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001616 default:
1617 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 }
Al Virod9585272012-06-22 12:39:14 +04001619 goto out;
Trond Myklebustcd9a1c02010-09-17 10:56:50 -04001620 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001621
Al Virob452a452018-06-08 13:06:28 -04001622 err = nfs_finish_open(ctx, ctx->dentry, file, open_flags);
Trond Myklebust6e0d0be2013-08-20 11:26:17 -04001623 trace_nfs_atomic_open_exit(dir, ctx, open_flags, err);
Trond Myklebust2d9db752013-08-30 09:17:33 -04001624 put_nfs_open_context(ctx);
Al Virod9585272012-06-22 12:39:14 +04001625out:
Al Viroc94c0952016-07-05 09:49:21 -04001626 if (unlikely(switched)) {
1627 d_lookup_done(dentry);
1628 dput(dentry);
1629 }
Al Virod9585272012-06-22 12:39:14 +04001630 return err;
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001631
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632no_open:
Trond Myklebust1472b832013-08-20 11:59:41 -04001633 res = nfs_lookup(dir, dentry, lookup_flags);
Al Viroc94c0952016-07-05 09:49:21 -04001634 if (switched) {
1635 d_lookup_done(dentry);
1636 if (!res)
1637 res = dentry;
1638 else
1639 dput(dentry);
1640 }
Miklos Szeredi0dd2b472012-06-05 15:10:18 +02001641 if (IS_ERR(res))
Al Viroc94c0952016-07-05 09:49:21 -04001642 return PTR_ERR(res);
Al Viroe45198a2012-06-10 06:48:09 -04001643 return finish_no_open(file, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04001645EXPORT_SYMBOL_GPL(nfs_atomic_open);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001647static int
1648nfs4_do_lookup_revalidate(struct inode *dir, struct dentry *dentry,
1649 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
Nick Piggin657e94b2011-01-14 02:48:39 +00001651 struct inode *inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Al Virofa3c56b2012-06-10 15:36:40 -04001653 if (!(flags & LOOKUP_OPEN) || (flags & LOOKUP_DIRECTORY))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001654 goto full_reval;
Miklos Szeredieda72af2012-06-05 15:10:21 +02001655 if (d_mountpoint(dentry))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001656 goto full_reval;
Trond Myklebust2b484292010-09-17 10:56:51 -04001657
David Howells2b0143b2015-03-17 22:25:59 +00001658 inode = d_inode(dentry);
Trond Myklebust2b484292010-09-17 10:56:51 -04001659
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 /* We can't create new files in nfs_open_revalidate(), so we
1661 * optimize away revalidation of negative dentries.
1662 */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001663 if (inode == NULL)
1664 goto full_reval;
NeilBrown49317a72014-07-14 11:28:20 +10001665
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001666 if (NFS_PROTO(dir)->have_delegation(inode, FMODE_READ))
1667 return nfs_lookup_revalidate_delegated(dir, dentry, inode);
Trond Myklebust216d5d062007-10-01 20:10:12 -04001668
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 /* NFS only supports OPEN on regular files */
1670 if (!S_ISREG(inode->i_mode))
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001671 goto full_reval;
1672
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 /* We cannot do exclusive creation on a positive dentry */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001674 if (flags & (LOOKUP_EXCL | LOOKUP_REVAL))
1675 goto reval_dentry;
1676
1677 /* Check if the directory changed */
1678 if (!nfs_check_verifier(dir, dentry, flags & LOOKUP_RCU))
1679 goto reval_dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680
Miklos Szeredi0ef97dc2012-05-21 17:30:20 +02001681 /* Let f_op->open() actually open (and revalidate) the file */
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001682 return 1;
1683reval_dentry:
1684 if (flags & LOOKUP_RCU)
1685 return -ECHILD;
zhangliguang42f72cf2019-02-12 09:38:33 +08001686 return nfs_lookup_revalidate_dentry(dir, dentry, inode);
Trond Myklebust536e43d2012-01-17 22:04:26 -05001687
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001688full_reval:
1689 return nfs_do_lookup_revalidate(dir, dentry, flags);
1690}
Trond Myklebust535918f2010-09-17 10:56:51 -04001691
Trond Myklebustc7944eb2018-09-28 12:42:51 -04001692static int nfs4_lookup_revalidate(struct dentry *dentry, unsigned int flags)
1693{
1694 return __nfs_lookup_revalidate(dentry, flags,
1695 nfs4_do_lookup_revalidate);
Trond Myklebustc0204fd2010-09-17 10:56:51 -04001696}
1697
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698#endif /* CONFIG_NFSV4 */
1699
Benjamin Coddington406cd912019-09-13 08:29:02 -04001700struct dentry *
1701nfs_add_or_obtain(struct dentry *dentry, struct nfs_fh *fhandle,
David Quigley1775fd32013-05-22 12:50:42 -04001702 struct nfs_fattr *fattr,
1703 struct nfs4_label *label)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704{
Trond Myklebustfab728e2007-09-29 17:41:33 -04001705 struct dentry *parent = dget_parent(dentry);
David Howells2b0143b2015-03-17 22:25:59 +00001706 struct inode *dir = d_inode(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 struct inode *inode;
Al Virob0c6108e2018-05-16 10:55:01 -04001708 struct dentry *d;
Benjamin Coddington406cd912019-09-13 08:29:02 -04001709 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Trond Myklebustfab728e2007-09-29 17:41:33 -04001711 d_drop(dentry);
1712
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 if (fhandle->size == 0) {
Trond Myklebustf7b37b82020-01-14 12:06:34 -05001714 error = NFS_PROTO(dir)->lookup(dir, dentry, fhandle, fattr, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 if (error)
Trond Myklebustfab728e2007-09-29 17:41:33 -04001716 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 }
Trond Myklebust5724ab32007-10-01 21:51:38 -04001718 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1720 struct nfs_server *server = NFS_SB(dentry->d_sb);
Trond Myklebusta841b542018-04-07 13:50:59 -04001721 error = server->nfs_client->rpc_ops->getattr(server, fhandle,
1722 fattr, NULL, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 if (error < 0)
Trond Myklebustfab728e2007-09-29 17:41:33 -04001724 goto out_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 }
David Quigley1775fd32013-05-22 12:50:42 -04001726 inode = nfs_fhget(dentry->d_sb, fhandle, fattr, label);
Al Virob0c6108e2018-05-16 10:55:01 -04001727 d = d_splice_alias(inode, dentry);
Trond Myklebustfab728e2007-09-29 17:41:33 -04001728out:
1729 dput(parent);
Benjamin Coddington406cd912019-09-13 08:29:02 -04001730 return d;
Trond Myklebustfab728e2007-09-29 17:41:33 -04001731out_error:
1732 nfs_mark_for_revalidate(dir);
Benjamin Coddington406cd912019-09-13 08:29:02 -04001733 d = ERR_PTR(error);
1734 goto out;
1735}
1736EXPORT_SYMBOL_GPL(nfs_add_or_obtain);
1737
1738/*
1739 * Code common to create, mkdir, and mknod.
1740 */
1741int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fhandle,
1742 struct nfs_fattr *fattr,
1743 struct nfs4_label *label)
1744{
1745 struct dentry *d;
1746
1747 d = nfs_add_or_obtain(dentry, fhandle, fattr, label);
1748 if (IS_ERR(d))
1749 return PTR_ERR(d);
1750
1751 /* Callers don't care */
1752 dput(d);
1753 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001755EXPORT_SYMBOL_GPL(nfs_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
1757/*
1758 * Following a failed create operation, we drop the dentry rather
1759 * than retain a negative dentry. This avoids a problem in the event
1760 * that the operation succeeded on the server, but an error in the
1761 * reply path made it appear to have failed.
1762 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001763int nfs_create(struct inode *dir, struct dentry *dentry,
Al Viroebfc3b42012-06-10 18:05:36 -04001764 umode_t mode, bool excl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765{
1766 struct iattr attr;
Al Viroebfc3b42012-06-10 18:05:36 -04001767 int open_flags = excl ? O_CREAT | O_EXCL : O_CREAT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Niels de Vos1e8968c2013-12-17 18:20:16 +01001770 dfprintk(VFS, "NFS: create(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001771 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
1773 attr.ia_mode = mode;
1774 attr.ia_valid = ATTR_MODE;
1775
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04001776 trace_nfs_create_enter(dir, dentry, open_flags);
Miklos Szeredi8867fe52012-06-05 15:10:19 +02001777 error = NFS_PROTO(dir)->create(dir, dentry, &attr, open_flags);
Trond Myklebust8b0ad3d2013-08-21 10:53:09 -04001778 trace_nfs_create_exit(dir, dentry, open_flags, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 if (error != 0)
1780 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 return 0;
1782out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 d_drop(dentry);
1784 return error;
1785}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001786EXPORT_SYMBOL_GPL(nfs_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
1788/*
1789 * See comments for nfs_proc_create regarding failed operations.
1790 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001791int
Al Viro1a67aaf2011-07-26 01:52:52 -04001792nfs_mknod(struct inode *dir, struct dentry *dentry, umode_t mode, dev_t rdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793{
1794 struct iattr attr;
1795 int status;
1796
Niels de Vos1e8968c2013-12-17 18:20:16 +01001797 dfprintk(VFS, "NFS: mknod(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001798 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 attr.ia_mode = mode;
1801 attr.ia_valid = ATTR_MODE;
1802
Trond Myklebust1ca42382013-08-21 12:36:04 -04001803 trace_nfs_mknod_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 status = NFS_PROTO(dir)->mknod(dir, dentry, &attr, rdev);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001805 trace_nfs_mknod_exit(dir, dentry, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 if (status != 0)
1807 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 return 0;
1809out_err:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 d_drop(dentry);
1811 return status;
1812}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001813EXPORT_SYMBOL_GPL(nfs_mknod);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
1815/*
1816 * See comments for nfs_proc_create regarding failed operations.
1817 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001818int nfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819{
1820 struct iattr attr;
1821 int error;
1822
Niels de Vos1e8968c2013-12-17 18:20:16 +01001823 dfprintk(VFS, "NFS: mkdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001824 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
1826 attr.ia_valid = ATTR_MODE;
1827 attr.ia_mode = mode | S_IFDIR;
1828
Trond Myklebust1ca42382013-08-21 12:36:04 -04001829 trace_nfs_mkdir_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 error = NFS_PROTO(dir)->mkdir(dir, dentry, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001831 trace_nfs_mkdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 if (error != 0)
1833 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 return 0;
1835out_err:
1836 d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 return error;
1838}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001839EXPORT_SYMBOL_GPL(nfs_mkdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840
Trond Myklebustd45b9d82008-01-28 19:43:18 -05001841static void nfs_dentry_handle_enoent(struct dentry *dentry)
1842{
Al Virodc3f4192015-05-18 10:10:34 -04001843 if (simple_positive(dentry))
Trond Myklebustd45b9d82008-01-28 19:43:18 -05001844 d_delete(dentry);
1845}
1846
Bryan Schumaker597d9282012-07-16 16:39:10 -04001847int nfs_rmdir(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848{
1849 int error;
1850
Niels de Vos1e8968c2013-12-17 18:20:16 +01001851 dfprintk(VFS, "NFS: rmdir(%s/%lu), %pd\n",
Al Viro6de14722013-09-16 10:53:17 -04001852 dir->i_sb->s_id, dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Trond Myklebust1ca42382013-08-21 12:36:04 -04001854 trace_nfs_rmdir_enter(dir, dentry);
David Howells2b0143b2015-03-17 22:25:59 +00001855 if (d_really_is_positive(dentry)) {
Al Viro884be172016-04-28 23:56:31 -04001856 down_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04001857 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
1858 /* Ensure the VFS deletes this inode */
1859 switch (error) {
1860 case 0:
David Howells2b0143b2015-03-17 22:25:59 +00001861 clear_nlink(d_inode(dentry));
Trond Myklebustba6c0592013-08-30 12:24:25 -04001862 break;
1863 case -ENOENT:
1864 nfs_dentry_handle_enoent(dentry);
1865 }
Al Viro884be172016-04-28 23:56:31 -04001866 up_write(&NFS_I(d_inode(dentry))->rmdir_sem);
Trond Myklebustba6c0592013-08-30 12:24:25 -04001867 } else
1868 error = NFS_PROTO(dir)->rmdir(dir, &dentry->d_name);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001869 trace_nfs_rmdir_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870
1871 return error;
1872}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001873EXPORT_SYMBOL_GPL(nfs_rmdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875/*
1876 * Remove a file after making sure there are no pending writes,
1877 * and after checking that the file has only one user.
1878 *
1879 * We invalidate the attribute cache and free the inode prior to the operation
1880 * to avoid possible races if the server reuses the inode.
1881 */
1882static int nfs_safe_remove(struct dentry *dentry)
1883{
David Howells2b0143b2015-03-17 22:25:59 +00001884 struct inode *dir = d_inode(dentry->d_parent);
1885 struct inode *inode = d_inode(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 int error = -EBUSY;
1887
Al Viro6de14722013-09-16 10:53:17 -04001888 dfprintk(VFS, "NFS: safe_remove(%pd2)\n", dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
1890 /* If the dentry was sillyrenamed, we simply call d_delete() */
1891 if (dentry->d_flags & DCACHE_NFSFS_RENAMED) {
1892 error = 0;
1893 goto out;
1894 }
1895
Trond Myklebust1ca42382013-08-21 12:36:04 -04001896 trace_nfs_remove_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 if (inode != NULL) {
Trond Myklebust912678d2018-03-20 16:43:15 -04001898 error = NFS_PROTO(dir)->remove(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 if (error == 0)
Trond Myklebust1b83d702008-06-11 15:44:04 -04001900 nfs_drop_nlink(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 } else
Trond Myklebust912678d2018-03-20 16:43:15 -04001902 error = NFS_PROTO(dir)->remove(dir, dentry);
Trond Myklebustd45b9d82008-01-28 19:43:18 -05001903 if (error == -ENOENT)
1904 nfs_dentry_handle_enoent(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001905 trace_nfs_remove_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906out:
1907 return error;
1908}
1909
1910/* We do silly rename. In case sillyrename() returns -EBUSY, the inode
1911 * belongs to an active ".nfs..." file and we return -EBUSY.
1912 *
1913 * If sillyrename() returns 0, we do nothing, otherwise we unlink.
1914 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001915int nfs_unlink(struct inode *dir, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916{
1917 int error;
1918 int need_rehash = 0;
1919
Niels de Vos1e8968c2013-12-17 18:20:16 +01001920 dfprintk(VFS, "NFS: unlink(%s/%lu, %pd)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04001921 dir->i_ino, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
Trond Myklebust1ca42382013-08-21 12:36:04 -04001923 trace_nfs_unlink_enter(dir, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 spin_lock(&dentry->d_lock);
Al Viro84d08fa2013-07-05 18:59:33 +04001925 if (d_count(dentry) > 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 spin_unlock(&dentry->d_lock);
Trond Myklebustccfeb502007-01-13 02:28:12 -05001927 /* Start asynchronous writeout of the inode */
David Howells2b0143b2015-03-17 22:25:59 +00001928 write_inode_now(d_inode(dentry), 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 error = nfs_sillyrename(dir, dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001930 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 }
1932 if (!d_unhashed(dentry)) {
1933 __d_drop(dentry);
1934 need_rehash = 1;
1935 }
1936 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 error = nfs_safe_remove(dentry);
Trond Myklebustd45b9d82008-01-28 19:43:18 -05001938 if (!error || error == -ENOENT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 nfs_set_verifier(dentry, nfs_save_change_attribute(dir));
1940 } else if (need_rehash)
1941 d_rehash(dentry);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001942out:
1943 trace_nfs_unlink_exit(dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 return error;
1945}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04001946EXPORT_SYMBOL_GPL(nfs_unlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
Chuck Lever873101b2006-08-22 20:06:23 -04001948/*
1949 * To create a symbolic link, most file systems instantiate a new inode,
1950 * add a page to it containing the path, then write it out to the disk
1951 * using prepare_write/commit_write.
1952 *
1953 * Unfortunately the NFS client can't create the in-core inode first
1954 * because it needs a file handle to create an in-core inode (see
1955 * fs/nfs/inode.c:nfs_fhget). We only have a file handle *after* the
1956 * symlink request has completed on the server.
1957 *
1958 * So instead we allocate a raw page, copy the symname into it, then do
1959 * the SYMLINK request with the page as the buffer. If it succeeds, we
1960 * now have a new file handle and can instantiate an in-core NFS inode
1961 * and move the raw page into its mapping.
1962 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04001963int nfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964{
Chuck Lever873101b2006-08-22 20:06:23 -04001965 struct page *page;
1966 char *kaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 struct iattr attr;
Chuck Lever873101b2006-08-22 20:06:23 -04001968 unsigned int pathlen = strlen(symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 int error;
1970
Niels de Vos1e8968c2013-12-17 18:20:16 +01001971 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s)\n", dir->i_sb->s_id,
Al Viro6de14722013-09-16 10:53:17 -04001972 dir->i_ino, dentry, symname);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
Chuck Lever873101b2006-08-22 20:06:23 -04001974 if (pathlen > PAGE_SIZE)
1975 return -ENAMETOOLONG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976
Chuck Lever873101b2006-08-22 20:06:23 -04001977 attr.ia_mode = S_IFLNK | S_IRWXUGO;
1978 attr.ia_valid = ATTR_MODE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
Al Viroe8ecde22016-01-14 17:52:59 -05001980 page = alloc_page(GFP_USER);
Trond Myklebust76566992008-06-11 15:44:22 -04001981 if (!page)
Chuck Lever873101b2006-08-22 20:06:23 -04001982 return -ENOMEM;
Chuck Lever873101b2006-08-22 20:06:23 -04001983
Al Viroe8ecde22016-01-14 17:52:59 -05001984 kaddr = page_address(page);
Chuck Lever873101b2006-08-22 20:06:23 -04001985 memcpy(kaddr, symname, pathlen);
1986 if (pathlen < PAGE_SIZE)
1987 memset(kaddr + pathlen, 0, PAGE_SIZE - pathlen);
Chuck Lever873101b2006-08-22 20:06:23 -04001988
Trond Myklebust1ca42382013-08-21 12:36:04 -04001989 trace_nfs_symlink_enter(dir, dentry);
Chuck Lever94a6d752006-08-22 20:06:23 -04001990 error = NFS_PROTO(dir)->symlink(dir, dentry, page, pathlen, &attr);
Trond Myklebust1ca42382013-08-21 12:36:04 -04001991 trace_nfs_symlink_exit(dir, dentry, error);
Chuck Lever873101b2006-08-22 20:06:23 -04001992 if (error != 0) {
Niels de Vos1e8968c2013-12-17 18:20:16 +01001993 dfprintk(VFS, "NFS: symlink(%s/%lu, %pd, %s) error %d\n",
Chuck Lever873101b2006-08-22 20:06:23 -04001994 dir->i_sb->s_id, dir->i_ino,
Al Viro6de14722013-09-16 10:53:17 -04001995 dentry, symname, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 d_drop(dentry);
Chuck Lever873101b2006-08-22 20:06:23 -04001997 __free_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04001998 return error;
1999 }
2000
2001 /*
2002 * No big deal if we can't add this page to the page cache here.
2003 * READLINK will get the missing page from the server if needed.
2004 */
David Howells2b0143b2015-03-17 22:25:59 +00002005 if (!add_to_page_cache_lru(page, d_inode(dentry)->i_mapping, 0,
Chuck Lever873101b2006-08-22 20:06:23 -04002006 GFP_KERNEL)) {
Chuck Lever873101b2006-08-22 20:06:23 -04002007 SetPageUptodate(page);
2008 unlock_page(page);
Rafael Aquinia0b54add2014-02-10 14:25:48 -08002009 /*
2010 * add_to_page_cache_lru() grabs an extra page refcount.
2011 * Drop it here to avoid leaking this page later.
2012 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002013 put_page(page);
Chuck Lever873101b2006-08-22 20:06:23 -04002014 } else
2015 __free_page(page);
2016
Chuck Lever873101b2006-08-22 20:06:23 -04002017 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002019EXPORT_SYMBOL_GPL(nfs_symlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020
Bryan Schumaker597d9282012-07-16 16:39:10 -04002021int
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022nfs_link(struct dentry *old_dentry, struct inode *dir, struct dentry *dentry)
2023{
David Howells2b0143b2015-03-17 22:25:59 +00002024 struct inode *inode = d_inode(old_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 int error;
2026
Al Viro6de14722013-09-16 10:53:17 -04002027 dfprintk(VFS, "NFS: link(%pd2 -> %pd2)\n",
2028 old_dentry, dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029
Trond Myklebust1fd10852013-08-21 13:54:44 -04002030 trace_nfs_link_enter(inode, dir, dentry);
Trond Myklebust9697d232007-10-02 21:58:05 -04002031 d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 error = NFS_PROTO(dir)->link(inode, dir, &dentry->d_name);
Trond Myklebustcf809552005-10-27 22:12:42 -04002033 if (error == 0) {
Al Viro7de9c6ee2010-10-23 11:11:40 -04002034 ihold(inode);
Trond Myklebust9697d232007-10-02 21:58:05 -04002035 d_add(dentry, inode);
Trond Myklebustcf809552005-10-27 22:12:42 -04002036 }
Trond Myklebust1fd10852013-08-21 13:54:44 -04002037 trace_nfs_link_exit(inode, dir, dentry, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 return error;
2039}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002040EXPORT_SYMBOL_GPL(nfs_link);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
2042/*
2043 * RENAME
2044 * FIXME: Some nfsds, like the Linux user space nfsd, may generate a
2045 * different file handle for the same inode after a rename (e.g. when
2046 * moving to a different directory). A fail-safe method to do so would
2047 * be to look up old_dir/old_name, create a link to new_dir/new_name and
2048 * rename the old file using the sillyrename stuff. This way, the original
2049 * file in old_dir will go away when the last process iput()s the inode.
2050 *
2051 * FIXED.
2052 *
2053 * It actually works quite well. One needs to have the possibility for
2054 * at least one ".nfs..." file in each directory the file ever gets
2055 * moved or linked to which happens automagically with the new
2056 * implementation that only depends on the dcache stuff instead of
2057 * using the inode layer
2058 *
2059 * Unfortunately, things are a little more complicated than indicated
2060 * above. For a cross-directory move, we want to make sure we can get
2061 * rid of the old inode after the operation. This means there must be
2062 * no pending writes (if it's a file), and the use count must be 1.
2063 * If these conditions are met, we can drop the dentries before doing
2064 * the rename.
2065 */
Bryan Schumaker597d9282012-07-16 16:39:10 -04002066int nfs_rename(struct inode *old_dir, struct dentry *old_dentry,
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02002067 struct inode *new_dir, struct dentry *new_dentry,
2068 unsigned int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069{
David Howells2b0143b2015-03-17 22:25:59 +00002070 struct inode *old_inode = d_inode(old_dentry);
2071 struct inode *new_inode = d_inode(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002072 struct dentry *dentry = NULL, *rehash = NULL;
Jeff Layton80a491f2014-03-17 07:06:56 -04002073 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 int error = -EBUSY;
2075
Miklos Szeredi1cd66c92016-09-27 11:03:58 +02002076 if (flags)
2077 return -EINVAL;
2078
Al Viro6de14722013-09-16 10:53:17 -04002079 dfprintk(VFS, "NFS: rename(%pd2 -> %pd2, ct=%d)\n",
2080 old_dentry, new_dentry,
Al Viro84d08fa2013-07-05 18:59:33 +04002081 d_count(new_dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082
Trond Myklebust70ded202013-08-21 12:08:45 -04002083 trace_nfs_rename_enter(old_dir, old_dentry, new_dir, new_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 /*
Miklos Szeredi28f79a12009-12-03 15:58:56 -05002085 * For non-directories, check whether the target is busy and if so,
2086 * make a copy of the dentry and then do a silly-rename. If the
2087 * silly-rename succeeds, the copied dentry is hashed and becomes
2088 * the new target.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 */
Miklos Szeredi27226102009-12-03 15:58:56 -05002090 if (new_inode && !S_ISDIR(new_inode->i_mode)) {
2091 /*
2092 * To prevent any new references to the target during the
2093 * rename, we unhash the dentry in advance.
2094 */
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002095 if (!d_unhashed(new_dentry)) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002096 d_drop(new_dentry);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002097 rehash = new_dentry;
2098 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
Al Viro84d08fa2013-07-05 18:59:33 +04002100 if (d_count(new_dentry) > 2) {
Miklos Szeredi27226102009-12-03 15:58:56 -05002101 int err;
2102
2103 /* copy the target dentry's name */
2104 dentry = d_alloc(new_dentry->d_parent,
2105 &new_dentry->d_name);
2106 if (!dentry)
2107 goto out;
2108
2109 /* silly-rename the existing target ... */
2110 err = nfs_sillyrename(new_dir, new_dentry);
Miklos Szeredi24e93022009-12-03 15:58:56 -05002111 if (err)
Miklos Szeredi27226102009-12-03 15:58:56 -05002112 goto out;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002113
2114 new_dentry = dentry;
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002115 rehash = NULL;
Miklos Szeredi24e93022009-12-03 15:58:56 -05002116 new_inode = NULL;
Miklos Szeredi27226102009-12-03 15:58:56 -05002117 }
Trond Myklebustb1e4adf2009-03-19 15:35:49 -04002118 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002120 task = nfs_async_rename(old_dir, new_dir, old_dentry, new_dentry, NULL);
Jeff Layton80a491f2014-03-17 07:06:56 -04002121 if (IS_ERR(task)) {
2122 error = PTR_ERR(task);
2123 goto out;
2124 }
2125
2126 error = rpc_wait_for_completion_task(task);
Benjamin Coddington818a8db2017-06-16 11:13:00 -04002127 if (error != 0) {
2128 ((struct nfs_renamedata *)task->tk_calldata)->cancelled = 1;
2129 /* Paired with the atomic_dec_and_test() barrier in rpc_do_put_task() */
2130 smp_wmb();
2131 } else
Jeff Layton80a491f2014-03-17 07:06:56 -04002132 error = task->tk_status;
2133 rpc_put_task(task);
Trond Myklebust59a707b2018-04-08 18:11:18 -04002134 /* Ensure the inode attributes are revalidated */
2135 if (error == 0) {
2136 spin_lock(&old_inode->i_lock);
2137 NFS_I(old_inode)->attr_gencount = nfs_inc_attr_generation_counter();
2138 NFS_I(old_inode)->cache_validity |= NFS_INO_INVALID_CHANGE
2139 | NFS_INO_INVALID_CTIME
2140 | NFS_INO_REVAL_FORCED;
2141 spin_unlock(&old_inode->i_lock);
2142 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143out:
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002144 if (rehash)
2145 d_rehash(rehash);
Trond Myklebust70ded202013-08-21 12:08:45 -04002146 trace_nfs_rename_exit(old_dir, old_dentry,
2147 new_dir, new_dentry, error);
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002148 if (!error) {
2149 if (new_inode != NULL)
2150 nfs_drop_nlink(new_inode);
2151 /*
2152 * The d_move() should be here instead of in an async RPC completion
2153 * handler because we need the proper locks to move the dentry. If
2154 * we're interrupted by a signal, the async RPC completion handler
2155 * should mark the directories for revalidation.
2156 */
2157 d_move(old_dentry, new_dentry);
Trond Myklebustd8032242017-11-06 15:28:04 -05002158 nfs_set_verifier(old_dentry,
Benjamin Coddingtond9f29502017-06-16 11:12:59 -04002159 nfs_save_change_attribute(new_dir));
2160 } else if (error == -ENOENT)
2161 nfs_dentry_handle_enoent(old_dentry);
2162
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 /* new dentry created? */
2164 if (dentry)
2165 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 return error;
2167}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002168EXPORT_SYMBOL_GPL(nfs_rename);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002170static DEFINE_SPINLOCK(nfs_access_lru_lock);
2171static LIST_HEAD(nfs_access_lru_list);
2172static atomic_long_t nfs_access_nr_entries;
2173
Trond Myklebust3a505842014-07-21 13:53:48 -04002174static unsigned long nfs_access_max_cachesize = ULONG_MAX;
2175module_param(nfs_access_max_cachesize, ulong, 0644);
2176MODULE_PARM_DESC(nfs_access_max_cachesize, "NFS access maximum total cache length");
2177
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002178static void nfs_access_free_entry(struct nfs_access_entry *entry)
2179{
NeilBrownb68572e2018-12-03 11:30:30 +11002180 put_cred(entry->cred);
NeilBrownf682a392014-07-14 11:28:20 +10002181 kfree_rcu(entry, rcu_head);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002182 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002183 atomic_long_dec(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002184 smp_mb__after_atomic();
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002185}
2186
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002187static void nfs_access_free_list(struct list_head *head)
2188{
2189 struct nfs_access_entry *cache;
2190
2191 while (!list_empty(head)) {
2192 cache = list_entry(head->next, struct nfs_access_entry, lru);
2193 list_del(&cache->lru);
2194 nfs_access_free_entry(cache);
2195 }
2196}
2197
Trond Myklebust3a505842014-07-21 13:53:48 -04002198static unsigned long
2199nfs_do_access_cache_scan(unsigned int nr_to_scan)
Trond Myklebust979df722006-07-25 11:28:19 -04002200{
2201 LIST_HEAD(head);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002202 struct nfs_inode *nfsi, *next;
Trond Myklebust979df722006-07-25 11:28:19 -04002203 struct nfs_access_entry *cache;
Dave Chinner1ab6c492013-08-28 10:18:09 +10002204 long freed = 0;
Trond Myklebust979df722006-07-25 11:28:19 -04002205
Trond Myklebusta50f7952007-06-05 19:23:43 -04002206 spin_lock(&nfs_access_lru_lock);
Trond Myklebustaa510da2010-09-29 15:11:56 -04002207 list_for_each_entry_safe(nfsi, next, &nfs_access_lru_list, access_cache_inode_lru) {
Trond Myklebust979df722006-07-25 11:28:19 -04002208 struct inode *inode;
2209
2210 if (nr_to_scan-- == 0)
2211 break;
Trond Myklebust9c7e7e22010-05-13 12:51:06 -04002212 inode = &nfsi->vfs_inode;
Trond Myklebust979df722006-07-25 11:28:19 -04002213 spin_lock(&inode->i_lock);
2214 if (list_empty(&nfsi->access_cache_entry_lru))
2215 goto remove_lru_entry;
2216 cache = list_entry(nfsi->access_cache_entry_lru.next,
2217 struct nfs_access_entry, lru);
2218 list_move(&cache->lru, &head);
2219 rb_erase(&cache->rb_node, &nfsi->access_cache);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002220 freed++;
Trond Myklebust979df722006-07-25 11:28:19 -04002221 if (!list_empty(&nfsi->access_cache_entry_lru))
2222 list_move_tail(&nfsi->access_cache_inode_lru,
2223 &nfs_access_lru_list);
2224 else {
2225remove_lru_entry:
2226 list_del_init(&nfsi->access_cache_inode_lru);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002227 smp_mb__before_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002228 clear_bit(NFS_INO_ACL_LRU_SET, &nfsi->flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002229 smp_mb__after_atomic();
Trond Myklebust979df722006-07-25 11:28:19 -04002230 }
Trond Myklebust59844a92010-05-26 08:42:24 -04002231 spin_unlock(&inode->i_lock);
Trond Myklebust979df722006-07-25 11:28:19 -04002232 }
2233 spin_unlock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002234 nfs_access_free_list(&head);
Dave Chinner1ab6c492013-08-28 10:18:09 +10002235 return freed;
2236}
2237
2238unsigned long
Trond Myklebust3a505842014-07-21 13:53:48 -04002239nfs_access_cache_scan(struct shrinker *shrink, struct shrink_control *sc)
2240{
2241 int nr_to_scan = sc->nr_to_scan;
2242 gfp_t gfp_mask = sc->gfp_mask;
2243
2244 if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
2245 return SHRINK_STOP;
2246 return nfs_do_access_cache_scan(nr_to_scan);
2247}
2248
2249
2250unsigned long
Dave Chinner1ab6c492013-08-28 10:18:09 +10002251nfs_access_cache_count(struct shrinker *shrink, struct shrink_control *sc)
2252{
Glauber Costa55f841c2013-08-28 10:17:53 +10002253 return vfs_pressure_ratio(atomic_long_read(&nfs_access_nr_entries));
Trond Myklebust979df722006-07-25 11:28:19 -04002254}
2255
Trond Myklebust3a505842014-07-21 13:53:48 -04002256static void
2257nfs_access_cache_enforce_limit(void)
2258{
2259 long nr_entries = atomic_long_read(&nfs_access_nr_entries);
2260 unsigned long diff;
2261 unsigned int nr_to_scan;
2262
2263 if (nr_entries < 0 || nr_entries <= nfs_access_max_cachesize)
2264 return;
2265 nr_to_scan = 100;
2266 diff = nr_entries - nfs_access_max_cachesize;
2267 if (diff < nr_to_scan)
2268 nr_to_scan = diff;
2269 nfs_do_access_cache_scan(nr_to_scan);
2270}
2271
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002272static void __nfs_access_zap_cache(struct nfs_inode *nfsi, struct list_head *head)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002273{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002274 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002275 struct rb_node *n;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002276 struct nfs_access_entry *entry;
2277
2278 /* Unhook entries from the cache */
2279 while ((n = rb_first(root_node)) != NULL) {
2280 entry = rb_entry(n, struct nfs_access_entry, rb_node);
2281 rb_erase(n, root_node);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002282 list_move(&entry->lru, head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002283 }
2284 nfsi->cache_validity &= ~NFS_INO_INVALID_ACCESS;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002285}
2286
2287void nfs_access_zap_cache(struct inode *inode)
2288{
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002289 LIST_HEAD(head);
2290
2291 if (test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags) == 0)
2292 return;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002293 /* Remove from global LRU init */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002294 spin_lock(&nfs_access_lru_lock);
2295 if (test_and_clear_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002296 list_del_init(&NFS_I(inode)->access_cache_inode_lru);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002297
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002298 spin_lock(&inode->i_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002299 __nfs_access_zap_cache(NFS_I(inode), &head);
2300 spin_unlock(&inode->i_lock);
2301 spin_unlock(&nfs_access_lru_lock);
2302 nfs_access_free_list(&head);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002303}
Bryan Schumaker1c606fb2012-07-30 16:05:24 -04002304EXPORT_SYMBOL_GPL(nfs_access_zap_cache);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002305
NeilBrownb68572e2018-12-03 11:30:30 +11002306static struct nfs_access_entry *nfs_access_search_rbtree(struct inode *inode, const struct cred *cred)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002307{
2308 struct rb_node *n = NFS_I(inode)->access_cache.rb_node;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002309
2310 while (n != NULL) {
NeilBrownb68572e2018-12-03 11:30:30 +11002311 struct nfs_access_entry *entry =
2312 rb_entry(n, struct nfs_access_entry, rb_node);
2313 int cmp = cred_fscmp(cred, entry->cred);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002314
NeilBrownb68572e2018-12-03 11:30:30 +11002315 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002316 n = n->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002317 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002318 n = n->rb_right;
2319 else
2320 return entry;
2321 }
2322 return NULL;
2323}
2324
NeilBrownb68572e2018-12-03 11:30:30 +11002325static int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res, bool may_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326{
Chuck Lever55296802005-08-18 11:24:09 -07002327 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002328 struct nfs_access_entry *cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002329 bool retry = true;
2330 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002332 spin_lock(&inode->i_lock);
Trond Myklebust57b69182016-06-03 17:07:19 -04002333 for(;;) {
2334 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2335 goto out_zap;
2336 cache = nfs_access_search_rbtree(inode, cred);
2337 err = -ENOENT;
2338 if (cache == NULL)
2339 goto out;
2340 /* Found an entry, is our attribute cache valid? */
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002341 if (!nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
Trond Myklebust57b69182016-06-03 17:07:19 -04002342 break;
Trond Myklebust5c965db2020-01-06 15:39:36 -05002343 if (!retry)
2344 break;
Trond Myklebust57b69182016-06-03 17:07:19 -04002345 err = -ECHILD;
2346 if (!may_block)
2347 goto out;
Trond Myklebust57b69182016-06-03 17:07:19 -04002348 spin_unlock(&inode->i_lock);
2349 err = __nfs_revalidate_inode(NFS_SERVER(inode), inode);
2350 if (err)
2351 return err;
2352 spin_lock(&inode->i_lock);
2353 retry = false;
2354 }
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002355 res->cred = cache->cred;
2356 res->mask = cache->mask;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002357 list_move_tail(&cache->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002358 err = 0;
2359out:
2360 spin_unlock(&inode->i_lock);
2361 return err;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002362out_zap:
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002363 spin_unlock(&inode->i_lock);
2364 nfs_access_zap_cache(inode);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002365 return -ENOENT;
2366}
2367
NeilBrownb68572e2018-12-03 11:30:30 +11002368static int nfs_access_get_cached_rcu(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res)
NeilBrownf682a392014-07-14 11:28:20 +10002369{
2370 /* Only check the most recently returned cache entry,
2371 * but do it without locking.
2372 */
2373 struct nfs_inode *nfsi = NFS_I(inode);
2374 struct nfs_access_entry *cache;
2375 int err = -ECHILD;
2376 struct list_head *lh;
2377
2378 rcu_read_lock();
2379 if (nfsi->cache_validity & NFS_INO_INVALID_ACCESS)
2380 goto out;
2381 lh = rcu_dereference(nfsi->access_cache_entry_lru.prev);
2382 cache = list_entry(lh, struct nfs_access_entry, lru);
2383 if (lh == &nfsi->access_cache_entry_lru ||
Trond Myklebust9a206de2020-01-26 17:31:14 -05002384 cred_fscmp(cred, cache->cred) != 0)
NeilBrownf682a392014-07-14 11:28:20 +10002385 cache = NULL;
2386 if (cache == NULL)
2387 goto out;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002388 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_ACCESS))
NeilBrownf682a392014-07-14 11:28:20 +10002389 goto out;
NeilBrownf682a392014-07-14 11:28:20 +10002390 res->cred = cache->cred;
2391 res->mask = cache->mask;
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002392 err = 0;
NeilBrownf682a392014-07-14 11:28:20 +10002393out:
2394 rcu_read_unlock();
2395 return err;
2396}
2397
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002398static void nfs_access_add_rbtree(struct inode *inode, struct nfs_access_entry *set)
2399{
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002400 struct nfs_inode *nfsi = NFS_I(inode);
2401 struct rb_root *root_node = &nfsi->access_cache;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002402 struct rb_node **p = &root_node->rb_node;
2403 struct rb_node *parent = NULL;
2404 struct nfs_access_entry *entry;
NeilBrownb68572e2018-12-03 11:30:30 +11002405 int cmp;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002406
2407 spin_lock(&inode->i_lock);
2408 while (*p != NULL) {
2409 parent = *p;
2410 entry = rb_entry(parent, struct nfs_access_entry, rb_node);
NeilBrownb68572e2018-12-03 11:30:30 +11002411 cmp = cred_fscmp(set->cred, entry->cred);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002412
NeilBrownb68572e2018-12-03 11:30:30 +11002413 if (cmp < 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002414 p = &parent->rb_left;
NeilBrownb68572e2018-12-03 11:30:30 +11002415 else if (cmp > 0)
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002416 p = &parent->rb_right;
2417 else
2418 goto found;
2419 }
2420 rb_link_node(&set->rb_node, parent, p);
2421 rb_insert_color(&set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002422 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002423 spin_unlock(&inode->i_lock);
2424 return;
2425found:
2426 rb_replace_node(parent, &set->rb_node, root_node);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002427 list_add_tail(&set->lru, &nfsi->access_cache_entry_lru);
2428 list_del(&entry->lru);
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002429 spin_unlock(&inode->i_lock);
2430 nfs_access_free_entry(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431}
2432
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002433void nfs_access_add_cache(struct inode *inode, struct nfs_access_entry *set)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434{
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002435 struct nfs_access_entry *cache = kmalloc(sizeof(*cache), GFP_KERNEL);
2436 if (cache == NULL)
2437 return;
2438 RB_CLEAR_NODE(&cache->rb_node);
NeilBrownb68572e2018-12-03 11:30:30 +11002439 cache->cred = get_cred(set->cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 cache->mask = set->mask;
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002441
NeilBrownf682a392014-07-14 11:28:20 +10002442 /* The above field assignments must be visible
2443 * before this item appears on the lru. We cannot easily
2444 * use rcu_assign_pointer, so just force the memory barrier.
2445 */
2446 smp_wmb();
Trond Myklebust1c3c07e2006-07-25 11:28:18 -04002447 nfs_access_add_rbtree(inode, cache);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002448
2449 /* Update accounting */
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002450 smp_mb__before_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002451 atomic_long_inc(&nfs_access_nr_entries);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002452 smp_mb__after_atomic();
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002453
2454 /* Add inode to global LRU list */
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002455 if (!test_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags)) {
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002456 spin_lock(&nfs_access_lru_lock);
Trond Myklebust1a81bb82010-05-13 12:51:06 -04002457 if (!test_and_set_bit(NFS_INO_ACL_LRU_SET, &NFS_I(inode)->flags))
2458 list_add_tail(&NFS_I(inode)->access_cache_inode_lru,
2459 &nfs_access_lru_list);
Trond Myklebustcfcea3e2006-07-25 11:28:18 -04002460 spin_unlock(&nfs_access_lru_lock);
2461 }
Trond Myklebust3a505842014-07-21 13:53:48 -04002462 nfs_access_cache_enforce_limit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463}
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002464EXPORT_SYMBOL_GPL(nfs_access_add_cache);
2465
Anna Schumaker3c181822017-07-26 10:14:55 -04002466#define NFS_MAY_READ (NFS_ACCESS_READ)
2467#define NFS_MAY_WRITE (NFS_ACCESS_MODIFY | \
2468 NFS_ACCESS_EXTEND | \
2469 NFS_ACCESS_DELETE)
2470#define NFS_FILE_MAY_WRITE (NFS_ACCESS_MODIFY | \
2471 NFS_ACCESS_EXTEND)
Trond Myklebustecbb9032017-07-11 17:54:35 -04002472#define NFS_DIR_MAY_WRITE NFS_MAY_WRITE
Anna Schumaker3c181822017-07-26 10:14:55 -04002473#define NFS_MAY_LOOKUP (NFS_ACCESS_LOOKUP)
2474#define NFS_MAY_EXECUTE (NFS_ACCESS_EXECUTE)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002475static int
Trond Myklebustecbb9032017-07-11 17:54:35 -04002476nfs_access_calc_mask(u32 access_result, umode_t umode)
Trond Myklebust15d4b732017-07-11 17:54:32 -04002477{
2478 int mask = 0;
2479
2480 if (access_result & NFS_MAY_READ)
2481 mask |= MAY_READ;
Trond Myklebustecbb9032017-07-11 17:54:35 -04002482 if (S_ISDIR(umode)) {
2483 if ((access_result & NFS_DIR_MAY_WRITE) == NFS_DIR_MAY_WRITE)
2484 mask |= MAY_WRITE;
2485 if ((access_result & NFS_MAY_LOOKUP) == NFS_MAY_LOOKUP)
2486 mask |= MAY_EXEC;
2487 } else if (S_ISREG(umode)) {
2488 if ((access_result & NFS_FILE_MAY_WRITE) == NFS_FILE_MAY_WRITE)
2489 mask |= MAY_WRITE;
2490 if ((access_result & NFS_MAY_EXECUTE) == NFS_MAY_EXECUTE)
2491 mask |= MAY_EXEC;
2492 } else if (access_result & NFS_MAY_WRITE)
2493 mask |= MAY_WRITE;
Trond Myklebust15d4b732017-07-11 17:54:32 -04002494 return mask;
2495}
2496
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002497void nfs_access_set_mask(struct nfs_access_entry *entry, u32 access_result)
2498{
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002499 entry->mask = access_result;
Weston Andros Adamson6168f622012-09-10 14:00:46 -04002500}
2501EXPORT_SYMBOL_GPL(nfs_access_set_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502
NeilBrownb68572e2018-12-03 11:30:30 +11002503static int nfs_do_access(struct inode *inode, const struct cred *cred, int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504{
2505 struct nfs_access_entry cache;
Trond Myklebust57b69182016-06-03 17:07:19 -04002506 bool may_block = (mask & MAY_NOT_BLOCK) == 0;
Trond Myklebuste8194b72020-01-06 15:25:12 -05002507 int cache_mask = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508 int status;
2509
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002510 trace_nfs_access_enter(inode);
2511
NeilBrownf682a392014-07-14 11:28:20 +10002512 status = nfs_access_get_cached_rcu(inode, cred, &cache);
2513 if (status != 0)
Trond Myklebust57b69182016-06-03 17:07:19 -04002514 status = nfs_access_get_cached(inode, cred, &cache, may_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 if (status == 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002516 goto out_cached;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517
NeilBrownf3324a22014-07-14 11:28:20 +10002518 status = -ECHILD;
Trond Myklebust57b69182016-06-03 17:07:19 -04002519 if (!may_block)
NeilBrownf3324a22014-07-14 11:28:20 +10002520 goto out;
2521
Anna Schumaker1750d922017-07-26 12:00:21 -04002522 /*
2523 * Determine which access bits we want to ask for...
2524 */
2525 cache.mask = NFS_ACCESS_READ | NFS_ACCESS_MODIFY | NFS_ACCESS_EXTEND;
2526 if (S_ISDIR(inode->i_mode))
2527 cache.mask |= NFS_ACCESS_DELETE | NFS_ACCESS_LOOKUP;
2528 else
2529 cache.mask |= NFS_ACCESS_EXECUTE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 cache.cred = cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 status = NFS_PROTO(inode)->access(inode, &cache);
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002532 if (status != 0) {
2533 if (status == -ESTALE) {
2534 nfs_zap_caches(inode);
2535 if (!S_ISDIR(inode->i_mode))
2536 set_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
2537 }
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002538 goto out;
Suresh Jayaramana71ee332009-03-10 20:33:21 -04002539 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 nfs_access_add_cache(inode, &cache);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002541out_cached:
Trond Myklebustecbb9032017-07-11 17:54:35 -04002542 cache_mask = nfs_access_calc_mask(cache.mask, inode->i_mode);
Trond Myklebustbd8b2442017-07-11 17:54:34 -04002543 if ((mask & ~cache_mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) != 0)
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002544 status = -EACCES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545out:
Trond Myklebuste8194b72020-01-06 15:25:12 -05002546 trace_nfs_access_exit(inode, mask, cache_mask, status);
Trond Myklebustf4ce1292013-08-19 18:59:33 -04002547 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548}
2549
Trond Myklebustaf22f942007-08-10 17:45:10 -04002550static int nfs_open_permission_mask(int openflags)
2551{
2552 int mask = 0;
2553
Weston Andros Adamsonf8d9a892013-01-03 16:42:29 -05002554 if (openflags & __FMODE_EXEC) {
2555 /* ONLY check exec rights */
2556 mask = MAY_EXEC;
2557 } else {
2558 if ((openflags & O_ACCMODE) != O_WRONLY)
2559 mask |= MAY_READ;
2560 if ((openflags & O_ACCMODE) != O_RDONLY)
2561 mask |= MAY_WRITE;
2562 }
2563
Trond Myklebustaf22f942007-08-10 17:45:10 -04002564 return mask;
2565}
2566
NeilBrownb68572e2018-12-03 11:30:30 +11002567int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags)
Trond Myklebustaf22f942007-08-10 17:45:10 -04002568{
2569 return nfs_do_access(inode, cred, nfs_open_permission_mask(openflags));
2570}
Bryan Schumaker89d77c82012-07-30 16:05:25 -04002571EXPORT_SYMBOL_GPL(nfs_may_open);
Trond Myklebustaf22f942007-08-10 17:45:10 -04002572
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002573static int nfs_execute_ok(struct inode *inode, int mask)
2574{
2575 struct nfs_server *server = NFS_SERVER(inode);
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002576 int ret = 0;
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002577
Trond Myklebust38258272018-07-24 14:27:11 -04002578 if (S_ISDIR(inode->i_mode))
2579 return 0;
Trond Myklebustcf834022018-07-20 16:19:35 -04002580 if (nfs_check_cache_invalid(inode, NFS_INO_INVALID_OTHER)) {
Trond Myklebust21c3ba72016-12-16 18:40:03 -05002581 if (mask & MAY_NOT_BLOCK)
2582 return -ECHILD;
2583 ret = __nfs_revalidate_inode(server, inode);
2584 }
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002585 if (ret == 0 && !execute_ok(inode))
2586 ret = -EACCES;
2587 return ret;
2588}
2589
Al Viro10556cb22011-06-20 19:28:19 -04002590int nfs_permission(struct inode *inode, int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591{
NeilBrownb68572e2018-12-03 11:30:30 +11002592 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593 int res = 0;
2594
Chuck Lever91d5b472006-03-20 13:44:14 -05002595 nfs_inc_stats(inode, NFSIOS_VFSACCESS);
2596
Al Viroe6305c42008-07-15 21:03:57 -04002597 if ((mask & (MAY_READ | MAY_WRITE | MAY_EXEC)) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 goto out;
2599 /* Is this sys_access() ? */
Eric Paris9cfcac82010-07-23 11:43:51 -04002600 if (mask & (MAY_ACCESS | MAY_CHDIR))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 goto force_lookup;
2602
2603 switch (inode->i_mode & S_IFMT) {
2604 case S_IFLNK:
2605 goto out;
2606 case S_IFREG:
Trond Myklebust762674f2015-12-26 21:54:58 -05002607 if ((mask & MAY_OPEN) &&
2608 nfs_server_capable(inode, NFS_CAP_ATOMIC_OPEN))
2609 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 break;
2611 case S_IFDIR:
2612 /*
2613 * Optimize away all write operations, since the server
2614 * will check permissions when we perform the op.
2615 */
2616 if ((mask & MAY_WRITE) && !(mask & MAY_READ))
2617 goto out;
2618 }
2619
2620force_lookup:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621 if (!NFS_PROTO(inode)->access)
2622 goto out_notsup;
2623
NeilBrownf3324a22014-07-14 11:28:20 +10002624 /* Always try fast lookups first */
2625 rcu_read_lock();
NeilBrownb68572e2018-12-03 11:30:30 +11002626 res = nfs_do_access(inode, cred, mask|MAY_NOT_BLOCK);
NeilBrownf3324a22014-07-14 11:28:20 +10002627 rcu_read_unlock();
2628 if (res == -ECHILD && !(mask & MAY_NOT_BLOCK)) {
2629 /* Fast lookup failed, try the slow way */
NeilBrownb68572e2018-12-03 11:30:30 +11002630 res = nfs_do_access(inode, cred, mask);
NeilBrownf3324a22014-07-14 11:28:20 +10002631 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632out:
Trond Myklebust5c5fc092015-12-28 19:30:05 -05002633 if (!res && (mask & MAY_EXEC))
2634 res = nfs_execute_ok(inode, mask);
Miklos Szeredif696a362008-07-31 13:41:58 +02002635
Niels de Vos1e8968c2013-12-17 18:20:16 +01002636 dfprintk(VFS, "NFS: permission(%s/%lu), mask=0x%x, res=%d\n",
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05002637 inode->i_sb->s_id, inode->i_ino, mask, res);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 return res;
2639out_notsup:
NeilBrownd51ac1a2014-07-14 11:28:20 +10002640 if (mask & MAY_NOT_BLOCK)
2641 return -ECHILD;
2642
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 res = nfs_revalidate_inode(NFS_SERVER(inode), inode);
2644 if (res == 0)
Al Viro2830ba72011-06-20 19:16:29 -04002645 res = generic_permission(inode, mask);
Chuck Lever1e7cb3d2006-03-20 13:44:24 -05002646 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647}
Bryan Schumakerddda8e02012-07-30 16:05:23 -04002648EXPORT_SYMBOL_GPL(nfs_permission);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649
2650/*
2651 * Local variables:
2652 * version-control: t
2653 * kept-new-versions: 5
2654 * End:
2655 */