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 static void nfs_free_delegation(struct nfs_delegation *delegation)
30 put_cred(delegation->cred);
31 delegation->cred = NULL;
32 kfree_rcu(delegation, rcu);
36 * nfs_mark_delegation_referenced - set delegation's REFERENCED flag
37 * @delegation: delegation to process
40 void nfs_mark_delegation_referenced(struct nfs_delegation *delegation)
42 set_bit(NFS_DELEGATION_REFERENCED, &delegation->flags);
46 nfs4_is_valid_delegation(const struct nfs_delegation *delegation,
49 if (delegation != NULL && (delegation->type & flags) == flags &&
50 !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags) &&
51 !test_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
56 struct nfs_delegation *nfs4_get_valid_delegation(const struct inode *inode)
58 struct nfs_delegation *delegation;
60 delegation = rcu_dereference(NFS_I(inode)->delegation);
61 if (nfs4_is_valid_delegation(delegation, 0))
67 nfs4_do_check_delegation(struct inode *inode, fmode_t flags, bool mark)
69 struct nfs_delegation *delegation;
72 flags &= FMODE_READ|FMODE_WRITE;
74 delegation = rcu_dereference(NFS_I(inode)->delegation);
75 if (nfs4_is_valid_delegation(delegation, flags)) {
77 nfs_mark_delegation_referenced(delegation);
84 * nfs_have_delegation - check if inode has a delegation, mark it
85 * NFS_DELEGATION_REFERENCED if there is one.
86 * @inode: inode to check
87 * @flags: delegation types to check for
89 * Returns one if inode has the indicated delegation, otherwise zero.
91 int nfs4_have_delegation(struct inode *inode, fmode_t flags)
93 return nfs4_do_check_delegation(inode, flags, true);
97 * nfs4_check_delegation - check if inode has a delegation, do not mark
98 * NFS_DELEGATION_REFERENCED if it has one.
100 int nfs4_check_delegation(struct inode *inode, fmode_t flags)
102 return nfs4_do_check_delegation(inode, flags, false);
105 static int nfs_delegation_claim_locks(struct nfs4_state *state, const nfs4_stateid *stateid)
107 struct inode *inode = state->inode;
108 struct file_lock *fl;
109 struct file_lock_context *flctx = inode->i_flctx;
110 struct list_head *list;
116 list = &flctx->flc_posix;
117 spin_lock(&flctx->flc_lock);
119 list_for_each_entry(fl, list, fl_list) {
120 if (nfs_file_open_context(fl->fl_file)->state != state)
122 spin_unlock(&flctx->flc_lock);
123 status = nfs4_lock_delegation_recall(fl, state, stateid);
126 spin_lock(&flctx->flc_lock);
128 if (list == &flctx->flc_posix) {
129 list = &flctx->flc_flock;
132 spin_unlock(&flctx->flc_lock);
137 static int nfs_delegation_claim_opens(struct inode *inode,
138 const nfs4_stateid *stateid, fmode_t type)
140 struct nfs_inode *nfsi = NFS_I(inode);
141 struct nfs_open_context *ctx;
142 struct nfs4_state_owner *sp;
143 struct nfs4_state *state;
149 list_for_each_entry_rcu(ctx, &nfsi->open_files, list) {
153 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
155 if (!nfs4_valid_open_stateid(state))
157 if (!nfs4_stateid_match(&state->stateid, stateid))
159 if (!get_nfs_open_context(ctx))
163 /* Block nfs4_proc_unlck */
164 mutex_lock(&sp->so_delegreturn_mutex);
165 seq = raw_seqcount_begin(&sp->so_reclaim_seqcount);
166 err = nfs4_open_delegation_recall(ctx, state, stateid);
168 err = nfs_delegation_claim_locks(state, stateid);
169 if (!err && read_seqcount_retry(&sp->so_reclaim_seqcount, seq))
171 mutex_unlock(&sp->so_delegreturn_mutex);
172 put_nfs_open_context(ctx);
182 * nfs_inode_reclaim_delegation - process a delegation reclaim request
183 * @inode: inode to process
184 * @cred: credential to use for request
185 * @type: delegation type
186 * @stateid: delegation stateid
187 * @pagemod_limit: write delegation "space_limit"
190 void nfs_inode_reclaim_delegation(struct inode *inode, const struct cred *cred,
192 const nfs4_stateid *stateid,
193 unsigned long pagemod_limit)
195 struct nfs_delegation *delegation;
196 const struct cred *oldcred = NULL;
199 delegation = rcu_dereference(NFS_I(inode)->delegation);
200 if (delegation != NULL) {
201 spin_lock(&delegation->lock);
202 if (delegation->inode != NULL) {
203 nfs4_stateid_copy(&delegation->stateid, stateid);
204 delegation->type = type;
205 delegation->pagemod_limit = pagemod_limit;
206 oldcred = delegation->cred;
207 delegation->cred = get_cred(cred);
208 clear_bit(NFS_DELEGATION_NEED_RECLAIM,
210 spin_unlock(&delegation->lock);
213 trace_nfs4_reclaim_delegation(inode, type);
216 /* We appear to have raced with a delegation return. */
217 spin_unlock(&delegation->lock);
220 nfs_inode_set_delegation(inode, cred, type, stateid, pagemod_limit);
223 static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation, int issync)
227 if (!test_bit(NFS_DELEGATION_REVOKED, &delegation->flags))
228 res = nfs4_proc_delegreturn(inode,
230 &delegation->stateid,
232 nfs_free_delegation(delegation);
236 static struct inode *nfs_delegation_grab_inode(struct nfs_delegation *delegation)
238 struct inode *inode = NULL;
240 spin_lock(&delegation->lock);
241 if (delegation->inode != NULL)
242 inode = igrab(delegation->inode);
244 set_bit(NFS_DELEGATION_INODE_FREEING, &delegation->flags);
245 spin_unlock(&delegation->lock);
249 static struct nfs_delegation *
250 nfs_start_delegation_return_locked(struct nfs_inode *nfsi)
252 struct nfs_delegation *ret = NULL;
253 struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
255 if (delegation == NULL)
257 spin_lock(&delegation->lock);
258 if (!test_and_set_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
260 spin_unlock(&delegation->lock);
265 static struct nfs_delegation *
266 nfs_start_delegation_return(struct nfs_inode *nfsi)
268 struct nfs_delegation *delegation;
271 delegation = nfs_start_delegation_return_locked(nfsi);
277 nfs_abort_delegation_return(struct nfs_delegation *delegation,
278 struct nfs_client *clp)
281 spin_lock(&delegation->lock);
282 clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
283 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
284 spin_unlock(&delegation->lock);
285 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
288 static struct nfs_delegation *
289 nfs_detach_delegation_locked(struct nfs_inode *nfsi,
290 struct nfs_delegation *delegation,
291 struct nfs_client *clp)
293 struct nfs_delegation *deleg_cur =
294 rcu_dereference_protected(nfsi->delegation,
295 lockdep_is_held(&clp->cl_lock));
297 if (deleg_cur == NULL || delegation != deleg_cur)
300 spin_lock(&delegation->lock);
301 if (!delegation->inode) {
302 spin_unlock(&delegation->lock);
305 set_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
306 list_del_rcu(&delegation->super_list);
307 delegation->inode = NULL;
308 rcu_assign_pointer(nfsi->delegation, NULL);
309 spin_unlock(&delegation->lock);
313 static struct nfs_delegation *nfs_detach_delegation(struct nfs_inode *nfsi,
314 struct nfs_delegation *delegation,
315 struct nfs_server *server)
317 struct nfs_client *clp = server->nfs_client;
319 spin_lock(&clp->cl_lock);
320 delegation = nfs_detach_delegation_locked(nfsi, delegation, clp);
321 spin_unlock(&clp->cl_lock);
325 static struct nfs_delegation *
326 nfs_inode_detach_delegation(struct inode *inode)
328 struct nfs_inode *nfsi = NFS_I(inode);
329 struct nfs_server *server = NFS_SERVER(inode);
330 struct nfs_delegation *delegation;
332 delegation = nfs_start_delegation_return(nfsi);
333 if (delegation == NULL)
335 return nfs_detach_delegation(nfsi, delegation, server);
339 nfs_update_inplace_delegation(struct nfs_delegation *delegation,
340 const struct nfs_delegation *update)
342 if (nfs4_stateid_is_newer(&update->stateid, &delegation->stateid)) {
343 delegation->stateid.seqid = update->stateid.seqid;
345 delegation->type = update->type;
346 clear_bit(NFS_DELEGATION_REVOKED, &delegation->flags);
351 * nfs_inode_set_delegation - set up a delegation on an inode
352 * @inode: inode to which delegation applies
353 * @cred: cred to use for subsequent delegation processing
354 * @type: delegation type
355 * @stateid: delegation stateid
356 * @pagemod_limit: write delegation "space_limit"
358 * Returns zero on success, or a negative errno value.
360 int nfs_inode_set_delegation(struct inode *inode, const struct cred *cred,
362 const nfs4_stateid *stateid,
363 unsigned long pagemod_limit)
365 struct nfs_server *server = NFS_SERVER(inode);
366 struct nfs_client *clp = server->nfs_client;
367 struct nfs_inode *nfsi = NFS_I(inode);
368 struct nfs_delegation *delegation, *old_delegation;
369 struct nfs_delegation *freeme = NULL;
372 delegation = kmalloc(sizeof(*delegation), GFP_NOFS);
373 if (delegation == NULL)
375 nfs4_stateid_copy(&delegation->stateid, stateid);
376 delegation->type = type;
377 delegation->pagemod_limit = pagemod_limit;
378 delegation->change_attr = inode_peek_iversion_raw(inode);
379 delegation->cred = get_cred(cred);
380 delegation->inode = inode;
381 delegation->flags = 1<<NFS_DELEGATION_REFERENCED;
382 spin_lock_init(&delegation->lock);
384 spin_lock(&clp->cl_lock);
385 old_delegation = rcu_dereference_protected(nfsi->delegation,
386 lockdep_is_held(&clp->cl_lock));
387 if (old_delegation != NULL) {
388 /* Is this an update of the existing delegation? */
389 if (nfs4_stateid_match_other(&old_delegation->stateid,
390 &delegation->stateid)) {
391 spin_lock(&old_delegation->lock);
392 nfs_update_inplace_delegation(old_delegation,
394 spin_unlock(&old_delegation->lock);
398 * Deal with broken servers that hand out two
399 * delegations for the same file.
400 * Allow for upgrades to a WRITE delegation, but
403 dfprintk(FILE, "%s: server %s handed out "
404 "a duplicate delegation!\n",
405 __func__, clp->cl_hostname);
406 if (delegation->type == old_delegation->type ||
407 !(delegation->type & FMODE_WRITE)) {
412 if (test_and_set_bit(NFS_DELEGATION_RETURNING,
413 &old_delegation->flags))
415 freeme = nfs_detach_delegation_locked(nfsi,
416 old_delegation, clp);
420 list_add_tail_rcu(&delegation->super_list, &server->delegations);
421 rcu_assign_pointer(nfsi->delegation, delegation);
424 trace_nfs4_set_delegation(inode, type);
426 spin_lock(&inode->i_lock);
427 if (NFS_I(inode)->cache_validity & (NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ATIME))
428 NFS_I(inode)->cache_validity |= NFS_INO_REVAL_FORCED;
429 spin_unlock(&inode->i_lock);
431 spin_unlock(&clp->cl_lock);
432 if (delegation != NULL)
433 nfs_free_delegation(delegation);
435 nfs_do_return_delegation(inode, freeme, 0);
440 * Basic procedure for returning a delegation to the server
442 static int nfs_end_delegation_return(struct inode *inode, struct nfs_delegation *delegation, int issync)
444 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
445 struct nfs_inode *nfsi = NFS_I(inode);
448 if (delegation == NULL)
451 if (test_bit(NFS_DELEGATION_REVOKED, &delegation->flags))
453 err = nfs_delegation_claim_opens(inode, &delegation->stateid,
455 if (!issync || err != -EAGAIN)
458 * Guard against state recovery
460 err = nfs4_wait_clnt_recover(clp);
464 nfs_abort_delegation_return(delegation, clp);
467 if (!nfs_detach_delegation(nfsi, delegation, NFS_SERVER(inode)))
470 err = nfs_do_return_delegation(inode, delegation, issync);
475 static bool nfs_delegation_need_return(struct nfs_delegation *delegation)
479 if (test_and_clear_bit(NFS_DELEGATION_RETURN, &delegation->flags))
481 if (test_and_clear_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags) && !ret) {
484 spin_lock(&delegation->lock);
485 inode = delegation->inode;
486 if (inode && list_empty(&NFS_I(inode)->open_files))
488 spin_unlock(&delegation->lock);
490 if (test_bit(NFS_DELEGATION_RETURNING, &delegation->flags) ||
491 test_bit(NFS_DELEGATION_REVOKED, &delegation->flags))
498 * nfs_client_return_marked_delegations - return previously marked delegations
499 * @clp: nfs_client to process
501 * Note that this function is designed to be called by the state
502 * manager thread. For this reason, it cannot flush the dirty data,
503 * since that could deadlock in case of a state recovery error.
505 * Returns zero on success, or a negative errno value.
507 int nfs_client_return_marked_delegations(struct nfs_client *clp)
509 struct nfs_delegation *delegation;
510 struct nfs_delegation *prev;
511 struct nfs_server *server;
513 struct inode *place_holder = NULL;
514 struct nfs_delegation *place_holder_deleg = NULL;
519 * To avoid quadratic looping we hold a reference
520 * to an inode place_holder. Each time we restart, we
521 * list nfs_servers from the server of that inode, and
522 * delegation in the server from the delegations of that
524 * prev is an RCU-protected pointer to a delegation which
525 * wasn't marked for return and might be a good choice for
526 * the next place_holder.
531 server = NFS_SERVER(place_holder);
533 server = list_entry_rcu(clp->cl_superblocks.next,
534 struct nfs_server, client_link);
535 list_for_each_entry_from_rcu(server, &clp->cl_superblocks, client_link) {
537 if (place_holder && server == NFS_SERVER(place_holder))
538 delegation = rcu_dereference(NFS_I(place_holder)->delegation);
539 if (!delegation || delegation != place_holder_deleg)
540 delegation = list_entry_rcu(server->delegations.next,
541 struct nfs_delegation, super_list);
542 list_for_each_entry_from_rcu(delegation, &server->delegations, super_list) {
543 struct inode *to_put = NULL;
545 if (!nfs_delegation_need_return(delegation)) {
549 if (!nfs_sb_active(server->super))
550 break; /* continue in outer loop */
555 tmp = nfs_delegation_grab_inode(prev);
557 to_put = place_holder;
559 place_holder_deleg = prev;
563 inode = nfs_delegation_grab_inode(delegation);
568 nfs_sb_deactive(server->super);
571 delegation = nfs_start_delegation_return_locked(NFS_I(inode));
577 err = nfs_end_delegation_return(inode, delegation, 0);
579 nfs_sb_deactive(server->super);
583 set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
596 * nfs_inode_evict_delegation - return delegation, don't reclaim opens
597 * @inode: inode to process
599 * Does not protect against delegation reclaims, therefore really only safe
600 * to be called from nfs4_clear_inode(). Guaranteed to always free
601 * the delegation structure.
603 void nfs_inode_evict_delegation(struct inode *inode)
605 struct nfs_delegation *delegation;
607 delegation = nfs_inode_detach_delegation(inode);
608 if (delegation != NULL) {
609 set_bit(NFS_DELEGATION_INODE_FREEING, &delegation->flags);
610 nfs_do_return_delegation(inode, delegation, 1);
615 * nfs_inode_return_delegation - synchronously return a delegation
616 * @inode: inode to process
618 * This routine will always flush any dirty data to disk on the
619 * assumption that if we need to return the delegation, then
620 * we should stop caching.
622 * Returns zero on success, or a negative errno value.
624 int nfs4_inode_return_delegation(struct inode *inode)
626 struct nfs_inode *nfsi = NFS_I(inode);
627 struct nfs_delegation *delegation;
631 delegation = nfs_start_delegation_return(nfsi);
632 if (delegation != NULL)
633 err = nfs_end_delegation_return(inode, delegation, 1);
638 * nfs4_inode_make_writeable
639 * @inode: pointer to inode
641 * Make the inode writeable by returning the delegation if necessary
643 * Returns zero on success, or a negative errno value.
645 int nfs4_inode_make_writeable(struct inode *inode)
647 if (!nfs4_has_session(NFS_SERVER(inode)->nfs_client) ||
648 !nfs4_check_delegation(inode, FMODE_WRITE))
649 return nfs4_inode_return_delegation(inode);
653 static void nfs_mark_return_if_closed_delegation(struct nfs_server *server,
654 struct nfs_delegation *delegation)
656 set_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags);
657 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
660 static void nfs_mark_return_delegation(struct nfs_server *server,
661 struct nfs_delegation *delegation)
663 set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
664 set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
667 static bool nfs_server_mark_return_all_delegations(struct nfs_server *server)
669 struct nfs_delegation *delegation;
672 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
673 nfs_mark_return_delegation(server, delegation);
679 static void nfs_client_mark_return_all_delegations(struct nfs_client *clp)
681 struct nfs_server *server;
684 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
685 nfs_server_mark_return_all_delegations(server);
689 static void nfs_delegation_run_state_manager(struct nfs_client *clp)
691 if (test_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state))
692 nfs4_schedule_state_manager(clp);
696 * nfs_expire_all_delegations
697 * @clp: client to process
700 void nfs_expire_all_delegations(struct nfs_client *clp)
702 nfs_client_mark_return_all_delegations(clp);
703 nfs_delegation_run_state_manager(clp);
707 * nfs_super_return_all_delegations - return delegations for one superblock
708 * @server: pointer to nfs_server to process
711 void nfs_server_return_all_delegations(struct nfs_server *server)
713 struct nfs_client *clp = server->nfs_client;
720 need_wait = nfs_server_mark_return_all_delegations(server);
724 nfs4_schedule_state_manager(clp);
725 nfs4_wait_clnt_recover(clp);
729 static void nfs_mark_return_unused_delegation_types(struct nfs_server *server,
732 struct nfs_delegation *delegation;
734 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
735 if ((delegation->type == (FMODE_READ|FMODE_WRITE)) && !(flags & FMODE_WRITE))
737 if (delegation->type & flags)
738 nfs_mark_return_if_closed_delegation(server, delegation);
742 static void nfs_client_mark_return_unused_delegation_types(struct nfs_client *clp,
745 struct nfs_server *server;
748 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
749 nfs_mark_return_unused_delegation_types(server, flags);
753 static void nfs_mark_delegation_revoked(struct nfs_server *server,
754 struct nfs_delegation *delegation)
756 set_bit(NFS_DELEGATION_REVOKED, &delegation->flags);
757 delegation->stateid.type = NFS4_INVALID_STATEID_TYPE;
758 nfs_mark_return_delegation(server, delegation);
761 static bool nfs_revoke_delegation(struct inode *inode,
762 const nfs4_stateid *stateid)
764 struct nfs_delegation *delegation;
769 delegation = rcu_dereference(NFS_I(inode)->delegation);
770 if (delegation == NULL)
772 if (stateid == NULL) {
773 nfs4_stateid_copy(&tmp, &delegation->stateid);
776 if (!nfs4_stateid_match_other(stateid, &delegation->stateid))
778 spin_lock(&delegation->lock);
779 if (stateid->seqid) {
780 if (nfs4_stateid_is_newer(&delegation->stateid, stateid)) {
781 spin_unlock(&delegation->lock);
784 delegation->stateid.seqid = stateid->seqid;
786 spin_unlock(&delegation->lock);
788 nfs_mark_delegation_revoked(NFS_SERVER(inode), delegation);
793 nfs_inode_find_state_and_recover(inode, stateid);
797 void nfs_remove_bad_delegation(struct inode *inode,
798 const nfs4_stateid *stateid)
800 struct nfs_delegation *delegation;
802 if (!nfs_revoke_delegation(inode, stateid))
804 delegation = nfs_inode_detach_delegation(inode);
806 nfs_free_delegation(delegation);
808 EXPORT_SYMBOL_GPL(nfs_remove_bad_delegation);
810 void nfs_delegation_mark_returned(struct inode *inode,
811 const nfs4_stateid *stateid)
813 struct nfs_delegation *delegation;
819 delegation = rcu_dereference(NFS_I(inode)->delegation);
823 spin_lock(&delegation->lock);
824 if (!nfs4_stateid_match_other(stateid, &delegation->stateid))
825 goto out_spin_unlock;
826 if (stateid->seqid) {
827 /* If delegation->stateid is newer, dont mark as returned */
828 if (nfs4_stateid_is_newer(&delegation->stateid, stateid))
829 goto out_clear_returning;
830 if (delegation->stateid.seqid != stateid->seqid)
831 delegation->stateid.seqid = stateid->seqid;
834 set_bit(NFS_DELEGATION_REVOKED, &delegation->flags);
837 clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
839 spin_unlock(&delegation->lock);
843 nfs_inode_find_state_and_recover(inode, stateid);
847 * nfs_expire_unused_delegation_types
848 * @clp: client to process
849 * @flags: delegation types to expire
852 void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags)
854 nfs_client_mark_return_unused_delegation_types(clp, flags);
855 nfs_delegation_run_state_manager(clp);
858 static void nfs_mark_return_unreferenced_delegations(struct nfs_server *server)
860 struct nfs_delegation *delegation;
862 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
863 if (test_and_clear_bit(NFS_DELEGATION_REFERENCED, &delegation->flags))
865 nfs_mark_return_if_closed_delegation(server, delegation);
870 * nfs_expire_unreferenced_delegations - Eliminate unused delegations
871 * @clp: nfs_client to process
874 void nfs_expire_unreferenced_delegations(struct nfs_client *clp)
876 struct nfs_server *server;
879 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
880 nfs_mark_return_unreferenced_delegations(server);
883 nfs_delegation_run_state_manager(clp);
887 * nfs_async_inode_return_delegation - asynchronously return a delegation
888 * @inode: inode to process
889 * @stateid: state ID information
891 * Returns zero on success, or a negative errno value.
893 int nfs_async_inode_return_delegation(struct inode *inode,
894 const nfs4_stateid *stateid)
896 struct nfs_server *server = NFS_SERVER(inode);
897 struct nfs_client *clp = server->nfs_client;
898 struct nfs_delegation *delegation;
901 delegation = nfs4_get_valid_delegation(inode);
902 if (delegation == NULL)
904 if (stateid != NULL &&
905 !clp->cl_mvops->match_stateid(&delegation->stateid, stateid))
907 nfs_mark_return_delegation(server, delegation);
910 nfs_delegation_run_state_manager(clp);
917 static struct inode *
918 nfs_delegation_find_inode_server(struct nfs_server *server,
919 const struct nfs_fh *fhandle)
921 struct nfs_delegation *delegation;
922 struct inode *freeme, *res = NULL;
924 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
925 spin_lock(&delegation->lock);
926 if (delegation->inode != NULL &&
927 !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags) &&
928 nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
929 freeme = igrab(delegation->inode);
930 if (freeme && nfs_sb_active(freeme->i_sb))
932 spin_unlock(&delegation->lock);
940 return ERR_PTR(-EAGAIN);
942 spin_unlock(&delegation->lock);
944 return ERR_PTR(-ENOENT);
948 * nfs_delegation_find_inode - retrieve the inode associated with a delegation
949 * @clp: client state handle
950 * @fhandle: filehandle from a delegation recall
952 * Returns pointer to inode matching "fhandle," or NULL if a matching inode
955 struct inode *nfs_delegation_find_inode(struct nfs_client *clp,
956 const struct nfs_fh *fhandle)
958 struct nfs_server *server;
962 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
963 res = nfs_delegation_find_inode_server(server, fhandle);
964 if (res != ERR_PTR(-ENOENT)) {
970 return ERR_PTR(-ENOENT);
973 static void nfs_delegation_mark_reclaim_server(struct nfs_server *server)
975 struct nfs_delegation *delegation;
977 list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
979 * If the delegation may have been admin revoked, then we
982 if (test_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags))
984 set_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
989 * nfs_delegation_mark_reclaim - mark all delegations as needing to be reclaimed
990 * @clp: nfs_client to process
993 void nfs_delegation_mark_reclaim(struct nfs_client *clp)
995 struct nfs_server *server;
998 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
999 nfs_delegation_mark_reclaim_server(server);
1004 * nfs_delegation_reap_unclaimed - reap unclaimed delegations after reboot recovery is done
1005 * @clp: nfs_client to process
1008 void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
1010 struct nfs_delegation *delegation;
1011 struct nfs_server *server;
1012 struct inode *inode;
1016 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1017 list_for_each_entry_rcu(delegation, &server->delegations,
1019 if (test_bit(NFS_DELEGATION_INODE_FREEING,
1020 &delegation->flags) ||
1021 test_bit(NFS_DELEGATION_RETURNING,
1022 &delegation->flags) ||
1023 test_bit(NFS_DELEGATION_NEED_RECLAIM,
1024 &delegation->flags) == 0)
1026 if (!nfs_sb_active(server->super))
1027 break; /* continue in outer loop */
1028 inode = nfs_delegation_grab_inode(delegation);
1029 if (inode == NULL) {
1031 nfs_sb_deactive(server->super);
1034 delegation = nfs_start_delegation_return_locked(NFS_I(inode));
1036 if (delegation != NULL) {
1037 delegation = nfs_detach_delegation(NFS_I(inode),
1038 delegation, server);
1039 if (delegation != NULL)
1040 nfs_free_delegation(delegation);
1043 nfs_sb_deactive(server->super);
1051 static inline bool nfs4_server_rebooted(const struct nfs_client *clp)
1053 return (clp->cl_state & (BIT(NFS4CLNT_CHECK_LEASE) |
1054 BIT(NFS4CLNT_LEASE_EXPIRED) |
1055 BIT(NFS4CLNT_SESSION_RESET))) != 0;
1058 static void nfs_mark_test_expired_delegation(struct nfs_server *server,
1059 struct nfs_delegation *delegation)
1061 if (delegation->stateid.type == NFS4_INVALID_STATEID_TYPE)
1063 clear_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
1064 set_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags);
1065 set_bit(NFS4CLNT_DELEGATION_EXPIRED, &server->nfs_client->cl_state);
1068 static void nfs_inode_mark_test_expired_delegation(struct nfs_server *server,
1069 struct inode *inode)
1071 struct nfs_delegation *delegation;
1074 delegation = rcu_dereference(NFS_I(inode)->delegation);
1076 nfs_mark_test_expired_delegation(server, delegation);
1081 static void nfs_delegation_mark_test_expired_server(struct nfs_server *server)
1083 struct nfs_delegation *delegation;
1085 list_for_each_entry_rcu(delegation, &server->delegations, super_list)
1086 nfs_mark_test_expired_delegation(server, delegation);
1090 * nfs_mark_test_expired_all_delegations - mark all delegations for testing
1091 * @clp: nfs_client to process
1093 * Iterates through all the delegations associated with this server and
1094 * marks them as needing to be checked for validity.
1096 void nfs_mark_test_expired_all_delegations(struct nfs_client *clp)
1098 struct nfs_server *server;
1101 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1102 nfs_delegation_mark_test_expired_server(server);
1107 * nfs_test_expired_all_delegations - test all delegations for a client
1108 * @clp: nfs_client to process
1110 * Helper for handling "recallable state revoked" status from server.
1112 void nfs_test_expired_all_delegations(struct nfs_client *clp)
1114 nfs_mark_test_expired_all_delegations(clp);
1115 nfs4_schedule_state_manager(clp);
1119 nfs_delegation_test_free_expired(struct inode *inode,
1120 nfs4_stateid *stateid,
1121 const struct cred *cred)
1123 struct nfs_server *server = NFS_SERVER(inode);
1124 const struct nfs4_minor_version_ops *ops = server->nfs_client->cl_mvops;
1129 status = ops->test_and_free_expired(server, stateid, cred);
1130 if (status == -NFS4ERR_EXPIRED || status == -NFS4ERR_BAD_STATEID)
1131 nfs_remove_bad_delegation(inode, stateid);
1135 * nfs_reap_expired_delegations - reap expired delegations
1136 * @clp: nfs_client to process
1138 * Iterates through all the delegations associated with this server and
1139 * checks if they have may have been revoked. This function is usually
1140 * expected to be called in cases where the server may have lost its
1143 void nfs_reap_expired_delegations(struct nfs_client *clp)
1145 struct nfs_delegation *delegation;
1146 struct nfs_server *server;
1147 struct inode *inode;
1148 const struct cred *cred;
1149 nfs4_stateid stateid;
1153 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1154 list_for_each_entry_rcu(delegation, &server->delegations,
1156 if (test_bit(NFS_DELEGATION_INODE_FREEING,
1157 &delegation->flags) ||
1158 test_bit(NFS_DELEGATION_RETURNING,
1159 &delegation->flags) ||
1160 test_bit(NFS_DELEGATION_TEST_EXPIRED,
1161 &delegation->flags) == 0)
1163 if (!nfs_sb_active(server->super))
1164 break; /* continue in outer loop */
1165 inode = nfs_delegation_grab_inode(delegation);
1166 if (inode == NULL) {
1168 nfs_sb_deactive(server->super);
1171 cred = get_cred_rcu(delegation->cred);
1172 nfs4_stateid_copy(&stateid, &delegation->stateid);
1173 clear_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags);
1175 nfs_delegation_test_free_expired(inode, &stateid, cred);
1177 if (nfs4_server_rebooted(clp)) {
1178 nfs_inode_mark_test_expired_delegation(server,inode);
1180 nfs_sb_deactive(server->super);
1184 nfs_sb_deactive(server->super);
1192 void nfs_inode_find_delegation_state_and_recover(struct inode *inode,
1193 const nfs4_stateid *stateid)
1195 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1196 struct nfs_delegation *delegation;
1200 delegation = rcu_dereference(NFS_I(inode)->delegation);
1202 nfs4_stateid_match_other(&delegation->stateid, stateid)) {
1203 nfs_mark_test_expired_delegation(NFS_SERVER(inode), delegation);
1208 nfs4_schedule_state_manager(clp);
1212 * nfs_delegations_present - check for existence of delegations
1213 * @clp: client state handle
1215 * Returns one if there are any nfs_delegation structures attached
1216 * to this nfs_client.
1218 int nfs_delegations_present(struct nfs_client *clp)
1220 struct nfs_server *server;
1224 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1225 if (!list_empty(&server->delegations)) {
1234 * nfs4_refresh_delegation_stateid - Update delegation stateid seqid
1235 * @dst: stateid to refresh
1236 * @inode: inode to check
1238 * Returns "true" and updates "dst->seqid" * if inode had a delegation
1239 * that matches our delegation stateid. Otherwise "false" is returned.
1241 bool nfs4_refresh_delegation_stateid(nfs4_stateid *dst, struct inode *inode)
1243 struct nfs_delegation *delegation;
1249 delegation = rcu_dereference(NFS_I(inode)->delegation);
1250 if (delegation != NULL &&
1251 nfs4_stateid_match_other(dst, &delegation->stateid) &&
1252 !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags)) {
1253 dst->seqid = delegation->stateid.seqid;
1262 * nfs4_copy_delegation_stateid - Copy inode's state ID information
1263 * @inode: inode to check
1264 * @flags: delegation type requirement
1265 * @dst: stateid data structure to fill in
1266 * @cred: optional argument to retrieve credential
1268 * Returns "true" and fills in "dst->data" * if inode had a delegation,
1269 * otherwise "false" is returned.
1271 bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags,
1272 nfs4_stateid *dst, const struct cred **cred)
1274 struct nfs_inode *nfsi = NFS_I(inode);
1275 struct nfs_delegation *delegation;
1278 flags &= FMODE_READ|FMODE_WRITE;
1280 delegation = rcu_dereference(nfsi->delegation);
1281 ret = nfs4_is_valid_delegation(delegation, flags);
1283 nfs4_stateid_copy(dst, &delegation->stateid);
1284 nfs_mark_delegation_referenced(delegation);
1286 *cred = get_cred(delegation->cred);
1293 * nfs4_delegation_flush_on_close - Check if we must flush file on close
1294 * @inode: inode to check
1296 * This function checks the number of outstanding writes to the file
1297 * against the delegation 'space_limit' field to see if
1298 * the spec requires us to flush the file on close.
1300 bool nfs4_delegation_flush_on_close(const struct inode *inode)
1302 struct nfs_inode *nfsi = NFS_I(inode);
1303 struct nfs_delegation *delegation;
1307 delegation = rcu_dereference(nfsi->delegation);
1308 if (delegation == NULL || !(delegation->type & FMODE_WRITE))
1310 if (atomic_long_read(&nfsi->nrequests) < delegation->pagemod_limit)