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 struct rpc_cred *
158 nfs4_get_renew_cred_server_locked(struct nfs_server *server)
160 struct rpc_cred *cred = NULL;
161 struct nfs4_state_owner *sp;
164 for (pos = rb_first(&server->state_owners);
166 pos = rb_next(pos)) {
167 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
168 if (list_empty(&sp->so_states))
170 cred = get_rpccred(sp->so_cred);
177 * nfs4_get_renew_cred_locked - Acquire credential for a renew operation
178 * @clp: client state handle
180 * Returns an rpc_cred with reference count bumped, or NULL.
181 * Caller must hold clp->cl_lock.
183 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp)
185 struct rpc_cred *cred = NULL;
186 struct nfs_server *server;
188 /* Use machine credentials if available */
189 cred = nfs4_get_machine_cred_locked(clp);
194 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
195 cred = nfs4_get_renew_cred_server_locked(server);
205 #if defined(CONFIG_NFS_V4_1)
207 static int nfs41_setup_state_renewal(struct nfs_client *clp)
210 struct nfs_fsinfo fsinfo;
212 if (!test_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state)) {
213 nfs4_schedule_state_renewal(clp);
217 status = nfs4_proc_get_lease_time(clp, &fsinfo);
219 /* Update lease time and schedule renewal */
220 spin_lock(&clp->cl_lock);
221 clp->cl_lease_time = fsinfo.lease_time * HZ;
222 clp->cl_last_renewal = jiffies;
223 spin_unlock(&clp->cl_lock);
225 nfs4_schedule_state_renewal(clp);
232 * Back channel returns NFS4ERR_DELAY for new requests when
233 * NFS4_SESSION_DRAINING is set so there is no work to be done when draining
236 static void nfs4_end_drain_session(struct nfs_client *clp)
238 struct nfs4_session *ses = clp->cl_session;
239 struct nfs4_slot_table *tbl;
243 tbl = &ses->fc_slot_table;
244 if (test_and_clear_bit(NFS4_SESSION_DRAINING, &ses->session_state)) {
245 spin_lock(&tbl->slot_tbl_lock);
246 nfs41_wake_slot_table(tbl);
247 spin_unlock(&tbl->slot_tbl_lock);
252 * Signal state manager thread if session fore channel is drained
254 void nfs4_session_drain_complete(struct nfs4_session *session,
255 struct nfs4_slot_table *tbl)
257 if (nfs4_session_draining(session))
258 complete(&tbl->complete);
261 static int nfs4_wait_on_slot_tbl(struct nfs4_slot_table *tbl)
263 spin_lock(&tbl->slot_tbl_lock);
264 if (tbl->highest_used_slotid != NFS4_NO_SLOT) {
265 INIT_COMPLETION(tbl->complete);
266 spin_unlock(&tbl->slot_tbl_lock);
267 return wait_for_completion_interruptible(&tbl->complete);
269 spin_unlock(&tbl->slot_tbl_lock);
273 static int nfs4_begin_drain_session(struct nfs_client *clp)
275 struct nfs4_session *ses = clp->cl_session;
278 set_bit(NFS4_SESSION_DRAINING, &ses->session_state);
280 ret = nfs4_wait_on_slot_tbl(&ses->bc_slot_table);
284 return nfs4_wait_on_slot_tbl(&ses->fc_slot_table);
287 static void nfs41_finish_session_reset(struct nfs_client *clp)
289 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
290 clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
291 /* create_session negotiated new slot table */
292 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
293 nfs41_setup_state_renewal(clp);
296 int nfs41_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
300 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
302 nfs4_begin_drain_session(clp);
303 status = nfs4_proc_exchange_id(clp, cred);
306 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
308 status = nfs4_proc_create_session(clp, cred);
311 nfs41_finish_session_reset(clp);
312 nfs_mark_client_ready(clp, NFS_CS_READY);
318 * nfs41_discover_server_trunking - Detect server IP address trunking (mv1)
320 * @clp: nfs_client under test
321 * @result: OUT: found nfs_client, or clp
322 * @cred: credential to use for trunking test
324 * Returns NFS4_OK, a negative errno, or a negative NFS4ERR status.
325 * If NFS4_OK is returned, an nfs_client pointer is planted in
328 * Note: The returned client may not yet be marked ready.
330 int nfs41_discover_server_trunking(struct nfs_client *clp,
331 struct nfs_client **result,
332 struct rpc_cred *cred)
336 status = nfs4_proc_exchange_id(clp, cred);
337 if (status != NFS4_OK)
339 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
341 return nfs41_walk_client_list(clp, result, cred);
344 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp)
346 struct rpc_cred *cred;
348 spin_lock(&clp->cl_lock);
349 cred = nfs4_get_machine_cred_locked(clp);
350 spin_unlock(&clp->cl_lock);
354 #endif /* CONFIG_NFS_V4_1 */
356 static struct rpc_cred *
357 nfs4_get_setclientid_cred_server(struct nfs_server *server)
359 struct nfs_client *clp = server->nfs_client;
360 struct rpc_cred *cred = NULL;
361 struct nfs4_state_owner *sp;
364 spin_lock(&clp->cl_lock);
365 pos = rb_first(&server->state_owners);
367 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
368 cred = get_rpccred(sp->so_cred);
370 spin_unlock(&clp->cl_lock);
375 * nfs4_get_setclientid_cred - Acquire credential for a setclientid operation
376 * @clp: client state handle
378 * Returns an rpc_cred with reference count bumped, or NULL.
380 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp)
382 struct nfs_server *server;
383 struct rpc_cred *cred;
385 spin_lock(&clp->cl_lock);
386 cred = nfs4_get_machine_cred_locked(clp);
387 spin_unlock(&clp->cl_lock);
392 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
393 cred = nfs4_get_setclientid_cred_server(server);
403 static struct nfs4_state_owner *
404 nfs4_find_state_owner_locked(struct nfs_server *server, struct rpc_cred *cred)
406 struct rb_node **p = &server->state_owners.rb_node,
408 struct nfs4_state_owner *sp;
412 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
414 if (cred < sp->so_cred)
415 p = &parent->rb_left;
416 else if (cred > sp->so_cred)
417 p = &parent->rb_right;
419 if (!list_empty(&sp->so_lru))
420 list_del_init(&sp->so_lru);
421 atomic_inc(&sp->so_count);
428 static struct nfs4_state_owner *
429 nfs4_insert_state_owner_locked(struct nfs4_state_owner *new)
431 struct nfs_server *server = new->so_server;
432 struct rb_node **p = &server->state_owners.rb_node,
434 struct nfs4_state_owner *sp;
439 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
441 if (new->so_cred < sp->so_cred)
442 p = &parent->rb_left;
443 else if (new->so_cred > sp->so_cred)
444 p = &parent->rb_right;
446 if (!list_empty(&sp->so_lru))
447 list_del_init(&sp->so_lru);
448 atomic_inc(&sp->so_count);
452 err = ida_get_new(&server->openowner_id, &new->so_seqid.owner_id);
455 rb_link_node(&new->so_server_node, parent, p);
456 rb_insert_color(&new->so_server_node, &server->state_owners);
461 nfs4_remove_state_owner_locked(struct nfs4_state_owner *sp)
463 struct nfs_server *server = sp->so_server;
465 if (!RB_EMPTY_NODE(&sp->so_server_node))
466 rb_erase(&sp->so_server_node, &server->state_owners);
467 ida_remove(&server->openowner_id, sp->so_seqid.owner_id);
471 nfs4_init_seqid_counter(struct nfs_seqid_counter *sc)
473 sc->create_time = ktime_get();
476 spin_lock_init(&sc->lock);
477 INIT_LIST_HEAD(&sc->list);
478 rpc_init_wait_queue(&sc->wait, "Seqid_waitqueue");
482 nfs4_destroy_seqid_counter(struct nfs_seqid_counter *sc)
484 rpc_destroy_wait_queue(&sc->wait);
488 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
489 * create a new state_owner.
492 static struct nfs4_state_owner *
493 nfs4_alloc_state_owner(struct nfs_server *server,
494 struct rpc_cred *cred,
497 struct nfs4_state_owner *sp;
499 sp = kzalloc(sizeof(*sp), gfp_flags);
502 sp->so_server = server;
503 sp->so_cred = get_rpccred(cred);
504 spin_lock_init(&sp->so_lock);
505 INIT_LIST_HEAD(&sp->so_states);
506 nfs4_init_seqid_counter(&sp->so_seqid);
507 atomic_set(&sp->so_count, 1);
508 INIT_LIST_HEAD(&sp->so_lru);
509 seqcount_init(&sp->so_reclaim_seqcount);
510 mutex_init(&sp->so_delegreturn_mutex);
515 nfs4_drop_state_owner(struct nfs4_state_owner *sp)
517 struct rb_node *rb_node = &sp->so_server_node;
519 if (!RB_EMPTY_NODE(rb_node)) {
520 struct nfs_server *server = sp->so_server;
521 struct nfs_client *clp = server->nfs_client;
523 spin_lock(&clp->cl_lock);
524 if (!RB_EMPTY_NODE(rb_node)) {
525 rb_erase(rb_node, &server->state_owners);
526 RB_CLEAR_NODE(rb_node);
528 spin_unlock(&clp->cl_lock);
532 static void nfs4_free_state_owner(struct nfs4_state_owner *sp)
534 nfs4_destroy_seqid_counter(&sp->so_seqid);
535 put_rpccred(sp->so_cred);
539 static void nfs4_gc_state_owners(struct nfs_server *server)
541 struct nfs_client *clp = server->nfs_client;
542 struct nfs4_state_owner *sp, *tmp;
543 unsigned long time_min, time_max;
546 spin_lock(&clp->cl_lock);
548 time_min = (long)time_max - (long)clp->cl_lease_time;
549 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
550 /* NB: LRU is sorted so that oldest is at the head */
551 if (time_in_range(sp->so_expires, time_min, time_max))
553 list_move(&sp->so_lru, &doomed);
554 nfs4_remove_state_owner_locked(sp);
556 spin_unlock(&clp->cl_lock);
558 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
559 list_del(&sp->so_lru);
560 nfs4_free_state_owner(sp);
565 * nfs4_get_state_owner - Look up a state owner given a credential
566 * @server: nfs_server to search
567 * @cred: RPC credential to match
569 * Returns a pointer to an instantiated nfs4_state_owner struct, or NULL.
571 struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *server,
572 struct rpc_cred *cred,
575 struct nfs_client *clp = server->nfs_client;
576 struct nfs4_state_owner *sp, *new;
578 spin_lock(&clp->cl_lock);
579 sp = nfs4_find_state_owner_locked(server, cred);
580 spin_unlock(&clp->cl_lock);
583 new = nfs4_alloc_state_owner(server, cred, gfp_flags);
587 if (ida_pre_get(&server->openowner_id, gfp_flags) == 0)
589 spin_lock(&clp->cl_lock);
590 sp = nfs4_insert_state_owner_locked(new);
591 spin_unlock(&clp->cl_lock);
592 } while (sp == ERR_PTR(-EAGAIN));
594 nfs4_free_state_owner(new);
596 nfs4_gc_state_owners(server);
601 * nfs4_put_state_owner - Release a nfs4_state_owner
602 * @sp: state owner data to release
604 * Note that we keep released state owners on an LRU
606 * This caches valid state owners so that they can be
607 * reused, to avoid the OPEN_CONFIRM on minor version 0.
608 * It also pins the uniquifier of dropped state owners for
609 * a while, to ensure that those state owner names are
612 void nfs4_put_state_owner(struct nfs4_state_owner *sp)
614 struct nfs_server *server = sp->so_server;
615 struct nfs_client *clp = server->nfs_client;
617 if (!atomic_dec_and_lock(&sp->so_count, &clp->cl_lock))
620 sp->so_expires = jiffies;
621 list_add_tail(&sp->so_lru, &server->state_owners_lru);
622 spin_unlock(&clp->cl_lock);
626 * nfs4_purge_state_owners - Release all cached state owners
627 * @server: nfs_server with cached state owners to release
629 * Called at umount time. Remaining state owners will be on
630 * the LRU with ref count of zero.
632 void nfs4_purge_state_owners(struct nfs_server *server)
634 struct nfs_client *clp = server->nfs_client;
635 struct nfs4_state_owner *sp, *tmp;
638 spin_lock(&clp->cl_lock);
639 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
640 list_move(&sp->so_lru, &doomed);
641 nfs4_remove_state_owner_locked(sp);
643 spin_unlock(&clp->cl_lock);
645 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
646 list_del(&sp->so_lru);
647 nfs4_free_state_owner(sp);
651 static struct nfs4_state *
652 nfs4_alloc_open_state(void)
654 struct nfs4_state *state;
656 state = kzalloc(sizeof(*state), GFP_NOFS);
659 atomic_set(&state->count, 1);
660 INIT_LIST_HEAD(&state->lock_states);
661 spin_lock_init(&state->state_lock);
662 seqlock_init(&state->seqlock);
667 nfs4_state_set_mode_locked(struct nfs4_state *state, fmode_t fmode)
669 if (state->state == fmode)
671 /* NB! List reordering - see the reclaim code for why. */
672 if ((fmode & FMODE_WRITE) != (state->state & FMODE_WRITE)) {
673 if (fmode & FMODE_WRITE)
674 list_move(&state->open_states, &state->owner->so_states);
676 list_move_tail(&state->open_states, &state->owner->so_states);
678 state->state = fmode;
681 static struct nfs4_state *
682 __nfs4_find_state_byowner(struct inode *inode, struct nfs4_state_owner *owner)
684 struct nfs_inode *nfsi = NFS_I(inode);
685 struct nfs4_state *state;
687 list_for_each_entry(state, &nfsi->open_states, inode_states) {
688 if (state->owner != owner)
690 if (!nfs4_valid_open_stateid(state))
692 if (atomic_inc_not_zero(&state->count))
699 nfs4_free_open_state(struct nfs4_state *state)
705 nfs4_get_open_state(struct inode *inode, struct nfs4_state_owner *owner)
707 struct nfs4_state *state, *new;
708 struct nfs_inode *nfsi = NFS_I(inode);
710 spin_lock(&inode->i_lock);
711 state = __nfs4_find_state_byowner(inode, owner);
712 spin_unlock(&inode->i_lock);
715 new = nfs4_alloc_open_state();
716 spin_lock(&owner->so_lock);
717 spin_lock(&inode->i_lock);
718 state = __nfs4_find_state_byowner(inode, owner);
719 if (state == NULL && new != NULL) {
721 state->owner = owner;
722 atomic_inc(&owner->so_count);
723 list_add(&state->inode_states, &nfsi->open_states);
725 state->inode = inode;
726 spin_unlock(&inode->i_lock);
727 /* Note: The reclaim code dictates that we add stateless
728 * and read-only stateids to the end of the list */
729 list_add_tail(&state->open_states, &owner->so_states);
730 spin_unlock(&owner->so_lock);
732 spin_unlock(&inode->i_lock);
733 spin_unlock(&owner->so_lock);
735 nfs4_free_open_state(new);
741 void nfs4_put_open_state(struct nfs4_state *state)
743 struct inode *inode = state->inode;
744 struct nfs4_state_owner *owner = state->owner;
746 if (!atomic_dec_and_lock(&state->count, &owner->so_lock))
748 spin_lock(&inode->i_lock);
749 list_del(&state->inode_states);
750 list_del(&state->open_states);
751 spin_unlock(&inode->i_lock);
752 spin_unlock(&owner->so_lock);
754 nfs4_free_open_state(state);
755 nfs4_put_state_owner(owner);
759 * Close the current file.
761 static void __nfs4_close(struct nfs4_state *state,
762 fmode_t fmode, gfp_t gfp_mask, int wait)
764 struct nfs4_state_owner *owner = state->owner;
768 atomic_inc(&owner->so_count);
769 /* Protect against nfs4_find_state() */
770 spin_lock(&owner->so_lock);
771 switch (fmode & (FMODE_READ | FMODE_WRITE)) {
778 case FMODE_READ|FMODE_WRITE:
781 newstate = FMODE_READ|FMODE_WRITE;
782 if (state->n_rdwr == 0) {
783 if (state->n_rdonly == 0) {
784 newstate &= ~FMODE_READ;
785 call_close |= test_bit(NFS_O_RDONLY_STATE, &state->flags);
786 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
788 if (state->n_wronly == 0) {
789 newstate &= ~FMODE_WRITE;
790 call_close |= test_bit(NFS_O_WRONLY_STATE, &state->flags);
791 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
794 clear_bit(NFS_DELEGATED_STATE, &state->flags);
796 nfs4_state_set_mode_locked(state, newstate);
797 spin_unlock(&owner->so_lock);
800 nfs4_put_open_state(state);
801 nfs4_put_state_owner(owner);
803 nfs4_do_close(state, gfp_mask, wait);
806 void nfs4_close_state(struct nfs4_state *state, fmode_t fmode)
808 __nfs4_close(state, fmode, GFP_NOFS, 0);
811 void nfs4_close_sync(struct nfs4_state *state, fmode_t fmode)
813 __nfs4_close(state, fmode, GFP_KERNEL, 1);
817 * Search the state->lock_states for an existing lock_owner
818 * that is compatible with current->files
820 static struct nfs4_lock_state *
821 __nfs4_find_lock_state(struct nfs4_state *state, fl_owner_t fl_owner, pid_t fl_pid, unsigned int type)
823 struct nfs4_lock_state *pos;
824 list_for_each_entry(pos, &state->lock_states, ls_locks) {
825 if (type != NFS4_ANY_LOCK_TYPE && pos->ls_owner.lo_type != type)
827 switch (pos->ls_owner.lo_type) {
828 case NFS4_POSIX_LOCK_TYPE:
829 if (pos->ls_owner.lo_u.posix_owner != fl_owner)
832 case NFS4_FLOCK_LOCK_TYPE:
833 if (pos->ls_owner.lo_u.flock_owner != fl_pid)
836 atomic_inc(&pos->ls_count);
843 * Return a compatible lock_state. If no initialized lock_state structure
844 * exists, return an uninitialized one.
847 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)
849 struct nfs4_lock_state *lsp;
850 struct nfs_server *server = state->owner->so_server;
852 lsp = kzalloc(sizeof(*lsp), GFP_NOFS);
855 nfs4_init_seqid_counter(&lsp->ls_seqid);
856 atomic_set(&lsp->ls_count, 1);
857 lsp->ls_state = state;
858 lsp->ls_owner.lo_type = type;
859 switch (lsp->ls_owner.lo_type) {
860 case NFS4_FLOCK_LOCK_TYPE:
861 lsp->ls_owner.lo_u.flock_owner = fl_pid;
863 case NFS4_POSIX_LOCK_TYPE:
864 lsp->ls_owner.lo_u.posix_owner = fl_owner;
869 lsp->ls_seqid.owner_id = ida_simple_get(&server->lockowner_id, 0, 0, GFP_NOFS);
870 if (lsp->ls_seqid.owner_id < 0)
872 INIT_LIST_HEAD(&lsp->ls_locks);
879 void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp)
881 ida_simple_remove(&server->lockowner_id, lsp->ls_seqid.owner_id);
882 nfs4_destroy_seqid_counter(&lsp->ls_seqid);
887 * Return a compatible lock_state. If no initialized lock_state structure
888 * exists, return an uninitialized one.
891 static struct nfs4_lock_state *nfs4_get_lock_state(struct nfs4_state *state, fl_owner_t owner, pid_t pid, unsigned int type)
893 struct nfs4_lock_state *lsp, *new = NULL;
896 spin_lock(&state->state_lock);
897 lsp = __nfs4_find_lock_state(state, owner, pid, type);
901 list_add(&new->ls_locks, &state->lock_states);
902 set_bit(LK_STATE_IN_USE, &state->flags);
907 spin_unlock(&state->state_lock);
908 new = nfs4_alloc_lock_state(state, owner, pid, type);
912 spin_unlock(&state->state_lock);
914 nfs4_free_lock_state(state->owner->so_server, new);
919 * Release reference to lock_state, and free it if we see that
920 * it is no longer in use
922 void nfs4_put_lock_state(struct nfs4_lock_state *lsp)
924 struct nfs4_state *state;
928 state = lsp->ls_state;
929 if (!atomic_dec_and_lock(&lsp->ls_count, &state->state_lock))
931 list_del(&lsp->ls_locks);
932 if (list_empty(&state->lock_states))
933 clear_bit(LK_STATE_IN_USE, &state->flags);
934 spin_unlock(&state->state_lock);
935 if (test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags)) {
936 if (nfs4_release_lockowner(lsp) == 0)
939 nfs4_free_lock_state(lsp->ls_state->owner->so_server, lsp);
942 static void nfs4_fl_copy_lock(struct file_lock *dst, struct file_lock *src)
944 struct nfs4_lock_state *lsp = src->fl_u.nfs4_fl.owner;
946 dst->fl_u.nfs4_fl.owner = lsp;
947 atomic_inc(&lsp->ls_count);
950 static void nfs4_fl_release_lock(struct file_lock *fl)
952 nfs4_put_lock_state(fl->fl_u.nfs4_fl.owner);
955 static const struct file_lock_operations nfs4_fl_lock_ops = {
956 .fl_copy_lock = nfs4_fl_copy_lock,
957 .fl_release_private = nfs4_fl_release_lock,
960 int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl)
962 struct nfs4_lock_state *lsp;
964 if (fl->fl_ops != NULL)
966 if (fl->fl_flags & FL_POSIX)
967 lsp = nfs4_get_lock_state(state, fl->fl_owner, 0, NFS4_POSIX_LOCK_TYPE);
968 else if (fl->fl_flags & FL_FLOCK)
969 lsp = nfs4_get_lock_state(state, NULL, fl->fl_pid,
970 NFS4_FLOCK_LOCK_TYPE);
975 fl->fl_u.nfs4_fl.owner = lsp;
976 fl->fl_ops = &nfs4_fl_lock_ops;
980 static int nfs4_copy_lock_stateid(nfs4_stateid *dst,
981 struct nfs4_state *state,
982 const struct nfs_lockowner *lockowner)
984 struct nfs4_lock_state *lsp;
990 if (lockowner == NULL)
993 if (test_bit(LK_STATE_IN_USE, &state->flags) == 0)
996 fl_owner = lockowner->l_owner;
997 fl_pid = lockowner->l_pid;
998 spin_lock(&state->state_lock);
999 lsp = __nfs4_find_lock_state(state, fl_owner, fl_pid, NFS4_ANY_LOCK_TYPE);
1000 if (lsp != NULL && test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags) != 0) {
1001 nfs4_stateid_copy(dst, &lsp->ls_stateid);
1004 if (!list_empty(&lsp->ls_seqid.list))
1007 spin_unlock(&state->state_lock);
1008 nfs4_put_lock_state(lsp);
1013 static int nfs4_copy_open_stateid(nfs4_stateid *dst, struct nfs4_state *state)
1015 const nfs4_stateid *src;
1020 src = &zero_stateid;
1021 seq = read_seqbegin(&state->seqlock);
1022 if (test_bit(NFS_OPEN_STATE, &state->flags))
1023 src = &state->open_stateid;
1024 nfs4_stateid_copy(dst, src);
1027 if (!list_empty(&state->owner->so_seqid.list))
1029 } while (read_seqretry(&state->seqlock, seq));
1034 * Byte-range lock aware utility to initialize the stateid of read/write
1037 int nfs4_select_rw_stateid(nfs4_stateid *dst, struct nfs4_state *state,
1038 fmode_t fmode, const struct nfs_lockowner *lockowner)
1041 if (nfs4_copy_delegation_stateid(dst, state->inode, fmode))
1043 ret = nfs4_copy_lock_stateid(dst, state, lockowner);
1046 ret = nfs4_copy_open_stateid(dst, state);
1048 if (nfs_server_capable(state->inode, NFS_CAP_STATEID_NFSV41))
1053 struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask)
1055 struct nfs_seqid *new;
1057 new = kmalloc(sizeof(*new), gfp_mask);
1059 new->sequence = counter;
1060 INIT_LIST_HEAD(&new->list);
1066 void nfs_release_seqid(struct nfs_seqid *seqid)
1068 struct nfs_seqid_counter *sequence;
1070 if (list_empty(&seqid->list))
1072 sequence = seqid->sequence;
1073 spin_lock(&sequence->lock);
1074 list_del_init(&seqid->list);
1075 if (!list_empty(&sequence->list)) {
1076 struct nfs_seqid *next;
1078 next = list_first_entry(&sequence->list,
1079 struct nfs_seqid, list);
1080 rpc_wake_up_queued_task(&sequence->wait, next->task);
1082 spin_unlock(&sequence->lock);
1085 void nfs_free_seqid(struct nfs_seqid *seqid)
1087 nfs_release_seqid(seqid);
1092 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
1093 * failed with a seqid incrementing error -
1094 * see comments nfs_fs.h:seqid_mutating_error()
1096 static void nfs_increment_seqid(int status, struct nfs_seqid *seqid)
1101 case -NFS4ERR_BAD_SEQID:
1102 if (seqid->sequence->flags & NFS_SEQID_CONFIRMED)
1104 pr_warn_ratelimited("NFS: v4 server returned a bad"
1105 " sequence-id error on an"
1106 " unconfirmed sequence %p!\n",
1108 case -NFS4ERR_STALE_CLIENTID:
1109 case -NFS4ERR_STALE_STATEID:
1110 case -NFS4ERR_BAD_STATEID:
1111 case -NFS4ERR_BADXDR:
1112 case -NFS4ERR_RESOURCE:
1113 case -NFS4ERR_NOFILEHANDLE:
1114 /* Non-seqid mutating errors */
1118 * Note: no locking needed as we are guaranteed to be first
1119 * on the sequence list
1121 seqid->sequence->counter++;
1124 void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid)
1126 struct nfs4_state_owner *sp = container_of(seqid->sequence,
1127 struct nfs4_state_owner, so_seqid);
1128 struct nfs_server *server = sp->so_server;
1130 if (status == -NFS4ERR_BAD_SEQID)
1131 nfs4_drop_state_owner(sp);
1132 if (!nfs4_has_session(server->nfs_client))
1133 nfs_increment_seqid(status, seqid);
1137 * Increment the seqid if the LOCK/LOCKU succeeded, or
1138 * failed with a seqid incrementing error -
1139 * see comments nfs_fs.h:seqid_mutating_error()
1141 void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid)
1143 nfs_increment_seqid(status, seqid);
1146 int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task)
1148 struct nfs_seqid_counter *sequence = seqid->sequence;
1151 spin_lock(&sequence->lock);
1153 if (list_empty(&seqid->list))
1154 list_add_tail(&seqid->list, &sequence->list);
1155 if (list_first_entry(&sequence->list, struct nfs_seqid, list) == seqid)
1157 rpc_sleep_on(&sequence->wait, task, NULL);
1160 spin_unlock(&sequence->lock);
1164 static int nfs4_run_state_manager(void *);
1166 static void nfs4_clear_state_manager_bit(struct nfs_client *clp)
1168 smp_mb__before_clear_bit();
1169 clear_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
1170 smp_mb__after_clear_bit();
1171 wake_up_bit(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING);
1172 rpc_wake_up(&clp->cl_rpcwaitq);
1176 * Schedule the nfs_client asynchronous state management routine
1178 void nfs4_schedule_state_manager(struct nfs_client *clp)
1180 struct task_struct *task;
1181 char buf[INET6_ADDRSTRLEN + sizeof("-manager") + 1];
1183 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
1185 __module_get(THIS_MODULE);
1186 atomic_inc(&clp->cl_count);
1188 /* The rcu_read_lock() is not strictly necessary, as the state
1189 * manager is the only thread that ever changes the rpc_xprt
1190 * after it's initialized. At this point, we're single threaded. */
1192 snprintf(buf, sizeof(buf), "%s-manager",
1193 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_ADDR));
1195 task = kthread_run(nfs4_run_state_manager, clp, buf);
1197 printk(KERN_ERR "%s: kthread_run: %ld\n",
1198 __func__, PTR_ERR(task));
1199 nfs4_clear_state_manager_bit(clp);
1200 nfs_put_client(clp);
1201 module_put(THIS_MODULE);
1206 * Schedule a lease recovery attempt
1208 void nfs4_schedule_lease_recovery(struct nfs_client *clp)
1212 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1213 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1214 dprintk("%s: scheduling lease recovery for server %s\n", __func__,
1216 nfs4_schedule_state_manager(clp);
1218 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_recovery);
1220 int nfs4_wait_clnt_recover(struct nfs_client *clp)
1226 res = wait_on_bit(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING,
1227 nfs_wait_bit_killable, TASK_KILLABLE);
1231 if (clp->cl_cons_state < 0)
1232 return clp->cl_cons_state;
1236 int nfs4_client_recover_expired_lease(struct nfs_client *clp)
1241 for (loop = NFS4_MAX_LOOP_ON_RECOVER; loop != 0; loop--) {
1242 ret = nfs4_wait_clnt_recover(clp);
1245 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) &&
1246 !test_bit(NFS4CLNT_CHECK_LEASE,&clp->cl_state))
1248 nfs4_schedule_state_manager(clp);
1255 * nfs40_handle_cb_pathdown - return all delegations after NFS4ERR_CB_PATH_DOWN
1256 * @clp: client to process
1258 * Set the NFS4CLNT_LEASE_EXPIRED state in order to force a
1259 * resend of the SETCLIENTID and hence re-establish the
1260 * callback channel. Then return all existing delegations.
1262 static void nfs40_handle_cb_pathdown(struct nfs_client *clp)
1264 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1265 nfs_expire_all_delegations(clp);
1266 dprintk("%s: handling CB_PATHDOWN recovery for server %s\n", __func__,
1270 void nfs4_schedule_path_down_recovery(struct nfs_client *clp)
1272 nfs40_handle_cb_pathdown(clp);
1273 nfs4_schedule_state_manager(clp);
1276 static int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state)
1279 set_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1280 /* Don't recover state that expired before the reboot */
1281 if (test_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags)) {
1282 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1285 set_bit(NFS_OWNER_RECLAIM_REBOOT, &state->owner->so_flags);
1286 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1290 static int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state)
1292 set_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags);
1293 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1294 set_bit(NFS_OWNER_RECLAIM_NOGRACE, &state->owner->so_flags);
1295 set_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state);
1299 int nfs4_schedule_stateid_recovery(const struct nfs_server *server, struct nfs4_state *state)
1301 struct nfs_client *clp = server->nfs_client;
1303 if (!nfs4_valid_open_stateid(state))
1305 nfs4_state_mark_reclaim_nograce(clp, state);
1306 dprintk("%s: scheduling stateid recovery for server %s\n", __func__,
1308 nfs4_schedule_state_manager(clp);
1311 EXPORT_SYMBOL_GPL(nfs4_schedule_stateid_recovery);
1313 void nfs_inode_find_state_and_recover(struct inode *inode,
1314 const nfs4_stateid *stateid)
1316 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1317 struct nfs_inode *nfsi = NFS_I(inode);
1318 struct nfs_open_context *ctx;
1319 struct nfs4_state *state;
1322 spin_lock(&inode->i_lock);
1323 list_for_each_entry(ctx, &nfsi->open_files, list) {
1327 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
1329 if (!nfs4_stateid_match(&state->stateid, stateid))
1331 nfs4_state_mark_reclaim_nograce(clp, state);
1334 spin_unlock(&inode->i_lock);
1336 nfs4_schedule_state_manager(clp);
1339 static void nfs4_state_mark_open_context_bad(struct nfs4_state *state)
1341 struct inode *inode = state->inode;
1342 struct nfs_inode *nfsi = NFS_I(inode);
1343 struct nfs_open_context *ctx;
1345 spin_lock(&inode->i_lock);
1346 list_for_each_entry(ctx, &nfsi->open_files, list) {
1347 if (ctx->state != state)
1349 set_bit(NFS_CONTEXT_BAD, &ctx->flags);
1351 spin_unlock(&inode->i_lock);
1354 static void nfs4_state_mark_recovery_failed(struct nfs4_state *state, int error)
1356 set_bit(NFS_STATE_RECOVERY_FAILED, &state->flags);
1357 nfs4_state_mark_open_context_bad(state);
1361 static int nfs4_reclaim_locks(struct nfs4_state *state, const struct nfs4_state_recovery_ops *ops)
1363 struct inode *inode = state->inode;
1364 struct nfs_inode *nfsi = NFS_I(inode);
1365 struct file_lock *fl;
1368 if (inode->i_flock == NULL)
1371 /* Guard against delegation returns and new lock/unlock calls */
1372 down_write(&nfsi->rwsem);
1373 /* Protect inode->i_flock using the BKL */
1375 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1376 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
1378 if (nfs_file_open_context(fl->fl_file)->state != state)
1381 status = ops->recover_lock(state, fl);
1386 case -NFS4ERR_ADMIN_REVOKED:
1387 case -NFS4ERR_STALE_STATEID:
1388 case -NFS4ERR_BAD_STATEID:
1389 case -NFS4ERR_EXPIRED:
1390 case -NFS4ERR_NO_GRACE:
1391 case -NFS4ERR_STALE_CLIENTID:
1392 case -NFS4ERR_BADSESSION:
1393 case -NFS4ERR_BADSLOT:
1394 case -NFS4ERR_BAD_HIGH_SLOT:
1395 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1398 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1399 "Zeroing state\n", __func__, status);
1401 case -NFS4ERR_DENIED:
1402 case -NFS4ERR_RECLAIM_BAD:
1403 case -NFS4ERR_RECLAIM_CONFLICT:
1404 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
1411 up_write(&nfsi->rwsem);
1415 static int nfs4_reclaim_open_state(struct nfs4_state_owner *sp, const struct nfs4_state_recovery_ops *ops)
1417 struct nfs4_state *state;
1418 struct nfs4_lock_state *lock;
1421 /* Note: we rely on the sp->so_states list being ordered
1422 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
1424 * This is needed to ensure that the server won't give us any
1425 * read delegations that we have to return if, say, we are
1426 * recovering after a network partition or a reboot from a
1427 * server that doesn't support a grace period.
1429 spin_lock(&sp->so_lock);
1430 write_seqcount_begin(&sp->so_reclaim_seqcount);
1432 list_for_each_entry(state, &sp->so_states, open_states) {
1433 if (!test_and_clear_bit(ops->state_flag_bit, &state->flags))
1435 if (!nfs4_valid_open_stateid(state))
1437 if (state->state == 0)
1439 atomic_inc(&state->count);
1440 spin_unlock(&sp->so_lock);
1441 status = ops->recover_open(sp, state);
1443 status = nfs4_reclaim_locks(state, ops);
1445 spin_lock(&state->state_lock);
1446 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1447 if (!test_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags))
1448 pr_warn_ratelimited("NFS: "
1450 "failed!\n", __func__);
1452 spin_unlock(&state->state_lock);
1453 nfs4_put_open_state(state);
1454 spin_lock(&sp->so_lock);
1460 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1461 "Zeroing state\n", __func__, status);
1466 * Open state on this file cannot be recovered
1467 * All we can do is revert to using the zero stateid.
1469 nfs4_state_mark_recovery_failed(state, status);
1473 case -NFS4ERR_ADMIN_REVOKED:
1474 case -NFS4ERR_STALE_STATEID:
1475 case -NFS4ERR_BAD_STATEID:
1476 case -NFS4ERR_RECLAIM_BAD:
1477 case -NFS4ERR_RECLAIM_CONFLICT:
1478 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1480 case -NFS4ERR_EXPIRED:
1481 case -NFS4ERR_NO_GRACE:
1482 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1483 case -NFS4ERR_STALE_CLIENTID:
1484 case -NFS4ERR_BADSESSION:
1485 case -NFS4ERR_BADSLOT:
1486 case -NFS4ERR_BAD_HIGH_SLOT:
1487 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1490 nfs4_put_open_state(state);
1491 spin_lock(&sp->so_lock);
1494 write_seqcount_end(&sp->so_reclaim_seqcount);
1495 spin_unlock(&sp->so_lock);
1498 nfs4_put_open_state(state);
1499 spin_lock(&sp->so_lock);
1500 write_seqcount_end(&sp->so_reclaim_seqcount);
1501 spin_unlock(&sp->so_lock);
1505 static void nfs4_clear_open_state(struct nfs4_state *state)
1507 struct nfs4_lock_state *lock;
1509 clear_bit(NFS_DELEGATED_STATE, &state->flags);
1510 clear_bit(NFS_O_RDONLY_STATE, &state->flags);
1511 clear_bit(NFS_O_WRONLY_STATE, &state->flags);
1512 clear_bit(NFS_O_RDWR_STATE, &state->flags);
1513 spin_lock(&state->state_lock);
1514 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1515 lock->ls_seqid.flags = 0;
1516 clear_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags);
1518 spin_unlock(&state->state_lock);
1521 static void nfs4_reset_seqids(struct nfs_server *server,
1522 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1524 struct nfs_client *clp = server->nfs_client;
1525 struct nfs4_state_owner *sp;
1526 struct rb_node *pos;
1527 struct nfs4_state *state;
1529 spin_lock(&clp->cl_lock);
1530 for (pos = rb_first(&server->state_owners);
1532 pos = rb_next(pos)) {
1533 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1534 sp->so_seqid.flags = 0;
1535 spin_lock(&sp->so_lock);
1536 list_for_each_entry(state, &sp->so_states, open_states) {
1537 if (mark_reclaim(clp, state))
1538 nfs4_clear_open_state(state);
1540 spin_unlock(&sp->so_lock);
1542 spin_unlock(&clp->cl_lock);
1545 static void nfs4_state_mark_reclaim_helper(struct nfs_client *clp,
1546 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1548 struct nfs_server *server;
1551 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1552 nfs4_reset_seqids(server, mark_reclaim);
1556 static void nfs4_state_start_reclaim_reboot(struct nfs_client *clp)
1558 /* Mark all delegations for reclaim */
1559 nfs_delegation_mark_reclaim(clp);
1560 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_reboot);
1563 static void nfs4_reclaim_complete(struct nfs_client *clp,
1564 const struct nfs4_state_recovery_ops *ops)
1566 /* Notify the server we're done reclaiming our state */
1567 if (ops->reclaim_complete)
1568 (void)ops->reclaim_complete(clp);
1571 static void nfs4_clear_reclaim_server(struct nfs_server *server)
1573 struct nfs_client *clp = server->nfs_client;
1574 struct nfs4_state_owner *sp;
1575 struct rb_node *pos;
1576 struct nfs4_state *state;
1578 spin_lock(&clp->cl_lock);
1579 for (pos = rb_first(&server->state_owners);
1581 pos = rb_next(pos)) {
1582 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1583 spin_lock(&sp->so_lock);
1584 list_for_each_entry(state, &sp->so_states, open_states) {
1585 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT,
1588 nfs4_state_mark_reclaim_nograce(clp, state);
1590 spin_unlock(&sp->so_lock);
1592 spin_unlock(&clp->cl_lock);
1595 static int nfs4_state_clear_reclaim_reboot(struct nfs_client *clp)
1597 struct nfs_server *server;
1599 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
1603 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1604 nfs4_clear_reclaim_server(server);
1607 nfs_delegation_reap_unclaimed(clp);
1611 static void nfs4_state_end_reclaim_reboot(struct nfs_client *clp)
1613 if (!nfs4_state_clear_reclaim_reboot(clp))
1615 nfs4_reclaim_complete(clp, clp->cl_mvops->reboot_recovery_ops);
1618 static void nfs_delegation_clear_all(struct nfs_client *clp)
1620 nfs_delegation_mark_reclaim(clp);
1621 nfs_delegation_reap_unclaimed(clp);
1624 static void nfs4_state_start_reclaim_nograce(struct nfs_client *clp)
1626 nfs_delegation_clear_all(clp);
1627 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_nograce);
1630 static int nfs4_recovery_handle_error(struct nfs_client *clp, int error)
1635 case -NFS4ERR_CB_PATH_DOWN:
1636 nfs40_handle_cb_pathdown(clp);
1638 case -NFS4ERR_NO_GRACE:
1639 nfs4_state_end_reclaim_reboot(clp);
1641 case -NFS4ERR_STALE_CLIENTID:
1642 case -NFS4ERR_LEASE_MOVED:
1643 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1644 nfs4_state_clear_reclaim_reboot(clp);
1645 nfs4_state_start_reclaim_reboot(clp);
1647 case -NFS4ERR_EXPIRED:
1648 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1649 nfs4_state_start_reclaim_nograce(clp);
1651 case -NFS4ERR_BADSESSION:
1652 case -NFS4ERR_BADSLOT:
1653 case -NFS4ERR_BAD_HIGH_SLOT:
1654 case -NFS4ERR_DEADSESSION:
1655 case -NFS4ERR_SEQ_FALSE_RETRY:
1656 case -NFS4ERR_SEQ_MISORDERED:
1657 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1658 /* Zero session reset errors */
1660 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1661 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1664 dprintk("%s: failed to handle error %d for server %s\n",
1665 __func__, error, clp->cl_hostname);
1668 dprintk("%s: handled error %d for server %s\n", __func__, error,
1673 static int nfs4_do_reclaim(struct nfs_client *clp, const struct nfs4_state_recovery_ops *ops)
1675 struct nfs4_state_owner *sp;
1676 struct nfs_server *server;
1677 struct rb_node *pos;
1682 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1683 nfs4_purge_state_owners(server);
1684 spin_lock(&clp->cl_lock);
1685 for (pos = rb_first(&server->state_owners);
1687 pos = rb_next(pos)) {
1689 struct nfs4_state_owner, so_server_node);
1690 if (!test_and_clear_bit(ops->owner_flag_bit,
1693 atomic_inc(&sp->so_count);
1694 spin_unlock(&clp->cl_lock);
1697 status = nfs4_reclaim_open_state(sp, ops);
1699 set_bit(ops->owner_flag_bit, &sp->so_flags);
1700 nfs4_put_state_owner(sp);
1701 return nfs4_recovery_handle_error(clp, status);
1704 nfs4_put_state_owner(sp);
1707 spin_unlock(&clp->cl_lock);
1713 static int nfs4_check_lease(struct nfs_client *clp)
1715 struct rpc_cred *cred;
1716 const struct nfs4_state_maintenance_ops *ops =
1717 clp->cl_mvops->state_renewal_ops;
1720 /* Is the client already known to have an expired lease? */
1721 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1723 spin_lock(&clp->cl_lock);
1724 cred = ops->get_state_renewal_cred_locked(clp);
1725 spin_unlock(&clp->cl_lock);
1727 cred = nfs4_get_setclientid_cred(clp);
1732 status = ops->renew_lease(clp, cred);
1734 if (status == -ETIMEDOUT) {
1735 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1739 return nfs4_recovery_handle_error(clp, status);
1742 /* Set NFS4CLNT_LEASE_EXPIRED and reclaim reboot state for all v4.0 errors
1743 * and for recoverable errors on EXCHANGE_ID for v4.1
1745 static int nfs4_handle_reclaim_lease_error(struct nfs_client *clp, int status)
1748 case -NFS4ERR_SEQ_MISORDERED:
1749 if (test_and_set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state))
1750 return -ESERVERFAULT;
1751 /* Lease confirmation error: retry after purging the lease */
1753 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1755 case -NFS4ERR_STALE_CLIENTID:
1756 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1757 nfs4_state_clear_reclaim_reboot(clp);
1758 nfs4_state_start_reclaim_reboot(clp);
1760 case -NFS4ERR_CLID_INUSE:
1761 pr_err("NFS: Server %s reports our clientid is in use\n",
1763 nfs_mark_client_ready(clp, -EPERM);
1764 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1767 case -NFS4ERR_DELAY:
1773 case -NFS4ERR_MINOR_VERS_MISMATCH:
1774 if (clp->cl_cons_state == NFS_CS_SESSION_INITING)
1775 nfs_mark_client_ready(clp, -EPROTONOSUPPORT);
1776 dprintk("%s: exit with error %d for server %s\n",
1777 __func__, -EPROTONOSUPPORT, clp->cl_hostname);
1778 return -EPROTONOSUPPORT;
1779 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1780 * in nfs4_exchange_id */
1782 dprintk("%s: exit with error %d for server %s\n", __func__,
1783 status, clp->cl_hostname);
1786 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1787 dprintk("%s: handled error %d for server %s\n", __func__, status,
1792 static int nfs4_establish_lease(struct nfs_client *clp)
1794 struct rpc_cred *cred;
1795 const struct nfs4_state_recovery_ops *ops =
1796 clp->cl_mvops->reboot_recovery_ops;
1799 cred = ops->get_clid_cred(clp);
1802 status = ops->establish_clid(clp, cred);
1806 pnfs_destroy_all_layouts(clp);
1811 * Returns zero or a negative errno. NFS4ERR values are converted
1812 * to local errno values.
1814 static int nfs4_reclaim_lease(struct nfs_client *clp)
1818 status = nfs4_establish_lease(clp);
1820 return nfs4_handle_reclaim_lease_error(clp, status);
1821 if (test_and_clear_bit(NFS4CLNT_SERVER_SCOPE_MISMATCH, &clp->cl_state))
1822 nfs4_state_start_reclaim_nograce(clp);
1823 if (!test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
1824 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1825 clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1826 clear_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1830 static int nfs4_purge_lease(struct nfs_client *clp)
1834 status = nfs4_establish_lease(clp);
1836 return nfs4_handle_reclaim_lease_error(clp, status);
1837 clear_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
1838 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1839 nfs4_state_start_reclaim_nograce(clp);
1844 * nfs4_discover_server_trunking - Detect server IP address trunking
1846 * @clp: nfs_client under test
1847 * @result: OUT: found nfs_client, or clp
1849 * Returns zero or a negative errno. If zero is returned,
1850 * an nfs_client pointer is planted in "result".
1852 * Note: since we are invoked in process context, and
1853 * not from inside the state manager, we cannot use
1854 * nfs4_handle_reclaim_lease_error().
1856 int nfs4_discover_server_trunking(struct nfs_client *clp,
1857 struct nfs_client **result)
1859 const struct nfs4_state_recovery_ops *ops =
1860 clp->cl_mvops->reboot_recovery_ops;
1861 struct rpc_clnt *clnt;
1862 struct rpc_cred *cred;
1865 dprintk("NFS: %s: testing '%s'\n", __func__, clp->cl_hostname);
1867 clnt = clp->cl_rpcclient;
1870 mutex_lock(&nfs_clid_init_mutex);
1873 cred = ops->get_clid_cred(clp);
1877 status = ops->detect_trunking(clp, result, cred);
1882 case -NFS4ERR_DELAY:
1886 case -NFS4ERR_STALE_CLIENTID:
1887 dprintk("NFS: %s after status %d, retrying\n",
1893 case -NFS4ERR_CLID_INUSE:
1894 case -NFS4ERR_WRONGSEC:
1895 clnt = rpc_clone_client_set_auth(clnt, RPC_AUTH_UNIX);
1897 status = PTR_ERR(clnt);
1900 /* Note: this is safe because we haven't yet marked the
1901 * client as ready, so we are the only user of
1904 clnt = xchg(&clp->cl_rpcclient, clnt);
1905 rpc_shutdown_client(clnt);
1906 clnt = clp->cl_rpcclient;
1909 case -NFS4ERR_MINOR_VERS_MISMATCH:
1910 status = -EPROTONOSUPPORT;
1914 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1915 * in nfs4_exchange_id */
1916 status = -EKEYEXPIRED;
1919 pr_warn("NFS: %s unhandled error %d. Exiting with error EIO\n",
1925 mutex_unlock(&nfs_clid_init_mutex);
1926 dprintk("NFS: %s: status = %d\n", __func__, status);
1930 #ifdef CONFIG_NFS_V4_1
1931 void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
1933 struct nfs_client *clp = session->clp;
1937 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1939 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1940 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1942 nfs4_schedule_lease_recovery(clp);
1944 EXPORT_SYMBOL_GPL(nfs4_schedule_session_recovery);
1946 static void nfs41_ping_server(struct nfs_client *clp)
1948 /* Use CHECK_LEASE to ping the server with a SEQUENCE */
1949 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1950 nfs4_schedule_state_manager(clp);
1953 void nfs41_server_notify_target_slotid_update(struct nfs_client *clp)
1955 nfs41_ping_server(clp);
1958 void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp)
1960 nfs41_ping_server(clp);
1963 static void nfs4_reset_all_state(struct nfs_client *clp)
1965 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1966 set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
1967 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1968 nfs4_state_start_reclaim_nograce(clp);
1969 dprintk("%s: scheduling reset of all state for server %s!\n",
1970 __func__, clp->cl_hostname);
1971 nfs4_schedule_state_manager(clp);
1975 static void nfs41_handle_server_reboot(struct nfs_client *clp)
1977 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1978 nfs4_state_start_reclaim_reboot(clp);
1979 dprintk("%s: server %s rebooted!\n", __func__,
1981 nfs4_schedule_state_manager(clp);
1985 static void nfs41_handle_state_revoked(struct nfs_client *clp)
1987 nfs4_reset_all_state(clp);
1988 dprintk("%s: state revoked on server %s\n", __func__, clp->cl_hostname);
1991 static void nfs41_handle_recallable_state_revoked(struct nfs_client *clp)
1993 /* This will need to handle layouts too */
1994 nfs_expire_all_delegations(clp);
1995 dprintk("%s: Recallable state revoked on server %s!\n", __func__,
1999 static void nfs41_handle_backchannel_fault(struct nfs_client *clp)
2001 nfs_expire_all_delegations(clp);
2002 if (test_and_set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) == 0)
2003 nfs4_schedule_state_manager(clp);
2004 dprintk("%s: server %s declared a backchannel fault\n", __func__,
2008 static void nfs41_handle_cb_path_down(struct nfs_client *clp)
2010 if (test_and_set_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2011 &clp->cl_state) == 0)
2012 nfs4_schedule_state_manager(clp);
2015 void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags)
2020 dprintk("%s: \"%s\" (client ID %llx) flags=0x%08x\n",
2021 __func__, clp->cl_hostname, clp->cl_clientid, flags);
2023 if (flags & SEQ4_STATUS_RESTART_RECLAIM_NEEDED)
2024 nfs41_handle_server_reboot(clp);
2025 if (flags & (SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED |
2026 SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED |
2027 SEQ4_STATUS_ADMIN_STATE_REVOKED |
2028 SEQ4_STATUS_LEASE_MOVED))
2029 nfs41_handle_state_revoked(clp);
2030 if (flags & SEQ4_STATUS_RECALLABLE_STATE_REVOKED)
2031 nfs41_handle_recallable_state_revoked(clp);
2032 if (flags & SEQ4_STATUS_BACKCHANNEL_FAULT)
2033 nfs41_handle_backchannel_fault(clp);
2034 else if (flags & (SEQ4_STATUS_CB_PATH_DOWN |
2035 SEQ4_STATUS_CB_PATH_DOWN_SESSION))
2036 nfs41_handle_cb_path_down(clp);
2039 static int nfs4_reset_session(struct nfs_client *clp)
2041 struct rpc_cred *cred;
2044 if (!nfs4_has_session(clp))
2046 nfs4_begin_drain_session(clp);
2047 cred = nfs4_get_exchange_id_cred(clp);
2048 status = nfs4_proc_destroy_session(clp->cl_session, cred);
2051 case -NFS4ERR_BADSESSION:
2052 case -NFS4ERR_DEADSESSION:
2054 case -NFS4ERR_BACK_CHAN_BUSY:
2055 case -NFS4ERR_DELAY:
2056 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2061 status = nfs4_recovery_handle_error(clp, status);
2065 memset(clp->cl_session->sess_id.data, 0, NFS4_MAX_SESSIONID_LEN);
2066 status = nfs4_proc_create_session(clp, cred);
2068 dprintk("%s: session reset failed with status %d for server %s!\n",
2069 __func__, status, clp->cl_hostname);
2070 status = nfs4_handle_reclaim_lease_error(clp, status);
2073 nfs41_finish_session_reset(clp);
2074 dprintk("%s: session reset was successful for server %s!\n",
2075 __func__, clp->cl_hostname);
2082 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2084 struct rpc_cred *cred;
2087 if (!nfs4_has_session(clp))
2089 nfs4_begin_drain_session(clp);
2090 cred = nfs4_get_exchange_id_cred(clp);
2091 ret = nfs4_proc_bind_conn_to_session(clp, cred);
2094 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2097 dprintk("%s: bind_conn_to_session was successful for server %s!\n",
2098 __func__, clp->cl_hostname);
2100 case -NFS4ERR_DELAY:
2102 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2105 return nfs4_recovery_handle_error(clp, ret);
2109 #else /* CONFIG_NFS_V4_1 */
2110 static int nfs4_reset_session(struct nfs_client *clp) { return 0; }
2111 static int nfs4_end_drain_session(struct nfs_client *clp) { return 0; }
2113 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2117 #endif /* CONFIG_NFS_V4_1 */
2119 static void nfs4_state_manager(struct nfs_client *clp)
2122 const char *section = "", *section_sep = "";
2124 /* Ensure exclusive access to NFSv4 state */
2126 if (test_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state)) {
2127 section = "purge state";
2128 status = nfs4_purge_lease(clp);
2134 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state)) {
2135 section = "lease expired";
2136 /* We're going to have to re-establish a clientid */
2137 status = nfs4_reclaim_lease(clp);
2143 /* Initialize or reset the session */
2144 if (test_and_clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state)) {
2145 section = "reset session";
2146 status = nfs4_reset_session(clp);
2147 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
2153 /* Send BIND_CONN_TO_SESSION */
2154 if (test_and_clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2156 section = "bind conn to session";
2157 status = nfs4_bind_conn_to_session(clp);
2163 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state)) {
2164 section = "check lease";
2165 status = nfs4_check_lease(clp);
2171 /* First recover reboot state... */
2172 if (test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state)) {
2173 section = "reclaim reboot";
2174 status = nfs4_do_reclaim(clp,
2175 clp->cl_mvops->reboot_recovery_ops);
2176 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
2177 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
2179 nfs4_state_end_reclaim_reboot(clp);
2180 if (test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
2186 /* Now recover expired state... */
2187 if (test_and_clear_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state)) {
2188 section = "reclaim nograce";
2189 status = nfs4_do_reclaim(clp,
2190 clp->cl_mvops->nograce_recovery_ops);
2191 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
2192 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) ||
2193 test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
2199 nfs4_end_drain_session(clp);
2200 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state)) {
2201 nfs_client_return_marked_delegations(clp);
2205 nfs4_clear_state_manager_bit(clp);
2206 /* Did we race with an attempt to give us more work? */
2207 if (clp->cl_state == 0)
2209 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
2211 } while (atomic_read(&clp->cl_count) > 1);
2214 if (strlen(section))
2216 pr_warn_ratelimited("NFS: state manager%s%s failed on NFSv4 server %s"
2217 " with error %d\n", section_sep, section,
2218 clp->cl_hostname, -status);
2220 nfs4_end_drain_session(clp);
2221 nfs4_clear_state_manager_bit(clp);
2224 static int nfs4_run_state_manager(void *ptr)
2226 struct nfs_client *clp = ptr;
2228 allow_signal(SIGKILL);
2229 nfs4_state_manager(clp);
2230 nfs_put_client(clp);
2231 module_put_and_exit(0);