2 * linux/net/sunrpc/xprt.c
4 * This is a generic RPC call interface supporting congestion avoidance,
5 * and asynchronous calls.
7 * The interface works like this:
9 * - When a process places a call, it allocates a request slot if
10 * one is available. Otherwise, it sleeps on the backlog queue
12 * - Next, the caller puts together the RPC message, stuffs it into
13 * the request struct, and calls xprt_transmit().
14 * - xprt_transmit sends the message and installs the caller on the
15 * transport's wait list. At the same time, if a reply is expected,
16 * it installs a timer that is run after the packet's timeout has
18 * - When a packet arrives, the data_ready handler walks the list of
19 * pending requests for that transport. If a matching XID is found, the
20 * caller is woken up, and the timer removed.
21 * - When no reply arrives within the timeout interval, the timer is
22 * fired by the kernel and runs xprt_timer(). It either adjusts the
23 * timeout values (minor timeout) or wakes up the caller with a status
25 * - When the caller receives a notification from RPC that a reply arrived,
26 * it should release the RPC slot, and process the reply.
27 * If the call timed out, it may choose to retry the operation by
28 * adjusting the initial timeout value, and simply calling rpc_call
31 * Support for async RPC is done through a set of RPC-specific scheduling
32 * primitives that `transparently' work for processes as well as async
33 * tasks that rely on callbacks.
40 #include <linux/module.h>
42 #include <linux/types.h>
43 #include <linux/interrupt.h>
44 #include <linux/workqueue.h>
45 #include <linux/net.h>
46 #include <linux/ktime.h>
48 #include <linux/sunrpc/clnt.h>
49 #include <linux/sunrpc/metrics.h>
50 #include <linux/sunrpc/bc_xprt.h>
52 #include <trace/events/sunrpc.h>
60 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
61 # define RPCDBG_FACILITY RPCDBG_XPRT
67 static void xprt_init(struct rpc_xprt *xprt, struct net *net);
68 static void xprt_request_init(struct rpc_task *, struct rpc_xprt *);
69 static void xprt_connect_status(struct rpc_task *task);
70 static int __xprt_get_cong(struct rpc_xprt *, struct rpc_task *);
71 static void __xprt_put_cong(struct rpc_xprt *, struct rpc_rqst *);
72 static void xprt_destroy(struct rpc_xprt *xprt);
74 static DEFINE_SPINLOCK(xprt_list_lock);
75 static LIST_HEAD(xprt_list);
78 * xprt_register_transport - register a transport implementation
79 * @transport: transport to register
81 * If a transport implementation is loaded as a kernel module, it can
82 * call this interface to make itself known to the RPC client.
85 * 0: transport successfully registered
86 * -EEXIST: transport already registered
87 * -EINVAL: transport module being unloaded
89 int xprt_register_transport(struct xprt_class *transport)
95 spin_lock(&xprt_list_lock);
96 list_for_each_entry(t, &xprt_list, list) {
97 /* don't register the same transport class twice */
98 if (t->ident == transport->ident)
102 list_add_tail(&transport->list, &xprt_list);
103 printk(KERN_INFO "RPC: Registered %s transport module.\n",
108 spin_unlock(&xprt_list_lock);
111 EXPORT_SYMBOL_GPL(xprt_register_transport);
114 * xprt_unregister_transport - unregister a transport implementation
115 * @transport: transport to unregister
118 * 0: transport successfully unregistered
119 * -ENOENT: transport never registered
121 int xprt_unregister_transport(struct xprt_class *transport)
123 struct xprt_class *t;
127 spin_lock(&xprt_list_lock);
128 list_for_each_entry(t, &xprt_list, list) {
129 if (t == transport) {
131 "RPC: Unregistered %s transport module.\n",
133 list_del_init(&transport->list);
140 spin_unlock(&xprt_list_lock);
143 EXPORT_SYMBOL_GPL(xprt_unregister_transport);
146 * xprt_load_transport - load a transport implementation
147 * @transport_name: transport to load
150 * 0: transport successfully loaded
151 * -ENOENT: transport module not available
153 int xprt_load_transport(const char *transport_name)
155 struct xprt_class *t;
159 spin_lock(&xprt_list_lock);
160 list_for_each_entry(t, &xprt_list, list) {
161 if (strcmp(t->name, transport_name) == 0) {
162 spin_unlock(&xprt_list_lock);
166 spin_unlock(&xprt_list_lock);
167 result = request_module("xprt%s", transport_name);
171 EXPORT_SYMBOL_GPL(xprt_load_transport);
174 * xprt_reserve_xprt - serialize write access to transports
175 * @task: task that is requesting access to the transport
176 * @xprt: pointer to the target transport
178 * This prevents mixing the payload of separate requests, and prevents
179 * transport connects from colliding with writes. No congestion control
182 int xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
184 struct rpc_rqst *req = task->tk_rqstp;
187 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
188 if (task == xprt->snd_task)
192 xprt->snd_task = task;
199 dprintk("RPC: %5u failed to lock transport %p\n",
201 task->tk_timeout = 0;
202 task->tk_status = -EAGAIN;
204 priority = RPC_PRIORITY_LOW;
205 else if (!req->rq_ntrans)
206 priority = RPC_PRIORITY_NORMAL;
208 priority = RPC_PRIORITY_HIGH;
209 rpc_sleep_on_priority(&xprt->sending, task, NULL, priority);
212 EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
214 static void xprt_clear_locked(struct rpc_xprt *xprt)
216 xprt->snd_task = NULL;
217 if (!test_bit(XPRT_CLOSE_WAIT, &xprt->state)) {
218 smp_mb__before_atomic();
219 clear_bit(XPRT_LOCKED, &xprt->state);
220 smp_mb__after_atomic();
222 queue_work(rpciod_workqueue, &xprt->task_cleanup);
226 * xprt_reserve_xprt_cong - serialize write access to transports
227 * @task: task that is requesting access to the transport
229 * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
230 * integrated into the decision of whether a request is allowed to be
231 * woken up and given access to the transport.
233 int xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
235 struct rpc_rqst *req = task->tk_rqstp;
238 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
239 if (task == xprt->snd_task)
244 xprt->snd_task = task;
247 if (__xprt_get_cong(xprt, task)) {
248 xprt->snd_task = task;
252 xprt_clear_locked(xprt);
255 __xprt_put_cong(xprt, req);
256 dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
257 task->tk_timeout = 0;
258 task->tk_status = -EAGAIN;
260 priority = RPC_PRIORITY_LOW;
261 else if (!req->rq_ntrans)
262 priority = RPC_PRIORITY_NORMAL;
264 priority = RPC_PRIORITY_HIGH;
265 rpc_sleep_on_priority(&xprt->sending, task, NULL, priority);
268 EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
270 static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
274 spin_lock_bh(&xprt->transport_lock);
275 retval = xprt->ops->reserve_xprt(xprt, task);
276 spin_unlock_bh(&xprt->transport_lock);
280 static bool __xprt_lock_write_func(struct rpc_task *task, void *data)
282 struct rpc_xprt *xprt = data;
283 struct rpc_rqst *req;
285 req = task->tk_rqstp;
286 xprt->snd_task = task;
292 static void __xprt_lock_write_next(struct rpc_xprt *xprt)
294 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
297 if (rpc_wake_up_first(&xprt->sending, __xprt_lock_write_func, xprt))
299 xprt_clear_locked(xprt);
302 static bool __xprt_lock_write_cong_func(struct rpc_task *task, void *data)
304 struct rpc_xprt *xprt = data;
305 struct rpc_rqst *req;
307 req = task->tk_rqstp;
309 xprt->snd_task = task;
312 if (__xprt_get_cong(xprt, task)) {
313 xprt->snd_task = task;
320 static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
322 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
324 if (RPCXPRT_CONGESTED(xprt))
326 if (rpc_wake_up_first(&xprt->sending, __xprt_lock_write_cong_func, xprt))
329 xprt_clear_locked(xprt);
332 static void xprt_task_clear_bytes_sent(struct rpc_task *task)
335 struct rpc_rqst *req = task->tk_rqstp;
337 req->rq_bytes_sent = 0;
342 * xprt_release_xprt - allow other requests to use a transport
343 * @xprt: transport with other tasks potentially waiting
344 * @task: task that is releasing access to the transport
346 * Note that "task" can be NULL. No congestion control is provided.
348 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
350 if (xprt->snd_task == task) {
351 xprt_task_clear_bytes_sent(task);
352 xprt_clear_locked(xprt);
353 __xprt_lock_write_next(xprt);
356 EXPORT_SYMBOL_GPL(xprt_release_xprt);
359 * xprt_release_xprt_cong - allow other requests to use a transport
360 * @xprt: transport with other tasks potentially waiting
361 * @task: task that is releasing access to the transport
363 * Note that "task" can be NULL. Another task is awoken to use the
364 * transport if the transport's congestion window allows it.
366 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
368 if (xprt->snd_task == task) {
369 xprt_task_clear_bytes_sent(task);
370 xprt_clear_locked(xprt);
371 __xprt_lock_write_next_cong(xprt);
374 EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
376 static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
378 spin_lock_bh(&xprt->transport_lock);
379 xprt->ops->release_xprt(xprt, task);
380 spin_unlock_bh(&xprt->transport_lock);
384 * Van Jacobson congestion avoidance. Check if the congestion window
385 * overflowed. Put the task to sleep if this is the case.
388 __xprt_get_cong(struct rpc_xprt *xprt, struct rpc_task *task)
390 struct rpc_rqst *req = task->tk_rqstp;
394 dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
395 task->tk_pid, xprt->cong, xprt->cwnd);
396 if (RPCXPRT_CONGESTED(xprt))
399 xprt->cong += RPC_CWNDSCALE;
404 * Adjust the congestion window, and wake up the next task
405 * that has been sleeping due to congestion
408 __xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
413 xprt->cong -= RPC_CWNDSCALE;
414 __xprt_lock_write_next_cong(xprt);
418 * xprt_release_rqst_cong - housekeeping when request is complete
419 * @task: RPC request that recently completed
421 * Useful for transports that require congestion control.
423 void xprt_release_rqst_cong(struct rpc_task *task)
425 struct rpc_rqst *req = task->tk_rqstp;
427 __xprt_put_cong(req->rq_xprt, req);
429 EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
432 * xprt_adjust_cwnd - adjust transport congestion window
433 * @xprt: pointer to xprt
434 * @task: recently completed RPC request used to adjust window
435 * @result: result code of completed RPC request
437 * The transport code maintains an estimate on the maximum number of out-
438 * standing RPC requests, using a smoothed version of the congestion
439 * avoidance implemented in 44BSD. This is basically the Van Jacobson
440 * congestion algorithm: If a retransmit occurs, the congestion window is
441 * halved; otherwise, it is incremented by 1/cwnd when
443 * - a reply is received and
444 * - a full number of requests are outstanding and
445 * - the congestion window hasn't been updated recently.
447 void xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result)
449 struct rpc_rqst *req = task->tk_rqstp;
450 unsigned long cwnd = xprt->cwnd;
452 if (result >= 0 && cwnd <= xprt->cong) {
453 /* The (cwnd >> 1) term makes sure
454 * the result gets rounded properly. */
455 cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
456 if (cwnd > RPC_MAXCWND(xprt))
457 cwnd = RPC_MAXCWND(xprt);
458 __xprt_lock_write_next_cong(xprt);
459 } else if (result == -ETIMEDOUT) {
461 if (cwnd < RPC_CWNDSCALE)
462 cwnd = RPC_CWNDSCALE;
464 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
465 xprt->cong, xprt->cwnd, cwnd);
467 __xprt_put_cong(xprt, req);
469 EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
472 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
473 * @xprt: transport with waiting tasks
474 * @status: result code to plant in each task before waking it
477 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
480 rpc_wake_up_status(&xprt->pending, status);
482 rpc_wake_up(&xprt->pending);
484 EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
487 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
488 * @task: task to be put to sleep
489 * @action: function pointer to be executed after wait
491 * Note that we only set the timer for the case of RPC_IS_SOFT(), since
492 * we don't in general want to force a socket disconnection due to
493 * an incomplete RPC call transmission.
495 void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
497 struct rpc_rqst *req = task->tk_rqstp;
498 struct rpc_xprt *xprt = req->rq_xprt;
500 task->tk_timeout = RPC_IS_SOFT(task) ? req->rq_timeout : 0;
501 rpc_sleep_on(&xprt->pending, task, action);
503 EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
506 * xprt_write_space - wake the task waiting for transport output buffer space
507 * @xprt: transport with waiting tasks
509 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
511 void xprt_write_space(struct rpc_xprt *xprt)
513 spin_lock_bh(&xprt->transport_lock);
514 if (xprt->snd_task) {
515 dprintk("RPC: write space: waking waiting task on "
517 rpc_wake_up_queued_task(&xprt->pending, xprt->snd_task);
519 spin_unlock_bh(&xprt->transport_lock);
521 EXPORT_SYMBOL_GPL(xprt_write_space);
524 * xprt_set_retrans_timeout_def - set a request's retransmit timeout
525 * @task: task whose timeout is to be set
527 * Set a request's retransmit timeout based on the transport's
528 * default timeout parameters. Used by transports that don't adjust
529 * the retransmit timeout based on round-trip time estimation.
531 void xprt_set_retrans_timeout_def(struct rpc_task *task)
533 task->tk_timeout = task->tk_rqstp->rq_timeout;
535 EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def);
538 * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
539 * @task: task whose timeout is to be set
541 * Set a request's retransmit timeout using the RTT estimator.
543 void xprt_set_retrans_timeout_rtt(struct rpc_task *task)
545 int timer = task->tk_msg.rpc_proc->p_timer;
546 struct rpc_clnt *clnt = task->tk_client;
547 struct rpc_rtt *rtt = clnt->cl_rtt;
548 struct rpc_rqst *req = task->tk_rqstp;
549 unsigned long max_timeout = clnt->cl_timeout->to_maxval;
551 task->tk_timeout = rpc_calc_rto(rtt, timer);
552 task->tk_timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
553 if (task->tk_timeout > max_timeout || task->tk_timeout == 0)
554 task->tk_timeout = max_timeout;
556 EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt);
558 static void xprt_reset_majortimeo(struct rpc_rqst *req)
560 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
562 req->rq_majortimeo = req->rq_timeout;
563 if (to->to_exponential)
564 req->rq_majortimeo <<= to->to_retries;
566 req->rq_majortimeo += to->to_increment * to->to_retries;
567 if (req->rq_majortimeo > to->to_maxval || req->rq_majortimeo == 0)
568 req->rq_majortimeo = to->to_maxval;
569 req->rq_majortimeo += jiffies;
573 * xprt_adjust_timeout - adjust timeout values for next retransmit
574 * @req: RPC request containing parameters to use for the adjustment
577 int xprt_adjust_timeout(struct rpc_rqst *req)
579 struct rpc_xprt *xprt = req->rq_xprt;
580 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
583 if (time_before(jiffies, req->rq_majortimeo)) {
584 if (to->to_exponential)
585 req->rq_timeout <<= 1;
587 req->rq_timeout += to->to_increment;
588 if (to->to_maxval && req->rq_timeout >= to->to_maxval)
589 req->rq_timeout = to->to_maxval;
592 req->rq_timeout = to->to_initval;
594 xprt_reset_majortimeo(req);
595 /* Reset the RTT counters == "slow start" */
596 spin_lock_bh(&xprt->transport_lock);
597 rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
598 spin_unlock_bh(&xprt->transport_lock);
602 if (req->rq_timeout == 0) {
603 printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
604 req->rq_timeout = 5 * HZ;
609 static void xprt_autoclose(struct work_struct *work)
611 struct rpc_xprt *xprt =
612 container_of(work, struct rpc_xprt, task_cleanup);
614 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
615 xprt->ops->close(xprt);
616 xprt_release_write(xprt, NULL);
617 wake_up_bit(&xprt->state, XPRT_LOCKED);
621 * xprt_disconnect_done - mark a transport as disconnected
622 * @xprt: transport to flag for disconnect
625 void xprt_disconnect_done(struct rpc_xprt *xprt)
627 dprintk("RPC: disconnected transport %p\n", xprt);
628 spin_lock_bh(&xprt->transport_lock);
629 xprt_clear_connected(xprt);
630 xprt_wake_pending_tasks(xprt, -EAGAIN);
631 spin_unlock_bh(&xprt->transport_lock);
633 EXPORT_SYMBOL_GPL(xprt_disconnect_done);
636 * xprt_force_disconnect - force a transport to disconnect
637 * @xprt: transport to disconnect
640 void xprt_force_disconnect(struct rpc_xprt *xprt)
642 /* Don't race with the test_bit() in xprt_clear_locked() */
643 spin_lock_bh(&xprt->transport_lock);
644 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
645 /* Try to schedule an autoclose RPC call */
646 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
647 queue_work(rpciod_workqueue, &xprt->task_cleanup);
648 xprt_wake_pending_tasks(xprt, -EAGAIN);
649 spin_unlock_bh(&xprt->transport_lock);
653 * xprt_conditional_disconnect - force a transport to disconnect
654 * @xprt: transport to disconnect
655 * @cookie: 'connection cookie'
657 * This attempts to break the connection if and only if 'cookie' matches
658 * the current transport 'connection cookie'. It ensures that we don't
659 * try to break the connection more than once when we need to retransmit
660 * a batch of RPC requests.
663 void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
665 /* Don't race with the test_bit() in xprt_clear_locked() */
666 spin_lock_bh(&xprt->transport_lock);
667 if (cookie != xprt->connect_cookie)
669 if (test_bit(XPRT_CLOSING, &xprt->state) || !xprt_connected(xprt))
671 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
672 /* Try to schedule an autoclose RPC call */
673 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
674 queue_work(rpciod_workqueue, &xprt->task_cleanup);
675 xprt_wake_pending_tasks(xprt, -EAGAIN);
677 spin_unlock_bh(&xprt->transport_lock);
681 xprt_init_autodisconnect(unsigned long data)
683 struct rpc_xprt *xprt = (struct rpc_xprt *)data;
685 spin_lock(&xprt->transport_lock);
686 if (!list_empty(&xprt->recv))
688 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
690 spin_unlock(&xprt->transport_lock);
691 queue_work(rpciod_workqueue, &xprt->task_cleanup);
694 spin_unlock(&xprt->transport_lock);
697 bool xprt_lock_connect(struct rpc_xprt *xprt,
698 struct rpc_task *task,
703 spin_lock_bh(&xprt->transport_lock);
704 if (!test_bit(XPRT_LOCKED, &xprt->state))
706 if (xprt->snd_task != task)
708 xprt_task_clear_bytes_sent(task);
709 xprt->snd_task = cookie;
712 spin_unlock_bh(&xprt->transport_lock);
716 void xprt_unlock_connect(struct rpc_xprt *xprt, void *cookie)
718 spin_lock_bh(&xprt->transport_lock);
719 if (xprt->snd_task != cookie)
721 if (!test_bit(XPRT_LOCKED, &xprt->state))
723 xprt->snd_task =NULL;
724 xprt->ops->release_xprt(xprt, NULL);
726 spin_unlock_bh(&xprt->transport_lock);
727 wake_up_bit(&xprt->state, XPRT_LOCKED);
731 * xprt_connect - schedule a transport connect operation
732 * @task: RPC task that is requesting the connect
735 void xprt_connect(struct rpc_task *task)
737 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
739 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
740 xprt, (xprt_connected(xprt) ? "is" : "is not"));
742 if (!xprt_bound(xprt)) {
743 task->tk_status = -EAGAIN;
746 if (!xprt_lock_write(xprt, task))
749 if (test_and_clear_bit(XPRT_CLOSE_WAIT, &xprt->state))
750 xprt->ops->close(xprt);
752 if (!xprt_connected(xprt)) {
753 task->tk_rqstp->rq_bytes_sent = 0;
754 task->tk_timeout = task->tk_rqstp->rq_timeout;
755 rpc_sleep_on(&xprt->pending, task, xprt_connect_status);
757 if (test_bit(XPRT_CLOSING, &xprt->state))
759 if (xprt_test_and_set_connecting(xprt))
761 xprt->stat.connect_start = jiffies;
762 xprt->ops->connect(xprt, task);
764 xprt_release_write(xprt, task);
767 static void xprt_connect_status(struct rpc_task *task)
769 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
771 if (task->tk_status == 0) {
772 xprt->stat.connect_count++;
773 xprt->stat.connect_time += (long)jiffies - xprt->stat.connect_start;
774 dprintk("RPC: %5u xprt_connect_status: connection established\n",
779 switch (task->tk_status) {
787 dprintk("RPC: %5u xprt_connect_status: retrying\n", task->tk_pid);
790 dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
791 "out\n", task->tk_pid);
794 dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
795 "server %s\n", task->tk_pid, -task->tk_status,
797 task->tk_status = -EIO;
802 * xprt_lookup_rqst - find an RPC request corresponding to an XID
803 * @xprt: transport on which the original request was transmitted
804 * @xid: RPC XID of incoming reply
807 struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
809 struct rpc_rqst *entry;
811 list_for_each_entry(entry, &xprt->recv, rq_list)
812 if (entry->rq_xid == xid) {
813 trace_xprt_lookup_rqst(xprt, xid, 0);
817 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
819 trace_xprt_lookup_rqst(xprt, xid, -ENOENT);
820 xprt->stat.bad_xids++;
823 EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
825 static void xprt_update_rtt(struct rpc_task *task)
827 struct rpc_rqst *req = task->tk_rqstp;
828 struct rpc_rtt *rtt = task->tk_client->cl_rtt;
829 unsigned int timer = task->tk_msg.rpc_proc->p_timer;
830 long m = usecs_to_jiffies(ktime_to_us(req->rq_rtt));
833 if (req->rq_ntrans == 1)
834 rpc_update_rtt(rtt, timer, m);
835 rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
840 * xprt_complete_rqst - called when reply processing is complete
841 * @task: RPC request that recently completed
842 * @copied: actual number of bytes received from the transport
844 * Caller holds transport lock.
846 void xprt_complete_rqst(struct rpc_task *task, int copied)
848 struct rpc_rqst *req = task->tk_rqstp;
849 struct rpc_xprt *xprt = req->rq_xprt;
851 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
852 task->tk_pid, ntohl(req->rq_xid), copied);
853 trace_xprt_complete_rqst(xprt, req->rq_xid, copied);
856 req->rq_rtt = ktime_sub(ktime_get(), req->rq_xtime);
857 if (xprt->ops->timer != NULL)
858 xprt_update_rtt(task);
860 list_del_init(&req->rq_list);
861 req->rq_private_buf.len = copied;
862 /* Ensure all writes are done before we update */
863 /* req->rq_reply_bytes_recvd */
865 req->rq_reply_bytes_recvd = copied;
866 rpc_wake_up_queued_task(&xprt->pending, task);
868 EXPORT_SYMBOL_GPL(xprt_complete_rqst);
870 static void xprt_timer(struct rpc_task *task)
872 struct rpc_rqst *req = task->tk_rqstp;
873 struct rpc_xprt *xprt = req->rq_xprt;
875 if (task->tk_status != -ETIMEDOUT)
877 dprintk("RPC: %5u xprt_timer\n", task->tk_pid);
879 spin_lock_bh(&xprt->transport_lock);
880 if (!req->rq_reply_bytes_recvd) {
881 if (xprt->ops->timer)
882 xprt->ops->timer(xprt, task);
885 spin_unlock_bh(&xprt->transport_lock);
888 static inline int xprt_has_timer(struct rpc_xprt *xprt)
890 return xprt->idle_timeout != 0;
894 * xprt_prepare_transmit - reserve the transport before sending a request
895 * @task: RPC task about to send a request
898 bool xprt_prepare_transmit(struct rpc_task *task)
900 struct rpc_rqst *req = task->tk_rqstp;
901 struct rpc_xprt *xprt = req->rq_xprt;
904 dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
906 spin_lock_bh(&xprt->transport_lock);
907 if (!req->rq_bytes_sent) {
908 if (req->rq_reply_bytes_recvd) {
909 task->tk_status = req->rq_reply_bytes_recvd;
912 if ((task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
913 && xprt_connected(xprt)
914 && req->rq_connect_cookie == xprt->connect_cookie) {
915 xprt->ops->set_retrans_timeout(task);
916 rpc_sleep_on(&xprt->pending, task, xprt_timer);
920 if (!xprt->ops->reserve_xprt(xprt, task)) {
921 task->tk_status = -EAGAIN;
926 spin_unlock_bh(&xprt->transport_lock);
930 void xprt_end_transmit(struct rpc_task *task)
932 xprt_release_write(task->tk_rqstp->rq_xprt, task);
936 * xprt_transmit - send an RPC request on a transport
937 * @task: controlling RPC task
939 * We have to copy the iovec because sendmsg fiddles with its contents.
941 void xprt_transmit(struct rpc_task *task)
943 struct rpc_rqst *req = task->tk_rqstp;
944 struct rpc_xprt *xprt = req->rq_xprt;
947 dprintk("RPC: %5u xprt_transmit(%u)\n", task->tk_pid, req->rq_slen);
949 if (!req->rq_reply_bytes_recvd) {
950 if (list_empty(&req->rq_list) && rpc_reply_expected(task)) {
952 * Add to the list only if we're expecting a reply
954 spin_lock_bh(&xprt->transport_lock);
955 /* Update the softirq receive buffer */
956 memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
957 sizeof(req->rq_private_buf));
958 /* Add request to the receive list */
959 list_add_tail(&req->rq_list, &xprt->recv);
960 spin_unlock_bh(&xprt->transport_lock);
961 xprt_reset_majortimeo(req);
962 /* Turn off autodisconnect */
963 del_singleshot_timer_sync(&xprt->timer);
965 } else if (!req->rq_bytes_sent)
968 req->rq_xtime = ktime_get();
969 status = xprt->ops->send_request(task);
970 trace_xprt_transmit(xprt, req->rq_xid, status);
972 task->tk_status = status;
975 xprt_inject_disconnect(xprt);
977 dprintk("RPC: %5u xmit complete\n", task->tk_pid);
978 task->tk_flags |= RPC_TASK_SENT;
979 spin_lock_bh(&xprt->transport_lock);
981 xprt->ops->set_retrans_timeout(task);
983 numreqs = atomic_read(&xprt->num_reqs);
984 if (numreqs > xprt->stat.max_slots)
985 xprt->stat.max_slots = numreqs;
987 xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
988 xprt->stat.bklog_u += xprt->backlog.qlen;
989 xprt->stat.sending_u += xprt->sending.qlen;
990 xprt->stat.pending_u += xprt->pending.qlen;
992 /* Don't race with disconnect */
993 if (!xprt_connected(xprt))
994 task->tk_status = -ENOTCONN;
997 * Sleep on the pending queue since
998 * we're expecting a reply.
1000 if (!req->rq_reply_bytes_recvd && rpc_reply_expected(task))
1001 rpc_sleep_on(&xprt->pending, task, xprt_timer);
1002 req->rq_connect_cookie = xprt->connect_cookie;
1004 spin_unlock_bh(&xprt->transport_lock);
1007 static void xprt_add_backlog(struct rpc_xprt *xprt, struct rpc_task *task)
1009 set_bit(XPRT_CONGESTED, &xprt->state);
1010 rpc_sleep_on(&xprt->backlog, task, NULL);
1013 static void xprt_wake_up_backlog(struct rpc_xprt *xprt)
1015 if (rpc_wake_up_next(&xprt->backlog) == NULL)
1016 clear_bit(XPRT_CONGESTED, &xprt->state);
1019 static bool xprt_throttle_congested(struct rpc_xprt *xprt, struct rpc_task *task)
1023 if (!test_bit(XPRT_CONGESTED, &xprt->state))
1025 spin_lock(&xprt->reserve_lock);
1026 if (test_bit(XPRT_CONGESTED, &xprt->state)) {
1027 rpc_sleep_on(&xprt->backlog, task, NULL);
1030 spin_unlock(&xprt->reserve_lock);
1035 static struct rpc_rqst *xprt_dynamic_alloc_slot(struct rpc_xprt *xprt, gfp_t gfp_flags)
1037 struct rpc_rqst *req = ERR_PTR(-EAGAIN);
1039 if (!atomic_add_unless(&xprt->num_reqs, 1, xprt->max_reqs))
1041 req = kzalloc(sizeof(struct rpc_rqst), gfp_flags);
1044 atomic_dec(&xprt->num_reqs);
1045 req = ERR_PTR(-ENOMEM);
1050 static bool xprt_dynamic_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1052 if (atomic_add_unless(&xprt->num_reqs, -1, xprt->min_reqs)) {
1059 void xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
1061 struct rpc_rqst *req;
1063 spin_lock(&xprt->reserve_lock);
1064 if (!list_empty(&xprt->free)) {
1065 req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
1066 list_del(&req->rq_list);
1069 req = xprt_dynamic_alloc_slot(xprt, GFP_NOWAIT|__GFP_NOWARN);
1072 switch (PTR_ERR(req)) {
1074 dprintk("RPC: dynamic allocation of request slot "
1075 "failed! Retrying\n");
1076 task->tk_status = -ENOMEM;
1079 xprt_add_backlog(xprt, task);
1080 dprintk("RPC: waiting for request slot\n");
1082 task->tk_status = -EAGAIN;
1084 spin_unlock(&xprt->reserve_lock);
1087 task->tk_status = 0;
1088 task->tk_rqstp = req;
1089 xprt_request_init(task, xprt);
1090 spin_unlock(&xprt->reserve_lock);
1092 EXPORT_SYMBOL_GPL(xprt_alloc_slot);
1094 void xprt_lock_and_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
1096 /* Note: grabbing the xprt_lock_write() ensures that we throttle
1097 * new slot allocation if the transport is congested (i.e. when
1098 * reconnecting a stream transport or when out of socket write
1101 if (xprt_lock_write(xprt, task)) {
1102 xprt_alloc_slot(xprt, task);
1103 xprt_release_write(xprt, task);
1106 EXPORT_SYMBOL_GPL(xprt_lock_and_alloc_slot);
1108 static void xprt_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1110 spin_lock(&xprt->reserve_lock);
1111 if (!xprt_dynamic_free_slot(xprt, req)) {
1112 memset(req, 0, sizeof(*req)); /* mark unused */
1113 list_add(&req->rq_list, &xprt->free);
1115 xprt_wake_up_backlog(xprt);
1116 spin_unlock(&xprt->reserve_lock);
1119 static void xprt_free_all_slots(struct rpc_xprt *xprt)
1121 struct rpc_rqst *req;
1122 while (!list_empty(&xprt->free)) {
1123 req = list_first_entry(&xprt->free, struct rpc_rqst, rq_list);
1124 list_del(&req->rq_list);
1129 struct rpc_xprt *xprt_alloc(struct net *net, size_t size,
1130 unsigned int num_prealloc,
1131 unsigned int max_alloc)
1133 struct rpc_xprt *xprt;
1134 struct rpc_rqst *req;
1137 xprt = kzalloc(size, GFP_KERNEL);
1141 xprt_init(xprt, net);
1143 for (i = 0; i < num_prealloc; i++) {
1144 req = kzalloc(sizeof(struct rpc_rqst), GFP_KERNEL);
1147 list_add(&req->rq_list, &xprt->free);
1149 if (max_alloc > num_prealloc)
1150 xprt->max_reqs = max_alloc;
1152 xprt->max_reqs = num_prealloc;
1153 xprt->min_reqs = num_prealloc;
1154 atomic_set(&xprt->num_reqs, num_prealloc);
1163 EXPORT_SYMBOL_GPL(xprt_alloc);
1165 void xprt_free(struct rpc_xprt *xprt)
1167 put_net(xprt->xprt_net);
1168 xprt_free_all_slots(xprt);
1171 EXPORT_SYMBOL_GPL(xprt_free);
1174 * xprt_reserve - allocate an RPC request slot
1175 * @task: RPC task requesting a slot allocation
1177 * If the transport is marked as being congested, or if no more
1178 * slots are available, place the task on the transport's
1181 void xprt_reserve(struct rpc_task *task)
1183 struct rpc_xprt *xprt;
1185 task->tk_status = 0;
1186 if (task->tk_rqstp != NULL)
1189 task->tk_timeout = 0;
1190 task->tk_status = -EAGAIN;
1192 xprt = rcu_dereference(task->tk_client->cl_xprt);
1193 if (!xprt_throttle_congested(xprt, task))
1194 xprt->ops->alloc_slot(xprt, task);
1199 * xprt_retry_reserve - allocate an RPC request slot
1200 * @task: RPC task requesting a slot allocation
1202 * If no more slots are available, place the task on the transport's
1204 * Note that the only difference with xprt_reserve is that we now
1205 * ignore the value of the XPRT_CONGESTED flag.
1207 void xprt_retry_reserve(struct rpc_task *task)
1209 struct rpc_xprt *xprt;
1211 task->tk_status = 0;
1212 if (task->tk_rqstp != NULL)
1215 task->tk_timeout = 0;
1216 task->tk_status = -EAGAIN;
1218 xprt = rcu_dereference(task->tk_client->cl_xprt);
1219 xprt->ops->alloc_slot(xprt, task);
1223 static inline __be32 xprt_alloc_xid(struct rpc_xprt *xprt)
1225 return (__force __be32)xprt->xid++;
1228 static inline void xprt_init_xid(struct rpc_xprt *xprt)
1230 xprt->xid = prandom_u32();
1233 static void xprt_request_init(struct rpc_task *task, struct rpc_xprt *xprt)
1235 struct rpc_rqst *req = task->tk_rqstp;
1237 INIT_LIST_HEAD(&req->rq_list);
1238 req->rq_timeout = task->tk_client->cl_timeout->to_initval;
1239 req->rq_task = task;
1240 req->rq_xprt = xprt;
1241 req->rq_buffer = NULL;
1242 req->rq_xid = xprt_alloc_xid(xprt);
1243 req->rq_connect_cookie = xprt->connect_cookie - 1;
1244 req->rq_bytes_sent = 0;
1245 req->rq_snd_buf.len = 0;
1246 req->rq_snd_buf.buflen = 0;
1247 req->rq_rcv_buf.len = 0;
1248 req->rq_rcv_buf.buflen = 0;
1249 req->rq_release_snd_buf = NULL;
1250 xprt_reset_majortimeo(req);
1251 dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
1252 req, ntohl(req->rq_xid));
1256 * xprt_release - release an RPC request slot
1257 * @task: task which is finished with the slot
1260 void xprt_release(struct rpc_task *task)
1262 struct rpc_xprt *xprt;
1263 struct rpc_rqst *req = task->tk_rqstp;
1266 if (task->tk_client) {
1268 xprt = rcu_dereference(task->tk_client->cl_xprt);
1269 if (xprt->snd_task == task)
1270 xprt_release_write(xprt, task);
1276 xprt = req->rq_xprt;
1277 if (task->tk_ops->rpc_count_stats != NULL)
1278 task->tk_ops->rpc_count_stats(task, task->tk_calldata);
1279 else if (task->tk_client)
1280 rpc_count_iostats(task, task->tk_client->cl_metrics);
1281 spin_lock_bh(&xprt->transport_lock);
1282 xprt->ops->release_xprt(xprt, task);
1283 if (xprt->ops->release_request)
1284 xprt->ops->release_request(task);
1285 if (!list_empty(&req->rq_list))
1286 list_del(&req->rq_list);
1287 xprt->last_used = jiffies;
1288 if (list_empty(&xprt->recv) && xprt_has_timer(xprt))
1289 mod_timer(&xprt->timer,
1290 xprt->last_used + xprt->idle_timeout);
1291 spin_unlock_bh(&xprt->transport_lock);
1293 xprt->ops->buf_free(req->rq_buffer);
1294 xprt_inject_disconnect(xprt);
1295 if (req->rq_cred != NULL)
1296 put_rpccred(req->rq_cred);
1297 task->tk_rqstp = NULL;
1298 if (req->rq_release_snd_buf)
1299 req->rq_release_snd_buf(req);
1301 dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
1302 if (likely(!bc_prealloc(req)))
1303 xprt_free_slot(xprt, req);
1305 xprt_free_bc_request(req);
1308 static void xprt_init(struct rpc_xprt *xprt, struct net *net)
1310 atomic_set(&xprt->count, 1);
1312 spin_lock_init(&xprt->transport_lock);
1313 spin_lock_init(&xprt->reserve_lock);
1315 INIT_LIST_HEAD(&xprt->free);
1316 INIT_LIST_HEAD(&xprt->recv);
1317 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1318 spin_lock_init(&xprt->bc_pa_lock);
1319 INIT_LIST_HEAD(&xprt->bc_pa_list);
1320 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1322 xprt->last_used = jiffies;
1323 xprt->cwnd = RPC_INITCWND;
1324 xprt->bind_index = 0;
1326 rpc_init_wait_queue(&xprt->binding, "xprt_binding");
1327 rpc_init_wait_queue(&xprt->pending, "xprt_pending");
1328 rpc_init_priority_wait_queue(&xprt->sending, "xprt_sending");
1329 rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
1331 xprt_init_xid(xprt);
1333 xprt->xprt_net = get_net(net);
1337 * xprt_create_transport - create an RPC transport
1338 * @args: rpc transport creation arguments
1341 struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
1343 struct rpc_xprt *xprt;
1344 struct xprt_class *t;
1346 spin_lock(&xprt_list_lock);
1347 list_for_each_entry(t, &xprt_list, list) {
1348 if (t->ident == args->ident) {
1349 spin_unlock(&xprt_list_lock);
1353 spin_unlock(&xprt_list_lock);
1354 dprintk("RPC: transport (%d) not supported\n", args->ident);
1355 return ERR_PTR(-EIO);
1358 xprt = t->setup(args);
1360 dprintk("RPC: xprt_create_transport: failed, %ld\n",
1364 if (args->flags & XPRT_CREATE_NO_IDLE_TIMEOUT)
1365 xprt->idle_timeout = 0;
1366 INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
1367 if (xprt_has_timer(xprt))
1368 setup_timer(&xprt->timer, xprt_init_autodisconnect,
1369 (unsigned long)xprt);
1371 init_timer(&xprt->timer);
1373 if (strlen(args->servername) > RPC_MAXNETNAMELEN) {
1375 return ERR_PTR(-EINVAL);
1377 xprt->servername = kstrdup(args->servername, GFP_KERNEL);
1378 if (xprt->servername == NULL) {
1380 return ERR_PTR(-ENOMEM);
1383 rpc_xprt_debugfs_register(xprt);
1385 dprintk("RPC: created transport %p with %u slots\n", xprt,
1392 * xprt_destroy - destroy an RPC transport, killing off all requests.
1393 * @xprt: transport to destroy
1396 static void xprt_destroy(struct rpc_xprt *xprt)
1398 dprintk("RPC: destroying transport %p\n", xprt);
1400 /* Exclude transport connect/disconnect handlers */
1401 wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_UNINTERRUPTIBLE);
1403 del_timer_sync(&xprt->timer);
1405 rpc_xprt_debugfs_unregister(xprt);
1406 rpc_destroy_wait_queue(&xprt->binding);
1407 rpc_destroy_wait_queue(&xprt->pending);
1408 rpc_destroy_wait_queue(&xprt->sending);
1409 rpc_destroy_wait_queue(&xprt->backlog);
1410 cancel_work_sync(&xprt->task_cleanup);
1411 kfree(xprt->servername);
1413 * Tear down transport state and free the rpc_xprt
1415 xprt->ops->destroy(xprt);
1419 * xprt_put - release a reference to an RPC transport.
1420 * @xprt: pointer to the transport
1423 void xprt_put(struct rpc_xprt *xprt)
1425 if (atomic_dec_and_test(&xprt->count))