clnt.c 41.4 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 30 31
#include <linux/mm.h>
#include <linux/slab.h>
#include <linux/utsname.h>
32
#include <linux/workqueue.h>
33
#include <linux/in6.h>
L
Linus Torvalds 已提交
34 35 36

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

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

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

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

50 51 52 53 54 55
/*
 * All RPC clients are linked into this list
 */
static LIST_HEAD(all_clients);
static DEFINE_SPINLOCK(rpc_client_lock);

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


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

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

82 83 84 85 86 87 88 89 90 91 92 93 94
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 已提交
95 96 97 98

static int
rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
{
99
	static uint32_t clntid;
L
Linus Torvalds 已提交
100 101
	int error;

102 103
	clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
	clnt->cl_dentry = ERR_PTR(-ENOENT);
L
Linus Torvalds 已提交
104 105
	if (dir_name == NULL)
		return 0;
106 107 108 109 110

	clnt->cl_vfsmnt = rpc_get_mount();
	if (IS_ERR(clnt->cl_vfsmnt))
		return PTR_ERR(clnt->cl_vfsmnt);

111 112 113 114 115
	for (;;) {
		snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
				"%s/clnt%x", dir_name,
				(unsigned int)clntid++);
		clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
116
		clnt->cl_dentry = rpc_create_client_dir(clnt->cl_pathname, clnt);
117 118
		if (!IS_ERR(clnt->cl_dentry))
			return 0;
L
Linus Torvalds 已提交
119
		error = PTR_ERR(clnt->cl_dentry);
120 121 122
		if (error != -EEXIST) {
			printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
					clnt->cl_pathname, error);
123
			rpc_put_mount();
124 125
			return error;
		}
L
Linus Torvalds 已提交
126 127 128
	}
}

129
static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
130
{
131
	struct rpc_program	*program = args->program;
L
Linus Torvalds 已提交
132 133
	struct rpc_version	*version;
	struct rpc_clnt		*clnt = NULL;
134
	struct rpc_auth		*auth;
L
Linus Torvalds 已提交
135
	int err;
136 137 138 139
	size_t len;

	/* sanity check the name before trying to print it */
	err = -EINVAL;
140
	len = strlen(args->servername);
141 142 143
	if (len > RPC_MAXNETNAMELEN)
		goto out_no_rpciod;
	len++;
L
Linus Torvalds 已提交
144

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

148 149 150
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
L
Linus Torvalds 已提交
151 152
	err = -EINVAL;
	if (!xprt)
153
		goto out_no_xprt;
154 155 156 157 158

	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
159 160 161
		goto out_err;

	err = -ENOMEM;
162
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
163 164 165 166 167 168 169
	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);
170
		if (buf != NULL)
L
Linus Torvalds 已提交
171 172 173 174
			clnt->cl_server = buf;
		else
			len = sizeof(clnt->cl_inline_name);
	}
175
	strlcpy(clnt->cl_server, args->servername, len);
L
Linus Torvalds 已提交
176 177 178 179 180

	clnt->cl_xprt     = xprt;
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
	clnt->cl_protname = program->name;
181
	clnt->cl_prog     = args->prognumber ? : program->number;
L
Linus Torvalds 已提交
182 183
	clnt->cl_vers     = version->number;
	clnt->cl_stats    = program->stats;
184
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
185 186 187
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
188
	clnt->cl_program  = program;
189
	INIT_LIST_HEAD(&clnt->cl_tasks);
190
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
191

192
	if (!xprt_bound(clnt->cl_xprt))
L
Linus Torvalds 已提交
193 194
		clnt->cl_autobind = 1;

195 196 197 198 199 200 201
	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 已提交
202
	clnt->cl_rtt = &clnt->cl_rtt_default;
203
	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
204 205 206 207 208 209
	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 已提交
210

211 212
	kref_init(&clnt->cl_kref);

L
Linus Torvalds 已提交
213 214 215 216
	err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
	if (err < 0)
		goto out_no_path;

217
	auth = rpcauth_create(args->authflavor, clnt);
