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


#include <linux/module.h>
#include <linux/types.h>
23
#include <linux/kallsyms.h>
L
Linus Torvalds 已提交
24
#include <linux/mm.h>
25 26
#include <linux/namei.h>
#include <linux/mount.h>
L
Linus Torvalds 已提交
27 28
#include <linux/slab.h>
#include <linux/utsname.h>
29
#include <linux/workqueue.h>
30
#include <linux/in.h>
31
#include <linux/in6.h>
32
#include <linux/un.h>
33
#include <linux/rcupdate.h>
L
Linus Torvalds 已提交
34 35

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

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

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

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

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

L
Linus Torvalds 已提交
57 58 59 60 61 62 63 64 65
static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);


static void	call_start(struct rpc_task *task);
static void	call_reserve(struct rpc_task *task);
static void	call_reserveresult(struct rpc_task *task);
static void	call_allocate(struct rpc_task *task);
static void	call_decode(struct rpc_task *task);
static void	call_bind(struct rpc_task *task);
66
static void	call_bind_status(struct rpc_task *task);
L
Linus Torvalds 已提交
67
static void	call_transmit(struct rpc_task *task);
68
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
69
static void	call_bc_transmit(struct rpc_task *task);
70
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
L
Linus Torvalds 已提交
71
static void	call_status(struct rpc_task *task);
72
static void	call_transmit_status(struct rpc_task *task);
L
Linus Torvalds 已提交
73 74 75 76 77 78
static void	call_refresh(struct rpc_task *task);
static void	call_refreshresult(struct rpc_task *task);
static void	call_timeout(struct rpc_task *task);
static void	call_connect(struct rpc_task *task);
static void	call_connect_status(struct rpc_task *task);

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

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

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

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

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

103 104
static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
{
105
	if (clnt->cl_dentry) {
106 107
		if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
			clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
108
		rpc_remove_client_dir(clnt->cl_dentry);
109
	}
110
	clnt->cl_dentry = NULL;
111 112 113 114
}

static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
{
115
	struct net *net = rpc_net_ns(clnt);
116 117
	struct super_block *pipefs_sb;

118
	pipefs_sb = rpc_get_sb_net(net);
119 120
	if (pipefs_sb) {
		__rpc_clnt_remove_pipedir(clnt);
121
		rpc_put_sb_net(net);
122 123 124 125
	}
}

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

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

static int
156
rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
157
{
158
	struct dentry *dentry;
159

160 161
	if (clnt->cl_program->pipe_dir_name == NULL)
		goto out;
162
	clnt->cl_dentry = NULL;
163
	dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
164 165 166
	if (IS_ERR(dentry))
		return PTR_ERR(dentry);
	clnt->cl_dentry = dentry;
167
out:
168
	return 0;
L
Linus Torvalds 已提交
169 170
}

171
static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
172
{
173 174 175
	if (clnt->cl_program->pipe_dir_name == NULL)
		return 1;

176 177 178
	if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
	    ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
		return 1;
179 180
	if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
		return 1;
181 182 183 184 185
	return 0;
}

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

	switch (event) {
	case RPC_PIPEFS_MOUNT:
192
		dentry = rpc_setup_pipedir_sb(sb, clnt);
193 194
		if (!dentry)
			return -ENOENT;
195 196
		if (IS_ERR(dentry))
			return PTR_ERR(dentry);
197
		clnt->cl_dentry = dentry;
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
		if (clnt->cl_auth->au_ops->pipes_create) {
			err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
			if (err)
				__rpc_clnt_remove_pipedir(clnt);
		}
		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;
}

214 215 216 217 218 219 220 221 222 223 224 225 226 227
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;
}

228 229 230 231 232 233 234
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) {
235
		if (rpc_clnt_skip_event(clnt, event))
236 237 238 239 240 241 242 243
			continue;
		spin_unlock(&sn->rpc_client_lock);
		return clnt;
	}
	spin_unlock(&sn->rpc_client_lock);
	return NULL;
}

244 245 246 247 248 249 250
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;

251
	while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
252 253 254 255 256 257 258 259 260
		error = __rpc_pipefs_event(clnt, event, sb);
		if (error)
			break;
	}
	return error;
}

static struct notifier_block rpc_clients_block = {
	.notifier_call	= rpc_pipefs_event,
261
	.priority	= SUNRPC_PIPEFS_RPC_PRIO,
262 263 264 265 266 267 268 269 270 271 272 273
};

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

274 275 276 277 278 279 280 281
static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
{
	clnt->cl_nodelen = strlen(nodename);
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
	memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
}

282 283 284 285 286 287
static int rpc_client_register(const struct rpc_create_args *args,
			       struct rpc_clnt *clnt)
{
	struct rpc_auth *auth;
	struct net *net = rpc_net_ns(clnt);
	struct super_block *pipefs_sb;
288
	int err;
289 290 291

