2 * linux/kernel/hrtimer.c
4 * Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de>
5 * Copyright(C) 2005-2007, Red Hat, Inc., Ingo Molnar
6 * Copyright(C) 2006-2007 Timesys Corp., Thomas Gleixner
8 * High-resolution kernel timers
10 * In contrast to the low-resolution timeout API implemented in
11 * kernel/timer.c, hrtimers provide finer resolution and accuracy
12 * depending on system configuration and capabilities.
14 * These timers are currently used for:
18 * - precise in-kernel timing
20 * Started by: Thomas Gleixner and Ingo Molnar
23 * based on kernel/timer.c
25 * Help, testing, suggestions, bugfixes, improvements were
28 * George Anzinger, Andrew Morton, Steven Rostedt, Roman Zippel
31 * For licencing details see kernel-base/COPYING
34 #include <linux/cpu.h>
35 #include <linux/irq.h>
36 #include <linux/module.h>
37 #include <linux/percpu.h>
38 #include <linux/hrtimer.h>
39 #include <linux/notifier.h>
40 #include <linux/syscalls.h>
41 #include <linux/kallsyms.h>
42 #include <linux/interrupt.h>
43 #include <linux/tick.h>
44 #include <linux/seq_file.h>
45 #include <linux/err.h>
46 #include <linux/debugobjects.h>
48 #include <asm/uaccess.h>
51 * ktime_get - get the monotonic time in ktime_t format
53 * returns the time in ktime_t format
55 ktime_t ktime_get(void)
61 return timespec_to_ktime(now);
63 EXPORT_SYMBOL_GPL(ktime_get);
66 * ktime_get_real - get the real (wall-) time in ktime_t format
68 * returns the time in ktime_t format
70 ktime_t ktime_get_real(void)
76 return timespec_to_ktime(now);
79 EXPORT_SYMBOL_GPL(ktime_get_real);
84 * Note: If we want to add new timer bases, we have to skip the two
85 * clock ids captured by the cpu-timers. We do this by holding empty
86 * entries rather than doing math adjustment of the clock ids.
87 * This ensures that we capture erroneous accesses to these clock ids
88 * rather than moving them into the range of valid clock id's.
90 DEFINE_PER_CPU(struct hrtimer_cpu_base, hrtimer_bases) =
96 .index = CLOCK_REALTIME,
97 .get_time = &ktime_get_real,
98 .resolution = KTIME_LOW_RES,
101 .index = CLOCK_MONOTONIC,
102 .get_time = &ktime_get,
103 .resolution = KTIME_LOW_RES,
109 * ktime_get_ts - get the monotonic clock in timespec format
110 * @ts: pointer to timespec variable
112 * The function calculates the monotonic clock from the realtime
113 * clock and the wall_to_monotonic offset and stores the result
114 * in normalized timespec format in the variable pointed to by @ts.
116 void ktime_get_ts(struct timespec *ts)
118 struct timespec tomono;
122 seq = read_seqbegin(&xtime_lock);
124 tomono = wall_to_monotonic;
126 } while (read_seqretry(&xtime_lock, seq));
128 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
129 ts->tv_nsec + tomono.tv_nsec);
131 EXPORT_SYMBOL_GPL(ktime_get_ts);
134 * Get the coarse grained time at the softirq based on xtime and
137 static void hrtimer_get_softirq_time(struct hrtimer_cpu_base *base)
139 ktime_t xtim, tomono;
140 struct timespec xts, tom;
144 seq = read_seqbegin(&xtime_lock);
145 xts = current_kernel_time();
146 tom = wall_to_monotonic;
147 } while (read_seqretry(&xtime_lock, seq));
149 xtim = timespec_to_ktime(xts);
150 tomono = timespec_to_ktime(tom);
151 base->clock_base[CLOCK_REALTIME].softirq_time = xtim;
152 base->clock_base[CLOCK_MONOTONIC].softirq_time =
153 ktime_add(xtim, tomono);
157 * Functions and macros which are different for UP/SMP systems are kept in a
163 * We are using hashed locking: holding per_cpu(hrtimer_bases)[n].lock
164 * means that all timers which are tied to this base via timer->base are
165 * locked, and the base itself is locked too.
167 * So __run_timers/migrate_timers can safely modify all timers which could
168 * be found on the lists/queues.
170 * When the timer's base is locked, and the timer removed from list, it is
171 * possible to set timer->base = NULL and drop the lock: the timer remains
175 struct hrtimer_clock_base *lock_hrtimer_base(const struct hrtimer *timer,
176 unsigned long *flags)
178 struct hrtimer_clock_base *base;
182 if (likely(base != NULL)) {
183 spin_lock_irqsave(&base->cpu_base->lock, *flags);
184 if (likely(base == timer->base))
186 /* The timer has migrated to another CPU: */
187 spin_unlock_irqrestore(&base->cpu_base->lock, *flags);
194 * Switch the timer base to the current CPU when possible.
196 static inline struct hrtimer_clock_base *
197 switch_hrtimer_base(struct hrtimer *timer, struct hrtimer_clock_base *base)
199 struct hrtimer_clock_base *new_base;
200 struct hrtimer_cpu_base *new_cpu_base;
202 new_cpu_base = &__get_cpu_var(hrtimer_bases);
203 new_base = &new_cpu_base->clock_base[base->index];
205 if (base != new_base) {
207 * We are trying to schedule the timer on the local CPU.
208 * However we can't change timer's base while it is running,
209 * so we keep it on the same CPU. No hassle vs. reprogramming
210 * the event source in the high resolution case. The softirq
211 * code will take care of this when the timer function has
212 * completed. There is no conflict as we hold the lock until
213 * the timer is enqueued.
215 if (unlikely(hrtimer_callback_running(timer)))
218 /* See the comment in lock_timer_base() */
220 spin_unlock(&base->cpu_base->lock);
221 spin_lock(&new_base->cpu_base->lock);
222 timer->base = new_base;
227 #else /* CONFIG_SMP */
229 static inline struct hrtimer_clock_base *
230 lock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
232 struct hrtimer_clock_base *base = timer->base;
234 spin_lock_irqsave(&base->cpu_base->lock, *flags);
239 # define switch_hrtimer_base(t, b) (b)
241 #endif /* !CONFIG_SMP */
244 * Functions for the union type storage format of ktime_t which are
245 * too large for inlining:
247 #if BITS_PER_LONG < 64
248 # ifndef CONFIG_KTIME_SCALAR
250 * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
252 * @nsec: the scalar nsec value to add
254 * Returns the sum of kt and nsec in ktime_t format
256 ktime_t ktime_add_ns(const ktime_t kt, u64 nsec)
260 if (likely(nsec < NSEC_PER_SEC)) {
263 unsigned long rem = do_div(nsec, NSEC_PER_SEC);
265 tmp = ktime_set((long)nsec, rem);
268 return ktime_add(kt, tmp);
271 EXPORT_SYMBOL_GPL(ktime_add_ns);
274 * ktime_sub_ns - Subtract a scalar nanoseconds value from a ktime_t variable
276 * @nsec: the scalar nsec value to subtract
278 * Returns the subtraction of @nsec from @kt in ktime_t format
280 ktime_t ktime_sub_ns(const ktime_t kt, u64 nsec)
284 if (likely(nsec < NSEC_PER_SEC)) {
287 unsigned long rem = do_div(nsec, NSEC_PER_SEC);
289 tmp = ktime_set((long)nsec, rem);
292 return ktime_sub(kt, tmp);
295 EXPORT_SYMBOL_GPL(ktime_sub_ns);
296 # endif /* !CONFIG_KTIME_SCALAR */
299 * Divide a ktime value by a nanosecond value
301 u64 ktime_divns(const ktime_t kt, s64 div)
306 dclc = ktime_to_ns(kt);
307 /* Make sure the divisor is less than 2^32: */
313 do_div(dclc, (unsigned long) div);
317 #endif /* BITS_PER_LONG >= 64 */
320 * Add two ktime values and do a safety check for overflow:
322 ktime_t ktime_add_safe(const ktime_t lhs, const ktime_t rhs)
324 ktime_t res = ktime_add(lhs, rhs);
327 * We use KTIME_SEC_MAX here, the maximum timeout which we can
328 * return to user space in a timespec:
330 if (res.tv64 < 0 || res.tv64 < lhs.tv64 || res.tv64 < rhs.tv64)
331 res = ktime_set(KTIME_SEC_MAX, 0);
336 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
338 static struct debug_obj_descr hrtimer_debug_descr;
341 * fixup_init is called when:
342 * - an active object is initialized
344 static int hrtimer_fixup_init(void *addr, enum debug_obj_state state)
346 struct hrtimer *timer = addr;
349 case ODEBUG_STATE_ACTIVE:
350 hrtimer_cancel(timer);
351 debug_object_init(timer, &hrtimer_debug_descr);
359 * fixup_activate is called when:
360 * - an active object is activated
361 * - an unknown object is activated (might be a statically initialized object)
363 static int hrtimer_fixup_activate(void *addr, enum debug_obj_state state)
367 case ODEBUG_STATE_NOTAVAILABLE:
371 case ODEBUG_STATE_ACTIVE:
380 * fixup_free is called when:
381 * - an active object is freed
383 static int hrtimer_fixup_free(void *addr, enum debug_obj_state state)
385 struct hrtimer *timer = addr;
388 case ODEBUG_STATE_ACTIVE:
389 hrtimer_cancel(timer);
390 debug_object_free(timer, &hrtimer_debug_descr);
397 static struct debug_obj_descr hrtimer_debug_descr = {
399 .fixup_init = hrtimer_fixup_init,
400 .fixup_activate = hrtimer_fixup_activate,
401 .fixup_free = hrtimer_fixup_free,
404 static inline void debug_hrtimer_init(struct hrtimer *timer)
406 debug_object_init(timer, &hrtimer_debug_descr);
409 static inline void debug_hrtimer_activate(struct hrtimer *timer)
411 debug_object_activate(timer, &hrtimer_debug_descr);
414 static inline void debug_hrtimer_deactivate(struct hrtimer *timer)
416 debug_object_deactivate(timer, &hrtimer_debug_descr);
419 static inline void debug_hrtimer_free(struct hrtimer *timer)
421 debug_object_free(timer, &hrtimer_debug_descr);
424 static void __hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
425 enum hrtimer_mode mode);
427 void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t clock_id,
428 enum hrtimer_mode mode)
430 debug_object_init_on_stack(timer, &hrtimer_debug_descr);
431 __hrtimer_init(timer, clock_id, mode);
434 void destroy_hrtimer_on_stack(struct hrtimer *timer)
436 debug_object_free(timer, &hrtimer_debug_descr);
440 static inline void debug_hrtimer_init(struct hrtimer *timer) { }
441 static inline void debug_hrtimer_activate(struct hrtimer *timer) { }
442 static inline void debug_hrtimer_deactivate(struct hrtimer *timer) { }
446 * Check, whether the timer is on the callback pending list
448 static inline int hrtimer_cb_pending(const struct hrtimer *timer)
450 return timer->state & HRTIMER_STATE_PENDING;
454 * Remove a timer from the callback pending list
456 static inline void hrtimer_remove_cb_pending(struct hrtimer *timer)
458 list_del_init(&timer->cb_entry);
461 /* High resolution timer related functions */
462 #ifdef CONFIG_HIGH_RES_TIMERS
465 * High resolution timer enabled ?
467 static int hrtimer_hres_enabled __read_mostly = 1;
470 * Enable / Disable high resolution mode
472 static int __init setup_hrtimer_hres(char *str)
474 if (!strcmp(str, "off"))
475 hrtimer_hres_enabled = 0;
476 else if (!strcmp(str, "on"))
477 hrtimer_hres_enabled = 1;
483 __setup("highres=", setup_hrtimer_hres);
486 * hrtimer_high_res_enabled - query, if the highres mode is enabled
488 static inline int hrtimer_is_hres_enabled(void)
490 return hrtimer_hres_enabled;
494 * Is the high resolution mode active ?
496 static inline int hrtimer_hres_active(void)
498 return __get_cpu_var(hrtimer_bases).hres_active;
502 * Reprogram the event source with checking both queues for the
504 * Called with interrupts disabled and base->lock held
506 static void hrtimer_force_reprogram(struct hrtimer_cpu_base *cpu_base)
509 struct hrtimer_clock_base *base = cpu_base->clock_base;
512 cpu_base->expires_next.tv64 = KTIME_MAX;
514 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
515 struct hrtimer *timer;
519 timer = rb_entry(base->first, struct hrtimer, node);
520 expires = ktime_sub(timer->expires, base->offset);
521 if (expires.tv64 < cpu_base->expires_next.tv64)
522 cpu_base->expires_next = expires;
525 if (cpu_base->expires_next.tv64 != KTIME_MAX)
526 tick_program_event(cpu_base->expires_next, 1);
530 * Shared reprogramming for clock_realtime and clock_monotonic
532 * When a timer is enqueued and expires earlier than the already enqueued
533 * timers, we have to check, whether it expires earlier than the timer for
534 * which the clock event device was armed.
536 * Called with interrupts disabled and base->cpu_base.lock held
538 static int hrtimer_reprogram(struct hrtimer *timer,
539 struct hrtimer_clock_base *base)
541 ktime_t *expires_next = &__get_cpu_var(hrtimer_bases).expires_next;
542 ktime_t expires = ktime_sub(timer->expires, base->offset);
545 WARN_ON_ONCE(timer->expires.tv64 < 0);
548 * When the callback is running, we do not reprogram the clock event
549 * device. The timer callback is either running on a different CPU or
550 * the callback is executed in the hrtimer_interrupt context. The
551 * reprogramming is handled either by the softirq, which called the
552 * callback or at the end of the hrtimer_interrupt.
554 if (hrtimer_callback_running(timer))
558 * CLOCK_REALTIME timer might be requested with an absolute
559 * expiry time which is less than base->offset. Nothing wrong
560 * about that, just avoid to call into the tick code, which
561 * has now objections against negative expiry values.
563 if (expires.tv64 < 0)
566 if (expires.tv64 >= expires_next->tv64)
570 * Clockevents returns -ETIME, when the event was in the past.
572 res = tick_program_event(expires, 0);
573 if (!IS_ERR_VALUE(res))
574 *expires_next = expires;
580 * Retrigger next event is called after clock was set
582 * Called with interrupts disabled via on_each_cpu()
584 static void retrigger_next_event(void *arg)
586 struct hrtimer_cpu_base *base;
587 struct timespec realtime_offset;
590 if (!hrtimer_hres_active())
594 seq = read_seqbegin(&xtime_lock);
595 set_normalized_timespec(&realtime_offset,
596 -wall_to_monotonic.tv_sec,
597 -wall_to_monotonic.tv_nsec);
598 } while (read_seqretry(&xtime_lock, seq));
600 base = &__get_cpu_var(hrtimer_bases);
602 /* Adjust CLOCK_REALTIME offset */
603 spin_lock(&base->lock);
604 base->clock_base[CLOCK_REALTIME].offset =
605 timespec_to_ktime(realtime_offset);
607 hrtimer_force_reprogram(base);
608 spin_unlock(&base->lock);
612 * Clock realtime was set
614 * Change the offset of the realtime clock vs. the monotonic
617 * We might have to reprogram the high resolution timer interrupt. On
618 * SMP we call the architecture specific code to retrigger _all_ high
619 * resolution timer interrupts. On UP we just disable interrupts and
620 * call the high resolution interrupt code.
622 void clock_was_set(void)
624 /* Retrigger the CPU local events everywhere */
625 on_each_cpu(retrigger_next_event, NULL, 1);
629 * During resume we might have to reprogram the high resolution timer
630 * interrupt (on the local CPU):
632 void hres_timers_resume(void)
634 /* Retrigger the CPU local events: */
635 retrigger_next_event(NULL);
639 * Initialize the high resolution related parts of cpu_base
641 static inline void hrtimer_init_hres(struct hrtimer_cpu_base *base)
643 base->expires_next.tv64 = KTIME_MAX;
644 base->hres_active = 0;
648 * Initialize the high resolution related parts of a hrtimer
650 static inline void hrtimer_init_timer_hres(struct hrtimer *timer)
655 * When High resolution timers are active, try to reprogram. Note, that in case
656 * the state has HRTIMER_STATE_CALLBACK set, no reprogramming and no expiry
657 * check happens. The timer gets enqueued into the rbtree. The reprogramming
658 * and expiry check is done in the hrtimer_interrupt or in the softirq.
660 static inline int hrtimer_enqueue_reprogram(struct hrtimer *timer,
661 struct hrtimer_clock_base *base)
663 if (base->cpu_base->hres_active && hrtimer_reprogram(timer, base)) {
665 /* Timer is expired, act upon the callback mode */
666 switch(timer->cb_mode) {
667 case HRTIMER_CB_IRQSAFE_NO_RESTART:
668 debug_hrtimer_deactivate(timer);
670 * We can call the callback from here. No restart
671 * happens, so no danger of recursion
673 BUG_ON(timer->function(timer) != HRTIMER_NORESTART);
675 case HRTIMER_CB_IRQSAFE_PERCPU:
676 case HRTIMER_CB_IRQSAFE_UNLOCKED:
678 * This is solely for the sched tick emulation with
679 * dynamic tick support to ensure that we do not
680 * restart the tick right on the edge and end up with
681 * the tick timer in the softirq ! The calling site
682 * takes care of this. Also used for hrtimer sleeper !
684 debug_hrtimer_deactivate(timer);
686 case HRTIMER_CB_IRQSAFE:
687 case HRTIMER_CB_SOFTIRQ:
689 * Move everything else into the softirq pending list !
691 list_add_tail(&timer->cb_entry,
692 &base->cpu_base->cb_pending);
693 timer->state = HRTIMER_STATE_PENDING;
703 * Switch to high resolution mode
705 static int hrtimer_switch_to_hres(void)
707 int cpu = smp_processor_id();
708 struct hrtimer_cpu_base *base = &per_cpu(hrtimer_bases, cpu);
711 if (base->hres_active)
714 local_irq_save(flags);
716 if (tick_init_highres()) {
717 local_irq_restore(flags);
718 printk(KERN_WARNING "Could not switch to high resolution "
719 "mode on CPU %d\n", cpu);
722 base->hres_active = 1;
723 base->clock_base[CLOCK_REALTIME].resolution = KTIME_HIGH_RES;
724 base->clock_base[CLOCK_MONOTONIC].resolution = KTIME_HIGH_RES;
726 tick_setup_sched_timer();
728 /* "Retrigger" the interrupt to get things going */
729 retrigger_next_event(NULL);
730 local_irq_restore(flags);
731 printk(KERN_DEBUG "Switched to high resolution mode on CPU %d\n",
736 static inline void hrtimer_raise_softirq(void)
738 raise_softirq(HRTIMER_SOFTIRQ);
743 static inline int hrtimer_hres_active(void) { return 0; }
744 static inline int hrtimer_is_hres_enabled(void) { return 0; }
745 static inline int hrtimer_switch_to_hres(void) { return 0; }
746 static inline void hrtimer_force_reprogram(struct hrtimer_cpu_base *base) { }
747 static inline int hrtimer_enqueue_reprogram(struct hrtimer *timer,
748 struct hrtimer_clock_base *base)
752 static inline void hrtimer_init_hres(struct hrtimer_cpu_base *base) { }
753 static inline void hrtimer_init_timer_hres(struct hrtimer *timer) { }
754 static inline int hrtimer_reprogram(struct hrtimer *timer,
755 struct hrtimer_clock_base *base)
759 static inline void hrtimer_raise_softirq(void) { }
761 #endif /* CONFIG_HIGH_RES_TIMERS */
763 #ifdef CONFIG_TIMER_STATS
764 void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer, void *addr)
766 if (timer->start_site)
769 timer->start_site = addr;
770 memcpy(timer->start_comm, current->comm, TASK_COMM_LEN);
771 timer->start_pid = current->pid;
776 * Counterpart to lock_hrtimer_base above:
779 void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
781 spin_unlock_irqrestore(&timer->base->cpu_base->lock, *flags);
785 * hrtimer_forward - forward the timer expiry
786 * @timer: hrtimer to forward
787 * @now: forward past this time
788 * @interval: the interval to forward
790 * Forward the timer expiry so it will expire in the future.
791 * Returns the number of overruns.
793 u64 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
798 delta = ktime_sub(now, timer->expires);
803 if (interval.tv64 < timer->base->resolution.tv64)
804 interval.tv64 = timer->base->resolution.tv64;
806 if (unlikely(delta.tv64 >= interval.tv64)) {
807 s64 incr = ktime_to_ns(interval);
809 orun = ktime_divns(delta, incr);
810 timer->expires = ktime_add_ns(timer->expires, incr * orun);
811 if (timer->expires.tv64 > now.tv64)
814 * This (and the ktime_add() below) is the
815 * correction for exact:
819 timer->expires = ktime_add_safe(timer->expires, interval);
823 EXPORT_SYMBOL_GPL(hrtimer_forward);
826 * enqueue_hrtimer - internal function to (re)start a timer
828 * The timer is inserted in expiry order. Insertion into the
829 * red black tree is O(log(n)). Must hold the base lock.
831 static void enqueue_hrtimer(struct hrtimer *timer,
832 struct hrtimer_clock_base *base, int reprogram)
834 struct rb_node **link = &base->active.rb_node;
835 struct rb_node *parent = NULL;
836 struct hrtimer *entry;
839 debug_hrtimer_activate(timer);
842 * Find the right place in the rbtree:
846 entry = rb_entry(parent, struct hrtimer, node);
848 * We dont care about collisions. Nodes with
849 * the same expiry time stay together.
851 if (timer->expires.tv64 < entry->expires.tv64) {
852 link = &(*link)->rb_left;
854 link = &(*link)->rb_right;
860 * Insert the timer to the rbtree and check whether it
861 * replaces the first pending timer
865 * Reprogram the clock event device. When the timer is already
866 * expired hrtimer_enqueue_reprogram has either called the
867 * callback or added it to the pending list and raised the
870 * This is a NOP for !HIGHRES
872 if (reprogram && hrtimer_enqueue_reprogram(timer, base))
875 base->first = &timer->node;
878 rb_link_node(&timer->node, parent, link);
879 rb_insert_color(&timer->node, &base->active);
881 * HRTIMER_STATE_ENQUEUED is or'ed to the current state to preserve the
882 * state of a possibly running callback.
884 timer->state |= HRTIMER_STATE_ENQUEUED;
888 * __remove_hrtimer - internal function to remove a timer
890 * Caller must hold the base lock.
892 * High resolution timer mode reprograms the clock event device when the
893 * timer is the one which expires next. The caller can disable this by setting
894 * reprogram to zero. This is useful, when the context does a reprogramming
895 * anyway (e.g. timer interrupt)
897 static void __remove_hrtimer(struct hrtimer *timer,
898 struct hrtimer_clock_base *base,
899 unsigned long newstate, int reprogram)
901 /* High res. callback list. NOP for !HIGHRES */
902 if (hrtimer_cb_pending(timer))
903 hrtimer_remove_cb_pending(timer);
906 * Remove the timer from the rbtree and replace the
907 * first entry pointer if necessary.
909 if (base->first == &timer->node) {
910 base->first = rb_next(&timer->node);
911 /* Reprogram the clock event device. if enabled */
912 if (reprogram && hrtimer_hres_active())
913 hrtimer_force_reprogram(base->cpu_base);
915 rb_erase(&timer->node, &base->active);
917 timer->state = newstate;
921 * remove hrtimer, called with base lock held
924 remove_hrtimer(struct hrtimer *timer, struct hrtimer_clock_base *base)
926 if (hrtimer_is_queued(timer)) {
930 * Remove the timer and force reprogramming when high
931 * resolution mode is active and the timer is on the current
932 * CPU. If we remove a timer on another CPU, reprogramming is
933 * skipped. The interrupt event on this CPU is fired and
934 * reprogramming happens in the interrupt handler. This is a
935 * rare case and less expensive than a smp call.
937 debug_hrtimer_deactivate(timer);
938 timer_stats_hrtimer_clear_start_info(timer);
939 reprogram = base->cpu_base == &__get_cpu_var(hrtimer_bases);
940 __remove_hrtimer(timer, base, HRTIMER_STATE_INACTIVE,
948 * hrtimer_start - (re)start an relative timer on the current CPU
949 * @timer: the timer to be added
951 * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
955 * 1 when the timer was active
958 hrtimer_start(struct hrtimer *timer, ktime_t tim, const enum hrtimer_mode mode)
960 struct hrtimer_clock_base *base, *new_base;
964 base = lock_hrtimer_base(timer, &flags);
966 /* Remove an active timer from the queue: */
967 ret = remove_hrtimer(timer, base);
969 /* Switch the timer base, if necessary: */
970 new_base = switch_hrtimer_base(timer, base);
972 if (mode == HRTIMER_MODE_REL) {
973 tim = ktime_add_safe(tim, new_base->get_time());
975 * CONFIG_TIME_LOW_RES is a temporary way for architectures
976 * to signal that they simply return xtime in
977 * do_gettimeoffset(). In this case we want to round up by
978 * resolution when starting a relative timer, to avoid short
979 * timeouts. This will go away with the GTOD framework.
981 #ifdef CONFIG_TIME_LOW_RES
982 tim = ktime_add_safe(tim, base->resolution);
986 timer->expires = tim;
988 timer_stats_hrtimer_set_start_info(timer);
991 * Only allow reprogramming if the new base is on this CPU.
992 * (it might still be on another CPU if the timer was pending)
994 enqueue_hrtimer(timer, new_base,
995 new_base->cpu_base == &__get_cpu_var(hrtimer_bases));
998 * The timer may be expired and moved to the cb_pending
999 * list. We can not raise the softirq with base lock held due
1000 * to a possible deadlock with runqueue lock.
1002 raise = timer->state == HRTIMER_STATE_PENDING;
1005 * We use preempt_disable to prevent this task from migrating after
1006 * setting up the softirq and raising it. Otherwise, if me migrate
1007 * we will raise the softirq on the wrong CPU.
1011 unlock_hrtimer_base(timer, &flags);
1014 hrtimer_raise_softirq();
1019 EXPORT_SYMBOL_GPL(hrtimer_start);
1022 * hrtimer_try_to_cancel - try to deactivate a timer
1023 * @timer: hrtimer to stop
1026 * 0 when the timer was not active
1027 * 1 when the timer was active
1028 * -1 when the timer is currently excuting the callback function and
1031 int hrtimer_try_to_cancel(struct hrtimer *timer)
1033 struct hrtimer_clock_base *base;
1034 unsigned long flags;
1037 base = lock_hrtimer_base(timer, &flags);
1039 if (!hrtimer_callback_running(timer))
1040 ret = remove_hrtimer(timer, base);
1042 unlock_hrtimer_base(timer, &flags);
1047 EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
1050 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
1051 * @timer: the timer to be cancelled
1054 * 0 when the timer was not active
1055 * 1 when the timer was active
1057 int hrtimer_cancel(struct hrtimer *timer)
1060 int ret = hrtimer_try_to_cancel(timer);
1067 EXPORT_SYMBOL_GPL(hrtimer_cancel);
1070 * hrtimer_get_remaining - get remaining time for the timer
1071 * @timer: the timer to read
1073 ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
1075 struct hrtimer_clock_base *base;
1076 unsigned long flags;
1079 base = lock_hrtimer_base(timer, &flags);
1080 rem = ktime_sub(timer->expires, base->get_time());
1081 unlock_hrtimer_base(timer, &flags);
1085 EXPORT_SYMBOL_GPL(hrtimer_get_remaining);
1089 * hrtimer_get_next_event - get the time until next expiry event
1091 * Returns the delta to the next expiry event or KTIME_MAX if no timer
1094 ktime_t hrtimer_get_next_event(void)
1096 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1097 struct hrtimer_clock_base *base = cpu_base->clock_base;
1098 ktime_t delta, mindelta = { .tv64 = KTIME_MAX };
1099 unsigned long flags;
1102 spin_lock_irqsave(&cpu_base->lock, flags);
1104 if (!hrtimer_hres_active()) {
1105 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
1106 struct hrtimer *timer;
1111 timer = rb_entry(base->first, struct hrtimer, node);
1112 delta.tv64 = timer->expires.tv64;
1113 delta = ktime_sub(delta, base->get_time());
1114 if (delta.tv64 < mindelta.tv64)
1115 mindelta.tv64 = delta.tv64;
1119 spin_unlock_irqrestore(&cpu_base->lock, flags);
1121 if (mindelta.tv64 < 0)
1127 static void __hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
1128 enum hrtimer_mode mode)
1130 struct hrtimer_cpu_base *cpu_base;
1132 memset(timer, 0, sizeof(struct hrtimer));
1134 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
1136 if (clock_id == CLOCK_REALTIME && mode != HRTIMER_MODE_ABS)
1137 clock_id = CLOCK_MONOTONIC;
1139 timer->base = &cpu_base->clock_base[clock_id];
1140 INIT_LIST_HEAD(&timer->cb_entry);
1141 hrtimer_init_timer_hres(timer);
1143 #ifdef CONFIG_TIMER_STATS
1144 timer->start_site = NULL;
1145 timer->start_pid = -1;
1146 memset(timer->start_comm, 0, TASK_COMM_LEN);
1151 * hrtimer_init - initialize a timer to the given clock
1152 * @timer: the timer to be initialized
1153 * @clock_id: the clock to be used
1154 * @mode: timer mode abs/rel
1156 void hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
1157 enum hrtimer_mode mode)
1159 debug_hrtimer_init(timer);
1160 __hrtimer_init(timer, clock_id, mode);
1162 EXPORT_SYMBOL_GPL(hrtimer_init);
1165 * hrtimer_get_res - get the timer resolution for a clock
1166 * @which_clock: which clock to query
1167 * @tp: pointer to timespec variable to store the resolution
1169 * Store the resolution of the clock selected by @which_clock in the
1170 * variable pointed to by @tp.
1172 int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp)
1174 struct hrtimer_cpu_base *cpu_base;
1176 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
1177 *tp = ktime_to_timespec(cpu_base->clock_base[which_clock].resolution);
1181 EXPORT_SYMBOL_GPL(hrtimer_get_res);
1183 static void run_hrtimer_pending(struct hrtimer_cpu_base *cpu_base)
1185 spin_lock_irq(&cpu_base->lock);
1187 while (!list_empty(&cpu_base->cb_pending)) {
1188 enum hrtimer_restart (*fn)(struct hrtimer *);
1189 struct hrtimer *timer;
1192 timer = list_entry(cpu_base->cb_pending.next,
1193 struct hrtimer, cb_entry);
1195 debug_hrtimer_deactivate(timer);
1196 timer_stats_account_hrtimer(timer);
1198 fn = timer->function;
1199 __remove_hrtimer(timer, timer->base, HRTIMER_STATE_CALLBACK, 0);
1200 spin_unlock_irq(&cpu_base->lock);
1202 restart = fn(timer);
1204 spin_lock_irq(&cpu_base->lock);
1206 timer->state &= ~HRTIMER_STATE_CALLBACK;
1207 if (restart == HRTIMER_RESTART) {
1208 BUG_ON(hrtimer_active(timer));
1210 * Enqueue the timer, allow reprogramming of the event
1213 enqueue_hrtimer(timer, timer->base, 1);
1214 } else if (hrtimer_active(timer)) {
1216 * If the timer was rearmed on another CPU, reprogram
1219 struct hrtimer_clock_base *base = timer->base;
1221 if (base->first == &timer->node &&
1222 hrtimer_reprogram(timer, base)) {
1224 * Timer is expired. Thus move it from tree to
1225 * pending list again.
1227 __remove_hrtimer(timer, base,
1228 HRTIMER_STATE_PENDING, 0);
1229 list_add_tail(&timer->cb_entry,
1230 &base->cpu_base->cb_pending);
1234 spin_unlock_irq(&cpu_base->lock);
1237 static void __run_hrtimer(struct hrtimer *timer)
1239 struct hrtimer_clock_base *base = timer->base;
1240 struct hrtimer_cpu_base *cpu_base = base->cpu_base;
1241 enum hrtimer_restart (*fn)(struct hrtimer *);
1244 debug_hrtimer_deactivate(timer);
1245 __remove_hrtimer(timer, base, HRTIMER_STATE_CALLBACK, 0);
1246 timer_stats_account_hrtimer(timer);
1248 fn = timer->function;
1249 if (timer->cb_mode == HRTIMER_CB_IRQSAFE_PERCPU ||
1250 timer->cb_mode == HRTIMER_CB_IRQSAFE_UNLOCKED) {
1252 * Used for scheduler timers, avoid lock inversion with
1253 * rq->lock and tasklist_lock.
1255 * These timers are required to deal with enqueue expiry
1256 * themselves and are not allowed to migrate.
1258 spin_unlock(&cpu_base->lock);
1259 restart = fn(timer);
1260 spin_lock(&cpu_base->lock);
1262 restart = fn(timer);
1265 * Note: We clear the CALLBACK bit after enqueue_hrtimer to avoid
1266 * reprogramming of the event hardware. This happens at the end of this
1269 if (restart != HRTIMER_NORESTART) {
1270 BUG_ON(timer->state != HRTIMER_STATE_CALLBACK);
1271 enqueue_hrtimer(timer, base, 0);
1273 timer->state &= ~HRTIMER_STATE_CALLBACK;
1276 #ifdef CONFIG_HIGH_RES_TIMERS
1279 * High resolution timer interrupt
1280 * Called with interrupts disabled
1282 void hrtimer_interrupt(struct clock_event_device *dev)
1284 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1285 struct hrtimer_clock_base *base;
1286 ktime_t expires_next, now;
1289 BUG_ON(!cpu_base->hres_active);
1290 cpu_base->nr_events++;
1291 dev->next_event.tv64 = KTIME_MAX;
1296 expires_next.tv64 = KTIME_MAX;
1298 base = cpu_base->clock_base;
1300 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
1302 struct rb_node *node;
1304 spin_lock(&cpu_base->lock);
1306 basenow = ktime_add(now, base->offset);
1308 while ((node = base->first)) {
1309 struct hrtimer *timer;
1311 timer = rb_entry(node, struct hrtimer, node);
1313 if (basenow.tv64 < timer->expires.tv64) {
1316 expires = ktime_sub(timer->expires,
1318 if (expires.tv64 < expires_next.tv64)
1319 expires_next = expires;
1323 /* Move softirq callbacks to the pending list */
1324 if (timer->cb_mode == HRTIMER_CB_SOFTIRQ) {
1325 __remove_hrtimer(timer, base,
1326 HRTIMER_STATE_PENDING, 0);
1327 list_add_tail(&timer->cb_entry,
1328 &base->cpu_base->cb_pending);
1333 __run_hrtimer(timer);
1335 spin_unlock(&cpu_base->lock);
1339 cpu_base->expires_next = expires_next;
1341 /* Reprogramming necessary ? */
1342 if (expires_next.tv64 != KTIME_MAX) {
1343 if (tick_program_event(expires_next, 0))
1347 /* Raise softirq ? */
1349 raise_softirq(HRTIMER_SOFTIRQ);
1352 static void run_hrtimer_softirq(struct softirq_action *h)
1354 run_hrtimer_pending(&__get_cpu_var(hrtimer_bases));
1357 #endif /* CONFIG_HIGH_RES_TIMERS */
1360 * Called from timer softirq every jiffy, expire hrtimers:
1362 * For HRT its the fall back code to run the softirq in the timer
1363 * softirq context in case the hrtimer initialization failed or has
1364 * not been done yet.
1366 void hrtimer_run_pending(void)
1368 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1370 if (hrtimer_hres_active())
1374 * This _is_ ugly: We have to check in the softirq context,
1375 * whether we can switch to highres and / or nohz mode. The
1376 * clocksource switch happens in the timer interrupt with
1377 * xtime_lock held. Notification from there only sets the
1378 * check bit in the tick_oneshot code, otherwise we might
1379 * deadlock vs. xtime_lock.
1381 if (tick_check_oneshot_change(!hrtimer_is_hres_enabled()))
1382 hrtimer_switch_to_hres();
1384 run_hrtimer_pending(cpu_base);
1388 * Called from hardirq context every jiffy
1390 void hrtimer_run_queues(void)
1392 struct rb_node *node;
1393 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1394 struct hrtimer_clock_base *base;
1395 int index, gettime = 1;
1397 if (hrtimer_hres_active())
1400 for (index = 0; index < HRTIMER_MAX_CLOCK_BASES; index++) {
1401 base = &cpu_base->clock_base[index];
1406 if (base->get_softirq_time)
1407 base->softirq_time = base->get_softirq_time();
1409 hrtimer_get_softirq_time(cpu_base);
1413 spin_lock(&cpu_base->lock);
1415 while ((node = base->first)) {
1416 struct hrtimer *timer;
1418 timer = rb_entry(node, struct hrtimer, node);
1419 if (base->softirq_time.tv64 <= timer->expires.tv64)
1422 if (timer->cb_mode == HRTIMER_CB_SOFTIRQ) {
1423 __remove_hrtimer(timer, base,
1424 HRTIMER_STATE_PENDING, 0);
1425 list_add_tail(&timer->cb_entry,
1426 &base->cpu_base->cb_pending);
1430 __run_hrtimer(timer);
1432 spin_unlock(&cpu_base->lock);
1437 * Sleep related functions:
1439 static enum hrtimer_restart hrtimer_wakeup(struct hrtimer *timer)
1441 struct hrtimer_sleeper *t =
1442 container_of(timer, struct hrtimer_sleeper, timer);
1443 struct task_struct *task = t->task;
1447 wake_up_process(task);
1449 return HRTIMER_NORESTART;
1452 void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, struct task_struct *task)
1454 sl->timer.function = hrtimer_wakeup;
1456 #ifdef CONFIG_HIGH_RES_TIMERS
1457 sl->timer.cb_mode = HRTIMER_CB_IRQSAFE_UNLOCKED;
1461 static int __sched do_nanosleep(struct hrtimer_sleeper *t, enum hrtimer_mode mode)
1463 hrtimer_init_sleeper(t, current);
1466 set_current_state(TASK_INTERRUPTIBLE);
1467 hrtimer_start(&t->timer, t->timer.expires, mode);
1468 if (!hrtimer_active(&t->timer))
1471 if (likely(t->task))
1474 hrtimer_cancel(&t->timer);
1475 mode = HRTIMER_MODE_ABS;
1477 } while (t->task && !signal_pending(current));
1479 __set_current_state(TASK_RUNNING);
1481 return t->task == NULL;
1484 static int update_rmtp(struct hrtimer *timer, struct timespec __user *rmtp)
1486 struct timespec rmt;
1489 rem = ktime_sub(timer->expires, timer->base->get_time());
1492 rmt = ktime_to_timespec(rem);
1494 if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
1500 long __sched hrtimer_nanosleep_restart(struct restart_block *restart)
1502 struct hrtimer_sleeper t;
1503 struct timespec __user *rmtp;
1506 hrtimer_init_on_stack(&t.timer, restart->nanosleep.index,
1508 t.timer.expires.tv64 = restart->nanosleep.expires;
1510 if (do_nanosleep(&t, HRTIMER_MODE_ABS))
1513 rmtp = restart->nanosleep.rmtp;
1515 ret = update_rmtp(&t.timer, rmtp);
1520 /* The other values in restart are already filled in */
1521 ret = -ERESTART_RESTARTBLOCK;
1523 destroy_hrtimer_on_stack(&t.timer);
1527 long hrtimer_nanosleep(struct timespec *rqtp, struct timespec __user *rmtp,
1528 const enum hrtimer_mode mode, const clockid_t clockid)
1530 struct restart_block *restart;
1531 struct hrtimer_sleeper t;
1534 hrtimer_init_on_stack(&t.timer, clockid, mode);
1535 t.timer.expires = timespec_to_ktime(*rqtp);
1536 if (do_nanosleep(&t, mode))
1539 /* Absolute timers do not update the rmtp value and restart: */
1540 if (mode == HRTIMER_MODE_ABS) {
1541 ret = -ERESTARTNOHAND;
1546 ret = update_rmtp(&t.timer, rmtp);
1551 restart = ¤t_thread_info()->restart_block;
1552 restart->fn = hrtimer_nanosleep_restart;
1553 restart->nanosleep.index = t.timer.base->index;
1554 restart->nanosleep.rmtp = rmtp;
1555 restart->nanosleep.expires = t.timer.expires.tv64;
1557 ret = -ERESTART_RESTARTBLOCK;
1559 destroy_hrtimer_on_stack(&t.timer);
1564 sys_nanosleep(struct timespec __user *rqtp, struct timespec __user *rmtp)
1568 if (copy_from_user(&tu, rqtp, sizeof(tu)))
1571 if (!timespec_valid(&tu))
1574 return hrtimer_nanosleep(&tu, rmtp, HRTIMER_MODE_REL, CLOCK_MONOTONIC);
1578 * Functions related to boot-time initialization:
1580 static void __cpuinit init_hrtimers_cpu(int cpu)
1582 struct hrtimer_cpu_base *cpu_base = &per_cpu(hrtimer_bases, cpu);
1585 spin_lock_init(&cpu_base->lock);
1587 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
1588 cpu_base->clock_base[i].cpu_base = cpu_base;
1590 INIT_LIST_HEAD(&cpu_base->cb_pending);
1591 hrtimer_init_hres(cpu_base);
1594 #ifdef CONFIG_HOTPLUG_CPU
1596 static int migrate_hrtimer_list(struct hrtimer_clock_base *old_base,
1597 struct hrtimer_clock_base *new_base, int dcpu)
1599 struct hrtimer *timer;
1600 struct rb_node *node;
1603 while ((node = rb_first(&old_base->active))) {
1604 timer = rb_entry(node, struct hrtimer, node);
1605 BUG_ON(hrtimer_callback_running(timer));
1606 debug_hrtimer_deactivate(timer);
1609 * Should not happen. Per CPU timers should be
1610 * canceled _before_ the migration code is called
1612 if (timer->cb_mode == HRTIMER_CB_IRQSAFE_PERCPU) {
1613 __remove_hrtimer(timer, old_base,
1614 HRTIMER_STATE_INACTIVE, 0);
1615 WARN(1, "hrtimer (%p %p)active but cpu %d dead\n",
1616 timer, timer->function, dcpu);
1621 * Mark it as STATE_MIGRATE not INACTIVE otherwise the
1622 * timer could be seen as !active and just vanish away
1623 * under us on another CPU
1625 __remove_hrtimer(timer, old_base, HRTIMER_STATE_MIGRATE, 0);
1626 timer->base = new_base;
1628 * Enqueue the timer. Allow reprogramming of the event device
1630 enqueue_hrtimer(timer, new_base, 1);
1632 #ifdef CONFIG_HIGH_RES_TIMERS
1634 * Happens with high res enabled when the timer was
1635 * already expired and the callback mode is
1636 * HRTIMER_CB_IRQSAFE_UNLOCKED (hrtimer_sleeper). The
1637 * enqueue code does not move them to the soft irq
1638 * pending list for performance/latency reasons, but
1639 * in the migration state, we need to do that
1640 * otherwise we end up with a stale timer.
1642 if (timer->state == HRTIMER_STATE_MIGRATE) {
1643 timer->state = HRTIMER_STATE_PENDING;
1644 list_add_tail(&timer->cb_entry,
1645 &new_base->cpu_base->cb_pending);
1649 /* Clear the migration state bit */
1650 timer->state &= ~HRTIMER_STATE_MIGRATE;
1655 #ifdef CONFIG_HIGH_RES_TIMERS
1656 static int migrate_hrtimer_pending(struct hrtimer_cpu_base *old_base,
1657 struct hrtimer_cpu_base *new_base)
1659 struct hrtimer *timer;
1662 while (!list_empty(&old_base->cb_pending)) {
1663 timer = list_entry(old_base->cb_pending.next,
1664 struct hrtimer, cb_entry);
1666 __remove_hrtimer(timer, timer->base, HRTIMER_STATE_PENDING, 0);
1667 timer->base = &new_base->clock_base[timer->base->index];
1668 list_add_tail(&timer->cb_entry, &new_base->cb_pending);
1674 static int migrate_hrtimer_pending(struct hrtimer_cpu_base *old_base,
1675 struct hrtimer_cpu_base *new_base)
1681 static void migrate_hrtimers(int cpu)
1683 struct hrtimer_cpu_base *old_base, *new_base;
1686 BUG_ON(cpu_online(cpu));
1687 old_base = &per_cpu(hrtimer_bases, cpu);
1688 new_base = &get_cpu_var(hrtimer_bases);
1690 tick_cancel_sched_timer(cpu);
1692 local_irq_disable();
1693 spin_lock(&new_base->lock);
1694 spin_lock_nested(&old_base->lock, SINGLE_DEPTH_NESTING);
1696 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
1697 if (migrate_hrtimer_list(&old_base->clock_base[i],
1698 &new_base->clock_base[i], cpu))
1702 if (migrate_hrtimer_pending(old_base, new_base))
1705 spin_unlock(&old_base->lock);
1706 spin_unlock(&new_base->lock);
1708 put_cpu_var(hrtimer_bases);
1711 hrtimer_raise_softirq();
1713 #endif /* CONFIG_HOTPLUG_CPU */
1715 static int __cpuinit hrtimer_cpu_notify(struct notifier_block *self,
1716 unsigned long action, void *hcpu)
1718 unsigned int cpu = (long)hcpu;
1722 case CPU_UP_PREPARE:
1723 case CPU_UP_PREPARE_FROZEN:
1724 init_hrtimers_cpu(cpu);
1727 #ifdef CONFIG_HOTPLUG_CPU
1729 case CPU_DEAD_FROZEN:
1730 clockevents_notify(CLOCK_EVT_NOTIFY_CPU_DEAD, &cpu);
1731 migrate_hrtimers(cpu);
1742 static struct notifier_block __cpuinitdata hrtimers_nb = {
1743 .notifier_call = hrtimer_cpu_notify,
1746 void __init hrtimers_init(void)
1748 hrtimer_cpu_notify(&hrtimers_nb, (unsigned long)CPU_UP_PREPARE,
1749 (void *)(long)smp_processor_id());
1750 register_cpu_notifier(&hrtimers_nb);
1751 #ifdef CONFIG_HIGH_RES_TIMERS
1752 open_softirq(HRTIMER_SOFTIRQ, run_hrtimer_softirq);