sched.c 28.9 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>
21
#include <linux/freezer.h>
L
Linus Torvalds 已提交
22 23 24

#include <linux/sunrpc/clnt.h>

25 26
#include "sunrpc.h"

L
Linus Torvalds 已提交
27 28 29 30
#ifdef RPC_DEBUG
#define RPCDBG_FACILITY		RPCDBG_SCHED
#endif

31 32 33
#define CREATE_TRACE_POINTS
#include <trace/events/sunrpc.h>

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

45
static void			rpc_async_schedule(struct work_struct *);
46
static void			 rpc_release_task(struct rpc_task *task);
47
static void __rpc_queue_timer_fn(unsigned long ptr);
L
Linus Torvalds 已提交
48 49 50 51

/*
 * RPC tasks sit here while waiting for conditions to improve.
 */
52
static struct rpc_wait_queue delay_queue;
L
Linus Torvalds 已提交
53 54 55 56

/*
 * rpciod-related stuff
 */
57
struct workqueue_struct *rpciod_workqueue;
L
Linus Torvalds 已提交
58 59 60 61 62 63

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

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 已提交
81 82 83 84 85
}

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

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

95 96 97 98
	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 已提交
99 100
}

101 102 103 104 105 106 107 108 109 110 111 112
static void rpc_rotate_queue_owner(struct rpc_wait_queue *queue)
{
	struct list_head *q = &queue->tasks[queue->priority];
	struct rpc_task *task;

	if (!list_empty(q)) {
		task = list_first_entry(q, struct rpc_task, u.tk_wait.list);
		if (task->tk_owner == queue->owner)
			list_move_tail(&task->u.tk_wait.list, q);
	}
}

113 114
static void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
{
115 116 117 118 119
	if (queue->priority != priority) {
		/* Fairness: rotate the list when changing priority */
		rpc_rotate_queue_owner(queue);
		queue->priority = priority;
	}
120 121 122 123 124 125 126 127 128 129 130 131 132 133
}

static void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
{
	queue->owner = pid;
	queue->nr = RPC_BATCH_COUNT;
}

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

L
Linus Torvalds 已提交
134 135 136
/*
 * Add new request to a priority queue.
 */
137 138 139
static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue,
		struct rpc_task *task,
		unsigned char queue_priority)
L
Linus Torvalds 已提交
140 141 142 143 144
{
	struct list_head *q;
	struct rpc_task *t;

	INIT_LIST_HEAD(&task->u.tk_wait.links);
145
	if (unlikely(queue_priority > queue->maxpriority))
146 147 148 149
		queue_priority = queue->maxpriority;
	if (queue_priority > queue->priority)
		rpc_set_waitqueue_priority(queue, queue_priority);
	q = &queue->tasks[queue_priority];
L
Linus Torvalds 已提交
150
	list_for_each_entry(t, q, u.tk_wait.list) {
151
		if (t->tk_owner == task->tk_owner) {
L
Linus Torvalds 已提交
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
			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.
 */
167 168 169
static void __rpc_add_wait_queue(struct rpc_wait_queue *queue,
		struct rpc_task *task,
		unsigned char queue_priority)
L
Linus Torvalds 已提交
170
{
171 172 173
	WARN_ON_ONCE(RPC_IS_QUEUED(task));
	if (RPC_IS_QUEUED(task))
		return;
L
Linus Torvalds 已提交
174 175

	if (RPC_IS_PRIORITY(queue))
176
		__rpc_add_wait_queue_priority(queue, task, queue_priority);
L
Linus Torvalds 已提交
177 178 179 180
	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]);
181
	task->tk_waitqueue = queue;
182
	queue->qlen++;
183 184
	/* barrier matches the read in rpc_wake_up_task_queue_locked() */
	smp_wmb();
L
Linus Torvalds 已提交
185 186
	rpc_set_queued(task);

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

/*
 * 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.
 */
209
static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
210
{
211
	__rpc_disable_timer(queue, task);
L
Linus Torvalds 已提交
212 213
	if (RPC_IS_PRIORITY(queue))
		__rpc_remove_wait_queue_priority(task);
214
	list_del(&task->u.tk_wait.list);
215
	queue->qlen--;
216 217
	dprintk("RPC: %5u removed from queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
218 219
}

220
static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
L
Linus Torvalds 已提交
221 222 223 224 225 226
{
	int i;

	spin_lock_init(&queue->lock);
	for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
		INIT_LIST_HEAD(&queue->tasks[i]);
227
	queue->maxpriority = nr_queues - 1;
L
Linus Torvalds 已提交
228
	rpc_reset_waitqueue_priority(queue);
229 230 231
	queue->qlen = 0;
	setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
	INIT_LIST_HEAD(&queue->timer_list.list);
232
	rpc_assign_waitqueue_name(queue, qname);
L
Linus Torvalds 已提交
233 234 235 236
}

void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
237
	__rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
L
Linus Torvalds 已提交
238
}
239
EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
L
Linus Torvalds 已提交
240 241 242

void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
243
	__rpc_init_priority_wait_queue(queue, qname, 1);
L
Linus Torvalds 已提交
244
}
245
EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
L
Linus Torvalds 已提交
246

247 248
void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
{
249
	del_timer_sync(&queue->timer_list.timer);
250 251 252
}
EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);

