clnt.c 55.2 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
 *  linux/net/sunrpc/clnt.c
L
Linus Torvalds 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 *  This file contains the high-level RPC interface.
 *  It is modeled as a finite state machine to support both synchronous
 *  and asynchronous requests.
 *
 *  -	RPC header generation and argument serialization.
 *  -	Credential refresh.
 *  -	TCP connect handling.
 *  -	Retry of operation when it is suspected the operation failed because
 *	of uid squashing on the server, or when the credentials were stale
 *	and need to be refreshed, or when a packet was damaged in transit.
 *	This may be have to be moved to the VFS layer.
 *
 *  Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
 *  Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
 */


#include <linux/module.h>
#include <linux/types.h>
23
#include <linux/kallsyms.h>
L
Linus Torvalds 已提交
24
#include <linux/mm.h>
25 26
#include <linux/namei.h>
#include <linux/mount.h>
L
Linus Torvalds 已提交
27 28
#include <linux/slab.h>
#include <linux/utsname.h>
29
#include <linux/workqueue.h>
30
#include <linux/in.h>
31
#include <linux/in6.h>
32
#include <linux/un.h>
33
#include <linux/rcupdate.h>
L
Linus Torvalds 已提交
34 35

#include <linux/sunrpc/clnt.h>
36
#include <linux/sunrpc/addr.h>
L
Linus Torvalds 已提交
37
#include <linux/sunrpc/rpc_pipe_fs.h>
38
#include <linux/sunrpc/metrics.h>
39
#include <linux/sunrpc/bc_xprt.h>
40
#include <trace/events/sunrpc.h>
L
Linus Torvalds 已提交
41

42
#include "sunrpc.h"
43
#include "netns.h"
L
Linus Torvalds 已提交
44 45 46 47 48

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

49 50
#define dprint_status(t)					\
	dprintk("RPC: %5u %s (status %d)\n", t->tk_pid,		\
51
			__func__, t->tk_status)
52

53 54 55 56
/*
 * All RPC clients are linked into this list
 */

L
Linus Torvalds 已提交
57 58 59 60 61 62 63 64 65
static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);


static void	call_start(struct rpc_task *task);
static void	call_reserve(struct rpc_task *task);
static void	call_reserveresult(struct rpc_task *task);
static void	call_allocate(struct rpc_task *task);
static void	call_decode(struct rpc_task *task);
static void	call_bind(struct rpc_task *task);
66
static void	call_bind_status(struct rpc_task *task);
L
Linus Torvalds 已提交
67
static void	call_transmit(struct rpc_task *task);
68
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
69
static void	call_bc_transmit(struct rpc_task *task);
70
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
L
Linus Torvalds 已提交
71
static void	call_status(struct rpc_task *task);
72
static void	call_transmit_status(struct rpc_task *task);
L
Linus Torvalds 已提交
73 74 75 76 77 78
static void	call_refresh(struct rpc_task *task);
static void	call_refreshresult(struct rpc_task *task);
static void	call_timeout(struct rpc_task *task);
static void	call_connect(struct rpc_task *task);
static void	call_connect_status(struct rpc_task *task);

79 80
static __be32	*rpc_encode_header(struct rpc_task *task);
static __be32	*rpc_verify_header(struct rpc_task *task);
81
static int	rpc_ping(struct rpc_clnt *clnt);
T
Trond Myklebust 已提交
82

83 84
static void rpc_register_client(struct rpc_clnt *clnt)
{
85 86
	struct net *net = rpc_net_ns(clnt);
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
87 88 89 90

	spin_lock(&sn->rpc_client_lock);
	list_add(&clnt->cl_clients, &sn->all_clients);
	spin_unlock(&sn->rpc_client_lock);
91 92 93 94
}

static void rpc_unregister_client(struct rpc_clnt *clnt)
{
95 96
	struct net *net = rpc_net_ns(clnt);
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
97 98

	spin_lock(&sn->rpc_client_lock);
99
	list_del(&clnt->cl_clients);
100
	spin_unlock(&sn->rpc_client_lock);
101
}
L
Linus Torvalds 已提交
102

103 104
static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
{
105
	rpc_remove_client_dir(clnt);
106 107 108 109
}

static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
{
110
	struct net *net = rpc_net_ns(clnt);
111 112
	struct super_block *pipefs_sb;

113
	pipefs_sb = rpc_get_sb_net(net);
114 115
	if (pipefs_sb) {
		__rpc_clnt_remove_pipedir(clnt);
116
		rpc_put_sb_net(net);
117 118 119 120
	}
}

static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
121
				    struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
122
{
123
	static uint32_t clntid;
124
	const char *dir_name = clnt->cl_program->pipe_dir_name;
125
	char name[15];
126
	struct dentry *dir, *dentry;
L
Linus Torvalds 已提交
127

128
	dir = rpc_d_lookup_sb(sb, dir_name);
129 130
	if (dir == NULL) {
		pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
131
		return dir;
132
	}
133
	for (;;) {
134
		snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
135
		name[sizeof(name) - 1] = '\0';
136
		dentry = rpc_create_client_dir(dir, name, clnt);
137
		if (!IS_ERR(dentry))
138
			break;
139 140 141 142 143 144
		if (dentry == ERR_PTR(-EEXIST))
			continue;
		printk(KERN_INFO "RPC: Couldn't create pipefs entry"
				" %s/%s, error %ld\n",
				dir_name, name, PTR_ERR(dentry));
		break;
L
Linus Torvalds 已提交
145
	}
146 147 148 149 150
	dput(dir);
	return dentry;
}

static int
151
rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
152
{
153
	struct dentry *dentry;
154

155 156 157 158 159
	if (clnt->cl_program->pipe_dir_name != NULL) {
		dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
		if (IS_ERR(dentry))
			return PTR_ERR(dentry);
	}
160
	return 0;
L
Linus Torvalds 已提交
161 162
}

163
static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
164
{
165
	if (clnt->cl_program->pipe_dir_name == NULL)
166
		return 1;
167

168 169 170 171 172 173 174 175 176 177 178 179
	switch (event) {
	case RPC_PIPEFS_MOUNT:
		if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
			return 1;
		if (atomic_read(&clnt->cl_count) == 0)
			return 1;
		break;
	case RPC_PIPEFS_UMOUNT:
		if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
			return 1;
		break;
	}
180 181 182 183 184
	return 0;
}

static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
				   struct super_block *sb)
185 186 187 188 189 190
{
	struct dentry *dentry;
	int err = 0;

	switch (event) {
	case RPC_PIPEFS_MOUNT:
191
		dentry = rpc_setup_pipedir_sb(sb, clnt);
192 193
		if (!dentry)
			return -ENOENT;
194 195 196 197 198 199 200 201 202 203 204 205 206
		if (IS_ERR(dentry))
			return PTR_ERR(dentry);
		break;
	case RPC_PIPEFS_UMOUNT:
		__rpc_clnt_remove_pipedir(clnt);
		break;
	default:
		printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
		return -ENOTSUPP;
	}
	return err;
}

207 208 209 210 211 212 213 214 215 216 217 218 219 220
static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
				struct super_block *sb)
{
	int error = 0;

	for (;; clnt = clnt->cl_parent) {
		if (!rpc_clnt_skip_event(clnt, event))
			error = __rpc_clnt_handle_event(clnt, event, sb);
		if (error || clnt == clnt->cl_parent)
			break;
	}
	return error;
}

221 222 223 224 225 226 227
static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
{
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
	struct rpc_clnt *clnt;

	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
228
		if (rpc_clnt_skip_event(clnt, event))
229 230 231 232 233 234 235 236
			continue;
		spin_unlock(&sn->rpc_client_lock);
		return clnt;
	}
	spin_unlock(&sn->rpc_client_lock);
	return NULL;
}

