i2c: fsi: Add I2C master locking
[linux/fpc-iii.git] / fs / nfs / nfs4state.c
blob2bf2eaa08ca7de5397e0099786b672a757543242
1 /*
2 * fs/nfs/nfs4state.c
4 * Client-side XDR for NFSv4.
6 * Copyright (c) 2002 The Regents of the University of Michigan.
7 * All rights reserved.
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
13 * are met:
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
38 * subsequent patch.
41 #include <linux/kernel.h>
42 #include <linux/slab.h>
43 #include <linux/fs.h>
44 #include <linux/nfs_fs.h>
45 #include <linux/kthread.h>
46 #include <linux/module.h>
47 #include <linux/random.h>
48 #include <linux/ratelimit.h>
49 #include <linux/workqueue.h>
50 #include <linux/bitops.h>
51 #include <linux/jiffies.h>
53 #include <linux/sunrpc/clnt.h>
55 #include "nfs4_fs.h"
56 #include "callback.h"
57 #include "delegation.h"
58 #include "internal.h"
59 #include "nfs4idmap.h"
60 #include "nfs4session.h"
61 #include "pnfs.h"
62 #include "netns.h"
64 #define NFSDBG_FACILITY NFSDBG_STATE
66 #define OPENOWNER_POOL_SIZE 8
68 const nfs4_stateid zero_stateid = {
69 { .data = { 0 } },
70 .type = NFS4_SPECIAL_STATEID_TYPE,
72 const nfs4_stateid invalid_stateid = {
74 /* Funky initialiser keeps older gcc versions happy */
75 .data = { 0xff, 0xff, 0xff, 0xff, 0 },
77 .type = NFS4_INVALID_STATEID_TYPE,
80 const nfs4_stateid current_stateid = {
82 /* Funky initialiser keeps older gcc versions happy */
83 .data = { 0x0, 0x0, 0x0, 0x1, 0 },
85 .type = NFS4_SPECIAL_STATEID_TYPE,
88 static DEFINE_MUTEX(nfs_clid_init_mutex);
90 int nfs4_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
92 struct nfs4_setclientid_res clid = {
93 .clientid = clp->cl_clientid,
94 .confirm = clp->cl_confirm,
96 unsigned short port;
97 int status;
98 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
100 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
101 goto do_confirm;
102 port = nn->nfs_callback_tcpport;
103 if (clp->cl_addr.ss_family == AF_INET6)
104 port = nn->nfs_callback_tcpport6;
106 status = nfs4_proc_setclientid(clp, NFS4_CALLBACK, port, cred, &clid);
107 if (status != 0)
108 goto out;
109 clp->cl_clientid = clid.clientid;
110 clp->cl_confirm = clid.confirm;
111 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
112 do_confirm:
113 status = nfs4_proc_setclientid_confirm(clp, &clid, cred);
114 if (status != 0)
115 goto out;
116 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
117 nfs4_schedule_state_renewal(clp);
118 out:
119 return status;
123 * nfs40_discover_server_trunking - Detect server IP address trunking (mv0)
125 * @clp: nfs_client under test
126 * @result: OUT: found nfs_client, or clp
127 * @cred: credential to use for trunking test
129 * Returns zero, a negative errno, or a negative NFS4ERR status.
130 * If zero is returned, an nfs_client pointer is planted in
131 * "result".
133 * Note: The returned client may not yet be marked ready.
135 int nfs40_discover_server_trunking(struct nfs_client *clp,
136 struct nfs_client **result,
137 struct rpc_cred *cred)
139 struct nfs4_setclientid_res clid = {
140 .clientid = clp->cl_clientid,
141 .confirm = clp->cl_confirm,
143 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
144 unsigned short port;
145 int status;
147 port = nn->nfs_callback_tcpport;
148 if (clp->cl_addr.ss_family == AF_INET6)
149 port = nn->nfs_callback_tcpport6;
151 status = nfs4_proc_setclientid(clp, NFS4_CALLBACK, port, cred, &clid);
152 if (status != 0)
153 goto out;
154 clp->cl_clientid = clid.clientid;
155 clp->cl_confirm = clid.confirm;
157 status = nfs40_walk_client_list(clp, result, cred);
158 if (status == 0) {
159 /* Sustain the lease, even if it's empty. If the clientid4
160 * goes stale it's of no use for trunking discovery. */
161 nfs4_schedule_state_renewal(*result);
163 out:
164 return status;
167 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp)
169 struct rpc_cred *cred = NULL;
171 if (clp->cl_machine_cred != NULL)
172 cred = get_rpccred(clp->cl_machine_cred);
173 return cred;
176 static void nfs4_root_machine_cred(struct nfs_client *clp)
178 struct rpc_cred *cred, *new;
180 new = rpc_lookup_machine_cred(NULL);
181 spin_lock(&clp->cl_lock);
182 cred = clp->cl_machine_cred;
183 clp->cl_machine_cred = new;
184 spin_unlock(&clp->cl_lock);
185 if (cred != NULL)
186 put_rpccred(cred);
189 static struct rpc_cred *
190 nfs4_get_renew_cred_server_locked(struct nfs_server *server)
192 struct rpc_cred *cred = NULL;
193 struct nfs4_state_owner *sp;
194 struct rb_node *pos;
196 for (pos = rb_first(&server->state_owners);
197 pos != NULL;
198 pos = rb_next(pos)) {
199 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
200 if (list_empty(&sp->so_states))
201 continue;
202 cred = get_rpccred(sp->so_cred);
203 break;
205 return cred;
209 * nfs4_get_renew_cred_locked - Acquire credential for a renew operation
210 * @clp: client state handle
212 * Returns an rpc_cred with reference count bumped, or NULL.
213 * Caller must hold clp->cl_lock.
215 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp)
217 struct rpc_cred *cred = NULL;
218 struct nfs_server *server;
220 /* Use machine credentials if available */
221 cred = nfs4_get_machine_cred_locked(clp);
222 if (cred != NULL)
223 goto out;
225 rcu_read_lock();
226 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
227 cred = nfs4_get_renew_cred_server_locked(server);
228 if (cred != NULL)
229 break;
231 rcu_read_unlock();
233 out:
234 return cred;
237 static void nfs4_end_drain_slot_table(struct nfs4_slot_table *tbl)
239 if (test_and_clear_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
240 spin_lock(&tbl->slot_tbl_lock);
241 nfs41_wake_slot_table(tbl);
242 spin_unlock(&tbl->slot_tbl_lock);
246 static void nfs4_end_drain_session(struct nfs_client *clp)
248 struct nfs4_session *ses = clp->cl_session;
250 if (clp->cl_slot_tbl) {
251 nfs4_end_drain_slot_table(clp->cl_slot_tbl);
252 return;
255 if (ses != NULL) {
256 nfs4_end_drain_slot_table(&ses->bc_slot_table);
257 nfs4_end_drain_slot_table(&ses->fc_slot_table);
261 static int nfs4_drain_slot_tbl(struct nfs4_slot_table *tbl)
263 set_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state);
264 spin_lock(&tbl->slot_tbl_lock);
265 if (tbl->highest_used_slotid != NFS4_NO_SLOT) {
266 reinit_completion(&tbl->complete);
267 spin_unlock(&tbl->slot_tbl_lock);
268 return wait_for_completion_interruptible(&tbl->complete);
270 spin_unlock(&tbl->slot_tbl_lock);
271 return 0;
274 static int nfs4_begin_drain_session(struct nfs_client *clp)
276 struct nfs4_session *ses = clp->cl_session;
277 int ret = 0;
279 if (clp->cl_slot_tbl)
280 return nfs4_drain_slot_tbl(clp->cl_slot_tbl);
282 /* back channel */
283 ret = nfs4_drain_slot_tbl(&ses->bc_slot_table);
284 if (ret)
285 return ret;
286 /* fore channel */
287 return nfs4_drain_slot_tbl(&ses->fc_slot_table);
290 #if defined(CONFIG_NFS_V4_1)
292 static int nfs41_setup_state_renewal(struct nfs_client *clp)
294 int status;
295 struct nfs_fsinfo fsinfo;
296 unsigned long now;
298 if (!test_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state)) {
299 nfs4_schedule_state_renewal(clp);
300 return 0;
303 now = jiffies;
304 status = nfs4_proc_get_lease_time(clp, &fsinfo);
305 if (status == 0) {
306 nfs4_set_lease_period(clp, fsinfo.lease_time * HZ, now);
307 nfs4_schedule_state_renewal(clp);
310 return status;
313 static void nfs41_finish_session_reset(struct nfs_client *clp)
315 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
316 clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
317 /* create_session negotiated new slot table */
318 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
319 nfs41_setup_state_renewal(clp);
322 int nfs41_init_clientid(struct nfs_client *clp, struct rpc_cred *cred)
324 int status;
326 if (test_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state))
327 goto do_confirm;
328 status = nfs4_proc_exchange_id(clp, cred);
329 if (status != 0)
330 goto out;
331 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
332 do_confirm:
333 status = nfs4_proc_create_session(clp, cred);
334 if (status != 0)
335 goto out;
336 nfs41_finish_session_reset(clp);
337 nfs_mark_client_ready(clp, NFS_CS_READY);
338 out:
339 return status;
343 * nfs41_discover_server_trunking - Detect server IP address trunking (mv1)
345 * @clp: nfs_client under test
346 * @result: OUT: found nfs_client, or clp
347 * @cred: credential to use for trunking test
349 * Returns NFS4_OK, a negative errno, or a negative NFS4ERR status.
350 * If NFS4_OK is returned, an nfs_client pointer is planted in
351 * "result".
353 * Note: The returned client may not yet be marked ready.
355 int nfs41_discover_server_trunking(struct nfs_client *clp,
356 struct nfs_client **result,
357 struct rpc_cred *cred)
359 int status;
361 status = nfs4_proc_exchange_id(clp, cred);
362 if (status != NFS4_OK)
363 return status;
365 status = nfs41_walk_client_list(clp, result, cred);
366 if (status < 0)
367 return status;
368 if (clp != *result)
369 return 0;
372 * Purge state if the client id was established in a prior
373 * instance and the client id could not have arrived on the
374 * server via Transparent State Migration.
376 if (clp->cl_exchange_flags & EXCHGID4_FLAG_CONFIRMED_R) {
377 if (!test_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags))
378 set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
379 else
380 set_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
382 nfs4_schedule_state_manager(clp);
383 status = nfs_wait_client_init_complete(clp);
384 if (status < 0)
385 nfs_put_client(clp);
386 return status;
389 #endif /* CONFIG_NFS_V4_1 */
392 * nfs4_get_clid_cred - Acquire credential for a setclientid operation
393 * @clp: client state handle
395 * Returns an rpc_cred with reference count bumped, or NULL.
397 struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp)
399 struct rpc_cred *cred;
401 spin_lock(&clp->cl_lock);
402 cred = nfs4_get_machine_cred_locked(clp);
403 spin_unlock(&clp->cl_lock);
404 return cred;
407 static struct nfs4_state_owner *
408 nfs4_find_state_owner_locked(struct nfs_server *server, struct rpc_cred *cred)
410 struct rb_node **p = &server->state_owners.rb_node,
411 *parent = NULL;
412 struct nfs4_state_owner *sp;
414 while (*p != NULL) {
415 parent = *p;
416 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
418 if (cred < sp->so_cred)
419 p = &parent->rb_left;
420 else if (cred > sp->so_cred)
421 p = &parent->rb_right;
422 else {
423 if (!list_empty(&sp->so_lru))
424 list_del_init(&sp->so_lru);
425 atomic_inc(&sp->so_count);
426 return sp;
429 return NULL;
432 static struct nfs4_state_owner *
433 nfs4_insert_state_owner_locked(struct nfs4_state_owner *new)
435 struct nfs_server *server = new->so_server;
436 struct rb_node **p = &server->state_owners.rb_node,
437 *parent = NULL;
438 struct nfs4_state_owner *sp;
440 while (*p != NULL) {
441 parent = *p;
442 sp = rb_entry(parent, struct nfs4_state_owner, so_server_node);
444 if (new->so_cred < sp->so_cred)
445 p = &parent->rb_left;
446 else if (new->so_cred > sp->so_cred)
447 p = &parent->rb_right;
448 else {
449 if (!list_empty(&sp->so_lru))
450 list_del_init(&sp->so_lru);
451 atomic_inc(&sp->so_count);
452 return sp;
455 rb_link_node(&new->so_server_node, parent, p);
456 rb_insert_color(&new->so_server_node, &server->state_owners);
457 return new;
460 static void
461 nfs4_remove_state_owner_locked(struct nfs4_state_owner *sp)
463 struct nfs_server *server = sp->so_server;
465 if (!RB_EMPTY_NODE(&sp->so_server_node))
466 rb_erase(&sp->so_server_node, &server->state_owners);
469 static void
470 nfs4_init_seqid_counter(struct nfs_seqid_counter *sc)
472 sc->create_time = ktime_get();
473 sc->flags = 0;
474 sc->counter = 0;
475 spin_lock_init(&sc->lock);
476 INIT_LIST_HEAD(&sc->list);
477 rpc_init_wait_queue(&sc->wait, "Seqid_waitqueue");
480 static void
481 nfs4_destroy_seqid_counter(struct nfs_seqid_counter *sc)
483 rpc_destroy_wait_queue(&sc->wait);
487 * nfs4_alloc_state_owner(): this is called on the OPEN or CREATE path to
488 * create a new state_owner.
491 static struct nfs4_state_owner *
492 nfs4_alloc_state_owner(struct nfs_server *server,
493 struct rpc_cred *cred,
494 gfp_t gfp_flags)
496 struct nfs4_state_owner *sp;
498 sp = kzalloc(sizeof(*sp), gfp_flags);
499 if (!sp)
500 return NULL;
501 sp->so_seqid.owner_id = ida_simple_get(&server->openowner_id, 0, 0,
502 gfp_flags);
503 if (sp->so_seqid.owner_id < 0) {
504 kfree(sp);
505 return NULL;
507 sp->so_server = server;
508 sp->so_cred = get_rpccred(cred);
509 spin_lock_init(&sp->so_lock);
510 INIT_LIST_HEAD(&sp->so_states);
511 nfs4_init_seqid_counter(&sp->so_seqid);
512 atomic_set(&sp->so_count, 1);
513 INIT_LIST_HEAD(&sp->so_lru);
514 seqcount_init(&sp->so_reclaim_seqcount);
515 mutex_init(&sp->so_delegreturn_mutex);
516 return sp;
519 static void
520 nfs4_reset_state_owner(struct nfs4_state_owner *sp)
522 /* This state_owner is no longer usable, but must
523 * remain in place so that state recovery can find it
524 * and the opens associated with it.
525 * It may also be used for new 'open' request to
526 * return a delegation to the server.
527 * So update the 'create_time' so that it looks like
528 * a new state_owner. This will cause the server to
529 * request an OPEN_CONFIRM to start a new sequence.
531 sp->so_seqid.create_time = ktime_get();
534 static void nfs4_free_state_owner(struct nfs4_state_owner *sp)
536 nfs4_destroy_seqid_counter(&sp->so_seqid);
537 put_rpccred(sp->so_cred);
538 ida_simple_remove(&sp->so_server->openowner_id, sp->so_seqid.owner_id);
539 kfree(sp);
542 static void nfs4_gc_state_owners(struct nfs_server *server)
544 struct nfs_client *clp = server->nfs_client;
545 struct nfs4_state_owner *sp, *tmp;
546 unsigned long time_min, time_max;
547 LIST_HEAD(doomed);
549 spin_lock(&clp->cl_lock);
550 time_max = jiffies;
551 time_min = (long)time_max - (long)clp->cl_lease_time;
552 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
553 /* NB: LRU is sorted so that oldest is at the head */
554 if (time_in_range(sp->so_expires, time_min, time_max))
555 break;
556 list_move(&sp->so_lru, &doomed);
557 nfs4_remove_state_owner_locked(sp);
559 spin_unlock(&clp->cl_lock);
561 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
562 list_del(&sp->so_lru);
563 nfs4_free_state_owner(sp);
568 * nfs4_get_state_owner - Look up a state owner given a credential
569 * @server: nfs_server to search
570 * @cred: RPC credential to match
572 * Returns a pointer to an instantiated nfs4_state_owner struct, or NULL.
574 struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *server,
575 struct rpc_cred *cred,
576 gfp_t gfp_flags)
578 struct nfs_client *clp = server->nfs_client;
579 struct nfs4_state_owner *sp, *new;
581 spin_lock(&clp->cl_lock);
582 sp = nfs4_find_state_owner_locked(server, cred);
583 spin_unlock(&clp->cl_lock);
584 if (sp != NULL)
585 goto out;
586 new = nfs4_alloc_state_owner(server, cred, gfp_flags);
587 if (new == NULL)
588 goto out;
589 spin_lock(&clp->cl_lock);
590 sp = nfs4_insert_state_owner_locked(new);
591 spin_unlock(&clp->cl_lock);
592 if (sp != new)
593 nfs4_free_state_owner(new);
594 out:
595 nfs4_gc_state_owners(server);
596 return sp;
600 * nfs4_put_state_owner - Release a nfs4_state_owner
601 * @sp: state owner data to release
603 * Note that we keep released state owners on an LRU
604 * list.
605 * This caches valid state owners so that they can be
606 * reused, to avoid the OPEN_CONFIRM on minor version 0.
607 * It also pins the uniquifier of dropped state owners for
608 * a while, to ensure that those state owner names are
609 * never reused.
611 void nfs4_put_state_owner(struct nfs4_state_owner *sp)
613 struct nfs_server *server = sp->so_server;
614 struct nfs_client *clp = server->nfs_client;
616 if (!atomic_dec_and_lock(&sp->so_count, &clp->cl_lock))
617 return;
619 sp->so_expires = jiffies;
620 list_add_tail(&sp->so_lru, &server->state_owners_lru);
621 spin_unlock(&clp->cl_lock);
625 * nfs4_purge_state_owners - Release all cached state owners
626 * @server: nfs_server with cached state owners to release
628 * Called at umount time. Remaining state owners will be on
629 * the LRU with ref count of zero.
631 void nfs4_purge_state_owners(struct nfs_server *server)
633 struct nfs_client *clp = server->nfs_client;
634 struct nfs4_state_owner *sp, *tmp;
635 LIST_HEAD(doomed);
637 spin_lock(&clp->cl_lock);
638 list_for_each_entry_safe(sp, tmp, &server->state_owners_lru, so_lru) {
639 list_move(&sp->so_lru, &doomed);
640 nfs4_remove_state_owner_locked(sp);
642 spin_unlock(&clp->cl_lock);
644 list_for_each_entry_safe(sp, tmp, &doomed, so_lru) {
645 list_del(&sp->so_lru);
646 nfs4_free_state_owner(sp);
650 static struct nfs4_state *
651 nfs4_alloc_open_state(void)
653 struct nfs4_state *state;
655 state = kzalloc(sizeof(*state), GFP_NOFS);
656 if (!state)
657 return NULL;
658 atomic_set(&state->count, 1);
659 INIT_LIST_HEAD(&state->lock_states);
660 spin_lock_init(&state->state_lock);
661 seqlock_init(&state->seqlock);
662 init_waitqueue_head(&state->waitq);
663 return state;
666 void
667 nfs4_state_set_mode_locked(struct nfs4_state *state, fmode_t fmode)
669 if (state->state == fmode)
670 return;
671 /* NB! List reordering - see the reclaim code for why. */
672 if ((fmode & FMODE_WRITE) != (state->state & FMODE_WRITE)) {
673 if (fmode & FMODE_WRITE)
674 list_move(&state->open_states, &state->owner->so_states);
675 else
676 list_move_tail(&state->open_states, &state->owner->so_states);
678 state->state = fmode;
681 static struct nfs4_state *
682 __nfs4_find_state_byowner(struct inode *inode, struct nfs4_state_owner *owner)
684 struct nfs_inode *nfsi = NFS_I(inode);
685 struct nfs4_state *state;
687 list_for_each_entry(state, &nfsi->open_states, inode_states) {
688 if (state->owner != owner)
689 continue;
690 if (!nfs4_valid_open_stateid(state))
691 continue;
692 if (atomic_inc_not_zero(&state->count))
693 return state;
695 return NULL;
698 static void
699 nfs4_free_open_state(struct nfs4_state *state)
701 kfree(state);
704 struct nfs4_state *
705 nfs4_get_open_state(struct inode *inode, struct nfs4_state_owner *owner)
707 struct nfs4_state *state, *new;
708 struct nfs_inode *nfsi = NFS_I(inode);
710 spin_lock(&inode->i_lock);
711 state = __nfs4_find_state_byowner(inode, owner);
712 spin_unlock(&inode->i_lock);
713 if (state)
714 goto out;
715 new = nfs4_alloc_open_state();
716 spin_lock(&owner->so_lock);
717 spin_lock(&inode->i_lock);
718 state = __nfs4_find_state_byowner(inode, owner);
719 if (state == NULL && new != NULL) {
720 state = new;
721 state->owner = owner;
722 atomic_inc(&owner->so_count);
723 list_add(&state->inode_states, &nfsi->open_states);
724 ihold(inode);
725 state->inode = inode;
726 spin_unlock(&inode->i_lock);
727 /* Note: The reclaim code dictates that we add stateless
728 * and read-only stateids to the end of the list */
729 list_add_tail(&state->open_states, &owner->so_states);
730 spin_unlock(&owner->so_lock);
731 } else {
732 spin_unlock(&inode->i_lock);
733 spin_unlock(&owner->so_lock);
734 if (new)
735 nfs4_free_open_state(new);
737 out:
738 return state;
741 void nfs4_put_open_state(struct nfs4_state *state)
743 struct inode *inode = state->inode;
744 struct nfs4_state_owner *owner = state->owner;
746 if (!atomic_dec_and_lock(&state->count, &owner->so_lock))
747 return;
748 spin_lock(&inode->i_lock);
749 list_del(&state->inode_states);
750 list_del(&state->open_states);
751 spin_unlock(&inode->i_lock);
752 spin_unlock(&owner->so_lock);
753 iput(inode);
754 nfs4_free_open_state(state);
755 nfs4_put_state_owner(owner);
759 * Close the current file.
761 static void __nfs4_close(struct nfs4_state *state,
762 fmode_t fmode, gfp_t gfp_mask, int wait)
764 struct nfs4_state_owner *owner = state->owner;
765 int call_close = 0;
766 fmode_t newstate;
768 atomic_inc(&owner->so_count);
769 /* Protect against nfs4_find_state() */
770 spin_lock(&owner->so_lock);
771 switch (fmode & (FMODE_READ | FMODE_WRITE)) {
772 case FMODE_READ:
773 state->n_rdonly--;
774 break;
775 case FMODE_WRITE:
776 state->n_wronly--;
777 break;
778 case FMODE_READ|FMODE_WRITE:
779 state->n_rdwr--;
781 newstate = FMODE_READ|FMODE_WRITE;
782 if (state->n_rdwr == 0) {
783 if (state->n_rdonly == 0) {
784 newstate &= ~FMODE_READ;
785 call_close |= test_bit(NFS_O_RDONLY_STATE, &state->flags);
786 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
788 if (state->n_wronly == 0) {
789 newstate &= ~FMODE_WRITE;
790 call_close |= test_bit(NFS_O_WRONLY_STATE, &state->flags);
791 call_close |= test_bit(NFS_O_RDWR_STATE, &state->flags);
793 if (newstate == 0)
794 clear_bit(NFS_DELEGATED_STATE, &state->flags);
796 nfs4_state_set_mode_locked(state, newstate);
797 spin_unlock(&owner->so_lock);
799 if (!call_close) {
800 nfs4_put_open_state(state);
801 nfs4_put_state_owner(owner);
802 } else
803 nfs4_do_close(state, gfp_mask, wait);
806 void nfs4_close_state(struct nfs4_state *state, fmode_t fmode)
808 __nfs4_close(state, fmode, GFP_NOFS, 0);
811 void nfs4_close_sync(struct nfs4_state *state, fmode_t fmode)
813 __nfs4_close(state, fmode, GFP_KERNEL, 1);
817 * Search the state->lock_states for an existing lock_owner
818 * that is compatible with either of the given owners.
819 * If the second is non-zero, then the first refers to a Posix-lock
820 * owner (current->files) and the second refers to a flock/OFD
821 * owner (struct file*). In that case, prefer a match for the first
822 * owner.
823 * If both sorts of locks are held on the one file we cannot know
824 * which stateid was intended to be used, so a "correct" choice cannot
825 * be made. Failing that, a "consistent" choice is preferable. The
826 * consistent choice we make is to prefer the first owner, that of a
827 * Posix lock.
829 static struct nfs4_lock_state *
830 __nfs4_find_lock_state(struct nfs4_state *state,
831 fl_owner_t fl_owner, fl_owner_t fl_owner2)
833 struct nfs4_lock_state *pos, *ret = NULL;
834 list_for_each_entry(pos, &state->lock_states, ls_locks) {
835 if (pos->ls_owner == fl_owner) {
836 ret = pos;
837 break;
839 if (pos->ls_owner == fl_owner2)
840 ret = pos;
842 if (ret)
843 refcount_inc(&ret->ls_count);
844 return ret;
848 * Return a compatible lock_state. If no initialized lock_state structure
849 * exists, return an uninitialized one.
852 static struct nfs4_lock_state *nfs4_alloc_lock_state(struct nfs4_state *state, fl_owner_t fl_owner)
854 struct nfs4_lock_state *lsp;
855 struct nfs_server *server = state->owner->so_server;
857 lsp = kzalloc(sizeof(*lsp), GFP_NOFS);
858 if (lsp == NULL)
859 return NULL;
860 nfs4_init_seqid_counter(&lsp->ls_seqid);
861 refcount_set(&lsp->ls_count, 1);
862 lsp->ls_state = state;
863 lsp->ls_owner = fl_owner;
864 lsp->ls_seqid.owner_id = ida_simple_get(&server->lockowner_id, 0, 0, GFP_NOFS);
865 if (lsp->ls_seqid.owner_id < 0)
866 goto out_free;
867 INIT_LIST_HEAD(&lsp->ls_locks);
868 return lsp;
869 out_free:
870 kfree(lsp);
871 return NULL;
874 void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp)
876 ida_simple_remove(&server->lockowner_id, lsp->ls_seqid.owner_id);
877 nfs4_destroy_seqid_counter(&lsp->ls_seqid);
878 kfree(lsp);
882 * Return a compatible lock_state. If no initialized lock_state structure
883 * exists, return an uninitialized one.
886 static struct nfs4_lock_state *nfs4_get_lock_state(struct nfs4_state *state, fl_owner_t owner)
888 struct nfs4_lock_state *lsp, *new = NULL;
890 for(;;) {
891 spin_lock(&state->state_lock);
892 lsp = __nfs4_find_lock_state(state, owner, NULL);
893 if (lsp != NULL)
894 break;
895 if (new != NULL) {
896 list_add(&new->ls_locks, &state->lock_states);
897 set_bit(LK_STATE_IN_USE, &state->flags);
898 lsp = new;
899 new = NULL;
900 break;
902 spin_unlock(&state->state_lock);
903 new = nfs4_alloc_lock_state(state, owner);
904 if (new == NULL)
905 return NULL;
907 spin_unlock(&state->state_lock);
908 if (new != NULL)
909 nfs4_free_lock_state(state->owner->so_server, new);
910 return lsp;
914 * Release reference to lock_state, and free it if we see that
915 * it is no longer in use
917 void nfs4_put_lock_state(struct nfs4_lock_state *lsp)
919 struct nfs_server *server;
920 struct nfs4_state *state;
922 if (lsp == NULL)
923 return;
924 state = lsp->ls_state;
925 if (!refcount_dec_and_lock(&lsp->ls_count, &state->state_lock))
926 return;
927 list_del(&lsp->ls_locks);
928 if (list_empty(&state->lock_states))
929 clear_bit(LK_STATE_IN_USE, &state->flags);
930 spin_unlock(&state->state_lock);
931 server = state->owner->so_server;
932 if (test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags)) {
933 struct nfs_client *clp = server->nfs_client;
935 clp->cl_mvops->free_lock_state(server, lsp);
936 } else
937 nfs4_free_lock_state(server, lsp);
940 static void nfs4_fl_copy_lock(struct file_lock *dst, struct file_lock *src)
942 struct nfs4_lock_state *lsp = src->fl_u.nfs4_fl.owner;
944 dst->fl_u.nfs4_fl.owner = lsp;
945 refcount_inc(&lsp->ls_count);
948 static void nfs4_fl_release_lock(struct file_lock *fl)
950 nfs4_put_lock_state(fl->fl_u.nfs4_fl.owner);
953 static const struct file_lock_operations nfs4_fl_lock_ops = {
954 .fl_copy_lock = nfs4_fl_copy_lock,
955 .fl_release_private = nfs4_fl_release_lock,
958 int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl)
960 struct nfs4_lock_state *lsp;
962 if (fl->fl_ops != NULL)
963 return 0;
964 lsp = nfs4_get_lock_state(state, fl->fl_owner);
965 if (lsp == NULL)
966 return -ENOMEM;
967 fl->fl_u.nfs4_fl.owner = lsp;
968 fl->fl_ops = &nfs4_fl_lock_ops;
969 return 0;
972 static int nfs4_copy_lock_stateid(nfs4_stateid *dst,
973 struct nfs4_state *state,
974 const struct nfs_lock_context *l_ctx)
976 struct nfs4_lock_state *lsp;
977 fl_owner_t fl_owner, fl_flock_owner;
978 int ret = -ENOENT;
980 if (l_ctx == NULL)
981 goto out;
983 if (test_bit(LK_STATE_IN_USE, &state->flags) == 0)
984 goto out;
986 fl_owner = l_ctx->lockowner;
987 fl_flock_owner = l_ctx->open_context->flock_owner;
989 spin_lock(&state->state_lock);
990 lsp = __nfs4_find_lock_state(state, fl_owner, fl_flock_owner);
991 if (lsp && test_bit(NFS_LOCK_LOST, &lsp->ls_flags))
992 ret = -EIO;
993 else if (lsp != NULL && test_bit(NFS_LOCK_INITIALIZED, &lsp->ls_flags) != 0) {
994 nfs4_stateid_copy(dst, &lsp->ls_stateid);
995 ret = 0;
997 spin_unlock(&state->state_lock);
998 nfs4_put_lock_state(lsp);
999 out:
1000 return ret;
1003 bool nfs4_refresh_open_stateid(nfs4_stateid *dst, struct nfs4_state *state)
1005 bool ret;
1006 int seq;
1008 do {
1009 ret = false;
1010 seq = read_seqbegin(&state->seqlock);
1011 if (nfs4_state_match_open_stateid_other(state, dst)) {
1012 dst->seqid = state->open_stateid.seqid;
1013 ret = true;
1015 } while (read_seqretry(&state->seqlock, seq));
1016 return ret;
1019 bool nfs4_copy_open_stateid(nfs4_stateid *dst, struct nfs4_state *state)
1021 bool ret;
1022 const nfs4_stateid *src;
1023 int seq;
1025 do {
1026 ret = false;
1027 src = &zero_stateid;
1028 seq = read_seqbegin(&state->seqlock);
1029 if (test_bit(NFS_OPEN_STATE, &state->flags)) {
1030 src = &state->open_stateid;
1031 ret = true;
1033 nfs4_stateid_copy(dst, src);
1034 } while (read_seqretry(&state->seqlock, seq));
1035 return ret;
1039 * Byte-range lock aware utility to initialize the stateid of read/write
1040 * requests.
1042 int nfs4_select_rw_stateid(struct nfs4_state *state,
1043 fmode_t fmode, const struct nfs_lock_context *l_ctx,
1044 nfs4_stateid *dst, struct rpc_cred **cred)
1046 int ret;
1048 if (!nfs4_valid_open_stateid(state))
1049 return -EIO;
1050 if (cred != NULL)
1051 *cred = NULL;
1052 ret = nfs4_copy_lock_stateid(dst, state, l_ctx);
1053 if (ret == -EIO)
1054 /* A lost lock - don't even consider delegations */
1055 goto out;
1056 /* returns true if delegation stateid found and copied */
1057 if (nfs4_copy_delegation_stateid(state->inode, fmode, dst, cred)) {
1058 ret = 0;
1059 goto out;
1061 if (ret != -ENOENT)
1062 /* nfs4_copy_delegation_stateid() didn't over-write
1063 * dst, so it still has the lock stateid which we now
1064 * choose to use.
1066 goto out;
1067 nfs4_copy_open_stateid(dst, state);
1068 ret = 0;
1069 out:
1070 if (nfs_server_capable(state->inode, NFS_CAP_STATEID_NFSV41))
1071 dst->seqid = 0;
1072 return ret;
1075 struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask)
1077 struct nfs_seqid *new;
1079 new = kmalloc(sizeof(*new), gfp_mask);
1080 if (new == NULL)
1081 return ERR_PTR(-ENOMEM);
1082 new->sequence = counter;
1083 INIT_LIST_HEAD(&new->list);
1084 new->task = NULL;
1085 return new;
1088 void nfs_release_seqid(struct nfs_seqid *seqid)
1090 struct nfs_seqid_counter *sequence;
1092 if (seqid == NULL || list_empty(&seqid->list))
1093 return;
1094 sequence = seqid->sequence;
1095 spin_lock(&sequence->lock);
1096 list_del_init(&seqid->list);
1097 if (!list_empty(&sequence->list)) {
1098 struct nfs_seqid *next;
1100 next = list_first_entry(&sequence->list,
1101 struct nfs_seqid, list);
1102 rpc_wake_up_queued_task(&sequence->wait, next->task);
1104 spin_unlock(&sequence->lock);
1107 void nfs_free_seqid(struct nfs_seqid *seqid)
1109 nfs_release_seqid(seqid);
1110 kfree(seqid);
1114 * Increment the seqid if the OPEN/OPEN_DOWNGRADE/CLOSE succeeded, or
1115 * failed with a seqid incrementing error -
1116 * see comments nfs4.h:seqid_mutating_error()
1118 static void nfs_increment_seqid(int status, struct nfs_seqid *seqid)
1120 switch (status) {
1121 case 0:
1122 break;
1123 case -NFS4ERR_BAD_SEQID:
1124 if (seqid->sequence->flags & NFS_SEQID_CONFIRMED)
1125 return;
1126 pr_warn_ratelimited("NFS: v4 server returned a bad"
1127 " sequence-id error on an"
1128 " unconfirmed sequence %p!\n",
1129 seqid->sequence);
1130 case -NFS4ERR_STALE_CLIENTID:
1131 case -NFS4ERR_STALE_STATEID:
1132 case -NFS4ERR_BAD_STATEID:
1133 case -NFS4ERR_BADXDR:
1134 case -NFS4ERR_RESOURCE:
1135 case -NFS4ERR_NOFILEHANDLE:
1136 case -NFS4ERR_MOVED:
1137 /* Non-seqid mutating errors */
1138 return;
1141 * Note: no locking needed as we are guaranteed to be first
1142 * on the sequence list
1144 seqid->sequence->counter++;
1147 void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid)
1149 struct nfs4_state_owner *sp;
1151 if (seqid == NULL)
1152 return;
1154 sp = container_of(seqid->sequence, struct nfs4_state_owner, so_seqid);
1155 if (status == -NFS4ERR_BAD_SEQID)
1156 nfs4_reset_state_owner(sp);
1157 if (!nfs4_has_session(sp->so_server->nfs_client))
1158 nfs_increment_seqid(status, seqid);
1162 * Increment the seqid if the LOCK/LOCKU succeeded, or
1163 * failed with a seqid incrementing error -
1164 * see comments nfs4.h:seqid_mutating_error()
1166 void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid)
1168 if (seqid != NULL)
1169 nfs_increment_seqid(status, seqid);
1172 int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task)
1174 struct nfs_seqid_counter *sequence;
1175 int status = 0;
1177 if (seqid == NULL)
1178 goto out;
1179 sequence = seqid->sequence;
1180 spin_lock(&sequence->lock);
1181 seqid->task = task;
1182 if (list_empty(&seqid->list))
1183 list_add_tail(&seqid->list, &sequence->list);
1184 if (list_first_entry(&sequence->list, struct nfs_seqid, list) == seqid)
1185 goto unlock;
1186 rpc_sleep_on(&sequence->wait, task, NULL);
1187 status = -EAGAIN;
1188 unlock:
1189 spin_unlock(&sequence->lock);
1190 out:
1191 return status;
1194 static int nfs4_run_state_manager(void *);
1196 static void nfs4_clear_state_manager_bit(struct nfs_client *clp)
1198 smp_mb__before_atomic();
1199 clear_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state);
1200 smp_mb__after_atomic();
1201 wake_up_bit(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING);
1202 rpc_wake_up(&clp->cl_rpcwaitq);
1206 * Schedule the nfs_client asynchronous state management routine
1208 void nfs4_schedule_state_manager(struct nfs_client *clp)
1210 struct task_struct *task;
1211 char buf[INET6_ADDRSTRLEN + sizeof("-manager") + 1];
1213 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
1214 return;
1215 __module_get(THIS_MODULE);
1216 refcount_inc(&clp->cl_count);
1218 /* The rcu_read_lock() is not strictly necessary, as the state
1219 * manager is the only thread that ever changes the rpc_xprt
1220 * after it's initialized. At this point, we're single threaded. */
1221 rcu_read_lock();
1222 snprintf(buf, sizeof(buf), "%s-manager",
1223 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_ADDR));
1224 rcu_read_unlock();
1225 task = kthread_run(nfs4_run_state_manager, clp, "%s", buf);
1226 if (IS_ERR(task)) {
1227 printk(KERN_ERR "%s: kthread_run: %ld\n",
1228 __func__, PTR_ERR(task));
1229 nfs4_clear_state_manager_bit(clp);
1230 nfs_put_client(clp);
1231 module_put(THIS_MODULE);
1236 * Schedule a lease recovery attempt
1238 void nfs4_schedule_lease_recovery(struct nfs_client *clp)
1240 if (!clp)
1241 return;
1242 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1243 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1244 dprintk("%s: scheduling lease recovery for server %s\n", __func__,
1245 clp->cl_hostname);
1246 nfs4_schedule_state_manager(clp);
1248 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_recovery);
1251 * nfs4_schedule_migration_recovery - trigger migration recovery
1253 * @server: FSID that is migrating
1255 * Returns zero if recovery has started, otherwise a negative NFS4ERR
1256 * value is returned.
1258 int nfs4_schedule_migration_recovery(const struct nfs_server *server)
1260 struct nfs_client *clp = server->nfs_client;
1262 if (server->fh_expire_type != NFS4_FH_PERSISTENT) {
1263 pr_err("NFS: volatile file handles not supported (server %s)\n",
1264 clp->cl_hostname);
1265 return -NFS4ERR_IO;
1268 if (test_bit(NFS_MIG_FAILED, &server->mig_status))
1269 return -NFS4ERR_IO;
1271 dprintk("%s: scheduling migration recovery for (%llx:%llx) on %s\n",
1272 __func__,
1273 (unsigned long long)server->fsid.major,
1274 (unsigned long long)server->fsid.minor,
1275 clp->cl_hostname);
1277 set_bit(NFS_MIG_IN_TRANSITION,
1278 &((struct nfs_server *)server)->mig_status);
1279 set_bit(NFS4CLNT_MOVED, &clp->cl_state);
1281 nfs4_schedule_state_manager(clp);
1282 return 0;
1284 EXPORT_SYMBOL_GPL(nfs4_schedule_migration_recovery);
1287 * nfs4_schedule_lease_moved_recovery - start lease-moved recovery
1289 * @clp: server to check for moved leases
1292 void nfs4_schedule_lease_moved_recovery(struct nfs_client *clp)
1294 dprintk("%s: scheduling lease-moved recovery for client ID %llx on %s\n",
1295 __func__, clp->cl_clientid, clp->cl_hostname);
1297 set_bit(NFS4CLNT_LEASE_MOVED, &clp->cl_state);
1298 nfs4_schedule_state_manager(clp);
1300 EXPORT_SYMBOL_GPL(nfs4_schedule_lease_moved_recovery);
1302 int nfs4_wait_clnt_recover(struct nfs_client *clp)
1304 int res;
1306 might_sleep();
1308 refcount_inc(&clp->cl_count);
1309 res = wait_on_bit_action(&clp->cl_state, NFS4CLNT_MANAGER_RUNNING,
1310 nfs_wait_bit_killable, TASK_KILLABLE);
1311 if (res)
1312 goto out;
1313 if (clp->cl_cons_state < 0)
1314 res = clp->cl_cons_state;
1315 out:
1316 nfs_put_client(clp);
1317 return res;
1320 int nfs4_client_recover_expired_lease(struct nfs_client *clp)
1322 unsigned int loop;
1323 int ret;
1325 for (loop = NFS4_MAX_LOOP_ON_RECOVER; loop != 0; loop--) {
1326 ret = nfs4_wait_clnt_recover(clp);
1327 if (ret != 0)
1328 break;
1329 if (!test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) &&
1330 !test_bit(NFS4CLNT_CHECK_LEASE,&clp->cl_state))
1331 break;
1332 nfs4_schedule_state_manager(clp);
1333 ret = -EIO;
1335 return ret;
1339 * nfs40_handle_cb_pathdown - return all delegations after NFS4ERR_CB_PATH_DOWN
1340 * @clp: client to process
1342 * Set the NFS4CLNT_LEASE_EXPIRED state in order to force a
1343 * resend of the SETCLIENTID and hence re-establish the
1344 * callback channel. Then return all existing delegations.
1346 static void nfs40_handle_cb_pathdown(struct nfs_client *clp)
1348 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1349 nfs_expire_all_delegations(clp);
1350 dprintk("%s: handling CB_PATHDOWN recovery for server %s\n", __func__,
1351 clp->cl_hostname);
1354 void nfs4_schedule_path_down_recovery(struct nfs_client *clp)
1356 nfs40_handle_cb_pathdown(clp);
1357 nfs4_schedule_state_manager(clp);
1360 static int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state)
1363 if (!nfs4_valid_open_stateid(state))
1364 return 0;
1365 set_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1366 /* Don't recover state that expired before the reboot */
1367 if (test_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags)) {
1368 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1369 return 0;
1371 set_bit(NFS_OWNER_RECLAIM_REBOOT, &state->owner->so_flags);
1372 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1373 return 1;
1376 int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state)
1378 if (!nfs4_valid_open_stateid(state))
1379 return 0;
1380 set_bit(NFS_STATE_RECLAIM_NOGRACE, &state->flags);
1381 clear_bit(NFS_STATE_RECLAIM_REBOOT, &state->flags);
1382 set_bit(NFS_OWNER_RECLAIM_NOGRACE, &state->owner->so_flags);
1383 set_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state);
1384 return 1;
1387 int nfs4_schedule_stateid_recovery(const struct nfs_server *server, struct nfs4_state *state)
1389 struct nfs_client *clp = server->nfs_client;
1391 if (!nfs4_state_mark_reclaim_nograce(clp, state))
1392 return -EBADF;
1393 dprintk("%s: scheduling stateid recovery for server %s\n", __func__,
1394 clp->cl_hostname);
1395 nfs4_schedule_state_manager(clp);
1396 return 0;
1398 EXPORT_SYMBOL_GPL(nfs4_schedule_stateid_recovery);
1400 static struct nfs4_lock_state *
1401 nfs_state_find_lock_state_by_stateid(struct nfs4_state *state,
1402 const nfs4_stateid *stateid)
1404 struct nfs4_lock_state *pos;
1406 list_for_each_entry(pos, &state->lock_states, ls_locks) {
1407 if (!test_bit(NFS_LOCK_INITIALIZED, &pos->ls_flags))
1408 continue;
1409 if (nfs4_stateid_match_other(&pos->ls_stateid, stateid))
1410 return pos;
1412 return NULL;
1415 static bool nfs_state_lock_state_matches_stateid(struct nfs4_state *state,
1416 const nfs4_stateid *stateid)
1418 bool found = false;
1420 if (test_bit(LK_STATE_IN_USE, &state->flags)) {
1421 spin_lock(&state->state_lock);
1422 if (nfs_state_find_lock_state_by_stateid(state, stateid))
1423 found = true;
1424 spin_unlock(&state->state_lock);
1426 return found;
1429 void nfs_inode_find_state_and_recover(struct inode *inode,
1430 const nfs4_stateid *stateid)
1432 struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
1433 struct nfs_inode *nfsi = NFS_I(inode);
1434 struct nfs_open_context *ctx;
1435 struct nfs4_state *state;
1436 bool found = false;
1438 spin_lock(&inode->i_lock);
1439 list_for_each_entry(ctx, &nfsi->open_files, list) {
1440 state = ctx->state;
1441 if (state == NULL)
1442 continue;
1443 if (nfs4_stateid_match_other(&state->stateid, stateid) &&
1444 nfs4_state_mark_reclaim_nograce(clp, state)) {
1445 found = true;
1446 continue;
1448 if (nfs4_stateid_match_other(&state->open_stateid, stateid) &&
1449 nfs4_state_mark_reclaim_nograce(clp, state)) {
1450 found = true;
1451 continue;
1453 if (nfs_state_lock_state_matches_stateid(state, stateid) &&
1454 nfs4_state_mark_reclaim_nograce(clp, state))
1455 found = true;
1457 spin_unlock(&inode->i_lock);
1459 nfs_inode_find_delegation_state_and_recover(inode, stateid);
1460 if (found)
1461 nfs4_schedule_state_manager(clp);
1464 static void nfs4_state_mark_open_context_bad(struct nfs4_state *state)
1466 struct inode *inode = state->inode;
1467 struct nfs_inode *nfsi = NFS_I(inode);
1468 struct nfs_open_context *ctx;
1470 spin_lock(&inode->i_lock);
1471 list_for_each_entry(ctx, &nfsi->open_files, list) {
1472 if (ctx->state != state)
1473 continue;
1474 set_bit(NFS_CONTEXT_BAD, &ctx->flags);
1476 spin_unlock(&inode->i_lock);
1479 static void nfs4_state_mark_recovery_failed(struct nfs4_state *state, int error)
1481 set_bit(NFS_STATE_RECOVERY_FAILED, &state->flags);
1482 nfs4_state_mark_open_context_bad(state);
1486 static int nfs4_reclaim_locks(struct nfs4_state *state, const struct nfs4_state_recovery_ops *ops)
1488 struct inode *inode = state->inode;
1489 struct nfs_inode *nfsi = NFS_I(inode);
1490 struct file_lock *fl;
1491 struct nfs4_lock_state *lsp;
1492 int status = 0;
1493 struct file_lock_context *flctx = inode->i_flctx;
1494 struct list_head *list;
1496 if (flctx == NULL)
1497 return 0;
1499 list = &flctx->flc_posix;
1501 /* Guard against delegation returns and new lock/unlock calls */
1502 down_write(&nfsi->rwsem);
1503 spin_lock(&flctx->flc_lock);
1504 restart:
1505 list_for_each_entry(fl, list, fl_list) {
1506 if (nfs_file_open_context(fl->fl_file)->state != state)
1507 continue;
1508 spin_unlock(&flctx->flc_lock);
1509 status = ops->recover_lock(state, fl);
1510 switch (status) {
1511 case 0:
1512 break;
1513 case -ESTALE:
1514 case -NFS4ERR_ADMIN_REVOKED:
1515 case -NFS4ERR_STALE_STATEID:
1516 case -NFS4ERR_BAD_STATEID:
1517 case -NFS4ERR_EXPIRED:
1518 case -NFS4ERR_NO_GRACE:
1519 case -NFS4ERR_STALE_CLIENTID:
1520 case -NFS4ERR_BADSESSION:
1521 case -NFS4ERR_BADSLOT:
1522 case -NFS4ERR_BAD_HIGH_SLOT:
1523 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1524 goto out;
1525 default:
1526 pr_err("NFS: %s: unhandled error %d\n",
1527 __func__, status);
1528 case -ENOMEM:
1529 case -NFS4ERR_DENIED:
1530 case -NFS4ERR_RECLAIM_BAD:
1531 case -NFS4ERR_RECLAIM_CONFLICT:
1532 lsp = fl->fl_u.nfs4_fl.owner;
1533 if (lsp)
1534 set_bit(NFS_LOCK_LOST, &lsp->ls_flags);
1535 status = 0;
1537 spin_lock(&flctx->flc_lock);
1539 if (list == &flctx->flc_posix) {
1540 list = &flctx->flc_flock;
1541 goto restart;
1543 spin_unlock(&flctx->flc_lock);
1544 out:
1545 up_write(&nfsi->rwsem);
1546 return status;
1549 static int nfs4_reclaim_open_state(struct nfs4_state_owner *sp, const struct nfs4_state_recovery_ops *ops)
1551 struct nfs4_state *state;
1552 struct nfs4_lock_state *lock;
1553 int status = 0;
1555 /* Note: we rely on the sp->so_states list being ordered
1556 * so that we always reclaim open(O_RDWR) and/or open(O_WRITE)
1557 * states first.
1558 * This is needed to ensure that the server won't give us any
1559 * read delegations that we have to return if, say, we are
1560 * recovering after a network partition or a reboot from a
1561 * server that doesn't support a grace period.
1563 spin_lock(&sp->so_lock);
1564 raw_write_seqcount_begin(&sp->so_reclaim_seqcount);
1565 restart:
1566 list_for_each_entry(state, &sp->so_states, open_states) {
1567 if (!test_and_clear_bit(ops->state_flag_bit, &state->flags))
1568 continue;
1569 if (!nfs4_valid_open_stateid(state))
1570 continue;
1571 if (state->state == 0)
1572 continue;
1573 atomic_inc(&state->count);
1574 spin_unlock(&sp->so_lock);
1575 status = ops->recover_open(sp, state);
1576 if (status >= 0) {
1577 status = nfs4_reclaim_locks(state, ops);
1578 if (status >= 0) {
1579 if (!test_bit(NFS_DELEGATED_STATE, &state->flags)) {
1580 spin_lock(&state->state_lock);
1581 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1582 if (!test_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags))
1583 pr_warn_ratelimited("NFS: "
1584 "%s: Lock reclaim "
1585 "failed!\n", __func__);
1587 spin_unlock(&state->state_lock);
1589 clear_bit(NFS_STATE_RECLAIM_NOGRACE,
1590 &state->flags);
1591 nfs4_put_open_state(state);
1592 spin_lock(&sp->so_lock);
1593 goto restart;
1596 switch (status) {
1597 default:
1598 printk(KERN_ERR "NFS: %s: unhandled error %d\n",
1599 __func__, status);
1600 case -ENOENT:
1601 case -ENOMEM:
1602 case -EACCES:
1603 case -EROFS:
1604 case -EIO:
1605 case -ESTALE:
1606 /* Open state on this file cannot be recovered */
1607 nfs4_state_mark_recovery_failed(state, status);
1608 break;
1609 case -EAGAIN:
1610 ssleep(1);
1611 case -NFS4ERR_ADMIN_REVOKED:
1612 case -NFS4ERR_STALE_STATEID:
1613 case -NFS4ERR_OLD_STATEID:
1614 case -NFS4ERR_BAD_STATEID:
1615 case -NFS4ERR_RECLAIM_BAD:
1616 case -NFS4ERR_RECLAIM_CONFLICT:
1617 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1618 break;
1619 case -NFS4ERR_EXPIRED:
1620 case -NFS4ERR_NO_GRACE:
1621 nfs4_state_mark_reclaim_nograce(sp->so_server->nfs_client, state);
1622 case -NFS4ERR_STALE_CLIENTID:
1623 case -NFS4ERR_BADSESSION:
1624 case -NFS4ERR_BADSLOT:
1625 case -NFS4ERR_BAD_HIGH_SLOT:
1626 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1627 goto out_err;
1629 nfs4_put_open_state(state);
1630 spin_lock(&sp->so_lock);
1631 goto restart;
1633 raw_write_seqcount_end(&sp->so_reclaim_seqcount);
1634 spin_unlock(&sp->so_lock);
1635 return 0;
1636 out_err:
1637 nfs4_put_open_state(state);
1638 spin_lock(&sp->so_lock);
1639 raw_write_seqcount_end(&sp->so_reclaim_seqcount);
1640 spin_unlock(&sp->so_lock);
1641 return status;
1644 static void nfs4_clear_open_state(struct nfs4_state *state)
1646 struct nfs4_lock_state *lock;
1648 clear_bit(NFS_DELEGATED_STATE, &state->flags);
1649 clear_bit(NFS_O_RDONLY_STATE, &state->flags);
1650 clear_bit(NFS_O_WRONLY_STATE, &state->flags);
1651 clear_bit(NFS_O_RDWR_STATE, &state->flags);
1652 spin_lock(&state->state_lock);
1653 list_for_each_entry(lock, &state->lock_states, ls_locks) {
1654 lock->ls_seqid.flags = 0;
1655 clear_bit(NFS_LOCK_INITIALIZED, &lock->ls_flags);
1657 spin_unlock(&state->state_lock);
1660 static void nfs4_reset_seqids(struct nfs_server *server,
1661 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1663 struct nfs_client *clp = server->nfs_client;
1664 struct nfs4_state_owner *sp;
1665 struct rb_node *pos;
1666 struct nfs4_state *state;
1668 spin_lock(&clp->cl_lock);
1669 for (pos = rb_first(&server->state_owners);
1670 pos != NULL;
1671 pos = rb_next(pos)) {
1672 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1673 sp->so_seqid.flags = 0;
1674 spin_lock(&sp->so_lock);
1675 list_for_each_entry(state, &sp->so_states, open_states) {
1676 if (mark_reclaim(clp, state))
1677 nfs4_clear_open_state(state);
1679 spin_unlock(&sp->so_lock);
1681 spin_unlock(&clp->cl_lock);
1684 static void nfs4_state_mark_reclaim_helper(struct nfs_client *clp,
1685 int (*mark_reclaim)(struct nfs_client *clp, struct nfs4_state *state))
1687 struct nfs_server *server;
1689 rcu_read_lock();
1690 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1691 nfs4_reset_seqids(server, mark_reclaim);
1692 rcu_read_unlock();
1695 static void nfs4_state_start_reclaim_reboot(struct nfs_client *clp)
1697 /* Mark all delegations for reclaim */
1698 nfs_delegation_mark_reclaim(clp);
1699 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_reboot);
1702 static int nfs4_reclaim_complete(struct nfs_client *clp,
1703 const struct nfs4_state_recovery_ops *ops,
1704 struct rpc_cred *cred)
1706 /* Notify the server we're done reclaiming our state */
1707 if (ops->reclaim_complete)
1708 return ops->reclaim_complete(clp, cred);
1709 return 0;
1712 static void nfs4_clear_reclaim_server(struct nfs_server *server)
1714 struct nfs_client *clp = server->nfs_client;
1715 struct nfs4_state_owner *sp;
1716 struct rb_node *pos;
1717 struct nfs4_state *state;
1719 spin_lock(&clp->cl_lock);
1720 for (pos = rb_first(&server->state_owners);
1721 pos != NULL;
1722 pos = rb_next(pos)) {
1723 sp = rb_entry(pos, struct nfs4_state_owner, so_server_node);
1724 spin_lock(&sp->so_lock);
1725 list_for_each_entry(state, &sp->so_states, open_states) {
1726 if (!test_and_clear_bit(NFS_STATE_RECLAIM_REBOOT,
1727 &state->flags))
1728 continue;
1729 nfs4_state_mark_reclaim_nograce(clp, state);
1731 spin_unlock(&sp->so_lock);
1733 spin_unlock(&clp->cl_lock);
1736 static int nfs4_state_clear_reclaim_reboot(struct nfs_client *clp)
1738 struct nfs_server *server;
1740 if (!test_and_clear_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state))
1741 return 0;
1743 rcu_read_lock();
1744 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1745 nfs4_clear_reclaim_server(server);
1746 rcu_read_unlock();
1748 nfs_delegation_reap_unclaimed(clp);
1749 return 1;
1752 static void nfs4_state_end_reclaim_reboot(struct nfs_client *clp)
1754 const struct nfs4_state_recovery_ops *ops;
1755 struct rpc_cred *cred;
1756 int err;
1758 if (!nfs4_state_clear_reclaim_reboot(clp))
1759 return;
1760 ops = clp->cl_mvops->reboot_recovery_ops;
1761 cred = nfs4_get_clid_cred(clp);
1762 err = nfs4_reclaim_complete(clp, ops, cred);
1763 put_rpccred(cred);
1764 if (err == -NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
1765 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1768 static void nfs4_state_start_reclaim_nograce(struct nfs_client *clp)
1770 nfs_mark_test_expired_all_delegations(clp);
1771 nfs4_state_mark_reclaim_helper(clp, nfs4_state_mark_reclaim_nograce);
1774 static int nfs4_recovery_handle_error(struct nfs_client *clp, int error)
1776 switch (error) {
1777 case 0:
1778 break;
1779 case -NFS4ERR_CB_PATH_DOWN:
1780 nfs40_handle_cb_pathdown(clp);
1781 break;
1782 case -NFS4ERR_NO_GRACE:
1783 nfs4_state_end_reclaim_reboot(clp);
1784 break;
1785 case -NFS4ERR_STALE_CLIENTID:
1786 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1787 nfs4_state_start_reclaim_reboot(clp);
1788 break;
1789 case -NFS4ERR_EXPIRED:
1790 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1791 nfs4_state_start_reclaim_nograce(clp);
1792 break;
1793 case -NFS4ERR_BADSESSION:
1794 case -NFS4ERR_BADSLOT:
1795 case -NFS4ERR_BAD_HIGH_SLOT:
1796 case -NFS4ERR_DEADSESSION:
1797 case -NFS4ERR_SEQ_FALSE_RETRY:
1798 case -NFS4ERR_SEQ_MISORDERED:
1799 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
1800 /* Zero session reset errors */
1801 break;
1802 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
1803 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
1804 break;
1805 default:
1806 dprintk("%s: failed to handle error %d for server %s\n",
1807 __func__, error, clp->cl_hostname);
1808 return error;
1810 dprintk("%s: handled error %d for server %s\n", __func__, error,
1811 clp->cl_hostname);
1812 return 0;
1815 static int nfs4_do_reclaim(struct nfs_client *clp, const struct nfs4_state_recovery_ops *ops)
1817 struct nfs4_state_owner *sp;
1818 struct nfs_server *server;
1819 struct rb_node *pos;
1820 int status = 0;
1822 restart:
1823 rcu_read_lock();
1824 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
1825 nfs4_purge_state_owners(server);
1826 spin_lock(&clp->cl_lock);
1827 for (pos = rb_first(&server->state_owners);
1828 pos != NULL;
1829 pos = rb_next(pos)) {
1830 sp = rb_entry(pos,
1831 struct nfs4_state_owner, so_server_node);
1832 if (!test_and_clear_bit(ops->owner_flag_bit,
1833 &sp->so_flags))
1834 continue;
1835 if (!atomic_inc_not_zero(&sp->so_count))
1836 continue;
1837 spin_unlock(&clp->cl_lock);
1838 rcu_read_unlock();
1840 status = nfs4_reclaim_open_state(sp, ops);
1841 if (status < 0) {
1842 set_bit(ops->owner_flag_bit, &sp->so_flags);
1843 nfs4_put_state_owner(sp);
1844 status = nfs4_recovery_handle_error(clp, status);
1845 return (status != 0) ? status : -EAGAIN;
1848 nfs4_put_state_owner(sp);
1849 goto restart;
1851 spin_unlock(&clp->cl_lock);
1853 rcu_read_unlock();
1854 return 0;
1857 static int nfs4_check_lease(struct nfs_client *clp)
1859 struct rpc_cred *cred;
1860 const struct nfs4_state_maintenance_ops *ops =
1861 clp->cl_mvops->state_renewal_ops;
1862 int status;
1864 /* Is the client already known to have an expired lease? */
1865 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
1866 return 0;
1867 spin_lock(&clp->cl_lock);
1868 cred = ops->get_state_renewal_cred_locked(clp);
1869 spin_unlock(&clp->cl_lock);
1870 if (cred == NULL) {
1871 cred = nfs4_get_clid_cred(clp);
1872 status = -ENOKEY;
1873 if (cred == NULL)
1874 goto out;
1876 status = ops->renew_lease(clp, cred);
1877 put_rpccred(cred);
1878 if (status == -ETIMEDOUT) {
1879 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1880 return 0;
1882 out:
1883 return nfs4_recovery_handle_error(clp, status);
1886 /* Set NFS4CLNT_LEASE_EXPIRED and reclaim reboot state for all v4.0 errors
1887 * and for recoverable errors on EXCHANGE_ID for v4.1
1889 static int nfs4_handle_reclaim_lease_error(struct nfs_client *clp, int status)
1891 switch (status) {
1892 case -NFS4ERR_SEQ_MISORDERED:
1893 if (test_and_set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state))
1894 return -ESERVERFAULT;
1895 /* Lease confirmation error: retry after purging the lease */
1896 ssleep(1);
1897 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1898 break;
1899 case -NFS4ERR_STALE_CLIENTID:
1900 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1901 nfs4_state_start_reclaim_reboot(clp);
1902 break;
1903 case -NFS4ERR_CLID_INUSE:
1904 pr_err("NFS: Server %s reports our clientid is in use\n",
1905 clp->cl_hostname);
1906 nfs_mark_client_ready(clp, -EPERM);
1907 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
1908 return -EPERM;
1909 case -EACCES:
1910 case -NFS4ERR_DELAY:
1911 case -ETIMEDOUT:
1912 case -EAGAIN:
1913 ssleep(1);
1914 break;
1916 case -NFS4ERR_MINOR_VERS_MISMATCH:
1917 if (clp->cl_cons_state == NFS_CS_SESSION_INITING)
1918 nfs_mark_client_ready(clp, -EPROTONOSUPPORT);
1919 dprintk("%s: exit with error %d for server %s\n",
1920 __func__, -EPROTONOSUPPORT, clp->cl_hostname);
1921 return -EPROTONOSUPPORT;
1922 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
1923 * in nfs4_exchange_id */
1924 default:
1925 dprintk("%s: exit with error %d for server %s\n", __func__,
1926 status, clp->cl_hostname);
1927 return status;
1929 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1930 dprintk("%s: handled error %d for server %s\n", __func__, status,
1931 clp->cl_hostname);
1932 return 0;
1935 static int nfs4_establish_lease(struct nfs_client *clp)
1937 struct rpc_cred *cred;
1938 const struct nfs4_state_recovery_ops *ops =
1939 clp->cl_mvops->reboot_recovery_ops;
1940 int status;
1942 nfs4_begin_drain_session(clp);
1943 cred = nfs4_get_clid_cred(clp);
1944 if (cred == NULL)
1945 return -ENOENT;
1946 status = ops->establish_clid(clp, cred);
1947 put_rpccred(cred);
1948 if (status != 0)
1949 return status;
1950 pnfs_destroy_all_layouts(clp);
1951 return 0;
1955 * Returns zero or a negative errno. NFS4ERR values are converted
1956 * to local errno values.
1958 static int nfs4_reclaim_lease(struct nfs_client *clp)
1960 int status;
1962 status = nfs4_establish_lease(clp);
1963 if (status < 0)
1964 return nfs4_handle_reclaim_lease_error(clp, status);
1965 if (test_and_clear_bit(NFS4CLNT_SERVER_SCOPE_MISMATCH, &clp->cl_state))
1966 nfs4_state_start_reclaim_nograce(clp);
1967 if (!test_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state))
1968 set_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state);
1969 clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
1970 clear_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1971 return 0;
1974 static int nfs4_purge_lease(struct nfs_client *clp)
1976 int status;
1978 status = nfs4_establish_lease(clp);
1979 if (status < 0)
1980 return nfs4_handle_reclaim_lease_error(clp, status);
1981 clear_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
1982 set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state);
1983 nfs4_state_start_reclaim_nograce(clp);
1984 return 0;
1988 * Try remote migration of one FSID from a source server to a
1989 * destination server. The source server provides a list of
1990 * potential destinations.
1992 * Returns zero or a negative NFS4ERR status code.
1994 static int nfs4_try_migration(struct nfs_server *server, struct rpc_cred *cred)
1996 struct nfs_client *clp = server->nfs_client;
1997 struct nfs4_fs_locations *locations = NULL;
1998 struct inode *inode;
1999 struct page *page;
2000 int status, result;
2002 dprintk("--> %s: FSID %llx:%llx on \"%s\"\n", __func__,
2003 (unsigned long long)server->fsid.major,
2004 (unsigned long long)server->fsid.minor,
2005 clp->cl_hostname);
2007 result = 0;
2008 page = alloc_page(GFP_KERNEL);
2009 locations = kmalloc(sizeof(struct nfs4_fs_locations), GFP_KERNEL);
2010 if (page == NULL || locations == NULL) {
2011 dprintk("<-- %s: no memory\n", __func__);
2012 goto out;
2015 inode = d_inode(server->super->s_root);
2016 result = nfs4_proc_get_locations(inode, locations, page, cred);
2017 if (result) {
2018 dprintk("<-- %s: failed to retrieve fs_locations: %d\n",
2019 __func__, result);
2020 goto out;
2023 result = -NFS4ERR_NXIO;
2024 if (!(locations->fattr.valid & NFS_ATTR_FATTR_V4_LOCATIONS)) {
2025 dprintk("<-- %s: No fs_locations data, migration skipped\n",
2026 __func__);
2027 goto out;
2030 nfs4_begin_drain_session(clp);
2032 status = nfs4_replace_transport(server, locations);
2033 if (status != 0) {
2034 dprintk("<-- %s: failed to replace transport: %d\n",
2035 __func__, status);
2036 goto out;
2039 result = 0;
2040 dprintk("<-- %s: migration succeeded\n", __func__);
2042 out:
2043 if (page != NULL)
2044 __free_page(page);
2045 kfree(locations);
2046 if (result) {
2047 pr_err("NFS: migration recovery failed (server %s)\n",
2048 clp->cl_hostname);
2049 set_bit(NFS_MIG_FAILED, &server->mig_status);
2051 return result;
2055 * Returns zero or a negative NFS4ERR status code.
2057 static int nfs4_handle_migration(struct nfs_client *clp)
2059 const struct nfs4_state_maintenance_ops *ops =
2060 clp->cl_mvops->state_renewal_ops;
2061 struct nfs_server *server;
2062 struct rpc_cred *cred;
2064 dprintk("%s: migration reported on \"%s\"\n", __func__,
2065 clp->cl_hostname);
2067 spin_lock(&clp->cl_lock);
2068 cred = ops->get_state_renewal_cred_locked(clp);
2069 spin_unlock(&clp->cl_lock);
2070 if (cred == NULL)
2071 return -NFS4ERR_NOENT;
2073 clp->cl_mig_gen++;
2074 restart:
2075 rcu_read_lock();
2076 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
2077 int status;
2079 if (server->mig_gen == clp->cl_mig_gen)
2080 continue;
2081 server->mig_gen = clp->cl_mig_gen;
2083 if (!test_and_clear_bit(NFS_MIG_IN_TRANSITION,
2084 &server->mig_status))
2085 continue;
2087 rcu_read_unlock();
2088 status = nfs4_try_migration(server, cred);
2089 if (status < 0) {
2090 put_rpccred(cred);
2091 return status;
2093 goto restart;
2095 rcu_read_unlock();
2096 put_rpccred(cred);
2097 return 0;
2101 * Test each nfs_server on the clp's cl_superblocks list to see
2102 * if it's moved to another server. Stop when the server no longer
2103 * returns NFS4ERR_LEASE_MOVED.
2105 static int nfs4_handle_lease_moved(struct nfs_client *clp)
2107 const struct nfs4_state_maintenance_ops *ops =
2108 clp->cl_mvops->state_renewal_ops;
2109 struct nfs_server *server;
2110 struct rpc_cred *cred;
2112 dprintk("%s: lease moved reported on \"%s\"\n", __func__,
2113 clp->cl_hostname);
2115 spin_lock(&clp->cl_lock);
2116 cred = ops->get_state_renewal_cred_locked(clp);
2117 spin_unlock(&clp->cl_lock);
2118 if (cred == NULL)
2119 return -NFS4ERR_NOENT;
2121 clp->cl_mig_gen++;
2122 restart:
2123 rcu_read_lock();
2124 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
2125 struct inode *inode;
2126 int status;
2128 if (server->mig_gen == clp->cl_mig_gen)
2129 continue;
2130 server->mig_gen = clp->cl_mig_gen;
2132 rcu_read_unlock();
2134 inode = d_inode(server->super->s_root);
2135 status = nfs4_proc_fsid_present(inode, cred);
2136 if (status != -NFS4ERR_MOVED)
2137 goto restart; /* wasn't this one */
2138 if (nfs4_try_migration(server, cred) == -NFS4ERR_LEASE_MOVED)
2139 goto restart; /* there are more */
2140 goto out;
2142 rcu_read_unlock();
2144 out:
2145 put_rpccred(cred);
2146 return 0;
2150 * nfs4_discover_server_trunking - Detect server IP address trunking
2152 * @clp: nfs_client under test
2153 * @result: OUT: found nfs_client, or clp
2155 * Returns zero or a negative errno. If zero is returned,
2156 * an nfs_client pointer is planted in "result".
2158 * Note: since we are invoked in process context, and
2159 * not from inside the state manager, we cannot use
2160 * nfs4_handle_reclaim_lease_error().
2162 int nfs4_discover_server_trunking(struct nfs_client *clp,
2163 struct nfs_client **result)
2165 const struct nfs4_state_recovery_ops *ops =
2166 clp->cl_mvops->reboot_recovery_ops;
2167 struct rpc_clnt *clnt;
2168 struct rpc_cred *cred;
2169 int i, status;
2171 dprintk("NFS: %s: testing '%s'\n", __func__, clp->cl_hostname);
2173 clnt = clp->cl_rpcclient;
2174 i = 0;
2176 mutex_lock(&nfs_clid_init_mutex);
2177 again:
2178 status = -ENOENT;
2179 cred = nfs4_get_clid_cred(clp);
2180 if (cred == NULL)
2181 goto out_unlock;
2183 status = ops->detect_trunking(clp, result, cred);
2184 put_rpccred(cred);
2185 switch (status) {
2186 case 0:
2187 case -EINTR:
2188 case -ERESTARTSYS:
2189 break;
2190 case -ETIMEDOUT:
2191 if (clnt->cl_softrtry)
2192 break;
2193 case -NFS4ERR_DELAY:
2194 case -EAGAIN:
2195 ssleep(1);
2196 case -NFS4ERR_STALE_CLIENTID:
2197 dprintk("NFS: %s after status %d, retrying\n",
2198 __func__, status);
2199 goto again;
2200 case -EACCES:
2201 if (i++ == 0) {
2202 nfs4_root_machine_cred(clp);
2203 goto again;
2205 if (clnt->cl_auth->au_flavor == RPC_AUTH_UNIX)
2206 break;
2207 case -NFS4ERR_CLID_INUSE:
2208 case -NFS4ERR_WRONGSEC:
2209 /* No point in retrying if we already used RPC_AUTH_UNIX */
2210 if (clnt->cl_auth->au_flavor == RPC_AUTH_UNIX) {
2211 status = -EPERM;
2212 break;
2214 clnt = rpc_clone_client_set_auth(clnt, RPC_AUTH_UNIX);
2215 if (IS_ERR(clnt)) {
2216 status = PTR_ERR(clnt);
2217 break;
2219 /* Note: this is safe because we haven't yet marked the
2220 * client as ready, so we are the only user of
2221 * clp->cl_rpcclient
2223 clnt = xchg(&clp->cl_rpcclient, clnt);
2224 rpc_shutdown_client(clnt);
2225 clnt = clp->cl_rpcclient;
2226 goto again;
2228 case -NFS4ERR_MINOR_VERS_MISMATCH:
2229 status = -EPROTONOSUPPORT;
2230 break;
2232 case -EKEYEXPIRED:
2233 case -NFS4ERR_NOT_SAME: /* FixMe: implement recovery
2234 * in nfs4_exchange_id */
2235 status = -EKEYEXPIRED;
2236 break;
2237 default:
2238 pr_warn("NFS: %s unhandled error %d. Exiting with error EIO\n",
2239 __func__, status);
2240 status = -EIO;
2243 out_unlock:
2244 mutex_unlock(&nfs_clid_init_mutex);
2245 dprintk("NFS: %s: status = %d\n", __func__, status);
2246 return status;
2249 #ifdef CONFIG_NFS_V4_1
2250 void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
2252 struct nfs_client *clp = session->clp;
2254 switch (err) {
2255 default:
2256 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2257 break;
2258 case -NFS4ERR_CONN_NOT_BOUND_TO_SESSION:
2259 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2261 nfs4_schedule_state_manager(clp);
2263 EXPORT_SYMBOL_GPL(nfs4_schedule_session_recovery);
2265 void nfs41_notify_server(struct nfs_client *clp)
2267 /* Use CHECK_LEASE to ping the server with a SEQUENCE */
2268 set_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state);
2269 nfs4_schedule_state_manager(clp);
2272 static void nfs4_reset_all_state(struct nfs_client *clp)
2274 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
2275 set_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state);
2276 clear_bit(NFS4CLNT_LEASE_CONFIRM, &clp->cl_state);
2277 nfs4_state_start_reclaim_nograce(clp);
2278 dprintk("%s: scheduling reset of all state for server %s!\n",
2279 __func__, clp->cl_hostname);
2280 nfs4_schedule_state_manager(clp);
2284 static void nfs41_handle_server_reboot(struct nfs_client *clp)
2286 if (test_and_set_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state) == 0) {
2287 nfs4_state_start_reclaim_reboot(clp);
2288 dprintk("%s: server %s rebooted!\n", __func__,
2289 clp->cl_hostname);
2290 nfs4_schedule_state_manager(clp);
2294 static void nfs41_handle_all_state_revoked(struct nfs_client *clp)
2296 nfs4_reset_all_state(clp);
2297 dprintk("%s: state revoked on server %s\n", __func__, clp->cl_hostname);
2300 static void nfs41_handle_some_state_revoked(struct nfs_client *clp)
2302 nfs4_state_start_reclaim_nograce(clp);
2303 nfs4_schedule_state_manager(clp);
2305 dprintk("%s: state revoked on server %s\n", __func__, clp->cl_hostname);
2308 static void nfs41_handle_recallable_state_revoked(struct nfs_client *clp)
2310 /* FIXME: For now, we destroy all layouts. */
2311 pnfs_destroy_all_layouts(clp);
2312 /* FIXME: For now, we test all delegations+open state+locks. */
2313 nfs41_handle_some_state_revoked(clp);
2314 dprintk("%s: Recallable state revoked on server %s!\n", __func__,
2315 clp->cl_hostname);
2318 static void nfs41_handle_backchannel_fault(struct nfs_client *clp)
2320 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2321 nfs4_schedule_state_manager(clp);
2323 dprintk("%s: server %s declared a backchannel fault\n", __func__,
2324 clp->cl_hostname);
2327 static void nfs41_handle_cb_path_down(struct nfs_client *clp)
2329 if (test_and_set_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2330 &clp->cl_state) == 0)
2331 nfs4_schedule_state_manager(clp);
2334 void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags,
2335 bool recovery)
2337 if (!flags)
2338 return;
2340 dprintk("%s: \"%s\" (client ID %llx) flags=0x%08x\n",
2341 __func__, clp->cl_hostname, clp->cl_clientid, flags);
2343 * If we're called from the state manager thread, then assume we're
2344 * already handling the RECLAIM_NEEDED and/or STATE_REVOKED.
2345 * Those flags are expected to remain set until we're done
2346 * recovering (see RFC5661, section 18.46.3).
2348 if (recovery)
2349 goto out_recovery;
2351 if (flags & SEQ4_STATUS_RESTART_RECLAIM_NEEDED)
2352 nfs41_handle_server_reboot(clp);
2353 if (flags & (SEQ4_STATUS_EXPIRED_ALL_STATE_REVOKED))
2354 nfs41_handle_all_state_revoked(clp);
2355 if (flags & (SEQ4_STATUS_EXPIRED_SOME_STATE_REVOKED |
2356 SEQ4_STATUS_ADMIN_STATE_REVOKED))
2357 nfs41_handle_some_state_revoked(clp);
2358 if (flags & SEQ4_STATUS_LEASE_MOVED)
2359 nfs4_schedule_lease_moved_recovery(clp);
2360 if (flags & SEQ4_STATUS_RECALLABLE_STATE_REVOKED)
2361 nfs41_handle_recallable_state_revoked(clp);
2362 out_recovery:
2363 if (flags & SEQ4_STATUS_BACKCHANNEL_FAULT)
2364 nfs41_handle_backchannel_fault(clp);
2365 else if (flags & (SEQ4_STATUS_CB_PATH_DOWN |
2366 SEQ4_STATUS_CB_PATH_DOWN_SESSION))
2367 nfs41_handle_cb_path_down(clp);
2370 static int nfs4_reset_session(struct nfs_client *clp)
2372 struct rpc_cred *cred;
2373 int status;
2375 if (!nfs4_has_session(clp))
2376 return 0;
2377 nfs4_begin_drain_session(clp);
2378 cred = nfs4_get_clid_cred(clp);
2379 status = nfs4_proc_destroy_session(clp->cl_session, cred);
2380 switch (status) {
2381 case 0:
2382 case -NFS4ERR_BADSESSION:
2383 case -NFS4ERR_DEADSESSION:
2384 break;
2385 case -NFS4ERR_BACK_CHAN_BUSY:
2386 case -NFS4ERR_DELAY:
2387 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
2388 status = 0;
2389 ssleep(1);
2390 goto out;
2391 default:
2392 status = nfs4_recovery_handle_error(clp, status);
2393 goto out;
2396 memset(clp->cl_session->sess_id.data, 0, NFS4_MAX_SESSIONID_LEN);
2397 status = nfs4_proc_create_session(clp, cred);
2398 if (status) {
2399 dprintk("%s: session reset failed with status %d for server %s!\n",
2400 __func__, status, clp->cl_hostname);
2401 status = nfs4_handle_reclaim_lease_error(clp, status);
2402 goto out;
2404 nfs41_finish_session_reset(clp);
2405 dprintk("%s: session reset was successful for server %s!\n",
2406 __func__, clp->cl_hostname);
2407 out:
2408 if (cred)
2409 put_rpccred(cred);
2410 return status;
2413 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2415 struct rpc_cred *cred;
2416 int ret;
2418 if (!nfs4_has_session(clp))
2419 return 0;
2420 nfs4_begin_drain_session(clp);
2421 cred = nfs4_get_clid_cred(clp);
2422 ret = nfs4_proc_bind_conn_to_session(clp, cred);
2423 if (cred)
2424 put_rpccred(cred);
2425 clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2426 switch (ret) {
2427 case 0:
2428 dprintk("%s: bind_conn_to_session was successful for server %s!\n",
2429 __func__, clp->cl_hostname);
2430 break;
2431 case -NFS4ERR_DELAY:
2432 ssleep(1);
2433 set_bit(NFS4CLNT_BIND_CONN_TO_SESSION, &clp->cl_state);
2434 break;
2435 default:
2436 return nfs4_recovery_handle_error(clp, ret);
2438 return 0;
2440 #else /* CONFIG_NFS_V4_1 */
2441 static int nfs4_reset_session(struct nfs_client *clp) { return 0; }
2443 static int nfs4_bind_conn_to_session(struct nfs_client *clp)
2445 return 0;
2447 #endif /* CONFIG_NFS_V4_1 */
2449 static void nfs4_state_manager(struct nfs_client *clp)
2451 int status = 0;
2452 const char *section = "", *section_sep = "";
2454 /* Ensure exclusive access to NFSv4 state */
2455 do {
2456 if (test_bit(NFS4CLNT_PURGE_STATE, &clp->cl_state)) {
2457 section = "purge state";
2458 status = nfs4_purge_lease(clp);
2459 if (status < 0)
2460 goto out_error;
2461 continue;
2464 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state)) {
2465 section = "lease expired";
2466 /* We're going to have to re-establish a clientid */
2467 status = nfs4_reclaim_lease(clp);
2468 if (status < 0)
2469 goto out_error;
2470 continue;
2473 /* Initialize or reset the session */
2474 if (test_and_clear_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state)) {
2475 section = "reset session";
2476 status = nfs4_reset_session(clp);
2477 if (test_bit(NFS4CLNT_LEASE_EXPIRED, &clp->cl_state))
2478 continue;
2479 if (status < 0)
2480 goto out_error;
2483 /* Send BIND_CONN_TO_SESSION */
2484 if (test_and_clear_bit(NFS4CLNT_BIND_CONN_TO_SESSION,
2485 &clp->cl_state)) {
2486 section = "bind conn to session";
2487 status = nfs4_bind_conn_to_session(clp);
2488 if (status < 0)
2489 goto out_error;
2490 continue;
2493 if (test_and_clear_bit(NFS4CLNT_CHECK_LEASE, &clp->cl_state)) {
2494 section = "check lease";
2495 status = nfs4_check_lease(clp);
2496 if (status < 0)
2497 goto out_error;
2498 continue;
2501 if (test_and_clear_bit(NFS4CLNT_MOVED, &clp->cl_state)) {
2502 section = "migration";
2503 status = nfs4_handle_migration(clp);
2504 if (status < 0)
2505 goto out_error;
2508 if (test_and_clear_bit(NFS4CLNT_LEASE_MOVED, &clp->cl_state)) {
2509 section = "lease moved";
2510 status = nfs4_handle_lease_moved(clp);
2511 if (status < 0)
2512 goto out_error;
2515 /* First recover reboot state... */
2516 if (test_bit(NFS4CLNT_RECLAIM_REBOOT, &clp->cl_state)) {
2517 section = "reclaim reboot";
2518 status = nfs4_do_reclaim(clp,
2519 clp->cl_mvops->reboot_recovery_ops);
2520 if (status == -EAGAIN)
2521 continue;
2522 if (status < 0)
2523 goto out_error;
2524 nfs4_state_end_reclaim_reboot(clp);
2527 /* Detect expired delegations... */
2528 if (test_and_clear_bit(NFS4CLNT_DELEGATION_EXPIRED, &clp->cl_state)) {
2529 section = "detect expired delegations";
2530 nfs_reap_expired_delegations(clp);
2531 continue;
2534 /* Now recover expired state... */
2535 if (test_and_clear_bit(NFS4CLNT_RECLAIM_NOGRACE, &clp->cl_state)) {
2536 section = "reclaim nograce";
2537 status = nfs4_do_reclaim(clp,
2538 clp->cl_mvops->nograce_recovery_ops);
2539 if (status == -EAGAIN)
2540 continue;
2541 if (status < 0)
2542 goto out_error;
2545 nfs4_end_drain_session(clp);
2546 if (test_and_clear_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state)) {
2547 nfs_client_return_marked_delegations(clp);
2548 continue;
2551 nfs4_clear_state_manager_bit(clp);
2552 /* Did we race with an attempt to give us more work? */
2553 if (clp->cl_state == 0)
2554 break;
2555 if (test_and_set_bit(NFS4CLNT_MANAGER_RUNNING, &clp->cl_state) != 0)
2556 break;
2557 } while (refcount_read(&clp->cl_count) > 1);
2558 return;
2559 out_error:
2560 if (strlen(section))
2561 section_sep = ": ";
2562 pr_warn_ratelimited("NFS: state manager%s%s failed on NFSv4 server %s"
2563 " with error %d\n", section_sep, section,
2564 clp->cl_hostname, -status);
2565 ssleep(1);
2566 nfs4_end_drain_session(clp);
2567 nfs4_clear_state_manager_bit(clp);
2570 static int nfs4_run_state_manager(void *ptr)
2572 struct nfs_client *clp = ptr;
2574 allow_signal(SIGKILL);
2575 nfs4_state_manager(clp);
2576 nfs_put_client(clp);
2577 module_put_and_exit(0);
2578 return 0;
2582 * Local variables:
2583 * c-basic-offset: 8
2584 * End: