clnt.c 54.6 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
rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
161
{
162
	struct net *net = rpc_net_ns(clnt);
163
	struct super_block *pipefs_sb;
164
	struct dentry *dentry;
165

166
	clnt->cl_dentry = NULL;
167 168
	if (dir_name == NULL)
		return 0;
169
	pipefs_sb = rpc_get_sb_net(net);
170 171
	if (!pipefs_sb)
		return 0;
172
	dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
173
	rpc_put_sb_net(net);
174 175 176
	if (IS_ERR(dentry))
		return PTR_ERR(dentry);
	clnt->cl_dentry = dentry;
177
	return 0;
L
Linus Torvalds 已提交
178 179
}

180 181 182 183 184 185 186 187 188 189
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;
	return 0;
}

static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
				   struct super_block *sb)
190 191 192 193 194 195 196 197
{
	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);
198 199
		if (!dentry)
			return -ENOENT;
200 201
		if (IS_ERR(dentry))
			return PTR_ERR(dentry);
202
		clnt->cl_dentry = dentry;
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
		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;
}

219 220 221 222 223 224 225 226 227 228 229 230 231 232
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;
}

233 234 235 236 237 238 239
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) {
240
		if (clnt->cl_program->pipe_dir_name == NULL)
241
			continue;
242
		if (rpc_clnt_skip_event(clnt, event))
243
			continue;
244 245
		if (atomic_inc_not_zero(&clnt->cl_count) == 0)
			continue;
246 247 248 249 250 251 252
		spin_unlock(&sn->rpc_client_lock);
		return clnt;
	}
	spin_unlock(&sn->rpc_client_lock);
	return NULL;
}

253 254 255 256 257 258 259
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;

260
	while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
261
		error = __rpc_pipefs_event(clnt, event, sb);
262
		rpc_release_client(clnt);
263 264 265 266 267 268 269 270
		if (error)
			break;
	}
	return error;
}

static struct notifier_block rpc_clients_block = {
	.notifier_call	= rpc_pipefs_event,
271
	.priority	= SUNRPC_PIPEFS_RPC_PRIO,
272 273 274 275 276 277 278 279 280 281 282 283
};

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

284 285 286 287 288 289 290 291
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);
}

292
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
293
{
294 295
	const struct rpc_program *program = args->program;
	const struct rpc_version *version;
L
Linus Torvalds 已提交
296
	struct rpc_clnt		*clnt = NULL;
297
	struct rpc_auth		*auth;
L
Linus Torvalds 已提交
298
	int err;
299 300

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

304 305 306
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
307

308
	err = -EINVAL;
309 310 311 312
	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
313 314 315
		goto out_err;

	err = -ENOMEM;
316
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
317 318 319 320
	if (!clnt)
		goto out_err;
	clnt->cl_parent = clnt;

321
	rcu_assign_pointer(clnt->cl_xprt, xprt);
L
Linus Torvalds 已提交
322 323 324
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
	clnt->cl_protname = program->name;
325
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
326 327
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
328
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
329 330 331
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
332
	clnt->cl_program  = program;
333
	INIT_LIST_HEAD(&clnt->cl_tasks);
334
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
335

336
	if (!xprt_bound(xprt))
L
Linus Torvalds 已提交
337 338
		clnt->cl_autobind = 1;

339 340 341 342 343 344 345
	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 已提交
346
	clnt->cl_rtt = &clnt->cl_rtt_default;
347
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
348 349 350 351 352 353
	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 已提交
354

355
	atomic_set(&clnt->cl_count, 1);
356

L
Linus Torvalds 已提交
357 358 359 360
	err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
	if (err < 0)
		goto out_no_path;

361
	auth = rpcauth_create(args->authflavor, clnt);
362
	if (IS_ERR(auth)) {
L
Linus Torvalds 已提交
363
		printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
364
				args->authflavor);
365
		err = PTR_ERR(auth);
L
Linus Torvalds 已提交
366 367 368 369
		goto out_no_auth;
	}

	/* save the nodename */
370
	rpc_clnt_set_nodename(clnt, utsname()->nodename);
371
	rpc_register_client(clnt);
L
Linus Torvalds 已提交
372 373 374
	return clnt;

out_no_auth:
375
	rpc_clnt_remove_pipedir(clnt);
L
Linus Torvalds 已提交
376
out_no_path:
377 378
	kfree(clnt->cl_principal);
