clnt.c 55.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 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 127
				    struct rpc_clnt *clnt,
				    const char *dir_name)
L
Linus Torvalds 已提交
128
{
129
	static uint32_t clntid;
130
	char name[15];
131
	struct qstr q = { .name = name };
132
	struct dentry *dir, *dentry;
L
Linus Torvalds 已提交
133 134
	int error;

135
	dir = rpc_d_lookup_sb(sb, dir_name);
136 137
	if (dir == NULL) {
		pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
138
		return dir;
139
	}
140
	for (;;) {
141 142 143
		q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
		name[sizeof(name) - 1] = '\0';
		q.hash = full_name_hash(q.name, q.len);
144 145
		dentry = rpc_create_client_dir(dir, &q, clnt);
		if (!IS_ERR(dentry))
146
			break;
147
		error = PTR_ERR(dentry);
148
		if (error != -EEXIST) {
149 150 151
			printk(KERN_INFO "RPC: Couldn't create pipefs entry"
					" %s/%s, error %d\n",
					dir_name, name, error);
152
			break;
153
		}
L
Linus Torvalds 已提交
154
	}
155 156 157 158 159
	dput(dir);
	return dentry;
}

static int
160 161
rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name,
		  struct super_block *pipefs_sb)
162
{
163
	struct dentry *dentry;
164

165
	clnt->cl_dentry = NULL;
166 167
	if (dir_name == NULL)
		return 0;
168 169 170 171
	dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
	if (IS_ERR(dentry))
		return PTR_ERR(dentry);
	clnt->cl_dentry = dentry;
172
	return 0;
L
Linus Torvalds 已提交
173 174
}

175 176 177 178 179
static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
{
	if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
	    ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
		return 1;
180 181
	if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
		return 1;
182 183 184 185 186
	return 0;
}

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

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

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

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

248 249 250 251 252 253 254
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;

255
	while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
256 257 258 259 260 261 262 263 264
		error = __rpc_pipefs_event(clnt, event, sb);
		if (error)
			break;
	}
	return error;
}

static struct notifier_block rpc_clients_block = {
	.notifier_call	= rpc_pipefs_event,
265
	.priority	= SUNRPC_PIPEFS_RPC_PRIO,
266 267 268 269 270 271 272 273 274 275 276 277
};

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

278 279 280 281 282 283 284 285
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);
}

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
static int rpc_client_register(const struct rpc_create_args *args,
			       struct rpc_clnt *clnt)
{
	const struct rpc_program *program = args->program;
	struct rpc_auth *auth;
	struct net *net = rpc_net_ns(clnt);
	struct super_block *pipefs_sb;
	int err = 0;

	pipefs_sb = rpc_get_sb_net(net);
	if (pipefs_sb) {
		err = rpc_setup_pipedir(clnt, program->pipe_dir_name, pipefs_sb);
		if (err)
			goto out;
	}

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

	rpc_register_client(clnt);
out:
	if (pipefs_sb)
		rpc_put_sb_net(net);
	return err;

err_auth:
	__rpc_clnt_remove_pipedir(clnt);
	goto out;
}

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

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

332 333 334
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
335

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

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

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

364
	if (!xprt_bound(xprt))
L
Linus Torvalds 已提交
365 366
		clnt->cl_autobind = 1;

367 368 369 370 371 372 373
	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 已提交
374
	clnt->cl_rtt = &clnt->cl_rtt_default;
375
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
376 377 378 379 380 381
	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 已提交
382

383
	atomic_set(&clnt->cl_count, 1);
384

L
Linus Torvalds 已提交
385
	/* save the nodename */
386
	rpc_clnt_set_nodename(clnt, utsname()->nodename);
387 388 389 390

	err = rpc_client_register(args, clnt);
	if (err)
		goto out_no_path;
L
Linus Torvalds 已提交
391 392 393
	return clnt;

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

406
/**
407 408 409 410 411 412 413 414 415 416 417 418 419
 * 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;
420
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
421
		.net = args->net,
422
		.ident = args->protocol,
423
		.srcaddr = args->saddress,
424 425
		.dstaddr = args->address,
		.addrlen = args->addrsize,
426
		.servername = args->servername,
427
		.bc_xprt = args->bc_xprt,
428
	};
429
	char servername[48];
430

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

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

469 470 471 472
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

473 474 475 476 477 478 479 480 481 482
	/*
	 * 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;

483
	clnt = rpc_new_client(args, xprt);
484 485 486 487
	if (IS_ERR(clnt))
		return clnt;

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

	return clnt;
}
508
EXPORT_SYMBOL_GPL(rpc_create);
509

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

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

	new = rpc_new_client(args, xprt);
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
533
		goto out_err;
C
Chuck Lever 已提交
534 535
	}

536
	atomic_inc(&clnt->cl_count);
C
Chuck Lever 已提交
537 538 539 540 541 542 543
	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 已提交
544
	return new;
C
Chuck Lever 已提交
545 546

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

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

571 572 573 574
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
575
 * @flavor: security flavor for new client
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
 *
 * 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);

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

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

632 633 634
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
635

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

642
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
643
}
644
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
645 646

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

667 668 669 670
/*
 * Free an RPC client
 */
