]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - net/sunrpc/sched.c
Merge branch 'fixes' of master.kernel.org:/home/rmk/linux-2.6-arm
[mirror_ubuntu-artful-kernel.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{
c44fe705 249 rpc_task_set_debuginfo(task);
58f9612c 250 set_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
e6b3c4db
TM
251}
252
44c28873
TM
253/*
254 * Mark an RPC call as having completed by clearing the 'active' bit
bf294b41 255 * and then waking up all tasks that were sleeping.
44c28873 256 */
bf294b41 257static int rpc_complete_task(struct rpc_task *task)
44c28873 258{
bf294b41
TM
259 void *m = &task->tk_runstate;
260 wait_queue_head_t *wq = bit_waitqueue(m, RPC_TASK_ACTIVE);
261 struct wait_bit_key k = __WAIT_BIT_KEY_INITIALIZER(m, RPC_TASK_ACTIVE);
262 unsigned long flags;
263 int ret;
264
265 spin_lock_irqsave(&wq->lock, flags);
e6b3c4db 266 clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
bf294b41
TM
267 ret = atomic_dec_and_test(&task->tk_count);
268 if (waitqueue_active(wq))
269 __wake_up_locked_key(wq, TASK_NORMAL, &k);
270 spin_unlock_irqrestore(&wq->lock, flags);
271 return ret;
44c28873
TM
272}
273
274/*
275 * Allow callers to wait for completion of an RPC call
bf294b41
TM
276 *
277 * Note the use of out_of_line_wait_on_bit() rather than wait_on_bit()
278 * to enforce taking of the wq->lock and hence avoid races with
279 * rpc_complete_task().
44c28873
TM
280 */
281int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
282{
283 if (action == NULL)
150030b7 284 action = rpc_wait_bit_killable;
bf294b41 285 return out_of_line_wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
150030b7 286 action, TASK_KILLABLE);
44c28873 287}
e8914c65 288EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
44c28873 289
1da177e4
LT
290/*
291 * Make an RPC task runnable.
292 *
cca5172a 293 * Note: If the task is ASYNC, this must be called with
1da177e4
LT
294 * the spinlock held to protect the wait queue operation.
295 */
296static void rpc_make_runnable(struct rpc_task *task)
297{
1da177e4 298 rpc_clear_queued(task);
cc4dc59e
CS
299 if (rpc_test_and_set_running(task))
300 return;
1da177e4 301 if (RPC_IS_ASYNC(task)) {
65f27f38 302 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
cee6a537 303 queue_work(rpciod_workqueue, &task->u.tk_work);
1da177e4 304 } else
96651ab3 305 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
1da177e4
LT
306}
307
1da177e4
LT
308/*
309 * Prepare for sleeping on a wait queue.
310 * By always appending tasks to the list we ensure FIFO behavior.
311 * NB: An RPC task will only receive interrupt-driven events as long
312 * as it's on a wait queue.
313 */
314static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
5d00837b 315 rpc_action action)
1da177e4 316{
46121cf7
CL
317 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
318 task->tk_pid, rpc_qname(q), jiffies);
1da177e4 319
1da177e4
LT
320 __rpc_add_wait_queue(q, task);
321
322 BUG_ON(task->tk_callback != NULL);
323 task->tk_callback = action;
eb276c0e 324 __rpc_add_timer(q, task);
1da177e4
LT
325}
326
327void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
5d00837b 328 rpc_action action)
1da177e4 329{
58f9612c
TM
330 /* We shouldn't ever put an inactive task to sleep */
331 BUG_ON(!RPC_IS_ACTIVATED(task));
e6b3c4db 332
1da177e4
LT
333 /*
334 * Protect the queue operations.
335 */
336 spin_lock_bh(&q->lock);
5d00837b 337 __rpc_sleep_on(q, task, action);
1da177e4
LT
338 spin_unlock_bh(&q->lock);
339}
e8914c65 340EXPORT_SYMBOL_GPL(rpc_sleep_on);
1da177e4
LT
341
342/**
343 * __rpc_do_wake_up_task - wake up a single rpc_task
96ef13b2 344 * @queue: wait queue
1da177e4
LT
345 * @task: task to be woken up
346 *
347 * Caller must hold queue->lock, and have cleared the task queued flag.
348 */
96ef13b2 349static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 350{
46121cf7
CL
351 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
352 task->tk_pid, jiffies);
1da177e4 353
1da177e4
LT
354 /* Has the task been executed yet? If not, we cannot wake it up! */
355 if (!RPC_IS_ACTIVATED(task)) {
356 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
357 return;
358 }
359
96ef13b2 360 __rpc_remove_wait_queue(queue, task);
1da177e4
LT
361
362 rpc_make_runnable(task);
363
46121cf7 364 dprintk("RPC: __rpc_wake_up_task done\n");
1da177e4
LT
365}
366
367/*
96ef13b2 368 * Wake up a queued task while the queue lock is being held
1da177e4 369 */
96ef13b2 370static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 371{
f5fb7b06
TM
372 if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
373 __rpc_do_wake_up_task(queue, task);
1da177e4
LT
374}
375
48f18612
AB
376/*
377 * Tests whether rpc queue is empty
378 */
379int rpc_queue_empty(struct rpc_wait_queue *queue)
380{
381 int res;
382
383 spin_lock_bh(&queue->lock);
384 res = queue->qlen;
385 spin_unlock_bh(&queue->lock);
a02cec21 386 return res == 0;
48f18612
AB
387}
388EXPORT_SYMBOL_GPL(rpc_queue_empty);
389
1da177e4 390/*
96ef13b2 391 * Wake up a task on a specific queue
1da177e4 392 */
96ef13b2 393void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
1da177e4 394{
5e4424af 395 spin_lock_bh(&queue->lock);
96ef13b2 396 rpc_wake_up_task_queue_locked(queue, task);
5e4424af 397 spin_unlock_bh(&queue->lock);
1da177e4 398}
96ef13b2
TM
399EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
400
1da177e4
LT
401/*
402 * Wake up the next task on a priority queue.
403 */
404static struct rpc_task * __rpc_wake_up_next_priority(struct rpc_wait_queue *queue)
405{
406 struct list_head *q;
407 struct rpc_task *task;
408
409 /*
3ff7576d 410 * Service a batch of tasks from a single owner.
1da177e4
LT
411 */
412 q = &queue->tasks[queue->priority];
413 if (!list_empty(q)) {
414 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
3ff7576d 415 if (queue->owner == task->tk_owner) {
1da177e4
LT
416 if (--queue->nr)
417 goto out;
418 list_move_tail(&task->u.tk_wait.list, q);
419 }
420 /*
421 * Check if we need to switch queues.
422 */
423 if (--queue->count)
3ff7576d 424 goto new_owner;
1da177e4
LT
425 }
426
427 /*
428 * Service the next queue.
429 */
430 do {
431 if (q == &queue->tasks[0])
432 q = &queue->tasks[queue->maxpriority];
433 else
434 q = q - 1;
435 if (!list_empty(q)) {
436 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
437 goto new_queue;
438 }
439 } while (q != &queue->tasks[queue->priority]);
440
441 rpc_reset_waitqueue_priority(queue);
442 return NULL;
443
444new_queue:
445 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
3ff7576d
TM
446new_owner:
447 rpc_set_waitqueue_owner(queue, task->tk_owner);
1da177e4 448out:
96ef13b2 449 rpc_wake_up_task_queue_locked(queue, task);
1da177e4
LT
450 return task;
451}
452
453/*
454 * Wake up the next task on the wait queue.
455 */
456struct rpc_task * rpc_wake_up_next(struct rpc_wait_queue *queue)
457{
458 struct rpc_task *task = NULL;
459
46121cf7
CL
460 dprintk("RPC: wake_up_next(%p \"%s\")\n",
461 queue, rpc_qname(queue));
5e4424af 462 spin_lock_bh(&queue->lock);
1da177e4
LT
463 if (RPC_IS_PRIORITY(queue))
464 task = __rpc_wake_up_next_priority(queue);
465 else {
466 task_for_first(task, &queue->tasks[0])
96ef13b2 467 rpc_wake_up_task_queue_locked(queue, task);
1da177e4 468 }
5e4424af 469 spin_unlock_bh(&queue->lock);
1da177e4
LT
470
471 return task;
472}
e8914c65 473EXPORT_SYMBOL_GPL(rpc_wake_up_next);
1da177e4
LT
474
475/**
476 * rpc_wake_up - wake up all rpc_tasks
477 * @queue: rpc_wait_queue on which the tasks are sleeping
478 *
479 * Grabs queue->lock
480 */
481void rpc_wake_up(struct rpc_wait_queue *queue)
482{
e6d83d55 483 struct rpc_task *task, *next;
1da177e4 484 struct list_head *head;
e6d83d55 485
5e4424af 486 spin_lock_bh(&queue->lock);
1da177e4
LT
487 head = &queue->tasks[queue->maxpriority];
488 for (;;) {
e6d83d55 489 list_for_each_entry_safe(task, next, head, u.tk_wait.list)
96ef13b2 490 rpc_wake_up_task_queue_locked(queue, task);
1da177e4
LT
491 if (head == &queue->tasks[0])
492 break;
493 head--;
494 }
5e4424af 495 spin_unlock_bh(&queue->lock);
1da177e4 496}
e8914c65 497EXPORT_SYMBOL_GPL(rpc_wake_up);
1da177e4
LT
498
499/**
500 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
501 * @queue: rpc_wait_queue on which the tasks are sleeping
502 * @status: status value to set
503 *
504 * Grabs queue->lock
505 */
506void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
507{
e6d83d55 508 struct rpc_task *task, *next;
1da177e4 509 struct list_head *head;
1da177e4 510
5e4424af 511 spin_lock_bh(&queue->lock);
1da177e4
LT
512 head = &queue->tasks[queue->maxpriority];
513 for (;;) {
e6d83d55 514 list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
1da177e4 515 task->tk_status = status;
96ef13b2 516 rpc_wake_up_task_queue_locked(queue, task);
1da177e4
LT
517 }
518 if (head == &queue->tasks[0])
519 break;
520 head--;
521 }
5e4424af 522 spin_unlock_bh(&queue->lock);
1da177e4 523}
e8914c65 524EXPORT_SYMBOL_GPL(rpc_wake_up_status);
1da177e4 525
36df9aae
TM
526static void __rpc_queue_timer_fn(unsigned long ptr)
527{
528 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
529 struct rpc_task *task, *n;
530 unsigned long expires, now, timeo;
531
532 spin_lock(&queue->lock);
533 expires = now = jiffies;
534 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
535 timeo = task->u.tk_wait.expires;
536 if (time_after_eq(now, timeo)) {
36df9aae
TM
537 dprintk("RPC: %5u timeout\n", task->tk_pid);
538 task->tk_status = -ETIMEDOUT;
539 rpc_wake_up_task_queue_locked(queue, task);
540 continue;
541 }
542 if (expires == now || time_after(expires, timeo))
543 expires = timeo;
544 }
545 if (!list_empty(&queue->timer_list.list))
546 rpc_set_queue_timer(queue, expires);
547 spin_unlock(&queue->lock);
548}
549
8014793b
TM
550static void __rpc_atrun(struct rpc_task *task)
551{
5d00837b 552 task->tk_status = 0;
8014793b
TM
553}
554
1da177e4
LT
555/*
556 * Run a task at a later time
557 */
8014793b 558void rpc_delay(struct rpc_task *task, unsigned long delay)
1da177e4
LT
559{
560 task->tk_timeout = delay;
5d00837b 561 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
1da177e4 562}
e8914c65 563EXPORT_SYMBOL_GPL(rpc_delay);
1da177e4 564
4ce70ada
TM
565/*
566 * Helper to call task->tk_ops->rpc_call_prepare
567 */
aae2006e 568void rpc_prepare_task(struct rpc_task *task)
4ce70ada
TM
569{
570 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
571}
572
d05fdb0c 573/*
963d8fe5 574 * Helper that calls task->tk_ops->rpc_call_done if it exists
d05fdb0c 575 */
abbcf28f 576void rpc_exit_task(struct rpc_task *task)
d05fdb0c 577{
abbcf28f 578 task->tk_action = NULL;
963d8fe5
TM
579 if (task->tk_ops->rpc_call_done != NULL) {
580 task->tk_ops->rpc_call_done(task, task->tk_calldata);
d05fdb0c 581 if (task->tk_action != NULL) {
abbcf28f
TM
582 WARN_ON(RPC_ASSASSINATED(task));
583 /* Always release the RPC slot and buffer memory */
584 xprt_release(task);
d05fdb0c
TM
585 }
586 }
d05fdb0c 587}
d9b6cd94
TM
588
589void rpc_exit(struct rpc_task *task, int status)
590{
591 task->tk_status = status;
592 task->tk_action = rpc_exit_task;
593 if (RPC_IS_QUEUED(task))
594 rpc_wake_up_queued_task(task->tk_waitqueue, task);
595}
596EXPORT_SYMBOL_GPL(rpc_exit);
d05fdb0c 597
bbd5a1f9
TM
598void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
599{
a86dc496 600 if (ops->rpc_release != NULL)
bbd5a1f9 601 ops->rpc_release(calldata);
bbd5a1f9
TM
602}
603
1da177e4
LT
604/*
605 * This is the RPC `scheduler' (or rather, the finite state machine).
606 */
2efef837 607static void __rpc_execute(struct rpc_task *task)
1da177e4 608{
eb9b55ab
TM
609 struct rpc_wait_queue *queue;
610 int task_is_async = RPC_IS_ASYNC(task);
611 int status = 0;
1da177e4 612
46121cf7
CL
613 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
614 task->tk_pid, task->tk_flags);
1da177e4
LT
615
616 BUG_ON(RPC_IS_QUEUED(task));
617
d05fdb0c 618 for (;;) {
1da177e4
LT
619
620 /*
621 * Execute any pending callback.
622 */
a486aeda 623 if (task->tk_callback) {
1da177e4 624 void (*save_callback)(struct rpc_task *);
cca5172a
YH
625
626 /*
a486aeda
BF
627 * We set tk_callback to NULL before calling it,
628 * in case it sets the tk_callback field itself:
1da177e4 629 */
a486aeda
BF
630 save_callback = task->tk_callback;
631 task->tk_callback = NULL;
1da177e4 632 save_callback(task);
e020c680
TM
633 } else {
634 /*
635 * Perform the next FSM step.
636 * tk_action may be NULL when the task has been killed
637 * by someone else.
638 */
abbcf28f 639 if (task->tk_action == NULL)
1da177e4 640 break;
abbcf28f 641 task->tk_action(task);
1da177e4
LT
642 }
643
644 /*
645 * Lockless check for whether task is sleeping or not.
646 */
647 if (!RPC_IS_QUEUED(task))
648 continue;
eb9b55ab
TM
649 /*
650 * The queue->lock protects against races with
651 * rpc_make_runnable().
652 *
653 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
654 * rpc_task, rpc_make_runnable() can assign it to a
655 * different workqueue. We therefore cannot assume that the
656 * rpc_task pointer may still be dereferenced.
657 */
658 queue = task->tk_waitqueue;
659 spin_lock_bh(&queue->lock);
660 if (!RPC_IS_QUEUED(task)) {
661 spin_unlock_bh(&queue->lock);
1da177e4
LT
662 continue;
663 }
eb9b55ab
TM
664 rpc_clear_running(task);
665 spin_unlock_bh(&queue->lock);
666 if (task_is_async)
667 return;
1da177e4
LT
668
669 /* sync task: sleep here */
46121cf7 670 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
96651ab3 671 status = out_of_line_wait_on_bit(&task->tk_runstate,
150030b7
MW
672 RPC_TASK_QUEUED, rpc_wait_bit_killable,
673 TASK_KILLABLE);
96651ab3 674 if (status == -ERESTARTSYS) {
1da177e4
LT
675 /*
676 * When a sync task receives a signal, it exits with
677 * -ERESTARTSYS. In order to catch any callbacks that
678 * clean up after sleeping on some queue, we don't
679 * break the loop here, but go around once more.
680 */
46121cf7 681 dprintk("RPC: %5u got signal\n", task->tk_pid);
96651ab3
TM
682 task->tk_flags |= RPC_TASK_KILLED;
683 rpc_exit(task, -ERESTARTSYS);
1da177e4
LT
684 }
685 rpc_set_running(task);
46121cf7 686 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
1da177e4
LT
687 }
688
46121cf7
CL
689 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
690 task->tk_status);
1da177e4
LT
691 /* Release all resources associated with the task */
692 rpc_release_task(task);
1da177e4
LT
693}
694
695/*
696 * User-visible entry point to the scheduler.
697 *
698 * This may be called recursively if e.g. an async NFS task updates
699 * the attributes and finds that dirty pages must be flushed.
700 * NOTE: Upon exit of this function the task is guaranteed to be
701 * released. In particular note that tk_release() will have
702 * been called, so your task memory may have been freed.
703 */
2efef837 704void rpc_execute(struct rpc_task *task)
1da177e4 705{
44c28873 706 rpc_set_active(task);
d6a1ed08
TM
707 rpc_make_runnable(task);
708 if (!RPC_IS_ASYNC(task))
709 __rpc_execute(task);
1da177e4
LT
710}
711
65f27f38 712static void rpc_async_schedule(struct work_struct *work)
1da177e4 713{
65f27f38 714 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
1da177e4
LT
715}
716
02107148
CL
717/**
718 * rpc_malloc - allocate an RPC buffer
719 * @task: RPC task that will use this buffer
720 * @size: requested byte size
1da177e4 721 *
c5a4dd8b
CL
722 * To prevent rpciod from hanging, this allocator never sleeps,
723 * returning NULL if the request cannot be serviced immediately.
724 * The caller can arrange to sleep in a way that is safe for rpciod.
725 *
726 * Most requests are 'small' (under 2KiB) and can be serviced from a
727 * mempool, ensuring that NFS reads and writes can always proceed,
728 * and that there is good locality of reference for these buffers.
729 *
1da177e4 730 * In order to avoid memory starvation triggering more writebacks of
c5a4dd8b 731 * NFS requests, we avoid using GFP_KERNEL.
1da177e4 732 */
c5a4dd8b 733void *rpc_malloc(struct rpc_task *task, size_t size)
1da177e4 734{
aa3d1fae 735 struct rpc_buffer *buf;
c5a4dd8b 736 gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
1da177e4 737
aa3d1fae 738 size += sizeof(struct rpc_buffer);
c5a4dd8b
CL
739 if (size <= RPC_BUFFER_MAXSIZE)
740 buf = mempool_alloc(rpc_buffer_mempool, gfp);
1da177e4 741 else
c5a4dd8b 742 buf = kmalloc(size, gfp);
ddce40df
PZ
743
744 if (!buf)
745 return NULL;
746
aa3d1fae 747 buf->len = size;
215d0678 748 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
c5a4dd8b 749 task->tk_pid, size, buf);
aa3d1fae 750 return &buf->data;
1da177e4 751}
12444809 752EXPORT_SYMBOL_GPL(rpc_malloc);
1da177e4 753
02107148
CL
754/**
755 * rpc_free - free buffer allocated via rpc_malloc
c5a4dd8b 756 * @buffer: buffer to free
02107148
CL
757 *
758 */
c5a4dd8b 759void rpc_free(void *buffer)
1da177e4 760{
aa3d1fae
CL
761 size_t size;
762 struct rpc_buffer *buf;
02107148 763
c5a4dd8b
CL
764 if (!buffer)
765 return;
aa3d1fae
CL
766
767 buf = container_of(buffer, struct rpc_buffer, data);
768 size = buf->len;
c5a4dd8b 769
215d0678 770 dprintk("RPC: freeing buffer of size %zu at %p\n",
c5a4dd8b 771 size, buf);
aa3d1fae 772
c5a4dd8b
CL
773 if (size <= RPC_BUFFER_MAXSIZE)
774 mempool_free(buf, rpc_buffer_mempool);
775 else
776 kfree(buf);
1da177e4 777}
12444809 778EXPORT_SYMBOL_GPL(rpc_free);
1da177e4
LT
779
780/*
781 * Creation and deletion of RPC task structures
782 */
47fe0648 783static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
1da177e4
LT
784{
785 memset(task, 0, sizeof(*task));
44c28873 786 atomic_set(&task->tk_count, 1);
84115e1c
TM
787 task->tk_flags = task_setup_data->flags;
788 task->tk_ops = task_setup_data->callback_ops;
789 task->tk_calldata = task_setup_data->callback_data;
6529eba0 790 INIT_LIST_HEAD(&task->tk_task);
1da177e4
LT
791
792 /* Initialize retry counters */
793 task->tk_garb_retry = 2;
794 task->tk_cred_retry = 2;
795
3ff7576d
TM
796 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
797 task->tk_owner = current->tgid;
1da177e4
LT
798
799 /* Initialize workqueue for async tasks */
32bfb5c0 800 task->tk_workqueue = task_setup_data->workqueue;
1da177e4 801
84115e1c
TM
802 if (task->tk_ops->rpc_call_prepare != NULL)
803 task->tk_action = rpc_prepare_task;
963d8fe5 804
ef759a2e 805 /* starting timestamp */
ff839970 806 task->tk_start = ktime_get();
ef759a2e 807
46121cf7 808 dprintk("RPC: new task initialized, procpid %u\n",
ba25f9dc 809 task_pid_nr(current));
1da177e4
LT
810}
811
812static struct rpc_task *
813rpc_alloc_task(void)
814{
815 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
816}
817
1da177e4 818/*
90c5755f 819 * Create a new task for the specified client.
1da177e4 820 */
84115e1c 821struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
1da177e4 822{
e8f5d77c
TM
823 struct rpc_task *task = setup_data->task;
824 unsigned short flags = 0;
825
826 if (task == NULL) {
827 task = rpc_alloc_task();
19445b99
TM
828 if (task == NULL) {
829 rpc_release_calldata(setup_data->callback_ops,
830 setup_data->callback_data);
831 return ERR_PTR(-ENOMEM);
832 }
e8f5d77c
TM
833 flags = RPC_TASK_DYNAMIC;
834 }
1da177e4 835
84115e1c 836 rpc_init_task(task, setup_data);
e8f5d77c 837 task->tk_flags |= flags;
46121cf7 838 dprintk("RPC: allocated task %p\n", task);
1da177e4 839 return task;
1da177e4
LT
840}
841
32bfb5c0 842static void rpc_free_task(struct rpc_task *task)
1da177e4 843{
963d8fe5
TM
844 const struct rpc_call_ops *tk_ops = task->tk_ops;
845 void *calldata = task->tk_calldata;
1da177e4 846
5e4424af
TM
847 if (task->tk_flags & RPC_TASK_DYNAMIC) {
848 dprintk("RPC: %5u freeing task\n", task->tk_pid);
849 mempool_free(task, rpc_task_mempool);
850 }
32bfb5c0
TM
851 rpc_release_calldata(tk_ops, calldata);
852}
853
854static void rpc_async_release(struct work_struct *work)
855{
856 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
857}
858
bf294b41 859static void rpc_release_resources_task(struct rpc_task *task)
32bfb5c0 860{
e6b3c4db
TM
861 if (task->tk_rqstp)
862 xprt_release(task);
a271c5a0 863 if (task->tk_msg.rpc_cred) {
a17c2153 864 put_rpccred(task->tk_msg.rpc_cred);
a271c5a0
OH
865 task->tk_msg.rpc_cred = NULL;
866 }
58f9612c 867 rpc_task_release_client(task);
bf294b41
TM
868}
869
870static void rpc_final_put_task(struct rpc_task *task,
871 struct workqueue_struct *q)
872{
873 if (q != NULL) {
32bfb5c0 874 INIT_WORK(&task->u.tk_work, rpc_async_release);
bf294b41 875 queue_work(q, &task->u.tk_work);
32bfb5c0
TM
876 } else
877 rpc_free_task(task);
e6b3c4db 878}
bf294b41
TM
879
880static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
881{
882 if (atomic_dec_and_test(&task->tk_count)) {
883 rpc_release_resources_task(task);
884 rpc_final_put_task(task, q);
885 }
886}
887
888void rpc_put_task(struct rpc_task *task)
889{
890 rpc_do_put_task(task, NULL);
891}
e8914c65 892EXPORT_SYMBOL_GPL(rpc_put_task);
e6b3c4db 893
bf294b41
TM
894void rpc_put_task_async(struct rpc_task *task)
895{
896 rpc_do_put_task(task, task->tk_workqueue);
897}
898EXPORT_SYMBOL_GPL(rpc_put_task_async);
899
bde8f00c 900static void rpc_release_task(struct rpc_task *task)
e6b3c4db 901{
46121cf7 902 dprintk("RPC: %5u release task\n", task->tk_pid);
1da177e4 903
1da177e4 904 BUG_ON (RPC_IS_QUEUED(task));
1da177e4 905
bf294b41 906 rpc_release_resources_task(task);
e6b3c4db 907
bf294b41
TM
908 /*
909 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
910 * so it should be safe to use task->tk_count as a test for whether
911 * or not any other processes still hold references to our rpc_task.
912 */
913 if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
914 /* Wake up anyone who may be waiting for task completion */
915 if (!rpc_complete_task(task))
916 return;
917 } else {
918 if (!atomic_dec_and_test(&task->tk_count))
919 return;
920 }
921 rpc_final_put_task(task, task->tk_workqueue);
1da177e4
LT
922}
923
b247bbf1
TM
924int rpciod_up(void)
925{
926 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
927}
928
929void rpciod_down(void)
930{
931 module_put(THIS_MODULE);
932}
933
1da177e4 934/*
b247bbf1 935 * Start up the rpciod workqueue.
1da177e4 936 */
b247bbf1 937static int rpciod_start(void)
1da177e4
LT
938{
939 struct workqueue_struct *wq;
ab418d70 940
1da177e4
LT
941 /*
942 * Create the rpciod thread and wait for it to start.
943 */
ab418d70 944 dprintk("RPC: creating workqueue rpciod\n");
ada609ee 945 wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM, 0);
1da177e4 946 rpciod_workqueue = wq;
b247bbf1 947 return rpciod_workqueue != NULL;
1da177e4
LT
948}
949
b247bbf1 950static void rpciod_stop(void)
1da177e4 951{
b247bbf1 952 struct workqueue_struct *wq = NULL;
ab418d70 953
b247bbf1
TM
954 if (rpciod_workqueue == NULL)
955 return;
ab418d70 956 dprintk("RPC: destroying workqueue rpciod\n");
1da177e4 957
b247bbf1
TM
958 wq = rpciod_workqueue;
959 rpciod_workqueue = NULL;
960 destroy_workqueue(wq);
1da177e4
LT
961}
962
1da177e4
LT
963void
964rpc_destroy_mempool(void)
965{
b247bbf1 966 rpciod_stop();
1da177e4
LT
967 if (rpc_buffer_mempool)
968 mempool_destroy(rpc_buffer_mempool);
969 if (rpc_task_mempool)
970 mempool_destroy(rpc_task_mempool);
1a1d92c1
AD
971 if (rpc_task_slabp)
972 kmem_cache_destroy(rpc_task_slabp);
973 if (rpc_buffer_slabp)
974 kmem_cache_destroy(rpc_buffer_slabp);
f6a1cc89 975 rpc_destroy_wait_queue(&delay_queue);
1da177e4
LT
976}
977
978int
979rpc_init_mempool(void)
980{
f6a1cc89
TM
981 /*
982 * The following is not strictly a mempool initialisation,
983 * but there is no harm in doing it here
984 */
985 rpc_init_wait_queue(&delay_queue, "delayq");
986 if (!rpciod_start())
987 goto err_nomem;
988
1da177e4
LT
989 rpc_task_slabp = kmem_cache_create("rpc_tasks",
990 sizeof(struct rpc_task),
991 0, SLAB_HWCACHE_ALIGN,
20c2df83 992 NULL);
1da177e4
LT
993 if (!rpc_task_slabp)
994 goto err_nomem;
995 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
996 RPC_BUFFER_MAXSIZE,
997 0, SLAB_HWCACHE_ALIGN,
20c2df83 998 NULL);
1da177e4
LT
999 if (!rpc_buffer_slabp)
1000 goto err_nomem;
93d2341c
MD
1001 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1002 rpc_task_slabp);
1da177e4
LT
1003 if (!rpc_task_mempool)
1004 goto err_nomem;
93d2341c
MD
1005 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1006 rpc_buffer_slabp);
1da177e4
LT
1007 if (!rpc_buffer_mempool)
1008 goto err_nomem;
1009 return 0;
1010err_nomem:
1011 rpc_destroy_mempool();
1012 return -ENOMEM;
1013}