253
static int rpc_wait_bit_killable(void *word)
254
{
255
	if (fatal_signal_pending(current))
256
		return -ERESTARTSYS;
257
	freezable_schedule();
258 259 260
	return 0;
}

261 262 263 264 265 266 267 268 269 270 271 272 273
#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

274 275
static void rpc_set_active(struct rpc_task *task)
{
276 277
	trace_rpc_task_begin(task->tk_client, task, NULL);

278
	rpc_task_set_debuginfo(task);
279
	set_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
280 281
}

282 283
/*
 * Mark an RPC call as having completed by clearing the 'active' bit
284
 * and then waking up all tasks that were sleeping.
285
 */
286
static int rpc_complete_task(struct rpc_task *task)
287
{
288 289 290 291 292 293
	void *m = &task->tk_runstate;
	wait_queue_head_t *wq = bit_waitqueue(m, RPC_TASK_ACTIVE);
	struct wait_bit_key k = __WAIT_BIT_KEY_INITIALIZER(m, RPC_TASK_ACTIVE);
	unsigned long flags;
	int ret;

294 295
	trace_rpc_task_complete(task->tk_client, task, NULL);

296
	spin_lock_irqsave(&wq->lock, flags);
297
	clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
298 299 300 301 302
	ret = atomic_dec_and_test(&task->tk_count);
	if (waitqueue_active(wq))
		__wake_up_locked_key(wq, TASK_NORMAL, &k);
	spin_unlock_irqrestore(&wq->lock, flags);
	return ret;
303 304 305 306
}

/*
 * Allow callers to wait for completion of an RPC call
307 308 309 310
 *
 * Note the use of out_of_line_wait_on_bit() rather than wait_on_bit()
 * to enforce taking of the wq->lock and hence avoid races with
 * rpc_complete_task().
311 312 313 314
 */
int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
{
	if (action == NULL)
315
		action = rpc_wait_bit_killable;
316
	return out_of_line_wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
317
			action, TASK_KILLABLE);
318
}
319
EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
320

L
Linus Torvalds 已提交
321 322 323
/*
 * Make an RPC task runnable.
 *
324 325 326
 * Note: If the task is ASYNC, and is being made runnable after sitting on an
 * rpc_wait_queue, this must be called with the queue spinlock held to protect
 * the wait queue operation.
327 328 329 330
 * Note the ordering of rpc_test_and_set_running() and rpc_clear_queued(),
 * which is needed to ensure that __rpc_execute() doesn't loop (due to the
 * lockless RPC_IS_QUEUED() test) before we've had a chance to test
 * the RPC_TASK_RUNNING flag.
L
Linus Torvalds 已提交
331 332 333
 */
static void rpc_make_runnable(struct rpc_task *task)
{
334 335
	bool need_wakeup = !rpc_test_and_set_running(task);

L
Linus Torvalds 已提交
336
	rpc_clear_queued(task);
337
	if (!need_wakeup)
338
		return;
L
Linus Torvalds 已提交
339
	if (RPC_IS_ASYNC(task)) {
340
		INIT_WORK(&task->u.tk_work, rpc_async_schedule);
341
		queue_work(rpciod_workqueue, &task->u.tk_work);
L
Linus Torvalds 已提交
342
	} else
343
		wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
L
Linus Torvalds 已提交
344 345 346 347 348 349 350 351
}

