Merge tag 'armsoc-soc' of git://git.kernel.org/pub/scm/linux/kernel/git/arm/arm-soc
[platform/kernel/linux-rpi.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          * Tell the RCU framework we are entering an idle section,
145          * so no more rcu read side critical sections and one more
146          * step to the grace period
147          */
148         rcu_idle_enter();
149
150         if (cpuidle_not_available(drv, dev)) {
151                 default_idle_call();
152                 goto exit_idle;
153         }
154
155         /*
156          * Suspend-to-idle ("s2idle") is a system state in which all user space
157          * has been frozen, all I/O devices have been suspended and the only
158          * activity happens here and in iterrupts (if any).  In that case bypass
159          * the cpuidle governor and go stratight for the deepest idle state
160          * available.  Possibly also suspend the local tick and the entire
161          * timekeeping to prevent timer interrupts from kicking us out of idle
162          * until a proper wakeup interrupt happens.
163          */
164
165         if (idle_should_enter_s2idle() || dev->use_deepest_state) {
166                 if (idle_should_enter_s2idle()) {
167                         entered_state = cpuidle_enter_s2idle(drv, dev);
168                         if (entered_state > 0) {
169                                 local_irq_enable();
170                                 goto exit_idle;
171                         }
172                 }
173
174                 next_state = cpuidle_find_deepest_state(drv, dev);
175                 call_cpuidle(drv, dev, next_state);
176         } else {
177                 /*
178                  * Ask the cpuidle framework to choose a convenient idle state.
179                  */
180                 next_state = cpuidle_select(drv, dev);
181                 entered_state = call_cpuidle(drv, dev, next_state);
182                 /*
183                  * Give the governor an opportunity to reflect on the outcome
184                  */
185                 cpuidle_reflect(dev, entered_state);
186         }
187
188 exit_idle:
189         __current_set_polling();
190
191         /*
192          * It is up to the idle functions to reenable local interrupts
193          */
194         if (WARN_ON_ONCE(irqs_disabled()))
195                 local_irq_enable();
196
197         rcu_idle_exit();
198 }
199
200 /*
201  * Generic idle loop implementation
202  *
203  * Called with polling cleared.
204  */
205 static void do_idle(void)
206 {
207         int cpu = smp_processor_id();
208         /*
209          * If the arch has a polling bit, we maintain an invariant:
210          *
211          * Our polling bit is clear if we're not scheduled (i.e. if rq->curr !=
212          * rq->idle). This means that, if rq->idle has the polling bit set,
213          * then setting need_resched is guaranteed to cause the CPU to
214          * reschedule.
215          */
216
217         __current_set_polling();
218         tick_nohz_idle_enter();
219
220         while (!need_resched()) {
221                 check_pgt_cache();
222                 rmb();
223
224                 if (cpu_is_offline(cpu)) {
225                         cpuhp_report_idle_dead();
226                         arch_cpu_idle_dead();
227                 }
228
229                 local_irq_disable();
230                 arch_cpu_idle_enter();
231
232                 /*
233                  * In poll mode we reenable interrupts and spin. Also if we
234                  * detected in the wakeup from idle path that the tick
235                  * broadcast device expired for us, we don't want to go deep
236                  * idle as we know that the IPI is going to arrive right away.
237                  */
238                 if (cpu_idle_force_poll || tick_check_broadcast_expired())
239                         cpu_idle_poll();
240                 else
241                         cpuidle_idle_call();
242                 arch_cpu_idle_exit();
243         }
244
245         /*
246          * Since we fell out of the loop above, we know TIF_NEED_RESCHED must
247          * be set, propagate it into PREEMPT_NEED_RESCHED.
248          *
249          * This is required because for polling idle loops we will not have had
250          * an IPI to fold the state for us.
251          */
252         preempt_set_need_resched();
253         tick_nohz_idle_exit();
254         __current_clr_polling();
255
256         /*
257          * We promise to call sched_ttwu_pending() and reschedule if
258          * need_resched() is set while polling is set. That means that clearing
259          * polling needs to be visible before doing these things.
260          */
261         smp_mb__after_atomic();
262
263         sched_ttwu_pending();
264         schedule_idle();
265
266         if (unlikely(klp_patch_pending(current)))
267                 klp_update_patch_state(current);
268 }
269
270 bool cpu_in_idle(unsigned long pc)
271 {
272         return pc >= (unsigned long)__cpuidle_text_start &&
273                 pc < (unsigned long)__cpuidle_text_end;
274 }
275
276 struct idle_timer {
277         struct hrtimer timer;
278         int done;
279 };
280
281 static enum hrtimer_restart idle_inject_timer_fn(struct hrtimer *timer)
282 {
283         struct idle_timer *it = container_of(timer, struct idle_timer, timer);
284
285         WRITE_ONCE(it->done, 1);
286         set_tsk_need_resched(current);
287
288         return HRTIMER_NORESTART;
289 }
290
291 void play_idle(unsigned long duration_ms)
292 {
293         struct idle_timer it;
294
295         /*
296          * Only FIFO tasks can disable the tick since they don't need the forced
297          * preemption.
298          */
299         WARN_ON_ONCE(current->policy != SCHED_FIFO);
300         WARN_ON_ONCE(current->nr_cpus_allowed != 1);
301         WARN_ON_ONCE(!(current->flags & PF_KTHREAD));
302         WARN_ON_ONCE(!(current->flags & PF_NO_SETAFFINITY));
303         WARN_ON_ONCE(!duration_ms);
304
305         rcu_sleep_check();
306         preempt_disable();
307         current->flags |= PF_IDLE;
308         cpuidle_use_deepest_state(true);
309
310         it.done = 0;
311         hrtimer_init_on_stack(&it.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
312         it.timer.function = idle_inject_timer_fn;
313         hrtimer_start(&it.timer, ms_to_ktime(duration_ms), HRTIMER_MODE_REL_PINNED);
314
315         while (!READ_ONCE(it.done))
316                 do_idle();
317
318         cpuidle_use_deepest_state(false);
319         current->flags &= ~PF_IDLE;
320
321         preempt_fold_need_resched();
322         preempt_enable();
323 }
324 EXPORT_SYMBOL_GPL(play_idle);
325
326 void cpu_startup_entry(enum cpuhp_state state)
327 {
328         /*
329          * This #ifdef needs to die, but it's too late in the cycle to
330          * make this generic (ARM and SH have never invoked the canary
331          * init for the non boot CPUs!). Will be fixed in 3.11
332          */
333 #ifdef CONFIG_X86
334         /*
335          * If we're the non-boot CPU, nothing set the stack canary up
336          * for us. The boot CPU already has it initialized but no harm
337          * in doing it again. This is a good place for updating it, as
338          * we wont ever return from this function (so the invalid
339          * canaries already on the stack wont ever trigger).
340          */
341         boot_init_stack_canary();
342 #endif
343         arch_cpu_idle_prepare();
344         cpuhp_online_idle(state);
345         while (1)
346                 do_idle();
347 }
348
349 /*
350  * idle-task scheduling class.
351  */
352
353 #ifdef CONFIG_SMP
354 static int
355 select_task_rq_idle(struct task_struct *p, int cpu, int sd_flag, int flags)
356 {
357         return task_cpu(p); /* IDLE tasks as never migrated */
358 }
359 #endif
360
361 /*
362  * Idle tasks are unconditionally rescheduled:
363  */
364 static void check_preempt_curr_idle(struct rq *rq, struct task_struct *p, int flags)
365 {
366         resched_curr(rq);
367 }
368
369 static struct task_struct *
370 pick_next_task_idle(struct rq *rq, struct task_struct *prev, struct rq_flags *rf)
371 {
372         put_prev_task(rq, prev);
373         update_idle_core(rq);
374         schedstat_inc(rq->sched_goidle);
375
376         return rq->idle;
377 }
378
379 /*
380  * It is not legal to sleep in the idle task - print a warning
381  * message if some code attempts to do it:
382  */
383 static void
384 dequeue_task_idle(struct rq *rq, struct task_struct *p, int flags)
385 {
386         raw_spin_unlock_irq(&rq->lock);
387         printk(KERN_ERR "bad: scheduling from the idle thread!\n");
388         dump_stack();
389         raw_spin_lock_irq(&rq->lock);
390 }
391
392 static void put_prev_task_idle(struct rq *rq, struct task_struct *prev)
393 {
394 }
395
396 /*
397  * scheduler tick hitting a task of our scheduling class.
398  *
399  * NOTE: This function can be called remotely by the tick offload that
400  * goes along full dynticks. Therefore no local assumption can be made
401  * and everything must be accessed through the @rq and @curr passed in
402  * parameters.
403  */
404 static void task_tick_idle(struct rq *rq, struct task_struct *curr, int queued)
405 {
406 }
407
408 static void set_curr_task_idle(struct rq *rq)
409 {
410 }
411
412 static void switched_to_idle(struct rq *rq, struct task_struct *p)
413 {
414         BUG();
415 }
416
417 static void
418 prio_changed_idle(struct rq *rq, struct task_struct *p, int oldprio)
419 {
420         BUG();
421 }
422
423 static unsigned int get_rr_interval_idle(struct rq *rq, struct task_struct *task)
424 {
425         return 0;
426 }
427
428 static void update_curr_idle(struct rq *rq)
429 {
430 }
431
432 /*
433  * Simple, special scheduling class for the per-CPU idle tasks:
434  */
435 const struct sched_class idle_sched_class = {
436         /* .next is NULL */
437         /* no enqueue/yield_task for idle tasks */
438
439         /* dequeue is not valid, we print a debug message there: */
440         .dequeue_task           = dequeue_task_idle,
441
442         .check_preempt_curr     = check_preempt_curr_idle,
443
444         .pick_next_task         = pick_next_task_idle,
445         .put_prev_task          = put_prev_task_idle,
446
447 #ifdef CONFIG_SMP
448         .select_task_rq         = select_task_rq_idle,
449         .set_cpus_allowed       = set_cpus_allowed_common,
450 #endif
451
452         .set_curr_task          = set_curr_task_idle,
453         .task_tick              = task_tick_idle,
454
455         .get_rr_interval        = get_rr_interval_idle,
456
457         .prio_changed           = prio_changed_idle,
458         .switched_to            = switched_to_idle,
459         .update_curr            = update_curr_idle,
460 };