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

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

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

177 178 179 180 181 182 183 184 185 186
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)
187 188 189 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);
		BUG_ON(dentry == NULL);
		if (IS_ERR(dentry))
			return PTR_ERR(dentry);
198
		clnt->cl_dentry = dentry;
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
		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;
}

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

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

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

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

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

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

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

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

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

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

	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
311 312 313
		goto out_err;

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

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

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

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

353
	atomic_set(&clnt->cl_count, 1);
354

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

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

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

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

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

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

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

447 448 449 450
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

451 452 453 454 455 456 457 458 459 460
	/*
	 * 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;

461
	clnt = rpc_new_client(args, xprt);
462 463 464 465
	if (IS_ERR(clnt))
		return clnt;

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

	return clnt;
}
486
EXPORT_SYMBOL_GPL(rpc_create);
487

L
Linus Torvalds 已提交
488 489 490 491 492 493 494 495 496
/*
 * This function clones the RPC client structure. It allows us to share the
 * same transport while varying parameters such as the authentication
 * flavour.
 */
struct rpc_clnt *
rpc_clone_client(struct rpc_clnt *clnt)
{
	struct rpc_clnt *new;
497
	struct rpc_xprt *xprt;
498
	int err = -ENOMEM;
L
Linus Torvalds 已提交
499

500
	new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
L
Linus Torvalds 已提交
501 502
	if (!new)
		goto out_no_clnt;
503 504 505 506 507
	new->cl_parent = clnt;
	/* Turn off autobind on clones */
	new->cl_autobind = 0;
	INIT_LIST_HEAD(&new->cl_tasks);
	spin_lock_init(&new->cl_lock);
508
	rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
509 510 511
	new->cl_metrics = rpc_alloc_iostats(clnt);
	if (new->cl_metrics == NULL)
		goto out_no_stats;
512 513 514 515 516
	if (clnt->cl_principal) {
		new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
		if (new->cl_principal == NULL)
			goto out_no_principal;
	}
517 518 519 520 521 522
	rcu_read_lock();
	xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
	rcu_read_unlock();
	if (xprt == NULL)
		goto out_no_transport;
	rcu_assign_pointer(new->cl_xprt, xprt);
523
	atomic_set(&new->cl_count, 1);
524 525 526
	err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
	if (err != 0)
		goto out_no_path;
527
	rpc_clnt_set_nodename(new, utsname()->nodename);
L
Linus Torvalds 已提交
528 529
	if (new->cl_auth)
		atomic_inc(&new->cl_auth->au_count);
530
	atomic_inc(&clnt->cl_count);
531
	rpc_register_client(new);
532
	rpciod_up();
L
Linus Torvalds 已提交
533
	return new;
534
out_no_path:
535 536
	xprt_put(xprt);
out_no_transport:
537 538
	kfree(new->cl_principal);
out_no_principal:
539
	rpc_free_iostats(new->cl_metrics);
540 541
out_no_stats:
	kfree(new);
L
Linus Torvalds 已提交
542
out_no_clnt:
543
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
544
	return ERR_PTR(err);
L
Linus Torvalds 已提交
545
}
546
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
547

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
/*
 * 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);
570 571 572
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
573 574 575 576 577 578
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
579 580
/*
 * Properly shut down an RPC client, terminating all outstanding
581
 * requests.
L
Linus Torvalds 已提交
582
 */
