clnt.c 42.5 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 24 25 26 27
 *
 *  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.
 *
 *  NB: BSD uses a more intelligent approach to guessing when a request
 *  or reply has been lost by keeping the RTO estimate for each procedure.
 *  We currently make do with a constant timeout value.
 *
 *  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>
28
#include <linux/kallsyms.h>
L
Linus Torvalds 已提交
29
#include <linux/mm.h>
30 31
#include <linux/namei.h>
#include <linux/mount.h>
L
Linus Torvalds 已提交
32 33
#include <linux/slab.h>
#include <linux/utsname.h>
34
#include <linux/workqueue.h>
35
#include <linux/in6.h>
L
Linus Torvalds 已提交
36 37 38

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

42
#include "sunrpc.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 56 57
/*
 * All RPC clients are linked into this list
 */
static LIST_HEAD(all_clients);
static DEFINE_SPINLOCK(rpc_client_lock);

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

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

84 85 86 87 88 89 90 91 92 93 94 95 96
static void rpc_register_client(struct rpc_clnt *clnt)
{
	spin_lock(&rpc_client_lock);
	list_add(&clnt->cl_clients, &all_clients);
	spin_unlock(&rpc_client_lock);
}

static void rpc_unregister_client(struct rpc_clnt *clnt)
{
	spin_lock(&rpc_client_lock);
	list_del(&clnt->cl_clients);
	spin_unlock(&rpc_client_lock);
}
L
Linus Torvalds 已提交
97 98 99 100

static int
rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
{
101
	static uint32_t clntid;
102 103 104 105 106 107
	struct nameidata nd;
	struct path path;
	char name[15];
	struct qstr q = {
		.name = name,
	};
L
Linus Torvalds 已提交
108 109
	int error;

110 111
	clnt->cl_path.mnt = ERR_PTR(-ENOENT);
	clnt->cl_path.dentry = ERR_PTR(-ENOENT);
L
Linus Torvalds 已提交
112 113
	if (dir_name == NULL)
		return 0;
114

115 116 117 118 119 120
	path.mnt = rpc_get_mount();
	if (IS_ERR(path.mnt))
		return PTR_ERR(path.mnt);
	error = vfs_path_lookup(path.mnt->mnt_root, path.mnt, dir_name, 0, &nd);
	if (error)
		goto err;
121

122
	for (;;) {
123 124 125 126 127 128 129
		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);
		path.dentry = rpc_create_client_dir(nd.path.dentry, &q, clnt);
		if (!IS_ERR(path.dentry))
			break;
		error = PTR_ERR(path.dentry);
130
		if (error != -EEXIST) {
131 132 133 134
			printk(KERN_INFO "RPC: Couldn't create pipefs entry"
					" %s/%s, error %d\n",
					dir_name, name, error);
			goto err_path_put;
135
		}
L
Linus Torvalds 已提交
136
	}
137 138 139 140 141 142 143 144
	path_put(&nd.path);
	clnt->cl_path = path;
	return 0;
err_path_put:
	path_put(&nd.path);
err:
	rpc_put_mount();
	return error;
L
Linus Torvalds 已提交
145 146
}

