1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/net/sunrpc/xprt.c
5 * This is a generic RPC call interface supporting congestion avoidance,
6 * and asynchronous calls.
8 * The interface works like this:
10 * - When a process places a call, it allocates a request slot if
11 * one is available. Otherwise, it sleeps on the backlog queue
13 * - Next, the caller puts together the RPC message, stuffs it into
14 * the request struct, and calls xprt_transmit().
15 * - xprt_transmit sends the message and installs the caller on the
16 * transport's wait list. At the same time, if a reply is expected,
17 * it installs a timer that is run after the packet's timeout has
19 * - When a packet arrives, the data_ready handler walks the list of
20 * pending requests for that transport. If a matching XID is found, the
21 * caller is woken up, and the timer removed.
22 * - When no reply arrives within the timeout interval, the timer is
23 * fired by the kernel and runs xprt_timer(). It either adjusts the
24 * timeout values (minor timeout) or wakes up the caller with a status
26 * - When the caller receives a notification from RPC that a reply arrived,
27 * it should release the RPC slot, and process the reply.
28 * If the call timed out, it may choose to retry the operation by
29 * adjusting the initial timeout value, and simply calling rpc_call
32 * Support for async RPC is done through a set of RPC-specific scheduling
33 * primitives that `transparently' work for processes as well as async
34 * tasks that rely on callbacks.
36 * Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
38 * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
41 #include <linux/module.h>
43 #include <linux/types.h>
44 #include <linux/interrupt.h>
45 #include <linux/workqueue.h>
46 #include <linux/net.h>
47 #include <linux/ktime.h>
49 #include <linux/sunrpc/clnt.h>
50 #include <linux/sunrpc/metrics.h>
51 #include <linux/sunrpc/bc_xprt.h>
52 #include <linux/rcupdate.h>
53 #include <linux/sched/mm.h>
55 #include <trace/events/sunrpc.h>
63 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
64 # define RPCDBG_FACILITY RPCDBG_XPRT
70 static void xprt_init(struct rpc_xprt
*xprt
, struct net
*net
);
71 static __be32
xprt_alloc_xid(struct rpc_xprt
*xprt
);
72 static void xprt_destroy(struct rpc_xprt
*xprt
);
74 static DEFINE_SPINLOCK(xprt_list_lock
);
75 static LIST_HEAD(xprt_list
);
77 static unsigned long xprt_request_timeout(const struct rpc_rqst
*req
)
79 unsigned long timeout
= jiffies
+ req
->rq_timeout
;
81 if (time_before(timeout
, req
->rq_majortimeo
))
83 return req
->rq_majortimeo
;
87 * xprt_register_transport - register a transport implementation
88 * @transport: transport to register
90 * If a transport implementation is loaded as a kernel module, it can
91 * call this interface to make itself known to the RPC client.
94 * 0: transport successfully registered
95 * -EEXIST: transport already registered
96 * -EINVAL: transport module being unloaded
98 int xprt_register_transport(struct xprt_class
*transport
)
100 struct xprt_class
*t
;
104 spin_lock(&xprt_list_lock
);
105 list_for_each_entry(t
, &xprt_list
, list
) {
106 /* don't register the same transport class twice */
107 if (t
->ident
== transport
->ident
)
111 list_add_tail(&transport
->list
, &xprt_list
);
112 printk(KERN_INFO
"RPC: Registered %s transport module.\n",
117 spin_unlock(&xprt_list_lock
);
120 EXPORT_SYMBOL_GPL(xprt_register_transport
);
123 * xprt_unregister_transport - unregister a transport implementation
124 * @transport: transport to unregister
127 * 0: transport successfully unregistered
128 * -ENOENT: transport never registered
130 int xprt_unregister_transport(struct xprt_class
*transport
)
132 struct xprt_class
*t
;
136 spin_lock(&xprt_list_lock
);
137 list_for_each_entry(t
, &xprt_list
, list
) {
138 if (t
== transport
) {
140 "RPC: Unregistered %s transport module.\n",
142 list_del_init(&transport
->list
);
149 spin_unlock(&xprt_list_lock
);
152 EXPORT_SYMBOL_GPL(xprt_unregister_transport
);
155 * xprt_load_transport - load a transport implementation
156 * @transport_name: transport to load
159 * 0: transport successfully loaded
160 * -ENOENT: transport module not available
162 int xprt_load_transport(const char *transport_name
)
164 struct xprt_class
*t
;
168 spin_lock(&xprt_list_lock
);
169 list_for_each_entry(t
, &xprt_list
, list
) {
170 if (strcmp(t
->name
, transport_name
) == 0) {
171 spin_unlock(&xprt_list_lock
);
175 spin_unlock(&xprt_list_lock
);
176 result
= request_module("xprt%s", transport_name
);
180 EXPORT_SYMBOL_GPL(xprt_load_transport
);
182 static void xprt_clear_locked(struct rpc_xprt
*xprt
)
184 xprt
->snd_task
= NULL
;
185 if (!test_bit(XPRT_CLOSE_WAIT
, &xprt
->state
)) {
186 smp_mb__before_atomic();
187 clear_bit(XPRT_LOCKED
, &xprt
->state
);
188 smp_mb__after_atomic();
190 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
194 * xprt_reserve_xprt - serialize write access to transports
195 * @task: task that is requesting access to the transport
196 * @xprt: pointer to the target transport
198 * This prevents mixing the payload of separate requests, and prevents
199 * transport connects from colliding with writes. No congestion control
202 int xprt_reserve_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
204 struct rpc_rqst
*req
= task
->tk_rqstp
;
206 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
)) {
207 if (task
== xprt
->snd_task
)
211 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
213 xprt
->snd_task
= task
;
218 xprt_clear_locked(xprt
);
220 dprintk("RPC: %5u failed to lock transport %p\n",
222 task
->tk_status
= -EAGAIN
;
223 if (RPC_IS_SOFT(task
))
224 rpc_sleep_on_timeout(&xprt
->sending
, task
, NULL
,
225 xprt_request_timeout(req
));
227 rpc_sleep_on(&xprt
->sending
, task
, NULL
);
230 EXPORT_SYMBOL_GPL(xprt_reserve_xprt
);
233 xprt_need_congestion_window_wait(struct rpc_xprt
*xprt
)
235 return test_bit(XPRT_CWND_WAIT
, &xprt
->state
);
239 xprt_set_congestion_window_wait(struct rpc_xprt
*xprt
)
241 if (!list_empty(&xprt
->xmit_queue
)) {
242 /* Peek at head of queue to see if it can make progress */
243 if (list_first_entry(&xprt
->xmit_queue
, struct rpc_rqst
,
247 set_bit(XPRT_CWND_WAIT
, &xprt
->state
);
251 xprt_test_and_clear_congestion_window_wait(struct rpc_xprt
*xprt
)
253 if (!RPCXPRT_CONGESTED(xprt
))
254 clear_bit(XPRT_CWND_WAIT
, &xprt
->state
);
258 * xprt_reserve_xprt_cong - serialize write access to transports
259 * @task: task that is requesting access to the transport
261 * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
262 * integrated into the decision of whether a request is allowed to be
263 * woken up and given access to the transport.
264 * Note that the lock is only granted if we know there are free slots.
266 int xprt_reserve_xprt_cong(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
268 struct rpc_rqst
*req
= task
->tk_rqstp
;
270 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
)) {
271 if (task
== xprt
->snd_task
)
276 xprt
->snd_task
= task
;
279 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
281 if (!xprt_need_congestion_window_wait(xprt
)) {
282 xprt
->snd_task
= task
;
286 xprt_clear_locked(xprt
);
288 dprintk("RPC: %5u failed to lock transport %p\n", task
->tk_pid
, xprt
);
289 task
->tk_status
= -EAGAIN
;
290 if (RPC_IS_SOFT(task
))
291 rpc_sleep_on_timeout(&xprt
->sending
, task
, NULL
,
292 xprt_request_timeout(req
));
294 rpc_sleep_on(&xprt
->sending
, task
, NULL
);
297 EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong
);
299 static inline int xprt_lock_write(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
303 if (test_bit(XPRT_LOCKED
, &xprt
->state
) && xprt
->snd_task
== task
)
305 spin_lock(&xprt
->transport_lock
);
306 retval
= xprt
->ops
->reserve_xprt(xprt
, task
);
307 spin_unlock(&xprt
->transport_lock
);
311 static bool __xprt_lock_write_func(struct rpc_task
*task
, void *data
)
313 struct rpc_xprt
*xprt
= data
;
315 xprt
->snd_task
= task
;
319 static void __xprt_lock_write_next(struct rpc_xprt
*xprt
)
321 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
))
323 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
325 if (rpc_wake_up_first_on_wq(xprtiod_workqueue
, &xprt
->sending
,
326 __xprt_lock_write_func
, xprt
))
329 xprt_clear_locked(xprt
);
332 static void __xprt_lock_write_next_cong(struct rpc_xprt
*xprt
)
334 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
))
336 if (test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
338 if (xprt_need_congestion_window_wait(xprt
))
340 if (rpc_wake_up_first_on_wq(xprtiod_workqueue
, &xprt
->sending
,
341 __xprt_lock_write_func
, xprt
))
344 xprt_clear_locked(xprt
);
348 * xprt_release_xprt - 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. No congestion control is provided.
354 void xprt_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
356 if (xprt
->snd_task
== task
) {
357 xprt_clear_locked(xprt
);
358 __xprt_lock_write_next(xprt
);
361 EXPORT_SYMBOL_GPL(xprt_release_xprt
);
364 * xprt_release_xprt_cong - allow other requests to use a transport
365 * @xprt: transport with other tasks potentially waiting
366 * @task: task that is releasing access to the transport
368 * Note that "task" can be NULL. Another task is awoken to use the
369 * transport if the transport's congestion window allows it.
371 void xprt_release_xprt_cong(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
373 if (xprt
->snd_task
== task
) {
374 xprt_clear_locked(xprt
);
375 __xprt_lock_write_next_cong(xprt
);
378 EXPORT_SYMBOL_GPL(xprt_release_xprt_cong
);
380 static inline void xprt_release_write(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
382 if (xprt
->snd_task
!= task
)
384 spin_lock(&xprt
->transport_lock
);
385 xprt
->ops
->release_xprt(xprt
, task
);
386 spin_unlock(&xprt
->transport_lock
);
390 * Van Jacobson congestion avoidance. Check if the congestion window
391 * overflowed. Put the task to sleep if this is the case.
394 __xprt_get_cong(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
398 dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
399 req
->rq_task
->tk_pid
, xprt
->cong
, xprt
->cwnd
);
400 if (RPCXPRT_CONGESTED(xprt
)) {
401 xprt_set_congestion_window_wait(xprt
);
405 xprt
->cong
+= RPC_CWNDSCALE
;
410 * Adjust the congestion window, and wake up the next task
411 * that has been sleeping due to congestion
414 __xprt_put_cong(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
419 xprt
->cong
-= RPC_CWNDSCALE
;
420 xprt_test_and_clear_congestion_window_wait(xprt
);
421 __xprt_lock_write_next_cong(xprt
);
425 * xprt_request_get_cong - Request congestion control credits
426 * @xprt: pointer to transport
427 * @req: pointer to RPC request
429 * Useful for transports that require congestion control.
432 xprt_request_get_cong(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
438 spin_lock(&xprt
->transport_lock
);
439 ret
= __xprt_get_cong(xprt
, req
) != 0;
440 spin_unlock(&xprt
->transport_lock
);
443 EXPORT_SYMBOL_GPL(xprt_request_get_cong
);
446 * xprt_release_rqst_cong - housekeeping when request is complete
447 * @task: RPC request that recently completed
449 * Useful for transports that require congestion control.
451 void xprt_release_rqst_cong(struct rpc_task
*task
)
453 struct rpc_rqst
*req
= task
->tk_rqstp
;
455 __xprt_put_cong(req
->rq_xprt
, req
);
457 EXPORT_SYMBOL_GPL(xprt_release_rqst_cong
);
459 static void xprt_clear_congestion_window_wait_locked(struct rpc_xprt
*xprt
)
461 if (test_and_clear_bit(XPRT_CWND_WAIT
, &xprt
->state
))
462 __xprt_lock_write_next_cong(xprt
);
466 * Clear the congestion window wait flag and wake up the next
467 * entry on xprt->sending
470 xprt_clear_congestion_window_wait(struct rpc_xprt
*xprt
)
472 if (test_and_clear_bit(XPRT_CWND_WAIT
, &xprt
->state
)) {
473 spin_lock(&xprt
->transport_lock
);
474 __xprt_lock_write_next_cong(xprt
);
475 spin_unlock(&xprt
->transport_lock
);
480 * xprt_adjust_cwnd - adjust transport congestion window
481 * @xprt: pointer to xprt
482 * @task: recently completed RPC request used to adjust window
483 * @result: result code of completed RPC request
485 * The transport code maintains an estimate on the maximum number of out-
486 * standing RPC requests, using a smoothed version of the congestion
487 * avoidance implemented in 44BSD. This is basically the Van Jacobson
488 * congestion algorithm: If a retransmit occurs, the congestion window is
489 * halved; otherwise, it is incremented by 1/cwnd when
491 * - a reply is received and
492 * - a full number of requests are outstanding and
493 * - the congestion window hasn't been updated recently.
495 void xprt_adjust_cwnd(struct rpc_xprt
*xprt
, struct rpc_task
*task
, int result
)
497 struct rpc_rqst
*req
= task
->tk_rqstp
;
498 unsigned long cwnd
= xprt
->cwnd
;
500 if (result
>= 0 && cwnd
<= xprt
->cong
) {
501 /* The (cwnd >> 1) term makes sure
502 * the result gets rounded properly. */
503 cwnd
+= (RPC_CWNDSCALE
* RPC_CWNDSCALE
+ (cwnd
>> 1)) / cwnd
;
504 if (cwnd
> RPC_MAXCWND(xprt
))
505 cwnd
= RPC_MAXCWND(xprt
);
506 __xprt_lock_write_next_cong(xprt
);
507 } else if (result
== -ETIMEDOUT
) {
509 if (cwnd
< RPC_CWNDSCALE
)
510 cwnd
= RPC_CWNDSCALE
;
512 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
513 xprt
->cong
, xprt
->cwnd
, cwnd
);
515 __xprt_put_cong(xprt
, req
);
517 EXPORT_SYMBOL_GPL(xprt_adjust_cwnd
);
520 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
521 * @xprt: transport with waiting tasks
522 * @status: result code to plant in each task before waking it
525 void xprt_wake_pending_tasks(struct rpc_xprt
*xprt
, int status
)
528 rpc_wake_up_status(&xprt
->pending
, status
);
530 rpc_wake_up(&xprt
->pending
);
532 EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks
);
535 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
538 * Note that we only set the timer for the case of RPC_IS_SOFT(), since
539 * we don't in general want to force a socket disconnection due to
540 * an incomplete RPC call transmission.
542 void xprt_wait_for_buffer_space(struct rpc_xprt
*xprt
)
544 set_bit(XPRT_WRITE_SPACE
, &xprt
->state
);
546 EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space
);
549 xprt_clear_write_space_locked(struct rpc_xprt
*xprt
)
551 if (test_and_clear_bit(XPRT_WRITE_SPACE
, &xprt
->state
)) {
552 __xprt_lock_write_next(xprt
);
553 dprintk("RPC: write space: waking waiting task on "
561 * xprt_write_space - wake the task waiting for transport output buffer space
562 * @xprt: transport with waiting tasks
564 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
566 bool xprt_write_space(struct rpc_xprt
*xprt
)
570 if (!test_bit(XPRT_WRITE_SPACE
, &xprt
->state
))
572 spin_lock(&xprt
->transport_lock
);
573 ret
= xprt_clear_write_space_locked(xprt
);
574 spin_unlock(&xprt
->transport_lock
);
577 EXPORT_SYMBOL_GPL(xprt_write_space
);
579 static unsigned long xprt_abs_ktime_to_jiffies(ktime_t abstime
)
581 s64 delta
= ktime_to_ns(ktime_get() - abstime
);
582 return likely(delta
>= 0) ?
583 jiffies
- nsecs_to_jiffies(delta
) :
584 jiffies
+ nsecs_to_jiffies(-delta
);
587 static unsigned long xprt_calc_majortimeo(struct rpc_rqst
*req
)
589 const struct rpc_timeout
*to
= req
->rq_task
->tk_client
->cl_timeout
;
590 unsigned long majortimeo
= req
->rq_timeout
;
592 if (to
->to_exponential
)
593 majortimeo
<<= to
->to_retries
;
595 majortimeo
+= to
->to_increment
* to
->to_retries
;
596 if (majortimeo
> to
->to_maxval
|| majortimeo
== 0)
597 majortimeo
= to
->to_maxval
;
601 static void xprt_reset_majortimeo(struct rpc_rqst
*req
)
603 req
->rq_majortimeo
+= xprt_calc_majortimeo(req
);
606 static void xprt_init_majortimeo(struct rpc_task
*task
, struct rpc_rqst
*req
)
608 unsigned long time_init
;
609 struct rpc_xprt
*xprt
= req
->rq_xprt
;
611 if (likely(xprt
&& xprt_connected(xprt
)))
614 time_init
= xprt_abs_ktime_to_jiffies(task
->tk_start
);
615 req
->rq_timeout
= task
->tk_client
->cl_timeout
->to_initval
;
616 req
->rq_majortimeo
= time_init
+ xprt_calc_majortimeo(req
);
620 * xprt_adjust_timeout - adjust timeout values for next retransmit
621 * @req: RPC request containing parameters to use for the adjustment
624 int xprt_adjust_timeout(struct rpc_rqst
*req
)
626 struct rpc_xprt
*xprt
= req
->rq_xprt
;
627 const struct rpc_timeout
*to
= req
->rq_task
->tk_client
->cl_timeout
;
630 if (time_before(jiffies
, req
->rq_majortimeo
)) {
631 if (to
->to_exponential
)
632 req
->rq_timeout
<<= 1;
634 req
->rq_timeout
+= to
->to_increment
;
635 if (to
->to_maxval
&& req
->rq_timeout
>= to
->to_maxval
)
636 req
->rq_timeout
= to
->to_maxval
;
639 req
->rq_timeout
= to
->to_initval
;
641 xprt_reset_majortimeo(req
);
642 /* Reset the RTT counters == "slow start" */
643 spin_lock(&xprt
->transport_lock
);
644 rpc_init_rtt(req
->rq_task
->tk_client
->cl_rtt
, to
->to_initval
);
645 spin_unlock(&xprt
->transport_lock
);
649 if (req
->rq_timeout
== 0) {
650 printk(KERN_WARNING
"xprt_adjust_timeout: rq_timeout = 0!\n");
651 req
->rq_timeout
= 5 * HZ
;
656 static void xprt_autoclose(struct work_struct
*work
)
658 struct rpc_xprt
*xprt
=
659 container_of(work
, struct rpc_xprt
, task_cleanup
);
660 unsigned int pflags
= memalloc_nofs_save();
662 clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
663 xprt
->ops
->close(xprt
);
664 xprt_release_write(xprt
, NULL
);
665 wake_up_bit(&xprt
->state
, XPRT_LOCKED
);
666 memalloc_nofs_restore(pflags
);
670 * xprt_disconnect_done - mark a transport as disconnected
671 * @xprt: transport to flag for disconnect
674 void xprt_disconnect_done(struct rpc_xprt
*xprt
)
676 dprintk("RPC: disconnected transport %p\n", xprt
);
677 spin_lock(&xprt
->transport_lock
);
678 xprt_clear_connected(xprt
);
679 xprt_clear_write_space_locked(xprt
);
680 xprt_clear_congestion_window_wait_locked(xprt
);
681 xprt_wake_pending_tasks(xprt
, -ENOTCONN
);
682 spin_unlock(&xprt
->transport_lock
);
684 EXPORT_SYMBOL_GPL(xprt_disconnect_done
);
687 * xprt_force_disconnect - force a transport to disconnect
688 * @xprt: transport to disconnect
691 void xprt_force_disconnect(struct rpc_xprt
*xprt
)
693 /* Don't race with the test_bit() in xprt_clear_locked() */
694 spin_lock(&xprt
->transport_lock
);
695 set_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
696 /* Try to schedule an autoclose RPC call */
697 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
) == 0)
698 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
699 else if (xprt
->snd_task
)
700 rpc_wake_up_queued_task_set_status(&xprt
->pending
,
701 xprt
->snd_task
, -ENOTCONN
);
702 spin_unlock(&xprt
->transport_lock
);
704 EXPORT_SYMBOL_GPL(xprt_force_disconnect
);
707 xprt_connect_cookie(struct rpc_xprt
*xprt
)
709 return READ_ONCE(xprt
->connect_cookie
);
713 xprt_request_retransmit_after_disconnect(struct rpc_task
*task
)
715 struct rpc_rqst
*req
= task
->tk_rqstp
;
716 struct rpc_xprt
*xprt
= req
->rq_xprt
;
718 return req
->rq_connect_cookie
!= xprt_connect_cookie(xprt
) ||
719 !xprt_connected(xprt
);
723 * xprt_conditional_disconnect - force a transport to disconnect
724 * @xprt: transport to disconnect
725 * @cookie: 'connection cookie'
727 * This attempts to break the connection if and only if 'cookie' matches
728 * the current transport 'connection cookie'. It ensures that we don't
729 * try to break the connection more than once when we need to retransmit
730 * a batch of RPC requests.
733 void xprt_conditional_disconnect(struct rpc_xprt
*xprt
, unsigned int cookie
)
735 /* Don't race with the test_bit() in xprt_clear_locked() */
736 spin_lock(&xprt
->transport_lock
);
737 if (cookie
!= xprt
->connect_cookie
)
739 if (test_bit(XPRT_CLOSING
, &xprt
->state
))
741 set_bit(XPRT_CLOSE_WAIT
, &xprt
->state
);
742 /* Try to schedule an autoclose RPC call */
743 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
) == 0)
744 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
745 xprt_wake_pending_tasks(xprt
, -EAGAIN
);
747 spin_unlock(&xprt
->transport_lock
);
751 xprt_has_timer(const struct rpc_xprt
*xprt
)
753 return xprt
->idle_timeout
!= 0;
757 xprt_schedule_autodisconnect(struct rpc_xprt
*xprt
)
758 __must_hold(&xprt
->transport_lock
)
760 xprt
->last_used
= jiffies
;
761 if (RB_EMPTY_ROOT(&xprt
->recv_queue
) && xprt_has_timer(xprt
))
762 mod_timer(&xprt
->timer
, xprt
->last_used
+ xprt
->idle_timeout
);
766 xprt_init_autodisconnect(struct timer_list
*t
)
768 struct rpc_xprt
*xprt
= from_timer(xprt
, t
, timer
);
770 if (!RB_EMPTY_ROOT(&xprt
->recv_queue
))
772 /* Reset xprt->last_used to avoid connect/autodisconnect cycling */
773 xprt
->last_used
= jiffies
;
774 if (test_and_set_bit(XPRT_LOCKED
, &xprt
->state
))
776 queue_work(xprtiod_workqueue
, &xprt
->task_cleanup
);
779 bool xprt_lock_connect(struct rpc_xprt
*xprt
,
780 struct rpc_task
*task
,
785 spin_lock(&xprt
->transport_lock
);
786 if (!test_bit(XPRT_LOCKED
, &xprt
->state
))
788 if (xprt
->snd_task
!= task
)
790 xprt
->snd_task
= cookie
;
793 spin_unlock(&xprt
->transport_lock
);
797 void xprt_unlock_connect(struct rpc_xprt
*xprt
, void *cookie
)
799 spin_lock(&xprt
->transport_lock
);
800 if (xprt
->snd_task
!= cookie
)
802 if (!test_bit(XPRT_LOCKED
, &xprt
->state
))
804 xprt
->snd_task
=NULL
;
805 xprt
->ops
->release_xprt(xprt
, NULL
);
806 xprt_schedule_autodisconnect(xprt
);
808 spin_unlock(&xprt
->transport_lock
);
809 wake_up_bit(&xprt
->state
, XPRT_LOCKED
);
813 * xprt_connect - schedule a transport connect operation
814 * @task: RPC task that is requesting the connect
817 void xprt_connect(struct rpc_task
*task
)
819 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
821 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task
->tk_pid
,
822 xprt
, (xprt_connected(xprt
) ? "is" : "is not"));
824 if (!xprt_bound(xprt
)) {
825 task
->tk_status
= -EAGAIN
;
828 if (!xprt_lock_write(xprt
, task
))
831 if (test_and_clear_bit(XPRT_CLOSE_WAIT
, &xprt
->state
))
832 xprt
->ops
->close(xprt
);
834 if (!xprt_connected(xprt
)) {
835 task
->tk_rqstp
->rq_connect_cookie
= xprt
->connect_cookie
;
836 rpc_sleep_on_timeout(&xprt
->pending
, task
, NULL
,
837 xprt_request_timeout(task
->tk_rqstp
));
839 if (test_bit(XPRT_CLOSING
, &xprt
->state
))
841 if (xprt_test_and_set_connecting(xprt
))
844 if (!xprt_connected(xprt
)) {
845 xprt
->stat
.connect_start
= jiffies
;
846 xprt
->ops
->connect(xprt
, task
);
848 xprt_clear_connecting(xprt
);
850 rpc_wake_up_queued_task(&xprt
->pending
, task
);
853 xprt_release_write(xprt
, task
);
857 * xprt_reconnect_delay - compute the wait before scheduling a connect
858 * @xprt: transport instance
861 unsigned long xprt_reconnect_delay(const struct rpc_xprt
*xprt
)
863 unsigned long start
, now
= jiffies
;
865 start
= xprt
->stat
.connect_start
+ xprt
->reestablish_timeout
;
866 if (time_after(start
, now
))
870 EXPORT_SYMBOL_GPL(xprt_reconnect_delay
);
873 * xprt_reconnect_backoff - compute the new re-establish timeout
874 * @xprt: transport instance
875 * @init_to: initial reestablish timeout
878 void xprt_reconnect_backoff(struct rpc_xprt
*xprt
, unsigned long init_to
)
880 xprt
->reestablish_timeout
<<= 1;
881 if (xprt
->reestablish_timeout
> xprt
->max_reconnect_timeout
)
882 xprt
->reestablish_timeout
= xprt
->max_reconnect_timeout
;
883 if (xprt
->reestablish_timeout
< init_to
)
884 xprt
->reestablish_timeout
= init_to
;
886 EXPORT_SYMBOL_GPL(xprt_reconnect_backoff
);
888 enum xprt_xid_rb_cmp
{
893 static enum xprt_xid_rb_cmp
894 xprt_xid_cmp(__be32 xid1
, __be32 xid2
)
898 if ((__force u32
)xid1
< (__force u32
)xid2
)
903 static struct rpc_rqst
*
904 xprt_request_rb_find(struct rpc_xprt
*xprt
, __be32 xid
)
906 struct rb_node
*n
= xprt
->recv_queue
.rb_node
;
907 struct rpc_rqst
*req
;
910 req
= rb_entry(n
, struct rpc_rqst
, rq_recv
);
911 switch (xprt_xid_cmp(xid
, req
->rq_xid
)) {
926 xprt_request_rb_insert(struct rpc_xprt
*xprt
, struct rpc_rqst
*new)
928 struct rb_node
**p
= &xprt
->recv_queue
.rb_node
;
929 struct rb_node
*n
= NULL
;
930 struct rpc_rqst
*req
;
934 req
= rb_entry(n
, struct rpc_rqst
, rq_recv
);
935 switch(xprt_xid_cmp(new->rq_xid
, req
->rq_xid
)) {
943 WARN_ON_ONCE(new != req
);
947 rb_link_node(&new->rq_recv
, n
, p
);
948 rb_insert_color(&new->rq_recv
, &xprt
->recv_queue
);
952 xprt_request_rb_remove(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
954 rb_erase(&req
->rq_recv
, &xprt
->recv_queue
);
958 * xprt_lookup_rqst - find an RPC request corresponding to an XID
959 * @xprt: transport on which the original request was transmitted
960 * @xid: RPC XID of incoming reply
962 * Caller holds xprt->queue_lock.
964 struct rpc_rqst
*xprt_lookup_rqst(struct rpc_xprt
*xprt
, __be32 xid
)
966 struct rpc_rqst
*entry
;
968 entry
= xprt_request_rb_find(xprt
, xid
);
970 trace_xprt_lookup_rqst(xprt
, xid
, 0);
971 entry
->rq_rtt
= ktime_sub(ktime_get(), entry
->rq_xtime
);
975 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
977 trace_xprt_lookup_rqst(xprt
, xid
, -ENOENT
);
978 xprt
->stat
.bad_xids
++;
981 EXPORT_SYMBOL_GPL(xprt_lookup_rqst
);
984 xprt_is_pinned_rqst(struct rpc_rqst
*req
)
986 return atomic_read(&req
->rq_pin
) != 0;
990 * xprt_pin_rqst - Pin a request on the transport receive list
991 * @req: Request to pin
993 * Caller must ensure this is atomic with the call to xprt_lookup_rqst()
994 * so should be holding xprt->queue_lock.
996 void xprt_pin_rqst(struct rpc_rqst
*req
)
998 atomic_inc(&req
->rq_pin
);
1000 EXPORT_SYMBOL_GPL(xprt_pin_rqst
);
1003 * xprt_unpin_rqst - Unpin a request on the transport receive list
1004 * @req: Request to pin
1006 * Caller should be holding xprt->queue_lock.
1008 void xprt_unpin_rqst(struct rpc_rqst
*req
)
1010 if (!test_bit(RPC_TASK_MSG_PIN_WAIT
, &req
->rq_task
->tk_runstate
)) {
1011 atomic_dec(&req
->rq_pin
);
1014 if (atomic_dec_and_test(&req
->rq_pin
))
1015 wake_up_var(&req
->rq_pin
);
1017 EXPORT_SYMBOL_GPL(xprt_unpin_rqst
);
1019 static void xprt_wait_on_pinned_rqst(struct rpc_rqst
*req
)
1021 wait_var_event(&req
->rq_pin
, !xprt_is_pinned_rqst(req
));
1025 xprt_request_data_received(struct rpc_task
*task
)
1027 return !test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
) &&
1028 READ_ONCE(task
->tk_rqstp
->rq_reply_bytes_recvd
) != 0;
1032 xprt_request_need_enqueue_receive(struct rpc_task
*task
, struct rpc_rqst
*req
)
1034 return !test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
) &&
1035 READ_ONCE(task
->tk_rqstp
->rq_reply_bytes_recvd
) == 0;
1039 * xprt_request_enqueue_receive - Add an request to the receive queue
1044 xprt_request_enqueue_receive(struct rpc_task
*task
)
1046 struct rpc_rqst
*req
= task
->tk_rqstp
;
1047 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1049 if (!xprt_request_need_enqueue_receive(task
, req
))
1052 xprt_request_prepare(task
->tk_rqstp
);
1053 spin_lock(&xprt
->queue_lock
);
1055 /* Update the softirq receive buffer */
1056 memcpy(&req
->rq_private_buf
, &req
->rq_rcv_buf
,
1057 sizeof(req
->rq_private_buf
));
1059 /* Add request to the receive list */
1060 xprt_request_rb_insert(xprt
, req
);
1061 set_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
);
1062 spin_unlock(&xprt
->queue_lock
);
1064 /* Turn off autodisconnect */
1065 del_singleshot_timer_sync(&xprt
->timer
);
1069 * xprt_request_dequeue_receive_locked - Remove a request from the receive queue
1072 * Caller must hold xprt->queue_lock.
1075 xprt_request_dequeue_receive_locked(struct rpc_task
*task
)
1077 struct rpc_rqst
*req
= task
->tk_rqstp
;
1079 if (test_and_clear_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
))
1080 xprt_request_rb_remove(req
->rq_xprt
, req
);
1084 * xprt_update_rtt - Update RPC RTT statistics
1085 * @task: RPC request that recently completed
1087 * Caller holds xprt->queue_lock.
1089 void xprt_update_rtt(struct rpc_task
*task
)
1091 struct rpc_rqst
*req
= task
->tk_rqstp
;
1092 struct rpc_rtt
*rtt
= task
->tk_client
->cl_rtt
;
1093 unsigned int timer
= task
->tk_msg
.rpc_proc
->p_timer
;
1094 long m
= usecs_to_jiffies(ktime_to_us(req
->rq_rtt
));
1097 if (req
->rq_ntrans
== 1)
1098 rpc_update_rtt(rtt
, timer
, m
);
1099 rpc_set_timeo(rtt
, timer
, req
->rq_ntrans
- 1);
1102 EXPORT_SYMBOL_GPL(xprt_update_rtt
);
1105 * xprt_complete_rqst - called when reply processing is complete
1106 * @task: RPC request that recently completed
1107 * @copied: actual number of bytes received from the transport
1109 * Caller holds xprt->queue_lock.
1111 void xprt_complete_rqst(struct rpc_task
*task
, int copied
)
1113 struct rpc_rqst
*req
= task
->tk_rqstp
;
1114 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1116 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
1117 task
->tk_pid
, ntohl(req
->rq_xid
), copied
);
1118 trace_xprt_complete_rqst(xprt
, req
->rq_xid
, copied
);
1122 req
->rq_private_buf
.len
= copied
;
1123 /* Ensure all writes are done before we update */
1124 /* req->rq_reply_bytes_recvd */
1126 req
->rq_reply_bytes_recvd
= copied
;
1127 xprt_request_dequeue_receive_locked(task
);
1128 rpc_wake_up_queued_task(&xprt
->pending
, task
);
1130 EXPORT_SYMBOL_GPL(xprt_complete_rqst
);
1132 static void xprt_timer(struct rpc_task
*task
)
1134 struct rpc_rqst
*req
= task
->tk_rqstp
;
1135 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1137 if (task
->tk_status
!= -ETIMEDOUT
)
1140 trace_xprt_timer(xprt
, req
->rq_xid
, task
->tk_status
);
1141 if (!req
->rq_reply_bytes_recvd
) {
1142 if (xprt
->ops
->timer
)
1143 xprt
->ops
->timer(xprt
, task
);
1145 task
->tk_status
= 0;
1149 * xprt_wait_for_reply_request_def - wait for reply
1150 * @task: pointer to rpc_task
1152 * Set a request's retransmit timeout based on the transport's
1153 * default timeout parameters. Used by transports that don't adjust
1154 * the retransmit timeout based on round-trip time estimation,
1155 * and put the task to sleep on the pending queue.
1157 void xprt_wait_for_reply_request_def(struct rpc_task
*task
)
1159 struct rpc_rqst
*req
= task
->tk_rqstp
;
1161 rpc_sleep_on_timeout(&req
->rq_xprt
->pending
, task
, xprt_timer
,
1162 xprt_request_timeout(req
));
1164 EXPORT_SYMBOL_GPL(xprt_wait_for_reply_request_def
);
1167 * xprt_wait_for_reply_request_rtt - wait for reply using RTT estimator
1168 * @task: pointer to rpc_task
1170 * Set a request's retransmit timeout using the RTT estimator,
1171 * and put the task to sleep on the pending queue.
1173 void xprt_wait_for_reply_request_rtt(struct rpc_task
*task
)
1175 int timer
= task
->tk_msg
.rpc_proc
->p_timer
;
1176 struct rpc_clnt
*clnt
= task
->tk_client
;
1177 struct rpc_rtt
*rtt
= clnt
->cl_rtt
;
1178 struct rpc_rqst
*req
= task
->tk_rqstp
;
1179 unsigned long max_timeout
= clnt
->cl_timeout
->to_maxval
;
1180 unsigned long timeout
;
1182 timeout
= rpc_calc_rto(rtt
, timer
);
1183 timeout
<<= rpc_ntimeo(rtt
, timer
) + req
->rq_retries
;
1184 if (timeout
> max_timeout
|| timeout
== 0)
1185 timeout
= max_timeout
;
1186 rpc_sleep_on_timeout(&req
->rq_xprt
->pending
, task
, xprt_timer
,
1189 EXPORT_SYMBOL_GPL(xprt_wait_for_reply_request_rtt
);
1192 * xprt_request_wait_receive - wait for the reply to an RPC request
1193 * @task: RPC task about to send a request
1196 void xprt_request_wait_receive(struct rpc_task
*task
)
1198 struct rpc_rqst
*req
= task
->tk_rqstp
;
1199 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1201 if (!test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
))
1204 * Sleep on the pending queue if we're expecting a reply.
1205 * The spinlock ensures atomicity between the test of
1206 * req->rq_reply_bytes_recvd, and the call to rpc_sleep_on().
1208 spin_lock(&xprt
->queue_lock
);
1209 if (test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
)) {
1210 xprt
->ops
->wait_for_reply_request(task
);
1212 * Send an extra queue wakeup call if the
1213 * connection was dropped in case the call to
1214 * rpc_sleep_on() raced.
1216 if (xprt_request_retransmit_after_disconnect(task
))
1217 rpc_wake_up_queued_task_set_status(&xprt
->pending
,
1220 spin_unlock(&xprt
->queue_lock
);
1224 xprt_request_need_enqueue_transmit(struct rpc_task
*task
, struct rpc_rqst
*req
)
1226 return !test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
);
1230 * xprt_request_enqueue_transmit - queue a task for transmission
1231 * @task: pointer to rpc_task
1233 * Add a task to the transmission queue.
1236 xprt_request_enqueue_transmit(struct rpc_task
*task
)
1238 struct rpc_rqst
*pos
, *req
= task
->tk_rqstp
;
1239 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1241 if (xprt_request_need_enqueue_transmit(task
, req
)) {
1242 req
->rq_bytes_sent
= 0;
1243 spin_lock(&xprt
->queue_lock
);
1245 * Requests that carry congestion control credits are added
1246 * to the head of the list to avoid starvation issues.
1249 xprt_clear_congestion_window_wait(xprt
);
1250 list_for_each_entry(pos
, &xprt
->xmit_queue
, rq_xmit
) {
1253 /* Note: req is added _before_ pos */
1254 list_add_tail(&req
->rq_xmit
, &pos
->rq_xmit
);
1255 INIT_LIST_HEAD(&req
->rq_xmit2
);
1256 trace_xprt_enq_xmit(task
, 1);
1259 } else if (RPC_IS_SWAPPER(task
)) {
1260 list_for_each_entry(pos
, &xprt
->xmit_queue
, rq_xmit
) {
1261 if (pos
->rq_cong
|| pos
->rq_bytes_sent
)
1263 if (RPC_IS_SWAPPER(pos
->rq_task
))
1265 /* Note: req is added _before_ pos */
1266 list_add_tail(&req
->rq_xmit
, &pos
->rq_xmit
);
1267 INIT_LIST_HEAD(&req
->rq_xmit2
);
1268 trace_xprt_enq_xmit(task
, 2);
1271 } else if (!req
->rq_seqno
) {
1272 list_for_each_entry(pos
, &xprt
->xmit_queue
, rq_xmit
) {
1273 if (pos
->rq_task
->tk_owner
!= task
->tk_owner
)
1275 list_add_tail(&req
->rq_xmit2
, &pos
->rq_xmit2
);
1276 INIT_LIST_HEAD(&req
->rq_xmit
);
1277 trace_xprt_enq_xmit(task
, 3);
1281 list_add_tail(&req
->rq_xmit
, &xprt
->xmit_queue
);
1282 INIT_LIST_HEAD(&req
->rq_xmit2
);
1283 trace_xprt_enq_xmit(task
, 4);
1285 set_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
);
1286 spin_unlock(&xprt
->queue_lock
);
1291 * xprt_request_dequeue_transmit_locked - remove a task from the transmission queue
1292 * @task: pointer to rpc_task
1294 * Remove a task from the transmission queue
1295 * Caller must hold xprt->queue_lock
1298 xprt_request_dequeue_transmit_locked(struct rpc_task
*task
)
1300 struct rpc_rqst
*req
= task
->tk_rqstp
;
1302 if (!test_and_clear_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1304 if (!list_empty(&req
->rq_xmit
)) {
1305 list_del(&req
->rq_xmit
);
1306 if (!list_empty(&req
->rq_xmit2
)) {
1307 struct rpc_rqst
*next
= list_first_entry(&req
->rq_xmit2
,
1308 struct rpc_rqst
, rq_xmit2
);
1309 list_del(&req
->rq_xmit2
);
1310 list_add_tail(&next
->rq_xmit
, &next
->rq_xprt
->xmit_queue
);
1313 list_del(&req
->rq_xmit2
);
1317 * xprt_request_dequeue_transmit - remove a task from the transmission queue
1318 * @task: pointer to rpc_task
1320 * Remove a task from the transmission queue
1323 xprt_request_dequeue_transmit(struct rpc_task
*task
)
1325 struct rpc_rqst
*req
= task
->tk_rqstp
;
1326 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1328 spin_lock(&xprt
->queue_lock
);
1329 xprt_request_dequeue_transmit_locked(task
);
1330 spin_unlock(&xprt
->queue_lock
);
1334 * xprt_request_dequeue_xprt - remove a task from the transmit+receive queue
1335 * @task: pointer to rpc_task
1337 * Remove a task from the transmit and receive queues, and ensure that
1338 * it is not pinned by the receive work item.
1341 xprt_request_dequeue_xprt(struct rpc_task
*task
)
1343 struct rpc_rqst
*req
= task
->tk_rqstp
;
1344 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1346 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
) ||
1347 test_bit(RPC_TASK_NEED_RECV
, &task
->tk_runstate
) ||
1348 xprt_is_pinned_rqst(req
)) {
1349 spin_lock(&xprt
->queue_lock
);
1350 xprt_request_dequeue_transmit_locked(task
);
1351 xprt_request_dequeue_receive_locked(task
);
1352 while (xprt_is_pinned_rqst(req
)) {
1353 set_bit(RPC_TASK_MSG_PIN_WAIT
, &task
->tk_runstate
);
1354 spin_unlock(&xprt
->queue_lock
);
1355 xprt_wait_on_pinned_rqst(req
);
1356 spin_lock(&xprt
->queue_lock
);
1357 clear_bit(RPC_TASK_MSG_PIN_WAIT
, &task
->tk_runstate
);
1359 spin_unlock(&xprt
->queue_lock
);
1364 * xprt_request_prepare - prepare an encoded request for transport
1365 * @req: pointer to rpc_rqst
1367 * Calls into the transport layer to do whatever is needed to prepare
1368 * the request for transmission or receive.
1371 xprt_request_prepare(struct rpc_rqst
*req
)
1373 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1375 if (xprt
->ops
->prepare_request
)
1376 xprt
->ops
->prepare_request(req
);
1380 * xprt_request_need_retransmit - Test if a task needs retransmission
1381 * @task: pointer to rpc_task
1383 * Test for whether a connection breakage requires the task to retransmit
1386 xprt_request_need_retransmit(struct rpc_task
*task
)
1388 return xprt_request_retransmit_after_disconnect(task
);
1392 * xprt_prepare_transmit - reserve the transport before sending a request
1393 * @task: RPC task about to send a request
1396 bool xprt_prepare_transmit(struct rpc_task
*task
)
1398 struct rpc_rqst
*req
= task
->tk_rqstp
;
1399 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1401 dprintk("RPC: %5u xprt_prepare_transmit\n", task
->tk_pid
);
1403 if (!xprt_lock_write(xprt
, task
)) {
1404 /* Race breaker: someone may have transmitted us */
1405 if (!test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1406 rpc_wake_up_queued_task_set_status(&xprt
->sending
,
1414 void xprt_end_transmit(struct rpc_task
*task
)
1416 xprt_release_write(task
->tk_rqstp
->rq_xprt
, task
);
1420 * xprt_request_transmit - send an RPC request on a transport
1421 * @req: pointer to request to transmit
1422 * @snd_task: RPC task that owns the transport lock
1424 * This performs the transmission of a single request.
1425 * Note that if the request is not the same as snd_task, then it
1426 * does need to be pinned.
1427 * Returns '0' on success.
1430 xprt_request_transmit(struct rpc_rqst
*req
, struct rpc_task
*snd_task
)
1432 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1433 struct rpc_task
*task
= req
->rq_task
;
1434 unsigned int connect_cookie
;
1435 int is_retrans
= RPC_WAS_SENT(task
);
1438 if (!req
->rq_bytes_sent
) {
1439 if (xprt_request_data_received(task
)) {
1443 /* Verify that our message lies in the RPCSEC_GSS window */
1444 if (rpcauth_xmit_need_reencode(task
)) {
1448 if (RPC_SIGNALLED(task
)) {
1449 status
= -ERESTARTSYS
;
1455 * Update req->rq_ntrans before transmitting to avoid races with
1456 * xprt_update_rtt(), which needs to know that it is recording a
1457 * reply to the first transmission.
1461 connect_cookie
= xprt
->connect_cookie
;
1462 status
= xprt
->ops
->send_request(req
);
1465 trace_xprt_transmit(req
, status
);
1470 task
->tk_client
->cl_stats
->rpcretrans
++;
1472 xprt_inject_disconnect(xprt
);
1474 task
->tk_flags
|= RPC_TASK_SENT
;
1475 spin_lock(&xprt
->transport_lock
);
1478 xprt
->stat
.req_u
+= xprt
->stat
.sends
- xprt
->stat
.recvs
;
1479 xprt
->stat
.bklog_u
+= xprt
->backlog
.qlen
;
1480 xprt
->stat
.sending_u
+= xprt
->sending
.qlen
;
1481 xprt
->stat
.pending_u
+= xprt
->pending
.qlen
;
1482 spin_unlock(&xprt
->transport_lock
);
1484 req
->rq_connect_cookie
= connect_cookie
;
1486 trace_xprt_transmit(req
, status
);
1487 xprt_request_dequeue_transmit(task
);
1488 rpc_wake_up_queued_task_set_status(&xprt
->sending
, task
, status
);
1493 * xprt_transmit - send an RPC request on a transport
1494 * @task: controlling RPC task
1496 * Attempts to drain the transmit queue. On exit, either the transport
1497 * signalled an error that needs to be handled before transmission can
1498 * resume, or @task finished transmitting, and detected that it already
1502 xprt_transmit(struct rpc_task
*task
)
1504 struct rpc_rqst
*next
, *req
= task
->tk_rqstp
;
1505 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1508 spin_lock(&xprt
->queue_lock
);
1509 while (!list_empty(&xprt
->xmit_queue
)) {
1510 next
= list_first_entry(&xprt
->xmit_queue
,
1511 struct rpc_rqst
, rq_xmit
);
1512 xprt_pin_rqst(next
);
1513 spin_unlock(&xprt
->queue_lock
);
1514 status
= xprt_request_transmit(next
, task
);
1515 if (status
== -EBADMSG
&& next
!= req
)
1518 spin_lock(&xprt
->queue_lock
);
1519 xprt_unpin_rqst(next
);
1521 if (!xprt_request_data_received(task
) ||
1522 test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1524 } else if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
))
1525 task
->tk_status
= status
;
1528 spin_unlock(&xprt
->queue_lock
);
1531 static void xprt_add_backlog(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1533 set_bit(XPRT_CONGESTED
, &xprt
->state
);
1534 rpc_sleep_on(&xprt
->backlog
, task
, NULL
);
1537 static void xprt_wake_up_backlog(struct rpc_xprt
*xprt
)
1539 if (rpc_wake_up_next(&xprt
->backlog
) == NULL
)
1540 clear_bit(XPRT_CONGESTED
, &xprt
->state
);
1543 static bool xprt_throttle_congested(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1547 if (!test_bit(XPRT_CONGESTED
, &xprt
->state
))
1549 spin_lock(&xprt
->reserve_lock
);
1550 if (test_bit(XPRT_CONGESTED
, &xprt
->state
)) {
1551 rpc_sleep_on(&xprt
->backlog
, task
, NULL
);
1554 spin_unlock(&xprt
->reserve_lock
);
1559 static struct rpc_rqst
*xprt_dynamic_alloc_slot(struct rpc_xprt
*xprt
)
1561 struct rpc_rqst
*req
= ERR_PTR(-EAGAIN
);
1563 if (xprt
->num_reqs
>= xprt
->max_reqs
)
1566 spin_unlock(&xprt
->reserve_lock
);
1567 req
= kzalloc(sizeof(struct rpc_rqst
), GFP_NOFS
);
1568 spin_lock(&xprt
->reserve_lock
);
1572 req
= ERR_PTR(-ENOMEM
);
1577 static bool xprt_dynamic_free_slot(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
1579 if (xprt
->num_reqs
> xprt
->min_reqs
) {
1587 void xprt_alloc_slot(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1589 struct rpc_rqst
*req
;
1591 spin_lock(&xprt
->reserve_lock
);
1592 if (!list_empty(&xprt
->free
)) {
1593 req
= list_entry(xprt
->free
.next
, struct rpc_rqst
, rq_list
);
1594 list_del(&req
->rq_list
);
1597 req
= xprt_dynamic_alloc_slot(xprt
);
1600 switch (PTR_ERR(req
)) {
1602 dprintk("RPC: dynamic allocation of request slot "
1603 "failed! Retrying\n");
1604 task
->tk_status
= -ENOMEM
;
1607 xprt_add_backlog(xprt
, task
);
1608 dprintk("RPC: waiting for request slot\n");
1611 task
->tk_status
= -EAGAIN
;
1613 spin_unlock(&xprt
->reserve_lock
);
1616 xprt
->stat
.max_slots
= max_t(unsigned int, xprt
->stat
.max_slots
,
1618 spin_unlock(&xprt
->reserve_lock
);
1620 task
->tk_status
= 0;
1621 task
->tk_rqstp
= req
;
1623 EXPORT_SYMBOL_GPL(xprt_alloc_slot
);
1625 void xprt_free_slot(struct rpc_xprt
*xprt
, struct rpc_rqst
*req
)
1627 spin_lock(&xprt
->reserve_lock
);
1628 if (!xprt_dynamic_free_slot(xprt
, req
)) {
1629 memset(req
, 0, sizeof(*req
)); /* mark unused */
1630 list_add(&req
->rq_list
, &xprt
->free
);
1632 xprt_wake_up_backlog(xprt
);
1633 spin_unlock(&xprt
->reserve_lock
);
1635 EXPORT_SYMBOL_GPL(xprt_free_slot
);
1637 static void xprt_free_all_slots(struct rpc_xprt
*xprt
)
1639 struct rpc_rqst
*req
;
1640 while (!list_empty(&xprt
->free
)) {
1641 req
= list_first_entry(&xprt
->free
, struct rpc_rqst
, rq_list
);
1642 list_del(&req
->rq_list
);
1647 struct rpc_xprt
*xprt_alloc(struct net
*net
, size_t size
,
1648 unsigned int num_prealloc
,
1649 unsigned int max_alloc
)
1651 struct rpc_xprt
*xprt
;
1652 struct rpc_rqst
*req
;
1655 xprt
= kzalloc(size
, GFP_KERNEL
);
1659 xprt_init(xprt
, net
);
1661 for (i
= 0; i
< num_prealloc
; i
++) {
1662 req
= kzalloc(sizeof(struct rpc_rqst
), GFP_KERNEL
);
1665 list_add(&req
->rq_list
, &xprt
->free
);
1667 if (max_alloc
> num_prealloc
)
1668 xprt
->max_reqs
= max_alloc
;
1670 xprt
->max_reqs
= num_prealloc
;
1671 xprt
->min_reqs
= num_prealloc
;
1672 xprt
->num_reqs
= num_prealloc
;
1681 EXPORT_SYMBOL_GPL(xprt_alloc
);
1683 void xprt_free(struct rpc_xprt
*xprt
)
1685 put_net(xprt
->xprt_net
);
1686 xprt_free_all_slots(xprt
);
1687 kfree_rcu(xprt
, rcu
);
1689 EXPORT_SYMBOL_GPL(xprt_free
);
1692 xprt_init_connect_cookie(struct rpc_rqst
*req
, struct rpc_xprt
*xprt
)
1694 req
->rq_connect_cookie
= xprt_connect_cookie(xprt
) - 1;
1698 xprt_alloc_xid(struct rpc_xprt
*xprt
)
1702 spin_lock(&xprt
->reserve_lock
);
1703 xid
= (__force __be32
)xprt
->xid
++;
1704 spin_unlock(&xprt
->reserve_lock
);
1709 xprt_init_xid(struct rpc_xprt
*xprt
)
1711 xprt
->xid
= prandom_u32();
1715 xprt_request_init(struct rpc_task
*task
)
1717 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1718 struct rpc_rqst
*req
= task
->tk_rqstp
;
1720 req
->rq_task
= task
;
1721 req
->rq_xprt
= xprt
;
1722 req
->rq_buffer
= NULL
;
1723 req
->rq_xid
= xprt_alloc_xid(xprt
);
1724 xprt_init_connect_cookie(req
, xprt
);
1725 req
->rq_snd_buf
.len
= 0;
1726 req
->rq_snd_buf
.buflen
= 0;
1727 req
->rq_rcv_buf
.len
= 0;
1728 req
->rq_rcv_buf
.buflen
= 0;
1729 req
->rq_snd_buf
.bvec
= NULL
;
1730 req
->rq_rcv_buf
.bvec
= NULL
;
1731 req
->rq_release_snd_buf
= NULL
;
1732 xprt_init_majortimeo(task
, req
);
1733 dprintk("RPC: %5u reserved req %p xid %08x\n", task
->tk_pid
,
1734 req
, ntohl(req
->rq_xid
));
1738 xprt_do_reserve(struct rpc_xprt
*xprt
, struct rpc_task
*task
)
1740 xprt
->ops
->alloc_slot(xprt
, task
);
1741 if (task
->tk_rqstp
!= NULL
)
1742 xprt_request_init(task
);
1746 * xprt_reserve - allocate an RPC request slot
1747 * @task: RPC task requesting a slot allocation
1749 * If the transport is marked as being congested, or if no more
1750 * slots are available, place the task on the transport's
1753 void xprt_reserve(struct rpc_task
*task
)
1755 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1757 task
->tk_status
= 0;
1758 if (task
->tk_rqstp
!= NULL
)
1761 task
->tk_status
= -EAGAIN
;
1762 if (!xprt_throttle_congested(xprt
, task
))
1763 xprt_do_reserve(xprt
, task
);
1767 * xprt_retry_reserve - allocate an RPC request slot
1768 * @task: RPC task requesting a slot allocation
1770 * If no more slots are available, place the task on the transport's
1772 * Note that the only difference with xprt_reserve is that we now
1773 * ignore the value of the XPRT_CONGESTED flag.
1775 void xprt_retry_reserve(struct rpc_task
*task
)
1777 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1779 task
->tk_status
= 0;
1780 if (task
->tk_rqstp
!= NULL
)
1783 task
->tk_status
= -EAGAIN
;
1784 xprt_do_reserve(xprt
, task
);
1788 * xprt_release - release an RPC request slot
1789 * @task: task which is finished with the slot
1792 void xprt_release(struct rpc_task
*task
)
1794 struct rpc_xprt
*xprt
;
1795 struct rpc_rqst
*req
= task
->tk_rqstp
;
1798 if (task
->tk_client
) {
1799 xprt
= task
->tk_xprt
;
1800 xprt_release_write(xprt
, task
);
1805 xprt
= req
->rq_xprt
;
1806 xprt_request_dequeue_xprt(task
);
1807 spin_lock(&xprt
->transport_lock
);
1808 xprt
->ops
->release_xprt(xprt
, task
);
1809 if (xprt
->ops
->release_request
)
1810 xprt
->ops
->release_request(task
);
1811 xprt_schedule_autodisconnect(xprt
);
1812 spin_unlock(&xprt
->transport_lock
);
1814 xprt
->ops
->buf_free(task
);
1815 xprt_inject_disconnect(xprt
);
1816 xdr_free_bvec(&req
->rq_rcv_buf
);
1817 xdr_free_bvec(&req
->rq_snd_buf
);
1818 if (req
->rq_cred
!= NULL
)
1819 put_rpccred(req
->rq_cred
);
1820 task
->tk_rqstp
= NULL
;
1821 if (req
->rq_release_snd_buf
)
1822 req
->rq_release_snd_buf(req
);
1824 dprintk("RPC: %5u release request %p\n", task
->tk_pid
, req
);
1825 if (likely(!bc_prealloc(req
)))
1826 xprt
->ops
->free_slot(xprt
, req
);
1828 xprt_free_bc_request(req
);
1831 #ifdef CONFIG_SUNRPC_BACKCHANNEL
1833 xprt_init_bc_request(struct rpc_rqst
*req
, struct rpc_task
*task
)
1835 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
1837 task
->tk_rqstp
= req
;
1838 req
->rq_task
= task
;
1839 xprt_init_connect_cookie(req
, req
->rq_xprt
);
1841 * Set up the xdr_buf length.
1842 * This also indicates that the buffer is XDR encoded already.
1844 xbufp
->len
= xbufp
->head
[0].iov_len
+ xbufp
->page_len
+
1845 xbufp
->tail
[0].iov_len
;
1849 static void xprt_init(struct rpc_xprt
*xprt
, struct net
*net
)
1851 kref_init(&xprt
->kref
);
1853 spin_lock_init(&xprt
->transport_lock
);
1854 spin_lock_init(&xprt
->reserve_lock
);
1855 spin_lock_init(&xprt
->queue_lock
);
1857 INIT_LIST_HEAD(&xprt
->free
);
1858 xprt
->recv_queue
= RB_ROOT
;
1859 INIT_LIST_HEAD(&xprt
->xmit_queue
);
1860 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1861 spin_lock_init(&xprt
->bc_pa_lock
);
1862 INIT_LIST_HEAD(&xprt
->bc_pa_list
);
1863 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1864 INIT_LIST_HEAD(&xprt
->xprt_switch
);
1866 xprt
->last_used
= jiffies
;
1867 xprt
->cwnd
= RPC_INITCWND
;
1868 xprt
->bind_index
= 0;
1870 rpc_init_wait_queue(&xprt
->binding
, "xprt_binding");
1871 rpc_init_wait_queue(&xprt
->pending
, "xprt_pending");
1872 rpc_init_wait_queue(&xprt
->sending
, "xprt_sending");
1873 rpc_init_priority_wait_queue(&xprt
->backlog
, "xprt_backlog");
1875 xprt_init_xid(xprt
);
1877 xprt
->xprt_net
= get_net(net
);
1881 * xprt_create_transport - create an RPC transport
1882 * @args: rpc transport creation arguments
1885 struct rpc_xprt
*xprt_create_transport(struct xprt_create
*args
)
1887 struct rpc_xprt
*xprt
;
1888 struct xprt_class
*t
;
1890 spin_lock(&xprt_list_lock
);
1891 list_for_each_entry(t
, &xprt_list
, list
) {
1892 if (t
->ident
== args
->ident
) {
1893 spin_unlock(&xprt_list_lock
);
1897 spin_unlock(&xprt_list_lock
);
1898 dprintk("RPC: transport (%d) not supported\n", args
->ident
);
1899 return ERR_PTR(-EIO
);
1902 xprt
= t
->setup(args
);
1904 dprintk("RPC: xprt_create_transport: failed, %ld\n",
1908 if (args
->flags
& XPRT_CREATE_NO_IDLE_TIMEOUT
)
1909 xprt
->idle_timeout
= 0;
1910 INIT_WORK(&xprt
->task_cleanup
, xprt_autoclose
);
1911 if (xprt_has_timer(xprt
))
1912 timer_setup(&xprt
->timer
, xprt_init_autodisconnect
, 0);
1914 timer_setup(&xprt
->timer
, NULL
, 0);
1916 if (strlen(args
->servername
) > RPC_MAXNETNAMELEN
) {
1918 return ERR_PTR(-EINVAL
);
1920 xprt
->servername
= kstrdup(args
->servername
, GFP_KERNEL
);
1921 if (xprt
->servername
== NULL
) {
1923 return ERR_PTR(-ENOMEM
);
1926 rpc_xprt_debugfs_register(xprt
);
1928 dprintk("RPC: created transport %p with %u slots\n", xprt
,
1934 static void xprt_destroy_cb(struct work_struct
*work
)
1936 struct rpc_xprt
*xprt
=
1937 container_of(work
, struct rpc_xprt
, task_cleanup
);
1939 rpc_xprt_debugfs_unregister(xprt
);
1940 rpc_destroy_wait_queue(&xprt
->binding
);
1941 rpc_destroy_wait_queue(&xprt
->pending
);
1942 rpc_destroy_wait_queue(&xprt
->sending
);
1943 rpc_destroy_wait_queue(&xprt
->backlog
);
1944 kfree(xprt
->servername
);
1946 * Destroy any existing back channel
1948 xprt_destroy_backchannel(xprt
, UINT_MAX
);
1951 * Tear down transport state and free the rpc_xprt
1953 xprt
->ops
->destroy(xprt
);
1957 * xprt_destroy - destroy an RPC transport, killing off all requests.
1958 * @xprt: transport to destroy
1961 static void xprt_destroy(struct rpc_xprt
*xprt
)
1963 dprintk("RPC: destroying transport %p\n", xprt
);
1966 * Exclude transport connect/disconnect handlers and autoclose
1968 wait_on_bit_lock(&xprt
->state
, XPRT_LOCKED
, TASK_UNINTERRUPTIBLE
);
1970 del_timer_sync(&xprt
->timer
);
1973 * Destroy sockets etc from the system workqueue so they can
1974 * safely flush receive work running on rpciod.
1976 INIT_WORK(&xprt
->task_cleanup
, xprt_destroy_cb
);
1977 schedule_work(&xprt
->task_cleanup
);
1980 static void xprt_destroy_kref(struct kref
*kref
)
1982 xprt_destroy(container_of(kref
, struct rpc_xprt
, kref
));
1986 * xprt_get - return a reference to an RPC transport.
1987 * @xprt: pointer to the transport
1990 struct rpc_xprt
*xprt_get(struct rpc_xprt
*xprt
)
1992 if (xprt
!= NULL
&& kref_get_unless_zero(&xprt
->kref
))
1996 EXPORT_SYMBOL_GPL(xprt_get
);
1999 * xprt_put - release a reference to an RPC transport.
2000 * @xprt: pointer to the transport
2003 void xprt_put(struct rpc_xprt
*xprt
)
2006 kref_put(&xprt
->kref
, xprt_destroy_kref
);
2008 EXPORT_SYMBOL_GPL(xprt_put
);