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

#include <linux/module.h>

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

#include <linux/sunrpc/clnt.h>

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

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

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

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

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

/*
 * Disable the timer for a given RPC task. Should be called with
 * queue->lock and bh_disabled in order to avoid races within
 * rpc_run_timer().
 */
static inline void
__rpc_disable_timer(struct rpc_task *task)
{
63
	dprintk("RPC: %5u disabling timer\n", task->tk_pid);
L
Linus Torvalds 已提交
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
	task->tk_timeout_fn = NULL;
	task->tk_timeout = 0;
}

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

	callback = task->tk_timeout_fn;
	task->tk_timeout_fn = NULL;
	if (callback && RPC_IS_QUEUED(task)) {
82
		dprintk("RPC: %5u running timer\n", task->tk_pid);
L
Linus Torvalds 已提交
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
		callback(task);
	}
	smp_mb__before_clear_bit();
	clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
	smp_mb__after_clear_bit();
}

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

99
	dprintk("RPC: %5u setting alarm for %lu ms\n",
L
Linus Torvalds 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
			task->tk_pid, task->tk_timeout * 1000 / HZ);

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

/*
 * Delete any timer for the current task. Because we use del_timer_sync(),
 * this function should never be called while holding queue->lock.
 */
static void
rpc_delete_timer(struct rpc_task *task)
{
	if (RPC_IS_QUEUED(task))
		return;
	if (test_and_clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate)) {
		del_singleshot_timer_sync(&task->tk_timer);
121
		dprintk("RPC: %5u deleting timer\n", task->tk_pid);
L
Linus Torvalds 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
	}
}

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

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

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

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

168 169
	dprintk("RPC: %5u added to queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
}

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

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

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

	if (RPC_IS_PRIORITY(queue))
		__rpc_remove_wait_queue_priority(task);
	else
		list_del(&task->u.tk_wait.list);
200
	queue->qlen--;
201 202
	dprintk("RPC: %5u removed from queue %p \"%s\"\n",
			task->tk_pid, queue, rpc_qname(queue));
L
Linus Torvalds 已提交
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
}

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

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

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

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

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

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

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

248 249 250 251 252 253 254 255
static int rpc_wait_bit_interruptible(void *word)
{
	if (signal_pending(current))
		return -ERESTARTSYS;
	schedule();
	return 0;
}

256 257 258 259 260 261 262 263 264 265 266 267 268 269
#ifdef RPC_DEBUG
static void rpc_task_set_debuginfo(struct rpc_task *task)
{
	static atomic_t rpc_pid;

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

270 271
static void rpc_set_active(struct rpc_task *task)
{
272
	struct rpc_clnt *clnt;
273 274
	if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
		return;
275
	rpc_task_set_debuginfo(task);
276
	/* Add to global list of all tasks */
277 278 279 280 281 282
	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);
	}
283 284
}

285 286 287
/*
 * Mark an RPC call as having completed by clearing the 'active' bit
 */
288
static void rpc_mark_complete_task(struct rpc_task *task)
289
{
290 291 292
	smp_mb__before_clear_bit();
	clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
	smp_mb__after_clear_bit();
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
	wake_up_bit(&task->tk_runstate, RPC_TASK_ACTIVE);
}

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

L
Linus Torvalds 已提交
308 309 310
/*
 * Make an RPC task runnable.
 *
311
 * Note: If the task is ASYNC, this must be called with
L
Linus Torvalds 已提交
312 313 314 315 316 317
 * the spinlock held to protect the wait queue operation.
 */
