clnt.c 55.0 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(const struct rpc_create_args *args,
			       struct rpc_clnt *clnt)
{
278 279 280 281
	struct rpc_auth_create_args auth_args = {
		.pseudoflavor = args->authflavor,
		.target_name = args->client_name,
	};
282 283 284
	struct rpc_auth *auth;
	struct net *net = rpc_net_ns(clnt);
	struct super_block *pipefs_sb;
285
	int err;
286 287 288

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

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

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

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
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);
}

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

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

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

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

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

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

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

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

386 387 388 389 390 391 392
	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 已提交
393
	clnt->cl_rtt = &clnt->cl_rtt_default;
394
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
L
Linus Torvalds 已提交
395

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

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

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

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

421
/**
422 423 424 425 426 427 428 429 430 431 432 433 434
 * 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;
435
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
436
		.net = args->net,
437
		.ident = args->protocol,
438
		.srcaddr = args->saddress,
439 440
		.dstaddr = args->address,
		.addrlen = args->addrsize,
441
		.servername = args->servername,
442
		.bc_xprt = args->bc_xprt,
443
	};
444
	char servername[48];
445

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

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

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

488 489 490 491 492 493 494 495 496 497
	/*
	 * 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;

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

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
503
		int err = rpc_ping(clnt);
504 505 506 507 508 509 510 511 512 513 514 515
		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;
516 517
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
518 519
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
520 521 522

	return clnt;
}
523
EXPORT_SYMBOL_GPL(rpc_create);
524

L
Linus Torvalds 已提交
525 526 527 528 529
/*
 * 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 已提交
530 531
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
532
{
533
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
534 535
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
536

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

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

	/* 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 已提交
556
	return new;
C
Chuck Lever 已提交
557 558

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

/**
 * 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);
}
580
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
581

582 583 584 585
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
586
 * @flavor: security flavor for new client
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
 *
 * 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);

603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
/*
 * 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);
625 626 627
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
628 629 630 631 632 633
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

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

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

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

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

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

677 678 679 680
/*
 * Free an RPC client
 */
static void
681
rpc_free_auth(struct rpc_clnt *clnt)
682 683
{
	if (clnt->cl_auth == NULL) {
684
		rpc_free_client(clnt);
685 686 687 688 689 690 691 692
		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.
	 */
693
	atomic_inc(&clnt->cl_count);
694 695
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
696 697
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
698 699
}

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

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

715 716
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
717 718 719
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
720 721 722 723 724 725
 *
 * 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,
726
				      const struct rpc_program *program,
727
				      u32 vers)
728
{
729 730 731 732 733 734
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
	};
735 736 737
	struct rpc_clnt *clnt;
	int err;

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

751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
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;
772
		atomic_inc(&clnt->cl_count);
773 774
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
775 776
		if (clnt->cl_noretranstimeo)
			task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
M
Mel Gorman 已提交
777 778 779 780 781 782 783 784 785
		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();
		}
786 787 788 789 790 791 792
		/* 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);
	}
}

793 794 795 796 797 798 799 800
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);


801 802 803 804 805 806 807
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;
808 809
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
810 811 812
	}
}

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

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

T
Trond Myklebust 已提交
825 826 827 828 829
/**
 * 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)
830
{
831
	struct rpc_task *task;
832

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

837 838 839 840 841 842
	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);

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

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

867 868 869 870 871 872
	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 已提交
873

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

883 884 885 886 887
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
888
 * @tk_ops: RPC call ops
889
 * @data: user call data
L
Linus Torvalds 已提交
890 891
 */
int
892
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
893
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
894 895
{
	struct rpc_task	*task;
896 897 898 899 900 901 902
	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 已提交
903

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

912
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
913 914 915
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
916 917
 * @req: RPC request
 * @tk_ops: RPC call ops
918 919
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
920
				const struct rpc_call_ops *tk_ops)
921 922 923 924 925 926 927 928 929 930 931 932
{
	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);
933
	if (IS_ERR(task)) {
934 935 936 937 938 939 940 941 942 943 944 945 946 947
		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);
948
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
949 950 951 952 953 954
	rpc_execute(task);

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

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

964 965 966 967
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
968
 * @bufsize: length of target buffer
969 970 971 972 973 974
 *
 * 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;
975 976 977 978
	struct rpc_xprt *xprt;

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

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

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

990 991 992 993 994
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
995 996 997
 * 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.
998
 */
