clnt.c 60.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 357 358
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
		struct rpc_xprt *xprt,
		struct rpc_clnt *parent)
L
Linus Torvalds 已提交
359
{
360 361
	const struct rpc_program *program = args->program;
	const struct rpc_version *version;
362 363
	struct rpc_clnt *clnt = NULL;
	const struct rpc_timeout *timeout;
364
	const char *nodename = args->nodename;
L
Linus Torvalds 已提交
365
	int err;
366 367

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

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

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

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

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

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

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

413 414
	rpc_clnt_set_transport(clnt, xprt, timeout);

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

418
	atomic_set(&clnt->cl_count, 1);
419

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

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

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

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
					struct rpc_xprt *xprt)
{
	struct rpc_clnt *clnt = NULL;

	clnt = rpc_new_client(args, xprt, NULL);
	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;
468 469
	if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
		clnt->cl_noretranstimeo = 1;
470 471 472 473 474 475 476 477 478
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;

	return clnt;
}
EXPORT_SYMBOL_GPL(rpc_create_xprt);

479
/**
480 481 482 483 484 485 486 487 488 489 490 491
 * 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;
492
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
493
		.net = args->net,
494
		.ident = args->protocol,
495
		.srcaddr = args->saddress,
496 497
		.dstaddr = args->address,
		.addrlen = args->addrsize,
498
		.servername = args->servername,
499
		.bc_xprt = args->bc_xprt,
500
	};
501
	char servername[48];
502

503 504
	if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
		xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
505 506
	if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
		xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
507 508 509 510
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
511
	if (xprtargs.servername == NULL) {
512 513
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
514 515 516 517 518
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

519 520
		servername[0] = '\0';
		switch (args->address->sa_family) {
521 522 523 524
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
525
		case AF_INET:
H
Harvey Harrison 已提交
526 527
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
528
			break;
529
		case AF_INET6:
H
Harvey Harrison 已提交
530
			snprintf(servername, sizeof(servername), "%pI6",
531
				 &sin6->sin6_addr);
532 533 534 535 536 537
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
538
		xprtargs.servername = servername;
539 540
	}

541 542 543 544
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

545 546 547 548 549 550 551 552 553 554
	/*
	 * 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;

555
	return rpc_create_xprt(args, xprt);
556
}
557
EXPORT_SYMBOL_GPL(rpc_create);
558

L
Linus Torvalds 已提交
559 560 561 562 563
/*
 * 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 已提交
564 565
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
566
{
567
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
568 569
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
570

C
Chuck Lever 已提交
571
	err = -ENOMEM;
572 573 574 575
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
	rcu_read_unlock();
	if (xprt == NULL)
C
Chuck Lever 已提交
576 577
		goto out_err;
	args->servername = xprt->servername;
578
	args->nodename = clnt->cl_nodename;
C
Chuck Lever 已提交
579

580
	new = rpc_new_client(args, xprt, clnt);
C
Chuck Lever 已提交
581 582
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
583
		goto out_err;
C
Chuck Lever 已提交
584 585 586 587 588
	}

	/* Turn off autobind on clones */
	new->cl_autobind = 0;
	new->cl_softrtry = clnt->cl_softrtry;
589
	new->cl_noretranstimeo = clnt->cl_noretranstimeo;
C
Chuck Lever 已提交
590 591
	new->cl_discrtry = clnt->cl_discrtry;
	new->cl_chatty = clnt->cl_chatty;
L
Linus Torvalds 已提交
592
	return new;
C
Chuck Lever 已提交
593 594

out_err:
595
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
596
	return ERR_PTR(err);
L
Linus Torvalds 已提交
597
}
C
Chuck Lever 已提交
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615

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

618 619 620 621
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
622
 * @flavor: security flavor for new client
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
 *
 * 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);

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
/**
 * rpc_switch_client_transport: switch the RPC transport on the fly
 * @clnt: pointer to a struct rpc_clnt
 * @args: pointer to the new transport arguments
 * @timeout: pointer to the new timeout parameters
 *
 * This function allows the caller to switch the RPC transport for the
 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
 * server, for instance.  It assumes that the caller has ensured that
 * there are no active RPC tasks by using some form of locking.
 *
 * Returns zero if "clnt" is now using the new xprt.  Otherwise a
 * negative errno is returned, and "clnt" continues to use the old
 * xprt.
 */
