blob: 213f1bbeb82805caa42fc55d3204e5324452ae14 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/nfs/delegation.c
3 *
4 * Copyright (C) 2004 Trond Myklebust
5 *
6 * NFS file delegation management
7 *
8 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/completion.h>
Trond Myklebust58d97142006-01-03 09:55:24 +010010#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/module.h>
12#include <linux/sched.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090013#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/spinlock.h>
15
16#include <linux/nfs4.h>
17#include <linux/nfs_fs.h>
18#include <linux/nfs_xdr.h>
19
Trond Myklebust4ce79712005-06-22 17:16:21 +000020#include "nfs4_fs.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include "delegation.h"
David Howells24c8dbb2006-08-22 20:06:10 -040022#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Trond Myklebust905f8d12007-08-06 12:18:34 -040024static void nfs_free_delegation(struct nfs_delegation *delegation)
25{
Trond Myklebuste00b8a22011-01-27 14:55:39 -050026 if (delegation->cred) {
27 put_rpccred(delegation->cred);
28 delegation->cred = NULL;
29 }
Lai Jiangshan26f04dd2011-05-01 06:21:54 -070030 kfree_rcu(delegation, rcu);
Trond Myklebust8383e462007-07-06 15:12:04 -040031}
32
Chuck Leverd3978bb2010-12-24 01:33:04 +000033/**
34 * nfs_mark_delegation_referenced - set delegation's REFERENCED flag
35 * @delegation: delegation to process
36 *
37 */
Trond Myklebustb7391f42008-12-23 15:21:52 -050038void nfs_mark_delegation_referenced(struct nfs_delegation *delegation)
39{
40 set_bit(NFS_DELEGATION_REFERENCED, &delegation->flags);
41}
42
Chuck Leverd3978bb2010-12-24 01:33:04 +000043/**
44 * nfs_have_delegation - check if inode has a delegation
45 * @inode: inode to check
46 * @flags: delegation types to check for
47 *
48 * Returns one if inode has the indicated delegation, otherwise zero.
49 */
Bryan Schumaker011e2a72012-06-20 15:53:43 -040050int nfs4_have_delegation(struct inode *inode, fmode_t flags)
Trond Myklebustb7391f42008-12-23 15:21:52 -050051{
52 struct nfs_delegation *delegation;
53 int ret = 0;
54
55 flags &= FMODE_READ|FMODE_WRITE;
56 rcu_read_lock();
57 delegation = rcu_dereference(NFS_I(inode)->delegation);
Trond Myklebustd25be542013-02-05 11:43:28 -050058 if (delegation != NULL && (delegation->type & flags) == flags &&
59 !test_bit(NFS_DELEGATION_RETURNING, &delegation->flags)) {
Trond Myklebustb7391f42008-12-23 15:21:52 -050060 nfs_mark_delegation_referenced(delegation);
61 ret = 1;
62 }
63 rcu_read_unlock();
64 return ret;
65}
66
Trond Myklebustdb4f2e62013-04-01 15:56:46 -040067static int nfs_delegation_claim_locks(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid)
Trond Myklebust888e6942005-11-04 15:38:11 -050068{
69 struct inode *inode = state->inode;
70 struct file_lock *fl;
Trond Myklebustd5122202009-06-17 13:22:58 -070071 int status = 0;
Trond Myklebust888e6942005-11-04 15:38:11 -050072
Trond Myklebust3f09df72009-06-17 13:23:00 -070073 if (inode->i_flock == NULL)
Trond Myklebust65b62a22013-02-07 10:54:07 -050074 return 0;
Trond Myklebust3f09df72009-06-17 13:23:00 -070075
Trond Myklebust65b62a22013-02-07 10:54:07 -050076 if (inode->i_flock == NULL)
77 goto out;
Arnd Bergmannb89f4322010-09-18 15:09:31 +020078 /* Protect inode->i_flock using the file locks lock */
79 lock_flocks();
Harvey Harrison90dc7d22008-02-20 13:03:05 -080080 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
Trond Myklebust888e6942005-11-04 15:38:11 -050081 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
82 continue;
Trond Myklebustcd3758e2007-08-10 17:44:32 -040083 if (nfs_file_open_context(fl->fl_file) != ctx)
Trond Myklebust888e6942005-11-04 15:38:11 -050084 continue;
Arnd Bergmannb89f4322010-09-18 15:09:31 +020085 unlock_flocks();
Trond Myklebustdb4f2e62013-04-01 15:56:46 -040086 status = nfs4_lock_delegation_recall(fl, state, stateid);
Trond Myklebustd5122202009-06-17 13:22:58 -070087 if (status < 0)
Trond Myklebust3f09df72009-06-17 13:23:00 -070088 goto out;
Arnd Bergmannb89f4322010-09-18 15:09:31 +020089 lock_flocks();
Trond Myklebust888e6942005-11-04 15:38:11 -050090 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +020091 unlock_flocks();
Trond Myklebust3f09df72009-06-17 13:23:00 -070092out:
Trond Myklebust888e6942005-11-04 15:38:11 -050093 return status;
94}
95
Trond Myklebustd18cc1f2009-12-03 08:10:17 -050096static int nfs_delegation_claim_opens(struct inode *inode, const nfs4_stateid *stateid)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097{
98 struct nfs_inode *nfsi = NFS_I(inode);
99 struct nfs_open_context *ctx;
Trond Myklebustd25be542013-02-05 11:43:28 -0500100 struct nfs4_state_owner *sp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 struct nfs4_state *state;
Trond Myklebustd25be542013-02-05 11:43:28 -0500102 unsigned int seq;
Trond Myklebust888e6942005-11-04 15:38:11 -0500103 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105again:
106 spin_lock(&inode->i_lock);
107 list_for_each_entry(ctx, &nfsi->open_files, list) {
108 state = ctx->state;
109 if (state == NULL)
110 continue;
111 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
112 continue;
Trond Myklebustf597c532012-03-04 18:13:56 -0500113 if (!nfs4_stateid_match(&state->stateid, stateid))
Trond Myklebust90163022007-07-05 14:55:18 -0400114 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 get_nfs_open_context(ctx);
116 spin_unlock(&inode->i_lock);
Trond Myklebustd25be542013-02-05 11:43:28 -0500117 sp = state->owner;
Trond Myklebust65b62a22013-02-07 10:54:07 -0500118 /* Block nfs4_proc_unlck */
119 mutex_lock(&sp->so_delegreturn_mutex);
Trond Myklebustd25be542013-02-05 11:43:28 -0500120 seq = raw_seqcount_begin(&sp->so_reclaim_seqcount);
Trond Myklebust13437e12007-07-06 15:10:43 -0400121 err = nfs4_open_delegation_recall(ctx, state, stateid);
Trond Myklebustd25be542013-02-05 11:43:28 -0500122 if (!err)
Trond Myklebustdb4f2e62013-04-01 15:56:46 -0400123 err = nfs_delegation_claim_locks(ctx, state, stateid);
Trond Myklebustd25be542013-02-05 11:43:28 -0500124 if (!err && read_seqcount_retry(&sp->so_reclaim_seqcount, seq))
125 err = -EAGAIN;
Trond Myklebust65b62a22013-02-07 10:54:07 -0500126 mutex_unlock(&sp->so_delegreturn_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 put_nfs_open_context(ctx);
Trond Myklebust888e6942005-11-04 15:38:11 -0500128 if (err != 0)
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500129 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 goto again;
131 }
132 spin_unlock(&inode->i_lock);
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500133 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134}
135
Chuck Leverd3978bb2010-12-24 01:33:04 +0000136/**
137 * nfs_inode_reclaim_delegation - process a delegation reclaim request
138 * @inode: inode to process
139 * @cred: credential to use for request
140 * @res: new delegation state from server
141 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 */
Chuck Leverd3978bb2010-12-24 01:33:04 +0000143void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred,
144 struct nfs_openres *res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145{
Trond Myklebust8f649c32010-05-01 12:36:18 -0400146 struct nfs_delegation *delegation;
147 struct rpc_cred *oldcred = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Trond Myklebust8f649c32010-05-01 12:36:18 -0400149 rcu_read_lock();
150 delegation = rcu_dereference(NFS_I(inode)->delegation);
151 if (delegation != NULL) {
152 spin_lock(&delegation->lock);
153 if (delegation->inode != NULL) {
Trond Myklebustf597c532012-03-04 18:13:56 -0500154 nfs4_stateid_copy(&delegation->stateid, &res->delegation);
Trond Myklebust8f649c32010-05-01 12:36:18 -0400155 delegation->type = res->delegation_type;
156 delegation->maxsize = res->maxsize;
157 oldcred = delegation->cred;
158 delegation->cred = get_rpccred(cred);
159 clear_bit(NFS_DELEGATION_NEED_RECLAIM,
160 &delegation->flags);
161 NFS_I(inode)->delegation_state = delegation->type;
162 spin_unlock(&delegation->lock);
163 put_rpccred(oldcred);
164 rcu_read_unlock();
165 } else {
166 /* We appear to have raced with a delegation return. */
167 spin_unlock(&delegation->lock);
168 rcu_read_unlock();
169 nfs_inode_set_delegation(inode, cred, res);
170 }
171 } else {
172 rcu_read_unlock();
173 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174}
175
Trond Myklebust57bfa892008-01-25 16:38:18 -0500176static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation, int issync)
177{
178 int res = 0;
179
180 res = nfs4_proc_delegreturn(inode, delegation->cred, &delegation->stateid, issync);
181 nfs_free_delegation(delegation);
182 return res;
183}
184
Trond Myklebust86e89482008-12-23 15:21:39 -0500185static struct inode *nfs_delegation_grab_inode(struct nfs_delegation *delegation)
186{
187 struct inode *inode = NULL;
188
189 spin_lock(&delegation->lock);
190 if (delegation->inode != NULL)
191 inode = igrab(delegation->inode);
192 spin_unlock(&delegation->lock);
193 return inode;
194}
195
Chuck Leverdda4b222010-12-24 01:32:54 +0000196static struct nfs_delegation *
Trond Myklebustd25be542013-02-05 11:43:28 -0500197nfs_start_delegation_return_locked(struct nfs_inode *nfsi)
Trond Myklebust57bfa892008-01-25 16:38:18 -0500198{
Trond Myklebustd25be542013-02-05 11:43:28 -0500199 struct nfs_delegation *ret = NULL;
200 struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500201
202 if (delegation == NULL)
Trond Myklebustd25be542013-02-05 11:43:28 -0500203 goto out;
204 spin_lock(&delegation->lock);
205 if (!test_and_set_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
206 ret = delegation;
207 spin_unlock(&delegation->lock);
208out:
209 return ret;
210}
211
212static struct nfs_delegation *
213nfs_start_delegation_return(struct nfs_inode *nfsi)
214{
215 struct nfs_delegation *delegation;
216
217 rcu_read_lock();
218 delegation = nfs_start_delegation_return_locked(nfsi);
219 rcu_read_unlock();
220 return delegation;
221}
222
223static void
224nfs_abort_delegation_return(struct nfs_delegation *delegation,
225 struct nfs_client *clp)
226{
Chuck Leverdda4b222010-12-24 01:32:54 +0000227
Trond Myklebust34310432008-12-23 15:21:38 -0500228 spin_lock(&delegation->lock);
Trond Myklebustd25be542013-02-05 11:43:28 -0500229 clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
230 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
231 spin_unlock(&delegation->lock);
232 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
233}
234
235static struct nfs_delegation *
236nfs_detach_delegation_locked(struct nfs_inode *nfsi,
237 struct nfs_delegation *delegation,
238 struct nfs_client *clp)
239{
240 struct nfs_delegation *deleg_cur =
241 rcu_dereference_protected(nfsi->delegation,
242 lockdep_is_held(&clp->cl_lock));
243
244 if (deleg_cur == NULL || delegation != deleg_cur)
245 return NULL;
246
247 spin_lock(&delegation->lock);
248 set_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500249 list_del_rcu(&delegation->super_list);
Trond Myklebust86e89482008-12-23 15:21:39 -0500250 delegation->inode = NULL;
Trond Myklebust57bfa892008-01-25 16:38:18 -0500251 nfsi->delegation_state = 0;
252 rcu_assign_pointer(nfsi->delegation, NULL);
Trond Myklebust34310432008-12-23 15:21:38 -0500253 spin_unlock(&delegation->lock);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500254 return delegation;
Trond Myklebust57bfa892008-01-25 16:38:18 -0500255}
256
Chuck Leverdda4b222010-12-24 01:32:54 +0000257static struct nfs_delegation *nfs_detach_delegation(struct nfs_inode *nfsi,
Trond Myklebustd25be542013-02-05 11:43:28 -0500258 struct nfs_delegation *delegation,
259 struct nfs_server *server)
Chuck Leverdda4b222010-12-24 01:32:54 +0000260{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000261 struct nfs_client *clp = server->nfs_client;
Chuck Leverdda4b222010-12-24 01:32:54 +0000262
263 spin_lock(&clp->cl_lock);
Trond Myklebustd25be542013-02-05 11:43:28 -0500264 delegation = nfs_detach_delegation_locked(nfsi, delegation, clp);
Chuck Leverdda4b222010-12-24 01:32:54 +0000265 spin_unlock(&clp->cl_lock);
266 return delegation;
267}
268
Trond Myklebustd25be542013-02-05 11:43:28 -0500269static struct nfs_delegation *
270nfs_inode_detach_delegation(struct inode *inode)
271{
272 struct nfs_inode *nfsi = NFS_I(inode);
273 struct nfs_server *server = NFS_SERVER(inode);
274 struct nfs_delegation *delegation;
275
276 delegation = nfs_start_delegation_return(nfsi);
277 if (delegation == NULL)
278 return NULL;
279 return nfs_detach_delegation(nfsi, delegation, server);
280}
281
Chuck Leverd3978bb2010-12-24 01:33:04 +0000282/**
283 * nfs_inode_set_delegation - set up a delegation on an inode
284 * @inode: inode to which delegation applies
285 * @cred: cred to use for subsequent delegation processing
286 * @res: new delegation state from server
287 *
288 * Returns zero on success, or a negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 */
290int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res)
291{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000292 struct nfs_server *server = NFS_SERVER(inode);
293 struct nfs_client *clp = server->nfs_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 struct nfs_inode *nfsi = NFS_I(inode);
David Howells17d2c0a2010-05-01 12:37:18 -0400295 struct nfs_delegation *delegation, *old_delegation;
Trond Myklebust57bfa892008-01-25 16:38:18 -0500296 struct nfs_delegation *freeme = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 int status = 0;
298
Trond Myklebust8535b2b2010-05-13 12:51:01 -0400299 delegation = kmalloc(sizeof(*delegation), GFP_NOFS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 if (delegation == NULL)
301 return -ENOMEM;
Trond Myklebustf597c532012-03-04 18:13:56 -0500302 nfs4_stateid_copy(&delegation->stateid, &res->delegation);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 delegation->type = res->delegation_type;
304 delegation->maxsize = res->maxsize;
Trond Myklebusta9a4a872011-10-17 16:08:46 -0700305 delegation->change_attr = inode->i_version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 delegation->cred = get_rpccred(cred);
307 delegation->inode = inode;
Trond Myklebustb7391f42008-12-23 15:21:52 -0500308 delegation->flags = 1<<NFS_DELEGATION_REFERENCED;
Trond Myklebust34310432008-12-23 15:21:38 -0500309 spin_lock_init(&delegation->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 spin_lock(&clp->cl_lock);
David Howells17d2c0a2010-05-01 12:37:18 -0400312 old_delegation = rcu_dereference_protected(nfsi->delegation,
Chuck Leverd3978bb2010-12-24 01:33:04 +0000313 lockdep_is_held(&clp->cl_lock));
David Howells17d2c0a2010-05-01 12:37:18 -0400314 if (old_delegation != NULL) {
Trond Myklebustf597c532012-03-04 18:13:56 -0500315 if (nfs4_stateid_match(&delegation->stateid,
316 &old_delegation->stateid) &&
David Howells17d2c0a2010-05-01 12:37:18 -0400317 delegation->type == old_delegation->type) {
Trond Myklebust57bfa892008-01-25 16:38:18 -0500318 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 }
Trond Myklebust57bfa892008-01-25 16:38:18 -0500320 /*
321 * Deal with broken servers that hand out two
322 * delegations for the same file.
Trond Myklebust17280172012-03-11 13:11:00 -0400323 * Allow for upgrades to a WRITE delegation, but
324 * nothing else.
Trond Myklebust57bfa892008-01-25 16:38:18 -0500325 */
326 dfprintk(FILE, "%s: server %s handed out "
327 "a duplicate delegation!\n",
Harvey Harrison3110ff82008-05-02 13:42:44 -0700328 __func__, clp->cl_hostname);
Trond Myklebust17280172012-03-11 13:11:00 -0400329 if (delegation->type == old_delegation->type ||
330 !(delegation->type & FMODE_WRITE)) {
Trond Myklebust57bfa892008-01-25 16:38:18 -0500331 freeme = delegation;
332 delegation = NULL;
333 goto out;
334 }
Trond Myklebustd25be542013-02-05 11:43:28 -0500335 freeme = nfs_detach_delegation_locked(nfsi,
336 old_delegation, clp);
337 if (freeme == NULL)
338 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 }
Chuck Leverd3978bb2010-12-24 01:33:04 +0000340 list_add_rcu(&delegation->super_list, &server->delegations);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500341 nfsi->delegation_state = delegation->type;
342 rcu_assign_pointer(nfsi->delegation, delegation);
343 delegation = NULL;
Trond Myklebust412c77c2007-07-03 16:10:55 -0400344
345 /* Ensure we revalidate the attributes and page cache! */
346 spin_lock(&inode->i_lock);
347 nfsi->cache_validity |= NFS_INO_REVAL_FORCED;
348 spin_unlock(&inode->i_lock);
349
Trond Myklebust57bfa892008-01-25 16:38:18 -0500350out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 spin_unlock(&clp->cl_lock);
Trond Myklebust603c83d2007-10-18 19:59:20 -0400352 if (delegation != NULL)
353 nfs_free_delegation(delegation);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500354 if (freeme != NULL)
355 nfs_do_return_delegation(inode, freeme, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 return status;
357}
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359/*
360 * Basic procedure for returning a delegation to the server
361 */
Trond Myklebustd25be542013-02-05 11:43:28 -0500362static int nfs_end_delegation_return(struct inode *inode, struct nfs_delegation *delegation, int issync)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363{
Trond Myklebustd25be542013-02-05 11:43:28 -0500364 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500366 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Trond Myklebustd25be542013-02-05 11:43:28 -0500368 if (delegation == NULL)
369 return 0;
370 do {
371 err = nfs_delegation_claim_opens(inode, &delegation->stateid);
372 if (!issync || err != -EAGAIN)
373 break;
374 /*
375 * Guard against state recovery
376 */
377 err = nfs4_wait_clnt_recover(clp);
378 } while (err == 0);
379
380 if (err) {
381 nfs_abort_delegation_return(delegation, clp);
382 goto out;
383 }
384 if (!nfs_detach_delegation(nfsi, delegation, NFS_SERVER(inode)))
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500385 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500387 err = nfs_do_return_delegation(inode, delegation, issync);
388out:
389 return err;
Trond Myklebust90163022007-07-05 14:55:18 -0400390}
391
Trond Myklebustb7571442013-04-03 14:33:49 -0400392static bool nfs_delegation_need_return(struct nfs_delegation *delegation)
393{
394 bool ret = false;
395
396 if (test_and_clear_bit(NFS_DELEGATION_RETURN, &delegation->flags))
397 ret = true;
398 if (test_and_clear_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags) && !ret) {
399 struct inode *inode;
400
401 spin_lock(&delegation->lock);
402 inode = delegation->inode;
403 if (inode && list_empty(&NFS_I(inode)->open_files))
404 ret = true;
405 spin_unlock(&delegation->lock);
406 }
407 return ret;
408}
409
Chuck Leverd3978bb2010-12-24 01:33:04 +0000410/**
411 * nfs_client_return_marked_delegations - return previously marked delegations
412 * @clp: nfs_client to process
413 *
Trond Myklebustdc327ed2012-05-06 19:46:30 -0400414 * Note that this function is designed to be called by the state
415 * manager thread. For this reason, it cannot flush the dirty data,
416 * since that could deadlock in case of a state recovery error.
417 *
Chuck Leverd3978bb2010-12-24 01:33:04 +0000418 * Returns zero on success, or a negative errno value.
Trond Myklebust515d8612008-12-23 15:21:46 -0500419 */
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500420int nfs_client_return_marked_delegations(struct nfs_client *clp)
Trond Myklebust515d8612008-12-23 15:21:46 -0500421{
422 struct nfs_delegation *delegation;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000423 struct nfs_server *server;
Trond Myklebust515d8612008-12-23 15:21:46 -0500424 struct inode *inode;
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500425 int err = 0;
Trond Myklebust515d8612008-12-23 15:21:46 -0500426
427restart:
428 rcu_read_lock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000429 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
430 list_for_each_entry_rcu(delegation, &server->delegations,
431 super_list) {
Trond Myklebustb7571442013-04-03 14:33:49 -0400432 if (!nfs_delegation_need_return(delegation))
Chuck Leverd3978bb2010-12-24 01:33:04 +0000433 continue;
434 inode = nfs_delegation_grab_inode(delegation);
435 if (inode == NULL)
436 continue;
Trond Myklebustd25be542013-02-05 11:43:28 -0500437 delegation = nfs_start_delegation_return_locked(NFS_I(inode));
Chuck Leverd3978bb2010-12-24 01:33:04 +0000438 rcu_read_unlock();
439
Trond Myklebustd25be542013-02-05 11:43:28 -0500440 err = nfs_end_delegation_return(inode, delegation, 0);
Chuck Leverd3978bb2010-12-24 01:33:04 +0000441 iput(inode);
442 if (!err)
443 goto restart;
444 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
445 return err;
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500446 }
Trond Myklebust515d8612008-12-23 15:21:46 -0500447 }
448 rcu_read_unlock();
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500449 return 0;
Trond Myklebust515d8612008-12-23 15:21:46 -0500450}
451
Chuck Leverd3978bb2010-12-24 01:33:04 +0000452/**
453 * nfs_inode_return_delegation_noreclaim - return delegation, don't reclaim opens
454 * @inode: inode to process
455 *
456 * Does not protect against delegation reclaims, therefore really only safe
457 * to be called from nfs4_clear_inode().
Trond Myklebuste6f81072008-01-24 18:14:34 -0500458 */
459void nfs_inode_return_delegation_noreclaim(struct inode *inode)
460{
Trond Myklebuste6f81072008-01-24 18:14:34 -0500461 struct nfs_delegation *delegation;
462
Trond Myklebustd25be542013-02-05 11:43:28 -0500463 delegation = nfs_inode_detach_delegation(inode);
464 if (delegation != NULL)
465 nfs_do_return_delegation(inode, delegation, 0);
Trond Myklebuste6f81072008-01-24 18:14:34 -0500466}
467
Chuck Leverd3978bb2010-12-24 01:33:04 +0000468/**
469 * nfs_inode_return_delegation - synchronously return a delegation
470 * @inode: inode to process
471 *
Trond Myklebustc57d1bc2012-05-06 19:34:17 -0400472 * This routine will always flush any dirty data to disk on the
473 * assumption that if we need to return the delegation, then
474 * we should stop caching.
475 *
Chuck Leverd3978bb2010-12-24 01:33:04 +0000476 * Returns zero on success, or a negative errno value.
477 */
Bryan Schumaker57ec14c2012-06-20 15:53:44 -0400478int nfs4_inode_return_delegation(struct inode *inode)
Trond Myklebust90163022007-07-05 14:55:18 -0400479{
Trond Myklebust90163022007-07-05 14:55:18 -0400480 struct nfs_inode *nfsi = NFS_I(inode);
481 struct nfs_delegation *delegation;
482 int err = 0;
483
Trond Myklebustc57d1bc2012-05-06 19:34:17 -0400484 nfs_wb_all(inode);
Trond Myklebustd25be542013-02-05 11:43:28 -0500485 delegation = nfs_start_delegation_return(nfsi);
486 if (delegation != NULL)
487 err = nfs_end_delegation_return(inode, delegation, 1);
Trond Myklebust90163022007-07-05 14:55:18 -0400488 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
490
Trond Myklebustb7571442013-04-03 14:33:49 -0400491static void nfs_mark_return_if_closed_delegation(struct nfs_server *server,
492 struct nfs_delegation *delegation)
493{
494 set_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags);
495 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
496}
497
Trond Myklebusted1e62112011-07-25 15:37:29 -0400498static void nfs_mark_return_delegation(struct nfs_server *server,
499 struct nfs_delegation *delegation)
Trond Myklebust6411bd42008-12-23 15:21:51 -0500500{
501 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
Trond Myklebusted1e62112011-07-25 15:37:29 -0400502 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
Trond Myklebust6411bd42008-12-23 15:21:51 -0500503}
504
Trond Myklebust5c31e232013-04-03 19:04:58 -0400505static bool nfs_server_mark_return_all_delegations(struct nfs_server *server)
506{
507 struct nfs_delegation *delegation;
508 bool ret = false;
509
510 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
511 nfs_mark_return_delegation(server, delegation);
512 ret = true;
513 }
514 return ret;
515}
516
Chuck Leverd3978bb2010-12-24 01:33:04 +0000517/**
518 * nfs_super_return_all_delegations - return delegations for one superblock
519 * @sb: sb to process
520 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 */
Bryan Schumakereeebf912012-06-20 15:53:41 -0400522void nfs_server_return_all_delegations(struct nfs_server *server)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000524 struct nfs_client *clp = server->nfs_client;
Trond Myklebust5c31e232013-04-03 19:04:58 -0400525 bool need_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527 if (clp == NULL)
528 return;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000529
Trond Myklebust8383e462007-07-06 15:12:04 -0400530 rcu_read_lock();
Trond Myklebust5c31e232013-04-03 19:04:58 -0400531 need_wait = nfs_server_mark_return_all_delegations(server);
Trond Myklebust8383e462007-07-06 15:12:04 -0400532 rcu_read_unlock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000533
Trond Myklebust5c31e232013-04-03 19:04:58 -0400534 if (need_wait) {
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500535 nfs4_schedule_state_manager(clp);
Trond Myklebust5c31e232013-04-03 19:04:58 -0400536 nfs4_wait_clnt_recover(clp);
537 }
Trond Myklebust515d8612008-12-23 15:21:46 -0500538}
539
Chuck Leverd3978bb2010-12-24 01:33:04 +0000540static void nfs_mark_return_all_delegation_types(struct nfs_server *server,
541 fmode_t flags)
Trond Myklebust515d8612008-12-23 15:21:46 -0500542{
543 struct nfs_delegation *delegation;
544
Chuck Leverd3978bb2010-12-24 01:33:04 +0000545 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
Alexandros Batsakisc79571a2009-12-05 13:20:52 -0500546 if ((delegation->type == (FMODE_READ|FMODE_WRITE)) && !(flags & FMODE_WRITE))
547 continue;
548 if (delegation->type & flags)
Trond Myklebusted1e62112011-07-25 15:37:29 -0400549 nfs_mark_return_delegation(server, delegation);
Trond Myklebust707fb4b2008-12-23 15:21:47 -0500550 }
Chuck Leverd3978bb2010-12-24 01:33:04 +0000551}
552
553static void nfs_client_mark_return_all_delegation_types(struct nfs_client *clp,
554 fmode_t flags)
555{
556 struct nfs_server *server;
557
558 rcu_read_lock();
559 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
560 nfs_mark_return_all_delegation_types(server, flags);
Trond Myklebust515d8612008-12-23 15:21:46 -0500561 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562}
563
Trond Myklebustb0d3ded2008-12-23 15:21:50 -0500564static void nfs_delegation_run_state_manager(struct nfs_client *clp)
Trond Myklebust58d97142006-01-03 09:55:24 +0100565{
Trond Myklebustb0d3ded2008-12-23 15:21:50 -0500566 if (test_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state))
567 nfs4_schedule_state_manager(clp);
Trond Myklebust58d97142006-01-03 09:55:24 +0100568}
569
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500570void nfs_remove_bad_delegation(struct inode *inode)
571{
572 struct nfs_delegation *delegation;
573
Trond Myklebustd25be542013-02-05 11:43:28 -0500574 delegation = nfs_inode_detach_delegation(inode);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500575 if (delegation) {
576 nfs_inode_find_state_and_recover(inode, &delegation->stateid);
577 nfs_free_delegation(delegation);
578 }
579}
Andy Adamson9cb81962012-03-07 10:49:41 -0500580EXPORT_SYMBOL_GPL(nfs_remove_bad_delegation);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500581
Chuck Leverd3978bb2010-12-24 01:33:04 +0000582/**
583 * nfs_expire_all_delegation_types
584 * @clp: client to process
585 * @flags: delegation types to expire
586 *
587 */
Alexandros Batsakis31f09602009-12-05 13:27:02 -0500588void nfs_expire_all_delegation_types(struct nfs_client *clp, fmode_t flags)
Alexandros Batsakisc79571a2009-12-05 13:20:52 -0500589{
590 nfs_client_mark_return_all_delegation_types(clp, flags);
591 nfs_delegation_run_state_manager(clp);
592}
593
Chuck Leverd3978bb2010-12-24 01:33:04 +0000594/**
595 * nfs_expire_all_delegations
596 * @clp: client to process
597 *
598 */
David Howellsadfa6f92006-08-22 20:06:08 -0400599void nfs_expire_all_delegations(struct nfs_client *clp)
Trond Myklebust58d97142006-01-03 09:55:24 +0100600{
Alexandros Batsakisc79571a2009-12-05 13:20:52 -0500601 nfs_expire_all_delegation_types(clp, FMODE_READ|FMODE_WRITE);
Trond Myklebust58d97142006-01-03 09:55:24 +0100602}
603
Chuck Leverd3978bb2010-12-24 01:33:04 +0000604static void nfs_mark_return_unreferenced_delegations(struct nfs_server *server)
Trond Myklebustb7391f42008-12-23 15:21:52 -0500605{
606 struct nfs_delegation *delegation;
607
Chuck Leverd3978bb2010-12-24 01:33:04 +0000608 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
Trond Myklebustb7391f42008-12-23 15:21:52 -0500609 if (test_and_clear_bit(NFS_DELEGATION_REFERENCED, &delegation->flags))
610 continue;
Trond Myklebustb7571442013-04-03 14:33:49 -0400611 nfs_mark_return_if_closed_delegation(server, delegation);
Trond Myklebustb7391f42008-12-23 15:21:52 -0500612 }
Trond Myklebustb7391f42008-12-23 15:21:52 -0500613}
614
Chuck Leverd3978bb2010-12-24 01:33:04 +0000615/**
616 * nfs_expire_unreferenced_delegations - Eliminate unused delegations
617 * @clp: nfs_client to process
618 *
619 */
Trond Myklebustb7391f42008-12-23 15:21:52 -0500620void nfs_expire_unreferenced_delegations(struct nfs_client *clp)
621{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000622 struct nfs_server *server;
623
624 rcu_read_lock();
625 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
626 nfs_mark_return_unreferenced_delegations(server);
627 rcu_read_unlock();
628
Trond Myklebustb7391f42008-12-23 15:21:52 -0500629 nfs_delegation_run_state_manager(clp);
630}
631
Chuck Leverd3978bb2010-12-24 01:33:04 +0000632/**
633 * nfs_async_inode_return_delegation - asynchronously return a delegation
634 * @inode: inode to process
Trond Myklebust8e663f02012-03-04 18:13:56 -0500635 * @stateid: state ID information
Chuck Leverd3978bb2010-12-24 01:33:04 +0000636 *
637 * Returns zero on success, or a negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 */
Chuck Leverd3978bb2010-12-24 01:33:04 +0000639int nfs_async_inode_return_delegation(struct inode *inode,
640 const nfs4_stateid *stateid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Trond Myklebusted1e62112011-07-25 15:37:29 -0400642 struct nfs_server *server = NFS_SERVER(inode);
643 struct nfs_client *clp = server->nfs_client;
Trond Myklebust6411bd42008-12-23 15:21:51 -0500644 struct nfs_delegation *delegation;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Trond Myklebustdc327ed2012-05-06 19:46:30 -0400646 filemap_flush(inode->i_mapping);
647
Trond Myklebust6411bd42008-12-23 15:21:51 -0500648 rcu_read_lock();
649 delegation = rcu_dereference(NFS_I(inode)->delegation);
Alexandros Batsakis25976412009-12-05 13:48:55 -0500650
Trond Myklebust36281ca2012-03-04 18:13:56 -0500651 if (!clp->cl_mvops->match_stateid(&delegation->stateid, stateid)) {
Trond Myklebust6411bd42008-12-23 15:21:51 -0500652 rcu_read_unlock();
653 return -ENOENT;
654 }
Trond Myklebusted1e62112011-07-25 15:37:29 -0400655 nfs_mark_return_delegation(server, delegation);
Trond Myklebust6411bd42008-12-23 15:21:51 -0500656 rcu_read_unlock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000657
Trond Myklebust6411bd42008-12-23 15:21:51 -0500658 nfs_delegation_run_state_manager(clp);
659 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660}
661
Chuck Leverd3978bb2010-12-24 01:33:04 +0000662static struct inode *
663nfs_delegation_find_inode_server(struct nfs_server *server,
664 const struct nfs_fh *fhandle)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
666 struct nfs_delegation *delegation;
667 struct inode *res = NULL;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000668
669 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
Trond Myklebust86e89482008-12-23 15:21:39 -0500670 spin_lock(&delegation->lock);
671 if (delegation->inode != NULL &&
672 nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 res = igrab(delegation->inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 }
Trond Myklebust86e89482008-12-23 15:21:39 -0500675 spin_unlock(&delegation->lock);
676 if (res != NULL)
677 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 }
Chuck Leverd3978bb2010-12-24 01:33:04 +0000679 return res;
680}
681
682/**
683 * nfs_delegation_find_inode - retrieve the inode associated with a delegation
684 * @clp: client state handle
685 * @fhandle: filehandle from a delegation recall
686 *
687 * Returns pointer to inode matching "fhandle," or NULL if a matching inode
688 * cannot be found.
689 */
690struct inode *nfs_delegation_find_inode(struct nfs_client *clp,
691 const struct nfs_fh *fhandle)
692{
693 struct nfs_server *server;
694 struct inode *res = NULL;
695
696 rcu_read_lock();
697 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
698 res = nfs_delegation_find_inode_server(server, fhandle);
699 if (res != NULL)
700 break;
701 }
Trond Myklebust8383e462007-07-06 15:12:04 -0400702 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 return res;
704}
705
Chuck Leverd3978bb2010-12-24 01:33:04 +0000706static void nfs_delegation_mark_reclaim_server(struct nfs_server *server)
707{
708 struct nfs_delegation *delegation;
709
710 list_for_each_entry_rcu(delegation, &server->delegations, super_list)
711 set_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
712}
713
714/**
715 * nfs_delegation_mark_reclaim - mark all delegations as needing to be reclaimed
716 * @clp: nfs_client to process
717 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 */
David Howellsadfa6f92006-08-22 20:06:08 -0400719void nfs_delegation_mark_reclaim(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000721 struct nfs_server *server;
722
Trond Myklebust8383e462007-07-06 15:12:04 -0400723 rcu_read_lock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000724 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
725 nfs_delegation_mark_reclaim_server(server);
Trond Myklebust8383e462007-07-06 15:12:04 -0400726 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727}
728
Chuck Leverd3978bb2010-12-24 01:33:04 +0000729/**
730 * nfs_delegation_reap_unclaimed - reap unclaimed delegations after reboot recovery is done
731 * @clp: nfs_client to process
732 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 */
David Howellsadfa6f92006-08-22 20:06:08 -0400734void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735{
Trond Myklebust8383e462007-07-06 15:12:04 -0400736 struct nfs_delegation *delegation;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000737 struct nfs_server *server;
Trond Myklebust86e89482008-12-23 15:21:39 -0500738 struct inode *inode;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000739
Trond Myklebust8383e462007-07-06 15:12:04 -0400740restart:
741 rcu_read_lock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000742 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
743 list_for_each_entry_rcu(delegation, &server->delegations,
744 super_list) {
745 if (test_bit(NFS_DELEGATION_NEED_RECLAIM,
746 &delegation->flags) == 0)
747 continue;
748 inode = nfs_delegation_grab_inode(delegation);
749 if (inode == NULL)
750 continue;
751 delegation = nfs_detach_delegation(NFS_I(inode),
Trond Myklebustd25be542013-02-05 11:43:28 -0500752 delegation, server);
Chuck Leverd3978bb2010-12-24 01:33:04 +0000753 rcu_read_unlock();
754
755 if (delegation != NULL)
756 nfs_free_delegation(delegation);
757 iput(inode);
758 goto restart;
759 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 }
Trond Myklebust8383e462007-07-06 15:12:04 -0400761 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762}
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500763
Chuck Leverd3978bb2010-12-24 01:33:04 +0000764/**
765 * nfs_delegations_present - check for existence of delegations
766 * @clp: client state handle
767 *
768 * Returns one if there are any nfs_delegation structures attached
769 * to this nfs_client.
770 */
771int nfs_delegations_present(struct nfs_client *clp)
772{
773 struct nfs_server *server;
774 int ret = 0;
775
776 rcu_read_lock();
777 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
778 if (!list_empty(&server->delegations)) {
779 ret = 1;
780 break;
781 }
782 rcu_read_unlock();
783 return ret;
784}
785
786/**
787 * nfs4_copy_delegation_stateid - Copy inode's state ID information
788 * @dst: stateid data structure to fill in
789 * @inode: inode to check
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500790 * @flags: delegation type requirement
Chuck Leverd3978bb2010-12-24 01:33:04 +0000791 *
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500792 * Returns "true" and fills in "dst->data" * if inode had a delegation,
793 * otherwise "false" is returned.
Chuck Leverd3978bb2010-12-24 01:33:04 +0000794 */
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500795bool nfs4_copy_delegation_stateid(nfs4_stateid *dst, struct inode *inode,
796 fmode_t flags)
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500797{
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500798 struct nfs_inode *nfsi = NFS_I(inode);
799 struct nfs_delegation *delegation;
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500800 bool ret;
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500801
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500802 flags &= FMODE_READ|FMODE_WRITE;
Trond Myklebust8383e462007-07-06 15:12:04 -0400803 rcu_read_lock();
804 delegation = rcu_dereference(nfsi->delegation);
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500805 ret = (delegation != NULL && (delegation->type & flags) == flags);
806 if (ret) {
Trond Myklebustf597c532012-03-04 18:13:56 -0500807 nfs4_stateid_copy(dst, &delegation->stateid);
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500808 nfs_mark_delegation_referenced(delegation);
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500809 }
Trond Myklebust8383e462007-07-06 15:12:04 -0400810 rcu_read_unlock();
811 return ret;
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500812}