sched.c 25.7 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
static void			rpc_async_schedule(struct work_struct *);
42
static void			 rpc_release_task(struct rpc_task *task);
L
Linus Torvalds 已提交
43 44 45 46

/*
 * RPC tasks sit here while waiting for conditions to improve.
 */
47
static struct rpc_wait_queue delay_queue;
L
Linus Torvalds 已提交
48 49 50 51

/*
 * rpciod-related stuff
 */
52
struct workqueue_struct *rpciod_workqueue;
L
Linus Torvalds 已提交
53 54 55 56 57 58 59 60 61

/*
 * 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)
{
62
	dprintk("RPC: %5u disabling timer\n", task->tk_pid);
L
Linus Torvalds 已提交
63 64 65 66 67
	task->tk_timeout_fn = NULL;
	task->tk_timeout = 0;
}

/*
68
 * Default timeout handler if none specified by user
L
Linus Torvalds 已提交
69
 */
70 71
static void
__rpc_default_timer(struct rpc_task *task)
L
Linus Torvalds 已提交
72
{
73 74
	dprintk("RPC: %5u timeout (default timer)\n", task->tk_pid);
	task->tk_status = -ETIMEDOUT;
L
Linus Torvalds 已提交
75 76 77 78 79 80 81 82 83 84 85
}

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

86
	dprintk("RPC: %5u setting alarm for %lu ms\n",
L
Linus Torvalds 已提交
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
			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);
108
		dprintk("RPC: %5u deleting timer\n", task->tk_pid);
L
Linus Torvalds 已提交
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
	}
}

/*
 * 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) {
125
		if (t->tk_owner == task->tk_owner) {
L
Linus Torvalds 已提交
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
			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;
152
	queue->qlen++;
L
Linus Torvalds 已提交
153 154
	rpc_set_queued(task);

155 156
	dprintk("RPC: %5u added to queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
}

/*
 * 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);
187
	queue->qlen--;
188 189
	dprintk("RPC: %5u removed from queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
190 191 192 193 194 195 196 197
}

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

198
static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
L
Linus Torvalds 已提交
199
{
200
	queue->owner = pid;
L
Linus Torvalds 已提交
201 202 203 204 205 206
	queue->nr = RPC_BATCH_COUNT;
}

static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
{
	rpc_set_waitqueue_priority(queue, queue->maxpriority);
207
	rpc_set_waitqueue_owner(queue, 0);
L
Linus Torvalds 已提交
208 209
}

210
static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
L
Linus Torvalds 已提交
211 212 213 214 215 216
{
	int i;

	spin_lock_init(&queue->lock);
	for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
		INIT_LIST_HEAD(&queue->tasks[i]);
217
	queue->maxpriority = nr_queues - 1;
L
Linus Torvalds 已提交
218 219 220 221 222 223 224 225
	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)
{
226
	__rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
L
Linus Torvalds 已提交
227 228 229 230
}

void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
231
	__rpc_init_priority_wait_queue(queue, qname, 1);
L
Linus Torvalds 已提交
232
}
233
EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
L
Linus Torvalds 已提交
234

235
static int rpc_wait_bit_killable(void *word)
236
{
237
	if (fatal_signal_pending(current))
238 239 240 241 242
		return -ERESTARTSYS;
	schedule();
	return 0;
}

243 244 245 246 247 248 249 250 251 252 253 254 255 256
#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

257 258
static void rpc_set_active(struct rpc_task *task)
{
259
	struct rpc_clnt *clnt;
260 261
	if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
		return;
262
	rpc_task_set_debuginfo(task);
263
	/* Add to global list of all tasks */
264 265 266 267 268 269
	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);
	}
270 271
}

272 273 274
/*
 * Mark an RPC call as having completed by clearing the 'active' bit
 */
275
static void rpc_mark_complete_task(struct rpc_task *task)
276
{
277 278 279
	smp_mb__before_clear_bit();
	clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
	smp_mb__after_clear_bit();
280 281 282 283 284 285 286 287 288
	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)
289
		action = rpc_wait_bit_killable;
