clnt.c 69.1 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>
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

J
Jeff Layton 已提交
45
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
L
Linus Torvalds 已提交
46 47 48
# 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
{
	struct dentry *dentry;

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

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

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

236 237 238 239 240 241 242
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;

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

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

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

266 267 268 269 270 271 272
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);
273 274
	old = rcu_dereference_protected(clnt->cl_xprt,
			lockdep_is_held(&clnt->cl_lock));
275 276 277 278 279 280 281 282 283 284 285

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

286 287
static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
{
288 289
	clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
			nodename, sizeof(clnt->cl_nodename));
290 291
}

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

305
	rpc_clnt_debugfs_register(clnt);
306

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

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

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

337 338
static DEFINE_IDA(rpc_clids);

339 340 341 342 343
void rpc_cleanup_clids(void)
{
	ida_destroy(&rpc_clids);
}

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
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);
}

360
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
361
		struct rpc_xprt_switch *xps,
362 363
		struct rpc_xprt *xprt,
		struct rpc_clnt *parent)
L
Linus Torvalds 已提交
364
{
365 366
	const struct rpc_program *program = args->program;
	const struct rpc_version *version;
367 368
	struct rpc_clnt *clnt = NULL;
	const struct rpc_timeout *timeout;
369
	const char *nodename = args->nodename;
L
Linus Torvalds 已提交
370
	int err;
371 372

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

376 377 378
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
379

380
	err = -EINVAL;
381 382 383 384
	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
385 386 387
		goto out_err;

	err = -ENOMEM;
388
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
389 390
	if (!clnt)
		goto out_err;
391
	clnt->cl_parent = parent ? : clnt;
L
Linus Torvalds 已提交
392

393 394 395
	err = rpc_alloc_clid(clnt);
	if (err)
		goto out_no_clid;
L
Linus Torvalds 已提交
396 397 398

	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
399
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
400 401
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
402
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
403
	rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
404 405 406
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
407
	clnt->cl_program  = program;
408
	INIT_LIST_HEAD(&clnt->cl_tasks);
409
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
410

411
	timeout = xprt->timeout;
412 413 414
	if (args->timeout != NULL) {
		memcpy(&clnt->cl_timeout_default, args->timeout,
				sizeof(clnt->cl_timeout_default));
415
		timeout = &clnt->cl_timeout_default;
416 417
	}

418
	rpc_clnt_set_transport(clnt, xprt, timeout);
419 420
	xprt_iter_init(&clnt->cl_xpi, xps);
	xprt_switch_put(xps);
421

L
Linus Torvalds 已提交
422
	clnt->cl_rtt = &clnt->cl_rtt_default;
423
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
L
Linus Torvalds 已提交
424

425
	atomic_set(&clnt->cl_count, 1);
426

427 428
	if (nodename == NULL)
		nodename = utsname()->nodename;
L
Linus Torvalds 已提交
429
	/* save the nodename */
430
	rpc_clnt_set_nodename(clnt, nodename);
431

432
	err = rpc_client_register(clnt, args->authflavor, args->client_name);
433 434
	if (err)
		goto out_no_path;
435 436
	if (parent)
		atomic_inc(&parent->cl_count);
L
Linus Torvalds 已提交
437 438 439
	return clnt;

out_no_path:
440 441
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
442 443
	rpc_free_clid(clnt);
out_no_clid:
L
Linus Torvalds 已提交
444 445
	kfree(clnt);
out_err:
446 447
	rpciod_down();
out_no_rpciod:
448
	xprt_switch_put(xps);
449
	xprt_put(xprt);
L
Linus Torvalds 已提交
450 451 452
	return ERR_PTR(err);
}

453
static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
454 455 456
					struct rpc_xprt *xprt)
{
	struct rpc_clnt *clnt = NULL;
457
	struct rpc_xprt_switch *xps;
458

459
	if (args->bc_xprt && args->bc_xprt->xpt_bc_xps) {
460
		WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
461 462 463 464 465 466 467 468 469 470 471 472
		xps = args->bc_xprt->xpt_bc_xps;
		xprt_switch_get(xps);
	} else {
		xps = xprt_switch_alloc(xprt, GFP_KERNEL);
		if (xps == NULL) {
			xprt_put(xprt);
			return ERR_PTR(-ENOMEM);
		}
		if (xprt->bc_xprt) {
			xprt_switch_get(xps);
			xprt->bc_xprt->xpt_bc_xps = xps;
		}
473
	}
474
	clnt = rpc_new_client(args, xps, xprt, NULL);
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
		int err = rpc_ping(clnt);
		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;
492 493
	if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
		clnt->cl_noretranstimeo = 1;
494 495 496 497 498 499 500 501
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;

	return clnt;
}

502
/**
503 504 505 506 507 508 509 510 511 512 513 514
 * 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;
515
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
516
		.net = args->net,
517
		.ident = args->protocol,
518
		.srcaddr = args->saddress,
519 520
		.dstaddr = args->address,
		.addrlen = args->addrsize,
521
		.servername = args->servername,
522
		.bc_xprt = args->bc_xprt,
523
	};
524
	char servername[48];
525

526
	if (args->bc_xprt) {
527
		WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
528 529 530 531 532 533 534
		xprt = args->bc_xprt->xpt_bc_xprt;
		if (xprt) {
			xprt_get(xprt);
			return rpc_create_xprt(args, xprt);
		}
	}

535 536
	if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
		xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
537 538
	if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
		xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
539 540 541 542
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
543
	if (xprtargs.servername == NULL) {
544 545
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
546 547 548 549 550
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

551 552
		servername[0] = '\0';
		switch (args->address->sa_family) {
553 554 555 556
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
557
		case AF_INET:
H
Harvey Harrison 已提交
558 559
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
560
			break;
561
		case AF_INET6:
H
Harvey Harrison 已提交
562
			snprintf(servername, sizeof(servername), "%pI6",
563
				 &sin6->sin6_addr);
564 565 566 567 568 569
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
570
		xprtargs.servername = servername;
571 572
	}

573 574 575 576
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

577 578 579 580 581 582 583 584 585 586
	/*
	 * 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;

587
	return rpc_create_xprt(args, xprt);
588
}
589
EXPORT_SYMBOL_GPL(rpc_create);
590

L
Linus Torvalds 已提交
591 592 593 594 595
/*
 * 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 已提交
596 597
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
598
{
599
	struct rpc_xprt_switch *xps;
600
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
601 602
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
603

C
Chuck Lever 已提交
604
	err = -ENOMEM;
605 606
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
607
	xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
608
	rcu_read_unlock();
609 610 611
	if (xprt == NULL || xps == NULL) {
		xprt_put(xprt);
		xprt_switch_put(xps);
C
Chuck Lever 已提交
612
		goto out_err;
613
	}
C
Chuck Lever 已提交
614
	args->servername = xprt->servername;
615
	args->nodename = clnt->cl_nodename;
C
Chuck Lever 已提交
616

617
	new = rpc_new_client(args, xps, xprt, clnt);
C
Chuck Lever 已提交
618 619
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
620
		goto out_err;
C
Chuck Lever 已提交
621 622 623 624 625
	}

	/* Turn off autobind on clones */
	new->cl_autobind = 0;
	new->cl_softrtry = clnt->cl_softrtry;