out_no_principal:
379 380
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
L
Linus Torvalds 已提交
381 382
	kfree(clnt);
out_err:
383 384
	rpciod_down();
out_no_rpciod:
385
	xprt_put(xprt);
L
Linus Torvalds 已提交
386 387 388
	return ERR_PTR(err);
}

389
/**
390 391 392 393 394 395 396 397 398 399 400 401 402
 * 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;
403
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
404
		.net = args->net,
405
		.ident = args->protocol,
406
		.srcaddr = args->saddress,
407 408
		.dstaddr = args->address,
		.addrlen = args->addrsize,
409
		.servername = args->servername,
410
		.bc_xprt = args->bc_xprt,
411
	};
412
	char servername[48];
413

414 415
	if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
		xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
416 417 418 419
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
420
	if (xprtargs.servername == NULL) {
421 422
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
423 424 425 426 427
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

428 429
		servername[0] = '\0';
		switch (args->address->sa_family) {
430 431 432 433
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
434
		case AF_INET:
H
Harvey Harrison 已提交
435 436
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
437
			break;
438
		case AF_INET6:
H
Harvey Harrison 已提交
439
			snprintf(servername, sizeof(servername), "%pI6",
440
				 &sin6->sin6_addr);
441 442 443 444 445 446
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
447
		xprtargs.servername = servername;
448 449
	}

450 451 452 453
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

454 455 456 457 458 459 460 461 462 463
	/*
	 * 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;

464
	clnt = rpc_new_client(args, xprt);
465 466 467 468
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
469
		int err = rpc_ping(clnt);
470 471 472 473 474 475 476 477 478 479 480 481
		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;
482 483
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
484 485
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
486 487 488

	return clnt;
}
489
EXPORT_SYMBOL_GPL(rpc_create);
490

L
Linus Torvalds 已提交
491 492 493 494 495
/*
 * 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 已提交
496 497
static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
					   struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
498
{
499
	struct rpc_xprt *xprt;
C
Chuck Lever 已提交
500 501
	struct rpc_clnt *new;
	int err;
L
Linus Torvalds 已提交
502

C
Chuck Lever 已提交
503
	err = -ENOMEM;
504 505 506 507
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
	rcu_read_unlock();
	if (xprt == NULL)
C
Chuck Lever 已提交
508 509 510 511 512 513
		goto out_err;
	args->servername = xprt->servername;

	new = rpc_new_client(args, xprt);
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
C
Chuck Lever 已提交
514
		goto out_err;
C
Chuck Lever 已提交
515 516
	}

517
	atomic_inc(&clnt->cl_count);
C
Chuck Lever 已提交
518 519 520 521 522 523 524
	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 已提交
525
	return new;
C
Chuck Lever 已提交
526 527

out_err:
528
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
529
	return ERR_PTR(err);
L
Linus Torvalds 已提交
530
}
C
Chuck Lever 已提交
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549

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

552 553 554 555
/**
 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
 *
 * @clnt: RPC client whose parameters are copied
556
 * @flavor: security flavor for new client
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
 *
 * 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);

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
/*
 * 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);
596 597 598
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
599 600 601 602 603 604
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
605 606
/*
 * Properly shut down an RPC client, terminating all outstanding
607
 * requests.
L
Linus Torvalds 已提交
608
 */
609
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
610
{
611 612
	might_sleep();

613 614 615
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
616

617
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
618
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
619
		wait_event_timeout(destroy_wait,
620
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
621 622
	}

623
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
624
}
625
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
626 627

/*
628
 * Free an RPC client
L
Linus Torvalds 已提交
629
 */
