2 * linux/fs/nfs/delegation.c
4 * Copyright (C) 2004 Trond Myklebust
6 * NFS file delegation management
9 #include <linux/completion.h>
10 #include <linux/kthread.h>
11 #include <linux/module.h>
12 #include <linux/sched.h>
13 #include <linux/slab.h>
14 #include <linux/spinlock.h>
16 #include <linux/nfs4.h>
17 #include <linux/nfs_fs.h>
18 #include <linux/nfs_xdr.h>
21 #include "delegation.h"
23 #include "nfs4trace.h"
25 static void nfs_free_delegation(struct nfs_delegation
*delegation
)
27 if (delegation
->cred
) {
28 put_rpccred(delegation
->cred
);
29 delegation
->cred
= NULL
;
31 kfree_rcu(delegation
, rcu
);
35 * nfs_mark_delegation_referenced - set delegation's REFERENCED flag
36 * @delegation: delegation to process
39 void nfs_mark_delegation_referenced(struct nfs_delegation
*delegation
)
41 set_bit(NFS_DELEGATION_REFERENCED
, &delegation
->flags
);
45 * nfs_have_delegation - check if inode has a delegation
46 * @inode: inode to check
47 * @flags: delegation types to check for
49 * Returns one if inode has the indicated delegation, otherwise zero.
51 int nfs4_have_delegation(struct inode
*inode
, fmode_t flags
)
53 struct nfs_delegation
*delegation
;
56 flags
&= FMODE_READ
|FMODE_WRITE
;
58 delegation
= rcu_dereference(NFS_I(inode
)->delegation
);
59 if (delegation
!= NULL
&& (delegation
->type
& flags
) == flags
&&
60 !test_bit(NFS_DELEGATION_RETURNING
, &delegation
->flags
)) {
61 nfs_mark_delegation_referenced(delegation
);
68 static int nfs_delegation_claim_locks(struct nfs_open_context
*ctx
, struct nfs4_state
*state
, const nfs4_stateid
*stateid
)
70 struct inode
*inode
= state
->inode
;
74 if (inode
->i_flock
== NULL
)
77 /* Protect inode->i_flock using the i_lock */
78 spin_lock(&inode
->i_lock
);
79 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
80 if (!(fl
->fl_flags
& (FL_POSIX
|FL_FLOCK
)))
82 if (nfs_file_open_context(fl
->fl_file
) != ctx
)
84 spin_unlock(&inode
->i_lock
);
85 status
= nfs4_lock_delegation_recall(fl
, state
, stateid
);
88 spin_lock(&inode
->i_lock
);
90 spin_unlock(&inode
->i_lock
);
95 static int nfs_delegation_claim_opens(struct inode
*inode
, const nfs4_stateid
*stateid
)
97 struct nfs_inode
*nfsi
= NFS_I(inode
);
98 struct nfs_open_context
*ctx
;
99 struct nfs4_state_owner
*sp
;
100 struct nfs4_state
*state
;
105 spin_lock(&inode
->i_lock
);
106 list_for_each_entry(ctx
, &nfsi
->open_files
, list
) {
110 if (!test_bit(NFS_DELEGATED_STATE
, &state
->flags
))
112 if (!nfs4_stateid_match(&state
->stateid
, stateid
))
114 get_nfs_open_context(ctx
);
115 spin_unlock(&inode
->i_lock
);
117 /* Block nfs4_proc_unlck */
118 mutex_lock(&sp
->so_delegreturn_mutex
);
119 seq
= raw_seqcount_begin(&sp
->so_reclaim_seqcount
);
120 err
= nfs4_open_delegation_recall(ctx
, state
, stateid
);
122 err
= nfs_delegation_claim_locks(ctx
, state
, stateid
);
123 if (!err
&& read_seqcount_retry(&sp
->so_reclaim_seqcount
, seq
))
125 mutex_unlock(&sp
->so_delegreturn_mutex
);
126 put_nfs_open_context(ctx
);
131 spin_unlock(&inode
->i_lock
);
136 * nfs_inode_reclaim_delegation - process a delegation reclaim request
137 * @inode: inode to process
138 * @cred: credential to use for request
139 * @res: new delegation state from server
142 void nfs_inode_reclaim_delegation(struct inode
*inode
, struct rpc_cred
*cred
,
143 struct nfs_openres
*res
)
145 struct nfs_delegation
*delegation
;
146 struct rpc_cred
*oldcred
= NULL
;
149 delegation
= rcu_dereference(NFS_I(inode
)->delegation
);
150 if (delegation
!= NULL
) {
151 spin_lock(&delegation
->lock
);
152 if (delegation
->inode
!= NULL
) {
153 nfs4_stateid_copy(&delegation
->stateid
, &res
->delegation
);
154 delegation
->type
= res
->delegation_type
;
155 delegation
->maxsize
= res
->maxsize
;
156 oldcred
= delegation
->cred
;
157 delegation
->cred
= get_rpccred(cred
);
158 clear_bit(NFS_DELEGATION_NEED_RECLAIM
,
160 NFS_I(inode
)->delegation_state
= delegation
->type
;
161 spin_unlock(&delegation
->lock
);
162 put_rpccred(oldcred
);
164 trace_nfs4_reclaim_delegation(inode
, res
->delegation_type
);
166 /* We appear to have raced with a delegation return. */
167 spin_unlock(&delegation
->lock
);
169 nfs_inode_set_delegation(inode
, cred
, res
);
176 static int nfs_do_return_delegation(struct inode
*inode
, struct nfs_delegation
*delegation
, int issync
)
180 res
= nfs4_proc_delegreturn(inode
, delegation
->cred
, &delegation
->stateid
, issync
);
181 nfs_free_delegation(delegation
);
185 static struct inode
*nfs_delegation_grab_inode(struct nfs_delegation
*delegation
)
187 struct inode
*inode
= NULL
;
189 spin_lock(&delegation
->lock
);
190 if (delegation
->inode
!= NULL
)
191 inode
= igrab(delegation
->inode
);
192 spin_unlock(&delegation
->lock
);
196 static struct nfs_delegation
*
197 nfs_start_delegation_return_locked(struct nfs_inode
*nfsi
)
199 struct nfs_delegation
*ret
= NULL
;
200 struct nfs_delegation
*delegation
= rcu_dereference(nfsi
->delegation
);
202 if (delegation
== NULL
)
204 spin_lock(&delegation
->lock
);
205 if (!test_and_set_bit(NFS_DELEGATION_RETURNING
, &delegation
->flags
))
207 spin_unlock(&delegation
->lock
);
212 static struct nfs_delegation
*
213 nfs_start_delegation_return(struct nfs_inode
*nfsi
)
215 struct nfs_delegation
*delegation
;
218 delegation
= nfs_start_delegation_return_locked(nfsi
);
224 nfs_abort_delegation_return(struct nfs_delegation
*delegation
,
225 struct nfs_client
*clp
)
228 spin_lock(&delegation
->lock
);
229 clear_bit(NFS_DELEGATION_RETURNING
, &delegation
->flags
);
230 set_bit(NFS_DELEGATION_RETURN
, &delegation
->flags
);
231 spin_unlock(&delegation
->lock
);
232 set_bit(NFS4CLNT_DELEGRETURN
, &clp
->cl_state
);
235 static struct nfs_delegation
*
236 nfs_detach_delegation_locked(struct nfs_inode
*nfsi
,
237 struct nfs_delegation
*delegation
,
238 struct nfs_client
*clp
)
240 struct nfs_delegation
*deleg_cur
=
241 rcu_dereference_protected(nfsi
->delegation
,
242 lockdep_is_held(&clp
->cl_lock
));
244 if (deleg_cur
== NULL
|| delegation
!= deleg_cur
)
247 spin_lock(&delegation
->lock
);
248 set_bit(NFS_DELEGATION_RETURNING
, &delegation
->flags
);
249 list_del_rcu(&delegation
->super_list
);
250 delegation
->inode
= NULL
;
251 nfsi
->delegation_state
= 0;
252 rcu_assign_pointer(nfsi
->delegation
, NULL
);
253 spin_unlock(&delegation
->lock
);
257 static struct nfs_delegation
*nfs_detach_delegation(struct nfs_inode
*nfsi
,
258 struct nfs_delegation
*delegation
,
259 struct nfs_server
*server
)
261 struct nfs_client
*clp
= server
->nfs_client
;
263 spin_lock(&clp
->cl_lock
);
264 delegation
= nfs_detach_delegation_locked(nfsi
, delegation
, clp
);
265 spin_unlock(&clp
->cl_lock
);
269 static struct nfs_delegation
*
270 nfs_inode_detach_delegation(struct inode
*inode
)
272 struct nfs_inode
*nfsi
= NFS_I(inode
);
273 struct nfs_server
*server
= NFS_SERVER(inode
);
274 struct nfs_delegation
*delegation
;
276 delegation
= nfs_start_delegation_return(nfsi
);
277 if (delegation
== NULL
)
279 return nfs_detach_delegation(nfsi
, delegation
, server
);
283 * nfs_inode_set_delegation - set up a delegation on an inode
284 * @inode: inode to which delegation applies
285 * @cred: cred to use for subsequent delegation processing
286 * @res: new delegation state from server
288 * Returns zero on success, or a negative errno value.
290 int nfs_inode_set_delegation(struct inode
*inode
, struct rpc_cred
*cred
, struct nfs_openres
*res
)
292 struct nfs_server
*server
= NFS_SERVER(inode
);
293 struct nfs_client
*clp
= server
->nfs_client
;
294 struct nfs_inode
*nfsi
= NFS_I(inode
);
295 struct nfs_delegation
*delegation
, *old_delegation
;
296 struct nfs_delegation
*freeme
= NULL
;
299 delegation
= kmalloc(sizeof(*delegation
), GFP_NOFS
);
300 if (delegation
== NULL
)
302 nfs4_stateid_copy(&delegation
->stateid
, &res
->delegation
);
303 delegation
->type
= res
->delegation_type
;
304 delegation
->maxsize
= res
->maxsize
;
305 delegation
->change_attr
= inode
->i_version
;
306 delegation
->cred
= get_rpccred(cred
);
307 delegation
->inode
= inode
;
308 delegation
->flags
= 1<<NFS_DELEGATION_REFERENCED
;
309 spin_lock_init(&delegation
->lock
);
311 spin_lock(&clp
->cl_lock
);
312 old_delegation
= rcu_dereference_protected(nfsi
->delegation
,
313 lockdep_is_held(&clp
->cl_lock
));
314 if (old_delegation
!= NULL
) {
315 if (nfs4_stateid_match(&delegation
->stateid
,
316 &old_delegation
->stateid
) &&
317 delegation
->type
== old_delegation
->type
) {
321 * Deal with broken servers that hand out two
322 * delegations for the same file.
323 * Allow for upgrades to a WRITE delegation, but
326 dfprintk(FILE, "%s: server %s handed out "
327 "a duplicate delegation!\n",
328 __func__
, clp
->cl_hostname
);
329 if (delegation
->type
== old_delegation
->type
||
330 !(delegation
->type
& FMODE_WRITE
)) {
335 freeme
= nfs_detach_delegation_locked(nfsi
,
336 old_delegation
, clp
);
340 list_add_rcu(&delegation
->super_list
, &server
->delegations
);
341 nfsi
->delegation_state
= delegation
->type
;
342 rcu_assign_pointer(nfsi
->delegation
, delegation
);
345 /* Ensure we revalidate the attributes and page cache! */
346 spin_lock(&inode
->i_lock
);
347 nfsi
->cache_validity
|= NFS_INO_REVAL_FORCED
;
348 spin_unlock(&inode
->i_lock
);
349 trace_nfs4_set_delegation(inode
, res
->delegation_type
);
352 spin_unlock(&clp
->cl_lock
);
353 if (delegation
!= NULL
)
354 nfs_free_delegation(delegation
);
356 nfs_do_return_delegation(inode
, freeme
, 0);
361 * Basic procedure for returning a delegation to the server
363 static int nfs_end_delegation_return(struct inode
*inode
, struct nfs_delegation
*delegation
, int issync
)
365 struct nfs_client
*clp
= NFS_SERVER(inode
)->nfs_client
;
366 struct nfs_inode
*nfsi
= NFS_I(inode
);
369 if (delegation
== NULL
)
372 err
= nfs_delegation_claim_opens(inode
, &delegation
->stateid
);
373 if (!issync
|| err
!= -EAGAIN
)
376 * Guard against state recovery
378 err
= nfs4_wait_clnt_recover(clp
);
382 nfs_abort_delegation_return(delegation
, clp
);
385 if (!nfs_detach_delegation(nfsi
, delegation
, NFS_SERVER(inode
)))
388 err
= nfs_do_return_delegation(inode
, delegation
, issync
);
393 static bool nfs_delegation_need_return(struct nfs_delegation
*delegation
)
397 if (test_and_clear_bit(NFS_DELEGATION_RETURN
, &delegation
->flags
))
399 if (test_and_clear_bit(NFS_DELEGATION_RETURN_IF_CLOSED
, &delegation
->flags
) && !ret
) {
402 spin_lock(&delegation
->lock
);
403 inode
= delegation
->inode
;
404 if (inode
&& list_empty(&NFS_I(inode
)->open_files
))
406 spin_unlock(&delegation
->lock
);
412 * nfs_client_return_marked_delegations - return previously marked delegations
413 * @clp: nfs_client to process
415 * Note that this function is designed to be called by the state
416 * manager thread. For this reason, it cannot flush the dirty data,
417 * since that could deadlock in case of a state recovery error.
419 * Returns zero on success, or a negative errno value.
421 int nfs_client_return_marked_delegations(struct nfs_client
*clp
)
423 struct nfs_delegation
*delegation
;
424 struct nfs_server
*server
;
430 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
) {
431 list_for_each_entry_rcu(delegation
, &server
->delegations
,
433 if (!nfs_delegation_need_return(delegation
))
435 inode
= nfs_delegation_grab_inode(delegation
);
438 delegation
= nfs_start_delegation_return_locked(NFS_I(inode
));
441 err
= nfs_end_delegation_return(inode
, delegation
, 0);
445 set_bit(NFS4CLNT_DELEGRETURN
, &clp
->cl_state
);
454 * nfs_inode_return_delegation_noreclaim - return delegation, don't reclaim opens
455 * @inode: inode to process
457 * Does not protect against delegation reclaims, therefore really only safe
458 * to be called from nfs4_clear_inode().
460 void nfs_inode_return_delegation_noreclaim(struct inode
*inode
)
462 struct nfs_delegation
*delegation
;
464 delegation
= nfs_inode_detach_delegation(inode
);
465 if (delegation
!= NULL
)
466 nfs_do_return_delegation(inode
, delegation
, 0);
470 * nfs_inode_return_delegation - synchronously return a delegation
471 * @inode: inode to process
473 * This routine will always flush any dirty data to disk on the
474 * assumption that if we need to return the delegation, then
475 * we should stop caching.
477 * Returns zero on success, or a negative errno value.
479 int nfs4_inode_return_delegation(struct inode
*inode
)
481 struct nfs_inode
*nfsi
= NFS_I(inode
);
482 struct nfs_delegation
*delegation
;
486 delegation
= nfs_start_delegation_return(nfsi
);
487 if (delegation
!= NULL
)
488 err
= nfs_end_delegation_return(inode
, delegation
, 1);
492 static void nfs_mark_return_if_closed_delegation(struct nfs_server
*server
,
493 struct nfs_delegation
*delegation
)
495 set_bit(NFS_DELEGATION_RETURN_IF_CLOSED
, &delegation
->flags
);
496 set_bit(NFS4CLNT_DELEGRETURN
, &server
->nfs_client
->cl_state
);
499 static void nfs_mark_return_delegation(struct nfs_server
*server
,
500 struct nfs_delegation
*delegation
)
502 set_bit(NFS_DELEGATION_RETURN
, &delegation
->flags
);
503 set_bit(NFS4CLNT_DELEGRETURN
, &server
->nfs_client
->cl_state
);
506 static bool nfs_server_mark_return_all_delegations(struct nfs_server
*server
)
508 struct nfs_delegation
*delegation
;
511 list_for_each_entry_rcu(delegation
, &server
->delegations
, super_list
) {
512 nfs_mark_return_delegation(server
, delegation
);
518 static void nfs_client_mark_return_all_delegations(struct nfs_client
*clp
)
520 struct nfs_server
*server
;
523 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
)
524 nfs_server_mark_return_all_delegations(server
);
528 static void nfs_delegation_run_state_manager(struct nfs_client
*clp
)
530 if (test_bit(NFS4CLNT_DELEGRETURN
, &clp
->cl_state
))
531 nfs4_schedule_state_manager(clp
);
535 * nfs_expire_all_delegations
536 * @clp: client to process
539 void nfs_expire_all_delegations(struct nfs_client
*clp
)
541 nfs_client_mark_return_all_delegations(clp
);
542 nfs_delegation_run_state_manager(clp
);
546 * nfs_super_return_all_delegations - return delegations for one superblock
550 void nfs_server_return_all_delegations(struct nfs_server
*server
)
552 struct nfs_client
*clp
= server
->nfs_client
;
559 need_wait
= nfs_server_mark_return_all_delegations(server
);
563 nfs4_schedule_state_manager(clp
);
564 nfs4_wait_clnt_recover(clp
);
568 static void nfs_mark_return_unused_delegation_types(struct nfs_server
*server
,
571 struct nfs_delegation
*delegation
;
573 list_for_each_entry_rcu(delegation
, &server
->delegations
, super_list
) {
574 if ((delegation
->type
== (FMODE_READ
|FMODE_WRITE
)) && !(flags
& FMODE_WRITE
))
576 if (delegation
->type
& flags
)
577 nfs_mark_return_if_closed_delegation(server
, delegation
);
581 static void nfs_client_mark_return_unused_delegation_types(struct nfs_client
*clp
,
584 struct nfs_server
*server
;
587 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
)
588 nfs_mark_return_unused_delegation_types(server
, flags
);
592 void nfs_remove_bad_delegation(struct inode
*inode
)
594 struct nfs_delegation
*delegation
;
596 delegation
= nfs_inode_detach_delegation(inode
);
598 nfs_inode_find_state_and_recover(inode
, &delegation
->stateid
);
599 nfs_free_delegation(delegation
);
602 EXPORT_SYMBOL_GPL(nfs_remove_bad_delegation
);
605 * nfs_expire_unused_delegation_types
606 * @clp: client to process
607 * @flags: delegation types to expire
610 void nfs_expire_unused_delegation_types(struct nfs_client
*clp
, fmode_t flags
)
612 nfs_client_mark_return_unused_delegation_types(clp
, flags
);
613 nfs_delegation_run_state_manager(clp
);
616 static void nfs_mark_return_unreferenced_delegations(struct nfs_server
*server
)
618 struct nfs_delegation
*delegation
;
620 list_for_each_entry_rcu(delegation
, &server
->delegations
, super_list
) {
621 if (test_and_clear_bit(NFS_DELEGATION_REFERENCED
, &delegation
->flags
))
623 nfs_mark_return_if_closed_delegation(server
, delegation
);
628 * nfs_expire_unreferenced_delegations - Eliminate unused delegations
629 * @clp: nfs_client to process
632 void nfs_expire_unreferenced_delegations(struct nfs_client
*clp
)
634 struct nfs_server
*server
;
637 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
)
638 nfs_mark_return_unreferenced_delegations(server
);
641 nfs_delegation_run_state_manager(clp
);
645 * nfs_async_inode_return_delegation - asynchronously return a delegation
646 * @inode: inode to process
647 * @stateid: state ID information
649 * Returns zero on success, or a negative errno value.
651 int nfs_async_inode_return_delegation(struct inode
*inode
,
652 const nfs4_stateid
*stateid
)
654 struct nfs_server
*server
= NFS_SERVER(inode
);
655 struct nfs_client
*clp
= server
->nfs_client
;
656 struct nfs_delegation
*delegation
;
658 filemap_flush(inode
->i_mapping
);
661 delegation
= rcu_dereference(NFS_I(inode
)->delegation
);
663 if (!clp
->cl_mvops
->match_stateid(&delegation
->stateid
, stateid
)) {
667 nfs_mark_return_delegation(server
, delegation
);
670 nfs_delegation_run_state_manager(clp
);
674 static struct inode
*
675 nfs_delegation_find_inode_server(struct nfs_server
*server
,
676 const struct nfs_fh
*fhandle
)
678 struct nfs_delegation
*delegation
;
679 struct inode
*res
= NULL
;
681 list_for_each_entry_rcu(delegation
, &server
->delegations
, super_list
) {
682 spin_lock(&delegation
->lock
);
683 if (delegation
->inode
!= NULL
&&
684 nfs_compare_fh(fhandle
, &NFS_I(delegation
->inode
)->fh
) == 0) {
685 res
= igrab(delegation
->inode
);
687 spin_unlock(&delegation
->lock
);
695 * nfs_delegation_find_inode - retrieve the inode associated with a delegation
696 * @clp: client state handle
697 * @fhandle: filehandle from a delegation recall
699 * Returns pointer to inode matching "fhandle," or NULL if a matching inode
702 struct inode
*nfs_delegation_find_inode(struct nfs_client
*clp
,
703 const struct nfs_fh
*fhandle
)
705 struct nfs_server
*server
;
706 struct inode
*res
= NULL
;
709 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
) {
710 res
= nfs_delegation_find_inode_server(server
, fhandle
);
718 static void nfs_delegation_mark_reclaim_server(struct nfs_server
*server
)
720 struct nfs_delegation
*delegation
;
722 list_for_each_entry_rcu(delegation
, &server
->delegations
, super_list
)
723 set_bit(NFS_DELEGATION_NEED_RECLAIM
, &delegation
->flags
);
727 * nfs_delegation_mark_reclaim - mark all delegations as needing to be reclaimed
728 * @clp: nfs_client to process
731 void nfs_delegation_mark_reclaim(struct nfs_client
*clp
)
733 struct nfs_server
*server
;
736 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
)
737 nfs_delegation_mark_reclaim_server(server
);
742 * nfs_delegation_reap_unclaimed - reap unclaimed delegations after reboot recovery is done
743 * @clp: nfs_client to process
746 void nfs_delegation_reap_unclaimed(struct nfs_client
*clp
)
748 struct nfs_delegation
*delegation
;
749 struct nfs_server
*server
;
754 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
) {
755 list_for_each_entry_rcu(delegation
, &server
->delegations
,
757 if (test_bit(NFS_DELEGATION_NEED_RECLAIM
,
758 &delegation
->flags
) == 0)
760 inode
= nfs_delegation_grab_inode(delegation
);
763 delegation
= nfs_detach_delegation(NFS_I(inode
),
767 if (delegation
!= NULL
)
768 nfs_free_delegation(delegation
);
777 * nfs_delegations_present - check for existence of delegations
778 * @clp: client state handle
780 * Returns one if there are any nfs_delegation structures attached
781 * to this nfs_client.
783 int nfs_delegations_present(struct nfs_client
*clp
)
785 struct nfs_server
*server
;
789 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
)
790 if (!list_empty(&server
->delegations
)) {
799 * nfs4_copy_delegation_stateid - Copy inode's state ID information
800 * @dst: stateid data structure to fill in
801 * @inode: inode to check
802 * @flags: delegation type requirement
804 * Returns "true" and fills in "dst->data" * if inode had a delegation,
805 * otherwise "false" is returned.
807 bool nfs4_copy_delegation_stateid(nfs4_stateid
*dst
, struct inode
*inode
,
810 struct nfs_inode
*nfsi
= NFS_I(inode
);
811 struct nfs_delegation
*delegation
;
814 flags
&= FMODE_READ
|FMODE_WRITE
;
816 delegation
= rcu_dereference(nfsi
->delegation
);
817 ret
= (delegation
!= NULL
&& (delegation
->type
& flags
) == flags
);
819 nfs4_stateid_copy(dst
, &delegation
->stateid
);
820 nfs_mark_delegation_referenced(delegation
);