clnt.c 25.9 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9
/*
 *  linux/net/sunrpc/rpcclnt.c
 *
 *  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.
10
 *  -	TCP connect handling.
Linus Torvalds's avatar
Linus Torvalds committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *  -	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/types.h>
#include <linux/mm.h>
Linus Torvalds's avatar
Linus Torvalds committed
28
#include <linux/slab.h>
Linus Torvalds's avatar
Linus Torvalds committed
29 30 31 32
#include <linux/in.h>
#include <linux/utsname.h>

#include <linux/sunrpc/clnt.h>
33
#include <linux/workqueue.h>
34
#include <linux/sunrpc/rpc_pipe_fs.h>
Linus Torvalds's avatar
Linus Torvalds committed
35 36 37 38

#include <linux/nfs.h>


39
#define RPC_SLACK_SPACE		(1024)	/* total overkill */
Linus Torvalds's avatar
Linus Torvalds committed
40 41 42 43 44 45 46 47

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_CALL
#endif

static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);


48
static void	call_start(struct rpc_task *task);
Linus Torvalds's avatar
Linus Torvalds committed
49 50 51 52 53 54 55 56 57 58 59
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);
static void	call_transmit(struct rpc_task *task);
static void	call_status(struct rpc_task *task);
static void	call_refresh(struct rpc_task *task);
static void	call_refreshresult(struct rpc_task *task);
static void	call_timeout(struct rpc_task *task);
60
static void	call_connect(struct rpc_task *task);
61
static void	call_connect_status(struct rpc_task *task);
Linus Torvalds's avatar
Linus Torvalds committed
62 63 64 65
static u32 *	call_header(struct rpc_task *task);
static u32 *	call_verify(struct rpc_task *task);


66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
static int
rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
{
	static uint32_t clntid;
	int error;

	if (dir_name == NULL)
		return 0;
	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;
		error = PTR_ERR(clnt->cl_dentry);
		if (error != -EEXIST) {
			printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
					clnt->cl_pathname, error);
			return error;
		}
	}
}

Linus Torvalds's avatar
Linus Torvalds committed
91 92 93 94 95 96 97 98 99
/*
 * Create an RPC client
 * FIXME: This should also take a flags argument (as in task->tk_flags).
 * It's called (among others) from pmap_create_client, which may in
 * turn be called by an async task. In this case, rpciod should not be
 * made to sleep too long.
 */
struct rpc_clnt *
rpc_create_client(struct rpc_xprt *xprt, char *servname,
100 101
		  struct rpc_program *program, u32 vers,
		  rpc_authflavor_t flavor)
Linus Torvalds's avatar
Linus Torvalds committed
102 103 104
{
	struct rpc_version	*version;
	struct rpc_clnt		*clnt = NULL;
105
	int err;
106
	int len;
Linus Torvalds's avatar
Linus Torvalds committed
107 108 109 110

	dprintk("RPC: creating %s client for %s (xprt %p)\n",
		program->name, servname, xprt);

111
	err = -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
112
	if (!xprt)
113
		goto out_err;
Linus Torvalds's avatar
Linus Torvalds committed
114
	if (vers >= program->nrvers || !(version = program->version[vers]))
115
		goto out_err;
Linus Torvalds's avatar
Linus Torvalds committed
116

117
	err = -ENOMEM;
118
	clnt = (struct rpc_clnt *) kmalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
119
	if (!clnt)
120
		goto out_err;
Linus Torvalds's avatar
Linus Torvalds committed
121 122
	memset(clnt, 0, sizeof(*clnt));
	atomic_set(&clnt->cl_users, 0);
123 124 125 126 127 128 129 130 131 132 133 134 135
	atomic_set(&clnt->cl_count, 1);
	clnt->cl_parent = clnt;

	clnt->cl_server = clnt->cl_inline_name;
	len = strlen(servname) + 1;
	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);
Linus Torvalds's avatar
Linus Torvalds committed
136 137 138 139 140

	clnt->cl_xprt     = xprt;
	clnt->cl_procinfo = version->procs;
	clnt->cl_maxproc  = version->nrprocs;
	clnt->cl_protname = program->name;
141
	clnt->cl_pmap	  = &clnt->cl_pmap_default;
Linus Torvalds's avatar
Linus Torvalds committed
142 143 144 145 146
	clnt->cl_port     = xprt->addr.sin_port;
	clnt->cl_prog     = program->number;
	clnt->cl_vers     = version->number;
	clnt->cl_prot     = xprt->prot;
	clnt->cl_stats    = program->stats;
147
	rpc_init_wait_queue(&clnt->cl_pmap_default.pm_bindwait, "bindwait");
Linus Torvalds's avatar
Linus Torvalds committed
148 149 150 151

	if (!clnt->cl_port)
		clnt->cl_autobind = 1;

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