290
	return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
291
			action, TASK_KILLABLE);
292
}
293
EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
294

L
Linus Torvalds 已提交
295 296 297
/*
 * Make an RPC task runnable.
 *
298
 * Note: If the task is ASYNC, this must be called with
L
Linus Torvalds 已提交
299 300 301 302 303 304
 * 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);
305 306 307 308 309
	if (rpc_test_and_set_running(task))
		return;
	/* We might have raced */
	if (RPC_IS_QUEUED(task)) {
		rpc_clear_running(task);
L
Linus Torvalds 已提交
310
		return;
311
	}
L
Linus Torvalds 已提交
312 313 314
	if (RPC_IS_ASYNC(task)) {
		int status;

315
		INIT_WORK(&task->u.tk_work, rpc_async_schedule);
316
		status = queue_work(rpciod_workqueue, &task->u.tk_work);
L
Linus Torvalds 已提交
317 318 319 320 321 322
		if (status < 0) {
			printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
			task->tk_status = status;
			return;
		}
	} else
323
		wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
L
Linus Torvalds 已提交
324 325 326 327 328 329 330 331 332 333 334
}

/*
 * 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)
{
335 336
	dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
			task->tk_pid, rpc_qname(q), jiffies);
L
Linus Torvalds 已提交
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352

	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)
{
353 354 355
	/* Mark the task as being activated if so needed */
	rpc_set_active(task);

L
Linus Torvalds 已提交
356 357 358 359 360 361 362
	/*
	 * Protect the queue operations.
	 */
	spin_lock_bh(&q->lock);
	__rpc_sleep_on(q, task, action, timer);
	spin_unlock_bh(&q->lock);
}
363
EXPORT_SYMBOL_GPL(rpc_sleep_on);
L
Linus Torvalds 已提交
364 365 366 367 368 369 370 371 372

/**
 * __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)
{
373 374
	dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
			task->tk_pid, jiffies);
L
Linus Torvalds 已提交
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389

#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);

390
	dprintk("RPC:       __rpc_wake_up_task done\n");
L
Linus Torvalds 已提交
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
}

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

/*
 * Wake up the specified task
 */
void rpc_wake_up_task(struct rpc_task *task)
{
410
	rcu_read_lock_bh();
L
Linus Torvalds 已提交
411 412 413 414
	if (rpc_start_wakeup(task)) {
		if (RPC_IS_QUEUED(task)) {
			struct rpc_wait_queue *queue = task->u.tk_wait.rpc_waitq;

415 416
			/* Note: we're already in a bh-safe context */
			spin_lock(&queue->lock);
L
Linus Torvalds 已提交
417
			__rpc_do_wake_up_task(task);
418
			spin_unlock(&queue->lock);
L
Linus Torvalds 已提交
419 420 421
		}
		rpc_finish_wakeup(task);
	}
422
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
423
}
424
EXPORT_SYMBOL_GPL(rpc_wake_up_task);
L
Linus Torvalds 已提交
425 426 427 428 429 430 431 432 433 434

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

	/*
435
	 * Service a batch of tasks from a single owner.
L
Linus Torvalds 已提交
436 437 438 439
	 */
	q = &queue->tasks[queue->priority];
	if (!list_empty(q)) {
		task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
440
		if (queue->owner == task->tk_owner) {
L
Linus Torvalds 已提交
441 442 443 444 445 446 447 448
			if (--queue->nr)
				goto out;
			list_move_tail(&task->u.tk_wait.list, q);
		}
		/*
		 * Check if we need to switch queues.
		 */
		if (--queue->count)
449
			goto new_owner;
L
Linus Torvalds 已提交
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
	}

	/*
	 * 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]));
471 472
new_owner:
	rpc_set_waitqueue_owner(queue, task->tk_owner);
L
Linus Torvalds 已提交
473 474 475 476 477 478 479 480 481 482 483 484
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;

485 486
	dprintk("RPC:       wake_up_next(%p \"%s\")\n",
			queue, rpc_qname(queue));
487 488
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
489 490 491 492 493 494
	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);
	}
495 496
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
497 498 499

	return task;
}
500
EXPORT_SYMBOL_GPL(rpc_wake_up_next);
L
Linus Torvalds 已提交
501 502 503 504 505 506 507 508 509

/**
 * 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)
{
510
	struct rpc_task *task, *next;
L
Linus Torvalds 已提交
511
	struct list_head *head;
512

513 514
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
515 516
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
517
		list_for_each_entry_safe(task, next, head, u.tk_wait.list)
L
Linus Torvalds 已提交
518 519 520 521 522
			__rpc_wake_up_task(task);
		if (head == &queue->tasks[0])
			break;
		head--;
	}
523 524
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
525
}
526
EXPORT_SYMBOL_GPL(rpc_wake_up);
L
Linus Torvalds 已提交
527 528 529 530 531 532 533 534 535 536

/**
 * 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)
{
537
	struct rpc_task *task, *next;
L
Linus Torvalds 已提交
538 539
	struct list_head *head;

540 541
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
542 543
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
544
		list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
L
Linus Torvalds 已提交
545 546 547 548 549 550 551
			task->tk_status = status;
			__rpc_wake_up_task(task);
		}
		if (head == &queue->tasks[0])
			break;
		head--;
	}
552 553
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
554
}
555
EXPORT_SYMBOL_GPL(rpc_wake_up_status);
L
Linus Torvalds 已提交
556

557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
/*
 * Run a timeout function.
 */
