kernel/kernel/time/tick-common.c

   1 /*
   2  * linux/kernel/time/tick-common.c
   3  *
   4  * This file contains the base functions to manage periodic tick
   5  * related events.
   6  *
   7  * Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de>
   8  * Copyright(C) 2005-2007, Red Hat, Inc., Ingo Molnar
   9  * Copyright(C) 2006-2007, Timesys Corp., Thomas Gleixner
  10  *
  11  * This code is licenced under the GPL version 2. For details see
  12  * kernel-base/COPYING.
  13  */
  14 #include <linux/cpu.h>
  15 #include <linux/err.h>
  16 #include <linux/hrtimer.h>
  17 #include <linux/interrupt.h>
  18 #include <linux/percpu.h>
  19 #include <linux/profile.h>
  20 #include <linux/sched.h>
  21 #include <linux/module.h>
  22 #include <trace/events/power.h>
  23
  24 #include <asm/irq_regs.h>
  25
  26 #include "tick-internal.h"
  27
  28 /*
  29  * Tick devices
  30  */
  31 DEFINE_PER_CPU(struct tick_device, tick_cpu_device);
  32 /*
  33  * Tick next event: keeps track of the tick time
  34  */
  35 ktime_t tick_next_period;
  36 ktime_t tick_period;
  37
  38 /*
  39  * tick_do_timer_cpu is a timer core internal variable which holds the CPU NR
  40  * which is responsible for calling do_timer(), i.e. the timekeeping stuff. This
  41  * variable has two functions:
  42  *
  43  * 1) Prevent a thundering herd issue of a gazillion of CPUs trying to grab the
  44  *    timekeeping lock all at once. Only the CPU which is assigned to do the
  45  *    update is handling it.
  46  *
  47  * 2) Hand off the duty in the NOHZ idle case by setting the value to
  48  *    TICK_DO_TIMER_NONE, i.e. a non existing CPU. So the next cpu which looks
  49  *    at it will take over and keep the time keeping alive.  The handover
  50  *    procedure also covers cpu hotplug.
  51  */
  52 int tick_do_timer_cpu __read_mostly = TICK_DO_TIMER_BOOT;
  53
  54 /*
  55  * Debugging: see timer_list.c
  56  */
  57 struct tick_device *tick_get_device(int cpu)
  58 {
  59         return &per_cpu(tick_cpu_device, cpu);
  60 }
  61
  62 /**
  63  * tick_is_oneshot_available - check for a oneshot capable event device
  64  */
  65 int tick_is_oneshot_available(void)
  66 {
  67         struct clock_event_device *dev = __this_cpu_read(tick_cpu_device.evtdev);
  68
  69         if (!dev || !(dev->features & CLOCK_EVT_FEAT_ONESHOT))
  70                 return 0;
  71         if (!(dev->features & CLOCK_EVT_FEAT_C3STOP))
  72                 return 1;
  73         return tick_broadcast_oneshot_available();
  74 }
  75
  76 /*
  77  * Periodic tick
  78  */
  79 static void tick_periodic(int cpu)
  80 {
  81         if (tick_do_timer_cpu == cpu) {
  82                 raw_spin_lock(&jiffies_lock);
  83                 write_seqcount_begin(&jiffies_seq);
  84
  85                 /* Keep track of the next tick event */
  86                 tick_next_period = ktime_add(tick_next_period, tick_period);
  87
  88                 do_timer(1);
  89                 write_seqcount_end(&jiffies_seq);
  90                 raw_spin_unlock(&jiffies_lock);
  91                 update_wall_time();
  92         }
  93
  94         update_process_times(user_mode(get_irq_regs()));
  95         profile_tick(CPU_PROFILING);
  96 }
  97
  98 /*
  99  * Event handler for periodic ticks
 100  */
 101 void tick_handle_periodic(struct clock_event_device *dev)
 102 {
 103         int cpu = smp_processor_id();
 104         ktime_t next = dev->next_event;
 105
 106         tick_periodic(cpu);
 107
 108 #if defined(CONFIG_HIGH_RES_TIMERS) || defined(CONFIG_NO_HZ_COMMON)
 109         /*
 110          * The cpu might have transitioned to HIGHRES or NOHZ mode via
 111          * update_process_times() -> run_local_timers() ->
 112          * hrtimer_run_queues().
 113          */
 114         if (dev->event_handler != tick_handle_periodic)
 115                 return;
 116 #endif
 117
 118         if (!clockevent_state_oneshot(dev))
 119                 return;
 120         for (;;) {
 121                 /*
 122                  * Setup the next period for devices, which do not have
 123                  * periodic mode:
 124                  */
 125                 next = ktime_add(next, tick_period);
 126
 127                 if (!clockevents_program_event(dev, next, false))
 128                         return;
 129                 /*
 130                  * Have to be careful here. If we're in oneshot mode,
 131                  * before we call tick_periodic() in a loop, we need
 132                  * to be sure we're using a real hardware clocksource.
 133                  * Otherwise we could get trapped in an infinite
 134                  * loop, as the tick_periodic() increments jiffies,
 135                  * which then will increment time, possibly causing
 136                  * the loop to trigger again and again.
 137                  */
 138                 if (timekeeping_valid_for_hres())
 139                         tick_periodic(cpu);
 140         }
 141 }
 142
 143 /*
 144  * Setup the device for a periodic tick
 145  */
 146 void tick_setup_periodic(struct clock_event_device *dev, int broadcast)
 147 {
 148         tick_set_periodic_handler(dev, broadcast);
 149
 150         /* Broadcast setup ? */
 151         if (!tick_device_is_functional(dev))
 152                 return;
 153
 154         if ((dev->features & CLOCK_EVT_FEAT_PERIODIC) &&
 155             !tick_broadcast_oneshot_active()) {
 156                 clockevents_switch_state(dev, CLOCK_EVT_STATE_PERIODIC);
 157         } else {
 158                 unsigned long seq;
 159                 ktime_t next;
 160
 161                 do {
 162                         seq = read_seqcount_begin(&jiffies_seq);
 163                         next = tick_next_period;
 164                 } while (read_seqcount_retry(&jiffies_seq, seq));
 165
 166                 clockevents_switch_state(dev, CLOCK_EVT_STATE_ONESHOT);
 167
 168                 for (;;) {
 169                         if (!clockevents_program_event(dev, next, false))
 170                                 return;
 171                         next = ktime_add(next, tick_period);
 172                 }
 173         }
 174 }
 175
 176 /*
 177  * Setup the tick device
 178  */
 179 static void tick_setup_device(struct tick_device *td,
 180                               struct clock_event_device *newdev, int cpu,
 181                               const struct cpumask *cpumask)
 182 {
 183         ktime_t next_event;
 184         void (*handler)(struct clock_event_device *) = NULL;
 185
 186         /*
 187          * First device setup ?
 188          */
 189         if (!td->evtdev) {
 190                 /*
 191                  * If no cpu took the do_timer update, assign it to
 192                  * this cpu:
 193                  */
 194                 if (tick_do_timer_cpu == TICK_DO_TIMER_BOOT) {
 195                         if (!tick_nohz_full_cpu(cpu))
 196                                 tick_do_timer_cpu = cpu;
 197                         else
 198                                 tick_do_timer_cpu = TICK_DO_TIMER_NONE;
 199                         tick_next_period = ktime_get();
 200                         tick_period = ktime_set(0, NSEC_PER_SEC / HZ);
 201                 }
 202
 203                 /*
 204                  * Startup in periodic mode first.
 205                  */
 206                 td->mode = TICKDEV_MODE_PERIODIC;
 207         } else {
 208                 handler = td->evtdev->event_handler;
 209                 next_event = td->evtdev->next_event;
 210                 td->evtdev->event_handler = clockevents_handle_noop;
 211         }
 212
 213         td->evtdev = newdev;
 214
 215         /*
 216          * When the device is not per cpu, pin the interrupt to the
 217          * current cpu:
 218          */
 219         if (!cpumask_equal(newdev->cpumask, cpumask))
 220                 irq_set_affinity(newdev->irq, cpumask);
 221
 222         /*
 223          * When global broadcasting is active, check if the current
 224          * device is registered as a placeholder for broadcast mode.
 225          * This allows us to handle this x86 misfeature in a generic
 226          * way. This function also returns !=0 when we keep the
 227          * current active broadcast state for this CPU.
 228          */
 229         if (tick_device_uses_broadcast(newdev, cpu))
 230                 return;
 231
 232         if (td->mode == TICKDEV_MODE_PERIODIC)
 233                 tick_setup_periodic(newdev, 0);
 234         else
 235                 tick_setup_oneshot(newdev, handler, next_event);
 236 }
 237
 238 void tick_install_replacement(struct clock_event_device *newdev)
 239 {
 240         struct tick_device *td = this_cpu_ptr(&tick_cpu_device);
 241         int cpu = smp_processor_id();
 242
 243         clockevents_exchange_device(td->evtdev, newdev);
 244         tick_setup_device(td, newdev, cpu, cpumask_of(cpu));
 245         if (newdev->features & CLOCK_EVT_FEAT_ONESHOT)
 246                 tick_oneshot_notify();
 247 }
 248
 249 static bool tick_check_percpu(struct clock_event_device *curdev,
 250                               struct clock_event_device *newdev, int cpu)
 251 {
 252         if (!cpumask_test_cpu(cpu, newdev->cpumask))
 253                 return false;
 254         if (cpumask_equal(newdev->cpumask, cpumask_of(cpu)))
 255                 return true;
 256         /* Check if irq affinity can be set */
 257         if (newdev->irq >= 0 && !irq_can_set_affinity(newdev->irq))
 258                 return false;
 259         /* Prefer an existing cpu local device */
 260         if (curdev && cpumask_equal(curdev->cpumask, cpumask_of(cpu)))
 261                 return false;
 262         return true;
 263 }
 264
 265 static bool tick_check_preferred(struct clock_event_device *curdev,
 266                                  struct clock_event_device *newdev)
 267 {
 268         /* Prefer oneshot capable device */
 269         if (!(newdev->features & CLOCK_EVT_FEAT_ONESHOT)) {
 270                 if (curdev && (curdev->features & CLOCK_EVT_FEAT_ONESHOT))
 271                         return false;
 272                 if (tick_oneshot_mode_active())
 273                         return false;
 274         }
 275
 276         /*
 277          * Use the higher rated one, but prefer a CPU local device with a lower
 278          * rating than a non-CPU local device
 279          */
 280         return !curdev ||
 281                 newdev->rating > curdev->rating ||
 282                !cpumask_equal(curdev->cpumask, newdev->cpumask);
 283 }
 284
 285 /*
 286  * Check whether the new device is a better fit than curdev. curdev
 287  * can be NULL !
 288  */
 289 bool tick_check_replacement(struct clock_event_device *curdev,
 290                             struct clock_event_device *newdev)
 291 {
 292         if (!tick_check_percpu(curdev, newdev, smp_processor_id()))
 293                 return false;
 294
 295         return tick_check_preferred(curdev, newdev);
 296 }
 297
 298 /*
 299  * Check, if the new registered device should be used. Called with
 300  * clockevents_lock held and interrupts disabled.
 301  */
 302 void tick_check_new_device(struct clock_event_device *newdev)
 303 {
 304         struct clock_event_device *curdev;
 305         struct tick_device *td;
 306         int cpu;
 307
 308         cpu = smp_processor_id();
 309         td = &per_cpu(tick_cpu_device, cpu);
 310         curdev = td->evtdev;
 311
 312         /* cpu local device ? */
 313         if (!tick_check_percpu(curdev, newdev, cpu))
 314                 goto out_bc;
 315
 316         /* Preference decision */
 317         if (!tick_check_preferred(curdev, newdev))
 318                 goto out_bc;
 319
 320         if (!try_module_get(newdev->owner))
 321                 return;
 322
 323         /*
 324          * Replace the eventually existing device by the new
 325          * device. If the current device is the broadcast device, do
 326          * not give it back to the clockevents layer !
 327          */
 328         if (tick_is_broadcast_device(curdev)) {
 329                 clockevents_shutdown(curdev);
 330                 curdev = NULL;
 331         }
 332         clockevents_exchange_device(curdev, newdev);
 333         tick_setup_device(td, newdev, cpu, cpumask_of(cpu));
 334         if (newdev->features & CLOCK_EVT_FEAT_ONESHOT)
 335                 tick_oneshot_notify();
 336         return;
 337
 338 out_bc:
 339         /*
 340          * Can the new device be used as a broadcast device ?
 341          */
 342         tick_install_broadcast_device(newdev);
 343 }
 344
 345 /**
 346  * tick_broadcast_oneshot_control - Enter/exit broadcast oneshot mode
 347  * @state:      The target state (enter/exit)
 348  *
 349  * The system enters/leaves a state, where affected devices might stop
 350  * Returns 0 on success, -EBUSY if the cpu is used to broadcast wakeups.
 351  *
 352  * Called with interrupts disabled, so clockevents_lock is not
 353  * required here because the local clock event device cannot go away
 354  * under us.
 355  */
 356 int tick_broadcast_oneshot_control(enum tick_broadcast_state state)
 357 {
 358         struct tick_device *td = this_cpu_ptr(&tick_cpu_device);
 359
 360         if (!(td->evtdev->features & CLOCK_EVT_FEAT_C3STOP))
 361                 return 0;
 362
 363         return __tick_broadcast_oneshot_control(state);
 364 }
 365 EXPORT_SYMBOL_GPL(tick_broadcast_oneshot_control);
 366
 367 #ifdef CONFIG_HOTPLUG_CPU
 368 /*
 369  * Transfer the do_timer job away from a dying cpu.
 370  *
 371  * Called with interrupts disabled. Not locking required. If
 372  * tick_do_timer_cpu is owned by this cpu, nothing can change it.
 373  */
 374 void tick_handover_do_timer(void)
 375 {
 376         if (tick_do_timer_cpu == smp_processor_id()) {
 377                 int cpu = cpumask_first(cpu_online_mask);
 378
 379                 tick_do_timer_cpu = (cpu < nr_cpu_ids) ? cpu :
 380                         TICK_DO_TIMER_NONE;
 381         }
 382 }
 383
 384 /*
 385  * Shutdown an event device on a given cpu:
 386  *
 387  * This is called on a life CPU, when a CPU is dead. So we cannot
 388  * access the hardware device itself.
 389  * We just set the mode and remove it from the lists.
 390  */
 391 void tick_shutdown(unsigned int cpu)
 392 {
 393         struct tick_device *td = &per_cpu(tick_cpu_device, cpu);
 394         struct clock_event_device *dev = td->evtdev;
 395
 396         td->mode = TICKDEV_MODE_PERIODIC;
 397         if (dev) {
 398                 /*
 399                  * Prevent that the clock events layer tries to call
 400                  * the set mode function!
 401                  */
 402                 clockevent_set_state(dev, CLOCK_EVT_STATE_DETACHED);
 403                 clockevents_exchange_device(dev, NULL);
 404                 dev->event_handler = clockevents_handle_noop;
 405                 td->evtdev = NULL;
 406         }
 407 }
 408 #endif
 409
 410 /**
 411  * tick_suspend_local - Suspend the local tick device
 412  *
 413  * Called from the local cpu for freeze with interrupts disabled.
 414  *
 415  * No locks required. Nothing can change the per cpu device.
 416  */
 417 void tick_suspend_local(void)
 418 {
 419         struct tick_device *td = this_cpu_ptr(&tick_cpu_device);
 420
 421         clockevents_shutdown(td->evtdev);
 422 }
 423
 424 /**
 425  * tick_resume_local - Resume the local tick device
 426  *
 427  * Called from the local CPU for unfreeze or XEN resume magic.
 428  *
 429  * No locks required. Nothing can change the per cpu device.
 430  */
 431 void tick_resume_local(void)
 432 {
 433         struct tick_device *td = this_cpu_ptr(&tick_cpu_device);
 434         bool broadcast = tick_resume_check_broadcast();
 435
 436         clockevents_tick_resume(td->evtdev);
 437         if (!broadcast) {
 438                 if (td->mode == TICKDEV_MODE_PERIODIC)
 439                         tick_setup_periodic(td->evtdev, 0);
 440                 else
 441                         tick_resume_oneshot();
 442         }
 443 }
 444
 445 /**
 446  * tick_suspend - Suspend the tick and the broadcast device
 447  *
 448  * Called from syscore_suspend() via timekeeping_suspend with only one
 449  * CPU online and interrupts disabled or from tick_unfreeze() under
 450  * tick_freeze_lock.
 451  *
 452  * No locks required. Nothing can change the per cpu device.
 453  */
 454 void tick_suspend(void)
 455 {
 456         tick_suspend_local();
 457         tick_suspend_broadcast();
 458 }
 459
 460 /**
 461  * tick_resume - Resume the tick and the broadcast device
 462  *
 463  * Called from syscore_resume() via timekeeping_resume with only one
 464  * CPU online and interrupts disabled.
 465  *
 466  * No locks required. Nothing can change the per cpu device.
 467  */
 468 void tick_resume(void)
 469 {
 470         tick_resume_broadcast();
 471         tick_resume_local();
 472 }
 473
 474 #ifdef CONFIG_SUSPEND
 475 static DEFINE_RAW_SPINLOCK(tick_freeze_lock);
 476 static unsigned int tick_freeze_depth;
 477
 478 /**
 479  * tick_freeze - Suspend the local tick and (possibly) timekeeping.
 480  *
 481  * Check if this is the last online CPU executing the function and if so,
 482  * suspend timekeeping.  Otherwise suspend the local tick.
 483  *
 484  * Call with interrupts disabled.  Must be balanced with %tick_unfreeze().
 485  * Interrupts must not be enabled before the subsequent %tick_unfreeze().
 486  */
 487 void tick_freeze(void)
 488 {
 489         raw_spin_lock(&tick_freeze_lock);
 490
 491         tick_freeze_depth++;
 492         if (tick_freeze_depth == num_online_cpus()) {
 493                 trace_suspend_resume(TPS("timekeeping_freeze"),
 494                                      smp_processor_id(), true);
 495                 timekeeping_suspend();
 496         } else {
 497                 tick_suspend_local();
 498         }
 499
 500         raw_spin_unlock(&tick_freeze_lock);
 501 }
 502
 503 /**
 504  * tick_unfreeze - Resume the local tick and (possibly) timekeeping.
 505  *
 506  * Check if this is the first CPU executing the function and if so, resume
 507  * timekeeping.  Otherwise resume the local tick.
 508  *
 509  * Call with interrupts disabled.  Must be balanced with %tick_freeze().
 510  * Interrupts must not be enabled after the preceding %tick_freeze().
 511  */
 512 void tick_unfreeze(void)
 513 {
 514         raw_spin_lock(&tick_freeze_lock);
 515
 516         if (tick_freeze_depth == num_online_cpus()) {
 517                 timekeeping_resume();
 518                 trace_suspend_resume(TPS("timekeeping_freeze"),
 519                                      smp_processor_id(), false);
 520         } else {
 521                 tick_resume_local();
 522         }
 523
 524         tick_freeze_depth--;
 525
 526         raw_spin_unlock(&tick_freeze_lock);
 527 }
 528 #endif /* CONFIG_SUSPEND */
 529
 530 /**
 531  * tick_init - initialize the tick control
 532  */
 533 void __init tick_init(void)
 534 {
 535         tick_broadcast_init();
 536         tick_nohz_init();
 537 }