626
	new->cl_noretranstimeo = clnt->cl_noretranstimeo;
C
Chuck Lever 已提交
627 628
	new->cl_discrtry = clnt->cl_discrtry;
	new->cl_chatty = clnt->cl_chatty;
L
Linus Torvalds 已提交
629
	return new;
C
Chuck Lever 已提交
630 631

out_err:
632
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
633
	return ERR_PTR(err);
L
Linus Torvalds 已提交
634
}
C
Chuck Lever 已提交
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652

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

655 656 657 658
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
659
 * @flavor: security flavor for new client
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
 *
 * 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);

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;
697
	struct rpc_xprt_switch *xps, *oldxps;
698 699 700 701 702 703 704 705 706 707 708
	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);
	}

709 710 711 712 713 714
	xps = xprt_switch_alloc(xprt, GFP_KERNEL);
	if (xps == NULL) {
		xprt_put(xprt);
		return -ENOMEM;
	}

715 716 717 718
	pseudoflavor = clnt->cl_auth->au_flavor;

	old_timeo = clnt->cl_timeout;
	old = rpc_clnt_set_transport(clnt, xprt, timeout);
719
	oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
720 721 722

	rpc_unregister_client(clnt);
	__rpc_clnt_remove_pipedir(clnt);
723
	rpc_clnt_debugfs_unregister(clnt);
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

	/*
	 * 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);
745
	xprt_switch_put(oldxps);
746 747 748 749 750
	xprt_put(old);
	dprintk("RPC:       replaced xprt for clnt %p\n", clnt);
	return 0;

out_revert:
751
	xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
752 753 754
	rpc_clnt_set_transport(clnt, old, old_timeo);
	clnt->cl_parent = parent;
	rpc_client_register(clnt, pseudoflavor, NULL);
755
	xprt_switch_put(xps);
756 757 758 759 760 761
	xprt_put(xprt);
	dprintk("RPC:       failed to switch xprt for clnt %p\n", clnt);
	return err;
}
EXPORT_SYMBOL_GPL(rpc_switch_client_transport);

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
static
int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
{
	struct rpc_xprt_switch *xps;

	rcu_read_lock();
	xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
	rcu_read_unlock();
	if (xps == NULL)
		return -EAGAIN;
	xprt_iter_init_listall(xpi, xps);
	xprt_switch_put(xps);
	return 0;
}

/**
 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
 * @clnt: pointer to client
 * @fn: function to apply
 * @data: void pointer to function data
 *
 * Iterates through the list of RPC transports currently attached to the
 * client and applies the function fn(clnt, xprt, data).
 *
 * On error, the iteration stops, and the function returns the error value.
 */
int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
		int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
		void *data)
{
	struct rpc_xprt_iter xpi;
	int ret;

	ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
	if (ret)
		return ret;
	for (;;) {
		struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);

		if (!xprt)
			break;
		ret = fn(clnt, xprt, data);
		xprt_put(xprt);
		if (ret < 0)
			break;
	}
	xprt_iter_destroy(&xpi);
	return ret;
}
EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);

813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
/*
 * 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);
835 836 837
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
838 839 840 841 842 843
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
844 845
/*
 * Properly shut down an RPC client, terminating all outstanding
846
 * requests.
L
Linus Torvalds 已提交
847
 */
848
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
849
{
850 851
	might_sleep();

852
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
853
			clnt->cl_program->name,
854
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
855

856
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
857
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
858
		wait_event_timeout(destroy_wait,
859
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
860 861
	}

862
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
863
}
864
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
865 866

/*
867
 * Free an RPC client
L
Linus Torvalds 已提交
868
 */
869
static struct rpc_clnt *
870
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
871
{
872 873
	struct rpc_clnt *parent = NULL;

874
	dprintk_rcu("RPC:       destroying %s client for %s\n",
875
			clnt->cl_program->name,
876
			rcu_dereference(clnt->cl_xprt)->servername);
877
	if (clnt->cl_parent != clnt)
878
		parent = clnt->cl_parent;
879
	rpc_clnt_debugfs_unregister(clnt);
880
	rpc_clnt_remove_pipedir(clnt);
881
	rpc_unregister_client(clnt);
882 883
	rpc_free_iostats(clnt->cl_metrics);
	clnt->cl_metrics = NULL;
884
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
885
	xprt_iter_destroy(&clnt->cl_xpi);
886
	rpciod_down();
887
	rpc_free_clid(clnt);
L
Linus Torvalds 已提交
888
	kfree(clnt);
889
	return parent;
L
Linus Torvalds 已提交
890 891
}

892 893 894
/*
 * Free an RPC client
 */
895
static struct rpc_clnt * 
896
rpc_free_auth(struct rpc_clnt *clnt)
897
{
898 899
	if (clnt->cl_auth == NULL)
		return rpc_free_client(clnt);
900 901 902 903 904 905

	/*
	 * 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.
	 */
906
	atomic_inc(&clnt->cl_count);
907 908
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
909
	if (atomic_dec_and_test(&clnt->cl_count))
910 911
		return rpc_free_client(clnt);
	return NULL;
912 913
}

