blob: 6357fcb00c7e2046f8acb901d7005429d23158cd [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>
Jeff Laytond3103102011-12-01 22:44:39 +010021#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Benny Halevy69518672009-09-10 12:25:04 +030025#include "sunrpc.h"
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#ifdef RPC_DEBUG
28#define RPCDBG_FACILITY RPCDBG_SCHED
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#endif
30
Trond Myklebust82b0a4c2012-01-20 14:52:23 -050031#define CREATE_TRACE_POINTS
32#include <trace/events/sunrpc.h>
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034/*
35 * RPC slabs and memory pools
36 */
37#define RPC_BUFFER_MAXSIZE (2048)
38#define RPC_BUFFER_POOLSIZE (8)
39#define RPC_TASK_POOLSIZE (8)
Christoph Lametere18b8902006-12-06 20:33:20 -080040static struct kmem_cache *rpc_task_slabp __read_mostly;
41static struct kmem_cache *rpc_buffer_slabp __read_mostly;
Eric Dumazetba899662005-08-26 12:05:31 -070042static mempool_t *rpc_task_mempool __read_mostly;
43static mempool_t *rpc_buffer_mempool __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
David Howells65f27f32006-11-22 14:55:48 +000045static void rpc_async_schedule(struct work_struct *);
Trond Myklebustbde8f002007-01-24 11:54:53 -080046static void rpc_release_task(struct rpc_task *task);
Trond Myklebust36df9aa2007-07-18 16:18:52 -040047static void __rpc_queue_timer_fn(unsigned long ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 * RPC tasks sit here while waiting for conditions to improve.
51 */
Trond Myklebusta4a87492007-07-18 13:24:19 -040052static struct rpc_wait_queue delay_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * rpciod-related stuff
56 */
Trond Myklebust24c5d9d2006-03-20 13:44:08 -050057struct workqueue_struct *rpciod_workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 * Disable the timer for a given RPC task. Should be called with
61 * queue->lock and bh_disabled in order to avoid races within
62 * rpc_run_timer().
63 */
Trond Myklebust5d008372008-02-22 16:34:17 -050064static void
Trond Myklebusteb276c02008-02-22 17:27:59 -050065__rpc_disable_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066{
Trond Myklebust36df9aa2007-07-18 16:18:52 -040067 if (task->tk_timeout == 0)
68 return;
Chuck Lever46121cf2007-01-31 12:14:08 -050069 dprintk("RPC: %5u disabling timer\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 task->tk_timeout = 0;
Trond Myklebust36df9aa2007-07-18 16:18:52 -040071 list_del(&task->u.tk_wait.timer_list);
Trond Myklebusteb276c02008-02-22 17:27:59 -050072 if (list_empty(&queue->timer_list.list))
73 del_timer(&queue->timer_list.timer);
Trond Myklebust36df9aa2007-07-18 16:18:52 -040074}
75
76static void
77rpc_set_queue_timer(struct rpc_wait_queue *queue, unsigned long expires)
78{
79 queue->timer_list.expires = expires;
80 mod_timer(&queue->timer_list.timer, expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081}
82
83/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 * Set up a timer for the current task.
85 */
Trond Myklebust5d008372008-02-22 16:34:17 -050086static void
Trond Myklebusteb276c02008-02-22 17:27:59 -050087__rpc_add_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -070088{
89 if (!task->tk_timeout)
90 return;
91
Chuck Lever46121cf2007-01-31 12:14:08 -050092 dprintk("RPC: %5u setting alarm for %lu ms\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 task->tk_pid, task->tk_timeout * 1000 / HZ);
94
Trond Myklebusteb276c02008-02-22 17:27:59 -050095 task->u.tk_wait.expires = jiffies + task->tk_timeout;
96 if (list_empty(&queue->timer_list.list) || time_before(task->u.tk_wait.expires, queue->timer_list.expires))
97 rpc_set_queue_timer(queue, task->u.tk_wait.expires);
98 list_add(&task->u.tk_wait.timer_list, &queue->timer_list.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099}
100
101/*
102 * Add new request to a priority queue.
103 */
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400104static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue,
105 struct rpc_task *task,
106 unsigned char queue_priority)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107{
108 struct list_head *q;
109 struct rpc_task *t;
110
111 INIT_LIST_HEAD(&task->u.tk_wait.links);
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400112 q = &queue->tasks[queue_priority];
113 if (unlikely(queue_priority > queue->maxpriority))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 q = &queue->tasks[queue->maxpriority];
115 list_for_each_entry(t, q, u.tk_wait.list) {
Trond Myklebust3ff75762007-07-14 15:40:00 -0400116 if (t->tk_owner == task->tk_owner) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 list_add_tail(&task->u.tk_wait.list, &t->u.tk_wait.links);
118 return;
119 }
120 }
121 list_add_tail(&task->u.tk_wait.list, q);
122}
123
124/*
125 * Add new request to wait queue.
126 *
127 * Swapper tasks always get inserted at the head of the queue.
128 * This should avoid many nasty memory deadlocks and hopefully
129 * improve overall performance.
130 * Everyone else gets appended to the queue to ensure proper FIFO behavior.
131 */
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400132static void __rpc_add_wait_queue(struct rpc_wait_queue *queue,
133 struct rpc_task *task,
134 unsigned char queue_priority)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135{
136 BUG_ON (RPC_IS_QUEUED(task));
137
138 if (RPC_IS_PRIORITY(queue))
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400139 __rpc_add_wait_queue_priority(queue, task, queue_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 else if (RPC_IS_SWAPPER(task))
141 list_add(&task->u.tk_wait.list, &queue->tasks[0]);
142 else
143 list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500144 task->tk_waitqueue = queue;
Chuck Levere19b63d2006-03-20 13:44:15 -0500145 queue->qlen++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 rpc_set_queued(task);
147
Chuck Lever46121cf2007-01-31 12:14:08 -0500148 dprintk("RPC: %5u added to queue %p \"%s\"\n",
149 task->tk_pid, queue, rpc_qname(queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150}
151
152/*
153 * Remove request from a priority queue.
154 */
155static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
156{
157 struct rpc_task *t;
158
159 if (!list_empty(&task->u.tk_wait.links)) {
160 t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
161 list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
162 list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
163 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164}
165
166/*
167 * Remove request from queue.
168 * Note: must be called with spin lock held.
169 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500170static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Trond Myklebusteb276c02008-02-22 17:27:59 -0500172 __rpc_disable_timer(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 if (RPC_IS_PRIORITY(queue))
174 __rpc_remove_wait_queue_priority(task);
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400175 list_del(&task->u.tk_wait.list);
Chuck Levere19b63d2006-03-20 13:44:15 -0500176 queue->qlen--;
Chuck Lever46121cf2007-01-31 12:14:08 -0500177 dprintk("RPC: %5u removed from queue %p \"%s\"\n",
178 task->tk_pid, queue, rpc_qname(queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179}
180
181static inline void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
182{
183 queue->priority = priority;
184 queue->count = 1 << (priority * 2);
185}
186
Trond Myklebust3ff75762007-07-14 15:40:00 -0400187static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400189 queue->owner = pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 queue->nr = RPC_BATCH_COUNT;
191}
192
193static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
194{
195 rpc_set_waitqueue_priority(queue, queue->maxpriority);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400196 rpc_set_waitqueue_owner(queue, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197}
198
Trond Myklebust3ff75762007-07-14 15:40:00 -0400199static 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 -0700200{
201 int i;
202
203 spin_lock_init(&queue->lock);
204 for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
205 INIT_LIST_HEAD(&queue->tasks[i]);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400206 queue->maxpriority = nr_queues - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 rpc_reset_waitqueue_priority(queue);
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400208 queue->qlen = 0;
209 setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
210 INIT_LIST_HEAD(&queue->timer_list.list);
Trond Myklebust2f09c242012-02-08 22:01:15 -0500211 rpc_assign_waitqueue_name(queue, qname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212}
213
214void rpc_init_priority_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, RPC_NR_PRIORITY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217}
Alexandros Batsakis689cf5c2009-12-14 21:27:56 -0800218EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
221{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400222 __rpc_init_priority_wait_queue(queue, qname, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400224EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500226void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
227{
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400228 del_timer_sync(&queue->timer_list.timer);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500229}
230EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);
231
Matthew Wilcox150030b2007-12-06 16:24:39 -0500232static int rpc_wait_bit_killable(void *word)
Trond Myklebust44c28872006-01-03 09:55:06 +0100233{
Matthew Wilcox150030b2007-12-06 16:24:39 -0500234 if (fatal_signal_pending(current))
Trond Myklebust44c28872006-01-03 09:55:06 +0100235 return -ERESTARTSYS;
Jeff Laytond3103102011-12-01 22:44:39 +0100236 freezable_schedule();
Trond Myklebust44c28872006-01-03 09:55:06 +0100237 return 0;
238}
239
Trond Myklebustc44fe702007-06-16 14:17:01 -0400240#ifdef RPC_DEBUG
241static void rpc_task_set_debuginfo(struct rpc_task *task)
242{
243 static atomic_t rpc_pid;
244
Trond Myklebustc44fe702007-06-16 14:17:01 -0400245 task->tk_pid = atomic_inc_return(&rpc_pid);
246}
247#else
248static inline void rpc_task_set_debuginfo(struct rpc_task *task)
249{
250}
251#endif
252
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500253static void rpc_set_active(struct rpc_task *task)
254{
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500255 trace_rpc_task_begin(task->tk_client, task, NULL);
256
Trond Myklebustc44fe702007-06-16 14:17:01 -0400257 rpc_task_set_debuginfo(task);
Trond Myklebust58f96122010-07-31 14:29:08 -0400258 set_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500259}
260
Trond Myklebust44c28872006-01-03 09:55:06 +0100261/*
262 * Mark an RPC call as having completed by clearing the 'active' bit
Trond Myklebustbf294b42011-02-21 11:05:41 -0800263 * and then waking up all tasks that were sleeping.
Trond Myklebust44c28872006-01-03 09:55:06 +0100264 */
Trond Myklebustbf294b42011-02-21 11:05:41 -0800265static int rpc_complete_task(struct rpc_task *task)
Trond Myklebust44c28872006-01-03 09:55:06 +0100266{
Trond Myklebustbf294b42011-02-21 11:05:41 -0800267 void *m = &task->tk_runstate;
268 wait_queue_head_t *wq = bit_waitqueue(m, RPC_TASK_ACTIVE);
269 struct wait_bit_key k = __WAIT_BIT_KEY_INITIALIZER(m, RPC_TASK_ACTIVE);
270 unsigned long flags;
271 int ret;
272
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500273 trace_rpc_task_complete(task->tk_client, task, NULL);
274
Trond Myklebustbf294b42011-02-21 11:05:41 -0800275 spin_lock_irqsave(&wq->lock, flags);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500276 clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800277 ret = atomic_dec_and_test(&task->tk_count);
278 if (waitqueue_active(wq))
279 __wake_up_locked_key(wq, TASK_NORMAL, &k);
280 spin_unlock_irqrestore(&wq->lock, flags);
281 return ret;
Trond Myklebust44c28872006-01-03 09:55:06 +0100282}
283
284/*
285 * Allow callers to wait for completion of an RPC call
Trond Myklebustbf294b42011-02-21 11:05:41 -0800286 *
287 * Note the use of out_of_line_wait_on_bit() rather than wait_on_bit()
288 * to enforce taking of the wq->lock and hence avoid races with
289 * rpc_complete_task().
Trond Myklebust44c28872006-01-03 09:55:06 +0100290 */
291int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
292{
293 if (action == NULL)
Matthew Wilcox150030b2007-12-06 16:24:39 -0500294 action = rpc_wait_bit_killable;
Trond Myklebustbf294b42011-02-21 11:05:41 -0800295 return out_of_line_wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500296 action, TASK_KILLABLE);
Trond Myklebust44c28872006-01-03 09:55:06 +0100297}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400298EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
Trond Myklebust44c28872006-01-03 09:55:06 +0100299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300/*
301 * Make an RPC task runnable.
302 *
Jeff Layton506026c2012-07-23 15:51:55 -0400303 * Note: If the task is ASYNC, and is being made runnable after sitting on an
304 * rpc_wait_queue, this must be called with the queue spinlock held to protect
305 * the wait queue operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 */
307static void rpc_make_runnable(struct rpc_task *task)
308{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 rpc_clear_queued(task);
Christophe Saoutcc4dc59e2006-11-05 18:42:48 +0100310 if (rpc_test_and_set_running(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 return;
312 if (RPC_IS_ASYNC(task)) {
David Howells65f27f32006-11-22 14:55:48 +0000313 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
Fred Isamancee6a532011-02-11 15:42:35 +0000314 queue_work(rpciod_workqueue, &task->u.tk_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 } else
Trond Myklebust96651ab2005-06-22 17:16:21 +0000316 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317}
318
319/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 * Prepare for sleeping on a wait queue.
321 * By always appending tasks to the list we ensure FIFO behavior.
322 * NB: An RPC task will only receive interrupt-driven events as long
323 * as it's on a wait queue.
324 */
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400325static void __rpc_sleep_on_priority(struct rpc_wait_queue *q,
326 struct rpc_task *task,
327 rpc_action action,
328 unsigned char queue_priority)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329{
Chuck Lever46121cf2007-01-31 12:14:08 -0500330 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
331 task->tk_pid, rpc_qname(q), jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500333 trace_rpc_task_sleep(task->tk_client, task, q);
334
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400335 __rpc_add_wait_queue(q, task, queue_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
337 BUG_ON(task->tk_callback != NULL);
338 task->tk_callback = action;
Trond Myklebusteb276c02008-02-22 17:27:59 -0500339 __rpc_add_timer(q, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340}
341
342void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
Trond Myklebust5d008372008-02-22 16:34:17 -0500343 rpc_action action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344{
Trond Myklebust58f96122010-07-31 14:29:08 -0400345 /* We shouldn't ever put an inactive task to sleep */
346 BUG_ON(!RPC_IS_ACTIVATED(task));
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 /*
349 * Protect the queue operations.
350 */
351 spin_lock_bh(&q->lock);
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400352 __rpc_sleep_on_priority(q, task, action, task->tk_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 spin_unlock_bh(&q->lock);
354}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400355EXPORT_SYMBOL_GPL(rpc_sleep_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400357void rpc_sleep_on_priority(struct rpc_wait_queue *q, struct rpc_task *task,
358 rpc_action action, int priority)
359{
360 /* We shouldn't ever put an inactive task to sleep */
361 BUG_ON(!RPC_IS_ACTIVATED(task));
362
363 /*
364 * Protect the queue operations.
365 */
366 spin_lock_bh(&q->lock);
367 __rpc_sleep_on_priority(q, task, action, priority - RPC_PRIORITY_LOW);
368 spin_unlock_bh(&q->lock);
369}
370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371/**
372 * __rpc_do_wake_up_task - wake up a single rpc_task
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500373 * @queue: wait queue
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * @task: task to be woken up
375 *
376 * Caller must hold queue->lock, and have cleared the task queued flag.
377 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500378static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379{
Chuck Lever46121cf2007-01-31 12:14:08 -0500380 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
381 task->tk_pid, jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 /* Has the task been executed yet? If not, we cannot wake it up! */
384 if (!RPC_IS_ACTIVATED(task)) {
385 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
386 return;
387 }
388
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500389 trace_rpc_task_wakeup(task->tk_client, task, queue);
390
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500391 __rpc_remove_wait_queue(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393 rpc_make_runnable(task);
394
Chuck Lever46121cf2007-01-31 12:14:08 -0500395 dprintk("RPC: __rpc_wake_up_task done\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396}
397
398/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500399 * Wake up a queued task while the queue lock is being held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500401static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402{
Trond Myklebustf5fb7b062008-02-25 21:40:50 -0800403 if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
404 __rpc_do_wake_up_task(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405}
406
407/*
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800408 * Tests whether rpc queue is empty
409 */
410int rpc_queue_empty(struct rpc_wait_queue *queue)
411{
412 int res;
413
414 spin_lock_bh(&queue->lock);
415 res = queue->qlen;
416 spin_unlock_bh(&queue->lock);
Eric Dumazeta02cec22010-09-22 20:43:57 +0000417 return res == 0;
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800418}
419EXPORT_SYMBOL_GPL(rpc_queue_empty);
420
421/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500422 * Wake up a task on a specific queue
423 */
424void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
425{
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800426 spin_lock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500427 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800428 spin_unlock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500429}
430EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
431
432/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 * Wake up the next task on a priority queue.
434 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500435static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436{
437 struct list_head *q;
438 struct rpc_task *task;
439
440 /*
Trond Myklebust3ff75762007-07-14 15:40:00 -0400441 * Service a batch of tasks from a single owner.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 */
443 q = &queue->tasks[queue->priority];
444 if (!list_empty(q)) {
445 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400446 if (queue->owner == task->tk_owner) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 if (--queue->nr)
448 goto out;
449 list_move_tail(&task->u.tk_wait.list, q);
450 }
451 /*
452 * Check if we need to switch queues.
453 */
454 if (--queue->count)
Trond Myklebust3ff75762007-07-14 15:40:00 -0400455 goto new_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 }
457
458 /*
459 * Service the next queue.
460 */
461 do {
462 if (q == &queue->tasks[0])
463 q = &queue->tasks[queue->maxpriority];
464 else
465 q = q - 1;
466 if (!list_empty(q)) {
467 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
468 goto new_queue;
469 }
470 } while (q != &queue->tasks[queue->priority]);
471
472 rpc_reset_waitqueue_priority(queue);
473 return NULL;
474
475new_queue:
476 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
Trond Myklebust3ff75762007-07-14 15:40:00 -0400477new_owner:
478 rpc_set_waitqueue_owner(queue, task->tk_owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 return task;
481}
482
Trond Myklebust961a8282012-01-17 22:57:37 -0500483static struct rpc_task *__rpc_find_next_queued(struct rpc_wait_queue *queue)
484{
485 if (RPC_IS_PRIORITY(queue))
486 return __rpc_find_next_queued_priority(queue);
487 if (!list_empty(&queue->tasks[0]))
488 return list_first_entry(&queue->tasks[0], struct rpc_task, u.tk_wait.list);
489 return NULL;
490}
491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492/*
Trond Myklebust961a8282012-01-17 22:57:37 -0500493 * Wake up the first task on the wait queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500495struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
496 bool (*func)(struct rpc_task *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
498 struct rpc_task *task = NULL;
499
Trond Myklebust961a8282012-01-17 22:57:37 -0500500 dprintk("RPC: wake_up_first(%p \"%s\")\n",
Chuck Lever46121cf2007-01-31 12:14:08 -0500501 queue, rpc_qname(queue));
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800502 spin_lock_bh(&queue->lock);
Trond Myklebust961a8282012-01-17 22:57:37 -0500503 task = __rpc_find_next_queued(queue);
504 if (task != NULL) {
505 if (func(task, data))
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500506 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust961a8282012-01-17 22:57:37 -0500507 else
508 task = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800510 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
512 return task;
513}
Trond Myklebust961a8282012-01-17 22:57:37 -0500514EXPORT_SYMBOL_GPL(rpc_wake_up_first);
515
516static bool rpc_wake_up_next_func(struct rpc_task *task, void *data)
517{
518 return true;
519}
520
521/*
522 * Wake up the next task on the wait queue.
523*/
524struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *queue)
525{
526 return rpc_wake_up_first(queue, rpc_wake_up_next_func, NULL);
527}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400528EXPORT_SYMBOL_GPL(rpc_wake_up_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
530/**
531 * rpc_wake_up - wake up all rpc_tasks
532 * @queue: rpc_wait_queue on which the tasks are sleeping
533 *
534 * Grabs queue->lock
535 */
536void rpc_wake_up(struct rpc_wait_queue *queue)
537{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 struct list_head *head;
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800539
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800540 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 head = &queue->tasks[queue->maxpriority];
542 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400543 while (!list_empty(head)) {
544 struct rpc_task *task;
545 task = list_first_entry(head,
546 struct rpc_task,
547 u.tk_wait.list);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500548 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust540a0f72012-03-19 13:39:35 -0400549 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 if (head == &queue->tasks[0])
551 break;
552 head--;
553 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800554 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400556EXPORT_SYMBOL_GPL(rpc_wake_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
558/**
559 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
560 * @queue: rpc_wait_queue on which the tasks are sleeping
561 * @status: status value to set
562 *
563 * Grabs queue->lock
564 */
565void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
566{
567 struct list_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800569 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 head = &queue->tasks[queue->maxpriority];
571 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400572 while (!list_empty(head)) {
573 struct rpc_task *task;
574 task = list_first_entry(head,
575 struct rpc_task,
576 u.tk_wait.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 task->tk_status = status;
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500578 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
580 if (head == &queue->tasks[0])
581 break;
582 head--;
583 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800584 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400586EXPORT_SYMBOL_GPL(rpc_wake_up_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400588static void __rpc_queue_timer_fn(unsigned long ptr)
589{
590 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
591 struct rpc_task *task, *n;
592 unsigned long expires, now, timeo;
593
594 spin_lock(&queue->lock);
595 expires = now = jiffies;
596 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
597 timeo = task->u.tk_wait.expires;
598 if (time_after_eq(now, timeo)) {
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400599 dprintk("RPC: %5u timeout\n", task->tk_pid);
600 task->tk_status = -ETIMEDOUT;
601 rpc_wake_up_task_queue_locked(queue, task);
602 continue;
603 }
604 if (expires == now || time_after(expires, timeo))
605 expires = timeo;
606 }
607 if (!list_empty(&queue->timer_list.list))
608 rpc_set_queue_timer(queue, expires);
609 spin_unlock(&queue->lock);
610}
611
Trond Myklebust80147932006-08-31 18:24:08 -0400612static void __rpc_atrun(struct rpc_task *task)
613{
Trond Myklebust5d008372008-02-22 16:34:17 -0500614 task->tk_status = 0;
Trond Myklebust80147932006-08-31 18:24:08 -0400615}
616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617/*
618 * Run a task at a later time
619 */
Trond Myklebust80147932006-08-31 18:24:08 -0400620void rpc_delay(struct rpc_task *task, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
622 task->tk_timeout = delay;
Trond Myklebust5d008372008-02-22 16:34:17 -0500623 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400625EXPORT_SYMBOL_GPL(rpc_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627/*
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100628 * Helper to call task->tk_ops->rpc_call_prepare
629 */
Andy Adamsonaae20062009-04-01 09:22:40 -0400630void rpc_prepare_task(struct rpc_task *task)
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100631{
632 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
633}
634
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500635static void
636rpc_init_task_statistics(struct rpc_task *task)
637{
638 /* Initialize retry counters */
639 task->tk_garb_retry = 2;
640 task->tk_cred_retry = 2;
641 task->tk_rebind_retry = 2;
642
643 /* starting timestamp */
644 task->tk_start = ktime_get();
645}
646
647static void
648rpc_reset_task_statistics(struct rpc_task *task)
649{
650 task->tk_timeouts = 0;
651 task->tk_flags &= ~(RPC_CALL_MAJORSEEN|RPC_TASK_KILLED|RPC_TASK_SENT);
652
653 rpc_init_task_statistics(task);
654}
655
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100656/*
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100657 * Helper that calls task->tk_ops->rpc_call_done if it exists
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000658 */
Trond Myklebustabbcf282006-01-03 09:55:03 +0100659void rpc_exit_task(struct rpc_task *task)
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000660{
Trond Myklebustabbcf282006-01-03 09:55:03 +0100661 task->tk_action = NULL;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100662 if (task->tk_ops->rpc_call_done != NULL) {
663 task->tk_ops->rpc_call_done(task, task->tk_calldata);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000664 if (task->tk_action != NULL) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100665 WARN_ON(RPC_ASSASSINATED(task));
666 /* Always release the RPC slot and buffer memory */
667 xprt_release(task);
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500668 rpc_reset_task_statistics(task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000669 }
670 }
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000671}
Trond Myklebustd9b6cd92010-07-31 14:29:08 -0400672
673void rpc_exit(struct rpc_task *task, int status)
674{
675 task->tk_status = status;
676 task->tk_action = rpc_exit_task;
677 if (RPC_IS_QUEUED(task))
678 rpc_wake_up_queued_task(task->tk_waitqueue, task);
679}
680EXPORT_SYMBOL_GPL(rpc_exit);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000681
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400682void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
683{
Trond Myklebusta86dc492008-06-11 13:37:09 -0400684 if (ops->rpc_release != NULL)
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400685 ops->rpc_release(calldata);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400686}
687
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000688/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 * This is the RPC `scheduler' (or rather, the finite state machine).
690 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800691static void __rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692{
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400693 struct rpc_wait_queue *queue;
694 int task_is_async = RPC_IS_ASYNC(task);
695 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Chuck Lever46121cf2007-01-31 12:14:08 -0500697 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
698 task->tk_pid, task->tk_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700 BUG_ON(RPC_IS_QUEUED(task));
701
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000702 for (;;) {
Trond Myklebustb55c5982011-07-06 19:58:23 -0400703 void (*do_action)(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
705 /*
Trond Myklebustb55c5982011-07-06 19:58:23 -0400706 * Execute any pending callback first.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400708 do_action = task->tk_callback;
709 task->tk_callback = NULL;
710 if (do_action == NULL) {
Trond Myklebuste020c682011-03-15 19:56:30 -0400711 /*
712 * Perform the next FSM step.
Trond Myklebustb55c5982011-07-06 19:58:23 -0400713 * tk_action may be NULL if the task has been killed.
714 * In particular, note that rpc_killall_tasks may
715 * do this at any time, so beware when dereferencing.
Trond Myklebuste020c682011-03-15 19:56:30 -0400716 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400717 do_action = task->tk_action;
718 if (do_action == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 }
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500721 trace_rpc_task_run_action(task->tk_client, task, task->tk_action);
Trond Myklebustb55c5982011-07-06 19:58:23 -0400722 do_action(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 /*
725 * Lockless check for whether task is sleeping or not.
726 */
727 if (!RPC_IS_QUEUED(task))
728 continue;
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400729 /*
730 * The queue->lock protects against races with
731 * rpc_make_runnable().
732 *
733 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
734 * rpc_task, rpc_make_runnable() can assign it to a
735 * different workqueue. We therefore cannot assume that the
736 * rpc_task pointer may still be dereferenced.
737 */
738 queue = task->tk_waitqueue;
739 spin_lock_bh(&queue->lock);
740 if (!RPC_IS_QUEUED(task)) {
741 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 continue;
743 }
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400744 rpc_clear_running(task);
745 spin_unlock_bh(&queue->lock);
746 if (task_is_async)
747 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 /* sync task: sleep here */
Chuck Lever46121cf2007-01-31 12:14:08 -0500750 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000751 status = out_of_line_wait_on_bit(&task->tk_runstate,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500752 RPC_TASK_QUEUED, rpc_wait_bit_killable,
753 TASK_KILLABLE);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000754 if (status == -ERESTARTSYS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 /*
756 * When a sync task receives a signal, it exits with
757 * -ERESTARTSYS. In order to catch any callbacks that
758 * clean up after sleeping on some queue, we don't
759 * break the loop here, but go around once more.
760 */
Chuck Lever46121cf2007-01-31 12:14:08 -0500761 dprintk("RPC: %5u got signal\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000762 task->tk_flags |= RPC_TASK_KILLED;
763 rpc_exit(task, -ERESTARTSYS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 }
765 rpc_set_running(task);
Chuck Lever46121cf2007-01-31 12:14:08 -0500766 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 }
768
Chuck Lever46121cf2007-01-31 12:14:08 -0500769 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
770 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 /* Release all resources associated with the task */
772 rpc_release_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773}
774
775/*
776 * User-visible entry point to the scheduler.
777 *
778 * This may be called recursively if e.g. an async NFS task updates
779 * the attributes and finds that dirty pages must be flushed.
780 * NOTE: Upon exit of this function the task is guaranteed to be
781 * released. In particular note that tk_release() will have
782 * been called, so your task memory may have been freed.
783 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800784void rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
Trond Myklebust44c28872006-01-03 09:55:06 +0100786 rpc_set_active(task);
Trond Myklebustd6a1ed02010-07-31 14:29:08 -0400787 rpc_make_runnable(task);
788 if (!RPC_IS_ASYNC(task))
789 __rpc_execute(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790}
791
David Howells65f27f32006-11-22 14:55:48 +0000792static void rpc_async_schedule(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
Jeff Layton5cf02d02012-07-23 13:58:51 -0400794 current->flags |= PF_FSTRANS;
David Howells65f27f32006-11-22 14:55:48 +0000795 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
Jeff Layton5cf02d02012-07-23 13:58:51 -0400796 current->flags &= ~PF_FSTRANS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797}
798
Chuck Lever02107142006-01-03 09:55:49 +0100799/**
800 * rpc_malloc - allocate an RPC buffer
801 * @task: RPC task that will use this buffer
802 * @size: requested byte size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 *
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400804 * To prevent rpciod from hanging, this allocator never sleeps,
805 * returning NULL if the request cannot be serviced immediately.
806 * The caller can arrange to sleep in a way that is safe for rpciod.
807 *
808 * Most requests are 'small' (under 2KiB) and can be serviced from a
809 * mempool, ensuring that NFS reads and writes can always proceed,
810 * and that there is good locality of reference for these buffers.
811 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 * In order to avoid memory starvation triggering more writebacks of
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400813 * NFS requests, we avoid using GFP_KERNEL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400815void *rpc_malloc(struct rpc_task *task, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400817 struct rpc_buffer *buf;
Mel Gormana564b8f2012-07-31 16:45:12 -0700818 gfp_t gfp = GFP_NOWAIT;
819
820 if (RPC_IS_SWAPPER(task))
821 gfp |= __GFP_MEMALLOC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400823 size += sizeof(struct rpc_buffer);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400824 if (size <= RPC_BUFFER_MAXSIZE)
825 buf = mempool_alloc(rpc_buffer_mempool, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 else
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400827 buf = kmalloc(size, gfp);
Peter Zijlstraddce40d2007-05-09 08:30:11 +0200828
829 if (!buf)
830 return NULL;
831
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400832 buf->len = size;
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200833 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400834 task->tk_pid, size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400835 return &buf->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400837EXPORT_SYMBOL_GPL(rpc_malloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
Chuck Lever02107142006-01-03 09:55:49 +0100839/**
840 * rpc_free - free buffer allocated via rpc_malloc
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400841 * @buffer: buffer to free
Chuck Lever02107142006-01-03 09:55:49 +0100842 *
843 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400844void rpc_free(void *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400846 size_t size;
847 struct rpc_buffer *buf;
Chuck Lever02107142006-01-03 09:55:49 +0100848
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400849 if (!buffer)
850 return;
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400851
852 buf = container_of(buffer, struct rpc_buffer, data);
853 size = buf->len;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400854
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200855 dprintk("RPC: freeing buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400856 size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400857
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400858 if (size <= RPC_BUFFER_MAXSIZE)
859 mempool_free(buf, rpc_buffer_mempool);
860 else
861 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400863EXPORT_SYMBOL_GPL(rpc_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
865/*
866 * Creation and deletion of RPC task structures
867 */
Trond Myklebust47fe0642007-10-25 18:42:55 -0400868static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869{
870 memset(task, 0, sizeof(*task));
Trond Myklebust44c28872006-01-03 09:55:06 +0100871 atomic_set(&task->tk_count, 1);
Trond Myklebust84115e12007-07-14 15:39:59 -0400872 task->tk_flags = task_setup_data->flags;
873 task->tk_ops = task_setup_data->callback_ops;
874 task->tk_calldata = task_setup_data->callback_data;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400875 INIT_LIST_HEAD(&task->tk_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Trond Myklebust3ff75762007-07-14 15:40:00 -0400877 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
878 task->tk_owner = current->tgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
880 /* Initialize workqueue for async tasks */
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500881 task->tk_workqueue = task_setup_data->workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Trond Myklebust84115e12007-07-14 15:39:59 -0400883 if (task->tk_ops->rpc_call_prepare != NULL)
884 task->tk_action = rpc_prepare_task;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100885
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500886 rpc_init_task_statistics(task);
Chuck Leveref759a22006-03-20 13:44:17 -0500887
Chuck Lever46121cf2007-01-31 12:14:08 -0500888 dprintk("RPC: new task initialized, procpid %u\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700889 task_pid_nr(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
891
892static struct rpc_task *
893rpc_alloc_task(void)
894{
Mel Gormana564b8f2012-07-31 16:45:12 -0700895 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896}
897
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898/*
Trond Myklebust90c57552007-06-09 19:49:36 -0400899 * Create a new task for the specified client.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400901struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902{
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400903 struct rpc_task *task = setup_data->task;
904 unsigned short flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400906 if (task == NULL) {
907 task = rpc_alloc_task();
Trond Myklebust19445b92010-04-16 16:41:10 -0400908 if (task == NULL) {
909 rpc_release_calldata(setup_data->callback_ops,
910 setup_data->callback_data);
911 return ERR_PTR(-ENOMEM);
912 }
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400913 flags = RPC_TASK_DYNAMIC;
914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Trond Myklebust84115e12007-07-14 15:39:59 -0400916 rpc_init_task(task, setup_data);
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400917 task->tk_flags |= flags;
Chuck Lever46121cf2007-01-31 12:14:08 -0500918 dprintk("RPC: allocated task %p\n", task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 return task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920}
921
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500922static void rpc_free_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100924 const struct rpc_call_ops *tk_ops = task->tk_ops;
925 void *calldata = task->tk_calldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800927 if (task->tk_flags & RPC_TASK_DYNAMIC) {
928 dprintk("RPC: %5u freeing task\n", task->tk_pid);
929 mempool_free(task, rpc_task_mempool);
930 }
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500931 rpc_release_calldata(tk_ops, calldata);
932}
933
934static void rpc_async_release(struct work_struct *work)
935{
936 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
937}
938
Trond Myklebustbf294b42011-02-21 11:05:41 -0800939static void rpc_release_resources_task(struct rpc_task *task)
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500940{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500941 if (task->tk_rqstp)
942 xprt_release(task);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200943 if (task->tk_msg.rpc_cred) {
Trond Myklebusta17c2152010-07-31 14:29:08 -0400944 put_rpccred(task->tk_msg.rpc_cred);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200945 task->tk_msg.rpc_cred = NULL;
946 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400947 rpc_task_release_client(task);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800948}
949
950static void rpc_final_put_task(struct rpc_task *task,
951 struct workqueue_struct *q)
952{
953 if (q != NULL) {
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500954 INIT_WORK(&task->u.tk_work, rpc_async_release);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800955 queue_work(q, &task->u.tk_work);
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500956 } else
957 rpc_free_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500958}
Trond Myklebustbf294b42011-02-21 11:05:41 -0800959
960static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
961{
962 if (atomic_dec_and_test(&task->tk_count)) {
963 rpc_release_resources_task(task);
964 rpc_final_put_task(task, q);
965 }
966}
967
968void rpc_put_task(struct rpc_task *task)
969{
970 rpc_do_put_task(task, NULL);
971}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400972EXPORT_SYMBOL_GPL(rpc_put_task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500973
Trond Myklebustbf294b42011-02-21 11:05:41 -0800974void rpc_put_task_async(struct rpc_task *task)
975{
976 rpc_do_put_task(task, task->tk_workqueue);
977}
978EXPORT_SYMBOL_GPL(rpc_put_task_async);
979
Trond Myklebustbde8f002007-01-24 11:54:53 -0800980static void rpc_release_task(struct rpc_task *task)
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500981{
Chuck Lever46121cf2007-01-31 12:14:08 -0500982 dprintk("RPC: %5u release task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 BUG_ON (RPC_IS_QUEUED(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
Trond Myklebustbf294b42011-02-21 11:05:41 -0800986 rpc_release_resources_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500987
Trond Myklebustbf294b42011-02-21 11:05:41 -0800988 /*
989 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
990 * so it should be safe to use task->tk_count as a test for whether
991 * or not any other processes still hold references to our rpc_task.
992 */
993 if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
994 /* Wake up anyone who may be waiting for task completion */
995 if (!rpc_complete_task(task))
996 return;
997 } else {
998 if (!atomic_dec_and_test(&task->tk_count))
999 return;
1000 }
1001 rpc_final_put_task(task, task->tk_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002}
1003
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001004int rpciod_up(void)
1005{
1006 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
1007}
1008
1009void rpciod_down(void)
1010{
1011 module_put(THIS_MODULE);
1012}
1013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014/*
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001015 * Start up the rpciod workqueue.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 */
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001017static int rpciod_start(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018{
1019 struct workqueue_struct *wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 /*
1022 * Create the rpciod thread and wait for it to start.
1023 */
Trond Myklebustab418d72007-06-14 17:08:36 -04001024 dprintk("RPC: creating workqueue rpciod\n");
Trond Myklebust9b96ce72012-09-28 20:24:16 -04001025 wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 rpciod_workqueue = wq;
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001027 return rpciod_workqueue != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028}
1029
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001030static void rpciod_stop(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001032 struct workqueue_struct *wq = NULL;
Trond Myklebustab418d72007-06-14 17:08:36 -04001033
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001034 if (rpciod_workqueue == NULL)
1035 return;
Trond Myklebustab418d72007-06-14 17:08:36 -04001036 dprintk("RPC: destroying workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001038 wq = rpciod_workqueue;
1039 rpciod_workqueue = NULL;
1040 destroy_workqueue(wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041}
1042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043void
1044rpc_destroy_mempool(void)
1045{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001046 rpciod_stop();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 if (rpc_buffer_mempool)
1048 mempool_destroy(rpc_buffer_mempool);
1049 if (rpc_task_mempool)
1050 mempool_destroy(rpc_task_mempool);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001051 if (rpc_task_slabp)
1052 kmem_cache_destroy(rpc_task_slabp);
1053 if (rpc_buffer_slabp)
1054 kmem_cache_destroy(rpc_buffer_slabp);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001055 rpc_destroy_wait_queue(&delay_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056}
1057
1058int
1059rpc_init_mempool(void)
1060{
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001061 /*
1062 * The following is not strictly a mempool initialisation,
1063 * but there is no harm in doing it here
1064 */
1065 rpc_init_wait_queue(&delay_queue, "delayq");
1066 if (!rpciod_start())
1067 goto err_nomem;
1068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1070 sizeof(struct rpc_task),
1071 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001072 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 if (!rpc_task_slabp)
1074 goto err_nomem;
1075 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1076 RPC_BUFFER_MAXSIZE,
1077 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001078 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 if (!rpc_buffer_slabp)
1080 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001081 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1082 rpc_task_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 if (!rpc_task_mempool)
1084 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001085 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1086 rpc_buffer_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 if (!rpc_buffer_mempool)
1088 goto err_nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 return 0;
1090err_nomem:
1091 rpc_destroy_mempool();
1092 return -ENOMEM;
1093}