sched.c 28.3 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6
/*
 * linux/net/sunrpc/sched.c
 *
 * Scheduling for synchronous and asynchronous RPC requests.
 *
 * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
7
 *
L
Linus Torvalds 已提交
8 9 10 11 12 13 14 15 16 17 18 19 20
 * TCP NFS related read + write fixes
 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
 */

#include <linux/module.h>

#include <linux/sched.h>
#include <linux/interrupt.h>
#include <linux/slab.h>
#include <linux/mempool.h>
#include <linux/smp.h>
#include <linux/smp_lock.h>
#include <linux/spinlock.h>
A
Arjan van de Ven 已提交
21
#include <linux/mutex.h>
L
Linus Torvalds 已提交
22 23 24 25 26 27 28 29 30 31 32 33 34 35

#include <linux/sunrpc/clnt.h>

#ifdef RPC_DEBUG
#define RPCDBG_FACILITY		RPCDBG_SCHED
#define RPC_TASK_MAGIC_ID	0xf00baa
#endif

/*
 * RPC slabs and memory pools
 */
#define RPC_BUFFER_MAXSIZE	(2048)
#define RPC_BUFFER_POOLSIZE	(8)
#define RPC_TASK_POOLSIZE	(8)
36 37
static struct kmem_cache	*rpc_task_slabp __read_mostly;
static struct kmem_cache	*rpc_buffer_slabp __read_mostly;
38 39
static mempool_t	*rpc_task_mempool __read_mostly;
static mempool_t	*rpc_buffer_mempool __read_mostly;
L
Linus Torvalds 已提交
40 41 42

static void			__rpc_default_timer(struct rpc_task *task);
static void			rpciod_killall(void);
43
static void			rpc_async_schedule(struct work_struct *);
44
static void			 rpc_release_task(struct rpc_task *task);
L
Linus Torvalds 已提交
45 46 47 48 49 50 51

/*
 * RPC tasks sit here while waiting for conditions to improve.
 */
static RPC_WAITQ(delay_queue, "delayq");

/*
52
 * All RPC clients are linked into this list
L
Linus Torvalds 已提交
53
 */
54 55
static LIST_HEAD(all_clients);
static DECLARE_WAIT_QUEUE_HEAD(client_kill_wait);
L
Linus Torvalds 已提交
56 57 58 59

/*
 * rpciod-related stuff
 */
A
Arjan van de Ven 已提交
60
static DEFINE_MUTEX(rpciod_mutex);
L
Linus Torvalds 已提交
61
static unsigned int		rpciod_users;
62
struct workqueue_struct *rpciod_workqueue;
L
Linus Torvalds 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76

/*
 * Spinlock for other critical sections of code.
 */
static DEFINE_SPINLOCK(rpc_sched_lock);

/*
 * Disable the timer for a given RPC task. Should be called with
 * queue->lock and bh_disabled in order to avoid races within
 * rpc_run_timer().
 */
static inline void
__rpc_disable_timer(struct rpc_task *task)
{
77
	dprintk("RPC: %5u disabling timer\n", task->tk_pid);
L
Linus Torvalds 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
	task->tk_timeout_fn = NULL;
	task->tk_timeout = 0;
}

/*
 * Run a timeout function.
 * We use the callback in order to allow __rpc_wake_up_task()
 * and friends to disable the timer synchronously on SMP systems
 * without calling del_timer_sync(). The latter could cause a
 * deadlock if called while we're holding spinlocks...
 */
static void rpc_run_timer(struct rpc_task *task)
{
	void (*callback)(struct rpc_task *);

	callback = task->tk_timeout_fn;
	task->tk_timeout_fn = NULL;
	if (callback && RPC_IS_QUEUED(task)) {
96
		dprintk("RPC: %5u running timer\n", task->tk_pid);
L
Linus Torvalds 已提交
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
		callback(task);
	}
	smp_mb__before_clear_bit();
	clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
	smp_mb__after_clear_bit();
}

/*
 * Set up a timer for the current task.
 */
static inline void
__rpc_add_timer(struct rpc_task *task, rpc_action timer)
{
	if (!task->tk_timeout)
		return;

113
	dprintk("RPC: %5u setting alarm for %lu ms\n",
L
Linus Torvalds 已提交
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
			task->tk_pid, task->tk_timeout * 1000 / HZ);

	if (timer)
		task->tk_timeout_fn = timer;
	else
		task->tk_timeout_fn = __rpc_default_timer;
	set_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
	mod_timer(&task->tk_timer, jiffies + task->tk_timeout);
}

/*
 * Delete any timer for the current task. Because we use del_timer_sync(),
 * this function should never be called while holding queue->lock.
 */
static void
rpc_delete_timer(struct rpc_task *task)
{
	if (RPC_IS_QUEUED(task))
		return;
	if (test_and_clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate)) {
		del_singleshot_timer_sync(&task->tk_timer);
135
		dprintk("RPC: %5u deleting timer\n", task->tk_pid);
L
Linus Torvalds 已提交
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
	}
}

/*
 * Add new request to a priority queue.
 */
