clnt.c 38.0 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(const struct rpc_create_args *args, struct rpc_xprt *xprt)
L
Linus Torvalds 已提交
126
{
127
	struct rpc_program	*program = args->program;
L
Linus Torvalds 已提交
128 129
	struct rpc_version	*version;
	struct rpc_clnt		*clnt = NULL;
130
	struct rpc_auth		*auth;
L
Linus Torvalds 已提交
131
	int err;
132 133 134 135
	size_t len;

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

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

144 145 146
	err = rpciod_up();
	if (err)
		goto out_no_rpciod;
L
Linus Torvalds 已提交
147 148
	err = -EINVAL;
	if (!xprt)
149
		goto out_no_xprt;
150 151 152 153 154

	if (args->version >= program->nrvers)
		goto out_err;
	version = program->version[args->version];
	if (version == NULL)
L
Linus Torvalds 已提交
155 156 157
		goto out_err;

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

	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;
180
	clnt->cl_metrics  = rpc_alloc_iostats(clnt);
181 182 183
	err = -ENOMEM;
	if (clnt->cl_metrics == NULL)
		goto out_no_stats;
184
	clnt->cl_program  = program;
185
	INIT_LIST_HEAD(&clnt->cl_tasks);
186
	spin_lock_init(&clnt->cl_lock);
L
Linus Torvalds 已提交
187

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

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

194 195
	kref_init(&clnt->cl_kref);

L
Linus Torvalds 已提交
196 197 198 199
	err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
	if (err < 0)
		goto out_no_path;

200
	auth = rpcauth_create(args->authflavor, clnt);
201
	if (IS_ERR(auth)) {
L
Linus Torvalds 已提交
202
		printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
203
				args->authflavor);
204
		err = PTR_ERR(auth);
L
Linus Torvalds 已提交
205 206 207 208
		goto out_no_auth;
	}

	/* save the nodename */
209
	clnt->cl_nodelen = strlen(utsname()->nodename);
L
Linus Torvalds 已提交
210 211
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
212
	memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
213
	rpc_register_client(clnt);
L
Linus Torvalds 已提交
214 215 216
	return clnt;

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

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

258
	xprt = xprt_create_transport(&xprtargs);
259 260 261
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

262 263 264 265 266
	/*
	 * If the caller chooses not to specify a hostname, whip
	 * up a string representation of the passed-in address.
	 */
	if (args->servername == NULL) {
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
		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);
		}
288 289 290
		args->servername = servername;
	}

291 292 293 294
	xprt = xprt_create_transport(&xprtargs);
	if (IS_ERR(xprt))
		return (struct rpc_clnt *)xprt;

295 296 297 298 299 300 301 302 303 304
	/*
	 * 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;

305
	clnt = rpc_new_client(args, xprt);
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
	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;
325 326
	if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
		clnt->cl_discrtry = 1;
327 328 329

	return clnt;
}
330
EXPORT_SYMBOL_GPL(rpc_create);
331

L
Linus Torvalds 已提交
332 333 334 335 336 337 338 339 340
/*
 * 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;
341
	int err = -ENOMEM;
L
Linus Torvalds 已提交
342

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

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

385
	while (!list_empty(&clnt->cl_tasks)) {
L
Linus Torvalds 已提交
386
		rpc_killall_tasks(clnt);
I
Ingo Molnar 已提交
387
		wait_event_timeout(destroy_wait,
388
			list_empty(&clnt->cl_tasks), 1*HZ);
L
Linus Torvalds 已提交
389 390
	}

391
	rpc_release_client(clnt);
L
Linus Torvalds 已提交
392
}
393
EXPORT_SYMBOL_GPL(rpc_shutdown_client);
L
Linus Torvalds 已提交
394 395

/*
396
 * Free an RPC client
L
Linus Torvalds 已提交
397
 */
398 399
static void
rpc_free_client(struct kref *kref)
L
Linus Torvalds 已提交
400
{
401
	struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
L
Linus Torvalds 已提交
402

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

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

456 457
	if (list_empty(&clnt->cl_tasks))
		wake_up(&destroy_wait);
458
	kref_put(&clnt->cl_kref, rpc_free_auth);
459 460
}

461 462 463 464 465 466 467 468 469 470 471 472
/**
 * 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,
473
				      u32 vers)
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
{
	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);
	}
495
out:
496 497
	return clnt;
}
498
EXPORT_SYMBOL_GPL(rpc_bind_new_program);
499

L
Linus Torvalds 已提交
500 501 502 503
/*
 * Default callback for async RPC calls
 */
static void
504
rpc_default_callback(struct rpc_task *task, void *data)
L
Linus Torvalds 已提交
505 506 507
{
}

508 509 510 511
static const struct rpc_call_ops rpc_default_ops = {
	.rpc_call_done = rpc_default_callback,
};

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

518 519
static void rpc_save_sigmask(sigset_t *oldset, int intr)
{
520
	unsigned long	sigallow = sigmask(SIGKILL);
521 522 523 524 525 526 527 528 529
	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);
}

530
static void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
531 532 533 534
{
	rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
}

