clnt.c 37.9 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 28 29
 *
 *  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>
#include <linux/mm.h>
#include <linux/slab.h>
30
#include <linux/smp_lock.h>
L
Linus Torvalds 已提交
31
#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>
L
Linus Torvalds 已提交
38 39 40 41 42 43


#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

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

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

L
Linus Torvalds 已提交
54 55 56 57 58 59 60 61 62 63
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_encode(struct rpc_task *task);
static void	call_decode(struct rpc_task *task);
static void	call_bind(struct rpc_task *task);
64
static void	call_bind_status(struct rpc_task *task);
L
Linus Torvalds 已提交
65 66
static void	call_transmit(struct rpc_task *task);
static void	call_status(struct rpc_task *task);
67
static void	call_transmit_status(struct rpc_task *task);
L
Linus Torvalds 已提交
68 69 70 71 72
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);
73 74
static __be32 *	call_header(struct rpc_task *task);
static __be32 *	call_verify(struct rpc_task *task);
L
Linus Torvalds 已提交
75

T
Trond Myklebust 已提交
76 77
static int	rpc_ping(struct rpc_clnt *clnt, int flags);

78 79 80 81 82 83 84 85 86 87 88 89 90
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 已提交
91 92 93 94

static int
rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
{
95
	static uint32_t clntid;
L
Linus Torvalds 已提交
96 97
	int error;

98 99
	clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
	clnt->cl_dentry = ERR_PTR(-ENOENT);
L
Linus Torvalds 已提交
100 101
	if (dir_name == NULL)
		return 0;
102 103 104 105 106

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

107 108 109 110 111 112 113 114
	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';
		clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
		if (!IS_ERR(clnt->cl_dentry))
			return 0;
L
Linus Torvalds 已提交
115
		error = PTR_ERR(clnt->cl_dentry);
116 117 118
		if (error != -EEXIST) {
			printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
					clnt->cl_pathname, error);
119
			rpc_put_mount();
120 121
			return error;
		}
L
Linus Torvalds 已提交
122 123 124
	}
}

125
static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, rpc_authflavor_t flavor)
L
Linus Torvalds 已提交
126 127 128
{
	struct rpc_version	*version;
	struct rpc_clnt		*clnt = NULL;
129
	struct rpc_auth		*auth;
L
Linus Torvalds 已提交
130
	int err;
131 132 133 134 135 136 137 138
	size_t len;

	/* sanity check the name before trying to print it */
	err = -EINVAL;
	len = strlen(servname);
	if (len > RPC_MAXNETNAMELEN)
		goto out_no_rpciod;
	len++;
L
Linus Torvalds 已提交
139

140 141
	dprintk("RPC:       creating %s client for %s (xprt %p)\n",
			program->name, servname, xprt);
L
Linus Torvalds 已提交
142

143 144 145
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
L
Linus Torvalds 已提交
146 147
	err = -EINVAL;
	if (!xprt)
148
		goto out_no_xprt;
L
Linus Torvalds 已提交
149 150 151 152
	if (vers >= program->nrvers || !(version = program->version[vers]))
		goto out_err;

	err = -ENOMEM;
153
	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
L
Linus Torvalds 已提交
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
	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);
		if (buf != 0)
			clnt->cl_server = buf;
		else
			len = sizeof(clnt->cl_inline_name);
	}
	strlcpy(clnt->cl_server, servname, len);

	clnt->cl_xprt     = xprt;
	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;
175
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
176 177 178
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
179
	clnt->cl_program  = program;
180
	INIT_LIST_HEAD(&clnt->cl_tasks);
181
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
182

183
	if (!xprt_bound(clnt->cl_xprt))
L
Linus Torvalds 已提交
184 185 186 187 188
		clnt->cl_autobind = 1;

	clnt->cl_rtt = &clnt->cl_rtt_default;
	rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);

189 190
	kref_init(&clnt->cl_kref);

L
Linus Torvalds 已提交
191 192 193 194
	err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
	if (err < 0)
		goto out_no_path;

195 196
	auth = rpcauth_create(flavor, clnt);
	if (IS_ERR(auth)) {
L
Linus Torvalds 已提交
197 198
		printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
				flavor);
199
		err = PTR_ERR(auth);
L
Linus Torvalds 已提交
200 201 202 203
		goto out_no_auth;
	}

	/* save the nodename */
204
	clnt->cl_nodelen = strlen(utsname()->nodename);