147
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
148
{
149
	struct rpc_program	*program = args->program;
L
Linus Torvalds 已提交
150 151
	struct rpc_version	*version;
	struct rpc_clnt		*clnt = NULL;
152
	struct rpc_auth		*auth;
L
Linus Torvalds 已提交
153
	int err;
154 155 156 157
	size_t len;

	/* sanity check the name before trying to print it */
	err = -EINVAL;
158
	len = strlen(args->servername);
159 160 161
	if (len > RPC_MAXNETNAMELEN)
		goto out_no_rpciod;
	len++;
L
Linus Torvalds 已提交
162

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

166 167 168
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
L
Linus Torvalds 已提交
169 170
	err = -EINVAL;
	if (!xprt)
171
		goto out_no_xprt;
172 173 174 175 176

	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
177 178 179
		goto out_err;

	err = -ENOMEM;
180
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
181 182 183 184 185 186 187
	if (!clnt)
		goto out_err;
	clnt->cl_parent = clnt;

	clnt->cl_server = clnt->cl_inline_name;
	if (len > sizeof(clnt->cl_inline_name)) {
		char *buf = kmalloc(len, GFP_KERNEL);
188
		if (buf != NULL)
L
Linus Torvalds 已提交
189 190 191 192
			clnt->cl_server = buf;
		else
			len = sizeof(clnt->cl_inline_name);
	}
193
	strlcpy(clnt->cl_server, args->servername, len);
L
Linus Torvalds 已提交
194 195 196 197 198

	clnt->cl_xprt     = xprt;
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
	clnt->cl_protname = program->name;
199
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
200 201
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
202
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
203 204 205
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
206
	clnt->cl_program  = program;
207
	INIT_LIST_HEAD(&clnt->cl_tasks);
208
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
209

210
	if (!xprt_bound(clnt->cl_xprt))
L
Linus Torvalds 已提交
211 212
		clnt->cl_autobind = 1;

213 214 215 216 217 218 219
	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 已提交
220
	clnt->cl_rtt = &clnt->cl_rtt_default;
221
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
222 223 224 225 226 227
	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 已提交
228

229 230
	kref_init(&clnt->cl_kref);

L
Linus Torvalds 已提交
231 232 233 234
	err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
	if (err < 0)
		goto out_no_path;

235
	auth = rpcauth_create(args->authflavor, clnt);
236
	if (IS_ERR(auth)) {
L
Linus Torvalds 已提交
237
		printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
238
				args->authflavor);
239
		err = PTR_ERR(auth);
L
Linus Torvalds 已提交
240 241 242 243
		goto out_no_auth;
	}

	/* save the nodename */
244
	clnt->cl_nodelen = strlen(init_utsname()->nodename);
L
Linus Torvalds 已提交
245 246
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
247
	memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
248
	rpc_register_client(clnt);
L
Linus Torvalds 已提交
249 250 251
	return clnt;

out_no_auth:
252 253
	if (!IS_ERR(clnt->cl_path.dentry)) {
		rpc_remove_client_dir(clnt->cl_path.dentry);
254 255
		rpc_put_mount();
	}
L
Linus Torvalds 已提交
256
out_no_path:
257 258
	kfree(clnt->cl_principal);
out_no_principal:
259 260
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
L
Linus Torvalds 已提交
261 262 263 264
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
	kfree(clnt);
out_err:
265
	xprt_put(xprt);
266
out_no_xprt:
267 268
	rpciod_down();
out_no_rpciod:
L
Linus Torvalds 已提交
269 270 271
	return ERR_PTR(err);
}

272 273 274 275 276 277 278 279 280 281 282 283 284 285
/*
 * 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;
286
	struct xprt_create xprtargs = {
287
		.ident = args->protocol,
288
		.srcaddr = args->saddress,
289 290
		.dstaddr = args->address,
		.addrlen = args->addrsize,
291
		.bc_xprt = args->bc_xprt,
292
	};
293
	char servername[48];
294

295 296 297 298 299
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
	if (args->servername == NULL) {
300 301 302 303 304
		servername[0] = '\0';
		switch (args->address->sa_family) {
		case AF_INET: {
			struct sockaddr_in *sin =
					(struct sockaddr_in *)args->address;
H
Harvey Harrison 已提交
305 306
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
307 308 309 310 311
			break;
		}
		case AF_INET6: {
			struct sockaddr_in6 *sin =
					(struct sockaddr_in6 *)args->address;
H
Harvey Harrison 已提交
312
			snprintf(servername, sizeof(servername), "%pI6",
313
				 &sin->sin6_addr);
314 315 316 317 318 319 320
			break;
		}
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
321 322 323
		args->servername = servername;
	}

324 325 326 327
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

328 329 330 331 332 333 334 335 336 337
	/*
	 * 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;

338
	clnt = rpc_new_client(args, xprt);
339 340 341 342
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
343
		int err = rpc_ping(clnt);
344 345 346 347 348 349 350 351 352 353 354 355
		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;
356 357
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
358 359
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
360 361 362

	return clnt;
}
363
EXPORT_SYMBOL_GPL(rpc_create);
364

L
Linus Torvalds 已提交
365 366 367 368 369 370 371 372 373
/*
 * 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;
374
	int err = -ENOMEM;
L
Linus Torvalds 已提交
375

376
	new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
L
Linus Torvalds 已提交
377 378
	if (!new)
		goto out_no_clnt;
379 380 381 382 383
	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);
384
	rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
385 386 387
	new->cl_metrics = rpc_alloc_iostats(clnt);
	if (new->cl_metrics == NULL)
		goto out_no_stats;
388 389 390 391 392
	if (clnt->cl_principal) {
		new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
		if (new->cl_principal == NULL)
			goto out_no_principal;
	}
393
	kref_init(&new->cl_kref);
394 395 396
	err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
	if (err != 0)
		goto out_no_path;
L
Linus Torvalds 已提交
397 398
	if (new->cl_auth)
		atomic_inc(&new->cl_auth->au_count);
399 400
	xprt_get(clnt->cl_xprt);
	kref_get(&clnt->cl_kref);
401
	rpc_register_client(new);
402
	rpciod_up();
L
Linus Torvalds 已提交
403
	return new;
404
out_no_path:
405 406
	kfree(new->cl_principal);
out_no_principal:
407
	rpc_free_iostats(new->cl_metrics);
408 409
out_no_stats:
	kfree(new);
L
Linus Torvalds 已提交
410
out_no_clnt:
411
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
412
	return ERR_PTR(err);
L
Linus Torvalds 已提交
413
}
414
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
415 416 417

/*
 * Properly shut down an RPC client, terminating all outstanding
418
 * requests.
L
Linus Torvalds 已提交
419
 */
