clnt.c 53.8 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 36

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

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

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

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

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

L
Linus Torvalds 已提交
56 57 58 59 60 61 62 63 64
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);
65
static void	call_bind_status(struct rpc_task *task);
L
Linus Torvalds 已提交
66
static void	call_transmit(struct rpc_task *task);
67
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
68
static void	call_bc_transmit(struct rpc_task *task);
69
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
L
Linus Torvalds 已提交
70
static void	call_status(struct rpc_task *task);
71
static void	call_transmit_status(struct rpc_task *task);
L
Linus Torvalds 已提交
72 73 74 75 76 77
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);

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

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

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

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

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

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

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

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

static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
125 126
				    struct rpc_clnt *clnt,
				    const char *dir_name)
L
Linus Torvalds 已提交
127
{
128
	static uint32_t clntid;
129
	char name[15];
130
	struct qstr q = { .name = name };
131
	struct dentry *dir, *dentry;
L
Linus Torvalds 已提交
132 133
	int error;

134
	dir = rpc_d_lookup_sb(sb, dir_name);
135 136
	if (dir == NULL) {
		pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
137
		return dir;
138
	}
139
	for (;;) {
140 141 142
		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);
143 144
		dentry = rpc_create_client_dir(dir, &q, clnt);
		if (!IS_ERR(dentry))
145
			break;
146
		error = PTR_ERR(dentry);
147
		if (error != -EEXIST) {
148 149 150
			printk(KERN_INFO "RPC: Couldn't create pipefs entry"
					" %s/%s, error %d\n",
					dir_name, name, error);
151
			break;
152
		}
L
Linus Torvalds 已提交
153
	}
154 155 156 157 158
	dput(dir);
	return dentry;
}

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

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

179 180 181 182 183 184 185 186 187 188
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)
189 190 191 192 193 194 195 196
{
	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);
197 198
		if (!dentry)
			return -ENOENT;
199 200
		if (IS_ERR(dentry))
			return PTR_ERR(dentry);
201
		clnt->cl_dentry = dentry;
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
		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;
}

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

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

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

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

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

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

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

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

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

303 304 305
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
L
Linus Torvalds 已提交
306 307
	err = -EINVAL;
	if (!xprt)
308
		goto out_no_xprt;
309 310 311 312 313

	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
314 315 316
		goto out_err;

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

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

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

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

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

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

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

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

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

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

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 514 515 516
		goto out_err;
	args->servername = xprt->servername;

	new = rpc_new_client(args, xprt);
	if (IS_ERR(new)) {
		err = PTR_ERR(new);
		goto out_put;
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

792 793 794 795
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

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

804
	task = rpc_new_task(task_setup_data);
805
	if (IS_ERR(task))
806
		goto out;
807

808 809 810 811 812 813
	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);

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

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

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

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

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

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

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

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

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

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

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

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

	return bytes;
958
}
959
EXPORT_SYMBOL_GPL(rpc_peeraddr);
960

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

	xprt = rcu_dereference(clnt->cl_xprt);
976 977 978 979 980

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
981
}
982
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
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 1131 1132
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 已提交
1133 1134 1135
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1136 1137 1138 1139
	struct rpc_xprt *xprt;

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

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

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

1198 1199 1200 1201 1202 1203 1204
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1205 1206 1207 1208 1209
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1210
}
1211
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1212

1213 1214 1215 1216
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1217
int
1218 1219 1220
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1221
		return 0;
1222 1223 1224
	task->tk_action = call_start;
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1225
	return 1;
1226 1227 1228
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1229 1230 1231 1232
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1233
int
L
Linus Torvalds 已提交
1234 1235 1236
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1237
		return 0;
L
Linus Torvalds 已提交
1238
	task->tk_action = call_start;
1239
	return 1;
L
Linus Torvalds 已提交
1240
}
1241
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1242

1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
#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 已提交
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
/*
 * 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;

1269
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1270
			clnt->cl_protname, clnt->cl_vers,
1271
			rpc_proc_name(task),
1272
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285

	/* 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)
{
1286
	dprint_status(task);
L
Linus Torvalds 已提交
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300

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

/*
 * 1b.	Grok the result of xprt_reserve()
 */
static void
call_reserveresult(struct rpc_task *task)
{
	int status = task->tk_status;

1301
	dprint_status(task);
L
Linus Torvalds 已提交
1302 1303 1304 1305 1306 1307 1308 1309

	/*
	 * 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) {
1310
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1311 1312 1313 1314
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1315
				__func__, status);
L
Linus Torvalds 已提交
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
		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",
1326
				__func__, status);
L
Linus Torvalds 已提交
1327 1328 1329 1330
		xprt_release(task);
	}

	switch (status) {
1331 1332
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1333 1334 1335 1336 1337 1338 1339
	case -EAGAIN:	/* woken up; retry */
		task->tk_action = call_reserve;
		return;
	case -EIO:	/* probably a shutdown */
		break;
	default:
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1340
				__func__, status);