static void
671
rpc_free_auth(struct rpc_clnt *clnt)
672 673
{
	if (clnt->cl_auth == NULL) {
674
		rpc_free_client(clnt);
675 676 677 678 679 680 681 682
		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.
	 */
683
	atomic_inc(&clnt->cl_count);
684 685
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
686 687
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
688 689
}

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

698 699
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
700 701
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_auth(clnt);
702
}
703
EXPORT_SYMBOL_GPL(rpc_release_client);
704

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

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

742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
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;
763
		atomic_inc(&clnt->cl_count);
764 765
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
M
Mel Gorman 已提交
766 767 768 769 770 771 772 773 774
		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();
		}
775 776 777 778 779 780 781
		/* 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);
	}
}

782 783 784 785 786 787 788 789
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);


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

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

810 811 812 813
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

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

822
	task = rpc_new_task(task_setup_data);
823
	if (IS_ERR(task))
824
		goto out;
825

826 827 828 829 830 831
	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);

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

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

856 857 858 859 860 861
	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 已提交
862

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

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

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

901
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
902 903 904
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
905 906
 * @req: RPC request
 * @tk_ops: RPC call ops
907 908
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
909
				const struct rpc_call_ops *tk_ops)
910 911 912 913 914 915 916 917 918 919 920 921
{
	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);
922
	if (IS_ERR(task)) {
923 924 925 926 927 928 929 930 931 932 933 934 935 936
		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);
937
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
938 939 940 941 942 943
	rpc_execute(task);

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

946 947 948 949 950 951 952
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

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

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

969
	bytes = xprt->addrlen;
970 971
	if (bytes > bufsize)
		bytes = bufsize;
972 973 974 975
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
976
}
977
EXPORT_SYMBOL_GPL(rpc_peeraddr);
978

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

	xprt = rcu_dereference(clnt->cl_xprt);
994 995 996 997 998

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
999
}
1000
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
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 1148 1149 1150
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 已提交
1151 1152 1153
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1154 1155 1156 1157
	struct rpc_xprt *xprt;

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

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1213
}
1214
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1215

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

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

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

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

1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
#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 已提交
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
/*
 * 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;

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

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

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

1326 1327
static void call_retry_reserve(struct rpc_task *task);

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

1336
	dprint_status(task);
L
Linus Torvalds 已提交
1337 1338 1339 1340 1341 1342 1343 1344

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

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

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

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

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

1454 1455
	dprint_status(task);

1456
	task->tk_status = 0;
1457
	task->tk_action = call_bind;
1458

1459
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1460 1461
		return;

1462 1463 1464 1465 1466
	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 已提交
1467

1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
	/*
	 * 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;

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

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

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

	rpc_exit(task, -ERESTARTSYS);
}

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

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

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

1529
	dprint_status(task);
L
Linus Torvalds 已提交
1530

1531 1532 1533 1534 1535 1536
	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 已提交
1537

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

	encode = task->tk_msg.rpc_proc->p_encode;
1546 1547 1548 1549 1550
	if (encode == NULL)
		return;

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

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

1561
	dprint_status(task);
L
Linus Torvalds 已提交
1562

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

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

	if (task->tk_status >= 0) {
1580
		dprint_status(task);
1581 1582 1583 1584 1585
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

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

	rpc_exit(task, status);
	return;

1643 1644
retry_timeout:
	task->tk_action = call_timeout;
1645 1646 1647 1648
}

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

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

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

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

1677
	dprint_status(task);
1678

1679
	trace_rpc_connect_status(task, status);
L
Linus Torvalds 已提交
1680
	switch (status) {
1681 1682 1683
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
		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 已提交
1697
	}
1698
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1699 1700 1701 1702 1703 1704 1705 1706
}

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

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

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

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

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

1791
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
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 1836 1837 1838
/*
 * 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);
1839
		xprt_conditional_disconnect(req->rq_xprt,
1840 1841 1842 1843 1844 1845 1846
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1847
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1848 1849 1850 1851 1852 1853
		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);
}
1854
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1855

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

1866 1867
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1868

1869
	dprint_status(task);
L
Linus Torvalds 已提交
1870 1871 1872 1873 1874 1875 1876

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

1877
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1878 1879
	task->tk_status = 0;
	switch(status) {
1880 1881 1882 1883 1884 1885 1886 1887
	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 已提交
1888 1889
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1890
		if (task->tk_client->cl_discrtry)
1891
			xprt_conditional_disconnect(req->rq_xprt,
1892
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1893
		break;
1894
	case -ECONNRESET:
L
Linus Torvalds 已提交
1895
	case -ECONNREFUSED:
1896
		rpc_force_rebind(clnt);
1897 1898 1899
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
		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 已提交
1910 1911
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1912 1913 1914 1915 1916 1917
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

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

1932
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1933 1934
	task->tk_timeouts++;

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

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

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

1988
	dprint_status(task);
L
Linus Torvalds 已提交
1989

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

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

2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
	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",
				clnt->cl_protname, task->tk_status);
		task->tk_action = call_timeout;
		goto out_retry;
	}

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

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

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

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

	/* FIXME: check buffer size? */
2059

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

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

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

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

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

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

2231
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2232 2233 2234
{
}

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

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

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

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

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

C
Chuck Lever 已提交
2280 2281 2282 2283 2284 2285 2286 2287
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);

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

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

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