218
	if (IS_ERR(auth)) {
L
Linus Torvalds 已提交
219
		printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
220
				args->authflavor);
221
		err = PTR_ERR(auth);
L
Linus Torvalds 已提交
222 223 224 225
		goto out_no_auth;
	}

	/* save the nodename */
226
	clnt->cl_nodelen = strlen(init_utsname()->nodename);
L
Linus Torvalds 已提交
227 228
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
229
	memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
230
	rpc_register_client(clnt);
L
Linus Torvalds 已提交
231 232 233
	return clnt;

out_no_auth:
234
	if (!IS_ERR(clnt->cl_dentry)) {
235
		rpc_remove_client_dir(clnt->cl_dentry);
236 237
		rpc_put_mount();
	}
L
Linus Torvalds 已提交
238
out_no_path:
239 240
	kfree(clnt->cl_principal);
out_no_principal:
241 242
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
L
Linus Torvalds 已提交
243 244 245 246
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
	kfree(clnt);
out_err:
247
	xprt_put(xprt);
248
out_no_xprt:
249 250
	rpciod_down();
out_no_rpciod:
L
Linus Torvalds 已提交
251 252 253
	return ERR_PTR(err);
}

254 255 256 257 258 259 260 261 262 263 264 265 266 267
/*
 * 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;
268
	struct xprt_create xprtargs = {
269
		.ident = args->protocol,
270
		.srcaddr = args->saddress,
271 272 273
		.dstaddr = args->address,
		.addrlen = args->addrsize,
	};
274
	char servername[48];
275

276 277 278 279 280
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
	if (args->servername == NULL) {
281 282 283 284 285
		servername[0] = '\0';
		switch (args->address->sa_family) {
		case AF_INET: {
			struct sockaddr_in *sin =
					(struct sockaddr_in *)args->address;
H
Harvey Harrison 已提交
286 287
			snprintf(servername, sizeof(servername), "%pI4",
				 &sin->sin_addr.s_addr);
288 289 290 291 292
			break;
		}
		case AF_INET6: {
			struct sockaddr_in6 *sin =
					(struct sockaddr_in6 *)args->address;
H
Harvey Harrison 已提交
293
			snprintf(servername, sizeof(servername), "%pI6",
294
				 &sin->sin6_addr);
295 296 297 298 299 300 301
			break;
		}
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
302 303 304
		args->servername = servername;
	}

305 306 307 308
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

309 310 311 312 313 314 315 316 317 318
	/*
	 * 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;

319
	clnt = rpc_new_client(args, xprt);
320 321 322 323
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
324
		int err = rpc_ping(clnt, RPC_TASK_SOFT);
325 326 327 328 329 330 331 332 333 334 335 336
		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;
337 338
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
O
Olga Kornievskaia 已提交
339 340
	if (!(args->flags & RPC_CLNT_CREATE_QUIET))
		clnt->cl_chatty = 1;
341 342 343

	return clnt;
}
344
EXPORT_SYMBOL_GPL(rpc_create);
345

L
Linus Torvalds 已提交
346 347 348 349 350 351 352 353 354
/*
 * 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;
355
	int err = -ENOMEM;
L
Linus Torvalds 已提交
356

357
	new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
L
Linus Torvalds 已提交
358 359
	if (!new)
		goto out_no_clnt;
360 361 362 363 364
	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);
365
	rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
366 367 368
	new->cl_metrics = rpc_alloc_iostats(clnt);
	if (new->cl_metrics == NULL)
		goto out_no_stats;
369 370 371 372 373
	if (clnt->cl_principal) {
		new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
		if (new->cl_principal == NULL)
			goto out_no_principal;
	}
374
	kref_init(&new->cl_kref);
375 376 377
	err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
	if (err != 0)
		goto out_no_path;
L
Linus Torvalds 已提交
378 379
	if (new->cl_auth)
		atomic_inc(&new->cl_auth->au_count);
380 381
	xprt_get(clnt->cl_xprt);
	kref_get(&clnt->cl_kref);
382
	rpc_register_client(new);
383
	rpciod_up();
L
Linus Torvalds 已提交
384
	return new;
385
out_no_path:
386 387
	kfree(new->cl_principal);
out_no_principal:
388
	rpc_free_iostats(new->cl_metrics);
389 390
out_no_stats:
	kfree(new);
L
Linus Torvalds 已提交
391
out_no_clnt:
392
	dprintk("RPC:       %s: returned error %d\n", __func__, err);
393
	return ERR_PTR(err);
L
Linus Torvalds 已提交
394
}
395
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
396 397 398

/*
 * Properly shut down an RPC client, terminating all outstanding
399
 * requests.
L
Linus Torvalds 已提交
400
 */
