1 // SPDX-License-Identifier: GPL-2.0-only
3  * Generic entry points for the idle threads and
4  * implementation of the idle task scheduling class.
14  * sched_idle_set_state - Record idle state for the current CPU.
15  * @idle_state: State to record.
29 		cpu_idle_force_poll--;  in cpu_idle_poll_ctrl()
85  * default_idle_call - Default CPU idle routine.
111 		return -EBUSY;  in call_cpuidle_s2idle()
120 	 * The idle task must be scheduled, it is pointless to go to idle, just  in call_cpuidle()
121 	 * update no idle residency and return.  in call_cpuidle()
124 		dev->last_residency_ns = 0;  in call_cpuidle()
126 		return -EBUSY;  in call_cpuidle()
130 	 * Enter the idle state previously returned by the governor decision.  in call_cpuidle()
132 	 * care of re-enabling the local interrupts  in call_cpuidle()
138  * cpuidle_idle_call - the main idle function
153 	 * Check if the idle task must be rescheduled. If it is the  in cpuidle_idle_call()
154 	 * case, exit the function after re-enabling the local irq.  in cpuidle_idle_call()
162 	 * The RCU framework needs to be told that we are entering an idle  in cpuidle_idle_call()
175 	 * Suspend-to-idle ("s2idle") is a system state in which all user space  in cpuidle_idle_call()
178 	 * the cpuidle governor and go straight for the deepest idle state  in cpuidle_idle_call()
180 	 * timekeeping to prevent timer interrupts from kicking us out of idle  in cpuidle_idle_call()
184 	if (idle_should_enter_s2idle() || dev->forced_idle_latency_limit_ns) {  in cpuidle_idle_call()
195 			max_latency_ns = dev->forced_idle_latency_limit_ns;  in cpuidle_idle_call()
206 		 * Ask the cpuidle framework to choose a convenient idle state.  in cpuidle_idle_call()
226 	 * It is up to the idle functions to reenable local interrupts  in cpuidle_idle_call()
233  * Generic idle loop implementation
249 	 * Our polling bit is clear if we're not scheduled (i.e. if rq->curr !=  in do_idle()
250 	 * rq->idle). This means that, if rq->idle has the polling bit set,  in do_idle()
262 		 * Interrupts shouldn't be re-enabled from that point on until  in do_idle()
270 		 * - SLEEP-UNTIL-PENDING-INTERRUPT based instructions such as  in do_idle()
274 		 * - sti;mwait() couple is fine because the interrupts are  in do_idle()
275 		 *   re-enabled only upon the execution of mwait, leaving no gap  in do_idle()
276 		 *   in-between.  in do_idle()
278 		 * - ROLLBACK based idle handlers with the sleeping instruction  in do_idle()
280 		 *   when the interrupt detects it has interrupted an idle handler,  in do_idle()
282 		 *   need_resched() check before re-executing the sleeping  in do_idle()
285 		 *   appropriate CPU sleeping instruction, then a FAST-FORWARD  in do_idle()
287 		 *   interrupted an idle handler, it must resume to the end of  in do_idle()
288 		 *   this idle handler so that the generic idle loop is iterated  in do_idle()
304 		 * detected in the wakeup from idle path that the tick  in do_idle()
306 		 * idle as we know that the IPI is going to arrive right away.  in do_idle()
321 	 * This is required because for polling idle loops we will not have had  in do_idle()
322 	 * an IPI to fold the state for us.  in do_idle()
336 	 * RCU relies on this call to be done outside of an RCU read-side  in do_idle()
361 	WRITE_ONCE(it->done, 1);  in idle_inject_timer_fn()
375 	WARN_ON_ONCE(current->policy != SCHED_FIFO);  in play_idle_precise()
376 	WARN_ON_ONCE(current->nr_cpus_allowed != 1);  in play_idle_precise()
377 	WARN_ON_ONCE(!(current->flags & PF_KTHREAD));  in play_idle_precise()
378 	WARN_ON_ONCE(!(current->flags & PF_NO_SETAFFINITY));  in play_idle_precise()
380 	WARN_ON_ONCE(current->mm);  in play_idle_precise()
384 	current->flags |= PF_IDLE;  in play_idle_precise()
397 	current->flags &= ~PF_IDLE;  in play_idle_precise()
404 void cpu_startup_entry(enum cpuhp_state state)  in cpu_startup_entry()  argument
406 	current->flags |= PF_IDLE;  in cpu_startup_entry()
408 	cpuhp_online_idle(state);  in cpu_startup_entry()
414  * idle-task scheduling class.
421 	return task_cpu(p); /* IDLE tasks as never migrated */  in select_task_rq_idle()
432  * Idle tasks are unconditionally rescheduled:
446 	schedstat_inc(rq->sched_goidle);  in set_next_task_idle()
452 	return rq->idle;  in pick_task_idle()
458 	struct task_struct *next = rq->idle;  in pick_next_task_idle()
466  * It is not legal to sleep in the idle task - print a warning
473 	printk(KERN_ERR "bad: scheduling from the idle thread!\n");  in dequeue_task_idle()
506  * Simple, special scheduling class for the per-CPU idle tasks:
508 DEFINE_SCHED_CLASS(idle) = {
510 	/* no enqueue/yield_task for idle tasks */