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