static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue, struct rpc_task *task)
{
	struct list_head *q;
	struct rpc_task *t;

	INIT_LIST_HEAD(&task->u.tk_wait.links);
	q = &queue->tasks[task->tk_priority];
	if (unlikely(task->tk_priority > queue->maxpriority))
		q = &queue->tasks[queue->maxpriority];
	list_for_each_entry(t, q, u.tk_wait.list) {
		if (t->tk_cookie == task->tk_cookie) {
			list_add_tail(&task->u.tk_wait.list, &t->u.tk_wait.links);
			return;
		}
	}
	list_add_tail(&task->u.tk_wait.list, q);
}

/*
 * Add new request to wait queue.
 *
 * Swapper tasks always get inserted at the head of the queue.
 * This should avoid many nasty memory deadlocks and hopefully
 * improve overall performance.
 * Everyone else gets appended to the queue to ensure proper FIFO behavior.
 */
static void __rpc_add_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
{
	BUG_ON (RPC_IS_QUEUED(task));

	if (RPC_IS_PRIORITY(queue))
		__rpc_add_wait_queue_priority(queue, task);
	else if (RPC_IS_SWAPPER(task))
		list_add(&task->u.tk_wait.list, &queue->tasks[0]);
	else
		list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
	task->u.tk_wait.rpc_waitq = queue;
179
	queue->qlen++;
L
Linus Torvalds 已提交
180 181
	rpc_set_queued(task);

182 183
	dprintk("RPC: %5u added to queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
}

/*
 * Remove request from a priority queue.
 */
static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
{
	struct rpc_task *t;

	if (!list_empty(&task->u.tk_wait.links)) {
		t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
		list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
		list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
	}
	list_del(&task->u.tk_wait.list);
}

/*
 * Remove request from queue.
 * Note: must be called with spin lock held.
 */
static void __rpc_remove_wait_queue(struct rpc_task *task)
{
	struct rpc_wait_queue *queue;
	queue = task->u.tk_wait.rpc_waitq;

	if (RPC_IS_PRIORITY(queue))
		__rpc_remove_wait_queue_priority(task);
	else
		list_del(&task->u.tk_wait.list);
214
	queue->qlen--;
215 216
	dprintk("RPC: %5u removed from queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
}

static inline void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
{
	queue->priority = priority;
	queue->count = 1 << (priority * 2);
}

static inline void rpc_set_waitqueue_cookie(struct rpc_wait_queue *queue, unsigned long cookie)
{
	queue->cookie = cookie;
	queue->nr = RPC_BATCH_COUNT;
}

static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
{
	rpc_set_waitqueue_priority(queue, queue->maxpriority);
	rpc_set_waitqueue_cookie(queue, 0);
}

static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, int maxprio)
{
	int i;

	spin_lock_init(&queue->lock);
	for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
		INIT_LIST_HEAD(&queue->tasks[i]);
	queue->maxpriority = maxprio;
	rpc_reset_waitqueue_priority(queue);
#ifdef RPC_DEBUG
	queue->name = qname;
#endif
}

void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
	__rpc_init_priority_wait_queue(queue, qname, RPC_PRIORITY_HIGH);
}

void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
	__rpc_init_priority_wait_queue(queue, qname, 0);
}
EXPORT_SYMBOL(rpc_init_wait_queue);

262 263 264 265 266 267 268 269
static int rpc_wait_bit_interruptible(void *word)
{
	if (signal_pending(current))
		return -ERESTARTSYS;
	schedule();
	return 0;
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283
#ifdef RPC_DEBUG
static void rpc_task_set_debuginfo(struct rpc_task *task)
{
	static atomic_t rpc_pid;

	task->tk_magic = RPC_TASK_MAGIC_ID;
	task->tk_pid = atomic_inc_return(&rpc_pid);
}
#else
static inline void rpc_task_set_debuginfo(struct rpc_task *task)
{
}
#endif

284 285
static void rpc_set_active(struct rpc_task *task)
{
286
	struct rpc_clnt *clnt;
287 288
	if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
		return;
289
	rpc_task_set_debuginfo(task);
290
	/* Add to global list of all tasks */
291 292 293 294 295 296
	clnt = task->tk_client;
	if (clnt != NULL) {
		spin_lock(&clnt->cl_lock);
		list_add_tail(&task->tk_task, &clnt->cl_tasks);
		spin_unlock(&clnt->cl_lock);
	}
297 298
}

299 300 301
/*
 * Mark an RPC call as having completed by clearing the 'active' bit
 */
302
static void rpc_mark_complete_task(struct rpc_task *task)
303
{
304 305 306
	smp_mb__before_clear_bit();
	clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
	smp_mb__after_clear_bit();
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
	wake_up_bit(&task->tk_runstate, RPC_TASK_ACTIVE);
}

/*
 * Allow callers to wait for completion of an RPC call
 */
int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
{
	if (action == NULL)
		action = rpc_wait_bit_interruptible;
	return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
			action, TASK_INTERRUPTIBLE);
}
EXPORT_SYMBOL(__rpc_wait_for_completion_task);

