4 * Client-side XDR for NFSv4.
6 * Copyright (c) 2002 The Regents of the University of Michigan.
9 * Kendrick Smith <kmsmith@umich.edu>
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
25 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
26 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
31 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Implementation of the NFSv4 state model. For the time being,
37 * this is minimal, but will be made much more complex in a
41 #include <linux/kernel.h>
42 #include <linux/slab.h>
44 #include <linux/nfs_fs.h>
45 #include <linux/kthread.h>
46 #include <linux/module.h>
47 #include <linux/random.h>
48 #include <linux/ratelimit.h>
49 #include <linux/workqueue.h>
50 #include <linux/bitops.h>
51 #include <linux/jiffies.h>
52 #include <linux/sched/mm.h>
54 #include <linux/sunrpc/clnt.h>
58 #include "delegation.h"
60 #include "nfs4idmap.h"
61 #include "nfs4session.h"
64 #include "nfs4trace.h"
66 #define NFSDBG_FACILITY NFSDBG_STATE
68 #define OPENOWNER_POOL_SIZE 8
70 const nfs4_stateid zero_stateid = {
72 .type = NFS4_SPECIAL_STATEID_TYPE,
74 const nfs4_stateid invalid_stateid = {
76 /* Funky initialiser keeps older gcc versions happy */
77 .data = { 0xff, 0xff, 0xff, 0xff, 0 },
79 .type = NFS4_INVALID_STATEID_TYPE,
82 const nfs4_stateid current_stateid = {
84 /* Funky initialiser keeps older gcc versions happy */
85 .data = { 0x0, 0x0, 0x0, 0x1, 0 },
87 .type = NFS4_SPECIAL_STATEID_TYPE,
90 static DEFINE_MUTEX(nfs_clid_init_mutex);
92 static int nfs4_setup_state_renewal(struct nfs_client *clp)
95 struct nfs_fsinfo fsinfo;
97 if (!test_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state)) {
98 nfs4_schedule_state_renewal(clp);
102 status = nfs4_proc_get_lease_time(clp, &fsinfo);
104 nfs4_set_lease_period(clp, fsinfo.lease_time * HZ);
105 nfs4_schedule_state_renewal(clp);
111 int nfs4_init_clientid(struct nfs_client *clp, const struct cred *cred)
113 struct nfs4_setclientid_res clid = {
114 .clientid = clp->cl_clientid,
115 .confirm = clp->cl_confirm,
119 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
121 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
123 port = nn->nfs_callback_tcpport;
124 if (clp->cl_addr.ss_family == AF_INET6)
125 port = nn->nfs_callback_tcpport6;
127 status = nfs4_proc_setclientid(clp, NFS4_CALLBACK, port, cred, &clid);
130 clp->cl_clientid = clid.clientid;
131 clp->cl_confirm = clid.confirm;
132 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
134 status = nfs4_proc_setclientid_confirm(clp, &clid, cred);
137 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
138 nfs4_setup_state_renewal(clp);
144 * nfs40_discover_server_trunking - Detect server IP address trunking (mv0)
146 * @clp: nfs_client under test
147 * @result: OUT: found nfs_client, or clp
148 * @cred: credential to use for trunking test
150 * Returns zero, a negative errno, or a negative NFS4ERR status.
151 * If zero is returned, an nfs_client pointer is planted in
154 * Note: The returned client may not yet be marked ready.
156 int nfs40_discover_server_trunking(struct nfs_client *clp,
157 struct nfs_client **result,
158 const struct cred *cred)
160 struct nfs4_setclientid_res clid = {
161 .clientid = clp->cl_clientid,
162 .confirm = clp->cl_confirm,
164 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
168 port = nn->nfs_callback_tcpport;
169 if (clp->cl_addr.ss_family == AF_INET6)
170 port = nn->nfs_callback_tcpport6;
172 status = nfs4_proc_setclientid(clp, NFS4_CALLBACK, port, cred, &clid);
175 clp->cl_clientid = clid.clientid;
176 clp->cl_confirm = clid.confirm;
178 status = nfs40_walk_client_list(clp, result, cred);
180 /* Sustain the lease, even if it's empty. If the clientid4
181 * goes stale it's of no use for trunking discovery. */
182 nfs4_schedule_state_renewal(*result);
184 /* If the client state need to recover, do it. */
186 nfs4_schedule_state_manager(clp);
192 const struct cred *nfs4_get_machine_cred(struct nfs_client *clp)
194 return get_cred(rpc_machine_cred());
197 static void nfs4_root_machine_cred(struct nfs_client *clp)
200 /* Force root creds instead of machine */
201 clp->cl_principal = NULL;
202 clp->cl_rpcclient->cl_principal = NULL;
205 static const struct cred *
206 nfs4_get_renew_cred_server_locked(struct nfs_server *server)
208 const struct cred *cred = NULL;
209 struct nfs4_state_owner *sp;
212 for (pos = rb_first(&server->state_owners);
214 pos = rb_next(pos)) {
215 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
216 if (list_empty(&sp->so_states))
218 cred = get_cred(sp->so_cred);
225 * nfs4_get_renew_cred - Acquire credential for a renew operation
226 * @clp: client state handle
228 * Returns an rpc_cred with reference count bumped, or NULL.
229 * Caller must hold clp->cl_lock.
231 const struct cred *nfs4_get_renew_cred(struct nfs_client *clp)
233 const struct cred *cred = NULL;
234 struct nfs_server *server;
236 /* Use machine credentials if available */
237 cred = nfs4_get_machine_cred(clp);
241 spin_lock(&clp->cl_lock);
243 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
244 cred = nfs4_get_renew_cred_server_locked(server);
249 spin_unlock(&clp->cl_lock);
255 static void nfs4_end_drain_slot_table(struct nfs4_slot_table *tbl)
257 if (test_and_clear_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
258 spin_lock(&tbl->slot_tbl_lock);
259 nfs41_wake_slot_table(tbl);
260 spin_unlock(&tbl->slot_tbl_lock);
264 static void nfs4_end_drain_session(struct nfs_client *clp)
266 struct nfs4_session *ses = clp->cl_session;
268 if (clp->cl_slot_tbl) {
269 nfs4_end_drain_slot_table(clp->cl_slot_tbl);
274 nfs4_end_drain_slot_table(&ses->bc_slot_table);
275 nfs4_end_drain_slot_table(&ses->fc_slot_table);
279 static int nfs4_drain_slot_tbl(struct nfs4_slot_table *tbl)
281 set_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state);
282 spin_lock(&tbl->slot_tbl_lock);
283 if (tbl->highest_used_slotid != NFS4_NO_SLOT) {
284 reinit_completion(&tbl->complete);
285 spin_unlock(&tbl->slot_tbl_lock);
286 return wait_for_completion_interruptible(&tbl->complete);
288 spin_unlock(&tbl->slot_tbl_lock);
292 static int nfs4_begin_drain_session(struct nfs_client *clp)
294 struct nfs4_session *ses = clp->cl_session;
297 if (clp->cl_slot_tbl)
298 return nfs4_drain_slot_tbl(clp->cl_slot_tbl);
301 ret = nfs4_drain_slot_tbl(&ses->bc_slot_table);
305 return nfs4_drain_slot_tbl(&ses->fc_slot_table);
308 #if defined(CONFIG_NFS_V4_1)
310 static void nfs41_finish_session_reset(struct nfs_client *clp)
312 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
313 clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
314 /* create_session negotiated new slot table */
315 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
316 nfs4_setup_state_renewal(clp);
319 int nfs41_init_clientid(struct nfs_client *clp, const struct cred *cred)
323 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
325 status = nfs4_proc_exchange_id(clp, cred);
328 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
330 status = nfs4_proc_create_session(clp, cred);
333 nfs41_finish_session_reset(clp);
334 nfs_mark_client_ready(clp, NFS_CS_READY);
340 * nfs41_discover_server_trunking - Detect server IP address trunking (mv1)
342 * @clp: nfs_client under test
343 * @result: OUT: found nfs_client, or clp
344 * @cred: credential to use for trunking test
346 * Returns NFS4_OK, a negative errno, or a negative NFS4ERR status.
347 * If NFS4_OK is returned, an nfs_client pointer is planted in
350 * Note: The returned client may not yet be marked ready.
352 int nfs41_discover_server_trunking(struct nfs_client *clp,
353 struct nfs_client **result,
354 const struct cred *cred)
358 status = nfs4_proc_exchange_id(clp, cred);
359 if (status != NFS4_OK)
362 status = nfs41_walk_client_list(clp, result, cred);
369 * Purge state if the client id was established in a prior
370 * instance and the client id could not have arrived on the
371 * server via Transparent State Migration.
373 if (clp->cl_exchange_flags & EXCHGID4_FLAG_CONFIRMED_R) {
374 if (!test_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags))
375 set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
377 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
379 nfs4_schedule_state_manager(clp);
380 status = nfs_wait_client_init_complete(clp);
386 #endif /* CONFIG_NFS_V4_1 */
389 * nfs4_get_clid_cred - Acquire credential for a setclientid operation
390 * @clp: client state handle
392 * Returns a cred with reference count bumped, or NULL.
394 const struct cred *nfs4_get_clid_cred(struct nfs_client *clp)
396 const struct cred *cred;
398 cred = nfs4_get_machine_cred(clp);
402 static struct nfs4_state_owner *
403 nfs4_find_state_owner_locked(struct nfs_server *server, const struct cred *cred)
405 struct rb_node **p = &server->state_owners.rb_node,
407 struct nfs4_state_owner *sp;
412 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
413 cmp = cred_fscmp(cred, sp->so_cred);
416 p = &parent->rb_left;
418 p = &parent->rb_right;
420 if (!list_empty(&sp->so_lru))
421 list_del_init(&sp->so_lru);
422 atomic_inc(&sp->so_count);
429 static struct nfs4_state_owner *
430 nfs4_insert_state_owner_locked(struct nfs4_state_owner *new)
432 struct nfs_server *server = new->so_server;
433 struct rb_node **p = &server->state_owners.rb_node,
435 struct nfs4_state_owner *sp;
440 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
441 cmp = cred_fscmp(new->so_cred, sp->so_cred);
444 p = &parent->rb_left;
446 p = &parent->rb_right;
448 if (!list_empty(&sp->so_lru))
449 list_del_init(&sp->so_lru);
450 atomic_inc(&sp->so_count);
454 rb_link_node(&new->so_server_node, parent, p);
455 rb_insert_color(&new->so_server_node, &server->state_owners);
460 nfs4_remove_state_owner_locked(struct nfs4_state_owner *sp)
462 struct nfs_server *server = sp->so_server;
464 if (!RB_EMPTY_NODE(&sp->so_server_node))
465 rb_erase(&sp->so_server_node, &server->state_owners);
469 nfs4_init_seqid_counter(struct nfs_seqid_counter *sc)
471 sc->create_time = ktime_get();
474 spin_lock_init(&sc->lock);
475 INIT_LIST_HEAD(&sc->list);
476 rpc_init_wait_queue(&sc->wait, "Seqid_waitqueue");
480 nfs4_destroy_seqid_counter(struct nfs_seqid_counter *sc)
482 rpc_destroy_wait_queue(&sc->wait);
486 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
487 * create a new state_owner.
490 static struct nfs4_state_owner *
491 nfs4_alloc_state_owner(struct nfs_server *server,
492 const struct cred *cred,
495 struct nfs4_state_owner *sp;
497 sp = kzalloc(sizeof(*sp), gfp_flags);
500 sp->so_seqid.owner_id = ida_alloc(&server->openowner_id, gfp_flags);
501 if (sp->so_seqid.owner_id < 0) {
505 sp->so_server = server;
506 sp->so_cred = get_cred(cred);
507 spin_lock_init(&sp->so_lock);
508 INIT_LIST_HEAD(&sp->so_states);
509 nfs4_init_seqid_counter(&sp->so_seqid);
510 atomic_set(&sp->so_count, 1);
511 INIT_LIST_HEAD(&sp->so_lru);
512 seqcount_spinlock_init(&sp->so_reclaim_seqcount, &sp->so_lock);
513 mutex_init(&sp->so_delegreturn_mutex);
518 nfs4_reset_state_owner(struct nfs4_state_owner *sp)
520 /* This state_owner is no longer usable, but must
521 * remain in place so that state recovery can find it
522 * and the opens associated with it.
523 * It may also be used for new 'open' request to
524 * return a delegation to the server.
525 * So update the 'create_time' so that it looks like
526 * a new state_owner. This will cause the server to
527 * request an OPEN_CONFIRM to start a new sequence.
529 sp->so_seqid.create_time = ktime_get();
532 static void nfs4_free_state_owner(struct nfs4_state_owner *sp)
534 nfs4_destroy_seqid_counter(&sp->so_seqid);
535 put_cred(sp->so_cred);
536 ida_free(&sp->so_server->openowner_id, sp->so_seqid.owner_id);
540 static void nfs4_gc_state_owners(struct nfs_server *server)
542 struct nfs_client *clp = server->nfs_client;
543 struct nfs4_state_owner *sp, *tmp;
544 unsigned long time_min, time_max;
547 spin_lock(&clp->cl_lock);
549 time_min = (long)time_max - (long)clp->cl_lease_time;
550 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
551 /* NB: LRU is sorted so that oldest is at the head */
552 if (time_in_range(sp->so_expires, time_min, time_max))
554 list_move(&sp->so_lru, &doomed);
555 nfs4_remove_state_owner_locked(sp);
557 spin_unlock(&clp->cl_lock);
559 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
560 list_del(&sp->so_lru);
561 nfs4_free_state_owner(sp);
566 * nfs4_get_state_owner - Look up a state owner given a credential
567 * @server: nfs_server to search
568 * @cred: RPC credential to match
569 * @gfp_flags: allocation mode
571 * Returns a pointer to an instantiated nfs4_state_owner struct, or NULL.
573 struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *server,
574 const struct cred *cred,
577 struct nfs_client *clp = server->nfs_client;
578 struct nfs4_state_owner *sp, *new;
580 spin_lock(&clp->cl_lock);
581 sp = nfs4_find_state_owner_locked(server, cred);
582 spin_unlock(&clp->cl_lock);
585 new = nfs4_alloc_state_owner(server, cred, gfp_flags);
588 spin_lock(&clp->cl_lock);
589 sp = nfs4_insert_state_owner_locked(new);
590 spin_unlock(&clp->cl_lock);
592 nfs4_free_state_owner(new);
594 nfs4_gc_state_owners(server);
599 * nfs4_put_state_owner - Release a nfs4_state_owner
600 * @sp: state owner data to release
602 * Note that we keep released state owners on an LRU
604 * This caches valid state owners so that they can be
605 * reused, to avoid the OPEN_CONFIRM on minor version 0.
606 * It also pins the uniquifier of dropped state owners for
607 * a while, to ensure that those state owner names are
610 void nfs4_put_state_owner(struct nfs4_state_owner *sp)
612 struct nfs_server *server = sp->so_server;
613 struct nfs_client *clp = server->nfs_client;
615 if (!atomic_dec_and_lock(&sp->so_count, &clp->cl_lock))
618 sp->so_expires = jiffies;
619 list_add_tail(&sp->so_lru, &server->state_owners_lru);
620 spin_unlock(&clp->cl_lock);
624 * nfs4_purge_state_owners - Release all cached state owners
625 * @server: nfs_server with cached state owners to release
626 * @head: resulting list of state owners
628 * Called at umount time. Remaining state owners will be on
629 * the LRU with ref count of zero.
630 * Note that the state owners are not freed, but are added
631 * to the list @head, which can later be used as an argument
632 * to nfs4_free_state_owners.
634 void nfs4_purge_state_owners(struct nfs_server *server, struct list_head *head)
636 struct nfs_client *clp = server->nfs_client;
637 struct nfs4_state_owner *sp, *tmp;
639 spin_lock(&clp->cl_lock);
640 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
641 list_move(&sp->so_lru, head);
642 nfs4_remove_state_owner_locked(sp);
644 spin_unlock(&clp->cl_lock);
648 * nfs4_free_state_owners - Release all cached state owners
649 * @head: resulting list of state owners
651 * Frees a list of state owners that was generated by
652 * nfs4_purge_state_owners
654 void nfs4_free_state_owners(struct list_head *head)
656 struct nfs4_state_owner *sp, *tmp;
658 list_for_each_entry_safe(sp, tmp, head, so_lru) {
659 list_del(&sp->so_lru);
660 nfs4_free_state_owner(sp);
664 static struct nfs4_state *
665 nfs4_alloc_open_state(void)
667 struct nfs4_state *state;
669 state = kzalloc(sizeof(*state), GFP_KERNEL_ACCOUNT);
672 refcount_set(&state->count, 1);
673 INIT_LIST_HEAD(&state->lock_states);
674 spin_lock_init(&state->state_lock);
675 seqlock_init(&state->seqlock);
676 init_waitqueue_head(&state->waitq);
681 nfs4_state_set_mode_locked(struct nfs4_state *state, fmode_t fmode)
683 if (state->state == fmode)
685 /* NB! List reordering - see the reclaim code for why. */
686 if ((fmode & FMODE_WRITE) != (state->state & FMODE_WRITE)) {
687 if (fmode & FMODE_WRITE)
688 list_move(&state->open_states, &state->owner->so_states);
690 list_move_tail(&state->open_states, &state->owner->so_states);
692 state->state = fmode;
695 static struct nfs4_state *
696 __nfs4_find_state_byowner(struct inode *inode, struct nfs4_state_owner *owner)
698 struct nfs_inode *nfsi = NFS_I(inode);
699 struct nfs4_state *state;
701 list_for_each_entry_rcu(state, &nfsi->open_states, inode_states) {
702 if (state->owner != owner)
704 if (!nfs4_valid_open_stateid(state))
706 if (refcount_inc_not_zero(&state->count))
713 nfs4_free_open_state(struct nfs4_state *state)
715 kfree_rcu(state, rcu_head);
719 nfs4_get_open_state(struct inode *inode, struct nfs4_state_owner *owner)
721 struct nfs4_state *state, *new;
722 struct nfs_inode *nfsi = NFS_I(inode);
725 state = __nfs4_find_state_byowner(inode, owner);
729 new = nfs4_alloc_open_state();
730 spin_lock(&owner->so_lock);
731 spin_lock(&inode->i_lock);
732 state = __nfs4_find_state_byowner(inode, owner);
733 if (state == NULL && new != NULL) {
735 state->owner = owner;
736 atomic_inc(&owner->so_count);
738 state->inode = inode;
739 list_add_rcu(&state->inode_states, &nfsi->open_states);
740 spin_unlock(&inode->i_lock);
741 /* Note: The reclaim code dictates that we add stateless
742 * and read-only stateids to the end of the list */
743 list_add_tail(&state->open_states, &owner->so_states);
744 spin_unlock(&owner->so_lock);
746 spin_unlock(&inode->i_lock);
747 spin_unlock(&owner->so_lock);
749 nfs4_free_open_state(new);
755 void nfs4_put_open_state(struct nfs4_state *state)
757 struct inode *inode = state->inode;
758 struct nfs4_state_owner *owner = state->owner;
760 if (!refcount_dec_and_lock(&state->count, &owner->so_lock))
762 spin_lock(&inode->i_lock);
763 list_del_rcu(&state->inode_states);
764 list_del(&state->open_states);
765 spin_unlock(&inode->i_lock);
766 spin_unlock(&owner->so_lock);
767 nfs4_inode_return_delegation_on_close(inode);
769 nfs4_free_open_state(state);
770 nfs4_put_state_owner(owner);
774 * Close the current file.
776 static void __nfs4_close(struct nfs4_state *state,
777 fmode_t fmode, gfp_t gfp_mask, int wait)
779 struct nfs4_state_owner *owner = state->owner;
783 atomic_inc(&owner->so_count);
784 /* Protect against nfs4_find_state() */
785 spin_lock(&owner->so_lock);
786 switch (fmode & (FMODE_READ | FMODE_WRITE)) {
793 case FMODE_READ|FMODE_WRITE:
796 newstate = FMODE_READ|FMODE_WRITE;
797 if (state->n_rdwr == 0) {
798 if (state->n_rdonly == 0) {
799 newstate &= ~FMODE_READ;
800 call_close |= test_bit(NFS_O_RDONLY_STATE, &state->flags);
801 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
803 if (state->n_wronly == 0) {
804 newstate &= ~FMODE_WRITE;
805 call_close |= test_bit(NFS_O_WRONLY_STATE, &state->flags);
806 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
809 clear_bit(NFS_DELEGATED_STATE, &state->flags);
811 nfs4_state_set_mode_locked(state, newstate);
812 spin_unlock(&owner->so_lock);
815 nfs4_put_open_state(state);
816 nfs4_put_state_owner(owner);
818 nfs4_do_close(state, gfp_mask, wait);
821 void nfs4_close_state(struct nfs4_state *state, fmode_t fmode)
823 __nfs4_close(state, fmode, GFP_KERNEL, 0);
826 void nfs4_close_sync(struct nfs4_state *state, fmode_t fmode)
828 __nfs4_close(state, fmode, GFP_KERNEL, 1);
832 * Search the state->lock_states for an existing lock_owner
833 * that is compatible with either of the given owners.
834 * If the second is non-zero, then the first refers to a Posix-lock
835 * owner (current->files) and the second refers to a flock/OFD
836 * owner (struct file*). In that case, prefer a match for the first
838 * If both sorts of locks are held on the one file we cannot know
839 * which stateid was intended to be used, so a "correct" choice cannot
840 * be made. Failing that, a "consistent" choice is preferable. The
841 * consistent choice we make is to prefer the first owner, that of a
844 static struct nfs4_lock_state *
845 __nfs4_find_lock_state(struct nfs4_state *state,
846 fl_owner_t fl_owner, fl_owner_t fl_owner2)
848 struct nfs4_lock_state *pos, *ret = NULL;
849 list_for_each_entry(pos, &state->lock_states, ls_locks) {
850 if (pos->ls_owner == fl_owner) {
854 if (pos->ls_owner == fl_owner2)
858 refcount_inc(&ret->ls_count);
863 * Return a compatible lock_state. If no initialized lock_state structure
864 * exists, return an uninitialized one.
867 static struct nfs4_lock_state *nfs4_alloc_lock_state(struct nfs4_state *state, fl_owner_t fl_owner)
869 struct nfs4_lock_state *lsp;
870 struct nfs_server *server = state->owner->so_server;
872 lsp = kzalloc(sizeof(*lsp), GFP_KERNEL_ACCOUNT);
875 nfs4_init_seqid_counter(&lsp->ls_seqid);
876 refcount_set(&lsp->ls_count, 1);
877 lsp->ls_state = state;
878 lsp->ls_owner = fl_owner;
879 lsp->ls_seqid.owner_id = ida_alloc(&server->lockowner_id, GFP_KERNEL_ACCOUNT);
880 if (lsp->ls_seqid.owner_id < 0)
882 INIT_LIST_HEAD(&lsp->ls_locks);
889 void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp)
891 ida_free(&server->lockowner_id, lsp->ls_seqid.owner_id);
892 nfs4_destroy_seqid_counter(&lsp->ls_seqid);
897 * Return a compatible lock_state. If no initialized lock_state structure
898 * exists, return an uninitialized one.
901 static struct nfs4_lock_state *nfs4_get_lock_state(struct nfs4_state *state, fl_owner_t owner)
903 struct nfs4_lock_state *lsp, *new = NULL;
906 spin_lock(&state->state_lock);
907 lsp = __nfs4_find_lock_state(state, owner, NULL);
911 list_add(&new->ls_locks, &state->lock_states);
912 set_bit(LK_STATE_IN_USE, &state->flags);
917 spin_unlock(&state->state_lock);
918 new = nfs4_alloc_lock_state(state, owner);
922 spin_unlock(&state->state_lock);
924 nfs4_free_lock_state(state->owner->so_server, new);
929 * Release reference to lock_state, and free it if we see that
930 * it is no longer in use
932 void nfs4_put_lock_state(struct nfs4_lock_state *lsp)
934 struct nfs_server *server;
935 struct nfs4_state *state;
939 state = lsp->ls_state;
940 if (!refcount_dec_and_lock(&lsp->ls_count, &state->state_lock))
942 list_del(&lsp->ls_locks);
943 if (list_empty(&state->lock_states))
944 clear_bit(LK_STATE_IN_USE, &state->flags);
945 spin_unlock(&state->state_lock);
946 server = state->owner->so_server;
947 if (test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags)) {
948 struct nfs_client *clp = server->nfs_client;
950 clp->cl_mvops->free_lock_state(server, lsp);
952 nfs4_free_lock_state(server, lsp);
955 static void nfs4_fl_copy_lock(struct file_lock *dst, struct file_lock *src)
957 struct nfs4_lock_state *lsp = src->fl_u.nfs4_fl.owner;
959 dst->fl_u.nfs4_fl.owner = lsp;
960 refcount_inc(&lsp->ls_count);
963 static void nfs4_fl_release_lock(struct file_lock *fl)
965 nfs4_put_lock_state(fl->fl_u.nfs4_fl.owner);
968 static const struct file_lock_operations nfs4_fl_lock_ops = {
969 .fl_copy_lock = nfs4_fl_copy_lock,
970 .fl_release_private = nfs4_fl_release_lock,
973 int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl)
975 struct nfs4_lock_state *lsp;
977 if (fl->fl_ops != NULL)
979 lsp = nfs4_get_lock_state(state, fl->fl_owner);
982 fl->fl_u.nfs4_fl.owner = lsp;
983 fl->fl_ops = &nfs4_fl_lock_ops;
987 static int nfs4_copy_lock_stateid(nfs4_stateid *dst,
988 struct nfs4_state *state,
989 const struct nfs_lock_context *l_ctx)
991 struct nfs4_lock_state *lsp;
992 fl_owner_t fl_owner, fl_flock_owner;
998 if (test_bit(LK_STATE_IN_USE, &state->flags) == 0)
1001 fl_owner = l_ctx->lockowner;
1002 fl_flock_owner = l_ctx->open_context->flock_owner;
1004 spin_lock(&state->state_lock);
1005 lsp = __nfs4_find_lock_state(state, fl_owner, fl_flock_owner);
1006 if (lsp && test_bit(NFS_LOCK_LOST, &lsp->ls_flags))
1008 else if (lsp != NULL && test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags) != 0) {
1009 nfs4_stateid_copy(dst, &lsp->ls_stateid);
1012 spin_unlock(&state->state_lock);
1013 nfs4_put_lock_state(lsp);
1018 bool nfs4_copy_open_stateid(nfs4_stateid *dst, struct nfs4_state *state)
1021 const nfs4_stateid *src;
1026 src = &zero_stateid;
1027 seq = read_seqbegin(&state->seqlock);
1028 if (test_bit(NFS_OPEN_STATE, &state->flags)) {
1029 src = &state->open_stateid;
1032 nfs4_stateid_copy(dst, src);
1033 } while (read_seqretry(&state->seqlock, seq));
1038 * Byte-range lock aware utility to initialize the stateid of read/write
1041 int nfs4_select_rw_stateid(struct nfs4_state *state,
1042 fmode_t fmode, const struct nfs_lock_context *l_ctx,
1043 nfs4_stateid *dst, const struct cred **cred)
1047 if (!nfs4_valid_open_stateid(state))
1051 ret = nfs4_copy_lock_stateid(dst, state, l_ctx);
1053 /* A lost lock - don't even consider delegations */
1055 /* returns true if delegation stateid found and copied */
1056 if (nfs4_copy_delegation_stateid(state->inode, fmode, dst, cred)) {
1061 /* nfs4_copy_delegation_stateid() didn't over-write
1062 * dst, so it still has the lock stateid which we now
1066 ret = nfs4_copy_open_stateid(dst, state) ? 0 : -EAGAIN;
1068 if (nfs_server_capable(state->inode, NFS_CAP_STATEID_NFSV41))
1073 struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask)
1075 struct nfs_seqid *new;
1077 new = kmalloc(sizeof(*new), gfp_mask);
1079 return ERR_PTR(-ENOMEM);
1080 new->sequence = counter;
1081 INIT_LIST_HEAD(&new->list);
1086 void nfs_release_seqid(struct nfs_seqid *seqid)
1088 struct nfs_seqid_counter *sequence;
1090 if (seqid == NULL || list_empty(&seqid->list))
1092 sequence = seqid->sequence;
1093 spin_lock(&sequence->lock);
1094 list_del_init(&seqid->list);
1095 if (!list_empty(&sequence->list)) {
1096 struct nfs_seqid *next;
1098 next = list_first_entry(&sequence->list,
1099 struct nfs_seqid, list);
1100 rpc_wake_up_queued_task(&sequence->wait, next->task);
1102 spin_unlock(&sequence->lock);
1105 void nfs_free_seqid(struct nfs_seqid *seqid)
1107 nfs_release_seqid(seqid);
1112 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
1113 * failed with a seqid incrementing error -
1114 * see comments nfs4.h:seqid_mutating_error()
1116 static void nfs_increment_seqid(int status, struct nfs_seqid *seqid)
1121 case -NFS4ERR_BAD_SEQID:
1122 if (seqid->sequence->flags & NFS_SEQID_CONFIRMED)
1124 pr_warn_ratelimited("NFS: v4 server returned a bad"
1125 " sequence-id error on an"
1126 " unconfirmed sequence %p!\n",
1129 case -NFS4ERR_STALE_CLIENTID:
1130 case -NFS4ERR_STALE_STATEID:
1131 case -NFS4ERR_BAD_STATEID:
1132 case -NFS4ERR_BADXDR:
1133 case -NFS4ERR_RESOURCE:
1134 case -NFS4ERR_NOFILEHANDLE:
1135 case -NFS4ERR_MOVED:
1136 /* Non-seqid mutating errors */
1140 * Note: no locking needed as we are guaranteed to be first
1141 * on the sequence list
1143 seqid->sequence->counter++;
1146 void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid)
1148 struct nfs4_state_owner *sp;
1153 sp = container_of(seqid->sequence, struct nfs4_state_owner, so_seqid);
1154 if (status == -NFS4ERR_BAD_SEQID)
1155 nfs4_reset_state_owner(sp);
1156 if (!nfs4_has_session(sp->so_server->nfs_client))
1157 nfs_increment_seqid(status, seqid);
1161 * Increment the seqid if the LOCK/LOCKU succeeded, or
1162 * failed with a seqid incrementing error -
1163 * see comments nfs4.h:seqid_mutating_error()
1165 void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid)
1168 nfs_increment_seqid(status, seqid);
1171 int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task)
1173 struct nfs_seqid_counter *sequence;
1178 sequence = seqid->sequence;
1179 spin_lock(&sequence->lock);
1181 if (list_empty(&seqid->list))
1182 list_add_tail(&seqid->list, &sequence->list);
1183 if (list_first_entry(&sequence->list, struct nfs_seqid, list) == seqid)
1185 rpc_sleep_on(&sequence->wait, task, NULL);
1188 spin_unlock(&sequence->lock);
1193 static int nfs4_run_state_manager(void *);
1195 static void nfs4_clear_state_manager_bit(struct nfs_client *clp)
1197 clear_and_wake_up_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
1198 rpc_wake_up(&clp->cl_rpcwaitq);
1202 * Schedule the nfs_client asynchronous state management routine
1204 void nfs4_schedule_state_manager(struct nfs_client *clp)
1206 struct task_struct *task;
1207 char buf[INET6_ADDRSTRLEN + sizeof("-manager") + 1];
1208 struct rpc_clnt *cl = clp->cl_rpcclient;
1210 while (cl != cl->cl_parent)
1213 set_bit(NFS4CLNT_RUN_MANAGER, &clp->cl_state);
1214 if (test_and_set_bit(NFS4CLNT_MANAGER_AVAILABLE, &clp->cl_state) != 0) {
1215 wake_up_var(&clp->cl_state);
1218 set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
1219 __module_get(THIS_MODULE);
1220 refcount_inc(&clp->cl_count);
1222 /* The rcu_read_lock() is not strictly necessary, as the state
1223 * manager is the only thread that ever changes the rpc_xprt
1224 * after it's initialized. At this point, we're single threaded. */
1226 snprintf(buf, sizeof(buf), "%s-manager",
1227 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_ADDR));
1229 task = kthread_run(nfs4_run_state_manager, clp, "%s", buf);
1231 printk(KERN_ERR "%s: kthread_run: %ld\n",
1232 __func__, PTR_ERR(task));
1233 nfs4_clear_state_manager_bit(clp);
1234 clear_bit(NFS4CLNT_MANAGER_AVAILABLE, &clp->cl_state);
1235 nfs_put_client(clp);
1236 module_put(THIS_MODULE);
1241 * Schedule a lease recovery attempt
1243 void nfs4_schedule_lease_recovery(struct nfs_client *clp)
1247 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1248 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1249 dprintk("%s: scheduling lease recovery for server %s\n", __func__,
1251 nfs4_schedule_state_manager(clp);
1253 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_recovery);
1256 * nfs4_schedule_migration_recovery - trigger migration recovery
1258 * @server: FSID that is migrating
1260 * Returns zero if recovery has started, otherwise a negative NFS4ERR
1261 * value is returned.
1263 int nfs4_schedule_migration_recovery(const struct nfs_server *server)
1265 struct nfs_client *clp = server->nfs_client;
1267 if (server->fh_expire_type != NFS4_FH_PERSISTENT) {
1268 pr_err("NFS: volatile file handles not supported (server %s)\n",
1273 if (test_bit(NFS_MIG_FAILED, &server->mig_status))
1276 dprintk("%s: scheduling migration recovery for (%llx:%llx) on %s\n",
1278 (unsigned long long)server->fsid.major,
1279 (unsigned long long)server->fsid.minor,
1282 set_bit(NFS_MIG_IN_TRANSITION,
1283 &((struct nfs_server *)server)->mig_status);
1284 set_bit(NFS4CLNT_MOVED, &clp->cl_state);
1286 nfs4_schedule_state_manager(clp);
1289 EXPORT_SYMBOL_GPL(nfs4_schedule_migration_recovery);
1292 * nfs4_schedule_lease_moved_recovery - start lease-moved recovery
1294 * @clp: server to check for moved leases
1297 void nfs4_schedule_lease_moved_recovery(struct nfs_client *clp)
1299 dprintk("%s: scheduling lease-moved recovery for client ID %llx on %s\n",
1300 __func__, clp->cl_clientid, clp->cl_hostname);
1302 set_bit(NFS4CLNT_LEASE_MOVED, &clp->cl_state);
1303 nfs4_schedule_state_manager(clp);
1305 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_moved_recovery);
1307 int nfs4_wait_clnt_recover(struct nfs_client *clp)
1313 refcount_inc(&clp->cl_count);
1314 res = wait_on_bit_action(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING,
1315 nfs_wait_bit_killable,
1316 TASK_KILLABLE|TASK_FREEZABLE_UNSAFE);
1319 if (clp->cl_cons_state < 0)
1320 res = clp->cl_cons_state;
1322 nfs_put_client(clp);
1326 int nfs4_client_recover_expired_lease(struct nfs_client *clp)
1331 for (loop = NFS4_MAX_LOOP_ON_RECOVER; loop != 0; loop--) {
1332 ret = nfs4_wait_clnt_recover(clp);
1335 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) &&
1336 !test_bit(NFS4CLNT_CHECK_LEASE,&clp->cl_state))
1338 nfs4_schedule_state_manager(clp);
1345 * nfs40_handle_cb_pathdown - return all delegations after NFS4ERR_CB_PATH_DOWN
1346 * @clp: client to process
1348 * Set the NFS4CLNT_LEASE_EXPIRED state in order to force a
1349 * resend of the SETCLIENTID and hence re-establish the
1350 * callback channel. Then return all existing delegations.
1352 static void nfs40_handle_cb_pathdown(struct nfs_client *clp)
1354 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1355 nfs_expire_all_delegations(clp);
1356 dprintk("%s: handling CB_PATHDOWN recovery for server %s\n", __func__,
1360 void nfs4_schedule_path_down_recovery(struct nfs_client *clp)
1362 nfs40_handle_cb_pathdown(clp);
1363 nfs4_schedule_state_manager(clp);
1366 static int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state)
1369 if (!nfs4_valid_open_stateid(state))
1371 set_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1372 /* Don't recover state that expired before the reboot */
1373 if (test_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags)) {
1374 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1377 set_bit(NFS_OWNER_RECLAIM_REBOOT, &state->owner->so_flags);
1378 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1382 int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state)
1384 if (!nfs4_valid_open_stateid(state))
1386 set_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags);
1387 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1388 set_bit(NFS_OWNER_RECLAIM_NOGRACE, &state->owner->so_flags);
1389 set_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state);
1393 int nfs4_schedule_stateid_recovery(const struct nfs_server *server, struct nfs4_state *state)
1395 struct nfs_client *clp = server->nfs_client;
1397 if (!nfs4_state_mark_reclaim_nograce(clp, state))
1399 nfs_inode_find_delegation_state_and_recover(state->inode,
1401 dprintk("%s: scheduling stateid recovery for server %s\n", __func__,
1403 nfs4_schedule_state_manager(clp);
1406 EXPORT_SYMBOL_GPL(nfs4_schedule_stateid_recovery);
1408 static struct nfs4_lock_state *
1409 nfs_state_find_lock_state_by_stateid(struct nfs4_state *state,
1410 const nfs4_stateid *stateid)
1412 struct nfs4_lock_state *pos;
1414 list_for_each_entry(pos, &state->lock_states, ls_locks) {
1415 if (!test_bit(NFS_LOCK_INITIALIZED, &pos->ls_flags))
1417 if (nfs4_stateid_match_or_older(&pos->ls_stateid, stateid))
1423 static bool nfs_state_lock_state_matches_stateid(struct nfs4_state *state,
1424 const nfs4_stateid *stateid)
1428 if (test_bit(LK_STATE_IN_USE, &state->flags)) {
1429 spin_lock(&state->state_lock);
1430 if (nfs_state_find_lock_state_by_stateid(state, stateid))
1432 spin_unlock(&state->state_lock);
1437 void nfs_inode_find_state_and_recover(struct inode *inode,
1438 const nfs4_stateid *stateid)
1440 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1441 struct nfs_inode *nfsi = NFS_I(inode);
1442 struct nfs_open_context *ctx;
1443 struct nfs4_state *state;
1447 list_for_each_entry_rcu(ctx, &nfsi->open_files, list) {
1451 if (nfs4_stateid_match_or_older(&state->stateid, stateid) &&
1452 nfs4_state_mark_reclaim_nograce(clp, state)) {
1456 if (test_bit(NFS_OPEN_STATE, &state->flags) &&
1457 nfs4_stateid_match_or_older(&state->open_stateid, stateid) &&
1458 nfs4_state_mark_reclaim_nograce(clp, state)) {
1462 if (nfs_state_lock_state_matches_stateid(state, stateid) &&
1463 nfs4_state_mark_reclaim_nograce(clp, state))
1468 nfs_inode_find_delegation_state_and_recover(inode, stateid);
1470 nfs4_schedule_state_manager(clp);
1473 static void nfs4_state_mark_open_context_bad(struct nfs4_state *state, int err)
1475 struct inode *inode = state->inode;
1476 struct nfs_inode *nfsi = NFS_I(inode);
1477 struct nfs_open_context *ctx;
1480 list_for_each_entry_rcu(ctx, &nfsi->open_files, list) {
1481 if (ctx->state != state)
1483 set_bit(NFS_CONTEXT_BAD, &ctx->flags);
1484 pr_warn("NFSv4: state recovery failed for open file %pd2, "
1485 "error = %d\n", ctx->dentry, err);
1490 static void nfs4_state_mark_recovery_failed(struct nfs4_state *state, int error)
1492 set_bit(NFS_STATE_RECOVERY_FAILED, &state->flags);
1493 nfs4_state_mark_open_context_bad(state, error);
1497 static int nfs4_reclaim_locks(struct nfs4_state *state, const struct nfs4_state_recovery_ops *ops)
1499 struct inode *inode = state->inode;
1500 struct nfs_inode *nfsi = NFS_I(inode);
1501 struct file_lock *fl;
1502 struct nfs4_lock_state *lsp;
1504 struct file_lock_context *flctx = inode->i_flctx;
1505 struct list_head *list;
1510 list = &flctx->flc_posix;
1512 /* Guard against delegation returns and new lock/unlock calls */
1513 down_write(&nfsi->rwsem);
1514 spin_lock(&flctx->flc_lock);
1516 list_for_each_entry(fl, list, fl_list) {
1517 if (nfs_file_open_context(fl->fl_file)->state != state)
1519 spin_unlock(&flctx->flc_lock);
1520 status = ops->recover_lock(state, fl);
1526 case -NFS4ERR_ADMIN_REVOKED:
1527 case -NFS4ERR_STALE_STATEID:
1528 case -NFS4ERR_BAD_STATEID:
1529 case -NFS4ERR_EXPIRED:
1530 case -NFS4ERR_NO_GRACE:
1531 case -NFS4ERR_STALE_CLIENTID:
1532 case -NFS4ERR_BADSESSION:
1533 case -NFS4ERR_BADSLOT:
1534 case -NFS4ERR_BAD_HIGH_SLOT:
1535 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1538 pr_err("NFS: %s: unhandled error %d\n",
1542 case -NFS4ERR_DENIED:
1543 case -NFS4ERR_RECLAIM_BAD:
1544 case -NFS4ERR_RECLAIM_CONFLICT:
1545 lsp = fl->fl_u.nfs4_fl.owner;
1547 set_bit(NFS_LOCK_LOST, &lsp->ls_flags);
1550 spin_lock(&flctx->flc_lock);
1552 if (list == &flctx->flc_posix) {
1553 list = &flctx->flc_flock;
1556 spin_unlock(&flctx->flc_lock);
1558 up_write(&nfsi->rwsem);
1562 #ifdef CONFIG_NFS_V4_2
1563 static void nfs42_complete_copies(struct nfs4_state_owner *sp, struct nfs4_state *state)
1565 struct nfs4_copy_state *copy;
1567 if (!test_bit(NFS_CLNT_DST_SSC_COPY_STATE, &state->flags) &&
1568 !test_bit(NFS_CLNT_SRC_SSC_COPY_STATE, &state->flags))
1571 spin_lock(&sp->so_server->nfs_client->cl_lock);
1572 list_for_each_entry(copy, &sp->so_server->ss_copies, copies) {
1573 if ((test_bit(NFS_CLNT_DST_SSC_COPY_STATE, &state->flags) &&
1574 !nfs4_stateid_match_other(&state->stateid,
1575 ©->parent_dst_state->stateid)))
1578 if (test_and_clear_bit(NFS_CLNT_DST_SSC_COPY_STATE,
1580 clear_bit(NFS_CLNT_SRC_SSC_COPY_STATE, &state->flags);
1581 complete(©->completion);
1584 list_for_each_entry(copy, &sp->so_server->ss_copies, src_copies) {
1585 if ((test_bit(NFS_CLNT_SRC_SSC_COPY_STATE, &state->flags) &&
1586 !nfs4_stateid_match_other(&state->stateid,
1587 ©->parent_src_state->stateid)))
1590 if (test_and_clear_bit(NFS_CLNT_DST_SSC_COPY_STATE,
1592 complete(©->completion);
1594 spin_unlock(&sp->so_server->nfs_client->cl_lock);
1596 #else /* !CONFIG_NFS_V4_2 */
1597 static inline void nfs42_complete_copies(struct nfs4_state_owner *sp,
1598 struct nfs4_state *state)
1601 #endif /* CONFIG_NFS_V4_2 */
1603 static int __nfs4_reclaim_open_state(struct nfs4_state_owner *sp, struct nfs4_state *state,
1604 const struct nfs4_state_recovery_ops *ops,
1607 struct nfs4_lock_state *lock;
1610 status = ops->recover_open(sp, state);
1614 status = nfs4_reclaim_locks(state, ops);
1618 if (!test_bit(NFS_DELEGATED_STATE, &state->flags)) {
1619 spin_lock(&state->state_lock);
1620 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1621 trace_nfs4_state_lock_reclaim(state, lock);
1622 if (!test_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags))
1625 spin_unlock(&state->state_lock);
1628 nfs42_complete_copies(sp, state);
1629 clear_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags);
1633 static int nfs4_reclaim_open_state(struct nfs4_state_owner *sp,
1634 const struct nfs4_state_recovery_ops *ops,
1637 struct nfs4_state *state;
1638 unsigned int loop = 0;
1640 #ifdef CONFIG_NFS_V4_2
1641 bool found_ssc_copy_state = false;
1642 #endif /* CONFIG_NFS_V4_2 */
1644 /* Note: we rely on the sp->so_states list being ordered
1645 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
1647 * This is needed to ensure that the server won't give us any
1648 * read delegations that we have to return if, say, we are
1649 * recovering after a network partition or a reboot from a
1650 * server that doesn't support a grace period.
1652 spin_lock(&sp->so_lock);
1653 raw_write_seqcount_begin(&sp->so_reclaim_seqcount);
1655 list_for_each_entry(state, &sp->so_states, open_states) {
1656 if (!test_and_clear_bit(ops->state_flag_bit, &state->flags))
1658 if (!nfs4_valid_open_stateid(state))
1660 if (state->state == 0)
1662 #ifdef CONFIG_NFS_V4_2
1663 if (test_bit(NFS_SRV_SSC_COPY_STATE, &state->flags)) {
1664 nfs4_state_mark_recovery_failed(state, -EIO);
1665 found_ssc_copy_state = true;
1668 #endif /* CONFIG_NFS_V4_2 */
1669 refcount_inc(&state->count);
1670 spin_unlock(&sp->so_lock);
1671 status = __nfs4_reclaim_open_state(sp, state, ops, lost_locks);
1679 printk(KERN_ERR "NFS: %s: unhandled error %d\n", __func__, status);
1687 /* Open state on this file cannot be recovered */
1688 nfs4_state_mark_recovery_failed(state, status);
1693 set_bit(ops->state_flag_bit, &state->flags);
1697 case -NFS4ERR_ADMIN_REVOKED:
1698 case -NFS4ERR_STALE_STATEID:
1699 case -NFS4ERR_OLD_STATEID:
1700 case -NFS4ERR_BAD_STATEID:
1701 case -NFS4ERR_RECLAIM_BAD:
1702 case -NFS4ERR_RECLAIM_CONFLICT:
1703 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1705 case -NFS4ERR_EXPIRED:
1706 case -NFS4ERR_NO_GRACE:
1707 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1709 case -NFS4ERR_STALE_CLIENTID:
1710 case -NFS4ERR_BADSESSION:
1711 case -NFS4ERR_BADSLOT:
1712 case -NFS4ERR_BAD_HIGH_SLOT:
1713 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1717 nfs4_put_open_state(state);
1718 spin_lock(&sp->so_lock);
1721 raw_write_seqcount_end(&sp->so_reclaim_seqcount);
1722 spin_unlock(&sp->so_lock);
1723 #ifdef CONFIG_NFS_V4_2
1724 if (found_ssc_copy_state)
1726 #endif /* CONFIG_NFS_V4_2 */
1729 nfs4_put_open_state(state);
1730 spin_lock(&sp->so_lock);
1731 raw_write_seqcount_end(&sp->so_reclaim_seqcount);
1732 spin_unlock(&sp->so_lock);
1736 static void nfs4_clear_open_state(struct nfs4_state *state)
1738 struct nfs4_lock_state *lock;
1740 clear_bit(NFS_DELEGATED_STATE, &state->flags);
1741 clear_bit(NFS_O_RDONLY_STATE, &state->flags);
1742 clear_bit(NFS_O_WRONLY_STATE, &state->flags);
1743 clear_bit(NFS_O_RDWR_STATE, &state->flags);
1744 spin_lock(&state->state_lock);
1745 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1746 lock->ls_seqid.flags = 0;
1747 clear_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags);
1749 spin_unlock(&state->state_lock);
1752 static void nfs4_reset_seqids(struct nfs_server *server,
1753 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1755 struct nfs_client *clp = server->nfs_client;
1756 struct nfs4_state_owner *sp;
1757 struct rb_node *pos;
1758 struct nfs4_state *state;
1760 spin_lock(&clp->cl_lock);
1761 for (pos = rb_first(&server->state_owners);
1763 pos = rb_next(pos)) {
1764 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1765 sp->so_seqid.flags = 0;
1766 spin_lock(&sp->so_lock);
1767 list_for_each_entry(state, &sp->so_states, open_states) {
1768 if (mark_reclaim(clp, state))
1769 nfs4_clear_open_state(state);
1771 spin_unlock(&sp->so_lock);
1773 spin_unlock(&clp->cl_lock);
1776 static void nfs4_state_mark_reclaim_helper(struct nfs_client *clp,
1777 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1779 struct nfs_server *server;
1782 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1783 nfs4_reset_seqids(server, mark_reclaim);
1787 static void nfs4_state_start_reclaim_reboot(struct nfs_client *clp)
1789 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1790 /* Mark all delegations for reclaim */
1791 nfs_delegation_mark_reclaim(clp);
1792 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_reboot);
1795 static int nfs4_reclaim_complete(struct nfs_client *clp,
1796 const struct nfs4_state_recovery_ops *ops,
1797 const struct cred *cred)
1799 /* Notify the server we're done reclaiming our state */
1800 if (ops->reclaim_complete)
1801 return ops->reclaim_complete(clp, cred);
1805 static void nfs4_clear_reclaim_server(struct nfs_server *server)
1807 struct nfs_client *clp = server->nfs_client;
1808 struct nfs4_state_owner *sp;
1809 struct rb_node *pos;
1810 struct nfs4_state *state;
1812 spin_lock(&clp->cl_lock);
1813 for (pos = rb_first(&server->state_owners);
1815 pos = rb_next(pos)) {
1816 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1817 spin_lock(&sp->so_lock);
1818 list_for_each_entry(state, &sp->so_states, open_states) {
1819 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT,
1822 nfs4_state_mark_reclaim_nograce(clp, state);
1824 spin_unlock(&sp->so_lock);
1826 spin_unlock(&clp->cl_lock);
1829 static int nfs4_state_clear_reclaim_reboot(struct nfs_client *clp)
1831 struct nfs_server *server;
1833 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
1837 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1838 nfs4_clear_reclaim_server(server);
1841 nfs_delegation_reap_unclaimed(clp);
1845 static void nfs4_state_end_reclaim_reboot(struct nfs_client *clp)
1847 const struct nfs4_state_recovery_ops *ops;
1848 const struct cred *cred;
1851 if (!nfs4_state_clear_reclaim_reboot(clp))
1853 ops = clp->cl_mvops->reboot_recovery_ops;
1854 cred = nfs4_get_clid_cred(clp);
1855 err = nfs4_reclaim_complete(clp, ops, cred);
1857 if (err == -NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
1858 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1861 static void nfs4_state_start_reclaim_nograce(struct nfs_client *clp)
1863 nfs_mark_test_expired_all_delegations(clp);
1864 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_nograce);
1867 static int nfs4_recovery_handle_error(struct nfs_client *clp, int error)
1872 case -NFS4ERR_CB_PATH_DOWN:
1873 nfs40_handle_cb_pathdown(clp);
1875 case -NFS4ERR_NO_GRACE:
1876 nfs4_state_end_reclaim_reboot(clp);
1878 case -NFS4ERR_STALE_CLIENTID:
1879 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1880 nfs4_state_start_reclaim_reboot(clp);
1882 case -NFS4ERR_EXPIRED:
1883 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1884 nfs4_state_start_reclaim_nograce(clp);
1886 case -NFS4ERR_BADSESSION:
1887 case -NFS4ERR_BADSLOT:
1888 case -NFS4ERR_BAD_HIGH_SLOT:
1889 case -NFS4ERR_DEADSESSION:
1890 case -NFS4ERR_SEQ_FALSE_RETRY:
1891 case -NFS4ERR_SEQ_MISORDERED:
1892 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1893 /* Zero session reset errors */
1895 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1896 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1899 dprintk("%s: failed to handle error %d for server %s\n",
1900 __func__, error, clp->cl_hostname);
1903 dprintk("%s: handled error %d for server %s\n", __func__, error,
1908 static int nfs4_do_reclaim(struct nfs_client *clp, const struct nfs4_state_recovery_ops *ops)
1910 struct nfs4_state_owner *sp;
1911 struct nfs_server *server;
1912 struct rb_node *pos;
1919 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1920 nfs4_purge_state_owners(server, &freeme);
1921 spin_lock(&clp->cl_lock);
1922 for (pos = rb_first(&server->state_owners);
1924 pos = rb_next(pos)) {
1926 struct nfs4_state_owner, so_server_node);
1927 if (!test_and_clear_bit(ops->owner_flag_bit,
1930 if (!atomic_inc_not_zero(&sp->so_count))
1932 spin_unlock(&clp->cl_lock);
1935 status = nfs4_reclaim_open_state(sp, ops, &lost_locks);
1938 pr_warn("NFS: %s: lost %d locks\n",
1939 clp->cl_hostname, lost_locks);
1940 set_bit(ops->owner_flag_bit, &sp->so_flags);
1941 nfs4_put_state_owner(sp);
1942 status = nfs4_recovery_handle_error(clp, status);
1943 return (status != 0) ? status : -EAGAIN;
1946 nfs4_put_state_owner(sp);
1949 spin_unlock(&clp->cl_lock);
1952 nfs4_free_state_owners(&freeme);
1954 pr_warn("NFS: %s: lost %d locks\n",
1955 clp->cl_hostname, lost_locks);
1959 static int nfs4_check_lease(struct nfs_client *clp)
1961 const struct cred *cred;
1962 const struct nfs4_state_maintenance_ops *ops =
1963 clp->cl_mvops->state_renewal_ops;
1966 /* Is the client already known to have an expired lease? */
1967 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1969 cred = ops->get_state_renewal_cred(clp);
1971 cred = nfs4_get_clid_cred(clp);
1976 status = ops->renew_lease(clp, cred);
1978 if (status == -ETIMEDOUT) {
1979 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1983 return nfs4_recovery_handle_error(clp, status);
1986 /* Set NFS4CLNT_LEASE_EXPIRED and reclaim reboot state for all v4.0 errors
1987 * and for recoverable errors on EXCHANGE_ID for v4.1
1989 static int nfs4_handle_reclaim_lease_error(struct nfs_client *clp, int status)
1992 case -NFS4ERR_SEQ_MISORDERED:
1993 if (test_and_set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state))
1994 return -ESERVERFAULT;
1995 /* Lease confirmation error: retry after purging the lease */
1997 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1999 case -NFS4ERR_STALE_CLIENTID:
2000 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
2001 nfs4_state_start_reclaim_reboot(clp);
2003 case -NFS4ERR_CLID_INUSE:
2004 pr_err("NFS: Server %s reports our clientid is in use\n",
2006 nfs_mark_client_ready(clp, -EPERM);
2007 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
2010 case -NFS4ERR_DELAY:
2015 case -NFS4ERR_MINOR_VERS_MISMATCH:
2016 if (clp->cl_cons_state == NFS_CS_SESSION_INITING)
2017 nfs_mark_client_ready(clp, -EPROTONOSUPPORT);
2018 dprintk("%s: exit with error %d for server %s\n",
2019 __func__, -EPROTONOSUPPORT, clp->cl_hostname);
2020 return -EPROTONOSUPPORT;
2022 if (clp->cl_cons_state == NFS_CS_SESSION_INITING)
2023 nfs_mark_client_ready(clp, -EIO);
2025 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
2026 * in nfs4_exchange_id */
2028 dprintk("%s: exit with error %d for server %s\n", __func__,
2029 status, clp->cl_hostname);
2032 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
2033 dprintk("%s: handled error %d for server %s\n", __func__, status,
2038 static int nfs4_establish_lease(struct nfs_client *clp)
2040 const struct cred *cred;
2041 const struct nfs4_state_recovery_ops *ops =
2042 clp->cl_mvops->reboot_recovery_ops;
2045 status = nfs4_begin_drain_session(clp);
2048 cred = nfs4_get_clid_cred(clp);
2051 status = ops->establish_clid(clp, cred);
2055 pnfs_destroy_all_layouts(clp);
2060 * Returns zero or a negative errno. NFS4ERR values are converted
2061 * to local errno values.
2063 static int nfs4_reclaim_lease(struct nfs_client *clp)
2067 status = nfs4_establish_lease(clp);
2069 return nfs4_handle_reclaim_lease_error(clp, status);
2070 if (test_and_clear_bit(NFS4CLNT_SERVER_SCOPE_MISMATCH, &clp->cl_state))
2071 nfs4_state_start_reclaim_nograce(clp);
2072 if (!test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
2073 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
2074 clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
2075 clear_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
2079 static int nfs4_purge_lease(struct nfs_client *clp)
2083 status = nfs4_establish_lease(clp);
2085 return nfs4_handle_reclaim_lease_error(clp, status);
2086 clear_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
2087 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
2088 nfs4_state_start_reclaim_nograce(clp);
2093 * Try remote migration of one FSID from a source server to a
2094 * destination server. The source server provides a list of
2095 * potential destinations.
2097 * Returns zero or a negative NFS4ERR status code.
2099 static int nfs4_try_migration(struct nfs_server *server, const struct cred *cred)
2101 struct nfs_client *clp = server->nfs_client;
2102 struct nfs4_fs_locations *locations = NULL;
2103 struct inode *inode;
2107 dprintk("--> %s: FSID %llx:%llx on \"%s\"\n", __func__,
2108 (unsigned long long)server->fsid.major,
2109 (unsigned long long)server->fsid.minor,
2113 page = alloc_page(GFP_KERNEL);
2114 locations = kmalloc(sizeof(struct nfs4_fs_locations), GFP_KERNEL);
2115 if (page == NULL || locations == NULL) {
2116 dprintk("<-- %s: no memory\n", __func__);
2119 locations->fattr = nfs_alloc_fattr();
2120 if (locations->fattr == NULL) {
2121 dprintk("<-- %s: no memory\n", __func__);
2125 inode = d_inode(server->super->s_root);
2126 result = nfs4_proc_get_locations(server, NFS_FH(inode), locations,
2129 dprintk("<-- %s: failed to retrieve fs_locations: %d\n",
2134 result = -NFS4ERR_NXIO;
2135 if (!locations->nlocations)
2138 if (!(locations->fattr->valid & NFS_ATTR_FATTR_V4_LOCATIONS)) {
2139 dprintk("<-- %s: No fs_locations data, migration skipped\n",
2144 status = nfs4_begin_drain_session(clp);
2150 status = nfs4_replace_transport(server, locations);
2152 dprintk("<-- %s: failed to replace transport: %d\n",
2158 dprintk("<-- %s: migration succeeded\n", __func__);
2163 if (locations != NULL)
2164 kfree(locations->fattr);
2167 pr_err("NFS: migration recovery failed (server %s)\n",
2169 set_bit(NFS_MIG_FAILED, &server->mig_status);
2175 * Returns zero or a negative NFS4ERR status code.
2177 static int nfs4_handle_migration(struct nfs_client *clp)
2179 const struct nfs4_state_maintenance_ops *ops =
2180 clp->cl_mvops->state_renewal_ops;
2181 struct nfs_server *server;
2182 const struct cred *cred;
2184 dprintk("%s: migration reported on \"%s\"\n", __func__,
2187 cred = ops->get_state_renewal_cred(clp);
2189 return -NFS4ERR_NOENT;
2194 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
2197 if (server->mig_gen == clp->cl_mig_gen)
2199 server->mig_gen = clp->cl_mig_gen;
2201 if (!test_and_clear_bit(NFS_MIG_IN_TRANSITION,
2202 &server->mig_status))
2206 status = nfs4_try_migration(server, cred);
2219 * Test each nfs_server on the clp's cl_superblocks list to see
2220 * if it's moved to another server. Stop when the server no longer
2221 * returns NFS4ERR_LEASE_MOVED.
2223 static int nfs4_handle_lease_moved(struct nfs_client *clp)
2225 const struct nfs4_state_maintenance_ops *ops =
2226 clp->cl_mvops->state_renewal_ops;
2227 struct nfs_server *server;
2228 const struct cred *cred;
2230 dprintk("%s: lease moved reported on \"%s\"\n", __func__,
2233 cred = ops->get_state_renewal_cred(clp);
2235 return -NFS4ERR_NOENT;
2240 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
2241 struct inode *inode;
2244 if (server->mig_gen == clp->cl_mig_gen)
2246 server->mig_gen = clp->cl_mig_gen;
2250 inode = d_inode(server->super->s_root);
2251 status = nfs4_proc_fsid_present(inode, cred);
2252 if (status != -NFS4ERR_MOVED)
2253 goto restart; /* wasn't this one */
2254 if (nfs4_try_migration(server, cred) == -NFS4ERR_LEASE_MOVED)
2255 goto restart; /* there are more */
2266 * nfs4_discover_server_trunking - Detect server IP address trunking
2268 * @clp: nfs_client under test
2269 * @result: OUT: found nfs_client, or clp
2271 * Returns zero or a negative errno. If zero is returned,
2272 * an nfs_client pointer is planted in "result".
2274 * Note: since we are invoked in process context, and
2275 * not from inside the state manager, we cannot use
2276 * nfs4_handle_reclaim_lease_error().
2278 int nfs4_discover_server_trunking(struct nfs_client *clp,
2279 struct nfs_client **result)
2281 const struct nfs4_state_recovery_ops *ops =
2282 clp->cl_mvops->reboot_recovery_ops;
2283 struct rpc_clnt *clnt;
2284 const struct cred *cred;
2287 dprintk("NFS: %s: testing '%s'\n", __func__, clp->cl_hostname);
2289 clnt = clp->cl_rpcclient;
2292 mutex_lock(&nfs_clid_init_mutex);
2295 cred = nfs4_get_clid_cred(clp);
2299 status = ops->detect_trunking(clp, result, cred);
2307 if (clnt->cl_softrtry)
2310 case -NFS4ERR_DELAY:
2314 case -NFS4ERR_STALE_CLIENTID:
2315 dprintk("NFS: %s after status %d, retrying\n",
2320 nfs4_root_machine_cred(clp);
2323 if (clnt->cl_auth->au_flavor == RPC_AUTH_UNIX)
2326 case -NFS4ERR_CLID_INUSE:
2327 case -NFS4ERR_WRONGSEC:
2328 /* No point in retrying if we already used RPC_AUTH_UNIX */
2329 if (clnt->cl_auth->au_flavor == RPC_AUTH_UNIX) {
2333 clnt = rpc_clone_client_set_auth(clnt, RPC_AUTH_UNIX);
2335 status = PTR_ERR(clnt);
2338 /* Note: this is safe because we haven't yet marked the
2339 * client as ready, so we are the only user of
2342 clnt = xchg(&clp->cl_rpcclient, clnt);
2343 rpc_shutdown_client(clnt);
2344 clnt = clp->cl_rpcclient;
2347 case -NFS4ERR_MINOR_VERS_MISMATCH:
2348 status = -EPROTONOSUPPORT;
2352 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
2353 * in nfs4_exchange_id */
2354 status = -EKEYEXPIRED;
2357 pr_warn("NFS: %s unhandled error %d. Exiting with error EIO\n",
2363 mutex_unlock(&nfs_clid_init_mutex);
2364 dprintk("NFS: %s: status = %d\n", __func__, status);
2368 #ifdef CONFIG_NFS_V4_1
2369 void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
2371 struct nfs_client *clp = session->clp;
2375 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2377 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
2378 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2380 nfs4_schedule_state_manager(clp);
2382 EXPORT_SYMBOL_GPL(nfs4_schedule_session_recovery);
2384 void nfs41_notify_server(struct nfs_client *clp)
2386 /* Use CHECK_LEASE to ping the server with a SEQUENCE */
2387 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
2388 nfs4_schedule_state_manager(clp);
2391 static void nfs4_reset_all_state(struct nfs_client *clp)
2393 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
2394 set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
2395 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
2396 nfs4_state_start_reclaim_nograce(clp);
2397 dprintk("%s: scheduling reset of all state for server %s!\n",
2398 __func__, clp->cl_hostname);
2399 nfs4_schedule_state_manager(clp);
2403 static void nfs41_handle_server_reboot(struct nfs_client *clp)
2405 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
2406 nfs4_state_start_reclaim_reboot(clp);
2407 dprintk("%s: server %s rebooted!\n", __func__,
2409 nfs4_schedule_state_manager(clp);
2413 static void nfs41_handle_all_state_revoked(struct nfs_client *clp)
2415 nfs4_reset_all_state(clp);
2416 dprintk("%s: state revoked on server %s\n", __func__, clp->cl_hostname);
2419 static void nfs41_handle_some_state_revoked(struct nfs_client *clp)
2421 nfs4_state_start_reclaim_nograce(clp);
2422 nfs4_schedule_state_manager(clp);
2424 dprintk("%s: state revoked on server %s\n", __func__, clp->cl_hostname);
2427 static void nfs41_handle_recallable_state_revoked(struct nfs_client *clp)
2429 /* FIXME: For now, we destroy all layouts. */
2430 pnfs_destroy_all_layouts(clp);
2431 nfs_test_expired_all_delegations(clp);
2432 dprintk("%s: Recallable state revoked on server %s!\n", __func__,
2436 static void nfs41_handle_backchannel_fault(struct nfs_client *clp)
2438 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2439 nfs4_schedule_state_manager(clp);
2441 dprintk("%s: server %s declared a backchannel fault\n", __func__,
2445 static void nfs41_handle_cb_path_down(struct nfs_client *clp)
2447 if (test_and_set_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2448 &clp->cl_state) == 0)
2449 nfs4_schedule_state_manager(clp);
2452 void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags,
2458 dprintk("%s: \"%s\" (client ID %llx) flags=0x%08x\n",
2459 __func__, clp->cl_hostname, clp->cl_clientid, flags);
2461 * If we're called from the state manager thread, then assume we're
2462 * already handling the RECLAIM_NEEDED and/or STATE_REVOKED.
2463 * Those flags are expected to remain set until we're done
2464 * recovering (see RFC5661, section 18.46.3).
2469 if (flags & SEQ4_STATUS_RESTART_RECLAIM_NEEDED)
2470 nfs41_handle_server_reboot(clp);
2471 if (flags & (SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED))
2472 nfs41_handle_all_state_revoked(clp);
2473 if (flags & (SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED |
2474 SEQ4_STATUS_ADMIN_STATE_REVOKED))
2475 nfs41_handle_some_state_revoked(clp);
2476 if (flags & SEQ4_STATUS_LEASE_MOVED)
2477 nfs4_schedule_lease_moved_recovery(clp);
2478 if (flags & SEQ4_STATUS_RECALLABLE_STATE_REVOKED)
2479 nfs41_handle_recallable_state_revoked(clp);
2481 if (flags & SEQ4_STATUS_BACKCHANNEL_FAULT)
2482 nfs41_handle_backchannel_fault(clp);
2483 else if (flags & (SEQ4_STATUS_CB_PATH_DOWN |
2484 SEQ4_STATUS_CB_PATH_DOWN_SESSION))
2485 nfs41_handle_cb_path_down(clp);
2488 static int nfs4_reset_session(struct nfs_client *clp)
2490 const struct cred *cred;
2493 if (!nfs4_has_session(clp))
2495 status = nfs4_begin_drain_session(clp);
2498 cred = nfs4_get_clid_cred(clp);
2499 status = nfs4_proc_destroy_session(clp->cl_session, cred);
2502 case -NFS4ERR_BADSESSION:
2503 case -NFS4ERR_DEADSESSION:
2505 case -NFS4ERR_BACK_CHAN_BUSY:
2506 case -NFS4ERR_DELAY:
2507 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2512 status = nfs4_recovery_handle_error(clp, status);
2516 memset(clp->cl_session->sess_id.data, 0, NFS4_MAX_SESSIONID_LEN);
2517 status = nfs4_proc_create_session(clp, cred);
2519 dprintk("%s: session reset failed with status %d for server %s!\n",
2520 __func__, status, clp->cl_hostname);
2521 status = nfs4_handle_reclaim_lease_error(clp, status);
2524 nfs41_finish_session_reset(clp);
2525 dprintk("%s: session reset was successful for server %s!\n",
2526 __func__, clp->cl_hostname);
2532 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2534 const struct cred *cred;
2537 if (!nfs4_has_session(clp))
2539 ret = nfs4_begin_drain_session(clp);
2542 cred = nfs4_get_clid_cred(clp);
2543 ret = nfs4_proc_bind_conn_to_session(clp, cred);
2545 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2548 dprintk("%s: bind_conn_to_session was successful for server %s!\n",
2549 __func__, clp->cl_hostname);
2551 case -NFS4ERR_DELAY:
2553 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2556 return nfs4_recovery_handle_error(clp, ret);
2561 static void nfs4_layoutreturn_any_run(struct nfs_client *clp)
2565 if (test_and_clear_bit(NFS4CLNT_RECALL_ANY_LAYOUT_READ, &clp->cl_state))
2566 iomode += IOMODE_READ;
2567 if (test_and_clear_bit(NFS4CLNT_RECALL_ANY_LAYOUT_RW, &clp->cl_state))
2568 iomode += IOMODE_RW;
2569 /* Note: IOMODE_READ + IOMODE_RW == IOMODE_ANY */
2571 pnfs_layout_return_unused_byclid(clp, iomode);
2572 set_bit(NFS4CLNT_RUN_MANAGER, &clp->cl_state);
2575 #else /* CONFIG_NFS_V4_1 */
2576 static int nfs4_reset_session(struct nfs_client *clp) { return 0; }
2578 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2583 static void nfs4_layoutreturn_any_run(struct nfs_client *clp)
2586 #endif /* CONFIG_NFS_V4_1 */
2588 static void nfs4_state_manager(struct nfs_client *clp)
2590 unsigned int memflags;
2592 const char *section = "", *section_sep = "";
2595 * State recovery can deadlock if the direct reclaim code tries
2596 * start NFS writeback. So ensure memory allocations are all
2599 memflags = memalloc_nofs_save();
2601 /* Ensure exclusive access to NFSv4 state */
2603 trace_nfs4_state_mgr(clp);
2604 clear_bit(NFS4CLNT_RUN_MANAGER, &clp->cl_state);
2605 if (test_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state)) {
2606 section = "purge state";
2607 status = nfs4_purge_lease(clp);
2613 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state)) {
2614 section = "lease expired";
2615 /* We're going to have to re-establish a clientid */
2616 status = nfs4_reclaim_lease(clp);
2622 /* Initialize or reset the session */
2623 if (test_and_clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state)) {
2624 section = "reset session";
2625 status = nfs4_reset_session(clp);
2626 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
2632 /* Send BIND_CONN_TO_SESSION */
2633 if (test_and_clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2635 section = "bind conn to session";
2636 status = nfs4_bind_conn_to_session(clp);
2642 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state)) {
2643 section = "check lease";
2644 status = nfs4_check_lease(clp);
2650 if (test_and_clear_bit(NFS4CLNT_MOVED, &clp->cl_state)) {
2651 section = "migration";
2652 status = nfs4_handle_migration(clp);
2657 if (test_and_clear_bit(NFS4CLNT_LEASE_MOVED, &clp->cl_state)) {
2658 section = "lease moved";
2659 status = nfs4_handle_lease_moved(clp);
2664 /* First recover reboot state... */
2665 if (test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state)) {
2666 section = "reclaim reboot";
2667 status = nfs4_do_reclaim(clp,
2668 clp->cl_mvops->reboot_recovery_ops);
2669 if (status == -EAGAIN)
2673 nfs4_state_end_reclaim_reboot(clp);
2677 /* Detect expired delegations... */
2678 if (test_and_clear_bit(NFS4CLNT_DELEGATION_EXPIRED, &clp->cl_state)) {
2679 section = "detect expired delegations";
2680 nfs_reap_expired_delegations(clp);
2684 /* Now recover expired state... */
2685 if (test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state)) {
2686 section = "reclaim nograce";
2687 status = nfs4_do_reclaim(clp,
2688 clp->cl_mvops->nograce_recovery_ops);
2689 if (status == -EAGAIN)
2693 clear_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state);
2696 memalloc_nofs_restore(memflags);
2697 nfs4_end_drain_session(clp);
2698 nfs4_clear_state_manager_bit(clp);
2700 if (!test_and_set_bit(NFS4CLNT_RECALL_RUNNING, &clp->cl_state)) {
2701 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state)) {
2702 nfs_client_return_marked_delegations(clp);
2703 set_bit(NFS4CLNT_RUN_MANAGER, &clp->cl_state);
2705 nfs4_layoutreturn_any_run(clp);
2706 clear_bit(NFS4CLNT_RECALL_RUNNING, &clp->cl_state);
2711 } while (refcount_read(&clp->cl_count) > 1 && !signalled());
2715 if (strlen(section))
2717 trace_nfs4_state_mgr_failed(clp, section, status);
2718 pr_warn_ratelimited("NFS: state manager%s%s failed on NFSv4 server %s"
2719 " with error %d\n", section_sep, section,
2720 clp->cl_hostname, -status);
2723 memalloc_nofs_restore(memflags);
2724 nfs4_end_drain_session(clp);
2725 nfs4_clear_state_manager_bit(clp);
2728 static int nfs4_run_state_manager(void *ptr)
2730 struct nfs_client *clp = ptr;
2731 struct rpc_clnt *cl = clp->cl_rpcclient;
2733 while (cl != cl->cl_parent)
2736 allow_signal(SIGKILL);
2738 set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
2739 nfs4_state_manager(clp);
2740 if (atomic_read(&cl->cl_swapper)) {
2741 wait_var_event_interruptible(&clp->cl_state,
2742 test_bit(NFS4CLNT_RUN_MANAGER,
2744 if (atomic_read(&cl->cl_swapper) &&
2745 test_bit(NFS4CLNT_RUN_MANAGER, &clp->cl_state))
2747 /* Either no longer a swapper, or were signalled */
2749 clear_bit(NFS4CLNT_MANAGER_AVAILABLE, &clp->cl_state);
2751 if (refcount_read(&clp->cl_count) > 1 && !signalled() &&
2752 test_bit(NFS4CLNT_RUN_MANAGER, &clp->cl_state) &&
2753 !test_and_set_bit(NFS4CLNT_MANAGER_AVAILABLE, &clp->cl_state))
2756 nfs_put_client(clp);
2757 module_put_and_kthread_exit(0);