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>
47 #include <asm/uaccess.h>
50 * ktime_get - get the monotonic time in ktime_t format
52 * returns the time in ktime_t format
54 ktime_t
ktime_get(void)
60 return timespec_to_ktime(now
);
62 EXPORT_SYMBOL_GPL(ktime_get
);
65 * ktime_get_real - get the real (wall-) time in ktime_t format
67 * returns the time in ktime_t format
69 ktime_t
ktime_get_real(void)
75 return timespec_to_ktime(now
);
78 EXPORT_SYMBOL_GPL(ktime_get_real
);
83 * Note: If we want to add new timer bases, we have to skip the two
84 * clock ids captured by the cpu-timers. We do this by holding empty
85 * entries rather than doing math adjustment of the clock ids.
86 * This ensures that we capture erroneous accesses to these clock ids
87 * rather than moving them into the range of valid clock id's.
89 DEFINE_PER_CPU(struct hrtimer_cpu_base
, hrtimer_bases
) =
95 .index
= CLOCK_REALTIME
,
96 .get_time
= &ktime_get_real
,
97 .resolution
= KTIME_LOW_RES
,
100 .index
= CLOCK_MONOTONIC
,
101 .get_time
= &ktime_get
,
102 .resolution
= KTIME_LOW_RES
,
108 * ktime_get_ts - get the monotonic clock in timespec format
109 * @ts: pointer to timespec variable
111 * The function calculates the monotonic clock from the realtime
112 * clock and the wall_to_monotonic offset and stores the result
113 * in normalized timespec format in the variable pointed to by @ts.
115 void ktime_get_ts(struct timespec
*ts
)
117 struct timespec tomono
;
121 seq
= read_seqbegin(&xtime_lock
);
123 tomono
= wall_to_monotonic
;
125 } while (read_seqretry(&xtime_lock
, seq
));
127 set_normalized_timespec(ts
, ts
->tv_sec
+ tomono
.tv_sec
,
128 ts
->tv_nsec
+ tomono
.tv_nsec
);
130 EXPORT_SYMBOL_GPL(ktime_get_ts
);
133 * Get the coarse grained time at the softirq based on xtime and
136 static void hrtimer_get_softirq_time(struct hrtimer_cpu_base
*base
)
138 ktime_t xtim
, tomono
;
139 struct timespec xts
, tom
;
143 seq
= read_seqbegin(&xtime_lock
);
144 xts
= current_kernel_time();
145 tom
= wall_to_monotonic
;
146 } while (read_seqretry(&xtime_lock
, seq
));
148 xtim
= timespec_to_ktime(xts
);
149 tomono
= timespec_to_ktime(tom
);
150 base
->clock_base
[CLOCK_REALTIME
].softirq_time
= xtim
;
151 base
->clock_base
[CLOCK_MONOTONIC
].softirq_time
=
152 ktime_add(xtim
, tomono
);
156 * Helper function to check, whether the timer is running the callback
159 static inline int hrtimer_callback_running(struct hrtimer
*timer
)
161 return timer
->state
& HRTIMER_STATE_CALLBACK
;
165 * Functions and macros which are different for UP/SMP systems are kept in a
171 * We are using hashed locking: holding per_cpu(hrtimer_bases)[n].lock
172 * means that all timers which are tied to this base via timer->base are
173 * locked, and the base itself is locked too.
175 * So __run_timers/migrate_timers can safely modify all timers which could
176 * be found on the lists/queues.
178 * When the timer's base is locked, and the timer removed from list, it is
179 * possible to set timer->base = NULL and drop the lock: the timer remains
183 struct hrtimer_clock_base
*lock_hrtimer_base(const struct hrtimer
*timer
,
184 unsigned long *flags
)
186 struct hrtimer_clock_base
*base
;
190 if (likely(base
!= NULL
)) {
191 spin_lock_irqsave(&base
->cpu_base
->lock
, *flags
);
192 if (likely(base
== timer
->base
))
194 /* The timer has migrated to another CPU: */
195 spin_unlock_irqrestore(&base
->cpu_base
->lock
, *flags
);
202 * Switch the timer base to the current CPU when possible.
204 static inline struct hrtimer_clock_base
*
205 switch_hrtimer_base(struct hrtimer
*timer
, struct hrtimer_clock_base
*base
)
207 struct hrtimer_clock_base
*new_base
;
208 struct hrtimer_cpu_base
*new_cpu_base
;
210 new_cpu_base
= &__get_cpu_var(hrtimer_bases
);
211 new_base
= &new_cpu_base
->clock_base
[base
->index
];
213 if (base
!= new_base
) {
215 * We are trying to schedule the timer on the local CPU.
216 * However we can't change timer's base while it is running,
217 * so we keep it on the same CPU. No hassle vs. reprogramming
218 * the event source in the high resolution case. The softirq
219 * code will take care of this when the timer function has
220 * completed. There is no conflict as we hold the lock until
221 * the timer is enqueued.
223 if (unlikely(hrtimer_callback_running(timer
)))
226 /* See the comment in lock_timer_base() */
228 spin_unlock(&base
->cpu_base
->lock
);
229 spin_lock(&new_base
->cpu_base
->lock
);
230 timer
->base
= new_base
;
235 #else /* CONFIG_SMP */
237 static inline struct hrtimer_clock_base
*
238 lock_hrtimer_base(const struct hrtimer
*timer
, unsigned long *flags
)
240 struct hrtimer_clock_base
*base
= timer
->base
;
242 spin_lock_irqsave(&base
->cpu_base
->lock
, *flags
);
247 # define switch_hrtimer_base(t, b) (b)
249 #endif /* !CONFIG_SMP */
252 * Functions for the union type storage format of ktime_t which are
253 * too large for inlining:
255 #if BITS_PER_LONG < 64
256 # ifndef CONFIG_KTIME_SCALAR
258 * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
260 * @nsec: the scalar nsec value to add
262 * Returns the sum of kt and nsec in ktime_t format
264 ktime_t
ktime_add_ns(const ktime_t kt
, u64 nsec
)
268 if (likely(nsec
< NSEC_PER_SEC
)) {
271 unsigned long rem
= do_div(nsec
, NSEC_PER_SEC
);
273 tmp
= ktime_set((long)nsec
, rem
);
276 return ktime_add(kt
, tmp
);
279 EXPORT_SYMBOL_GPL(ktime_add_ns
);
282 * ktime_sub_ns - Subtract a scalar nanoseconds value from a ktime_t variable
284 * @nsec: the scalar nsec value to subtract
286 * Returns the subtraction of @nsec from @kt in ktime_t format
288 ktime_t
ktime_sub_ns(const ktime_t kt
, u64 nsec
)
292 if (likely(nsec
< NSEC_PER_SEC
)) {
295 unsigned long rem
= do_div(nsec
, NSEC_PER_SEC
);
297 tmp
= ktime_set((long)nsec
, rem
);
300 return ktime_sub(kt
, tmp
);
303 EXPORT_SYMBOL_GPL(ktime_sub_ns
);
304 # endif /* !CONFIG_KTIME_SCALAR */
307 * Divide a ktime value by a nanosecond value
309 unsigned long ktime_divns(const ktime_t kt
, s64 div
)
314 dclc
= dns
= ktime_to_ns(kt
);
316 /* Make sure the divisor is less than 2^32: */
322 do_div(dclc
, (unsigned long) div
);
324 return (unsigned long) dclc
;
326 #endif /* BITS_PER_LONG >= 64 */
328 /* High resolution timer related functions */
329 #ifdef CONFIG_HIGH_RES_TIMERS
332 * High resolution timer enabled ?
334 static int hrtimer_hres_enabled __read_mostly
= 1;
337 * Enable / Disable high resolution mode
339 static int __init
setup_hrtimer_hres(char *str
)
341 if (!strcmp(str
, "off"))
342 hrtimer_hres_enabled
= 0;
343 else if (!strcmp(str
, "on"))
344 hrtimer_hres_enabled
= 1;
350 __setup("highres=", setup_hrtimer_hres
);
353 * hrtimer_high_res_enabled - query, if the highres mode is enabled
355 static inline int hrtimer_is_hres_enabled(void)
357 return hrtimer_hres_enabled
;
361 * Is the high resolution mode active ?
363 static inline int hrtimer_hres_active(void)
365 return __get_cpu_var(hrtimer_bases
).hres_active
;
369 * Reprogram the event source with checking both queues for the
371 * Called with interrupts disabled and base->lock held
373 static void hrtimer_force_reprogram(struct hrtimer_cpu_base
*cpu_base
)
376 struct hrtimer_clock_base
*base
= cpu_base
->clock_base
;
379 cpu_base
->expires_next
.tv64
= KTIME_MAX
;
381 for (i
= 0; i
< HRTIMER_MAX_CLOCK_BASES
; i
++, base
++) {
382 struct hrtimer
*timer
;
386 timer
= rb_entry(base
->first
, struct hrtimer
, node
);
387 expires
= ktime_sub(timer
->expires
, base
->offset
);
388 if (expires
.tv64
< cpu_base
->expires_next
.tv64
)
389 cpu_base
->expires_next
= expires
;
392 if (cpu_base
->expires_next
.tv64
!= KTIME_MAX
)
393 tick_program_event(cpu_base
->expires_next
, 1);
397 * Shared reprogramming for clock_realtime and clock_monotonic
399 * When a timer is enqueued and expires earlier than the already enqueued
400 * timers, we have to check, whether it expires earlier than the timer for
401 * which the clock event device was armed.
403 * Called with interrupts disabled and base->cpu_base.lock held
405 static int hrtimer_reprogram(struct hrtimer
*timer
,
406 struct hrtimer_clock_base
*base
)
408 ktime_t
*expires_next
= &__get_cpu_var(hrtimer_bases
).expires_next
;
409 ktime_t expires
= ktime_sub(timer
->expires
, base
->offset
);
413 * When the callback is running, we do not reprogram the clock event
414 * device. The timer callback is either running on a different CPU or
415 * the callback is executed in the hrtimer_interrupt context. The
416 * reprogramming is handled either by the softirq, which called the
417 * callback or at the end of the hrtimer_interrupt.
419 if (hrtimer_callback_running(timer
))
422 if (expires
.tv64
>= expires_next
->tv64
)
426 * Clockevents returns -ETIME, when the event was in the past.
428 res
= tick_program_event(expires
, 0);
429 if (!IS_ERR_VALUE(res
))
430 *expires_next
= expires
;
436 * Retrigger next event is called after clock was set
438 * Called with interrupts disabled via on_each_cpu()
440 static void retrigger_next_event(void *arg
)
442 struct hrtimer_cpu_base
*base
;
443 struct timespec realtime_offset
;
446 if (!hrtimer_hres_active())
450 seq
= read_seqbegin(&xtime_lock
);
451 set_normalized_timespec(&realtime_offset
,
452 -wall_to_monotonic
.tv_sec
,
453 -wall_to_monotonic
.tv_nsec
);
454 } while (read_seqretry(&xtime_lock
, seq
));
456 base
= &__get_cpu_var(hrtimer_bases
);
458 /* Adjust CLOCK_REALTIME offset */
459 spin_lock(&base
->lock
);
460 base
->clock_base
[CLOCK_REALTIME
].offset
=
461 timespec_to_ktime(realtime_offset
);
463 hrtimer_force_reprogram(base
);
464 spin_unlock(&base
->lock
);
468 * Clock realtime was set
470 * Change the offset of the realtime clock vs. the monotonic
473 * We might have to reprogram the high resolution timer interrupt. On
474 * SMP we call the architecture specific code to retrigger _all_ high
475 * resolution timer interrupts. On UP we just disable interrupts and
476 * call the high resolution interrupt code.
478 void clock_was_set(void)
480 /* Retrigger the CPU local events everywhere */
481 on_each_cpu(retrigger_next_event
, NULL
, 0, 1);
485 * During resume we might have to reprogram the high resolution timer
486 * interrupt (on the local CPU):
488 void hres_timers_resume(void)
490 WARN_ON_ONCE(num_online_cpus() > 1);
492 /* Retrigger the CPU local events: */
493 retrigger_next_event(NULL
);
497 * Check, whether the timer is on the callback pending list
499 static inline int hrtimer_cb_pending(const struct hrtimer
*timer
)
501 return timer
->state
& HRTIMER_STATE_PENDING
;
505 * Remove a timer from the callback pending list
507 static inline void hrtimer_remove_cb_pending(struct hrtimer
*timer
)
509 list_del_init(&timer
->cb_entry
);
513 * Initialize the high resolution related parts of cpu_base
515 static inline void hrtimer_init_hres(struct hrtimer_cpu_base
*base
)
517 base
->expires_next
.tv64
= KTIME_MAX
;
518 base
->hres_active
= 0;
519 INIT_LIST_HEAD(&base
->cb_pending
);
523 * Initialize the high resolution related parts of a hrtimer
525 static inline void hrtimer_init_timer_hres(struct hrtimer
*timer
)
527 INIT_LIST_HEAD(&timer
->cb_entry
);
531 * When High resolution timers are active, try to reprogram. Note, that in case
532 * the state has HRTIMER_STATE_CALLBACK set, no reprogramming and no expiry
533 * check happens. The timer gets enqueued into the rbtree. The reprogramming
534 * and expiry check is done in the hrtimer_interrupt or in the softirq.
536 static inline int hrtimer_enqueue_reprogram(struct hrtimer
*timer
,
537 struct hrtimer_clock_base
*base
)
539 if (base
->cpu_base
->hres_active
&& hrtimer_reprogram(timer
, base
)) {
541 /* Timer is expired, act upon the callback mode */
542 switch(timer
->cb_mode
) {
543 case HRTIMER_CB_IRQSAFE_NO_RESTART
:
545 * We can call the callback from here. No restart
546 * happens, so no danger of recursion
548 BUG_ON(timer
->function(timer
) != HRTIMER_NORESTART
);
550 case HRTIMER_CB_IRQSAFE_NO_SOFTIRQ
:
552 * This is solely for the sched tick emulation with
553 * dynamic tick support to ensure that we do not
554 * restart the tick right on the edge and end up with
555 * the tick timer in the softirq ! The calling site
556 * takes care of this.
559 case HRTIMER_CB_IRQSAFE
:
560 case HRTIMER_CB_SOFTIRQ
:
562 * Move everything else into the softirq pending list !
564 list_add_tail(&timer
->cb_entry
,
565 &base
->cpu_base
->cb_pending
);
566 timer
->state
= HRTIMER_STATE_PENDING
;
567 raise_softirq(HRTIMER_SOFTIRQ
);
577 * Switch to high resolution mode
579 static int hrtimer_switch_to_hres(void)
581 int cpu
= smp_processor_id();
582 struct hrtimer_cpu_base
*base
= &per_cpu(hrtimer_bases
, cpu
);
585 if (base
->hres_active
)
588 local_irq_save(flags
);
590 if (tick_init_highres()) {
591 local_irq_restore(flags
);
592 printk(KERN_WARNING
"Could not switch to high resolution "
593 "mode on CPU %d\n", cpu
);
596 base
->hres_active
= 1;
597 base
->clock_base
[CLOCK_REALTIME
].resolution
= KTIME_HIGH_RES
;
598 base
->clock_base
[CLOCK_MONOTONIC
].resolution
= KTIME_HIGH_RES
;
600 tick_setup_sched_timer();
602 /* "Retrigger" the interrupt to get things going */
603 retrigger_next_event(NULL
);
604 local_irq_restore(flags
);
605 printk(KERN_DEBUG
"Switched to high resolution mode on CPU %d\n",
612 static inline int hrtimer_hres_active(void) { return 0; }
613 static inline int hrtimer_is_hres_enabled(void) { return 0; }
614 static inline int hrtimer_switch_to_hres(void) { return 0; }
615 static inline void hrtimer_force_reprogram(struct hrtimer_cpu_base
*base
) { }
616 static inline int hrtimer_enqueue_reprogram(struct hrtimer
*timer
,
617 struct hrtimer_clock_base
*base
)
621 static inline int hrtimer_cb_pending(struct hrtimer
*timer
) { return 0; }
622 static inline void hrtimer_remove_cb_pending(struct hrtimer
*timer
) { }
623 static inline void hrtimer_init_hres(struct hrtimer_cpu_base
*base
) { }
624 static inline void hrtimer_init_timer_hres(struct hrtimer
*timer
) { }
626 #endif /* CONFIG_HIGH_RES_TIMERS */
628 #ifdef CONFIG_TIMER_STATS
629 void __timer_stats_hrtimer_set_start_info(struct hrtimer
*timer
, void *addr
)
631 if (timer
->start_site
)
634 timer
->start_site
= addr
;
635 memcpy(timer
->start_comm
, current
->comm
, TASK_COMM_LEN
);
636 timer
->start_pid
= current
->pid
;
641 * Counterpart to lock_hrtimer_base above:
644 void unlock_hrtimer_base(const struct hrtimer
*timer
, unsigned long *flags
)
646 spin_unlock_irqrestore(&timer
->base
->cpu_base
->lock
, *flags
);
650 * hrtimer_forward - forward the timer expiry
651 * @timer: hrtimer to forward
652 * @now: forward past this time
653 * @interval: the interval to forward
655 * Forward the timer expiry so it will expire in the future.
656 * Returns the number of overruns.
659 hrtimer_forward(struct hrtimer
*timer
, ktime_t now
, ktime_t interval
)
661 unsigned long orun
= 1;
664 delta
= ktime_sub(now
, timer
->expires
);
669 if (interval
.tv64
< timer
->base
->resolution
.tv64
)
670 interval
.tv64
= timer
->base
->resolution
.tv64
;
672 if (unlikely(delta
.tv64
>= interval
.tv64
)) {
673 s64 incr
= ktime_to_ns(interval
);
675 orun
= ktime_divns(delta
, incr
);
676 timer
->expires
= ktime_add_ns(timer
->expires
, incr
* orun
);
677 if (timer
->expires
.tv64
> now
.tv64
)
680 * This (and the ktime_add() below) is the
681 * correction for exact:
685 timer
->expires
= ktime_add(timer
->expires
, interval
);
687 * Make sure, that the result did not wrap with a very large
690 if (timer
->expires
.tv64
< 0)
691 timer
->expires
= ktime_set(KTIME_SEC_MAX
, 0);
695 EXPORT_SYMBOL_GPL(hrtimer_forward
);
698 * enqueue_hrtimer - internal function to (re)start a timer
700 * The timer is inserted in expiry order. Insertion into the
701 * red black tree is O(log(n)). Must hold the base lock.
703 static void enqueue_hrtimer(struct hrtimer
*timer
,
704 struct hrtimer_clock_base
*base
, int reprogram
)
706 struct rb_node
**link
= &base
->active
.rb_node
;
707 struct rb_node
*parent
= NULL
;
708 struct hrtimer
*entry
;
712 * Find the right place in the rbtree:
716 entry
= rb_entry(parent
, struct hrtimer
, node
);
718 * We dont care about collisions. Nodes with
719 * the same expiry time stay together.
721 if (timer
->expires
.tv64
< entry
->expires
.tv64
) {
722 link
= &(*link
)->rb_left
;
724 link
= &(*link
)->rb_right
;
730 * Insert the timer to the rbtree and check whether it
731 * replaces the first pending timer
735 * Reprogram the clock event device. When the timer is already
736 * expired hrtimer_enqueue_reprogram has either called the
737 * callback or added it to the pending list and raised the
740 * This is a NOP for !HIGHRES
742 if (reprogram
&& hrtimer_enqueue_reprogram(timer
, base
))
745 base
->first
= &timer
->node
;
748 rb_link_node(&timer
->node
, parent
, link
);
749 rb_insert_color(&timer
->node
, &base
->active
);
751 * HRTIMER_STATE_ENQUEUED is or'ed to the current state to preserve the
752 * state of a possibly running callback.
754 timer
->state
|= HRTIMER_STATE_ENQUEUED
;
758 * __remove_hrtimer - internal function to remove a timer
760 * Caller must hold the base lock.
762 * High resolution timer mode reprograms the clock event device when the
763 * timer is the one which expires next. The caller can disable this by setting
764 * reprogram to zero. This is useful, when the context does a reprogramming
765 * anyway (e.g. timer interrupt)
767 static void __remove_hrtimer(struct hrtimer
*timer
,
768 struct hrtimer_clock_base
*base
,
769 unsigned long newstate
, int reprogram
)
771 /* High res. callback list. NOP for !HIGHRES */
772 if (hrtimer_cb_pending(timer
))
773 hrtimer_remove_cb_pending(timer
);
776 * Remove the timer from the rbtree and replace the
777 * first entry pointer if necessary.
779 if (base
->first
== &timer
->node
) {
780 base
->first
= rb_next(&timer
->node
);
781 /* Reprogram the clock event device. if enabled */
782 if (reprogram
&& hrtimer_hres_active())
783 hrtimer_force_reprogram(base
->cpu_base
);
785 rb_erase(&timer
->node
, &base
->active
);
787 timer
->state
= newstate
;
791 * remove hrtimer, called with base lock held
794 remove_hrtimer(struct hrtimer
*timer
, struct hrtimer_clock_base
*base
)
796 if (hrtimer_is_queued(timer
)) {
800 * Remove the timer and force reprogramming when high
801 * resolution mode is active and the timer is on the current
802 * CPU. If we remove a timer on another CPU, reprogramming is
803 * skipped. The interrupt event on this CPU is fired and
804 * reprogramming happens in the interrupt handler. This is a
805 * rare case and less expensive than a smp call.
807 timer_stats_hrtimer_clear_start_info(timer
);
808 reprogram
= base
->cpu_base
== &__get_cpu_var(hrtimer_bases
);
809 __remove_hrtimer(timer
, base
, HRTIMER_STATE_INACTIVE
,
817 * hrtimer_start - (re)start an relative timer on the current CPU
818 * @timer: the timer to be added
820 * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
824 * 1 when the timer was active
827 hrtimer_start(struct hrtimer
*timer
, ktime_t tim
, const enum hrtimer_mode mode
)
829 struct hrtimer_clock_base
*base
, *new_base
;
833 base
= lock_hrtimer_base(timer
, &flags
);
835 /* Remove an active timer from the queue: */
836 ret
= remove_hrtimer(timer
, base
);
838 /* Switch the timer base, if necessary: */
839 new_base
= switch_hrtimer_base(timer
, base
);
841 if (mode
== HRTIMER_MODE_REL
) {
842 tim
= ktime_add(tim
, new_base
->get_time());
844 * CONFIG_TIME_LOW_RES is a temporary way for architectures
845 * to signal that they simply return xtime in
846 * do_gettimeoffset(). In this case we want to round up by
847 * resolution when starting a relative timer, to avoid short
848 * timeouts. This will go away with the GTOD framework.
850 #ifdef CONFIG_TIME_LOW_RES
851 tim
= ktime_add(tim
, base
->resolution
);
854 * Careful here: User space might have asked for a
855 * very long sleep, so the add above might result in a
856 * negative number, which enqueues the timer in front
860 tim
.tv64
= KTIME_MAX
;
862 timer
->expires
= tim
;
864 timer_stats_hrtimer_set_start_info(timer
);
867 * Only allow reprogramming if the new base is on this CPU.
868 * (it might still be on another CPU if the timer was pending)
870 enqueue_hrtimer(timer
, new_base
,
871 new_base
->cpu_base
== &__get_cpu_var(hrtimer_bases
));
873 unlock_hrtimer_base(timer
, &flags
);
877 EXPORT_SYMBOL_GPL(hrtimer_start
);
880 * hrtimer_try_to_cancel - try to deactivate a timer
881 * @timer: hrtimer to stop
884 * 0 when the timer was not active
885 * 1 when the timer was active
886 * -1 when the timer is currently excuting the callback function and
889 int hrtimer_try_to_cancel(struct hrtimer
*timer
)
891 struct hrtimer_clock_base
*base
;
895 base
= lock_hrtimer_base(timer
, &flags
);
897 if (!hrtimer_callback_running(timer
))
898 ret
= remove_hrtimer(timer
, base
);
900 unlock_hrtimer_base(timer
, &flags
);
905 EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel
);
908 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
909 * @timer: the timer to be cancelled
912 * 0 when the timer was not active
913 * 1 when the timer was active
915 int hrtimer_cancel(struct hrtimer
*timer
)
918 int ret
= hrtimer_try_to_cancel(timer
);
925 EXPORT_SYMBOL_GPL(hrtimer_cancel
);
928 * hrtimer_get_remaining - get remaining time for the timer
929 * @timer: the timer to read
931 ktime_t
hrtimer_get_remaining(const struct hrtimer
*timer
)
933 struct hrtimer_clock_base
*base
;
937 base
= lock_hrtimer_base(timer
, &flags
);
938 rem
= ktime_sub(timer
->expires
, base
->get_time());
939 unlock_hrtimer_base(timer
, &flags
);
943 EXPORT_SYMBOL_GPL(hrtimer_get_remaining
);
945 #if defined(CONFIG_NO_IDLE_HZ) || defined(CONFIG_NO_HZ)
947 * hrtimer_get_next_event - get the time until next expiry event
949 * Returns the delta to the next expiry event or KTIME_MAX if no timer
952 ktime_t
hrtimer_get_next_event(void)
954 struct hrtimer_cpu_base
*cpu_base
= &__get_cpu_var(hrtimer_bases
);
955 struct hrtimer_clock_base
*base
= cpu_base
->clock_base
;
956 ktime_t delta
, mindelta
= { .tv64
= KTIME_MAX
};
960 spin_lock_irqsave(&cpu_base
->lock
, flags
);
962 if (!hrtimer_hres_active()) {
963 for (i
= 0; i
< HRTIMER_MAX_CLOCK_BASES
; i
++, base
++) {
964 struct hrtimer
*timer
;
969 timer
= rb_entry(base
->first
, struct hrtimer
, node
);
970 delta
.tv64
= timer
->expires
.tv64
;
971 delta
= ktime_sub(delta
, base
->get_time());
972 if (delta
.tv64
< mindelta
.tv64
)
973 mindelta
.tv64
= delta
.tv64
;
977 spin_unlock_irqrestore(&cpu_base
->lock
, flags
);
979 if (mindelta
.tv64
< 0)
986 * hrtimer_init - initialize a timer to the given clock
987 * @timer: the timer to be initialized
988 * @clock_id: the clock to be used
989 * @mode: timer mode abs/rel
991 void hrtimer_init(struct hrtimer
*timer
, clockid_t clock_id
,
992 enum hrtimer_mode mode
)
994 struct hrtimer_cpu_base
*cpu_base
;
996 memset(timer
, 0, sizeof(struct hrtimer
));
998 cpu_base
= &__raw_get_cpu_var(hrtimer_bases
);
1000 if (clock_id
== CLOCK_REALTIME
&& mode
!= HRTIMER_MODE_ABS
)
1001 clock_id
= CLOCK_MONOTONIC
;
1003 timer
->base
= &cpu_base
->clock_base
[clock_id
];
1004 hrtimer_init_timer_hres(timer
);
1006 #ifdef CONFIG_TIMER_STATS
1007 timer
->start_site
= NULL
;
1008 timer
->start_pid
= -1;
1009 memset(timer
->start_comm
, 0, TASK_COMM_LEN
);
1012 EXPORT_SYMBOL_GPL(hrtimer_init
);
1015 * hrtimer_get_res - get the timer resolution for a clock
1016 * @which_clock: which clock to query
1017 * @tp: pointer to timespec variable to store the resolution
1019 * Store the resolution of the clock selected by @which_clock in the
1020 * variable pointed to by @tp.
1022 int hrtimer_get_res(const clockid_t which_clock
, struct timespec
*tp
)
1024 struct hrtimer_cpu_base
*cpu_base
;
1026 cpu_base
= &__raw_get_cpu_var(hrtimer_bases
);
1027 *tp
= ktime_to_timespec(cpu_base
->clock_base
[which_clock
].resolution
);
1031 EXPORT_SYMBOL_GPL(hrtimer_get_res
);
1033 #ifdef CONFIG_HIGH_RES_TIMERS
1036 * High resolution timer interrupt
1037 * Called with interrupts disabled
1039 void hrtimer_interrupt(struct clock_event_device
*dev
)
1041 struct hrtimer_cpu_base
*cpu_base
= &__get_cpu_var(hrtimer_bases
);
1042 struct hrtimer_clock_base
*base
;
1043 ktime_t expires_next
, now
;
1046 BUG_ON(!cpu_base
->hres_active
);
1047 cpu_base
->nr_events
++;
1048 dev
->next_event
.tv64
= KTIME_MAX
;
1053 expires_next
.tv64
= KTIME_MAX
;
1055 base
= cpu_base
->clock_base
;
1057 for (i
= 0; i
< HRTIMER_MAX_CLOCK_BASES
; i
++) {
1059 struct rb_node
*node
;
1061 spin_lock(&cpu_base
->lock
);
1063 basenow
= ktime_add(now
, base
->offset
);
1065 while ((node
= base
->first
)) {
1066 struct hrtimer
*timer
;
1068 timer
= rb_entry(node
, struct hrtimer
, node
);
1070 if (basenow
.tv64
< timer
->expires
.tv64
) {
1073 expires
= ktime_sub(timer
->expires
,
1075 if (expires
.tv64
< expires_next
.tv64
)
1076 expires_next
= expires
;
1080 /* Move softirq callbacks to the pending list */
1081 if (timer
->cb_mode
== HRTIMER_CB_SOFTIRQ
) {
1082 __remove_hrtimer(timer
, base
,
1083 HRTIMER_STATE_PENDING
, 0);
1084 list_add_tail(&timer
->cb_entry
,
1085 &base
->cpu_base
->cb_pending
);
1090 __remove_hrtimer(timer
, base
,
1091 HRTIMER_STATE_CALLBACK
, 0);
1092 timer_stats_account_hrtimer(timer
);
1095 * Note: We clear the CALLBACK bit after
1096 * enqueue_hrtimer to avoid reprogramming of
1097 * the event hardware. This happens at the end
1098 * of this function anyway.
1100 if (timer
->function(timer
) != HRTIMER_NORESTART
) {
1101 BUG_ON(timer
->state
!= HRTIMER_STATE_CALLBACK
);
1102 enqueue_hrtimer(timer
, base
, 0);
1104 timer
->state
&= ~HRTIMER_STATE_CALLBACK
;
1106 spin_unlock(&cpu_base
->lock
);
1110 cpu_base
->expires_next
= expires_next
;
1112 /* Reprogramming necessary ? */
1113 if (expires_next
.tv64
!= KTIME_MAX
) {
1114 if (tick_program_event(expires_next
, 0))
1118 /* Raise softirq ? */
1120 raise_softirq(HRTIMER_SOFTIRQ
);
1123 static void run_hrtimer_softirq(struct softirq_action
*h
)
1125 struct hrtimer_cpu_base
*cpu_base
= &__get_cpu_var(hrtimer_bases
);
1127 spin_lock_irq(&cpu_base
->lock
);
1129 while (!list_empty(&cpu_base
->cb_pending
)) {
1130 enum hrtimer_restart (*fn
)(struct hrtimer
*);
1131 struct hrtimer
*timer
;
1134 timer
= list_entry(cpu_base
->cb_pending
.next
,
1135 struct hrtimer
, cb_entry
);
1137 timer_stats_account_hrtimer(timer
);
1139 fn
= timer
->function
;
1140 __remove_hrtimer(timer
, timer
->base
, HRTIMER_STATE_CALLBACK
, 0);
1141 spin_unlock_irq(&cpu_base
->lock
);
1143 restart
= fn(timer
);
1145 spin_lock_irq(&cpu_base
->lock
);
1147 timer
->state
&= ~HRTIMER_STATE_CALLBACK
;
1148 if (restart
== HRTIMER_RESTART
) {
1149 BUG_ON(hrtimer_active(timer
));
1151 * Enqueue the timer, allow reprogramming of the event
1154 enqueue_hrtimer(timer
, timer
->base
, 1);
1155 } else if (hrtimer_active(timer
)) {
1157 * If the timer was rearmed on another CPU, reprogram
1160 if (timer
->base
->first
== &timer
->node
)
1161 hrtimer_reprogram(timer
, timer
->base
);
1164 spin_unlock_irq(&cpu_base
->lock
);
1167 #endif /* CONFIG_HIGH_RES_TIMERS */
1170 * Expire the per base hrtimer-queue:
1172 static inline void run_hrtimer_queue(struct hrtimer_cpu_base
*cpu_base
,
1175 struct rb_node
*node
;
1176 struct hrtimer_clock_base
*base
= &cpu_base
->clock_base
[index
];
1181 if (base
->get_softirq_time
)
1182 base
->softirq_time
= base
->get_softirq_time();
1184 spin_lock_irq(&cpu_base
->lock
);
1186 while ((node
= base
->first
)) {
1187 struct hrtimer
*timer
;
1188 enum hrtimer_restart (*fn
)(struct hrtimer
*);
1191 timer
= rb_entry(node
, struct hrtimer
, node
);
1192 if (base
->softirq_time
.tv64
<= timer
->expires
.tv64
)
1195 #ifdef CONFIG_HIGH_RES_TIMERS
1196 WARN_ON_ONCE(timer
->cb_mode
== HRTIMER_CB_IRQSAFE_NO_SOFTIRQ
);
1198 timer_stats_account_hrtimer(timer
);
1200 fn
= timer
->function
;
1201 __remove_hrtimer(timer
, base
, HRTIMER_STATE_CALLBACK
, 0);
1202 spin_unlock_irq(&cpu_base
->lock
);
1204 restart
= fn(timer
);
1206 spin_lock_irq(&cpu_base
->lock
);
1208 timer
->state
&= ~HRTIMER_STATE_CALLBACK
;
1209 if (restart
!= HRTIMER_NORESTART
) {
1210 BUG_ON(hrtimer_active(timer
));
1211 enqueue_hrtimer(timer
, base
, 0);
1214 spin_unlock_irq(&cpu_base
->lock
);
1218 * Called from timer softirq every jiffy, expire hrtimers:
1220 * For HRT its the fall back code to run the softirq in the timer
1221 * softirq context in case the hrtimer initialization failed or has
1222 * not been done yet.
1224 void hrtimer_run_queues(void)
1226 struct hrtimer_cpu_base
*cpu_base
= &__get_cpu_var(hrtimer_bases
);
1229 if (hrtimer_hres_active())
1233 * This _is_ ugly: We have to check in the softirq context,
1234 * whether we can switch to highres and / or nohz mode. The
1235 * clocksource switch happens in the timer interrupt with
1236 * xtime_lock held. Notification from there only sets the
1237 * check bit in the tick_oneshot code, otherwise we might
1238 * deadlock vs. xtime_lock.
1240 if (tick_check_oneshot_change(!hrtimer_is_hres_enabled()))
1241 if (hrtimer_switch_to_hres())
1244 hrtimer_get_softirq_time(cpu_base
);
1246 for (i
= 0; i
< HRTIMER_MAX_CLOCK_BASES
; i
++)
1247 run_hrtimer_queue(cpu_base
, i
);
1251 * Sleep related functions:
1253 static enum hrtimer_restart
hrtimer_wakeup(struct hrtimer
*timer
)
1255 struct hrtimer_sleeper
*t
=
1256 container_of(timer
, struct hrtimer_sleeper
, timer
);
1257 struct task_struct
*task
= t
->task
;
1261 wake_up_process(task
);
1263 return HRTIMER_NORESTART
;
1266 void hrtimer_init_sleeper(struct hrtimer_sleeper
*sl
, struct task_struct
*task
)
1268 sl
->timer
.function
= hrtimer_wakeup
;
1270 #ifdef CONFIG_HIGH_RES_TIMERS
1271 sl
->timer
.cb_mode
= HRTIMER_CB_IRQSAFE_NO_RESTART
;
1275 static int __sched
do_nanosleep(struct hrtimer_sleeper
*t
, enum hrtimer_mode mode
)
1277 hrtimer_init_sleeper(t
, current
);
1280 set_current_state(TASK_INTERRUPTIBLE
);
1281 hrtimer_start(&t
->timer
, t
->timer
.expires
, mode
);
1283 if (likely(t
->task
))
1286 hrtimer_cancel(&t
->timer
);
1287 mode
= HRTIMER_MODE_ABS
;
1289 } while (t
->task
&& !signal_pending(current
));
1291 return t
->task
== NULL
;
1294 long __sched
hrtimer_nanosleep_restart(struct restart_block
*restart
)
1296 struct hrtimer_sleeper t
;
1297 struct timespec
*rmtp
;
1300 restart
->fn
= do_no_restart_syscall
;
1302 hrtimer_init(&t
.timer
, restart
->arg0
, HRTIMER_MODE_ABS
);
1303 t
.timer
.expires
.tv64
= ((u64
)restart
->arg3
<< 32) | (u64
) restart
->arg2
;
1305 if (do_nanosleep(&t
, HRTIMER_MODE_ABS
))
1308 rmtp
= (struct timespec
*)restart
->arg1
;
1310 time
= ktime_sub(t
.timer
.expires
, t
.timer
.base
->get_time());
1313 *rmtp
= ktime_to_timespec(time
);
1316 restart
->fn
= hrtimer_nanosleep_restart
;
1318 /* The other values in restart are already filled in */
1319 return -ERESTART_RESTARTBLOCK
;
1322 long hrtimer_nanosleep(struct timespec
*rqtp
, struct timespec
*rmtp
,
1323 const enum hrtimer_mode mode
, const clockid_t clockid
)
1325 struct restart_block
*restart
;
1326 struct hrtimer_sleeper t
;
1329 hrtimer_init(&t
.timer
, clockid
, mode
);
1330 t
.timer
.expires
= timespec_to_ktime(*rqtp
);
1331 if (do_nanosleep(&t
, mode
))
1334 /* Absolute timers do not update the rmtp value and restart: */
1335 if (mode
== HRTIMER_MODE_ABS
)
1336 return -ERESTARTNOHAND
;
1339 rem
= ktime_sub(t
.timer
.expires
, t
.timer
.base
->get_time());
1342 *rmtp
= ktime_to_timespec(rem
);
1345 restart
= ¤t_thread_info()->restart_block
;
1346 restart
->fn
= hrtimer_nanosleep_restart
;
1347 restart
->arg0
= (unsigned long) t
.timer
.base
->index
;
1348 restart
->arg1
= (unsigned long) rmtp
;
1349 restart
->arg2
= t
.timer
.expires
.tv64
& 0xFFFFFFFF;
1350 restart
->arg3
= t
.timer
.expires
.tv64
>> 32;
1352 return -ERESTART_RESTARTBLOCK
;
1356 sys_nanosleep(struct timespec __user
*rqtp
, struct timespec __user
*rmtp
)
1358 struct timespec tu
, rmt
;
1361 if (copy_from_user(&tu
, rqtp
, sizeof(tu
)))
1364 if (!timespec_valid(&tu
))
1367 ret
= hrtimer_nanosleep(&tu
, rmtp
? &rmt
: NULL
, HRTIMER_MODE_REL
,
1371 if (copy_to_user(rmtp
, &rmt
, sizeof(*rmtp
)))
1379 * Functions related to boot-time initialization:
1381 static void __devinit
init_hrtimers_cpu(int cpu
)
1383 struct hrtimer_cpu_base
*cpu_base
= &per_cpu(hrtimer_bases
, cpu
);
1386 spin_lock_init(&cpu_base
->lock
);
1387 lockdep_set_class(&cpu_base
->lock
, &cpu_base
->lock_key
);
1389 for (i
= 0; i
< HRTIMER_MAX_CLOCK_BASES
; i
++)
1390 cpu_base
->clock_base
[i
].cpu_base
= cpu_base
;
1392 hrtimer_init_hres(cpu_base
);
1395 #ifdef CONFIG_HOTPLUG_CPU
1397 static void migrate_hrtimer_list(struct hrtimer_clock_base
*old_base
,
1398 struct hrtimer_clock_base
*new_base
)
1400 struct hrtimer
*timer
;
1401 struct rb_node
*node
;
1403 while ((node
= rb_first(&old_base
->active
))) {
1404 timer
= rb_entry(node
, struct hrtimer
, node
);
1405 BUG_ON(hrtimer_callback_running(timer
));
1406 __remove_hrtimer(timer
, old_base
, HRTIMER_STATE_INACTIVE
, 0);
1407 timer
->base
= new_base
;
1409 * Enqueue the timer. Allow reprogramming of the event device
1411 enqueue_hrtimer(timer
, new_base
, 1);
1415 static void migrate_hrtimers(int cpu
)
1417 struct hrtimer_cpu_base
*old_base
, *new_base
;
1420 BUG_ON(cpu_online(cpu
));
1421 old_base
= &per_cpu(hrtimer_bases
, cpu
);
1422 new_base
= &get_cpu_var(hrtimer_bases
);
1424 tick_cancel_sched_timer(cpu
);
1426 local_irq_disable();
1427 double_spin_lock(&new_base
->lock
, &old_base
->lock
,
1428 smp_processor_id() < cpu
);
1430 for (i
= 0; i
< HRTIMER_MAX_CLOCK_BASES
; i
++) {
1431 migrate_hrtimer_list(&old_base
->clock_base
[i
],
1432 &new_base
->clock_base
[i
]);
1435 double_spin_unlock(&new_base
->lock
, &old_base
->lock
,
1436 smp_processor_id() < cpu
);
1438 put_cpu_var(hrtimer_bases
);
1440 #endif /* CONFIG_HOTPLUG_CPU */
1442 static int __cpuinit
hrtimer_cpu_notify(struct notifier_block
*self
,
1443 unsigned long action
, void *hcpu
)
1445 unsigned int cpu
= (long)hcpu
;
1449 case CPU_UP_PREPARE
:
1450 case CPU_UP_PREPARE_FROZEN
:
1451 init_hrtimers_cpu(cpu
);
1454 #ifdef CONFIG_HOTPLUG_CPU
1456 case CPU_DEAD_FROZEN
:
1457 clockevents_notify(CLOCK_EVT_NOTIFY_CPU_DEAD
, &cpu
);
1458 migrate_hrtimers(cpu
);
1469 static struct notifier_block __cpuinitdata hrtimers_nb
= {
1470 .notifier_call
= hrtimer_cpu_notify
,
1473 void __init
hrtimers_init(void)
1475 hrtimer_cpu_notify(&hrtimers_nb
, (unsigned long)CPU_UP_PREPARE
,
1476 (void *)(long)smp_processor_id());
1477 register_cpu_notifier(&hrtimers_nb
);
1478 #ifdef CONFIG_HIGH_RES_TIMERS
1479 open_softirq(HRTIMER_SOFTIRQ
, run_hrtimer_softirq
, NULL
);