237 238 239 240 241 242 243
static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
			    void *ptr)
{
	struct super_block *sb = ptr;
	struct rpc_clnt *clnt;
	int error = 0;

244
	while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
245 246 247 248 249 250 251 252 253
		error = __rpc_pipefs_event(clnt, event, sb);
		if (error)
			break;
	}
	return error;
}

static struct notifier_block rpc_clients_block = {
	.notifier_call	= rpc_pipefs_event,
254
	.priority	= SUNRPC_PIPEFS_RPC_PRIO,
255 256 257 258 259 260 261 262 263 264 265 266
};

int rpc_clients_notifier_register(void)
{
	return rpc_pipefs_notifier_register(&rpc_clients_block);
}

void rpc_clients_notifier_unregister(void)
{
	return rpc_pipefs_notifier_unregister(&rpc_clients_block);
}

267 268 269 270 271 272 273 274
static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
{
	clnt->cl_nodelen = strlen(nodename);
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
	memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
}

275 276 277
static int rpc_client_register(struct rpc_clnt *clnt,
			       rpc_authflavor_t pseudoflavor,
			       const char *client_name)
278
{
279
	struct rpc_auth_create_args auth_args = {
280 281
		.pseudoflavor = pseudoflavor,
		.target_name = client_name,
282
	};
283 284 285
	struct rpc_auth *auth;
	struct net *net = rpc_net_ns(clnt);
	struct super_block *pipefs_sb;
286
	int err;
287 288 289

	pipefs_sb = rpc_get_sb_net(net);
	if (pipefs_sb) {
290
		err = rpc_setup_pipedir(pipefs_sb, clnt);
291 292 293 294
		if (err)
			goto out;
	}

295 296 297 298
	rpc_register_client(clnt);
	if (pipefs_sb)
		rpc_put_sb_net(net);

299
	auth = rpcauth_create(&auth_args, clnt);
300 301
	if (IS_ERR(auth)) {
		dprintk("RPC:       Couldn't create auth handle (flavor %u)\n",
302
				pseudoflavor);
303 304 305
		err = PTR_ERR(auth);
		goto err_auth;
	}
306 307 308
	return 0;
err_auth:
	pipefs_sb = rpc_get_sb_net(net);
309
	rpc_unregister_client(clnt);
310
	__rpc_clnt_remove_pipedir(clnt);
311 312 313 314 315 316
out:
	if (pipefs_sb)
		rpc_put_sb_net(net);
	return err;
}

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
static DEFINE_IDA(rpc_clids);

static int rpc_alloc_clid(struct rpc_clnt *clnt)
{
	int clid;

	clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
	if (clid < 0)
		return clid;
	clnt->cl_clid = clid;
	return 0;
}

static void rpc_free_clid(struct rpc_clnt *clnt)
{
	ida_simple_remove(&rpc_clids, clnt->cl_clid);
}

335 336 337
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
		struct rpc_xprt *xprt,
		struct rpc_clnt *parent)
L
Linus Torvalds 已提交
338
{
339 340
	const struct rpc_program *program = args->program;
	const struct rpc_version *version;
L
Linus Torvalds 已提交
341 342
	struct rpc_clnt		*clnt = NULL;
	int err;
343 344

	/* sanity check the name before trying to print it */
345
	dprintk("RPC:       creating %s client for %s (xprt %p)\n",
346
			program->name, args->servername, xprt);
L
Linus Torvalds 已提交
347

348 349 350
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
351

352
	err = -EINVAL;
353 354 355 356
	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
357 358 359
		goto out_err;

	err = -ENOMEM;
360
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
361 362
	if (!clnt)
		goto out_err;
363
	clnt->cl_parent = parent ? : clnt;
L
Linus Torvalds 已提交
364

365 366 367
	err = rpc_alloc_clid(clnt);
	if (err)
		goto out_no_clid;
L
Linus Torvalds 已提交
368

369
	rcu_assign_pointer(clnt->cl_xprt, xprt);
L
Linus Torvalds 已提交
370 371
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
372
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
373 374
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
375
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
376
	rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
377 378 379
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
380
	clnt->cl_program  = program;
381
	INIT_LIST_HEAD(&clnt->cl_tasks);
382
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
383

384
	if (!xprt_bound(xprt))
L
Linus Torvalds 已提交
385 386
		clnt->cl_autobind = 1;

387 388 389 390 391 392 393
	clnt->cl_timeout = xprt->timeout;
	if (args->timeout != NULL) {
		memcpy(&clnt->cl_timeout_default, args->timeout,
				sizeof(clnt->cl_timeout_default));
		clnt->cl_timeout = &clnt->cl_timeout_default;
	}

L
Linus Torvalds 已提交
394
	clnt->cl_rtt = &clnt->cl_rtt_default;
395
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
L
Linus Torvalds 已提交
396

397
	atomic_set(&clnt->cl_count, 1);
398

L
Linus Torvalds 已提交
399
	/* save the nodename */
400
	rpc_clnt_set_nodename(clnt, utsname()->nodename);
401

402
	err = rpc_client_register(clnt, args->authflavor, args->client_name);
403 404
	if (err)
		goto out_no_path;
405 406
	if (parent)
		atomic_inc(&parent->cl_count);
L
Linus Torvalds 已提交
407 408 409
	return clnt;

out_no_path:
410 411
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
412 413
	rpc_free_clid(clnt);
out_no_clid:
L
Linus Torvalds 已提交
414 415
	kfree(clnt);
out_err:
416 417
	rpciod_down();
out_no_rpciod:
418
	xprt_put(xprt);
L
Linus Torvalds 已提交
419 420 421
	return ERR_PTR(err);
}

422
/**
423 424 425 426 427 428 429 430 431 432 433 434 435
 * rpc_create - create an RPC client and transport with one call
 * @args: rpc_clnt create argument structure
 *
 * Creates and initializes an RPC transport and an RPC client.
 *
 * It can ping the server in order to determine if it is up, and to see if
 * it supports this program and version.  RPC_CLNT_CREATE_NOPING disables
 * this behavior so asynchronous tasks can also use rpc_create.
 */
struct rpc_clnt *rpc_create(struct rpc_create_args *args)
{
	struct rpc_xprt *xprt;
	struct rpc_clnt *clnt;
436
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
437
		.net = args->net,
438
		.ident = args->protocol,
439
		.srcaddr = args->saddress,
440 441
		.dstaddr = args->address,
		.addrlen = args->addrsize,
442
		.servername = args->servername,
443
		.bc_xprt = args->bc_xprt,
444
	};
445
	char servername[48];
446

447 448
	if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
		xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
449 450
	if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
		xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
451 452 453 454
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
455
	if (xprtargs.servername == NULL) {
456 457
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
458 459 460 461 462
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

463 464
		servername[0] = '\0';
		switch (args->address->sa_family) {
465 466 467 468
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
469
		case AF_INET:
H
Harvey Harrison 已提交
470 471
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
472
			break;
473
		case AF_INET6:
H
Harvey Harrison 已提交
474
			snprintf(servername, sizeof(servername), "%pI6",
475
				 &sin6->sin6_addr);
476 477 478 479 480 481
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
482
		xprtargs.servername = servername;
483 484
	}

485 486 487 488
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

489 490 491 492 493 494 495 496 497 498
	/*
	 * By default, kernel RPC client connects from a reserved port.
	 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
	 * but it is always enabled for rpciod, which handles the connect
	 * operation.
	 */
	xprt->resvport = 1;
	if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
		xprt->resvport = 0;

499
	clnt = rpc_new_client(args, xprt, NULL);
500 501 502 503
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
504
		int err = rpc_ping(clnt);
505 506 507 508 509 510 511 512 513 514 515 516
		if (err != 0) {
			rpc_shutdown_client(clnt);
			return ERR_PTR(err);
		}
	}

	clnt->cl_softrtry = 1;
	if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
		clnt->cl_softrtry = 0;

	if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
		clnt->cl_autobind = 1;