/*
 * 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.
 */
352 353 354 355
static void __rpc_sleep_on_priority(struct rpc_wait_queue *q,
		struct rpc_task *task,
		rpc_action action,
		unsigned char queue_priority)
L
Linus Torvalds 已提交
356
{
357 358
	dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
			task->tk_pid, rpc_qname(q), jiffies);
L
Linus Torvalds 已提交
359

360 361
	trace_rpc_task_sleep(task->tk_client, task, q);

362
	__rpc_add_wait_queue(q, task, queue_priority);
L
Linus Torvalds 已提交
363

364
	WARN_ON_ONCE(task->tk_callback != NULL);
L
Linus Torvalds 已提交
365
	task->tk_callback = action;
366
	__rpc_add_timer(q, task);
L
Linus Torvalds 已提交
367 368 369
}

void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
370
				rpc_action action)
L
Linus Torvalds 已提交
371
{
372
	/* We shouldn't ever put an inactive task to sleep */
373 374 375 376 377 378
	WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
	if (!RPC_IS_ACTIVATED(task)) {
		task->tk_status = -EIO;
		rpc_put_task_async(task);
		return;
	}
379

L
Linus Torvalds 已提交
380 381 382 383
	/*
	 * Protect the queue operations.
	 */
	spin_lock_bh(&q->lock);
384
	__rpc_sleep_on_priority(q, task, action, task->tk_priority);
L
Linus Torvalds 已提交
385 386
	spin_unlock_bh(&q->lock);
}
387
EXPORT_SYMBOL_GPL(rpc_sleep_on);
L
Linus Torvalds 已提交
388

389 390 391 392
void rpc_sleep_on_priority(struct rpc_wait_queue *q, struct rpc_task *task,
		rpc_action action, int priority)
{
	/* We shouldn't ever put an inactive task to sleep */
393 394 395 396 397 398
	WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
	if (!RPC_IS_ACTIVATED(task)) {
		task->tk_status = -EIO;
		rpc_put_task_async(task);
		return;
	}
399 400 401 402 403 404 405 406

	/*
	 * Protect the queue operations.
	 */
	spin_lock_bh(&q->lock);
	__rpc_sleep_on_priority(q, task, action, priority - RPC_PRIORITY_LOW);
	spin_unlock_bh(&q->lock);
}
407
EXPORT_SYMBOL_GPL(rpc_sleep_on_priority);
408

L
Linus Torvalds 已提交
409 410
/**
 * __rpc_do_wake_up_task - wake up a single rpc_task
411
 * @queue: wait queue
L
Linus Torvalds 已提交
412 413 414 415
 * @task: task to be woken up
 *
 * Caller must hold queue->lock, and have cleared the task queued flag.
 */
416
static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
417
{
418 419
	dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
			task->tk_pid, jiffies);
L
Linus Torvalds 已提交
420 421 422 423 424 425 426

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

427 428
	trace_rpc_task_wakeup(task->tk_client, task, queue);

429
	__rpc_remove_wait_queue(queue, task);
L
Linus Torvalds 已提交
430 431 432

	rpc_make_runnable(task);

433
	dprintk("RPC:       __rpc_wake_up_task done\n");
L
Linus Torvalds 已提交
434 435 436
}

/*
437
 * Wake up a queued task while the queue lock is being held
L
Linus Torvalds 已提交
438
 */
439
static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
440
{
441 442 443 444 445
	if (RPC_IS_QUEUED(task)) {
		smp_rmb();
		if (task->tk_waitqueue == queue)
			__rpc_do_wake_up_task(queue, task);
	}
L
Linus Torvalds 已提交
446 447
}

448 449 450 451 452 453 454 455 456 457
/*
 * 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);
E
Eric Dumazet 已提交
458
	return res == 0;
459 460 461
}
EXPORT_SYMBOL_GPL(rpc_queue_empty);

L
Linus Torvalds 已提交
462
/*
463
 * Wake up a task on a specific queue
L
Linus Torvalds 已提交
464
 */
465
void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
466
{
467
	spin_lock_bh(&queue->lock);
468
	rpc_wake_up_task_queue_locked(queue, task);
469
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
470
}
471 472
EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);

L
Linus Torvalds 已提交
473 474 475
/*
 * Wake up the next task on a priority queue.
 */