static void rpc_make_runnable(struct rpc_task *task)
{
	BUG_ON(task->tk_timeout_fn);
	rpc_clear_queued(task);
318 319 320 321 322
	if (rpc_test_and_set_running(task))
		return;
	/* We might have raced */
	if (RPC_IS_QUEUED(task)) {
		rpc_clear_running(task);
L
Linus Torvalds 已提交
323
		return;
324
	}
L
Linus Torvalds 已提交
325 326 327
	if (RPC_IS_ASYNC(task)) {
		int status;

328
		INIT_WORK(&task->u.tk_work, rpc_async_schedule);
L
Linus Torvalds 已提交
329 330 331 332 333 334 335
		status = queue_work(task->tk_workqueue, &task->u.tk_work);
		if (status < 0) {
			printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
			task->tk_status = status;
			return;
		}
	} else
336
		wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
L
Linus Torvalds 已提交
337 338 339 340 341 342 343 344 345 346 347
}

/*
 * Prepare for sleeping on a wait queue.
 * By always appending tasks to the list we ensure FIFO behavior.
 * NB: An RPC task will only receive interrupt-driven events as long
 * as it's on a wait queue.
 */
static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
			rpc_action action, rpc_action timer)
{
348 349
	dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
			task->tk_pid, rpc_qname(q), jiffies);
L
Linus Torvalds 已提交
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

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

	__rpc_add_wait_queue(q, task);

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

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

L
Linus Torvalds 已提交
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
	/*
	 * Protect the queue operations.
	 */
	spin_lock_bh(&q->lock);
	__rpc_sleep_on(q, task, action, timer);
	spin_unlock_bh(&q->lock);
}

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

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

	__rpc_disable_timer(task);
	__rpc_remove_wait_queue(task);

	rpc_make_runnable(task);

402
	dprintk("RPC:       __rpc_wake_up_task done\n");
L
Linus Torvalds 已提交
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
}

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

/*
 * Default timeout handler if none specified by user
 */
static void
__rpc_default_timer(struct rpc_task *task)
{
423
	dprintk("RPC: %5u timeout (default timer)\n", task->tk_pid);
L
Linus Torvalds 已提交
424 425 426 427 428 429 430 431 432
	task->tk_status = -ETIMEDOUT;
	rpc_wake_up_task(task);
}

/*
 * Wake up the specified task
 */
void rpc_wake_up_task(struct rpc_task *task)
{
433
	rcu_read_lock_bh();
L
Linus Torvalds 已提交
434 435 436 437
	if (rpc_start_wakeup(task)) {
		if (RPC_IS_QUEUED(task)) {
			struct rpc_wait_queue *queue = task->u.tk_wait.rpc_waitq;

438 439
			/* Note: we're already in a bh-safe context */
			spin_lock(&queue->lock);
L
Linus Torvalds 已提交
440
			__rpc_do_wake_up_task(task);
441
			spin_unlock(&queue->lock);
L
Linus Torvalds 已提交
442 443 444
		}
		rpc_finish_wakeup(task);
	}
445
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
}

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

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

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

	rpc_reset_waitqueue_priority(queue);
	return NULL;

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

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

507 508
	dprintk("RPC:       wake_up_next(%p \"%s\")\n",
			queue, rpc_qname(queue));
509 510
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
511 512 513 514 515 516
	if (RPC_IS_PRIORITY(queue))
		task = __rpc_wake_up_next_priority(queue);
	else {
		task_for_first(task, &queue->tasks[0])
			__rpc_wake_up_task(task);
	}
517 518
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
519 520 521 522 523 524 525 526 527 528 529 530

	return task;
}

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

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

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

560 561
	rcu_read_lock_bh();
	spin_lock(&queue->lock);
L
Linus Torvalds 已提交
562 563
	head = &queue->tasks[queue->maxpriority];
	for (;;) {
564
		list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
L
Linus Torvalds 已提交
565 566 567 568 569 570 571
			task->tk_status = status;
			__rpc_wake_up_task(task);
		}
		if (head == &queue->tasks[0])
			break;
		head--;
	}
572 573
	spin_unlock(&queue->lock);
	rcu_read_unlock_bh();
L
Linus Torvalds 已提交
574 575
}

576 577 578 579 580
static void __rpc_atrun(struct rpc_task *task)
{
	rpc_wake_up_task(task);
}