583
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
584
{
585 586 587
	dprintk_rcu("RPC:       shutting down %s client for %s\n",
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
L
Linus Torvalds 已提交
588

589
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
590
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
591
		wait_event_timeout(destroy_wait,
592
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
593 594
	}

595
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
596
}
597
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
598 599

/*
600
 * Free an RPC client
L
Linus Torvalds 已提交
601
 */
602
static void
603
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
604
{
605 606 607
	dprintk_rcu("RPC:       destroying %s client for %s\n",
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
608
	if (clnt->cl_parent != clnt)
609
		rpc_release_client(clnt->cl_parent);
610
	rpc_unregister_client(clnt);
611
	rpc_clnt_remove_pipedir(clnt);
612
	rpc_free_iostats(clnt->cl_metrics);
613
	kfree(clnt->cl_principal);
614
	clnt->cl_metrics = NULL;
615
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
616
	rpciod_down();
L
Linus Torvalds 已提交
617 618 619
	kfree(clnt);
}

620 621 622 623
/*
 * Free an RPC client
 */
static void
624
rpc_free_auth(struct rpc_clnt *clnt)
625 626
{
	if (clnt->cl_auth == NULL) {
627
		rpc_free_client(clnt);
628 629 630 631 632 633 634 635
		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.
	 */
636
	atomic_inc(&clnt->cl_count);
637 638
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
639 640
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
641 642
}

L
Linus Torvalds 已提交
643
/*
644
 * Release reference to the RPC client
L
Linus Torvalds 已提交
645 646 647 648
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
649
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
650

651 652
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
653 654
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_auth(clnt);
655 656
}

657 658
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
659 660 661
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
662 663 664 665 666 667
 *
 * 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,
668
				      const struct rpc_program *program,
669
				      u32 vers)
670 671
{
	struct rpc_clnt *clnt;
672
	const struct rpc_version *version;
673 674 675 676 677 678 679 680 681 682 683 684 685
	int err;

	BUG_ON(vers >= program->nrvers || !program->version[vers]);
	version = program->version[vers];
	clnt = rpc_clone_client(old);
	if (IS_ERR(clnt))
		goto out;
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
	clnt->cl_protname = program->name;
	clnt->cl_prog     = program->number;
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
686
	err = rpc_ping(clnt);
687 688 689 690
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
691
out:
692 693
	return clnt;
}
694
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
695

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
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;
717
		atomic_inc(&clnt->cl_count);
718 719
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
M
Mel Gorman 已提交
720 721 722 723 724 725 726 727 728
		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();
		}
729 730 731 732 733 734 735
		/* 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);
	}
}

736 737 738 739 740 741 742 743
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);


744 745 746 747 748 749 750
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;
751 752
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
753 754 755
	}
}

L
Linus Torvalds 已提交
756 757 758 759
/*
 * Default callback for async RPC calls
 */
static void
760
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
761 762 763
{
}

764 765 766 767
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
768 769 770 771 772
/**
 * 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)
773
{
774
	struct rpc_task *task;
775

776
	task = rpc_new_task(task_setup_data);
777
	if (IS_ERR(task))
778
		goto out;
779

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

786 787 788
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
789
	return task;
790
}
T
Trond Myklebust 已提交
791
EXPORT_SYMBOL_GPL(rpc_run_task);
792 793 794 795 796 797

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
798
 */
799
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
800 801
{
	struct rpc_task	*task;
802 803 804 805 806 807
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
808
	int status;
L
Linus Torvalds 已提交
809 810 811

	BUG_ON(flags & RPC_TASK_ASYNC);

T
Trond Myklebust 已提交
812
	task = rpc_run_task(&task_setup_data);
813 814
	if (IS_ERR(task))
		return PTR_ERR(task);
815
	status = task->tk_status;
816
	rpc_put_task(task);
L
Linus Torvalds 已提交
817 818
	return status;
}
819
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
820

821 822 823 824 825
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
826
 * @tk_ops: RPC call ops
827
 * @data: user call data
L
Linus Torvalds 已提交
828 829
 */
int
830
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
831
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
832 833
{
	struct rpc_task	*task;
834 835 836 837 838 839 840
	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 已提交
841

T
Trond Myklebust 已提交
842
	task = rpc_run_task(&task_setup_data);
843 844 845 846
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
847
}
848
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
849

850
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
851 852 853
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
854 855
 * @req: RPC request
 * @tk_ops: RPC call ops
856 857
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
858
				const struct rpc_call_ops *tk_ops)
859 860 861 862 863 864 865 866 867 868 869 870
{
	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);
871
	if (IS_ERR(task)) {
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
		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);
	BUG_ON(atomic_read(&task->tk_count) != 2);
	rpc_execute(task);

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

895 896 897 898 899 900 901
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

902 903 904 905
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
906
 * @bufsize: length of target buffer
907 908 909 910 911 912
 *
 * 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;
913 914 915 916
	struct rpc_xprt *xprt;

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

918
	bytes = xprt->addrlen;
919 920
	if (bytes > bufsize)
		bytes = bufsize;
921 922 923 924
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
925
}
926
EXPORT_SYMBOL_GPL(rpc_peeraddr);
927

928 929 930 931 932
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
933 934 935
 * 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.
936
 */
937 938
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
939
{
940 941 942
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
943 944 945 946 947

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
948
}
949
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
950

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 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
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 已提交
1100 1101 1102
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
1103 1104 1105 1106
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
1107 1108
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1109
	rcu_read_unlock();
L
Linus Torvalds 已提交
1110
}
1111
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
1112

