clnt.c 48.6 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
 *  linux/net/sunrpc/clnt.c
L
Linus Torvalds 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 *  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 <asm/system.h>

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

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

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

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
				struct super_block *sb)
{
	struct dentry *dentry;
	int err = 0;

	switch (event) {
	case RPC_PIPEFS_MOUNT:
		if (clnt->cl_program->pipe_dir_name == NULL)
			break;
		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);
195
		clnt->cl_dentry = dentry;
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
		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;
}

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
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) {
		if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
		    ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
			continue;
		atomic_inc(&clnt->cl_count);
		spin_unlock(&sn->rpc_client_lock);
		return clnt;
	}
	spin_unlock(&sn->rpc_client_lock);
	return NULL;
}

230 231 232 233 234 235 236
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;

237
	while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
238
		error = __rpc_pipefs_event(clnt, event, sb);
239
		rpc_release_client(clnt);
240 241 242 243 244 245 246 247
		if (error)
			break;
	}
	return error;
}

static struct notifier_block rpc_clients_block = {
	.notifier_call	= rpc_pipefs_event,
248
	.priority	= SUNRPC_PIPEFS_RPC_PRIO,
249 250 251 252 253 254 255 256 257 258 259 260
};

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

261
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
262
{
263 264
	const struct rpc_program *program = args->program;
	const struct rpc_version *version;
L
Linus Torvalds 已提交
265
	struct rpc_clnt		*clnt = NULL;
266
	struct rpc_auth		*auth;
L
Linus Torvalds 已提交
267
	int err;
268 269 270 271
	size_t len;

	/* sanity check the name before trying to print it */
	err = -EINVAL;
272
	len = strlen(args->servername);
273 274 275
	if (len > RPC_MAXNETNAMELEN)
		goto out_no_rpciod;
	len++;
L
Linus Torvalds 已提交
276

277
	dprintk("RPC:       creating %s client for %s (xprt %p)\n",
278
			program->name, args->servername, xprt);
L
Linus Torvalds 已提交
279

280 281 282
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
L
Linus Torvalds 已提交
283 284
	err = -EINVAL;
	if (!xprt)
285
		goto out_no_xprt;
286 287 288 289 290

	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
291 292 293
		goto out_err;

	err = -ENOMEM;
294
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
295 296 297 298
	if (!clnt)
		goto out_err;
	clnt->cl_parent = clnt;

299 300 301
	clnt->cl_server = kstrdup(args->servername, GFP_KERNEL);
	if (clnt->cl_server == NULL)
		goto out_no_server;
L
Linus Torvalds 已提交
302

303
	rcu_assign_pointer(clnt->cl_xprt, xprt);
L
Linus Torvalds 已提交
304 305 306
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
	clnt->cl_protname = program->name;
307
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
308 309
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
310
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
311 312 313
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
314
	clnt->cl_program  = program;
315
	INIT_LIST_HEAD(&clnt->cl_tasks);
316
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
317

318
	if (!xprt_bound(xprt))
L
Linus Torvalds 已提交
319 320
		clnt->cl_autobind = 1;

321 322 323 324 325 326 327
	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 已提交
328
	clnt->cl_rtt = &clnt->cl_rtt_default;
329
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
330 331 332 333 334 335
	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 已提交
336

337
	atomic_set(&clnt->cl_count, 1);
338

L
Linus Torvalds 已提交
339 340 341 342
	err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
	if (err < 0)
		goto out_no_path;

343
	auth = rpcauth_create(args->authflavor, clnt);
344
	if (IS_ERR(auth)) {
L
Linus Torvalds 已提交
345
		printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
346
				args->authflavor);
347
		err = PTR_ERR(auth);
L
Linus Torvalds 已提交
348 349 350 351
		goto out_no_auth;
	}

	/* save the nodename */
352
	clnt->cl_nodelen = strlen(init_utsname()->nodename);
L
Linus Torvalds 已提交
353 354
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
355
	memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
356
	rpc_register_client(clnt);
