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>
51 #include <linux/rcupdate.h>
53 #include <trace/events/sunrpc.h>
61 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
62 # define RPCDBG_FACILITY RPCDBG_XPRT
68 static void xprt_init(struct rpc_xprt
*xprt
, struct net
*net
);
69 static __be32
xprt_alloc_xid(struct rpc_xprt
*xprt
);
70 static void xprt_connect_status(struct rpc_task
*task
);
71 static void xprt_destroy(struct rpc_xprt
*xprt
);
73 static DEFINE_SPINLOCK(xprt_list_lock
);
74 static LIST_HEAD(xprt_list
);
77 * xprt_register_transport - register a transport implementation
78 * @transport: transport to register
80 * If a transport implementation is loaded as a kernel module, it can
81 * call this interface to make itself known to the RPC client.
84 * 0: transport successfully registered
85 * -EEXIST: transport already registered
86 * -EINVAL: transport module being unloaded
88 int xprt_register_transport(struct xprt_class
*transport
)
94 spin_lock(&xprt_list_lock
);
95 list_for_each_entry(t
, &xprt_list
, list
) {
96 /* don't register the same transport class twice */
97 if (t
->ident
== transport
->ident
)
101 list_add_tail(&transport
->list
, &xprt_list
);
102 printk(KERN_INFO
"RPC: Registered %s transport module.\n",
107 spin_unlock(&xprt_list_lock
);
110 EXPORT_SYMBOL_GPL(xprt_register_transport
);
113 * xprt_unregister_transport - unregister a transport implementation
114 * @transport: transport to unregister
117 * 0: transport successfully unregistered
118 * -ENOENT: transport never registered
120 int xprt_unregister_transport(struct xprt_class
*transport
)
122 struct xprt_class
*t
;
126 spin_lock(&xprt_list_lock
);
127 list_for_each_entry(t
, &xprt_list
, list
) {
128 if (t
== transport
) {
130 "RPC: Unregistered %s transport module.\n",
132 list_del_init(&transport
->list
);
139 spin_unlock(&xprt_list_lock
);
142 EXPORT_SYMBOL_GPL(xprt_unregister_transport
);
145 * xprt_load_transport - load a transport implementation
146 * @transport_name: transport to load
149 * 0: transport successfully loaded
150 * -ENOENT: transport module not available
152 int xprt_load_transport(const char *transport_name
)
154 struct xprt_class
*t
;
158 spin_lock(&xprt_list_lock
);
159 list_for_each_entry(t
, &xprt_list
, list
) {
160 if (strcmp(t
->name
, transport_name
) == 0) {
161 spin_unlock(&xprt_list_lock
);
165 spin_unlock(&xprt_list_lock
);
166 result
= request_module("xprt%s", transport_name
);
170 EXPORT_SYMBOL_GPL(xprt_load_transport
);
172 static void xprt_clear_locked(struct rpc_xprt
*xprt
)
174 xprt
->snd_task
= NULL
;
175 if (!test_bit(XPRT_CLOSE_WAIT
, &xprt
->state
)) {
176 smp_mb__before_atomic();
177 clear_bit(XPRT_LOCKED
, &xprt
->state
);
178 smp_mb__after_atomic();
180 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
184 * xprt_reserve_xprt - serialize write access to transports
185 * @task: task that is requesting access to the transport
186 * @xprt: pointer to the target transport
188 * This prevents mixing the payload of separate requests, and prevents
189 * transport connects from colliding with writes. No congestion control
192 int xprt_reserve_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
194 struct rpc_rqst
*req
= task
->tk_rqstp
;
196 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
)) {
197 if (task
== xprt
->snd_task
)
201 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
203 xprt
->snd_task
= task
;
208 xprt_clear_locked(xprt
);
210 dprintk("RPC: %5u failed to lock transport %p\n",
212 task
->tk_timeout
= RPC_IS_SOFT(task
) ? req
->rq_timeout
: 0;
213 task
->tk_status
= -EAGAIN
;
214 rpc_sleep_on(&xprt
->sending
, task
, NULL
);
217 EXPORT_SYMBOL_GPL(xprt_reserve_xprt
);
220 xprt_need_congestion_window_wait(struct rpc_xprt
*xprt
)
222 return test_bit(XPRT_CWND_WAIT
, &xprt
->state
);
226 xprt_set_congestion_window_wait(struct rpc_xprt
*xprt
)
228 if (!list_empty(&xprt
->xmit_queue
)) {
229 /* Peek at head of queue to see if it can make progress */
230 if (list_first_entry(&xprt
->xmit_queue
, struct rpc_rqst
,
234 set_bit(XPRT_CWND_WAIT
, &xprt
->state
);
238 xprt_test_and_clear_congestion_window_wait(struct rpc_xprt
*xprt
)
240 if (!RPCXPRT_CONGESTED(xprt
))
241 clear_bit(XPRT_CWND_WAIT
, &xprt
->state
);
245 * xprt_reserve_xprt_cong - serialize write access to transports
246 * @task: task that is requesting access to the transport
248 * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
249 * integrated into the decision of whether a request is allowed to be
250 * woken up and given access to the transport.
251 * Note that the lock is only granted if we know there are free slots.
253 int xprt_reserve_xprt_cong(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
255 struct rpc_rqst
*req
= task
->tk_rqstp
;
257 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
)) {
258 if (task
== xprt
->snd_task
)
263 xprt
->snd_task
= task
;
266 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
268 if (!xprt_need_congestion_window_wait(xprt
)) {
269 xprt
->snd_task
= task
;
273 xprt_clear_locked(xprt
);
275 dprintk("RPC: %5u failed to lock transport %p\n", task
->tk_pid
, xprt
);
276 task
->tk_timeout
= RPC_IS_SOFT(task
) ? req
->rq_timeout
: 0;
277 task
->tk_status
= -EAGAIN
;
278 rpc_sleep_on(&xprt
->sending
, task
, NULL
);
281 EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong
);
283 static inline int xprt_lock_write(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
287 if (test_bit(XPRT_LOCKED
, &xprt
->state
) && xprt
->snd_task
== task
)
289 spin_lock_bh(&xprt
->transport_lock
);
290 retval
= xprt
->ops
->reserve_xprt(xprt
, task
);
291 spin_unlock_bh(&xprt
->transport_lock
);
295 static bool __xprt_lock_write_func(struct rpc_task
*task
, void *data
)
297 struct rpc_xprt
*xprt
= data
;
299 xprt
->snd_task
= task
;
303 static void __xprt_lock_write_next(struct rpc_xprt
*xprt
)
305 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
))
307 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
309 if (rpc_wake_up_first_on_wq(xprtiod_workqueue
, &xprt
->sending
,
310 __xprt_lock_write_func
, xprt
))
313 xprt_clear_locked(xprt
);
316 static void __xprt_lock_write_next_cong(struct rpc_xprt
*xprt
)
318 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
))
320 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
322 if (xprt_need_congestion_window_wait(xprt
))
324 if (rpc_wake_up_first_on_wq(xprtiod_workqueue
, &xprt
->sending
,
325 __xprt_lock_write_func
, xprt
))
328 xprt_clear_locked(xprt
);
332 * xprt_release_xprt - allow other requests to use a transport
333 * @xprt: transport with other tasks potentially waiting
334 * @task: task that is releasing access to the transport
336 * Note that "task" can be NULL. No congestion control is provided.
338 void xprt_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
340 if (xprt
->snd_task
== task
) {
341 xprt_clear_locked(xprt
);
342 __xprt_lock_write_next(xprt
);
345 EXPORT_SYMBOL_GPL(xprt_release_xprt
);
348 * xprt_release_xprt_cong - allow other requests to use a transport
349 * @xprt: transport with other tasks potentially waiting
350 * @task: task that is releasing access to the transport
352 * Note that "task" can be NULL. Another task is awoken to use the
353 * transport if the transport's congestion window allows it.
355 void xprt_release_xprt_cong(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
357 if (xprt
->snd_task
== task
) {
358 xprt_clear_locked(xprt
);
359 __xprt_lock_write_next_cong(xprt
);
362 EXPORT_SYMBOL_GPL(xprt_release_xprt_cong
);
364 static inline void xprt_release_write(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
366 if (xprt
->snd_task
!= task
)
368 spin_lock_bh(&xprt
->transport_lock
);
369 xprt
->ops
->release_xprt(xprt
, task
);
370 spin_unlock_bh(&xprt
->transport_lock
);
374 * Van Jacobson congestion avoidance. Check if the congestion window
375 * overflowed. Put the task to sleep if this is the case.
378 __xprt_get_cong(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
382 dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
383 req
->rq_task
->tk_pid
, xprt
->cong
, xprt
->cwnd
);
384 if (RPCXPRT_CONGESTED(xprt
)) {
385 xprt_set_congestion_window_wait(xprt
);
389 xprt
->cong
+= RPC_CWNDSCALE
;
394 * Adjust the congestion window, and wake up the next task
395 * that has been sleeping due to congestion
398 __xprt_put_cong(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
403 xprt
->cong
-= RPC_CWNDSCALE
;
404 xprt_test_and_clear_congestion_window_wait(xprt
);
405 __xprt_lock_write_next_cong(xprt
);
409 * xprt_request_get_cong - Request congestion control credits
410 * @xprt: pointer to transport
411 * @req: pointer to RPC request
413 * Useful for transports that require congestion control.
416 xprt_request_get_cong(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
422 spin_lock_bh(&xprt
->transport_lock
);
423 ret
= __xprt_get_cong(xprt
, req
) != 0;
424 spin_unlock_bh(&xprt
->transport_lock
);
427 EXPORT_SYMBOL_GPL(xprt_request_get_cong
);
430 * xprt_release_rqst_cong - housekeeping when request is complete
431 * @task: RPC request that recently completed
433 * Useful for transports that require congestion control.
435 void xprt_release_rqst_cong(struct rpc_task
*task
)
437 struct rpc_rqst
*req
= task
->tk_rqstp
;
439 __xprt_put_cong(req
->rq_xprt
, req
);
441 EXPORT_SYMBOL_GPL(xprt_release_rqst_cong
);
444 * Clear the congestion window wait flag and wake up the next
445 * entry on xprt->sending
448 xprt_clear_congestion_window_wait(struct rpc_xprt
*xprt
)
450 if (test_and_clear_bit(XPRT_CWND_WAIT
, &xprt
->state
)) {
451 spin_lock_bh(&xprt
->transport_lock
);
452 __xprt_lock_write_next_cong(xprt
);
453 spin_unlock_bh(&xprt
->transport_lock
);
458 * xprt_adjust_cwnd - adjust transport congestion window
459 * @xprt: pointer to xprt
460 * @task: recently completed RPC request used to adjust window
461 * @result: result code of completed RPC request
463 * The transport code maintains an estimate on the maximum number of out-
464 * standing RPC requests, using a smoothed version of the congestion
465 * avoidance implemented in 44BSD. This is basically the Van Jacobson
466 * congestion algorithm: If a retransmit occurs, the congestion window is
467 * halved; otherwise, it is incremented by 1/cwnd when
469 * - a reply is received and
470 * - a full number of requests are outstanding and
471 * - the congestion window hasn't been updated recently.
473 void xprt_adjust_cwnd(struct rpc_xprt
*xprt
, struct rpc_task
*task
, int result
)
475 struct rpc_rqst
*req
= task
->tk_rqstp
;
476 unsigned long cwnd
= xprt
->cwnd
;
478 if (result
>= 0 && cwnd
<= xprt
->cong
) {
479 /* The (cwnd >> 1) term makes sure
480 * the result gets rounded properly. */
481 cwnd
+= (RPC_CWNDSCALE
* RPC_CWNDSCALE
+ (cwnd
>> 1)) / cwnd
;
482 if (cwnd
> RPC_MAXCWND(xprt
))
483 cwnd
= RPC_MAXCWND(xprt
);
484 __xprt_lock_write_next_cong(xprt
);
485 } else if (result
== -ETIMEDOUT
) {
487 if (cwnd
< RPC_CWNDSCALE
)
488 cwnd
= RPC_CWNDSCALE
;
490 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
491 xprt
->cong
, xprt
->cwnd
, cwnd
);
493 __xprt_put_cong(xprt
, req
);
495 EXPORT_SYMBOL_GPL(xprt_adjust_cwnd
);
498 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
499 * @xprt: transport with waiting tasks
500 * @status: result code to plant in each task before waking it
503 void xprt_wake_pending_tasks(struct rpc_xprt
*xprt
, int status
)
506 rpc_wake_up_status(&xprt
->pending
, status
);
508 rpc_wake_up(&xprt
->pending
);
510 EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks
);
513 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
516 * Note that we only set the timer for the case of RPC_IS_SOFT(), since
517 * we don't in general want to force a socket disconnection due to
518 * an incomplete RPC call transmission.
520 void xprt_wait_for_buffer_space(struct rpc_xprt
*xprt
)
522 set_bit(XPRT_WRITE_SPACE
, &xprt
->state
);
524 EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space
);
527 xprt_clear_write_space_locked(struct rpc_xprt
*xprt
)
529 if (test_and_clear_bit(XPRT_WRITE_SPACE
, &xprt
->state
)) {
530 __xprt_lock_write_next(xprt
);
531 dprintk("RPC: write space: waking waiting task on "
539 * xprt_write_space - wake the task waiting for transport output buffer space
540 * @xprt: transport with waiting tasks
542 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
544 bool xprt_write_space(struct rpc_xprt
*xprt
)
548 if (!test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
550 spin_lock_bh(&xprt
->transport_lock
);
551 ret
= xprt_clear_write_space_locked(xprt
);
552 spin_unlock_bh(&xprt
->transport_lock
);
555 EXPORT_SYMBOL_GPL(xprt_write_space
);
558 * xprt_set_retrans_timeout_def - set a request's retransmit timeout
559 * @task: task whose timeout is to be set
561 * Set a request's retransmit timeout based on the transport's
562 * default timeout parameters. Used by transports that don't adjust
563 * the retransmit timeout based on round-trip time estimation.
565 void xprt_set_retrans_timeout_def(struct rpc_task
*task
)
567 task
->tk_timeout
= task
->tk_rqstp
->rq_timeout
;
569 EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def
);
572 * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
573 * @task: task whose timeout is to be set
575 * Set a request's retransmit timeout using the RTT estimator.
577 void xprt_set_retrans_timeout_rtt(struct rpc_task
*task
)
579 int timer
= task
->tk_msg
.rpc_proc
->p_timer
;
580 struct rpc_clnt
*clnt
= task
->tk_client
;
581 struct rpc_rtt
*rtt
= clnt
->cl_rtt
;
582 struct rpc_rqst
*req
= task
->tk_rqstp
;
583 unsigned long max_timeout
= clnt
->cl_timeout
->to_maxval
;
585 task
->tk_timeout
= rpc_calc_rto(rtt
, timer
);
586 task
->tk_timeout
<<= rpc_ntimeo(rtt
, timer
) + req
->rq_retries
;
587 if (task
->tk_timeout
> max_timeout
|| task
->tk_timeout
== 0)
588 task
->tk_timeout
= max_timeout
;
590 EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt
);
592 static void xprt_reset_majortimeo(struct rpc_rqst
*req
)
594 const struct rpc_timeout
*to
= req
->rq_task
->tk_client
->cl_timeout
;
596 req
->rq_majortimeo
= req
->rq_timeout
;
597 if (to
->to_exponential
)
598 req
->rq_majortimeo
<<= to
->to_retries
;
600 req
->rq_majortimeo
+= to
->to_increment
* to
->to_retries
;
601 if (req
->rq_majortimeo
> to
->to_maxval
|| req
->rq_majortimeo
== 0)
602 req
->rq_majortimeo
= to
->to_maxval
;
603 req
->rq_majortimeo
+= jiffies
;
607 * xprt_adjust_timeout - adjust timeout values for next retransmit
608 * @req: RPC request containing parameters to use for the adjustment
611 int xprt_adjust_timeout(struct rpc_rqst
*req
)
613 struct rpc_xprt
*xprt
= req
->rq_xprt
;
614 const struct rpc_timeout
*to
= req
->rq_task
->tk_client
->cl_timeout
;
617 if (time_before(jiffies
, req
->rq_majortimeo
)) {
618 if (to
->to_exponential
)
619 req
->rq_timeout
<<= 1;
621 req
->rq_timeout
+= to
->to_increment
;
622 if (to
->to_maxval
&& req
->rq_timeout
>= to
->to_maxval
)
623 req
->rq_timeout
= to
->to_maxval
;
626 req
->rq_timeout
= to
->to_initval
;
628 xprt_reset_majortimeo(req
);
629 /* Reset the RTT counters == "slow start" */
630 spin_lock_bh(&xprt
->transport_lock
);
631 rpc_init_rtt(req
->rq_task
->tk_client
->cl_rtt
, to
->to_initval
);
632 spin_unlock_bh(&xprt
->transport_lock
);
636 if (req
->rq_timeout
== 0) {
637 printk(KERN_WARNING
"xprt_adjust_timeout: rq_timeout = 0!\n");
638 req
->rq_timeout
= 5 * HZ
;
643 static void xprt_autoclose(struct work_struct
*work
)
645 struct rpc_xprt
*xprt
=
646 container_of(work
, struct rpc_xprt
, task_cleanup
);
648 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
649 xprt
->ops
->close(xprt
);
650 xprt_release_write(xprt
, NULL
);
651 wake_up_bit(&xprt
->state
, XPRT_LOCKED
);
655 * xprt_disconnect_done - mark a transport as disconnected
656 * @xprt: transport to flag for disconnect
659 void xprt_disconnect_done(struct rpc_xprt
*xprt
)
661 dprintk("RPC: disconnected transport %p\n", xprt
);
662 spin_lock_bh(&xprt
->transport_lock
);
663 xprt_clear_connected(xprt
);
664 xprt_clear_write_space_locked(xprt
);
665 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
666 spin_unlock_bh(&xprt
->transport_lock
);
668 EXPORT_SYMBOL_GPL(xprt_disconnect_done
);
671 * xprt_force_disconnect - force a transport to disconnect
672 * @xprt: transport to disconnect
675 void xprt_force_disconnect(struct rpc_xprt
*xprt
)
677 /* Don't race with the test_bit() in xprt_clear_locked() */
678 spin_lock_bh(&xprt
->transport_lock
);
679 set_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
680 /* Try to schedule an autoclose RPC call */
681 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
) == 0)
682 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
683 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
684 spin_unlock_bh(&xprt
->transport_lock
);
686 EXPORT_SYMBOL_GPL(xprt_force_disconnect
);
689 xprt_connect_cookie(struct rpc_xprt
*xprt
)
691 return READ_ONCE(xprt
->connect_cookie
);
695 xprt_request_retransmit_after_disconnect(struct rpc_task
*task
)
697 struct rpc_rqst
*req
= task
->tk_rqstp
;
698 struct rpc_xprt
*xprt
= req
->rq_xprt
;
700 return req
->rq_connect_cookie
!= xprt_connect_cookie(xprt
) ||
701 !xprt_connected(xprt
);
705 * xprt_conditional_disconnect - force a transport to disconnect
706 * @xprt: transport to disconnect
707 * @cookie: 'connection cookie'
709 * This attempts to break the connection if and only if 'cookie' matches
710 * the current transport 'connection cookie'. It ensures that we don't
711 * try to break the connection more than once when we need to retransmit
712 * a batch of RPC requests.
715 void xprt_conditional_disconnect(struct rpc_xprt
*xprt
, unsigned int cookie
)
717 /* Don't race with the test_bit() in xprt_clear_locked() */
718 spin_lock_bh(&xprt
->transport_lock
);
719 if (cookie
!= xprt
->connect_cookie
)
721 if (test_bit(XPRT_CLOSING
, &xprt
->state
))
723 set_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
724 /* Try to schedule an autoclose RPC call */
725 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
) == 0)
726 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
727 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
729 spin_unlock_bh(&xprt
->transport_lock
);
733 xprt_has_timer(const struct rpc_xprt
*xprt
)
735 return xprt
->idle_timeout
!= 0;
739 xprt_schedule_autodisconnect(struct rpc_xprt
*xprt
)
740 __must_hold(&xprt
->transport_lock
)
742 if (RB_EMPTY_ROOT(&xprt
->recv_queue
) && xprt_has_timer(xprt
))
743 mod_timer(&xprt
->timer
, xprt
->last_used
+ xprt
->idle_timeout
);
747 xprt_init_autodisconnect(struct timer_list
*t
)
749 struct rpc_xprt
*xprt
= from_timer(xprt
, t
, timer
);
751 spin_lock(&xprt
->transport_lock
);
752 if (!RB_EMPTY_ROOT(&xprt
->recv_queue
))
754 /* Reset xprt->last_used to avoid connect/autodisconnect cycling */
755 xprt
->last_used
= jiffies
;
756 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
))
758 spin_unlock(&xprt
->transport_lock
);
759 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
762 spin_unlock(&xprt
->transport_lock
);
765 bool xprt_lock_connect(struct rpc_xprt
*xprt
,
766 struct rpc_task
*task
,
771 spin_lock_bh(&xprt
->transport_lock
);
772 if (!test_bit(XPRT_LOCKED
, &xprt
->state
))
774 if (xprt
->snd_task
!= task
)
776 xprt
->snd_task
= cookie
;
779 spin_unlock_bh(&xprt
->transport_lock
);
783 void xprt_unlock_connect(struct rpc_xprt
*xprt
, void *cookie
)
785 spin_lock_bh(&xprt
->transport_lock
);
786 if (xprt
->snd_task
!= cookie
)
788 if (!test_bit(XPRT_LOCKED
, &xprt
->state
))
790 xprt
->snd_task
=NULL
;
791 xprt
->ops
->release_xprt(xprt
, NULL
);
792 xprt_schedule_autodisconnect(xprt
);
794 spin_unlock_bh(&xprt
->transport_lock
);
795 wake_up_bit(&xprt
->state
, XPRT_LOCKED
);
799 * xprt_connect - schedule a transport connect operation
800 * @task: RPC task that is requesting the connect
803 void xprt_connect(struct rpc_task
*task
)
805 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
807 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task
->tk_pid
,
808 xprt
, (xprt_connected(xprt
) ? "is" : "is not"));
810 if (!xprt_bound(xprt
)) {
811 task
->tk_status
= -EAGAIN
;
814 if (!xprt_lock_write(xprt
, task
))
817 if (test_and_clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
))
818 xprt
->ops
->close(xprt
);
820 if (!xprt_connected(xprt
)) {
821 task
->tk_timeout
= task
->tk_rqstp
->rq_timeout
;
822 task
->tk_rqstp
->rq_connect_cookie
= xprt
->connect_cookie
;
823 rpc_sleep_on(&xprt
->pending
, task
, xprt_connect_status
);
825 if (test_bit(XPRT_CLOSING
, &xprt
->state
))
827 if (xprt_test_and_set_connecting(xprt
))
830 if (!xprt_connected(xprt
)) {
831 xprt
->stat
.connect_start
= jiffies
;
832 xprt
->ops
->connect(xprt
, task
);
834 xprt_clear_connecting(xprt
);
836 rpc_wake_up_queued_task(&xprt
->pending
, task
);
839 xprt_release_write(xprt
, task
);
842 static void xprt_connect_status(struct rpc_task
*task
)
844 switch (task
->tk_status
) {
846 dprintk("RPC: %5u xprt_connect_status: connection established\n",
856 dprintk("RPC: %5u xprt_connect_status: retrying\n", task
->tk_pid
);
859 dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
860 "out\n", task
->tk_pid
);
863 dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
864 "server %s\n", task
->tk_pid
, -task
->tk_status
,
865 task
->tk_rqstp
->rq_xprt
->servername
);
866 task
->tk_status
= -EIO
;
870 enum xprt_xid_rb_cmp
{
875 static enum xprt_xid_rb_cmp
876 xprt_xid_cmp(__be32 xid1
, __be32 xid2
)
880 if ((__force u32
)xid1
< (__force u32
)xid2
)
885 static struct rpc_rqst
*
886 xprt_request_rb_find(struct rpc_xprt
*xprt
, __be32 xid
)
888 struct rb_node
*n
= xprt
->recv_queue
.rb_node
;
889 struct rpc_rqst
*req
;
892 req
= rb_entry(n
, struct rpc_rqst
, rq_recv
);
893 switch (xprt_xid_cmp(xid
, req
->rq_xid
)) {
908 xprt_request_rb_insert(struct rpc_xprt
*xprt
, struct rpc_rqst
*new)
910 struct rb_node
**p
= &xprt
->recv_queue
.rb_node
;
911 struct rb_node
*n
= NULL
;
912 struct rpc_rqst
*req
;
916 req
= rb_entry(n
, struct rpc_rqst
, rq_recv
);
917 switch(xprt_xid_cmp(new->rq_xid
, req
->rq_xid
)) {
925 WARN_ON_ONCE(new != req
);
929 rb_link_node(&new->rq_recv
, n
, p
);
930 rb_insert_color(&new->rq_recv
, &xprt
->recv_queue
);
934 xprt_request_rb_remove(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
936 rb_erase(&req
->rq_recv
, &xprt
->recv_queue
);
940 * xprt_lookup_rqst - find an RPC request corresponding to an XID
941 * @xprt: transport on which the original request was transmitted
942 * @xid: RPC XID of incoming reply
944 * Caller holds xprt->queue_lock.
946 struct rpc_rqst
*xprt_lookup_rqst(struct rpc_xprt
*xprt
, __be32 xid
)
948 struct rpc_rqst
*entry
;
950 entry
= xprt_request_rb_find(xprt
, xid
);
952 trace_xprt_lookup_rqst(xprt
, xid
, 0);
953 entry
->rq_rtt
= ktime_sub(ktime_get(), entry
->rq_xtime
);
957 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
959 trace_xprt_lookup_rqst(xprt
, xid
, -ENOENT
);
960 xprt
->stat
.bad_xids
++;
963 EXPORT_SYMBOL_GPL(xprt_lookup_rqst
);
966 xprt_is_pinned_rqst(struct rpc_rqst
*req
)
968 return atomic_read(&req
->rq_pin
) != 0;
972 * xprt_pin_rqst - Pin a request on the transport receive list
973 * @req: Request to pin
975 * Caller must ensure this is atomic with the call to xprt_lookup_rqst()
976 * so should be holding the xprt receive lock.
978 void xprt_pin_rqst(struct rpc_rqst
*req
)
980 atomic_inc(&req
->rq_pin
);
982 EXPORT_SYMBOL_GPL(xprt_pin_rqst
);
985 * xprt_unpin_rqst - Unpin a request on the transport receive list
986 * @req: Request to pin
988 * Caller should be holding the xprt receive lock.
990 void xprt_unpin_rqst(struct rpc_rqst
*req
)
992 if (!test_bit(RPC_TASK_MSG_PIN_WAIT
, &req
->rq_task
->tk_runstate
)) {
993 atomic_dec(&req
->rq_pin
);
996 if (atomic_dec_and_test(&req
->rq_pin
))
997 wake_up_var(&req
->rq_pin
);
999 EXPORT_SYMBOL_GPL(xprt_unpin_rqst
);
1001 static void xprt_wait_on_pinned_rqst(struct rpc_rqst
*req
)
1003 wait_var_event(&req
->rq_pin
, !xprt_is_pinned_rqst(req
));
1007 xprt_request_data_received(struct rpc_task
*task
)
1009 return !test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
) &&
1010 READ_ONCE(task
->tk_rqstp
->rq_reply_bytes_recvd
) != 0;
1014 xprt_request_need_enqueue_receive(struct rpc_task
*task
, struct rpc_rqst
*req
)
1016 return !test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
) &&
1017 READ_ONCE(task
->tk_rqstp
->rq_reply_bytes_recvd
) == 0;
1021 * xprt_request_enqueue_receive - Add an request to the receive queue
1026 xprt_request_enqueue_receive(struct rpc_task
*task
)
1028 struct rpc_rqst
*req
= task
->tk_rqstp
;
1029 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1031 if (!xprt_request_need_enqueue_receive(task
, req
))
1033 spin_lock(&xprt
->queue_lock
);
1035 /* Update the softirq receive buffer */
1036 memcpy(&req
->rq_private_buf
, &req
->rq_rcv_buf
,
1037 sizeof(req
->rq_private_buf
));
1039 /* Add request to the receive list */
1040 xprt_request_rb_insert(xprt
, req
);
1041 set_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
);
1042 spin_unlock(&xprt
->queue_lock
);
1044 xprt_reset_majortimeo(req
);
1045 /* Turn off autodisconnect */
1046 del_singleshot_timer_sync(&xprt
->timer
);
1050 * xprt_request_dequeue_receive_locked - Remove a request from the receive queue
1053 * Caller must hold xprt->queue_lock.
1056 xprt_request_dequeue_receive_locked(struct rpc_task
*task
)
1058 struct rpc_rqst
*req
= task
->tk_rqstp
;
1060 if (test_and_clear_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
))
1061 xprt_request_rb_remove(req
->rq_xprt
, req
);
1065 * xprt_update_rtt - Update RPC RTT statistics
1066 * @task: RPC request that recently completed
1068 * Caller holds xprt->queue_lock.
1070 void xprt_update_rtt(struct rpc_task
*task
)
1072 struct rpc_rqst
*req
= task
->tk_rqstp
;
1073 struct rpc_rtt
*rtt
= task
->tk_client
->cl_rtt
;
1074 unsigned int timer
= task
->tk_msg
.rpc_proc
->p_timer
;
1075 long m
= usecs_to_jiffies(ktime_to_us(req
->rq_rtt
));
1078 if (req
->rq_ntrans
== 1)
1079 rpc_update_rtt(rtt
, timer
, m
);
1080 rpc_set_timeo(rtt
, timer
, req
->rq_ntrans
- 1);
1083 EXPORT_SYMBOL_GPL(xprt_update_rtt
);
1086 * xprt_complete_rqst - called when reply processing is complete
1087 * @task: RPC request that recently completed
1088 * @copied: actual number of bytes received from the transport
1090 * Caller holds xprt->queue_lock.
1092 void xprt_complete_rqst(struct rpc_task
*task
, int copied
)
1094 struct rpc_rqst
*req
= task
->tk_rqstp
;
1095 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1097 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
1098 task
->tk_pid
, ntohl(req
->rq_xid
), copied
);
1099 trace_xprt_complete_rqst(xprt
, req
->rq_xid
, copied
);
1103 req
->rq_private_buf
.len
= copied
;
1104 /* Ensure all writes are done before we update */
1105 /* req->rq_reply_bytes_recvd */
1107 req
->rq_reply_bytes_recvd
= copied
;
1108 xprt_request_dequeue_receive_locked(task
);
1109 rpc_wake_up_queued_task(&xprt
->pending
, task
);
1111 EXPORT_SYMBOL_GPL(xprt_complete_rqst
);
1113 static void xprt_timer(struct rpc_task
*task
)
1115 struct rpc_rqst
*req
= task
->tk_rqstp
;
1116 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1118 if (task
->tk_status
!= -ETIMEDOUT
)
1121 trace_xprt_timer(xprt
, req
->rq_xid
, task
->tk_status
);
1122 if (!req
->rq_reply_bytes_recvd
) {
1123 if (xprt
->ops
->timer
)
1124 xprt
->ops
->timer(xprt
, task
);
1126 task
->tk_status
= 0;
1130 * xprt_request_wait_receive - wait for the reply to an RPC request
1131 * @task: RPC task about to send a request
1134 void xprt_request_wait_receive(struct rpc_task
*task
)
1136 struct rpc_rqst
*req
= task
->tk_rqstp
;
1137 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1139 if (!test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
))
1142 * Sleep on the pending queue if we're expecting a reply.
1143 * The spinlock ensures atomicity between the test of
1144 * req->rq_reply_bytes_recvd, and the call to rpc_sleep_on().
1146 spin_lock(&xprt
->queue_lock
);
1147 if (test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
)) {
1148 xprt
->ops
->set_retrans_timeout(task
);
1149 rpc_sleep_on(&xprt
->pending
, task
, xprt_timer
);
1151 * Send an extra queue wakeup call if the
1152 * connection was dropped in case the call to
1153 * rpc_sleep_on() raced.
1155 if (xprt_request_retransmit_after_disconnect(task
))
1156 rpc_wake_up_queued_task_set_status(&xprt
->pending
,
1159 spin_unlock(&xprt
->queue_lock
);
1163 xprt_request_need_enqueue_transmit(struct rpc_task
*task
, struct rpc_rqst
*req
)
1165 return !test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
);
1169 * xprt_request_enqueue_transmit - queue a task for transmission
1170 * @task: pointer to rpc_task
1172 * Add a task to the transmission queue.
1175 xprt_request_enqueue_transmit(struct rpc_task
*task
)
1177 struct rpc_rqst
*pos
, *req
= task
->tk_rqstp
;
1178 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1180 if (xprt_request_need_enqueue_transmit(task
, req
)) {
1181 spin_lock(&xprt
->queue_lock
);
1183 * Requests that carry congestion control credits are added
1184 * to the head of the list to avoid starvation issues.
1187 xprt_clear_congestion_window_wait(xprt
);
1188 list_for_each_entry(pos
, &xprt
->xmit_queue
, rq_xmit
) {
1191 /* Note: req is added _before_ pos */
1192 list_add_tail(&req
->rq_xmit
, &pos
->rq_xmit
);
1193 INIT_LIST_HEAD(&req
->rq_xmit2
);
1196 } else if (RPC_IS_SWAPPER(task
)) {
1197 list_for_each_entry(pos
, &xprt
->xmit_queue
, rq_xmit
) {
1198 if (pos
->rq_cong
|| pos
->rq_bytes_sent
)
1200 if (RPC_IS_SWAPPER(pos
->rq_task
))
1202 /* Note: req is added _before_ pos */
1203 list_add_tail(&req
->rq_xmit
, &pos
->rq_xmit
);
1204 INIT_LIST_HEAD(&req
->rq_xmit2
);
1208 list_for_each_entry(pos
, &xprt
->xmit_queue
, rq_xmit
) {
1209 if (pos
->rq_task
->tk_owner
!= task
->tk_owner
)
1211 list_add_tail(&req
->rq_xmit2
, &pos
->rq_xmit2
);
1212 INIT_LIST_HEAD(&req
->rq_xmit
);
1216 list_add_tail(&req
->rq_xmit
, &xprt
->xmit_queue
);
1217 INIT_LIST_HEAD(&req
->rq_xmit2
);
1219 set_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
);
1220 spin_unlock(&xprt
->queue_lock
);
1225 * xprt_request_dequeue_transmit_locked - remove a task from the transmission queue
1226 * @task: pointer to rpc_task
1228 * Remove a task from the transmission queue
1229 * Caller must hold xprt->queue_lock
1232 xprt_request_dequeue_transmit_locked(struct rpc_task
*task
)
1234 struct rpc_rqst
*req
= task
->tk_rqstp
;
1236 if (!test_and_clear_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1238 if (!list_empty(&req
->rq_xmit
)) {
1239 list_del(&req
->rq_xmit
);
1240 if (!list_empty(&req
->rq_xmit2
)) {
1241 struct rpc_rqst
*next
= list_first_entry(&req
->rq_xmit2
,
1242 struct rpc_rqst
, rq_xmit2
);
1243 list_del(&req
->rq_xmit2
);
1244 list_add_tail(&next
->rq_xmit
, &next
->rq_xprt
->xmit_queue
);
1247 list_del(&req
->rq_xmit2
);
1251 * xprt_request_dequeue_transmit - remove a task from the transmission queue
1252 * @task: pointer to rpc_task
1254 * Remove a task from the transmission queue
1257 xprt_request_dequeue_transmit(struct rpc_task
*task
)
1259 struct rpc_rqst
*req
= task
->tk_rqstp
;
1260 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1262 spin_lock(&xprt
->queue_lock
);
1263 xprt_request_dequeue_transmit_locked(task
);
1264 spin_unlock(&xprt
->queue_lock
);
1268 * xprt_request_prepare - prepare an encoded request for transport
1269 * @req: pointer to rpc_rqst
1271 * Calls into the transport layer to do whatever is needed to prepare
1272 * the request for transmission or receive.
1275 xprt_request_prepare(struct rpc_rqst
*req
)
1277 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1279 if (xprt
->ops
->prepare_request
)
1280 xprt
->ops
->prepare_request(req
);
1284 * xprt_request_need_retransmit - Test if a task needs retransmission
1285 * @task: pointer to rpc_task
1287 * Test for whether a connection breakage requires the task to retransmit
1290 xprt_request_need_retransmit(struct rpc_task
*task
)
1292 return xprt_request_retransmit_after_disconnect(task
);
1296 * xprt_prepare_transmit - reserve the transport before sending a request
1297 * @task: RPC task about to send a request
1300 bool xprt_prepare_transmit(struct rpc_task
*task
)
1302 struct rpc_rqst
*req
= task
->tk_rqstp
;
1303 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1305 dprintk("RPC: %5u xprt_prepare_transmit\n", task
->tk_pid
);
1307 if (!xprt_lock_write(xprt
, task
)) {
1308 /* Race breaker: someone may have transmitted us */
1309 if (!test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1310 rpc_wake_up_queued_task_set_status(&xprt
->sending
,
1318 void xprt_end_transmit(struct rpc_task
*task
)
1320 xprt_release_write(task
->tk_rqstp
->rq_xprt
, task
);
1324 * xprt_request_transmit - send an RPC request on a transport
1325 * @req: pointer to request to transmit
1326 * @snd_task: RPC task that owns the transport lock
1328 * This performs the transmission of a single request.
1329 * Note that if the request is not the same as snd_task, then it
1330 * does need to be pinned.
1331 * Returns '0' on success.
1334 xprt_request_transmit(struct rpc_rqst
*req
, struct rpc_task
*snd_task
)
1336 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1337 struct rpc_task
*task
= req
->rq_task
;
1338 unsigned int connect_cookie
;
1339 int is_retrans
= RPC_WAS_SENT(task
);
1342 dprintk("RPC: %5u xprt_transmit(%u)\n", task
->tk_pid
, req
->rq_slen
);
1344 if (!req
->rq_bytes_sent
) {
1345 if (xprt_request_data_received(task
)) {
1349 /* Verify that our message lies in the RPCSEC_GSS window */
1350 if (rpcauth_xmit_need_reencode(task
)) {
1357 * Update req->rq_ntrans before transmitting to avoid races with
1358 * xprt_update_rtt(), which needs to know that it is recording a
1359 * reply to the first transmission.
1363 connect_cookie
= xprt
->connect_cookie
;
1364 status
= xprt
->ops
->send_request(req
);
1365 trace_xprt_transmit(xprt
, req
->rq_xid
, status
);
1372 task
->tk_client
->cl_stats
->rpcretrans
++;
1374 xprt_inject_disconnect(xprt
);
1376 dprintk("RPC: %5u xmit complete\n", task
->tk_pid
);
1377 task
->tk_flags
|= RPC_TASK_SENT
;
1378 spin_lock_bh(&xprt
->transport_lock
);
1381 xprt
->stat
.req_u
+= xprt
->stat
.sends
- xprt
->stat
.recvs
;
1382 xprt
->stat
.bklog_u
+= xprt
->backlog
.qlen
;
1383 xprt
->stat
.sending_u
+= xprt
->sending
.qlen
;
1384 xprt
->stat
.pending_u
+= xprt
->pending
.qlen
;
1385 spin_unlock_bh(&xprt
->transport_lock
);
1387 req
->rq_connect_cookie
= connect_cookie
;
1389 xprt_request_dequeue_transmit(task
);
1390 rpc_wake_up_queued_task_set_status(&xprt
->sending
, task
, status
);
1395 * xprt_transmit - send an RPC request on a transport
1396 * @task: controlling RPC task
1398 * Attempts to drain the transmit queue. On exit, either the transport
1399 * signalled an error that needs to be handled before transmission can
1400 * resume, or @task finished transmitting, and detected that it already
1404 xprt_transmit(struct rpc_task
*task
)
1406 struct rpc_rqst
*next
, *req
= task
->tk_rqstp
;
1407 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1410 spin_lock(&xprt
->queue_lock
);
1411 while (!list_empty(&xprt
->xmit_queue
)) {
1412 next
= list_first_entry(&xprt
->xmit_queue
,
1413 struct rpc_rqst
, rq_xmit
);
1414 xprt_pin_rqst(next
);
1415 spin_unlock(&xprt
->queue_lock
);
1416 status
= xprt_request_transmit(next
, task
);
1417 if (status
== -EBADMSG
&& next
!= req
)
1420 spin_lock(&xprt
->queue_lock
);
1421 xprt_unpin_rqst(next
);
1423 if (!xprt_request_data_received(task
) ||
1424 test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1426 } else if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1427 task
->tk_status
= status
;
1430 spin_unlock(&xprt
->queue_lock
);
1433 static void xprt_add_backlog(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1435 set_bit(XPRT_CONGESTED
, &xprt
->state
);
1436 rpc_sleep_on(&xprt
->backlog
, task
, NULL
);
1439 static void xprt_wake_up_backlog(struct rpc_xprt
*xprt
)
1441 if (rpc_wake_up_next(&xprt
->backlog
) == NULL
)
1442 clear_bit(XPRT_CONGESTED
, &xprt
->state
);
1445 static bool xprt_throttle_congested(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1449 if (!test_bit(XPRT_CONGESTED
, &xprt
->state
))
1451 spin_lock(&xprt
->reserve_lock
);
1452 if (test_bit(XPRT_CONGESTED
, &xprt
->state
)) {
1453 rpc_sleep_on(&xprt
->backlog
, task
, NULL
);
1456 spin_unlock(&xprt
->reserve_lock
);
1461 static struct rpc_rqst
*xprt_dynamic_alloc_slot(struct rpc_xprt
*xprt
)
1463 struct rpc_rqst
*req
= ERR_PTR(-EAGAIN
);
1465 if (xprt
->num_reqs
>= xprt
->max_reqs
)
1468 spin_unlock(&xprt
->reserve_lock
);
1469 req
= kzalloc(sizeof(struct rpc_rqst
), GFP_NOFS
);
1470 spin_lock(&xprt
->reserve_lock
);
1474 req
= ERR_PTR(-ENOMEM
);
1479 static bool xprt_dynamic_free_slot(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
1481 if (xprt
->num_reqs
> xprt
->min_reqs
) {
1489 void xprt_alloc_slot(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1491 struct rpc_rqst
*req
;
1493 spin_lock(&xprt
->reserve_lock
);
1494 if (!list_empty(&xprt
->free
)) {
1495 req
= list_entry(xprt
->free
.next
, struct rpc_rqst
, rq_list
);
1496 list_del(&req
->rq_list
);
1499 req
= xprt_dynamic_alloc_slot(xprt
);
1502 switch (PTR_ERR(req
)) {
1504 dprintk("RPC: dynamic allocation of request slot "
1505 "failed! Retrying\n");
1506 task
->tk_status
= -ENOMEM
;
1509 xprt_add_backlog(xprt
, task
);
1510 dprintk("RPC: waiting for request slot\n");
1513 task
->tk_status
= -EAGAIN
;
1515 spin_unlock(&xprt
->reserve_lock
);
1518 xprt
->stat
.max_slots
= max_t(unsigned int, xprt
->stat
.max_slots
,
1520 spin_unlock(&xprt
->reserve_lock
);
1522 task
->tk_status
= 0;
1523 task
->tk_rqstp
= req
;
1525 EXPORT_SYMBOL_GPL(xprt_alloc_slot
);
1527 void xprt_free_slot(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
1529 spin_lock(&xprt
->reserve_lock
);
1530 if (!xprt_dynamic_free_slot(xprt
, req
)) {
1531 memset(req
, 0, sizeof(*req
)); /* mark unused */
1532 list_add(&req
->rq_list
, &xprt
->free
);
1534 xprt_wake_up_backlog(xprt
);
1535 spin_unlock(&xprt
->reserve_lock
);
1537 EXPORT_SYMBOL_GPL(xprt_free_slot
);
1539 static void xprt_free_all_slots(struct rpc_xprt
*xprt
)
1541 struct rpc_rqst
*req
;
1542 while (!list_empty(&xprt
->free
)) {
1543 req
= list_first_entry(&xprt
->free
, struct rpc_rqst
, rq_list
);
1544 list_del(&req
->rq_list
);
1549 struct rpc_xprt
*xprt_alloc(struct net
*net
, size_t size
,
1550 unsigned int num_prealloc
,
1551 unsigned int max_alloc
)
1553 struct rpc_xprt
*xprt
;
1554 struct rpc_rqst
*req
;
1557 xprt
= kzalloc(size
, GFP_KERNEL
);
1561 xprt_init(xprt
, net
);
1563 for (i
= 0; i
< num_prealloc
; i
++) {
1564 req
= kzalloc(sizeof(struct rpc_rqst
), GFP_KERNEL
);
1567 list_add(&req
->rq_list
, &xprt
->free
);
1569 if (max_alloc
> num_prealloc
)
1570 xprt
->max_reqs
= max_alloc
;
1572 xprt
->max_reqs
= num_prealloc
;
1573 xprt
->min_reqs
= num_prealloc
;
1574 xprt
->num_reqs
= num_prealloc
;
1583 EXPORT_SYMBOL_GPL(xprt_alloc
);
1585 void xprt_free(struct rpc_xprt
*xprt
)
1587 put_net(xprt
->xprt_net
);
1588 xprt_free_all_slots(xprt
);
1589 kfree_rcu(xprt
, rcu
);
1591 EXPORT_SYMBOL_GPL(xprt_free
);
1594 xprt_init_connect_cookie(struct rpc_rqst
*req
, struct rpc_xprt
*xprt
)
1596 req
->rq_connect_cookie
= xprt_connect_cookie(xprt
) - 1;
1600 xprt_alloc_xid(struct rpc_xprt
*xprt
)
1604 spin_lock(&xprt
->reserve_lock
);
1605 xid
= (__force __be32
)xprt
->xid
++;
1606 spin_unlock(&xprt
->reserve_lock
);
1611 xprt_init_xid(struct rpc_xprt
*xprt
)
1613 xprt
->xid
= prandom_u32();
1617 xprt_request_init(struct rpc_task
*task
)
1619 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1620 struct rpc_rqst
*req
= task
->tk_rqstp
;
1622 req
->rq_timeout
= task
->tk_client
->cl_timeout
->to_initval
;
1623 req
->rq_task
= task
;
1624 req
->rq_xprt
= xprt
;
1625 req
->rq_buffer
= NULL
;
1626 req
->rq_xid
= xprt_alloc_xid(xprt
);
1627 xprt_init_connect_cookie(req
, xprt
);
1628 req
->rq_bytes_sent
= 0;
1629 req
->rq_snd_buf
.len
= 0;
1630 req
->rq_snd_buf
.buflen
= 0;
1631 req
->rq_rcv_buf
.len
= 0;
1632 req
->rq_rcv_buf
.buflen
= 0;
1633 req
->rq_snd_buf
.bvec
= NULL
;
1634 req
->rq_rcv_buf
.bvec
= NULL
;
1635 req
->rq_release_snd_buf
= NULL
;
1636 xprt_reset_majortimeo(req
);
1637 dprintk("RPC: %5u reserved req %p xid %08x\n", task
->tk_pid
,
1638 req
, ntohl(req
->rq_xid
));
1642 xprt_do_reserve(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1644 xprt
->ops
->alloc_slot(xprt
, task
);
1645 if (task
->tk_rqstp
!= NULL
)
1646 xprt_request_init(task
);
1650 * xprt_reserve - allocate an RPC request slot
1651 * @task: RPC task requesting a slot allocation
1653 * If the transport is marked as being congested, or if no more
1654 * slots are available, place the task on the transport's
1657 void xprt_reserve(struct rpc_task
*task
)
1659 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1661 task
->tk_status
= 0;
1662 if (task
->tk_rqstp
!= NULL
)
1665 task
->tk_timeout
= 0;
1666 task
->tk_status
= -EAGAIN
;
1667 if (!xprt_throttle_congested(xprt
, task
))
1668 xprt_do_reserve(xprt
, task
);
1672 * xprt_retry_reserve - allocate an RPC request slot
1673 * @task: RPC task requesting a slot allocation
1675 * If no more slots are available, place the task on the transport's
1677 * Note that the only difference with xprt_reserve is that we now
1678 * ignore the value of the XPRT_CONGESTED flag.
1680 void xprt_retry_reserve(struct rpc_task
*task
)
1682 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1684 task
->tk_status
= 0;
1685 if (task
->tk_rqstp
!= NULL
)
1688 task
->tk_timeout
= 0;
1689 task
->tk_status
= -EAGAIN
;
1690 xprt_do_reserve(xprt
, task
);
1694 xprt_request_dequeue_all(struct rpc_task
*task
, struct rpc_rqst
*req
)
1696 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1698 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
) ||
1699 test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
) ||
1700 xprt_is_pinned_rqst(req
)) {
1701 spin_lock(&xprt
->queue_lock
);
1702 xprt_request_dequeue_transmit_locked(task
);
1703 xprt_request_dequeue_receive_locked(task
);
1704 while (xprt_is_pinned_rqst(req
)) {
1705 set_bit(RPC_TASK_MSG_PIN_WAIT
, &task
->tk_runstate
);
1706 spin_unlock(&xprt
->queue_lock
);
1707 xprt_wait_on_pinned_rqst(req
);
1708 spin_lock(&xprt
->queue_lock
);
1709 clear_bit(RPC_TASK_MSG_PIN_WAIT
, &task
->tk_runstate
);
1711 spin_unlock(&xprt
->queue_lock
);
1716 * xprt_release - release an RPC request slot
1717 * @task: task which is finished with the slot
1720 void xprt_release(struct rpc_task
*task
)
1722 struct rpc_xprt
*xprt
;
1723 struct rpc_rqst
*req
= task
->tk_rqstp
;
1726 if (task
->tk_client
) {
1727 xprt
= task
->tk_xprt
;
1728 xprt_release_write(xprt
, task
);
1733 xprt
= req
->rq_xprt
;
1734 if (task
->tk_ops
->rpc_count_stats
!= NULL
)
1735 task
->tk_ops
->rpc_count_stats(task
, task
->tk_calldata
);
1736 else if (task
->tk_client
)
1737 rpc_count_iostats(task
, task
->tk_client
->cl_metrics
);
1738 xprt_request_dequeue_all(task
, req
);
1739 spin_lock_bh(&xprt
->transport_lock
);
1740 xprt
->ops
->release_xprt(xprt
, task
);
1741 if (xprt
->ops
->release_request
)
1742 xprt
->ops
->release_request(task
);
1743 xprt
->last_used
= jiffies
;
1744 xprt_schedule_autodisconnect(xprt
);
1745 spin_unlock_bh(&xprt
->transport_lock
);
1747 xprt
->ops
->buf_free(task
);
1748 xprt_inject_disconnect(xprt
);
1749 xdr_free_bvec(&req
->rq_rcv_buf
);
1750 if (req
->rq_cred
!= NULL
)
1751 put_rpccred(req
->rq_cred
);
1752 task
->tk_rqstp
= NULL
;
1753 if (req
->rq_release_snd_buf
)
1754 req
->rq_release_snd_buf(req
);
1756 dprintk("RPC: %5u release request %p\n", task
->tk_pid
, req
);
1757 if (likely(!bc_prealloc(req
)))
1758 xprt
->ops
->free_slot(xprt
, req
);
1760 xprt_free_bc_request(req
);
1763 #ifdef CONFIG_SUNRPC_BACKCHANNEL
1765 xprt_init_bc_request(struct rpc_rqst
*req
, struct rpc_task
*task
)
1767 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
1769 task
->tk_rqstp
= req
;
1770 req
->rq_task
= task
;
1771 xprt_init_connect_cookie(req
, req
->rq_xprt
);
1773 * Set up the xdr_buf length.
1774 * This also indicates that the buffer is XDR encoded already.
1776 xbufp
->len
= xbufp
->head
[0].iov_len
+ xbufp
->page_len
+
1777 xbufp
->tail
[0].iov_len
;
1778 req
->rq_bytes_sent
= 0;
1782 static void xprt_init(struct rpc_xprt
*xprt
, struct net
*net
)
1784 kref_init(&xprt
->kref
);
1786 spin_lock_init(&xprt
->transport_lock
);
1787 spin_lock_init(&xprt
->reserve_lock
);
1788 spin_lock_init(&xprt
->queue_lock
);
1790 INIT_LIST_HEAD(&xprt
->free
);
1791 xprt
->recv_queue
= RB_ROOT
;
1792 INIT_LIST_HEAD(&xprt
->xmit_queue
);
1793 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1794 spin_lock_init(&xprt
->bc_pa_lock
);
1795 INIT_LIST_HEAD(&xprt
->bc_pa_list
);
1796 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1797 INIT_LIST_HEAD(&xprt
->xprt_switch
);
1799 xprt
->last_used
= jiffies
;
1800 xprt
->cwnd
= RPC_INITCWND
;
1801 xprt
->bind_index
= 0;
1803 rpc_init_wait_queue(&xprt
->binding
, "xprt_binding");
1804 rpc_init_wait_queue(&xprt
->pending
, "xprt_pending");
1805 rpc_init_wait_queue(&xprt
->sending
, "xprt_sending");
1806 rpc_init_priority_wait_queue(&xprt
->backlog
, "xprt_backlog");
1808 xprt_init_xid(xprt
);
1810 xprt
->xprt_net
= get_net(net
);
1814 * xprt_create_transport - create an RPC transport
1815 * @args: rpc transport creation arguments
1818 struct rpc_xprt
*xprt_create_transport(struct xprt_create
*args
)
1820 struct rpc_xprt
*xprt
;
1821 struct xprt_class
*t
;
1823 spin_lock(&xprt_list_lock
);
1824 list_for_each_entry(t
, &xprt_list
, list
) {
1825 if (t
->ident
== args
->ident
) {
1826 spin_unlock(&xprt_list_lock
);
1830 spin_unlock(&xprt_list_lock
);
1831 dprintk("RPC: transport (%d) not supported\n", args
->ident
);
1832 return ERR_PTR(-EIO
);
1835 xprt
= t
->setup(args
);
1837 dprintk("RPC: xprt_create_transport: failed, %ld\n",
1841 if (args
->flags
& XPRT_CREATE_NO_IDLE_TIMEOUT
)
1842 xprt
->idle_timeout
= 0;
1843 INIT_WORK(&xprt
->task_cleanup
, xprt_autoclose
);
1844 if (xprt_has_timer(xprt
))
1845 timer_setup(&xprt
->timer
, xprt_init_autodisconnect
, 0);
1847 timer_setup(&xprt
->timer
, NULL
, 0);
1849 if (strlen(args
->servername
) > RPC_MAXNETNAMELEN
) {
1851 return ERR_PTR(-EINVAL
);
1853 xprt
->servername
= kstrdup(args
->servername
, GFP_KERNEL
);
1854 if (xprt
->servername
== NULL
) {
1856 return ERR_PTR(-ENOMEM
);
1859 rpc_xprt_debugfs_register(xprt
);
1861 dprintk("RPC: created transport %p with %u slots\n", xprt
,
1867 static void xprt_destroy_cb(struct work_struct
*work
)
1869 struct rpc_xprt
*xprt
=
1870 container_of(work
, struct rpc_xprt
, task_cleanup
);
1872 rpc_xprt_debugfs_unregister(xprt
);
1873 rpc_destroy_wait_queue(&xprt
->binding
);
1874 rpc_destroy_wait_queue(&xprt
->pending
);
1875 rpc_destroy_wait_queue(&xprt
->sending
);
1876 rpc_destroy_wait_queue(&xprt
->backlog
);
1877 kfree(xprt
->servername
);
1879 * Tear down transport state and free the rpc_xprt
1881 xprt
->ops
->destroy(xprt
);
1885 * xprt_destroy - destroy an RPC transport, killing off all requests.
1886 * @xprt: transport to destroy
1889 static void xprt_destroy(struct rpc_xprt
*xprt
)
1891 dprintk("RPC: destroying transport %p\n", xprt
);
1894 * Exclude transport connect/disconnect handlers and autoclose
1896 wait_on_bit_lock(&xprt
->state
, XPRT_LOCKED
, TASK_UNINTERRUPTIBLE
);
1898 del_timer_sync(&xprt
->timer
);
1901 * Destroy sockets etc from the system workqueue so they can
1902 * safely flush receive work running on rpciod.
1904 INIT_WORK(&xprt
->task_cleanup
, xprt_destroy_cb
);
1905 schedule_work(&xprt
->task_cleanup
);
1908 static void xprt_destroy_kref(struct kref
*kref
)
1910 xprt_destroy(container_of(kref
, struct rpc_xprt
, kref
));
1914 * xprt_get - return a reference to an RPC transport.
1915 * @xprt: pointer to the transport
1918 struct rpc_xprt
*xprt_get(struct rpc_xprt
*xprt
)
1920 if (xprt
!= NULL
&& kref_get_unless_zero(&xprt
->kref
))
1924 EXPORT_SYMBOL_GPL(xprt_get
);
1927 * xprt_put - release a reference to an RPC transport.
1928 * @xprt: pointer to the transport
1931 void xprt_put(struct rpc_xprt
*xprt
)
1934 kref_put(&xprt
->kref
, xprt_destroy_kref
);
1936 EXPORT_SYMBOL_GPL(xprt_put
);