sched.c 25.8 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
 * 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/spinlock.h>
A
Arjan van de Ven 已提交
20
#include <linux/mutex.h>
L
Linus Torvalds 已提交
21 22 23

#include <linux/sunrpc/clnt.h>

24 25
#include "sunrpc.h"

L
Linus Torvalds 已提交
26 27 28 29 30 31 32 33 34 35
#ifdef RPC_DEBUG
#define RPCDBG_FACILITY		RPCDBG_SCHED
#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);
43
static void __rpc_queue_timer_fn(unsigned long ptr);
L
Linus Torvalds 已提交
44 45 46 47

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

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

/*
 * 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().
 */
60
static void
61
__rpc_disable_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
62
{
63 64
	if (task->tk_timeout == 0)
		return;
65
	dprintk("RPC: %5u disabling timer\n", task->tk_pid);
L
Linus Torvalds 已提交
66
	task->tk_timeout = 0;
67
	list_del(&task->u.tk_wait.timer_list);
68 69
	if (list_empty(&queue->timer_list.list))
		del_timer(&queue->timer_list.timer);
70 71 72 73 74 75 76
}

static void
rpc_set_queue_timer(struct rpc_wait_queue *queue, unsigned long expires)
{
	queue->timer_list.expires = expires;
	mod_timer(&queue->timer_list.timer, expires);
L
Linus Torvalds 已提交
77 78 79 80 81
}

/*
 * Set up a timer for the current task.
 */
82
static void
83
__rpc_add_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
84 85 86 87
{
	if (!task->tk_timeout)
		return;

88
	dprintk("RPC: %5u setting alarm for %lu ms\n",
L
Linus Torvalds 已提交
89 90
			task->tk_pid, task->tk_timeout * 1000 / HZ);

91 92 93 94
	task->u.tk_wait.expires = jiffies + task->tk_timeout;
	if (list_empty(&queue->timer_list.list) || time_before(task->u.tk_wait.expires, queue->timer_list.expires))
		rpc_set_queue_timer(queue, task->u.tk_wait.expires);
	list_add(&task->u.tk_wait.timer_list, &queue->timer_list.list);
L
Linus Torvalds 已提交
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
}

/*
 * 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) {
110
		if (t->tk_owner == task->tk_owner) {
L
Linus Torvalds 已提交
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
			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]);
136
	task->tk_waitqueue = queue;
137
	queue->qlen++;
L
Linus Torvalds 已提交
138 139
	rpc_set_queued(task);

140 141
	dprintk("RPC: %5u added to queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
}

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

/*
 * Remove request from queue.
 * Note: must be called with spin lock held.
 */
162
static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
163
{
164
	__rpc_disable_timer(queue, task);
L
Linus Torvalds 已提交
165 166
	if (RPC_IS_PRIORITY(queue))
		__rpc_remove_wait_queue_priority(task);
167
	list_del(&task->u.tk_wait.list);
168
	queue->qlen--;
169 170
	dprintk("RPC: %5u removed from queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
171 172 173 174 175 176 177 178
}

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

179
static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
L
Linus Torvalds 已提交
180
{
181
	queue->owner = pid;
L
Linus Torvalds 已提交
182 183 184 185 186 187
	queue->nr = RPC_BATCH_COUNT;
}

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

191
static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
L
Linus Torvalds 已提交
192 193 194 195 196 197
{
	int i;

	spin_lock_init(&queue->lock);
	for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
		INIT_LIST_HEAD(&queue->tasks[i]);
198
	queue->maxpriority = nr_queues - 1;
L
Linus Torvalds 已提交
199
	rpc_reset_waitqueue_priority(queue);
200 201 202
	queue->qlen = 0;
	setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
	INIT_LIST_HEAD(&queue->timer_list.list);
L
Linus Torvalds 已提交
203 204 205 206 207 208 209
#ifdef RPC_DEBUG
	queue->name = qname;
#endif
}

void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
210
	__rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
L
Linus Torvalds 已提交
211
}
212
EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
L
Linus Torvalds 已提交
213 214 215

void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
216
	__rpc_init_priority_wait_queue(queue, qname, 1);