401
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
402
{
403 404
	dprintk("RPC:       shutting down %s client for %s\n",
			clnt->cl_protname, clnt->cl_server);
L
Linus Torvalds 已提交
405

406
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
407
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
408
		wait_event_timeout(destroy_wait,
409
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
410 411
	}

412
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
413
}
414
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
415 416

/*
417
 * Free an RPC client
L
Linus Torvalds 已提交
418
 */
419 420
static void
rpc_free_client(struct kref *kref)
L
Linus Torvalds 已提交
421
{
422
	struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
L
Linus Torvalds 已提交
423

424
	dprintk("RPC:       destroying %s client for %s\n",
L
Linus Torvalds 已提交
425
			clnt->cl_protname, clnt->cl_server);
426
	if (!IS_ERR(clnt->cl_dentry)) {
427
		rpc_remove_client_dir(clnt->cl_dentry);
428 429
		rpc_put_mount();
	}
430
	if (clnt->cl_parent != clnt) {
431
		rpc_release_client(clnt->cl_parent);
432 433
		goto out_free;
	}
L
Linus Torvalds 已提交
434 435 436
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
out_free:
437
	rpc_unregister_client(clnt);
438
	rpc_free_iostats(clnt->cl_metrics);
439
	kfree(clnt->cl_principal);
440
	clnt->cl_metrics = NULL;
441
	xprt_put(clnt->cl_xprt);
442
	rpciod_down();
L
Linus Torvalds 已提交
443 444 445
	kfree(clnt);
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
/*
 * 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 已提交
470
/*
471
 * Release reference to the RPC client
L
Linus Torvalds 已提交
472 473 474 475
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
476
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
477

478 479
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
480
	kref_put(&clnt->cl_kref, rpc_free_auth);
481 482
}

483 484
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
485 486 487
 * @old: old rpc_client
 * @program: rpc program to set
 * @vers: rpc program version
488 489 490 491 492 493 494
 *
 * 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,
495
				      u32 vers)
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
{
	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;
512
	err = rpc_ping(clnt, RPC_TASK_SOFT);
513 514 515 516
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
517
out:
518 519
	return clnt;
}
520
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
521

L
Linus Torvalds 已提交
522 523 524 525
/*
 * Default callback for async RPC calls
 */
static void
526
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
527 528 529
{
}

530 531 532 533
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

T
Trond Myklebust 已提交
534 535 536 537 538
/**
 * 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)
539 540 541
{
	struct rpc_task *task, *ret;

542
	task = rpc_new_task(task_setup_data);
543
	if (task == NULL) {
544 545
		rpc_release_calldata(task_setup_data->callback_ops,
				task_setup_data->callback_data);
546 547
		ret = ERR_PTR(-ENOMEM);
		goto out;
548 549
	}

550 551 552 553
	if (task->tk_status != 0) {
		ret = ERR_PTR(task->tk_status);
		rpc_put_task(task);
		goto out;
554 555 556 557 558 559 560
	}
	atomic_inc(&task->tk_count);
	rpc_execute(task);
	ret = task;
out:
	return ret;
}
T
Trond Myklebust 已提交
561
EXPORT_SYMBOL_GPL(rpc_run_task);
562 563 564 565 566 567

/**
 * rpc_call_sync - Perform a synchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
L
Linus Torvalds 已提交
568
 */
569
int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
L
Linus Torvalds 已提交
570 571
{
	struct rpc_task	*task;
572 573 574 575 576 577
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
578
	int status;
L
Linus Torvalds 已提交
579 580 581

	BUG_ON(flags & RPC_TASK_ASYNC);

T
Trond Myklebust 已提交
582
	task = rpc_run_task(&task_setup_data);
583 584
	if (IS_ERR(task))
		return PTR_ERR(task);
585
	status = task->tk_status;
586
	rpc_put_task(task);
L
Linus Torvalds 已提交
587 588
	return status;
}
589
EXPORT_SYMBOL_GPL(rpc_call_sync);
L
Linus Torvalds 已提交
590

591 592 593 594 595
/**
 * rpc_call_async - Perform an asynchronous RPC call
 * @clnt: pointer to RPC client
 * @msg: RPC call parameters
 * @flags: RPC call flags
596
 * @tk_ops: RPC call ops
597
 * @data: user call data
L
Linus Torvalds 已提交
598 599
 */
int
600
rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
601
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
602 603
{
	struct rpc_task	*task;
604 605 606 607 608 609 610
	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 已提交
611

T
Trond Myklebust 已提交
612
	task = rpc_run_task(&task_setup_data);
613 614 615 616
	if (IS_ERR(task))
		return PTR_ERR(task);
	rpc_put_task(task);
	return 0;
L
Linus Torvalds 已提交
617
}
618
EXPORT_SYMBOL_GPL(rpc_call_async);
L
Linus Torvalds 已提交
619

620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
#if defined(CONFIG_NFS_V4_1)
/**
 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 * rpc_execute against it
 * @ops: RPC call ops
 */
struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
					const struct rpc_call_ops *tk_ops)
{
	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 */

664 665 666 667 668 669 670
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

671 672 673 674
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
675
 * @bufsize: length of target buffer
676 677 678 679 680 681 682 683 684 685 686 687
 *
 * 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);