	pipefs_sb = rpc_get_sb_net(net);
	if (pipefs_sb) {
292
		err = rpc_setup_pipedir(pipefs_sb, clnt);
293 294 295 296
		if (err)
			goto out;
	}

297 298 299 300
	rpc_register_client(clnt);
	if (pipefs_sb)
		rpc_put_sb_net(net);

301 302 303 304 305 306 307
	auth = rpcauth_create(args->authflavor, clnt);
	if (IS_ERR(auth)) {
		dprintk("RPC:       Couldn't create auth handle (flavor %u)\n",
				args->authflavor);
		err = PTR_ERR(auth);
		goto err_auth;
	}
308 309 310
	return 0;
err_auth:
	pipefs_sb = rpc_get_sb_net(net);
311
	rpc_unregister_client(clnt);
312
	__rpc_clnt_remove_pipedir(clnt);
313 314 315 316 317 318
out:
	if (pipefs_sb)
		rpc_put_sb_net(net);
	return err;
}

319
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
320
{
321 322
	const struct rpc_program *program = args->program;
	const struct rpc_version *version;
L
Linus Torvalds 已提交
323 324
	struct rpc_clnt		*clnt = NULL;
	int err;
325 326

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

330 331 332
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
333

334
	err = -EINVAL;
335 336 337 338
	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
339 340 341
		goto out_err;

	err = -ENOMEM;
342
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
343 344 345 346
	if (!clnt)
		goto out_err;
	clnt->cl_parent = clnt;

347
	rcu_assign_pointer(clnt->cl_xprt, xprt);
L
Linus Torvalds 已提交
348 349
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
350
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
351 352
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
353
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
354 355 356
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
357
	clnt->cl_program  = program;
358
	INIT_LIST_HEAD(&clnt->cl_tasks);
359
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
360

361
	if (!xprt_bound(xprt))
L
Linus Torvalds 已提交
362 363
		clnt->cl_autobind = 1;

364 365 366 367 368 369 370
	clnt->cl_timeout = xprt->timeout;
	if (args->timeout != NULL) {
		memcpy(&clnt->cl_timeout_default, args->timeout,
				sizeof(clnt->cl_timeout_default));
		clnt->cl_timeout = &clnt->cl_timeout_default;
	}

L
Linus Torvalds 已提交
371
	clnt->cl_rtt = &clnt->cl_rtt_default;
372
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
373 374 375 376 377 378
	clnt->cl_principal = NULL;
	if (args->client_name) {
		clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
		if (!clnt->cl_principal)
			goto out_no_principal;
	}
L
Linus Torvalds 已提交
379

380
	atomic_set(&clnt->cl_count, 1);
381

L
Linus Torvalds 已提交
382
	/* save the nodename */
383
	rpc_clnt_set_nodename(clnt, utsname()->nodename);
384 385 386 387

	err = rpc_client_register(args, clnt);
	if (err)
		goto out_no_path;
L
Linus Torvalds 已提交
388 389 390
	return clnt;

out_no_path:
391 392
	kfree(clnt->cl_principal);
out_no_principal:
393 394
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
L
Linus Torvalds 已提交
395 396
	kfree(clnt);
out_err:
397 398
	rpciod_down();
out_no_rpciod:
399
	xprt_put(xprt);
L
Linus Torvalds 已提交
400 401 402
	return ERR_PTR(err);
}

403
/**
404 405 406 407 408 409 410 411 412 413 414 415 416
 * rpc_create - create an RPC client and transport with one call
 * @args: rpc_clnt create argument structure
 *
 * Creates and initializes an RPC transport and an RPC client.
 *
 * It can ping the server in order to determine if it is up, and to see if
 * it supports this program and version.  RPC_CLNT_CREATE_NOPING disables
 * this behavior so asynchronous tasks can also use rpc_create.
 */
struct rpc_clnt *rpc_create(struct rpc_create_args *args)
{
	struct rpc_xprt *xprt;
	struct rpc_clnt *clnt;
417
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
418
		.net = args->net,
419
		.ident = args->protocol,
420
		.srcaddr = args->saddress,
421 422
		.dstaddr = args->address,
		.addrlen = args->addrsize,
423
		.servername = args->servername,
424
		.bc_xprt = args->bc_xprt,
425
	};
426
	char servername[48];
427

428 429
	if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
		xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
430 431
	if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
		xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