L
Linus Torvalds 已提交
357 358 359
	return clnt;

out_no_auth:
360
	rpc_clnt_remove_pipedir(clnt);
L
Linus Torvalds 已提交
361
out_no_path:
362 363
	kfree(clnt->cl_principal);
out_no_principal:
364 365
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
366 367
	kfree(clnt->cl_server);
out_no_server:
L
Linus Torvalds 已提交
368 369
	kfree(clnt);
out_err:
370
	xprt_put(xprt);
371
out_no_xprt:
372 373
	rpciod_down();
out_no_rpciod:
L
Linus Torvalds 已提交
374 375 376
	return ERR_PTR(err);
}

377 378 379 380 381 382 383 384 385 386 387 388 389 390
/*
 * 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;
391
	struct xprt_create xprtargs = {
P
Pavel Emelyanov 已提交
392
		.net = args->net,
393
		.ident = args->protocol,
394
		.srcaddr = args->saddress,
395 396
		.dstaddr = args->address,
		.addrlen = args->addrsize,
397
		.bc_xprt = args->bc_xprt,
398
	};
399
	char servername[48];
400

401 402 403 404 405
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
	if (args->servername == NULL) {
406 407
		struct sockaddr_un *sun =
				(struct sockaddr_un *)args->address;
408 409 410 411 412
		struct sockaddr_in *sin =
				(struct sockaddr_in *)args->address;
		struct sockaddr_in6 *sin6 =
				(struct sockaddr_in6 *)args->address;

413 414
		servername[0] = '\0';
		switch (args->address->sa_family) {
415 416 417 418
		case AF_LOCAL:
			snprintf(servername, sizeof(servername), "%s",
				 sun->sun_path);
			break;
419
		case AF_INET:
H
Harvey Harrison 已提交
420 421
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
422
			break;
423
		case AF_INET6:
H
Harvey Harrison 已提交
424
			snprintf(servername, sizeof(servername), "%pI6",
425
				 &sin6->sin6_addr);
426 427 428 429 430 431
			break;
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
432 433 434
		args->servername = servername;
	}

435 436 437 438
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

439 440 441 442 443 444 445 446 447 448
	/*
	 * 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;

449
	clnt = rpc_new_client(args, xprt);
450 451 452 453
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
454
		int err = rpc_ping(clnt);
455 456 457 458 459 460 461 462 463 464 465 466
		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;
467 468
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
469 470
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
471 472 473

	return clnt;
}
474
EXPORT_SYMBOL_GPL(rpc_create);
475

L
Linus Torvalds 已提交
476 477 478 479 480 481 482 483 484
/*
 * 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;
485
	struct rpc_xprt *xprt;
486
	int err = -ENOMEM;
L
Linus Torvalds 已提交
487

488
	new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
L
Linus Torvalds 已提交
489 490
	if (!new)
		goto out_no_clnt;
491 492 493
	new->cl_server = kstrdup(clnt->cl_server, GFP_KERNEL);
	if (new->cl_server == NULL)
		goto out_no_server;
494 495 496 497 498
	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);
499
	rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
500 501 502
	new->cl_metrics = rpc_alloc_iostats(clnt);
	if (new->cl_metrics == NULL)
		goto out_no_stats;
503 504 505 506 507
	if (clnt->cl_principal) {
		new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
		if (new->cl_principal == NULL)
			goto out_no_principal;
	}
508 509 510 511 512 513
	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);
514
	atomic_set(&new->cl_count, 1);
515 516 517
	err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
	if (err != 0)
		goto out_no_path;
L
Linus Torvalds 已提交
518 519
	if (new->cl_auth)
		atomic_inc(&new->cl_auth->au_count);
520
	atomic_inc(&clnt->cl_count);
521
	rpc_register_client(new);
522
	rpciod_up();
L
Linus Torvalds 已提交
523
	return new;
524
out_no_path:
525 526
	xprt_put(xprt);
out_no_transport:
527 528
	kfree(new->cl_principal);
out_no_principal:
529
	rpc_free_iostats(new->cl_metrics);
530
out_no_stats:
531 532
	kfree(new->cl_server);
out_no_server:
533
	kfree(new);
L
Linus Torvalds 已提交
534
out_no_clnt:
535
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
536
	return ERR_PTR(err);
L
Linus Torvalds 已提交
537
}
538
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
539

540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
/*
 * 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);
562 563 564
			if (RPC_IS_QUEUED(rovr))
				rpc_wake_up_queued_task(rovr->tk_waitqueue,
							rovr);
565 566 567 568 569 570
		}
	}
	spin_unlock(&clnt->cl_lock);
}
EXPORT_SYMBOL_GPL(rpc_killall_tasks);

L
Linus Torvalds 已提交
571 572
/*
 * Properly shut down an RPC client, terminating all outstanding
573
 * requests.
L
Linus Torvalds 已提交
574
 */
