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


#include <linux/module.h>
#include <linux/types.h>
23
#include <linux/kallsyms.h>
L
Linus Torvalds 已提交
24
#include <linux/mm.h>
25 26
#include <linux/namei.h>
#include <linux/mount.h>
L
Linus Torvalds 已提交
27
#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 190
{
	struct dentry *dentry;
	int err = 0;

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

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

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

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

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

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

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

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

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

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

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

	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
static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
{
289 290
	clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
			nodename, sizeof(clnt->cl_nodename));
291 292
}

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

306
	rpc_clnt_debugfs_register(clnt);
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
out:
	if (pipefs_sb)
		rpc_put_sb_net(net);
334
	rpc_clnt_debugfs_unregister(clnt);
335 336 337
	return err;
}

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

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

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

372 373 374
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
375

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

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

389 390 391
	err = rpc_alloc_clid(clnt);
	if (err)
		goto out_no_clid;
L
Linus Torvalds 已提交
392 393 394

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

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

414
	rpc_clnt_set_transport(clnt, xprt, timeout);
415 416
	xprt_iter_init(&clnt->cl_xpi, xps);
	xprt_switch_put(xps);
417

L
Linus Torvalds 已提交
418
	clnt->cl_rtt = &clnt->cl_rtt_default;
419
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
L
Linus Torvalds 已提交
420

421
	atomic_set(&clnt->cl_count, 1);
422

423 424
	if (nodename == NULL)
		nodename = utsname()->nodename;
L
Linus Torvalds 已提交
425
	/* save the nodename */
426
	rpc_clnt_set_nodename(clnt, nodename);
427

428
	err = rpc_client_register(clnt, args->authflavor, args->client_name);
429 430
	if (err)
		goto out_no_path;
431 432
	if (parent)
		atomic_inc(&parent->cl_count);
L
Linus Torvalds 已提交
433 434 435
	return clnt;

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

449
static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
450 451 452
					struct rpc_xprt *xprt)
{
	struct rpc_clnt *clnt = NULL;
453
	struct rpc_xprt_switch *xps;
454

455
	xps = xprt_switch_alloc(xprt, GFP_KERNEL);
456 457
	if (xps == NULL) {
		xprt_put(xprt);
458
		return ERR_PTR(-ENOMEM);
459
	}
460
	clnt = rpc_new_client(args, xps, xprt, NULL);
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
	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;
478 479
	if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
		clnt->cl_noretranstimeo = 1;
480 481 482 483 484 485 486 487
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;

	return clnt;
}

488
/**
489 490 491 492 493 494 495 496 497 498 499 500
 * 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;
501
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
502
		.net = args->net,
503
		.ident = args->protocol,
504
		.srcaddr = args->saddress,
505 506
		.dstaddr = args->address,
		.addrlen = args->addrsize,
507
		.servername = args->servername,
508
		.bc_xprt = args->bc_xprt,
509
	};
510
	char servername[48];
511

512 513 514 515 516 517 518 519 520
	if (args->bc_xprt) {
		WARN_ON(args->protocol != XPRT_TRANSPORT_BC_TCP);
		xprt = args->bc_xprt->xpt_bc_xprt;
		if (xprt) {
			xprt_get(xprt);
			return rpc_create_xprt(args, xprt);
		}
	}

521 522
	if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
		xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
523 524
	if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
		xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
525 526 527 528
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
529
	if (xprtargs.servername == NULL) {
530 531
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
532 533 534 535 536
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

537 538
		servername[0] = '\0';
		switch (args->address->sa_family) {
539 540 541 542
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
543
		case AF_INET:
H
Harvey Harrison 已提交
544 545
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
546
			break;
547
		case AF_INET6:
H
Harvey Harrison 已提交
548
			snprintf(servername, sizeof(servername), "%pI6",
549
				 &sin6->sin6_addr);
550 551 552 553 554 555
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
556
		xprtargs.servername = servername;
557 558
	}

559 560 561 562
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

563 564 565 566 567 568 569 570 571 572
	/*
	 * 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;

573
	return rpc_create_xprt(args, xprt);
574
}
575
EXPORT_SYMBOL_GPL(rpc_create);
576

L
Linus Torvalds 已提交
577 578 579 580 581
/*
 * 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 已提交
582 583
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
584
{
585
	struct rpc_xprt_switch *xps;
586
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
587 588
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
589

C
Chuck Lever 已提交
590
	err = -ENOMEM;
591 592
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
593
	xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
594
	rcu_read_unlock();
595 596 597
	if (xprt == NULL || xps == NULL) {
		xprt_put(xprt);
		xprt_switch_put(xps);
C
Chuck Lever 已提交
598
		goto out_err;
599
	}
C
Chuck Lever 已提交
600
	args->servername = xprt->servername;
601
	args->nodename = clnt->cl_nodename;
C
Chuck Lever 已提交
602

603
	new = rpc_new_client(args, xps, xprt, clnt);
C
Chuck Lever 已提交
604 605
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
606
		goto out_err;
C
Chuck Lever 已提交
607 608 609 610 611
	}

	/* Turn off autobind on clones */
	new->cl_autobind = 0;
	new->cl_softrtry = clnt->cl_softrtry;