420
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
421
{
422 423
	dprintk("RPC:       shutting down %s client for %s\n",
			clnt->cl_protname, clnt->cl_server);
L
Linus Torvalds 已提交
424

425
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
426
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
427
		wait_event_timeout(destroy_wait,
428
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
429 430
	}

431
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
432
}
433
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
434 435

/*
436
 * Free an RPC client
L
Linus Torvalds 已提交
437
 */
438 439
static void
rpc_free_client(struct kref *kref)
L
Linus Torvalds 已提交
440
{
441
	struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
L
Linus Torvalds 已提交
442

443
	dprintk("RPC:       destroying %s client for %s\n",
L
Linus Torvalds 已提交
444
			clnt->cl_protname, clnt->cl_server);
445 446
	if (!IS_ERR(clnt->cl_path.dentry)) {
		rpc_remove_client_dir(clnt->cl_path.dentry);
447 448
		rpc_put_mount();
	}
449
	if (clnt->cl_parent != clnt) {
450
		rpc_release_client(clnt->cl_parent);
451 452
		goto out_free;
	}
L
Linus Torvalds 已提交
453 454 455
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
out_free:
456
	rpc_unregister_client(clnt);
457
	rpc_free_iostats(clnt->cl_metrics);
458
	kfree(clnt->cl_principal);
459
	clnt->cl_metrics = NULL;
460
	xprt_put(clnt->cl_xprt);
461
	rpciod_down();
L
Linus Torvalds 已提交
462 463 464
	kfree(clnt);
}

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
/*
 * Free an RPC client
 */
static void
rpc_free_auth(struct kref *kref)
{
	struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);

	if (clnt->cl_auth == NULL) {
		rpc_free_client(kref);
		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.
	 */
	kref_init(kref);
	rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = NULL;
	kref_put(kref, rpc_free_client);
}

L
Linus Torvalds 已提交
489
/*
490
 * Release reference to the RPC client
L
Linus Torvalds 已提交
491 492 493 494
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
495
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
496

497 498
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
499
	kref_put(&clnt->cl_kref, rpc_free_auth);
500 501
}

502 503
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
504 505 506
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
507 508 509 510 511 512 513
 *
 * 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,
				      struct rpc_program *program,
514
				      u32 vers)
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
{
	struct rpc_clnt *clnt;
	struct rpc_version *version;
	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;
531
	err = rpc_ping(clnt);
532 533 534 535
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
536
out:
537 538
	return clnt;
}
539
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
540

L
Linus Torvalds 已提交
541 542 543 544
/*
 * Default callback for async RPC calls
 */
static void
545
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
546 547 548
{
}

549 550 551 552
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
553 554 555 556 557
/**
 * 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)
558 559 560
{
	struct rpc_task *task, *ret;

561
	task = rpc_new_task(task_setup_data);
562
	if (task == NULL) {
563 564
		rpc_release_calldata(task_setup_data->callback_ops,
				task_setup_data->callback_data);
565 566
		ret = ERR_PTR(-ENOMEM);
		goto out;
567 568
	}

569 570 571 572
	if (task->tk_status != 0) {
		ret = ERR_PTR(task->tk_status);
		rpc_put_task(task);
		goto out;
573 574 575 576 577 578 579
	}
	atomic_inc(&task->tk_count);
	rpc_execute(task);
	ret = task;
out:
	return ret;
}
T
Trond Myklebust 已提交
580
EXPORT_SYMBOL_GPL(rpc_run_task);
581 582 583 584 585 586

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
587
 */