L
Linus Torvalds 已提交
914
/*
915
 * Release reference to the RPC client
L
Linus Torvalds 已提交
916 917 918 919
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
920
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
921

922 923 924 925 926 927 928
	do {
		if (list_empty(&clnt->cl_tasks))
			wake_up(&destroy_wait);
		if (!atomic_dec_and_test(&clnt->cl_count))
			break;
		clnt = rpc_free_auth(clnt);
	} while (clnt != NULL);
929
}
930
EXPORT_SYMBOL_GPL(rpc_release_client);
931

932 933
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
934 935 936
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
937 938 939 940 941 942
 *
 * 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,
943
				      const struct rpc_program *program,
944
				      u32 vers)
945
{
946 947 948 949 950 951
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
	};
952 953 954
	struct rpc_clnt *clnt;
	int err;

955
	clnt = __rpc_clone_client(&args, old);
956 957
	if (IS_ERR(clnt))
		goto out;
958
	err = rpc_ping(clnt);
959 960 961 962
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
963
out:
964 965
	return clnt;
}
966
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
967

968 969 970 971 972 973 974 975 976 977 978
void rpc_task_release_transport(struct rpc_task *task)
{
	struct rpc_xprt *xprt = task->tk_xprt;

	if (xprt) {
		task->tk_xprt = NULL;
		xprt_put(xprt);
	}
}
EXPORT_SYMBOL_GPL(rpc_task_release_transport);

979 980 981 982 983 984 985 986 987 988 989 990 991
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);
	}
992 993
	rpc_task_release_transport(task);
}
994

995 996 997 998 999
static
void rpc_task_set_transport(struct rpc_task *task, struct rpc_clnt *clnt)
{
	if (!task->tk_xprt)
		task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
1000 1001 1002 1003 1004
}

static
void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
{
1005

1006
	if (clnt != NULL) {
1007
		rpc_task_set_transport(task, clnt);
1008
		task->tk_client = clnt;
1009
		atomic_inc(&clnt->cl_count);
1010 1011
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
1012 1013
		if (clnt->cl_noretranstimeo)
			task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
1014 1015
		if (atomic_read(&clnt->cl_swapper))
			task->tk_flags |= RPC_TASK_SWAPPER;
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
		/* 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);
	}
}

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;
1030 1031
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
1032 1033 1034
	}
}

L
Linus Torvalds 已提交
1035 1036 1037 1038
/*
 * Default callback for async RPC calls
 */
static void
1039
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
1040 1041 1042
{
}

1043 1044 1045 1046
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
1047 1048 1049 1050 1051
/**
 * 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)
1052
{
1053
	struct rpc_task *task;
1054

1055
	task = rpc_new_task(task_setup_data);
1056

1057 1058 1059 1060 1061 1062
	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);

1063 1064
	atomic_inc(&task->tk_count);
	rpc_execute(task);
1065
	return task;
1066
}
T
Trond Myklebust 已提交
1067
EXPORT_SYMBOL_GPL(rpc_run_task);
1068 1069 1070 1071 1072 1073

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
1074
 */
1075
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
1076 1077
{
	struct rpc_task	*task;
1078 1079 1080 1081 1082 1083
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
1084
	int status;
L
Linus Torvalds 已提交
1085

1086 1087 1088 1089 1090 1091
	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 已提交
1092

T
Trond Myklebust 已提交
1093
	task = rpc_run_task(&task_setup_data);
1094 1095
	if (IS_ERR(task))
		return PTR_ERR(task);
1096
	status = task->tk_status;
1097
	rpc_put_task(task);
L
Linus Torvalds 已提交
1098 1099
	return status;
}
1100
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
1101

1102 1103 1104 1105 1106
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
1107
 * @tk_ops: RPC call ops
1108
 * @data: user call data
L
Linus Torvalds 已提交
1109 1110
 */
int
1111
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
1112
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
1113 1114
{
	struct rpc_task	*task;
1115 1116 1117 1118 1119 1120 1121
	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 已提交
1122

T
Trond Myklebust 已提交
1123
	task = rpc_run_task(&task_setup_data);
1124 1125 1126 1127
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
1128
}
1129
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
1130

1131
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1132 1133 1134
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
1135
 * @req: RPC request
1136
 */
1137
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
1138 1139 1140 1141
{
	struct rpc_task *task;
	struct xdr_buf *xbufp = &req->rq_snd_buf;
	struct rpc_task_setup task_setup_data = {
1142
		.callback_ops = &rpc_default_ops,
1143
		.flags = RPC_TASK_SOFTCONN,
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
	};

	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);
	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);
1162
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
1163 1164 1165 1166 1167
	rpc_execute(task);

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

1170 1171 1172 1173 1174 1175 1176
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

1177 1178 1179 1180
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
1181
 * @bufsize: length of target buffer
1182 1183 1184 1185 1186 1187
 *
 * 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;
1188 1189 1190 1191
	struct rpc_xprt *xprt;

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

1193
	bytes = xprt->addrlen;
1194 1195
	if (bytes > bufsize)
		bytes = bufsize;
1196 1197 1198 1199
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
1200
}
1201
EXPORT_SYMBOL_GPL(rpc_peeraddr);
1202

1203 1204 1205 1206 1207
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
1208 1209 1210
 * 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.
1211
 */
1212 1213
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
1214
{
1215 1216 1217
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
1218 1219 1220 1221 1222

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
1223
}
1224
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1225

1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
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,
1245
			struct sockaddr *buf)
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
{
	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;
	}

1283
	err = kernel_getsockname(sock, buf);
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
	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));
1324
		break;
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
	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);
1367
	err = rpc_sockname(net, sap, salen, buf);
1368 1369 1370 1371 1372 1373 1374 1375
	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 已提交
1376 1377 1378
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1379 1380 1381 1382
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1383 1384
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1385
	rcu_read_unlock();
L
Linus Torvalds 已提交
1386
}
1387
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
1388

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
/**
 * 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 已提交
1408 1409 1410 1411 1412 1413 1414 1415
 *
 * 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)
{
1416 1417 1418 1419 1420 1421
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1422
}
1423
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1424

1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
/**
 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
 * @clnt: RPC client to query
 */
size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
{
	struct rpc_xprt *xprt;
	size_t ret;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
	ret = xprt->ops->bc_maxpayload(xprt);
	rcu_read_unlock();
	return ret;
}
EXPORT_SYMBOL_GPL(rpc_max_bc_payload);

1442 1443 1444 1445 1446 1447 1448
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1449 1450 1451 1452 1453
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1454
}
1455
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1456

1457 1458 1459 1460
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1461
int
1462 1463 1464
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1465
		return 0;
1466
	task->tk_action = call_start;
1467
	task->tk_status = 0;
1468 1469
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1470
	return 1;
1471 1472 1473
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1474 1475 1476 1477
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1478
int
L
Linus Torvalds 已提交
1479 1480 1481
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1482
		return 0;
L
Linus Torvalds 已提交
1483
	task->tk_action = call_start;
1484
	task->tk_status = 0;
1485
	return 1;
L
Linus Torvalds 已提交
1486
}
1487
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1488

1489 1490
const char
*rpc_proc_name(const struct rpc_task *task)
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
{
	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";
}

