clnt.c 57.6 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
#include <linux/slab.h>
28
#include <linux/rcupdate.h>
L
Linus Torvalds 已提交
29
#include <linux/utsname.h>
30
#include <linux/workqueue.h>
31
#include <linux/in.h>
32
#include <linux/in6.h>
33
#include <linux/un.h>
34
#include <linux/rcupdate.h>
L
Linus Torvalds 已提交
35 36

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

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

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

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

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

L
Linus Torvalds 已提交
58 59 60 61 62 63 64 65 66
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);
67
static void	call_bind_status(struct rpc_task *task);
L
Linus Torvalds 已提交
68
static void	call_transmit(struct rpc_task *task);
69
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
70
static void	call_bc_transmit(struct rpc_task *task);
71
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
L
Linus Torvalds 已提交
72
static void	call_status(struct rpc_task *task);
73
static void	call_transmit_status(struct rpc_task *task);
L
Linus Torvalds 已提交
74 75 76 77 78 79
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);

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

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

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

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

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

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

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

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

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

129
	dir = rpc_d_lookup_sb(sb, dir_name);
130 131
	if (dir == NULL) {
		pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
132
		return dir;
133
	}
134
	for (;;) {
135
		snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
136
		name[sizeof(name) - 1] = '\0';
137
		dentry = rpc_create_client_dir(dir, name, clnt);
138
		if (!IS_ERR(dentry))
139
			break;
140 141 142 143 144 145
		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 已提交
146
	}
147 148 149 150 151
	dput(dir);
	return dentry;
}

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

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

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

169 170 171 172 173 174 175 176 177 178 179 180
	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;
	}
181 182 183 184 185
	return 0;
}

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

	switch (event) {
	case RPC_PIPEFS_MOUNT:
192
		dentry = rpc_setup_pipedir_sb(sb, clnt);
193 194
		if (!dentry)
			return -ENOENT;
195 196 197 198 199 200 201 202 203 204 205 206 207
		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;
}

208 209 210 211 212 213 214 215 216 217 218 219 220 221
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;
}

222 223 224 225 226 227 228
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) {
229
		if (rpc_clnt_skip_event(clnt, event))
230 231 232 233 234 235 236 237
			continue;
		spin_unlock(&sn->rpc_client_lock);
		return clnt;
	}
	spin_unlock(&sn->rpc_client_lock);
	return NULL;
}

238 239 240 241 242 243 244
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;

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

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

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);
}

268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
		struct rpc_xprt *xprt,
		const struct rpc_timeout *timeout)
{
	struct rpc_xprt *old;

	spin_lock(&clnt->cl_lock);
	old = clnt->cl_xprt;

	if (!xprt_bound(xprt))
		clnt->cl_autobind = 1;

	clnt->cl_timeout = timeout;
	rcu_assign_pointer(clnt->cl_xprt, xprt);
	spin_unlock(&clnt->cl_lock);

	return old;
}

287 288 289 290 291 292 293 294
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);
}

295 296 297
static int rpc_client_register(struct rpc_clnt *clnt,
			       rpc_authflavor_t pseudoflavor,
			       const char *client_name)
298
{
299
	struct rpc_auth_create_args auth_args = {
300 301
		.pseudoflavor = pseudoflavor,
		.target_name = client_name,
302
	};
303 304 305
	struct rpc_auth *auth;
	struct net *net = rpc_net_ns(clnt);
	struct super_block *pipefs_sb;
306
	int err;
307 308 309

	pipefs_sb = rpc_get_sb_net(net);
	if (pipefs_sb) {
310
		err = rpc_setup_pipedir(pipefs_sb, clnt);
311 312 313 314
		if (err)
			goto out;
	}

315 316 317 318
	rpc_register_client(clnt);
	if (pipefs_sb)
		rpc_put_sb_net(net);

319
	auth = rpcauth_create(&auth_args, clnt);
320 321
	if (IS_ERR(auth)) {
		dprintk("RPC:       Couldn't create auth handle (flavor %u)\n",
322
				pseudoflavor);
323 324 325
		err = PTR_ERR(auth);
		goto err_auth;
	}
326 327 328
	return 0;
err_auth:
	pipefs_sb = rpc_get_sb_net(net);
329
	rpc_unregister_client(clnt);
330
	__rpc_clnt_remove_pipedir(clnt);
331 332 333 334 335 336
out:
	if (pipefs_sb)
		rpc_put_sb_net(net);
	return err;
}

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
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);
}