L
Linus Torvalds 已提交
205 206
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
207
	memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
208
	rpc_register_client(clnt);
L
Linus Torvalds 已提交
209 210 211
	return clnt;

out_no_auth:
212
	if (!IS_ERR(clnt->cl_dentry)) {
T
Trond Myklebust 已提交
213
		rpc_rmdir(clnt->cl_dentry);
214 215
		rpc_put_mount();
	}
L
Linus Torvalds 已提交
216
out_no_path:
217 218
	rpc_free_iostats(clnt->cl_metrics);
out_no_stats:
L
Linus Torvalds 已提交
219 220 221 222
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
	kfree(clnt);
out_err:
223
	xprt_put(xprt);
224
out_no_xprt:
225 226
	rpciod_down();
out_no_rpciod:
L
Linus Torvalds 已提交
227 228 229
	return ERR_PTR(err);
}

230 231 232 233 234 235 236 237 238 239 240 241 242 243
/*
 * 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;
244
	struct xprt_create xprtargs = {
245
		.ident = args->protocol,
246
		.srcaddr = args->saddress,
247 248 249 250
		.dstaddr = args->address,
		.addrlen = args->addrsize,
		.timeout = args->timeout
	};
251
	char servername[48];
252

253
	xprt = xprt_create_transport(&xprtargs);
254 255 256
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

257 258 259 260 261
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
	if (args->servername == NULL) {
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
		servername[0] = '\0';
		switch (args->address->sa_family) {
		case AF_INET: {
			struct sockaddr_in *sin =
					(struct sockaddr_in *)args->address;
			snprintf(servername, sizeof(servername), NIPQUAD_FMT,
				 NIPQUAD(sin->sin_addr.s_addr));
			break;
		}
		case AF_INET6: {
			struct sockaddr_in6 *sin =
					(struct sockaddr_in6 *)args->address;
			snprintf(servername, sizeof(servername), NIP6_FMT,
				 NIP6(sin->sin6_addr));
			break;
		}
		default:
			/* caller wants default server name, but
			 * address family isn't recognized. */
			return ERR_PTR(-EINVAL);
		}
283 284 285
		args->servername = servername;
	}

286 287 288 289
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
	/*
	 * 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;

	clnt = rpc_new_client(xprt, args->servername, args->program,
				args->version, args->authflavor);
	if (IS_ERR(clnt))
		return clnt;

	if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
		int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
		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_INTR)
		clnt->cl_intr = 1;
	if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
		clnt->cl_autobind = 1;
321 322
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
323 324 325

	return clnt;
}
326
EXPORT_SYMBOL_GPL(rpc_create);
327

L
Linus Torvalds 已提交
328 329 330 331 332 333 334 335 336
/*
 * 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;
337
	int err = -ENOMEM;
L
Linus Torvalds 已提交
338

339
	new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
L
Linus Torvalds 已提交
340 341
	if (!new)
		goto out_no_clnt;
342 343 344 345 346 347
	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);
	rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
348 349 350
	new->cl_metrics = rpc_alloc_iostats(clnt);
	if (new->cl_metrics == NULL)
		goto out_no_stats;
351
	kref_init(&new->cl_kref);
352 353 354
	err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
	if (err != 0)
		goto out_no_path;
L
Linus Torvalds 已提交
355 356
	if (new->cl_auth)
		atomic_inc(&new->cl_auth->au_count);
357 358
	xprt_get(clnt->cl_xprt);
	kref_get(&clnt->cl_kref);
359
	rpc_register_client(new);
360
	rpciod_up();
L
Linus Torvalds 已提交
361
	return new;
362 363
out_no_path:
	rpc_free_iostats(new->cl_metrics);
364 365
out_no_stats:
	kfree(new);
L
Linus Torvalds 已提交
366
out_no_clnt:
367
	dprintk("RPC:       %s: returned error %d\n", __FUNCTION__, err);
368
	return ERR_PTR(err);
L
Linus Torvalds 已提交
369
}
370
EXPORT_SYMBOL_GPL(rpc_clone_client);
L
Linus Torvalds 已提交
371 372 373

/*
 * Properly shut down an RPC client, terminating all outstanding
374
 * requests.
L
Linus Torvalds 已提交
375
 */