L
Linus Torvalds 已提交
217
}
218
EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
L
Linus Torvalds 已提交
219

220 221
void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
{
222
	del_timer_sync(&queue->timer_list.timer);
223 224 225
}
EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);

226
static int rpc_wait_bit_killable(void *word)
227
{
228
	if (fatal_signal_pending(current))
229 230 231 232 233
		return -ERESTARTSYS;
	schedule();
	return 0;
}

234 235 236 237 238 239 240 241 242 243 244 245 246
#ifdef RPC_DEBUG
static void rpc_task_set_debuginfo(struct rpc_task *task)
{
	static atomic_t rpc_pid;

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

247 248
static void rpc_set_active(struct rpc_task *task)
{
249
	struct rpc_clnt *clnt;
250 251
	if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
		return;
252
	rpc_task_set_debuginfo(task);
253
	/* Add to global list of all tasks */
254 255 256 257 258 259
	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);
	}
260 261
}

262 263 264
/*
 * Mark an RPC call as having completed by clearing the 'active' bit
 */
265
static void rpc_mark_complete_task(struct rpc_task *task)
266
{
267 268 269
	smp_mb__before_clear_bit();
	clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
	smp_mb__after_clear_bit();
270 271 272 273 274 275 276 277 278
	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)
279
		action = rpc_wait_bit_killable;
280
	return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
281
			action, TASK_KILLABLE);
282
}
283
EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
284

L
Linus Torvalds 已提交
285 286 287
/*
 * Make an RPC task runnable.
 *
288
 * Note: If the task is ASYNC, this must be called with
L
Linus Torvalds 已提交
289 290 291 292 293
 * the spinlock held to protect the wait queue operation.
 */
static void rpc_make_runnable(struct rpc_task *task)
{
	rpc_clear_queued(task);
294 295
	if (rpc_test_and_set_running(task))
		return;
L
Linus Torvalds 已提交
296 297 298
	if (RPC_IS_ASYNC(task)) {
		int status;

299
		INIT_WORK(&task->u.tk_work, rpc_async_schedule);
300
		status = queue_work(rpciod_workqueue, &task->u.tk_work);
L
Linus Torvalds 已提交
301 302 303 304 305 306
		if (status < 0) {
			printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
			task->tk_status = status;
			return;
		}
	} else
307
		wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
L
Linus Torvalds 已提交
308 309 310 311 312 313 314 315 316
}

/*
 * 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,
317
			rpc_action action)
L
Linus Torvalds 已提交
318
{
319 320
	dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
			task->tk_pid, rpc_qname(q), jiffies);
L
Linus Torvalds 已提交
321 322 323 324 325 326 327 328 329 330

	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;
331
	__rpc_add_timer(q, task);
L
Linus Torvalds 已提交
332 333 334
}

void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
335
				rpc_action action)
L
Linus Torvalds 已提交
336
{
337 338 339
	/* Mark the task as being activated if so needed */
	rpc_set_active(task);

L
Linus Torvalds 已提交
340 341 342 343
	/*
	 * Protect the queue operations.
	 */
	spin_lock_bh(&q->lock);
344
	__rpc_sleep_on(q, task, action);
L
Linus Torvalds 已提交
345 346
	spin_unlock_bh(&q->lock);
}
347
EXPORT_SYMBOL_GPL(rpc_sleep_on);
L
Linus Torvalds 已提交
348 349 350

/**
 * __rpc_do_wake_up_task - wake up a single rpc_task
351
 * @queue: wait queue
L
Linus Torvalds 已提交
352 353 354 355
 * @task: task to be woken up
 *
 * Caller must hold queue->lock, and have cleared the task queued flag.
 */
356
static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
357
{
358 359
	dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
			task->tk_pid, jiffies);
L
Linus Torvalds 已提交
360 361 362 363 364 365 366

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

367
	__rpc_remove_wait_queue(queue, task);
L
Linus Torvalds 已提交
368 369 370

	rpc_make_runnable(task);

371
	dprintk("RPC:       __rpc_wake_up_task done\n");
L
Linus Torvalds 已提交
372 373 374
}