355 356 357
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
		struct rpc_xprt *xprt,
		struct rpc_clnt *parent)
L
Linus Torvalds 已提交
358
{
359 360
	const struct rpc_program *program = args->program;
	const struct rpc_version *version;
361 362
	struct rpc_clnt *clnt = NULL;
	const struct rpc_timeout *timeout;
L
Linus Torvalds 已提交
363
	int err;
364 365

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

369 370 371
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
372

373
	err = -EINVAL;
374 375 376 377
	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
378 379 380
		goto out_err;

	err = -ENOMEM;
381
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
382 383
	if (!clnt)
		goto out_err;
384
	clnt->cl_parent = parent ? : clnt;
L
Linus Torvalds 已提交
385

386 387 388
	err = rpc_alloc_clid(clnt);
	if (err)
		goto out_no_clid;
L
Linus Torvalds 已提交
389 390 391

	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
392
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
393 394
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
395
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
396
	rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
397 398 399
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
400
	clnt->cl_program  = program;
401
	INIT_LIST_HEAD(&clnt->cl_tasks);
402
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
403

404
	timeout = xprt->timeout;
405 406 407
	if (args->timeout != NULL) {
		memcpy(&clnt->cl_timeout_default, args->timeout,
				sizeof(clnt->cl_timeout_default));
408
		timeout = &clnt->cl_timeout_default;
409 410
	}

411 412
	rpc_clnt_set_transport(clnt, xprt, timeout);

L
Linus Torvalds 已提交
413
	clnt->cl_rtt = &clnt->cl_rtt_default;
414
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
L
Linus Torvalds 已提交
415

416
	atomic_set(&clnt->cl_count, 1);
417

L
Linus Torvalds 已提交
418
	/* save the nodename */
419
	rpc_clnt_set_nodename(clnt, utsname()->nodename);
420

421
	err = rpc_client_register(clnt, args->authflavor, args->client_name);
422 423
	if (err)
		goto out_no_path;
424 425
	if (parent)
		atomic_inc(&parent->cl_count);
L
Linus Torvalds 已提交
426 427 428
	return clnt;

out_no_path:
429 430
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
431 432
	rpc_free_clid(clnt);
out_no_clid:
L
Linus Torvalds 已提交
433 434
	kfree(clnt);
out_err:
435 436
	rpciod_down();
out_no_rpciod:
437
	xprt_put(xprt);
L
Linus Torvalds 已提交
438 439 440
	return ERR_PTR(err);
}

441
/**
442 443 444 445 446 447 448 449 450 451 452 453 454
 * 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;
455
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
456
		.net = args->net,
457
		.ident = args->protocol,
458
		.srcaddr = args->saddress,
459 460
		.dstaddr = args->address,
		.addrlen = args->addrsize,
461
		.servername = args->servername,
462
		.bc_xprt = args->bc_xprt,
463
	};
464
	char servername[48];
465

466 467
	if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
		xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
468 469
	if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
		xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
470 471 472 473
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
474
	if (xprtargs.servername == NULL) {
475 476
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
477 478 479 480 481
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

482 483
		servername[0] = '\0';
		switch (args->address->sa_family) {
484 485 486 487
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
488
		case AF_INET:
H
Harvey Harrison 已提交
489 490
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
491
			break;
492
		case AF_INET6:
H
Harvey Harrison 已提交
493
			snprintf(servername, sizeof(servername), "%pI6",
494
				 &sin6->sin6_addr);
495 496 497 498 499 500
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
501
		xprtargs.servername = servername;
502 503
	}

504 505 506 507
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

508 509 510 511 512 513 514 515 516 517
	/*
	 * 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;

518
	clnt = rpc_new_client(args, xprt, NULL);
519 520 521 522
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
523
		int err = rpc_ping(clnt);
524 525 526 527 528 529 530 531 532 533 534 535
		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;
536 537
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
538 539
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
540 541 542

	return clnt;
}
543
EXPORT_SYMBOL_GPL(rpc_create);
544

L
Linus Torvalds 已提交
545 546 547 548 549
/*
 * 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 已提交
550 551
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
552
{
553
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
554 555
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
556

C
Chuck Lever 已提交
557
	err = -ENOMEM;
558 559 560 561
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
	rcu_read_unlock();
	if (xprt == NULL)
C
Chuck Lever 已提交
562 563 564
		goto out_err;
	args->servername = xprt->servername;

565
	new = rpc_new_client(args, xprt, clnt);
C
Chuck Lever 已提交
566 567
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
568
		goto out_err;
C
Chuck Lever 已提交
569 570 571 572 573 574 575
	}

	/* 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 已提交
576
	return new;
C
Chuck Lever 已提交
577 578

out_err:
579
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
580
	return ERR_PTR(err);
L
Linus Torvalds 已提交
581
}
C
Chuck Lever 已提交
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599

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

602 603 604 605
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
606
 * @flavor: security flavor for new client
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
 *
 * 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);

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
/**
 * rpc_switch_client_transport: switch the RPC transport on the fly
 * @clnt: pointer to a struct rpc_clnt
 * @args: pointer to the new transport arguments
 * @timeout: pointer to the new timeout parameters
 *
 * This function allows the caller to switch the RPC transport for the
 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
 * server, for instance.  It assumes that the caller has ensured that
 * there are no active RPC tasks by using some form of locking.
 *
 * Returns zero if "clnt" is now using the new xprt.  Otherwise a
 * negative errno is returned, and "clnt" continues to use the old
 * xprt.
 */
