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