static void rpc_run_timer(unsigned long ptr)
{
	struct rpc_task *task = (struct rpc_task *)ptr;
	void (*callback)(struct rpc_task *);

	if (!rpc_start_wakeup(task))
		goto out;
	if (RPC_IS_QUEUED(task)) {
		struct rpc_wait_queue *queue = task->u.tk_wait.rpc_waitq;
		callback = task->tk_timeout_fn;

		dprintk("RPC: %5u running timer\n", task->tk_pid);
		if (callback != NULL)
			callback(task);
		/* Note: we're already in a bh-safe context */
		spin_lock(&queue->lock);
		__rpc_do_wake_up_task(task);
		spin_unlock(&queue->lock);
	}
	rpc_finish_wakeup(task);
out:
	smp_mb__before_clear_bit();
	clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
	smp_mb__after_clear_bit();
}

586 587 588 589
static void __rpc_atrun(struct rpc_task *task)
{
}

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

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

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

629 630 631 632 633 634 635 636 637
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 已提交
638 639 640
/*
 * This is the RPC `scheduler' (or rather, the finite state machine).
 */
T
Trond Myklebust 已提交
641
static void __rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
642 643 644
{
	int		status = 0;

645 646
	dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
			task->tk_pid, task->tk_flags);
L
Linus Torvalds 已提交
647 648 649

	BUG_ON(RPC_IS_QUEUED(task));

650
	for (;;) {
L
Linus Torvalds 已提交
651 652 653 654 655 656 657 658 659 660 661
		/*
		 * 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 *);
662 663

			/*
L
Linus Torvalds 已提交
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
			 * 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 已提交
681
			if (task->tk_action == NULL)
L
Linus Torvalds 已提交
682
				break;
T
Trond Myklebust 已提交
683
			task->tk_action(task);
L
Linus Torvalds 已提交
684 685 686 687 688 689 690 691 692 693 694
		}

		/*
		 * 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 已提交
695
				return;
L
Linus Torvalds 已提交
696
			if (rpc_test_and_set_running(task))
T
Trond Myklebust 已提交
697
				return;
L
Linus Torvalds 已提交
698 699 700 701
			continue;
		}

		/* sync task: sleep here */
702
		dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
703
		status = out_of_line_wait_on_bit(&task->tk_runstate,
704 705
				RPC_TASK_QUEUED, rpc_wait_bit_killable,
				TASK_KILLABLE);
706
		if (status == -ERESTARTSYS) {
L
Linus Torvalds 已提交
707 708 709 710 711 712
			/*
			 * 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.
			 */
713
			dprintk("RPC: %5u got signal\n", task->tk_pid);
714 715 716
			task->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(task, -ERESTARTSYS);
			rpc_wake_up_task(task);
L
Linus Torvalds 已提交
717 718
		}
		rpc_set_running(task);
719
		dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
L
Linus Torvalds 已提交
720 721
	}