L
Linus Torvalds 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
/*
 * 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;
1513
	int idx = task->tk_msg.rpc_proc->p_statidx;
L
Linus Torvalds 已提交
1514

1515
	trace_rpc_request(task);
1516
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1517
			clnt->cl_program->name, clnt->cl_vers,
1518
			rpc_proc_name(task),
1519
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1520

1521 1522 1523
	/* Increment call count (version might not be valid for ping) */
	if (clnt->cl_program->version[clnt->cl_vers])
		clnt->cl_program->version[clnt->cl_vers]->counts[idx]++;
L
Linus Torvalds 已提交
1524 1525
	clnt->cl_stats->rpccnt++;
	task->tk_action = call_reserve;
1526
	rpc_task_set_transport(task, clnt);
L
Linus Torvalds 已提交
1527 1528 1529 1530 1531 1532 1533 1534
}

/*
 * 1.	Reserve an RPC call slot
 */
static void
call_reserve(struct rpc_task *task)
{
1535
	dprint_status(task);
L
Linus Torvalds 已提交
1536 1537 1538 1539 1540 1541

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

1542 1543
static void call_retry_reserve(struct rpc_task *task);

L
Linus Torvalds 已提交
1544 1545 1546 1547 1548 1549 1550 1551
/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1552
	dprint_status(task);
L
Linus Torvalds 已提交
1553 1554 1555 1556 1557 1558 1559 1560

	/*
	 * 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) {
1561
			xprt_request_init(task);
1562
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1563 1564 1565 1566
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1567
				__func__, status);
L
Linus Torvalds 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
		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",
1578
				__func__, status);
L
Linus Torvalds 已提交
1579 1580 1581 1582
		xprt_release(task);
	}

	switch (status) {
1583 1584
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
1585
		/* fall through */
L
Linus Torvalds 已提交
1586
	case -EAGAIN:	/* woken up; retry */
1587
		task->tk_action = call_retry_reserve;
L
Linus Torvalds 已提交
1588 1589 1590 1591 1592
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1593
				__func__, status);
L
Linus Torvalds 已提交
1594 1595 1596 1597 1598
		break;
	}
	rpc_exit(task, status);
}

1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
/*
 * 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 已提交
1612
/*
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
 * 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;
1637
	task->tk_action = call_refresh;
1638
	switch (status) {
1639
	case 0:
1640
		if (rpcauth_uptodatecred(task)) {
1641
			task->tk_action = call_allocate;
1642 1643 1644 1645 1646
			return;
		}
		/* Use rate-limiting and a max number of retries if refresh
		 * had status 0 but failed to update the cred.
		 */
1647
		/* fall through */
1648 1649
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1650
		/* fall through */
1651 1652
	case -EAGAIN:
		status = -EACCES;
1653
		/* fall through */
1654
	case -EKEYEXPIRED:
1655 1656 1657 1658 1659 1660
		if (!task->tk_cred_retry)
			break;
		task->tk_cred_retry--;
		dprintk("RPC: %5u %s: retry refresh creds\n",
				task->tk_pid, __func__);
		return;
1661
	}
1662 1663 1664
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1665 1666 1667 1668
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1669
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1670 1671 1672 1673
 */
static void
call_allocate(struct rpc_task *task)
{
1674
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1675
	struct rpc_rqst *req = task->tk_rqstp;
1676
	struct rpc_xprt *xprt = req->rq_xprt;
1677
	const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1678
	int status;
L
Linus Torvalds 已提交
1679

1680 1681
	dprint_status(task);

1682
	task->tk_status = 0;
1683
	task->tk_action = call_bind;
1684

1685
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1686 1687
		return;

1688 1689 1690 1691 1692
	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 已提交
1693

1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
	/*
	 * 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;

1704
	status = xprt->ops->buf_alloc(task);
C
Chuck Lever 已提交
1705
	xprt_inject_disconnect(xprt);
1706 1707 1708 1709 1710 1711
	if (status == 0)
		return;
	if (status != -ENOMEM) {
		rpc_exit(task, status);
		return;
	}
1712 1713

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

1715
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1716
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1717 1718 1719 1720 1721 1722 1723
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
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;
1734
	task->tk_rqstp->rq_bytes_sent = 0;
1735 1736
}

L
Linus Torvalds 已提交
1737 1738 1739 1740
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1741
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1742 1743
{
	struct rpc_rqst	*req = task->tk_rqstp;
1744
	kxdreproc_t	encode;
1745
	__be32		*p;
L
Linus Torvalds 已提交
1746

1747
	dprint_status(task);
L
Linus Torvalds 已提交
1748

1749 1750 1751 1752
	xdr_buf_init(&req->rq_snd_buf,
		     req->rq_buffer,
		     req->rq_callsize);
	xdr_buf_init(&req->rq_rcv_buf,
1753
		     req->rq_rbuffer,
1754
		     req->rq_rcvsize);
L
Linus Torvalds 已提交
1755

1756 1757 1758
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1759 1760 1761
		rpc_exit(task, -EIO);
		return;
	}
1762 1763

	encode = task->tk_msg.rpc_proc->p_encode;
1764 1765 1766 1767 1768
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1769 1770 1771 1772 1773 1774 1775 1776
}

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

1779
	dprint_status(task);
L
Linus Torvalds 已提交
1780

1781
	task->tk_action = call_connect;
1782
	if (!xprt_bound(xprt)) {
1783
		task->tk_action = call_bind_status;
1784
		task->tk_timeout = xprt->bind_timeout;
1785
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1786 1787 1788 1789
	}
}

/*
1790 1791 1792 1793 1794
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1795
	int status = -EIO;
1796 1797

	if (task->tk_status >= 0) {
1798
		dprint_status(task);
1799 1800 1801 1802 1803
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1804
	trace_rpc_bind_status(task);
1805
	switch (task->tk_status) {
1806 1807 1808
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1809
		goto retry_timeout;
1810
	case -EACCES:
1811 1812
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1813 1814 1815 1816 1817
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1818 1819 1820
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1821
		rpc_delay(task, 3*HZ);
1822
		goto retry_timeout;
1823
	case -ETIMEDOUT:
1824
		dprintk("RPC: %5u rpcbind request timed out\n",
1825
				task->tk_pid);
1826
		goto retry_timeout;
1827
	case -EPFNOSUPPORT:
1828
		/* server doesn't support any rpcbind version we know of */
1829
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1830 1831 1832
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1833
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1834
				task->tk_pid);
1835
		goto retry_timeout;
1836 1837
	case -ECONNREFUSED:		/* connection problems */
	case -ECONNRESET:
1838
	case -ECONNABORTED:
1839 1840
	case -ENOTCONN:
	case -EHOSTDOWN:
T
Trond Myklebust 已提交
1841
	case -ENETDOWN:
1842 1843
	case -EHOSTUNREACH:
	case -ENETUNREACH:
1844
	case -ENOBUFS:
1845 1846 1847 1848 1849 1850 1851 1852 1853
	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;
1854
	default:
1855
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1856 1857 1858 1859 1860 1861
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1862
retry_timeout:
1863
	task->tk_status = 0;
1864
	task->tk_action = call_timeout;
1865 1866 1867 1868
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1869 1870 1871 1872
 */
static void
call_connect(struct rpc_task *task)
{
1873
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1874

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

1879 1880 1881 1882 1883
	task->tk_action = call_transmit;
	if (!xprt_connected(xprt)) {
		task->tk_action = call_connect_status;
		if (task->tk_status < 0)
			return;
1884 1885 1886 1887
		if (task->tk_flags & RPC_TASK_NOCONNECT) {
			rpc_exit(task, -ENOTCONN);
			return;
		}
1888
		xprt_connect(task);
L
Linus Torvalds 已提交
1889 1890 1891 1892
	}
}

/*
1893
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1894 1895 1896 1897 1898 1899 1900
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1901
	dprint_status(task);
1902

1903
	trace_rpc_connect_status(task);
1904
	task->tk_status = 0;
L
Linus Torvalds 已提交
1905
	switch (status) {
1906
	case -ECONNREFUSED:
1907 1908 1909 1910 1911 1912 1913 1914
		/* A positive refusal suggests a rebind is needed. */
		if (RPC_IS_SOFTCONN(task))
			break;
		if (clnt->cl_autobind) {
			rpc_force_rebind(clnt);
			task->tk_action = call_bind;
			return;
		}
1915
		/* fall through */
1916
	case -ECONNRESET:
1917
	case -ECONNABORTED:
T
Trond Myklebust 已提交
1918
	case -ENETDOWN:
1919
	case -ENETUNREACH:
1920
	case -EHOSTUNREACH:
1921
	case -EADDRINUSE:
1922
	case -ENOBUFS:
1923
	case -EPIPE:
1924 1925
		xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
					    task->tk_rqstp->rq_connect_cookie);
1926 1927
		if (RPC_IS_SOFTCONN(task))
			break;
1928 1929
		/* retry with existing socket, after a delay */
		rpc_delay(task, 3*HZ);
1930
		/* fall through */
1931
	case -EAGAIN:
1932 1933 1934
		/* Check for timeouts before looping back to call_bind */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1935 1936
		return;
	case 0:
1937 1938 1939
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
L
Linus Torvalds 已提交
1940
	}
1941
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1942 1943 1944 1945 1946 1947 1948 1949
}

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

1952
	dprint_status(task);
L
Linus Torvalds 已提交
1953 1954 1955 1956

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
1957
	if (!xprt_prepare_transmit(task))
L
Linus Torvalds 已提交
1958
		return;
1959
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1960
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1961
	if (rpc_task_need_encode(task)) {
1962
		rpc_xdr_encode(task);
1963
		/* Did the encode result in an error condition? */
1964 1965 1966 1967 1968 1969
		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);
1970
			return;
1971
		}
1972
	}
L
Linus Torvalds 已提交
1973 1974 1975
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1976 1977
	if (is_retrans)
		task->tk_client->cl_stats->rpcretrans++;
1978 1979 1980 1981 1982
	/*
	 * 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);
1983
	if (rpc_reply_expected(task))
1984 1985
		return;
	task->tk_action = rpc_exit_task;
1986
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1987 1988 1989 1990 1991 1992 1993 1994 1995
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006

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

2007 2008
	switch (task->tk_status) {
	case -EAGAIN:
2009
	case -ENOBUFS:
2010 2011
		break;
	default:
2012
		dprint_status(task);
2013
		xprt_end_transmit(task);
2014 2015
		rpc_task_force_reencode(task);
		break;
2016 2017 2018 2019 2020 2021 2022 2023
		/*
		 * 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:
T
Trond Myklebust 已提交
2024
	case -ENETDOWN:
2025 2026
	case -EHOSTUNREACH:
	case -ENETUNREACH:
2027
	case -EPERM:
2028 2029
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
2030 2031 2032
			if (!task->tk_msg.rpc_proc->p_proc)
				trace_xprt_ping(task->tk_xprt,
						task->tk_status);
2033 2034 2035
			rpc_exit(task, task->tk_status);
			break;
		}
2036
		/* fall through */
2037
	case -ECONNRESET:
2038
	case -ECONNABORTED:
2039
	case -EADDRINUSE:
2040
	case -ENOTCONN:
2041
	case -EPIPE:
2042 2043
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
2044 2045
}

2046
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
2047 2048 2049 2050 2051 2052 2053 2054 2055
/*
 * 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;

2056 2057
	if (!xprt_prepare_transmit(task))
		goto out_retry;
2058 2059 2060 2061

	if (task->tk_status < 0) {
		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
			"error: %d\n", task->tk_status);
2062
		goto out_done;
2063
	}
2064 2065
	if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
		req->rq_bytes_sent = 0;
2066 2067

	xprt_transmit(task);
2068 2069 2070 2071

	if (task->tk_status == -EAGAIN)
		goto out_nospace;

2072 2073 2074 2075 2076
	xprt_end_transmit(task);
	dprint_status(task);
	switch (task->tk_status) {
	case 0:
		/* Success */
T
Trond Myklebust 已提交
2077
	case -ENETDOWN:
2078 2079 2080
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
2081 2082 2083 2084 2085 2086
	case -ECONNRESET:
	case -ECONNREFUSED:
	case -EADDRINUSE:
	case -ENOTCONN:
	case -EPIPE:
		break;
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096
	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);
2097
		xprt_conditional_disconnect(req->rq_xprt,
2098 2099 2100 2101 2102 2103 2104
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
2105
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
2106 2107 2108 2109 2110
		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);
2111 2112 2113 2114 2115 2116 2117
out_done:
	task->tk_action = rpc_exit_task;
	return;
out_nospace:
	req->rq_connect_cookie = req->rq_xprt->connect_cookie;
out_retry:
	task->tk_status = 0;
2118
}
2119
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
2120

