1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/net/sunrpc/sched.c
5 * Scheduling for synchronous and asynchronous RPC requests.
7 * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
9 * TCP NFS related read + write fixes
10 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
13 #include <linux/module.h>
15 #include <linux/sched.h>
16 #include <linux/interrupt.h>
17 #include <linux/slab.h>
18 #include <linux/mempool.h>
19 #include <linux/smp.h>
20 #include <linux/spinlock.h>
21 #include <linux/mutex.h>
22 #include <linux/freezer.h>
23 #include <linux/sched/mm.h>
25 #include <linux/sunrpc/clnt.h>
26 #include <linux/sunrpc/metrics.h>
30 #define CREATE_TRACE_POINTS
31 #include <trace/events/sunrpc.h>
34 * RPC slabs and memory pools
36 #define RPC_BUFFER_MAXSIZE (2048)
37 #define RPC_BUFFER_POOLSIZE (8)
38 #define RPC_TASK_POOLSIZE (8)
39 static struct kmem_cache
*rpc_task_slabp __read_mostly
;
40 static struct kmem_cache
*rpc_buffer_slabp __read_mostly
;
41 static mempool_t
*rpc_task_mempool __read_mostly
;
42 static mempool_t
*rpc_buffer_mempool __read_mostly
;
44 static void rpc_async_schedule(struct work_struct
*);
45 static void rpc_release_task(struct rpc_task
*task
);
46 static void __rpc_queue_timer_fn(struct work_struct
*);
49 * RPC tasks sit here while waiting for conditions to improve.
51 static struct rpc_wait_queue delay_queue
;
54 * rpciod-related stuff
56 struct workqueue_struct
*rpciod_workqueue __read_mostly
;
57 struct workqueue_struct
*xprtiod_workqueue __read_mostly
;
58 EXPORT_SYMBOL_GPL(xprtiod_workqueue
);
60 gfp_t
rpc_task_gfp_mask(void)
62 if (current
->flags
& PF_WQ_WORKER
)
63 return GFP_KERNEL
| __GFP_NORETRY
| __GFP_NOWARN
;
66 EXPORT_SYMBOL_GPL(rpc_task_gfp_mask
);
68 bool rpc_task_set_rpc_status(struct rpc_task
*task
, int rpc_status
)
70 if (cmpxchg(&task
->tk_rpc_status
, 0, rpc_status
) == 0)
76 rpc_task_timeout(const struct rpc_task
*task
)
78 unsigned long timeout
= READ_ONCE(task
->tk_timeout
);
81 unsigned long now
= jiffies
;
82 if (time_before(now
, timeout
))
87 EXPORT_SYMBOL_GPL(rpc_task_timeout
);
90 * Disable the timer for a given RPC task. Should be called with
91 * queue->lock and bh_disabled in order to avoid races within
95 __rpc_disable_timer(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
97 if (list_empty(&task
->u
.tk_wait
.timer_list
))
100 list_del(&task
->u
.tk_wait
.timer_list
);
101 if (list_empty(&queue
->timer_list
.list
))
102 cancel_delayed_work(&queue
->timer_list
.dwork
);
106 rpc_set_queue_timer(struct rpc_wait_queue
*queue
, unsigned long expires
)
108 unsigned long now
= jiffies
;
109 queue
->timer_list
.expires
= expires
;
110 if (time_before_eq(expires
, now
))
114 mod_delayed_work(rpciod_workqueue
, &queue
->timer_list
.dwork
, expires
);
118 * Set up a timer for the current task.
121 __rpc_add_timer(struct rpc_wait_queue
*queue
, struct rpc_task
*task
,
122 unsigned long timeout
)
124 task
->tk_timeout
= timeout
;
125 if (list_empty(&queue
->timer_list
.list
) || time_before(timeout
, queue
->timer_list
.expires
))
126 rpc_set_queue_timer(queue
, timeout
);
127 list_add(&task
->u
.tk_wait
.timer_list
, &queue
->timer_list
.list
);
130 static void rpc_set_waitqueue_priority(struct rpc_wait_queue
*queue
, int priority
)
132 if (queue
->priority
!= priority
) {
133 queue
->priority
= priority
;
134 queue
->nr
= 1U << priority
;
138 static void rpc_reset_waitqueue_priority(struct rpc_wait_queue
*queue
)
140 rpc_set_waitqueue_priority(queue
, queue
->maxpriority
);
144 * Add a request to a queue list
147 __rpc_list_enqueue_task(struct list_head
*q
, struct rpc_task
*task
)
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
.links
,
154 &t
->u
.tk_wait
.links
);
155 /* Cache the queue head in task->u.tk_wait.list */
156 task
->u
.tk_wait
.list
.next
= q
;
157 task
->u
.tk_wait
.list
.prev
= NULL
;
161 INIT_LIST_HEAD(&task
->u
.tk_wait
.links
);
162 list_add_tail(&task
->u
.tk_wait
.list
, q
);
166 * Remove request from a queue list
169 __rpc_list_dequeue_task(struct rpc_task
*task
)
174 if (task
->u
.tk_wait
.list
.prev
== NULL
) {
175 list_del(&task
->u
.tk_wait
.links
);
178 if (!list_empty(&task
->u
.tk_wait
.links
)) {
179 t
= list_first_entry(&task
->u
.tk_wait
.links
,
182 /* Assume __rpc_list_enqueue_task() cached the queue head */
183 q
= t
->u
.tk_wait
.list
.next
;
184 list_add_tail(&t
->u
.tk_wait
.list
, q
);
185 list_del(&task
->u
.tk_wait
.links
);
187 list_del(&task
->u
.tk_wait
.list
);
191 * Add new request to a priority queue.
193 static void __rpc_add_wait_queue_priority(struct rpc_wait_queue
*queue
,
194 struct rpc_task
*task
,
195 unsigned char queue_priority
)
197 if (unlikely(queue_priority
> queue
->maxpriority
))
198 queue_priority
= queue
->maxpriority
;
199 __rpc_list_enqueue_task(&queue
->tasks
[queue_priority
], task
);
203 * Add new request to wait queue.
205 static void __rpc_add_wait_queue(struct rpc_wait_queue
*queue
,
206 struct rpc_task
*task
,
207 unsigned char queue_priority
)
209 INIT_LIST_HEAD(&task
->u
.tk_wait
.timer_list
);
210 if (RPC_IS_PRIORITY(queue
))
211 __rpc_add_wait_queue_priority(queue
, task
, queue_priority
);
213 list_add_tail(&task
->u
.tk_wait
.list
, &queue
->tasks
[0]);
214 task
->tk_waitqueue
= queue
;
216 /* barrier matches the read in rpc_wake_up_task_queue_locked() */
218 rpc_set_queued(task
);
222 * Remove request from a priority queue.
224 static void __rpc_remove_wait_queue_priority(struct rpc_task
*task
)
226 __rpc_list_dequeue_task(task
);
230 * Remove request from queue.
231 * Note: must be called with spin lock held.
233 static void __rpc_remove_wait_queue(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
235 __rpc_disable_timer(queue
, task
);
236 if (RPC_IS_PRIORITY(queue
))
237 __rpc_remove_wait_queue_priority(task
);
239 list_del(&task
->u
.tk_wait
.list
);
243 static void __rpc_init_priority_wait_queue(struct rpc_wait_queue
*queue
, const char *qname
, unsigned char nr_queues
)
247 spin_lock_init(&queue
->lock
);
248 for (i
= 0; i
< ARRAY_SIZE(queue
->tasks
); i
++)
249 INIT_LIST_HEAD(&queue
->tasks
[i
]);
250 queue
->maxpriority
= nr_queues
- 1;
251 rpc_reset_waitqueue_priority(queue
);
253 queue
->timer_list
.expires
= 0;
254 INIT_DELAYED_WORK(&queue
->timer_list
.dwork
, __rpc_queue_timer_fn
);
255 INIT_LIST_HEAD(&queue
->timer_list
.list
);
256 rpc_assign_waitqueue_name(queue
, qname
);
259 void rpc_init_priority_wait_queue(struct rpc_wait_queue
*queue
, const char *qname
)
261 __rpc_init_priority_wait_queue(queue
, qname
, RPC_NR_PRIORITY
);
263 EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue
);
265 void rpc_init_wait_queue(struct rpc_wait_queue
*queue
, const char *qname
)
267 __rpc_init_priority_wait_queue(queue
, qname
, 1);
269 EXPORT_SYMBOL_GPL(rpc_init_wait_queue
);
271 void rpc_destroy_wait_queue(struct rpc_wait_queue
*queue
)
273 cancel_delayed_work_sync(&queue
->timer_list
.dwork
);
275 EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue
);
277 static int rpc_wait_bit_killable(struct wait_bit_key
*key
, int mode
)
280 if (signal_pending_state(mode
, current
))
285 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
286 static void rpc_task_set_debuginfo(struct rpc_task
*task
)
288 struct rpc_clnt
*clnt
= task
->tk_client
;
290 /* Might be a task carrying a reverse-direction operation */
292 static atomic_t rpc_pid
;
294 task
->tk_pid
= atomic_inc_return(&rpc_pid
);
298 task
->tk_pid
= atomic_inc_return(&clnt
->cl_pid
);
301 static inline void rpc_task_set_debuginfo(struct rpc_task
*task
)
306 static void rpc_set_active(struct rpc_task
*task
)
308 rpc_task_set_debuginfo(task
);
309 set_bit(RPC_TASK_ACTIVE
, &task
->tk_runstate
);
310 trace_rpc_task_begin(task
, NULL
);
314 * Mark an RPC call as having completed by clearing the 'active' bit
315 * and then waking up all tasks that were sleeping.
317 static int rpc_complete_task(struct rpc_task
*task
)
319 void *m
= &task
->tk_runstate
;
320 wait_queue_head_t
*wq
= bit_waitqueue(m
, RPC_TASK_ACTIVE
);
321 struct wait_bit_key k
= __WAIT_BIT_KEY_INITIALIZER(m
, RPC_TASK_ACTIVE
);
325 trace_rpc_task_complete(task
, NULL
);
327 spin_lock_irqsave(&wq
->lock
, flags
);
328 clear_bit(RPC_TASK_ACTIVE
, &task
->tk_runstate
);
329 ret
= atomic_dec_and_test(&task
->tk_count
);
330 if (waitqueue_active(wq
))
331 __wake_up_locked_key(wq
, TASK_NORMAL
, &k
);
332 spin_unlock_irqrestore(&wq
->lock
, flags
);
337 * Allow callers to wait for completion of an RPC call
339 * Note the use of out_of_line_wait_on_bit() rather than wait_on_bit()
340 * to enforce taking of the wq->lock and hence avoid races with
341 * rpc_complete_task().
343 int rpc_wait_for_completion_task(struct rpc_task
*task
)
345 return out_of_line_wait_on_bit(&task
->tk_runstate
, RPC_TASK_ACTIVE
,
346 rpc_wait_bit_killable
, TASK_KILLABLE
|TASK_FREEZABLE_UNSAFE
);
348 EXPORT_SYMBOL_GPL(rpc_wait_for_completion_task
);
351 * Make an RPC task runnable.
353 * Note: If the task is ASYNC, and is being made runnable after sitting on an
354 * rpc_wait_queue, this must be called with the queue spinlock held to protect
355 * the wait queue operation.
356 * Note the ordering of rpc_test_and_set_running() and rpc_clear_queued(),
357 * which is needed to ensure that __rpc_execute() doesn't loop (due to the
358 * lockless RPC_IS_QUEUED() test) before we've had a chance to test
359 * the RPC_TASK_RUNNING flag.
361 static void rpc_make_runnable(struct workqueue_struct
*wq
,
362 struct rpc_task
*task
)
364 bool need_wakeup
= !rpc_test_and_set_running(task
);
366 rpc_clear_queued(task
);
369 if (RPC_IS_ASYNC(task
)) {
370 INIT_WORK(&task
->u
.tk_work
, rpc_async_schedule
);
371 queue_work(wq
, &task
->u
.tk_work
);
373 smp_mb__after_atomic();
374 wake_up_bit(&task
->tk_runstate
, RPC_TASK_QUEUED
);
379 * Prepare for sleeping on a wait queue.
380 * By always appending tasks to the list we ensure FIFO behavior.
381 * NB: An RPC task will only receive interrupt-driven events as long
382 * as it's on a wait queue.
384 static void __rpc_do_sleep_on_priority(struct rpc_wait_queue
*q
,
385 struct rpc_task
*task
,
386 unsigned char queue_priority
)
388 trace_rpc_task_sleep(task
, q
);
390 __rpc_add_wait_queue(q
, task
, queue_priority
);
393 static void __rpc_sleep_on_priority(struct rpc_wait_queue
*q
,
394 struct rpc_task
*task
,
395 unsigned char queue_priority
)
397 if (WARN_ON_ONCE(RPC_IS_QUEUED(task
)))
399 __rpc_do_sleep_on_priority(q
, task
, queue_priority
);
402 static void __rpc_sleep_on_priority_timeout(struct rpc_wait_queue
*q
,
403 struct rpc_task
*task
, unsigned long timeout
,
404 unsigned char queue_priority
)
406 if (WARN_ON_ONCE(RPC_IS_QUEUED(task
)))
408 if (time_is_after_jiffies(timeout
)) {
409 __rpc_do_sleep_on_priority(q
, task
, queue_priority
);
410 __rpc_add_timer(q
, task
, timeout
);
412 task
->tk_status
= -ETIMEDOUT
;
415 static void rpc_set_tk_callback(struct rpc_task
*task
, rpc_action action
)
417 if (action
&& !WARN_ON_ONCE(task
->tk_callback
!= NULL
))
418 task
->tk_callback
= action
;
421 static bool rpc_sleep_check_activated(struct rpc_task
*task
)
423 /* We shouldn't ever put an inactive task to sleep */
424 if (WARN_ON_ONCE(!RPC_IS_ACTIVATED(task
))) {
425 task
->tk_status
= -EIO
;
426 rpc_put_task_async(task
);
432 void rpc_sleep_on_timeout(struct rpc_wait_queue
*q
, struct rpc_task
*task
,
433 rpc_action action
, unsigned long timeout
)
435 if (!rpc_sleep_check_activated(task
))
438 rpc_set_tk_callback(task
, action
);
441 * Protect the queue operations.
444 __rpc_sleep_on_priority_timeout(q
, task
, timeout
, task
->tk_priority
);
445 spin_unlock(&q
->lock
);
447 EXPORT_SYMBOL_GPL(rpc_sleep_on_timeout
);
449 void rpc_sleep_on(struct rpc_wait_queue
*q
, struct rpc_task
*task
,
452 if (!rpc_sleep_check_activated(task
))
455 rpc_set_tk_callback(task
, action
);
457 WARN_ON_ONCE(task
->tk_timeout
!= 0);
459 * Protect the queue operations.
462 __rpc_sleep_on_priority(q
, task
, task
->tk_priority
);
463 spin_unlock(&q
->lock
);
465 EXPORT_SYMBOL_GPL(rpc_sleep_on
);
467 void rpc_sleep_on_priority_timeout(struct rpc_wait_queue
*q
,
468 struct rpc_task
*task
, unsigned long timeout
, int priority
)
470 if (!rpc_sleep_check_activated(task
))
473 priority
-= RPC_PRIORITY_LOW
;
475 * Protect the queue operations.
478 __rpc_sleep_on_priority_timeout(q
, task
, timeout
, priority
);
479 spin_unlock(&q
->lock
);
481 EXPORT_SYMBOL_GPL(rpc_sleep_on_priority_timeout
);
483 void rpc_sleep_on_priority(struct rpc_wait_queue
*q
, struct rpc_task
*task
,
486 if (!rpc_sleep_check_activated(task
))
489 WARN_ON_ONCE(task
->tk_timeout
!= 0);
490 priority
-= RPC_PRIORITY_LOW
;
492 * Protect the queue operations.
495 __rpc_sleep_on_priority(q
, task
, priority
);
496 spin_unlock(&q
->lock
);
498 EXPORT_SYMBOL_GPL(rpc_sleep_on_priority
);
501 * __rpc_do_wake_up_task_on_wq - wake up a single rpc_task
502 * @wq: workqueue on which to run task
504 * @task: task to be woken up
506 * Caller must hold queue->lock, and have cleared the task queued flag.
508 static void __rpc_do_wake_up_task_on_wq(struct workqueue_struct
*wq
,
509 struct rpc_wait_queue
*queue
,
510 struct rpc_task
*task
)
512 /* Has the task been executed yet? If not, we cannot wake it up! */
513 if (!RPC_IS_ACTIVATED(task
)) {
514 printk(KERN_ERR
"RPC: Inactive task (%p) being woken up!\n", task
);
518 trace_rpc_task_wakeup(task
, queue
);
520 __rpc_remove_wait_queue(queue
, task
);
522 rpc_make_runnable(wq
, task
);
526 * Wake up a queued task while the queue lock is being held
528 static struct rpc_task
*
529 rpc_wake_up_task_on_wq_queue_action_locked(struct workqueue_struct
*wq
,
530 struct rpc_wait_queue
*queue
, struct rpc_task
*task
,
531 bool (*action
)(struct rpc_task
*, void *), void *data
)
533 if (RPC_IS_QUEUED(task
)) {
535 if (task
->tk_waitqueue
== queue
) {
536 if (action
== NULL
|| action(task
, data
)) {
537 __rpc_do_wake_up_task_on_wq(wq
, queue
, task
);
546 * Wake up a queued task while the queue lock is being held
548 static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue
*queue
,
549 struct rpc_task
*task
)
551 rpc_wake_up_task_on_wq_queue_action_locked(rpciod_workqueue
, queue
,
556 * Wake up a task on a specific queue
558 void rpc_wake_up_queued_task(struct rpc_wait_queue
*queue
, struct rpc_task
*task
)
560 if (!RPC_IS_QUEUED(task
))
562 spin_lock(&queue
->lock
);
563 rpc_wake_up_task_queue_locked(queue
, task
);
564 spin_unlock(&queue
->lock
);
566 EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task
);
568 static bool rpc_task_action_set_status(struct rpc_task
*task
, void *status
)
570 task
->tk_status
= *(int *)status
;
575 rpc_wake_up_task_queue_set_status_locked(struct rpc_wait_queue
*queue
,
576 struct rpc_task
*task
, int status
)
578 rpc_wake_up_task_on_wq_queue_action_locked(rpciod_workqueue
, queue
,
579 task
, rpc_task_action_set_status
, &status
);
583 * rpc_wake_up_queued_task_set_status - wake up a task and set task->tk_status
584 * @queue: pointer to rpc_wait_queue
585 * @task: pointer to rpc_task
586 * @status: integer error value
588 * If @task is queued on @queue, then it is woken up, and @task->tk_status is
589 * set to the value of @status.
592 rpc_wake_up_queued_task_set_status(struct rpc_wait_queue
*queue
,
593 struct rpc_task
*task
, int status
)
595 if (!RPC_IS_QUEUED(task
))
597 spin_lock(&queue
->lock
);
598 rpc_wake_up_task_queue_set_status_locked(queue
, task
, status
);
599 spin_unlock(&queue
->lock
);
603 * Wake up the next task on a priority queue.
605 static struct rpc_task
*__rpc_find_next_queued_priority(struct rpc_wait_queue
*queue
)
608 struct rpc_task
*task
;
611 * Service the privileged queue.
613 q
= &queue
->tasks
[RPC_NR_PRIORITY
- 1];
614 if (queue
->maxpriority
> RPC_PRIORITY_PRIVILEGED
&& !list_empty(q
)) {
615 task
= list_first_entry(q
, struct rpc_task
, u
.tk_wait
.list
);
620 * Service a batch of tasks from a single owner.
622 q
= &queue
->tasks
[queue
->priority
];
623 if (!list_empty(q
) && queue
->nr
) {
625 task
= list_first_entry(q
, struct rpc_task
, u
.tk_wait
.list
);
630 * Service the next queue.
633 if (q
== &queue
->tasks
[0])
634 q
= &queue
->tasks
[queue
->maxpriority
];
637 if (!list_empty(q
)) {
638 task
= list_first_entry(q
, struct rpc_task
, u
.tk_wait
.list
);
641 } while (q
!= &queue
->tasks
[queue
->priority
]);
643 rpc_reset_waitqueue_priority(queue
);
647 rpc_set_waitqueue_priority(queue
, (unsigned int)(q
- &queue
->tasks
[0]));
652 static struct rpc_task
*__rpc_find_next_queued(struct rpc_wait_queue
*queue
)
654 if (RPC_IS_PRIORITY(queue
))
655 return __rpc_find_next_queued_priority(queue
);
656 if (!list_empty(&queue
->tasks
[0]))
657 return list_first_entry(&queue
->tasks
[0], struct rpc_task
, u
.tk_wait
.list
);
662 * Wake up the first task on the wait queue.
664 struct rpc_task
*rpc_wake_up_first_on_wq(struct workqueue_struct
*wq
,
665 struct rpc_wait_queue
*queue
,
666 bool (*func
)(struct rpc_task
*, void *), void *data
)
668 struct rpc_task
*task
= NULL
;
670 spin_lock(&queue
->lock
);
671 task
= __rpc_find_next_queued(queue
);
673 task
= rpc_wake_up_task_on_wq_queue_action_locked(wq
, queue
,
675 spin_unlock(&queue
->lock
);
681 * Wake up the first task on the wait queue.
683 struct rpc_task
*rpc_wake_up_first(struct rpc_wait_queue
*queue
,
684 bool (*func
)(struct rpc_task
*, void *), void *data
)
686 return rpc_wake_up_first_on_wq(rpciod_workqueue
, queue
, func
, data
);
688 EXPORT_SYMBOL_GPL(rpc_wake_up_first
);
690 static bool rpc_wake_up_next_func(struct rpc_task
*task
, void *data
)
696 * Wake up the next task on the wait queue.
698 struct rpc_task
*rpc_wake_up_next(struct rpc_wait_queue
*queue
)
700 return rpc_wake_up_first(queue
, rpc_wake_up_next_func
, NULL
);
702 EXPORT_SYMBOL_GPL(rpc_wake_up_next
);
705 * rpc_wake_up_locked - wake up all rpc_tasks
706 * @queue: rpc_wait_queue on which the tasks are sleeping
709 static void rpc_wake_up_locked(struct rpc_wait_queue
*queue
)
711 struct rpc_task
*task
;
714 task
= __rpc_find_next_queued(queue
);
717 rpc_wake_up_task_queue_locked(queue
, task
);
722 * rpc_wake_up - wake up all rpc_tasks
723 * @queue: rpc_wait_queue on which the tasks are sleeping
727 void rpc_wake_up(struct rpc_wait_queue
*queue
)
729 spin_lock(&queue
->lock
);
730 rpc_wake_up_locked(queue
);
731 spin_unlock(&queue
->lock
);
733 EXPORT_SYMBOL_GPL(rpc_wake_up
);
736 * rpc_wake_up_status_locked - wake up all rpc_tasks and set their status value.
737 * @queue: rpc_wait_queue on which the tasks are sleeping
738 * @status: status value to set
740 static void rpc_wake_up_status_locked(struct rpc_wait_queue
*queue
, int status
)
742 struct rpc_task
*task
;
745 task
= __rpc_find_next_queued(queue
);
748 rpc_wake_up_task_queue_set_status_locked(queue
, task
, status
);
753 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
754 * @queue: rpc_wait_queue on which the tasks are sleeping
755 * @status: status value to set
759 void rpc_wake_up_status(struct rpc_wait_queue
*queue
, int status
)
761 spin_lock(&queue
->lock
);
762 rpc_wake_up_status_locked(queue
, status
);
763 spin_unlock(&queue
->lock
);
765 EXPORT_SYMBOL_GPL(rpc_wake_up_status
);
767 static void __rpc_queue_timer_fn(struct work_struct
*work
)
769 struct rpc_wait_queue
*queue
= container_of(work
,
770 struct rpc_wait_queue
,
771 timer_list
.dwork
.work
);
772 struct rpc_task
*task
, *n
;
773 unsigned long expires
, now
, timeo
;
775 spin_lock(&queue
->lock
);
776 expires
= now
= jiffies
;
777 list_for_each_entry_safe(task
, n
, &queue
->timer_list
.list
, u
.tk_wait
.timer_list
) {
778 timeo
= task
->tk_timeout
;
779 if (time_after_eq(now
, timeo
)) {
780 trace_rpc_task_timeout(task
, task
->tk_action
);
781 task
->tk_status
= -ETIMEDOUT
;
782 rpc_wake_up_task_queue_locked(queue
, task
);
785 if (expires
== now
|| time_after(expires
, timeo
))
788 if (!list_empty(&queue
->timer_list
.list
))
789 rpc_set_queue_timer(queue
, expires
);
790 spin_unlock(&queue
->lock
);
793 static void __rpc_atrun(struct rpc_task
*task
)
795 if (task
->tk_status
== -ETIMEDOUT
)
800 * Run a task at a later time
802 void rpc_delay(struct rpc_task
*task
, unsigned long delay
)
804 rpc_sleep_on_timeout(&delay_queue
, task
, __rpc_atrun
, jiffies
+ delay
);
806 EXPORT_SYMBOL_GPL(rpc_delay
);
809 * Helper to call task->tk_ops->rpc_call_prepare
811 void rpc_prepare_task(struct rpc_task
*task
)
813 task
->tk_ops
->rpc_call_prepare(task
, task
->tk_calldata
);
817 rpc_init_task_statistics(struct rpc_task
*task
)
819 /* Initialize retry counters */
820 task
->tk_garb_retry
= 2;
821 task
->tk_cred_retry
= 2;
823 /* starting timestamp */
824 task
->tk_start
= ktime_get();
828 rpc_reset_task_statistics(struct rpc_task
*task
)
830 task
->tk_timeouts
= 0;
831 task
->tk_flags
&= ~(RPC_CALL_MAJORSEEN
|RPC_TASK_SENT
);
832 rpc_init_task_statistics(task
);
836 * Helper that calls task->tk_ops->rpc_call_done if it exists
838 void rpc_exit_task(struct rpc_task
*task
)
840 trace_rpc_task_end(task
, task
->tk_action
);
841 task
->tk_action
= NULL
;
842 if (task
->tk_ops
->rpc_count_stats
)
843 task
->tk_ops
->rpc_count_stats(task
, task
->tk_calldata
);
844 else if (task
->tk_client
)
845 rpc_count_iostats(task
, task
->tk_client
->cl_metrics
);
846 if (task
->tk_ops
->rpc_call_done
!= NULL
) {
847 trace_rpc_task_call_done(task
, task
->tk_ops
->rpc_call_done
);
848 task
->tk_ops
->rpc_call_done(task
, task
->tk_calldata
);
849 if (task
->tk_action
!= NULL
) {
850 /* Always release the RPC slot and buffer memory */
852 rpc_reset_task_statistics(task
);
857 void rpc_signal_task(struct rpc_task
*task
)
859 struct rpc_wait_queue
*queue
;
861 if (!RPC_IS_ACTIVATED(task
))
864 if (!rpc_task_set_rpc_status(task
, -ERESTARTSYS
))
866 trace_rpc_task_signalled(task
, task
->tk_action
);
867 set_bit(RPC_TASK_SIGNALLED
, &task
->tk_runstate
);
868 smp_mb__after_atomic();
869 queue
= READ_ONCE(task
->tk_waitqueue
);
871 rpc_wake_up_queued_task(queue
, task
);
874 void rpc_task_try_cancel(struct rpc_task
*task
, int error
)
876 struct rpc_wait_queue
*queue
;
878 if (!rpc_task_set_rpc_status(task
, error
))
880 queue
= READ_ONCE(task
->tk_waitqueue
);
882 rpc_wake_up_queued_task(queue
, task
);
885 void rpc_exit(struct rpc_task
*task
, int status
)
887 task
->tk_status
= status
;
888 task
->tk_action
= rpc_exit_task
;
889 rpc_wake_up_queued_task(task
->tk_waitqueue
, task
);
891 EXPORT_SYMBOL_GPL(rpc_exit
);
893 void rpc_release_calldata(const struct rpc_call_ops
*ops
, void *calldata
)
895 if (ops
->rpc_release
!= NULL
)
896 ops
->rpc_release(calldata
);
899 static bool xprt_needs_memalloc(struct rpc_xprt
*xprt
, struct rpc_task
*tk
)
903 if (!atomic_read(&xprt
->swapper
))
905 return test_bit(XPRT_LOCKED
, &xprt
->state
) && xprt
->snd_task
== tk
;
909 * This is the RPC `scheduler' (or rather, the finite state machine).
911 static void __rpc_execute(struct rpc_task
*task
)
913 struct rpc_wait_queue
*queue
;
914 int task_is_async
= RPC_IS_ASYNC(task
);
916 unsigned long pflags
= current
->flags
;
918 WARN_ON_ONCE(RPC_IS_QUEUED(task
));
919 if (RPC_IS_QUEUED(task
))
923 void (*do_action
)(struct rpc_task
*);
926 * Perform the next FSM step or a pending callback.
928 * tk_action may be NULL if the task has been killed.
930 do_action
= task
->tk_action
;
931 /* Tasks with an RPC error status should exit */
932 if (do_action
&& do_action
!= rpc_exit_task
&&
933 (status
= READ_ONCE(task
->tk_rpc_status
)) != 0) {
934 task
->tk_status
= status
;
935 do_action
= rpc_exit_task
;
937 /* Callbacks override all actions */
938 if (task
->tk_callback
) {
939 do_action
= task
->tk_callback
;
940 task
->tk_callback
= NULL
;
944 if (RPC_IS_SWAPPER(task
) ||
945 xprt_needs_memalloc(task
->tk_xprt
, task
))
946 current
->flags
|= PF_MEMALLOC
;
948 trace_rpc_task_run_action(task
, do_action
);
952 * Lockless check for whether task is sleeping or not.
954 if (!RPC_IS_QUEUED(task
)) {
960 * The queue->lock protects against races with
961 * rpc_make_runnable().
963 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
964 * rpc_task, rpc_make_runnable() can assign it to a
965 * different workqueue. We therefore cannot assume that the
966 * rpc_task pointer may still be dereferenced.
968 queue
= task
->tk_waitqueue
;
969 spin_lock(&queue
->lock
);
970 if (!RPC_IS_QUEUED(task
)) {
971 spin_unlock(&queue
->lock
);
974 /* Wake up any task that has an exit status */
975 if (READ_ONCE(task
->tk_rpc_status
) != 0) {
976 rpc_wake_up_task_queue_locked(queue
, task
);
977 spin_unlock(&queue
->lock
);
980 rpc_clear_running(task
);
981 spin_unlock(&queue
->lock
);
985 /* sync task: sleep here */
986 trace_rpc_task_sync_sleep(task
, task
->tk_action
);
987 status
= out_of_line_wait_on_bit(&task
->tk_runstate
,
988 RPC_TASK_QUEUED
, rpc_wait_bit_killable
,
989 TASK_KILLABLE
|TASK_FREEZABLE
);
992 * When a sync task receives a signal, it exits with
993 * -ERESTARTSYS. In order to catch any callbacks that
994 * clean up after sleeping on some queue, we don't
995 * break the loop here, but go around once more.
997 rpc_signal_task(task
);
999 trace_rpc_task_sync_wake(task
, task
->tk_action
);
1002 /* Release all resources associated with the task */
1003 rpc_release_task(task
);
1005 current_restore_flags(pflags
, PF_MEMALLOC
);
1009 * User-visible entry point to the scheduler.
1011 * This may be called recursively if e.g. an async NFS task updates
1012 * the attributes and finds that dirty pages must be flushed.
1013 * NOTE: Upon exit of this function the task is guaranteed to be
1014 * released. In particular note that tk_release() will have
1015 * been called, so your task memory may have been freed.
1017 void rpc_execute(struct rpc_task
*task
)
1019 bool is_async
= RPC_IS_ASYNC(task
);
1021 rpc_set_active(task
);
1022 rpc_make_runnable(rpciod_workqueue
, task
);
1024 unsigned int pflags
= memalloc_nofs_save();
1025 __rpc_execute(task
);
1026 memalloc_nofs_restore(pflags
);
1030 static void rpc_async_schedule(struct work_struct
*work
)
1032 unsigned int pflags
= memalloc_nofs_save();
1034 __rpc_execute(container_of(work
, struct rpc_task
, u
.tk_work
));
1035 memalloc_nofs_restore(pflags
);
1039 * rpc_malloc - allocate RPC buffer resources
1042 * A single memory region is allocated, which is split between the
1043 * RPC call and RPC reply that this task is being used for. When
1044 * this RPC is retired, the memory is released by calling rpc_free.
1046 * To prevent rpciod from hanging, this allocator never sleeps,
1047 * returning -ENOMEM and suppressing warning if the request cannot
1048 * be serviced immediately. The caller can arrange to sleep in a
1049 * way that is safe for rpciod.
1051 * Most requests are 'small' (under 2KiB) and can be serviced from a
1052 * mempool, ensuring that NFS reads and writes can always proceed,
1053 * and that there is good locality of reference for these buffers.
1055 int rpc_malloc(struct rpc_task
*task
)
1057 struct rpc_rqst
*rqst
= task
->tk_rqstp
;
1058 size_t size
= rqst
->rq_callsize
+ rqst
->rq_rcvsize
;
1059 struct rpc_buffer
*buf
;
1060 gfp_t gfp
= rpc_task_gfp_mask();
1062 size
+= sizeof(struct rpc_buffer
);
1063 if (size
<= RPC_BUFFER_MAXSIZE
) {
1064 buf
= kmem_cache_alloc(rpc_buffer_slabp
, gfp
);
1065 /* Reach for the mempool if dynamic allocation fails */
1066 if (!buf
&& RPC_IS_ASYNC(task
))
1067 buf
= mempool_alloc(rpc_buffer_mempool
, GFP_NOWAIT
);
1069 buf
= kmalloc(size
, gfp
);
1075 rqst
->rq_buffer
= buf
->data
;
1076 rqst
->rq_rbuffer
= (char *)rqst
->rq_buffer
+ rqst
->rq_callsize
;
1079 EXPORT_SYMBOL_GPL(rpc_malloc
);
1082 * rpc_free - free RPC buffer resources allocated via rpc_malloc
1086 void rpc_free(struct rpc_task
*task
)
1088 void *buffer
= task
->tk_rqstp
->rq_buffer
;
1090 struct rpc_buffer
*buf
;
1092 buf
= container_of(buffer
, struct rpc_buffer
, data
);
1095 if (size
<= RPC_BUFFER_MAXSIZE
)
1096 mempool_free(buf
, rpc_buffer_mempool
);
1100 EXPORT_SYMBOL_GPL(rpc_free
);
1103 * Creation and deletion of RPC task structures
1105 static void rpc_init_task(struct rpc_task
*task
, const struct rpc_task_setup
*task_setup_data
)
1107 memset(task
, 0, sizeof(*task
));
1108 atomic_set(&task
->tk_count
, 1);
1109 task
->tk_flags
= task_setup_data
->flags
;
1110 task
->tk_ops
= task_setup_data
->callback_ops
;
1111 task
->tk_calldata
= task_setup_data
->callback_data
;
1112 INIT_LIST_HEAD(&task
->tk_task
);
1114 task
->tk_priority
= task_setup_data
->priority
- RPC_PRIORITY_LOW
;
1115 task
->tk_owner
= current
->tgid
;
1117 /* Initialize workqueue for async tasks */
1118 task
->tk_workqueue
= task_setup_data
->workqueue
;
1120 task
->tk_xprt
= rpc_task_get_xprt(task_setup_data
->rpc_client
,
1121 xprt_get(task_setup_data
->rpc_xprt
));
1123 task
->tk_op_cred
= get_rpccred(task_setup_data
->rpc_op_cred
);
1125 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
1126 task
->tk_action
= rpc_prepare_task
;
1128 rpc_init_task_statistics(task
);
1131 static struct rpc_task
*rpc_alloc_task(void)
1133 struct rpc_task
*task
;
1135 task
= kmem_cache_alloc(rpc_task_slabp
, rpc_task_gfp_mask());
1138 return mempool_alloc(rpc_task_mempool
, GFP_NOWAIT
);
1142 * Create a new task for the specified client.
1144 struct rpc_task
*rpc_new_task(const struct rpc_task_setup
*setup_data
)
1146 struct rpc_task
*task
= setup_data
->task
;
1147 unsigned short flags
= 0;
1150 task
= rpc_alloc_task();
1152 rpc_release_calldata(setup_data
->callback_ops
,
1153 setup_data
->callback_data
);
1154 return ERR_PTR(-ENOMEM
);
1156 flags
= RPC_TASK_DYNAMIC
;
1159 rpc_init_task(task
, setup_data
);
1160 task
->tk_flags
|= flags
;
1165 * rpc_free_task - release rpc task and perform cleanups
1167 * Note that we free up the rpc_task _after_ rpc_release_calldata()
1168 * in order to work around a workqueue dependency issue.
1171 * "Workqueue currently considers two work items to be the same if they're
1172 * on the same address and won't execute them concurrently - ie. it
1173 * makes a work item which is queued again while being executed wait
1174 * for the previous execution to complete.
1176 * If a work function frees the work item, and then waits for an event
1177 * which should be performed by another work item and *that* work item
1178 * recycles the freed work item, it can create a false dependency loop.
1179 * There really is no reliable way to detect this short of verifying
1180 * every memory free."
1183 static void rpc_free_task(struct rpc_task
*task
)
1185 unsigned short tk_flags
= task
->tk_flags
;
1187 put_rpccred(task
->tk_op_cred
);
1188 rpc_release_calldata(task
->tk_ops
, task
->tk_calldata
);
1190 if (tk_flags
& RPC_TASK_DYNAMIC
)
1191 mempool_free(task
, rpc_task_mempool
);
1194 static void rpc_async_release(struct work_struct
*work
)
1196 unsigned int pflags
= memalloc_nofs_save();
1198 rpc_free_task(container_of(work
, struct rpc_task
, u
.tk_work
));
1199 memalloc_nofs_restore(pflags
);
1202 static void rpc_release_resources_task(struct rpc_task
*task
)
1205 if (task
->tk_msg
.rpc_cred
) {
1206 if (!(task
->tk_flags
& RPC_TASK_CRED_NOREF
))
1207 put_cred(task
->tk_msg
.rpc_cred
);
1208 task
->tk_msg
.rpc_cred
= NULL
;
1210 rpc_task_release_client(task
);
1213 static void rpc_final_put_task(struct rpc_task
*task
,
1214 struct workqueue_struct
*q
)
1217 INIT_WORK(&task
->u
.tk_work
, rpc_async_release
);
1218 queue_work(q
, &task
->u
.tk_work
);
1220 rpc_free_task(task
);
1223 static void rpc_do_put_task(struct rpc_task
*task
, struct workqueue_struct
*q
)
1225 if (atomic_dec_and_test(&task
->tk_count
)) {
1226 rpc_release_resources_task(task
);
1227 rpc_final_put_task(task
, q
);
1231 void rpc_put_task(struct rpc_task
*task
)
1233 rpc_do_put_task(task
, NULL
);
1235 EXPORT_SYMBOL_GPL(rpc_put_task
);
1237 void rpc_put_task_async(struct rpc_task
*task
)
1239 rpc_do_put_task(task
, task
->tk_workqueue
);
1241 EXPORT_SYMBOL_GPL(rpc_put_task_async
);
1243 static void rpc_release_task(struct rpc_task
*task
)
1245 WARN_ON_ONCE(RPC_IS_QUEUED(task
));
1247 rpc_release_resources_task(task
);
1250 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
1251 * so it should be safe to use task->tk_count as a test for whether
1252 * or not any other processes still hold references to our rpc_task.
1254 if (atomic_read(&task
->tk_count
) != 1 + !RPC_IS_ASYNC(task
)) {
1255 /* Wake up anyone who may be waiting for task completion */
1256 if (!rpc_complete_task(task
))
1259 if (!atomic_dec_and_test(&task
->tk_count
))
1262 rpc_final_put_task(task
, task
->tk_workqueue
);
1267 return try_module_get(THIS_MODULE
) ? 0 : -EINVAL
;
1270 void rpciod_down(void)
1272 module_put(THIS_MODULE
);
1276 * Start up the rpciod workqueue.
1278 static int rpciod_start(void)
1280 struct workqueue_struct
*wq
;
1283 * Create the rpciod thread and wait for it to start.
1285 wq
= alloc_workqueue("rpciod", WQ_MEM_RECLAIM
| WQ_UNBOUND
, 0);
1288 rpciod_workqueue
= wq
;
1289 wq
= alloc_workqueue("xprtiod", WQ_UNBOUND
| WQ_MEM_RECLAIM
, 0);
1292 xprtiod_workqueue
= wq
;
1295 wq
= rpciod_workqueue
;
1296 rpciod_workqueue
= NULL
;
1297 destroy_workqueue(wq
);
1302 static void rpciod_stop(void)
1304 struct workqueue_struct
*wq
= NULL
;
1306 if (rpciod_workqueue
== NULL
)
1309 wq
= rpciod_workqueue
;
1310 rpciod_workqueue
= NULL
;
1311 destroy_workqueue(wq
);
1312 wq
= xprtiod_workqueue
;
1313 xprtiod_workqueue
= NULL
;
1314 destroy_workqueue(wq
);
1318 rpc_destroy_mempool(void)
1321 mempool_destroy(rpc_buffer_mempool
);
1322 mempool_destroy(rpc_task_mempool
);
1323 kmem_cache_destroy(rpc_task_slabp
);
1324 kmem_cache_destroy(rpc_buffer_slabp
);
1325 rpc_destroy_wait_queue(&delay_queue
);
1329 rpc_init_mempool(void)
1332 * The following is not strictly a mempool initialisation,
1333 * but there is no harm in doing it here
1335 rpc_init_wait_queue(&delay_queue
, "delayq");
1336 if (!rpciod_start())
1339 rpc_task_slabp
= kmem_cache_create("rpc_tasks",
1340 sizeof(struct rpc_task
),
1341 0, SLAB_HWCACHE_ALIGN
,
1343 if (!rpc_task_slabp
)
1345 rpc_buffer_slabp
= kmem_cache_create("rpc_buffers",
1347 0, SLAB_HWCACHE_ALIGN
,
1349 if (!rpc_buffer_slabp
)
1351 rpc_task_mempool
= mempool_create_slab_pool(RPC_TASK_POOLSIZE
,
1353 if (!rpc_task_mempool
)
1355 rpc_buffer_mempool
= mempool_create_slab_pool(RPC_BUFFER_POOLSIZE
,
1357 if (!rpc_buffer_mempool
)
1361 rpc_destroy_mempool();