155 156
	err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
	if (err < 0)
157
		goto out_no_path;
158

159
	err = -ENOMEM;
160 161 162
	if (!rpcauth_create(flavor, clnt)) {
		printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
				flavor);
Linus Torvalds's avatar
Linus Torvalds committed
163
		goto out_no_auth;
164
	}
Linus Torvalds's avatar
Linus Torvalds committed
165 166 167 168 169 170 171 172 173

	/* save the nodename */
	clnt->cl_nodelen = strlen(system_utsname.nodename);
	if (clnt->cl_nodelen > UNX_MAXNODENAME)
		clnt->cl_nodelen = UNX_MAXNODENAME;
	memcpy(clnt->cl_nodename, system_utsname.nodename, clnt->cl_nodelen);
	return clnt;

out_no_auth:
174 175
	rpc_rmdir(clnt->cl_pathname);
out_no_path:
176 177
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
178
	kfree(clnt);
179 180
out_err:
	return ERR_PTR(err);
Linus Torvalds's avatar
Linus Torvalds committed
181 182
}

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
/*
 * 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;

	new = (struct rpc_clnt *)kmalloc(sizeof(*new), GFP_KERNEL);
	if (!new)
		goto out_no_clnt;
	memcpy(new, clnt, sizeof(*new));
	atomic_set(&new->cl_count, 1);
	atomic_set(&new->cl_users, 0);
199 200 201 202 203 204 205 206 207
	new->cl_parent = clnt;
	atomic_inc(&clnt->cl_count);
	/* Duplicate portmapper */
	rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
	/* Turn off autobind on clones */
	new->cl_autobind = 0;
	new->cl_oneshot = 0;
	new->cl_dead = 0;
	rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
208 209 210 211 212
	if (new->cl_auth)
		atomic_inc(&new->cl_auth->au_count);
	return new;
out_no_clnt:
	printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
213
	return ERR_PTR(-ENOMEM);
214 215
}

Linus Torvalds's avatar
Linus Torvalds committed
216 217 218 219 220 221 222 223 224
/*
 * Properly shut down an RPC client, terminating all outstanding
 * requests. Note that we must be certain that cl_oneshot and
 * cl_dead are cleared, or else the client would be destroyed
 * when the last task releases it.
 */
int
rpc_shutdown_client(struct rpc_clnt *clnt)
{
225 226 227 228 229
	dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
			clnt->cl_protname, clnt->cl_server,
			atomic_read(&clnt->cl_users));

	while (atomic_read(&clnt->cl_users) > 0) {
Linus Torvalds's avatar
Linus Torvalds committed
230 231 232 233 234 235
		/* Don't let rpc_release_client destroy us */
		clnt->cl_oneshot = 0;
		clnt->cl_dead = 0;
		rpc_killall_tasks(clnt);
		sleep_on_timeout(&destroy_wait, 1*HZ);
	}
236 237 238 239 240 241 242 243 244 245

	if (atomic_read(&clnt->cl_users) < 0) {
		printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
				clnt, atomic_read(&clnt->cl_users));
#ifdef RPC_DEBUG
		rpc_show_tasks();
#endif
		BUG();
	}

Linus Torvalds's avatar
Linus Torvalds committed
246 247 248 249 250 251 252 253 254
	return rpc_destroy_client(clnt);
}

/*
 * Delete an RPC client
 */
int
rpc_destroy_client(struct rpc_clnt *clnt)
{
255 256 257 258
	if (!atomic_dec_and_test(&clnt->cl_count))
		return 1;
	BUG_ON(atomic_read(&clnt->cl_users) != 0);

Linus Torvalds's avatar
Linus Torvalds committed
259 260 261 262 263 264
	dprintk("RPC: destroying %s client for %s\n",
			clnt->cl_protname, clnt->cl_server);
	if (clnt->cl_auth) {
		rpcauth_destroy(clnt->cl_auth);
		clnt->cl_auth = NULL;
	}
265 266 267 268
	if (clnt->cl_parent != clnt) {
		rpc_destroy_client(clnt->cl_parent);
		goto out_free;
	}
269 270
	if (clnt->cl_pathname[0])
		rpc_rmdir(clnt->cl_pathname);
Linus Torvalds's avatar
Linus Torvalds committed
271 272 273 274
	if (clnt->cl_xprt) {
		xprt_destroy(clnt->cl_xprt);
		clnt->cl_xprt = NULL;
	}
275 276 277
	if (clnt->cl_server != clnt->cl_inline_name)
		kfree(clnt->cl_server);
out_free:
278
	kfree(clnt);
Linus Torvalds's avatar
Linus Torvalds committed
279 280 281 282 283 284 285 286 287 288 289 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
	return 0;
}

/*
 * Release an RPC client
 */
