sched.c 27.3 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6
/*
 * linux/net/sunrpc/sched.c
 *
 * Scheduling for synchronous and asynchronous RPC requests.
 *
 * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
7
 *
L
Linus Torvalds 已提交
8 9 10 11 12 13 14 15 16 17 18 19
 * 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
}

/*
 * Add new request to a priority queue.
 */
104 105 106
static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue,
		struct rpc_task *task,
		unsigned char queue_priority)
L
Linus Torvalds 已提交
107 108 109 110 111
{
	struct list_head *q;
	struct rpc_task *t;

	INIT_LIST_HEAD(&task->u.tk_wait.links);
112 113
	q = &queue->tasks[queue_priority];
	if (unlikely(queue_priority > queue->maxpriority))
L
Linus Torvalds 已提交
114 115
		q = &queue->tasks[queue->maxpriority];
	list_for_each_entry(t, q, u.tk_wait.list) {
116
		if (t->tk_owner == task->tk_owner) {
L
Linus Torvalds 已提交
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
			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.
 */
132 133 134
static void __rpc_add_wait_queue(struct rpc_wait_queue *queue,
		struct rpc_task *task,
		unsigned char queue_priority)
L
Linus Torvalds 已提交
135 136 137 138
{
	BUG_ON (RPC_IS_QUEUED(task));

	if (RPC_IS_PRIORITY(queue))
139
		__rpc_add_wait_queue_priority(queue, task, queue_priority);
L
Linus Torvalds 已提交
140 141 142 143
	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]);
144
	task->tk_waitqueue = queue;
145
	queue->qlen++;
L
Linus Torvalds 已提交
146 147
	rpc_set_queued(task);

148 149
	dprintk("RPC: %5u added to queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
}

/*
 * 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.
 */
170
static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
171
{
172
	__rpc_disable_timer(queue, task);
L
Linus Torvalds 已提交
173 174
	if (RPC_IS_PRIORITY(queue))
		__rpc_remove_wait_queue_priority(task);
175
	list_del(&task->u.tk_wait.list);
176
	queue->qlen--;
177 178
	dprintk("RPC: %5u removed from queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
179 180 181 182 183 184 185 186
}

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

187
static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
L
Linus Torvalds 已提交
188
{
189
	queue->owner = pid;
L
Linus Torvalds 已提交
190 191 192 193 194 195
	queue->nr = RPC_BATCH_COUNT;
}

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

199
static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
L
Linus Torvalds 已提交
200 201 202 203 204 205
{
	int i;

	spin_lock_init(&queue->lock);
	for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
		INIT_LIST_HEAD(&queue->tasks[i]);
206
	queue->maxpriority = nr_queues - 1;
L
Linus Torvalds 已提交
207
	rpc_reset_waitqueue_priority(queue);
208 209 210
	queue->qlen = 0;
	setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
	INIT_LIST_HEAD(&queue->timer_list.list);
211
	rpc_assign_waitqueue_name(queue, qname);
L
Linus Torvalds 已提交
212 213 214 215
}

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

void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
{
222
	__rpc_init_priority_wait_queue(queue, qname, 1);
L
Linus Torvalds 已提交
223
}
224
EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
L
Linus Torvalds 已提交
225

226 227
void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
{
228
	del_timer_sync(&queue->timer_list.timer);
229 230 231
}
EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);

232
static int rpc_wait_bit_killable(void *word)
233
{
234
	if (fatal_signal_pending(current))
235
		return -ERESTARTSYS;
236
	freezable_schedule();
237 238 239
	return 0;
}

240 241 242 243 244 245 246 247 248 249 250 251 252
#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

253 254
static void rpc_set_active(struct rpc_task *task)
{
255 256
	trace_rpc_task_begin(task->tk_client, task, NULL);

257
	rpc_task_set_debuginfo(task);
258
	set_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
259 260
}

261 262
/*
 * Mark an RPC call as having completed by clearing the 'active' bit
263
 * and then waking up all tasks that were sleeping.
264
 */
265
static int rpc_complete_task(struct rpc_task *task)
266
{
267 268 269 270 271 272
	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;

273 274
	trace_rpc_task_complete(task->tk_client, task, NULL);

275
	spin_lock_irqsave(&wq->lock, flags);
276
	clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
277 278 279 280 281
	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;
282 283 284 285
}

/*
 * Allow callers to wait for completion of an RPC call
286 287 288 289
 *
 * 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().
290 291 292 293
 */
int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
{
	if (action == NULL)
294
		action = rpc_wait_bit_killable;
295
	return out_of_line_wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
296
			action, TASK_KILLABLE);
297
}
298
EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
299

L
Linus Torvalds 已提交
300 301 302
/*
 * Make an RPC task runnable.
 *
303 304 305
 * 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.
L
Linus Torvalds 已提交
306 307 308 309
 */
static void rpc_make_runnable(struct rpc_task *task)
{
	rpc_clear_queued(task);
310 311
	if (rpc_test_and_set_running(task))
		return;
L
Linus Torvalds 已提交
312
	if (RPC_IS_ASYNC(task)) {
313
		INIT_WORK(&task->u.tk_work, rpc_async_schedule);
314
		queue_work(rpciod_workqueue, &task->u.tk_work);
L
Linus Torvalds 已提交
315
	} else
316
		wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
L
Linus Torvalds 已提交
317 318 319 320 321 322 323 324
}

/*
 * 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.
 */
325 326 327 328
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 已提交
329
{
330 331
	dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
			task->tk_pid, rpc_qname(q), jiffies);
L
Linus Torvalds 已提交
332

333 334
	trace_rpc_task_sleep(task->tk_client, task, q);

335
	__rpc_add_wait_queue(q, task, queue_priority);
L
Linus Torvalds 已提交
336

337
	WARN_ON_ONCE(task->tk_callback != NULL);
L
Linus Torvalds 已提交
338
	task->tk_callback = action;
339
	__rpc_add_timer(q, task);
L
Linus Torvalds 已提交
340 341 342
}