1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
/**
 * 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 已提交
1148 1149 1150 1151 1152 1153 1154 1155
 *
 * 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)
{
1156 1157 1158 1159 1160 1161
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
1162
}
1163
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
1164

1165 1166 1167 1168 1169 1170 1171
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1172 1173 1174 1175 1176
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1177
}
1178
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1179

1180 1181 1182 1183
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1184
int
1185 1186 1187
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1188
		return 0;
1189 1190 1191
	task->tk_action = call_start;
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1192
	return 1;
1193 1194 1195
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1196 1197 1198 1199
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1200
int
L
Linus Torvalds 已提交
1201 1202 1203
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1204
		return 0;
L
Linus Torvalds 已提交
1205
	task->tk_action = call_start;
1206
	return 1;
L
Linus Torvalds 已提交
1207
}
1208
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1209

1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
#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 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
/*
 * 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;

1236
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1237
			clnt->cl_protname, clnt->cl_vers,
1238
			rpc_proc_name(task),
1239
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252

	/* 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)
{
1253
	dprint_status(task);
L
Linus Torvalds 已提交
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267

	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;

1268
	dprint_status(task);
L
Linus Torvalds 已提交
1269 1270 1271 1272 1273 1274 1275 1276

	/*
	 * 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) {
1277
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1278 1279 1280 1281
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1282
				__func__, status);
L
Linus Torvalds 已提交
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
		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",
1293
				__func__, status);
L
Linus Torvalds 已提交
1294 1295 1296 1297
		xprt_release(task);
	}

	switch (status) {
1298 1299
	case -ENOMEM:
		rpc_delay(task, HZ >> 2);
L
Linus Torvalds 已提交
1300 1301 1302 1303 1304 1305 1306
	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",
1307
				__func__, status);
L
Linus Torvalds 已提交
1308 1309 1310 1311 1312 1313
		break;
	}
	rpc_exit(task, status);
}

/*
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
 * 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;
1338
	task->tk_action = call_refresh;
1339
	switch (status) {
1340 1341 1342
	case 0:
		if (rpcauth_uptodatecred(task))
			task->tk_action = call_allocate;
1343 1344 1345
		return;
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1346 1347 1348 1349 1350 1351 1352 1353
	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;
1354
	}
1355 1356 1357
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1358 1359 1360 1361
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1362
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1363 1364 1365 1366
 */
static void
call_allocate(struct rpc_task *task)
{
1367
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1368 1369
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = task->tk_xprt;
1370
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1371

1372 1373
	dprint_status(task);

1374
	task->tk_status = 0;
1375
	task->tk_action = call_bind;
1376

1377
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1378 1379
		return;

1380 1381 1382 1383 1384
	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 已提交
1385

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
	/*
	 * 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;

1396 1397
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1398
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1399
		return;
1400 1401

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

1403
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1404
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1405 1406 1407 1408 1409 1410 1411
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
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;
1422
	task->tk_rqstp->rq_bytes_sent = 0;
1423 1424
}

1425 1426 1427 1428 1429 1430 1431
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;
1432
	buf->flags = 0;
1433 1434 1435 1436
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1437 1438 1439 1440
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1441
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1442 1443
{
	struct rpc_rqst	*req = task->tk_rqstp;
1444
	kxdreproc_t	encode;
1445
	__be32		*p;
L
Linus Torvalds 已提交
1446

1447
	dprint_status(task);
L
Linus Torvalds 已提交
1448

1449 1450 1451 1452 1453 1454
	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 已提交
1455

1456 1457 1458
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1459 1460 1461
		rpc_exit(task, -EIO);
		return;
	}
1462 1463

	encode = task->tk_msg.rpc_proc->p_encode;
1464 1465 1466 1467 1468
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1469 1470 1471 1472 1473 1474 1475 1476
}

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

1479
	dprint_status(task);
L
Linus Torvalds 已提交
1480

1481
	task->tk_action = call_connect;
1482
	if (!xprt_bound(xprt)) {
1483
		task->tk_action = call_bind_status;
1484
		task->tk_timeout = xprt->bind_timeout;
1485
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1486 1487 1488 1489
	}
}

/*
1490 1491 1492 1493 1494
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1495
	int status = -EIO;
1496 1497

	if (task->tk_status >= 0) {
1498
		dprint_status(task);
1499 1500 1501 1502 1503
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1504
	trace_rpc_bind_status(task);
1505
	switch (task->tk_status) {
1506 1507 1508
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1509
		goto retry_timeout;
1510
	case -EACCES:
1511 1512
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1513 1514 1515 1516 1517
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1518 1519 1520
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1521
		rpc_delay(task, 3*HZ);
1522
		goto retry_timeout;
1523
	case -ETIMEDOUT:
1524
		dprintk("RPC: %5u rpcbind request timed out\n",
1525
				task->tk_pid);
1526
		goto retry_timeout;
1527
	case -EPFNOSUPPORT:
1528
		/* server doesn't support any rpcbind version we know of */
1529
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1530 1531 1532
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1533
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1534
				task->tk_pid);