575
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
576
{
577 578
	dprintk("RPC:       shutting down %s client for %s\n",
			clnt->cl_protname, clnt->cl_server);
L
Linus Torvalds 已提交
579

580
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
581
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
582
		wait_event_timeout(destroy_wait,
583
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
584 585
	}

586
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
587
}
588
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
589 590

/*
591
 * Free an RPC client
L
Linus Torvalds 已提交
592
 */
593
static void
594
rpc_free_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
595
{
596
	dprintk("RPC:       destroying %s client for %s\n",
L
Linus Torvalds 已提交
597
			clnt->cl_protname, clnt->cl_server);
598
	if (clnt->cl_parent != clnt)
599
		rpc_release_client(clnt->cl_parent);
600
	kfree(clnt->cl_server);
601
	rpc_unregister_client(clnt);
602
	rpc_clnt_remove_pipedir(clnt);
603
	rpc_free_iostats(clnt->cl_metrics);
604
	kfree(clnt->cl_principal);
605
	clnt->cl_metrics = NULL;
606
	xprt_put(rcu_dereference_raw(clnt->cl_xprt));
607
	rpciod_down();
L
Linus Torvalds 已提交
608 609 610
	kfree(clnt);
}

611 612 613 614
/*
 * Free an RPC client
 */
static void
615
rpc_free_auth(struct rpc_clnt *clnt)
616 617
{
	if (clnt->cl_auth == NULL) {
618
		rpc_free_client(clnt);
619 620 621 622 623 624 625 626
		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.
	 */
627
	atomic_inc(&clnt->cl_count);
628 629
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
630 631
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_client(clnt);
632 633
}

L
Linus Torvalds 已提交
634
/*
635
 * Release reference to the RPC client
L
Linus Torvalds 已提交
636 637 638 639
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
640
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
641

642 643
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
644 645
	if (atomic_dec_and_test(&clnt->cl_count))
		rpc_free_auth(clnt);
646 647
}

648 649
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
650 651 652
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
653 654 655 656 657 658
 *
 * 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,
659
				      const struct rpc_program *program,
660
				      u32 vers)
661 662
{
	struct rpc_clnt *clnt;
663
	const struct rpc_version *version;
664 665 666 667 668 669 670 671 672 673 674 675 676
	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;
677
	err = rpc_ping(clnt);
678 679 680 681
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
682
out:
683 684
	return clnt;
}
685
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
686

687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
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;
708
		atomic_inc(&clnt->cl_count);
709 710 711 712 713 714 715 716 717
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
		/* 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);
	}
}

718 719 720 721 722 723 724 725
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);


726 727 728 729 730 731 732
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;
733 734
		if (msg->rpc_cred != NULL)
			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
735 736 737
	}
}

L
Linus Torvalds 已提交
738 739 740 741
/*
 * Default callback for async RPC calls
 */
static void
742
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
743 744 745
{
}

746 747 748 749
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
750 751 752 753 754
/**
 * 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)
755
{
756
	struct rpc_task *task;
757

758
	task = rpc_new_task(task_setup_data);
759
	if (IS_ERR(task))
760
		goto out;
761

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

768 769 770
	atomic_inc(&task->tk_count);
	rpc_execute(task);
out:
771
	return task;
772
}
T
Trond Myklebust 已提交
773
EXPORT_SYMBOL_GPL(rpc_run_task);
774 775 776 777 778 779

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
780
 */
781
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
782 783
{
	struct rpc_task	*task;
784 785 786 787 788 789
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
790
	int status;
L
Linus Torvalds 已提交
791 792 793

	BUG_ON(flags & RPC_TASK_ASYNC);

T
Trond Myklebust 已提交
794
	task = rpc_run_task(&task_setup_data);
795 796
	if (IS_ERR(task))
		return PTR_ERR(task);
797
	status = task->tk_status;
798
	rpc_put_task(task);
L
Linus Torvalds 已提交
799 800
	return status;
}
801
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
802

803 804 805 806 807
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
808
 * @tk_ops: RPC call ops
809
 * @data: user call data
L
Linus Torvalds 已提交
810 811
 */
int
812
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
813
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
814 815
{
	struct rpc_task	*task;
816 817 818 819 820 821 822
	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 已提交
823

T
Trond Myklebust 已提交
824
	task = rpc_run_task(&task_setup_data);
825 826 827 828
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
829
}
830
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
831

832
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
833 834 835
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
836 837
 * @req: RPC request
 * @tk_ops: RPC call ops
838 839
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
840
				const struct rpc_call_ops *tk_ops)