688
	return xprt->addrlen;
689
}
690
EXPORT_SYMBOL_GPL(rpc_peeraddr);
691

692 693 694 695 696 697
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
 */
698 699
const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
			     enum rpc_display_format_t format)
700 701
{
	struct rpc_xprt *xprt = clnt->cl_xprt;
702 703 704 705 706

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
707
}
708
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
709

L
Linus Torvalds 已提交
710 711 712 713
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
	struct rpc_xprt *xprt = clnt->cl_xprt;
714 715
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
L
Linus Torvalds 已提交
716
}
717
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
718 719 720 721 722 723 724 725 726 727 728 729 730

/*
 * 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;
}
731
EXPORT_SYMBOL_GPL(rpc_max_payload);
L
Linus Torvalds 已提交
732

733 734 735 736 737 738 739 740
/**
 * 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)
741
		xprt_clear_bound(clnt->cl_xprt);
742
}
743
EXPORT_SYMBOL_GPL(rpc_force_rebind);
744

745 746 747 748 749 750 751 752 753 754 755 756 757
/*
 * 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 已提交
758 759 760 761 762 763 764 765 766 767 768 769
/*
 * 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;
}
770
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
771

772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
#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 已提交
787 788 789 790 791 792 793 794 795 796 797
/*
 * 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;

798
	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
799
			clnt->cl_protname, clnt->cl_vers,
800
			rpc_proc_name(task),
801
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
802 803 804 805 806 807 808 809 810 811 812 813 814

	/* 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)
{
815
	dprint_status(task);
L
Linus Torvalds 已提交
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834

	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;

835
	dprint_status(task);
L
Linus Torvalds 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848

	/*
	 * 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",
849
				__func__, status);
L
Linus Torvalds 已提交
850 851 852 853 854 855 856 857 858 859
		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",
860
				__func__, status);
L
Linus Torvalds 已提交
861 862 863 864 865 866 867 868 869 870 871
		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",
872
				__func__, status);
L
Linus Torvalds 已提交
873 874 875 876 877 878 879
		break;
	}
	rpc_exit(task, status);
}

/*
 * 2.	Allocate the buffer. For details, see sched.c:rpc_malloc.
880
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
881 882 883 884
 */