612
	new->cl_noretranstimeo = clnt->cl_noretranstimeo;
C
Chuck Lever 已提交
613 614
	new->cl_discrtry = clnt->cl_discrtry;
	new->cl_chatty = clnt->cl_chatty;
L
Linus Torvalds 已提交
615
	return new;
C
Chuck Lever 已提交
616 617

out_err:
618
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
619
	return ERR_PTR(err);
L
Linus Torvalds 已提交
620
}
C
Chuck Lever 已提交
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638

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

641 642 643 644
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
645
 * @flavor: security flavor for new client
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
 *
 * 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);

662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
/**
 * 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;
683
	struct rpc_xprt_switch *xps, *oldxps;
684 685 686 687 688 689 690 691 692 693 694
	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);
	}

695 696 697 698 699 700
	xps = xprt_switch_alloc(xprt, GFP_KERNEL);
	if (xps == NULL) {
		xprt_put(xprt);
		return -ENOMEM;
	}

701 702 703 704
	pseudoflavor = clnt->cl_auth->au_flavor;

	old_timeo = clnt->cl_timeout;
	old = rpc_clnt_set_transport(clnt, xprt, timeout);
705
	oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
706 707 708

	rpc_unregister_client(clnt);
	__rpc_clnt_remove_pipedir(clnt);
709
	rpc_clnt_debugfs_unregister(clnt);
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730

	/*
	 * 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);
731
	xprt_switch_put(oldxps);
732 733 734 735 736
	xprt_put(old);
	dprintk("RPC:       replaced xprt for clnt %p\n", clnt);
	return 0;

out_revert:
737
	xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
738 739 740
	rpc_clnt_set_transport(clnt, old, old_timeo);
	clnt->cl_parent = parent;
	rpc_client_register(clnt, pseudoflavor, NULL);
741
	xprt_switch_put(xps);
742 743 744 745 746 747
	xprt_put(xprt);
	dprintk("RPC:       failed to switch xprt for clnt %p\n", clnt);
	return err;
}
EXPORT_SYMBOL_GPL(rpc_switch_client_transport);

748 749 750 751 752 753 754 755 756 757 758 759 760 761 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
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);

799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
/*
 * 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);
821 822 823
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
824 825 826 827 828 829
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
830 831
/*
 * Properly shut down an RPC client, terminating all outstanding
832
 * requests.
L
Linus Torvalds 已提交
833
 */
834
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
835
{
836 837
	might_sleep();

838
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
839
			clnt->cl_program->name,
840
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
841

842
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
843
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
844
		wait_event_timeout(destroy_wait,
845
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
846 847
	}

848
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
849
}
850
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
851 852

/*
853
 * Free an RPC client
L
Linus Torvalds 已提交
854
 */