841 842 843 844 845 846 847 848 849 850 851 852
{
	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);
853
	if (IS_ERR(task)) {
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
		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;
}
875
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
876

877 878 879 880 881 882 883
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

884 885 886 887
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
888
 * @bufsize: length of target buffer
889 890 891 892 893 894
 *
 * 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;
895 896 897 898
	struct rpc_xprt *xprt;

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

900
	bytes = xprt->addrlen;
901 902
	if (bytes > bufsize)
		bytes = bufsize;
903 904 905 906
	memcpy(buf, &xprt->addr, bytes);
	rcu_read_unlock();

	return bytes;
907
}
908
EXPORT_SYMBOL_GPL(rpc_peeraddr);
909

910 911 912 913 914
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
915 916 917
 * 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.
918
 */
919 920
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
921
{
922 923 924
	struct rpc_xprt *xprt;

	xprt = rcu_dereference(clnt->cl_xprt);
925 926 927 928 929

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
930
}
931
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
932

L
Linus Torvalds 已提交
933 934 935
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
936 937 938 939
	struct rpc_xprt *xprt;

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
940 941
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
942
	rcu_read_unlock();
L
Linus Torvalds 已提交
943
}
944
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
945

946 947 948 949 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
/**
 * 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 已提交
981 982 983 984 985 986 987 988
 *
 * 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)
{
989 990 991 992 993 994
	size_t ret;

	rcu_read_lock();
	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
	rcu_read_unlock();
	return ret;
L
Linus Torvalds 已提交
995
}
996
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
997

998 999 1000 1001 1002 1003 1004
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
1005 1006 1007 1008 1009
	if (clnt->cl_autobind) {
		rcu_read_lock();
		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
		rcu_read_unlock();
	}
1010
}
1011
EXPORT_SYMBOL_GPL(rpc_force_rebind);
1012

1013 1014 1015 1016
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
1017
int
1018 1019 1020
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1021
		return 0;
1022 1023 1024
	task->tk_action = call_start;
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
1025
	return 1;
1026 1027 1028
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
1029 1030 1031 1032
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
1033
int
L
Linus Torvalds 已提交
1034 1035 1036
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
1037
		return 0;
L
Linus Torvalds 已提交
1038
	task->tk_action = call_start;
1039
	return 1;
L
Linus Torvalds 已提交
1040
}
1041
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
1042

1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
#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 已提交
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
/*
 * 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;

1069
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1070
			clnt->cl_protname, clnt->cl_vers,
1071
			rpc_proc_name(task),
1072
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085

	/* 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)
{
1086
	dprint_status(task);
L
Linus Torvalds 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100

	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;

1101
	dprint_status(task);
L
Linus Torvalds 已提交
1102 1103 1104 1105 1106 1107 1108 1109

	/*
	 * 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) {
1110
			task->tk_action = call_refresh;
L
Linus Torvalds 已提交
1111 1112 1113 1114
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1115
				__func__, status);
L
Linus Torvalds 已提交
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
		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",
1126
				__func__, status);
L
Linus Torvalds 已提交
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
		xprt_release(task);
	}

	switch (status) {
	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",
1138
				__func__, status);
L
Linus Torvalds 已提交
1139 1140 1141 1142 1143 1144
		break;
	}
	rpc_exit(task, status);
}

/*
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
 * 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;
1169
	task->tk_action = call_refresh;
1170
	switch (status) {
1171 1172 1173
	case 0:
		if (rpcauth_uptodatecred(task))
			task->tk_action = call_allocate;
1174 1175 1176
		return;
	case -ETIMEDOUT:
		rpc_delay(task, 3*HZ);
1177 1178 1179 1180 1181 1182 1183 1184
	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;
1185
	}
1186 1187 1188
	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
				task->tk_pid, __func__, status);
	rpc_exit(task, status);
1189 1190 1191 1192
}

/*
 * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1193
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
1194 1195 1196 1197
 */