void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
343
				rpc_action action)
L
Linus Torvalds 已提交
344
{
345
	/* We shouldn't ever put an inactive task to sleep */
346 347 348 349 350 351
	WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
	if (!RPC_IS_ACTIVATED(task)) {
		task->tk_status = -EIO;
		rpc_put_task_async(task);
		return;
	}
352

L
Linus Torvalds 已提交
353 354 355 356
	/*
	 * Protect the queue operations.
	 */
	spin_lock_bh(&q->lock);
357
	__rpc_sleep_on_priority(q, task, action, task->tk_priority);
L
Linus Torvalds 已提交
358 359
	spin_unlock_bh(&q->lock);
}
360
EXPORT_SYMBOL_GPL(rpc_sleep_on);
L
Linus Torvalds 已提交
361

362 363 364 365
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 */
366 367 368 369 370 371
	WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
	if (!RPC_IS_ACTIVATED(task)) {
		task->tk_status = -EIO;
		rpc_put_task_async(task);
		return;
	}
372 373 374 375 376 377 378 379 380

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

L
Linus Torvalds 已提交
381 382
/**
 * __rpc_do_wake_up_task - wake up a single rpc_task
383
 * @queue: wait queue
L
Linus Torvalds 已提交
384 385 386 387
 * @task: task to be woken up
 *
 * Caller must hold queue->lock, and have cleared the task queued flag.
 */
388
static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
389
{
390 391
	dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
			task->tk_pid, jiffies);
L
Linus Torvalds 已提交
392 393 394 395 396 397 398

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

399 400
	trace_rpc_task_wakeup(task->tk_client, task, queue);

401
	__rpc_remove_wait_queue(queue, task);
L
Linus Torvalds 已提交
402 403 404

	rpc_make_runnable(task);

405
	dprintk("RPC:       __rpc_wake_up_task done\n");
L
Linus Torvalds 已提交
406 407 408
}

/*
409
 * Wake up a queued task while the queue lock is being held
L
Linus Torvalds 已提交
410
 */
411
static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
412
{
413 414
	if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
		__rpc_do_wake_up_task(queue, task);
L
Linus Torvalds 已提交
415 416
}

417 418 419 420 421 422 423 424 425 426
/*
 * 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 已提交
427
	return res == 0;
428 429 430
}
EXPORT_SYMBOL_GPL(rpc_queue_empty);

L
Linus Torvalds 已提交
431
/*
432
 * Wake up a task on a specific queue
L
Linus Torvalds 已提交
433
 */
434
void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
L
Linus Torvalds 已提交
435
{
436
	spin_lock_bh(&queue->lock);
437
	rpc_wake_up_task_queue_locked(queue, task);
438
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
439
}
440 441
EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);

L
Linus Torvalds 已提交
442 443 444
/*
 * Wake up the next task on a priority queue.
 */