int rpc_switch_client_transport(struct rpc_clnt *clnt,
		struct xprt_create *args,
		const struct rpc_timeout *timeout)
{
	const struct rpc_timeout *old_timeo;
	rpc_authflavor_t pseudoflavor;
	struct rpc_xprt *xprt, *old;
	struct rpc_clnt *parent;
	int err;

	xprt = xprt_create_transport(args);
	if (IS_ERR(xprt)) {
		dprintk("RPC:       failed to create new xprt for clnt %p\n",
			clnt);
		return PTR_ERR(xprt);
	}

	pseudoflavor = clnt->cl_auth->au_flavor;

	old_timeo = clnt->cl_timeout;
	old = rpc_clnt_set_transport(clnt, xprt, timeout);

	rpc_unregister_client(clnt);
	__rpc_clnt_remove_pipedir(clnt);

	/*
	 * A new transport was created.  "clnt" therefore
	 * becomes the root of a new cl_parent tree.  clnt's
	 * children, if it has any, still point to the old xprt.
	 */
	parent = clnt->cl_parent;
	clnt->cl_parent = clnt;

	/*
	 * The old rpc_auth cache cannot be re-used.  GSS
	 * contexts in particular are between a single
	 * client and server.
	 */
	err = rpc_client_register(clnt, pseudoflavor, NULL);
	if (err)
		goto out_revert;

	synchronize_rcu();
	if (parent != clnt)
		rpc_release_client(parent);
	xprt_put(old);
	dprintk("RPC:       replaced xprt for clnt %p\n", clnt);
	return 0;

out_revert:
	rpc_clnt_set_transport(clnt, old, old_timeo);
	clnt->cl_parent = parent;
	rpc_client_register(clnt, pseudoflavor, NULL);
	xprt_put(xprt);
	dprintk("RPC:       failed to switch xprt for clnt %p\n", clnt);
	return err;
}
EXPORT_SYMBOL_GPL(rpc_switch_client_transport);

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
/*
 * 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);
719 720 721
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
722 723 724 725 726 727
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
728 729
/*
 * Properly shut down an RPC client, terminating all outstanding
730
 * requests.
L
Linus Torvalds 已提交
731
 */
732
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
733
{
734 735
	might_sleep();

736
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
737
			clnt->cl_program->name,
738
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
739

740
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
741
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
742
		wait_event_timeout(destroy_wait,
743
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
744 745
	}

746
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
747
}
748
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
749 750

/*
751
 * Free an RPC client
L
Linus Torvalds 已提交
752
 */
753
static void
754
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
755
{
756
	dprintk_rcu("RPC:       destroying %s client for %s\n",
757
			clnt->cl_program->name,
758
			rcu_dereference(clnt->cl_xprt)->servername);
759
	if (clnt->cl_parent != clnt)
760
		rpc_release_client(clnt->cl_parent);
761
	rpc_clnt_remove_pipedir(clnt);
762
	rpc_unregister_client(clnt);
763 764
	rpc_free_iostats(clnt->cl_metrics);
	clnt->cl_metrics = NULL;
765
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
766
	rpciod_down();
767
	rpc_free_clid(clnt);
L
Linus Torvalds 已提交
768 769 770
	kfree(clnt);
}

771 772 773 774
/*
 * Free an RPC client
 */