static void
call_allocate(struct rpc_task *task)
{
885
	unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
886 887
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = task->tk_xprt;
888
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
889

890 891
	dprint_status(task);

892
	task->tk_status = 0;
L
Linus Torvalds 已提交
893
	task->tk_action = call_bind;
894

895
	if (req->rq_buffer)
L
Linus Torvalds 已提交
896 897
		return;

898 899 900 901 902
	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 已提交
903

904 905 906 907 908 909 910 911 912 913
	/*
	 * 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;

914 915
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
916
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
917
		return;
918 919

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

921
	if (RPC_IS_ASYNC(task) || !signalled()) {
922
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
923 924 925 926 927 928 929
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

930 931 932 933 934 935 936 937 938 939 940 941
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;
}

942 943 944 945 946 947 948
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;
949
	buf->flags = 0;
950 951 952 953
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
954 955 956 957
/*
 * 3.	Encode arguments of an RPC call
 */
static void
958
rpc_xdr_encode(struct rpc_task *task)
L
Linus Torvalds 已提交
959 960 961
{
	struct rpc_rqst	*req = task->tk_rqstp;
	kxdrproc_t	encode;
962
	__be32		*p;
L
Linus Torvalds 已提交
963

964
	dprint_status(task);
L
Linus Torvalds 已提交
965

966 967 968 969 970 971
	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 已提交
972

973 974 975
	p = rpc_encode_header(task);
	if (p == NULL) {
		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
L
Linus Torvalds 已提交
976 977 978
		rpc_exit(task, -EIO);
		return;
	}
979 980

	encode = task->tk_msg.rpc_proc->p_encode;
981 982 983 984 985
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
L
Linus Torvalds 已提交
986 987 988 989 990 991 992 993
}

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

996
	dprint_status(task);
L
Linus Torvalds 已提交
997

998
	task->tk_action = call_connect;
999
	if (!xprt_bound(xprt)) {
1000
		task->tk_action = call_bind_status;
1001
		task->tk_timeout = xprt->bind_timeout;
1002
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
1003 1004 1005 1006
	}
}

/*
1007 1008 1009 1010 1011
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
1012
	int status = -EIO;
1013 1014

	if (task->tk_status >= 0) {
1015
		dprint_status(task);
1016 1017 1018 1019 1020 1021
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

	switch (task->tk_status) {
1022 1023 1024
	case -ENOMEM:
		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
		rpc_delay(task, HZ >> 2);
1025
		goto retry_timeout;
1026
	case -EACCES:
1027 1028
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
1029 1030 1031 1032 1033
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
1034
		rpc_delay(task, 3*HZ);
1035
		goto retry_timeout;
1036
	case -ETIMEDOUT:
1037
		dprintk("RPC: %5u rpcbind request timed out\n",
1038
				task->tk_pid);
1039
		goto retry_timeout;
1040
	case -EPFNOSUPPORT:
1041
		/* server doesn't support any rpcbind version we know of */
1042
		dprintk("RPC: %5u remote rpcbind service unavailable\n",
1043 1044 1045
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1046
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1047
				task->tk_pid);
1048 1049 1050
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1051
	default:
1052
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1053 1054 1055 1056 1057 1058
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1059 1060
retry_timeout:
	task->tk_action = call_timeout;
1061 1062 1063 1064
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1065 1066 1067 1068
 */
static void
call_connect(struct rpc_task *task)
{
1069
	struct rpc_xprt *xprt = task->tk_xprt;
L
Linus Torvalds 已提交
1070

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

1075 1076 1077 1078 1079 1080
	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 已提交
1081 1082 1083 1084
	}
}

/*
1085
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1086 1087 1088 1089 1090 1091 1092
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1093
	dprint_status(task);
1094

L
Linus Torvalds 已提交
1095
	task->tk_status = 0;
1096
	if (status >= 0 || status == -EAGAIN) {
L
Linus Torvalds 已提交
1097 1098 1099 1100 1101 1102
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}

	switch (status) {
1103 1104 1105
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1106 1107 1108
		break;
	default:
		rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1109 1110 1111 1112 1113 1114 1115 1116 1117
	}
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1118
	dprint_status(task);
L
Linus Torvalds 已提交
1119 1120 1121 1122 1123 1124 1125

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1126
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1127
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1128
	if (rpc_task_need_encode(task)) {
1129
		BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1130
		rpc_xdr_encode(task);
1131
		/* Did the encode result in an error condition? */