445
static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
L
Linus Torvalds 已提交
446 447 448 449 450
{
	struct list_head *q;
	struct rpc_task *task;

	/*
451
	 * Service a batch of tasks from a single owner.
L
Linus Torvalds 已提交
452 453 454 455
	 */
	q = &queue->tasks[queue->priority];
	if (!list_empty(q)) {
		task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
456
		if (queue->owner == task->tk_owner) {
L
Linus Torvalds 已提交
457 458 459 460 461 462 463 464
			if (--queue->nr)
				goto out;
			list_move_tail(&task->u.tk_wait.list, q);
		}
		/*
		 * Check if we need to switch queues.
		 */
		if (--queue->count)
465
			goto new_owner;
L
Linus Torvalds 已提交
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
	}

	/*
	 * 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]));
487 488
new_owner:
	rpc_set_waitqueue_owner(queue, task->tk_owner);
L
Linus Torvalds 已提交
489 490 491 492
out:
	return task;
}

493 494 495 496 497 498 499 500 501
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 已提交
502
/*
503
 * Wake up the first task on the wait queue.
L
Linus Torvalds 已提交
504
 */
505 506
struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
		bool (*func)(struct rpc_task *, void *), void *data)
L
Linus Torvalds 已提交
507 508 509
{
	struct rpc_task	*task = NULL;

510
	dprintk("RPC:       wake_up_first(%p \"%s\")\n",
511
			queue, rpc_qname(queue));
512
	spin_lock_bh(&queue->lock);
513 514 515
	task = __rpc_find_next_queued(queue);
	if (task != NULL) {
		if (func(task, data))
516
			rpc_wake_up_task_queue_locked(queue, task);
517 518
		else
			task = NULL;
L
Linus Torvalds 已提交
519
	}
520
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
521 522 523

	return task;
}
524 525 526 527 528 529 530 531 532 533 534 535 536 537
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);
}
538
EXPORT_SYMBOL_GPL(rpc_wake_up_next);
L
Linus Torvalds 已提交
539 540 541 542 543 544 545 546 547 548

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

550
	spin_lock_bh(&queue->lock);
L
Linus Torvalds 已提交
551 552
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
553 554 555 556 557
		while (!list_empty(head)) {
			struct rpc_task *task;
			task = list_first_entry(head,
					struct rpc_task,
					u.tk_wait.list);
558
			rpc_wake_up_task_queue_locked(queue, task);
559
		}
L
Linus Torvalds 已提交
560 561 562 563
		if (head == &queue->tasks[0])
			break;
		head--;
	}
564
	spin_unlock_bh(&queue->lock);
L
Linus Torvalds 已提交
565
}
566
EXPORT_SYMBOL_GPL(rpc_wake_up);
L
Linus Torvalds 已提交
567 568 569 570 571 572 573 574 575 576 577 578

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

579
	spin_lock_bh(&queue->lock);
L
Linus Torvalds 已提交
580 581
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
582 583 584 585 586
		while (!list_empty(head)) {
			struct rpc_task *task;
			task = list_first_entry(head,
					struct rpc_task,
					u.tk_wait.list);
L
Linus Torvalds 已提交
587
			task->tk_status = status;
588
			rpc_wake_up_task_queue_locked(queue, task);
L
Linus Torvalds 已提交
589 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_status);
L
Linus Torvalds 已提交
597

598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
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);
}

622 623
static void __rpc_atrun(struct rpc_task *task)
{
624
	task->tk_status = 0;
625 626
}

L
Linus Torvalds 已提交
627 628 629
/*
 * Run a task at a later time
 */
630
void rpc_delay(struct rpc_task *task, unsigned long delay)
L
Linus Torvalds 已提交
631 632
{
	task->tk_timeout = delay;
633
	rpc_sleep_on(&delay_queue, task, __rpc_atrun);
L
Linus Torvalds 已提交
634
}
635
EXPORT_SYMBOL_GPL(rpc_delay);
L
Linus Torvalds 已提交
636

T
Trond Myklebust 已提交
637 638 639
/*
 * Helper to call task->tk_ops->rpc_call_prepare
 */
640
void rpc_prepare_task(struct rpc_task *task)
T
Trond Myklebust 已提交
641 642 643 644
{
	task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
}

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
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);
}

666
/*
667
 * Helper that calls task->tk_ops->rpc_call_done if it exists
668
 */