535
static void rpc_restore_sigmask(sigset_t *oldset)
536 537 538 539
{
	sigprocmask(SIG_SETMASK, oldset, NULL);
}

L
Linus Torvalds 已提交
540 541
void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
{
542
	rpc_save_sigmask(oldset, clnt->cl_intr);
L
Linus Torvalds 已提交
543
}
544
EXPORT_SYMBOL_GPL(rpc_clnt_sigmask);
L
Linus Torvalds 已提交
545 546 547

void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
{
548
	rpc_restore_sigmask(oldset);
L
Linus Torvalds 已提交
549
}
550
EXPORT_SYMBOL_GPL(rpc_clnt_sigunmask);
L
Linus Torvalds 已提交
551

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

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

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

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

	BUG_ON(flags & RPC_TASK_ASYNC);

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

613 614 615 616 617 618 619
/**
 * 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 已提交
620 621 622
 */
int
rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
623
	       const struct rpc_call_ops *tk_ops, void *data)
L
Linus Torvalds 已提交
624 625
{
	struct rpc_task	*task;
626 627 628 629 630 631 632
	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 已提交
633

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

642 643 644 645 646 647 648
void
rpc_call_start(struct rpc_task *task)
{
	task->tk_action = call_start;
}
EXPORT_SYMBOL_GPL(rpc_call_start);

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
/**
 * 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);
666
	return xprt->addrlen;
667
}
668
EXPORT_SYMBOL_GPL(rpc_peeraddr);
669

670 671 672 673 674 675 676 677 678
/**
 * 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;
679 680 681 682 683

	if (xprt->address_strings[format] != NULL)
		return xprt->address_strings[format];
	else
		return "unprintable";
684
}
685
EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
686

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

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

710 711 712 713 714 715 716 717
/**
 * 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)
718
		xprt_clear_bound(clnt->cl_xprt);
719
}
720
EXPORT_SYMBOL_GPL(rpc_force_rebind);
721

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

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

747 748 749 750
	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 已提交
751 752 753 754 755 756 757 758 759 760 761 762 763

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

	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;

784
	dprint_status(task);
L
Linus Torvalds 已提交
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 825 826 827 828

	/*
	 * 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.
829
 *	(Note: buffer memory is freed in xprt_release).
L
Linus Torvalds 已提交
830 831 832 833
 */
static void
call_allocate(struct rpc_task *task)
{
834
	unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
835 836
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_xprt *xprt = task->tk_xprt;
837
	struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
L
Linus Torvalds 已提交
838

839 840
	dprint_status(task);

841
	task->tk_status = 0;
L
Linus Torvalds 已提交
842
	task->tk_action = call_bind;
843

844
	if (req->rq_buffer)
L
Linus Torvalds 已提交
845 846
		return;

847 848 849 850 851
	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 已提交
852

853 854 855 856 857 858 859 860 861 862
	/*
	 * 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;

863 864
	req->rq_buffer = xprt->ops->buf_alloc(task,
					req->rq_callsize + req->rq_rcvsize);
865
	if (req->rq_buffer != NULL)
L
Linus Torvalds 已提交
866
		return;
867 868

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

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

	rpc_exit(task, -ERESTARTSYS);
}

879 880 881 882 883 884 885 886 887 888 889 890
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;
}

891 892 893 894 895 896 897
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;
898
	buf->flags = 0;
899 900 901 902
	buf->len = 0;
	buf->buflen = len;
}

L
Linus Torvalds 已提交
903 904 905 906 907 908 909 910
/*
 * 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;
911
	__be32		*p;
L
Linus Torvalds 已提交
912

913
	dprint_status(task);
L
Linus Torvalds 已提交
914

915 916 917 918 919 920
	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 已提交
921 922 923 924 925 926 927 928

	/* 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;
	}
929 930 931 932 933 934 935 936 937 938
	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 已提交
939 940 941 942 943 944 945 946
}

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

949
	dprint_status(task);
L
Linus Torvalds 已提交
950

951
	task->tk_action = call_connect;
952
	if (!xprt_bound(xprt)) {
953
		task->tk_action = call_bind_status;
954
		task->tk_timeout = xprt->bind_timeout;
955
		xprt->ops->rpcbind(task);
L
Linus Torvalds 已提交
956 957 958 959
	}
}

/*
960 961 962 963 964
 * 4a.	Sort out bind result
 */
static void
call_bind_status(struct rpc_task *task)
{
965
	int status = -EIO;
966 967

	if (task->tk_status >= 0) {
968
		dprint_status(task);
969 970 971 972 973 974
		task->tk_status = 0;
		task->tk_action = call_connect;
		return;
	}

	switch (task->tk_status) {
975 976 977 978 979 980
	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;
981
	case -EACCES:
982 983
		dprintk("RPC: %5u remote rpcbind: RPC program/version "
				"unavailable\n", task->tk_pid);
984 985 986 987 988
		/* fail immediately if this is an RPC ping */
		if (task->tk_msg.rpc_proc->p_proc == 0) {
			status = -EOPNOTSUPP;
			break;
		}
989
		rpc_delay(task, 3*HZ);
990
		goto retry_timeout;
991
	case -ETIMEDOUT:
992
		dprintk("RPC: %5u rpcbind request timed out\n",
993
				task->tk_pid);
994
		goto retry_timeout;
995
	case -EPFNOSUPPORT:
996
		/* server doesn't support any rpcbind version we know of */
997
		dprintk("RPC: %5u remote rpcbind service unavailable\n",
998 999 1000
				task->tk_pid);
		break;
	case -EPROTONOSUPPORT:
1001
		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1002
				task->tk_pid);
1003 1004 1005
		task->tk_status = 0;
		task->tk_action = call_bind;
		return;
1006
	default:
1007
		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1008 1009 1010 1011 1012 1013
				task->tk_pid, -task->tk_status);
	}

	rpc_exit(task, status);
	return;

1014 1015
retry_timeout:
	task->tk_action = call_timeout;
1016 1017 1018 1019
}

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

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

