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 int tick_do_timer_cpu __read_mostly = TICK_DO_TIMER_BOOT;
  37
  38 /*
  39  * Debugging: see timer_list.c
  40  */
  41 struct tick_device *tick_get_device(int cpu)
  42 {
  43         return &per_cpu(tick_cpu_device, cpu);
  44 }
  45
  46 /**
  47  * tick_is_oneshot_available - check for a oneshot capable event device
  48  */
  49 int tick_is_oneshot_available(void)
  50 {
  51         struct clock_event_device *dev = __this_cpu_read(tick_cpu_device.evtdev);
  52
  53         if (!dev || !(dev->features & CLOCK_EVT_FEAT_ONESHOT))
  54                 return 0;
  55         if (!(dev->features & CLOCK_EVT_FEAT_C3STOP))
  56                 return 1;
  57         return tick_broadcast_oneshot_available();
  58 }
  59
  60 /*
  61  * Periodic tick
  62  */
  63 static void tick_periodic(int cpu)
  64 {
  65         if (tick_do_timer_cpu == cpu) {
  66                 write_seqlock(&jiffies_lock);
  67
  68                 /* Keep track of the next tick event */
  69                 tick_next_period = ktime_add(tick_next_period, tick_period);
  70
  71                 do_timer(1);
  72                 write_sequnlock(&jiffies_lock);
  73         }
  74
  75         update_process_times(user_mode(get_irq_regs()));
  76         profile_tick(CPU_PROFILING);
  77 }
  78
  79 /*
  80  * Event handler for periodic ticks
  81  */
  82 void tick_handle_periodic(struct clock_event_device *dev)
  83 {
  84         int cpu = smp_processor_id();
  85         ktime_t next;
  86
  87         tick_periodic(cpu);
  88
  89         if (dev->mode != CLOCK_EVT_MODE_ONESHOT)
  90                 return;
  91         /*
  92          * Setup the next period for devices, which do not have
  93          * periodic mode:
  94          */
  95         next = ktime_add(dev->next_event, tick_period);
  96         for (;;) {
  97                 if (!clockevents_program_event(dev, next, false))
  98                         return;
  99                 /*
 100                  * Have to be careful here. If we're in oneshot mode,
 101                  * before we call tick_periodic() in a loop, we need
 102                  * to be sure we're using a real hardware clocksource.
 103                  * Otherwise we could get trapped in an infinite
 104                  * loop, as the tick_periodic() increments jiffies,
 105                  * when then will increment time, posibly causing
 106                  * the loop to trigger again and again.
 107                  */
 108                 if (timekeeping_valid_for_hres())
 109                         tick_periodic(cpu);
 110                 next = ktime_add(next, tick_period);
 111         }
 112 }
 113
 114 /*
 115  * Setup the device for a periodic tick
 116  */
 117 void tick_setup_periodic(struct clock_event_device *dev, int broadcast)
 118 {
 119         tick_set_periodic_handler(dev, broadcast);
 120
 121         /* Broadcast setup ? */
 122         if (!tick_device_is_functional(dev))
 123                 return;
 124
 125         if ((dev->features & CLOCK_EVT_FEAT_PERIODIC) &&
 126             !tick_broadcast_oneshot_active()) {
 127                 clockevents_set_mode(dev, CLOCK_EVT_MODE_PERIODIC);
 128         } else {
 129                 unsigned long seq;
 130                 ktime_t next;
 131
 132                 do {
 133                         seq = read_seqbegin(&jiffies_lock);
 134                         next = tick_next_period;
 135                 } while (read_seqretry(&jiffies_lock, seq));
 136
 137                 clockevents_set_mode(dev, CLOCK_EVT_MODE_ONESHOT);
 138
 139                 for (;;) {
 140                         if (!clockevents_program_event(dev, next, false))
 141                                 return;
 142                         next = ktime_add(next, tick_period);
 143                 }
 144         }
 145 }
 146
 147 /*
 148  * Setup the tick device
 149  */
 150 static void tick_setup_device(struct tick_device *td,
 151                               struct clock_event_device *newdev, int cpu,
 152                               const struct cpumask *cpumask)
 153 {
 154         ktime_t next_event;
 155         void (*handler)(struct clock_event_device *) = NULL;
 156
 157         /*
 158          * First device setup ?
 159          */
 160         if (!td->evtdev) {
 161                 /*
 162                  * If no cpu took the do_timer update, assign it to
 163                  * this cpu:
 164                  */
 165                 if (tick_do_timer_cpu == TICK_DO_TIMER_BOOT) {
 166                         if (!tick_nohz_full_cpu(cpu))
 167                                 tick_do_timer_cpu = cpu;
 168                         else
 169                                 tick_do_timer_cpu = TICK_DO_TIMER_NONE;
 170                         tick_next_period = ktime_get();
 171                         tick_period = ktime_set(0, NSEC_PER_SEC / HZ);
 172                 }
 173
 174                 /*
 175                  * Startup in periodic mode first.
 176                  */
 177                 td->mode = TICKDEV_MODE_PERIODIC;
 178         } else {
 179                 handler = td->evtdev->event_handler;
 180                 next_event = td->evtdev->next_event;
 181                 td->evtdev->event_handler = clockevents_handle_noop;
 182         }
 183
 184         td->evtdev = newdev;
 185
 186         /*
 187          * When the device is not per cpu, pin the interrupt to the
 188          * current cpu:
 189          */
 190         if (!cpumask_equal(newdev->cpumask, cpumask))
 191                 irq_set_affinity(newdev->irq, cpumask);
 192
 193         /*
 194          * When global broadcasting is active, check if the current
 195          * device is registered as a placeholder for broadcast mode.
 196          * This allows us to handle this x86 misfeature in a generic
 197          * way.
 198          */
 199         if (tick_device_uses_broadcast(newdev, cpu))
 200                 return;
 201
 202         if (td->mode == TICKDEV_MODE_PERIODIC)
 203                 tick_setup_periodic(newdev, 0);
 204         else
 205                 tick_setup_oneshot(newdev, handler, next_event);
 206 }
 207
 208 void tick_install_replacement(struct clock_event_device *newdev)
 209 {
 210         struct tick_device *td = &__get_cpu_var(tick_cpu_device);
 211         int cpu = smp_processor_id();
 212
 213         clockevents_exchange_device(td->evtdev, newdev);
 214         tick_setup_device(td, newdev, cpu, cpumask_of(cpu));
 215         if (newdev->features & CLOCK_EVT_FEAT_ONESHOT)
 216                 tick_oneshot_notify();
 217 }
 218
 219 static bool tick_check_percpu(struct clock_event_device *curdev,
 220                               struct clock_event_device *newdev, int cpu)
 221 {
 222         if (!cpumask_test_cpu(cpu, newdev->cpumask))
 223                 return false;
 224         if (cpumask_equal(newdev->cpumask, cpumask_of(cpu)))
 225                 return true;
 226         /* Check if irq affinity can be set */
 227         if (newdev->irq >= 0 && !irq_can_set_affinity(newdev->irq))
 228                 return false;
 229         /* Prefer an existing cpu local device */
 230         if (curdev && cpumask_equal(curdev->cpumask, cpumask_of(cpu)))
 231                 return false;
 232         return true;
 233 }
 234
 235 static bool tick_check_preferred(struct clock_event_device *curdev,
 236                                  struct clock_event_device *newdev)
 237 {
 238         /* Prefer oneshot capable device */
 239         if (!(newdev->features & CLOCK_EVT_FEAT_ONESHOT)) {
 240                 if (curdev && (curdev->features & CLOCK_EVT_FEAT_ONESHOT))
 241                         return false;
 242                 if (tick_oneshot_mode_active())
 243                         return false;
 244         }
 245
 246         /*
 247          * Use the higher rated one, but prefer a CPU local device with a lower
 248          * rating than a non-CPU local device
 249          */
 250         return !curdev ||
 251                 newdev->rating > curdev->rating ||
 252                !cpumask_equal(curdev->cpumask, newdev->cpumask);
 253 }
 254
 255 /*
 256  * Check whether the new device is a better fit than curdev. curdev
 257  * can be NULL !
 258  */
 259 bool tick_check_replacement(struct clock_event_device *curdev,
 260                             struct clock_event_device *newdev)
 261 {
 262         if (tick_check_percpu(curdev, newdev, smp_processor_id()))
 263                 return false;
 264
 265         return tick_check_preferred(curdev, newdev);
 266 }
 267
 268 /*
 269  * Check, if the new registered device should be used. Called with
 270  * clockevents_lock held and interrupts disabled.
 271  */
 272 void tick_check_new_device(struct clock_event_device *newdev)
 273 {
 274         struct clock_event_device *curdev;
 275         struct tick_device *td;
 276         int cpu;
 277
 278         cpu = smp_processor_id();
 279         if (!cpumask_test_cpu(cpu, newdev->cpumask))
 280                 goto out_bc;
 281
 282         td = &per_cpu(tick_cpu_device, cpu);
 283         curdev = td->evtdev;
 284
 285         /* cpu local device ? */
 286         if (!tick_check_percpu(curdev, newdev, cpu))
 287                 goto out_bc;
 288
 289         /* Preference decision */
 290         if (!tick_check_preferred(curdev, newdev))
 291                 goto out_bc;
 292
 293         if (!try_module_get(newdev->owner))
 294                 return;
 295
 296         /*
 297          * Replace the eventually existing device by the new
 298          * device. If the current device is the broadcast device, do
 299          * not give it back to the clockevents layer !
 300          */
 301         if (tick_is_broadcast_device(curdev)) {
 302                 clockevents_shutdown(curdev);
 303                 curdev = NULL;
 304         }
 305         clockevents_exchange_device(curdev, newdev);
 306         tick_setup_device(td, newdev, cpu, cpumask_of(cpu));
 307         if (newdev->features & CLOCK_EVT_FEAT_ONESHOT)
 308                 tick_oneshot_notify();
 309         return;
 310
 311 out_bc:
 312         /*
 313          * Can the new device be used as a broadcast device ?
 314          */
 315         tick_install_broadcast_device(newdev);
 316 }
 317
 318 /*
 319  * Transfer the do_timer job away from a dying cpu.
 320  *
 321  * Called with interrupts disabled.
 322  */
 323 void tick_handover_do_timer(int *cpup)
 324 {
 325         if (*cpup == tick_do_timer_cpu) {
 326                 int cpu = cpumask_first(cpu_online_mask);
 327
 328                 tick_do_timer_cpu = (cpu < nr_cpu_ids) ? cpu :
 329                         TICK_DO_TIMER_NONE;
 330         }
 331 }
 332
 333 /*
 334  * Shutdown an event device on a given cpu:
 335  *
 336  * This is called on a life CPU, when a CPU is dead. So we cannot
 337  * access the hardware device itself.
 338  * We just set the mode and remove it from the lists.
 339  */
 340 void tick_shutdown(unsigned int *cpup)
 341 {
 342         struct tick_device *td = &per_cpu(tick_cpu_device, *cpup);
 343         struct clock_event_device *dev = td->evtdev;
 344
 345         td->mode = TICKDEV_MODE_PERIODIC;
 346         if (dev) {
 347                 /*
 348                  * Prevent that the clock events layer tries to call
 349                  * the set mode function!
 350                  */
 351                 dev->mode = CLOCK_EVT_MODE_UNUSED;
 352                 clockevents_exchange_device(dev, NULL);
 353                 dev->event_handler = clockevents_handle_noop;
 354                 td->evtdev = NULL;
 355         }
 356 }
 357
 358 void tick_suspend(void)
 359 {
 360         struct tick_device *td = &__get_cpu_var(tick_cpu_device);
 361
 362         clockevents_shutdown(td->evtdev);
 363 }
 364
 365 void tick_resume(void)
 366 {
 367         struct tick_device *td = &__get_cpu_var(tick_cpu_device);
 368         int broadcast = tick_resume_broadcast();
 369
 370         clockevents_set_mode(td->evtdev, CLOCK_EVT_MODE_RESUME);
 371
 372         if (!broadcast) {
 373                 if (td->mode == TICKDEV_MODE_PERIODIC)
 374                         tick_setup_periodic(td->evtdev, 0);
 375                 else
 376                         tick_resume_oneshot();
 377         }
 378 }
 379
 380 /**
 381  * tick_init - initialize the tick control
 382  */
 383 void __init tick_init(void)
 384 {
 385         tick_broadcast_init();
 386 }