blob: 42f09ade00445289c22a51f88550af7b7dadb85a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Chuck Lever55aa4f52005-08-11 16:25:47 -040013 * the request struct, and calls xprt_transmit().
14 * - xprt_transmit sends the message and installs the caller on the
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040015 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * - When a packet arrives, the data_ready handler walks the list of
Chuck Lever55aa4f52005-08-11 16:25:47 -040019 * pending requests for that transport. If a matching XID is found, the
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 * 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>
Chuck Lever55aa4f52005-08-11 16:25:47 -040036 *
37 * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 */
39
Chuck Levera246b012005-08-11 16:25:23 -040040#include <linux/module.h>
41
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <linux/types.h>
Chuck Levera246b012005-08-11 16:25:23 -040043#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/workqueue.h>
Chuck Leverbf3fcf82006-05-25 01:40:51 -040045#include <linux/net.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Chuck Levera246b012005-08-11 16:25:23 -040047#include <linux/sunrpc/clnt.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050048#include <linux/sunrpc/metrics.h>
Trond Myklebustc9acb422010-03-19 15:36:22 -040049#include <linux/sunrpc/bc_xprt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040051#include "sunrpc.h"
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053/*
54 * Local variables
55 */
56
57#ifdef RPC_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -070058# define RPCDBG_FACILITY RPCDBG_XPRT
59#endif
60
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/*
62 * Local functions
63 */
64static void xprt_request_init(struct rpc_task *, struct rpc_xprt *);
65static inline void do_xprt_reserve(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066static void xprt_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static int __xprt_get_cong(struct rpc_xprt *, struct rpc_task *);
68
Jiri Slaby5ba03e82007-11-22 19:40:22 +080069static DEFINE_SPINLOCK(xprt_list_lock);
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -040070static LIST_HEAD(xprt_list);
71
Chuck Lever555ee3a2005-08-25 16:25:54 -070072/*
73 * The transport code maintains an estimate on the maximum number of out-
74 * standing RPC requests, using a smoothed version of the congestion
75 * avoidance implemented in 44BSD. This is basically the Van Jacobson
76 * congestion algorithm: If a retransmit occurs, the congestion window is
77 * halved; otherwise, it is incremented by 1/cwnd when
78 *
79 * - a reply is received and
80 * - a full number of requests are outstanding and
81 * - the congestion window hasn't been updated recently.
82 */
83#define RPC_CWNDSHIFT (8U)
84#define RPC_CWNDSCALE (1U << RPC_CWNDSHIFT)
85#define RPC_INITCWND RPC_CWNDSCALE
86#define RPC_MAXCWND(xprt) ((xprt)->max_reqs << RPC_CWNDSHIFT)
87
88#define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Chuck Lever12a80462005-08-25 16:25:51 -070090/**
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -040091 * xprt_register_transport - register a transport implementation
92 * @transport: transport to register
93 *
94 * If a transport implementation is loaded as a kernel module, it can
95 * call this interface to make itself known to the RPC client.
96 *
97 * Returns:
98 * 0: transport successfully registered
99 * -EEXIST: transport already registered
100 * -EINVAL: transport module being unloaded
101 */
102int xprt_register_transport(struct xprt_class *transport)
103{
104 struct xprt_class *t;
105 int result;
106
107 result = -EEXIST;
108 spin_lock(&xprt_list_lock);
109 list_for_each_entry(t, &xprt_list, list) {
110 /* don't register the same transport class twice */
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400111 if (t->ident == transport->ident)
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400112 goto out;
113 }
114
Denis V. Lunevc9f6cde2008-07-31 09:53:56 +0400115 list_add_tail(&transport->list, &xprt_list);
116 printk(KERN_INFO "RPC: Registered %s transport module.\n",
117 transport->name);
118 result = 0;
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400119
120out:
121 spin_unlock(&xprt_list_lock);
122 return result;
123}
124EXPORT_SYMBOL_GPL(xprt_register_transport);
125
126/**
127 * xprt_unregister_transport - unregister a transport implementation
Randy Dunlap65b6e422008-02-13 15:03:23 -0800128 * @transport: transport to unregister
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400129 *
130 * Returns:
131 * 0: transport successfully unregistered
132 * -ENOENT: transport never registered
133 */
134int xprt_unregister_transport(struct xprt_class *transport)
135{
136 struct xprt_class *t;
137 int result;
138
139 result = 0;
140 spin_lock(&xprt_list_lock);
141 list_for_each_entry(t, &xprt_list, list) {
142 if (t == transport) {
143 printk(KERN_INFO
144 "RPC: Unregistered %s transport module.\n",
145 transport->name);
146 list_del_init(&transport->list);
\"Talpey, Thomas\81c098a2007-09-10 13:46:00 -0400147 goto out;
148 }
149 }
150 result = -ENOENT;
151
152out:
153 spin_unlock(&xprt_list_lock);
154 return result;
155}
156EXPORT_SYMBOL_GPL(xprt_unregister_transport);
157
158/**
Tom Talpey441e3e22009-03-11 14:37:56 -0400159 * xprt_load_transport - load a transport implementation
160 * @transport_name: transport to load
161 *
162 * Returns:
163 * 0: transport successfully loaded
164 * -ENOENT: transport module not available
165 */
166int xprt_load_transport(const char *transport_name)
167{
168 struct xprt_class *t;
169 char module_name[sizeof t->name + 5];
170 int result;
171
172 result = 0;
173 spin_lock(&xprt_list_lock);
174 list_for_each_entry(t, &xprt_list, list) {
175 if (strcmp(t->name, transport_name) == 0) {
176 spin_unlock(&xprt_list_lock);
177 goto out;
178 }
179 }
180 spin_unlock(&xprt_list_lock);
181 strcpy(module_name, "xprt");
182 strncat(module_name, transport_name, sizeof t->name);
183 result = request_module(module_name);
184out:
185 return result;
186}
187EXPORT_SYMBOL_GPL(xprt_load_transport);
188
189/**
Chuck Lever12a80462005-08-25 16:25:51 -0700190 * xprt_reserve_xprt - serialize write access to transports
191 * @task: task that is requesting access to the transport
192 *
193 * This prevents mixing the payload of separate requests, and prevents
194 * transport connects from colliding with writes. No congestion control
195 * is provided.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 */
Chuck Lever12a80462005-08-25 16:25:51 -0700197int xprt_reserve_xprt(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198{
Chuck Lever12a80462005-08-25 16:25:51 -0700199 struct rpc_rqst *req = task->tk_rqstp;
Rahul Iyer343952f2009-04-01 09:23:17 -0400200 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever12a80462005-08-25 16:25:51 -0700201
202 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
203 if (task == xprt->snd_task)
204 return 1;
205 if (task == NULL)
206 return 0;
207 goto out_sleep;
208 }
209 xprt->snd_task = task;
210 if (req) {
211 req->rq_bytes_sent = 0;
212 req->rq_ntrans++;
213 }
214 return 1;
215
216out_sleep:
Chuck Lever46121cf2007-01-31 12:14:08 -0500217 dprintk("RPC: %5u failed to lock transport %p\n",
Chuck Lever12a80462005-08-25 16:25:51 -0700218 task->tk_pid, xprt);
219 task->tk_timeout = 0;
220 task->tk_status = -EAGAIN;
221 if (req && req->rq_ntrans)
Trond Myklebust5d008372008-02-22 16:34:17 -0500222 rpc_sleep_on(&xprt->resend, task, NULL);
Chuck Lever12a80462005-08-25 16:25:51 -0700223 else
Trond Myklebust5d008372008-02-22 16:34:17 -0500224 rpc_sleep_on(&xprt->sending, task, NULL);
Chuck Lever12a80462005-08-25 16:25:51 -0700225 return 0;
226}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400227EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
Chuck Lever12a80462005-08-25 16:25:51 -0700228
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100229static void xprt_clear_locked(struct rpc_xprt *xprt)
230{
231 xprt->snd_task = NULL;
232 if (!test_bit(XPRT_CLOSE_WAIT, &xprt->state) || xprt->shutdown) {
233 smp_mb__before_clear_bit();
234 clear_bit(XPRT_LOCKED, &xprt->state);
235 smp_mb__after_clear_bit();
236 } else
Trond Myklebustc1384c92007-06-14 18:00:42 -0400237 queue_work(rpciod_workqueue, &xprt->task_cleanup);
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100238}
239
Chuck Lever12a80462005-08-25 16:25:51 -0700240/*
241 * xprt_reserve_xprt_cong - serialize write access to transports
242 * @task: task that is requesting access to the transport
243 *
244 * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
245 * integrated into the decision of whether a request is allowed to be
246 * woken up and given access to the transport.
247 */
248int xprt_reserve_xprt_cong(struct rpc_task *task)
249{
250 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 struct rpc_rqst *req = task->tk_rqstp;
252
Chuck Lever2226feb2005-08-11 16:25:38 -0400253 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 if (task == xprt->snd_task)
255 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 goto out_sleep;
257 }
Chuck Lever12a80462005-08-25 16:25:51 -0700258 if (__xprt_get_cong(xprt, task)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 xprt->snd_task = task;
260 if (req) {
261 req->rq_bytes_sent = 0;
262 req->rq_ntrans++;
263 }
264 return 1;
265 }
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100266 xprt_clear_locked(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267out_sleep:
Chuck Lever46121cf2007-01-31 12:14:08 -0500268 dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 task->tk_timeout = 0;
270 task->tk_status = -EAGAIN;
271 if (req && req->rq_ntrans)
Trond Myklebust5d008372008-02-22 16:34:17 -0500272 rpc_sleep_on(&xprt->resend, task, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 else
Trond Myklebust5d008372008-02-22 16:34:17 -0500274 rpc_sleep_on(&xprt->sending, task, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 return 0;
276}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400277EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Chuck Lever12a80462005-08-25 16:25:51 -0700279static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
281 int retval;
282
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400283 spin_lock_bh(&xprt->transport_lock);
Chuck Lever12a80462005-08-25 16:25:51 -0700284 retval = xprt->ops->reserve_xprt(task);
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400285 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return retval;
287}
288
Chuck Lever12a80462005-08-25 16:25:51 -0700289static void __xprt_lock_write_next(struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
291 struct rpc_task *task;
Chuck Lever49e9a892005-08-25 16:25:51 -0700292 struct rpc_rqst *req;
293
294 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
295 return;
296
297 task = rpc_wake_up_next(&xprt->resend);
298 if (!task) {
299 task = rpc_wake_up_next(&xprt->sending);
300 if (!task)
301 goto out_unlock;
302 }
303
304 req = task->tk_rqstp;
305 xprt->snd_task = task;
306 if (req) {
307 req->rq_bytes_sent = 0;
308 req->rq_ntrans++;
309 }
310 return;
311
312out_unlock:
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100313 xprt_clear_locked(xprt);
Chuck Lever49e9a892005-08-25 16:25:51 -0700314}
315
316static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
317{
318 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Chuck Lever2226feb2005-08-11 16:25:38 -0400320 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 return;
Chuck Lever49e9a892005-08-25 16:25:51 -0700322 if (RPCXPRT_CONGESTED(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 goto out_unlock;
324 task = rpc_wake_up_next(&xprt->resend);
325 if (!task) {
326 task = rpc_wake_up_next(&xprt->sending);
327 if (!task)
328 goto out_unlock;
329 }
Chuck Lever49e9a892005-08-25 16:25:51 -0700330 if (__xprt_get_cong(xprt, task)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 struct rpc_rqst *req = task->tk_rqstp;
332 xprt->snd_task = task;
333 if (req) {
334 req->rq_bytes_sent = 0;
335 req->rq_ntrans++;
336 }
337 return;
338 }
339out_unlock:
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100340 xprt_clear_locked(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341}
342
Chuck Lever49e9a892005-08-25 16:25:51 -0700343/**
344 * xprt_release_xprt - allow other requests to use a transport
345 * @xprt: transport with other tasks potentially waiting
346 * @task: task that is releasing access to the transport
347 *
348 * Note that "task" can be NULL. No congestion control is provided.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 */
Chuck Lever49e9a892005-08-25 16:25:51 -0700350void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351{
352 if (xprt->snd_task == task) {
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100353 xprt_clear_locked(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 __xprt_lock_write_next(xprt);
355 }
356}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400357EXPORT_SYMBOL_GPL(xprt_release_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Chuck Lever49e9a892005-08-25 16:25:51 -0700359/**
360 * xprt_release_xprt_cong - allow other requests to use a transport
361 * @xprt: transport with other tasks potentially waiting
362 * @task: task that is releasing access to the transport
363 *
364 * Note that "task" can be NULL. Another task is awoken to use the
365 * transport if the transport's congestion window allows it.
366 */
367void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
368{
369 if (xprt->snd_task == task) {
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100370 xprt_clear_locked(xprt);
Chuck Lever49e9a892005-08-25 16:25:51 -0700371 __xprt_lock_write_next_cong(xprt);
372 }
373}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400374EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
Chuck Lever49e9a892005-08-25 16:25:51 -0700375
376static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377{
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400378 spin_lock_bh(&xprt->transport_lock);
Chuck Lever49e9a892005-08-25 16:25:51 -0700379 xprt->ops->release_xprt(xprt, task);
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400380 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381}
382
383/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 * Van Jacobson congestion avoidance. Check if the congestion window
385 * overflowed. Put the task to sleep if this is the case.
386 */
387static int
388__xprt_get_cong(struct rpc_xprt *xprt, struct rpc_task *task)
389{
390 struct rpc_rqst *req = task->tk_rqstp;
391
392 if (req->rq_cong)
393 return 1;
Chuck Lever46121cf2007-01-31 12:14:08 -0500394 dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 task->tk_pid, xprt->cong, xprt->cwnd);
396 if (RPCXPRT_CONGESTED(xprt))
397 return 0;
398 req->rq_cong = 1;
399 xprt->cong += RPC_CWNDSCALE;
400 return 1;
401}
402
403/*
404 * Adjust the congestion window, and wake up the next task
405 * that has been sleeping due to congestion
406 */
407static void
408__xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
409{
410 if (!req->rq_cong)
411 return;
412 req->rq_cong = 0;
413 xprt->cong -= RPC_CWNDSCALE;
Chuck Lever49e9a892005-08-25 16:25:51 -0700414 __xprt_lock_write_next_cong(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415}
416
Chuck Lever46c0ee82005-08-25 16:25:52 -0700417/**
Chuck Levera58dd392005-08-25 16:25:53 -0700418 * xprt_release_rqst_cong - housekeeping when request is complete
419 * @task: RPC request that recently completed
420 *
421 * Useful for transports that require congestion control.
422 */
423void xprt_release_rqst_cong(struct rpc_task *task)
424{
425 __xprt_put_cong(task->tk_xprt, task->tk_rqstp);
426}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400427EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
Chuck Levera58dd392005-08-25 16:25:53 -0700428
429/**
Chuck Lever46c0ee82005-08-25 16:25:52 -0700430 * xprt_adjust_cwnd - adjust transport congestion window
431 * @task: recently completed RPC request used to adjust window
432 * @result: result code of completed RPC request
433 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 * We use a time-smoothed congestion estimator to avoid heavy oscillation.
435 */
Chuck Lever46c0ee82005-08-25 16:25:52 -0700436void xprt_adjust_cwnd(struct rpc_task *task, int result)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437{
Chuck Lever46c0ee82005-08-25 16:25:52 -0700438 struct rpc_rqst *req = task->tk_rqstp;
439 struct rpc_xprt *xprt = task->tk_xprt;
440 unsigned long cwnd = xprt->cwnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 if (result >= 0 && cwnd <= xprt->cong) {
443 /* The (cwnd >> 1) term makes sure
444 * the result gets rounded properly. */
445 cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
446 if (cwnd > RPC_MAXCWND(xprt))
447 cwnd = RPC_MAXCWND(xprt);
Chuck Lever49e9a892005-08-25 16:25:51 -0700448 __xprt_lock_write_next_cong(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 } else if (result == -ETIMEDOUT) {
450 cwnd >>= 1;
451 if (cwnd < RPC_CWNDSCALE)
452 cwnd = RPC_CWNDSCALE;
453 }
Chuck Lever46121cf2007-01-31 12:14:08 -0500454 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 xprt->cong, xprt->cwnd, cwnd);
456 xprt->cwnd = cwnd;
Chuck Lever46c0ee82005-08-25 16:25:52 -0700457 __xprt_put_cong(xprt, req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400459EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Chuck Lever44fbac22005-08-11 16:25:44 -0400461/**
462 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
463 * @xprt: transport with waiting tasks
464 * @status: result code to plant in each task before waking it
465 *
466 */
467void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
468{
469 if (status < 0)
470 rpc_wake_up_status(&xprt->pending, status);
471 else
472 rpc_wake_up(&xprt->pending);
473}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400474EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
Chuck Lever44fbac22005-08-11 16:25:44 -0400475
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400476/**
477 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
478 * @task: task to be put to sleep
Randy Dunlap0b80ae42008-04-26 22:59:02 -0700479 * @action: function pointer to be executed after wait
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400480 */
Trond Myklebustb6ddf642008-04-17 18:52:19 -0400481void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400482{
483 struct rpc_rqst *req = task->tk_rqstp;
484 struct rpc_xprt *xprt = req->rq_xprt;
485
486 task->tk_timeout = req->rq_timeout;
Trond Myklebustb6ddf642008-04-17 18:52:19 -0400487 rpc_sleep_on(&xprt->pending, task, action);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400488}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400489EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400490
491/**
492 * xprt_write_space - wake the task waiting for transport output buffer space
493 * @xprt: transport with waiting tasks
494 *
495 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
496 */
497void xprt_write_space(struct rpc_xprt *xprt)
498{
499 if (unlikely(xprt->shutdown))
500 return;
501
502 spin_lock_bh(&xprt->transport_lock);
503 if (xprt->snd_task) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500504 dprintk("RPC: write space: waking waiting task on "
505 "xprt %p\n", xprt);
Trond Myklebustfda13932008-02-22 16:34:12 -0500506 rpc_wake_up_queued_task(&xprt->pending, xprt->snd_task);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400507 }
508 spin_unlock_bh(&xprt->transport_lock);
509}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400510EXPORT_SYMBOL_GPL(xprt_write_space);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400511
Chuck Leverfe3aca22005-08-25 16:25:50 -0700512/**
513 * xprt_set_retrans_timeout_def - set a request's retransmit timeout
514 * @task: task whose timeout is to be set
515 *
516 * Set a request's retransmit timeout based on the transport's
517 * default timeout parameters. Used by transports that don't adjust
518 * the retransmit timeout based on round-trip time estimation.
519 */
520void xprt_set_retrans_timeout_def(struct rpc_task *task)
521{
522 task->tk_timeout = task->tk_rqstp->rq_timeout;
523}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400524EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def);
Chuck Leverfe3aca22005-08-25 16:25:50 -0700525
526/*
527 * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
528 * @task: task whose timeout is to be set
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800529 *
Chuck Leverfe3aca22005-08-25 16:25:50 -0700530 * Set a request's retransmit timeout using the RTT estimator.
531 */
532void xprt_set_retrans_timeout_rtt(struct rpc_task *task)
533{
534 int timer = task->tk_msg.rpc_proc->p_timer;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500535 struct rpc_clnt *clnt = task->tk_client;
536 struct rpc_rtt *rtt = clnt->cl_rtt;
Chuck Leverfe3aca22005-08-25 16:25:50 -0700537 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500538 unsigned long max_timeout = clnt->cl_timeout->to_maxval;
Chuck Leverfe3aca22005-08-25 16:25:50 -0700539
540 task->tk_timeout = rpc_calc_rto(rtt, timer);
541 task->tk_timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
542 if (task->tk_timeout > max_timeout || task->tk_timeout == 0)
543 task->tk_timeout = max_timeout;
544}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400545EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt);
Chuck Leverfe3aca22005-08-25 16:25:50 -0700546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547static void xprt_reset_majortimeo(struct rpc_rqst *req)
548{
Trond Myklebustba7392b2007-12-20 16:03:55 -0500549 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
551 req->rq_majortimeo = req->rq_timeout;
552 if (to->to_exponential)
553 req->rq_majortimeo <<= to->to_retries;
554 else
555 req->rq_majortimeo += to->to_increment * to->to_retries;
556 if (req->rq_majortimeo > to->to_maxval || req->rq_majortimeo == 0)
557 req->rq_majortimeo = to->to_maxval;
558 req->rq_majortimeo += jiffies;
559}
560
Chuck Lever9903cd12005-08-11 16:25:26 -0400561/**
562 * xprt_adjust_timeout - adjust timeout values for next retransmit
563 * @req: RPC request containing parameters to use for the adjustment
564 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 */
566int xprt_adjust_timeout(struct rpc_rqst *req)
567{
568 struct rpc_xprt *xprt = req->rq_xprt;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500569 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 int status = 0;
571
572 if (time_before(jiffies, req->rq_majortimeo)) {
573 if (to->to_exponential)
574 req->rq_timeout <<= 1;
575 else
576 req->rq_timeout += to->to_increment;
577 if (to->to_maxval && req->rq_timeout >= to->to_maxval)
578 req->rq_timeout = to->to_maxval;
579 req->rq_retries++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 } else {
581 req->rq_timeout = to->to_initval;
582 req->rq_retries = 0;
583 xprt_reset_majortimeo(req);
584 /* Reset the RTT counters == "slow start" */
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400585 spin_lock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400587 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 status = -ETIMEDOUT;
589 }
590
591 if (req->rq_timeout == 0) {
592 printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
593 req->rq_timeout = 5 * HZ;
594 }
595 return status;
596}
597
David Howells65f27f32006-11-22 14:55:48 +0000598static void xprt_autoclose(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599{
David Howells65f27f32006-11-22 14:55:48 +0000600 struct rpc_xprt *xprt =
601 container_of(work, struct rpc_xprt, task_cleanup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Chuck Levera246b012005-08-11 16:25:23 -0400603 xprt->ops->close(xprt);
Trond Myklebust66af1e52007-11-06 10:18:36 -0500604 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 xprt_release_write(xprt, NULL);
606}
607
Chuck Lever9903cd12005-08-11 16:25:26 -0400608/**
Trond Myklebust62da3b22007-11-06 18:44:20 -0500609 * xprt_disconnect_done - mark a transport as disconnected
Chuck Lever9903cd12005-08-11 16:25:26 -0400610 * @xprt: transport to flag for disconnect
611 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 */
Trond Myklebust62da3b22007-11-06 18:44:20 -0500613void xprt_disconnect_done(struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614{
Chuck Lever46121cf2007-01-31 12:14:08 -0500615 dprintk("RPC: disconnected transport %p\n", xprt);
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400616 spin_lock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 xprt_clear_connected(xprt);
Trond Myklebust2a491992009-03-11 14:38:00 -0400618 xprt_wake_pending_tasks(xprt, -EAGAIN);
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400619 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
Trond Myklebust62da3b22007-11-06 18:44:20 -0500621EXPORT_SYMBOL_GPL(xprt_disconnect_done);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Trond Myklebust66af1e52007-11-06 10:18:36 -0500623/**
624 * xprt_force_disconnect - force a transport to disconnect
625 * @xprt: transport to disconnect
626 *
627 */
628void xprt_force_disconnect(struct rpc_xprt *xprt)
629{
630 /* Don't race with the test_bit() in xprt_clear_locked() */
631 spin_lock_bh(&xprt->transport_lock);
632 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
633 /* Try to schedule an autoclose RPC call */
634 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
635 queue_work(rpciod_workqueue, &xprt->task_cleanup);
Trond Myklebust2a491992009-03-11 14:38:00 -0400636 xprt_wake_pending_tasks(xprt, -EAGAIN);
Trond Myklebust66af1e52007-11-06 10:18:36 -0500637 spin_unlock_bh(&xprt->transport_lock);
638}
Trond Myklebust66af1e52007-11-06 10:18:36 -0500639
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400640/**
641 * xprt_conditional_disconnect - force a transport to disconnect
642 * @xprt: transport to disconnect
643 * @cookie: 'connection cookie'
644 *
645 * This attempts to break the connection if and only if 'cookie' matches
646 * the current transport 'connection cookie'. It ensures that we don't
647 * try to break the connection more than once when we need to retransmit
648 * a batch of RPC requests.
649 *
650 */
651void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
652{
653 /* Don't race with the test_bit() in xprt_clear_locked() */
654 spin_lock_bh(&xprt->transport_lock);
655 if (cookie != xprt->connect_cookie)
656 goto out;
657 if (test_bit(XPRT_CLOSING, &xprt->state) || !xprt_connected(xprt))
658 goto out;
659 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
660 /* Try to schedule an autoclose RPC call */
661 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
662 queue_work(rpciod_workqueue, &xprt->task_cleanup);
Trond Myklebust2a491992009-03-11 14:38:00 -0400663 xprt_wake_pending_tasks(xprt, -EAGAIN);
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400664out:
665 spin_unlock_bh(&xprt->transport_lock);
666}
667
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668static void
669xprt_init_autodisconnect(unsigned long data)
670{
671 struct rpc_xprt *xprt = (struct rpc_xprt *)data;
672
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400673 spin_lock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 if (!list_empty(&xprt->recv) || xprt->shutdown)
675 goto out_abort;
Chuck Lever2226feb2005-08-11 16:25:38 -0400676 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 goto out_abort;
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400678 spin_unlock(&xprt->transport_lock);
Trond Myklebustf75e6742009-04-21 17:18:20 -0400679 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
680 queue_work(rpciod_workqueue, &xprt->task_cleanup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 return;
682out_abort:
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400683 spin_unlock(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684}
685
Chuck Lever9903cd12005-08-11 16:25:26 -0400686/**
687 * xprt_connect - schedule a transport connect operation
688 * @task: RPC task that is requesting the connect
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 *
690 */
691void xprt_connect(struct rpc_task *task)
692{
693 struct rpc_xprt *xprt = task->tk_xprt;
694
Chuck Lever46121cf2007-01-31 12:14:08 -0500695 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 xprt, (xprt_connected(xprt) ? "is" : "is not"));
697
Chuck Leverec739ef2006-08-22 20:06:15 -0400698 if (!xprt_bound(xprt)) {
Trond Myklebust01d37c42009-03-11 14:09:39 -0400699 task->tk_status = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return;
701 }
702 if (!xprt_lock_write(xprt, task))
703 return;
Trond Myklebustfeb8ca32009-12-03 08:10:17 -0500704
705 if (test_and_clear_bit(XPRT_CLOSE_WAIT, &xprt->state))
706 xprt->ops->close(xprt);
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 if (xprt_connected(xprt))
Chuck Levera246b012005-08-11 16:25:23 -0400709 xprt_release_write(xprt, task);
710 else {
711 if (task->tk_rqstp)
712 task->tk_rqstp->rq_bytes_sent = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
Chuck Lever03bf4b72005-08-25 16:25:55 -0700714 task->tk_timeout = xprt->connect_timeout;
Trond Myklebust5d008372008-02-22 16:34:17 -0500715 rpc_sleep_on(&xprt->pending, task, xprt_connect_status);
Chuck Lever262ca072006-03-20 13:44:16 -0500716 xprt->stat.connect_start = jiffies;
Chuck Levera246b012005-08-11 16:25:23 -0400717 xprt->ops->connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 }
719 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720}
721
Chuck Lever9903cd12005-08-11 16:25:26 -0400722static void xprt_connect_status(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
724 struct rpc_xprt *xprt = task->tk_xprt;
725
Chuck Levercd983ef2008-06-11 17:56:13 -0400726 if (task->tk_status == 0) {
Chuck Lever262ca072006-03-20 13:44:16 -0500727 xprt->stat.connect_count++;
728 xprt->stat.connect_time += (long)jiffies - xprt->stat.connect_start;
Chuck Lever46121cf2007-01-31 12:14:08 -0500729 dprintk("RPC: %5u xprt_connect_status: connection established\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 task->tk_pid);
731 return;
732 }
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 switch (task->tk_status) {
Trond Myklebust2a491992009-03-11 14:38:00 -0400735 case -EAGAIN:
736 dprintk("RPC: %5u xprt_connect_status: retrying\n", task->tk_pid);
Chuck Lever23475d62005-08-11 16:25:08 -0400737 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500739 dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
740 "out\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 break;
742 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500743 dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
744 "server %s\n", task->tk_pid, -task->tk_status,
745 task->tk_client->cl_server);
Chuck Lever23475d62005-08-11 16:25:08 -0400746 xprt_release_write(xprt, task);
747 task->tk_status = -EIO;
Chuck Lever23475d62005-08-11 16:25:08 -0400748 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749}
750
Chuck Lever9903cd12005-08-11 16:25:26 -0400751/**
752 * xprt_lookup_rqst - find an RPC request corresponding to an XID
753 * @xprt: transport on which the original request was transmitted
754 * @xid: RPC XID of incoming reply
755 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700757struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
759 struct list_head *pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
761 list_for_each(pos, &xprt->recv) {
762 struct rpc_rqst *entry = list_entry(pos, struct rpc_rqst, rq_list);
Chuck Lever262ca072006-03-20 13:44:16 -0500763 if (entry->rq_xid == xid)
764 return entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 }
Chuck Lever46121cf2007-01-31 12:14:08 -0500766
767 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
768 ntohl(xid));
Chuck Lever262ca072006-03-20 13:44:16 -0500769 xprt->stat.bad_xids++;
770 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400772EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Chuck Lever9903cd12005-08-11 16:25:26 -0400774/**
Chuck Lever1570c1e2005-08-25 16:25:52 -0700775 * xprt_update_rtt - update an RPC client's RTT state after receiving a reply
776 * @task: RPC request that recently completed
Chuck Lever9903cd12005-08-11 16:25:26 -0400777 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 */
Chuck Lever1570c1e2005-08-25 16:25:52 -0700779void xprt_update_rtt(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780{
Chuck Lever1570c1e2005-08-25 16:25:52 -0700781 struct rpc_rqst *req = task->tk_rqstp;
782 struct rpc_rtt *rtt = task->tk_client->cl_rtt;
783 unsigned timer = task->tk_msg.rpc_proc->p_timer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Chuck Lever1570c1e2005-08-25 16:25:52 -0700785 if (timer) {
786 if (req->rq_ntrans == 1)
787 rpc_update_rtt(rtt, timer,
788 (long)jiffies - req->rq_xtime);
789 rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 }
Chuck Lever1570c1e2005-08-25 16:25:52 -0700791}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400792EXPORT_SYMBOL_GPL(xprt_update_rtt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Chuck Lever1570c1e2005-08-25 16:25:52 -0700794/**
795 * xprt_complete_rqst - called when reply processing is complete
796 * @task: RPC request that recently completed
797 * @copied: actual number of bytes received from the transport
798 *
799 * Caller holds transport lock.
800 */
801void xprt_complete_rqst(struct rpc_task *task, int copied)
802{
803 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebustfda13932008-02-22 16:34:12 -0500804 struct rpc_xprt *xprt = req->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Chuck Lever1570c1e2005-08-25 16:25:52 -0700806 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
807 task->tk_pid, ntohl(req->rq_xid), copied);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Trond Myklebustfda13932008-02-22 16:34:12 -0500809 xprt->stat.recvs++;
Chuck Leveref759a22006-03-20 13:44:17 -0500810 task->tk_rtt = (long)jiffies - req->rq_xtime;
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 list_del_init(&req->rq_list);
Trond Myklebust1e799b62008-03-21 16:19:41 -0400813 req->rq_private_buf.len = copied;
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400814 /* Ensure all writes are done before we update */
815 /* req->rq_reply_bytes_recvd */
Trond Myklebust43ac3f22006-03-20 13:44:51 -0500816 smp_wmb();
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400817 req->rq_reply_bytes_recvd = copied;
Trond Myklebustfda13932008-02-22 16:34:12 -0500818 rpc_wake_up_queued_task(&xprt->pending, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400820EXPORT_SYMBOL_GPL(xprt_complete_rqst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Chuck Lever46c0ee82005-08-25 16:25:52 -0700822static void xprt_timer(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823{
Chuck Lever46c0ee82005-08-25 16:25:52 -0700824 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 struct rpc_xprt *xprt = req->rq_xprt;
826
Trond Myklebust5d008372008-02-22 16:34:17 -0500827 if (task->tk_status != -ETIMEDOUT)
828 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500829 dprintk("RPC: %5u xprt_timer\n", task->tk_pid);
Chuck Lever46c0ee82005-08-25 16:25:52 -0700830
Trond Myklebust5d008372008-02-22 16:34:17 -0500831 spin_lock_bh(&xprt->transport_lock);
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400832 if (!req->rq_reply_bytes_recvd) {
Chuck Lever46c0ee82005-08-25 16:25:52 -0700833 if (xprt->ops->timer)
834 xprt->ops->timer(task);
Trond Myklebust5d008372008-02-22 16:34:17 -0500835 } else
836 task->tk_status = 0;
837 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
839
Rahul Iyer4cfc7e62009-09-10 17:32:28 +0300840static inline int xprt_has_timer(struct rpc_xprt *xprt)
841{
842 return xprt->idle_timeout != 0;
843}
844
Chuck Lever9903cd12005-08-11 16:25:26 -0400845/**
846 * xprt_prepare_transmit - reserve the transport before sending a request
847 * @task: RPC task about to send a request
848 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 */
Chuck Lever9903cd12005-08-11 16:25:26 -0400850int xprt_prepare_transmit(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851{
852 struct rpc_rqst *req = task->tk_rqstp;
853 struct rpc_xprt *xprt = req->rq_xprt;
854 int err = 0;
855
Chuck Lever46121cf2007-01-31 12:14:08 -0500856 dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400858 spin_lock_bh(&xprt->transport_lock);
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400859 if (req->rq_reply_bytes_recvd && !req->rq_bytes_sent) {
860 err = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 goto out_unlock;
862 }
Trond Myklebust2a491992009-03-11 14:38:00 -0400863 if (!xprt->ops->reserve_xprt(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 err = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865out_unlock:
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400866 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 return err;
868}
869
Trond Myklebuste0ab53d2006-07-27 17:22:50 -0400870void xprt_end_transmit(struct rpc_task *task)
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -0700871{
Rahul Iyer343952f2009-04-01 09:23:17 -0400872 xprt_release_write(task->tk_rqstp->rq_xprt, task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -0700873}
874
Chuck Lever9903cd12005-08-11 16:25:26 -0400875/**
876 * xprt_transmit - send an RPC request on a transport
877 * @task: controlling RPC task
878 *
879 * We have to copy the iovec because sendmsg fiddles with its contents.
880 */
881void xprt_transmit(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 struct rpc_rqst *req = task->tk_rqstp;
884 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Levera246b012005-08-11 16:25:23 -0400885 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
Chuck Lever46121cf2007-01-31 12:14:08 -0500887 dprintk("RPC: %5u xprt_transmit(%u)\n", task->tk_pid, req->rq_slen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400889 if (!req->rq_reply_bytes_recvd) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400890 if (list_empty(&req->rq_list) && rpc_reply_expected(task)) {
891 /*
892 * Add to the list only if we're expecting a reply
893 */
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400894 spin_lock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 /* Update the softirq receive buffer */
896 memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
897 sizeof(req->rq_private_buf));
898 /* Add request to the receive list */
899 list_add_tail(&req->rq_list, &xprt->recv);
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400900 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 xprt_reset_majortimeo(req);
Trond Myklebust0f9dc2b2005-06-22 17:16:28 +0000902 /* Turn off autodisconnect */
903 del_singleshot_timer_sync(&xprt->timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 }
905 } else if (!req->rq_bytes_sent)
906 return;
907
Trond Myklebust7c1d71c2008-04-17 16:52:57 -0400908 req->rq_connect_cookie = xprt->connect_cookie;
Chuck Leverb22602a2008-06-06 13:22:25 -0400909 req->rq_xtime = jiffies;
Chuck Levera246b012005-08-11 16:25:23 -0400910 status = xprt->ops->send_request(task);
Trond Myklebustc8485e42009-03-11 14:37:59 -0400911 if (status != 0) {
912 task->tk_status = status;
Chuck Leverfe3aca22005-08-25 16:25:50 -0700913 return;
914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Trond Myklebustc8485e42009-03-11 14:37:59 -0400916 dprintk("RPC: %5u xmit complete\n", task->tk_pid);
917 spin_lock_bh(&xprt->transport_lock);
918
919 xprt->ops->set_retrans_timeout(task);
920
921 xprt->stat.sends++;
922 xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
923 xprt->stat.bklog_u += xprt->backlog.qlen;
924
925 /* Don't race with disconnect */
926 if (!xprt_connected(xprt))
927 task->tk_status = -ENOTCONN;
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400928 else if (!req->rq_reply_bytes_recvd && rpc_reply_expected(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400929 /*
930 * Sleep on the pending queue since
931 * we're expecting a reply.
932 */
Trond Myklebustc8485e42009-03-11 14:37:59 -0400933 rpc_sleep_on(&xprt->pending, task, xprt_timer);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400934 }
Trond Myklebustc8485e42009-03-11 14:37:59 -0400935 spin_unlock_bh(&xprt->transport_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936}
937
Chuck Lever9903cd12005-08-11 16:25:26 -0400938static inline void do_xprt_reserve(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939{
940 struct rpc_xprt *xprt = task->tk_xprt;
941
942 task->tk_status = 0;
943 if (task->tk_rqstp)
944 return;
945 if (!list_empty(&xprt->free)) {
946 struct rpc_rqst *req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
947 list_del_init(&req->rq_list);
948 task->tk_rqstp = req;
949 xprt_request_init(task, xprt);
950 return;
951 }
Chuck Lever46121cf2007-01-31 12:14:08 -0500952 dprintk("RPC: waiting for request slot\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 task->tk_status = -EAGAIN;
954 task->tk_timeout = 0;
Trond Myklebust5d008372008-02-22 16:34:17 -0500955 rpc_sleep_on(&xprt->backlog, task, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956}
957
Chuck Lever9903cd12005-08-11 16:25:26 -0400958/**
959 * xprt_reserve - allocate an RPC request slot
960 * @task: RPC task requesting a slot allocation
961 *
962 * If no more slots are available, place the task on the transport's
963 * backlog queue.
964 */
965void xprt_reserve(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966{
967 struct rpc_xprt *xprt = task->tk_xprt;
968
969 task->tk_status = -EIO;
Trond Myklebust0065db32006-01-03 09:55:56 +0100970 spin_lock(&xprt->reserve_lock);
971 do_xprt_reserve(task);
972 spin_unlock(&xprt->reserve_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973}
974
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700975static inline __be32 xprt_alloc_xid(struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
977 return xprt->xid++;
978}
979
980static inline void xprt_init_xid(struct rpc_xprt *xprt)
981{
Chuck Leverbf3fcf82006-05-25 01:40:51 -0400982 xprt->xid = net_random();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983}
984
Chuck Lever9903cd12005-08-11 16:25:26 -0400985static void xprt_request_init(struct rpc_task *task, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986{
987 struct rpc_rqst *req = task->tk_rqstp;
988
Trond Myklebustba7392b2007-12-20 16:03:55 -0500989 req->rq_timeout = task->tk_client->cl_timeout->to_initval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 req->rq_task = task;
991 req->rq_xprt = xprt;
Chuck Lever02107142006-01-03 09:55:49 +0100992 req->rq_buffer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 req->rq_xid = xprt_alloc_xid(xprt);
J. Bruce Fieldsead5e1c2005-10-13 16:54:43 -0400994 req->rq_release_snd_buf = NULL;
Trond Myklebustda458282006-08-31 15:44:52 -0400995 xprt_reset_majortimeo(req);
Chuck Lever46121cf2007-01-31 12:14:08 -0500996 dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 req, ntohl(req->rq_xid));
998}
999
Chuck Lever9903cd12005-08-11 16:25:26 -04001000/**
1001 * xprt_release - release an RPC request slot
1002 * @task: task which is finished with the slot
1003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 */
Chuck Lever9903cd12005-08-11 16:25:26 -04001005void xprt_release(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006{
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001007 struct rpc_xprt *xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 struct rpc_rqst *req;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001009 int is_bc_request;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
1011 if (!(req = task->tk_rqstp))
1012 return;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001013
1014 /* Preallocated backchannel request? */
1015 is_bc_request = bc_prealloc(req);
1016
1017 xprt = req->rq_xprt;
Chuck Lever11c556b2006-03-20 13:44:22 -05001018 rpc_count_iostats(task);
Chuck Lever4a0f8c02005-08-11 16:25:32 -04001019 spin_lock_bh(&xprt->transport_lock);
Chuck Lever49e9a892005-08-25 16:25:51 -07001020 xprt->ops->release_xprt(xprt, task);
Chuck Levera58dd392005-08-25 16:25:53 -07001021 if (xprt->ops->release_request)
1022 xprt->ops->release_request(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 if (!list_empty(&req->rq_list))
1024 list_del(&req->rq_list);
1025 xprt->last_used = jiffies;
Rahul Iyer4cfc7e62009-09-10 17:32:28 +03001026 if (list_empty(&xprt->recv) && xprt_has_timer(xprt))
Chuck Levera246b012005-08-11 16:25:23 -04001027 mod_timer(&xprt->timer,
Chuck Lever03bf4b72005-08-25 16:25:55 -07001028 xprt->last_used + xprt->idle_timeout);
Chuck Lever4a0f8c02005-08-11 16:25:32 -04001029 spin_unlock_bh(&xprt->transport_lock);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001030 if (!bc_prealloc(req))
1031 xprt->ops->buf_free(req->rq_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 task->tk_rqstp = NULL;
J. Bruce Fieldsead5e1c2005-10-13 16:54:43 -04001033 if (req->rq_release_snd_buf)
1034 req->rq_release_snd_buf(req);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001035
Chuck Lever46121cf2007-01-31 12:14:08 -05001036 dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
Trond Myklebustc9acb422010-03-19 15:36:22 -04001037 if (likely(!is_bc_request)) {
1038 memset(req, 0, sizeof(*req)); /* mark unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Trond Myklebustc9acb422010-03-19 15:36:22 -04001040 spin_lock(&xprt->reserve_lock);
1041 list_add(&req->rq_list, &xprt->free);
1042 rpc_wake_up_next(&xprt->backlog);
1043 spin_unlock(&xprt->reserve_lock);
1044 } else
1045 xprt_free_bc_request(req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046}
1047
Chuck Lever9903cd12005-08-11 16:25:26 -04001048/**
Chuck Leverc2866762006-08-22 20:06:20 -04001049 * xprt_create_transport - create an RPC transport
Frank van Maarseveen96802a02007-07-08 13:08:54 +02001050 * @args: rpc transport creation arguments
Chuck Leverc2866762006-08-22 20:06:20 -04001051 *
1052 */
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -04001053struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
Chuck Leverc2866762006-08-22 20:06:20 -04001054{
Chuck Leverc2866762006-08-22 20:06:20 -04001055 struct rpc_xprt *xprt;
1056 struct rpc_rqst *req;
\"Talpey, Thomas\bc255712007-09-10 13:46:39 -04001057 struct xprt_class *t;
Chuck Leverc2866762006-08-22 20:06:20 -04001058
\"Talpey, Thomas\bc255712007-09-10 13:46:39 -04001059 spin_lock(&xprt_list_lock);
1060 list_for_each_entry(t, &xprt_list, list) {
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -04001061 if (t->ident == args->ident) {
\"Talpey, Thomas\bc255712007-09-10 13:46:39 -04001062 spin_unlock(&xprt_list_lock);
1063 goto found;
1064 }
Chuck Leverc2866762006-08-22 20:06:20 -04001065 }
\"Talpey, Thomas\bc255712007-09-10 13:46:39 -04001066 spin_unlock(&xprt_list_lock);
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -04001067 printk(KERN_ERR "RPC: transport (%d) not supported\n", args->ident);
\"Talpey, Thomas\bc255712007-09-10 13:46:39 -04001068 return ERR_PTR(-EIO);
1069
1070found:
1071 xprt = t->setup(args);
Chuck Leverc8541ec2006-10-17 14:44:27 -04001072 if (IS_ERR(xprt)) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001073 dprintk("RPC: xprt_create_transport: failed, %ld\n",
Chuck Leverc8541ec2006-10-17 14:44:27 -04001074 -PTR_ERR(xprt));
1075 return xprt;
Chuck Leverc2866762006-08-22 20:06:20 -04001076 }
1077
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001078 kref_init(&xprt->kref);
Chuck Leverc2866762006-08-22 20:06:20 -04001079 spin_lock_init(&xprt->transport_lock);
1080 spin_lock_init(&xprt->reserve_lock);
1081
1082 INIT_LIST_HEAD(&xprt->free);
1083 INIT_LIST_HEAD(&xprt->recv);
Ricardo Labiagaf9acac12009-04-01 09:22:59 -04001084#if defined(CONFIG_NFS_V4_1)
1085 spin_lock_init(&xprt->bc_pa_lock);
1086 INIT_LIST_HEAD(&xprt->bc_pa_list);
1087#endif /* CONFIG_NFS_V4_1 */
1088
David Howells65f27f32006-11-22 14:55:48 +00001089 INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
Rahul Iyer4cfc7e62009-09-10 17:32:28 +03001090 if (xprt_has_timer(xprt))
1091 setup_timer(&xprt->timer, xprt_init_autodisconnect,
1092 (unsigned long)xprt);
1093 else
1094 init_timer(&xprt->timer);
Chuck Leverc2866762006-08-22 20:06:20 -04001095 xprt->last_used = jiffies;
1096 xprt->cwnd = RPC_INITCWND;
Chuck Levera5090502007-03-29 16:48:04 -04001097 xprt->bind_index = 0;
Chuck Leverc2866762006-08-22 20:06:20 -04001098
1099 rpc_init_wait_queue(&xprt->binding, "xprt_binding");
1100 rpc_init_wait_queue(&xprt->pending, "xprt_pending");
1101 rpc_init_wait_queue(&xprt->sending, "xprt_sending");
1102 rpc_init_wait_queue(&xprt->resend, "xprt_resend");
1103 rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
1104
1105 /* initialize free list */
1106 for (req = &xprt->slot[xprt->max_reqs-1]; req >= &xprt->slot[0]; req--)
1107 list_add(&req->rq_list, &xprt->free);
1108
1109 xprt_init_xid(xprt);
1110
Chuck Lever46121cf2007-01-31 12:14:08 -05001111 dprintk("RPC: created transport %p with %u slots\n", xprt,
Chuck Leverc2866762006-08-22 20:06:20 -04001112 xprt->max_reqs);
Chuck Leverc2866762006-08-22 20:06:20 -04001113 return xprt;
1114}
1115
Chuck Lever9903cd12005-08-11 16:25:26 -04001116/**
1117 * xprt_destroy - destroy an RPC transport, killing off all requests.
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001118 * @kref: kref for the transport to destroy
Chuck Lever9903cd12005-08-11 16:25:26 -04001119 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 */
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001121static void xprt_destroy(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122{
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001123 struct rpc_xprt *xprt = container_of(kref, struct rpc_xprt, kref);
1124
Chuck Lever46121cf2007-01-31 12:14:08 -05001125 dprintk("RPC: destroying transport %p\n", xprt);
Trond Myklebust0065db32006-01-03 09:55:56 +01001126 xprt->shutdown = 1;
1127 del_timer_sync(&xprt->timer);
Chuck Leverc8541ec2006-10-17 14:44:27 -04001128
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001129 rpc_destroy_wait_queue(&xprt->binding);
1130 rpc_destroy_wait_queue(&xprt->pending);
1131 rpc_destroy_wait_queue(&xprt->sending);
1132 rpc_destroy_wait_queue(&xprt->resend);
1133 rpc_destroy_wait_queue(&xprt->backlog);
Chuck Leverc8541ec2006-10-17 14:44:27 -04001134 /*
1135 * Tear down transport state and free the rpc_xprt
1136 */
Chuck Levera246b012005-08-11 16:25:23 -04001137 xprt->ops->destroy(xprt);
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001138}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Trond Myklebust6b6ca862006-09-05 12:55:57 -04001140/**
1141 * xprt_put - release a reference to an RPC transport.
1142 * @xprt: pointer to the transport
1143 *
1144 */
1145void xprt_put(struct rpc_xprt *xprt)
1146{
1147 kref_put(&xprt->kref, xprt_destroy);
1148}
1149
1150/**
1151 * xprt_get - return a reference to an RPC transport.
1152 * @xprt: pointer to the transport
1153 *
1154 */
1155struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
1156{
1157 kref_get(&xprt->kref);
1158 return xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159}