L
Linus Torvalds 已提交
581 582 583
/*
 * Run a task at a later time
 */
584
void rpc_delay(struct rpc_task *task, unsigned long delay)
L
Linus Torvalds 已提交
585 586 587 588 589
{
	task->tk_timeout = delay;
	rpc_sleep_on(&delay_queue, task, NULL, __rpc_atrun);
}

T
Trond Myklebust 已提交
590 591 592 593 594
/*
 * Helper to call task->tk_ops->rpc_call_prepare
 */
static void rpc_prepare_task(struct rpc_task *task)
{
595
	lock_kernel();
T
Trond Myklebust 已提交
596
	task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
597
	unlock_kernel();
T
Trond Myklebust 已提交
598 599
}

600
/*
601
 * Helper that calls task->tk_ops->rpc_call_done if it exists
602
 */
T
Trond Myklebust 已提交
603
void rpc_exit_task(struct rpc_task *task)
604
{
T
Trond Myklebust 已提交
605
	task->tk_action = NULL;
606
	if (task->tk_ops->rpc_call_done != NULL) {
607
		lock_kernel();
608
		task->tk_ops->rpc_call_done(task, task->tk_calldata);
609
		unlock_kernel();
610
		if (task->tk_action != NULL) {
T
Trond Myklebust 已提交
611 612 613
			WARN_ON(RPC_ASSASSINATED(task));
			/* Always release the RPC slot and buffer memory */
			xprt_release(task);
614 615 616
		}
	}
}
T
Trond Myklebust 已提交
617
EXPORT_SYMBOL(rpc_exit_task);
618

619 620 621 622 623 624 625 626 627
void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
{
	if (ops->rpc_release != NULL) {
		lock_kernel();
		ops->rpc_release(calldata);
		unlock_kernel();
	}
}

L
Linus Torvalds 已提交
628 629 630
/*
 * This is the RPC `scheduler' (or rather, the finite state machine).
 */
T
Trond Myklebust 已提交
631
static void __rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
632 633 634
{
	int		status = 0;

635 636
	dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
			task->tk_pid, task->tk_flags);
L
Linus Torvalds 已提交
637 638 639

	BUG_ON(RPC_IS_QUEUED(task));

640
	for (;;) {
L
Linus Torvalds 已提交
641 642 643 644 645 646 647 648 649 650 651
		/*
		 * Garbage collection of pending timers...
		 */
		rpc_delete_timer(task);

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

			/*
L
Linus Torvalds 已提交
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
			 * If a callback exists, save it, reset it,
			 * call it.
			 * The save is needed to stop from resetting
			 * another callback set within the callback handler
			 * - Dave
			 */
			save_callback=task->tk_callback;
			task->tk_callback=NULL;
			save_callback(task);
		}

		/*
		 * Perform the next FSM step.
		 * tk_action may be NULL when the task has been killed
		 * by someone else.
		 */
		if (!RPC_IS_QUEUED(task)) {
T
Trond Myklebust 已提交
671
			if (task->tk_action == NULL)
L
Linus Torvalds 已提交
672
				break;
T
Trond Myklebust 已提交
673
			task->tk_action(task);
L
Linus Torvalds 已提交
674 675 676 677 678 679 680 681 682 683 684
		}

		/*
		 * Lockless check for whether task is sleeping or not.
		 */
		if (!RPC_IS_QUEUED(task))
			continue;
		rpc_clear_running(task);
		if (RPC_IS_ASYNC(task)) {
			/* Careful! we may have raced... */
			if (RPC_IS_QUEUED(task))
T
Trond Myklebust 已提交
685
				return;
L
Linus Torvalds 已提交
686
			if (rpc_test_and_set_running(task))
T
Trond Myklebust 已提交
687
				return;
L
Linus Torvalds 已提交
688 689 690 691
			continue;
		}

		/* sync task: sleep here */
692
		dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
