GNU Linux-libre 4.19.286-gnu1
[releases.git] / kernel / sched / idle.c
1 /*
2  * Generic entry points for the idle threads and
3  * implementation of the idle task scheduling class.
4  *
5  * (NOTE: these are not related to SCHED_IDLE batch scheduled
6  *        tasks which are handled in sched/fair.c )
7  */
8 #include "sched.h"
9
10 #include <trace/events/power.h>
11
12 /* Linker adds these: start and end of __cpuidle functions */
13 extern char __cpuidle_text_start[], __cpuidle_text_end[];
14
15 /**
16  * sched_idle_set_state - Record idle state for the current CPU.
17  * @idle_state: State to record.
18  */
19 void sched_idle_set_state(struct cpuidle_state *idle_state)
20 {
21         idle_set_state(this_rq(), idle_state);
22 }
23
24 static int __read_mostly cpu_idle_force_poll;
25
26 void cpu_idle_poll_ctrl(bool enable)
27 {
28         if (enable) {
29                 cpu_idle_force_poll++;
30         } else {
31                 cpu_idle_force_poll--;
32                 WARN_ON_ONCE(cpu_idle_force_poll < 0);
33         }
34 }
35
36 #ifdef CONFIG_GENERIC_IDLE_POLL_SETUP
37 static int __init cpu_idle_poll_setup(char *__unused)
38 {
39         cpu_idle_force_poll = 1;
40
41         return 1;
42 }
43 __setup("nohlt", cpu_idle_poll_setup);
44
45 static int __init cpu_idle_nopoll_setup(char *__unused)
46 {
47         cpu_idle_force_poll = 0;
48
49         return 1;
50 }
51 __setup("hlt", cpu_idle_nopoll_setup);
52 #endif
53
54 static noinline int __cpuidle cpu_idle_poll(void)
55 {
56         rcu_idle_enter();
57         trace_cpu_idle_rcuidle(0, smp_processor_id());
58         local_irq_enable();
59         stop_critical_timings();
60
61         while (!tif_need_resched() &&
62                 (cpu_idle_force_poll || tick_check_broadcast_expired()))
63                 cpu_relax();
64         start_critical_timings();
65         trace_cpu_idle_rcuidle(PWR_EVENT_EXIT, smp_processor_id());
66         rcu_idle_exit();
67
68         return 1;
69 }
70
71 /* Weak implementations for optional arch specific functions */
72 void __weak arch_cpu_idle_prepare(void) { }
73 void __weak arch_cpu_idle_enter(void) { }
74 void __weak arch_cpu_idle_exit(void) { }
75 void __weak arch_cpu_idle_dead(void) { }
76 void __weak arch_cpu_idle(void)
77 {
78         cpu_idle_force_poll = 1;
79         local_irq_enable();
80 }
81
82 /**
83  * default_idle_call - Default CPU idle routine.
84  *
85  * To use when the cpuidle framework cannot be used.
86  */
87 void __cpuidle default_idle_call(void)
88 {
89         if (current_clr_polling_and_test()) {
90                 local_irq_enable();
91         } else {
92                 stop_critical_timings();
93                 arch_cpu_idle();
94                 start_critical_timings();
95         }
96 }
97
98 static int call_cpuidle(struct cpuidle_driver *drv, struct cpuidle_device *dev,
99                       int next_state)
100 {
101         /*
102          * The idle task must be scheduled, it is pointless to go to idle, just
103          * update no idle residency and return.
104          */
105         if (current_clr_polling_and_test()) {
106                 dev->last_residency = 0;
107                 local_irq_enable();
108                 return -EBUSY;
109         }
110
111         /*
112          * Enter the idle state previously returned by the governor decision.
113          * This function will block until an interrupt occurs and will take
114          * care of re-enabling the local interrupts
115          */
116         return cpuidle_enter(drv, dev, next_state);
117 }
118
119 /**
120  * cpuidle_idle_call - the main idle function
121  *
122  * NOTE: no locks or semaphores should be used here
123  *
124  * On archs that support TIF_POLLING_NRFLAG, is called with polling
125  * set, and it returns with polling set.  If it ever stops polling, it
126  * must clear the polling bit.
127  */
128 static void cpuidle_idle_call(void)
129 {
130         struct cpuidle_device *dev = cpuidle_get_device();
131         struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
132         int next_state, entered_state;
133
134         /*
135          * Check if the idle task must be rescheduled. If it is the
136          * case, exit the function after re-enabling the local irq.
137          */
138         if (need_resched()) {
139                 local_irq_enable();
140                 return;
141         }
142
143         /*
144          * The RCU framework needs to be told that we are entering an idle
145          * section, so no more rcu read side critical sections and one more
146          * step to the grace period
147          */
148
149         if (cpuidle_not_available(drv, dev)) {
150                 tick_nohz_idle_stop_tick();
151                 rcu_idle_enter();
152
153                 default_idle_call();
154                 goto exit_idle;
155         }
156
157         /*
158          * Suspend-to-idle ("s2idle") is a system state in which all user space
159          * has been frozen, all I/O devices have been suspended and the only
160          * activity happens here and in iterrupts (if any).  In that case bypass
161          * the cpuidle governor and go stratight for the deepest idle state
162          * available.  Possibly also suspend the local tick and the entire
163          * timekeeping to prevent timer interrupts from kicking us out of idle
164          * until a proper wakeup interrupt happens.
165          */
166
167         if (idle_should_enter_s2idle() || dev->use_deepest_state) {
168                 if (idle_should_enter_s2idle()) {
169                         rcu_idle_enter();
170
171                         entered_state = cpuidle_enter_s2idle(drv, dev);
172                         if (entered_state > 0) {
173                                 local_irq_enable();
174                                 goto exit_idle;
175                         }
176
177                         rcu_idle_exit();
178                 }
179
180                 tick_nohz_idle_stop_tick();
181                 rcu_idle_enter();
182
183                 next_state = cpuidle_find_deepest_state(drv, dev);
184                 call_cpuidle(drv, dev, next_state);
185         } else {
186                 bool stop_tick = true;
187
188                 /*
189                  * Ask the cpuidle framework to choose a convenient idle state.
190                  */
191                 next_state = cpuidle_select(drv, dev, &stop_tick);
192
193                 if (stop_tick || tick_nohz_tick_stopped())
194                         tick_nohz_idle_stop_tick();
195                 else
196                         tick_nohz_idle_retain_tick();
197
198                 rcu_idle_enter();
199
200                 entered_state = call_cpuidle(drv, dev, next_state);
201                 /*
202                  * Give the governor an opportunity to reflect on the outcome
203                  */
204                 cpuidle_reflect(dev, entered_state);
205         }
206
207 exit_idle:
208         __current_set_polling();
209
210         /*
211          * It is up to the idle functions to reenable local interrupts
212          */
213         if (WARN_ON_ONCE(irqs_disabled()))
214                 local_irq_enable();
215
216         rcu_idle_exit();
217 }
218
219 /*
220  * Generic idle loop implementation
221  *
222  * Called with polling cleared.
223  */
224 static void do_idle(void)
225 {
226         int cpu = smp_processor_id();
227         /*
228          * If the arch has a polling bit, we maintain an invariant:
229          *
230          * Our polling bit is clear if we're not scheduled (i.e. if rq->curr !=
231          * rq->idle). This means that, if rq->idle has the polling bit set,
232          * then setting need_resched is guaranteed to cause the CPU to
233          * reschedule.
234          */
235
236         __current_set_polling();
237         tick_nohz_idle_enter();
238
239         while (!need_resched()) {
240                 check_pgt_cache();
241                 rmb();
242
243                 local_irq_disable();
244
245                 if (cpu_is_offline(cpu)) {
246                         tick_nohz_idle_stop_tick();
247                         cpuhp_report_idle_dead();
248                         arch_cpu_idle_dead();
249                 }
250
251                 arch_cpu_idle_enter();
252
253                 /*
254                  * In poll mode we reenable interrupts and spin. Also if we
255                  * detected in the wakeup from idle path that the tick
256                  * broadcast device expired for us, we don't want to go deep
257                  * idle as we know that the IPI is going to arrive right away.
258                  */
259                 if (cpu_idle_force_poll || tick_check_broadcast_expired()) {
260                         tick_nohz_idle_restart_tick();
261                         cpu_idle_poll();
262                 } else {
263                         cpuidle_idle_call();
264                 }
265                 arch_cpu_idle_exit();
266         }
267
268         /*
269          * Since we fell out of the loop above, we know TIF_NEED_RESCHED must
270          * be set, propagate it into PREEMPT_NEED_RESCHED.
271          *
272          * This is required because for polling idle loops we will not have had
273          * an IPI to fold the state for us.
274          */
275         preempt_set_need_resched();
276         tick_nohz_idle_exit();
277         __current_clr_polling();
278
279         /*
280          * We promise to call sched_ttwu_pending() and reschedule if
281          * need_resched() is set while polling is set. That means that clearing
282          * polling needs to be visible before doing these things.
283          */
284         smp_mb__after_atomic();
285
286         sched_ttwu_pending();
287         schedule_idle();
288
289         if (unlikely(klp_patch_pending(current)))
290                 klp_update_patch_state(current);
291 }
292
293 bool cpu_in_idle(unsigned long pc)
294 {
295         return pc >= (unsigned long)__cpuidle_text_start &&
296                 pc < (unsigned long)__cpuidle_text_end;
297 }
298
299 struct idle_timer {
300         struct hrtimer timer;
301         int done;
302 };
303
304 static enum hrtimer_restart idle_inject_timer_fn(struct hrtimer *timer)
305 {
306         struct idle_timer *it = container_of(timer, struct idle_timer, timer);
307
308         WRITE_ONCE(it->done, 1);
309         set_tsk_need_resched(current);
310
311         return HRTIMER_NORESTART;
312 }
313
314 void play_idle(unsigned long duration_ms)
315 {
316         struct idle_timer it;
317
318         /*
319          * Only FIFO tasks can disable the tick since they don't need the forced
320          * preemption.
321          */
322         WARN_ON_ONCE(current->policy != SCHED_FIFO);
323         WARN_ON_ONCE(current->nr_cpus_allowed != 1);
324         WARN_ON_ONCE(!(current->flags & PF_KTHREAD));
325         WARN_ON_ONCE(!(current->flags & PF_NO_SETAFFINITY));
326         WARN_ON_ONCE(!duration_ms);
327
328         rcu_sleep_check();
329         preempt_disable();
330         current->flags |= PF_IDLE;
331         cpuidle_use_deepest_state(true);
332
333         it.done = 0;
334         hrtimer_init_on_stack(&it.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
335         it.timer.function = idle_inject_timer_fn;
336         hrtimer_start(&it.timer, ms_to_ktime(duration_ms), HRTIMER_MODE_REL_PINNED);
337
338         while (!READ_ONCE(it.done))
339                 do_idle();
340
341         cpuidle_use_deepest_state(false);
342         current->flags &= ~PF_IDLE;
343
344         preempt_fold_need_resched();
345         preempt_enable();
346 }
347 EXPORT_SYMBOL_GPL(play_idle);
348
349 void cpu_startup_entry(enum cpuhp_state state)
350 {
351         /*
352          * This #ifdef needs to die, but it's too late in the cycle to
353          * make this generic (ARM and SH have never invoked the canary
354          * init for the non boot CPUs!). Will be fixed in 3.11
355          */
356 #ifdef CONFIG_X86
357         /*
358          * If we're the non-boot CPU, nothing set the stack canary up
359          * for us. The boot CPU already has it initialized but no harm
360          * in doing it again. This is a good place for updating it, as
361          * we wont ever return from this function (so the invalid
362          * canaries already on the stack wont ever trigger).
363          */
364         boot_init_stack_canary();
365 #endif
366         arch_cpu_idle_prepare();
367         cpuhp_online_idle(state);
368         while (1)
369                 do_idle();
370 }
371
372 /*
373  * idle-task scheduling class.
374  */
375
376 #ifdef CONFIG_SMP
377 static int
378 select_task_rq_idle(struct task_struct *p, int cpu, int sd_flag, int flags)
379 {
380         return task_cpu(p); /* IDLE tasks as never migrated */
381 }
382 #endif
383
384 /*
385  * Idle tasks are unconditionally rescheduled:
386  */
387 static void check_preempt_curr_idle(struct rq *rq, struct task_struct *p, int flags)
388 {
389         resched_curr(rq);
390 }
391
392 static struct task_struct *
393 pick_next_task_idle(struct rq *rq, struct task_struct *prev, struct rq_flags *rf)
394 {
395         put_prev_task(rq, prev);
396         update_idle_core(rq);
397         schedstat_inc(rq->sched_goidle);
398
399         return rq->idle;
400 }
401
402 /*
403  * It is not legal to sleep in the idle task - print a warning
404  * message if some code attempts to do it:
405  */
406 static void
407 dequeue_task_idle(struct rq *rq, struct task_struct *p, int flags)
408 {
409         raw_spin_unlock_irq(&rq->lock);
410         printk(KERN_ERR "bad: scheduling from the idle thread!\n");
411         dump_stack();
412         raw_spin_lock_irq(&rq->lock);
413 }
414
415 static void put_prev_task_idle(struct rq *rq, struct task_struct *prev)
416 {
417 }
418
419 /*
420  * scheduler tick hitting a task of our scheduling class.
421  *
422  * NOTE: This function can be called remotely by the tick offload that
423  * goes along full dynticks. Therefore no local assumption can be made
424  * and everything must be accessed through the @rq and @curr passed in
425  * parameters.
426  */
427 static void task_tick_idle(struct rq *rq, struct task_struct *curr, int queued)
428 {
429 }
430
431 static void set_curr_task_idle(struct rq *rq)
432 {
433 }
434
435 static void switched_to_idle(struct rq *rq, struct task_struct *p)
436 {
437         BUG();
438 }
439
440 static void
441 prio_changed_idle(struct rq *rq, struct task_struct *p, int oldprio)
442 {
443         BUG();
444 }
445
446 static unsigned int get_rr_interval_idle(struct rq *rq, struct task_struct *task)
447 {
448         return 0;
449 }
450
451 static void update_curr_idle(struct rq *rq)
452 {
453 }
454
455 /*
456  * Simple, special scheduling class for the per-CPU idle tasks:
457  */
458 const struct sched_class idle_sched_class = {
459         /* .next is NULL */
460         /* no enqueue/yield_task for idle tasks */
461
462         /* dequeue is not valid, we print a debug message there: */
463         .dequeue_task           = dequeue_task_idle,
464
465         .check_preempt_curr     = check_preempt_curr_idle,
466
467         .pick_next_task         = pick_next_task_idle,
468         .put_prev_task          = put_prev_task_idle,
469
470 #ifdef CONFIG_SMP
471         .select_task_rq         = select_task_rq_idle,
472         .set_cpus_allowed       = set_cpus_allowed_common,
473 #endif
474
475         .set_curr_task          = set_curr_task_idle,
476         .task_tick              = task_tick_idle,
477
478         .get_rr_interval        = get_rr_interval_idle,
479
480         .prio_changed           = prio_changed_idle,
481         .switched_to            = switched_to_idle,
482         .update_curr            = update_curr_idle,
483 };