630
static void
631
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
632
{
633 634 635
	dprintk_rcu("RPC:       destroying %s client for %s\n",
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
636
	if (clnt->cl_parent != clnt)
637
		rpc_release_client(clnt->cl_parent);
638
	rpc_unregister_client(clnt);
639
	rpc_clnt_remove_pipedir(clnt);
640
	rpc_free_iostats(clnt->cl_metrics);
641
	kfree(clnt->cl_principal);
642
	clnt->cl_metrics = NULL;
643
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
644
	rpciod_down();
L
Linus Torvalds 已提交
645 646 647
	kfree(clnt);
}

648 649 650 651
/*
 * Free an RPC client
 */
static void
652
rpc_free_auth(struct rpc_clnt *clnt)
653 654
{
	if (clnt->cl_auth == NULL) {
655
		rpc_free_client(clnt);
656 657 658 659 660 661 662 663
		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.
	 */
664
	atomic_inc(&clnt->cl_count);
665 666
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
667 668
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
669 670
}

L
Linus Torvalds 已提交
671
/*
672
 * Release reference to the RPC client
L
Linus Torvalds 已提交
673 674 675 676
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
677
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
678

679 680
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
681 682
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_auth(clnt);
683 684
}

685 686
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
687 688 689
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
690 691 692 693 694 695
 *
 * 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,
696
				      const struct rpc_program *program,
697
				      u32 vers)
698
{
699 700 701 702 703 704 705
	struct rpc_create_args args = {
		.program	= program,
		.prognumber	= program->number,
		.version	= vers,
		.authflavor	= old->cl_auth->au_flavor,
		.client_name	= old->cl_principal,
	};
706 707 708
	struct rpc_clnt *clnt;
	int err;

709
	clnt = __rpc_clone_client(&args, old);
710 711
	if (IS_ERR(clnt))
		goto out;
712
	err = rpc_ping(clnt);
713 714 715 716
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
717
out:
718 719
	return clnt;
}
720
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
721

722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
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;
743
		atomic_inc(&clnt->cl_count);
744 745
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
M
Mel Gorman 已提交
746 747 748 749 750 751 752 753 754
		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();
		}
755 756 757 758 759 760 761
		/* 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);
	}
}

762 763 764 765 766 767 768 769
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);


770 771 772 773 774 775 776
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;
777 778
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
779 780 781
	}
}

L
Linus Torvalds 已提交
782 783 784 785
/*
 * Default callback for async RPC calls
 */
static void
786
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
787 788 789
{
}

790 791 792 793
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
794 795 796 797 798
/**
 * 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)
799
{
800
	struct rpc_task *task;
801

802
	task = rpc_new_task(task_setup_data);
803
	if (IS_ERR(task))
804
		goto out;
805

806 807 808 809 810 811
	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);

812 813 814
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
815
	return task;
816
}
T
Trond Myklebust 已提交
817
EXPORT_SYMBOL_GPL(rpc_run_task);
818 819 820 821 822 823

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
824
 */
825
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
826 827
{
	struct rpc_task	*task;
828 829 830 831 832 833
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
834
	int status;
L
Linus Torvalds 已提交
835

836 837 838 839 840 841
	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 已提交
842

T
Trond Myklebust 已提交
843
	task = rpc_run_task(&task_setup_data);
844 845
	if (IS_ERR(task))
		return PTR_ERR(task);
846
	status = task->tk_status;
847
	rpc_put_task(task);
L
Linus Torvalds 已提交
848 849
	return status;
}
850
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
851

852 853 854 855 856
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
857
 * @tk_ops: RPC call ops
858
 * @data: user call data
L
Linus Torvalds 已提交
859 860
 */
int
861
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
862
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
863 864
{
	struct rpc_task	*task;
865 866 867 868 869 870 871
	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 已提交
872

T
Trond Myklebust 已提交
873
	task = rpc_run_task(&task_setup_data);
874 875 876 877
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
878
}
879
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
880

881
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
882 883 884
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
885 886
 * @req: RPC request
 * @tk_ops: RPC call ops
887 888
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
889
				const struct rpc_call_ops *tk_ops)
890 891 892 893 894 895 896 897 898 899 900 901
{
	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);
902
	if (IS_ERR(task)) {
903 904 905 906 907 908 909 910 911 912 913 914 915 916
		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);
917
	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
918 919 920 921 922 923
	rpc_execute(task);

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

926 927 928 929 930 931 932
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

933 934 935 936
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
937
 * @bufsize: length of target buffer
938 939 940 941 942 943
 *
 * 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;
944 945 946 947
	struct rpc_xprt *xprt;

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

949
	bytes = xprt->addrlen;
950 951
	if (bytes > bufsize)
		bytes = bufsize;
952 953 954 955
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
956
}
957
EXPORT_SYMBOL_GPL(rpc_peeraddr);
958

959 960 961 962 963
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
964 965 966
 * 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.
967
 */
968 969
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
970
{
971 972 973
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
974 975 976 977 978

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
979
}
980
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
981

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 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
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 已提交
1131 1132 1133
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1134 1135 1136 1137
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1138 1139
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1140
	rcu_read_unlock();