1030 1031 1032 1033 1034 1035
	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 已提交
1036 1037 1038 1039
	}
}

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

1048
	dprint_status(task);
1049

L
Linus Torvalds 已提交
1050 1051 1052 1053 1054 1055 1056
	task->tk_status = 0;
	if (status >= 0) {
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}

1057
	/* Something failed: remote service port may have changed */
1058
	rpc_force_rebind(clnt);
1059

L
Linus Torvalds 已提交
1060 1061 1062
	switch (status) {
	case -ENOTCONN:
	case -EAGAIN:
1063
		task->tk_action = call_bind;
1064 1065 1066 1067 1068 1069
		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 已提交
1070
	}
1071
	rpc_exit(task, -EIO);
L
Linus Torvalds 已提交
1072 1073 1074 1075 1076 1077 1078 1079
}

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

	task->tk_action = call_status;
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
	if (task->tk_status != 0)
		return;
1088
	task->tk_action = call_transmit_status;
L
Linus Torvalds 已提交
1089
	/* Encode here so that rpcsec_gss can use correct sequence number. */
1090
	if (rpc_task_need_encode(task)) {
1091
		BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
L
Linus Torvalds 已提交
1092
		call_encode(task);
1093 1094
		/* Did the encode result in an error condition? */
		if (task->tk_status != 0)
1095
			return;
1096
	}
L
Linus Torvalds 已提交
1097 1098 1099
	xprt_transmit(task);
	if (task->tk_status < 0)
		return;
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
	/*
	 * 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);
1125
	rpc_task_force_reencode(task);
L
Linus Torvalds 已提交
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
}

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

1141
	dprint_status(task);
L
Linus Torvalds 已提交
1142 1143 1144 1145 1146 1147 1148 1149 1150

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

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

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

1198
	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1199 1200
	task->tk_timeouts++;

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

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

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

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

C
Chuck Lever 已提交
1235
	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
L
Linus Torvalds 已提交
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
		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;
		}
1247 1248
		dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
				clnt->cl_protname, task->tk_status);
1249 1250
		task->tk_action = call_timeout;
		goto out_retry;
L
Linus Torvalds 已提交
1251 1252
	}

1253 1254 1255 1256 1257
	/*
	 * Ensure that we see all writes made by xprt_complete_rqst()
	 * before it changed req->rq_received.
	 */
	smp_rmb();
L
Linus Torvalds 已提交
1258 1259 1260 1261 1262 1263 1264
	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 已提交
1265 1266 1267 1268 1269
	p = call_verify(task);
	if (IS_ERR(p)) {
		if (p == ERR_PTR(-EAGAIN))
			goto out_retry;
		return;
L
Linus Torvalds 已提交
1270 1271
	}

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

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

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

	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;
1309 1310

	dprint_status(task);
L
Linus Torvalds 已提交
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328

	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
 */
1329
static __be32 *
L
Linus Torvalds 已提交
1330 1331 1332 1333
call_header(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
1334
	__be32		*p = req->rq_svec[0].iov_base;
L
Linus Torvalds 已提交
1335 1336

	/* FIXME: check buffer size? */
1337 1338

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

/*
 * Reply header verification
 */
1353
static __be32 *
L
Linus Torvalds 已提交
1354 1355 1356 1357
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;
1358 1359
	__be32	*p = iov->iov_base;
	u32 n;
L
Linus Torvalds 已提交
1360 1361
	int error = -EACCES;

1362 1363 1364 1365 1366 1367
	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
		 */
1368 1369 1370
		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);
1371 1372
		goto out_eio;
	}
L
Linus Torvalds 已提交
1373 1374 1375 1376 1377
	if ((len -= 3) < 0)
		goto out_overflow;
	p += 1;	/* skip XID */

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

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

1509
static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1510 1511 1512 1513
{
	return 0;
}

1514
static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1515 1516 1517 1518 1519 1520 1521 1522 1523
{
	return 0;
}

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

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

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

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
#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 已提交
1569 1570 1571 1572 1573 1574
			int proc;

			if (t->tk_msg.rpc_proc)
				proc = t->tk_msg.rpc_proc->p_proc;
			else
				proc = -1;
1575 1576 1577 1578 1579

			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 已提交
1580
				t->tk_pid, proc,
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
				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