L
Linus Torvalds 已提交
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
/*
 * 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;

2131 2132 2133
	if (!task->tk_msg.rpc_proc->p_proc)
		trace_xprt_ping(task->tk_xprt, task->tk_status);

2134 2135
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
2136

2137
	dprint_status(task);
L
Linus Torvalds 已提交
2138 2139 2140 2141 2142 2143 2144

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

2145
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
2146 2147
	task->tk_status = 0;
	switch(status) {
2148
	case -EHOSTDOWN:
T
Trond Myklebust 已提交
2149
	case -ENETDOWN:
2150 2151
	case -EHOSTUNREACH:
	case -ENETUNREACH:
2152
	case -EPERM:
2153 2154 2155 2156
		if (RPC_IS_SOFTCONN(task)) {
			rpc_exit(task, status);
			break;
		}
2157 2158 2159 2160 2161
		/*
		 * Delay any retries for 3 seconds, then handle as if it
		 * were a timeout.
		 */
		rpc_delay(task, 3*HZ);
2162
		/* fall through */
L
Linus Torvalds 已提交
2163 2164 2165 2166
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
		break;
	case -ECONNREFUSED:
2167 2168
	case -ECONNRESET:
	case -ECONNABORTED:
2169
		rpc_force_rebind(clnt);
2170
		/* fall through */
2171
	case -EADDRINUSE:
2172
		rpc_delay(task, 3*HZ);
2173
		/* fall through */
2174 2175
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
2176 2177
		task->tk_action = call_bind;
		break;
2178 2179
	case -ENOBUFS:
		rpc_delay(task, HZ>>2);
2180
		/* fall through */
L
Linus Torvalds 已提交
2181 2182 2183 2184 2185 2186 2187 2188
	case -EAGAIN:
		task->tk_action = call_transmit;
		break;
	case -EIO:
		/* shutdown or soft timeout */
		rpc_exit(task, status);
		break;
	default:
O
Olga Kornievskaia 已提交
2189 2190
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
2191
			       clnt->cl_program->name, -status);
L
Linus Torvalds 已提交
2192 2193 2194 2195 2196
		rpc_exit(task, status);
	}
}

/*
2197
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
2198 2199 2200 2201 2202 2203 2204 2205 2206
 * 	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) {
2207
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
2208 2209 2210
		goto retry;
	}

2211
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
2212 2213
	task->tk_timeouts++;

2214 2215 2216 2217
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
2218
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
2219
		if (clnt->cl_chatty) {
O
Olga Kornievskaia 已提交
2220
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
2221
				clnt->cl_program->name,
2222
				task->tk_xprt->servername);
J
Joe Perches 已提交
2223
		}
2224 2225 2226 2227
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
2228 2229 2230
		return;
	}

C
Chuck Lever 已提交
2231
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
2232
		task->tk_flags |= RPC_CALL_MAJORSEEN;
2233
		if (clnt->cl_chatty) {
O
Olga Kornievskaia 已提交
2234
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
2235
			clnt->cl_program->name,
2236
			task->tk_xprt->servername);
2237
		}
L
Linus Torvalds 已提交
2238
	}
2239
	rpc_force_rebind(clnt);
2240 2241 2242 2243 2244
	/*
	 * 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 已提交
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258

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

2262
	dprint_status(task);
L
Linus Torvalds 已提交
2263

C
Chuck Lever 已提交
2264
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2265
		if (clnt->cl_chatty) {
O
Olga Kornievskaia 已提交
2266
			printk(KERN_NOTICE "%s: server %s OK\n",
2267
				clnt->cl_program->name,
2268
				task->tk_xprt->servername);
2269
		}
L
Linus Torvalds 已提交
2270 2271 2272
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

2273 2274
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
2275
	 * before it changed req->rq_reply_bytes_recvd.
2276 2277
	 */
	smp_rmb();
L
Linus Torvalds 已提交
2278 2279 2280 2281 2282 2283
	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);

2284 2285 2286 2287 2288 2289
	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",
2290
				clnt->cl_program->name, task->tk_status);
2291 2292 2293 2294
		task->tk_action = call_timeout;
		goto out_retry;
	}

2295
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2296 2297 2298 2299
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2300 2301
	}

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

2304
	if (decode) {
L
Linus Torvalds 已提交
2305 2306
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
2307
	}
2308 2309
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
2310 2311 2312
	return;
out_retry:
	task->tk_status = 0;
2313
	/* Note: rpc_verify_header() may have freed the RPC slot */
2314
	if (task->tk_rqstp == req) {
2315
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2316
		if (task->tk_client->cl_discrtry)
2317
			xprt_conditional_disconnect(req->rq_xprt,
2318
					req->rq_connect_cookie);
2319
	}
L
Linus Torvalds 已提交
2320 2321
}

2322
static __be32 *
2323
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2324 2325 2326
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2327
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2328 2329

	/* FIXME: check buffer size? */
2330

2331
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2332 2333 2334 2335 2336 2337
	*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 */
2338 2339 2340
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2341 2342
}

2343
static __be32 *
2344
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2345
{
2346
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2347 2348
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2349 2350
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2351 2352
	int error = -EACCES;

2353 2354 2355 2356 2357 2358
	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
		 */
2359
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2360
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2361
		       task->tk_rqstp->rq_rcv_buf.len);
2362 2363
		error = -EIO;
		goto out_err;
2364
	}
L
Linus Torvalds 已提交
2365 2366 2367
	if ((len -= 3) < 0)
		goto out_overflow;

2368
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2369
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2370
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2371
			task->tk_pid, __func__, n);
2372
		error = -EIO;
T
Trond Myklebust 已提交
2373
		goto out_garbage;
L
Linus Torvalds 已提交
2374
	}
2375

L
Linus Torvalds 已提交
2376 2377 2378 2379
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
J
Joe Perches 已提交
2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
		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);
2391 2392
			error = -EIO;
			goto out_err;
L
Linus Torvalds 已提交
2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403
		}
		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--;
2404
			dprintk("RPC: %5u %s: retry stale creds\n",
2405
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2406
			rpcauth_invalcred(task);
2407 2408
			/* Ensure we obtain a new XID! */
			xprt_release(task);
2409
			task->tk_action = call_reserve;
T
Trond Myklebust 已提交
2410
			goto out_retry;
L
Linus Torvalds 已提交
2411 2412 2413 2414 2415 2416
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
2417
			dprintk("RPC: %5u %s: retry garbled creds\n",
2418
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2419
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
2420
			goto out_retry;
L
Linus Torvalds 已提交
2421
		case RPC_AUTH_TOOWEAK:
2422
			printk(KERN_NOTICE "RPC: server %s requires stronger "
2423
			       "authentication.\n",
2424
			       task->tk_xprt->servername);
L
Linus Torvalds 已提交
2425 2426
			break;
		default:
2427
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
2428
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2429 2430
			error = -EIO;
		}
2431
		dprintk("RPC: %5u %s: call rejected %d\n",
2432
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2433 2434
		goto out_err;
	}
2435 2436 2437 2438 2439
	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 已提交
2440
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
2441
	}
