4 * Copyright (c) 2012 Trond Myklebust <Trond.Myklebust@netapp.com>
7 #include <linux/kernel.h>
8 #include <linux/errno.h>
9 #include <linux/string.h>
10 #include <linux/printk.h>
11 #include <linux/slab.h>
12 #include <linux/sunrpc/sched.h>
13 #include <linux/sunrpc/bc_xprt.h>
14 #include <linux/nfs.h>
15 #include <linux/nfs4.h>
16 #include <linux/nfs_fs.h>
17 #include <linux/module.h>
21 #include "nfs4session.h"
24 #define NFSDBG_FACILITY NFSDBG_STATE
26 static void nfs4_init_slot_table(struct nfs4_slot_table
*tbl
, const char *queue
)
28 tbl
->highest_used_slotid
= NFS4_NO_SLOT
;
29 spin_lock_init(&tbl
->slot_tbl_lock
);
30 rpc_init_priority_wait_queue(&tbl
->slot_tbl_waitq
, queue
);
31 init_waitqueue_head(&tbl
->slot_waitq
);
32 init_completion(&tbl
->complete
);
36 * nfs4_shrink_slot_table - free retired slots from the slot table
38 static void nfs4_shrink_slot_table(struct nfs4_slot_table
*tbl
, u32 newsize
)
41 if (newsize
>= tbl
->max_slots
)
48 struct nfs4_slot
*slot
= *p
;
57 * nfs4_slot_tbl_drain_complete - wake waiters when drain is complete
58 * @tbl - controlling slot table
61 void nfs4_slot_tbl_drain_complete(struct nfs4_slot_table
*tbl
)
63 if (nfs4_slot_tbl_draining(tbl
))
64 complete(&tbl
->complete
);
68 * nfs4_free_slot - free a slot and efficiently update slot table.
70 * freeing a slot is trivially done by clearing its respective bit
72 * If the freed slotid equals highest_used_slotid we want to update it
73 * so that the server would be able to size down the slot table if needed,
74 * otherwise we know that the highest_used_slotid is still in use.
75 * When updating highest_used_slotid there may be "holes" in the bitmap
76 * so we need to scan down from highest_used_slotid to 0 looking for the now
77 * highest slotid in use.
78 * If none found, highest_used_slotid is set to NFS4_NO_SLOT.
80 * Must be called while holding tbl->slot_tbl_lock
82 void nfs4_free_slot(struct nfs4_slot_table
*tbl
, struct nfs4_slot
*slot
)
84 u32 slotid
= slot
->slot_nr
;
86 /* clear used bit in bitmap */
87 __clear_bit(slotid
, tbl
->used_slots
);
89 /* update highest_used_slotid when it is freed */
90 if (slotid
== tbl
->highest_used_slotid
) {
91 u32 new_max
= find_last_bit(tbl
->used_slots
, slotid
);
93 tbl
->highest_used_slotid
= new_max
;
95 tbl
->highest_used_slotid
= NFS4_NO_SLOT
;
96 nfs4_slot_tbl_drain_complete(tbl
);
99 dprintk("%s: slotid %u highest_used_slotid %u\n", __func__
,
100 slotid
, tbl
->highest_used_slotid
);
103 static struct nfs4_slot
*nfs4_new_slot(struct nfs4_slot_table
*tbl
,
104 u32 slotid
, u32 seq_init
, gfp_t gfp_mask
)
106 struct nfs4_slot
*slot
;
108 slot
= kzalloc(sizeof(*slot
), gfp_mask
);
111 slot
->slot_nr
= slotid
;
112 slot
->seq_nr
= seq_init
;
117 static struct nfs4_slot
*nfs4_find_or_create_slot(struct nfs4_slot_table
*tbl
,
118 u32 slotid
, u32 seq_init
, gfp_t gfp_mask
)
120 struct nfs4_slot
**p
, *slot
;
125 *p
= nfs4_new_slot(tbl
, tbl
->max_slots
,
132 if (slot
->slot_nr
== slotid
)
136 return ERR_PTR(-ENOMEM
);
139 static void nfs4_lock_slot(struct nfs4_slot_table
*tbl
,
140 struct nfs4_slot
*slot
)
142 u32 slotid
= slot
->slot_nr
;
144 __set_bit(slotid
, tbl
->used_slots
);
145 if (slotid
> tbl
->highest_used_slotid
||
146 tbl
->highest_used_slotid
== NFS4_NO_SLOT
)
147 tbl
->highest_used_slotid
= slotid
;
148 slot
->generation
= tbl
->generation
;
152 * nfs4_try_to_lock_slot - Given a slot try to allocate it
154 * Note: must be called with the slot_tbl_lock held.
156 bool nfs4_try_to_lock_slot(struct nfs4_slot_table
*tbl
, struct nfs4_slot
*slot
)
158 if (nfs4_test_locked_slot(tbl
, slot
->slot_nr
))
160 nfs4_lock_slot(tbl
, slot
);
165 * nfs4_lookup_slot - Find a slot but don't allocate it
167 * Note: must be called with the slot_tbl_lock held.
169 struct nfs4_slot
*nfs4_lookup_slot(struct nfs4_slot_table
*tbl
, u32 slotid
)
171 if (slotid
<= tbl
->max_slotid
)
172 return nfs4_find_or_create_slot(tbl
, slotid
, 1, GFP_NOWAIT
);
173 return ERR_PTR(-E2BIG
);
176 static int nfs4_slot_get_seqid(struct nfs4_slot_table
*tbl
, u32 slotid
,
178 __must_hold(&tbl
->slot_tbl_lock
)
180 struct nfs4_slot
*slot
;
182 slot
= nfs4_lookup_slot(tbl
, slotid
);
184 return PTR_ERR(slot
);
185 *seq_nr
= slot
->seq_nr
;
190 * nfs4_slot_seqid_in_use - test if a slot sequence id is still in use
192 * Given a slot table, slot id and sequence number, determine if the
193 * RPC call in question is still in flight. This function is mainly
194 * intended for use by the callback channel.
196 static bool nfs4_slot_seqid_in_use(struct nfs4_slot_table
*tbl
,
197 u32 slotid
, u32 seq_nr
)
202 spin_lock(&tbl
->slot_tbl_lock
);
203 if (nfs4_slot_get_seqid(tbl
, slotid
, &cur_seq
) == 0 &&
204 cur_seq
== seq_nr
&& test_bit(slotid
, tbl
->used_slots
))
206 spin_unlock(&tbl
->slot_tbl_lock
);
211 * nfs4_slot_wait_on_seqid - wait until a slot sequence id is complete
213 * Given a slot table, slot id and sequence number, wait until the
214 * corresponding RPC call completes. This function is mainly
215 * intended for use by the callback channel.
217 int nfs4_slot_wait_on_seqid(struct nfs4_slot_table
*tbl
,
218 u32 slotid
, u32 seq_nr
,
219 unsigned long timeout
)
221 if (wait_event_timeout(tbl
->slot_waitq
,
222 !nfs4_slot_seqid_in_use(tbl
, slotid
, seq_nr
),
229 * nfs4_alloc_slot - efficiently look for a free slot
231 * nfs4_alloc_slot looks for an unset bit in the used_slots bitmap.
232 * If found, we mark the slot as used, update the highest_used_slotid,
233 * and respectively set up the sequence operation args.
235 * Note: must be called with under the slot_tbl_lock.
237 struct nfs4_slot
*nfs4_alloc_slot(struct nfs4_slot_table
*tbl
)
239 struct nfs4_slot
*ret
= ERR_PTR(-EBUSY
);
242 dprintk("--> %s used_slots=%04lx highest_used=%u max_slots=%u\n",
243 __func__
, tbl
->used_slots
[0], tbl
->highest_used_slotid
,
244 tbl
->max_slotid
+ 1);
245 slotid
= find_first_zero_bit(tbl
->used_slots
, tbl
->max_slotid
+ 1);
246 if (slotid
<= tbl
->max_slotid
) {
247 ret
= nfs4_find_or_create_slot(tbl
, slotid
, 1, GFP_NOWAIT
);
249 nfs4_lock_slot(tbl
, ret
);
251 dprintk("<-- %s used_slots=%04lx highest_used=%u slotid=%u\n",
252 __func__
, tbl
->used_slots
[0], tbl
->highest_used_slotid
,
253 !IS_ERR(ret
) ? ret
->slot_nr
: NFS4_NO_SLOT
);
257 static int nfs4_grow_slot_table(struct nfs4_slot_table
*tbl
,
258 u32 max_reqs
, u32 ivalue
)
260 if (max_reqs
<= tbl
->max_slots
)
262 if (!IS_ERR(nfs4_find_or_create_slot(tbl
, max_reqs
- 1, ivalue
, GFP_NOFS
)))
267 static void nfs4_reset_slot_table(struct nfs4_slot_table
*tbl
,
268 u32 server_highest_slotid
,
271 struct nfs4_slot
**p
;
273 nfs4_shrink_slot_table(tbl
, server_highest_slotid
+ 1);
276 (*p
)->seq_nr
= ivalue
;
277 (*p
)->interrupted
= 0;
280 tbl
->highest_used_slotid
= NFS4_NO_SLOT
;
281 tbl
->target_highest_slotid
= server_highest_slotid
;
282 tbl
->server_highest_slotid
= server_highest_slotid
;
283 tbl
->d_target_highest_slotid
= 0;
284 tbl
->d2_target_highest_slotid
= 0;
285 tbl
->max_slotid
= server_highest_slotid
;
289 * (re)Initialise a slot table
291 static int nfs4_realloc_slot_table(struct nfs4_slot_table
*tbl
,
292 u32 max_reqs
, u32 ivalue
)
296 dprintk("--> %s: max_reqs=%u, tbl->max_slots %u\n", __func__
,
297 max_reqs
, tbl
->max_slots
);
299 if (max_reqs
> NFS4_MAX_SLOT_TABLE
)
300 max_reqs
= NFS4_MAX_SLOT_TABLE
;
302 ret
= nfs4_grow_slot_table(tbl
, max_reqs
, ivalue
);
306 spin_lock(&tbl
->slot_tbl_lock
);
307 nfs4_reset_slot_table(tbl
, max_reqs
- 1, ivalue
);
308 spin_unlock(&tbl
->slot_tbl_lock
);
310 dprintk("%s: tbl=%p slots=%p max_slots=%u\n", __func__
,
311 tbl
, tbl
->slots
, tbl
->max_slots
);
313 dprintk("<-- %s: return %d\n", __func__
, ret
);
318 * nfs4_release_slot_table - release all slot table entries
320 static void nfs4_release_slot_table(struct nfs4_slot_table
*tbl
)
322 nfs4_shrink_slot_table(tbl
, 0);
326 * nfs4_shutdown_slot_table - release resources attached to a slot table
327 * @tbl: slot table to shut down
330 void nfs4_shutdown_slot_table(struct nfs4_slot_table
*tbl
)
332 nfs4_release_slot_table(tbl
);
333 rpc_destroy_wait_queue(&tbl
->slot_tbl_waitq
);
337 * nfs4_setup_slot_table - prepare a stand-alone slot table for use
338 * @tbl: slot table to set up
339 * @max_reqs: maximum number of requests allowed
340 * @queue: name to give RPC wait queue
342 * Returns zero on success, or a negative errno.
344 int nfs4_setup_slot_table(struct nfs4_slot_table
*tbl
, unsigned int max_reqs
,
347 nfs4_init_slot_table(tbl
, queue
);
348 return nfs4_realloc_slot_table(tbl
, max_reqs
, 0);
351 static bool nfs41_assign_slot(struct rpc_task
*task
, void *pslot
)
353 struct nfs4_sequence_args
*args
= task
->tk_msg
.rpc_argp
;
354 struct nfs4_sequence_res
*res
= task
->tk_msg
.rpc_resp
;
355 struct nfs4_slot
*slot
= pslot
;
356 struct nfs4_slot_table
*tbl
= slot
->table
;
358 if (nfs4_slot_tbl_draining(tbl
) && !args
->sa_privileged
)
360 slot
->generation
= tbl
->generation
;
361 args
->sa_slot
= slot
;
362 res
->sr_timestamp
= jiffies
;
364 res
->sr_status_flags
= 0;
369 static bool __nfs41_wake_and_assign_slot(struct nfs4_slot_table
*tbl
,
370 struct nfs4_slot
*slot
)
372 if (rpc_wake_up_first(&tbl
->slot_tbl_waitq
, nfs41_assign_slot
, slot
))
377 bool nfs41_wake_and_assign_slot(struct nfs4_slot_table
*tbl
,
378 struct nfs4_slot
*slot
)
380 if (slot
->slot_nr
> tbl
->max_slotid
)
382 return __nfs41_wake_and_assign_slot(tbl
, slot
);
385 static bool nfs41_try_wake_next_slot_table_entry(struct nfs4_slot_table
*tbl
)
387 struct nfs4_slot
*slot
= nfs4_alloc_slot(tbl
);
389 bool ret
= __nfs41_wake_and_assign_slot(tbl
, slot
);
392 nfs4_free_slot(tbl
, slot
);
397 void nfs41_wake_slot_table(struct nfs4_slot_table
*tbl
)
400 if (!nfs41_try_wake_next_slot_table_entry(tbl
))
405 #if defined(CONFIG_NFS_V4_1)
407 static void nfs41_set_max_slotid_locked(struct nfs4_slot_table
*tbl
,
408 u32 target_highest_slotid
)
412 max_slotid
= min(NFS4_MAX_SLOT_TABLE
- 1, target_highest_slotid
);
413 if (max_slotid
> tbl
->server_highest_slotid
)
414 max_slotid
= tbl
->server_highest_slotid
;
415 if (max_slotid
> tbl
->target_highest_slotid
)
416 max_slotid
= tbl
->target_highest_slotid
;
417 tbl
->max_slotid
= max_slotid
;
418 nfs41_wake_slot_table(tbl
);
421 /* Update the client's idea of target_highest_slotid */
422 static void nfs41_set_target_slotid_locked(struct nfs4_slot_table
*tbl
,
423 u32 target_highest_slotid
)
425 if (tbl
->target_highest_slotid
== target_highest_slotid
)
427 tbl
->target_highest_slotid
= target_highest_slotid
;
431 void nfs41_set_target_slotid(struct nfs4_slot_table
*tbl
,
432 u32 target_highest_slotid
)
434 spin_lock(&tbl
->slot_tbl_lock
);
435 nfs41_set_target_slotid_locked(tbl
, target_highest_slotid
);
436 tbl
->d_target_highest_slotid
= 0;
437 tbl
->d2_target_highest_slotid
= 0;
438 nfs41_set_max_slotid_locked(tbl
, target_highest_slotid
);
439 spin_unlock(&tbl
->slot_tbl_lock
);
442 static void nfs41_set_server_slotid_locked(struct nfs4_slot_table
*tbl
,
445 if (tbl
->server_highest_slotid
== highest_slotid
)
447 if (tbl
->highest_used_slotid
> highest_slotid
)
449 /* Deallocate slots */
450 nfs4_shrink_slot_table(tbl
, highest_slotid
+ 1);
451 tbl
->server_highest_slotid
= highest_slotid
;
454 static s32
nfs41_derivative_target_slotid(s32 s1
, s32 s2
)
460 return (s1
- 1) >> 1;
461 return (s1
+ 1) >> 1;
464 static int nfs41_sign_s32(s32 s1
)
473 static bool nfs41_same_sign_or_zero_s32(s32 s1
, s32 s2
)
477 return nfs41_sign_s32(s1
) == nfs41_sign_s32(s2
);
480 /* Try to eliminate outliers by checking for sharp changes in the
481 * derivatives and second derivatives
483 static bool nfs41_is_outlier_target_slotid(struct nfs4_slot_table
*tbl
,
486 s32 d_target
, d2_target
;
489 d_target
= nfs41_derivative_target_slotid(new_target
,
490 tbl
->target_highest_slotid
);
491 d2_target
= nfs41_derivative_target_slotid(d_target
,
492 tbl
->d_target_highest_slotid
);
493 /* Is first derivative same sign? */
494 if (nfs41_same_sign_or_zero_s32(d_target
, tbl
->d_target_highest_slotid
))
496 /* Is second derivative same sign? */
497 if (nfs41_same_sign_or_zero_s32(d2_target
, tbl
->d2_target_highest_slotid
))
499 tbl
->d_target_highest_slotid
= d_target
;
500 tbl
->d2_target_highest_slotid
= d2_target
;
504 void nfs41_update_target_slotid(struct nfs4_slot_table
*tbl
,
505 struct nfs4_slot
*slot
,
506 struct nfs4_sequence_res
*res
)
508 spin_lock(&tbl
->slot_tbl_lock
);
509 if (!nfs41_is_outlier_target_slotid(tbl
, res
->sr_target_highest_slotid
))
510 nfs41_set_target_slotid_locked(tbl
, res
->sr_target_highest_slotid
);
511 if (tbl
->generation
== slot
->generation
)
512 nfs41_set_server_slotid_locked(tbl
, res
->sr_highest_slotid
);
513 nfs41_set_max_slotid_locked(tbl
, res
->sr_target_highest_slotid
);
514 spin_unlock(&tbl
->slot_tbl_lock
);
517 static void nfs4_release_session_slot_tables(struct nfs4_session
*session
)
519 nfs4_release_slot_table(&session
->fc_slot_table
);
520 nfs4_release_slot_table(&session
->bc_slot_table
);
524 * Initialize or reset the forechannel and backchannel tables
526 int nfs4_setup_session_slot_tables(struct nfs4_session
*ses
)
528 struct nfs4_slot_table
*tbl
;
531 dprintk("--> %s\n", __func__
);
533 tbl
= &ses
->fc_slot_table
;
535 status
= nfs4_realloc_slot_table(tbl
, ses
->fc_attrs
.max_reqs
, 1);
536 if (status
|| !(ses
->flags
& SESSION4_BACK_CHAN
)) /* -ENOMEM */
539 tbl
= &ses
->bc_slot_table
;
541 status
= nfs4_realloc_slot_table(tbl
, ses
->bc_attrs
.max_reqs
, 0);
542 if (status
&& tbl
->slots
== NULL
)
543 /* Fore and back channel share a connection so get
544 * both slot tables or neither */
545 nfs4_release_session_slot_tables(ses
);
549 struct nfs4_session
*nfs4_alloc_session(struct nfs_client
*clp
)
551 struct nfs4_session
*session
;
553 session
= kzalloc(sizeof(struct nfs4_session
), GFP_NOFS
);
557 nfs4_init_slot_table(&session
->fc_slot_table
, "ForeChannel Slot table");
558 nfs4_init_slot_table(&session
->bc_slot_table
, "BackChannel Slot table");
559 session
->session_state
= 1<<NFS4_SESSION_INITING
;
565 static void nfs4_destroy_session_slot_tables(struct nfs4_session
*session
)
567 nfs4_shutdown_slot_table(&session
->fc_slot_table
);
568 nfs4_shutdown_slot_table(&session
->bc_slot_table
);
571 void nfs4_destroy_session(struct nfs4_session
*session
)
573 struct rpc_xprt
*xprt
;
574 struct rpc_cred
*cred
;
576 cred
= nfs4_get_clid_cred(session
->clp
);
577 nfs4_proc_destroy_session(session
, cred
);
582 xprt
= rcu_dereference(session
->clp
->cl_rpcclient
->cl_xprt
);
584 dprintk("%s Destroy backchannel for xprt %p\n",
586 xprt_destroy_backchannel(xprt
, NFS41_BC_MIN_CALLBACKS
);
587 nfs4_destroy_session_slot_tables(session
);
592 * With sessions, the client is not marked ready until after a
593 * successful EXCHANGE_ID and CREATE_SESSION.
595 * Map errors cl_cons_state errors to EPROTONOSUPPORT to indicate
596 * other versions of NFS can be tried.
598 static int nfs41_check_session_ready(struct nfs_client
*clp
)
602 if (clp
->cl_cons_state
== NFS_CS_SESSION_INITING
) {
603 ret
= nfs4_client_recover_expired_lease(clp
);
607 if (clp
->cl_cons_state
< NFS_CS_READY
)
608 return -EPROTONOSUPPORT
;
613 int nfs4_init_session(struct nfs_client
*clp
)
615 if (!nfs4_has_session(clp
))
618 clear_bit(NFS4_SESSION_INITING
, &clp
->cl_session
->session_state
);
619 return nfs41_check_session_ready(clp
);
622 int nfs4_init_ds_session(struct nfs_client
*clp
, unsigned long lease_time
)
624 struct nfs4_session
*session
= clp
->cl_session
;
627 spin_lock(&clp
->cl_lock
);
628 if (test_and_clear_bit(NFS4_SESSION_INITING
, &session
->session_state
)) {
630 * Do not set NFS_CS_CHECK_LEASE_TIME instead set the
631 * DS lease to be equal to the MDS lease.
633 clp
->cl_lease_time
= lease_time
;
634 clp
->cl_last_renewal
= jiffies
;
636 spin_unlock(&clp
->cl_lock
);
638 ret
= nfs41_check_session_ready(clp
);
641 /* Test for the DS role */
642 if (!is_ds_client(clp
))
646 EXPORT_SYMBOL_GPL(nfs4_init_ds_session
);
648 #endif /* defined(CONFIG_NFS_V4_1) */