L
Linus Torvalds 已提交
1141
}
1142
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
1143

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
/**
 * 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 已提交
1179 1180 1181 1182 1183 1184 1185 1186
 *
 * 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)
{
1187 1188 1189 1190 1191 1192
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1193
}
1194
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1195

1196
/**
T
Trond Myklebust 已提交
1197
 * rpc_get_timeout - Get timeout for transport in units of HZ
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
 * @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);

1211 1212 1213 1214 1215 1216 1217
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1218 1219 1220 1221 1222
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1223
}
1224
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1225

1226 1227 1228 1229
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1230
int
1231 1232 1233
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1234
		return 0;
1235 1236 1237
	task->tk_action = call_start;
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1238
	return 1;
1239 1240 1241
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1242 1243 1244 1245
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1246
int
L
Linus Torvalds 已提交
1247 1248 1249
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1250
		return 0;
L
Linus Torvalds 已提交
1251
	task->tk_action = call_start;
1252
	return 1;
L
Linus Torvalds 已提交
1253
}
1254
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1255

1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
#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 已提交
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
/*
 * 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;

1282
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1283
			clnt->cl_protname, clnt->cl_vers,
1284
			rpc_proc_name(task),
1285
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298

	/* 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)
{
1299
	dprint_status(task);
L
Linus Torvalds 已提交
1300 1301 1302 1303 1304 1305

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

1306 1307
static void call_retry_reserve(struct rpc_task *task);

L
Linus Torvalds 已提交
1308 1309 1310 1311 1312 1313 1314 1315
/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1316
	dprint_status(task);
L
Linus Torvalds 已提交
1317 1318 1319 1320 1321 1322 1323 1324

	/*
	 * 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) {
1325
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1326 1327 1328 1329
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1330
				__func__, status);
L
Linus Torvalds 已提交
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
		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",
1341
				__func__, status);
L
Linus Torvalds 已提交
1342 1343 1344 1345
		xprt_release(task);
	}

	switch (status) {
1346 1347
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1348
	case -EAGAIN:	/* woken up; retry */
1349
		task->tk_action = call_retry_reserve;
L
Linus Torvalds 已提交
1350 1351 1352 1353 1354
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1355
				__func__, status);
L
Linus Torvalds 已提交
1356 1357 1358 1359 1360
		break;
	}
	rpc_exit(task, status);
}

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
/*
 * 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 已提交
1374
/*
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
 * 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;
1399
	task->tk_action = call_refresh;
1400
	switch (status) {
1401 1402 1403
	case 0:
		if (rpcauth_uptodatecred(task))
			task->tk_action = call_allocate;
1404 1405 1406
		return;
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1407
	case -EKEYEXPIRED:
1408 1409 1410 1411 1412 1413 1414 1415
	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;
1416
	}
1417 1418 1419
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1420 1421 1422 1423
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1424
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1425 1426 1427 1428
 */
static void
call_allocate(struct rpc_task *task)
{
1429
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1430
	struct rpc_rqst *req = task->tk_rqstp;
1431
	struct rpc_xprt *xprt = req->rq_xprt;
1432
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1433

1434 1435
	dprint_status(task);

1436
	task->tk_status = 0;
1437
	task->tk_action = call_bind;
1438

1439
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1440 1441
		return;

1442 1443 1444 1445 1446
	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 已提交
1447

1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
	/*
	 * 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;

1458 1459
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1460
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1461
		return;
1462 1463

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

1465
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1466
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1467 1468 1469 1470 1471 1472 1473
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
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;
1484
	task->tk_rqstp->rq_bytes_sent = 0;
1485 1486
}

1487 1488 1489 1490 1491 1492 1493
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;
1494
	buf->flags = 0;
1495 1496 1497 1498
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1499 1500 1501 1502
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1503
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1504 1505
{
	struct rpc_rqst	*req = task->tk_rqstp;
1506
	kxdreproc_t	encode;
1507
	__be32		*p;
L
Linus Torvalds 已提交
1508

1509
	dprint_status(task);
L
Linus Torvalds 已提交
1510

1511 1512 1513 1514 1515 1516
	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 已提交
1517

1518 1519 1520
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1521 1522 1523
		rpc_exit(task, -EIO);
		return;
	}
1524 1525

	encode = task->tk_msg.rpc_proc->p_encode;
1526 1527 1528 1529 1530
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1531 1532 1533 1534 1535 1536 1537 1538
}

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

1541
	dprint_status(task);
L
Linus Torvalds 已提交
1542

1543
	task->tk_action = call_connect;
1544
	if (!xprt_bound(xprt)) {
1545
		task->tk_action = call_bind_status;
1546
		task->tk_timeout = xprt->bind_timeout;
1547
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1548 1549 1550 1551
	}
}

/*
1552 1553 1554 1555 1556
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1557
	int status = -EIO;
1558 1559

	if (task->tk_status >= 0) {
1560
		dprint_status(task);
1561 1562 1563 1564 1565
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1566
	trace_rpc_bind_status(task);
1567
	switch (task->tk_status) {
1568 1569 1570
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1571
		goto retry_timeout;
1572
	case -EACCES:
1573 1574
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1575 1576 1577 1578 1579
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1580 1581 1582
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1583
		rpc_delay(task, 3*HZ);
1584
		goto retry_timeout;
1585
	case -ETIMEDOUT:
1586
		dprintk("RPC: %5u rpcbind request timed out\n",
1587
				task->tk_pid);
1588
		goto retry_timeout;
1589
	case -EPFNOSUPPORT:
1590
		/* server doesn't support any rpcbind version we know of */
1591
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1592 1593 1594
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1595
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1596
				task->tk_pid);
