SUNRPC: Fix an Oops due to socket not set up yet...
[deliverable/linux.git] / net / sunrpc / xprt.c
CommitLineData
1da177e4
LT
1/*
2 * linux/net/sunrpc/xprt.c
3 *
4 * This is a generic RPC call interface supporting congestion avoidance,
5 * and asynchronous calls.
6 *
7 * The interface works like this:
8 *
9 * - When a process places a call, it allocates a request slot if
10 * one is available. Otherwise, it sleeps on the backlog queue
11 * (xprt_reserve).
12 * - Next, the caller puts together the RPC message, stuffs it into
55aa4f58
CL
13 * the request struct, and calls xprt_transmit().
14 * - xprt_transmit sends the message and installs the caller on the
15 * transport's wait list. At the same time, it installs a timer that
1da177e4
LT
16 * is run after the packet's timeout has expired.
17 * - When a packet arrives, the data_ready handler walks the list of
55aa4f58 18 * pending requests for that transport. If a matching XID is found, the
1da177e4
LT
19 * caller is woken up, and the timer removed.
20 * - When no reply arrives within the timeout interval, the timer is
21 * fired by the kernel and runs xprt_timer(). It either adjusts the
22 * timeout values (minor timeout) or wakes up the caller with a status
23 * of -ETIMEDOUT.
24 * - When the caller receives a notification from RPC that a reply arrived,
25 * it should release the RPC slot, and process the reply.
26 * If the call timed out, it may choose to retry the operation by
27 * adjusting the initial timeout value, and simply calling rpc_call
28 * again.
29 *
30 * Support for async RPC is done through a set of RPC-specific scheduling
31 * primitives that `transparently' work for processes as well as async
32 * tasks that rely on callbacks.
33 *
34 * Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
55aa4f58
CL
35 *
36 * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
1da177e4
LT
37 */
38
a246b010
CL
39#include <linux/module.h>
40
1da177e4 41#include <linux/types.h>
a246b010 42#include <linux/interrupt.h>
1da177e4 43#include <linux/workqueue.h>
bf3fcf89 44#include <linux/net.h>
1da177e4 45
a246b010 46#include <linux/sunrpc/clnt.h>
11c556b3 47#include <linux/sunrpc/metrics.h>
1da177e4
LT
48
49/*
50 * Local variables
51 */
52
53#ifdef RPC_DEBUG
1da177e4
LT
54# define RPCDBG_FACILITY RPCDBG_XPRT
55#endif
56
1da177e4
LT
57/*
58 * Local functions
59 */
60static void xprt_request_init(struct rpc_task *, struct rpc_xprt *);
61static inline void do_xprt_reserve(struct rpc_task *);
1da177e4 62static void xprt_connect_status(struct rpc_task *task);
1da177e4
LT
63static int __xprt_get_cong(struct rpc_xprt *, struct rpc_task *);
64
5ba03e82 65static DEFINE_SPINLOCK(xprt_list_lock);
81c098af
TT
66static LIST_HEAD(xprt_list);
67
555ee3af
CL
68/*
69 * The transport code maintains an estimate on the maximum number of out-
70 * standing RPC requests, using a smoothed version of the congestion
71 * avoidance implemented in 44BSD. This is basically the Van Jacobson
72 * congestion algorithm: If a retransmit occurs, the congestion window is
73 * halved; otherwise, it is incremented by 1/cwnd when
74 *
75 * - a reply is received and
76 * - a full number of requests are outstanding and
77 * - the congestion window hasn't been updated recently.
78 */
79#define RPC_CWNDSHIFT (8U)
80#define RPC_CWNDSCALE (1U << RPC_CWNDSHIFT)
81#define RPC_INITCWND RPC_CWNDSCALE
82#define RPC_MAXCWND(xprt) ((xprt)->max_reqs << RPC_CWNDSHIFT)
83
84#define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)
1da177e4 85
81c098af
TT
86/**
87 * xprt_register_transport - register a transport implementation
88 * @transport: transport to register
89 *
90 * If a transport implementation is loaded as a kernel module, it can
91 * call this interface to make itself known to the RPC client.
92 *
93 * Returns:
94 * 0: transport successfully registered
95 * -EEXIST: transport already registered
96 * -EINVAL: transport module being unloaded
97 */
98int xprt_register_transport(struct xprt_class *transport)
99{
100 struct xprt_class *t;
101 int result;
102
103 result = -EEXIST;
104 spin_lock(&xprt_list_lock);
105 list_for_each_entry(t, &xprt_list, list) {
106 /* don't register the same transport class twice */
4fa016eb 107 if (t->ident == transport->ident)
81c098af
TT
108 goto out;
109 }
110
c9f6cde6
DL
111 list_add_tail(&transport->list, &xprt_list);
112 printk(KERN_INFO "RPC: Registered %s transport module.\n",
113 transport->name);
114 result = 0;
81c098af
TT
115
116out:
117 spin_unlock(&xprt_list_lock);
118 return result;
119}
120EXPORT_SYMBOL_GPL(xprt_register_transport);
121
122/**
123 * xprt_unregister_transport - unregister a transport implementation
65b6e42c 124 * @transport: transport to unregister
81c098af
TT
125 *
126 * Returns:
127 * 0: transport successfully unregistered
128 * -ENOENT: transport never registered
129 */
130int xprt_unregister_transport(struct xprt_class *transport)
131{
132 struct xprt_class *t;
133 int result;
134
135 result = 0;
136 spin_lock(&xprt_list_lock);
137 list_for_each_entry(t, &xprt_list, list) {
138 if (t == transport) {
139 printk(KERN_INFO
140 "RPC: Unregistered %s transport module.\n",
141 transport->name);
142 list_del_init(&transport->list);
81c098af
TT
143 goto out;
144 }
145 }
146 result = -ENOENT;
147
148out:
149 spin_unlock(&xprt_list_lock);
150 return result;
151}
152EXPORT_SYMBOL_GPL(xprt_unregister_transport);
153
12a80469
CL
154/**
155 * xprt_reserve_xprt - serialize write access to transports
156 * @task: task that is requesting access to the transport
157 *
158 * This prevents mixing the payload of separate requests, and prevents
159 * transport connects from colliding with writes. No congestion control
160 * is provided.
161 */
162int xprt_reserve_xprt(struct rpc_task *task)
163{
164 struct rpc_xprt *xprt = task->tk_xprt;
165 struct rpc_rqst *req = task->tk_rqstp;
166
167 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
168 if (task == xprt->snd_task)
169 return 1;
170 if (task == NULL)
171 return 0;
172 goto out_sleep;
173 }
174 xprt->snd_task = task;
175 if (req) {
176 req->rq_bytes_sent = 0;
177 req->rq_ntrans++;
178 }
179 return 1;
180
181out_sleep:
46121cf7 182 dprintk("RPC: %5u failed to lock transport %p\n",
12a80469
CL
183 task->tk_pid, xprt);
184 task->tk_timeout = 0;
185 task->tk_status = -EAGAIN;
186 if (req && req->rq_ntrans)
5d00837b 187 rpc_sleep_on(&xprt->resend, task, NULL);
12a80469 188 else
5d00837b 189 rpc_sleep_on(&xprt->sending, task, NULL);
12a80469
CL
190 return 0;
191}
12444809 192EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
12a80469 193
632e3bdc
TM
194static void xprt_clear_locked(struct rpc_xprt *xprt)
195{
196 xprt->snd_task = NULL;
197 if (!test_bit(XPRT_CLOSE_WAIT, &xprt->state) || xprt->shutdown) {
198 smp_mb__before_clear_bit();
199 clear_bit(XPRT_LOCKED, &xprt->state);
200 smp_mb__after_clear_bit();
201 } else
c1384c9c 202 queue_work(rpciod_workqueue, &xprt->task_cleanup);
632e3bdc
TM
203}
204
1da177e4 205/*
12a80469
CL
206 * xprt_reserve_xprt_cong - serialize write access to transports
207 * @task: task that is requesting access to the transport
208 *
209 * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
210 * integrated into the decision of whether a request is allowed to be
211 * woken up and given access to the transport.
1da177e4 212 */
12a80469 213int xprt_reserve_xprt_cong(struct rpc_task *task)
1da177e4 214{
12a80469 215 struct rpc_xprt *xprt = task->tk_xprt;
1da177e4
LT
216 struct rpc_rqst *req = task->tk_rqstp;
217
2226feb6 218 if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
1da177e4
LT
219 if (task == xprt->snd_task)
220 return 1;
1da177e4
LT
221 goto out_sleep;
222 }
12a80469 223 if (__xprt_get_cong(xprt, task)) {
1da177e4
LT
224 xprt->snd_task = task;
225 if (req) {
226 req->rq_bytes_sent = 0;
227 req->rq_ntrans++;
228 }
229 return 1;
230 }
632e3bdc 231 xprt_clear_locked(xprt);
1da177e4 232out_sleep:
46121cf7 233 dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
1da177e4
LT
234 task->tk_timeout = 0;
235 task->tk_status = -EAGAIN;
236 if (req && req->rq_ntrans)
5d00837b 237 rpc_sleep_on(&xprt->resend, task, NULL);
1da177e4 238 else
5d00837b 239 rpc_sleep_on(&xprt->sending, task, NULL);
1da177e4
LT
240 return 0;
241}
12444809 242EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
1da177e4 243
12a80469 244static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
245{
246 int retval;
247
4a0f8c04 248 spin_lock_bh(&xprt->transport_lock);
12a80469 249 retval = xprt->ops->reserve_xprt(task);
4a0f8c04 250 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
251 return retval;
252}
253
12a80469 254static void __xprt_lock_write_next(struct rpc_xprt *xprt)
49e9a890
CL
255{
256 struct rpc_task *task;
257 struct rpc_rqst *req;
258
259 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
260 return;
261
262 task = rpc_wake_up_next(&xprt->resend);
263 if (!task) {
264 task = rpc_wake_up_next(&xprt->sending);
265 if (!task)
266 goto out_unlock;
267 }
268
269 req = task->tk_rqstp;
270 xprt->snd_task = task;
271 if (req) {
272 req->rq_bytes_sent = 0;
273 req->rq_ntrans++;
274 }
275 return;
276
277out_unlock:
632e3bdc 278 xprt_clear_locked(xprt);
49e9a890
CL
279}
280
281static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
1da177e4
LT
282{
283 struct rpc_task *task;
284
2226feb6 285 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
1da177e4 286 return;
49e9a890 287 if (RPCXPRT_CONGESTED(xprt))
1da177e4
LT
288 goto out_unlock;
289 task = rpc_wake_up_next(&xprt->resend);
290 if (!task) {
291 task = rpc_wake_up_next(&xprt->sending);
292 if (!task)
293 goto out_unlock;
294 }
49e9a890 295 if (__xprt_get_cong(xprt, task)) {
1da177e4
LT
296 struct rpc_rqst *req = task->tk_rqstp;
297 xprt->snd_task = task;
298 if (req) {
299 req->rq_bytes_sent = 0;
300 req->rq_ntrans++;
301 }
302 return;
303 }
304out_unlock:
632e3bdc 305 xprt_clear_locked(xprt);
1da177e4
LT
306}
307
49e9a890
CL
308/**
309 * xprt_release_xprt - allow other requests to use a transport
310 * @xprt: transport with other tasks potentially waiting
311 * @task: task that is releasing access to the transport
312 *
313 * Note that "task" can be NULL. No congestion control is provided.
1da177e4 314 */
49e9a890 315void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4
LT
316{
317 if (xprt->snd_task == task) {
632e3bdc 318 xprt_clear_locked(xprt);
1da177e4
LT
319 __xprt_lock_write_next(xprt);
320 }
321}
12444809 322EXPORT_SYMBOL_GPL(xprt_release_xprt);
1da177e4 323
49e9a890
CL
324/**
325 * xprt_release_xprt_cong - allow other requests to use a transport
326 * @xprt: transport with other tasks potentially waiting
327 * @task: task that is releasing access to the transport
328 *
329 * Note that "task" can be NULL. Another task is awoken to use the
330 * transport if the transport's congestion window allows it.
331 */
332void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
333{
334 if (xprt->snd_task == task) {
632e3bdc 335 xprt_clear_locked(xprt);
49e9a890
CL
336 __xprt_lock_write_next_cong(xprt);
337 }
338}
12444809 339EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
49e9a890
CL
340
341static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
1da177e4 342{
4a0f8c04 343 spin_lock_bh(&xprt->transport_lock);
49e9a890 344 xprt->ops->release_xprt(xprt, task);
4a0f8c04 345 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
346}
347
1da177e4
LT
348/*
349 * Van Jacobson congestion avoidance. Check if the congestion window
350 * overflowed. Put the task to sleep if this is the case.
351 */
352static int
353__xprt_get_cong(struct rpc_xprt *xprt, struct rpc_task *task)
354{
355 struct rpc_rqst *req = task->tk_rqstp;
356
357 if (req->rq_cong)
358 return 1;
46121cf7 359 dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
1da177e4
LT
360 task->tk_pid, xprt->cong, xprt->cwnd);
361 if (RPCXPRT_CONGESTED(xprt))
362 return 0;
363 req->rq_cong = 1;
364 xprt->cong += RPC_CWNDSCALE;
365 return 1;
366}
367
368/*
369 * Adjust the congestion window, and wake up the next task
370 * that has been sleeping due to congestion
371 */
372static void
373__xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
374{
375 if (!req->rq_cong)
376 return;
377 req->rq_cong = 0;
378 xprt->cong -= RPC_CWNDSCALE;
49e9a890 379 __xprt_lock_write_next_cong(xprt);
1da177e4
LT
380}
381
a58dd398
CL
382/**
383 * xprt_release_rqst_cong - housekeeping when request is complete
384 * @task: RPC request that recently completed
385 *
386 * Useful for transports that require congestion control.
387 */
388void xprt_release_rqst_cong(struct rpc_task *task)
389{
390 __xprt_put_cong(task->tk_xprt, task->tk_rqstp);
391}
12444809 392EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
a58dd398 393
46c0ee8b
CL
394/**
395 * xprt_adjust_cwnd - adjust transport congestion window
396 * @task: recently completed RPC request used to adjust window
397 * @result: result code of completed RPC request
398 *
1da177e4
LT
399 * We use a time-smoothed congestion estimator to avoid heavy oscillation.
400 */
46c0ee8b 401void xprt_adjust_cwnd(struct rpc_task *task, int result)
1da177e4 402{
46c0ee8b
CL
403 struct rpc_rqst *req = task->tk_rqstp;
404 struct rpc_xprt *xprt = task->tk_xprt;
405 unsigned long cwnd = xprt->cwnd;
1da177e4 406
1da177e4
LT
407 if (result >= 0 && cwnd <= xprt->cong) {
408 /* The (cwnd >> 1) term makes sure
409 * the result gets rounded properly. */
410 cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
411 if (cwnd > RPC_MAXCWND(xprt))
412 cwnd = RPC_MAXCWND(xprt);
49e9a890 413 __xprt_lock_write_next_cong(xprt);
1da177e4
LT
414 } else if (result == -ETIMEDOUT) {
415 cwnd >>= 1;
416 if (cwnd < RPC_CWNDSCALE)
417 cwnd = RPC_CWNDSCALE;
418 }
46121cf7 419 dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
1da177e4
LT
420 xprt->cong, xprt->cwnd, cwnd);
421 xprt->cwnd = cwnd;
46c0ee8b 422 __xprt_put_cong(xprt, req);
1da177e4 423}
12444809 424EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
1da177e4 425
44fbac22
CL
426/**
427 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
428 * @xprt: transport with waiting tasks
429 * @status: result code to plant in each task before waking it
430 *
431 */
432void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
433{
434 if (status < 0)
435 rpc_wake_up_status(&xprt->pending, status);
436 else
437 rpc_wake_up(&xprt->pending);
438}
12444809 439EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
44fbac22 440
c7b2cae8
CL
441/**
442 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
443 * @task: task to be put to sleep
0b80ae42 444 * @action: function pointer to be executed after wait
c7b2cae8 445 */
b6ddf64f 446void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
c7b2cae8
CL
447{
448 struct rpc_rqst *req = task->tk_rqstp;
449 struct rpc_xprt *xprt = req->rq_xprt;
450
451 task->tk_timeout = req->rq_timeout;
b6ddf64f 452 rpc_sleep_on(&xprt->pending, task, action);
c7b2cae8 453}
12444809 454EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
c7b2cae8
CL
455
456/**
457 * xprt_write_space - wake the task waiting for transport output buffer space
458 * @xprt: transport with waiting tasks
459 *
460 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
461 */
462void xprt_write_space(struct rpc_xprt *xprt)
463{
464 if (unlikely(xprt->shutdown))
465 return;
466
467 spin_lock_bh(&xprt->transport_lock);
468 if (xprt->snd_task) {
46121cf7
CL
469 dprintk("RPC: write space: waking waiting task on "
470 "xprt %p\n", xprt);
fda13939 471 rpc_wake_up_queued_task(&xprt->pending, xprt->snd_task);
c7b2cae8
CL
472 }
473 spin_unlock_bh(&xprt->transport_lock);
474}
12444809 475EXPORT_SYMBOL_GPL(xprt_write_space);
c7b2cae8 476
fe3aca29
CL
477/**
478 * xprt_set_retrans_timeout_def - set a request's retransmit timeout
479 * @task: task whose timeout is to be set
480 *
481 * Set a request's retransmit timeout based on the transport's
482 * default timeout parameters. Used by transports that don't adjust
483 * the retransmit timeout based on round-trip time estimation.
484 */
485void xprt_set_retrans_timeout_def(struct rpc_task *task)
486{
487 task->tk_timeout = task->tk_rqstp->rq_timeout;
488}
12444809 489EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def);
fe3aca29
CL
490
491/*
492 * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
493 * @task: task whose timeout is to be set
cca5172a 494 *
fe3aca29
CL
495 * Set a request's retransmit timeout using the RTT estimator.
496 */
497void xprt_set_retrans_timeout_rtt(struct rpc_task *task)
498{
499 int timer = task->tk_msg.rpc_proc->p_timer;
ba7392bb
TM
500 struct rpc_clnt *clnt = task->tk_client;
501 struct rpc_rtt *rtt = clnt->cl_rtt;
fe3aca29 502 struct rpc_rqst *req = task->tk_rqstp;
ba7392bb 503 unsigned long max_timeout = clnt->cl_timeout->to_maxval;
fe3aca29
CL
504
505 task->tk_timeout = rpc_calc_rto(rtt, timer);
506 task->tk_timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
507 if (task->tk_timeout > max_timeout || task->tk_timeout == 0)
508 task->tk_timeout = max_timeout;
509}
12444809 510EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt);
fe3aca29 511
1da177e4
LT
512static void xprt_reset_majortimeo(struct rpc_rqst *req)
513{
ba7392bb 514 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
1da177e4
LT
515
516 req->rq_majortimeo = req->rq_timeout;
517 if (to->to_exponential)
518 req->rq_majortimeo <<= to->to_retries;
519 else
520 req->rq_majortimeo += to->to_increment * to->to_retries;
521 if (req->rq_majortimeo > to->to_maxval || req->rq_majortimeo == 0)
522 req->rq_majortimeo = to->to_maxval;
523 req->rq_majortimeo += jiffies;
524}
525
9903cd1c
CL
526/**
527 * xprt_adjust_timeout - adjust timeout values for next retransmit
528 * @req: RPC request containing parameters to use for the adjustment
529 *
1da177e4
LT
530 */
531int xprt_adjust_timeout(struct rpc_rqst *req)
532{
533 struct rpc_xprt *xprt = req->rq_xprt;
ba7392bb 534 const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
1da177e4
LT
535 int status = 0;
536
537 if (time_before(jiffies, req->rq_majortimeo)) {
538 if (to->to_exponential)
539 req->rq_timeout <<= 1;
540 else
541 req->rq_timeout += to->to_increment;
542 if (to->to_maxval && req->rq_timeout >= to->to_maxval)
543 req->rq_timeout = to->to_maxval;
544 req->rq_retries++;
1da177e4
LT
545 } else {
546 req->rq_timeout = to->to_initval;
547 req->rq_retries = 0;
548 xprt_reset_majortimeo(req);
549 /* Reset the RTT counters == "slow start" */
4a0f8c04 550 spin_lock_bh(&xprt->transport_lock);
1da177e4 551 rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
4a0f8c04 552 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
553 status = -ETIMEDOUT;
554 }
555
556 if (req->rq_timeout == 0) {
557 printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
558 req->rq_timeout = 5 * HZ;
559 }
560 return status;
561}
562
65f27f38 563static void xprt_autoclose(struct work_struct *work)
1da177e4 564{
65f27f38
DH
565 struct rpc_xprt *xprt =
566 container_of(work, struct rpc_xprt, task_cleanup);
1da177e4 567
a246b010 568 xprt->ops->close(xprt);
66af1e55 569 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1da177e4
LT
570 xprt_release_write(xprt, NULL);
571}
572
9903cd1c 573/**
62da3b24 574 * xprt_disconnect_done - mark a transport as disconnected
9903cd1c
CL
575 * @xprt: transport to flag for disconnect
576 *
1da177e4 577 */
62da3b24 578void xprt_disconnect_done(struct rpc_xprt *xprt)
1da177e4 579{
46121cf7 580 dprintk("RPC: disconnected transport %p\n", xprt);
4a0f8c04 581 spin_lock_bh(&xprt->transport_lock);
1da177e4 582 xprt_clear_connected(xprt);
44fbac22 583 xprt_wake_pending_tasks(xprt, -ENOTCONN);
4a0f8c04 584 spin_unlock_bh(&xprt->transport_lock);
1da177e4 585}
62da3b24 586EXPORT_SYMBOL_GPL(xprt_disconnect_done);
1da177e4 587
66af1e55
TM
588/**
589 * xprt_force_disconnect - force a transport to disconnect
590 * @xprt: transport to disconnect
591 *
592 */
593void xprt_force_disconnect(struct rpc_xprt *xprt)
594{
595 /* Don't race with the test_bit() in xprt_clear_locked() */
596 spin_lock_bh(&xprt->transport_lock);
597 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
598 /* Try to schedule an autoclose RPC call */
599 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
600 queue_work(rpciod_workqueue, &xprt->task_cleanup);
fda13939 601 xprt_wake_pending_tasks(xprt, -ENOTCONN);
66af1e55
TM
602 spin_unlock_bh(&xprt->transport_lock);
603}
66af1e55 604
7c1d71cf
TM
605/**
606 * xprt_conditional_disconnect - force a transport to disconnect
607 * @xprt: transport to disconnect
608 * @cookie: 'connection cookie'
609 *
610 * This attempts to break the connection if and only if 'cookie' matches
611 * the current transport 'connection cookie'. It ensures that we don't
612 * try to break the connection more than once when we need to retransmit
613 * a batch of RPC requests.
614 *
615 */
616void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
617{
618 /* Don't race with the test_bit() in xprt_clear_locked() */
619 spin_lock_bh(&xprt->transport_lock);
620 if (cookie != xprt->connect_cookie)
621 goto out;
622 if (test_bit(XPRT_CLOSING, &xprt->state) || !xprt_connected(xprt))
623 goto out;
624 set_bit(XPRT_CLOSE_WAIT, &xprt->state);
625 /* Try to schedule an autoclose RPC call */
626 if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
627 queue_work(rpciod_workqueue, &xprt->task_cleanup);
628 xprt_wake_pending_tasks(xprt, -ENOTCONN);
629out:
630 spin_unlock_bh(&xprt->transport_lock);
631}
632
1da177e4
LT
633static void
634xprt_init_autodisconnect(unsigned long data)
635{
636 struct rpc_xprt *xprt = (struct rpc_xprt *)data;
637
4a0f8c04 638 spin_lock(&xprt->transport_lock);
1da177e4
LT
639 if (!list_empty(&xprt->recv) || xprt->shutdown)
640 goto out_abort;
2226feb6 641 if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
1da177e4 642 goto out_abort;
4a0f8c04 643 spin_unlock(&xprt->transport_lock);
2226feb6 644 if (xprt_connecting(xprt))
1da177e4
LT
645 xprt_release_write(xprt, NULL);
646 else
c1384c9c 647 queue_work(rpciod_workqueue, &xprt->task_cleanup);
1da177e4
LT
648 return;
649out_abort:
4a0f8c04 650 spin_unlock(&xprt->transport_lock);
1da177e4
LT
651}
652
9903cd1c
CL
653/**
654 * xprt_connect - schedule a transport connect operation
655 * @task: RPC task that is requesting the connect
1da177e4
LT
656 *
657 */
658void xprt_connect(struct rpc_task *task)
659{
660 struct rpc_xprt *xprt = task->tk_xprt;
661
46121cf7 662 dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
1da177e4
LT
663 xprt, (xprt_connected(xprt) ? "is" : "is not"));
664
ec739ef0 665 if (!xprt_bound(xprt)) {
1da177e4
LT
666 task->tk_status = -EIO;
667 return;
668 }
669 if (!xprt_lock_write(xprt, task))
670 return;
671 if (xprt_connected(xprt))
a246b010
CL
672 xprt_release_write(xprt, task);
673 else {
674 if (task->tk_rqstp)
675 task->tk_rqstp->rq_bytes_sent = 0;
1da177e4 676
03bf4b70 677 task->tk_timeout = xprt->connect_timeout;
5d00837b 678 rpc_sleep_on(&xprt->pending, task, xprt_connect_status);
262ca07d 679 xprt->stat.connect_start = jiffies;
a246b010 680 xprt->ops->connect(task);
1da177e4
LT
681 }
682 return;
1da177e4
LT
683}
684
9903cd1c 685static void xprt_connect_status(struct rpc_task *task)
1da177e4
LT
686{
687 struct rpc_xprt *xprt = task->tk_xprt;
688
cd983ef8 689 if (task->tk_status == 0) {
262ca07d
CL
690 xprt->stat.connect_count++;
691 xprt->stat.connect_time += (long)jiffies - xprt->stat.connect_start;
46121cf7 692 dprintk("RPC: %5u xprt_connect_status: connection established\n",
1da177e4
LT
693 task->tk_pid);
694 return;
695 }
696
1da177e4 697 switch (task->tk_status) {
1da177e4 698 case -ENOTCONN:
46121cf7 699 dprintk("RPC: %5u xprt_connect_status: connection broken\n",
23475d66
CL
700 task->tk_pid);
701 break;
1da177e4 702 case -ETIMEDOUT:
46121cf7
CL
703 dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
704 "out\n", task->tk_pid);
1da177e4
LT
705 break;
706 default:
46121cf7
CL
707 dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
708 "server %s\n", task->tk_pid, -task->tk_status,
709 task->tk_client->cl_server);
23475d66
CL
710 xprt_release_write(xprt, task);
711 task->tk_status = -EIO;
1da177e4 712 }
1da177e4
LT
713}
714
9903cd1c
CL
715/**
716 * xprt_lookup_rqst - find an RPC request corresponding to an XID
717 * @xprt: transport on which the original request was transmitted
718 * @xid: RPC XID of incoming reply
719 *
1da177e4 720 */
d8ed029d 721struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
1da177e4
LT
722{
723 struct list_head *pos;
1da177e4
LT
724
725 list_for_each(pos, &xprt->recv) {
726 struct rpc_rqst *entry = list_entry(pos, struct rpc_rqst, rq_list);
262ca07d
CL
727 if (entry->rq_xid == xid)
728 return entry;
1da177e4 729 }
46121cf7
CL
730
731 dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
732 ntohl(xid));
262ca07d
CL
733 xprt->stat.bad_xids++;
734 return NULL;
1da177e4 735}
12444809 736EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
1da177e4 737
1570c1e4
CL
738/**
739 * xprt_update_rtt - update an RPC client's RTT state after receiving a reply
740 * @task: RPC request that recently completed
741 *
742 */
743void xprt_update_rtt(struct rpc_task *task)
744{
745 struct rpc_rqst *req = task->tk_rqstp;
746 struct rpc_rtt *rtt = task->tk_client->cl_rtt;
747 unsigned timer = task->tk_msg.rpc_proc->p_timer;
748
749 if (timer) {
750 if (req->rq_ntrans == 1)
751 rpc_update_rtt(rtt, timer,
752 (long)jiffies - req->rq_xtime);
753 rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
754 }
755}
12444809 756EXPORT_SYMBOL_GPL(xprt_update_rtt);
1570c1e4 757
9903cd1c
CL
758/**
759 * xprt_complete_rqst - called when reply processing is complete
1570c1e4 760 * @task: RPC request that recently completed
9903cd1c
CL
761 * @copied: actual number of bytes received from the transport
762 *
1570c1e4 763 * Caller holds transport lock.
1da177e4 764 */
1570c1e4 765void xprt_complete_rqst(struct rpc_task *task, int copied)
1da177e4 766{
1570c1e4 767 struct rpc_rqst *req = task->tk_rqstp;
fda13939 768 struct rpc_xprt *xprt = req->rq_xprt;
1da177e4 769
1570c1e4
CL
770 dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
771 task->tk_pid, ntohl(req->rq_xid), copied);
1da177e4 772
fda13939 773 xprt->stat.recvs++;
ef759a2e
CL
774 task->tk_rtt = (long)jiffies - req->rq_xtime;
775
1da177e4 776 list_del_init(&req->rq_list);
1e799b67 777 req->rq_private_buf.len = copied;
43ac3f29
TM
778 /* Ensure all writes are done before we update req->rq_received */
779 smp_wmb();
1e799b67 780 req->rq_received = copied;
fda13939 781 rpc_wake_up_queued_task(&xprt->pending, task);
1da177e4 782}
12444809 783EXPORT_SYMBOL_GPL(xprt_complete_rqst);
1da177e4 784
46c0ee8b 785static void xprt_timer(struct rpc_task *task)
1da177e4 786{
46c0ee8b 787 struct rpc_rqst *req = task->tk_rqstp;
1da177e4
LT
788 struct rpc_xprt *xprt = req->rq_xprt;
789
5d00837b
TM
790 if (task->tk_status != -ETIMEDOUT)
791 return;
46121cf7 792 dprintk("RPC: %5u xprt_timer\n", task->tk_pid);
1da177e4 793
5d00837b 794 spin_lock_bh(&xprt->transport_lock);
46c0ee8b
CL
795 if (!req->rq_received) {
796 if (xprt->ops->timer)
797 xprt->ops->timer(task);
5d00837b
TM
798 } else
799 task->tk_status = 0;
800 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
801}
802
9903cd1c
CL
803/**
804 * xprt_prepare_transmit - reserve the transport before sending a request
805 * @task: RPC task about to send a request
806 *
1da177e4 807 */
9903cd1c 808int xprt_prepare_transmit(struct rpc_task *task)
1da177e4
LT
809{
810 struct rpc_rqst *req = task->tk_rqstp;
811 struct rpc_xprt *xprt = req->rq_xprt;
812 int err = 0;
813
46121cf7 814 dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
1da177e4 815
4a0f8c04 816 spin_lock_bh(&xprt->transport_lock);
1da177e4
LT
817 if (req->rq_received && !req->rq_bytes_sent) {
818 err = req->rq_received;
819 goto out_unlock;
820 }
12a80469 821 if (!xprt->ops->reserve_xprt(task)) {
1da177e4
LT
822 err = -EAGAIN;
823 goto out_unlock;
824 }
825
826 if (!xprt_connected(xprt)) {
827 err = -ENOTCONN;
828 goto out_unlock;
829 }
830out_unlock:
4a0f8c04 831 spin_unlock_bh(&xprt->transport_lock);
1da177e4
LT
832 return err;
833}
834
e0ab53de 835void xprt_end_transmit(struct rpc_task *task)
5e5ce5be 836{
e0ab53de 837 xprt_release_write(task->tk_xprt, task);
5e5ce5be
TM
838}
839
9903cd1c
CL
840/**
841 * xprt_transmit - send an RPC request on a transport
842 * @task: controlling RPC task
843 *
844 * We have to copy the iovec because sendmsg fiddles with its contents.
845 */
846void xprt_transmit(struct rpc_task *task)
1da177e4 847{
1da177e4
LT
848 struct rpc_rqst *req = task->tk_rqstp;
849 struct rpc_xprt *xprt = req->rq_xprt;
a246b010 850 int status;
1da177e4 851
46121cf7 852 dprintk("RPC: %5u xprt_transmit(%u)\n", task->tk_pid, req->rq_slen);
1da177e4 853
1da177e4
LT
854 if (!req->rq_received) {
855 if (list_empty(&req->rq_list)) {
4a0f8c04 856 spin_lock_bh(&xprt->transport_lock);
1da177e4
LT
857 /* Update the softirq receive buffer */
858 memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
859 sizeof(req->rq_private_buf));
860 /* Add request to the receive list */
861 list_add_tail(&req->rq_list, &xprt->recv);
4a0f8c04 862 spin_unlock_bh(&xprt->transport_lock);
1da177e4 863 xprt_reset_majortimeo(req);
0f9dc2b1
TM
864 /* Turn off autodisconnect */
865 del_singleshot_timer_sync(&xprt->timer);
1da177e4
LT
866 }
867 } else if (!req->rq_bytes_sent)
868 return;
869
7c1d71cf 870 req->rq_connect_cookie = xprt->connect_cookie;
b22602a6 871 req->rq_xtime = jiffies;
a246b010 872 status = xprt->ops->send_request(task);
fe3aca29 873 if (status == 0) {
46121cf7 874 dprintk("RPC: %5u xmit complete\n", task->tk_pid);
fe3aca29 875 spin_lock_bh(&xprt->transport_lock);
262ca07d 876
fe3aca29 877 xprt->ops->set_retrans_timeout(task);
262ca07d
CL
878
879 xprt->stat.sends++;
880 xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
881 xprt->stat.bklog_u += xprt->backlog.qlen;
882
fe3aca29
CL
883 /* Don't race with disconnect */
884 if (!xprt_connected(xprt))
885 task->tk_status = -ENOTCONN;
886 else if (!req->rq_received)
5d00837b 887 rpc_sleep_on(&xprt->pending, task, xprt_timer);
fe3aca29
CL
888 spin_unlock_bh(&xprt->transport_lock);
889 return;
890 }
1da177e4
LT
891
892 /* Note: at this point, task->tk_sleeping has not yet been set,
893 * hence there is no danger of the waking up task being put on
894 * schedq, and being picked up by a parallel run of rpciod().
895 */
896 task->tk_status = status;
e0ab53de 897 if (status == -ECONNREFUSED)
5d00837b 898 rpc_sleep_on(&xprt->sending, task, NULL);
1da177e4
LT
899}
900
9903cd1c 901static inline void do_xprt_reserve(struct rpc_task *task)
1da177e4
LT
902{
903 struct rpc_xprt *xprt = task->tk_xprt;
904
905 task->tk_status = 0;
906 if (task->tk_rqstp)
907 return;
908 if (!list_empty(&xprt->free)) {
909 struct rpc_rqst *req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
910 list_del_init(&req->rq_list);
911 task->tk_rqstp = req;
912 xprt_request_init(task, xprt);
913 return;
914 }
46121cf7 915 dprintk("RPC: waiting for request slot\n");
1da177e4
LT
916 task->tk_status = -EAGAIN;
917 task->tk_timeout = 0;
5d00837b 918 rpc_sleep_on(&xprt->backlog, task, NULL);
1da177e4
LT
919}
920
9903cd1c
CL
921/**
922 * xprt_reserve - allocate an RPC request slot
923 * @task: RPC task requesting a slot allocation
924 *
925 * If no more slots are available, place the task on the transport's
926 * backlog queue.
927 */
928void xprt_reserve(struct rpc_task *task)
1da177e4
LT
929{
930 struct rpc_xprt *xprt = task->tk_xprt;
931
932 task->tk_status = -EIO;
0065db32
TM
933 spin_lock(&xprt->reserve_lock);
934 do_xprt_reserve(task);
935 spin_unlock(&xprt->reserve_lock);
1da177e4
LT
936}
937
d8ed029d 938static inline __be32 xprt_alloc_xid(struct rpc_xprt *xprt)
1da177e4
LT
939{
940 return xprt->xid++;
941}
942
943static inline void xprt_init_xid(struct rpc_xprt *xprt)
944{
bf3fcf89 945 xprt->xid = net_random();
1da177e4
LT
946}
947
9903cd1c 948static void xprt_request_init(struct rpc_task *task, struct rpc_xprt *xprt)
1da177e4
LT
949{
950 struct rpc_rqst *req = task->tk_rqstp;
951
ba7392bb 952 req->rq_timeout = task->tk_client->cl_timeout->to_initval;
1da177e4
LT
953 req->rq_task = task;
954 req->rq_xprt = xprt;
02107148 955 req->rq_buffer = NULL;
1da177e4 956 req->rq_xid = xprt_alloc_xid(xprt);
ead5e1c2 957 req->rq_release_snd_buf = NULL;
da45828e 958 xprt_reset_majortimeo(req);
46121cf7 959 dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
1da177e4
LT
960 req, ntohl(req->rq_xid));
961}
962
9903cd1c
CL
963/**
964 * xprt_release - release an RPC request slot
965 * @task: task which is finished with the slot
966 *
1da177e4 967 */
9903cd1c 968void xprt_release(struct rpc_task *task)
1da177e4
LT
969{
970 struct rpc_xprt *xprt = task->tk_xprt;
971 struct rpc_rqst *req;
972
973 if (!(req = task->tk_rqstp))
974 return;
11c556b3 975 rpc_count_iostats(task);
4a0f8c04 976 spin_lock_bh(&xprt->transport_lock);
49e9a890 977 xprt->ops->release_xprt(xprt, task);
a58dd398
CL
978 if (xprt->ops->release_request)
979 xprt->ops->release_request(task);
1da177e4
LT
980 if (!list_empty(&req->rq_list))
981 list_del(&req->rq_list);
982 xprt->last_used = jiffies;
0065db32 983 if (list_empty(&xprt->recv))
a246b010 984 mod_timer(&xprt->timer,
03bf4b70 985 xprt->last_used + xprt->idle_timeout);
4a0f8c04 986 spin_unlock_bh(&xprt->transport_lock);
c5a4dd8b 987 xprt->ops->buf_free(req->rq_buffer);
1da177e4 988 task->tk_rqstp = NULL;
ead5e1c2
BF
989 if (req->rq_release_snd_buf)
990 req->rq_release_snd_buf(req);
1da177e4
LT
991 memset(req, 0, sizeof(*req)); /* mark unused */
992
46121cf7 993 dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
1da177e4 994
5dc07727 995 spin_lock(&xprt->reserve_lock);
1da177e4 996 list_add(&req->rq_list, &xprt->free);
555ee3af 997 rpc_wake_up_next(&xprt->backlog);
5dc07727 998 spin_unlock(&xprt->reserve_lock);
1da177e4
LT
999}
1000
c2866763
CL
1001/**
1002 * xprt_create_transport - create an RPC transport
96802a09 1003 * @args: rpc transport creation arguments
c2866763
CL
1004 *
1005 */
3c341b0b 1006struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
c2866763 1007{
c2866763
CL
1008 struct rpc_xprt *xprt;
1009 struct rpc_rqst *req;
bc25571e 1010 struct xprt_class *t;
c2866763 1011
bc25571e
TT
1012 spin_lock(&xprt_list_lock);
1013 list_for_each_entry(t, &xprt_list, list) {
4fa016eb 1014 if (t->ident == args->ident) {
bc25571e
TT
1015 spin_unlock(&xprt_list_lock);
1016 goto found;
1017 }
c2866763 1018 }
bc25571e 1019 spin_unlock(&xprt_list_lock);
4fa016eb 1020 printk(KERN_ERR "RPC: transport (%d) not supported\n", args->ident);
bc25571e
TT
1021 return ERR_PTR(-EIO);
1022
1023found:
1024 xprt = t->setup(args);
c8541ecd 1025 if (IS_ERR(xprt)) {
46121cf7 1026 dprintk("RPC: xprt_create_transport: failed, %ld\n",
c8541ecd
CL
1027 -PTR_ERR(xprt));
1028 return xprt;
c2866763
CL
1029 }
1030
6b6ca86b 1031 kref_init(&xprt->kref);
c2866763
CL
1032 spin_lock_init(&xprt->transport_lock);
1033 spin_lock_init(&xprt->reserve_lock);
1034
1035 INIT_LIST_HEAD(&xprt->free);
1036 INIT_LIST_HEAD(&xprt->recv);
65f27f38 1037 INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
b24b8a24
PE
1038 setup_timer(&xprt->timer, xprt_init_autodisconnect,
1039 (unsigned long)xprt);
c2866763
CL
1040 xprt->last_used = jiffies;
1041 xprt->cwnd = RPC_INITCWND;
a509050b 1042 xprt->bind_index = 0;
c2866763
CL
1043
1044 rpc_init_wait_queue(&xprt->binding, "xprt_binding");
1045 rpc_init_wait_queue(&xprt->pending, "xprt_pending");
1046 rpc_init_wait_queue(&xprt->sending, "xprt_sending");
1047 rpc_init_wait_queue(&xprt->resend, "xprt_resend");
1048 rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
1049
1050 /* initialize free list */
1051 for (req = &xprt->slot[xprt->max_reqs-1]; req >= &xprt->slot[0]; req--)
1052 list_add(&req->rq_list, &xprt->free);
1053
1054 xprt_init_xid(xprt);
1055
46121cf7 1056 dprintk("RPC: created transport %p with %u slots\n", xprt,
c2866763
CL
1057 xprt->max_reqs);
1058
1059 return xprt;
1060}
1061
9903cd1c
CL
1062/**
1063 * xprt_destroy - destroy an RPC transport, killing off all requests.
6b6ca86b 1064 * @kref: kref for the transport to destroy
9903cd1c 1065 *
1da177e4 1066 */
6b6ca86b 1067static void xprt_destroy(struct kref *kref)
1da177e4 1068{
6b6ca86b
TM
1069 struct rpc_xprt *xprt = container_of(kref, struct rpc_xprt, kref);
1070
46121cf7 1071 dprintk("RPC: destroying transport %p\n", xprt);
0065db32
TM
1072 xprt->shutdown = 1;
1073 del_timer_sync(&xprt->timer);
c8541ecd 1074
f6a1cc89
TM
1075 rpc_destroy_wait_queue(&xprt->binding);
1076 rpc_destroy_wait_queue(&xprt->pending);
1077 rpc_destroy_wait_queue(&xprt->sending);
1078 rpc_destroy_wait_queue(&xprt->resend);
1079 rpc_destroy_wait_queue(&xprt->backlog);
c8541ecd
CL
1080 /*
1081 * Tear down transport state and free the rpc_xprt
1082 */
a246b010 1083 xprt->ops->destroy(xprt);
6b6ca86b 1084}
1da177e4 1085
6b6ca86b
TM
1086/**
1087 * xprt_put - release a reference to an RPC transport.
1088 * @xprt: pointer to the transport
1089 *
1090 */
1091void xprt_put(struct rpc_xprt *xprt)
1092{
1093 kref_put(&xprt->kref, xprt_destroy);
1094}
1095
1096/**
1097 * xprt_get - return a reference to an RPC transport.
1098 * @xprt: pointer to the transport
1099 *
1100 */
1101struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
1102{
1103 kref_get(&xprt->kref);
1104 return xprt;
1da177e4 1105}
This page took 0.460594 seconds and 5 git commands to generate.