/*
375
 * Wake up a queued task while the queue lock is being held
L
Linus Torvalds 已提交
376
 */
377
static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
378
{
379 380
	if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
		__rpc_do_wake_up_task(queue, task);
L
Linus Torvalds 已提交
381 382
}

383 384 385 386 387 388 389 390 391 392 393 394 395 396
/*
 * Tests whether rpc queue is empty
 */
int rpc_queue_empty(struct rpc_wait_queue *queue)
{
	int res;

	spin_lock_bh(&queue->lock);
	res = queue->qlen;
	spin_unlock_bh(&queue->lock);
	return (res == 0);
}
EXPORT_SYMBOL_GPL(rpc_queue_empty);

L
Linus Torvalds 已提交
397
/*
398
 * Wake up a task on a specific queue
L
Linus Torvalds 已提交
399
 */
400
void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
401
{
402
	spin_lock_bh(&queue->lock);
403
	rpc_wake_up_task_queue_locked(queue, task);
404
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
405
}
406 407 408 409 410
EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);

/*
 * Wake up the specified task
 */
411
static void rpc_wake_up_task(struct rpc_task *task)
412 413 414
{
	rpc_wake_up_queued_task(task->tk_waitqueue, task);
}
L
Linus Torvalds 已提交
415 416 417 418 419 420 421 422 423 424

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

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

	/*
	 * 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]));
461 462
new_owner:
	rpc_set_waitqueue_owner(queue, task->tk_owner);
L
Linus Torvalds 已提交
463
out:
464
	rpc_wake_up_task_queue_locked(queue, task);
L
Linus Torvalds 已提交
465 466 467 468 469 470 471 472 473 474
	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;

475 476
	dprintk("RPC:       wake_up_next(%p \"%s\")\n",
			queue, rpc_qname(queue));
477
	spin_lock_bh(&queue->lock);
L
Linus Torvalds 已提交
478 479 480 481
	if (RPC_IS_PRIORITY(queue))
		task = __rpc_wake_up_next_priority(queue);
	else {
		task_for_first(task, &queue->tasks[0])
482
			rpc_wake_up_task_queue_locked(queue, task);
L
Linus Torvalds 已提交
483
	}
484
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
485 486 487

	return task;
}
488
EXPORT_SYMBOL_GPL(rpc_wake_up_next);
L
Linus Torvalds 已提交
489 490 491 492 493 494 495 496 497

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

501
	spin_lock_bh(&queue->lock);
L
Linus Torvalds 已提交
502 503
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
504
		list_for_each_entry_safe(task, next, head, u.tk_wait.list)
505
			rpc_wake_up_task_queue_locked(queue, task);
L
Linus Torvalds 已提交
506 507 508 509
		if (head == &queue->tasks[0])
			break;
		head--;
	}
510
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
511
}
512
EXPORT_SYMBOL_GPL(rpc_wake_up);
L
Linus Torvalds 已提交
513 514 515 516 517 518 519 520 521 522

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

526
	spin_lock_bh(&queue->lock);
L
Linus Torvalds 已提交
527 528
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
529
		list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
L
Linus Torvalds 已提交
530
			task->tk_status = status;
531
			rpc_wake_up_task_queue_locked(queue, task);
L
Linus Torvalds 已提交
532 533 534 535 536
		}
		if (head == &queue->tasks[0])
			break;
		head--;
	}
537
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
538
}
539
EXPORT_SYMBOL_GPL(rpc_wake_up_status);
L
Linus Torvalds 已提交
540

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
static void __rpc_queue_timer_fn(unsigned long ptr)
{
	struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
	struct rpc_task *task, *n;
	unsigned long expires, now, timeo;

	spin_lock(&queue->lock);
	expires = now = jiffies;
	list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
		timeo = task->u.tk_wait.expires;
		if (time_after_eq(now, timeo)) {
			dprintk("RPC: %5u timeout\n", task->tk_pid);
			task->tk_status = -ETIMEDOUT;
			rpc_wake_up_task_queue_locked(queue, task);
			continue;
		}
		if (expires == now || time_after(expires, timeo))
			expires = timeo;
	}
	if (!list_empty(&queue->timer_list.list))
		rpc_set_queue_timer(queue, expires);
	spin_unlock(&queue->lock);
}

565 566
static void __rpc_atrun(struct rpc_task *task)
{
567
	task->tk_status = 0;
568 569
}

L
Linus Torvalds 已提交
570 571 572
/*
 * Run a task at a later time
 */