588
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
589 590
{
	struct rpc_task	*task;
591 592 593 594 595 596
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
597
	int status;
L
Linus Torvalds 已提交
598 599 600

	BUG_ON(flags & RPC_TASK_ASYNC);

T
Trond Myklebust 已提交
601
	task = rpc_run_task(&task_setup_data);
602 603
	if (IS_ERR(task))
		return PTR_ERR(task);
604
	status = task->tk_status;
605
	rpc_put_task(task);
L
Linus Torvalds 已提交
606 607
	return status;
}
608
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
609

610 611 612 613 614
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
615
 * @tk_ops: RPC call ops
616
 * @data: user call data
L
Linus Torvalds 已提交
617 618
 */
int
619
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
620
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
621 622
{
	struct rpc_task	*task;
623 624 625 626 627 628 629
	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 已提交
630

T
Trond Myklebust 已提交
631
	task = rpc_run_task(&task_setup_data);
632 633 634 635
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
636
}
637
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
638

639 640 641 642
#if defined(CONFIG_NFS_V4_1)
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
643 644
 * @req: RPC request
 * @tk_ops: RPC call ops
645 646
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
647
				const struct rpc_call_ops *tk_ops)
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
{
	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);
	if (!task) {
		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;
}
#endif /* CONFIG_NFS_V4_1 */

684 685 686 687 688 689 690
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

691 692 693 694
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
695
 * @bufsize: length of target buffer
696 697 698 699 700 701 702 703 704 705 706 707
 *
 * 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;
	struct rpc_xprt *xprt = clnt->cl_xprt;

	bytes = sizeof(xprt->addr);
	if (bytes > bufsize)
		bytes = bufsize;
	memcpy(buf, &clnt->cl_xprt->addr, bytes);
708
	return xprt->addrlen;
709
}
710
EXPORT_SYMBOL_GPL(rpc_peeraddr);
711

712 713 714 715 716 717
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
 */
718 719
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
720 721
{
	struct rpc_xprt *xprt = clnt->cl_xprt;
722 723 724 725 726

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
727
}
728
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
729

L
Linus Torvalds 已提交
730 731 732 733
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
	struct rpc_xprt *xprt = clnt->cl_xprt;
734 735
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
L
Linus Torvalds 已提交
736
}
737
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
738 739 740 741 742 743 744 745 746 747 748 749 750

/*
 * Return size of largest payload RPC client can support, in bytes
 *
 * 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)
{
	return clnt->cl_xprt->max_payload;
}
751
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
752

753 754 755 756 757 758 759 760
/**
 * rpc_force_rebind - force transport to check that remote port is unchanged
 * @clnt: client to rebind
 *
 */
void rpc_force_rebind(struct rpc_clnt *clnt)
{
	if (clnt->cl_autobind)
761
		xprt_clear_bound(clnt->cl_xprt);
762
}
763
EXPORT_SYMBOL_GPL(rpc_force_rebind);
764

765 766 767 768 769 770 771 772 773 774 775 776 777
/*
 * Restart an (async) RPC call from the call_prepare state.
 * Usually called from within the exit handler.
 */
void
rpc_restart_call_prepare(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
		return;
	task->tk_action = rpc_prepare_task;
}
EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);

L
Linus Torvalds 已提交
778 779 780 781 782 783 784 785 786 787 788 789
/*
 * Restart an (async) RPC call. Usually called from within the
 * exit handler.
 */
void
rpc_restart_call(struct rpc_task *task)
{
	if (RPC_ASSASSINATED(task))
		return;

	task->tk_action = call_start;
}
790
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
791

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
#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 已提交
807 808 809 810 811 812 813 814 815 816 817
/*
 * 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;

818
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
819
			clnt->cl_protname, clnt->cl_vers,
820
			rpc_proc_name(task),
821
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
822 823 824 825 826 827 828 829 830 831 832 833 834

	/* 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)
{
835
	dprint_status(task);
L
Linus Torvalds 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854

	if (!rpcauth_uptodatecred(task)) {
		task->tk_action = call_refresh;
		return;
	}

	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;

855
	dprint_status(task);
L
Linus Torvalds 已提交
856 857 858 859 860 861 862 863 864 865 866 867 868

	/*
	 * 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) {
			task->tk_action = call_allocate;
			return;
		}

		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
869
				__func__, status);
L
Linus Torvalds 已提交
870 871 872 873 874 875 876 877 878 879
		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",
880
				__func__, status);
L
Linus Torvalds 已提交
881 882 883 884 885 886 887 888 889 890 891
		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",
892
				__func__, status);
L
Linus Torvalds 已提交
893 894 895 896 897 898 899
		break;
	}
	rpc_exit(task, status);
}

/*
 * 2.	Allocate the buffer. For details, see sched.c:rpc_malloc.
900
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
901 902 903 904
 */