L
Linus Torvalds 已提交
1341 1342 1343 1344 1345 1346
		break;
	}
	rpc_exit(task, status);
}

/*
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
 * 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;
1371
	task->tk_action = call_refresh;
1372
	switch (status) {
1373 1374 1375
	case 0:
		if (rpcauth_uptodatecred(task))
			task->tk_action = call_allocate;
1376 1377 1378
		return;
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1379
	case -EKEYEXPIRED:
1380 1381 1382 1383 1384 1385 1386 1387
	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;
1388
	}
1389 1390 1391
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1392 1393 1394 1395
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1396
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1397 1398 1399 1400
 */
static void
call_allocate(struct rpc_task *task)
{
1401
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1402
	struct rpc_rqst *req = task->tk_rqstp;
1403
	struct rpc_xprt *xprt = req->rq_xprt;
1404
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1405

1406 1407
	dprint_status(task);

1408
	task->tk_status = 0;
1409
	task->tk_action = call_bind;
1410

1411
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1412 1413
		return;

1414 1415 1416 1417 1418
	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 已提交
1419

1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
	/*
	 * 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;

1430 1431
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1432
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1433
		return;
1434 1435

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

1437
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1438
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1439 1440 1441 1442 1443 1444 1445
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
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;
1456
	task->tk_rqstp->rq_bytes_sent = 0;
1457 1458
}

1459 1460 1461 1462 1463 1464 1465
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;
1466
	buf->flags = 0;
1467 1468 1469 1470
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1471 1472 1473 1474
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1475
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1476 1477
{
	struct rpc_rqst	*req = task->tk_rqstp;
1478
	kxdreproc_t	encode;
1479
	__be32		*p;
L
Linus Torvalds 已提交
1480

1481
	dprint_status(task);
L
Linus Torvalds 已提交
1482

1483 1484 1485 1486 1487 1488
	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 已提交
1489

1490 1491 1492
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1493 1494 1495
		rpc_exit(task, -EIO);
		return;
	}
1496 1497

	encode = task->tk_msg.rpc_proc->p_encode;
1498 1499 1500 1501 1502
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1503 1504 1505 1506 1507 1508 1509 1510
}

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

1513
	dprint_status(task);
L
Linus Torvalds 已提交
1514

1515
	task->tk_action = call_connect;
1516
	if (!xprt_bound(xprt)) {
1517
		task->tk_action = call_bind_status;
1518
		task->tk_timeout = xprt->bind_timeout;
1519
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1520 1521 1522 1523
	}
}

/*
1524 1525 1526 1527 1528
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1529
	int status = -EIO;
1530 1531

	if (task->tk_status >= 0) {
1532
		dprint_status(task);
1533 1534 1535 1536 1537
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1538
	trace_rpc_bind_status(task);
1539
	switch (task->tk_status) {
1540 1541 1542
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1543
		goto retry_timeout;
1544
	case -EACCES:
1545 1546
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1547 1548 1549 1550 1551
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1552 1553 1554
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1555
		rpc_delay(task, 3*HZ);
1556
		goto retry_timeout;
1557
	case -ETIMEDOUT:
1558
		dprintk("RPC: %5u rpcbind request timed out\n",
1559
				task->tk_pid);
1560
		goto retry_timeout;
1561
	case -EPFNOSUPPORT:
1562
		/* server doesn't support any rpcbind version we know of */
1563
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1564 1565 1566
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1567
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1568
				task->tk_pid);
1569 1570 1571
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
	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;
1587
	default:
1588
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1589 1590 1591 1592 1593 1594
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1595 1596
retry_timeout:
	task->tk_action = call_timeout;
1597 1598 1599 1600
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1601 1602 1603 1604
 */
static void
call_connect(struct rpc_task *task)
{
1605
	struct rpc_xprt *xprt = task->tk_xprt;
L
Linus Torvalds 已提交
1606

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

1611 1612 1613 1614 1615 1616
	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 已提交
1617 1618 1619 1620
	}
}

/*
1621
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1622 1623 1624 1625 1626 1627 1628
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1629
	dprint_status(task);
1630

L
Linus Torvalds 已提交
1631
	task->tk_status = 0;
1632
	if (status >= 0 || status == -EAGAIN) {
L
Linus Torvalds 已提交
1633 1634 1635 1636 1637
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}

1638
	trace_rpc_connect_status(task, status);
L
Linus Torvalds 已提交
1639
	switch (status) {
1640 1641 1642
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1643 1644 1645
		break;
	default:
		rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1646 1647 1648 1649 1650 1651 1652 1653 1654
	}
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1655
	dprint_status(task);
L
Linus Torvalds 已提交
1656 1657 1658 1659 1660 1661 1662

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1663
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1664
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1665
	if (rpc_task_need_encode(task)) {
1666
		rpc_xdr_encode(task);
1667
		/* Did the encode result in an error condition? */