static void
call_allocate(struct rpc_task *task)
{
1198
	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1199 1200
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = task->tk_xprt;
1201
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
1202

1203 1204
	dprint_status(task);

1205
	task->tk_status = 0;
1206
	task->tk_action = call_bind;
1207

1208
	if (req->rq_buffer)
L
Linus Torvalds 已提交
1209 1210
		return;

1211 1212 1213 1214 1215
	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 已提交
1216

1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
	/*
	 * 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;

1227 1228
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
1229
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
1230
		return;
1231 1232

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

1234
	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1235
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
1236 1237 1238 1239 1240 1241 1242
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
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;
1253
	task->tk_rqstp->rq_bytes_sent = 0;
1254 1255
}

1256 1257 1258 1259 1260 1261 1262
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;
1263
	buf->flags = 0;
1264 1265 1266 1267
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
1268 1269 1270 1271
/*
 * 3.	Encode arguments of an RPC call
 */
static void
1272
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
1273 1274
{
	struct rpc_rqst	*req = task->tk_rqstp;
1275
	kxdreproc_t	encode;
1276
	__be32		*p;
L
Linus Torvalds 已提交
1277

1278
	dprint_status(task);
L
Linus Torvalds 已提交
1279

1280 1281 1282 1283 1284 1285
	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 已提交
1286

1287 1288 1289
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
1290 1291 1292
		rpc_exit(task, -EIO);
		return;
	}
1293 1294

	encode = task->tk_msg.rpc_proc->p_encode;
1295 1296 1297 1298 1299
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1300 1301 1302 1303 1304 1305 1306 1307
}

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

1310
	dprint_status(task);
L
Linus Torvalds 已提交
1311

1312
	task->tk_action = call_connect;
1313
	if (!xprt_bound(xprt)) {
1314
		task->tk_action = call_bind_status;
1315
		task->tk_timeout = xprt->bind_timeout;
1316
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1317 1318 1319 1320
	}
}

/*
1321 1322 1323 1324 1325
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1326
	int status = -EIO;
1327 1328

	if (task->tk_status >= 0) {
1329
		dprint_status(task);
1330 1331 1332 1333 1334
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

1335
	trace_rpc_bind_status(task);
1336
	switch (task->tk_status) {
1337 1338 1339
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1340
		goto retry_timeout;
1341
	case -EACCES:
1342 1343
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1344 1345 1346 1347 1348
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1349 1350 1351
		if (task->tk_rebind_retry == 0)
			break;
		task->tk_rebind_retry--;
1352
		rpc_delay(task, 3*HZ);
1353
		goto retry_timeout;
1354
	case -ETIMEDOUT:
1355
		dprintk("RPC: %5u rpcbind request timed out\n",
1356
				task->tk_pid);
1357
		goto retry_timeout;
1358
	case -EPFNOSUPPORT:
1359
		/* server doesn't support any rpcbind version we know of */
