]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - net/sunrpc/xprt.c
ceph: avoid iput_final() while holding mutex or in dispatch thread
[mirror_ubuntu-bionic-kernel.git] / net / sunrpc / xprt.c
CommitLineData
1da177e4
LT
1/*
2 * linux/net/sunrpc/xprt.c
3 *
4 * This is a generic RPC call interface supporting congestion avoidance,
5 * and asynchronous calls.
6 *
7 * The interface works like this:
8 *
9 * - When a process places a call, it allocates a request slot if
10 * one is available. Otherwise, it sleeps on the backlog queue
11 * (xprt_reserve).
12 * - Next, the caller puts together the RPC message, stuffs it into
55aa4f58
CL
13 * the request struct, and calls xprt_transmit().
14 * - xprt_transmit sends the message and installs the caller on the
55ae1aab
RL
15 * transport's wait list. At the same time, if a reply is expected,
16 * it installs a timer that is run after the packet's timeout has
17 * expired.
1da177e4 18 * - When a packet arrives, the data_ready handler walks the list of
55aa4f58 19 * pending requests for that transport. If a matching XID is found, the
1da177e4
LT
20 * caller is woken up, and the timer removed.
21 * - When no reply arrives within the timeout interval, the timer is
22 * fired by the kernel and runs xprt_timer(). It either adjusts the
23 * timeout values (minor timeout) or wakes up the caller with a status
24 * of -ETIMEDOUT.
25 * - When the caller receives a notification from RPC that a reply arrived,
26 * it should release the RPC slot, and process the reply.
27 * If the call timed out, it may choose to retry the operation by
28 * adjusting the initial timeout value, and simply calling rpc_call
29 * again.
30 *
31 * Support for async RPC is done through a set of RPC-specific scheduling
32 * primitives that `transparently' work for processes as well as async
33 * tasks that rely on callbacks.
34 *
35 * Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
55aa4f58
CL
36 *
37 * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
1da177e4
LT
38 */
39
a246b010
CL
40#include <linux/module.h>
41
1da177e4 42#include <linux/types.h>
a246b010 43#include <linux/interrupt.h>
1da177e4 44#include <linux/workqueue.h>
bf3fcf89 45#include <linux/net.h>
ff839970 46#include <linux/ktime.h>
1da177e4 47
a246b010 48#include <linux/sunrpc/clnt.h>
11c556b3 49#include <linux/sunrpc/metrics.h>
c9acb42e 50#include <linux/sunrpc/bc_xprt.h>
fda1bfef 51#include <linux/rcupdate.h>
1da177e4 52
3705ad64
JL
53#include <trace/events/sunrpc.h>
54
55ae1aab
RL
55#include "sunrpc.h"
56
1da177e4
LT
57/*
58 * Local variables
59 */
60
f895b252 61#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
1da177e4
LT
62# define RPCDBG_FACILITY RPCDBG_XPRT
63#endif
64
1da177e4
LT
65/*
66 * Local functions
67 */
21de0a95 68static void xprt_init(struct rpc_xprt *xprt, struct net *net);
1da177e4 69static void xprt_request_init(struct rpc_task *, struct rpc_xprt *);
1da177e4 70static void xprt_connect_status(struct rpc_task *task);
1da177e4 71static int __xprt_get_cong(struct rpc_xprt *, struct rpc_task *);
29807318 72static void __xprt_put_cong(struct rpc_xprt *, struct rpc_rqst *);
4e0038b6 73static void xprt_destroy(struct rpc_xprt *xprt);
1da177e4 74
5ba03e82 75static DEFINE_SPINLOCK(xprt_list_lock);
81c098af
TT
76static LIST_HEAD(xprt_list);
77
81c098af
TT
78/**
79 * xprt_register_transport - register a transport implementation
80 * @transport: transport to register
81 *
82 * If a transport implementation is loaded as a kernel module, it can
83 * call this interface to make itself known to the RPC client.
84 *
85 * Returns:
86 * 0: transport successfully registered
87 * -EEXIST: transport already registered
88 * -EINVAL: transport module being unloaded
89 */
90int xprt_register_transport(struct xprt_class *transport)
91{
92 struct xprt_class *t;
93 int result;
94
95 result = -EEXIST;
96 spin_lock(&xprt_list_lock);
97 list_for_each_entry(t, &xprt_list, list) {
98 /* don't register the same transport class twice */
4fa016eb 99 if (t->ident == transport->ident)
81c098af
TT
100 goto out;
101 }
102
c9f6cde6
DL
103 list_add_tail(&transport->list, &xprt_list);
104 printk(KERN_INFO "RPC: Registered %s transport module.\n",
105 transport->name);
106 result = 0;
81c098af
TT
107
108out:
109 spin_unlock(&xprt_list_lock);
110 return result;
111}
112EXPORT_SYMBOL_GPL(xprt_register_transport);
113
114/**
115 * xprt_unregister_transport - unregister a transport implementation
65b6e42c 116 * @transport: transport to unregister
81c098af
TT
117 *
118 * Returns:
119 * 0: transport successfully unregistered
120 * -ENOENT: transport never registered
121 */
122int xprt_unregister_transport(struct xprt_class *transport)
123{
124 struct xprt_class *t;
125 int result;
126
127 result = 0;
128 spin_lock(&xprt_list_lock);
129 list_for_each_entry(t, &xprt_list, list) {
130 if (t == transport) {
131 printk(KERN_INFO
132 "RPC: Unregistered %s transport module.\n",
133 transport->name);
134 list_del_init(&transport->list);
81c098af
TT
135 goto out;
136 }
137 }
138 result = -ENOENT;
139
140out:
141 spin_unlock(&xprt_list_lock);
142 return result;
143}
144EXPORT_SYMBOL_GPL(xprt_unregister_transport);
145
441e3e24
TT
146/**
147 * xprt_load_transport - load a transport implementation
148 * @transport_name: transport to load
149 *
150 * Returns:
151 * 0: transport successfully loaded
152 * -ENOENT: transport module not available
153 */
154int xprt_load_transport(const char *transport_name)
155{
156 struct xprt_class *t;
441e3e24
TT
157 int result;
158
159 result = 0;
160 spin_lock(&xprt_list_lock);
161 list_for_each_entry(t, &xprt_list, list) {
162 if (strcmp(t->name, transport_name) == 0) {
163 spin_unlock(&xprt_list_lock);
164 goto out;
165 }
166 }
167 spin_unlock(&xprt_list_lock);
ef7ffe8f 168 result = request_module("xprt%s", transport_name);
441e3e24
TT
169out:
170 return result;
171}
172EXPORT_SYMBOL_GPL(xprt_load_transport);
173
12a80469
CL
174/**
175 * xprt_reserve_xprt - serialize write access to transports
176 * @task: task that is requesting access to the transport
177c27bf 177 * @xprt: pointer to the target transport
12a80469
CL
178 *
179 * This prevents mixing the payload of separate requests, and prevents
180 * transport connects from colliding with writes. No congestion control
181 * is provided.
182 */
43cedbf0 183int xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
12a80469 184{
12a80469 185 struct rpc_rqst *req = task->tk_rqstp;
34006cee 186 int priority;
12a80469
CL
187
188 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
189 if (task == xprt->snd_task)
190 return 1;
12a80469
CL
191 goto out_sleep;
192 }
193 xprt->snd_task = task;
92551948 194 if (req != NULL)
43cedbf0 195 req->rq_ntrans++;
4d4a76f3 196
12a80469
CL
197 return 1;
198
199out_sleep:
46121cf7 200 dprintk("RPC: %5u failed to lock transport %p\n",
12a80469
CL
201 task->tk_pid, xprt);
202 task->tk_timeout = 0;
203 task->tk_status = -EAGAIN;
34006cee
TM
204 if (req == NULL)
205 priority = RPC_PRIORITY_LOW;
206 else if (!req->rq_ntrans)
207 priority = RPC_PRIORITY_NORMAL;
12a80469 208 else
34006cee
TM
209 priority = RPC_PRIORITY_HIGH;
210 rpc_sleep_on_priority(&xprt->sending, task, NULL, priority);
12a80469
CL
211 return 0;
212}
12444809 213EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
12a80469 214
632e3bdc
TM
215static void xprt_clear_locked(struct rpc_xprt *xprt)
216{
217 xprt->snd_task = NULL;
d19751e7 218 if (!test_bit(XPRT_CLOSE_WAIT, &xprt->state)) {
4e857c58 219 smp_mb__before_atomic();
632e3bdc 220 clear_bit(XPRT_LOCKED, &xprt->state);
4e857c58 221 smp_mb__after_atomic();
632e3bdc 222 } else
40a5f1b1 223 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
632e3bdc
TM
224}
225
1da177e4 226/*
12a80469
CL
227 * xprt_reserve_xprt_cong - serialize write access to transports
228 * @task: task that is requesting access to the transport
229 *
230 * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
231 * integrated into the decision of whether a request is allowed to be
232 * woken up and given access to the transport.
1da177e4 233 */
43cedbf0 234int xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
235{
236 struct rpc_rqst *req = task->tk_rqstp;
34006cee 237 int priority;
1da177e4 238
2226feb6 239 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
1da177e4
LT
240 if (task == xprt->snd_task)
241 return 1;
1da177e4
LT
242 goto out_sleep;
243 }
43cedbf0
TM
244 if (req == NULL) {
245 xprt->snd_task = task;
246 return 1;
247 }
12a80469 248 if (__xprt_get_cong(xprt, task)) {
1da177e4 249 xprt->snd_task = task;
43cedbf0 250 req->rq_ntrans++;
1da177e4
LT
251 return 1;
252 }
632e3bdc 253 xprt_clear_locked(xprt);
1da177e4 254out_sleep:
29807318
NB
255 if (req)
256 __xprt_put_cong(xprt, req);
46121cf7 257 dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
1da177e4
LT
258 task->tk_timeout = 0;
259 task->tk_status = -EAGAIN;
34006cee
TM
260 if (req == NULL)
261 priority = RPC_PRIORITY_LOW;
262 else if (!req->rq_ntrans)
263 priority = RPC_PRIORITY_NORMAL;
1da177e4 264 else
34006cee
TM
265 priority = RPC_PRIORITY_HIGH;
266 rpc_sleep_on_priority(&xprt->sending, task, NULL, priority);
1da177e4
LT
267 return 0;
268}
12444809 269EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
1da177e4 270
12a80469 271static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
272{
273 int retval;
274
4a0f8c04 275 spin_lock_bh(&xprt->transport_lock);
43cedbf0 276 retval = xprt->ops->reserve_xprt(xprt, task);
4a0f8c04 277 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
278 return retval;
279}
280
961a828d 281static bool __xprt_lock_write_func(struct rpc_task *task, void *data)
49e9a890 282{
961a828d 283 struct rpc_xprt *xprt = data;
49e9a890
CL
284 struct rpc_rqst *req;
285
49e9a890
CL
286 req = task->tk_rqstp;
287 xprt->snd_task = task;
92551948 288 if (req)
49e9a890 289 req->rq_ntrans++;
961a828d
TM
290 return true;
291}
49e9a890 292
961a828d
TM
293static void __xprt_lock_write_next(struct rpc_xprt *xprt)
294{
295 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
296 return;
297
f1dc237c
TM
298 if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
299 __xprt_lock_write_func, xprt))
961a828d 300 return;
632e3bdc 301 xprt_clear_locked(xprt);
49e9a890
CL
302}
303
961a828d 304static bool __xprt_lock_write_cong_func(struct rpc_task *task, void *data)
1da177e4 305{
961a828d 306 struct rpc_xprt *xprt = data;
43cedbf0 307 struct rpc_rqst *req;
1da177e4 308
43cedbf0
TM
309 req = task->tk_rqstp;
310 if (req == NULL) {
311 xprt->snd_task = task;
961a828d 312 return true;
43cedbf0 313 }
49e9a890 314 if (__xprt_get_cong(xprt, task)) {
1da177e4 315 xprt->snd_task = task;
43cedbf0 316 req->rq_ntrans++;
961a828d 317 return true;
1da177e4 318 }
961a828d
TM
319 return false;
320}
321
322static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
323{
324 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
325 return;
326 if (RPCXPRT_CONGESTED(xprt))
327 goto out_unlock;
f1dc237c
TM
328 if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
329 __xprt_lock_write_cong_func, xprt))
961a828d 330 return;
1da177e4 331out_unlock:
632e3bdc 332 xprt_clear_locked(xprt);
1da177e4
LT
333}
334
0695314e
TM
335static void xprt_task_clear_bytes_sent(struct rpc_task *task)
336{
337 if (task != NULL) {
338 struct rpc_rqst *req = task->tk_rqstp;
339 if (req != NULL)
340 req->rq_bytes_sent = 0;
341 }
342}
343
49e9a890
CL
344/**
345 * xprt_release_xprt - allow other requests to use a transport
346 * @xprt: transport with other tasks potentially waiting
347 * @task: task that is releasing access to the transport
348 *
349 * Note that "task" can be NULL. No congestion control is provided.
1da177e4 350 */
49e9a890 351void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
352{
353 if (xprt->snd_task == task) {
0695314e 354 xprt_task_clear_bytes_sent(task);
632e3bdc 355 xprt_clear_locked(xprt);
1da177e4
LT
356 __xprt_lock_write_next(xprt);
357 }
358}
12444809 359EXPORT_SYMBOL_GPL(xprt_release_xprt);
1da177e4 360
49e9a890
CL
361/**
362 * xprt_release_xprt_cong - allow other requests to use a transport
363 * @xprt: transport with other tasks potentially waiting
364 * @task: task that is releasing access to the transport
365 *
366 * Note that "task" can be NULL. Another task is awoken to use the
367 * transport if the transport's congestion window allows it.
368 */
369void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
370{
371 if (xprt->snd_task == task) {
0695314e 372 xprt_task_clear_bytes_sent(task);
632e3bdc 373 xprt_clear_locked(xprt);
49e9a890
CL
374 __xprt_lock_write_next_cong(xprt);
375 }
376}
12444809 377EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
49e9a890
CL
378
379static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4 380{
4a0f8c04 381 spin_lock_bh(&xprt->transport_lock);
49e9a890 382 xprt->ops->release_xprt(xprt, task);
4a0f8c04 383 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
384}
385
1da177e4
LT
386/*
387 * Van Jacobson congestion avoidance. Check if the congestion window
388 * overflowed. Put the task to sleep if this is the case.
389 */
390static int
391__xprt_get_cong(struct rpc_xprt *xprt, struct rpc_task *task)
392{
393 struct rpc_rqst *req = task->tk_rqstp;
394
395 if (req->rq_cong)
396 return 1;
46121cf7 397 dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
1da177e4
LT
398 task->tk_pid, xprt->cong, xprt->cwnd);
399 if (RPCXPRT_CONGESTED(xprt))
400 return 0;
401 req->rq_cong = 1;
402 xprt->cong += RPC_CWNDSCALE;
403 return 1;
404}
405
406/*
407 * Adjust the congestion window, and wake up the next task
408 * that has been sleeping due to congestion
409 */
410static void
411__xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
412{
413 if (!req->rq_cong)
414 return;
415 req->rq_cong = 0;
416 xprt->cong -= RPC_CWNDSCALE;
49e9a890 417 __xprt_lock_write_next_cong(xprt);
1da177e4
LT
418}
419
a58dd398
CL
420/**
421 * xprt_release_rqst_cong - housekeeping when request is complete
422 * @task: RPC request that recently completed
423 *
424 * Useful for transports that require congestion control.
425 */
426void xprt_release_rqst_cong(struct rpc_task *task)
427{
a4f0835c
TM
428 struct rpc_rqst *req = task->tk_rqstp;
429
430 __xprt_put_cong(req->rq_xprt, req);
a58dd398 431}
12444809 432EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
a58dd398 433
46c0ee8b
CL
434/**
435 * xprt_adjust_cwnd - adjust transport congestion window
6a24dfb6 436 * @xprt: pointer to xprt
46c0ee8b
CL
437 * @task: recently completed RPC request used to adjust window
438 * @result: result code of completed RPC request
439 *
4f4cf5ad
CL
440 * The transport code maintains an estimate on the maximum number of out-
441 * standing RPC requests, using a smoothed version of the congestion
442 * avoidance implemented in 44BSD. This is basically the Van Jacobson
443 * congestion algorithm: If a retransmit occurs, the congestion window is
444 * halved; otherwise, it is incremented by 1/cwnd when
445 *
446 * - a reply is received and
447 * - a full number of requests are outstanding and
448 * - the congestion window hasn't been updated recently.
1da177e4 449 */
6a24dfb6 450void xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result)
1da177e4 451{
46c0ee8b 452 struct rpc_rqst *req = task->tk_rqstp;
46c0ee8b 453 unsigned long cwnd = xprt->cwnd;
1da177e4 454
1da177e4
LT
455 if (result >= 0 && cwnd <= xprt->cong) {
456 /* The (cwnd >> 1) term makes sure
457 * the result gets rounded properly. */
458 cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
459 if (cwnd > RPC_MAXCWND(xprt))
460 cwnd = RPC_MAXCWND(xprt);
49e9a890 461 __xprt_lock_write_next_cong(xprt);
1da177e4
LT
462 } else if (result == -ETIMEDOUT) {
463 cwnd >>= 1;
464 if (cwnd < RPC_CWNDSCALE)
465 cwnd = RPC_CWNDSCALE;
466 }
46121cf7 467 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
1da177e4
LT
468 xprt->cong, xprt->cwnd, cwnd);
469 xprt->cwnd = cwnd;
46c0ee8b 470 __xprt_put_cong(xprt, req);
1da177e4 471}
12444809 472EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
1da177e4 473
44fbac22
CL
474/**
475 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
476 * @xprt: transport with waiting tasks
477 * @status: result code to plant in each task before waking it
478 *
479 */
480void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
481{
482 if (status < 0)
483 rpc_wake_up_status(&xprt->pending, status);
484 else
485 rpc_wake_up(&xprt->pending);
486}
12444809 487EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
44fbac22 488
c7b2cae8
CL
489/**
490 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
491 * @task: task to be put to sleep
0b80ae42 492 * @action: function pointer to be executed after wait
a9a6b52e
TM
493 *
494 * Note that we only set the timer for the case of RPC_IS_SOFT(), since
495 * we don't in general want to force a socket disconnection due to
496 * an incomplete RPC call transmission.
c7b2cae8 497 */
b6ddf64f 498void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
c7b2cae8
CL
499{
500 struct rpc_rqst *req = task->tk_rqstp;
501 struct rpc_xprt *xprt = req->rq_xprt;
502
a9a6b52e 503 task->tk_timeout = RPC_IS_SOFT(task) ? req->rq_timeout : 0;
b6ddf64f 504 rpc_sleep_on(&xprt->pending, task, action);
c7b2cae8 505}
12444809 506EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
c7b2cae8
CL
507
508/**
509 * xprt_write_space - wake the task waiting for transport output buffer space
510 * @xprt: transport with waiting tasks
511 *
512 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
513 */
514void xprt_write_space(struct rpc_xprt *xprt)
515{
c7b2cae8
CL
516 spin_lock_bh(&xprt->transport_lock);
517 if (xprt->snd_task) {
46121cf7
CL
518 dprintk("RPC: write space: waking waiting task on "
519 "xprt %p\n", xprt);
fda13939 520 rpc_wake_up_queued_task(&xprt->pending, xprt->snd_task);
c7b2cae8
CL
521 }
522 spin_unlock_bh(&xprt->transport_lock);
523}
12444809 524EXPORT_SYMBOL_GPL(xprt_write_space);
c7b2cae8 525
fe3aca29
CL
526/**
527 * xprt_set_retrans_timeout_def - set a request's retransmit timeout
528 * @task: task whose timeout is to be set
529 *
530 * Set a request's retransmit timeout based on the transport's
531 * default timeout parameters. Used by transports that don't adjust
532 * the retransmit timeout based on round-trip time estimation.
533 */
534void xprt_set_retrans_timeout_def(struct rpc_task *task)
535{
536 task->tk_timeout = task->tk_rqstp->rq_timeout;
537}
12444809 538EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def);
fe3aca29 539
2c53040f 540/**
fe3aca29
CL
541 * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
542 * @task: task whose timeout is to be set
cca5172a 543 *
fe3aca29
CL
544 * Set a request's retransmit timeout using the RTT estimator.
545 */
546void xprt_set_retrans_timeout_rtt(struct rpc_task *task)
547{
548 int timer = task->tk_msg.rpc_proc->p_timer;
ba7392bb
TM
549 struct rpc_clnt *clnt = task->tk_client;
550 struct rpc_rtt *rtt = clnt->cl_rtt;
fe3aca29 551 struct rpc_rqst *req = task->tk_rqstp;
ba7392bb 552 unsigned long max_timeout = clnt->cl_timeout->to_maxval;
fe3aca29
CL
553
554 task->tk_timeout = rpc_calc_rto(rtt, timer);
555 task->tk_timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
556 if (task->tk_timeout > max_timeout || task->tk_timeout == 0)
557 task->tk_timeout = max_timeout;
558}
12444809 559EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt);
fe3aca29 560
1da177e4
LT
561static void xprt_reset_majortimeo(struct rpc_rqst *req)
562{
ba7392bb 563 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
1da177e4
LT
564
565 req->rq_majortimeo = req->rq_timeout;
566 if (to->to_exponential)
567 req->rq_majortimeo <<= to->to_retries;
568 else
569 req->rq_majortimeo += to->to_increment * to->to_retries;
570 if (req->rq_majortimeo > to->to_maxval || req->rq_majortimeo == 0)
571 req->rq_majortimeo = to->to_maxval;
572 req->rq_majortimeo += jiffies;
573}
574
9903cd1c
CL
575/**
576 * xprt_adjust_timeout - adjust timeout values for next retransmit
577 * @req: RPC request containing parameters to use for the adjustment
578 *
1da177e4
LT
579 */
580int xprt_adjust_timeout(struct rpc_rqst *req)
581{
582 struct rpc_xprt *xprt = req->rq_xprt;
ba7392bb 583 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
1da177e4
LT
584 int status = 0;
585
586 if (time_before(jiffies, req->rq_majortimeo)) {
587 if (to->to_exponential)
588 req->rq_timeout <<= 1;
589 else
590 req->rq_timeout += to->to_increment;
591 if (to->to_maxval && req->rq_timeout >= to->to_maxval)
592 req->rq_timeout = to->to_maxval;
593 req->rq_retries++;
1da177e4
LT
594 } else {
595 req->rq_timeout = to->to_initval;
596 req->rq_retries = 0;
597 xprt_reset_majortimeo(req);
598 /* Reset the RTT counters == "slow start" */
4a0f8c04 599 spin_lock_bh(&xprt->transport_lock);
1da177e4 600 rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
4a0f8c04 601 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
602 status = -ETIMEDOUT;
603 }
604
605 if (req->rq_timeout == 0) {
606 printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
607 req->rq_timeout = 5 * HZ;
608 }
609 return status;
610}
611
65f27f38 612static void xprt_autoclose(struct work_struct *work)
1da177e4 613{
65f27f38
DH
614 struct rpc_xprt *xprt =
615 container_of(work, struct rpc_xprt, task_cleanup);
1da177e4 616
66af1e55 617 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
4876cc77 618 xprt->ops->close(xprt);
1da177e4 619 xprt_release_write(xprt, NULL);
79234c3d 620 wake_up_bit(&xprt->state, XPRT_LOCKED);
1da177e4
LT
621}
622
9903cd1c 623/**
62da3b24 624 * xprt_disconnect_done - mark a transport as disconnected
9903cd1c
CL
625 * @xprt: transport to flag for disconnect
626 *
1da177e4 627 */
62da3b24 628void xprt_disconnect_done(struct rpc_xprt *xprt)
1da177e4 629{
46121cf7 630 dprintk("RPC: disconnected transport %p\n", xprt);
4a0f8c04 631 spin_lock_bh(&xprt->transport_lock);
1da177e4 632 xprt_clear_connected(xprt);
2a491991 633 xprt_wake_pending_tasks(xprt, -EAGAIN);
4a0f8c04 634 spin_unlock_bh(&xprt->transport_lock);
1da177e4 635}
62da3b24 636EXPORT_SYMBOL_GPL(xprt_disconnect_done);
1da177e4 637
66af1e55
TM
638/**
639 * xprt_force_disconnect - force a transport to disconnect
640 * @xprt: transport to disconnect
641 *
642 */
643void xprt_force_disconnect(struct rpc_xprt *xprt)
644{
645 /* Don't race with the test_bit() in xprt_clear_locked() */
646 spin_lock_bh(&xprt->transport_lock);
647 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
648 /* Try to schedule an autoclose RPC call */
649 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
40a5f1b1 650 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
2a491991 651 xprt_wake_pending_tasks(xprt, -EAGAIN);
66af1e55
TM
652 spin_unlock_bh(&xprt->transport_lock);
653}
e2a4f4fb 654EXPORT_SYMBOL_GPL(xprt_force_disconnect);
66af1e55 655
7c1d71cf
TM
656/**
657 * xprt_conditional_disconnect - force a transport to disconnect
658 * @xprt: transport to disconnect
659 * @cookie: 'connection cookie'
660 *
661 * This attempts to break the connection if and only if 'cookie' matches
662 * the current transport 'connection cookie'. It ensures that we don't
663 * try to break the connection more than once when we need to retransmit
664 * a batch of RPC requests.
665 *
666 */
667void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
668{
669 /* Don't race with the test_bit() in xprt_clear_locked() */
670 spin_lock_bh(&xprt->transport_lock);
671 if (cookie != xprt->connect_cookie)
672 goto out;
2c2ee6d2 673 if (test_bit(XPRT_CLOSING, &xprt->state))
7c1d71cf
TM
674 goto out;
675 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
676 /* Try to schedule an autoclose RPC call */
677 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
40a5f1b1 678 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
2a491991 679 xprt_wake_pending_tasks(xprt, -EAGAIN);
7c1d71cf
TM
680out:
681 spin_unlock_bh(&xprt->transport_lock);
682}
683
ad3331ac
TM
684static bool
685xprt_has_timer(const struct rpc_xprt *xprt)
686{
687 return xprt->idle_timeout != 0;
688}
689
690static void
691xprt_schedule_autodisconnect(struct rpc_xprt *xprt)
692 __must_hold(&xprt->transport_lock)
693{
694 if (list_empty(&xprt->recv) && xprt_has_timer(xprt))
695 mod_timer(&xprt->timer, xprt->last_used + xprt->idle_timeout);
696}
697
1da177e4 698static void
ff861c4d 699xprt_init_autodisconnect(struct timer_list *t)
1da177e4 700{
ff861c4d 701 struct rpc_xprt *xprt = from_timer(xprt, t, timer);
1da177e4 702
4a0f8c04 703 spin_lock(&xprt->transport_lock);
d19751e7 704 if (!list_empty(&xprt->recv))
1da177e4 705 goto out_abort;
ad3331ac
TM
706 /* Reset xprt->last_used to avoid connect/autodisconnect cycling */
707 xprt->last_used = jiffies;
2226feb6 708 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
1da177e4 709 goto out_abort;
4a0f8c04 710 spin_unlock(&xprt->transport_lock);
40a5f1b1 711 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
1da177e4
LT
712 return;
713out_abort:
4a0f8c04 714 spin_unlock(&xprt->transport_lock);
1da177e4
LT
715}
716
718ba5b8
TM
717bool xprt_lock_connect(struct rpc_xprt *xprt,
718 struct rpc_task *task,
719 void *cookie)
720{
721 bool ret = false;
722
723 spin_lock_bh(&xprt->transport_lock);
724 if (!test_bit(XPRT_LOCKED, &xprt->state))
725 goto out;
726 if (xprt->snd_task != task)
727 goto out;
0695314e 728 xprt_task_clear_bytes_sent(task);
718ba5b8
TM
729 xprt->snd_task = cookie;
730 ret = true;
731out:
732 spin_unlock_bh(&xprt->transport_lock);
733 return ret;
734}
735
736void xprt_unlock_connect(struct rpc_xprt *xprt, void *cookie)
737{
738 spin_lock_bh(&xprt->transport_lock);
739 if (xprt->snd_task != cookie)
740 goto out;
741 if (!test_bit(XPRT_LOCKED, &xprt->state))
742 goto out;
743 xprt->snd_task =NULL;
744 xprt->ops->release_xprt(xprt, NULL);
ad3331ac 745 xprt_schedule_autodisconnect(xprt);
718ba5b8
TM
746out:
747 spin_unlock_bh(&xprt->transport_lock);
79234c3d 748 wake_up_bit(&xprt->state, XPRT_LOCKED);
718ba5b8
TM
749}
750
9903cd1c
CL
751/**
752 * xprt_connect - schedule a transport connect operation
753 * @task: RPC task that is requesting the connect
1da177e4
LT
754 *
755 */
756void xprt_connect(struct rpc_task *task)
757{
ad2368d6 758 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1da177e4 759
46121cf7 760 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
1da177e4
LT
761 xprt, (xprt_connected(xprt) ? "is" : "is not"));
762
ec739ef0 763 if (!xprt_bound(xprt)) {
01d37c42 764 task->tk_status = -EAGAIN;
1da177e4
LT
765 return;
766 }
767 if (!xprt_lock_write(xprt, task))
768 return;
feb8ca37
TM
769
770 if (test_and_clear_bit(XPRT_CLOSE_WAIT, &xprt->state))
771 xprt->ops->close(xprt);
772
718ba5b8 773 if (!xprt_connected(xprt)) {
87e3c055 774 task->tk_rqstp->rq_bytes_sent = 0;
a8ce4a8f 775 task->tk_timeout = task->tk_rqstp->rq_timeout;
2c2ee6d2 776 task->tk_rqstp->rq_connect_cookie = xprt->connect_cookie;
5d00837b 777 rpc_sleep_on(&xprt->pending, task, xprt_connect_status);
0b9e7943
TM
778
779 if (test_bit(XPRT_CLOSING, &xprt->state))
780 return;
781 if (xprt_test_and_set_connecting(xprt))
782 return;
262ca07d 783 xprt->stat.connect_start = jiffies;
1b092092 784 xprt->ops->connect(xprt, task);
1da177e4 785 }
718ba5b8 786 xprt_release_write(xprt, task);
1da177e4
LT
787}
788
9903cd1c 789static void xprt_connect_status(struct rpc_task *task)
1da177e4 790{
ad2368d6 791 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1da177e4 792
cd983ef8 793 if (task->tk_status == 0) {
262ca07d
CL
794 xprt->stat.connect_count++;
795 xprt->stat.connect_time += (long)jiffies - xprt->stat.connect_start;
46121cf7 796 dprintk("RPC: %5u xprt_connect_status: connection established\n",
1da177e4
LT
797 task->tk_pid);
798 return;
799 }
800
1da177e4 801 switch (task->tk_status) {
0fe8d04e
TM
802 case -ECONNREFUSED:
803 case -ECONNRESET:
804 case -ECONNABORTED:
805 case -ENETUNREACH:
806 case -EHOSTUNREACH:
2fc193cf 807 case -EPIPE:
2a491991
TM
808 case -EAGAIN:
809 dprintk("RPC: %5u xprt_connect_status: retrying\n", task->tk_pid);
23475d66 810 break;
1da177e4 811 case -ETIMEDOUT:
46121cf7
CL
812 dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
813 "out\n", task->tk_pid);
1da177e4
LT
814 break;
815 default:
46121cf7
CL
816 dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
817 "server %s\n", task->tk_pid, -task->tk_status,
4e0038b6 818 xprt->servername);
23475d66 819 task->tk_status = -EIO;
1da177e4 820 }
1da177e4
LT
821}
822
9903cd1c
CL
823/**
824 * xprt_lookup_rqst - find an RPC request corresponding to an XID
825 * @xprt: transport on which the original request was transmitted
826 * @xid: RPC XID of incoming reply
827 *
1da177e4 828 */
d8ed029d 829struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
1da177e4 830{
8f3a6de3 831 struct rpc_rqst *entry;
1da177e4 832
8f3a6de3 833 list_for_each_entry(entry, &xprt->recv, rq_list)
3705ad64
JL
834 if (entry->rq_xid == xid) {
835 trace_xprt_lookup_rqst(xprt, xid, 0);
262ca07d 836 return entry;
3705ad64 837 }
46121cf7
CL
838
839 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
840 ntohl(xid));
3705ad64 841 trace_xprt_lookup_rqst(xprt, xid, -ENOENT);
262ca07d
CL
842 xprt->stat.bad_xids++;
843 return NULL;
1da177e4 844}
12444809 845EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
1da177e4 846
729749bb
TM
847/**
848 * xprt_pin_rqst - Pin a request on the transport receive list
849 * @req: Request to pin
850 *
851 * Caller must ensure this is atomic with the call to xprt_lookup_rqst()
852 * so should be holding the xprt transport lock.
853 */
854void xprt_pin_rqst(struct rpc_rqst *req)
855{
856 set_bit(RPC_TASK_MSG_RECV, &req->rq_task->tk_runstate);
857}
9590d083 858EXPORT_SYMBOL_GPL(xprt_pin_rqst);
729749bb
TM
859
860/**
861 * xprt_unpin_rqst - Unpin a request on the transport receive list
862 * @req: Request to pin
863 *
864 * Caller should be holding the xprt transport lock.
865 */
866void xprt_unpin_rqst(struct rpc_rqst *req)
867{
868 struct rpc_task *task = req->rq_task;
869
870 clear_bit(RPC_TASK_MSG_RECV, &task->tk_runstate);
871 if (test_bit(RPC_TASK_MSG_RECV_WAIT, &task->tk_runstate))
872 wake_up_bit(&task->tk_runstate, RPC_TASK_MSG_RECV);
873}
9590d083 874EXPORT_SYMBOL_GPL(xprt_unpin_rqst);
729749bb
TM
875
876static void xprt_wait_on_pinned_rqst(struct rpc_rqst *req)
ce7c252a 877__must_hold(&req->rq_xprt->recv_lock)
729749bb
TM
878{
879 struct rpc_task *task = req->rq_task;
880
881 if (task && test_bit(RPC_TASK_MSG_RECV, &task->tk_runstate)) {
ce7c252a 882 spin_unlock(&req->rq_xprt->recv_lock);
729749bb
TM
883 set_bit(RPC_TASK_MSG_RECV_WAIT, &task->tk_runstate);
884 wait_on_bit(&task->tk_runstate, RPC_TASK_MSG_RECV,
885 TASK_UNINTERRUPTIBLE);
886 clear_bit(RPC_TASK_MSG_RECV_WAIT, &task->tk_runstate);
ce7c252a 887 spin_lock(&req->rq_xprt->recv_lock);
729749bb
TM
888 }
889}
890
bbc72cea 891static void xprt_update_rtt(struct rpc_task *task)
1570c1e4
CL
892{
893 struct rpc_rqst *req = task->tk_rqstp;
894 struct rpc_rtt *rtt = task->tk_client->cl_rtt;
95c96174 895 unsigned int timer = task->tk_msg.rpc_proc->p_timer;
d60dbb20 896 long m = usecs_to_jiffies(ktime_to_us(req->rq_rtt));
1570c1e4
CL
897
898 if (timer) {
899 if (req->rq_ntrans == 1)
ff839970 900 rpc_update_rtt(rtt, timer, m);
1570c1e4
CL
901 rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
902 }
903}
904
9903cd1c
CL
905/**
906 * xprt_complete_rqst - called when reply processing is complete
1570c1e4 907 * @task: RPC request that recently completed
9903cd1c
CL
908 * @copied: actual number of bytes received from the transport
909 *
1570c1e4 910 * Caller holds transport lock.
1da177e4 911 */
1570c1e4 912void xprt_complete_rqst(struct rpc_task *task, int copied)
1da177e4 913{
1570c1e4 914 struct rpc_rqst *req = task->tk_rqstp;
fda13939 915 struct rpc_xprt *xprt = req->rq_xprt;
1da177e4 916
1570c1e4
CL
917 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
918 task->tk_pid, ntohl(req->rq_xid), copied);
3705ad64 919 trace_xprt_complete_rqst(xprt, req->rq_xid, copied);
1da177e4 920
fda13939 921 xprt->stat.recvs++;
d60dbb20 922 req->rq_rtt = ktime_sub(ktime_get(), req->rq_xtime);
bbc72cea
CL
923 if (xprt->ops->timer != NULL)
924 xprt_update_rtt(task);
ef759a2e 925
1da177e4 926 list_del_init(&req->rq_list);
1e799b67 927 req->rq_private_buf.len = copied;
dd2b63d0
RL
928 /* Ensure all writes are done before we update */
929 /* req->rq_reply_bytes_recvd */
43ac3f29 930 smp_wmb();
dd2b63d0 931 req->rq_reply_bytes_recvd = copied;
fda13939 932 rpc_wake_up_queued_task(&xprt->pending, task);
1da177e4 933}
12444809 934EXPORT_SYMBOL_GPL(xprt_complete_rqst);
1da177e4 935
46c0ee8b 936static void xprt_timer(struct rpc_task *task)
1da177e4 937{
46c0ee8b 938 struct rpc_rqst *req = task->tk_rqstp;
1da177e4
LT
939 struct rpc_xprt *xprt = req->rq_xprt;
940
5d00837b
TM
941 if (task->tk_status != -ETIMEDOUT)
942 return;
46121cf7 943 dprintk("RPC: %5u xprt_timer\n", task->tk_pid);
1da177e4 944
dd2b63d0 945 if (!req->rq_reply_bytes_recvd) {
46c0ee8b 946 if (xprt->ops->timer)
6a24dfb6 947 xprt->ops->timer(xprt, task);
5d00837b
TM
948 } else
949 task->tk_status = 0;
1da177e4
LT
950}
951
9903cd1c
CL
952/**
953 * xprt_prepare_transmit - reserve the transport before sending a request
954 * @task: RPC task about to send a request
955 *
1da177e4 956 */
90051ea7 957bool xprt_prepare_transmit(struct rpc_task *task)
1da177e4
LT
958{
959 struct rpc_rqst *req = task->tk_rqstp;
960 struct rpc_xprt *xprt = req->rq_xprt;
90051ea7 961 bool ret = false;
1da177e4 962
46121cf7 963 dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
1da177e4 964
4a0f8c04 965 spin_lock_bh(&xprt->transport_lock);
8a19a0b6
TM
966 if (!req->rq_bytes_sent) {
967 if (req->rq_reply_bytes_recvd) {
968 task->tk_status = req->rq_reply_bytes_recvd;
969 goto out_unlock;
970 }
971 if ((task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
972 && xprt_connected(xprt)
973 && req->rq_connect_cookie == xprt->connect_cookie) {
974 xprt->ops->set_retrans_timeout(task);
975 rpc_sleep_on(&xprt->pending, task, xprt_timer);
976 goto out_unlock;
977 }
1da177e4 978 }
90051ea7
TM
979 if (!xprt->ops->reserve_xprt(xprt, task)) {
980 task->tk_status = -EAGAIN;
981 goto out_unlock;
982 }
983 ret = true;
1da177e4 984out_unlock:
4a0f8c04 985 spin_unlock_bh(&xprt->transport_lock);
90051ea7 986 return ret;
1da177e4
LT
987}
988
e0ab53de 989void xprt_end_transmit(struct rpc_task *task)
5e5ce5be 990{
343952fa 991 xprt_release_write(task->tk_rqstp->rq_xprt, task);
5e5ce5be
TM
992}
993
9903cd1c
CL
994/**
995 * xprt_transmit - send an RPC request on a transport
996 * @task: controlling RPC task
997 *
998 * We have to copy the iovec because sendmsg fiddles with its contents.
999 */
1000void xprt_transmit(struct rpc_task *task)
1da177e4 1001{
1da177e4
LT
1002 struct rpc_rqst *req = task->tk_rqstp;
1003 struct rpc_xprt *xprt = req->rq_xprt;
90d91b0c 1004 unsigned int connect_cookie;
15a45206 1005 int status, numreqs;
1da177e4 1006
46121cf7 1007 dprintk("RPC: %5u xprt_transmit(%u)\n", task->tk_pid, req->rq_slen);
1da177e4 1008
dd2b63d0 1009 if (!req->rq_reply_bytes_recvd) {
55ae1aab
RL
1010 if (list_empty(&req->rq_list) && rpc_reply_expected(task)) {
1011 /*
1012 * Add to the list only if we're expecting a reply
1013 */
1da177e4
LT
1014 /* Update the softirq receive buffer */
1015 memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
1016 sizeof(req->rq_private_buf));
1017 /* Add request to the receive list */
ce7c252a 1018 spin_lock(&xprt->recv_lock);
1da177e4 1019 list_add_tail(&req->rq_list, &xprt->recv);
ce7c252a 1020 spin_unlock(&xprt->recv_lock);
1da177e4 1021 xprt_reset_majortimeo(req);
0f9dc2b1
TM
1022 /* Turn off autodisconnect */
1023 del_singleshot_timer_sync(&xprt->timer);
1da177e4
LT
1024 }
1025 } else if (!req->rq_bytes_sent)
1026 return;
1027
90d91b0c 1028 connect_cookie = xprt->connect_cookie;
ff839970 1029 req->rq_xtime = ktime_get();
a246b010 1030 status = xprt->ops->send_request(task);
3705ad64 1031 trace_xprt_transmit(xprt, req->rq_xid, status);
c8485e4d
TM
1032 if (status != 0) {
1033 task->tk_status = status;
1034 return;
1035 }
4a068258 1036 xprt_inject_disconnect(xprt);
262ca07d 1037
c8485e4d 1038 dprintk("RPC: %5u xmit complete\n", task->tk_pid);
468f8613 1039 task->tk_flags |= RPC_TASK_SENT;
c8485e4d 1040 spin_lock_bh(&xprt->transport_lock);
262ca07d 1041
c8485e4d 1042 xprt->ops->set_retrans_timeout(task);
262ca07d 1043
15a45206
AA
1044 numreqs = atomic_read(&xprt->num_reqs);
1045 if (numreqs > xprt->stat.max_slots)
1046 xprt->stat.max_slots = numreqs;
c8485e4d
TM
1047 xprt->stat.sends++;
1048 xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
1049 xprt->stat.bklog_u += xprt->backlog.qlen;
15a45206
AA
1050 xprt->stat.sending_u += xprt->sending.qlen;
1051 xprt->stat.pending_u += xprt->pending.qlen;
90d91b0c 1052 spin_unlock_bh(&xprt->transport_lock);
1da177e4 1053
90d91b0c
TM
1054 req->rq_connect_cookie = connect_cookie;
1055 if (rpc_reply_expected(task) && !READ_ONCE(req->rq_reply_bytes_recvd)) {
55ae1aab 1056 /*
90d91b0c
TM
1057 * Sleep on the pending queue if we're expecting a reply.
1058 * The spinlock ensures atomicity between the test of
1059 * req->rq_reply_bytes_recvd, and the call to rpc_sleep_on().
55ae1aab 1060 */
90d91b0c
TM
1061 spin_lock(&xprt->recv_lock);
1062 if (!req->rq_reply_bytes_recvd) {
0a660521 1063 rpc_sleep_on(&xprt->pending, task, xprt_timer);
90d91b0c
TM
1064 /*
1065 * Send an extra queue wakeup call if the
1066 * connection was dropped in case the call to
1067 * rpc_sleep_on() raced.
1068 */
1069 if (!xprt_connected(xprt))
1070 xprt_wake_pending_tasks(xprt, -ENOTCONN);
1071 }
1072 spin_unlock(&xprt->recv_lock);
55ae1aab 1073 }
1da177e4
LT
1074}
1075
ba60eb25
TM
1076static void xprt_add_backlog(struct rpc_xprt *xprt, struct rpc_task *task)
1077{
1078 set_bit(XPRT_CONGESTED, &xprt->state);
1079 rpc_sleep_on(&xprt->backlog, task, NULL);
1080}
1081
1082static void xprt_wake_up_backlog(struct rpc_xprt *xprt)
1083{
1084 if (rpc_wake_up_next(&xprt->backlog) == NULL)
1085 clear_bit(XPRT_CONGESTED, &xprt->state);
1086}
1087
1088static bool xprt_throttle_congested(struct rpc_xprt *xprt, struct rpc_task *task)
1089{
1090 bool ret = false;
1091
1092 if (!test_bit(XPRT_CONGESTED, &xprt->state))
1093 goto out;
1094 spin_lock(&xprt->reserve_lock);
1095 if (test_bit(XPRT_CONGESTED, &xprt->state)) {
1096 rpc_sleep_on(&xprt->backlog, task, NULL);
1097 ret = true;
1098 }
1099 spin_unlock(&xprt->reserve_lock);
1100out:
1101 return ret;
1102}
1103
92ea011f 1104static struct rpc_rqst *xprt_dynamic_alloc_slot(struct rpc_xprt *xprt)
d9ba131d
TM
1105{
1106 struct rpc_rqst *req = ERR_PTR(-EAGAIN);
1107
1108 if (!atomic_add_unless(&xprt->num_reqs, 1, xprt->max_reqs))
1109 goto out;
92ea011f
TM
1110 spin_unlock(&xprt->reserve_lock);
1111 req = kzalloc(sizeof(struct rpc_rqst), GFP_NOFS);
1112 spin_lock(&xprt->reserve_lock);
d9ba131d
TM
1113 if (req != NULL)
1114 goto out;
1115 atomic_dec(&xprt->num_reqs);
1116 req = ERR_PTR(-ENOMEM);
1117out:
1118 return req;
1119}
1120
1121static bool xprt_dynamic_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1122{
1123 if (atomic_add_unless(&xprt->num_reqs, -1, xprt->min_reqs)) {
1124 kfree(req);
1125 return true;
1126 }
1127 return false;
1128}
1129
f39c1bfb 1130void xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4 1131{
d9ba131d 1132 struct rpc_rqst *req;
1da177e4 1133
f39c1bfb 1134 spin_lock(&xprt->reserve_lock);
1da177e4 1135 if (!list_empty(&xprt->free)) {
d9ba131d
TM
1136 req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
1137 list_del(&req->rq_list);
1138 goto out_init_req;
1139 }
92ea011f 1140 req = xprt_dynamic_alloc_slot(xprt);
d9ba131d
TM
1141 if (!IS_ERR(req))
1142 goto out_init_req;
1143 switch (PTR_ERR(req)) {
1144 case -ENOMEM:
d9ba131d
TM
1145 dprintk("RPC: dynamic allocation of request slot "
1146 "failed! Retrying\n");
1afeaf5c 1147 task->tk_status = -ENOMEM;
d9ba131d
TM
1148 break;
1149 case -EAGAIN:
ba60eb25 1150 xprt_add_backlog(xprt, task);
d9ba131d 1151 dprintk("RPC: waiting for request slot\n");
e9d47639 1152 /* fall through */
1afeaf5c
TM
1153 default:
1154 task->tk_status = -EAGAIN;
1da177e4 1155 }
f39c1bfb 1156 spin_unlock(&xprt->reserve_lock);
d9ba131d
TM
1157 return;
1158out_init_req:
1159 task->tk_status = 0;
1160 task->tk_rqstp = req;
1161 xprt_request_init(task, xprt);
f39c1bfb
TM
1162 spin_unlock(&xprt->reserve_lock);
1163}
1164EXPORT_SYMBOL_GPL(xprt_alloc_slot);
1165
1166void xprt_lock_and_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
1167{
1168 /* Note: grabbing the xprt_lock_write() ensures that we throttle
1169 * new slot allocation if the transport is congested (i.e. when
1170 * reconnecting a stream transport or when out of socket write
1171 * buffer space).
1172 */
1173 if (xprt_lock_write(xprt, task)) {
1174 xprt_alloc_slot(xprt, task);
1175 xprt_release_write(xprt, task);
1176 }
1da177e4 1177}
f39c1bfb 1178EXPORT_SYMBOL_GPL(xprt_lock_and_alloc_slot);
1da177e4 1179
ee5ebe85
TM
1180static void xprt_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1181{
ee5ebe85 1182 spin_lock(&xprt->reserve_lock);
c25573b5
TM
1183 if (!xprt_dynamic_free_slot(xprt, req)) {
1184 memset(req, 0, sizeof(*req)); /* mark unused */
1185 list_add(&req->rq_list, &xprt->free);
1186 }
ba60eb25 1187 xprt_wake_up_backlog(xprt);
ee5ebe85
TM
1188 spin_unlock(&xprt->reserve_lock);
1189}
1190
21de0a95
TM
1191static void xprt_free_all_slots(struct rpc_xprt *xprt)
1192{
1193 struct rpc_rqst *req;
1194 while (!list_empty(&xprt->free)) {
1195 req = list_first_entry(&xprt->free, struct rpc_rqst, rq_list);
1196 list_del(&req->rq_list);
1197 kfree(req);
1198 }
1199}
1200
d9ba131d
TM
1201struct rpc_xprt *xprt_alloc(struct net *net, size_t size,
1202 unsigned int num_prealloc,
1203 unsigned int max_alloc)
bd1722d4
PE
1204{
1205 struct rpc_xprt *xprt;
21de0a95
TM
1206 struct rpc_rqst *req;
1207 int i;
bd1722d4
PE
1208
1209 xprt = kzalloc(size, GFP_KERNEL);
1210 if (xprt == NULL)
1211 goto out;
1212
21de0a95
TM
1213 xprt_init(xprt, net);
1214
1215 for (i = 0; i < num_prealloc; i++) {
1216 req = kzalloc(sizeof(struct rpc_rqst), GFP_KERNEL);
1217 if (!req)
8313164c 1218 goto out_free;
21de0a95
TM
1219 list_add(&req->rq_list, &xprt->free);
1220 }
d9ba131d
TM
1221 if (max_alloc > num_prealloc)
1222 xprt->max_reqs = max_alloc;
1223 else
1224 xprt->max_reqs = num_prealloc;
1225 xprt->min_reqs = num_prealloc;
1226 atomic_set(&xprt->num_reqs, num_prealloc);
bd1722d4
PE
1227
1228 return xprt;
1229
1230out_free:
21de0a95 1231 xprt_free(xprt);
bd1722d4
PE
1232out:
1233 return NULL;
1234}
1235EXPORT_SYMBOL_GPL(xprt_alloc);
1236
e204e621
PE
1237void xprt_free(struct rpc_xprt *xprt)
1238{
37aa2133 1239 put_net(xprt->xprt_net);
21de0a95 1240 xprt_free_all_slots(xprt);
fda1bfef 1241 kfree_rcu(xprt, rcu);
e204e621
PE
1242}
1243EXPORT_SYMBOL_GPL(xprt_free);
1244
9903cd1c
CL
1245/**
1246 * xprt_reserve - allocate an RPC request slot
1247 * @task: RPC task requesting a slot allocation
1248 *
ba60eb25
TM
1249 * If the transport is marked as being congested, or if no more
1250 * slots are available, place the task on the transport's
9903cd1c
CL
1251 * backlog queue.
1252 */
1253void xprt_reserve(struct rpc_task *task)
1da177e4 1254{
fb43d172 1255 struct rpc_xprt *xprt = task->tk_xprt;
1da177e4 1256
43cedbf0
TM
1257 task->tk_status = 0;
1258 if (task->tk_rqstp != NULL)
1259 return;
1260
43cedbf0
TM
1261 task->tk_timeout = 0;
1262 task->tk_status = -EAGAIN;
ba60eb25
TM
1263 if (!xprt_throttle_congested(xprt, task))
1264 xprt->ops->alloc_slot(xprt, task);
ba60eb25
TM
1265}
1266
1267/**
1268 * xprt_retry_reserve - allocate an RPC request slot
1269 * @task: RPC task requesting a slot allocation
1270 *
1271 * If no more slots are available, place the task on the transport's
1272 * backlog queue.
1273 * Note that the only difference with xprt_reserve is that we now
1274 * ignore the value of the XPRT_CONGESTED flag.
1275 */
1276void xprt_retry_reserve(struct rpc_task *task)
1277{
fb43d172 1278 struct rpc_xprt *xprt = task->tk_xprt;
ba60eb25
TM
1279
1280 task->tk_status = 0;
1281 if (task->tk_rqstp != NULL)
1282 return;
1283
1284 task->tk_timeout = 0;
1285 task->tk_status = -EAGAIN;
f39c1bfb 1286 xprt->ops->alloc_slot(xprt, task);
1da177e4
LT
1287}
1288
d8ed029d 1289static inline __be32 xprt_alloc_xid(struct rpc_xprt *xprt)
1da177e4 1290{
0eae88f3 1291 return (__force __be32)xprt->xid++;
1da177e4
LT
1292}
1293
1294static inline void xprt_init_xid(struct rpc_xprt *xprt)
1295{
63862b5b 1296 xprt->xid = prandom_u32();
1da177e4
LT
1297}
1298
9903cd1c 1299static void xprt_request_init(struct rpc_task *task, struct rpc_xprt *xprt)
1da177e4
LT
1300{
1301 struct rpc_rqst *req = task->tk_rqstp;
1302
d9ba131d 1303 INIT_LIST_HEAD(&req->rq_list);
ba7392bb 1304 req->rq_timeout = task->tk_client->cl_timeout->to_initval;
1da177e4
LT
1305 req->rq_task = task;
1306 req->rq_xprt = xprt;
02107148 1307 req->rq_buffer = NULL;
1da177e4 1308 req->rq_xid = xprt_alloc_xid(xprt);
0a660521 1309 req->rq_connect_cookie = xprt->connect_cookie - 1;
92551948
TM
1310 req->rq_bytes_sent = 0;
1311 req->rq_snd_buf.len = 0;
1312 req->rq_snd_buf.buflen = 0;
1313 req->rq_rcv_buf.len = 0;
1314 req->rq_rcv_buf.buflen = 0;
ead5e1c2 1315 req->rq_release_snd_buf = NULL;
da45828e 1316 xprt_reset_majortimeo(req);
46121cf7 1317 dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
1da177e4
LT
1318 req, ntohl(req->rq_xid));
1319}
1320
9903cd1c
CL
1321/**
1322 * xprt_release - release an RPC request slot
1323 * @task: task which is finished with the slot
1324 *
1da177e4 1325 */
9903cd1c 1326void xprt_release(struct rpc_task *task)
1da177e4 1327{
55ae1aab 1328 struct rpc_xprt *xprt;
87ed5003 1329 struct rpc_rqst *req = task->tk_rqstp;
1da177e4 1330
87ed5003
TM
1331 if (req == NULL) {
1332 if (task->tk_client) {
fb43d172 1333 xprt = task->tk_xprt;
87ed5003
TM
1334 if (xprt->snd_task == task)
1335 xprt_release_write(xprt, task);
87ed5003 1336 }
1da177e4 1337 return;
87ed5003 1338 }
55ae1aab 1339
55ae1aab 1340 xprt = req->rq_xprt;
0a702195
WAA
1341 if (task->tk_ops->rpc_count_stats != NULL)
1342 task->tk_ops->rpc_count_stats(task, task->tk_calldata);
1343 else if (task->tk_client)
1344 rpc_count_iostats(task, task->tk_client->cl_metrics);
ce7c252a
TM
1345 spin_lock(&xprt->recv_lock);
1346 if (!list_empty(&req->rq_list)) {
4c625a97 1347 list_del_init(&req->rq_list);
ce7c252a
TM
1348 xprt_wait_on_pinned_rqst(req);
1349 }
1350 spin_unlock(&xprt->recv_lock);
4a0f8c04 1351 spin_lock_bh(&xprt->transport_lock);
49e9a890 1352 xprt->ops->release_xprt(xprt, task);
a58dd398
CL
1353 if (xprt->ops->release_request)
1354 xprt->ops->release_request(task);
1da177e4 1355 xprt->last_used = jiffies;
ad3331ac 1356 xprt_schedule_autodisconnect(xprt);
4a0f8c04 1357 spin_unlock_bh(&xprt->transport_lock);
ee5ebe85 1358 if (req->rq_buffer)
3435c74a 1359 xprt->ops->buf_free(task);
4a068258 1360 xprt_inject_disconnect(xprt);
a17c2153
TM
1361 if (req->rq_cred != NULL)
1362 put_rpccred(req->rq_cred);
1da177e4 1363 task->tk_rqstp = NULL;
ead5e1c2
BF
1364 if (req->rq_release_snd_buf)
1365 req->rq_release_snd_buf(req);
55ae1aab 1366
46121cf7 1367 dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
ee5ebe85
TM
1368 if (likely(!bc_prealloc(req)))
1369 xprt_free_slot(xprt, req);
1370 else
c9acb42e 1371 xprt_free_bc_request(req);
1da177e4
LT
1372}
1373
21de0a95 1374static void xprt_init(struct rpc_xprt *xprt, struct net *net)
c2866763 1375{
30c5116b 1376 kref_init(&xprt->kref);
c2866763
CL
1377
1378 spin_lock_init(&xprt->transport_lock);
1379 spin_lock_init(&xprt->reserve_lock);
ce7c252a 1380 spin_lock_init(&xprt->recv_lock);
c2866763
CL
1381
1382 INIT_LIST_HEAD(&xprt->free);
1383 INIT_LIST_HEAD(&xprt->recv);
9e00abc3 1384#if defined(CONFIG_SUNRPC_BACKCHANNEL)
f9acac1a
RL
1385 spin_lock_init(&xprt->bc_pa_lock);
1386 INIT_LIST_HEAD(&xprt->bc_pa_list);
9e00abc3 1387#endif /* CONFIG_SUNRPC_BACKCHANNEL */
80b14d5e 1388 INIT_LIST_HEAD(&xprt->xprt_switch);
f9acac1a 1389
c2866763
CL
1390 xprt->last_used = jiffies;
1391 xprt->cwnd = RPC_INITCWND;
a509050b 1392 xprt->bind_index = 0;
c2866763
CL
1393
1394 rpc_init_wait_queue(&xprt->binding, "xprt_binding");
1395 rpc_init_wait_queue(&xprt->pending, "xprt_pending");
34006cee 1396 rpc_init_priority_wait_queue(&xprt->sending, "xprt_sending");
c2866763
CL
1397 rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
1398
c2866763
CL
1399 xprt_init_xid(xprt);
1400
21de0a95 1401 xprt->xprt_net = get_net(net);
8d9266ff
TM
1402}
1403
1404/**
1405 * xprt_create_transport - create an RPC transport
1406 * @args: rpc transport creation arguments
1407 *
1408 */
1409struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
1410{
1411 struct rpc_xprt *xprt;
1412 struct xprt_class *t;
1413
1414 spin_lock(&xprt_list_lock);
1415 list_for_each_entry(t, &xprt_list, list) {
1416 if (t->ident == args->ident) {
1417 spin_unlock(&xprt_list_lock);
1418 goto found;
1419 }
1420 }
1421 spin_unlock(&xprt_list_lock);
3c45ddf8 1422 dprintk("RPC: transport (%d) not supported\n", args->ident);
8d9266ff
TM
1423 return ERR_PTR(-EIO);
1424
1425found:
1426 xprt = t->setup(args);
1427 if (IS_ERR(xprt)) {
1428 dprintk("RPC: xprt_create_transport: failed, %ld\n",
1429 -PTR_ERR(xprt));
21de0a95 1430 goto out;
8d9266ff 1431 }
33d90ac0
BF
1432 if (args->flags & XPRT_CREATE_NO_IDLE_TIMEOUT)
1433 xprt->idle_timeout = 0;
21de0a95
TM
1434 INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
1435 if (xprt_has_timer(xprt))
ff861c4d 1436 timer_setup(&xprt->timer, xprt_init_autodisconnect, 0);
21de0a95 1437 else
ff861c4d 1438 timer_setup(&xprt->timer, NULL, 0);
4e0038b6
TM
1439
1440 if (strlen(args->servername) > RPC_MAXNETNAMELEN) {
1441 xprt_destroy(xprt);
1442 return ERR_PTR(-EINVAL);
1443 }
1444 xprt->servername = kstrdup(args->servername, GFP_KERNEL);
1445 if (xprt->servername == NULL) {
1446 xprt_destroy(xprt);
1447 return ERR_PTR(-ENOMEM);
1448 }
1449
3f940098 1450 rpc_xprt_debugfs_register(xprt);
388f0c77 1451
46121cf7 1452 dprintk("RPC: created transport %p with %u slots\n", xprt,
c2866763 1453 xprt->max_reqs);
21de0a95 1454out:
c2866763
CL
1455 return xprt;
1456}
1457
528fd354
TM
1458static void xprt_destroy_cb(struct work_struct *work)
1459{
1460 struct rpc_xprt *xprt =
1461 container_of(work, struct rpc_xprt, task_cleanup);
1462
1463 rpc_xprt_debugfs_unregister(xprt);
1464 rpc_destroy_wait_queue(&xprt->binding);
1465 rpc_destroy_wait_queue(&xprt->pending);
1466 rpc_destroy_wait_queue(&xprt->sending);
1467 rpc_destroy_wait_queue(&xprt->backlog);
1468 kfree(xprt->servername);
1469 /*
1470 * Tear down transport state and free the rpc_xprt
1471 */
1472 xprt->ops->destroy(xprt);
1473}
1474
9903cd1c
CL
1475/**
1476 * xprt_destroy - destroy an RPC transport, killing off all requests.
a8de240a 1477 * @xprt: transport to destroy
9903cd1c 1478 *
1da177e4 1479 */
a8de240a 1480static void xprt_destroy(struct rpc_xprt *xprt)
1da177e4 1481{
46121cf7 1482 dprintk("RPC: destroying transport %p\n", xprt);
79234c3d 1483
528fd354
TM
1484 /*
1485 * Exclude transport connect/disconnect handlers and autoclose
1486 */
79234c3d
TM
1487 wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_UNINTERRUPTIBLE);
1488
0065db32 1489 del_timer_sync(&xprt->timer);
c8541ecd
CL
1490
1491 /*
528fd354
TM
1492 * Destroy sockets etc from the system workqueue so they can
1493 * safely flush receive work running on rpciod.
c8541ecd 1494 */
528fd354
TM
1495 INIT_WORK(&xprt->task_cleanup, xprt_destroy_cb);
1496 schedule_work(&xprt->task_cleanup);
6b6ca86b 1497}
1da177e4 1498
30c5116b
TM
1499static void xprt_destroy_kref(struct kref *kref)
1500{
1501 xprt_destroy(container_of(kref, struct rpc_xprt, kref));
1502}
1503
1504/**
1505 * xprt_get - return a reference to an RPC transport.
1506 * @xprt: pointer to the transport
1507 *
1508 */
1509struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
1510{
1511 if (xprt != NULL && kref_get_unless_zero(&xprt->kref))
1512 return xprt;
1513 return NULL;
1514}
1515EXPORT_SYMBOL_GPL(xprt_get);
1516
6b6ca86b
TM
1517/**
1518 * xprt_put - release a reference to an RPC transport.
1519 * @xprt: pointer to the transport
1520 *
1521 */
1522void xprt_put(struct rpc_xprt *xprt)
1523{
30c5116b
TM
1524 if (xprt != NULL)
1525 kref_put(&xprt->kref, xprt_destroy_kref);
6b6ca86b 1526}
5d252f90 1527EXPORT_SYMBOL_GPL(xprt_put);