xprt.c 29.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12
/*
 *  linux/net/sunrpc/xprt.c
 *
 *  This is a generic RPC call interface supporting congestion avoidance,
 *  and asynchronous calls.
 *
 *  The interface works like this:
 *
 *  -	When a process places a call, it allocates a request slot if
 *	one is available. Otherwise, it sleeps on the backlog queue
 *	(xprt_reserve).
 *  -	Next, the caller puts together the RPC message, stuffs it into
13 14 15
 *	the request struct, and calls xprt_transmit().
 *  -	xprt_transmit sends the message and installs the caller on the
 *	transport's wait list. At the same time, it installs a timer that
L
Linus Torvalds 已提交
16 17
 *	is run after the packet's timeout has expired.
 *  -	When a packet arrives, the data_ready handler walks the list of
18
 *	pending requests for that transport. If a matching XID is found, the
L
Linus Torvalds 已提交
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 *	caller is woken up, and the timer removed.
 *  -	When no reply arrives within the timeout interval, the timer is
 *	fired by the kernel and runs xprt_timer(). It either adjusts the
 *	timeout values (minor timeout) or wakes up the caller with a status
 *	of -ETIMEDOUT.
 *  -	When the caller receives a notification from RPC that a reply arrived,
 *	it should release the RPC slot, and process the reply.
 *	If the call timed out, it may choose to retry the operation by
 *	adjusting the initial timeout value, and simply calling rpc_call
 *	again.
 *
 *  Support for async RPC is done through a set of RPC-specific scheduling
 *  primitives that `transparently' work for processes as well as async
 *  tasks that rely on callbacks.
 *
 *  Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
35 36
 *
 *  Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
L
Linus Torvalds 已提交
37 38
 */

39 40
#include <linux/module.h>

L
Linus Torvalds 已提交
41
#include <linux/types.h>
42
#include <linux/interrupt.h>
L
Linus Torvalds 已提交
43
#include <linux/workqueue.h>
44
#include <linux/net.h>
L
Linus Torvalds 已提交
45

46
#include <linux/sunrpc/clnt.h>
47
#include <linux/sunrpc/metrics.h>
L
Linus Torvalds 已提交
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64

/*
 * Local variables
 */

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_XPRT
#endif

/*
 * Local functions
 */
static void	xprt_request_init(struct rpc_task *, struct rpc_xprt *);
static inline void	do_xprt_reserve(struct rpc_task *);
static void	xprt_connect_status(struct rpc_task *task);
static int      __xprt_get_cong(struct rpc_xprt *, struct rpc_task *);

J
Jiri Slaby 已提交
65
static DEFINE_SPINLOCK(xprt_list_lock);
66 67
static LIST_HEAD(xprt_list);

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
/*
 * The transport code maintains an estimate on the maximum number of out-
 * standing RPC requests, using a smoothed version of the congestion
 * avoidance implemented in 44BSD. This is basically the Van Jacobson
 * congestion algorithm: If a retransmit occurs, the congestion window is
 * halved; otherwise, it is incremented by 1/cwnd when
 *
 *	-	a reply is received and
 *	-	a full number of requests are outstanding and
 *	-	the congestion window hasn't been updated recently.
 */
#define RPC_CWNDSHIFT		(8U)
#define RPC_CWNDSCALE		(1U << RPC_CWNDSHIFT)
#define RPC_INITCWND		RPC_CWNDSCALE
#define RPC_MAXCWND(xprt)	((xprt)->max_reqs << RPC_CWNDSHIFT)

#define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)
L
Linus Torvalds 已提交
85

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
/**
 * xprt_register_transport - register a transport implementation
 * @transport: transport to register
 *
 * If a transport implementation is loaded as a kernel module, it can
 * call this interface to make itself known to the RPC client.
 *
 * Returns:
 * 0:		transport successfully registered
 * -EEXIST:	transport already registered
 * -EINVAL:	transport module being unloaded
 */
int xprt_register_transport(struct xprt_class *transport)
{
	struct xprt_class *t;
	int result;

	result = -EEXIST;
	spin_lock(&xprt_list_lock);
	list_for_each_entry(t, &xprt_list, list) {
		/* don't register the same transport class twice */
107
		if (t->ident == transport->ident)
108 109 110
			goto out;
	}

111 112 113 114
	list_add_tail(&transport->list, &xprt_list);
	printk(KERN_INFO "RPC: Registered %s transport module.\n",
	       transport->name);
	result = 0;
115 116 117 118 119 120 121 122 123

out:
	spin_unlock(&xprt_list_lock);
	return result;
}
EXPORT_SYMBOL_GPL(xprt_register_transport);

/**
 * xprt_unregister_transport - unregister a transport implementation
124
 * @transport: transport to unregister
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
 *
 * Returns:
 * 0:		transport successfully unregistered
 * -ENOENT:	transport never registered
 */
int xprt_unregister_transport(struct xprt_class *transport)
{
	struct xprt_class *t;
	int result;

	result = 0;
	spin_lock(&xprt_list_lock);
	list_for_each_entry(t, &xprt_list, list) {
		if (t == transport) {
			printk(KERN_INFO
				"RPC: Unregistered %s transport module.\n",
				transport->name);
			list_del_init(&transport->list);
			goto out;
		}
	}
	result = -ENOENT;

out:
	spin_unlock(&xprt_list_lock);
	return result;
}
EXPORT_SYMBOL_GPL(xprt_unregister_transport);

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
/**
 * xprt_load_transport - load a transport implementation
 * @transport_name: transport to load
 *
 * Returns:
 * 0:		transport successfully loaded
 * -ENOENT:	transport module not available
 */