376
void rpc_shutdown_client(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
377
{
378 379
	dprintk("RPC:       shutting down %s client for %s\n",
			clnt->cl_protname, clnt->cl_server);
L
Linus Torvalds 已提交
380

381
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
382
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
383
		wait_event_timeout(destroy_wait,
384
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
385 386
	}

387
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
388
}
389
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
390 391

/*
392
 * Free an RPC client
L
Linus Torvalds 已提交
393
 */
394 395
static void
rpc_free_client(struct kref *kref)
L
Linus Torvalds 已提交
396
{
397
	struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
L
Linus Torvalds 已提交
398

399
	dprintk("RPC:       destroying %s client for %s\n",
L
Linus Torvalds 已提交
400
			clnt->cl_protname, clnt->cl_server);
401
	if (!IS_ERR(clnt->cl_dentry)) {
T
Trond Myklebust 已提交
402
		rpc_rmdir(clnt->cl_dentry);
403 404
		rpc_put_mount();
	}
405
	if (clnt->cl_parent != clnt) {
406
		rpc_release_client(clnt->cl_parent);
407 408
		goto out_free;
	}
L
Linus Torvalds 已提交
409 410 411
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
out_free:
412
	rpc_unregister_client(clnt);
413 414
	rpc_free_iostats(clnt->cl_metrics);
	clnt->cl_metrics = NULL;
415
	xprt_put(clnt->cl_xprt);
416
	rpciod_down();
L
Linus Torvalds 已提交
417 418 419
	kfree(clnt);
}

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
/*
 * 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 已提交
444
/*
445
 * Release reference to the RPC client
L
Linus Torvalds 已提交
446 447 448 449
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
450
	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
L
Linus Torvalds 已提交
451

452 453
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
454
	kref_put(&clnt->cl_kref, rpc_free_auth);
455 456
}

457 458 459 460 461 462 463 464 465 466 467 468
/**
 * rpc_bind_new_program - bind a new RPC program to an existing client
 * @old - old rpc_client
 * @program - rpc program to set
 * @vers - rpc program version
 *
 * 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,
469
				      u32 vers)
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
{
	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;
	err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
	if (err != 0) {
		rpc_shutdown_client(clnt);
		clnt = ERR_PTR(err);
	}
491
out:
492 493
	return clnt;
}
494
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
495

L
Linus Torvalds 已提交
496 497 498 499
/*
 * Default callback for async RPC calls
 */
static void
500
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
501 502 503
{
}

504 505 506 507
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

L
Linus Torvalds 已提交
508
/*
509
 *	Export the signal mask handling for synchronous code that
L
Linus Torvalds 已提交
510 511
 *	sleeps on RPC calls
 */
512
#define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
513

514 515
static void rpc_save_sigmask(sigset_t *oldset, int intr)
{
516
	unsigned long	sigallow = sigmask(SIGKILL);
517 518 519 520 521 522 523 524 525
	sigset_t sigmask;

	/* Block all signals except those listed in sigallow */
	if (intr)
		sigallow |= RPC_INTR_SIGNALS;
	siginitsetinv(&sigmask, sigallow);
	sigprocmask(SIG_BLOCK, &sigmask, oldset);
}

526
static void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
527 528 529 530
{
	rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
}

531
static void rpc_restore_sigmask(sigset_t *oldset)
532 533 534 535
{
	sigprocmask(SIG_SETMASK, oldset, NULL);
}

L
Linus Torvalds 已提交
536 537
void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
{
538
	rpc_save_sigmask(oldset, clnt->cl_intr);
L
Linus Torvalds 已提交
539
}
540
EXPORT_SYMBOL_GPL(rpc_clnt_sigmask);
L
Linus Torvalds 已提交
541 542 543

void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
{
544
	rpc_restore_sigmask(oldset);
L
Linus Torvalds 已提交
545
}
546
EXPORT_SYMBOL_GPL(rpc_clnt_sigunmask);
L
Linus Torvalds 已提交
547

T
Trond Myklebust 已提交
548 549 550 551 552
/**
 * 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)
553 554 555 556
{
	struct rpc_task *task, *ret;
	sigset_t oldset;

557
	task = rpc_new_task(task_setup_data);
558
	if (task == NULL) {
559 560
		rpc_release_calldata(task_setup_data->callback_ops,
				task_setup_data->callback_data);
561 562
		ret = ERR_PTR(-ENOMEM);
		goto out;
563 564
	}

565 566 567 568
	if (task->tk_status != 0) {
		ret = ERR_PTR(task->tk_status);
		rpc_put_task(task);
		goto out;
569 570
	}
	atomic_inc(&task->tk_count);
571 572
	/* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
	rpc_task_sigmask(task, &oldset);
573
	rpc_execute(task);
574
	rpc_restore_sigmask(&oldset);
575 576 577 578
	ret = task;
out:
	return ret;
}
T
Trond Myklebust 已提交
579
EXPORT_SYMBOL_GPL(rpc_run_task);
580 581 582 583 584 585

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

	BUG_ON(flags & RPC_TASK_ASYNC);

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

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

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

638 639 640 641 642 643 644
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
/**
 * rpc_peeraddr - extract remote peer address from clnt's xprt
 * @clnt: RPC client structure
 * @buf: target buffer
 * @size: length of target buffer
 *
 * 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);
662
	return xprt->addrlen;
663
}
664
EXPORT_SYMBOL_GPL(rpc_peeraddr);
665

666 667 668 669 670 671 672 673 674
/**
 * rpc_peeraddr2str - return remote peer address in printable format
 * @clnt: RPC client structure
 * @format: address format
 *
 */
char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
{
	struct rpc_xprt *xprt = clnt->cl_xprt;
675 676 677 678 679

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
680
}
681
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
682

L
Linus Torvalds 已提交
683 684 685 686
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
	struct rpc_xprt *xprt = clnt->cl_xprt;
687 688
	if (xprt->ops->set_buffer_size)
		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
L
Linus Torvalds 已提交
689
}
690
EXPORT_SYMBOL_GPL(rpc_setbufsize);
L
Linus Torvalds 已提交
691 692 693 694 695 696 697 698 699 700 701 702 703

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