static void
775
rpc_free_auth(struct rpc_clnt *clnt)
776 777
{
	if (clnt->cl_auth == NULL) {
778
		rpc_free_client(clnt);
779 780 781 782 783 784 785 786
		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.
	 */
787
	atomic_inc(&clnt->cl_count);
788 789
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
790 791
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
792 793
}

L
Linus Torvalds 已提交
794
/*
795
 * Release reference to the RPC client
L
Linus Torvalds 已提交
796 797 798 799
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
800
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
801

802 803
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
804 805
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_auth(clnt);
806
}
807
EXPORT_SYMBOL_GPL(rpc_release_client);
808

809 810
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
811 812 813
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
814 815 816 817 818 819
 *
 * 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,
820
				      const struct rpc_program *program,
821
				      u32 vers)
822
{
823 824 825 826 827 828
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
	};
829 830 831
	struct rpc_clnt *clnt;
	int err;

832
	clnt = __rpc_clone_client(&args, old);
833 834
	if (IS_ERR(clnt))
		goto out;
835
	err = rpc_ping(clnt);
836 837 838 839
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
840
out:
841 842
	return clnt;
}
843
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
844

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
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;
866
		atomic_inc(&clnt->cl_count);
867 868
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
869 870
		if (clnt->cl_noretranstimeo)
			task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
M
Mel Gorman 已提交
871 872 873 874 875 876 877 878 879
		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();
		}
880 881 882 883 884 885 886
		/* 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);
	}
}

887 888 889 890 891 892 893 894
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);


895 896 897 898 899 900 901
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;
902 903
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
904 905 906
	}
}

L
Linus Torvalds 已提交
907 908 909 910
/*
 * Default callback for async RPC calls
 */
static void
911
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
912 913 914
{
}

915 916 917 918
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
919 920 921 922 923
/**
 * 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)
924
{
925
	struct rpc_task *task;
926

927
	task = rpc_new_task(task_setup_data);
928
	if (IS_ERR(task))
929
		goto out;
930

931 932 933 934 935 936
	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);

937 938 939
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
940
	return task;
941
}
T
Trond Myklebust 已提交
942
EXPORT_SYMBOL_GPL(rpc_run_task);
943 944 945 946 947 948

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
949
 */
950
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
951 952
{
	struct rpc_task	*task;
953 954 955 956 957 958
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
959
	int status;
L
Linus Torvalds 已提交
960

961 962 963 964 965 966
	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 已提交
967

T
Trond Myklebust 已提交
968
	task = rpc_run_task(&task_setup_data);
969 970
	if (IS_ERR(task))
		return PTR_ERR(task);
971
	status = task->tk_status;
972
	rpc_put_task(task);
L
Linus Torvalds 已提交
973 974
	return status;
}
975
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
976

977 978 979 980 981
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
982
 * @tk_ops: RPC call ops
983
 * @data: user call data
L
Linus Torvalds 已提交
984 985
 */
int
986
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
987
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
988 989
{
	struct rpc_task	*task;
990 991 992 993 994 995 996
	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 已提交
997

T
Trond Myklebust 已提交
998
	task = rpc_run_task(&task_setup_data);
999 1000 1001 1002
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
1003
}
1004
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
1005

1006
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1007 1008 1009
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
1010 1011
 * @req: RPC request
 * @tk_ops: RPC call ops
1012 1013
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
1014
				const struct rpc_call_ops *tk_ops)
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
{
	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);
1027
	if (IS_ERR(task)) {
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
		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);
1042
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
1043 1044 1045 1046 1047 1048
	rpc_execute(task);

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

1051 1052 1053 1054 1055 1056 1057
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

1058 1059 1060 1061
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
1062
 * @bufsize: length of target buffer
1063 1064 1065 1066 1067 1068
 *
 * 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;
1069 1070 1071 1072
	struct rpc_xprt *xprt;

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

1074
	bytes = xprt->addrlen;
1075 1076
	if (bytes > bufsize)
		bytes = bufsize;
1077 1078 1079 1080
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
1081
}
1082
EXPORT_SYMBOL_GPL(rpc_peeraddr);
1083

1084 1085 1086 1087 1088
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
1089 1090 1091
 * 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.
1092
 */
1093 1094
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
1095
{
1096 1097 1098
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
1099 1100 1101 1102 1103

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
1104
}
1105
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1106

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 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 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
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 已提交
1256 1257 1258
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1259 1260 1261 1262
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1263 1264
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1265
	rcu_read_unlock();
L
Linus Torvalds 已提交
1266
}
1267
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
1268