int xprt_load_transport(const char *transport_name)
{
	struct xprt_class *t;
	char module_name[sizeof t->name + 5];
	int result;

	result = 0;
	spin_lock(&xprt_list_lock);
	list_for_each_entry(t, &xprt_list, list) {
		if (strcmp(t->name, transport_name) == 0) {
			spin_unlock(&xprt_list_lock);
			goto out;
		}
	}
	spin_unlock(&xprt_list_lock);
	strcpy(module_name, "xprt");
	strncat(module_name, transport_name, sizeof t->name);
	result = request_module(module_name);
out:
	return result;
}
EXPORT_SYMBOL_GPL(xprt_load_transport);

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
/**
 * xprt_reserve_xprt - serialize write access to transports
 * @task: task that is requesting access to the transport
 *
 * This prevents mixing the payload of separate requests, and prevents
 * transport connects from colliding with writes.  No congestion control
 * is provided.
 */
int xprt_reserve_xprt(struct rpc_task *task)
{
	struct rpc_xprt	*xprt = task->tk_xprt;
	struct rpc_rqst *req = task->tk_rqstp;

	if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
		if (task == xprt->snd_task)
			return 1;
		if (task == NULL)
			return 0;
		goto out_sleep;
	}
	xprt->snd_task = task;
	if (req) {
		req->rq_bytes_sent = 0;
		req->rq_ntrans++;
	}
	return 1;

out_sleep:
213
	dprintk("RPC: %5u failed to lock transport %p\n",
214 215 216 217
			task->tk_pid, xprt);
	task->tk_timeout = 0;
	task->tk_status = -EAGAIN;
	if (req && req->rq_ntrans)
218
		rpc_sleep_on(&xprt->resend, task, NULL);
219
	else
220
		rpc_sleep_on(&xprt->sending, task, NULL);
221 222
	return 0;
}
223
EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
224

225 226 227 228 229 230 231 232
static void xprt_clear_locked(struct rpc_xprt *xprt)
{
	xprt->snd_task = NULL;
	if (!test_bit(XPRT_CLOSE_WAIT, &xprt->state) || xprt->shutdown) {
		smp_mb__before_clear_bit();
		clear_bit(XPRT_LOCKED, &xprt->state);
		smp_mb__after_clear_bit();
	} else
233
		queue_work(rpciod_workqueue, &xprt->task_cleanup);
234 235
}

L
Linus Torvalds 已提交
236
/*
237 238 239 240 241 242
 * xprt_reserve_xprt_cong - serialize write access to transports
 * @task: task that is requesting access to the transport
 *
 * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
 * integrated into the decision of whether a request is allowed to be
 * woken up and given access to the transport.
L
Linus Torvalds 已提交
243
 */
244
int xprt_reserve_xprt_cong(struct rpc_task *task)
L
Linus Torvalds 已提交
245
{
246
	struct rpc_xprt	*xprt = task->tk_xprt;
L
Linus Torvalds 已提交
247 248
	struct rpc_rqst *req = task->tk_rqstp;

249
	if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
L
Linus Torvalds 已提交
250 251 252 253
		if (task == xprt->snd_task)
			return 1;
		goto out_sleep;
	}
254
	if (__xprt_get_cong(xprt, task)) {
L
Linus Torvalds 已提交
255 256 257 258 259 260 261
		xprt->snd_task = task;
		if (req) {
			req->rq_bytes_sent = 0;
			req->rq_ntrans++;
		}
		return 1;
	}
262
	xprt_clear_locked(xprt);
L
Linus Torvalds 已提交
263
out_sleep:
264
	dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
L
Linus Torvalds 已提交
265 266 267
	task->tk_timeout = 0;
	task->tk_status = -EAGAIN;
	if (req && req->rq_ntrans)
268
		rpc_sleep_on(&xprt->resend, task, NULL);
L
Linus Torvalds 已提交
269
	else
270
		rpc_sleep_on(&xprt->sending, task, NULL);
L
Linus Torvalds 已提交
271 272
	return 0;
}
273
EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
L
Linus Torvalds 已提交
274

275
static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
L
Linus Torvalds 已提交
276 277 278
{
	int retval;

C
Chuck Lever 已提交
279
	spin_lock_bh(&xprt->transport_lock);
280
	retval = xprt->ops->reserve_xprt(task);
C
Chuck Lever 已提交
281
	spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
282 283 284
	return retval;
}

285
static void __xprt_lock_write_next(struct rpc_xprt *xprt)
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
{
	struct rpc_task *task;
	struct rpc_rqst *req;

	if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
		return;

	task = rpc_wake_up_next(&xprt->resend);
	if (!task) {
		task = rpc_wake_up_next(&xprt->sending);
		if (!task)
			goto out_unlock;
	}

	req = task->tk_rqstp;
	xprt->snd_task = task;
	if (req) {
		req->rq_bytes_sent = 0;
		req->rq_ntrans++;
	}
	return;

out_unlock:
309
	xprt_clear_locked(xprt);
310 311 312
}