1535 1536 1537
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
	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;
1553
	default:
1554
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1555 1556 1557 1558 1559 1560
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1561 1562
retry_timeout:
	task->tk_action = call_timeout;
1563 1564 1565 1566
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1567 1568 1569 1570
 */
static void
call_connect(struct rpc_task *task)
{
1571
	struct rpc_xprt *xprt = task->tk_xprt;
L
Linus Torvalds 已提交
1572

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

1577 1578 1579 1580 1581 1582
	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 已提交
1583 1584 1585 1586
	}
}

/*
1587
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1588 1589 1590 1591 1592 1593 1594
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1595
	dprint_status(task);
1596

L
Linus Torvalds 已提交
1597
	task->tk_status = 0;
1598
	if (status >= 0 || status == -EAGAIN) {
L
Linus Torvalds 已提交
1599 1600 1601 1602 1603
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}

1604
	trace_rpc_connect_status(task, status);
L
Linus Torvalds 已提交
1605
	switch (status) {
1606 1607 1608
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1609 1610 1611
		break;
	default:
		rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1612 1613 1614 1615 1616 1617 1618 1619 1620
	}
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1621
	dprint_status(task);
L
Linus Torvalds 已提交
1622 1623 1624 1625 1626 1627 1628

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1629
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1630
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1631
	if (rpc_task_need_encode(task)) {
1632
		BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1633
		rpc_xdr_encode(task);
1634
		/* Did the encode result in an error condition? */
1635 1636 1637 1638 1639 1640
		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);
1641
			return;
1642
		}
1643
	}
L
Linus Torvalds 已提交
1644 1645 1646
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1647 1648 1649 1650 1651
	/*
	 * 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);
1652
	if (rpc_reply_expected(task))
1653 1654
		return;
	task->tk_action = rpc_exit_task;
1655
	rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
1656 1657 1658 1659 1660 1661 1662 1663 1664
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675

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

1676 1677 1678 1679
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1680
		dprint_status(task);
1681
		xprt_end_transmit(task);
1682 1683
		rpc_task_force_reencode(task);
		break;
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693
		/*
		 * 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:
1694 1695 1696 1697 1698 1699 1700
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1701
	case -EPIPE:
1702 1703
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1704 1705
}

1706
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 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
/*
 * 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;

	BUG_ON(task->tk_status != 0);
	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);
		xprt_conditional_disconnect(task->tk_xprt,
			req->rq_connect_cookie);
		break;
	default:
		/*
		 * We were unable to reply and will have to drop the
		 * request.  The server should reconnect and retransmit.
		 */
		BUG_ON(task->tk_status == -EAGAIN);
		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);
}
1770
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1771

