blob: f494b356e87678ee8ea745a60c4a0eefabd12bf2 [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 */
Weston Andros Adamsone454a7a2012-10-23 10:43:32 -0400346 WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
347 if (!RPC_IS_ACTIVATED(task)) {
348 task->tk_status = -EIO;
349 rpc_put_task_async(task);
350 return;
351 }
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 /*
354 * Protect the queue operations.
355 */
356 spin_lock_bh(&q->lock);
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400357 __rpc_sleep_on_priority(q, task, action, task->tk_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 spin_unlock_bh(&q->lock);
359}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400360EXPORT_SYMBOL_GPL(rpc_sleep_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400362void rpc_sleep_on_priority(struct rpc_wait_queue *q, struct rpc_task *task,
363 rpc_action action, int priority)
364{
365 /* We shouldn't ever put an inactive task to sleep */
Weston Andros Adamsone454a7a2012-10-23 10:43:32 -0400366 WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
367 if (!RPC_IS_ACTIVATED(task)) {
368 task->tk_status = -EIO;
369 rpc_put_task_async(task);
370 return;
371 }
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400372
373 /*
374 * Protect the queue operations.
375 */
376 spin_lock_bh(&q->lock);
377 __rpc_sleep_on_priority(q, task, action, priority - RPC_PRIORITY_LOW);
378 spin_unlock_bh(&q->lock);
379}
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381/**
382 * __rpc_do_wake_up_task - wake up a single rpc_task
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500383 * @queue: wait queue
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 * @task: task to be woken up
385 *
386 * Caller must hold queue->lock, and have cleared the task queued flag.
387 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500388static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389{
Chuck Lever46121cf2007-01-31 12:14:08 -0500390 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
391 task->tk_pid, jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 /* Has the task been executed yet? If not, we cannot wake it up! */
394 if (!RPC_IS_ACTIVATED(task)) {
395 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
396 return;
397 }
398
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500399 trace_rpc_task_wakeup(task->tk_client, task, queue);
400
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500401 __rpc_remove_wait_queue(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403 rpc_make_runnable(task);
404
Chuck Lever46121cf2007-01-31 12:14:08 -0500405 dprintk("RPC: __rpc_wake_up_task done\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406}
407
408/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500409 * Wake up a queued task while the queue lock is being held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500411static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
Trond Myklebustf5fb7b062008-02-25 21:40:50 -0800413 if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
414 __rpc_do_wake_up_task(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415}
416
417/*
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800418 * Tests whether rpc queue is empty
419 */
420int rpc_queue_empty(struct rpc_wait_queue *queue)
421{
422 int res;
423
424 spin_lock_bh(&queue->lock);
425 res = queue->qlen;
426 spin_unlock_bh(&queue->lock);
Eric Dumazeta02cec22010-09-22 20:43:57 +0000427 return res == 0;
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800428}
429EXPORT_SYMBOL_GPL(rpc_queue_empty);
430
431/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500432 * Wake up a task on a specific queue
433 */
434void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
435{
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800436 spin_lock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500437 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800438 spin_unlock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500439}
440EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
441
442/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 * Wake up the next task on a priority queue.
444 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500445static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446{
447 struct list_head *q;
448 struct rpc_task *task;
449
450 /*
Trond Myklebust3ff75762007-07-14 15:40:00 -0400451 * Service a batch of tasks from a single owner.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 */
453 q = &queue->tasks[queue->priority];
454 if (!list_empty(q)) {
455 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400456 if (queue->owner == task->tk_owner) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 if (--queue->nr)
458 goto out;
459 list_move_tail(&task->u.tk_wait.list, q);
460 }
461 /*
462 * Check if we need to switch queues.
463 */
464 if (--queue->count)
Trond Myklebust3ff75762007-07-14 15:40:00 -0400465 goto new_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 }
467
468 /*
469 * Service the next queue.
470 */
471 do {
472 if (q == &queue->tasks[0])
473 q = &queue->tasks[queue->maxpriority];
474 else
475 q = q - 1;
476 if (!list_empty(q)) {
477 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
478 goto new_queue;
479 }
480 } while (q != &queue->tasks[queue->priority]);
481
482 rpc_reset_waitqueue_priority(queue);
483 return NULL;
484
485new_queue:
486 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
Trond Myklebust3ff75762007-07-14 15:40:00 -0400487new_owner:
488 rpc_set_waitqueue_owner(queue, task->tk_owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 return task;
491}
492
Trond Myklebust961a8282012-01-17 22:57:37 -0500493static struct rpc_task *__rpc_find_next_queued(struct rpc_wait_queue *queue)
494{
495 if (RPC_IS_PRIORITY(queue))
496 return __rpc_find_next_queued_priority(queue);
497 if (!list_empty(&queue->tasks[0]))
498 return list_first_entry(&queue->tasks[0], struct rpc_task, u.tk_wait.list);
499 return NULL;
500}
501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502/*
Trond Myklebust961a8282012-01-17 22:57:37 -0500503 * Wake up the first task on the wait queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500505struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
506 bool (*func)(struct rpc_task *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
508 struct rpc_task *task = NULL;
509
Trond Myklebust961a8282012-01-17 22:57:37 -0500510 dprintk("RPC: wake_up_first(%p \"%s\")\n",
Chuck Lever46121cf2007-01-31 12:14:08 -0500511 queue, rpc_qname(queue));
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800512 spin_lock_bh(&queue->lock);
Trond Myklebust961a8282012-01-17 22:57:37 -0500513 task = __rpc_find_next_queued(queue);
514 if (task != NULL) {
515 if (func(task, data))
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500516 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust961a8282012-01-17 22:57:37 -0500517 else
518 task = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800520 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
522 return task;
523}
Trond Myklebust961a8282012-01-17 22:57:37 -0500524EXPORT_SYMBOL_GPL(rpc_wake_up_first);
525
526static bool rpc_wake_up_next_func(struct rpc_task *task, void *data)
527{
528 return true;
529}
530
531/*
532 * Wake up the next task on the wait queue.
533*/
534struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *queue)
535{
536 return rpc_wake_up_first(queue, rpc_wake_up_next_func, NULL);
537}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400538EXPORT_SYMBOL_GPL(rpc_wake_up_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540/**
541 * rpc_wake_up - wake up all rpc_tasks
542 * @queue: rpc_wait_queue on which the tasks are sleeping
543 *
544 * Grabs queue->lock
545 */
546void rpc_wake_up(struct rpc_wait_queue *queue)
547{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 struct list_head *head;
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800549
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800550 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 head = &queue->tasks[queue->maxpriority];
552 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400553 while (!list_empty(head)) {
554 struct rpc_task *task;
555 task = list_first_entry(head,
556 struct rpc_task,
557 u.tk_wait.list);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500558 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust540a0f72012-03-19 13:39:35 -0400559 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 if (head == &queue->tasks[0])
561 break;
562 head--;
563 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800564 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400566EXPORT_SYMBOL_GPL(rpc_wake_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
568/**
569 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
570 * @queue: rpc_wait_queue on which the tasks are sleeping
571 * @status: status value to set
572 *
573 * Grabs queue->lock
574 */
575void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
576{
577 struct list_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800579 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 head = &queue->tasks[queue->maxpriority];
581 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400582 while (!list_empty(head)) {
583 struct rpc_task *task;
584 task = list_first_entry(head,
585 struct rpc_task,
586 u.tk_wait.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 task->tk_status = status;
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500588 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 }
590 if (head == &queue->tasks[0])
591 break;
592 head--;
593 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800594 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400596EXPORT_SYMBOL_GPL(rpc_wake_up_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400598static void __rpc_queue_timer_fn(unsigned long ptr)
599{
600 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
601 struct rpc_task *task, *n;
602 unsigned long expires, now, timeo;
603
604 spin_lock(&queue->lock);
605 expires = now = jiffies;
606 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
607 timeo = task->u.tk_wait.expires;
608 if (time_after_eq(now, timeo)) {
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400609 dprintk("RPC: %5u timeout\n", task->tk_pid);
610 task->tk_status = -ETIMEDOUT;
611 rpc_wake_up_task_queue_locked(queue, task);
612 continue;
613 }
614 if (expires == now || time_after(expires, timeo))
615 expires = timeo;
616 }
617 if (!list_empty(&queue->timer_list.list))
618 rpc_set_queue_timer(queue, expires);
619 spin_unlock(&queue->lock);
620}
621
Trond Myklebust80147932006-08-31 18:24:08 -0400622static void __rpc_atrun(struct rpc_task *task)
623{
Trond Myklebust5d008372008-02-22 16:34:17 -0500624 task->tk_status = 0;
Trond Myklebust80147932006-08-31 18:24:08 -0400625}
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627/*
628 * Run a task at a later time
629 */
Trond Myklebust80147932006-08-31 18:24:08 -0400630void rpc_delay(struct rpc_task *task, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
632 task->tk_timeout = delay;
Trond Myklebust5d008372008-02-22 16:34:17 -0500633 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400635EXPORT_SYMBOL_GPL(rpc_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637/*
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100638 * Helper to call task->tk_ops->rpc_call_prepare
639 */
Andy Adamsonaae20062009-04-01 09:22:40 -0400640void rpc_prepare_task(struct rpc_task *task)
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100641{
642 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
643}
644
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500645static void
646rpc_init_task_statistics(struct rpc_task *task)
647{
648 /* Initialize retry counters */
649 task->tk_garb_retry = 2;
650 task->tk_cred_retry = 2;
651 task->tk_rebind_retry = 2;
652
653 /* starting timestamp */
654 task->tk_start = ktime_get();
655}
656
657static void
658rpc_reset_task_statistics(struct rpc_task *task)
659{
660 task->tk_timeouts = 0;
661 task->tk_flags &= ~(RPC_CALL_MAJORSEEN|RPC_TASK_KILLED|RPC_TASK_SENT);
662
663 rpc_init_task_statistics(task);
664}
665
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100666/*
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100667 * Helper that calls task->tk_ops->rpc_call_done if it exists
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000668 */
Trond Myklebustabbcf282006-01-03 09:55:03 +0100669void rpc_exit_task(struct rpc_task *task)
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000670{
Trond Myklebustabbcf282006-01-03 09:55:03 +0100671 task->tk_action = NULL;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100672 if (task->tk_ops->rpc_call_done != NULL) {
673 task->tk_ops->rpc_call_done(task, task->tk_calldata);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000674 if (task->tk_action != NULL) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100675 WARN_ON(RPC_ASSASSINATED(task));
676 /* Always release the RPC slot and buffer memory */
677 xprt_release(task);
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500678 rpc_reset_task_statistics(task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000679 }
680 }
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000681}
Trond Myklebustd9b6cd92010-07-31 14:29:08 -0400682
683void rpc_exit(struct rpc_task *task, int status)
684{
685 task->tk_status = status;
686 task->tk_action = rpc_exit_task;
687 if (RPC_IS_QUEUED(task))
688 rpc_wake_up_queued_task(task->tk_waitqueue, task);
689}
690EXPORT_SYMBOL_GPL(rpc_exit);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000691
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400692void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
693{
Trond Myklebusta86dc492008-06-11 13:37:09 -0400694 if (ops->rpc_release != NULL)
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400695 ops->rpc_release(calldata);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400696}
697
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000698/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 * This is the RPC `scheduler' (or rather, the finite state machine).
700 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800701static void __rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400703 struct rpc_wait_queue *queue;
704 int task_is_async = RPC_IS_ASYNC(task);
705 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Chuck Lever46121cf2007-01-31 12:14:08 -0500707 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
708 task->tk_pid, task->tk_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710 BUG_ON(RPC_IS_QUEUED(task));
711
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000712 for (;;) {
Trond Myklebustb55c5982011-07-06 19:58:23 -0400713 void (*do_action)(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 /*
Trond Myklebustb55c5982011-07-06 19:58:23 -0400716 * Execute any pending callback first.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400718 do_action = task->tk_callback;
719 task->tk_callback = NULL;
720 if (do_action == NULL) {
Trond Myklebuste020c682011-03-15 19:56:30 -0400721 /*
722 * Perform the next FSM step.
Trond Myklebustb55c5982011-07-06 19:58:23 -0400723 * tk_action may be NULL if the task has been killed.
724 * In particular, note that rpc_killall_tasks may
725 * do this at any time, so beware when dereferencing.
Trond Myklebuste020c682011-03-15 19:56:30 -0400726 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400727 do_action = task->tk_action;
728 if (do_action == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 }
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500731 trace_rpc_task_run_action(task->tk_client, task, task->tk_action);
Trond Myklebustb55c5982011-07-06 19:58:23 -0400732 do_action(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
734 /*
735 * Lockless check for whether task is sleeping or not.
736 */
737 if (!RPC_IS_QUEUED(task))
738 continue;
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400739 /*
740 * The queue->lock protects against races with
741 * rpc_make_runnable().
742 *
743 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
744 * rpc_task, rpc_make_runnable() can assign it to a
745 * different workqueue. We therefore cannot assume that the
746 * rpc_task pointer may still be dereferenced.
747 */
748 queue = task->tk_waitqueue;
749 spin_lock_bh(&queue->lock);
750 if (!RPC_IS_QUEUED(task)) {
751 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 continue;
753 }
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400754 rpc_clear_running(task);
755 spin_unlock_bh(&queue->lock);
756 if (task_is_async)
757 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
759 /* sync task: sleep here */
Chuck Lever46121cf2007-01-31 12:14:08 -0500760 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000761 status = out_of_line_wait_on_bit(&task->tk_runstate,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500762 RPC_TASK_QUEUED, rpc_wait_bit_killable,
763 TASK_KILLABLE);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000764 if (status == -ERESTARTSYS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 /*
766 * When a sync task receives a signal, it exits with
767 * -ERESTARTSYS. In order to catch any callbacks that
768 * clean up after sleeping on some queue, we don't
769 * break the loop here, but go around once more.
770 */
Chuck Lever46121cf2007-01-31 12:14:08 -0500771 dprintk("RPC: %5u got signal\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000772 task->tk_flags |= RPC_TASK_KILLED;
773 rpc_exit(task, -ERESTARTSYS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 }
775 rpc_set_running(task);
Chuck Lever46121cf2007-01-31 12:14:08 -0500776 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 }
778
Chuck Lever46121cf2007-01-31 12:14:08 -0500779 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
780 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 /* Release all resources associated with the task */
782 rpc_release_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783}
784
785/*
786 * User-visible entry point to the scheduler.
787 *
788 * This may be called recursively if e.g. an async NFS task updates
789 * the attributes and finds that dirty pages must be flushed.
790 * NOTE: Upon exit of this function the task is guaranteed to be
791 * released. In particular note that tk_release() will have
792 * been called, so your task memory may have been freed.
793 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800794void rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795{
Trond Myklebust44c28872006-01-03 09:55:06 +0100796 rpc_set_active(task);
Trond Myklebustd6a1ed02010-07-31 14:29:08 -0400797 rpc_make_runnable(task);
798 if (!RPC_IS_ASYNC(task))
799 __rpc_execute(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
David Howells65f27f32006-11-22 14:55:48 +0000802static void rpc_async_schedule(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803{
Jeff Layton5cf02d02012-07-23 13:58:51 -0400804 current->flags |= PF_FSTRANS;
David Howells65f27f32006-11-22 14:55:48 +0000805 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
Jeff Layton5cf02d02012-07-23 13:58:51 -0400806 current->flags &= ~PF_FSTRANS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Chuck Lever02107142006-01-03 09:55:49 +0100809/**
810 * rpc_malloc - allocate an RPC buffer
811 * @task: RPC task that will use this buffer
812 * @size: requested byte size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 *
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400814 * To prevent rpciod from hanging, this allocator never sleeps,
815 * returning NULL if the request cannot be serviced immediately.
816 * The caller can arrange to sleep in a way that is safe for rpciod.
817 *
818 * Most requests are 'small' (under 2KiB) and can be serviced from a
819 * mempool, ensuring that NFS reads and writes can always proceed,
820 * and that there is good locality of reference for these buffers.
821 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 * In order to avoid memory starvation triggering more writebacks of
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400823 * NFS requests, we avoid using GFP_KERNEL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400825void *rpc_malloc(struct rpc_task *task, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400827 struct rpc_buffer *buf;
Mel Gormana564b8f2012-07-31 16:45:12 -0700828 gfp_t gfp = GFP_NOWAIT;
829
830 if (RPC_IS_SWAPPER(task))
831 gfp |= __GFP_MEMALLOC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400833 size += sizeof(struct rpc_buffer);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400834 if (size <= RPC_BUFFER_MAXSIZE)
835 buf = mempool_alloc(rpc_buffer_mempool, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 else
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400837 buf = kmalloc(size, gfp);
Peter Zijlstraddce40d2007-05-09 08:30:11 +0200838
839 if (!buf)
840 return NULL;
841
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400842 buf->len = size;
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200843 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400844 task->tk_pid, size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400845 return &buf->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400847EXPORT_SYMBOL_GPL(rpc_malloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Chuck Lever02107142006-01-03 09:55:49 +0100849/**
850 * rpc_free - free buffer allocated via rpc_malloc
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400851 * @buffer: buffer to free
Chuck Lever02107142006-01-03 09:55:49 +0100852 *
853 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400854void rpc_free(void *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400856 size_t size;
857 struct rpc_buffer *buf;
Chuck Lever02107142006-01-03 09:55:49 +0100858
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400859 if (!buffer)
860 return;
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400861
862 buf = container_of(buffer, struct rpc_buffer, data);
863 size = buf->len;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400864
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200865 dprintk("RPC: freeing buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400866 size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400867
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400868 if (size <= RPC_BUFFER_MAXSIZE)
869 mempool_free(buf, rpc_buffer_mempool);
870 else
871 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400873EXPORT_SYMBOL_GPL(rpc_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875/*
876 * Creation and deletion of RPC task structures
877 */
Trond Myklebust47fe0642007-10-25 18:42:55 -0400878static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879{
880 memset(task, 0, sizeof(*task));
Trond Myklebust44c28872006-01-03 09:55:06 +0100881 atomic_set(&task->tk_count, 1);
Trond Myklebust84115e12007-07-14 15:39:59 -0400882 task->tk_flags = task_setup_data->flags;
883 task->tk_ops = task_setup_data->callback_ops;
884 task->tk_calldata = task_setup_data->callback_data;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400885 INIT_LIST_HEAD(&task->tk_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
Trond Myklebust3ff75762007-07-14 15:40:00 -0400887 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
888 task->tk_owner = current->tgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
890 /* Initialize workqueue for async tasks */
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500891 task->tk_workqueue = task_setup_data->workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Trond Myklebust84115e12007-07-14 15:39:59 -0400893 if (task->tk_ops->rpc_call_prepare != NULL)
894 task->tk_action = rpc_prepare_task;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100895
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500896 rpc_init_task_statistics(task);
Chuck Leveref759a22006-03-20 13:44:17 -0500897
Chuck Lever46121cf2007-01-31 12:14:08 -0500898 dprintk("RPC: new task initialized, procpid %u\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700899 task_pid_nr(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900}
901
902static struct rpc_task *
903rpc_alloc_task(void)
904{
Mel Gormana564b8f2012-07-31 16:45:12 -0700905 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906}
907
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908/*
Trond Myklebust90c57552007-06-09 19:49:36 -0400909 * Create a new task for the specified client.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400911struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400913 struct rpc_task *task = setup_data->task;
914 unsigned short flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400916 if (task == NULL) {
917 task = rpc_alloc_task();
Trond Myklebust19445b92010-04-16 16:41:10 -0400918 if (task == NULL) {
919 rpc_release_calldata(setup_data->callback_ops,
920 setup_data->callback_data);
921 return ERR_PTR(-ENOMEM);
922 }
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400923 flags = RPC_TASK_DYNAMIC;
924 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Trond Myklebust84115e12007-07-14 15:39:59 -0400926 rpc_init_task(task, setup_data);
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400927 task->tk_flags |= flags;
Chuck Lever46121cf2007-01-31 12:14:08 -0500928 dprintk("RPC: allocated task %p\n", task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 return task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930}
931
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500932static void rpc_free_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100934 const struct rpc_call_ops *tk_ops = task->tk_ops;
935 void *calldata = task->tk_calldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800937 if (task->tk_flags & RPC_TASK_DYNAMIC) {
938 dprintk("RPC: %5u freeing task\n", task->tk_pid);
939 mempool_free(task, rpc_task_mempool);
940 }
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500941 rpc_release_calldata(tk_ops, calldata);
942}
943
944static void rpc_async_release(struct work_struct *work)
945{
946 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
947}
948
Trond Myklebustbf294b42011-02-21 11:05:41 -0800949static void rpc_release_resources_task(struct rpc_task *task)
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500950{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500951 if (task->tk_rqstp)
952 xprt_release(task);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200953 if (task->tk_msg.rpc_cred) {
Trond Myklebusta17c2152010-07-31 14:29:08 -0400954 put_rpccred(task->tk_msg.rpc_cred);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200955 task->tk_msg.rpc_cred = NULL;
956 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400957 rpc_task_release_client(task);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800958}
959
960static void rpc_final_put_task(struct rpc_task *task,
961 struct workqueue_struct *q)
962{
963 if (q != NULL) {
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500964 INIT_WORK(&task->u.tk_work, rpc_async_release);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800965 queue_work(q, &task->u.tk_work);
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500966 } else
967 rpc_free_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500968}
Trond Myklebustbf294b42011-02-21 11:05:41 -0800969
970static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
971{
972 if (atomic_dec_and_test(&task->tk_count)) {
973 rpc_release_resources_task(task);
974 rpc_final_put_task(task, q);
975 }
976}
977
978void rpc_put_task(struct rpc_task *task)
979{
980 rpc_do_put_task(task, NULL);
981}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400982EXPORT_SYMBOL_GPL(rpc_put_task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500983
Trond Myklebustbf294b42011-02-21 11:05:41 -0800984void rpc_put_task_async(struct rpc_task *task)
985{
986 rpc_do_put_task(task, task->tk_workqueue);
987}
988EXPORT_SYMBOL_GPL(rpc_put_task_async);
989
Trond Myklebustbde8f002007-01-24 11:54:53 -0800990static void rpc_release_task(struct rpc_task *task)
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500991{
Chuck Lever46121cf2007-01-31 12:14:08 -0500992 dprintk("RPC: %5u release task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 BUG_ON (RPC_IS_QUEUED(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
Trond Myklebustbf294b42011-02-21 11:05:41 -0800996 rpc_release_resources_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500997
Trond Myklebustbf294b42011-02-21 11:05:41 -0800998 /*
999 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
1000 * so it should be safe to use task->tk_count as a test for whether
1001 * or not any other processes still hold references to our rpc_task.
1002 */
1003 if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
1004 /* Wake up anyone who may be waiting for task completion */
1005 if (!rpc_complete_task(task))
1006 return;
1007 } else {
1008 if (!atomic_dec_and_test(&task->tk_count))
1009 return;
1010 }
1011 rpc_final_put_task(task, task->tk_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012}
1013
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001014int rpciod_up(void)
1015{
1016 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
1017}
1018
1019void rpciod_down(void)
1020{
1021 module_put(THIS_MODULE);
1022}
1023
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024/*
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001025 * Start up the rpciod workqueue.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 */
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001027static int rpciod_start(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028{
1029 struct workqueue_struct *wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 /*
1032 * Create the rpciod thread and wait for it to start.
1033 */
Trond Myklebustab418d72007-06-14 17:08:36 -04001034 dprintk("RPC: creating workqueue rpciod\n");
Trond Myklebust9b96ce72012-09-28 20:24:16 -04001035 wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 rpciod_workqueue = wq;
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001037 return rpciod_workqueue != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038}
1039
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001040static void rpciod_stop(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001042 struct workqueue_struct *wq = NULL;
Trond Myklebustab418d72007-06-14 17:08:36 -04001043
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001044 if (rpciod_workqueue == NULL)
1045 return;
Trond Myklebustab418d72007-06-14 17:08:36 -04001046 dprintk("RPC: destroying workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001048 wq = rpciod_workqueue;
1049 rpciod_workqueue = NULL;
1050 destroy_workqueue(wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051}
1052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053void
1054rpc_destroy_mempool(void)
1055{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001056 rpciod_stop();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 if (rpc_buffer_mempool)
1058 mempool_destroy(rpc_buffer_mempool);
1059 if (rpc_task_mempool)
1060 mempool_destroy(rpc_task_mempool);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001061 if (rpc_task_slabp)
1062 kmem_cache_destroy(rpc_task_slabp);
1063 if (rpc_buffer_slabp)
1064 kmem_cache_destroy(rpc_buffer_slabp);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001065 rpc_destroy_wait_queue(&delay_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066}
1067
1068int
1069rpc_init_mempool(void)
1070{
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001071 /*
1072 * The following is not strictly a mempool initialisation,
1073 * but there is no harm in doing it here
1074 */
1075 rpc_init_wait_queue(&delay_queue, "delayq");
1076 if (!rpciod_start())
1077 goto err_nomem;
1078
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1080 sizeof(struct rpc_task),
1081 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001082 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 if (!rpc_task_slabp)
1084 goto err_nomem;
1085 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1086 RPC_BUFFER_MAXSIZE,
1087 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001088 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 if (!rpc_buffer_slabp)
1090 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001091 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1092 rpc_task_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 if (!rpc_task_mempool)
1094 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001095 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1096 rpc_buffer_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 if (!rpc_buffer_mempool)
1098 goto err_nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 return 0;
1100err_nomem:
1101 rpc_destroy_mempool();
1102 return -ENOMEM;
1103}