apm_power: support using VOLTAGE_* properties for apm calculations
[linux-2.6.git] / kernel / hrtimer.c
blob1069998fe25fdcce1af97f7be831852d85b6d20b
1 /*
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:
15 * - itimers
16 * - POSIX timers
17 * - nanosleep
18 * - precise in-kernel timing
20 * Started by: Thomas Gleixner and Ingo Molnar
22 * Credits:
23 * based on kernel/timer.c
25 * Help, testing, suggestions, bugfixes, improvements were
26 * provided by:
28 * George Anzinger, Andrew Morton, Steven Rostedt, Roman Zippel
29 * et. al.
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>
49 /**
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)
56 struct timespec now;
58 ktime_get_ts(&now);
60 return timespec_to_ktime(now);
62 EXPORT_SYMBOL_GPL(ktime_get);
64 /**
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)
71 struct timespec now;
73 getnstimeofday(&now);
75 return timespec_to_ktime(now);
78 EXPORT_SYMBOL_GPL(ktime_get_real);
81 * The timer bases:
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) =
92 .clock_base =
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;
118 unsigned long seq;
120 do {
121 seq = read_seqbegin(&xtime_lock);
122 getnstimeofday(ts);
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
134 * wall_to_monotonic.
136 static void hrtimer_get_softirq_time(struct hrtimer_cpu_base *base)
138 ktime_t xtim, tomono;
139 struct timespec xts, tom;
140 unsigned long seq;
142 do {
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
157 * function
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
166 * single place
168 #ifdef CONFIG_SMP
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
180 * locked.
182 static
183 struct hrtimer_clock_base *lock_hrtimer_base(const struct hrtimer *timer,
184 unsigned long *flags)
186 struct hrtimer_clock_base *base;
188 for (;;) {
189 base = timer->base;
190 if (likely(base != NULL)) {
191 spin_lock_irqsave(&base->cpu_base->lock, *flags);
192 if (likely(base == timer->base))
193 return base;
194 /* The timer has migrated to another CPU: */
195 spin_unlock_irqrestore(&base->cpu_base->lock, *flags);
197 cpu_relax();
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)))
224 return base;
226 /* See the comment in lock_timer_base() */
227 timer->base = NULL;
228 spin_unlock(&base->cpu_base->lock);
229 spin_lock(&new_base->cpu_base->lock);
230 timer->base = new_base;
232 return 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);
244 return base;
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
259 * @kt: addend
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)
266 ktime_t tmp;
268 if (likely(nsec < NSEC_PER_SEC)) {
269 tmp.tv64 = nsec;
270 } else {
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
283 * @kt: minuend
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)
290 ktime_t tmp;
292 if (likely(nsec < NSEC_PER_SEC)) {
293 tmp.tv64 = nsec;
294 } else {
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)
311 u64 dclc, inc, dns;
312 int sft = 0;
314 dclc = dns = ktime_to_ns(kt);
315 inc = div;
316 /* Make sure the divisor is less than 2^32: */
317 while (div >> 32) {
318 sft++;
319 div >>= 1;
321 dclc >>= sft;
322 do_div(dclc, (unsigned long) div);
324 return (unsigned long) dclc;
326 #endif /* BITS_PER_LONG >= 64 */
329 * Check, whether the timer is on the callback pending list
331 static inline int hrtimer_cb_pending(const struct hrtimer *timer)
333 return timer->state & HRTIMER_STATE_PENDING;
337 * Remove a timer from the callback pending list
339 static inline void hrtimer_remove_cb_pending(struct hrtimer *timer)
341 list_del_init(&timer->cb_entry);
344 /* High resolution timer related functions */
345 #ifdef CONFIG_HIGH_RES_TIMERS
348 * High resolution timer enabled ?
350 static int hrtimer_hres_enabled __read_mostly = 1;
353 * Enable / Disable high resolution mode
355 static int __init setup_hrtimer_hres(char *str)
357 if (!strcmp(str, "off"))
358 hrtimer_hres_enabled = 0;
359 else if (!strcmp(str, "on"))
360 hrtimer_hres_enabled = 1;
361 else
362 return 0;
363 return 1;
366 __setup("highres=", setup_hrtimer_hres);
369 * hrtimer_high_res_enabled - query, if the highres mode is enabled
371 static inline int hrtimer_is_hres_enabled(void)
373 return hrtimer_hres_enabled;
377 * Is the high resolution mode active ?
379 static inline int hrtimer_hres_active(void)
381 return __get_cpu_var(hrtimer_bases).hres_active;
385 * Reprogram the event source with checking both queues for the
386 * next event
387 * Called with interrupts disabled and base->lock held
389 static void hrtimer_force_reprogram(struct hrtimer_cpu_base *cpu_base)
391 int i;
392 struct hrtimer_clock_base *base = cpu_base->clock_base;
393 ktime_t expires;
395 cpu_base->expires_next.tv64 = KTIME_MAX;
397 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
398 struct hrtimer *timer;
400 if (!base->first)
401 continue;
402 timer = rb_entry(base->first, struct hrtimer, node);
403 expires = ktime_sub(timer->expires, base->offset);
404 if (expires.tv64 < cpu_base->expires_next.tv64)
405 cpu_base->expires_next = expires;
408 if (cpu_base->expires_next.tv64 != KTIME_MAX)
409 tick_program_event(cpu_base->expires_next, 1);
413 * Shared reprogramming for clock_realtime and clock_monotonic
415 * When a timer is enqueued and expires earlier than the already enqueued
416 * timers, we have to check, whether it expires earlier than the timer for
417 * which the clock event device was armed.
419 * Called with interrupts disabled and base->cpu_base.lock held
421 static int hrtimer_reprogram(struct hrtimer *timer,
422 struct hrtimer_clock_base *base)
424 ktime_t *expires_next = &__get_cpu_var(hrtimer_bases).expires_next;
425 ktime_t expires = ktime_sub(timer->expires, base->offset);
426 int res;
429 * When the callback is running, we do not reprogram the clock event
430 * device. The timer callback is either running on a different CPU or
431 * the callback is executed in the hrtimer_interrupt context. The
432 * reprogramming is handled either by the softirq, which called the
433 * callback or at the end of the hrtimer_interrupt.
435 if (hrtimer_callback_running(timer))
436 return 0;
438 if (expires.tv64 >= expires_next->tv64)
439 return 0;
442 * Clockevents returns -ETIME, when the event was in the past.
444 res = tick_program_event(expires, 0);
445 if (!IS_ERR_VALUE(res))
446 *expires_next = expires;
447 return res;
452 * Retrigger next event is called after clock was set
454 * Called with interrupts disabled via on_each_cpu()
456 static void retrigger_next_event(void *arg)
458 struct hrtimer_cpu_base *base;
459 struct timespec realtime_offset;
460 unsigned long seq;
462 if (!hrtimer_hres_active())
463 return;
465 do {
466 seq = read_seqbegin(&xtime_lock);
467 set_normalized_timespec(&realtime_offset,
468 -wall_to_monotonic.tv_sec,
469 -wall_to_monotonic.tv_nsec);
470 } while (read_seqretry(&xtime_lock, seq));
472 base = &__get_cpu_var(hrtimer_bases);
474 /* Adjust CLOCK_REALTIME offset */
475 spin_lock(&base->lock);
476 base->clock_base[CLOCK_REALTIME].offset =
477 timespec_to_ktime(realtime_offset);
479 hrtimer_force_reprogram(base);
480 spin_unlock(&base->lock);
484 * Clock realtime was set
486 * Change the offset of the realtime clock vs. the monotonic
487 * clock.
489 * We might have to reprogram the high resolution timer interrupt. On
490 * SMP we call the architecture specific code to retrigger _all_ high
491 * resolution timer interrupts. On UP we just disable interrupts and
492 * call the high resolution interrupt code.
494 void clock_was_set(void)
496 /* Retrigger the CPU local events everywhere */
497 on_each_cpu(retrigger_next_event, NULL, 0, 1);
501 * During resume we might have to reprogram the high resolution timer
502 * interrupt (on the local CPU):
504 void hres_timers_resume(void)
506 WARN_ON_ONCE(num_online_cpus() > 1);
508 /* Retrigger the CPU local events: */
509 retrigger_next_event(NULL);
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;
522 * Initialize the high resolution related parts of a hrtimer
524 static inline void hrtimer_init_timer_hres(struct hrtimer *timer)
529 * When High resolution timers are active, try to reprogram. Note, that in case
530 * the state has HRTIMER_STATE_CALLBACK set, no reprogramming and no expiry
531 * check happens. The timer gets enqueued into the rbtree. The reprogramming
532 * and expiry check is done in the hrtimer_interrupt or in the softirq.
534 static inline int hrtimer_enqueue_reprogram(struct hrtimer *timer,
535 struct hrtimer_clock_base *base)
537 if (base->cpu_base->hres_active && hrtimer_reprogram(timer, base)) {
539 /* Timer is expired, act upon the callback mode */
540 switch(timer->cb_mode) {
541 case HRTIMER_CB_IRQSAFE_NO_RESTART:
543 * We can call the callback from here. No restart
544 * happens, so no danger of recursion
546 BUG_ON(timer->function(timer) != HRTIMER_NORESTART);
547 return 1;
548 case HRTIMER_CB_IRQSAFE_NO_SOFTIRQ:
550 * This is solely for the sched tick emulation with
551 * dynamic tick support to ensure that we do not
552 * restart the tick right on the edge and end up with
553 * the tick timer in the softirq ! The calling site
554 * takes care of this.
556 return 1;
557 case HRTIMER_CB_IRQSAFE:
558 case HRTIMER_CB_SOFTIRQ:
560 * Move everything else into the softirq pending list !
562 list_add_tail(&timer->cb_entry,
563 &base->cpu_base->cb_pending);
564 timer->state = HRTIMER_STATE_PENDING;
565 raise_softirq(HRTIMER_SOFTIRQ);
566 return 1;
567 default:
568 BUG();
571 return 0;
575 * Switch to high resolution mode
577 static int hrtimer_switch_to_hres(void)
579 int cpu = smp_processor_id();
580 struct hrtimer_cpu_base *base = &per_cpu(hrtimer_bases, cpu);
581 unsigned long flags;
583 if (base->hres_active)
584 return 1;
586 local_irq_save(flags);
588 if (tick_init_highres()) {
589 local_irq_restore(flags);
590 printk(KERN_WARNING "Could not switch to high resolution "
591 "mode on CPU %d\n", cpu);
592 return 0;
594 base->hres_active = 1;
595 base->clock_base[CLOCK_REALTIME].resolution = KTIME_HIGH_RES;
596 base->clock_base[CLOCK_MONOTONIC].resolution = KTIME_HIGH_RES;
598 tick_setup_sched_timer();
600 /* "Retrigger" the interrupt to get things going */
601 retrigger_next_event(NULL);
602 local_irq_restore(flags);
603 printk(KERN_DEBUG "Switched to high resolution mode on CPU %d\n",
604 smp_processor_id());
605 return 1;
608 #else
610 static inline int hrtimer_hres_active(void) { return 0; }
611 static inline int hrtimer_is_hres_enabled(void) { return 0; }
612 static inline int hrtimer_switch_to_hres(void) { return 0; }
613 static inline void hrtimer_force_reprogram(struct hrtimer_cpu_base *base) { }
614 static inline int hrtimer_enqueue_reprogram(struct hrtimer *timer,
615 struct hrtimer_clock_base *base)
617 return 0;
619 static inline void hrtimer_init_hres(struct hrtimer_cpu_base *base) { }
620 static inline void hrtimer_init_timer_hres(struct hrtimer *timer) { }
621 static inline int hrtimer_reprogram(struct hrtimer *timer,
622 struct hrtimer_clock_base *base)
624 return 0;
627 #endif /* CONFIG_HIGH_RES_TIMERS */
629 #ifdef CONFIG_TIMER_STATS
630 void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer, void *addr)
632 if (timer->start_site)
633 return;
635 timer->start_site = addr;
636 memcpy(timer->start_comm, current->comm, TASK_COMM_LEN);
637 timer->start_pid = current->pid;
639 #endif
642 * Counterpart to lock_hrtimer_base above:
644 static inline
645 void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
647 spin_unlock_irqrestore(&timer->base->cpu_base->lock, *flags);
651 * hrtimer_forward - forward the timer expiry
652 * @timer: hrtimer to forward
653 * @now: forward past this time
654 * @interval: the interval to forward
656 * Forward the timer expiry so it will expire in the future.
657 * Returns the number of overruns.
659 unsigned long
660 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
662 unsigned long orun = 1;
663 ktime_t delta;
665 delta = ktime_sub(now, timer->expires);
667 if (delta.tv64 < 0)
668 return 0;
670 if (interval.tv64 < timer->base->resolution.tv64)
671 interval.tv64 = timer->base->resolution.tv64;
673 if (unlikely(delta.tv64 >= interval.tv64)) {
674 s64 incr = ktime_to_ns(interval);
676 orun = ktime_divns(delta, incr);
677 timer->expires = ktime_add_ns(timer->expires, incr * orun);
678 if (timer->expires.tv64 > now.tv64)
679 return orun;
681 * This (and the ktime_add() below) is the
682 * correction for exact:
684 orun++;
686 timer->expires = ktime_add(timer->expires, interval);
688 * Make sure, that the result did not wrap with a very large
689 * interval.
691 if (timer->expires.tv64 < 0)
692 timer->expires = ktime_set(KTIME_SEC_MAX, 0);
694 return orun;
696 EXPORT_SYMBOL_GPL(hrtimer_forward);
699 * enqueue_hrtimer - internal function to (re)start a timer
701 * The timer is inserted in expiry order. Insertion into the
702 * red black tree is O(log(n)). Must hold the base lock.
704 static void enqueue_hrtimer(struct hrtimer *timer,
705 struct hrtimer_clock_base *base, int reprogram)
707 struct rb_node **link = &base->active.rb_node;
708 struct rb_node *parent = NULL;
709 struct hrtimer *entry;
710 int leftmost = 1;
713 * Find the right place in the rbtree:
715 while (*link) {
716 parent = *link;
717 entry = rb_entry(parent, struct hrtimer, node);
719 * We dont care about collisions. Nodes with
720 * the same expiry time stay together.
722 if (timer->expires.tv64 < entry->expires.tv64) {
723 link = &(*link)->rb_left;
724 } else {
725 link = &(*link)->rb_right;
726 leftmost = 0;
731 * Insert the timer to the rbtree and check whether it
732 * replaces the first pending timer
734 if (leftmost) {
736 * Reprogram the clock event device. When the timer is already
737 * expired hrtimer_enqueue_reprogram has either called the
738 * callback or added it to the pending list and raised the
739 * softirq.
741 * This is a NOP for !HIGHRES
743 if (reprogram && hrtimer_enqueue_reprogram(timer, base))
744 return;
746 base->first = &timer->node;
749 rb_link_node(&timer->node, parent, link);
750 rb_insert_color(&timer->node, &base->active);
752 * HRTIMER_STATE_ENQUEUED is or'ed to the current state to preserve the
753 * state of a possibly running callback.
755 timer->state |= HRTIMER_STATE_ENQUEUED;
759 * __remove_hrtimer - internal function to remove a timer
761 * Caller must hold the base lock.
763 * High resolution timer mode reprograms the clock event device when the
764 * timer is the one which expires next. The caller can disable this by setting
765 * reprogram to zero. This is useful, when the context does a reprogramming
766 * anyway (e.g. timer interrupt)
768 static void __remove_hrtimer(struct hrtimer *timer,
769 struct hrtimer_clock_base *base,
770 unsigned long newstate, int reprogram)
772 /* High res. callback list. NOP for !HIGHRES */
773 if (hrtimer_cb_pending(timer))
774 hrtimer_remove_cb_pending(timer);
775 else {
777 * Remove the timer from the rbtree and replace the
778 * first entry pointer if necessary.
780 if (base->first == &timer->node) {
781 base->first = rb_next(&timer->node);
782 /* Reprogram the clock event device. if enabled */
783 if (reprogram && hrtimer_hres_active())
784 hrtimer_force_reprogram(base->cpu_base);
786 rb_erase(&timer->node, &base->active);
788 timer->state = newstate;
792 * remove hrtimer, called with base lock held
794 static inline int
795 remove_hrtimer(struct hrtimer *timer, struct hrtimer_clock_base *base)
797 if (hrtimer_is_queued(timer)) {
798 int reprogram;
801 * Remove the timer and force reprogramming when high
802 * resolution mode is active and the timer is on the current
803 * CPU. If we remove a timer on another CPU, reprogramming is
804 * skipped. The interrupt event on this CPU is fired and
805 * reprogramming happens in the interrupt handler. This is a
806 * rare case and less expensive than a smp call.
808 timer_stats_hrtimer_clear_start_info(timer);
809 reprogram = base->cpu_base == &__get_cpu_var(hrtimer_bases);
810 __remove_hrtimer(timer, base, HRTIMER_STATE_INACTIVE,
811 reprogram);
812 return 1;
814 return 0;
818 * hrtimer_start - (re)start an relative timer on the current CPU
819 * @timer: the timer to be added
820 * @tim: expiry time
821 * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
823 * Returns:
824 * 0 on success
825 * 1 when the timer was active
828 hrtimer_start(struct hrtimer *timer, ktime_t tim, const enum hrtimer_mode mode)
830 struct hrtimer_clock_base *base, *new_base;
831 unsigned long flags;
832 int ret;
834 base = lock_hrtimer_base(timer, &flags);
836 /* Remove an active timer from the queue: */
837 ret = remove_hrtimer(timer, base);
839 /* Switch the timer base, if necessary: */
840 new_base = switch_hrtimer_base(timer, base);
842 if (mode == HRTIMER_MODE_REL) {
843 tim = ktime_add(tim, new_base->get_time());
845 * CONFIG_TIME_LOW_RES is a temporary way for architectures
846 * to signal that they simply return xtime in
847 * do_gettimeoffset(). In this case we want to round up by
848 * resolution when starting a relative timer, to avoid short
849 * timeouts. This will go away with the GTOD framework.
851 #ifdef CONFIG_TIME_LOW_RES
852 tim = ktime_add(tim, base->resolution);
853 #endif
855 * Careful here: User space might have asked for a
856 * very long sleep, so the add above might result in a
857 * negative number, which enqueues the timer in front
858 * of the queue.
860 if (tim.tv64 < 0)
861 tim.tv64 = KTIME_MAX;
863 timer->expires = tim;
865 timer_stats_hrtimer_set_start_info(timer);
868 * Only allow reprogramming if the new base is on this CPU.
869 * (it might still be on another CPU if the timer was pending)
871 enqueue_hrtimer(timer, new_base,
872 new_base->cpu_base == &__get_cpu_var(hrtimer_bases));
874 unlock_hrtimer_base(timer, &flags);
876 return ret;
878 EXPORT_SYMBOL_GPL(hrtimer_start);
881 * hrtimer_try_to_cancel - try to deactivate a timer
882 * @timer: hrtimer to stop
884 * Returns:
885 * 0 when the timer was not active
886 * 1 when the timer was active
887 * -1 when the timer is currently excuting the callback function and
888 * cannot be stopped
890 int hrtimer_try_to_cancel(struct hrtimer *timer)
892 struct hrtimer_clock_base *base;
893 unsigned long flags;
894 int ret = -1;
896 base = lock_hrtimer_base(timer, &flags);
898 if (!hrtimer_callback_running(timer))
899 ret = remove_hrtimer(timer, base);
901 unlock_hrtimer_base(timer, &flags);
903 return ret;
906 EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
909 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
910 * @timer: the timer to be cancelled
912 * Returns:
913 * 0 when the timer was not active
914 * 1 when the timer was active
916 int hrtimer_cancel(struct hrtimer *timer)
918 for (;;) {
919 int ret = hrtimer_try_to_cancel(timer);
921 if (ret >= 0)
922 return ret;
923 cpu_relax();
926 EXPORT_SYMBOL_GPL(hrtimer_cancel);
929 * hrtimer_get_remaining - get remaining time for the timer
930 * @timer: the timer to read
932 ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
934 struct hrtimer_clock_base *base;
935 unsigned long flags;
936 ktime_t rem;
938 base = lock_hrtimer_base(timer, &flags);
939 rem = ktime_sub(timer->expires, base->get_time());
940 unlock_hrtimer_base(timer, &flags);
942 return rem;
944 EXPORT_SYMBOL_GPL(hrtimer_get_remaining);
946 #if defined(CONFIG_NO_IDLE_HZ) || defined(CONFIG_NO_HZ)
948 * hrtimer_get_next_event - get the time until next expiry event
950 * Returns the delta to the next expiry event or KTIME_MAX if no timer
951 * is pending.
953 ktime_t hrtimer_get_next_event(void)
955 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
956 struct hrtimer_clock_base *base = cpu_base->clock_base;
957 ktime_t delta, mindelta = { .tv64 = KTIME_MAX };
958 unsigned long flags;
959 int i;
961 spin_lock_irqsave(&cpu_base->lock, flags);
963 if (!hrtimer_hres_active()) {
964 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
965 struct hrtimer *timer;
967 if (!base->first)
968 continue;
970 timer = rb_entry(base->first, struct hrtimer, node);
971 delta.tv64 = timer->expires.tv64;
972 delta = ktime_sub(delta, base->get_time());
973 if (delta.tv64 < mindelta.tv64)
974 mindelta.tv64 = delta.tv64;
978 spin_unlock_irqrestore(&cpu_base->lock, flags);
980 if (mindelta.tv64 < 0)
981 mindelta.tv64 = 0;
982 return mindelta;
984 #endif
987 * hrtimer_init - initialize a timer to the given clock
988 * @timer: the timer to be initialized
989 * @clock_id: the clock to be used
990 * @mode: timer mode abs/rel
992 void hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
993 enum hrtimer_mode mode)
995 struct hrtimer_cpu_base *cpu_base;
997 memset(timer, 0, sizeof(struct hrtimer));
999 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
1001 if (clock_id == CLOCK_REALTIME && mode != HRTIMER_MODE_ABS)
1002 clock_id = CLOCK_MONOTONIC;
1004 timer->base = &cpu_base->clock_base[clock_id];
1005 INIT_LIST_HEAD(&timer->cb_entry);
1006 hrtimer_init_timer_hres(timer);
1008 #ifdef CONFIG_TIMER_STATS
1009 timer->start_site = NULL;
1010 timer->start_pid = -1;
1011 memset(timer->start_comm, 0, TASK_COMM_LEN);
1012 #endif
1014 EXPORT_SYMBOL_GPL(hrtimer_init);
1017 * hrtimer_get_res - get the timer resolution for a clock
1018 * @which_clock: which clock to query
1019 * @tp: pointer to timespec variable to store the resolution
1021 * Store the resolution of the clock selected by @which_clock in the
1022 * variable pointed to by @tp.
1024 int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp)
1026 struct hrtimer_cpu_base *cpu_base;
1028 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
1029 *tp = ktime_to_timespec(cpu_base->clock_base[which_clock].resolution);
1031 return 0;
1033 EXPORT_SYMBOL_GPL(hrtimer_get_res);
1035 static void run_hrtimer_pending(struct hrtimer_cpu_base *cpu_base)
1037 spin_lock_irq(&cpu_base->lock);
1039 while (!list_empty(&cpu_base->cb_pending)) {
1040 enum hrtimer_restart (*fn)(struct hrtimer *);
1041 struct hrtimer *timer;
1042 int restart;
1044 timer = list_entry(cpu_base->cb_pending.next,
1045 struct hrtimer, cb_entry);
1047 timer_stats_account_hrtimer(timer);
1049 fn = timer->function;
1050 __remove_hrtimer(timer, timer->base, HRTIMER_STATE_CALLBACK, 0);
1051 spin_unlock_irq(&cpu_base->lock);
1053 restart = fn(timer);
1055 spin_lock_irq(&cpu_base->lock);
1057 timer->state &= ~HRTIMER_STATE_CALLBACK;
1058 if (restart == HRTIMER_RESTART) {
1059 BUG_ON(hrtimer_active(timer));
1061 * Enqueue the timer, allow reprogramming of the event
1062 * device
1064 enqueue_hrtimer(timer, timer->base, 1);
1065 } else if (hrtimer_active(timer)) {
1067 * If the timer was rearmed on another CPU, reprogram
1068 * the event device.
1070 if (timer->base->first == &timer->node)
1071 hrtimer_reprogram(timer, timer->base);
1074 spin_unlock_irq(&cpu_base->lock);
1077 static void __run_hrtimer(struct hrtimer *timer)
1079 struct hrtimer_clock_base *base = timer->base;
1080 struct hrtimer_cpu_base *cpu_base = base->cpu_base;
1081 enum hrtimer_restart (*fn)(struct hrtimer *);
1082 int restart;
1084 __remove_hrtimer(timer, base, HRTIMER_STATE_CALLBACK, 0);
1085 timer_stats_account_hrtimer(timer);
1087 fn = timer->function;
1088 if (timer->cb_mode == HRTIMER_CB_IRQSAFE_NO_SOFTIRQ) {
1090 * Used for scheduler timers, avoid lock inversion with
1091 * rq->lock and tasklist_lock.
1093 * These timers are required to deal with enqueue expiry
1094 * themselves and are not allowed to migrate.
1096 spin_unlock(&cpu_base->lock);
1097 restart = fn(timer);
1098 spin_lock(&cpu_base->lock);
1099 } else
1100 restart = fn(timer);
1103 * Note: We clear the CALLBACK bit after enqueue_hrtimer to avoid
1104 * reprogramming of the event hardware. This happens at the end of this
1105 * function anyway.
1107 if (restart != HRTIMER_NORESTART) {
1108 BUG_ON(timer->state != HRTIMER_STATE_CALLBACK);
1109 enqueue_hrtimer(timer, base, 0);
1111 timer->state &= ~HRTIMER_STATE_CALLBACK;
1114 #ifdef CONFIG_HIGH_RES_TIMERS
1117 * High resolution timer interrupt
1118 * Called with interrupts disabled
1120 void hrtimer_interrupt(struct clock_event_device *dev)
1122 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1123 struct hrtimer_clock_base *base;
1124 ktime_t expires_next, now;
1125 int i, raise = 0;
1127 BUG_ON(!cpu_base->hres_active);
1128 cpu_base->nr_events++;
1129 dev->next_event.tv64 = KTIME_MAX;
1131 retry:
1132 now = ktime_get();
1134 expires_next.tv64 = KTIME_MAX;
1136 base = cpu_base->clock_base;
1138 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
1139 ktime_t basenow;
1140 struct rb_node *node;
1142 spin_lock(&cpu_base->lock);
1144 basenow = ktime_add(now, base->offset);
1146 while ((node = base->first)) {
1147 struct hrtimer *timer;
1149 timer = rb_entry(node, struct hrtimer, node);
1151 if (basenow.tv64 < timer->expires.tv64) {
1152 ktime_t expires;
1154 expires = ktime_sub(timer->expires,
1155 base->offset);
1156 if (expires.tv64 < expires_next.tv64)
1157 expires_next = expires;
1158 break;
1161 /* Move softirq callbacks to the pending list */
1162 if (timer->cb_mode == HRTIMER_CB_SOFTIRQ) {
1163 __remove_hrtimer(timer, base,
1164 HRTIMER_STATE_PENDING, 0);
1165 list_add_tail(&timer->cb_entry,
1166 &base->cpu_base->cb_pending);
1167 raise = 1;
1168 continue;
1171 __run_hrtimer(timer);
1173 spin_unlock(&cpu_base->lock);
1174 base++;
1177 cpu_base->expires_next = expires_next;
1179 /* Reprogramming necessary ? */
1180 if (expires_next.tv64 != KTIME_MAX) {
1181 if (tick_program_event(expires_next, 0))
1182 goto retry;
1185 /* Raise softirq ? */
1186 if (raise)
1187 raise_softirq(HRTIMER_SOFTIRQ);
1190 static void run_hrtimer_softirq(struct softirq_action *h)
1192 run_hrtimer_pending(&__get_cpu_var(hrtimer_bases));
1195 #endif /* CONFIG_HIGH_RES_TIMERS */
1198 * Called from timer softirq every jiffy, expire hrtimers:
1200 * For HRT its the fall back code to run the softirq in the timer
1201 * softirq context in case the hrtimer initialization failed or has
1202 * not been done yet.
1204 void hrtimer_run_pending(void)
1206 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1208 if (hrtimer_hres_active())
1209 return;
1212 * This _is_ ugly: We have to check in the softirq context,
1213 * whether we can switch to highres and / or nohz mode. The
1214 * clocksource switch happens in the timer interrupt with
1215 * xtime_lock held. Notification from there only sets the
1216 * check bit in the tick_oneshot code, otherwise we might
1217 * deadlock vs. xtime_lock.
1219 if (tick_check_oneshot_change(!hrtimer_is_hres_enabled()))
1220 hrtimer_switch_to_hres();
1222 run_hrtimer_pending(cpu_base);
1226 * Called from hardirq context every jiffy
1228 static inline void run_hrtimer_queue(struct hrtimer_cpu_base *cpu_base,
1229 int index)
1231 struct rb_node *node;
1232 struct hrtimer_clock_base *base = &cpu_base->clock_base[index];
1234 if (!base->first)
1235 return;
1237 if (base->get_softirq_time)
1238 base->softirq_time = base->get_softirq_time();
1240 spin_lock(&cpu_base->lock);
1242 while ((node = base->first)) {
1243 struct hrtimer *timer;
1245 timer = rb_entry(node, struct hrtimer, node);
1246 if (base->softirq_time.tv64 <= timer->expires.tv64)
1247 break;
1249 if (timer->cb_mode == HRTIMER_CB_SOFTIRQ) {
1250 __remove_hrtimer(timer, base, HRTIMER_STATE_PENDING, 0);
1251 list_add_tail(&timer->cb_entry,
1252 &base->cpu_base->cb_pending);
1253 continue;
1256 __run_hrtimer(timer);
1258 spin_unlock(&cpu_base->lock);
1261 void hrtimer_run_queues(void)
1263 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1264 int i;
1266 if (hrtimer_hres_active())
1267 return;
1269 hrtimer_get_softirq_time(cpu_base);
1271 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
1272 run_hrtimer_queue(cpu_base, i);
1276 * Sleep related functions:
1278 static enum hrtimer_restart hrtimer_wakeup(struct hrtimer *timer)
1280 struct hrtimer_sleeper *t =
1281 container_of(timer, struct hrtimer_sleeper, timer);
1282 struct task_struct *task = t->task;
1284 t->task = NULL;
1285 if (task)
1286 wake_up_process(task);
1288 return HRTIMER_NORESTART;
1291 void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, struct task_struct *task)
1293 sl->timer.function = hrtimer_wakeup;
1294 sl->task = task;
1295 #ifdef CONFIG_HIGH_RES_TIMERS
1296 sl->timer.cb_mode = HRTIMER_CB_IRQSAFE_NO_SOFTIRQ;
1297 #endif
1300 static int __sched do_nanosleep(struct hrtimer_sleeper *t, enum hrtimer_mode mode)
1302 hrtimer_init_sleeper(t, current);
1304 do {
1305 set_current_state(TASK_INTERRUPTIBLE);
1306 hrtimer_start(&t->timer, t->timer.expires, mode);
1307 if (!hrtimer_active(&t->timer))
1308 t->task = NULL;
1310 if (likely(t->task))
1311 schedule();
1313 hrtimer_cancel(&t->timer);
1314 mode = HRTIMER_MODE_ABS;
1316 } while (t->task && !signal_pending(current));
1318 __set_current_state(TASK_RUNNING);
1320 return t->task == NULL;
1323 long __sched hrtimer_nanosleep_restart(struct restart_block *restart)
1325 struct hrtimer_sleeper t;
1326 struct timespec *rmtp;
1327 ktime_t time;
1329 restart->fn = do_no_restart_syscall;
1331 hrtimer_init(&t.timer, restart->arg0, HRTIMER_MODE_ABS);
1332 t.timer.expires.tv64 = ((u64)restart->arg3 << 32) | (u64) restart->arg2;
1334 if (do_nanosleep(&t, HRTIMER_MODE_ABS))
1335 return 0;
1337 rmtp = (struct timespec *)restart->arg1;
1338 if (rmtp) {
1339 time = ktime_sub(t.timer.expires, t.timer.base->get_time());
1340 if (time.tv64 <= 0)
1341 return 0;
1342 *rmtp = ktime_to_timespec(time);
1345 restart->fn = hrtimer_nanosleep_restart;
1347 /* The other values in restart are already filled in */
1348 return -ERESTART_RESTARTBLOCK;
1351 long hrtimer_nanosleep(struct timespec *rqtp, struct timespec *rmtp,
1352 const enum hrtimer_mode mode, const clockid_t clockid)
1354 struct restart_block *restart;
1355 struct hrtimer_sleeper t;
1356 ktime_t rem;
1358 hrtimer_init(&t.timer, clockid, mode);
1359 t.timer.expires = timespec_to_ktime(*rqtp);
1360 if (do_nanosleep(&t, mode))
1361 return 0;
1363 /* Absolute timers do not update the rmtp value and restart: */
1364 if (mode == HRTIMER_MODE_ABS)
1365 return -ERESTARTNOHAND;
1367 if (rmtp) {
1368 rem = ktime_sub(t.timer.expires, t.timer.base->get_time());
1369 if (rem.tv64 <= 0)
1370 return 0;
1371 *rmtp = ktime_to_timespec(rem);
1374 restart = &current_thread_info()->restart_block;
1375 restart->fn = hrtimer_nanosleep_restart;
1376 restart->arg0 = (unsigned long) t.timer.base->index;
1377 restart->arg1 = (unsigned long) rmtp;
1378 restart->arg2 = t.timer.expires.tv64 & 0xFFFFFFFF;
1379 restart->arg3 = t.timer.expires.tv64 >> 32;
1381 return -ERESTART_RESTARTBLOCK;
1384 asmlinkage long
1385 sys_nanosleep(struct timespec __user *rqtp, struct timespec __user *rmtp)
1387 struct timespec tu, rmt;
1388 int ret;
1390 if (copy_from_user(&tu, rqtp, sizeof(tu)))
1391 return -EFAULT;
1393 if (!timespec_valid(&tu))
1394 return -EINVAL;
1396 ret = hrtimer_nanosleep(&tu, rmtp ? &rmt : NULL, HRTIMER_MODE_REL,
1397 CLOCK_MONOTONIC);
1399 if (ret && rmtp) {
1400 if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
1401 return -EFAULT;
1404 return ret;
1408 * Functions related to boot-time initialization:
1410 static void __cpuinit init_hrtimers_cpu(int cpu)
1412 struct hrtimer_cpu_base *cpu_base = &per_cpu(hrtimer_bases, cpu);
1413 int i;
1415 spin_lock_init(&cpu_base->lock);
1416 lockdep_set_class(&cpu_base->lock, &cpu_base->lock_key);
1418 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
1419 cpu_base->clock_base[i].cpu_base = cpu_base;
1421 INIT_LIST_HEAD(&cpu_base->cb_pending);
1422 hrtimer_init_hres(cpu_base);
1425 #ifdef CONFIG_HOTPLUG_CPU
1427 static void migrate_hrtimer_list(struct hrtimer_clock_base *old_base,
1428 struct hrtimer_clock_base *new_base)
1430 struct hrtimer *timer;
1431 struct rb_node *node;
1433 while ((node = rb_first(&old_base->active))) {
1434 timer = rb_entry(node, struct hrtimer, node);
1435 BUG_ON(hrtimer_callback_running(timer));
1436 __remove_hrtimer(timer, old_base, HRTIMER_STATE_INACTIVE, 0);
1437 timer->base = new_base;
1439 * Enqueue the timer. Allow reprogramming of the event device
1441 enqueue_hrtimer(timer, new_base, 1);
1445 static void migrate_hrtimers(int cpu)
1447 struct hrtimer_cpu_base *old_base, *new_base;
1448 int i;
1450 BUG_ON(cpu_online(cpu));
1451 old_base = &per_cpu(hrtimer_bases, cpu);
1452 new_base = &get_cpu_var(hrtimer_bases);
1454 tick_cancel_sched_timer(cpu);
1456 local_irq_disable();
1457 double_spin_lock(&new_base->lock, &old_base->lock,
1458 smp_processor_id() < cpu);
1460 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
1461 migrate_hrtimer_list(&old_base->clock_base[i],
1462 &new_base->clock_base[i]);
1465 double_spin_unlock(&new_base->lock, &old_base->lock,
1466 smp_processor_id() < cpu);
1467 local_irq_enable();
1468 put_cpu_var(hrtimer_bases);
1470 #endif /* CONFIG_HOTPLUG_CPU */
1472 static int __cpuinit hrtimer_cpu_notify(struct notifier_block *self,
1473 unsigned long action, void *hcpu)
1475 unsigned int cpu = (long)hcpu;
1477 switch (action) {
1479 case CPU_UP_PREPARE:
1480 case CPU_UP_PREPARE_FROZEN:
1481 init_hrtimers_cpu(cpu);
1482 break;
1484 #ifdef CONFIG_HOTPLUG_CPU
1485 case CPU_DEAD:
1486 case CPU_DEAD_FROZEN:
1487 clockevents_notify(CLOCK_EVT_NOTIFY_CPU_DEAD, &cpu);
1488 migrate_hrtimers(cpu);
1489 break;
1490 #endif
1492 default:
1493 break;
1496 return NOTIFY_OK;
1499 static struct notifier_block __cpuinitdata hrtimers_nb = {
1500 .notifier_call = hrtimer_cpu_notify,
1503 void __init hrtimers_init(void)
1505 hrtimer_cpu_notify(&hrtimers_nb, (unsigned long)CPU_UP_PREPARE,
1506 (void *)(long)smp_processor_id());
1507 register_cpu_notifier(&hrtimers_nb);
1508 #ifdef CONFIG_HIGH_RES_TIMERS
1509 open_softirq(HRTIMER_SOFTIRQ, run_hrtimer_softirq, NULL);
1510 #endif