inotify: fix race
[linux-2.6.22.y-op.git] / kernel / hrtimer.c
blob355e867f4a3e82066dfdbe79ae4a94d75a311052
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 #ifdef CONFIG_NO_HZ
145 getnstimeofday(&xts);
146 #else
147 xts = xtime;
148 #endif
149 tom = wall_to_monotonic;
150 } while (read_seqretry(&xtime_lock, seq));
152 xtim = timespec_to_ktime(xts);
153 tomono = timespec_to_ktime(tom);
154 base->clock_base[CLOCK_REALTIME].softirq_time = xtim;
155 base->clock_base[CLOCK_MONOTONIC].softirq_time =
156 ktime_add(xtim, tomono);
160 * Helper function to check, whether the timer is running the callback
161 * function
163 static inline int hrtimer_callback_running(struct hrtimer *timer)
165 return timer->state & HRTIMER_STATE_CALLBACK;
169 * Functions and macros which are different for UP/SMP systems are kept in a
170 * single place
172 #ifdef CONFIG_SMP
175 * We are using hashed locking: holding per_cpu(hrtimer_bases)[n].lock
176 * means that all timers which are tied to this base via timer->base are
177 * locked, and the base itself is locked too.
179 * So __run_timers/migrate_timers can safely modify all timers which could
180 * be found on the lists/queues.
182 * When the timer's base is locked, and the timer removed from list, it is
183 * possible to set timer->base = NULL and drop the lock: the timer remains
184 * locked.
186 static
187 struct hrtimer_clock_base *lock_hrtimer_base(const struct hrtimer *timer,
188 unsigned long *flags)
190 struct hrtimer_clock_base *base;
192 for (;;) {
193 base = timer->base;
194 if (likely(base != NULL)) {
195 spin_lock_irqsave(&base->cpu_base->lock, *flags);
196 if (likely(base == timer->base))
197 return base;
198 /* The timer has migrated to another CPU: */
199 spin_unlock_irqrestore(&base->cpu_base->lock, *flags);
201 cpu_relax();
206 * Switch the timer base to the current CPU when possible.
208 static inline struct hrtimer_clock_base *
209 switch_hrtimer_base(struct hrtimer *timer, struct hrtimer_clock_base *base)
211 struct hrtimer_clock_base *new_base;
212 struct hrtimer_cpu_base *new_cpu_base;
214 new_cpu_base = &__get_cpu_var(hrtimer_bases);
215 new_base = &new_cpu_base->clock_base[base->index];
217 if (base != new_base) {
219 * We are trying to schedule the timer on the local CPU.
220 * However we can't change timer's base while it is running,
221 * so we keep it on the same CPU. No hassle vs. reprogramming
222 * the event source in the high resolution case. The softirq
223 * code will take care of this when the timer function has
224 * completed. There is no conflict as we hold the lock until
225 * the timer is enqueued.
227 if (unlikely(hrtimer_callback_running(timer)))
228 return base;
230 /* See the comment in lock_timer_base() */
231 timer->base = NULL;
232 spin_unlock(&base->cpu_base->lock);
233 spin_lock(&new_base->cpu_base->lock);
234 timer->base = new_base;
236 return new_base;
239 #else /* CONFIG_SMP */
241 static inline struct hrtimer_clock_base *
242 lock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
244 struct hrtimer_clock_base *base = timer->base;
246 spin_lock_irqsave(&base->cpu_base->lock, *flags);
248 return base;
251 # define switch_hrtimer_base(t, b) (b)
253 #endif /* !CONFIG_SMP */
256 * Functions for the union type storage format of ktime_t which are
257 * too large for inlining:
259 #if BITS_PER_LONG < 64
260 # ifndef CONFIG_KTIME_SCALAR
262 * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
263 * @kt: addend
264 * @nsec: the scalar nsec value to add
266 * Returns the sum of kt and nsec in ktime_t format
268 ktime_t ktime_add_ns(const ktime_t kt, u64 nsec)
270 ktime_t tmp;
272 if (likely(nsec < NSEC_PER_SEC)) {
273 tmp.tv64 = nsec;
274 } else {
275 unsigned long rem = do_div(nsec, NSEC_PER_SEC);
277 tmp = ktime_set((long)nsec, rem);
280 return ktime_add(kt, tmp);
283 EXPORT_SYMBOL_GPL(ktime_add_ns);
284 # endif /* !CONFIG_KTIME_SCALAR */
287 * Divide a ktime value by a nanosecond value
289 unsigned long ktime_divns(const ktime_t kt, s64 div)
291 u64 dclc, inc, dns;
292 int sft = 0;
294 dclc = dns = ktime_to_ns(kt);
295 inc = div;
296 /* Make sure the divisor is less than 2^32: */
297 while (div >> 32) {
298 sft++;
299 div >>= 1;
301 dclc >>= sft;
302 do_div(dclc, (unsigned long) div);
304 return (unsigned long) dclc;
306 #endif /* BITS_PER_LONG >= 64 */
308 /* High resolution timer related functions */
309 #ifdef CONFIG_HIGH_RES_TIMERS
312 * High resolution timer enabled ?
314 static int hrtimer_hres_enabled __read_mostly = 1;
317 * Enable / Disable high resolution mode
319 static int __init setup_hrtimer_hres(char *str)
321 if (!strcmp(str, "off"))
322 hrtimer_hres_enabled = 0;
323 else if (!strcmp(str, "on"))
324 hrtimer_hres_enabled = 1;
325 else
326 return 0;
327 return 1;
330 __setup("highres=", setup_hrtimer_hres);
333 * hrtimer_high_res_enabled - query, if the highres mode is enabled
335 static inline int hrtimer_is_hres_enabled(void)
337 return hrtimer_hres_enabled;
341 * Is the high resolution mode active ?
343 static inline int hrtimer_hres_active(void)
345 return __get_cpu_var(hrtimer_bases).hres_active;
349 * Reprogram the event source with checking both queues for the
350 * next event
351 * Called with interrupts disabled and base->lock held
353 static void hrtimer_force_reprogram(struct hrtimer_cpu_base *cpu_base)
355 int i;
356 struct hrtimer_clock_base *base = cpu_base->clock_base;
357 ktime_t expires;
359 cpu_base->expires_next.tv64 = KTIME_MAX;
361 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
362 struct hrtimer *timer;
364 if (!base->first)
365 continue;
366 timer = rb_entry(base->first, struct hrtimer, node);
367 expires = ktime_sub(timer->expires, base->offset);
368 if (expires.tv64 < cpu_base->expires_next.tv64)
369 cpu_base->expires_next = expires;
372 if (cpu_base->expires_next.tv64 != KTIME_MAX)
373 tick_program_event(cpu_base->expires_next, 1);
377 * Shared reprogramming for clock_realtime and clock_monotonic
379 * When a timer is enqueued and expires earlier than the already enqueued
380 * timers, we have to check, whether it expires earlier than the timer for
381 * which the clock event device was armed.
383 * Called with interrupts disabled and base->cpu_base.lock held
385 static int hrtimer_reprogram(struct hrtimer *timer,
386 struct hrtimer_clock_base *base)
388 ktime_t *expires_next = &__get_cpu_var(hrtimer_bases).expires_next;
389 ktime_t expires = ktime_sub(timer->expires, base->offset);
390 int res;
393 * When the callback is running, we do not reprogram the clock event
394 * device. The timer callback is either running on a different CPU or
395 * the callback is executed in the hrtimer_interupt context. The
396 * reprogramming is handled either by the softirq, which called the
397 * callback or at the end of the hrtimer_interrupt.
399 if (hrtimer_callback_running(timer))
400 return 0;
402 if (expires.tv64 >= expires_next->tv64)
403 return 0;
406 * Clockevents returns -ETIME, when the event was in the past.
408 res = tick_program_event(expires, 0);
409 if (!IS_ERR_VALUE(res))
410 *expires_next = expires;
411 return res;
416 * Retrigger next event is called after clock was set
418 * Called with interrupts disabled via on_each_cpu()
420 static void retrigger_next_event(void *arg)
422 struct hrtimer_cpu_base *base;
423 struct timespec realtime_offset;
424 unsigned long seq;
426 if (!hrtimer_hres_active())
427 return;
429 do {
430 seq = read_seqbegin(&xtime_lock);
431 set_normalized_timespec(&realtime_offset,
432 -wall_to_monotonic.tv_sec,
433 -wall_to_monotonic.tv_nsec);
434 } while (read_seqretry(&xtime_lock, seq));
436 base = &__get_cpu_var(hrtimer_bases);
438 /* Adjust CLOCK_REALTIME offset */
439 spin_lock(&base->lock);
440 base->clock_base[CLOCK_REALTIME].offset =
441 timespec_to_ktime(realtime_offset);
443 hrtimer_force_reprogram(base);
444 spin_unlock(&base->lock);
448 * Clock realtime was set
450 * Change the offset of the realtime clock vs. the monotonic
451 * clock.
453 * We might have to reprogram the high resolution timer interrupt. On
454 * SMP we call the architecture specific code to retrigger _all_ high
455 * resolution timer interrupts. On UP we just disable interrupts and
456 * call the high resolution interrupt code.
458 void clock_was_set(void)
460 /* Retrigger the CPU local events everywhere */
461 on_each_cpu(retrigger_next_event, NULL, 0, 1);
465 * During resume we might have to reprogram the high resolution timer
466 * interrupt (on the local CPU):
468 void hres_timers_resume(void)
470 WARN_ON_ONCE(num_online_cpus() > 1);
472 /* Retrigger the CPU local events: */
473 retrigger_next_event(NULL);
477 * Check, whether the timer is on the callback pending list
479 static inline int hrtimer_cb_pending(const struct hrtimer *timer)
481 return timer->state & HRTIMER_STATE_PENDING;
485 * Remove a timer from the callback pending list
487 static inline void hrtimer_remove_cb_pending(struct hrtimer *timer)
489 list_del_init(&timer->cb_entry);
493 * Initialize the high resolution related parts of cpu_base
495 static inline void hrtimer_init_hres(struct hrtimer_cpu_base *base)
497 base->expires_next.tv64 = KTIME_MAX;
498 base->hres_active = 0;
499 INIT_LIST_HEAD(&base->cb_pending);
503 * Initialize the high resolution related parts of a hrtimer
505 static inline void hrtimer_init_timer_hres(struct hrtimer *timer)
507 INIT_LIST_HEAD(&timer->cb_entry);
511 * When High resolution timers are active, try to reprogram. Note, that in case
512 * the state has HRTIMER_STATE_CALLBACK set, no reprogramming and no expiry
513 * check happens. The timer gets enqueued into the rbtree. The reprogramming
514 * and expiry check is done in the hrtimer_interrupt or in the softirq.
516 static inline int hrtimer_enqueue_reprogram(struct hrtimer *timer,
517 struct hrtimer_clock_base *base)
519 if (base->cpu_base->hres_active && hrtimer_reprogram(timer, base)) {
521 /* Timer is expired, act upon the callback mode */
522 switch(timer->cb_mode) {
523 case HRTIMER_CB_IRQSAFE_NO_RESTART:
525 * We can call the callback from here. No restart
526 * happens, so no danger of recursion
528 BUG_ON(timer->function(timer) != HRTIMER_NORESTART);
529 return 1;
530 case HRTIMER_CB_IRQSAFE_NO_SOFTIRQ:
532 * This is solely for the sched tick emulation with
533 * dynamic tick support to ensure that we do not
534 * restart the tick right on the edge and end up with
535 * the tick timer in the softirq ! The calling site
536 * takes care of this.
538 return 1;
539 case HRTIMER_CB_IRQSAFE:
540 case HRTIMER_CB_SOFTIRQ:
542 * Move everything else into the softirq pending list !
544 list_add_tail(&timer->cb_entry,
545 &base->cpu_base->cb_pending);
546 timer->state = HRTIMER_STATE_PENDING;
547 raise_softirq(HRTIMER_SOFTIRQ);
548 return 1;
549 default:
550 BUG();
553 return 0;
557 * Switch to high resolution mode
559 static int hrtimer_switch_to_hres(void)
561 struct hrtimer_cpu_base *base = &__get_cpu_var(hrtimer_bases);
562 unsigned long flags;
564 if (base->hres_active)
565 return 1;
567 local_irq_save(flags);
569 if (tick_init_highres()) {
570 local_irq_restore(flags);
571 return 0;
573 base->hres_active = 1;
574 base->clock_base[CLOCK_REALTIME].resolution = KTIME_HIGH_RES;
575 base->clock_base[CLOCK_MONOTONIC].resolution = KTIME_HIGH_RES;
577 tick_setup_sched_timer();
579 /* "Retrigger" the interrupt to get things going */
580 retrigger_next_event(NULL);
581 local_irq_restore(flags);
582 printk(KERN_INFO "Switched to high resolution mode on CPU %d\n",
583 smp_processor_id());
584 return 1;
587 #else
589 static inline int hrtimer_hres_active(void) { return 0; }
590 static inline int hrtimer_is_hres_enabled(void) { return 0; }
591 static inline int hrtimer_switch_to_hres(void) { return 0; }
592 static inline void hrtimer_force_reprogram(struct hrtimer_cpu_base *base) { }
593 static inline int hrtimer_enqueue_reprogram(struct hrtimer *timer,
594 struct hrtimer_clock_base *base)
596 return 0;
598 static inline int hrtimer_cb_pending(struct hrtimer *timer) { return 0; }
599 static inline void hrtimer_remove_cb_pending(struct hrtimer *timer) { }
600 static inline void hrtimer_init_hres(struct hrtimer_cpu_base *base) { }
601 static inline void hrtimer_init_timer_hres(struct hrtimer *timer) { }
603 #endif /* CONFIG_HIGH_RES_TIMERS */
605 #ifdef CONFIG_TIMER_STATS
606 void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer, void *addr)
608 if (timer->start_site)
609 return;
611 timer->start_site = addr;
612 memcpy(timer->start_comm, current->comm, TASK_COMM_LEN);
613 timer->start_pid = current->pid;
615 #endif
618 * Counterpart to lock_timer_base above:
620 static inline
621 void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
623 spin_unlock_irqrestore(&timer->base->cpu_base->lock, *flags);
627 * hrtimer_forward - forward the timer expiry
628 * @timer: hrtimer to forward
629 * @now: forward past this time
630 * @interval: the interval to forward
632 * Forward the timer expiry so it will expire in the future.
633 * Returns the number of overruns.
635 unsigned long
636 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
638 unsigned long orun = 1;
639 ktime_t delta;
641 delta = ktime_sub(now, timer->expires);
643 if (delta.tv64 < 0)
644 return 0;
646 if (interval.tv64 < timer->base->resolution.tv64)
647 interval.tv64 = timer->base->resolution.tv64;
649 if (unlikely(delta.tv64 >= interval.tv64)) {
650 s64 incr = ktime_to_ns(interval);
652 orun = ktime_divns(delta, incr);
653 timer->expires = ktime_add_ns(timer->expires, incr * orun);
654 if (timer->expires.tv64 > now.tv64)
655 return orun;
657 * This (and the ktime_add() below) is the
658 * correction for exact:
660 orun++;
662 timer->expires = ktime_add(timer->expires, interval);
664 * Make sure, that the result did not wrap with a very large
665 * interval.
667 if (timer->expires.tv64 < 0)
668 timer->expires = ktime_set(KTIME_SEC_MAX, 0);
670 return orun;
672 EXPORT_SYMBOL_GPL(hrtimer_forward);
675 * enqueue_hrtimer - internal function to (re)start a timer
677 * The timer is inserted in expiry order. Insertion into the
678 * red black tree is O(log(n)). Must hold the base lock.
680 static void enqueue_hrtimer(struct hrtimer *timer,
681 struct hrtimer_clock_base *base, int reprogram)
683 struct rb_node **link = &base->active.rb_node;
684 struct rb_node *parent = NULL;
685 struct hrtimer *entry;
688 * Find the right place in the rbtree:
690 while (*link) {
691 parent = *link;
692 entry = rb_entry(parent, struct hrtimer, node);
694 * We dont care about collisions. Nodes with
695 * the same expiry time stay together.
697 if (timer->expires.tv64 < entry->expires.tv64)
698 link = &(*link)->rb_left;
699 else
700 link = &(*link)->rb_right;
704 * Insert the timer to the rbtree and check whether it
705 * replaces the first pending timer
707 if (!base->first || timer->expires.tv64 <
708 rb_entry(base->first, struct hrtimer, node)->expires.tv64) {
710 * Reprogram the clock event device. When the timer is already
711 * expired hrtimer_enqueue_reprogram has either called the
712 * callback or added it to the pending list and raised the
713 * softirq.
715 * This is a NOP for !HIGHRES
717 if (reprogram && hrtimer_enqueue_reprogram(timer, base))
718 return;
720 base->first = &timer->node;
723 rb_link_node(&timer->node, parent, link);
724 rb_insert_color(&timer->node, &base->active);
726 * HRTIMER_STATE_ENQUEUED is or'ed to the current state to preserve the
727 * state of a possibly running callback.
729 timer->state |= HRTIMER_STATE_ENQUEUED;
733 * __remove_hrtimer - internal function to remove a timer
735 * Caller must hold the base lock.
737 * High resolution timer mode reprograms the clock event device when the
738 * timer is the one which expires next. The caller can disable this by setting
739 * reprogram to zero. This is useful, when the context does a reprogramming
740 * anyway (e.g. timer interrupt)
742 static void __remove_hrtimer(struct hrtimer *timer,
743 struct hrtimer_clock_base *base,
744 unsigned long newstate, int reprogram)
746 /* High res. callback list. NOP for !HIGHRES */
747 if (hrtimer_cb_pending(timer))
748 hrtimer_remove_cb_pending(timer);
749 else {
751 * Remove the timer from the rbtree and replace the
752 * first entry pointer if necessary.
754 if (base->first == &timer->node) {
755 base->first = rb_next(&timer->node);
756 /* Reprogram the clock event device. if enabled */
757 if (reprogram && hrtimer_hres_active())
758 hrtimer_force_reprogram(base->cpu_base);
760 rb_erase(&timer->node, &base->active);
762 timer->state = newstate;
766 * remove hrtimer, called with base lock held
768 static inline int
769 remove_hrtimer(struct hrtimer *timer, struct hrtimer_clock_base *base)
771 if (hrtimer_is_queued(timer)) {
772 int reprogram;
775 * Remove the timer and force reprogramming when high
776 * resolution mode is active and the timer is on the current
777 * CPU. If we remove a timer on another CPU, reprogramming is
778 * skipped. The interrupt event on this CPU is fired and
779 * reprogramming happens in the interrupt handler. This is a
780 * rare case and less expensive than a smp call.
782 timer_stats_hrtimer_clear_start_info(timer);
783 reprogram = base->cpu_base == &__get_cpu_var(hrtimer_bases);
784 __remove_hrtimer(timer, base, HRTIMER_STATE_INACTIVE,
785 reprogram);
786 return 1;
788 return 0;
792 * hrtimer_start - (re)start an relative timer on the current CPU
793 * @timer: the timer to be added
794 * @tim: expiry time
795 * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
797 * Returns:
798 * 0 on success
799 * 1 when the timer was active
802 hrtimer_start(struct hrtimer *timer, ktime_t tim, const enum hrtimer_mode mode)
804 struct hrtimer_clock_base *base, *new_base;
805 unsigned long flags;
806 int ret;
808 base = lock_hrtimer_base(timer, &flags);
810 /* Remove an active timer from the queue: */
811 ret = remove_hrtimer(timer, base);
813 /* Switch the timer base, if necessary: */
814 new_base = switch_hrtimer_base(timer, base);
816 if (mode == HRTIMER_MODE_REL) {
817 tim = ktime_add(tim, new_base->get_time());
819 * CONFIG_TIME_LOW_RES is a temporary way for architectures
820 * to signal that they simply return xtime in
821 * do_gettimeoffset(). In this case we want to round up by
822 * resolution when starting a relative timer, to avoid short
823 * timeouts. This will go away with the GTOD framework.
825 #ifdef CONFIG_TIME_LOW_RES
826 tim = ktime_add(tim, base->resolution);
827 #endif
829 * Careful here: User space might have asked for a
830 * very long sleep, so the add above might result in a
831 * negative number, which enqueues the timer in front
832 * of the queue.
834 if (tim.tv64 < 0)
835 tim.tv64 = KTIME_MAX;
837 timer->expires = tim;
839 timer_stats_hrtimer_set_start_info(timer);
842 * Only allow reprogramming if the new base is on this CPU.
843 * (it might still be on another CPU if the timer was pending)
845 enqueue_hrtimer(timer, new_base,
846 new_base->cpu_base == &__get_cpu_var(hrtimer_bases));
848 unlock_hrtimer_base(timer, &flags);
850 return ret;
852 EXPORT_SYMBOL_GPL(hrtimer_start);
855 * hrtimer_try_to_cancel - try to deactivate a timer
856 * @timer: hrtimer to stop
858 * Returns:
859 * 0 when the timer was not active
860 * 1 when the timer was active
861 * -1 when the timer is currently excuting the callback function and
862 * cannot be stopped
864 int hrtimer_try_to_cancel(struct hrtimer *timer)
866 struct hrtimer_clock_base *base;
867 unsigned long flags;
868 int ret = -1;
870 base = lock_hrtimer_base(timer, &flags);
872 if (!hrtimer_callback_running(timer))
873 ret = remove_hrtimer(timer, base);
875 unlock_hrtimer_base(timer, &flags);
877 return ret;
880 EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
883 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
884 * @timer: the timer to be cancelled
886 * Returns:
887 * 0 when the timer was not active
888 * 1 when the timer was active
890 int hrtimer_cancel(struct hrtimer *timer)
892 for (;;) {
893 int ret = hrtimer_try_to_cancel(timer);
895 if (ret >= 0)
896 return ret;
897 cpu_relax();
900 EXPORT_SYMBOL_GPL(hrtimer_cancel);
903 * hrtimer_get_remaining - get remaining time for the timer
904 * @timer: the timer to read
906 ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
908 struct hrtimer_clock_base *base;
909 unsigned long flags;
910 ktime_t rem;
912 base = lock_hrtimer_base(timer, &flags);
913 rem = ktime_sub(timer->expires, base->get_time());
914 unlock_hrtimer_base(timer, &flags);
916 return rem;
918 EXPORT_SYMBOL_GPL(hrtimer_get_remaining);
920 #if defined(CONFIG_NO_IDLE_HZ) || defined(CONFIG_NO_HZ)
922 * hrtimer_get_next_event - get the time until next expiry event
924 * Returns the delta to the next expiry event or KTIME_MAX if no timer
925 * is pending.
927 ktime_t hrtimer_get_next_event(void)
929 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
930 struct hrtimer_clock_base *base = cpu_base->clock_base;
931 ktime_t delta, mindelta = { .tv64 = KTIME_MAX };
932 unsigned long flags;
933 int i;
935 spin_lock_irqsave(&cpu_base->lock, flags);
937 if (!hrtimer_hres_active()) {
938 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
939 struct hrtimer *timer;
941 if (!base->first)
942 continue;
944 timer = rb_entry(base->first, struct hrtimer, node);
945 delta.tv64 = timer->expires.tv64;
946 delta = ktime_sub(delta, base->get_time());
947 if (delta.tv64 < mindelta.tv64)
948 mindelta.tv64 = delta.tv64;
952 spin_unlock_irqrestore(&cpu_base->lock, flags);
954 if (mindelta.tv64 < 0)
955 mindelta.tv64 = 0;
956 return mindelta;
958 #endif
961 * hrtimer_init - initialize a timer to the given clock
962 * @timer: the timer to be initialized
963 * @clock_id: the clock to be used
964 * @mode: timer mode abs/rel
966 void hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
967 enum hrtimer_mode mode)
969 struct hrtimer_cpu_base *cpu_base;
971 memset(timer, 0, sizeof(struct hrtimer));
973 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
975 if (clock_id == CLOCK_REALTIME && mode != HRTIMER_MODE_ABS)
976 clock_id = CLOCK_MONOTONIC;
978 timer->base = &cpu_base->clock_base[clock_id];
979 hrtimer_init_timer_hres(timer);
981 #ifdef CONFIG_TIMER_STATS
982 timer->start_site = NULL;
983 timer->start_pid = -1;
984 memset(timer->start_comm, 0, TASK_COMM_LEN);
985 #endif
987 EXPORT_SYMBOL_GPL(hrtimer_init);
990 * hrtimer_get_res - get the timer resolution for a clock
991 * @which_clock: which clock to query
992 * @tp: pointer to timespec variable to store the resolution
994 * Store the resolution of the clock selected by @which_clock in the
995 * variable pointed to by @tp.
997 int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp)
999 struct hrtimer_cpu_base *cpu_base;
1001 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
1002 *tp = ktime_to_timespec(cpu_base->clock_base[which_clock].resolution);
1004 return 0;
1006 EXPORT_SYMBOL_GPL(hrtimer_get_res);
1008 #ifdef CONFIG_HIGH_RES_TIMERS
1011 * High resolution timer interrupt
1012 * Called with interrupts disabled
1014 void hrtimer_interrupt(struct clock_event_device *dev)
1016 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1017 struct hrtimer_clock_base *base;
1018 ktime_t expires_next, now;
1019 int i, raise = 0;
1021 BUG_ON(!cpu_base->hres_active);
1022 cpu_base->nr_events++;
1023 dev->next_event.tv64 = KTIME_MAX;
1025 retry:
1026 now = ktime_get();
1028 expires_next.tv64 = KTIME_MAX;
1030 base = cpu_base->clock_base;
1032 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
1033 ktime_t basenow;
1034 struct rb_node *node;
1036 spin_lock(&cpu_base->lock);
1038 basenow = ktime_add(now, base->offset);
1040 while ((node = base->first)) {
1041 struct hrtimer *timer;
1043 timer = rb_entry(node, struct hrtimer, node);
1045 if (basenow.tv64 < timer->expires.tv64) {
1046 ktime_t expires;
1048 expires = ktime_sub(timer->expires,
1049 base->offset);
1050 if (expires.tv64 < expires_next.tv64)
1051 expires_next = expires;
1052 break;
1055 /* Move softirq callbacks to the pending list */
1056 if (timer->cb_mode == HRTIMER_CB_SOFTIRQ) {
1057 __remove_hrtimer(timer, base,
1058 HRTIMER_STATE_PENDING, 0);
1059 list_add_tail(&timer->cb_entry,
1060 &base->cpu_base->cb_pending);
1061 raise = 1;
1062 continue;
1065 __remove_hrtimer(timer, base,
1066 HRTIMER_STATE_CALLBACK, 0);
1067 timer_stats_account_hrtimer(timer);
1070 * Note: We clear the CALLBACK bit after
1071 * enqueue_hrtimer to avoid reprogramming of
1072 * the event hardware. This happens at the end
1073 * of this function anyway.
1075 if (timer->function(timer) != HRTIMER_NORESTART) {
1076 BUG_ON(timer->state != HRTIMER_STATE_CALLBACK);
1077 enqueue_hrtimer(timer, base, 0);
1079 timer->state &= ~HRTIMER_STATE_CALLBACK;
1081 spin_unlock(&cpu_base->lock);
1082 base++;
1085 cpu_base->expires_next = expires_next;
1087 /* Reprogramming necessary ? */
1088 if (expires_next.tv64 != KTIME_MAX) {
1089 if (tick_program_event(expires_next, 0))
1090 goto retry;
1093 /* Raise softirq ? */
1094 if (raise)
1095 raise_softirq(HRTIMER_SOFTIRQ);
1098 static void run_hrtimer_softirq(struct softirq_action *h)
1100 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1102 spin_lock_irq(&cpu_base->lock);
1104 while (!list_empty(&cpu_base->cb_pending)) {
1105 enum hrtimer_restart (*fn)(struct hrtimer *);
1106 struct hrtimer *timer;
1107 int restart;
1109 timer = list_entry(cpu_base->cb_pending.next,
1110 struct hrtimer, cb_entry);
1112 timer_stats_account_hrtimer(timer);
1114 fn = timer->function;
1115 __remove_hrtimer(timer, timer->base, HRTIMER_STATE_CALLBACK, 0);
1116 spin_unlock_irq(&cpu_base->lock);
1118 restart = fn(timer);
1120 spin_lock_irq(&cpu_base->lock);
1122 timer->state &= ~HRTIMER_STATE_CALLBACK;
1123 if (restart == HRTIMER_RESTART) {
1124 BUG_ON(hrtimer_active(timer));
1126 * Enqueue the timer, allow reprogramming of the event
1127 * device
1129 enqueue_hrtimer(timer, timer->base, 1);
1130 } else if (hrtimer_active(timer)) {
1132 * If the timer was rearmed on another CPU, reprogram
1133 * the event device.
1135 if (timer->base->first == &timer->node)
1136 hrtimer_reprogram(timer, timer->base);
1139 spin_unlock_irq(&cpu_base->lock);
1142 #endif /* CONFIG_HIGH_RES_TIMERS */
1145 * Expire the per base hrtimer-queue:
1147 static inline void run_hrtimer_queue(struct hrtimer_cpu_base *cpu_base,
1148 int index)
1150 struct rb_node *node;
1151 struct hrtimer_clock_base *base = &cpu_base->clock_base[index];
1153 if (!base->first)
1154 return;
1156 if (base->get_softirq_time)
1157 base->softirq_time = base->get_softirq_time();
1159 spin_lock_irq(&cpu_base->lock);
1161 while ((node = base->first)) {
1162 struct hrtimer *timer;
1163 enum hrtimer_restart (*fn)(struct hrtimer *);
1164 int restart;
1166 timer = rb_entry(node, struct hrtimer, node);
1167 if (base->softirq_time.tv64 <= timer->expires.tv64)
1168 break;
1170 #ifdef CONFIG_HIGH_RES_TIMERS
1171 WARN_ON_ONCE(timer->cb_mode == HRTIMER_CB_IRQSAFE_NO_SOFTIRQ);
1172 #endif
1173 timer_stats_account_hrtimer(timer);
1175 fn = timer->function;
1176 __remove_hrtimer(timer, base, HRTIMER_STATE_CALLBACK, 0);
1177 spin_unlock_irq(&cpu_base->lock);
1179 restart = fn(timer);
1181 spin_lock_irq(&cpu_base->lock);
1183 timer->state &= ~HRTIMER_STATE_CALLBACK;
1184 if (restart != HRTIMER_NORESTART) {
1185 BUG_ON(hrtimer_active(timer));
1186 enqueue_hrtimer(timer, base, 0);
1189 spin_unlock_irq(&cpu_base->lock);
1193 * Called from timer softirq every jiffy, expire hrtimers:
1195 * For HRT its the fall back code to run the softirq in the timer
1196 * softirq context in case the hrtimer initialization failed or has
1197 * not been done yet.
1199 void hrtimer_run_queues(void)
1201 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
1202 int i;
1204 if (hrtimer_hres_active())
1205 return;
1208 * This _is_ ugly: We have to check in the softirq context,
1209 * whether we can switch to highres and / or nohz mode. The
1210 * clocksource switch happens in the timer interrupt with
1211 * xtime_lock held. Notification from there only sets the
1212 * check bit in the tick_oneshot code, otherwise we might
1213 * deadlock vs. xtime_lock.
1215 if (tick_check_oneshot_change(!hrtimer_is_hres_enabled()))
1216 if (hrtimer_switch_to_hres())
1217 return;
1219 hrtimer_get_softirq_time(cpu_base);
1221 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
1222 run_hrtimer_queue(cpu_base, i);
1226 * Sleep related functions:
1228 static enum hrtimer_restart hrtimer_wakeup(struct hrtimer *timer)
1230 struct hrtimer_sleeper *t =
1231 container_of(timer, struct hrtimer_sleeper, timer);
1232 struct task_struct *task = t->task;
1234 t->task = NULL;
1235 if (task)
1236 wake_up_process(task);
1238 return HRTIMER_NORESTART;
1241 void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, struct task_struct *task)
1243 sl->timer.function = hrtimer_wakeup;
1244 sl->task = task;
1245 #ifdef CONFIG_HIGH_RES_TIMERS
1246 sl->timer.cb_mode = HRTIMER_CB_IRQSAFE_NO_RESTART;
1247 #endif
1250 static int __sched do_nanosleep(struct hrtimer_sleeper *t, enum hrtimer_mode mode)
1252 hrtimer_init_sleeper(t, current);
1254 do {
1255 set_current_state(TASK_INTERRUPTIBLE);
1256 hrtimer_start(&t->timer, t->timer.expires, mode);
1258 if (likely(t->task))
1259 schedule();
1261 hrtimer_cancel(&t->timer);
1262 mode = HRTIMER_MODE_ABS;
1264 } while (t->task && !signal_pending(current));
1266 return t->task == NULL;
1269 long __sched hrtimer_nanosleep_restart(struct restart_block *restart)
1271 struct hrtimer_sleeper t;
1272 struct timespec __user *rmtp;
1273 struct timespec tu;
1274 ktime_t time;
1276 restart->fn = do_no_restart_syscall;
1278 hrtimer_init(&t.timer, restart->arg0, HRTIMER_MODE_ABS);
1279 t.timer.expires.tv64 = ((u64)restart->arg3 << 32) | (u64) restart->arg2;
1281 if (do_nanosleep(&t, HRTIMER_MODE_ABS))
1282 return 0;
1284 rmtp = (struct timespec __user *) restart->arg1;
1285 if (rmtp) {
1286 time = ktime_sub(t.timer.expires, t.timer.base->get_time());
1287 if (time.tv64 <= 0)
1288 return 0;
1289 tu = ktime_to_timespec(time);
1290 if (copy_to_user(rmtp, &tu, sizeof(tu)))
1291 return -EFAULT;
1294 restart->fn = hrtimer_nanosleep_restart;
1296 /* The other values in restart are already filled in */
1297 return -ERESTART_RESTARTBLOCK;
1300 long hrtimer_nanosleep(struct timespec *rqtp, struct timespec __user *rmtp,
1301 const enum hrtimer_mode mode, const clockid_t clockid)
1303 struct restart_block *restart;
1304 struct hrtimer_sleeper t;
1305 struct timespec tu;
1306 ktime_t rem;
1308 hrtimer_init(&t.timer, clockid, mode);
1309 t.timer.expires = timespec_to_ktime(*rqtp);
1310 if (do_nanosleep(&t, mode))
1311 return 0;
1313 /* Absolute timers do not update the rmtp value and restart: */
1314 if (mode == HRTIMER_MODE_ABS)
1315 return -ERESTARTNOHAND;
1317 if (rmtp) {
1318 rem = ktime_sub(t.timer.expires, t.timer.base->get_time());
1319 if (rem.tv64 <= 0)
1320 return 0;
1321 tu = ktime_to_timespec(rem);
1322 if (copy_to_user(rmtp, &tu, sizeof(tu)))
1323 return -EFAULT;
1326 restart = &current_thread_info()->restart_block;
1327 restart->fn = hrtimer_nanosleep_restart;
1328 restart->arg0 = (unsigned long) t.timer.base->index;
1329 restart->arg1 = (unsigned long) rmtp;
1330 restart->arg2 = t.timer.expires.tv64 & 0xFFFFFFFF;
1331 restart->arg3 = t.timer.expires.tv64 >> 32;
1333 return -ERESTART_RESTARTBLOCK;
1336 asmlinkage long
1337 sys_nanosleep(struct timespec __user *rqtp, struct timespec __user *rmtp)
1339 struct timespec tu;
1341 if (copy_from_user(&tu, rqtp, sizeof(tu)))
1342 return -EFAULT;
1344 if (!timespec_valid(&tu))
1345 return -EINVAL;
1347 return hrtimer_nanosleep(&tu, rmtp, HRTIMER_MODE_REL, CLOCK_MONOTONIC);
1351 * Functions related to boot-time initialization:
1353 static void __devinit init_hrtimers_cpu(int cpu)
1355 struct hrtimer_cpu_base *cpu_base = &per_cpu(hrtimer_bases, cpu);
1356 int i;
1358 spin_lock_init(&cpu_base->lock);
1359 lockdep_set_class(&cpu_base->lock, &cpu_base->lock_key);
1361 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
1362 cpu_base->clock_base[i].cpu_base = cpu_base;
1364 hrtimer_init_hres(cpu_base);
1367 #ifdef CONFIG_HOTPLUG_CPU
1369 static void migrate_hrtimer_list(struct hrtimer_clock_base *old_base,
1370 struct hrtimer_clock_base *new_base)
1372 struct hrtimer *timer;
1373 struct rb_node *node;
1375 while ((node = rb_first(&old_base->active))) {
1376 timer = rb_entry(node, struct hrtimer, node);
1377 BUG_ON(hrtimer_callback_running(timer));
1378 __remove_hrtimer(timer, old_base, HRTIMER_STATE_INACTIVE, 0);
1379 timer->base = new_base;
1381 * Enqueue the timer. Allow reprogramming of the event device
1383 enqueue_hrtimer(timer, new_base, 1);
1387 static void migrate_hrtimers(int cpu)
1389 struct hrtimer_cpu_base *old_base, *new_base;
1390 int i;
1392 BUG_ON(cpu_online(cpu));
1393 old_base = &per_cpu(hrtimer_bases, cpu);
1394 new_base = &get_cpu_var(hrtimer_bases);
1396 tick_cancel_sched_timer(cpu);
1398 local_irq_disable();
1399 double_spin_lock(&new_base->lock, &old_base->lock,
1400 smp_processor_id() < cpu);
1402 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
1403 migrate_hrtimer_list(&old_base->clock_base[i],
1404 &new_base->clock_base[i]);
1407 double_spin_unlock(&new_base->lock, &old_base->lock,
1408 smp_processor_id() < cpu);
1409 local_irq_enable();
1410 put_cpu_var(hrtimer_bases);
1412 #endif /* CONFIG_HOTPLUG_CPU */
1414 static int __cpuinit hrtimer_cpu_notify(struct notifier_block *self,
1415 unsigned long action, void *hcpu)
1417 long cpu = (long)hcpu;
1419 switch (action) {
1421 case CPU_UP_PREPARE:
1422 case CPU_UP_PREPARE_FROZEN:
1423 init_hrtimers_cpu(cpu);
1424 break;
1426 #ifdef CONFIG_HOTPLUG_CPU
1427 case CPU_DEAD:
1428 case CPU_DEAD_FROZEN:
1429 clockevents_notify(CLOCK_EVT_NOTIFY_CPU_DEAD, &cpu);
1430 migrate_hrtimers(cpu);
1431 break;
1432 #endif
1434 default:
1435 break;
1438 return NOTIFY_OK;
1441 static struct notifier_block __cpuinitdata hrtimers_nb = {
1442 .notifier_call = hrtimer_cpu_notify,
1445 void __init hrtimers_init(void)
1447 hrtimer_cpu_notify(&hrtimers_nb, (unsigned long)CPU_UP_PREPARE,
1448 (void *)(long)smp_processor_id());
1449 register_cpu_notifier(&hrtimers_nb);
1450 #ifdef CONFIG_HIGH_RES_TIMERS
1451 open_softirq(HRTIMER_SOFTIRQ, run_hrtimer_softirq, NULL);
1452 #endif