L
Linus Torvalds 已提交
322 323 324
/*
 * Make an RPC task runnable.
 *
325
 * Note: If the task is ASYNC, this must be called with
L
Linus Torvalds 已提交
326 327 328 329 330 331
 * the spinlock held to protect the wait queue operation.
 */
static void rpc_make_runnable(struct rpc_task *task)
{
	BUG_ON(task->tk_timeout_fn);
	rpc_clear_queued(task);
332 333 334 335 336
	if (rpc_test_and_set_running(task))
		return;
	/* We might have raced */
	if (RPC_IS_QUEUED(task)) {
		rpc_clear_running(task);
L
Linus Torvalds 已提交
337
		return;
338
	}
L
Linus Torvalds 已提交
339 340 341
	if (RPC_IS_ASYNC(task)) {
		int status;

342
		INIT_WORK(&task->u.tk_work, rpc_async_schedule);
L
Linus Torvalds 已提交
343 344 345 346 347 348 349
		status = queue_work(task->tk_workqueue, &task->u.tk_work);
		if (status < 0) {
			printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
			task->tk_status = status;
			return;
		}
	} else
350
		wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
L
Linus Torvalds 已提交
351 352 353 354 355 356 357 358 359 360 361
}

/*
 * Prepare for sleeping on a wait queue.
 * By always appending tasks to the list we ensure FIFO behavior.
 * NB: An RPC task will only receive interrupt-driven events as long
 * as it's on a wait queue.
 */
static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
			rpc_action action, rpc_action timer)
{
362 363
	dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
			task->tk_pid, rpc_qname(q), jiffies);
L
Linus Torvalds 已提交
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379

	if (!RPC_IS_ASYNC(task) && !RPC_IS_ACTIVATED(task)) {
		printk(KERN_ERR "RPC: Inactive synchronous task put to sleep!\n");
		return;
	}

	__rpc_add_wait_queue(q, task);

	BUG_ON(task->tk_callback != NULL);
	task->tk_callback = action;
	__rpc_add_timer(task, timer);
}

void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
				rpc_action action, rpc_action timer)
{
380 381 382
	/* Mark the task as being activated if so needed */
	rpc_set_active(task);

L
Linus Torvalds 已提交
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
	/*
	 * Protect the queue operations.
	 */
	spin_lock_bh(&q->lock);
	__rpc_sleep_on(q, task, action, timer);
	spin_unlock_bh(&q->lock);
}

/**
 * __rpc_do_wake_up_task - wake up a single rpc_task
 * @task: task to be woken up
 *
 * Caller must hold queue->lock, and have cleared the task queued flag.
 */
static void __rpc_do_wake_up_task(struct rpc_task *task)
{
399 400
	dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
			task->tk_pid, jiffies);
L
Linus Torvalds 已提交
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415

#ifdef RPC_DEBUG
	BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
#endif
	/* Has the task been executed yet? If not, we cannot wake it up! */
	if (!RPC_IS_ACTIVATED(task)) {
		printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
		return;
	}

	__rpc_disable_timer(task);
	__rpc_remove_wait_queue(task);

	rpc_make_runnable(task);

416
	dprintk("RPC:       __rpc_wake_up_task done\n");
L
Linus Torvalds 已提交
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
}

/*
 * Wake up the specified task
 */
static void __rpc_wake_up_task(struct rpc_task *task)
{
	if (rpc_start_wakeup(task)) {
		if (RPC_IS_QUEUED(task))
			__rpc_do_wake_up_task(task);
		rpc_finish_wakeup(task);
	}
}

/*
 * Default timeout handler if none specified by user
 */
static void
__rpc_default_timer(struct rpc_task *task)
{
437
	dprintk("RPC: %5u timeout (default timer)\n", task->tk_pid);
L
Linus Torvalds 已提交
438 439 440 441 442 443 444 445 446
	task->tk_status = -ETIMEDOUT;
	rpc_wake_up_task(task);
}

/*
 * Wake up the specified task
 */
void rpc_wake_up_task(struct rpc_task *task)
{
447
	rcu_read_lock_bh();
L
Linus Torvalds 已提交
448 449 450 451
	if (rpc_start_wakeup(task)) {
		if (RPC_IS_QUEUED(task)) {
			struct rpc_wait_queue *queue = task->u.tk_wait.rpc_waitq;

452 453
			/* Note: we're already in a bh-safe context */
			spin_lock(&queue->lock);
L
Linus Torvalds 已提交
454
			__rpc_do_wake_up_task(task);
455
			spin_unlock(&queue->lock);
L
Linus Torvalds 已提交
456 457 458
		}
		rpc_finish_wakeup(task);
	}
459
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
}

/*
 * Wake up the next task on a priority queue.
 */
static struct rpc_task * __rpc_wake_up_next_priority(struct rpc_wait_queue *queue)
{
	struct list_head *q;
	struct rpc_task *task;

