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.
35 * Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
37 * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
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
))
762 if (!xprt_connected(xprt
)) {
763 xprt
->stat
.connect_start
= jiffies
;
764 xprt
->ops
->connect(xprt
, task
);
766 xprt_clear_connecting(xprt
);
768 rpc_wake_up_queued_task(&xprt
->pending
, task
);
771 xprt_release_write(xprt
, task
);
774 static void xprt_connect_status(struct rpc_task
*task
)
776 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
778 if (task
->tk_status
== 0) {
779 xprt
->stat
.connect_count
++;
780 xprt
->stat
.connect_time
+= (long)jiffies
- xprt
->stat
.connect_start
;
781 dprintk("RPC: %5u xprt_connect_status: connection established\n",
786 switch (task
->tk_status
) {
794 dprintk("RPC: %5u xprt_connect_status: retrying\n", task
->tk_pid
);
797 dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
798 "out\n", task
->tk_pid
);
801 dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
802 "server %s\n", task
->tk_pid
, -task
->tk_status
,
804 task
->tk_status
= -EIO
;
809 * xprt_lookup_rqst - find an RPC request corresponding to an XID
810 * @xprt: transport on which the original request was transmitted
811 * @xid: RPC XID of incoming reply
814 struct rpc_rqst
*xprt_lookup_rqst(struct rpc_xprt
*xprt
, __be32 xid
)
816 struct rpc_rqst
*entry
;
818 list_for_each_entry(entry
, &xprt
->recv
, rq_list
)
819 if (entry
->rq_xid
== xid
) {
820 trace_xprt_lookup_rqst(xprt
, xid
, 0);
824 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
826 trace_xprt_lookup_rqst(xprt
, xid
, -ENOENT
);
827 xprt
->stat
.bad_xids
++;
830 EXPORT_SYMBOL_GPL(xprt_lookup_rqst
);
832 static void xprt_update_rtt(struct rpc_task
*task
)
834 struct rpc_rqst
*req
= task
->tk_rqstp
;
835 struct rpc_rtt
*rtt
= task
->tk_client
->cl_rtt
;
836 unsigned int timer
= task
->tk_msg
.rpc_proc
->p_timer
;
837 long m
= usecs_to_jiffies(ktime_to_us(req
->rq_rtt
));
840 if (req
->rq_ntrans
== 1)
841 rpc_update_rtt(rtt
, timer
, m
);
842 rpc_set_timeo(rtt
, timer
, req
->rq_ntrans
- 1);
847 * xprt_complete_rqst - called when reply processing is complete
848 * @task: RPC request that recently completed
849 * @copied: actual number of bytes received from the transport
851 * Caller holds transport lock.
853 void xprt_complete_rqst(struct rpc_task
*task
, int copied
)
855 struct rpc_rqst
*req
= task
->tk_rqstp
;
856 struct rpc_xprt
*xprt
= req
->rq_xprt
;
858 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
859 task
->tk_pid
, ntohl(req
->rq_xid
), copied
);
860 trace_xprt_complete_rqst(xprt
, req
->rq_xid
, copied
);
863 req
->rq_rtt
= ktime_sub(ktime_get(), req
->rq_xtime
);
864 if (xprt
->ops
->timer
!= NULL
)
865 xprt_update_rtt(task
);
867 list_del_init(&req
->rq_list
);
868 req
->rq_private_buf
.len
= copied
;
869 /* Ensure all writes are done before we update */
870 /* req->rq_reply_bytes_recvd */
872 req
->rq_reply_bytes_recvd
= copied
;
873 rpc_wake_up_queued_task(&xprt
->pending
, task
);
875 EXPORT_SYMBOL_GPL(xprt_complete_rqst
);
877 static void xprt_timer(struct rpc_task
*task
)
879 struct rpc_rqst
*req
= task
->tk_rqstp
;
880 struct rpc_xprt
*xprt
= req
->rq_xprt
;
882 if (task
->tk_status
!= -ETIMEDOUT
)
884 dprintk("RPC: %5u xprt_timer\n", task
->tk_pid
);
886 spin_lock_bh(&xprt
->transport_lock
);
887 if (!req
->rq_reply_bytes_recvd
) {
888 if (xprt
->ops
->timer
)
889 xprt
->ops
->timer(xprt
, task
);
892 spin_unlock_bh(&xprt
->transport_lock
);
895 static inline int xprt_has_timer(struct rpc_xprt
*xprt
)
897 return xprt
->idle_timeout
!= 0;
901 * xprt_prepare_transmit - reserve the transport before sending a request
902 * @task: RPC task about to send a request
905 bool xprt_prepare_transmit(struct rpc_task
*task
)
907 struct rpc_rqst
*req
= task
->tk_rqstp
;
908 struct rpc_xprt
*xprt
= req
->rq_xprt
;
911 dprintk("RPC: %5u xprt_prepare_transmit\n", task
->tk_pid
);
913 spin_lock_bh(&xprt
->transport_lock
);
914 if (!req
->rq_bytes_sent
) {
915 if (req
->rq_reply_bytes_recvd
) {
916 task
->tk_status
= req
->rq_reply_bytes_recvd
;
919 if ((task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
)
920 && xprt_connected(xprt
)
921 && req
->rq_connect_cookie
== xprt
->connect_cookie
) {
922 xprt
->ops
->set_retrans_timeout(task
);
923 rpc_sleep_on(&xprt
->pending
, task
, xprt_timer
);
927 if (!xprt
->ops
->reserve_xprt(xprt
, task
)) {
928 task
->tk_status
= -EAGAIN
;
933 spin_unlock_bh(&xprt
->transport_lock
);
937 void xprt_end_transmit(struct rpc_task
*task
)
939 xprt_release_write(task
->tk_rqstp
->rq_xprt
, task
);
943 * xprt_transmit - send an RPC request on a transport
944 * @task: controlling RPC task
946 * We have to copy the iovec because sendmsg fiddles with its contents.
948 void xprt_transmit(struct rpc_task
*task
)
950 struct rpc_rqst
*req
= task
->tk_rqstp
;
951 struct rpc_xprt
*xprt
= req
->rq_xprt
;
954 dprintk("RPC: %5u xprt_transmit(%u)\n", task
->tk_pid
, req
->rq_slen
);
956 if (!req
->rq_reply_bytes_recvd
) {
957 if (list_empty(&req
->rq_list
) && rpc_reply_expected(task
)) {
959 * Add to the list only if we're expecting a reply
961 spin_lock_bh(&xprt
->transport_lock
);
962 /* Update the softirq receive buffer */
963 memcpy(&req
->rq_private_buf
, &req
->rq_rcv_buf
,
964 sizeof(req
->rq_private_buf
));
965 /* Add request to the receive list */
966 list_add_tail(&req
->rq_list
, &xprt
->recv
);
967 spin_unlock_bh(&xprt
->transport_lock
);
968 xprt_reset_majortimeo(req
);
969 /* Turn off autodisconnect */
970 del_singleshot_timer_sync(&xprt
->timer
);
972 } else if (!req
->rq_bytes_sent
)
975 req
->rq_xtime
= ktime_get();
976 status
= xprt
->ops
->send_request(task
);
977 trace_xprt_transmit(xprt
, req
->rq_xid
, status
);
979 task
->tk_status
= status
;
982 xprt_inject_disconnect(xprt
);
984 dprintk("RPC: %5u xmit complete\n", task
->tk_pid
);
985 task
->tk_flags
|= RPC_TASK_SENT
;
986 spin_lock_bh(&xprt
->transport_lock
);
988 xprt
->ops
->set_retrans_timeout(task
);
990 numreqs
= atomic_read(&xprt
->num_reqs
);
991 if (numreqs
> xprt
->stat
.max_slots
)
992 xprt
->stat
.max_slots
= numreqs
;
994 xprt
->stat
.req_u
+= xprt
->stat
.sends
- xprt
->stat
.recvs
;
995 xprt
->stat
.bklog_u
+= xprt
->backlog
.qlen
;
996 xprt
->stat
.sending_u
+= xprt
->sending
.qlen
;
997 xprt
->stat
.pending_u
+= xprt
->pending
.qlen
;
999 /* Don't race with disconnect */
1000 if (!xprt_connected(xprt
))
1001 task
->tk_status
= -ENOTCONN
;
1004 * Sleep on the pending queue since
1005 * we're expecting a reply.
1007 if (!req
->rq_reply_bytes_recvd
&& rpc_reply_expected(task
))
1008 rpc_sleep_on(&xprt
->pending
, task
, xprt_timer
);
1009 req
->rq_connect_cookie
= xprt
->connect_cookie
;
1011 spin_unlock_bh(&xprt
->transport_lock
);
1014 static void xprt_add_backlog(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1016 set_bit(XPRT_CONGESTED
, &xprt
->state
);
1017 rpc_sleep_on(&xprt
->backlog
, task
, NULL
);
1020 static void xprt_wake_up_backlog(struct rpc_xprt
*xprt
)
1022 if (rpc_wake_up_next(&xprt
->backlog
) == NULL
)
1023 clear_bit(XPRT_CONGESTED
, &xprt
->state
);
1026 static bool xprt_throttle_congested(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1030 if (!test_bit(XPRT_CONGESTED
, &xprt
->state
))
1032 spin_lock(&xprt
->reserve_lock
);
1033 if (test_bit(XPRT_CONGESTED
, &xprt
->state
)) {
1034 rpc_sleep_on(&xprt
->backlog
, task
, NULL
);
1037 spin_unlock(&xprt
->reserve_lock
);
1042 static struct rpc_rqst
*xprt_dynamic_alloc_slot(struct rpc_xprt
*xprt
, gfp_t gfp_flags
)
1044 struct rpc_rqst
*req
= ERR_PTR(-EAGAIN
);
1046 if (!atomic_add_unless(&xprt
->num_reqs
, 1, xprt
->max_reqs
))
1048 req
= kzalloc(sizeof(struct rpc_rqst
), gfp_flags
);
1051 atomic_dec(&xprt
->num_reqs
);
1052 req
= ERR_PTR(-ENOMEM
);
1057 static bool xprt_dynamic_free_slot(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
1059 if (atomic_add_unless(&xprt
->num_reqs
, -1, xprt
->min_reqs
)) {
1066 void xprt_alloc_slot(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1068 struct rpc_rqst
*req
;
1070 spin_lock(&xprt
->reserve_lock
);
1071 if (!list_empty(&xprt
->free
)) {
1072 req
= list_entry(xprt
->free
.next
, struct rpc_rqst
, rq_list
);
1073 list_del(&req
->rq_list
);
1076 req
= xprt_dynamic_alloc_slot(xprt
, GFP_NOWAIT
|__GFP_NOWARN
);
1079 switch (PTR_ERR(req
)) {
1081 dprintk("RPC: dynamic allocation of request slot "
1082 "failed! Retrying\n");
1083 task
->tk_status
= -ENOMEM
;
1086 xprt_add_backlog(xprt
, task
);
1087 dprintk("RPC: waiting for request slot\n");
1089 task
->tk_status
= -EAGAIN
;
1091 spin_unlock(&xprt
->reserve_lock
);
1094 task
->tk_status
= 0;
1095 task
->tk_rqstp
= req
;
1096 xprt_request_init(task
, xprt
);
1097 spin_unlock(&xprt
->reserve_lock
);
1099 EXPORT_SYMBOL_GPL(xprt_alloc_slot
);
1101 void xprt_lock_and_alloc_slot(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1103 /* Note: grabbing the xprt_lock_write() ensures that we throttle
1104 * new slot allocation if the transport is congested (i.e. when
1105 * reconnecting a stream transport or when out of socket write
1108 if (xprt_lock_write(xprt
, task
)) {
1109 xprt_alloc_slot(xprt
, task
);
1110 xprt_release_write(xprt
, task
);
1113 EXPORT_SYMBOL_GPL(xprt_lock_and_alloc_slot
);
1115 static void xprt_free_slot(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
1117 spin_lock(&xprt
->reserve_lock
);
1118 if (!xprt_dynamic_free_slot(xprt
, req
)) {
1119 memset(req
, 0, sizeof(*req
)); /* mark unused */
1120 list_add(&req
->rq_list
, &xprt
->free
);
1122 xprt_wake_up_backlog(xprt
);
1123 spin_unlock(&xprt
->reserve_lock
);
1126 static void xprt_free_all_slots(struct rpc_xprt
*xprt
)
1128 struct rpc_rqst
*req
;
1129 while (!list_empty(&xprt
->free
)) {
1130 req
= list_first_entry(&xprt
->free
, struct rpc_rqst
, rq_list
);
1131 list_del(&req
->rq_list
);
1136 struct rpc_xprt
*xprt_alloc(struct net
*net
, size_t size
,
1137 unsigned int num_prealloc
,
1138 unsigned int max_alloc
)
1140 struct rpc_xprt
*xprt
;
1141 struct rpc_rqst
*req
;
1144 xprt
= kzalloc(size
, GFP_KERNEL
);
1148 xprt_init(xprt
, net
);
1150 for (i
= 0; i
< num_prealloc
; i
++) {
1151 req
= kzalloc(sizeof(struct rpc_rqst
), GFP_KERNEL
);
1154 list_add(&req
->rq_list
, &xprt
->free
);
1156 if (max_alloc
> num_prealloc
)
1157 xprt
->max_reqs
= max_alloc
;
1159 xprt
->max_reqs
= num_prealloc
;
1160 xprt
->min_reqs
= num_prealloc
;
1161 atomic_set(&xprt
->num_reqs
, num_prealloc
);
1170 EXPORT_SYMBOL_GPL(xprt_alloc
);
1172 void xprt_free(struct rpc_xprt
*xprt
)
1174 put_net(xprt
->xprt_net
);
1175 xprt_free_all_slots(xprt
);
1178 EXPORT_SYMBOL_GPL(xprt_free
);
1181 * xprt_reserve - allocate an RPC request slot
1182 * @task: RPC task requesting a slot allocation
1184 * If the transport is marked as being congested, or if no more
1185 * slots are available, place the task on the transport's
1188 void xprt_reserve(struct rpc_task
*task
)
1190 struct rpc_xprt
*xprt
;
1192 task
->tk_status
= 0;
1193 if (task
->tk_rqstp
!= NULL
)
1196 task
->tk_timeout
= 0;
1197 task
->tk_status
= -EAGAIN
;
1199 xprt
= rcu_dereference(task
->tk_client
->cl_xprt
);
1200 if (!xprt_throttle_congested(xprt
, task
))
1201 xprt
->ops
->alloc_slot(xprt
, task
);
1206 * xprt_retry_reserve - allocate an RPC request slot
1207 * @task: RPC task requesting a slot allocation
1209 * If no more slots are available, place the task on the transport's
1211 * Note that the only difference with xprt_reserve is that we now
1212 * ignore the value of the XPRT_CONGESTED flag.
1214 void xprt_retry_reserve(struct rpc_task
*task
)
1216 struct rpc_xprt
*xprt
;
1218 task
->tk_status
= 0;
1219 if (task
->tk_rqstp
!= NULL
)
1222 task
->tk_timeout
= 0;
1223 task
->tk_status
= -EAGAIN
;
1225 xprt
= rcu_dereference(task
->tk_client
->cl_xprt
);
1226 xprt
->ops
->alloc_slot(xprt
, task
);
1230 static inline __be32
xprt_alloc_xid(struct rpc_xprt
*xprt
)
1232 return (__force __be32
)xprt
->xid
++;
1235 static inline void xprt_init_xid(struct rpc_xprt
*xprt
)
1237 xprt
->xid
= prandom_u32();
1240 static void xprt_request_init(struct rpc_task
*task
, struct rpc_xprt
*xprt
)
1242 struct rpc_rqst
*req
= task
->tk_rqstp
;
1244 INIT_LIST_HEAD(&req
->rq_list
);
1245 req
->rq_timeout
= task
->tk_client
->cl_timeout
->to_initval
;
1246 req
->rq_task
= task
;
1247 req
->rq_xprt
= xprt
;
1248 req
->rq_buffer
= NULL
;
1249 req
->rq_xid
= xprt_alloc_xid(xprt
);
1250 req
->rq_connect_cookie
= xprt
->connect_cookie
- 1;
1251 req
->rq_bytes_sent
= 0;
1252 req
->rq_snd_buf
.len
= 0;
1253 req
->rq_snd_buf
.buflen
= 0;
1254 req
->rq_rcv_buf
.len
= 0;
1255 req
->rq_rcv_buf
.buflen
= 0;
1256 req
->rq_release_snd_buf
= NULL
;
1257 xprt_reset_majortimeo(req
);
1258 dprintk("RPC: %5u reserved req %p xid %08x\n", task
->tk_pid
,
1259 req
, ntohl(req
->rq_xid
));
1263 * xprt_release - release an RPC request slot
1264 * @task: task which is finished with the slot
1267 void xprt_release(struct rpc_task
*task
)
1269 struct rpc_xprt
*xprt
;
1270 struct rpc_rqst
*req
= task
->tk_rqstp
;
1273 if (task
->tk_client
) {
1275 xprt
= rcu_dereference(task
->tk_client
->cl_xprt
);
1276 if (xprt
->snd_task
== task
)
1277 xprt_release_write(xprt
, task
);
1283 xprt
= req
->rq_xprt
;
1284 if (task
->tk_ops
->rpc_count_stats
!= NULL
)
1285 task
->tk_ops
->rpc_count_stats(task
, task
->tk_calldata
);
1286 else if (task
->tk_client
)
1287 rpc_count_iostats(task
, task
->tk_client
->cl_metrics
);
1288 spin_lock_bh(&xprt
->transport_lock
);
1289 xprt
->ops
->release_xprt(xprt
, task
);
1290 if (xprt
->ops
->release_request
)
1291 xprt
->ops
->release_request(task
);
1292 if (!list_empty(&req
->rq_list
))
1293 list_del(&req
->rq_list
);
1294 xprt
->last_used
= jiffies
;
1295 if (list_empty(&xprt
->recv
) && xprt_has_timer(xprt
))
1296 mod_timer(&xprt
->timer
,
1297 xprt
->last_used
+ xprt
->idle_timeout
);
1298 spin_unlock_bh(&xprt
->transport_lock
);
1300 xprt
->ops
->buf_free(req
->rq_buffer
);
1301 xprt_inject_disconnect(xprt
);
1302 if (req
->rq_cred
!= NULL
)
1303 put_rpccred(req
->rq_cred
);
1304 task
->tk_rqstp
= NULL
;
1305 if (req
->rq_release_snd_buf
)
1306 req
->rq_release_snd_buf(req
);
1308 dprintk("RPC: %5u release request %p\n", task
->tk_pid
, req
);
1309 if (likely(!bc_prealloc(req
)))
1310 xprt_free_slot(xprt
, req
);
1312 xprt_free_bc_request(req
);
1315 static void xprt_init(struct rpc_xprt
*xprt
, struct net
*net
)
1317 atomic_set(&xprt
->count
, 1);
1319 spin_lock_init(&xprt
->transport_lock
);
1320 spin_lock_init(&xprt
->reserve_lock
);
1322 INIT_LIST_HEAD(&xprt
->free
);
1323 INIT_LIST_HEAD(&xprt
->recv
);
1324 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1325 spin_lock_init(&xprt
->bc_pa_lock
);
1326 INIT_LIST_HEAD(&xprt
->bc_pa_list
);
1327 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1329 xprt
->last_used
= jiffies
;
1330 xprt
->cwnd
= RPC_INITCWND
;
1331 xprt
->bind_index
= 0;
1333 rpc_init_wait_queue(&xprt
->binding
, "xprt_binding");
1334 rpc_init_wait_queue(&xprt
->pending
, "xprt_pending");
1335 rpc_init_priority_wait_queue(&xprt
->sending
, "xprt_sending");
1336 rpc_init_priority_wait_queue(&xprt
->backlog
, "xprt_backlog");
1338 xprt_init_xid(xprt
);
1340 xprt
->xprt_net
= get_net(net
);
1344 * xprt_create_transport - create an RPC transport
1345 * @args: rpc transport creation arguments
1348 struct rpc_xprt
*xprt_create_transport(struct xprt_create
*args
)
1350 struct rpc_xprt
*xprt
;
1351 struct xprt_class
*t
;
1353 spin_lock(&xprt_list_lock
);
1354 list_for_each_entry(t
, &xprt_list
, list
) {
1355 if (t
->ident
== args
->ident
) {
1356 spin_unlock(&xprt_list_lock
);
1360 spin_unlock(&xprt_list_lock
);
1361 dprintk("RPC: transport (%d) not supported\n", args
->ident
);
1362 return ERR_PTR(-EIO
);
1365 xprt
= t
->setup(args
);
1367 dprintk("RPC: xprt_create_transport: failed, %ld\n",
1371 if (args
->flags
& XPRT_CREATE_NO_IDLE_TIMEOUT
)
1372 xprt
->idle_timeout
= 0;
1373 INIT_WORK(&xprt
->task_cleanup
, xprt_autoclose
);
1374 if (xprt_has_timer(xprt
))
1375 setup_timer(&xprt
->timer
, xprt_init_autodisconnect
,
1376 (unsigned long)xprt
);
1378 init_timer(&xprt
->timer
);
1380 if (strlen(args
->servername
) > RPC_MAXNETNAMELEN
) {
1382 return ERR_PTR(-EINVAL
);
1384 xprt
->servername
= kstrdup(args
->servername
, GFP_KERNEL
);
1385 if (xprt
->servername
== NULL
) {
1387 return ERR_PTR(-ENOMEM
);
1390 rpc_xprt_debugfs_register(xprt
);
1392 dprintk("RPC: created transport %p with %u slots\n", xprt
,
1399 * xprt_destroy - destroy an RPC transport, killing off all requests.
1400 * @xprt: transport to destroy
1403 static void xprt_destroy(struct rpc_xprt
*xprt
)
1405 dprintk("RPC: destroying transport %p\n", xprt
);
1407 /* Exclude transport connect/disconnect handlers */
1408 wait_on_bit_lock(&xprt
->state
, XPRT_LOCKED
, TASK_UNINTERRUPTIBLE
);
1410 del_timer_sync(&xprt
->timer
);
1412 rpc_xprt_debugfs_unregister(xprt
);
1413 rpc_destroy_wait_queue(&xprt
->binding
);
1414 rpc_destroy_wait_queue(&xprt
->pending
);
1415 rpc_destroy_wait_queue(&xprt
->sending
);
1416 rpc_destroy_wait_queue(&xprt
->backlog
);
1417 cancel_work_sync(&xprt
->task_cleanup
);
1418 kfree(xprt
->servername
);
1420 * Tear down transport state and free the rpc_xprt
1422 xprt
->ops
->destroy(xprt
);
1426 * xprt_put - release a reference to an RPC transport.
1427 * @xprt: pointer to the transport
1430 void xprt_put(struct rpc_xprt
*xprt
)
1432 if (atomic_dec_and_test(&xprt
->count
))