blob: 4a843b883b89d8b906a1d9023248a6d85f3c0c3b [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/spinlock.h>
Arjan van de Ven4a3e2f72006-03-20 22:33:17 -080020#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Benny Halevy69518672009-09-10 12:25:04 +030024#include "sunrpc.h"
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#ifdef RPC_DEBUG
27#define RPCDBG_FACILITY RPCDBG_SCHED
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}
Alexandros Batsakis689cf5c2009-12-14 21:27:56 -0800212EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
215{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400216 __rpc_init_priority_wait_queue(queue, qname, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400218EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500220void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
221{
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400222 del_timer_sync(&queue->timer_list.timer);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500223}
224EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);
225
Matthew Wilcox150030b2007-12-06 16:24:39 -0500226static int rpc_wait_bit_killable(void *word)
Trond Myklebust44c28872006-01-03 09:55:06 +0100227{
Matthew Wilcox150030b2007-12-06 16:24:39 -0500228 if (fatal_signal_pending(current))
Trond Myklebust44c28872006-01-03 09:55:06 +0100229 return -ERESTARTSYS;
230 schedule();
231 return 0;
232}
233
Trond Myklebustc44fe702007-06-16 14:17:01 -0400234#ifdef RPC_DEBUG
235static void rpc_task_set_debuginfo(struct rpc_task *task)
236{
237 static atomic_t rpc_pid;
238
Trond Myklebustc44fe702007-06-16 14:17:01 -0400239 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 Saoutcc4dc592006-11-05 18:42:48 +0100294 if (rpc_test_and_set_running(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 return;
296 if (RPC_IS_ASYNC(task)) {
297 int status;
298
David Howells65f27f32006-11-22 14:55:48 +0000299 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500300 status = queue_work(rpciod_workqueue, &task->u.tk_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 if (status < 0) {
302 printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
303 task->tk_status = status;
304 return;
305 }
306 } else
Trond Myklebust96651ab2005-06-22 17:16:21 +0000307 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308}
309
310/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 * Prepare for sleeping on a wait queue.
312 * By always appending tasks to the list we ensure FIFO behavior.
313 * NB: An RPC task will only receive interrupt-driven events as long
314 * as it's on a wait queue.
315 */
316static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
Trond Myklebust5d008372008-02-22 16:34:17 -0500317 rpc_action action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318{
Chuck Lever46121cf2007-01-31 12:14:08 -0500319 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
320 task->tk_pid, rpc_qname(q), jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 if (!RPC_IS_ASYNC(task) && !RPC_IS_ACTIVATED(task)) {
323 printk(KERN_ERR "RPC: Inactive synchronous task put to sleep!\n");
324 return;
325 }
326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 __rpc_add_wait_queue(q, task);
328
329 BUG_ON(task->tk_callback != NULL);
330 task->tk_callback = action;
Trond Myklebusteb276c02008-02-22 17:27:59 -0500331 __rpc_add_timer(q, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332}
333
334void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
Trond Myklebust5d008372008-02-22 16:34:17 -0500335 rpc_action action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500337 /* Mark the task as being activated if so needed */
338 rpc_set_active(task);
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 /*
341 * Protect the queue operations.
342 */
343 spin_lock_bh(&q->lock);
Trond Myklebust5d008372008-02-22 16:34:17 -0500344 __rpc_sleep_on(q, task, action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 spin_unlock_bh(&q->lock);
346}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400347EXPORT_SYMBOL_GPL(rpc_sleep_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349/**
350 * __rpc_do_wake_up_task - wake up a single rpc_task
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500351 * @queue: wait queue
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 * @task: task to be woken up
353 *
354 * Caller must hold queue->lock, and have cleared the task queued flag.
355 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500356static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357{
Chuck Lever46121cf2007-01-31 12:14:08 -0500358 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
359 task->tk_pid, jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 /* Has the task been executed yet? If not, we cannot wake it up! */
362 if (!RPC_IS_ACTIVATED(task)) {
363 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
364 return;
365 }
366
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500367 __rpc_remove_wait_queue(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
369 rpc_make_runnable(task);
370
Chuck Lever46121cf2007-01-31 12:14:08 -0500371 dprintk("RPC: __rpc_wake_up_task done\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372}
373
374/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500375 * Wake up a queued task while the queue lock is being held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500377static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378{
Trond Myklebustf5fb7b062008-02-25 21:40:50 -0800379 if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
380 __rpc_do_wake_up_task(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381}
382
383/*
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800384 * Tests whether rpc queue is empty
385 */
386int rpc_queue_empty(struct rpc_wait_queue *queue)
387{
388 int res;
389
390 spin_lock_bh(&queue->lock);
391 res = queue->qlen;
392 spin_unlock_bh(&queue->lock);
393 return (res == 0);
394}
395EXPORT_SYMBOL_GPL(rpc_queue_empty);
396
397/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500398 * Wake up a task on a specific queue
399 */
400void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
401{
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800402 spin_lock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500403 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800404 spin_unlock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500405}
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 Myklebust5e4424a2008-02-25 21:53:49 -0800477 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 if (RPC_IS_PRIORITY(queue))
479 task = __rpc_wake_up_next_priority(queue);
480 else {
481 task_for_first(task, &queue->tasks[0])
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500482 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800484 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486 return task;
487}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400488EXPORT_SYMBOL_GPL(rpc_wake_up_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490/**
491 * rpc_wake_up - wake up all rpc_tasks
492 * @queue: rpc_wait_queue on which the tasks are sleeping
493 *
494 * Grabs queue->lock
495 */
496void rpc_wake_up(struct rpc_wait_queue *queue)
497{
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800498 struct rpc_task *task, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 struct list_head *head;
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800500
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800501 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 head = &queue->tasks[queue->maxpriority];
503 for (;;) {
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800504 list_for_each_entry_safe(task, next, head, u.tk_wait.list)
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500505 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 if (head == &queue->tasks[0])
507 break;
508 head--;
509 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800510 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400512EXPORT_SYMBOL_GPL(rpc_wake_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514/**
515 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
516 * @queue: rpc_wait_queue on which the tasks are sleeping
517 * @status: status value to set
518 *
519 * Grabs queue->lock
520 */
521void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
522{
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800523 struct rpc_task *task, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 struct list_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800526 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 head = &queue->tasks[queue->maxpriority];
528 for (;;) {
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800529 list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 task->tk_status = status;
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500531 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 }
533 if (head == &queue->tasks[0])
534 break;
535 head--;
536 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800537 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400539EXPORT_SYMBOL_GPL(rpc_wake_up_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400541static void __rpc_queue_timer_fn(unsigned long ptr)
542{
543 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
544 struct rpc_task *task, *n;
545 unsigned long expires, now, timeo;
546
547 spin_lock(&queue->lock);
548 expires = now = jiffies;
549 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
550 timeo = task->u.tk_wait.expires;
551 if (time_after_eq(now, timeo)) {
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400552 dprintk("RPC: %5u timeout\n", task->tk_pid);
553 task->tk_status = -ETIMEDOUT;
554 rpc_wake_up_task_queue_locked(queue, task);
555 continue;
556 }
557 if (expires == now || time_after(expires, timeo))
558 expires = timeo;
559 }
560 if (!list_empty(&queue->timer_list.list))
561 rpc_set_queue_timer(queue, expires);
562 spin_unlock(&queue->lock);
563}
564
Trond Myklebust80147932006-08-31 18:24:08 -0400565static void __rpc_atrun(struct rpc_task *task)
566{
Trond Myklebust5d008372008-02-22 16:34:17 -0500567 task->tk_status = 0;
Trond Myklebust80147932006-08-31 18:24:08 -0400568}
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570/*
571 * Run a task at a later time
572 */
Trond Myklebust80147932006-08-31 18:24:08 -0400573void rpc_delay(struct rpc_task *task, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574{
575 task->tk_timeout = delay;
Trond Myklebust5d008372008-02-22 16:34:17 -0500576 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400578EXPORT_SYMBOL_GPL(rpc_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580/*
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100581 * Helper to call task->tk_ops->rpc_call_prepare
582 */
Andy Adamsonaae20062009-04-01 09:22:40 -0400583void rpc_prepare_task(struct rpc_task *task)
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100584{
585 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
586}
587
588/*
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100589 * Helper that calls task->tk_ops->rpc_call_done if it exists
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000590 */
Trond Myklebustabbcf282006-01-03 09:55:03 +0100591void rpc_exit_task(struct rpc_task *task)
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000592{
Trond Myklebustabbcf282006-01-03 09:55:03 +0100593 task->tk_action = NULL;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100594 if (task->tk_ops->rpc_call_done != NULL) {
595 task->tk_ops->rpc_call_done(task, task->tk_calldata);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000596 if (task->tk_action != NULL) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100597 WARN_ON(RPC_ASSASSINATED(task));
598 /* Always release the RPC slot and buffer memory */
599 xprt_release(task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000600 }
601 }
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000602}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400603EXPORT_SYMBOL_GPL(rpc_exit_task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000604
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400605void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
606{
Trond Myklebusta86dc492008-06-11 13:37:09 -0400607 if (ops->rpc_release != NULL)
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400608 ops->rpc_release(calldata);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400609}
610
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000611/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 * This is the RPC `scheduler' (or rather, the finite state machine).
613 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800614static void __rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615{
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400616 struct rpc_wait_queue *queue;
617 int task_is_async = RPC_IS_ASYNC(task);
618 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Chuck Lever46121cf2007-01-31 12:14:08 -0500620 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
621 task->tk_pid, task->tk_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
623 BUG_ON(RPC_IS_QUEUED(task));
624
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000625 for (;;) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627 /*
628 * Execute any pending callback.
629 */
\\\"J. Bruce Fields\\\a486aed2008-06-09 16:51:35 -0400630 if (task->tk_callback) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 void (*save_callback)(struct rpc_task *);
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800632
633 /*
\\\"J. Bruce Fields\\\a486aed2008-06-09 16:51:35 -0400634 * We set tk_callback to NULL before calling it,
635 * in case it sets the tk_callback field itself:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 */
\\\"J. Bruce Fields\\\a486aed2008-06-09 16:51:35 -0400637 save_callback = task->tk_callback;
638 task->tk_callback = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 save_callback(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 }
641
642 /*
643 * Perform the next FSM step.
644 * tk_action may be NULL when the task has been killed
645 * by someone else.
646 */
647 if (!RPC_IS_QUEUED(task)) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100648 if (task->tk_action == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 break;
Trond Myklebustabbcf282006-01-03 09:55:03 +0100650 task->tk_action(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 }
652
653 /*
654 * Lockless check for whether task is sleeping or not.
655 */
656 if (!RPC_IS_QUEUED(task))
657 continue;
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400658 /*
659 * The queue->lock protects against races with
660 * rpc_make_runnable().
661 *
662 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
663 * rpc_task, rpc_make_runnable() can assign it to a
664 * different workqueue. We therefore cannot assume that the
665 * rpc_task pointer may still be dereferenced.
666 */
667 queue = task->tk_waitqueue;
668 spin_lock_bh(&queue->lock);
669 if (!RPC_IS_QUEUED(task)) {
670 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 continue;
672 }
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400673 rpc_clear_running(task);
674 spin_unlock_bh(&queue->lock);
675 if (task_is_async)
676 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
678 /* sync task: sleep here */
Chuck Lever46121cf2007-01-31 12:14:08 -0500679 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000680 status = out_of_line_wait_on_bit(&task->tk_runstate,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500681 RPC_TASK_QUEUED, rpc_wait_bit_killable,
682 TASK_KILLABLE);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000683 if (status == -ERESTARTSYS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 /*
685 * When a sync task receives a signal, it exits with
686 * -ERESTARTSYS. In order to catch any callbacks that
687 * clean up after sleeping on some queue, we don't
688 * break the loop here, but go around once more.
689 */
Chuck Lever46121cf2007-01-31 12:14:08 -0500690 dprintk("RPC: %5u got signal\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000691 task->tk_flags |= RPC_TASK_KILLED;
692 rpc_exit(task, -ERESTARTSYS);
693 rpc_wake_up_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 }
695 rpc_set_running(task);
Chuck Lever46121cf2007-01-31 12:14:08 -0500696 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 }
698
Chuck Lever46121cf2007-01-31 12:14:08 -0500699 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
700 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 /* Release all resources associated with the task */
702 rpc_release_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703}
704
705/*
706 * User-visible entry point to the scheduler.
707 *
708 * This may be called recursively if e.g. an async NFS task updates
709 * the attributes and finds that dirty pages must be flushed.
710 * NOTE: Upon exit of this function the task is guaranteed to be
711 * released. In particular note that tk_release() will have
712 * been called, so your task memory may have been freed.
713 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800714void rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
Trond Myklebust44c28872006-01-03 09:55:06 +0100716 rpc_set_active(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 rpc_set_running(task);
Trond Myklebust2efef832007-02-03 13:38:41 -0800718 __rpc_execute(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719}
720
David Howells65f27f32006-11-22 14:55:48 +0000721static void rpc_async_schedule(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722{
David Howells65f27f32006-11-22 14:55:48 +0000723 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724}
725
Chuck Lever02107142006-01-03 09:55:49 +0100726/**
727 * rpc_malloc - allocate an RPC buffer
728 * @task: RPC task that will use this buffer
729 * @size: requested byte size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 *
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400731 * To prevent rpciod from hanging, this allocator never sleeps,
732 * returning NULL if the request cannot be serviced immediately.
733 * The caller can arrange to sleep in a way that is safe for rpciod.
734 *
735 * Most requests are 'small' (under 2KiB) and can be serviced from a
736 * mempool, ensuring that NFS reads and writes can always proceed,
737 * and that there is good locality of reference for these buffers.
738 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 * In order to avoid memory starvation triggering more writebacks of
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400740 * NFS requests, we avoid using GFP_KERNEL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400742void *rpc_malloc(struct rpc_task *task, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400744 struct rpc_buffer *buf;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400745 gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400747 size += sizeof(struct rpc_buffer);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400748 if (size <= RPC_BUFFER_MAXSIZE)
749 buf = mempool_alloc(rpc_buffer_mempool, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 else
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400751 buf = kmalloc(size, gfp);
Peter Zijlstraddce40d2007-05-09 08:30:11 +0200752
753 if (!buf)
754 return NULL;
755
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400756 buf->len = size;
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200757 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400758 task->tk_pid, size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400759 return &buf->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400761EXPORT_SYMBOL_GPL(rpc_malloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Chuck Lever02107142006-01-03 09:55:49 +0100763/**
764 * rpc_free - free buffer allocated via rpc_malloc
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400765 * @buffer: buffer to free
Chuck Lever02107142006-01-03 09:55:49 +0100766 *
767 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400768void rpc_free(void *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400770 size_t size;
771 struct rpc_buffer *buf;
Chuck Lever02107142006-01-03 09:55:49 +0100772
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400773 if (!buffer)
774 return;
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400775
776 buf = container_of(buffer, struct rpc_buffer, data);
777 size = buf->len;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400778
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200779 dprintk("RPC: freeing buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400780 size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400781
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400782 if (size <= RPC_BUFFER_MAXSIZE)
783 mempool_free(buf, rpc_buffer_mempool);
784 else
785 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400787EXPORT_SYMBOL_GPL(rpc_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788
789/*
790 * Creation and deletion of RPC task structures
791 */
Trond Myklebust47fe0642007-10-25 18:42:55 -0400792static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
794 memset(task, 0, sizeof(*task));
Trond Myklebust44c28872006-01-03 09:55:06 +0100795 atomic_set(&task->tk_count, 1);
Trond Myklebust84115e12007-07-14 15:39:59 -0400796 task->tk_flags = task_setup_data->flags;
797 task->tk_ops = task_setup_data->callback_ops;
798 task->tk_calldata = task_setup_data->callback_data;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400799 INIT_LIST_HEAD(&task->tk_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
801 /* Initialize retry counters */
802 task->tk_garb_retry = 2;
803 task->tk_cred_retry = 2;
804
Trond Myklebust3ff75762007-07-14 15:40:00 -0400805 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
806 task->tk_owner = current->tgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
808 /* Initialize workqueue for async tasks */
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500809 task->tk_workqueue = task_setup_data->workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Trond Myklebust84115e12007-07-14 15:39:59 -0400811 task->tk_client = task_setup_data->rpc_client;
812 if (task->tk_client != NULL) {
813 kref_get(&task->tk_client->cl_kref);
814 if (task->tk_client->cl_softrtry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 task->tk_flags |= RPC_TASK_SOFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 }
817
Trond Myklebust84115e12007-07-14 15:39:59 -0400818 if (task->tk_ops->rpc_call_prepare != NULL)
819 task->tk_action = rpc_prepare_task;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100820
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400821 if (task_setup_data->rpc_message != NULL) {
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400822 task->tk_msg.rpc_proc = task_setup_data->rpc_message->rpc_proc;
823 task->tk_msg.rpc_argp = task_setup_data->rpc_message->rpc_argp;
824 task->tk_msg.rpc_resp = task_setup_data->rpc_message->rpc_resp;
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400825 /* Bind the user cred */
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400826 rpcauth_bindcred(task, task_setup_data->rpc_message->rpc_cred, task_setup_data->flags);
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400827 if (task->tk_action == NULL)
828 rpc_call_start(task);
829 }
830
Chuck Leveref759a22006-03-20 13:44:17 -0500831 /* starting timestamp */
Chuck Leverff839972010-05-07 13:34:47 -0400832 task->tk_start = ktime_get();
Chuck Leveref759a22006-03-20 13:44:17 -0500833
Chuck Lever46121cf2007-01-31 12:14:08 -0500834 dprintk("RPC: new task initialized, procpid %u\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700835 task_pid_nr(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836}
837
838static struct rpc_task *
839rpc_alloc_task(void)
840{
841 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
842}
843
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844/*
Trond Myklebust90c57552007-06-09 19:49:36 -0400845 * Create a new task for the specified client.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400847struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400849 struct rpc_task *task = setup_data->task;
850 unsigned short flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400852 if (task == NULL) {
853 task = rpc_alloc_task();
Trond Myklebust19445b92010-04-16 16:41:10 -0400854 if (task == NULL) {
855 rpc_release_calldata(setup_data->callback_ops,
856 setup_data->callback_data);
857 return ERR_PTR(-ENOMEM);
858 }
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400859 flags = RPC_TASK_DYNAMIC;
860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Trond Myklebust84115e12007-07-14 15:39:59 -0400862 rpc_init_task(task, setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400863 if (task->tk_status < 0) {
864 int err = task->tk_status;
865 rpc_put_task(task);
866 return ERR_PTR(err);
867 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400869 task->tk_flags |= flags;
Chuck Lever46121cf2007-01-31 12:14:08 -0500870 dprintk("RPC: allocated task %p\n", task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 return task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872}
873
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500874static void rpc_free_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100876 const struct rpc_call_ops *tk_ops = task->tk_ops;
877 void *calldata = task->tk_calldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800879 if (task->tk_flags & RPC_TASK_DYNAMIC) {
880 dprintk("RPC: %5u freeing task\n", task->tk_pid);
881 mempool_free(task, rpc_task_mempool);
882 }
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500883 rpc_release_calldata(tk_ops, calldata);
884}
885
886static void rpc_async_release(struct work_struct *work)
887{
888 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
889}
890
891void rpc_put_task(struct rpc_task *task)
892{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500893 if (!atomic_dec_and_test(&task->tk_count))
894 return;
895 /* Release resources */
896 if (task->tk_rqstp)
897 xprt_release(task);
898 if (task->tk_msg.rpc_cred)
899 rpcauth_unbindcred(task);
900 if (task->tk_client) {
901 rpc_release_client(task->tk_client);
902 task->tk_client = NULL;
903 }
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500904 if (task->tk_workqueue != NULL) {
905 INIT_WORK(&task->u.tk_work, rpc_async_release);
906 queue_work(task->tk_workqueue, &task->u.tk_work);
907 } else
908 rpc_free_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500909}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400910EXPORT_SYMBOL_GPL(rpc_put_task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500911
Trond Myklebustbde8f002007-01-24 11:54:53 -0800912static void rpc_release_task(struct rpc_task *task)
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500913{
Chuck Lever46121cf2007-01-31 12:14:08 -0500914 dprintk("RPC: %5u release task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Trond Myklebust6529eba2007-06-14 16:40:14 -0400916 if (!list_empty(&task->tk_task)) {
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400917 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400918 /* Remove from client task list */
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400919 spin_lock(&clnt->cl_lock);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400920 list_del(&task->tk_task);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400921 spin_unlock(&clnt->cl_lock);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400922 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 BUG_ON (RPC_IS_QUEUED(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500925 /* Wake up anyone who is waiting for task completion */
926 rpc_mark_complete_task(task);
927
928 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929}
930
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931/*
932 * Kill all tasks for the given client.
933 * XXX: kill their descendants as well?
934 */
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400935void rpc_killall_tasks(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936{
937 struct rpc_task *rovr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400940 if (list_empty(&clnt->cl_tasks))
941 return;
942 dprintk("RPC: killing all tasks for client %p\n", clnt);
943 /*
944 * Spin lock all_tasks to prevent changes...
945 */
946 spin_lock(&clnt->cl_lock);
947 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 if (! RPC_IS_ACTIVATED(rovr))
949 continue;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400950 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 rovr->tk_flags |= RPC_TASK_KILLED;
952 rpc_exit(rovr, -EIO);
953 rpc_wake_up_task(rovr);
954 }
955 }
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400956 spin_unlock(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400958EXPORT_SYMBOL_GPL(rpc_killall_tasks);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400960int rpciod_up(void)
961{
962 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
963}
964
965void rpciod_down(void)
966{
967 module_put(THIS_MODULE);
968}
969
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970/*
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400971 * Start up the rpciod workqueue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 */
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400973static int rpciod_start(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974{
975 struct workqueue_struct *wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 /*
978 * Create the rpciod thread and wait for it to start.
979 */
Trond Myklebustab418d72007-06-14 17:08:36 -0400980 dprintk("RPC: creating workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 wq = create_workqueue("rpciod");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 rpciod_workqueue = wq;
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400983 return rpciod_workqueue != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984}
985
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400986static void rpciod_stop(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987{
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400988 struct workqueue_struct *wq = NULL;
Trond Myklebustab418d72007-06-14 17:08:36 -0400989
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400990 if (rpciod_workqueue == NULL)
991 return;
Trond Myklebustab418d72007-06-14 17:08:36 -0400992 dprintk("RPC: destroying workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Trond Myklebustb247bbf2007-07-19 16:32:20 -0400994 wq = rpciod_workqueue;
995 rpciod_workqueue = NULL;
996 destroy_workqueue(wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997}
998
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999void
1000rpc_destroy_mempool(void)
1001{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001002 rpciod_stop();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 if (rpc_buffer_mempool)
1004 mempool_destroy(rpc_buffer_mempool);
1005 if (rpc_task_mempool)
1006 mempool_destroy(rpc_task_mempool);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001007 if (rpc_task_slabp)
1008 kmem_cache_destroy(rpc_task_slabp);
1009 if (rpc_buffer_slabp)
1010 kmem_cache_destroy(rpc_buffer_slabp);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001011 rpc_destroy_wait_queue(&delay_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012}
1013
1014int
1015rpc_init_mempool(void)
1016{
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001017 /*
1018 * The following is not strictly a mempool initialisation,
1019 * but there is no harm in doing it here
1020 */
1021 rpc_init_wait_queue(&delay_queue, "delayq");
1022 if (!rpciod_start())
1023 goto err_nomem;
1024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1026 sizeof(struct rpc_task),
1027 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001028 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 if (!rpc_task_slabp)
1030 goto err_nomem;
1031 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1032 RPC_BUFFER_MAXSIZE,
1033 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001034 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 if (!rpc_buffer_slabp)
1036 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001037 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1038 rpc_task_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 if (!rpc_task_mempool)
1040 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001041 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1042 rpc_buffer_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 if (!rpc_buffer_mempool)
1044 goto err_nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 return 0;
1046err_nomem:
1047 rpc_destroy_mempool();
1048 return -ENOMEM;
1049}