1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de>
4 * Copyright(C) 2005-2007, Red Hat, Inc., Ingo Molnar
5 * Copyright(C) 2006-2007 Timesys Corp., Thomas Gleixner
7 * High-resolution kernel timers
9 * In contrast to the low-resolution timeout API, aka timer wheel,
10 * hrtimers provide finer resolution and accuracy depending on system
11 * configuration and capabilities.
13 * Started by: Thomas Gleixner and Ingo Molnar
16 * Based on the original timer wheel code
18 * Help, testing, suggestions, bugfixes, improvements were
21 * George Anzinger, Andrew Morton, Steven Rostedt, Roman Zippel
25 #include <linux/cpu.h>
26 #include <linux/export.h>
27 #include <linux/percpu.h>
28 #include <linux/hrtimer.h>
29 #include <linux/notifier.h>
30 #include <linux/syscalls.h>
31 #include <linux/interrupt.h>
32 #include <linux/tick.h>
33 #include <linux/err.h>
34 #include <linux/debugobjects.h>
35 #include <linux/sched/signal.h>
36 #include <linux/sched/sysctl.h>
37 #include <linux/sched/rt.h>
38 #include <linux/sched/deadline.h>
39 #include <linux/sched/nohz.h>
40 #include <linux/sched/debug.h>
41 #include <linux/timer.h>
42 #include <linux/freezer.h>
43 #include <linux/compat.h>
45 #include <linux/uaccess.h>
47 #include <trace/events/timer.h>
49 #include "tick-internal.h"
52 * Masks for selecting the soft and hard context timers from
55 #define MASK_SHIFT (HRTIMER_BASE_MONOTONIC_SOFT)
56 #define HRTIMER_ACTIVE_HARD ((1U << MASK_SHIFT) - 1)
57 #define HRTIMER_ACTIVE_SOFT (HRTIMER_ACTIVE_HARD << MASK_SHIFT)
58 #define HRTIMER_ACTIVE_ALL (HRTIMER_ACTIVE_SOFT | HRTIMER_ACTIVE_HARD)
63 * There are more clockids than hrtimer bases. Thus, we index
64 * into the timer bases by the hrtimer_base_type enum. When trying
65 * to reach a base using a clockid, hrtimer_clockid_to_base()
66 * is used to convert from clockid to the proper hrtimer_base_type.
68 DEFINE_PER_CPU(struct hrtimer_cpu_base, hrtimer_bases) =
70 .lock = __RAW_SPIN_LOCK_UNLOCKED(hrtimer_bases.lock),
74 .index = HRTIMER_BASE_MONOTONIC,
75 .clockid = CLOCK_MONOTONIC,
76 .get_time = &ktime_get,
79 .index = HRTIMER_BASE_REALTIME,
80 .clockid = CLOCK_REALTIME,
81 .get_time = &ktime_get_real,
84 .index = HRTIMER_BASE_BOOTTIME,
85 .clockid = CLOCK_BOOTTIME,
86 .get_time = &ktime_get_boottime,
89 .index = HRTIMER_BASE_TAI,
91 .get_time = &ktime_get_clocktai,
94 .index = HRTIMER_BASE_MONOTONIC_SOFT,
95 .clockid = CLOCK_MONOTONIC,
96 .get_time = &ktime_get,
99 .index = HRTIMER_BASE_REALTIME_SOFT,
100 .clockid = CLOCK_REALTIME,
101 .get_time = &ktime_get_real,
104 .index = HRTIMER_BASE_BOOTTIME_SOFT,
105 .clockid = CLOCK_BOOTTIME,
106 .get_time = &ktime_get_boottime,
109 .index = HRTIMER_BASE_TAI_SOFT,
110 .clockid = CLOCK_TAI,
111 .get_time = &ktime_get_clocktai,
116 static const int hrtimer_clock_to_base_table[MAX_CLOCKS] = {
117 /* Make sure we catch unsupported clockids */
118 [0 ... MAX_CLOCKS - 1] = HRTIMER_MAX_CLOCK_BASES,
120 [CLOCK_REALTIME] = HRTIMER_BASE_REALTIME,
121 [CLOCK_MONOTONIC] = HRTIMER_BASE_MONOTONIC,
122 [CLOCK_BOOTTIME] = HRTIMER_BASE_BOOTTIME,
123 [CLOCK_TAI] = HRTIMER_BASE_TAI,
127 * Functions and macros which are different for UP/SMP systems are kept in a
133 * We require the migration_base for lock_hrtimer_base()/switch_hrtimer_base()
134 * such that hrtimer_callback_running() can unconditionally dereference
135 * timer->base->cpu_base
137 static struct hrtimer_cpu_base migration_cpu_base = {
139 .cpu_base = &migration_cpu_base,
140 .seq = SEQCNT_RAW_SPINLOCK_ZERO(migration_cpu_base.seq,
141 &migration_cpu_base.lock),
145 #define migration_base migration_cpu_base.clock_base[0]
147 static inline bool is_migration_base(struct hrtimer_clock_base *base)
149 return base == &migration_base;
153 * We are using hashed locking: holding per_cpu(hrtimer_bases)[n].lock
154 * means that all timers which are tied to this base via timer->base are
155 * locked, and the base itself is locked too.
157 * So __run_timers/migrate_timers can safely modify all timers which could
158 * be found on the lists/queues.
160 * When the timer's base is locked, and the timer removed from list, it is
161 * possible to set timer->base = &migration_base and drop the lock: the timer
165 struct hrtimer_clock_base *lock_hrtimer_base(const struct hrtimer *timer,
166 unsigned long *flags)
168 struct hrtimer_clock_base *base;
171 base = READ_ONCE(timer->base);
172 if (likely(base != &migration_base)) {
173 raw_spin_lock_irqsave(&base->cpu_base->lock, *flags);
174 if (likely(base == timer->base))
176 /* The timer has migrated to another CPU: */
177 raw_spin_unlock_irqrestore(&base->cpu_base->lock, *flags);
184 * We do not migrate the timer when it is expiring before the next
185 * event on the target cpu. When high resolution is enabled, we cannot
186 * reprogram the target cpu hardware and we would cause it to fire
187 * late. To keep it simple, we handle the high resolution enabled and
188 * disabled case similar.
190 * Called with cpu_base->lock of target cpu held.
193 hrtimer_check_target(struct hrtimer *timer, struct hrtimer_clock_base *new_base)
197 expires = ktime_sub(hrtimer_get_expires(timer), new_base->offset);
198 return expires < new_base->cpu_base->expires_next;
202 struct hrtimer_cpu_base *get_target_base(struct hrtimer_cpu_base *base,
205 #if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
206 if (static_branch_likely(&timers_migration_enabled) && !pinned)
207 return &per_cpu(hrtimer_bases, get_nohz_timer_target());
213 * We switch the timer base to a power-optimized selected CPU target,
215 * - NO_HZ_COMMON is enabled
216 * - timer migration is enabled
217 * - the timer callback is not running
218 * - the timer is not the first expiring timer on the new target
220 * If one of the above requirements is not fulfilled we move the timer
221 * to the current CPU or leave it on the previously assigned CPU if
222 * the timer callback is currently running.
224 static inline struct hrtimer_clock_base *
225 switch_hrtimer_base(struct hrtimer *timer, struct hrtimer_clock_base *base,
228 struct hrtimer_cpu_base *new_cpu_base, *this_cpu_base;
229 struct hrtimer_clock_base *new_base;
230 int basenum = base->index;
232 this_cpu_base = this_cpu_ptr(&hrtimer_bases);
233 new_cpu_base = get_target_base(this_cpu_base, pinned);
235 new_base = &new_cpu_base->clock_base[basenum];
237 if (base != new_base) {
239 * We are trying to move timer to new_base.
240 * However we can't change timer's base while it is running,
241 * so we keep it on the same CPU. No hassle vs. reprogramming
242 * the event source in the high resolution case. The softirq
243 * code will take care of this when the timer function has
244 * completed. There is no conflict as we hold the lock until
245 * the timer is enqueued.
247 if (unlikely(hrtimer_callback_running(timer)))
250 /* See the comment in lock_hrtimer_base() */
251 WRITE_ONCE(timer->base, &migration_base);
252 raw_spin_unlock(&base->cpu_base->lock);
253 raw_spin_lock(&new_base->cpu_base->lock);
255 if (new_cpu_base != this_cpu_base &&
256 hrtimer_check_target(timer, new_base)) {
257 raw_spin_unlock(&new_base->cpu_base->lock);
258 raw_spin_lock(&base->cpu_base->lock);
259 new_cpu_base = this_cpu_base;
260 WRITE_ONCE(timer->base, base);
263 WRITE_ONCE(timer->base, new_base);
265 if (new_cpu_base != this_cpu_base &&
266 hrtimer_check_target(timer, new_base)) {
267 new_cpu_base = this_cpu_base;
274 #else /* CONFIG_SMP */
276 static inline bool is_migration_base(struct hrtimer_clock_base *base)
281 static inline struct hrtimer_clock_base *
282 lock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
284 struct hrtimer_clock_base *base = timer->base;
286 raw_spin_lock_irqsave(&base->cpu_base->lock, *flags);
291 # define switch_hrtimer_base(t, b, p) (b)
293 #endif /* !CONFIG_SMP */
296 * Functions for the union type storage format of ktime_t which are
297 * too large for inlining:
299 #if BITS_PER_LONG < 64
301 * Divide a ktime value by a nanosecond value
303 s64 __ktime_divns(const ktime_t kt, s64 div)
309 dclc = ktime_to_ns(kt);
310 tmp = dclc < 0 ? -dclc : dclc;
312 /* Make sure the divisor is less than 2^32: */
318 do_div(tmp, (u32) div);
319 return dclc < 0 ? -tmp : tmp;
321 EXPORT_SYMBOL_GPL(__ktime_divns);
322 #endif /* BITS_PER_LONG >= 64 */
325 * Add two ktime values and do a safety check for overflow:
327 ktime_t ktime_add_safe(const ktime_t lhs, const ktime_t rhs)
329 ktime_t res = ktime_add_unsafe(lhs, rhs);
332 * We use KTIME_SEC_MAX here, the maximum timeout which we can
333 * return to user space in a timespec:
335 if (res < 0 || res < lhs || res < rhs)
336 res = ktime_set(KTIME_SEC_MAX, 0);
341 EXPORT_SYMBOL_GPL(ktime_add_safe);
343 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
345 static const struct debug_obj_descr hrtimer_debug_descr;
347 static void *hrtimer_debug_hint(void *addr)
349 return ((struct hrtimer *) addr)->function;
353 * fixup_init is called when:
354 * - an active object is initialized
356 static bool hrtimer_fixup_init(void *addr, enum debug_obj_state state)
358 struct hrtimer *timer = addr;
361 case ODEBUG_STATE_ACTIVE:
362 hrtimer_cancel(timer);
363 debug_object_init(timer, &hrtimer_debug_descr);
371 * fixup_activate is called when:
372 * - an active object is activated
373 * - an unknown non-static object is activated
375 static bool hrtimer_fixup_activate(void *addr, enum debug_obj_state state)
378 case ODEBUG_STATE_ACTIVE:
387 * fixup_free is called when:
388 * - an active object is freed
390 static bool hrtimer_fixup_free(void *addr, enum debug_obj_state state)
392 struct hrtimer *timer = addr;
395 case ODEBUG_STATE_ACTIVE:
396 hrtimer_cancel(timer);
397 debug_object_free(timer, &hrtimer_debug_descr);
404 static const struct debug_obj_descr hrtimer_debug_descr = {
406 .debug_hint = hrtimer_debug_hint,
407 .fixup_init = hrtimer_fixup_init,
408 .fixup_activate = hrtimer_fixup_activate,
409 .fixup_free = hrtimer_fixup_free,
412 static inline void debug_hrtimer_init(struct hrtimer *timer)
414 debug_object_init(timer, &hrtimer_debug_descr);
417 static inline void debug_hrtimer_activate(struct hrtimer *timer,
418 enum hrtimer_mode mode)
420 debug_object_activate(timer, &hrtimer_debug_descr);
423 static inline void debug_hrtimer_deactivate(struct hrtimer *timer)
425 debug_object_deactivate(timer, &hrtimer_debug_descr);
428 static void __hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
429 enum hrtimer_mode mode);
431 void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t clock_id,
432 enum hrtimer_mode mode)
434 debug_object_init_on_stack(timer, &hrtimer_debug_descr);
435 __hrtimer_init(timer, clock_id, mode);
437 EXPORT_SYMBOL_GPL(hrtimer_init_on_stack);
439 static void __hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
440 clockid_t clock_id, enum hrtimer_mode mode);
442 void hrtimer_init_sleeper_on_stack(struct hrtimer_sleeper *sl,
443 clockid_t clock_id, enum hrtimer_mode mode)
445 debug_object_init_on_stack(&sl->timer, &hrtimer_debug_descr);
446 __hrtimer_init_sleeper(sl, clock_id, mode);
448 EXPORT_SYMBOL_GPL(hrtimer_init_sleeper_on_stack);
450 void destroy_hrtimer_on_stack(struct hrtimer *timer)
452 debug_object_free(timer, &hrtimer_debug_descr);
454 EXPORT_SYMBOL_GPL(destroy_hrtimer_on_stack);
458 static inline void debug_hrtimer_init(struct hrtimer *timer) { }
459 static inline void debug_hrtimer_activate(struct hrtimer *timer,
460 enum hrtimer_mode mode) { }
461 static inline void debug_hrtimer_deactivate(struct hrtimer *timer) { }
465 debug_init(struct hrtimer *timer, clockid_t clockid,
466 enum hrtimer_mode mode)
468 debug_hrtimer_init(timer);
469 trace_hrtimer_init(timer, clockid, mode);
472 static inline void debug_activate(struct hrtimer *timer,
473 enum hrtimer_mode mode)
475 debug_hrtimer_activate(timer, mode);
476 trace_hrtimer_start(timer, mode);
479 static inline void debug_deactivate(struct hrtimer *timer)
481 debug_hrtimer_deactivate(timer);
482 trace_hrtimer_cancel(timer);
485 static struct hrtimer_clock_base *
486 __next_base(struct hrtimer_cpu_base *cpu_base, unsigned int *active)
493 idx = __ffs(*active);
494 *active &= ~(1U << idx);
496 return &cpu_base->clock_base[idx];
499 #define for_each_active_base(base, cpu_base, active) \
500 while ((base = __next_base((cpu_base), &(active))))
502 static ktime_t __hrtimer_next_event_base(struct hrtimer_cpu_base *cpu_base,
503 const struct hrtimer *exclude,
505 ktime_t expires_next)
507 struct hrtimer_clock_base *base;
510 for_each_active_base(base, cpu_base, active) {
511 struct timerqueue_node *next;
512 struct hrtimer *timer;
514 next = timerqueue_getnext(&base->active);
515 timer = container_of(next, struct hrtimer, node);
516 if (timer == exclude) {
517 /* Get to the next timer in the queue. */
518 next = timerqueue_iterate_next(next);
522 timer = container_of(next, struct hrtimer, node);
524 expires = ktime_sub(hrtimer_get_expires(timer), base->offset);
525 if (expires < expires_next) {
526 expires_next = expires;
528 /* Skip cpu_base update if a timer is being excluded. */
533 cpu_base->softirq_next_timer = timer;
535 cpu_base->next_timer = timer;
539 * clock_was_set() might have changed base->offset of any of
540 * the clock bases so the result might be negative. Fix it up
541 * to prevent a false positive in clockevents_program_event().
543 if (expires_next < 0)
549 * Recomputes cpu_base::*next_timer and returns the earliest expires_next
550 * but does not set cpu_base::*expires_next, that is done by
551 * hrtimer[_force]_reprogram and hrtimer_interrupt only. When updating
552 * cpu_base::*expires_next right away, reprogramming logic would no longer
555 * When a softirq is pending, we can ignore the HRTIMER_ACTIVE_SOFT bases,
556 * those timers will get run whenever the softirq gets handled, at the end of
557 * hrtimer_run_softirq(), hrtimer_update_softirq_timer() will re-add these bases.
559 * Therefore softirq values are those from the HRTIMER_ACTIVE_SOFT clock bases.
560 * The !softirq values are the minima across HRTIMER_ACTIVE_ALL, unless an actual
561 * softirq is pending, in which case they're the minima of HRTIMER_ACTIVE_HARD.
563 * @active_mask must be one of:
564 * - HRTIMER_ACTIVE_ALL,
565 * - HRTIMER_ACTIVE_SOFT, or
566 * - HRTIMER_ACTIVE_HARD.
569 __hrtimer_get_next_event(struct hrtimer_cpu_base *cpu_base, unsigned int active_mask)
572 struct hrtimer *next_timer = NULL;
573 ktime_t expires_next = KTIME_MAX;
575 if (!cpu_base->softirq_activated && (active_mask & HRTIMER_ACTIVE_SOFT)) {
576 active = cpu_base->active_bases & HRTIMER_ACTIVE_SOFT;
577 cpu_base->softirq_next_timer = NULL;
578 expires_next = __hrtimer_next_event_base(cpu_base, NULL,
581 next_timer = cpu_base->softirq_next_timer;
584 if (active_mask & HRTIMER_ACTIVE_HARD) {
585 active = cpu_base->active_bases & HRTIMER_ACTIVE_HARD;
586 cpu_base->next_timer = next_timer;
587 expires_next = __hrtimer_next_event_base(cpu_base, NULL, active,
594 static ktime_t hrtimer_update_next_event(struct hrtimer_cpu_base *cpu_base)
596 ktime_t expires_next, soft = KTIME_MAX;
599 * If the soft interrupt has already been activated, ignore the
600 * soft bases. They will be handled in the already raised soft
603 if (!cpu_base->softirq_activated) {
604 soft = __hrtimer_get_next_event(cpu_base, HRTIMER_ACTIVE_SOFT);
606 * Update the soft expiry time. clock_settime() might have
609 cpu_base->softirq_expires_next = soft;
612 expires_next = __hrtimer_get_next_event(cpu_base, HRTIMER_ACTIVE_HARD);
614 * If a softirq timer is expiring first, update cpu_base->next_timer
615 * and program the hardware with the soft expiry time.
617 if (expires_next > soft) {
618 cpu_base->next_timer = cpu_base->softirq_next_timer;
625 static inline ktime_t hrtimer_update_base(struct hrtimer_cpu_base *base)
627 ktime_t *offs_real = &base->clock_base[HRTIMER_BASE_REALTIME].offset;
628 ktime_t *offs_boot = &base->clock_base[HRTIMER_BASE_BOOTTIME].offset;
629 ktime_t *offs_tai = &base->clock_base[HRTIMER_BASE_TAI].offset;
631 ktime_t now = ktime_get_update_offsets_now(&base->clock_was_set_seq,
632 offs_real, offs_boot, offs_tai);
634 base->clock_base[HRTIMER_BASE_REALTIME_SOFT].offset = *offs_real;
635 base->clock_base[HRTIMER_BASE_BOOTTIME_SOFT].offset = *offs_boot;
636 base->clock_base[HRTIMER_BASE_TAI_SOFT].offset = *offs_tai;
642 * Is the high resolution mode active ?
644 static inline int __hrtimer_hres_active(struct hrtimer_cpu_base *cpu_base)
646 return IS_ENABLED(CONFIG_HIGH_RES_TIMERS) ?
647 cpu_base->hres_active : 0;
650 static inline int hrtimer_hres_active(void)
652 return __hrtimer_hres_active(this_cpu_ptr(&hrtimer_bases));
656 * Reprogram the event source with checking both queues for the
658 * Called with interrupts disabled and base->lock held
661 hrtimer_force_reprogram(struct hrtimer_cpu_base *cpu_base, int skip_equal)
663 ktime_t expires_next;
665 expires_next = hrtimer_update_next_event(cpu_base);
667 if (skip_equal && expires_next == cpu_base->expires_next)
670 cpu_base->expires_next = expires_next;
673 * If hres is not active, hardware does not have to be
676 * If a hang was detected in the last timer interrupt then we
677 * leave the hang delay active in the hardware. We want the
678 * system to make progress. That also prevents the following
680 * T1 expires 50ms from now
681 * T2 expires 5s from now
683 * T1 is removed, so this code is called and would reprogram
684 * the hardware to 5s from now. Any hrtimer_start after that
685 * will not reprogram the hardware due to hang_detected being
686 * set. So we'd effectivly block all timers until the T2 event
689 if (!__hrtimer_hres_active(cpu_base) || cpu_base->hang_detected)
692 tick_program_event(cpu_base->expires_next, 1);
695 /* High resolution timer related functions */
696 #ifdef CONFIG_HIGH_RES_TIMERS
699 * High resolution timer enabled ?
701 static bool hrtimer_hres_enabled __read_mostly = true;
702 unsigned int hrtimer_resolution __read_mostly = LOW_RES_NSEC;
703 EXPORT_SYMBOL_GPL(hrtimer_resolution);
706 * Enable / Disable high resolution mode
708 static int __init setup_hrtimer_hres(char *str)
710 return (kstrtobool(str, &hrtimer_hres_enabled) == 0);
713 __setup("highres=", setup_hrtimer_hres);
716 * hrtimer_high_res_enabled - query, if the highres mode is enabled
718 static inline int hrtimer_is_hres_enabled(void)
720 return hrtimer_hres_enabled;
724 * Retrigger next event is called after clock was set
726 * Called with interrupts disabled via on_each_cpu()
728 static void retrigger_next_event(void *arg)
730 struct hrtimer_cpu_base *base = this_cpu_ptr(&hrtimer_bases);
732 if (!__hrtimer_hres_active(base))
735 raw_spin_lock(&base->lock);
736 hrtimer_update_base(base);
737 hrtimer_force_reprogram(base, 0);
738 raw_spin_unlock(&base->lock);
742 * Switch to high resolution mode
744 static void hrtimer_switch_to_hres(void)
746 struct hrtimer_cpu_base *base = this_cpu_ptr(&hrtimer_bases);
748 if (tick_init_highres()) {
749 pr_warn("Could not switch to high resolution mode on CPU %u\n",
753 base->hres_active = 1;
754 hrtimer_resolution = HIGH_RES_NSEC;
756 tick_setup_sched_timer();
757 /* "Retrigger" the interrupt to get things going */
758 retrigger_next_event(NULL);
763 static inline int hrtimer_is_hres_enabled(void) { return 0; }
764 static inline void hrtimer_switch_to_hres(void) { }
765 static inline void retrigger_next_event(void *arg) { }
767 #endif /* CONFIG_HIGH_RES_TIMERS */
770 * When a timer is enqueued and expires earlier than the already enqueued
771 * timers, we have to check, whether it expires earlier than the timer for
772 * which the clock event device was armed.
774 * Called with interrupts disabled and base->cpu_base.lock held
776 static void hrtimer_reprogram(struct hrtimer *timer, bool reprogram)
778 struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
779 struct hrtimer_clock_base *base = timer->base;
780 ktime_t expires = ktime_sub(hrtimer_get_expires(timer), base->offset);
782 WARN_ON_ONCE(hrtimer_get_expires_tv64(timer) < 0);
785 * CLOCK_REALTIME timer might be requested with an absolute
786 * expiry time which is less than base->offset. Set it to 0.
791 if (timer->is_soft) {
793 * soft hrtimer could be started on a remote CPU. In this
794 * case softirq_expires_next needs to be updated on the
795 * remote CPU. The soft hrtimer will not expire before the
796 * first hard hrtimer on the remote CPU -
797 * hrtimer_check_target() prevents this case.
799 struct hrtimer_cpu_base *timer_cpu_base = base->cpu_base;
801 if (timer_cpu_base->softirq_activated)
804 if (!ktime_before(expires, timer_cpu_base->softirq_expires_next))
807 timer_cpu_base->softirq_next_timer = timer;
808 timer_cpu_base->softirq_expires_next = expires;
810 if (!ktime_before(expires, timer_cpu_base->expires_next) ||
816 * If the timer is not on the current cpu, we cannot reprogram
817 * the other cpus clock event device.
819 if (base->cpu_base != cpu_base)
823 * If the hrtimer interrupt is running, then it will
824 * reevaluate the clock bases and reprogram the clock event
825 * device. The callbacks are always executed in hard interrupt
826 * context so we don't need an extra check for a running
829 if (cpu_base->in_hrtirq)
832 if (expires >= cpu_base->expires_next)
835 /* Update the pointer to the next expiring timer */
836 cpu_base->next_timer = timer;
837 cpu_base->expires_next = expires;
840 * If hres is not active, hardware does not have to be
843 * If a hang was detected in the last timer interrupt then we
844 * do not schedule a timer which is earlier than the expiry
845 * which we enforced in the hang detection. We want the system
848 if (!__hrtimer_hres_active(cpu_base) || cpu_base->hang_detected)
852 * Program the timer hardware. We enforce the expiry for
853 * events which are already in the past.
855 tick_program_event(expires, 1);
859 * Clock realtime was set
861 * Change the offset of the realtime clock vs. the monotonic
864 * We might have to reprogram the high resolution timer interrupt. On
865 * SMP we call the architecture specific code to retrigger _all_ high
866 * resolution timer interrupts. On UP we just disable interrupts and
867 * call the high resolution interrupt code.
869 void clock_was_set(void)
871 #ifdef CONFIG_HIGH_RES_TIMERS
872 /* Retrigger the CPU local events everywhere */
873 on_each_cpu(retrigger_next_event, NULL, 1);
875 timerfd_clock_was_set();
878 static void clock_was_set_work(struct work_struct *work)
883 static DECLARE_WORK(hrtimer_work, clock_was_set_work);
886 * Called from timekeeping and resume code to reprogram the hrtimer
887 * interrupt device on all cpus and to notify timerfd.
889 void clock_was_set_delayed(void)
891 schedule_work(&hrtimer_work);
895 * During resume we might have to reprogram the high resolution timer
896 * interrupt on all online CPUs. However, all other CPUs will be
897 * stopped with IRQs interrupts disabled so the clock_was_set() call
900 void hrtimers_resume(void)
902 lockdep_assert_irqs_disabled();
903 /* Retrigger on the local CPU */
904 retrigger_next_event(NULL);
905 /* And schedule a retrigger for all others */
906 clock_was_set_delayed();
910 * Counterpart to lock_hrtimer_base above:
913 void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
915 raw_spin_unlock_irqrestore(&timer->base->cpu_base->lock, *flags);
919 * hrtimer_forward - forward the timer expiry
920 * @timer: hrtimer to forward
921 * @now: forward past this time
922 * @interval: the interval to forward
924 * Forward the timer expiry so it will expire in the future.
925 * Returns the number of overruns.
927 * Can be safely called from the callback function of @timer. If
928 * called from other contexts @timer must neither be enqueued nor
929 * running the callback and the caller needs to take care of
932 * Note: This only updates the timer expiry value and does not requeue
935 u64 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
940 delta = ktime_sub(now, hrtimer_get_expires(timer));
945 if (WARN_ON(timer->state & HRTIMER_STATE_ENQUEUED))
948 if (interval < hrtimer_resolution)
949 interval = hrtimer_resolution;
951 if (unlikely(delta >= interval)) {
952 s64 incr = ktime_to_ns(interval);
954 orun = ktime_divns(delta, incr);
955 hrtimer_add_expires_ns(timer, incr * orun);
956 if (hrtimer_get_expires_tv64(timer) > now)
959 * This (and the ktime_add() below) is the
960 * correction for exact:
964 hrtimer_add_expires(timer, interval);
968 EXPORT_SYMBOL_GPL(hrtimer_forward);
971 * enqueue_hrtimer - internal function to (re)start a timer
973 * The timer is inserted in expiry order. Insertion into the
974 * red black tree is O(log(n)). Must hold the base lock.
976 * Returns 1 when the new timer is the leftmost timer in the tree.
978 static int enqueue_hrtimer(struct hrtimer *timer,
979 struct hrtimer_clock_base *base,
980 enum hrtimer_mode mode)
982 debug_activate(timer, mode);
983 WARN_ON_ONCE(!base->cpu_base->online);
985 base->cpu_base->active_bases |= 1 << base->index;
987 /* Pairs with the lockless read in hrtimer_is_queued() */
988 WRITE_ONCE(timer->state, HRTIMER_STATE_ENQUEUED);
990 return timerqueue_add(&base->active, &timer->node);
994 * __remove_hrtimer - internal function to remove a timer
996 * Caller must hold the base lock.
998 * High resolution timer mode reprograms the clock event device when the
999 * timer is the one which expires next. The caller can disable this by setting
1000 * reprogram to zero. This is useful, when the context does a reprogramming
1001 * anyway (e.g. timer interrupt)
1003 static void __remove_hrtimer(struct hrtimer *timer,
1004 struct hrtimer_clock_base *base,
1005 u8 newstate, int reprogram)
1007 struct hrtimer_cpu_base *cpu_base = base->cpu_base;
1008 u8 state = timer->state;
1010 /* Pairs with the lockless read in hrtimer_is_queued() */
1011 WRITE_ONCE(timer->state, newstate);
1012 if (!(state & HRTIMER_STATE_ENQUEUED))
1015 if (!timerqueue_del(&base->active, &timer->node))
1016 cpu_base->active_bases &= ~(1 << base->index);
1019 * Note: If reprogram is false we do not update
1020 * cpu_base->next_timer. This happens when we remove the first
1021 * timer on a remote cpu. No harm as we never dereference
1022 * cpu_base->next_timer. So the worst thing what can happen is
1023 * an superflous call to hrtimer_force_reprogram() on the
1024 * remote cpu later on if the same timer gets enqueued again.
1026 if (reprogram && timer == cpu_base->next_timer)
1027 hrtimer_force_reprogram(cpu_base, 1);
1031 * remove hrtimer, called with base lock held
1034 remove_hrtimer(struct hrtimer *timer, struct hrtimer_clock_base *base,
1035 bool restart, bool keep_local)
1037 u8 state = timer->state;
1039 if (state & HRTIMER_STATE_ENQUEUED) {
1043 * Remove the timer and force reprogramming when high
1044 * resolution mode is active and the timer is on the current
1045 * CPU. If we remove a timer on another CPU, reprogramming is
1046 * skipped. The interrupt event on this CPU is fired and
1047 * reprogramming happens in the interrupt handler. This is a
1048 * rare case and less expensive than a smp call.
1050 debug_deactivate(timer);
1051 reprogram = base->cpu_base == this_cpu_ptr(&hrtimer_bases);
1054 * If the timer is not restarted then reprogramming is
1055 * required if the timer is local. If it is local and about
1056 * to be restarted, avoid programming it twice (on removal
1057 * and a moment later when it's requeued).
1060 state = HRTIMER_STATE_INACTIVE;
1062 reprogram &= !keep_local;
1064 __remove_hrtimer(timer, base, state, reprogram);
1070 static inline ktime_t hrtimer_update_lowres(struct hrtimer *timer, ktime_t tim,
1071 const enum hrtimer_mode mode)
1073 #ifdef CONFIG_TIME_LOW_RES
1075 * CONFIG_TIME_LOW_RES indicates that the system has no way to return
1076 * granular time values. For relative timers we add hrtimer_resolution
1077 * (i.e. one jiffie) to prevent short timeouts.
1079 timer->is_rel = mode & HRTIMER_MODE_REL;
1081 tim = ktime_add_safe(tim, hrtimer_resolution);
1087 hrtimer_update_softirq_timer(struct hrtimer_cpu_base *cpu_base, bool reprogram)
1092 * Find the next SOFT expiration.
1094 expires = __hrtimer_get_next_event(cpu_base, HRTIMER_ACTIVE_SOFT);
1097 * reprogramming needs to be triggered, even if the next soft
1098 * hrtimer expires at the same time than the next hard
1099 * hrtimer. cpu_base->softirq_expires_next needs to be updated!
1101 if (expires == KTIME_MAX)
1105 * cpu_base->*next_timer is recomputed by __hrtimer_get_next_event()
1106 * cpu_base->*expires_next is only set by hrtimer_reprogram()
1108 hrtimer_reprogram(cpu_base->softirq_next_timer, reprogram);
1111 static int __hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
1112 u64 delta_ns, const enum hrtimer_mode mode,
1113 struct hrtimer_clock_base *base)
1115 struct hrtimer_clock_base *new_base;
1116 bool force_local, first;
1119 * If the timer is on the local cpu base and is the first expiring
1120 * timer then this might end up reprogramming the hardware twice
1121 * (on removal and on enqueue). To avoid that by prevent the
1122 * reprogram on removal, keep the timer local to the current CPU
1123 * and enforce reprogramming after it is queued no matter whether
1124 * it is the new first expiring timer again or not.
1126 force_local = base->cpu_base == this_cpu_ptr(&hrtimer_bases);
1127 force_local &= base->cpu_base->next_timer == timer;
1130 * Remove an active timer from the queue. In case it is not queued
1131 * on the current CPU, make sure that remove_hrtimer() updates the
1132 * remote data correctly.
1134 * If it's on the current CPU and the first expiring timer, then
1135 * skip reprogramming, keep the timer local and enforce
1136 * reprogramming later if it was the first expiring timer. This
1137 * avoids programming the underlying clock event twice (once at
1138 * removal and once after enqueue).
1140 remove_hrtimer(timer, base, true, force_local);
1142 if (mode & HRTIMER_MODE_REL)
1143 tim = ktime_add_safe(tim, base->get_time());
1145 tim = hrtimer_update_lowres(timer, tim, mode);
1147 hrtimer_set_expires_range_ns(timer, tim, delta_ns);
1149 /* Switch the timer base, if necessary: */
1151 new_base = switch_hrtimer_base(timer, base,
1152 mode & HRTIMER_MODE_PINNED);
1157 first = enqueue_hrtimer(timer, new_base, mode);
1162 * Timer was forced to stay on the current CPU to avoid
1163 * reprogramming on removal and enqueue. Force reprogram the
1164 * hardware by evaluating the new first expiring timer.
1166 hrtimer_force_reprogram(new_base->cpu_base, 1);
1171 * hrtimer_start_range_ns - (re)start an hrtimer
1172 * @timer: the timer to be added
1174 * @delta_ns: "slack" range for the timer
1175 * @mode: timer mode: absolute (HRTIMER_MODE_ABS) or
1176 * relative (HRTIMER_MODE_REL), and pinned (HRTIMER_MODE_PINNED);
1177 * softirq based mode is considered for debug purpose only!
1179 void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
1180 u64 delta_ns, const enum hrtimer_mode mode)
1182 struct hrtimer_clock_base *base;
1183 unsigned long flags;
1186 * Check whether the HRTIMER_MODE_SOFT bit and hrtimer.is_soft
1187 * match on CONFIG_PREEMPT_RT = n. With PREEMPT_RT check the hard
1188 * expiry mode because unmarked timers are moved to softirq expiry.
1190 if (!IS_ENABLED(CONFIG_PREEMPT_RT))
1191 WARN_ON_ONCE(!(mode & HRTIMER_MODE_SOFT) ^ !timer->is_soft);
1193 WARN_ON_ONCE(!(mode & HRTIMER_MODE_HARD) ^ !timer->is_hard);
1195 base = lock_hrtimer_base(timer, &flags);
1197 if (__hrtimer_start_range_ns(timer, tim, delta_ns, mode, base))
1198 hrtimer_reprogram(timer, true);
1200 unlock_hrtimer_base(timer, &flags);
1202 EXPORT_SYMBOL_GPL(hrtimer_start_range_ns);
1205 * hrtimer_try_to_cancel - try to deactivate a timer
1206 * @timer: hrtimer to stop
1210 * * 0 when the timer was not active
1211 * * 1 when the timer was active
1212 * * -1 when the timer is currently executing the callback function and
1215 int hrtimer_try_to_cancel(struct hrtimer *timer)
1217 struct hrtimer_clock_base *base;
1218 unsigned long flags;
1222 * Check lockless first. If the timer is not active (neither
1223 * enqueued nor running the callback, nothing to do here. The
1224 * base lock does not serialize against a concurrent enqueue,
1225 * so we can avoid taking it.
1227 if (!hrtimer_active(timer))
1230 base = lock_hrtimer_base(timer, &flags);
1232 if (!hrtimer_callback_running(timer))
1233 ret = remove_hrtimer(timer, base, false, false);
1235 unlock_hrtimer_base(timer, &flags);
1240 EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
1242 #ifdef CONFIG_PREEMPT_RT
1243 static void hrtimer_cpu_base_init_expiry_lock(struct hrtimer_cpu_base *base)
1245 spin_lock_init(&base->softirq_expiry_lock);
1248 static void hrtimer_cpu_base_lock_expiry(struct hrtimer_cpu_base *base)
1250 spin_lock(&base->softirq_expiry_lock);
1253 static void hrtimer_cpu_base_unlock_expiry(struct hrtimer_cpu_base *base)
1255 spin_unlock(&base->softirq_expiry_lock);
1259 * The counterpart to hrtimer_cancel_wait_running().
1261 * If there is a waiter for cpu_base->expiry_lock, then it was waiting for
1262 * the timer callback to finish. Drop expiry_lock and reaquire it. That
1263 * allows the waiter to acquire the lock and make progress.
1265 static void hrtimer_sync_wait_running(struct hrtimer_cpu_base *cpu_base,
1266 unsigned long flags)
1268 if (atomic_read(&cpu_base->timer_waiters)) {
1269 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1270 spin_unlock(&cpu_base->softirq_expiry_lock);
1271 spin_lock(&cpu_base->softirq_expiry_lock);
1272 raw_spin_lock_irq(&cpu_base->lock);
1277 * This function is called on PREEMPT_RT kernels when the fast path
1278 * deletion of a timer failed because the timer callback function was
1281 * This prevents priority inversion: if the soft irq thread is preempted
1282 * in the middle of a timer callback, then calling del_timer_sync() can
1283 * lead to two issues:
1285 * - If the caller is on a remote CPU then it has to spin wait for the timer
1286 * handler to complete. This can result in unbound priority inversion.
1288 * - If the caller originates from the task which preempted the timer
1289 * handler on the same CPU, then spin waiting for the timer handler to
1290 * complete is never going to end.
1292 void hrtimer_cancel_wait_running(const struct hrtimer *timer)
1294 /* Lockless read. Prevent the compiler from reloading it below */
1295 struct hrtimer_clock_base *base = READ_ONCE(timer->base);
1298 * Just relax if the timer expires in hard interrupt context or if
1299 * it is currently on the migration base.
1301 if (!timer->is_soft || is_migration_base(base)) {
1307 * Mark the base as contended and grab the expiry lock, which is
1308 * held by the softirq across the timer callback. Drop the lock
1309 * immediately so the softirq can expire the next timer. In theory
1310 * the timer could already be running again, but that's more than
1311 * unlikely and just causes another wait loop.
1313 atomic_inc(&base->cpu_base->timer_waiters);
1314 spin_lock_bh(&base->cpu_base->softirq_expiry_lock);
1315 atomic_dec(&base->cpu_base->timer_waiters);
1316 spin_unlock_bh(&base->cpu_base->softirq_expiry_lock);
1320 hrtimer_cpu_base_init_expiry_lock(struct hrtimer_cpu_base *base) { }
1322 hrtimer_cpu_base_lock_expiry(struct hrtimer_cpu_base *base) { }
1324 hrtimer_cpu_base_unlock_expiry(struct hrtimer_cpu_base *base) { }
1325 static inline void hrtimer_sync_wait_running(struct hrtimer_cpu_base *base,
1326 unsigned long flags) { }
1330 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
1331 * @timer: the timer to be cancelled
1334 * 0 when the timer was not active
1335 * 1 when the timer was active
1337 int hrtimer_cancel(struct hrtimer *timer)
1342 ret = hrtimer_try_to_cancel(timer);
1345 hrtimer_cancel_wait_running(timer);
1349 EXPORT_SYMBOL_GPL(hrtimer_cancel);
1352 * hrtimer_get_remaining - get remaining time for the timer
1353 * @timer: the timer to read
1354 * @adjust: adjust relative timers when CONFIG_TIME_LOW_RES=y
1356 ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust)
1358 unsigned long flags;
1361 lock_hrtimer_base(timer, &flags);
1362 if (IS_ENABLED(CONFIG_TIME_LOW_RES) && adjust)
1363 rem = hrtimer_expires_remaining_adjusted(timer);
1365 rem = hrtimer_expires_remaining(timer);
1366 unlock_hrtimer_base(timer, &flags);
1370 EXPORT_SYMBOL_GPL(__hrtimer_get_remaining);
1372 #ifdef CONFIG_NO_HZ_COMMON
1374 * hrtimer_get_next_event - get the time until next expiry event
1376 * Returns the next expiry time or KTIME_MAX if no timer is pending.
1378 u64 hrtimer_get_next_event(void)
1380 struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
1381 u64 expires = KTIME_MAX;
1382 unsigned long flags;
1384 raw_spin_lock_irqsave(&cpu_base->lock, flags);
1386 if (!__hrtimer_hres_active(cpu_base))
1387 expires = __hrtimer_get_next_event(cpu_base, HRTIMER_ACTIVE_ALL);
1389 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1395 * hrtimer_next_event_without - time until next expiry event w/o one timer
1396 * @exclude: timer to exclude
1398 * Returns the next expiry time over all timers except for the @exclude one or
1399 * KTIME_MAX if none of them is pending.
1401 u64 hrtimer_next_event_without(const struct hrtimer *exclude)
1403 struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
1404 u64 expires = KTIME_MAX;
1405 unsigned long flags;
1407 raw_spin_lock_irqsave(&cpu_base->lock, flags);
1409 if (__hrtimer_hres_active(cpu_base)) {
1410 unsigned int active;
1412 if (!cpu_base->softirq_activated) {
1413 active = cpu_base->active_bases & HRTIMER_ACTIVE_SOFT;
1414 expires = __hrtimer_next_event_base(cpu_base, exclude,
1417 active = cpu_base->active_bases & HRTIMER_ACTIVE_HARD;
1418 expires = __hrtimer_next_event_base(cpu_base, exclude, active,
1422 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1428 static inline int hrtimer_clockid_to_base(clockid_t clock_id)
1430 if (likely(clock_id < MAX_CLOCKS)) {
1431 int base = hrtimer_clock_to_base_table[clock_id];
1433 if (likely(base != HRTIMER_MAX_CLOCK_BASES))
1436 WARN(1, "Invalid clockid %d. Using MONOTONIC\n", clock_id);
1437 return HRTIMER_BASE_MONOTONIC;
1440 static void __hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
1441 enum hrtimer_mode mode)
1443 bool softtimer = !!(mode & HRTIMER_MODE_SOFT);
1444 struct hrtimer_cpu_base *cpu_base;
1448 * On PREEMPT_RT enabled kernels hrtimers which are not explicitely
1449 * marked for hard interrupt expiry mode are moved into soft
1450 * interrupt context for latency reasons and because the callbacks
1451 * can invoke functions which might sleep on RT, e.g. spin_lock().
1453 if (IS_ENABLED(CONFIG_PREEMPT_RT) && !(mode & HRTIMER_MODE_HARD))
1456 memset(timer, 0, sizeof(struct hrtimer));
1458 cpu_base = raw_cpu_ptr(&hrtimer_bases);
1461 * POSIX magic: Relative CLOCK_REALTIME timers are not affected by
1462 * clock modifications, so they needs to become CLOCK_MONOTONIC to
1463 * ensure POSIX compliance.
1465 if (clock_id == CLOCK_REALTIME && mode & HRTIMER_MODE_REL)
1466 clock_id = CLOCK_MONOTONIC;
1468 base = softtimer ? HRTIMER_MAX_CLOCK_BASES / 2 : 0;
1469 base += hrtimer_clockid_to_base(clock_id);
1470 timer->is_soft = softtimer;
1471 timer->is_hard = !!(mode & HRTIMER_MODE_HARD);
1472 timer->base = &cpu_base->clock_base[base];
1473 timerqueue_init(&timer->node);
1477 * hrtimer_init - initialize a timer to the given clock
1478 * @timer: the timer to be initialized
1479 * @clock_id: the clock to be used
1480 * @mode: The modes which are relevant for intitialization:
1481 * HRTIMER_MODE_ABS, HRTIMER_MODE_REL, HRTIMER_MODE_ABS_SOFT,
1482 * HRTIMER_MODE_REL_SOFT
1484 * The PINNED variants of the above can be handed in,
1485 * but the PINNED bit is ignored as pinning happens
1486 * when the hrtimer is started
1488 void hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
1489 enum hrtimer_mode mode)
1491 debug_init(timer, clock_id, mode);
1492 __hrtimer_init(timer, clock_id, mode);
1494 EXPORT_SYMBOL_GPL(hrtimer_init);
1497 * A timer is active, when it is enqueued into the rbtree or the
1498 * callback function is running or it's in the state of being migrated
1501 * It is important for this function to not return a false negative.
1503 bool hrtimer_active(const struct hrtimer *timer)
1505 struct hrtimer_clock_base *base;
1509 base = READ_ONCE(timer->base);
1510 seq = raw_read_seqcount_begin(&base->seq);
1512 if (timer->state != HRTIMER_STATE_INACTIVE ||
1513 base->running == timer)
1516 } while (read_seqcount_retry(&base->seq, seq) ||
1517 base != READ_ONCE(timer->base));
1521 EXPORT_SYMBOL_GPL(hrtimer_active);
1524 * The write_seqcount_barrier()s in __run_hrtimer() split the thing into 3
1525 * distinct sections:
1527 * - queued: the timer is queued
1528 * - callback: the timer is being ran
1529 * - post: the timer is inactive or (re)queued
1531 * On the read side we ensure we observe timer->state and cpu_base->running
1532 * from the same section, if anything changed while we looked at it, we retry.
1533 * This includes timer->base changing because sequence numbers alone are
1534 * insufficient for that.
1536 * The sequence numbers are required because otherwise we could still observe
1537 * a false negative if the read side got smeared over multiple consequtive
1538 * __run_hrtimer() invocations.
1541 static void __run_hrtimer(struct hrtimer_cpu_base *cpu_base,
1542 struct hrtimer_clock_base *base,
1543 struct hrtimer *timer, ktime_t *now,
1544 unsigned long flags) __must_hold(&cpu_base->lock)
1546 enum hrtimer_restart (*fn)(struct hrtimer *);
1547 bool expires_in_hardirq;
1550 lockdep_assert_held(&cpu_base->lock);
1552 debug_deactivate(timer);
1553 base->running = timer;
1556 * Separate the ->running assignment from the ->state assignment.
1558 * As with a regular write barrier, this ensures the read side in
1559 * hrtimer_active() cannot observe base->running == NULL &&
1560 * timer->state == INACTIVE.
1562 raw_write_seqcount_barrier(&base->seq);
1564 __remove_hrtimer(timer, base, HRTIMER_STATE_INACTIVE, 0);
1565 fn = timer->function;
1568 * Clear the 'is relative' flag for the TIME_LOW_RES case. If the
1569 * timer is restarted with a period then it becomes an absolute
1570 * timer. If its not restarted it does not matter.
1572 if (IS_ENABLED(CONFIG_TIME_LOW_RES))
1573 timer->is_rel = false;
1576 * The timer is marked as running in the CPU base, so it is
1577 * protected against migration to a different CPU even if the lock
1580 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1581 trace_hrtimer_expire_entry(timer, now);
1582 expires_in_hardirq = lockdep_hrtimer_enter(timer);
1584 restart = fn(timer);
1586 lockdep_hrtimer_exit(expires_in_hardirq);
1587 trace_hrtimer_expire_exit(timer);
1588 raw_spin_lock_irq(&cpu_base->lock);
1591 * Note: We clear the running state after enqueue_hrtimer and
1592 * we do not reprogram the event hardware. Happens either in
1593 * hrtimer_start_range_ns() or in hrtimer_interrupt()
1595 * Note: Because we dropped the cpu_base->lock above,
1596 * hrtimer_start_range_ns() can have popped in and enqueued the timer
1599 if (restart != HRTIMER_NORESTART &&
1600 !(timer->state & HRTIMER_STATE_ENQUEUED))
1601 enqueue_hrtimer(timer, base, HRTIMER_MODE_ABS);
1604 * Separate the ->running assignment from the ->state assignment.
1606 * As with a regular write barrier, this ensures the read side in
1607 * hrtimer_active() cannot observe base->running.timer == NULL &&
1608 * timer->state == INACTIVE.
1610 raw_write_seqcount_barrier(&base->seq);
1612 WARN_ON_ONCE(base->running != timer);
1613 base->running = NULL;
1616 static void __hrtimer_run_queues(struct hrtimer_cpu_base *cpu_base, ktime_t now,
1617 unsigned long flags, unsigned int active_mask)
1619 struct hrtimer_clock_base *base;
1620 unsigned int active = cpu_base->active_bases & active_mask;
1622 for_each_active_base(base, cpu_base, active) {
1623 struct timerqueue_node *node;
1626 basenow = ktime_add(now, base->offset);
1628 while ((node = timerqueue_getnext(&base->active))) {
1629 struct hrtimer *timer;
1631 timer = container_of(node, struct hrtimer, node);
1634 * The immediate goal for using the softexpires is
1635 * minimizing wakeups, not running timers at the
1636 * earliest interrupt after their soft expiration.
1637 * This allows us to avoid using a Priority Search
1638 * Tree, which can answer a stabbing querry for
1639 * overlapping intervals and instead use the simple
1640 * BST we already have.
1641 * We don't add extra wakeups by delaying timers that
1642 * are right-of a not yet expired timer, because that
1643 * timer will have to trigger a wakeup anyway.
1645 if (basenow < hrtimer_get_softexpires_tv64(timer))
1648 __run_hrtimer(cpu_base, base, timer, &basenow, flags);
1649 if (active_mask == HRTIMER_ACTIVE_SOFT)
1650 hrtimer_sync_wait_running(cpu_base, flags);
1655 static __latent_entropy void hrtimer_run_softirq(struct softirq_action *h)
1657 struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
1658 unsigned long flags;
1661 hrtimer_cpu_base_lock_expiry(cpu_base);
1662 raw_spin_lock_irqsave(&cpu_base->lock, flags);
1664 now = hrtimer_update_base(cpu_base);
1665 __hrtimer_run_queues(cpu_base, now, flags, HRTIMER_ACTIVE_SOFT);
1667 cpu_base->softirq_activated = 0;
1668 hrtimer_update_softirq_timer(cpu_base, true);
1670 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1671 hrtimer_cpu_base_unlock_expiry(cpu_base);
1674 #ifdef CONFIG_HIGH_RES_TIMERS
1677 * High resolution timer interrupt
1678 * Called with interrupts disabled
1680 void hrtimer_interrupt(struct clock_event_device *dev)
1682 struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
1683 ktime_t expires_next, now, entry_time, delta;
1684 unsigned long flags;
1687 BUG_ON(!cpu_base->hres_active);
1688 cpu_base->nr_events++;
1689 dev->next_event = KTIME_MAX;
1691 raw_spin_lock_irqsave(&cpu_base->lock, flags);
1692 entry_time = now = hrtimer_update_base(cpu_base);
1694 cpu_base->in_hrtirq = 1;
1696 * We set expires_next to KTIME_MAX here with cpu_base->lock
1697 * held to prevent that a timer is enqueued in our queue via
1698 * the migration code. This does not affect enqueueing of
1699 * timers which run their callback and need to be requeued on
1702 cpu_base->expires_next = KTIME_MAX;
1704 if (!ktime_before(now, cpu_base->softirq_expires_next)) {
1705 cpu_base->softirq_expires_next = KTIME_MAX;
1706 cpu_base->softirq_activated = 1;
1707 raise_softirq_irqoff(HRTIMER_SOFTIRQ);
1710 __hrtimer_run_queues(cpu_base, now, flags, HRTIMER_ACTIVE_HARD);
1712 /* Reevaluate the clock bases for the [soft] next expiry */
1713 expires_next = hrtimer_update_next_event(cpu_base);
1715 * Store the new expiry value so the migration code can verify
1718 cpu_base->expires_next = expires_next;
1719 cpu_base->in_hrtirq = 0;
1720 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1722 /* Reprogramming necessary ? */
1723 if (!tick_program_event(expires_next, 0)) {
1724 cpu_base->hang_detected = 0;
1729 * The next timer was already expired due to:
1731 * - long lasting callbacks
1732 * - being scheduled away when running in a VM
1734 * We need to prevent that we loop forever in the hrtimer
1735 * interrupt routine. We give it 3 attempts to avoid
1736 * overreacting on some spurious event.
1738 * Acquire base lock for updating the offsets and retrieving
1741 raw_spin_lock_irqsave(&cpu_base->lock, flags);
1742 now = hrtimer_update_base(cpu_base);
1743 cpu_base->nr_retries++;
1747 * Give the system a chance to do something else than looping
1748 * here. We stored the entry time, so we know exactly how long
1749 * we spent here. We schedule the next event this amount of
1752 cpu_base->nr_hangs++;
1753 cpu_base->hang_detected = 1;
1754 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1756 delta = ktime_sub(now, entry_time);
1757 if ((unsigned int)delta > cpu_base->max_hang_time)
1758 cpu_base->max_hang_time = (unsigned int) delta;
1760 * Limit it to a sensible value as we enforce a longer
1761 * delay. Give the CPU at least 100ms to catch up.
1763 if (delta > 100 * NSEC_PER_MSEC)
1764 expires_next = ktime_add_ns(now, 100 * NSEC_PER_MSEC);
1766 expires_next = ktime_add(now, delta);
1767 tick_program_event(expires_next, 1);
1768 pr_warn_once("hrtimer: interrupt took %llu ns\n", ktime_to_ns(delta));
1771 /* called with interrupts disabled */
1772 static inline void __hrtimer_peek_ahead_timers(void)
1774 struct tick_device *td;
1776 if (!hrtimer_hres_active())
1779 td = this_cpu_ptr(&tick_cpu_device);
1780 if (td && td->evtdev)
1781 hrtimer_interrupt(td->evtdev);
1784 #else /* CONFIG_HIGH_RES_TIMERS */
1786 static inline void __hrtimer_peek_ahead_timers(void) { }
1788 #endif /* !CONFIG_HIGH_RES_TIMERS */
1791 * Called from run_local_timers in hardirq context every jiffy
1793 void hrtimer_run_queues(void)
1795 struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
1796 unsigned long flags;
1799 if (__hrtimer_hres_active(cpu_base))
1803 * This _is_ ugly: We have to check periodically, whether we
1804 * can switch to highres and / or nohz mode. The clocksource
1805 * switch happens with xtime_lock held. Notification from
1806 * there only sets the check bit in the tick_oneshot code,
1807 * otherwise we might deadlock vs. xtime_lock.
1809 if (tick_check_oneshot_change(!hrtimer_is_hres_enabled())) {
1810 hrtimer_switch_to_hres();
1814 raw_spin_lock_irqsave(&cpu_base->lock, flags);
1815 now = hrtimer_update_base(cpu_base);
1817 if (!ktime_before(now, cpu_base->softirq_expires_next)) {
1818 cpu_base->softirq_expires_next = KTIME_MAX;
1819 cpu_base->softirq_activated = 1;
1820 raise_softirq_irqoff(HRTIMER_SOFTIRQ);
1823 __hrtimer_run_queues(cpu_base, now, flags, HRTIMER_ACTIVE_HARD);
1824 raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
1828 * Sleep related functions:
1830 static enum hrtimer_restart hrtimer_wakeup(struct hrtimer *timer)
1832 struct hrtimer_sleeper *t =
1833 container_of(timer, struct hrtimer_sleeper, timer);
1834 struct task_struct *task = t->task;
1838 wake_up_process(task);
1840 return HRTIMER_NORESTART;
1844 * hrtimer_sleeper_start_expires - Start a hrtimer sleeper timer
1845 * @sl: sleeper to be started
1846 * @mode: timer mode abs/rel
1848 * Wrapper around hrtimer_start_expires() for hrtimer_sleeper based timers
1849 * to allow PREEMPT_RT to tweak the delivery mode (soft/hardirq context)
1851 void hrtimer_sleeper_start_expires(struct hrtimer_sleeper *sl,
1852 enum hrtimer_mode mode)
1855 * Make the enqueue delivery mode check work on RT. If the sleeper
1856 * was initialized for hard interrupt delivery, force the mode bit.
1857 * This is a special case for hrtimer_sleepers because
1858 * hrtimer_init_sleeper() determines the delivery mode on RT so the
1859 * fiddling with this decision is avoided at the call sites.
1861 if (IS_ENABLED(CONFIG_PREEMPT_RT) && sl->timer.is_hard)
1862 mode |= HRTIMER_MODE_HARD;
1864 hrtimer_start_expires(&sl->timer, mode);
1866 EXPORT_SYMBOL_GPL(hrtimer_sleeper_start_expires);
1868 static void __hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
1869 clockid_t clock_id, enum hrtimer_mode mode)
1872 * On PREEMPT_RT enabled kernels hrtimers which are not explicitely
1873 * marked for hard interrupt expiry mode are moved into soft
1874 * interrupt context either for latency reasons or because the
1875 * hrtimer callback takes regular spinlocks or invokes other
1876 * functions which are not suitable for hard interrupt context on
1879 * The hrtimer_sleeper callback is RT compatible in hard interrupt
1880 * context, but there is a latency concern: Untrusted userspace can
1881 * spawn many threads which arm timers for the same expiry time on
1882 * the same CPU. That causes a latency spike due to the wakeup of
1883 * a gazillion threads.
1885 * OTOH, priviledged real-time user space applications rely on the
1886 * low latency of hard interrupt wakeups. If the current task is in
1887 * a real-time scheduling class, mark the mode for hard interrupt
1890 if (IS_ENABLED(CONFIG_PREEMPT_RT)) {
1891 if (task_is_realtime(current) && !(mode & HRTIMER_MODE_SOFT))
1892 mode |= HRTIMER_MODE_HARD;
1895 __hrtimer_init(&sl->timer, clock_id, mode);
1896 sl->timer.function = hrtimer_wakeup;
1901 * hrtimer_init_sleeper - initialize sleeper to the given clock
1902 * @sl: sleeper to be initialized
1903 * @clock_id: the clock to be used
1904 * @mode: timer mode abs/rel
1906 void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, clockid_t clock_id,
1907 enum hrtimer_mode mode)
1909 debug_init(&sl->timer, clock_id, mode);
1910 __hrtimer_init_sleeper(sl, clock_id, mode);
1913 EXPORT_SYMBOL_GPL(hrtimer_init_sleeper);
1915 int nanosleep_copyout(struct restart_block *restart, struct timespec64 *ts)
1917 switch(restart->nanosleep.type) {
1918 #ifdef CONFIG_COMPAT_32BIT_TIME
1920 if (put_old_timespec32(ts, restart->nanosleep.compat_rmtp))
1925 if (put_timespec64(ts, restart->nanosleep.rmtp))
1931 return -ERESTART_RESTARTBLOCK;
1934 static int __sched do_nanosleep(struct hrtimer_sleeper *t, enum hrtimer_mode mode)
1936 struct restart_block *restart;
1939 set_current_state(TASK_INTERRUPTIBLE);
1940 hrtimer_sleeper_start_expires(t, mode);
1942 if (likely(t->task))
1943 freezable_schedule();
1945 hrtimer_cancel(&t->timer);
1946 mode = HRTIMER_MODE_ABS;
1948 } while (t->task && !signal_pending(current));
1950 __set_current_state(TASK_RUNNING);
1955 restart = ¤t->restart_block;
1956 if (restart->nanosleep.type != TT_NONE) {
1957 ktime_t rem = hrtimer_expires_remaining(&t->timer);
1958 struct timespec64 rmt;
1962 rmt = ktime_to_timespec64(rem);
1964 return nanosleep_copyout(restart, &rmt);
1966 return -ERESTART_RESTARTBLOCK;
1969 static long __sched hrtimer_nanosleep_restart(struct restart_block *restart)
1971 struct hrtimer_sleeper t;
1974 hrtimer_init_sleeper_on_stack(&t, restart->nanosleep.clockid,
1976 hrtimer_set_expires_tv64(&t.timer, restart->nanosleep.expires);
1977 ret = do_nanosleep(&t, HRTIMER_MODE_ABS);
1978 destroy_hrtimer_on_stack(&t.timer);
1982 long hrtimer_nanosleep(ktime_t rqtp, const enum hrtimer_mode mode,
1983 const clockid_t clockid)
1985 struct restart_block *restart;
1986 struct hrtimer_sleeper t;
1990 slack = current->timer_slack_ns;
1991 if (dl_task(current) || rt_task(current))
1994 hrtimer_init_sleeper_on_stack(&t, clockid, mode);
1995 hrtimer_set_expires_range_ns(&t.timer, rqtp, slack);
1996 ret = do_nanosleep(&t, mode);
1997 if (ret != -ERESTART_RESTARTBLOCK)
2000 /* Absolute timers do not update the rmtp value and restart: */
2001 if (mode == HRTIMER_MODE_ABS) {
2002 ret = -ERESTARTNOHAND;
2006 restart = ¤t->restart_block;
2007 restart->nanosleep.clockid = t.timer.base->clockid;
2008 restart->nanosleep.expires = hrtimer_get_expires_tv64(&t.timer);
2009 set_restart_fn(restart, hrtimer_nanosleep_restart);
2011 destroy_hrtimer_on_stack(&t.timer);
2017 SYSCALL_DEFINE2(nanosleep, struct __kernel_timespec __user *, rqtp,
2018 struct __kernel_timespec __user *, rmtp)
2020 struct timespec64 tu;
2022 if (get_timespec64(&tu, rqtp))
2025 if (!timespec64_valid(&tu))
2028 current->restart_block.fn = do_no_restart_syscall;
2029 current->restart_block.nanosleep.type = rmtp ? TT_NATIVE : TT_NONE;
2030 current->restart_block.nanosleep.rmtp = rmtp;
2031 return hrtimer_nanosleep(timespec64_to_ktime(tu), HRTIMER_MODE_REL,
2037 #ifdef CONFIG_COMPAT_32BIT_TIME
2039 SYSCALL_DEFINE2(nanosleep_time32, struct old_timespec32 __user *, rqtp,
2040 struct old_timespec32 __user *, rmtp)
2042 struct timespec64 tu;
2044 if (get_old_timespec32(&tu, rqtp))
2047 if (!timespec64_valid(&tu))
2050 current->restart_block.fn = do_no_restart_syscall;
2051 current->restart_block.nanosleep.type = rmtp ? TT_COMPAT : TT_NONE;
2052 current->restart_block.nanosleep.compat_rmtp = rmtp;
2053 return hrtimer_nanosleep(timespec64_to_ktime(tu), HRTIMER_MODE_REL,
2059 * Functions related to boot-time initialization:
2061 int hrtimers_prepare_cpu(unsigned int cpu)
2063 struct hrtimer_cpu_base *cpu_base = &per_cpu(hrtimer_bases, cpu);
2066 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
2067 struct hrtimer_clock_base *clock_b = &cpu_base->clock_base[i];
2069 clock_b->cpu_base = cpu_base;
2070 seqcount_raw_spinlock_init(&clock_b->seq, &cpu_base->lock);
2071 timerqueue_init_head(&clock_b->active);
2074 cpu_base->cpu = cpu;
2075 cpu_base->active_bases = 0;
2076 cpu_base->hres_active = 0;
2077 cpu_base->hang_detected = 0;
2078 cpu_base->next_timer = NULL;
2079 cpu_base->softirq_next_timer = NULL;
2080 cpu_base->expires_next = KTIME_MAX;
2081 cpu_base->softirq_expires_next = KTIME_MAX;
2082 cpu_base->online = 1;
2083 hrtimer_cpu_base_init_expiry_lock(cpu_base);
2087 #ifdef CONFIG_HOTPLUG_CPU
2089 static void migrate_hrtimer_list(struct hrtimer_clock_base *old_base,
2090 struct hrtimer_clock_base *new_base)
2092 struct hrtimer *timer;
2093 struct timerqueue_node *node;
2095 while ((node = timerqueue_getnext(&old_base->active))) {
2096 timer = container_of(node, struct hrtimer, node);
2097 BUG_ON(hrtimer_callback_running(timer));
2098 debug_deactivate(timer);
2101 * Mark it as ENQUEUED not INACTIVE otherwise the
2102 * timer could be seen as !active and just vanish away
2103 * under us on another CPU
2105 __remove_hrtimer(timer, old_base, HRTIMER_STATE_ENQUEUED, 0);
2106 timer->base = new_base;
2108 * Enqueue the timers on the new cpu. This does not
2109 * reprogram the event device in case the timer
2110 * expires before the earliest on this CPU, but we run
2111 * hrtimer_interrupt after we migrated everything to
2112 * sort out already expired timers and reprogram the
2115 enqueue_hrtimer(timer, new_base, HRTIMER_MODE_ABS);
2119 int hrtimers_cpu_dying(unsigned int dying_cpu)
2121 struct hrtimer_cpu_base *old_base, *new_base;
2122 int i, ncpu = cpumask_first(cpu_active_mask);
2124 tick_cancel_sched_timer(dying_cpu);
2126 old_base = this_cpu_ptr(&hrtimer_bases);
2127 new_base = &per_cpu(hrtimer_bases, ncpu);
2130 * The caller is globally serialized and nobody else
2131 * takes two locks at once, deadlock is not possible.
2133 raw_spin_lock(&old_base->lock);
2134 raw_spin_lock_nested(&new_base->lock, SINGLE_DEPTH_NESTING);
2136 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
2137 migrate_hrtimer_list(&old_base->clock_base[i],
2138 &new_base->clock_base[i]);
2142 * The migration might have changed the first expiring softirq
2143 * timer on this CPU. Update it.
2145 __hrtimer_get_next_event(new_base, HRTIMER_ACTIVE_SOFT);
2146 /* Tell the other CPU to retrigger the next event */
2147 smp_call_function_single(ncpu, retrigger_next_event, NULL, 0);
2149 raw_spin_unlock(&new_base->lock);
2150 old_base->online = 0;
2151 raw_spin_unlock(&old_base->lock);
2156 #endif /* CONFIG_HOTPLUG_CPU */
2158 void __init hrtimers_init(void)
2160 hrtimers_prepare_cpu(smp_processor_id());
2161 open_softirq(HRTIMER_SOFTIRQ, hrtimer_run_softirq);
2165 * schedule_hrtimeout_range_clock - sleep until timeout
2166 * @expires: timeout value (ktime_t)
2167 * @delta: slack in expires timeout (ktime_t) for SCHED_OTHER tasks
2169 * @clock_id: timer clock to be used
2172 schedule_hrtimeout_range_clock(ktime_t *expires, u64 delta,
2173 const enum hrtimer_mode mode, clockid_t clock_id)
2175 struct hrtimer_sleeper t;
2178 * Optimize when a zero timeout value is given. It does not
2179 * matter whether this is an absolute or a relative time.
2181 if (expires && *expires == 0) {
2182 __set_current_state(TASK_RUNNING);
2187 * A NULL parameter means "infinite"
2195 * Override any slack passed by the user if under
2198 if (rt_task(current))
2201 hrtimer_init_sleeper_on_stack(&t, clock_id, mode);
2202 hrtimer_set_expires_range_ns(&t.timer, *expires, delta);
2203 hrtimer_sleeper_start_expires(&t, mode);
2208 hrtimer_cancel(&t.timer);
2209 destroy_hrtimer_on_stack(&t.timer);
2211 __set_current_state(TASK_RUNNING);
2213 return !t.task ? 0 : -EINTR;
2215 EXPORT_SYMBOL_GPL(schedule_hrtimeout_range_clock);
2218 * schedule_hrtimeout_range - sleep until timeout
2219 * @expires: timeout value (ktime_t)
2220 * @delta: slack in expires timeout (ktime_t) for SCHED_OTHER tasks
2223 * Make the current task sleep until the given expiry time has
2224 * elapsed. The routine will return immediately unless
2225 * the current task state has been set (see set_current_state()).
2227 * The @delta argument gives the kernel the freedom to schedule the
2228 * actual wakeup to a time that is both power and performance friendly
2229 * for regular (non RT/DL) tasks.
2230 * The kernel give the normal best effort behavior for "@expires+@delta",
2231 * but may decide to fire the timer earlier, but no earlier than @expires.
2233 * You can set the task state as follows -
2235 * %TASK_UNINTERRUPTIBLE - at least @timeout time is guaranteed to
2236 * pass before the routine returns unless the current task is explicitly
2237 * woken up, (e.g. by wake_up_process()).
2239 * %TASK_INTERRUPTIBLE - the routine may return early if a signal is
2240 * delivered to the current task or the current task is explicitly woken
2243 * The current task state is guaranteed to be TASK_RUNNING when this
2246 * Returns 0 when the timer has expired. If the task was woken before the
2247 * timer expired by a signal (only possible in state TASK_INTERRUPTIBLE) or
2248 * by an explicit wakeup, it returns -EINTR.
2250 int __sched schedule_hrtimeout_range(ktime_t *expires, u64 delta,
2251 const enum hrtimer_mode mode)
2253 return schedule_hrtimeout_range_clock(expires, delta, mode,
2256 EXPORT_SYMBOL_GPL(schedule_hrtimeout_range);
2259 * schedule_hrtimeout - sleep until timeout
2260 * @expires: timeout value (ktime_t)
2263 * Make the current task sleep until the given expiry time has
2264 * elapsed. The routine will return immediately unless
2265 * the current task state has been set (see set_current_state()).
2267 * You can set the task state as follows -
2269 * %TASK_UNINTERRUPTIBLE - at least @timeout time is guaranteed to
2270 * pass before the routine returns unless the current task is explicitly
2271 * woken up, (e.g. by wake_up_process()).
2273 * %TASK_INTERRUPTIBLE - the routine may return early if a signal is
2274 * delivered to the current task or the current task is explicitly woken
2277 * The current task state is guaranteed to be TASK_RUNNING when this
2280 * Returns 0 when the timer has expired. If the task was woken before the
2281 * timer expired by a signal (only possible in state TASK_INTERRUPTIBLE) or
2282 * by an explicit wakeup, it returns -EINTR.
2284 int __sched schedule_hrtimeout(ktime_t *expires,
2285 const enum hrtimer_mode mode)
2287 return schedule_hrtimeout_range(expires, 0, mode);
2289 EXPORT_SYMBOL_GPL(schedule_hrtimeout);