blob: 783748dc5e6fbf59959380e024e99e42039d7956 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
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
Chuck Lever55aa4f52005-08-11 16:25:47 -040014 * the request struct, and calls xprt_transmit().
15 * - xprt_transmit sends the message and installs the caller on the
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040016 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * - When a packet arrives, the data_ready handler walks the list of
Chuck Lever55aa4f52005-08-11 16:25:47 -040020 * pending requests for that transport. If a matching XID is found, the
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 * 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>
Chuck Lever55aa4f52005-08-11 16:25:47 -040037 *
38 * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 */
40
Chuck Levera246b012005-08-11 16:25:23 -040041#include <linux/module.h>
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <linux/types.h>
Chuck Levera246b012005-08-11 16:25:23 -040044#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/workqueue.h>
Chuck Leverbf3fcf82006-05-25 01:40:51 -040046#include <linux/net.h>
Chuck Leverff839972010-05-07 13:34:47 -040047#include <linux/ktime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Chuck Levera246b012005-08-11 16:25:23 -040049#include <linux/sunrpc/clnt.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050050#include <linux/sunrpc/metrics.h>
Trond Myklebustc9acb422010-03-19 15:36:22 -040051#include <linux/sunrpc/bc_xprt.h>
Trond Myklebustfda1bfe2015-02-14 17:48:49 -050052#include <linux/rcupdate.h>
Trond Myklebusta1231fd2019-02-18 10:02:29 -050053#include <linux/sched/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Jeff Layton3705ad62014-10-28 14:24:13 -040055#include <trace/events/sunrpc.h>
56
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040057#include "sunrpc.h"
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059/*
60 * Local variables
61 */
62
Jeff Laytonf895b252014-11-17 16:58:04 -050063#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064# define RPCDBG_FACILITY RPCDBG_XPRT
65#endif
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067/*
68 * Local functions
69 */
Trond Myklebust21de0a92011-07-17 16:57:32 -040070static void xprt_init(struct rpc_xprt *xprt, struct net *net);
Chuck Lever37ac86c2018-05-04 15:34:53 -040071static __be32 xprt_alloc_xid(struct rpc_xprt *xprt);
Trond Myklebust4e0038b2012-03-01 17:01:05 -050072static void xprt_destroy(struct rpc_xprt *xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Jiri Slaby5ba03e82007-11-22 19:40:22 +080074static DEFINE_SPINLOCK(xprt_list_lock);
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -040075static LIST_HEAD(xprt_list);
76
Trond Myklebust9e910bf2019-04-07 13:58:53 -040077static 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
Chuck Lever12a80462005-08-25 16:25:51 -070086/**
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -040087 * 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 */
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400107 if (t->ident == transport->ident)
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400108 goto out;
109 }
110
Denis V. Lunevc9f6cde2008-07-31 09:53:56 +0400111 list_add_tail(&transport->list, &xprt_list);
112 printk(KERN_INFO "RPC: Registered %s transport module.\n",
113 transport->name);
114 result = 0;
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400115
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
Randy Dunlap65b6e422008-02-13 15:03:23 -0800124 * @transport: transport to unregister
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400125 *
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);
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400143 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
154/**
Tom Talpey441e3e22009-03-11 14:37:56 -0400155 * 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;
Tom Talpey441e3e22009-03-11 14:37:56 -0400165 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);
Alex Riesenef7ffe82010-05-24 14:33:05 -0700176 result = request_module("xprt%s", transport_name);
Tom Talpey441e3e22009-03-11 14:37:56 -0400177out:
178 return result;
179}
180EXPORT_SYMBOL_GPL(xprt_load_transport);
181
Trond Myklebustc5445772018-09-03 23:39:27 -0400182static 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
Tom Talpey441e3e22009-03-11 14:37:56 -0400193/**
Chuck Lever12a80462005-08-25 16:25:51 -0700194 * xprt_reserve_xprt - serialize write access to transports
195 * @task: task that is requesting access to the transport
Randy Dunlap177c27b2011-07-28 06:54:36 +0000196 * @xprt: pointer to the target transport
Chuck Lever12a80462005-08-25 16:25:51 -0700197 *
198 * This prevents mixing the payload of separate requests, and prevents
199 * transport connects from colliding with writes. No congestion control
200 * is provided.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 */
Trond Myklebust43cedbf0e2011-07-17 16:01:03 -0400202int xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
Chuck Lever12a80462005-08-25 16:25:51 -0700204 struct rpc_rqst *req = task->tk_rqstp;
205
206 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
207 if (task == xprt->snd_task)
208 return 1;
Chuck Lever12a80462005-08-25 16:25:51 -0700209 goto out_sleep;
210 }
Trond Myklebustc5445772018-09-03 23:39:27 -0400211 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
212 goto out_unlock;
Chuck Lever12a80462005-08-25 16:25:51 -0700213 xprt->snd_task = task;
j223yang@asset.uwaterloo.ca4d4a76f2011-03-10 12:40:28 -0500214
Chuck Lever12a80462005-08-25 16:25:51 -0700215 return 1;
216
Trond Myklebustc5445772018-09-03 23:39:27 -0400217out_unlock:
218 xprt_clear_locked(xprt);
Chuck Lever12a80462005-08-25 16:25:51 -0700219out_sleep:
Chuck Lever46121cf2007-01-31 12:14:08 -0500220 dprintk("RPC: %5u failed to lock transport %p\n",
Chuck Lever12a80462005-08-25 16:25:51 -0700221 task->tk_pid, xprt);
Chuck Lever12a80462005-08-25 16:25:51 -0700222 task->tk_status = -EAGAIN;
Trond Myklebust6b2e6852019-04-07 13:58:49 -0400223 if (RPC_IS_SOFT(task))
224 rpc_sleep_on_timeout(&xprt->sending, task, NULL,
Trond Myklebust9e910bf2019-04-07 13:58:53 -0400225 xprt_request_timeout(req));
Trond Myklebust6b2e6852019-04-07 13:58:49 -0400226 else
227 rpc_sleep_on(&xprt->sending, task, NULL);
Chuck Lever12a80462005-08-25 16:25:51 -0700228 return 0;
229}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400230EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
Chuck Lever12a80462005-08-25 16:25:51 -0700231
Trond Myklebust75891f52018-09-03 17:37:36 -0400232static 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
Chuck Lever12a80462005-08-25 16:25:51 -0700257/*
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.
Trond Myklebust75891f52018-09-03 17:37:36 -0400264 * Note that the lock is only granted if we know there are free slots.
Chuck Lever12a80462005-08-25 16:25:51 -0700265 */
Trond Myklebust43cedbf0e2011-07-17 16:01:03 -0400266int xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
Chuck Lever12a80462005-08-25 16:25:51 -0700267{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 struct rpc_rqst *req = task->tk_rqstp;
269
Chuck Lever2226feb2005-08-11 16:25:38 -0400270 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 if (task == xprt->snd_task)
272 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 goto out_sleep;
274 }
Trond Myklebust43cedbf0e2011-07-17 16:01:03 -0400275 if (req == NULL) {
276 xprt->snd_task = task;
277 return 1;
278 }
Trond Myklebustc5445772018-09-03 23:39:27 -0400279 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
280 goto out_unlock;
Trond Myklebust75891f52018-09-03 17:37:36 -0400281 if (!xprt_need_congestion_window_wait(xprt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 xprt->snd_task = task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 return 1;
284 }
Trond Myklebustc5445772018-09-03 23:39:27 -0400285out_unlock:
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100286 xprt_clear_locked(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287out_sleep:
Chuck Lever46121cf2007-01-31 12:14:08 -0500288 dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 task->tk_status = -EAGAIN;
Trond Myklebust6b2e6852019-04-07 13:58:49 -0400290 if (RPC_IS_SOFT(task))
291 rpc_sleep_on_timeout(&xprt->sending, task, NULL,
Trond Myklebust9e910bf2019-04-07 13:58:53 -0400292 xprt_request_timeout(req));
Trond Myklebust6b2e6852019-04-07 13:58:49 -0400293 else
294 rpc_sleep_on(&xprt->sending, task, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 return 0;
296}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400297EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Chuck Lever12a80462005-08-25 16:25:51 -0700299static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
301 int retval;
302
Trond Myklebustbd79bc52018-09-07 19:38:55 -0400303 if (test_bit(XPRT_LOCKED, &xprt->state) && xprt->snd_task == task)
304 return 1;
Trond Myklebustb5e92412019-05-02 11:21:08 -0400305 spin_lock(&xprt->transport_lock);
Trond Myklebust43cedbf0e2011-07-17 16:01:03 -0400306 retval = xprt->ops->reserve_xprt(xprt, task);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400307 spin_unlock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 return retval;
309}
310
Trond Myklebust961a8282012-01-17 22:57:37 -0500311static bool __xprt_lock_write_func(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{
Trond Myklebust961a8282012-01-17 22:57:37 -0500313 struct rpc_xprt *xprt = data;
Chuck Lever49e9a892005-08-25 16:25:51 -0700314
Chuck Lever49e9a892005-08-25 16:25:51 -0700315 xprt->snd_task = task;
Trond Myklebust961a8282012-01-17 22:57:37 -0500316 return true;
317}
Chuck Lever49e9a892005-08-25 16:25:51 -0700318
Trond Myklebust961a8282012-01-17 22:57:37 -0500319static void __xprt_lock_write_next(struct rpc_xprt *xprt)
320{
321 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
322 return;
Trond Myklebustc5445772018-09-03 23:39:27 -0400323 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
324 goto out_unlock;
Trond Myklebustf1dc2372016-05-27 12:59:33 -0400325 if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
326 __xprt_lock_write_func, xprt))
Trond Myklebust961a8282012-01-17 22:57:37 -0500327 return;
Trond Myklebustc5445772018-09-03 23:39:27 -0400328out_unlock:
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100329 xprt_clear_locked(xprt);
Chuck Lever49e9a892005-08-25 16:25:51 -0700330}
331
Trond Myklebust961a8282012-01-17 22:57:37 -0500332static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
333{
334 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
335 return;
Trond Myklebustc5445772018-09-03 23:39:27 -0400336 if (test_bit(XPRT_WRITE_SPACE, &xprt->state))
337 goto out_unlock;
Trond Myklebust75891f52018-09-03 17:37:36 -0400338 if (xprt_need_congestion_window_wait(xprt))
Trond Myklebust961a8282012-01-17 22:57:37 -0500339 goto out_unlock;
Trond Myklebustf1dc2372016-05-27 12:59:33 -0400340 if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
Trond Myklebust75891f52018-09-03 17:37:36 -0400341 __xprt_lock_write_func, xprt))
Trond Myklebust961a8282012-01-17 22:57:37 -0500342 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343out_unlock:
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100344 xprt_clear_locked(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345}
346
Chuck Lever49e9a892005-08-25 16:25:51 -0700347/**
348 * xprt_release_xprt - allow other requests to use a transport
349 * @xprt: transport with other tasks potentially waiting
350 * @task: task that is releasing access to the transport
351 *
352 * Note that "task" can be NULL. No congestion control is provided.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 */
Chuck Lever49e9a892005-08-25 16:25:51 -0700354void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355{
356 if (xprt->snd_task == task) {
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100357 xprt_clear_locked(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 __xprt_lock_write_next(xprt);
359 }
360}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400361EXPORT_SYMBOL_GPL(xprt_release_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Chuck Lever49e9a892005-08-25 16:25:51 -0700363/**
364 * xprt_release_xprt_cong - allow other requests to use a transport
365 * @xprt: transport with other tasks potentially waiting
366 * @task: task that is releasing access to the transport
367 *
368 * Note that "task" can be NULL. Another task is awoken to use the
369 * transport if the transport's congestion window allows it.
370 */
371void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
372{
373 if (xprt->snd_task == task) {
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100374 xprt_clear_locked(xprt);
Chuck Lever49e9a892005-08-25 16:25:51 -0700375 __xprt_lock_write_next_cong(xprt);
376 }
377}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400378EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
Chuck Lever49e9a892005-08-25 16:25:51 -0700379
380static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Trond Myklebustbd79bc52018-09-07 19:38:55 -0400382 if (xprt->snd_task != task)
383 return;
Trond Myklebustb5e92412019-05-02 11:21:08 -0400384 spin_lock(&xprt->transport_lock);
Chuck Lever49e9a892005-08-25 16:25:51 -0700385 xprt->ops->release_xprt(xprt, task);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400386 spin_unlock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387}
388
389/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 * Van Jacobson congestion avoidance. Check if the congestion window
391 * overflowed. Put the task to sleep if this is the case.
392 */
393static int
Trond Myklebust75891f52018-09-03 17:37:36 -0400394__xprt_get_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 if (req->rq_cong)
397 return 1;
Chuck Lever46121cf2007-01-31 12:14:08 -0500398 dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
Trond Myklebust75891f52018-09-03 17:37:36 -0400399 req->rq_task->tk_pid, xprt->cong, xprt->cwnd);
400 if (RPCXPRT_CONGESTED(xprt)) {
401 xprt_set_congestion_window_wait(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 return 0;
Trond Myklebust75891f52018-09-03 17:37:36 -0400403 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 req->rq_cong = 1;
405 xprt->cong += RPC_CWNDSCALE;
406 return 1;
407}
408
409/*
410 * Adjust the congestion window, and wake up the next task
411 * that has been sleeping due to congestion
412 */
413static void
414__xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
415{
416 if (!req->rq_cong)
417 return;
418 req->rq_cong = 0;
419 xprt->cong -= RPC_CWNDSCALE;
Trond Myklebust75891f52018-09-03 17:37:36 -0400420 xprt_test_and_clear_congestion_window_wait(xprt);
Chuck Lever49e9a892005-08-25 16:25:51 -0700421 __xprt_lock_write_next_cong(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422}
423
Chuck Lever46c0ee82005-08-25 16:25:52 -0700424/**
Trond Myklebust75891f52018-09-03 17:37:36 -0400425 * xprt_request_get_cong - Request congestion control credits
426 * @xprt: pointer to transport
427 * @req: pointer to RPC request
428 *
429 * Useful for transports that require congestion control.
430 */
431bool
432xprt_request_get_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
433{
434 bool ret = false;
435
436 if (req->rq_cong)
437 return true;
Trond Myklebustb5e92412019-05-02 11:21:08 -0400438 spin_lock(&xprt->transport_lock);
Trond Myklebust75891f52018-09-03 17:37:36 -0400439 ret = __xprt_get_cong(xprt, req) != 0;
Trond Myklebustb5e92412019-05-02 11:21:08 -0400440 spin_unlock(&xprt->transport_lock);
Trond Myklebust75891f52018-09-03 17:37:36 -0400441 return ret;
442}
443EXPORT_SYMBOL_GPL(xprt_request_get_cong);
444
445/**
Chuck Levera58dd392005-08-25 16:25:53 -0700446 * xprt_release_rqst_cong - housekeeping when request is complete
447 * @task: RPC request that recently completed
448 *
449 * Useful for transports that require congestion control.
450 */
451void xprt_release_rqst_cong(struct rpc_task *task)
452{
Trond Myklebusta4f08352013-01-08 09:10:21 -0500453 struct rpc_rqst *req = task->tk_rqstp;
454
455 __xprt_put_cong(req->rq_xprt, req);
Chuck Levera58dd392005-08-25 16:25:53 -0700456}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400457EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
Chuck Levera58dd392005-08-25 16:25:53 -0700458
Trond Myklebust75891f52018-09-03 17:37:36 -0400459/*
460 * Clear the congestion window wait flag and wake up the next
461 * entry on xprt->sending
462 */
463static void
464xprt_clear_congestion_window_wait(struct rpc_xprt *xprt)
465{
466 if (test_and_clear_bit(XPRT_CWND_WAIT, &xprt->state)) {
Trond Myklebustb5e92412019-05-02 11:21:08 -0400467 spin_lock(&xprt->transport_lock);
Trond Myklebust75891f52018-09-03 17:37:36 -0400468 __xprt_lock_write_next_cong(xprt);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400469 spin_unlock(&xprt->transport_lock);
Trond Myklebust75891f52018-09-03 17:37:36 -0400470 }
471}
472
Chuck Levera58dd392005-08-25 16:25:53 -0700473/**
Chuck Lever46c0ee82005-08-25 16:25:52 -0700474 * xprt_adjust_cwnd - adjust transport congestion window
Trond Myklebust6a24dfb2013-01-08 09:48:15 -0500475 * @xprt: pointer to xprt
Chuck Lever46c0ee82005-08-25 16:25:52 -0700476 * @task: recently completed RPC request used to adjust window
477 * @result: result code of completed RPC request
478 *
Chuck Lever4f4cf5a2014-05-28 10:34:49 -0400479 * The transport code maintains an estimate on the maximum number of out-
480 * standing RPC requests, using a smoothed version of the congestion
481 * avoidance implemented in 44BSD. This is basically the Van Jacobson
482 * congestion algorithm: If a retransmit occurs, the congestion window is
483 * halved; otherwise, it is incremented by 1/cwnd when
484 *
485 * - a reply is received and
486 * - a full number of requests are outstanding and
487 * - the congestion window hasn't been updated recently.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 */
Trond Myklebust6a24dfb2013-01-08 09:48:15 -0500489void xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Chuck Lever46c0ee82005-08-25 16:25:52 -0700491 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever46c0ee82005-08-25 16:25:52 -0700492 unsigned long cwnd = xprt->cwnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 if (result >= 0 && cwnd <= xprt->cong) {
495 /* The (cwnd >> 1) term makes sure
496 * the result gets rounded properly. */
497 cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
498 if (cwnd > RPC_MAXCWND(xprt))
499 cwnd = RPC_MAXCWND(xprt);
Chuck Lever49e9a892005-08-25 16:25:51 -0700500 __xprt_lock_write_next_cong(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 } else if (result == -ETIMEDOUT) {
502 cwnd >>= 1;
503 if (cwnd < RPC_CWNDSCALE)
504 cwnd = RPC_CWNDSCALE;
505 }
Chuck Lever46121cf2007-01-31 12:14:08 -0500506 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 xprt->cong, xprt->cwnd, cwnd);
508 xprt->cwnd = cwnd;
Chuck Lever46c0ee82005-08-25 16:25:52 -0700509 __xprt_put_cong(xprt, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400511EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Chuck Lever44fbac22005-08-11 16:25:44 -0400513/**
514 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
515 * @xprt: transport with waiting tasks
516 * @status: result code to plant in each task before waking it
517 *
518 */
519void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
520{
521 if (status < 0)
522 rpc_wake_up_status(&xprt->pending, status);
523 else
524 rpc_wake_up(&xprt->pending);
525}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400526EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
Chuck Lever44fbac22005-08-11 16:25:44 -0400527
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400528/**
529 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
Trond Myklebustc5445772018-09-03 23:39:27 -0400530 * @xprt: transport
Trond Myklebusta9a6b522013-02-22 14:57:57 -0500531 *
532 * Note that we only set the timer for the case of RPC_IS_SOFT(), since
533 * we don't in general want to force a socket disconnection due to
534 * an incomplete RPC call transmission.
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400535 */
Trond Myklebustc5445772018-09-03 23:39:27 -0400536void xprt_wait_for_buffer_space(struct rpc_xprt *xprt)
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400537{
Trond Myklebustc5445772018-09-03 23:39:27 -0400538 set_bit(XPRT_WRITE_SPACE, &xprt->state);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400539}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400540EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400541
Trond Myklebustc5445772018-09-03 23:39:27 -0400542static bool
543xprt_clear_write_space_locked(struct rpc_xprt *xprt)
544{
545 if (test_and_clear_bit(XPRT_WRITE_SPACE, &xprt->state)) {
546 __xprt_lock_write_next(xprt);
547 dprintk("RPC: write space: waking waiting task on "
548 "xprt %p\n", xprt);
549 return true;
550 }
551 return false;
552}
553
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400554/**
555 * xprt_write_space - wake the task waiting for transport output buffer space
556 * @xprt: transport with waiting tasks
557 *
558 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
559 */
Trond Myklebustc5445772018-09-03 23:39:27 -0400560bool xprt_write_space(struct rpc_xprt *xprt)
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400561{
Trond Myklebustc5445772018-09-03 23:39:27 -0400562 bool ret;
563
564 if (!test_bit(XPRT_WRITE_SPACE, &xprt->state))
565 return false;
Trond Myklebustb5e92412019-05-02 11:21:08 -0400566 spin_lock(&xprt->transport_lock);
Trond Myklebustc5445772018-09-03 23:39:27 -0400567 ret = xprt_clear_write_space_locked(xprt);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400568 spin_unlock(&xprt->transport_lock);
Trond Myklebustc5445772018-09-03 23:39:27 -0400569 return ret;
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400570}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400571EXPORT_SYMBOL_GPL(xprt_write_space);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400572
Trond Myklebustda953062019-04-07 13:58:56 -0400573static unsigned long xprt_abs_ktime_to_jiffies(ktime_t abstime)
574{
575 s64 delta = ktime_to_ns(ktime_get() - abstime);
576 return likely(delta >= 0) ?
577 jiffies - nsecs_to_jiffies(delta) :
578 jiffies + nsecs_to_jiffies(-delta);
579}
580
581static unsigned long xprt_calc_majortimeo(struct rpc_rqst *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
Trond Myklebustba7392b2007-12-20 16:03:55 -0500583 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
Trond Myklebustda953062019-04-07 13:58:56 -0400584 unsigned long majortimeo = req->rq_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 if (to->to_exponential)
Trond Myklebustda953062019-04-07 13:58:56 -0400587 majortimeo <<= to->to_retries;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 else
Trond Myklebustda953062019-04-07 13:58:56 -0400589 majortimeo += to->to_increment * to->to_retries;
590 if (majortimeo > to->to_maxval || majortimeo == 0)
591 majortimeo = to->to_maxval;
592 return majortimeo;
593}
594
595static void xprt_reset_majortimeo(struct rpc_rqst *req)
596{
597 req->rq_majortimeo += xprt_calc_majortimeo(req);
598}
599
600static void xprt_init_majortimeo(struct rpc_task *task, struct rpc_rqst *req)
601{
602 unsigned long time_init;
603 struct rpc_xprt *xprt = req->rq_xprt;
604
605 if (likely(xprt && xprt_connected(xprt)))
606 time_init = jiffies;
607 else
608 time_init = xprt_abs_ktime_to_jiffies(task->tk_start);
609 req->rq_timeout = task->tk_client->cl_timeout->to_initval;
610 req->rq_majortimeo = time_init + xprt_calc_majortimeo(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611}
612
Chuck Lever9903cd12005-08-11 16:25:26 -0400613/**
614 * xprt_adjust_timeout - adjust timeout values for next retransmit
615 * @req: RPC request containing parameters to use for the adjustment
616 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 */
618int xprt_adjust_timeout(struct rpc_rqst *req)
619{
620 struct rpc_xprt *xprt = req->rq_xprt;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500621 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 int status = 0;
623
624 if (time_before(jiffies, req->rq_majortimeo)) {
625 if (to->to_exponential)
626 req->rq_timeout <<= 1;
627 else
628 req->rq_timeout += to->to_increment;
629 if (to->to_maxval && req->rq_timeout >= to->to_maxval)
630 req->rq_timeout = to->to_maxval;
631 req->rq_retries++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 } else {
633 req->rq_timeout = to->to_initval;
634 req->rq_retries = 0;
635 xprt_reset_majortimeo(req);
636 /* Reset the RTT counters == "slow start" */
Trond Myklebustb5e92412019-05-02 11:21:08 -0400637 spin_lock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400639 spin_unlock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 status = -ETIMEDOUT;
641 }
642
643 if (req->rq_timeout == 0) {
644 printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
645 req->rq_timeout = 5 * HZ;
646 }
647 return status;
648}
649
David Howells65f27f32006-11-22 14:55:48 +0000650static void xprt_autoclose(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
David Howells65f27f32006-11-22 14:55:48 +0000652 struct rpc_xprt *xprt =
653 container_of(work, struct rpc_xprt, task_cleanup);
Trond Myklebusta1231fd2019-02-18 10:02:29 -0500654 unsigned int pflags = memalloc_nofs_save();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Trond Myklebust66af1e552007-11-06 10:18:36 -0500656 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
Trond Myklebust4876cc72015-06-19 16:17:57 -0400657 xprt->ops->close(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 xprt_release_write(xprt, NULL);
Trond Myklebust79234c32015-09-18 15:53:24 -0400659 wake_up_bit(&xprt->state, XPRT_LOCKED);
Trond Myklebusta1231fd2019-02-18 10:02:29 -0500660 memalloc_nofs_restore(pflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
662
Chuck Lever9903cd12005-08-11 16:25:26 -0400663/**
Trond Myklebust62da3b22007-11-06 18:44:20 -0500664 * xprt_disconnect_done - mark a transport as disconnected
Chuck Lever9903cd12005-08-11 16:25:26 -0400665 * @xprt: transport to flag for disconnect
666 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 */
Trond Myklebust62da3b22007-11-06 18:44:20 -0500668void xprt_disconnect_done(struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669{
Chuck Lever46121cf2007-01-31 12:14:08 -0500670 dprintk("RPC: disconnected transport %p\n", xprt);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400671 spin_lock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 xprt_clear_connected(xprt);
Trond Myklebustc5445772018-09-03 23:39:27 -0400673 xprt_clear_write_space_locked(xprt);
Trond Myklebust27adc782019-03-15 08:01:16 -0400674 xprt_wake_pending_tasks(xprt, -ENOTCONN);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400675 spin_unlock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
Trond Myklebust62da3b22007-11-06 18:44:20 -0500677EXPORT_SYMBOL_GPL(xprt_disconnect_done);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Trond Myklebust66af1e552007-11-06 10:18:36 -0500679/**
680 * xprt_force_disconnect - force a transport to disconnect
681 * @xprt: transport to disconnect
682 *
683 */
684void xprt_force_disconnect(struct rpc_xprt *xprt)
685{
686 /* Don't race with the test_bit() in xprt_clear_locked() */
Trond Myklebustb5e92412019-05-02 11:21:08 -0400687 spin_lock(&xprt->transport_lock);
Trond Myklebust66af1e552007-11-06 10:18:36 -0500688 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
689 /* Try to schedule an autoclose RPC call */
690 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
Trond Myklebust40a5f1b2016-05-27 10:39:50 -0400691 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
Trond Myklebust0445f922018-12-17 13:34:59 -0500692 else if (xprt->snd_task)
693 rpc_wake_up_queued_task_set_status(&xprt->pending,
694 xprt->snd_task, -ENOTCONN);
Trond Myklebustb5e92412019-05-02 11:21:08 -0400695 spin_unlock(&xprt->transport_lock);
Trond Myklebust66af1e552007-11-06 10:18:36 -0500696}
Chuck Levere2a4f4f2017-04-11 13:22:38 -0400697EXPORT_SYMBOL_GPL(xprt_force_disconnect);
Trond Myklebust66af1e552007-11-06 10:18:36 -0500698
Trond Myklebust7f3a1d12018-08-23 00:03:43 -0400699static unsigned int
700xprt_connect_cookie(struct rpc_xprt *xprt)
701{
702 return READ_ONCE(xprt->connect_cookie);
703}
704
705static bool
706xprt_request_retransmit_after_disconnect(struct rpc_task *task)
707{
708 struct rpc_rqst *req = task->tk_rqstp;
709 struct rpc_xprt *xprt = req->rq_xprt;
710
711 return req->rq_connect_cookie != xprt_connect_cookie(xprt) ||
712 !xprt_connected(xprt);
713}
714
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400715/**
716 * xprt_conditional_disconnect - force a transport to disconnect
717 * @xprt: transport to disconnect
718 * @cookie: 'connection cookie'
719 *
720 * This attempts to break the connection if and only if 'cookie' matches
721 * the current transport 'connection cookie'. It ensures that we don't
722 * try to break the connection more than once when we need to retransmit
723 * a batch of RPC requests.
724 *
725 */
726void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
727{
728 /* Don't race with the test_bit() in xprt_clear_locked() */
Trond Myklebustb5e92412019-05-02 11:21:08 -0400729 spin_lock(&xprt->transport_lock);
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400730 if (cookie != xprt->connect_cookie)
731 goto out;
NeilBrown2c2ee6d2016-11-23 14:44:58 +1100732 if (test_bit(XPRT_CLOSING, &xprt->state))
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400733 goto out;
734 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
735 /* Try to schedule an autoclose RPC call */
736 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
Trond Myklebust40a5f1b2016-05-27 10:39:50 -0400737 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
Trond Myklebust2a491992009-03-11 14:38:00 -0400738 xprt_wake_pending_tasks(xprt, -EAGAIN);
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400739out:
Trond Myklebustb5e92412019-05-02 11:21:08 -0400740 spin_unlock(&xprt->transport_lock);
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400741}
742
Trond Myklebustad3331a2016-08-02 13:47:43 -0400743static bool
744xprt_has_timer(const struct rpc_xprt *xprt)
745{
746 return xprt->idle_timeout != 0;
747}
748
749static void
750xprt_schedule_autodisconnect(struct rpc_xprt *xprt)
751 __must_hold(&xprt->transport_lock)
752{
Dave Wysochanski80d3c452019-06-26 16:30:24 -0400753 xprt->last_used = jiffies;
Trond Myklebust95f76912018-09-07 08:35:22 -0400754 if (RB_EMPTY_ROOT(&xprt->recv_queue) && xprt_has_timer(xprt))
Trond Myklebustad3331a2016-08-02 13:47:43 -0400755 mod_timer(&xprt->timer, xprt->last_used + xprt->idle_timeout);
756}
757
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758static void
Kees Cookff861c42017-10-16 17:29:42 -0700759xprt_init_autodisconnect(struct timer_list *t)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760{
Kees Cookff861c42017-10-16 17:29:42 -0700761 struct rpc_xprt *xprt = from_timer(xprt, t, timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Trond Myklebust95f76912018-09-07 08:35:22 -0400763 if (!RB_EMPTY_ROOT(&xprt->recv_queue))
Trond Myklebustb5e92412019-05-02 11:21:08 -0400764 return;
Trond Myklebustad3331a2016-08-02 13:47:43 -0400765 /* Reset xprt->last_used to avoid connect/autodisconnect cycling */
766 xprt->last_used = jiffies;
Chuck Lever2226feb2005-08-11 16:25:38 -0400767 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
Trond Myklebustb5e92412019-05-02 11:21:08 -0400768 return;
Trond Myklebust40a5f1b2016-05-27 10:39:50 -0400769 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770}
771
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500772bool xprt_lock_connect(struct rpc_xprt *xprt,
773 struct rpc_task *task,
774 void *cookie)
775{
776 bool ret = false;
777
Trond Myklebustb5e92412019-05-02 11:21:08 -0400778 spin_lock(&xprt->transport_lock);
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500779 if (!test_bit(XPRT_LOCKED, &xprt->state))
780 goto out;
781 if (xprt->snd_task != task)
782 goto out;
783 xprt->snd_task = cookie;
784 ret = true;
785out:
Trond Myklebustb5e92412019-05-02 11:21:08 -0400786 spin_unlock(&xprt->transport_lock);
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500787 return ret;
788}
789
790void xprt_unlock_connect(struct rpc_xprt *xprt, void *cookie)
791{
Trond Myklebustb5e92412019-05-02 11:21:08 -0400792 spin_lock(&xprt->transport_lock);
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500793 if (xprt->snd_task != cookie)
794 goto out;
795 if (!test_bit(XPRT_LOCKED, &xprt->state))
796 goto out;
797 xprt->snd_task =NULL;
798 xprt->ops->release_xprt(xprt, NULL);
Trond Myklebustad3331a2016-08-02 13:47:43 -0400799 xprt_schedule_autodisconnect(xprt);
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500800out:
Trond Myklebustb5e92412019-05-02 11:21:08 -0400801 spin_unlock(&xprt->transport_lock);
Trond Myklebust79234c32015-09-18 15:53:24 -0400802 wake_up_bit(&xprt->state, XPRT_LOCKED);
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500803}
804
Chuck Lever9903cd12005-08-11 16:25:26 -0400805/**
806 * xprt_connect - schedule a transport connect operation
807 * @task: RPC task that is requesting the connect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 *
809 */
810void xprt_connect(struct rpc_task *task)
811{
Trond Myklebustad2368d2013-01-08 10:08:33 -0500812 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Chuck Lever46121cf2007-01-31 12:14:08 -0500814 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 xprt, (xprt_connected(xprt) ? "is" : "is not"));
816
Chuck Leverec739ef2006-08-22 20:06:15 -0400817 if (!xprt_bound(xprt)) {
Trond Myklebust01d37c42009-03-11 14:09:39 -0400818 task->tk_status = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 return;
820 }
821 if (!xprt_lock_write(xprt, task))
822 return;
Trond Myklebustfeb8ca32009-12-03 08:10:17 -0500823
824 if (test_and_clear_bit(XPRT_CLOSE_WAIT, &xprt->state))
825 xprt->ops->close(xprt);
826
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500827 if (!xprt_connected(xprt)) {
NeilBrown2c2ee6d2016-11-23 14:44:58 +1100828 task->tk_rqstp->rq_connect_cookie = xprt->connect_cookie;
Trond Myklebust6b2e6852019-04-07 13:58:49 -0400829 rpc_sleep_on_timeout(&xprt->pending, task, NULL,
Trond Myklebust9e910bf2019-04-07 13:58:53 -0400830 xprt_request_timeout(task->tk_rqstp));
Trond Myklebust0b9e7942010-04-16 16:41:57 -0400831
832 if (test_bit(XPRT_CLOSING, &xprt->state))
833 return;
834 if (xprt_test_and_set_connecting(xprt))
835 return;
Trond Myklebust0a9a4302018-12-01 23:18:00 -0500836 /* Race breaker */
837 if (!xprt_connected(xprt)) {
838 xprt->stat.connect_start = jiffies;
839 xprt->ops->connect(xprt, task);
840 } else {
841 xprt_clear_connecting(xprt);
842 task->tk_status = 0;
843 rpc_wake_up_queued_task(&xprt->pending, task);
844 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 }
Trond Myklebust718ba5b2015-02-08 18:19:25 -0500846 xprt_release_write(xprt, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847}
848
Chuck Lever675dd902019-06-19 10:33:42 -0400849/**
850 * xprt_reconnect_delay - compute the wait before scheduling a connect
851 * @xprt: transport instance
852 *
853 */
854unsigned long xprt_reconnect_delay(const struct rpc_xprt *xprt)
855{
856 unsigned long start, now = jiffies;
857
858 start = xprt->stat.connect_start + xprt->reestablish_timeout;
859 if (time_after(start, now))
860 return start - now;
861 return 0;
862}
863EXPORT_SYMBOL_GPL(xprt_reconnect_delay);
864
865/**
866 * xprt_reconnect_backoff - compute the new re-establish timeout
867 * @xprt: transport instance
868 * @init_to: initial reestablish timeout
869 *
870 */
871void xprt_reconnect_backoff(struct rpc_xprt *xprt, unsigned long init_to)
872{
873 xprt->reestablish_timeout <<= 1;
874 if (xprt->reestablish_timeout > xprt->max_reconnect_timeout)
875 xprt->reestablish_timeout = xprt->max_reconnect_timeout;
876 if (xprt->reestablish_timeout < init_to)
877 xprt->reestablish_timeout = init_to;
878}
879EXPORT_SYMBOL_GPL(xprt_reconnect_backoff);
880
Trond Myklebust95f76912018-09-07 08:35:22 -0400881enum xprt_xid_rb_cmp {
882 XID_RB_EQUAL,
883 XID_RB_LEFT,
884 XID_RB_RIGHT,
885};
886static enum xprt_xid_rb_cmp
887xprt_xid_cmp(__be32 xid1, __be32 xid2)
888{
889 if (xid1 == xid2)
890 return XID_RB_EQUAL;
891 if ((__force u32)xid1 < (__force u32)xid2)
892 return XID_RB_LEFT;
893 return XID_RB_RIGHT;
894}
895
896static struct rpc_rqst *
897xprt_request_rb_find(struct rpc_xprt *xprt, __be32 xid)
898{
899 struct rb_node *n = xprt->recv_queue.rb_node;
900 struct rpc_rqst *req;
901
902 while (n != NULL) {
903 req = rb_entry(n, struct rpc_rqst, rq_recv);
904 switch (xprt_xid_cmp(xid, req->rq_xid)) {
905 case XID_RB_LEFT:
906 n = n->rb_left;
907 break;
908 case XID_RB_RIGHT:
909 n = n->rb_right;
910 break;
911 case XID_RB_EQUAL:
912 return req;
913 }
914 }
915 return NULL;
916}
917
918static void
919xprt_request_rb_insert(struct rpc_xprt *xprt, struct rpc_rqst *new)
920{
921 struct rb_node **p = &xprt->recv_queue.rb_node;
922 struct rb_node *n = NULL;
923 struct rpc_rqst *req;
924
925 while (*p != NULL) {
926 n = *p;
927 req = rb_entry(n, struct rpc_rqst, rq_recv);
928 switch(xprt_xid_cmp(new->rq_xid, req->rq_xid)) {
929 case XID_RB_LEFT:
930 p = &n->rb_left;
931 break;
932 case XID_RB_RIGHT:
933 p = &n->rb_right;
934 break;
935 case XID_RB_EQUAL:
936 WARN_ON_ONCE(new != req);
937 return;
938 }
939 }
940 rb_link_node(&new->rq_recv, n, p);
941 rb_insert_color(&new->rq_recv, &xprt->recv_queue);
942}
943
944static void
945xprt_request_rb_remove(struct rpc_xprt *xprt, struct rpc_rqst *req)
946{
947 rb_erase(&req->rq_recv, &xprt->recv_queue);
948}
949
Chuck Lever9903cd12005-08-11 16:25:26 -0400950/**
951 * xprt_lookup_rqst - find an RPC request corresponding to an XID
952 * @xprt: transport on which the original request was transmitted
953 * @xid: RPC XID of incoming reply
954 *
Trond Myklebust75c84152018-08-31 10:21:00 -0400955 * Caller holds xprt->queue_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700957struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958{
Pavel Emelyanov8f3a6de2010-10-05 23:30:19 +0400959 struct rpc_rqst *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
Trond Myklebust95f76912018-09-07 08:35:22 -0400961 entry = xprt_request_rb_find(xprt, xid);
962 if (entry != NULL) {
963 trace_xprt_lookup_rqst(xprt, xid, 0);
964 entry->rq_rtt = ktime_sub(ktime_get(), entry->rq_xtime);
965 return entry;
966 }
Chuck Lever46121cf2007-01-31 12:14:08 -0500967
968 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
969 ntohl(xid));
Jeff Layton3705ad62014-10-28 14:24:13 -0400970 trace_xprt_lookup_rqst(xprt, xid, -ENOENT);
Chuck Lever262ca072006-03-20 13:44:16 -0500971 xprt->stat.bad_xids++;
972 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400974EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Trond Myklebustcf9946c2018-08-06 12:55:34 -0400976static bool
977xprt_is_pinned_rqst(struct rpc_rqst *req)
978{
979 return atomic_read(&req->rq_pin) != 0;
980}
981
Trond Myklebust729749b2017-08-13 10:03:59 -0400982/**
983 * xprt_pin_rqst - Pin a request on the transport receive list
984 * @req: Request to pin
985 *
986 * Caller must ensure this is atomic with the call to xprt_lookup_rqst()
Chuck Lever1f7d1c72019-04-24 09:40:09 -0400987 * so should be holding xprt->queue_lock.
Trond Myklebust729749b2017-08-13 10:03:59 -0400988 */
989void xprt_pin_rqst(struct rpc_rqst *req)
990{
Trond Myklebustcf9946c2018-08-06 12:55:34 -0400991 atomic_inc(&req->rq_pin);
Trond Myklebust729749b2017-08-13 10:03:59 -0400992}
Chuck Lever9590d082017-08-23 17:05:58 -0400993EXPORT_SYMBOL_GPL(xprt_pin_rqst);
Trond Myklebust729749b2017-08-13 10:03:59 -0400994
995/**
996 * xprt_unpin_rqst - Unpin a request on the transport receive list
997 * @req: Request to pin
998 *
Chuck Lever1f7d1c72019-04-24 09:40:09 -0400999 * Caller should be holding xprt->queue_lock.
Trond Myklebust729749b2017-08-13 10:03:59 -04001000 */
1001void xprt_unpin_rqst(struct rpc_rqst *req)
1002{
Trond Myklebustcf9946c2018-08-06 12:55:34 -04001003 if (!test_bit(RPC_TASK_MSG_PIN_WAIT, &req->rq_task->tk_runstate)) {
1004 atomic_dec(&req->rq_pin);
1005 return;
1006 }
1007 if (atomic_dec_and_test(&req->rq_pin))
1008 wake_up_var(&req->rq_pin);
Trond Myklebust729749b2017-08-13 10:03:59 -04001009}
Chuck Lever9590d082017-08-23 17:05:58 -04001010EXPORT_SYMBOL_GPL(xprt_unpin_rqst);
Trond Myklebust729749b2017-08-13 10:03:59 -04001011
1012static void xprt_wait_on_pinned_rqst(struct rpc_rqst *req)
Trond Myklebust729749b2017-08-13 10:03:59 -04001013{
Trond Myklebustcf9946c2018-08-06 12:55:34 -04001014 wait_var_event(&req->rq_pin, !xprt_is_pinned_rqst(req));
Trond Myklebust729749b2017-08-13 10:03:59 -04001015}
1016
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001017static bool
1018xprt_request_data_received(struct rpc_task *task)
1019{
1020 return !test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate) &&
1021 READ_ONCE(task->tk_rqstp->rq_reply_bytes_recvd) != 0;
1022}
1023
1024static bool
1025xprt_request_need_enqueue_receive(struct rpc_task *task, struct rpc_rqst *req)
1026{
1027 return !test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate) &&
1028 READ_ONCE(task->tk_rqstp->rq_reply_bytes_recvd) == 0;
1029}
1030
1031/**
1032 * xprt_request_enqueue_receive - Add an request to the receive queue
1033 * @task: RPC task
1034 *
1035 */
1036void
1037xprt_request_enqueue_receive(struct rpc_task *task)
1038{
1039 struct rpc_rqst *req = task->tk_rqstp;
1040 struct rpc_xprt *xprt = req->rq_xprt;
1041
1042 if (!xprt_request_need_enqueue_receive(task, req))
1043 return;
Trond Myklebust75369082019-07-17 21:22:38 -04001044
1045 xprt_request_prepare(task->tk_rqstp);
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001046 spin_lock(&xprt->queue_lock);
1047
1048 /* Update the softirq receive buffer */
1049 memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
1050 sizeof(req->rq_private_buf));
1051
1052 /* Add request to the receive list */
Trond Myklebust95f76912018-09-07 08:35:22 -04001053 xprt_request_rb_insert(xprt, req);
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001054 set_bit(RPC_TASK_NEED_RECV, &task->tk_runstate);
1055 spin_unlock(&xprt->queue_lock);
1056
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001057 /* Turn off autodisconnect */
1058 del_singleshot_timer_sync(&xprt->timer);
1059}
1060
1061/**
1062 * xprt_request_dequeue_receive_locked - Remove a request from the receive queue
1063 * @task: RPC task
1064 *
1065 * Caller must hold xprt->queue_lock.
1066 */
1067static void
1068xprt_request_dequeue_receive_locked(struct rpc_task *task)
1069{
Trond Myklebust95f76912018-09-07 08:35:22 -04001070 struct rpc_rqst *req = task->tk_rqstp;
1071
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001072 if (test_and_clear_bit(RPC_TASK_NEED_RECV, &task->tk_runstate))
Trond Myklebust95f76912018-09-07 08:35:22 -04001073 xprt_request_rb_remove(req->rq_xprt, req);
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001074}
1075
Chuck Leverecd465e2018-03-05 15:12:57 -05001076/**
1077 * xprt_update_rtt - Update RPC RTT statistics
1078 * @task: RPC request that recently completed
1079 *
Trond Myklebust75c84152018-08-31 10:21:00 -04001080 * Caller holds xprt->queue_lock.
Chuck Leverecd465e2018-03-05 15:12:57 -05001081 */
1082void xprt_update_rtt(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083{
Chuck Lever1570c1e2005-08-25 16:25:52 -07001084 struct rpc_rqst *req = task->tk_rqstp;
1085 struct rpc_rtt *rtt = task->tk_client->cl_rtt;
Eric Dumazet95c96172012-04-15 05:58:06 +00001086 unsigned int timer = task->tk_msg.rpc_proc->p_timer;
Trond Myklebustd60dbb22010-05-13 12:51:49 -04001087 long m = usecs_to_jiffies(ktime_to_us(req->rq_rtt));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
Chuck Lever1570c1e2005-08-25 16:25:52 -07001089 if (timer) {
1090 if (req->rq_ntrans == 1)
Chuck Leverff839972010-05-07 13:34:47 -04001091 rpc_update_rtt(rtt, timer, m);
Chuck Lever1570c1e2005-08-25 16:25:52 -07001092 rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
Chuck Lever1570c1e2005-08-25 16:25:52 -07001094}
Chuck Leverecd465e2018-03-05 15:12:57 -05001095EXPORT_SYMBOL_GPL(xprt_update_rtt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Chuck Lever1570c1e2005-08-25 16:25:52 -07001097/**
1098 * xprt_complete_rqst - called when reply processing is complete
1099 * @task: RPC request that recently completed
1100 * @copied: actual number of bytes received from the transport
1101 *
Trond Myklebust75c84152018-08-31 10:21:00 -04001102 * Caller holds xprt->queue_lock.
Chuck Lever1570c1e2005-08-25 16:25:52 -07001103 */
1104void xprt_complete_rqst(struct rpc_task *task, int copied)
1105{
1106 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebustfda13932008-02-22 16:34:12 -05001107 struct rpc_xprt *xprt = req->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108
Chuck Lever1570c1e2005-08-25 16:25:52 -07001109 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
1110 task->tk_pid, ntohl(req->rq_xid), copied);
Jeff Layton3705ad62014-10-28 14:24:13 -04001111 trace_xprt_complete_rqst(xprt, req->rq_xid, copied);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112
Trond Myklebustfda13932008-02-22 16:34:12 -05001113 xprt->stat.recvs++;
Chuck Leveref759a22006-03-20 13:44:17 -05001114
Trond Myklebust1e799b62008-03-21 16:19:41 -04001115 req->rq_private_buf.len = copied;
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001116 /* Ensure all writes are done before we update */
1117 /* req->rq_reply_bytes_recvd */
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001118 smp_wmb();
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001119 req->rq_reply_bytes_recvd = copied;
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001120 xprt_request_dequeue_receive_locked(task);
Trond Myklebustfda13932008-02-22 16:34:12 -05001121 rpc_wake_up_queued_task(&xprt->pending, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -04001123EXPORT_SYMBOL_GPL(xprt_complete_rqst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
Chuck Lever46c0ee82005-08-25 16:25:52 -07001125static void xprt_timer(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126{
Chuck Lever46c0ee82005-08-25 16:25:52 -07001127 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 struct rpc_xprt *xprt = req->rq_xprt;
1129
Trond Myklebust5d008372008-02-22 16:34:17 -05001130 if (task->tk_status != -ETIMEDOUT)
1131 return;
Chuck Lever46c0ee82005-08-25 16:25:52 -07001132
Chuck Lever82476d92018-01-03 15:38:25 -05001133 trace_xprt_timer(xprt, req->rq_xid, task->tk_status);
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001134 if (!req->rq_reply_bytes_recvd) {
Chuck Lever46c0ee82005-08-25 16:25:52 -07001135 if (xprt->ops->timer)
Trond Myklebust6a24dfb2013-01-08 09:48:15 -05001136 xprt->ops->timer(xprt, task);
Trond Myklebust5d008372008-02-22 16:34:17 -05001137 } else
1138 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139}
1140
Chuck Lever9903cd12005-08-11 16:25:26 -04001141/**
Trond Myklebust8ba6a922019-04-07 13:58:46 -04001142 * xprt_wait_for_reply_request_def - wait for reply
1143 * @task: pointer to rpc_task
1144 *
1145 * Set a request's retransmit timeout based on the transport's
1146 * default timeout parameters. Used by transports that don't adjust
1147 * the retransmit timeout based on round-trip time estimation,
1148 * and put the task to sleep on the pending queue.
1149 */
1150void xprt_wait_for_reply_request_def(struct rpc_task *task)
1151{
1152 struct rpc_rqst *req = task->tk_rqstp;
1153
Trond Myklebust6b2e6852019-04-07 13:58:49 -04001154 rpc_sleep_on_timeout(&req->rq_xprt->pending, task, xprt_timer,
Trond Myklebust9e910bf2019-04-07 13:58:53 -04001155 xprt_request_timeout(req));
Trond Myklebust8ba6a922019-04-07 13:58:46 -04001156}
1157EXPORT_SYMBOL_GPL(xprt_wait_for_reply_request_def);
1158
1159/**
1160 * xprt_wait_for_reply_request_rtt - wait for reply using RTT estimator
1161 * @task: pointer to rpc_task
1162 *
1163 * Set a request's retransmit timeout using the RTT estimator,
1164 * and put the task to sleep on the pending queue.
1165 */
1166void xprt_wait_for_reply_request_rtt(struct rpc_task *task)
1167{
1168 int timer = task->tk_msg.rpc_proc->p_timer;
1169 struct rpc_clnt *clnt = task->tk_client;
1170 struct rpc_rtt *rtt = clnt->cl_rtt;
1171 struct rpc_rqst *req = task->tk_rqstp;
1172 unsigned long max_timeout = clnt->cl_timeout->to_maxval;
Trond Myklebust6b2e6852019-04-07 13:58:49 -04001173 unsigned long timeout;
Trond Myklebust8ba6a922019-04-07 13:58:46 -04001174
Trond Myklebust6b2e6852019-04-07 13:58:49 -04001175 timeout = rpc_calc_rto(rtt, timer);
1176 timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
1177 if (timeout > max_timeout || timeout == 0)
1178 timeout = max_timeout;
1179 rpc_sleep_on_timeout(&req->rq_xprt->pending, task, xprt_timer,
1180 jiffies + timeout);
Trond Myklebust8ba6a922019-04-07 13:58:46 -04001181}
1182EXPORT_SYMBOL_GPL(xprt_wait_for_reply_request_rtt);
1183
1184/**
Trond Myklebust7f3a1d12018-08-23 00:03:43 -04001185 * xprt_request_wait_receive - wait for the reply to an RPC request
1186 * @task: RPC task about to send a request
1187 *
1188 */
1189void xprt_request_wait_receive(struct rpc_task *task)
1190{
1191 struct rpc_rqst *req = task->tk_rqstp;
1192 struct rpc_xprt *xprt = req->rq_xprt;
1193
1194 if (!test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate))
1195 return;
1196 /*
1197 * Sleep on the pending queue if we're expecting a reply.
1198 * The spinlock ensures atomicity between the test of
1199 * req->rq_reply_bytes_recvd, and the call to rpc_sleep_on().
1200 */
1201 spin_lock(&xprt->queue_lock);
1202 if (test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate)) {
Trond Myklebust8ba6a922019-04-07 13:58:46 -04001203 xprt->ops->wait_for_reply_request(task);
Trond Myklebust7f3a1d12018-08-23 00:03:43 -04001204 /*
1205 * Send an extra queue wakeup call if the
1206 * connection was dropped in case the call to
1207 * rpc_sleep_on() raced.
1208 */
1209 if (xprt_request_retransmit_after_disconnect(task))
1210 rpc_wake_up_queued_task_set_status(&xprt->pending,
1211 task, -ENOTCONN);
1212 }
1213 spin_unlock(&xprt->queue_lock);
1214}
1215
Trond Myklebust944b0422018-08-09 23:33:21 -04001216static bool
Trond Myklebust944b0422018-08-09 23:33:21 -04001217xprt_request_need_enqueue_transmit(struct rpc_task *task, struct rpc_rqst *req)
1218{
Trond Myklebust762e4e62018-08-24 16:28:28 -04001219 return !test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate);
Trond Myklebust944b0422018-08-09 23:33:21 -04001220}
1221
1222/**
1223 * xprt_request_enqueue_transmit - queue a task for transmission
1224 * @task: pointer to rpc_task
1225 *
1226 * Add a task to the transmission queue.
1227 */
1228void
1229xprt_request_enqueue_transmit(struct rpc_task *task)
1230{
Trond Myklebust918f3c12018-09-09 11:37:22 -04001231 struct rpc_rqst *pos, *req = task->tk_rqstp;
Trond Myklebust944b0422018-08-09 23:33:21 -04001232 struct rpc_xprt *xprt = req->rq_xprt;
1233
1234 if (xprt_request_need_enqueue_transmit(task, req)) {
Trond Myklebuste66721f2019-01-02 17:53:10 -05001235 req->rq_bytes_sent = 0;
Trond Myklebust944b0422018-08-09 23:33:21 -04001236 spin_lock(&xprt->queue_lock);
Trond Myklebust75891f52018-09-03 17:37:36 -04001237 /*
1238 * Requests that carry congestion control credits are added
1239 * to the head of the list to avoid starvation issues.
1240 */
1241 if (req->rq_cong) {
1242 xprt_clear_congestion_window_wait(xprt);
1243 list_for_each_entry(pos, &xprt->xmit_queue, rq_xmit) {
1244 if (pos->rq_cong)
1245 continue;
1246 /* Note: req is added _before_ pos */
1247 list_add_tail(&req->rq_xmit, &pos->rq_xmit);
1248 INIT_LIST_HEAD(&req->rq_xmit2);
Chuck Lever0c776682019-02-11 11:25:04 -05001249 trace_xprt_enq_xmit(task, 1);
Trond Myklebust75891f52018-09-03 17:37:36 -04001250 goto out;
1251 }
Trond Myklebust86aeee02018-09-08 14:22:41 -04001252 } else if (RPC_IS_SWAPPER(task)) {
1253 list_for_each_entry(pos, &xprt->xmit_queue, rq_xmit) {
1254 if (pos->rq_cong || pos->rq_bytes_sent)
1255 continue;
1256 if (RPC_IS_SWAPPER(pos->rq_task))
1257 continue;
1258 /* Note: req is added _before_ pos */
1259 list_add_tail(&req->rq_xmit, &pos->rq_xmit);
1260 INIT_LIST_HEAD(&req->rq_xmit2);
Chuck Lever0c776682019-02-11 11:25:04 -05001261 trace_xprt_enq_xmit(task, 2);
Trond Myklebust86aeee02018-09-08 14:22:41 -04001262 goto out;
1263 }
Chuck Leverdeaa5c92019-01-09 10:04:57 -05001264 } else if (!req->rq_seqno) {
Trond Myklebust75891f52018-09-03 17:37:36 -04001265 list_for_each_entry(pos, &xprt->xmit_queue, rq_xmit) {
1266 if (pos->rq_task->tk_owner != task->tk_owner)
1267 continue;
1268 list_add_tail(&req->rq_xmit2, &pos->rq_xmit2);
1269 INIT_LIST_HEAD(&req->rq_xmit);
Chuck Lever0c776682019-02-11 11:25:04 -05001270 trace_xprt_enq_xmit(task, 3);
Trond Myklebust75891f52018-09-03 17:37:36 -04001271 goto out;
1272 }
Trond Myklebust918f3c12018-09-09 11:37:22 -04001273 }
Trond Myklebust944b0422018-08-09 23:33:21 -04001274 list_add_tail(&req->rq_xmit, &xprt->xmit_queue);
Trond Myklebust918f3c12018-09-09 11:37:22 -04001275 INIT_LIST_HEAD(&req->rq_xmit2);
Chuck Lever0c776682019-02-11 11:25:04 -05001276 trace_xprt_enq_xmit(task, 4);
Trond Myklebust918f3c12018-09-09 11:37:22 -04001277out:
Trond Myklebust944b0422018-08-09 23:33:21 -04001278 set_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate);
1279 spin_unlock(&xprt->queue_lock);
1280 }
1281}
1282
1283/**
1284 * xprt_request_dequeue_transmit_locked - remove a task from the transmission queue
1285 * @task: pointer to rpc_task
1286 *
1287 * Remove a task from the transmission queue
1288 * Caller must hold xprt->queue_lock
1289 */
1290static void
1291xprt_request_dequeue_transmit_locked(struct rpc_task *task)
1292{
Trond Myklebust918f3c12018-09-09 11:37:22 -04001293 struct rpc_rqst *req = task->tk_rqstp;
1294
1295 if (!test_and_clear_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
1296 return;
1297 if (!list_empty(&req->rq_xmit)) {
1298 list_del(&req->rq_xmit);
1299 if (!list_empty(&req->rq_xmit2)) {
1300 struct rpc_rqst *next = list_first_entry(&req->rq_xmit2,
1301 struct rpc_rqst, rq_xmit2);
1302 list_del(&req->rq_xmit2);
1303 list_add_tail(&next->rq_xmit, &next->rq_xprt->xmit_queue);
1304 }
1305 } else
1306 list_del(&req->rq_xmit2);
Trond Myklebust944b0422018-08-09 23:33:21 -04001307}
1308
1309/**
1310 * xprt_request_dequeue_transmit - remove a task from the transmission queue
1311 * @task: pointer to rpc_task
1312 *
1313 * Remove a task from the transmission queue
1314 */
1315static void
1316xprt_request_dequeue_transmit(struct rpc_task *task)
1317{
1318 struct rpc_rqst *req = task->tk_rqstp;
1319 struct rpc_xprt *xprt = req->rq_xprt;
1320
1321 spin_lock(&xprt->queue_lock);
1322 xprt_request_dequeue_transmit_locked(task);
1323 spin_unlock(&xprt->queue_lock);
1324}
1325
Trond Myklebust7f3a1d12018-08-23 00:03:43 -04001326/**
Trond Myklebust9d96acb2018-09-13 12:22:04 -04001327 * xprt_request_prepare - prepare an encoded request for transport
1328 * @req: pointer to rpc_rqst
1329 *
1330 * Calls into the transport layer to do whatever is needed to prepare
1331 * the request for transmission or receive.
1332 */
1333void
1334xprt_request_prepare(struct rpc_rqst *req)
1335{
1336 struct rpc_xprt *xprt = req->rq_xprt;
1337
1338 if (xprt->ops->prepare_request)
1339 xprt->ops->prepare_request(req);
1340}
1341
1342/**
Trond Myklebust762e4e62018-08-24 16:28:28 -04001343 * xprt_request_need_retransmit - Test if a task needs retransmission
1344 * @task: pointer to rpc_task
1345 *
1346 * Test for whether a connection breakage requires the task to retransmit
1347 */
1348bool
1349xprt_request_need_retransmit(struct rpc_task *task)
1350{
1351 return xprt_request_retransmit_after_disconnect(task);
1352}
1353
1354/**
Chuck Lever9903cd12005-08-11 16:25:26 -04001355 * xprt_prepare_transmit - reserve the transport before sending a request
1356 * @task: RPC task about to send a request
1357 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 */
Trond Myklebust90051ea2013-09-25 12:17:18 -04001359bool xprt_prepare_transmit(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
1361 struct rpc_rqst *req = task->tk_rqstp;
1362 struct rpc_xprt *xprt = req->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
Chuck Lever46121cf2007-01-31 12:14:08 -05001364 dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
Trond Myklebust5f2f6bd2018-09-01 14:25:24 -04001366 if (!xprt_lock_write(xprt, task)) {
1367 /* Race breaker: someone may have transmitted us */
Trond Myklebust944b0422018-08-09 23:33:21 -04001368 if (!test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
Trond Myklebust5f2f6bd2018-09-01 14:25:24 -04001369 rpc_wake_up_queued_task_set_status(&xprt->sending,
1370 task, 0);
1371 return false;
1372
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
Trond Myklebust5f2f6bd2018-09-01 14:25:24 -04001374 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375}
1376
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001377void xprt_end_transmit(struct rpc_task *task)
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001378{
Rahul Iyer343952f2009-04-01 09:23:17 -04001379 xprt_release_write(task->tk_rqstp->rq_xprt, task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001380}
1381
Chuck Lever9903cd12005-08-11 16:25:26 -04001382/**
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001383 * xprt_request_transmit - send an RPC request on a transport
1384 * @req: pointer to request to transmit
1385 * @snd_task: RPC task that owns the transport lock
Chuck Lever9903cd12005-08-11 16:25:26 -04001386 *
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001387 * This performs the transmission of a single request.
1388 * Note that if the request is not the same as snd_task, then it
1389 * does need to be pinned.
1390 * Returns '0' on success.
Chuck Lever9903cd12005-08-11 16:25:26 -04001391 */
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001392static int
1393xprt_request_transmit(struct rpc_rqst *req, struct rpc_task *snd_task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394{
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001395 struct rpc_xprt *xprt = req->rq_xprt;
1396 struct rpc_task *task = req->rq_task;
Trond Myklebust90d91b02017-12-14 21:24:08 -05001397 unsigned int connect_cookie;
Trond Myklebustdcbbeda2018-09-01 14:29:18 -04001398 int is_retrans = RPC_WAS_SENT(task);
Chuck Leverff699ea82018-03-05 15:13:13 -05001399 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001401 if (!req->rq_bytes_sent) {
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001402 if (xprt_request_data_received(task)) {
1403 status = 0;
Trond Myklebust944b0422018-08-09 23:33:21 -04001404 goto out_dequeue;
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001405 }
Trond Myklebust3021a5bb2018-08-14 13:50:21 -04001406 /* Verify that our message lies in the RPCSEC_GSS window */
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001407 if (rpcauth_xmit_need_reencode(task)) {
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001408 status = -EBADMSG;
Trond Myklebust944b0422018-08-09 23:33:21 -04001409 goto out_dequeue;
Trond Myklebust3021a5bb2018-08-14 13:50:21 -04001410 }
Trond Myklebusta79f1942019-02-27 15:37:36 -05001411 if (task->tk_ops->rpc_call_prepare_transmit) {
1412 task->tk_ops->rpc_call_prepare_transmit(task,
1413 task->tk_calldata);
1414 status = task->tk_status;
1415 if (status < 0)
1416 goto out_dequeue;
1417 }
Trond Myklebustae67bd32019-04-07 13:58:44 -04001418 if (RPC_SIGNALLED(task)) {
1419 status = -ERESTARTSYS;
1420 goto out_dequeue;
1421 }
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
Trond Myklebustdcbbeda2018-09-01 14:29:18 -04001424 /*
1425 * Update req->rq_ntrans before transmitting to avoid races with
1426 * xprt_update_rtt(), which needs to know that it is recording a
1427 * reply to the first transmission.
1428 */
1429 req->rq_ntrans++;
1430
Trond Myklebust90d91b02017-12-14 21:24:08 -05001431 connect_cookie = xprt->connect_cookie;
Trond Myklebustadfa7142018-09-03 23:58:59 -04001432 status = xprt->ops->send_request(req);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001433 if (status != 0) {
Trond Myklebustdcbbeda2018-09-01 14:29:18 -04001434 req->rq_ntrans--;
Chuck Lever0c776682019-02-11 11:25:04 -05001435 trace_xprt_transmit(req, status);
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001436 return status;
Chuck Leverfe3aca22005-08-25 16:25:50 -07001437 }
Trond Myklebust7ebbbc62018-08-28 09:00:27 -04001438
Trond Myklebustdcbbeda2018-09-01 14:29:18 -04001439 if (is_retrans)
1440 task->tk_client->cl_stats->rpcretrans++;
1441
Chuck Lever4a068252015-05-11 14:02:25 -04001442 xprt_inject_disconnect(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
Bryan Schumaker468f8612011-04-18 15:57:32 -04001444 task->tk_flags |= RPC_TASK_SENT;
Trond Myklebustb5e92412019-05-02 11:21:08 -04001445 spin_lock(&xprt->transport_lock);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001446
Trond Myklebustc8485e42009-03-11 14:37:59 -04001447 xprt->stat.sends++;
1448 xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
1449 xprt->stat.bklog_u += xprt->backlog.qlen;
Andy Adamson15a45202012-02-14 16:19:18 -05001450 xprt->stat.sending_u += xprt->sending.qlen;
1451 xprt->stat.pending_u += xprt->pending.qlen;
Trond Myklebustb5e92412019-05-02 11:21:08 -04001452 spin_unlock(&xprt->transport_lock);
Trond Myklebust90d91b02017-12-14 21:24:08 -05001453
1454 req->rq_connect_cookie = connect_cookie;
Trond Myklebust944b0422018-08-09 23:33:21 -04001455out_dequeue:
Chuck Lever0c776682019-02-11 11:25:04 -05001456 trace_xprt_transmit(req, status);
Trond Myklebust944b0422018-08-09 23:33:21 -04001457 xprt_request_dequeue_transmit(task);
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001458 rpc_wake_up_queued_task_set_status(&xprt->sending, task, status);
1459 return status;
1460}
1461
1462/**
1463 * xprt_transmit - send an RPC request on a transport
1464 * @task: controlling RPC task
1465 *
1466 * Attempts to drain the transmit queue. On exit, either the transport
1467 * signalled an error that needs to be handled before transmission can
1468 * resume, or @task finished transmitting, and detected that it already
1469 * received a reply.
1470 */
1471void
1472xprt_transmit(struct rpc_task *task)
1473{
1474 struct rpc_rqst *next, *req = task->tk_rqstp;
1475 struct rpc_xprt *xprt = req->rq_xprt;
1476 int status;
1477
1478 spin_lock(&xprt->queue_lock);
1479 while (!list_empty(&xprt->xmit_queue)) {
1480 next = list_first_entry(&xprt->xmit_queue,
1481 struct rpc_rqst, rq_xmit);
1482 xprt_pin_rqst(next);
1483 spin_unlock(&xprt->queue_lock);
1484 status = xprt_request_transmit(next, task);
1485 if (status == -EBADMSG && next != req)
1486 status = 0;
1487 cond_resched();
1488 spin_lock(&xprt->queue_lock);
1489 xprt_unpin_rqst(next);
1490 if (status == 0) {
1491 if (!xprt_request_data_received(task) ||
1492 test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
1493 continue;
Trond Myklebustc5445772018-09-03 23:39:27 -04001494 } else if (test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
Trond Myklebust89f90fe2018-08-29 17:40:55 -04001495 task->tk_status = status;
1496 break;
1497 }
1498 spin_unlock(&xprt->queue_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499}
1500
Trond Myklebustba60eb22013-04-14 10:49:37 -04001501static void xprt_add_backlog(struct rpc_xprt *xprt, struct rpc_task *task)
1502{
1503 set_bit(XPRT_CONGESTED, &xprt->state);
1504 rpc_sleep_on(&xprt->backlog, task, NULL);
1505}
1506
1507static void xprt_wake_up_backlog(struct rpc_xprt *xprt)
1508{
1509 if (rpc_wake_up_next(&xprt->backlog) == NULL)
1510 clear_bit(XPRT_CONGESTED, &xprt->state);
1511}
1512
1513static bool xprt_throttle_congested(struct rpc_xprt *xprt, struct rpc_task *task)
1514{
1515 bool ret = false;
1516
1517 if (!test_bit(XPRT_CONGESTED, &xprt->state))
1518 goto out;
1519 spin_lock(&xprt->reserve_lock);
1520 if (test_bit(XPRT_CONGESTED, &xprt->state)) {
1521 rpc_sleep_on(&xprt->backlog, task, NULL);
1522 ret = true;
1523 }
1524 spin_unlock(&xprt->reserve_lock);
1525out:
1526 return ret;
1527}
1528
Trond Myklebust92ea0112017-06-20 19:35:39 -04001529static struct rpc_rqst *xprt_dynamic_alloc_slot(struct rpc_xprt *xprt)
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001530{
1531 struct rpc_rqst *req = ERR_PTR(-EAGAIN);
1532
Chuck Leverff699ea82018-03-05 15:13:13 -05001533 if (xprt->num_reqs >= xprt->max_reqs)
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001534 goto out;
Chuck Leverff699ea82018-03-05 15:13:13 -05001535 ++xprt->num_reqs;
Trond Myklebust92ea0112017-06-20 19:35:39 -04001536 spin_unlock(&xprt->reserve_lock);
1537 req = kzalloc(sizeof(struct rpc_rqst), GFP_NOFS);
1538 spin_lock(&xprt->reserve_lock);
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001539 if (req != NULL)
1540 goto out;
Chuck Leverff699ea82018-03-05 15:13:13 -05001541 --xprt->num_reqs;
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001542 req = ERR_PTR(-ENOMEM);
1543out:
1544 return req;
1545}
1546
1547static bool xprt_dynamic_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1548{
Chuck Leverff699ea82018-03-05 15:13:13 -05001549 if (xprt->num_reqs > xprt->min_reqs) {
1550 --xprt->num_reqs;
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001551 kfree(req);
1552 return true;
1553 }
1554 return false;
1555}
1556
Trond Myklebustf39c1bf2012-09-07 11:08:50 -04001557void xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558{
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001559 struct rpc_rqst *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Trond Myklebustf39c1bf2012-09-07 11:08:50 -04001561 spin_lock(&xprt->reserve_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 if (!list_empty(&xprt->free)) {
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001563 req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
1564 list_del(&req->rq_list);
1565 goto out_init_req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 }
Trond Myklebust92ea0112017-06-20 19:35:39 -04001567 req = xprt_dynamic_alloc_slot(xprt);
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001568 if (!IS_ERR(req))
1569 goto out_init_req;
1570 switch (PTR_ERR(req)) {
1571 case -ENOMEM:
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001572 dprintk("RPC: dynamic allocation of request slot "
1573 "failed! Retrying\n");
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001574 task->tk_status = -ENOMEM;
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001575 break;
1576 case -EAGAIN:
Trond Myklebustba60eb22013-04-14 10:49:37 -04001577 xprt_add_backlog(xprt, task);
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001578 dprintk("RPC: waiting for request slot\n");
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001579 /* fall through */
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001580 default:
1581 task->tk_status = -EAGAIN;
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001582 }
Trond Myklebustf39c1bf2012-09-07 11:08:50 -04001583 spin_unlock(&xprt->reserve_lock);
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001584 return;
1585out_init_req:
Chuck Leverff699ea82018-03-05 15:13:13 -05001586 xprt->stat.max_slots = max_t(unsigned int, xprt->stat.max_slots,
1587 xprt->num_reqs);
Chuck Lever37ac86c2018-05-04 15:34:53 -04001588 spin_unlock(&xprt->reserve_lock);
1589
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001590 task->tk_status = 0;
1591 task->tk_rqstp = req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592}
Trond Myklebustf39c1bf2012-09-07 11:08:50 -04001593EXPORT_SYMBOL_GPL(xprt_alloc_slot);
1594
Chuck Levera9cde232018-05-04 15:34:59 -04001595void xprt_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
Trond Myklebustee5ebe82010-04-16 16:37:01 -04001596{
Trond Myklebustee5ebe82010-04-16 16:37:01 -04001597 spin_lock(&xprt->reserve_lock);
Trond Myklebustc25573b2011-12-01 14:16:17 -05001598 if (!xprt_dynamic_free_slot(xprt, req)) {
1599 memset(req, 0, sizeof(*req)); /* mark unused */
1600 list_add(&req->rq_list, &xprt->free);
1601 }
Trond Myklebustba60eb22013-04-14 10:49:37 -04001602 xprt_wake_up_backlog(xprt);
Trond Myklebustee5ebe82010-04-16 16:37:01 -04001603 spin_unlock(&xprt->reserve_lock);
1604}
Chuck Levera9cde232018-05-04 15:34:59 -04001605EXPORT_SYMBOL_GPL(xprt_free_slot);
Trond Myklebustee5ebe82010-04-16 16:37:01 -04001606
Trond Myklebust21de0a92011-07-17 16:57:32 -04001607static void xprt_free_all_slots(struct rpc_xprt *xprt)
1608{
1609 struct rpc_rqst *req;
1610 while (!list_empty(&xprt->free)) {
1611 req = list_first_entry(&xprt->free, struct rpc_rqst, rq_list);
1612 list_del(&req->rq_list);
1613 kfree(req);
1614 }
1615}
1616
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001617struct rpc_xprt *xprt_alloc(struct net *net, size_t size,
1618 unsigned int num_prealloc,
1619 unsigned int max_alloc)
Pavel Emelyanovbd1722d2010-09-29 16:02:43 +04001620{
1621 struct rpc_xprt *xprt;
Trond Myklebust21de0a92011-07-17 16:57:32 -04001622 struct rpc_rqst *req;
1623 int i;
Pavel Emelyanovbd1722d2010-09-29 16:02:43 +04001624
1625 xprt = kzalloc(size, GFP_KERNEL);
1626 if (xprt == NULL)
1627 goto out;
1628
Trond Myklebust21de0a92011-07-17 16:57:32 -04001629 xprt_init(xprt, net);
1630
1631 for (i = 0; i < num_prealloc; i++) {
1632 req = kzalloc(sizeof(struct rpc_rqst), GFP_KERNEL);
1633 if (!req)
wangweidong83131642013-10-15 11:44:30 +08001634 goto out_free;
Trond Myklebust21de0a92011-07-17 16:57:32 -04001635 list_add(&req->rq_list, &xprt->free);
1636 }
Trond Myklebustd9ba1312011-07-17 18:11:30 -04001637 if (max_alloc > num_prealloc)
1638 xprt->max_reqs = max_alloc;
1639 else
1640 xprt->max_reqs = num_prealloc;
1641 xprt->min_reqs = num_prealloc;
Chuck Leverff699ea82018-03-05 15:13:13 -05001642 xprt->num_reqs = num_prealloc;
Pavel Emelyanovbd1722d2010-09-29 16:02:43 +04001643
1644 return xprt;
1645
1646out_free:
Trond Myklebust21de0a92011-07-17 16:57:32 -04001647 xprt_free(xprt);
Pavel Emelyanovbd1722d2010-09-29 16:02:43 +04001648out:
1649 return NULL;
1650}
1651EXPORT_SYMBOL_GPL(xprt_alloc);
1652
Pavel Emelyanove204e622010-09-29 16:03:13 +04001653void xprt_free(struct rpc_xprt *xprt)
1654{
Pavel Emelyanov37aa2132010-09-29 16:05:43 +04001655 put_net(xprt->xprt_net);
Trond Myklebust21de0a92011-07-17 16:57:32 -04001656 xprt_free_all_slots(xprt);
Trond Myklebustfda1bfe2015-02-14 17:48:49 -05001657 kfree_rcu(xprt, rcu);
Pavel Emelyanove204e622010-09-29 16:03:13 +04001658}
1659EXPORT_SYMBOL_GPL(xprt_free);
1660
Trond Myklebust902c5882018-09-01 17:21:01 -04001661static void
1662xprt_init_connect_cookie(struct rpc_rqst *req, struct rpc_xprt *xprt)
1663{
1664 req->rq_connect_cookie = xprt_connect_cookie(xprt) - 1;
1665}
1666
Trond Myklebust9dc6edc2018-08-22 14:24:16 -04001667static __be32
1668xprt_alloc_xid(struct rpc_xprt *xprt)
1669{
1670 __be32 xid;
1671
1672 spin_lock(&xprt->reserve_lock);
1673 xid = (__force __be32)xprt->xid++;
1674 spin_unlock(&xprt->reserve_lock);
1675 return xid;
1676}
1677
1678static void
1679xprt_init_xid(struct rpc_xprt *xprt)
1680{
1681 xprt->xid = prandom_u32();
1682}
1683
1684static void
1685xprt_request_init(struct rpc_task *task)
1686{
1687 struct rpc_xprt *xprt = task->tk_xprt;
1688 struct rpc_rqst *req = task->tk_rqstp;
1689
Trond Myklebust9dc6edc2018-08-22 14:24:16 -04001690 req->rq_task = task;
1691 req->rq_xprt = xprt;
1692 req->rq_buffer = NULL;
1693 req->rq_xid = xprt_alloc_xid(xprt);
Trond Myklebust902c5882018-09-01 17:21:01 -04001694 xprt_init_connect_cookie(req, xprt);
Trond Myklebust9dc6edc2018-08-22 14:24:16 -04001695 req->rq_snd_buf.len = 0;
1696 req->rq_snd_buf.buflen = 0;
1697 req->rq_rcv_buf.len = 0;
1698 req->rq_rcv_buf.buflen = 0;
Trond Myklebust71700bb2018-11-30 16:11:15 -05001699 req->rq_snd_buf.bvec = NULL;
1700 req->rq_rcv_buf.bvec = NULL;
Trond Myklebust9dc6edc2018-08-22 14:24:16 -04001701 req->rq_release_snd_buf = NULL;
Trond Myklebustda953062019-04-07 13:58:56 -04001702 xprt_init_majortimeo(task, req);
Trond Myklebust9dc6edc2018-08-22 14:24:16 -04001703 dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
1704 req, ntohl(req->rq_xid));
1705}
1706
1707static void
1708xprt_do_reserve(struct rpc_xprt *xprt, struct rpc_task *task)
1709{
1710 xprt->ops->alloc_slot(xprt, task);
1711 if (task->tk_rqstp != NULL)
1712 xprt_request_init(task);
1713}
1714
Chuck Lever9903cd12005-08-11 16:25:26 -04001715/**
1716 * xprt_reserve - allocate an RPC request slot
1717 * @task: RPC task requesting a slot allocation
1718 *
Trond Myklebustba60eb22013-04-14 10:49:37 -04001719 * If the transport is marked as being congested, or if no more
1720 * slots are available, place the task on the transport's
Chuck Lever9903cd12005-08-11 16:25:26 -04001721 * backlog queue.
1722 */
1723void xprt_reserve(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724{
Trond Myklebustfb43d172016-01-30 16:39:26 -05001725 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
Trond Myklebust43cedbf0e2011-07-17 16:01:03 -04001727 task->tk_status = 0;
1728 if (task->tk_rqstp != NULL)
1729 return;
1730
Trond Myklebust43cedbf0e2011-07-17 16:01:03 -04001731 task->tk_status = -EAGAIN;
Trond Myklebustba60eb22013-04-14 10:49:37 -04001732 if (!xprt_throttle_congested(xprt, task))
Trond Myklebust9dc6edc2018-08-22 14:24:16 -04001733 xprt_do_reserve(xprt, task);
Trond Myklebustba60eb22013-04-14 10:49:37 -04001734}
1735
1736/**
1737 * xprt_retry_reserve - allocate an RPC request slot
1738 * @task: RPC task requesting a slot allocation
1739 *
1740 * If no more slots are available, place the task on the transport's
1741 * backlog queue.
1742 * Note that the only difference with xprt_reserve is that we now
1743 * ignore the value of the XPRT_CONGESTED flag.
1744 */
1745void xprt_retry_reserve(struct rpc_task *task)
1746{
Trond Myklebustfb43d172016-01-30 16:39:26 -05001747 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebustba60eb22013-04-14 10:49:37 -04001748
1749 task->tk_status = 0;
1750 if (task->tk_rqstp != NULL)
1751 return;
1752
Trond Myklebustba60eb22013-04-14 10:49:37 -04001753 task->tk_status = -EAGAIN;
Trond Myklebust9dc6edc2018-08-22 14:24:16 -04001754 xprt_do_reserve(xprt, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755}
1756
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001757static void
1758xprt_request_dequeue_all(struct rpc_task *task, struct rpc_rqst *req)
1759{
1760 struct rpc_xprt *xprt = req->rq_xprt;
1761
Trond Myklebust944b0422018-08-09 23:33:21 -04001762 if (test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate) ||
1763 test_bit(RPC_TASK_NEED_RECV, &task->tk_runstate) ||
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001764 xprt_is_pinned_rqst(req)) {
1765 spin_lock(&xprt->queue_lock);
Trond Myklebust944b0422018-08-09 23:33:21 -04001766 xprt_request_dequeue_transmit_locked(task);
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001767 xprt_request_dequeue_receive_locked(task);
1768 while (xprt_is_pinned_rqst(req)) {
1769 set_bit(RPC_TASK_MSG_PIN_WAIT, &task->tk_runstate);
1770 spin_unlock(&xprt->queue_lock);
1771 xprt_wait_on_pinned_rqst(req);
1772 spin_lock(&xprt->queue_lock);
1773 clear_bit(RPC_TASK_MSG_PIN_WAIT, &task->tk_runstate);
1774 }
1775 spin_unlock(&xprt->queue_lock);
1776 }
1777}
1778
Chuck Lever9903cd12005-08-11 16:25:26 -04001779/**
1780 * xprt_release - release an RPC request slot
1781 * @task: task which is finished with the slot
1782 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 */
Chuck Lever9903cd12005-08-11 16:25:26 -04001784void xprt_release(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785{
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001786 struct rpc_xprt *xprt;
Trond Myklebust87ed5002013-01-07 14:30:46 -05001787 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Trond Myklebust87ed5002013-01-07 14:30:46 -05001789 if (req == NULL) {
1790 if (task->tk_client) {
Trond Myklebustfb43d172016-01-30 16:39:26 -05001791 xprt = task->tk_xprt;
Trond Myklebustbd79bc52018-09-07 19:38:55 -04001792 xprt_release_write(xprt, task);
Trond Myklebust87ed5002013-01-07 14:30:46 -05001793 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 return;
Trond Myklebust87ed5002013-01-07 14:30:46 -05001795 }
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001796
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001797 xprt = req->rq_xprt;
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001798 xprt_request_dequeue_all(task, req);
Trond Myklebustb5e92412019-05-02 11:21:08 -04001799 spin_lock(&xprt->transport_lock);
Chuck Lever49e9a892005-08-25 16:25:51 -07001800 xprt->ops->release_xprt(xprt, task);
Chuck Levera58dd392005-08-25 16:25:53 -07001801 if (xprt->ops->release_request)
1802 xprt->ops->release_request(task);
Trond Myklebustad3331a2016-08-02 13:47:43 -04001803 xprt_schedule_autodisconnect(xprt);
Trond Myklebustb5e92412019-05-02 11:21:08 -04001804 spin_unlock(&xprt->transport_lock);
Trond Myklebustee5ebe82010-04-16 16:37:01 -04001805 if (req->rq_buffer)
Chuck Lever3435c742016-09-15 10:55:29 -04001806 xprt->ops->buf_free(task);
Chuck Lever4a068252015-05-11 14:02:25 -04001807 xprt_inject_disconnect(xprt);
Trond Myklebust9d96acb2018-09-13 12:22:04 -04001808 xdr_free_bvec(&req->rq_rcv_buf);
Trond Myklebust0472e472019-02-19 13:00:13 -05001809 xdr_free_bvec(&req->rq_snd_buf);
Trond Myklebusta17c2152010-07-31 14:29:08 -04001810 if (req->rq_cred != NULL)
1811 put_rpccred(req->rq_cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 task->tk_rqstp = NULL;
J. Bruce Fieldsead5e1c2005-10-13 16:54:43 -04001813 if (req->rq_release_snd_buf)
1814 req->rq_release_snd_buf(req);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001815
Chuck Lever46121cf2007-01-31 12:14:08 -05001816 dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
Trond Myklebustee5ebe82010-04-16 16:37:01 -04001817 if (likely(!bc_prealloc(req)))
Chuck Levera9cde232018-05-04 15:34:59 -04001818 xprt->ops->free_slot(xprt, req);
Trond Myklebustee5ebe82010-04-16 16:37:01 -04001819 else
Trond Myklebustc9acb422010-03-19 15:36:22 -04001820 xprt_free_bc_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821}
1822
Trond Myklebust902c5882018-09-01 17:21:01 -04001823#ifdef CONFIG_SUNRPC_BACKCHANNEL
1824void
1825xprt_init_bc_request(struct rpc_rqst *req, struct rpc_task *task)
1826{
1827 struct xdr_buf *xbufp = &req->rq_snd_buf;
1828
1829 task->tk_rqstp = req;
1830 req->rq_task = task;
1831 xprt_init_connect_cookie(req, req->rq_xprt);
1832 /*
1833 * Set up the xdr_buf length.
1834 * This also indicates that the buffer is XDR encoded already.
1835 */
1836 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1837 xbufp->tail[0].iov_len;
Trond Myklebust902c5882018-09-01 17:21:01 -04001838}
1839#endif
1840
Trond Myklebust21de0a92011-07-17 16:57:32 -04001841static void xprt_init(struct rpc_xprt *xprt, struct net *net)
Chuck Leverc2866762006-08-22 20:06:20 -04001842{
Trond Myklebust30c51162015-02-24 20:31:39 -05001843 kref_init(&xprt->kref);
Chuck Leverc2866762006-08-22 20:06:20 -04001844
1845 spin_lock_init(&xprt->transport_lock);
1846 spin_lock_init(&xprt->reserve_lock);
Trond Myklebust75c84152018-08-31 10:21:00 -04001847 spin_lock_init(&xprt->queue_lock);
Chuck Leverc2866762006-08-22 20:06:20 -04001848
1849 INIT_LIST_HEAD(&xprt->free);
Trond Myklebust95f76912018-09-07 08:35:22 -04001850 xprt->recv_queue = RB_ROOT;
Trond Myklebust944b0422018-08-09 23:33:21 -04001851 INIT_LIST_HEAD(&xprt->xmit_queue);
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001852#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiagaf9acac12009-04-01 09:22:59 -04001853 spin_lock_init(&xprt->bc_pa_lock);
1854 INIT_LIST_HEAD(&xprt->bc_pa_list);
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001855#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Trond Myklebust80b14d52015-02-14 20:31:59 -05001856 INIT_LIST_HEAD(&xprt->xprt_switch);
Ricardo Labiagaf9acac12009-04-01 09:22:59 -04001857
Chuck Leverc2866762006-08-22 20:06:20 -04001858 xprt->last_used = jiffies;
1859 xprt->cwnd = RPC_INITCWND;
Chuck Levera5090502007-03-29 16:48:04 -04001860 xprt->bind_index = 0;
Chuck Leverc2866762006-08-22 20:06:20 -04001861
1862 rpc_init_wait_queue(&xprt->binding, "xprt_binding");
1863 rpc_init_wait_queue(&xprt->pending, "xprt_pending");
Trond Myklebust79c99152018-09-09 13:53:05 -04001864 rpc_init_wait_queue(&xprt->sending, "xprt_sending");
Chuck Leverc2866762006-08-22 20:06:20 -04001865 rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
1866
Chuck Leverc2866762006-08-22 20:06:20 -04001867 xprt_init_xid(xprt);
1868
Trond Myklebust21de0a92011-07-17 16:57:32 -04001869 xprt->xprt_net = get_net(net);
Trond Myklebust8d9266f2011-07-17 16:01:09 -04001870}
1871
1872/**
1873 * xprt_create_transport - create an RPC transport
1874 * @args: rpc transport creation arguments
1875 *
1876 */
1877struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
1878{
1879 struct rpc_xprt *xprt;
1880 struct xprt_class *t;
1881
1882 spin_lock(&xprt_list_lock);
1883 list_for_each_entry(t, &xprt_list, list) {
1884 if (t->ident == args->ident) {
1885 spin_unlock(&xprt_list_lock);
1886 goto found;
1887 }
1888 }
1889 spin_unlock(&xprt_list_lock);
Chuck Lever3c45ddf2014-07-16 15:38:32 -04001890 dprintk("RPC: transport (%d) not supported\n", args->ident);
Trond Myklebust8d9266f2011-07-17 16:01:09 -04001891 return ERR_PTR(-EIO);
1892
1893found:
1894 xprt = t->setup(args);
1895 if (IS_ERR(xprt)) {
1896 dprintk("RPC: xprt_create_transport: failed, %ld\n",
1897 -PTR_ERR(xprt));
Trond Myklebust21de0a92011-07-17 16:57:32 -04001898 goto out;
Trond Myklebust8d9266f2011-07-17 16:01:09 -04001899 }
J. Bruce Fields33d90ac2013-04-11 15:06:36 -04001900 if (args->flags & XPRT_CREATE_NO_IDLE_TIMEOUT)
1901 xprt->idle_timeout = 0;
Trond Myklebust21de0a92011-07-17 16:57:32 -04001902 INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
1903 if (xprt_has_timer(xprt))
Anna Schumaker502980e2019-06-18 14:57:33 -04001904 timer_setup(&xprt->timer, xprt_init_autodisconnect, 0);
Trond Myklebust21de0a92011-07-17 16:57:32 -04001905 else
Kees Cookff861c42017-10-16 17:29:42 -07001906 timer_setup(&xprt->timer, NULL, 0);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001907
1908 if (strlen(args->servername) > RPC_MAXNETNAMELEN) {
1909 xprt_destroy(xprt);
1910 return ERR_PTR(-EINVAL);
1911 }
1912 xprt->servername = kstrdup(args->servername, GFP_KERNEL);
1913 if (xprt->servername == NULL) {
1914 xprt_destroy(xprt);
1915 return ERR_PTR(-ENOMEM);
1916 }
1917
Jeff Layton3f940092015-03-31 12:03:28 -04001918 rpc_xprt_debugfs_register(xprt);
Jeff Layton388f0c72014-11-26 14:44:44 -05001919
Chuck Lever46121cf2007-01-31 12:14:08 -05001920 dprintk("RPC: created transport %p with %u slots\n", xprt,
Chuck Leverc2866762006-08-22 20:06:20 -04001921 xprt->max_reqs);
Trond Myklebust21de0a92011-07-17 16:57:32 -04001922out:
Chuck Leverc2866762006-08-22 20:06:20 -04001923 return xprt;
1924}
1925
Trond Myklebust528fd352017-10-19 12:13:10 -04001926static void xprt_destroy_cb(struct work_struct *work)
1927{
1928 struct rpc_xprt *xprt =
1929 container_of(work, struct rpc_xprt, task_cleanup);
1930
1931 rpc_xprt_debugfs_unregister(xprt);
1932 rpc_destroy_wait_queue(&xprt->binding);
1933 rpc_destroy_wait_queue(&xprt->pending);
1934 rpc_destroy_wait_queue(&xprt->sending);
1935 rpc_destroy_wait_queue(&xprt->backlog);
1936 kfree(xprt->servername);
1937 /*
1938 * Tear down transport state and free the rpc_xprt
1939 */
1940 xprt->ops->destroy(xprt);
1941}
1942
Chuck Lever9903cd12005-08-11 16:25:26 -04001943/**
1944 * xprt_destroy - destroy an RPC transport, killing off all requests.
Trond Myklebusta8de2402011-03-15 19:56:30 -04001945 * @xprt: transport to destroy
Chuck Lever9903cd12005-08-11 16:25:26 -04001946 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 */
Trond Myklebusta8de2402011-03-15 19:56:30 -04001948static void xprt_destroy(struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949{
Chuck Lever46121cf2007-01-31 12:14:08 -05001950 dprintk("RPC: destroying transport %p\n", xprt);
Trond Myklebust79234c32015-09-18 15:53:24 -04001951
Trond Myklebust528fd352017-10-19 12:13:10 -04001952 /*
1953 * Exclude transport connect/disconnect handlers and autoclose
1954 */
Trond Myklebust79234c32015-09-18 15:53:24 -04001955 wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_UNINTERRUPTIBLE);
1956
Trond Myklebust0065db32006-01-03 09:55:56 +01001957 del_timer_sync(&xprt->timer);
Chuck Leverc8541ec2006-10-17 14:44:27 -04001958
1959 /*
Trond Myklebust528fd352017-10-19 12:13:10 -04001960 * Destroy sockets etc from the system workqueue so they can
1961 * safely flush receive work running on rpciod.
Chuck Leverc8541ec2006-10-17 14:44:27 -04001962 */
Trond Myklebust528fd352017-10-19 12:13:10 -04001963 INIT_WORK(&xprt->task_cleanup, xprt_destroy_cb);
1964 schedule_work(&xprt->task_cleanup);
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001965}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966
Trond Myklebust30c51162015-02-24 20:31:39 -05001967static void xprt_destroy_kref(struct kref *kref)
1968{
1969 xprt_destroy(container_of(kref, struct rpc_xprt, kref));
1970}
1971
1972/**
1973 * xprt_get - return a reference to an RPC transport.
1974 * @xprt: pointer to the transport
1975 *
1976 */
1977struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
1978{
1979 if (xprt != NULL && kref_get_unless_zero(&xprt->kref))
1980 return xprt;
1981 return NULL;
1982}
1983EXPORT_SYMBOL_GPL(xprt_get);
1984
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001985/**
1986 * xprt_put - release a reference to an RPC transport.
1987 * @xprt: pointer to the transport
1988 *
1989 */
1990void xprt_put(struct rpc_xprt *xprt)
1991{
Trond Myklebust30c51162015-02-24 20:31:39 -05001992 if (xprt != NULL)
1993 kref_put(&xprt->kref, xprt_destroy_kref);
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001994}
Chuck Lever5d252f92016-01-07 14:50:10 -05001995EXPORT_SYMBOL_GPL(xprt_put);