517 518
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
519 520
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
521 522 523

	return clnt;
}
524
EXPORT_SYMBOL_GPL(rpc_create);
525

L
Linus Torvalds 已提交
526 527 528 529 530
/*
 * This function clones the RPC client structure. It allows us to share the
 * same transport while varying parameters such as the authentication
 * flavour.
 */
C
Chuck Lever 已提交
531 532
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
533
{
534
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
535 536
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
537

C
Chuck Lever 已提交
538
	err = -ENOMEM;
539 540 541 542
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
	rcu_read_unlock();
	if (xprt == NULL)
C
Chuck Lever 已提交
543 544 545
		goto out_err;
	args->servername = xprt->servername;

546
	new = rpc_new_client(args, xprt, clnt);
C
Chuck Lever 已提交
547 548
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
549
		goto out_err;
C
Chuck Lever 已提交
550 551 552 553 554 555 556
	}

	/* Turn off autobind on clones */
	new->cl_autobind = 0;
	new->cl_softrtry = clnt->cl_softrtry;
	new->cl_discrtry = clnt->cl_discrtry;
	new->cl_chatty = clnt->cl_chatty;
L
Linus Torvalds 已提交
557
	return new;
C
Chuck Lever 已提交
558 559

out_err:
560
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
561
	return ERR_PTR(err);
L
Linus Torvalds 已提交
562
}
C
Chuck Lever 已提交
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580

/**
 * rpc_clone_client - Clone an RPC client structure
 *
 * @clnt: RPC client whose parameters are copied
 *
 * Returns a fresh RPC client or an ERR_PTR.
 */
struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
{
	struct rpc_create_args args = {
		.program	= clnt->cl_program,
		.prognumber	= clnt->cl_prog,
		.version	= clnt->cl_vers,
		.authflavor	= clnt->cl_auth->au_flavor,
	};
	return __rpc_clone_client(&args, clnt);
}
581
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
582

583 584 585 586
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
587
 * @flavor: security flavor for new client
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
 *
 * Returns a fresh RPC client or an ERR_PTR.
 */
struct rpc_clnt *
rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
{
	struct rpc_create_args args = {
		.program	= clnt->cl_program,
		.prognumber	= clnt->cl_prog,
		.version	= clnt->cl_vers,
		.authflavor	= flavor,
	};
	return __rpc_clone_client(&args, clnt);
}
EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
/*
 * Kill all tasks for the given client.
 * XXX: kill their descendants as well?
 */
void rpc_killall_tasks(struct rpc_clnt *clnt)
{
	struct rpc_task	*rovr;


	if (list_empty(&clnt->cl_tasks))
		return;
	dprintk("RPC:       killing all tasks for client %p\n", clnt);
	/*
	 * Spin lock all_tasks to prevent changes...
	 */
	spin_lock(&clnt->cl_lock);
	list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
		if (!RPC_IS_ACTIVATED(rovr))
			continue;
		if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
			rovr->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(rovr, -EIO);
626 627 628
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
629 630 631 632 633 634
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
635 636
/*
 * Properly shut down an RPC client, terminating all outstanding
637
 * requests.
L
Linus Torvalds 已提交
638
 */
639
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
640
{
641 642
	might_sleep();

643
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
644
			clnt->cl_program->name,
645
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
646

647
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
648
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
649
		wait_event_timeout(destroy_wait,
650
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
651 652
	}

653
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
654
}
655
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
656 657

/*
658
 * Free an RPC client
L
Linus Torvalds 已提交
659
 */
660
static void
661
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
662
{
663
	dprintk_rcu("RPC:       destroying %s client for %s\n",
664
			clnt->cl_program->name,
665
			rcu_dereference(clnt->cl_xprt)->servername);
666
	if (clnt->cl_parent != clnt)
667
		rpc_release_client(clnt->cl_parent);
668
	rpc_clnt_remove_pipedir(clnt);
669
	rpc_unregister_client(clnt);
670 671
	rpc_free_iostats(clnt->cl_metrics);
	clnt->cl_metrics = NULL;
672
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
673
	rpciod_down();
674
	rpc_free_clid(clnt);
L
Linus Torvalds 已提交
675 676 677
	kfree(clnt);
}

678 679 680 681
/*
 * Free an RPC client
 */
static void
682
rpc_free_auth(struct rpc_clnt *clnt)
683 684
{
	if (clnt->cl_auth == NULL) {
685
		rpc_free_client(clnt);
686 687 688 689 690 691 692 693
		return;
	}

	/*
	 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
	 *       release remaining GSS contexts. This mechanism ensures
	 *       that it can do so safely.
	 */
694
	atomic_inc(&clnt->cl_count);
695 696
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
697 698
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
699 700
}

L
Linus Torvalds 已提交
701
/*
702
 * Release reference to the RPC client
L
Linus Torvalds 已提交
703 704 705 706
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
707
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
708

709 710
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
711 712
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_auth(clnt);
713
}
714
EXPORT_SYMBOL_GPL(rpc_release_client);
715

716 717
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
718 719 720
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
721 722 723 724 725 726
 *
 * Clones the rpc client and sets up a new RPC program. This is mainly
 * of use for enabling different RPC programs to share the same transport.
 * The Sun NFSv2/v3 ACL protocol can do this.
 */
struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
727
				      const struct rpc_program *program,
728
				      u32 vers)
729
{
730 731 732 733 734 735
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
	};
736 737 738
	struct rpc_clnt *clnt;
	int err;

739
	clnt = __rpc_clone_client(&args, old);
740 741
	if (IS_ERR(clnt))
		goto out;
742
	err = rpc_ping(clnt);
743 744 745 746
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
747
out:
748 749
	return clnt;
}
750
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
751

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
void rpc_task_release_client(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;

	if (clnt != NULL) {
		/* Remove from client task list */
		spin_lock(&clnt->cl_lock);
		list_del(&task->tk_task);
		spin_unlock(&clnt->cl_lock);
		task->tk_client = NULL;

		rpc_release_client(clnt);
	}
}

static
void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
{
	if (clnt != NULL) {
		rpc_task_release_client(task);
		task->tk_client = clnt;
773
		atomic_inc(&clnt->cl_count);
774 775
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
776 777
		if (clnt->cl_noretranstimeo)
			task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
M
Mel Gorman 已提交
778 779 780 781 782 783 784 785 786
		if (sk_memalloc_socks()) {
			struct rpc_xprt *xprt;

			rcu_read_lock();
			xprt = rcu_dereference(clnt->cl_xprt);
			if (xprt->swapper)
				task->tk_flags |= RPC_TASK_SWAPPER;
			rcu_read_unlock();
		}
787 788 789 790 791 792 793
		/* Add to the client's list of all tasks */
		spin_lock(&clnt->cl_lock);
		list_add_tail(&task->tk_task, &clnt->cl_tasks);
		spin_unlock(&clnt->cl_lock);
	}
}

794 795 796 797 798 799 800 801
void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
{
	rpc_task_release_client(task);
	rpc_task_set_client(task, clnt);
}
EXPORT_SYMBOL_GPL(rpc_task_reset_client);