static void
call_allocate(struct rpc_task *task)
{
905
	unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
906 907
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = task->tk_xprt;
908
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
909

910 911
	dprint_status(task);

912
	task->tk_status = 0;
L
Linus Torvalds 已提交
913
	task->tk_action = call_bind;
914

915
	if (req->rq_buffer)
L
Linus Torvalds 已提交
916 917
		return;

918 919 920 921 922
	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 已提交
923

924 925 926 927 928 929 930 931 932 933
	/*
	 * 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;

934 935
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
936
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
937
		return;
938 939

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

941
	if (RPC_IS_ASYNC(task) || !signalled()) {
942
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
943 944 945 946 947 948 949
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

950 951 952 953 954 955 956 957 958 959
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;
960
	task->tk_rqstp->rq_bytes_sent = 0;
961 962
}

963 964 965 966 967 968 969
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;
970
	buf->flags = 0;
971 972 973 974
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
975 976 977 978
/*
 * 3.	Encode arguments of an RPC call
 */
static void
979
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
980 981 982
{
	struct rpc_rqst	*req = task->tk_rqstp;
	kxdrproc_t	encode;
983
	__be32		*p;
L
Linus Torvalds 已提交
984

985
	dprint_status(task);
L
Linus Torvalds 已提交
986

987 988 989 990 991 992
	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 已提交
993

994 995 996
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
997 998 999
		rpc_exit(task, -EIO);
		return;
	}
1000 1001

	encode = task->tk_msg.rpc_proc->p_encode;
1002 1003 1004 1005 1006
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
1007 1008 1009 1010 1011 1012 1013 1014
}

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

1017
	dprint_status(task);
L
Linus Torvalds 已提交
1018

1019
	task->tk_action = call_connect;
1020
	if (!xprt_bound(xprt)) {
1021
		task->tk_action = call_bind_status;
1022
		task->tk_timeout = xprt->bind_timeout;
1023
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1024 1025 1026 1027
	}
}

/*
1028 1029 1030 1031 1032
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1033
	int status = -EIO;
1034 1035

	if (task->tk_status >= 0) {
1036
		dprint_status(task);
1037 1038 1039 1040 1041 1042
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

	switch (task->tk_status) {
1043 1044 1045
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1046
		goto retry_timeout;
1047
	case -EACCES:
1048 1049
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1050 1051 1052 1053 1054
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1055
		rpc_delay(task, 3*HZ);
1056
		goto retry_timeout;
1057
	case -ETIMEDOUT:
1058
		dprintk("RPC: %5u rpcbind request timed out\n",
1059
				task->tk_pid);
1060
		goto retry_timeout;
1061
	case -EPFNOSUPPORT:
1062
		/* server doesn't support any rpcbind version we know of */
1063
		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1064 1065 1066
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1067
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1068
				task->tk_pid);
1069 1070 1071
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
	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;
1087
	default:
1088
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1089 1090 1091 1092 1093 1094
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1095 1096
retry_timeout:
	task->tk_action = call_timeout;
1097 1098 1099 1100
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1101 1102 1103 1104
 */
static void
call_connect(struct rpc_task *task)
{
1105
	struct rpc_xprt *xprt = task->tk_xprt;
L
Linus Torvalds 已提交
1106

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

1111 1112 1113 1114 1115 1116
	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 已提交
1117 1118 1119 1120
	}
}