static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
313 314 315
{
	struct rpc_task *task;

316
	if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
L
Linus Torvalds 已提交
317
		return;
318
	if (RPCXPRT_CONGESTED(xprt))
L
Linus Torvalds 已提交
319 320 321 322 323 324 325
		goto out_unlock;
	task = rpc_wake_up_next(&xprt->resend);
	if (!task) {
		task = rpc_wake_up_next(&xprt->sending);
		if (!task)
			goto out_unlock;
	}
326
	if (__xprt_get_cong(xprt, task)) {
L
Linus Torvalds 已提交
327 328 329 330 331 332 333 334 335
		struct rpc_rqst *req = task->tk_rqstp;
		xprt->snd_task = task;
		if (req) {
			req->rq_bytes_sent = 0;
			req->rq_ntrans++;
		}
		return;
	}
out_unlock:
336
	xprt_clear_locked(xprt);
L
Linus Torvalds 已提交
337 338
}

339 340 341 342 343 344
/**
 * xprt_release_xprt - allow other requests to use a transport
 * @xprt: transport with other tasks potentially waiting
 * @task: task that is releasing access to the transport
 *
 * Note that "task" can be NULL.  No congestion control is provided.
L
Linus Torvalds 已提交
345
 */
346
void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
L
Linus Torvalds 已提交
347 348
{
	if (xprt->snd_task == task) {
349
		xprt_clear_locked(xprt);
L
Linus Torvalds 已提交
350 351 352
		__xprt_lock_write_next(xprt);
	}
}
353
EXPORT_SYMBOL_GPL(xprt_release_xprt);
L
Linus Torvalds 已提交
354

355 356 357 358 359 360 361 362 363 364 365
/**
 * xprt_release_xprt_cong - allow other requests to use a transport
 * @xprt: transport with other tasks potentially waiting
 * @task: task that is releasing access to the transport
 *
 * Note that "task" can be NULL.  Another task is awoken to use the
 * transport if the transport's congestion window allows it.
 */
void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
{
	if (xprt->snd_task == task) {
366
		xprt_clear_locked(xprt);
367 368 369
		__xprt_lock_write_next_cong(xprt);
	}
}
370
EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
371 372

static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
L
Linus Torvalds 已提交
373
{
C
Chuck Lever 已提交
374
	spin_lock_bh(&xprt->transport_lock);
375
	xprt->ops->release_xprt(xprt, task);
C
Chuck Lever 已提交
376
	spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
377 378 379 380 381 382 383 384 385 386 387 388 389
}

/*
 * Van Jacobson congestion avoidance. Check if the congestion window
 * overflowed. Put the task to sleep if this is the case.
 */
static int
__xprt_get_cong(struct rpc_xprt *xprt, struct rpc_task *task)
{
	struct rpc_rqst *req = task->tk_rqstp;

	if (req->rq_cong)
		return 1;
390
	dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
L
Linus Torvalds 已提交
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
			task->tk_pid, xprt->cong, xprt->cwnd);
	if (RPCXPRT_CONGESTED(xprt))
		return 0;
	req->rq_cong = 1;
	xprt->cong += RPC_CWNDSCALE;
	return 1;
}

/*
 * Adjust the congestion window, and wake up the next task
 * that has been sleeping due to congestion
 */
static void
__xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
{
	if (!req->rq_cong)
		return;
	req->rq_cong = 0;
	xprt->cong -= RPC_CWNDSCALE;
410
	__xprt_lock_write_next_cong(xprt);
L
Linus Torvalds 已提交
411 412
}

413 414 415 416 417 418 419 420 421 422
/**
 * xprt_release_rqst_cong - housekeeping when request is complete
 * @task: RPC request that recently completed
 *
 * Useful for transports that require congestion control.
 */
void xprt_release_rqst_cong(struct rpc_task *task)
{
	__xprt_put_cong(task->tk_xprt, task->tk_rqstp);
}
423
EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
424

425 426 427 428 429
/**
 * xprt_adjust_cwnd - adjust transport congestion window
 * @task: recently completed RPC request used to adjust window
 * @result: result code of completed RPC request
 *
L
Linus Torvalds 已提交
430 431
 * We use a time-smoothed congestion estimator to avoid heavy oscillation.
 */
432
void xprt_adjust_cwnd(struct rpc_task *task, int result)
L
Linus Torvalds 已提交
433
{
434 435 436
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = task->tk_xprt;
	unsigned long cwnd = xprt->cwnd;
L
Linus Torvalds 已提交
437 438 439 440 441 442 443

	if (result >= 0 && cwnd <= xprt->cong) {
		/* The (cwnd >> 1) term makes sure
		 * the result gets rounded properly. */
		cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
		if (cwnd > RPC_MAXCWND(xprt))
			cwnd = RPC_MAXCWND(xprt);
444
		__xprt_lock_write_next_cong(xprt);
L
Linus Torvalds 已提交
445 446 447 448 449
	} else if (result == -ETIMEDOUT) {
		cwnd >>= 1;
		if (cwnd < RPC_CWNDSCALE)
			cwnd = RPC_CWNDSCALE;
	}
450
	dprintk("RPC:       cong %ld, cwnd was %ld, now %ld\n",
L
Linus Torvalds 已提交
451 452
			xprt->cong, xprt->cwnd, cwnd);
	xprt->cwnd = cwnd;
453
	__xprt_put_cong(xprt, req);
L
Linus Torvalds 已提交
454
}
455
EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
L
Linus Torvalds 已提交
456