802 803 804 805 806 807 808
static void
rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
{
	if (msg != NULL) {
		task->tk_msg.rpc_proc = msg->rpc_proc;
		task->tk_msg.rpc_argp = msg->rpc_argp;
		task->tk_msg.rpc_resp = msg->rpc_resp;
809 810
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
811 812 813
	}
}

L
Linus Torvalds 已提交
814 815 816 817
/*
 * Default callback for async RPC calls
 */
static void
818
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
819 820 821
{
}

822 823 824 825
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
826 827 828 829 830
/**
 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
 * @task_setup_data: pointer to task initialisation data
 */
struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
831
{
832
	struct rpc_task *task;
833

834
	task = rpc_new_task(task_setup_data);
835
	if (IS_ERR(task))
836
		goto out;
837

838 839 840 841 842 843
	rpc_task_set_client(task, task_setup_data->rpc_client);
	rpc_task_set_rpc_message(task, task_setup_data->rpc_message);

	if (task->tk_action == NULL)
		rpc_call_start(task);

844 845 846
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
847
	return task;
848
}
T
Trond Myklebust 已提交
849
EXPORT_SYMBOL_GPL(rpc_run_task);
850 851 852 853 854 855

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
856
 */
857
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
858 859
{
	struct rpc_task	*task;
860 861 862 863 864 865
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
866
	int status;
L
Linus Torvalds 已提交
867

868 869 870 871 872 873
	WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
	if (flags & RPC_TASK_ASYNC) {
		rpc_release_calldata(task_setup_data.callback_ops,
			task_setup_data.callback_data);
		return -EINVAL;
	}
L
Linus Torvalds 已提交
874

T
Trond Myklebust 已提交
875
	task = rpc_run_task(&task_setup_data);
876 877
	if (IS_ERR(task))
		return PTR_ERR(task);
878
	status = task->tk_status;
879
	rpc_put_task(task);
L
Linus Torvalds 已提交
880 881
	return status;
}
882
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
883

884 885 886 887 888
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
889
 * @tk_ops: RPC call ops
890
 * @data: user call data
L
Linus Torvalds 已提交
891 892
 */
int
893
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
894
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
895 896
{
	struct rpc_task	*task;
897 898 899 900 901 902 903
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = tk_ops,
		.callback_data = data,
		.flags = flags|RPC_TASK_ASYNC,
	};
L
Linus Torvalds 已提交
904

T
Trond Myklebust 已提交
905
	task = rpc_run_task(&task_setup_data);
906 907 908 909
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
910
}
911
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
912

913
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
914 915 916
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
917 918
 * @req: RPC request
 * @tk_ops: RPC call ops
919 920
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
921
				const struct rpc_call_ops *tk_ops)
922 923 924 925 926 927 928 929 930 931 932 933
{
	struct rpc_task *task;
	struct xdr_buf *xbufp = &req->rq_snd_buf;
	struct rpc_task_setup task_setup_data = {
		.callback_ops = tk_ops,
	};

	dprintk("RPC: rpc_run_bc_task req= %p\n", req);
	/*
	 * Create an rpc_task to send the data
	 */
	task = rpc_new_task(&task_setup_data);
934
	if (IS_ERR(task)) {
935 936 937 938 939 940 941 942 943 944 945 946 947 948
		xprt_free_bc_request(req);
		goto out;
	}
	task->tk_rqstp = req;

	/*
	 * Set up the xdr_buf length.
	 * This also indicates that the buffer is XDR encoded already.
	 */
	xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
			xbufp->tail[0].iov_len;

	task->tk_action = call_bc_transmit;
	atomic_inc(&task->tk_count);
949
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
950 951 952 953 954 955
	rpc_execute(task);

out:
	dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
	return task;
}
956
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
957

958 959 960 961 962 963 964
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

965 966 967 968
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
969
 * @bufsize: length of target buffer
970 971 972 973 974 975
 *
 * Returns the number of bytes that are actually in the stored address.
 */
size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
{
	size_t bytes;
976 977 978 979
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
980

981
	bytes = xprt->addrlen;
982 983
	if (bytes > bufsize)
		bytes = bufsize;
984 985 986 987
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
988
}
989
EXPORT_SYMBOL_GPL(rpc_peeraddr);
990

991 992 993 994 995
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
996 997 998
 * NB: the lifetime of the memory referenced by the returned pointer is
 * the same as the rpc_xprt itself.  As long as the caller uses this
 * pointer, it must hold the RCU read lock.
999
 */
1000 1001
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
1002
{
1003 1004 1005
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
1006 1007 1008 1009 1010

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
1011
}
1012
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1013

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
static const struct sockaddr_in rpc_inaddr_loopback = {
	.sin_family		= AF_INET,
	.sin_addr.s_addr	= htonl(INADDR_ANY),
};

static const struct sockaddr_in6 rpc_in6addr_loopback = {
	.sin6_family		= AF_INET6,
	.sin6_addr		= IN6ADDR_ANY_INIT,
};

/*
 * Try a getsockname() on a connected datagram socket.  Using a
 * connected datagram socket prevents leaving a socket in TIME_WAIT.
 * This conserves the ephemeral port number space.
 *
 * Returns zero and fills in "buf" if successful; otherwise, a
 * negative errno is returned.
 */
static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
			struct sockaddr *buf, int buflen)
{
	struct socket *sock;
	int err;

	err = __sock_create(net, sap->sa_family,
				SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
	if (err < 0) {
		dprintk("RPC:       can't create UDP socket (%d)\n", err);
		goto out;
	}

	switch (sap->sa_family) {
	case AF_INET:
		err = kernel_bind(sock,
				(struct sockaddr *)&rpc_inaddr_loopback,
				sizeof(rpc_inaddr_loopback));
		break;
	case AF_INET6:
		err = kernel_bind(sock,
				(struct sockaddr *)&rpc_in6addr_loopback,
				sizeof(rpc_in6addr_loopback));
		break;
	default:
		err = -EAFNOSUPPORT;
		goto out;
	}
	if (err < 0) {
		dprintk("RPC:       can't bind UDP socket (%d)\n", err);
		goto out_release;
	}

	err = kernel_connect(sock, sap, salen, 0);
	if (err < 0) {
		dprintk("RPC:       can't connect UDP socket (%d)\n", err);
		goto out_release;
	}

	err = kernel_getsockname(sock, buf, &buflen);
	if (err < 0) {
		dprintk("RPC:       getsockname failed (%d)\n", err);
		goto out_release;
	}

	err = 0;
	if (buf->sa_family == AF_INET6) {
		struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
		sin6->sin6_scope_id = 0;
	}
	dprintk("RPC:       %s succeeded\n", __func__);

out_release:
	sock_release(sock);
out:
	return err;
}

/*
 * Scraping a connected socket failed, so we don't have a useable
 * local address.  Fallback: generate an address that will prevent
 * the server from calling us back.
 *
 * Returns zero and fills in "buf" if successful; otherwise, a
 * negative errno is returned.
 */
static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
{
	switch (family) {
	case AF_INET:
		if (buflen < sizeof(rpc_inaddr_loopback))
			return -EINVAL;
		memcpy(buf, &rpc_inaddr_loopback,
				sizeof(rpc_inaddr_loopback));
		break;
	case AF_INET6:
		if (buflen < sizeof(rpc_in6addr_loopback))
			return -EINVAL;
		memcpy(buf, &rpc_in6addr_loopback,
				sizeof(rpc_in6addr_loopback));
	default:
		dprintk("RPC:       %s: address family not supported\n",
			__func__);
		return -EAFNOSUPPORT;
	}
	dprintk("RPC:       %s: succeeded\n", __func__);
	return 0;
}

/**
 * rpc_localaddr - discover local endpoint address for an RPC client
 * @clnt: RPC client structure
 * @buf: target buffer
 * @buflen: size of target buffer, in bytes
 *
 * Returns zero and fills in "buf" and "buflen" if successful;
 * otherwise, a negative errno is returned.
 *
 * This works even if the underlying transport is not currently connected,
 * or if the upper layer never previously provided a source address.
 *
 * The result of this function call is transient: multiple calls in
 * succession may give different results, depending on how local
 * networking configuration changes over time.
 */
int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
{
	struct sockaddr_storage address;
	struct sockaddr *sap = (struct sockaddr *)&address;
	struct rpc_xprt *xprt;
	struct net *net;
	size_t salen;
	int err;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
	salen = xprt->addrlen;
	memcpy(sap, &xprt->addr, salen);
	net = get_net(xprt->xprt_net);
	rcu_read_unlock();

	rpc_set_port(sap, 0);
	err = rpc_sockname(net, sap, salen, buf, buflen);
	put_net(net);
	if (err != 0)
		/* Couldn't discover local address, return ANYADDR */
		return rpc_anyaddr(sap->sa_family, buf, buflen);
	return 0;
}
EXPORT_SYMBOL_GPL(rpc_localaddr);

L
Linus Torvalds 已提交
1163 1164 1165
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1166 1167 1168 1169
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1170 1171
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1172
	rcu_read_unlock();
L
Linus Torvalds 已提交
1173
}
1174
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
1175

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
/**
 * rpc_protocol - Get transport protocol number for an RPC client
 * @clnt: RPC client to query
 *
 */