1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
/**
 * 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 已提交
1304 1305 1306 1307 1308 1309 1310 1311
 *
 * 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)
{
1312 1313 1314 1315 1316 1317
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1318
}
1319
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1320

1321
/**
T
Trond Myklebust 已提交
1322
 * rpc_get_timeout - Get timeout for transport in units of HZ
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
 * @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);

1336 1337 1338 1339 1340 1341 1342
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1343 1344 1345 1346 1347
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1348
}
1349
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1350

1351 1352 1353 1354
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1355
int
1356 1357 1358
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1359
		return 0;
1360 1361 1362
	task->tk_action = call_start;
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1363
	return 1;
1364 1365 1366
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1367 1368 1369 1370
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1371
int
L
Linus Torvalds 已提交
1372 1373 1374
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1375
		return 0;
L
Linus Torvalds 已提交
1376
	task->tk_action = call_start;
1377
	return 1;
L
Linus Torvalds 已提交
1378
}
1379
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1380

1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
#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 已提交
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
/*
 * 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;

1407
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1408
			clnt->cl_program->name, clnt->cl_vers,
1409
			rpc_proc_name(task),
1410
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423

	/* 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)
{
1424
	dprint_status(task);
L
Linus Torvalds 已提交
1425 1426 1427 1428 1429 1430

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

1431 1432
static void call_retry_reserve(struct rpc_task *task);

L
Linus Torvalds 已提交
1433 1434 1435 1436 1437 1438 1439 1440
/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1441
	dprint_status(task);
L
Linus Torvalds 已提交
1442 1443 1444 1445 1446 1447 1448 1449

	/*
	 * 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) {
1450
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1451 1452 1453 1454
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1455
				__func__, status);
L
Linus Torvalds 已提交
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
		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",
1466
				__func__, status);
L
Linus Torvalds 已提交
1467 1468 1469 1470
		xprt_release(task);
	}

	switch (status) {
1471 1472
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1473
	case -EAGAIN:	/* woken up; retry */
1474
		task->tk_action = call_retry_reserve;
L
Linus Torvalds 已提交
1475 1476 1477 1478 1479
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1480
				__func__, status);
L
Linus Torvalds 已提交
1481 1482 1483 1484 1485
		break;
	}
	rpc_exit(task, status);
}

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
/*
 * 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 已提交
1499
/*
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
 * 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;
1524
	task->tk_action = call_refresh;
1525
	switch (status) {
1526 1527 1528
	case 0:
		if (rpcauth_uptodatecred(task))
			task->tk_action = call_allocate;
1529 1530 1531
		return;
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1532 1533
	case -EAGAIN:
		status = -EACCES;
1534
	case -EKEYEXPIRED:
1535 1536 1537 1538 1539 1540
		if (!task->tk_cred_retry)
			break;
		task->tk_cred_retry--;
		dprintk("RPC: %5u %s: retry refresh creds\n",
				task->tk_pid, __func__);
		return;
1541
	}
1542 1543 1544
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1545 1546 1547 1548
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1549
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1550 1551 1552 1553
 */
static void
call_allocate(struct rpc_task *task)
{
1554
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1555
	struct rpc_rqst *req = task->tk_rqstp;
1556
	struct rpc_xprt *xprt = req->rq_xprt;
1557
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1558

1559 1560
	dprint_status(task);

1561
	task->tk_status = 0;
1562
	task->tk_action = call_bind;
1563

1564
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1565 1566
		return;

1567 1568 1569 1570 1571
	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 已提交
1572

1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
	/*
	 * 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;

1583 1584
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1585
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1586
		return;
1587 1588

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

1590
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1591
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1592 1593 1594 1595 1596 1597 1598
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
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;
1609
	task->tk_rqstp->rq_bytes_sent = 0;
1610 1611
}

1612 1613 1614 1615 1616 1617 1618
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;
1619
	buf->flags = 0;
1620 1621 1622 1623
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1624 1625 1626 1627
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1628
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1629 1630
{
	struct rpc_rqst	*req = task->tk_rqstp;
1631
	kxdreproc_t	encode;
1632
	__be32		*p;
L
Linus Torvalds 已提交
1633

1634
	dprint_status(task);
L
Linus Torvalds 已提交
1635

1636 1637 1638 1639 1640 1641
	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 已提交
1642

1643 1644 1645
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1646 1647 1648
		rpc_exit(task, -EIO);
		return;
	}
1649 1650

	encode = task->tk_msg.rpc_proc->p_encode;
1651 1652 1653 1654 1655
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1656 1657 1658 1659 1660 1661 1662 1663
}

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

1666
	dprint_status(task);
L
Linus Torvalds 已提交
1667

1668
	task->tk_action = call_connect;
1669
	if (!xprt_bound(xprt)) {
1670
		task->tk_action = call_bind_status;
1671
		task->tk_timeout = xprt->bind_timeout;
1672
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1673 1674 1675 1676
	}
}

/*
1677 1678 1679 1680 1681
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1682
	int status = -EIO;
1683 1684

	if (task->tk_status >= 0) {
1685
		dprint_status(task);
1686 1687 1688 1689 1690
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1691
	trace_rpc_bind_status(task);
1692
	switch (task->tk_status) {
1693 1694 1695
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1696
		goto retry_timeout;
1697
	case -EACCES:
1698 1699
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1700 1701 1702 1703 1704
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1705 1706 1707
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1708
		rpc_delay(task, 3*HZ);
1709
		goto retry_timeout;
1710
	case -ETIMEDOUT:
1711
		dprintk("RPC: %5u rpcbind request timed out\n",
1712
				task->tk_pid);
1713
		goto retry_timeout;
1714
	case -EPFNOSUPPORT:
1715
		/* server doesn't support any rpcbind version we know of */
1716
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1717 1718 1719
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1720
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1721
				task->tk_pid);