457 458 459 460 461 462 463 464 465 466 467 468 469
/**
 * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
 * @xprt: transport with waiting tasks
 * @status: result code to plant in each task before waking it
 *
 */
void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
{
	if (status < 0)
		rpc_wake_up_status(&xprt->pending, status);
	else
		rpc_wake_up(&xprt->pending);
}
470
EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
471

472 473 474
/**
 * xprt_wait_for_buffer_space - wait for transport output buffer to clear
 * @task: task to be put to sleep
R
Randy Dunlap 已提交
475
 * @action: function pointer to be executed after wait
476
 */
477
void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
478 479 480 481 482
{
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = req->rq_xprt;

	task->tk_timeout = req->rq_timeout;
483
	rpc_sleep_on(&xprt->pending, task, action);
484
}
485
EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
486 487 488 489 490 491 492 493 494 495 496 497 498 499

/**
 * xprt_write_space - wake the task waiting for transport output buffer space
 * @xprt: transport with waiting tasks
 *
 * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
 */
void xprt_write_space(struct rpc_xprt *xprt)
{
	if (unlikely(xprt->shutdown))
		return;

	spin_lock_bh(&xprt->transport_lock);
	if (xprt->snd_task) {
500 501
		dprintk("RPC:       write space: waking waiting task on "
				"xprt %p\n", xprt);
502
		rpc_wake_up_queued_task(&xprt->pending, xprt->snd_task);
503 504 505
	}
	spin_unlock_bh(&xprt->transport_lock);
}
506
EXPORT_SYMBOL_GPL(xprt_write_space);
507

508 509 510 511 512 513 514 515 516 517 518 519
/**
 * xprt_set_retrans_timeout_def - set a request's retransmit timeout
 * @task: task whose timeout is to be set
 *
 * Set a request's retransmit timeout based on the transport's
 * default timeout parameters.  Used by transports that don't adjust
 * the retransmit timeout based on round-trip time estimation.
 */
void xprt_set_retrans_timeout_def(struct rpc_task *task)
{
	task->tk_timeout = task->tk_rqstp->rq_timeout;
}
520
EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def);
521 522 523 524

/*
 * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
 * @task: task whose timeout is to be set
525
 *
526 527 528 529 530
 * Set a request's retransmit timeout using the RTT estimator.
 */
void xprt_set_retrans_timeout_rtt(struct rpc_task *task)
{
	int timer = task->tk_msg.rpc_proc->p_timer;
531 532
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rtt *rtt = clnt->cl_rtt;
533
	struct rpc_rqst *req = task->tk_rqstp;
534
	unsigned long max_timeout = clnt->cl_timeout->to_maxval;
535 536 537 538 539 540

	task->tk_timeout = rpc_calc_rto(rtt, timer);
	task->tk_timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
	if (task->tk_timeout > max_timeout || task->tk_timeout == 0)
		task->tk_timeout = max_timeout;
}
541
EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt);
542

L
Linus Torvalds 已提交
543 544
static void xprt_reset_majortimeo(struct rpc_rqst *req)
{
545
	const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
L
Linus Torvalds 已提交
546 547 548 549 550 551 552 553 554 555 556

	req->rq_majortimeo = req->rq_timeout;
	if (to->to_exponential)
		req->rq_majortimeo <<= to->to_retries;
	else
		req->rq_majortimeo += to->to_increment * to->to_retries;
	if (req->rq_majortimeo > to->to_maxval || req->rq_majortimeo == 0)
		req->rq_majortimeo = to->to_maxval;
	req->rq_majortimeo += jiffies;
}

557 558 559 560
/**
 * xprt_adjust_timeout - adjust timeout values for next retransmit
 * @req: RPC request containing parameters to use for the adjustment
 *
L
Linus Torvalds 已提交
561 562 563 564
 */
int xprt_adjust_timeout(struct rpc_rqst *req)
{
	struct rpc_xprt *xprt = req->rq_xprt;
565
	const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
L
Linus Torvalds 已提交
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
	int status = 0;

	if (time_before(jiffies, req->rq_majortimeo)) {
		if (to->to_exponential)
			req->rq_timeout <<= 1;
		else
			req->rq_timeout += to->to_increment;
		if (to->to_maxval && req->rq_timeout >= to->to_maxval)
			req->rq_timeout = to->to_maxval;
		req->rq_retries++;
	} else {
		req->rq_timeout = to->to_initval;
		req->rq_retries = 0;
		xprt_reset_majortimeo(req);
		/* Reset the RTT counters == "slow start" */
C
Chuck Lever 已提交
581
		spin_lock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
582
		rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
C
Chuck Lever 已提交
583
		spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
584 585 586 587 588 589 590 591 592 593
		status = -ETIMEDOUT;
	}

	if (req->rq_timeout == 0) {
		printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
		req->rq_timeout = 5 * HZ;
	}
	return status;
}

594
static void xprt_autoclose(struct work_struct *work)
L
Linus Torvalds 已提交
595
{
596 597
	struct rpc_xprt *xprt =
		container_of(work, struct rpc_xprt, task_cleanup);
L
Linus Torvalds 已提交
598

599
	xprt->ops->close(xprt);
600
	clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
L
Linus Torvalds 已提交
601 602 603
	xprt_release_write(xprt, NULL);
}

