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