int rpc_switch_client_transport(struct rpc_clnt *clnt,
		struct xprt_create *args,
		const struct rpc_timeout *timeout)
{
	const struct rpc_timeout *old_timeo;
	rpc_authflavor_t pseudoflavor;
	struct rpc_xprt *xprt, *old;
	struct rpc_clnt *parent;
	int err;

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

	pseudoflavor = clnt->cl_auth->au_flavor;

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

	rpc_unregister_client(clnt);
	__rpc_clnt_remove_pipedir(clnt);
678
	rpc_clnt_debugfs_unregister(clnt);
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713

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

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

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

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

714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
/*
 * 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);
736 737 738
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
739 740 741 742 743 744
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
745 746
/*
 * Properly shut down an RPC client, terminating all outstanding
747
 * requests.
L
Linus Torvalds 已提交
748
 */
749
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
750
{
751 752
	might_sleep();

753
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
754
			clnt->cl_program->name,
755
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
756

757
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
758
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
759
		wait_event_timeout(destroy_wait,
760
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
761 762
	}

763
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
764
}
765
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
766 767

/*
768
 * Free an RPC client
L
Linus Torvalds 已提交
769
 */
770
static struct rpc_clnt *
771
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
772
{
773 774
	struct rpc_clnt *parent = NULL;

775
	dprintk_rcu("RPC:       destroying %s client for %s\n",
776
			clnt->cl_program->name,
777
			rcu_dereference(clnt->cl_xprt)->servername);
778
	if (clnt->cl_parent != clnt)
779
		parent = clnt->cl_parent;
780
	rpc_clnt_debugfs_unregister(clnt);
781
	rpc_clnt_remove_pipedir(clnt);
782
	rpc_unregister_client(clnt);
783 784
	rpc_free_iostats(clnt->cl_metrics);
	clnt->cl_metrics = NULL;
785
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
786
	rpciod_down();
787
	rpc_free_clid(clnt);
L
Linus Torvalds 已提交
788
	kfree(clnt);
789
	return parent;
L
Linus Torvalds 已提交
790 791
}

792 793 794
/*
 * Free an RPC client
 */
795
static struct rpc_clnt * 
796
rpc_free_auth(struct rpc_clnt *clnt)
797
{
798 799
	if (clnt->cl_auth == NULL)
		return rpc_free_client(clnt);
800 801 802 803 804 805

	/*
	 * 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.
	 */
806
	atomic_inc(&clnt->cl_count);
807 808
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
809
	if (atomic_dec_and_test(&clnt->cl_count))
810 811
		return rpc_free_client(clnt);
	return NULL;
812 813
}

L
Linus Torvalds 已提交
814
/*
815
 * Release reference to the RPC client
L
Linus Torvalds 已提交
816 817 818 819
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
820
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
821

822 823 824 825 826 827 828
	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);
829
}
830
EXPORT_SYMBOL_GPL(rpc_release_client);
831

832 833
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
834 835 836
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
837 838 839 840 841 842
 *
 * 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,
843
				      const struct rpc_program *program,
844
				      u32 vers)
845
{
846 847 848 849 850 851
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
	};
852 853 854
	struct rpc_clnt *clnt;
	int err;

855
	clnt = __rpc_clone_client(&args, old);
856 857
	if (IS_ERR(clnt))
		goto out;
858
	err = rpc_ping(clnt);
859 860 861 862
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
863
out:
864 865
	return clnt;
}
866
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
867

868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
void rpc_task_release_client(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;

	if (clnt != NULL) {
		/* Remove from client task list */
		spin_lock(&clnt->cl_lock);
		list_del(&task->tk_task);
		spin_unlock(&clnt->cl_lock);
		task->tk_client = NULL;

		rpc_release_client(clnt);
	}
}