1668 1669 1670 1671 1672 1673
		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);
1674
			return;
1675
		}
1676
	}
L
Linus Torvalds 已提交
1677 1678 1679
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1680 1681 1682 1683 1684
	/*
	 * 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);
1685
	if (rpc_reply_expected(task))
1686 1687
		return;
	task->tk_action = rpc_exit_task;
1688
	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1689 1690 1691 1692 1693 1694 1695 1696 1697
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708

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

1709 1710 1711 1712
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1713
		dprint_status(task);
1714
		xprt_end_transmit(task);
1715 1716
		rpc_task_force_reencode(task);
		break;
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
		/*
		 * 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:
1727 1728 1729 1730 1731 1732 1733
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1734
	case -EPIPE:
1735 1736
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1737 1738
}

1739
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786
/*
 * 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);
1787
		xprt_conditional_disconnect(req->rq_xprt,
1788 1789 1790 1791 1792 1793 1794
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
1795
		WARN_ON_ONCE(task->tk_status == -EAGAIN);
1796 1797 1798 1799 1800 1801
		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);
}
1802
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1803

L
Linus Torvalds 已提交
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
/*
 * 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;

1814 1815
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1816

1817
	dprint_status(task);
L
Linus Torvalds 已提交
1818 1819 1820 1821 1822 1823 1824

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

1825
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1826 1827
	task->tk_status = 0;
	switch(status) {
1828 1829 1830 1831 1832 1833 1834 1835
	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 已提交
1836 1837
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1838
		if (task->tk_client->cl_discrtry)
1839
			xprt_conditional_disconnect(req->rq_xprt,
1840
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1841
		break;
1842
	case -ECONNRESET:
L
Linus Torvalds 已提交
1843
	case -ECONNREFUSED:
1844
		rpc_force_rebind(clnt);
1845 1846 1847
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
		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 已提交
1858 1859
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1860 1861 1862 1863 1864 1865
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
1866
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1867 1868 1869 1870 1871 1872 1873 1874 1875
 * 	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) {
1876
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1877 1878 1879
		goto retry;
	}

1880
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1881 1882
	task->tk_timeouts++;

1883 1884 1885 1886
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
1887
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
1888
		if (clnt->cl_chatty) {
1889
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1890
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1891 1892 1893
				clnt->cl_protname,
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
J
Joe Perches 已提交
1894
		}
1895 1896 1897 1898
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1899 1900 1901
		return;
	}

C
Chuck Lever 已提交
1902
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1903
		task->tk_flags |= RPC_CALL_MAJORSEEN;
1904 1905
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1906
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1907 1908 1909 1910
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1911
	}
1912
	rpc_force_rebind(clnt);
1913 1914 1915 1916 1917
	/*
	 * 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 已提交
1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932

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

1936
	dprint_status(task);
L
Linus Torvalds 已提交
1937

C
Chuck Lever 已提交
1938
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1939 1940
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1941
			printk(KERN_NOTICE "%s: server %s OK\n",
1942 1943 1944 1945
				clnt->cl_protname,
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1946 1947 1948
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

1949 1950
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
1951
	 * before it changed req->rq_reply_bytes_recvd.
1952 1953
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1954 1955 1956 1957 1958 1959
	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);

1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971
	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;
	}

1972
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
1973 1974 1975 1976
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
1977 1978
	}

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

1981
	if (decode) {
L
Linus Torvalds 已提交
1982 1983
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
1984
	}
1985 1986
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
1987 1988 1989
	return;
out_retry:
	task->tk_status = 0;
1990
	/* Note: rpc_verify_header() may have freed the RPC slot */
1991
	if (task->tk_rqstp == req) {
1992
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1993
		if (task->tk_client->cl_discrtry)
1994
			xprt_conditional_disconnect(req->rq_xprt,
1995
					req->rq_connect_cookie);
1996
	}
L
Linus Torvalds 已提交
1997 1998
}

1999
static __be32 *
2000
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2001 2002 2003
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
2004
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
2005 2006

	/* FIXME: check buffer size? */
2007

2008
	p = xprt_skip_transport_header(req->rq_xprt, p);
L
Linus Torvalds 已提交
2009 2010 2011 2012 2013 2014
	*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 */
2015 2016 2017
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
2018 2019
}

2020
static __be32 *
2021
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
2022
{
2023
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
2024 2025
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2026 2027
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
2028 2029
	int error = -EACCES;

2030 2031 2032 2033 2034 2035
	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
		 */
2036
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2037
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2038
		       task->tk_rqstp->rq_rcv_buf.len);