int rpc_protocol(struct rpc_clnt *clnt)
{
	int protocol;

	rcu_read_lock();
	protocol = rcu_dereference(clnt->cl_xprt)->prot;
	rcu_read_unlock();
	return protocol;
}
EXPORT_SYMBOL_GPL(rpc_protocol);

/**
 * rpc_net_ns - Get the network namespace for this RPC client
 * @clnt: RPC client to query
 *
 */
struct net *rpc_net_ns(struct rpc_clnt *clnt)
{
	struct net *ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
	rcu_read_unlock();
	return ret;
}
EXPORT_SYMBOL_GPL(rpc_net_ns);

/**
 * rpc_max_payload - Get maximum payload size for a transport, in bytes
 * @clnt: RPC client to query
L
Linus Torvalds 已提交
1211 1212 1213 1214 1215 1216 1217 1218
 *
 * For stream transports, this is one RPC record fragment (see RFC
 * 1831), as we don't support multi-record requests yet.  For datagram
 * transports, this is the size of an IP packet minus the IP, UDP, and
 * RPC header sizes.
 */
size_t rpc_max_payload(struct rpc_clnt *clnt)
{
1219 1220 1221 1222 1223 1224
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1225
}
1226
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1227

1228
/**
T
Trond Myklebust 已提交
1229
 * rpc_get_timeout - Get timeout for transport in units of HZ
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
 * @clnt: RPC client to query
 */
unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
{
	unsigned long ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
	rcu_read_unlock();
	return ret;
}
EXPORT_SYMBOL_GPL(rpc_get_timeout);

1243 1244 1245 1246 1247 1248 1249
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1250 1251 1252 1253 1254
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1255
}
1256
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1257

1258 1259 1260 1261
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1262
int
1263 1264 1265
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1266
		return 0;
1267 1268 1269
	task->tk_action = call_start;
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1270
	return 1;
1271 1272 1273
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1274 1275 1276 1277
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1278
int
L
Linus Torvalds 已提交
1279 1280 1281
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1282
		return 0;
L
Linus Torvalds 已提交
1283
	task->tk_action = call_start;
1284
	return 1;
L
Linus Torvalds 已提交
1285
}
1286
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1287

1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
#ifdef RPC_DEBUG
static const char *rpc_proc_name(const struct rpc_task *task)
{
	const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;

	if (proc) {
		if (proc->p_name)
			return proc->p_name;
		else
			return "NULL";
	} else
		return "no proc";
}
#endif

L
Linus Torvalds 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
/*
 * 0.  Initial state
 *
 *     Other FSM states can be visited zero or more times, but
 *     this state is visited exactly once for each RPC.
 */
static void
call_start(struct rpc_task *task)
{
	struct rpc_clnt	*clnt = task->tk_client;

1314
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1315
			clnt->cl_program->name, clnt->cl_vers,
1316
			rpc_proc_name(task),
1317
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330

	/* Increment call count */
	task->tk_msg.rpc_proc->p_count++;
	clnt->cl_stats->rpccnt++;
	task->tk_action = call_reserve;
}

/*
 * 1.	Reserve an RPC call slot
 */
static void
call_reserve(struct rpc_task *task)
{
1331
	dprint_status(task);
L
Linus Torvalds 已提交
1332 1333 1334 1335 1336 1337

	task->tk_status  = 0;
	task->tk_action  = call_reserveresult;
	xprt_reserve(task);
}

1338 1339
static void call_retry_reserve(struct rpc_task *task);

L
Linus Torvalds 已提交
1340 1341 1342 1343 1344 1345 1346 1347
/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1348
	dprint_status(task);
L
Linus Torvalds 已提交
1349 1350 1351 1352 1353 1354 1355 1356

	/*
	 * After a call to xprt_reserve(), we must have either
	 * a request slot or else an error status.
	 */
	task->tk_status = 0;
	if (status >= 0) {
		if (task->tk_rqstp) {
1357
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1358 1359 1360 1361
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1362
				__func__, status);
L
Linus Torvalds 已提交
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
		rpc_exit(task, -EIO);
		return;
	}

	/*
	 * Even though there was an error, we may have acquired
	 * a request slot somehow.  Make sure not to leak it.
	 */
	if (task->tk_rqstp) {
		printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1373
				__func__, status);
L
Linus Torvalds 已提交
1374 1375 1376 1377
		xprt_release(task);
	}

	switch (status) {
1378 1379
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1380
	case -EAGAIN:	/* woken up; retry */
1381
		task->tk_action = call_retry_reserve;
L
Linus Torvalds 已提交
1382 1383 1384 1385 1386
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1387
				__func__, status);
L
Linus Torvalds 已提交
1388 1389 1390 1391 1392
		break;
	}
	rpc_exit(task, status);
}

1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
/*
 * 1c.	Retry reserving an RPC call slot
 */
static void
call_retry_reserve(struct rpc_task *task)
{
	dprint_status(task);

	task->tk_status  = 0;
	task->tk_action  = call_reserveresult;
	xprt_retry_reserve(task);
}

L
Linus Torvalds 已提交
1406
/*
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
 * 2.	Bind and/or refresh the credentials
 */
static void
call_refresh(struct rpc_task *task)
{
	dprint_status(task);

	task->tk_action = call_refreshresult;
	task->tk_status = 0;
	task->tk_client->cl_stats->rpcauthrefresh++;
	rpcauth_refreshcred(task);
}

/*
 * 2a.	Process the results of a credential refresh
 */