static
void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
{
	if (clnt != NULL) {
		rpc_task_release_client(task);
		task->tk_client = clnt;
889
		atomic_inc(&clnt->cl_count);
890 891
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
892 893
		if (clnt->cl_noretranstimeo)
			task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
894 895
		if (atomic_read(&clnt->cl_swapper))
			task->tk_flags |= RPC_TASK_SWAPPER;
896 897 898 899 900 901 902
		/* 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);
	}
}

903 904 905 906 907 908 909 910
void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
{
	rpc_task_release_client(task);
	rpc_task_set_client(task, clnt);
}
EXPORT_SYMBOL_GPL(rpc_task_reset_client);


911 912 913 914 915 916 917
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;
918 919
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
920 921 922
	}
}

L
Linus Torvalds 已提交
923 924 925 926
/*
 * Default callback for async RPC calls
 */
static void
927
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
928 929 930
{
}

931 932 933 934
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
935 936 937 938 939
/**
 * 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)
940
{
941
	struct rpc_task *task;
942

943
	task = rpc_new_task(task_setup_data);
944
	if (IS_ERR(task))
945
		goto out;
946

947 948 949 950 951 952
	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);

953 954 955
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
956
	return task;
957
}
T
Trond Myklebust 已提交
958
EXPORT_SYMBOL_GPL(rpc_run_task);
959 960 961 962 963 964

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
965
 */
966
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
967 968
{
	struct rpc_task	*task;
969 970 971 972 973 974
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
975
	int status;
L
Linus Torvalds 已提交
976

977 978 979 980 981 982
	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 已提交
983

T
Trond Myklebust 已提交
984
	task = rpc_run_task(&task_setup_data);
985 986
	if (IS_ERR(task))
		return PTR_ERR(task);
987
	status = task->tk_status;
988
	rpc_put_task(task);
L
Linus Torvalds 已提交
989 990
	return status;
}
991
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
992

993 994 995 996 997
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
998
 * @tk_ops: RPC call ops
999
 * @data: user call data
L
Linus Torvalds 已提交
1000 1001
 */
int
1002
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
1003
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
1004 1005
{
	struct rpc_task	*task;
1006 1007 1008 1009 1010 1011 1012
	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 已提交
1013

T
Trond Myklebust 已提交
1014
	task = rpc_run_task(&task_setup_data);
1015 1016 1017 1018
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
1019
}
1020
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
1021

1022
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1023 1024 1025
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
1026
 * @req: RPC request
1027
 */
1028
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
1029 1030 1031 1032
{
	struct rpc_task *task;
	struct xdr_buf *xbufp = &req->rq_snd_buf;
	struct rpc_task_setup task_setup_data = {
1033
		.callback_ops = &rpc_default_ops,
1034
		.flags = RPC_TASK_SOFTCONN,
1035 1036 1037 1038 1039 1040 1041
	};

	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);
1042
	if (IS_ERR(task)) {
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
		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);
1057
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
1058 1059 1060 1061 1062 1063
	rpc_execute(task);

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

1066 1067 1068 1069 1070 1071 1072
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

1073 1074 1075 1076
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
1077
 * @bufsize: length of target buffer
1078 1079 1080 1081 1082 1083
 *
 * 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;
1084 1085 1086 1087
	struct rpc_xprt *xprt;

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

1089
	bytes = xprt->addrlen;
1090 1091
	if (bytes > bufsize)
		bytes = bufsize;
1092 1093 1094 1095
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
1096
}
1097
EXPORT_SYMBOL_GPL(rpc_peeraddr);
1098

1099 1100 1101 1102 1103
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
1104 1105 1106
 * 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.
1107
 */
1108 1109
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
1110
{
1111 1112 1113
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
1114 1115 1116 1117 1118

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
1119
}
1120
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1121

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
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));
1220
		break;
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
	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 已提交
1272 1273 1274
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1275 1276 1277 1278
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1279 1280
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1281
	rcu_read_unlock();