706 707 708 709 710 711 712 713
/**
 * 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)
714
		xprt_clear_bound(clnt->cl_xprt);
715
}
716
EXPORT_SYMBOL_GPL(rpc_force_rebind);
717

L
Linus Torvalds 已提交
718 719 720 721 722 723 724 725 726 727 728 729
/*
 * 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;
}
730
EXPORT_SYMBOL_GPL(rpc_restart_call);
L
Linus Torvalds 已提交
731 732 733 734 735 736 737 738 739 740 741 742

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

743 744 745 746
	dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
			clnt->cl_protname, clnt->cl_vers,
			task->tk_msg.rpc_proc->p_proc,
			(RPC_IS_ASYNC(task) ? "async" : "sync"));
L
Linus Torvalds 已提交
747 748 749 750 751 752 753 754 755 756 757 758 759

	/* 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)
{
760
	dprint_status(task);
L
Linus Torvalds 已提交
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

	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;

780
	dprint_status(task);
L
Linus Torvalds 已提交
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824

	/*
	 * 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",
				__FUNCTION__, status);
		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",
				__FUNCTION__, status);
		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",
				__FUNCTION__, status);
		break;
	}
	rpc_exit(task, status);
}

/*
 * 2.	Allocate the buffer. For details, see sched.c:rpc_malloc.
825
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
826 827 828 829
 */
static void
call_allocate(struct rpc_task *task)
{
830
	unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
831 832
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = task->tk_xprt;
833
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
834

835 836
	dprint_status(task);

837
	task->tk_status = 0;
L
Linus Torvalds 已提交
838
	task->tk_action = call_bind;
839

840
	if (req->rq_buffer)
L
Linus Torvalds 已提交
841 842
		return;

843 844 845 846 847
	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 已提交
848

849 850 851 852 853 854 855 856 857 858
	/*
	 * 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;

859 860
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
861
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
862
		return;
863 864

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

866
	if (RPC_IS_ASYNC(task) || !signalled()) {
867
		task->tk_action = call_allocate;
L
Linus Torvalds 已提交
868 869 870 871 872 873 874
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

875 876 877 878 879 880 881 882 883 884 885 886
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;
}

887 888 889 890 891 892 893
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;
894
	buf->flags = 0;
895 896 897 898
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
899 900 901 902 903 904 905 906
/*
 * 3.	Encode arguments of an RPC call
 */
static void
call_encode(struct rpc_task *task)
{
	struct rpc_rqst	*req = task->tk_rqstp;
	kxdrproc_t	encode;
907
	__be32		*p;
L
Linus Torvalds 已提交
908

909
	dprint_status(task);
L
Linus Torvalds 已提交
910

911 912 913 914 915 916
	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 已提交
917 918 919 920 921 922 923 924

	/* Encode header and provided arguments */
	encode = task->tk_msg.rpc_proc->p_encode;
	if (!(p = call_header(task))) {
		printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
		rpc_exit(task, -EIO);
		return;
	}
925 926 927 928 929 930 931 932 933 934
	if (encode == NULL)
		return;

	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
			task->tk_msg.rpc_argp);
	if (task->tk_status == -ENOMEM) {
		/* XXX: Is this sane? */
		rpc_delay(task, 3*HZ);
		task->tk_status = -EAGAIN;
	}
L
Linus Torvalds 已提交
935 936 937 938 939 940 941 942
}

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