1132 1133 1134 1135 1136 1137
		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);
1138
			return;
1139
		}
1140
	}
L
Linus Torvalds 已提交
1141 1142 1143
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1144 1145 1146 1147 1148
	/*
	 * 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);
1149
	if (rpc_reply_expected(task))
1150 1151
		return;
	task->tk_action = rpc_exit_task;
1152
	rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
1153 1154 1155 1156 1157 1158 1159 1160 1161
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
	switch (task->tk_status) {
	case -EAGAIN:
		break;
	default:
		xprt_end_transmit(task);
		/*
		 * 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:
1174
	case -ECONNRESET:
1175 1176 1177 1178
	case -ENOTCONN:
	case -EHOSTDOWN:
	case -EHOSTUNREACH:
	case -ENETUNREACH:
1179
	case -EPIPE:
1180 1181
		rpc_task_force_reencode(task);
	}
L
Linus Torvalds 已提交
1182 1183
}

1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
#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 已提交
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
/*
 * 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;

1260 1261
	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_reply_bytes_recvd;
L
Linus Torvalds 已提交
1262

1263
	dprint_status(task);
L
Linus Torvalds 已提交
1264 1265 1266 1267 1268 1269 1270 1271 1272

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

	task->tk_status = 0;
	switch(status) {
1273 1274 1275 1276 1277 1278 1279 1280
	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 已提交
1281 1282
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1283
		if (task->tk_client->cl_discrtry)
1284 1285
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
L
Linus Torvalds 已提交
1286
		break;
1287
	case -ECONNRESET:
L
Linus Torvalds 已提交
1288
	case -ECONNREFUSED:
1289
		rpc_force_rebind(clnt);
1290 1291 1292
		rpc_delay(task, 3*HZ);
	case -EPIPE:
	case -ENOTCONN:
L
Linus Torvalds 已提交
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
		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 已提交
1303 1304
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1305 1306 1307 1308 1309 1310
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
1311
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320
 * 	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) {
1321
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1322 1323 1324
		goto retry;
	}

1325
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1326 1327
	task->tk_timeouts++;

L
Linus Torvalds 已提交
1328
	if (RPC_IS_SOFT(task)) {
O
Olga Kornievskaia 已提交
1329 1330
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
L
Linus Torvalds 已提交
1331 1332 1333 1334 1335
				clnt->cl_protname, clnt->cl_server);
		rpc_exit(task, -EIO);
		return;
	}

C
Chuck Lever 已提交
1336
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1337
		task->tk_flags |= RPC_CALL_MAJORSEEN;
O
Olga Kornievskaia 已提交
1338 1339
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
L
Linus Torvalds 已提交
1340 1341
			clnt->cl_protname, clnt->cl_server);
	}
1342
	rpc_force_rebind(clnt);
1343 1344 1345 1346 1347
	/*
	 * 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 已提交
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363

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;
1364
	__be32		*p;
L
Linus Torvalds 已提交
1365

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

C
Chuck Lever 已提交
1369
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
O
Olga Kornievskaia 已提交
1370 1371 1372
		if (clnt->cl_chatty)
			printk(KERN_NOTICE "%s: server %s OK\n",
				clnt->cl_protname, clnt->cl_server);
L
Linus Torvalds 已提交
1373 1374 1375
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

1376 1377
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
1378
	 * before it changed req->rq_reply_bytes_recvd.
1379 1380
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1381 1382 1383 1384 1385 1386
	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);

1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
	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;
	}

1399
	p = rpc_verify_header(task);
T
Trond Myklebust 已提交
1400 1401 1402 1403
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
1404 1405
	}

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

1408
	if (decode) {
L
Linus Torvalds 已提交
1409 1410
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
1411
	}
1412 1413
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
1414 1415 1416
	return;
out_retry:
	task->tk_status = 0;
1417
	/* Note: rpc_verify_header() may have freed the RPC slot */