2039 2040
		goto out_eio;
	}
L
Linus Torvalds 已提交
2041 2042 2043
	if ((len -= 3) < 0)
		goto out_overflow;

2044
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2045
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2046
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2047
			task->tk_pid, __func__, n);
T
Trond Myklebust 已提交
2048
		goto out_garbage;
L
Linus Torvalds 已提交
2049
	}
2050

L
Linus Torvalds 已提交
2051 2052 2053 2054
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
J
Joe Perches 已提交
2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
		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 已提交
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077
		}
		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--;
2078
			dprintk("RPC: %5u %s: retry stale creds\n",
2079
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2080
			rpcauth_invalcred(task);
2081 2082
			/* Ensure we obtain a new XID! */
			xprt_release(task);
2083
			task->tk_action = call_reserve;
T
Trond Myklebust 已提交
2084
			goto out_retry;
L
Linus Torvalds 已提交
2085 2086 2087 2088 2089 2090
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
2091
			dprintk("RPC: %5u %s: retry garbled creds\n",
2092
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2093
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
2094
			goto out_retry;
L
Linus Torvalds 已提交
2095
		case RPC_AUTH_TOOWEAK:
2096
			rcu_read_lock();
2097
			printk(KERN_NOTICE "RPC: server %s requires stronger "
2098 2099 2100
			       "authentication.\n",
			       rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
L
Linus Torvalds 已提交
2101 2102
			break;
		default:
2103
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
2104
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2105 2106
			error = -EIO;
		}
2107
		dprintk("RPC: %5u %s: call rejected %d\n",
2108
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2109 2110 2111
		goto out_err;
	}
	if (!(p = rpcauth_checkverf(task, p))) {
2112
		dprintk("RPC: %5u %s: auth check failed\n",
2113
				task->tk_pid, __func__);
T
Trond Myklebust 已提交
2114
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
2115
	}
2116
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
2117 2118 2119 2120 2121 2122
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
2123 2124 2125 2126
		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);
2127 2128
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2129
	case RPC_PROG_MISMATCH:
2130 2131 2132 2133 2134
		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);
2135 2136
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2137
	case RPC_PROC_UNAVAIL:
2138
		dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2139
				"version %u on server %s\n",
2140
				task->tk_pid, __func__,
2141
				rpc_proc_name(task),
2142 2143
				clnt->cl_prog, clnt->cl_vers,
				rcu_dereference(clnt->cl_xprt)->servername);
2144 2145
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
2146
	case RPC_GARBAGE_ARGS:
2147
		dprintk("RPC: %5u %s: server saw garbage\n",
2148
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2149 2150
		break;			/* retry */
	default:
2151
		dprintk("RPC: %5u %s: server accept status: %x\n",
2152
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2153 2154 2155
		/* Also retry */
	}

T
Trond Myklebust 已提交
2156
out_garbage:
2157
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2158 2159
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2160
		dprintk("RPC: %5u %s: retrying\n",
2161
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2162
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2163 2164
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2165 2166 2167 2168 2169
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
2170
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2171
			__func__, error);
T
Trond Myklebust 已提交
2172
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2173
out_overflow:
2174
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2175
			__func__);
T
Trond Myklebust 已提交
2176
	goto out_garbage;
L
Linus Torvalds 已提交
2177
}
2178

2179
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2180 2181 2182
{
}

2183
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2184 2185 2186 2187 2188 2189 2190 2191 2192
{
	return 0;
}

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

2193
static int rpc_ping(struct rpc_clnt *clnt)
2194 2195 2196 2197 2198 2199
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2200
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2201 2202 2203
	put_rpccred(msg.rpc_cred);
	return err;
}
2204

2205 2206 2207 2208 2209 2210
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,
	};
2211 2212 2213 2214 2215 2216
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2217
	return rpc_run_task(&task_setup_data);
2218
}
2219
EXPORT_SYMBOL_GPL(rpc_call_null);
2220

2221
#ifdef RPC_DEBUG
2222 2223
static void rpc_show_header(void)
{
2224 2225
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2226 2227
}

C
Chuck Lever 已提交
2228 2229 2230 2231 2232 2233 2234 2235
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);

2236
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2237 2238 2239
		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),
2240
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2241 2242
}

2243
void rpc_show_tasks(struct net *net)
2244 2245
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2246
	struct rpc_task *task;
2247
	int header = 0;
2248
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2249

2250 2251
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2252
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2253
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2254 2255 2256 2257
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2258
			rpc_show_task(clnt, task);
2259 2260 2261
		}
		spin_unlock(&clnt->cl_lock);
	}
2262
	spin_unlock(&sn->rpc_client_lock);
2263 2264
}
#endif