static void
call_refreshresult(struct rpc_task *task)
{
	int status = task->tk_status;

	dprint_status(task);

	task->tk_status = 0;
1431
	task->tk_action = call_refresh;
1432
	switch (status) {
1433 1434 1435
	case 0:
		if (rpcauth_uptodatecred(task))
			task->tk_action = call_allocate;
1436 1437 1438
		return;
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1439 1440
	case -EAGAIN:
		status = -EACCES;
1441
	case -EKEYEXPIRED:
1442 1443 1444 1445 1446 1447
		if (!task->tk_cred_retry)
			break;
		task->tk_cred_retry--;
		dprintk("RPC: %5u %s: retry refresh creds\n",
				task->tk_pid, __func__);
		return;
1448
	}
1449 1450 1451
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1452 1453 1454 1455
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1456
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1457 1458 1459 1460
 */
static void
call_allocate(struct rpc_task *task)
{
1461
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1462
	struct rpc_rqst *req = task->tk_rqstp;
1463
	struct rpc_xprt *xprt = req->rq_xprt;
1464
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1465

1466 1467
	dprint_status(task);

1468
	task->tk_status = 0;
1469
	task->tk_action = call_bind;
1470

1471
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1472 1473
		return;

1474 1475 1476 1477 1478
	if (proc->p_proc != 0) {
		BUG_ON(proc->p_arglen == 0);
		if (proc->p_decode != NULL)
			BUG_ON(proc->p_replen == 0);
	}
L
Linus Torvalds 已提交
1479

1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
	/*
	 * Calculate the size (in quads) of the RPC call
	 * and reply headers, and convert both values
	 * to byte sizes.
	 */
	req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
	req->rq_callsize <<= 2;
	req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
	req->rq_rcvsize <<= 2;

1490 1491
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1492
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1493
		return;
1494 1495

	dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
L
Linus Torvalds 已提交
1496

1497
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1498
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1499 1500 1501 1502 1503 1504 1505
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
static inline int
rpc_task_need_encode(struct rpc_task *task)
{
	return task->tk_rqstp->rq_snd_buf.len == 0;
}

static inline void
rpc_task_force_reencode(struct rpc_task *task)
{
	task->tk_rqstp->rq_snd_buf.len = 0;
1516
	task->tk_rqstp->rq_bytes_sent = 0;
1517 1518
}

1519 1520 1521 1522 1523 1524 1525
static inline void
rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
{
	buf->head[0].iov_base = start;
	buf->head[0].iov_len = len;
	buf->tail[0].iov_len = 0;
	buf->page_len = 0;
1526
	buf->flags = 0;
1527 1528 1529 1530
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1531 1532 1533 1534
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1535
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1536 1537
{
	struct rpc_rqst	*req = task->tk_rqstp;
1538
	kxdreproc_t	encode;
1539
	__be32		*p;
L
Linus Torvalds 已提交
1540

1541
	dprint_status(task);
L
Linus Torvalds 已提交
1542

1543 1544 1545 1546 1547 1548
	rpc_xdr_buf_init(&req->rq_snd_buf,
			 req->rq_buffer,
			 req->rq_callsize);
	rpc_xdr_buf_init(&req->rq_rcv_buf,
			 (char *)req->rq_buffer + req->rq_callsize,
			 req->rq_rcvsize);
L
Linus Torvalds 已提交
1549

1550 1551 1552
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1553 1554 1555
		rpc_exit(task, -EIO);
		return;
	}
1556 1557

	encode = task->tk_msg.rpc_proc->p_encode;
1558 1559 1560 1561 1562
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1563 1564 1565 1566 1567 1568 1569 1570
}

/*
 * 4.	Get the server port number if not yet set
 */
static void
call_bind(struct rpc_task *task)
{
1571
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1572

1573
	dprint_status(task);
L
Linus Torvalds 已提交
1574

1575
	task->tk_action = call_connect;
1576
	if (!xprt_bound(xprt)) {
1577
		task->tk_action = call_bind_status;
1578
		task->tk_timeout = xprt->bind_timeout;
1579
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1580 1581 1582 1583
	}
}

/*
1584 1585 1586 1587 1588
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1589
	int status = -EIO;
1590 1591

	if (task->tk_status >= 0) {
1592
		dprint_status(task);
1593 1594 1595 1596 1597
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1598
	trace_rpc_bind_status(task);
1599
	switch (task->tk_status) {
1600 1601 1602
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1603
		goto retry_timeout;
1604
	case -EACCES:
1605 1606
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1607 1608 1609 1610 1611
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1612 1613 1614
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1615
		rpc_delay(task, 3*HZ);
1616
		goto retry_timeout;
1617
	case -ETIMEDOUT:
1618
		dprintk("RPC: %5u rpcbind request timed out\n",
1619
				task->tk_pid);
1620
		goto retry_timeout;
1621
	case -EPFNOSUPPORT:
1622
		/* server doesn't support any rpcbind version we know of */
1623
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1624 1625 1626
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1627
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1628
				task->tk_pid);
1629 1630 1631
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
	case -ECONNREFUSED:		/* connection problems */
	case -ECONNRESET:
	case -ENOTCONN:
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
	case -EPIPE:
		dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
				task->tk_pid, task->tk_status);
		if (!RPC_IS_SOFTCONN(task)) {
			rpc_delay(task, 5*HZ);
			goto retry_timeout;
		}
		status = task->tk_status;
		break;
1647
	default:
1648
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1649 1650 1651 1652 1653 1654
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1655 1656
retry_timeout:
	task->tk_action = call_timeout;
1657 1658 1659 1660
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1661 1662 1663 1664
 */
static void
call_connect(struct rpc_task *task)
{
1665
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1666

1667
	dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1668 1669
			task->tk_pid, xprt,
			(xprt_connected(xprt) ? "is" : "is not"));
L
Linus Torvalds 已提交
1670

1671 1672 1673 1674 1675
	task->tk_action = call_transmit;
	if (!xprt_connected(xprt)) {
		task->tk_action = call_connect_status;
		if (task->tk_status < 0)
			return;
1676 1677 1678 1679
		if (task->tk_flags & RPC_TASK_NOCONNECT) {
			rpc_exit(task, -ENOTCONN);
			return;
		}
1680
		xprt_connect(task);
L
Linus Torvalds 已提交
1681 1682 1683 1684
	}
}

/*
1685
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1686 1687 1688 1689 1690 1691 1692
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1693
	dprint_status(task);
1694

1695
	trace_rpc_connect_status(task, status);
1696
	task->tk_status = 0;
L
Linus Torvalds 已提交
1697
	switch (status) {
1698 1699 1700
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1701 1702 1703 1704
		return;
	case -ECONNREFUSED:
	case -ECONNRESET:
	case -ENETUNREACH:
1705 1706
		/* retry with existing socket, after a delay */
		rpc_delay(task, 3*HZ);
1707 1708 1709
		if (RPC_IS_SOFTCONN(task))
			break;
	case -EAGAIN:
1710 1711 1712
		task->tk_action = call_bind;
		return;
	case 0:
1713 1714 1715
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
L
Linus Torvalds 已提交
1716
	}
1717
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1718 1719 1720 1721 1722 1723 1724 1725
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1726 1727
	int is_retrans = RPC_WAS_SENT(task);

1728
	dprint_status(task);
L
Linus Torvalds 已提交
1729 1730 1731 1732

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
1733
	if (!xprt_prepare_transmit(task))
L
Linus Torvalds 已提交
1734
		return;
1735
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1736
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1737
	if (rpc_task_need_encode(task)) {
1738
		rpc_xdr_encode(task);
1739
		/* Did the encode result in an error condition? */
1740 1741 1742 1743 1744 1745
		if (task->tk_status != 0) {
			/* Was the error nonfatal? */
			if (task->tk_status == -EAGAIN)
				rpc_delay(task, HZ >> 4);
			else
				rpc_exit(task, task->tk_status);
1746
			return;
1747
		}
1748
	}
L
Linus Torvalds 已提交
1749 1750 1751
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1752 1753
	if (is_retrans)
		task->tk_client->cl_stats->rpcretrans++;
1754 1755 1756 1757 1758
	/*
	 * On success, ensure that we call xprt_end_transmit() before sleeping
	 * in order to allow access to the socket to other RPC requests.
	 */
	call_transmit_status(task);
1759
	if (rpc_reply_expected(task))