T
Trond Myklebust 已提交
669
void rpc_exit_task(struct rpc_task *task)
670
{
T
Trond Myklebust 已提交
671
	task->tk_action = NULL;
672 673
	if (task->tk_ops->rpc_call_done != NULL) {
		task->tk_ops->rpc_call_done(task, task->tk_calldata);
674
		if (task->tk_action != NULL) {
T
Trond Myklebust 已提交
675 676 677
			WARN_ON(RPC_ASSASSINATED(task));
			/* Always release the RPC slot and buffer memory */
			xprt_release(task);
678
			rpc_reset_task_statistics(task);
679 680 681
		}
	}
}
682 683 684 685 686 687 688 689 690

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

692 693
void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
{
694
	if (ops->rpc_release != NULL)
695 696 697
		ops->rpc_release(calldata);
}

L
Linus Torvalds 已提交
698 699 700
/*
 * This is the RPC `scheduler' (or rather, the finite state machine).
 */
T
Trond Myklebust 已提交
701
static void __rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
702
{
703 704 705
	struct rpc_wait_queue *queue;
	int task_is_async = RPC_IS_ASYNC(task);
	int status = 0;
L
Linus Torvalds 已提交
706

707 708
	dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
			task->tk_pid, task->tk_flags);
L
Linus Torvalds 已提交
709 710 711

	BUG_ON(RPC_IS_QUEUED(task));

712
	for (;;) {
713
		void (*do_action)(struct rpc_task *);
L
Linus Torvalds 已提交
714 715

		/*
716
		 * Execute any pending callback first.
L
Linus Torvalds 已提交
717
		 */
718 719 720
		do_action = task->tk_callback;
		task->tk_callback = NULL;
		if (do_action == NULL) {
721 722
			/*
			 * Perform the next FSM step.
723 724 725
			 * 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.
726
			 */
727 728
			do_action = task->tk_action;
			if (do_action == NULL)
L
Linus Torvalds 已提交
729 730
				break;
		}
731
		trace_rpc_task_run_action(task->tk_client, task, task->tk_action);
732
		do_action(task);
L
Linus Torvalds 已提交
733 734 735 736 737 738

		/*
		 * Lockless check for whether task is sleeping or not.
		 */
		if (!RPC_IS_QUEUED(task))
			continue;
739 740 741 742 743 744 745 746 747 748 749 750 751
		/*
		 * 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 已提交
752 753
			continue;
		}
754 755 756 757
		rpc_clear_running(task);
		spin_unlock_bh(&queue->lock);
		if (task_is_async)
			return;
L
Linus Torvalds 已提交
758 759

		/* sync task: sleep here */
760
		dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
761
		status = out_of_line_wait_on_bit(&task->tk_runstate,
762 763
				RPC_TASK_QUEUED, rpc_wait_bit_killable,
				TASK_KILLABLE);
764
		if (status == -ERESTARTSYS) {
L
Linus Torvalds 已提交
765 766 767 768 769 770
			/*
			 * 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.
			 */
771
			dprintk("RPC: %5u got signal\n", task->tk_pid);
772 773
			task->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(task, -ERESTARTSYS);
L
Linus Torvalds 已提交
774 775
		}
		rpc_set_running(task);
776
		dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
L
Linus Torvalds 已提交
777 778
	}

779 780
	dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
			task->tk_status);
L
Linus Torvalds 已提交
781 782 783 784 785 786 787 788 789 790 791 792 793
	/* 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 已提交
794
void rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
795
{
796
	rpc_set_active(task);
797 798 799
	rpc_make_runnable(task);
	if (!RPC_IS_ASYNC(task))
		__rpc_execute(task);
L
Linus Torvalds 已提交
800 801
}

802
static void rpc_async_schedule(struct work_struct *work)
L
Linus Torvalds 已提交
803
{
804
	current->flags |= PF_FSTRANS;
805
	__rpc_execute(container_of(work, struct rpc_task, u.tk_work));
806
	current->flags &= ~PF_FSTRANS;
L
Linus Torvalds 已提交
807 808
}

809 810 811 812
/**
 * rpc_malloc - allocate an RPC buffer
 * @task: RPC task that will use this buffer
 * @size: requested byte size
L
Linus Torvalds 已提交
813
 *
814 815 816 817 818 819 820 821
 * 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 已提交
822
 * In order to avoid memory starvation triggering more writebacks of
823
 * NFS requests, we avoid using GFP_KERNEL.
L
Linus Torvalds 已提交
824
 */