476
static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
L
Linus Torvalds 已提交
477 478 479 480 481
{
	struct list_head *q;
	struct rpc_task *task;

	/*
482
	 * Service a batch of tasks from a single owner.
L
Linus Torvalds 已提交
483 484 485 486
	 */
	q = &queue->tasks[queue->priority];
	if (!list_empty(q)) {
		task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
487
		if (queue->owner == task->tk_owner) {
L
Linus Torvalds 已提交
488 489 490 491 492 493 494
			if (--queue->nr)
				goto out;
			list_move_tail(&task->u.tk_wait.list, q);
		}
		/*
		 * Check if we need to switch queues.
		 */
495
		goto new_owner;
L
Linus Torvalds 已提交
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
	}

	/*
	 * 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]));
517 518
new_owner:
	rpc_set_waitqueue_owner(queue, task->tk_owner);
L
Linus Torvalds 已提交
519 520 521 522
out:
	return task;
}

523 524 525 526 527 528 529 530 531
static struct rpc_task *__rpc_find_next_queued(struct rpc_wait_queue *queue)
{
	if (RPC_IS_PRIORITY(queue))
		return __rpc_find_next_queued_priority(queue);
	if (!list_empty(&queue->tasks[0]))
		return list_first_entry(&queue->tasks[0], struct rpc_task, u.tk_wait.list);
	return NULL;
}

L
Linus Torvalds 已提交
532
/*
533
 * Wake up the first task on the wait queue.
L
Linus Torvalds 已提交
534
 */
535 536
struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
		bool (*func)(struct rpc_task *, void *), void *data)
L
Linus Torvalds 已提交
537 538 539
{
	struct rpc_task	*task = NULL;

540
	dprintk("RPC:       wake_up_first(%p \"%s\")\n",
541
			queue, rpc_qname(queue));
542
	spin_lock_bh(&queue->lock);
543 544 545
	task = __rpc_find_next_queued(queue);
	if (task != NULL) {
		if (func(task, data))
546
			rpc_wake_up_task_queue_locked(queue, task);
547 548
		else
			task = NULL;
L
Linus Torvalds 已提交
549
	}
550
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
551 552 553

	return task;
}
554 555 556 557 558 559 560 561 562 563 564 565 566 567
EXPORT_SYMBOL_GPL(rpc_wake_up_first);

static bool rpc_wake_up_next_func(struct rpc_task *task, void *data)
{
	return true;
}

/*
 * Wake up the next task on the wait queue.
*/
struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *queue)
{
	return rpc_wake_up_first(queue, rpc_wake_up_next_func, NULL);
}
568
EXPORT_SYMBOL_GPL(rpc_wake_up_next);
L
Linus Torvalds 已提交
569 570 571 572 573 574 575 576 577 578

/**
 * 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)
{
	struct list_head *head;
579

580
	spin_lock_bh(&queue->lock);
L
Linus Torvalds 已提交
581 582
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
583 584 585 586 587
		while (!list_empty(head)) {
			struct rpc_task *task;
			task = list_first_entry(head,
					struct rpc_task,
					u.tk_wait.list);
588
			rpc_wake_up_task_queue_locked(queue, task);
589
		}
L
Linus Torvalds 已提交
590 591 592 593
		if (head == &queue->tasks[0])
			break;
		head--;
	}
594
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
595
}
596
EXPORT_SYMBOL_GPL(rpc_wake_up);
L
Linus Torvalds 已提交
597 598 599 600 601 602 603 604 605 606 607 608

/**
 * 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)
{
	struct list_head *head;

609
	spin_lock_bh(&queue->lock);
L
Linus Torvalds 已提交
610 611
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
612 613 614 615 616
		while (!list_empty(head)) {
			struct rpc_task *task;
			task = list_first_entry(head,
					struct rpc_task,
					u.tk_wait.list);
L
Linus Torvalds 已提交
617
			task->tk_status = status;
618
			rpc_wake_up_task_queue_locked(queue, task);
L
Linus Torvalds 已提交
619 620 621 622 623
		}
		if (head == &queue->tasks[0])
			break;
		head--;
	}
624
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
625
}
626
EXPORT_SYMBOL_GPL(rpc_wake_up_status);
L
Linus Torvalds 已提交
627

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
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);
}

652 653
static void __rpc_atrun(struct rpc_task *task)
{
654
	task->tk_status = 0;
655 656
}

L
Linus Torvalds 已提交
657 658 659
/*
 * Run a task at a later time
 */