void
rpc_release_client(struct rpc_clnt *clnt)
{
	dprintk("RPC:      rpc_release_client(%p, %d)\n",
				clnt, atomic_read(&clnt->cl_users));

	if (!atomic_dec_and_test(&clnt->cl_users))
		return;
	wake_up(&destroy_wait);
	if (clnt->cl_oneshot || clnt->cl_dead)
		rpc_destroy_client(clnt);
}

/*
 * Default callback for async RPC calls
 */
static void
rpc_default_callback(struct rpc_task *task)
{
}

/*
 *	Export the signal mask handling for aysnchronous code that
 *	sleeps on RPC calls
 */
 
void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
{
	unsigned long	sigallow = sigmask(SIGKILL);
	unsigned long	irqflags;
	
	/* Turn off various signals */
	if (clnt->cl_intr) {
318
		struct k_sigaction *action = current->sighand->action;
Linus Torvalds's avatar
Linus Torvalds committed
319 320 321 322 323
		if (action[SIGINT-1].sa.sa_handler == SIG_DFL)
			sigallow |= sigmask(SIGINT);
		if (action[SIGQUIT-1].sa.sa_handler == SIG_DFL)
			sigallow |= sigmask(SIGQUIT);
	}
324
	spin_lock_irqsave(&current->sighand->siglock, irqflags);
Linus Torvalds's avatar
Linus Torvalds committed
325 326
	*oldset = current->blocked;
	siginitsetinv(&current->blocked, sigallow & ~oldset->sig[0]);
327
	recalc_sigpending();
328
	spin_unlock_irqrestore(&current->sighand->siglock, irqflags);
Linus Torvalds's avatar
Linus Torvalds committed
329 330 331 332 333 334
}

void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
{
	unsigned long	irqflags;
	
335
	spin_lock_irqsave(&current->sighand->siglock, irqflags);
Linus Torvalds's avatar
Linus Torvalds committed
336
	current->blocked = *oldset;
337
	recalc_sigpending();
338
	spin_unlock_irqrestore(&current->sighand->siglock, irqflags);
Linus Torvalds's avatar
Linus Torvalds committed
339 340 341 342 343 344 345
}

/*
 * New rpc_call implementation
 */
int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
{
346
	struct rpc_task	*task;
Linus Torvalds's avatar
Linus Torvalds committed
347 348 349 350 351 352 353
	sigset_t	oldset;
	int		status;

	/* If this client is slain all further I/O fails */
	if (clnt->cl_dead) 
		return -EIO;

354
	BUG_ON(flags & RPC_TASK_ASYNC);
Linus Torvalds's avatar
Linus Torvalds committed
355 356 357

	rpc_clnt_sigmask(clnt, &oldset);		

358 359 360 361 362
	status = -ENOMEM;
	task = rpc_new_task(clnt, NULL, flags);
	if (task == NULL)
		goto out;

Linus Torvalds's avatar
Linus Torvalds committed
363 364 365 366 367 368 369 370 371 372
	rpc_call_setup(task, msg, 0);

	/* Set up the call info struct and execute the task */
	if (task->tk_status == 0)
		status = rpc_execute(task);
	else {
		status = task->tk_status;
		rpc_release_task(task);
	}

373
out:
Linus Torvalds's avatar
Linus Torvalds committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
	rpc_clnt_sigunmask(clnt, &oldset);		

	return status;
}

/*
 * New rpc_call implementation
 */
int
rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
	       rpc_action callback, void *data)
{
	struct rpc_task	*task;
	sigset_t	oldset;
	int		status;

	/* If this client is slain all further I/O fails */
	if (clnt->cl_dead) 
		return -EIO;

	flags |= RPC_TASK_ASYNC;

	rpc_clnt_sigmask(clnt, &oldset);		

	/* Create/initialize a new RPC task */
	if (!callback)
		callback = rpc_default_callback;
	status = -ENOMEM;
	if (!(task = rpc_new_task(clnt, callback, flags)))
		goto out;
	task->tk_calldata = data;

	rpc_call_setup(task, msg, 0);

	/* Set up the call info struct and execute the task */
	if (task->tk_status == 0)
		status = rpc_execute(task);
	else {
		status = task->tk_status;
		rpc_release_task(task);
	}

out:
	rpc_clnt_sigunmask(clnt, &oldset);		

	return status;
}


void
rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
{
	task->tk_msg   = *msg;
	task->tk_flags |= flags;
	/* Bind the user cred */
	if (task->tk_msg.rpc_cred != NULL) {
		rpcauth_holdcred(task);
	} else
		rpcauth_bindcred(task);

	if (task->tk_status == 0)
435
		task->tk_action = call_start;
Linus Torvalds's avatar
Linus Torvalds committed
436 437 438 439
	else
		task->tk_action = NULL;
}

