2 * linux/kernel/time/tick-broadcast.c
4 * This file contains functions which emulate a local clock-event
5 * device via a broadcast event source.
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
11 * This code is licenced under the GPL version 2. For details see
12 * kernel-base/COPYING.
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/smp.h>
23 #include "tick-internal.h"
26 * Broadcast support for broken x86 hardware, where the local apic
27 * timer stops in C3 state.
30 static struct tick_device tick_broadcast_device;
31 static cpumask_var_t tick_broadcast_mask;
32 static cpumask_var_t tmpmask;
33 static DEFINE_RAW_SPINLOCK(tick_broadcast_lock);
34 static int tick_broadcast_force;
36 #ifdef CONFIG_TICK_ONESHOT
37 static void tick_broadcast_clear_oneshot(int cpu);
39 static inline void tick_broadcast_clear_oneshot(int cpu) { }
43 * Debugging: see timer_list.c
45 struct tick_device *tick_get_broadcast_device(void)
47 return &tick_broadcast_device;
50 struct cpumask *tick_get_broadcast_mask(void)
52 return tick_broadcast_mask;
56 * Start the device in periodic mode
58 static void tick_broadcast_start_periodic(struct clock_event_device *bc)
61 tick_setup_periodic(bc, 1);
65 * Check, if the device can be utilized as broadcast device:
67 int tick_check_broadcast_device(struct clock_event_device *dev)
69 if ((dev->features & CLOCK_EVT_FEAT_DUMMY) ||
70 (tick_broadcast_device.evtdev &&
71 tick_broadcast_device.evtdev->rating >= dev->rating) ||
72 (dev->features & CLOCK_EVT_FEAT_C3STOP))
75 clockevents_exchange_device(tick_broadcast_device.evtdev, dev);
76 tick_broadcast_device.evtdev = dev;
77 if (!cpumask_empty(tick_broadcast_mask))
78 tick_broadcast_start_periodic(dev);
80 * Inform all cpus about this. We might be in a situation
81 * where we did not switch to oneshot mode because the per cpu
82 * devices are affected by CLOCK_EVT_FEAT_C3STOP and the lack
83 * of a oneshot capable broadcast device. Without that
84 * notification the systems stays stuck in periodic mode
87 if (dev->features & CLOCK_EVT_FEAT_ONESHOT)
93 * Check, if the device is the broadcast device
95 int tick_is_broadcast_device(struct clock_event_device *dev)
97 return (dev && tick_broadcast_device.evtdev == dev);
100 static void err_broadcast(const struct cpumask *mask)
102 pr_crit_once("Failed to broadcast timer tick. Some CPUs may be unresponsive.\n");
105 static void tick_device_setup_broadcast_func(struct clock_event_device *dev)
108 dev->broadcast = tick_broadcast;
109 if (!dev->broadcast) {
110 pr_warn_once("%s depends on broadcast, but no broadcast function available\n",
112 dev->broadcast = err_broadcast;
117 * Check, if the device is disfunctional and a place holder, which
118 * needs to be handled by the broadcast device.
120 int tick_device_uses_broadcast(struct clock_event_device *dev, int cpu)
125 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
128 * Devices might be registered with both periodic and oneshot
129 * mode disabled. This signals, that the device needs to be
130 * operated from the broadcast device and is a placeholder for
131 * the cpu local device.
133 if (!tick_device_is_functional(dev)) {
134 dev->event_handler = tick_handle_periodic;
135 tick_device_setup_broadcast_func(dev);
136 cpumask_set_cpu(cpu, tick_broadcast_mask);
137 tick_broadcast_start_periodic(tick_broadcast_device.evtdev);
141 * When the new device is not affected by the stop
142 * feature and the cpu is marked in the broadcast mask
143 * then clear the broadcast bit.
145 if (!(dev->features & CLOCK_EVT_FEAT_C3STOP)) {
146 int cpu = smp_processor_id();
147 cpumask_clear_cpu(cpu, tick_broadcast_mask);
148 tick_broadcast_clear_oneshot(cpu);
150 tick_device_setup_broadcast_func(dev);
153 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
157 #ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
158 int tick_receive_broadcast(void)
160 struct tick_device *td = this_cpu_ptr(&tick_cpu_device);
161 struct clock_event_device *evt = td->evtdev;
166 if (!evt->event_handler)
169 evt->event_handler(evt);
175 * Broadcast the event to the cpus, which are set in the mask (mangled).
177 static void tick_do_broadcast(struct cpumask *mask)
179 int cpu = smp_processor_id();
180 struct tick_device *td;
183 * Check, if the current cpu is in the mask
185 if (cpumask_test_cpu(cpu, mask)) {
186 cpumask_clear_cpu(cpu, mask);
187 td = &per_cpu(tick_cpu_device, cpu);
188 td->evtdev->event_handler(td->evtdev);
191 if (!cpumask_empty(mask)) {
193 * It might be necessary to actually check whether the devices
194 * have different broadcast functions. For now, just use the
195 * one of the first device. This works as long as we have this
196 * misfeature only on x86 (lapic)
198 td = &per_cpu(tick_cpu_device, cpumask_first(mask));
199 td->evtdev->broadcast(mask);
204 * Periodic broadcast:
205 * - invoke the broadcast handlers
207 static void tick_do_periodic_broadcast(void)
209 raw_spin_lock(&tick_broadcast_lock);
211 cpumask_and(tmpmask, cpu_online_mask, tick_broadcast_mask);
212 tick_do_broadcast(tmpmask);
214 raw_spin_unlock(&tick_broadcast_lock);
218 * Event handler for periodic broadcast ticks
220 static void tick_handle_periodic_broadcast(struct clock_event_device *dev)
224 tick_do_periodic_broadcast();
227 * The device is in periodic mode. No reprogramming necessary:
229 if (dev->mode == CLOCK_EVT_MODE_PERIODIC)
233 * Setup the next period for devices, which do not have
234 * periodic mode. We read dev->next_event first and add to it
235 * when the event already expired. clockevents_program_event()
236 * sets dev->next_event only when the event is really
237 * programmed to the device.
239 for (next = dev->next_event; ;) {
240 next = ktime_add(next, tick_period);
242 if (!clockevents_program_event(dev, next, false))
244 tick_do_periodic_broadcast();
249 * Powerstate information: The system enters/leaves a state, where
250 * affected devices might stop
252 static void tick_do_broadcast_on_off(unsigned long *reason)
254 struct clock_event_device *bc, *dev;
255 struct tick_device *td;
259 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
261 cpu = smp_processor_id();
262 td = &per_cpu(tick_cpu_device, cpu);
264 bc = tick_broadcast_device.evtdev;
267 * Is the device not affected by the powerstate ?
269 if (!dev || !(dev->features & CLOCK_EVT_FEAT_C3STOP))
272 if (!tick_device_is_functional(dev))
275 bc_stopped = cpumask_empty(tick_broadcast_mask);
278 case CLOCK_EVT_NOTIFY_BROADCAST_ON:
279 case CLOCK_EVT_NOTIFY_BROADCAST_FORCE:
280 if (!cpumask_test_and_set_cpu(cpu, tick_broadcast_mask)) {
281 if (tick_broadcast_device.mode ==
282 TICKDEV_MODE_PERIODIC)
283 clockevents_shutdown(dev);
285 if (*reason == CLOCK_EVT_NOTIFY_BROADCAST_FORCE)
286 tick_broadcast_force = 1;
288 case CLOCK_EVT_NOTIFY_BROADCAST_OFF:
289 if (!tick_broadcast_force &&
290 cpumask_test_and_clear_cpu(cpu, tick_broadcast_mask)) {
291 if (tick_broadcast_device.mode ==
292 TICKDEV_MODE_PERIODIC)
293 tick_setup_periodic(dev, 0);
298 if (cpumask_empty(tick_broadcast_mask)) {
300 clockevents_shutdown(bc);
301 } else if (bc_stopped) {
302 if (tick_broadcast_device.mode == TICKDEV_MODE_PERIODIC)
303 tick_broadcast_start_periodic(bc);
305 tick_broadcast_setup_oneshot(bc);
308 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
312 * Powerstate information: The system enters/leaves a state, where
313 * affected devices might stop.
315 void tick_broadcast_on_off(unsigned long reason, int *oncpu)
317 if (!cpumask_test_cpu(*oncpu, cpu_online_mask))
318 printk(KERN_ERR "tick-broadcast: ignoring broadcast for "
319 "offline CPU #%d\n", *oncpu);
321 tick_do_broadcast_on_off(&reason);
325 * Set the periodic handler depending on broadcast on/off
327 void tick_set_periodic_handler(struct clock_event_device *dev, int broadcast)
330 dev->event_handler = tick_handle_periodic;
332 dev->event_handler = tick_handle_periodic_broadcast;
336 * Remove a CPU from broadcasting
338 void tick_shutdown_broadcast(unsigned int *cpup)
340 struct clock_event_device *bc;
342 unsigned int cpu = *cpup;
344 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
346 bc = tick_broadcast_device.evtdev;
347 cpumask_clear_cpu(cpu, tick_broadcast_mask);
349 if (tick_broadcast_device.mode == TICKDEV_MODE_PERIODIC) {
350 if (bc && cpumask_empty(tick_broadcast_mask))
351 clockevents_shutdown(bc);
354 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
357 void tick_suspend_broadcast(void)
359 struct clock_event_device *bc;
362 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
364 bc = tick_broadcast_device.evtdev;
366 clockevents_shutdown(bc);
368 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
371 int tick_resume_broadcast(void)
373 struct clock_event_device *bc;
377 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
379 bc = tick_broadcast_device.evtdev;
382 clockevents_set_mode(bc, CLOCK_EVT_MODE_RESUME);
384 switch (tick_broadcast_device.mode) {
385 case TICKDEV_MODE_PERIODIC:
386 if (!cpumask_empty(tick_broadcast_mask))
387 tick_broadcast_start_periodic(bc);
388 broadcast = cpumask_test_cpu(smp_processor_id(),
389 tick_broadcast_mask);
391 case TICKDEV_MODE_ONESHOT:
392 if (!cpumask_empty(tick_broadcast_mask))
393 broadcast = tick_resume_broadcast_oneshot(bc);
397 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
403 #ifdef CONFIG_TICK_ONESHOT
405 static cpumask_var_t tick_broadcast_oneshot_mask;
406 static cpumask_var_t tick_broadcast_pending_mask;
407 static cpumask_var_t tick_broadcast_force_mask;
410 * Exposed for debugging: see timer_list.c
412 struct cpumask *tick_get_broadcast_oneshot_mask(void)
414 return tick_broadcast_oneshot_mask;
418 * Called before going idle with interrupts disabled. Checks whether a
419 * broadcast event from the other core is about to happen. We detected
420 * that in tick_broadcast_oneshot_control(). The callsite can use this
421 * to avoid a deep idle transition as we are about to get the
422 * broadcast IPI right away.
424 int tick_check_broadcast_expired(void)
426 return cpumask_test_cpu(smp_processor_id(), tick_broadcast_force_mask);
430 * Set broadcast interrupt affinity
432 static void tick_broadcast_set_affinity(struct clock_event_device *bc,
433 const struct cpumask *cpumask)
435 if (!(bc->features & CLOCK_EVT_FEAT_DYNIRQ))
438 if (cpumask_equal(bc->cpumask, cpumask))
441 bc->cpumask = cpumask;
442 irq_set_affinity(bc->irq, bc->cpumask);
445 static int tick_broadcast_set_event(struct clock_event_device *bc, int cpu,
446 ktime_t expires, int force)
450 if (bc->mode != CLOCK_EVT_MODE_ONESHOT)
451 clockevents_set_mode(bc, CLOCK_EVT_MODE_ONESHOT);
453 ret = clockevents_program_event(bc, expires, force);
455 tick_broadcast_set_affinity(bc, cpumask_of(cpu));
459 int tick_resume_broadcast_oneshot(struct clock_event_device *bc)
461 clockevents_set_mode(bc, CLOCK_EVT_MODE_ONESHOT);
466 * Called from irq_enter() when idle was interrupted to reenable the
469 void tick_check_oneshot_broadcast(int cpu)
471 if (cpumask_test_cpu(cpu, tick_broadcast_oneshot_mask)) {
472 struct tick_device *td = &per_cpu(tick_cpu_device, cpu);
474 clockevents_set_mode(td->evtdev, CLOCK_EVT_MODE_ONESHOT);
479 * Handle oneshot mode broadcasting
481 static void tick_handle_oneshot_broadcast(struct clock_event_device *dev)
483 struct tick_device *td;
484 ktime_t now, next_event;
485 int cpu, next_cpu = 0;
487 raw_spin_lock(&tick_broadcast_lock);
489 dev->next_event.tv64 = KTIME_MAX;
490 next_event.tv64 = KTIME_MAX;
491 cpumask_clear(tmpmask);
493 /* Find all expired events */
494 for_each_cpu(cpu, tick_broadcast_oneshot_mask) {
495 td = &per_cpu(tick_cpu_device, cpu);
496 if (td->evtdev->next_event.tv64 <= now.tv64) {
497 cpumask_set_cpu(cpu, tmpmask);
499 * Mark the remote cpu in the pending mask, so
500 * it can avoid reprogramming the cpu local
501 * timer in tick_broadcast_oneshot_control().
503 cpumask_set_cpu(cpu, tick_broadcast_pending_mask);
504 } else if (td->evtdev->next_event.tv64 < next_event.tv64) {
505 next_event.tv64 = td->evtdev->next_event.tv64;
510 /* Take care of enforced broadcast requests */
511 cpumask_or(tmpmask, tmpmask, tick_broadcast_force_mask);
512 cpumask_clear(tick_broadcast_force_mask);
515 * Wakeup the cpus which have an expired event.
517 tick_do_broadcast(tmpmask);
520 * Two reasons for reprogram:
522 * - The global event did not expire any CPU local
523 * events. This happens in dyntick mode, as the maximum PIT
524 * delta is quite small.
526 * - There are pending events on sleeping CPUs which were not
529 if (next_event.tv64 != KTIME_MAX) {
531 * Rearm the broadcast device. If event expired,
534 if (tick_broadcast_set_event(dev, next_cpu, next_event, 0))
537 raw_spin_unlock(&tick_broadcast_lock);
541 * Powerstate information: The system enters/leaves a state, where
542 * affected devices might stop
544 void tick_broadcast_oneshot_control(unsigned long reason)
546 struct clock_event_device *bc, *dev;
547 struct tick_device *td;
553 * Periodic mode does not care about the enter/exit of power
556 if (tick_broadcast_device.mode == TICKDEV_MODE_PERIODIC)
560 * We are called with preemtion disabled from the depth of the
561 * idle code, so we can't be moved away.
563 cpu = smp_processor_id();
564 td = &per_cpu(tick_cpu_device, cpu);
567 if (!(dev->features & CLOCK_EVT_FEAT_C3STOP))
570 bc = tick_broadcast_device.evtdev;
572 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
573 if (reason == CLOCK_EVT_NOTIFY_BROADCAST_ENTER) {
574 WARN_ON_ONCE(cpumask_test_cpu(cpu, tick_broadcast_pending_mask));
575 if (!cpumask_test_and_set_cpu(cpu, tick_broadcast_oneshot_mask)) {
576 clockevents_set_mode(dev, CLOCK_EVT_MODE_SHUTDOWN);
578 * We only reprogram the broadcast timer if we
579 * did not mark ourself in the force mask and
580 * if the cpu local event is earlier than the
581 * broadcast event. If the current CPU is in
582 * the force mask, then we are going to be
583 * woken by the IPI right away.
585 if (!cpumask_test_cpu(cpu, tick_broadcast_force_mask) &&
586 dev->next_event.tv64 < bc->next_event.tv64)
587 tick_broadcast_set_event(bc, cpu, dev->next_event, 1);
590 if (cpumask_test_and_clear_cpu(cpu, tick_broadcast_oneshot_mask)) {
591 clockevents_set_mode(dev, CLOCK_EVT_MODE_ONESHOT);
592 if (dev->next_event.tv64 == KTIME_MAX)
595 * The cpu which was handling the broadcast
596 * timer marked this cpu in the broadcast
597 * pending mask and fired the broadcast
598 * IPI. So we are going to handle the expired
599 * event anyway via the broadcast IPI
600 * handler. No need to reprogram the timer
601 * with an already expired event.
603 if (cpumask_test_and_clear_cpu(cpu,
604 tick_broadcast_pending_mask))
608 * If the pending bit is not set, then we are
609 * either the CPU handling the broadcast
610 * interrupt or we got woken by something else.
612 * We are not longer in the broadcast mask, so
613 * if the cpu local expiry time is already
614 * reached, we would reprogram the cpu local
615 * timer with an already expired event.
617 * This can lead to a ping-pong when we return
618 * to idle and therefor rearm the broadcast
619 * timer before the cpu local timer was able
620 * to fire. This happens because the forced
621 * reprogramming makes sure that the event
622 * will happen in the future and depending on
623 * the min_delta setting this might be far
624 * enough out that the ping-pong starts.
626 * If the cpu local next_event has expired
627 * then we know that the broadcast timer
628 * next_event has expired as well and
629 * broadcast is about to be handled. So we
630 * avoid reprogramming and enforce that the
631 * broadcast handler, which did not run yet,
632 * will invoke the cpu local handler.
634 * We cannot call the handler directly from
635 * here, because we might be in a NOHZ phase
636 * and we did not go through the irq_enter()
640 if (dev->next_event.tv64 <= now.tv64) {
641 cpumask_set_cpu(cpu, tick_broadcast_force_mask);
645 * We got woken by something else. Reprogram
646 * the cpu local timer device.
648 tick_program_event(dev->next_event, 1);
652 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
656 * Reset the one shot broadcast for a cpu
658 * Called with tick_broadcast_lock held
660 static void tick_broadcast_clear_oneshot(int cpu)
662 cpumask_clear_cpu(cpu, tick_broadcast_oneshot_mask);
665 static void tick_broadcast_init_next_event(struct cpumask *mask,
668 struct tick_device *td;
671 for_each_cpu(cpu, mask) {
672 td = &per_cpu(tick_cpu_device, cpu);
674 td->evtdev->next_event = expires;
679 * tick_broadcast_setup_oneshot - setup the broadcast device
681 void tick_broadcast_setup_oneshot(struct clock_event_device *bc)
683 int cpu = smp_processor_id();
685 /* Set it up only once ! */
686 if (bc->event_handler != tick_handle_oneshot_broadcast) {
687 int was_periodic = bc->mode == CLOCK_EVT_MODE_PERIODIC;
689 bc->event_handler = tick_handle_oneshot_broadcast;
691 /* Take the do_timer update */
692 tick_do_timer_cpu = cpu;
695 * We must be careful here. There might be other CPUs
696 * waiting for periodic broadcast. We need to set the
697 * oneshot_mask bits for those and program the
698 * broadcast device to fire.
700 cpumask_copy(tmpmask, tick_broadcast_mask);
701 cpumask_clear_cpu(cpu, tmpmask);
702 cpumask_or(tick_broadcast_oneshot_mask,
703 tick_broadcast_oneshot_mask, tmpmask);
705 if (was_periodic && !cpumask_empty(tmpmask)) {
706 clockevents_set_mode(bc, CLOCK_EVT_MODE_ONESHOT);
707 tick_broadcast_init_next_event(tmpmask,
709 tick_broadcast_set_event(bc, cpu, tick_next_period, 1);
711 bc->next_event.tv64 = KTIME_MAX;
714 * The first cpu which switches to oneshot mode sets
715 * the bit for all other cpus which are in the general
716 * (periodic) broadcast mask. So the bit is set and
717 * would prevent the first broadcast enter after this
718 * to program the bc device.
720 tick_broadcast_clear_oneshot(cpu);
725 * Select oneshot operating mode for the broadcast device
727 void tick_broadcast_switch_to_oneshot(void)
729 struct clock_event_device *bc;
732 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
734 tick_broadcast_device.mode = TICKDEV_MODE_ONESHOT;
735 bc = tick_broadcast_device.evtdev;
737 tick_broadcast_setup_oneshot(bc);
739 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
744 * Remove a dead CPU from broadcasting
746 void tick_shutdown_broadcast_oneshot(unsigned int *cpup)
749 unsigned int cpu = *cpup;
751 raw_spin_lock_irqsave(&tick_broadcast_lock, flags);
754 * Clear the broadcast mask flag for the dead cpu, but do not
755 * stop the broadcast device!
757 cpumask_clear_cpu(cpu, tick_broadcast_oneshot_mask);
759 raw_spin_unlock_irqrestore(&tick_broadcast_lock, flags);
763 * Check, whether the broadcast device is in one shot mode
765 int tick_broadcast_oneshot_active(void)
767 return tick_broadcast_device.mode == TICKDEV_MODE_ONESHOT;
771 * Check whether the broadcast device supports oneshot.
773 bool tick_broadcast_oneshot_available(void)
775 struct clock_event_device *bc = tick_broadcast_device.evtdev;
777 return bc ? bc->features & CLOCK_EVT_FEAT_ONESHOT : false;
782 void __init tick_broadcast_init(void)
784 alloc_cpumask_var(&tick_broadcast_mask, GFP_NOWAIT);
785 alloc_cpumask_var(&tmpmask, GFP_NOWAIT);
786 #ifdef CONFIG_TICK_ONESHOT
787 alloc_cpumask_var(&tick_broadcast_oneshot_mask, GFP_NOWAIT);
788 alloc_cpumask_var(&tick_broadcast_pending_mask, GFP_NOWAIT);
789 alloc_cpumask_var(&tick_broadcast_force_mask, GFP_NOWAIT);