855
static struct rpc_clnt *
856
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
857
{
858 859
	struct rpc_clnt *parent = NULL;

860
	dprintk_rcu("RPC:       destroying %s client for %s\n",
861
			clnt->cl_program->name,
862
			rcu_dereference(clnt->cl_xprt)->servername);
863
	if (clnt->cl_parent != clnt)
864
		parent = clnt->cl_parent;
865
	rpc_clnt_debugfs_unregister(clnt);
866
	rpc_clnt_remove_pipedir(clnt);
867
	rpc_unregister_client(clnt);
868 869
	rpc_free_iostats(clnt->cl_metrics);
	clnt->cl_metrics = NULL;
870
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
871
	xprt_iter_destroy(&clnt->cl_xpi);
872
	rpciod_down();
873
	rpc_free_clid(clnt);
L
Linus Torvalds 已提交
874
	kfree(clnt);
875
	return parent;
L
Linus Torvalds 已提交
876 877
}

878 879 880
/*
 * Free an RPC client
 */
881
static struct rpc_clnt * 
882
rpc_free_auth(struct rpc_clnt *clnt)
883
{
884 885
	if (clnt->cl_auth == NULL)
		return rpc_free_client(clnt);
886 887 888 889 890 891

	/*
	 * 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.
	 */
892
	atomic_inc(&clnt->cl_count);
893 894
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
895
	if (atomic_dec_and_test(&clnt->cl_count))
896 897
		return rpc_free_client(clnt);
	return NULL;
898 899
}

L
Linus Torvalds 已提交
900
/*
901
 * Release reference to the RPC client
L
Linus Torvalds 已提交
902 903 904 905
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
906
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
907

908 909 910 911 912 913 914
	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);
915
}
916
EXPORT_SYMBOL_GPL(rpc_release_client);
917

918 919
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
920 921 922
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
923 924 925 926 927 928
 *
 * 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,
929
				      const struct rpc_program *program,
930
				      u32 vers)
931
{
932 933 934 935 936 937
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
	};
938 939 940
	struct rpc_clnt *clnt;
	int err;

941
	clnt = __rpc_clone_client(&args, old);
942 943
	if (IS_ERR(clnt))
		goto out;
944
	err = rpc_ping(clnt);
945 946 947 948
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
949
out:
950 951
	return clnt;
}
952
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
953

954 955 956
void rpc_task_release_client(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
957
	struct rpc_xprt *xprt = task->tk_xprt;
958 959 960 961 962 963 964 965 966 967

	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);
	}
968 969 970 971 972 973

	if (xprt != NULL) {
		task->tk_xprt = NULL;

		xprt_put(xprt);
	}
974 975 976 977 978
}

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

980 981
	if (clnt != NULL) {
		rpc_task_release_client(task);
982 983
		if (task->tk_xprt == NULL)
			task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
984
		task->tk_client = clnt;
985
		atomic_inc(&clnt->cl_count);
986 987
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
988 989
		if (clnt->cl_noretranstimeo)
			task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
990 991
		if (atomic_read(&clnt->cl_swapper))
			task->tk_flags |= RPC_TASK_SWAPPER;
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
		/* 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;
1006 1007
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
1008 1009 1010
	}
}

L
Linus Torvalds 已提交
1011 1012 1013 1014
/*
 * Default callback for async RPC calls
 */
static void
1015
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
1016 1017 1018
{
}

1019 1020 1021 1022
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
1023 1024 1025 1026 1027
/**
 * 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)
1028
{
1029
	struct rpc_task *task;
1030

1031
	task = rpc_new_task(task_setup_data);
1032
	if (IS_ERR(task))
1033
		goto out;
1034

1035 1036 1037 1038 1039 1040
	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);

1041 1042 1043
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
1044
	return task;
1045
}
T
Trond Myklebust 已提交
1046
EXPORT_SYMBOL_GPL(rpc_run_task);
1047 1048 1049 1050 1051 1052

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
1053
 */
1054
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
1055 1056
{
	struct rpc_task	*task;
1057 1058 1059 1060 1061 1062
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
1063
	int status;
L
Linus Torvalds 已提交
1064

1065 1066 1067 1068 1069 1070
	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 已提交
1071

T
Trond Myklebust 已提交
1072
	task = rpc_run_task(&task_setup_data);
1073 1074
	if (IS_ERR(task))
		return PTR_ERR(task);
1075
	status = task->tk_status;
1076
	rpc_put_task(task);
L
Linus Torvalds 已提交
1077 1078
	return status;
}
1079
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
1080

