blob: c98c6539e2c2d40cf6a134b7fb33c50accc90d76 [file] [log] [blame]
Thomas Gleixnerc0a31322006-01-09 20:52:32 -08001/*
2 * include/linux/hrtimer.h
3 *
4 * hrtimers - High-resolution kernel timers
5 *
6 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
7 * Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
8 *
9 * data type definitions, declarations, prototypes
10 *
11 * Started by: Thomas Gleixner and Ingo Molnar
12 *
13 * For licencing details see kernel-base/COPYING
14 */
15#ifndef _LINUX_HRTIMER_H
16#define _LINUX_HRTIMER_H
17
18#include <linux/rbtree.h>
19#include <linux/ktime.h>
20#include <linux/init.h>
21#include <linux/list.h>
22#include <linux/wait.h>
Stephen Rothwell40b86062008-10-15 14:20:28 +110023#include <linux/percpu.h>
Heiko Carstens507e1232009-06-23 17:38:15 +020024#include <linux/timer.h>
John Stultz998adc32010-09-20 19:19:17 -070025#include <linux/timerqueue.h>
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080026
Thomas Gleixner3c8aa392007-02-16 01:27:50 -080027struct hrtimer_clock_base;
28struct hrtimer_cpu_base;
29
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080030/*
31 * Mode arguments of xxx_hrtimer functions:
32 */
33enum hrtimer_mode {
Arun R Bharadwaj597d0272009-04-16 12:13:26 +053034 HRTIMER_MODE_ABS = 0x0, /* Time value is absolute */
35 HRTIMER_MODE_REL = 0x1, /* Time value is relative to now */
36 HRTIMER_MODE_PINNED = 0x02, /* Timer is bound to CPU */
37 HRTIMER_MODE_ABS_PINNED = 0x02,
38 HRTIMER_MODE_REL_PINNED = 0x03,
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080039};
40
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -080041/*
42 * Return values for the callback function
43 */
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080044enum hrtimer_restart {
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -080045 HRTIMER_NORESTART, /* Timer is not restarted */
46 HRTIMER_RESTART, /* Timer must be restarted */
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080047};
48
Thomas Gleixner303e9672007-02-16 01:27:51 -080049/*
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -080050 * Values to track state of the timer
Thomas Gleixner303e9672007-02-16 01:27:51 -080051 *
52 * Possible states:
53 *
54 * 0x00 inactive
55 * 0x01 enqueued into rbtree
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -080056 *
Peter Zijlstra887d9dc2015-06-11 14:46:48 +020057 * The callback state is not part of the timer->state because clearing it would
58 * mean touching the timer after the callback, this makes it impossible to free
59 * the timer from the callback function.
Thomas Gleixner53370d22011-03-10 18:26:33 +010060 *
Peter Zijlstra887d9dc2015-06-11 14:46:48 +020061 * Therefore we track the callback state in:
62 *
63 * timer->base->cpu_base->running == timer
64 *
65 * On SMP it is possible to have a "callback function running and enqueued"
66 * status. It happens for example when a posix timer expired and the callback
Thomas Gleixner303e9672007-02-16 01:27:51 -080067 * queued a signal. Between dropping the lock which protects the posix timer
68 * and reacquiring the base lock of the hrtimer, another CPU can deliver the
Peter Zijlstra887d9dc2015-06-11 14:46:48 +020069 * signal and rearm the timer.
Thomas Gleixner303e9672007-02-16 01:27:51 -080070 *
71 * All state transitions are protected by cpu_base->lock.
72 */
73#define HRTIMER_STATE_INACTIVE 0x00
74#define HRTIMER_STATE_ENQUEUED 0x01
Thomas Gleixner303e9672007-02-16 01:27:51 -080075
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080076/**
77 * struct hrtimer - the basic hrtimer structure
John Stultz998adc32010-09-20 19:19:17 -070078 * @node: timerqueue node, which also manages node.expires,
79 * the absolute expiry time in the hrtimers internal
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080080 * representation. The time is related to the clock on
Thomas Gleixner592aa992008-10-20 16:38:19 +020081 * which the timer is based. Is setup by adding
82 * slack to the _softexpires value. For non range timers
83 * identical to _softexpires.
84 * @_softexpires: the absolute earliest expiry time of the hrtimer.
85 * The time which was given as expiry time when the timer
86 * was armed.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080087 * @function: timer expiry callback function
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080088 * @base: pointer to the timer base (per cpu and per clock)
Thomas Gleixner303e9672007-02-16 01:27:51 -080089 * @state: state information (See bit values above)
Thomas Gleixner203cbf72016-01-14 16:54:46 +000090 * @is_rel: Set if the timer was armed relative
91 * @start_pid: timer statistics field to store the pid of the task which
Viresh Kumare2e680f2014-03-19 16:21:33 +053092 * started the timer
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -080093 * @start_site: timer statistics field to store the site where the timer
94 * was started
95 * @start_comm: timer statistics field to store the name of the process which
96 * started the timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080097 *
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -080098 * The hrtimer structure must be initialized by hrtimer_init()
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080099 */
100struct hrtimer {
John Stultz998adc32010-09-20 19:19:17 -0700101 struct timerqueue_node node;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700102 ktime_t _softexpires;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800103 enum hrtimer_restart (*function)(struct hrtimer *);
104 struct hrtimer_clock_base *base;
Thomas Gleixner203cbf72016-01-14 16:54:46 +0000105 u8 state;
106 u8 is_rel;
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800107#ifdef CONFIG_TIMER_STATS
Richard Kennedy1b024692008-09-22 14:42:43 -0700108 int start_pid;
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800109 void *start_site;
110 char start_comm[16];
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800111#endif
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800112};
113
114/**
Thomas Gleixner00362e32006-03-31 02:31:17 -0800115 * struct hrtimer_sleeper - simple sleeper structure
Thomas Gleixner00362e32006-03-31 02:31:17 -0800116 * @timer: embedded timer structure
117 * @task: task to wake up
118 *
119 * task is set to NULL, when the timer expires.
120 */
121struct hrtimer_sleeper {
122 struct hrtimer timer;
123 struct task_struct *task;
124};
125
Thomas Gleixnerb8e38412015-04-14 21:08:44 +0000126#ifdef CONFIG_64BIT
127# define HRTIMER_CLOCK_BASE_ALIGN 64
128#else
129# define HRTIMER_CLOCK_BASE_ALIGN 32
130#endif
131
Thomas Gleixner00362e32006-03-31 02:31:17 -0800132/**
Andres Salomond1d67172007-03-06 01:42:07 -0800133 * struct hrtimer_clock_base - the timer base for a specific clock
Randy Dunlap05fb6bf2007-02-28 20:12:13 -0800134 * @cpu_base: per cpu clock base
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800135 * @index: clock type index for per_cpu support when moving a
136 * timer to a base on another cpu.
Vitaliy Ivanov4d258b22011-06-27 19:07:08 +0300137 * @clockid: clock id for per_cpu support
Thomas Gleixner92127c72006-03-26 01:38:05 -0800138 * @active: red black tree root node for the active timers
Thomas Gleixner92127c72006-03-26 01:38:05 -0800139 * @get_time: function to retrieve the current time of the clock
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800140 * @offset: offset of this clock to the monotonic base
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800141 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800142struct hrtimer_clock_base {
143 struct hrtimer_cpu_base *cpu_base;
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200144 int index;
145 clockid_t clockid;
John Stultz998adc32010-09-20 19:19:17 -0700146 struct timerqueue_head active;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800147 ktime_t (*get_time)(void);
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800148 ktime_t offset;
Thomas Gleixnerb8e38412015-04-14 21:08:44 +0000149} __attribute__((__aligned__(HRTIMER_CLOCK_BASE_ALIGN)));
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800150
John Stultze06383d2010-12-14 19:37:07 -0800151enum hrtimer_base_type {
John Stultze06383d2010-12-14 19:37:07 -0800152 HRTIMER_BASE_MONOTONIC,
Thomas Gleixner68fa61c2011-05-20 23:14:04 +0200153 HRTIMER_BASE_REALTIME,
John Stultz70a08cc2011-02-15 10:45:16 -0800154 HRTIMER_BASE_BOOTTIME,
John Stultz90adda92013-01-21 17:00:11 -0800155 HRTIMER_BASE_TAI,
John Stultze06383d2010-12-14 19:37:07 -0800156 HRTIMER_MAX_CLOCK_BASES,
157};
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800158
159/*
160 * struct hrtimer_cpu_base - the per cpu clock bases
161 * @lock: lock protecting the base and associated clock bases
162 * and timers
Peter Zijlstra887d9dc2015-06-11 14:46:48 +0200163 * @seq: seqcount around __run_hrtimer
164 * @running: pointer to the currently running hrtimer
Viresh Kumarcddd0242014-06-22 01:29:15 +0200165 * @cpu: cpu number
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200166 * @active_bases: Bitfield to mark bases with active timers
Thomas Gleixner868a3e92015-04-14 21:08:37 +0000167 * @clock_was_set_seq: Sequence counter of clock was set events
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000168 * @migration_enabled: The migration of hrtimers to other cpus is enabled
Thomas Gleixner683be132015-05-26 22:50:35 +0000169 * @nohz_active: The nohz functionality is enabled
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800170 * @expires_next: absolute time of the next event which was scheduled
171 * via clock_set_next_event()
Thomas Gleixner895bdfa2015-04-14 21:08:49 +0000172 * @next_timer: Pointer to the first expiring timer
Thomas Gleixner9bc749192015-01-20 21:24:10 +0100173 * @in_hrtirq: hrtimer_interrupt() is currently executing
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800174 * @hres_active: State of high resolution mode
Thomas Gleixner41d2e492009-11-13 17:05:44 +0100175 * @hang_detected: The last hrtimer interrupt detected a hang
176 * @nr_events: Total number of hrtimer interrupt events
177 * @nr_retries: Total number of hrtimer interrupt retries
178 * @nr_hangs: Total number of hrtimer interrupt hangs
179 * @max_hang_time: Maximum time spent in hrtimer_interrupt
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200180 * @clock_base: array of clock bases for this cpu
Thomas Gleixner895bdfa2015-04-14 21:08:49 +0000181 *
182 * Note: next_timer is just an optimization for __remove_hrtimer().
183 * Do not dereference the pointer because it is not reliable on
184 * cross cpu removals.
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800185 */
186struct hrtimer_cpu_base {
Thomas Gleixnerecb49d12009-11-17 16:36:54 +0100187 raw_spinlock_t lock;
Peter Zijlstra887d9dc2015-06-11 14:46:48 +0200188 seqcount_t seq;
189 struct hrtimer *running;
Viresh Kumarcddd0242014-06-22 01:29:15 +0200190 unsigned int cpu;
John Stultzf55a6fa2012-07-10 18:43:19 -0400191 unsigned int active_bases;
Thomas Gleixner868a3e92015-04-14 21:08:37 +0000192 unsigned int clock_was_set_seq;
Thomas Gleixnerbc7a34b2015-05-26 22:50:33 +0000193 bool migration_enabled;
Thomas Gleixner683be132015-05-26 22:50:35 +0000194 bool nohz_active;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800195#ifdef CONFIG_HIGH_RES_TIMERS
Thomas Gleixnere19ffe82015-04-14 21:08:39 +0000196 unsigned int in_hrtirq : 1,
197 hres_active : 1,
198 hang_detected : 1;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800199 ktime_t expires_next;
Thomas Gleixner895bdfa2015-04-14 21:08:49 +0000200 struct hrtimer *next_timer;
Thomas Gleixnera6ffebc2015-04-14 21:08:34 +0000201 unsigned int nr_events;
202 unsigned int nr_retries;
203 unsigned int nr_hangs;
204 unsigned int max_hang_time;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800205#endif
Thomas Gleixnerf24444b2011-05-20 13:02:58 +0200206 struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES];
Thomas Gleixner6d9a1412015-04-14 21:08:42 +0000207} ____cacheline_aligned;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800208
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700209static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
210{
Thomas Gleixnerb8e38412015-04-14 21:08:44 +0000211 BUILD_BUG_ON(sizeof(struct hrtimer_clock_base) > HRTIMER_CLOCK_BASE_ALIGN);
212
John Stultz998adc32010-09-20 19:19:17 -0700213 timer->node.expires = time;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700214 timer->_softexpires = time;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700215}
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700216
217static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
218{
219 timer->_softexpires = time;
John Stultz998adc32010-09-20 19:19:17 -0700220 timer->node.expires = ktime_add_safe(time, delta);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700221}
222
John Stultzda8b44d2016-03-17 14:20:51 -0700223static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, u64 delta)
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700224{
225 timer->_softexpires = time;
John Stultz998adc32010-09-20 19:19:17 -0700226 timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700227}
228
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700229static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
230{
John Stultz998adc32010-09-20 19:19:17 -0700231 timer->node.expires.tv64 = tv64;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700232 timer->_softexpires.tv64 = tv64;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700233}
234
235static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
236{
John Stultz998adc32010-09-20 19:19:17 -0700237 timer->node.expires = ktime_add_safe(timer->node.expires, time);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700238 timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700239}
240
David Howells7597bc92008-11-05 17:38:47 +0000241static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700242{
John Stultz998adc32010-09-20 19:19:17 -0700243 timer->node.expires = ktime_add_ns(timer->node.expires, ns);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700244 timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700245}
246
247static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
248{
John Stultz998adc32010-09-20 19:19:17 -0700249 return timer->node.expires;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700250}
251
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700252static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
253{
254 return timer->_softexpires;
255}
256
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700257static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
258{
John Stultz998adc32010-09-20 19:19:17 -0700259 return timer->node.expires.tv64;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700260}
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700261static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
262{
263 return timer->_softexpires.tv64;
264}
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700265
266static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
267{
John Stultz998adc32010-09-20 19:19:17 -0700268 return ktime_to_ns(timer->node.expires);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700269}
270
271static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
272{
John Stultz998adc32010-09-20 19:19:17 -0700273 return ktime_sub(timer->node.expires, timer->base->get_time());
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700274}
275
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800276static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
277{
278 return timer->base->get_time();
279}
280
Thomas Gleixner21d6d522015-04-14 21:08:35 +0000281#ifdef CONFIG_HIGH_RES_TIMERS
282struct clock_event_device;
283
284extern void hrtimer_interrupt(struct clock_event_device *dev);
285
Peter Zijlstra8f4d37e2008-01-25 21:08:29 +0100286static inline int hrtimer_is_hres_active(struct hrtimer *timer)
287{
288 return timer->base->cpu_base->hres_active;
289}
290
Arjan van de Ven2075eb82008-10-07 10:57:54 -0700291extern void hrtimer_peek_ahead_timers(void);
292
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800293/*
294 * The resolution of the clocks. The resolution value is returned in
295 * the clock_getres() system call to give application programmers an
296 * idea of the (in)accuracy of timers. Timer values are rounded up to
297 * this resolution values.
298 */
Tony Breeds151db1f2008-02-08 09:24:52 +1100299# define HIGH_RES_NSEC 1
300# define KTIME_HIGH_RES (ktime_t) { .tv64 = HIGH_RES_NSEC }
301# define MONOTONIC_RES_NSEC HIGH_RES_NSEC
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800302# define KTIME_MONOTONIC_RES KTIME_HIGH_RES
303
John Stultzf55a6fa2012-07-10 18:43:19 -0400304extern void clock_was_set_delayed(void);
305
Thomas Gleixner398ca172015-04-14 21:08:27 +0000306extern unsigned int hrtimer_resolution;
307
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800308#else
309
Tony Breeds151db1f2008-02-08 09:24:52 +1100310# define MONOTONIC_RES_NSEC LOW_RES_NSEC
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800311# define KTIME_MONOTONIC_RES KTIME_LOW_RES
312
Borislav Petkovd711b8b2015-06-06 11:30:00 +0200313#define hrtimer_resolution (unsigned int)LOW_RES_NSEC
Thomas Gleixner398ca172015-04-14 21:08:27 +0000314
Arjan van de Ven2075eb82008-10-07 10:57:54 -0700315static inline void hrtimer_peek_ahead_timers(void) { }
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800316
Peter Zijlstra8f4d37e2008-01-25 21:08:29 +0100317static inline int hrtimer_is_hres_active(struct hrtimer *timer)
318{
319 return 0;
320}
John Stultzf55a6fa2012-07-10 18:43:19 -0400321
322static inline void clock_was_set_delayed(void) { }
323
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800324#endif
325
Thomas Gleixner203cbf72016-01-14 16:54:46 +0000326static inline ktime_t
327__hrtimer_expires_remaining_adjusted(const struct hrtimer *timer, ktime_t now)
328{
329 ktime_t rem = ktime_sub(timer->node.expires, now);
330
331 /*
332 * Adjust relative timers for the extra we added in
333 * hrtimer_start_range_ns() to prevent short timeouts.
334 */
335 if (IS_ENABLED(CONFIG_TIME_LOW_RES) && timer->is_rel)
336 rem.tv64 -= hrtimer_resolution;
337 return rem;
338}
339
340static inline ktime_t
341hrtimer_expires_remaining_adjusted(const struct hrtimer *timer)
342{
343 return __hrtimer_expires_remaining_adjusted(timer,
344 timer->base->get_time());
345}
346
Thomas Gleixnerb12a03c2011-05-02 16:48:57 +0200347extern void clock_was_set(void);
Thomas Gleixner9ec26902011-05-20 16:18:50 +0200348#ifdef CONFIG_TIMERFD
349extern void timerfd_clock_was_set(void);
350#else
351static inline void timerfd_clock_was_set(void) { }
352#endif
Thomas Gleixnerb12a03c2011-05-02 16:48:57 +0200353extern void hrtimers_resume(void);
354
Arjan van de Ven2e94d1f2008-09-10 16:06:00 -0700355DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
Arjan van de Ven2e94d1f2008-09-10 16:06:00 -0700356
357
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800358/* Exported timer functions: */
359
360/* Initialize timers: */
George Anzinger7978672c2006-02-01 03:05:11 -0800361extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
362 enum hrtimer_mode mode);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800363
Thomas Gleixner237fc6e2008-04-30 00:55:04 -0700364#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
365extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
366 enum hrtimer_mode mode);
367
368extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
369#else
370static inline void hrtimer_init_on_stack(struct hrtimer *timer,
371 clockid_t which_clock,
372 enum hrtimer_mode mode)
373{
374 hrtimer_init(timer, which_clock, mode);
375}
376static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
377#endif
378
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800379/* Basic timer operations: */
Thomas Gleixner61699e12015-04-14 21:09:23 +0000380extern void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
John Stultzda8b44d2016-03-17 14:20:51 -0700381 u64 range_ns, const enum hrtimer_mode mode);
Peter Zijlstra7f1e2ca2009-03-13 12:21:27 +0100382
Thomas Gleixner02a171a2015-04-14 21:09:10 +0000383/**
384 * hrtimer_start - (re)start an hrtimer on the current CPU
385 * @timer: the timer to be added
386 * @tim: expiry time
387 * @mode: expiry mode: absolute (HRTIMER_MODE_ABS) or
388 * relative (HRTIMER_MODE_REL)
Thomas Gleixner02a171a2015-04-14 21:09:10 +0000389 */
Thomas Gleixner61699e12015-04-14 21:09:23 +0000390static inline void hrtimer_start(struct hrtimer *timer, ktime_t tim,
391 const enum hrtimer_mode mode)
Thomas Gleixner02a171a2015-04-14 21:09:10 +0000392{
Thomas Gleixner61699e12015-04-14 21:09:23 +0000393 hrtimer_start_range_ns(timer, tim, 0, mode);
Thomas Gleixner02a171a2015-04-14 21:09:10 +0000394}
395
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800396extern int hrtimer_cancel(struct hrtimer *timer);
397extern int hrtimer_try_to_cancel(struct hrtimer *timer);
398
Thomas Gleixner61699e12015-04-14 21:09:23 +0000399static inline void hrtimer_start_expires(struct hrtimer *timer,
400 enum hrtimer_mode mode)
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700401{
John Stultzda8b44d2016-03-17 14:20:51 -0700402 u64 delta;
Arjan van de Venda8f2e12008-09-07 10:47:46 -0700403 ktime_t soft, hard;
404 soft = hrtimer_get_softexpires(timer);
405 hard = hrtimer_get_expires(timer);
406 delta = ktime_to_ns(ktime_sub(hard, soft));
Thomas Gleixner61699e12015-04-14 21:09:23 +0000407 hrtimer_start_range_ns(timer, soft, delta, mode);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700408}
409
Thomas Gleixner61699e12015-04-14 21:09:23 +0000410static inline void hrtimer_restart(struct hrtimer *timer)
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800411{
Thomas Gleixner61699e12015-04-14 21:09:23 +0000412 hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800413}
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800414
415/* Query timers: */
Thomas Gleixner203cbf72016-01-14 16:54:46 +0000416extern ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust);
417
418static inline ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
419{
420 return __hrtimer_get_remaining(timer, false);
421}
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800422
Thomas Gleixnerc1ad3482015-04-14 21:08:58 +0000423extern u64 hrtimer_get_next_event(void);
Tony Lindgren69239742006-03-06 15:42:45 -0800424
Peter Zijlstra887d9dc2015-06-11 14:46:48 +0200425extern bool hrtimer_active(const struct hrtimer *timer);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800426
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800427/*
428 * Helper function to check, whether the timer is on one of the queues
429 */
430static inline int hrtimer_is_queued(struct hrtimer *timer)
431{
Peter Zijlstraca109492008-11-25 12:43:51 +0100432 return timer->state & HRTIMER_STATE_ENQUEUED;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800433}
434
Oliver Hartkopp4346f652008-04-30 23:04:37 +0200435/*
436 * Helper function to check, whether the timer is running the callback
437 * function
438 */
439static inline int hrtimer_callback_running(struct hrtimer *timer)
440{
Peter Zijlstra887d9dc2015-06-11 14:46:48 +0200441 return timer->base->cpu_base->running == timer;
Oliver Hartkopp4346f652008-04-30 23:04:37 +0200442}
443
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800444/* Forward a hrtimer so it expires after now: */
Davide Libenzi4d672e72008-02-04 22:27:26 -0800445extern u64
Roman Zippel44f21472006-03-26 01:38:06 -0800446hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800447
Thomas Gleixner91e5a212015-04-13 21:02:22 +0000448/**
449 * hrtimer_forward_now - forward the timer expiry so it expires after now
450 * @timer: hrtimer to forward
451 * @interval: the interval to forward
452 *
453 * Forward the timer expiry so it will expire after the current time
454 * of the hrtimer clock base. Returns the number of overruns.
455 *
456 * Can be safely called from the callback function of @timer. If
457 * called from other contexts @timer must neither be enqueued nor
458 * running the callback and the caller needs to take care of
459 * serialization.
460 *
461 * Note: This only updates the timer expiry value and does not requeue
462 * the timer.
463 */
Davide Libenzi4d672e72008-02-04 22:27:26 -0800464static inline u64 hrtimer_forward_now(struct hrtimer *timer,
465 ktime_t interval)
Davide Libenzi5e05ad72008-02-04 22:27:25 -0800466{
467 return hrtimer_forward(timer, timer->base->get_time(), interval);
468}
469
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800470/* Precise sleep: */
471extern long hrtimer_nanosleep(struct timespec *rqtp,
Oleg Nesterov080344b2008-02-01 17:29:05 +0300472 struct timespec __user *rmtp,
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800473 const enum hrtimer_mode mode,
474 const clockid_t clockid);
Toyo Abe1711ef32006-09-29 02:00:28 -0700475extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800476
Thomas Gleixner00362e32006-03-31 02:31:17 -0800477extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
478 struct task_struct *tsk);
479
John Stultzda8b44d2016-03-17 14:20:51 -0700480extern int schedule_hrtimeout_range(ktime_t *expires, u64 delta,
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700481 const enum hrtimer_mode mode);
Carsten Emde351b3f72010-04-02 22:40:19 +0200482extern int schedule_hrtimeout_range_clock(ktime_t *expires,
John Stultzda8b44d2016-03-17 14:20:51 -0700483 u64 delta,
484 const enum hrtimer_mode mode,
485 int clock);
Arjan van de Ven7bb67432008-08-31 08:05:58 -0700486extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
487
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800488/* Soft interrupt function to run the hrtimer queues: */
489extern void hrtimer_run_queues(void);
490
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800491/* Bootup initialization: */
492extern void __init hrtimers_init(void);
493
Ingo Molnar88ad0bf62007-02-16 01:28:16 -0800494/* Show pending timers: */
495extern void sysrq_timer_list_show(void);
496
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800497#endif