	/*
	 * Service a batch of tasks from a single cookie.
	 */
	q = &queue->tasks[queue->priority];
	if (!list_empty(q)) {
		task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
		if (queue->cookie == task->tk_cookie) {
			if (--queue->nr)
				goto out;
			list_move_tail(&task->u.tk_wait.list, q);
		}
		/*
		 * Check if we need to switch queues.
		 */
		if (--queue->count)
			goto new_cookie;
	}

	/*
	 * Service the next queue.
	 */
	do {
		if (q == &queue->tasks[0])
			q = &queue->tasks[queue->maxpriority];
		else
			q = q - 1;
		if (!list_empty(q)) {
			task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
			goto new_queue;
		}
	} while (q != &queue->tasks[queue->priority]);

	rpc_reset_waitqueue_priority(queue);
	return NULL;

new_queue:
	rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
new_cookie:
	rpc_set_waitqueue_cookie(queue, task->tk_cookie);
out:
	__rpc_wake_up_task(task);
	return task;
}

/*
 * Wake up the next task on the wait queue.
 */
struct rpc_task * rpc_wake_up_next(struct rpc_wait_queue *queue)
{
	struct rpc_task	*task = NULL;

521 522
	dprintk("RPC:       wake_up_next(%p \"%s\")\n",
			queue, rpc_qname(queue));
523 524
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
525 526 527 528 529 530
	if (RPC_IS_PRIORITY(queue))
		task = __rpc_wake_up_next_priority(queue);
	else {
		task_for_first(task, &queue->tasks[0])
			__rpc_wake_up_task(task);
	}
531 532
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
533 534 535 536 537 538 539 540 541 542 543 544

	return task;
}

/**
 * rpc_wake_up - wake up all rpc_tasks
 * @queue: rpc_wait_queue on which the tasks are sleeping
 *
 * Grabs queue->lock
 */
void rpc_wake_up(struct rpc_wait_queue *queue)
{
545
	struct rpc_task *task, *next;
L
Linus Torvalds 已提交
546
	struct list_head *head;
547

548 549
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
550 551
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
552
		list_for_each_entry_safe(task, next, head, u.tk_wait.list)
L
Linus Torvalds 已提交
553 554 555 556 557
			__rpc_wake_up_task(task);
		if (head == &queue->tasks[0])
			break;
		head--;
	}
558 559
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
560 561 562 563 564 565 566 567 568 569 570
}

/**
 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
 * @queue: rpc_wait_queue on which the tasks are sleeping
 * @status: status value to set
 *
 * Grabs queue->lock
 */
void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
{
571
	struct rpc_task *task, *next;
L
Linus Torvalds 已提交
572 573
	struct list_head *head;

574 575
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
576 577
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
578
		list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
L
Linus Torvalds 已提交
579 580 581 582 583 584 585
			task->tk_status = status;
			__rpc_wake_up_task(task);
		}
		if (head == &queue->tasks[0])
			break;
		head--;
	}
586 587
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
588 589
}

590 591 592 593 594
static void __rpc_atrun(struct rpc_task *task)
{
	rpc_wake_up_task(task);
}

L
Linus Torvalds 已提交
595 596 597
/*
 * Run a task at a later time
 */
598
void rpc_delay(struct rpc_task *task, unsigned long delay)
L
Linus Torvalds 已提交
599 600 601 602 603
{
	task->tk_timeout = delay;
	rpc_sleep_on(&delay_queue, task, NULL, __rpc_atrun);
}

T
Trond Myklebust 已提交
604 605 606 607 608
/*
 * Helper to call task->tk_ops->rpc_call_prepare
 */
static void rpc_prepare_task(struct rpc_task *task)
{
609
	lock_kernel();
T
Trond Myklebust 已提交
610
	task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
611
	unlock_kernel();
T
Trond Myklebust 已提交
612 613
}

614
/*
615
 * Helper that calls task->tk_ops->rpc_call_done if it exists
616
 */
T
Trond Myklebust 已提交
617
void rpc_exit_task(struct rpc_task *task)
618
{
T
Trond Myklebust 已提交
619
	task->tk_action = NULL;
620
	if (task->tk_ops->rpc_call_done != NULL) {
621
		lock_kernel();
622
		task->tk_ops->rpc_call_done(task, task->tk_calldata);
623
		unlock_kernel();
624
		if (task->tk_action != NULL) {
T
Trond Myklebust 已提交
625 626 627
			WARN_ON(RPC_ASSASSINATED(task));
			/* Always release the RPC slot and buffer memory */
			xprt_release(task);
628 629 630
		}
	}
}
T
Trond Myklebust 已提交
631
EXPORT_SYMBOL(rpc_exit_task);
632

633 634 635 636 637 638 639 640 641
void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
{
	if (ops->rpc_release != NULL) {
		lock_kernel();
		ops->rpc_release(calldata);
		unlock_kernel();
	}
}

L
Linus Torvalds 已提交
642 643 644
/*
 * This is the RPC `scheduler' (or rather, the finite state machine).
 */
T
Trond Myklebust 已提交
645
static void __rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
646 647 648
{
	int		status = 0;

649 650
	dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
			task->tk_pid, task->tk_flags);
L
Linus Torvalds 已提交
651 652 653

	BUG_ON(RPC_IS_QUEUED(task));

