2 * include/linux/hrtimer.h
4 * hrtimers - High-resolution kernel timers
6 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
7 * Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
9 * data type definitions, declarations, prototypes
11 * Started by: Thomas Gleixner and Ingo Molnar
13 * For licencing details see kernel-base/COPYING
15 #ifndef _LINUX_HRTIMER_H
16 #define _LINUX_HRTIMER_H
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>
24 struct hrtimer_clock_base;
25 struct hrtimer_cpu_base;
28 * Mode arguments of xxx_hrtimer functions:
31 HRTIMER_MODE_ABS, /* Time value is absolute */
32 HRTIMER_MODE_REL, /* Time value is relative to now */
36 * Return values for the callback function
38 enum hrtimer_restart {
39 HRTIMER_NORESTART, /* Timer is not restarted */
40 HRTIMER_RESTART, /* Timer must be restarted */
44 * hrtimer callback modes:
46 * HRTIMER_CB_SOFTIRQ: Callback must run in softirq context
47 * HRTIMER_CB_IRQSAFE: Callback may run in hardirq context
48 * HRTIMER_CB_IRQSAFE_NO_RESTART: Callback may run in hardirq context and
49 * does not restart the timer
50 * HRTIMER_CB_IRQSAFE_NO_SOFTIRQ: Callback must run in hardirq context
51 * Special mode for tick emultation
53 enum hrtimer_cb_mode {
56 HRTIMER_CB_IRQSAFE_NO_RESTART,
57 HRTIMER_CB_IRQSAFE_NO_SOFTIRQ,
61 * Values to track state of the timer
66 * 0x01 enqueued into rbtree
67 * 0x02 callback function running
68 * 0x04 callback pending (high resolution mode)
71 * 0x03 callback function running and enqueued
72 * (was requeued on another CPU)
73 * The "callback function running and enqueued" status is only possible on
74 * SMP. It happens for example when a posix timer expired and the callback
75 * queued a signal. Between dropping the lock which protects the posix timer
76 * and reacquiring the base lock of the hrtimer, another CPU can deliver the
77 * signal and rearm the timer. We have to preserve the callback running state,
78 * as otherwise the timer could be removed before the softirq code finishes the
79 * the handling of the timer.
81 * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state to
82 * preserve the HRTIMER_STATE_CALLBACK bit in the above scenario.
84 * All state transitions are protected by cpu_base->lock.
86 #define HRTIMER_STATE_INACTIVE 0x00
87 #define HRTIMER_STATE_ENQUEUED 0x01
88 #define HRTIMER_STATE_CALLBACK 0x02
89 #define HRTIMER_STATE_PENDING 0x04
92 * struct hrtimer - the basic hrtimer structure
93 * @node: red black tree node for time ordered insertion
94 * @expires: the absolute expiry time in the hrtimers internal
95 * representation. The time is related to the clock on
96 * which the timer is based.
97 * @function: timer expiry callback function
98 * @base: pointer to the timer base (per cpu and per clock)
99 * @state: state information (See bit values above)
100 * @cb_mode: high resolution timer feature to select the callback execution
102 * @cb_entry: list head to enqueue an expired timer into the callback list
103 * @start_site: timer statistics field to store the site where the timer
105 * @start_comm: timer statistics field to store the name of the process which
107 * @start_pid: timer statistics field to store the pid of the task which
110 * The hrtimer structure must be initialized by hrtimer_init()
115 ktime_t _softexpires;
116 enum hrtimer_restart (*function)(struct hrtimer *);
117 struct hrtimer_clock_base *base;
119 enum hrtimer_cb_mode cb_mode;
120 struct list_head cb_entry;
121 #ifdef CONFIG_TIMER_STATS
129 * struct hrtimer_sleeper - simple sleeper structure
130 * @timer: embedded timer structure
131 * @task: task to wake up
133 * task is set to NULL, when the timer expires.
135 struct hrtimer_sleeper {
136 struct hrtimer timer;
137 struct task_struct *task;
141 * struct hrtimer_clock_base - the timer base for a specific clock
142 * @cpu_base: per cpu clock base
143 * @index: clock type index for per_cpu support when moving a
144 * timer to a base on another cpu.
145 * @active: red black tree root node for the active timers
146 * @first: pointer to the timer node which expires first
147 * @resolution: the resolution of the clock, in nanoseconds
148 * @get_time: function to retrieve the current time of the clock
149 * @get_softirq_time: function to retrieve the current time from the softirq
150 * @softirq_time: the time when running the hrtimer queue in the softirq
151 * @offset: offset of this clock to the monotonic base
152 * @reprogram: function to reprogram the timer event
154 struct hrtimer_clock_base {
155 struct hrtimer_cpu_base *cpu_base;
157 struct rb_root active;
158 struct rb_node *first;
160 ktime_t (*get_time)(void);
161 ktime_t (*get_softirq_time)(void);
162 ktime_t softirq_time;
163 #ifdef CONFIG_HIGH_RES_TIMERS
165 int (*reprogram)(struct hrtimer *t,
166 struct hrtimer_clock_base *b,
171 #define HRTIMER_MAX_CLOCK_BASES 2
174 * struct hrtimer_cpu_base - the per cpu clock bases
175 * @lock: lock protecting the base and associated clock bases
177 * @clock_base: array of clock bases for this cpu
178 * @curr_timer: the timer which is executing a callback right now
179 * @expires_next: absolute time of the next event which was scheduled
180 * via clock_set_next_event()
181 * @hres_active: State of high resolution mode
182 * @check_clocks: Indictator, when set evaluate time source and clock
183 * event devices whether high resolution mode can be
185 * @cb_pending: Expired timers are moved from the rbtree to this
186 * list in the timer interrupt. The list is processed
188 * @nr_events: Total number of timer interrupt events
190 struct hrtimer_cpu_base {
192 struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES];
193 struct list_head cb_pending;
194 #ifdef CONFIG_HIGH_RES_TIMERS
195 ktime_t expires_next;
197 unsigned long nr_events;
202 * In high resolution mode the time reference must be read accurate
204 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
206 return timer->base->get_time();
209 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
211 return timer->base->cpu_base->hres_active;
214 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
216 timer->_expires = time;
217 timer->_softexpires = time;
220 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
222 timer->_softexpires = time;
223 timer->_expires = ktime_add_safe(time, delta);
226 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
228 timer->_softexpires = time;
229 timer->_expires = ktime_add_safe(time, ns_to_ktime(delta));
232 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
234 timer->_expires.tv64 = tv64;
235 timer->_softexpires.tv64 = tv64;
238 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
240 timer->_expires = ktime_add_safe(timer->_expires, time);
241 timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
244 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, unsigned long ns)
246 timer->_expires = ktime_add_ns(timer->_expires, ns);
247 timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
250 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
252 return timer->_expires;
255 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
257 return timer->_softexpires;
260 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
262 return timer->_expires.tv64;
264 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
266 return timer->_softexpires.tv64;
269 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
271 return ktime_to_ns(timer->_expires);
274 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
276 return ktime_sub(timer->_expires, timer->base->get_time());
279 #ifdef CONFIG_HIGH_RES_TIMERS
280 struct clock_event_device;
282 extern void clock_was_set(void);
283 extern void hres_timers_resume(void);
284 extern void hrtimer_interrupt(struct clock_event_device *dev);
287 * The resolution of the clocks. The resolution value is returned in
288 * the clock_getres() system call to give application programmers an
289 * idea of the (in)accuracy of timers. Timer values are rounded up to
290 * this resolution values.
292 # define HIGH_RES_NSEC 1
293 # define KTIME_HIGH_RES (ktime_t) { .tv64 = HIGH_RES_NSEC }
294 # define MONOTONIC_RES_NSEC HIGH_RES_NSEC
295 # define KTIME_MONOTONIC_RES KTIME_HIGH_RES
299 # define MONOTONIC_RES_NSEC LOW_RES_NSEC
300 # define KTIME_MONOTONIC_RES KTIME_LOW_RES
303 * clock_was_set() is a NOP for non- high-resolution systems. The
304 * time-sorted order guarantees that a timer does not expire early and
305 * is expired in the next softirq when the clock was advanced.
307 static inline void clock_was_set(void) { }
309 static inline void hres_timers_resume(void) { }
312 * In non high resolution mode the time reference is taken from
313 * the base softirq time variable.
315 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
317 return timer->base->softirq_time;
320 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
326 extern ktime_t ktime_get(void);
327 extern ktime_t ktime_get_real(void);
329 /* Exported timer functions: */
331 /* Initialize timers: */
332 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
333 enum hrtimer_mode mode);
335 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
336 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
337 enum hrtimer_mode mode);
339 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
341 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
342 clockid_t which_clock,
343 enum hrtimer_mode mode)
345 hrtimer_init(timer, which_clock, mode);
347 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
350 /* Basic timer operations: */
351 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
352 const enum hrtimer_mode mode);
353 extern int hrtimer_cancel(struct hrtimer *timer);
354 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
356 static inline int hrtimer_start_expires(struct hrtimer *timer,
357 enum hrtimer_mode mode)
359 return hrtimer_start(timer, hrtimer_get_expires(timer), mode);
362 static inline int hrtimer_restart(struct hrtimer *timer)
364 return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
368 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
369 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
371 extern ktime_t hrtimer_get_next_event(void);
374 * A timer is active, when it is enqueued into the rbtree or the callback
375 * function is running.
377 static inline int hrtimer_active(const struct hrtimer *timer)
379 return timer->state != HRTIMER_STATE_INACTIVE;
383 * Helper function to check, whether the timer is on one of the queues
385 static inline int hrtimer_is_queued(struct hrtimer *timer)
387 return timer->state &
388 (HRTIMER_STATE_ENQUEUED | HRTIMER_STATE_PENDING);
392 * Helper function to check, whether the timer is running the callback
395 static inline int hrtimer_callback_running(struct hrtimer *timer)
397 return timer->state & HRTIMER_STATE_CALLBACK;
400 /* Forward a hrtimer so it expires after now: */
402 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
404 /* Forward a hrtimer so it expires after the hrtimer's current now */
405 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
408 return hrtimer_forward(timer, timer->base->get_time(), interval);
412 extern long hrtimer_nanosleep(struct timespec *rqtp,
413 struct timespec __user *rmtp,
414 const enum hrtimer_mode mode,
415 const clockid_t clockid);
416 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
418 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
419 struct task_struct *tsk);
421 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
422 const enum hrtimer_mode mode);
423 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
425 /* Soft interrupt function to run the hrtimer queues: */
426 extern void hrtimer_run_queues(void);
427 extern void hrtimer_run_pending(void);
429 /* Bootup initialization: */
430 extern void __init hrtimers_init(void);
432 #if BITS_PER_LONG < 64
433 extern u64 ktime_divns(const ktime_t kt, s64 div);
434 #else /* BITS_PER_LONG < 64 */
435 # define ktime_divns(kt, div) (u64)((kt).tv64 / (div))
438 /* Show pending timers: */
439 extern void sysrq_timer_list_show(void);
442 * Timer-statistics info:
444 #ifdef CONFIG_TIMER_STATS
446 extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
447 void *timerf, char *comm,
448 unsigned int timer_flag);
450 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
452 timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
453 timer->function, timer->start_comm, 0);
456 extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
459 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
461 __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
464 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
466 timer->start_site = NULL;
469 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
473 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
477 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)