1722 1723 1724
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
	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;
1740
	default:
1741
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1742 1743 1744 1745 1746 1747
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1748 1749
retry_timeout:
	task->tk_action = call_timeout;
1750 1751 1752 1753
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1754 1755 1756 1757
 */
static void
call_connect(struct rpc_task *task)
{
1758
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1759

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

1764 1765 1766 1767 1768
	task->tk_action = call_transmit;
	if (!xprt_connected(xprt)) {
		task->tk_action = call_connect_status;
		if (task->tk_status < 0)
			return;
1769 1770 1771 1772
		if (task->tk_flags & RPC_TASK_NOCONNECT) {
			rpc_exit(task, -ENOTCONN);
			return;
		}
1773
		xprt_connect(task);
L
Linus Torvalds 已提交
1774 1775 1776 1777
	}
}

/*
1778
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1779 1780 1781 1782 1783 1784 1785
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1786
	dprint_status(task);
1787

1788
	trace_rpc_connect_status(task, status);
1789
	task->tk_status = 0;
L
Linus Torvalds 已提交
1790
	switch (status) {
1791 1792 1793
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1794 1795 1796 1797
		return;
	case -ECONNREFUSED:
	case -ECONNRESET:
	case -ENETUNREACH:
1798 1799
		/* retry with existing socket, after a delay */
		rpc_delay(task, 3*HZ);
1800 1801 1802
		if (RPC_IS_SOFTCONN(task))
			break;
	case -EAGAIN:
1803 1804 1805
		task->tk_action = call_bind;
		return;
	case 0:
1806 1807 1808
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
L
Linus Torvalds 已提交
1809
	}
1810
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1811 1812 1813 1814 1815 1816 1817 1818
}

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

1821
	dprint_status(task);
L
Linus Torvalds 已提交
1822 1823 1824 1825

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
1826
	if (!xprt_prepare_transmit(task))
L
Linus Torvalds 已提交
1827
		return;
1828
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1829
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1830
	if (rpc_task_need_encode(task)) {
1831
		rpc_xdr_encode(task);
1832
		/* Did the encode result in an error condition? */
1833 1834 1835 1836 1837 1838
		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);
1839
			return;
1840
		}
1841
	}
L
Linus Torvalds 已提交
1842 1843 1844
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1845 1846
	if (is_retrans)
		task->tk_client->cl_stats->rpcretrans++;