654
	for (;;) {
L
Linus Torvalds 已提交
655 656 657 658 659 660 661 662 663 664 665
		/*
		 * Garbage collection of pending timers...
		 */
		rpc_delete_timer(task);

		/*
		 * Execute any pending callback.
		 */
		if (RPC_DO_CALLBACK(task)) {
			/* Define a callback save pointer */
			void (*save_callback)(struct rpc_task *);
666 667

			/*
L
Linus Torvalds 已提交
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
			 * If a callback exists, save it, reset it,
			 * call it.
			 * The save is needed to stop from resetting
			 * another callback set within the callback handler
			 * - Dave
			 */
			save_callback=task->tk_callback;
			task->tk_callback=NULL;
			save_callback(task);
		}

		/*
		 * Perform the next FSM step.
		 * tk_action may be NULL when the task has been killed
		 * by someone else.
		 */
		if (!RPC_IS_QUEUED(task)) {
T
Trond Myklebust 已提交
685
			if (task->tk_action == NULL)
L
Linus Torvalds 已提交
686
				break;
T
Trond Myklebust 已提交
687
			task->tk_action(task);
L
Linus Torvalds 已提交
688 689 690 691 692 693 694 695 696 697 698
		}

		/*
		 * Lockless check for whether task is sleeping or not.
		 */
		if (!RPC_IS_QUEUED(task))
			continue;
		rpc_clear_running(task);
		if (RPC_IS_ASYNC(task)) {
			/* Careful! we may have raced... */
			if (RPC_IS_QUEUED(task))
T
Trond Myklebust 已提交
699
				return;
L
Linus Torvalds 已提交
700
			if (rpc_test_and_set_running(task))
T
Trond Myklebust 已提交
701
				return;
L
Linus Torvalds 已提交
702 703 704 705
			continue;
		}

		/* sync task: sleep here */
706
		dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
707 708 709 710 711
		/* Note: Caller should be using rpc_clnt_sigmask() */
		status = out_of_line_wait_on_bit(&task->tk_runstate,
				RPC_TASK_QUEUED, rpc_wait_bit_interruptible,
				TASK_INTERRUPTIBLE);
		if (status == -ERESTARTSYS) {
L
Linus Torvalds 已提交
712 713 714 715 716 717
			/*
			 * When a sync task receives a signal, it exits with
			 * -ERESTARTSYS. In order to catch any callbacks that
			 * clean up after sleeping on some queue, we don't
			 * break the loop here, but go around once more.
			 */
718
			dprintk("RPC: %5u got signal\n", task->tk_pid);
719 720 721
			task->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(task, -ERESTARTSYS);
			rpc_wake_up_task(task);
L
Linus Torvalds 已提交
722 723
		}
		rpc_set_running(task);
724
		dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
L
Linus Torvalds 已提交
725 726
	}

727 728
	dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
			task->tk_status);
L
Linus Torvalds 已提交
729 730 731 732 733 734 735 736 737 738 739 740 741
	/* Release all resources associated with the task */
	rpc_release_task(task);
}

/*
 * User-visible entry point to the scheduler.
 *
 * This may be called recursively if e.g. an async NFS task updates
 * the attributes and finds that dirty pages must be flushed.
 * NOTE: Upon exit of this function the task is guaranteed to be
 *	 released. In particular note that tk_release() will have
 *	 been called, so your task memory may have been freed.
 */
T
Trond Myklebust 已提交
742
void rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
743
{
744
	rpc_set_active(task);
L
Linus Torvalds 已提交
745
	rpc_set_running(task);
T
Trond Myklebust 已提交
746
	__rpc_execute(task);
L
Linus Torvalds 已提交
747 748
}

749
static void rpc_async_schedule(struct work_struct *work)
L
Linus Torvalds 已提交
750
{
751
	__rpc_execute(container_of(work, struct rpc_task, u.tk_work));
L
Linus Torvalds 已提交
752 753
}

754 755 756 757 758
struct rpc_buffer {
	size_t	len;
	char	data[];
};

759 760 761 762
/**
 * rpc_malloc - allocate an RPC buffer
 * @task: RPC task that will use this buffer
 * @size: requested byte size
L
Linus Torvalds 已提交
763
 *
764 765 766 767 768 769 770 771
 * To prevent rpciod from hanging, this allocator never sleeps,
 * returning NULL if the request cannot be serviced immediately.
 * The caller can arrange to sleep in a way that is safe for rpciod.
 *
 * Most requests are 'small' (under 2KiB) and can be serviced from a
 * mempool, ensuring that NFS reads and writes can always proceed,
 * and that there is good locality of reference for these buffers.
 *
L
Linus Torvalds 已提交
772
 * In order to avoid memory starvation triggering more writebacks of
773
 * NFS requests, we avoid using GFP_KERNEL.
L
Linus Torvalds 已提交
774
 */