1418
	if (task->tk_rqstp == req) {
1419
		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1420
		if (task->tk_client->cl_discrtry)
1421 1422
			xprt_conditional_disconnect(task->tk_xprt,
					req->rq_connect_cookie);
1423
	}
L
Linus Torvalds 已提交
1424 1425 1426 1427 1428 1429 1430 1431
}

/*
 * 8.	Refresh the credentials if rejected by the server
 */
static void
call_refresh(struct rpc_task *task)
{
1432
	dprint_status(task);
L
Linus Torvalds 已提交
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446

	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;
1447 1448

	dprint_status(task);
L
Linus Torvalds 已提交
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463

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

1464
static __be32 *
1465
rpc_encode_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1466 1467 1468
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
1469
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
1470 1471

	/* FIXME: check buffer size? */
1472 1473

	p = xprt_skip_transport_header(task->tk_xprt, p);
L
Linus Torvalds 已提交
1474 1475 1476 1477 1478 1479
	*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 */
1480 1481 1482
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
1483 1484
}

1485
static __be32 *
1486
rpc_verify_header(struct rpc_task *task)
L
Linus Torvalds 已提交
1487 1488 1489
{
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1490 1491
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
1492 1493
	int error = -EACCES;

1494 1495 1496 1497 1498 1499
	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
		 */
1500
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
1501
		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
1502
		       task->tk_rqstp->rq_rcv_buf.len);
1503 1504
		goto out_eio;
	}
L
Linus Torvalds 已提交
1505 1506 1507
	if ((len -= 3) < 0)
		goto out_overflow;

1508
	p += 1; /* skip XID */
L
Linus Torvalds 已提交
1509
	if ((n = ntohl(*p++)) != RPC_REPLY) {
1510
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1511
			task->tk_pid, __func__, n);
T
Trond Myklebust 已提交
1512
		goto out_garbage;
L
Linus Torvalds 已提交
1513
	}
1514

L
Linus Torvalds 已提交
1515 1516 1517 1518 1519 1520 1521
	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:
1522 1523
				dprintk("RPC: %5u %s: RPC call version "
						"mismatch!\n",
1524
						task->tk_pid, __func__);
1525 1526
				error = -EPROTONOSUPPORT;
				goto out_err;
L
Linus Torvalds 已提交
1527
			default:
1528 1529
				dprintk("RPC: %5u %s: RPC call rejected, "
						"unknown error: %x\n",
1530
						task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
				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--;
1543
			dprintk("RPC: %5u %s: retry stale creds\n",
1544
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
1545
			rpcauth_invalcred(task);
1546 1547
			/* Ensure we obtain a new XID! */
			xprt_release(task);
L
Linus Torvalds 已提交
1548
			task->tk_action = call_refresh;
T
Trond Myklebust 已提交
1549
			goto out_retry;
L
Linus Torvalds 已提交
1550 1551 1552 1553 1554 1555
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
1556
			dprintk("RPC: %5u %s: retry garbled creds\n",
1557
					task->tk_pid, __func__);
L
Linus Torvalds 已提交
1558
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
1559
			goto out_retry;
L
Linus Torvalds 已提交
1560
		case RPC_AUTH_TOOWEAK:
1561
			printk(KERN_NOTICE "RPC: server %s requires stronger "
1562
			       "authentication.\n", task->tk_client->cl_server);
L
Linus Torvalds 已提交
1563 1564
			break;
		default:
1565
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
1566
					task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1567 1568
			error = -EIO;
		}
1569
		dprintk("RPC: %5u %s: call rejected %d\n",
1570
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1571 1572 1573
		goto out_err;
	}
	if (!(p = rpcauth_checkverf(task, p))) {
1574
		dprintk("RPC: %5u %s: auth check failed\n",
1575
				task->tk_pid, __func__);
T
Trond Myklebust 已提交
1576
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
1577
	}
1578
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
1579 1580 1581 1582 1583 1584
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
1585
		dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1586
				task->tk_pid, __func__,
L
Linus Torvalds 已提交
1587 1588
				(unsigned int)task->tk_client->cl_prog,
				task->tk_client->cl_server);
