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>
56 #include "delegation.h"
60 #define OPENOWNER_POOL_SIZE 8
62 const nfs4_stateid zero_stateid;
64 static LIST_HEAD(nfs4_clientid_list);
66 int nfs4_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
68 struct nfs4_setclientid_res clid = {
69 .clientid = clp->cl_clientid,
70 .confirm = clp->cl_confirm,
75 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
77 port = nfs_callback_tcpport;
78 if (clp->cl_addr.ss_family == AF_INET6)
79 port = nfs_callback_tcpport6;
81 status = nfs4_proc_setclientid(clp, NFS4_CALLBACK, port, cred, &clid);
84 clp->cl_clientid = clid.clientid;
85 clp->cl_confirm = clid.confirm;
86 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
88 status = nfs4_proc_setclientid_confirm(clp, &clid, cred);
91 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
92 nfs4_schedule_state_renewal(clp);
97 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp)
99 struct rpc_cred *cred = NULL;
101 if (clp->cl_machine_cred != NULL)
102 cred = get_rpccred(clp->cl_machine_cred);
106 static void nfs4_clear_machine_cred(struct nfs_client *clp)
108 struct rpc_cred *cred;
110 spin_lock(&clp->cl_lock);
111 cred = clp->cl_machine_cred;
112 clp->cl_machine_cred = NULL;
113 spin_unlock(&clp->cl_lock);
118 static struct rpc_cred *
119 nfs4_get_renew_cred_server_locked(struct nfs_server *server)
121 struct rpc_cred *cred = NULL;
122 struct nfs4_state_owner *sp;
125 for (pos = rb_first(&server->state_owners);
127 pos = rb_next(pos)) {
128 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
129 if (list_empty(&sp->so_states))
131 cred = get_rpccred(sp->so_cred);
138 * nfs4_get_renew_cred_locked - Acquire credential for a renew operation
139 * @clp: client state handle
141 * Returns an rpc_cred with reference count bumped, or NULL.
142 * Caller must hold clp->cl_lock.
144 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp)
146 struct rpc_cred *cred = NULL;
147 struct nfs_server *server;
149 /* Use machine credentials if available */
150 cred = nfs4_get_machine_cred_locked(clp);
155 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
156 cred = nfs4_get_renew_cred_server_locked(server);
166 #if defined(CONFIG_NFS_V4_1)
168 static int nfs41_setup_state_renewal(struct nfs_client *clp)
171 struct nfs_fsinfo fsinfo;
173 if (!test_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state)) {
174 nfs4_schedule_state_renewal(clp);
178 status = nfs4_proc_get_lease_time(clp, &fsinfo);
180 /* Update lease time and schedule renewal */
181 spin_lock(&clp->cl_lock);
182 clp->cl_lease_time = fsinfo.lease_time * HZ;
183 clp->cl_last_renewal = jiffies;
184 spin_unlock(&clp->cl_lock);
186 nfs4_schedule_state_renewal(clp);
193 * Back channel returns NFS4ERR_DELAY for new requests when
194 * NFS4_SESSION_DRAINING is set so there is no work to be done when draining
197 static void nfs4_end_drain_session(struct nfs_client *clp)
199 struct nfs4_session *ses = clp->cl_session;
200 struct nfs4_slot_table *tbl;
205 tbl = &ses->fc_slot_table;
206 if (test_and_clear_bit(NFS4_SESSION_DRAINING, &ses->session_state)) {
207 spin_lock(&tbl->slot_tbl_lock);
208 max_slots = tbl->max_slots;
209 while (max_slots--) {
210 if (rpc_wake_up_first(&tbl->slot_tbl_waitq,
211 nfs4_set_task_privileged,
215 spin_unlock(&tbl->slot_tbl_lock);
219 static int nfs4_wait_on_slot_tbl(struct nfs4_slot_table *tbl)
221 spin_lock(&tbl->slot_tbl_lock);
222 if (tbl->highest_used_slotid != NFS4_NO_SLOT) {
223 INIT_COMPLETION(tbl->complete);
224 spin_unlock(&tbl->slot_tbl_lock);
225 return wait_for_completion_interruptible(&tbl->complete);
227 spin_unlock(&tbl->slot_tbl_lock);
231 static int nfs4_begin_drain_session(struct nfs_client *clp)
233 struct nfs4_session *ses = clp->cl_session;
236 set_bit(NFS4_SESSION_DRAINING, &ses->session_state);
238 ret = nfs4_wait_on_slot_tbl(&ses->bc_slot_table);
242 return nfs4_wait_on_slot_tbl(&ses->fc_slot_table);
245 int nfs41_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
249 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
251 nfs4_begin_drain_session(clp);
252 status = nfs4_proc_exchange_id(clp, cred);
255 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
257 status = nfs4_proc_create_session(clp);
260 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
261 nfs41_setup_state_renewal(clp);
262 nfs_mark_client_ready(clp, NFS_CS_READY);
267 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp)
269 struct rpc_cred *cred;
271 spin_lock(&clp->cl_lock);
272 cred = nfs4_get_machine_cred_locked(clp);
273 spin_unlock(&clp->cl_lock);
277 #endif /* CONFIG_NFS_V4_1 */
279 static struct rpc_cred *
280 nfs4_get_setclientid_cred_server(struct nfs_server *server)
282 struct nfs_client *clp = server->nfs_client;
283 struct rpc_cred *cred = NULL;
284 struct nfs4_state_owner *sp;
287 spin_lock(&clp->cl_lock);
288 pos = rb_first(&server->state_owners);
290 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
291 cred = get_rpccred(sp->so_cred);
293 spin_unlock(&clp->cl_lock);
298 * nfs4_get_setclientid_cred - Acquire credential for a setclientid operation
299 * @clp: client state handle
301 * Returns an rpc_cred with reference count bumped, or NULL.
303 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp)
305 struct nfs_server *server;
306 struct rpc_cred *cred;
308 spin_lock(&clp->cl_lock);
309 cred = nfs4_get_machine_cred_locked(clp);
310 spin_unlock(&clp->cl_lock);
315 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
316 cred = nfs4_get_setclientid_cred_server(server);
326 static struct nfs4_state_owner *
327 nfs4_find_state_owner_locked(struct nfs_server *server, struct rpc_cred *cred)
329 struct rb_node **p = &server->state_owners.rb_node,
331 struct nfs4_state_owner *sp;
335 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
337 if (cred < sp->so_cred)
338 p = &parent->rb_left;
339 else if (cred > sp->so_cred)
340 p = &parent->rb_right;
342 if (!list_empty(&sp->so_lru))
343 list_del_init(&sp->so_lru);
344 atomic_inc(&sp->so_count);
351 static struct nfs4_state_owner *
352 nfs4_insert_state_owner_locked(struct nfs4_state_owner *new)
354 struct nfs_server *server = new->so_server;
355 struct rb_node **p = &server->state_owners.rb_node,
357 struct nfs4_state_owner *sp;
362 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
364 if (new->so_cred < sp->so_cred)
365 p = &parent->rb_left;
366 else if (new->so_cred > sp->so_cred)
367 p = &parent->rb_right;
369 if (!list_empty(&sp->so_lru))
370 list_del_init(&sp->so_lru);
371 atomic_inc(&sp->so_count);
375 err = ida_get_new(&server->openowner_id, &new->so_seqid.owner_id);
378 rb_link_node(&new->so_server_node, parent, p);
379 rb_insert_color(&new->so_server_node, &server->state_owners);
384 nfs4_remove_state_owner_locked(struct nfs4_state_owner *sp)
386 struct nfs_server *server = sp->so_server;
388 if (!RB_EMPTY_NODE(&sp->so_server_node))
389 rb_erase(&sp->so_server_node, &server->state_owners);
390 ida_remove(&server->openowner_id, sp->so_seqid.owner_id);
394 nfs4_init_seqid_counter(struct nfs_seqid_counter *sc)
396 sc->create_time = ktime_get();
399 spin_lock_init(&sc->lock);
400 INIT_LIST_HEAD(&sc->list);
401 rpc_init_wait_queue(&sc->wait, "Seqid_waitqueue");
405 nfs4_destroy_seqid_counter(struct nfs_seqid_counter *sc)
407 rpc_destroy_wait_queue(&sc->wait);
411 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
412 * create a new state_owner.
415 static struct nfs4_state_owner *
416 nfs4_alloc_state_owner(struct nfs_server *server,
417 struct rpc_cred *cred,
420 struct nfs4_state_owner *sp;
422 sp = kzalloc(sizeof(*sp), gfp_flags);
425 sp->so_server = server;
426 sp->so_cred = get_rpccred(cred);
427 spin_lock_init(&sp->so_lock);
428 INIT_LIST_HEAD(&sp->so_states);
429 nfs4_init_seqid_counter(&sp->so_seqid);
430 atomic_set(&sp->so_count, 1);
431 INIT_LIST_HEAD(&sp->so_lru);
436 nfs4_drop_state_owner(struct nfs4_state_owner *sp)
438 struct rb_node *rb_node = &sp->so_server_node;
440 if (!RB_EMPTY_NODE(rb_node)) {
441 struct nfs_server *server = sp->so_server;
442 struct nfs_client *clp = server->nfs_client;
444 spin_lock(&clp->cl_lock);
445 if (!RB_EMPTY_NODE(rb_node)) {
446 rb_erase(rb_node, &server->state_owners);
447 RB_CLEAR_NODE(rb_node);
449 spin_unlock(&clp->cl_lock);
453 static void nfs4_free_state_owner(struct nfs4_state_owner *sp)
455 nfs4_destroy_seqid_counter(&sp->so_seqid);
456 put_rpccred(sp->so_cred);
460 static void nfs4_gc_state_owners(struct nfs_server *server)
462 struct nfs_client *clp = server->nfs_client;
463 struct nfs4_state_owner *sp, *tmp;
464 unsigned long time_min, time_max;
467 spin_lock(&clp->cl_lock);
469 time_min = (long)time_max - (long)clp->cl_lease_time;
470 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
471 /* NB: LRU is sorted so that oldest is at the head */
472 if (time_in_range(sp->so_expires, time_min, time_max))
474 list_move(&sp->so_lru, &doomed);
475 nfs4_remove_state_owner_locked(sp);
477 spin_unlock(&clp->cl_lock);
479 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
480 list_del(&sp->so_lru);
481 nfs4_free_state_owner(sp);
486 * nfs4_get_state_owner - Look up a state owner given a credential
487 * @server: nfs_server to search
488 * @cred: RPC credential to match
490 * Returns a pointer to an instantiated nfs4_state_owner struct, or NULL.
492 struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *server,
493 struct rpc_cred *cred,
496 struct nfs_client *clp = server->nfs_client;
497 struct nfs4_state_owner *sp, *new;
499 spin_lock(&clp->cl_lock);
500 sp = nfs4_find_state_owner_locked(server, cred);
501 spin_unlock(&clp->cl_lock);
504 new = nfs4_alloc_state_owner(server, cred, gfp_flags);
508 if (ida_pre_get(&server->openowner_id, gfp_flags) == 0)
510 spin_lock(&clp->cl_lock);
511 sp = nfs4_insert_state_owner_locked(new);
512 spin_unlock(&clp->cl_lock);
513 } while (sp == ERR_PTR(-EAGAIN));
515 nfs4_free_state_owner(new);
517 nfs4_gc_state_owners(server);
522 * nfs4_put_state_owner - Release a nfs4_state_owner
523 * @sp: state owner data to release
525 void nfs4_put_state_owner(struct nfs4_state_owner *sp)
527 struct nfs_server *server = sp->so_server;
528 struct nfs_client *clp = server->nfs_client;
530 if (!atomic_dec_and_lock(&sp->so_count, &clp->cl_lock))
533 if (!RB_EMPTY_NODE(&sp->so_server_node)) {
534 sp->so_expires = jiffies;
535 list_add_tail(&sp->so_lru, &server->state_owners_lru);
536 spin_unlock(&clp->cl_lock);
538 nfs4_remove_state_owner_locked(sp);
539 spin_unlock(&clp->cl_lock);
540 nfs4_free_state_owner(sp);
545 * nfs4_purge_state_owners - Release all cached state owners
546 * @server: nfs_server with cached state owners to release
548 * Called at umount time. Remaining state owners will be on
549 * the LRU with ref count of zero.
551 void nfs4_purge_state_owners(struct nfs_server *server)
553 struct nfs_client *clp = server->nfs_client;
554 struct nfs4_state_owner *sp, *tmp;
557 spin_lock(&clp->cl_lock);
558 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
559 list_move(&sp->so_lru, &doomed);
560 nfs4_remove_state_owner_locked(sp);
562 spin_unlock(&clp->cl_lock);
564 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
565 list_del(&sp->so_lru);
566 nfs4_free_state_owner(sp);
570 static struct nfs4_state *
571 nfs4_alloc_open_state(void)
573 struct nfs4_state *state;
575 state = kzalloc(sizeof(*state), GFP_NOFS);
578 atomic_set(&state->count, 1);
579 INIT_LIST_HEAD(&state->lock_states);
580 spin_lock_init(&state->state_lock);
581 seqlock_init(&state->seqlock);
586 nfs4_state_set_mode_locked(struct nfs4_state *state, fmode_t fmode)
588 if (state->state == fmode)
590 /* NB! List reordering - see the reclaim code for why. */
591 if ((fmode & FMODE_WRITE) != (state->state & FMODE_WRITE)) {
592 if (fmode & FMODE_WRITE)
593 list_move(&state->open_states, &state->owner->so_states);
595 list_move_tail(&state->open_states, &state->owner->so_states);
597 state->state = fmode;
600 static struct nfs4_state *
601 __nfs4_find_state_byowner(struct inode *inode, struct nfs4_state_owner *owner)
603 struct nfs_inode *nfsi = NFS_I(inode);
604 struct nfs4_state *state;
606 list_for_each_entry(state, &nfsi->open_states, inode_states) {
607 if (state->owner != owner)
609 if (atomic_inc_not_zero(&state->count))
616 nfs4_free_open_state(struct nfs4_state *state)
622 nfs4_get_open_state(struct inode *inode, struct nfs4_state_owner *owner)
624 struct nfs4_state *state, *new;
625 struct nfs_inode *nfsi = NFS_I(inode);
627 spin_lock(&inode->i_lock);
628 state = __nfs4_find_state_byowner(inode, owner);
629 spin_unlock(&inode->i_lock);
632 new = nfs4_alloc_open_state();
633 spin_lock(&owner->so_lock);
634 spin_lock(&inode->i_lock);
635 state = __nfs4_find_state_byowner(inode, owner);
636 if (state == NULL && new != NULL) {
638 state->owner = owner;
639 atomic_inc(&owner->so_count);
640 list_add(&state->inode_states, &nfsi->open_states);
642 state->inode = inode;
643 spin_unlock(&inode->i_lock);
644 /* Note: The reclaim code dictates that we add stateless
645 * and read-only stateids to the end of the list */
646 list_add_tail(&state->open_states, &owner->so_states);
647 spin_unlock(&owner->so_lock);
649 spin_unlock(&inode->i_lock);
650 spin_unlock(&owner->so_lock);
652 nfs4_free_open_state(new);
658 void nfs4_put_open_state(struct nfs4_state *state)
660 struct inode *inode = state->inode;
661 struct nfs4_state_owner *owner = state->owner;
663 if (!atomic_dec_and_lock(&state->count, &owner->so_lock))
665 spin_lock(&inode->i_lock);
666 list_del(&state->inode_states);
667 list_del(&state->open_states);
668 spin_unlock(&inode->i_lock);
669 spin_unlock(&owner->so_lock);
671 nfs4_free_open_state(state);
672 nfs4_put_state_owner(owner);
676 * Close the current file.
678 static void __nfs4_close(struct nfs4_state *state,
679 fmode_t fmode, gfp_t gfp_mask, int wait)
681 struct nfs4_state_owner *owner = state->owner;
685 atomic_inc(&owner->so_count);
686 /* Protect against nfs4_find_state() */
687 spin_lock(&owner->so_lock);
688 switch (fmode & (FMODE_READ | FMODE_WRITE)) {
695 case FMODE_READ|FMODE_WRITE:
698 newstate = FMODE_READ|FMODE_WRITE;
699 if (state->n_rdwr == 0) {
700 if (state->n_rdonly == 0) {
701 newstate &= ~FMODE_READ;
702 call_close |= test_bit(NFS_O_RDONLY_STATE, &state->flags);
703 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
705 if (state->n_wronly == 0) {
706 newstate &= ~FMODE_WRITE;
707 call_close |= test_bit(NFS_O_WRONLY_STATE, &state->flags);
708 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
711 clear_bit(NFS_DELEGATED_STATE, &state->flags);
713 nfs4_state_set_mode_locked(state, newstate);
714 spin_unlock(&owner->so_lock);
717 nfs4_put_open_state(state);
718 nfs4_put_state_owner(owner);
720 bool roc = pnfs_roc(state->inode);
722 nfs4_do_close(state, gfp_mask, wait, roc);
726 void nfs4_close_state(struct nfs4_state *state, fmode_t fmode)
728 __nfs4_close(state, fmode, GFP_NOFS, 0);
731 void nfs4_close_sync(struct nfs4_state *state, fmode_t fmode)
733 __nfs4_close(state, fmode, GFP_KERNEL, 1);
737 * Search the state->lock_states for an existing lock_owner
738 * that is compatible with current->files
740 static struct nfs4_lock_state *
741 __nfs4_find_lock_state(struct nfs4_state *state, fl_owner_t fl_owner, pid_t fl_pid, unsigned int type)
743 struct nfs4_lock_state *pos;
744 list_for_each_entry(pos, &state->lock_states, ls_locks) {
745 if (type != NFS4_ANY_LOCK_TYPE && pos->ls_owner.lo_type != type)
747 switch (pos->ls_owner.lo_type) {
748 case NFS4_POSIX_LOCK_TYPE:
749 if (pos->ls_owner.lo_u.posix_owner != fl_owner)
752 case NFS4_FLOCK_LOCK_TYPE:
753 if (pos->ls_owner.lo_u.flock_owner != fl_pid)
756 atomic_inc(&pos->ls_count);
763 * Return a compatible lock_state. If no initialized lock_state structure
764 * exists, return an uninitialized one.
767 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)
769 struct nfs4_lock_state *lsp;
770 struct nfs_server *server = state->owner->so_server;
772 lsp = kzalloc(sizeof(*lsp), GFP_NOFS);
775 nfs4_init_seqid_counter(&lsp->ls_seqid);
776 atomic_set(&lsp->ls_count, 1);
777 lsp->ls_state = state;
778 lsp->ls_owner.lo_type = type;
779 switch (lsp->ls_owner.lo_type) {
780 case NFS4_FLOCK_LOCK_TYPE:
781 lsp->ls_owner.lo_u.flock_owner = fl_pid;
783 case NFS4_POSIX_LOCK_TYPE:
784 lsp->ls_owner.lo_u.posix_owner = fl_owner;
789 lsp->ls_seqid.owner_id = ida_simple_get(&server->lockowner_id, 0, 0, GFP_NOFS);
790 if (lsp->ls_seqid.owner_id < 0)
792 INIT_LIST_HEAD(&lsp->ls_locks);
799 void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp)
801 ida_simple_remove(&server->lockowner_id, lsp->ls_seqid.owner_id);
802 nfs4_destroy_seqid_counter(&lsp->ls_seqid);
807 * Return a compatible lock_state. If no initialized lock_state structure
808 * exists, return an uninitialized one.
811 static struct nfs4_lock_state *nfs4_get_lock_state(struct nfs4_state *state, fl_owner_t owner, pid_t pid, unsigned int type)
813 struct nfs4_lock_state *lsp, *new = NULL;
816 spin_lock(&state->state_lock);
817 lsp = __nfs4_find_lock_state(state, owner, pid, type);
821 list_add(&new->ls_locks, &state->lock_states);
822 set_bit(LK_STATE_IN_USE, &state->flags);
827 spin_unlock(&state->state_lock);
828 new = nfs4_alloc_lock_state(state, owner, pid, type);
832 spin_unlock(&state->state_lock);
834 nfs4_free_lock_state(state->owner->so_server, new);
839 * Release reference to lock_state, and free it if we see that
840 * it is no longer in use
842 void nfs4_put_lock_state(struct nfs4_lock_state *lsp)
844 struct nfs4_state *state;
848 state = lsp->ls_state;
849 if (!atomic_dec_and_lock(&lsp->ls_count, &state->state_lock))
851 list_del(&lsp->ls_locks);
852 if (list_empty(&state->lock_states))
853 clear_bit(LK_STATE_IN_USE, &state->flags);
854 spin_unlock(&state->state_lock);
855 if (lsp->ls_flags & NFS_LOCK_INITIALIZED) {
856 if (nfs4_release_lockowner(lsp) == 0)
859 nfs4_free_lock_state(lsp->ls_state->owner->so_server, lsp);
862 static void nfs4_fl_copy_lock(struct file_lock *dst, struct file_lock *src)
864 struct nfs4_lock_state *lsp = src->fl_u.nfs4_fl.owner;
866 dst->fl_u.nfs4_fl.owner = lsp;
867 atomic_inc(&lsp->ls_count);
870 static void nfs4_fl_release_lock(struct file_lock *fl)
872 nfs4_put_lock_state(fl->fl_u.nfs4_fl.owner);
875 static const struct file_lock_operations nfs4_fl_lock_ops = {
876 .fl_copy_lock = nfs4_fl_copy_lock,
877 .fl_release_private = nfs4_fl_release_lock,
880 int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl)
882 struct nfs4_lock_state *lsp;
884 if (fl->fl_ops != NULL)
886 if (fl->fl_flags & FL_POSIX)
887 lsp = nfs4_get_lock_state(state, fl->fl_owner, 0, NFS4_POSIX_LOCK_TYPE);
888 else if (fl->fl_flags & FL_FLOCK)
889 lsp = nfs4_get_lock_state(state, NULL, fl->fl_pid,
890 NFS4_FLOCK_LOCK_TYPE);
895 fl->fl_u.nfs4_fl.owner = lsp;
896 fl->fl_ops = &nfs4_fl_lock_ops;
900 static bool nfs4_copy_lock_stateid(nfs4_stateid *dst, struct nfs4_state *state,
901 fl_owner_t fl_owner, pid_t fl_pid)
903 struct nfs4_lock_state *lsp;
906 if (test_bit(LK_STATE_IN_USE, &state->flags) == 0)
909 spin_lock(&state->state_lock);
910 lsp = __nfs4_find_lock_state(state, fl_owner, fl_pid, NFS4_ANY_LOCK_TYPE);
911 if (lsp != NULL && (lsp->ls_flags & NFS_LOCK_INITIALIZED) != 0) {
912 nfs4_stateid_copy(dst, &lsp->ls_stateid);
915 spin_unlock(&state->state_lock);
916 nfs4_put_lock_state(lsp);
921 static void nfs4_copy_open_stateid(nfs4_stateid *dst, struct nfs4_state *state)
926 seq = read_seqbegin(&state->seqlock);
927 nfs4_stateid_copy(dst, &state->stateid);
928 } while (read_seqretry(&state->seqlock, seq));
932 * Byte-range lock aware utility to initialize the stateid of read/write
935 void nfs4_select_rw_stateid(nfs4_stateid *dst, struct nfs4_state *state,
936 fmode_t fmode, fl_owner_t fl_owner, pid_t fl_pid)
938 if (nfs4_copy_delegation_stateid(dst, state->inode, fmode))
940 if (nfs4_copy_lock_stateid(dst, state, fl_owner, fl_pid))
942 nfs4_copy_open_stateid(dst, state);
945 struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask)
947 struct nfs_seqid *new;
949 new = kmalloc(sizeof(*new), gfp_mask);
951 new->sequence = counter;
952 INIT_LIST_HEAD(&new->list);
958 void nfs_release_seqid(struct nfs_seqid *seqid)
960 struct nfs_seqid_counter *sequence;
962 if (list_empty(&seqid->list))
964 sequence = seqid->sequence;
965 spin_lock(&sequence->lock);
966 list_del_init(&seqid->list);
967 if (!list_empty(&sequence->list)) {
968 struct nfs_seqid *next;
970 next = list_first_entry(&sequence->list,
971 struct nfs_seqid, list);
972 rpc_wake_up_queued_task(&sequence->wait, next->task);
974 spin_unlock(&sequence->lock);
977 void nfs_free_seqid(struct nfs_seqid *seqid)
979 nfs_release_seqid(seqid);
984 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
985 * failed with a seqid incrementing error -
986 * see comments nfs_fs.h:seqid_mutating_error()
988 static void nfs_increment_seqid(int status, struct nfs_seqid *seqid)
990 BUG_ON(list_first_entry(&seqid->sequence->list, struct nfs_seqid, list) != seqid);
994 case -NFS4ERR_BAD_SEQID:
995 if (seqid->sequence->flags & NFS_SEQID_CONFIRMED)
997 pr_warn_ratelimited("NFS: v4 server returned a bad"
998 " sequence-id error on an"
999 " unconfirmed sequence %p!\n",
1001 case -NFS4ERR_STALE_CLIENTID:
1002 case -NFS4ERR_STALE_STATEID:
1003 case -NFS4ERR_BAD_STATEID:
1004 case -NFS4ERR_BADXDR:
1005 case -NFS4ERR_RESOURCE:
1006 case -NFS4ERR_NOFILEHANDLE:
1007 /* Non-seqid mutating errors */
1011 * Note: no locking needed as we are guaranteed to be first
1012 * on the sequence list
1014 seqid->sequence->counter++;
1017 void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid)
1019 struct nfs4_state_owner *sp = container_of(seqid->sequence,
1020 struct nfs4_state_owner, so_seqid);
1021 struct nfs_server *server = sp->so_server;
1023 if (status == -NFS4ERR_BAD_SEQID)
1024 nfs4_drop_state_owner(sp);
1025 if (!nfs4_has_session(server->nfs_client))
1026 nfs_increment_seqid(status, seqid);
1030 * Increment the seqid if the LOCK/LOCKU succeeded, or
1031 * failed with a seqid incrementing error -
1032 * see comments nfs_fs.h:seqid_mutating_error()
1034 void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid)
1036 nfs_increment_seqid(status, seqid);
1039 int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task)
1041 struct nfs_seqid_counter *sequence = seqid->sequence;
1044 spin_lock(&sequence->lock);
1046 if (list_empty(&seqid->list))
1047 list_add_tail(&seqid->list, &sequence->list);
1048 if (list_first_entry(&sequence->list, struct nfs_seqid, list) == seqid)
1050 rpc_sleep_on(&sequence->wait, task, NULL);
1053 spin_unlock(&sequence->lock);
1057 static int nfs4_run_state_manager(void *);
1059 static void nfs4_clear_state_manager_bit(struct nfs_client *clp)
1061 smp_mb__before_clear_bit();
1062 clear_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
1063 smp_mb__after_clear_bit();
1064 wake_up_bit(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING);
1065 rpc_wake_up(&clp->cl_rpcwaitq);
1069 * Schedule the nfs_client asynchronous state management routine
1071 void nfs4_schedule_state_manager(struct nfs_client *clp)
1073 struct task_struct *task;
1074 char buf[INET6_ADDRSTRLEN + sizeof("-manager") + 1];
1076 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
1078 __module_get(THIS_MODULE);
1079 atomic_inc(&clp->cl_count);
1081 /* The rcu_read_lock() is not strictly necessary, as the state
1082 * manager is the only thread that ever changes the rpc_xprt
1083 * after it's initialized. At this point, we're single threaded. */
1085 snprintf(buf, sizeof(buf), "%s-manager",
1086 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_ADDR));
1088 task = kthread_run(nfs4_run_state_manager, clp, buf);
1090 printk(KERN_ERR "%s: kthread_run: %ld\n",
1091 __func__, PTR_ERR(task));
1092 nfs4_clear_state_manager_bit(clp);
1093 nfs_put_client(clp);
1094 module_put(THIS_MODULE);
1099 * Schedule a lease recovery attempt
1101 void nfs4_schedule_lease_recovery(struct nfs_client *clp)
1105 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1106 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1107 nfs4_schedule_state_manager(clp);
1109 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_recovery);
1112 * nfs40_handle_cb_pathdown - return all delegations after NFS4ERR_CB_PATH_DOWN
1113 * @clp: client to process
1115 * Set the NFS4CLNT_LEASE_EXPIRED state in order to force a
1116 * resend of the SETCLIENTID and hence re-establish the
1117 * callback channel. Then return all existing delegations.
1119 static void nfs40_handle_cb_pathdown(struct nfs_client *clp)
1121 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1122 nfs_expire_all_delegations(clp);
1125 void nfs4_schedule_path_down_recovery(struct nfs_client *clp)
1127 nfs40_handle_cb_pathdown(clp);
1128 nfs4_schedule_state_manager(clp);
1131 static int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state)
1134 set_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1135 /* Don't recover state that expired before the reboot */
1136 if (test_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags)) {
1137 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1140 set_bit(NFS_OWNER_RECLAIM_REBOOT, &state->owner->so_flags);
1141 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1145 static int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state)
1147 set_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags);
1148 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1149 set_bit(NFS_OWNER_RECLAIM_NOGRACE, &state->owner->so_flags);
1150 set_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state);
1154 void nfs4_schedule_stateid_recovery(const struct nfs_server *server, struct nfs4_state *state)
1156 struct nfs_client *clp = server->nfs_client;
1158 nfs4_state_mark_reclaim_nograce(clp, state);
1159 nfs4_schedule_state_manager(clp);
1161 EXPORT_SYMBOL_GPL(nfs4_schedule_stateid_recovery);
1163 void nfs_inode_find_state_and_recover(struct inode *inode,
1164 const nfs4_stateid *stateid)
1166 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1167 struct nfs_inode *nfsi = NFS_I(inode);
1168 struct nfs_open_context *ctx;
1169 struct nfs4_state *state;
1172 spin_lock(&inode->i_lock);
1173 list_for_each_entry(ctx, &nfsi->open_files, list) {
1177 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
1179 if (!nfs4_stateid_match(&state->stateid, stateid))
1181 nfs4_state_mark_reclaim_nograce(clp, state);
1184 spin_unlock(&inode->i_lock);
1186 nfs4_schedule_state_manager(clp);
1190 static int nfs4_reclaim_locks(struct nfs4_state *state, const struct nfs4_state_recovery_ops *ops)
1192 struct inode *inode = state->inode;
1193 struct nfs_inode *nfsi = NFS_I(inode);
1194 struct file_lock *fl;
1197 if (inode->i_flock == NULL)
1200 /* Guard against delegation returns and new lock/unlock calls */
1201 down_write(&nfsi->rwsem);
1202 /* Protect inode->i_flock using the BKL */
1204 for (fl = inode->i_flock; fl != NULL; fl = fl->fl_next) {
1205 if (!(fl->fl_flags & (FL_POSIX|FL_FLOCK)))
1207 if (nfs_file_open_context(fl->fl_file)->state != state)
1210 status = ops->recover_lock(state, fl);
1215 case -NFS4ERR_ADMIN_REVOKED:
1216 case -NFS4ERR_STALE_STATEID:
1217 case -NFS4ERR_BAD_STATEID:
1218 case -NFS4ERR_EXPIRED:
1219 case -NFS4ERR_NO_GRACE:
1220 case -NFS4ERR_STALE_CLIENTID:
1221 case -NFS4ERR_BADSESSION:
1222 case -NFS4ERR_BADSLOT:
1223 case -NFS4ERR_BAD_HIGH_SLOT:
1224 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1227 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1228 "Zeroing state\n", __func__, status);
1230 case -NFS4ERR_DENIED:
1231 case -NFS4ERR_RECLAIM_BAD:
1232 case -NFS4ERR_RECLAIM_CONFLICT:
1233 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
1240 up_write(&nfsi->rwsem);
1244 static int nfs4_reclaim_open_state(struct nfs4_state_owner *sp, const struct nfs4_state_recovery_ops *ops)
1246 struct nfs4_state *state;
1247 struct nfs4_lock_state *lock;
1250 /* Note: we rely on the sp->so_states list being ordered
1251 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
1253 * This is needed to ensure that the server won't give us any
1254 * read delegations that we have to return if, say, we are
1255 * recovering after a network partition or a reboot from a
1256 * server that doesn't support a grace period.
1259 spin_lock(&sp->so_lock);
1260 list_for_each_entry(state, &sp->so_states, open_states) {
1261 if (!test_and_clear_bit(ops->state_flag_bit, &state->flags))
1263 if (state->state == 0)
1265 atomic_inc(&state->count);
1266 spin_unlock(&sp->so_lock);
1267 status = ops->recover_open(sp, state);
1269 status = nfs4_reclaim_locks(state, ops);
1271 spin_lock(&state->state_lock);
1272 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1273 if (!(lock->ls_flags & NFS_LOCK_INITIALIZED))
1274 pr_warn_ratelimited("NFS: "
1276 "failed!\n", __func__);
1278 spin_unlock(&state->state_lock);
1279 nfs4_put_open_state(state);
1285 printk(KERN_ERR "NFS: %s: unhandled error %d. "
1286 "Zeroing state\n", __func__, status);
1291 * Open state on this file cannot be recovered
1292 * All we can do is revert to using the zero stateid.
1294 memset(&state->stateid, 0,
1295 sizeof(state->stateid));
1296 /* Mark the file as being 'closed' */
1301 * User RPCSEC_GSS context has expired.
1302 * We cannot recover this stateid now, so
1303 * skip it and allow recovery thread to
1307 case -NFS4ERR_ADMIN_REVOKED:
1308 case -NFS4ERR_STALE_STATEID:
1309 case -NFS4ERR_BAD_STATEID:
1310 case -NFS4ERR_RECLAIM_BAD:
1311 case -NFS4ERR_RECLAIM_CONFLICT:
1312 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1314 case -NFS4ERR_EXPIRED:
1315 case -NFS4ERR_NO_GRACE:
1316 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1317 case -NFS4ERR_STALE_CLIENTID:
1318 case -NFS4ERR_BADSESSION:
1319 case -NFS4ERR_BADSLOT:
1320 case -NFS4ERR_BAD_HIGH_SLOT:
1321 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1324 nfs4_put_open_state(state);
1327 spin_unlock(&sp->so_lock);
1330 nfs4_put_open_state(state);
1334 static void nfs4_clear_open_state(struct nfs4_state *state)
1336 struct nfs4_lock_state *lock;
1338 clear_bit(NFS_DELEGATED_STATE, &state->flags);
1339 clear_bit(NFS_O_RDONLY_STATE, &state->flags);
1340 clear_bit(NFS_O_WRONLY_STATE, &state->flags);
1341 clear_bit(NFS_O_RDWR_STATE, &state->flags);
1342 spin_lock(&state->state_lock);
1343 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1344 lock->ls_seqid.flags = 0;
1345 lock->ls_flags &= ~NFS_LOCK_INITIALIZED;
1347 spin_unlock(&state->state_lock);
1350 static void nfs4_reset_seqids(struct nfs_server *server,
1351 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1353 struct nfs_client *clp = server->nfs_client;
1354 struct nfs4_state_owner *sp;
1355 struct rb_node *pos;
1356 struct nfs4_state *state;
1358 spin_lock(&clp->cl_lock);
1359 for (pos = rb_first(&server->state_owners);
1361 pos = rb_next(pos)) {
1362 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1363 sp->so_seqid.flags = 0;
1364 spin_lock(&sp->so_lock);
1365 list_for_each_entry(state, &sp->so_states, open_states) {
1366 if (mark_reclaim(clp, state))
1367 nfs4_clear_open_state(state);
1369 spin_unlock(&sp->so_lock);
1371 spin_unlock(&clp->cl_lock);
1374 static void nfs4_state_mark_reclaim_helper(struct nfs_client *clp,
1375 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1377 struct nfs_server *server;
1380 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1381 nfs4_reset_seqids(server, mark_reclaim);
1385 static void nfs4_state_start_reclaim_reboot(struct nfs_client *clp)
1387 /* Mark all delegations for reclaim */
1388 nfs_delegation_mark_reclaim(clp);
1389 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_reboot);
1392 static void nfs4_reclaim_complete(struct nfs_client *clp,
1393 const struct nfs4_state_recovery_ops *ops)
1395 /* Notify the server we're done reclaiming our state */
1396 if (ops->reclaim_complete)
1397 (void)ops->reclaim_complete(clp);
1400 static void nfs4_clear_reclaim_server(struct nfs_server *server)
1402 struct nfs_client *clp = server->nfs_client;
1403 struct nfs4_state_owner *sp;
1404 struct rb_node *pos;
1405 struct nfs4_state *state;
1407 spin_lock(&clp->cl_lock);
1408 for (pos = rb_first(&server->state_owners);
1410 pos = rb_next(pos)) {
1411 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1412 spin_lock(&sp->so_lock);
1413 list_for_each_entry(state, &sp->so_states, open_states) {
1414 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT,
1417 nfs4_state_mark_reclaim_nograce(clp, state);
1419 spin_unlock(&sp->so_lock);
1421 spin_unlock(&clp->cl_lock);
1424 static int nfs4_state_clear_reclaim_reboot(struct nfs_client *clp)
1426 struct nfs_server *server;
1428 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
1432 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1433 nfs4_clear_reclaim_server(server);
1436 nfs_delegation_reap_unclaimed(clp);
1440 static void nfs4_state_end_reclaim_reboot(struct nfs_client *clp)
1442 if (!nfs4_state_clear_reclaim_reboot(clp))
1444 nfs4_reclaim_complete(clp, clp->cl_mvops->reboot_recovery_ops);
1447 static void nfs_delegation_clear_all(struct nfs_client *clp)
1449 nfs_delegation_mark_reclaim(clp);
1450 nfs_delegation_reap_unclaimed(clp);
1453 static void nfs4_state_start_reclaim_nograce(struct nfs_client *clp)
1455 nfs_delegation_clear_all(clp);
1456 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_nograce);
1459 static void nfs4_warn_keyexpired(const char *s)
1461 printk_ratelimited(KERN_WARNING "Error: state manager"
1462 " encountered RPCSEC_GSS session"
1463 " expired against NFSv4 server %s.\n",
1467 static int nfs4_recovery_handle_error(struct nfs_client *clp, int error)
1472 case -NFS4ERR_CB_PATH_DOWN:
1473 nfs40_handle_cb_pathdown(clp);
1475 case -NFS4ERR_NO_GRACE:
1476 nfs4_state_end_reclaim_reboot(clp);
1478 case -NFS4ERR_STALE_CLIENTID:
1479 case -NFS4ERR_LEASE_MOVED:
1480 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1481 nfs4_state_clear_reclaim_reboot(clp);
1482 nfs4_state_start_reclaim_reboot(clp);
1484 case -NFS4ERR_EXPIRED:
1485 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1486 nfs4_state_start_reclaim_nograce(clp);
1488 case -NFS4ERR_BADSESSION:
1489 case -NFS4ERR_BADSLOT:
1490 case -NFS4ERR_BAD_HIGH_SLOT:
1491 case -NFS4ERR_DEADSESSION:
1492 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1493 case -NFS4ERR_SEQ_FALSE_RETRY:
1494 case -NFS4ERR_SEQ_MISORDERED:
1495 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1496 /* Zero session reset errors */
1499 /* Nothing we can do */
1500 nfs4_warn_keyexpired(clp->cl_hostname);
1508 static int nfs4_do_reclaim(struct nfs_client *clp, const struct nfs4_state_recovery_ops *ops)
1510 struct nfs4_state_owner *sp;
1511 struct nfs_server *server;
1512 struct rb_node *pos;
1517 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1518 nfs4_purge_state_owners(server);
1519 spin_lock(&clp->cl_lock);
1520 for (pos = rb_first(&server->state_owners);
1522 pos = rb_next(pos)) {
1524 struct nfs4_state_owner, so_server_node);
1525 if (!test_and_clear_bit(ops->owner_flag_bit,
1528 atomic_inc(&sp->so_count);
1529 spin_unlock(&clp->cl_lock);
1532 status = nfs4_reclaim_open_state(sp, ops);
1534 set_bit(ops->owner_flag_bit, &sp->so_flags);
1535 nfs4_put_state_owner(sp);
1536 return nfs4_recovery_handle_error(clp, status);
1539 nfs4_put_state_owner(sp);
1542 spin_unlock(&clp->cl_lock);
1548 static int nfs4_check_lease(struct nfs_client *clp)
1550 struct rpc_cred *cred;
1551 const struct nfs4_state_maintenance_ops *ops =
1552 clp->cl_mvops->state_renewal_ops;
1555 /* Is the client already known to have an expired lease? */
1556 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1558 spin_lock(&clp->cl_lock);
1559 cred = ops->get_state_renewal_cred_locked(clp);
1560 spin_unlock(&clp->cl_lock);
1562 cred = nfs4_get_setclientid_cred(clp);
1567 status = ops->renew_lease(clp, cred);
1570 return nfs4_recovery_handle_error(clp, status);
1573 static int nfs4_reclaim_lease(struct nfs_client *clp)
1575 struct rpc_cred *cred;
1576 const struct nfs4_state_recovery_ops *ops =
1577 clp->cl_mvops->reboot_recovery_ops;
1578 int status = -ENOENT;
1580 cred = ops->get_clid_cred(clp);
1582 status = ops->establish_clid(clp, cred);
1584 /* Handle case where the user hasn't set up machine creds */
1585 if (status == -EACCES && cred == clp->cl_machine_cred) {
1586 nfs4_clear_machine_cred(clp);
1589 if (status == -NFS4ERR_MINOR_VERS_MISMATCH)
1590 status = -EPROTONOSUPPORT;
1595 #ifdef CONFIG_NFS_V4_1
1596 void nfs4_schedule_session_recovery(struct nfs4_session *session)
1598 struct nfs_client *clp = session->clp;
1600 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1601 nfs4_schedule_lease_recovery(clp);
1603 EXPORT_SYMBOL_GPL(nfs4_schedule_session_recovery);
1605 void nfs41_handle_recall_slot(struct nfs_client *clp)
1607 set_bit(NFS4CLNT_RECALL_SLOT, &clp->cl_state);
1608 nfs4_schedule_state_manager(clp);
1611 static void nfs4_reset_all_state(struct nfs_client *clp)
1613 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1614 clp->cl_boot_time = CURRENT_TIME;
1615 nfs4_state_start_reclaim_nograce(clp);
1616 nfs4_schedule_state_manager(clp);
1620 static void nfs41_handle_server_reboot(struct nfs_client *clp)
1622 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
1623 nfs4_state_start_reclaim_reboot(clp);
1624 nfs4_schedule_state_manager(clp);
1628 static void nfs41_handle_state_revoked(struct nfs_client *clp)
1631 nfs4_reset_all_state(clp);
1634 static void nfs41_handle_recallable_state_revoked(struct nfs_client *clp)
1636 /* This will need to handle layouts too */
1637 nfs_expire_all_delegations(clp);
1640 static void nfs41_handle_cb_path_down(struct nfs_client *clp)
1642 nfs_expire_all_delegations(clp);
1643 if (test_and_set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) == 0)
1644 nfs4_schedule_state_manager(clp);
1647 void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags)
1651 if (flags & SEQ4_STATUS_RESTART_RECLAIM_NEEDED)
1652 nfs41_handle_server_reboot(clp);
1653 if (flags & (SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED |
1654 SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED |
1655 SEQ4_STATUS_ADMIN_STATE_REVOKED |
1656 SEQ4_STATUS_LEASE_MOVED))
1657 nfs41_handle_state_revoked(clp);
1658 if (flags & SEQ4_STATUS_RECALLABLE_STATE_REVOKED)
1659 nfs41_handle_recallable_state_revoked(clp);
1660 if (flags & (SEQ4_STATUS_CB_PATH_DOWN |
1661 SEQ4_STATUS_BACKCHANNEL_FAULT |
1662 SEQ4_STATUS_CB_PATH_DOWN_SESSION))
1663 nfs41_handle_cb_path_down(clp);
1666 static int nfs4_reset_session(struct nfs_client *clp)
1670 nfs4_begin_drain_session(clp);
1671 status = nfs4_proc_destroy_session(clp->cl_session);
1672 if (status && status != -NFS4ERR_BADSESSION &&
1673 status != -NFS4ERR_DEADSESSION) {
1674 status = nfs4_recovery_handle_error(clp, status);
1678 memset(clp->cl_session->sess_id.data, 0, NFS4_MAX_SESSIONID_LEN);
1679 status = nfs4_proc_create_session(clp);
1681 status = nfs4_recovery_handle_error(clp, status);
1684 clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1685 /* create_session negotiated new slot table */
1686 clear_bit(NFS4CLNT_RECALL_SLOT, &clp->cl_state);
1688 /* Let the state manager reestablish state */
1689 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1690 nfs41_setup_state_renewal(clp);
1695 static int nfs4_recall_slot(struct nfs_client *clp)
1697 struct nfs4_slot_table *fc_tbl = &clp->cl_session->fc_slot_table;
1698 struct nfs4_channel_attrs *fc_attrs = &clp->cl_session->fc_attrs;
1699 struct nfs4_slot *new, *old;
1702 nfs4_begin_drain_session(clp);
1703 new = kmalloc(fc_tbl->target_max_slots * sizeof(struct nfs4_slot),
1708 spin_lock(&fc_tbl->slot_tbl_lock);
1709 for (i = 0; i < fc_tbl->target_max_slots; i++)
1710 new[i].seq_nr = fc_tbl->slots[i].seq_nr;
1711 old = fc_tbl->slots;
1712 fc_tbl->slots = new;
1713 fc_tbl->max_slots = fc_tbl->target_max_slots;
1714 fc_tbl->target_max_slots = 0;
1715 fc_attrs->max_reqs = fc_tbl->max_slots;
1716 spin_unlock(&fc_tbl->slot_tbl_lock);
1719 nfs4_end_drain_session(clp);
1723 #else /* CONFIG_NFS_V4_1 */
1724 static int nfs4_reset_session(struct nfs_client *clp) { return 0; }
1725 static int nfs4_end_drain_session(struct nfs_client *clp) { return 0; }
1726 static int nfs4_recall_slot(struct nfs_client *clp) { return 0; }
1727 #endif /* CONFIG_NFS_V4_1 */
1729 /* Set NFS4CLNT_LEASE_EXPIRED for all v4.0 errors and for recoverable errors
1730 * on EXCHANGE_ID for v4.1
1732 static void nfs4_set_lease_expired(struct nfs_client *clp, int status)
1735 case -NFS4ERR_CLID_INUSE:
1736 case -NFS4ERR_STALE_CLIENTID:
1737 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1739 case -NFS4ERR_DELAY:
1746 nfs4_warn_keyexpired(clp->cl_hostname);
1747 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1748 * in nfs4_exchange_id */
1752 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1755 static void nfs4_state_manager(struct nfs_client *clp)
1759 /* Ensure exclusive access to NFSv4 state */
1761 if (test_and_clear_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state)) {
1762 /* We're going to have to re-establish a clientid */
1763 status = nfs4_reclaim_lease(clp);
1765 nfs4_set_lease_expired(clp, status);
1766 if (test_bit(NFS4CLNT_LEASE_EXPIRED,
1769 if (clp->cl_cons_state ==
1770 NFS_CS_SESSION_INITING)
1771 nfs_mark_client_ready(clp, status);
1774 clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1776 if (test_and_clear_bit(NFS4CLNT_SERVER_SCOPE_MISMATCH,
1778 nfs4_state_start_reclaim_nograce(clp);
1780 set_bit(NFS4CLNT_RECLAIM_REBOOT,
1783 pnfs_destroy_all_layouts(clp);
1786 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state)) {
1787 status = nfs4_check_lease(clp);
1790 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1794 /* Initialize or reset the session */
1795 if (test_and_clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state)
1796 && nfs4_has_session(clp)) {
1797 status = nfs4_reset_session(clp);
1798 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1804 /* First recover reboot state... */
1805 if (test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state)) {
1806 status = nfs4_do_reclaim(clp,
1807 clp->cl_mvops->reboot_recovery_ops);
1808 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
1809 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
1811 nfs4_state_end_reclaim_reboot(clp);
1812 if (test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
1818 /* Now recover expired state... */
1819 if (test_and_clear_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state)) {
1820 status = nfs4_do_reclaim(clp,
1821 clp->cl_mvops->nograce_recovery_ops);
1822 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) ||
1823 test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state) ||
1824 test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
1830 nfs4_end_drain_session(clp);
1831 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state)) {
1832 nfs_client_return_marked_delegations(clp);
1835 /* Recall session slots */
1836 if (test_and_clear_bit(NFS4CLNT_RECALL_SLOT, &clp->cl_state)
1837 && nfs4_has_session(clp)) {
1838 status = nfs4_recall_slot(clp);
1845 nfs4_clear_state_manager_bit(clp);
1846 /* Did we race with an attempt to give us more work? */
1847 if (clp->cl_state == 0)
1849 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
1851 } while (atomic_read(&clp->cl_count) > 1);
1854 pr_warn_ratelimited("NFS: state manager failed on NFSv4 server %s"
1855 " with error %d\n", clp->cl_hostname, -status);
1856 nfs4_end_drain_session(clp);
1857 nfs4_clear_state_manager_bit(clp);
1860 static int nfs4_run_state_manager(void *ptr)
1862 struct nfs_client *clp = ptr;
1864 allow_signal(SIGKILL);
1865 nfs4_state_manager(clp);
1866 nfs_put_client(clp);
1867 module_put_and_exit(0);