1597 1598 1599
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
	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;
1615
	default:
1616
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1617 1618 1619 1620 1621 1622
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1623 1624
retry_timeout:
	task->tk_action = call_timeout;
1625 1626 1627 1628
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1629 1630 1631 1632
 */
static void
call_connect(struct rpc_task *task)
{
1633
	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
L
Linus Torvalds 已提交
1634

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

1639 1640 1641 1642 1643 1644
	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 已提交
1645 1646 1647 1648
	}
}

/*
1649
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1650 1651 1652 1653 1654 1655 1656
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1657
	dprint_status(task);
1658

1659
	trace_rpc_connect_status(task, status);
L
Linus Torvalds 已提交
1660
	switch (status) {
1661 1662 1663
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
		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 已提交
1677
	}
1678
	rpc_exit(task, status);
L
Linus Torvalds 已提交
1679 1680 1681 1682 1683 1684 1685 1686
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1687
	dprint_status(task);
L
Linus Torvalds 已提交
1688 1689 1690 1691 1692 1693 1694

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1695
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1696
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1697
	if (rpc_task_need_encode(task)) {
1698
		rpc_xdr_encode(task);
1699
		/* Did the encode result in an error condition? */
1700 1701 1702 1703 1704 1705
		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);
1706
			return;
1707
		}
1708
	}
L
Linus Torvalds 已提交
1709 1710 1711
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1712 1713 1714 1715 1716
	/*
	 * 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);
1717
	if (rpc_reply_expected(task))
1718 1719
		return;
	task->tk_action = rpc_exit_task;
1720
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1721 1722 1723 1724 1725 1726 1727 1728 1729
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740

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

1741 1742 1743 1744
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1745
		dprint_status(task);
1746
		xprt_end_transmit(task);
1747 1748
		rpc_task_force_reencode(task);
		break;
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
		/*
		 * 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:
1759 1760 1761 1762 1763 1764 1765
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1766
	case -EPIPE:
1767 1768
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1769 1770
}

1771
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 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
/*
 * 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);
1819
		xprt_conditional_disconnect(req->rq_xprt,
1820 1821 1822 1823 1824 1825 1826
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1827
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1828 1829 1830 1831 1832 1833
		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);
}
1834
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1835

L
Linus Torvalds 已提交
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
/*
 * 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;

1846 1847
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1848

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

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

1857
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1858 1859
	task->tk_status = 0;
	switch(status) {
1860 1861 1862 1863 1864 1865 1866 1867
	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 已提交
1868 1869
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1870
		if (task->tk_client->cl_discrtry)
1871
			xprt_conditional_disconnect(req->rq_xprt,
1872
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1873
		break;
1874
	case -ECONNRESET:
L
Linus Torvalds 已提交
1875
	case -ECONNREFUSED:
1876
		rpc_force_rebind(clnt);
1877 1878 1879
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
		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 已提交
1890 1891
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1892 1893 1894 1895 1896 1897
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
1898
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1899 1900 1901 1902 1903 1904 1905 1906 1907
 * 	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) {
1908
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1909 1910 1911
		goto retry;
	}

1912
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1913 1914
	task->tk_timeouts++;

1915 1916 1917 1918
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
1919
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
1920
		if (clnt->cl_chatty) {
1921
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1922
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1923 1924 1925
				clnt->cl_protname,
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
J
Joe Perches 已提交
1926
		}
1927 1928 1929 1930
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1931 1932 1933
		return;
	}

C
Chuck Lever 已提交
1934
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1935
		task->tk_flags |= RPC_CALL_MAJORSEEN;
1936 1937
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1938
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1939 1940 1941 1942
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1943
	}
1944
	rpc_force_rebind(clnt);
1945 1946 1947 1948 1949
	/*
	 * 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 已提交
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964

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

1968
	dprint_status(task);
L
Linus Torvalds 已提交
1969

C
Chuck Lever 已提交
1970
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1971 1972
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1973
			printk(KERN_NOTICE "%s: server %s OK\n",
1974 1975 1976 1977
				clnt->cl_protname,
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1978 1979 1980
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

1981 1982
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
1983
	 * before it changed req->rq_reply_bytes_recvd.
1984 1985
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1986 1987 1988 1989 1990 1991
	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);

1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
	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;
	}

2004
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
2005 2006 2007 2008
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
2009 2010
	}

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

2013
	if (decode) {
L
Linus Torvalds 已提交
2014 2015
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
2016
	}
2017 2018
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
2019 2020 2021
	return;
out_retry:
	task->tk_status = 0;
2022
	/* Note: rpc_verify_header() may have freed the RPC slot */
