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"
63 #define NFSDBG_FACILITY NFSDBG_STATE
65 #define OPENOWNER_POOL_SIZE 8
67 const nfs4_stateid zero_stateid;
68 static DEFINE_MUTEX(nfs_clid_init_mutex);
69 static LIST_HEAD(nfs4_clientid_list);
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 case -NFS4ERR_STALE_CLIENTID:
141 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
143 /* Sustain the lease, even if it's empty. If the clientid4
144 * goes stale it's of no use for trunking discovery. */
145 nfs4_schedule_state_renewal(*result);
153 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp)
155 struct rpc_cred *cred = NULL;
157 if (clp->cl_machine_cred != NULL)
158 cred = get_rpccred(clp->cl_machine_cred);
162 static void nfs4_clear_machine_cred(struct nfs_client *clp)
164 struct rpc_cred *cred;
166 spin_lock(&clp->cl_lock);
167 cred = clp->cl_machine_cred;
168 clp->cl_machine_cred = NULL;
169 spin_unlock(&clp->cl_lock);
174 static struct rpc_cred *
175 nfs4_get_renew_cred_server_locked(struct nfs_server *server)
177 struct rpc_cred *cred = NULL;
178 struct nfs4_state_owner *sp;
181 for (pos = rb_first(&server->state_owners);
183 pos = rb_next(pos)) {
184 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
185 if (list_empty(&sp->so_states))
187 cred = get_rpccred(sp->so_cred);
194 * nfs4_get_renew_cred_locked - Acquire credential for a renew operation
195 * @clp: client state handle
197 * Returns an rpc_cred with reference count bumped, or NULL.
198 * Caller must hold clp->cl_lock.
200 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp)
202 struct rpc_cred *cred = NULL;
203 struct nfs_server *server;
205 /* Use machine credentials if available */
206 cred = nfs4_get_machine_cred_locked(clp);
211 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
212 cred = nfs4_get_renew_cred_server_locked(server);
222 #if defined(CONFIG_NFS_V4_1)
224 static int nfs41_setup_state_renewal(struct nfs_client *clp)
227 struct nfs_fsinfo fsinfo;
229 if (!test_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state)) {
230 nfs4_schedule_state_renewal(clp);
234 status = nfs4_proc_get_lease_time(clp, &fsinfo);
236 /* Update lease time and schedule renewal */
237 spin_lock(&clp->cl_lock);
238 clp->cl_lease_time = fsinfo.lease_time * HZ;
239 clp->cl_last_renewal = jiffies;
240 spin_unlock(&clp->cl_lock);
242 nfs4_schedule_state_renewal(clp);
249 * Back channel returns NFS4ERR_DELAY for new requests when
250 * NFS4_SESSION_DRAINING is set so there is no work to be done when draining
253 static void nfs4_end_drain_session(struct nfs_client *clp)
255 struct nfs4_session *ses = clp->cl_session;
256 struct nfs4_slot_table *tbl;
261 tbl = &ses->fc_slot_table;
262 if (test_and_clear_bit(NFS4_SESSION_DRAINING, &ses->session_state)) {
263 spin_lock(&tbl->slot_tbl_lock);
264 for (i = 0; i <= tbl->max_slotid; i++) {
265 if (rpc_wake_up_first(&tbl->slot_tbl_waitq,
266 nfs4_set_task_privileged,
270 spin_unlock(&tbl->slot_tbl_lock);
275 * Signal state manager thread if session fore channel is drained
277 void nfs4_session_drain_complete(struct nfs4_session *session,
278 struct nfs4_slot_table *tbl)
280 if (nfs4_session_draining(session))
281 complete(&tbl->complete);
284 static int nfs4_wait_on_slot_tbl(struct nfs4_slot_table *tbl)
286 spin_lock(&tbl->slot_tbl_lock);
287 if (tbl->highest_used_slotid != NFS4_NO_SLOT) {
288 INIT_COMPLETION(tbl->complete);
289 spin_unlock(&tbl->slot_tbl_lock);
290 return wait_for_completion_interruptible(&tbl->complete);
292 spin_unlock(&tbl->slot_tbl_lock);
296 static int nfs4_begin_drain_session(struct nfs_client *clp)
298 struct nfs4_session *ses = clp->cl_session;
301 set_bit(NFS4_SESSION_DRAINING, &ses->session_state);
303 ret = nfs4_wait_on_slot_tbl(&ses->bc_slot_table);
307 return nfs4_wait_on_slot_tbl(&ses->fc_slot_table);
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 nfs41_setup_state_renewal(clp);
319 int nfs41_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
323 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
325 nfs4_begin_drain_session(clp);
326 status = nfs4_proc_exchange_id(clp, cred);
329 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
331 status = nfs4_proc_create_session(clp, cred);
334 nfs41_finish_session_reset(clp);
335 nfs_mark_client_ready(clp, NFS_CS_READY);
341 * nfs41_discover_server_trunking - Detect server IP address trunking (mv1)
343 * @clp: nfs_client under test
344 * @result: OUT: found nfs_client, or clp
345 * @cred: credential to use for trunking test
347 * Returns NFS4_OK, a negative errno, or a negative NFS4ERR status.
348 * If NFS4_OK is returned, an nfs_client pointer is planted in
351 * Note: The returned client may not yet be marked ready.
353 int nfs41_discover_server_trunking(struct nfs_client *clp,
354 struct nfs_client **result,
355 struct rpc_cred *cred)
359 status = nfs4_proc_exchange_id(clp, cred);
360 if (status != NFS4_OK)
362 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
364 return nfs41_walk_client_list(clp, result, cred);
367 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp)
369 struct rpc_cred *cred;
371 spin_lock(&clp->cl_lock);
372 cred = nfs4_get_machine_cred_locked(clp);
373 spin_unlock(&clp->cl_lock);
377 #endif /* CONFIG_NFS_V4_1 */
379 static struct rpc_cred *
380 nfs4_get_setclientid_cred_server(struct nfs_server *server)
382 struct nfs_client *clp = server->nfs_client;
383 struct rpc_cred *cred = NULL;
384 struct nfs4_state_owner *sp;
387 spin_lock(&clp->cl_lock);
388 pos = rb_first(&server->state_owners);
390 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
391 cred = get_rpccred(sp->so_cred);
393 spin_unlock(&clp->cl_lock);
398 * nfs4_get_setclientid_cred - Acquire credential for a setclientid operation
399 * @clp: client state handle
401 * Returns an rpc_cred with reference count bumped, or NULL.
403 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp)
405 struct nfs_server *server;
406 struct rpc_cred *cred;
408 spin_lock(&clp->cl_lock);
409 cred = nfs4_get_machine_cred_locked(clp);
410 spin_unlock(&clp->cl_lock);
415 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
416 cred = nfs4_get_setclientid_cred_server(server);
426 static struct nfs4_state_owner *
427 nfs4_find_state_owner_locked(struct nfs_server *server, struct rpc_cred *cred)
429 struct rb_node **p = &server->state_owners.rb_node,
431 struct nfs4_state_owner *sp;
435 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
437 if (cred < sp->so_cred)
438 p = &parent->rb_left;
439 else if (cred > sp->so_cred)
440 p = &parent->rb_right;
442 if (!list_empty(&sp->so_lru))
443 list_del_init(&sp->so_lru);
444 atomic_inc(&sp->so_count);
451 static struct nfs4_state_owner *
452 nfs4_insert_state_owner_locked(struct nfs4_state_owner *new)
454 struct nfs_server *server = new->so_server;
455 struct rb_node **p = &server->state_owners.rb_node,
457 struct nfs4_state_owner *sp;
462 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
464 if (new->so_cred < sp->so_cred)
465 p = &parent->rb_left;
466 else if (new->so_cred > sp->so_cred)
467 p = &parent->rb_right;
469 if (!list_empty(&sp->so_lru))
470 list_del_init(&sp->so_lru);
471 atomic_inc(&sp->so_count);
475 err = ida_get_new(&server->openowner_id, &new->so_seqid.owner_id);
478 rb_link_node(&new->so_server_node, parent, p);
479 rb_insert_color(&new->so_server_node, &server->state_owners);
484 nfs4_remove_state_owner_locked(struct nfs4_state_owner *sp)
486 struct nfs_server *server = sp->so_server;
488 if (!RB_EMPTY_NODE(&sp->so_server_node))
489 rb_erase(&sp->so_server_node, &server->state_owners);
490 ida_remove(&server->openowner_id, sp->so_seqid.owner_id);
494 nfs4_init_seqid_counter(struct nfs_seqid_counter *sc)
496 sc->create_time = ktime_get();
499 spin_lock_init(&sc->lock);
500 INIT_LIST_HEAD(&sc->list);
501 rpc_init_wait_queue(&sc->wait, "Seqid_waitqueue");
505 nfs4_destroy_seqid_counter(struct nfs_seqid_counter *sc)
507 rpc_destroy_wait_queue(&sc->wait);
511 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
512 * create a new state_owner.
515 static struct nfs4_state_owner *
516 nfs4_alloc_state_owner(struct nfs_server *server,
517 struct rpc_cred *cred,
520 struct nfs4_state_owner *sp;
522 sp = kzalloc(sizeof(*sp), gfp_flags);
525 sp->so_server = server;
526 sp->so_cred = get_rpccred(cred);
527 spin_lock_init(&sp->so_lock);
528 INIT_LIST_HEAD(&sp->so_states);
529 nfs4_init_seqid_counter(&sp->so_seqid);
530 atomic_set(&sp->so_count, 1);
531 INIT_LIST_HEAD(&sp->so_lru);
536 nfs4_drop_state_owner(struct nfs4_state_owner *sp)
538 struct rb_node *rb_node = &sp->so_server_node;
540 if (!RB_EMPTY_NODE(rb_node)) {
541 struct nfs_server *server = sp->so_server;
542 struct nfs_client *clp = server->nfs_client;
544 spin_lock(&clp->cl_lock);
545 if (!RB_EMPTY_NODE(rb_node)) {
546 rb_erase(rb_node, &server->state_owners);
547 RB_CLEAR_NODE(rb_node);
549 spin_unlock(&clp->cl_lock);
553 static void nfs4_free_state_owner(struct nfs4_state_owner *sp)
555 nfs4_destroy_seqid_counter(&sp->so_seqid);
556 put_rpccred(sp->so_cred);
560 static void nfs4_gc_state_owners(struct nfs_server *server)
562 struct nfs_client *clp = server->nfs_client;
563 struct nfs4_state_owner *sp, *tmp;
564 unsigned long time_min, time_max;
567 spin_lock(&clp->cl_lock);
569 time_min = (long)time_max - (long)clp->cl_lease_time;
570 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
571 /* NB: LRU is sorted so that oldest is at the head */
572 if (time_in_range(sp->so_expires, time_min, time_max))
574 list_move(&sp->so_lru, &doomed);
575 nfs4_remove_state_owner_locked(sp);
577 spin_unlock(&clp->cl_lock);
579 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
580 list_del(&sp->so_lru);
581 nfs4_free_state_owner(sp);
586 * nfs4_get_state_owner - Look up a state owner given a credential
587 * @server: nfs_server to search
588 * @cred: RPC credential to match
590 * Returns a pointer to an instantiated nfs4_state_owner struct, or NULL.
592 struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *server,
593 struct rpc_cred *cred,
596 struct nfs_client *clp = server->nfs_client;
597 struct nfs4_state_owner *sp, *new;
599 spin_lock(&clp->cl_lock);
600 sp = nfs4_find_state_owner_locked(server, cred);
601 spin_unlock(&clp->cl_lock);
604 new = nfs4_alloc_state_owner(server, cred, gfp_flags);
608 if (ida_pre_get(&server->openowner_id, gfp_flags) == 0)
610 spin_lock(&clp->cl_lock);
611 sp = nfs4_insert_state_owner_locked(new);
612 spin_unlock(&clp->cl_lock);
613 } while (sp == ERR_PTR(-EAGAIN));
615 nfs4_free_state_owner(new);
617 nfs4_gc_state_owners(server);
622 * nfs4_put_state_owner - Release a nfs4_state_owner
623 * @sp: state owner data to release
625 * Note that we keep released state owners on an LRU
627 * This caches valid state owners so that they can be
628 * reused, to avoid the OPEN_CONFIRM on minor version 0.
629 * It also pins the uniquifier of dropped state owners for
630 * a while, to ensure that those state owner names are
633 void nfs4_put_state_owner(struct nfs4_state_owner *sp)
635 struct nfs_server *server = sp->so_server;
636 struct nfs_client *clp = server->nfs_client;
638 if (!atomic_dec_and_lock(&sp->so_count, &clp->cl_lock))
641 sp->so_expires = jiffies;
642 list_add_tail(&sp->so_lru, &server->state_owners_lru);
643 spin_unlock(&clp->cl_lock);
647 * nfs4_purge_state_owners - Release all cached state owners
648 * @server: nfs_server with cached state owners to release
650 * Called at umount time. Remaining state owners will be on
651 * the LRU with ref count of zero.
653 void nfs4_purge_state_owners(struct nfs_server *server)
655 struct nfs_client *clp = server->nfs_client;
656 struct nfs4_state_owner *sp, *tmp;
659 spin_lock(&clp->cl_lock);
660 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
661 list_move(&sp->so_lru, &doomed);
662 nfs4_remove_state_owner_locked(sp);
664 spin_unlock(&clp->cl_lock);
666 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
667 list_del(&sp->so_lru);
668 nfs4_free_state_owner(sp);
672 static struct nfs4_state *
673 nfs4_alloc_open_state(void)
675 struct nfs4_state *state;
677 state = kzalloc(sizeof(*state), GFP_NOFS);
680 atomic_set(&state->count, 1);
681 INIT_LIST_HEAD(&state->lock_states);
682 spin_lock_init(&state->state_lock);
683 seqlock_init(&state->seqlock);
688 nfs4_state_set_mode_locked(struct nfs4_state *state, fmode_t fmode)
690 if (state->state == fmode)
692 /* NB! List reordering - see the reclaim code for why. */
693 if ((fmode & FMODE_WRITE) != (state->state & FMODE_WRITE)) {
694 if (fmode & FMODE_WRITE)
695 list_move(&state->open_states, &state->owner->so_states);
697 list_move_tail(&state->open_states, &state->owner->so_states);
699 state->state = fmode;
702 static struct nfs4_state *
703 __nfs4_find_state_byowner(struct inode *inode, struct nfs4_state_owner *owner)
705 struct nfs_inode *nfsi = NFS_I(inode);
706 struct nfs4_state *state;
708 list_for_each_entry(state, &nfsi->open_states, inode_states) {
709 if (state->owner != owner)
711 if (atomic_inc_not_zero(&state->count))
718 nfs4_free_open_state(struct nfs4_state *state)
724 nfs4_get_open_state(struct inode *inode, struct nfs4_state_owner *owner)
726 struct nfs4_state *state, *new;
727 struct nfs_inode *nfsi = NFS_I(inode);
729 spin_lock(&inode->i_lock);
730 state = __nfs4_find_state_byowner(inode, owner);
731 spin_unlock(&inode->i_lock);
734 new = nfs4_alloc_open_state();
735 spin_lock(&owner->so_lock);
736 spin_lock(&inode->i_lock);
737 state = __nfs4_find_state_byowner(inode, owner);
738 if (state == NULL && new != NULL) {
740 state->owner = owner;
741 atomic_inc(&owner->so_count);
742 list_add(&state->inode_states, &nfsi->open_states);
744 state->inode = inode;
745 spin_unlock(&inode->i_lock);
746 /* Note: The reclaim code dictates that we add stateless
747 * and read-only stateids to the end of the list */
748 list_add_tail(&state->open_states, &owner->so_states);
749 spin_unlock(&owner->so_lock);
751 spin_unlock(&inode->i_lock);
752 spin_unlock(&owner->so_lock);
754 nfs4_free_open_state(new);
760 void nfs4_put_open_state(struct nfs4_state *state)
762 struct inode *inode = state->inode;
763 struct nfs4_state_owner *owner = state->owner;
765 if (!atomic_dec_and_lock(&state->count, &owner->so_lock))
767 spin_lock(&inode->i_lock);
768 list_del(&state->inode_states);
769 list_del(&state->open_states);
770 spin_unlock(&inode->i_lock);
771 spin_unlock(&owner->so_lock);
773 nfs4_free_open_state(state);
774 nfs4_put_state_owner(owner);
778 * Close the current file.
780 static void __nfs4_close(struct nfs4_state *state,
781 fmode_t fmode, gfp_t gfp_mask, int wait)
783 struct nfs4_state_owner *owner = state->owner;
787 atomic_inc(&owner->so_count);
788 /* Protect against nfs4_find_state() */
789 spin_lock(&owner->so_lock);
790 switch (fmode & (FMODE_READ | FMODE_WRITE)) {
797 case FMODE_READ|FMODE_WRITE:
800 newstate = FMODE_READ|FMODE_WRITE;
801 if (state->n_rdwr == 0) {
802 if (state->n_rdonly == 0) {
803 newstate &= ~FMODE_READ;
804 call_close |= test_bit(NFS_O_RDONLY_STATE, &state->flags);
805 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
807 if (state->n_wronly == 0) {
808 newstate &= ~FMODE_WRITE;
809 call_close |= test_bit(NFS_O_WRONLY_STATE, &state->flags);
810 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
813 clear_bit(NFS_DELEGATED_STATE, &state->flags);
815 nfs4_state_set_mode_locked(state, newstate);
816 spin_unlock(&owner->so_lock);
819 nfs4_put_open_state(state);
820 nfs4_put_state_owner(owner);
822 nfs4_do_close(state, gfp_mask, wait);
825 void nfs4_close_state(struct nfs4_state *state, fmode_t fmode)
827 __nfs4_close(state, fmode, GFP_NOFS, 0);
830 void nfs4_close_sync(struct nfs4_state *state, fmode_t fmode)
832 __nfs4_close(state, fmode, GFP_KERNEL, 1);
836 * Search the state->lock_states for an existing lock_owner
837 * that is compatible with current->files
839 static struct nfs4_lock_state *
840 __nfs4_find_lock_state(struct nfs4_state *state, fl_owner_t fl_owner, pid_t fl_pid, unsigned int type)
842 struct nfs4_lock_state *pos;
843 list_for_each_entry(pos, &state->lock_states, ls_locks) {
844 if (type != NFS4_ANY_LOCK_TYPE && pos->ls_owner.lo_type != type)
846 switch (pos->ls_owner.lo_type) {
847 case NFS4_POSIX_LOCK_TYPE:
848 if (pos->ls_owner.lo_u.posix_owner != fl_owner)
851 case NFS4_FLOCK_LOCK_TYPE:
852 if (pos->ls_owner.lo_u.flock_owner != fl_pid)
855 atomic_inc(&pos->ls_count);
862 * Return a compatible lock_state. If no initialized lock_state structure
863 * exists, return an uninitialized one.
866 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)
868 struct nfs4_lock_state *lsp;
869 struct nfs_server *server = state->owner->so_server;
871 lsp = kzalloc(sizeof(*lsp), GFP_NOFS);
874 nfs4_init_seqid_counter(&lsp->ls_seqid);
875 atomic_set(&lsp->ls_count, 1);
876 lsp->ls_state = state;
877 lsp->ls_owner.lo_type = type;
878 switch (lsp->ls_owner.lo_type) {
879 case NFS4_FLOCK_LOCK_TYPE:
880 lsp->ls_owner.lo_u.flock_owner = fl_pid;
882 case NFS4_POSIX_LOCK_TYPE:
883 lsp->ls_owner.lo_u.posix_owner = fl_owner;
888 lsp->ls_seqid.owner_id = ida_simple_get(&server->lockowner_id, 0, 0, GFP_NOFS);
889 if (lsp->ls_seqid.owner_id < 0)
891 INIT_LIST_HEAD(&lsp->ls_locks);
898 void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp)
900 ida_simple_remove(&server->lockowner_id, lsp->ls_seqid.owner_id);
901 nfs4_destroy_seqid_counter(&lsp->ls_seqid);
906 * Return a compatible lock_state. If no initialized lock_state structure
907 * exists, return an uninitialized one.
910 static struct nfs4_lock_state *nfs4_get_lock_state(struct nfs4_state *state, fl_owner_t owner, pid_t pid, unsigned int type)
912 struct nfs4_lock_state *lsp, *new = NULL;
915 spin_lock(&state->state_lock);
916 lsp = __nfs4_find_lock_state(state, owner, pid, type);
920 list_add(&new->ls_locks, &state->lock_states);
921 set_bit(LK_STATE_IN_USE, &state->flags);
926 spin_unlock(&state->state_lock);
927 new = nfs4_alloc_lock_state(state, owner, pid, type);
931 spin_unlock(&state->state_lock);
933 nfs4_free_lock_state(state->owner->so_server, new);
938 * Release reference to lock_state, and free it if we see that
939 * it is no longer in use
941 void nfs4_put_lock_state(struct nfs4_lock_state *lsp)
943 struct nfs4_state *state;
947 state = lsp->ls_state;
948 if (!atomic_dec_and_lock(&lsp->ls_count, &state->state_lock))
950 list_del(&lsp->ls_locks);
951 if (list_empty(&state->lock_states))
952 clear_bit(LK_STATE_IN_USE, &state->flags);
953 spin_unlock(&state->state_lock);
954 if (test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags)) {
955 if (nfs4_release_lockowner(lsp) == 0)
958 nfs4_free_lock_state(lsp->ls_state->owner->so_server, lsp);
961 static void nfs4_fl_copy_lock(struct file_lock *dst, struct file_lock *src)
963 struct nfs4_lock_state *lsp = src->fl_u.nfs4_fl.owner;
965 dst->fl_u.nfs4_fl.owner = lsp;
966 atomic_inc(&lsp->ls_count);
969 static void nfs4_fl_release_lock(struct file_lock *fl)
971 nfs4_put_lock_state(fl->fl_u.nfs4_fl.owner);
974 static const struct file_lock_operations nfs4_fl_lock_ops = {
975 .fl_copy_lock = nfs4_fl_copy_lock,
976 .fl_release_private = nfs4_fl_release_lock,
979 int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl)
981 struct nfs4_lock_state *lsp;
983 if (fl->fl_ops != NULL)
985 if (fl->fl_flags & FL_POSIX)
986 lsp = nfs4_get_lock_state(state, fl->fl_owner, 0, NFS4_POSIX_LOCK_TYPE);
987 else if (fl->fl_flags & FL_FLOCK)
988 lsp = nfs4_get_lock_state(state, NULL, fl->fl_pid,
989 NFS4_FLOCK_LOCK_TYPE);
994 fl->fl_u.nfs4_fl.owner = lsp;
995 fl->fl_ops = &nfs4_fl_lock_ops;
999 static bool nfs4_copy_lock_stateid(nfs4_stateid *dst, struct nfs4_state *state,
1000 const struct nfs_lockowner *lockowner)
1002 struct nfs4_lock_state *lsp;
1003 fl_owner_t fl_owner;
1008 if (lockowner == NULL)
1011 if (test_bit(LK_STATE_IN_USE, &state->flags) == 0)
1014 fl_owner = lockowner->l_owner;
1015 fl_pid = lockowner->l_pid;
1016 spin_lock(&state->state_lock);
1017 lsp = __nfs4_find_lock_state(state, fl_owner, fl_pid, NFS4_ANY_LOCK_TYPE);
1018 if (lsp != NULL && test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags) != 0) {
1019 nfs4_stateid_copy(dst, &lsp->ls_stateid);
1022 spin_unlock(&state->state_lock);
1023 nfs4_put_lock_state(lsp);
1028 static void nfs4_copy_open_stateid(nfs4_stateid *dst, struct nfs4_state *state)
1033 seq = read_seqbegin(&state->seqlock);
1034 nfs4_stateid_copy(dst, &state->stateid);
1035 } while (read_seqretry(&state->seqlock, seq));
1039 * Byte-range lock aware utility to initialize the stateid of read/write
1042 void nfs4_select_rw_stateid(nfs4_stateid *dst, struct nfs4_state *state,
1043 fmode_t fmode, const struct nfs_lockowner *lockowner)
1045 if (nfs4_copy_delegation_stateid(dst, state->inode, fmode))
1047 if (nfs4_copy_lock_stateid(dst, state, lockowner))
1049 nfs4_copy_open_stateid(dst, state);
1052 struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask)
1054 struct nfs_seqid *new;
1056 new = kmalloc(sizeof(*new), gfp_mask);
1058 new->sequence = counter;
1059 INIT_LIST_HEAD(&new->list);
1065 void nfs_release_seqid(struct nfs_seqid *seqid)
1067 struct nfs_seqid_counter *sequence;
1069 if (list_empty(&seqid->list))
1071 sequence = seqid->sequence;
1072 spin_lock(&sequence->lock);
1073 list_del_init(&seqid->list);
1074 if (!list_empty(&sequence->list)) {
1075 struct nfs_seqid *next;
1077 next = list_first_entry(&sequence->list,
1078 struct nfs_seqid, list);
1079 rpc_wake_up_queued_task(&sequence->wait, next->task);
1081 spin_unlock(&sequence->lock);
1084 void nfs_free_seqid(struct nfs_seqid *seqid)
1086 nfs_release_seqid(seqid);
1091 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
1092 * failed with a seqid incrementing error -
1093 * see comments nfs_fs.h:seqid_mutating_error()
1095 static void nfs_increment_seqid(int status, struct nfs_seqid *seqid)
1100 case -NFS4ERR_BAD_SEQID:
1101 if (seqid->sequence->flags & NFS_SEQID_CONFIRMED)
1103 pr_warn_ratelimited("NFS: v4 server returned a bad"
1104 " sequence-id error on an"
1105 " unconfirmed sequence %p!\n",
1107 case -NFS4ERR_STALE_CLIENTID:
1108 case -NFS4ERR_STALE_STATEID:
1109 case -NFS4ERR_BAD_STATEID:
1110 case -NFS4ERR_BADXDR:
1111 case -NFS4ERR_RESOURCE:
1112 case -NFS4ERR_NOFILEHANDLE:
1113 /* Non-seqid mutating errors */
1117 * Note: no locking needed as we are guaranteed to be first
1118 * on the sequence list
1120 seqid->sequence->counter++;
1123 void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid)
1125 struct nfs4_state_owner *sp = container_of(seqid->sequence,
1126 struct nfs4_state_owner, so_seqid);
1127 struct nfs_server *server = sp->so_server;
1129 if (status == -NFS4ERR_BAD_SEQID)
1130 nfs4_drop_state_owner(sp);
1131 if (!nfs4_has_session(server->nfs_client))
1132 nfs_increment_seqid(status, seqid);
1136 * Increment the seqid if the LOCK/LOCKU succeeded, or
1137 * failed with a seqid incrementing error -
1138 * see comments nfs_fs.h:seqid_mutating_error()
1140 void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid)
1142 nfs_increment_seqid(status, seqid);
1145 int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task)
1147 struct nfs_seqid_counter *sequence = seqid->sequence;
1150 spin_lock(&sequence->lock);
1152 if (list_empty(&seqid->list))
1153 list_add_tail(&seqid->list, &sequence->list);
1154 if (list_first_entry(&sequence->list, struct nfs_seqid, list) == seqid)
1156 rpc_sleep_on(&sequence->wait, task, NULL);
1159 spin_unlock(&sequence->lock);
1163 static int nfs4_run_state_manager(void *);
1165 static void nfs4_clear_state_manager_bit(struct nfs_client *clp)
1167 smp_mb__before_clear_bit();
1168 clear_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
1169 smp_mb__after_clear_bit();
1170 wake_up_bit(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING);
1171 rpc_wake_up(&clp->cl_rpcwaitq);
1175 * Schedule the nfs_client asynchronous state management routine
1177 void nfs4_schedule_state_manager(struct nfs_client *clp)
1179 struct task_struct *task;
1180 char buf[INET6_ADDRSTRLEN + sizeof("-manager") + 1];
1182 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
1184 __module_get(THIS_MODULE);
1185 atomic_inc(&clp->cl_count);
1187 /* The rcu_read_lock() is not strictly necessary, as the state
1188 * manager is the only thread that ever changes the rpc_xprt
1189 * after it's initialized. At this point, we're single threaded. */
1191 snprintf(buf, sizeof(buf), "%s-manager",
1192 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_ADDR));
1194 task = kthread_run(nfs4_run_state_manager, clp, buf);
1196 printk(KERN_ERR "%s: kthread_run: %ld\n",
1197 __func__, PTR_ERR(task));
1198 nfs4_clear_state_manager_bit(clp);
1199 nfs_put_client(clp);
1200 module_put(THIS_MODULE);
1205 * Schedule a lease recovery attempt
1207 void nfs4_schedule_lease_recovery(struct nfs_client *clp)
1211 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1212 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1213 dprintk("%s: scheduling lease recovery for server %s\n", __func__,
1215 nfs4_schedule_state_manager(clp);
1217 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_recovery);
1220 * nfs40_handle_cb_pathdown - return all delegations after NFS4ERR_CB_PATH_DOWN
1221 * @clp: client to process
1223 * Set the NFS4CLNT_LEASE_EXPIRED state in order to force a
1224 * resend of the SETCLIENTID and hence re-establish the
1225 * callback channel. Then return all existing delegations.
1227 static void nfs40_handle_cb_pathdown(struct nfs_client *clp)
1229 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1230 nfs_expire_all_delegations(clp);
1231 dprintk("%s: handling CB_PATHDOWN recovery for server %s\n", __func__,
1235 void nfs4_schedule_path_down_recovery(struct nfs_client *clp)
1237 nfs40_handle_cb_pathdown(clp);
1238 nfs4_schedule_state_manager(clp);
1241 static int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state)
1244 set_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1245 /* Don't recover state that expired before the reboot */
1246 if (test_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags)) {
1247 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1250 set_bit(NFS_OWNER_RECLAIM_REBOOT, &state->owner->so_flags);
1251 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1255 static int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state)
1257 set_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags);
1258 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1259 set_bit(NFS_OWNER_RECLAIM_NOGRACE, &state->owner->so_flags);
1260 set_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state);
1264 void nfs4_schedule_stateid_recovery(const struct nfs_server *server, struct nfs4_state *state)
1266 struct nfs_client *clp = server->nfs_client;
1268 nfs4_state_mark_reclaim_nograce(clp, state);
1269 dprintk("%s: scheduling stateid recovery for server %s\n", __func__,
1271 nfs4_schedule_state_manager(clp);
1273 EXPORT_SYMBOL_GPL(nfs4_schedule_stateid_recovery);
1275 void nfs_inode_find_state_and_recover(struct inode *inode,
1276 const nfs4_stateid *stateid)
1278 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1279 struct nfs_inode *nfsi = NFS_I(inode);
1280 struct nfs_open_context *ctx;
1281 struct nfs4_state *state;
1284 spin_lock(&inode->i_lock);
1285 list_for_each_entry(ctx, &nfsi->open_files, list) {
1289 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
1291 if (!nfs4_stateid_match(&state->stateid, stateid))
1293 nfs4_state_mark_reclaim_nograce(clp, state);
1296 spin_unlock(&inode->i_lock);
1298 nfs4_schedule_state_manager(clp);
1302 static int nfs4_reclaim_locks(struct nfs4_state *state, const struct nfs4_state_recovery_ops *ops)
1304 struct inode *inode = state->inode;
1305 struct nfs_inode *nfsi = NFS_I(inode);
1306 struct file_lock *fl;
1309 if (inode->i_flock == NULL)
1312 /* Guard against delegation returns and new lock/unlock calls */
1313 down_write(&nfsi->rwsem);
1314 /* Protect inode->i_flock using the BKL */
1316 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1317 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
1319 if (nfs_file_open_context(fl->fl_file)->state != state)
1322 status = ops->recover_lock(state, fl);
1327 case -NFS4ERR_ADMIN_REVOKED:
1328 case -NFS4ERR_STALE_STATEID:
1329 case -NFS4ERR_BAD_STATEID:
1330 case -NFS4ERR_EXPIRED:
1331 case -NFS4ERR_NO_GRACE:
1332 case -NFS4ERR_STALE_CLIENTID:
1333 case -NFS4ERR_BADSESSION:
1334 case -NFS4ERR_BADSLOT:
1335 case -NFS4ERR_BAD_HIGH_SLOT:
1336 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1339 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1340 "Zeroing state\n", __func__, status);
1342 case -NFS4ERR_DENIED:
1343 case -NFS4ERR_RECLAIM_BAD:
1344 case -NFS4ERR_RECLAIM_CONFLICT:
1345 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
1352 up_write(&nfsi->rwsem);
1356 static int nfs4_reclaim_open_state(struct nfs4_state_owner *sp, const struct nfs4_state_recovery_ops *ops)
1358 struct nfs4_state *state;
1359 struct nfs4_lock_state *lock;
1362 /* Note: we rely on the sp->so_states list being ordered
1363 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
1365 * This is needed to ensure that the server won't give us any
1366 * read delegations that we have to return if, say, we are
1367 * recovering after a network partition or a reboot from a
1368 * server that doesn't support a grace period.
1371 spin_lock(&sp->so_lock);
1372 list_for_each_entry(state, &sp->so_states, open_states) {
1373 if (!test_and_clear_bit(ops->state_flag_bit, &state->flags))
1375 if (state->state == 0)
1377 atomic_inc(&state->count);
1378 spin_unlock(&sp->so_lock);
1379 status = ops->recover_open(sp, state);
1381 status = nfs4_reclaim_locks(state, ops);
1383 spin_lock(&state->state_lock);
1384 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1385 if (!test_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags))
1386 pr_warn_ratelimited("NFS: "
1388 "failed!\n", __func__);
1390 spin_unlock(&state->state_lock);
1391 nfs4_put_open_state(state);
1397 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1398 "Zeroing state\n", __func__, status);
1403 * Open state on this file cannot be recovered
1404 * All we can do is revert to using the zero stateid.
1406 memset(&state->stateid, 0,
1407 sizeof(state->stateid));
1408 /* Mark the file as being 'closed' */
1413 * User RPCSEC_GSS context has expired.
1414 * We cannot recover this stateid now, so
1415 * skip it and allow recovery thread to
1419 case -NFS4ERR_ADMIN_REVOKED:
1420 case -NFS4ERR_STALE_STATEID:
1421 case -NFS4ERR_BAD_STATEID:
1422 case -NFS4ERR_RECLAIM_BAD:
1423 case -NFS4ERR_RECLAIM_CONFLICT:
1424 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1426 case -NFS4ERR_EXPIRED:
1427 case -NFS4ERR_NO_GRACE:
1428 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1429 case -NFS4ERR_STALE_CLIENTID:
1430 case -NFS4ERR_BADSESSION:
1431 case -NFS4ERR_BADSLOT:
1432 case -NFS4ERR_BAD_HIGH_SLOT:
1433 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1436 nfs4_put_open_state(state);
1439 spin_unlock(&sp->so_lock);
1442 nfs4_put_open_state(state);
1446 static void nfs4_clear_open_state(struct nfs4_state *state)
1448 struct nfs4_lock_state *lock;
1450 clear_bit(NFS_DELEGATED_STATE, &state->flags);
1451 clear_bit(NFS_O_RDONLY_STATE, &state->flags);
1452 clear_bit(NFS_O_WRONLY_STATE, &state->flags);
1453 clear_bit(NFS_O_RDWR_STATE, &state->flags);
1454 spin_lock(&state->state_lock);
1455 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1456 lock->ls_seqid.flags = 0;
1457 clear_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags);
1459 spin_unlock(&state->state_lock);
1462 static void nfs4_reset_seqids(struct nfs_server *server,
1463 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1465 struct nfs_client *clp = server->nfs_client;
1466 struct nfs4_state_owner *sp;
1467 struct rb_node *pos;
1468 struct nfs4_state *state;
1470 spin_lock(&clp->cl_lock);
1471 for (pos = rb_first(&server->state_owners);
1473 pos = rb_next(pos)) {
1474 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1475 sp->so_seqid.flags = 0;
1476 spin_lock(&sp->so_lock);
1477 list_for_each_entry(state, &sp->so_states, open_states) {
1478 if (mark_reclaim(clp, state))
1479 nfs4_clear_open_state(state);
1481 spin_unlock(&sp->so_lock);
1483 spin_unlock(&clp->cl_lock);
1486 static void nfs4_state_mark_reclaim_helper(struct nfs_client *clp,
1487 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1489 struct nfs_server *server;
1492 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1493 nfs4_reset_seqids(server, mark_reclaim);
1497 static void nfs4_state_start_reclaim_reboot(struct nfs_client *clp)
1499 /* Mark all delegations for reclaim */
1500 nfs_delegation_mark_reclaim(clp);
1501 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_reboot);
1504 static void nfs4_reclaim_complete(struct nfs_client *clp,
1505 const struct nfs4_state_recovery_ops *ops)
1507 /* Notify the server we're done reclaiming our state */
1508 if (ops->reclaim_complete)
1509 (void)ops->reclaim_complete(clp);
1512 static void nfs4_clear_reclaim_server(struct nfs_server *server)
1514 struct nfs_client *clp = server->nfs_client;
1515 struct nfs4_state_owner *sp;
1516 struct rb_node *pos;
1517 struct nfs4_state *state;
1519 spin_lock(&clp->cl_lock);
1520 for (pos = rb_first(&server->state_owners);
1522 pos = rb_next(pos)) {
1523 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1524 spin_lock(&sp->so_lock);
1525 list_for_each_entry(state, &sp->so_states, open_states) {
1526 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT,
1529 nfs4_state_mark_reclaim_nograce(clp, state);
1531 spin_unlock(&sp->so_lock);
1533 spin_unlock(&clp->cl_lock);
1536 static int nfs4_state_clear_reclaim_reboot(struct nfs_client *clp)
1538 struct nfs_server *server;
1540 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
1544 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1545 nfs4_clear_reclaim_server(server);
1548 nfs_delegation_reap_unclaimed(clp);
1552 static void nfs4_state_end_reclaim_reboot(struct nfs_client *clp)
1554 if (!nfs4_state_clear_reclaim_reboot(clp))
1556 nfs4_reclaim_complete(clp, clp->cl_mvops->reboot_recovery_ops);
1559 static void nfs_delegation_clear_all(struct nfs_client *clp)
1561 nfs_delegation_mark_reclaim(clp);
1562 nfs_delegation_reap_unclaimed(clp);
1565 static void nfs4_state_start_reclaim_nograce(struct nfs_client *clp)
1567 nfs_delegation_clear_all(clp);
1568 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_nograce);
1571 static void nfs4_warn_keyexpired(const char *s)
1573 printk_ratelimited(KERN_WARNING "Error: state manager"
1574 " encountered RPCSEC_GSS session"
1575 " expired against NFSv4 server %s.\n",
1579 static int nfs4_recovery_handle_error(struct nfs_client *clp, int error)
1584 case -NFS4ERR_CB_PATH_DOWN:
1585 nfs40_handle_cb_pathdown(clp);
1587 case -NFS4ERR_NO_GRACE:
1588 nfs4_state_end_reclaim_reboot(clp);
1590 case -NFS4ERR_STALE_CLIENTID:
1591 case -NFS4ERR_LEASE_MOVED:
1592 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1593 nfs4_state_clear_reclaim_reboot(clp);
1594 nfs4_state_start_reclaim_reboot(clp);
1596 case -NFS4ERR_EXPIRED:
1597 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1598 nfs4_state_start_reclaim_nograce(clp);
1600 case -NFS4ERR_BADSESSION:
1601 case -NFS4ERR_BADSLOT:
1602 case -NFS4ERR_BAD_HIGH_SLOT:
1603 case -NFS4ERR_DEADSESSION:
1604 case -NFS4ERR_SEQ_FALSE_RETRY:
1605 case -NFS4ERR_SEQ_MISORDERED:
1606 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1607 /* Zero session reset errors */
1609 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1610 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1613 /* Nothing we can do */
1614 nfs4_warn_keyexpired(clp->cl_hostname);
1617 dprintk("%s: failed to handle error %d for server %s\n",
1618 __func__, error, clp->cl_hostname);
1621 dprintk("%s: handled error %d for server %s\n", __func__, error,
1626 static int nfs4_do_reclaim(struct nfs_client *clp, const struct nfs4_state_recovery_ops *ops)
1628 struct nfs4_state_owner *sp;
1629 struct nfs_server *server;
1630 struct rb_node *pos;
1635 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1636 nfs4_purge_state_owners(server);
1637 spin_lock(&clp->cl_lock);
1638 for (pos = rb_first(&server->state_owners);
1640 pos = rb_next(pos)) {
1642 struct nfs4_state_owner, so_server_node);
1643 if (!test_and_clear_bit(ops->owner_flag_bit,
1646 atomic_inc(&sp->so_count);
1647 spin_unlock(&clp->cl_lock);
1650 status = nfs4_reclaim_open_state(sp, ops);
1652 set_bit(ops->owner_flag_bit, &sp->so_flags);
1653 nfs4_put_state_owner(sp);
1654 return nfs4_recovery_handle_error(clp, status);
1657 nfs4_put_state_owner(sp);
1660 spin_unlock(&clp->cl_lock);
1666 static int nfs4_check_lease(struct nfs_client *clp)
1668 struct rpc_cred *cred;
1669 const struct nfs4_state_maintenance_ops *ops =
1670 clp->cl_mvops->state_renewal_ops;
1673 /* Is the client already known to have an expired lease? */
1674 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1676 spin_lock(&clp->cl_lock);
1677 cred = ops->get_state_renewal_cred_locked(clp);
1678 spin_unlock(&clp->cl_lock);
1680 cred = nfs4_get_setclientid_cred(clp);
1685 status = ops->renew_lease(clp, cred);
1688 return nfs4_recovery_handle_error(clp, status);
1691 /* Set NFS4CLNT_LEASE_EXPIRED and reclaim reboot state for all v4.0 errors
1692 * and for recoverable errors on EXCHANGE_ID for v4.1
1694 static int nfs4_handle_reclaim_lease_error(struct nfs_client *clp, int status)
1697 case -NFS4ERR_SEQ_MISORDERED:
1698 if (test_and_set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state))
1699 return -ESERVERFAULT;
1700 /* Lease confirmation error: retry after purging the lease */
1702 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1704 case -NFS4ERR_STALE_CLIENTID:
1705 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1706 nfs4_state_clear_reclaim_reboot(clp);
1707 nfs4_state_start_reclaim_reboot(clp);
1709 case -NFS4ERR_CLID_INUSE:
1710 pr_err("NFS: Server %s reports our clientid is in use\n",
1712 nfs_mark_client_ready(clp, -EPERM);
1713 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1716 if (clp->cl_machine_cred == NULL)
1718 /* Handle case where the user hasn't set up machine creds */
1719 nfs4_clear_machine_cred(clp);
1720 case -NFS4ERR_DELAY:
1726 case -NFS4ERR_MINOR_VERS_MISMATCH:
1727 if (clp->cl_cons_state == NFS_CS_SESSION_INITING)
1728 nfs_mark_client_ready(clp, -EPROTONOSUPPORT);
1729 dprintk("%s: exit with error %d for server %s\n",
1730 __func__, -EPROTONOSUPPORT, clp->cl_hostname);
1731 return -EPROTONOSUPPORT;
1733 nfs4_warn_keyexpired(clp->cl_hostname);
1734 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1735 * in nfs4_exchange_id */
1737 dprintk("%s: exit with error %d for server %s\n", __func__,
1738 status, clp->cl_hostname);
1741 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1742 dprintk("%s: handled error %d for server %s\n", __func__, status,
1747 static int nfs4_establish_lease(struct nfs_client *clp)
1749 struct rpc_cred *cred;
1750 const struct nfs4_state_recovery_ops *ops =
1751 clp->cl_mvops->reboot_recovery_ops;
1754 cred = ops->get_clid_cred(clp);
1757 status = ops->establish_clid(clp, cred);
1761 pnfs_destroy_all_layouts(clp);
1766 * Returns zero or a negative errno. NFS4ERR values are converted
1767 * to local errno values.
1769 static int nfs4_reclaim_lease(struct nfs_client *clp)
1773 status = nfs4_establish_lease(clp);
1775 return nfs4_handle_reclaim_lease_error(clp, status);
1776 if (test_and_clear_bit(NFS4CLNT_SERVER_SCOPE_MISMATCH, &clp->cl_state))
1777 nfs4_state_start_reclaim_nograce(clp);
1778 if (!test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
1779 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1780 clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1781 clear_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1785 static int nfs4_purge_lease(struct nfs_client *clp)
1789 status = nfs4_establish_lease(clp);
1791 return nfs4_handle_reclaim_lease_error(clp, status);
1792 clear_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
1793 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1794 nfs4_state_start_reclaim_nograce(clp);
1799 * nfs4_discover_server_trunking - Detect server IP address trunking
1801 * @clp: nfs_client under test
1802 * @result: OUT: found nfs_client, or clp
1804 * Returns zero or a negative errno. If zero is returned,
1805 * an nfs_client pointer is planted in "result".
1807 * Note: since we are invoked in process context, and
1808 * not from inside the state manager, we cannot use
1809 * nfs4_handle_reclaim_lease_error().
1811 int nfs4_discover_server_trunking(struct nfs_client *clp,
1812 struct nfs_client **result)
1814 const struct nfs4_state_recovery_ops *ops =
1815 clp->cl_mvops->reboot_recovery_ops;
1816 rpc_authflavor_t *flavors, flav, save;
1817 struct rpc_clnt *clnt;
1818 struct rpc_cred *cred;
1821 dprintk("NFS: %s: testing '%s'\n", __func__, clp->cl_hostname);
1823 len = NFS_MAX_SECFLAVORS;
1824 flavors = kcalloc(len, sizeof(*flavors), GFP_KERNEL);
1825 if (flavors == NULL) {
1829 len = rpcauth_list_flavors(flavors, len);
1834 clnt = clp->cl_rpcclient;
1835 save = clnt->cl_auth->au_flavor;
1838 mutex_lock(&nfs_clid_init_mutex);
1841 cred = ops->get_clid_cred(clp);
1845 status = ops->detect_trunking(clp, result, cred);
1852 if (clp->cl_machine_cred == NULL)
1854 /* Handle case where the user hasn't set up machine creds */
1855 nfs4_clear_machine_cred(clp);
1856 case -NFS4ERR_DELAY:
1860 dprintk("NFS: %s after status %d, retrying\n",
1864 case -NFS4ERR_CLID_INUSE:
1865 case -NFS4ERR_WRONGSEC:
1870 flav = flavors[i++];
1872 flav = flavors[i++];
1873 clnt = rpc_clone_client_set_auth(clnt, flav);
1875 status = PTR_ERR(clnt);
1878 clp->cl_rpcclient = clnt;
1881 case -NFS4ERR_MINOR_VERS_MISMATCH:
1882 status = -EPROTONOSUPPORT;
1886 nfs4_warn_keyexpired(clp->cl_hostname);
1887 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1888 * in nfs4_exchange_id */
1889 status = -EKEYEXPIRED;
1893 mutex_unlock(&nfs_clid_init_mutex);
1897 dprintk("NFS: %s: status = %d\n", __func__, status);
1901 #ifdef CONFIG_NFS_V4_1
1902 void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
1904 struct nfs_client *clp = session->clp;
1908 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1910 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1911 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1913 nfs4_schedule_lease_recovery(clp);
1915 EXPORT_SYMBOL_GPL(nfs4_schedule_session_recovery);
1917 static void nfs41_ping_server(struct nfs_client *clp)
1919 /* Use CHECK_LEASE to ping the server with a SEQUENCE */
1920 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1921 nfs4_schedule_state_manager(clp);
1924 void nfs41_server_notify_target_slotid_update(struct nfs_client *clp)
1926 nfs41_ping_server(clp);
1929 static void nfs4_reset_all_state(struct nfs_client *clp)
1931 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1932 set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
1933 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1934 nfs4_state_start_reclaim_nograce(clp);
1935 dprintk("%s: scheduling reset of all state for server %s!\n",
1936 __func__, clp->cl_hostname);
1937 nfs4_schedule_state_manager(clp);
1941 static void nfs41_handle_server_reboot(struct nfs_client *clp)
1943 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1944 nfs4_state_start_reclaim_reboot(clp);
1945 dprintk("%s: server %s rebooted!\n", __func__,
1947 nfs4_schedule_state_manager(clp);
1951 static void nfs41_handle_state_revoked(struct nfs_client *clp)
1953 nfs4_reset_all_state(clp);
1954 dprintk("%s: state revoked on server %s\n", __func__, clp->cl_hostname);
1957 static void nfs41_handle_recallable_state_revoked(struct nfs_client *clp)
1959 /* This will need to handle layouts too */
1960 nfs_expire_all_delegations(clp);
1961 dprintk("%s: Recallable state revoked on server %s!\n", __func__,
1965 static void nfs41_handle_backchannel_fault(struct nfs_client *clp)
1967 nfs_expire_all_delegations(clp);
1968 if (test_and_set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) == 0)
1969 nfs4_schedule_state_manager(clp);
1970 dprintk("%s: server %s declared a backchannel fault\n", __func__,
1974 static void nfs41_handle_cb_path_down(struct nfs_client *clp)
1976 if (test_and_set_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
1977 &clp->cl_state) == 0)
1978 nfs4_schedule_state_manager(clp);
1981 void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags)
1986 dprintk("%s: \"%s\" (client ID %llx) flags=0x%08x\n",
1987 __func__, clp->cl_hostname, clp->cl_clientid, flags);
1989 if (flags & SEQ4_STATUS_RESTART_RECLAIM_NEEDED)
1990 nfs41_handle_server_reboot(clp);
1991 if (flags & (SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED |
1992 SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED |
1993 SEQ4_STATUS_ADMIN_STATE_REVOKED |
1994 SEQ4_STATUS_LEASE_MOVED))
1995 nfs41_handle_state_revoked(clp);
1996 if (flags & SEQ4_STATUS_RECALLABLE_STATE_REVOKED)
1997 nfs41_handle_recallable_state_revoked(clp);
1998 if (flags & SEQ4_STATUS_BACKCHANNEL_FAULT)
1999 nfs41_handle_backchannel_fault(clp);
2000 else if (flags & (SEQ4_STATUS_CB_PATH_DOWN |
2001 SEQ4_STATUS_CB_PATH_DOWN_SESSION))
2002 nfs41_handle_cb_path_down(clp);
2005 static int nfs4_reset_session(struct nfs_client *clp)
2007 struct rpc_cred *cred;
2010 if (!nfs4_has_session(clp))
2012 nfs4_begin_drain_session(clp);
2013 cred = nfs4_get_exchange_id_cred(clp);
2014 status = nfs4_proc_destroy_session(clp->cl_session, cred);
2015 if (status && status != -NFS4ERR_BADSESSION &&
2016 status != -NFS4ERR_DEADSESSION) {
2017 status = nfs4_recovery_handle_error(clp, status);
2021 memset(clp->cl_session->sess_id.data, 0, NFS4_MAX_SESSIONID_LEN);
2022 status = nfs4_proc_create_session(clp, cred);
2024 dprintk("%s: session reset failed with status %d for server %s!\n",
2025 __func__, status, clp->cl_hostname);
2026 status = nfs4_handle_reclaim_lease_error(clp, status);
2029 nfs41_finish_session_reset(clp);
2030 dprintk("%s: session reset was successful for server %s!\n",
2031 __func__, clp->cl_hostname);
2038 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2040 struct rpc_cred *cred;
2043 if (!nfs4_has_session(clp))
2045 nfs4_begin_drain_session(clp);
2046 cred = nfs4_get_exchange_id_cred(clp);
2047 ret = nfs4_proc_bind_conn_to_session(clp, cred);
2050 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2053 dprintk("%s: bind_conn_to_session was successful for server %s!\n",
2054 __func__, clp->cl_hostname);
2056 case -NFS4ERR_DELAY:
2058 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2061 return nfs4_recovery_handle_error(clp, ret);
2065 #else /* CONFIG_NFS_V4_1 */
2066 static int nfs4_reset_session(struct nfs_client *clp) { return 0; }
2067 static int nfs4_end_drain_session(struct nfs_client *clp) { return 0; }
2069 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2073 #endif /* CONFIG_NFS_V4_1 */
2075 static void nfs4_state_manager(struct nfs_client *clp)
2078 const char *section = "", *section_sep = "";
2080 /* Ensure exclusive access to NFSv4 state */
2082 if (test_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state)) {
2083 section = "purge state";
2084 status = nfs4_purge_lease(clp);
2090 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state)) {
2091 section = "lease expired";
2092 /* We're going to have to re-establish a clientid */
2093 status = nfs4_reclaim_lease(clp);
2099 /* Initialize or reset the session */
2100 if (test_and_clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state)) {
2101 section = "reset session";
2102 status = nfs4_reset_session(clp);
2103 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
2109 /* Send BIND_CONN_TO_SESSION */
2110 if (test_and_clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2112 section = "bind conn to session";
2113 status = nfs4_bind_conn_to_session(clp);
2119 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state)) {
2120 section = "check lease";
2121 status = nfs4_check_lease(clp);
2127 /* First recover reboot state... */
2128 if (test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state)) {
2129 section = "reclaim reboot";
2130 status = nfs4_do_reclaim(clp,
2131 clp->cl_mvops->reboot_recovery_ops);
2132 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
2133 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
2135 nfs4_state_end_reclaim_reboot(clp);
2136 if (test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
2142 /* Now recover expired state... */
2143 if (test_and_clear_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state)) {
2144 section = "reclaim nograce";
2145 status = nfs4_do_reclaim(clp,
2146 clp->cl_mvops->nograce_recovery_ops);
2147 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
2148 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) ||
2149 test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
2155 nfs4_end_drain_session(clp);
2156 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state)) {
2157 nfs_client_return_marked_delegations(clp);
2161 nfs4_clear_state_manager_bit(clp);
2162 /* Did we race with an attempt to give us more work? */
2163 if (clp->cl_state == 0)
2165 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
2167 } while (atomic_read(&clp->cl_count) > 1);
2170 if (strlen(section))
2172 pr_warn_ratelimited("NFS: state manager%s%s failed on NFSv4 server %s"
2173 " with error %d\n", section_sep, section,
2174 clp->cl_hostname, -status);
2176 nfs4_end_drain_session(clp);
2177 nfs4_clear_state_manager_bit(clp);
2180 static int nfs4_run_state_manager(void *ptr)
2182 struct nfs_client *clp = ptr;
2184 allow_signal(SIGKILL);
2185 nfs4_state_manager(clp);
2186 nfs_put_client(clp);
2187 module_put_and_exit(0);