/*
1121
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1122 1123 1124 1125 1126 1127 1128
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1129
	dprint_status(task);
1130

L
Linus Torvalds 已提交
1131
	task->tk_status = 0;
1132
	if (status >= 0 || status == -EAGAIN) {
L
Linus Torvalds 已提交
1133 1134 1135 1136 1137 1138
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}

	switch (status) {
1139 1140 1141
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1142 1143 1144
		break;
	default:
		rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1145 1146 1147 1148 1149 1150 1151 1152 1153
	}
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1154
	dprint_status(task);
L
Linus Torvalds 已提交
1155 1156 1157 1158 1159 1160 1161

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1162
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1163
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1164
	if (rpc_task_need_encode(task)) {
1165
		BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1166
		rpc_xdr_encode(task);
1167
		/* Did the encode result in an error condition? */
1168 1169 1170 1171 1172 1173
		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);
1174
			return;
1175
		}
1176
	}
L
Linus Torvalds 已提交
1177 1178 1179
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1180 1181 1182 1183 1184
	/*
	 * 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);
1185
	if (rpc_reply_expected(task))
1186 1187
		return;
	task->tk_action = rpc_exit_task;
1188
	rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
1189 1190 1191 1192 1193 1194 1195 1196 1197
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208

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

1209 1210 1211 1212
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
1213
		dprint_status(task);
1214
		xprt_end_transmit(task);
1215 1216
		rpc_task_force_reencode(task);
		break;
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
		/*
		 * 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:
1227 1228 1229 1230 1231 1232 1233
		if (RPC_IS_SOFTCONN(task)) {
			xprt_end_transmit(task);
			rpc_exit(task, task->tk_status);
			break;
		}
	case -ECONNRESET:
	case -ENOTCONN:
1234
	case -EPIPE:
1235 1236
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1237 1238
}

1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
#if defined(CONFIG_NFS_V4_1)
/*
 * 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);
}
#endif /* CONFIG_NFS_V4_1 */

L
Linus Torvalds 已提交
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
/*
 * 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;

1315 1316
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1317

1318
	dprint_status(task);
L
Linus Torvalds 已提交
1319 1320 1321 1322 1323 1324 1325 1326 1327

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

	task->tk_status = 0;
	switch(status) {
1328 1329 1330 1331 1332 1333 1334 1335
	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 已提交
1336 1337
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1338
		if (task->tk_client->cl_discrtry)
1339 1340
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1341
		break;
1342
	case -ECONNRESET:
L
Linus Torvalds 已提交
1343
	case -ECONNREFUSED:
1344
		rpc_force_rebind(clnt);
1345 1346 1347
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
		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 已提交
1358 1359
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1360 1361 1362 1363 1364 1365
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
1366
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1367 1368 1369 1370 1371 1372 1373 1374 1375
 * 	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) {
1376
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1377 1378 1379
		goto retry;
	}

1380
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1381 1382
	task->tk_timeouts++;

1383 1384 1385 1386
	if (RPC_IS_SOFTCONN(task)) {
		rpc_exit(task, -ETIMEDOUT);
		return;
	}
L
Linus Torvalds 已提交
1387
	if (RPC_IS_SOFT(task)) {
O
Olga Kornievskaia 已提交
1388 1389
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
L
Linus Torvalds 已提交
1390 1391 1392 1393 1394
				clnt->cl_protname, clnt->cl_server);
		rpc_exit(task, -EIO);
		return;
	}

C
Chuck Lever 已提交
1395
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1396
		task->tk_flags |= RPC_CALL_MAJORSEEN;
O
Olga Kornievskaia 已提交
1397 1398
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
L
Linus Torvalds 已提交
1399 1400
			clnt->cl_protname, clnt->cl_server);
	}
1401
	rpc_force_rebind(clnt);
1402 1403 1404 1405 1406
	/*
	 * 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 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422

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;
	kxdrproc_t	decode = task->tk_msg.rpc_proc->p_decode;
1423
	__be32		*p;
L
Linus Torvalds 已提交
1424

1425 1426
	dprintk("RPC: %5u call_decode (status %d)\n",
			task->tk_pid, task->tk_status);
L
Linus Torvalds 已提交
1427

C
Chuck Lever 已提交
1428
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
O
Olga Kornievskaia 已提交
1429 1430 1431
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s OK\n",
				clnt->cl_protname, clnt->cl_server);
L
Linus Torvalds 已提交
1432 1433 1434
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

1435 1436
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
1437
	 * before it changed req->rq_reply_bytes_recvd.
1438 1439
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1440 1441 1442 1443 1444 1445
	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);

1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
	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;
	}

1458
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
1459 1460 1461 1462
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
1463 1464
	}

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

1467
	if (decode) {
L
Linus Torvalds 已提交
1468 1469
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
1470
	}
1471 1472
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
1473 1474 1475
	return;
out_retry:
	task->tk_status = 0;
1476
	/* Note: rpc_verify_header() may have freed the RPC slot */