1360
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1361 1362 1363
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1364
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1365
				task->tk_pid);
1366 1367 1368
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
	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;
1384
	default:
1385
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1386 1387 1388 1389 1390 1391
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1392 1393
retry_timeout:
	task->tk_action = call_timeout;
1394 1395 1396 1397
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1398 1399 1400 1401
 */
static void
call_connect(struct rpc_task *task)
{
1402
	struct rpc_xprt *xprt = task->tk_xprt;
L
Linus Torvalds 已提交
1403

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

1408 1409 1410 1411 1412 1413
	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 已提交
1414 1415 1416 1417
	}
}

/*
1418
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1419 1420 1421 1422 1423 1424 1425
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1426
	dprint_status(task);
1427

L
Linus Torvalds 已提交
1428
	task->tk_status = 0;
1429
	if (status >= 0 || status == -EAGAIN) {
L
Linus Torvalds 已提交
1430 1431 1432 1433 1434
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}

1435
	trace_rpc_connect_status(task, status);
L
Linus Torvalds 已提交
1436
	switch (status) {
1437 1438 1439
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1440 1441 1442
		break;
	default:
		rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1443 1444 1445 1446 1447 1448 1449 1450 1451
	}
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1452
	dprint_status(task);
L
Linus Torvalds 已提交
1453 1454 1455 1456 1457 1458 1459

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1460
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1461
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1462
	if (rpc_task_need_encode(task)) {
1463
		BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1464
		rpc_xdr_encode(task);
1465
		/* Did the encode result in an error condition? */
1466 1467 1468 1469 1470 1471
		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);
1472
			return;
1473
		}
1474
	}
L
Linus Torvalds 已提交
1475 1476 1477
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1478 1479 1480 1481 1482
	/*
	 * 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);
1483
	if (rpc_reply_expected(task))
1484 1485
		return;
	task->tk_action = rpc_exit_task;
1486
	rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
1487 1488 1489 1490 1491 1492 1493 1494 1495
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506

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

1507 1508 1509 1510
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1511
		dprint_status(task);
1512
		xprt_end_transmit(task);
1513 1514
		rpc_task_force_reencode(task);
		break;
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
		/*
		 * 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:
1525 1526 1527 1528 1529 1530 1531
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1532
	case -EPIPE:
1533 1534
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1535 1536
}

1537
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
/*
 * 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);
}
1601
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1602

L
Linus Torvalds 已提交
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
/*
 * 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;

1613 1614
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1615

1616
	dprint_status(task);
L
Linus Torvalds 已提交
1617 1618 1619 1620 1621 1622 1623

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

1624
	trace_rpc_call_status(task);
L
Linus Torvalds 已提交
1625 1626
	task->tk_status = 0;
	switch(status) {
1627 1628 1629 1630 1631 1632 1633 1634
	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 已提交
1635 1636
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1637
		if (task->tk_client->cl_discrtry)
1638 1639
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1640
		break;
1641
	case -ECONNRESET:
L
Linus Torvalds 已提交
1642
	case -ECONNREFUSED:
1643
		rpc_force_rebind(clnt);
1644 1645 1646
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656
		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 已提交
1657 1658
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1659 1660 1661 1662 1663 1664
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
1665
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1666 1667 1668 1669 1670 1671 1672 1673 1674
 * 	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) {
1675
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1676 1677 1678
		goto retry;
	}

1679
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1680 1681
	task->tk_timeouts++;

1682 1683 1684 1685
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
1686
	if (RPC_IS_SOFT(task)) {
O
Olga Kornievskaia 已提交
1687 1688
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
L
Linus Torvalds 已提交
1689
				clnt->cl_protname, clnt->cl_server);
1690 1691 1692 1693
		if (task->tk_flags & RPC_TASK_TIMEOUT)
			rpc_exit(task, -ETIMEDOUT);
		else
			rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1694 1695 1696
		return;
	}

C
Chuck Lever 已提交
1697
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1698
		task->tk_flags |= RPC_CALL_MAJORSEEN;
O
Olga Kornievskaia 已提交
1699 1700
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
L
Linus Torvalds 已提交
1701 1702
			clnt->cl_protname, clnt->cl_server);
	}
1703
	rpc_force_rebind(clnt);
1704 1705 1706 1707 1708
	/*
	 * 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 已提交
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723

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

1727
	dprint_status(task);
L
Linus Torvalds 已提交
1728

C
Chuck Lever 已提交
1729
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
O
Olga Kornievskaia 已提交
1730 1731 1732
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s OK\n",
				clnt->cl_protname, clnt->cl_server);
L
Linus Torvalds 已提交
1733 1734 1735
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

1736 1737
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
1738
	 * before it changed req->rq_reply_bytes_recvd.
1739 1740
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1741 1742 1743 1744 1745 1746
	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);

1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
	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;
	}

1759
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
1760 1761 1762 1763
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
1764 1765
	}

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

1768
	if (decode) {
L
Linus Torvalds 已提交
1769 1770
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
1771
	}
1772 1773
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
1774 1775 1776
	return;
out_retry:
	task->tk_status = 0;
1777
	/* Note: rpc_verify_header() may have freed the RPC slot */