L
Linus Torvalds 已提交
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
/*
 * 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;

1782 1783
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1784

1785
	dprint_status(task);
L
Linus Torvalds 已提交
1786 1787 1788 1789 1790 1791 1792

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

1793
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1794 1795
	task->tk_status = 0;
	switch(status) {
1796 1797 1798 1799 1800 1801 1802 1803
	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 已提交
1804 1805
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1806
		if (task->tk_client->cl_discrtry)
1807 1808
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1809
		break;
1810
	case -ECONNRESET:
L
Linus Torvalds 已提交
1811
	case -ECONNREFUSED:
1812
		rpc_force_rebind(clnt);
1813 1814 1815
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825
		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 已提交
1826 1827
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1828 1829 1830 1831 1832 1833
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
1834
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1835 1836 1837 1838 1839 1840 1841 1842 1843
 * 	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) {
1844
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1845 1846 1847
		goto retry;
	}

1848
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1849 1850
	task->tk_timeouts++;

1851 1852 1853 1854
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
1855
	if (RPC_IS_SOFT(task)) {
J
Joe Perches 已提交
1856
		if (clnt->cl_chatty) {
1857
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1858
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1859 1860 1861
				clnt->cl_protname,
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
J
Joe Perches 已提交
1862
		}
1863 1864 1865 1866
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1867 1868 1869
		return;
	}

C
Chuck Lever 已提交
1870
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1871
		task->tk_flags |= RPC_CALL_MAJORSEEN;
1872 1873
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1874
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1875 1876 1877 1878
			clnt->cl_protname,
			rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1879
	}
1880
	rpc_force_rebind(clnt);
1881 1882 1883 1884 1885
	/*
	 * 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 已提交
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900

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

1904
	dprint_status(task);
L
Linus Torvalds 已提交
1905

C
Chuck Lever 已提交
1906
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1907 1908
		if (clnt->cl_chatty) {
			rcu_read_lock();
O
Olga Kornievskaia 已提交
1909
			printk(KERN_NOTICE "%s: server %s OK\n",
1910 1911 1912 1913
				clnt->cl_protname,
				rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
		}
L
Linus Torvalds 已提交
1914 1915 1916
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

1917 1918
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
1919
	 * before it changed req->rq_reply_bytes_recvd.
1920 1921
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1922 1923 1924 1925 1926 1927
	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);

1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
	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;
	}

1940
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
1941 1942 1943 1944
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
1945 1946
	}

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

1949
	if (decode) {
L
Linus Torvalds 已提交
1950 1951
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
1952
	}
1953 1954
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
1955 1956 1957
	return;
out_retry:
	task->tk_status = 0;
1958
	/* Note: rpc_verify_header() may have freed the RPC slot */
1959
	if (task->tk_rqstp == req) {
1960
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1961
		if (task->tk_client->cl_discrtry)
1962 1963
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
1964
	}
L
Linus Torvalds 已提交
1965 1966
}

1967
static __be32 *
1968
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1969 1970 1971
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
1972
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
1973 1974

	/* FIXME: check buffer size? */
1975 1976

	p = xprt_skip_transport_header(task->tk_xprt, p);
L
Linus Torvalds 已提交
1977 1978 1979 1980 1981 1982
	*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 */
1983 1984 1985
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
1986 1987
}

1988
static __be32 *
1989
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1990
{
1991
	struct rpc_clnt *clnt = task->tk_client;
L
Linus Torvalds 已提交
1992 1993
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1994 1995
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
1996 1997
	int error = -EACCES;

1998 1999 2000 2001 2002 2003
	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
		 */
2004
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2005
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2006
		       task->tk_rqstp->rq_rcv_buf.len);
2007 2008
		goto out_eio;
	}
L
Linus Torvalds 已提交
2009 2010 2011
	if ((len -= 3) < 0)
		goto out_overflow;

2012
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
2013
	if ((n = ntohl(*p++)) != RPC_REPLY) {
2014
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2015
			task->tk_pid, __func__, n);
T
Trond Myklebust 已提交
2016
		goto out_garbage;
L
Linus Torvalds 已提交
2017
	}
2018

L
Linus Torvalds 已提交
2019 2020 2021 2022
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
J
Joe Perches 已提交
2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
		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 已提交
2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045
		}
		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--;