722 723
	dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
			task->tk_status);
L
Linus Torvalds 已提交
724 725 726 727 728 729 730 731 732 733 734 735 736
	/* 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 已提交
737
void rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
738
{
739
	rpc_set_active(task);
L
Linus Torvalds 已提交
740
	rpc_set_running(task);
T
Trond Myklebust 已提交
741
	__rpc_execute(task);
L
Linus Torvalds 已提交
742 743
}

744
static void rpc_async_schedule(struct work_struct *work)
L
Linus Torvalds 已提交
745
{
746
	__rpc_execute(container_of(work, struct rpc_task, u.tk_work));
L
Linus Torvalds 已提交
747 748
}

749 750 751 752 753
struct rpc_buffer {
	size_t	len;
	char	data[];
};

754 755 756 757
/**
 * rpc_malloc - allocate an RPC buffer
 * @task: RPC task that will use this buffer
 * @size: requested byte size
L
Linus Torvalds 已提交
758
 *
759 760 761 762 763 764 765 766
 * 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 已提交
767
 * In order to avoid memory starvation triggering more writebacks of
768
 * NFS requests, we avoid using GFP_KERNEL.
L
Linus Torvalds 已提交
769
 */
770
void *rpc_malloc(struct rpc_task *task, size_t size)
L
Linus Torvalds 已提交
771
{
772
	struct rpc_buffer *buf;
773
	gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
L
Linus Torvalds 已提交
774

775
	size += sizeof(struct rpc_buffer);
776 777
	if (size <= RPC_BUFFER_MAXSIZE)
		buf = mempool_alloc(rpc_buffer_mempool, gfp);
L
Linus Torvalds 已提交
778
	else
779
		buf = kmalloc(size, gfp);
780 781 782 783

	if (!buf)
		return NULL;

784
	buf->len = size;
G
Geert Uytterhoeven 已提交
785
	dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
786
			task->tk_pid, size, buf);
787
	return &buf->data;
L
Linus Torvalds 已提交
788
}
789
EXPORT_SYMBOL_GPL(rpc_malloc);
L
Linus Torvalds 已提交
790

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

801 802
	if (!buffer)
		return;
803 804 805

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

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

810 811 812 813
	if (size <= RPC_BUFFER_MAXSIZE)
		mempool_free(buf, rpc_buffer_mempool);
	else
		kfree(buf);
L
Linus Torvalds 已提交
814
}
815
EXPORT_SYMBOL_GPL(rpc_free);
L
Linus Torvalds 已提交
816 817 818 819

/*
 * Creation and deletion of RPC task structures
 */
820
static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
L
Linus Torvalds 已提交
821 822
{
	memset(task, 0, sizeof(*task));
823
	setup_timer(&task->tk_timer, rpc_run_timer, (unsigned long)task);
824
	atomic_set(&task->tk_count, 1);
825 826 827
	task->tk_flags  = task_setup_data->flags;
	task->tk_ops = task_setup_data->callback_ops;
	task->tk_calldata = task_setup_data->callback_data;
828
	INIT_LIST_HEAD(&task->tk_task);
L
Linus Torvalds 已提交
829 830 831 832 833

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

834 835
	task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
	task->tk_owner = current->tgid;
L
Linus Torvalds 已提交
836 837

	/* Initialize workqueue for async tasks */
838
	task->tk_workqueue = task_setup_data->workqueue;
L
Linus Torvalds 已提交
839

840 841 842 843
	task->tk_client = task_setup_data->rpc_client;
	if (task->tk_client != NULL) {
		kref_get(&task->tk_client->cl_kref);
		if (task->tk_client->cl_softrtry)
L
Linus Torvalds 已提交
844 845 846
			task->tk_flags |= RPC_TASK_SOFT;
	}

847 848
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
849

850 851 852 853 854 855 856 857 858 859 860
	if (task_setup_data->rpc_message != NULL) {
		memcpy(&task->tk_msg, task_setup_data->rpc_message, sizeof(task->tk_msg));
		/* Bind the user cred */
		if (task->tk_msg.rpc_cred != NULL)
			rpcauth_holdcred(task);
		else
			rpcauth_bindcred(task);
		if (task->tk_action == NULL)
			rpc_call_start(task);
	}

861 862 863
	/* starting timestamp */
	task->tk_start = jiffies;

864
	dprintk("RPC:       new task initialized, procpid %u\n",
865
				task_pid_nr(current));
L
Linus Torvalds 已提交
866 867 868 869 870 871 872 873
}

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

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