1778
	if (task->tk_rqstp == req) {
1779
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1780
		if (task->tk_client->cl_discrtry)
1781 1782
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
1783
	}
L
Linus Torvalds 已提交
1784 1785
}

1786
static __be32 *
1787
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1788 1789 1790
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
1791
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
1792 1793

	/* FIXME: check buffer size? */
1794 1795

	p = xprt_skip_transport_header(task->tk_xprt, p);
L
Linus Torvalds 已提交
1796 1797 1798 1799 1800 1801
	*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 */
1802 1803 1804
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
1805 1806
}

1807
static __be32 *
1808
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1809 1810 1811
{
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1812 1813
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
1814 1815
	int error = -EACCES;

1816 1817 1818 1819 1820 1821
	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
		 */
1822
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
1823
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
1824
		       task->tk_rqstp->rq_rcv_buf.len);
1825 1826
		goto out_eio;
	}
L
Linus Torvalds 已提交
1827 1828 1829
	if ((len -= 3) < 0)
		goto out_overflow;

1830
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
1831
	if ((n = ntohl(*p++)) != RPC_REPLY) {
1832
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1833
			task->tk_pid, __func__, n);
T
Trond Myklebust 已提交
1834
		goto out_garbage;
L
Linus Torvalds 已提交
1835
	}
1836

L
Linus Torvalds 已提交
1837 1838 1839 1840
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
J
Joe Perches 已提交
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
		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 已提交
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
		}
		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--;
1864
			dprintk("RPC: %5u %s: retry stale creds\n",
1865
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
1866
			rpcauth_invalcred(task);
1867 1868
			/* Ensure we obtain a new XID! */
			xprt_release(task);
1869
			task->tk_action = call_reserve;
T
Trond Myklebust 已提交
1870
			goto out_retry;
L
Linus Torvalds 已提交
1871 1872 1873 1874 1875 1876
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
1877
			dprintk("RPC: %5u %s: retry garbled creds\n",
1878
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
1879
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
1880
			goto out_retry;
L
Linus Torvalds 已提交
1881
		case RPC_AUTH_TOOWEAK:
1882
			printk(KERN_NOTICE "RPC: server %s requires stronger "
1883
			       "authentication.\n", task->tk_client->cl_server);
L
Linus Torvalds 已提交
1884 1885
			break;
		default:
1886
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
1887
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1888 1889
			error = -EIO;
		}
1890
		dprintk("RPC: %5u %s: call rejected %d\n",
1891
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1892 1893 1894
		goto out_err;
	}
	if (!(p = rpcauth_checkverf(task, p))) {
1895
		dprintk("RPC: %5u %s: auth check failed\n",
1896
				task->tk_pid, __func__);
T
Trond Myklebust 已提交
1897
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
1898
	}
1899
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
1900 1901 1902 1903 1904 1905
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
1906
		dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1907
				task->tk_pid, __func__,
L
Linus Torvalds 已提交
1908 1909
				(unsigned int)task->tk_client->cl_prog,
				task->tk_client->cl_server);