1477
	if (task->tk_rqstp == req) {
1478
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1479
		if (task->tk_client->cl_discrtry)
1480 1481
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
1482
	}
L
Linus Torvalds 已提交
1483 1484 1485 1486 1487 1488 1489 1490
}

/*
 * 8.	Refresh the credentials if rejected by the server
 */
static void
call_refresh(struct rpc_task *task)
{
1491
	dprint_status(task);
L
Linus Torvalds 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505

	task->tk_action = call_refreshresult;
	task->tk_status = 0;
	task->tk_client->cl_stats->rpcauthrefresh++;
	rpcauth_refreshcred(task);
}

/*
 * 8a.	Process the results of a credential refresh
 */
static void
call_refreshresult(struct rpc_task *task)
{
	int status = task->tk_status;
1506 1507

	dprint_status(task);
L
Linus Torvalds 已提交
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522

	task->tk_status = 0;
	task->tk_action = call_reserve;
	if (status >= 0 && rpcauth_uptodatecred(task))
		return;
	if (status == -EACCES) {
		rpc_exit(task, -EACCES);
		return;
	}
	task->tk_action = call_refresh;
	if (status != -ETIMEDOUT)
		rpc_delay(task, 3*HZ);
	return;
}

1523
static __be32 *
1524
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1525 1526 1527
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
1528
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
1529 1530

	/* FIXME: check buffer size? */
1531 1532

	p = xprt_skip_transport_header(task->tk_xprt, p);
L
Linus Torvalds 已提交
1533 1534 1535 1536 1537 1538
	*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 */
1539 1540 1541
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
1542 1543
}

1544
static __be32 *
1545
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1546 1547 1548
{
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1549 1550
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
1551 1552
	int error = -EACCES;

1553 1554 1555 1556 1557 1558
	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
		 */
1559
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
1560
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
1561
		       task->tk_rqstp->rq_rcv_buf.len);
1562 1563
		goto out_eio;
	}
L
Linus Torvalds 已提交
1564 1565 1566
	if ((len -= 3) < 0)
		goto out_overflow;

1567
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
1568
	if ((n = ntohl(*p++)) != RPC_REPLY) {
1569
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1570
			task->tk_pid, __func__, n);
T
Trond Myklebust 已提交
1571
		goto out_garbage;
L
Linus Torvalds 已提交
1572
	}
1573

L
Linus Torvalds 已提交
1574 1575 1576 1577 1578 1579 1580
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		if (--len < 0)
			goto out_overflow;
		switch ((n = ntohl(*p++))) {
			case RPC_AUTH_ERROR:
				break;
			case RPC_MISMATCH:
1581 1582
				dprintk("RPC: %5u %s: RPC call version "
						"mismatch!\n",
1583
						task->tk_pid, __func__);
1584 1585
				error = -EPROTONOSUPPORT;
				goto out_err;
L
Linus Torvalds 已提交
1586
			default:
1587 1588
				dprintk("RPC: %5u %s: RPC call rejected, "
						"unknown error: %x\n",
1589
						task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
				goto out_eio;
		}
		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--;
1602
			dprintk("RPC: %5u %s: retry stale creds\n",
1603
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
1604
			rpcauth_invalcred(task);
1605 1606
			/* Ensure we obtain a new XID! */
			xprt_release(task);
L
Linus Torvalds 已提交
1607
			task->tk_action = call_refresh;
T
Trond Myklebust 已提交
1608
			goto out_retry;
L
Linus Torvalds 已提交
1609 1610 1611 1612 1613 1614
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
1615
			dprintk("RPC: %5u %s: retry garbled creds\n",
1616
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
1617
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
1618
			goto out_retry;
L
Linus Torvalds 已提交
1619
		case RPC_AUTH_TOOWEAK:
1620
			printk(KERN_NOTICE "RPC: server %s requires stronger "
1621
			       "authentication.\n", task->tk_client->cl_server);
L
Linus Torvalds 已提交
1622 1623
			break;
		default:
1624
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
1625
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1626 1627
			error = -EIO;
		}
1628
		dprintk("RPC: %5u %s: call rejected %d\n",
1629
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1630 1631 1632
		goto out_err;
	}
	if (!(p = rpcauth_checkverf(task, p))) {
1633
		dprintk("RPC: %5u %s: auth check failed\n",
1634
				task->tk_pid, __func__);
T
Trond Myklebust 已提交
1635
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
1636
	}
1637
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
1638 1639 1640 1641 1642 1643
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
1644
		dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1645
				task->tk_pid, __func__,
L
Linus Torvalds 已提交
1646 1647
				(unsigned int)task->tk_client->cl_prog,
				task->tk_client->cl_server);
1648 1649
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1650
	case RPC_PROG_MISMATCH:
1651
		dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1652
				"server %s\n", task->tk_pid, __func__,
L
Linus Torvalds 已提交
1653 1654 1655
				(unsigned int)task->tk_client->cl_prog,
				(unsigned int)task->tk_client->cl_vers,
				task->tk_client->cl_server);