693 694 695 696 697
		/* Note: Caller should be using rpc_clnt_sigmask() */
		status = out_of_line_wait_on_bit(&task->tk_runstate,
				RPC_TASK_QUEUED, rpc_wait_bit_interruptible,
				TASK_INTERRUPTIBLE);
		if (status == -ERESTARTSYS) {
L
Linus Torvalds 已提交
698 699 700 701 702 703
			/*
			 * 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.
			 */
704
			dprintk("RPC: %5u got signal\n", task->tk_pid);
705 706 707
			task->tk_flags |= RPC_TASK_KILLED;
			rpc_exit(task, -ERESTARTSYS);
			rpc_wake_up_task(task);
L
Linus Torvalds 已提交
708 709
		}
		rpc_set_running(task);
710
		dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
L
Linus Torvalds 已提交
711 712
	}

713 714
	dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
			task->tk_status);
L
Linus Torvalds 已提交
715 716 717 718 719 720 721 722 723 724 725 726 727
	/* 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 已提交
728
void rpc_execute(struct rpc_task *task)
L
Linus Torvalds 已提交
729
{
730
	rpc_set_active(task);
L
Linus Torvalds 已提交
731
	rpc_set_running(task);
T
Trond Myklebust 已提交
732
	__rpc_execute(task);
L
Linus Torvalds 已提交
733 734
}

735
static void rpc_async_schedule(struct work_struct *work)
L
Linus Torvalds 已提交
736
{
737
	__rpc_execute(container_of(work, struct rpc_task, u.tk_work));
L
Linus Torvalds 已提交
738 739
}

740 741 742 743 744
struct rpc_buffer {
	size_t	len;
	char	data[];
};

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

766
	size += sizeof(struct rpc_buffer);
767 768
	if (size <= RPC_BUFFER_MAXSIZE)
		buf = mempool_alloc(rpc_buffer_mempool, gfp);
L
Linus Torvalds 已提交
769
	else
770
		buf = kmalloc(size, gfp);
771 772 773 774

	if (!buf)
		return NULL;

775
	buf->len = size;
G
Geert Uytterhoeven 已提交
776
	dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
777
			task->tk_pid, size, buf);
778
	return &buf->data;
L
Linus Torvalds 已提交
779 780
}

781 782
/**
 * rpc_free - free buffer allocated via rpc_malloc
783
 * @buffer: buffer to free
784 785
 *
 */
786
void rpc_free(void *buffer)
L
Linus Torvalds 已提交
787
{
788 789
	size_t size;
	struct rpc_buffer *buf;
790

791 792
	if (!buffer)
		return;
793 794 795

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

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

800 801 802 803
	if (size <= RPC_BUFFER_MAXSIZE)
		mempool_free(buf, rpc_buffer_mempool);
	else
		kfree(buf);
L
Linus Torvalds 已提交
804 805 806 807 808
}

/*
 * Creation and deletion of RPC task structures
 */