604
/**
605
 * xprt_disconnect_done - mark a transport as disconnected
606 607
 * @xprt: transport to flag for disconnect
 *
L
Linus Torvalds 已提交
608
 */
609
void xprt_disconnect_done(struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
610
{
611
	dprintk("RPC:       disconnected transport %p\n", xprt);
C
Chuck Lever 已提交
612
	spin_lock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
613
	xprt_clear_connected(xprt);
614
	xprt_wake_pending_tasks(xprt, -EAGAIN);
C
Chuck Lever 已提交
615
	spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
616
}
617
EXPORT_SYMBOL_GPL(xprt_disconnect_done);
L
Linus Torvalds 已提交
618

619 620 621 622 623 624 625 626 627 628 629 630 631
/**
 * xprt_force_disconnect - force a transport to disconnect
 * @xprt: transport to disconnect
 *
 */
void xprt_force_disconnect(struct rpc_xprt *xprt)
{
	/* Don't race with the test_bit() in xprt_clear_locked() */
	spin_lock_bh(&xprt->transport_lock);
	set_bit(XPRT_CLOSE_WAIT, &xprt->state);
	/* Try to schedule an autoclose RPC call */
	if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
		queue_work(rpciod_workqueue, &xprt->task_cleanup);
632
	xprt_wake_pending_tasks(xprt, -EAGAIN);
633 634 635
	spin_unlock_bh(&xprt->transport_lock);
}

636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
/**
 * xprt_conditional_disconnect - force a transport to disconnect
 * @xprt: transport to disconnect
 * @cookie: 'connection cookie'
 *
 * This attempts to break the connection if and only if 'cookie' matches
 * the current transport 'connection cookie'. It ensures that we don't
 * try to break the connection more than once when we need to retransmit
 * a batch of RPC requests.
 *
 */
void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
{
	/* Don't race with the test_bit() in xprt_clear_locked() */
	spin_lock_bh(&xprt->transport_lock);
	if (cookie != xprt->connect_cookie)
		goto out;
	if (test_bit(XPRT_CLOSING, &xprt->state) || !xprt_connected(xprt))
		goto out;
	set_bit(XPRT_CLOSE_WAIT, &xprt->state);
	/* Try to schedule an autoclose RPC call */
	if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
		queue_work(rpciod_workqueue, &xprt->task_cleanup);
659
	xprt_wake_pending_tasks(xprt, -EAGAIN);
660 661 662 663
out:
	spin_unlock_bh(&xprt->transport_lock);
}

L
Linus Torvalds 已提交
664 665 666 667 668
static void
xprt_init_autodisconnect(unsigned long data)
{
	struct rpc_xprt *xprt = (struct rpc_xprt *)data;

C
Chuck Lever 已提交
669
	spin_lock(&xprt->transport_lock);
L
Linus Torvalds 已提交
670 671
	if (!list_empty(&xprt->recv) || xprt->shutdown)
		goto out_abort;
672
	if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
L
Linus Torvalds 已提交
673
		goto out_abort;
C
Chuck Lever 已提交
674
	spin_unlock(&xprt->transport_lock);
675
	if (xprt_connecting(xprt))
L
Linus Torvalds 已提交
676 677
		xprt_release_write(xprt, NULL);
	else
678
		queue_work(rpciod_workqueue, &xprt->task_cleanup);
L
Linus Torvalds 已提交
679 680
	return;
out_abort:
C
Chuck Lever 已提交
681
	spin_unlock(&xprt->transport_lock);
L
Linus Torvalds 已提交
682 683
}

684 685 686
/**
 * xprt_connect - schedule a transport connect operation
 * @task: RPC task that is requesting the connect
L
Linus Torvalds 已提交
687 688 689 690 691 692
 *
 */
void xprt_connect(struct rpc_task *task)
{
	struct rpc_xprt	*xprt = task->tk_xprt;

693
	dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
L
Linus Torvalds 已提交
694 695
			xprt, (xprt_connected(xprt) ? "is" : "is not"));

696
	if (!xprt_bound(xprt)) {
697
		task->tk_status = -EAGAIN;
L
Linus Torvalds 已提交
698 699 700 701 702
		return;
	}
	if (!xprt_lock_write(xprt, task))
		return;
	if (xprt_connected(xprt))
703 704 705 706
		xprt_release_write(xprt, task);
	else {
		if (task->tk_rqstp)
			task->tk_rqstp->rq_bytes_sent = 0;
L
Linus Torvalds 已提交
707

708
		task->tk_timeout = xprt->connect_timeout;
709
		rpc_sleep_on(&xprt->pending, task, xprt_connect_status);
710
		xprt->stat.connect_start = jiffies;
711
		xprt->ops->connect(task);
L
Linus Torvalds 已提交
712 713 714 715
	}
	return;
}

716
static void xprt_connect_status(struct rpc_task *task)
L
Linus Torvalds 已提交
717 718 719
{
	struct rpc_xprt	*xprt = task->tk_xprt;

720
	if (task->tk_status == 0) {
721 722
		xprt->stat.connect_count++;
		xprt->stat.connect_time += (long)jiffies - xprt->stat.connect_start;
723
		dprintk("RPC: %5u xprt_connect_status: connection established\n",
L
Linus Torvalds 已提交
724 725 726 727 728
				task->tk_pid);
		return;
	}

	switch (task->tk_status) {
729 730
	case -EAGAIN:
		dprintk("RPC: %5u xprt_connect_status: retrying\n", task->tk_pid);
731
		break;
L
Linus Torvalds 已提交
732
	case -ETIMEDOUT:
733 734
		dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
				"out\n", task->tk_pid);
L
Linus Torvalds 已提交
735 736
		break;
	default:
737 738 739
		dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
				"server %s\n", task->tk_pid, -task->tk_status,
				task->tk_client->cl_server);
