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