573
void rpc_delay(struct rpc_task *task, unsigned long delay)
L
Linus Torvalds 已提交
574 575
{
	task->tk_timeout = delay;
576
	rpc_sleep_on(&delay_queue, task, __rpc_atrun);
L
Linus Torvalds 已提交
577
}
578
EXPORT_SYMBOL_GPL(rpc_delay);
L
Linus Torvalds 已提交
579

T
Trond Myklebust 已提交
580 581 582
/*
 * Helper to call task->tk_ops->rpc_call_prepare
 */
583
void rpc_prepare_task(struct rpc_task *task)
T
Trond Myklebust 已提交
584 585 586 587
{
	task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
}

588
/*
589
 * Helper that calls task->tk_ops->rpc_call_done if it exists
590
 */
T
Trond Myklebust 已提交
591
void rpc_exit_task(struct rpc_task *task)
592
{
T
Trond Myklebust 已提交
593
	task->tk_action = NULL;
594 595
	if (task->tk_ops->rpc_call_done != NULL) {
		task->tk_ops->rpc_call_done(task, task->tk_calldata);
596
		if (task->tk_action != NULL) {
T
Trond Myklebust 已提交
597 598 599
			WARN_ON(RPC_ASSASSINATED(task));
			/* Always release the RPC slot and buffer memory */
			xprt_release(task);
600 601 602
		}
	}
}
603
EXPORT_SYMBOL_GPL(rpc_exit_task);
604

605 606
void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
{
607
	if (ops->rpc_release != NULL)
608 609 610
		ops->rpc_release(calldata);
}

L
Linus Torvalds 已提交
611 612 613
/*
 * This is the RPC `scheduler' (or rather, the finite state machine).
 */
T
Trond Myklebust 已提交
614
static void __rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
615
{
616 617 618
	struct rpc_wait_queue *queue;
	int task_is_async = RPC_IS_ASYNC(task);
	int status = 0;
L
Linus Torvalds 已提交
619

620 621
	dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
			task->tk_pid, task->tk_flags);
L
Linus Torvalds 已提交
622 623 624

	BUG_ON(RPC_IS_QUEUED(task));

625
	for (;;) {
L
Linus Torvalds 已提交
626 627 628 629

		/*
		 * Execute any pending callback.
		 */
630
		if (task->tk_callback) {
L
Linus Torvalds 已提交
631
			void (*save_callback)(struct rpc_task *);
632 633

			/*
634 635
			 * We set tk_callback to NULL before calling it,
			 * in case it sets the tk_callback field itself:
L
Linus Torvalds 已提交
636
			 */
637 638
			save_callback = task->tk_callback;
			task->tk_callback = NULL;
L
Linus Torvalds 已提交
639 640 641 642 643 644 645 646 647
			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 已提交
648
			if (task->tk_action == NULL)
L
Linus Torvalds 已提交
649
				break;
T
Trond Myklebust 已提交
650
			task->tk_action(task);
L
Linus Torvalds 已提交
651 652 653 654 655 656 657
		}

		/*
		 * Lockless check for whether task is sleeping or not.
		 */
		if (!RPC_IS_QUEUED(task))
			continue;
658 659 660 661 662 663 664 665 666 667 668 669 670
		/*
		 * The queue->lock protects against races with
		 * rpc_make_runnable().
		 *
		 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
		 * rpc_task, rpc_make_runnable() can assign it to a
		 * different workqueue. We therefore cannot assume that the
		 * rpc_task pointer may still be dereferenced.
		 */
		queue = task->tk_waitqueue;
		spin_lock_bh(&queue->lock);
		if (!RPC_IS_QUEUED(task)) {
			spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
671 672
			continue;
		}
673 674 675 676
		rpc_clear_running(task);
		spin_unlock_bh(&queue->lock);
		if (task_is_async)
			return;
L
Linus Torvalds 已提交
677 678

		/* sync task: sleep here */
679
		dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
680
		status = out_of_line_wait_on_bit(&task->tk_runstate,
681 682
				RPC_TASK_QUEUED, rpc_wait_bit_killable,
				TASK_KILLABLE);
683
		if (status == -ERESTARTSYS) {
L
Linus Torvalds 已提交
684 685 686 687 688 689
			/*
			 * 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.
			 */
690
			dprintk("RPC: %5u got signal\n", task->tk_pid);
691 692 693
			task->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(task, -ERESTARTSYS);
			rpc_wake_up_task(task);
L
Linus Torvalds 已提交
694 695
		}
		rpc_set_running(task);
696
		dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
L
Linus Torvalds 已提交
697 698
	}

