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>
43 #include <linux/smp_lock.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/workqueue.h>
50 #include <linux/bitops.h>
54 #include "delegation.h"
57 #define OPENOWNER_POOL_SIZE 8
59 const nfs4_stateid zero_stateid
;
61 static LIST_HEAD(nfs4_clientid_list
);
63 static int nfs4_init_client(struct nfs_client
*clp
, struct rpc_cred
*cred
)
65 int status
= nfs4_proc_setclientid(clp
, NFS4_CALLBACK
,
66 nfs_callback_tcpport
, cred
);
68 status
= nfs4_proc_setclientid_confirm(clp
, cred
);
70 nfs4_schedule_state_renewal(clp
);
74 static struct rpc_cred
*nfs4_get_machine_cred_locked(struct nfs_client
*clp
)
76 struct rpc_cred
*cred
= NULL
;
78 if (clp
->cl_machine_cred
!= NULL
)
79 cred
= get_rpccred(clp
->cl_machine_cred
);
83 static void nfs4_clear_machine_cred(struct nfs_client
*clp
)
85 struct rpc_cred
*cred
;
87 spin_lock(&clp
->cl_lock
);
88 cred
= clp
->cl_machine_cred
;
89 clp
->cl_machine_cred
= NULL
;
90 spin_unlock(&clp
->cl_lock
);
95 struct rpc_cred
*nfs4_get_renew_cred_locked(struct nfs_client
*clp
)
97 struct nfs4_state_owner
*sp
;
99 struct rpc_cred
*cred
= NULL
;
101 for (pos
= rb_first(&clp
->cl_state_owners
); pos
!= NULL
; pos
= rb_next(pos
)) {
102 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_client_node
);
103 if (list_empty(&sp
->so_states
))
105 cred
= get_rpccred(sp
->so_cred
);
111 static struct rpc_cred
*nfs4_get_renew_cred(struct nfs_client
*clp
)
113 struct rpc_cred
*cred
;
115 spin_lock(&clp
->cl_lock
);
116 cred
= nfs4_get_renew_cred_locked(clp
);
117 spin_unlock(&clp
->cl_lock
);
121 static struct rpc_cred
*nfs4_get_setclientid_cred(struct nfs_client
*clp
)
123 struct nfs4_state_owner
*sp
;
125 struct rpc_cred
*cred
;
127 spin_lock(&clp
->cl_lock
);
128 cred
= nfs4_get_machine_cred_locked(clp
);
131 pos
= rb_first(&clp
->cl_state_owners
);
133 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_client_node
);
134 cred
= get_rpccred(sp
->so_cred
);
137 spin_unlock(&clp
->cl_lock
);
141 static void nfs_alloc_unique_id(struct rb_root
*root
, struct nfs_unique_id
*new,
142 __u64 minval
, int maxbits
)
144 struct rb_node
**p
, *parent
;
145 struct nfs_unique_id
*pos
;
149 mask
= (1ULL << maxbits
) - 1ULL;
151 /* Ensure distribution is more or less flat */
152 get_random_bytes(&new->id
, sizeof(new->id
));
154 if (new->id
< minval
)
162 pos
= rb_entry(parent
, struct nfs_unique_id
, rb_node
);
164 if (new->id
< pos
->id
)
166 else if (new->id
> pos
->id
)
171 rb_link_node(&new->rb_node
, parent
, p
);
172 rb_insert_color(&new->rb_node
, root
);
177 if (new->id
< minval
|| (new->id
& mask
) != new->id
) {
181 parent
= rb_next(parent
);
184 pos
= rb_entry(parent
, struct nfs_unique_id
, rb_node
);
185 if (new->id
< pos
->id
)
191 static void nfs_free_unique_id(struct rb_root
*root
, struct nfs_unique_id
*id
)
193 rb_erase(&id
->rb_node
, root
);
196 static struct nfs4_state_owner
*
197 nfs4_find_state_owner(struct nfs_server
*server
, struct rpc_cred
*cred
)
199 struct nfs_client
*clp
= server
->nfs_client
;
200 struct rb_node
**p
= &clp
->cl_state_owners
.rb_node
,
202 struct nfs4_state_owner
*sp
, *res
= NULL
;
206 sp
= rb_entry(parent
, struct nfs4_state_owner
, so_client_node
);
208 if (server
< sp
->so_server
) {
209 p
= &parent
->rb_left
;
212 if (server
> sp
->so_server
) {
213 p
= &parent
->rb_right
;
216 if (cred
< sp
->so_cred
)
217 p
= &parent
->rb_left
;
218 else if (cred
> sp
->so_cred
)
219 p
= &parent
->rb_right
;
221 atomic_inc(&sp
->so_count
);
229 static struct nfs4_state_owner
*
230 nfs4_insert_state_owner(struct nfs_client
*clp
, struct nfs4_state_owner
*new)
232 struct rb_node
**p
= &clp
->cl_state_owners
.rb_node
,
234 struct nfs4_state_owner
*sp
;
238 sp
= rb_entry(parent
, struct nfs4_state_owner
, so_client_node
);
240 if (new->so_server
< sp
->so_server
) {
241 p
= &parent
->rb_left
;
244 if (new->so_server
> sp
->so_server
) {
245 p
= &parent
->rb_right
;
248 if (new->so_cred
< sp
->so_cred
)
249 p
= &parent
->rb_left
;
250 else if (new->so_cred
> sp
->so_cred
)
251 p
= &parent
->rb_right
;
253 atomic_inc(&sp
->so_count
);
257 nfs_alloc_unique_id(&clp
->cl_openowner_id
, &new->so_owner_id
, 1, 64);
258 rb_link_node(&new->so_client_node
, parent
, p
);
259 rb_insert_color(&new->so_client_node
, &clp
->cl_state_owners
);
264 nfs4_remove_state_owner(struct nfs_client
*clp
, struct nfs4_state_owner
*sp
)
266 if (!RB_EMPTY_NODE(&sp
->so_client_node
))
267 rb_erase(&sp
->so_client_node
, &clp
->cl_state_owners
);
268 nfs_free_unique_id(&clp
->cl_openowner_id
, &sp
->so_owner_id
);
272 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
273 * create a new state_owner.
276 static struct nfs4_state_owner
*
277 nfs4_alloc_state_owner(void)
279 struct nfs4_state_owner
*sp
;
281 sp
= kzalloc(sizeof(*sp
),GFP_KERNEL
);
284 spin_lock_init(&sp
->so_lock
);
285 INIT_LIST_HEAD(&sp
->so_states
);
286 INIT_LIST_HEAD(&sp
->so_delegations
);
287 rpc_init_wait_queue(&sp
->so_sequence
.wait
, "Seqid_waitqueue");
288 sp
->so_seqid
.sequence
= &sp
->so_sequence
;
289 spin_lock_init(&sp
->so_sequence
.lock
);
290 INIT_LIST_HEAD(&sp
->so_sequence
.list
);
291 atomic_set(&sp
->so_count
, 1);
296 nfs4_drop_state_owner(struct nfs4_state_owner
*sp
)
298 if (!RB_EMPTY_NODE(&sp
->so_client_node
)) {
299 struct nfs_client
*clp
= sp
->so_client
;
301 spin_lock(&clp
->cl_lock
);
302 rb_erase(&sp
->so_client_node
, &clp
->cl_state_owners
);
303 RB_CLEAR_NODE(&sp
->so_client_node
);
304 spin_unlock(&clp
->cl_lock
);
308 struct nfs4_state_owner
*nfs4_get_state_owner(struct nfs_server
*server
, struct rpc_cred
*cred
)
310 struct nfs_client
*clp
= server
->nfs_client
;
311 struct nfs4_state_owner
*sp
, *new;
313 spin_lock(&clp
->cl_lock
);
314 sp
= nfs4_find_state_owner(server
, cred
);
315 spin_unlock(&clp
->cl_lock
);
318 new = nfs4_alloc_state_owner();
321 new->so_client
= clp
;
322 new->so_server
= server
;
324 spin_lock(&clp
->cl_lock
);
325 sp
= nfs4_insert_state_owner(clp
, new);
326 spin_unlock(&clp
->cl_lock
);
330 rpc_destroy_wait_queue(&new->so_sequence
.wait
);
336 void nfs4_put_state_owner(struct nfs4_state_owner
*sp
)
338 struct nfs_client
*clp
= sp
->so_client
;
339 struct rpc_cred
*cred
= sp
->so_cred
;
341 if (!atomic_dec_and_lock(&sp
->so_count
, &clp
->cl_lock
))
343 nfs4_remove_state_owner(clp
, sp
);
344 spin_unlock(&clp
->cl_lock
);
345 rpc_destroy_wait_queue(&sp
->so_sequence
.wait
);
350 static struct nfs4_state
*
351 nfs4_alloc_open_state(void)
353 struct nfs4_state
*state
;
355 state
= kzalloc(sizeof(*state
), GFP_KERNEL
);
358 atomic_set(&state
->count
, 1);
359 INIT_LIST_HEAD(&state
->lock_states
);
360 spin_lock_init(&state
->state_lock
);
361 seqlock_init(&state
->seqlock
);
366 nfs4_state_set_mode_locked(struct nfs4_state
*state
, fmode_t fmode
)
368 if (state
->state
== fmode
)
370 /* NB! List reordering - see the reclaim code for why. */
371 if ((fmode
& FMODE_WRITE
) != (state
->state
& FMODE_WRITE
)) {
372 if (fmode
& FMODE_WRITE
)
373 list_move(&state
->open_states
, &state
->owner
->so_states
);
375 list_move_tail(&state
->open_states
, &state
->owner
->so_states
);
377 state
->state
= fmode
;
380 static struct nfs4_state
*
381 __nfs4_find_state_byowner(struct inode
*inode
, struct nfs4_state_owner
*owner
)
383 struct nfs_inode
*nfsi
= NFS_I(inode
);
384 struct nfs4_state
*state
;
386 list_for_each_entry(state
, &nfsi
->open_states
, inode_states
) {
387 if (state
->owner
!= owner
)
389 if (atomic_inc_not_zero(&state
->count
))
396 nfs4_free_open_state(struct nfs4_state
*state
)
402 nfs4_get_open_state(struct inode
*inode
, struct nfs4_state_owner
*owner
)
404 struct nfs4_state
*state
, *new;
405 struct nfs_inode
*nfsi
= NFS_I(inode
);
407 spin_lock(&inode
->i_lock
);
408 state
= __nfs4_find_state_byowner(inode
, owner
);
409 spin_unlock(&inode
->i_lock
);
412 new = nfs4_alloc_open_state();
413 spin_lock(&owner
->so_lock
);
414 spin_lock(&inode
->i_lock
);
415 state
= __nfs4_find_state_byowner(inode
, owner
);
416 if (state
== NULL
&& new != NULL
) {
418 state
->owner
= owner
;
419 atomic_inc(&owner
->so_count
);
420 list_add(&state
->inode_states
, &nfsi
->open_states
);
421 state
->inode
= igrab(inode
);
422 spin_unlock(&inode
->i_lock
);
423 /* Note: The reclaim code dictates that we add stateless
424 * and read-only stateids to the end of the list */
425 list_add_tail(&state
->open_states
, &owner
->so_states
);
426 spin_unlock(&owner
->so_lock
);
428 spin_unlock(&inode
->i_lock
);
429 spin_unlock(&owner
->so_lock
);
431 nfs4_free_open_state(new);
437 void nfs4_put_open_state(struct nfs4_state
*state
)
439 struct inode
*inode
= state
->inode
;
440 struct nfs4_state_owner
*owner
= state
->owner
;
442 if (!atomic_dec_and_lock(&state
->count
, &owner
->so_lock
))
444 spin_lock(&inode
->i_lock
);
445 list_del(&state
->inode_states
);
446 list_del(&state
->open_states
);
447 spin_unlock(&inode
->i_lock
);
448 spin_unlock(&owner
->so_lock
);
450 nfs4_free_open_state(state
);
451 nfs4_put_state_owner(owner
);
455 * Close the current file.
457 static void __nfs4_close(struct path
*path
, struct nfs4_state
*state
, fmode_t fmode
, int wait
)
459 struct nfs4_state_owner
*owner
= state
->owner
;
463 atomic_inc(&owner
->so_count
);
464 /* Protect against nfs4_find_state() */
465 spin_lock(&owner
->so_lock
);
466 switch (fmode
& (FMODE_READ
| FMODE_WRITE
)) {
473 case FMODE_READ
|FMODE_WRITE
:
476 newstate
= FMODE_READ
|FMODE_WRITE
;
477 if (state
->n_rdwr
== 0) {
478 if (state
->n_rdonly
== 0) {
479 newstate
&= ~FMODE_READ
;
480 call_close
|= test_bit(NFS_O_RDONLY_STATE
, &state
->flags
);
481 call_close
|= test_bit(NFS_O_RDWR_STATE
, &state
->flags
);
483 if (state
->n_wronly
== 0) {
484 newstate
&= ~FMODE_WRITE
;
485 call_close
|= test_bit(NFS_O_WRONLY_STATE
, &state
->flags
);
486 call_close
|= test_bit(NFS_O_RDWR_STATE
, &state
->flags
);
489 clear_bit(NFS_DELEGATED_STATE
, &state
->flags
);
491 nfs4_state_set_mode_locked(state
, newstate
);
492 spin_unlock(&owner
->so_lock
);
495 nfs4_put_open_state(state
);
496 nfs4_put_state_owner(owner
);
498 nfs4_do_close(path
, state
, wait
);
501 void nfs4_close_state(struct path
*path
, struct nfs4_state
*state
, fmode_t fmode
)
503 __nfs4_close(path
, state
, fmode
, 0);
506 void nfs4_close_sync(struct path
*path
, struct nfs4_state
*state
, fmode_t fmode
)
508 __nfs4_close(path
, state
, fmode
, 1);
512 * Search the state->lock_states for an existing lock_owner
513 * that is compatible with current->files
515 static struct nfs4_lock_state
*
516 __nfs4_find_lock_state(struct nfs4_state
*state
, fl_owner_t fl_owner
)
518 struct nfs4_lock_state
*pos
;
519 list_for_each_entry(pos
, &state
->lock_states
, ls_locks
) {
520 if (pos
->ls_owner
!= fl_owner
)
522 atomic_inc(&pos
->ls_count
);
529 * Return a compatible lock_state. If no initialized lock_state structure
530 * exists, return an uninitialized one.
533 static struct nfs4_lock_state
*nfs4_alloc_lock_state(struct nfs4_state
*state
, fl_owner_t fl_owner
)
535 struct nfs4_lock_state
*lsp
;
536 struct nfs_client
*clp
= state
->owner
->so_client
;
538 lsp
= kzalloc(sizeof(*lsp
), GFP_KERNEL
);
541 rpc_init_wait_queue(&lsp
->ls_sequence
.wait
, "lock_seqid_waitqueue");
542 spin_lock_init(&lsp
->ls_sequence
.lock
);
543 INIT_LIST_HEAD(&lsp
->ls_sequence
.list
);
544 lsp
->ls_seqid
.sequence
= &lsp
->ls_sequence
;
545 atomic_set(&lsp
->ls_count
, 1);
546 lsp
->ls_owner
= fl_owner
;
547 spin_lock(&clp
->cl_lock
);
548 nfs_alloc_unique_id(&clp
->cl_lockowner_id
, &lsp
->ls_id
, 1, 64);
549 spin_unlock(&clp
->cl_lock
);
550 INIT_LIST_HEAD(&lsp
->ls_locks
);
554 static void nfs4_free_lock_state(struct nfs4_lock_state
*lsp
)
556 struct nfs_client
*clp
= lsp
->ls_state
->owner
->so_client
;
558 spin_lock(&clp
->cl_lock
);
559 nfs_free_unique_id(&clp
->cl_lockowner_id
, &lsp
->ls_id
);
560 spin_unlock(&clp
->cl_lock
);
561 rpc_destroy_wait_queue(&lsp
->ls_sequence
.wait
);
566 * Return a compatible lock_state. If no initialized lock_state structure
567 * exists, return an uninitialized one.
570 static struct nfs4_lock_state
*nfs4_get_lock_state(struct nfs4_state
*state
, fl_owner_t owner
)
572 struct nfs4_lock_state
*lsp
, *new = NULL
;
575 spin_lock(&state
->state_lock
);
576 lsp
= __nfs4_find_lock_state(state
, owner
);
580 new->ls_state
= state
;
581 list_add(&new->ls_locks
, &state
->lock_states
);
582 set_bit(LK_STATE_IN_USE
, &state
->flags
);
587 spin_unlock(&state
->state_lock
);
588 new = nfs4_alloc_lock_state(state
, owner
);
592 spin_unlock(&state
->state_lock
);
594 nfs4_free_lock_state(new);
599 * Release reference to lock_state, and free it if we see that
600 * it is no longer in use
602 void nfs4_put_lock_state(struct nfs4_lock_state
*lsp
)
604 struct nfs4_state
*state
;
608 state
= lsp
->ls_state
;
609 if (!atomic_dec_and_lock(&lsp
->ls_count
, &state
->state_lock
))
611 list_del(&lsp
->ls_locks
);
612 if (list_empty(&state
->lock_states
))
613 clear_bit(LK_STATE_IN_USE
, &state
->flags
);
614 spin_unlock(&state
->state_lock
);
615 nfs4_free_lock_state(lsp
);
618 static void nfs4_fl_copy_lock(struct file_lock
*dst
, struct file_lock
*src
)
620 struct nfs4_lock_state
*lsp
= src
->fl_u
.nfs4_fl
.owner
;
622 dst
->fl_u
.nfs4_fl
.owner
= lsp
;
623 atomic_inc(&lsp
->ls_count
);
626 static void nfs4_fl_release_lock(struct file_lock
*fl
)
628 nfs4_put_lock_state(fl
->fl_u
.nfs4_fl
.owner
);
631 static struct file_lock_operations nfs4_fl_lock_ops
= {
632 .fl_copy_lock
= nfs4_fl_copy_lock
,
633 .fl_release_private
= nfs4_fl_release_lock
,
636 int nfs4_set_lock_state(struct nfs4_state
*state
, struct file_lock
*fl
)
638 struct nfs4_lock_state
*lsp
;
640 if (fl
->fl_ops
!= NULL
)
642 lsp
= nfs4_get_lock_state(state
, fl
->fl_owner
);
645 fl
->fl_u
.nfs4_fl
.owner
= lsp
;
646 fl
->fl_ops
= &nfs4_fl_lock_ops
;
651 * Byte-range lock aware utility to initialize the stateid of read/write
654 void nfs4_copy_stateid(nfs4_stateid
*dst
, struct nfs4_state
*state
, fl_owner_t fl_owner
)
656 struct nfs4_lock_state
*lsp
;
660 seq
= read_seqbegin(&state
->seqlock
);
661 memcpy(dst
, &state
->stateid
, sizeof(*dst
));
662 } while (read_seqretry(&state
->seqlock
, seq
));
663 if (test_bit(LK_STATE_IN_USE
, &state
->flags
) == 0)
666 spin_lock(&state
->state_lock
);
667 lsp
= __nfs4_find_lock_state(state
, fl_owner
);
668 if (lsp
!= NULL
&& (lsp
->ls_flags
& NFS_LOCK_INITIALIZED
) != 0)
669 memcpy(dst
, &lsp
->ls_stateid
, sizeof(*dst
));
670 spin_unlock(&state
->state_lock
);
671 nfs4_put_lock_state(lsp
);
674 struct nfs_seqid
*nfs_alloc_seqid(struct nfs_seqid_counter
*counter
)
676 struct nfs_seqid
*new;
678 new = kmalloc(sizeof(*new), GFP_KERNEL
);
680 new->sequence
= counter
;
681 INIT_LIST_HEAD(&new->list
);
686 void nfs_free_seqid(struct nfs_seqid
*seqid
)
688 if (!list_empty(&seqid
->list
)) {
689 struct rpc_sequence
*sequence
= seqid
->sequence
->sequence
;
691 spin_lock(&sequence
->lock
);
692 list_del(&seqid
->list
);
693 spin_unlock(&sequence
->lock
);
694 rpc_wake_up(&sequence
->wait
);
700 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
701 * failed with a seqid incrementing error -
702 * see comments nfs_fs.h:seqid_mutating_error()
704 static void nfs_increment_seqid(int status
, struct nfs_seqid
*seqid
)
706 BUG_ON(list_first_entry(&seqid
->sequence
->sequence
->list
, struct nfs_seqid
, list
) != seqid
);
710 case -NFS4ERR_BAD_SEQID
:
711 if (seqid
->sequence
->flags
& NFS_SEQID_CONFIRMED
)
713 printk(KERN_WARNING
"NFS: v4 server returned a bad"
714 " sequence-id error on an"
715 " unconfirmed sequence %p!\n",
717 case -NFS4ERR_STALE_CLIENTID
:
718 case -NFS4ERR_STALE_STATEID
:
719 case -NFS4ERR_BAD_STATEID
:
720 case -NFS4ERR_BADXDR
:
721 case -NFS4ERR_RESOURCE
:
722 case -NFS4ERR_NOFILEHANDLE
:
723 /* Non-seqid mutating errors */
727 * Note: no locking needed as we are guaranteed to be first
728 * on the sequence list
730 seqid
->sequence
->counter
++;
733 void nfs_increment_open_seqid(int status
, struct nfs_seqid
*seqid
)
735 if (status
== -NFS4ERR_BAD_SEQID
) {
736 struct nfs4_state_owner
*sp
= container_of(seqid
->sequence
,
737 struct nfs4_state_owner
, so_seqid
);
738 nfs4_drop_state_owner(sp
);
740 nfs_increment_seqid(status
, seqid
);
744 * Increment the seqid if the LOCK/LOCKU succeeded, or
745 * failed with a seqid incrementing error -
746 * see comments nfs_fs.h:seqid_mutating_error()
748 void nfs_increment_lock_seqid(int status
, struct nfs_seqid
*seqid
)
750 nfs_increment_seqid(status
, seqid
);
753 int nfs_wait_on_sequence(struct nfs_seqid
*seqid
, struct rpc_task
*task
)
755 struct rpc_sequence
*sequence
= seqid
->sequence
->sequence
;
758 spin_lock(&sequence
->lock
);
759 if (list_empty(&seqid
->list
))
760 list_add_tail(&seqid
->list
, &sequence
->list
);
761 if (list_first_entry(&sequence
->list
, struct nfs_seqid
, list
) == seqid
)
763 rpc_sleep_on(&sequence
->wait
, task
, NULL
);
766 spin_unlock(&sequence
->lock
);
770 static int nfs4_run_state_manager(void *);
772 static void nfs4_clear_state_manager_bit(struct nfs_client
*clp
)
774 smp_mb__before_clear_bit();
775 clear_bit(NFS4CLNT_MANAGER_RUNNING
, &clp
->cl_state
);
776 smp_mb__after_clear_bit();
777 wake_up_bit(&clp
->cl_state
, NFS4CLNT_MANAGER_RUNNING
);
778 rpc_wake_up(&clp
->cl_rpcwaitq
);
782 * Schedule the nfs_client asynchronous state management routine
784 void nfs4_schedule_state_manager(struct nfs_client
*clp
)
786 struct task_struct
*task
;
788 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING
, &clp
->cl_state
) != 0)
790 __module_get(THIS_MODULE
);
791 atomic_inc(&clp
->cl_count
);
792 task
= kthread_run(nfs4_run_state_manager
, clp
, "%s-manager",
793 rpc_peeraddr2str(clp
->cl_rpcclient
,
797 nfs4_clear_state_manager_bit(clp
);
799 module_put(THIS_MODULE
);
803 * Schedule a state recovery attempt
805 void nfs4_schedule_state_recovery(struct nfs_client
*clp
)
809 if (!test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
))
810 set_bit(NFS4CLNT_CHECK_LEASE
, &clp
->cl_state
);
811 nfs4_schedule_state_manager(clp
);
814 static int nfs4_state_mark_reclaim_reboot(struct nfs_client
*clp
, struct nfs4_state
*state
)
817 set_bit(NFS_STATE_RECLAIM_REBOOT
, &state
->flags
);
818 /* Don't recover state that expired before the reboot */
819 if (test_bit(NFS_STATE_RECLAIM_NOGRACE
, &state
->flags
)) {
820 clear_bit(NFS_STATE_RECLAIM_REBOOT
, &state
->flags
);
823 set_bit(NFS_OWNER_RECLAIM_REBOOT
, &state
->owner
->so_flags
);
824 set_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
);
828 int nfs4_state_mark_reclaim_nograce(struct nfs_client
*clp
, struct nfs4_state
*state
)
830 set_bit(NFS_STATE_RECLAIM_NOGRACE
, &state
->flags
);
831 clear_bit(NFS_STATE_RECLAIM_REBOOT
, &state
->flags
);
832 set_bit(NFS_OWNER_RECLAIM_NOGRACE
, &state
->owner
->so_flags
);
833 set_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
);
837 static int nfs4_reclaim_locks(struct nfs4_state
*state
, const struct nfs4_state_recovery_ops
*ops
)
839 struct inode
*inode
= state
->inode
;
840 struct nfs_inode
*nfsi
= NFS_I(inode
);
841 struct file_lock
*fl
;
844 down_write(&nfsi
->rwsem
);
845 for (fl
= inode
->i_flock
; fl
!= NULL
; fl
= fl
->fl_next
) {
846 if (!(fl
->fl_flags
& (FL_POSIX
|FL_FLOCK
)))
848 if (nfs_file_open_context(fl
->fl_file
)->state
!= state
)
850 status
= ops
->recover_lock(state
, fl
);
855 printk(KERN_ERR
"%s: unhandled error %d. Zeroing state\n",
857 case -NFS4ERR_EXPIRED
:
858 case -NFS4ERR_NO_GRACE
:
859 case -NFS4ERR_RECLAIM_BAD
:
860 case -NFS4ERR_RECLAIM_CONFLICT
:
861 /* kill_proc(fl->fl_pid, SIGLOST, 1); */
863 case -NFS4ERR_STALE_CLIENTID
:
867 up_write(&nfsi
->rwsem
);
870 up_write(&nfsi
->rwsem
);
874 static int nfs4_reclaim_open_state(struct nfs4_state_owner
*sp
, const struct nfs4_state_recovery_ops
*ops
)
876 struct nfs4_state
*state
;
877 struct nfs4_lock_state
*lock
;
880 /* Note: we rely on the sp->so_states list being ordered
881 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
883 * This is needed to ensure that the server won't give us any
884 * read delegations that we have to return if, say, we are
885 * recovering after a network partition or a reboot from a
886 * server that doesn't support a grace period.
889 spin_lock(&sp
->so_lock
);
890 list_for_each_entry(state
, &sp
->so_states
, open_states
) {
891 if (!test_and_clear_bit(ops
->state_flag_bit
, &state
->flags
))
893 if (state
->state
== 0)
895 atomic_inc(&state
->count
);
896 spin_unlock(&sp
->so_lock
);
897 status
= ops
->recover_open(sp
, state
);
899 status
= nfs4_reclaim_locks(state
, ops
);
901 list_for_each_entry(lock
, &state
->lock_states
, ls_locks
) {
902 if (!(lock
->ls_flags
& NFS_LOCK_INITIALIZED
))
903 printk("%s: Lock reclaim failed!\n",
906 nfs4_put_open_state(state
);
912 printk(KERN_ERR
"%s: unhandled error %d. Zeroing state\n",
917 * Open state on this file cannot be recovered
918 * All we can do is revert to using the zero stateid.
920 memset(state
->stateid
.data
, 0,
921 sizeof(state
->stateid
.data
));
922 /* Mark the file as being 'closed' */
925 case -NFS4ERR_RECLAIM_BAD
:
926 case -NFS4ERR_RECLAIM_CONFLICT
:
927 nfs4_state_mark_reclaim_nograce(sp
->so_client
, state
);
929 case -NFS4ERR_EXPIRED
:
930 case -NFS4ERR_NO_GRACE
:
931 nfs4_state_mark_reclaim_nograce(sp
->so_client
, state
);
932 case -NFS4ERR_STALE_CLIENTID
:
935 nfs4_put_open_state(state
);
938 spin_unlock(&sp
->so_lock
);
941 nfs4_put_open_state(state
);
945 static void nfs4_clear_open_state(struct nfs4_state
*state
)
947 struct nfs4_lock_state
*lock
;
949 clear_bit(NFS_DELEGATED_STATE
, &state
->flags
);
950 clear_bit(NFS_O_RDONLY_STATE
, &state
->flags
);
951 clear_bit(NFS_O_WRONLY_STATE
, &state
->flags
);
952 clear_bit(NFS_O_RDWR_STATE
, &state
->flags
);
953 list_for_each_entry(lock
, &state
->lock_states
, ls_locks
) {
954 lock
->ls_seqid
.flags
= 0;
955 lock
->ls_flags
&= ~NFS_LOCK_INITIALIZED
;
959 static void nfs4_state_mark_reclaim_helper(struct nfs_client
*clp
, int (*mark_reclaim
)(struct nfs_client
*clp
, struct nfs4_state
*state
))
961 struct nfs4_state_owner
*sp
;
963 struct nfs4_state
*state
;
965 /* Reset all sequence ids to zero */
966 for (pos
= rb_first(&clp
->cl_state_owners
); pos
!= NULL
; pos
= rb_next(pos
)) {
967 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_client_node
);
968 sp
->so_seqid
.flags
= 0;
969 spin_lock(&sp
->so_lock
);
970 list_for_each_entry(state
, &sp
->so_states
, open_states
) {
971 if (mark_reclaim(clp
, state
))
972 nfs4_clear_open_state(state
);
974 spin_unlock(&sp
->so_lock
);
978 static void nfs4_state_start_reclaim_reboot(struct nfs_client
*clp
)
980 /* Mark all delegations for reclaim */
981 nfs_delegation_mark_reclaim(clp
);
982 nfs4_state_mark_reclaim_helper(clp
, nfs4_state_mark_reclaim_reboot
);
985 static void nfs4_state_end_reclaim_reboot(struct nfs_client
*clp
)
987 struct nfs4_state_owner
*sp
;
989 struct nfs4_state
*state
;
991 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
))
994 for (pos
= rb_first(&clp
->cl_state_owners
); pos
!= NULL
; pos
= rb_next(pos
)) {
995 sp
= rb_entry(pos
, struct nfs4_state_owner
, so_client_node
);
996 spin_lock(&sp
->so_lock
);
997 list_for_each_entry(state
, &sp
->so_states
, open_states
) {
998 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT
, &state
->flags
))
1000 nfs4_state_mark_reclaim_nograce(clp
, state
);
1002 spin_unlock(&sp
->so_lock
);
1005 nfs_delegation_reap_unclaimed(clp
);
1008 static void nfs_delegation_clear_all(struct nfs_client
*clp
)
1010 nfs_delegation_mark_reclaim(clp
);
1011 nfs_delegation_reap_unclaimed(clp
);
1014 static void nfs4_state_start_reclaim_nograce(struct nfs_client
*clp
)
1016 nfs_delegation_clear_all(clp
);
1017 nfs4_state_mark_reclaim_helper(clp
, nfs4_state_mark_reclaim_nograce
);
1020 static void nfs4_state_end_reclaim_nograce(struct nfs_client
*clp
)
1022 clear_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
);
1025 static void nfs4_recovery_handle_error(struct nfs_client
*clp
, int error
)
1028 case -NFS4ERR_CB_PATH_DOWN
:
1029 nfs_handle_cb_pathdown(clp
);
1031 case -NFS4ERR_STALE_CLIENTID
:
1032 case -NFS4ERR_LEASE_MOVED
:
1033 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1034 nfs4_state_start_reclaim_reboot(clp
);
1036 case -NFS4ERR_EXPIRED
:
1037 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1038 nfs4_state_start_reclaim_nograce(clp
);
1042 static int nfs4_do_reclaim(struct nfs_client
*clp
, const struct nfs4_state_recovery_ops
*ops
)
1044 struct rb_node
*pos
;
1048 spin_lock(&clp
->cl_lock
);
1049 for (pos
= rb_first(&clp
->cl_state_owners
); pos
!= NULL
; pos
= rb_next(pos
)) {
1050 struct nfs4_state_owner
*sp
= rb_entry(pos
, struct nfs4_state_owner
, so_client_node
);
1051 if (!test_and_clear_bit(ops
->owner_flag_bit
, &sp
->so_flags
))
1053 atomic_inc(&sp
->so_count
);
1054 spin_unlock(&clp
->cl_lock
);
1055 status
= nfs4_reclaim_open_state(sp
, ops
);
1057 set_bit(ops
->owner_flag_bit
, &sp
->so_flags
);
1058 nfs4_put_state_owner(sp
);
1059 nfs4_recovery_handle_error(clp
, status
);
1062 nfs4_put_state_owner(sp
);
1065 spin_unlock(&clp
->cl_lock
);
1069 static int nfs4_check_lease(struct nfs_client
*clp
)
1071 struct rpc_cred
*cred
;
1072 int status
= -NFS4ERR_EXPIRED
;
1074 /* Is the client already known to have an expired lease? */
1075 if (test_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
))
1077 cred
= nfs4_get_renew_cred(clp
);
1079 cred
= nfs4_get_setclientid_cred(clp
);
1083 status
= nfs4_proc_renew(clp
, cred
);
1086 nfs4_recovery_handle_error(clp
, status
);
1090 static int nfs4_reclaim_lease(struct nfs_client
*clp
)
1092 struct rpc_cred
*cred
;
1093 int status
= -ENOENT
;
1095 cred
= nfs4_get_setclientid_cred(clp
);
1097 status
= nfs4_init_client(clp
, cred
);
1099 /* Handle case where the user hasn't set up machine creds */
1100 if (status
== -EACCES
&& cred
== clp
->cl_machine_cred
) {
1101 nfs4_clear_machine_cred(clp
);
1108 static void nfs4_state_manager(struct nfs_client
*clp
)
1112 /* Ensure exclusive access to NFSv4 state */
1114 if (test_and_clear_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
)) {
1115 /* We're going to have to re-establish a clientid */
1116 status
= nfs4_reclaim_lease(clp
);
1118 set_bit(NFS4CLNT_LEASE_EXPIRED
, &clp
->cl_state
);
1119 if (status
== -EAGAIN
)
1123 clear_bit(NFS4CLNT_CHECK_LEASE
, &clp
->cl_state
);
1126 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE
, &clp
->cl_state
)) {
1127 status
= nfs4_check_lease(clp
);
1132 /* First recover reboot state... */
1133 if (test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
)) {
1134 status
= nfs4_do_reclaim(clp
, &nfs4_reboot_recovery_ops
);
1135 if (status
== -NFS4ERR_STALE_CLIENTID
)
1137 nfs4_state_end_reclaim_reboot(clp
);
1141 /* Now recover expired state... */
1142 if (test_and_clear_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
)) {
1143 status
= nfs4_do_reclaim(clp
, &nfs4_nograce_recovery_ops
);
1145 set_bit(NFS4CLNT_RECLAIM_NOGRACE
, &clp
->cl_state
);
1146 if (status
== -NFS4ERR_STALE_CLIENTID
)
1148 if (status
== -NFS4ERR_EXPIRED
)
1152 nfs4_state_end_reclaim_nograce(clp
);
1156 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN
, &clp
->cl_state
)) {
1157 nfs_client_return_marked_delegations(clp
);
1161 nfs4_clear_state_manager_bit(clp
);
1162 /* Did we race with an attempt to give us more work? */
1163 if (clp
->cl_state
== 0)
1165 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING
, &clp
->cl_state
) != 0)
1170 printk(KERN_WARNING
"Error: state manager failed on NFSv4 server %s"
1171 " with error %d\n", clp
->cl_hostname
, -status
);
1172 if (test_bit(NFS4CLNT_RECLAIM_REBOOT
, &clp
->cl_state
))
1173 nfs4_state_end_reclaim_reboot(clp
);
1174 nfs4_clear_state_manager_bit(clp
);
1177 static int nfs4_run_state_manager(void *ptr
)
1179 struct nfs_client
*clp
= ptr
;
1181 allow_signal(SIGKILL
);
1182 nfs4_state_manager(clp
);
1183 nfs_put_client(clp
);
1184 module_put_and_exit(0);