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 wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
377 * Prepare for sleeping on a wait queue.
378 * By always appending tasks to the list we ensure FIFO behavior.
379 * NB: An RPC task will only receive interrupt-driven events as long
380 * as it's on a wait queue.
382 static void __rpc_do_sleep_on_priority(struct rpc_wait_queue *q,
383 struct rpc_task *task,
384 unsigned char queue_priority)
386 trace_rpc_task_sleep(task, q);
388 __rpc_add_wait_queue(q, task, queue_priority);
391 static void __rpc_sleep_on_priority(struct rpc_wait_queue *q,
392 struct rpc_task *task,
393 unsigned char queue_priority)
395 if (WARN_ON_ONCE(RPC_IS_QUEUED(task)))
397 __rpc_do_sleep_on_priority(q, task, queue_priority);
400 static void __rpc_sleep_on_priority_timeout(struct rpc_wait_queue *q,
401 struct rpc_task *task, unsigned long timeout,
402 unsigned char queue_priority)
404 if (WARN_ON_ONCE(RPC_IS_QUEUED(task)))
406 if (time_is_after_jiffies(timeout)) {
407 __rpc_do_sleep_on_priority(q, task, queue_priority);
408 __rpc_add_timer(q, task, timeout);
410 task->tk_status = -ETIMEDOUT;
413 static void rpc_set_tk_callback(struct rpc_task *task, rpc_action action)
415 if (action && !WARN_ON_ONCE(task->tk_callback != NULL))
416 task->tk_callback = action;
419 static bool rpc_sleep_check_activated(struct rpc_task *task)
421 /* We shouldn't ever put an inactive task to sleep */
422 if (WARN_ON_ONCE(!RPC_IS_ACTIVATED(task))) {
423 task->tk_status = -EIO;
424 rpc_put_task_async(task);
430 void rpc_sleep_on_timeout(struct rpc_wait_queue *q, struct rpc_task *task,
431 rpc_action action, unsigned long timeout)
433 if (!rpc_sleep_check_activated(task))
436 rpc_set_tk_callback(task, action);
439 * Protect the queue operations.
442 __rpc_sleep_on_priority_timeout(q, task, timeout, task->tk_priority);
443 spin_unlock(&q->lock);
445 EXPORT_SYMBOL_GPL(rpc_sleep_on_timeout);
447 void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
450 if (!rpc_sleep_check_activated(task))
453 rpc_set_tk_callback(task, action);
455 WARN_ON_ONCE(task->tk_timeout != 0);
457 * Protect the queue operations.
460 __rpc_sleep_on_priority(q, task, task->tk_priority);
461 spin_unlock(&q->lock);
463 EXPORT_SYMBOL_GPL(rpc_sleep_on);
465 void rpc_sleep_on_priority_timeout(struct rpc_wait_queue *q,
466 struct rpc_task *task, unsigned long timeout, int priority)
468 if (!rpc_sleep_check_activated(task))
471 priority -= RPC_PRIORITY_LOW;
473 * Protect the queue operations.
476 __rpc_sleep_on_priority_timeout(q, task, timeout, priority);
477 spin_unlock(&q->lock);
479 EXPORT_SYMBOL_GPL(rpc_sleep_on_priority_timeout);
481 void rpc_sleep_on_priority(struct rpc_wait_queue *q, struct rpc_task *task,
484 if (!rpc_sleep_check_activated(task))
487 WARN_ON_ONCE(task->tk_timeout != 0);
488 priority -= RPC_PRIORITY_LOW;
490 * Protect the queue operations.
493 __rpc_sleep_on_priority(q, task, priority);
494 spin_unlock(&q->lock);
496 EXPORT_SYMBOL_GPL(rpc_sleep_on_priority);
499 * __rpc_do_wake_up_task_on_wq - wake up a single rpc_task
500 * @wq: workqueue on which to run task
502 * @task: task to be woken up
504 * Caller must hold queue->lock, and have cleared the task queued flag.
506 static void __rpc_do_wake_up_task_on_wq(struct workqueue_struct *wq,
507 struct rpc_wait_queue *queue,
508 struct rpc_task *task)
510 /* Has the task been executed yet? If not, we cannot wake it up! */
511 if (!RPC_IS_ACTIVATED(task)) {
512 printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
516 trace_rpc_task_wakeup(task, queue);
518 __rpc_remove_wait_queue(queue, task);
520 rpc_make_runnable(wq, task);
524 * Wake up a queued task while the queue lock is being held
526 static struct rpc_task *
527 rpc_wake_up_task_on_wq_queue_action_locked(struct workqueue_struct *wq,
528 struct rpc_wait_queue *queue, struct rpc_task *task,
529 bool (*action)(struct rpc_task *, void *), void *data)
531 if (RPC_IS_QUEUED(task)) {
533 if (task->tk_waitqueue == queue) {
534 if (action == NULL || action(task, data)) {
535 __rpc_do_wake_up_task_on_wq(wq, queue, task);
544 * Wake up a queued task while the queue lock is being held
546 static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue,
547 struct rpc_task *task)
549 rpc_wake_up_task_on_wq_queue_action_locked(rpciod_workqueue, queue,
554 * Wake up a task on a specific queue
556 void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
558 if (!RPC_IS_QUEUED(task))
560 spin_lock(&queue->lock);
561 rpc_wake_up_task_queue_locked(queue, task);
562 spin_unlock(&queue->lock);
564 EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
566 static bool rpc_task_action_set_status(struct rpc_task *task, void *status)
568 task->tk_status = *(int *)status;
573 rpc_wake_up_task_queue_set_status_locked(struct rpc_wait_queue *queue,
574 struct rpc_task *task, int status)
576 rpc_wake_up_task_on_wq_queue_action_locked(rpciod_workqueue, queue,
577 task, rpc_task_action_set_status, &status);
581 * rpc_wake_up_queued_task_set_status - wake up a task and set task->tk_status
582 * @queue: pointer to rpc_wait_queue
583 * @task: pointer to rpc_task
584 * @status: integer error value
586 * If @task is queued on @queue, then it is woken up, and @task->tk_status is
587 * set to the value of @status.
590 rpc_wake_up_queued_task_set_status(struct rpc_wait_queue *queue,
591 struct rpc_task *task, int status)
593 if (!RPC_IS_QUEUED(task))
595 spin_lock(&queue->lock);
596 rpc_wake_up_task_queue_set_status_locked(queue, task, status);
597 spin_unlock(&queue->lock);
601 * Wake up the next task on a priority queue.
603 static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
606 struct rpc_task *task;
609 * Service the privileged queue.
611 q = &queue->tasks[RPC_NR_PRIORITY - 1];
612 if (queue->maxpriority > RPC_PRIORITY_PRIVILEGED && !list_empty(q)) {
613 task = list_first_entry(q, struct rpc_task, u.tk_wait.list);
618 * Service a batch of tasks from a single owner.
620 q = &queue->tasks[queue->priority];
621 if (!list_empty(q) && queue->nr) {
623 task = list_first_entry(q, struct rpc_task, u.tk_wait.list);
628 * Service the next queue.
631 if (q == &queue->tasks[0])
632 q = &queue->tasks[queue->maxpriority];
635 if (!list_empty(q)) {
636 task = list_first_entry(q, struct rpc_task, u.tk_wait.list);
639 } while (q != &queue->tasks[queue->priority]);
641 rpc_reset_waitqueue_priority(queue);
645 rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
650 static struct rpc_task *__rpc_find_next_queued(struct rpc_wait_queue *queue)
652 if (RPC_IS_PRIORITY(queue))
653 return __rpc_find_next_queued_priority(queue);
654 if (!list_empty(&queue->tasks[0]))
655 return list_first_entry(&queue->tasks[0], struct rpc_task, u.tk_wait.list);
660 * Wake up the first task on the wait queue.
662 struct rpc_task *rpc_wake_up_first_on_wq(struct workqueue_struct *wq,
663 struct rpc_wait_queue *queue,
664 bool (*func)(struct rpc_task *, void *), void *data)
666 struct rpc_task *task = NULL;
668 spin_lock(&queue->lock);
669 task = __rpc_find_next_queued(queue);
671 task = rpc_wake_up_task_on_wq_queue_action_locked(wq, queue,
673 spin_unlock(&queue->lock);
679 * Wake up the first task on the wait queue.
681 struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
682 bool (*func)(struct rpc_task *, void *), void *data)
684 return rpc_wake_up_first_on_wq(rpciod_workqueue, queue, func, data);
686 EXPORT_SYMBOL_GPL(rpc_wake_up_first);
688 static bool rpc_wake_up_next_func(struct rpc_task *task, void *data)
694 * Wake up the next task on the wait queue.
696 struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *queue)
698 return rpc_wake_up_first(queue, rpc_wake_up_next_func, NULL);
700 EXPORT_SYMBOL_GPL(rpc_wake_up_next);
703 * rpc_wake_up_locked - wake up all rpc_tasks
704 * @queue: rpc_wait_queue on which the tasks are sleeping
707 static void rpc_wake_up_locked(struct rpc_wait_queue *queue)
709 struct rpc_task *task;
712 task = __rpc_find_next_queued(queue);
715 rpc_wake_up_task_queue_locked(queue, task);
720 * rpc_wake_up - wake up all rpc_tasks
721 * @queue: rpc_wait_queue on which the tasks are sleeping
725 void rpc_wake_up(struct rpc_wait_queue *queue)
727 spin_lock(&queue->lock);
728 rpc_wake_up_locked(queue);
729 spin_unlock(&queue->lock);
731 EXPORT_SYMBOL_GPL(rpc_wake_up);
734 * rpc_wake_up_status_locked - wake up all rpc_tasks and set their status value.
735 * @queue: rpc_wait_queue on which the tasks are sleeping
736 * @status: status value to set
738 static void rpc_wake_up_status_locked(struct rpc_wait_queue *queue, int status)
740 struct rpc_task *task;
743 task = __rpc_find_next_queued(queue);
746 rpc_wake_up_task_queue_set_status_locked(queue, task, status);
751 * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
752 * @queue: rpc_wait_queue on which the tasks are sleeping
753 * @status: status value to set
757 void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
759 spin_lock(&queue->lock);
760 rpc_wake_up_status_locked(queue, status);
761 spin_unlock(&queue->lock);
763 EXPORT_SYMBOL_GPL(rpc_wake_up_status);
765 static void __rpc_queue_timer_fn(struct work_struct *work)
767 struct rpc_wait_queue *queue = container_of(work,
768 struct rpc_wait_queue,
769 timer_list.dwork.work);
770 struct rpc_task *task, *n;
771 unsigned long expires, now, timeo;
773 spin_lock(&queue->lock);
774 expires = now = jiffies;
775 list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
776 timeo = task->tk_timeout;
777 if (time_after_eq(now, timeo)) {
778 trace_rpc_task_timeout(task, task->tk_action);
779 task->tk_status = -ETIMEDOUT;
780 rpc_wake_up_task_queue_locked(queue, task);
783 if (expires == now || time_after(expires, timeo))
786 if (!list_empty(&queue->timer_list.list))
787 rpc_set_queue_timer(queue, expires);
788 spin_unlock(&queue->lock);
791 static void __rpc_atrun(struct rpc_task *task)
793 if (task->tk_status == -ETIMEDOUT)
798 * Run a task at a later time
800 void rpc_delay(struct rpc_task *task, unsigned long delay)
802 rpc_sleep_on_timeout(&delay_queue, task, __rpc_atrun, jiffies + delay);
804 EXPORT_SYMBOL_GPL(rpc_delay);
807 * Helper to call task->tk_ops->rpc_call_prepare
809 void rpc_prepare_task(struct rpc_task *task)
811 task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
815 rpc_init_task_statistics(struct rpc_task *task)
817 /* Initialize retry counters */
818 task->tk_garb_retry = 2;
819 task->tk_cred_retry = 2;
821 /* starting timestamp */
822 task->tk_start = ktime_get();
826 rpc_reset_task_statistics(struct rpc_task *task)
828 task->tk_timeouts = 0;
829 task->tk_flags &= ~(RPC_CALL_MAJORSEEN|RPC_TASK_SENT);
830 rpc_init_task_statistics(task);
834 * Helper that calls task->tk_ops->rpc_call_done if it exists
836 void rpc_exit_task(struct rpc_task *task)
838 trace_rpc_task_end(task, task->tk_action);
839 task->tk_action = NULL;
840 if (task->tk_ops->rpc_count_stats)
841 task->tk_ops->rpc_count_stats(task, task->tk_calldata);
842 else if (task->tk_client)
843 rpc_count_iostats(task, task->tk_client->cl_metrics);
844 if (task->tk_ops->rpc_call_done != NULL) {
845 trace_rpc_task_call_done(task, task->tk_ops->rpc_call_done);
846 task->tk_ops->rpc_call_done(task, task->tk_calldata);
847 if (task->tk_action != NULL) {
848 /* Always release the RPC slot and buffer memory */
850 rpc_reset_task_statistics(task);
855 void rpc_signal_task(struct rpc_task *task)
857 struct rpc_wait_queue *queue;
859 if (!RPC_IS_ACTIVATED(task))
862 if (!rpc_task_set_rpc_status(task, -ERESTARTSYS))
864 trace_rpc_task_signalled(task, task->tk_action);
865 set_bit(RPC_TASK_SIGNALLED, &task->tk_runstate);
866 smp_mb__after_atomic();
867 queue = READ_ONCE(task->tk_waitqueue);
869 rpc_wake_up_queued_task(queue, task);
872 void rpc_task_try_cancel(struct rpc_task *task, int error)
874 struct rpc_wait_queue *queue;
876 if (!rpc_task_set_rpc_status(task, error))
878 queue = READ_ONCE(task->tk_waitqueue);
880 rpc_wake_up_queued_task(queue, task);
883 void rpc_exit(struct rpc_task *task, int status)
885 task->tk_status = status;
886 task->tk_action = rpc_exit_task;
887 rpc_wake_up_queued_task(task->tk_waitqueue, task);
889 EXPORT_SYMBOL_GPL(rpc_exit);
891 void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
893 if (ops->rpc_release != NULL)
894 ops->rpc_release(calldata);
897 static bool xprt_needs_memalloc(struct rpc_xprt *xprt, struct rpc_task *tk)
901 if (!atomic_read(&xprt->swapper))
903 return test_bit(XPRT_LOCKED, &xprt->state) && xprt->snd_task == tk;
907 * This is the RPC `scheduler' (or rather, the finite state machine).
909 static void __rpc_execute(struct rpc_task *task)
911 struct rpc_wait_queue *queue;
912 int task_is_async = RPC_IS_ASYNC(task);
914 unsigned long pflags = current->flags;
916 WARN_ON_ONCE(RPC_IS_QUEUED(task));
917 if (RPC_IS_QUEUED(task))
921 void (*do_action)(struct rpc_task *);
924 * Perform the next FSM step or a pending callback.
926 * tk_action may be NULL if the task has been killed.
928 do_action = task->tk_action;
929 /* Tasks with an RPC error status should exit */
930 if (do_action != rpc_exit_task &&
931 (status = READ_ONCE(task->tk_rpc_status)) != 0) {
932 task->tk_status = status;
933 if (do_action != NULL)
934 do_action = rpc_exit_task;
936 /* Callbacks override all actions */
937 if (task->tk_callback) {
938 do_action = task->tk_callback;
939 task->tk_callback = NULL;
943 if (RPC_IS_SWAPPER(task) ||
944 xprt_needs_memalloc(task->tk_xprt, task))
945 current->flags |= PF_MEMALLOC;
947 trace_rpc_task_run_action(task, do_action);
951 * Lockless check for whether task is sleeping or not.
953 if (!RPC_IS_QUEUED(task)) {
959 * The queue->lock protects against races with
960 * rpc_make_runnable().
962 * Note that once we clear RPC_TASK_RUNNING on an asynchronous
963 * rpc_task, rpc_make_runnable() can assign it to a
964 * different workqueue. We therefore cannot assume that the
965 * rpc_task pointer may still be dereferenced.
967 queue = task->tk_waitqueue;
968 spin_lock(&queue->lock);
969 if (!RPC_IS_QUEUED(task)) {
970 spin_unlock(&queue->lock);
973 /* Wake up any task that has an exit status */
974 if (READ_ONCE(task->tk_rpc_status) != 0) {
975 rpc_wake_up_task_queue_locked(queue, task);
976 spin_unlock(&queue->lock);
979 rpc_clear_running(task);
980 spin_unlock(&queue->lock);
984 /* sync task: sleep here */
985 trace_rpc_task_sync_sleep(task, task->tk_action);
986 status = out_of_line_wait_on_bit(&task->tk_runstate,
987 RPC_TASK_QUEUED, rpc_wait_bit_killable,
988 TASK_KILLABLE|TASK_FREEZABLE);
991 * When a sync task receives a signal, it exits with
992 * -ERESTARTSYS. In order to catch any callbacks that
993 * clean up after sleeping on some queue, we don't
994 * break the loop here, but go around once more.
996 rpc_signal_task(task);
998 trace_rpc_task_sync_wake(task, task->tk_action);
1001 /* Release all resources associated with the task */
1002 rpc_release_task(task);
1004 current_restore_flags(pflags, PF_MEMALLOC);
1008 * User-visible entry point to the scheduler.
1010 * This may be called recursively if e.g. an async NFS task updates
1011 * the attributes and finds that dirty pages must be flushed.
1012 * NOTE: Upon exit of this function the task is guaranteed to be
1013 * released. In particular note that tk_release() will have
1014 * been called, so your task memory may have been freed.
1016 void rpc_execute(struct rpc_task *task)
1018 bool is_async = RPC_IS_ASYNC(task);
1020 rpc_set_active(task);
1021 rpc_make_runnable(rpciod_workqueue, task);
1023 unsigned int pflags = memalloc_nofs_save();
1024 __rpc_execute(task);
1025 memalloc_nofs_restore(pflags);
1029 static void rpc_async_schedule(struct work_struct *work)
1031 unsigned int pflags = memalloc_nofs_save();
1033 __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
1034 memalloc_nofs_restore(pflags);
1038 * rpc_malloc - allocate RPC buffer resources
1041 * A single memory region is allocated, which is split between the
1042 * RPC call and RPC reply that this task is being used for. When
1043 * this RPC is retired, the memory is released by calling rpc_free.
1045 * To prevent rpciod from hanging, this allocator never sleeps,
1046 * returning -ENOMEM and suppressing warning if the request cannot
1047 * be serviced immediately. The caller can arrange to sleep in a
1048 * way that is safe for rpciod.
1050 * Most requests are 'small' (under 2KiB) and can be serviced from a
1051 * mempool, ensuring that NFS reads and writes can always proceed,
1052 * and that there is good locality of reference for these buffers.
1054 int rpc_malloc(struct rpc_task *task)
1056 struct rpc_rqst *rqst = task->tk_rqstp;
1057 size_t size = rqst->rq_callsize + rqst->rq_rcvsize;
1058 struct rpc_buffer *buf;
1059 gfp_t gfp = rpc_task_gfp_mask();
1061 size += sizeof(struct rpc_buffer);
1062 if (size <= RPC_BUFFER_MAXSIZE) {
1063 buf = kmem_cache_alloc(rpc_buffer_slabp, gfp);
1064 /* Reach for the mempool if dynamic allocation fails */
1065 if (!buf && RPC_IS_ASYNC(task))
1066 buf = mempool_alloc(rpc_buffer_mempool, GFP_NOWAIT);
1068 buf = kmalloc(size, gfp);
1074 rqst->rq_buffer = buf->data;
1075 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize;
1078 EXPORT_SYMBOL_GPL(rpc_malloc);
1081 * rpc_free - free RPC buffer resources allocated via rpc_malloc
1085 void rpc_free(struct rpc_task *task)
1087 void *buffer = task->tk_rqstp->rq_buffer;
1089 struct rpc_buffer *buf;
1091 buf = container_of(buffer, struct rpc_buffer, data);
1094 if (size <= RPC_BUFFER_MAXSIZE)
1095 mempool_free(buf, rpc_buffer_mempool);
1099 EXPORT_SYMBOL_GPL(rpc_free);
1102 * Creation and deletion of RPC task structures
1104 static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
1106 memset(task, 0, sizeof(*task));
1107 atomic_set(&task->tk_count, 1);
1108 task->tk_flags = task_setup_data->flags;
1109 task->tk_ops = task_setup_data->callback_ops;
1110 task->tk_calldata = task_setup_data->callback_data;
1111 INIT_LIST_HEAD(&task->tk_task);
1113 task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
1114 task->tk_owner = current->tgid;
1116 /* Initialize workqueue for async tasks */
1117 task->tk_workqueue = task_setup_data->workqueue;
1119 task->tk_xprt = rpc_task_get_xprt(task_setup_data->rpc_client,
1120 xprt_get(task_setup_data->rpc_xprt));
1122 task->tk_op_cred = get_rpccred(task_setup_data->rpc_op_cred);
1124 if (task->tk_ops->rpc_call_prepare != NULL)
1125 task->tk_action = rpc_prepare_task;
1127 rpc_init_task_statistics(task);
1130 static struct rpc_task *rpc_alloc_task(void)
1132 struct rpc_task *task;
1134 task = kmem_cache_alloc(rpc_task_slabp, rpc_task_gfp_mask());
1137 return mempool_alloc(rpc_task_mempool, GFP_NOWAIT);
1141 * Create a new task for the specified client.
1143 struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
1145 struct rpc_task *task = setup_data->task;
1146 unsigned short flags = 0;
1149 task = rpc_alloc_task();
1151 rpc_release_calldata(setup_data->callback_ops,
1152 setup_data->callback_data);
1153 return ERR_PTR(-ENOMEM);
1155 flags = RPC_TASK_DYNAMIC;
1158 rpc_init_task(task, setup_data);
1159 task->tk_flags |= flags;
1164 * rpc_free_task - release rpc task and perform cleanups
1166 * Note that we free up the rpc_task _after_ rpc_release_calldata()
1167 * in order to work around a workqueue dependency issue.
1170 * "Workqueue currently considers two work items to be the same if they're
1171 * on the same address and won't execute them concurrently - ie. it
1172 * makes a work item which is queued again while being executed wait
1173 * for the previous execution to complete.
1175 * If a work function frees the work item, and then waits for an event
1176 * which should be performed by another work item and *that* work item
1177 * recycles the freed work item, it can create a false dependency loop.
1178 * There really is no reliable way to detect this short of verifying
1179 * every memory free."
1182 static void rpc_free_task(struct rpc_task *task)
1184 unsigned short tk_flags = task->tk_flags;
1186 put_rpccred(task->tk_op_cred);
1187 rpc_release_calldata(task->tk_ops, task->tk_calldata);
1189 if (tk_flags & RPC_TASK_DYNAMIC)
1190 mempool_free(task, rpc_task_mempool);
1193 static void rpc_async_release(struct work_struct *work)
1195 unsigned int pflags = memalloc_nofs_save();
1197 rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
1198 memalloc_nofs_restore(pflags);
1201 static void rpc_release_resources_task(struct rpc_task *task)
1204 if (task->tk_msg.rpc_cred) {
1205 if (!(task->tk_flags & RPC_TASK_CRED_NOREF))
1206 put_cred(task->tk_msg.rpc_cred);
1207 task->tk_msg.rpc_cred = NULL;
1209 rpc_task_release_client(task);
1212 static void rpc_final_put_task(struct rpc_task *task,
1213 struct workqueue_struct *q)
1216 INIT_WORK(&task->u.tk_work, rpc_async_release);
1217 queue_work(q, &task->u.tk_work);
1219 rpc_free_task(task);
1222 static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
1224 if (atomic_dec_and_test(&task->tk_count)) {
1225 rpc_release_resources_task(task);
1226 rpc_final_put_task(task, q);
1230 void rpc_put_task(struct rpc_task *task)
1232 rpc_do_put_task(task, NULL);
1234 EXPORT_SYMBOL_GPL(rpc_put_task);
1236 void rpc_put_task_async(struct rpc_task *task)
1238 rpc_do_put_task(task, task->tk_workqueue);
1240 EXPORT_SYMBOL_GPL(rpc_put_task_async);
1242 static void rpc_release_task(struct rpc_task *task)
1244 WARN_ON_ONCE(RPC_IS_QUEUED(task));
1246 rpc_release_resources_task(task);
1249 * Note: at this point we have been removed from rpc_clnt->cl_tasks,
1250 * so it should be safe to use task->tk_count as a test for whether
1251 * or not any other processes still hold references to our rpc_task.
1253 if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
1254 /* Wake up anyone who may be waiting for task completion */
1255 if (!rpc_complete_task(task))
1258 if (!atomic_dec_and_test(&task->tk_count))
1261 rpc_final_put_task(task, task->tk_workqueue);
1266 return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
1269 void rpciod_down(void)
1271 module_put(THIS_MODULE);
1275 * Start up the rpciod workqueue.
1277 static int rpciod_start(void)
1279 struct workqueue_struct *wq;
1282 * Create the rpciod thread and wait for it to start.
1284 wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM | WQ_UNBOUND, 0);
1287 rpciod_workqueue = wq;
1288 wq = alloc_workqueue("xprtiod", WQ_UNBOUND | WQ_MEM_RECLAIM, 0);
1291 xprtiod_workqueue = wq;
1294 wq = rpciod_workqueue;
1295 rpciod_workqueue = NULL;
1296 destroy_workqueue(wq);
1301 static void rpciod_stop(void)
1303 struct workqueue_struct *wq = NULL;
1305 if (rpciod_workqueue == NULL)
1308 wq = rpciod_workqueue;
1309 rpciod_workqueue = NULL;
1310 destroy_workqueue(wq);
1311 wq = xprtiod_workqueue;
1312 xprtiod_workqueue = NULL;
1313 destroy_workqueue(wq);
1317 rpc_destroy_mempool(void)
1320 mempool_destroy(rpc_buffer_mempool);
1321 mempool_destroy(rpc_task_mempool);
1322 kmem_cache_destroy(rpc_task_slabp);
1323 kmem_cache_destroy(rpc_buffer_slabp);
1324 rpc_destroy_wait_queue(&delay_queue);
1328 rpc_init_mempool(void)
1331 * The following is not strictly a mempool initialisation,
1332 * but there is no harm in doing it here
1334 rpc_init_wait_queue(&delay_queue, "delayq");
1335 if (!rpciod_start())
1338 rpc_task_slabp = kmem_cache_create("rpc_tasks",
1339 sizeof(struct rpc_task),
1340 0, SLAB_HWCACHE_ALIGN,
1342 if (!rpc_task_slabp)
1344 rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
1346 0, SLAB_HWCACHE_ALIGN,
1348 if (!rpc_buffer_slabp)
1350 rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
1352 if (!rpc_task_mempool)
1354 rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
1356 if (!rpc_buffer_mempool)
1360 rpc_destroy_mempool();