1760 1761
		return;
	task->tk_action = rpc_exit_task;
1762
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1763 1764 1765 1766 1767 1768 1769 1770 1771
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782

	/*
	 * Common case: success.  Force the compiler to put this
	 * test first.
	 */
	if (task->tk_status == 0) {
		xprt_end_transmit(task);
		rpc_task_force_reencode(task);
		return;
	}

1783 1784 1785 1786
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1787
		dprint_status(task);
1788
		xprt_end_transmit(task);
1789 1790
		rpc_task_force_reencode(task);
		break;
1791 1792 1793 1794 1795 1796 1797 1798 1799 1800
		/*
		 * Special cases: if we've been waiting on the
		 * socket's write_space() callback, or if the
		 * socket just returned a connection error,
		 * then hold onto the transport lock.
		 */
	case -ECONNREFUSED:
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
1801 1802 1803 1804 1805 1806 1807
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1808
	case -EPIPE:
1809 1810
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1811 1812
}

1813
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1814 1815 1816 1817 1818 1819 1820 1821 1822
/*
 * 5b.	Send the backchannel RPC reply.  On error, drop the reply.  In
 * addition, disconnect on connectivity errors.
 */
static void
call_bc_transmit(struct rpc_task *task)
{
	struct rpc_rqst *req = task->tk_rqstp;

1823
	if (!xprt_prepare_transmit(task)) {
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
		/*
		 * Could not reserve the transport. Try again after the
		 * transport is released.
		 */
		task->tk_status = 0;
		task->tk_action = call_bc_transmit;
		return;
	}

	task->tk_action = rpc_exit_task;
	if (task->tk_status < 0) {
		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
			"error: %d\n", task->tk_status);
		return;
	}

	xprt_transmit(task);
	xprt_end_transmit(task);
	dprint_status(task);
	switch (task->tk_status) {
	case 0:
		/* Success */
		break;
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
	case -ETIMEDOUT:
		/*
		 * Problem reaching the server.  Disconnect and let the
		 * forechannel reestablish the connection.  The server will
		 * have to retransmit the backchannel request and we'll
		 * reprocess it.  Since these ops are idempotent, there's no
		 * need to cache our reply at this time.
		 */
		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
			"error: %d\n", task->tk_status);
1860
		xprt_conditional_disconnect(req->rq_xprt,
1861 1862 1863 1864 1865 1866 1867
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1868
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1869 1870 1871 1872 1873 1874
		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
			"error: %d\n", task->tk_status);
		break;
	}
	rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
}
1875
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1876

L
Linus Torvalds 已提交
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
/*
 * 6.	Sort out the RPC call status
 */
static void
call_status(struct rpc_task *task)
{
	struct rpc_clnt	*clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
	int		status;

1887 1888
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1889

1890
	dprint_status(task);
L
Linus Torvalds 已提交
1891 1892 1893 1894 1895 1896 1897

	status = task->tk_status;
	if (status >= 0) {
		task->tk_action = call_decode;
		return;
	}

1898
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1899 1900
	task->tk_status = 0;
	switch(status) {
1901 1902 1903 1904 1905 1906 1907 1908
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
		/*
		 * Delay any retries for 3 seconds, then handle as if it
		 * were a timeout.
		 */
		rpc_delay(task, 3*HZ);
L
Linus Torvalds 已提交
1909 1910
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1911 1912
		if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
		    && task->tk_client->cl_discrtry)
1913
			xprt_conditional_disconnect(req->rq_xprt,
1914
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1915
		break;
1916
	case -ECONNRESET:
L
Linus Torvalds 已提交
1917
	case -ECONNREFUSED:
1918
		rpc_force_rebind(clnt);
1919 1920 1921
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1922 1923 1924 1925 1926 1927 1928 1929 1930 1931
		task->tk_action = call_bind;
		break;
	case -EAGAIN:
		task->tk_action = call_transmit;
		break;
	case -EIO:
		/* shutdown or soft timeout */
		rpc_exit(task, status);
		break;
	default:
O
Olga Kornievskaia 已提交
1932 1933
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
1934
			       clnt->cl_program->name, -status);
L
Linus Torvalds 已提交
1935 1936 1937 1938 1939
		rpc_exit(task, status);
	}
}

/*
1940
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1941 1942 1943 1944 1945 1946 1947 1948 1949
 * 	We do not release the request slot, so we keep using the
 *	same XID for all retransmits.
 */
static void
call_timeout(struct rpc_task *task)
{
	struct rpc_clnt	*clnt = task->tk_client;

	if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1950
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1951 1952 1953
		goto retry;
	}

1954
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1955 1956
	task->tk_timeouts++;

1957 1958 1959 1960
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
1961
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
1962
		if (clnt->cl_chatty) {
1963
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1964
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1965
				clnt->cl_program->name,
1966 1967
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
J
Joe Perches 已提交
1968
		}
1969 1970 1971 1972
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1973 1974 1975
		return;
	}

C
Chuck Lever 已提交
1976
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1977
		task->tk_flags |= RPC_CALL_MAJORSEEN;
1978 1979
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1980
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1981
			clnt->cl_program->name,
1982 1983 1984
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1985
	}
1986
	rpc_force_rebind(clnt);
1987 1988 1989 1990 1991
	/*
	 * Did our request time out due to an RPCSEC_GSS out-of-sequence
	 * event? RFC2203 requires the server to drop all such requests.
	 */
	rpcauth_invalcred(task);
L
Linus Torvalds 已提交
1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005

retry:
	task->tk_action = call_bind;
	task->tk_status = 0;
}

/*
 * 7.	Decode the RPC reply
 */
static void
call_decode(struct rpc_task *task)
{
	struct rpc_clnt	*clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2006
	kxdrdproc_t	decode = task->tk_msg.rpc_proc->p_decode;
2007
	__be32		*p;
L
Linus Torvalds 已提交
2008

2009
	dprint_status(task);
L
Linus Torvalds 已提交
2010

C
Chuck Lever 已提交
2011
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2012 2013
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2014
			printk(KERN_NOTICE "%s: server %s OK\n",
2015
				clnt->cl_program->name,
2016 2017 2018
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
2019 2020 2021
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

2022 2023
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
2024
	 * before it changed req->rq_reply_bytes_recvd.
2025 2026
	 */
	smp_rmb();
L
Linus Torvalds 已提交
2027 2028 2029 2030 2031 2032
	req->rq_rcv_buf.len = req->rq_private_buf.len;

	/* Check that the softirq receive buffer is valid */
	WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
				sizeof(req->rq_rcv_buf)) != 0);

2033 2034 2035 2036 2037 2038
	if (req->rq_rcv_buf.len < 12) {
		if (!RPC_IS_SOFT(task)) {
			task->tk_action = call_bind;
			goto out_retry;
		}
		dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
2039
				clnt->cl_program->name, task->tk_status);
2040 2041 2042 2043
		task->tk_action = call_timeout;
		goto out_retry;
	}

2044
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2045 2046 2047 2048
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2049 2050
	}

T
Trond Myklebust 已提交
2051
	task->tk_action = rpc_exit_task;
L
Linus Torvalds 已提交
2052

2053
	if (decode) {
L
Linus Torvalds 已提交
2054 2055
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
2056
	}
2057 2058
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
2059 2060 2061
	return;
out_retry:
	task->tk_status = 0;
2062
	/* Note: rpc_verify_header() may have freed the RPC slot */
2063
	if (task->tk_rqstp == req) {
2064
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2065
		if (task->tk_client->cl_discrtry)
2066
			xprt_conditional_disconnect(req->rq_xprt,
2067
					req->rq_connect_cookie);
2068
	}
L
Linus Torvalds 已提交
2069 2070
}