660
void rpc_delay(struct rpc_task *task, unsigned long delay)
L
Linus Torvalds 已提交
661 662
{
	task->tk_timeout = delay;
663
	rpc_sleep_on(&delay_queue, task, __rpc_atrun);
L
Linus Torvalds 已提交
664
}
665
EXPORT_SYMBOL_GPL(rpc_delay);
L
Linus Torvalds 已提交
666

T
Trond Myklebust 已提交
667 668 669
/*
 * Helper to call task->tk_ops->rpc_call_prepare
 */
670
void rpc_prepare_task(struct rpc_task *task)
T
Trond Myklebust 已提交
671 672 673 674
{
	task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
}

675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
static void
rpc_init_task_statistics(struct rpc_task *task)
{
	/* Initialize retry counters */
	task->tk_garb_retry = 2;
	task->tk_cred_retry = 2;
	task->tk_rebind_retry = 2;

	/* starting timestamp */
	task->tk_start = ktime_get();
}

static void
rpc_reset_task_statistics(struct rpc_task *task)
{
	task->tk_timeouts = 0;
	task->tk_flags &= ~(RPC_CALL_MAJORSEEN|RPC_TASK_KILLED|RPC_TASK_SENT);

	rpc_init_task_statistics(task);
}

696
/*
697
 * Helper that calls task->tk_ops->rpc_call_done if it exists
698
 */
T
Trond Myklebust 已提交
699
void rpc_exit_task(struct rpc_task *task)
700
{
T
Trond Myklebust 已提交
701
	task->tk_action = NULL;
702 703
	if (task->tk_ops->rpc_call_done != NULL) {
		task->tk_ops->rpc_call_done(task, task->tk_calldata);
704
		if (task->tk_action != NULL) {
T
Trond Myklebust 已提交
705 706 707
			WARN_ON(RPC_ASSASSINATED(task));
			/* Always release the RPC slot and buffer memory */
			xprt_release(task);
708
			rpc_reset_task_statistics(task);
709 710 711
		}
	}
}
712 713 714 715 716 717 718 719 720

void rpc_exit(struct rpc_task *task, int status)
{
	task->tk_status = status;
	task->tk_action = rpc_exit_task;
	if (RPC_IS_QUEUED(task))
		rpc_wake_up_queued_task(task->tk_waitqueue, task);
}
EXPORT_SYMBOL_GPL(rpc_exit);
721

722 723
void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
{
724
	if (ops->rpc_release != NULL)
725 726 727
		ops->rpc_release(calldata);
}

L
Linus Torvalds 已提交
728 729 730
/*
 * This is the RPC `scheduler' (or rather, the finite state machine).
 */
T
Trond Myklebust 已提交
731
static void __rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
732
{
733 734 735
	struct rpc_wait_queue *queue;
	int task_is_async = RPC_IS_ASYNC(task);
	int status = 0;
L
Linus Torvalds 已提交
736

737 738
	dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
			task->tk_pid, task->tk_flags);
L
Linus Torvalds 已提交
739

740 741 742
	WARN_ON_ONCE(RPC_IS_QUEUED(task));
	if (RPC_IS_QUEUED(task))
		return;
L
Linus Torvalds 已提交
743