809
void rpc_init_task(struct rpc_task *task, struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
L
Linus Torvalds 已提交
810 811 812 813 814
{
	memset(task, 0, sizeof(*task));
	init_timer(&task->tk_timer);
	task->tk_timer.data     = (unsigned long) task;
	task->tk_timer.function = (void (*)(unsigned long)) rpc_run_timer;
815
	atomic_set(&task->tk_count, 1);
L
Linus Torvalds 已提交
816 817
	task->tk_client = clnt;
	task->tk_flags  = flags;
818
	task->tk_ops = tk_ops;
T
Trond Myklebust 已提交
819 820
	if (tk_ops->rpc_call_prepare != NULL)
		task->tk_action = rpc_prepare_task;
821
	task->tk_calldata = calldata;
822
	INIT_LIST_HEAD(&task->tk_task);
L
Linus Torvalds 已提交
823 824 825 826 827 828 829 830 831 832 833 834

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

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

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

	if (clnt) {
835
		kref_get(&clnt->cl_kref);
L
Linus Torvalds 已提交
836 837 838 839 840 841
		if (clnt->cl_softrtry)
			task->tk_flags |= RPC_TASK_SOFT;
		if (!clnt->cl_intr)
			task->tk_flags |= RPC_TASK_NOINTR;
	}

842 843
	BUG_ON(task->tk_ops == NULL);

844 845 846
	/* starting timestamp */
	task->tk_start = jiffies;

847
	dprintk("RPC:       new task initialized, procpid %u\n",
L
Linus Torvalds 已提交
848 849 850 851 852 853 854 855 856
				current->pid);
}

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

857
static void rpc_free_task(struct rcu_head *rcu)
L
Linus Torvalds 已提交
858
{
859
	struct rpc_task *task = container_of(rcu, struct rpc_task, u.tk_rcu);
860
	dprintk("RPC: %5u freeing task\n", task->tk_pid);
L
Linus Torvalds 已提交
861 862 863 864
	mempool_free(task, rpc_task_mempool);
}

/*
865
 * Create a new task for the specified client.
L
Linus Torvalds 已提交
866
 */
867
struct rpc_task *rpc_new_task(struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
L
Linus Torvalds 已提交
868 869 870 871 872
{
	struct rpc_task	*task;

	task = rpc_alloc_task();
	if (!task)
873
		goto out;
L
Linus Torvalds 已提交
874

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

877
	dprintk("RPC:       allocated task %p\n", task);
L
Linus Torvalds 已提交
878 879 880 881 882
	task->tk_flags |= RPC_TASK_DYNAMIC;
out:
	return task;
}

883 884

void rpc_put_task(struct rpc_task *task)
L
Linus Torvalds 已提交
885
{
886 887
	const struct rpc_call_ops *tk_ops = task->tk_ops;
	void *calldata = task->tk_calldata;
L
Linus Torvalds 已提交
888

889 890 891 892 893 894 895 896 897 898 899 900
	if (!atomic_dec_and_test(&task->tk_count))
		return;
	/* Release resources */
	if (task->tk_rqstp)
		xprt_release(task);
	if (task->tk_msg.rpc_cred)
		rpcauth_unbindcred(task);
	if (task->tk_client) {
		rpc_release_client(task->tk_client);
		task->tk_client = NULL;
	}
	if (task->tk_flags & RPC_TASK_DYNAMIC)
901
		call_rcu_bh(&task->u.tk_rcu, rpc_free_task);
902
	rpc_release_calldata(tk_ops, calldata);
903 904 905
}
EXPORT_SYMBOL(rpc_put_task);

906
static void rpc_release_task(struct rpc_task *task)
907
{
L
Linus Torvalds 已提交
908 909 910
#ifdef RPC_DEBUG
	BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
#endif
911
	dprintk("RPC: %5u release task\n", task->tk_pid);
L
Linus Torvalds 已提交
912

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

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

#ifdef RPC_DEBUG
	task->tk_magic = 0;
#endif
928 929 930 931
	/* Wake up anyone who is waiting for task completion */
	rpc_mark_complete_task(task);

	rpc_put_task(task);
L
Linus Torvalds 已提交
932 933 934 935 936 937
}

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


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

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

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

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

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

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

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

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

void
rpc_destroy_mempool(void)
{
1004
	rpciod_stop();
L
Linus Torvalds 已提交
1005 1006 1007 1008
	if (rpc_buffer_mempool)
		mempool_destroy(rpc_buffer_mempool);
	if (rpc_task_mempool)
		mempool_destroy(rpc_task_mempool);
1009 1010 1011 1012
	if (rpc_task_slabp)
		kmem_cache_destroy(rpc_task_slabp);
	if (rpc_buffer_slabp)
		kmem_cache_destroy(rpc_buffer_slabp);
L
Linus Torvalds 已提交
1013 1014 1015 1016 1017 1018 1019 1020
}

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