2 * linux/net/sunrpc/sched.c
4 * Scheduling for synchronous and asynchronous RPC requests.
6 * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
8 * TCP NFS related read + write fixes
9 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
12 #include <linux/module.h>
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/spinlock.h>
20 #include <linux/mutex.h>
21 #include <linux/freezer.h>
23 #include <linux/sunrpc/clnt.h>
27 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
28 #define RPCDBG_FACILITY RPCDBG_SCHED
31 #define CREATE_TRACE_POINTS
32 #include <trace/events/sunrpc.h>
35 * RPC slabs and memory pools
37 #define RPC_BUFFER_MAXSIZE (2048)
38 #define RPC_BUFFER_POOLSIZE (8)
39 #define RPC_TASK_POOLSIZE (8)
40 static struct kmem_cache
*rpc_task_slabp __read_mostly
;
41 static struct kmem_cache
*rpc_buffer_slabp __read_mostly
;
42 static mempool_t
*rpc_task_mempool __read_mostly
;
43 static mempool_t
*rpc_buffer_mempool __read_mostly
;
45 static void rpc_async_schedule(struct work_struct
*);
46 static void rpc_release_task(struct rpc_task
*task
);
47 static void __rpc_queue_timer_fn(unsigned long ptr
);
50 * RPC tasks sit here while waiting for conditions to improve.
52 static struct rpc_wait_queue delay_queue
;
55 * rpciod-related stuff
57 struct workqueue_struct
*rpciod_workqueue __read_mostly
;
58 struct workqueue_struct
*xprtiod_workqueue __read_mostly
;
61 * Disable the timer for a given RPC task. Should be called with
62 * queue->lock and bh_disabled in order to avoid races within
66 __rpc_disable_timer(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
68 if (task
->tk_timeout
== 0)
70 dprintk("RPC: %5u disabling timer\n", task
->tk_pid
);
72 list_del(&task
->u
.tk_wait
.timer_list
);
73 if (list_empty(&queue
->timer_list
.list
))
74 del_timer(&queue
->timer_list
.timer
);
78 rpc_set_queue_timer(struct rpc_wait_queue
*queue
, unsigned long expires
)
80 queue
->timer_list
.expires
= expires
;
81 mod_timer(&queue
->timer_list
.timer
, expires
);
85 * Set up a timer for the current task.
88 __rpc_add_timer(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
90 if (!task
->tk_timeout
)
93 dprintk("RPC: %5u setting alarm for %u ms\n",
94 task
->tk_pid
, jiffies_to_msecs(task
->tk_timeout
));
96 task
->u
.tk_wait
.expires
= jiffies
+ task
->tk_timeout
;
97 if (list_empty(&queue
->timer_list
.list
) || time_before(task
->u
.tk_wait
.expires
, queue
->timer_list
.expires
))
98 rpc_set_queue_timer(queue
, task
->u
.tk_wait
.expires
);
99 list_add(&task
->u
.tk_wait
.timer_list
, &queue
->timer_list
.list
);
102 static void rpc_rotate_queue_owner(struct rpc_wait_queue
*queue
)
104 struct list_head
*q
= &queue
->tasks
[queue
->priority
];
105 struct rpc_task
*task
;
107 if (!list_empty(q
)) {
108 task
= list_first_entry(q
, struct rpc_task
, u
.tk_wait
.list
);
109 if (task
->tk_owner
== queue
->owner
)
110 list_move_tail(&task
->u
.tk_wait
.list
, q
);
114 static void rpc_set_waitqueue_priority(struct rpc_wait_queue
*queue
, int priority
)
116 if (queue
->priority
!= priority
) {
117 /* Fairness: rotate the list when changing priority */
118 rpc_rotate_queue_owner(queue
);
119 queue
->priority
= priority
;
123 static void rpc_set_waitqueue_owner(struct rpc_wait_queue
*queue
, pid_t pid
)
126 queue
->nr
= RPC_BATCH_COUNT
;
129 static void rpc_reset_waitqueue_priority(struct rpc_wait_queue
*queue
)
131 rpc_set_waitqueue_priority(queue
, queue
->maxpriority
);
132 rpc_set_waitqueue_owner(queue
, 0);
136 * Add new request to a priority queue.
138 static void __rpc_add_wait_queue_priority(struct rpc_wait_queue
*queue
,
139 struct rpc_task
*task
,
140 unsigned char queue_priority
)
145 INIT_LIST_HEAD(&task
->u
.tk_wait
.links
);
146 if (unlikely(queue_priority
> queue
->maxpriority
))
147 queue_priority
= queue
->maxpriority
;
148 if (queue_priority
> queue
->priority
)
149 rpc_set_waitqueue_priority(queue
, queue_priority
);
150 q
= &queue
->tasks
[queue_priority
];
151 list_for_each_entry(t
, q
, u
.tk_wait
.list
) {
152 if (t
->tk_owner
== task
->tk_owner
) {
153 list_add_tail(&task
->u
.tk_wait
.list
, &t
->u
.tk_wait
.links
);
157 list_add_tail(&task
->u
.tk_wait
.list
, q
);
161 * Add new request to wait queue.
163 * Swapper tasks always get inserted at the head of the queue.
164 * This should avoid many nasty memory deadlocks and hopefully
165 * improve overall performance.
166 * Everyone else gets appended to the queue to ensure proper FIFO behavior.
168 static void __rpc_add_wait_queue(struct rpc_wait_queue
*queue
,
169 struct rpc_task
*task
,
170 unsigned char queue_priority
)
172 WARN_ON_ONCE(RPC_IS_QUEUED(task
));
173 if (RPC_IS_QUEUED(task
))
176 if (RPC_IS_PRIORITY(queue
))
177 __rpc_add_wait_queue_priority(queue
, task
, queue_priority
);
178 else if (RPC_IS_SWAPPER(task
))
179 list_add(&task
->u
.tk_wait
.list
, &queue
->tasks
[0]);
181 list_add_tail(&task
->u
.tk_wait
.list
, &queue
->tasks
[0]);
182 task
->tk_waitqueue
= queue
;
184 /* barrier matches the read in rpc_wake_up_task_queue_locked() */
186 rpc_set_queued(task
);
188 dprintk("RPC: %5u added to queue %p \"%s\"\n",
189 task
->tk_pid
, queue
, rpc_qname(queue
));
193 * Remove request from a priority queue.
195 static void __rpc_remove_wait_queue_priority(struct rpc_task
*task
)
199 if (!list_empty(&task
->u
.tk_wait
.links
)) {
200 t
= list_entry(task
->u
.tk_wait
.links
.next
, struct rpc_task
, u
.tk_wait
.list
);
201 list_move(&t
->u
.tk_wait
.list
, &task
->u
.tk_wait
.list
);
202 list_splice_init(&task
->u
.tk_wait
.links
, &t
->u
.tk_wait
.links
);
207 * Remove request from queue.
208 * Note: must be called with spin lock held.
210 static void __rpc_remove_wait_queue(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
212 __rpc_disable_timer(queue
, task
);
213 if (RPC_IS_PRIORITY(queue
))
214 __rpc_remove_wait_queue_priority(task
);
215 list_del(&task
->u
.tk_wait
.list
);
217 dprintk("RPC: %5u removed from queue %p \"%s\"\n",
218 task
->tk_pid
, queue
, rpc_qname(queue
));
221 static void __rpc_init_priority_wait_queue(struct rpc_wait_queue
*queue
, const char *qname
, unsigned char nr_queues
)
225 spin_lock_init(&queue
->lock
);
226 for (i
= 0; i
< ARRAY_SIZE(queue
->tasks
); i
++)
227 INIT_LIST_HEAD(&queue
->tasks
[i
]);
228 queue
->maxpriority
= nr_queues
- 1;
229 rpc_reset_waitqueue_priority(queue
);
231 setup_timer(&queue
->timer_list
.timer
, __rpc_queue_timer_fn
, (unsigned long)queue
);
232 INIT_LIST_HEAD(&queue
->timer_list
.list
);
233 rpc_assign_waitqueue_name(queue
, qname
);
236 void rpc_init_priority_wait_queue(struct rpc_wait_queue
*queue
, const char *qname
)
238 __rpc_init_priority_wait_queue(queue
, qname
, RPC_NR_PRIORITY
);
240 EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue
);
242 void rpc_init_wait_queue(struct rpc_wait_queue
*queue
, const char *qname
)
244 __rpc_init_priority_wait_queue(queue
, qname
, 1);
246 EXPORT_SYMBOL_GPL(rpc_init_wait_queue
);
248 void rpc_destroy_wait_queue(struct rpc_wait_queue
*queue
)
250 del_timer_sync(&queue
->timer_list
.timer
);
252 EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue
);
254 static int rpc_wait_bit_killable(struct wait_bit_key
*key
, int mode
)
256 freezable_schedule_unsafe();
257 if (signal_pending_state(mode
, current
))
262 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
263 static void rpc_task_set_debuginfo(struct rpc_task
*task
)
265 static atomic_t rpc_pid
;
267 task
->tk_pid
= atomic_inc_return(&rpc_pid
);
270 static inline void rpc_task_set_debuginfo(struct rpc_task
*task
)
275 static void rpc_set_active(struct rpc_task
*task
)
277 rpc_task_set_debuginfo(task
);
278 set_bit(RPC_TASK_ACTIVE
, &task
->tk_runstate
);
279 trace_rpc_task_begin(task
->tk_client
, task
, NULL
);
283 * Mark an RPC call as having completed by clearing the 'active' bit
284 * and then waking up all tasks that were sleeping.
286 static int rpc_complete_task(struct rpc_task
*task
)
288 void *m
= &task
->tk_runstate
;
289 wait_queue_head_t
*wq
= bit_waitqueue(m
, RPC_TASK_ACTIVE
);
290 struct wait_bit_key k
= __WAIT_BIT_KEY_INITIALIZER(m
, RPC_TASK_ACTIVE
);
294 trace_rpc_task_complete(task
->tk_client
, task
, NULL
);
296 spin_lock_irqsave(&wq
->lock
, flags
);
297 clear_bit(RPC_TASK_ACTIVE
, &task
->tk_runstate
);
298 ret
= atomic_dec_and_test(&task
->tk_count
);
299 if (waitqueue_active(wq
))
300 __wake_up_locked_key(wq
, TASK_NORMAL
, &k
);
301 spin_unlock_irqrestore(&wq
->lock
, flags
);
306 * Allow callers to wait for completion of an RPC call
308 * Note the use of out_of_line_wait_on_bit() rather than wait_on_bit()
309 * to enforce taking of the wq->lock and hence avoid races with
310 * rpc_complete_task().
312 int __rpc_wait_for_completion_task(struct rpc_task
*task
, wait_bit_action_f
*action
)
315 action
= rpc_wait_bit_killable
;
316 return out_of_line_wait_on_bit(&task
->tk_runstate
, RPC_TASK_ACTIVE
,
317 action
, TASK_KILLABLE
);
319 EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task
);
322 * Make an RPC task runnable.
324 * Note: If the task is ASYNC, and is being made runnable after sitting on an
325 * rpc_wait_queue, this must be called with the queue spinlock held to protect
326 * the wait queue operation.
327 * Note the ordering of rpc_test_and_set_running() and rpc_clear_queued(),
328 * which is needed to ensure that __rpc_execute() doesn't loop (due to the
329 * lockless RPC_IS_QUEUED() test) before we've had a chance to test
330 * the RPC_TASK_RUNNING flag.
332 static void rpc_make_runnable(struct workqueue_struct
*wq
,
333 struct rpc_task
*task
)
335 bool need_wakeup
= !rpc_test_and_set_running(task
);
337 rpc_clear_queued(task
);
340 if (RPC_IS_ASYNC(task
)) {
341 INIT_WORK(&task
->u
.tk_work
, rpc_async_schedule
);
342 queue_work(wq
, &task
->u
.tk_work
);
344 wake_up_bit(&task
->tk_runstate
, RPC_TASK_QUEUED
);
348 * Prepare for sleeping on a wait queue.
349 * By always appending tasks to the list we ensure FIFO behavior.
350 * NB: An RPC task will only receive interrupt-driven events as long
351 * as it's on a wait queue.
353 static void __rpc_sleep_on_priority(struct rpc_wait_queue
*q
,
354 struct rpc_task
*task
,
356 unsigned char queue_priority
)
358 dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
359 task
->tk_pid
, rpc_qname(q
), jiffies
);
361 trace_rpc_task_sleep(task
->tk_client
, task
, q
);
363 __rpc_add_wait_queue(q
, task
, queue_priority
);
365 WARN_ON_ONCE(task
->tk_callback
!= NULL
);
366 task
->tk_callback
= action
;
367 __rpc_add_timer(q
, task
);
370 void rpc_sleep_on(struct rpc_wait_queue
*q
, struct rpc_task
*task
,
373 /* We shouldn't ever put an inactive task to sleep */
374 WARN_ON_ONCE(!RPC_IS_ACTIVATED(task
));
375 if (!RPC_IS_ACTIVATED(task
)) {
376 task
->tk_status
= -EIO
;
377 rpc_put_task_async(task
);
382 * Protect the queue operations.
384 spin_lock_bh(&q
->lock
);
385 __rpc_sleep_on_priority(q
, task
, action
, task
->tk_priority
);
386 spin_unlock_bh(&q
->lock
);
388 EXPORT_SYMBOL_GPL(rpc_sleep_on
);
390 void rpc_sleep_on_priority(struct rpc_wait_queue
*q
, struct rpc_task
*task
,
391 rpc_action action
, int priority
)
393 /* We shouldn't ever put an inactive task to sleep */
394 WARN_ON_ONCE(!RPC_IS_ACTIVATED(task
));
395 if (!RPC_IS_ACTIVATED(task
)) {
396 task
->tk_status
= -EIO
;
397 rpc_put_task_async(task
);
402 * Protect the queue operations.
404 spin_lock_bh(&q
->lock
);
405 __rpc_sleep_on_priority(q
, task
, action
, priority
- RPC_PRIORITY_LOW
);
406 spin_unlock_bh(&q
->lock
);
408 EXPORT_SYMBOL_GPL(rpc_sleep_on_priority
);
411 * __rpc_do_wake_up_task_on_wq - wake up a single rpc_task
412 * @wq: workqueue on which to run task
414 * @task: task to be woken up
416 * Caller must hold queue->lock, and have cleared the task queued flag.
418 static void __rpc_do_wake_up_task_on_wq(struct workqueue_struct
*wq
,
419 struct rpc_wait_queue
*queue
,
420 struct rpc_task
*task
)
422 dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
423 task
->tk_pid
, jiffies
);
425 /* Has the task been executed yet? If not, we cannot wake it up! */
426 if (!RPC_IS_ACTIVATED(task
)) {
427 printk(KERN_ERR
"RPC: Inactive task (%p) being woken up!\n", task
);
431 trace_rpc_task_wakeup(task
->tk_client
, task
, queue
);
433 __rpc_remove_wait_queue(queue
, task
);
435 rpc_make_runnable(wq
, task
);
437 dprintk("RPC: __rpc_wake_up_task done\n");
441 * Wake up a queued task while the queue lock is being held
443 static void rpc_wake_up_task_on_wq_queue_locked(struct workqueue_struct
*wq
,
444 struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
446 if (RPC_IS_QUEUED(task
)) {
448 if (task
->tk_waitqueue
== queue
)
449 __rpc_do_wake_up_task_on_wq(wq
, queue
, task
);
454 * Wake up a queued task while the queue lock is being held
456 static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
458 rpc_wake_up_task_on_wq_queue_locked(rpciod_workqueue
, queue
, task
);
462 * Wake up a task on a specific queue
464 void rpc_wake_up_queued_task(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
466 spin_lock_bh(&queue
->lock
);
467 rpc_wake_up_task_queue_locked(queue
, task
);
468 spin_unlock_bh(&queue
->lock
);
470 EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task
);
473 * Wake up the next task on a priority queue.
475 static struct rpc_task
*__rpc_find_next_queued_priority(struct rpc_wait_queue
*queue
)
478 struct rpc_task
*task
;
481 * Service a batch of tasks from a single owner.
483 q
= &queue
->tasks
[queue
->priority
];
484 if (!list_empty(q
)) {
485 task
= list_entry(q
->next
, struct rpc_task
, u
.tk_wait
.list
);
486 if (queue
->owner
== task
->tk_owner
) {
489 list_move_tail(&task
->u
.tk_wait
.list
, q
);
492 * Check if we need to switch queues.
498 * Service the next queue.
501 if (q
== &queue
->tasks
[0])
502 q
= &queue
->tasks
[queue
->maxpriority
];
505 if (!list_empty(q
)) {
506 task
= list_entry(q
->next
, struct rpc_task
, u
.tk_wait
.list
);
509 } while (q
!= &queue
->tasks
[queue
->priority
]);
511 rpc_reset_waitqueue_priority(queue
);
515 rpc_set_waitqueue_priority(queue
, (unsigned int)(q
- &queue
->tasks
[0]));
517 rpc_set_waitqueue_owner(queue
, task
->tk_owner
);
522 static struct rpc_task
*__rpc_find_next_queued(struct rpc_wait_queue
*queue
)
524 if (RPC_IS_PRIORITY(queue
))
525 return __rpc_find_next_queued_priority(queue
);
526 if (!list_empty(&queue
->tasks
[0]))
527 return list_first_entry(&queue
->tasks
[0], struct rpc_task
, u
.tk_wait
.list
);
532 * Wake up the first task on the wait queue.
534 struct rpc_task
*rpc_wake_up_first_on_wq(struct workqueue_struct
*wq
,
535 struct rpc_wait_queue
*queue
,
536 bool (*func
)(struct rpc_task
*, void *), void *data
)
538 struct rpc_task
*task
= NULL
;
540 dprintk("RPC: wake_up_first(%p \"%s\")\n",
541 queue
, rpc_qname(queue
));
542 spin_lock_bh(&queue
->lock
);
543 task
= __rpc_find_next_queued(queue
);
545 if (func(task
, data
))
546 rpc_wake_up_task_on_wq_queue_locked(wq
, queue
, task
);
550 spin_unlock_bh(&queue
->lock
);
556 * Wake up the first task on the wait queue.
558 struct rpc_task
*rpc_wake_up_first(struct rpc_wait_queue
*queue
,
559 bool (*func
)(struct rpc_task
*, void *), void *data
)
561 return rpc_wake_up_first_on_wq(rpciod_workqueue
, queue
, func
, data
);
563 EXPORT_SYMBOL_GPL(rpc_wake_up_first
);
565 static bool rpc_wake_up_next_func(struct rpc_task
*task
, void *data
)
571 * Wake up the next task on the wait queue.
573 struct rpc_task
*rpc_wake_up_next(struct rpc_wait_queue
*queue
)
575 return rpc_wake_up_first(queue
, rpc_wake_up_next_func
, NULL
);
577 EXPORT_SYMBOL_GPL(rpc_wake_up_next
);
580 * rpc_wake_up - wake up all rpc_tasks
581 * @queue: rpc_wait_queue on which the tasks are sleeping
585 void rpc_wake_up(struct rpc_wait_queue
*queue
)
587 struct list_head
*head
;
589 spin_lock_bh(&queue
->lock
);
590 head
= &queue
->tasks
[queue
->maxpriority
];
592 while (!list_empty(head
)) {
593 struct rpc_task
*task
;
594 task
= list_first_entry(head
,
597 rpc_wake_up_task_queue_locked(queue
, task
);
599 if (head
== &queue
->tasks
[0])
603 spin_unlock_bh(&queue
->lock
);
605 EXPORT_SYMBOL_GPL(rpc_wake_up
);
608 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
609 * @queue: rpc_wait_queue on which the tasks are sleeping
610 * @status: status value to set
614 void rpc_wake_up_status(struct rpc_wait_queue
*queue
, int status
)
616 struct list_head
*head
;
618 spin_lock_bh(&queue
->lock
);
619 head
= &queue
->tasks
[queue
->maxpriority
];
621 while (!list_empty(head
)) {
622 struct rpc_task
*task
;
623 task
= list_first_entry(head
,
626 task
->tk_status
= status
;
627 rpc_wake_up_task_queue_locked(queue
, task
);
629 if (head
== &queue
->tasks
[0])
633 spin_unlock_bh(&queue
->lock
);
635 EXPORT_SYMBOL_GPL(rpc_wake_up_status
);
637 static void __rpc_queue_timer_fn(unsigned long ptr
)
639 struct rpc_wait_queue
*queue
= (struct rpc_wait_queue
*)ptr
;
640 struct rpc_task
*task
, *n
;
641 unsigned long expires
, now
, timeo
;
643 spin_lock(&queue
->lock
);
644 expires
= now
= jiffies
;
645 list_for_each_entry_safe(task
, n
, &queue
->timer_list
.list
, u
.tk_wait
.timer_list
) {
646 timeo
= task
->u
.tk_wait
.expires
;
647 if (time_after_eq(now
, timeo
)) {
648 dprintk("RPC: %5u timeout\n", task
->tk_pid
);
649 task
->tk_status
= -ETIMEDOUT
;
650 rpc_wake_up_task_queue_locked(queue
, task
);
653 if (expires
== now
|| time_after(expires
, timeo
))
656 if (!list_empty(&queue
->timer_list
.list
))
657 rpc_set_queue_timer(queue
, expires
);
658 spin_unlock(&queue
->lock
);
661 static void __rpc_atrun(struct rpc_task
*task
)
663 if (task
->tk_status
== -ETIMEDOUT
)
668 * Run a task at a later time
670 void rpc_delay(struct rpc_task
*task
, unsigned long delay
)
672 task
->tk_timeout
= delay
;
673 rpc_sleep_on(&delay_queue
, task
, __rpc_atrun
);
675 EXPORT_SYMBOL_GPL(rpc_delay
);
678 * Helper to call task->tk_ops->rpc_call_prepare
680 void rpc_prepare_task(struct rpc_task
*task
)
682 task
->tk_ops
->rpc_call_prepare(task
, task
->tk_calldata
);
686 rpc_init_task_statistics(struct rpc_task
*task
)
688 /* Initialize retry counters */
689 task
->tk_garb_retry
= 2;
690 task
->tk_cred_retry
= 2;
691 task
->tk_rebind_retry
= 2;
693 /* starting timestamp */
694 task
->tk_start
= ktime_get();
698 rpc_reset_task_statistics(struct rpc_task
*task
)
700 task
->tk_timeouts
= 0;
701 task
->tk_flags
&= ~(RPC_CALL_MAJORSEEN
|RPC_TASK_KILLED
|RPC_TASK_SENT
);
703 rpc_init_task_statistics(task
);
707 * Helper that calls task->tk_ops->rpc_call_done if it exists
709 void rpc_exit_task(struct rpc_task
*task
)
711 task
->tk_action
= NULL
;
712 if (task
->tk_ops
->rpc_call_done
!= NULL
) {
713 task
->tk_ops
->rpc_call_done(task
, task
->tk_calldata
);
714 if (task
->tk_action
!= NULL
) {
715 WARN_ON(RPC_ASSASSINATED(task
));
716 /* Always release the RPC slot and buffer memory */
718 rpc_reset_task_statistics(task
);
723 void rpc_exit(struct rpc_task
*task
, int status
)
725 task
->tk_status
= status
;
726 task
->tk_action
= rpc_exit_task
;
727 if (RPC_IS_QUEUED(task
))
728 rpc_wake_up_queued_task(task
->tk_waitqueue
, task
);
730 EXPORT_SYMBOL_GPL(rpc_exit
);
732 void rpc_release_calldata(const struct rpc_call_ops
*ops
, void *calldata
)
734 if (ops
->rpc_release
!= NULL
)
735 ops
->rpc_release(calldata
);
739 * This is the RPC `scheduler' (or rather, the finite state machine).
741 static void __rpc_execute(struct rpc_task
*task
)
743 struct rpc_wait_queue
*queue
;
744 int task_is_async
= RPC_IS_ASYNC(task
);
747 dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
748 task
->tk_pid
, task
->tk_flags
);
750 WARN_ON_ONCE(RPC_IS_QUEUED(task
));
751 if (RPC_IS_QUEUED(task
))
755 void (*do_action
)(struct rpc_task
*);
758 * Execute any pending callback first.
760 do_action
= task
->tk_callback
;
761 task
->tk_callback
= NULL
;
762 if (do_action
== NULL
) {
764 * Perform the next FSM step.
765 * tk_action may be NULL if the task has been killed.
766 * In particular, note that rpc_killall_tasks may
767 * do this at any time, so beware when dereferencing.
769 do_action
= task
->tk_action
;
770 if (do_action
== NULL
)
773 trace_rpc_task_run_action(task
->tk_client
, task
, task
->tk_action
);
777 * Lockless check for whether task is sleeping or not.
779 if (!RPC_IS_QUEUED(task
))
782 * The queue->lock protects against races with
783 * rpc_make_runnable().
785 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
786 * rpc_task, rpc_make_runnable() can assign it to a
787 * different workqueue. We therefore cannot assume that the
788 * rpc_task pointer may still be dereferenced.
790 queue
= task
->tk_waitqueue
;
791 spin_lock_bh(&queue
->lock
);
792 if (!RPC_IS_QUEUED(task
)) {
793 spin_unlock_bh(&queue
->lock
);
796 rpc_clear_running(task
);
797 spin_unlock_bh(&queue
->lock
);
801 /* sync task: sleep here */
802 dprintk("RPC: %5u sync task going to sleep\n", task
->tk_pid
);
803 status
= out_of_line_wait_on_bit(&task
->tk_runstate
,
804 RPC_TASK_QUEUED
, rpc_wait_bit_killable
,
806 if (status
== -ERESTARTSYS
) {
808 * When a sync task receives a signal, it exits with
809 * -ERESTARTSYS. In order to catch any callbacks that
810 * clean up after sleeping on some queue, we don't
811 * break the loop here, but go around once more.
813 dprintk("RPC: %5u got signal\n", task
->tk_pid
);
814 task
->tk_flags
|= RPC_TASK_KILLED
;
815 rpc_exit(task
, -ERESTARTSYS
);
817 dprintk("RPC: %5u sync task resuming\n", task
->tk_pid
);
820 dprintk("RPC: %5u return %d, status %d\n", task
->tk_pid
, status
,
822 /* Release all resources associated with the task */
823 rpc_release_task(task
);
827 * User-visible entry point to the scheduler.
829 * This may be called recursively if e.g. an async NFS task updates
830 * the attributes and finds that dirty pages must be flushed.
831 * NOTE: Upon exit of this function the task is guaranteed to be
832 * released. In particular note that tk_release() will have
833 * been called, so your task memory may have been freed.
835 void rpc_execute(struct rpc_task
*task
)
837 bool is_async
= RPC_IS_ASYNC(task
);
839 rpc_set_active(task
);
840 rpc_make_runnable(rpciod_workqueue
, task
);
845 static void rpc_async_schedule(struct work_struct
*work
)
847 __rpc_execute(container_of(work
, struct rpc_task
, u
.tk_work
));
851 * rpc_malloc - allocate RPC buffer resources
854 * A single memory region is allocated, which is split between the
855 * RPC call and RPC reply that this task is being used for. When
856 * this RPC is retired, the memory is released by calling rpc_free.
858 * To prevent rpciod from hanging, this allocator never sleeps,
859 * returning -ENOMEM and suppressing warning if the request cannot
860 * be serviced immediately. The caller can arrange to sleep in a
861 * way that is safe for rpciod.
863 * Most requests are 'small' (under 2KiB) and can be serviced from a
864 * mempool, ensuring that NFS reads and writes can always proceed,
865 * and that there is good locality of reference for these buffers.
867 * In order to avoid memory starvation triggering more writebacks of
868 * NFS requests, we avoid using GFP_KERNEL.
870 int rpc_malloc(struct rpc_task
*task
)
872 struct rpc_rqst
*rqst
= task
->tk_rqstp
;
873 size_t size
= rqst
->rq_callsize
+ rqst
->rq_rcvsize
;
874 struct rpc_buffer
*buf
;
875 gfp_t gfp
= GFP_NOIO
| __GFP_NOWARN
;
877 if (RPC_IS_SWAPPER(task
))
878 gfp
= __GFP_MEMALLOC
| GFP_NOWAIT
| __GFP_NOWARN
;
880 size
+= sizeof(struct rpc_buffer
);
881 if (size
<= RPC_BUFFER_MAXSIZE
)
882 buf
= mempool_alloc(rpc_buffer_mempool
, gfp
);
884 buf
= kmalloc(size
, gfp
);
890 dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
891 task
->tk_pid
, size
, buf
);
892 rqst
->rq_buffer
= buf
->data
;
893 rqst
->rq_rbuffer
= (char *)rqst
->rq_buffer
+ rqst
->rq_callsize
;
896 EXPORT_SYMBOL_GPL(rpc_malloc
);
899 * rpc_free - free RPC buffer resources allocated via rpc_malloc
903 void rpc_free(struct rpc_task
*task
)
905 void *buffer
= task
->tk_rqstp
->rq_buffer
;
907 struct rpc_buffer
*buf
;
909 buf
= container_of(buffer
, struct rpc_buffer
, data
);
912 dprintk("RPC: freeing buffer of size %zu at %p\n",
915 if (size
<= RPC_BUFFER_MAXSIZE
)
916 mempool_free(buf
, rpc_buffer_mempool
);
920 EXPORT_SYMBOL_GPL(rpc_free
);
923 * Creation and deletion of RPC task structures
925 static void rpc_init_task(struct rpc_task
*task
, const struct rpc_task_setup
*task_setup_data
)
927 memset(task
, 0, sizeof(*task
));
928 atomic_set(&task
->tk_count
, 1);
929 task
->tk_flags
= task_setup_data
->flags
;
930 task
->tk_ops
= task_setup_data
->callback_ops
;
931 task
->tk_calldata
= task_setup_data
->callback_data
;
932 INIT_LIST_HEAD(&task
->tk_task
);
934 task
->tk_priority
= task_setup_data
->priority
- RPC_PRIORITY_LOW
;
935 task
->tk_owner
= current
->tgid
;
937 /* Initialize workqueue for async tasks */
938 task
->tk_workqueue
= task_setup_data
->workqueue
;
940 task
->tk_xprt
= xprt_get(task_setup_data
->rpc_xprt
);
942 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
943 task
->tk_action
= rpc_prepare_task
;
945 rpc_init_task_statistics(task
);
947 dprintk("RPC: new task initialized, procpid %u\n",
948 task_pid_nr(current
));
951 static struct rpc_task
*
954 return (struct rpc_task
*)mempool_alloc(rpc_task_mempool
, GFP_NOIO
);
958 * Create a new task for the specified client.
960 struct rpc_task
*rpc_new_task(const struct rpc_task_setup
*setup_data
)
962 struct rpc_task
*task
= setup_data
->task
;
963 unsigned short flags
= 0;
966 task
= rpc_alloc_task();
967 flags
= RPC_TASK_DYNAMIC
;
970 rpc_init_task(task
, setup_data
);
971 task
->tk_flags
|= flags
;
972 dprintk("RPC: allocated task %p\n", task
);
977 * rpc_free_task - release rpc task and perform cleanups
979 * Note that we free up the rpc_task _after_ rpc_release_calldata()
980 * in order to work around a workqueue dependency issue.
983 * "Workqueue currently considers two work items to be the same if they're
984 * on the same address and won't execute them concurrently - ie. it
985 * makes a work item which is queued again while being executed wait
986 * for the previous execution to complete.
988 * If a work function frees the work item, and then waits for an event
989 * which should be performed by another work item and *that* work item
990 * recycles the freed work item, it can create a false dependency loop.
991 * There really is no reliable way to detect this short of verifying
992 * every memory free."
995 static void rpc_free_task(struct rpc_task
*task
)
997 unsigned short tk_flags
= task
->tk_flags
;
999 rpc_release_calldata(task
->tk_ops
, task
->tk_calldata
);
1001 if (tk_flags
& RPC_TASK_DYNAMIC
) {
1002 dprintk("RPC: %5u freeing task\n", task
->tk_pid
);
1003 mempool_free(task
, rpc_task_mempool
);
1007 static void rpc_async_release(struct work_struct
*work
)
1009 rpc_free_task(container_of(work
, struct rpc_task
, u
.tk_work
));
1012 static void rpc_release_resources_task(struct rpc_task
*task
)
1015 if (task
->tk_msg
.rpc_cred
) {
1016 put_rpccred(task
->tk_msg
.rpc_cred
);
1017 task
->tk_msg
.rpc_cred
= NULL
;
1019 rpc_task_release_client(task
);
1022 static void rpc_final_put_task(struct rpc_task
*task
,
1023 struct workqueue_struct
*q
)
1026 INIT_WORK(&task
->u
.tk_work
, rpc_async_release
);
1027 queue_work(q
, &task
->u
.tk_work
);
1029 rpc_free_task(task
);
1032 static void rpc_do_put_task(struct rpc_task
*task
, struct workqueue_struct
*q
)
1034 if (atomic_dec_and_test(&task
->tk_count
)) {
1035 rpc_release_resources_task(task
);
1036 rpc_final_put_task(task
, q
);
1040 void rpc_put_task(struct rpc_task
*task
)
1042 rpc_do_put_task(task
, NULL
);
1044 EXPORT_SYMBOL_GPL(rpc_put_task
);
1046 void rpc_put_task_async(struct rpc_task
*task
)
1048 rpc_do_put_task(task
, task
->tk_workqueue
);
1050 EXPORT_SYMBOL_GPL(rpc_put_task_async
);
1052 static void rpc_release_task(struct rpc_task
*task
)
1054 dprintk("RPC: %5u release task\n", task
->tk_pid
);
1056 WARN_ON_ONCE(RPC_IS_QUEUED(task
));
1058 rpc_release_resources_task(task
);
1061 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
1062 * so it should be safe to use task->tk_count as a test for whether
1063 * or not any other processes still hold references to our rpc_task.
1065 if (atomic_read(&task
->tk_count
) != 1 + !RPC_IS_ASYNC(task
)) {
1066 /* Wake up anyone who may be waiting for task completion */
1067 if (!rpc_complete_task(task
))
1070 if (!atomic_dec_and_test(&task
->tk_count
))
1073 rpc_final_put_task(task
, task
->tk_workqueue
);
1078 return try_module_get(THIS_MODULE
) ? 0 : -EINVAL
;
1081 void rpciod_down(void)
1083 module_put(THIS_MODULE
);
1087 * Start up the rpciod workqueue.
1089 static int rpciod_start(void)
1091 struct workqueue_struct
*wq
;
1094 * Create the rpciod thread and wait for it to start.
1096 dprintk("RPC: creating workqueue rpciod\n");
1097 wq
= alloc_workqueue("rpciod", WQ_MEM_RECLAIM
, 0);
1100 rpciod_workqueue
= wq
;
1101 /* Note: highpri because network receive is latency sensitive */
1102 wq
= alloc_workqueue("xprtiod", WQ_MEM_RECLAIM
| WQ_HIGHPRI
, 0);
1105 xprtiod_workqueue
= wq
;
1108 wq
= rpciod_workqueue
;
1109 rpciod_workqueue
= NULL
;
1110 destroy_workqueue(wq
);
1115 static void rpciod_stop(void)
1117 struct workqueue_struct
*wq
= NULL
;
1119 if (rpciod_workqueue
== NULL
)
1121 dprintk("RPC: destroying workqueue rpciod\n");
1123 wq
= rpciod_workqueue
;
1124 rpciod_workqueue
= NULL
;
1125 destroy_workqueue(wq
);
1126 wq
= xprtiod_workqueue
;
1127 xprtiod_workqueue
= NULL
;
1128 destroy_workqueue(wq
);
1132 rpc_destroy_mempool(void)
1135 mempool_destroy(rpc_buffer_mempool
);
1136 mempool_destroy(rpc_task_mempool
);
1137 kmem_cache_destroy(rpc_task_slabp
);
1138 kmem_cache_destroy(rpc_buffer_slabp
);
1139 rpc_destroy_wait_queue(&delay_queue
);
1143 rpc_init_mempool(void)
1146 * The following is not strictly a mempool initialisation,
1147 * but there is no harm in doing it here
1149 rpc_init_wait_queue(&delay_queue
, "delayq");
1150 if (!rpciod_start())
1153 rpc_task_slabp
= kmem_cache_create("rpc_tasks",
1154 sizeof(struct rpc_task
),
1155 0, SLAB_HWCACHE_ALIGN
,
1157 if (!rpc_task_slabp
)
1159 rpc_buffer_slabp
= kmem_cache_create("rpc_buffers",
1161 0, SLAB_HWCACHE_ALIGN
,
1163 if (!rpc_buffer_slabp
)
1165 rpc_task_mempool
= mempool_create_slab_pool(RPC_TASK_POOLSIZE
,
1167 if (!rpc_task_mempool
)
1169 rpc_buffer_mempool
= mempool_create_slab_pool(RPC_BUFFER_POOLSIZE
,
1171 if (!rpc_buffer_mempool
)
1175 rpc_destroy_mempool();