blob: 57db3244f4d967dd5479dbf3ab883c6d28cc2cbd [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 Myklebustdb4f2e632013-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 goto out;
Jeff Layton314d7cc2013-04-10 15:36:48 -040075
Arnd Bergmannb89f4322010-09-18 15:09:31 +020076 /* Protect inode->i_flock using the file locks lock */
77 lock_flocks();
Harvey Harrison90dc7d22008-02-20 13:03:05 -080078 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
Trond Myklebust888e6942005-11-04 15:38:11 -050079 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
80 continue;
Trond Myklebustcd3758e2007-08-10 17:44:32 -040081 if (nfs_file_open_context(fl->fl_file) != ctx)
Trond Myklebust888e6942005-11-04 15:38:11 -050082 continue;
Arnd Bergmannb89f4322010-09-18 15:09:31 +020083 unlock_flocks();
Trond Myklebustdb4f2e632013-04-01 15:56:46 -040084 status = nfs4_lock_delegation_recall(fl, state, stateid);
Trond Myklebustd5122202009-06-17 13:22:58 -070085 if (status < 0)
Trond Myklebust3f09df72009-06-17 13:23:00 -070086 goto out;
Arnd Bergmannb89f4322010-09-18 15:09:31 +020087 lock_flocks();
Trond Myklebust888e6942005-11-04 15:38:11 -050088 }
Arnd Bergmannb89f4322010-09-18 15:09:31 +020089 unlock_flocks();
Trond Myklebust3f09df72009-06-17 13:23:00 -070090out:
Trond Myklebust888e6942005-11-04 15:38:11 -050091 return status;
92}
93
Trond Myklebustd18cc1f2009-12-03 08:10:17 -050094static int nfs_delegation_claim_opens(struct inode *inode, const nfs4_stateid *stateid)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095{
96 struct nfs_inode *nfsi = NFS_I(inode);
97 struct nfs_open_context *ctx;
Trond Myklebustd25be542013-02-05 11:43:28 -050098 struct nfs4_state_owner *sp;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 struct nfs4_state *state;
Trond Myklebustd25be542013-02-05 11:43:28 -0500100 unsigned int seq;
Trond Myklebust888e6942005-11-04 15:38:11 -0500101 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103again:
104 spin_lock(&inode->i_lock);
105 list_for_each_entry(ctx, &nfsi->open_files, list) {
106 state = ctx->state;
107 if (state == NULL)
108 continue;
109 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
110 continue;
Trond Myklebustf597c532012-03-04 18:13:56 -0500111 if (!nfs4_stateid_match(&state->stateid, stateid))
Trond Myklebust90163022007-07-05 14:55:18 -0400112 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 get_nfs_open_context(ctx);
114 spin_unlock(&inode->i_lock);
Trond Myklebustd25be542013-02-05 11:43:28 -0500115 sp = state->owner;
Trond Myklebust65b62a22013-02-07 10:54:07 -0500116 /* Block nfs4_proc_unlck */
117 mutex_lock(&sp->so_delegreturn_mutex);
Trond Myklebustd25be542013-02-05 11:43:28 -0500118 seq = raw_seqcount_begin(&sp->so_reclaim_seqcount);
Trond Myklebust13437e12007-07-06 15:10:43 -0400119 err = nfs4_open_delegation_recall(ctx, state, stateid);
Trond Myklebustd25be542013-02-05 11:43:28 -0500120 if (!err)
Trond Myklebustdb4f2e632013-04-01 15:56:46 -0400121 err = nfs_delegation_claim_locks(ctx, state, stateid);
Trond Myklebustd25be542013-02-05 11:43:28 -0500122 if (!err && read_seqcount_retry(&sp->so_reclaim_seqcount, seq))
123 err = -EAGAIN;
Trond Myklebust65b62a22013-02-07 10:54:07 -0500124 mutex_unlock(&sp->so_delegreturn_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 put_nfs_open_context(ctx);
Trond Myklebust888e6942005-11-04 15:38:11 -0500126 if (err != 0)
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500127 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 goto again;
129 }
130 spin_unlock(&inode->i_lock);
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500131 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132}
133
Chuck Leverd3978bb2010-12-24 01:33:04 +0000134/**
135 * nfs_inode_reclaim_delegation - process a delegation reclaim request
136 * @inode: inode to process
137 * @cred: credential to use for request
138 * @res: new delegation state from server
139 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 */
Chuck Leverd3978bb2010-12-24 01:33:04 +0000141void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred,
142 struct nfs_openres *res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
Trond Myklebust8f649c32010-05-01 12:36:18 -0400144 struct nfs_delegation *delegation;
145 struct rpc_cred *oldcred = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Trond Myklebust8f649c32010-05-01 12:36:18 -0400147 rcu_read_lock();
148 delegation = rcu_dereference(NFS_I(inode)->delegation);
149 if (delegation != NULL) {
150 spin_lock(&delegation->lock);
151 if (delegation->inode != NULL) {
Trond Myklebustf597c532012-03-04 18:13:56 -0500152 nfs4_stateid_copy(&delegation->stateid, &res->delegation);
Trond Myklebust8f649c32010-05-01 12:36:18 -0400153 delegation->type = res->delegation_type;
154 delegation->maxsize = res->maxsize;
155 oldcred = delegation->cred;
156 delegation->cred = get_rpccred(cred);
157 clear_bit(NFS_DELEGATION_NEED_RECLAIM,
158 &delegation->flags);
159 NFS_I(inode)->delegation_state = delegation->type;
160 spin_unlock(&delegation->lock);
161 put_rpccred(oldcred);
162 rcu_read_unlock();
163 } else {
164 /* We appear to have raced with a delegation return. */
165 spin_unlock(&delegation->lock);
166 rcu_read_unlock();
167 nfs_inode_set_delegation(inode, cred, res);
168 }
169 } else {
170 rcu_read_unlock();
171 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172}
173
Trond Myklebust57bfa892008-01-25 16:38:18 -0500174static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation, int issync)
175{
176 int res = 0;
177
178 res = nfs4_proc_delegreturn(inode, delegation->cred, &delegation->stateid, issync);
179 nfs_free_delegation(delegation);
180 return res;
181}
182
Trond Myklebust86e89482008-12-23 15:21:39 -0500183static struct inode *nfs_delegation_grab_inode(struct nfs_delegation *delegation)
184{
185 struct inode *inode = NULL;
186
187 spin_lock(&delegation->lock);
188 if (delegation->inode != NULL)
189 inode = igrab(delegation->inode);
190 spin_unlock(&delegation->lock);
191 return inode;
192}
193
Chuck Leverdda4b222010-12-24 01:32:54 +0000194static struct nfs_delegation *
Trond Myklebustd25be542013-02-05 11:43:28 -0500195nfs_start_delegation_return_locked(struct nfs_inode *nfsi)
Trond Myklebust57bfa892008-01-25 16:38:18 -0500196{
Trond Myklebustd25be542013-02-05 11:43:28 -0500197 struct nfs_delegation *ret = NULL;
198 struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500199
200 if (delegation == NULL)
Trond Myklebustd25be542013-02-05 11:43:28 -0500201 goto out;
202 spin_lock(&delegation->lock);
203 if (!test_and_set_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
204 ret = delegation;
205 spin_unlock(&delegation->lock);
206out:
207 return ret;
208}
209
210static struct nfs_delegation *
211nfs_start_delegation_return(struct nfs_inode *nfsi)
212{
213 struct nfs_delegation *delegation;
214
215 rcu_read_lock();
216 delegation = nfs_start_delegation_return_locked(nfsi);
217 rcu_read_unlock();
218 return delegation;
219}
220
221static void
222nfs_abort_delegation_return(struct nfs_delegation *delegation,
223 struct nfs_client *clp)
224{
Chuck Leverdda4b222010-12-24 01:32:54 +0000225
Trond Myklebust34310432008-12-23 15:21:38 -0500226 spin_lock(&delegation->lock);
Trond Myklebustd25be542013-02-05 11:43:28 -0500227 clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
228 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
229 spin_unlock(&delegation->lock);
230 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
231}
232
233static struct nfs_delegation *
234nfs_detach_delegation_locked(struct nfs_inode *nfsi,
235 struct nfs_delegation *delegation,
236 struct nfs_client *clp)
237{
238 struct nfs_delegation *deleg_cur =
239 rcu_dereference_protected(nfsi->delegation,
240 lockdep_is_held(&clp->cl_lock));
241
242 if (deleg_cur == NULL || delegation != deleg_cur)
243 return NULL;
244
245 spin_lock(&delegation->lock);
246 set_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500247 list_del_rcu(&delegation->super_list);
Trond Myklebust86e89482008-12-23 15:21:39 -0500248 delegation->inode = NULL;
Trond Myklebust57bfa892008-01-25 16:38:18 -0500249 nfsi->delegation_state = 0;
250 rcu_assign_pointer(nfsi->delegation, NULL);
Trond Myklebust34310432008-12-23 15:21:38 -0500251 spin_unlock(&delegation->lock);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500252 return delegation;
Trond Myklebust57bfa892008-01-25 16:38:18 -0500253}
254
Chuck Leverdda4b222010-12-24 01:32:54 +0000255static struct nfs_delegation *nfs_detach_delegation(struct nfs_inode *nfsi,
Trond Myklebustd25be542013-02-05 11:43:28 -0500256 struct nfs_delegation *delegation,
257 struct nfs_server *server)
Chuck Leverdda4b222010-12-24 01:32:54 +0000258{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000259 struct nfs_client *clp = server->nfs_client;
Chuck Leverdda4b222010-12-24 01:32:54 +0000260
261 spin_lock(&clp->cl_lock);
Trond Myklebustd25be542013-02-05 11:43:28 -0500262 delegation = nfs_detach_delegation_locked(nfsi, delegation, clp);
Chuck Leverdda4b222010-12-24 01:32:54 +0000263 spin_unlock(&clp->cl_lock);
264 return delegation;
265}
266
Trond Myklebustd25be542013-02-05 11:43:28 -0500267static struct nfs_delegation *
268nfs_inode_detach_delegation(struct inode *inode)
269{
270 struct nfs_inode *nfsi = NFS_I(inode);
271 struct nfs_server *server = NFS_SERVER(inode);
272 struct nfs_delegation *delegation;
273
274 delegation = nfs_start_delegation_return(nfsi);
275 if (delegation == NULL)
276 return NULL;
277 return nfs_detach_delegation(nfsi, delegation, server);
278}
279
Chuck Leverd3978bb2010-12-24 01:33:04 +0000280/**
281 * nfs_inode_set_delegation - set up a delegation on an inode
282 * @inode: inode to which delegation applies
283 * @cred: cred to use for subsequent delegation processing
284 * @res: new delegation state from server
285 *
286 * Returns zero on success, or a negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 */
288int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res)
289{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000290 struct nfs_server *server = NFS_SERVER(inode);
291 struct nfs_client *clp = server->nfs_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 struct nfs_inode *nfsi = NFS_I(inode);
David Howells17d2c0a2010-05-01 12:37:18 -0400293 struct nfs_delegation *delegation, *old_delegation;
Trond Myklebust57bfa892008-01-25 16:38:18 -0500294 struct nfs_delegation *freeme = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 int status = 0;
296
Trond Myklebust8535b2b2010-05-13 12:51:01 -0400297 delegation = kmalloc(sizeof(*delegation), GFP_NOFS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 if (delegation == NULL)
299 return -ENOMEM;
Trond Myklebustf597c532012-03-04 18:13:56 -0500300 nfs4_stateid_copy(&delegation->stateid, &res->delegation);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 delegation->type = res->delegation_type;
302 delegation->maxsize = res->maxsize;
Trond Myklebusta9a4a872011-10-17 16:08:46 -0700303 delegation->change_attr = inode->i_version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 delegation->cred = get_rpccred(cred);
305 delegation->inode = inode;
Trond Myklebustb7391f42008-12-23 15:21:52 -0500306 delegation->flags = 1<<NFS_DELEGATION_REFERENCED;
Trond Myklebust34310432008-12-23 15:21:38 -0500307 spin_lock_init(&delegation->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309 spin_lock(&clp->cl_lock);
David Howells17d2c0a2010-05-01 12:37:18 -0400310 old_delegation = rcu_dereference_protected(nfsi->delegation,
Chuck Leverd3978bb2010-12-24 01:33:04 +0000311 lockdep_is_held(&clp->cl_lock));
David Howells17d2c0a2010-05-01 12:37:18 -0400312 if (old_delegation != NULL) {
Trond Myklebustf597c532012-03-04 18:13:56 -0500313 if (nfs4_stateid_match(&delegation->stateid,
314 &old_delegation->stateid) &&
David Howells17d2c0a2010-05-01 12:37:18 -0400315 delegation->type == old_delegation->type) {
Trond Myklebust57bfa892008-01-25 16:38:18 -0500316 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 }
Trond Myklebust57bfa892008-01-25 16:38:18 -0500318 /*
319 * Deal with broken servers that hand out two
320 * delegations for the same file.
Trond Myklebust17280172012-03-11 13:11:00 -0400321 * Allow for upgrades to a WRITE delegation, but
322 * nothing else.
Trond Myklebust57bfa892008-01-25 16:38:18 -0500323 */
324 dfprintk(FILE, "%s: server %s handed out "
325 "a duplicate delegation!\n",
Harvey Harrison3110ff82008-05-02 13:42:44 -0700326 __func__, clp->cl_hostname);
Trond Myklebust17280172012-03-11 13:11:00 -0400327 if (delegation->type == old_delegation->type ||
328 !(delegation->type & FMODE_WRITE)) {
Trond Myklebust57bfa892008-01-25 16:38:18 -0500329 freeme = delegation;
330 delegation = NULL;
331 goto out;
332 }
Trond Myklebustd25be542013-02-05 11:43:28 -0500333 freeme = nfs_detach_delegation_locked(nfsi,
334 old_delegation, clp);
335 if (freeme == NULL)
336 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 }
Chuck Leverd3978bb2010-12-24 01:33:04 +0000338 list_add_rcu(&delegation->super_list, &server->delegations);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500339 nfsi->delegation_state = delegation->type;
340 rcu_assign_pointer(nfsi->delegation, delegation);
341 delegation = NULL;
Trond Myklebust412c77c2007-07-03 16:10:55 -0400342
343 /* Ensure we revalidate the attributes and page cache! */
344 spin_lock(&inode->i_lock);
345 nfsi->cache_validity |= NFS_INO_REVAL_FORCED;
346 spin_unlock(&inode->i_lock);
347
Trond Myklebust57bfa892008-01-25 16:38:18 -0500348out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 spin_unlock(&clp->cl_lock);
Trond Myklebust603c83d2007-10-18 19:59:20 -0400350 if (delegation != NULL)
351 nfs_free_delegation(delegation);
Trond Myklebust57bfa892008-01-25 16:38:18 -0500352 if (freeme != NULL)
353 nfs_do_return_delegation(inode, freeme, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 return status;
355}
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357/*
358 * Basic procedure for returning a delegation to the server
359 */
Trond Myklebustd25be542013-02-05 11:43:28 -0500360static int nfs_end_delegation_return(struct inode *inode, struct nfs_delegation *delegation, int issync)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361{
Trond Myklebustd25be542013-02-05 11:43:28 -0500362 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 struct nfs_inode *nfsi = NFS_I(inode);
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500364 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Trond Myklebustd25be542013-02-05 11:43:28 -0500366 if (delegation == NULL)
367 return 0;
368 do {
369 err = nfs_delegation_claim_opens(inode, &delegation->stateid);
370 if (!issync || err != -EAGAIN)
371 break;
372 /*
373 * Guard against state recovery
374 */
375 err = nfs4_wait_clnt_recover(clp);
376 } while (err == 0);
377
378 if (err) {
379 nfs_abort_delegation_return(delegation, clp);
380 goto out;
381 }
382 if (!nfs_detach_delegation(nfsi, delegation, NFS_SERVER(inode)))
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500383 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500385 err = nfs_do_return_delegation(inode, delegation, issync);
386out:
387 return err;
Trond Myklebust90163022007-07-05 14:55:18 -0400388}
389
Trond Myklebustb7571442013-04-03 14:33:49 -0400390static bool nfs_delegation_need_return(struct nfs_delegation *delegation)
391{
392 bool ret = false;
393
394 if (test_and_clear_bit(NFS_DELEGATION_RETURN, &delegation->flags))
395 ret = true;
396 if (test_and_clear_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags) && !ret) {
397 struct inode *inode;
398
399 spin_lock(&delegation->lock);
400 inode = delegation->inode;
401 if (inode && list_empty(&NFS_I(inode)->open_files))
402 ret = true;
403 spin_unlock(&delegation->lock);
404 }
405 return ret;
406}
407
Chuck Leverd3978bb2010-12-24 01:33:04 +0000408/**
409 * nfs_client_return_marked_delegations - return previously marked delegations
410 * @clp: nfs_client to process
411 *
Trond Myklebustdc327ed2012-05-06 19:46:30 -0400412 * Note that this function is designed to be called by the state
413 * manager thread. For this reason, it cannot flush the dirty data,
414 * since that could deadlock in case of a state recovery error.
415 *
Chuck Leverd3978bb2010-12-24 01:33:04 +0000416 * Returns zero on success, or a negative errno value.
Trond Myklebust515d8612008-12-23 15:21:46 -0500417 */
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500418int nfs_client_return_marked_delegations(struct nfs_client *clp)
Trond Myklebust515d8612008-12-23 15:21:46 -0500419{
420 struct nfs_delegation *delegation;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000421 struct nfs_server *server;
Trond Myklebust515d8612008-12-23 15:21:46 -0500422 struct inode *inode;
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500423 int err = 0;
Trond Myklebust515d8612008-12-23 15:21:46 -0500424
425restart:
426 rcu_read_lock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000427 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
428 list_for_each_entry_rcu(delegation, &server->delegations,
429 super_list) {
Trond Myklebustb7571442013-04-03 14:33:49 -0400430 if (!nfs_delegation_need_return(delegation))
Chuck Leverd3978bb2010-12-24 01:33:04 +0000431 continue;
432 inode = nfs_delegation_grab_inode(delegation);
433 if (inode == NULL)
434 continue;
Trond Myklebustd25be542013-02-05 11:43:28 -0500435 delegation = nfs_start_delegation_return_locked(NFS_I(inode));
Chuck Leverd3978bb2010-12-24 01:33:04 +0000436 rcu_read_unlock();
437
Trond Myklebustd25be542013-02-05 11:43:28 -0500438 err = nfs_end_delegation_return(inode, delegation, 0);
Chuck Leverd3978bb2010-12-24 01:33:04 +0000439 iput(inode);
440 if (!err)
441 goto restart;
442 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
443 return err;
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500444 }
Trond Myklebust515d8612008-12-23 15:21:46 -0500445 }
446 rcu_read_unlock();
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500447 return 0;
Trond Myklebust515d8612008-12-23 15:21:46 -0500448}
449
Chuck Leverd3978bb2010-12-24 01:33:04 +0000450/**
451 * nfs_inode_return_delegation_noreclaim - return delegation, don't reclaim opens
452 * @inode: inode to process
453 *
454 * Does not protect against delegation reclaims, therefore really only safe
455 * to be called from nfs4_clear_inode().
Trond Myklebuste6f81072008-01-24 18:14:34 -0500456 */
457void nfs_inode_return_delegation_noreclaim(struct inode *inode)
458{
Trond Myklebuste6f81072008-01-24 18:14:34 -0500459 struct nfs_delegation *delegation;
460
Trond Myklebustd25be542013-02-05 11:43:28 -0500461 delegation = nfs_inode_detach_delegation(inode);
462 if (delegation != NULL)
463 nfs_do_return_delegation(inode, delegation, 0);
Trond Myklebuste6f81072008-01-24 18:14:34 -0500464}
465
Chuck Leverd3978bb2010-12-24 01:33:04 +0000466/**
467 * nfs_inode_return_delegation - synchronously return a delegation
468 * @inode: inode to process
469 *
Trond Myklebustc57d1bc2012-05-06 19:34:17 -0400470 * This routine will always flush any dirty data to disk on the
471 * assumption that if we need to return the delegation, then
472 * we should stop caching.
473 *
Chuck Leverd3978bb2010-12-24 01:33:04 +0000474 * Returns zero on success, or a negative errno value.
475 */
Bryan Schumaker57ec14c2012-06-20 15:53:44 -0400476int nfs4_inode_return_delegation(struct inode *inode)
Trond Myklebust90163022007-07-05 14:55:18 -0400477{
Trond Myklebust90163022007-07-05 14:55:18 -0400478 struct nfs_inode *nfsi = NFS_I(inode);
479 struct nfs_delegation *delegation;
480 int err = 0;
481
Trond Myklebustc57d1bc2012-05-06 19:34:17 -0400482 nfs_wb_all(inode);
Trond Myklebustd25be542013-02-05 11:43:28 -0500483 delegation = nfs_start_delegation_return(nfsi);
484 if (delegation != NULL)
485 err = nfs_end_delegation_return(inode, delegation, 1);
Trond Myklebust90163022007-07-05 14:55:18 -0400486 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487}
488
Trond Myklebustb7571442013-04-03 14:33:49 -0400489static void nfs_mark_return_if_closed_delegation(struct nfs_server *server,
490 struct nfs_delegation *delegation)
491{
492 set_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags);
493 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
494}
495
Trond Myklebusted1e6212011-07-25 15:37:29 -0400496static void nfs_mark_return_delegation(struct nfs_server *server,
497 struct nfs_delegation *delegation)
Trond Myklebust6411bd42008-12-23 15:21:51 -0500498{
499 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
Trond Myklebusted1e6212011-07-25 15:37:29 -0400500 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
Trond Myklebust6411bd42008-12-23 15:21:51 -0500501}
502
Trond Myklebust5c31e232013-04-03 19:04:58 -0400503static bool nfs_server_mark_return_all_delegations(struct nfs_server *server)
504{
505 struct nfs_delegation *delegation;
506 bool ret = false;
507
508 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
509 nfs_mark_return_delegation(server, delegation);
510 ret = true;
511 }
512 return ret;
513}
514
Trond Myklebustb02ba0b2013-04-03 19:23:58 -0400515static void nfs_client_mark_return_all_delegations(struct nfs_client *clp)
516{
517 struct nfs_server *server;
518
519 rcu_read_lock();
520 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
521 nfs_server_mark_return_all_delegations(server);
522 rcu_read_unlock();
523}
524
525static void nfs_delegation_run_state_manager(struct nfs_client *clp)
526{
527 if (test_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state))
528 nfs4_schedule_state_manager(clp);
529}
530
531/**
532 * nfs_expire_all_delegations
533 * @clp: client to process
534 *
535 */
536void nfs_expire_all_delegations(struct nfs_client *clp)
537{
538 nfs_client_mark_return_all_delegations(clp);
539 nfs_delegation_run_state_manager(clp);
540}
541
Chuck Leverd3978bb2010-12-24 01:33:04 +0000542/**
543 * nfs_super_return_all_delegations - return delegations for one superblock
544 * @sb: sb to process
545 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 */
Bryan Schumakereeebf912012-06-20 15:53:41 -0400547void nfs_server_return_all_delegations(struct nfs_server *server)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000549 struct nfs_client *clp = server->nfs_client;
Trond Myklebust5c31e232013-04-03 19:04:58 -0400550 bool need_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552 if (clp == NULL)
553 return;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000554
Trond Myklebust8383e462007-07-06 15:12:04 -0400555 rcu_read_lock();
Trond Myklebust5c31e232013-04-03 19:04:58 -0400556 need_wait = nfs_server_mark_return_all_delegations(server);
Trond Myklebust8383e462007-07-06 15:12:04 -0400557 rcu_read_unlock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000558
Trond Myklebust5c31e232013-04-03 19:04:58 -0400559 if (need_wait) {
Trond Myklebustd18cc1f2009-12-03 08:10:17 -0500560 nfs4_schedule_state_manager(clp);
Trond Myklebust5c31e232013-04-03 19:04:58 -0400561 nfs4_wait_clnt_recover(clp);
562 }
Trond Myklebust515d8612008-12-23 15:21:46 -0500563}
564
Trond Myklebust826e0012013-04-03 19:27:52 -0400565static void nfs_mark_return_unused_delegation_types(struct nfs_server *server,
Chuck Leverd3978bb2010-12-24 01:33:04 +0000566 fmode_t flags)
Trond Myklebust515d8612008-12-23 15:21:46 -0500567{
568 struct nfs_delegation *delegation;
569
Chuck Leverd3978bb2010-12-24 01:33:04 +0000570 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
Alexandros Batsakisc79571a2009-12-05 13:20:52 -0500571 if ((delegation->type == (FMODE_READ|FMODE_WRITE)) && !(flags & FMODE_WRITE))
572 continue;
573 if (delegation->type & flags)
Trond Myklebust826e0012013-04-03 19:27:52 -0400574 nfs_mark_return_if_closed_delegation(server, delegation);
Trond Myklebust707fb4b2008-12-23 15:21:47 -0500575 }
Chuck Leverd3978bb2010-12-24 01:33:04 +0000576}
577
Trond Myklebust826e0012013-04-03 19:27:52 -0400578static void nfs_client_mark_return_unused_delegation_types(struct nfs_client *clp,
Chuck Leverd3978bb2010-12-24 01:33:04 +0000579 fmode_t flags)
580{
581 struct nfs_server *server;
582
583 rcu_read_lock();
584 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
Trond Myklebust826e0012013-04-03 19:27:52 -0400585 nfs_mark_return_unused_delegation_types(server, flags);
Trond Myklebust515d8612008-12-23 15:21:46 -0500586 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
588
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500589void nfs_remove_bad_delegation(struct inode *inode)
590{
591 struct nfs_delegation *delegation;
592
Trond Myklebustd25be542013-02-05 11:43:28 -0500593 delegation = nfs_inode_detach_delegation(inode);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500594 if (delegation) {
595 nfs_inode_find_state_and_recover(inode, &delegation->stateid);
596 nfs_free_delegation(delegation);
597 }
598}
Andy Adamson9cb81962012-03-07 10:49:41 -0500599EXPORT_SYMBOL_GPL(nfs_remove_bad_delegation);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500600
Chuck Leverd3978bb2010-12-24 01:33:04 +0000601/**
Trond Myklebust826e0012013-04-03 19:27:52 -0400602 * nfs_expire_unused_delegation_types
Chuck Leverd3978bb2010-12-24 01:33:04 +0000603 * @clp: client to process
604 * @flags: delegation types to expire
605 *
606 */
Trond Myklebust826e0012013-04-03 19:27:52 -0400607void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags)
Alexandros Batsakisc79571a2009-12-05 13:20:52 -0500608{
Trond Myklebust826e0012013-04-03 19:27:52 -0400609 nfs_client_mark_return_unused_delegation_types(clp, flags);
Alexandros Batsakisc79571a2009-12-05 13:20:52 -0500610 nfs_delegation_run_state_manager(clp);
611}
612
Chuck Leverd3978bb2010-12-24 01:33:04 +0000613static void nfs_mark_return_unreferenced_delegations(struct nfs_server *server)
Trond Myklebustb7391f42008-12-23 15:21:52 -0500614{
615 struct nfs_delegation *delegation;
616
Chuck Leverd3978bb2010-12-24 01:33:04 +0000617 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
Trond Myklebustb7391f42008-12-23 15:21:52 -0500618 if (test_and_clear_bit(NFS_DELEGATION_REFERENCED, &delegation->flags))
619 continue;
Trond Myklebustb7571442013-04-03 14:33:49 -0400620 nfs_mark_return_if_closed_delegation(server, delegation);
Trond Myklebustb7391f42008-12-23 15:21:52 -0500621 }
Trond Myklebustb7391f42008-12-23 15:21:52 -0500622}
623
Chuck Leverd3978bb2010-12-24 01:33:04 +0000624/**
625 * nfs_expire_unreferenced_delegations - Eliminate unused delegations
626 * @clp: nfs_client to process
627 *
628 */
Trond Myklebustb7391f42008-12-23 15:21:52 -0500629void nfs_expire_unreferenced_delegations(struct nfs_client *clp)
630{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000631 struct nfs_server *server;
632
633 rcu_read_lock();
634 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
635 nfs_mark_return_unreferenced_delegations(server);
636 rcu_read_unlock();
637
Trond Myklebustb7391f42008-12-23 15:21:52 -0500638 nfs_delegation_run_state_manager(clp);
639}
640
Chuck Leverd3978bb2010-12-24 01:33:04 +0000641/**
642 * nfs_async_inode_return_delegation - asynchronously return a delegation
643 * @inode: inode to process
Trond Myklebust8e663f02012-03-04 18:13:56 -0500644 * @stateid: state ID information
Chuck Leverd3978bb2010-12-24 01:33:04 +0000645 *
646 * Returns zero on success, or a negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 */
Chuck Leverd3978bb2010-12-24 01:33:04 +0000648int nfs_async_inode_return_delegation(struct inode *inode,
649 const nfs4_stateid *stateid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Trond Myklebusted1e6212011-07-25 15:37:29 -0400651 struct nfs_server *server = NFS_SERVER(inode);
652 struct nfs_client *clp = server->nfs_client;
Trond Myklebust6411bd42008-12-23 15:21:51 -0500653 struct nfs_delegation *delegation;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Trond Myklebustdc327ed2012-05-06 19:46:30 -0400655 filemap_flush(inode->i_mapping);
656
Trond Myklebust6411bd42008-12-23 15:21:51 -0500657 rcu_read_lock();
658 delegation = rcu_dereference(NFS_I(inode)->delegation);
Alexandros Batsakis25976412009-12-05 13:48:55 -0500659
Trond Myklebust36281ca2012-03-04 18:13:56 -0500660 if (!clp->cl_mvops->match_stateid(&delegation->stateid, stateid)) {
Trond Myklebust6411bd42008-12-23 15:21:51 -0500661 rcu_read_unlock();
662 return -ENOENT;
663 }
Trond Myklebusted1e6212011-07-25 15:37:29 -0400664 nfs_mark_return_delegation(server, delegation);
Trond Myklebust6411bd42008-12-23 15:21:51 -0500665 rcu_read_unlock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000666
Trond Myklebust6411bd42008-12-23 15:21:51 -0500667 nfs_delegation_run_state_manager(clp);
668 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669}
670
Chuck Leverd3978bb2010-12-24 01:33:04 +0000671static struct inode *
672nfs_delegation_find_inode_server(struct nfs_server *server,
673 const struct nfs_fh *fhandle)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
675 struct nfs_delegation *delegation;
676 struct inode *res = NULL;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000677
678 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
Trond Myklebust86e89482008-12-23 15:21:39 -0500679 spin_lock(&delegation->lock);
680 if (delegation->inode != NULL &&
681 nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 res = igrab(delegation->inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 }
Trond Myklebust86e89482008-12-23 15:21:39 -0500684 spin_unlock(&delegation->lock);
685 if (res != NULL)
686 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 }
Chuck Leverd3978bb2010-12-24 01:33:04 +0000688 return res;
689}
690
691/**
692 * nfs_delegation_find_inode - retrieve the inode associated with a delegation
693 * @clp: client state handle
694 * @fhandle: filehandle from a delegation recall
695 *
696 * Returns pointer to inode matching "fhandle," or NULL if a matching inode
697 * cannot be found.
698 */
699struct inode *nfs_delegation_find_inode(struct nfs_client *clp,
700 const struct nfs_fh *fhandle)
701{
702 struct nfs_server *server;
703 struct inode *res = NULL;
704
705 rcu_read_lock();
706 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
707 res = nfs_delegation_find_inode_server(server, fhandle);
708 if (res != NULL)
709 break;
710 }
Trond Myklebust8383e462007-07-06 15:12:04 -0400711 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 return res;
713}
714
Chuck Leverd3978bb2010-12-24 01:33:04 +0000715static void nfs_delegation_mark_reclaim_server(struct nfs_server *server)
716{
717 struct nfs_delegation *delegation;
718
719 list_for_each_entry_rcu(delegation, &server->delegations, super_list)
720 set_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
721}
722
723/**
724 * nfs_delegation_mark_reclaim - mark all delegations as needing to be reclaimed
725 * @clp: nfs_client to process
726 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 */
David Howellsadfa6f92006-08-22 20:06:08 -0400728void nfs_delegation_mark_reclaim(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
Chuck Leverd3978bb2010-12-24 01:33:04 +0000730 struct nfs_server *server;
731
Trond Myklebust8383e462007-07-06 15:12:04 -0400732 rcu_read_lock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000733 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
734 nfs_delegation_mark_reclaim_server(server);
Trond Myklebust8383e462007-07-06 15:12:04 -0400735 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
737
Chuck Leverd3978bb2010-12-24 01:33:04 +0000738/**
739 * nfs_delegation_reap_unclaimed - reap unclaimed delegations after reboot recovery is done
740 * @clp: nfs_client to process
741 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 */
David Howellsadfa6f92006-08-22 20:06:08 -0400743void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
Trond Myklebust8383e462007-07-06 15:12:04 -0400745 struct nfs_delegation *delegation;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000746 struct nfs_server *server;
Trond Myklebust86e89482008-12-23 15:21:39 -0500747 struct inode *inode;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000748
Trond Myklebust8383e462007-07-06 15:12:04 -0400749restart:
750 rcu_read_lock();
Chuck Leverd3978bb2010-12-24 01:33:04 +0000751 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
752 list_for_each_entry_rcu(delegation, &server->delegations,
753 super_list) {
754 if (test_bit(NFS_DELEGATION_NEED_RECLAIM,
755 &delegation->flags) == 0)
756 continue;
757 inode = nfs_delegation_grab_inode(delegation);
758 if (inode == NULL)
759 continue;
760 delegation = nfs_detach_delegation(NFS_I(inode),
Trond Myklebustd25be542013-02-05 11:43:28 -0500761 delegation, server);
Chuck Leverd3978bb2010-12-24 01:33:04 +0000762 rcu_read_unlock();
763
764 if (delegation != NULL)
765 nfs_free_delegation(delegation);
766 iput(inode);
767 goto restart;
768 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 }
Trond Myklebust8383e462007-07-06 15:12:04 -0400770 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771}
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500772
Chuck Leverd3978bb2010-12-24 01:33:04 +0000773/**
774 * nfs_delegations_present - check for existence of delegations
775 * @clp: client state handle
776 *
777 * Returns one if there are any nfs_delegation structures attached
778 * to this nfs_client.
779 */
780int nfs_delegations_present(struct nfs_client *clp)
781{
782 struct nfs_server *server;
783 int ret = 0;
784
785 rcu_read_lock();
786 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
787 if (!list_empty(&server->delegations)) {
788 ret = 1;
789 break;
790 }
791 rcu_read_unlock();
792 return ret;
793}
794
795/**
796 * nfs4_copy_delegation_stateid - Copy inode's state ID information
797 * @dst: stateid data structure to fill in
798 * @inode: inode to check
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500799 * @flags: delegation type requirement
Chuck Leverd3978bb2010-12-24 01:33:04 +0000800 *
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500801 * Returns "true" and fills in "dst->data" * if inode had a delegation,
802 * otherwise "false" is returned.
Chuck Leverd3978bb2010-12-24 01:33:04 +0000803 */
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500804bool nfs4_copy_delegation_stateid(nfs4_stateid *dst, struct inode *inode,
805 fmode_t flags)
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500806{
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500807 struct nfs_inode *nfsi = NFS_I(inode);
808 struct nfs_delegation *delegation;
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500809 bool ret;
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500810
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500811 flags &= FMODE_READ|FMODE_WRITE;
Trond Myklebust8383e462007-07-06 15:12:04 -0400812 rcu_read_lock();
813 delegation = rcu_dereference(nfsi->delegation);
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500814 ret = (delegation != NULL && (delegation->type & flags) == flags);
815 if (ret) {
Trond Myklebustf597c532012-03-04 18:13:56 -0500816 nfs4_stateid_copy(dst, &delegation->stateid);
Trond Myklebust0032a7a2012-03-08 17:16:12 -0500817 nfs_mark_delegation_referenced(delegation);
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500818 }
Trond Myklebust8383e462007-07-06 15:12:04 -0400819 rcu_read_unlock();
820 return ret;
Trond Myklebust3e4f6292006-03-20 13:44:46 -0500821}