Merge tag 'drm-misc-next-fixes-2019-12-12' of git://anongit.freedesktop.org/drm/drm...
[linux-block.git] / net / sunrpc / xprt.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * linux/net/sunrpc/xprt.c
4 *
5 * This is a generic RPC call interface supporting congestion avoidance,
6 * and asynchronous calls.
7 *
8 * The interface works like this:
9 *
10 * - When a process places a call, it allocates a request slot if
11 * one is available. Otherwise, it sleeps on the backlog queue
12 * (xprt_reserve).
13 * - Next, the caller puts together the RPC message, stuffs it into
55aa4f58
CL
14 * the request struct, and calls xprt_transmit().
15 * - xprt_transmit sends the message and installs the caller on the
55ae1aab
RL
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
18 * expired.
1da177e4 19 * - When a packet arrives, the data_ready handler walks the list of
55aa4f58 20 * pending requests for that transport. If a matching XID is found, the
1da177e4
LT
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
25 * of -ETIMEDOUT.
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
30 * again.
31 *
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.
35 *
36 * Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
55aa4f58
CL
37 *
38 * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
1da177e4
LT
39 */
40
a246b010
CL
41#include <linux/module.h>
42
1da177e4 43#include <linux/types.h>
a246b010 44#include <linux/interrupt.h>
1da177e4 45#include <linux/workqueue.h>
bf3fcf89 46#include <linux/net.h>
ff839970 47#include <linux/ktime.h>
1da177e4 48
a246b010 49#include <linux/sunrpc/clnt.h>
11c556b3 50#include <linux/sunrpc/metrics.h>
c9acb42e 51#include <linux/sunrpc/bc_xprt.h>
fda1bfef 52#include <linux/rcupdate.h>
a1231fda 53#include <linux/sched/mm.h>
1da177e4 54
3705ad64
JL
55#include <trace/events/sunrpc.h>
56
55ae1aab
RL
57#include "sunrpc.h"
58
1da177e4
LT
59/*
60 * Local variables
61 */
62
f895b252 63#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
1da177e4
LT
64# define RPCDBG_FACILITY RPCDBG_XPRT
65#endif
66
1da177e4
LT
67/*
68 * Local functions
69 */
21de0a95 70static void xprt_init(struct rpc_xprt *xprt, struct net *net);
37ac86c3 71static __be32 xprt_alloc_xid(struct rpc_xprt *xprt);
4e0038b6 72static void xprt_destroy(struct rpc_xprt *xprt);
1da177e4 73
5ba03e82 74static DEFINE_SPINLOCK(xprt_list_lock);
81c098af
TT
75static LIST_HEAD(xprt_list);
76
9e910bff
TM
77static unsigned long xprt_request_timeout(const struct rpc_rqst *req)
78{
79 unsigned long timeout = jiffies + req->rq_timeout;
80
81 if (time_before(timeout, req->rq_majortimeo))
82 return timeout;
83 return req->rq_majortimeo;
84}
85
81c098af
TT
86/**
87 * xprt_register_transport - register a transport implementation
88 * @transport: transport to register
89 *
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.
92 *
93 * Returns:
94 * 0: transport successfully registered
95 * -EEXIST: transport already registered
96 * -EINVAL: transport module being unloaded
97 */
98int xprt_register_transport(struct xprt_class *transport)
99{
100 struct xprt_class *t;
101 int result;
102
103 result = -EEXIST;
104 spin_lock(&xprt_list_lock);
105 list_for_each_entry(t, &xprt_list, list) {
106 /* don't register the same transport class twice */
4fa016eb 107 if (t->ident == transport->ident)
81c098af
TT
108 goto out;
109 }
110
c9f6cde6
DL
111 list_add_tail(&transport->list, &xprt_list);
112 printk(KERN_INFO "RPC: Registered %s transport module.\n",
113 transport->name);
114 result = 0;
81c098af
TT
115
116out:
117 spin_unlock(&xprt_list_lock);
118 return result;
119}
120EXPORT_SYMBOL_GPL(xprt_register_transport);
121
122/**
123 * xprt_unregister_transport - unregister a transport implementation
65b6e42c 124 * @transport: transport to unregister
81c098af
TT
125 *
126 * Returns:
127 * 0: transport successfully unregistered
128 * -ENOENT: transport never registered
129 */
130int xprt_unregister_transport(struct xprt_class *transport)
131{
132 struct xprt_class *t;
133 int result;
134
135 result = 0;
136 spin_lock(&xprt_list_lock);
137 list_for_each_entry(t, &xprt_list, list) {
138 if (t == transport) {
139 printk(KERN_INFO
140 "RPC: Unregistered %s transport module.\n",
141 transport->name);
142 list_del_init(&transport->list);
81c098af
TT
143 goto out;
144 }
145 }
146 result = -ENOENT;
147
148out:
149 spin_unlock(&xprt_list_lock);
150 return result;
151}
152EXPORT_SYMBOL_GPL(xprt_unregister_transport);
153
441e3e24
TT
154/**
155 * xprt_load_transport - load a transport implementation
156 * @transport_name: transport to load
157 *
158 * Returns:
159 * 0: transport successfully loaded
160 * -ENOENT: transport module not available
161 */
162int xprt_load_transport(const char *transport_name)
163{
164 struct xprt_class *t;
441e3e24
TT
165 int result;
166
167 result = 0;
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);
172 goto out;
173 }
174 }
175 spin_unlock(&xprt_list_lock);
ef7ffe8f 176 result = request_module("xprt%s", transport_name);
441e3e24
TT
177out:
178 return result;
179}
180EXPORT_SYMBOL_GPL(xprt_load_transport);
181
c544577d
TM
182static void xprt_clear_locked(struct rpc_xprt *xprt)
183{
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();
189 } else
190 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
191}
192
12a80469
CL
193/**
194 * xprt_reserve_xprt - serialize write access to transports
195 * @task: task that is requesting access to the transport
177c27bf 196 * @xprt: pointer to the target transport
12a80469
CL
197 *
198 * This prevents mixing the payload of separate requests, and prevents
199 * transport connects from colliding with writes. No congestion control
200 * is provided.
201 */
43cedbf0 202int xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
12a80469 203{
12a80469
CL
204 struct rpc_rqst *req = task->tk_rqstp;
205
206 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
207 if (task == xprt->snd_task)
bf7ca707 208 goto out_locked;
12a80469
CL
209 goto out_sleep;
210 }
c544577d
TM
211 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
212 goto out_unlock;
12a80469 213 xprt->snd_task = task;
4d4a76f3 214
bf7ca707
CL
215out_locked:
216 trace_xprt_reserve_xprt(xprt, task);
12a80469
CL
217 return 1;
218
c544577d
TM
219out_unlock:
220 xprt_clear_locked(xprt);
12a80469 221out_sleep:
12a80469 222 task->tk_status = -EAGAIN;
6b2e6856
TM
223 if (RPC_IS_SOFT(task))
224 rpc_sleep_on_timeout(&xprt->sending, task, NULL,
9e910bff 225 xprt_request_timeout(req));
6b2e6856
TM
226 else
227 rpc_sleep_on(&xprt->sending, task, NULL);
12a80469
CL
228 return 0;
229}
12444809 230EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
12a80469 231
75891f50
TM
232static bool
233xprt_need_congestion_window_wait(struct rpc_xprt *xprt)
234{
235 return test_bit(XPRT_CWND_WAIT, &xprt->state);
236}
237
238static void
239xprt_set_congestion_window_wait(struct rpc_xprt *xprt)
240{
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,
244 rq_xmit)->rq_cong)
245 return;
246 }
247 set_bit(XPRT_CWND_WAIT, &xprt->state);
248}
249
250static void
251xprt_test_and_clear_congestion_window_wait(struct rpc_xprt *xprt)
252{
253 if (!RPCXPRT_CONGESTED(xprt))
254 clear_bit(XPRT_CWND_WAIT, &xprt->state);
255}
256
1da177e4 257/*
12a80469
CL
258 * xprt_reserve_xprt_cong - serialize write access to transports
259 * @task: task that is requesting access to the transport
260 *
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.
75891f50 264 * Note that the lock is only granted if we know there are free slots.
1da177e4 265 */
43cedbf0 266int xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
267{
268 struct rpc_rqst *req = task->tk_rqstp;
269
2226feb6 270 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
1da177e4 271 if (task == xprt->snd_task)
bf7ca707 272 goto out_locked;
1da177e4
LT
273 goto out_sleep;
274 }
43cedbf0
TM
275 if (req == NULL) {
276 xprt->snd_task = task;
bf7ca707 277 goto out_locked;
43cedbf0 278 }
c544577d
TM
279 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
280 goto out_unlock;
75891f50 281 if (!xprt_need_congestion_window_wait(xprt)) {
1da177e4 282 xprt->snd_task = task;
bf7ca707 283 goto out_locked;
1da177e4 284 }
c544577d 285out_unlock:
632e3bdc 286 xprt_clear_locked(xprt);
1da177e4 287out_sleep:
1da177e4 288 task->tk_status = -EAGAIN;
6b2e6856
TM
289 if (RPC_IS_SOFT(task))
290 rpc_sleep_on_timeout(&xprt->sending, task, NULL,
9e910bff 291 xprt_request_timeout(req));
6b2e6856
TM
292 else
293 rpc_sleep_on(&xprt->sending, task, NULL);
1da177e4 294 return 0;
bf7ca707
CL
295out_locked:
296 trace_xprt_reserve_cong(xprt, task);
297 return 1;
1da177e4 298}
12444809 299EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
1da177e4 300
12a80469 301static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
302{
303 int retval;
304
bd79bc57
TM
305 if (test_bit(XPRT_LOCKED, &xprt->state) && xprt->snd_task == task)
306 return 1;
b5e92419 307 spin_lock(&xprt->transport_lock);
43cedbf0 308 retval = xprt->ops->reserve_xprt(xprt, task);
b5e92419 309 spin_unlock(&xprt->transport_lock);
1da177e4
LT
310 return retval;
311}
312
961a828d 313static bool __xprt_lock_write_func(struct rpc_task *task, void *data)
49e9a890 314{
961a828d 315 struct rpc_xprt *xprt = data;
49e9a890 316
49e9a890 317 xprt->snd_task = task;
961a828d
TM
318 return true;
319}
49e9a890 320
961a828d
TM
321static void __xprt_lock_write_next(struct rpc_xprt *xprt)
322{
323 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
324 return;
c544577d
TM
325 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
326 goto out_unlock;
f1dc237c
TM
327 if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
328 __xprt_lock_write_func, xprt))
961a828d 329 return;
c544577d 330out_unlock:
632e3bdc 331 xprt_clear_locked(xprt);
49e9a890
CL
332}
333
961a828d
TM
334static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
335{
336 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
337 return;
c544577d
TM
338 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
339 goto out_unlock;
75891f50 340 if (xprt_need_congestion_window_wait(xprt))
961a828d 341 goto out_unlock;
f1dc237c 342 if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
75891f50 343 __xprt_lock_write_func, xprt))
961a828d 344 return;
1da177e4 345out_unlock:
632e3bdc 346 xprt_clear_locked(xprt);
1da177e4
LT
347}
348
49e9a890
CL
349/**
350 * xprt_release_xprt - allow other requests to use a transport
351 * @xprt: transport with other tasks potentially waiting
352 * @task: task that is releasing access to the transport
353 *
354 * Note that "task" can be NULL. No congestion control is provided.
1da177e4 355 */
49e9a890 356void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
357{
358 if (xprt->snd_task == task) {
632e3bdc 359 xprt_clear_locked(xprt);
1da177e4
LT
360 __xprt_lock_write_next(xprt);
361 }
bf7ca707 362 trace_xprt_release_xprt(xprt, task);
1da177e4 363}
12444809 364EXPORT_SYMBOL_GPL(xprt_release_xprt);
1da177e4 365
49e9a890
CL
366/**
367 * xprt_release_xprt_cong - allow other requests to use a transport
368 * @xprt: transport with other tasks potentially waiting
369 * @task: task that is releasing access to the transport
370 *
371 * Note that "task" can be NULL. Another task is awoken to use the
372 * transport if the transport's congestion window allows it.
373 */
374void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
375{
376 if (xprt->snd_task == task) {
632e3bdc 377 xprt_clear_locked(xprt);
49e9a890
CL
378 __xprt_lock_write_next_cong(xprt);
379 }
bf7ca707 380 trace_xprt_release_cong(xprt, task);
49e9a890 381}
12444809 382EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
49e9a890
CL
383
384static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4 385{
bd79bc57
TM
386 if (xprt->snd_task != task)
387 return;
b5e92419 388 spin_lock(&xprt->transport_lock);
49e9a890 389 xprt->ops->release_xprt(xprt, task);
b5e92419 390 spin_unlock(&xprt->transport_lock);
1da177e4
LT
391}
392
1da177e4
LT
393/*
394 * Van Jacobson congestion avoidance. Check if the congestion window
395 * overflowed. Put the task to sleep if this is the case.
396 */
397static int
75891f50 398__xprt_get_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
1da177e4 399{
1da177e4
LT
400 if (req->rq_cong)
401 return 1;
bf7ca707 402 trace_xprt_get_cong(xprt, req->rq_task);
75891f50
TM
403 if (RPCXPRT_CONGESTED(xprt)) {
404 xprt_set_congestion_window_wait(xprt);
1da177e4 405 return 0;
75891f50 406 }
1da177e4
LT
407 req->rq_cong = 1;
408 xprt->cong += RPC_CWNDSCALE;
409 return 1;
410}
411
412/*
413 * Adjust the congestion window, and wake up the next task
414 * that has been sleeping due to congestion
415 */
416static void
417__xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
418{
419 if (!req->rq_cong)
420 return;
421 req->rq_cong = 0;
422 xprt->cong -= RPC_CWNDSCALE;
75891f50 423 xprt_test_and_clear_congestion_window_wait(xprt);
bf7ca707 424 trace_xprt_put_cong(xprt, req->rq_task);
49e9a890 425 __xprt_lock_write_next_cong(xprt);
1da177e4
LT
426}
427
75891f50
TM
428/**
429 * xprt_request_get_cong - Request congestion control credits
430 * @xprt: pointer to transport
431 * @req: pointer to RPC request
432 *
433 * Useful for transports that require congestion control.
434 */
435bool
436xprt_request_get_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
437{
438 bool ret = false;
439
440 if (req->rq_cong)
441 return true;
b5e92419 442 spin_lock(&xprt->transport_lock);
75891f50 443 ret = __xprt_get_cong(xprt, req) != 0;
b5e92419 444 spin_unlock(&xprt->transport_lock);
75891f50
TM
445 return ret;
446}
447EXPORT_SYMBOL_GPL(xprt_request_get_cong);
448
a58dd398
CL
449/**
450 * xprt_release_rqst_cong - housekeeping when request is complete
451 * @task: RPC request that recently completed
452 *
453 * Useful for transports that require congestion control.
454 */
455void xprt_release_rqst_cong(struct rpc_task *task)
456{
a4f0835c
TM
457 struct rpc_rqst *req = task->tk_rqstp;
458
459 __xprt_put_cong(req->rq_xprt, req);
a58dd398 460}
12444809 461EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
a58dd398 462
8593e010
CL
463static void xprt_clear_congestion_window_wait_locked(struct rpc_xprt *xprt)
464{
465 if (test_and_clear_bit(XPRT_CWND_WAIT, &xprt->state))
466 __xprt_lock_write_next_cong(xprt);
467}
468
75891f50
TM
469/*
470 * Clear the congestion window wait flag and wake up the next
471 * entry on xprt->sending
472 */
473static void
474xprt_clear_congestion_window_wait(struct rpc_xprt *xprt)
475{
476 if (test_and_clear_bit(XPRT_CWND_WAIT, &xprt->state)) {
b5e92419 477 spin_lock(&xprt->transport_lock);
75891f50 478 __xprt_lock_write_next_cong(xprt);
b5e92419 479 spin_unlock(&xprt->transport_lock);
75891f50
TM
480 }
481}
482
46c0ee8b
CL
483/**
484 * xprt_adjust_cwnd - adjust transport congestion window
6a24dfb6 485 * @xprt: pointer to xprt
46c0ee8b
CL
486 * @task: recently completed RPC request used to adjust window
487 * @result: result code of completed RPC request
488 *
4f4cf5ad
CL
489 * The transport code maintains an estimate on the maximum number of out-
490 * standing RPC requests, using a smoothed version of the congestion
491 * avoidance implemented in 44BSD. This is basically the Van Jacobson
492 * congestion algorithm: If a retransmit occurs, the congestion window is
493 * halved; otherwise, it is incremented by 1/cwnd when
494 *
495 * - a reply is received and
496 * - a full number of requests are outstanding and
497 * - the congestion window hasn't been updated recently.
1da177e4 498 */
6a24dfb6 499void xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result)
1da177e4 500{
46c0ee8b 501 struct rpc_rqst *req = task->tk_rqstp;
46c0ee8b 502 unsigned long cwnd = xprt->cwnd;
1da177e4 503
1da177e4
LT
504 if (result >= 0 && cwnd <= xprt->cong) {
505 /* The (cwnd >> 1) term makes sure
506 * the result gets rounded properly. */
507 cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
508 if (cwnd > RPC_MAXCWND(xprt))
509 cwnd = RPC_MAXCWND(xprt);
49e9a890 510 __xprt_lock_write_next_cong(xprt);
1da177e4
LT
511 } else if (result == -ETIMEDOUT) {
512 cwnd >>= 1;
513 if (cwnd < RPC_CWNDSCALE)
514 cwnd = RPC_CWNDSCALE;
515 }
46121cf7 516 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
1da177e4
LT
517 xprt->cong, xprt->cwnd, cwnd);
518 xprt->cwnd = cwnd;
46c0ee8b 519 __xprt_put_cong(xprt, req);
1da177e4 520}
12444809 521EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
1da177e4 522
44fbac22
CL
523/**
524 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
525 * @xprt: transport with waiting tasks
526 * @status: result code to plant in each task before waking it
527 *
528 */
529void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
530{
531 if (status < 0)
532 rpc_wake_up_status(&xprt->pending, status);
533 else
534 rpc_wake_up(&xprt->pending);
535}
12444809 536EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
44fbac22 537
c7b2cae8
CL
538/**
539 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
c544577d 540 * @xprt: transport
a9a6b52e
TM
541 *
542 * Note that we only set the timer for the case of RPC_IS_SOFT(), since
543 * we don't in general want to force a socket disconnection due to
544 * an incomplete RPC call transmission.
c7b2cae8 545 */
c544577d 546void xprt_wait_for_buffer_space(struct rpc_xprt *xprt)
c7b2cae8 547{
c544577d 548 set_bit(XPRT_WRITE_SPACE, &xprt->state);
c7b2cae8 549}
12444809 550EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
c7b2cae8 551
c544577d
TM
552static bool
553xprt_clear_write_space_locked(struct rpc_xprt *xprt)
554{
555 if (test_and_clear_bit(XPRT_WRITE_SPACE, &xprt->state)) {
556 __xprt_lock_write_next(xprt);
557 dprintk("RPC: write space: waking waiting task on "
558 "xprt %p\n", xprt);
559 return true;
560 }
561 return false;
562}
563
c7b2cae8
CL
564/**
565 * xprt_write_space - wake the task waiting for transport output buffer space
566 * @xprt: transport with waiting tasks
567 *
568 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
569 */
c544577d 570bool xprt_write_space(struct rpc_xprt *xprt)
c7b2cae8 571{
c544577d
TM
572 bool ret;
573
574 if (!test_bit(XPRT_WRITE_SPACE, &xprt->state))
575 return false;
b5e92419 576 spin_lock(&xprt->transport_lock);
c544577d 577 ret = xprt_clear_write_space_locked(xprt);
b5e92419 578 spin_unlock(&xprt->transport_lock);
c544577d 579 return ret;
c7b2cae8 580}
12444809 581EXPORT_SYMBOL_GPL(xprt_write_space);
c7b2cae8 582
da953063
TM
583static unsigned long xprt_abs_ktime_to_jiffies(ktime_t abstime)
584{
585 s64 delta = ktime_to_ns(ktime_get() - abstime);
586 return likely(delta >= 0) ?
587 jiffies - nsecs_to_jiffies(delta) :
588 jiffies + nsecs_to_jiffies(-delta);
589}
590
591static unsigned long xprt_calc_majortimeo(struct rpc_rqst *req)
1da177e4 592{
ba7392bb 593 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
da953063 594 unsigned long majortimeo = req->rq_timeout;
1da177e4 595
1da177e4 596 if (to->to_exponential)
da953063
TM
597 majortimeo <<= to->to_retries;
598 else
599 majortimeo += to->to_increment * to->to_retries;
600 if (majortimeo > to->to_maxval || majortimeo == 0)
601 majortimeo = to->to_maxval;
602 return majortimeo;
603}
604
605static void xprt_reset_majortimeo(struct rpc_rqst *req)
606{
607 req->rq_majortimeo += xprt_calc_majortimeo(req);
608}
609
610static void xprt_init_majortimeo(struct rpc_task *task, struct rpc_rqst *req)
611{
612 unsigned long time_init;
613 struct rpc_xprt *xprt = req->rq_xprt;
614
615 if (likely(xprt && xprt_connected(xprt)))
616 time_init = jiffies;
1da177e4 617 else
da953063
TM
618 time_init = xprt_abs_ktime_to_jiffies(task->tk_start);
619 req->rq_timeout = task->tk_client->cl_timeout->to_initval;
620 req->rq_majortimeo = time_init + xprt_calc_majortimeo(req);
1da177e4
LT
621}
622
9903cd1c
CL
623/**
624 * xprt_adjust_timeout - adjust timeout values for next retransmit
625 * @req: RPC request containing parameters to use for the adjustment
626 *
1da177e4
LT
627 */
628int xprt_adjust_timeout(struct rpc_rqst *req)
629{
630 struct rpc_xprt *xprt = req->rq_xprt;
ba7392bb 631 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
1da177e4
LT
632 int status = 0;
633
634 if (time_before(jiffies, req->rq_majortimeo)) {
635 if (to->to_exponential)
636 req->rq_timeout <<= 1;
637 else
638 req->rq_timeout += to->to_increment;
639 if (to->to_maxval && req->rq_timeout >= to->to_maxval)
640 req->rq_timeout = to->to_maxval;
641 req->rq_retries++;
1da177e4
LT
642 } else {
643 req->rq_timeout = to->to_initval;
644 req->rq_retries = 0;
645 xprt_reset_majortimeo(req);
646 /* Reset the RTT counters == "slow start" */
b5e92419 647 spin_lock(&xprt->transport_lock);
1da177e4 648 rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
b5e92419 649 spin_unlock(&xprt->transport_lock);
1da177e4
LT
650 status = -ETIMEDOUT;
651 }
652
653 if (req->rq_timeout == 0) {
654 printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
655 req->rq_timeout = 5 * HZ;
656 }
657 return status;
658}
659
65f27f38 660static void xprt_autoclose(struct work_struct *work)
1da177e4 661{
65f27f38
DH
662 struct rpc_xprt *xprt =
663 container_of(work, struct rpc_xprt, task_cleanup);
a1231fda 664 unsigned int pflags = memalloc_nofs_save();
1da177e4 665
66af1e55 666 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
4876cc77 667 xprt->ops->close(xprt);
1da177e4 668 xprt_release_write(xprt, NULL);
79234c3d 669 wake_up_bit(&xprt->state, XPRT_LOCKED);
a1231fda 670 memalloc_nofs_restore(pflags);
1da177e4
LT
671}
672
9903cd1c 673/**
62da3b24 674 * xprt_disconnect_done - mark a transport as disconnected
9903cd1c
CL
675 * @xprt: transport to flag for disconnect
676 *
1da177e4 677 */
62da3b24 678void xprt_disconnect_done(struct rpc_xprt *xprt)
1da177e4 679{
46121cf7 680 dprintk("RPC: disconnected transport %p\n", xprt);
b5e92419 681 spin_lock(&xprt->transport_lock);
1da177e4 682 xprt_clear_connected(xprt);
c544577d 683 xprt_clear_write_space_locked(xprt);
8593e010 684 xprt_clear_congestion_window_wait_locked(xprt);
27adc785 685 xprt_wake_pending_tasks(xprt, -ENOTCONN);
b5e92419 686 spin_unlock(&xprt->transport_lock);
1da177e4 687}
62da3b24 688EXPORT_SYMBOL_GPL(xprt_disconnect_done);
1da177e4 689
66af1e55
TM
690/**
691 * xprt_force_disconnect - force a transport to disconnect
692 * @xprt: transport to disconnect
693 *
694 */
695void xprt_force_disconnect(struct rpc_xprt *xprt)
696{
697 /* Don't race with the test_bit() in xprt_clear_locked() */
b5e92419 698 spin_lock(&xprt->transport_lock);
66af1e55
TM
699 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
700 /* Try to schedule an autoclose RPC call */
701 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
40a5f1b1 702 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
0445f92c
TM
703 else if (xprt->snd_task)
704 rpc_wake_up_queued_task_set_status(&xprt->pending,
705 xprt->snd_task, -ENOTCONN);
b5e92419 706 spin_unlock(&xprt->transport_lock);
66af1e55 707}
e2a4f4fb 708EXPORT_SYMBOL_GPL(xprt_force_disconnect);
66af1e55 709
7f3a1d1e
TM
710static unsigned int
711xprt_connect_cookie(struct rpc_xprt *xprt)
712{
713 return READ_ONCE(xprt->connect_cookie);
714}
715
716static bool
717xprt_request_retransmit_after_disconnect(struct rpc_task *task)
718{
719 struct rpc_rqst *req = task->tk_rqstp;
720 struct rpc_xprt *xprt = req->rq_xprt;
721
722 return req->rq_connect_cookie != xprt_connect_cookie(xprt) ||
723 !xprt_connected(xprt);
724}
725
7c1d71cf
TM
726/**
727 * xprt_conditional_disconnect - force a transport to disconnect
728 * @xprt: transport to disconnect
729 * @cookie: 'connection cookie'
730 *
731 * This attempts to break the connection if and only if 'cookie' matches
732 * the current transport 'connection cookie'. It ensures that we don't
733 * try to break the connection more than once when we need to retransmit
734 * a batch of RPC requests.
735 *
736 */
737void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
738{
739 /* Don't race with the test_bit() in xprt_clear_locked() */
b5e92419 740 spin_lock(&xprt->transport_lock);
7c1d71cf
TM
741 if (cookie != xprt->connect_cookie)
742 goto out;
2c2ee6d2 743 if (test_bit(XPRT_CLOSING, &xprt->state))
7c1d71cf
TM
744 goto out;
745 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
746 /* Try to schedule an autoclose RPC call */
747 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
40a5f1b1 748 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
2a491991 749 xprt_wake_pending_tasks(xprt, -EAGAIN);
7c1d71cf 750out:
b5e92419 751 spin_unlock(&xprt->transport_lock);
7c1d71cf
TM
752}
753
ad3331ac
TM
754static bool
755xprt_has_timer(const struct rpc_xprt *xprt)
756{
757 return xprt->idle_timeout != 0;
758}
759
760static void
761xprt_schedule_autodisconnect(struct rpc_xprt *xprt)
762 __must_hold(&xprt->transport_lock)
763{
80d3c45f 764 xprt->last_used = jiffies;
95f7691d 765 if (RB_EMPTY_ROOT(&xprt->recv_queue) && xprt_has_timer(xprt))
ad3331ac
TM
766 mod_timer(&xprt->timer, xprt->last_used + xprt->idle_timeout);
767}
768
1da177e4 769static void
ff861c4d 770xprt_init_autodisconnect(struct timer_list *t)
1da177e4 771{
ff861c4d 772 struct rpc_xprt *xprt = from_timer(xprt, t, timer);
1da177e4 773
95f7691d 774 if (!RB_EMPTY_ROOT(&xprt->recv_queue))
b5e92419 775 return;
ad3331ac
TM
776 /* Reset xprt->last_used to avoid connect/autodisconnect cycling */
777 xprt->last_used = jiffies;
2226feb6 778 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
b5e92419 779 return;
40a5f1b1 780 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
1da177e4
LT
781}
782
718ba5b8
TM
783bool xprt_lock_connect(struct rpc_xprt *xprt,
784 struct rpc_task *task,
785 void *cookie)
786{
787 bool ret = false;
788
b5e92419 789 spin_lock(&xprt->transport_lock);
718ba5b8
TM
790 if (!test_bit(XPRT_LOCKED, &xprt->state))
791 goto out;
792 if (xprt->snd_task != task)
793 goto out;
794 xprt->snd_task = cookie;
795 ret = true;
796out:
b5e92419 797 spin_unlock(&xprt->transport_lock);
718ba5b8
TM
798 return ret;
799}
800
801void xprt_unlock_connect(struct rpc_xprt *xprt, void *cookie)
802{
b5e92419 803 spin_lock(&xprt->transport_lock);
718ba5b8
TM
804 if (xprt->snd_task != cookie)
805 goto out;
806 if (!test_bit(XPRT_LOCKED, &xprt->state))
807 goto out;
808 xprt->snd_task =NULL;
809 xprt->ops->release_xprt(xprt, NULL);
ad3331ac 810 xprt_schedule_autodisconnect(xprt);
718ba5b8 811out:
b5e92419 812 spin_unlock(&xprt->transport_lock);
79234c3d 813 wake_up_bit(&xprt->state, XPRT_LOCKED);
718ba5b8
TM
814}
815
9903cd1c
CL
816/**
817 * xprt_connect - schedule a transport connect operation
818 * @task: RPC task that is requesting the connect
1da177e4
LT
819 *
820 */
821void xprt_connect(struct rpc_task *task)
822{
ad2368d6 823 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1da177e4 824
46121cf7 825 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
1da177e4
LT
826 xprt, (xprt_connected(xprt) ? "is" : "is not"));
827
ec739ef0 828 if (!xprt_bound(xprt)) {
01d37c42 829 task->tk_status = -EAGAIN;
1da177e4
LT
830 return;
831 }
832 if (!xprt_lock_write(xprt, task))
833 return;
feb8ca37
TM
834
835 if (test_and_clear_bit(XPRT_CLOSE_WAIT, &xprt->state))
836 xprt->ops->close(xprt);
837
718ba5b8 838 if (!xprt_connected(xprt)) {
2c2ee6d2 839 task->tk_rqstp->rq_connect_cookie = xprt->connect_cookie;
6b2e6856 840 rpc_sleep_on_timeout(&xprt->pending, task, NULL,
9e910bff 841 xprt_request_timeout(task->tk_rqstp));
0b9e7943
TM
842
843 if (test_bit(XPRT_CLOSING, &xprt->state))
844 return;
845 if (xprt_test_and_set_connecting(xprt))
846 return;
0a9a4304
TM
847 /* Race breaker */
848 if (!xprt_connected(xprt)) {
849 xprt->stat.connect_start = jiffies;
850 xprt->ops->connect(xprt, task);
851 } else {
852 xprt_clear_connecting(xprt);
853 task->tk_status = 0;
854 rpc_wake_up_queued_task(&xprt->pending, task);
855 }
1da177e4 856 }
718ba5b8 857 xprt_release_write(xprt, task);
1da177e4
LT
858}
859
675dd90a
CL
860/**
861 * xprt_reconnect_delay - compute the wait before scheduling a connect
862 * @xprt: transport instance
863 *
864 */
865unsigned long xprt_reconnect_delay(const struct rpc_xprt *xprt)
866{
867 unsigned long start, now = jiffies;
868
869 start = xprt->stat.connect_start + xprt->reestablish_timeout;
870 if (time_after(start, now))
871 return start - now;
872 return 0;
873}
874EXPORT_SYMBOL_GPL(xprt_reconnect_delay);
875
876/**
877 * xprt_reconnect_backoff - compute the new re-establish timeout
878 * @xprt: transport instance
879 * @init_to: initial reestablish timeout
880 *
881 */
882void xprt_reconnect_backoff(struct rpc_xprt *xprt, unsigned long init_to)
883{
884 xprt->reestablish_timeout <<= 1;
885 if (xprt->reestablish_timeout > xprt->max_reconnect_timeout)
886 xprt->reestablish_timeout = xprt->max_reconnect_timeout;
887 if (xprt->reestablish_timeout < init_to)
888 xprt->reestablish_timeout = init_to;
889}
890EXPORT_SYMBOL_GPL(xprt_reconnect_backoff);
891
95f7691d
TM
892enum xprt_xid_rb_cmp {
893 XID_RB_EQUAL,
894 XID_RB_LEFT,
895 XID_RB_RIGHT,
896};
897static enum xprt_xid_rb_cmp
898xprt_xid_cmp(__be32 xid1, __be32 xid2)
899{
900 if (xid1 == xid2)
901 return XID_RB_EQUAL;
902 if ((__force u32)xid1 < (__force u32)xid2)
903 return XID_RB_LEFT;
904 return XID_RB_RIGHT;
905}
906
907static struct rpc_rqst *
908xprt_request_rb_find(struct rpc_xprt *xprt, __be32 xid)
909{
910 struct rb_node *n = xprt->recv_queue.rb_node;
911 struct rpc_rqst *req;
912
913 while (n != NULL) {
914 req = rb_entry(n, struct rpc_rqst, rq_recv);
915 switch (xprt_xid_cmp(xid, req->rq_xid)) {
916 case XID_RB_LEFT:
917 n = n->rb_left;
918 break;
919 case XID_RB_RIGHT:
920 n = n->rb_right;
921 break;
922 case XID_RB_EQUAL:
923 return req;
924 }
925 }
926 return NULL;
927}
928
929static void
930xprt_request_rb_insert(struct rpc_xprt *xprt, struct rpc_rqst *new)
931{
932 struct rb_node **p = &xprt->recv_queue.rb_node;
933 struct rb_node *n = NULL;
934 struct rpc_rqst *req;
935
936 while (*p != NULL) {
937 n = *p;
938 req = rb_entry(n, struct rpc_rqst, rq_recv);
939 switch(xprt_xid_cmp(new->rq_xid, req->rq_xid)) {
940 case XID_RB_LEFT:
941 p = &n->rb_left;
942 break;
943 case XID_RB_RIGHT:
944 p = &n->rb_right;
945 break;
946 case XID_RB_EQUAL:
947 WARN_ON_ONCE(new != req);
948 return;
949 }
950 }
951 rb_link_node(&new->rq_recv, n, p);
952 rb_insert_color(&new->rq_recv, &xprt->recv_queue);
953}
954
955static void
956xprt_request_rb_remove(struct rpc_xprt *xprt, struct rpc_rqst *req)
957{
958 rb_erase(&req->rq_recv, &xprt->recv_queue);
959}
960
9903cd1c
CL
961/**
962 * xprt_lookup_rqst - find an RPC request corresponding to an XID
963 * @xprt: transport on which the original request was transmitted
964 * @xid: RPC XID of incoming reply
965 *
75c84151 966 * Caller holds xprt->queue_lock.
1da177e4 967 */
d8ed029d 968struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
1da177e4 969{
8f3a6de3 970 struct rpc_rqst *entry;
1da177e4 971
95f7691d
TM
972 entry = xprt_request_rb_find(xprt, xid);
973 if (entry != NULL) {
974 trace_xprt_lookup_rqst(xprt, xid, 0);
975 entry->rq_rtt = ktime_sub(ktime_get(), entry->rq_xtime);
976 return entry;
977 }
46121cf7
CL
978
979 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
980 ntohl(xid));
3705ad64 981 trace_xprt_lookup_rqst(xprt, xid, -ENOENT);
262ca07d
CL
982 xprt->stat.bad_xids++;
983 return NULL;
1da177e4 984}
12444809 985EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
1da177e4 986
cf9946cd
TM
987static bool
988xprt_is_pinned_rqst(struct rpc_rqst *req)
989{
990 return atomic_read(&req->rq_pin) != 0;
991}
992
729749bb
TM
993/**
994 * xprt_pin_rqst - Pin a request on the transport receive list
995 * @req: Request to pin
996 *
997 * Caller must ensure this is atomic with the call to xprt_lookup_rqst()
1f7d1c73 998 * so should be holding xprt->queue_lock.
729749bb
TM
999 */
1000void xprt_pin_rqst(struct rpc_rqst *req)
1001{
cf9946cd 1002 atomic_inc(&req->rq_pin);
729749bb 1003}
9590d083 1004EXPORT_SYMBOL_GPL(xprt_pin_rqst);
729749bb
TM
1005
1006/**
1007 * xprt_unpin_rqst - Unpin a request on the transport receive list
1008 * @req: Request to pin
1009 *
1f7d1c73 1010 * Caller should be holding xprt->queue_lock.
729749bb
TM
1011 */
1012void xprt_unpin_rqst(struct rpc_rqst *req)
1013{
cf9946cd
TM
1014 if (!test_bit(RPC_TASK_MSG_PIN_WAIT, &req->rq_task->tk_runstate)) {
1015 atomic_dec(&req->rq_pin);
1016 return;
1017 }
1018 if (atomic_dec_and_test(&req->rq_pin))
1019 wake_up_var(&req->rq_pin);
729749bb 1020}
9590d083 1021EXPORT_SYMBOL_GPL(xprt_unpin_rqst);
729749bb
TM
1022
1023static void xprt_wait_on_pinned_rqst(struct rpc_rqst *req)
729749bb 1024{
cf9946cd 1025 wait_var_event(&req->rq_pin, !xprt_is_pinned_rqst(req));
729749bb
TM
1026}
1027
edc81dcd
TM
1028static bool
1029xprt_request_data_received(struct rpc_task *task)
1030{
1031 return !test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate) &&
1032 READ_ONCE(task->tk_rqstp->rq_reply_bytes_recvd) != 0;
1033}
1034
1035static bool
1036xprt_request_need_enqueue_receive(struct rpc_task *task, struct rpc_rqst *req)
1037{
1038 return !test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate) &&
1039 READ_ONCE(task->tk_rqstp->rq_reply_bytes_recvd) == 0;
1040}
1041
1042/**
1043 * xprt_request_enqueue_receive - Add an request to the receive queue
1044 * @task: RPC task
1045 *
1046 */
1047void
1048xprt_request_enqueue_receive(struct rpc_task *task)
1049{
1050 struct rpc_rqst *req = task->tk_rqstp;
1051 struct rpc_xprt *xprt = req->rq_xprt;
1052
1053 if (!xprt_request_need_enqueue_receive(task, req))
1054 return;
75369089
TM
1055
1056 xprt_request_prepare(task->tk_rqstp);
edc81dcd
TM
1057 spin_lock(&xprt->queue_lock);
1058
1059 /* Update the softirq receive buffer */
1060 memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
1061 sizeof(req->rq_private_buf));
1062
1063 /* Add request to the receive list */
95f7691d 1064 xprt_request_rb_insert(xprt, req);
edc81dcd
TM
1065 set_bit(RPC_TASK_NEED_RECV, &task->tk_runstate);
1066 spin_unlock(&xprt->queue_lock);
1067
edc81dcd
TM
1068 /* Turn off autodisconnect */
1069 del_singleshot_timer_sync(&xprt->timer);
1070}
1071
1072/**
1073 * xprt_request_dequeue_receive_locked - Remove a request from the receive queue
1074 * @task: RPC task
1075 *
1076 * Caller must hold xprt->queue_lock.
1077 */
1078static void
1079xprt_request_dequeue_receive_locked(struct rpc_task *task)
1080{
95f7691d
TM
1081 struct rpc_rqst *req = task->tk_rqstp;
1082
edc81dcd 1083 if (test_and_clear_bit(RPC_TASK_NEED_RECV, &task->tk_runstate))
95f7691d 1084 xprt_request_rb_remove(req->rq_xprt, req);
edc81dcd
TM
1085}
1086
ecd465ee
CL
1087/**
1088 * xprt_update_rtt - Update RPC RTT statistics
1089 * @task: RPC request that recently completed
1090 *
75c84151 1091 * Caller holds xprt->queue_lock.
ecd465ee
CL
1092 */
1093void xprt_update_rtt(struct rpc_task *task)
1570c1e4
CL
1094{
1095 struct rpc_rqst *req = task->tk_rqstp;
1096 struct rpc_rtt *rtt = task->tk_client->cl_rtt;
95c96174 1097 unsigned int timer = task->tk_msg.rpc_proc->p_timer;
d60dbb20 1098 long m = usecs_to_jiffies(ktime_to_us(req->rq_rtt));
1570c1e4
CL
1099
1100 if (timer) {
1101 if (req->rq_ntrans == 1)
ff839970 1102 rpc_update_rtt(rtt, timer, m);
1570c1e4
CL
1103 rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
1104 }
1105}
ecd465ee 1106EXPORT_SYMBOL_GPL(xprt_update_rtt);
1570c1e4 1107
9903cd1c
CL
1108/**
1109 * xprt_complete_rqst - called when reply processing is complete
1570c1e4 1110 * @task: RPC request that recently completed
9903cd1c
CL
1111 * @copied: actual number of bytes received from the transport
1112 *
75c84151 1113 * Caller holds xprt->queue_lock.
1da177e4 1114 */
1570c1e4 1115void xprt_complete_rqst(struct rpc_task *task, int copied)
1da177e4 1116{
1570c1e4 1117 struct rpc_rqst *req = task->tk_rqstp;
fda13939 1118 struct rpc_xprt *xprt = req->rq_xprt;
1da177e4 1119
1570c1e4
CL
1120 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
1121 task->tk_pid, ntohl(req->rq_xid), copied);
3705ad64 1122 trace_xprt_complete_rqst(xprt, req->rq_xid, copied);
1da177e4 1123
fda13939 1124 xprt->stat.recvs++;
ef759a2e 1125
1e799b67 1126 req->rq_private_buf.len = copied;
dd2b63d0
RL
1127 /* Ensure all writes are done before we update */
1128 /* req->rq_reply_bytes_recvd */
43ac3f29 1129 smp_wmb();
dd2b63d0 1130 req->rq_reply_bytes_recvd = copied;
edc81dcd 1131 xprt_request_dequeue_receive_locked(task);
fda13939 1132 rpc_wake_up_queued_task(&xprt->pending, task);
1da177e4 1133}
12444809 1134EXPORT_SYMBOL_GPL(xprt_complete_rqst);
1da177e4 1135
46c0ee8b 1136static void xprt_timer(struct rpc_task *task)
1da177e4 1137{
46c0ee8b 1138 struct rpc_rqst *req = task->tk_rqstp;
1da177e4
LT
1139 struct rpc_xprt *xprt = req->rq_xprt;
1140
5d00837b
TM
1141 if (task->tk_status != -ETIMEDOUT)
1142 return;
1da177e4 1143
82476d9f 1144 trace_xprt_timer(xprt, req->rq_xid, task->tk_status);
dd2b63d0 1145 if (!req->rq_reply_bytes_recvd) {
46c0ee8b 1146 if (xprt->ops->timer)
6a24dfb6 1147 xprt->ops->timer(xprt, task);
5d00837b
TM
1148 } else
1149 task->tk_status = 0;
1da177e4
LT
1150}
1151
8ba6a92d
TM
1152/**
1153 * xprt_wait_for_reply_request_def - wait for reply
1154 * @task: pointer to rpc_task
1155 *
1156 * Set a request's retransmit timeout based on the transport's
1157 * default timeout parameters. Used by transports that don't adjust
1158 * the retransmit timeout based on round-trip time estimation,
1159 * and put the task to sleep on the pending queue.
1160 */
1161void xprt_wait_for_reply_request_def(struct rpc_task *task)
1162{
1163 struct rpc_rqst *req = task->tk_rqstp;
1164
6b2e6856 1165 rpc_sleep_on_timeout(&req->rq_xprt->pending, task, xprt_timer,
9e910bff 1166 xprt_request_timeout(req));
8ba6a92d
TM
1167}
1168EXPORT_SYMBOL_GPL(xprt_wait_for_reply_request_def);
1169
1170/**
1171 * xprt_wait_for_reply_request_rtt - wait for reply using RTT estimator
1172 * @task: pointer to rpc_task
1173 *
1174 * Set a request's retransmit timeout using the RTT estimator,
1175 * and put the task to sleep on the pending queue.
1176 */
1177void xprt_wait_for_reply_request_rtt(struct rpc_task *task)
1178{
1179 int timer = task->tk_msg.rpc_proc->p_timer;
1180 struct rpc_clnt *clnt = task->tk_client;
1181 struct rpc_rtt *rtt = clnt->cl_rtt;
1182 struct rpc_rqst *req = task->tk_rqstp;
1183 unsigned long max_timeout = clnt->cl_timeout->to_maxval;
6b2e6856 1184 unsigned long timeout;
8ba6a92d 1185
6b2e6856
TM
1186 timeout = rpc_calc_rto(rtt, timer);
1187 timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
1188 if (timeout > max_timeout || timeout == 0)
1189 timeout = max_timeout;
1190 rpc_sleep_on_timeout(&req->rq_xprt->pending, task, xprt_timer,
1191 jiffies + timeout);
8ba6a92d
TM
1192}
1193EXPORT_SYMBOL_GPL(xprt_wait_for_reply_request_rtt);
1194
7f3a1d1e
TM
1195/**
1196 * xprt_request_wait_receive - wait for the reply to an RPC request
1197 * @task: RPC task about to send a request
1198 *
1199 */
1200void xprt_request_wait_receive(struct rpc_task *task)
1201{
1202 struct rpc_rqst *req = task->tk_rqstp;
1203 struct rpc_xprt *xprt = req->rq_xprt;
1204
1205 if (!test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate))
1206 return;
1207 /*
1208 * Sleep on the pending queue if we're expecting a reply.
1209 * The spinlock ensures atomicity between the test of
1210 * req->rq_reply_bytes_recvd, and the call to rpc_sleep_on().
1211 */
1212 spin_lock(&xprt->queue_lock);
1213 if (test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate)) {
8ba6a92d 1214 xprt->ops->wait_for_reply_request(task);
7f3a1d1e
TM
1215 /*
1216 * Send an extra queue wakeup call if the
1217 * connection was dropped in case the call to
1218 * rpc_sleep_on() raced.
1219 */
1220 if (xprt_request_retransmit_after_disconnect(task))
1221 rpc_wake_up_queued_task_set_status(&xprt->pending,
1222 task, -ENOTCONN);
1223 }
1224 spin_unlock(&xprt->queue_lock);
1225}
1226
944b0429
TM
1227static bool
1228xprt_request_need_enqueue_transmit(struct rpc_task *task, struct rpc_rqst *req)
1229{
762e4e67 1230 return !test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate);
944b0429
TM
1231}
1232
1233/**
1234 * xprt_request_enqueue_transmit - queue a task for transmission
1235 * @task: pointer to rpc_task
1236 *
1237 * Add a task to the transmission queue.
1238 */
1239void
1240xprt_request_enqueue_transmit(struct rpc_task *task)
1241{
918f3c1f 1242 struct rpc_rqst *pos, *req = task->tk_rqstp;
944b0429
TM
1243 struct rpc_xprt *xprt = req->rq_xprt;
1244
1245 if (xprt_request_need_enqueue_transmit(task, req)) {
e66721f0 1246 req->rq_bytes_sent = 0;
944b0429 1247 spin_lock(&xprt->queue_lock);
75891f50
TM
1248 /*
1249 * Requests that carry congestion control credits are added
1250 * to the head of the list to avoid starvation issues.
1251 */
1252 if (req->rq_cong) {
1253 xprt_clear_congestion_window_wait(xprt);
1254 list_for_each_entry(pos, &xprt->xmit_queue, rq_xmit) {
1255 if (pos->rq_cong)
1256 continue;
1257 /* Note: req is added _before_ pos */
1258 list_add_tail(&req->rq_xmit, &pos->rq_xmit);
1259 INIT_LIST_HEAD(&req->rq_xmit2);
0c77668d 1260 trace_xprt_enq_xmit(task, 1);
75891f50
TM
1261 goto out;
1262 }
86aeee0e
TM
1263 } else if (RPC_IS_SWAPPER(task)) {
1264 list_for_each_entry(pos, &xprt->xmit_queue, rq_xmit) {
1265 if (pos->rq_cong || pos->rq_bytes_sent)
1266 continue;
1267 if (RPC_IS_SWAPPER(pos->rq_task))
1268 continue;
1269 /* Note: req is added _before_ pos */
1270 list_add_tail(&req->rq_xmit, &pos->rq_xmit);
1271 INIT_LIST_HEAD(&req->rq_xmit2);
0c77668d 1272 trace_xprt_enq_xmit(task, 2);
86aeee0e
TM
1273 goto out;
1274 }
deaa5c96 1275 } else if (!req->rq_seqno) {
75891f50
TM
1276 list_for_each_entry(pos, &xprt->xmit_queue, rq_xmit) {
1277 if (pos->rq_task->tk_owner != task->tk_owner)
1278 continue;
1279 list_add_tail(&req->rq_xmit2, &pos->rq_xmit2);
1280 INIT_LIST_HEAD(&req->rq_xmit);
0c77668d 1281 trace_xprt_enq_xmit(task, 3);
75891f50
TM
1282 goto out;
1283 }
918f3c1f 1284 }
944b0429 1285 list_add_tail(&req->rq_xmit, &xprt->xmit_queue);
918f3c1f 1286 INIT_LIST_HEAD(&req->rq_xmit2);
0c77668d 1287 trace_xprt_enq_xmit(task, 4);
918f3c1f 1288out:
944b0429
TM
1289 set_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate);
1290 spin_unlock(&xprt->queue_lock);
1291 }
1292}
1293
1294/**
1295 * xprt_request_dequeue_transmit_locked - remove a task from the transmission queue
1296 * @task: pointer to rpc_task
1297 *
1298 * Remove a task from the transmission queue
1299 * Caller must hold xprt->queue_lock
1300 */
1301static void
1302xprt_request_dequeue_transmit_locked(struct rpc_task *task)
1303{
918f3c1f
TM
1304 struct rpc_rqst *req = task->tk_rqstp;
1305
1306 if (!test_and_clear_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
1307 return;
1308 if (!list_empty(&req->rq_xmit)) {
1309 list_del(&req->rq_xmit);
1310 if (!list_empty(&req->rq_xmit2)) {
1311 struct rpc_rqst *next = list_first_entry(&req->rq_xmit2,
1312 struct rpc_rqst, rq_xmit2);
1313 list_del(&req->rq_xmit2);
1314 list_add_tail(&next->rq_xmit, &next->rq_xprt->xmit_queue);
1315 }
1316 } else
1317 list_del(&req->rq_xmit2);
944b0429
TM
1318}
1319
1320/**
1321 * xprt_request_dequeue_transmit - remove a task from the transmission queue
1322 * @task: pointer to rpc_task
1323 *
1324 * Remove a task from the transmission queue
1325 */
1326static void
1327xprt_request_dequeue_transmit(struct rpc_task *task)
1328{
1329 struct rpc_rqst *req = task->tk_rqstp;
1330 struct rpc_xprt *xprt = req->rq_xprt;
1331
1332 spin_lock(&xprt->queue_lock);
1333 xprt_request_dequeue_transmit_locked(task);
1334 spin_unlock(&xprt->queue_lock);
1335}
1336
cc204d01
TM
1337/**
1338 * xprt_request_dequeue_xprt - remove a task from the transmit+receive queue
1339 * @task: pointer to rpc_task
1340 *
1341 * Remove a task from the transmit and receive queues, and ensure that
1342 * it is not pinned by the receive work item.
1343 */
1344void
1345xprt_request_dequeue_xprt(struct rpc_task *task)
1346{
1347 struct rpc_rqst *req = task->tk_rqstp;
1348 struct rpc_xprt *xprt = req->rq_xprt;
1349
1350 if (test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate) ||
1351 test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate) ||
1352 xprt_is_pinned_rqst(req)) {
1353 spin_lock(&xprt->queue_lock);
1354 xprt_request_dequeue_transmit_locked(task);
1355 xprt_request_dequeue_receive_locked(task);
1356 while (xprt_is_pinned_rqst(req)) {
1357 set_bit(RPC_TASK_MSG_PIN_WAIT, &task->tk_runstate);
1358 spin_unlock(&xprt->queue_lock);
1359 xprt_wait_on_pinned_rqst(req);
1360 spin_lock(&xprt->queue_lock);
1361 clear_bit(RPC_TASK_MSG_PIN_WAIT, &task->tk_runstate);
1362 }
1363 spin_unlock(&xprt->queue_lock);
1364 }
1365}
1366
9d96acbc
TM
1367/**
1368 * xprt_request_prepare - prepare an encoded request for transport
1369 * @req: pointer to rpc_rqst
1370 *
1371 * Calls into the transport layer to do whatever is needed to prepare
1372 * the request for transmission or receive.
1373 */
1374void
1375xprt_request_prepare(struct rpc_rqst *req)
1376{
1377 struct rpc_xprt *xprt = req->rq_xprt;
1378
1379 if (xprt->ops->prepare_request)
1380 xprt->ops->prepare_request(req);
1381}
1382
762e4e67
TM
1383/**
1384 * xprt_request_need_retransmit - Test if a task needs retransmission
1385 * @task: pointer to rpc_task
1386 *
1387 * Test for whether a connection breakage requires the task to retransmit
1388 */
1389bool
1390xprt_request_need_retransmit(struct rpc_task *task)
1391{
1392 return xprt_request_retransmit_after_disconnect(task);
1393}
1394
9903cd1c
CL
1395/**
1396 * xprt_prepare_transmit - reserve the transport before sending a request
1397 * @task: RPC task about to send a request
1398 *
1da177e4 1399 */
90051ea7 1400bool xprt_prepare_transmit(struct rpc_task *task)
1da177e4
LT
1401{
1402 struct rpc_rqst *req = task->tk_rqstp;
1403 struct rpc_xprt *xprt = req->rq_xprt;
1da177e4 1404
46121cf7 1405 dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
1da177e4 1406
5f2f6bd9
TM
1407 if (!xprt_lock_write(xprt, task)) {
1408 /* Race breaker: someone may have transmitted us */
944b0429 1409 if (!test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
5f2f6bd9
TM
1410 rpc_wake_up_queued_task_set_status(&xprt->sending,
1411 task, 0);
1412 return false;
1413
90051ea7 1414 }
5f2f6bd9 1415 return true;
1da177e4
LT
1416}
1417
e0ab53de 1418void xprt_end_transmit(struct rpc_task *task)
5e5ce5be 1419{
343952fa 1420 xprt_release_write(task->tk_rqstp->rq_xprt, task);
5e5ce5be
TM
1421}
1422
9903cd1c 1423/**
89f90fe1
TM
1424 * xprt_request_transmit - send an RPC request on a transport
1425 * @req: pointer to request to transmit
1426 * @snd_task: RPC task that owns the transport lock
9903cd1c 1427 *
89f90fe1
TM
1428 * This performs the transmission of a single request.
1429 * Note that if the request is not the same as snd_task, then it
1430 * does need to be pinned.
1431 * Returns '0' on success.
9903cd1c 1432 */
89f90fe1
TM
1433static int
1434xprt_request_transmit(struct rpc_rqst *req, struct rpc_task *snd_task)
1da177e4 1435{
89f90fe1
TM
1436 struct rpc_xprt *xprt = req->rq_xprt;
1437 struct rpc_task *task = req->rq_task;
90d91b0c 1438 unsigned int connect_cookie;
dcbbeda8 1439 int is_retrans = RPC_WAS_SENT(task);
ff699ea8 1440 int status;
1da177e4 1441
edc81dcd 1442 if (!req->rq_bytes_sent) {
89f90fe1
TM
1443 if (xprt_request_data_received(task)) {
1444 status = 0;
944b0429 1445 goto out_dequeue;
89f90fe1 1446 }
3021a5bb 1447 /* Verify that our message lies in the RPCSEC_GSS window */
edc81dcd 1448 if (rpcauth_xmit_need_reencode(task)) {
89f90fe1 1449 status = -EBADMSG;
944b0429 1450 goto out_dequeue;
a79f194a 1451 }
ae67bd38
TM
1452 if (RPC_SIGNALLED(task)) {
1453 status = -ERESTARTSYS;
1454 goto out_dequeue;
3021a5bb 1455 }
edc81dcd 1456 }
1da177e4 1457
dcbbeda8
TM
1458 /*
1459 * Update req->rq_ntrans before transmitting to avoid races with
1460 * xprt_update_rtt(), which needs to know that it is recording a
1461 * reply to the first transmission.
1462 */
1463 req->rq_ntrans++;
1464
90d91b0c 1465 connect_cookie = xprt->connect_cookie;
adfa7144 1466 status = xprt->ops->send_request(req);
c8485e4d 1467 if (status != 0) {
dcbbeda8 1468 req->rq_ntrans--;
0c77668d 1469 trace_xprt_transmit(req, status);
89f90fe1 1470 return status;
c8485e4d 1471 }
7ebbbc6e 1472
dcbbeda8
TM
1473 if (is_retrans)
1474 task->tk_client->cl_stats->rpcretrans++;
1475
4a068258 1476 xprt_inject_disconnect(xprt);
262ca07d 1477
468f8613 1478 task->tk_flags |= RPC_TASK_SENT;
b5e92419 1479 spin_lock(&xprt->transport_lock);
262ca07d 1480
c8485e4d
TM
1481 xprt->stat.sends++;
1482 xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
1483 xprt->stat.bklog_u += xprt->backlog.qlen;
15a45206
AA
1484 xprt->stat.sending_u += xprt->sending.qlen;
1485 xprt->stat.pending_u += xprt->pending.qlen;
b5e92419 1486 spin_unlock(&xprt->transport_lock);
1da177e4 1487
90d91b0c 1488 req->rq_connect_cookie = connect_cookie;
944b0429 1489out_dequeue:
0c77668d 1490 trace_xprt_transmit(req, status);
944b0429 1491 xprt_request_dequeue_transmit(task);
89f90fe1
TM
1492 rpc_wake_up_queued_task_set_status(&xprt->sending, task, status);
1493 return status;
1494}
1495
1496/**
1497 * xprt_transmit - send an RPC request on a transport
1498 * @task: controlling RPC task
1499 *
1500 * Attempts to drain the transmit queue. On exit, either the transport
1501 * signalled an error that needs to be handled before transmission can
1502 * resume, or @task finished transmitting, and detected that it already
1503 * received a reply.
1504 */
1505void
1506xprt_transmit(struct rpc_task *task)
1507{
1508 struct rpc_rqst *next, *req = task->tk_rqstp;
1509 struct rpc_xprt *xprt = req->rq_xprt;
1510 int status;
1511
1512 spin_lock(&xprt->queue_lock);
1513 while (!list_empty(&xprt->xmit_queue)) {
1514 next = list_first_entry(&xprt->xmit_queue,
1515 struct rpc_rqst, rq_xmit);
1516 xprt_pin_rqst(next);
1517 spin_unlock(&xprt->queue_lock);
1518 status = xprt_request_transmit(next, task);
1519 if (status == -EBADMSG && next != req)
1520 status = 0;
1521 cond_resched();
1522 spin_lock(&xprt->queue_lock);
1523 xprt_unpin_rqst(next);
1524 if (status == 0) {
1525 if (!xprt_request_data_received(task) ||
1526 test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
1527 continue;
c544577d 1528 } else if (test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
89f90fe1
TM
1529 task->tk_status = status;
1530 break;
1531 }
1532 spin_unlock(&xprt->queue_lock);
1da177e4
LT
1533}
1534
ba60eb25
TM
1535static void xprt_add_backlog(struct rpc_xprt *xprt, struct rpc_task *task)
1536{
1537 set_bit(XPRT_CONGESTED, &xprt->state);
1538 rpc_sleep_on(&xprt->backlog, task, NULL);
1539}
1540
1541static void xprt_wake_up_backlog(struct rpc_xprt *xprt)
1542{
1543 if (rpc_wake_up_next(&xprt->backlog) == NULL)
1544 clear_bit(XPRT_CONGESTED, &xprt->state);
1545}
1546
1547static bool xprt_throttle_congested(struct rpc_xprt *xprt, struct rpc_task *task)
1548{
1549 bool ret = false;
1550
1551 if (!test_bit(XPRT_CONGESTED, &xprt->state))
1552 goto out;
1553 spin_lock(&xprt->reserve_lock);
1554 if (test_bit(XPRT_CONGESTED, &xprt->state)) {
1555 rpc_sleep_on(&xprt->backlog, task, NULL);
1556 ret = true;
1557 }
1558 spin_unlock(&xprt->reserve_lock);
1559out:
1560 return ret;
1561}
1562
92ea011f 1563static struct rpc_rqst *xprt_dynamic_alloc_slot(struct rpc_xprt *xprt)
d9ba131d
TM
1564{
1565 struct rpc_rqst *req = ERR_PTR(-EAGAIN);
1566
ff699ea8 1567 if (xprt->num_reqs >= xprt->max_reqs)
d9ba131d 1568 goto out;
ff699ea8 1569 ++xprt->num_reqs;
92ea011f
TM
1570 spin_unlock(&xprt->reserve_lock);
1571 req = kzalloc(sizeof(struct rpc_rqst), GFP_NOFS);
1572 spin_lock(&xprt->reserve_lock);
d9ba131d
TM
1573 if (req != NULL)
1574 goto out;
ff699ea8 1575 --xprt->num_reqs;
d9ba131d
TM
1576 req = ERR_PTR(-ENOMEM);
1577out:
1578 return req;
1579}
1580
1581static bool xprt_dynamic_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1582{
ff699ea8
CL
1583 if (xprt->num_reqs > xprt->min_reqs) {
1584 --xprt->num_reqs;
d9ba131d
TM
1585 kfree(req);
1586 return true;
1587 }
1588 return false;
1589}
1590
f39c1bfb 1591void xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4 1592{
d9ba131d 1593 struct rpc_rqst *req;
1da177e4 1594
f39c1bfb 1595 spin_lock(&xprt->reserve_lock);
1da177e4 1596 if (!list_empty(&xprt->free)) {
d9ba131d
TM
1597 req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
1598 list_del(&req->rq_list);
1599 goto out_init_req;
1600 }
92ea011f 1601 req = xprt_dynamic_alloc_slot(xprt);
d9ba131d
TM
1602 if (!IS_ERR(req))
1603 goto out_init_req;
1604 switch (PTR_ERR(req)) {
1605 case -ENOMEM:
d9ba131d
TM
1606 dprintk("RPC: dynamic allocation of request slot "
1607 "failed! Retrying\n");
1afeaf5c 1608 task->tk_status = -ENOMEM;
d9ba131d
TM
1609 break;
1610 case -EAGAIN:
ba60eb25 1611 xprt_add_backlog(xprt, task);
d9ba131d 1612 dprintk("RPC: waiting for request slot\n");
e9d47639 1613 /* fall through */
1afeaf5c
TM
1614 default:
1615 task->tk_status = -EAGAIN;
1da177e4 1616 }
f39c1bfb 1617 spin_unlock(&xprt->reserve_lock);
d9ba131d
TM
1618 return;
1619out_init_req:
ff699ea8
CL
1620 xprt->stat.max_slots = max_t(unsigned int, xprt->stat.max_slots,
1621 xprt->num_reqs);
37ac86c3
CL
1622 spin_unlock(&xprt->reserve_lock);
1623
d9ba131d
TM
1624 task->tk_status = 0;
1625 task->tk_rqstp = req;
f39c1bfb
TM
1626}
1627EXPORT_SYMBOL_GPL(xprt_alloc_slot);
1628
a9cde23a 1629void xprt_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
ee5ebe85 1630{
ee5ebe85 1631 spin_lock(&xprt->reserve_lock);
c25573b5
TM
1632 if (!xprt_dynamic_free_slot(xprt, req)) {
1633 memset(req, 0, sizeof(*req)); /* mark unused */
1634 list_add(&req->rq_list, &xprt->free);
1635 }
ba60eb25 1636 xprt_wake_up_backlog(xprt);
ee5ebe85
TM
1637 spin_unlock(&xprt->reserve_lock);
1638}
a9cde23a 1639EXPORT_SYMBOL_GPL(xprt_free_slot);
ee5ebe85 1640
21de0a95
TM
1641static void xprt_free_all_slots(struct rpc_xprt *xprt)
1642{
1643 struct rpc_rqst *req;
1644 while (!list_empty(&xprt->free)) {
1645 req = list_first_entry(&xprt->free, struct rpc_rqst, rq_list);
1646 list_del(&req->rq_list);
1647 kfree(req);
1648 }
1649}
1650
d9ba131d
TM
1651struct rpc_xprt *xprt_alloc(struct net *net, size_t size,
1652 unsigned int num_prealloc,
1653 unsigned int max_alloc)
bd1722d4
PE
1654{
1655 struct rpc_xprt *xprt;
21de0a95
TM
1656 struct rpc_rqst *req;
1657 int i;
bd1722d4
PE
1658
1659 xprt = kzalloc(size, GFP_KERNEL);
1660 if (xprt == NULL)
1661 goto out;
1662
21de0a95
TM
1663 xprt_init(xprt, net);
1664
1665 for (i = 0; i < num_prealloc; i++) {
1666 req = kzalloc(sizeof(struct rpc_rqst), GFP_KERNEL);
1667 if (!req)
8313164c 1668 goto out_free;
21de0a95
TM
1669 list_add(&req->rq_list, &xprt->free);
1670 }
d9ba131d
TM
1671 if (max_alloc > num_prealloc)
1672 xprt->max_reqs = max_alloc;
1673 else
1674 xprt->max_reqs = num_prealloc;
1675 xprt->min_reqs = num_prealloc;
ff699ea8 1676 xprt->num_reqs = num_prealloc;
bd1722d4
PE
1677
1678 return xprt;
1679
1680out_free:
21de0a95 1681 xprt_free(xprt);
bd1722d4
PE
1682out:
1683 return NULL;
1684}
1685EXPORT_SYMBOL_GPL(xprt_alloc);
1686
e204e621
PE
1687void xprt_free(struct rpc_xprt *xprt)
1688{
37aa2133 1689 put_net(xprt->xprt_net);
21de0a95 1690 xprt_free_all_slots(xprt);
fda1bfef 1691 kfree_rcu(xprt, rcu);
e204e621
PE
1692}
1693EXPORT_SYMBOL_GPL(xprt_free);
1694
902c5887
TM
1695static void
1696xprt_init_connect_cookie(struct rpc_rqst *req, struct rpc_xprt *xprt)
1697{
1698 req->rq_connect_cookie = xprt_connect_cookie(xprt) - 1;
1699}
1700
9dc6edcf
TM
1701static __be32
1702xprt_alloc_xid(struct rpc_xprt *xprt)
1703{
1704 __be32 xid;
1705
1706 spin_lock(&xprt->reserve_lock);
1707 xid = (__force __be32)xprt->xid++;
1708 spin_unlock(&xprt->reserve_lock);
1709 return xid;
1710}
1711
1712static void
1713xprt_init_xid(struct rpc_xprt *xprt)
1714{
1715 xprt->xid = prandom_u32();
1716}
1717
1718static void
1719xprt_request_init(struct rpc_task *task)
1720{
1721 struct rpc_xprt *xprt = task->tk_xprt;
1722 struct rpc_rqst *req = task->tk_rqstp;
1723
9dc6edcf
TM
1724 req->rq_task = task;
1725 req->rq_xprt = xprt;
1726 req->rq_buffer = NULL;
1727 req->rq_xid = xprt_alloc_xid(xprt);
902c5887 1728 xprt_init_connect_cookie(req, xprt);
9dc6edcf
TM
1729 req->rq_snd_buf.len = 0;
1730 req->rq_snd_buf.buflen = 0;
1731 req->rq_rcv_buf.len = 0;
1732 req->rq_rcv_buf.buflen = 0;
71700bb9
TM
1733 req->rq_snd_buf.bvec = NULL;
1734 req->rq_rcv_buf.bvec = NULL;
9dc6edcf 1735 req->rq_release_snd_buf = NULL;
da953063 1736 xprt_init_majortimeo(task, req);
9dc6edcf
TM
1737 dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
1738 req, ntohl(req->rq_xid));
1739}
1740
1741static void
1742xprt_do_reserve(struct rpc_xprt *xprt, struct rpc_task *task)
1743{
1744 xprt->ops->alloc_slot(xprt, task);
1745 if (task->tk_rqstp != NULL)
1746 xprt_request_init(task);
1747}
1748
9903cd1c
CL
1749/**
1750 * xprt_reserve - allocate an RPC request slot
1751 * @task: RPC task requesting a slot allocation
1752 *
ba60eb25
TM
1753 * If the transport is marked as being congested, or if no more
1754 * slots are available, place the task on the transport's
9903cd1c
CL
1755 * backlog queue.
1756 */
1757void xprt_reserve(struct rpc_task *task)
1da177e4 1758{
fb43d172 1759 struct rpc_xprt *xprt = task->tk_xprt;
1da177e4 1760
43cedbf0
TM
1761 task->tk_status = 0;
1762 if (task->tk_rqstp != NULL)
1763 return;
1764
43cedbf0 1765 task->tk_status = -EAGAIN;
ba60eb25 1766 if (!xprt_throttle_congested(xprt, task))
9dc6edcf 1767 xprt_do_reserve(xprt, task);
ba60eb25
TM
1768}
1769
1770/**
1771 * xprt_retry_reserve - allocate an RPC request slot
1772 * @task: RPC task requesting a slot allocation
1773 *
1774 * If no more slots are available, place the task on the transport's
1775 * backlog queue.
1776 * Note that the only difference with xprt_reserve is that we now
1777 * ignore the value of the XPRT_CONGESTED flag.
1778 */
1779void xprt_retry_reserve(struct rpc_task *task)
1780{
fb43d172 1781 struct rpc_xprt *xprt = task->tk_xprt;
ba60eb25
TM
1782
1783 task->tk_status = 0;
1784 if (task->tk_rqstp != NULL)
1785 return;
1786
ba60eb25 1787 task->tk_status = -EAGAIN;
9dc6edcf 1788 xprt_do_reserve(xprt, task);
1da177e4
LT
1789}
1790
9903cd1c
CL
1791/**
1792 * xprt_release - release an RPC request slot
1793 * @task: task which is finished with the slot
1794 *
1da177e4 1795 */
9903cd1c 1796void xprt_release(struct rpc_task *task)
1da177e4 1797{
55ae1aab 1798 struct rpc_xprt *xprt;
87ed5003 1799 struct rpc_rqst *req = task->tk_rqstp;
1da177e4 1800
87ed5003
TM
1801 if (req == NULL) {
1802 if (task->tk_client) {
fb43d172 1803 xprt = task->tk_xprt;
bd79bc57 1804 xprt_release_write(xprt, task);
87ed5003 1805 }
1da177e4 1806 return;
87ed5003 1807 }
55ae1aab 1808
55ae1aab 1809 xprt = req->rq_xprt;
cc204d01 1810 xprt_request_dequeue_xprt(task);
b5e92419 1811 spin_lock(&xprt->transport_lock);
49e9a890 1812 xprt->ops->release_xprt(xprt, task);
a58dd398
CL
1813 if (xprt->ops->release_request)
1814 xprt->ops->release_request(task);
ad3331ac 1815 xprt_schedule_autodisconnect(xprt);
b5e92419 1816 spin_unlock(&xprt->transport_lock);
ee5ebe85 1817 if (req->rq_buffer)
3435c74a 1818 xprt->ops->buf_free(task);
4a068258 1819 xprt_inject_disconnect(xprt);
9d96acbc 1820 xdr_free_bvec(&req->rq_rcv_buf);
0472e476 1821 xdr_free_bvec(&req->rq_snd_buf);
a17c2153
TM
1822 if (req->rq_cred != NULL)
1823 put_rpccred(req->rq_cred);
1da177e4 1824 task->tk_rqstp = NULL;
ead5e1c2
BF
1825 if (req->rq_release_snd_buf)
1826 req->rq_release_snd_buf(req);
55ae1aab 1827
46121cf7 1828 dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
ee5ebe85 1829 if (likely(!bc_prealloc(req)))
a9cde23a 1830 xprt->ops->free_slot(xprt, req);
ee5ebe85 1831 else
c9acb42e 1832 xprt_free_bc_request(req);
1da177e4
LT
1833}
1834
902c5887
TM
1835#ifdef CONFIG_SUNRPC_BACKCHANNEL
1836void
1837xprt_init_bc_request(struct rpc_rqst *req, struct rpc_task *task)
1838{
1839 struct xdr_buf *xbufp = &req->rq_snd_buf;
1840
1841 task->tk_rqstp = req;
1842 req->rq_task = task;
1843 xprt_init_connect_cookie(req, req->rq_xprt);
1844 /*
1845 * Set up the xdr_buf length.
1846 * This also indicates that the buffer is XDR encoded already.
1847 */
1848 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1849 xbufp->tail[0].iov_len;
902c5887
TM
1850}
1851#endif
1852
21de0a95 1853static void xprt_init(struct rpc_xprt *xprt, struct net *net)
c2866763 1854{
30c5116b 1855 kref_init(&xprt->kref);
c2866763
CL
1856
1857 spin_lock_init(&xprt->transport_lock);
1858 spin_lock_init(&xprt->reserve_lock);
75c84151 1859 spin_lock_init(&xprt->queue_lock);
c2866763
CL
1860
1861 INIT_LIST_HEAD(&xprt->free);
95f7691d 1862 xprt->recv_queue = RB_ROOT;
944b0429 1863 INIT_LIST_HEAD(&xprt->xmit_queue);
9e00abc3 1864#if defined(CONFIG_SUNRPC_BACKCHANNEL)
f9acac1a
RL
1865 spin_lock_init(&xprt->bc_pa_lock);
1866 INIT_LIST_HEAD(&xprt->bc_pa_list);
9e00abc3 1867#endif /* CONFIG_SUNRPC_BACKCHANNEL */
80b14d5e 1868 INIT_LIST_HEAD(&xprt->xprt_switch);
f9acac1a 1869
c2866763
CL
1870 xprt->last_used = jiffies;
1871 xprt->cwnd = RPC_INITCWND;
a509050b 1872 xprt->bind_index = 0;
c2866763
CL
1873
1874 rpc_init_wait_queue(&xprt->binding, "xprt_binding");
1875 rpc_init_wait_queue(&xprt->pending, "xprt_pending");
79c99152 1876 rpc_init_wait_queue(&xprt->sending, "xprt_sending");
c2866763
CL
1877 rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
1878
c2866763
CL
1879 xprt_init_xid(xprt);
1880
21de0a95 1881 xprt->xprt_net = get_net(net);
8d9266ff
TM
1882}
1883
1884/**
1885 * xprt_create_transport - create an RPC transport
1886 * @args: rpc transport creation arguments
1887 *
1888 */
1889struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
1890{
1891 struct rpc_xprt *xprt;
1892 struct xprt_class *t;
1893
1894 spin_lock(&xprt_list_lock);
1895 list_for_each_entry(t, &xprt_list, list) {
1896 if (t->ident == args->ident) {
1897 spin_unlock(&xprt_list_lock);
1898 goto found;
1899 }
1900 }
1901 spin_unlock(&xprt_list_lock);
3c45ddf8 1902 dprintk("RPC: transport (%d) not supported\n", args->ident);
8d9266ff
TM
1903 return ERR_PTR(-EIO);
1904
1905found:
1906 xprt = t->setup(args);
1907 if (IS_ERR(xprt)) {
1908 dprintk("RPC: xprt_create_transport: failed, %ld\n",
1909 -PTR_ERR(xprt));
21de0a95 1910 goto out;
8d9266ff 1911 }
33d90ac0
BF
1912 if (args->flags & XPRT_CREATE_NO_IDLE_TIMEOUT)
1913 xprt->idle_timeout = 0;
21de0a95
TM
1914 INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
1915 if (xprt_has_timer(xprt))
502980e8 1916 timer_setup(&xprt->timer, xprt_init_autodisconnect, 0);
21de0a95 1917 else
ff861c4d 1918 timer_setup(&xprt->timer, NULL, 0);
4e0038b6
TM
1919
1920 if (strlen(args->servername) > RPC_MAXNETNAMELEN) {
1921 xprt_destroy(xprt);
1922 return ERR_PTR(-EINVAL);
1923 }
1924 xprt->servername = kstrdup(args->servername, GFP_KERNEL);
1925 if (xprt->servername == NULL) {
1926 xprt_destroy(xprt);
1927 return ERR_PTR(-ENOMEM);
1928 }
1929
3f940098 1930 rpc_xprt_debugfs_register(xprt);
388f0c77 1931
46121cf7 1932 dprintk("RPC: created transport %p with %u slots\n", xprt,
c2866763 1933 xprt->max_reqs);
21de0a95 1934out:
c2866763
CL
1935 return xprt;
1936}
1937
528fd354
TM
1938static void xprt_destroy_cb(struct work_struct *work)
1939{
1940 struct rpc_xprt *xprt =
1941 container_of(work, struct rpc_xprt, task_cleanup);
1942
1943 rpc_xprt_debugfs_unregister(xprt);
1944 rpc_destroy_wait_queue(&xprt->binding);
1945 rpc_destroy_wait_queue(&xprt->pending);
1946 rpc_destroy_wait_queue(&xprt->sending);
1947 rpc_destroy_wait_queue(&xprt->backlog);
1948 kfree(xprt->servername);
669996ad
TM
1949 /*
1950 * Destroy any existing back channel
1951 */
1952 xprt_destroy_backchannel(xprt, UINT_MAX);
1953
528fd354
TM
1954 /*
1955 * Tear down transport state and free the rpc_xprt
1956 */
1957 xprt->ops->destroy(xprt);
1958}
1959
9903cd1c
CL
1960/**
1961 * xprt_destroy - destroy an RPC transport, killing off all requests.
a8de240a 1962 * @xprt: transport to destroy
9903cd1c 1963 *
1da177e4 1964 */
a8de240a 1965static void xprt_destroy(struct rpc_xprt *xprt)
1da177e4 1966{
46121cf7 1967 dprintk("RPC: destroying transport %p\n", xprt);
79234c3d 1968
528fd354
TM
1969 /*
1970 * Exclude transport connect/disconnect handlers and autoclose
1971 */
79234c3d
TM
1972 wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_UNINTERRUPTIBLE);
1973
0065db32 1974 del_timer_sync(&xprt->timer);
c8541ecd
CL
1975
1976 /*
528fd354
TM
1977 * Destroy sockets etc from the system workqueue so they can
1978 * safely flush receive work running on rpciod.
c8541ecd 1979 */
528fd354
TM
1980 INIT_WORK(&xprt->task_cleanup, xprt_destroy_cb);
1981 schedule_work(&xprt->task_cleanup);
6b6ca86b 1982}
1da177e4 1983
30c5116b
TM
1984static void xprt_destroy_kref(struct kref *kref)
1985{
1986 xprt_destroy(container_of(kref, struct rpc_xprt, kref));
1987}
1988
1989/**
1990 * xprt_get - return a reference to an RPC transport.
1991 * @xprt: pointer to the transport
1992 *
1993 */
1994struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
1995{
1996 if (xprt != NULL && kref_get_unless_zero(&xprt->kref))
1997 return xprt;
1998 return NULL;
1999}
2000EXPORT_SYMBOL_GPL(xprt_get);
2001
6b6ca86b
TM
2002/**
2003 * xprt_put - release a reference to an RPC transport.
2004 * @xprt: pointer to the transport
2005 *
2006 */
2007void xprt_put(struct rpc_xprt *xprt)
2008{
30c5116b
TM
2009 if (xprt != NULL)
2010 kref_put(&xprt->kref, xprt_destroy_kref);
6b6ca86b 2011}
5d252f90 2012EXPORT_SYMBOL_GPL(xprt_put);