2442
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
2443 2444 2445 2446 2447 2448
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
2449
		dprintk("RPC: %5u %s: program %u is unsupported "
2450 2451
				"by server %s\n", task->tk_pid, __func__,
				(unsigned int)clnt->cl_prog,
2452
				task->tk_xprt->servername);
2453 2454
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2455
	case RPC_PROG_MISMATCH:
2456
		dprintk("RPC: %5u %s: program %u, version %u unsupported "
2457 2458 2459
				"by server %s\n", task->tk_pid, __func__,
				(unsigned int)clnt->cl_prog,
				(unsigned int)clnt->cl_vers,
2460
				task->tk_xprt->servername);
2461 2462
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2463
	case RPC_PROC_UNAVAIL:
2464
		dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
2465
				"version %u on server %s\n",
2466
				task->tk_pid, __func__,
2467
				rpc_proc_name(task),
2468
				clnt->cl_prog, clnt->cl_vers,
2469
				task->tk_xprt->servername);
2470 2471
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
2472
	case RPC_GARBAGE_ARGS:
2473
		dprintk("RPC: %5u %s: server saw garbage\n",
2474
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2475 2476
		break;			/* retry */
	default:
2477
		dprintk("RPC: %5u %s: server accept status: %x\n",
2478
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2479 2480 2481
		/* Also retry */
	}

T
Trond Myklebust 已提交
2482
out_garbage:
2483
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2484 2485
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2486
		dprintk("RPC: %5u %s: retrying\n",
2487
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2488
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2489 2490
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2491 2492 2493
	}
out_err:
	rpc_exit(task, error);
2494
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2495
			__func__, error);
T
Trond Myklebust 已提交
2496
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2497
out_overflow:
2498
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2499
			__func__);
T
Trond Myklebust 已提交
2500
	goto out_garbage;
L
Linus Torvalds 已提交
2501
}
2502

2503 2504
static void rpcproc_encode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
		const void *obj)
2505 2506 2507
{
}

2508 2509
static int rpcproc_decode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
		void *obj)
2510 2511 2512 2513
{
	return 0;
}

2514
static const struct rpc_procinfo rpcproc_null = {
2515 2516 2517 2518
	.p_encode = rpcproc_encode_null,
	.p_decode = rpcproc_decode_null,
};

2519
static int rpc_ping(struct rpc_clnt *clnt)
2520 2521 2522 2523 2524 2525
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2526
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2527 2528 2529
	put_rpccred(msg.rpc_cred);
	return err;
}
2530

2531 2532 2533 2534
static
struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
		struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
		const struct rpc_call_ops *ops, void *data)
2535 2536 2537 2538 2539
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
		.rpc_cred = cred,
	};
2540 2541
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
2542
		.rpc_xprt = xprt,
2543
		.rpc_message = &msg,
2544 2545
		.callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
		.callback_data = data,
2546 2547
		.flags = flags,
	};
2548

T
Trond Myklebust 已提交
2549
	return rpc_run_task(&task_setup_data);
2550
}
2551 2552 2553 2554 2555

struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
{
	return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
}
2556
EXPORT_SYMBOL_GPL(rpc_call_null);
2557

2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
struct rpc_cb_add_xprt_calldata {
	struct rpc_xprt_switch *xps;
	struct rpc_xprt *xprt;
};

static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
{
	struct rpc_cb_add_xprt_calldata *data = calldata;

	if (task->tk_status == 0)
		rpc_xprt_switch_add_xprt(data->xps, data->xprt);
}

static void rpc_cb_add_xprt_release(void *calldata)
{
	struct rpc_cb_add_xprt_calldata *data = calldata;

	xprt_put(data->xprt);
	xprt_switch_put(data->xps);
	kfree(data);
}

2580
static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
	.rpc_call_done = rpc_cb_add_xprt_done,
	.rpc_release = rpc_cb_add_xprt_release,
};

/**
 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
 * @clnt: pointer to struct rpc_clnt
 * @xps: pointer to struct rpc_xprt_switch,
 * @xprt: pointer struct rpc_xprt
 * @dummy: unused
 */
int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
		struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
		void *dummy)
{
	struct rpc_cb_add_xprt_calldata *data;
	struct rpc_cred *cred;
	struct rpc_task *task;

	data = kmalloc(sizeof(*data), GFP_NOFS);
	if (!data)
		return -ENOMEM;
	data->xps = xprt_switch_get(xps);
	data->xprt = xprt_get(xprt);

	cred = authnull_ops.lookup_cred(NULL, NULL, 0);
	task = rpc_call_null_helper(clnt, xprt, cred,
			RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
			&rpc_cb_add_xprt_call_ops, data);
	put_rpccred(cred);
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 1;
}
EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);

2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681
/**
 * rpc_clnt_setup_test_and_add_xprt()
 *
 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
 *   1) caller of the test function must dereference the rpc_xprt_switch
 *   and the rpc_xprt.
 *   2) test function must call rpc_xprt_switch_add_xprt, usually in
 *   the rpc_call_done routine.
 *
 * Upon success (return of 1), the test function adds the new
 * transport to the rpc_clnt xprt switch
 *
 * @clnt: struct rpc_clnt to get the new transport
 * @xps:  the rpc_xprt_switch to hold the new transport
 * @xprt: the rpc_xprt to test
 * @data: a struct rpc_add_xprt_test pointer that holds the test function
 *        and test function call data
 */