2023
	if (task->tk_rqstp == req) {
2024
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2025
		if (task->tk_client->cl_discrtry)
2026
			xprt_conditional_disconnect(req->rq_xprt,
2027
					req->rq_connect_cookie);
2028
	}
L
Linus Torvalds 已提交
2029 2030
}

2031
static __be32 *
2032
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2033 2034 2035
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2036
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2037 2038

	/* FIXME: check buffer size? */
2039

2040
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2041 2042 2043 2044 2045 2046
	*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 */
2047 2048 2049
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2050 2051
}

2052
static __be32 *
2053
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2054
{
2055
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2056 2057
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2058 2059
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2060 2061
	int error = -EACCES;

2062 2063 2064 2065 2066 2067
	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
		 */
2068
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2069
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2070
		       task->tk_rqstp->rq_rcv_buf.len);
2071 2072
		goto out_eio;
	}
L
Linus Torvalds 已提交
2073 2074 2075
	if ((len -= 3) < 0)
		goto out_overflow;

2076
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2077
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2078
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2079
			task->tk_pid, __func__, n);
T
Trond Myklebust 已提交
2080
		goto out_garbage;
L
Linus Torvalds 已提交
2081
	}
2082

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

T
Trond Myklebust 已提交
2188
out_garbage:
2189
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2190 2191
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2192
		dprintk("RPC: %5u %s: retrying\n",
2193
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2194
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2195 2196
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2197 2198 2199 2200 2201
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
2202
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2203
			__func__, error);
T
Trond Myklebust 已提交
2204
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2205
out_overflow:
2206
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2207
			__func__);
T
Trond Myklebust 已提交
2208
	goto out_garbage;
L
Linus Torvalds 已提交
2209
}
2210

2211
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2212 2213 2214
{
}

2215
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2216 2217 2218 2219 2220 2221 2222 2223 2224
{
	return 0;
}

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

2225
static int rpc_ping(struct rpc_clnt *clnt)
2226 2227 2228 2229 2230 2231
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2232
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2233 2234 2235
	put_rpccred(msg.rpc_cred);
	return err;
}
2236

2237 2238 2239 2240 2241 2242
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,
	};
2243 2244 2245 2246 2247 2248
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2249
	return rpc_run_task(&task_setup_data);
2250
}
2251
EXPORT_SYMBOL_GPL(rpc_call_null);
2252

2253
#ifdef RPC_DEBUG
2254 2255
static void rpc_show_header(void)
{
2256 2257
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2258 2259
}

C
Chuck Lever 已提交
2260 2261 2262 2263 2264 2265 2266 2267
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);

2268
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2269 2270 2271
		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),
2272
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2273 2274
}

2275
void rpc_show_tasks(struct net *net)
2276 2277
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2278
	struct rpc_task *task;
2279
	int header = 0;
2280
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2281

2282 2283
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2284
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2285
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2286 2287 2288 2289
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2290
			rpc_show_task(clnt, task);
2291 2292 2293
		}
		spin_unlock(&clnt->cl_lock);
	}
2294
	spin_unlock(&sn->rpc_client_lock);
2295 2296
}
#endif