432 433 434 435
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
436
	if (xprtargs.servername == NULL) {
437 438
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
439 440 441 442 443
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

444 445
		servername[0] = '\0';
		switch (args->address->sa_family) {
446 447 448 449
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
450
		case AF_INET:
H
Harvey Harrison 已提交
451 452
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
453
			break;
454
		case AF_INET6:
H
Harvey Harrison 已提交
455
			snprintf(servername, sizeof(servername), "%pI6",
456
				 &sin6->sin6_addr);
457 458 459 460 461 462
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
463
		xprtargs.servername = servername;
464 465
	}

466 467 468 469
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

470 471 472 473 474 475 476 477 478 479
	/*
	 * 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;

480
	clnt = rpc_new_client(args, xprt);
481 482 483 484
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
485
		int err = rpc_ping(clnt);
486 487 488 489 490 491 492 493 494 495 496 497
		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;
498 499
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
500 501
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
502 503 504

	return clnt;
}
505
EXPORT_SYMBOL_GPL(rpc_create);
506

L
Linus Torvalds 已提交
507 508 509 510 511
/*
 * 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 已提交
512 513
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
514
{
515
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
516 517
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
518

C
Chuck Lever 已提交
519
	err = -ENOMEM;
520 521 522 523
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
	rcu_read_unlock();
	if (xprt == NULL)
C
Chuck Lever 已提交
524 525 526 527 528 529
		goto out_err;
	args->servername = xprt->servername;

	new = rpc_new_client(args, xprt);
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
530
		goto out_err;
C
Chuck Lever 已提交
531 532
	}

533
	atomic_inc(&clnt->cl_count);
C
Chuck Lever 已提交
534 535 536 537 538 539 540
	new->cl_parent = clnt;

	/* Turn off autobind on clones */
	new->cl_autobind = 0;
	new->cl_softrtry = clnt->cl_softrtry;
	new->cl_discrtry = clnt->cl_discrtry;
	new->cl_chatty = clnt->cl_chatty;
L
Linus Torvalds 已提交
541
	return new;
C
Chuck Lever 已提交
542 543

out_err:
544
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
545
	return ERR_PTR(err);
L
Linus Torvalds 已提交
546
}
C
Chuck Lever 已提交
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

/**
 * 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,
		.client_name	= clnt->cl_principal,
	};
	return __rpc_clone_client(&args, clnt);
}
566
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
567

568 569 570 571
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
572
 * @flavor: security flavor for new client
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
 *
 * 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,
		.client_name	= clnt->cl_principal,
	};
	return __rpc_clone_client(&args, clnt);
}
EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
/*
 * 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);
612 613 614
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
615 616 617 618 619 620
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
621 622
/*
 * Properly shut down an RPC client, terminating all outstanding
623
 * requests.
L
Linus Torvalds 已提交
624
 */
625
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
626
{
627 628
	might_sleep();

629
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
630
			clnt->cl_program->name,
631
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
632

633
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
634
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
635
		wait_event_timeout(destroy_wait,
636
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
637 638
	}

639
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
640
}
641
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
642 643

/*
644
 * Free an RPC client
L
Linus Torvalds 已提交
645
 */
646
static void
647
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
648
{
649
	dprintk_rcu("RPC:       destroying %s client for %s\n",
650
			clnt->cl_program->name,
651
			rcu_dereference(clnt->cl_xprt)->servername);
652
	if (clnt->cl_parent != clnt)
653
		rpc_release_client(clnt->cl_parent);
654
	rpc_clnt_remove_pipedir(clnt);
655
	rpc_unregister_client(clnt);
656
	rpc_free_iostats(clnt->cl_metrics);
657
	kfree(clnt->cl_principal);
658
	clnt->cl_metrics = NULL;
659
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
660
	rpciod_down();
L
Linus Torvalds 已提交
661 662 663
	kfree(clnt);
}

664 665 666 667
/*
 * Free an RPC client
 */
static void
668
rpc_free_auth(struct rpc_clnt *clnt)
669 670
{
	if (clnt->cl_auth == NULL) {
671
		rpc_free_client(clnt);
672 673 674 675 676 677 678 679
		return;
	}

	/*
	 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
	 *       release remaining GSS contexts. This mechanism ensures
	 *       that it can do so safely.
	 */
680
	atomic_inc(&clnt->cl_count);
681 682
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
683 684
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
685 686
}

L
Linus Torvalds 已提交
687
/*
688
 * Release reference to the RPC client
L
Linus Torvalds 已提交
689 690 691 692
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
693
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
694

695 696
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
697 698
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_auth(clnt);
699
}
700
EXPORT_SYMBOL_GPL(rpc_release_client);
701

702 703
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
704 705 706
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
707 708 709 710 711 712
 *
 * 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,
713
				      const struct rpc_program *program,
714
				      u32 vers)
715
{
716 717 718 719 720 721 722
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
		.client_name	= old->cl_principal,
	};
723 724 725
	struct rpc_clnt *clnt;
	int err;

726
	clnt = __rpc_clone_client(&args, old);
727 728
	if (IS_ERR(clnt))
		goto out;
729
	err = rpc_ping(clnt);
730 731 732 733
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
734
out:
735 736
	return clnt;
}
737
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
738

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
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;
760
		atomic_inc(&clnt->cl_count);
761 762
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
M
Mel Gorman 已提交
763 764 765 766 767 768 769 770 771
		if (sk_memalloc_socks()) {
			struct rpc_xprt *xprt;

			rcu_read_lock();
			xprt = rcu_dereference(clnt->cl_xprt);
			if (xprt->swapper)
				task->tk_flags |= RPC_TASK_SWAPPER;
			rcu_read_unlock();
		}
772 773 774 775 776 777 778
		/* 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);
	}
}

779 780 781 782 783 784 785 786
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);


787 788 789 790 791 792 793
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;
794 795
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
796 797 798
	}
}

L
Linus Torvalds 已提交
799 800 801 802
/*
 * Default callback for async RPC calls
 */