945
	dprint_status(task);
L
Linus Torvalds 已提交
946

947
	task->tk_action = call_connect;
948
	if (!xprt_bound(xprt)) {
949
		task->tk_action = call_bind_status;
950
		task->tk_timeout = xprt->bind_timeout;
951
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
952 953 954 955
	}
}

/*
956 957 958 959 960
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
961
	int status = -EIO;
962 963

	if (task->tk_status >= 0) {
964
		dprint_status(task);
965 966 967 968 969 970
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

	switch (task->tk_status) {
971 972 973 974 975 976
	case -EAGAIN:
		dprintk("RPC: %5u rpcbind waiting for another request "
				"to finish\n", task->tk_pid);
		/* avoid busy-waiting here -- could be a network outage. */
		rpc_delay(task, 5*HZ);
		goto retry_timeout;
977
	case -EACCES:
978 979
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
980 981 982 983 984
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
985
		rpc_delay(task, 3*HZ);
986
		goto retry_timeout;
987
	case -ETIMEDOUT:
988
		dprintk("RPC: %5u rpcbind request timed out\n",
989
				task->tk_pid);
990
		goto retry_timeout;
991
	case -EPFNOSUPPORT:
992
		/* server doesn't support any rpcbind version we know of */
993
		dprintk("RPC: %5u remote rpcbind service unavailable\n",
994 995 996
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
997
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
998
				task->tk_pid);
999 1000 1001
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1002
	default:
1003
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1004 1005 1006 1007 1008 1009
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1010 1011
retry_timeout:
	task->tk_action = call_timeout;
1012 1013 1014 1015
}

/*
 * 4b.	Connect to the RPC server
L
Linus Torvalds 已提交
1016 1017 1018 1019
 */
static void
call_connect(struct rpc_task *task)
{
1020
	struct rpc_xprt *xprt = task->tk_xprt;
L
Linus Torvalds 已提交
1021

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

1026 1027 1028 1029 1030 1031
	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 已提交
1032 1033 1034 1035
	}
}

/*
1036
 * 4c.	Sort out connect result
L
Linus Torvalds 已提交
1037 1038 1039 1040 1041 1042 1043
 */
static void
call_connect_status(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

1044
	dprint_status(task);
1045

L
Linus Torvalds 已提交
1046 1047 1048 1049 1050 1051 1052
	task->tk_status = 0;
	if (status >= 0) {
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}

1053
	/* Something failed: remote service port may have changed */
1054
	rpc_force_rebind(clnt);
1055

L
Linus Torvalds 已提交
1056 1057 1058
	switch (status) {
	case -ENOTCONN:
	case -EAGAIN:
1059
		task->tk_action = call_bind;
1060 1061 1062 1063 1064 1065
		if (!RPC_IS_SOFT(task))
			return;
		/* if soft mounted, test if we've timed out */
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
		return;
L
Linus Torvalds 已提交
1066
	}
1067
	rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1068 1069 1070 1071 1072 1073 1074 1075
}

/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
1076
	dprint_status(task);
L
Linus Torvalds 已提交
1077 1078 1079 1080 1081 1082 1083

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1084
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1085
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1086
	if (rpc_task_need_encode(task)) {
1087
		BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
L
Linus Torvalds 已提交
1088
		call_encode(task);
1089 1090
		/* Did the encode result in an error condition? */
		if (task->tk_status != 0)
1091
			return;
1092
	}
L
Linus Torvalds 已提交
1093 1094 1095
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
	/*
	 * 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);
	if (task->tk_msg.rpc_proc->p_decode != NULL)
		return;
	task->tk_action = rpc_exit_task;
	rpc_wake_up_task(task);
}

/*
 * 5a.	Handle cleanup after a transmission
 */