2046
			dprintk("RPC: %5u %s: retry stale creds\n",
2047
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2048
			rpcauth_invalcred(task);
2049 2050
			/* Ensure we obtain a new XID! */
			xprt_release(task);
2051
			task->tk_action = call_reserve;
T
Trond Myklebust 已提交
2052
			goto out_retry;
L
Linus Torvalds 已提交
2053 2054 2055 2056 2057 2058
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
2059
			dprintk("RPC: %5u %s: retry garbled creds\n",
2060
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
2061
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
2062
			goto out_retry;
L
Linus Torvalds 已提交
2063
		case RPC_AUTH_TOOWEAK:
2064
			rcu_read_lock();
2065
			printk(KERN_NOTICE "RPC: server %s requires stronger "
2066 2067 2068
			       "authentication.\n",
			       rcu_dereference(clnt->cl_xprt)->servername);
			rcu_read_unlock();
L
Linus Torvalds 已提交
2069 2070
			break;
		default:
2071
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
2072
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2073 2074
			error = -EIO;
		}
2075
		dprintk("RPC: %5u %s: call rejected %d\n",
2076
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2077 2078 2079
		goto out_err;
	}
	if (!(p = rpcauth_checkverf(task, p))) {
2080
		dprintk("RPC: %5u %s: auth check failed\n",
2081
				task->tk_pid, __func__);
T
Trond Myklebust 已提交
2082
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
2083
	}
2084
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
2085 2086 2087 2088 2089 2090
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
2091 2092 2093 2094
		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);
2095 2096
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2097
	case RPC_PROG_MISMATCH:
2098 2099 2100 2101 2102
		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);
2103 2104
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
2105
	case RPC_PROC_UNAVAIL:
2106
		dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2107
				"version %u on server %s\n",
2108
				task->tk_pid, __func__,
2109
				rpc_proc_name(task),
2110 2111
				clnt->cl_prog, clnt->cl_vers,
				rcu_dereference(clnt->cl_xprt)->servername);
2112 2113
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
2114
	case RPC_GARBAGE_ARGS:
2115
		dprintk("RPC: %5u %s: server saw garbage\n",
2116
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2117 2118
		break;			/* retry */
	default:
2119
		dprintk("RPC: %5u %s: server accept status: %x\n",
2120
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
2121 2122 2123
		/* Also retry */
	}

T
Trond Myklebust 已提交
2124
out_garbage:
2125
	clnt->cl_stats->rpcgarbage++;
L
Linus Torvalds 已提交
2126 2127
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
2128
		dprintk("RPC: %5u %s: retrying\n",
2129
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
2130
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
2131 2132
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
2133 2134 2135 2136 2137
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
2138
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2139
			__func__, error);
T
Trond Myklebust 已提交
2140
	return ERR_PTR(error);
L
Linus Torvalds 已提交
2141
out_overflow:
2142
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2143
			__func__);
T
Trond Myklebust 已提交
2144
	goto out_garbage;
L
Linus Torvalds 已提交
2145
}
2146

2147
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2148 2149 2150
{
}

2151
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2152 2153 2154 2155 2156 2157 2158 2159 2160
{
	return 0;
}

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

2161
static int rpc_ping(struct rpc_clnt *clnt)
2162 2163 2164 2165 2166 2167
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2168
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2169 2170 2171
	put_rpccred(msg.rpc_cred);
	return err;
}
2172

2173 2174 2175 2176 2177 2178
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,
	};
2179 2180 2181 2182 2183 2184
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2185
	return rpc_run_task(&task_setup_data);
2186
}
2187
EXPORT_SYMBOL_GPL(rpc_call_null);
2188

2189
#ifdef RPC_DEBUG
2190 2191
static void rpc_show_header(void)
{
2192 2193
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2194 2195
}

C
Chuck Lever 已提交
2196 2197 2198 2199 2200 2201 2202 2203
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);

2204
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2205 2206 2207
		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),
2208
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2209 2210
}

2211
void rpc_show_tasks(struct net *net)
2212 2213
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2214
	struct rpc_task *task;
2215
	int header = 0;
2216
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2217

2218 2219
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2220
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2221
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2222 2223 2224 2225
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2226
			rpc_show_task(clnt, task);
2227 2228 2229
		}
		spin_unlock(&clnt->cl_lock);
	}
2230
	spin_unlock(&sn->rpc_client_lock);
2231 2232
}
#endif