825
void *rpc_malloc(struct rpc_task *task, size_t size)
L
Linus Torvalds 已提交
826
{
827
	struct rpc_buffer *buf;
M
Mel Gorman 已提交
828 829 830 831
	gfp_t gfp = GFP_NOWAIT;

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

833
	size += sizeof(struct rpc_buffer);
834 835
	if (size <= RPC_BUFFER_MAXSIZE)
		buf = mempool_alloc(rpc_buffer_mempool, gfp);
L
Linus Torvalds 已提交
836
	else
837
		buf = kmalloc(size, gfp);
838 839 840 841

	if (!buf)
		return NULL;

842
	buf->len = size;
G
Geert Uytterhoeven 已提交
843
	dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
844
			task->tk_pid, size, buf);
845
	return &buf->data;
L
Linus Torvalds 已提交
846
}
847
EXPORT_SYMBOL_GPL(rpc_malloc);
L
Linus Torvalds 已提交
848

849 850
/**
 * rpc_free - free buffer allocated via rpc_malloc
851
 * @buffer: buffer to free
852 853
 *
 */
854
void rpc_free(void *buffer)
L
Linus Torvalds 已提交
855
{
856 857
	size_t size;
	struct rpc_buffer *buf;
858

859 860
	if (!buffer)
		return;
861 862 863

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

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

868 869 870 871
	if (size <= RPC_BUFFER_MAXSIZE)
		mempool_free(buf, rpc_buffer_mempool);
	else
		kfree(buf);
L
Linus Torvalds 已提交
872
}
873
EXPORT_SYMBOL_GPL(rpc_free);
L
Linus Torvalds 已提交
874 875 876 877

/*
 * Creation and deletion of RPC task structures
 */
878
static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
L
Linus Torvalds 已提交
879 880
{
	memset(task, 0, sizeof(*task));
881
	atomic_set(&task->tk_count, 1);
882 883 884
	task->tk_flags  = task_setup_data->flags;
	task->tk_ops = task_setup_data->callback_ops;
	task->tk_calldata = task_setup_data->callback_data;
885
	INIT_LIST_HEAD(&task->tk_task);
L
Linus Torvalds 已提交
886

887 888
	task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
	task->tk_owner = current->tgid;
L
Linus Torvalds 已提交
889 890

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

893 894
	if (task->tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
895

896
	rpc_init_task_statistics(task);
897

898
	dprintk("RPC:       new task initialized, procpid %u\n",
899
				task_pid_nr(current));
L
Linus Torvalds 已提交
900 901 902 903 904
}

static struct rpc_task *
rpc_alloc_task(void)
{
M
Mel Gorman 已提交
905
	return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOIO);
L
Linus Torvalds 已提交
906 907 908
}

/*
909
 * Create a new task for the specified client.
L
Linus Torvalds 已提交
910
 */
911
struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
L
Linus Torvalds 已提交
912
{
913 914 915 916 917
	struct rpc_task	*task = setup_data->task;
	unsigned short flags = 0;

	if (task == NULL) {
		task = rpc_alloc_task();
918 919 920 921 922
		if (task == NULL) {
			rpc_release_calldata(setup_data->callback_ops,
					setup_data->callback_data);
			return ERR_PTR(-ENOMEM);
		}
923 924
		flags = RPC_TASK_DYNAMIC;
	}
L
Linus Torvalds 已提交
925

926
	rpc_init_task(task, setup_data);
927
	task->tk_flags |= flags;
928
	dprintk("RPC:       allocated task %p\n", task);
L
Linus Torvalds 已提交
929 930 931
	return task;
}

932
static void rpc_free_task(struct rpc_task *task)
L
Linus Torvalds 已提交
933
{
934 935
	const struct rpc_call_ops *tk_ops = task->tk_ops;
	void *calldata = task->tk_calldata;
L
Linus Torvalds 已提交
936

937 938 939 940
	if (task->tk_flags & RPC_TASK_DYNAMIC) {
		dprintk("RPC: %5u freeing task\n", task->tk_pid);
		mempool_free(task, rpc_task_mempool);
	}
941 942 943 944 945 946 947 948
	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));
}

949
static void rpc_release_resources_task(struct rpc_task *task)
950
{
951 952
	if (task->tk_rqstp)
		xprt_release(task);
953
	if (task->tk_msg.rpc_cred) {
954
		put_rpccred(task->tk_msg.rpc_cred);
955 956
		task->tk_msg.rpc_cred = NULL;
	}
957
	rpc_task_release_client(task);
958 959 960 961 962 963
}