2071
static __be32 *
2072
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2073 2074 2075
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2076
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2077 2078

	/* FIXME: check buffer size? */
2079

2080
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2081 2082 2083 2084 2085 2086
	*p++ = req->rq_xid;		/* XID */
	*p++ = htonl(RPC_CALL);		/* CALL */
	*p++ = htonl(RPC_VERSION);	/* RPC version */
	*p++ = htonl(clnt->cl_prog);	/* program number */
	*p++ = htonl(clnt->cl_vers);	/* program version */
	*p++ = htonl(task->tk_msg.rpc_proc->p_proc);	/* procedure */
2087 2088 2089
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2090 2091
}

2092
static __be32 *
2093
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2094
{
2095
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2096 2097
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2098 2099
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2100 2101
	int error = -EACCES;

2102 2103 2104 2105 2106 2107
	if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
		/* RFC-1014 says that the representation of XDR data must be a
		 * multiple of four bytes
		 * - if it isn't pointer subtraction in the NFS client may give
		 *   undefined results
		 */
2108
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2109
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2110
		       task->tk_rqstp->rq_rcv_buf.len);
2111 2112
		error = -EIO;
		goto out_err;
2113
	}
L
Linus Torvalds 已提交
2114 2115 2116
	if ((len -= 3) < 0)
		goto out_overflow;

2117
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2118
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2119
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2120
			task->tk_pid, __func__, n);
2121
		error = -EIO;
T
Trond Myklebust 已提交
2122
		goto out_garbage;
L
Linus Torvalds 已提交
2123
	}
2124

L
Linus Torvalds 已提交
2125 2126 2127 2128
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
J
Joe Perches 已提交
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
		case RPC_AUTH_ERROR:
			break;
		case RPC_MISMATCH:
			dprintk("RPC: %5u %s: RPC call version mismatch!\n",
				task->tk_pid, __func__);
			error = -EPROTONOSUPPORT;
			goto out_err;
		default:
			dprintk("RPC: %5u %s: RPC call rejected, "
				"unknown error: %x\n",
				task->tk_pid, __func__, n);
2140 2141
			error = -EIO;
			goto out_err;
L
Linus Torvalds 已提交
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152
		}
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
		case RPC_AUTH_REJECTEDCRED:
		case RPC_AUTH_REJECTEDVERF:
		case RPCSEC_GSS_CREDPROBLEM:
		case RPCSEC_GSS_CTXPROBLEM:
			if (!task->tk_cred_retry)
				break;
			task->tk_cred_retry--;
2153
			dprintk("RPC: %5u %s: retry stale creds\n",
2154
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2155
			rpcauth_invalcred(task);
2156 2157
			/* Ensure we obtain a new XID! */
			xprt_release(task);
2158
			task->tk_action = call_reserve;
T
Trond Myklebust 已提交
2159
			goto out_retry;
L
Linus Torvalds 已提交
2160 2161 2162 2163 2164 2165
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
2166
			dprintk("RPC: %5u %s: retry garbled creds\n",
2167
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2168
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
2169
			goto out_retry;
L
Linus Torvalds 已提交
2170
		case RPC_AUTH_TOOWEAK:
2171
			rcu_read_lock();
2172
			printk(KERN_NOTICE "RPC: server %s requires stronger "
2173 2174 2175
			       "authentication.\n",
			       rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
L
Linus Torvalds 已提交
2176 2177
			break;
		default:
2178
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
2179
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2180 2181
			error = -EIO;
		}
2182
		dprintk("RPC: %5u %s: call rejected %d\n",
2183
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2184 2185
		goto out_err;
	}
2186 2187 2188 2189 2190
	p = rpcauth_checkverf(task, p);
	if (IS_ERR(p)) {
		error = PTR_ERR(p);
		dprintk("RPC: %5u %s: auth check failed with %d\n",
				task->tk_pid, __func__, error);
T
Trond Myklebust 已提交
2191
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
2192
	}
2193
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
2194 2195 2196 2197 2198 2199
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
2200 2201 2202 2203
		dprintk_rcu("RPC: %5u %s: program %u is unsupported "
				"by server %s\n", task->tk_pid, __func__,
				(unsigned int)clnt->cl_prog,
				rcu_dereference(clnt->cl_xprt)->servername);
2204 2205
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2206
	case RPC_PROG_MISMATCH:
2207 2208 2209 2210 2211
		dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
				"by server %s\n", task->tk_pid, __func__,
				(unsigned int)clnt->cl_prog,
				(unsigned int)clnt->cl_vers,
				rcu_dereference(clnt->cl_xprt)->servername);
2212 2213
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2214
	case RPC_PROC_UNAVAIL:
2215
		dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2216
				"version %u on server %s\n",
2217
				task->tk_pid, __func__,
2218
				rpc_proc_name(task),
2219 2220
				clnt->cl_prog, clnt->cl_vers,
				rcu_dereference(clnt->cl_xprt)->servername);
2221 2222
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
2223
	case RPC_GARBAGE_ARGS:
2224
		dprintk("RPC: %5u %s: server saw garbage\n",
2225
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2226 2227
		break;			/* retry */
	default:
2228
		dprintk("RPC: %5u %s: server accept status: %x\n",
2229
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2230 2231 2232
		/* Also retry */
	}

T
Trond Myklebust 已提交
2233
out_garbage:
2234
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2235 2236
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2237
		dprintk("RPC: %5u %s: retrying\n",
2238
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2239
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2240 2241
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2242 2243 2244
	}
out_err:
	rpc_exit(task, error);
2245
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2246
			__func__, error);
T
Trond Myklebust 已提交
2247
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2248
out_overflow:
2249
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2250
			__func__);
T
Trond Myklebust 已提交
2251
	goto out_garbage;
L
Linus Torvalds 已提交
2252
}
2253

2254
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2255 2256 2257
{
}

2258
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2259 2260 2261 2262 2263 2264 2265 2266 2267
{
	return 0;
}

static struct rpc_procinfo rpcproc_null = {
	.p_encode = rpcproc_encode_null,
	.p_decode = rpcproc_decode_null,
};

2268
static int rpc_ping(struct rpc_clnt *clnt)
2269 2270 2271 2272 2273 2274
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2275
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2276 2277 2278
	put_rpccred(msg.rpc_cred);
	return err;
}
2279

2280 2281 2282 2283 2284 2285
struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
		.rpc_cred = cred,
	};
2286 2287 2288 2289 2290 2291
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2292
	return rpc_run_task(&task_setup_data);
2293
}
2294
EXPORT_SYMBOL_GPL(rpc_call_null);
2295

2296
#ifdef RPC_DEBUG
2297 2298
static void rpc_show_header(void)
{
2299 2300
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2301 2302
}

C
Chuck Lever 已提交
2303 2304 2305 2306 2307 2308 2309 2310
static void rpc_show_task(const struct rpc_clnt *clnt,
			  const struct rpc_task *task)
{
	const char *rpc_waitq = "none";

	if (RPC_IS_QUEUED(task))
		rpc_waitq = rpc_qname(task->tk_waitqueue);

2311
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2312 2313
		task->tk_pid, task->tk_flags, task->tk_status,
		clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2314
		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2315
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2316 2317
}

2318
void rpc_show_tasks(struct net *net)
2319 2320
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2321
	struct rpc_task *task;
2322
	int header = 0;
2323
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2324

2325 2326
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2327
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2328
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2329 2330 2331 2332
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2333
			rpc_show_task(clnt, task);
2334 2335 2336
		}
		spin_unlock(&clnt->cl_lock);
	}
2337
	spin_unlock(&sn->rpc_client_lock);
2338 2339
}
#endif