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
27 * nfs4_shrink_slot_table - free retired slots from the slot table
29 static void nfs4_shrink_slot_table(struct nfs4_slot_table *tbl, u32 newsize)
32 if (newsize >= tbl->max_slots)
39 struct nfs4_slot *slot = *p;
48 * nfs4_free_slot - free a slot and efficiently update slot table.
50 * freeing a slot is trivially done by clearing its respective bit
52 * If the freed slotid equals highest_used_slotid we want to update it
53 * so that the server would be able to size down the slot table if needed,
54 * otherwise we know that the highest_used_slotid is still in use.
55 * When updating highest_used_slotid there may be "holes" in the bitmap
56 * so we need to scan down from highest_used_slotid to 0 looking for the now
57 * highest slotid in use.
58 * If none found, highest_used_slotid is set to NFS4_NO_SLOT.
60 * Must be called while holding tbl->slot_tbl_lock
62 void nfs4_free_slot(struct nfs4_slot_table *tbl, struct nfs4_slot *slot)
64 u32 slotid = slot->slot_nr;
66 /* clear used bit in bitmap */
67 __clear_bit(slotid, tbl->used_slots);
69 /* update highest_used_slotid when it is freed */
70 if (slotid == tbl->highest_used_slotid) {
71 u32 new_max = find_last_bit(tbl->used_slots, slotid);
73 tbl->highest_used_slotid = new_max;
75 tbl->highest_used_slotid = NFS4_NO_SLOT;
76 nfs4_session_drain_complete(tbl->session, tbl);
79 dprintk("%s: slotid %u highest_used_slotid %d\n", __func__,
80 slotid, tbl->highest_used_slotid);
83 static struct nfs4_slot *nfs4_new_slot(struct nfs4_slot_table *tbl,
84 u32 slotid, u32 seq_init, gfp_t gfp_mask)
86 struct nfs4_slot *slot;
88 slot = kzalloc(sizeof(*slot), gfp_mask);
91 slot->slot_nr = slotid;
92 slot->seq_nr = seq_init;
97 static struct nfs4_slot *nfs4_find_or_create_slot(struct nfs4_slot_table *tbl,
98 u32 slotid, u32 seq_init, gfp_t gfp_mask)
100 struct nfs4_slot **p, *slot;
105 *p = nfs4_new_slot(tbl, tbl->max_slots,
112 if (slot->slot_nr == slotid)
116 return ERR_PTR(-ENOMEM);
120 * nfs4_alloc_slot - efficiently look for a free slot
122 * nfs4_alloc_slot looks for an unset bit in the used_slots bitmap.
123 * If found, we mark the slot as used, update the highest_used_slotid,
124 * and respectively set up the sequence operation args.
126 * Note: must be called with under the slot_tbl_lock.
128 struct nfs4_slot *nfs4_alloc_slot(struct nfs4_slot_table *tbl)
130 struct nfs4_slot *ret = ERR_PTR(-EBUSY);
133 dprintk("--> %s used_slots=%04lx highest_used=%u max_slots=%u\n",
134 __func__, tbl->used_slots[0], tbl->highest_used_slotid,
135 tbl->max_slotid + 1);
136 slotid = find_first_zero_bit(tbl->used_slots, tbl->max_slotid + 1);
137 if (slotid > tbl->max_slotid)
139 ret = nfs4_find_or_create_slot(tbl, slotid, 1, GFP_NOWAIT);
142 __set_bit(slotid, tbl->used_slots);
143 if (slotid > tbl->highest_used_slotid ||
144 tbl->highest_used_slotid == NFS4_NO_SLOT)
145 tbl->highest_used_slotid = slotid;
146 ret->renewal_time = jiffies;
147 ret->generation = tbl->generation;
150 dprintk("<-- %s used_slots=%04lx highest_used=%d slotid=%d \n",
151 __func__, tbl->used_slots[0], tbl->highest_used_slotid,
152 !IS_ERR(ret) ? ret->slot_nr : -1);
156 static int nfs4_grow_slot_table(struct nfs4_slot_table *tbl,
157 u32 max_reqs, u32 ivalue)
159 if (max_reqs <= tbl->max_slots)
161 if (!IS_ERR(nfs4_find_or_create_slot(tbl, max_reqs - 1, ivalue, GFP_NOFS)))
166 static void nfs4_reset_slot_table(struct nfs4_slot_table *tbl,
167 u32 server_highest_slotid,
170 struct nfs4_slot **p;
172 nfs4_shrink_slot_table(tbl, server_highest_slotid + 1);
175 (*p)->seq_nr = ivalue;
178 tbl->highest_used_slotid = NFS4_NO_SLOT;
179 tbl->target_highest_slotid = server_highest_slotid;
180 tbl->server_highest_slotid = server_highest_slotid;
181 tbl->d_target_highest_slotid = 0;
182 tbl->d2_target_highest_slotid = 0;
183 tbl->max_slotid = server_highest_slotid;
187 * (re)Initialise a slot table
189 static int nfs4_realloc_slot_table(struct nfs4_slot_table *tbl,
190 u32 max_reqs, u32 ivalue)
194 dprintk("--> %s: max_reqs=%u, tbl->max_slots %d\n", __func__,
195 max_reqs, tbl->max_slots);
197 if (max_reqs > NFS4_MAX_SLOT_TABLE)
198 max_reqs = NFS4_MAX_SLOT_TABLE;
200 ret = nfs4_grow_slot_table(tbl, max_reqs, ivalue);
204 spin_lock(&tbl->slot_tbl_lock);
205 nfs4_reset_slot_table(tbl, max_reqs - 1, ivalue);
206 spin_unlock(&tbl->slot_tbl_lock);
208 dprintk("%s: tbl=%p slots=%p max_slots=%d\n", __func__,
209 tbl, tbl->slots, tbl->max_slots);
211 dprintk("<-- %s: return %d\n", __func__, ret);
215 /* Destroy the slot table */
216 static void nfs4_destroy_slot_tables(struct nfs4_session *session)
218 nfs4_shrink_slot_table(&session->fc_slot_table, 0);
219 nfs4_shrink_slot_table(&session->bc_slot_table, 0);
222 static bool nfs41_assign_slot(struct rpc_task *task, void *pslot)
224 struct nfs4_sequence_args *args = task->tk_msg.rpc_argp;
225 struct nfs4_sequence_res *res = task->tk_msg.rpc_resp;
226 struct nfs4_slot *slot = pslot;
227 struct nfs4_slot_table *tbl = slot->table;
229 if (nfs4_session_draining(tbl->session) && !args->sa_privileged)
231 slot->renewal_time = jiffies;
232 slot->generation = tbl->generation;
233 args->sa_slot = slot;
235 res->sr_status_flags = 0;
240 static bool __nfs41_wake_and_assign_slot(struct nfs4_slot_table *tbl,
241 struct nfs4_slot *slot)
243 if (rpc_wake_up_first(&tbl->slot_tbl_waitq, nfs41_assign_slot, slot))
248 bool nfs41_wake_and_assign_slot(struct nfs4_slot_table *tbl,
249 struct nfs4_slot *slot)
251 if (slot->slot_nr > tbl->max_slotid)
253 return __nfs41_wake_and_assign_slot(tbl, slot);
256 static bool nfs41_try_wake_next_slot_table_entry(struct nfs4_slot_table *tbl)
258 struct nfs4_slot *slot = nfs4_alloc_slot(tbl);
260 bool ret = __nfs41_wake_and_assign_slot(tbl, slot);
263 nfs4_free_slot(tbl, slot);
268 void nfs41_wake_slot_table(struct nfs4_slot_table *tbl)
271 if (!nfs41_try_wake_next_slot_table_entry(tbl))
276 /* Update the client's idea of target_highest_slotid */
277 static void nfs41_set_target_slotid_locked(struct nfs4_slot_table *tbl,
278 u32 target_highest_slotid)
280 unsigned int max_slotid;
282 if (tbl->target_highest_slotid == target_highest_slotid)
284 tbl->target_highest_slotid = target_highest_slotid;
287 max_slotid = min(NFS4_MAX_SLOT_TABLE - 1, tbl->target_highest_slotid);
288 tbl->max_slotid = max_slotid;
289 nfs41_wake_slot_table(tbl);
292 void nfs41_set_target_slotid(struct nfs4_slot_table *tbl,
293 u32 target_highest_slotid)
295 spin_lock(&tbl->slot_tbl_lock);
296 nfs41_set_target_slotid_locked(tbl, target_highest_slotid);
297 tbl->d_target_highest_slotid = 0;
298 tbl->d2_target_highest_slotid = 0;
299 spin_unlock(&tbl->slot_tbl_lock);
302 static void nfs41_set_server_slotid_locked(struct nfs4_slot_table *tbl,
305 if (tbl->server_highest_slotid == highest_slotid)
307 if (tbl->highest_used_slotid > highest_slotid)
309 /* Deallocate slots */
310 nfs4_shrink_slot_table(tbl, highest_slotid + 1);
311 tbl->server_highest_slotid = highest_slotid;
314 static s32 nfs41_derivative_target_slotid(s32 s1, s32 s2)
320 return (s1 - 1) >> 1;
321 return (s1 + 1) >> 1;
324 static int nfs41_sign_s32(s32 s1)
333 static bool nfs41_same_sign_or_zero_s32(s32 s1, s32 s2)
337 return nfs41_sign_s32(s1) == nfs41_sign_s32(s2);
340 /* Try to eliminate outliers by checking for sharp changes in the
341 * derivatives and second derivatives
343 static bool nfs41_is_outlier_target_slotid(struct nfs4_slot_table *tbl,
346 s32 d_target, d2_target;
349 d_target = nfs41_derivative_target_slotid(new_target,
350 tbl->target_highest_slotid);
351 d2_target = nfs41_derivative_target_slotid(d_target,
352 tbl->d_target_highest_slotid);
353 /* Is first derivative same sign? */
354 if (nfs41_same_sign_or_zero_s32(d_target, tbl->d_target_highest_slotid))
356 /* Is second derivative same sign? */
357 if (nfs41_same_sign_or_zero_s32(d2_target, tbl->d2_target_highest_slotid))
359 tbl->d_target_highest_slotid = d_target;
360 tbl->d2_target_highest_slotid = d2_target;
364 void nfs41_update_target_slotid(struct nfs4_slot_table *tbl,
365 struct nfs4_slot *slot,
366 struct nfs4_sequence_res *res)
368 spin_lock(&tbl->slot_tbl_lock);
369 if (!nfs41_is_outlier_target_slotid(tbl, res->sr_target_highest_slotid))
370 nfs41_set_target_slotid_locked(tbl, res->sr_target_highest_slotid);
371 if (tbl->generation == slot->generation)
372 nfs41_set_server_slotid_locked(tbl, res->sr_highest_slotid);
373 spin_unlock(&tbl->slot_tbl_lock);
377 * Initialize or reset the forechannel and backchannel tables
379 int nfs4_setup_session_slot_tables(struct nfs4_session *ses)
381 struct nfs4_slot_table *tbl;
384 dprintk("--> %s\n", __func__);
386 tbl = &ses->fc_slot_table;
388 status = nfs4_realloc_slot_table(tbl, ses->fc_attrs.max_reqs, 1);
389 if (status) /* -ENOMEM */
392 tbl = &ses->bc_slot_table;
394 status = nfs4_realloc_slot_table(tbl, ses->bc_attrs.max_reqs, 0);
395 if (status && tbl->slots == NULL)
396 /* Fore and back channel share a connection so get
397 * both slot tables or neither */
398 nfs4_destroy_slot_tables(ses);
402 struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp)
404 struct nfs4_session *session;
405 struct nfs4_slot_table *tbl;
407 session = kzalloc(sizeof(struct nfs4_session), GFP_NOFS);
411 tbl = &session->fc_slot_table;
412 tbl->highest_used_slotid = NFS4_NO_SLOT;
413 spin_lock_init(&tbl->slot_tbl_lock);
414 rpc_init_priority_wait_queue(&tbl->slot_tbl_waitq, "ForeChannel Slot table");
415 init_completion(&tbl->complete);
417 tbl = &session->bc_slot_table;
418 tbl->highest_used_slotid = NFS4_NO_SLOT;
419 spin_lock_init(&tbl->slot_tbl_lock);
420 rpc_init_wait_queue(&tbl->slot_tbl_waitq, "BackChannel Slot table");
421 init_completion(&tbl->complete);
423 session->session_state = 1<<NFS4_SESSION_INITING;
429 void nfs4_destroy_session(struct nfs4_session *session)
431 struct rpc_xprt *xprt;
432 struct rpc_cred *cred;
434 cred = nfs4_get_exchange_id_cred(session->clp);
435 nfs4_proc_destroy_session(session, cred);
440 xprt = rcu_dereference(session->clp->cl_rpcclient->cl_xprt);
442 dprintk("%s Destroy backchannel for xprt %p\n",
444 xprt_destroy_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
445 nfs4_destroy_slot_tables(session);
450 * With sessions, the client is not marked ready until after a
451 * successful EXCHANGE_ID and CREATE_SESSION.
453 * Map errors cl_cons_state errors to EPROTONOSUPPORT to indicate
454 * other versions of NFS can be tried.
456 static int nfs41_check_session_ready(struct nfs_client *clp)
460 if (clp->cl_cons_state == NFS_CS_SESSION_INITING) {
461 ret = nfs4_client_recover_expired_lease(clp);
465 if (clp->cl_cons_state < NFS_CS_READY)
466 return -EPROTONOSUPPORT;
471 int nfs4_init_session(struct nfs_server *server)
473 struct nfs_client *clp = server->nfs_client;
474 struct nfs4_session *session;
475 unsigned int target_max_rqst_sz = NFS_MAX_FILE_IO_SIZE;
476 unsigned int target_max_resp_sz = NFS_MAX_FILE_IO_SIZE;
478 if (!nfs4_has_session(clp))
481 if (server->rsize != 0)
482 target_max_resp_sz = server->rsize;
483 target_max_resp_sz += nfs41_maxread_overhead;
485 if (server->wsize != 0)
486 target_max_rqst_sz = server->wsize;
487 target_max_rqst_sz += nfs41_maxwrite_overhead;
489 session = clp->cl_session;
490 spin_lock(&clp->cl_lock);
491 if (test_and_clear_bit(NFS4_SESSION_INITING, &session->session_state)) {
492 /* Initialise targets and channel attributes */
493 session->fc_target_max_rqst_sz = target_max_rqst_sz;
494 session->fc_attrs.max_rqst_sz = target_max_rqst_sz;
495 session->fc_target_max_resp_sz = target_max_resp_sz;
496 session->fc_attrs.max_resp_sz = target_max_resp_sz;
498 /* Just adjust the targets */
499 if (target_max_rqst_sz > session->fc_target_max_rqst_sz) {
500 session->fc_target_max_rqst_sz = target_max_rqst_sz;
501 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
503 if (target_max_resp_sz > session->fc_target_max_resp_sz) {
504 session->fc_target_max_resp_sz = target_max_resp_sz;
505 set_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state);
508 spin_unlock(&clp->cl_lock);
510 if (test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
511 nfs4_schedule_lease_recovery(clp);
513 return nfs41_check_session_ready(clp);
516 int nfs4_init_ds_session(struct nfs_client *clp, unsigned long lease_time)
518 struct nfs4_session *session = clp->cl_session;
521 spin_lock(&clp->cl_lock);
522 if (test_and_clear_bit(NFS4_SESSION_INITING, &session->session_state)) {
524 * Do not set NFS_CS_CHECK_LEASE_TIME instead set the
525 * DS lease to be equal to the MDS lease.
527 clp->cl_lease_time = lease_time;
528 clp->cl_last_renewal = jiffies;
530 spin_unlock(&clp->cl_lock);
532 ret = nfs41_check_session_ready(clp);
535 /* Test for the DS role */
536 if (!is_ds_client(clp))
540 EXPORT_SYMBOL_GPL(nfs4_init_ds_session);