/*
882
 * Create a new task for the specified client.
L
Linus Torvalds 已提交
883
 */
884
struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
L
Linus Torvalds 已提交
885
{
886 887 888 889 890 891 892 893 894
	struct rpc_task	*task = setup_data->task;
	unsigned short flags = 0;

	if (task == NULL) {
		task = rpc_alloc_task();
		if (task == NULL)
			goto out;
		flags = RPC_TASK_DYNAMIC;
	}
L
Linus Torvalds 已提交
895

896
	rpc_init_task(task, setup_data);
L
Linus Torvalds 已提交
897

898
	task->tk_flags |= flags;
899
	dprintk("RPC:       allocated task %p\n", task);
L
Linus Torvalds 已提交
900 901 902 903
out:
	return task;
}

904
static void rpc_free_task(struct rpc_task *task)
L
Linus Torvalds 已提交
905
{
906 907
	const struct rpc_call_ops *tk_ops = task->tk_ops;
	void *calldata = task->tk_calldata;
L
Linus Torvalds 已提交
908

909 910 911 912 913 914 915 916 917 918 919 920
	if (task->tk_flags & RPC_TASK_DYNAMIC)
		call_rcu_bh(&task->u.tk_rcu, rpc_free_task_rcu);
	rpc_release_calldata(tk_ops, calldata);
}

static void rpc_async_release(struct work_struct *work)
{
	rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
}

void rpc_put_task(struct rpc_task *task)
{
921 922 923 924 925 926 927 928 929 930 931
	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;
	}
932 933 934 935 936
	if (task->tk_workqueue != NULL) {
		INIT_WORK(&task->u.tk_work, rpc_async_release);
		queue_work(task->tk_workqueue, &task->u.tk_work);
	} else
		rpc_free_task(task);
937
}
938
EXPORT_SYMBOL_GPL(rpc_put_task);
939

940
static void rpc_release_task(struct rpc_task *task)
941
{
L
Linus Torvalds 已提交
942 943 944
#ifdef RPC_DEBUG
	BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
#endif
945
	dprintk("RPC: %5u release task\n", task->tk_pid);
L
Linus Torvalds 已提交
946

947
	if (!list_empty(&task->tk_task)) {
948
		struct rpc_clnt *clnt = task->tk_client;
949
		/* Remove from client task list */
950
		spin_lock(&clnt->cl_lock);
951
		list_del(&task->tk_task);
952
		spin_unlock(&clnt->cl_lock);
953
	}
L
Linus Torvalds 已提交
954 955 956 957 958 959 960 961
	BUG_ON (RPC_IS_QUEUED(task));

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

#ifdef RPC_DEBUG
	task->tk_magic = 0;
#endif
962 963 964 965
	/* Wake up anyone who is waiting for task completion */
	rpc_mark_complete_task(task);

	rpc_put_task(task);
L
Linus Torvalds 已提交
966 967 968 969 970 971
}

/*
 * Kill all tasks for the given client.
 * XXX: kill their descendants as well?
 */
972
void rpc_killall_tasks(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
973 974 975 976
{
	struct rpc_task	*rovr;


977 978 979 980 981 982 983 984
	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 已提交
985 986
		if (! RPC_IS_ACTIVATED(rovr))
			continue;
987
		if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
L
Linus Torvalds 已提交
988 989 990 991 992
			rovr->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(rovr, -EIO);
			rpc_wake_up_task(rovr);
		}
	}
