blob: 38cca3259f3a2e6a6f02d2677b85303727b6b028 [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++;
Trond Myklebust66156e62013-03-25 11:23:40 -0400146 /* barrier matches the read in rpc_wake_up_task_queue_locked() */
147 smp_wmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 rpc_set_queued(task);
149
Chuck Lever46121cf2007-01-31 12:14:08 -0500150 dprintk("RPC: %5u added to queue %p \"%s\"\n",
151 task->tk_pid, queue, rpc_qname(queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152}
153
154/*
155 * Remove request from a priority queue.
156 */
157static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
158{
159 struct rpc_task *t;
160
161 if (!list_empty(&task->u.tk_wait.links)) {
162 t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
163 list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
164 list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
165 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166}
167
168/*
169 * Remove request from queue.
170 * Note: must be called with spin lock held.
171 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500172static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
Trond Myklebusteb276c02008-02-22 17:27:59 -0500174 __rpc_disable_timer(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 if (RPC_IS_PRIORITY(queue))
176 __rpc_remove_wait_queue_priority(task);
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400177 list_del(&task->u.tk_wait.list);
Chuck Levere19b63d2006-03-20 13:44:15 -0500178 queue->qlen--;
Chuck Lever46121cf2007-01-31 12:14:08 -0500179 dprintk("RPC: %5u removed from queue %p \"%s\"\n",
180 task->tk_pid, queue, rpc_qname(queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181}
182
183static inline void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
184{
185 queue->priority = priority;
186 queue->count = 1 << (priority * 2);
187}
188
Trond Myklebust3ff75762007-07-14 15:40:00 -0400189static inline void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400191 queue->owner = pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 queue->nr = RPC_BATCH_COUNT;
193}
194
195static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
196{
197 rpc_set_waitqueue_priority(queue, queue->maxpriority);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400198 rpc_set_waitqueue_owner(queue, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199}
200
Trond Myklebust3ff75762007-07-14 15:40:00 -0400201static 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 -0700202{
203 int i;
204
205 spin_lock_init(&queue->lock);
206 for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
207 INIT_LIST_HEAD(&queue->tasks[i]);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400208 queue->maxpriority = nr_queues - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 rpc_reset_waitqueue_priority(queue);
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400210 queue->qlen = 0;
211 setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
212 INIT_LIST_HEAD(&queue->timer_list.list);
Trond Myklebust2f09c242012-02-08 22:01:15 -0500213 rpc_assign_waitqueue_name(queue, qname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214}
215
216void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
217{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400218 __rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219}
Alexandros Batsakis689cf5c2009-12-14 21:27:56 -0800220EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
223{
Trond Myklebust3ff75762007-07-14 15:40:00 -0400224 __rpc_init_priority_wait_queue(queue, qname, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400226EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500228void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
229{
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400230 del_timer_sync(&queue->timer_list.timer);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500231}
232EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);
233
Matthew Wilcox150030b2007-12-06 16:24:39 -0500234static int rpc_wait_bit_killable(void *word)
Trond Myklebust44c28872006-01-03 09:55:06 +0100235{
Matthew Wilcox150030b2007-12-06 16:24:39 -0500236 if (fatal_signal_pending(current))
Trond Myklebust44c28872006-01-03 09:55:06 +0100237 return -ERESTARTSYS;
Jeff Laytond3103102011-12-01 22:44:39 +0100238 freezable_schedule();
Trond Myklebust44c28872006-01-03 09:55:06 +0100239 return 0;
240}
241
Trond Myklebustc44fe702007-06-16 14:17:01 -0400242#ifdef RPC_DEBUG
243static void rpc_task_set_debuginfo(struct rpc_task *task)
244{
245 static atomic_t rpc_pid;
246
Trond Myklebustc44fe702007-06-16 14:17:01 -0400247 task->tk_pid = atomic_inc_return(&rpc_pid);
248}
249#else
250static inline void rpc_task_set_debuginfo(struct rpc_task *task)
251{
252}
253#endif
254
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500255static void rpc_set_active(struct rpc_task *task)
256{
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500257 trace_rpc_task_begin(task->tk_client, task, NULL);
258
Trond Myklebustc44fe702007-06-16 14:17:01 -0400259 rpc_task_set_debuginfo(task);
Trond Myklebust58f96122010-07-31 14:29:08 -0400260 set_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500261}
262
Trond Myklebust44c28872006-01-03 09:55:06 +0100263/*
264 * Mark an RPC call as having completed by clearing the 'active' bit
Trond Myklebustbf294b42011-02-21 11:05:41 -0800265 * and then waking up all tasks that were sleeping.
Trond Myklebust44c28872006-01-03 09:55:06 +0100266 */
Trond Myklebustbf294b42011-02-21 11:05:41 -0800267static int rpc_complete_task(struct rpc_task *task)
Trond Myklebust44c28872006-01-03 09:55:06 +0100268{
Trond Myklebustbf294b42011-02-21 11:05:41 -0800269 void *m = &task->tk_runstate;
270 wait_queue_head_t *wq = bit_waitqueue(m, RPC_TASK_ACTIVE);
271 struct wait_bit_key k = __WAIT_BIT_KEY_INITIALIZER(m, RPC_TASK_ACTIVE);
272 unsigned long flags;
273 int ret;
274
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500275 trace_rpc_task_complete(task->tk_client, task, NULL);
276
Trond Myklebustbf294b42011-02-21 11:05:41 -0800277 spin_lock_irqsave(&wq->lock, flags);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500278 clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800279 ret = atomic_dec_and_test(&task->tk_count);
280 if (waitqueue_active(wq))
281 __wake_up_locked_key(wq, TASK_NORMAL, &k);
282 spin_unlock_irqrestore(&wq->lock, flags);
283 return ret;
Trond Myklebust44c28872006-01-03 09:55:06 +0100284}
285
286/*
287 * Allow callers to wait for completion of an RPC call
Trond Myklebustbf294b42011-02-21 11:05:41 -0800288 *
289 * Note the use of out_of_line_wait_on_bit() rather than wait_on_bit()
290 * to enforce taking of the wq->lock and hence avoid races with
291 * rpc_complete_task().
Trond Myklebust44c28872006-01-03 09:55:06 +0100292 */
293int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
294{
295 if (action == NULL)
Matthew Wilcox150030b2007-12-06 16:24:39 -0500296 action = rpc_wait_bit_killable;
Trond Myklebustbf294b42011-02-21 11:05:41 -0800297 return out_of_line_wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500298 action, TASK_KILLABLE);
Trond Myklebust44c28872006-01-03 09:55:06 +0100299}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400300EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
Trond Myklebust44c28872006-01-03 09:55:06 +0100301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302/*
303 * Make an RPC task runnable.
304 *
Jeff Laytone8d5ce12012-07-23 15:51:55 -0400305 * Note: If the task is ASYNC, and is being made runnable after sitting on an
306 * rpc_wait_queue, this must be called with the queue spinlock held to protect
307 * the wait queue operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 */
309static void rpc_make_runnable(struct rpc_task *task)
310{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 rpc_clear_queued(task);
Christophe Saoutcc4dc592006-11-05 18:42:48 +0100312 if (rpc_test_and_set_running(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 return;
314 if (RPC_IS_ASYNC(task)) {
David Howells65f27f32006-11-22 14:55:48 +0000315 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
Fred Isamancee6a532011-02-11 15:42:35 +0000316 queue_work(rpciod_workqueue, &task->u.tk_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 } else
Trond Myklebust96651ab2005-06-22 17:16:21 +0000318 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319}
320
321/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 * Prepare for sleeping on a wait queue.
323 * By always appending tasks to the list we ensure FIFO behavior.
324 * NB: An RPC task will only receive interrupt-driven events as long
325 * as it's on a wait queue.
326 */
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400327static void __rpc_sleep_on_priority(struct rpc_wait_queue *q,
328 struct rpc_task *task,
329 rpc_action action,
330 unsigned char queue_priority)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331{
Chuck Lever46121cf2007-01-31 12:14:08 -0500332 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
333 task->tk_pid, rpc_qname(q), jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500335 trace_rpc_task_sleep(task->tk_client, task, q);
336
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400337 __rpc_add_wait_queue(q, task, queue_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339 BUG_ON(task->tk_callback != NULL);
340 task->tk_callback = action;
Trond Myklebusteb276c02008-02-22 17:27:59 -0500341 __rpc_add_timer(q, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342}
343
344void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
Trond Myklebust5d008372008-02-22 16:34:17 -0500345 rpc_action action)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
Trond Myklebust58f96122010-07-31 14:29:08 -0400347 /* We shouldn't ever put an inactive task to sleep */
348 BUG_ON(!RPC_IS_ACTIVATED(task));
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 /*
351 * Protect the queue operations.
352 */
353 spin_lock_bh(&q->lock);
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400354 __rpc_sleep_on_priority(q, task, action, task->tk_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 spin_unlock_bh(&q->lock);
356}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400357EXPORT_SYMBOL_GPL(rpc_sleep_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400359void rpc_sleep_on_priority(struct rpc_wait_queue *q, struct rpc_task *task,
360 rpc_action action, int priority)
361{
362 /* We shouldn't ever put an inactive task to sleep */
363 BUG_ON(!RPC_IS_ACTIVATED(task));
364
365 /*
366 * Protect the queue operations.
367 */
368 spin_lock_bh(&q->lock);
369 __rpc_sleep_on_priority(q, task, action, priority - RPC_PRIORITY_LOW);
370 spin_unlock_bh(&q->lock);
371}
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373/**
374 * __rpc_do_wake_up_task - wake up a single rpc_task
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500375 * @queue: wait queue
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 * @task: task to be woken up
377 *
378 * Caller must hold queue->lock, and have cleared the task queued flag.
379 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500380static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Chuck Lever46121cf2007-01-31 12:14:08 -0500382 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
383 task->tk_pid, jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 /* Has the task been executed yet? If not, we cannot wake it up! */
386 if (!RPC_IS_ACTIVATED(task)) {
387 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
388 return;
389 }
390
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500391 trace_rpc_task_wakeup(task->tk_client, task, queue);
392
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500393 __rpc_remove_wait_queue(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395 rpc_make_runnable(task);
396
Chuck Lever46121cf2007-01-31 12:14:08 -0500397 dprintk("RPC: __rpc_wake_up_task done\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398}
399
400/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500401 * Wake up a queued task while the queue lock is being held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500403static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
Trond Myklebust66156e62013-03-25 11:23:40 -0400405 if (RPC_IS_QUEUED(task)) {
406 smp_rmb();
407 if (task->tk_waitqueue == queue)
408 __rpc_do_wake_up_task(queue, task);
409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410}
411
412/*
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800413 * Tests whether rpc queue is empty
414 */
415int rpc_queue_empty(struct rpc_wait_queue *queue)
416{
417 int res;
418
419 spin_lock_bh(&queue->lock);
420 res = queue->qlen;
421 spin_unlock_bh(&queue->lock);
Eric Dumazeta02cec22010-09-22 20:43:57 +0000422 return res == 0;
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800423}
424EXPORT_SYMBOL_GPL(rpc_queue_empty);
425
426/*
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500427 * Wake up a task on a specific queue
428 */
429void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
430{
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800431 spin_lock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500432 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800433 spin_unlock_bh(&queue->lock);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500434}
435EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
436
437/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 * Wake up the next task on a priority queue.
439 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500440static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 struct list_head *q;
443 struct rpc_task *task;
444
445 /*
Trond Myklebust3ff75762007-07-14 15:40:00 -0400446 * Service a batch of tasks from a single owner.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 */
448 q = &queue->tasks[queue->priority];
449 if (!list_empty(q)) {
450 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400451 if (queue->owner == task->tk_owner) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 if (--queue->nr)
453 goto out;
454 list_move_tail(&task->u.tk_wait.list, q);
455 }
456 /*
457 * Check if we need to switch queues.
458 */
459 if (--queue->count)
Trond Myklebust3ff75762007-07-14 15:40:00 -0400460 goto new_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 }
462
463 /*
464 * Service the next queue.
465 */
466 do {
467 if (q == &queue->tasks[0])
468 q = &queue->tasks[queue->maxpriority];
469 else
470 q = q - 1;
471 if (!list_empty(q)) {
472 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
473 goto new_queue;
474 }
475 } while (q != &queue->tasks[queue->priority]);
476
477 rpc_reset_waitqueue_priority(queue);
478 return NULL;
479
480new_queue:
481 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
Trond Myklebust3ff75762007-07-14 15:40:00 -0400482new_owner:
483 rpc_set_waitqueue_owner(queue, task->tk_owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 return task;
486}
487
Trond Myklebust961a8282012-01-17 22:57:37 -0500488static struct rpc_task *__rpc_find_next_queued(struct rpc_wait_queue *queue)
489{
490 if (RPC_IS_PRIORITY(queue))
491 return __rpc_find_next_queued_priority(queue);
492 if (!list_empty(&queue->tasks[0]))
493 return list_first_entry(&queue->tasks[0], struct rpc_task, u.tk_wait.list);
494 return NULL;
495}
496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497/*
Trond Myklebust961a8282012-01-17 22:57:37 -0500498 * Wake up the first task on the wait queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500500struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
501 bool (*func)(struct rpc_task *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502{
503 struct rpc_task *task = NULL;
504
Trond Myklebust961a8282012-01-17 22:57:37 -0500505 dprintk("RPC: wake_up_first(%p \"%s\")\n",
Chuck Lever46121cf2007-01-31 12:14:08 -0500506 queue, rpc_qname(queue));
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800507 spin_lock_bh(&queue->lock);
Trond Myklebust961a8282012-01-17 22:57:37 -0500508 task = __rpc_find_next_queued(queue);
509 if (task != NULL) {
510 if (func(task, data))
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500511 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust961a8282012-01-17 22:57:37 -0500512 else
513 task = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800515 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517 return task;
518}
Trond Myklebust961a8282012-01-17 22:57:37 -0500519EXPORT_SYMBOL_GPL(rpc_wake_up_first);
520
521static bool rpc_wake_up_next_func(struct rpc_task *task, void *data)
522{
523 return true;
524}
525
526/*
527 * Wake up the next task on the wait queue.
528*/
529struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *queue)
530{
531 return rpc_wake_up_first(queue, rpc_wake_up_next_func, NULL);
532}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400533EXPORT_SYMBOL_GPL(rpc_wake_up_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
535/**
536 * rpc_wake_up - wake up all rpc_tasks
537 * @queue: rpc_wait_queue on which the tasks are sleeping
538 *
539 * Grabs queue->lock
540 */
541void rpc_wake_up(struct rpc_wait_queue *queue)
542{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 struct list_head *head;
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800544
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800545 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 head = &queue->tasks[queue->maxpriority];
547 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400548 while (!list_empty(head)) {
549 struct rpc_task *task;
550 task = list_first_entry(head,
551 struct rpc_task,
552 u.tk_wait.list);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500553 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust540a0f72012-03-19 13:39:35 -0400554 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 if (head == &queue->tasks[0])
556 break;
557 head--;
558 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800559 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400561EXPORT_SYMBOL_GPL(rpc_wake_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
563/**
564 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
565 * @queue: rpc_wait_queue on which the tasks are sleeping
566 * @status: status value to set
567 *
568 * Grabs queue->lock
569 */
570void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
571{
572 struct list_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800574 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 head = &queue->tasks[queue->maxpriority];
576 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400577 while (!list_empty(head)) {
578 struct rpc_task *task;
579 task = list_first_entry(head,
580 struct rpc_task,
581 u.tk_wait.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 task->tk_status = status;
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500583 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 }
585 if (head == &queue->tasks[0])
586 break;
587 head--;
588 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800589 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400591EXPORT_SYMBOL_GPL(rpc_wake_up_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400593static void __rpc_queue_timer_fn(unsigned long ptr)
594{
595 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
596 struct rpc_task *task, *n;
597 unsigned long expires, now, timeo;
598
599 spin_lock(&queue->lock);
600 expires = now = jiffies;
601 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
602 timeo = task->u.tk_wait.expires;
603 if (time_after_eq(now, timeo)) {
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400604 dprintk("RPC: %5u timeout\n", task->tk_pid);
605 task->tk_status = -ETIMEDOUT;
606 rpc_wake_up_task_queue_locked(queue, task);
607 continue;
608 }
609 if (expires == now || time_after(expires, timeo))
610 expires = timeo;
611 }
612 if (!list_empty(&queue->timer_list.list))
613 rpc_set_queue_timer(queue, expires);
614 spin_unlock(&queue->lock);
615}
616
Trond Myklebust80147932006-08-31 18:24:08 -0400617static void __rpc_atrun(struct rpc_task *task)
618{
Trond Myklebust5d008372008-02-22 16:34:17 -0500619 task->tk_status = 0;
Trond Myklebust80147932006-08-31 18:24:08 -0400620}
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622/*
623 * Run a task at a later time
624 */
Trond Myklebust80147932006-08-31 18:24:08 -0400625void rpc_delay(struct rpc_task *task, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
627 task->tk_timeout = delay;
Trond Myklebust5d008372008-02-22 16:34:17 -0500628 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400630EXPORT_SYMBOL_GPL(rpc_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632/*
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100633 * Helper to call task->tk_ops->rpc_call_prepare
634 */
Andy Adamsonaae20062009-04-01 09:22:40 -0400635void rpc_prepare_task(struct rpc_task *task)
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100636{
637 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
638}
639
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500640static void
641rpc_init_task_statistics(struct rpc_task *task)
642{
643 /* Initialize retry counters */
644 task->tk_garb_retry = 2;
645 task->tk_cred_retry = 2;
646 task->tk_rebind_retry = 2;
647
648 /* starting timestamp */
649 task->tk_start = ktime_get();
650}
651
652static void
653rpc_reset_task_statistics(struct rpc_task *task)
654{
655 task->tk_timeouts = 0;
656 task->tk_flags &= ~(RPC_CALL_MAJORSEEN|RPC_TASK_KILLED|RPC_TASK_SENT);
657
658 rpc_init_task_statistics(task);
659}
660
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100661/*
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100662 * Helper that calls task->tk_ops->rpc_call_done if it exists
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000663 */
Trond Myklebustabbcf282006-01-03 09:55:03 +0100664void rpc_exit_task(struct rpc_task *task)
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000665{
Trond Myklebustabbcf282006-01-03 09:55:03 +0100666 task->tk_action = NULL;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100667 if (task->tk_ops->rpc_call_done != NULL) {
668 task->tk_ops->rpc_call_done(task, task->tk_calldata);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000669 if (task->tk_action != NULL) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100670 WARN_ON(RPC_ASSASSINATED(task));
671 /* Always release the RPC slot and buffer memory */
672 xprt_release(task);
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500673 rpc_reset_task_statistics(task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000674 }
675 }
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000676}
Trond Myklebustd9b6cd92010-07-31 14:29:08 -0400677
678void rpc_exit(struct rpc_task *task, int status)
679{
680 task->tk_status = status;
681 task->tk_action = rpc_exit_task;
682 if (RPC_IS_QUEUED(task))
683 rpc_wake_up_queued_task(task->tk_waitqueue, task);
684}
685EXPORT_SYMBOL_GPL(rpc_exit);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000686
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400687void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
688{
Trond Myklebusta86dc492008-06-11 13:37:09 -0400689 if (ops->rpc_release != NULL)
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400690 ops->rpc_release(calldata);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400691}
692
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000693/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 * This is the RPC `scheduler' (or rather, the finite state machine).
695 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800696static void __rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400698 struct rpc_wait_queue *queue;
699 int task_is_async = RPC_IS_ASYNC(task);
700 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
Chuck Lever46121cf2007-01-31 12:14:08 -0500702 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
703 task->tk_pid, task->tk_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
705 BUG_ON(RPC_IS_QUEUED(task));
706
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000707 for (;;) {
Trond Myklebustb55c5982011-07-06 19:58:23 -0400708 void (*do_action)(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710 /*
Trond Myklebustb55c5982011-07-06 19:58:23 -0400711 * Execute any pending callback first.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400713 do_action = task->tk_callback;
714 task->tk_callback = NULL;
715 if (do_action == NULL) {
Trond Myklebuste020c682011-03-15 19:56:30 -0400716 /*
717 * Perform the next FSM step.
Trond Myklebustb55c5982011-07-06 19:58:23 -0400718 * tk_action may be NULL if the task has been killed.
719 * In particular, note that rpc_killall_tasks may
720 * do this at any time, so beware when dereferencing.
Trond Myklebuste020c682011-03-15 19:56:30 -0400721 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400722 do_action = task->tk_action;
723 if (do_action == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 }
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500726 trace_rpc_task_run_action(task->tk_client, task, task->tk_action);
Trond Myklebustb55c5982011-07-06 19:58:23 -0400727 do_action(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729 /*
730 * Lockless check for whether task is sleeping or not.
731 */
732 if (!RPC_IS_QUEUED(task))
733 continue;
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400734 /*
735 * The queue->lock protects against races with
736 * rpc_make_runnable().
737 *
738 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
739 * rpc_task, rpc_make_runnable() can assign it to a
740 * different workqueue. We therefore cannot assume that the
741 * rpc_task pointer may still be dereferenced.
742 */
743 queue = task->tk_waitqueue;
744 spin_lock_bh(&queue->lock);
745 if (!RPC_IS_QUEUED(task)) {
746 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 continue;
748 }
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400749 rpc_clear_running(task);
750 spin_unlock_bh(&queue->lock);
751 if (task_is_async)
752 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
754 /* sync task: sleep here */
Chuck Lever46121cf2007-01-31 12:14:08 -0500755 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000756 status = out_of_line_wait_on_bit(&task->tk_runstate,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500757 RPC_TASK_QUEUED, rpc_wait_bit_killable,
758 TASK_KILLABLE);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000759 if (status == -ERESTARTSYS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 /*
761 * When a sync task receives a signal, it exits with
762 * -ERESTARTSYS. In order to catch any callbacks that
763 * clean up after sleeping on some queue, we don't
764 * break the loop here, but go around once more.
765 */
Chuck Lever46121cf2007-01-31 12:14:08 -0500766 dprintk("RPC: %5u got signal\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000767 task->tk_flags |= RPC_TASK_KILLED;
768 rpc_exit(task, -ERESTARTSYS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 }
770 rpc_set_running(task);
Chuck Lever46121cf2007-01-31 12:14:08 -0500771 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 }
773
Chuck Lever46121cf2007-01-31 12:14:08 -0500774 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
775 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 /* Release all resources associated with the task */
777 rpc_release_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778}
779
780/*
781 * User-visible entry point to the scheduler.
782 *
783 * This may be called recursively if e.g. an async NFS task updates
784 * the attributes and finds that dirty pages must be flushed.
785 * NOTE: Upon exit of this function the task is guaranteed to be
786 * released. In particular note that tk_release() will have
787 * been called, so your task memory may have been freed.
788 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800789void rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790{
Trond Myklebust44c28872006-01-03 09:55:06 +0100791 rpc_set_active(task);
Trond Myklebustd6a1ed02010-07-31 14:29:08 -0400792 rpc_make_runnable(task);
793 if (!RPC_IS_ASYNC(task))
794 __rpc_execute(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795}
796
David Howells65f27f32006-11-22 14:55:48 +0000797static void rpc_async_schedule(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
Jeff Layton032da6a2012-07-23 13:58:51 -0400799 current->flags |= PF_FSTRANS;
David Howells65f27f32006-11-22 14:55:48 +0000800 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
Jeff Layton032da6a2012-07-23 13:58:51 -0400801 current->flags &= ~PF_FSTRANS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802}
803
Chuck Lever02107142006-01-03 09:55:49 +0100804/**
805 * rpc_malloc - allocate an RPC buffer
806 * @task: RPC task that will use this buffer
807 * @size: requested byte size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 *
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400809 * To prevent rpciod from hanging, this allocator never sleeps,
810 * returning NULL if the request cannot be serviced immediately.
811 * The caller can arrange to sleep in a way that is safe for rpciod.
812 *
813 * Most requests are 'small' (under 2KiB) and can be serviced from a
814 * mempool, ensuring that NFS reads and writes can always proceed,
815 * and that there is good locality of reference for these buffers.
816 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 * In order to avoid memory starvation triggering more writebacks of
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400818 * NFS requests, we avoid using GFP_KERNEL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400820void *rpc_malloc(struct rpc_task *task, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400822 struct rpc_buffer *buf;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400823 gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400825 size += sizeof(struct rpc_buffer);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400826 if (size <= RPC_BUFFER_MAXSIZE)
827 buf = mempool_alloc(rpc_buffer_mempool, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 else
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400829 buf = kmalloc(size, gfp);
Peter Zijlstraddce40d2007-05-09 08:30:11 +0200830
831 if (!buf)
832 return NULL;
833
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400834 buf->len = size;
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200835 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400836 task->tk_pid, size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400837 return &buf->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400839EXPORT_SYMBOL_GPL(rpc_malloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
Chuck Lever02107142006-01-03 09:55:49 +0100841/**
842 * rpc_free - free buffer allocated via rpc_malloc
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400843 * @buffer: buffer to free
Chuck Lever02107142006-01-03 09:55:49 +0100844 *
845 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400846void rpc_free(void *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400848 size_t size;
849 struct rpc_buffer *buf;
Chuck Lever02107142006-01-03 09:55:49 +0100850
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400851 if (!buffer)
852 return;
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400853
854 buf = container_of(buffer, struct rpc_buffer, data);
855 size = buf->len;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400856
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200857 dprintk("RPC: freeing buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400858 size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400859
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400860 if (size <= RPC_BUFFER_MAXSIZE)
861 mempool_free(buf, rpc_buffer_mempool);
862 else
863 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400865EXPORT_SYMBOL_GPL(rpc_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
867/*
868 * Creation and deletion of RPC task structures
869 */
Trond Myklebust47fe0642007-10-25 18:42:55 -0400870static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
872 memset(task, 0, sizeof(*task));
Trond Myklebust44c28872006-01-03 09:55:06 +0100873 atomic_set(&task->tk_count, 1);
Trond Myklebust84115e12007-07-14 15:39:59 -0400874 task->tk_flags = task_setup_data->flags;
875 task->tk_ops = task_setup_data->callback_ops;
876 task->tk_calldata = task_setup_data->callback_data;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400877 INIT_LIST_HEAD(&task->tk_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
Trond Myklebust3ff75762007-07-14 15:40:00 -0400879 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
880 task->tk_owner = current->tgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
882 /* Initialize workqueue for async tasks */
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500883 task->tk_workqueue = task_setup_data->workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
Trond Myklebust84115e12007-07-14 15:39:59 -0400885 if (task->tk_ops->rpc_call_prepare != NULL)
886 task->tk_action = rpc_prepare_task;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100887
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500888 rpc_init_task_statistics(task);
Chuck Leveref759a22006-03-20 13:44:17 -0500889
Chuck Lever46121cf2007-01-31 12:14:08 -0500890 dprintk("RPC: new task initialized, procpid %u\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700891 task_pid_nr(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892}
893
894static struct rpc_task *
895rpc_alloc_task(void)
896{
897 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
898}
899
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900/*
Trond Myklebust90c57552007-06-09 19:49:36 -0400901 * Create a new task for the specified client.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400903struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904{
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400905 struct rpc_task *task = setup_data->task;
906 unsigned short flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400908 if (task == NULL) {
909 task = rpc_alloc_task();
Trond Myklebust19445b92010-04-16 16:41:10 -0400910 if (task == NULL) {
911 rpc_release_calldata(setup_data->callback_ops,
912 setup_data->callback_data);
913 return ERR_PTR(-ENOMEM);
914 }
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400915 flags = RPC_TASK_DYNAMIC;
916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Trond Myklebust84115e12007-07-14 15:39:59 -0400918 rpc_init_task(task, setup_data);
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400919 task->tk_flags |= flags;
Chuck Lever46121cf2007-01-31 12:14:08 -0500920 dprintk("RPC: allocated task %p\n", task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 return task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922}
923
Trond Myklebustd5b31992013-01-04 12:23:21 -0500924/*
925 * rpc_free_task - release rpc task and perform cleanups
926 *
927 * Note that we free up the rpc_task _after_ rpc_release_calldata()
928 * in order to work around a workqueue dependency issue.
929 *
930 * Tejun Heo states:
931 * "Workqueue currently considers two work items to be the same if they're
932 * on the same address and won't execute them concurrently - ie. it
933 * makes a work item which is queued again while being executed wait
934 * for the previous execution to complete.
935 *
936 * If a work function frees the work item, and then waits for an event
937 * which should be performed by another work item and *that* work item
938 * recycles the freed work item, it can create a false dependency loop.
939 * There really is no reliable way to detect this short of verifying
940 * every memory free."
941 *
942 */
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500943static void rpc_free_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944{
Trond Myklebustd5b31992013-01-04 12:23:21 -0500945 unsigned short tk_flags = task->tk_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
Trond Myklebustd5b31992013-01-04 12:23:21 -0500947 rpc_release_calldata(task->tk_ops, task->tk_calldata);
948
949 if (tk_flags & RPC_TASK_DYNAMIC) {
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800950 dprintk("RPC: %5u freeing task\n", task->tk_pid);
951 mempool_free(task, rpc_task_mempool);
952 }
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500953}
954
955static void rpc_async_release(struct work_struct *work)
956{
957 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
958}
959
Trond Myklebustbf294b42011-02-21 11:05:41 -0800960static void rpc_release_resources_task(struct rpc_task *task)
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500961{
Trond Myklebust11d607d2013-01-07 14:30:46 -0500962 xprt_release(task);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200963 if (task->tk_msg.rpc_cred) {
Trond Myklebusta17c2152010-07-31 14:29:08 -0400964 put_rpccred(task->tk_msg.rpc_cred);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200965 task->tk_msg.rpc_cred = NULL;
966 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400967 rpc_task_release_client(task);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800968}
969
970static void rpc_final_put_task(struct rpc_task *task,
971 struct workqueue_struct *q)
972{
973 if (q != NULL) {
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500974 INIT_WORK(&task->u.tk_work, rpc_async_release);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800975 queue_work(q, &task->u.tk_work);
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500976 } else
977 rpc_free_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500978}
Trond Myklebustbf294b42011-02-21 11:05:41 -0800979
980static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
981{
982 if (atomic_dec_and_test(&task->tk_count)) {
983 rpc_release_resources_task(task);
984 rpc_final_put_task(task, q);
985 }
986}
987
988void rpc_put_task(struct rpc_task *task)
989{
990 rpc_do_put_task(task, NULL);
991}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400992EXPORT_SYMBOL_GPL(rpc_put_task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500993
Trond Myklebustbf294b42011-02-21 11:05:41 -0800994void rpc_put_task_async(struct rpc_task *task)
995{
996 rpc_do_put_task(task, task->tk_workqueue);
997}
998EXPORT_SYMBOL_GPL(rpc_put_task_async);
999
Trond Myklebustbde8f002007-01-24 11:54:53 -08001000static void rpc_release_task(struct rpc_task *task)
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -05001001{
Chuck Lever46121cf2007-01-31 12:14:08 -05001002 dprintk("RPC: %5u release task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 BUG_ON (RPC_IS_QUEUED(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Trond Myklebustbf294b42011-02-21 11:05:41 -08001006 rpc_release_resources_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -05001007
Trond Myklebustbf294b42011-02-21 11:05:41 -08001008 /*
1009 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
1010 * so it should be safe to use task->tk_count as a test for whether
1011 * or not any other processes still hold references to our rpc_task.
1012 */
1013 if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
1014 /* Wake up anyone who may be waiting for task completion */
1015 if (!rpc_complete_task(task))
1016 return;
1017 } else {
1018 if (!atomic_dec_and_test(&task->tk_count))
1019 return;
1020 }
1021 rpc_final_put_task(task, task->tk_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022}
1023
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001024int rpciod_up(void)
1025{
1026 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
1027}
1028
1029void rpciod_down(void)
1030{
1031 module_put(THIS_MODULE);
1032}
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034/*
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001035 * Start up the rpciod workqueue.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 */
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001037static int rpciod_start(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038{
1039 struct workqueue_struct *wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 /*
1042 * Create the rpciod thread and wait for it to start.
1043 */
Trond Myklebustab418d72007-06-14 17:08:36 -04001044 dprintk("RPC: creating workqueue rpciod\n");
Tejun Heoada609e2011-01-25 14:35:54 +01001045 wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 rpciod_workqueue = wq;
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001047 return rpciod_workqueue != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048}
1049
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001050static void rpciod_stop(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001052 struct workqueue_struct *wq = NULL;
Trond Myklebustab418d72007-06-14 17:08:36 -04001053
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001054 if (rpciod_workqueue == NULL)
1055 return;
Trond Myklebustab418d72007-06-14 17:08:36 -04001056 dprintk("RPC: destroying workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001058 wq = rpciod_workqueue;
1059 rpciod_workqueue = NULL;
1060 destroy_workqueue(wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061}
1062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063void
1064rpc_destroy_mempool(void)
1065{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001066 rpciod_stop();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 if (rpc_buffer_mempool)
1068 mempool_destroy(rpc_buffer_mempool);
1069 if (rpc_task_mempool)
1070 mempool_destroy(rpc_task_mempool);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001071 if (rpc_task_slabp)
1072 kmem_cache_destroy(rpc_task_slabp);
1073 if (rpc_buffer_slabp)
1074 kmem_cache_destroy(rpc_buffer_slabp);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001075 rpc_destroy_wait_queue(&delay_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076}
1077
1078int
1079rpc_init_mempool(void)
1080{
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001081 /*
1082 * The following is not strictly a mempool initialisation,
1083 * but there is no harm in doing it here
1084 */
1085 rpc_init_wait_queue(&delay_queue, "delayq");
1086 if (!rpciod_start())
1087 goto err_nomem;
1088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1090 sizeof(struct rpc_task),
1091 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001092 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 if (!rpc_task_slabp)
1094 goto err_nomem;
1095 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1096 RPC_BUFFER_MAXSIZE,
1097 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001098 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 if (!rpc_buffer_slabp)
1100 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001101 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1102 rpc_task_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 if (!rpc_task_mempool)
1104 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001105 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1106 rpc_buffer_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 if (!rpc_buffer_mempool)
1108 goto err_nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 return 0;
1110err_nomem:
1111 rpc_destroy_mempool();
1112 return -ENOMEM;
1113}