440 441 442 443 444 445 446 447 448 449 450
void
rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
{
	struct rpc_xprt *xprt = clnt->cl_xprt;

	xprt->sndsize = 0;
	if (sndsize)
		xprt->sndsize = sndsize + RPC_SLACK_SPACE;
	xprt->rcvsize = 0;
	if (rcvsize)
		xprt->rcvsize = rcvsize + RPC_SLACK_SPACE;
451 452
	if (xprt_connected(xprt))
		xprt_sock_setbufsize(xprt);
453 454
}

Linus Torvalds's avatar
Linus Torvalds committed
455 456 457 458 459 460 461 462 463 464
/*
 * 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;

465
	task->tk_action = call_start;
Linus Torvalds's avatar
Linus Torvalds committed
466 467 468
}

/*
469 470 471 472
 * 0.  Initial state
 *
 *     Other FSM states can be visited zero or more times, but
 *     this state is visited exactly once for each RPC.
Linus Torvalds's avatar
Linus Torvalds committed
473 474
 */
static void
475
call_start(struct rpc_task *task)
Linus Torvalds's avatar
Linus Torvalds committed
476 477 478
{
	struct rpc_clnt	*clnt = task->tk_client;

479
	dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
480
		clnt->cl_protname, clnt->cl_vers, task->tk_msg.rpc_proc->p_proc,
481 482 483
		(RPC_IS_ASYNC(task) ? "async" : "sync"));

	/* Increment call count */
484
	task->tk_msg.rpc_proc->p_count++;
485 486 487 488 489 490 491 492 493 494
	clnt->cl_stats->rpccnt++;
	task->tk_action = call_reserve;
}

/*
 * 1.	Reserve an RPC call slot
 */
static void
call_reserve(struct rpc_task *task)
{
Linus Torvalds's avatar
Linus Torvalds committed
495
	dprintk("RPC: %4d call_reserve\n", task->tk_pid);
496

Linus Torvalds's avatar
Linus Torvalds committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
	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;

	dprintk("RPC: %4d call_reserveresult (status %d)\n",
				task->tk_pid, task->tk_status);
517

Linus Torvalds's avatar
Linus Torvalds committed
518 519 520 521
	/*
	 * After a call to xprt_reserve(), we must have either
	 * a request slot or else an error status.
	 */
522 523 524 525 526 527 528 529 530 531
	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);
Linus Torvalds's avatar
Linus Torvalds committed
532 533 534
		return;
	}

535 536 537 538 539 540 541 542 543 544
	/*
	 * 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);
	}

Linus Torvalds's avatar
Linus Torvalds committed
545
	switch (status) {
546
	case -EAGAIN:	/* woken up; retry */
Linus Torvalds's avatar
Linus Torvalds committed
547
		task->tk_action = call_reserve;
548
		return;
549
	case -EIO:	/* probably a shutdown */
Linus Torvalds's avatar
Linus Torvalds committed
550 551
		break;
	default:
552 553 554
		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
				__FUNCTION__, status);
		break;
Linus Torvalds's avatar
Linus Torvalds committed
555
	}
556
	rpc_exit(task, status);
Linus Torvalds's avatar
Linus Torvalds committed
557 558 559 560 561 562 563 564 565 566 567 568 569
}

/*
 * 2.	Allocate the buffer. For details, see sched.c:rpc_malloc.
 *	(Note: buffer memory is freed in rpc_task_release).
 */
static void
call_allocate(struct rpc_task *task)
{
	unsigned int	bufsiz;

	dprintk("RPC: %4d call_allocate (status %d)\n", 
				task->tk_pid, task->tk_status);
570
	task->tk_action = call_bind;
Linus Torvalds's avatar
Linus Torvalds committed
571 572 573 574 575
	if (task->tk_buffer)
		return;

	/* FIXME: compute buffer requirements more exactly using
	 * auth->au_wslack */
576
	bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
Linus Torvalds's avatar
Linus Torvalds committed
577

578
	if (rpc_malloc(task, bufsiz << 1) != NULL)
Linus Torvalds's avatar
Linus Torvalds committed
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
		return;
	printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task); 

	if (RPC_IS_ASYNC(task) || !(task->tk_client->cl_intr && signalled())) {
		xprt_release(task);
		task->tk_action = call_reserve;
		rpc_delay(task, HZ>>4);
		return;
	}

	rpc_exit(task, -ERESTARTSYS);
}

/*
 * 3.	Encode arguments of an RPC call
 */