1081 1082 1083 1084 1085
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
1086
 * @tk_ops: RPC call ops
1087
 * @data: user call data
L
Linus Torvalds 已提交
1088 1089
 */
int
1090
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
1091
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
1092 1093
{
	struct rpc_task	*task;
1094 1095 1096 1097 1098 1099 1100
	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 已提交
1101

T
Trond Myklebust 已提交
1102
	task = rpc_run_task(&task_setup_data);
1103 1104 1105 1106
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
1107
}
1108
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
1109

1110
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1111 1112 1113
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
1114
 * @req: RPC request
1115
 */
1116
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
1117 1118 1119 1120
{
	struct rpc_task *task;
	struct xdr_buf *xbufp = &req->rq_snd_buf;
	struct rpc_task_setup task_setup_data = {
1121
		.callback_ops = &rpc_default_ops,
1122
		.flags = RPC_TASK_SOFTCONN,
1123 1124 1125 1126 1127 1128 1129
	};

	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);
1130
	if (IS_ERR(task)) {
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
		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);
1145
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
1146 1147 1148 1149 1150 1151
	rpc_execute(task);

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

1154 1155 1156 1157 1158 1159 1160
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

1161 1162 1163 1164
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
1165
 * @bufsize: length of target buffer
1166 1167 1168 1169 1170 1171
 *
 * 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;
1172 1173 1174 1175
	struct rpc_xprt *xprt;

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

1177
	bytes = xprt->addrlen;
1178 1179
	if (bytes > bufsize)
		bytes = bufsize;
1180 1181 1182 1183
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
1184
}
1185
EXPORT_SYMBOL_GPL(rpc_peeraddr);
1186

1187 1188 1189 1190 1191
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
1192 1193 1194
 * 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.
1195
 */
1196 1197
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
1198
{
1199 1200 1201
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
1202 1203 1204 1205 1206

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
1207
}
1208
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
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 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 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
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));
1308
		break;
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 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
	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 已提交
1360 1361 1362
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1363 1364 1365 1366
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1367 1368
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1369
	rcu_read_unlock();
L
Linus Torvalds 已提交
1370
}
1371
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
1372

1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
/**
 * 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 已提交
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
/**
T
Trond Myklebust 已提交
1443
 * rpc_get_timeout - Get timeout for transport in units of HZ
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
 * @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);

1457 1458 1459 1460 1461 1462 1463
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1464 1465 1466 1467 1468
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1469
}
1470
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1471

1472 1473 1474 1475
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1476
int
1477 1478 1479
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1480
		return 0;
1481
	task->tk_action = call_start;
1482
	task->tk_status = 0;
1483 1484
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1485
	return 1;
1486 1487 1488
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1489 1490 1491 1492
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1493
int
L
Linus Torvalds 已提交
1494 1495 1496
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1497
		return 0;
L
Linus Torvalds 已提交
1498
	task->tk_action = call_start;
1499
	task->tk_status = 0;
1500
	return 1;
L
Linus Torvalds 已提交
1501
}
1502
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1503

J
Jeff Layton 已提交
1504
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
1505 1506
const char
*rpc_proc_name(const struct rpc_task *task)
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
{
	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 已提交
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
/*
 * 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;

1531
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1532
			clnt->cl_program->name, clnt->cl_vers,
1533
			rpc_proc_name(task),
1534
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547

	/* 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)
{
1548
	dprint_status(task);
L
Linus Torvalds 已提交
1549 1550 1551 1552 1553 1554

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

1555 1556
static void call_retry_reserve(struct rpc_task *task);

L
Linus Torvalds 已提交
1557 1558 1559 1560 1561 1562 1563 1564
/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1565
	dprint_status(task);
L
Linus Torvalds 已提交
1566 1567 1568 1569 1570 1571 1572 1573

	/*
	 * 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) {
1574
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1575 1576 1577 1578
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1579
				__func__, status);
L
Linus Torvalds 已提交
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
		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",
1590
				__func__, status);
L
Linus Torvalds 已提交
1591 1592 1593 1594
		xprt_release(task);
	}

	switch (status) {
1595 1596
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1597
	case -EAGAIN:	/* woken up; retry */