775
void *rpc_malloc(struct rpc_task *task, size_t size)
L
Linus Torvalds 已提交
776
{
777
	struct rpc_buffer *buf;
778
	gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
L
Linus Torvalds 已提交
779

780
	size += sizeof(struct rpc_buffer);
781 782
	if (size <= RPC_BUFFER_MAXSIZE)
		buf = mempool_alloc(rpc_buffer_mempool, gfp);
L
Linus Torvalds 已提交
783
	else
784
		buf = kmalloc(size, gfp);
785 786 787 788

	if (!buf)
		return NULL;

789
	buf->len = size;
G
Geert Uytterhoeven 已提交
790
	dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
791
			task->tk_pid, size, buf);
792
	return &buf->data;
L
Linus Torvalds 已提交
793 794
}

795 796
/**
 * rpc_free - free buffer allocated via rpc_malloc
797
 * @buffer: buffer to free
798 799
 *
 */
800
void rpc_free(void *buffer)
L
Linus Torvalds 已提交
801
{
802 803
	size_t size;
	struct rpc_buffer *buf;
804

805 806
	if (!buffer)
		return;
807 808 809

	buf = container_of(buffer, struct rpc_buffer, data);
	size = buf->len;
810

G
Geert Uytterhoeven 已提交
811
	dprintk("RPC:       freeing buffer of size %zu at %p\n",
812
			size, buf);
813

814 815 816 817
	if (size <= RPC_BUFFER_MAXSIZE)
		mempool_free(buf, rpc_buffer_mempool);
	else
		kfree(buf);
L
Linus Torvalds 已提交
818 819 820 821 822
}

/*
 * Creation and deletion of RPC task structures
 */