static void
call_encode(struct rpc_task *task)
{
	struct rpc_clnt	*clnt = task->tk_client;
	struct rpc_rqst	*req = task->tk_rqstp;
600
	struct xdr_buf *sndbuf = &req->rq_snd_buf;
601
	struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
Linus Torvalds's avatar
Linus Torvalds committed
602 603 604 605 606 607 608 609 610
	unsigned int	bufsiz;
	kxdrproc_t	encode;
	int		status;
	u32		*p;

	dprintk("RPC: %4d call_encode (status %d)\n", 
				task->tk_pid, task->tk_status);

	/* Default buffer setup */
611
	bufsiz = task->tk_bufsize >> 1;
612 613 614 615 616
	sndbuf->head[0].iov_base = (void *)task->tk_buffer;
	sndbuf->head[0].iov_len  = bufsiz;
	sndbuf->tail[0].iov_len  = 0;
	sndbuf->page_len	 = 0;
	sndbuf->len		 = 0;
617
	sndbuf->buflen		 = bufsiz;
618 619 620 621
	rcvbuf->head[0].iov_base = (void *)((char *)task->tk_buffer + bufsiz);
	rcvbuf->head[0].iov_len  = bufsiz;
	rcvbuf->tail[0].iov_len  = 0;
	rcvbuf->page_len	 = 0;
622 623
	rcvbuf->len		 = 0;
	rcvbuf->buflen		 = bufsiz;
Linus Torvalds's avatar
Linus Torvalds committed
624 625

	/* Encode header and provided arguments */
626
	encode = task->tk_msg.rpc_proc->p_encode;
Linus Torvalds's avatar
Linus Torvalds committed
627 628 629
	if (!(p = call_header(task))) {
		printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
		rpc_exit(task, -EIO);
630 631
		return;
	}
632 633
	if (encode && (status = rpcauth_wrap_req(task, encode, req, p,
						 task->tk_msg.rpc_argp)) < 0) {
Linus Torvalds's avatar
Linus Torvalds committed
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
		printk(KERN_WARNING "%s: can't encode arguments: %d\n",
				clnt->cl_protname, -status);
		rpc_exit(task, status);
	}
}

/*
 * 4.	Get the server port number if not yet set
 */
static void
call_bind(struct rpc_task *task)
{
	struct rpc_clnt	*clnt = task->tk_client;
	struct rpc_xprt *xprt = clnt->cl_xprt;

649 650 651
	dprintk("RPC: %4d call_bind xprt %p %s connected\n", task->tk_pid,
			xprt, (xprt_connected(xprt) ? "is" : "is not"));

652
	task->tk_action = (xprt_connected(xprt)) ? call_transmit : call_connect;
Linus Torvalds's avatar
Linus Torvalds committed
653 654

	if (!clnt->cl_port) {
655
		task->tk_action = call_connect;
656
		task->tk_timeout = RPC_CONNECT_TIMEOUT;
Linus Torvalds's avatar
Linus Torvalds committed
657 658 659 660 661
		rpc_getport(task, clnt);
	}
}

/*
662
 * 4a.	Connect to the RPC server (TCP case)
Linus Torvalds's avatar
Linus Torvalds committed
663 664
 */
static void
665
call_connect(struct rpc_task *task)
Linus Torvalds's avatar
Linus Torvalds committed
666 667 668
{
	struct rpc_clnt *clnt = task->tk_client;

669
	dprintk("RPC: %4d call_connect status %d\n",
Linus Torvalds's avatar
Linus Torvalds committed
670 671
				task->tk_pid, task->tk_status);

672
	if (xprt_connected(clnt->cl_xprt)) {
673
		task->tk_action = call_transmit;
Linus Torvalds's avatar
Linus Torvalds committed
674
		return;
Linus Torvalds's avatar
Linus Torvalds committed
675
	}
676 677 678 679
	task->tk_action = call_connect_status;
	if (task->tk_status < 0)
		return;
	xprt_connect(task);
Linus Torvalds's avatar
Linus Torvalds committed
680 681
}

682 683 684
/*
 * 4b. Sort out connect result
 */
685
static void
686
call_connect_status(struct rpc_task *task)
Linus Torvalds's avatar
Linus Torvalds committed
687
{
688 689 690
	struct rpc_clnt *clnt = task->tk_client;
	int status = task->tk_status;

Linus Torvalds's avatar
Linus Torvalds committed
691
	task->tk_status = 0;
692 693 694 695 696
	if (status >= 0) {
		clnt->cl_stats->netreconn++;
		task->tk_action = call_transmit;
		return;
	}
Linus Torvalds's avatar
Linus Torvalds committed
697

698 699 700 701 702 703 704 705 706 707 708 709
	/* Something failed: we may have to rebind */
	if (clnt->cl_autobind)
		clnt->cl_port = 0;
	switch (status) {
	case -ENOTCONN:
	case -ETIMEDOUT:
	case -EAGAIN:
		task->tk_action = (clnt->cl_port == 0) ? call_bind : call_connect;
		break;
	default:
		rpc_exit(task, -EIO);
	}
Linus Torvalds's avatar
Linus Torvalds committed
710 711
}