999 1000
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
1001
{
1002 1003 1004
	struct rpc_xprt *xprt;

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

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

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
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 已提交
1162 1163 1164
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1165 1166 1167 1168
	struct rpc_xprt *xprt;

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

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
/**
 * 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 已提交
1210 1211 1212 1213 1214 1215 1216 1217
 *
 * 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)
{
1218 1219 1220 1221 1222 1223
	size_t ret;

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

1227
/**
T
Trond Myklebust 已提交
1228
 * rpc_get_timeout - Get timeout for transport in units of HZ
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
 * @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);

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

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

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

1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
#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 已提交
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
/*
 * 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;

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

	/* 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)
{
1330
	dprint_status(task);
L
Linus Torvalds 已提交
1331 1332 1333 1334 1335 1336

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

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

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

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

	/*
	 * 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) {
1356
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1357 1358 1359 1360
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1361
				__func__, status);
L
Linus Torvalds 已提交
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
		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",
1372
				__func__, status);
L
Linus Torvalds 已提交
1373 1374 1375 1376
		xprt_release(task);
	}

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

1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
/*
 * 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 已提交
1405
/*
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
 * 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;
1430
	task->tk_action = call_refresh;
1431
	switch (status) {
1432 1433 1434
	case 0:
		if (rpcauth_uptodatecred(task))
			task->tk_action = call_allocate;
1435 1436 1437
		return;
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1438 1439
	case -EAGAIN:
		status = -EACCES;
1440
	case -EKEYEXPIRED:
1441 1442 1443 1444 1445 1446
		if (!task->tk_cred_retry)
			break;
		task->tk_cred_retry--;
		dprintk("RPC: %5u %s: retry refresh creds\n",
				task->tk_pid, __func__);
		return;
1447
	}
1448 1449 1450
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1451 1452 1453 1454
}

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

1465 1466
	dprint_status(task);

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

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

1473 1474 1475 1476 1477
	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 已提交
1478

1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
	/*
	 * 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;

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

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

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

	rpc_exit(task, -ERESTARTSYS);
}

1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
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;
1515
	task->tk_rqstp->rq_bytes_sent = 0;
1516 1517
}

1518 1519 1520 1521 1522 1523 1524
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;
1525
	buf->flags = 0;
1526 1527 1528 1529
	buf->len = 0;
	buf->buflen = len;
}

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

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

1542 1543 1544 1545 1546 1547
	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 已提交
1548

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

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

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

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

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

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

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

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

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

	rpc_exit(task, status);
	return;

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

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

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

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

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

1692
	dprint_status(task);
1693

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

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1722
	dprint_status(task);
L
Linus Torvalds 已提交
1723 1724 1725 1726

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
1727
	if (!xprt_prepare_transmit(task))
L
Linus Torvalds 已提交
1728
		return;
1729
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1730
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1731
	if (rpc_task_need_encode(task)) {
1732
		rpc_xdr_encode(task);
1733
		/* Did the encode result in an error condition? */
1734 1735 1736 1737 1738 1739
		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);
1740
			return;
1741
		}
1742
	}