1598
		task->tk_action = call_retry_reserve;
L
Linus Torvalds 已提交
1599 1600 1601 1602 1603
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1604
				__func__, status);
L
Linus Torvalds 已提交
1605 1606 1607 1608 1609
		break;
	}
	rpc_exit(task, status);
}

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

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1677
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1678 1679 1680 1681
 */
static void
call_allocate(struct rpc_task *task)
{
1682
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1683
	struct rpc_rqst *req = task->tk_rqstp;
1684
	struct rpc_xprt *xprt = req->rq_xprt;
1685
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1686

1687 1688
	dprint_status(task);

1689
	task->tk_status = 0;
1690
	task->tk_action = call_bind;
1691

1692
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1693 1694
		return;

1695 1696 1697 1698 1699
	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 已提交
1700

1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
	/*
	 * 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;

1711 1712
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1713
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1714
		return;
C
Chuck Lever 已提交
1715
	xprt_inject_disconnect(xprt);
1716 1717

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

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

	rpc_exit(task, -ERESTARTSYS);
}

1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
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;
1738
	task->tk_rqstp->rq_bytes_sent = 0;
1739 1740
}

1741 1742 1743 1744 1745 1746 1747
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;
1748
	buf->flags = 0;
1749 1750 1751 1752
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1753 1754 1755 1756
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1757
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1758 1759
{
	struct rpc_rqst	*req = task->tk_rqstp;
1760
	kxdreproc_t	encode;
1761
	__be32		*p;
L
Linus Torvalds 已提交
1762

1763
	dprint_status(task);
L
Linus Torvalds 已提交
1764

1765 1766 1767 1768 1769 1770
	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 已提交
1771

1772 1773 1774
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1775 1776 1777
		rpc_exit(task, -EIO);
		return;
	}
1778 1779

	encode = task->tk_msg.rpc_proc->p_encode;
1780 1781 1782 1783 1784
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1785 1786 1787 1788 1789 1790 1791 1792
}

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

1795
	dprint_status(task);
L
Linus Torvalds 已提交
1796

1797
	task->tk_action = call_connect;
1798
	if (!xprt_bound(xprt)) {
1799
		task->tk_action = call_bind_status;
1800
		task->tk_timeout = xprt->bind_timeout;
1801
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1802 1803 1804 1805
	}
}

/*
1806 1807 1808 1809 1810
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1811
	int status = -EIO;
1812 1813

	if (task->tk_status >= 0) {
1814
		dprint_status(task);
1815 1816 1817 1818 1819
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1820
	trace_rpc_bind_status(task);
1821
	switch (task->tk_status) {
1822 1823 1824
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1825
		goto retry_timeout;
1826
	case -EACCES:
1827 1828
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1829 1830 1831 1832 1833
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1834 1835 1836
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1837
		rpc_delay(task, 3*HZ);
1838
		goto retry_timeout;
1839
	case -ETIMEDOUT:
1840
		dprintk("RPC: %5u rpcbind request timed out\n",
1841
				task->tk_pid);
1842
		goto retry_timeout;
1843
	case -EPFNOSUPPORT:
1844
		/* server doesn't support any rpcbind version we know of */
1845
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1846 1847 1848
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1849
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1850
				task->tk_pid);
1851
		goto retry_timeout;
1852 1853
	case -ECONNREFUSED:		/* connection problems */
	case -ECONNRESET:
1854
	case -ECONNABORTED:
1855 1856 1857 1858
	case -ENOTCONN:
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
1859
	case -ENOBUFS:
1860 1861 1862 1863 1864 1865 1866 1867 1868
	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;
1869
	default:
1870
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1871 1872 1873 1874 1875 1876
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1877
retry_timeout:
1878
	task->tk_status = 0;
1879
	task->tk_action = call_timeout;
1880 1881 1882 1883
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1884 1885 1886 1887
 */