L
Linus Torvalds 已提交
1282
}
1283
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
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
/**
 * 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 已提交
1320 1321 1322 1323 1324 1325 1326 1327
 *
 * 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)
{
1328 1329 1330 1331 1332 1333
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1334
}
1335
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1336

1337
/**
T
Trond Myklebust 已提交
1338
 * rpc_get_timeout - Get timeout for transport in units of HZ
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
 * @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);

1352 1353 1354 1355 1356 1357 1358
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1359 1360 1361 1362 1363
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1364
}
1365
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1366

1367 1368 1369 1370
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1371
int
1372 1373 1374
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1375
		return 0;
1376
	task->tk_action = call_start;
1377
	task->tk_status = 0;
1378 1379
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1380
	return 1;
1381 1382 1383
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1384 1385 1386 1387
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1388
int
L
Linus Torvalds 已提交
1389 1390 1391
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1392
		return 0;
L
Linus Torvalds 已提交
1393
	task->tk_action = call_start;
1394
	task->tk_status = 0;
1395
	return 1;
L
Linus Torvalds 已提交
1396
}
1397
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1398

J
Jeff Layton 已提交
1399
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
1400 1401
const char
*rpc_proc_name(const struct rpc_task *task)
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
{
	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 已提交
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
/*
 * 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;

1426
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1427
			clnt->cl_program->name, clnt->cl_vers,
1428
			rpc_proc_name(task),
1429
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442

	/* 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)
{
1443
	dprint_status(task);
L
Linus Torvalds 已提交
1444 1445 1446 1447 1448 1449

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

1450 1451
static void call_retry_reserve(struct rpc_task *task);

L
Linus Torvalds 已提交
1452 1453 1454 1455 1456 1457 1458 1459
/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1460
	dprint_status(task);
L
Linus Torvalds 已提交
1461 1462 1463 1464 1465 1466 1467 1468

	/*
	 * 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) {
1469
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1470 1471 1472 1473
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1474
				__func__, status);
L
Linus Torvalds 已提交
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
		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",
1485
				__func__, status);
L
Linus Torvalds 已提交
1486 1487 1488 1489
		xprt_release(task);
	}

	switch (status) {
1490 1491
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1492
	case -EAGAIN:	/* woken up; retry */
1493
		task->tk_action = call_retry_reserve;
L
Linus Torvalds 已提交
1494 1495 1496 1497 1498
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1499
				__func__, status);
L
Linus Torvalds 已提交
1500 1501 1502 1503 1504
		break;
	}
	rpc_exit(task, status);
}

1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
/*
 * 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 已提交
1518
/*
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
 * 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;
1543
	task->tk_action = call_refresh;
1544
	switch (status) {
1545
	case 0:
1546
		if (rpcauth_uptodatecred(task)) {
1547
			task->tk_action = call_allocate;
1548 1549 1550 1551 1552
			return;
		}
		/* Use rate-limiting and a max number of retries if refresh
		 * had status 0 but failed to update the cred.
		 */
1553 1554
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1555 1556
	case -EAGAIN:
		status = -EACCES;
1557
	case -EKEYEXPIRED:
1558 1559 1560 1561 1562 1563
		if (!task->tk_cred_retry)
			break;
		task->tk_cred_retry--;
		dprintk("RPC: %5u %s: retry refresh creds\n",
				task->tk_pid, __func__);
		return;
1564
	}
1565 1566 1567
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1568 1569 1570 1571
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1572
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1573 1574 1575 1576
 */
static void
call_allocate(struct rpc_task *task)
{
1577
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1578
	struct rpc_rqst *req = task->tk_rqstp;
1579
	struct rpc_xprt *xprt = req->rq_xprt;
1580
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1581

1582 1583
	dprint_status(task);

1584
	task->tk_status = 0;
1585
	task->tk_action = call_bind;
1586

1587
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1588 1589
		return;

1590 1591 1592 1593 1594
	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 已提交
1595

1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
	/*
	 * 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;

1606 1607
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1608
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1609
		return;
C
Chuck Lever 已提交
1610
	xprt_inject_disconnect(xprt);
1611 1612

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

1614
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1615
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1616 1617 1618 1619 1620 1621 1622
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
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;
1633
	task->tk_rqstp->rq_bytes_sent = 0;
1634 1635
}

1636 1637 1638 1639 1640 1641 1642
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;
1643
	buf->flags = 0;
1644 1645 1646 1647
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1648 1649 1650 1651
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1652
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1653 1654
{
	struct rpc_rqst	*req = task->tk_rqstp;
1655
	kxdreproc_t	encode;
1656
	__be32		*p;
L
Linus Torvalds 已提交
1657

1658
	dprint_status(task);
L
Linus Torvalds 已提交
1659

1660 1661 1662 1663 1664 1665
	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 已提交
1666

1667 1668 1669
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1670 1671 1672
		rpc_exit(task, -EIO);
		return;
	}
1673 1674

	encode = task->tk_msg.rpc_proc->p_encode;
1675 1676 1677 1678 1679
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1680 1681 1682 1683 1684 1685 1686 1687
}

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

1690
	dprint_status(task);
L
Linus Torvalds 已提交
1691

1692
	task->tk_action = call_connect;
1693
	if (!xprt_bound(xprt)) {
1694
		task->tk_action = call_bind_status;
1695
		task->tk_timeout = xprt->bind_timeout;
1696
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1697 1698 1699 1700
	}
}

/*
1701 1702 1703 1704 1705
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1706
	int status = -EIO;
1707 1708

	if (task->tk_status >= 0) {
1709
		dprint_status(task);
1710 1711 1712 1713 1714
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1715
	trace_rpc_bind_status(task);
1716
	switch (task->tk_status) {
1717 1718 1719
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1720
		goto retry_timeout;
1721
	case -EACCES:
1722 1723
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1724 1725 1726 1727 1728
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1729 1730 1731
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1732
		rpc_delay(task, 3*HZ);
1733
		goto retry_timeout;
1734
	case -ETIMEDOUT:
1735
		dprintk("RPC: %5u rpcbind request timed out\n",
1736
				task->tk_pid);
1737
		goto retry_timeout;
1738
	case -EPFNOSUPPORT:
1739
		/* server doesn't support any rpcbind version we know of */
1740
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1741 1742 1743
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1744
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1745
				task->tk_pid);
