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/nfs_idmap.h>
46 #include <linux/kthread.h>
47 #include <linux/module.h>
48 #include <linux/random.h>
49 #include <linux/ratelimit.h>
50 #include <linux/workqueue.h>
51 #include <linux/bitops.h>
52 #include <linux/jiffies.h>
54 #include <linux/sunrpc/clnt.h>
58 #include "delegation.h"
60 #include "nfs4session.h"
64 #define NFSDBG_FACILITY NFSDBG_STATE
66 #define OPENOWNER_POOL_SIZE 8
68 const nfs4_stateid zero_stateid;
69 static DEFINE_MUTEX(nfs_clid_init_mutex);
71 int nfs4_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
73 struct nfs4_setclientid_res clid = {
74 .clientid = clp->cl_clientid,
75 .confirm = clp->cl_confirm,
79 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
81 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
83 port = nn->nfs_callback_tcpport;
84 if (clp->cl_addr.ss_family == AF_INET6)
85 port = nn->nfs_callback_tcpport6;
87 status = nfs4_proc_setclientid(clp, NFS4_CALLBACK, port, cred, &clid);
90 clp->cl_clientid = clid.clientid;
91 clp->cl_confirm = clid.confirm;
92 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
94 status = nfs4_proc_setclientid_confirm(clp, &clid, cred);
97 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
98 nfs4_schedule_state_renewal(clp);
104 * nfs40_discover_server_trunking - Detect server IP address trunking (mv0)
106 * @clp: nfs_client under test
107 * @result: OUT: found nfs_client, or clp
108 * @cred: credential to use for trunking test
110 * Returns zero, a negative errno, or a negative NFS4ERR status.
111 * If zero is returned, an nfs_client pointer is planted in
114 * Note: The returned client may not yet be marked ready.
116 int nfs40_discover_server_trunking(struct nfs_client *clp,
117 struct nfs_client **result,
118 struct rpc_cred *cred)
120 struct nfs4_setclientid_res clid = {
121 .clientid = clp->cl_clientid,
122 .confirm = clp->cl_confirm,
124 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
128 port = nn->nfs_callback_tcpport;
129 if (clp->cl_addr.ss_family == AF_INET6)
130 port = nn->nfs_callback_tcpport6;
132 status = nfs4_proc_setclientid(clp, NFS4_CALLBACK, port, cred, &clid);
135 clp->cl_clientid = clid.clientid;
136 clp->cl_confirm = clid.confirm;
138 status = nfs40_walk_client_list(clp, result, cred);
140 /* Sustain the lease, even if it's empty. If the clientid4
141 * goes stale it's of no use for trunking discovery. */
142 nfs4_schedule_state_renewal(*result);
148 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp)
150 struct rpc_cred *cred = NULL;
152 if (clp->cl_machine_cred != NULL)
153 cred = get_rpccred(clp->cl_machine_cred);
157 static void nfs4_clear_machine_cred(struct nfs_client *clp)
159 struct rpc_cred *cred;
161 spin_lock(&clp->cl_lock);
162 cred = clp->cl_machine_cred;
163 clp->cl_machine_cred = NULL;
164 spin_unlock(&clp->cl_lock);
169 static struct rpc_cred *
170 nfs4_get_renew_cred_server_locked(struct nfs_server *server)
172 struct rpc_cred *cred = NULL;
173 struct nfs4_state_owner *sp;
176 for (pos = rb_first(&server->state_owners);
178 pos = rb_next(pos)) {
179 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
180 if (list_empty(&sp->so_states))
182 cred = get_rpccred(sp->so_cred);
189 * nfs4_get_renew_cred_locked - Acquire credential for a renew operation
190 * @clp: client state handle
192 * Returns an rpc_cred with reference count bumped, or NULL.
193 * Caller must hold clp->cl_lock.
195 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp)
197 struct rpc_cred *cred = NULL;
198 struct nfs_server *server;
200 /* Use machine credentials if available */
201 cred = nfs4_get_machine_cred_locked(clp);
206 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
207 cred = nfs4_get_renew_cred_server_locked(server);
217 #if defined(CONFIG_NFS_V4_1)
219 static int nfs41_setup_state_renewal(struct nfs_client *clp)
222 struct nfs_fsinfo fsinfo;
224 if (!test_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state)) {
225 nfs4_schedule_state_renewal(clp);
229 status = nfs4_proc_get_lease_time(clp, &fsinfo);
231 /* Update lease time and schedule renewal */
232 spin_lock(&clp->cl_lock);
233 clp->cl_lease_time = fsinfo.lease_time * HZ;
234 clp->cl_last_renewal = jiffies;
235 spin_unlock(&clp->cl_lock);
237 nfs4_schedule_state_renewal(clp);
244 * Back channel returns NFS4ERR_DELAY for new requests when
245 * NFS4_SESSION_DRAINING is set so there is no work to be done when draining
248 static void nfs4_end_drain_session(struct nfs_client *clp)
250 struct nfs4_session *ses = clp->cl_session;
251 struct nfs4_slot_table *tbl;
255 tbl = &ses->fc_slot_table;
256 if (test_and_clear_bit(NFS4_SESSION_DRAINING, &ses->session_state)) {
257 spin_lock(&tbl->slot_tbl_lock);
258 nfs41_wake_slot_table(tbl);
259 spin_unlock(&tbl->slot_tbl_lock);
264 * Signal state manager thread if session fore channel is drained
266 void nfs4_session_drain_complete(struct nfs4_session *session,
267 struct nfs4_slot_table *tbl)
269 if (nfs4_session_draining(session))
270 complete(&tbl->complete);
273 static int nfs4_wait_on_slot_tbl(struct nfs4_slot_table *tbl)
275 spin_lock(&tbl->slot_tbl_lock);
276 if (tbl->highest_used_slotid != NFS4_NO_SLOT) {
277 INIT_COMPLETION(tbl->complete);
278 spin_unlock(&tbl->slot_tbl_lock);
279 return wait_for_completion_interruptible(&tbl->complete);
281 spin_unlock(&tbl->slot_tbl_lock);
285 static int nfs4_begin_drain_session(struct nfs_client *clp)
287 struct nfs4_session *ses = clp->cl_session;
290 set_bit(NFS4_SESSION_DRAINING, &ses->session_state);
292 ret = nfs4_wait_on_slot_tbl(&ses->bc_slot_table);
296 return nfs4_wait_on_slot_tbl(&ses->fc_slot_table);
299 static void nfs41_finish_session_reset(struct nfs_client *clp)
301 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
302 clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
303 /* create_session negotiated new slot table */
304 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
305 nfs41_setup_state_renewal(clp);
308 int nfs41_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
312 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
314 nfs4_begin_drain_session(clp);
315 status = nfs4_proc_exchange_id(clp, cred);
318 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
320 status = nfs4_proc_create_session(clp, cred);
323 nfs41_finish_session_reset(clp);
324 nfs_mark_client_ready(clp, NFS_CS_READY);
330 * nfs41_discover_server_trunking - Detect server IP address trunking (mv1)
332 * @clp: nfs_client under test
333 * @result: OUT: found nfs_client, or clp
334 * @cred: credential to use for trunking test
336 * Returns NFS4_OK, a negative errno, or a negative NFS4ERR status.
337 * If NFS4_OK is returned, an nfs_client pointer is planted in
340 * Note: The returned client may not yet be marked ready.
342 int nfs41_discover_server_trunking(struct nfs_client *clp,
343 struct nfs_client **result,
344 struct rpc_cred *cred)
348 status = nfs4_proc_exchange_id(clp, cred);
349 if (status != NFS4_OK)
351 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
353 return nfs41_walk_client_list(clp, result, cred);
356 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp)
358 struct rpc_cred *cred;
360 spin_lock(&clp->cl_lock);
361 cred = nfs4_get_machine_cred_locked(clp);
362 spin_unlock(&clp->cl_lock);
366 #endif /* CONFIG_NFS_V4_1 */
368 static struct rpc_cred *
369 nfs4_get_setclientid_cred_server(struct nfs_server *server)
371 struct nfs_client *clp = server->nfs_client;
372 struct rpc_cred *cred = NULL;
373 struct nfs4_state_owner *sp;
376 spin_lock(&clp->cl_lock);
377 pos = rb_first(&server->state_owners);
379 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
380 cred = get_rpccred(sp->so_cred);
382 spin_unlock(&clp->cl_lock);
387 * nfs4_get_setclientid_cred - Acquire credential for a setclientid operation
388 * @clp: client state handle
390 * Returns an rpc_cred with reference count bumped, or NULL.
392 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp)
394 struct nfs_server *server;
395 struct rpc_cred *cred;
397 spin_lock(&clp->cl_lock);
398 cred = nfs4_get_machine_cred_locked(clp);
399 spin_unlock(&clp->cl_lock);
404 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
405 cred = nfs4_get_setclientid_cred_server(server);
415 static struct nfs4_state_owner *
416 nfs4_find_state_owner_locked(struct nfs_server *server, struct rpc_cred *cred)
418 struct rb_node **p = &server->state_owners.rb_node,
420 struct nfs4_state_owner *sp;
424 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
426 if (cred < sp->so_cred)
427 p = &parent->rb_left;
428 else if (cred > sp->so_cred)
429 p = &parent->rb_right;
431 if (!list_empty(&sp->so_lru))
432 list_del_init(&sp->so_lru);
433 atomic_inc(&sp->so_count);
440 static struct nfs4_state_owner *
441 nfs4_insert_state_owner_locked(struct nfs4_state_owner *new)
443 struct nfs_server *server = new->so_server;
444 struct rb_node **p = &server->state_owners.rb_node,
446 struct nfs4_state_owner *sp;
451 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
453 if (new->so_cred < sp->so_cred)
454 p = &parent->rb_left;
455 else if (new->so_cred > sp->so_cred)
456 p = &parent->rb_right;
458 if (!list_empty(&sp->so_lru))
459 list_del_init(&sp->so_lru);
460 atomic_inc(&sp->so_count);
464 err = ida_get_new(&server->openowner_id, &new->so_seqid.owner_id);
467 rb_link_node(&new->so_server_node, parent, p);
468 rb_insert_color(&new->so_server_node, &server->state_owners);
473 nfs4_remove_state_owner_locked(struct nfs4_state_owner *sp)
475 struct nfs_server *server = sp->so_server;
477 if (!RB_EMPTY_NODE(&sp->so_server_node))
478 rb_erase(&sp->so_server_node, &server->state_owners);
479 ida_remove(&server->openowner_id, sp->so_seqid.owner_id);
483 nfs4_init_seqid_counter(struct nfs_seqid_counter *sc)
485 sc->create_time = ktime_get();
488 spin_lock_init(&sc->lock);
489 INIT_LIST_HEAD(&sc->list);
490 rpc_init_wait_queue(&sc->wait, "Seqid_waitqueue");
494 nfs4_destroy_seqid_counter(struct nfs_seqid_counter *sc)
496 rpc_destroy_wait_queue(&sc->wait);
500 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
501 * create a new state_owner.
504 static struct nfs4_state_owner *
505 nfs4_alloc_state_owner(struct nfs_server *server,
506 struct rpc_cred *cred,
509 struct nfs4_state_owner *sp;
511 sp = kzalloc(sizeof(*sp), gfp_flags);
514 sp->so_server = server;
515 sp->so_cred = get_rpccred(cred);
516 spin_lock_init(&sp->so_lock);
517 INIT_LIST_HEAD(&sp->so_states);
518 nfs4_init_seqid_counter(&sp->so_seqid);
519 atomic_set(&sp->so_count, 1);
520 INIT_LIST_HEAD(&sp->so_lru);
521 seqcount_init(&sp->so_reclaim_seqcount);
526 nfs4_drop_state_owner(struct nfs4_state_owner *sp)
528 struct rb_node *rb_node = &sp->so_server_node;
530 if (!RB_EMPTY_NODE(rb_node)) {
531 struct nfs_server *server = sp->so_server;
532 struct nfs_client *clp = server->nfs_client;
534 spin_lock(&clp->cl_lock);
535 if (!RB_EMPTY_NODE(rb_node)) {
536 rb_erase(rb_node, &server->state_owners);
537 RB_CLEAR_NODE(rb_node);
539 spin_unlock(&clp->cl_lock);
543 static void nfs4_free_state_owner(struct nfs4_state_owner *sp)
545 nfs4_destroy_seqid_counter(&sp->so_seqid);
546 put_rpccred(sp->so_cred);
550 static void nfs4_gc_state_owners(struct nfs_server *server)
552 struct nfs_client *clp = server->nfs_client;
553 struct nfs4_state_owner *sp, *tmp;
554 unsigned long time_min, time_max;
557 spin_lock(&clp->cl_lock);
559 time_min = (long)time_max - (long)clp->cl_lease_time;
560 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
561 /* NB: LRU is sorted so that oldest is at the head */
562 if (time_in_range(sp->so_expires, time_min, time_max))
564 list_move(&sp->so_lru, &doomed);
565 nfs4_remove_state_owner_locked(sp);
567 spin_unlock(&clp->cl_lock);
569 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
570 list_del(&sp->so_lru);
571 nfs4_free_state_owner(sp);
576 * nfs4_get_state_owner - Look up a state owner given a credential
577 * @server: nfs_server to search
578 * @cred: RPC credential to match
580 * Returns a pointer to an instantiated nfs4_state_owner struct, or NULL.
582 struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *server,
583 struct rpc_cred *cred,
586 struct nfs_client *clp = server->nfs_client;
587 struct nfs4_state_owner *sp, *new;
589 spin_lock(&clp->cl_lock);
590 sp = nfs4_find_state_owner_locked(server, cred);
591 spin_unlock(&clp->cl_lock);
594 new = nfs4_alloc_state_owner(server, cred, gfp_flags);
598 if (ida_pre_get(&server->openowner_id, gfp_flags) == 0)
600 spin_lock(&clp->cl_lock);
601 sp = nfs4_insert_state_owner_locked(new);
602 spin_unlock(&clp->cl_lock);
603 } while (sp == ERR_PTR(-EAGAIN));
605 nfs4_free_state_owner(new);
607 nfs4_gc_state_owners(server);
612 * nfs4_put_state_owner - Release a nfs4_state_owner
613 * @sp: state owner data to release
615 * Note that we keep released state owners on an LRU
617 * This caches valid state owners so that they can be
618 * reused, to avoid the OPEN_CONFIRM on minor version 0.
619 * It also pins the uniquifier of dropped state owners for
620 * a while, to ensure that those state owner names are
623 void nfs4_put_state_owner(struct nfs4_state_owner *sp)
625 struct nfs_server *server = sp->so_server;
626 struct nfs_client *clp = server->nfs_client;
628 if (!atomic_dec_and_lock(&sp->so_count, &clp->cl_lock))
631 sp->so_expires = jiffies;
632 list_add_tail(&sp->so_lru, &server->state_owners_lru);
633 spin_unlock(&clp->cl_lock);
637 * nfs4_purge_state_owners - Release all cached state owners
638 * @server: nfs_server with cached state owners to release
640 * Called at umount time. Remaining state owners will be on
641 * the LRU with ref count of zero.
643 void nfs4_purge_state_owners(struct nfs_server *server)
645 struct nfs_client *clp = server->nfs_client;
646 struct nfs4_state_owner *sp, *tmp;
649 spin_lock(&clp->cl_lock);
650 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
651 list_move(&sp->so_lru, &doomed);
652 nfs4_remove_state_owner_locked(sp);
654 spin_unlock(&clp->cl_lock);
656 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
657 list_del(&sp->so_lru);
658 nfs4_free_state_owner(sp);
662 static struct nfs4_state *
663 nfs4_alloc_open_state(void)
665 struct nfs4_state *state;
667 state = kzalloc(sizeof(*state), GFP_NOFS);
670 atomic_set(&state->count, 1);
671 INIT_LIST_HEAD(&state->lock_states);
672 spin_lock_init(&state->state_lock);
673 seqlock_init(&state->seqlock);
678 nfs4_state_set_mode_locked(struct nfs4_state *state, fmode_t fmode)
680 if (state->state == fmode)
682 /* NB! List reordering - see the reclaim code for why. */
683 if ((fmode & FMODE_WRITE) != (state->state & FMODE_WRITE)) {
684 if (fmode & FMODE_WRITE)
685 list_move(&state->open_states, &state->owner->so_states);
687 list_move_tail(&state->open_states, &state->owner->so_states);
689 state->state = fmode;
692 static struct nfs4_state *
693 __nfs4_find_state_byowner(struct inode *inode, struct nfs4_state_owner *owner)
695 struct nfs_inode *nfsi = NFS_I(inode);
696 struct nfs4_state *state;
698 list_for_each_entry(state, &nfsi->open_states, inode_states) {
699 if (state->owner != owner)
701 if (atomic_inc_not_zero(&state->count))
708 nfs4_free_open_state(struct nfs4_state *state)
714 nfs4_get_open_state(struct inode *inode, struct nfs4_state_owner *owner)
716 struct nfs4_state *state, *new;
717 struct nfs_inode *nfsi = NFS_I(inode);
719 spin_lock(&inode->i_lock);
720 state = __nfs4_find_state_byowner(inode, owner);
721 spin_unlock(&inode->i_lock);
724 new = nfs4_alloc_open_state();
725 spin_lock(&owner->so_lock);
726 spin_lock(&inode->i_lock);
727 state = __nfs4_find_state_byowner(inode, owner);
728 if (state == NULL && new != NULL) {
730 state->owner = owner;
731 atomic_inc(&owner->so_count);
732 list_add(&state->inode_states, &nfsi->open_states);
734 state->inode = inode;
735 spin_unlock(&inode->i_lock);
736 /* Note: The reclaim code dictates that we add stateless
737 * and read-only stateids to the end of the list */
738 list_add_tail(&state->open_states, &owner->so_states);
739 spin_unlock(&owner->so_lock);
741 spin_unlock(&inode->i_lock);
742 spin_unlock(&owner->so_lock);
744 nfs4_free_open_state(new);
750 void nfs4_put_open_state(struct nfs4_state *state)
752 struct inode *inode = state->inode;
753 struct nfs4_state_owner *owner = state->owner;
755 if (!atomic_dec_and_lock(&state->count, &owner->so_lock))
757 spin_lock(&inode->i_lock);
758 list_del(&state->inode_states);
759 list_del(&state->open_states);
760 spin_unlock(&inode->i_lock);
761 spin_unlock(&owner->so_lock);
763 nfs4_free_open_state(state);
764 nfs4_put_state_owner(owner);
768 * Close the current file.
770 static void __nfs4_close(struct nfs4_state *state,
771 fmode_t fmode, gfp_t gfp_mask, int wait)
773 struct nfs4_state_owner *owner = state->owner;
777 atomic_inc(&owner->so_count);
778 /* Protect against nfs4_find_state() */
779 spin_lock(&owner->so_lock);
780 switch (fmode & (FMODE_READ | FMODE_WRITE)) {
787 case FMODE_READ|FMODE_WRITE:
790 newstate = FMODE_READ|FMODE_WRITE;
791 if (state->n_rdwr == 0) {
792 if (state->n_rdonly == 0) {
793 newstate &= ~FMODE_READ;
794 call_close |= test_bit(NFS_O_RDONLY_STATE, &state->flags);
795 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
797 if (state->n_wronly == 0) {
798 newstate &= ~FMODE_WRITE;
799 call_close |= test_bit(NFS_O_WRONLY_STATE, &state->flags);
800 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
803 clear_bit(NFS_DELEGATED_STATE, &state->flags);
805 nfs4_state_set_mode_locked(state, newstate);
806 spin_unlock(&owner->so_lock);
809 nfs4_put_open_state(state);
810 nfs4_put_state_owner(owner);
812 nfs4_do_close(state, gfp_mask, wait);
815 void nfs4_close_state(struct nfs4_state *state, fmode_t fmode)
817 __nfs4_close(state, fmode, GFP_NOFS, 0);
820 void nfs4_close_sync(struct nfs4_state *state, fmode_t fmode)
822 __nfs4_close(state, fmode, GFP_KERNEL, 1);
826 * Search the state->lock_states for an existing lock_owner
827 * that is compatible with current->files
829 static struct nfs4_lock_state *
830 __nfs4_find_lock_state(struct nfs4_state *state, fl_owner_t fl_owner, pid_t fl_pid, unsigned int type)
832 struct nfs4_lock_state *pos;
833 list_for_each_entry(pos, &state->lock_states, ls_locks) {
834 if (type != NFS4_ANY_LOCK_TYPE && pos->ls_owner.lo_type != type)
836 switch (pos->ls_owner.lo_type) {
837 case NFS4_POSIX_LOCK_TYPE:
838 if (pos->ls_owner.lo_u.posix_owner != fl_owner)
841 case NFS4_FLOCK_LOCK_TYPE:
842 if (pos->ls_owner.lo_u.flock_owner != fl_pid)
845 atomic_inc(&pos->ls_count);
852 * Return a compatible lock_state. If no initialized lock_state structure
853 * exists, return an uninitialized one.
856 static struct nfs4_lock_state *nfs4_alloc_lock_state(struct nfs4_state *state, fl_owner_t fl_owner, pid_t fl_pid, unsigned int type)
858 struct nfs4_lock_state *lsp;
859 struct nfs_server *server = state->owner->so_server;
861 lsp = kzalloc(sizeof(*lsp), GFP_NOFS);
864 nfs4_init_seqid_counter(&lsp->ls_seqid);
865 atomic_set(&lsp->ls_count, 1);
866 lsp->ls_state = state;
867 lsp->ls_owner.lo_type = type;
868 switch (lsp->ls_owner.lo_type) {
869 case NFS4_FLOCK_LOCK_TYPE:
870 lsp->ls_owner.lo_u.flock_owner = fl_pid;
872 case NFS4_POSIX_LOCK_TYPE:
873 lsp->ls_owner.lo_u.posix_owner = fl_owner;
878 lsp->ls_seqid.owner_id = ida_simple_get(&server->lockowner_id, 0, 0, GFP_NOFS);
879 if (lsp->ls_seqid.owner_id < 0)
881 INIT_LIST_HEAD(&lsp->ls_locks);
888 void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp)
890 ida_simple_remove(&server->lockowner_id, lsp->ls_seqid.owner_id);
891 nfs4_destroy_seqid_counter(&lsp->ls_seqid);
896 * Return a compatible lock_state. If no initialized lock_state structure
897 * exists, return an uninitialized one.
900 static struct nfs4_lock_state *nfs4_get_lock_state(struct nfs4_state *state, fl_owner_t owner, pid_t pid, unsigned int type)
902 struct nfs4_lock_state *lsp, *new = NULL;
905 spin_lock(&state->state_lock);
906 lsp = __nfs4_find_lock_state(state, owner, pid, type);
910 list_add(&new->ls_locks, &state->lock_states);
911 set_bit(LK_STATE_IN_USE, &state->flags);
916 spin_unlock(&state->state_lock);
917 new = nfs4_alloc_lock_state(state, owner, pid, type);
921 spin_unlock(&state->state_lock);
923 nfs4_free_lock_state(state->owner->so_server, new);
928 * Release reference to lock_state, and free it if we see that
929 * it is no longer in use
931 void nfs4_put_lock_state(struct nfs4_lock_state *lsp)
933 struct nfs4_state *state;
937 state = lsp->ls_state;
938 if (!atomic_dec_and_lock(&lsp->ls_count, &state->state_lock))
940 list_del(&lsp->ls_locks);
941 if (list_empty(&state->lock_states))
942 clear_bit(LK_STATE_IN_USE, &state->flags);
943 spin_unlock(&state->state_lock);
944 if (test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags)) {
945 if (nfs4_release_lockowner(lsp) == 0)
948 nfs4_free_lock_state(lsp->ls_state->owner->so_server, lsp);
951 static void nfs4_fl_copy_lock(struct file_lock *dst, struct file_lock *src)
953 struct nfs4_lock_state *lsp = src->fl_u.nfs4_fl.owner;
955 dst->fl_u.nfs4_fl.owner = lsp;
956 atomic_inc(&lsp->ls_count);
959 static void nfs4_fl_release_lock(struct file_lock *fl)
961 nfs4_put_lock_state(fl->fl_u.nfs4_fl.owner);
964 static const struct file_lock_operations nfs4_fl_lock_ops = {
965 .fl_copy_lock = nfs4_fl_copy_lock,
966 .fl_release_private = nfs4_fl_release_lock,
969 int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl)
971 struct nfs4_lock_state *lsp;
973 if (fl->fl_ops != NULL)
975 if (fl->fl_flags & FL_POSIX)
976 lsp = nfs4_get_lock_state(state, fl->fl_owner, 0, NFS4_POSIX_LOCK_TYPE);
977 else if (fl->fl_flags & FL_FLOCK)
978 lsp = nfs4_get_lock_state(state, NULL, fl->fl_pid,
979 NFS4_FLOCK_LOCK_TYPE);
984 fl->fl_u.nfs4_fl.owner = lsp;
985 fl->fl_ops = &nfs4_fl_lock_ops;
989 static bool nfs4_copy_lock_stateid(nfs4_stateid *dst, struct nfs4_state *state,
990 const struct nfs_lockowner *lockowner)
992 struct nfs4_lock_state *lsp;
998 if (lockowner == NULL)
1001 if (test_bit(LK_STATE_IN_USE, &state->flags) == 0)
1004 fl_owner = lockowner->l_owner;
1005 fl_pid = lockowner->l_pid;
1006 spin_lock(&state->state_lock);
1007 lsp = __nfs4_find_lock_state(state, fl_owner, fl_pid, NFS4_ANY_LOCK_TYPE);
1008 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 static void nfs4_copy_open_stateid(nfs4_stateid *dst, struct nfs4_state *state)
1023 seq = read_seqbegin(&state->seqlock);
1024 nfs4_stateid_copy(dst, &state->stateid);
1025 } while (read_seqretry(&state->seqlock, seq));
1029 * Byte-range lock aware utility to initialize the stateid of read/write
1032 void nfs4_select_rw_stateid(nfs4_stateid *dst, struct nfs4_state *state,
1033 fmode_t fmode, const struct nfs_lockowner *lockowner)
1035 if (nfs4_copy_delegation_stateid(dst, state->inode, fmode))
1037 if (nfs4_copy_lock_stateid(dst, state, lockowner))
1039 nfs4_copy_open_stateid(dst, state);
1042 struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask)
1044 struct nfs_seqid *new;
1046 new = kmalloc(sizeof(*new), gfp_mask);
1048 new->sequence = counter;
1049 INIT_LIST_HEAD(&new->list);
1055 void nfs_release_seqid(struct nfs_seqid *seqid)
1057 struct nfs_seqid_counter *sequence;
1059 if (list_empty(&seqid->list))
1061 sequence = seqid->sequence;
1062 spin_lock(&sequence->lock);
1063 list_del_init(&seqid->list);
1064 if (!list_empty(&sequence->list)) {
1065 struct nfs_seqid *next;
1067 next = list_first_entry(&sequence->list,
1068 struct nfs_seqid, list);
1069 rpc_wake_up_queued_task(&sequence->wait, next->task);
1071 spin_unlock(&sequence->lock);
1074 void nfs_free_seqid(struct nfs_seqid *seqid)
1076 nfs_release_seqid(seqid);
1081 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
1082 * failed with a seqid incrementing error -
1083 * see comments nfs_fs.h:seqid_mutating_error()
1085 static void nfs_increment_seqid(int status, struct nfs_seqid *seqid)
1090 case -NFS4ERR_BAD_SEQID:
1091 if (seqid->sequence->flags & NFS_SEQID_CONFIRMED)
1093 pr_warn_ratelimited("NFS: v4 server returned a bad"
1094 " sequence-id error on an"
1095 " unconfirmed sequence %p!\n",
1097 case -NFS4ERR_STALE_CLIENTID:
1098 case -NFS4ERR_STALE_STATEID:
1099 case -NFS4ERR_BAD_STATEID:
1100 case -NFS4ERR_BADXDR:
1101 case -NFS4ERR_RESOURCE:
1102 case -NFS4ERR_NOFILEHANDLE:
1103 /* Non-seqid mutating errors */
1107 * Note: no locking needed as we are guaranteed to be first
1108 * on the sequence list
1110 seqid->sequence->counter++;
1113 void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid)
1115 struct nfs4_state_owner *sp = container_of(seqid->sequence,
1116 struct nfs4_state_owner, so_seqid);
1117 struct nfs_server *server = sp->so_server;
1119 if (status == -NFS4ERR_BAD_SEQID)
1120 nfs4_drop_state_owner(sp);
1121 if (!nfs4_has_session(server->nfs_client))
1122 nfs_increment_seqid(status, seqid);
1126 * Increment the seqid if the LOCK/LOCKU succeeded, or
1127 * failed with a seqid incrementing error -
1128 * see comments nfs_fs.h:seqid_mutating_error()
1130 void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid)
1132 nfs_increment_seqid(status, seqid);
1135 int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task)
1137 struct nfs_seqid_counter *sequence = seqid->sequence;
1140 spin_lock(&sequence->lock);
1142 if (list_empty(&seqid->list))
1143 list_add_tail(&seqid->list, &sequence->list);
1144 if (list_first_entry(&sequence->list, struct nfs_seqid, list) == seqid)
1146 rpc_sleep_on(&sequence->wait, task, NULL);
1149 spin_unlock(&sequence->lock);
1153 static int nfs4_run_state_manager(void *);
1155 static void nfs4_clear_state_manager_bit(struct nfs_client *clp)
1157 smp_mb__before_clear_bit();
1158 clear_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
1159 smp_mb__after_clear_bit();
1160 wake_up_bit(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING);
1161 rpc_wake_up(&clp->cl_rpcwaitq);
1165 * Schedule the nfs_client asynchronous state management routine
1167 void nfs4_schedule_state_manager(struct nfs_client *clp)
1169 struct task_struct *task;
1170 char buf[INET6_ADDRSTRLEN + sizeof("-manager") + 1];
1172 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
1174 __module_get(THIS_MODULE);
1175 atomic_inc(&clp->cl_count);
1177 /* The rcu_read_lock() is not strictly necessary, as the state
1178 * manager is the only thread that ever changes the rpc_xprt
1179 * after it's initialized. At this point, we're single threaded. */
1181 snprintf(buf, sizeof(buf), "%s-manager",
1182 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_ADDR));
1184 task = kthread_run(nfs4_run_state_manager, clp, buf);
1186 printk(KERN_ERR "%s: kthread_run: %ld\n",
1187 __func__, PTR_ERR(task));
1188 nfs4_clear_state_manager_bit(clp);
1189 nfs_put_client(clp);
1190 module_put(THIS_MODULE);
1195 * Schedule a lease recovery attempt
1197 void nfs4_schedule_lease_recovery(struct nfs_client *clp)
1201 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1202 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1203 dprintk("%s: scheduling lease recovery for server %s\n", __func__,
1205 nfs4_schedule_state_manager(clp);
1207 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_recovery);
1209 int nfs4_wait_clnt_recover(struct nfs_client *clp)
1215 res = wait_on_bit(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING,
1216 nfs_wait_bit_killable, TASK_KILLABLE);
1220 if (clp->cl_cons_state < 0)
1221 return clp->cl_cons_state;
1225 int nfs4_client_recover_expired_lease(struct nfs_client *clp)
1230 for (loop = NFS4_MAX_LOOP_ON_RECOVER; loop != 0; loop--) {
1231 ret = nfs4_wait_clnt_recover(clp);
1234 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) &&
1235 !test_bit(NFS4CLNT_CHECK_LEASE,&clp->cl_state))
1237 nfs4_schedule_state_manager(clp);
1244 * nfs40_handle_cb_pathdown - return all delegations after NFS4ERR_CB_PATH_DOWN
1245 * @clp: client to process
1247 * Set the NFS4CLNT_LEASE_EXPIRED state in order to force a
1248 * resend of the SETCLIENTID and hence re-establish the
1249 * callback channel. Then return all existing delegations.
1251 static void nfs40_handle_cb_pathdown(struct nfs_client *clp)
1253 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1254 nfs_expire_all_delegations(clp);
1255 dprintk("%s: handling CB_PATHDOWN recovery for server %s\n", __func__,
1259 void nfs4_schedule_path_down_recovery(struct nfs_client *clp)
1261 nfs40_handle_cb_pathdown(clp);
1262 nfs4_schedule_state_manager(clp);
1265 static int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state)
1268 set_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1269 /* Don't recover state that expired before the reboot */
1270 if (test_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags)) {
1271 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1274 set_bit(NFS_OWNER_RECLAIM_REBOOT, &state->owner->so_flags);
1275 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1279 static int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state)
1281 set_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags);
1282 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1283 set_bit(NFS_OWNER_RECLAIM_NOGRACE, &state->owner->so_flags);
1284 set_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state);
1288 void nfs4_schedule_stateid_recovery(const struct nfs_server *server, struct nfs4_state *state)
1290 struct nfs_client *clp = server->nfs_client;
1292 nfs4_state_mark_reclaim_nograce(clp, state);
1293 dprintk("%s: scheduling stateid recovery for server %s\n", __func__,
1295 nfs4_schedule_state_manager(clp);
1297 EXPORT_SYMBOL_GPL(nfs4_schedule_stateid_recovery);
1299 void nfs_inode_find_state_and_recover(struct inode *inode,
1300 const nfs4_stateid *stateid)
1302 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1303 struct nfs_inode *nfsi = NFS_I(inode);
1304 struct nfs_open_context *ctx;
1305 struct nfs4_state *state;
1308 spin_lock(&inode->i_lock);
1309 list_for_each_entry(ctx, &nfsi->open_files, list) {
1313 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
1315 if (!nfs4_stateid_match(&state->stateid, stateid))
1317 nfs4_state_mark_reclaim_nograce(clp, state);
1320 spin_unlock(&inode->i_lock);
1322 nfs4_schedule_state_manager(clp);
1326 static int nfs4_reclaim_locks(struct nfs4_state *state, const struct nfs4_state_recovery_ops *ops)
1328 struct inode *inode = state->inode;
1329 struct nfs_inode *nfsi = NFS_I(inode);
1330 struct file_lock *fl;
1333 if (inode->i_flock == NULL)
1336 /* Guard against delegation returns and new lock/unlock calls */
1337 down_write(&nfsi->rwsem);
1338 /* Protect inode->i_flock using the BKL */
1340 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1341 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
1343 if (nfs_file_open_context(fl->fl_file)->state != state)
1346 status = ops->recover_lock(state, fl);
1351 case -NFS4ERR_ADMIN_REVOKED:
1352 case -NFS4ERR_STALE_STATEID:
1353 case -NFS4ERR_BAD_STATEID:
1354 case -NFS4ERR_EXPIRED:
1355 case -NFS4ERR_NO_GRACE:
1356 case -NFS4ERR_STALE_CLIENTID:
1357 case -NFS4ERR_BADSESSION:
1358 case -NFS4ERR_BADSLOT:
1359 case -NFS4ERR_BAD_HIGH_SLOT:
1360 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1363 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1364 "Zeroing state\n", __func__, status);
1366 case -NFS4ERR_DENIED:
1367 case -NFS4ERR_RECLAIM_BAD:
1368 case -NFS4ERR_RECLAIM_CONFLICT:
1369 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
1376 up_write(&nfsi->rwsem);
1380 static int nfs4_reclaim_open_state(struct nfs4_state_owner *sp, const struct nfs4_state_recovery_ops *ops)
1382 struct nfs4_state *state;
1383 struct nfs4_lock_state *lock;
1386 /* Note: we rely on the sp->so_states list being ordered
1387 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
1389 * This is needed to ensure that the server won't give us any
1390 * read delegations that we have to return if, say, we are
1391 * recovering after a network partition or a reboot from a
1392 * server that doesn't support a grace period.
1394 spin_lock(&sp->so_lock);
1395 write_seqcount_begin(&sp->so_reclaim_seqcount);
1397 list_for_each_entry(state, &sp->so_states, open_states) {
1398 if (!test_and_clear_bit(ops->state_flag_bit, &state->flags))
1400 if (state->state == 0)
1402 atomic_inc(&state->count);
1403 spin_unlock(&sp->so_lock);
1404 status = ops->recover_open(sp, state);
1406 status = nfs4_reclaim_locks(state, ops);
1408 spin_lock(&state->state_lock);
1409 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1410 if (!test_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags))
1411 pr_warn_ratelimited("NFS: "
1413 "failed!\n", __func__);
1415 spin_unlock(&state->state_lock);
1416 nfs4_put_open_state(state);
1417 spin_lock(&sp->so_lock);
1423 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1424 "Zeroing state\n", __func__, status);
1429 * Open state on this file cannot be recovered
1430 * All we can do is revert to using the zero stateid.
1432 memset(&state->stateid, 0,
1433 sizeof(state->stateid));
1434 /* Mark the file as being 'closed' */
1437 case -NFS4ERR_ADMIN_REVOKED:
1438 case -NFS4ERR_STALE_STATEID:
1439 case -NFS4ERR_BAD_STATEID:
1440 case -NFS4ERR_RECLAIM_BAD:
1441 case -NFS4ERR_RECLAIM_CONFLICT:
1442 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1444 case -NFS4ERR_EXPIRED:
1445 case -NFS4ERR_NO_GRACE:
1446 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1447 case -NFS4ERR_STALE_CLIENTID:
1448 case -NFS4ERR_BADSESSION:
1449 case -NFS4ERR_BADSLOT:
1450 case -NFS4ERR_BAD_HIGH_SLOT:
1451 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1454 nfs4_put_open_state(state);
1455 spin_lock(&sp->so_lock);
1458 write_seqcount_end(&sp->so_reclaim_seqcount);
1459 spin_unlock(&sp->so_lock);
1462 nfs4_put_open_state(state);
1463 spin_lock(&sp->so_lock);
1464 write_seqcount_end(&sp->so_reclaim_seqcount);
1465 spin_unlock(&sp->so_lock);
1469 static void nfs4_clear_open_state(struct nfs4_state *state)
1471 struct nfs4_lock_state *lock;
1473 clear_bit(NFS_DELEGATED_STATE, &state->flags);
1474 clear_bit(NFS_O_RDONLY_STATE, &state->flags);
1475 clear_bit(NFS_O_WRONLY_STATE, &state->flags);
1476 clear_bit(NFS_O_RDWR_STATE, &state->flags);
1477 spin_lock(&state->state_lock);
1478 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1479 lock->ls_seqid.flags = 0;
1480 clear_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags);
1482 spin_unlock(&state->state_lock);
1485 static void nfs4_reset_seqids(struct nfs_server *server,
1486 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1488 struct nfs_client *clp = server->nfs_client;
1489 struct nfs4_state_owner *sp;
1490 struct rb_node *pos;
1491 struct nfs4_state *state;
1493 spin_lock(&clp->cl_lock);
1494 for (pos = rb_first(&server->state_owners);
1496 pos = rb_next(pos)) {
1497 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1498 sp->so_seqid.flags = 0;
1499 spin_lock(&sp->so_lock);
1500 list_for_each_entry(state, &sp->so_states, open_states) {
1501 if (mark_reclaim(clp, state))
1502 nfs4_clear_open_state(state);
1504 spin_unlock(&sp->so_lock);
1506 spin_unlock(&clp->cl_lock);
1509 static void nfs4_state_mark_reclaim_helper(struct nfs_client *clp,
1510 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1512 struct nfs_server *server;
1515 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1516 nfs4_reset_seqids(server, mark_reclaim);
1520 static void nfs4_state_start_reclaim_reboot(struct nfs_client *clp)
1522 /* Mark all delegations for reclaim */
1523 nfs_delegation_mark_reclaim(clp);
1524 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_reboot);
1527 static void nfs4_reclaim_complete(struct nfs_client *clp,
1528 const struct nfs4_state_recovery_ops *ops)
1530 /* Notify the server we're done reclaiming our state */
1531 if (ops->reclaim_complete)
1532 (void)ops->reclaim_complete(clp);
1535 static void nfs4_clear_reclaim_server(struct nfs_server *server)
1537 struct nfs_client *clp = server->nfs_client;
1538 struct nfs4_state_owner *sp;
1539 struct rb_node *pos;
1540 struct nfs4_state *state;
1542 spin_lock(&clp->cl_lock);
1543 for (pos = rb_first(&server->state_owners);
1545 pos = rb_next(pos)) {
1546 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1547 spin_lock(&sp->so_lock);
1548 list_for_each_entry(state, &sp->so_states, open_states) {
1549 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT,
1552 nfs4_state_mark_reclaim_nograce(clp, state);
1554 spin_unlock(&sp->so_lock);
1556 spin_unlock(&clp->cl_lock);
1559 static int nfs4_state_clear_reclaim_reboot(struct nfs_client *clp)
1561 struct nfs_server *server;
1563 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
1567 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1568 nfs4_clear_reclaim_server(server);
1571 nfs_delegation_reap_unclaimed(clp);
1575 static void nfs4_state_end_reclaim_reboot(struct nfs_client *clp)
1577 if (!nfs4_state_clear_reclaim_reboot(clp))
1579 nfs4_reclaim_complete(clp, clp->cl_mvops->reboot_recovery_ops);
1582 static void nfs_delegation_clear_all(struct nfs_client *clp)
1584 nfs_delegation_mark_reclaim(clp);
1585 nfs_delegation_reap_unclaimed(clp);
1588 static void nfs4_state_start_reclaim_nograce(struct nfs_client *clp)
1590 nfs_delegation_clear_all(clp);
1591 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_nograce);
1594 static int nfs4_recovery_handle_error(struct nfs_client *clp, int error)
1599 case -NFS4ERR_CB_PATH_DOWN:
1600 nfs40_handle_cb_pathdown(clp);
1602 case -NFS4ERR_NO_GRACE:
1603 nfs4_state_end_reclaim_reboot(clp);
1605 case -NFS4ERR_STALE_CLIENTID:
1606 case -NFS4ERR_LEASE_MOVED:
1607 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1608 nfs4_state_clear_reclaim_reboot(clp);
1609 nfs4_state_start_reclaim_reboot(clp);
1611 case -NFS4ERR_EXPIRED:
1612 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1613 nfs4_state_start_reclaim_nograce(clp);
1615 case -NFS4ERR_BADSESSION:
1616 case -NFS4ERR_BADSLOT:
1617 case -NFS4ERR_BAD_HIGH_SLOT:
1618 case -NFS4ERR_DEADSESSION:
1619 case -NFS4ERR_SEQ_FALSE_RETRY:
1620 case -NFS4ERR_SEQ_MISORDERED:
1621 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1622 /* Zero session reset errors */
1624 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1625 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1628 dprintk("%s: failed to handle error %d for server %s\n",
1629 __func__, error, clp->cl_hostname);
1632 dprintk("%s: handled error %d for server %s\n", __func__, error,
1637 static int nfs4_do_reclaim(struct nfs_client *clp, const struct nfs4_state_recovery_ops *ops)
1639 struct nfs4_state_owner *sp;
1640 struct nfs_server *server;
1641 struct rb_node *pos;
1646 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1647 nfs4_purge_state_owners(server);
1648 spin_lock(&clp->cl_lock);
1649 for (pos = rb_first(&server->state_owners);
1651 pos = rb_next(pos)) {
1653 struct nfs4_state_owner, so_server_node);
1654 if (!test_and_clear_bit(ops->owner_flag_bit,
1657 atomic_inc(&sp->so_count);
1658 spin_unlock(&clp->cl_lock);
1661 status = nfs4_reclaim_open_state(sp, ops);
1663 set_bit(ops->owner_flag_bit, &sp->so_flags);
1664 nfs4_put_state_owner(sp);
1665 return nfs4_recovery_handle_error(clp, status);
1668 nfs4_put_state_owner(sp);
1671 spin_unlock(&clp->cl_lock);
1677 static int nfs4_check_lease(struct nfs_client *clp)
1679 struct rpc_cred *cred;
1680 const struct nfs4_state_maintenance_ops *ops =
1681 clp->cl_mvops->state_renewal_ops;
1684 /* Is the client already known to have an expired lease? */
1685 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1687 spin_lock(&clp->cl_lock);
1688 cred = ops->get_state_renewal_cred_locked(clp);
1689 spin_unlock(&clp->cl_lock);
1691 cred = nfs4_get_setclientid_cred(clp);
1696 status = ops->renew_lease(clp, cred);
1699 return nfs4_recovery_handle_error(clp, status);
1702 /* Set NFS4CLNT_LEASE_EXPIRED and reclaim reboot state for all v4.0 errors
1703 * and for recoverable errors on EXCHANGE_ID for v4.1
1705 static int nfs4_handle_reclaim_lease_error(struct nfs_client *clp, int status)
1708 case -NFS4ERR_SEQ_MISORDERED:
1709 if (test_and_set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state))
1710 return -ESERVERFAULT;
1711 /* Lease confirmation error: retry after purging the lease */
1713 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1715 case -NFS4ERR_STALE_CLIENTID:
1716 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1717 nfs4_state_clear_reclaim_reboot(clp);
1718 nfs4_state_start_reclaim_reboot(clp);
1720 case -NFS4ERR_CLID_INUSE:
1721 pr_err("NFS: Server %s reports our clientid is in use\n",
1723 nfs_mark_client_ready(clp, -EPERM);
1724 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1727 if (clp->cl_machine_cred == NULL)
1729 /* Handle case where the user hasn't set up machine creds */
1730 nfs4_clear_machine_cred(clp);
1731 case -NFS4ERR_DELAY:
1737 case -NFS4ERR_MINOR_VERS_MISMATCH:
1738 if (clp->cl_cons_state == NFS_CS_SESSION_INITING)
1739 nfs_mark_client_ready(clp, -EPROTONOSUPPORT);
1740 dprintk("%s: exit with error %d for server %s\n",
1741 __func__, -EPROTONOSUPPORT, clp->cl_hostname);
1742 return -EPROTONOSUPPORT;
1743 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1744 * in nfs4_exchange_id */
1746 dprintk("%s: exit with error %d for server %s\n", __func__,
1747 status, clp->cl_hostname);
1750 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1751 dprintk("%s: handled error %d for server %s\n", __func__, status,
1756 static int nfs4_establish_lease(struct nfs_client *clp)
1758 struct rpc_cred *cred;
1759 const struct nfs4_state_recovery_ops *ops =
1760 clp->cl_mvops->reboot_recovery_ops;
1763 cred = ops->get_clid_cred(clp);
1766 status = ops->establish_clid(clp, cred);
1770 pnfs_destroy_all_layouts(clp);
1775 * Returns zero or a negative errno. NFS4ERR values are converted
1776 * to local errno values.
1778 static int nfs4_reclaim_lease(struct nfs_client *clp)
1782 status = nfs4_establish_lease(clp);
1784 return nfs4_handle_reclaim_lease_error(clp, status);
1785 if (test_and_clear_bit(NFS4CLNT_SERVER_SCOPE_MISMATCH, &clp->cl_state))
1786 nfs4_state_start_reclaim_nograce(clp);
1787 if (!test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
1788 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1789 clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1790 clear_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1794 static int nfs4_purge_lease(struct nfs_client *clp)
1798 status = nfs4_establish_lease(clp);
1800 return nfs4_handle_reclaim_lease_error(clp, status);
1801 clear_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
1802 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1803 nfs4_state_start_reclaim_nograce(clp);
1808 * nfs4_discover_server_trunking - Detect server IP address trunking
1810 * @clp: nfs_client under test
1811 * @result: OUT: found nfs_client, or clp
1813 * Returns zero or a negative errno. If zero is returned,
1814 * an nfs_client pointer is planted in "result".
1816 * Note: since we are invoked in process context, and
1817 * not from inside the state manager, we cannot use
1818 * nfs4_handle_reclaim_lease_error().
1820 int nfs4_discover_server_trunking(struct nfs_client *clp,
1821 struct nfs_client **result)
1823 const struct nfs4_state_recovery_ops *ops =
1824 clp->cl_mvops->reboot_recovery_ops;
1825 rpc_authflavor_t *flavors, flav, save;
1826 struct rpc_clnt *clnt;
1827 struct rpc_cred *cred;
1830 dprintk("NFS: %s: testing '%s'\n", __func__, clp->cl_hostname);
1832 len = NFS_MAX_SECFLAVORS;
1833 flavors = kcalloc(len, sizeof(*flavors), GFP_KERNEL);
1834 if (flavors == NULL) {
1838 len = rpcauth_list_flavors(flavors, len);
1843 clnt = clp->cl_rpcclient;
1844 save = clnt->cl_auth->au_flavor;
1847 mutex_lock(&nfs_clid_init_mutex);
1850 cred = ops->get_clid_cred(clp);
1854 status = ops->detect_trunking(clp, result, cred);
1861 if (clp->cl_machine_cred == NULL)
1863 /* Handle case where the user hasn't set up machine creds */
1864 nfs4_clear_machine_cred(clp);
1865 case -NFS4ERR_DELAY:
1869 case -NFS4ERR_STALE_CLIENTID:
1870 dprintk("NFS: %s after status %d, retrying\n",
1874 case -NFS4ERR_CLID_INUSE:
1875 case -NFS4ERR_WRONGSEC:
1880 flav = flavors[i++];
1882 flav = flavors[i++];
1883 clnt = rpc_clone_client_set_auth(clnt, flav);
1885 status = PTR_ERR(clnt);
1888 clp->cl_rpcclient = clnt;
1891 case -NFS4ERR_MINOR_VERS_MISMATCH:
1892 status = -EPROTONOSUPPORT;
1896 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1897 * in nfs4_exchange_id */
1898 status = -EKEYEXPIRED;
1902 mutex_unlock(&nfs_clid_init_mutex);
1906 dprintk("NFS: %s: status = %d\n", __func__, status);
1910 #ifdef CONFIG_NFS_V4_1
1911 void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
1913 struct nfs_client *clp = session->clp;
1917 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1919 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1920 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1922 nfs4_schedule_lease_recovery(clp);
1924 EXPORT_SYMBOL_GPL(nfs4_schedule_session_recovery);
1926 static void nfs41_ping_server(struct nfs_client *clp)
1928 /* Use CHECK_LEASE to ping the server with a SEQUENCE */
1929 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1930 nfs4_schedule_state_manager(clp);
1933 void nfs41_server_notify_target_slotid_update(struct nfs_client *clp)
1935 nfs41_ping_server(clp);
1938 void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp)
1940 nfs41_ping_server(clp);
1943 static void nfs4_reset_all_state(struct nfs_client *clp)
1945 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1946 set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
1947 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1948 nfs4_state_start_reclaim_nograce(clp);
1949 dprintk("%s: scheduling reset of all state for server %s!\n",
1950 __func__, clp->cl_hostname);
1951 nfs4_schedule_state_manager(clp);
1955 static void nfs41_handle_server_reboot(struct nfs_client *clp)
1957 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1958 nfs4_state_start_reclaim_reboot(clp);
1959 dprintk("%s: server %s rebooted!\n", __func__,
1961 nfs4_schedule_state_manager(clp);
1965 static void nfs41_handle_state_revoked(struct nfs_client *clp)
1967 nfs4_reset_all_state(clp);
1968 dprintk("%s: state revoked on server %s\n", __func__, clp->cl_hostname);
1971 static void nfs41_handle_recallable_state_revoked(struct nfs_client *clp)
1973 /* This will need to handle layouts too */
1974 nfs_expire_all_delegations(clp);
1975 dprintk("%s: Recallable state revoked on server %s!\n", __func__,
1979 static void nfs41_handle_backchannel_fault(struct nfs_client *clp)
1981 nfs_expire_all_delegations(clp);
1982 if (test_and_set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) == 0)
1983 nfs4_schedule_state_manager(clp);
1984 dprintk("%s: server %s declared a backchannel fault\n", __func__,
1988 static void nfs41_handle_cb_path_down(struct nfs_client *clp)
1990 if (test_and_set_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
1991 &clp->cl_state) == 0)
1992 nfs4_schedule_state_manager(clp);
1995 void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags)
2000 dprintk("%s: \"%s\" (client ID %llx) flags=0x%08x\n",
2001 __func__, clp->cl_hostname, clp->cl_clientid, flags);
2003 if (flags & SEQ4_STATUS_RESTART_RECLAIM_NEEDED)
2004 nfs41_handle_server_reboot(clp);
2005 if (flags & (SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED |
2006 SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED |
2007 SEQ4_STATUS_ADMIN_STATE_REVOKED |
2008 SEQ4_STATUS_LEASE_MOVED))
2009 nfs41_handle_state_revoked(clp);
2010 if (flags & SEQ4_STATUS_RECALLABLE_STATE_REVOKED)
2011 nfs41_handle_recallable_state_revoked(clp);
2012 if (flags & SEQ4_STATUS_BACKCHANNEL_FAULT)
2013 nfs41_handle_backchannel_fault(clp);
2014 else if (flags & (SEQ4_STATUS_CB_PATH_DOWN |
2015 SEQ4_STATUS_CB_PATH_DOWN_SESSION))
2016 nfs41_handle_cb_path_down(clp);
2019 static int nfs4_reset_session(struct nfs_client *clp)
2021 struct rpc_cred *cred;
2024 if (!nfs4_has_session(clp))
2026 nfs4_begin_drain_session(clp);
2027 cred = nfs4_get_exchange_id_cred(clp);
2028 status = nfs4_proc_destroy_session(clp->cl_session, cred);
2031 case -NFS4ERR_BADSESSION:
2032 case -NFS4ERR_DEADSESSION:
2034 case -NFS4ERR_BACK_CHAN_BUSY:
2035 case -NFS4ERR_DELAY:
2036 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2041 status = nfs4_recovery_handle_error(clp, status);
2045 memset(clp->cl_session->sess_id.data, 0, NFS4_MAX_SESSIONID_LEN);
2046 status = nfs4_proc_create_session(clp, cred);
2048 dprintk("%s: session reset failed with status %d for server %s!\n",
2049 __func__, status, clp->cl_hostname);
2050 status = nfs4_handle_reclaim_lease_error(clp, status);
2053 nfs41_finish_session_reset(clp);
2054 dprintk("%s: session reset was successful for server %s!\n",
2055 __func__, clp->cl_hostname);
2062 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2064 struct rpc_cred *cred;
2067 if (!nfs4_has_session(clp))
2069 nfs4_begin_drain_session(clp);
2070 cred = nfs4_get_exchange_id_cred(clp);
2071 ret = nfs4_proc_bind_conn_to_session(clp, cred);
2074 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2077 dprintk("%s: bind_conn_to_session was successful for server %s!\n",
2078 __func__, clp->cl_hostname);
2080 case -NFS4ERR_DELAY:
2082 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2085 return nfs4_recovery_handle_error(clp, ret);
2089 #else /* CONFIG_NFS_V4_1 */
2090 static int nfs4_reset_session(struct nfs_client *clp) { return 0; }
2091 static int nfs4_end_drain_session(struct nfs_client *clp) { return 0; }
2093 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2097 #endif /* CONFIG_NFS_V4_1 */
2099 static void nfs4_state_manager(struct nfs_client *clp)
2102 const char *section = "", *section_sep = "";
2104 /* Ensure exclusive access to NFSv4 state */
2106 if (test_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state)) {
2107 section = "purge state";
2108 status = nfs4_purge_lease(clp);
2114 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state)) {
2115 section = "lease expired";
2116 /* We're going to have to re-establish a clientid */
2117 status = nfs4_reclaim_lease(clp);
2123 /* Initialize or reset the session */
2124 if (test_and_clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state)) {
2125 section = "reset session";
2126 status = nfs4_reset_session(clp);
2127 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
2133 /* Send BIND_CONN_TO_SESSION */
2134 if (test_and_clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2136 section = "bind conn to session";
2137 status = nfs4_bind_conn_to_session(clp);
2143 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state)) {
2144 section = "check lease";
2145 status = nfs4_check_lease(clp);
2151 /* First recover reboot state... */
2152 if (test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state)) {
2153 section = "reclaim reboot";
2154 status = nfs4_do_reclaim(clp,
2155 clp->cl_mvops->reboot_recovery_ops);
2156 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
2157 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
2159 nfs4_state_end_reclaim_reboot(clp);
2160 if (test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
2166 /* Now recover expired state... */
2167 if (test_and_clear_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state)) {
2168 section = "reclaim nograce";
2169 status = nfs4_do_reclaim(clp,
2170 clp->cl_mvops->nograce_recovery_ops);
2171 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
2172 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) ||
2173 test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
2179 nfs4_end_drain_session(clp);
2180 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state)) {
2181 nfs_client_return_marked_delegations(clp);
2185 nfs4_clear_state_manager_bit(clp);
2186 /* Did we race with an attempt to give us more work? */
2187 if (clp->cl_state == 0)
2189 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
2191 } while (atomic_read(&clp->cl_count) > 1);
2194 if (strlen(section))
2196 pr_warn_ratelimited("NFS: state manager%s%s failed on NFSv4 server %s"
2197 " with error %d\n", section_sep, section,
2198 clp->cl_hostname, -status);
2200 nfs4_end_drain_session(clp);
2201 nfs4_clear_state_manager_bit(clp);
2204 static int nfs4_run_state_manager(void *ptr)
2206 struct nfs_client *clp = ptr;
2208 allow_signal(SIGKILL);
2209 nfs4_state_manager(clp);
2210 nfs_put_client(clp);
2211 module_put_and_exit(0);