Linus Torvalds's avatar
Linus Torvalds committed
712 713 714 715 716 717 718 719 720 721
/*
 * 5.	Transmit the RPC request, and wait for reply
 */
static void
call_transmit(struct rpc_task *task)
{
	dprintk("RPC: %4d call_transmit (status %d)\n", 
				task->tk_pid, task->tk_status);

	task->tk_action = call_status;
722 723 724
	if (task->tk_status < 0)
		return;
	task->tk_status = xprt_prepare_transmit(task);
Trond Myklebust's avatar
Trond Myklebust committed
725
	if (task->tk_status != 0)
726 727
		return;
	/* Encode here so that rpcsec_gss can use correct sequence number. */
728 729
	if (!task->tk_rqstp->rq_bytes_sent)
		call_encode(task);
Linus Torvalds's avatar
Linus Torvalds committed
730 731 732
	if (task->tk_status < 0)
		return;
	xprt_transmit(task);
733 734 735
	if (task->tk_status < 0)
		return;
	if (!task->tk_msg.rpc_proc->p_decode) {
Linus Torvalds's avatar
Linus Torvalds committed
736 737 738 739 740 741 742 743 744 745 746 747
		task->tk_action = NULL;
		rpc_wake_up_task(task);
	}
}

/*
 * 6.	Sort out the RPC call status
 */
static void
call_status(struct rpc_task *task)
{
	struct rpc_clnt	*clnt = task->tk_client;
748 749 750
	struct rpc_rqst	*req = task->tk_rqstp;
	int		status;

Trond Myklebust's avatar
Trond Myklebust committed
751
	if (req->rq_received > 0 && !req->rq_bytes_sent)
752
		task->tk_status = req->rq_received;
Linus Torvalds's avatar
Linus Torvalds committed
753 754 755 756

	dprintk("RPC: %4d call_status (status %d)\n", 
				task->tk_pid, task->tk_status);

757
	status = task->tk_status;
Linus Torvalds's avatar
Linus Torvalds committed
758 759 760 761 762 763 764 765 766 767 768 769
	if (status >= 0) {
		task->tk_action = call_decode;
		return;
	}

	task->tk_status = 0;
	switch(status) {
	case -ETIMEDOUT:
		task->tk_action = call_timeout;
		break;
	case -ECONNREFUSED:
	case -ENOTCONN:
770
		req->rq_bytes_sent = 0;
771
		if (clnt->cl_autobind)
Linus Torvalds's avatar
Linus Torvalds committed
772
			clnt->cl_port = 0;
773 774
		task->tk_action = call_bind;
		break;
Linus Torvalds's avatar
Linus Torvalds committed
775 776 777
	case -EAGAIN:
		task->tk_action = call_transmit;
		break;
778 779 780 781
	case -EIO:
		/* shutdown or soft timeout */
		rpc_exit(task, status);
		break;
Linus Torvalds's avatar
Linus Torvalds committed
782 783 784 785 786
	default:
		if (clnt->cl_chatty)
			printk("%s: RPC call returned error %d\n",
			       clnt->cl_protname, -status);
		rpc_exit(task, status);
787
		break;
Linus Torvalds's avatar
Linus Torvalds committed
788 789 790 791 792 793 794 795 796 797 798 799 800
	}
}

/*
 * 6a.	Handle RPC timeout
 * 	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;

801
	if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
802 803
		dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
		goto retry;
Linus Torvalds's avatar
Linus Torvalds committed
804 805
	}

806
	dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
807
	if (RPC_IS_SOFT(task)) {
808
		if (clnt->cl_chatty)
Linus Torvalds's avatar
Linus Torvalds committed
809 810 811 812 813
			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
				clnt->cl_protname, clnt->cl_server);
		rpc_exit(task, -EIO);
		return;
	}
814

815
	if (clnt->cl_chatty && !(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds's avatar
Linus Torvalds committed
816
		task->tk_flags |= RPC_CALL_MAJORSEEN;
817 818
		printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
			clnt->cl_protname, clnt->cl_server);
Linus Torvalds's avatar
Linus Torvalds committed
819 820 821 822
	}
	if (clnt->cl_autobind)
		clnt->cl_port = 0;

823 824 825
retry:
	clnt->cl_stats->rpcretrans++;
	task->tk_action = call_bind;
Linus Torvalds's avatar
Linus Torvalds committed
826 827 828 829 830 831 832 833 834 835 836
	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;
837
	kxdrproc_t	decode = task->tk_msg.rpc_proc->p_decode;
Linus Torvalds's avatar
Linus Torvalds committed
838 839 840 841 842 843 844 845 846 847 848 849
	u32		*p;

	dprintk("RPC: %4d call_decode (status %d)\n", 
				task->tk_pid, task->tk_status);

	if (clnt->cl_chatty && (task->tk_flags & RPC_CALL_MAJORSEEN)) {
		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) {
850
		if (!RPC_IS_SOFT(task)) {
Trond Myklebust's avatar
Trond Myklebust committed
851
			task->tk_action = call_bind;
Linus Torvalds's avatar
Linus Torvalds committed
852
			clnt->cl_stats->rpcretrans++;
Trond Myklebust's avatar
Trond Myklebust committed
853
			goto out_retry;
Linus Torvalds's avatar
Linus Torvalds committed
854
		}
Trond Myklebust's avatar
Trond Myklebust committed
855 856 857
		printk(KERN_WARNING "%s: too small RPC reply size (%d bytes)\n",
			clnt->cl_protname, task->tk_status);
		rpc_exit(task, -EIO);
Linus Torvalds's avatar
Linus Torvalds committed
858 859 860
		return;
	}

861 862
	req->rq_rcv_buf.len = req->rq_private_buf.len;

863 864 865 866
	/* 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);

Linus Torvalds's avatar
Linus Torvalds committed
867
	/* Verify the RPC header */
