]> bbs.cooldavid.org Git - net-next-2.6.git/blame - net/sunrpc/sched.c
SUNRPC: Ensure that rpc_exit() always wakes up a sleeping task
[net-next-2.6.git] / net / sunrpc / sched.c
CommitLineData
1da177e4
LT
1/*
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>
cca5172a 7 *
1da177e4
LT
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>
1da177e4 19#include <linux/spinlock.h>
4a3e2f71 20#include <linux/mutex.h>
1da177e4
LT
21
22#include <linux/sunrpc/clnt.h>
1da177e4 23
6951867b
BH
24#include "sunrpc.h"
25
1da177e4
LT
26#ifdef RPC_DEBUG
27#define RPCDBG_FACILITY RPCDBG_SCHED
1da177e4
LT
28#endif
29
30/*
31 * RPC slabs and memory pools
32 */
33#define RPC_BUFFER_MAXSIZE (2048)
34#define RPC_BUFFER_POOLSIZE (8)
35#define RPC_TASK_POOLSIZE (8)
e18b890b
CL
36static struct kmem_cache *rpc_task_slabp __read_mostly;
37static struct kmem_cache *rpc_buffer_slabp __read_mostly;
ba89966c
ED
38static mempool_t *rpc_task_mempool __read_mostly;
39static mempool_t *rpc_buffer_mempool __read_mostly;
1da177e4 40
65f27f38 41static void rpc_async_schedule(struct work_struct *);
bde8f00c 42static void rpc_release_task(struct rpc_task *task);
36df9aae 43static void __rpc_queue_timer_fn(unsigned long ptr);
1da177e4 44
1da177e4
LT
45/*
46 * RPC tasks sit here while waiting for conditions to improve.
47 */
a4a87499 48static struct rpc_wait_queue delay_queue;
1da177e4 49
1da177e4
LT
50/*
51 * rpciod-related stuff
52 */
24c5d9d7 53struct workqueue_struct *rpciod_workqueue;
1da177e4 54
1da177e4
LT
55/*
56 * Disable the timer for a given RPC task. Should be called with
57 * queue->lock and bh_disabled in order to avoid races within
58 * rpc_run_timer().
59 */
5d00837b 60static void
eb276c0e 61__rpc_disable_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 62{
36df9aae
TM
63 if (task->tk_timeout == 0)
64 return;
46121cf7 65 dprintk("RPC: %5u disabling timer\n", task->tk_pid);
1da177e4 66 task->tk_timeout = 0;
36df9aae 67 list_del(&task->u.tk_wait.timer_list);
eb276c0e
TM
68 if (list_empty(&queue->timer_list.list))
69 del_timer(&queue->timer_list.timer);
36df9aae
TM
70}
71
72static void
73rpc_set_queue_timer(struct rpc_wait_queue *queue, unsigned long expires)
74{
75 queue->timer_list.expires = expires;
76 mod_timer(&queue->timer_list.timer, expires);
1da177e4
LT
77}
78
1da177e4
LT
79/*
80 * Set up a timer for the current task.
81 */
5d00837b 82static void
eb276c0e 83__rpc_add_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4
LT
84{
85 if (!task->tk_timeout)
86 return;
87
46121cf7 88 dprintk("RPC: %5u setting alarm for %lu ms\n",
1da177e4
LT
89 task->tk_pid, task->tk_timeout * 1000 / HZ);
90
eb276c0e
TM
91 task->u.tk_wait.expires = jiffies + task->tk_timeout;
92 if (list_empty(&queue->timer_list.list) || time_before(task->u.tk_wait.expires, queue->timer_list.expires))
93 rpc_set_queue_timer(queue, task->u.tk_wait.expires);
94 list_add(&task->u.tk_wait.timer_list, &queue->timer_list.list);
1da177e4
LT
95}
96
97/*
98 * Add new request to a priority queue.
99 */
100static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue, struct rpc_task *task)
101{
102 struct list_head *q;
103 struct rpc_task *t;
104
105 INIT_LIST_HEAD(&task->u.tk_wait.links);
106 q = &queue->tasks[task->tk_priority];
107 if (unlikely(task->tk_priority > queue->maxpriority))
108 q = &queue->tasks[queue->maxpriority];
109 list_for_each_entry(t, q, u.tk_wait.list) {
3ff7576d 110 if (t->tk_owner == task->tk_owner) {
1da177e4
LT
111 list_add_tail(&task->u.tk_wait.list, &t->u.tk_wait.links);
112 return;
113 }
114 }
115 list_add_tail(&task->u.tk_wait.list, q);
116}
117
118/*
119 * Add new request to wait queue.
120 *
121 * Swapper tasks always get inserted at the head of the queue.
122 * This should avoid many nasty memory deadlocks and hopefully
123 * improve overall performance.
124 * Everyone else gets appended to the queue to ensure proper FIFO behavior.
125 */
126static void __rpc_add_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
127{
128 BUG_ON (RPC_IS_QUEUED(task));
129
130 if (RPC_IS_PRIORITY(queue))
131 __rpc_add_wait_queue_priority(queue, task);
132 else if (RPC_IS_SWAPPER(task))
133 list_add(&task->u.tk_wait.list, &queue->tasks[0]);
134 else
135 list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
96ef13b2 136 task->tk_waitqueue = queue;
e19b63da 137 queue->qlen++;
1da177e4
LT
138 rpc_set_queued(task);
139
46121cf7
CL
140 dprintk("RPC: %5u added to queue %p \"%s\"\n",
141 task->tk_pid, queue, rpc_qname(queue));
1da177e4
LT
142}
143
144/*
145 * Remove request from a priority queue.
146 */
147static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
148{
149 struct rpc_task *t;
150
151 if (!list_empty(&task->u.tk_wait.links)) {
152 t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
153 list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
154 list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
155 }
1da177e4
LT
156}
157
158/*
159 * Remove request from queue.
160 * Note: must be called with spin lock held.
161 */
96ef13b2 162static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 163{
eb276c0e 164 __rpc_disable_timer(queue, task);
1da177e4
LT
165 if (RPC_IS_PRIORITY(queue))
166 __rpc_remove_wait_queue_priority(task);
36df9aae 167 list_del(&task->u.tk_wait.list);
e19b63da 168 queue->qlen--;
46121cf7
CL
169 dprintk("RPC: %5u removed from queue %p \"%s\"\n",
170 task->tk_pid, queue, rpc_qname(queue));
1da177e4
LT
171}
172
173static inline void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
174{
175 queue->priority = priority;
176 queue->count = 1 << (priority * 2);
177}
178
3ff7576d 179static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
1da177e4 180{
3ff7576d 181 queue->owner = pid;
1da177e4
LT
182 queue->nr = RPC_BATCH_COUNT;
183}
184
185static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
186{
187 rpc_set_waitqueue_priority(queue, queue->maxpriority);
3ff7576d 188 rpc_set_waitqueue_owner(queue, 0);
1da177e4
LT
189}
190
3ff7576d 191static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
1da177e4
LT
192{
193 int i;
194
195 spin_lock_init(&queue->lock);
196 for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
197 INIT_LIST_HEAD(&queue->tasks[i]);
3ff7576d 198 queue->maxpriority = nr_queues - 1;
1da177e4 199 rpc_reset_waitqueue_priority(queue);
36df9aae
TM
200 queue->qlen = 0;
201 setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
202 INIT_LIST_HEAD(&queue->timer_list.list);
1da177e4
LT
203#ifdef RPC_DEBUG
204 queue->name = qname;
205#endif
206}
207
208void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
209{
3ff7576d 210 __rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
1da177e4 211}
689cf5c1 212EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
1da177e4
LT
213
214void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
215{
3ff7576d 216 __rpc_init_priority_wait_queue(queue, qname, 1);
1da177e4 217}
e8914c65 218EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
1da177e4 219
f6a1cc89
TM
220void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
221{
36df9aae 222 del_timer_sync(&queue->timer_list.timer);
f6a1cc89
TM
223}
224EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);
225
150030b7 226static int rpc_wait_bit_killable(void *word)
44c28873 227{
150030b7 228 if (fatal_signal_pending(current))
44c28873
TM
229 return -ERESTARTSYS;
230 schedule();
231 return 0;
232}
233
c44fe705
TM
234#ifdef RPC_DEBUG
235static void rpc_task_set_debuginfo(struct rpc_task *task)
236{
237 static atomic_t rpc_pid;
238
c44fe705
TM
239 task->tk_pid = atomic_inc_return(&rpc_pid);
240}
241#else
242static inline void rpc_task_set_debuginfo(struct rpc_task *task)
243{
244}
245#endif
246
e6b3c4db
TM
247static void rpc_set_active(struct rpc_task *task)
248{
4bef61ff 249 struct rpc_clnt *clnt;
e6b3c4db
TM
250 if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
251 return;
c44fe705 252 rpc_task_set_debuginfo(task);
e6b3c4db 253 /* Add to global list of all tasks */
4bef61ff
TM
254 clnt = task->tk_client;
255 if (clnt != NULL) {
256 spin_lock(&clnt->cl_lock);
257 list_add_tail(&task->tk_task, &clnt->cl_tasks);
258 spin_unlock(&clnt->cl_lock);
259 }
e6b3c4db
TM
260}
261
44c28873
TM
262/*
263 * Mark an RPC call as having completed by clearing the 'active' bit
264 */
e6b3c4db 265static void rpc_mark_complete_task(struct rpc_task *task)
44c28873 266{
e6b3c4db
TM
267 smp_mb__before_clear_bit();
268 clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
269 smp_mb__after_clear_bit();
44c28873
TM
270 wake_up_bit(&task->tk_runstate, RPC_TASK_ACTIVE);
271}
272
273/*
274 * Allow callers to wait for completion of an RPC call
275 */
276int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
277{
278 if (action == NULL)
150030b7 279 action = rpc_wait_bit_killable;
44c28873 280 return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
150030b7 281 action, TASK_KILLABLE);
44c28873 282}
e8914c65 283EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
44c28873 284
1da177e4
LT
285/*
286 * Make an RPC task runnable.
287 *
cca5172a 288 * Note: If the task is ASYNC, this must be called with
1da177e4
LT
289 * the spinlock held to protect the wait queue operation.
290 */
291static void rpc_make_runnable(struct rpc_task *task)
292{
1da177e4 293 rpc_clear_queued(task);
cc4dc59e
CS
294 if (rpc_test_and_set_running(task))
295 return;
1da177e4
LT
296 if (RPC_IS_ASYNC(task)) {
297 int status;
298
65f27f38 299 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
32bfb5c0 300 status = queue_work(rpciod_workqueue, &task->u.tk_work);
1da177e4
LT
301 if (status < 0) {
302 printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
303 task->tk_status = status;
304 return;
305 }
306 } else
96651ab3 307 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
1da177e4
LT
308}
309
1da177e4
LT
310/*
311 * Prepare for sleeping on a wait queue.
312 * By always appending tasks to the list we ensure FIFO behavior.
313 * NB: An RPC task will only receive interrupt-driven events as long
314 * as it's on a wait queue.
315 */
316static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
5d00837b 317 rpc_action action)
1da177e4 318{
46121cf7
CL
319 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
320 task->tk_pid, rpc_qname(q), jiffies);
1da177e4
LT
321
322 if (!RPC_IS_ASYNC(task) && !RPC_IS_ACTIVATED(task)) {
323 printk(KERN_ERR "RPC: Inactive synchronous task put to sleep!\n");
324 return;
325 }
326
1da177e4
LT
327 __rpc_add_wait_queue(q, task);
328
329 BUG_ON(task->tk_callback != NULL);
330 task->tk_callback = action;
eb276c0e 331 __rpc_add_timer(q, task);
1da177e4
LT
332}
333
334void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
5d00837b 335 rpc_action action)
1da177e4 336{
e6b3c4db
TM
337 /* Mark the task as being activated if so needed */
338 rpc_set_active(task);
339
1da177e4
LT
340 /*
341 * Protect the queue operations.
342 */
343 spin_lock_bh(&q->lock);
5d00837b 344 __rpc_sleep_on(q, task, action);
1da177e4
LT
345 spin_unlock_bh(&q->lock);
346}
e8914c65 347EXPORT_SYMBOL_GPL(rpc_sleep_on);
1da177e4
LT
348
349/**
350 * __rpc_do_wake_up_task - wake up a single rpc_task
96ef13b2 351 * @queue: wait queue
1da177e4
LT
352 * @task: task to be woken up
353 *
354 * Caller must hold queue->lock, and have cleared the task queued flag.
355 */
96ef13b2 356static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 357{
46121cf7
CL
358 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
359 task->tk_pid, jiffies);
1da177e4 360
1da177e4
LT
361 /* Has the task been executed yet? If not, we cannot wake it up! */
362 if (!RPC_IS_ACTIVATED(task)) {
363 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
364 return;
365 }
366
96ef13b2 367 __rpc_remove_wait_queue(queue, task);
1da177e4
LT
368
369 rpc_make_runnable(task);
370
46121cf7 371 dprintk("RPC: __rpc_wake_up_task done\n");
1da177e4
LT
372}
373
374/*
96ef13b2 375 * Wake up a queued task while the queue lock is being held
1da177e4 376 */
96ef13b2 377static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 378{
f5fb7b06
TM
379 if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
380 __rpc_do_wake_up_task(queue, task);
1da177e4
LT
381}
382
48f18612
AB
383/*
384 * Tests whether rpc queue is empty
385 */
386int rpc_queue_empty(struct rpc_wait_queue *queue)
387{
388 int res;
389
390 spin_lock_bh(&queue->lock);
391 res = queue->qlen;
392 spin_unlock_bh(&queue->lock);
393 return (res == 0);
394}
395EXPORT_SYMBOL_GPL(rpc_queue_empty);
396
1da177e4 397/*
96ef13b2 398 * Wake up a task on a specific queue
1da177e4 399 */
96ef13b2 400void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 401{
5e4424af 402 spin_lock_bh(&queue->lock);
96ef13b2 403 rpc_wake_up_task_queue_locked(queue, task);
5e4424af 404 spin_unlock_bh(&queue->lock);
1da177e4 405}
96ef13b2
TM
406EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
407
1da177e4
LT
408/*
409 * Wake up the next task on a priority queue.
410 */
411static struct rpc_task * __rpc_wake_up_next_priority(struct rpc_wait_queue *queue)
412{
413 struct list_head *q;
414 struct rpc_task *task;
415
416 /*
3ff7576d 417 * Service a batch of tasks from a single owner.
1da177e4
LT
418 */
419 q = &queue->tasks[queue->priority];
420 if (!list_empty(q)) {
421 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
3ff7576d 422 if (queue->owner == task->tk_owner) {
1da177e4
LT
423 if (--queue->nr)
424 goto out;
425 list_move_tail(&task->u.tk_wait.list, q);
426 }
427 /*
428 * Check if we need to switch queues.
429 */
430 if (--queue->count)
3ff7576d 431 goto new_owner;
1da177e4
LT
432 }
433
434 /*
435 * Service the next queue.
436 */
437 do {
438 if (q == &queue->tasks[0])
439 q = &queue->tasks[queue->maxpriority];
440 else
441 q = q - 1;
442 if (!list_empty(q)) {
443 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
444 goto new_queue;
445 }
446 } while (q != &queue->tasks[queue->priority]);
447
448 rpc_reset_waitqueue_priority(queue);
449 return NULL;
450
451new_queue:
452 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
3ff7576d
TM
453new_owner:
454 rpc_set_waitqueue_owner(queue, task->tk_owner);
1da177e4 455out:
96ef13b2 456 rpc_wake_up_task_queue_locked(queue, task);
1da177e4
LT
457 return task;
458}
459
460/*
461 * Wake up the next task on the wait queue.
462 */
463struct rpc_task * rpc_wake_up_next(struct rpc_wait_queue *queue)
464{
465 struct rpc_task *task = NULL;
466
46121cf7
CL
467 dprintk("RPC: wake_up_next(%p \"%s\")\n",
468 queue, rpc_qname(queue));
5e4424af 469 spin_lock_bh(&queue->lock);
1da177e4
LT
470 if (RPC_IS_PRIORITY(queue))
471 task = __rpc_wake_up_next_priority(queue);
472 else {
473 task_for_first(task, &queue->tasks[0])
96ef13b2 474 rpc_wake_up_task_queue_locked(queue, task);
1da177e4 475 }
5e4424af 476 spin_unlock_bh(&queue->lock);
1da177e4
LT
477
478 return task;
479}
e8914c65 480EXPORT_SYMBOL_GPL(rpc_wake_up_next);
1da177e4
LT
481
482/**
483 * rpc_wake_up - wake up all rpc_tasks
484 * @queue: rpc_wait_queue on which the tasks are sleeping
485 *
486 * Grabs queue->lock
487 */
488void rpc_wake_up(struct rpc_wait_queue *queue)
489{
e6d83d55 490 struct rpc_task *task, *next;
1da177e4 491 struct list_head *head;
e6d83d55 492
5e4424af 493 spin_lock_bh(&queue->lock);
1da177e4
LT
494 head = &queue->tasks[queue->maxpriority];
495 for (;;) {
e6d83d55 496 list_for_each_entry_safe(task, next, head, u.tk_wait.list)
96ef13b2 497 rpc_wake_up_task_queue_locked(queue, task);
1da177e4
LT
498 if (head == &queue->tasks[0])
499 break;
500 head--;
501 }
5e4424af 502 spin_unlock_bh(&queue->lock);
1da177e4 503}
e8914c65 504EXPORT_SYMBOL_GPL(rpc_wake_up);
1da177e4
LT
505
506/**
507 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
508 * @queue: rpc_wait_queue on which the tasks are sleeping
509 * @status: status value to set
510 *
511 * Grabs queue->lock
512 */
513void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
514{
e6d83d55 515 struct rpc_task *task, *next;
1da177e4 516 struct list_head *head;
1da177e4 517
5e4424af 518 spin_lock_bh(&queue->lock);
1da177e4
LT
519 head = &queue->tasks[queue->maxpriority];
520 for (;;) {
e6d83d55 521 list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
1da177e4 522 task->tk_status = status;
96ef13b2 523 rpc_wake_up_task_queue_locked(queue, task);
1da177e4
LT
524 }
525 if (head == &queue->tasks[0])
526 break;
527 head--;
528 }
5e4424af 529 spin_unlock_bh(&queue->lock);
1da177e4 530}
e8914c65 531EXPORT_SYMBOL_GPL(rpc_wake_up_status);
1da177e4 532
36df9aae
TM
533static void __rpc_queue_timer_fn(unsigned long ptr)
534{
535 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
536 struct rpc_task *task, *n;
537 unsigned long expires, now, timeo;
538
539 spin_lock(&queue->lock);
540 expires = now = jiffies;
541 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
542 timeo = task->u.tk_wait.expires;
543 if (time_after_eq(now, timeo)) {
36df9aae
TM
544 dprintk("RPC: %5u timeout\n", task->tk_pid);
545 task->tk_status = -ETIMEDOUT;
546 rpc_wake_up_task_queue_locked(queue, task);
547 continue;
548 }
549 if (expires == now || time_after(expires, timeo))
550 expires = timeo;
551 }
552 if (!list_empty(&queue->timer_list.list))
553 rpc_set_queue_timer(queue, expires);
554 spin_unlock(&queue->lock);
555}
556
8014793b
TM
557static void __rpc_atrun(struct rpc_task *task)
558{
5d00837b 559 task->tk_status = 0;
8014793b
TM
560}
561
1da177e4
LT
562/*
563 * Run a task at a later time
564 */
8014793b 565void rpc_delay(struct rpc_task *task, unsigned long delay)
1da177e4
LT
566{
567 task->tk_timeout = delay;
5d00837b 568 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
1da177e4 569}
e8914c65 570EXPORT_SYMBOL_GPL(rpc_delay);
1da177e4 571
4ce70ada
TM
572/*
573 * Helper to call task->tk_ops->rpc_call_prepare
574 */
aae2006e 575void rpc_prepare_task(struct rpc_task *task)
4ce70ada
TM
576{
577 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
578}
579
d05fdb0c 580/*
963d8fe5 581 * Helper that calls task->tk_ops->rpc_call_done if it exists
d05fdb0c 582 */
abbcf28f 583void rpc_exit_task(struct rpc_task *task)
d05fdb0c 584{
abbcf28f 585 task->tk_action = NULL;
963d8fe5
TM
586 if (task->tk_ops->rpc_call_done != NULL) {
587 task->tk_ops->rpc_call_done(task, task->tk_calldata);
d05fdb0c 588 if (task->tk_action != NULL) {
abbcf28f
TM
589 WARN_ON(RPC_ASSASSINATED(task));
590 /* Always release the RPC slot and buffer memory */
591 xprt_release(task);
d05fdb0c
TM
592 }
593 }
d05fdb0c 594}
d9b6cd94
TM
595
596void rpc_exit(struct rpc_task *task, int status)
597{
598 task->tk_status = status;
599 task->tk_action = rpc_exit_task;
600 if (RPC_IS_QUEUED(task))
601 rpc_wake_up_queued_task(task->tk_waitqueue, task);
602}
603EXPORT_SYMBOL_GPL(rpc_exit);
d05fdb0c 604
bbd5a1f9
TM
605void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
606{
a86dc496 607 if (ops->rpc_release != NULL)
bbd5a1f9 608 ops->rpc_release(calldata);
bbd5a1f9
TM
609}
610
1da177e4
LT
611/*
612 * This is the RPC `scheduler' (or rather, the finite state machine).
613 */
2efef837 614static void __rpc_execute(struct rpc_task *task)
1da177e4 615{
eb9b55ab
TM
616 struct rpc_wait_queue *queue;
617 int task_is_async = RPC_IS_ASYNC(task);
618 int status = 0;
1da177e4 619
46121cf7
CL
620 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
621 task->tk_pid, task->tk_flags);
1da177e4
LT
622
623 BUG_ON(RPC_IS_QUEUED(task));
624
d05fdb0c 625 for (;;) {
1da177e4
LT
626
627 /*
628 * Execute any pending callback.
629 */
a486aeda 630 if (task->tk_callback) {
1da177e4 631 void (*save_callback)(struct rpc_task *);
cca5172a
YH
632
633 /*
a486aeda
BF
634 * We set tk_callback to NULL before calling it,
635 * in case it sets the tk_callback field itself:
1da177e4 636 */
a486aeda
BF
637 save_callback = task->tk_callback;
638 task->tk_callback = NULL;
1da177e4 639 save_callback(task);
1da177e4
LT
640 }
641
642 /*
643 * Perform the next FSM step.
644 * tk_action may be NULL when the task has been killed
645 * by someone else.
646 */
647 if (!RPC_IS_QUEUED(task)) {
abbcf28f 648 if (task->tk_action == NULL)
1da177e4 649 break;
abbcf28f 650 task->tk_action(task);
1da177e4
LT
651 }
652
653 /*
654 * Lockless check for whether task is sleeping or not.
655 */
656 if (!RPC_IS_QUEUED(task))
657 continue;
eb9b55ab
TM
658 /*
659 * The queue->lock protects against races with
660 * rpc_make_runnable().
661 *
662 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
663 * rpc_task, rpc_make_runnable() can assign it to a
664 * different workqueue. We therefore cannot assume that the
665 * rpc_task pointer may still be dereferenced.
666 */
667 queue = task->tk_waitqueue;
668 spin_lock_bh(&queue->lock);
669 if (!RPC_IS_QUEUED(task)) {
670 spin_unlock_bh(&queue->lock);
1da177e4
LT
671 continue;
672 }
eb9b55ab
TM
673 rpc_clear_running(task);
674 spin_unlock_bh(&queue->lock);
675 if (task_is_async)
676 return;
1da177e4
LT
677
678 /* sync task: sleep here */
46121cf7 679 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
96651ab3 680 status = out_of_line_wait_on_bit(&task->tk_runstate,
150030b7
MW
681 RPC_TASK_QUEUED, rpc_wait_bit_killable,
682 TASK_KILLABLE);
96651ab3 683 if (status == -ERESTARTSYS) {
1da177e4
LT
684 /*
685 * When a sync task receives a signal, it exits with
686 * -ERESTARTSYS. In order to catch any callbacks that
687 * clean up after sleeping on some queue, we don't
688 * break the loop here, but go around once more.
689 */
46121cf7 690 dprintk("RPC: %5u got signal\n", task->tk_pid);
96651ab3
TM
691 task->tk_flags |= RPC_TASK_KILLED;
692 rpc_exit(task, -ERESTARTSYS);
1da177e4
LT
693 }
694 rpc_set_running(task);
46121cf7 695 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
1da177e4
LT
696 }
697
46121cf7
CL
698 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
699 task->tk_status);
1da177e4
LT
700 /* Release all resources associated with the task */
701 rpc_release_task(task);
1da177e4
LT
702}
703
704/*
705 * User-visible entry point to the scheduler.
706 *
707 * This may be called recursively if e.g. an async NFS task updates
708 * the attributes and finds that dirty pages must be flushed.
709 * NOTE: Upon exit of this function the task is guaranteed to be
710 * released. In particular note that tk_release() will have
711 * been called, so your task memory may have been freed.
712 */
2efef837 713void rpc_execute(struct rpc_task *task)
1da177e4 714{
44c28873 715 rpc_set_active(task);
1da177e4 716 rpc_set_running(task);
2efef837 717 __rpc_execute(task);
1da177e4
LT
718}
719
65f27f38 720static void rpc_async_schedule(struct work_struct *work)
1da177e4 721{
65f27f38 722 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
1da177e4
LT
723}
724
02107148
CL
725/**
726 * rpc_malloc - allocate an RPC buffer
727 * @task: RPC task that will use this buffer
728 * @size: requested byte size
1da177e4 729 *
c5a4dd8b
CL
730 * To prevent rpciod from hanging, this allocator never sleeps,
731 * returning NULL if the request cannot be serviced immediately.
732 * The caller can arrange to sleep in a way that is safe for rpciod.
733 *
734 * Most requests are 'small' (under 2KiB) and can be serviced from a
735 * mempool, ensuring that NFS reads and writes can always proceed,
736 * and that there is good locality of reference for these buffers.
737 *
1da177e4 738 * In order to avoid memory starvation triggering more writebacks of
c5a4dd8b 739 * NFS requests, we avoid using GFP_KERNEL.
1da177e4 740 */
c5a4dd8b 741void *rpc_malloc(struct rpc_task *task, size_t size)
1da177e4 742{
aa3d1fae 743 struct rpc_buffer *buf;
c5a4dd8b 744 gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
1da177e4 745
aa3d1fae 746 size += sizeof(struct rpc_buffer);
c5a4dd8b
CL
747 if (size <= RPC_BUFFER_MAXSIZE)
748 buf = mempool_alloc(rpc_buffer_mempool, gfp);
1da177e4 749 else
c5a4dd8b 750 buf = kmalloc(size, gfp);
ddce40df
PZ
751
752 if (!buf)
753 return NULL;
754
aa3d1fae 755 buf->len = size;
215d0678 756 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
c5a4dd8b 757 task->tk_pid, size, buf);
aa3d1fae 758 return &buf->data;
1da177e4 759}
12444809 760EXPORT_SYMBOL_GPL(rpc_malloc);
1da177e4 761
02107148
CL
762/**
763 * rpc_free - free buffer allocated via rpc_malloc
c5a4dd8b 764 * @buffer: buffer to free
02107148
CL
765 *
766 */
c5a4dd8b 767void rpc_free(void *buffer)
1da177e4 768{
aa3d1fae
CL
769 size_t size;
770 struct rpc_buffer *buf;
02107148 771
c5a4dd8b
CL
772 if (!buffer)
773 return;
aa3d1fae
CL
774
775 buf = container_of(buffer, struct rpc_buffer, data);
776 size = buf->len;
c5a4dd8b 777
215d0678 778 dprintk("RPC: freeing buffer of size %zu at %p\n",
c5a4dd8b 779 size, buf);
aa3d1fae 780
c5a4dd8b
CL
781 if (size <= RPC_BUFFER_MAXSIZE)
782 mempool_free(buf, rpc_buffer_mempool);
783 else
784 kfree(buf);
1da177e4 785}
12444809 786EXPORT_SYMBOL_GPL(rpc_free);
1da177e4
LT
787
788/*
789 * Creation and deletion of RPC task structures
790 */
47fe0648 791static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
1da177e4
LT
792{
793 memset(task, 0, sizeof(*task));
44c28873 794 atomic_set(&task->tk_count, 1);
84115e1c
TM
795 task->tk_flags = task_setup_data->flags;
796 task->tk_ops = task_setup_data->callback_ops;
797 task->tk_calldata = task_setup_data->callback_data;
6529eba0 798 INIT_LIST_HEAD(&task->tk_task);
1da177e4
LT
799
800 /* Initialize retry counters */
801 task->tk_garb_retry = 2;
802 task->tk_cred_retry = 2;
803
3ff7576d
TM
804 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
805 task->tk_owner = current->tgid;
1da177e4
LT
806
807 /* Initialize workqueue for async tasks */
32bfb5c0 808 task->tk_workqueue = task_setup_data->workqueue;
1da177e4 809
84115e1c
TM
810 task->tk_client = task_setup_data->rpc_client;
811 if (task->tk_client != NULL) {
812 kref_get(&task->tk_client->cl_kref);
813 if (task->tk_client->cl_softrtry)
1da177e4 814 task->tk_flags |= RPC_TASK_SOFT;
1da177e4
LT
815 }
816
84115e1c
TM
817 if (task->tk_ops->rpc_call_prepare != NULL)
818 task->tk_action = rpc_prepare_task;
963d8fe5 819
b3ef8b3b 820 if (task_setup_data->rpc_message != NULL) {
4ccda2cd
TM
821 task->tk_msg.rpc_proc = task_setup_data->rpc_message->rpc_proc;
822 task->tk_msg.rpc_argp = task_setup_data->rpc_message->rpc_argp;
823 task->tk_msg.rpc_resp = task_setup_data->rpc_message->rpc_resp;
b3ef8b3b 824 /* Bind the user cred */
4ccda2cd 825 rpcauth_bindcred(task, task_setup_data->rpc_message->rpc_cred, task_setup_data->flags);
b3ef8b3b
TM
826 if (task->tk_action == NULL)
827 rpc_call_start(task);
828 }
829
ef759a2e 830 /* starting timestamp */
ff839970 831 task->tk_start = ktime_get();
ef759a2e 832
46121cf7 833 dprintk("RPC: new task initialized, procpid %u\n",
ba25f9dc 834 task_pid_nr(current));
1da177e4
LT
835}
836
837static struct rpc_task *
838rpc_alloc_task(void)
839{
840 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
841}
842
1da177e4 843/*
90c5755f 844 * Create a new task for the specified client.
1da177e4 845 */
84115e1c 846struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
1da177e4 847{
e8f5d77c
TM
848 struct rpc_task *task = setup_data->task;
849 unsigned short flags = 0;
850
851 if (task == NULL) {
852 task = rpc_alloc_task();
19445b99
TM
853 if (task == NULL) {
854 rpc_release_calldata(setup_data->callback_ops,
855 setup_data->callback_data);
856 return ERR_PTR(-ENOMEM);
857 }
e8f5d77c
TM
858 flags = RPC_TASK_DYNAMIC;
859 }
1da177e4 860
84115e1c 861 rpc_init_task(task, setup_data);
19445b99
TM
862 if (task->tk_status < 0) {
863 int err = task->tk_status;
864 rpc_put_task(task);
865 return ERR_PTR(err);
866 }
1da177e4 867
e8f5d77c 868 task->tk_flags |= flags;
46121cf7 869 dprintk("RPC: allocated task %p\n", task);
1da177e4 870 return task;
1da177e4
LT
871}
872
32bfb5c0 873static void rpc_free_task(struct rpc_task *task)
1da177e4 874{
963d8fe5
TM
875 const struct rpc_call_ops *tk_ops = task->tk_ops;
876 void *calldata = task->tk_calldata;
1da177e4 877
5e4424af
TM
878 if (task->tk_flags & RPC_TASK_DYNAMIC) {
879 dprintk("RPC: %5u freeing task\n", task->tk_pid);
880 mempool_free(task, rpc_task_mempool);
881 }
32bfb5c0
TM
882 rpc_release_calldata(tk_ops, calldata);
883}
884
885static void rpc_async_release(struct work_struct *work)
886{
887 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
888}
889
890void rpc_put_task(struct rpc_task *task)
891{
e6b3c4db
TM
892 if (!atomic_dec_and_test(&task->tk_count))
893 return;
894 /* Release resources */
895 if (task->tk_rqstp)
896 xprt_release(task);
897 if (task->tk_msg.rpc_cred)
898 rpcauth_unbindcred(task);
899 if (task->tk_client) {
900 rpc_release_client(task->tk_client);
901 task->tk_client = NULL;
902 }
32bfb5c0
TM
903 if (task->tk_workqueue != NULL) {
904 INIT_WORK(&task->u.tk_work, rpc_async_release);
905 queue_work(task->tk_workqueue, &task->u.tk_work);
906 } else
907 rpc_free_task(task);
e6b3c4db 908}
e8914c65 909EXPORT_SYMBOL_GPL(rpc_put_task);
e6b3c4db 910
bde8f00c 911static void rpc_release_task(struct rpc_task *task)
e6b3c4db 912{
46121cf7 913 dprintk("RPC: %5u release task\n", task->tk_pid);
1da177e4 914
6529eba0 915 if (!list_empty(&task->tk_task)) {
4bef61ff 916 struct rpc_clnt *clnt = task->tk_client;
6529eba0 917 /* Remove from client task list */
4bef61ff 918 spin_lock(&clnt->cl_lock);
6529eba0 919 list_del(&task->tk_task);
4bef61ff 920 spin_unlock(&clnt->cl_lock);
6529eba0 921 }
1da177e4 922 BUG_ON (RPC_IS_QUEUED(task));
1da177e4 923
e6b3c4db
TM
924 /* Wake up anyone who is waiting for task completion */
925 rpc_mark_complete_task(task);
926
927 rpc_put_task(task);
1da177e4
LT
928}
929
1da177e4
LT
930/*
931 * Kill all tasks for the given client.
932 * XXX: kill their descendants as well?
933 */
4bef61ff 934void rpc_killall_tasks(struct rpc_clnt *clnt)
1da177e4
LT
935{
936 struct rpc_task *rovr;
1da177e4 937
1da177e4 938
4bef61ff
TM
939 if (list_empty(&clnt->cl_tasks))
940 return;
941 dprintk("RPC: killing all tasks for client %p\n", clnt);
942 /*
943 * Spin lock all_tasks to prevent changes...
944 */
945 spin_lock(&clnt->cl_lock);
946 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
1da177e4
LT
947 if (! RPC_IS_ACTIVATED(rovr))
948 continue;
6529eba0 949 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
1da177e4
LT
950 rovr->tk_flags |= RPC_TASK_KILLED;
951 rpc_exit(rovr, -EIO);
1da177e4
LT
952 }
953 }
4bef61ff 954 spin_unlock(&clnt->cl_lock);
1da177e4 955}
e8914c65 956EXPORT_SYMBOL_GPL(rpc_killall_tasks);
1da177e4 957
b247bbf1
TM
958int rpciod_up(void)
959{
960 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
961}
962
963void rpciod_down(void)
964{
965 module_put(THIS_MODULE);
966}
967
1da177e4 968/*
b247bbf1 969 * Start up the rpciod workqueue.
1da177e4 970 */
b247bbf1 971static int rpciod_start(void)
1da177e4
LT
972{
973 struct workqueue_struct *wq;
ab418d70 974
1da177e4
LT
975 /*
976 * Create the rpciod thread and wait for it to start.
977 */
ab418d70 978 dprintk("RPC: creating workqueue rpciod\n");
1da177e4 979 wq = create_workqueue("rpciod");
1da177e4 980 rpciod_workqueue = wq;
b247bbf1 981 return rpciod_workqueue != NULL;
1da177e4
LT
982}
983
b247bbf1 984static void rpciod_stop(void)
1da177e4 985{
b247bbf1 986 struct workqueue_struct *wq = NULL;
ab418d70 987
b247bbf1
TM
988 if (rpciod_workqueue == NULL)
989 return;
ab418d70 990 dprintk("RPC: destroying workqueue rpciod\n");
1da177e4 991
b247bbf1
TM
992 wq = rpciod_workqueue;
993 rpciod_workqueue = NULL;
994 destroy_workqueue(wq);
1da177e4
LT
995}
996
1da177e4
LT
997void
998rpc_destroy_mempool(void)
999{
b247bbf1 1000 rpciod_stop();
1da177e4
LT
1001 if (rpc_buffer_mempool)
1002 mempool_destroy(rpc_buffer_mempool);
1003 if (rpc_task_mempool)
1004 mempool_destroy(rpc_task_mempool);
1a1d92c1
AD
1005 if (rpc_task_slabp)
1006 kmem_cache_destroy(rpc_task_slabp);
1007 if (rpc_buffer_slabp)
1008 kmem_cache_destroy(rpc_buffer_slabp);
f6a1cc89 1009 rpc_destroy_wait_queue(&delay_queue);
1da177e4
LT
1010}
1011
1012int
1013rpc_init_mempool(void)
1014{
f6a1cc89
TM
1015 /*
1016 * The following is not strictly a mempool initialisation,
1017 * but there is no harm in doing it here
1018 */
1019 rpc_init_wait_queue(&delay_queue, "delayq");
1020 if (!rpciod_start())
1021 goto err_nomem;
1022
1da177e4
LT
1023 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1024 sizeof(struct rpc_task),
1025 0, SLAB_HWCACHE_ALIGN,
20c2df83 1026 NULL);
1da177e4
LT
1027 if (!rpc_task_slabp)
1028 goto err_nomem;
1029 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1030 RPC_BUFFER_MAXSIZE,
1031 0, SLAB_HWCACHE_ALIGN,
20c2df83 1032 NULL);
1da177e4
LT
1033 if (!rpc_buffer_slabp)
1034 goto err_nomem;
93d2341c
MD
1035 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1036 rpc_task_slabp);
1da177e4
LT
1037 if (!rpc_task_mempool)
1038 goto err_nomem;
93d2341c
MD
1039 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1040 rpc_buffer_slabp);
1da177e4
LT
1041 if (!rpc_buffer_mempool)
1042 goto err_nomem;
1043 return 0;
1044err_nomem:
1045 rpc_destroy_mempool();
1046 return -ENOMEM;
1047}