int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
				     struct rpc_xprt_switch *xps,
				     struct rpc_xprt *xprt,
				     void *data)
{
	struct rpc_cred *cred;
	struct rpc_task *task;
	struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
	int status = -EADDRINUSE;

	xprt = xprt_get(xprt);
	xprt_switch_get(xps);

	if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
		goto out_err;

	/* Test the connection */
	cred = authnull_ops.lookup_cred(NULL, NULL, 0);
	task = rpc_call_null_helper(clnt, xprt, cred,
				    RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
				    NULL, NULL);
	put_rpccred(cred);
	if (IS_ERR(task)) {
		status = PTR_ERR(task);
		goto out_err;
	}
	status = task->tk_status;
	rpc_put_task(task);

	if (status < 0)
		goto out_err;

	/* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
	xtest->add_xprt_test(clnt, xprt, xtest->data);

	/* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
	return 1;
out_err:
	xprt_put(xprt);
	xprt_switch_put(xps);
	pr_info("RPC:   rpc_clnt_test_xprt failed: %d addr %s not added\n",
		status, xprt->address_strings[RPC_DISPLAY_ADDR]);
	return status;
}
EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);

2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704
/**
 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
 * @clnt: pointer to struct rpc_clnt
 * @xprtargs: pointer to struct xprt_create
 * @setup: callback to test and/or set up the connection
 * @data: pointer to setup function data
 *
 * Creates a new transport using the parameters set in args and
 * adds it to clnt.
 * If ping is set, then test that connectivity succeeds before
 * adding the new transport.
 *
 */
int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
		struct xprt_create *xprtargs,
		int (*setup)(struct rpc_clnt *,
			struct rpc_xprt_switch *,
			struct rpc_xprt *,
			void *),
		void *data)
{
	struct rpc_xprt_switch *xps;
	struct rpc_xprt *xprt;
2705
	unsigned long connect_timeout;
2706
	unsigned long reconnect_timeout;
2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717
	unsigned char resvport;
	int ret = 0;

	rcu_read_lock();
	xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
	xprt = xprt_iter_xprt(&clnt->cl_xpi);
	if (xps == NULL || xprt == NULL) {
		rcu_read_unlock();
		return -EAGAIN;
	}
	resvport = xprt->resvport;
2718
	connect_timeout = xprt->connect_timeout;
2719
	reconnect_timeout = xprt->max_reconnect_timeout;
2720 2721 2722 2723 2724 2725 2726 2727
	rcu_read_unlock();

	xprt = xprt_create_transport(xprtargs);
	if (IS_ERR(xprt)) {
		ret = PTR_ERR(xprt);
		goto out_put_switch;
	}
	xprt->resvport = resvport;
2728 2729 2730 2731
	if (xprt->ops->set_connect_timeout != NULL)
		xprt->ops->set_connect_timeout(xprt,
				connect_timeout,
				reconnect_timeout);
2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747

	rpc_xprt_switch_set_roundrobin(xps);
	if (setup) {
		ret = setup(clnt, xps, xprt, data);
		if (ret != 0)
			goto out_put_xprt;
	}
	rpc_xprt_switch_add_xprt(xps, xprt);
out_put_xprt:
	xprt_put(xprt);
out_put_switch:
	xprt_switch_put(xps);
	return ret;
}
EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);

2748 2749 2750 2751 2752
struct connect_timeout_data {
	unsigned long connect_timeout;
	unsigned long reconnect_timeout;
};

2753
static int
2754
rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
2755 2756 2757
		struct rpc_xprt *xprt,
		void *data)
{
2758
	struct connect_timeout_data *timeo = data;
2759

2760 2761 2762 2763
	if (xprt->ops->set_connect_timeout)
		xprt->ops->set_connect_timeout(xprt,
				timeo->connect_timeout,
				timeo->reconnect_timeout);
2764 2765 2766 2767
	return 0;
}

void
2768 2769 2770
rpc_set_connect_timeout(struct rpc_clnt *clnt,
		unsigned long connect_timeout,
		unsigned long reconnect_timeout)
2771
{
2772
	struct connect_timeout_data timeout = {
2773 2774
		.connect_timeout = connect_timeout,
		.reconnect_timeout = reconnect_timeout,
2775
	};
2776
	rpc_clnt_iterate_for_each_xprt(clnt,
2777 2778
			rpc_xprt_set_connect_timeout,
			&timeout);
2779
}
2780
EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
2781

A
Andy Adamson 已提交
2782 2783
void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
{
A
Anna Schumaker 已提交
2784
	rcu_read_lock();
A
Andy Adamson 已提交
2785
	xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
A
Anna Schumaker 已提交
2786
	rcu_read_unlock();
A
Andy Adamson 已提交
2787 2788 2789
}
EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);

2790 2791
void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
{
A
Anna Schumaker 已提交
2792
	rcu_read_lock();
2793 2794
	rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
				 xprt);
A
Anna Schumaker 已提交
2795
	rcu_read_unlock();
2796 2797 2798
}
EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);

2799 2800 2801 2802 2803 2804 2805
bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
				   const struct sockaddr *sap)
{
	struct rpc_xprt_switch *xps;
	bool ret;

	rcu_read_lock();
A
Anna Schumaker 已提交
2806
	xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
2807 2808 2809 2810 2811 2812
	ret = rpc_xprt_switch_has_addr(xps, sap);
	rcu_read_unlock();
	return ret;
}
EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);

J
Jeff Layton 已提交
2813
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
2814 2815
static void rpc_show_header(void)
{
2816 2817
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2818 2819
}

C
Chuck Lever 已提交
2820 2821 2822 2823 2824 2825 2826 2827
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);

2828
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2829 2830
		task->tk_pid, task->tk_flags, task->tk_status,
		clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2831
		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2832
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2833 2834
}

2835
void rpc_show_tasks(struct net *net)
2836 2837
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2838
	struct rpc_task *task;
2839
	int header = 0;
2840
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2841

2842 2843
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2844
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2845
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2846 2847 2848 2849
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2850
			rpc_show_task(clnt, task);
2851 2852 2853
		}
		spin_unlock(&clnt->cl_lock);
	}
2854
	spin_unlock(&sn->rpc_client_lock);
2855 2856
}
#endif
2857 2858

#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2859 2860 2861 2862 2863 2864 2865 2866
static int
rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
		struct rpc_xprt *xprt,
		void *dummy)
{
	return xprt_enable_swap(xprt);
}

2867 2868 2869
int
rpc_clnt_swap_activate(struct rpc_clnt *clnt)
{
2870 2871 2872 2873
	if (atomic_inc_return(&clnt->cl_swapper) == 1)
		return rpc_clnt_iterate_for_each_xprt(clnt,
				rpc_clnt_swap_activate_callback, NULL);
	return 0;
2874 2875 2876
}
EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);

2877 2878 2879 2880 2881 2882 2883 2884 2885
static int
rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
		struct rpc_xprt *xprt,
		void *dummy)
{
	xprt_disable_swap(xprt);
	return 0;
}

2886 2887 2888
void
rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
{
2889 2890 2891
	if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
		rpc_clnt_iterate_for_each_xprt(clnt,
				rpc_clnt_swap_deactivate_callback, NULL);
2892 2893 2894
}
EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
#endif /* CONFIG_SUNRPC_SWAP */