static void
call_transmit_status(struct rpc_task *task)
{
	task->tk_action = call_status;
	/*
	 * Special case: if we've been waiting on the socket's write_space()
	 * callback, then don't call xprt_end_transmit().
	 */
	if (task->tk_status == -EAGAIN)
		return;
	xprt_end_transmit(task);
1121
	rpc_task_force_reencode(task);
L
Linus Torvalds 已提交
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
}

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

	if (req->rq_received > 0 && !req->rq_bytes_sent)
		task->tk_status = req->rq_received;

1137
	dprint_status(task);
L
Linus Torvalds 已提交
1138 1139 1140 1141 1142 1143 1144 1145 1146

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

	task->tk_status = 0;
	switch(status) {
1147 1148 1149 1150 1151 1152 1153 1154
	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 已提交
1155 1156
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
1157
		if (task->tk_client->cl_discrtry)
1158
			xprt_force_disconnect(task->tk_xprt);
L
Linus Torvalds 已提交
1159 1160 1161
		break;
	case -ECONNREFUSED:
	case -ENOTCONN:
1162
		rpc_force_rebind(clnt);
L
Linus Torvalds 已提交
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
		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:
C
Chuck Lever 已提交
1173
		printk("%s: RPC call returned error %d\n",
L
Linus Torvalds 已提交
1174 1175 1176 1177 1178 1179
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
1180
 * 6a.	Handle RPC timeout
L
Linus Torvalds 已提交
1181 1182 1183 1184 1185 1186 1187 1188 1189
 * 	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) {
1190
		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
L
Linus Torvalds 已提交
1191 1192 1193
		goto retry;
	}

1194
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1195 1196
	task->tk_timeouts++;

L
Linus Torvalds 已提交
1197
	if (RPC_IS_SOFT(task)) {
C
Chuck Lever 已提交
1198
		printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
L
Linus Torvalds 已提交
1199 1200 1201 1202 1203
				clnt->cl_protname, clnt->cl_server);
		rpc_exit(task, -EIO);
		return;
	}

C
Chuck Lever 已提交
1204
	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
L
Linus Torvalds 已提交
1205 1206 1207 1208
		task->tk_flags |= RPC_CALL_MAJORSEEN;
		printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
			clnt->cl_protname, clnt->cl_server);
	}
1209
	rpc_force_rebind(clnt);
L
Linus Torvalds 已提交
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225

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

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

C
Chuck Lever 已提交
1231
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
L
Linus Torvalds 已提交
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
		printk(KERN_NOTICE "%s: server %s OK\n",
			clnt->cl_protname, clnt->cl_server);
		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
	}

	if (task->tk_status < 12) {
		if (!RPC_IS_SOFT(task)) {
			task->tk_action = call_bind;
			clnt->cl_stats->rpcretrans++;
			goto out_retry;
		}
1243 1244
		dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
				clnt->cl_protname, task->tk_status);
1245 1246
		task->tk_action = call_timeout;
		goto out_retry;
L
Linus Torvalds 已提交
1247 1248
	}

1249 1250 1251 1252 1253
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
	 * before it changed req->rq_received.
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1254 1255 1256 1257 1258 1259 1260
	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);

	/* Verify the RPC header */
T
Trond Myklebust 已提交
1261 1262 1263 1264 1265
	p = call_verify(task);
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
1266 1267
	}

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

1270
	if (decode) {
L
Linus Torvalds 已提交
1271 1272
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
1273
	}
1274 1275
	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
			task->tk_status);
L
Linus Torvalds 已提交
1276 1277 1278 1279
	return;
out_retry:
	req->rq_received = req->rq_private_buf.len = 0;
	task->tk_status = 0;
1280
	if (task->tk_client->cl_discrtry)
1281
		xprt_force_disconnect(task->tk_xprt);
L
Linus Torvalds 已提交
1282 1283 1284 1285 1286 1287 1288 1289
}

/*
 * 8.	Refresh the credentials if rejected by the server
 */