1746
		goto retry_timeout;
1747 1748
	case -ECONNREFUSED:		/* connection problems */
	case -ECONNRESET:
1749
	case -ECONNABORTED:
1750 1751 1752 1753
	case -ENOTCONN:
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
1754
	case -ENOBUFS:
1755 1756 1757 1758 1759 1760 1761 1762 1763
	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;
1764
	default:
1765
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1766 1767 1768 1769 1770 1771
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1772
retry_timeout:
1773
	task->tk_status = 0;
1774
	task->tk_action = call_timeout;
1775 1776 1777 1778
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1779 1780 1781 1782
 */
static void
call_connect(struct rpc_task *task)
{
1783
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1784

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

1789 1790 1791 1792 1793
	task->tk_action = call_transmit;
	if (!xprt_connected(xprt)) {
		task->tk_action = call_connect_status;
		if (task->tk_status < 0)
			return;
1794 1795 1796 1797
		if (task->tk_flags & RPC_TASK_NOCONNECT) {
			rpc_exit(task, -ENOTCONN);
			return;
		}
1798
		xprt_connect(task);
L
Linus Torvalds 已提交
1799 1800 1801 1802
	}
}

/*
1803
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1804 1805 1806 1807 1808 1809 1810
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1811
	dprint_status(task);
1812

1813
	trace_rpc_connect_status(task, status);
1814
	task->tk_status = 0;
L
Linus Torvalds 已提交
1815
	switch (status) {
1816 1817
	case -ECONNREFUSED:
	case -ECONNRESET:
1818
	case -ECONNABORTED:
1819
	case -ENETUNREACH:
1820
	case -EHOSTUNREACH:
1821
	case -EADDRINUSE:
1822
	case -ENOBUFS:
1823
	case -EPIPE:
1824 1825
		if (RPC_IS_SOFTCONN(task))
			break;
1826 1827
		/* retry with existing socket, after a delay */
		rpc_delay(task, 3*HZ);
1828
	case -EAGAIN:
1829 1830 1831
		/* Check for timeouts before looping back to call_bind */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1832 1833
		return;
	case 0:
1834 1835 1836
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
L
Linus Torvalds 已提交
1837
	}
1838
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1839 1840 1841 1842 1843 1844 1845 1846
}

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

1849
	dprint_status(task);
L
Linus Torvalds 已提交
1850 1851 1852 1853

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
1854
	if (!xprt_prepare_transmit(task))
L
Linus Torvalds 已提交
1855
		return;
1856
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1857
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1858
	if (rpc_task_need_encode(task)) {
1859
		rpc_xdr_encode(task);
1860
		/* Did the encode result in an error condition? */
1861 1862 1863 1864 1865 1866
		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);
1867
			return;
1868
		}
1869
	}
L
Linus Torvalds 已提交
1870 1871 1872
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1873 1874
	if (is_retrans)
		task->tk_client->cl_stats->rpcretrans++;