static void
803
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
804 805 806
{
}

807 808 809 810
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
811 812 813 814 815
/**
 * 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)
816
{
817
	struct rpc_task *task;
818

819
	task = rpc_new_task(task_setup_data);
820
	if (IS_ERR(task))
821
		goto out;
822

823 824 825 826 827 828
	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);

829 830 831
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
832
	return task;
833
}
T
Trond Myklebust 已提交
834
EXPORT_SYMBOL_GPL(rpc_run_task);
835 836 837 838 839 840

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
841
 */
842
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
843 844
{
	struct rpc_task	*task;
845 846 847 848 849 850
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
851
	int status;
L
Linus Torvalds 已提交
852

853 854 855 856 857 858
	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 已提交
859

T
Trond Myklebust 已提交
860
	task = rpc_run_task(&task_setup_data);
861 862
	if (IS_ERR(task))
		return PTR_ERR(task);
863
	status = task->tk_status;
864
	rpc_put_task(task);
L
Linus Torvalds 已提交
865 866
	return status;
}
867
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
868

869 870 871 872 873
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
874
 * @tk_ops: RPC call ops
875
 * @data: user call data
L
Linus Torvalds 已提交
876 877
 */
int
878
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
879
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
880 881
{
	struct rpc_task	*task;
882 883 884 885 886 887 888
	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 已提交
889

T
Trond Myklebust 已提交
890
	task = rpc_run_task(&task_setup_data);
891 892 893 894
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
895
}
896
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
897

898
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
899 900 901
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
902 903
 * @req: RPC request
 * @tk_ops: RPC call ops
904 905
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
906
				const struct rpc_call_ops *tk_ops)
907 908 909 910 911 912 913 914 915 916 917 918
{
	struct rpc_task *task;
	struct xdr_buf *xbufp = &req->rq_snd_buf;
	struct rpc_task_setup task_setup_data = {
		.callback_ops = tk_ops,
	};

	dprintk("RPC: rpc_run_bc_task req= %p\n", req);
	/*
	 * Create an rpc_task to send the data
	 */
	task = rpc_new_task(&task_setup_data);
919
	if (IS_ERR(task)) {
920 921 922 923 924 925 926 927 928 929 930 931 932 933
		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);
934
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
935 936 937 938 939 940
	rpc_execute(task);

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

943 944 945 946 947 948 949
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

950 951 952 953
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
954
 * @bufsize: length of target buffer
955 956 957 958 959 960
 *
 * 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;
961 962 963 964
	struct rpc_xprt *xprt;

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

966
	bytes = xprt->addrlen;
967 968
	if (bytes > bufsize)
		bytes = bufsize;
969 970 971 972
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
973
}
974
EXPORT_SYMBOL_GPL(rpc_peeraddr);
975

976 977 978 979 980
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
981 982 983
 * 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.
984
 */
985 986
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
987
{
988 989 990
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
991 992 993 994 995

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
996
}
997
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
998

999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
static const struct sockaddr_in rpc_inaddr_loopback = {
	.sin_family		= AF_INET,
	.sin_addr.s_addr	= htonl(INADDR_ANY),
};

static const struct sockaddr_in6 rpc_in6addr_loopback = {
	.sin6_family		= AF_INET6,
	.sin6_addr		= IN6ADDR_ANY_INIT,
};

/*
 * Try a getsockname() on a connected datagram socket.  Using a
 * connected datagram socket prevents leaving a socket in TIME_WAIT.
 * This conserves the ephemeral port number space.
 *
 * Returns zero and fills in "buf" if successful; otherwise, a
 * negative errno is returned.
 */
static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
			struct sockaddr *buf, int buflen)
{
	struct socket *sock;
	int err;