Trond Myklebust's avatar
Trond Myklebust committed
868 869 870 871 872
	if (!(p = call_verify(task))) {
		if (task->tk_action == NULL)
			return;
		goto out_retry;
	}
Linus Torvalds's avatar
Linus Torvalds committed
873 874 875 876 877 878 879 880 881 882

	/*
	 * The following is an NFS-specific hack to cater for setuid
	 * processes whose uid is mapped to nobody on the server.
	 */
	if (task->tk_client->cl_droppriv && 
            (ntohl(*p) == NFSERR_ACCES || ntohl(*p) == NFSERR_PERM)) {
		if (RPC_IS_SETUID(task) && task->tk_suid_retry) {
			dprintk("RPC: %4d retry squashed uid\n", task->tk_pid);
			task->tk_flags ^= RPC_CALL_REALUID;
883
			task->tk_action = call_bind;
Linus Torvalds's avatar
Linus Torvalds committed
884
			task->tk_suid_retry--;
Trond Myklebust's avatar
Trond Myklebust committed
885
			goto out_retry;
Linus Torvalds's avatar
Linus Torvalds committed
886 887 888 889 890 891
		}
	}

	task->tk_action = NULL;

	if (decode)
892 893
		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
						      task->tk_msg.rpc_resp);
Linus Torvalds's avatar
Linus Torvalds committed
894 895
	dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
					task->tk_status);
Trond Myklebust's avatar
Trond Myklebust committed
896 897
	return;
out_retry:
898
	req->rq_received = req->rq_private_buf.len = 0;
Trond Myklebust's avatar
Trond Myklebust committed
899
	task->tk_status = 0;
Linus Torvalds's avatar
Linus Torvalds committed
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
}

/*
 * 8.	Refresh the credentials if rejected by the server
 */
static void
call_refresh(struct rpc_task *task)
{
	dprintk("RPC: %4d call_refresh\n", task->tk_pid);

	xprt_release(task);	/* Must do to obtain new XID */
	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)
{
923
	int status = task->tk_status;
Linus Torvalds's avatar
Linus Torvalds committed
924 925 926
	dprintk("RPC: %4d call_refreshresult (status %d)\n", 
				task->tk_pid, task->tk_status);

927 928
	task->tk_status = 0;
	task->tk_action = call_reserve;
929 930 931 932
	if (status >= 0 && rpcauth_uptodatecred(task))
		return;
	if (rpcauth_deadcred(task)) {
		rpc_exit(task, -EACCES);
933 934
		return;
	}
935 936 937 938
	task->tk_action = call_refresh;
	if (status != -ETIMEDOUT)
		rpc_delay(task, 3*HZ);
	return;
Linus Torvalds's avatar
Linus Torvalds committed
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
}

/*
 * Call header serialization
 */
static u32 *
call_header(struct rpc_task *task)
{
	struct rpc_clnt *clnt = task->tk_client;
	struct rpc_xprt *xprt = clnt->cl_xprt;
	struct rpc_rqst	*req = task->tk_rqstp;
	u32		*p = req->rq_svec[0].iov_base;

	/* FIXME: check buffer size? */
	if (xprt->stream)
		*p++ = 0;		/* fill in later */
	*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 */
960
	*p++ = htonl(task->tk_msg.rpc_proc->p_proc);	/* procedure */
Linus Torvalds's avatar
Linus Torvalds committed
961 962 963 964 965 966 967 968 969
	return rpcauth_marshcred(task, p);
}

/*
 * Reply header verification
 */