static void
call_connect(struct rpc_task *task)
{
1888
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1889

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

1894 1895 1896 1897 1898
	task->tk_action = call_transmit;
	if (!xprt_connected(xprt)) {
		task->tk_action = call_connect_status;
		if (task->tk_status < 0)
			return;
1899 1900 1901 1902
		if (task->tk_flags & RPC_TASK_NOCONNECT) {
			rpc_exit(task, -ENOTCONN);
			return;
		}
1903
		xprt_connect(task);
L
Linus Torvalds 已提交
1904 1905 1906 1907
	}
}

/*
1908
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1909 1910 1911 1912 1913 1914 1915
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1916
	dprint_status(task);
1917

1918
	trace_rpc_connect_status(task, status);
1919
	task->tk_status = 0;
L
Linus Torvalds 已提交
1920
	switch (status) {
1921 1922
	case -ECONNREFUSED:
	case -ECONNRESET:
1923
	case -ECONNABORTED:
1924
	case -ENETUNREACH:
1925
	case -EHOSTUNREACH:
1926
	case -EADDRINUSE:
1927
	case -ENOBUFS:
1928
	case -EPIPE:
1929 1930
		if (RPC_IS_SOFTCONN(task))
			break;
1931 1932
		/* retry with existing socket, after a delay */
		rpc_delay(task, 3*HZ);
1933
	case -EAGAIN:
1934 1935 1936
		/* Check for timeouts before looping back to call_bind */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1937 1938
		return;
	case 0:
1939 1940 1941
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
L
Linus Torvalds 已提交
1942
	}
1943
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1944 1945 1946 1947 1948 1949 1950 1951
}

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

1954
	dprint_status(task);
L
Linus Torvalds 已提交
1955 1956 1957 1958

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

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

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

2009 2010
	switch (task->tk_status) {
	case -EAGAIN:
2011
	case -ENOBUFS:
2012 2013
		break;
	default:
2014
		dprint_status(task);
2015
		xprt_end_transmit(task);
2016 2017
		rpc_task_force_reencode(task);
		break;
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
		/*
		 * 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:
2028
	case -EPERM:
2029 2030 2031 2032 2033 2034
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
2035
	case -ECONNABORTED:
2036
	case -EADDRINUSE:
2037
	case -ENOTCONN:
2038
	case -EPIPE:
2039 2040
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
2041 2042
}

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

2053 2054
	if (!xprt_prepare_transmit(task))
		goto out_retry;
2055 2056 2057 2058

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

	xprt_transmit(task);
2065 2066 2067 2068

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

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

L
Linus Torvalds 已提交
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126
/*
 * 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;

2127 2128
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
2129

2130
	dprint_status(task);
L
Linus Torvalds 已提交
2131 2132 2133 2134 2135 2136 2137

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

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

/*
2189
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
2190 2191 2192 2193 2194 2195 2196 2197 2198
 * 	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) {
2199
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
2200 2201 2202
		goto retry;
	}

2203
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
2204 2205
	task->tk_timeouts++;

2206 2207 2208 2209
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
2210
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
2211
		if (clnt->cl_chatty) {
O
Olga Kornievskaia 已提交
2212
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
2213
				clnt->cl_program->name,
2214
				task->tk_xprt->servername);
J
Joe Perches 已提交
2215
		}
2216 2217 2218 2219
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
2220 2221 2222
		return;
	}

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

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

2254
	dprint_status(task);
L
Linus Torvalds 已提交
2255

C
Chuck Lever 已提交
2256
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2257
		if (clnt->cl_chatty) {
O
Olga Kornievskaia 已提交
2258
			printk(KERN_NOTICE "%s: server %s OK\n",
2259
				clnt->cl_program->name,
2260
				task->tk_xprt->servername);
2261
		}
L
Linus Torvalds 已提交
2262 2263 2264
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

2265 2266
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
2267
	 * before it changed req->rq_reply_bytes_recvd.
2268 2269
	 */
	smp_rmb();
L
Linus Torvalds 已提交
2270 2271 2272 2273 2274 2275
	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);

2276 2277 2278 2279 2280 2281
	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",
2282
				clnt->cl_program->name, task->tk_status);
2283 2284 2285 2286
		task->tk_action = call_timeout;
		goto out_retry;
	}

2287
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2288 2289 2290 2291
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2292 2293
	}

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

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