	err = __sock_create(net, sap->sa_family,
				SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
	if (err < 0) {
		dprintk("RPC:       can't create UDP socket (%d)\n", err);
		goto out;
	}

	switch (sap->sa_family) {
	case AF_INET:
		err = kernel_bind(sock,
				(struct sockaddr *)&rpc_inaddr_loopback,
				sizeof(rpc_inaddr_loopback));
		break;
	case AF_INET6:
		err = kernel_bind(sock,
				(struct sockaddr *)&rpc_in6addr_loopback,
				sizeof(rpc_in6addr_loopback));
		break;
	default:
		err = -EAFNOSUPPORT;
		goto out;
	}
	if (err < 0) {
		dprintk("RPC:       can't bind UDP socket (%d)\n", err);
		goto out_release;
	}

	err = kernel_connect(sock, sap, salen, 0);
	if (err < 0) {
		dprintk("RPC:       can't connect UDP socket (%d)\n", err);
		goto out_release;
	}

	err = kernel_getsockname(sock, buf, &buflen);
	if (err < 0) {
		dprintk("RPC:       getsockname failed (%d)\n", err);
		goto out_release;
	}

	err = 0;
	if (buf->sa_family == AF_INET6) {
		struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
		sin6->sin6_scope_id = 0;
	}
	dprintk("RPC:       %s succeeded\n", __func__);

out_release:
	sock_release(sock);
out:
	return err;
}

/*
 * Scraping a connected socket failed, so we don't have a useable
 * local address.  Fallback: generate an address that will prevent
 * the server from calling us back.
 *
 * Returns zero and fills in "buf" if successful; otherwise, a
 * negative errno is returned.
 */
static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
{
	switch (family) {
	case AF_INET:
		if (buflen < sizeof(rpc_inaddr_loopback))
			return -EINVAL;
		memcpy(buf, &rpc_inaddr_loopback,
				sizeof(rpc_inaddr_loopback));
		break;
	case AF_INET6:
		if (buflen < sizeof(rpc_in6addr_loopback))
			return -EINVAL;
		memcpy(buf, &rpc_in6addr_loopback,
				sizeof(rpc_in6addr_loopback));
	default:
		dprintk("RPC:       %s: address family not supported\n",
			__func__);
		return -EAFNOSUPPORT;
	}
	dprintk("RPC:       %s: succeeded\n", __func__);
	return 0;
}

/**
 * rpc_localaddr - discover local endpoint address for an RPC client
 * @clnt: RPC client structure
 * @buf: target buffer
 * @buflen: size of target buffer, in bytes
 *
 * Returns zero and fills in "buf" and "buflen" if successful;
 * otherwise, a negative errno is returned.
 *
 * This works even if the underlying transport is not currently connected,
 * or if the upper layer never previously provided a source address.
 *
 * The result of this function call is transient: multiple calls in
 * succession may give different results, depending on how local
 * networking configuration changes over time.
 */
int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
{
	struct sockaddr_storage address;
	struct sockaddr *sap = (struct sockaddr *)&address;
	struct rpc_xprt *xprt;
	struct net *net;
	size_t salen;
	int err;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
	salen = xprt->addrlen;
	memcpy(sap, &xprt->addr, salen);
	net = get_net(xprt->xprt_net);
	rcu_read_unlock();

	rpc_set_port(sap, 0);
	err = rpc_sockname(net, sap, salen, buf, buflen);
	put_net(net);
	if (err != 0)
		/* Couldn't discover local address, return ANYADDR */
		return rpc_anyaddr(sap->sa_family, buf, buflen);
	return 0;
}
EXPORT_SYMBOL_GPL(rpc_localaddr);

L
Linus Torvalds 已提交
1148 1149 1150
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1151 1152 1153 1154
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1155 1156
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1157
	rcu_read_unlock();
L
Linus Torvalds 已提交
1158
}
1159
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
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
/**
 * 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 已提交
1196 1197 1198 1199 1200 1201 1202 1203
 *
 * 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)
{
1204 1205 1206 1207 1208 1209
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1210
}
1211
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1212

1213
/**
T
Trond Myklebust 已提交
1214
 * rpc_get_timeout - Get timeout for transport in units of HZ
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
 * @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);

1228 1229 1230 1231 1232 1233 1234
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1235 1236 1237 1238 1239
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1240
}
1241
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1242

1243 1244 1245 1246
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1247
int
1248 1249 1250
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1251
		return 0;
1252 1253 1254
	task->tk_action = call_start;
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1255
	return 1;
1256 1257 1258
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1259 1260 1261 1262
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1263
int
L
Linus Torvalds 已提交
1264 1265 1266
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1267
		return 0;
L
Linus Torvalds 已提交
1268
	task->tk_action = call_start;
1269
	return 1;
L
Linus Torvalds 已提交
1270
}
1271
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1272

1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
#ifdef RPC_DEBUG
static const char *rpc_proc_name(const struct rpc_task *task)
{
	const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;

	if (proc) {
		if (proc->p_name)
			return proc->p_name;
		else
			return "NULL";
	} else
		return "no proc";
}
#endif

L
Linus Torvalds 已提交
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
/*
 * 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;

1299
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1300
			clnt->cl_program->name, clnt->cl_vers,
1301
			rpc_proc_name(task),
1302
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315

	/* 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)
{
1316
	dprint_status(task);
L
Linus Torvalds 已提交
1317 1318 1319 1320 1321 1322

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

1323 1324
static void call_retry_reserve(struct rpc_task *task);

L
Linus Torvalds 已提交
1325 1326 1327 1328 1329 1330 1331 1332
/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1333
	dprint_status(task);
L
Linus Torvalds 已提交
1334 1335 1336 1337 1338 1339 1340 1341

	/*
	 * 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) {
1342
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1343 1344 1345 1346
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1347
				__func__, status);
L
Linus Torvalds 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
		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",
1358
				__func__, status);
L
Linus Torvalds 已提交
1359 1360 1361 1362
		xprt_release(task);
	}

	switch (status) {
1363 1364
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1365
	case -EAGAIN:	/* woken up; retry */