static void
call_refresh(struct rpc_task *task)
{
1290
	dprint_status(task);
L
Linus Torvalds 已提交
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304

	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;
1305 1306

	dprint_status(task);
L
Linus Torvalds 已提交
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324

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

/*
 * Call header serialization
 */
1325
static __be32 *
L
Linus Torvalds 已提交
1326 1327 1328 1329
call_header(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
1330
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
1331 1332

	/* FIXME: check buffer size? */
1333 1334

	p = xprt_skip_transport_header(task->tk_xprt, p);
L
Linus Torvalds 已提交
1335 1336 1337 1338 1339 1340
	*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 */
1341 1342 1343
	p = rpcauth_marshcred(task, p);
	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
	return p;
L
Linus Torvalds 已提交
1344 1345 1346 1347 1348
}

/*
 * Reply header verification
 */
1349
static __be32 *
L
Linus Torvalds 已提交
1350 1351 1352 1353
call_verify(struct rpc_task *task)
{
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1354 1355
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
1356 1357
	int error = -EACCES;

1358 1359 1360 1361 1362 1363
	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
		 */
1364 1365 1366
		dprintk("RPC: %5u %s: XDR representation not a multiple of"
		       " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
		       task->tk_rqstp->rq_rcv_buf.len);
1367 1368
		goto out_eio;
	}
L
Linus Torvalds 已提交
1369 1370 1371 1372 1373
	if ((len -= 3) < 0)
		goto out_overflow;
	p += 1;	/* skip XID */

	if ((n = ntohl(*p++)) != RPC_REPLY) {
1374 1375
		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
				task->tk_pid, __FUNCTION__, n);
T
Trond Myklebust 已提交
1376
		goto out_garbage;
L
Linus Torvalds 已提交
1377 1378 1379 1380 1381 1382 1383 1384
	}
	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:
1385 1386 1387
				dprintk("RPC: %5u %s: RPC call version "
						"mismatch!\n",
						task->tk_pid, __FUNCTION__);
1388 1389
				error = -EPROTONOSUPPORT;
				goto out_err;
L
Linus Torvalds 已提交
1390
			default:
1391 1392 1393
				dprintk("RPC: %5u %s: RPC call rejected, "
						"unknown error: %x\n",
						task->tk_pid, __FUNCTION__, n);
L
Linus Torvalds 已提交
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
				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--;
1406 1407
			dprintk("RPC: %5u %s: retry stale creds\n",
					task->tk_pid, __FUNCTION__);
L
Linus Torvalds 已提交
1408
			rpcauth_invalcred(task);
1409 1410
			/* Ensure we obtain a new XID! */
			xprt_release(task);
L
Linus Torvalds 已提交
1411
			task->tk_action = call_refresh;
T
Trond Myklebust 已提交
1412
			goto out_retry;
L
Linus Torvalds 已提交
1413 1414 1415 1416 1417 1418
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
1419 1420
			dprintk("RPC: %5u %s: retry garbled creds\n",
					task->tk_pid, __FUNCTION__);
L
Linus Torvalds 已提交
1421
			task->tk_action = call_bind;
T
Trond Myklebust 已提交
1422
			goto out_retry;
L
Linus Torvalds 已提交
1423
		case RPC_AUTH_TOOWEAK:
1424 1425
			printk(KERN_NOTICE "call_verify: server %s requires stronger "
			       "authentication.\n", task->tk_client->cl_server);
L
Linus Torvalds 已提交
1426 1427
			break;
		default:
1428 1429
			dprintk("RPC: %5u %s: unknown auth error: %x\n",
					task->tk_pid, __FUNCTION__, n);
L
Linus Torvalds 已提交
1430 1431
			error = -EIO;
		}
1432 1433
		dprintk("RPC: %5u %s: call rejected %d\n",
				task->tk_pid, __FUNCTION__, n);
L
Linus Torvalds 已提交
1434 1435 1436
		goto out_err;
	}
	if (!(p = rpcauth_checkverf(task, p))) {
1437 1438
		dprintk("RPC: %5u %s: auth check failed\n",
				task->tk_pid, __FUNCTION__);
T
Trond Myklebust 已提交
1439
		goto out_garbage;		/* bad verifier, retry */
L
Linus Torvalds 已提交
1440
	}
1441
	len = p - (__be32 *)iov->iov_base - 1;
L
Linus Torvalds 已提交
1442 1443 1444 1445 1446 1447
	if (len < 0)
		goto out_overflow;
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
	case RPC_PROG_UNAVAIL:
1448 1449
		dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
				task->tk_pid, __FUNCTION__,
L
Linus Torvalds 已提交
1450 1451
				(unsigned int)task->tk_client->cl_prog,
				task->tk_client->cl_server);
1452 1453
		error = -EPFNOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1454
	case RPC_PROG_MISMATCH:
1455 1456
		dprintk("RPC: %5u %s: program %u, version %u unsupported by "
				"server %s\n", task->tk_pid, __FUNCTION__,
L
Linus Torvalds 已提交
1457 1458 1459
				(unsigned int)task->tk_client->cl_prog,
				(unsigned int)task->tk_client->cl_vers,
				task->tk_client->cl_server);
