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 NFSDBG_FACILITY NFSDBG_STATE
62 #define OPENOWNER_POOL_SIZE 8
64 const nfs4_stateid zero_stateid
;
66 static LIST_HEAD(nfs4_clientid_list
);
68 int nfs4_init_clientid(struct nfs_client
*clp
, struct rpc_cred
*cred
)
70 struct nfs4_setclientid_res clid
= {
71 .clientid
= clp
->cl_clientid
,
72 .confirm
= clp
->cl_confirm
,
77 if (test_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
))
79 port
= nfs_callback_tcpport
;
80 if (clp
->cl_addr
.ss_family
== AF_INET6
)
81 port
= nfs_callback_tcpport6
;
83 status
= nfs4_proc_setclientid(clp
, NFS4_CALLBACK
, port
, cred
, &clid
);
86 clp
->cl_clientid
= clid
.clientid
;
87 clp
->cl_confirm
= clid
.confirm
;
88 set_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
);
90 status
= nfs4_proc_setclientid_confirm(clp
, &clid
, cred
);
93 clear_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
);
94 nfs4_schedule_state_renewal(clp
);
99 struct rpc_cred
*nfs4_get_machine_cred_locked(struct nfs_client
*clp
)
101 struct rpc_cred
*cred
= NULL
;
103 if (clp
->cl_machine_cred
!= NULL
)
104 cred
= get_rpccred(clp
->cl_machine_cred
);
108 static void nfs4_clear_machine_cred(struct nfs_client
*clp
)
110 struct rpc_cred
*cred
;
112 spin_lock(&clp
->cl_lock
);
113 cred
= clp
->cl_machine_cred
;
114 clp
->cl_machine_cred
= NULL
;
115 spin_unlock(&clp
->cl_lock
);
120 static struct rpc_cred
*
121 nfs4_get_renew_cred_server_locked(struct nfs_server
*server
)
123 struct rpc_cred
*cred
= NULL
;
124 struct nfs4_state_owner
*sp
;
127 for (pos
= rb_first(&server
->state_owners
);
129 pos
= rb_next(pos
)) {
130 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_server_node
);
131 if (list_empty(&sp
->so_states
))
133 cred
= get_rpccred(sp
->so_cred
);
140 * nfs4_get_renew_cred_locked - Acquire credential for a renew operation
141 * @clp: client state handle
143 * Returns an rpc_cred with reference count bumped, or NULL.
144 * Caller must hold clp->cl_lock.
146 struct rpc_cred
*nfs4_get_renew_cred_locked(struct nfs_client
*clp
)
148 struct rpc_cred
*cred
= NULL
;
149 struct nfs_server
*server
;
151 /* Use machine credentials if available */
152 cred
= nfs4_get_machine_cred_locked(clp
);
157 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
) {
158 cred
= nfs4_get_renew_cred_server_locked(server
);
168 #if defined(CONFIG_NFS_V4_1)
170 static int nfs41_setup_state_renewal(struct nfs_client
*clp
)
173 struct nfs_fsinfo fsinfo
;
175 if (!test_bit(NFS_CS_CHECK_LEASE_TIME
, &clp
->cl_res_state
)) {
176 nfs4_schedule_state_renewal(clp
);
180 status
= nfs4_proc_get_lease_time(clp
, &fsinfo
);
182 /* Update lease time and schedule renewal */
183 spin_lock(&clp
->cl_lock
);
184 clp
->cl_lease_time
= fsinfo
.lease_time
* HZ
;
185 clp
->cl_last_renewal
= jiffies
;
186 spin_unlock(&clp
->cl_lock
);
188 nfs4_schedule_state_renewal(clp
);
195 * Back channel returns NFS4ERR_DELAY for new requests when
196 * NFS4_SESSION_DRAINING is set so there is no work to be done when draining
199 static void nfs4_end_drain_session(struct nfs_client
*clp
)
201 struct nfs4_session
*ses
= clp
->cl_session
;
202 struct nfs4_slot_table
*tbl
;
207 tbl
= &ses
->fc_slot_table
;
208 if (test_and_clear_bit(NFS4_SESSION_DRAINING
, &ses
->session_state
)) {
209 spin_lock(&tbl
->slot_tbl_lock
);
210 max_slots
= tbl
->max_slots
;
211 while (max_slots
--) {
212 if (rpc_wake_up_first(&tbl
->slot_tbl_waitq
,
213 nfs4_set_task_privileged
,
217 spin_unlock(&tbl
->slot_tbl_lock
);
221 static int nfs4_wait_on_slot_tbl(struct nfs4_slot_table
*tbl
)
223 spin_lock(&tbl
->slot_tbl_lock
);
224 if (tbl
->highest_used_slotid
!= NFS4_NO_SLOT
) {
225 INIT_COMPLETION(tbl
->complete
);
226 spin_unlock(&tbl
->slot_tbl_lock
);
227 return wait_for_completion_interruptible(&tbl
->complete
);
229 spin_unlock(&tbl
->slot_tbl_lock
);
233 static int nfs4_begin_drain_session(struct nfs_client
*clp
)
235 struct nfs4_session
*ses
= clp
->cl_session
;
238 set_bit(NFS4_SESSION_DRAINING
, &ses
->session_state
);
240 ret
= nfs4_wait_on_slot_tbl(&ses
->bc_slot_table
);
244 return nfs4_wait_on_slot_tbl(&ses
->fc_slot_table
);
247 static void nfs41_finish_session_reset(struct nfs_client
*clp
)
249 clear_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
);
250 clear_bit(NFS4CLNT_SESSION_RESET
, &clp
->cl_state
);
251 /* create_session negotiated new slot table */
252 clear_bit(NFS4CLNT_RECALL_SLOT
, &clp
->cl_state
);
253 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION
, &clp
->cl_state
);
254 nfs41_setup_state_renewal(clp
);
257 int nfs41_init_clientid(struct nfs_client
*clp
, struct rpc_cred
*cred
)
261 if (test_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
))
263 nfs4_begin_drain_session(clp
);
264 status
= nfs4_proc_exchange_id(clp
, cred
);
267 set_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
);
269 status
= nfs4_proc_create_session(clp
, cred
);
272 nfs41_finish_session_reset(clp
);
273 nfs_mark_client_ready(clp
, NFS_CS_READY
);
278 struct rpc_cred
*nfs4_get_exchange_id_cred(struct nfs_client
*clp
)
280 struct rpc_cred
*cred
;
282 spin_lock(&clp
->cl_lock
);
283 cred
= nfs4_get_machine_cred_locked(clp
);
284 spin_unlock(&clp
->cl_lock
);
288 #endif /* CONFIG_NFS_V4_1 */
290 static struct rpc_cred
*
291 nfs4_get_setclientid_cred_server(struct nfs_server
*server
)
293 struct nfs_client
*clp
= server
->nfs_client
;
294 struct rpc_cred
*cred
= NULL
;
295 struct nfs4_state_owner
*sp
;
298 spin_lock(&clp
->cl_lock
);
299 pos
= rb_first(&server
->state_owners
);
301 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_server_node
);
302 cred
= get_rpccred(sp
->so_cred
);
304 spin_unlock(&clp
->cl_lock
);
309 * nfs4_get_setclientid_cred - Acquire credential for a setclientid operation
310 * @clp: client state handle
312 * Returns an rpc_cred with reference count bumped, or NULL.
314 struct rpc_cred
*nfs4_get_setclientid_cred(struct nfs_client
*clp
)
316 struct nfs_server
*server
;
317 struct rpc_cred
*cred
;
319 spin_lock(&clp
->cl_lock
);
320 cred
= nfs4_get_machine_cred_locked(clp
);
321 spin_unlock(&clp
->cl_lock
);
326 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
) {
327 cred
= nfs4_get_setclientid_cred_server(server
);
337 static struct nfs4_state_owner
*
338 nfs4_find_state_owner_locked(struct nfs_server
*server
, struct rpc_cred
*cred
)
340 struct rb_node
**p
= &server
->state_owners
.rb_node
,
342 struct nfs4_state_owner
*sp
;
346 sp
= rb_entry(parent
, struct nfs4_state_owner
, so_server_node
);
348 if (cred
< sp
->so_cred
)
349 p
= &parent
->rb_left
;
350 else if (cred
> sp
->so_cred
)
351 p
= &parent
->rb_right
;
353 if (!list_empty(&sp
->so_lru
))
354 list_del_init(&sp
->so_lru
);
355 atomic_inc(&sp
->so_count
);
362 static struct nfs4_state_owner
*
363 nfs4_insert_state_owner_locked(struct nfs4_state_owner
*new)
365 struct nfs_server
*server
= new->so_server
;
366 struct rb_node
**p
= &server
->state_owners
.rb_node
,
368 struct nfs4_state_owner
*sp
;
373 sp
= rb_entry(parent
, struct nfs4_state_owner
, so_server_node
);
375 if (new->so_cred
< sp
->so_cred
)
376 p
= &parent
->rb_left
;
377 else if (new->so_cred
> sp
->so_cred
)
378 p
= &parent
->rb_right
;
380 if (!list_empty(&sp
->so_lru
))
381 list_del_init(&sp
->so_lru
);
382 atomic_inc(&sp
->so_count
);
386 err
= ida_get_new(&server
->openowner_id
, &new->so_seqid
.owner_id
);
389 rb_link_node(&new->so_server_node
, parent
, p
);
390 rb_insert_color(&new->so_server_node
, &server
->state_owners
);
395 nfs4_remove_state_owner_locked(struct nfs4_state_owner
*sp
)
397 struct nfs_server
*server
= sp
->so_server
;
399 if (!RB_EMPTY_NODE(&sp
->so_server_node
))
400 rb_erase(&sp
->so_server_node
, &server
->state_owners
);
401 ida_remove(&server
->openowner_id
, sp
->so_seqid
.owner_id
);
405 nfs4_init_seqid_counter(struct nfs_seqid_counter
*sc
)
407 sc
->create_time
= ktime_get();
410 spin_lock_init(&sc
->lock
);
411 INIT_LIST_HEAD(&sc
->list
);
412 rpc_init_wait_queue(&sc
->wait
, "Seqid_waitqueue");
416 nfs4_destroy_seqid_counter(struct nfs_seqid_counter
*sc
)
418 rpc_destroy_wait_queue(&sc
->wait
);
422 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
423 * create a new state_owner.
426 static struct nfs4_state_owner
*
427 nfs4_alloc_state_owner(struct nfs_server
*server
,
428 struct rpc_cred
*cred
,
431 struct nfs4_state_owner
*sp
;
433 sp
= kzalloc(sizeof(*sp
), gfp_flags
);
436 sp
->so_server
= server
;
437 sp
->so_cred
= get_rpccred(cred
);
438 spin_lock_init(&sp
->so_lock
);
439 INIT_LIST_HEAD(&sp
->so_states
);
440 nfs4_init_seqid_counter(&sp
->so_seqid
);
441 atomic_set(&sp
->so_count
, 1);
442 INIT_LIST_HEAD(&sp
->so_lru
);
447 nfs4_drop_state_owner(struct nfs4_state_owner
*sp
)
449 struct rb_node
*rb_node
= &sp
->so_server_node
;
451 if (!RB_EMPTY_NODE(rb_node
)) {
452 struct nfs_server
*server
= sp
->so_server
;
453 struct nfs_client
*clp
= server
->nfs_client
;
455 spin_lock(&clp
->cl_lock
);
456 if (!RB_EMPTY_NODE(rb_node
)) {
457 rb_erase(rb_node
, &server
->state_owners
);
458 RB_CLEAR_NODE(rb_node
);
460 spin_unlock(&clp
->cl_lock
);
464 static void nfs4_free_state_owner(struct nfs4_state_owner
*sp
)
466 nfs4_destroy_seqid_counter(&sp
->so_seqid
);
467 put_rpccred(sp
->so_cred
);
471 static void nfs4_gc_state_owners(struct nfs_server
*server
)
473 struct nfs_client
*clp
= server
->nfs_client
;
474 struct nfs4_state_owner
*sp
, *tmp
;
475 unsigned long time_min
, time_max
;
478 spin_lock(&clp
->cl_lock
);
480 time_min
= (long)time_max
- (long)clp
->cl_lease_time
;
481 list_for_each_entry_safe(sp
, tmp
, &server
->state_owners_lru
, so_lru
) {
482 /* NB: LRU is sorted so that oldest is at the head */
483 if (time_in_range(sp
->so_expires
, time_min
, time_max
))
485 list_move(&sp
->so_lru
, &doomed
);
486 nfs4_remove_state_owner_locked(sp
);
488 spin_unlock(&clp
->cl_lock
);
490 list_for_each_entry_safe(sp
, tmp
, &doomed
, so_lru
) {
491 list_del(&sp
->so_lru
);
492 nfs4_free_state_owner(sp
);
497 * nfs4_get_state_owner - Look up a state owner given a credential
498 * @server: nfs_server to search
499 * @cred: RPC credential to match
501 * Returns a pointer to an instantiated nfs4_state_owner struct, or NULL.
503 struct nfs4_state_owner
*nfs4_get_state_owner(struct nfs_server
*server
,
504 struct rpc_cred
*cred
,
507 struct nfs_client
*clp
= server
->nfs_client
;
508 struct nfs4_state_owner
*sp
, *new;
510 spin_lock(&clp
->cl_lock
);
511 sp
= nfs4_find_state_owner_locked(server
, cred
);
512 spin_unlock(&clp
->cl_lock
);
515 new = nfs4_alloc_state_owner(server
, cred
, gfp_flags
);
519 if (ida_pre_get(&server
->openowner_id
, gfp_flags
) == 0)
521 spin_lock(&clp
->cl_lock
);
522 sp
= nfs4_insert_state_owner_locked(new);
523 spin_unlock(&clp
->cl_lock
);
524 } while (sp
== ERR_PTR(-EAGAIN
));
526 nfs4_free_state_owner(new);
528 nfs4_gc_state_owners(server
);
533 * nfs4_put_state_owner - Release a nfs4_state_owner
534 * @sp: state owner data to release
536 * Note that we keep released state owners on an LRU
538 * This caches valid state owners so that they can be
539 * reused, to avoid the OPEN_CONFIRM on minor version 0.
540 * It also pins the uniquifier of dropped state owners for
541 * a while, to ensure that those state owner names are
544 void nfs4_put_state_owner(struct nfs4_state_owner
*sp
)
546 struct nfs_server
*server
= sp
->so_server
;
547 struct nfs_client
*clp
= server
->nfs_client
;
549 if (!atomic_dec_and_lock(&sp
->so_count
, &clp
->cl_lock
))
552 sp
->so_expires
= jiffies
;
553 list_add_tail(&sp
->so_lru
, &server
->state_owners_lru
);
554 spin_unlock(&clp
->cl_lock
);
558 * nfs4_purge_state_owners - Release all cached state owners
559 * @server: nfs_server with cached state owners to release
561 * Called at umount time. Remaining state owners will be on
562 * the LRU with ref count of zero.
564 void nfs4_purge_state_owners(struct nfs_server
*server
)
566 struct nfs_client
*clp
= server
->nfs_client
;
567 struct nfs4_state_owner
*sp
, *tmp
;
570 spin_lock(&clp
->cl_lock
);
571 list_for_each_entry_safe(sp
, tmp
, &server
->state_owners_lru
, so_lru
) {
572 list_move(&sp
->so_lru
, &doomed
);
573 nfs4_remove_state_owner_locked(sp
);
575 spin_unlock(&clp
->cl_lock
);
577 list_for_each_entry_safe(sp
, tmp
, &doomed
, so_lru
) {
578 list_del(&sp
->so_lru
);
579 nfs4_free_state_owner(sp
);
583 static struct nfs4_state
*
584 nfs4_alloc_open_state(void)
586 struct nfs4_state
*state
;
588 state
= kzalloc(sizeof(*state
), GFP_NOFS
);
591 atomic_set(&state
->count
, 1);
592 INIT_LIST_HEAD(&state
->lock_states
);
593 spin_lock_init(&state
->state_lock
);
594 seqlock_init(&state
->seqlock
);
599 nfs4_state_set_mode_locked(struct nfs4_state
*state
, fmode_t fmode
)
601 if (state
->state
== fmode
)
603 /* NB! List reordering - see the reclaim code for why. */
604 if ((fmode
& FMODE_WRITE
) != (state
->state
& FMODE_WRITE
)) {
605 if (fmode
& FMODE_WRITE
)
606 list_move(&state
->open_states
, &state
->owner
->so_states
);
608 list_move_tail(&state
->open_states
, &state
->owner
->so_states
);
610 state
->state
= fmode
;
613 static struct nfs4_state
*
614 __nfs4_find_state_byowner(struct inode
*inode
, struct nfs4_state_owner
*owner
)
616 struct nfs_inode
*nfsi
= NFS_I(inode
);
617 struct nfs4_state
*state
;
619 list_for_each_entry(state
, &nfsi
->open_states
, inode_states
) {
620 if (state
->owner
!= owner
)
622 if (atomic_inc_not_zero(&state
->count
))
629 nfs4_free_open_state(struct nfs4_state
*state
)
635 nfs4_get_open_state(struct inode
*inode
, struct nfs4_state_owner
*owner
)
637 struct nfs4_state
*state
, *new;
638 struct nfs_inode
*nfsi
= NFS_I(inode
);
640 spin_lock(&inode
->i_lock
);
641 state
= __nfs4_find_state_byowner(inode
, owner
);
642 spin_unlock(&inode
->i_lock
);
645 new = nfs4_alloc_open_state();
646 spin_lock(&owner
->so_lock
);
647 spin_lock(&inode
->i_lock
);
648 state
= __nfs4_find_state_byowner(inode
, owner
);
649 if (state
== NULL
&& new != NULL
) {
651 state
->owner
= owner
;
652 atomic_inc(&owner
->so_count
);
653 list_add(&state
->inode_states
, &nfsi
->open_states
);
655 state
->inode
= inode
;
656 spin_unlock(&inode
->i_lock
);
657 /* Note: The reclaim code dictates that we add stateless
658 * and read-only stateids to the end of the list */
659 list_add_tail(&state
->open_states
, &owner
->so_states
);
660 spin_unlock(&owner
->so_lock
);
662 spin_unlock(&inode
->i_lock
);
663 spin_unlock(&owner
->so_lock
);
665 nfs4_free_open_state(new);
671 void nfs4_put_open_state(struct nfs4_state
*state
)
673 struct inode
*inode
= state
->inode
;
674 struct nfs4_state_owner
*owner
= state
->owner
;
676 if (!atomic_dec_and_lock(&state
->count
, &owner
->so_lock
))
678 spin_lock(&inode
->i_lock
);
679 list_del(&state
->inode_states
);
680 list_del(&state
->open_states
);
681 spin_unlock(&inode
->i_lock
);
682 spin_unlock(&owner
->so_lock
);
684 nfs4_free_open_state(state
);
685 nfs4_put_state_owner(owner
);
689 * Close the current file.
691 static void __nfs4_close(struct nfs4_state
*state
,
692 fmode_t fmode
, gfp_t gfp_mask
, int wait
)
694 struct nfs4_state_owner
*owner
= state
->owner
;
698 atomic_inc(&owner
->so_count
);
699 /* Protect against nfs4_find_state() */
700 spin_lock(&owner
->so_lock
);
701 switch (fmode
& (FMODE_READ
| FMODE_WRITE
)) {
708 case FMODE_READ
|FMODE_WRITE
:
711 newstate
= FMODE_READ
|FMODE_WRITE
;
712 if (state
->n_rdwr
== 0) {
713 if (state
->n_rdonly
== 0) {
714 newstate
&= ~FMODE_READ
;
715 call_close
|= test_bit(NFS_O_RDONLY_STATE
, &state
->flags
);
716 call_close
|= test_bit(NFS_O_RDWR_STATE
, &state
->flags
);
718 if (state
->n_wronly
== 0) {
719 newstate
&= ~FMODE_WRITE
;
720 call_close
|= test_bit(NFS_O_WRONLY_STATE
, &state
->flags
);
721 call_close
|= test_bit(NFS_O_RDWR_STATE
, &state
->flags
);
724 clear_bit(NFS_DELEGATED_STATE
, &state
->flags
);
726 nfs4_state_set_mode_locked(state
, newstate
);
727 spin_unlock(&owner
->so_lock
);
730 nfs4_put_open_state(state
);
731 nfs4_put_state_owner(owner
);
733 bool roc
= pnfs_roc(state
->inode
);
735 nfs4_do_close(state
, gfp_mask
, wait
, roc
);
739 void nfs4_close_state(struct nfs4_state
*state
, fmode_t fmode
)
741 __nfs4_close(state
, fmode
, GFP_NOFS
, 0);
744 void nfs4_close_sync(struct nfs4_state
*state
, fmode_t fmode
)
746 __nfs4_close(state
, fmode
, GFP_KERNEL
, 1);
750 * Search the state->lock_states for an existing lock_owner
751 * that is compatible with current->files
753 static struct nfs4_lock_state
*
754 __nfs4_find_lock_state(struct nfs4_state
*state
, fl_owner_t fl_owner
, pid_t fl_pid
, unsigned int type
)
756 struct nfs4_lock_state
*pos
;
757 list_for_each_entry(pos
, &state
->lock_states
, ls_locks
) {
758 if (type
!= NFS4_ANY_LOCK_TYPE
&& pos
->ls_owner
.lo_type
!= type
)
760 switch (pos
->ls_owner
.lo_type
) {
761 case NFS4_POSIX_LOCK_TYPE
:
762 if (pos
->ls_owner
.lo_u
.posix_owner
!= fl_owner
)
765 case NFS4_FLOCK_LOCK_TYPE
:
766 if (pos
->ls_owner
.lo_u
.flock_owner
!= fl_pid
)
769 atomic_inc(&pos
->ls_count
);
776 * Return a compatible lock_state. If no initialized lock_state structure
777 * exists, return an uninitialized one.
780 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
)
782 struct nfs4_lock_state
*lsp
;
783 struct nfs_server
*server
= state
->owner
->so_server
;
785 lsp
= kzalloc(sizeof(*lsp
), GFP_NOFS
);
788 nfs4_init_seqid_counter(&lsp
->ls_seqid
);
789 atomic_set(&lsp
->ls_count
, 1);
790 lsp
->ls_state
= state
;
791 lsp
->ls_owner
.lo_type
= type
;
792 switch (lsp
->ls_owner
.lo_type
) {
793 case NFS4_FLOCK_LOCK_TYPE
:
794 lsp
->ls_owner
.lo_u
.flock_owner
= fl_pid
;
796 case NFS4_POSIX_LOCK_TYPE
:
797 lsp
->ls_owner
.lo_u
.posix_owner
= fl_owner
;
802 lsp
->ls_seqid
.owner_id
= ida_simple_get(&server
->lockowner_id
, 0, 0, GFP_NOFS
);
803 if (lsp
->ls_seqid
.owner_id
< 0)
805 INIT_LIST_HEAD(&lsp
->ls_locks
);
812 void nfs4_free_lock_state(struct nfs_server
*server
, struct nfs4_lock_state
*lsp
)
814 ida_simple_remove(&server
->lockowner_id
, lsp
->ls_seqid
.owner_id
);
815 nfs4_destroy_seqid_counter(&lsp
->ls_seqid
);
820 * Return a compatible lock_state. If no initialized lock_state structure
821 * exists, return an uninitialized one.
824 static struct nfs4_lock_state
*nfs4_get_lock_state(struct nfs4_state
*state
, fl_owner_t owner
, pid_t pid
, unsigned int type
)
826 struct nfs4_lock_state
*lsp
, *new = NULL
;
829 spin_lock(&state
->state_lock
);
830 lsp
= __nfs4_find_lock_state(state
, owner
, pid
, type
);
834 list_add(&new->ls_locks
, &state
->lock_states
);
835 set_bit(LK_STATE_IN_USE
, &state
->flags
);
840 spin_unlock(&state
->state_lock
);
841 new = nfs4_alloc_lock_state(state
, owner
, pid
, type
);
845 spin_unlock(&state
->state_lock
);
847 nfs4_free_lock_state(state
->owner
->so_server
, new);
852 * Release reference to lock_state, and free it if we see that
853 * it is no longer in use
855 void nfs4_put_lock_state(struct nfs4_lock_state
*lsp
)
857 struct nfs4_state
*state
;
861 state
= lsp
->ls_state
;
862 if (!atomic_dec_and_lock(&lsp
->ls_count
, &state
->state_lock
))
864 list_del(&lsp
->ls_locks
);
865 if (list_empty(&state
->lock_states
))
866 clear_bit(LK_STATE_IN_USE
, &state
->flags
);
867 spin_unlock(&state
->state_lock
);
868 if (lsp
->ls_flags
& NFS_LOCK_INITIALIZED
) {
869 if (nfs4_release_lockowner(lsp
) == 0)
872 nfs4_free_lock_state(lsp
->ls_state
->owner
->so_server
, lsp
);
875 static void nfs4_fl_copy_lock(struct file_lock
*dst
, struct file_lock
*src
)
877 struct nfs4_lock_state
*lsp
= src
->fl_u
.nfs4_fl
.owner
;
879 dst
->fl_u
.nfs4_fl
.owner
= lsp
;
880 atomic_inc(&lsp
->ls_count
);
883 static void nfs4_fl_release_lock(struct file_lock
*fl
)
885 nfs4_put_lock_state(fl
->fl_u
.nfs4_fl
.owner
);
888 static const struct file_lock_operations nfs4_fl_lock_ops
= {
889 .fl_copy_lock
= nfs4_fl_copy_lock
,
890 .fl_release_private
= nfs4_fl_release_lock
,
893 int nfs4_set_lock_state(struct nfs4_state
*state
, struct file_lock
*fl
)
895 struct nfs4_lock_state
*lsp
;
897 if (fl
->fl_ops
!= NULL
)
899 if (fl
->fl_flags
& FL_POSIX
)
900 lsp
= nfs4_get_lock_state(state
, fl
->fl_owner
, 0, NFS4_POSIX_LOCK_TYPE
);
901 else if (fl
->fl_flags
& FL_FLOCK
)
902 lsp
= nfs4_get_lock_state(state
, NULL
, fl
->fl_pid
,
903 NFS4_FLOCK_LOCK_TYPE
);
908 fl
->fl_u
.nfs4_fl
.owner
= lsp
;
909 fl
->fl_ops
= &nfs4_fl_lock_ops
;
913 static bool nfs4_copy_lock_stateid(nfs4_stateid
*dst
, struct nfs4_state
*state
,
914 fl_owner_t fl_owner
, pid_t fl_pid
)
916 struct nfs4_lock_state
*lsp
;
919 if (test_bit(LK_STATE_IN_USE
, &state
->flags
) == 0)
922 spin_lock(&state
->state_lock
);
923 lsp
= __nfs4_find_lock_state(state
, fl_owner
, fl_pid
, NFS4_ANY_LOCK_TYPE
);
924 if (lsp
!= NULL
&& (lsp
->ls_flags
& NFS_LOCK_INITIALIZED
) != 0) {
925 nfs4_stateid_copy(dst
, &lsp
->ls_stateid
);
928 spin_unlock(&state
->state_lock
);
929 nfs4_put_lock_state(lsp
);
934 static void nfs4_copy_open_stateid(nfs4_stateid
*dst
, struct nfs4_state
*state
)
939 seq
= read_seqbegin(&state
->seqlock
);
940 nfs4_stateid_copy(dst
, &state
->stateid
);
941 } while (read_seqretry(&state
->seqlock
, seq
));
945 * Byte-range lock aware utility to initialize the stateid of read/write
948 void nfs4_select_rw_stateid(nfs4_stateid
*dst
, struct nfs4_state
*state
,
949 fmode_t fmode
, fl_owner_t fl_owner
, pid_t fl_pid
)
951 if (nfs4_copy_delegation_stateid(dst
, state
->inode
, fmode
))
953 if (nfs4_copy_lock_stateid(dst
, state
, fl_owner
, fl_pid
))
955 nfs4_copy_open_stateid(dst
, state
);
958 struct nfs_seqid
*nfs_alloc_seqid(struct nfs_seqid_counter
*counter
, gfp_t gfp_mask
)
960 struct nfs_seqid
*new;
962 new = kmalloc(sizeof(*new), gfp_mask
);
964 new->sequence
= counter
;
965 INIT_LIST_HEAD(&new->list
);
971 void nfs_release_seqid(struct nfs_seqid
*seqid
)
973 struct nfs_seqid_counter
*sequence
;
975 if (list_empty(&seqid
->list
))
977 sequence
= seqid
->sequence
;
978 spin_lock(&sequence
->lock
);
979 list_del_init(&seqid
->list
);
980 if (!list_empty(&sequence
->list
)) {
981 struct nfs_seqid
*next
;
983 next
= list_first_entry(&sequence
->list
,
984 struct nfs_seqid
, list
);
985 rpc_wake_up_queued_task(&sequence
->wait
, next
->task
);
987 spin_unlock(&sequence
->lock
);
990 void nfs_free_seqid(struct nfs_seqid
*seqid
)
992 nfs_release_seqid(seqid
);
997 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
998 * failed with a seqid incrementing error -
999 * see comments nfs_fs.h:seqid_mutating_error()
1001 static void nfs_increment_seqid(int status
, struct nfs_seqid
*seqid
)
1003 BUG_ON(list_first_entry(&seqid
->sequence
->list
, struct nfs_seqid
, list
) != seqid
);
1007 case -NFS4ERR_BAD_SEQID
:
1008 if (seqid
->sequence
->flags
& NFS_SEQID_CONFIRMED
)
1010 pr_warn_ratelimited("NFS: v4 server returned a bad"
1011 " sequence-id error on an"
1012 " unconfirmed sequence %p!\n",
1014 case -NFS4ERR_STALE_CLIENTID
:
1015 case -NFS4ERR_STALE_STATEID
:
1016 case -NFS4ERR_BAD_STATEID
:
1017 case -NFS4ERR_BADXDR
:
1018 case -NFS4ERR_RESOURCE
:
1019 case -NFS4ERR_NOFILEHANDLE
:
1020 /* Non-seqid mutating errors */
1024 * Note: no locking needed as we are guaranteed to be first
1025 * on the sequence list
1027 seqid
->sequence
->counter
++;
1030 void nfs_increment_open_seqid(int status
, struct nfs_seqid
*seqid
)
1032 struct nfs4_state_owner
*sp
= container_of(seqid
->sequence
,
1033 struct nfs4_state_owner
, so_seqid
);
1034 struct nfs_server
*server
= sp
->so_server
;
1036 if (status
== -NFS4ERR_BAD_SEQID
)
1037 nfs4_drop_state_owner(sp
);
1038 if (!nfs4_has_session(server
->nfs_client
))
1039 nfs_increment_seqid(status
, seqid
);
1043 * Increment the seqid if the LOCK/LOCKU succeeded, or
1044 * failed with a seqid incrementing error -
1045 * see comments nfs_fs.h:seqid_mutating_error()
1047 void nfs_increment_lock_seqid(int status
, struct nfs_seqid
*seqid
)
1049 nfs_increment_seqid(status
, seqid
);
1052 int nfs_wait_on_sequence(struct nfs_seqid
*seqid
, struct rpc_task
*task
)
1054 struct nfs_seqid_counter
*sequence
= seqid
->sequence
;
1057 spin_lock(&sequence
->lock
);
1059 if (list_empty(&seqid
->list
))
1060 list_add_tail(&seqid
->list
, &sequence
->list
);
1061 if (list_first_entry(&sequence
->list
, struct nfs_seqid
, list
) == seqid
)
1063 rpc_sleep_on(&sequence
->wait
, task
, NULL
);
1066 spin_unlock(&sequence
->lock
);
1070 static int nfs4_run_state_manager(void *);
1072 static void nfs4_clear_state_manager_bit(struct nfs_client
*clp
)
1074 smp_mb__before_clear_bit();
1075 clear_bit(NFS4CLNT_MANAGER_RUNNING
, &clp
->cl_state
);
1076 smp_mb__after_clear_bit();
1077 wake_up_bit(&clp
->cl_state
, NFS4CLNT_MANAGER_RUNNING
);
1078 rpc_wake_up(&clp
->cl_rpcwaitq
);
1082 * Schedule the nfs_client asynchronous state management routine
1084 void nfs4_schedule_state_manager(struct nfs_client
*clp
)
1086 struct task_struct
*task
;
1087 char buf
[INET6_ADDRSTRLEN
+ sizeof("-manager") + 1];
1089 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING
, &clp
->cl_state
) != 0)
1091 __module_get(THIS_MODULE
);
1092 atomic_inc(&clp
->cl_count
);
1094 /* The rcu_read_lock() is not strictly necessary, as the state
1095 * manager is the only thread that ever changes the rpc_xprt
1096 * after it's initialized. At this point, we're single threaded. */
1098 snprintf(buf
, sizeof(buf
), "%s-manager",
1099 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_ADDR
));
1101 task
= kthread_run(nfs4_run_state_manager
, clp
, buf
);
1103 printk(KERN_ERR
"%s: kthread_run: %ld\n",
1104 __func__
, PTR_ERR(task
));
1105 nfs4_clear_state_manager_bit(clp
);
1106 nfs_put_client(clp
);
1107 module_put(THIS_MODULE
);
1112 * Schedule a lease recovery attempt
1114 void nfs4_schedule_lease_recovery(struct nfs_client
*clp
)
1118 if (!test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
))
1119 set_bit(NFS4CLNT_CHECK_LEASE
, &clp
->cl_state
);
1120 dprintk("%s: scheduling lease recovery for server %s\n", __func__
,
1122 nfs4_schedule_state_manager(clp
);
1124 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_recovery
);
1127 * nfs40_handle_cb_pathdown - return all delegations after NFS4ERR_CB_PATH_DOWN
1128 * @clp: client to process
1130 * Set the NFS4CLNT_LEASE_EXPIRED state in order to force a
1131 * resend of the SETCLIENTID and hence re-establish the
1132 * callback channel. Then return all existing delegations.
1134 static void nfs40_handle_cb_pathdown(struct nfs_client
*clp
)
1136 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1137 nfs_expire_all_delegations(clp
);
1138 dprintk("%s: handling CB_PATHDOWN recovery for server %s\n", __func__
,
1142 void nfs4_schedule_path_down_recovery(struct nfs_client
*clp
)
1144 nfs40_handle_cb_pathdown(clp
);
1145 nfs4_schedule_state_manager(clp
);
1148 static int nfs4_state_mark_reclaim_reboot(struct nfs_client
*clp
, struct nfs4_state
*state
)
1151 set_bit(NFS_STATE_RECLAIM_REBOOT
, &state
->flags
);
1152 /* Don't recover state that expired before the reboot */
1153 if (test_bit(NFS_STATE_RECLAIM_NOGRACE
, &state
->flags
)) {
1154 clear_bit(NFS_STATE_RECLAIM_REBOOT
, &state
->flags
);
1157 set_bit(NFS_OWNER_RECLAIM_REBOOT
, &state
->owner
->so_flags
);
1158 set_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
);
1162 static int nfs4_state_mark_reclaim_nograce(struct nfs_client
*clp
, struct nfs4_state
*state
)
1164 set_bit(NFS_STATE_RECLAIM_NOGRACE
, &state
->flags
);
1165 clear_bit(NFS_STATE_RECLAIM_REBOOT
, &state
->flags
);
1166 set_bit(NFS_OWNER_RECLAIM_NOGRACE
, &state
->owner
->so_flags
);
1167 set_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
);
1171 void nfs4_schedule_stateid_recovery(const struct nfs_server
*server
, struct nfs4_state
*state
)
1173 struct nfs_client
*clp
= server
->nfs_client
;
1175 nfs4_state_mark_reclaim_nograce(clp
, state
);
1176 dprintk("%s: scheduling stateid recovery for server %s\n", __func__
,
1178 nfs4_schedule_state_manager(clp
);
1180 EXPORT_SYMBOL_GPL(nfs4_schedule_stateid_recovery
);
1182 void nfs_inode_find_state_and_recover(struct inode
*inode
,
1183 const nfs4_stateid
*stateid
)
1185 struct nfs_client
*clp
= NFS_SERVER(inode
)->nfs_client
;
1186 struct nfs_inode
*nfsi
= NFS_I(inode
);
1187 struct nfs_open_context
*ctx
;
1188 struct nfs4_state
*state
;
1191 spin_lock(&inode
->i_lock
);
1192 list_for_each_entry(ctx
, &nfsi
->open_files
, list
) {
1196 if (!test_bit(NFS_DELEGATED_STATE
, &state
->flags
))
1198 if (!nfs4_stateid_match(&state
->stateid
, stateid
))
1200 nfs4_state_mark_reclaim_nograce(clp
, state
);
1203 spin_unlock(&inode
->i_lock
);
1205 nfs4_schedule_state_manager(clp
);
1209 static int nfs4_reclaim_locks(struct nfs4_state
*state
, const struct nfs4_state_recovery_ops
*ops
)
1211 struct inode
*inode
= state
->inode
;
1212 struct nfs_inode
*nfsi
= NFS_I(inode
);
1213 struct file_lock
*fl
;
1216 if (inode
->i_flock
== NULL
)
1219 /* Guard against delegation returns and new lock/unlock calls */
1220 down_write(&nfsi
->rwsem
);
1221 /* Protect inode->i_flock using the BKL */
1223 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
1224 if (!(fl
->fl_flags
& (FL_POSIX
|FL_FLOCK
)))
1226 if (nfs_file_open_context(fl
->fl_file
)->state
!= state
)
1229 status
= ops
->recover_lock(state
, fl
);
1234 case -NFS4ERR_ADMIN_REVOKED
:
1235 case -NFS4ERR_STALE_STATEID
:
1236 case -NFS4ERR_BAD_STATEID
:
1237 case -NFS4ERR_EXPIRED
:
1238 case -NFS4ERR_NO_GRACE
:
1239 case -NFS4ERR_STALE_CLIENTID
:
1240 case -NFS4ERR_BADSESSION
:
1241 case -NFS4ERR_BADSLOT
:
1242 case -NFS4ERR_BAD_HIGH_SLOT
:
1243 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION
:
1246 printk(KERN_ERR
"NFS: %s: unhandled error %d. "
1247 "Zeroing state\n", __func__
, status
);
1249 case -NFS4ERR_DENIED
:
1250 case -NFS4ERR_RECLAIM_BAD
:
1251 case -NFS4ERR_RECLAIM_CONFLICT
:
1252 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
1259 up_write(&nfsi
->rwsem
);
1263 static int nfs4_reclaim_open_state(struct nfs4_state_owner
*sp
, const struct nfs4_state_recovery_ops
*ops
)
1265 struct nfs4_state
*state
;
1266 struct nfs4_lock_state
*lock
;
1269 /* Note: we rely on the sp->so_states list being ordered
1270 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
1272 * This is needed to ensure that the server won't give us any
1273 * read delegations that we have to return if, say, we are
1274 * recovering after a network partition or a reboot from a
1275 * server that doesn't support a grace period.
1278 spin_lock(&sp
->so_lock
);
1279 list_for_each_entry(state
, &sp
->so_states
, open_states
) {
1280 if (!test_and_clear_bit(ops
->state_flag_bit
, &state
->flags
))
1282 if (state
->state
== 0)
1284 atomic_inc(&state
->count
);
1285 spin_unlock(&sp
->so_lock
);
1286 status
= ops
->recover_open(sp
, state
);
1288 status
= nfs4_reclaim_locks(state
, ops
);
1290 spin_lock(&state
->state_lock
);
1291 list_for_each_entry(lock
, &state
->lock_states
, ls_locks
) {
1292 if (!(lock
->ls_flags
& NFS_LOCK_INITIALIZED
))
1293 pr_warn_ratelimited("NFS: "
1295 "failed!\n", __func__
);
1297 spin_unlock(&state
->state_lock
);
1298 nfs4_put_open_state(state
);
1304 printk(KERN_ERR
"NFS: %s: unhandled error %d. "
1305 "Zeroing state\n", __func__
, status
);
1310 * Open state on this file cannot be recovered
1311 * All we can do is revert to using the zero stateid.
1313 memset(&state
->stateid
, 0,
1314 sizeof(state
->stateid
));
1315 /* Mark the file as being 'closed' */
1320 * User RPCSEC_GSS context has expired.
1321 * We cannot recover this stateid now, so
1322 * skip it and allow recovery thread to
1326 case -NFS4ERR_ADMIN_REVOKED
:
1327 case -NFS4ERR_STALE_STATEID
:
1328 case -NFS4ERR_BAD_STATEID
:
1329 case -NFS4ERR_RECLAIM_BAD
:
1330 case -NFS4ERR_RECLAIM_CONFLICT
:
1331 nfs4_state_mark_reclaim_nograce(sp
->so_server
->nfs_client
, state
);
1333 case -NFS4ERR_EXPIRED
:
1334 case -NFS4ERR_NO_GRACE
:
1335 nfs4_state_mark_reclaim_nograce(sp
->so_server
->nfs_client
, state
);
1336 case -NFS4ERR_STALE_CLIENTID
:
1337 case -NFS4ERR_BADSESSION
:
1338 case -NFS4ERR_BADSLOT
:
1339 case -NFS4ERR_BAD_HIGH_SLOT
:
1340 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION
:
1343 nfs4_put_open_state(state
);
1346 spin_unlock(&sp
->so_lock
);
1349 nfs4_put_open_state(state
);
1353 static void nfs4_clear_open_state(struct nfs4_state
*state
)
1355 struct nfs4_lock_state
*lock
;
1357 clear_bit(NFS_DELEGATED_STATE
, &state
->flags
);
1358 clear_bit(NFS_O_RDONLY_STATE
, &state
->flags
);
1359 clear_bit(NFS_O_WRONLY_STATE
, &state
->flags
);
1360 clear_bit(NFS_O_RDWR_STATE
, &state
->flags
);
1361 spin_lock(&state
->state_lock
);
1362 list_for_each_entry(lock
, &state
->lock_states
, ls_locks
) {
1363 lock
->ls_seqid
.flags
= 0;
1364 lock
->ls_flags
&= ~NFS_LOCK_INITIALIZED
;
1366 spin_unlock(&state
->state_lock
);
1369 static void nfs4_reset_seqids(struct nfs_server
*server
,
1370 int (*mark_reclaim
)(struct nfs_client
*clp
, struct nfs4_state
*state
))
1372 struct nfs_client
*clp
= server
->nfs_client
;
1373 struct nfs4_state_owner
*sp
;
1374 struct rb_node
*pos
;
1375 struct nfs4_state
*state
;
1377 spin_lock(&clp
->cl_lock
);
1378 for (pos
= rb_first(&server
->state_owners
);
1380 pos
= rb_next(pos
)) {
1381 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_server_node
);
1382 sp
->so_seqid
.flags
= 0;
1383 spin_lock(&sp
->so_lock
);
1384 list_for_each_entry(state
, &sp
->so_states
, open_states
) {
1385 if (mark_reclaim(clp
, state
))
1386 nfs4_clear_open_state(state
);
1388 spin_unlock(&sp
->so_lock
);
1390 spin_unlock(&clp
->cl_lock
);
1393 static void nfs4_state_mark_reclaim_helper(struct nfs_client
*clp
,
1394 int (*mark_reclaim
)(struct nfs_client
*clp
, struct nfs4_state
*state
))
1396 struct nfs_server
*server
;
1399 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
)
1400 nfs4_reset_seqids(server
, mark_reclaim
);
1404 static void nfs4_state_start_reclaim_reboot(struct nfs_client
*clp
)
1406 /* Mark all delegations for reclaim */
1407 nfs_delegation_mark_reclaim(clp
);
1408 nfs4_state_mark_reclaim_helper(clp
, nfs4_state_mark_reclaim_reboot
);
1411 static void nfs4_reclaim_complete(struct nfs_client
*clp
,
1412 const struct nfs4_state_recovery_ops
*ops
)
1414 /* Notify the server we're done reclaiming our state */
1415 if (ops
->reclaim_complete
)
1416 (void)ops
->reclaim_complete(clp
);
1419 static void nfs4_clear_reclaim_server(struct nfs_server
*server
)
1421 struct nfs_client
*clp
= server
->nfs_client
;
1422 struct nfs4_state_owner
*sp
;
1423 struct rb_node
*pos
;
1424 struct nfs4_state
*state
;
1426 spin_lock(&clp
->cl_lock
);
1427 for (pos
= rb_first(&server
->state_owners
);
1429 pos
= rb_next(pos
)) {
1430 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_server_node
);
1431 spin_lock(&sp
->so_lock
);
1432 list_for_each_entry(state
, &sp
->so_states
, open_states
) {
1433 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT
,
1436 nfs4_state_mark_reclaim_nograce(clp
, state
);
1438 spin_unlock(&sp
->so_lock
);
1440 spin_unlock(&clp
->cl_lock
);
1443 static int nfs4_state_clear_reclaim_reboot(struct nfs_client
*clp
)
1445 struct nfs_server
*server
;
1447 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
))
1451 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
)
1452 nfs4_clear_reclaim_server(server
);
1455 nfs_delegation_reap_unclaimed(clp
);
1459 static void nfs4_state_end_reclaim_reboot(struct nfs_client
*clp
)
1461 if (!nfs4_state_clear_reclaim_reboot(clp
))
1463 nfs4_reclaim_complete(clp
, clp
->cl_mvops
->reboot_recovery_ops
);
1466 static void nfs_delegation_clear_all(struct nfs_client
*clp
)
1468 nfs_delegation_mark_reclaim(clp
);
1469 nfs_delegation_reap_unclaimed(clp
);
1472 static void nfs4_state_start_reclaim_nograce(struct nfs_client
*clp
)
1474 nfs_delegation_clear_all(clp
);
1475 nfs4_state_mark_reclaim_helper(clp
, nfs4_state_mark_reclaim_nograce
);
1478 static void nfs4_warn_keyexpired(const char *s
)
1480 printk_ratelimited(KERN_WARNING
"Error: state manager"
1481 " encountered RPCSEC_GSS session"
1482 " expired against NFSv4 server %s.\n",
1486 static int nfs4_recovery_handle_error(struct nfs_client
*clp
, int error
)
1491 case -NFS4ERR_CB_PATH_DOWN
:
1492 nfs40_handle_cb_pathdown(clp
);
1494 case -NFS4ERR_NO_GRACE
:
1495 nfs4_state_end_reclaim_reboot(clp
);
1497 case -NFS4ERR_STALE_CLIENTID
:
1498 case -NFS4ERR_LEASE_MOVED
:
1499 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1500 nfs4_state_clear_reclaim_reboot(clp
);
1501 nfs4_state_start_reclaim_reboot(clp
);
1503 case -NFS4ERR_EXPIRED
:
1504 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1505 nfs4_state_start_reclaim_nograce(clp
);
1507 case -NFS4ERR_BADSESSION
:
1508 case -NFS4ERR_BADSLOT
:
1509 case -NFS4ERR_BAD_HIGH_SLOT
:
1510 case -NFS4ERR_DEADSESSION
:
1511 case -NFS4ERR_SEQ_FALSE_RETRY
:
1512 case -NFS4ERR_SEQ_MISORDERED
:
1513 set_bit(NFS4CLNT_SESSION_RESET
, &clp
->cl_state
);
1514 /* Zero session reset errors */
1516 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION
:
1517 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION
, &clp
->cl_state
);
1520 /* Nothing we can do */
1521 nfs4_warn_keyexpired(clp
->cl_hostname
);
1524 dprintk("%s: failed to handle error %d for server %s\n",
1525 __func__
, error
, clp
->cl_hostname
);
1528 dprintk("%s: handled error %d for server %s\n", __func__
, error
,
1533 static int nfs4_do_reclaim(struct nfs_client
*clp
, const struct nfs4_state_recovery_ops
*ops
)
1535 struct nfs4_state_owner
*sp
;
1536 struct nfs_server
*server
;
1537 struct rb_node
*pos
;
1542 list_for_each_entry_rcu(server
, &clp
->cl_superblocks
, client_link
) {
1543 nfs4_purge_state_owners(server
);
1544 spin_lock(&clp
->cl_lock
);
1545 for (pos
= rb_first(&server
->state_owners
);
1547 pos
= rb_next(pos
)) {
1549 struct nfs4_state_owner
, so_server_node
);
1550 if (!test_and_clear_bit(ops
->owner_flag_bit
,
1553 atomic_inc(&sp
->so_count
);
1554 spin_unlock(&clp
->cl_lock
);
1557 status
= nfs4_reclaim_open_state(sp
, ops
);
1559 set_bit(ops
->owner_flag_bit
, &sp
->so_flags
);
1560 nfs4_put_state_owner(sp
);
1561 return nfs4_recovery_handle_error(clp
, status
);
1564 nfs4_put_state_owner(sp
);
1567 spin_unlock(&clp
->cl_lock
);
1573 static int nfs4_check_lease(struct nfs_client
*clp
)
1575 struct rpc_cred
*cred
;
1576 const struct nfs4_state_maintenance_ops
*ops
=
1577 clp
->cl_mvops
->state_renewal_ops
;
1580 /* Is the client already known to have an expired lease? */
1581 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
))
1583 spin_lock(&clp
->cl_lock
);
1584 cred
= ops
->get_state_renewal_cred_locked(clp
);
1585 spin_unlock(&clp
->cl_lock
);
1587 cred
= nfs4_get_setclientid_cred(clp
);
1592 status
= ops
->renew_lease(clp
, cred
);
1595 return nfs4_recovery_handle_error(clp
, status
);
1598 /* Set NFS4CLNT_LEASE_EXPIRED for all v4.0 errors and for recoverable errors
1599 * on EXCHANGE_ID for v4.1
1601 static int nfs4_handle_reclaim_lease_error(struct nfs_client
*clp
, int status
)
1604 case -NFS4ERR_SEQ_MISORDERED
:
1605 if (test_and_set_bit(NFS4CLNT_PURGE_STATE
, &clp
->cl_state
))
1606 return -ESERVERFAULT
;
1607 /* Lease confirmation error: retry after purging the lease */
1609 case -NFS4ERR_STALE_CLIENTID
:
1610 clear_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
);
1612 case -NFS4ERR_CLID_INUSE
:
1613 pr_err("NFS: Server %s reports our clientid is in use\n",
1615 nfs_mark_client_ready(clp
, -EPERM
);
1616 clear_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
);
1619 if (clp
->cl_machine_cred
== NULL
)
1621 /* Handle case where the user hasn't set up machine creds */
1622 nfs4_clear_machine_cred(clp
);
1623 case -NFS4ERR_DELAY
:
1629 case -NFS4ERR_MINOR_VERS_MISMATCH
:
1630 if (clp
->cl_cons_state
== NFS_CS_SESSION_INITING
)
1631 nfs_mark_client_ready(clp
, -EPROTONOSUPPORT
);
1632 dprintk("%s: exit with error %d for server %s\n",
1633 __func__
, -EPROTONOSUPPORT
, clp
->cl_hostname
);
1634 return -EPROTONOSUPPORT
;
1636 nfs4_warn_keyexpired(clp
->cl_hostname
);
1637 case -NFS4ERR_NOT_SAME
: /* FixMe: implement recovery
1638 * in nfs4_exchange_id */
1640 dprintk("%s: exit with error %d for server %s\n", __func__
,
1641 status
, clp
->cl_hostname
);
1644 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1645 dprintk("%s: handled error %d for server %s\n", __func__
, status
,
1650 static int nfs4_establish_lease(struct nfs_client
*clp
)
1652 struct rpc_cred
*cred
;
1653 const struct nfs4_state_recovery_ops
*ops
=
1654 clp
->cl_mvops
->reboot_recovery_ops
;
1657 cred
= ops
->get_clid_cred(clp
);
1660 status
= ops
->establish_clid(clp
, cred
);
1664 pnfs_destroy_all_layouts(clp
);
1669 * Returns zero or a negative errno. NFS4ERR values are converted
1670 * to local errno values.
1672 static int nfs4_reclaim_lease(struct nfs_client
*clp
)
1676 status
= nfs4_establish_lease(clp
);
1678 return nfs4_handle_reclaim_lease_error(clp
, status
);
1679 if (test_and_clear_bit(NFS4CLNT_SERVER_SCOPE_MISMATCH
, &clp
->cl_state
))
1680 nfs4_state_start_reclaim_nograce(clp
);
1681 if (!test_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
))
1682 set_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
);
1683 clear_bit(NFS4CLNT_CHECK_LEASE
, &clp
->cl_state
);
1684 clear_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1688 static int nfs4_purge_lease(struct nfs_client
*clp
)
1692 status
= nfs4_establish_lease(clp
);
1694 return nfs4_handle_reclaim_lease_error(clp
, status
);
1695 clear_bit(NFS4CLNT_PURGE_STATE
, &clp
->cl_state
);
1696 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1697 nfs4_state_start_reclaim_nograce(clp
);
1701 #ifdef CONFIG_NFS_V4_1
1702 void nfs4_schedule_session_recovery(struct nfs4_session
*session
, int err
)
1704 struct nfs_client
*clp
= session
->clp
;
1708 set_bit(NFS4CLNT_SESSION_RESET
, &clp
->cl_state
);
1710 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION
:
1711 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION
, &clp
->cl_state
);
1713 nfs4_schedule_lease_recovery(clp
);
1715 EXPORT_SYMBOL_GPL(nfs4_schedule_session_recovery
);
1717 void nfs41_handle_recall_slot(struct nfs_client
*clp
)
1719 set_bit(NFS4CLNT_RECALL_SLOT
, &clp
->cl_state
);
1720 dprintk("%s: scheduling slot recall for server %s\n", __func__
,
1722 nfs4_schedule_state_manager(clp
);
1725 static void nfs4_reset_all_state(struct nfs_client
*clp
)
1727 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
) == 0) {
1728 set_bit(NFS4CLNT_PURGE_STATE
, &clp
->cl_state
);
1729 clear_bit(NFS4CLNT_LEASE_CONFIRM
, &clp
->cl_state
);
1730 nfs4_state_start_reclaim_nograce(clp
);
1731 dprintk("%s: scheduling reset of all state for server %s!\n",
1732 __func__
, clp
->cl_hostname
);
1733 nfs4_schedule_state_manager(clp
);
1737 static void nfs41_handle_server_reboot(struct nfs_client
*clp
)
1739 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
) == 0) {
1740 nfs4_state_start_reclaim_reboot(clp
);
1741 dprintk("%s: server %s rebooted!\n", __func__
,
1743 nfs4_schedule_state_manager(clp
);
1747 static void nfs41_handle_state_revoked(struct nfs_client
*clp
)
1749 nfs4_reset_all_state(clp
);
1750 dprintk("%s: state revoked on server %s\n", __func__
, clp
->cl_hostname
);
1753 static void nfs41_handle_recallable_state_revoked(struct nfs_client
*clp
)
1755 /* This will need to handle layouts too */
1756 nfs_expire_all_delegations(clp
);
1757 dprintk("%s: Recallable state revoked on server %s!\n", __func__
,
1761 static void nfs41_handle_backchannel_fault(struct nfs_client
*clp
)
1763 nfs_expire_all_delegations(clp
);
1764 if (test_and_set_bit(NFS4CLNT_SESSION_RESET
, &clp
->cl_state
) == 0)
1765 nfs4_schedule_state_manager(clp
);
1766 dprintk("%s: server %s declared a backchannel fault\n", __func__
,
1770 static void nfs41_handle_cb_path_down(struct nfs_client
*clp
)
1772 if (test_and_set_bit(NFS4CLNT_BIND_CONN_TO_SESSION
,
1773 &clp
->cl_state
) == 0)
1774 nfs4_schedule_state_manager(clp
);
1777 void nfs41_handle_sequence_flag_errors(struct nfs_client
*clp
, u32 flags
)
1782 dprintk("%s: \"%s\" (client ID %llx) flags=0x%08x\n",
1783 __func__
, clp
->cl_hostname
, clp
->cl_clientid
, flags
);
1785 if (flags
& SEQ4_STATUS_RESTART_RECLAIM_NEEDED
)
1786 nfs41_handle_server_reboot(clp
);
1787 if (flags
& (SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED
|
1788 SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED
|
1789 SEQ4_STATUS_ADMIN_STATE_REVOKED
|
1790 SEQ4_STATUS_LEASE_MOVED
))
1791 nfs41_handle_state_revoked(clp
);
1792 if (flags
& SEQ4_STATUS_RECALLABLE_STATE_REVOKED
)
1793 nfs41_handle_recallable_state_revoked(clp
);
1794 if (flags
& SEQ4_STATUS_BACKCHANNEL_FAULT
)
1795 nfs41_handle_backchannel_fault(clp
);
1796 else if (flags
& (SEQ4_STATUS_CB_PATH_DOWN
|
1797 SEQ4_STATUS_CB_PATH_DOWN_SESSION
))
1798 nfs41_handle_cb_path_down(clp
);
1801 static int nfs4_reset_session(struct nfs_client
*clp
)
1803 struct rpc_cred
*cred
;
1806 if (!nfs4_has_session(clp
))
1808 nfs4_begin_drain_session(clp
);
1809 cred
= nfs4_get_exchange_id_cred(clp
);
1810 status
= nfs4_proc_destroy_session(clp
->cl_session
, cred
);
1811 if (status
&& status
!= -NFS4ERR_BADSESSION
&&
1812 status
!= -NFS4ERR_DEADSESSION
) {
1813 status
= nfs4_recovery_handle_error(clp
, status
);
1817 memset(clp
->cl_session
->sess_id
.data
, 0, NFS4_MAX_SESSIONID_LEN
);
1818 status
= nfs4_proc_create_session(clp
, cred
);
1820 dprintk("%s: session reset failed with status %d for server %s!\n",
1821 __func__
, status
, clp
->cl_hostname
);
1822 status
= nfs4_handle_reclaim_lease_error(clp
, status
);
1825 nfs41_finish_session_reset(clp
);
1826 dprintk("%s: session reset was successful for server %s!\n",
1827 __func__
, clp
->cl_hostname
);
1834 static int nfs4_recall_slot(struct nfs_client
*clp
)
1836 struct nfs4_slot_table
*fc_tbl
;
1837 struct nfs4_slot
*new, *old
;
1840 if (!nfs4_has_session(clp
))
1842 nfs4_begin_drain_session(clp
);
1843 fc_tbl
= &clp
->cl_session
->fc_slot_table
;
1844 new = kmalloc(fc_tbl
->target_max_slots
* sizeof(struct nfs4_slot
),
1849 spin_lock(&fc_tbl
->slot_tbl_lock
);
1850 for (i
= 0; i
< fc_tbl
->target_max_slots
; i
++)
1851 new[i
].seq_nr
= fc_tbl
->slots
[i
].seq_nr
;
1852 old
= fc_tbl
->slots
;
1853 fc_tbl
->slots
= new;
1854 fc_tbl
->max_slots
= fc_tbl
->target_max_slots
;
1855 fc_tbl
->target_max_slots
= 0;
1856 clp
->cl_session
->fc_attrs
.max_reqs
= fc_tbl
->max_slots
;
1857 spin_unlock(&fc_tbl
->slot_tbl_lock
);
1863 static int nfs4_bind_conn_to_session(struct nfs_client
*clp
)
1865 struct rpc_cred
*cred
;
1868 if (!nfs4_has_session(clp
))
1870 nfs4_begin_drain_session(clp
);
1871 cred
= nfs4_get_exchange_id_cred(clp
);
1872 ret
= nfs4_proc_bind_conn_to_session(clp
, cred
);
1875 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION
, &clp
->cl_state
);
1878 dprintk("%s: bind_conn_to_session was successful for server %s!\n",
1879 __func__
, clp
->cl_hostname
);
1881 case -NFS4ERR_DELAY
:
1883 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION
, &clp
->cl_state
);
1886 return nfs4_recovery_handle_error(clp
, ret
);
1890 #else /* CONFIG_NFS_V4_1 */
1891 static int nfs4_reset_session(struct nfs_client
*clp
) { return 0; }
1892 static int nfs4_end_drain_session(struct nfs_client
*clp
) { return 0; }
1893 static int nfs4_recall_slot(struct nfs_client
*clp
) { return 0; }
1895 static int nfs4_bind_conn_to_session(struct nfs_client
*clp
)
1899 #endif /* CONFIG_NFS_V4_1 */
1901 static void nfs4_state_manager(struct nfs_client
*clp
)
1904 const char *section
= "", *section_sep
= "";
1906 /* Ensure exclusive access to NFSv4 state */
1908 if (test_bit(NFS4CLNT_PURGE_STATE
, &clp
->cl_state
)) {
1909 section
= "purge state";
1910 status
= nfs4_purge_lease(clp
);
1916 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
)) {
1917 section
= "lease expired";
1918 /* We're going to have to re-establish a clientid */
1919 status
= nfs4_reclaim_lease(clp
);
1925 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE
, &clp
->cl_state
)) {
1926 section
= "check lease";
1927 status
= nfs4_check_lease(clp
);
1930 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
))
1934 /* Initialize or reset the session */
1935 if (test_and_clear_bit(NFS4CLNT_SESSION_RESET
, &clp
->cl_state
)) {
1936 section
= "reset session";
1937 status
= nfs4_reset_session(clp
);
1938 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
))
1944 /* Send BIND_CONN_TO_SESSION */
1945 if (test_and_clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION
,
1947 section
= "bind conn to session";
1948 status
= nfs4_bind_conn_to_session(clp
);
1954 /* Recall session slots */
1955 if (test_and_clear_bit(NFS4CLNT_RECALL_SLOT
, &clp
->cl_state
)) {
1956 section
= "recall slot";
1957 status
= nfs4_recall_slot(clp
);
1963 /* First recover reboot state... */
1964 if (test_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
)) {
1965 section
= "reclaim reboot";
1966 status
= nfs4_do_reclaim(clp
,
1967 clp
->cl_mvops
->reboot_recovery_ops
);
1968 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
) ||
1969 test_bit(NFS4CLNT_SESSION_RESET
, &clp
->cl_state
))
1971 nfs4_state_end_reclaim_reboot(clp
);
1972 if (test_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
))
1978 /* Now recover expired state... */
1979 if (test_and_clear_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
)) {
1980 section
= "reclaim nograce";
1981 status
= nfs4_do_reclaim(clp
,
1982 clp
->cl_mvops
->nograce_recovery_ops
);
1983 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
) ||
1984 test_bit(NFS4CLNT_SESSION_RESET
, &clp
->cl_state
) ||
1985 test_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
))
1991 nfs4_end_drain_session(clp
);
1992 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN
, &clp
->cl_state
)) {
1993 nfs_client_return_marked_delegations(clp
);
1997 nfs4_clear_state_manager_bit(clp
);
1998 /* Did we race with an attempt to give us more work? */
1999 if (clp
->cl_state
== 0)
2001 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING
, &clp
->cl_state
) != 0)
2003 } while (atomic_read(&clp
->cl_count
) > 1);
2006 if (strlen(section
))
2008 pr_warn_ratelimited("NFS: state manager%s%s failed on NFSv4 server %s"
2009 " with error %d\n", section_sep
, section
,
2010 clp
->cl_hostname
, -status
);
2011 nfs4_end_drain_session(clp
);
2012 nfs4_clear_state_manager_bit(clp
);
2015 static int nfs4_run_state_manager(void *ptr
)
2017 struct nfs_client
*clp
= ptr
;
2019 allow_signal(SIGKILL
);
2020 nfs4_state_manager(clp
);
2021 nfs_put_client(clp
);
2022 module_put_and_exit(0);