1366
		task->tk_action = call_retry_reserve;
L
Linus Torvalds 已提交
1367 1368 1369 1370 1371
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1372
				__func__, status);
L
Linus Torvalds 已提交
1373 1374 1375 1376 1377
		break;
	}
	rpc_exit(task, status);
}

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

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1441
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1442 1443 1444 1445
 */
static void
call_allocate(struct rpc_task *task)
{
1446
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1447
	struct rpc_rqst *req = task->tk_rqstp;
1448
	struct rpc_xprt *xprt = req->rq_xprt;
1449
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1450

1451 1452
	dprint_status(task);

1453
	task->tk_status = 0;
1454
	task->tk_action = call_bind;
1455

1456
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1457 1458
		return;

1459 1460 1461 1462 1463
	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 已提交
1464

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
	/*
	 * 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;

1475 1476
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1477
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1478
		return;
1479 1480

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

1482
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1483
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1484 1485 1486 1487 1488 1489 1490
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
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;
1501
	task->tk_rqstp->rq_bytes_sent = 0;
1502 1503
}

1504 1505 1506 1507 1508 1509 1510
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;
1511
	buf->flags = 0;
1512 1513 1514 1515
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1516 1517 1518 1519
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1520
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1521 1522
{
	struct rpc_rqst	*req = task->tk_rqstp;
1523
	kxdreproc_t	encode;
1524
	__be32		*p;
L
Linus Torvalds 已提交
1525

1526
	dprint_status(task);
L
Linus Torvalds 已提交
1527

1528 1529 1530 1531 1532 1533
	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 已提交
1534

1535 1536 1537
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1538 1539 1540
		rpc_exit(task, -EIO);
		return;
	}
1541 1542

	encode = task->tk_msg.rpc_proc->p_encode;
1543 1544 1545 1546 1547
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1548 1549 1550 1551 1552 1553 1554 1555
}

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

1558
	dprint_status(task);
L
Linus Torvalds 已提交
1559

1560
	task->tk_action = call_connect;
1561
	if (!xprt_bound(xprt)) {
1562
		task->tk_action = call_bind_status;
1563
		task->tk_timeout = xprt->bind_timeout;
1564
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1565 1566 1567 1568
	}
}

/*
1569 1570 1571 1572 1573
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1574
	int status = -EIO;
1575 1576

	if (task->tk_status >= 0) {
1577
		dprint_status(task);
1578 1579 1580 1581 1582
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1583
	trace_rpc_bind_status(task);
1584
	switch (task->tk_status) {
1585 1586 1587
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1588
		goto retry_timeout;
1589
	case -EACCES:
1590 1591
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1592 1593 1594 1595 1596
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1597 1598 1599
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1600
		rpc_delay(task, 3*HZ);
1601
		goto retry_timeout;
1602
	case -ETIMEDOUT:
1603
		dprintk("RPC: %5u rpcbind request timed out\n",
1604
				task->tk_pid);
1605
		goto retry_timeout;
1606
	case -EPFNOSUPPORT:
1607
		/* server doesn't support any rpcbind version we know of */
1608
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1609 1610 1611
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1612
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1613
				task->tk_pid);
1614 1615 1616
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631
	case -ECONNREFUSED:		/* connection problems */
	case -ECONNRESET:
	case -ENOTCONN:
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
	case -EPIPE:
		dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
				task->tk_pid, task->tk_status);
		if (!RPC_IS_SOFTCONN(task)) {
			rpc_delay(task, 5*HZ);
			goto retry_timeout;
		}
		status = task->tk_status;
		break;
1632
	default:
1633
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1634 1635 1636 1637 1638 1639
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1640 1641
retry_timeout:
	task->tk_action = call_timeout;
1642 1643 1644 1645
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1646 1647 1648 1649
 */
static void
call_connect(struct rpc_task *task)
{
1650
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1651

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

1656 1657 1658 1659 1660 1661
	task->tk_action = call_transmit;
	if (!xprt_connected(xprt)) {
		task->tk_action = call_connect_status;
		if (task->tk_status < 0)
			return;
		xprt_connect(task);
L
Linus Torvalds 已提交
1662 1663 1664 1665
	}
}