1847 1848 1849 1850 1851
	/*
	 * 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);
1852
	if (rpc_reply_expected(task))
1853 1854
		return;
	task->tk_action = rpc_exit_task;
1855
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1856 1857 1858 1859 1860 1861 1862 1863 1864
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875

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

1876 1877 1878 1879
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1880
		dprint_status(task);
1881
		xprt_end_transmit(task);
1882 1883
		rpc_task_force_reencode(task);
		break;
1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
		/*
		 * 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:
1894 1895 1896 1897 1898 1899 1900
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1901
	case -EPIPE:
1902 1903
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1904 1905
}

1906
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1907 1908 1909 1910 1911 1912 1913 1914 1915
/*
 * 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;

1916
	if (!xprt_prepare_transmit(task)) {
1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
		/*
		 * 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);
1953
		xprt_conditional_disconnect(req->rq_xprt,
1954 1955 1956 1957 1958 1959 1960
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1961
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1962 1963 1964 1965 1966 1967
		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);
}
1968
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1969

L
Linus Torvalds 已提交
1970 1971 1972 1973 1974 1975 1976 1977 1978 1979
/*
 * 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;

1980 1981
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1982

1983
	dprint_status(task);
L
Linus Torvalds 已提交
1984 1985 1986 1987 1988 1989 1990

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

1991
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1992 1993
	task->tk_status = 0;
	switch(status) {
1994 1995 1996 1997 1998 1999 2000 2001
	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 已提交
2002 2003
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
2004 2005
		if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
		    && task->tk_client->cl_discrtry)
2006
			xprt_conditional_disconnect(req->rq_xprt,
2007
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
2008
		break;
2009
	case -ECONNRESET:
L
Linus Torvalds 已提交
2010
	case -ECONNREFUSED:
2011
		rpc_force_rebind(clnt);
2012 2013 2014
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
		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 已提交
2025 2026
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
2027
			       clnt->cl_program->name, -status);
L
Linus Torvalds 已提交
2028 2029 2030 2031 2032
		rpc_exit(task, status);
	}
}

/*
2033
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
2034 2035 2036 2037 2038 2039 2040 2041 2042
 * 	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) {
2043
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
2044 2045 2046
		goto retry;
	}

2047
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
2048 2049
	task->tk_timeouts++;

2050 2051 2052 2053
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
2054
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
2055
		if (clnt->cl_chatty) {
2056
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2057
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
2058
				clnt->cl_program->name,
2059 2060
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
J
Joe Perches 已提交
2061
		}
2062 2063 2064 2065
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
2066 2067 2068
		return;
	}

C
Chuck Lever 已提交
2069
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
2070
		task->tk_flags |= RPC_CALL_MAJORSEEN;
2071 2072
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2073
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
2074
			clnt->cl_program->name,
2075 2076 2077
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
2078
	}
2079
	rpc_force_rebind(clnt);
2080 2081 2082 2083 2084
	/*
	 * 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 已提交
2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098

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

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

2102
	dprint_status(task);
L
Linus Torvalds 已提交
2103

C
Chuck Lever 已提交
2104
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2105 2106
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2107
			printk(KERN_NOTICE "%s: server %s OK\n",
2108
				clnt->cl_program->name,
2109 2110 2111
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
2112 2113 2114
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

2115 2116
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
2117
	 * before it changed req->rq_reply_bytes_recvd.
2118 2119
	 */
	smp_rmb();
L
Linus Torvalds 已提交
2120 2121 2122 2123 2124 2125
	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);

2126 2127 2128 2129 2130 2131
	if (req->rq_rcv_buf.len < 12) {
		if (!RPC_IS_SOFT(task)) {
			task->tk_action = call_bind;
			goto out_retry;
		}
		dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
2132
				clnt->cl_program->name, task->tk_status);
2133 2134 2135 2136
		task->tk_action = call_timeout;
		goto out_retry;
	}

2137
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2138 2139 2140 2141
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2142 2143
	}

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

2146
	if (decode) {
L
Linus Torvalds 已提交
2147 2148
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
2149
	}
2150 2151
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
2152 2153 2154
	return;
out_retry:
	task->tk_status = 0;
2155
	/* Note: rpc_verify_header() may have freed the RPC slot */
2156
	if (task->tk_rqstp == req) {
2157
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2158
		if (task->tk_client->cl_discrtry)
2159
			xprt_conditional_disconnect(req->rq_xprt,
2160
					req->rq_connect_cookie);
2161
	}
L
Linus Torvalds 已提交
2162 2163
}

2164
static __be32 *
2165
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2166 2167 2168
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2169
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2170 2171

	/* FIXME: check buffer size? */
2172

2173
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2174 2175 2176 2177 2178 2179
	*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 */
2180 2181 2182
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2183 2184
}

2185
static __be32 *
2186
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2187
{
2188
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2189 2190
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2191 2192
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2193 2194
	int error = -EACCES;

2195 2196 2197 2198 2199 2200
	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
		 */
2201
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2202
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2203
		       task->tk_rqstp->rq_rcv_buf.len);
2204 2205
		error = -EIO;
		goto out_err;
2206
	}
L
Linus Torvalds 已提交
2207 2208 2209
	if ((len -= 3) < 0)
		goto out_overflow;

2210
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2211
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2212
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2213
			task->tk_pid, __func__, n);