744
	for (;;) {
745
		void (*do_action)(struct rpc_task *);
L
Linus Torvalds 已提交
746 747

		/*
748
		 * Execute any pending callback first.
L
Linus Torvalds 已提交
749
		 */
750 751 752
		do_action = task->tk_callback;
		task->tk_callback = NULL;
		if (do_action == NULL) {
753 754
			/*
			 * Perform the next FSM step.
755 756 757
			 * tk_action may be NULL if the task has been killed.
			 * In particular, note that rpc_killall_tasks may
			 * do this at any time, so beware when dereferencing.
758
			 */
759 760
			do_action = task->tk_action;
			if (do_action == NULL)
L
Linus Torvalds 已提交
761 762
				break;
		}
763
		trace_rpc_task_run_action(task->tk_client, task, task->tk_action);
764
		do_action(task);
L
Linus Torvalds 已提交
765 766 767 768 769 770

		/*
		 * Lockless check for whether task is sleeping or not.
		 */
		if (!RPC_IS_QUEUED(task))
			continue;
771 772 773 774 775 776 777 778 779 780 781 782 783
		/*
		 * 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 已提交
784 785
			continue;
		}
786 787 788 789
		rpc_clear_running(task);
		spin_unlock_bh(&queue->lock);
		if (task_is_async)
			return;
L
Linus Torvalds 已提交
790 791

		/* sync task: sleep here */
792
		dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
793
		status = out_of_line_wait_on_bit(&task->tk_runstate,
794 795
				RPC_TASK_QUEUED, rpc_wait_bit_killable,
				TASK_KILLABLE);
796
		if (status == -ERESTARTSYS) {
L
Linus Torvalds 已提交
797 798 799 800 801 802
			/*
			 * 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.
			 */
803
			dprintk("RPC: %5u got signal\n", task->tk_pid);
804 805
			task->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(task, -ERESTARTSYS);
L
Linus Torvalds 已提交
806 807
		}
		rpc_set_running(task);
808
		dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
L
Linus Torvalds 已提交
809 810
	}

811 812
	dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
			task->tk_status);
L
Linus Torvalds 已提交
813 814 815 816 817 818 819 820 821 822 823 824 825
	/* 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 已提交
826
void rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
827
{
828
	rpc_set_active(task);
829 830 831
	rpc_make_runnable(task);
	if (!RPC_IS_ASYNC(task))
		__rpc_execute(task);
L
Linus Torvalds 已提交
832 833
}

834
static void rpc_async_schedule(struct work_struct *work)
L
Linus Torvalds 已提交
835
{
836
	current->flags |= PF_FSTRANS;
837
	__rpc_execute(container_of(work, struct rpc_task, u.tk_work));
838
	current->flags &= ~PF_FSTRANS;
L
Linus Torvalds 已提交
839 840
}

841 842 843 844
/**
 * rpc_malloc - allocate an RPC buffer
 * @task: RPC task that will use this buffer
 * @size: requested byte size
L
Linus Torvalds 已提交
845
 *
846 847 848 849 850 851 852 853
 * 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 已提交
854
 * In order to avoid memory starvation triggering more writebacks of
855
 * NFS requests, we avoid using GFP_KERNEL.
L
Linus Torvalds 已提交
856
 */
857
void *rpc_malloc(struct rpc_task *task, size_t size)
L
Linus Torvalds 已提交
858
{
859
	struct rpc_buffer *buf;
M
Mel Gorman 已提交
860 861 862 863
	gfp_t gfp = GFP_NOWAIT;

	if (RPC_IS_SWAPPER(task))
		gfp |= __GFP_MEMALLOC;
L
Linus Torvalds 已提交
864

865
	size += sizeof(struct rpc_buffer);
866 867
	if (size <= RPC_BUFFER_MAXSIZE)
		buf = mempool_alloc(rpc_buffer_mempool, gfp);
L
Linus Torvalds 已提交
868
	else
869
		buf = kmalloc(size, gfp);
870 871 872 873

	if (!buf)
		return NULL;

874
	buf->len = size;
G
Geert Uytterhoeven 已提交
875
	dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
876
			task->tk_pid, size, buf);
877
	return &buf->data;
L
Linus Torvalds 已提交
878
}
879
EXPORT_SYMBOL_GPL(rpc_malloc);
L
Linus Torvalds 已提交
880

881 882
/**
 * rpc_free - free buffer allocated via rpc_malloc
883
 * @buffer: buffer to free
884 885
 *
 */
886
void rpc_free(void *buffer)
L
Linus Torvalds 已提交
887
{
888 889
	size_t size;
	struct rpc_buffer *buf;
890

891 892
	if (!buffer)
		return;
893 894 895

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

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

900 901 902 903
	if (size <= RPC_BUFFER_MAXSIZE)
		mempool_free(buf, rpc_buffer_mempool);
	else
		kfree(buf);
L
Linus Torvalds 已提交
904
}
905
EXPORT_SYMBOL_GPL(rpc_free);
L
Linus Torvalds 已提交
906 907 908 909

/*
 * Creation and deletion of RPC task structures
 */