1875 1876 1877 1878 1879
	/*
	 * 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);
1880
	if (rpc_reply_expected(task))
1881 1882
		return;
	task->tk_action = rpc_exit_task;
1883
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1884 1885 1886 1887 1888 1889 1890 1891 1892
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903

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

1904 1905
	switch (task->tk_status) {
	case -EAGAIN:
1906
	case -ENOBUFS:
1907 1908
		break;
	default:
1909
		dprint_status(task);
1910
		xprt_end_transmit(task);
1911 1912
		rpc_task_force_reencode(task);
		break;
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922
		/*
		 * 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:
1923
	case -EPERM:
1924 1925 1926 1927 1928 1929
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
1930
	case -ECONNABORTED:
1931
	case -EADDRINUSE:
1932
	case -ENOTCONN:
1933
	case -EPIPE:
1934 1935
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1936 1937
}

1938
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1939 1940 1941 1942 1943 1944 1945 1946 1947
/*
 * 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;

1948 1949
	if (!xprt_prepare_transmit(task))
		goto out_retry;
1950 1951 1952 1953

	if (task->tk_status < 0) {
		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
			"error: %d\n", task->tk_status);
1954
		goto out_done;
1955
	}
1956 1957
	if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
		req->rq_bytes_sent = 0;
1958 1959

	xprt_transmit(task);
1960 1961 1962 1963

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

1964 1965 1966 1967 1968 1969 1970 1971
	xprt_end_transmit(task);
	dprint_status(task);
	switch (task->tk_status) {
	case 0:
		/* Success */
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
1972 1973 1974 1975 1976 1977
	case -ECONNRESET:
	case -ECONNREFUSED:
	case -EADDRINUSE:
	case -ENOTCONN:
	case -EPIPE:
		break;
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
	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);
1988
		xprt_conditional_disconnect(req->rq_xprt,
1989 1990 1991 1992 1993 1994 1995
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1996
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1997 1998 1999 2000 2001
		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);
2002 2003 2004 2005 2006 2007 2008
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;
2009
}
2010
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
2011

L
Linus Torvalds 已提交
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
/*
 * 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;

2022 2023
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
2024

2025
	dprint_status(task);
L
Linus Torvalds 已提交
2026 2027 2028 2029 2030 2031 2032

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

2033
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
2034 2035
	task->tk_status = 0;
	switch(status) {
2036 2037 2038
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
2039
	case -EPERM:
2040 2041 2042 2043
		if (RPC_IS_SOFTCONN(task)) {
			rpc_exit(task, status);
			break;
		}
2044 2045 2046 2047 2048
		/*
		 * Delay any retries for 3 seconds, then handle as if it
		 * were a timeout.
		 */
		rpc_delay(task, 3*HZ);
L
Linus Torvalds 已提交
2049 2050
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
2051 2052
		if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
		    && task->tk_client->cl_discrtry)
2053
			xprt_conditional_disconnect(req->rq_xprt,
2054
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
2055 2056
		break;
	case -ECONNREFUSED:
2057 2058
	case -ECONNRESET:
	case -ECONNABORTED:
2059
		rpc_force_rebind(clnt);
2060
	case -EADDRINUSE:
2061 2062 2063
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
2064 2065
		task->tk_action = call_bind;
		break;
2066 2067
	case -ENOBUFS:
		rpc_delay(task, HZ>>2);
L
Linus Torvalds 已提交
2068 2069 2070 2071 2072 2073 2074 2075
	case -EAGAIN:
		task->tk_action = call_transmit;
		break;
	case -EIO:
		/* shutdown or soft timeout */
		rpc_exit(task, status);
		break;
	default:
O
Olga Kornievskaia 已提交
2076 2077
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
2078
			       clnt->cl_program->name, -status);
L
Linus Torvalds 已提交
2079 2080 2081 2082 2083
		rpc_exit(task, status);
	}
}

/*
2084
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
2085 2086 2087 2088 2089 2090 2091 2092 2093
 * 	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) {
2094
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
2095 2096 2097
		goto retry;
	}

2098
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
2099 2100
	task->tk_timeouts++;

2101 2102 2103 2104
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
2105
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
2106
		if (clnt->cl_chatty) {
2107
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2108
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
2109
				clnt->cl_program->name,
2110 2111
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
J
Joe Perches 已提交
2112
		}
2113 2114 2115 2116
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
2117 2118 2119
		return;
	}

C
Chuck Lever 已提交
2120
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
2121
		task->tk_flags |= RPC_CALL_MAJORSEEN;
2122 2123
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2124
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
2125
			clnt->cl_program->name,
2126 2127 2128
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
2129
	}
2130
	rpc_force_rebind(clnt);
2131 2132 2133 2134 2135
	/*
	 * 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 已提交
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149

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

2153
	dprint_status(task);
L
Linus Torvalds 已提交
2154

C
Chuck Lever 已提交
2155
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2156 2157
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
2158
			printk(KERN_NOTICE "%s: server %s OK\n",
2159
				clnt->cl_program->name,
2160 2161 2162
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
2163 2164 2165
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

2166 2167
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
2168
	 * before it changed req->rq_reply_bytes_recvd.
2169 2170
	 */
	smp_rmb();