993
	spin_unlock(&clnt->cl_lock);
L
Linus Torvalds 已提交
994
}
995
EXPORT_SYMBOL_GPL(rpc_killall_tasks);
L
Linus Torvalds 已提交
996

997 998 999 1000 1001 1002 1003 1004 1005 1006
int rpciod_up(void)
{
	return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
}

void rpciod_down(void)
{
	module_put(THIS_MODULE);
}

L
Linus Torvalds 已提交
1007
/*
1008
 * Start up the rpciod workqueue.
L
Linus Torvalds 已提交
1009
 */
1010
static int rpciod_start(void)
L
Linus Torvalds 已提交
1011 1012
{
	struct workqueue_struct *wq;
T
Trond Myklebust 已提交
1013

L
Linus Torvalds 已提交
1014 1015 1016
	/*
	 * Create the rpciod thread and wait for it to start.
	 */
T
Trond Myklebust 已提交
1017
	dprintk("RPC:       creating workqueue rpciod\n");
L
Linus Torvalds 已提交
1018 1019
	wq = create_workqueue("rpciod");
	rpciod_workqueue = wq;
1020
	return rpciod_workqueue != NULL;
L
Linus Torvalds 已提交
1021 1022
}

1023
static void rpciod_stop(void)
L
Linus Torvalds 已提交
1024
{
1025
	struct workqueue_struct *wq = NULL;
T
Trond Myklebust 已提交
1026

1027 1028
	if (rpciod_workqueue == NULL)
		return;
T
Trond Myklebust 已提交
1029
	dprintk("RPC:       destroying workqueue rpciod\n");
L
Linus Torvalds 已提交
1030

1031 1032 1033
	wq = rpciod_workqueue;
	rpciod_workqueue = NULL;
	destroy_workqueue(wq);
L
Linus Torvalds 已提交
1034 1035 1036 1037 1038
}

void
rpc_destroy_mempool(void)
{
1039
	rpciod_stop();
L
Linus Torvalds 已提交
1040 1041 1042 1043
	if (rpc_buffer_mempool)
		mempool_destroy(rpc_buffer_mempool);
	if (rpc_task_mempool)
		mempool_destroy(rpc_task_mempool);
1044 1045 1046 1047
	if (rpc_task_slabp)
		kmem_cache_destroy(rpc_task_slabp);
	if (rpc_buffer_slabp)
		kmem_cache_destroy(rpc_buffer_slabp);
L
Linus Torvalds 已提交
1048 1049 1050 1051 1052 1053 1054 1055
}

int
rpc_init_mempool(void)
{
	rpc_task_slabp = kmem_cache_create("rpc_tasks",
					     sizeof(struct rpc_task),
					     0, SLAB_HWCACHE_ALIGN,
1056
					     NULL);
L
Linus Torvalds 已提交
1057 1058 1059 1060 1061
	if (!rpc_task_slabp)
		goto err_nomem;
	rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
					     RPC_BUFFER_MAXSIZE,
					     0, SLAB_HWCACHE_ALIGN,
1062
					     NULL);
L
Linus Torvalds 已提交
1063 1064
	if (!rpc_buffer_slabp)
		goto err_nomem;
1065 1066
	rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
						    rpc_task_slabp);
L
Linus Torvalds 已提交
1067 1068
	if (!rpc_task_mempool)
		goto err_nomem;
1069 1070
	rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
						      rpc_buffer_slabp);
L
Linus Torvalds 已提交
1071 1072
	if (!rpc_buffer_mempool)
		goto err_nomem;
1073 1074
	if (!rpciod_start())
		goto err_nomem;
1075 1076 1077 1078 1079
	/*
	 * The following is not strictly a mempool initialisation,
	 * but there is no harm in doing it here
	 */
	rpc_init_wait_queue(&delay_queue, "delayq");
L
Linus Torvalds 已提交
1080 1081 1082 1083 1084
	return 0;
err_nomem:
	rpc_destroy_mempool();
	return -ENOMEM;
}