740 741
		xprt_release_write(xprt, task);
		task->tk_status = -EIO;
L
Linus Torvalds 已提交
742 743 744
	}
}

745 746 747 748 749
/**
 * xprt_lookup_rqst - find an RPC request corresponding to an XID
 * @xprt: transport on which the original request was transmitted
 * @xid: RPC XID of incoming reply
 *
L
Linus Torvalds 已提交
750
 */
751
struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
L
Linus Torvalds 已提交
752 753 754 755 756
{
	struct list_head *pos;

	list_for_each(pos, &xprt->recv) {
		struct rpc_rqst *entry = list_entry(pos, struct rpc_rqst, rq_list);
757 758
		if (entry->rq_xid == xid)
			return entry;
L
Linus Torvalds 已提交
759
	}
760 761 762

	dprintk("RPC:       xprt_lookup_rqst did not find xid %08x\n",
			ntohl(xid));
763 764
	xprt->stat.bad_xids++;
	return NULL;
L
Linus Torvalds 已提交
765
}
766
EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
L
Linus Torvalds 已提交
767

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
/**
 * xprt_update_rtt - update an RPC client's RTT state after receiving a reply
 * @task: RPC request that recently completed
 *
 */
void xprt_update_rtt(struct rpc_task *task)
{
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_rtt *rtt = task->tk_client->cl_rtt;
	unsigned timer = task->tk_msg.rpc_proc->p_timer;

	if (timer) {
		if (req->rq_ntrans == 1)
			rpc_update_rtt(rtt, timer,
					(long)jiffies - req->rq_xtime);
		rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
	}
}
786
EXPORT_SYMBOL_GPL(xprt_update_rtt);
787

788 789
/**
 * xprt_complete_rqst - called when reply processing is complete
790
 * @task: RPC request that recently completed
791 792
 * @copied: actual number of bytes received from the transport
 *
793
 * Caller holds transport lock.
L
Linus Torvalds 已提交
794
 */
795
void xprt_complete_rqst(struct rpc_task *task, int copied)
L
Linus Torvalds 已提交
796
{
797
	struct rpc_rqst *req = task->tk_rqstp;
798
	struct rpc_xprt *xprt = req->rq_xprt;
L
Linus Torvalds 已提交
799

800 801
	dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
			task->tk_pid, ntohl(req->rq_xid), copied);
L
Linus Torvalds 已提交
802

803
	xprt->stat.recvs++;
804 805
	task->tk_rtt = (long)jiffies - req->rq_xtime;

L
Linus Torvalds 已提交
806
	list_del_init(&req->rq_list);
807
	req->rq_private_buf.len = copied;
808 809
	/* Ensure all writes are done before we update req->rq_received */
	smp_wmb();
810
	req->rq_received = copied;
811
	rpc_wake_up_queued_task(&xprt->pending, task);
L
Linus Torvalds 已提交
812
}
813
EXPORT_SYMBOL_GPL(xprt_complete_rqst);
L
Linus Torvalds 已提交
814

815
static void xprt_timer(struct rpc_task *task)
L
Linus Torvalds 已提交
816
{
817
	struct rpc_rqst *req = task->tk_rqstp;
L
Linus Torvalds 已提交
818 819
	struct rpc_xprt *xprt = req->rq_xprt;

820 821
	if (task->tk_status != -ETIMEDOUT)
		return;
822
	dprintk("RPC: %5u xprt_timer\n", task->tk_pid);
L
Linus Torvalds 已提交
823

824
	spin_lock_bh(&xprt->transport_lock);
825 826 827
	if (!req->rq_received) {
		if (xprt->ops->timer)
			xprt->ops->timer(task);
828 829 830
	} else
		task->tk_status = 0;
	spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
831 832
}

833 834 835 836
/**
 * xprt_prepare_transmit - reserve the transport before sending a request
 * @task: RPC task about to send a request
 *
L
Linus Torvalds 已提交
837
 */
838
int xprt_prepare_transmit(struct rpc_task *task)
L
Linus Torvalds 已提交
839 840 841 842 843
{
	struct rpc_rqst	*req = task->tk_rqstp;
	struct rpc_xprt	*xprt = req->rq_xprt;
	int err = 0;

844
	dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
L
Linus Torvalds 已提交
845

C
Chuck Lever 已提交
846
	spin_lock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
847 848 849 850
	if (req->rq_received && !req->rq_bytes_sent) {
		err = req->rq_received;
		goto out_unlock;
	}
851
	if (!xprt->ops->reserve_xprt(task))
L
Linus Torvalds 已提交
852 853
		err = -EAGAIN;
out_unlock:
C
Chuck Lever 已提交
854
	spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
855 856 857
	return err;
}

858
void xprt_end_transmit(struct rpc_task *task)
859
{
860
	xprt_release_write(task->tk_xprt, task);
861 862
}

863 864 865 866 867 868 869
/**
 * xprt_transmit - send an RPC request on a transport
 * @task: controlling RPC task
 *
 * We have to copy the iovec because sendmsg fiddles with its contents.
 */
