blob: 69049179c280c059a4c8da1acf7203241a92d7aa [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{
Weston Andros Adamson2bd4eef2012-10-23 10:43:47 -0400136 WARN_ON_ONCE(RPC_IS_QUEUED(task));
137 if (RPC_IS_QUEUED(task))
138 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140 if (RPC_IS_PRIORITY(queue))
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400141 __rpc_add_wait_queue_priority(queue, task, queue_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 else if (RPC_IS_SWAPPER(task))
143 list_add(&task->u.tk_wait.list, &queue->tasks[0]);
144 else
145 list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500146 task->tk_waitqueue = queue;
Chuck Levere19b63d2006-03-20 13:44:15 -0500147 queue->qlen++;
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 Myklebust96ef13b22008-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 Layton506026c2012-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 Saoutcc4dc59e2006-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
Weston Andros Adamsonf50ad422012-10-23 10:43:46 -0400339 WARN_ON_ONCE(task->tk_callback != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 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 */
Weston Andros Adamsone454a7a2012-10-23 10:43:32 -0400348 WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
349 if (!RPC_IS_ACTIVATED(task)) {
350 task->tk_status = -EIO;
351 rpc_put_task_async(task);
352 return;
353 }
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 /*
356 * Protect the queue operations.
357 */
358 spin_lock_bh(&q->lock);
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400359 __rpc_sleep_on_priority(q, task, action, task->tk_priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 spin_unlock_bh(&q->lock);
361}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400362EXPORT_SYMBOL_GPL(rpc_sleep_on);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400364void rpc_sleep_on_priority(struct rpc_wait_queue *q, struct rpc_task *task,
365 rpc_action action, int priority)
366{
367 /* We shouldn't ever put an inactive task to sleep */
Weston Andros Adamsone454a7a2012-10-23 10:43:32 -0400368 WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
369 if (!RPC_IS_ACTIVATED(task)) {
370 task->tk_status = -EIO;
371 rpc_put_task_async(task);
372 return;
373 }
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400374
375 /*
376 * Protect the queue operations.
377 */
378 spin_lock_bh(&q->lock);
379 __rpc_sleep_on_priority(q, task, action, priority - RPC_PRIORITY_LOW);
380 spin_unlock_bh(&q->lock);
381}
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383/**
384 * __rpc_do_wake_up_task - wake up a single rpc_task
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500385 * @queue: wait queue
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 * @task: task to be woken up
387 *
388 * Caller must hold queue->lock, and have cleared the task queued flag.
389 */
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500390static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391{
Chuck Lever46121cf2007-01-31 12:14:08 -0500392 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
393 task->tk_pid, jiffies);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 /* Has the task been executed yet? If not, we cannot wake it up! */
396 if (!RPC_IS_ACTIVATED(task)) {
397 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
398 return;
399 }
400
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500401 trace_rpc_task_wakeup(task->tk_client, task, queue);
402
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500403 __rpc_remove_wait_queue(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 rpc_make_runnable(task);
406
Chuck Lever46121cf2007-01-31 12:14:08 -0500407 dprintk("RPC: __rpc_wake_up_task done\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408}
409
410/*
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500411 * Wake up a queued task while the queue lock is being held
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 */
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500413static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414{
Trond Myklebustf5fb7b062008-02-25 21:40:50 -0800415 if (RPC_IS_QUEUED(task) && task->tk_waitqueue == queue)
416 __rpc_do_wake_up_task(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417}
418
419/*
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800420 * Tests whether rpc queue is empty
421 */
422int rpc_queue_empty(struct rpc_wait_queue *queue)
423{
424 int res;
425
426 spin_lock_bh(&queue->lock);
427 res = queue->qlen;
428 spin_unlock_bh(&queue->lock);
Eric Dumazeta02cec22010-09-22 20:43:57 +0000429 return res == 0;
Alexandros Batsakis48f18612009-12-14 21:27:53 -0800430}
431EXPORT_SYMBOL_GPL(rpc_queue_empty);
432
433/*
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500434 * Wake up a task on a specific queue
435 */
436void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
437{
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800438 spin_lock_bh(&queue->lock);
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500439 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800440 spin_unlock_bh(&queue->lock);
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500441}
442EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
443
444/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 * Wake up the next task on a priority queue.
446 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500447static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448{
449 struct list_head *q;
450 struct rpc_task *task;
451
452 /*
Trond Myklebust3ff75762007-07-14 15:40:00 -0400453 * Service a batch of tasks from a single owner.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 */
455 q = &queue->tasks[queue->priority];
456 if (!list_empty(q)) {
457 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
Trond Myklebust3ff75762007-07-14 15:40:00 -0400458 if (queue->owner == task->tk_owner) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 if (--queue->nr)
460 goto out;
461 list_move_tail(&task->u.tk_wait.list, q);
462 }
463 /*
464 * Check if we need to switch queues.
465 */
466 if (--queue->count)
Trond Myklebust3ff75762007-07-14 15:40:00 -0400467 goto new_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 }
469
470 /*
471 * Service the next queue.
472 */
473 do {
474 if (q == &queue->tasks[0])
475 q = &queue->tasks[queue->maxpriority];
476 else
477 q = q - 1;
478 if (!list_empty(q)) {
479 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
480 goto new_queue;
481 }
482 } while (q != &queue->tasks[queue->priority]);
483
484 rpc_reset_waitqueue_priority(queue);
485 return NULL;
486
487new_queue:
488 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
Trond Myklebust3ff75762007-07-14 15:40:00 -0400489new_owner:
490 rpc_set_waitqueue_owner(queue, task->tk_owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 return task;
493}
494
Trond Myklebust961a8282012-01-17 22:57:37 -0500495static struct rpc_task *__rpc_find_next_queued(struct rpc_wait_queue *queue)
496{
497 if (RPC_IS_PRIORITY(queue))
498 return __rpc_find_next_queued_priority(queue);
499 if (!list_empty(&queue->tasks[0]))
500 return list_first_entry(&queue->tasks[0], struct rpc_task, u.tk_wait.list);
501 return NULL;
502}
503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504/*
Trond Myklebust961a8282012-01-17 22:57:37 -0500505 * Wake up the first task on the wait queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 */
Trond Myklebust961a8282012-01-17 22:57:37 -0500507struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
508 bool (*func)(struct rpc_task *, void *), void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
510 struct rpc_task *task = NULL;
511
Trond Myklebust961a8282012-01-17 22:57:37 -0500512 dprintk("RPC: wake_up_first(%p \"%s\")\n",
Chuck Lever46121cf2007-01-31 12:14:08 -0500513 queue, rpc_qname(queue));
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800514 spin_lock_bh(&queue->lock);
Trond Myklebust961a8282012-01-17 22:57:37 -0500515 task = __rpc_find_next_queued(queue);
516 if (task != NULL) {
517 if (func(task, data))
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500518 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust961a8282012-01-17 22:57:37 -0500519 else
520 task = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800522 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
524 return task;
525}
Trond Myklebust961a8282012-01-17 22:57:37 -0500526EXPORT_SYMBOL_GPL(rpc_wake_up_first);
527
528static bool rpc_wake_up_next_func(struct rpc_task *task, void *data)
529{
530 return true;
531}
532
533/*
534 * Wake up the next task on the wait queue.
535*/
536struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *queue)
537{
538 return rpc_wake_up_first(queue, rpc_wake_up_next_func, NULL);
539}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400540EXPORT_SYMBOL_GPL(rpc_wake_up_next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542/**
543 * rpc_wake_up - wake up all rpc_tasks
544 * @queue: rpc_wait_queue on which the tasks are sleeping
545 *
546 * Grabs queue->lock
547 */
548void rpc_wake_up(struct rpc_wait_queue *queue)
549{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 struct list_head *head;
Trond Myklebuste6d83d52006-03-13 21:20:48 -0800551
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800552 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 head = &queue->tasks[queue->maxpriority];
554 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400555 while (!list_empty(head)) {
556 struct rpc_task *task;
557 task = list_first_entry(head,
558 struct rpc_task,
559 u.tk_wait.list);
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500560 rpc_wake_up_task_queue_locked(queue, task);
Trond Myklebust540a0f72012-03-19 13:39:35 -0400561 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 if (head == &queue->tasks[0])
563 break;
564 head--;
565 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800566 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400568EXPORT_SYMBOL_GPL(rpc_wake_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
570/**
571 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
572 * @queue: rpc_wait_queue on which the tasks are sleeping
573 * @status: status value to set
574 *
575 * Grabs queue->lock
576 */
577void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
578{
579 struct list_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800581 spin_lock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 head = &queue->tasks[queue->maxpriority];
583 for (;;) {
Trond Myklebust540a0f72012-03-19 13:39:35 -0400584 while (!list_empty(head)) {
585 struct rpc_task *task;
586 task = list_first_entry(head,
587 struct rpc_task,
588 u.tk_wait.list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 task->tk_status = status;
Trond Myklebust96ef13b22008-02-22 15:46:41 -0500590 rpc_wake_up_task_queue_locked(queue, task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 }
592 if (head == &queue->tasks[0])
593 break;
594 head--;
595 }
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800596 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400598EXPORT_SYMBOL_GPL(rpc_wake_up_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400600static void __rpc_queue_timer_fn(unsigned long ptr)
601{
602 struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
603 struct rpc_task *task, *n;
604 unsigned long expires, now, timeo;
605
606 spin_lock(&queue->lock);
607 expires = now = jiffies;
608 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
609 timeo = task->u.tk_wait.expires;
610 if (time_after_eq(now, timeo)) {
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400611 dprintk("RPC: %5u timeout\n", task->tk_pid);
612 task->tk_status = -ETIMEDOUT;
613 rpc_wake_up_task_queue_locked(queue, task);
614 continue;
615 }
616 if (expires == now || time_after(expires, timeo))
617 expires = timeo;
618 }
619 if (!list_empty(&queue->timer_list.list))
620 rpc_set_queue_timer(queue, expires);
621 spin_unlock(&queue->lock);
622}
623
Trond Myklebust80147932006-08-31 18:24:08 -0400624static void __rpc_atrun(struct rpc_task *task)
625{
Trond Myklebust5d008372008-02-22 16:34:17 -0500626 task->tk_status = 0;
Trond Myklebust80147932006-08-31 18:24:08 -0400627}
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629/*
630 * Run a task at a later time
631 */
Trond Myklebust80147932006-08-31 18:24:08 -0400632void rpc_delay(struct rpc_task *task, unsigned long delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 task->tk_timeout = delay;
Trond Myklebust5d008372008-02-22 16:34:17 -0500635 rpc_sleep_on(&delay_queue, task, __rpc_atrun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400637EXPORT_SYMBOL_GPL(rpc_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639/*
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100640 * Helper to call task->tk_ops->rpc_call_prepare
641 */
Andy Adamsonaae20062009-04-01 09:22:40 -0400642void rpc_prepare_task(struct rpc_task *task)
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100643{
644 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
645}
646
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500647static void
648rpc_init_task_statistics(struct rpc_task *task)
649{
650 /* Initialize retry counters */
651 task->tk_garb_retry = 2;
652 task->tk_cred_retry = 2;
653 task->tk_rebind_retry = 2;
654
655 /* starting timestamp */
656 task->tk_start = ktime_get();
657}
658
659static void
660rpc_reset_task_statistics(struct rpc_task *task)
661{
662 task->tk_timeouts = 0;
663 task->tk_flags &= ~(RPC_CALL_MAJORSEEN|RPC_TASK_KILLED|RPC_TASK_SENT);
664
665 rpc_init_task_statistics(task);
666}
667
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100668/*
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100669 * Helper that calls task->tk_ops->rpc_call_done if it exists
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000670 */
Trond Myklebustabbcf282006-01-03 09:55:03 +0100671void rpc_exit_task(struct rpc_task *task)
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000672{
Trond Myklebustabbcf282006-01-03 09:55:03 +0100673 task->tk_action = NULL;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100674 if (task->tk_ops->rpc_call_done != NULL) {
675 task->tk_ops->rpc_call_done(task, task->tk_calldata);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000676 if (task->tk_action != NULL) {
Trond Myklebustabbcf282006-01-03 09:55:03 +0100677 WARN_ON(RPC_ASSASSINATED(task));
678 /* Always release the RPC slot and buffer memory */
679 xprt_release(task);
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500680 rpc_reset_task_statistics(task);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000681 }
682 }
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000683}
Trond Myklebustd9b6cd92010-07-31 14:29:08 -0400684
685void rpc_exit(struct rpc_task *task, int status)
686{
687 task->tk_status = status;
688 task->tk_action = rpc_exit_task;
689 if (RPC_IS_QUEUED(task))
690 rpc_wake_up_queued_task(task->tk_waitqueue, task);
691}
692EXPORT_SYMBOL_GPL(rpc_exit);
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000693
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400694void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
695{
Trond Myklebusta86dc492008-06-11 13:37:09 -0400696 if (ops->rpc_release != NULL)
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400697 ops->rpc_release(calldata);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400698}
699
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000700/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 * This is the RPC `scheduler' (or rather, the finite state machine).
702 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800703static void __rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400705 struct rpc_wait_queue *queue;
706 int task_is_async = RPC_IS_ASYNC(task);
707 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Chuck Lever46121cf2007-01-31 12:14:08 -0500709 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
710 task->tk_pid, task->tk_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Weston Andros Adamson2bd4eef2012-10-23 10:43:47 -0400712 WARN_ON_ONCE(RPC_IS_QUEUED(task));
713 if (RPC_IS_QUEUED(task))
714 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Trond Myklebustd05fdb02005-06-22 17:16:19 +0000716 for (;;) {
Trond Myklebustb55c5982011-07-06 19:58:23 -0400717 void (*do_action)(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719 /*
Trond Myklebustb55c5982011-07-06 19:58:23 -0400720 * Execute any pending callback first.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400722 do_action = task->tk_callback;
723 task->tk_callback = NULL;
724 if (do_action == NULL) {
Trond Myklebuste020c682011-03-15 19:56:30 -0400725 /*
726 * Perform the next FSM step.
Trond Myklebustb55c5982011-07-06 19:58:23 -0400727 * tk_action may be NULL if the task has been killed.
728 * In particular, note that rpc_killall_tasks may
729 * do this at any time, so beware when dereferencing.
Trond Myklebuste020c682011-03-15 19:56:30 -0400730 */
Trond Myklebustb55c5982011-07-06 19:58:23 -0400731 do_action = task->tk_action;
732 if (do_action == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 }
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500735 trace_rpc_task_run_action(task->tk_client, task, task->tk_action);
Trond Myklebustb55c5982011-07-06 19:58:23 -0400736 do_action(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738 /*
739 * Lockless check for whether task is sleeping or not.
740 */
741 if (!RPC_IS_QUEUED(task))
742 continue;
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400743 /*
744 * The queue->lock protects against races with
745 * rpc_make_runnable().
746 *
747 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
748 * rpc_task, rpc_make_runnable() can assign it to a
749 * different workqueue. We therefore cannot assume that the
750 * rpc_task pointer may still be dereferenced.
751 */
752 queue = task->tk_waitqueue;
753 spin_lock_bh(&queue->lock);
754 if (!RPC_IS_QUEUED(task)) {
755 spin_unlock_bh(&queue->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 continue;
757 }
Trond Myklebusteb9b55a2009-03-10 20:33:16 -0400758 rpc_clear_running(task);
759 spin_unlock_bh(&queue->lock);
760 if (task_is_async)
761 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
763 /* sync task: sleep here */
Chuck Lever46121cf2007-01-31 12:14:08 -0500764 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000765 status = out_of_line_wait_on_bit(&task->tk_runstate,
Matthew Wilcox150030b2007-12-06 16:24:39 -0500766 RPC_TASK_QUEUED, rpc_wait_bit_killable,
767 TASK_KILLABLE);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000768 if (status == -ERESTARTSYS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 /*
770 * When a sync task receives a signal, it exits with
771 * -ERESTARTSYS. In order to catch any callbacks that
772 * clean up after sleeping on some queue, we don't
773 * break the loop here, but go around once more.
774 */
Chuck Lever46121cf2007-01-31 12:14:08 -0500775 dprintk("RPC: %5u got signal\n", task->tk_pid);
Trond Myklebust96651ab2005-06-22 17:16:21 +0000776 task->tk_flags |= RPC_TASK_KILLED;
777 rpc_exit(task, -ERESTARTSYS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 }
779 rpc_set_running(task);
Chuck Lever46121cf2007-01-31 12:14:08 -0500780 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 }
782
Chuck Lever46121cf2007-01-31 12:14:08 -0500783 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
784 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 /* Release all resources associated with the task */
786 rpc_release_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787}
788
789/*
790 * User-visible entry point to the scheduler.
791 *
792 * This may be called recursively if e.g. an async NFS task updates
793 * the attributes and finds that dirty pages must be flushed.
794 * NOTE: Upon exit of this function the task is guaranteed to be
795 * released. In particular note that tk_release() will have
796 * been called, so your task memory may have been freed.
797 */
Trond Myklebust2efef832007-02-03 13:38:41 -0800798void rpc_execute(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
Trond Myklebust44c28872006-01-03 09:55:06 +0100800 rpc_set_active(task);
Trond Myklebustd6a1ed02010-07-31 14:29:08 -0400801 rpc_make_runnable(task);
802 if (!RPC_IS_ASYNC(task))
803 __rpc_execute(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804}
805
David Howells65f27f32006-11-22 14:55:48 +0000806static void rpc_async_schedule(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807{
Jeff Layton5cf02d02012-07-23 13:58:51 -0400808 current->flags |= PF_FSTRANS;
David Howells65f27f32006-11-22 14:55:48 +0000809 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
Jeff Layton5cf02d02012-07-23 13:58:51 -0400810 current->flags &= ~PF_FSTRANS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811}
812
Chuck Lever02107142006-01-03 09:55:49 +0100813/**
814 * rpc_malloc - allocate an RPC buffer
815 * @task: RPC task that will use this buffer
816 * @size: requested byte size
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 *
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400818 * To prevent rpciod from hanging, this allocator never sleeps,
819 * returning NULL if the request cannot be serviced immediately.
820 * The caller can arrange to sleep in a way that is safe for rpciod.
821 *
822 * Most requests are 'small' (under 2KiB) and can be serviced from a
823 * mempool, ensuring that NFS reads and writes can always proceed,
824 * and that there is good locality of reference for these buffers.
825 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 * In order to avoid memory starvation triggering more writebacks of
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400827 * NFS requests, we avoid using GFP_KERNEL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400829void *rpc_malloc(struct rpc_task *task, size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400831 struct rpc_buffer *buf;
Mel Gormana564b8f2012-07-31 16:45:12 -0700832 gfp_t gfp = GFP_NOWAIT;
833
834 if (RPC_IS_SWAPPER(task))
835 gfp |= __GFP_MEMALLOC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400837 size += sizeof(struct rpc_buffer);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400838 if (size <= RPC_BUFFER_MAXSIZE)
839 buf = mempool_alloc(rpc_buffer_mempool, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 else
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400841 buf = kmalloc(size, gfp);
Peter Zijlstraddce40d2007-05-09 08:30:11 +0200842
843 if (!buf)
844 return NULL;
845
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400846 buf->len = size;
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200847 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400848 task->tk_pid, size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400849 return &buf->data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400851EXPORT_SYMBOL_GPL(rpc_malloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Chuck Lever02107142006-01-03 09:55:49 +0100853/**
854 * rpc_free - free buffer allocated via rpc_malloc
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400855 * @buffer: buffer to free
Chuck Lever02107142006-01-03 09:55:49 +0100856 *
857 */
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400858void rpc_free(void *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859{
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400860 size_t size;
861 struct rpc_buffer *buf;
Chuck Lever02107142006-01-03 09:55:49 +0100862
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400863 if (!buffer)
864 return;
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400865
866 buf = container_of(buffer, struct rpc_buffer, data);
867 size = buf->len;
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400868
Geert Uytterhoeven215d0672007-05-08 11:37:26 +0200869 dprintk("RPC: freeing buffer of size %zu at %p\n",
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400870 size, buf);
Chuck Leveraa3d1fa2007-05-08 18:23:28 -0400871
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400872 if (size <= RPC_BUFFER_MAXSIZE)
873 mempool_free(buf, rpc_buffer_mempool);
874 else
875 kfree(buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400877EXPORT_SYMBOL_GPL(rpc_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
879/*
880 * Creation and deletion of RPC task structures
881 */
Trond Myklebust47fe0642007-10-25 18:42:55 -0400882static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883{
884 memset(task, 0, sizeof(*task));
Trond Myklebust44c28872006-01-03 09:55:06 +0100885 atomic_set(&task->tk_count, 1);
Trond Myklebust84115e12007-07-14 15:39:59 -0400886 task->tk_flags = task_setup_data->flags;
887 task->tk_ops = task_setup_data->callback_ops;
888 task->tk_calldata = task_setup_data->callback_data;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400889 INIT_LIST_HEAD(&task->tk_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Trond Myklebust3ff75762007-07-14 15:40:00 -0400891 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
892 task->tk_owner = current->tgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
894 /* Initialize workqueue for async tasks */
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500895 task->tk_workqueue = task_setup_data->workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
Trond Myklebust84115e12007-07-14 15:39:59 -0400897 if (task->tk_ops->rpc_call_prepare != NULL)
898 task->tk_action = rpc_prepare_task;
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100899
Trond Myklebust7fdcf132011-12-01 14:00:15 -0500900 rpc_init_task_statistics(task);
Chuck Leveref759a22006-03-20 13:44:17 -0500901
Chuck Lever46121cf2007-01-31 12:14:08 -0500902 dprintk("RPC: new task initialized, procpid %u\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -0700903 task_pid_nr(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904}
905
906static struct rpc_task *
907rpc_alloc_task(void)
908{
Mel Gormana564b8f2012-07-31 16:45:12 -0700909 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910}
911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912/*
Trond Myklebust90c57552007-06-09 19:49:36 -0400913 * Create a new task for the specified client.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400915struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916{
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400917 struct rpc_task *task = setup_data->task;
918 unsigned short flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400920 if (task == NULL) {
921 task = rpc_alloc_task();
Trond Myklebust19445b92010-04-16 16:41:10 -0400922 if (task == NULL) {
923 rpc_release_calldata(setup_data->callback_ops,
924 setup_data->callback_data);
925 return ERR_PTR(-ENOMEM);
926 }
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400927 flags = RPC_TASK_DYNAMIC;
928 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
Trond Myklebust84115e12007-07-14 15:39:59 -0400930 rpc_init_task(task, setup_data);
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400931 task->tk_flags |= flags;
Chuck Lever46121cf2007-01-31 12:14:08 -0500932 dprintk("RPC: allocated task %p\n", task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 return task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934}
935
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500936static void rpc_free_task(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937{
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100938 const struct rpc_call_ops *tk_ops = task->tk_ops;
939 void *calldata = task->tk_calldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Trond Myklebust5e4424a2008-02-25 21:53:49 -0800941 if (task->tk_flags & RPC_TASK_DYNAMIC) {
942 dprintk("RPC: %5u freeing task\n", task->tk_pid);
943 mempool_free(task, rpc_task_mempool);
944 }
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500945 rpc_release_calldata(tk_ops, calldata);
946}
947
948static void rpc_async_release(struct work_struct *work)
949{
950 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
951}
952
Trond Myklebustbf294b42011-02-21 11:05:41 -0800953static void rpc_release_resources_task(struct rpc_task *task)
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500954{
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500955 if (task->tk_rqstp)
956 xprt_release(task);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200957 if (task->tk_msg.rpc_cred) {
Trond Myklebusta17c2152010-07-31 14:29:08 -0400958 put_rpccred(task->tk_msg.rpc_cred);
OGAWA Hirofumia271c5a2011-03-27 17:48:57 +0200959 task->tk_msg.rpc_cred = NULL;
960 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400961 rpc_task_release_client(task);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800962}
963
964static void rpc_final_put_task(struct rpc_task *task,
965 struct workqueue_struct *q)
966{
967 if (q != NULL) {
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500968 INIT_WORK(&task->u.tk_work, rpc_async_release);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800969 queue_work(q, &task->u.tk_work);
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500970 } else
971 rpc_free_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500972}
Trond Myklebustbf294b42011-02-21 11:05:41 -0800973
974static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
975{
976 if (atomic_dec_and_test(&task->tk_count)) {
977 rpc_release_resources_task(task);
978 rpc_final_put_task(task, q);
979 }
980}
981
982void rpc_put_task(struct rpc_task *task)
983{
984 rpc_do_put_task(task, NULL);
985}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400986EXPORT_SYMBOL_GPL(rpc_put_task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500987
Trond Myklebustbf294b42011-02-21 11:05:41 -0800988void rpc_put_task_async(struct rpc_task *task)
989{
990 rpc_do_put_task(task, task->tk_workqueue);
991}
992EXPORT_SYMBOL_GPL(rpc_put_task_async);
993
Trond Myklebustbde8f002007-01-24 11:54:53 -0800994static void rpc_release_task(struct rpc_task *task)
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500995{
Chuck Lever46121cf2007-01-31 12:14:08 -0500996 dprintk("RPC: %5u release task\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 BUG_ON (RPC_IS_QUEUED(task));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Trond Myklebustbf294b42011-02-21 11:05:41 -08001000 rpc_release_resources_task(task);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -05001001
Trond Myklebustbf294b42011-02-21 11:05:41 -08001002 /*
1003 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
1004 * so it should be safe to use task->tk_count as a test for whether
1005 * or not any other processes still hold references to our rpc_task.
1006 */
1007 if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
1008 /* Wake up anyone who may be waiting for task completion */
1009 if (!rpc_complete_task(task))
1010 return;
1011 } else {
1012 if (!atomic_dec_and_test(&task->tk_count))
1013 return;
1014 }
1015 rpc_final_put_task(task, task->tk_workqueue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016}
1017
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001018int rpciod_up(void)
1019{
1020 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
1021}
1022
1023void rpciod_down(void)
1024{
1025 module_put(THIS_MODULE);
1026}
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028/*
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001029 * Start up the rpciod workqueue.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 */
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001031static int rpciod_start(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032{
1033 struct workqueue_struct *wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 /*
1036 * Create the rpciod thread and wait for it to start.
1037 */
Trond Myklebustab418d72007-06-14 17:08:36 -04001038 dprintk("RPC: creating workqueue rpciod\n");
Trond Myklebust9b96ce72012-09-28 20:24:16 -04001039 wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 rpciod_workqueue = wq;
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001041 return rpciod_workqueue != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042}
1043
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001044static void rpciod_stop(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001046 struct workqueue_struct *wq = NULL;
Trond Myklebustab418d72007-06-14 17:08:36 -04001047
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001048 if (rpciod_workqueue == NULL)
1049 return;
Trond Myklebustab418d72007-06-14 17:08:36 -04001050 dprintk("RPC: destroying workqueue rpciod\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001052 wq = rpciod_workqueue;
1053 rpciod_workqueue = NULL;
1054 destroy_workqueue(wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055}
1056
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057void
1058rpc_destroy_mempool(void)
1059{
Trond Myklebustb247bbf2007-07-19 16:32:20 -04001060 rpciod_stop();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 if (rpc_buffer_mempool)
1062 mempool_destroy(rpc_buffer_mempool);
1063 if (rpc_task_mempool)
1064 mempool_destroy(rpc_task_mempool);
Alexey Dobriyan1a1d92c2006-09-27 01:49:40 -07001065 if (rpc_task_slabp)
1066 kmem_cache_destroy(rpc_task_slabp);
1067 if (rpc_buffer_slabp)
1068 kmem_cache_destroy(rpc_buffer_slabp);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001069 rpc_destroy_wait_queue(&delay_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070}
1071
1072int
1073rpc_init_mempool(void)
1074{
Trond Myklebustf6a1cc82008-02-22 17:06:55 -05001075 /*
1076 * The following is not strictly a mempool initialisation,
1077 * but there is no harm in doing it here
1078 */
1079 rpc_init_wait_queue(&delay_queue, "delayq");
1080 if (!rpciod_start())
1081 goto err_nomem;
1082
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1084 sizeof(struct rpc_task),
1085 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001086 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 if (!rpc_task_slabp)
1088 goto err_nomem;
1089 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1090 RPC_BUFFER_MAXSIZE,
1091 0, SLAB_HWCACHE_ALIGN,
Paul Mundt20c2df82007-07-20 10:11:58 +09001092 NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 if (!rpc_buffer_slabp)
1094 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001095 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1096 rpc_task_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 if (!rpc_task_mempool)
1098 goto err_nomem;
Matthew Dobson93d23412006-03-26 01:37:50 -08001099 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1100 rpc_buffer_slabp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 if (!rpc_buffer_mempool)
1102 goto err_nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 return 0;
1104err_nomem:
1105 rpc_destroy_mempool();
1106 return -ENOMEM;
1107}