L
Linus Torvalds 已提交
1743 1744 1745
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1746 1747 1748 1749 1750
	/*
	 * 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);
1751
	if (rpc_reply_expected(task))
1752 1753
		return;
	task->tk_action = rpc_exit_task;
1754
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1755 1756 1757 1758 1759 1760 1761 1762 1763
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774

	/*
	 * 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;
	}

1775 1776 1777 1778
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1779
		dprint_status(task);
1780
		xprt_end_transmit(task);
1781 1782
		rpc_task_force_reencode(task);
		break;
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
		/*
		 * 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:
1793 1794 1795 1796 1797 1798 1799
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1800
	case -EPIPE:
1801 1802
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1803 1804
}

1805
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1806 1807 1808 1809 1810 1811 1812 1813 1814
/*
 * 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;

1815
	if (!xprt_prepare_transmit(task)) {
1816 1817 1818 1819 1820 1821 1822 1823 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
		/*
		 * 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);
1852
		xprt_conditional_disconnect(req->rq_xprt,
1853 1854 1855 1856 1857 1858 1859
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1860
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1861 1862 1863 1864 1865 1866
		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);
}
1867
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1868

L
Linus Torvalds 已提交
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
/*
 * 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;

1879 1880
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1881

1882
	dprint_status(task);
L
Linus Torvalds 已提交
1883 1884 1885 1886 1887 1888 1889

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

1890
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1891 1892
	task->tk_status = 0;
	switch(status) {
1893 1894 1895 1896 1897 1898 1899 1900
	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 已提交
1901 1902
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1903 1904
		if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
		    && task->tk_client->cl_discrtry)
1905
			xprt_conditional_disconnect(req->rq_xprt,
1906
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1907
		break;
1908
	case -ECONNRESET:
L
Linus Torvalds 已提交
1909
	case -ECONNREFUSED:
1910
		rpc_force_rebind(clnt);
1911 1912 1913
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
		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 已提交
1924 1925
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
1926
			       clnt->cl_program->name, -status);
L
Linus Torvalds 已提交
1927 1928 1929 1930 1931
		rpc_exit(task, status);
	}
}

/*
1932
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1933 1934 1935 1936 1937 1938 1939 1940 1941
 * 	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) {
1942
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1943 1944 1945
		goto retry;
	}

1946
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1947 1948
	task->tk_timeouts++;

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

C
Chuck Lever 已提交
1968
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1969
		task->tk_flags |= RPC_CALL_MAJORSEEN;
1970 1971
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1972
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1973
			clnt->cl_program->name,
1974 1975 1976
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1977
	}
1978
	rpc_force_rebind(clnt);
1979 1980 1981 1982 1983
	/*
	 * 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 已提交
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998

retry:
	clnt->cl_stats->rpcretrans++;
	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;
1999
	kxdrdproc_t	decode = task->tk_msg.rpc_proc->p_decode;
2000
	__be32		*p;
L
Linus Torvalds 已提交
2001

2002
	dprint_status(task);
L
Linus Torvalds 已提交
2003

C
Chuck Lever 已提交
2004
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2005 2006
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2007
			printk(KERN_NOTICE "%s: server %s OK\n",
2008
				clnt->cl_program->name,
2009 2010 2011
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
2012 2013 2014
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

2015 2016
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
2017
	 * before it changed req->rq_reply_bytes_recvd.
2018 2019
	 */
	smp_rmb();
L
Linus Torvalds 已提交
2020 2021 2022 2023 2024 2025
	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);

2026 2027 2028 2029 2030 2031 2032
	if (req->rq_rcv_buf.len < 12) {
		if (!RPC_IS_SOFT(task)) {
			task->tk_action = call_bind;
			clnt->cl_stats->rpcretrans++;
			goto out_retry;
		}
		dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
2033
				clnt->cl_program->name, task->tk_status);
2034 2035 2036 2037
		task->tk_action = call_timeout;
		goto out_retry;
	}

2038
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2039 2040 2041 2042
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2043 2044
	}

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

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

2065
static __be32 *
2066
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2067 2068 2069
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2070
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2071 2072

	/* FIXME: check buffer size? */
2073

2074
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2075 2076 2077 2078 2079 2080
	*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 */
2081 2082 2083
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2084 2085
}

2086
static __be32 *
2087
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2088
{
2089
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2090 2091
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2092 2093
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2094 2095
	int error = -EACCES;

2096 2097 2098 2099 2100 2101
	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
		 */
2102
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2103
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2104
		       task->tk_rqstp->rq_rcv_buf.len);
2105 2106
		error = -EIO;
		goto out_err;
2107
	}
L
Linus Torvalds 已提交
2108 2109 2110
	if ((len -= 3) < 0)
		goto out_overflow;

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

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

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

2248
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2249 2250 2251
{
}

2252
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2253 2254 2255 2256 2257 2258 2259 2260 2261
{
	return 0;
}

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

2262
static int rpc_ping(struct rpc_clnt *clnt)
2263 2264 2265 2266 2267 2268
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2269
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2270 2271 2272
	put_rpccred(msg.rpc_cred);
	return err;
}
2273

2274 2275 2276 2277 2278 2279
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,
	};
2280 2281 2282 2283 2284 2285
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2286
	return rpc_run_task(&task_setup_data);
2287
}
2288
EXPORT_SYMBOL_GPL(rpc_call_null);
2289

2290
#ifdef RPC_DEBUG
2291 2292
static void rpc_show_header(void)
{
2293 2294
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2295 2296
}

C
Chuck Lever 已提交
2297 2298 2299 2300 2301 2302 2303 2304
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);

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

2312
void rpc_show_tasks(struct net *net)
2313 2314
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2315
	struct rpc_task *task;
2316
	int header = 0;
2317
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2318

2319 2320
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2321
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2322
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2323 2324 2325 2326
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2327
			rpc_show_task(clnt, task);
2328 2329 2330
		}
		spin_unlock(&clnt->cl_lock);
	}
2331
	spin_unlock(&sn->rpc_client_lock);
2332 2333
}
#endif