void xprt_transmit(struct rpc_task *task)
L
Linus Torvalds 已提交
870 871 872
{
	struct rpc_rqst	*req = task->tk_rqstp;
	struct rpc_xprt	*xprt = req->rq_xprt;
873
	int status;
L
Linus Torvalds 已提交
874

875
	dprintk("RPC: %5u xprt_transmit(%u)\n", task->tk_pid, req->rq_slen);
L
Linus Torvalds 已提交
876 877 878

	if (!req->rq_received) {
		if (list_empty(&req->rq_list)) {
C
Chuck Lever 已提交
879
			spin_lock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
880 881 882 883 884
			/* Update the softirq receive buffer */
			memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
					sizeof(req->rq_private_buf));
			/* Add request to the receive list */
			list_add_tail(&req->rq_list, &xprt->recv);
C
Chuck Lever 已提交
885
			spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
886
			xprt_reset_majortimeo(req);
887 888
			/* Turn off autodisconnect */
			del_singleshot_timer_sync(&xprt->timer);
L
Linus Torvalds 已提交
889 890 891 892
		}
	} else if (!req->rq_bytes_sent)
		return;

893
	req->rq_connect_cookie = xprt->connect_cookie;
894
	req->rq_xtime = jiffies;
895
	status = xprt->ops->send_request(task);
896 897 898 899
	if (status != 0) {
		task->tk_status = status;
		return;
	}
900

901 902
	dprintk("RPC: %5u xmit complete\n", task->tk_pid);
	spin_lock_bh(&xprt->transport_lock);
903

904
	xprt->ops->set_retrans_timeout(task);
905

906 907 908
	xprt->stat.sends++;
	xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
	xprt->stat.bklog_u += xprt->backlog.qlen;
L
Linus Torvalds 已提交
909

910 911 912 913 914 915
	/* Don't race with disconnect */
	if (!xprt_connected(xprt))
		task->tk_status = -ENOTCONN;
	else if (!req->rq_received)
		rpc_sleep_on(&xprt->pending, task, xprt_timer);
	spin_unlock_bh(&xprt->transport_lock);
L
Linus Torvalds 已提交
916 917
}

918
static inline void do_xprt_reserve(struct rpc_task *task)
L
Linus Torvalds 已提交
919 920 921 922 923 924 925 926 927 928 929 930 931
{
	struct rpc_xprt	*xprt = task->tk_xprt;

	task->tk_status = 0;
	if (task->tk_rqstp)
		return;
	if (!list_empty(&xprt->free)) {
		struct rpc_rqst	*req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
		list_del_init(&req->rq_list);
		task->tk_rqstp = req;
		xprt_request_init(task, xprt);
		return;
	}
932
	dprintk("RPC:       waiting for request slot\n");
L
Linus Torvalds 已提交
933 934
	task->tk_status = -EAGAIN;
	task->tk_timeout = 0;
935
	rpc_sleep_on(&xprt->backlog, task, NULL);
L
Linus Torvalds 已提交
936 937
}

938 939 940 941 942 943 944 945
/**
 * xprt_reserve - allocate an RPC request slot
 * @task: RPC task requesting a slot allocation
 *
 * If no more slots are available, place the task on the transport's
 * backlog queue.
 */
void xprt_reserve(struct rpc_task *task)
L
Linus Torvalds 已提交
946 947 948 949
{
	struct rpc_xprt	*xprt = task->tk_xprt;

	task->tk_status = -EIO;
950 951 952
	spin_lock(&xprt->reserve_lock);
	do_xprt_reserve(task);
	spin_unlock(&xprt->reserve_lock);
L
Linus Torvalds 已提交
953 954
}