1589 1590
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1591
	case RPC_PROG_MISMATCH:
1592
		dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1593
				"server %s\n", task->tk_pid, __func__,
L
Linus Torvalds 已提交
1594 1595 1596
				(unsigned int)task->tk_client->cl_prog,
				(unsigned int)task->tk_client->cl_vers,
				task->tk_client->cl_server);
1597 1598
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1599
	case RPC_PROC_UNAVAIL:
1600
		dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
1601
				"version %u on server %s\n",
1602
				task->tk_pid, __func__,
1603
				rpc_proc_name(task),
L
Linus Torvalds 已提交
1604 1605 1606
				task->tk_client->cl_prog,
				task->tk_client->cl_vers,
				task->tk_client->cl_server);
1607 1608
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
1609
	case RPC_GARBAGE_ARGS:
1610
		dprintk("RPC: %5u %s: server saw garbage\n",
1611
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
1612 1613
		break;			/* retry */
	default:
1614
		dprintk("RPC: %5u %s: server accept status: %x\n",
1615
				task->tk_pid, __func__, n);
L
Linus Torvalds 已提交
1616 1617 1618
		/* Also retry */
	}

T
Trond Myklebust 已提交
1619
out_garbage:
L
Linus Torvalds 已提交
1620 1621 1622
	task->tk_client->cl_stats->rpcgarbage++;
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
1623
		dprintk("RPC: %5u %s: retrying\n",
1624
				task->tk_pid, __func__);
L
Linus Torvalds 已提交
1625
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
1626 1627
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
1628 1629 1630 1631 1632
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
1633
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1634
			__func__, error);
T
Trond Myklebust 已提交
1635
	return ERR_PTR(error);
L
Linus Torvalds 已提交
1636
out_overflow:
1637
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1638
			__func__);
T
Trond Myklebust 已提交
1639
	goto out_garbage;
L
Linus Torvalds 已提交
1640
}
1641

1642
static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1643 1644 1645 1646
{
	return 0;
}

1647
static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1648 1649 1650 1651 1652 1653 1654 1655 1656
{
	return 0;
}

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

T
Trond Myklebust 已提交
1657
static int rpc_ping(struct rpc_clnt *clnt, int flags)
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
{
	struct rpc_message msg = {
		.rpc_proc = &rpcproc_null,
	};
	int err;
	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
	err = rpc_call_sync(clnt, &msg, flags);
	put_rpccred(msg.rpc_cred);
	return err;
}
1668

1669 1670 1671 1672 1673 1674
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,
	};
1675 1676 1677 1678 1679 1680
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
1681
	return rpc_run_task(&task_setup_data);
1682
}
1683
EXPORT_SYMBOL_GPL(rpc_call_null);
1684

1685
#ifdef RPC_DEBUG
1686 1687
static void rpc_show_header(void)
{
1688 1689
	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
		"-timeout ---ops--\n");
1690 1691
}

C
Chuck Lever 已提交
1692 1693 1694 1695
static void rpc_show_task(const struct rpc_clnt *clnt,
			  const struct rpc_task *task)
{
	const char *rpc_waitq = "none";
1696
	char *p, action[KSYM_SYMBOL_LEN];
C
Chuck Lever 已提交
1697 1698 1699 1700

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

1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
	/* 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 已提交
1713 1714
}

1715 1716 1717
void rpc_show_tasks(void)
{
	struct rpc_clnt *clnt;
C
Chuck Lever 已提交
1718
	struct rpc_task *task;
1719
	int header = 0;
1720 1721 1722 1723

	spin_lock(&rpc_client_lock);
	list_for_each_entry(clnt, &all_clients, cl_clients) {
		spin_lock(&clnt->cl_lock);
C
Chuck Lever 已提交
1724
		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
1725 1726 1727 1728
			if (!header) {
				rpc_show_header();
				header++;
			}
C
Chuck Lever 已提交
1729
			rpc_show_task(clnt, task);
1730 1731 1732 1733 1734 1735
		}
		spin_unlock(&clnt->cl_lock);
	}
	spin_unlock(&rpc_client_lock);
}
#endif