910
static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
L
Linus Torvalds 已提交
911 912
{
	memset(task, 0, sizeof(*task));
913
	atomic_set(&task->tk_count, 1);
914 915 916
	task->tk_flags  = task_setup_data->flags;
	task->tk_ops = task_setup_data->callback_ops;
	task->tk_calldata = task_setup_data->callback_data;
917
	INIT_LIST_HEAD(&task->tk_task);
L
Linus Torvalds 已提交
918

919 920
	task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
	task->tk_owner = current->tgid;
L
Linus Torvalds 已提交
921 922

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

925 926
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
927

928
	rpc_init_task_statistics(task);
929

930
	dprintk("RPC:       new task initialized, procpid %u\n",
931
				task_pid_nr(current));
L
Linus Torvalds 已提交
932 933 934 935 936
}

static struct rpc_task *
rpc_alloc_task(void)
{
M
Mel Gorman 已提交
937
	return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOIO);
L
Linus Torvalds 已提交
938 939 940
}

/*
941
 * Create a new task for the specified client.
L
Linus Torvalds 已提交
942
 */
943
struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
L
Linus Torvalds 已提交
944
{
945 946 947 948 949
	struct rpc_task	*task = setup_data->task;
	unsigned short flags = 0;

	if (task == NULL) {
		task = rpc_alloc_task();
950 951 952 953 954
		if (task == NULL) {
			rpc_release_calldata(setup_data->callback_ops,
					setup_data->callback_data);
			return ERR_PTR(-ENOMEM);
		}
955 956
		flags = RPC_TASK_DYNAMIC;
	}
L
Linus Torvalds 已提交
957

958
	rpc_init_task(task, setup_data);
959
	task->tk_flags |= flags;
960
	dprintk("RPC:       allocated task %p\n", task);
L
Linus Torvalds 已提交
961 962 963
	return task;
}

964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
/*
 * rpc_free_task - release rpc task and perform cleanups
 *
 * Note that we free up the rpc_task _after_ rpc_release_calldata()
 * in order to work around a workqueue dependency issue.
 *
 * Tejun Heo states:
 * "Workqueue currently considers two work items to be the same if they're
 * on the same address and won't execute them concurrently - ie. it
 * makes a work item which is queued again while being executed wait
 * for the previous execution to complete.
 *
 * If a work function frees the work item, and then waits for an event
 * which should be performed by another work item and *that* work item
 * recycles the freed work item, it can create a false dependency loop.
 * There really is no reliable way to detect this short of verifying
 * every memory free."
 *
 */
983
static void rpc_free_task(struct rpc_task *task)
L
Linus Torvalds 已提交
984
{
985 986 987
	unsigned short tk_flags = task->tk_flags;

	rpc_release_calldata(task->tk_ops, task->tk_calldata);
L
Linus Torvalds 已提交
988

989
	if (tk_flags & RPC_TASK_DYNAMIC) {
990 991 992
		dprintk("RPC: %5u freeing task\n", task->tk_pid);
		mempool_free(task, rpc_task_mempool);
	}
993 994 995 996 997 998 999
}

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

1000
static void rpc_release_resources_task(struct rpc_task *task)
1001
{
1002
	xprt_release(task);
1003
	if (task->tk_msg.rpc_cred) {
1004
		put_rpccred(task->tk_msg.rpc_cred);
1005 1006
		task->tk_msg.rpc_cred = NULL;
	}
1007
	rpc_task_release_client(task);
1008 1009 1010 1011 1012 1013
}

static void rpc_final_put_task(struct rpc_task *task,
		struct workqueue_struct *q)
{
	if (q != NULL) {
1014
		INIT_WORK(&task->u.tk_work, rpc_async_release);
1015
		queue_work(q, &task->u.tk_work);
1016 1017
	} else
		rpc_free_task(task);
1018
}
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031

static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
{
	if (atomic_dec_and_test(&task->tk_count)) {
		rpc_release_resources_task(task);
		rpc_final_put_task(task, q);
	}
}

void rpc_put_task(struct rpc_task *task)
{
	rpc_do_put_task(task, NULL);
}
1032
EXPORT_SYMBOL_GPL(rpc_put_task);
1033

1034 1035 1036 1037 1038 1039
void rpc_put_task_async(struct rpc_task *task)
{
	rpc_do_put_task(task, task->tk_workqueue);
}
EXPORT_SYMBOL_GPL(rpc_put_task_async);