955
static inline __be32 xprt_alloc_xid(struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
956 957 958 959 960 961
{
	return xprt->xid++;
}

static inline void xprt_init_xid(struct rpc_xprt *xprt)
{
962
	xprt->xid = net_random();
L
Linus Torvalds 已提交
963 964
}

965
static void xprt_request_init(struct rpc_task *task, struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
966 967 968
{
	struct rpc_rqst	*req = task->tk_rqstp;

969
	req->rq_timeout = task->tk_client->cl_timeout->to_initval;
L
Linus Torvalds 已提交
970 971
	req->rq_task	= task;
	req->rq_xprt    = xprt;
972
	req->rq_buffer  = NULL;
L
Linus Torvalds 已提交
973
	req->rq_xid     = xprt_alloc_xid(xprt);
974
	req->rq_release_snd_buf = NULL;
975
	xprt_reset_majortimeo(req);
976
	dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
L
Linus Torvalds 已提交
977 978 979
			req, ntohl(req->rq_xid));
}

980 981 982 983
/**
 * xprt_release - release an RPC request slot
 * @task: task which is finished with the slot
 *
L
Linus Torvalds 已提交
984
 */
985
void xprt_release(struct rpc_task *task)
L
Linus Torvalds 已提交
986 987 988 989 990 991
{
	struct rpc_xprt	*xprt = task->tk_xprt;
	struct rpc_rqst	*req;

	if (!(req = task->tk_rqstp))
		return;
992
	rpc_count_iostats(task);
C
Chuck Lever 已提交
993
	spin_lock_bh(&xprt->transport_lock);
994
	xprt->ops->release_xprt(xprt, task);
995 996
	if (xprt->ops->release_request)
		xprt->ops->release_request(task);
L
Linus Torvalds 已提交
997 998 999
	if (!list_empty(&req->rq_list))
		list_del(&req->rq_list);
	xprt->last_used = jiffies;
1000
	if (list_empty(&xprt->recv))
1001
		mod_timer(&xprt->timer,
1002
				xprt->last_used + xprt->idle_timeout);
C
Chuck Lever 已提交
1003
	spin_unlock_bh(&xprt->transport_lock);
1004
	xprt->ops->buf_free(req->rq_buffer);
L
Linus Torvalds 已提交
1005
	task->tk_rqstp = NULL;
1006 1007
	if (req->rq_release_snd_buf)
		req->rq_release_snd_buf(req);
L
Linus Torvalds 已提交
1008 1009
	memset(req, 0, sizeof(*req));	/* mark unused */

1010
	dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
L
Linus Torvalds 已提交
1011

C
Chuck Lever 已提交
1012
	spin_lock(&xprt->reserve_lock);
L
Linus Torvalds 已提交
1013
	list_add(&req->rq_list, &xprt->free);
1014
	rpc_wake_up_next(&xprt->backlog);
C
Chuck Lever 已提交
1015
	spin_unlock(&xprt->reserve_lock);
L
Linus Torvalds 已提交
1016 1017
}

1018 1019
/**
 * xprt_create_transport - create an RPC transport
1020
 * @args: rpc transport creation arguments
1021 1022
 *
 */
1023
struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
1024 1025 1026
{
	struct rpc_xprt	*xprt;
	struct rpc_rqst	*req;
1027
	struct xprt_class *t;
1028

1029 1030
	spin_lock(&xprt_list_lock);
	list_for_each_entry(t, &xprt_list, list) {
1031
		if (t->ident == args->ident) {
1032 1033 1034
			spin_unlock(&xprt_list_lock);
			goto found;
		}
1035
	}
1036
	spin_unlock(&xprt_list_lock);
1037
	printk(KERN_ERR "RPC: transport (%d) not supported\n", args->ident);
1038 1039 1040 1041
	return ERR_PTR(-EIO);

found:
	xprt = t->setup(args);
1042
	if (IS_ERR(xprt)) {
1043
		dprintk("RPC:       xprt_create_transport: failed, %ld\n",
1044 1045
				-PTR_ERR(xprt));
		return xprt;
1046 1047
	}

1048
	kref_init(&xprt->kref);
1049 1050 1051 1052 1053
	spin_lock_init(&xprt->transport_lock);
	spin_lock_init(&xprt->reserve_lock);

	INIT_LIST_HEAD(&xprt->free);
	INIT_LIST_HEAD(&xprt->recv);
1054
	INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
1055 1056
	setup_timer(&xprt->timer, xprt_init_autodisconnect,
			(unsigned long)xprt);
1057 1058
	xprt->last_used = jiffies;
	xprt->cwnd = RPC_INITCWND;
1059
	xprt->bind_index = 0;
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072

	rpc_init_wait_queue(&xprt->binding, "xprt_binding");
	rpc_init_wait_queue(&xprt->pending, "xprt_pending");
	rpc_init_wait_queue(&xprt->sending, "xprt_sending");
	rpc_init_wait_queue(&xprt->resend, "xprt_resend");
	rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");

	/* initialize free list */
	for (req = &xprt->slot[xprt->max_reqs-1]; req >= &xprt->slot[0]; req--)
		list_add(&req->rq_list, &xprt->free);

	xprt_init_xid(xprt);

1073
	dprintk("RPC:       created transport %p with %u slots\n", xprt,
1074 1075 1076 1077 1078
			xprt->max_reqs);

	return xprt;
}

1079 1080
/**
 * xprt_destroy - destroy an RPC transport, killing off all requests.
1081
 * @kref: kref for the transport to destroy
1082
 *
L
Linus Torvalds 已提交
1083
 */
1084
static void xprt_destroy(struct kref *kref)
L
Linus Torvalds 已提交
1085
{
1086 1087
	struct rpc_xprt *xprt = container_of(kref, struct rpc_xprt, kref);

1088
	dprintk("RPC:       destroying transport %p\n", xprt);
1089 1090
	xprt->shutdown = 1;
	del_timer_sync(&xprt->timer);
1091

1092 1093 1094 1095 1096
	rpc_destroy_wait_queue(&xprt->binding);
	rpc_destroy_wait_queue(&xprt->pending);
	rpc_destroy_wait_queue(&xprt->sending);
	rpc_destroy_wait_queue(&xprt->resend);
	rpc_destroy_wait_queue(&xprt->backlog);
1097 1098 1099
	/*
	 * Tear down transport state and free the rpc_xprt
	 */
1100
	xprt->ops->destroy(xprt);
1101
}
L
Linus Torvalds 已提交
1102

1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
/**
 * xprt_put - release a reference to an RPC transport.
 * @xprt: pointer to the transport
 *
 */
void xprt_put(struct rpc_xprt *xprt)
{
	kref_put(&xprt->kref, xprt_destroy);
}

/**
 * xprt_get - return a reference to an RPC transport.
 * @xprt: pointer to the transport
 *
 */
struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
{
	kref_get(&xprt->kref);
	return xprt;
L
Linus Torvalds 已提交
1122
}