2314
static __be32 *
2315
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2316 2317 2318
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2319
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2320 2321

	/* FIXME: check buffer size? */
2322

2323
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2324 2325 2326 2327 2328 2329
	*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 */
2330 2331 2332
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2333 2334
}

2335
static __be32 *
2336
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2337
{
2338
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2339 2340
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2341 2342
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2343 2344
	int error = -EACCES;

2345 2346 2347 2348 2349 2350
	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
		 */
2351
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2352
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2353
		       task->tk_rqstp->rq_rcv_buf.len);
2354 2355
		error = -EIO;
		goto out_err;
2356
	}
L
Linus Torvalds 已提交
2357 2358 2359
	if ((len -= 3) < 0)
		goto out_overflow;

2360
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2361
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2362
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2363
			task->tk_pid, __func__, n);
2364
		error = -EIO;
T
Trond Myklebust 已提交
2365
		goto out_garbage;
L
Linus Torvalds 已提交
2366
	}
2367

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

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

2495
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2496 2497 2498
{
}

2499
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2500 2501 2502 2503 2504 2505 2506 2507 2508
{
	return 0;
}

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

2509
static int rpc_ping(struct rpc_clnt *clnt)
2510 2511 2512 2513 2514 2515
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2516
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2517 2518 2519
	put_rpccred(msg.rpc_cred);
	return err;
}
2520

2521 2522 2523 2524
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)
2525 2526 2527 2528 2529
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
		.rpc_cred = cred,
	};
2530 2531
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
2532
		.rpc_xprt = xprt,
2533
		.rpc_message = &msg,
2534 2535
		.callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
		.callback_data = data,
2536 2537
		.flags = flags,
	};
2538

T
Trond Myklebust 已提交
2539
	return rpc_run_task(&task_setup_data);
2540
}
2541 2542 2543 2544 2545

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);
}
2546
EXPORT_SYMBOL_GPL(rpc_call_null);
2547

2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 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 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
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);
}

const static struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
	.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);

/**
 * 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;
	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;
	rcu_read_unlock();

	xprt = xprt_create_transport(xprtargs);
	if (IS_ERR(xprt)) {
		ret = PTR_ERR(xprt);
		goto out_put_switch;
	}
	xprt->resvport = resvport;

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

J
Jeff Layton 已提交
2666
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
2667 2668
static void rpc_show_header(void)
{
2669 2670
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2671 2672
}

C
Chuck Lever 已提交
2673 2674 2675 2676 2677 2678 2679 2680
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);

2681
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2682 2683
		task->tk_pid, task->tk_flags, task->tk_status,
		clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2684
		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2685
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2686 2687
}

2688
void rpc_show_tasks(struct net *net)
2689 2690
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2691
	struct rpc_task *task;
2692
	int header = 0;
2693
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2694

2695 2696
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2697
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2698
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2699 2700 2701 2702
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2703
			rpc_show_task(clnt, task);
2704 2705 2706
		}
		spin_unlock(&clnt->cl_lock);
	}
2707
	spin_unlock(&sn->rpc_client_lock);
2708 2709
}
#endif
2710 2711

#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2712 2713 2714 2715 2716 2717 2718 2719
static int
rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
		struct rpc_xprt *xprt,
		void *dummy)
{
	return xprt_enable_swap(xprt);
}

2720 2721 2722
int
rpc_clnt_swap_activate(struct rpc_clnt *clnt)
{
2723 2724 2725 2726
	if (atomic_inc_return(&clnt->cl_swapper) == 1)
		return rpc_clnt_iterate_for_each_xprt(clnt,
				rpc_clnt_swap_activate_callback, NULL);
	return 0;
2727 2728 2729
}
EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);

2730 2731 2732 2733 2734 2735 2736 2737 2738
static int
rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
		struct rpc_xprt *xprt,
		void *dummy)
{
	xprt_disable_swap(xprt);
	return 0;
}

2739 2740 2741
void
rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
{
2742 2743 2744
	if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
		rpc_clnt_iterate_for_each_xprt(clnt,
				rpc_clnt_swap_deactivate_callback, NULL);
2745 2746 2747
}
EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
#endif /* CONFIG_SUNRPC_SWAP */