static u32 *
call_verify(struct rpc_task *task)
{
970 971 972
	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
	u32	*p = iov->iov_base, n;
Linus Torvalds's avatar
Linus Torvalds committed
973

974 975
	if ((len -= 3) < 0)
		goto garbage;
Linus Torvalds's avatar
Linus Torvalds committed
976 977 978 979 980 981 982 983 984
	p += 1;	/* skip XID */

	if ((n = ntohl(*p++)) != RPC_REPLY) {
		printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
		goto garbage;
	}
	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
		int	error = -EACCES;

985 986
		if (--len < 0)
			goto garbage;
Linus Torvalds's avatar
Linus Torvalds committed
987 988
		if ((n = ntohl(*p++)) != RPC_AUTH_ERROR) {
			printk(KERN_WARNING "call_verify: RPC call rejected: %x\n", n);
989
		} else if (--len < 0)
Linus Torvalds's avatar
Linus Torvalds committed
990 991 992
		switch ((n = ntohl(*p++))) {
		case RPC_AUTH_REJECTEDCRED:
		case RPC_AUTH_REJECTEDVERF:
993 994
		case RPCSEC_GSS_CREDPROBLEM:
		case RPCSEC_GSS_CTXPROBLEM:
Linus Torvalds's avatar
Linus Torvalds committed
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
			if (!task->tk_cred_retry)
				break;
			task->tk_cred_retry--;
			dprintk("RPC: %4d call_verify: retry stale creds\n",
							task->tk_pid);
			rpcauth_invalcred(task);
			task->tk_action = call_refresh;
			return NULL;
		case RPC_AUTH_BADCRED:
		case RPC_AUTH_BADVERF:
			/* possibly garbled cred/verf? */
			if (!task->tk_garb_retry)
				break;
			task->tk_garb_retry--;
			dprintk("RPC: %4d call_verify: retry garbled creds\n",
							task->tk_pid);
1011
			task->tk_action = call_bind;
Linus Torvalds's avatar
Linus Torvalds committed
1012 1013 1014 1015 1016 1017 1018 1019
			return NULL;
		case RPC_AUTH_TOOWEAK:
			printk(KERN_NOTICE "call_verify: server requires stronger "
			       "authentication.\n");
			break;
		default:
			printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
			error = -EIO;
1020 1021
		} else
			goto garbage;
Linus Torvalds's avatar
Linus Torvalds committed
1022 1023 1024 1025 1026 1027 1028 1029 1030
		dprintk("RPC: %4d call_verify: call rejected %d\n",
						task->tk_pid, n);
		rpc_exit(task, error);
		return NULL;
	}
	if (!(p = rpcauth_checkverf(task, p))) {
		printk(KERN_WARNING "call_verify: auth check failed\n");
		goto garbage;		/* bad verifier, retry */
	}
1031 1032 1033
	len = p - (u32 *)iov->iov_base - 1;
	if (len < 0)
		goto garbage;
Linus Torvalds's avatar
Linus Torvalds committed
1034 1035 1036
	switch ((n = ntohl(*p++))) {
	case RPC_SUCCESS:
		return p;
1037
	case RPC_PROG_UNAVAIL:
1038 1039
		printk(KERN_WARNING "RPC: call_verify: program %u is unsupported by server %s\n",
				(unsigned int)task->tk_client->cl_prog,
1040 1041 1042
				task->tk_client->cl_server);
		goto out_eio;
	case RPC_PROG_MISMATCH:
1043 1044
		printk(KERN_WARNING "RPC: call_verify: program %u, version %u unsupported by server %s\n",
				(unsigned int)task->tk_client->cl_prog,
1045 1046 1047 1048
				(unsigned int)task->tk_client->cl_vers,
				task->tk_client->cl_server);
		goto out_eio;
	case RPC_PROC_UNAVAIL:
1049 1050
		printk(KERN_WARNING "RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
				task->tk_msg.rpc_proc,
1051 1052
				task->tk_client->cl_prog,
				task->tk_client->cl_vers,
1053 1054
				task->tk_client->cl_server);
		goto out_eio;
Linus Torvalds's avatar
Linus Torvalds committed
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	case RPC_GARBAGE_ARGS:
		break;			/* retry */
	default:
		printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
		/* Also retry */
	}

garbage:
	dprintk("RPC: %4d call_verify: server saw garbage\n", task->tk_pid);
	task->tk_client->cl_stats->rpcgarbage++;
	if (task->tk_garb_retry) {
		task->tk_garb_retry--;
		dprintk(KERN_WARNING "RPC: garbage, retrying %4d\n", task->tk_pid);
1068
		task->tk_action = call_bind;
Linus Torvalds's avatar
Linus Torvalds committed
1069 1070 1071
		return NULL;
	}
	printk(KERN_WARNING "RPC: garbage, exit EIO\n");
1072
out_eio:
Linus Torvalds's avatar
Linus Torvalds committed
1073 1074 1075
	rpc_exit(task, -EIO);
	return NULL;
}