1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (c) 2012 Trond Myklebust <Trond.Myklebust@netapp.com>
8 #include <linux/kernel.h>
9 #include <linux/errno.h>
10 #include <linux/string.h>
11 #include <linux/printk.h>
12 #include <linux/slab.h>
13 #include <linux/sunrpc/sched.h>
14 #include <linux/sunrpc/bc_xprt.h>
15 #include <linux/nfs.h>
16 #include <linux/nfs4.h>
17 #include <linux/nfs_fs.h>
18 #include <linux/module.h>
22 #include "nfs4session.h"
25 #define NFSDBG_FACILITY NFSDBG_STATE
27 static void nfs4_init_slot_table(struct nfs4_slot_table
*tbl
, const char *queue
)
29 tbl
->highest_used_slotid
= NFS4_NO_SLOT
;
30 spin_lock_init(&tbl
->slot_tbl_lock
);
31 rpc_init_priority_wait_queue(&tbl
->slot_tbl_waitq
, queue
);
32 init_waitqueue_head(&tbl
->slot_waitq
);
33 init_completion(&tbl
->complete
);
37 * nfs4_shrink_slot_table - free retired slots from the slot table
39 static void nfs4_shrink_slot_table(struct nfs4_slot_table
*tbl
, u32 newsize
)
42 if (newsize
>= tbl
->max_slots
)
49 struct nfs4_slot
*slot
= *p
;
58 * nfs4_slot_tbl_drain_complete - wake waiters when drain is complete
59 * @tbl: controlling slot table
62 void nfs4_slot_tbl_drain_complete(struct nfs4_slot_table
*tbl
)
64 if (nfs4_slot_tbl_draining(tbl
))
65 complete(&tbl
->complete
);
69 * nfs4_free_slot - free a slot and efficiently update slot table.
71 * freeing a slot is trivially done by clearing its respective bit
73 * If the freed slotid equals highest_used_slotid we want to update it
74 * so that the server would be able to size down the slot table if needed,
75 * otherwise we know that the highest_used_slotid is still in use.
76 * When updating highest_used_slotid there may be "holes" in the bitmap
77 * so we need to scan down from highest_used_slotid to 0 looking for the now
78 * highest slotid in use.
79 * If none found, highest_used_slotid is set to NFS4_NO_SLOT.
81 * Must be called while holding tbl->slot_tbl_lock
83 void nfs4_free_slot(struct nfs4_slot_table
*tbl
, struct nfs4_slot
*slot
)
85 u32 slotid
= slot
->slot_nr
;
87 /* clear used bit in bitmap */
88 __clear_bit(slotid
, tbl
->used_slots
);
90 /* update highest_used_slotid when it is freed */
91 if (slotid
== tbl
->highest_used_slotid
) {
92 u32 new_max
= find_last_bit(tbl
->used_slots
, slotid
);
94 tbl
->highest_used_slotid
= new_max
;
96 tbl
->highest_used_slotid
= NFS4_NO_SLOT
;
97 nfs4_slot_tbl_drain_complete(tbl
);
100 dprintk("%s: slotid %u highest_used_slotid %u\n", __func__
,
101 slotid
, tbl
->highest_used_slotid
);
104 static struct nfs4_slot
*nfs4_new_slot(struct nfs4_slot_table
*tbl
,
105 u32 slotid
, u32 seq_init
, gfp_t gfp_mask
)
107 struct nfs4_slot
*slot
;
109 slot
= kzalloc(sizeof(*slot
), gfp_mask
);
112 slot
->slot_nr
= slotid
;
113 slot
->seq_nr
= seq_init
;
114 slot
->seq_nr_highest_sent
= seq_init
;
115 slot
->seq_nr_last_acked
= seq_init
- 1;
120 static struct nfs4_slot
*nfs4_find_or_create_slot(struct nfs4_slot_table
*tbl
,
121 u32 slotid
, u32 seq_init
, gfp_t gfp_mask
)
123 struct nfs4_slot
**p
, *slot
;
128 *p
= nfs4_new_slot(tbl
, tbl
->max_slots
,
135 if (slot
->slot_nr
== slotid
)
139 return ERR_PTR(-ENOMEM
);
142 static void nfs4_lock_slot(struct nfs4_slot_table
*tbl
,
143 struct nfs4_slot
*slot
)
145 u32 slotid
= slot
->slot_nr
;
147 __set_bit(slotid
, tbl
->used_slots
);
148 if (slotid
> tbl
->highest_used_slotid
||
149 tbl
->highest_used_slotid
== NFS4_NO_SLOT
)
150 tbl
->highest_used_slotid
= slotid
;
151 slot
->generation
= tbl
->generation
;
155 * nfs4_try_to_lock_slot - Given a slot try to allocate it
157 * Note: must be called with the slot_tbl_lock held.
159 bool nfs4_try_to_lock_slot(struct nfs4_slot_table
*tbl
, struct nfs4_slot
*slot
)
161 if (nfs4_test_locked_slot(tbl
, slot
->slot_nr
))
163 nfs4_lock_slot(tbl
, slot
);
168 * nfs4_lookup_slot - Find a slot but don't allocate it
170 * Note: must be called with the slot_tbl_lock held.
172 struct nfs4_slot
*nfs4_lookup_slot(struct nfs4_slot_table
*tbl
, u32 slotid
)
174 if (slotid
<= tbl
->max_slotid
)
175 return nfs4_find_or_create_slot(tbl
, slotid
, 0, GFP_NOWAIT
);
176 return ERR_PTR(-E2BIG
);
179 static int nfs4_slot_get_seqid(struct nfs4_slot_table
*tbl
, u32 slotid
,
181 __must_hold(&tbl
->slot_tbl_lock
)
183 struct nfs4_slot
*slot
;
186 slot
= nfs4_lookup_slot(tbl
, slotid
);
187 ret
= PTR_ERR_OR_ZERO(slot
);
189 *seq_nr
= slot
->seq_nr
;
195 * nfs4_slot_seqid_in_use - test if a slot sequence id is still in use
197 * Given a slot table, slot id and sequence number, determine if the
198 * RPC call in question is still in flight. This function is mainly
199 * intended for use by the callback channel.
201 static bool nfs4_slot_seqid_in_use(struct nfs4_slot_table
*tbl
,
202 u32 slotid
, u32 seq_nr
)
207 spin_lock(&tbl
->slot_tbl_lock
);
208 if (nfs4_slot_get_seqid(tbl
, slotid
, &cur_seq
) == 0 &&
209 cur_seq
== seq_nr
&& test_bit(slotid
, tbl
->used_slots
))
211 spin_unlock(&tbl
->slot_tbl_lock
);
216 * nfs4_slot_wait_on_seqid - wait until a slot sequence id is complete
218 * Given a slot table, slot id and sequence number, wait until the
219 * corresponding RPC call completes. This function is mainly
220 * intended for use by the callback channel.
222 int nfs4_slot_wait_on_seqid(struct nfs4_slot_table
*tbl
,
223 u32 slotid
, u32 seq_nr
,
224 unsigned long timeout
)
226 if (wait_event_timeout(tbl
->slot_waitq
,
227 !nfs4_slot_seqid_in_use(tbl
, slotid
, seq_nr
),
234 * nfs4_alloc_slot - efficiently look for a free slot
236 * nfs4_alloc_slot looks for an unset bit in the used_slots bitmap.
237 * If found, we mark the slot as used, update the highest_used_slotid,
238 * and respectively set up the sequence operation args.
240 * Note: must be called with under the slot_tbl_lock.
242 struct nfs4_slot
*nfs4_alloc_slot(struct nfs4_slot_table
*tbl
)
244 struct nfs4_slot
*ret
= ERR_PTR(-EBUSY
);
247 dprintk("--> %s used_slots=%04lx highest_used=%u max_slots=%u\n",
248 __func__
, tbl
->used_slots
[0], tbl
->highest_used_slotid
,
249 tbl
->max_slotid
+ 1);
250 slotid
= find_first_zero_bit(tbl
->used_slots
, tbl
->max_slotid
+ 1);
251 if (slotid
<= tbl
->max_slotid
) {
252 ret
= nfs4_find_or_create_slot(tbl
, slotid
, 1, GFP_NOWAIT
);
254 nfs4_lock_slot(tbl
, ret
);
256 dprintk("<-- %s used_slots=%04lx highest_used=%u slotid=%u\n",
257 __func__
, tbl
->used_slots
[0], tbl
->highest_used_slotid
,
258 !IS_ERR(ret
) ? ret
->slot_nr
: NFS4_NO_SLOT
);
262 static int nfs4_grow_slot_table(struct nfs4_slot_table
*tbl
,
263 u32 max_reqs
, u32 ivalue
)
265 if (max_reqs
<= tbl
->max_slots
)
267 if (!IS_ERR(nfs4_find_or_create_slot(tbl
, max_reqs
- 1, ivalue
, GFP_NOFS
)))
272 static void nfs4_reset_slot_table(struct nfs4_slot_table
*tbl
,
273 u32 server_highest_slotid
,
276 struct nfs4_slot
**p
;
278 nfs4_shrink_slot_table(tbl
, server_highest_slotid
+ 1);
281 (*p
)->seq_nr
= ivalue
;
282 (*p
)->seq_nr_highest_sent
= ivalue
;
283 (*p
)->seq_nr_last_acked
= ivalue
- 1;
286 tbl
->highest_used_slotid
= NFS4_NO_SLOT
;
287 tbl
->target_highest_slotid
= server_highest_slotid
;
288 tbl
->server_highest_slotid
= server_highest_slotid
;
289 tbl
->d_target_highest_slotid
= 0;
290 tbl
->d2_target_highest_slotid
= 0;
291 tbl
->max_slotid
= server_highest_slotid
;
295 * (re)Initialise a slot table
297 static int nfs4_realloc_slot_table(struct nfs4_slot_table
*tbl
,
298 u32 max_reqs
, u32 ivalue
)
302 dprintk("--> %s: max_reqs=%u, tbl->max_slots %u\n", __func__
,
303 max_reqs
, tbl
->max_slots
);
305 if (max_reqs
> NFS4_MAX_SLOT_TABLE
)
306 max_reqs
= NFS4_MAX_SLOT_TABLE
;
308 ret
= nfs4_grow_slot_table(tbl
, max_reqs
, ivalue
);
312 spin_lock(&tbl
->slot_tbl_lock
);
313 nfs4_reset_slot_table(tbl
, max_reqs
- 1, ivalue
);
314 spin_unlock(&tbl
->slot_tbl_lock
);
316 dprintk("%s: tbl=%p slots=%p max_slots=%u\n", __func__
,
317 tbl
, tbl
->slots
, tbl
->max_slots
);
319 dprintk("<-- %s: return %d\n", __func__
, ret
);
324 * nfs4_release_slot_table - release all slot table entries
326 static void nfs4_release_slot_table(struct nfs4_slot_table
*tbl
)
328 nfs4_shrink_slot_table(tbl
, 0);
332 * nfs4_shutdown_slot_table - release resources attached to a slot table
333 * @tbl: slot table to shut down
336 void nfs4_shutdown_slot_table(struct nfs4_slot_table
*tbl
)
338 nfs4_release_slot_table(tbl
);
339 rpc_destroy_wait_queue(&tbl
->slot_tbl_waitq
);
343 * nfs4_setup_slot_table - prepare a stand-alone slot table for use
344 * @tbl: slot table to set up
345 * @max_reqs: maximum number of requests allowed
346 * @queue: name to give RPC wait queue
348 * Returns zero on success, or a negative errno.
350 int nfs4_setup_slot_table(struct nfs4_slot_table
*tbl
, unsigned int max_reqs
,
353 nfs4_init_slot_table(tbl
, queue
);
354 return nfs4_realloc_slot_table(tbl
, max_reqs
, 0);
357 static bool nfs41_assign_slot(struct rpc_task
*task
, void *pslot
)
359 struct nfs4_sequence_args
*args
= task
->tk_msg
.rpc_argp
;
360 struct nfs4_sequence_res
*res
= task
->tk_msg
.rpc_resp
;
361 struct nfs4_slot
*slot
= pslot
;
362 struct nfs4_slot_table
*tbl
= slot
->table
;
364 if (nfs4_slot_tbl_draining(tbl
) && !args
->sa_privileged
)
366 slot
->generation
= tbl
->generation
;
367 args
->sa_slot
= slot
;
368 res
->sr_timestamp
= jiffies
;
370 res
->sr_status_flags
= 0;
375 static bool __nfs41_wake_and_assign_slot(struct nfs4_slot_table
*tbl
,
376 struct nfs4_slot
*slot
)
378 if (rpc_wake_up_first(&tbl
->slot_tbl_waitq
, nfs41_assign_slot
, slot
))
383 bool nfs41_wake_and_assign_slot(struct nfs4_slot_table
*tbl
,
384 struct nfs4_slot
*slot
)
386 if (slot
->slot_nr
> tbl
->max_slotid
)
388 return __nfs41_wake_and_assign_slot(tbl
, slot
);
391 static bool nfs41_try_wake_next_slot_table_entry(struct nfs4_slot_table
*tbl
)
393 struct nfs4_slot
*slot
= nfs4_alloc_slot(tbl
);
395 bool ret
= __nfs41_wake_and_assign_slot(tbl
, slot
);
398 nfs4_free_slot(tbl
, slot
);
403 void nfs41_wake_slot_table(struct nfs4_slot_table
*tbl
)
406 if (!nfs41_try_wake_next_slot_table_entry(tbl
))
411 #if defined(CONFIG_NFS_V4_1)
413 static void nfs41_set_max_slotid_locked(struct nfs4_slot_table
*tbl
,
414 u32 target_highest_slotid
)
418 max_slotid
= min(NFS4_MAX_SLOT_TABLE
- 1, target_highest_slotid
);
419 if (max_slotid
> tbl
->server_highest_slotid
)
420 max_slotid
= tbl
->server_highest_slotid
;
421 if (max_slotid
> tbl
->target_highest_slotid
)
422 max_slotid
= tbl
->target_highest_slotid
;
423 tbl
->max_slotid
= max_slotid
;
424 nfs41_wake_slot_table(tbl
);
427 /* Update the client's idea of target_highest_slotid */
428 static void nfs41_set_target_slotid_locked(struct nfs4_slot_table
*tbl
,
429 u32 target_highest_slotid
)
431 if (tbl
->target_highest_slotid
== target_highest_slotid
)
433 tbl
->target_highest_slotid
= target_highest_slotid
;
437 void nfs41_set_target_slotid(struct nfs4_slot_table
*tbl
,
438 u32 target_highest_slotid
)
440 spin_lock(&tbl
->slot_tbl_lock
);
441 nfs41_set_target_slotid_locked(tbl
, target_highest_slotid
);
442 tbl
->d_target_highest_slotid
= 0;
443 tbl
->d2_target_highest_slotid
= 0;
444 nfs41_set_max_slotid_locked(tbl
, target_highest_slotid
);
445 spin_unlock(&tbl
->slot_tbl_lock
);
448 static void nfs41_set_server_slotid_locked(struct nfs4_slot_table
*tbl
,
451 if (tbl
->server_highest_slotid
== highest_slotid
)
453 if (tbl
->highest_used_slotid
> highest_slotid
)
455 /* Deallocate slots */
456 nfs4_shrink_slot_table(tbl
, highest_slotid
+ 1);
457 tbl
->server_highest_slotid
= highest_slotid
;
460 static s32
nfs41_derivative_target_slotid(s32 s1
, s32 s2
)
466 return (s1
- 1) >> 1;
467 return (s1
+ 1) >> 1;
470 static int nfs41_sign_s32(s32 s1
)
479 static bool nfs41_same_sign_or_zero_s32(s32 s1
, s32 s2
)
483 return nfs41_sign_s32(s1
) == nfs41_sign_s32(s2
);
486 /* Try to eliminate outliers by checking for sharp changes in the
487 * derivatives and second derivatives
489 static bool nfs41_is_outlier_target_slotid(struct nfs4_slot_table
*tbl
,
492 s32 d_target
, d2_target
;
495 d_target
= nfs41_derivative_target_slotid(new_target
,
496 tbl
->target_highest_slotid
);
497 d2_target
= nfs41_derivative_target_slotid(d_target
,
498 tbl
->d_target_highest_slotid
);
499 /* Is first derivative same sign? */
500 if (nfs41_same_sign_or_zero_s32(d_target
, tbl
->d_target_highest_slotid
))
502 /* Is second derivative same sign? */
503 if (nfs41_same_sign_or_zero_s32(d2_target
, tbl
->d2_target_highest_slotid
))
505 tbl
->d_target_highest_slotid
= d_target
;
506 tbl
->d2_target_highest_slotid
= d2_target
;
510 void nfs41_update_target_slotid(struct nfs4_slot_table
*tbl
,
511 struct nfs4_slot
*slot
,
512 struct nfs4_sequence_res
*res
)
514 spin_lock(&tbl
->slot_tbl_lock
);
515 if (!nfs41_is_outlier_target_slotid(tbl
, res
->sr_target_highest_slotid
))
516 nfs41_set_target_slotid_locked(tbl
, res
->sr_target_highest_slotid
);
517 if (tbl
->generation
== slot
->generation
)
518 nfs41_set_server_slotid_locked(tbl
, res
->sr_highest_slotid
);
519 nfs41_set_max_slotid_locked(tbl
, res
->sr_target_highest_slotid
);
520 spin_unlock(&tbl
->slot_tbl_lock
);
523 static void nfs4_release_session_slot_tables(struct nfs4_session
*session
)
525 nfs4_release_slot_table(&session
->fc_slot_table
);
526 nfs4_release_slot_table(&session
->bc_slot_table
);
530 * Initialize or reset the forechannel and backchannel tables
532 int nfs4_setup_session_slot_tables(struct nfs4_session
*ses
)
534 struct nfs4_slot_table
*tbl
;
537 dprintk("--> %s\n", __func__
);
539 tbl
= &ses
->fc_slot_table
;
541 status
= nfs4_realloc_slot_table(tbl
, ses
->fc_attrs
.max_reqs
, 1);
542 if (status
|| !(ses
->flags
& SESSION4_BACK_CHAN
)) /* -ENOMEM */
545 tbl
= &ses
->bc_slot_table
;
547 status
= nfs4_realloc_slot_table(tbl
, ses
->bc_attrs
.max_reqs
, 0);
548 if (status
&& tbl
->slots
== NULL
)
549 /* Fore and back channel share a connection so get
550 * both slot tables or neither */
551 nfs4_release_session_slot_tables(ses
);
555 struct nfs4_session
*nfs4_alloc_session(struct nfs_client
*clp
)
557 struct nfs4_session
*session
;
559 session
= kzalloc(sizeof(struct nfs4_session
), GFP_NOFS
);
563 nfs4_init_slot_table(&session
->fc_slot_table
, "ForeChannel Slot table");
564 nfs4_init_slot_table(&session
->bc_slot_table
, "BackChannel Slot table");
565 session
->session_state
= 1<<NFS4_SESSION_INITING
;
571 static void nfs4_destroy_session_slot_tables(struct nfs4_session
*session
)
573 nfs4_shutdown_slot_table(&session
->fc_slot_table
);
574 nfs4_shutdown_slot_table(&session
->bc_slot_table
);
577 void nfs4_destroy_session(struct nfs4_session
*session
)
579 struct rpc_xprt
*xprt
;
580 const struct cred
*cred
;
582 cred
= nfs4_get_clid_cred(session
->clp
);
583 nfs4_proc_destroy_session(session
, cred
);
587 xprt
= rcu_dereference(session
->clp
->cl_rpcclient
->cl_xprt
);
589 dprintk("%s Destroy backchannel for xprt %p\n",
591 xprt_destroy_backchannel(xprt
, NFS41_BC_MIN_CALLBACKS
);
592 nfs4_destroy_session_slot_tables(session
);
597 * With sessions, the client is not marked ready until after a
598 * successful EXCHANGE_ID and CREATE_SESSION.
600 * Map errors cl_cons_state errors to EPROTONOSUPPORT to indicate
601 * other versions of NFS can be tried.
603 static int nfs41_check_session_ready(struct nfs_client
*clp
)
607 if (clp
->cl_cons_state
== NFS_CS_SESSION_INITING
) {
608 ret
= nfs4_client_recover_expired_lease(clp
);
612 if (clp
->cl_cons_state
< NFS_CS_READY
)
613 return -EPROTONOSUPPORT
;
618 int nfs4_init_session(struct nfs_client
*clp
)
620 if (!nfs4_has_session(clp
))
623 clear_bit(NFS4_SESSION_INITING
, &clp
->cl_session
->session_state
);
624 return nfs41_check_session_ready(clp
);
627 int nfs4_init_ds_session(struct nfs_client
*clp
, unsigned long lease_time
)
629 struct nfs4_session
*session
= clp
->cl_session
;
632 spin_lock(&clp
->cl_lock
);
633 if (test_and_clear_bit(NFS4_SESSION_INITING
, &session
->session_state
)) {
635 * Do not set NFS_CS_CHECK_LEASE_TIME instead set the
636 * DS lease to be equal to the MDS lease.
638 clp
->cl_lease_time
= lease_time
;
639 clp
->cl_last_renewal
= jiffies
;
641 spin_unlock(&clp
->cl_lock
);
643 ret
= nfs41_check_session_ready(clp
);
646 /* Test for the DS role */
647 if (!is_ds_client(clp
))
651 EXPORT_SYMBOL_GPL(nfs4_init_ds_session
);
653 #endif /* defined(CONFIG_NFS_V4_1) */