blob: cd51b54683323cad7988c2b835714c2bb738c567 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/net/sunrpc/sched.c
3 *
4 * Scheduling for synchronous and asynchronous RPC requests.
5 *
6 * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
7 *
8 * TCP NFS related read + write fixes
9 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
10 */
11
12#include <linux/module.h>
13
14#include <linux/sched.h>
15#include <linux/interrupt.h>
16#include <linux/slab.h>
17#include <linux/mempool.h>
18#include <linux/smp.h>
19#include <linux/smp_lock.h>
20#include <linux/spinlock.h>
21
22#include <linux/sunrpc/clnt.h>
23#include <linux/sunrpc/xprt.h>
24
25#ifdef RPC_DEBUG
26#define RPCDBG_FACILITY RPCDBG_SCHED
27#define RPC_TASK_MAGIC_ID 0xf00baa
28static int rpc_task_id;
29#endif
30
31/*
32 * RPC slabs and memory pools
33 */
34#define RPC_BUFFER_MAXSIZE (2048)
35#define RPC_BUFFER_POOLSIZE (8)
36#define RPC_TASK_POOLSIZE (8)
Eric Dumazetba899662005-08-26 12:05:31 -070037static kmem_cache_t *rpc_task_slabp __read_mostly;
38static kmem_cache_t *rpc_buffer_slabp __read_mostly;
39static mempool_t *rpc_task_mempool __read_mostly;
40static mempool_t *rpc_buffer_mempool __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42static void __rpc_default_timer(struct rpc_task *task);
43static void rpciod_killall(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044static void rpc_async_schedule(void *);
45
46/*
47 * RPC tasks that create another task (e.g. for contacting the portmapper)
48 * will wait on this queue for their child's completion
49 */
50static RPC_WAITQ(childq, "childq");
51
52/*
53 * RPC tasks sit here while waiting for conditions to improve.
54 */
55static RPC_WAITQ(delay_queue, "delayq");
56
57/*
58 * All RPC tasks are linked into this list
59 */
60static LIST_HEAD(all_tasks);
61
62/*
63 * rpciod-related stuff
64 */
65static DECLARE_MUTEX(rpciod_sema);
66static unsigned int rpciod_users;
Trond Myklebust24c5d9d2006-03-20 13:44:08 -050067struct workqueue_struct *rpciod_workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69/*
70 * Spinlock for other critical sections of code.
71 */
72static DEFINE_SPINLOCK(rpc_sched_lock);
73
74/*
75 * Disable the timer for a given RPC task. Should be called with
76 * queue->lock and bh_disabled in order to avoid races within
77 * rpc_run_timer().
78 */
79static inline void
80__rpc_disable_timer(struct rpc_task *task)
81{
82 dprintk("RPC: %4d disabling timer\n", task->tk_pid);
83 task->tk_timeout_fn = NULL;
84 task->tk_timeout = 0;
85}
86
87/*
88 * Run a timeout function.
89 * We use the callback in order to allow __rpc_wake_up_task()
90 * and friends to disable the timer synchronously on SMP systems
91 * without calling del_timer_sync(). The latter could cause a
92 * deadlock if called while we're holding spinlocks...
93 */
94static void rpc_run_timer(struct rpc_task *task)
95{
96 void (*callback)(struct rpc_task *);
97
98 callback = task->tk_timeout_fn;
99 task->tk_timeout_fn = NULL;
100 if (callback && RPC_IS_QUEUED(task)) {
101 dprintk("RPC: %4d running timer\n", task->tk_pid);
102 callback(task);
103 }
104 smp_mb__before_clear_bit();
105 clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
106 smp_mb__after_clear_bit();
107}
108
109/*
110 * Set up a timer for the current task.
111 */
112static inline void
113__rpc_add_timer(struct rpc_task *task, rpc_action timer)
114{
115 if (!task->tk_timeout)
116 return;
117
118 dprintk("RPC: %4d setting alarm for %lu ms\n",
119 task->tk_pid, task->tk_timeout * 1000 / HZ);
120
121 if (timer)
122 task->tk_timeout_fn = timer;
123 else
124 task->tk_timeout_fn = __rpc_default_timer;
125 set_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
126 mod_timer(&task->tk_timer, jiffies + task->tk_timeout);
127}
128
129/*
130 * Delete any timer for the current task. Because we use del_timer_sync(),
131 * this function should never be called while holding queue->lock.
132 */
133static void
134rpc_delete_timer(struct rpc_task *task)
135{
136 if (RPC_IS_QUEUED(task))
137 return;
138 if (test_and_clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate)) {
139 del_singleshot_timer_sync(&task->tk_timer);
140 dprintk("RPC: %4d deleting timer\n", task->tk_pid);
141 }
142}
143
144/*
145 * Add new request to a priority queue.
146 */
147static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue, struct rpc_task *task)
148{
149 struct list_head *q;
150 struct rpc_task *t;
151
152 INIT_LIST_HEAD(&task->u.tk_wait.links);
153 q = &queue->tasks[task->tk_priority];
154 if (unlikely(task->tk_priority > queue->maxpriority))
155 q = &queue->tasks[queue->maxpriority];
156 list_for_each_entry(t, q, u.tk_wait.list) {
157 if (t->tk_cookie == task->tk_cookie) {
158 list_add_tail(&task->u.tk_wait.list, &t->u.tk_wait.links);
159 return;
160 }
161 }
162 list_add_tail(&task->u.tk_wait.list, q);
163}
164
165/*
166 * Add new request to wait queue.
167 *
168 * Swapper tasks always get inserted at the head of the queue.
169 * This should avoid many nasty memory deadlocks and hopefully
170 * improve overall performance.
171 * Everyone else gets appended to the queue to ensure proper FIFO behavior.
172 */
173static void __rpc_add_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
174{
175 BUG_ON (RPC_IS_QUEUED(task));
176
177 if (RPC_IS_PRIORITY(queue))
178 __rpc_add_wait_queue_priority(queue, task);
179 else if (RPC_IS_SWAPPER(task))
180 list_add(&task->u.tk_wait.list, &queue->tasks[0]);
181 else
182 list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
183 task->u.tk_wait.rpc_waitq = queue;
Chuck Levere19b63d2006-03-20 13:44:15 -0500184 queue->qlen++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 rpc_set_queued(task);
186
187 dprintk("RPC: %4d added to queue %p \"%s\"\n",
188 task->tk_pid, queue, rpc_qname(queue));
189}
190
191/*
192 * Remove request from a priority queue.
193 */
194static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
195{
196 struct rpc_task *t;
197
198 if (!list_empty(&task->u.tk_wait.links)) {
199 t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
200 list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
201 list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
202 }
203 list_del(&task->u.tk_wait.list);
204}
205
206/*
207 * Remove request from queue.
208 * Note: must be called with spin lock held.
209 */
210static void __rpc_remove_wait_queue(struct rpc_task *task)
211{
212 struct rpc_wait_queue *queue;
213 queue = task->u.tk_wait.rpc_waitq;
214
215 if (RPC_IS_PRIORITY(queue))
216 __rpc_remove_wait_queue_priority(task);
217 else
218 list_del(&task->u.tk_wait.list);
Chuck Levere19b63d2006-03-20 13:44:15 -0500219 queue->qlen--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 dprintk("RPC: %4d removed from queue %p \"%s\"\n",
221 task->tk_pid, queue, rpc_qname(queue));
222}
223
224static inline void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
225{
226 queue->priority = priority;
227 queue->count = 1 << (priority * 2);
228}
229
230static inline void rpc_set_waitqueue_cookie(struct rpc_wait_queue *queue, unsigned long cookie)
231{
232 queue->cookie = cookie;
233 queue->nr = RPC_BATCH_COUNT;
234}
235
236static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
237{
238 rpc_set_waitqueue_priority(queue, queue->maxpriority);
239 rpc_set_waitqueue_cookie(queue, 0);
240}
241
242static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, int maxprio)
243{
244 int i;
245
246 spin_lock_init(&queue->lock);
247 for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
248 INIT_LIST_HEAD(&queue->tasks[i]);
249 queue->maxpriority = maxprio;
250 rpc_reset_waitqueue_priority(queue);
251#ifdef RPC_DEBUG
252 queue->name = qname;
253#endif
254}
255
256void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
257{
258 __rpc_init_priority_wait_queue(queue, qname, RPC_PRIORITY_HIGH);
259}
260
261void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
262{
263 __rpc_init_priority_wait_queue(queue, qname, 0);
264}
265EXPORT_SYMBOL(rpc_init_wait_queue);
266
Trond Myklebust44c28872006-01-03 09:55:06 +0100267static int rpc_wait_bit_interruptible(void *word)
268{
269 if (signal_pending(current))
270 return -ERESTARTSYS;
271 schedule();
272 return 0;
273}
274
275/*
276 * Mark an RPC call as having completed by clearing the 'active' bit
277 */
278static inline void rpc_mark_complete_task(struct rpc_task *task)
279{
280 rpc_clear_active(task);
281 wake_up_bit(&task->tk_runstate, RPC_TASK_ACTIVE);
282}
283
284/*
285 * Allow callers to wait for completion of an RPC call
286 */
287int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
288{
289 if (action == NULL)
290 action = rpc_wait_bit_interruptible;
291 return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
292 action, TASK_INTERRUPTIBLE);
293}
294EXPORT_SYMBOL(__rpc_wait_for_completion_task);
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296/*
297 * Make an RPC task runnable.
298 *
299 * Note: If the task is ASYNC, this must be called with
300 * the spinlock held to protect the wait queue operation.
301 */
302static void rpc_make_runnable(struct rpc_task *task)
303{
304 int do_ret;
305
306 BUG_ON(task->tk_timeout_fn);
307 do_ret = rpc_test_and_set_running(task);
308 rpc_clear_queued(task);
309 if (do_ret)
310 return;
311 if (RPC_IS_ASYNC(task)) {
312 int status;
313
314 INIT_WORK(&task->u.tk_work, rpc_async_schedule, (void *)task);
315 status = queue_work(task->tk_workqueue, &task->u.tk_work);
316 if (status < 0) {
317 printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
318 task->tk_status = status;
319 return;
320 }
321 } else
Trond Myklebust96651ab2005-06-22 17:16:21 +0000322 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323}
324
325/*
326 * Place a newly initialized task on the workqueue.
327 */
328static inline void
329rpc_schedule_run(struct rpc_task *task)
330{
Trond Myklebust44c28872006-01-03 09:55:06 +0100331 rpc_set_active(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 rpc_make_runnable(task);
333}
334
335/*
336 * Prepare for sleeping on a wait queue.
337 * By always appending tasks to the list we ensure FIFO behavior.
338 * NB: An RPC task will only receive interrupt-driven events as long
339 * as it's on a wait queue.
340 */
341static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
342 rpc_action action, rpc_action timer)
343{
344 dprintk("RPC: %4d sleep_on(queue \"%s\" time %ld)\n", task->tk_pid,
345 rpc_qname(q), jiffies);
346
347 if (!RPC_IS_ASYNC(task) && !RPC_IS_ACTIVATED(task)) {
348 printk(KERN_ERR "RPC: Inactive synchronous task put to sleep!\n");
349 return;
350 }
351
352 /* Mark the task as being activated if so needed */
Trond Myklebust44c28872006-01-03 09:55:06 +0100353 rpc_set_active(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355 __rpc_add_wait_queue(q, task);
356
357 BUG_ON(task->tk_callback != NULL);
358 task->tk_callback = action;
359 __rpc_add_timer(task, timer);
360}
361
362void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
363 rpc_action action, rpc_action timer)
364{
365 /*
366 * Protect the queue operations.
367 */
368 spin_lock_bh(&q->lock);
369 __rpc_sleep_on(q, task, action, timer);
370 spin_unlock_bh(&q->lock);
371}
372
373/**
374 * __rpc_do_wake_up_task - wake up a single rpc_task
375 * @task: task to be woken up
376 *
377 * Caller must hold queue->lock, and have cleared the task queued flag.
378 */
379static void __rpc_do_wake_up_task(struct rpc_task *task)
380{
381 dprintk("RPC: %4d __rpc_wake_up_task (now %ld)\n", task->tk_pid, jiffies);
382
383#ifdef RPC_DEBUG
384 BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
385#endif
386 /* Has the task been executed yet? If not, we cannot wake it up! */
387 if (!RPC_IS_ACTIVATED(task)) {
388 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
389 return;
390 }
391
392 __rpc_disable_timer(task);
393 __rpc_remove_wait_queue(task);
394
395 rpc_make_runnable(task);
396
397 dprintk("RPC: __rpc_wake_up_task done\n");
398}
399
400/*
401 * Wake up the specified task
402 */
403static void __rpc_wake_up_task(struct rpc_task *task)
404{
405 if (rpc_start_wakeup(task)) {
406 if (RPC_IS_QUEUED(task))
407 __rpc_do_wake_up_task(task);
408 rpc_finish_wakeup(task);
409 }
410}
411
412/*
413 * Default timeout handler if none specified by user
414 */
415static void
416__rpc_default_timer(struct rpc_task *task)
417{
418 dprintk("RPC: %d timeout (default timer)\n", task->tk_pid);
419 task->tk_status = -ETIMEDOUT;
420 rpc_wake_up_task(task);
421}
422
423/*
424 * Wake up the specified task
425 */
426void rpc_wake_up_task(struct rpc_task *task)
427{
428 if (rpc_start_wakeup(task)) {
429 if (RPC_IS_QUEUED(task)) {
430 struct rpc_wait_queue *queue = task->u.tk_wait.rpc_waitq;
431
432 spin_lock_bh(&queue->lock);
433 __rpc_do_wake_up_task(task);
434 spin_unlock_bh(&queue->lock);
435 }
436 rpc_finish_wakeup(task);
437 }
438}
439
440/*
441 * Wake up the next task on a priority queue.
442 */
443static struct rpc_task * __rpc_wake_up_next_priority(struct rpc_wait_queue *queue)
444{
445 struct list_head *q;
446 struct rpc_task *task;
447
448 /*
449 * Service a batch of tasks from a single cookie.
450 */
451 q = &queue->tasks[queue->priority];
452 if (!list_empty(q)) {
453 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
454 if (queue->cookie == task->tk_cookie) {
455 if (--queue->nr)
456 goto out;
457 list_move_tail(&task->u.tk_wait.list, q);
458 }
459 /*
460 * Check if we need to switch queues.
461 */
462 if (--queue->count)
463 goto new_cookie;
464 }
465
466 /*
467 * Service the next queue.
468 */
469 do {
470 if (q == &queue->tasks[0])
471 q = &queue->tasks[queue->maxpriority];
472 else
473 q = q - 1;
474 if (!list_empty(q)) {
475 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
476 goto new_queue;
477 }
478 } while (q != &queue->tasks[queue->priority]);
479
480 rpc_reset_waitqueue_priority(queue);
481 return NULL;
482
483new_queue:
484 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
485new_cookie:
486 rpc_set_waitqueue_cookie(queue, task->tk_cookie);
487out:
488 __rpc_wake_up_task(task);
489 return task;
490}
491
492/*
493 * Wake up the next task on the wait queue.
494 */
495struct rpc_task * rpc_wake_up_next(struct rpc_wait_queue *queue)
496{
497 struct rpc_task *task = NULL;
498
499 dprintk("RPC: wake_up_next(%p \"%s\")\n", queue, rpc_qname(queue));
500 spin_lock_bh(&queue->lock);
501 if (RPC_IS_PRIORITY(queue))
502 task = __rpc_wake_up_next_priority(queue);
503 else {
504 task_for_first(task, &queue->tasks[0])
505 __rpc_wake_up_task(task);
506 }
507 spin_unlock_bh(&queue->lock);
508
509 return task;
510}
511
512/**
513 * rpc_wake_up - wake up all rpc_tasks
514 * @queue: rpc_wait_queue on which the tasks are sleeping
515 *
516 * Grabs queue->lock
517 */
518void rpc_wake_up(struct rpc_wait_queue *queue)
519{
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800520 struct rpc_task *task, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 struct list_head *head;
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 spin_lock_bh(&queue->lock);
524 head = &queue->tasks[queue->maxpriority];
525 for (;;) {
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800526 list_for_each_entry_safe(task, next, head, u.tk_wait.list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 __rpc_wake_up_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 if (head == &queue->tasks[0])
529 break;
530 head--;
531 }
532 spin_unlock_bh(&queue->lock);
533}
534
535/**
536 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
537 * @queue: rpc_wait_queue on which the tasks are sleeping
538 * @status: status value to set
539 *
540 * Grabs queue->lock
541 */
542void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
543{
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800544 struct rpc_task *task, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 struct list_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
547 spin_lock_bh(&queue->lock);
548 head = &queue->tasks[queue->maxpriority];
549 for (;;) {
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800550 list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 task->tk_status = status;
552 __rpc_wake_up_task(task);
553 }
554 if (head == &queue->tasks[0])
555 break;
556 head--;
557 }
558 spin_unlock_bh(&queue->lock);
559}
560
561/*
562 * Run a task at a later time
563 */
564static void __rpc_atrun(struct rpc_task *);
565void
566rpc_delay(struct rpc_task *task, unsigned long delay)
567{
568 task->tk_timeout = delay;
569 rpc_sleep_on(&delay_queue, task, NULL, __rpc_atrun);
570}
571
572static void
573__rpc_atrun(struct rpc_task *task)
574{
575 task->tk_status = 0;
576 rpc_wake_up_task(task);
577}
578
579/*
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100580 * Helper to call task->tk_ops->rpc_call_prepare
581 */
582static void rpc_prepare_task(struct rpc_task *task)
583{
584 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
585}
586
587/*
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100588 * Helper that calls task->tk_ops->rpc_call_done if it exists
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000589 */
Trond Myklebustabbcf282006-01-03 09:55:03 +0100590void rpc_exit_task(struct rpc_task *task)
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000591{
Trond Myklebustabbcf282006-01-03 09:55:03 +0100592 task->tk_action = NULL;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100593 if (task->tk_ops->rpc_call_done != NULL) {
594 task->tk_ops->rpc_call_done(task, task->tk_calldata);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000595 if (task->tk_action != NULL) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100596 WARN_ON(RPC_ASSASSINATED(task));
597 /* Always release the RPC slot and buffer memory */
598 xprt_release(task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000599 }
600 }
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000601}
Trond Myklebustabbcf282006-01-03 09:55:03 +0100602EXPORT_SYMBOL(rpc_exit_task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000603
604/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 * This is the RPC `scheduler' (or rather, the finite state machine).
606 */
607static int __rpc_execute(struct rpc_task *task)
608{
609 int status = 0;
610
611 dprintk("RPC: %4d rpc_execute flgs %x\n",
612 task->tk_pid, task->tk_flags);
613
614 BUG_ON(RPC_IS_QUEUED(task));
615
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000616 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 /*
618 * Garbage collection of pending timers...
619 */
620 rpc_delete_timer(task);
621
622 /*
623 * Execute any pending callback.
624 */
625 if (RPC_DO_CALLBACK(task)) {
626 /* Define a callback save pointer */
627 void (*save_callback)(struct rpc_task *);
628
629 /*
630 * If a callback exists, save it, reset it,
631 * call it.
632 * The save is needed to stop from resetting
633 * another callback set within the callback handler
634 * - Dave
635 */
636 save_callback=task->tk_callback;
637 task->tk_callback=NULL;
638 lock_kernel();
639 save_callback(task);
640 unlock_kernel();
641 }
642
643 /*
644 * Perform the next FSM step.
645 * tk_action may be NULL when the task has been killed
646 * by someone else.
647 */
648 if (!RPC_IS_QUEUED(task)) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100649 if (task->tk_action == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 break;
Trond Myklebustabbcf282006-01-03 09:55:03 +0100651 lock_kernel();
652 task->tk_action(task);
653 unlock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 }
655
656 /*
657 * Lockless check for whether task is sleeping or not.
658 */
659 if (!RPC_IS_QUEUED(task))
660 continue;
661 rpc_clear_running(task);
662 if (RPC_IS_ASYNC(task)) {
663 /* Careful! we may have raced... */
664 if (RPC_IS_QUEUED(task))
665 return 0;
666 if (rpc_test_and_set_running(task))
667 return 0;
668 continue;
669 }
670
671 /* sync task: sleep here */
672 dprintk("RPC: %4d sync task going to sleep\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000673 /* Note: Caller should be using rpc_clnt_sigmask() */
674 status = out_of_line_wait_on_bit(&task->tk_runstate,
675 RPC_TASK_QUEUED, rpc_wait_bit_interruptible,
676 TASK_INTERRUPTIBLE);
677 if (status == -ERESTARTSYS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 /*
679 * When a sync task receives a signal, it exits with
680 * -ERESTARTSYS. In order to catch any callbacks that
681 * clean up after sleeping on some queue, we don't
682 * break the loop here, but go around once more.
683 */
Trond Myklebust96651ab2005-06-22 17:16:21 +0000684 dprintk("RPC: %4d got signal\n", task->tk_pid);
685 task->tk_flags |= RPC_TASK_KILLED;
686 rpc_exit(task, -ERESTARTSYS);
687 rpc_wake_up_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 }
689 rpc_set_running(task);
690 dprintk("RPC: %4d sync task resuming\n", task->tk_pid);
691 }
692
Trond Myklebuste60859a2006-01-03 09:55:10 +0100693 dprintk("RPC: %4d, return %d, status %d\n", task->tk_pid, status, task->tk_status);
Trond Myklebust44c28872006-01-03 09:55:06 +0100694 /* Wake up anyone who is waiting for task completion */
695 rpc_mark_complete_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 /* Release all resources associated with the task */
697 rpc_release_task(task);
698 return status;
699}
700
701/*
702 * User-visible entry point to the scheduler.
703 *
704 * This may be called recursively if e.g. an async NFS task updates
705 * the attributes and finds that dirty pages must be flushed.
706 * NOTE: Upon exit of this function the task is guaranteed to be
707 * released. In particular note that tk_release() will have
708 * been called, so your task memory may have been freed.
709 */
710int
711rpc_execute(struct rpc_task *task)
712{
Trond Myklebust44c28872006-01-03 09:55:06 +0100713 rpc_set_active(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 rpc_set_running(task);
715 return __rpc_execute(task);
716}
717
718static void rpc_async_schedule(void *arg)
719{
720 __rpc_execute((struct rpc_task *)arg);
721}
722
Chuck Lever02107142006-01-03 09:55:49 +0100723/**
724 * rpc_malloc - allocate an RPC buffer
725 * @task: RPC task that will use this buffer
726 * @size: requested byte size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 *
728 * We try to ensure that some NFS reads and writes can always proceed
729 * by using a mempool when allocating 'small' buffers.
730 * In order to avoid memory starvation triggering more writebacks of
731 * NFS requests, we use GFP_NOFS rather than GFP_KERNEL.
732 */
Chuck Lever02107142006-01-03 09:55:49 +0100733void * rpc_malloc(struct rpc_task *task, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
Chuck Lever02107142006-01-03 09:55:49 +0100735 struct rpc_rqst *req = task->tk_rqstp;
Al Virodd0fc662005-10-07 07:46:04 +0100736 gfp_t gfp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738 if (task->tk_flags & RPC_TASK_SWAPPER)
739 gfp = GFP_ATOMIC;
740 else
741 gfp = GFP_NOFS;
742
743 if (size > RPC_BUFFER_MAXSIZE) {
Chuck Lever02107142006-01-03 09:55:49 +0100744 req->rq_buffer = kmalloc(size, gfp);
745 if (req->rq_buffer)
746 req->rq_bufsize = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 } else {
Chuck Lever02107142006-01-03 09:55:49 +0100748 req->rq_buffer = mempool_alloc(rpc_buffer_mempool, gfp);
749 if (req->rq_buffer)
750 req->rq_bufsize = RPC_BUFFER_MAXSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 }
Chuck Lever02107142006-01-03 09:55:49 +0100752 return req->rq_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753}
754
Chuck Lever02107142006-01-03 09:55:49 +0100755/**
756 * rpc_free - free buffer allocated via rpc_malloc
757 * @task: RPC task with a buffer to be freed
758 *
759 */
760void rpc_free(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
Chuck Lever02107142006-01-03 09:55:49 +0100762 struct rpc_rqst *req = task->tk_rqstp;
763
764 if (req->rq_buffer) {
765 if (req->rq_bufsize == RPC_BUFFER_MAXSIZE)
766 mempool_free(req->rq_buffer, rpc_buffer_mempool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 else
Chuck Lever02107142006-01-03 09:55:49 +0100768 kfree(req->rq_buffer);
769 req->rq_buffer = NULL;
770 req->rq_bufsize = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 }
772}
773
774/*
775 * Creation and deletion of RPC task structures
776 */
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100777void rpc_init_task(struct rpc_task *task, struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778{
779 memset(task, 0, sizeof(*task));
780 init_timer(&task->tk_timer);
781 task->tk_timer.data = (unsigned long) task;
782 task->tk_timer.function = (void (*)(unsigned long)) rpc_run_timer;
Trond Myklebust44c28872006-01-03 09:55:06 +0100783 atomic_set(&task->tk_count, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 task->tk_client = clnt;
785 task->tk_flags = flags;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100786 task->tk_ops = tk_ops;
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100787 if (tk_ops->rpc_call_prepare != NULL)
788 task->tk_action = rpc_prepare_task;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100789 task->tk_calldata = calldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
791 /* Initialize retry counters */
792 task->tk_garb_retry = 2;
793 task->tk_cred_retry = 2;
794
795 task->tk_priority = RPC_PRIORITY_NORMAL;
796 task->tk_cookie = (unsigned long)current;
797
798 /* Initialize workqueue for async tasks */
799 task->tk_workqueue = rpciod_workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
801 if (clnt) {
802 atomic_inc(&clnt->cl_users);
803 if (clnt->cl_softrtry)
804 task->tk_flags |= RPC_TASK_SOFT;
805 if (!clnt->cl_intr)
806 task->tk_flags |= RPC_TASK_NOINTR;
807 }
808
809#ifdef RPC_DEBUG
810 task->tk_magic = RPC_TASK_MAGIC_ID;
811 task->tk_pid = rpc_task_id++;
812#endif
813 /* Add to global list of all tasks */
814 spin_lock(&rpc_sched_lock);
815 list_add_tail(&task->tk_task, &all_tasks);
816 spin_unlock(&rpc_sched_lock);
817
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100818 BUG_ON(task->tk_ops == NULL);
819
Chuck Leveref759a22006-03-20 13:44:17 -0500820 /* starting timestamp */
821 task->tk_start = jiffies;
822
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 dprintk("RPC: %4d new task procpid %d\n", task->tk_pid,
824 current->pid);
825}
826
827static struct rpc_task *
828rpc_alloc_task(void)
829{
830 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
831}
832
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100833static void rpc_free_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
835 dprintk("RPC: %4d freeing task\n", task->tk_pid);
836 mempool_free(task, rpc_task_mempool);
837}
838
839/*
840 * Create a new task for the specified client. We have to
841 * clean up after an allocation failure, as the client may
842 * have specified "oneshot".
843 */
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100844struct rpc_task *rpc_new_task(struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845{
846 struct rpc_task *task;
847
848 task = rpc_alloc_task();
849 if (!task)
850 goto cleanup;
851
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100852 rpc_init_task(task, clnt, flags, tk_ops, calldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
854 dprintk("RPC: %4d allocated task\n", task->tk_pid);
855 task->tk_flags |= RPC_TASK_DYNAMIC;
856out:
857 return task;
858
859cleanup:
860 /* Check whether to release the client */
861 if (clnt) {
862 printk("rpc_new_task: failed, users=%d, oneshot=%d\n",
863 atomic_read(&clnt->cl_users), clnt->cl_oneshot);
864 atomic_inc(&clnt->cl_users); /* pretend we were used ... */
865 rpc_release_client(clnt);
866 }
867 goto out;
868}
869
870void rpc_release_task(struct rpc_task *task)
871{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100872 const struct rpc_call_ops *tk_ops = task->tk_ops;
873 void *calldata = task->tk_calldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875#ifdef RPC_DEBUG
876 BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
877#endif
Trond Myklebust44c28872006-01-03 09:55:06 +0100878 if (!atomic_dec_and_test(&task->tk_count))
879 return;
880 dprintk("RPC: %4d release task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
882 /* Remove from global task list */
883 spin_lock(&rpc_sched_lock);
884 list_del(&task->tk_task);
885 spin_unlock(&rpc_sched_lock);
886
887 BUG_ON (RPC_IS_QUEUED(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
889 /* Synchronously delete any running timer */
890 rpc_delete_timer(task);
891
892 /* Release resources */
893 if (task->tk_rqstp)
894 xprt_release(task);
895 if (task->tk_msg.rpc_cred)
896 rpcauth_unbindcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 if (task->tk_client) {
898 rpc_release_client(task->tk_client);
899 task->tk_client = NULL;
900 }
901
902#ifdef RPC_DEBUG
903 task->tk_magic = 0;
904#endif
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100905 if (task->tk_flags & RPC_TASK_DYNAMIC)
906 rpc_free_task(task);
907 if (tk_ops->rpc_release)
908 tk_ops->rpc_release(calldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909}
910
911/**
Trond Myklebust44c28872006-01-03 09:55:06 +0100912 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
Martin Waitz99acf042006-02-01 03:06:56 -0800913 * @clnt: pointer to RPC client
914 * @flags: RPC flags
915 * @ops: RPC call ops
916 * @data: user call data
Trond Myklebust44c28872006-01-03 09:55:06 +0100917 */
918struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
919 const struct rpc_call_ops *ops,
920 void *data)
921{
922 struct rpc_task *task;
923 task = rpc_new_task(clnt, flags, ops, data);
924 if (task == NULL)
925 return ERR_PTR(-ENOMEM);
926 atomic_inc(&task->tk_count);
927 rpc_execute(task);
928 return task;
929}
930EXPORT_SYMBOL(rpc_run_task);
931
932/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 * rpc_find_parent - find the parent of a child task.
934 * @child: child task
Martin Waitz99acf042006-02-01 03:06:56 -0800935 * @parent: parent task
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 *
937 * Checks that the parent task is still sleeping on the
938 * queue 'childq'. If so returns a pointer to the parent.
939 * Upon failure returns NULL.
940 *
941 * Caller must hold childq.lock
942 */
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100943static inline struct rpc_task *rpc_find_parent(struct rpc_task *child, struct rpc_task *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100945 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 struct list_head *le;
947
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 task_for_each(task, le, &childq.tasks[0])
949 if (task == parent)
950 return parent;
951
952 return NULL;
953}
954
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100955static void rpc_child_exit(struct rpc_task *child, void *calldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956{
957 struct rpc_task *parent;
958
959 spin_lock_bh(&childq.lock);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100960 if ((parent = rpc_find_parent(child, calldata)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 parent->tk_status = child->tk_status;
962 __rpc_wake_up_task(parent);
963 }
964 spin_unlock_bh(&childq.lock);
965}
966
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100967static const struct rpc_call_ops rpc_child_ops = {
968 .rpc_call_done = rpc_child_exit,
969};
970
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971/*
972 * Note: rpc_new_task releases the client after a failure.
973 */
974struct rpc_task *
975rpc_new_child(struct rpc_clnt *clnt, struct rpc_task *parent)
976{
977 struct rpc_task *task;
978
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100979 task = rpc_new_task(clnt, RPC_TASK_ASYNC | RPC_TASK_CHILD, &rpc_child_ops, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 if (!task)
981 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 return task;
983
984fail:
985 parent->tk_status = -ENOMEM;
986 return NULL;
987}
988
989void rpc_run_child(struct rpc_task *task, struct rpc_task *child, rpc_action func)
990{
991 spin_lock_bh(&childq.lock);
992 /* N.B. Is it possible for the child to have already finished? */
993 __rpc_sleep_on(&childq, task, func, NULL);
994 rpc_schedule_run(child);
995 spin_unlock_bh(&childq.lock);
996}
997
998/*
999 * Kill all tasks for the given client.
1000 * XXX: kill their descendants as well?
1001 */
1002void rpc_killall_tasks(struct rpc_clnt *clnt)
1003{
1004 struct rpc_task *rovr;
1005 struct list_head *le;
1006
1007 dprintk("RPC: killing all tasks for client %p\n", clnt);
1008
1009 /*
1010 * Spin lock all_tasks to prevent changes...
1011 */
1012 spin_lock(&rpc_sched_lock);
1013 alltask_for_each(rovr, le, &all_tasks) {
1014 if (! RPC_IS_ACTIVATED(rovr))
1015 continue;
1016 if (!clnt || rovr->tk_client == clnt) {
1017 rovr->tk_flags |= RPC_TASK_KILLED;
1018 rpc_exit(rovr, -EIO);
1019 rpc_wake_up_task(rovr);
1020 }
1021 }
1022 spin_unlock(&rpc_sched_lock);
1023}
1024
1025static DECLARE_MUTEX_LOCKED(rpciod_running);
1026
1027static void rpciod_killall(void)
1028{
1029 unsigned long flags;
1030
1031 while (!list_empty(&all_tasks)) {
1032 clear_thread_flag(TIF_SIGPENDING);
1033 rpc_killall_tasks(NULL);
1034 flush_workqueue(rpciod_workqueue);
1035 if (!list_empty(&all_tasks)) {
1036 dprintk("rpciod_killall: waiting for tasks to exit\n");
1037 yield();
1038 }
1039 }
1040
1041 spin_lock_irqsave(&current->sighand->siglock, flags);
1042 recalc_sigpending();
1043 spin_unlock_irqrestore(&current->sighand->siglock, flags);
1044}
1045
1046/*
1047 * Start up the rpciod process if it's not already running.
1048 */
1049int
1050rpciod_up(void)
1051{
1052 struct workqueue_struct *wq;
1053 int error = 0;
1054
1055 down(&rpciod_sema);
1056 dprintk("rpciod_up: users %d\n", rpciod_users);
1057 rpciod_users++;
1058 if (rpciod_workqueue)
1059 goto out;
1060 /*
1061 * If there's no pid, we should be the first user.
1062 */
1063 if (rpciod_users > 1)
1064 printk(KERN_WARNING "rpciod_up: no workqueue, %d users??\n", rpciod_users);
1065 /*
1066 * Create the rpciod thread and wait for it to start.
1067 */
1068 error = -ENOMEM;
1069 wq = create_workqueue("rpciod");
1070 if (wq == NULL) {
1071 printk(KERN_WARNING "rpciod_up: create workqueue failed, error=%d\n", error);
1072 rpciod_users--;
1073 goto out;
1074 }
1075 rpciod_workqueue = wq;
1076 error = 0;
1077out:
1078 up(&rpciod_sema);
1079 return error;
1080}
1081
1082void
1083rpciod_down(void)
1084{
1085 down(&rpciod_sema);
1086 dprintk("rpciod_down sema %d\n", rpciod_users);
1087 if (rpciod_users) {
1088 if (--rpciod_users)
1089 goto out;
1090 } else
1091 printk(KERN_WARNING "rpciod_down: no users??\n");
1092
1093 if (!rpciod_workqueue) {
1094 dprintk("rpciod_down: Nothing to do!\n");
1095 goto out;
1096 }
1097 rpciod_killall();
1098
1099 destroy_workqueue(rpciod_workqueue);
1100 rpciod_workqueue = NULL;
1101 out:
1102 up(&rpciod_sema);
1103}
1104
1105#ifdef RPC_DEBUG
1106void rpc_show_tasks(void)
1107{
1108 struct list_head *le;
1109 struct rpc_task *t;
1110
1111 spin_lock(&rpc_sched_lock);
1112 if (list_empty(&all_tasks)) {
1113 spin_unlock(&rpc_sched_lock);
1114 return;
1115 }
1116 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001117 "-rpcwait -action- ---ops--\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 alltask_for_each(t, le, &all_tasks) {
1119 const char *rpc_waitq = "none";
1120
1121 if (RPC_IS_QUEUED(t))
1122 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1123
1124 printk("%05d %04d %04x %06d %8p %6d %8p %08ld %8s %8p %8p\n",
1125 t->tk_pid,
1126 (t->tk_msg.rpc_proc ? t->tk_msg.rpc_proc->p_proc : -1),
1127 t->tk_flags, t->tk_status,
1128 t->tk_client,
1129 (t->tk_client ? t->tk_client->cl_prog : 0),
1130 t->tk_rqstp, t->tk_timeout,
1131 rpc_waitq,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001132 t->tk_action, t->tk_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 }
1134 spin_unlock(&rpc_sched_lock);
1135}
1136#endif
1137
1138void
1139rpc_destroy_mempool(void)
1140{
1141 if (rpc_buffer_mempool)
1142 mempool_destroy(rpc_buffer_mempool);
1143 if (rpc_task_mempool)
1144 mempool_destroy(rpc_task_mempool);
1145 if (rpc_task_slabp && kmem_cache_destroy(rpc_task_slabp))
1146 printk(KERN_INFO "rpc_task: not all structures were freed\n");
1147 if (rpc_buffer_slabp && kmem_cache_destroy(rpc_buffer_slabp))
1148 printk(KERN_INFO "rpc_buffers: not all structures were freed\n");
1149}
1150
1151int
1152rpc_init_mempool(void)
1153{
1154 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1155 sizeof(struct rpc_task),
1156 0, SLAB_HWCACHE_ALIGN,
1157 NULL, NULL);
1158 if (!rpc_task_slabp)
1159 goto err_nomem;
1160 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1161 RPC_BUFFER_MAXSIZE,
1162 0, SLAB_HWCACHE_ALIGN,
1163 NULL, NULL);
1164 if (!rpc_buffer_slabp)
1165 goto err_nomem;
1166 rpc_task_mempool = mempool_create(RPC_TASK_POOLSIZE,
1167 mempool_alloc_slab,
1168 mempool_free_slab,
1169 rpc_task_slabp);
1170 if (!rpc_task_mempool)
1171 goto err_nomem;
1172 rpc_buffer_mempool = mempool_create(RPC_BUFFER_POOLSIZE,
1173 mempool_alloc_slab,
1174 mempool_free_slab,
1175 rpc_buffer_slabp);
1176 if (!rpc_buffer_mempool)
1177 goto err_nomem;
1178 return 0;
1179err_nomem:
1180 rpc_destroy_mempool();
1181 return -ENOMEM;
1182}