1910 1911
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1912
	case RPC_PROG_MISMATCH:
1913
		dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1914
				"server %s\n", task->tk_pid, __func__,
L
Linus Torvalds 已提交
1915 1916 1917
				(unsigned int)task->tk_client->cl_prog,
				(unsigned int)task->tk_client->cl_vers,
				task->tk_client->cl_server);
1918 1919
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1920
	case RPC_PROC_UNAVAIL:
1921
		dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
1922
				"version %u on server %s\n",
1923
				task->tk_pid, __func__,
1924
				rpc_proc_name(task),
L
Linus Torvalds 已提交
1925 1926 1927
				task->tk_client->cl_prog,
				task->tk_client->cl_vers,
				task->tk_client->cl_server);
1928 1929
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
1930
	case RPC_GARBAGE_ARGS:
1931
		dprintk("RPC: %5u %s: server saw garbage\n",
1932
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
1933 1934
		break;			/* retry */
	default:
1935
		dprintk("RPC: %5u %s: server accept status: %x\n",
1936
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1937 1938 1939
		/* Also retry */
	}

T
Trond Myklebust 已提交
1940
out_garbage:
L
Linus Torvalds 已提交
1941 1942 1943
	task->tk_client->cl_stats->rpcgarbage++;
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
1944
		dprintk("RPC: %5u %s: retrying\n",
1945
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
1946
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
1947 1948
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
1949 1950 1951 1952 1953
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
1954
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1955
			__func__, error);
T
Trond Myklebust 已提交
1956
	return ERR_PTR(error);
L
Linus Torvalds 已提交
1957
out_overflow:
1958
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1959
			__func__);
T
Trond Myklebust 已提交
1960
	goto out_garbage;
L
Linus Torvalds 已提交
1961
}
1962

1963
static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
1964 1965 1966
{
}

1967
static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
1968 1969 1970 1971 1972 1973 1974 1975 1976
{
	return 0;
}

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

1977
static int rpc_ping(struct rpc_clnt *clnt)
1978 1979 1980 1981 1982 1983
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1984
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
1985 1986 1987
	put_rpccred(msg.rpc_cred);
	return err;
}
1988

1989 1990 1991 1992 1993 1994
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,
	};
1995 1996 1997 1998 1999 2000
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
2001
	return rpc_run_task(&task_setup_data);
2002
}
2003
EXPORT_SYMBOL_GPL(rpc_call_null);
2004

2005
#ifdef RPC_DEBUG
2006 2007
static void rpc_show_header(void)
{
2008 2009
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
2010 2011
}

C
Chuck Lever 已提交
2012 2013 2014 2015 2016 2017 2018 2019
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);

2020
	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2021 2022 2023
		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),
2024
		task->tk_action, rpc_waitq);
C
Chuck Lever 已提交
2025 2026
}

2027
void rpc_show_tasks(struct net *net)
2028 2029
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
2030
	struct rpc_task *task;
2031
	int header = 0;
2032
	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2033

2034 2035
	spin_lock(&sn->rpc_client_lock);
	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2036
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
2037
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2038 2039 2040 2041
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
2042
			rpc_show_task(clnt, task);
2043 2044 2045
		}
		spin_unlock(&clnt->cl_lock);
	}
2046
	spin_unlock(&sn->rpc_client_lock);
2047 2048
}
#endif