xref: /openbmc/linux/kernel/time/hrtimer.c (revision 2ac2dccce9d16a7b1a8fddf69a955d249375bce4)
15cee9645SThomas Gleixner /*
25cee9645SThomas Gleixner  *  linux/kernel/hrtimer.c
35cee9645SThomas Gleixner  *
45cee9645SThomas Gleixner  *  Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de>
55cee9645SThomas Gleixner  *  Copyright(C) 2005-2007, Red Hat, Inc., Ingo Molnar
65cee9645SThomas Gleixner  *  Copyright(C) 2006-2007  Timesys Corp., Thomas Gleixner
75cee9645SThomas Gleixner  *
85cee9645SThomas Gleixner  *  High-resolution kernel timers
95cee9645SThomas Gleixner  *
105cee9645SThomas Gleixner  *  In contrast to the low-resolution timeout API implemented in
115cee9645SThomas Gleixner  *  kernel/timer.c, hrtimers provide finer resolution and accuracy
125cee9645SThomas Gleixner  *  depending on system configuration and capabilities.
135cee9645SThomas Gleixner  *
145cee9645SThomas Gleixner  *  These timers are currently used for:
155cee9645SThomas Gleixner  *   - itimers
165cee9645SThomas Gleixner  *   - POSIX timers
175cee9645SThomas Gleixner  *   - nanosleep
185cee9645SThomas Gleixner  *   - precise in-kernel timing
195cee9645SThomas Gleixner  *
205cee9645SThomas Gleixner  *  Started by: Thomas Gleixner and Ingo Molnar
215cee9645SThomas Gleixner  *
225cee9645SThomas Gleixner  *  Credits:
235cee9645SThomas Gleixner  *	based on kernel/timer.c
245cee9645SThomas Gleixner  *
255cee9645SThomas Gleixner  *	Help, testing, suggestions, bugfixes, improvements were
265cee9645SThomas Gleixner  *	provided by:
275cee9645SThomas Gleixner  *
285cee9645SThomas Gleixner  *	George Anzinger, Andrew Morton, Steven Rostedt, Roman Zippel
295cee9645SThomas Gleixner  *	et. al.
305cee9645SThomas Gleixner  *
315cee9645SThomas Gleixner  *  For licencing details see kernel-base/COPYING
325cee9645SThomas Gleixner  */
335cee9645SThomas Gleixner 
345cee9645SThomas Gleixner #include <linux/cpu.h>
355cee9645SThomas Gleixner #include <linux/export.h>
365cee9645SThomas Gleixner #include <linux/percpu.h>
375cee9645SThomas Gleixner #include <linux/hrtimer.h>
385cee9645SThomas Gleixner #include <linux/notifier.h>
395cee9645SThomas Gleixner #include <linux/syscalls.h>
405cee9645SThomas Gleixner #include <linux/kallsyms.h>
415cee9645SThomas Gleixner #include <linux/interrupt.h>
425cee9645SThomas Gleixner #include <linux/tick.h>
435cee9645SThomas Gleixner #include <linux/seq_file.h>
445cee9645SThomas Gleixner #include <linux/err.h>
455cee9645SThomas Gleixner #include <linux/debugobjects.h>
46174cd4b1SIngo Molnar #include <linux/sched/signal.h>
475cee9645SThomas Gleixner #include <linux/sched/sysctl.h>
485cee9645SThomas Gleixner #include <linux/sched/rt.h>
495cee9645SThomas Gleixner #include <linux/sched/deadline.h>
50370c9135SIngo Molnar #include <linux/sched/nohz.h>
51b17b0153SIngo Molnar #include <linux/sched/debug.h>
525cee9645SThomas Gleixner #include <linux/timer.h>
535cee9645SThomas Gleixner #include <linux/freezer.h>
54edbeda46SAl Viro #include <linux/compat.h>
555cee9645SThomas Gleixner 
567c0f6ba6SLinus Torvalds #include <linux/uaccess.h>
575cee9645SThomas Gleixner 
585cee9645SThomas Gleixner #include <trace/events/timer.h>
595cee9645SThomas Gleixner 
60c1797bafSThomas Gleixner #include "tick-internal.h"
618b094cd0SThomas Gleixner 
625cee9645SThomas Gleixner /*
635cee9645SThomas Gleixner  * The timer bases:
645cee9645SThomas Gleixner  *
65571af55aSZhen Lei  * There are more clockids than hrtimer bases. Thus, we index
665cee9645SThomas Gleixner  * into the timer bases by the hrtimer_base_type enum. When trying
675cee9645SThomas Gleixner  * to reach a base using a clockid, hrtimer_clockid_to_base()
685cee9645SThomas Gleixner  * is used to convert from clockid to the proper hrtimer_base_type.
695cee9645SThomas Gleixner  */
705cee9645SThomas Gleixner DEFINE_PER_CPU(struct hrtimer_cpu_base, hrtimer_bases) =
715cee9645SThomas Gleixner {
725cee9645SThomas Gleixner 	.lock = __RAW_SPIN_LOCK_UNLOCKED(hrtimer_bases.lock),
735cee9645SThomas Gleixner 	.clock_base =
745cee9645SThomas Gleixner 	{
755cee9645SThomas Gleixner 		{
765cee9645SThomas Gleixner 			.index = HRTIMER_BASE_MONOTONIC,
775cee9645SThomas Gleixner 			.clockid = CLOCK_MONOTONIC,
785cee9645SThomas Gleixner 			.get_time = &ktime_get,
795cee9645SThomas Gleixner 		},
805cee9645SThomas Gleixner 		{
815cee9645SThomas Gleixner 			.index = HRTIMER_BASE_REALTIME,
825cee9645SThomas Gleixner 			.clockid = CLOCK_REALTIME,
835cee9645SThomas Gleixner 			.get_time = &ktime_get_real,
845cee9645SThomas Gleixner 		},
855cee9645SThomas Gleixner 		{
865cee9645SThomas Gleixner 			.index = HRTIMER_BASE_BOOTTIME,
875cee9645SThomas Gleixner 			.clockid = CLOCK_BOOTTIME,
885cee9645SThomas Gleixner 			.get_time = &ktime_get_boottime,
895cee9645SThomas Gleixner 		},
905cee9645SThomas Gleixner 		{
915cee9645SThomas Gleixner 			.index = HRTIMER_BASE_TAI,
925cee9645SThomas Gleixner 			.clockid = CLOCK_TAI,
935cee9645SThomas Gleixner 			.get_time = &ktime_get_clocktai,
945cee9645SThomas Gleixner 		},
955cee9645SThomas Gleixner 	}
965cee9645SThomas Gleixner };
975cee9645SThomas Gleixner 
985cee9645SThomas Gleixner static const int hrtimer_clock_to_base_table[MAX_CLOCKS] = {
99336a9cdeSMarc Zyngier 	/* Make sure we catch unsupported clockids */
100336a9cdeSMarc Zyngier 	[0 ... MAX_CLOCKS - 1]	= HRTIMER_MAX_CLOCK_BASES,
101336a9cdeSMarc Zyngier 
1025cee9645SThomas Gleixner 	[CLOCK_REALTIME]	= HRTIMER_BASE_REALTIME,
1035cee9645SThomas Gleixner 	[CLOCK_MONOTONIC]	= HRTIMER_BASE_MONOTONIC,
1045cee9645SThomas Gleixner 	[CLOCK_BOOTTIME]	= HRTIMER_BASE_BOOTTIME,
1055cee9645SThomas Gleixner 	[CLOCK_TAI]		= HRTIMER_BASE_TAI,
1065cee9645SThomas Gleixner };
1075cee9645SThomas Gleixner 
1085cee9645SThomas Gleixner /*
1095cee9645SThomas Gleixner  * Functions and macros which are different for UP/SMP systems are kept in a
1105cee9645SThomas Gleixner  * single place
1115cee9645SThomas Gleixner  */
1125cee9645SThomas Gleixner #ifdef CONFIG_SMP
1135cee9645SThomas Gleixner 
1145cee9645SThomas Gleixner /*
115887d9dc9SPeter Zijlstra  * We require the migration_base for lock_hrtimer_base()/switch_hrtimer_base()
116887d9dc9SPeter Zijlstra  * such that hrtimer_callback_running() can unconditionally dereference
117887d9dc9SPeter Zijlstra  * timer->base->cpu_base
118887d9dc9SPeter Zijlstra  */
119887d9dc9SPeter Zijlstra static struct hrtimer_cpu_base migration_cpu_base = {
120887d9dc9SPeter Zijlstra 	.clock_base = { { .cpu_base = &migration_cpu_base, }, },
121887d9dc9SPeter Zijlstra };
122887d9dc9SPeter Zijlstra 
123887d9dc9SPeter Zijlstra #define migration_base	migration_cpu_base.clock_base[0]
124887d9dc9SPeter Zijlstra 
125887d9dc9SPeter Zijlstra /*
1265cee9645SThomas Gleixner  * We are using hashed locking: holding per_cpu(hrtimer_bases)[n].lock
1275cee9645SThomas Gleixner  * means that all timers which are tied to this base via timer->base are
1285cee9645SThomas Gleixner  * locked, and the base itself is locked too.
1295cee9645SThomas Gleixner  *
1305cee9645SThomas Gleixner  * So __run_timers/migrate_timers can safely modify all timers which could
1315cee9645SThomas Gleixner  * be found on the lists/queues.
1325cee9645SThomas Gleixner  *
1335cee9645SThomas Gleixner  * When the timer's base is locked, and the timer removed from list, it is
134887d9dc9SPeter Zijlstra  * possible to set timer->base = &migration_base and drop the lock: the timer
135887d9dc9SPeter Zijlstra  * remains locked.
1365cee9645SThomas Gleixner  */
1375cee9645SThomas Gleixner static
1385cee9645SThomas Gleixner struct hrtimer_clock_base *lock_hrtimer_base(const struct hrtimer *timer,
1395cee9645SThomas Gleixner 					     unsigned long *flags)
1405cee9645SThomas Gleixner {
1415cee9645SThomas Gleixner 	struct hrtimer_clock_base *base;
1425cee9645SThomas Gleixner 
1435cee9645SThomas Gleixner 	for (;;) {
1445cee9645SThomas Gleixner 		base = timer->base;
145887d9dc9SPeter Zijlstra 		if (likely(base != &migration_base)) {
1465cee9645SThomas Gleixner 			raw_spin_lock_irqsave(&base->cpu_base->lock, *flags);
1475cee9645SThomas Gleixner 			if (likely(base == timer->base))
1485cee9645SThomas Gleixner 				return base;
1495cee9645SThomas Gleixner 			/* The timer has migrated to another CPU: */
1505cee9645SThomas Gleixner 			raw_spin_unlock_irqrestore(&base->cpu_base->lock, *flags);
1515cee9645SThomas Gleixner 		}
1525cee9645SThomas Gleixner 		cpu_relax();
1535cee9645SThomas Gleixner 	}
1545cee9645SThomas Gleixner }
1555cee9645SThomas Gleixner 
1565cee9645SThomas Gleixner /*
15707a9a7eaSAnna-Maria Gleixner  * We do not migrate the timer when it is expiring before the next
15807a9a7eaSAnna-Maria Gleixner  * event on the target cpu. When high resolution is enabled, we cannot
15907a9a7eaSAnna-Maria Gleixner  * reprogram the target cpu hardware and we would cause it to fire
16007a9a7eaSAnna-Maria Gleixner  * late. To keep it simple, we handle the high resolution enabled and
16107a9a7eaSAnna-Maria Gleixner  * disabled case similar.
1625cee9645SThomas Gleixner  *
1635cee9645SThomas Gleixner  * Called with cpu_base->lock of target cpu held.
1645cee9645SThomas Gleixner  */
1655cee9645SThomas Gleixner static int
1665cee9645SThomas Gleixner hrtimer_check_target(struct hrtimer *timer, struct hrtimer_clock_base *new_base)
1675cee9645SThomas Gleixner {
1685cee9645SThomas Gleixner 	ktime_t expires;
1695cee9645SThomas Gleixner 
1705cee9645SThomas Gleixner 	expires = ktime_sub(hrtimer_get_expires(timer), new_base->offset);
171*2ac2dcccSAnna-Maria Gleixner 	return expires < new_base->cpu_base->expires_next;
1725cee9645SThomas Gleixner }
1735cee9645SThomas Gleixner 
174bc7a34b8SThomas Gleixner static inline
175bc7a34b8SThomas Gleixner struct hrtimer_cpu_base *get_target_base(struct hrtimer_cpu_base *base,
176bc7a34b8SThomas Gleixner 					 int pinned)
177bc7a34b8SThomas Gleixner {
178ae67badaSThomas Gleixner #if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON)
179ae67badaSThomas Gleixner 	if (static_branch_likely(&timers_migration_enabled) && !pinned)
180bc7a34b8SThomas Gleixner 		return &per_cpu(hrtimer_bases, get_nohz_timer_target());
181ae67badaSThomas Gleixner #endif
182662b3e19SFrederic Weisbecker 	return base;
183bc7a34b8SThomas Gleixner }
184bc7a34b8SThomas Gleixner 
1855cee9645SThomas Gleixner /*
186b48362d8SFrederic Weisbecker  * We switch the timer base to a power-optimized selected CPU target,
187b48362d8SFrederic Weisbecker  * if:
188b48362d8SFrederic Weisbecker  *	- NO_HZ_COMMON is enabled
189b48362d8SFrederic Weisbecker  *	- timer migration is enabled
190b48362d8SFrederic Weisbecker  *	- the timer callback is not running
191b48362d8SFrederic Weisbecker  *	- the timer is not the first expiring timer on the new target
192b48362d8SFrederic Weisbecker  *
193b48362d8SFrederic Weisbecker  * If one of the above requirements is not fulfilled we move the timer
194b48362d8SFrederic Weisbecker  * to the current CPU or leave it on the previously assigned CPU if
195b48362d8SFrederic Weisbecker  * the timer callback is currently running.
1965cee9645SThomas Gleixner  */
1975cee9645SThomas Gleixner static inline struct hrtimer_clock_base *
1985cee9645SThomas Gleixner switch_hrtimer_base(struct hrtimer *timer, struct hrtimer_clock_base *base,
1995cee9645SThomas Gleixner 		    int pinned)
2005cee9645SThomas Gleixner {
201b48362d8SFrederic Weisbecker 	struct hrtimer_cpu_base *new_cpu_base, *this_cpu_base;
2025cee9645SThomas Gleixner 	struct hrtimer_clock_base *new_base;
2035cee9645SThomas Gleixner 	int basenum = base->index;
2045cee9645SThomas Gleixner 
205b48362d8SFrederic Weisbecker 	this_cpu_base = this_cpu_ptr(&hrtimer_bases);
206b48362d8SFrederic Weisbecker 	new_cpu_base = get_target_base(this_cpu_base, pinned);
2075cee9645SThomas Gleixner again:
2085cee9645SThomas Gleixner 	new_base = &new_cpu_base->clock_base[basenum];
2095cee9645SThomas Gleixner 
2105cee9645SThomas Gleixner 	if (base != new_base) {
2115cee9645SThomas Gleixner 		/*
2125cee9645SThomas Gleixner 		 * We are trying to move timer to new_base.
2135cee9645SThomas Gleixner 		 * However we can't change timer's base while it is running,
2145cee9645SThomas Gleixner 		 * so we keep it on the same CPU. No hassle vs. reprogramming
2155cee9645SThomas Gleixner 		 * the event source in the high resolution case. The softirq
2165cee9645SThomas Gleixner 		 * code will take care of this when the timer function has
2175cee9645SThomas Gleixner 		 * completed. There is no conflict as we hold the lock until
2185cee9645SThomas Gleixner 		 * the timer is enqueued.
2195cee9645SThomas Gleixner 		 */
2205cee9645SThomas Gleixner 		if (unlikely(hrtimer_callback_running(timer)))
2215cee9645SThomas Gleixner 			return base;
2225cee9645SThomas Gleixner 
223887d9dc9SPeter Zijlstra 		/* See the comment in lock_hrtimer_base() */
224887d9dc9SPeter Zijlstra 		timer->base = &migration_base;
2255cee9645SThomas Gleixner 		raw_spin_unlock(&base->cpu_base->lock);
2265cee9645SThomas Gleixner 		raw_spin_lock(&new_base->cpu_base->lock);
2275cee9645SThomas Gleixner 
228b48362d8SFrederic Weisbecker 		if (new_cpu_base != this_cpu_base &&
229bc7a34b8SThomas Gleixner 		    hrtimer_check_target(timer, new_base)) {
2305cee9645SThomas Gleixner 			raw_spin_unlock(&new_base->cpu_base->lock);
2315cee9645SThomas Gleixner 			raw_spin_lock(&base->cpu_base->lock);
232b48362d8SFrederic Weisbecker 			new_cpu_base = this_cpu_base;
2335cee9645SThomas Gleixner 			timer->base = base;
2345cee9645SThomas Gleixner 			goto again;
2355cee9645SThomas Gleixner 		}
2365cee9645SThomas Gleixner 		timer->base = new_base;
2375cee9645SThomas Gleixner 	} else {
238b48362d8SFrederic Weisbecker 		if (new_cpu_base != this_cpu_base &&
239bc7a34b8SThomas Gleixner 		    hrtimer_check_target(timer, new_base)) {
240b48362d8SFrederic Weisbecker 			new_cpu_base = this_cpu_base;
2415cee9645SThomas Gleixner 			goto again;
2425cee9645SThomas Gleixner 		}
2435cee9645SThomas Gleixner 	}
2445cee9645SThomas Gleixner 	return new_base;
2455cee9645SThomas Gleixner }
2465cee9645SThomas Gleixner 
2475cee9645SThomas Gleixner #else /* CONFIG_SMP */
2485cee9645SThomas Gleixner 
2495cee9645SThomas Gleixner static inline struct hrtimer_clock_base *
2505cee9645SThomas Gleixner lock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
2515cee9645SThomas Gleixner {
2525cee9645SThomas Gleixner 	struct hrtimer_clock_base *base = timer->base;
2535cee9645SThomas Gleixner 
2545cee9645SThomas Gleixner 	raw_spin_lock_irqsave(&base->cpu_base->lock, *flags);
2555cee9645SThomas Gleixner 
2565cee9645SThomas Gleixner 	return base;
2575cee9645SThomas Gleixner }
2585cee9645SThomas Gleixner 
2595cee9645SThomas Gleixner # define switch_hrtimer_base(t, b, p)	(b)
2605cee9645SThomas Gleixner 
2615cee9645SThomas Gleixner #endif	/* !CONFIG_SMP */
2625cee9645SThomas Gleixner 
2635cee9645SThomas Gleixner /*
2645cee9645SThomas Gleixner  * Functions for the union type storage format of ktime_t which are
2655cee9645SThomas Gleixner  * too large for inlining:
2665cee9645SThomas Gleixner  */
2675cee9645SThomas Gleixner #if BITS_PER_LONG < 64
2685cee9645SThomas Gleixner /*
2695cee9645SThomas Gleixner  * Divide a ktime value by a nanosecond value
2705cee9645SThomas Gleixner  */
271f7bcb70eSJohn Stultz s64 __ktime_divns(const ktime_t kt, s64 div)
2725cee9645SThomas Gleixner {
2735cee9645SThomas Gleixner 	int sft = 0;
274f7bcb70eSJohn Stultz 	s64 dclc;
275f7bcb70eSJohn Stultz 	u64 tmp;
2765cee9645SThomas Gleixner 
2775cee9645SThomas Gleixner 	dclc = ktime_to_ns(kt);
278f7bcb70eSJohn Stultz 	tmp = dclc < 0 ? -dclc : dclc;
279f7bcb70eSJohn Stultz 
2805cee9645SThomas Gleixner 	/* Make sure the divisor is less than 2^32: */
2815cee9645SThomas Gleixner 	while (div >> 32) {
2825cee9645SThomas Gleixner 		sft++;
2835cee9645SThomas Gleixner 		div >>= 1;
2845cee9645SThomas Gleixner 	}
285f7bcb70eSJohn Stultz 	tmp >>= sft;
286f7bcb70eSJohn Stultz 	do_div(tmp, (unsigned long) div);
287f7bcb70eSJohn Stultz 	return dclc < 0 ? -tmp : tmp;
2885cee9645SThomas Gleixner }
2898b618628SNicolas Pitre EXPORT_SYMBOL_GPL(__ktime_divns);
2905cee9645SThomas Gleixner #endif /* BITS_PER_LONG >= 64 */
2915cee9645SThomas Gleixner 
2925cee9645SThomas Gleixner /*
2935cee9645SThomas Gleixner  * Add two ktime values and do a safety check for overflow:
2945cee9645SThomas Gleixner  */
2955cee9645SThomas Gleixner ktime_t ktime_add_safe(const ktime_t lhs, const ktime_t rhs)
2965cee9645SThomas Gleixner {
297979515c5SVegard Nossum 	ktime_t res = ktime_add_unsafe(lhs, rhs);
2985cee9645SThomas Gleixner 
2995cee9645SThomas Gleixner 	/*
3005cee9645SThomas Gleixner 	 * We use KTIME_SEC_MAX here, the maximum timeout which we can
3015cee9645SThomas Gleixner 	 * return to user space in a timespec:
3025cee9645SThomas Gleixner 	 */
3032456e855SThomas Gleixner 	if (res < 0 || res < lhs || res < rhs)
3045cee9645SThomas Gleixner 		res = ktime_set(KTIME_SEC_MAX, 0);
3055cee9645SThomas Gleixner 
3065cee9645SThomas Gleixner 	return res;
3075cee9645SThomas Gleixner }
3085cee9645SThomas Gleixner 
3095cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(ktime_add_safe);
3105cee9645SThomas Gleixner 
3115cee9645SThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
3125cee9645SThomas Gleixner 
3135cee9645SThomas Gleixner static struct debug_obj_descr hrtimer_debug_descr;
3145cee9645SThomas Gleixner 
3155cee9645SThomas Gleixner static void *hrtimer_debug_hint(void *addr)
3165cee9645SThomas Gleixner {
3175cee9645SThomas Gleixner 	return ((struct hrtimer *) addr)->function;
3185cee9645SThomas Gleixner }
3195cee9645SThomas Gleixner 
3205cee9645SThomas Gleixner /*
3215cee9645SThomas Gleixner  * fixup_init is called when:
3225cee9645SThomas Gleixner  * - an active object is initialized
3235cee9645SThomas Gleixner  */
324e3252464SDu, Changbin static bool hrtimer_fixup_init(void *addr, enum debug_obj_state state)
3255cee9645SThomas Gleixner {
3265cee9645SThomas Gleixner 	struct hrtimer *timer = addr;
3275cee9645SThomas Gleixner 
3285cee9645SThomas Gleixner 	switch (state) {
3295cee9645SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
3305cee9645SThomas Gleixner 		hrtimer_cancel(timer);
3315cee9645SThomas Gleixner 		debug_object_init(timer, &hrtimer_debug_descr);
332e3252464SDu, Changbin 		return true;
3335cee9645SThomas Gleixner 	default:
334e3252464SDu, Changbin 		return false;
3355cee9645SThomas Gleixner 	}
3365cee9645SThomas Gleixner }
3375cee9645SThomas Gleixner 
3385cee9645SThomas Gleixner /*
3395cee9645SThomas Gleixner  * fixup_activate is called when:
3405cee9645SThomas Gleixner  * - an active object is activated
341b9fdac7fSDu, Changbin  * - an unknown non-static object is activated
3425cee9645SThomas Gleixner  */
343e3252464SDu, Changbin static bool hrtimer_fixup_activate(void *addr, enum debug_obj_state state)
3445cee9645SThomas Gleixner {
3455cee9645SThomas Gleixner 	switch (state) {
3465cee9645SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
3475cee9645SThomas Gleixner 		WARN_ON(1);
3485cee9645SThomas Gleixner 
3495cee9645SThomas Gleixner 	default:
350e3252464SDu, Changbin 		return false;
3515cee9645SThomas Gleixner 	}
3525cee9645SThomas Gleixner }
3535cee9645SThomas Gleixner 
3545cee9645SThomas Gleixner /*
3555cee9645SThomas Gleixner  * fixup_free is called when:
3565cee9645SThomas Gleixner  * - an active object is freed
3575cee9645SThomas Gleixner  */
358e3252464SDu, Changbin static bool hrtimer_fixup_free(void *addr, enum debug_obj_state state)
3595cee9645SThomas Gleixner {
3605cee9645SThomas Gleixner 	struct hrtimer *timer = addr;
3615cee9645SThomas Gleixner 
3625cee9645SThomas Gleixner 	switch (state) {
3635cee9645SThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
3645cee9645SThomas Gleixner 		hrtimer_cancel(timer);
3655cee9645SThomas Gleixner 		debug_object_free(timer, &hrtimer_debug_descr);
366e3252464SDu, Changbin 		return true;
3675cee9645SThomas Gleixner 	default:
368e3252464SDu, Changbin 		return false;
3695cee9645SThomas Gleixner 	}
3705cee9645SThomas Gleixner }
3715cee9645SThomas Gleixner 
3725cee9645SThomas Gleixner static struct debug_obj_descr hrtimer_debug_descr = {
3735cee9645SThomas Gleixner 	.name		= "hrtimer",
3745cee9645SThomas Gleixner 	.debug_hint	= hrtimer_debug_hint,
3755cee9645SThomas Gleixner 	.fixup_init	= hrtimer_fixup_init,
3765cee9645SThomas Gleixner 	.fixup_activate	= hrtimer_fixup_activate,
3775cee9645SThomas Gleixner 	.fixup_free	= hrtimer_fixup_free,
3785cee9645SThomas Gleixner };
3795cee9645SThomas Gleixner 
3805cee9645SThomas Gleixner static inline void debug_hrtimer_init(struct hrtimer *timer)
3815cee9645SThomas Gleixner {
3825cee9645SThomas Gleixner 	debug_object_init(timer, &hrtimer_debug_descr);
3835cee9645SThomas Gleixner }
3845cee9645SThomas Gleixner 
3855cee9645SThomas Gleixner static inline void debug_hrtimer_activate(struct hrtimer *timer)
3865cee9645SThomas Gleixner {
3875cee9645SThomas Gleixner 	debug_object_activate(timer, &hrtimer_debug_descr);
3885cee9645SThomas Gleixner }
3895cee9645SThomas Gleixner 
3905cee9645SThomas Gleixner static inline void debug_hrtimer_deactivate(struct hrtimer *timer)
3915cee9645SThomas Gleixner {
3925cee9645SThomas Gleixner 	debug_object_deactivate(timer, &hrtimer_debug_descr);
3935cee9645SThomas Gleixner }
3945cee9645SThomas Gleixner 
3955cee9645SThomas Gleixner static inline void debug_hrtimer_free(struct hrtimer *timer)
3965cee9645SThomas Gleixner {
3975cee9645SThomas Gleixner 	debug_object_free(timer, &hrtimer_debug_descr);
3985cee9645SThomas Gleixner }
3995cee9645SThomas Gleixner 
4005cee9645SThomas Gleixner static void __hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
4015cee9645SThomas Gleixner 			   enum hrtimer_mode mode);
4025cee9645SThomas Gleixner 
4035cee9645SThomas Gleixner void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t clock_id,
4045cee9645SThomas Gleixner 			   enum hrtimer_mode mode)
4055cee9645SThomas Gleixner {
4065cee9645SThomas Gleixner 	debug_object_init_on_stack(timer, &hrtimer_debug_descr);
4075cee9645SThomas Gleixner 	__hrtimer_init(timer, clock_id, mode);
4085cee9645SThomas Gleixner }
4095cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(hrtimer_init_on_stack);
4105cee9645SThomas Gleixner 
4115cee9645SThomas Gleixner void destroy_hrtimer_on_stack(struct hrtimer *timer)
4125cee9645SThomas Gleixner {
4135cee9645SThomas Gleixner 	debug_object_free(timer, &hrtimer_debug_descr);
4145cee9645SThomas Gleixner }
415c08376acSGuenter Roeck EXPORT_SYMBOL_GPL(destroy_hrtimer_on_stack);
4165cee9645SThomas Gleixner 
4175cee9645SThomas Gleixner #else
4185cee9645SThomas Gleixner static inline void debug_hrtimer_init(struct hrtimer *timer) { }
4195cee9645SThomas Gleixner static inline void debug_hrtimer_activate(struct hrtimer *timer) { }
4205cee9645SThomas Gleixner static inline void debug_hrtimer_deactivate(struct hrtimer *timer) { }
4215cee9645SThomas Gleixner #endif
4225cee9645SThomas Gleixner 
4235cee9645SThomas Gleixner static inline void
4245cee9645SThomas Gleixner debug_init(struct hrtimer *timer, clockid_t clockid,
4255cee9645SThomas Gleixner 	   enum hrtimer_mode mode)
4265cee9645SThomas Gleixner {
4275cee9645SThomas Gleixner 	debug_hrtimer_init(timer);
4285cee9645SThomas Gleixner 	trace_hrtimer_init(timer, clockid, mode);
4295cee9645SThomas Gleixner }
4305cee9645SThomas Gleixner 
43163e2ed36SAnna-Maria Gleixner static inline void debug_activate(struct hrtimer *timer,
43263e2ed36SAnna-Maria Gleixner 				  enum hrtimer_mode mode)
4335cee9645SThomas Gleixner {
4345cee9645SThomas Gleixner 	debug_hrtimer_activate(timer);
43563e2ed36SAnna-Maria Gleixner 	trace_hrtimer_start(timer, mode);
4365cee9645SThomas Gleixner }
4375cee9645SThomas Gleixner 
4385cee9645SThomas Gleixner static inline void debug_deactivate(struct hrtimer *timer)
4395cee9645SThomas Gleixner {
4405cee9645SThomas Gleixner 	debug_hrtimer_deactivate(timer);
4415cee9645SThomas Gleixner 	trace_hrtimer_cancel(timer);
4425cee9645SThomas Gleixner }
4435cee9645SThomas Gleixner 
444c272ca58SAnna-Maria Gleixner static struct hrtimer_clock_base *
445c272ca58SAnna-Maria Gleixner __next_base(struct hrtimer_cpu_base *cpu_base, unsigned int *active)
446c272ca58SAnna-Maria Gleixner {
447c272ca58SAnna-Maria Gleixner 	unsigned int idx;
448c272ca58SAnna-Maria Gleixner 
449c272ca58SAnna-Maria Gleixner 	if (!*active)
450c272ca58SAnna-Maria Gleixner 		return NULL;
451c272ca58SAnna-Maria Gleixner 
452c272ca58SAnna-Maria Gleixner 	idx = __ffs(*active);
453c272ca58SAnna-Maria Gleixner 	*active &= ~(1U << idx);
454c272ca58SAnna-Maria Gleixner 
455c272ca58SAnna-Maria Gleixner 	return &cpu_base->clock_base[idx];
456c272ca58SAnna-Maria Gleixner }
457c272ca58SAnna-Maria Gleixner 
458c272ca58SAnna-Maria Gleixner #define for_each_active_base(base, cpu_base, active)	\
459c272ca58SAnna-Maria Gleixner 	while ((base = __next_base((cpu_base), &(active))))
460c272ca58SAnna-Maria Gleixner 
4614ebbda52Skbuild test robot static ktime_t __hrtimer_get_next_event(struct hrtimer_cpu_base *cpu_base)
4629bc74919SThomas Gleixner {
463c272ca58SAnna-Maria Gleixner 	struct hrtimer_clock_base *base;
46434aee88aSThomas Gleixner 	unsigned int active = cpu_base->active_bases;
4652456e855SThomas Gleixner 	ktime_t expires, expires_next = KTIME_MAX;
4669bc74919SThomas Gleixner 
467eb27926bSAnna-Maria Gleixner 	cpu_base->next_timer = NULL;
468c272ca58SAnna-Maria Gleixner 	for_each_active_base(base, cpu_base, active) {
4699bc74919SThomas Gleixner 		struct timerqueue_node *next;
4709bc74919SThomas Gleixner 		struct hrtimer *timer;
4719bc74919SThomas Gleixner 
47234aee88aSThomas Gleixner 		next = timerqueue_getnext(&base->active);
4739bc74919SThomas Gleixner 		timer = container_of(next, struct hrtimer, node);
4749bc74919SThomas Gleixner 		expires = ktime_sub(hrtimer_get_expires(timer), base->offset);
4752456e855SThomas Gleixner 		if (expires < expires_next) {
4769bc74919SThomas Gleixner 			expires_next = expires;
477eb27926bSAnna-Maria Gleixner 			cpu_base->next_timer = timer;
478895bdfa7SThomas Gleixner 		}
4799bc74919SThomas Gleixner 	}
4809bc74919SThomas Gleixner 	/*
4819bc74919SThomas Gleixner 	 * clock_was_set() might have changed base->offset of any of
4829bc74919SThomas Gleixner 	 * the clock bases so the result might be negative. Fix it up
4839bc74919SThomas Gleixner 	 * to prevent a false positive in clockevents_program_event().
4849bc74919SThomas Gleixner 	 */
4852456e855SThomas Gleixner 	if (expires_next < 0)
4862456e855SThomas Gleixner 		expires_next = 0;
4879bc74919SThomas Gleixner 	return expires_next;
4889bc74919SThomas Gleixner }
4899bc74919SThomas Gleixner 
49021d6d52aSThomas Gleixner static inline ktime_t hrtimer_update_base(struct hrtimer_cpu_base *base)
49121d6d52aSThomas Gleixner {
49221d6d52aSThomas Gleixner 	ktime_t *offs_real = &base->clock_base[HRTIMER_BASE_REALTIME].offset;
49321d6d52aSThomas Gleixner 	ktime_t *offs_boot = &base->clock_base[HRTIMER_BASE_BOOTTIME].offset;
49421d6d52aSThomas Gleixner 	ktime_t *offs_tai = &base->clock_base[HRTIMER_BASE_TAI].offset;
49521d6d52aSThomas Gleixner 
496868a3e91SThomas Gleixner 	return ktime_get_update_offsets_now(&base->clock_was_set_seq,
497868a3e91SThomas Gleixner 					    offs_real, offs_boot, offs_tai);
49821d6d52aSThomas Gleixner }
49921d6d52aSThomas Gleixner 
50028bfd18bSAnna-Maria Gleixner /*
50128bfd18bSAnna-Maria Gleixner  * Is the high resolution mode active ?
50228bfd18bSAnna-Maria Gleixner  */
50328bfd18bSAnna-Maria Gleixner static inline int __hrtimer_hres_active(struct hrtimer_cpu_base *cpu_base)
50428bfd18bSAnna-Maria Gleixner {
50528bfd18bSAnna-Maria Gleixner 	return IS_ENABLED(CONFIG_HIGH_RES_TIMERS) ?
50628bfd18bSAnna-Maria Gleixner 		cpu_base->hres_active : 0;
50728bfd18bSAnna-Maria Gleixner }
50828bfd18bSAnna-Maria Gleixner 
50928bfd18bSAnna-Maria Gleixner static inline int hrtimer_hres_active(void)
51028bfd18bSAnna-Maria Gleixner {
51128bfd18bSAnna-Maria Gleixner 	return __hrtimer_hres_active(this_cpu_ptr(&hrtimer_bases));
51228bfd18bSAnna-Maria Gleixner }
51328bfd18bSAnna-Maria Gleixner 
5145cee9645SThomas Gleixner /*
5155cee9645SThomas Gleixner  * Reprogram the event source with checking both queues for the
5165cee9645SThomas Gleixner  * next event
5175cee9645SThomas Gleixner  * Called with interrupts disabled and base->lock held
5185cee9645SThomas Gleixner  */
5195cee9645SThomas Gleixner static void
5205cee9645SThomas Gleixner hrtimer_force_reprogram(struct hrtimer_cpu_base *cpu_base, int skip_equal)
5215cee9645SThomas Gleixner {
52221d6d52aSThomas Gleixner 	ktime_t expires_next;
52321d6d52aSThomas Gleixner 
52421d6d52aSThomas Gleixner 	expires_next = __hrtimer_get_next_event(cpu_base);
5255cee9645SThomas Gleixner 
5262456e855SThomas Gleixner 	if (skip_equal && expires_next == cpu_base->expires_next)
5275cee9645SThomas Gleixner 		return;
5285cee9645SThomas Gleixner 
5292456e855SThomas Gleixner 	cpu_base->expires_next = expires_next;
5305cee9645SThomas Gleixner 
5315cee9645SThomas Gleixner 	/*
53261bb4bcbSAnna-Maria Gleixner 	 * If hres is not active, hardware does not have to be
53361bb4bcbSAnna-Maria Gleixner 	 * reprogrammed yet.
53461bb4bcbSAnna-Maria Gleixner 	 *
5355cee9645SThomas Gleixner 	 * If a hang was detected in the last timer interrupt then we
5365cee9645SThomas Gleixner 	 * leave the hang delay active in the hardware. We want the
5375cee9645SThomas Gleixner 	 * system to make progress. That also prevents the following
5385cee9645SThomas Gleixner 	 * scenario:
5395cee9645SThomas Gleixner 	 * T1 expires 50ms from now
5405cee9645SThomas Gleixner 	 * T2 expires 5s from now
5415cee9645SThomas Gleixner 	 *
5425cee9645SThomas Gleixner 	 * T1 is removed, so this code is called and would reprogram
5435cee9645SThomas Gleixner 	 * the hardware to 5s from now. Any hrtimer_start after that
5445cee9645SThomas Gleixner 	 * will not reprogram the hardware due to hang_detected being
5455cee9645SThomas Gleixner 	 * set. So we'd effectivly block all timers until the T2 event
5465cee9645SThomas Gleixner 	 * fires.
5475cee9645SThomas Gleixner 	 */
54861bb4bcbSAnna-Maria Gleixner 	if (!__hrtimer_hres_active(cpu_base) || cpu_base->hang_detected)
5495cee9645SThomas Gleixner 		return;
5505cee9645SThomas Gleixner 
5515cee9645SThomas Gleixner 	tick_program_event(cpu_base->expires_next, 1);
5525cee9645SThomas Gleixner }
5535cee9645SThomas Gleixner 
554ebba2c72SAnna-Maria Gleixner /* High resolution timer related functions */
555ebba2c72SAnna-Maria Gleixner #ifdef CONFIG_HIGH_RES_TIMERS
556ebba2c72SAnna-Maria Gleixner 
557ebba2c72SAnna-Maria Gleixner /*
558ebba2c72SAnna-Maria Gleixner  * High resolution timer enabled ?
559ebba2c72SAnna-Maria Gleixner  */
560ebba2c72SAnna-Maria Gleixner static bool hrtimer_hres_enabled __read_mostly  = true;
561ebba2c72SAnna-Maria Gleixner unsigned int hrtimer_resolution __read_mostly = LOW_RES_NSEC;
562ebba2c72SAnna-Maria Gleixner EXPORT_SYMBOL_GPL(hrtimer_resolution);
563ebba2c72SAnna-Maria Gleixner 
564ebba2c72SAnna-Maria Gleixner /*
565ebba2c72SAnna-Maria Gleixner  * Enable / Disable high resolution mode
566ebba2c72SAnna-Maria Gleixner  */
567ebba2c72SAnna-Maria Gleixner static int __init setup_hrtimer_hres(char *str)
568ebba2c72SAnna-Maria Gleixner {
569ebba2c72SAnna-Maria Gleixner 	return (kstrtobool(str, &hrtimer_hres_enabled) == 0);
570ebba2c72SAnna-Maria Gleixner }
571ebba2c72SAnna-Maria Gleixner 
572ebba2c72SAnna-Maria Gleixner __setup("highres=", setup_hrtimer_hres);
573ebba2c72SAnna-Maria Gleixner 
574ebba2c72SAnna-Maria Gleixner /*
575ebba2c72SAnna-Maria Gleixner  * hrtimer_high_res_enabled - query, if the highres mode is enabled
576ebba2c72SAnna-Maria Gleixner  */
577ebba2c72SAnna-Maria Gleixner static inline int hrtimer_is_hres_enabled(void)
578ebba2c72SAnna-Maria Gleixner {
579ebba2c72SAnna-Maria Gleixner 	return hrtimer_hres_enabled;
580ebba2c72SAnna-Maria Gleixner }
581ebba2c72SAnna-Maria Gleixner 
5825cee9645SThomas Gleixner /*
58311a9fe06SAnna-Maria Gleixner  * Retrigger next event is called after clock was set
58411a9fe06SAnna-Maria Gleixner  *
58511a9fe06SAnna-Maria Gleixner  * Called with interrupts disabled via on_each_cpu()
58611a9fe06SAnna-Maria Gleixner  */
58711a9fe06SAnna-Maria Gleixner static void retrigger_next_event(void *arg)
58811a9fe06SAnna-Maria Gleixner {
58911a9fe06SAnna-Maria Gleixner 	struct hrtimer_cpu_base *base = this_cpu_ptr(&hrtimer_bases);
59011a9fe06SAnna-Maria Gleixner 
59111a9fe06SAnna-Maria Gleixner 	if (!__hrtimer_hres_active(base))
59211a9fe06SAnna-Maria Gleixner 		return;
59311a9fe06SAnna-Maria Gleixner 
59411a9fe06SAnna-Maria Gleixner 	raw_spin_lock(&base->lock);
59511a9fe06SAnna-Maria Gleixner 	hrtimer_update_base(base);
59611a9fe06SAnna-Maria Gleixner 	hrtimer_force_reprogram(base, 0);
59711a9fe06SAnna-Maria Gleixner 	raw_spin_unlock(&base->lock);
59811a9fe06SAnna-Maria Gleixner }
59911a9fe06SAnna-Maria Gleixner 
60011a9fe06SAnna-Maria Gleixner /*
60111a9fe06SAnna-Maria Gleixner  * Switch to high resolution mode
60211a9fe06SAnna-Maria Gleixner  */
60311a9fe06SAnna-Maria Gleixner static void hrtimer_switch_to_hres(void)
60411a9fe06SAnna-Maria Gleixner {
60511a9fe06SAnna-Maria Gleixner 	struct hrtimer_cpu_base *base = this_cpu_ptr(&hrtimer_bases);
60611a9fe06SAnna-Maria Gleixner 
60711a9fe06SAnna-Maria Gleixner 	if (tick_init_highres()) {
60811a9fe06SAnna-Maria Gleixner 		printk(KERN_WARNING "Could not switch to high resolution "
60911a9fe06SAnna-Maria Gleixner 				    "mode on CPU %d\n", base->cpu);
61011a9fe06SAnna-Maria Gleixner 		return;
61111a9fe06SAnna-Maria Gleixner 	}
61211a9fe06SAnna-Maria Gleixner 	base->hres_active = 1;
61311a9fe06SAnna-Maria Gleixner 	hrtimer_resolution = HIGH_RES_NSEC;
61411a9fe06SAnna-Maria Gleixner 
61511a9fe06SAnna-Maria Gleixner 	tick_setup_sched_timer();
61611a9fe06SAnna-Maria Gleixner 	/* "Retrigger" the interrupt to get things going */
61711a9fe06SAnna-Maria Gleixner 	retrigger_next_event(NULL);
61811a9fe06SAnna-Maria Gleixner }
61911a9fe06SAnna-Maria Gleixner 
62011a9fe06SAnna-Maria Gleixner static void clock_was_set_work(struct work_struct *work)
62111a9fe06SAnna-Maria Gleixner {
62211a9fe06SAnna-Maria Gleixner 	clock_was_set();
62311a9fe06SAnna-Maria Gleixner }
62411a9fe06SAnna-Maria Gleixner 
62511a9fe06SAnna-Maria Gleixner static DECLARE_WORK(hrtimer_work, clock_was_set_work);
62611a9fe06SAnna-Maria Gleixner 
62711a9fe06SAnna-Maria Gleixner /*
62811a9fe06SAnna-Maria Gleixner  * Called from timekeeping and resume code to reprogram the hrtimer
62911a9fe06SAnna-Maria Gleixner  * interrupt device on all cpus.
63011a9fe06SAnna-Maria Gleixner  */
63111a9fe06SAnna-Maria Gleixner void clock_was_set_delayed(void)
63211a9fe06SAnna-Maria Gleixner {
63311a9fe06SAnna-Maria Gleixner 	schedule_work(&hrtimer_work);
63411a9fe06SAnna-Maria Gleixner }
63511a9fe06SAnna-Maria Gleixner 
63611a9fe06SAnna-Maria Gleixner #else
63711a9fe06SAnna-Maria Gleixner 
63811a9fe06SAnna-Maria Gleixner static inline int hrtimer_is_hres_enabled(void) { return 0; }
63911a9fe06SAnna-Maria Gleixner static inline void hrtimer_switch_to_hres(void) { }
64011a9fe06SAnna-Maria Gleixner static inline void retrigger_next_event(void *arg) { }
64111a9fe06SAnna-Maria Gleixner 
64211a9fe06SAnna-Maria Gleixner #endif /* CONFIG_HIGH_RES_TIMERS */
64311a9fe06SAnna-Maria Gleixner 
64411a9fe06SAnna-Maria Gleixner /*
6455cee9645SThomas Gleixner  * When a timer is enqueued and expires earlier than the already enqueued
6465cee9645SThomas Gleixner  * timers, we have to check, whether it expires earlier than the timer for
6475cee9645SThomas Gleixner  * which the clock event device was armed.
6485cee9645SThomas Gleixner  *
6495cee9645SThomas Gleixner  * Called with interrupts disabled and base->cpu_base.lock held
6505cee9645SThomas Gleixner  */
651c6eb3f70SThomas Gleixner static void hrtimer_reprogram(struct hrtimer *timer,
6525cee9645SThomas Gleixner 			      struct hrtimer_clock_base *base)
6535cee9645SThomas Gleixner {
654dc5df73bSChristoph Lameter 	struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
6555cee9645SThomas Gleixner 	ktime_t expires = ktime_sub(hrtimer_get_expires(timer), base->offset);
6565cee9645SThomas Gleixner 
6575cee9645SThomas Gleixner 	WARN_ON_ONCE(hrtimer_get_expires_tv64(timer) < 0);
6585cee9645SThomas Gleixner 
6595cee9645SThomas Gleixner 	/*
660c6eb3f70SThomas Gleixner 	 * If the timer is not on the current cpu, we cannot reprogram
661c6eb3f70SThomas Gleixner 	 * the other cpus clock event device.
6625cee9645SThomas Gleixner 	 */
663c6eb3f70SThomas Gleixner 	if (base->cpu_base != cpu_base)
664c6eb3f70SThomas Gleixner 		return;
665c6eb3f70SThomas Gleixner 
666c6eb3f70SThomas Gleixner 	/*
667c6eb3f70SThomas Gleixner 	 * If the hrtimer interrupt is running, then it will
668c6eb3f70SThomas Gleixner 	 * reevaluate the clock bases and reprogram the clock event
669c6eb3f70SThomas Gleixner 	 * device. The callbacks are always executed in hard interrupt
670c6eb3f70SThomas Gleixner 	 * context so we don't need an extra check for a running
671c6eb3f70SThomas Gleixner 	 * callback.
672c6eb3f70SThomas Gleixner 	 */
673c6eb3f70SThomas Gleixner 	if (cpu_base->in_hrtirq)
674c6eb3f70SThomas Gleixner 		return;
6755cee9645SThomas Gleixner 
6765cee9645SThomas Gleixner 	/*
6775cee9645SThomas Gleixner 	 * CLOCK_REALTIME timer might be requested with an absolute
678c6eb3f70SThomas Gleixner 	 * expiry time which is less than base->offset. Set it to 0.
6795cee9645SThomas Gleixner 	 */
6802456e855SThomas Gleixner 	if (expires < 0)
6812456e855SThomas Gleixner 		expires = 0;
6825cee9645SThomas Gleixner 
6832456e855SThomas Gleixner 	if (expires >= cpu_base->expires_next)
684c6eb3f70SThomas Gleixner 		return;
6855cee9645SThomas Gleixner 
686c6eb3f70SThomas Gleixner 	/* Update the pointer to the next expiring timer */
687895bdfa7SThomas Gleixner 	cpu_base->next_timer = timer;
68814c80341SAnna-Maria Gleixner 	cpu_base->expires_next = expires;
6899bc74919SThomas Gleixner 
6909bc74919SThomas Gleixner 	/*
69114c80341SAnna-Maria Gleixner 	 * If hres is not active, hardware does not have to be
69214c80341SAnna-Maria Gleixner 	 * programmed yet.
69314c80341SAnna-Maria Gleixner 	 *
6945cee9645SThomas Gleixner 	 * If a hang was detected in the last timer interrupt then we
6955cee9645SThomas Gleixner 	 * do not schedule a timer which is earlier than the expiry
6965cee9645SThomas Gleixner 	 * which we enforced in the hang detection. We want the system
6975cee9645SThomas Gleixner 	 * to make progress.
6985cee9645SThomas Gleixner 	 */
69914c80341SAnna-Maria Gleixner 	if (!__hrtimer_hres_active(cpu_base) || cpu_base->hang_detected)
700c6eb3f70SThomas Gleixner 		return;
7015cee9645SThomas Gleixner 
7025cee9645SThomas Gleixner 	/*
703c6eb3f70SThomas Gleixner 	 * Program the timer hardware. We enforce the expiry for
704c6eb3f70SThomas Gleixner 	 * events which are already in the past.
7055cee9645SThomas Gleixner 	 */
706c6eb3f70SThomas Gleixner 	tick_program_event(expires, 1);
7075cee9645SThomas Gleixner }
7085cee9645SThomas Gleixner 
7095cee9645SThomas Gleixner /*
7105cee9645SThomas Gleixner  * Clock realtime was set
7115cee9645SThomas Gleixner  *
7125cee9645SThomas Gleixner  * Change the offset of the realtime clock vs. the monotonic
7135cee9645SThomas Gleixner  * clock.
7145cee9645SThomas Gleixner  *
7155cee9645SThomas Gleixner  * We might have to reprogram the high resolution timer interrupt. On
7165cee9645SThomas Gleixner  * SMP we call the architecture specific code to retrigger _all_ high
7175cee9645SThomas Gleixner  * resolution timer interrupts. On UP we just disable interrupts and
7185cee9645SThomas Gleixner  * call the high resolution interrupt code.
7195cee9645SThomas Gleixner  */
7205cee9645SThomas Gleixner void clock_was_set(void)
7215cee9645SThomas Gleixner {
7225cee9645SThomas Gleixner #ifdef CONFIG_HIGH_RES_TIMERS
7235cee9645SThomas Gleixner 	/* Retrigger the CPU local events everywhere */
7245cee9645SThomas Gleixner 	on_each_cpu(retrigger_next_event, NULL, 1);
7255cee9645SThomas Gleixner #endif
7265cee9645SThomas Gleixner 	timerfd_clock_was_set();
7275cee9645SThomas Gleixner }
7285cee9645SThomas Gleixner 
7295cee9645SThomas Gleixner /*
7305cee9645SThomas Gleixner  * During resume we might have to reprogram the high resolution timer
7315cee9645SThomas Gleixner  * interrupt on all online CPUs.  However, all other CPUs will be
7325cee9645SThomas Gleixner  * stopped with IRQs interrupts disabled so the clock_was_set() call
7335cee9645SThomas Gleixner  * must be deferred.
7345cee9645SThomas Gleixner  */
7355cee9645SThomas Gleixner void hrtimers_resume(void)
7365cee9645SThomas Gleixner {
73753bef3fdSFrederic Weisbecker 	lockdep_assert_irqs_disabled();
7385cee9645SThomas Gleixner 	/* Retrigger on the local CPU */
7395cee9645SThomas Gleixner 	retrigger_next_event(NULL);
7405cee9645SThomas Gleixner 	/* And schedule a retrigger for all others */
7415cee9645SThomas Gleixner 	clock_was_set_delayed();
7425cee9645SThomas Gleixner }
7435cee9645SThomas Gleixner 
7445cee9645SThomas Gleixner /*
7455cee9645SThomas Gleixner  * Counterpart to lock_hrtimer_base above:
7465cee9645SThomas Gleixner  */
7475cee9645SThomas Gleixner static inline
7485cee9645SThomas Gleixner void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
7495cee9645SThomas Gleixner {
7505cee9645SThomas Gleixner 	raw_spin_unlock_irqrestore(&timer->base->cpu_base->lock, *flags);
7515cee9645SThomas Gleixner }
7525cee9645SThomas Gleixner 
7535cee9645SThomas Gleixner /**
7545cee9645SThomas Gleixner  * hrtimer_forward - forward the timer expiry
7555cee9645SThomas Gleixner  * @timer:	hrtimer to forward
7565cee9645SThomas Gleixner  * @now:	forward past this time
7575cee9645SThomas Gleixner  * @interval:	the interval to forward
7585cee9645SThomas Gleixner  *
7595cee9645SThomas Gleixner  * Forward the timer expiry so it will expire in the future.
7605cee9645SThomas Gleixner  * Returns the number of overruns.
76191e5a217SThomas Gleixner  *
76291e5a217SThomas Gleixner  * Can be safely called from the callback function of @timer. If
76391e5a217SThomas Gleixner  * called from other contexts @timer must neither be enqueued nor
76491e5a217SThomas Gleixner  * running the callback and the caller needs to take care of
76591e5a217SThomas Gleixner  * serialization.
76691e5a217SThomas Gleixner  *
76791e5a217SThomas Gleixner  * Note: This only updates the timer expiry value and does not requeue
76891e5a217SThomas Gleixner  * the timer.
7695cee9645SThomas Gleixner  */
7705cee9645SThomas Gleixner u64 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
7715cee9645SThomas Gleixner {
7725cee9645SThomas Gleixner 	u64 orun = 1;
7735cee9645SThomas Gleixner 	ktime_t delta;
7745cee9645SThomas Gleixner 
7755cee9645SThomas Gleixner 	delta = ktime_sub(now, hrtimer_get_expires(timer));
7765cee9645SThomas Gleixner 
7772456e855SThomas Gleixner 	if (delta < 0)
7785cee9645SThomas Gleixner 		return 0;
7795cee9645SThomas Gleixner 
7805de2755cSPeter Zijlstra 	if (WARN_ON(timer->state & HRTIMER_STATE_ENQUEUED))
7815de2755cSPeter Zijlstra 		return 0;
7825de2755cSPeter Zijlstra 
7832456e855SThomas Gleixner 	if (interval < hrtimer_resolution)
7842456e855SThomas Gleixner 		interval = hrtimer_resolution;
7855cee9645SThomas Gleixner 
7862456e855SThomas Gleixner 	if (unlikely(delta >= interval)) {
7875cee9645SThomas Gleixner 		s64 incr = ktime_to_ns(interval);
7885cee9645SThomas Gleixner 
7895cee9645SThomas Gleixner 		orun = ktime_divns(delta, incr);
7905cee9645SThomas Gleixner 		hrtimer_add_expires_ns(timer, incr * orun);
7912456e855SThomas Gleixner 		if (hrtimer_get_expires_tv64(timer) > now)
7925cee9645SThomas Gleixner 			return orun;
7935cee9645SThomas Gleixner 		/*
7945cee9645SThomas Gleixner 		 * This (and the ktime_add() below) is the
7955cee9645SThomas Gleixner 		 * correction for exact:
7965cee9645SThomas Gleixner 		 */
7975cee9645SThomas Gleixner 		orun++;
7985cee9645SThomas Gleixner 	}
7995cee9645SThomas Gleixner 	hrtimer_add_expires(timer, interval);
8005cee9645SThomas Gleixner 
8015cee9645SThomas Gleixner 	return orun;
8025cee9645SThomas Gleixner }
8035cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(hrtimer_forward);
8045cee9645SThomas Gleixner 
8055cee9645SThomas Gleixner /*
8065cee9645SThomas Gleixner  * enqueue_hrtimer - internal function to (re)start a timer
8075cee9645SThomas Gleixner  *
8085cee9645SThomas Gleixner  * The timer is inserted in expiry order. Insertion into the
8095cee9645SThomas Gleixner  * red black tree is O(log(n)). Must hold the base lock.
8105cee9645SThomas Gleixner  *
8115cee9645SThomas Gleixner  * Returns 1 when the new timer is the leftmost timer in the tree.
8125cee9645SThomas Gleixner  */
8135cee9645SThomas Gleixner static int enqueue_hrtimer(struct hrtimer *timer,
81463e2ed36SAnna-Maria Gleixner 			   struct hrtimer_clock_base *base,
81563e2ed36SAnna-Maria Gleixner 			   enum hrtimer_mode mode)
8165cee9645SThomas Gleixner {
81763e2ed36SAnna-Maria Gleixner 	debug_activate(timer, mode);
8185cee9645SThomas Gleixner 
8195cee9645SThomas Gleixner 	base->cpu_base->active_bases |= 1 << base->index;
8205cee9645SThomas Gleixner 
821887d9dc9SPeter Zijlstra 	timer->state = HRTIMER_STATE_ENQUEUED;
8225cee9645SThomas Gleixner 
823b97f44c9SThomas Gleixner 	return timerqueue_add(&base->active, &timer->node);
8245cee9645SThomas Gleixner }
8255cee9645SThomas Gleixner 
8265cee9645SThomas Gleixner /*
8275cee9645SThomas Gleixner  * __remove_hrtimer - internal function to remove a timer
8285cee9645SThomas Gleixner  *
8295cee9645SThomas Gleixner  * Caller must hold the base lock.
8305cee9645SThomas Gleixner  *
8315cee9645SThomas Gleixner  * High resolution timer mode reprograms the clock event device when the
8325cee9645SThomas Gleixner  * timer is the one which expires next. The caller can disable this by setting
8335cee9645SThomas Gleixner  * reprogram to zero. This is useful, when the context does a reprogramming
8345cee9645SThomas Gleixner  * anyway (e.g. timer interrupt)
8355cee9645SThomas Gleixner  */
8365cee9645SThomas Gleixner static void __remove_hrtimer(struct hrtimer *timer,
8375cee9645SThomas Gleixner 			     struct hrtimer_clock_base *base,
838203cbf77SThomas Gleixner 			     u8 newstate, int reprogram)
8395cee9645SThomas Gleixner {
840e19ffe8bSThomas Gleixner 	struct hrtimer_cpu_base *cpu_base = base->cpu_base;
841203cbf77SThomas Gleixner 	u8 state = timer->state;
8425cee9645SThomas Gleixner 
8435cee9645SThomas Gleixner 	timer->state = newstate;
844895bdfa7SThomas Gleixner 	if (!(state & HRTIMER_STATE_ENQUEUED))
845895bdfa7SThomas Gleixner 		return;
8465cee9645SThomas Gleixner 
847b97f44c9SThomas Gleixner 	if (!timerqueue_del(&base->active, &timer->node))
848e19ffe8bSThomas Gleixner 		cpu_base->active_bases &= ~(1 << base->index);
849d9f0acdeSViresh Kumar 
850895bdfa7SThomas Gleixner 	/*
851895bdfa7SThomas Gleixner 	 * Note: If reprogram is false we do not update
852895bdfa7SThomas Gleixner 	 * cpu_base->next_timer. This happens when we remove the first
853895bdfa7SThomas Gleixner 	 * timer on a remote cpu. No harm as we never dereference
854895bdfa7SThomas Gleixner 	 * cpu_base->next_timer. So the worst thing what can happen is
855895bdfa7SThomas Gleixner 	 * an superflous call to hrtimer_force_reprogram() on the
856895bdfa7SThomas Gleixner 	 * remote cpu later on if the same timer gets enqueued again.
857895bdfa7SThomas Gleixner 	 */
858895bdfa7SThomas Gleixner 	if (reprogram && timer == cpu_base->next_timer)
859e19ffe8bSThomas Gleixner 		hrtimer_force_reprogram(cpu_base, 1);
8605cee9645SThomas Gleixner }
8615cee9645SThomas Gleixner 
8625cee9645SThomas Gleixner /*
8635cee9645SThomas Gleixner  * remove hrtimer, called with base lock held
8645cee9645SThomas Gleixner  */
8655cee9645SThomas Gleixner static inline int
8668edfb036SPeter Zijlstra remove_hrtimer(struct hrtimer *timer, struct hrtimer_clock_base *base, bool restart)
8675cee9645SThomas Gleixner {
8685cee9645SThomas Gleixner 	if (hrtimer_is_queued(timer)) {
869203cbf77SThomas Gleixner 		u8 state = timer->state;
8705cee9645SThomas Gleixner 		int reprogram;
8715cee9645SThomas Gleixner 
8725cee9645SThomas Gleixner 		/*
8735cee9645SThomas Gleixner 		 * Remove the timer and force reprogramming when high
8745cee9645SThomas Gleixner 		 * resolution mode is active and the timer is on the current
8755cee9645SThomas Gleixner 		 * CPU. If we remove a timer on another CPU, reprogramming is
8765cee9645SThomas Gleixner 		 * skipped. The interrupt event on this CPU is fired and
8775cee9645SThomas Gleixner 		 * reprogramming happens in the interrupt handler. This is a
8785cee9645SThomas Gleixner 		 * rare case and less expensive than a smp call.
8795cee9645SThomas Gleixner 		 */
8805cee9645SThomas Gleixner 		debug_deactivate(timer);
881dc5df73bSChristoph Lameter 		reprogram = base->cpu_base == this_cpu_ptr(&hrtimer_bases);
8828edfb036SPeter Zijlstra 
883887d9dc9SPeter Zijlstra 		if (!restart)
884887d9dc9SPeter Zijlstra 			state = HRTIMER_STATE_INACTIVE;
885887d9dc9SPeter Zijlstra 
8865cee9645SThomas Gleixner 		__remove_hrtimer(timer, base, state, reprogram);
8875cee9645SThomas Gleixner 		return 1;
8885cee9645SThomas Gleixner 	}
8895cee9645SThomas Gleixner 	return 0;
8905cee9645SThomas Gleixner }
8915cee9645SThomas Gleixner 
892203cbf77SThomas Gleixner static inline ktime_t hrtimer_update_lowres(struct hrtimer *timer, ktime_t tim,
893203cbf77SThomas Gleixner 					    const enum hrtimer_mode mode)
894203cbf77SThomas Gleixner {
895203cbf77SThomas Gleixner #ifdef CONFIG_TIME_LOW_RES
896203cbf77SThomas Gleixner 	/*
897203cbf77SThomas Gleixner 	 * CONFIG_TIME_LOW_RES indicates that the system has no way to return
898203cbf77SThomas Gleixner 	 * granular time values. For relative timers we add hrtimer_resolution
899203cbf77SThomas Gleixner 	 * (i.e. one jiffie) to prevent short timeouts.
900203cbf77SThomas Gleixner 	 */
901203cbf77SThomas Gleixner 	timer->is_rel = mode & HRTIMER_MODE_REL;
902203cbf77SThomas Gleixner 	if (timer->is_rel)
9038b0e1953SThomas Gleixner 		tim = ktime_add_safe(tim, hrtimer_resolution);
904203cbf77SThomas Gleixner #endif
905203cbf77SThomas Gleixner 	return tim;
906203cbf77SThomas Gleixner }
907203cbf77SThomas Gleixner 
90858f1f803SThomas Gleixner /**
9096de6250cSAnna-Maria Gleixner  * hrtimer_start_range_ns - (re)start an hrtimer
91058f1f803SThomas Gleixner  * @timer:	the timer to be added
91158f1f803SThomas Gleixner  * @tim:	expiry time
91258f1f803SThomas Gleixner  * @delta_ns:	"slack" range for the timer
9136de6250cSAnna-Maria Gleixner  * @mode:	timer mode: absolute (HRTIMER_MODE_ABS) or
9146de6250cSAnna-Maria Gleixner  *		relative (HRTIMER_MODE_REL), and pinned (HRTIMER_MODE_PINNED)
91558f1f803SThomas Gleixner  */
91661699e13SThomas Gleixner void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
917da8b44d5SJohn Stultz 			    u64 delta_ns, const enum hrtimer_mode mode)
9185cee9645SThomas Gleixner {
9195cee9645SThomas Gleixner 	struct hrtimer_clock_base *base, *new_base;
9205cee9645SThomas Gleixner 	unsigned long flags;
92161699e13SThomas Gleixner 	int leftmost;
9225cee9645SThomas Gleixner 
9235cee9645SThomas Gleixner 	base = lock_hrtimer_base(timer, &flags);
9245cee9645SThomas Gleixner 
9255cee9645SThomas Gleixner 	/* Remove an active timer from the queue: */
9268edfb036SPeter Zijlstra 	remove_hrtimer(timer, base, true);
9275cee9645SThomas Gleixner 
928203cbf77SThomas Gleixner 	if (mode & HRTIMER_MODE_REL)
9295cee9645SThomas Gleixner 		tim = ktime_add_safe(tim, base->get_time());
930203cbf77SThomas Gleixner 
931203cbf77SThomas Gleixner 	tim = hrtimer_update_lowres(timer, tim, mode);
9325cee9645SThomas Gleixner 
9335cee9645SThomas Gleixner 	hrtimer_set_expires_range_ns(timer, tim, delta_ns);
9345cee9645SThomas Gleixner 
9355cee9645SThomas Gleixner 	/* Switch the timer base, if necessary: */
9365cee9645SThomas Gleixner 	new_base = switch_hrtimer_base(timer, base, mode & HRTIMER_MODE_PINNED);
9375cee9645SThomas Gleixner 
93863e2ed36SAnna-Maria Gleixner 	leftmost = enqueue_hrtimer(timer, new_base, mode);
93961699e13SThomas Gleixner 	if (!leftmost)
94061699e13SThomas Gleixner 		goto unlock;
94149a2a075SViresh Kumar 
942c6eb3f70SThomas Gleixner 	hrtimer_reprogram(timer, new_base);
94361699e13SThomas Gleixner unlock:
9445cee9645SThomas Gleixner 	unlock_hrtimer_base(timer, &flags);
9455cee9645SThomas Gleixner }
9465cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(hrtimer_start_range_ns);
9475cee9645SThomas Gleixner 
9485cee9645SThomas Gleixner /**
9495cee9645SThomas Gleixner  * hrtimer_try_to_cancel - try to deactivate a timer
9505cee9645SThomas Gleixner  * @timer:	hrtimer to stop
9515cee9645SThomas Gleixner  *
9525cee9645SThomas Gleixner  * Returns:
9535cee9645SThomas Gleixner  *  0 when the timer was not active
9545cee9645SThomas Gleixner  *  1 when the timer was active
9550ba42a59SMasanari Iida  * -1 when the timer is currently executing the callback function and
9565cee9645SThomas Gleixner  *    cannot be stopped
9575cee9645SThomas Gleixner  */
9585cee9645SThomas Gleixner int hrtimer_try_to_cancel(struct hrtimer *timer)
9595cee9645SThomas Gleixner {
9605cee9645SThomas Gleixner 	struct hrtimer_clock_base *base;
9615cee9645SThomas Gleixner 	unsigned long flags;
9625cee9645SThomas Gleixner 	int ret = -1;
9635cee9645SThomas Gleixner 
96419d9f422SThomas Gleixner 	/*
96519d9f422SThomas Gleixner 	 * Check lockless first. If the timer is not active (neither
96619d9f422SThomas Gleixner 	 * enqueued nor running the callback, nothing to do here.  The
96719d9f422SThomas Gleixner 	 * base lock does not serialize against a concurrent enqueue,
96819d9f422SThomas Gleixner 	 * so we can avoid taking it.
96919d9f422SThomas Gleixner 	 */
97019d9f422SThomas Gleixner 	if (!hrtimer_active(timer))
97119d9f422SThomas Gleixner 		return 0;
97219d9f422SThomas Gleixner 
9735cee9645SThomas Gleixner 	base = lock_hrtimer_base(timer, &flags);
9745cee9645SThomas Gleixner 
9755cee9645SThomas Gleixner 	if (!hrtimer_callback_running(timer))
9768edfb036SPeter Zijlstra 		ret = remove_hrtimer(timer, base, false);
9775cee9645SThomas Gleixner 
9785cee9645SThomas Gleixner 	unlock_hrtimer_base(timer, &flags);
9795cee9645SThomas Gleixner 
9805cee9645SThomas Gleixner 	return ret;
9815cee9645SThomas Gleixner 
9825cee9645SThomas Gleixner }
9835cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
9845cee9645SThomas Gleixner 
9855cee9645SThomas Gleixner /**
9865cee9645SThomas Gleixner  * hrtimer_cancel - cancel a timer and wait for the handler to finish.
9875cee9645SThomas Gleixner  * @timer:	the timer to be cancelled
9885cee9645SThomas Gleixner  *
9895cee9645SThomas Gleixner  * Returns:
9905cee9645SThomas Gleixner  *  0 when the timer was not active
9915cee9645SThomas Gleixner  *  1 when the timer was active
9925cee9645SThomas Gleixner  */
9935cee9645SThomas Gleixner int hrtimer_cancel(struct hrtimer *timer)
9945cee9645SThomas Gleixner {
9955cee9645SThomas Gleixner 	for (;;) {
9965cee9645SThomas Gleixner 		int ret = hrtimer_try_to_cancel(timer);
9975cee9645SThomas Gleixner 
9985cee9645SThomas Gleixner 		if (ret >= 0)
9995cee9645SThomas Gleixner 			return ret;
10005cee9645SThomas Gleixner 		cpu_relax();
10015cee9645SThomas Gleixner 	}
10025cee9645SThomas Gleixner }
10035cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(hrtimer_cancel);
10045cee9645SThomas Gleixner 
10055cee9645SThomas Gleixner /**
10065cee9645SThomas Gleixner  * hrtimer_get_remaining - get remaining time for the timer
10075cee9645SThomas Gleixner  * @timer:	the timer to read
1008203cbf77SThomas Gleixner  * @adjust:	adjust relative timers when CONFIG_TIME_LOW_RES=y
10095cee9645SThomas Gleixner  */
1010203cbf77SThomas Gleixner ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust)
10115cee9645SThomas Gleixner {
10125cee9645SThomas Gleixner 	unsigned long flags;
10135cee9645SThomas Gleixner 	ktime_t rem;
10145cee9645SThomas Gleixner 
10155cee9645SThomas Gleixner 	lock_hrtimer_base(timer, &flags);
1016203cbf77SThomas Gleixner 	if (IS_ENABLED(CONFIG_TIME_LOW_RES) && adjust)
1017203cbf77SThomas Gleixner 		rem = hrtimer_expires_remaining_adjusted(timer);
1018203cbf77SThomas Gleixner 	else
10195cee9645SThomas Gleixner 		rem = hrtimer_expires_remaining(timer);
10205cee9645SThomas Gleixner 	unlock_hrtimer_base(timer, &flags);
10215cee9645SThomas Gleixner 
10225cee9645SThomas Gleixner 	return rem;
10235cee9645SThomas Gleixner }
1024203cbf77SThomas Gleixner EXPORT_SYMBOL_GPL(__hrtimer_get_remaining);
10255cee9645SThomas Gleixner 
10265cee9645SThomas Gleixner #ifdef CONFIG_NO_HZ_COMMON
10275cee9645SThomas Gleixner /**
10285cee9645SThomas Gleixner  * hrtimer_get_next_event - get the time until next expiry event
10295cee9645SThomas Gleixner  *
1030c1ad348bSThomas Gleixner  * Returns the next expiry time or KTIME_MAX if no timer is pending.
10315cee9645SThomas Gleixner  */
1032c1ad348bSThomas Gleixner u64 hrtimer_get_next_event(void)
10335cee9645SThomas Gleixner {
1034dc5df73bSChristoph Lameter 	struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
1035c1ad348bSThomas Gleixner 	u64 expires = KTIME_MAX;
10365cee9645SThomas Gleixner 	unsigned long flags;
10375cee9645SThomas Gleixner 
10385cee9645SThomas Gleixner 	raw_spin_lock_irqsave(&cpu_base->lock, flags);
10395cee9645SThomas Gleixner 
1040e19ffe8bSThomas Gleixner 	if (!__hrtimer_hres_active(cpu_base))
10412456e855SThomas Gleixner 		expires = __hrtimer_get_next_event(cpu_base);
10425cee9645SThomas Gleixner 
10435cee9645SThomas Gleixner 	raw_spin_unlock_irqrestore(&cpu_base->lock, flags);
10445cee9645SThomas Gleixner 
1045c1ad348bSThomas Gleixner 	return expires;
10465cee9645SThomas Gleixner }
10475cee9645SThomas Gleixner #endif
10485cee9645SThomas Gleixner 
1049336a9cdeSMarc Zyngier static inline int hrtimer_clockid_to_base(clockid_t clock_id)
1050336a9cdeSMarc Zyngier {
1051336a9cdeSMarc Zyngier 	if (likely(clock_id < MAX_CLOCKS)) {
1052336a9cdeSMarc Zyngier 		int base = hrtimer_clock_to_base_table[clock_id];
1053336a9cdeSMarc Zyngier 
1054336a9cdeSMarc Zyngier 		if (likely(base != HRTIMER_MAX_CLOCK_BASES))
1055336a9cdeSMarc Zyngier 			return base;
1056336a9cdeSMarc Zyngier 	}
1057336a9cdeSMarc Zyngier 	WARN(1, "Invalid clockid %d. Using MONOTONIC\n", clock_id);
1058336a9cdeSMarc Zyngier 	return HRTIMER_BASE_MONOTONIC;
1059336a9cdeSMarc Zyngier }
1060336a9cdeSMarc Zyngier 
10615cee9645SThomas Gleixner static void __hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
10625cee9645SThomas Gleixner 			   enum hrtimer_mode mode)
10635cee9645SThomas Gleixner {
10645cee9645SThomas Gleixner 	struct hrtimer_cpu_base *cpu_base;
10655cee9645SThomas Gleixner 	int base;
10665cee9645SThomas Gleixner 
10675cee9645SThomas Gleixner 	memset(timer, 0, sizeof(struct hrtimer));
10685cee9645SThomas Gleixner 
106922127e93SChristoph Lameter 	cpu_base = raw_cpu_ptr(&hrtimer_bases);
10705cee9645SThomas Gleixner 
107148d0c9beSAnna-Maria Gleixner 	/*
107248d0c9beSAnna-Maria Gleixner 	 * POSIX magic: Relative CLOCK_REALTIME timers are not affected by
107348d0c9beSAnna-Maria Gleixner 	 * clock modifications, so they needs to become CLOCK_MONOTONIC to
107448d0c9beSAnna-Maria Gleixner 	 * ensure POSIX compliance.
107548d0c9beSAnna-Maria Gleixner 	 */
107648d0c9beSAnna-Maria Gleixner 	if (clock_id == CLOCK_REALTIME && mode & HRTIMER_MODE_REL)
10775cee9645SThomas Gleixner 		clock_id = CLOCK_MONOTONIC;
10785cee9645SThomas Gleixner 
10795cee9645SThomas Gleixner 	base = hrtimer_clockid_to_base(clock_id);
10805cee9645SThomas Gleixner 	timer->base = &cpu_base->clock_base[base];
10815cee9645SThomas Gleixner 	timerqueue_init(&timer->node);
10825cee9645SThomas Gleixner }
10835cee9645SThomas Gleixner 
10845cee9645SThomas Gleixner /**
10855cee9645SThomas Gleixner  * hrtimer_init - initialize a timer to the given clock
10865cee9645SThomas Gleixner  * @timer:	the timer to be initialized
10875cee9645SThomas Gleixner  * @clock_id:	the clock to be used
10886de6250cSAnna-Maria Gleixner  * @mode:	timer mode: absolute (HRTIMER_MODE_ABS) or
10896de6250cSAnna-Maria Gleixner  *		relative (HRTIMER_MODE_REL); pinned is not considered here!
10905cee9645SThomas Gleixner  */
10915cee9645SThomas Gleixner void hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
10925cee9645SThomas Gleixner 		  enum hrtimer_mode mode)
10935cee9645SThomas Gleixner {
10945cee9645SThomas Gleixner 	debug_init(timer, clock_id, mode);
10955cee9645SThomas Gleixner 	__hrtimer_init(timer, clock_id, mode);
10965cee9645SThomas Gleixner }
10975cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(hrtimer_init);
10985cee9645SThomas Gleixner 
1099887d9dc9SPeter Zijlstra /*
1100887d9dc9SPeter Zijlstra  * A timer is active, when it is enqueued into the rbtree or the
1101887d9dc9SPeter Zijlstra  * callback function is running or it's in the state of being migrated
1102887d9dc9SPeter Zijlstra  * to another cpu.
11035cee9645SThomas Gleixner  *
1104887d9dc9SPeter Zijlstra  * It is important for this function to not return a false negative.
11055cee9645SThomas Gleixner  */
1106887d9dc9SPeter Zijlstra bool hrtimer_active(const struct hrtimer *timer)
11075cee9645SThomas Gleixner {
11083f0b9e8eSAnna-Maria Gleixner 	struct hrtimer_clock_base *base;
1109887d9dc9SPeter Zijlstra 	unsigned int seq;
11105cee9645SThomas Gleixner 
1111887d9dc9SPeter Zijlstra 	do {
11123f0b9e8eSAnna-Maria Gleixner 		base = READ_ONCE(timer->base);
11133f0b9e8eSAnna-Maria Gleixner 		seq = raw_read_seqcount_begin(&base->seq);
11145cee9645SThomas Gleixner 
1115887d9dc9SPeter Zijlstra 		if (timer->state != HRTIMER_STATE_INACTIVE ||
11163f0b9e8eSAnna-Maria Gleixner 		    base->running == timer)
1117887d9dc9SPeter Zijlstra 			return true;
1118887d9dc9SPeter Zijlstra 
11193f0b9e8eSAnna-Maria Gleixner 	} while (read_seqcount_retry(&base->seq, seq) ||
11203f0b9e8eSAnna-Maria Gleixner 		 base != READ_ONCE(timer->base));
1121887d9dc9SPeter Zijlstra 
1122887d9dc9SPeter Zijlstra 	return false;
11235cee9645SThomas Gleixner }
1124887d9dc9SPeter Zijlstra EXPORT_SYMBOL_GPL(hrtimer_active);
11255cee9645SThomas Gleixner 
1126887d9dc9SPeter Zijlstra /*
1127887d9dc9SPeter Zijlstra  * The write_seqcount_barrier()s in __run_hrtimer() split the thing into 3
1128887d9dc9SPeter Zijlstra  * distinct sections:
1129887d9dc9SPeter Zijlstra  *
1130887d9dc9SPeter Zijlstra  *  - queued:	the timer is queued
1131887d9dc9SPeter Zijlstra  *  - callback:	the timer is being ran
1132887d9dc9SPeter Zijlstra  *  - post:	the timer is inactive or (re)queued
1133887d9dc9SPeter Zijlstra  *
1134887d9dc9SPeter Zijlstra  * On the read side we ensure we observe timer->state and cpu_base->running
1135887d9dc9SPeter Zijlstra  * from the same section, if anything changed while we looked at it, we retry.
1136887d9dc9SPeter Zijlstra  * This includes timer->base changing because sequence numbers alone are
1137887d9dc9SPeter Zijlstra  * insufficient for that.
1138887d9dc9SPeter Zijlstra  *
1139887d9dc9SPeter Zijlstra  * The sequence numbers are required because otherwise we could still observe
1140887d9dc9SPeter Zijlstra  * a false negative if the read side got smeared over multiple consequtive
1141887d9dc9SPeter Zijlstra  * __run_hrtimer() invocations.
1142887d9dc9SPeter Zijlstra  */
1143887d9dc9SPeter Zijlstra 
114421d6d52aSThomas Gleixner static void __run_hrtimer(struct hrtimer_cpu_base *cpu_base,
114521d6d52aSThomas Gleixner 			  struct hrtimer_clock_base *base,
114621d6d52aSThomas Gleixner 			  struct hrtimer *timer, ktime_t *now)
11475cee9645SThomas Gleixner {
11485cee9645SThomas Gleixner 	enum hrtimer_restart (*fn)(struct hrtimer *);
11495cee9645SThomas Gleixner 	int restart;
11505cee9645SThomas Gleixner 
1151887d9dc9SPeter Zijlstra 	lockdep_assert_held(&cpu_base->lock);
11525cee9645SThomas Gleixner 
11535cee9645SThomas Gleixner 	debug_deactivate(timer);
11543f0b9e8eSAnna-Maria Gleixner 	base->running = timer;
1155887d9dc9SPeter Zijlstra 
1156887d9dc9SPeter Zijlstra 	/*
1157887d9dc9SPeter Zijlstra 	 * Separate the ->running assignment from the ->state assignment.
1158887d9dc9SPeter Zijlstra 	 *
1159887d9dc9SPeter Zijlstra 	 * As with a regular write barrier, this ensures the read side in
11603f0b9e8eSAnna-Maria Gleixner 	 * hrtimer_active() cannot observe base->running == NULL &&
1161887d9dc9SPeter Zijlstra 	 * timer->state == INACTIVE.
1162887d9dc9SPeter Zijlstra 	 */
11633f0b9e8eSAnna-Maria Gleixner 	raw_write_seqcount_barrier(&base->seq);
1164887d9dc9SPeter Zijlstra 
1165887d9dc9SPeter Zijlstra 	__remove_hrtimer(timer, base, HRTIMER_STATE_INACTIVE, 0);
11665cee9645SThomas Gleixner 	fn = timer->function;
11675cee9645SThomas Gleixner 
11685cee9645SThomas Gleixner 	/*
1169203cbf77SThomas Gleixner 	 * Clear the 'is relative' flag for the TIME_LOW_RES case. If the
1170203cbf77SThomas Gleixner 	 * timer is restarted with a period then it becomes an absolute
1171203cbf77SThomas Gleixner 	 * timer. If its not restarted it does not matter.
1172203cbf77SThomas Gleixner 	 */
1173203cbf77SThomas Gleixner 	if (IS_ENABLED(CONFIG_TIME_LOW_RES))
1174203cbf77SThomas Gleixner 		timer->is_rel = false;
1175203cbf77SThomas Gleixner 
1176203cbf77SThomas Gleixner 	/*
1177d05ca13bSThomas Gleixner 	 * The timer is marked as running in the CPU base, so it is
1178d05ca13bSThomas Gleixner 	 * protected against migration to a different CPU even if the lock
1179d05ca13bSThomas Gleixner 	 * is dropped.
11805cee9645SThomas Gleixner 	 */
11815cee9645SThomas Gleixner 	raw_spin_unlock(&cpu_base->lock);
11825cee9645SThomas Gleixner 	trace_hrtimer_expire_entry(timer, now);
11835cee9645SThomas Gleixner 	restart = fn(timer);
11845cee9645SThomas Gleixner 	trace_hrtimer_expire_exit(timer);
11855cee9645SThomas Gleixner 	raw_spin_lock(&cpu_base->lock);
11865cee9645SThomas Gleixner 
11875cee9645SThomas Gleixner 	/*
1188887d9dc9SPeter Zijlstra 	 * Note: We clear the running state after enqueue_hrtimer and
1189b4d90e9fSPratyush Patel 	 * we do not reprogram the event hardware. Happens either in
11905cee9645SThomas Gleixner 	 * hrtimer_start_range_ns() or in hrtimer_interrupt()
11915de2755cSPeter Zijlstra 	 *
11925de2755cSPeter Zijlstra 	 * Note: Because we dropped the cpu_base->lock above,
11935de2755cSPeter Zijlstra 	 * hrtimer_start_range_ns() can have popped in and enqueued the timer
11945de2755cSPeter Zijlstra 	 * for us already.
11955cee9645SThomas Gleixner 	 */
11965de2755cSPeter Zijlstra 	if (restart != HRTIMER_NORESTART &&
11975de2755cSPeter Zijlstra 	    !(timer->state & HRTIMER_STATE_ENQUEUED))
119863e2ed36SAnna-Maria Gleixner 		enqueue_hrtimer(timer, base, HRTIMER_MODE_ABS);
11995cee9645SThomas Gleixner 
12005cee9645SThomas Gleixner 	/*
1201887d9dc9SPeter Zijlstra 	 * Separate the ->running assignment from the ->state assignment.
1202887d9dc9SPeter Zijlstra 	 *
1203887d9dc9SPeter Zijlstra 	 * As with a regular write barrier, this ensures the read side in
12043f0b9e8eSAnna-Maria Gleixner 	 * hrtimer_active() cannot observe base->running.timer == NULL &&
1205887d9dc9SPeter Zijlstra 	 * timer->state == INACTIVE.
12065cee9645SThomas Gleixner 	 */
12073f0b9e8eSAnna-Maria Gleixner 	raw_write_seqcount_barrier(&base->seq);
12085cee9645SThomas Gleixner 
12093f0b9e8eSAnna-Maria Gleixner 	WARN_ON_ONCE(base->running != timer);
12103f0b9e8eSAnna-Maria Gleixner 	base->running = NULL;
12115cee9645SThomas Gleixner }
12125cee9645SThomas Gleixner 
121321d6d52aSThomas Gleixner static void __hrtimer_run_queues(struct hrtimer_cpu_base *cpu_base, ktime_t now)
12145cee9645SThomas Gleixner {
1215c272ca58SAnna-Maria Gleixner 	struct hrtimer_clock_base *base;
121634aee88aSThomas Gleixner 	unsigned int active = cpu_base->active_bases;
12175cee9645SThomas Gleixner 
1218c272ca58SAnna-Maria Gleixner 	for_each_active_base(base, cpu_base, active) {
12195cee9645SThomas Gleixner 		struct timerqueue_node *node;
12205cee9645SThomas Gleixner 		ktime_t basenow;
12215cee9645SThomas Gleixner 
12225cee9645SThomas Gleixner 		basenow = ktime_add(now, base->offset);
12235cee9645SThomas Gleixner 
12245cee9645SThomas Gleixner 		while ((node = timerqueue_getnext(&base->active))) {
12255cee9645SThomas Gleixner 			struct hrtimer *timer;
12265cee9645SThomas Gleixner 
12275cee9645SThomas Gleixner 			timer = container_of(node, struct hrtimer, node);
12285cee9645SThomas Gleixner 
12295cee9645SThomas Gleixner 			/*
12305cee9645SThomas Gleixner 			 * The immediate goal for using the softexpires is
12315cee9645SThomas Gleixner 			 * minimizing wakeups, not running timers at the
12325cee9645SThomas Gleixner 			 * earliest interrupt after their soft expiration.
12335cee9645SThomas Gleixner 			 * This allows us to avoid using a Priority Search
12345cee9645SThomas Gleixner 			 * Tree, which can answer a stabbing querry for
12355cee9645SThomas Gleixner 			 * overlapping intervals and instead use the simple
12365cee9645SThomas Gleixner 			 * BST we already have.
12375cee9645SThomas Gleixner 			 * We don't add extra wakeups by delaying timers that
12385cee9645SThomas Gleixner 			 * are right-of a not yet expired timer, because that
12395cee9645SThomas Gleixner 			 * timer will have to trigger a wakeup anyway.
12405cee9645SThomas Gleixner 			 */
12412456e855SThomas Gleixner 			if (basenow < hrtimer_get_softexpires_tv64(timer))
12425cee9645SThomas Gleixner 				break;
12435cee9645SThomas Gleixner 
124421d6d52aSThomas Gleixner 			__run_hrtimer(cpu_base, base, timer, &basenow);
12455cee9645SThomas Gleixner 		}
12465cee9645SThomas Gleixner 	}
124721d6d52aSThomas Gleixner }
124821d6d52aSThomas Gleixner 
124921d6d52aSThomas Gleixner #ifdef CONFIG_HIGH_RES_TIMERS
125021d6d52aSThomas Gleixner 
125121d6d52aSThomas Gleixner /*
125221d6d52aSThomas Gleixner  * High resolution timer interrupt
125321d6d52aSThomas Gleixner  * Called with interrupts disabled
125421d6d52aSThomas Gleixner  */
125521d6d52aSThomas Gleixner void hrtimer_interrupt(struct clock_event_device *dev)
125621d6d52aSThomas Gleixner {
125721d6d52aSThomas Gleixner 	struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
125821d6d52aSThomas Gleixner 	ktime_t expires_next, now, entry_time, delta;
125921d6d52aSThomas Gleixner 	int retries = 0;
126021d6d52aSThomas Gleixner 
126121d6d52aSThomas Gleixner 	BUG_ON(!cpu_base->hres_active);
126221d6d52aSThomas Gleixner 	cpu_base->nr_events++;
12632456e855SThomas Gleixner 	dev->next_event = KTIME_MAX;
126421d6d52aSThomas Gleixner 
126521d6d52aSThomas Gleixner 	raw_spin_lock(&cpu_base->lock);
126621d6d52aSThomas Gleixner 	entry_time = now = hrtimer_update_base(cpu_base);
126721d6d52aSThomas Gleixner retry:
126821d6d52aSThomas Gleixner 	cpu_base->in_hrtirq = 1;
126921d6d52aSThomas Gleixner 	/*
127021d6d52aSThomas Gleixner 	 * We set expires_next to KTIME_MAX here with cpu_base->lock
127121d6d52aSThomas Gleixner 	 * held to prevent that a timer is enqueued in our queue via
127221d6d52aSThomas Gleixner 	 * the migration code. This does not affect enqueueing of
127321d6d52aSThomas Gleixner 	 * timers which run their callback and need to be requeued on
127421d6d52aSThomas Gleixner 	 * this CPU.
127521d6d52aSThomas Gleixner 	 */
12762456e855SThomas Gleixner 	cpu_base->expires_next = KTIME_MAX;
127721d6d52aSThomas Gleixner 
127821d6d52aSThomas Gleixner 	__hrtimer_run_queues(cpu_base, now);
127921d6d52aSThomas Gleixner 
12809bc74919SThomas Gleixner 	/* Reevaluate the clock bases for the next expiry */
12819bc74919SThomas Gleixner 	expires_next = __hrtimer_get_next_event(cpu_base);
12825cee9645SThomas Gleixner 	/*
12835cee9645SThomas Gleixner 	 * Store the new expiry value so the migration code can verify
12845cee9645SThomas Gleixner 	 * against it.
12855cee9645SThomas Gleixner 	 */
12865cee9645SThomas Gleixner 	cpu_base->expires_next = expires_next;
12879bc74919SThomas Gleixner 	cpu_base->in_hrtirq = 0;
12885cee9645SThomas Gleixner 	raw_spin_unlock(&cpu_base->lock);
12895cee9645SThomas Gleixner 
12905cee9645SThomas Gleixner 	/* Reprogramming necessary ? */
1291d2540875SViresh Kumar 	if (!tick_program_event(expires_next, 0)) {
12925cee9645SThomas Gleixner 		cpu_base->hang_detected = 0;
12935cee9645SThomas Gleixner 		return;
12945cee9645SThomas Gleixner 	}
12955cee9645SThomas Gleixner 
12965cee9645SThomas Gleixner 	/*
12975cee9645SThomas Gleixner 	 * The next timer was already expired due to:
12985cee9645SThomas Gleixner 	 * - tracing
12995cee9645SThomas Gleixner 	 * - long lasting callbacks
13005cee9645SThomas Gleixner 	 * - being scheduled away when running in a VM
13015cee9645SThomas Gleixner 	 *
13025cee9645SThomas Gleixner 	 * We need to prevent that we loop forever in the hrtimer
13035cee9645SThomas Gleixner 	 * interrupt routine. We give it 3 attempts to avoid
13045cee9645SThomas Gleixner 	 * overreacting on some spurious event.
13055cee9645SThomas Gleixner 	 *
13065cee9645SThomas Gleixner 	 * Acquire base lock for updating the offsets and retrieving
13075cee9645SThomas Gleixner 	 * the current time.
13085cee9645SThomas Gleixner 	 */
13095cee9645SThomas Gleixner 	raw_spin_lock(&cpu_base->lock);
13105cee9645SThomas Gleixner 	now = hrtimer_update_base(cpu_base);
13115cee9645SThomas Gleixner 	cpu_base->nr_retries++;
13125cee9645SThomas Gleixner 	if (++retries < 3)
13135cee9645SThomas Gleixner 		goto retry;
13145cee9645SThomas Gleixner 	/*
13155cee9645SThomas Gleixner 	 * Give the system a chance to do something else than looping
13165cee9645SThomas Gleixner 	 * here. We stored the entry time, so we know exactly how long
13175cee9645SThomas Gleixner 	 * we spent here. We schedule the next event this amount of
13185cee9645SThomas Gleixner 	 * time away.
13195cee9645SThomas Gleixner 	 */
13205cee9645SThomas Gleixner 	cpu_base->nr_hangs++;
13215cee9645SThomas Gleixner 	cpu_base->hang_detected = 1;
13225cee9645SThomas Gleixner 	raw_spin_unlock(&cpu_base->lock);
13235cee9645SThomas Gleixner 	delta = ktime_sub(now, entry_time);
13242456e855SThomas Gleixner 	if ((unsigned int)delta > cpu_base->max_hang_time)
13252456e855SThomas Gleixner 		cpu_base->max_hang_time = (unsigned int) delta;
13265cee9645SThomas Gleixner 	/*
13275cee9645SThomas Gleixner 	 * Limit it to a sensible value as we enforce a longer
13285cee9645SThomas Gleixner 	 * delay. Give the CPU at least 100ms to catch up.
13295cee9645SThomas Gleixner 	 */
13302456e855SThomas Gleixner 	if (delta > 100 * NSEC_PER_MSEC)
13315cee9645SThomas Gleixner 		expires_next = ktime_add_ns(now, 100 * NSEC_PER_MSEC);
13325cee9645SThomas Gleixner 	else
13335cee9645SThomas Gleixner 		expires_next = ktime_add(now, delta);
13345cee9645SThomas Gleixner 	tick_program_event(expires_next, 1);
13355cee9645SThomas Gleixner 	printk_once(KERN_WARNING "hrtimer: interrupt took %llu ns\n",
13365cee9645SThomas Gleixner 		    ktime_to_ns(delta));
13375cee9645SThomas Gleixner }
13385cee9645SThomas Gleixner 
1339016da201SStephen Boyd /* called with interrupts disabled */
1340c6eb3f70SThomas Gleixner static inline void __hrtimer_peek_ahead_timers(void)
13415cee9645SThomas Gleixner {
13425cee9645SThomas Gleixner 	struct tick_device *td;
13435cee9645SThomas Gleixner 
13445cee9645SThomas Gleixner 	if (!hrtimer_hres_active())
13455cee9645SThomas Gleixner 		return;
13465cee9645SThomas Gleixner 
134722127e93SChristoph Lameter 	td = this_cpu_ptr(&tick_cpu_device);
13485cee9645SThomas Gleixner 	if (td && td->evtdev)
13495cee9645SThomas Gleixner 		hrtimer_interrupt(td->evtdev);
13505cee9645SThomas Gleixner }
13515cee9645SThomas Gleixner 
13525cee9645SThomas Gleixner #else /* CONFIG_HIGH_RES_TIMERS */
13535cee9645SThomas Gleixner 
13545cee9645SThomas Gleixner static inline void __hrtimer_peek_ahead_timers(void) { }
13555cee9645SThomas Gleixner 
13565cee9645SThomas Gleixner #endif	/* !CONFIG_HIGH_RES_TIMERS */
13575cee9645SThomas Gleixner 
13585cee9645SThomas Gleixner /*
1359c6eb3f70SThomas Gleixner  * Called from run_local_timers in hardirq context every jiffy
13605cee9645SThomas Gleixner  */
13615cee9645SThomas Gleixner void hrtimer_run_queues(void)
13625cee9645SThomas Gleixner {
1363dc5df73bSChristoph Lameter 	struct hrtimer_cpu_base *cpu_base = this_cpu_ptr(&hrtimer_bases);
136421d6d52aSThomas Gleixner 	ktime_t now;
13655cee9645SThomas Gleixner 
1366e19ffe8bSThomas Gleixner 	if (__hrtimer_hres_active(cpu_base))
13675cee9645SThomas Gleixner 		return;
13685cee9645SThomas Gleixner 
1369c6eb3f70SThomas Gleixner 	/*
1370c6eb3f70SThomas Gleixner 	 * This _is_ ugly: We have to check periodically, whether we
1371c6eb3f70SThomas Gleixner 	 * can switch to highres and / or nohz mode. The clocksource
1372c6eb3f70SThomas Gleixner 	 * switch happens with xtime_lock held. Notification from
1373c6eb3f70SThomas Gleixner 	 * there only sets the check bit in the tick_oneshot code,
1374c6eb3f70SThomas Gleixner 	 * otherwise we might deadlock vs. xtime_lock.
1375c6eb3f70SThomas Gleixner 	 */
1376c6eb3f70SThomas Gleixner 	if (tick_check_oneshot_change(!hrtimer_is_hres_enabled())) {
1377c6eb3f70SThomas Gleixner 		hrtimer_switch_to_hres();
1378c6eb3f70SThomas Gleixner 		return;
13795cee9645SThomas Gleixner 	}
13805cee9645SThomas Gleixner 
13815cee9645SThomas Gleixner 	raw_spin_lock(&cpu_base->lock);
138221d6d52aSThomas Gleixner 	now = hrtimer_update_base(cpu_base);
138321d6d52aSThomas Gleixner 	__hrtimer_run_queues(cpu_base, now);
13845cee9645SThomas Gleixner 	raw_spin_unlock(&cpu_base->lock);
13855cee9645SThomas Gleixner }
13865cee9645SThomas Gleixner 
13875cee9645SThomas Gleixner /*
13885cee9645SThomas Gleixner  * Sleep related functions:
13895cee9645SThomas Gleixner  */
13905cee9645SThomas Gleixner static enum hrtimer_restart hrtimer_wakeup(struct hrtimer *timer)
13915cee9645SThomas Gleixner {
13925cee9645SThomas Gleixner 	struct hrtimer_sleeper *t =
13935cee9645SThomas Gleixner 		container_of(timer, struct hrtimer_sleeper, timer);
13945cee9645SThomas Gleixner 	struct task_struct *task = t->task;
13955cee9645SThomas Gleixner 
13965cee9645SThomas Gleixner 	t->task = NULL;
13975cee9645SThomas Gleixner 	if (task)
13985cee9645SThomas Gleixner 		wake_up_process(task);
13995cee9645SThomas Gleixner 
14005cee9645SThomas Gleixner 	return HRTIMER_NORESTART;
14015cee9645SThomas Gleixner }
14025cee9645SThomas Gleixner 
14035cee9645SThomas Gleixner void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, struct task_struct *task)
14045cee9645SThomas Gleixner {
14055cee9645SThomas Gleixner 	sl->timer.function = hrtimer_wakeup;
14065cee9645SThomas Gleixner 	sl->task = task;
14075cee9645SThomas Gleixner }
14085cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(hrtimer_init_sleeper);
14095cee9645SThomas Gleixner 
1410c0edd7c9SDeepa Dinamani int nanosleep_copyout(struct restart_block *restart, struct timespec64 *ts)
1411ce41aaf4SAl Viro {
1412ce41aaf4SAl Viro 	switch(restart->nanosleep.type) {
1413ce41aaf4SAl Viro #ifdef CONFIG_COMPAT
1414ce41aaf4SAl Viro 	case TT_COMPAT:
1415c0edd7c9SDeepa Dinamani 		if (compat_put_timespec64(ts, restart->nanosleep.compat_rmtp))
1416ce41aaf4SAl Viro 			return -EFAULT;
1417ce41aaf4SAl Viro 		break;
1418ce41aaf4SAl Viro #endif
1419ce41aaf4SAl Viro 	case TT_NATIVE:
1420c0edd7c9SDeepa Dinamani 		if (put_timespec64(ts, restart->nanosleep.rmtp))
1421ce41aaf4SAl Viro 			return -EFAULT;
1422ce41aaf4SAl Viro 		break;
1423ce41aaf4SAl Viro 	default:
1424ce41aaf4SAl Viro 		BUG();
1425ce41aaf4SAl Viro 	}
1426ce41aaf4SAl Viro 	return -ERESTART_RESTARTBLOCK;
1427ce41aaf4SAl Viro }
1428ce41aaf4SAl Viro 
14295cee9645SThomas Gleixner static int __sched do_nanosleep(struct hrtimer_sleeper *t, enum hrtimer_mode mode)
14305cee9645SThomas Gleixner {
1431edbeda46SAl Viro 	struct restart_block *restart;
1432edbeda46SAl Viro 
14335cee9645SThomas Gleixner 	hrtimer_init_sleeper(t, current);
14345cee9645SThomas Gleixner 
14355cee9645SThomas Gleixner 	do {
14365cee9645SThomas Gleixner 		set_current_state(TASK_INTERRUPTIBLE);
14375cee9645SThomas Gleixner 		hrtimer_start_expires(&t->timer, mode);
14385cee9645SThomas Gleixner 
14395cee9645SThomas Gleixner 		if (likely(t->task))
14405cee9645SThomas Gleixner 			freezable_schedule();
14415cee9645SThomas Gleixner 
14425cee9645SThomas Gleixner 		hrtimer_cancel(&t->timer);
14435cee9645SThomas Gleixner 		mode = HRTIMER_MODE_ABS;
14445cee9645SThomas Gleixner 
14455cee9645SThomas Gleixner 	} while (t->task && !signal_pending(current));
14465cee9645SThomas Gleixner 
14475cee9645SThomas Gleixner 	__set_current_state(TASK_RUNNING);
14485cee9645SThomas Gleixner 
1449a7602681SAl Viro 	if (!t->task)
1450a7602681SAl Viro 		return 0;
14515cee9645SThomas Gleixner 
1452edbeda46SAl Viro 	restart = &current->restart_block;
1453edbeda46SAl Viro 	if (restart->nanosleep.type != TT_NONE) {
1454a7602681SAl Viro 		ktime_t rem = hrtimer_expires_remaining(&t->timer);
1455c0edd7c9SDeepa Dinamani 		struct timespec64 rmt;
1456edbeda46SAl Viro 
14572456e855SThomas Gleixner 		if (rem <= 0)
14585cee9645SThomas Gleixner 			return 0;
1459c0edd7c9SDeepa Dinamani 		rmt = ktime_to_timespec64(rem);
14605cee9645SThomas Gleixner 
1461ce41aaf4SAl Viro 		return nanosleep_copyout(restart, &rmt);
1462a7602681SAl Viro 	}
1463a7602681SAl Viro 	return -ERESTART_RESTARTBLOCK;
14645cee9645SThomas Gleixner }
14655cee9645SThomas Gleixner 
1466fb923c4aSAl Viro static long __sched hrtimer_nanosleep_restart(struct restart_block *restart)
14675cee9645SThomas Gleixner {
14685cee9645SThomas Gleixner 	struct hrtimer_sleeper t;
1469a7602681SAl Viro 	int ret;
14705cee9645SThomas Gleixner 
14715cee9645SThomas Gleixner 	hrtimer_init_on_stack(&t.timer, restart->nanosleep.clockid,
14725cee9645SThomas Gleixner 				HRTIMER_MODE_ABS);
14735cee9645SThomas Gleixner 	hrtimer_set_expires_tv64(&t.timer, restart->nanosleep.expires);
14745cee9645SThomas Gleixner 
1475a7602681SAl Viro 	ret = do_nanosleep(&t, HRTIMER_MODE_ABS);
14765cee9645SThomas Gleixner 	destroy_hrtimer_on_stack(&t.timer);
14775cee9645SThomas Gleixner 	return ret;
14785cee9645SThomas Gleixner }
14795cee9645SThomas Gleixner 
1480938e7cf2SThomas Gleixner long hrtimer_nanosleep(const struct timespec64 *rqtp,
14815cee9645SThomas Gleixner 		       const enum hrtimer_mode mode, const clockid_t clockid)
14825cee9645SThomas Gleixner {
1483a7602681SAl Viro 	struct restart_block *restart;
14845cee9645SThomas Gleixner 	struct hrtimer_sleeper t;
14855cee9645SThomas Gleixner 	int ret = 0;
1486da8b44d5SJohn Stultz 	u64 slack;
14875cee9645SThomas Gleixner 
14885cee9645SThomas Gleixner 	slack = current->timer_slack_ns;
14895cee9645SThomas Gleixner 	if (dl_task(current) || rt_task(current))
14905cee9645SThomas Gleixner 		slack = 0;
14915cee9645SThomas Gleixner 
14925cee9645SThomas Gleixner 	hrtimer_init_on_stack(&t.timer, clockid, mode);
1493ad196384SDeepa Dinamani 	hrtimer_set_expires_range_ns(&t.timer, timespec64_to_ktime(*rqtp), slack);
1494a7602681SAl Viro 	ret = do_nanosleep(&t, mode);
1495a7602681SAl Viro 	if (ret != -ERESTART_RESTARTBLOCK)
14965cee9645SThomas Gleixner 		goto out;
14975cee9645SThomas Gleixner 
14985cee9645SThomas Gleixner 	/* Absolute timers do not update the rmtp value and restart: */
14995cee9645SThomas Gleixner 	if (mode == HRTIMER_MODE_ABS) {
15005cee9645SThomas Gleixner 		ret = -ERESTARTNOHAND;
15015cee9645SThomas Gleixner 		goto out;
15025cee9645SThomas Gleixner 	}
15035cee9645SThomas Gleixner 
1504a7602681SAl Viro 	restart = &current->restart_block;
15055cee9645SThomas Gleixner 	restart->fn = hrtimer_nanosleep_restart;
15065cee9645SThomas Gleixner 	restart->nanosleep.clockid = t.timer.base->clockid;
15075cee9645SThomas Gleixner 	restart->nanosleep.expires = hrtimer_get_expires_tv64(&t.timer);
15085cee9645SThomas Gleixner out:
15095cee9645SThomas Gleixner 	destroy_hrtimer_on_stack(&t.timer);
15105cee9645SThomas Gleixner 	return ret;
15115cee9645SThomas Gleixner }
15125cee9645SThomas Gleixner 
15135cee9645SThomas Gleixner SYSCALL_DEFINE2(nanosleep, struct timespec __user *, rqtp,
15145cee9645SThomas Gleixner 		struct timespec __user *, rmtp)
15155cee9645SThomas Gleixner {
1516c0edd7c9SDeepa Dinamani 	struct timespec64 tu;
15175cee9645SThomas Gleixner 
1518c0edd7c9SDeepa Dinamani 	if (get_timespec64(&tu, rqtp))
15195cee9645SThomas Gleixner 		return -EFAULT;
15205cee9645SThomas Gleixner 
1521c0edd7c9SDeepa Dinamani 	if (!timespec64_valid(&tu))
15225cee9645SThomas Gleixner 		return -EINVAL;
15235cee9645SThomas Gleixner 
1524edbeda46SAl Viro 	current->restart_block.nanosleep.type = rmtp ? TT_NATIVE : TT_NONE;
1525192a82f9SAl Viro 	current->restart_block.nanosleep.rmtp = rmtp;
1526c0edd7c9SDeepa Dinamani 	return hrtimer_nanosleep(&tu, HRTIMER_MODE_REL, CLOCK_MONOTONIC);
15275cee9645SThomas Gleixner }
15285cee9645SThomas Gleixner 
1529edbeda46SAl Viro #ifdef CONFIG_COMPAT
1530edbeda46SAl Viro 
1531edbeda46SAl Viro COMPAT_SYSCALL_DEFINE2(nanosleep, struct compat_timespec __user *, rqtp,
1532edbeda46SAl Viro 		       struct compat_timespec __user *, rmtp)
1533edbeda46SAl Viro {
1534c0edd7c9SDeepa Dinamani 	struct timespec64 tu;
1535edbeda46SAl Viro 
1536c0edd7c9SDeepa Dinamani 	if (compat_get_timespec64(&tu, rqtp))
1537edbeda46SAl Viro 		return -EFAULT;
1538edbeda46SAl Viro 
1539c0edd7c9SDeepa Dinamani 	if (!timespec64_valid(&tu))
1540edbeda46SAl Viro 		return -EINVAL;
1541edbeda46SAl Viro 
1542edbeda46SAl Viro 	current->restart_block.nanosleep.type = rmtp ? TT_COMPAT : TT_NONE;
1543edbeda46SAl Viro 	current->restart_block.nanosleep.compat_rmtp = rmtp;
1544c0edd7c9SDeepa Dinamani 	return hrtimer_nanosleep(&tu, HRTIMER_MODE_REL, CLOCK_MONOTONIC);
1545edbeda46SAl Viro }
1546edbeda46SAl Viro #endif
1547edbeda46SAl Viro 
15485cee9645SThomas Gleixner /*
15495cee9645SThomas Gleixner  * Functions related to boot-time initialization:
15505cee9645SThomas Gleixner  */
155127590dc1SThomas Gleixner int hrtimers_prepare_cpu(unsigned int cpu)
15525cee9645SThomas Gleixner {
15535cee9645SThomas Gleixner 	struct hrtimer_cpu_base *cpu_base = &per_cpu(hrtimer_bases, cpu);
15545cee9645SThomas Gleixner 	int i;
15555cee9645SThomas Gleixner 
15565cee9645SThomas Gleixner 	for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
15575cee9645SThomas Gleixner 		cpu_base->clock_base[i].cpu_base = cpu_base;
15585cee9645SThomas Gleixner 		timerqueue_init_head(&cpu_base->clock_base[i].active);
15595cee9645SThomas Gleixner 	}
15605cee9645SThomas Gleixner 
1561cddd0248SViresh Kumar 	cpu_base->cpu = cpu;
156228bfd18bSAnna-Maria Gleixner 	cpu_base->hres_active = 0;
156307a9a7eaSAnna-Maria Gleixner 	cpu_base->expires_next = KTIME_MAX;
156427590dc1SThomas Gleixner 	return 0;
15655cee9645SThomas Gleixner }
15665cee9645SThomas Gleixner 
15675cee9645SThomas Gleixner #ifdef CONFIG_HOTPLUG_CPU
15685cee9645SThomas Gleixner 
15695cee9645SThomas Gleixner static void migrate_hrtimer_list(struct hrtimer_clock_base *old_base,
15705cee9645SThomas Gleixner 				struct hrtimer_clock_base *new_base)
15715cee9645SThomas Gleixner {
15725cee9645SThomas Gleixner 	struct hrtimer *timer;
15735cee9645SThomas Gleixner 	struct timerqueue_node *node;
15745cee9645SThomas Gleixner 
15755cee9645SThomas Gleixner 	while ((node = timerqueue_getnext(&old_base->active))) {
15765cee9645SThomas Gleixner 		timer = container_of(node, struct hrtimer, node);
15775cee9645SThomas Gleixner 		BUG_ON(hrtimer_callback_running(timer));
15785cee9645SThomas Gleixner 		debug_deactivate(timer);
15795cee9645SThomas Gleixner 
15805cee9645SThomas Gleixner 		/*
1581c04dca02SOleg Nesterov 		 * Mark it as ENQUEUED not INACTIVE otherwise the
15825cee9645SThomas Gleixner 		 * timer could be seen as !active and just vanish away
15835cee9645SThomas Gleixner 		 * under us on another CPU
15845cee9645SThomas Gleixner 		 */
1585c04dca02SOleg Nesterov 		__remove_hrtimer(timer, old_base, HRTIMER_STATE_ENQUEUED, 0);
15865cee9645SThomas Gleixner 		timer->base = new_base;
15875cee9645SThomas Gleixner 		/*
15885cee9645SThomas Gleixner 		 * Enqueue the timers on the new cpu. This does not
15895cee9645SThomas Gleixner 		 * reprogram the event device in case the timer
15905cee9645SThomas Gleixner 		 * expires before the earliest on this CPU, but we run
15915cee9645SThomas Gleixner 		 * hrtimer_interrupt after we migrated everything to
15925cee9645SThomas Gleixner 		 * sort out already expired timers and reprogram the
15935cee9645SThomas Gleixner 		 * event device.
15945cee9645SThomas Gleixner 		 */
159563e2ed36SAnna-Maria Gleixner 		enqueue_hrtimer(timer, new_base, HRTIMER_MODE_ABS);
15965cee9645SThomas Gleixner 	}
15975cee9645SThomas Gleixner }
15985cee9645SThomas Gleixner 
159927590dc1SThomas Gleixner int hrtimers_dead_cpu(unsigned int scpu)
16005cee9645SThomas Gleixner {
16015cee9645SThomas Gleixner 	struct hrtimer_cpu_base *old_base, *new_base;
16025cee9645SThomas Gleixner 	int i;
16035cee9645SThomas Gleixner 
16045cee9645SThomas Gleixner 	BUG_ON(cpu_online(scpu));
16055cee9645SThomas Gleixner 	tick_cancel_sched_timer(scpu);
16065cee9645SThomas Gleixner 
16075cee9645SThomas Gleixner 	local_irq_disable();
16085cee9645SThomas Gleixner 	old_base = &per_cpu(hrtimer_bases, scpu);
1609dc5df73bSChristoph Lameter 	new_base = this_cpu_ptr(&hrtimer_bases);
16105cee9645SThomas Gleixner 	/*
16115cee9645SThomas Gleixner 	 * The caller is globally serialized and nobody else
16125cee9645SThomas Gleixner 	 * takes two locks at once, deadlock is not possible.
16135cee9645SThomas Gleixner 	 */
16145cee9645SThomas Gleixner 	raw_spin_lock(&new_base->lock);
16155cee9645SThomas Gleixner 	raw_spin_lock_nested(&old_base->lock, SINGLE_DEPTH_NESTING);
16165cee9645SThomas Gleixner 
16175cee9645SThomas Gleixner 	for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
16185cee9645SThomas Gleixner 		migrate_hrtimer_list(&old_base->clock_base[i],
16195cee9645SThomas Gleixner 				     &new_base->clock_base[i]);
16205cee9645SThomas Gleixner 	}
16215cee9645SThomas Gleixner 
16225cee9645SThomas Gleixner 	raw_spin_unlock(&old_base->lock);
16235cee9645SThomas Gleixner 	raw_spin_unlock(&new_base->lock);
16245cee9645SThomas Gleixner 
16255cee9645SThomas Gleixner 	/* Check, if we got expired work to do */
16265cee9645SThomas Gleixner 	__hrtimer_peek_ahead_timers();
16275cee9645SThomas Gleixner 	local_irq_enable();
162827590dc1SThomas Gleixner 	return 0;
16295cee9645SThomas Gleixner }
16305cee9645SThomas Gleixner 
16315cee9645SThomas Gleixner #endif /* CONFIG_HOTPLUG_CPU */
16325cee9645SThomas Gleixner 
16335cee9645SThomas Gleixner void __init hrtimers_init(void)
16345cee9645SThomas Gleixner {
163527590dc1SThomas Gleixner 	hrtimers_prepare_cpu(smp_processor_id());
16365cee9645SThomas Gleixner }
16375cee9645SThomas Gleixner 
16385cee9645SThomas Gleixner /**
16395cee9645SThomas Gleixner  * schedule_hrtimeout_range_clock - sleep until timeout
16405cee9645SThomas Gleixner  * @expires:	timeout value (ktime_t)
16415cee9645SThomas Gleixner  * @delta:	slack in expires timeout (ktime_t)
164290777713SAnna-Maria Gleixner  * @mode:	timer mode
164390777713SAnna-Maria Gleixner  * @clock_id:	timer clock to be used
16445cee9645SThomas Gleixner  */
16455cee9645SThomas Gleixner int __sched
1646da8b44d5SJohn Stultz schedule_hrtimeout_range_clock(ktime_t *expires, u64 delta,
164790777713SAnna-Maria Gleixner 			       const enum hrtimer_mode mode, clockid_t clock_id)
16485cee9645SThomas Gleixner {
16495cee9645SThomas Gleixner 	struct hrtimer_sleeper t;
16505cee9645SThomas Gleixner 
16515cee9645SThomas Gleixner 	/*
16525cee9645SThomas Gleixner 	 * Optimize when a zero timeout value is given. It does not
16535cee9645SThomas Gleixner 	 * matter whether this is an absolute or a relative time.
16545cee9645SThomas Gleixner 	 */
16552456e855SThomas Gleixner 	if (expires && *expires == 0) {
16565cee9645SThomas Gleixner 		__set_current_state(TASK_RUNNING);
16575cee9645SThomas Gleixner 		return 0;
16585cee9645SThomas Gleixner 	}
16595cee9645SThomas Gleixner 
16605cee9645SThomas Gleixner 	/*
16615cee9645SThomas Gleixner 	 * A NULL parameter means "infinite"
16625cee9645SThomas Gleixner 	 */
16635cee9645SThomas Gleixner 	if (!expires) {
16645cee9645SThomas Gleixner 		schedule();
16655cee9645SThomas Gleixner 		return -EINTR;
16665cee9645SThomas Gleixner 	}
16675cee9645SThomas Gleixner 
166890777713SAnna-Maria Gleixner 	hrtimer_init_on_stack(&t.timer, clock_id, mode);
16695cee9645SThomas Gleixner 	hrtimer_set_expires_range_ns(&t.timer, *expires, delta);
16705cee9645SThomas Gleixner 
16715cee9645SThomas Gleixner 	hrtimer_init_sleeper(&t, current);
16725cee9645SThomas Gleixner 
16735cee9645SThomas Gleixner 	hrtimer_start_expires(&t.timer, mode);
16745cee9645SThomas Gleixner 
16755cee9645SThomas Gleixner 	if (likely(t.task))
16765cee9645SThomas Gleixner 		schedule();
16775cee9645SThomas Gleixner 
16785cee9645SThomas Gleixner 	hrtimer_cancel(&t.timer);
16795cee9645SThomas Gleixner 	destroy_hrtimer_on_stack(&t.timer);
16805cee9645SThomas Gleixner 
16815cee9645SThomas Gleixner 	__set_current_state(TASK_RUNNING);
16825cee9645SThomas Gleixner 
16835cee9645SThomas Gleixner 	return !t.task ? 0 : -EINTR;
16845cee9645SThomas Gleixner }
16855cee9645SThomas Gleixner 
16865cee9645SThomas Gleixner /**
16875cee9645SThomas Gleixner  * schedule_hrtimeout_range - sleep until timeout
16885cee9645SThomas Gleixner  * @expires:	timeout value (ktime_t)
16895cee9645SThomas Gleixner  * @delta:	slack in expires timeout (ktime_t)
169090777713SAnna-Maria Gleixner  * @mode:	timer mode
16915cee9645SThomas Gleixner  *
16925cee9645SThomas Gleixner  * Make the current task sleep until the given expiry time has
16935cee9645SThomas Gleixner  * elapsed. The routine will return immediately unless
16945cee9645SThomas Gleixner  * the current task state has been set (see set_current_state()).
16955cee9645SThomas Gleixner  *
16965cee9645SThomas Gleixner  * The @delta argument gives the kernel the freedom to schedule the
16975cee9645SThomas Gleixner  * actual wakeup to a time that is both power and performance friendly.
16985cee9645SThomas Gleixner  * The kernel give the normal best effort behavior for "@expires+@delta",
16995cee9645SThomas Gleixner  * but may decide to fire the timer earlier, but no earlier than @expires.
17005cee9645SThomas Gleixner  *
17015cee9645SThomas Gleixner  * You can set the task state as follows -
17025cee9645SThomas Gleixner  *
17035cee9645SThomas Gleixner  * %TASK_UNINTERRUPTIBLE - at least @timeout time is guaranteed to
17044b7e9cf9SDouglas Anderson  * pass before the routine returns unless the current task is explicitly
17054b7e9cf9SDouglas Anderson  * woken up, (e.g. by wake_up_process()).
17065cee9645SThomas Gleixner  *
17075cee9645SThomas Gleixner  * %TASK_INTERRUPTIBLE - the routine may return early if a signal is
17084b7e9cf9SDouglas Anderson  * delivered to the current task or the current task is explicitly woken
17094b7e9cf9SDouglas Anderson  * up.
17105cee9645SThomas Gleixner  *
17115cee9645SThomas Gleixner  * The current task state is guaranteed to be TASK_RUNNING when this
17125cee9645SThomas Gleixner  * routine returns.
17135cee9645SThomas Gleixner  *
17144b7e9cf9SDouglas Anderson  * Returns 0 when the timer has expired. If the task was woken before the
17154b7e9cf9SDouglas Anderson  * timer expired by a signal (only possible in state TASK_INTERRUPTIBLE) or
17164b7e9cf9SDouglas Anderson  * by an explicit wakeup, it returns -EINTR.
17175cee9645SThomas Gleixner  */
1718da8b44d5SJohn Stultz int __sched schedule_hrtimeout_range(ktime_t *expires, u64 delta,
17195cee9645SThomas Gleixner 				     const enum hrtimer_mode mode)
17205cee9645SThomas Gleixner {
17215cee9645SThomas Gleixner 	return schedule_hrtimeout_range_clock(expires, delta, mode,
17225cee9645SThomas Gleixner 					      CLOCK_MONOTONIC);
17235cee9645SThomas Gleixner }
17245cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(schedule_hrtimeout_range);
17255cee9645SThomas Gleixner 
17265cee9645SThomas Gleixner /**
17275cee9645SThomas Gleixner  * schedule_hrtimeout - sleep until timeout
17285cee9645SThomas Gleixner  * @expires:	timeout value (ktime_t)
172990777713SAnna-Maria Gleixner  * @mode:	timer mode
17305cee9645SThomas Gleixner  *
17315cee9645SThomas Gleixner  * Make the current task sleep until the given expiry time has
17325cee9645SThomas Gleixner  * elapsed. The routine will return immediately unless
17335cee9645SThomas Gleixner  * the current task state has been set (see set_current_state()).
17345cee9645SThomas Gleixner  *
17355cee9645SThomas Gleixner  * You can set the task state as follows -
17365cee9645SThomas Gleixner  *
17375cee9645SThomas Gleixner  * %TASK_UNINTERRUPTIBLE - at least @timeout time is guaranteed to
17384b7e9cf9SDouglas Anderson  * pass before the routine returns unless the current task is explicitly
17394b7e9cf9SDouglas Anderson  * woken up, (e.g. by wake_up_process()).
17405cee9645SThomas Gleixner  *
17415cee9645SThomas Gleixner  * %TASK_INTERRUPTIBLE - the routine may return early if a signal is
17424b7e9cf9SDouglas Anderson  * delivered to the current task or the current task is explicitly woken
17434b7e9cf9SDouglas Anderson  * up.
17445cee9645SThomas Gleixner  *
17455cee9645SThomas Gleixner  * The current task state is guaranteed to be TASK_RUNNING when this
17465cee9645SThomas Gleixner  * routine returns.
17475cee9645SThomas Gleixner  *
17484b7e9cf9SDouglas Anderson  * Returns 0 when the timer has expired. If the task was woken before the
17494b7e9cf9SDouglas Anderson  * timer expired by a signal (only possible in state TASK_INTERRUPTIBLE) or
17504b7e9cf9SDouglas Anderson  * by an explicit wakeup, it returns -EINTR.
17515cee9645SThomas Gleixner  */
17525cee9645SThomas Gleixner int __sched schedule_hrtimeout(ktime_t *expires,
17535cee9645SThomas Gleixner 			       const enum hrtimer_mode mode)
17545cee9645SThomas Gleixner {
17555cee9645SThomas Gleixner 	return schedule_hrtimeout_range(expires, 0, mode);
17565cee9645SThomas Gleixner }
17575cee9645SThomas Gleixner EXPORT_SYMBOL_GPL(schedule_hrtimeout);
1758