699 700
	dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
			task->tk_status);
L
Linus Torvalds 已提交
701 702 703 704 705 706 707 708 709 710 711 712 713
	/* 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 已提交
714
void rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
715
{
716
	rpc_set_active(task);
L
Linus Torvalds 已提交
717
	rpc_set_running(task);
T
Trond Myklebust 已提交
718
	__rpc_execute(task);
L
Linus Torvalds 已提交
719 720
}

721
static void rpc_async_schedule(struct work_struct *work)
L
Linus Torvalds 已提交
722
{
723
	__rpc_execute(container_of(work, struct rpc_task, u.tk_work));
L
Linus Torvalds 已提交
724 725
}

726 727 728 729
/**
 * rpc_malloc - allocate an RPC buffer
 * @task: RPC task that will use this buffer
 * @size: requested byte size
L
Linus Torvalds 已提交
730
 *
731 732 733 734 735 736 737 738
 * 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 已提交
739
 * In order to avoid memory starvation triggering more writebacks of
740
 * NFS requests, we avoid using GFP_KERNEL.
L
Linus Torvalds 已提交
741
 */
742
void *rpc_malloc(struct rpc_task *task, size_t size)
L
Linus Torvalds 已提交
743
{
744
	struct rpc_buffer *buf;
745
	gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
L
Linus Torvalds 已提交
746

747
	size += sizeof(struct rpc_buffer);
748 749
	if (size <= RPC_BUFFER_MAXSIZE)
		buf = mempool_alloc(rpc_buffer_mempool, gfp);
L
Linus Torvalds 已提交
750
	else
751
		buf = kmalloc(size, gfp);
752 753 754 755

	if (!buf)
		return NULL;

756
	buf->len = size;
G
Geert Uytterhoeven 已提交
757
	dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
758
			task->tk_pid, size, buf);
759
	return &buf->data;
L
Linus Torvalds 已提交
760
}
761
EXPORT_SYMBOL_GPL(rpc_malloc);
L
Linus Torvalds 已提交
762

763 764
/**
 * rpc_free - free buffer allocated via rpc_malloc
765
 * @buffer: buffer to free
766 767
 *
 */
768
void rpc_free(void *buffer)
L
Linus Torvalds 已提交
769
{
770 771
	size_t size;
	struct rpc_buffer *buf;
772

773 774
	if (!buffer)
		return;
775 776 777

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

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

782 783 784 785
	if (size <= RPC_BUFFER_MAXSIZE)
		mempool_free(buf, rpc_buffer_mempool);
	else
		kfree(buf);
L
Linus Torvalds 已提交
786
}
787
EXPORT_SYMBOL_GPL(rpc_free);
L
Linus Torvalds 已提交
788 789 790 791

/*
 * Creation and deletion of RPC task structures
 */
792
static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
L
Linus Torvalds 已提交
793 794
{
	memset(task, 0, sizeof(*task));
795
	atomic_set(&task->tk_count, 1);
796 797 798
	task->tk_flags  = task_setup_data->flags;
	task->tk_ops = task_setup_data->callback_ops;
	task->tk_calldata = task_setup_data->callback_data;
799
	INIT_LIST_HEAD(&task->tk_task);
L
Linus Torvalds 已提交
800 801 802 803 804

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

805 806
	task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
	task->tk_owner = current->tgid;
L
Linus Torvalds 已提交
807 808

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

811 812 813 814
	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 已提交
815 816 817
			task->tk_flags |= RPC_TASK_SOFT;
	}