L
Linus Torvalds 已提交
2171 2172 2173 2174 2175 2176
	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);

2177 2178 2179 2180 2181 2182
	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",
2183
				clnt->cl_program->name, task->tk_status);
2184 2185 2186 2187
		task->tk_action = call_timeout;
		goto out_retry;
	}

2188
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2189 2190 2191 2192
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2193 2194
	}

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

2197
	if (decode) {
L
Linus Torvalds 已提交
2198 2199
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
2200
	}
2201 2202
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
2203 2204 2205
	return;
out_retry:
	task->tk_status = 0;
2206
	/* Note: rpc_verify_header() may have freed the RPC slot */
2207
	if (task->tk_rqstp == req) {
2208
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2209
		if (task->tk_client->cl_discrtry)
2210
			xprt_conditional_disconnect(req->rq_xprt,
2211
					req->rq_connect_cookie);
2212
	}
L
Linus Torvalds 已提交
2213 2214
}

2215
static __be32 *
2216
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2217 2218 2219
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2220
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2221 2222

	/* FIXME: check buffer size? */
2223

2224
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2225 2226 2227 2228 2229 2230
	*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 */
2231 2232 2233
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2234 2235
}

2236
static __be32 *
2237
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2238
{
2239
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2240 2241
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2242 2243
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2244 2245
	int error = -EACCES;

2246 2247 2248 2249 2250 2251
	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
		 */
2252
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2253
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2254
		       task->tk_rqstp->rq_rcv_buf.len);
2255 2256
		error = -EIO;
		goto out_err;
2257
	}
L
Linus Torvalds 已提交
2258 2259 2260
	if ((len -= 3) < 0)
		goto out_overflow;

2261
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2262
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2263
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2264
			task->tk_pid, __func__, n);
2265
		error = -EIO;
T
Trond Myklebust 已提交
2266
		goto out_garbage;
L
Linus Torvalds 已提交
2267
	}
2268

L
Linus Torvalds 已提交
2269 2270 2271 2272
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
J
Joe Perches 已提交
2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
		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);
2284 2285
			error = -EIO;
			goto out_err;
L
Linus Torvalds 已提交
2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
		}
		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--;
2297
			dprintk("RPC: %5u %s: retry stale creds\n",
2298
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2299
			rpcauth_invalcred(task);
2300 2301
			/* Ensure we obtain a new XID! */
			xprt_release(task);
2302
			task->tk_action = call_reserve;
T
Trond Myklebust 已提交
2303
			goto out_retry;
L
Linus Torvalds 已提交
2304 2305 2306 2307 2308 2309
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
2310
			dprintk("RPC: %5u %s: retry garbled creds\n",
2311
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2312
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
2313
			goto out_retry;
L
Linus Torvalds 已提交
2314
		case RPC_AUTH_TOOWEAK:
2315
			rcu_read_lock();
2316
			printk(KERN_NOTICE "RPC: server %s requires stronger "
2317 2318 2319
			       "authentication.\n",
			       rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
L
Linus Torvalds 已提交
2320 2321
			break;
		default:
2322
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
2323
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2324 2325
			error = -EIO;
		}
2326
		dprintk("RPC: %5u %s: call rejected %d\n",
2327
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2328 2329
		goto out_err;
	}
2330 2331 2332 2333 2334
	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 已提交
2335
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
2336
	}
2337
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
2338 2339 2340 2341 2342 2343
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
2344 2345 2346 2347
		dprintk_rcu("RPC: %5u %s: program %u is unsupported "
				"by server %s\n", task->tk_pid, __func__,
				(unsigned int)clnt->cl_prog,
				rcu_dereference(clnt->cl_xprt)->servername);
2348 2349
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2350
	case RPC_PROG_MISMATCH:
2351 2352 2353 2354 2355
		dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
				"by server %s\n", task->tk_pid, __func__,
				(unsigned int)clnt->cl_prog,
				(unsigned int)clnt->cl_vers,
				rcu_dereference(clnt->cl_xprt)->servername);
