clnt.c 54.9 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;
M
Mel Gorman 已提交
775 776 777 778 779 780 781 782 783
		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();
		}
784 785 786 787 788 789 790
		/* 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);
	}
}

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


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

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

819 820 821 822
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

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

831
	task = rpc_new_task(task_setup_data);
832
	if (IS_ERR(task))
833
		goto out;
834

835 836 837 838 839 840
	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);

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

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

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

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

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

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

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

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

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

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

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

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

	return bytes;
985
}
986
EXPORT_SYMBOL_GPL(rpc_peeraddr);
987

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

	xprt = rcu_dereference(clnt->cl_xprt);
1003 1004 1005 1006 1007

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

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

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

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

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

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

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

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

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

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

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

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

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

1335 1336
static void call_retry_reserve(struct rpc_task *task);

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

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

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

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

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

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

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

1463 1464
	dprint_status(task);

1465
	task->tk_status = 0;
1466
	task->tk_action = call_bind;
1467

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

1471 1472 1473 1474 1475
	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 已提交
1476

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

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

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

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

	rpc_exit(task, -ERESTARTSYS);
}

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

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

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

1538
	dprint_status(task);
L
Linus Torvalds 已提交
1539

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

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

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

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

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

1570
	dprint_status(task);
L
Linus Torvalds 已提交
1571

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

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

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

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

	rpc_exit(task, status);
	return;

1652 1653
retry_timeout:
	task->tk_action = call_timeout;
1654 1655 1656 1657
}

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

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

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

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

1690
	dprint_status(task);
1691

1692
	trace_rpc_connect_status(task, status);
L
Linus Torvalds 已提交
1693
	switch (status) {
1694 1695 1696
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
		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 已提交
1710
	}
1711
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1712 1713 1714 1715 1716 1717 1718 1719
}

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

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

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

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

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

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

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

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

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

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

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

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

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

1943
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1944 1945
	task->tk_timeouts++;

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

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

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;
1996
	kxdrdproc_t	decode = task->tk_msg.rpc_proc->p_decode;
1997
	__be32		*p;
L
Linus Torvalds 已提交
1998

1999
	dprint_status(task);
L
Linus Torvalds 已提交
2000

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

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

2023 2024 2025 2026 2027 2028 2029
	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",
2030
				clnt->cl_program->name, task->tk_status);
2031 2032 2033 2034
		task->tk_action = call_timeout;
		goto out_retry;
	}

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

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

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

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

	/* FIXME: check buffer size? */
2070

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

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

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

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

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

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

2245
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2246 2247 2248
{
}

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

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

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

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

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

C
Chuck Lever 已提交
2294 2295 2296 2297 2298 2299 2300 2301
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);

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

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

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