818 819
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
820

821
	if (task_setup_data->rpc_message != NULL) {
822 823 824
		task->tk_msg.rpc_proc = task_setup_data->rpc_message->rpc_proc;
		task->tk_msg.rpc_argp = task_setup_data->rpc_message->rpc_argp;
		task->tk_msg.rpc_resp = task_setup_data->rpc_message->rpc_resp;
825
		/* Bind the user cred */
826
		rpcauth_bindcred(task, task_setup_data->rpc_message->rpc_cred, task_setup_data->flags);
827 828 829 830
		if (task->tk_action == NULL)
			rpc_call_start(task);
	}

831
	/* starting timestamp */
832
	task->tk_start = ktime_get();
833

834
	dprintk("RPC:       new task initialized, procpid %u\n",
835
				task_pid_nr(current));
L
Linus Torvalds 已提交
836 837 838 839 840 841 842 843 844
}

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

/*
845
 * Create a new task for the specified client.
L
Linus Torvalds 已提交
846
 */
847
struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
L
Linus Torvalds 已提交
848
{
849 850 851 852 853
	struct rpc_task	*task = setup_data->task;
	unsigned short flags = 0;

	if (task == NULL) {
		task = rpc_alloc_task();
854 855 856 857 858
		if (task == NULL) {
			rpc_release_calldata(setup_data->callback_ops,
					setup_data->callback_data);
			return ERR_PTR(-ENOMEM);
		}
859 860
		flags = RPC_TASK_DYNAMIC;
	}
L
Linus Torvalds 已提交
861

862
	rpc_init_task(task, setup_data);
863 864 865 866 867
	if (task->tk_status < 0) {
		int err = task->tk_status;
		rpc_put_task(task);
		return ERR_PTR(err);
	}
L
Linus Torvalds 已提交
868

869
	task->tk_flags |= flags;
870
	dprintk("RPC:       allocated task %p\n", task);
L
Linus Torvalds 已提交
871 872 873
	return task;
}

874
static void rpc_free_task(struct rpc_task *task)
L
Linus Torvalds 已提交
875
{
876 877
	const struct rpc_call_ops *tk_ops = task->tk_ops;
	void *calldata = task->tk_calldata;
L
Linus Torvalds 已提交
878

879 880 881 882
	if (task->tk_flags & RPC_TASK_DYNAMIC) {
		dprintk("RPC: %5u freeing task\n", task->tk_pid);
		mempool_free(task, rpc_task_mempool);
	}
883 884 885 886 887 888 889 890 891 892
	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)
{
893 894 895 896 897 898 899 900 901 902 903
	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;
	}
904 905 906 907 908
	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);
909
}
910
EXPORT_SYMBOL_GPL(rpc_put_task);
911

912
static void rpc_release_task(struct rpc_task *task)
913
{
914
	dprintk("RPC: %5u release task\n", task->tk_pid);
L
Linus Torvalds 已提交
915

916
	if (!list_empty(&task->tk_task)) {
917
		struct rpc_clnt *clnt = task->tk_client;
918
		/* Remove from client task list */
919
		spin_lock(&clnt->cl_lock);
920
		list_del(&task->tk_task);
921
		spin_unlock(&clnt->cl_lock);
922
	}
L
Linus Torvalds 已提交
923 924
	BUG_ON (RPC_IS_QUEUED(task));

925 926 927 928
	/* Wake up anyone who is waiting for task completion */
	rpc_mark_complete_task(task);

	rpc_put_task(task);
L
Linus Torvalds 已提交
929 930 931 932 933 934
}

/*
 * Kill all tasks for the given client.
 * XXX: kill their descendants as well?
 */
