blob: 043eef4c15a2a975be9bfda9b8739bf295aba40c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/net/sunrpc/sched.c
3 *
4 * Scheduling for synchronous and asynchronous RPC requests.
5 *
6 * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -08007 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * 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>
Arjan van de Ven4a3e2f72006-03-20 22:33:17 -080021#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25#ifdef RPC_DEBUG
26#define RPCDBG_FACILITY RPCDBG_SCHED
27#define RPC_TASK_MAGIC_ID 0xf00baa
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#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)
Christoph Lametere18b8902006-12-06 20:33:20 -080036static struct kmem_cache *rpc_task_slabp __read_mostly;
37static struct kmem_cache *rpc_buffer_slabp __read_mostly;
Eric Dumazetba899662005-08-26 12:05:31 -070038static mempool_t *rpc_task_mempool __read_mostly;
39static mempool_t *rpc_buffer_mempool __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
David Howells65f27f32006-11-22 14:55:48 +000041static void rpc_async_schedule(struct work_struct *);
Trond Myklebustbde8f002007-01-24 11:54:53 -080042static void rpc_release_task(struct rpc_task *task);
Trond Myklebust36df9aa2007-07-18 16:18:52 -040043static void __rpc_queue_timer_fn(unsigned long ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 * RPC tasks sit here while waiting for conditions to improve.
47 */
Trond Myklebusta4a87492007-07-18 13:24:19 -040048static struct rpc_wait_queue delay_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * rpciod-related stuff
52 */
Trond Myklebust24c5d9d2006-03-20 13:44:08 -050053struct workqueue_struct *rpciod_workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 * 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 */
Trond Myklebust5d008372008-02-22 16:34:17 -050060static void
Trond Myklebusteb276c02008-02-22 17:27:59 -050061__rpc_disable_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062{
Trond Myklebust36df9aa2007-07-18 16:18:52 -040063 if (task->tk_timeout == 0)
64 return;
Chuck Lever46121cf2007-01-31 12:14:08 -050065 dprintk("RPC: %5u disabling timer\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 task->tk_timeout = 0;
Trond Myklebust36df9aa2007-07-18 16:18:52 -040067 list_del(&task->u.tk_wait.timer_list);
Trond Myklebusteb276c02008-02-22 17:27:59 -050068 if (list_empty(&queue->timer_list.list))
69 del_timer(&queue->timer_list.timer);
Trond Myklebust36df9aa2007-07-18 16:18:52 -040070}
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077}
78
79/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 * Set up a timer for the current task.
81 */
Trond Myklebust5d008372008-02-22 16:34:17 -050082static void
Trond Myklebusteb276c02008-02-22 17:27:59 -050083__rpc_add_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
85 if (!task->tk_timeout)
86 return;
87
Chuck Lever46121cf2007-01-31 12:14:08 -050088 dprintk("RPC: %5u setting alarm for %lu ms\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 task->tk_pid, task->tk_timeout * 1000 / HZ);
90
Trond Myklebusteb276c02008-02-22 17:27:59 -050091 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095}
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) {
Trond Myklebust3ff75762007-07-14 15:40:00 -0400110 if (t->tk_owner == task->tk_owner) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 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]);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500136 task->tk_waitqueue = queue;
Chuck Levere19b63d2006-03-20 13:44:15 -0500137 queue->qlen++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 rpc_set_queued(task);
139
Chuck Lever46121cf2007-01-31 12:14:08 -0500140 dprintk("RPC: %5u added to queue %p \"%s\"\n",
141 task->tk_pid, queue, rpc_qname(queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
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 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156}
157
158/*
159 * Remove request from queue.
160 * Note: must be called with spin lock held.
161 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500162static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
Trond Myklebusteb276c02008-02-22 17:27:59 -0500164 __rpc_disable_timer(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 if (RPC_IS_PRIORITY(queue))
166 __rpc_remove_wait_queue_priority(task);
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400167 list_del(&task->u.tk_wait.list);
Chuck Levere19b63d2006-03-20 13:44:15 -0500168 queue->qlen--;
Chuck Lever46121cf2007-01-31 12:14:08 -0500169 dprintk("RPC: %5u removed from queue %p \"%s\"\n",
170 task->tk_pid, queue, rpc_qname(queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
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
Trond Myklebust3ff75762007-07-14 15:40:00 -0400179static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400181 queue->owner = pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 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);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400188 rpc_set_waitqueue_owner(queue, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189}
190
Trond Myklebust3ff75762007-07-14 15:40:00 -0400191static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192{
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]);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400198 queue->maxpriority = nr_queues - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 rpc_reset_waitqueue_priority(queue);
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400200 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203#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{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400210 __rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211}
212
213void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
214{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400215 __rpc_init_priority_wait_queue(queue, qname, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400217EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500219void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
220{
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400221 del_timer_sync(&queue->timer_list.timer);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500222}
223EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);
224
Matthew Wilcox150030b2007-12-06 16:24:39 -0500225static int rpc_wait_bit_killable(void *word)
Trond Myklebust44c28872006-01-03 09:55:06 +0100226{
Matthew Wilcox150030b2007-12-06 16:24:39 -0500227 if (fatal_signal_pending(current))
Trond Myklebust44c28872006-01-03 09:55:06 +0100228 return -ERESTARTSYS;
229 schedule();
230 return 0;
231}
232
Trond Myklebustc44fe702007-06-16 14:17:01 -0400233#ifdef RPC_DEBUG
234static void rpc_task_set_debuginfo(struct rpc_task *task)
235{
236 static atomic_t rpc_pid;
237
238 task->tk_magic = RPC_TASK_MAGIC_ID;
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
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500247static void rpc_set_active(struct rpc_task *task)
248{
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400249 struct rpc_clnt *clnt;
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500250 if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
251 return;
Trond Myklebustc44fe702007-06-16 14:17:01 -0400252 rpc_task_set_debuginfo(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500253 /* Add to global list of all tasks */
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400254 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 }
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500260}
261
Trond Myklebust44c28872006-01-03 09:55:06 +0100262/*
263 * Mark an RPC call as having completed by clearing the 'active' bit
264 */
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500265static void rpc_mark_complete_task(struct rpc_task *task)
Trond Myklebust44c28872006-01-03 09:55:06 +0100266{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500267 smp_mb__before_clear_bit();
268 clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
269 smp_mb__after_clear_bit();
Trond Myklebust44c28872006-01-03 09:55:06 +0100270 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)
Matthew Wilcox150030b2007-12-06 16:24:39 -0500279 action = rpc_wait_bit_killable;
Trond Myklebust44c28872006-01-03 09:55:06 +0100280 return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500281 action, TASK_KILLABLE);
Trond Myklebust44c28872006-01-03 09:55:06 +0100282}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400283EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
Trond Myklebust44c28872006-01-03 09:55:06 +0100284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/*
286 * Make an RPC task runnable.
287 *
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800288 * Note: If the task is ASYNC, this must be called with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 * the spinlock held to protect the wait queue operation.
290 */
291static void rpc_make_runnable(struct rpc_task *task)
292{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 rpc_clear_queued(task);
Christophe Saoutcc4dc59e2006-11-05 18:42:48 +0100294 if (rpc_test_and_set_running(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 return;
Christophe Saoutcc4dc59e2006-11-05 18:42:48 +0100296 /* We might have raced */
297 if (RPC_IS_QUEUED(task)) {
298 rpc_clear_running(task);
299 return;
300 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 if (RPC_IS_ASYNC(task)) {
302 int status;
303
David Howells65f27f32006-11-22 14:55:48 +0000304 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500305 status = queue_work(rpciod_workqueue, &task->u.tk_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 if (status < 0) {
307 printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
308 task->tk_status = status;
309 return;
310 }
311 } else
Trond Myklebust96651ab2005-06-22 17:16:21 +0000312 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313}
314
315/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 * Prepare for sleeping on a wait queue.
317 * By always appending tasks to the list we ensure FIFO behavior.
318 * NB: An RPC task will only receive interrupt-driven events as long
319 * as it's on a wait queue.
320 */
321static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
Trond Myklebust5d008372008-02-22 16:34:17 -0500322 rpc_action action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
Chuck Lever46121cf2007-01-31 12:14:08 -0500324 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
325 task->tk_pid, rpc_qname(q), jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
327 if (!RPC_IS_ASYNC(task) && !RPC_IS_ACTIVATED(task)) {
328 printk(KERN_ERR "RPC: Inactive synchronous task put to sleep!\n");
329 return;
330 }
331
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 __rpc_add_wait_queue(q, task);
333
334 BUG_ON(task->tk_callback != NULL);
335 task->tk_callback = action;
Trond Myklebusteb276c02008-02-22 17:27:59 -0500336 __rpc_add_timer(q, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337}
338
339void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
Trond Myklebust5d008372008-02-22 16:34:17 -0500340 rpc_action action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500342 /* Mark the task as being activated if so needed */
343 rpc_set_active(task);
344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 /*
346 * Protect the queue operations.
347 */
348 spin_lock_bh(&q->lock);
Trond Myklebust5d008372008-02-22 16:34:17 -0500349 __rpc_sleep_on(q, task, action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 spin_unlock_bh(&q->lock);
351}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400352EXPORT_SYMBOL_GPL(rpc_sleep_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
354/**
355 * __rpc_do_wake_up_task - wake up a single rpc_task
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500356 * @queue: wait queue
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 * @task: task to be woken up
358 *
359 * Caller must hold queue->lock, and have cleared the task queued flag.
360 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500361static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362{
Chuck Lever46121cf2007-01-31 12:14:08 -0500363 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
364 task->tk_pid, jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
366#ifdef RPC_DEBUG
367 BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
368#endif
369 /* Has the task been executed yet? If not, we cannot wake it up! */
370 if (!RPC_IS_ACTIVATED(task)) {
371 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
372 return;
373 }
374
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500375 __rpc_remove_wait_queue(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 rpc_make_runnable(task);
378
Chuck Lever46121cf2007-01-31 12:14:08 -0500379 dprintk("RPC: __rpc_wake_up_task done\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380}
381
382/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500383 * Wake up a queued task while the queue lock is being held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500385static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386{
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500387 if (!RPC_IS_QUEUED(task) || task->tk_waitqueue != queue)
388 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 if (rpc_start_wakeup(task)) {
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500390 __rpc_do_wake_up_task(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 rpc_finish_wakeup(task);
392 }
393}
394
395/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500396 * Wake up a task on a specific queue
397 */
398void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
399{
400 rcu_read_lock_bh();
401 spin_lock(&queue->lock);
402 rpc_wake_up_task_queue_locked(queue, task);
403 spin_unlock(&queue->lock);
404 rcu_read_unlock_bh();
405}
406EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
407
408/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 * Wake up the specified task
410 */
Trond Myklebustfda13932008-02-22 16:34:12 -0500411static void rpc_wake_up_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500413 rpc_wake_up_queued_task(task->tk_waitqueue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414}
415
416/*
417 * Wake up the next task on a priority queue.
418 */
419static struct rpc_task * __rpc_wake_up_next_priority(struct rpc_wait_queue *queue)
420{
421 struct list_head *q;
422 struct rpc_task *task;
423
424 /*
Trond Myklebust3ff75762007-07-14 15:40:00 -0400425 * Service a batch of tasks from a single owner.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 */
427 q = &queue->tasks[queue->priority];
428 if (!list_empty(q)) {
429 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400430 if (queue->owner == task->tk_owner) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 if (--queue->nr)
432 goto out;
433 list_move_tail(&task->u.tk_wait.list, q);
434 }
435 /*
436 * Check if we need to switch queues.
437 */
438 if (--queue->count)
Trond Myklebust3ff75762007-07-14 15:40:00 -0400439 goto new_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 }
441
442 /*
443 * Service the next queue.
444 */
445 do {
446 if (q == &queue->tasks[0])
447 q = &queue->tasks[queue->maxpriority];
448 else
449 q = q - 1;
450 if (!list_empty(q)) {
451 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
452 goto new_queue;
453 }
454 } while (q != &queue->tasks[queue->priority]);
455
456 rpc_reset_waitqueue_priority(queue);
457 return NULL;
458
459new_queue:
460 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
Trond Myklebust3ff75762007-07-14 15:40:00 -0400461new_owner:
462 rpc_set_waitqueue_owner(queue, task->tk_owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463out:
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500464 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 return task;
466}
467
468/*
469 * Wake up the next task on the wait queue.
470 */
471struct rpc_task * rpc_wake_up_next(struct rpc_wait_queue *queue)
472{
473 struct rpc_task *task = NULL;
474
Chuck Lever46121cf2007-01-31 12:14:08 -0500475 dprintk("RPC: wake_up_next(%p \"%s\")\n",
476 queue, rpc_qname(queue));
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500477 rcu_read_lock_bh();
478 spin_lock(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 if (RPC_IS_PRIORITY(queue))
480 task = __rpc_wake_up_next_priority(queue);
481 else {
482 task_for_first(task, &queue->tasks[0])
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500483 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 }
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500485 spin_unlock(&queue->lock);
486 rcu_read_unlock_bh();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
488 return task;
489}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400490EXPORT_SYMBOL_GPL(rpc_wake_up_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492/**
493 * rpc_wake_up - wake up all rpc_tasks
494 * @queue: rpc_wait_queue on which the tasks are sleeping
495 *
496 * Grabs queue->lock
497 */
498void rpc_wake_up(struct rpc_wait_queue *queue)
499{
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800500 struct rpc_task *task, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 struct list_head *head;
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800502
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500503 rcu_read_lock_bh();
504 spin_lock(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 head = &queue->tasks[queue->maxpriority];
506 for (;;) {
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800507 list_for_each_entry_safe(task, next, head, u.tk_wait.list)
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500508 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 if (head == &queue->tasks[0])
510 break;
511 head--;
512 }
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500513 spin_unlock(&queue->lock);
514 rcu_read_unlock_bh();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400516EXPORT_SYMBOL_GPL(rpc_wake_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518/**
519 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
520 * @queue: rpc_wait_queue on which the tasks are sleeping
521 * @status: status value to set
522 *
523 * Grabs queue->lock
524 */
525void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
526{
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800527 struct rpc_task *task, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 struct list_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500530 rcu_read_lock_bh();
531 spin_lock(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 head = &queue->tasks[queue->maxpriority];
533 for (;;) {
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800534 list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 task->tk_status = status;
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500536 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 }
538 if (head == &queue->tasks[0])
539 break;
540 head--;
541 }
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500542 spin_unlock(&queue->lock);
543 rcu_read_unlock_bh();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400545EXPORT_SYMBOL_GPL(rpc_wake_up_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400547static void __rpc_queue_timer_fn(unsigned long ptr)
548{
549 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
550 struct rpc_task *task, *n;
551 unsigned long expires, now, timeo;
552
553 spin_lock(&queue->lock);
554 expires = now = jiffies;
555 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
556 timeo = task->u.tk_wait.expires;
557 if (time_after_eq(now, timeo)) {
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400558 dprintk("RPC: %5u timeout\n", task->tk_pid);
559 task->tk_status = -ETIMEDOUT;
560 rpc_wake_up_task_queue_locked(queue, task);
561 continue;
562 }
563 if (expires == now || time_after(expires, timeo))
564 expires = timeo;
565 }
566 if (!list_empty(&queue->timer_list.list))
567 rpc_set_queue_timer(queue, expires);
568 spin_unlock(&queue->lock);
569}
570
Trond Myklebust80147932006-08-31 18:24:08 -0400571static void __rpc_atrun(struct rpc_task *task)
572{
Trond Myklebust5d008372008-02-22 16:34:17 -0500573 task->tk_status = 0;
Trond Myklebust80147932006-08-31 18:24:08 -0400574}
575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576/*
577 * Run a task at a later time
578 */
Trond Myklebust80147932006-08-31 18:24:08 -0400579void rpc_delay(struct rpc_task *task, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
581 task->tk_timeout = delay;
Trond Myklebust5d008372008-02-22 16:34:17 -0500582 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400584EXPORT_SYMBOL_GPL(rpc_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586/*
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100587 * Helper to call task->tk_ops->rpc_call_prepare
588 */
589static void rpc_prepare_task(struct rpc_task *task)
590{
Trond Myklebust6d5fcb52006-10-18 16:01:06 -0400591 lock_kernel();
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100592 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -0400593 unlock_kernel();
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100594}
595
596/*
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100597 * Helper that calls task->tk_ops->rpc_call_done if it exists
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000598 */
Trond Myklebustabbcf282006-01-03 09:55:03 +0100599void rpc_exit_task(struct rpc_task *task)
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000600{
Trond Myklebustabbcf282006-01-03 09:55:03 +0100601 task->tk_action = NULL;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100602 if (task->tk_ops->rpc_call_done != NULL) {
Trond Myklebust6d5fcb52006-10-18 16:01:06 -0400603 lock_kernel();
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100604 task->tk_ops->rpc_call_done(task, task->tk_calldata);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -0400605 unlock_kernel();
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000606 if (task->tk_action != NULL) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100607 WARN_ON(RPC_ASSASSINATED(task));
608 /* Always release the RPC slot and buffer memory */
609 xprt_release(task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000610 }
611 }
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000612}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400613EXPORT_SYMBOL_GPL(rpc_exit_task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000614
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400615void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
616{
617 if (ops->rpc_release != NULL) {
618 lock_kernel();
619 ops->rpc_release(calldata);
620 unlock_kernel();
621 }
622}
623
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000624/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 * This is the RPC `scheduler' (or rather, the finite state machine).
626 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800627static void __rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
629 int status = 0;
630
Chuck Lever46121cf2007-01-31 12:14:08 -0500631 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
632 task->tk_pid, task->tk_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
634 BUG_ON(RPC_IS_QUEUED(task));
635
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000636 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
638 /*
639 * Execute any pending callback.
640 */
641 if (RPC_DO_CALLBACK(task)) {
642 /* Define a callback save pointer */
643 void (*save_callback)(struct rpc_task *);
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800644
645 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 * If a callback exists, save it, reset it,
647 * call it.
648 * The save is needed to stop from resetting
649 * another callback set within the callback handler
650 * - Dave
651 */
652 save_callback=task->tk_callback;
653 task->tk_callback=NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 save_callback(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 }
656
657 /*
658 * Perform the next FSM step.
659 * tk_action may be NULL when the task has been killed
660 * by someone else.
661 */
662 if (!RPC_IS_QUEUED(task)) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100663 if (task->tk_action == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 break;
Trond Myklebustabbcf282006-01-03 09:55:03 +0100665 task->tk_action(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 }
667
668 /*
669 * Lockless check for whether task is sleeping or not.
670 */
671 if (!RPC_IS_QUEUED(task))
672 continue;
673 rpc_clear_running(task);
674 if (RPC_IS_ASYNC(task)) {
675 /* Careful! we may have raced... */
676 if (RPC_IS_QUEUED(task))
Trond Myklebust2efef832007-02-03 13:38:41 -0800677 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 if (rpc_test_and_set_running(task))
Trond Myklebust2efef832007-02-03 13:38:41 -0800679 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 continue;
681 }
682
683 /* sync task: sleep here */
Chuck Lever46121cf2007-01-31 12:14:08 -0500684 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000685 status = out_of_line_wait_on_bit(&task->tk_runstate,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500686 RPC_TASK_QUEUED, rpc_wait_bit_killable,
687 TASK_KILLABLE);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000688 if (status == -ERESTARTSYS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 /*
690 * When a sync task receives a signal, it exits with
691 * -ERESTARTSYS. In order to catch any callbacks that
692 * clean up after sleeping on some queue, we don't
693 * break the loop here, but go around once more.
694 */
Chuck Lever46121cf2007-01-31 12:14:08 -0500695 dprintk("RPC: %5u got signal\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000696 task->tk_flags |= RPC_TASK_KILLED;
697 rpc_exit(task, -ERESTARTSYS);
698 rpc_wake_up_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 }
700 rpc_set_running(task);
Chuck Lever46121cf2007-01-31 12:14:08 -0500701 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 }
703
Chuck Lever46121cf2007-01-31 12:14:08 -0500704 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
705 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 /* Release all resources associated with the task */
707 rpc_release_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
709
710/*
711 * User-visible entry point to the scheduler.
712 *
713 * This may be called recursively if e.g. an async NFS task updates
714 * the attributes and finds that dirty pages must be flushed.
715 * NOTE: Upon exit of this function the task is guaranteed to be
716 * released. In particular note that tk_release() will have
717 * been called, so your task memory may have been freed.
718 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800719void rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720{
Trond Myklebust44c28872006-01-03 09:55:06 +0100721 rpc_set_active(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 rpc_set_running(task);
Trond Myklebust2efef832007-02-03 13:38:41 -0800723 __rpc_execute(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724}
725
David Howells65f27f32006-11-22 14:55:48 +0000726static void rpc_async_schedule(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727{
David Howells65f27f32006-11-22 14:55:48 +0000728 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729}
730
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400731struct rpc_buffer {
732 size_t len;
733 char data[];
734};
735
Chuck Lever02107142006-01-03 09:55:49 +0100736/**
737 * rpc_malloc - allocate an RPC buffer
738 * @task: RPC task that will use this buffer
739 * @size: requested byte size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 *
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400741 * To prevent rpciod from hanging, this allocator never sleeps,
742 * returning NULL if the request cannot be serviced immediately.
743 * The caller can arrange to sleep in a way that is safe for rpciod.
744 *
745 * Most requests are 'small' (under 2KiB) and can be serviced from a
746 * mempool, ensuring that NFS reads and writes can always proceed,
747 * and that there is good locality of reference for these buffers.
748 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 * In order to avoid memory starvation triggering more writebacks of
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400750 * NFS requests, we avoid using GFP_KERNEL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400752void *rpc_malloc(struct rpc_task *task, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400754 struct rpc_buffer *buf;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400755 gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400757 size += sizeof(struct rpc_buffer);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400758 if (size <= RPC_BUFFER_MAXSIZE)
759 buf = mempool_alloc(rpc_buffer_mempool, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 else
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400761 buf = kmalloc(size, gfp);
Peter Zijlstraddce40d2007-05-09 08:30:11 +0200762
763 if (!buf)
764 return NULL;
765
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400766 buf->len = size;
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200767 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400768 task->tk_pid, size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400769 return &buf->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400771EXPORT_SYMBOL_GPL(rpc_malloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Chuck Lever02107142006-01-03 09:55:49 +0100773/**
774 * rpc_free - free buffer allocated via rpc_malloc
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400775 * @buffer: buffer to free
Chuck Lever02107142006-01-03 09:55:49 +0100776 *
777 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400778void rpc_free(void *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400780 size_t size;
781 struct rpc_buffer *buf;
Chuck Lever02107142006-01-03 09:55:49 +0100782
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400783 if (!buffer)
784 return;
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400785
786 buf = container_of(buffer, struct rpc_buffer, data);
787 size = buf->len;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400788
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200789 dprintk("RPC: freeing buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400790 size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400791
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400792 if (size <= RPC_BUFFER_MAXSIZE)
793 mempool_free(buf, rpc_buffer_mempool);
794 else
795 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400797EXPORT_SYMBOL_GPL(rpc_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
799/*
800 * Creation and deletion of RPC task structures
801 */
Trond Myklebust47fe0642007-10-25 18:42:55 -0400802static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803{
804 memset(task, 0, sizeof(*task));
Trond Myklebust44c28872006-01-03 09:55:06 +0100805 atomic_set(&task->tk_count, 1);
Trond Myklebust84115e12007-07-14 15:39:59 -0400806 task->tk_flags = task_setup_data->flags;
807 task->tk_ops = task_setup_data->callback_ops;
808 task->tk_calldata = task_setup_data->callback_data;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400809 INIT_LIST_HEAD(&task->tk_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
811 /* Initialize retry counters */
812 task->tk_garb_retry = 2;
813 task->tk_cred_retry = 2;
814
Trond Myklebust3ff75762007-07-14 15:40:00 -0400815 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
816 task->tk_owner = current->tgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
818 /* Initialize workqueue for async tasks */
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500819 task->tk_workqueue = task_setup_data->workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
Trond Myklebust84115e12007-07-14 15:39:59 -0400821 task->tk_client = task_setup_data->rpc_client;
822 if (task->tk_client != NULL) {
823 kref_get(&task->tk_client->cl_kref);
824 if (task->tk_client->cl_softrtry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 task->tk_flags |= RPC_TASK_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 }
827
Trond Myklebust84115e12007-07-14 15:39:59 -0400828 if (task->tk_ops->rpc_call_prepare != NULL)
829 task->tk_action = rpc_prepare_task;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100830
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400831 if (task_setup_data->rpc_message != NULL) {
832 memcpy(&task->tk_msg, task_setup_data->rpc_message, sizeof(task->tk_msg));
833 /* Bind the user cred */
834 if (task->tk_msg.rpc_cred != NULL)
835 rpcauth_holdcred(task);
836 else
837 rpcauth_bindcred(task);
838 if (task->tk_action == NULL)
839 rpc_call_start(task);
840 }
841
Chuck Leveref759a22006-03-20 13:44:17 -0500842 /* starting timestamp */
843 task->tk_start = jiffies;
844
Chuck Lever46121cf2007-01-31 12:14:08 -0500845 dprintk("RPC: new task initialized, procpid %u\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700846 task_pid_nr(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847}
848
849static struct rpc_task *
850rpc_alloc_task(void)
851{
852 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
853}
854
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500855static void rpc_free_task_rcu(struct rcu_head *rcu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856{
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500857 struct rpc_task *task = container_of(rcu, struct rpc_task, u.tk_rcu);
Chuck Lever46121cf2007-01-31 12:14:08 -0500858 dprintk("RPC: %5u freeing task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 mempool_free(task, rpc_task_mempool);
860}
861
862/*
Trond Myklebust90c57552007-06-09 19:49:36 -0400863 * Create a new task for the specified client.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400865struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400867 struct rpc_task *task = setup_data->task;
868 unsigned short flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400870 if (task == NULL) {
871 task = rpc_alloc_task();
872 if (task == NULL)
873 goto out;
874 flags = RPC_TASK_DYNAMIC;
875 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Trond Myklebust84115e12007-07-14 15:39:59 -0400877 rpc_init_task(task, setup_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400879 task->tk_flags |= flags;
Chuck Lever46121cf2007-01-31 12:14:08 -0500880 dprintk("RPC: allocated task %p\n", task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881out:
882 return task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
884
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500885static void rpc_free_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100887 const struct rpc_call_ops *tk_ops = task->tk_ops;
888 void *calldata = task->tk_calldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500890 if (task->tk_flags & RPC_TASK_DYNAMIC)
891 call_rcu_bh(&task->u.tk_rcu, rpc_free_task_rcu);
892 rpc_release_calldata(tk_ops, calldata);
893}
894
895static void rpc_async_release(struct work_struct *work)
896{
897 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
898}
899
900void rpc_put_task(struct rpc_task *task)
901{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500902 if (!atomic_dec_and_test(&task->tk_count))
903 return;
904 /* Release resources */
905 if (task->tk_rqstp)
906 xprt_release(task);
907 if (task->tk_msg.rpc_cred)
908 rpcauth_unbindcred(task);
909 if (task->tk_client) {
910 rpc_release_client(task->tk_client);
911 task->tk_client = NULL;
912 }
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500913 if (task->tk_workqueue != NULL) {
914 INIT_WORK(&task->u.tk_work, rpc_async_release);
915 queue_work(task->tk_workqueue, &task->u.tk_work);
916 } else
917 rpc_free_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500918}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400919EXPORT_SYMBOL_GPL(rpc_put_task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500920
Trond Myklebustbde8f002007-01-24 11:54:53 -0800921static void rpc_release_task(struct rpc_task *task)
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500922{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923#ifdef RPC_DEBUG
924 BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
925#endif
Chuck Lever46121cf2007-01-31 12:14:08 -0500926 dprintk("RPC: %5u release task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Trond Myklebust6529eba2007-06-14 16:40:14 -0400928 if (!list_empty(&task->tk_task)) {
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400929 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400930 /* Remove from client task list */
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400931 spin_lock(&clnt->cl_lock);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400932 list_del(&task->tk_task);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400933 spin_unlock(&clnt->cl_lock);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400934 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 BUG_ON (RPC_IS_QUEUED(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937#ifdef RPC_DEBUG
938 task->tk_magic = 0;
939#endif
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500940 /* Wake up anyone who is waiting for task completion */
941 rpc_mark_complete_task(task);
942
943 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944}
945
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946/*
947 * Kill all tasks for the given client.
948 * XXX: kill their descendants as well?
949 */
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400950void rpc_killall_tasks(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951{
952 struct rpc_task *rovr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400955 if (list_empty(&clnt->cl_tasks))
956 return;
957 dprintk("RPC: killing all tasks for client %p\n", clnt);
958 /*
959 * Spin lock all_tasks to prevent changes...
960 */
961 spin_lock(&clnt->cl_lock);
962 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 if (! RPC_IS_ACTIVATED(rovr))
964 continue;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400965 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 rovr->tk_flags |= RPC_TASK_KILLED;
967 rpc_exit(rovr, -EIO);
968 rpc_wake_up_task(rovr);
969 }
970 }
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400971 spin_unlock(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400973EXPORT_SYMBOL_GPL(rpc_killall_tasks);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400975int rpciod_up(void)
976{
977 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
978}
979
980void rpciod_down(void)
981{
982 module_put(THIS_MODULE);
983}
984
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985/*
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400986 * Start up the rpciod workqueue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 */
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400988static int rpciod_start(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989{
990 struct workqueue_struct *wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 /*
993 * Create the rpciod thread and wait for it to start.
994 */
Trond Myklebustab418d72007-06-14 17:08:36 -0400995 dprintk("RPC: creating workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 wq = create_workqueue("rpciod");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 rpciod_workqueue = wq;
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400998 return rpciod_workqueue != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999}
1000
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001001static void rpciod_stop(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001003 struct workqueue_struct *wq = NULL;
Trond Myklebustab418d72007-06-14 17:08:36 -04001004
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001005 if (rpciod_workqueue == NULL)
1006 return;
Trond Myklebustab418d72007-06-14 17:08:36 -04001007 dprintk("RPC: destroying workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001009 wq = rpciod_workqueue;
1010 rpciod_workqueue = NULL;
1011 destroy_workqueue(wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012}
1013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014void
1015rpc_destroy_mempool(void)
1016{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001017 rpciod_stop();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 if (rpc_buffer_mempool)
1019 mempool_destroy(rpc_buffer_mempool);
1020 if (rpc_task_mempool)
1021 mempool_destroy(rpc_task_mempool);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001022 if (rpc_task_slabp)
1023 kmem_cache_destroy(rpc_task_slabp);
1024 if (rpc_buffer_slabp)
1025 kmem_cache_destroy(rpc_buffer_slabp);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001026 rpc_destroy_wait_queue(&delay_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027}
1028
1029int
1030rpc_init_mempool(void)
1031{
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001032 /*
1033 * The following is not strictly a mempool initialisation,
1034 * but there is no harm in doing it here
1035 */
1036 rpc_init_wait_queue(&delay_queue, "delayq");
1037 if (!rpciod_start())
1038 goto err_nomem;
1039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1041 sizeof(struct rpc_task),
1042 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001043 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 if (!rpc_task_slabp)
1045 goto err_nomem;
1046 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1047 RPC_BUFFER_MAXSIZE,
1048 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001049 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 if (!rpc_buffer_slabp)
1051 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001052 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1053 rpc_task_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 if (!rpc_task_mempool)
1055 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001056 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1057 rpc_buffer_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 if (!rpc_buffer_mempool)
1059 goto err_nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 return 0;
1061err_nomem:
1062 rpc_destroy_mempool();
1063 return -ENOMEM;
1064}