1460 1461
		error = -EPROTONOSUPPORT;
		goto out_err;
L
Linus Torvalds 已提交
1462
	case RPC_PROC_UNAVAIL:
1463 1464 1465
		dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
				"version %u on server %s\n",
				task->tk_pid, __FUNCTION__,
L
Linus Torvalds 已提交
1466 1467 1468 1469
				task->tk_msg.rpc_proc,
				task->tk_client->cl_prog,
				task->tk_client->cl_vers,
				task->tk_client->cl_server);
1470 1471
		error = -EOPNOTSUPP;
		goto out_err;
L
Linus Torvalds 已提交
1472
	case RPC_GARBAGE_ARGS:
1473 1474
		dprintk("RPC: %5u %s: server saw garbage\n",
				task->tk_pid, __FUNCTION__);
L
Linus Torvalds 已提交
1475 1476
		break;			/* retry */
	default:
1477 1478
		dprintk("RPC: %5u %s: server accept status: %x\n",
				task->tk_pid, __FUNCTION__, n);
L
Linus Torvalds 已提交
1479 1480 1481
		/* Also retry */
	}

T
Trond Myklebust 已提交
1482
out_garbage:
L
Linus Torvalds 已提交
1483 1484 1485
	task->tk_client->cl_stats->rpcgarbage++;
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
1486 1487
		dprintk("RPC: %5u %s: retrying\n",
				task->tk_pid, __FUNCTION__);
L
Linus Torvalds 已提交
1488
		task->tk_action = call_bind;
T
Trond Myklebust 已提交
1489 1490
out_retry:
		return ERR_PTR(-EAGAIN);
L
Linus Torvalds 已提交
1491 1492 1493 1494 1495
	}
out_eio:
	error = -EIO;
out_err:
	rpc_exit(task, error);
1496 1497
	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
			__FUNCTION__, error);
T
Trond Myklebust 已提交
1498
	return ERR_PTR(error);
L
Linus Torvalds 已提交
1499
out_overflow:
1500 1501
	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
			__FUNCTION__);
T
Trond Myklebust 已提交
1502
	goto out_garbage;
L
Linus Torvalds 已提交
1503
}
1504

1505
static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1506 1507 1508 1509
{
	return 0;
}

1510
static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1511 1512 1513 1514 1515 1516 1517 1518 1519
{
	return 0;
}

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

T
Trond Myklebust 已提交
1520
static int rpc_ping(struct rpc_clnt *clnt, int flags)
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
{
	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;
}
1531

1532 1533 1534 1535 1536 1537
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,
	};
1538 1539 1540 1541 1542 1543
	struct rpc_task_setup task_setup_data = {
		.rpc_client = clnt,
		.rpc_message = &msg,
		.callback_ops = &rpc_default_ops,
		.flags = flags,
	};
T
Trond Myklebust 已提交
1544
	return rpc_run_task(&task_setup_data);
1545
}
1546
EXPORT_SYMBOL_GPL(rpc_call_null);
1547

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
#ifdef RPC_DEBUG
void rpc_show_tasks(void)
{
	struct rpc_clnt *clnt;
	struct rpc_task *t;

	spin_lock(&rpc_client_lock);
	if (list_empty(&all_clients))
		goto out;
	printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
		"-rpcwait -action- ---ops--\n");
	list_for_each_entry(clnt, &all_clients, cl_clients) {
		if (list_empty(&clnt->cl_tasks))
			continue;
		spin_lock(&clnt->cl_lock);
		list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
			const char *rpc_waitq = "none";
C
Chuck Lever 已提交
1565 1566 1567 1568 1569 1570
			int proc;

			if (t->tk_msg.rpc_proc)
				proc = t->tk_msg.rpc_proc->p_proc;
			else
				proc = -1;
1571 1572 1573 1574 1575

			if (RPC_IS_QUEUED(t))
				rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);

			printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
C
Chuck Lever 已提交
1576
				t->tk_pid, proc,
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
				t->tk_flags, t->tk_status,
				t->tk_client,
				(t->tk_client ? t->tk_client->cl_prog : 0),
				t->tk_rqstp, t->tk_timeout,
				rpc_waitq,
				t->tk_action, t->tk_ops);
		}
		spin_unlock(&clnt->cl_lock);
	}
out:
	spin_unlock(&rpc_client_lock);
}
#endif