static void rpc_final_put_task(struct rpc_task *task,
		struct workqueue_struct *q)
{
	if (q != NULL) {
964
		INIT_WORK(&task->u.tk_work, rpc_async_release);
965
		queue_work(q, &task->u.tk_work);
966 967
	} else
		rpc_free_task(task);
968
}
969 970 971 972 973 974 975 976 977 978 979 980 981

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);
}
982
EXPORT_SYMBOL_GPL(rpc_put_task);
983

984 985 986 987 988 989
void rpc_put_task_async(struct rpc_task *task)
{
	rpc_do_put_task(task, task->tk_workqueue);
}
EXPORT_SYMBOL_GPL(rpc_put_task_async);

990
static void rpc_release_task(struct rpc_task *task)
991
{
992
	dprintk("RPC: %5u release task\n", task->tk_pid);
L
Linus Torvalds 已提交
993 994 995

	BUG_ON (RPC_IS_QUEUED(task));

996
	rpc_release_resources_task(task);
997

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
	/*
	 * 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 已提交
1012 1013
}

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
int rpciod_up(void)
{
	return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
}

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

L
Linus Torvalds 已提交
1024
/*
1025
 * Start up the rpciod workqueue.
L
Linus Torvalds 已提交
1026
 */
1027
static int rpciod_start(void)
L
Linus Torvalds 已提交
1028 1029
{
	struct workqueue_struct *wq;
T
Trond Myklebust 已提交
1030

L
Linus Torvalds 已提交
1031 1032 1033
	/*
	 * Create the rpciod thread and wait for it to start.
	 */
T
Trond Myklebust 已提交
1034
	dprintk("RPC:       creating workqueue rpciod\n");
1035
	wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM, 1);
L
Linus Torvalds 已提交
1036
	rpciod_workqueue = wq;
1037
	return rpciod_workqueue != NULL;
L
Linus Torvalds 已提交
1038 1039
}

1040
static void rpciod_stop(void)
L
Linus Torvalds 已提交
1041
{
1042
	struct workqueue_struct *wq = NULL;
T
Trond Myklebust 已提交
1043

1044 1045
	if (rpciod_workqueue == NULL)
		return;
T
Trond Myklebust 已提交
1046
	dprintk("RPC:       destroying workqueue rpciod\n");
L
Linus Torvalds 已提交
1047

1048 1049 1050
	wq = rpciod_workqueue;
	rpciod_workqueue = NULL;
	destroy_workqueue(wq);
L
Linus Torvalds 已提交
1051 1052 1053 1054 1055
}

void
rpc_destroy_mempool(void)
{
1056
	rpciod_stop();
L
Linus Torvalds 已提交
1057 1058 1059 1060
	if (rpc_buffer_mempool)
		mempool_destroy(rpc_buffer_mempool);
	if (rpc_task_mempool)
		mempool_destroy(rpc_task_mempool);
1061 1062 1063 1064
	if (rpc_task_slabp)
		kmem_cache_destroy(rpc_task_slabp);
	if (rpc_buffer_slabp)
		kmem_cache_destroy(rpc_buffer_slabp);
1065
	rpc_destroy_wait_queue(&delay_queue);
L
Linus Torvalds 已提交
1066 1067 1068 1069 1070
}

int
rpc_init_mempool(void)
{
1071 1072 1073 1074 1075 1076 1077 1078
	/*
	 * 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 已提交
1079 1080 1081
	rpc_task_slabp = kmem_cache_create("rpc_tasks",
					     sizeof(struct rpc_task),
					     0, SLAB_HWCACHE_ALIGN,
1082
					     NULL);
L
Linus Torvalds 已提交
1083 1084 1085 1086 1087
	if (!rpc_task_slabp)
		goto err_nomem;
	rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
					     RPC_BUFFER_MAXSIZE,
					     0, SLAB_HWCACHE_ALIGN,
1088
					     NULL);
L
Linus Torvalds 已提交
1089 1090
	if (!rpc_buffer_slabp)
		goto err_nomem;
1091 1092
	rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
						    rpc_task_slabp);
L
Linus Torvalds 已提交
1093 1094
	if (!rpc_task_mempool)
		goto err_nomem;
1095 1096
	rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
						      rpc_buffer_slabp);
L
Linus Torvalds 已提交
1097 1098 1099 1100 1101 1102 1103
	if (!rpc_buffer_mempool)
		goto err_nomem;
	return 0;
err_nomem:
	rpc_destroy_mempool();
	return -ENOMEM;
}