935
void rpc_killall_tasks(struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
936 937 938 939
{
	struct rpc_task	*rovr;


940 941 942 943 944 945 946 947
	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 已提交
948 949
		if (! RPC_IS_ACTIVATED(rovr))
			continue;
950
		if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
L
Linus Torvalds 已提交
951 952 953 954 955
			rovr->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(rovr, -EIO);
			rpc_wake_up_task(rovr);
		}
	}
956
	spin_unlock(&clnt->cl_lock);
L
Linus Torvalds 已提交
957
}
958
EXPORT_SYMBOL_GPL(rpc_killall_tasks);
L
Linus Torvalds 已提交
959

960 961 962 963 964 965 966 967 968 969
int rpciod_up(void)
{
	return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
}

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

L
Linus Torvalds 已提交
970
/*
971
 * Start up the rpciod workqueue.
L
Linus Torvalds 已提交
972
 */
973
static int rpciod_start(void)
L
Linus Torvalds 已提交
974 975
{
	struct workqueue_struct *wq;
T
Trond Myklebust 已提交
976

L
Linus Torvalds 已提交
977 978 979
	/*
	 * Create the rpciod thread and wait for it to start.
	 */
T
Trond Myklebust 已提交
980
	dprintk("RPC:       creating workqueue rpciod\n");
L
Linus Torvalds 已提交
981 982
	wq = create_workqueue("rpciod");
	rpciod_workqueue = wq;
983
	return rpciod_workqueue != NULL;
L
Linus Torvalds 已提交
984 985
}

986
static void rpciod_stop(void)
L
Linus Torvalds 已提交
987
{
988
	struct workqueue_struct *wq = NULL;
T
Trond Myklebust 已提交
989

990 991
	if (rpciod_workqueue == NULL)
		return;
T
Trond Myklebust 已提交
992
	dprintk("RPC:       destroying workqueue rpciod\n");
L
Linus Torvalds 已提交
993

994 995 996
	wq = rpciod_workqueue;
	rpciod_workqueue = NULL;
	destroy_workqueue(wq);
L
Linus Torvalds 已提交
997 998 999 1000 1001
}

void
rpc_destroy_mempool(void)
{
1002
	rpciod_stop();
L
Linus Torvalds 已提交
1003 1004 1005 1006
	if (rpc_buffer_mempool)
		mempool_destroy(rpc_buffer_mempool);
	if (rpc_task_mempool)
		mempool_destroy(rpc_task_mempool);
1007 1008 1009 1010
	if (rpc_task_slabp)
		kmem_cache_destroy(rpc_task_slabp);
	if (rpc_buffer_slabp)
		kmem_cache_destroy(rpc_buffer_slabp);
1011
	rpc_destroy_wait_queue(&delay_queue);
L
Linus Torvalds 已提交
1012 1013 1014 1015 1016
}

int
rpc_init_mempool(void)
{
1017 1018 1019 1020 1021 1022 1023 1024
	/*
	 * The following is not strictly a mempool initialisation,
	 * but there is no harm in doing it here
	 */
	rpc_init_wait_queue(&delay_queue, "delayq");
	if (!rpciod_start())
		goto err_nomem;

L
Linus Torvalds 已提交
1025 1026 1027
	rpc_task_slabp = kmem_cache_create("rpc_tasks",
					     sizeof(struct rpc_task),
					     0, SLAB_HWCACHE_ALIGN,
1028
					     NULL);
L
Linus Torvalds 已提交
1029 1030 1031 1032 1033
	if (!rpc_task_slabp)
		goto err_nomem;
	rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
					     RPC_BUFFER_MAXSIZE,
					     0, SLAB_HWCACHE_ALIGN,
1034
					     NULL);
L
Linus Torvalds 已提交
1035 1036
	if (!rpc_buffer_slabp)
		goto err_nomem;
1037 1038
	rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
						    rpc_task_slabp);
L
Linus Torvalds 已提交
1039 1040
	if (!rpc_task_mempool)
		goto err_nomem;
1041 1042
	rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
						      rpc_buffer_slabp);
L
Linus Torvalds 已提交
1043 1044 1045 1046 1047 1048 1049
	if (!rpc_buffer_mempool)
		goto err_nomem;
	return 0;
err_nomem:
	rpc_destroy_mempool();
	return -ENOMEM;
}