1040
static void rpc_release_task(struct rpc_task *task)
1041
{
1042
	dprintk("RPC: %5u release task\n", task->tk_pid);
L
Linus Torvalds 已提交
1043

1044
	WARN_ON_ONCE(RPC_IS_QUEUED(task));
L
Linus Torvalds 已提交
1045

1046
	rpc_release_resources_task(task);
1047

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
	/*
	 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
	 * so it should be safe to use task->tk_count as a test for whether
	 * or not any other processes still hold references to our rpc_task.
	 */
	if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
		/* Wake up anyone who may be waiting for task completion */
		if (!rpc_complete_task(task))
			return;
	} else {
		if (!atomic_dec_and_test(&task->tk_count))
			return;
	}
	rpc_final_put_task(task, task->tk_workqueue);
L
Linus Torvalds 已提交
1062 1063
}

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
int rpciod_up(void)
{
	return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
}

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

L
Linus Torvalds 已提交
1074
/*
1075
 * Start up the rpciod workqueue.
L
Linus Torvalds 已提交
1076
 */
1077
static int rpciod_start(void)
L
Linus Torvalds 已提交
1078 1079
{
	struct workqueue_struct *wq;
T
Trond Myklebust 已提交
1080

L
Linus Torvalds 已提交
1081 1082 1083
	/*
	 * Create the rpciod thread and wait for it to start.
	 */
T
Trond Myklebust 已提交
1084
	dprintk("RPC:       creating workqueue rpciod\n");
1085
	wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM, 1);
L
Linus Torvalds 已提交
1086
	rpciod_workqueue = wq;
1087
	return rpciod_workqueue != NULL;
L
Linus Torvalds 已提交
1088 1089
}

1090
static void rpciod_stop(void)
L
Linus Torvalds 已提交
1091
{
1092
	struct workqueue_struct *wq = NULL;
T
Trond Myklebust 已提交
1093

1094 1095
	if (rpciod_workqueue == NULL)
		return;
T
Trond Myklebust 已提交
1096
	dprintk("RPC:       destroying workqueue rpciod\n");
L
Linus Torvalds 已提交
1097

1098 1099 1100
	wq = rpciod_workqueue;
	rpciod_workqueue = NULL;
	destroy_workqueue(wq);
L
Linus Torvalds 已提交
1101 1102 1103 1104 1105
}

void
rpc_destroy_mempool(void)
{
1106
	rpciod_stop();
L
Linus Torvalds 已提交
1107 1108 1109 1110
	if (rpc_buffer_mempool)
		mempool_destroy(rpc_buffer_mempool);
	if (rpc_task_mempool)
		mempool_destroy(rpc_task_mempool);
1111 1112 1113 1114
	if (rpc_task_slabp)
		kmem_cache_destroy(rpc_task_slabp);
	if (rpc_buffer_slabp)
		kmem_cache_destroy(rpc_buffer_slabp);
1115
	rpc_destroy_wait_queue(&delay_queue);
L
Linus Torvalds 已提交
1116 1117 1118 1119 1120
}

int
rpc_init_mempool(void)
{
1121 1122 1123 1124 1125 1126 1127 1128
	/*
	 * 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 已提交
1129 1130 1131
	rpc_task_slabp = kmem_cache_create("rpc_tasks",
					     sizeof(struct rpc_task),
					     0, SLAB_HWCACHE_ALIGN,
1132
					     NULL);
L
Linus Torvalds 已提交
1133 1134 1135 1136 1137
	if (!rpc_task_slabp)
		goto err_nomem;
	rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
					     RPC_BUFFER_MAXSIZE,
					     0, SLAB_HWCACHE_ALIGN,
1138
					     NULL);
L
Linus Torvalds 已提交
1139 1140
	if (!rpc_buffer_slabp)
		goto err_nomem;
1141 1142
	rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
						    rpc_task_slabp);
L
Linus Torvalds 已提交
1143 1144
	if (!rpc_task_mempool)
		goto err_nomem;
1145 1146
	rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
						      rpc_buffer_slabp);
L
Linus Torvalds 已提交
1147 1148 1149 1150 1151 1152 1153
	if (!rpc_buffer_mempool)
		goto err_nomem;
	return 0;
err_nomem:
	rpc_destroy_mempool();
	return -ENOMEM;
}