1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/fs/nfs/delegation.c
5 * Copyright (C) 2004 Trond Myklebust
7 * NFS file delegation management
10 #include <linux/completion.h>
11 #include <linux/kthread.h>
12 #include <linux/module.h>
13 #include <linux/sched.h>
14 #include <linux/slab.h>
15 #include <linux/spinlock.h>
16 #include <linux/iversion.h>
18 #include <linux/nfs4.h>
19 #include <linux/nfs_fs.h>
20 #include <linux/nfs_xdr.h>
23 #include "nfs4session.h"
24 #include "delegation.h"
26 #include "nfs4trace.h"
28 #define NFS_DEFAULT_DELEGATION_WATERMARK (5000U)
30 static atomic_long_t nfs_active_delegations;
31 static unsigned nfs_delegation_watermark = NFS_DEFAULT_DELEGATION_WATERMARK;
33 static void __nfs_free_delegation(struct nfs_delegation *delegation)
35 put_cred(delegation->cred);
36 delegation->cred = NULL;
37 kfree_rcu(delegation, rcu);
40 static void nfs_mark_delegation_revoked(struct nfs_delegation *delegation)
42 if (!test_and_set_bit(NFS_DELEGATION_REVOKED, &delegation->flags)) {
43 delegation->stateid.type = NFS4_INVALID_STATEID_TYPE;
44 atomic_long_dec(&nfs_active_delegations);
45 if (!test_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
46 nfs_clear_verifier_delegated(delegation->inode);
50 static struct nfs_delegation *nfs_get_delegation(struct nfs_delegation *delegation)
52 refcount_inc(&delegation->refcount);
56 static void nfs_put_delegation(struct nfs_delegation *delegation)
58 if (refcount_dec_and_test(&delegation->refcount))
59 __nfs_free_delegation(delegation);
62 static void nfs_free_delegation(struct nfs_delegation *delegation)
64 nfs_mark_delegation_revoked(delegation);
65 nfs_put_delegation(delegation);
69 * nfs_mark_delegation_referenced - set delegation's REFERENCED flag
70 * @delegation: delegation to process
73 void nfs_mark_delegation_referenced(struct nfs_delegation *delegation)
75 set_bit(NFS_DELEGATION_REFERENCED, &delegation->flags);
78 static void nfs_mark_return_delegation(struct nfs_server *server,
79 struct nfs_delegation *delegation)
81 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
82 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
86 nfs4_is_valid_delegation(const struct nfs_delegation *delegation,
89 if (delegation != NULL && (delegation->type & flags) == flags &&
90 !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags) &&
91 !test_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
96 struct nfs_delegation *nfs4_get_valid_delegation(const struct inode *inode)
98 struct nfs_delegation *delegation;
100 delegation = rcu_dereference(NFS_I(inode)->delegation);
101 if (nfs4_is_valid_delegation(delegation, 0))
107 nfs4_do_check_delegation(struct inode *inode, fmode_t flags, bool mark)
109 struct nfs_delegation *delegation;
112 flags &= FMODE_READ|FMODE_WRITE;
114 delegation = rcu_dereference(NFS_I(inode)->delegation);
115 if (nfs4_is_valid_delegation(delegation, flags)) {
117 nfs_mark_delegation_referenced(delegation);
124 * nfs_have_delegation - check if inode has a delegation, mark it
125 * NFS_DELEGATION_REFERENCED if there is one.
126 * @inode: inode to check
127 * @flags: delegation types to check for
129 * Returns one if inode has the indicated delegation, otherwise zero.
131 int nfs4_have_delegation(struct inode *inode, fmode_t flags)
133 return nfs4_do_check_delegation(inode, flags, true);
137 * nfs4_check_delegation - check if inode has a delegation, do not mark
138 * NFS_DELEGATION_REFERENCED if it has one.
140 int nfs4_check_delegation(struct inode *inode, fmode_t flags)
142 return nfs4_do_check_delegation(inode, flags, false);
145 static int nfs_delegation_claim_locks(struct nfs4_state *state, const nfs4_stateid *stateid)
147 struct inode *inode = state->inode;
148 struct file_lock *fl;
149 struct file_lock_context *flctx = inode->i_flctx;
150 struct list_head *list;
156 list = &flctx->flc_posix;
157 spin_lock(&flctx->flc_lock);
159 list_for_each_entry(fl, list, fl_list) {
160 if (nfs_file_open_context(fl->fl_file)->state != state)
162 spin_unlock(&flctx->flc_lock);
163 status = nfs4_lock_delegation_recall(fl, state, stateid);
166 spin_lock(&flctx->flc_lock);
168 if (list == &flctx->flc_posix) {
169 list = &flctx->flc_flock;
172 spin_unlock(&flctx->flc_lock);
177 static int nfs_delegation_claim_opens(struct inode *inode,
178 const nfs4_stateid *stateid, fmode_t type)
180 struct nfs_inode *nfsi = NFS_I(inode);
181 struct nfs_open_context *ctx;
182 struct nfs4_state_owner *sp;
183 struct nfs4_state *state;
189 list_for_each_entry_rcu(ctx, &nfsi->open_files, list) {
193 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
195 if (!nfs4_valid_open_stateid(state))
197 if (!nfs4_stateid_match(&state->stateid, stateid))
199 if (!get_nfs_open_context(ctx))
203 /* Block nfs4_proc_unlck */
204 mutex_lock(&sp->so_delegreturn_mutex);
205 seq = raw_seqcount_begin(&sp->so_reclaim_seqcount);
206 err = nfs4_open_delegation_recall(ctx, state, stateid);
208 err = nfs_delegation_claim_locks(state, stateid);
209 if (!err && read_seqcount_retry(&sp->so_reclaim_seqcount, seq))
211 mutex_unlock(&sp->so_delegreturn_mutex);
212 put_nfs_open_context(ctx);
222 * nfs_inode_reclaim_delegation - process a delegation reclaim request
223 * @inode: inode to process
224 * @cred: credential to use for request
225 * @type: delegation type
226 * @stateid: delegation stateid
227 * @pagemod_limit: write delegation "space_limit"
230 void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
231 fmode_t type, const nfs4_stateid *stateid,
232 unsigned long pagemod_limit)
234 struct nfs_delegation *delegation;
235 const struct cred *oldcred = NULL;
238 delegation = rcu_dereference(NFS_I(inode)->delegation);
239 if (delegation != NULL) {
240 spin_lock(&delegation->lock);
241 nfs4_stateid_copy(&delegation->stateid, stateid);
242 delegation->type = type;
243 delegation->pagemod_limit = pagemod_limit;
244 oldcred = delegation->cred;
245 delegation->cred = get_cred(cred);
246 clear_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
247 if (test_and_clear_bit(NFS_DELEGATION_REVOKED,
249 atomic_long_inc(&nfs_active_delegations);
250 spin_unlock(&delegation->lock);
253 trace_nfs4_reclaim_delegation(inode, type);
256 nfs_inode_set_delegation(inode, cred, type, stateid,
261 static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation, int issync)
263 const struct cred *cred;
266 if (!test_bit(NFS_DELEGATION_REVOKED, &delegation->flags)) {
267 spin_lock(&delegation->lock);
268 cred = get_cred(delegation->cred);
269 spin_unlock(&delegation->lock);
270 res = nfs4_proc_delegreturn(inode, cred,
271 &delegation->stateid,
278 static struct inode *nfs_delegation_grab_inode(struct nfs_delegation *delegation)
280 struct inode *inode = NULL;
282 spin_lock(&delegation->lock);
283 if (delegation->inode != NULL)
284 inode = igrab(delegation->inode);
286 set_bit(NFS_DELEGATION_INODE_FREEING, &delegation->flags);
287 spin_unlock(&delegation->lock);
291 static struct nfs_delegation *
292 nfs_start_delegation_return_locked(struct nfs_inode *nfsi)
294 struct nfs_delegation *ret = NULL;
295 struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
297 if (delegation == NULL)
299 spin_lock(&delegation->lock);
300 if (!test_and_set_bit(NFS_DELEGATION_RETURNING, &delegation->flags)) {
301 clear_bit(NFS_DELEGATION_RETURN_DELAYED, &delegation->flags);
302 /* Refcount matched in nfs_end_delegation_return() */
303 ret = nfs_get_delegation(delegation);
305 spin_unlock(&delegation->lock);
307 nfs_clear_verifier_delegated(&nfsi->vfs_inode);
312 static struct nfs_delegation *
313 nfs_start_delegation_return(struct nfs_inode *nfsi)
315 struct nfs_delegation *delegation;
318 delegation = nfs_start_delegation_return_locked(nfsi);
323 static void nfs_abort_delegation_return(struct nfs_delegation *delegation,
324 struct nfs_client *clp, int err)
327 spin_lock(&delegation->lock);
328 clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
329 if (err == -EAGAIN) {
330 set_bit(NFS_DELEGATION_RETURN_DELAYED, &delegation->flags);
331 set_bit(NFS4CLNT_DELEGRETURN_DELAYED, &clp->cl_state);
333 spin_unlock(&delegation->lock);
336 static struct nfs_delegation *
337 nfs_detach_delegation_locked(struct nfs_inode *nfsi,
338 struct nfs_delegation *delegation,
339 struct nfs_client *clp)
341 struct nfs_delegation *deleg_cur =
342 rcu_dereference_protected(nfsi->delegation,
343 lockdep_is_held(&clp->cl_lock));
345 if (deleg_cur == NULL || delegation != deleg_cur)
348 spin_lock(&delegation->lock);
349 if (!delegation->inode) {
350 spin_unlock(&delegation->lock);
353 list_del_rcu(&delegation->super_list);
354 delegation->inode = NULL;
355 rcu_assign_pointer(nfsi->delegation, NULL);
356 spin_unlock(&delegation->lock);
360 static struct nfs_delegation *nfs_detach_delegation(struct nfs_inode *nfsi,
361 struct nfs_delegation *delegation,
362 struct nfs_server *server)
364 struct nfs_client *clp = server->nfs_client;
366 spin_lock(&clp->cl_lock);
367 delegation = nfs_detach_delegation_locked(nfsi, delegation, clp);
368 spin_unlock(&clp->cl_lock);
372 static struct nfs_delegation *
373 nfs_inode_detach_delegation(struct inode *inode)
375 struct nfs_inode *nfsi = NFS_I(inode);
376 struct nfs_server *server = NFS_SERVER(inode);
377 struct nfs_delegation *delegation;
380 delegation = rcu_dereference(nfsi->delegation);
381 if (delegation != NULL)
382 delegation = nfs_detach_delegation(nfsi, delegation, server);
388 nfs_update_delegation_cred(struct nfs_delegation *delegation,
389 const struct cred *cred)
391 const struct cred *old;
393 if (cred_fscmp(delegation->cred, cred) != 0) {
394 old = xchg(&delegation->cred, get_cred(cred));
400 nfs_update_inplace_delegation(struct nfs_delegation *delegation,
401 const struct nfs_delegation *update)
403 if (nfs4_stateid_is_newer(&update->stateid, &delegation->stateid)) {
404 delegation->stateid.seqid = update->stateid.seqid;
406 delegation->type = update->type;
407 delegation->pagemod_limit = update->pagemod_limit;
408 if (test_bit(NFS_DELEGATION_REVOKED, &delegation->flags)) {
409 delegation->change_attr = update->change_attr;
410 nfs_update_delegation_cred(delegation, update->cred);
411 /* smp_mb__before_atomic() is implicit due to xchg() */
412 clear_bit(NFS_DELEGATION_REVOKED, &delegation->flags);
413 atomic_long_inc(&nfs_active_delegations);
419 * nfs_inode_set_delegation - set up a delegation on an inode
420 * @inode: inode to which delegation applies
421 * @cred: cred to use for subsequent delegation processing
422 * @type: delegation type
423 * @stateid: delegation stateid
424 * @pagemod_limit: write delegation "space_limit"
426 * Returns zero on success, or a negative errno value.
428 int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
430 const nfs4_stateid *stateid,
431 unsigned long pagemod_limit)
433 struct nfs_server *server = NFS_SERVER(inode);
434 struct nfs_client *clp = server->nfs_client;
435 struct nfs_inode *nfsi = NFS_I(inode);
436 struct nfs_delegation *delegation, *old_delegation;
437 struct nfs_delegation *freeme = NULL;
440 delegation = kmalloc(sizeof(*delegation), GFP_NOFS);
441 if (delegation == NULL)
443 nfs4_stateid_copy(&delegation->stateid, stateid);
444 refcount_set(&delegation->refcount, 1);
445 delegation->type = type;
446 delegation->pagemod_limit = pagemod_limit;
447 delegation->change_attr = inode_peek_iversion_raw(inode);
448 delegation->cred = get_cred(cred);
449 delegation->inode = inode;
450 delegation->flags = 1<<NFS_DELEGATION_REFERENCED;
451 spin_lock_init(&delegation->lock);
453 spin_lock(&clp->cl_lock);
454 old_delegation = rcu_dereference_protected(nfsi->delegation,
455 lockdep_is_held(&clp->cl_lock));
456 if (old_delegation == NULL)
458 /* Is this an update of the existing delegation? */
459 if (nfs4_stateid_match_other(&old_delegation->stateid,
460 &delegation->stateid)) {
461 spin_lock(&old_delegation->lock);
462 nfs_update_inplace_delegation(old_delegation,
464 spin_unlock(&old_delegation->lock);
467 if (!test_bit(NFS_DELEGATION_REVOKED, &old_delegation->flags)) {
469 * Deal with broken servers that hand out two
470 * delegations for the same file.
471 * Allow for upgrades to a WRITE delegation, but
474 dfprintk(FILE, "%s: server %s handed out "
475 "a duplicate delegation!\n",
476 __func__, clp->cl_hostname);
477 if (delegation->type == old_delegation->type ||
478 !(delegation->type & FMODE_WRITE)) {
483 if (test_and_set_bit(NFS_DELEGATION_RETURNING,
484 &old_delegation->flags))
487 freeme = nfs_detach_delegation_locked(nfsi, old_delegation, clp);
491 list_add_tail_rcu(&delegation->super_list, &server->delegations);
492 rcu_assign_pointer(nfsi->delegation, delegation);
495 atomic_long_inc(&nfs_active_delegations);
497 trace_nfs4_set_delegation(inode, type);
499 spin_lock(&inode->i_lock);
500 if (NFS_I(inode)->cache_validity & (NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ATIME))
501 NFS_I(inode)->cache_validity |= NFS_INO_REVAL_FORCED;
502 spin_unlock(&inode->i_lock);
504 spin_unlock(&clp->cl_lock);
505 if (delegation != NULL)
506 __nfs_free_delegation(delegation);
507 if (freeme != NULL) {
508 nfs_do_return_delegation(inode, freeme, 0);
509 nfs_free_delegation(freeme);
515 * Basic procedure for returning a delegation to the server
517 static int nfs_end_delegation_return(struct inode *inode, struct nfs_delegation *delegation, int issync)
519 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
522 if (delegation == NULL)
525 if (test_bit(NFS_DELEGATION_REVOKED, &delegation->flags))
527 err = nfs_delegation_claim_opens(inode, &delegation->stateid,
529 if (!issync || err != -EAGAIN)
532 * Guard against state recovery
534 err = nfs4_wait_clnt_recover(clp);
538 nfs_abort_delegation_return(delegation, clp, err);
542 err = nfs_do_return_delegation(inode, delegation, issync);
544 /* Refcount matched in nfs_start_delegation_return_locked() */
545 nfs_put_delegation(delegation);
549 static bool nfs_delegation_need_return(struct nfs_delegation *delegation)
553 if (test_and_clear_bit(NFS_DELEGATION_RETURN, &delegation->flags))
555 else if (test_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags)) {
558 spin_lock(&delegation->lock);
559 inode = delegation->inode;
560 if (inode && list_empty(&NFS_I(inode)->open_files))
562 spin_unlock(&delegation->lock);
565 clear_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags);
566 if (test_bit(NFS_DELEGATION_RETURNING, &delegation->flags) ||
567 test_bit(NFS_DELEGATION_RETURN_DELAYED, &delegation->flags) ||
568 test_bit(NFS_DELEGATION_REVOKED, &delegation->flags))
574 static int nfs_server_return_marked_delegations(struct nfs_server *server,
575 void __always_unused *data)
577 struct nfs_delegation *delegation;
578 struct nfs_delegation *prev;
580 struct inode *place_holder = NULL;
581 struct nfs_delegation *place_holder_deleg = NULL;
586 * To avoid quadratic looping we hold a reference
587 * to an inode place_holder. Each time we restart, we
588 * list delegation in the server from the delegations
590 * prev is an RCU-protected pointer to a delegation which
591 * wasn't marked for return and might be a good choice for
592 * the next place_holder.
598 delegation = rcu_dereference(NFS_I(place_holder)->delegation);
599 if (!delegation || delegation != place_holder_deleg)
600 delegation = list_entry_rcu(server->delegations.next,
601 struct nfs_delegation, super_list);
602 list_for_each_entry_from_rcu(delegation, &server->delegations, super_list) {
603 struct inode *to_put = NULL;
605 if (test_bit(NFS_DELEGATION_INODE_FREEING, &delegation->flags))
607 if (!nfs_delegation_need_return(delegation)) {
608 if (nfs4_is_valid_delegation(delegation, 0))
614 struct inode *tmp = nfs_delegation_grab_inode(prev);
616 to_put = place_holder;
618 place_holder_deleg = prev;
622 inode = nfs_delegation_grab_inode(delegation);
628 delegation = nfs_start_delegation_return_locked(NFS_I(inode));
633 err = nfs_end_delegation_return(inode, delegation, 0);
638 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
647 static bool nfs_server_clear_delayed_delegations(struct nfs_server *server)
649 struct nfs_delegation *d;
652 list_for_each_entry_rcu (d, &server->delegations, super_list) {
653 if (!test_bit(NFS_DELEGATION_RETURN_DELAYED, &d->flags))
655 nfs_mark_return_delegation(server, d);
656 clear_bit(NFS_DELEGATION_RETURN_DELAYED, &d->flags);
662 static bool nfs_client_clear_delayed_delegations(struct nfs_client *clp)
664 struct nfs_server *server;
667 if (!test_and_clear_bit(NFS4CLNT_DELEGRETURN_DELAYED, &clp->cl_state))
670 list_for_each_entry_rcu (server, &clp->cl_superblocks, client_link) {
671 if (nfs_server_clear_delayed_delegations(server))
680 * nfs_client_return_marked_delegations - return previously marked delegations
681 * @clp: nfs_client to process
683 * Note that this function is designed to be called by the state
684 * manager thread. For this reason, it cannot flush the dirty data,
685 * since that could deadlock in case of a state recovery error.
687 * Returns zero on success, or a negative errno value.
689 int nfs_client_return_marked_delegations(struct nfs_client *clp)
691 int err = nfs_client_for_each_server(
692 clp, nfs_server_return_marked_delegations, NULL);
695 /* If a return was delayed, sleep to prevent hard looping */
696 if (nfs_client_clear_delayed_delegations(clp))
702 * nfs_inode_evict_delegation - return delegation, don't reclaim opens
703 * @inode: inode to process
705 * Does not protect against delegation reclaims, therefore really only safe
706 * to be called from nfs4_clear_inode(). Guaranteed to always free
707 * the delegation structure.
709 void nfs_inode_evict_delegation(struct inode *inode)
711 struct nfs_delegation *delegation;
713 delegation = nfs_inode_detach_delegation(inode);
714 if (delegation != NULL) {
715 set_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
716 set_bit(NFS_DELEGATION_INODE_FREEING, &delegation->flags);
717 nfs_do_return_delegation(inode, delegation, 1);
718 nfs_free_delegation(delegation);
723 * nfs_inode_return_delegation - synchronously return a delegation
724 * @inode: inode to process
726 * This routine will always flush any dirty data to disk on the
727 * assumption that if we need to return the delegation, then
728 * we should stop caching.
730 * Returns zero on success, or a negative errno value.
732 int nfs4_inode_return_delegation(struct inode *inode)
734 struct nfs_inode *nfsi = NFS_I(inode);
735 struct nfs_delegation *delegation;
739 delegation = nfs_start_delegation_return(nfsi);
740 if (delegation != NULL)
741 err = nfs_end_delegation_return(inode, delegation, 1);
746 * nfs_inode_return_delegation_on_close - asynchronously return a delegation
747 * @inode: inode to process
749 * This routine is called on file close in order to determine if the
750 * inode delegation needs to be returned immediately.
752 void nfs4_inode_return_delegation_on_close(struct inode *inode)
754 struct nfs_delegation *delegation;
755 struct nfs_delegation *ret = NULL;
760 delegation = nfs4_get_valid_delegation(inode);
763 if (test_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags) ||
764 atomic_long_read(&nfs_active_delegations) >= nfs_delegation_watermark) {
765 spin_lock(&delegation->lock);
766 if (delegation->inode &&
767 list_empty(&NFS_I(inode)->open_files) &&
768 !test_and_set_bit(NFS_DELEGATION_RETURNING, &delegation->flags)) {
769 clear_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags);
770 /* Refcount matched in nfs_end_delegation_return() */
771 ret = nfs_get_delegation(delegation);
773 spin_unlock(&delegation->lock);
775 nfs_clear_verifier_delegated(inode);
779 nfs_end_delegation_return(inode, ret, 0);
783 * nfs4_inode_make_writeable
784 * @inode: pointer to inode
786 * Make the inode writeable by returning the delegation if necessary
788 * Returns zero on success, or a negative errno value.
790 int nfs4_inode_make_writeable(struct inode *inode)
792 struct nfs_delegation *delegation;
795 delegation = nfs4_get_valid_delegation(inode);
796 if (delegation == NULL ||
797 (nfs4_has_session(NFS_SERVER(inode)->nfs_client) &&
798 (delegation->type & FMODE_WRITE))) {
803 return nfs4_inode_return_delegation(inode);
806 static void nfs_mark_return_if_closed_delegation(struct nfs_server *server,
807 struct nfs_delegation *delegation)
809 set_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags);
810 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
813 static bool nfs_server_mark_return_all_delegations(struct nfs_server *server)
815 struct nfs_delegation *delegation;
818 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
819 nfs_mark_return_delegation(server, delegation);
825 static void nfs_client_mark_return_all_delegations(struct nfs_client *clp)
827 struct nfs_server *server;
830 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
831 nfs_server_mark_return_all_delegations(server);
835 static void nfs_delegation_run_state_manager(struct nfs_client *clp)
837 if (test_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state))
838 nfs4_schedule_state_manager(clp);
842 * nfs_expire_all_delegations
843 * @clp: client to process
846 void nfs_expire_all_delegations(struct nfs_client *clp)
848 nfs_client_mark_return_all_delegations(clp);
849 nfs_delegation_run_state_manager(clp);
853 * nfs_super_return_all_delegations - return delegations for one superblock
854 * @server: pointer to nfs_server to process
857 void nfs_server_return_all_delegations(struct nfs_server *server)
859 struct nfs_client *clp = server->nfs_client;
866 need_wait = nfs_server_mark_return_all_delegations(server);
870 nfs4_schedule_state_manager(clp);
871 nfs4_wait_clnt_recover(clp);
875 static void nfs_mark_return_unused_delegation_types(struct nfs_server *server,
878 struct nfs_delegation *delegation;
880 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
881 if ((delegation->type == (FMODE_READ|FMODE_WRITE)) && !(flags & FMODE_WRITE))
883 if (delegation->type & flags)
884 nfs_mark_return_if_closed_delegation(server, delegation);
888 static void nfs_client_mark_return_unused_delegation_types(struct nfs_client *clp,
891 struct nfs_server *server;
894 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
895 nfs_mark_return_unused_delegation_types(server, flags);
899 static void nfs_revoke_delegation(struct inode *inode,
900 const nfs4_stateid *stateid)
902 struct nfs_delegation *delegation;
907 delegation = rcu_dereference(NFS_I(inode)->delegation);
908 if (delegation == NULL)
910 if (stateid == NULL) {
911 nfs4_stateid_copy(&tmp, &delegation->stateid);
914 if (!nfs4_stateid_match_other(stateid, &delegation->stateid))
916 spin_lock(&delegation->lock);
917 if (stateid->seqid) {
918 if (nfs4_stateid_is_newer(&delegation->stateid, stateid)) {
919 spin_unlock(&delegation->lock);
922 delegation->stateid.seqid = stateid->seqid;
924 spin_unlock(&delegation->lock);
926 nfs_mark_delegation_revoked(delegation);
931 nfs_inode_find_state_and_recover(inode, stateid);
934 void nfs_remove_bad_delegation(struct inode *inode,
935 const nfs4_stateid *stateid)
937 nfs_revoke_delegation(inode, stateid);
939 EXPORT_SYMBOL_GPL(nfs_remove_bad_delegation);
941 void nfs_delegation_mark_returned(struct inode *inode,
942 const nfs4_stateid *stateid)
944 struct nfs_delegation *delegation;
950 delegation = rcu_dereference(NFS_I(inode)->delegation);
954 spin_lock(&delegation->lock);
955 if (!nfs4_stateid_match_other(stateid, &delegation->stateid))
956 goto out_spin_unlock;
957 if (stateid->seqid) {
958 /* If delegation->stateid is newer, dont mark as returned */
959 if (nfs4_stateid_is_newer(&delegation->stateid, stateid))
960 goto out_clear_returning;
961 if (delegation->stateid.seqid != stateid->seqid)
962 delegation->stateid.seqid = stateid->seqid;
965 nfs_mark_delegation_revoked(delegation);
968 clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
970 spin_unlock(&delegation->lock);
974 nfs_inode_find_state_and_recover(inode, stateid);
978 * nfs_expire_unused_delegation_types
979 * @clp: client to process
980 * @flags: delegation types to expire
983 void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags)
985 nfs_client_mark_return_unused_delegation_types(clp, flags);
986 nfs_delegation_run_state_manager(clp);
989 static void nfs_mark_return_unreferenced_delegations(struct nfs_server *server)
991 struct nfs_delegation *delegation;
993 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
994 if (test_and_clear_bit(NFS_DELEGATION_REFERENCED, &delegation->flags))
996 nfs_mark_return_if_closed_delegation(server, delegation);
1001 * nfs_expire_unreferenced_delegations - Eliminate unused delegations
1002 * @clp: nfs_client to process
1005 void nfs_expire_unreferenced_delegations(struct nfs_client *clp)
1007 struct nfs_server *server;
1010 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1011 nfs_mark_return_unreferenced_delegations(server);
1014 nfs_delegation_run_state_manager(clp);
1018 * nfs_async_inode_return_delegation - asynchronously return a delegation
1019 * @inode: inode to process
1020 * @stateid: state ID information
1022 * Returns zero on success, or a negative errno value.
1024 int nfs_async_inode_return_delegation(struct inode *inode,
1025 const nfs4_stateid *stateid)
1027 struct nfs_server *server = NFS_SERVER(inode);
1028 struct nfs_client *clp = server->nfs_client;
1029 struct nfs_delegation *delegation;
1032 delegation = nfs4_get_valid_delegation(inode);
1033 if (delegation == NULL)
1035 if (stateid != NULL &&
1036 !clp->cl_mvops->match_stateid(&delegation->stateid, stateid))
1038 nfs_mark_return_delegation(server, delegation);
1041 nfs_delegation_run_state_manager(clp);
1048 static struct inode *
1049 nfs_delegation_find_inode_server(struct nfs_server *server,
1050 const struct nfs_fh *fhandle)
1052 struct nfs_delegation *delegation;
1053 struct super_block *freeme = NULL;
1054 struct inode *res = NULL;
1056 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
1057 spin_lock(&delegation->lock);
1058 if (delegation->inode != NULL &&
1059 !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags) &&
1060 nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
1061 if (nfs_sb_active(server->super)) {
1062 freeme = server->super;
1063 res = igrab(delegation->inode);
1065 spin_unlock(&delegation->lock);
1070 nfs_sb_deactive(freeme);
1073 return ERR_PTR(-EAGAIN);
1075 spin_unlock(&delegation->lock);
1077 return ERR_PTR(-ENOENT);
1081 * nfs_delegation_find_inode - retrieve the inode associated with a delegation
1082 * @clp: client state handle
1083 * @fhandle: filehandle from a delegation recall
1085 * Returns pointer to inode matching "fhandle," or NULL if a matching inode
1088 struct inode *nfs_delegation_find_inode(struct nfs_client *clp,
1089 const struct nfs_fh *fhandle)
1091 struct nfs_server *server;
1095 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1096 res = nfs_delegation_find_inode_server(server, fhandle);
1097 if (res != ERR_PTR(-ENOENT)) {
1103 return ERR_PTR(-ENOENT);
1106 static void nfs_delegation_mark_reclaim_server(struct nfs_server *server)
1108 struct nfs_delegation *delegation;
1110 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
1112 * If the delegation may have been admin revoked, then we
1113 * cannot reclaim it.
1115 if (test_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags))
1117 set_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
1122 * nfs_delegation_mark_reclaim - mark all delegations as needing to be reclaimed
1123 * @clp: nfs_client to process
1126 void nfs_delegation_mark_reclaim(struct nfs_client *clp)
1128 struct nfs_server *server;
1131 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1132 nfs_delegation_mark_reclaim_server(server);
1136 static int nfs_server_reap_unclaimed_delegations(struct nfs_server *server,
1137 void __always_unused *data)
1139 struct nfs_delegation *delegation;
1140 struct inode *inode;
1144 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
1145 if (test_bit(NFS_DELEGATION_INODE_FREEING,
1146 &delegation->flags) ||
1147 test_bit(NFS_DELEGATION_RETURNING,
1148 &delegation->flags) ||
1149 test_bit(NFS_DELEGATION_NEED_RECLAIM,
1150 &delegation->flags) == 0)
1152 inode = nfs_delegation_grab_inode(delegation);
1154 goto restart_locked;
1155 delegation = nfs_start_delegation_return_locked(NFS_I(inode));
1157 if (delegation != NULL) {
1158 if (nfs_detach_delegation(NFS_I(inode), delegation,
1160 nfs_free_delegation(delegation);
1161 /* Match nfs_start_delegation_return_locked */
1162 nfs_put_delegation(delegation);
1173 * nfs_delegation_reap_unclaimed - reap unclaimed delegations after reboot recovery is done
1174 * @clp: nfs_client to process
1177 void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
1179 nfs_client_for_each_server(clp, nfs_server_reap_unclaimed_delegations,
1183 static inline bool nfs4_server_rebooted(const struct nfs_client *clp)
1185 return (clp->cl_state & (BIT(NFS4CLNT_CHECK_LEASE) |
1186 BIT(NFS4CLNT_LEASE_EXPIRED) |
1187 BIT(NFS4CLNT_SESSION_RESET))) != 0;
1190 static void nfs_mark_test_expired_delegation(struct nfs_server *server,
1191 struct nfs_delegation *delegation)
1193 if (delegation->stateid.type == NFS4_INVALID_STATEID_TYPE)
1195 clear_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
1196 set_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags);
1197 set_bit(NFS4CLNT_DELEGATION_EXPIRED, &server->nfs_client->cl_state);
1200 static void nfs_inode_mark_test_expired_delegation(struct nfs_server *server,
1201 struct inode *inode)
1203 struct nfs_delegation *delegation;
1206 delegation = rcu_dereference(NFS_I(inode)->delegation);
1208 nfs_mark_test_expired_delegation(server, delegation);
1213 static void nfs_delegation_mark_test_expired_server(struct nfs_server *server)
1215 struct nfs_delegation *delegation;
1217 list_for_each_entry_rcu(delegation, &server->delegations, super_list)
1218 nfs_mark_test_expired_delegation(server, delegation);
1222 * nfs_mark_test_expired_all_delegations - mark all delegations for testing
1223 * @clp: nfs_client to process
1225 * Iterates through all the delegations associated with this server and
1226 * marks them as needing to be checked for validity.
1228 void nfs_mark_test_expired_all_delegations(struct nfs_client *clp)
1230 struct nfs_server *server;
1233 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1234 nfs_delegation_mark_test_expired_server(server);
1239 * nfs_test_expired_all_delegations - test all delegations for a client
1240 * @clp: nfs_client to process
1242 * Helper for handling "recallable state revoked" status from server.
1244 void nfs_test_expired_all_delegations(struct nfs_client *clp)
1246 nfs_mark_test_expired_all_delegations(clp);
1247 nfs4_schedule_state_manager(clp);
1251 nfs_delegation_test_free_expired(struct inode *inode,
1252 nfs4_stateid *stateid,
1253 const struct cred *cred)
1255 struct nfs_server *server = NFS_SERVER(inode);
1256 const struct nfs4_minor_version_ops *ops = server->nfs_client->cl_mvops;
1261 status = ops->test_and_free_expired(server, stateid, cred);
1262 if (status == -NFS4ERR_EXPIRED || status == -NFS4ERR_BAD_STATEID)
1263 nfs_remove_bad_delegation(inode, stateid);
1266 static int nfs_server_reap_expired_delegations(struct nfs_server *server,
1267 void __always_unused *data)
1269 struct nfs_delegation *delegation;
1270 struct inode *inode;
1271 const struct cred *cred;
1272 nfs4_stateid stateid;
1276 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
1277 if (test_bit(NFS_DELEGATION_INODE_FREEING,
1278 &delegation->flags) ||
1279 test_bit(NFS_DELEGATION_RETURNING,
1280 &delegation->flags) ||
1281 test_bit(NFS_DELEGATION_TEST_EXPIRED,
1282 &delegation->flags) == 0)
1284 inode = nfs_delegation_grab_inode(delegation);
1286 goto restart_locked;
1287 spin_lock(&delegation->lock);
1288 cred = get_cred_rcu(delegation->cred);
1289 nfs4_stateid_copy(&stateid, &delegation->stateid);
1290 spin_unlock(&delegation->lock);
1291 clear_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags);
1293 nfs_delegation_test_free_expired(inode, &stateid, cred);
1295 if (!nfs4_server_rebooted(server->nfs_client)) {
1300 nfs_inode_mark_test_expired_delegation(server,inode);
1309 * nfs_reap_expired_delegations - reap expired delegations
1310 * @clp: nfs_client to process
1312 * Iterates through all the delegations associated with this server and
1313 * checks if they have may have been revoked. This function is usually
1314 * expected to be called in cases where the server may have lost its
1317 void nfs_reap_expired_delegations(struct nfs_client *clp)
1319 nfs_client_for_each_server(clp, nfs_server_reap_expired_delegations,
1323 void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
1324 const nfs4_stateid *stateid)
1326 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1327 struct nfs_delegation *delegation;
1331 delegation = rcu_dereference(NFS_I(inode)->delegation);
1333 nfs4_stateid_match_or_older(&delegation->stateid, stateid) &&
1334 !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags)) {
1335 nfs_mark_test_expired_delegation(NFS_SERVER(inode), delegation);
1340 nfs4_schedule_state_manager(clp);
1344 * nfs_delegations_present - check for existence of delegations
1345 * @clp: client state handle
1347 * Returns one if there are any nfs_delegation structures attached
1348 * to this nfs_client.
1350 int nfs_delegations_present(struct nfs_client *clp)
1352 struct nfs_server *server;
1356 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1357 if (!list_empty(&server->delegations)) {
1366 * nfs4_refresh_delegation_stateid - Update delegation stateid seqid
1367 * @dst: stateid to refresh
1368 * @inode: inode to check
1370 * Returns "true" and updates "dst->seqid" * if inode had a delegation
1371 * that matches our delegation stateid. Otherwise "false" is returned.
1373 bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode)
1375 struct nfs_delegation *delegation;
1381 delegation = rcu_dereference(NFS_I(inode)->delegation);
1382 if (delegation != NULL &&
1383 nfs4_stateid_match_other(dst, &delegation->stateid) &&
1384 nfs4_stateid_is_newer(&delegation->stateid, dst) &&
1385 !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags)) {
1386 dst->seqid = delegation->stateid.seqid;
1395 * nfs4_copy_delegation_stateid - Copy inode's state ID information
1396 * @inode: inode to check
1397 * @flags: delegation type requirement
1398 * @dst: stateid data structure to fill in
1399 * @cred: optional argument to retrieve credential
1401 * Returns "true" and fills in "dst->data" * if inode had a delegation,
1402 * otherwise "false" is returned.
1404 bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags,
1405 nfs4_stateid *dst, const struct cred **cred)
1407 struct nfs_inode *nfsi = NFS_I(inode);
1408 struct nfs_delegation *delegation;
1411 flags &= FMODE_READ|FMODE_WRITE;
1413 delegation = rcu_dereference(nfsi->delegation);
1416 spin_lock(&delegation->lock);
1417 ret = nfs4_is_valid_delegation(delegation, flags);
1419 nfs4_stateid_copy(dst, &delegation->stateid);
1420 nfs_mark_delegation_referenced(delegation);
1422 *cred = get_cred(delegation->cred);
1424 spin_unlock(&delegation->lock);
1431 * nfs4_delegation_flush_on_close - Check if we must flush file on close
1432 * @inode: inode to check
1434 * This function checks the number of outstanding writes to the file
1435 * against the delegation 'space_limit' field to see if
1436 * the spec requires us to flush the file on close.
1438 bool nfs4_delegation_flush_on_close(const struct inode *inode)
1440 struct nfs_inode *nfsi = NFS_I(inode);
1441 struct nfs_delegation *delegation;
1445 delegation = rcu_dereference(nfsi->delegation);
1446 if (delegation == NULL || !(delegation->type & FMODE_WRITE))
1448 if (atomic_long_read(&nfsi->nrequests) < delegation->pagemod_limit)
1455 module_param_named(delegation_watermark, nfs_delegation_watermark, uint, 0644);