]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - net/sunrpc/sched.c
SUNRPC: Move exported declarations to the function declarations
[mirror_ubuntu-focal-kernel.git] / net / sunrpc / sched.c
CommitLineData
1da177e4
LT
1/*
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>
cca5172a 7 *
1da177e4
LT
8 * 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>
19#include <linux/smp_lock.h>
20#include <linux/spinlock.h>
4a3e2f71 21#include <linux/mutex.h>
1da177e4
LT
22
23#include <linux/sunrpc/clnt.h>
1da177e4
LT
24
25#ifdef RPC_DEBUG
26#define RPCDBG_FACILITY RPCDBG_SCHED
27#define RPC_TASK_MAGIC_ID 0xf00baa
1da177e4
LT
28#endif
29
30/*
31 * RPC slabs and memory pools
32 */
33#define RPC_BUFFER_MAXSIZE (2048)
34#define RPC_BUFFER_POOLSIZE (8)
35#define RPC_TASK_POOLSIZE (8)
e18b890b
CL
36static struct kmem_cache *rpc_task_slabp __read_mostly;
37static struct kmem_cache *rpc_buffer_slabp __read_mostly;
ba89966c
ED
38static mempool_t *rpc_task_mempool __read_mostly;
39static mempool_t *rpc_buffer_mempool __read_mostly;
1da177e4
LT
40
41static void __rpc_default_timer(struct rpc_task *task);
65f27f38 42static void rpc_async_schedule(struct work_struct *);
bde8f00c 43static void rpc_release_task(struct rpc_task *task);
1da177e4 44
1da177e4
LT
45/*
46 * RPC tasks sit here while waiting for conditions to improve.
47 */
48static RPC_WAITQ(delay_queue, "delayq");
49
1da177e4
LT
50/*
51 * rpciod-related stuff
52 */
24c5d9d7 53struct workqueue_struct *rpciod_workqueue;
1da177e4 54
1da177e4
LT
55/*
56 * Disable the timer for a given RPC task. Should be called with
57 * queue->lock and bh_disabled in order to avoid races within
58 * rpc_run_timer().
59 */
60static inline void
61__rpc_disable_timer(struct rpc_task *task)
62{
46121cf7 63 dprintk("RPC: %5u disabling timer\n", task->tk_pid);
1da177e4
LT
64 task->tk_timeout_fn = NULL;
65 task->tk_timeout = 0;
66}
67
68/*
69 * Run a timeout function.
70 * We use the callback in order to allow __rpc_wake_up_task()
71 * and friends to disable the timer synchronously on SMP systems
72 * without calling del_timer_sync(). The latter could cause a
73 * deadlock if called while we're holding spinlocks...
74 */
75static void rpc_run_timer(struct rpc_task *task)
76{
77 void (*callback)(struct rpc_task *);
78
79 callback = task->tk_timeout_fn;
80 task->tk_timeout_fn = NULL;
81 if (callback && RPC_IS_QUEUED(task)) {
46121cf7 82 dprintk("RPC: %5u running timer\n", task->tk_pid);
1da177e4
LT
83 callback(task);
84 }
85 smp_mb__before_clear_bit();
86 clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
87 smp_mb__after_clear_bit();
88}
89
90/*
91 * Set up a timer for the current task.
92 */
93static inline void
94__rpc_add_timer(struct rpc_task *task, rpc_action timer)
95{
96 if (!task->tk_timeout)
97 return;
98
46121cf7 99 dprintk("RPC: %5u setting alarm for %lu ms\n",
1da177e4
LT
100 task->tk_pid, task->tk_timeout * 1000 / HZ);
101
102 if (timer)
103 task->tk_timeout_fn = timer;
104 else
105 task->tk_timeout_fn = __rpc_default_timer;
106 set_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate);
107 mod_timer(&task->tk_timer, jiffies + task->tk_timeout);
108}
109
110/*
111 * Delete any timer for the current task. Because we use del_timer_sync(),
112 * this function should never be called while holding queue->lock.
113 */
114static void
115rpc_delete_timer(struct rpc_task *task)
116{
117 if (RPC_IS_QUEUED(task))
118 return;
119 if (test_and_clear_bit(RPC_TASK_HAS_TIMER, &task->tk_runstate)) {
120 del_singleshot_timer_sync(&task->tk_timer);
46121cf7 121 dprintk("RPC: %5u deleting timer\n", task->tk_pid);
1da177e4
LT
122 }
123}
124
125/*
126 * Add new request to a priority queue.
127 */
128static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue, struct rpc_task *task)
129{
130 struct list_head *q;
131 struct rpc_task *t;
132
133 INIT_LIST_HEAD(&task->u.tk_wait.links);
134 q = &queue->tasks[task->tk_priority];
135 if (unlikely(task->tk_priority > queue->maxpriority))
136 q = &queue->tasks[queue->maxpriority];
137 list_for_each_entry(t, q, u.tk_wait.list) {
138 if (t->tk_cookie == task->tk_cookie) {
139 list_add_tail(&task->u.tk_wait.list, &t->u.tk_wait.links);
140 return;
141 }
142 }
143 list_add_tail(&task->u.tk_wait.list, q);
144}
145
146/*
147 * Add new request to wait queue.
148 *
149 * Swapper tasks always get inserted at the head of the queue.
150 * This should avoid many nasty memory deadlocks and hopefully
151 * improve overall performance.
152 * Everyone else gets appended to the queue to ensure proper FIFO behavior.
153 */
154static void __rpc_add_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
155{
156 BUG_ON (RPC_IS_QUEUED(task));
157
158 if (RPC_IS_PRIORITY(queue))
159 __rpc_add_wait_queue_priority(queue, task);
160 else if (RPC_IS_SWAPPER(task))
161 list_add(&task->u.tk_wait.list, &queue->tasks[0]);
162 else
163 list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
164 task->u.tk_wait.rpc_waitq = queue;
e19b63da 165 queue->qlen++;
1da177e4
LT
166 rpc_set_queued(task);
167
46121cf7
CL
168 dprintk("RPC: %5u added to queue %p \"%s\"\n",
169 task->tk_pid, queue, rpc_qname(queue));
1da177e4
LT
170}
171
172/*
173 * Remove request from a priority queue.
174 */
175static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
176{
177 struct rpc_task *t;
178
179 if (!list_empty(&task->u.tk_wait.links)) {
180 t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
181 list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
182 list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
183 }
184 list_del(&task->u.tk_wait.list);
185}
186
187/*
188 * Remove request from queue.
189 * Note: must be called with spin lock held.
190 */
191static void __rpc_remove_wait_queue(struct rpc_task *task)
192{
193 struct rpc_wait_queue *queue;
194 queue = task->u.tk_wait.rpc_waitq;
195
196 if (RPC_IS_PRIORITY(queue))
197 __rpc_remove_wait_queue_priority(task);
198 else
199 list_del(&task->u.tk_wait.list);
e19b63da 200 queue->qlen--;
46121cf7
CL
201 dprintk("RPC: %5u removed from queue %p \"%s\"\n",
202 task->tk_pid, queue, rpc_qname(queue));
1da177e4
LT
203}
204
205static inline void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
206{
207 queue->priority = priority;
208 queue->count = 1 << (priority * 2);
209}
210
211static inline void rpc_set_waitqueue_cookie(struct rpc_wait_queue *queue, unsigned long cookie)
212{
213 queue->cookie = cookie;
214 queue->nr = RPC_BATCH_COUNT;
215}
216
217static inline void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
218{
219 rpc_set_waitqueue_priority(queue, queue->maxpriority);
220 rpc_set_waitqueue_cookie(queue, 0);
221}
222
223static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, int maxprio)
224{
225 int i;
226
227 spin_lock_init(&queue->lock);
228 for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
229 INIT_LIST_HEAD(&queue->tasks[i]);
230 queue->maxpriority = maxprio;
231 rpc_reset_waitqueue_priority(queue);
232#ifdef RPC_DEBUG
233 queue->name = qname;
234#endif
235}
236
237void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
238{
239 __rpc_init_priority_wait_queue(queue, qname, RPC_PRIORITY_HIGH);
240}
241
242void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
243{
244 __rpc_init_priority_wait_queue(queue, qname, 0);
245}
246EXPORT_SYMBOL(rpc_init_wait_queue);
247
44c28873
TM
248static int rpc_wait_bit_interruptible(void *word)
249{
250 if (signal_pending(current))
251 return -ERESTARTSYS;
252 schedule();
253 return 0;
254}
255
c44fe705
TM
256#ifdef RPC_DEBUG
257static void rpc_task_set_debuginfo(struct rpc_task *task)
258{
259 static atomic_t rpc_pid;
260
261 task->tk_magic = RPC_TASK_MAGIC_ID;
262 task->tk_pid = atomic_inc_return(&rpc_pid);
263}
264#else
265static inline void rpc_task_set_debuginfo(struct rpc_task *task)
266{
267}
268#endif
269
e6b3c4db
TM
270static void rpc_set_active(struct rpc_task *task)
271{
4bef61ff 272 struct rpc_clnt *clnt;
e6b3c4db
TM
273 if (test_and_set_bit(RPC_TASK_ACTIVE, &task->tk_runstate) != 0)
274 return;
c44fe705 275 rpc_task_set_debuginfo(task);
e6b3c4db 276 /* Add to global list of all tasks */
4bef61ff
TM
277 clnt = task->tk_client;
278 if (clnt != NULL) {
279 spin_lock(&clnt->cl_lock);
280 list_add_tail(&task->tk_task, &clnt->cl_tasks);
281 spin_unlock(&clnt->cl_lock);
282 }
e6b3c4db
TM
283}
284
44c28873
TM
285/*
286 * Mark an RPC call as having completed by clearing the 'active' bit
287 */
e6b3c4db 288static void rpc_mark_complete_task(struct rpc_task *task)
44c28873 289{
e6b3c4db
TM
290 smp_mb__before_clear_bit();
291 clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
292 smp_mb__after_clear_bit();
44c28873
TM
293 wake_up_bit(&task->tk_runstate, RPC_TASK_ACTIVE);
294}
295
296/*
297 * Allow callers to wait for completion of an RPC call
298 */
299int __rpc_wait_for_completion_task(struct rpc_task *task, int (*action)(void *))
300{
301 if (action == NULL)
302 action = rpc_wait_bit_interruptible;
303 return wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
304 action, TASK_INTERRUPTIBLE);
305}
306EXPORT_SYMBOL(__rpc_wait_for_completion_task);
307
1da177e4
LT
308/*
309 * Make an RPC task runnable.
310 *
cca5172a 311 * Note: If the task is ASYNC, this must be called with
1da177e4
LT
312 * the spinlock held to protect the wait queue operation.
313 */
314static void rpc_make_runnable(struct rpc_task *task)
315{
1da177e4 316 BUG_ON(task->tk_timeout_fn);
1da177e4 317 rpc_clear_queued(task);
cc4dc59e
CS
318 if (rpc_test_and_set_running(task))
319 return;
320 /* We might have raced */
321 if (RPC_IS_QUEUED(task)) {
322 rpc_clear_running(task);
1da177e4 323 return;
cc4dc59e 324 }
1da177e4
LT
325 if (RPC_IS_ASYNC(task)) {
326 int status;
327
65f27f38 328 INIT_WORK(&task->u.tk_work, rpc_async_schedule);
1da177e4
LT
329 status = queue_work(task->tk_workqueue, &task->u.tk_work);
330 if (status < 0) {
331 printk(KERN_WARNING "RPC: failed to add task to queue: error: %d!\n", status);
332 task->tk_status = status;
333 return;
334 }
335 } else
96651ab3 336 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
1da177e4
LT
337}
338
1da177e4
LT
339/*
340 * Prepare for sleeping on a wait queue.
341 * By always appending tasks to the list we ensure FIFO behavior.
342 * NB: An RPC task will only receive interrupt-driven events as long
343 * as it's on a wait queue.
344 */
345static void __rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
346 rpc_action action, rpc_action timer)
347{
46121cf7
CL
348 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
349 task->tk_pid, rpc_qname(q), jiffies);
1da177e4
LT
350
351 if (!RPC_IS_ASYNC(task) && !RPC_IS_ACTIVATED(task)) {
352 printk(KERN_ERR "RPC: Inactive synchronous task put to sleep!\n");
353 return;
354 }
355
1da177e4
LT
356 __rpc_add_wait_queue(q, task);
357
358 BUG_ON(task->tk_callback != NULL);
359 task->tk_callback = action;
360 __rpc_add_timer(task, timer);
361}
362
363void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
364 rpc_action action, rpc_action timer)
365{
e6b3c4db
TM
366 /* Mark the task as being activated if so needed */
367 rpc_set_active(task);
368
1da177e4
LT
369 /*
370 * Protect the queue operations.
371 */
372 spin_lock_bh(&q->lock);
373 __rpc_sleep_on(q, task, action, timer);
374 spin_unlock_bh(&q->lock);
375}
a6eaf8bd 376EXPORT_SYMBOL(rpc_sleep_on);
1da177e4
LT
377
378/**
379 * __rpc_do_wake_up_task - wake up a single rpc_task
380 * @task: task to be woken up
381 *
382 * Caller must hold queue->lock, and have cleared the task queued flag.
383 */
384static void __rpc_do_wake_up_task(struct rpc_task *task)
385{
46121cf7
CL
386 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
387 task->tk_pid, jiffies);
1da177e4
LT
388
389#ifdef RPC_DEBUG
390 BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
391#endif
392 /* Has the task been executed yet? If not, we cannot wake it up! */
393 if (!RPC_IS_ACTIVATED(task)) {
394 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
395 return;
396 }
397
398 __rpc_disable_timer(task);
399 __rpc_remove_wait_queue(task);
400
401 rpc_make_runnable(task);
402
46121cf7 403 dprintk("RPC: __rpc_wake_up_task done\n");
1da177e4
LT
404}
405
406/*
407 * Wake up the specified task
408 */
409static void __rpc_wake_up_task(struct rpc_task *task)
410{
411 if (rpc_start_wakeup(task)) {
412 if (RPC_IS_QUEUED(task))
413 __rpc_do_wake_up_task(task);
414 rpc_finish_wakeup(task);
415 }
416}
417
418/*
419 * Default timeout handler if none specified by user
420 */
421static void
422__rpc_default_timer(struct rpc_task *task)
423{
46121cf7 424 dprintk("RPC: %5u timeout (default timer)\n", task->tk_pid);
1da177e4
LT
425 task->tk_status = -ETIMEDOUT;
426 rpc_wake_up_task(task);
427}
428
429/*
430 * Wake up the specified task
431 */
432void rpc_wake_up_task(struct rpc_task *task)
433{
8aca67f0 434 rcu_read_lock_bh();
1da177e4
LT
435 if (rpc_start_wakeup(task)) {
436 if (RPC_IS_QUEUED(task)) {
437 struct rpc_wait_queue *queue = task->u.tk_wait.rpc_waitq;
438
8aca67f0
TM
439 /* Note: we're already in a bh-safe context */
440 spin_lock(&queue->lock);
1da177e4 441 __rpc_do_wake_up_task(task);
8aca67f0 442 spin_unlock(&queue->lock);
1da177e4
LT
443 }
444 rpc_finish_wakeup(task);
445 }
8aca67f0 446 rcu_read_unlock_bh();
1da177e4 447}
a6eaf8bd 448EXPORT_SYMBOL(rpc_wake_up_task);
1da177e4
LT
449
450/*
451 * Wake up the next task on a priority queue.
452 */
453static struct rpc_task * __rpc_wake_up_next_priority(struct rpc_wait_queue *queue)
454{
455 struct list_head *q;
456 struct rpc_task *task;
457
458 /*
459 * Service a batch of tasks from a single cookie.
460 */
461 q = &queue->tasks[queue->priority];
462 if (!list_empty(q)) {
463 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
464 if (queue->cookie == task->tk_cookie) {
465 if (--queue->nr)
466 goto out;
467 list_move_tail(&task->u.tk_wait.list, q);
468 }
469 /*
470 * Check if we need to switch queues.
471 */
472 if (--queue->count)
473 goto new_cookie;
474 }
475
476 /*
477 * Service the next queue.
478 */
479 do {
480 if (q == &queue->tasks[0])
481 q = &queue->tasks[queue->maxpriority];
482 else
483 q = q - 1;
484 if (!list_empty(q)) {
485 task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
486 goto new_queue;
487 }
488 } while (q != &queue->tasks[queue->priority]);
489
490 rpc_reset_waitqueue_priority(queue);
491 return NULL;
492
493new_queue:
494 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
495new_cookie:
496 rpc_set_waitqueue_cookie(queue, task->tk_cookie);
497out:
498 __rpc_wake_up_task(task);
499 return task;
500}
501
502/*
503 * Wake up the next task on the wait queue.
504 */
505struct rpc_task * rpc_wake_up_next(struct rpc_wait_queue *queue)
506{
507 struct rpc_task *task = NULL;
508
46121cf7
CL
509 dprintk("RPC: wake_up_next(%p \"%s\")\n",
510 queue, rpc_qname(queue));
8aca67f0
TM
511 rcu_read_lock_bh();
512 spin_lock(&queue->lock);
1da177e4
LT
513 if (RPC_IS_PRIORITY(queue))
514 task = __rpc_wake_up_next_priority(queue);
515 else {
516 task_for_first(task, &queue->tasks[0])
517 __rpc_wake_up_task(task);
518 }
8aca67f0
TM
519 spin_unlock(&queue->lock);
520 rcu_read_unlock_bh();
1da177e4
LT
521
522 return task;
523}
a6eaf8bd 524EXPORT_SYMBOL(rpc_wake_up_next);
1da177e4
LT
525
526/**
527 * rpc_wake_up - wake up all rpc_tasks
528 * @queue: rpc_wait_queue on which the tasks are sleeping
529 *
530 * Grabs queue->lock
531 */
532void rpc_wake_up(struct rpc_wait_queue *queue)
533{
e6d83d55 534 struct rpc_task *task, *next;
1da177e4 535 struct list_head *head;
e6d83d55 536
8aca67f0
TM
537 rcu_read_lock_bh();
538 spin_lock(&queue->lock);
1da177e4
LT
539 head = &queue->tasks[queue->maxpriority];
540 for (;;) {
e6d83d55 541 list_for_each_entry_safe(task, next, head, u.tk_wait.list)
1da177e4 542 __rpc_wake_up_task(task);
1da177e4
LT
543 if (head == &queue->tasks[0])
544 break;
545 head--;
546 }
8aca67f0
TM
547 spin_unlock(&queue->lock);
548 rcu_read_unlock_bh();
1da177e4 549}
a6eaf8bd 550EXPORT_SYMBOL(rpc_wake_up);
1da177e4
LT
551
552/**
553 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
554 * @queue: rpc_wait_queue on which the tasks are sleeping
555 * @status: status value to set
556 *
557 * Grabs queue->lock
558 */
559void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
560{
e6d83d55 561 struct rpc_task *task, *next;
1da177e4 562 struct list_head *head;
1da177e4 563
8aca67f0
TM
564 rcu_read_lock_bh();
565 spin_lock(&queue->lock);
1da177e4
LT
566 head = &queue->tasks[queue->maxpriority];
567 for (;;) {
e6d83d55 568 list_for_each_entry_safe(task, next, head, u.tk_wait.list) {
1da177e4
LT
569 task->tk_status = status;
570 __rpc_wake_up_task(task);
571 }
572 if (head == &queue->tasks[0])
573 break;
574 head--;
575 }
8aca67f0
TM
576 spin_unlock(&queue->lock);
577 rcu_read_unlock_bh();
1da177e4 578}
a6eaf8bd 579EXPORT_SYMBOL(rpc_wake_up_status);
1da177e4 580
8014793b
TM
581static void __rpc_atrun(struct rpc_task *task)
582{
583 rpc_wake_up_task(task);
584}
585
1da177e4
LT
586/*
587 * Run a task at a later time
588 */
8014793b 589void rpc_delay(struct rpc_task *task, unsigned long delay)
1da177e4
LT
590{
591 task->tk_timeout = delay;
592 rpc_sleep_on(&delay_queue, task, NULL, __rpc_atrun);
593}
a6eaf8bd 594EXPORT_SYMBOL(rpc_delay);
1da177e4 595
4ce70ada
TM
596/*
597 * Helper to call task->tk_ops->rpc_call_prepare
598 */
599static void rpc_prepare_task(struct rpc_task *task)
600{
6d5fcb5a 601 lock_kernel();
4ce70ada 602 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
6d5fcb5a 603 unlock_kernel();
4ce70ada
TM
604}
605
d05fdb0c 606/*
963d8fe5 607 * Helper that calls task->tk_ops->rpc_call_done if it exists
d05fdb0c 608 */
abbcf28f 609void rpc_exit_task(struct rpc_task *task)
d05fdb0c 610{
abbcf28f 611 task->tk_action = NULL;
963d8fe5 612 if (task->tk_ops->rpc_call_done != NULL) {
6d5fcb5a 613 lock_kernel();
963d8fe5 614 task->tk_ops->rpc_call_done(task, task->tk_calldata);
6d5fcb5a 615 unlock_kernel();
d05fdb0c 616 if (task->tk_action != NULL) {
abbcf28f
TM
617 WARN_ON(RPC_ASSASSINATED(task));
618 /* Always release the RPC slot and buffer memory */
619 xprt_release(task);
d05fdb0c
TM
620 }
621 }
d05fdb0c 622}
abbcf28f 623EXPORT_SYMBOL(rpc_exit_task);
d05fdb0c 624
bbd5a1f9
TM
625void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
626{
627 if (ops->rpc_release != NULL) {
628 lock_kernel();
629 ops->rpc_release(calldata);
630 unlock_kernel();
631 }
632}
633
1da177e4
LT
634/*
635 * This is the RPC `scheduler' (or rather, the finite state machine).
636 */
2efef837 637static void __rpc_execute(struct rpc_task *task)
1da177e4
LT
638{
639 int status = 0;
640
46121cf7
CL
641 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
642 task->tk_pid, task->tk_flags);
1da177e4
LT
643
644 BUG_ON(RPC_IS_QUEUED(task));
645
d05fdb0c 646 for (;;) {
1da177e4
LT
647 /*
648 * Garbage collection of pending timers...
649 */
650 rpc_delete_timer(task);
651
652 /*
653 * Execute any pending callback.
654 */
655 if (RPC_DO_CALLBACK(task)) {
656 /* Define a callback save pointer */
657 void (*save_callback)(struct rpc_task *);
cca5172a
YH
658
659 /*
1da177e4
LT
660 * If a callback exists, save it, reset it,
661 * call it.
662 * The save is needed to stop from resetting
663 * another callback set within the callback handler
664 * - Dave
665 */
666 save_callback=task->tk_callback;
667 task->tk_callback=NULL;
1da177e4 668 save_callback(task);
1da177e4
LT
669 }
670
671 /*
672 * Perform the next FSM step.
673 * tk_action may be NULL when the task has been killed
674 * by someone else.
675 */
676 if (!RPC_IS_QUEUED(task)) {
abbcf28f 677 if (task->tk_action == NULL)
1da177e4 678 break;
abbcf28f 679 task->tk_action(task);
1da177e4
LT
680 }
681
682 /*
683 * Lockless check for whether task is sleeping or not.
684 */
685 if (!RPC_IS_QUEUED(task))
686 continue;
687 rpc_clear_running(task);
688 if (RPC_IS_ASYNC(task)) {
689 /* Careful! we may have raced... */
690 if (RPC_IS_QUEUED(task))
2efef837 691 return;
1da177e4 692 if (rpc_test_and_set_running(task))
2efef837 693 return;
1da177e4
LT
694 continue;
695 }
696
697 /* sync task: sleep here */
46121cf7 698 dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
96651ab3
TM
699 /* Note: Caller should be using rpc_clnt_sigmask() */
700 status = out_of_line_wait_on_bit(&task->tk_runstate,
701 RPC_TASK_QUEUED, rpc_wait_bit_interruptible,
702 TASK_INTERRUPTIBLE);
703 if (status == -ERESTARTSYS) {
1da177e4
LT
704 /*
705 * When a sync task receives a signal, it exits with
706 * -ERESTARTSYS. In order to catch any callbacks that
707 * clean up after sleeping on some queue, we don't
708 * break the loop here, but go around once more.
709 */
46121cf7 710 dprintk("RPC: %5u got signal\n", task->tk_pid);
96651ab3
TM
711 task->tk_flags |= RPC_TASK_KILLED;
712 rpc_exit(task, -ERESTARTSYS);
713 rpc_wake_up_task(task);
1da177e4
LT
714 }
715 rpc_set_running(task);
46121cf7 716 dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
1da177e4
LT
717 }
718
46121cf7
CL
719 dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
720 task->tk_status);
1da177e4
LT
721 /* Release all resources associated with the task */
722 rpc_release_task(task);
1da177e4
LT
723}
724
725/*
726 * User-visible entry point to the scheduler.
727 *
728 * This may be called recursively if e.g. an async NFS task updates
729 * the attributes and finds that dirty pages must be flushed.
730 * NOTE: Upon exit of this function the task is guaranteed to be
731 * released. In particular note that tk_release() will have
732 * been called, so your task memory may have been freed.
733 */
2efef837 734void rpc_execute(struct rpc_task *task)
1da177e4 735{
44c28873 736 rpc_set_active(task);
1da177e4 737 rpc_set_running(task);
2efef837 738 __rpc_execute(task);
1da177e4 739}
a6eaf8bd 740EXPORT_SYMBOL(rpc_execute);
1da177e4 741
65f27f38 742static void rpc_async_schedule(struct work_struct *work)
1da177e4 743{
65f27f38 744 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
1da177e4
LT
745}
746
aa3d1fae
CL
747struct rpc_buffer {
748 size_t len;
749 char data[];
750};
751
02107148
CL
752/**
753 * rpc_malloc - allocate an RPC buffer
754 * @task: RPC task that will use this buffer
755 * @size: requested byte size
1da177e4 756 *
c5a4dd8b
CL
757 * To prevent rpciod from hanging, this allocator never sleeps,
758 * returning NULL if the request cannot be serviced immediately.
759 * The caller can arrange to sleep in a way that is safe for rpciod.
760 *
761 * Most requests are 'small' (under 2KiB) and can be serviced from a
762 * mempool, ensuring that NFS reads and writes can always proceed,
763 * and that there is good locality of reference for these buffers.
764 *
1da177e4 765 * In order to avoid memory starvation triggering more writebacks of
c5a4dd8b 766 * NFS requests, we avoid using GFP_KERNEL.
1da177e4 767 */
c5a4dd8b 768void *rpc_malloc(struct rpc_task *task, size_t size)
1da177e4 769{
aa3d1fae 770 struct rpc_buffer *buf;
c5a4dd8b 771 gfp_t gfp = RPC_IS_SWAPPER(task) ? GFP_ATOMIC : GFP_NOWAIT;
1da177e4 772
aa3d1fae 773 size += sizeof(struct rpc_buffer);
c5a4dd8b
CL
774 if (size <= RPC_BUFFER_MAXSIZE)
775 buf = mempool_alloc(rpc_buffer_mempool, gfp);
1da177e4 776 else
c5a4dd8b 777 buf = kmalloc(size, gfp);
ddce40df
PZ
778
779 if (!buf)
780 return NULL;
781
aa3d1fae 782 buf->len = size;
215d0678 783 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
c5a4dd8b 784 task->tk_pid, size, buf);
aa3d1fae 785 return &buf->data;
1da177e4 786}
12444809 787EXPORT_SYMBOL_GPL(rpc_malloc);
1da177e4 788
02107148
CL
789/**
790 * rpc_free - free buffer allocated via rpc_malloc
c5a4dd8b 791 * @buffer: buffer to free
02107148
CL
792 *
793 */
c5a4dd8b 794void rpc_free(void *buffer)
1da177e4 795{
aa3d1fae
CL
796 size_t size;
797 struct rpc_buffer *buf;
02107148 798
c5a4dd8b
CL
799 if (!buffer)
800 return;
aa3d1fae
CL
801
802 buf = container_of(buffer, struct rpc_buffer, data);
803 size = buf->len;
c5a4dd8b 804
215d0678 805 dprintk("RPC: freeing buffer of size %zu at %p\n",
c5a4dd8b 806 size, buf);
aa3d1fae 807
c5a4dd8b
CL
808 if (size <= RPC_BUFFER_MAXSIZE)
809 mempool_free(buf, rpc_buffer_mempool);
810 else
811 kfree(buf);
1da177e4 812}
12444809 813EXPORT_SYMBOL_GPL(rpc_free);
1da177e4
LT
814
815/*
816 * Creation and deletion of RPC task structures
817 */
963d8fe5 818void rpc_init_task(struct rpc_task *task, struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
1da177e4
LT
819{
820 memset(task, 0, sizeof(*task));
b24b8a24
PE
821 setup_timer(&task->tk_timer, (void (*)(unsigned long))rpc_run_timer,
822 (unsigned long)task);
44c28873 823 atomic_set(&task->tk_count, 1);
1da177e4
LT
824 task->tk_client = clnt;
825 task->tk_flags = flags;
963d8fe5 826 task->tk_ops = tk_ops;
4ce70ada
TM
827 if (tk_ops->rpc_call_prepare != NULL)
828 task->tk_action = rpc_prepare_task;
963d8fe5 829 task->tk_calldata = calldata;
6529eba0 830 INIT_LIST_HEAD(&task->tk_task);
1da177e4
LT
831
832 /* Initialize retry counters */
833 task->tk_garb_retry = 2;
834 task->tk_cred_retry = 2;
835
836 task->tk_priority = RPC_PRIORITY_NORMAL;
837 task->tk_cookie = (unsigned long)current;
838
839 /* Initialize workqueue for async tasks */
840 task->tk_workqueue = rpciod_workqueue;
1da177e4
LT
841
842 if (clnt) {
34f52e35 843 kref_get(&clnt->cl_kref);
1da177e4
LT
844 if (clnt->cl_softrtry)
845 task->tk_flags |= RPC_TASK_SOFT;
846 if (!clnt->cl_intr)
847 task->tk_flags |= RPC_TASK_NOINTR;
848 }
849
963d8fe5
TM
850 BUG_ON(task->tk_ops == NULL);
851
ef759a2e
CL
852 /* starting timestamp */
853 task->tk_start = jiffies;
854
46121cf7 855 dprintk("RPC: new task initialized, procpid %u\n",
ba25f9dc 856 task_pid_nr(current));
1da177e4 857}
a6eaf8bd 858EXPORT_SYMBOL(rpc_init_task);
1da177e4
LT
859
860static struct rpc_task *
861rpc_alloc_task(void)
862{
863 return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOFS);
864}
865
8aca67f0 866static void rpc_free_task(struct rcu_head *rcu)
1da177e4 867{
8aca67f0 868 struct rpc_task *task = container_of(rcu, struct rpc_task, u.tk_rcu);
46121cf7 869 dprintk("RPC: %5u freeing task\n", task->tk_pid);
1da177e4
LT
870 mempool_free(task, rpc_task_mempool);
871}
872
873/*
90c5755f 874 * Create a new task for the specified client.
1da177e4 875 */
963d8fe5 876struct rpc_task *rpc_new_task(struct rpc_clnt *clnt, int flags, const struct rpc_call_ops *tk_ops, void *calldata)
1da177e4
LT
877{
878 struct rpc_task *task;
879
880 task = rpc_alloc_task();
881 if (!task)
90c5755f 882 goto out;
1da177e4 883
963d8fe5 884 rpc_init_task(task, clnt, flags, tk_ops, calldata);
1da177e4 885
46121cf7 886 dprintk("RPC: allocated task %p\n", task);
1da177e4
LT
887 task->tk_flags |= RPC_TASK_DYNAMIC;
888out:
889 return task;
1da177e4
LT
890}
891
e6b3c4db
TM
892
893void rpc_put_task(struct rpc_task *task)
1da177e4 894{
963d8fe5
TM
895 const struct rpc_call_ops *tk_ops = task->tk_ops;
896 void *calldata = task->tk_calldata;
1da177e4 897
e6b3c4db
TM
898 if (!atomic_dec_and_test(&task->tk_count))
899 return;
900 /* Release resources */
901 if (task->tk_rqstp)
902 xprt_release(task);
903 if (task->tk_msg.rpc_cred)
904 rpcauth_unbindcred(task);
905 if (task->tk_client) {
906 rpc_release_client(task->tk_client);
907 task->tk_client = NULL;
908 }
909 if (task->tk_flags & RPC_TASK_DYNAMIC)
8aca67f0 910 call_rcu_bh(&task->u.tk_rcu, rpc_free_task);
bbd5a1f9 911 rpc_release_calldata(tk_ops, calldata);
e6b3c4db
TM
912}
913EXPORT_SYMBOL(rpc_put_task);
914
bde8f00c 915static void rpc_release_task(struct rpc_task *task)
e6b3c4db 916{
1da177e4
LT
917#ifdef RPC_DEBUG
918 BUG_ON(task->tk_magic != RPC_TASK_MAGIC_ID);
919#endif
46121cf7 920 dprintk("RPC: %5u release task\n", task->tk_pid);
1da177e4 921
6529eba0 922 if (!list_empty(&task->tk_task)) {
4bef61ff 923 struct rpc_clnt *clnt = task->tk_client;
6529eba0 924 /* Remove from client task list */
4bef61ff 925 spin_lock(&clnt->cl_lock);
6529eba0 926 list_del(&task->tk_task);
4bef61ff 927 spin_unlock(&clnt->cl_lock);
6529eba0 928 }
1da177e4 929 BUG_ON (RPC_IS_QUEUED(task));
1da177e4
LT
930
931 /* Synchronously delete any running timer */
932 rpc_delete_timer(task);
933
1da177e4
LT
934#ifdef RPC_DEBUG
935 task->tk_magic = 0;
936#endif
e6b3c4db
TM
937 /* Wake up anyone who is waiting for task completion */
938 rpc_mark_complete_task(task);
939
940 rpc_put_task(task);
1da177e4
LT
941}
942
1da177e4
LT
943/*
944 * Kill all tasks for the given client.
945 * XXX: kill their descendants as well?
946 */
4bef61ff 947void rpc_killall_tasks(struct rpc_clnt *clnt)
1da177e4
LT
948{
949 struct rpc_task *rovr;
1da177e4 950
1da177e4 951
4bef61ff
TM
952 if (list_empty(&clnt->cl_tasks))
953 return;
954 dprintk("RPC: killing all tasks for client %p\n", clnt);
955 /*
956 * Spin lock all_tasks to prevent changes...
957 */
958 spin_lock(&clnt->cl_lock);
959 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
1da177e4
LT
960 if (! RPC_IS_ACTIVATED(rovr))
961 continue;
6529eba0 962 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
1da177e4
LT
963 rovr->tk_flags |= RPC_TASK_KILLED;
964 rpc_exit(rovr, -EIO);
965 rpc_wake_up_task(rovr);
966 }
967 }
4bef61ff 968 spin_unlock(&clnt->cl_lock);
1da177e4 969}
a6eaf8bd 970EXPORT_SYMBOL(rpc_killall_tasks);
1da177e4 971
b247bbf1
TM
972int rpciod_up(void)
973{
974 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
975}
976
977void rpciod_down(void)
978{
979 module_put(THIS_MODULE);
980}
981
1da177e4 982/*
b247bbf1 983 * Start up the rpciod workqueue.
1da177e4 984 */
b247bbf1 985static int rpciod_start(void)
1da177e4
LT
986{
987 struct workqueue_struct *wq;
ab418d70 988
1da177e4
LT
989 /*
990 * Create the rpciod thread and wait for it to start.
991 */
ab418d70 992 dprintk("RPC: creating workqueue rpciod\n");
1da177e4 993 wq = create_workqueue("rpciod");
1da177e4 994 rpciod_workqueue = wq;
b247bbf1 995 return rpciod_workqueue != NULL;
1da177e4
LT
996}
997
b247bbf1 998static void rpciod_stop(void)
1da177e4 999{
b247bbf1 1000 struct workqueue_struct *wq = NULL;
ab418d70 1001
b247bbf1
TM
1002 if (rpciod_workqueue == NULL)
1003 return;
ab418d70 1004 dprintk("RPC: destroying workqueue rpciod\n");
1da177e4 1005
b247bbf1
TM
1006 wq = rpciod_workqueue;
1007 rpciod_workqueue = NULL;
1008 destroy_workqueue(wq);
1da177e4
LT
1009}
1010
1da177e4
LT
1011void
1012rpc_destroy_mempool(void)
1013{
b247bbf1 1014 rpciod_stop();
1da177e4
LT
1015 if (rpc_buffer_mempool)
1016 mempool_destroy(rpc_buffer_mempool);
1017 if (rpc_task_mempool)
1018 mempool_destroy(rpc_task_mempool);
1a1d92c1
AD
1019 if (rpc_task_slabp)
1020 kmem_cache_destroy(rpc_task_slabp);
1021 if (rpc_buffer_slabp)
1022 kmem_cache_destroy(rpc_buffer_slabp);
1da177e4
LT
1023}
1024
1025int
1026rpc_init_mempool(void)
1027{
1028 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1029 sizeof(struct rpc_task),
1030 0, SLAB_HWCACHE_ALIGN,
20c2df83 1031 NULL);
1da177e4
LT
1032 if (!rpc_task_slabp)
1033 goto err_nomem;
1034 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1035 RPC_BUFFER_MAXSIZE,
1036 0, SLAB_HWCACHE_ALIGN,
20c2df83 1037 NULL);
1da177e4
LT
1038 if (!rpc_buffer_slabp)
1039 goto err_nomem;
93d2341c
MD
1040 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1041 rpc_task_slabp);
1da177e4
LT
1042 if (!rpc_task_mempool)
1043 goto err_nomem;
93d2341c
MD
1044 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1045 rpc_buffer_slabp);
1da177e4
LT
1046 if (!rpc_buffer_mempool)
1047 goto err_nomem;
b247bbf1
TM
1048 if (!rpciod_start())
1049 goto err_nomem;
1da177e4
LT
1050 return 0;
1051err_nomem:
1052 rpc_destroy_mempool();
1053 return -ENOMEM;
1054}