823
void rpc_init_task(struct rpc_task *task, struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
L
Linus Torvalds 已提交
824 825 826 827 828
{
	memset(task, 0, sizeof(*task));
	init_timer(&task->tk_timer);
	task->tk_timer.data     = (unsigned long) task;
	task->tk_timer.function = (void (*)(unsigned long)) rpc_run_timer;
829
	atomic_set(&task->tk_count, 1);
L
Linus Torvalds 已提交
830 831
	task->tk_client = clnt;
	task->tk_flags  = flags;
832
	task->tk_ops = tk_ops;
T
Trond Myklebust 已提交
833 834
	if (tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
835
	task->tk_calldata = calldata;
836
	INIT_LIST_HEAD(&task->tk_task);
L
Linus Torvalds 已提交
837 838 839 840 841 842 843 844 845 846 847 848

	/* Initialize retry counters */
	task->tk_garb_retry = 2;
	task->tk_cred_retry = 2;

	task->tk_priority = RPC_PRIORITY_NORMAL;
	task->tk_cookie = (unsigned long)current;

	/* Initialize workqueue for async tasks */
	task->tk_workqueue = rpciod_workqueue;

	if (clnt) {
849
		kref_get(&clnt->cl_kref);
L
Linus Torvalds 已提交
850 851 852 853 854 855
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
		if (!clnt->cl_intr)
			task->tk_flags |= RPC_TASK_NOINTR;
	}

856 857
	BUG_ON(task->tk_ops == NULL);

858 859 860
	/* starting timestamp */
	task->tk_start = jiffies;

861
	dprintk("RPC:       new task initialized, procpid %u\n",
L
Linus Torvalds 已提交
862 863 864 865 866 867 868 869 870
				current->pid);
}

static struct rpc_task *
rpc_alloc_task(void)
{
	return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
}

871
static void rpc_free_task(struct rcu_head *rcu)
L
Linus Torvalds 已提交
872
{
873
	struct rpc_task *task = container_of(rcu, struct rpc_task, u.tk_rcu);
874
	dprintk("RPC: %5u freeing task\n", task->tk_pid);
L
Linus Torvalds 已提交
875 876 877 878 879 880 881 882
	mempool_free(task, rpc_task_mempool);
}

/*
 * Create a new task for the specified client.  We have to
 * clean up after an allocation failure, as the client may
 * have specified "oneshot".
 */
883
struct rpc_task *rpc_new_task(struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
L
Linus Torvalds 已提交
884 885 886 887 888 889 890
{
	struct rpc_task	*task;

	task = rpc_alloc_task();
	if (!task)
		goto cleanup;

891
	rpc_init_task(task, clnt, flags, tk_ops, calldata);
L
Linus Torvalds 已提交
892

893
	dprintk("RPC:       allocated task %p\n", task);
L
Linus Torvalds 已提交
894 895 896 897 898 899 900
	task->tk_flags |= RPC_TASK_DYNAMIC;
out:
	return task;

cleanup:
	/* Check whether to release the client */
	if (clnt) {
901
		kref_get(&clnt->cl_kref); /* pretend we were used ... */
L
Linus Torvalds 已提交
902 903 904 905 906
		rpc_release_client(clnt);
	}
	goto out;
}

907 908

void rpc_put_task(struct rpc_task *task)
L
Linus Torvalds 已提交
909
{
910 911
	const struct rpc_call_ops *tk_ops = task->tk_ops;
	void *calldata = task->tk_calldata;
L
Linus Torvalds 已提交
912

913 914 915 916 917 918 919 920 921 922 923 924
	if (!atomic_dec_and_test(&task->tk_count))
		return;
	/* Release resources */
	if (task->tk_rqstp)
		xprt_release(task);
	if (task->tk_msg.rpc_cred)
		rpcauth_unbindcred(task);
	if (task->tk_client) {
		rpc_release_client(task->tk_client);
		task->tk_client = NULL;
	}
	if (task->tk_flags & RPC_TASK_DYNAMIC)
925
		call_rcu_bh(&task->u.tk_rcu, rpc_free_task);
926
	rpc_release_calldata(tk_ops, calldata);
927 928 929
}
EXPORT_SYMBOL(rpc_put_task);

930
static void rpc_release_task(struct rpc_task *task)
931
{
L
Linus Torvalds 已提交
932 933 934
#ifdef RPC_DEBUG
	BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
#endif
935
	dprintk("RPC: %5u release task\n", task->tk_pid);
L
Linus Torvalds 已提交
936

937
	if (!list_empty(&task->tk_task)) {
938
		struct rpc_clnt *clnt = task->tk_client;
939
		/* Remove from client task list */
940
		spin_lock(&clnt->cl_lock);
941
		list_del(&task->tk_task);
942
		spin_unlock(&clnt->cl_lock);
943
	}
L
Linus Torvalds 已提交
944 945 946 947 948 949 950 951
	BUG_ON (RPC_IS_QUEUED(task));

	/* Synchronously delete any running timer */
	rpc_delete_timer(task);

#ifdef RPC_DEBUG
	task->tk_magic = 0;
#endif
952 953 954 955
	/* Wake up anyone who is waiting for task completion */
	rpc_mark_complete_task(task);

	rpc_put_task(task);
L
Linus Torvalds 已提交
956 957
}

958 959
/**
 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
960 961 962 963
 * @clnt: pointer to RPC client
 * @flags: RPC flags
 * @ops: RPC call ops
 * @data: user call data
964 965 966 967 968 969 970
 */
struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
					const struct rpc_call_ops *ops,
					void *data)
{
	struct rpc_task *task;
	task = rpc_new_task(clnt, flags, ops, data);
971
	if (task == NULL) {
972
		rpc_release_calldata(ops, data);
973
		return ERR_PTR(-ENOMEM);
974
	}
975 976 977 978 979 980
	atomic_inc(&task->tk_count);
	rpc_execute(task);
	return task;
}
EXPORT_SYMBOL(rpc_run_task);

L
Linus Torvalds 已提交
981 982 983 984
/*
 * Kill all tasks for the given client.
 * XXX: kill their descendants as well?
 */
985
void rpc_killall_tasks(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
986 987 988 989
{
	struct rpc_task	*rovr;


990 991 992 993 994 995 996 997
	if (list_empty(&clnt->cl_tasks))
		return;
	dprintk("RPC:       killing all tasks for client %p\n", clnt);
	/*
	 * Spin lock all_tasks to prevent changes...
	 */
	spin_lock(&clnt->cl_lock);
	list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
L
Linus Torvalds 已提交
998 999
		if (! RPC_IS_ACTIVATED(rovr))
			continue;
1000
		if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
L
Linus Torvalds 已提交
1001 1002 1003 1004 1005
			rovr->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(rovr, -EIO);
			rpc_wake_up_task(rovr);
		}
	}
1006
	spin_unlock(&clnt->cl_lock);
L
Linus Torvalds 已提交
1007 1008 1009 1010
}

static void rpciod_killall(void)
{
1011
	struct rpc_clnt *clnt;
L
Linus Torvalds 已提交
1012 1013
	unsigned long flags;

1014
	for(;;) {
L
Linus Torvalds 已提交
1015
		clear_thread_flag(TIF_SIGPENDING);
1016 1017 1018

		spin_lock(&rpc_sched_lock);
		list_for_each_entry(clnt, &all_clients, cl_clients)
1019
			rpc_killall_tasks(clnt);
1020
		spin_unlock(&rpc_sched_lock);
L
Linus Torvalds 已提交
1021
		flush_workqueue(rpciod_workqueue);
1022 1023 1024
		if (!list_empty(&all_clients))
			break;
		dprintk("RPC:       rpciod_killall: waiting for tasks "
1025
					"to exit\n");
1026 1027
		wait_event_timeout(client_kill_wait,
				list_empty(&all_clients), 1*HZ);
L
Linus Torvalds 已提交
1028 1029 1030 1031 1032 1033 1034
	}

	spin_lock_irqsave(&current->sighand->siglock, flags);
	recalc_sigpending();
	spin_unlock_irqrestore(&current->sighand->siglock, flags);
}

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
void rpc_register_client(struct rpc_clnt *clnt)
{
	spin_lock(&rpc_sched_lock);
	list_add(&clnt->cl_clients, &all_clients);
	spin_unlock(&rpc_sched_lock);
}

void rpc_unregister_client(struct rpc_clnt *clnt)
{
	spin_lock(&rpc_sched_lock);
	list_del(&clnt->cl_clients);
	if (list_empty(&all_clients))
		wake_up(&client_kill_wait);
	spin_unlock(&rpc_sched_lock);
}

L
Linus Torvalds 已提交
1051 1052 1053 1054 1055 1056 1057 1058 1059
/*
 * Start up the rpciod process if it's not already running.
 */
int
rpciod_up(void)
{
	struct workqueue_struct *wq;
	int error = 0;

A
Arjan van de Ven 已提交
1060
	mutex_lock(&rpciod_mutex);
1061
	dprintk("RPC:       rpciod_up: users %u\n", rpciod_users);
L
Linus Torvalds 已提交
1062 1063 1064 1065 1066 1067 1068
	rpciod_users++;
	if (rpciod_workqueue)
		goto out;
	/*
	 * If there's no pid, we should be the first user.
	 */
	if (rpciod_users > 1)
1069
		printk(KERN_WARNING "rpciod_up: no workqueue, %u users??\n", rpciod_users);
L
Linus Torvalds 已提交
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
	/*
	 * Create the rpciod thread and wait for it to start.
	 */
	error = -ENOMEM;
	wq = create_workqueue("rpciod");
	if (wq == NULL) {
		printk(KERN_WARNING "rpciod_up: create workqueue failed, error=%d\n", error);
		rpciod_users--;
		goto out;
	}
	rpciod_workqueue = wq;
	error = 0;
out:
A
Arjan van de Ven 已提交
1083
	mutex_unlock(&rpciod_mutex);
L
Linus Torvalds 已提交
1084 1085 1086 1087 1088 1089
	return error;
}

void
rpciod_down(void)
{
A
Arjan van de Ven 已提交
1090
	mutex_lock(&rpciod_mutex);
1091
	dprintk("RPC:       rpciod_down sema %u\n", rpciod_users);
L
Linus Torvalds 已提交
1092 1093 1094 1095 1096 1097 1098
	if (rpciod_users) {
		if (--rpciod_users)
			goto out;
	} else
		printk(KERN_WARNING "rpciod_down: no users??\n");

	if (!rpciod_workqueue) {
1099
		dprintk("RPC:       rpciod_down: Nothing to do!\n");
L
Linus Torvalds 已提交
1100 1101 1102 1103 1104 1105 1106
		goto out;
	}
	rpciod_killall();

	destroy_workqueue(rpciod_workqueue);
	rpciod_workqueue = NULL;
 out:
A
Arjan van de Ven 已提交
1107
	mutex_unlock(&rpciod_mutex);
L
Linus Torvalds 已提交
1108 1109 1110 1111 1112
}

#ifdef RPC_DEBUG
void rpc_show_tasks(void)
{
1113
	struct rpc_clnt *clnt;
L
Linus Torvalds 已提交
1114 1115 1116
	struct rpc_task *t;

	spin_lock(&rpc_sched_lock);
1117 1118
	if (list_empty(&all_clients))
		goto out;
L
Linus Torvalds 已提交
1119
	printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1120
		"-rpcwait -action- ---ops--\n");
1121
	list_for_each_entry(clnt, &all_clients, cl_clients) {
1122 1123 1124
		if (list_empty(&clnt->cl_tasks))
			continue;
		spin_lock(&clnt->cl_lock);
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
		list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
			const char *rpc_waitq = "none";

			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",
				t->tk_pid,
				(t->tk_msg.rpc_proc ? t->tk_msg.rpc_proc->p_proc : -1),
				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);
		}