2214
		error = -EIO;
T
Trond Myklebust 已提交
2215
		goto out_garbage;
L
Linus Torvalds 已提交
2216
	}
2217

L
Linus Torvalds 已提交
2218 2219 2220 2221
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
J
Joe Perches 已提交
2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232
		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);
2233 2234
			error = -EIO;
			goto out_err;
L
Linus Torvalds 已提交
2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
		}
		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--;
2246
			dprintk("RPC: %5u %s: retry stale creds\n",
2247
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2248
			rpcauth_invalcred(task);
2249 2250
			/* Ensure we obtain a new XID! */
			xprt_release(task);
2251
			task->tk_action = call_reserve;
T
Trond Myklebust 已提交
2252
			goto out_retry;
L
Linus Torvalds 已提交
2253 2254 2255 2256 2257 2258
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
2259
			dprintk("RPC: %5u %s: retry garbled creds\n",
2260
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2261
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
2262
			goto out_retry;
L
Linus Torvalds 已提交
2263
		case RPC_AUTH_TOOWEAK:
2264
			rcu_read_lock();
2265
			printk(KERN_NOTICE "RPC: server %s requires stronger "
2266 2267 2268
			       "authentication.\n",
			       rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
L
Linus Torvalds 已提交
2269 2270
			break;
		default:
2271
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
2272
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2273 2274
			error = -EIO;
		}
2275
		dprintk("RPC: %5u %s: call rejected %d\n",
2276
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2277 2278
		goto out_err;
	}
2279 2280 2281 2282 2283
	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 已提交
2284
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
2285
	}
2286
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
2287 2288 2289 2290 2291 2292
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
2293 2294 2295 2296
		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);
2297 2298
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2299
	case RPC_PROG_MISMATCH:
2300 2301 2302 2303 2304
		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);
2305 2306
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2307
	case RPC_PROC_UNAVAIL:
2308
		dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2309
				"version %u on server %s\n",
2310
				task->tk_pid, __func__,
2311
				rpc_proc_name(task),
2312 2313
				clnt->cl_prog, clnt->cl_vers,
				rcu_dereference(clnt->cl_xprt)->servername);
2314 2315
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
2316
	case RPC_GARBAGE_ARGS:
2317
		dprintk("RPC: %5u %s: server saw garbage\n",
2318
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2319 2320
		break;			/* retry */
	default:
2321
		dprintk("RPC: %5u %s: server accept status: %x\n",
2322
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2323 2324 2325
		/* Also retry */
	}

T
Trond Myklebust 已提交
2326
out_garbage:
2327
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2328 2329
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2330
		dprintk("RPC: %5u %s: retrying\n",
2331
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2332
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2333 2334
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2335 2336 2337
	}
out_err:
	rpc_exit(task, error);
2338
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2339
			__func__, error);
T
Trond Myklebust 已提交
2340
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2341
out_overflow:
2342
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2343
			__func__);
T
Trond Myklebust 已提交
2344
	goto out_garbage;
L
Linus Torvalds 已提交
2345
}
2346

2347
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2348 2349 2350
{
}

2351
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2352 2353 2354 2355 2356 2357 2358 2359 2360
{
	return 0;
}

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

2361
static int rpc_ping(struct rpc_clnt *clnt)
2362 2363 2364 2365 2366 2367
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2368
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2369 2370 2371
	put_rpccred(msg.rpc_cred);
	return err;
}
2372

2373 2374 2375 2376 2377 2378
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,
	};
2379 2380 2381 2382 2383 2384
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2385
	return rpc_run_task(&task_setup_data);
2386
}
2387
EXPORT_SYMBOL_GPL(rpc_call_null);
2388

2389
#ifdef RPC_DEBUG
2390 2391
static void rpc_show_header(void)
{
2392 2393
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2394 2395
}

C
Chuck Lever 已提交
2396 2397 2398 2399 2400 2401 2402 2403
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);

2404
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2405 2406
		task->tk_pid, task->tk_flags, task->tk_status,
		clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2407
		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2408
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2409 2410
}

2411
void rpc_show_tasks(struct net *net)
2412 2413
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2414
	struct rpc_task *task;
2415
	int header = 0;
2416
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2417

2418 2419
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2420
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2421
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2422 2423 2424 2425
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2426
			rpc_show_task(clnt, task);
2427 2428 2429
		}
		spin_unlock(&clnt->cl_lock);
	}
2430
	spin_unlock(&sn->rpc_client_lock);
2431 2432
}
#endif