1656 1657
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1658
	case RPC_PROC_UNAVAIL:
1659
		dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
1660
				"version %u on server %s\n",
1661
				task->tk_pid, __func__,
1662
				rpc_proc_name(task),
L
Linus Torvalds 已提交
1663 1664 1665
				task->tk_client->cl_prog,
				task->tk_client->cl_vers,
				task->tk_client->cl_server);
1666 1667
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
1668
	case RPC_GARBAGE_ARGS:
1669
		dprintk("RPC: %5u %s: server saw garbage\n",
1670
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
1671 1672
		break;			/* retry */
	default:
1673
		dprintk("RPC: %5u %s: server accept status: %x\n",
1674
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1675 1676 1677
		/* Also retry */
	}

T
Trond Myklebust 已提交
1678
out_garbage:
L
Linus Torvalds 已提交
1679 1680 1681
	task->tk_client->cl_stats->rpcgarbage++;
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
1682
		dprintk("RPC: %5u %s: retrying\n",
1683
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
1684
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
1685 1686
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
1687 1688 1689 1690 1691
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
1692
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1693
			__func__, error);
T
Trond Myklebust 已提交
1694
	return ERR_PTR(error);
L
Linus Torvalds 已提交
1695
out_overflow:
1696
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1697
			__func__);
T
Trond Myklebust 已提交
1698
	goto out_garbage;
L
Linus Torvalds 已提交
1699
}
1700

1701
static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1702 1703 1704 1705
{
	return 0;
}

1706
static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1707 1708 1709 1710 1711 1712 1713 1714 1715
{
	return 0;
}

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

1716
static int rpc_ping(struct rpc_clnt *clnt)
1717 1718 1719 1720 1721 1722
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1723
	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
1724 1725 1726
	put_rpccred(msg.rpc_cred);
	return err;
}
1727

1728 1729 1730 1731 1732 1733
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,
	};
1734 1735 1736 1737 1738 1739
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
1740
	return rpc_run_task(&task_setup_data);
1741
}
1742
EXPORT_SYMBOL_GPL(rpc_call_null);
1743

1744
#ifdef RPC_DEBUG
1745 1746
static void rpc_show_header(void)
{
1747 1748
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
1749 1750
}

C
Chuck Lever 已提交
1751 1752 1753 1754
static void rpc_show_task(const struct rpc_clnt *clnt,
			  const struct rpc_task *task)
{
	const char *rpc_waitq = "none";
1755
	char *p, action[KSYM_SYMBOL_LEN];
C
Chuck Lever 已提交
1756 1757 1758 1759

	if (RPC_IS_QUEUED(task))
		rpc_waitq = rpc_qname(task->tk_waitqueue);

1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771
	/* map tk_action pointer to a function name; then trim off
	 * the "+0x0 [sunrpc]" */
	sprint_symbol(action, (unsigned long)task->tk_action);
	p = strchr(action, '+');
	if (p)
		*p = '\0';

	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
		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),
		action, rpc_waitq);
C
Chuck Lever 已提交
1772 1773
}

1774 1775 1776
void rpc_show_tasks(void)
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
1777
	struct rpc_task *task;
1778
	int header = 0;
1779 1780 1781 1782

	spin_lock(&rpc_client_lock);
	list_for_each_entry(clnt, &all_clients, cl_clients) {
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
1783
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
1784 1785 1786 1787
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
1788
			rpc_show_task(clnt, task);
1789 1790 1791 1792 1793 1794
		}
		spin_unlock(&clnt->cl_lock);
	}
	spin_unlock(&rpc_client_lock);
}
#endif