/*
1666
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1667 1668 1669 1670 1671 1672 1673
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1674
	dprint_status(task);
1675

1676
	trace_rpc_connect_status(task, status);
L
Linus Torvalds 已提交
1677
	switch (status) {
1678 1679 1680
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693
		return;
	case -ECONNREFUSED:
	case -ECONNRESET:
	case -ENETUNREACH:
		if (RPC_IS_SOFTCONN(task))
			break;
		/* retry with existing socket, after a delay */
	case 0:
	case -EAGAIN:
		task->tk_status = 0;
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
L
Linus Torvalds 已提交
1694
	}
1695
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1696 1697 1698 1699 1700 1701 1702 1703
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1704
	dprint_status(task);
L
Linus Torvalds 已提交
1705 1706 1707 1708 1709 1710 1711

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1712
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1713
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1714
	if (rpc_task_need_encode(task)) {
1715
		rpc_xdr_encode(task);
1716
		/* Did the encode result in an error condition? */
1717 1718 1719 1720 1721 1722
		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);
1723
			return;
1724
		}
1725
	}
L
Linus Torvalds 已提交
1726 1727 1728
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1729 1730 1731 1732 1733
	/*
	 * 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);
1734
	if (rpc_reply_expected(task))
1735 1736
		return;
	task->tk_action = rpc_exit_task;
1737
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1738 1739 1740 1741 1742 1743 1744 1745 1746
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757

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

1758 1759 1760 1761
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1762
		dprint_status(task);
1763
		xprt_end_transmit(task);
1764 1765
		rpc_task_force_reencode(task);
		break;
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
		/*
		 * 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:
1776 1777 1778 1779 1780 1781 1782
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1783
	case -EPIPE:
1784 1785
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1786 1787
}

1788
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
/*
 * 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;

	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status == -EAGAIN) {
		/*
		 * Could not reserve the transport. Try again after the
		 * transport is released.
		 */
		task->tk_status = 0;
		task->tk_action = call_bc_transmit;
		return;
	}

	task->tk_action = rpc_exit_task;
	if (task->tk_status < 0) {
		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
			"error: %d\n", task->tk_status);
		return;
	}

	xprt_transmit(task);
	xprt_end_transmit(task);
	dprint_status(task);
	switch (task->tk_status) {
	case 0:
		/* Success */
		break;
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
	case -ETIMEDOUT:
		/*
		 * Problem reaching the server.  Disconnect and let the
		 * forechannel reestablish the connection.  The server will
		 * have to retransmit the backchannel request and we'll
		 * reprocess it.  Since these ops are idempotent, there's no
		 * need to cache our reply at this time.
		 */
		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
			"error: %d\n", task->tk_status);
1836
		xprt_conditional_disconnect(req->rq_xprt,
1837 1838 1839 1840 1841 1842 1843
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1844
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1845 1846 1847 1848 1849 1850
		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);
}
1851
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1852

L
Linus Torvalds 已提交
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
/*
 * 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;

1863 1864
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1865

1866
	dprint_status(task);
L
Linus Torvalds 已提交
1867 1868 1869 1870 1871 1872 1873

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

1874
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1875 1876
	task->tk_status = 0;
	switch(status) {
1877 1878 1879 1880 1881 1882 1883 1884
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
		/*
		 * Delay any retries for 3 seconds, then handle as if it
		 * were a timeout.
		 */
		rpc_delay(task, 3*HZ);
L
Linus Torvalds 已提交
1885 1886
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1887
		if (task->tk_client->cl_discrtry)
1888
			xprt_conditional_disconnect(req->rq_xprt,
1889
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1890
		break;
1891
	case -ECONNRESET:
L
Linus Torvalds 已提交
1892
	case -ECONNREFUSED:
1893
		rpc_force_rebind(clnt);
1894 1895 1896
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
		task->tk_action = call_bind;
		break;
	case -EAGAIN:
		task->tk_action = call_transmit;
		break;
	case -EIO:
		/* shutdown or soft timeout */
		rpc_exit(task, status);
		break;
	default:
O
Olga Kornievskaia 已提交
1907 1908
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
1909
			       clnt->cl_program->name, -status);
L
Linus Torvalds 已提交
1910 1911 1912 1913 1914
		rpc_exit(task, status);
	}
}