1141
		spin_unlock(&clnt->cl_lock);
L
Linus Torvalds 已提交
1142
	}
1143
out:
L
Linus Torvalds 已提交
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
	spin_unlock(&rpc_sched_lock);
}
#endif

void
rpc_destroy_mempool(void)
{
	if (rpc_buffer_mempool)
		mempool_destroy(rpc_buffer_mempool);
	if (rpc_task_mempool)
		mempool_destroy(rpc_task_mempool);
1155 1156 1157 1158
	if (rpc_task_slabp)
		kmem_cache_destroy(rpc_task_slabp);
	if (rpc_buffer_slabp)
		kmem_cache_destroy(rpc_buffer_slabp);
L
Linus Torvalds 已提交
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
}

int
rpc_init_mempool(void)
{
	rpc_task_slabp = kmem_cache_create("rpc_tasks",
					     sizeof(struct rpc_task),
					     0, SLAB_HWCACHE_ALIGN,
					     NULL, NULL);
	if (!rpc_task_slabp)
		goto err_nomem;
	rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
					     RPC_BUFFER_MAXSIZE,
					     0, SLAB_HWCACHE_ALIGN,
					     NULL, NULL);
	if (!rpc_buffer_slabp)
		goto err_nomem;
1176 1177
	rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
						    rpc_task_slabp);
L
Linus Torvalds 已提交
1178 1179
	if (!rpc_task_mempool)
		goto err_nomem;
1180 1181
	rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
						      rpc_buffer_slabp);
L
Linus Torvalds 已提交
1182 1183 1184 1185 1186 1187 1188
	if (!rpc_buffer_mempool)
		goto err_nomem;
	return 0;
err_nomem:
	rpc_destroy_mempool();
	return -ENOMEM;
}