kernel/sched/idle.c

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