/*
1915
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1916 1917 1918 1919 1920 1921 1922 1923 1924
 * 	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) {
1925
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1926 1927 1928
		goto retry;
	}

1929
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1930 1931
	task->tk_timeouts++;

1932 1933 1934 1935
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
1936
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
1937
		if (clnt->cl_chatty) {
1938
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1939
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1940
				clnt->cl_program->name,
1941 1942
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
J
Joe Perches 已提交
1943
		}
1944 1945 1946 1947
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1948 1949 1950
		return;
	}

C
Chuck Lever 已提交
1951
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1952
		task->tk_flags |= RPC_CALL_MAJORSEEN;
1953 1954
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1955
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1956
			clnt->cl_program->name,
1957 1958 1959
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1960
	}
1961
	rpc_force_rebind(clnt);
1962 1963 1964 1965 1966
	/*
	 * 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 已提交
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981

retry:
	clnt->cl_stats->rpcretrans++;
	task->tk_action = call_bind;
	task->tk_status = 0;
}

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

1985
	dprint_status(task);
L
Linus Torvalds 已提交
1986

C
Chuck Lever 已提交
1987
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1988 1989
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1990
			printk(KERN_NOTICE "%s: server %s OK\n",
1991
				clnt->cl_program->name,
1992 1993 1994
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1995 1996 1997
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

1998 1999
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
2000
	 * before it changed req->rq_reply_bytes_recvd.
2001 2002
	 */
	smp_rmb();
L
Linus Torvalds 已提交
2003 2004 2005 2006 2007 2008
	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);

2009 2010 2011 2012 2013 2014 2015
	if (req->rq_rcv_buf.len < 12) {
		if (!RPC_IS_SOFT(task)) {
			task->tk_action = call_bind;
			clnt->cl_stats->rpcretrans++;
			goto out_retry;
		}
		dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
2016
				clnt->cl_program->name, task->tk_status);
2017 2018 2019 2020
		task->tk_action = call_timeout;
		goto out_retry;
	}

2021
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2022 2023 2024 2025
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2026 2027
	}

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

2030
	if (decode) {
L
Linus Torvalds 已提交
2031 2032
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
2033
	}
2034 2035
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
2036 2037 2038
	return;
out_retry:
	task->tk_status = 0;
2039
	/* Note: rpc_verify_header() may have freed the RPC slot */
2040
	if (task->tk_rqstp == req) {
2041
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2042
		if (task->tk_client->cl_discrtry)
2043
			xprt_conditional_disconnect(req->rq_xprt,
2044
					req->rq_connect_cookie);
2045
	}
L
Linus Torvalds 已提交
2046 2047
}

2048
static __be32 *
2049
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2050 2051 2052
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2053
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2054 2055

	/* FIXME: check buffer size? */
2056

2057
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2058 2059 2060 2061 2062 2063
	*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 */
2064 2065 2066
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2067 2068
}

2069
static __be32 *
2070
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2071
{
2072
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2073 2074
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2075 2076
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2077 2078
	int error = -EACCES;

2079 2080 2081 2082 2083 2084
	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
		 */
2085
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2086
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2087
		       task->tk_rqstp->rq_rcv_buf.len);
2088 2089
		goto out_eio;
	}
L
Linus Torvalds 已提交
2090 2091 2092
	if ((len -= 3) < 0)
		goto out_overflow;

2093
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2094
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2095
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2096
			task->tk_pid, __func__, n);
T
Trond Myklebust 已提交
2097
		goto out_garbage;
L
Linus Torvalds 已提交
2098
	}
2099

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

T
Trond Myklebust 已提交
2205
out_garbage:
2206
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2207 2208
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2209
		dprintk("RPC: %5u %s: retrying\n",
2210
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2211
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2212 2213
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2214 2215 2216 2217 2218
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
2219
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2220
			__func__, error);
T
Trond Myklebust 已提交
2221
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2222
out_overflow:
2223
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2224
			__func__);
T
Trond Myklebust 已提交
2225
	goto out_garbage;
L
Linus Torvalds 已提交
2226
}
2227

2228
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2229 2230 2231
{
}

2232
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2233 2234 2235 2236 2237 2238 2239 2240 2241
{
	return 0;
}

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

2242
static int rpc_ping(struct rpc_clnt *clnt)
2243 2244 2245 2246 2247 2248
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2249
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2250 2251 2252
	put_rpccred(msg.rpc_cred);
	return err;
}
2253

2254 2255 2256 2257 2258 2259
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,
	};
2260 2261 2262 2263 2264 2265
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2266
	return rpc_run_task(&task_setup_data);
2267
}
2268
EXPORT_SYMBOL_GPL(rpc_call_null);
2269

2270
#ifdef RPC_DEBUG
2271 2272
static void rpc_show_header(void)
{
2273 2274
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2275 2276
}

C
Chuck Lever 已提交
2277 2278 2279 2280 2281 2282 2283 2284
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);

2285
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2286 2287
		task->tk_pid, task->tk_flags, task->tk_status,
		clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2288
		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2289
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2290 2291
}

2292
void rpc_show_tasks(struct net *net)
2293 2294
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2295
	struct rpc_task *task;
2296
	int header = 0;
2297
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2298

2299 2300
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2301
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2302
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2303 2304 2305 2306
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2307
			rpc_show_task(clnt, task);
2308 2309 2310
		}
		spin_unlock(&clnt->cl_lock);
	}
2311
	spin_unlock(&sn->rpc_client_lock);
2312 2313
}
#endif