2356 2357
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2358
	case RPC_PROC_UNAVAIL:
2359
		dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2360
				"version %u on server %s\n",
2361
				task->tk_pid, __func__,
2362
				rpc_proc_name(task),
2363 2364
				clnt->cl_prog, clnt->cl_vers,
				rcu_dereference(clnt->cl_xprt)->servername);
2365 2366
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
2367
	case RPC_GARBAGE_ARGS:
2368
		dprintk("RPC: %5u %s: server saw garbage\n",
2369
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2370 2371
		break;			/* retry */
	default:
2372
		dprintk("RPC: %5u %s: server accept status: %x\n",
2373
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2374 2375 2376
		/* Also retry */
	}

T
Trond Myklebust 已提交
2377
out_garbage:
2378
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2379 2380
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2381
		dprintk("RPC: %5u %s: retrying\n",
2382
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2383
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2384 2385
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2386 2387 2388
	}
out_err:
	rpc_exit(task, error);
2389
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2390
			__func__, error);
T
Trond Myklebust 已提交
2391
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2392
out_overflow:
2393
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2394
			__func__);
T
Trond Myklebust 已提交
2395
	goto out_garbage;
L
Linus Torvalds 已提交
2396
}
2397

2398
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2399 2400 2401
{
}

2402
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2403 2404 2405 2406 2407 2408 2409 2410 2411
{
	return 0;
}

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

2412
static int rpc_ping(struct rpc_clnt *clnt)
2413 2414 2415 2416 2417 2418
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2419
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2420 2421 2422
	put_rpccred(msg.rpc_cred);
	return err;
}
2423

2424 2425 2426 2427 2428 2429
struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
		.rpc_cred = cred,
	};
2430 2431 2432 2433 2434 2435
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2436
	return rpc_run_task(&task_setup_data);
2437
}
2438
EXPORT_SYMBOL_GPL(rpc_call_null);
2439

J
Jeff Layton 已提交
2440
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
2441 2442
static void rpc_show_header(void)
{
2443 2444
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2445 2446
}

C
Chuck Lever 已提交
2447 2448 2449 2450 2451 2452 2453 2454
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);

2455
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2456 2457
		task->tk_pid, task->tk_flags, task->tk_status,
		clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2458
		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2459
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2460 2461
}

2462
void rpc_show_tasks(struct net *net)
2463 2464
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2465
	struct rpc_task *task;
2466
	int header = 0;
2467
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2468

2469 2470
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2471
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2472
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2473 2474 2475 2476
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2477
			rpc_show_task(clnt, task);
2478 2479 2480
		}
		spin_unlock(&clnt->cl_lock);
	}
2481
	spin_unlock(&sn->rpc_client_lock);
2482 2483
}
#endif
2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506

#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
int
rpc_clnt_swap_activate(struct rpc_clnt *clnt)
{
	int ret = 0;
	struct rpc_xprt	*xprt;

	if (atomic_inc_return(&clnt->cl_swapper) == 1) {
retry:
		rcu_read_lock();
		xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
		if (!xprt) {
			/*
			 * If we didn't get a reference, then we likely are
			 * racing with a migration event. Wait for a grace
			 * period and try again.
			 */
			synchronize_rcu();
			goto retry;
		}

2507
		ret = xprt_enable_swap(xprt);
2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533
		xprt_put(xprt);
	}
	return ret;
}
EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);

void
rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
{
	struct rpc_xprt	*xprt;

	if (atomic_dec_if_positive(&clnt->cl_swapper) == 0) {
retry:
		rcu_read_lock();
		xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
		if (!xprt) {
			/*
			 * If we didn't get a reference, then we likely are
			 * racing with a migration event. Wait for a grace
			 * period and try again.
			 */
			synchronize_rcu();
			goto retry;
		}

2534
		xprt_disable_swap(xprt);
2535 2536 2537 2538 2539
		xprt_put(xprt);
	}
}
EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
#endif /* CONFIG_SUNRPC_SWAP */