blob: a036d058a249c99d289a721027a529e1c0245040 [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
56 * 0x02 callback function running
Thomas Gleixner53370d22011-03-10 18:26:33 +010057 * 0x04 timer is migrated to another cpu
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -080058 *
Thomas Gleixnerb00c1a92008-09-29 15:44:46 +020059 * Special cases:
Thomas Gleixner303e9672007-02-16 01:27:51 -080060 * 0x03 callback function running and enqueued
61 * (was requeued on another CPU)
Thomas Gleixner53370d22011-03-10 18:26:33 +010062 * 0x05 timer was migrated on CPU hotunplug
63 *
Thomas Gleixner303e9672007-02-16 01:27:51 -080064 * The "callback function running and enqueued" status is only possible on
65 * SMP. It happens for example when a posix timer expired and the callback
66 * queued a signal. Between dropping the lock which protects the posix timer
67 * and reacquiring the base lock of the hrtimer, another CPU can deliver the
68 * signal and rearm the timer. We have to preserve the callback running state,
69 * as otherwise the timer could be removed before the softirq code finishes the
70 * the handling of the timer.
71 *
Thomas Gleixner53370d22011-03-10 18:26:33 +010072 * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state
73 * to preserve the HRTIMER_STATE_CALLBACK in the above scenario. This
74 * also affects HRTIMER_STATE_MIGRATE where the preservation is not
75 * necessary. HRTIMER_STATE_MIGRATE is cleared after the timer is
76 * enqueued on the new cpu.
Thomas Gleixner303e9672007-02-16 01:27:51 -080077 *
78 * All state transitions are protected by cpu_base->lock.
79 */
80#define HRTIMER_STATE_INACTIVE 0x00
81#define HRTIMER_STATE_ENQUEUED 0x01
82#define HRTIMER_STATE_CALLBACK 0x02
Peter Zijlstraca109492008-11-25 12:43:51 +010083#define HRTIMER_STATE_MIGRATE 0x04
Thomas Gleixner303e9672007-02-16 01:27:51 -080084
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080085/**
86 * struct hrtimer - the basic hrtimer structure
John Stultz998adc32010-09-20 19:19:17 -070087 * @node: timerqueue node, which also manages node.expires,
88 * the absolute expiry time in the hrtimers internal
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080089 * representation. The time is related to the clock on
Thomas Gleixner592aa992008-10-20 16:38:19 +020090 * which the timer is based. Is setup by adding
91 * slack to the _softexpires value. For non range timers
92 * identical to _softexpires.
93 * @_softexpires: the absolute earliest expiry time of the hrtimer.
94 * The time which was given as expiry time when the timer
95 * was armed.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080096 * @function: timer expiry callback function
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080097 * @base: pointer to the timer base (per cpu and per clock)
Thomas Gleixner303e9672007-02-16 01:27:51 -080098 * @state: state information (See bit values above)
Viresh Kumare2e680f2014-03-19 16:21:33 +053099 * @start_pid: timer statistics field to store the pid of the task which
100 * started the timer
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800101 * @start_site: timer statistics field to store the site where the timer
102 * was started
103 * @start_comm: timer statistics field to store the name of the process which
104 * started the timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800105 *
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800106 * The hrtimer structure must be initialized by hrtimer_init()
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800107 */
108struct hrtimer {
John Stultz998adc32010-09-20 19:19:17 -0700109 struct timerqueue_node node;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700110 ktime_t _softexpires;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800111 enum hrtimer_restart (*function)(struct hrtimer *);
112 struct hrtimer_clock_base *base;
Thomas Gleixner303e9672007-02-16 01:27:51 -0800113 unsigned long state;
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800114#ifdef CONFIG_TIMER_STATS
Richard Kennedy1b024692008-09-22 14:42:43 -0700115 int start_pid;
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800116 void *start_site;
117 char start_comm[16];
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800118#endif
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800119};
120
121/**
Thomas Gleixner00362e32006-03-31 02:31:17 -0800122 * struct hrtimer_sleeper - simple sleeper structure
Thomas Gleixner00362e32006-03-31 02:31:17 -0800123 * @timer: embedded timer structure
124 * @task: task to wake up
125 *
126 * task is set to NULL, when the timer expires.
127 */
128struct hrtimer_sleeper {
129 struct hrtimer timer;
130 struct task_struct *task;
131};
132
133/**
Andres Salomond1d67172007-03-06 01:42:07 -0800134 * struct hrtimer_clock_base - the timer base for a specific clock
Randy Dunlap05fb6bf2007-02-28 20:12:13 -0800135 * @cpu_base: per cpu clock base
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800136 * @index: clock type index for per_cpu support when moving a
137 * timer to a base on another cpu.
Vitaliy Ivanov4d258b22011-06-27 19:07:08 +0300138 * @clockid: clock id for per_cpu support
Thomas Gleixner92127c72006-03-26 01:38:05 -0800139 * @active: red black tree root node for the active timers
Thomas Gleixner92127c72006-03-26 01:38:05 -0800140 * @resolution: the resolution of the clock, in nanoseconds
141 * @get_time: function to retrieve the current time of the clock
Thomas Gleixner92127c72006-03-26 01:38:05 -0800142 * @softirq_time: the time when running the hrtimer queue in the softirq
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800143 * @offset: offset of this clock to the monotonic base
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800144 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800145struct hrtimer_clock_base {
146 struct hrtimer_cpu_base *cpu_base;
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200147 int index;
148 clockid_t clockid;
John Stultz998adc32010-09-20 19:19:17 -0700149 struct timerqueue_head active;
Thomas Gleixnere2787632006-01-12 11:36:14 +0100150 ktime_t resolution;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800151 ktime_t (*get_time)(void);
Thomas Gleixner92127c72006-03-26 01:38:05 -0800152 ktime_t softirq_time;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800153 ktime_t offset;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800154};
155
John Stultze06383d2010-12-14 19:37:07 -0800156enum hrtimer_base_type {
John Stultze06383d2010-12-14 19:37:07 -0800157 HRTIMER_BASE_MONOTONIC,
Thomas Gleixner68fa61c2011-05-20 23:14:04 +0200158 HRTIMER_BASE_REALTIME,
John Stultz70a08cc2011-02-15 10:45:16 -0800159 HRTIMER_BASE_BOOTTIME,
John Stultz90adda92013-01-21 17:00:11 -0800160 HRTIMER_BASE_TAI,
John Stultze06383d2010-12-14 19:37:07 -0800161 HRTIMER_MAX_CLOCK_BASES,
162};
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800163
164/*
165 * struct hrtimer_cpu_base - the per cpu clock bases
166 * @lock: lock protecting the base and associated clock bases
167 * and timers
Viresh Kumarcddd0242014-06-22 01:29:15 +0200168 * @cpu: cpu number
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200169 * @active_bases: Bitfield to mark bases with active timers
John Stultzf55a6fa2012-07-10 18:43:19 -0400170 * @clock_was_set: Indicates that clock was set from irq context.
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800171 * @expires_next: absolute time of the next event which was scheduled
172 * via clock_set_next_event()
173 * @hres_active: State of high resolution mode
Thomas Gleixner41d2e492009-11-13 17:05:44 +0100174 * @hang_detected: The last hrtimer interrupt detected a hang
175 * @nr_events: Total number of hrtimer interrupt events
176 * @nr_retries: Total number of hrtimer interrupt retries
177 * @nr_hangs: Total number of hrtimer interrupt hangs
178 * @max_hang_time: Maximum time spent in hrtimer_interrupt
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200179 * @clock_base: array of clock bases for this cpu
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800180 */
181struct hrtimer_cpu_base {
Thomas Gleixnerecb49d12009-11-17 16:36:54 +0100182 raw_spinlock_t lock;
Viresh Kumarcddd0242014-06-22 01:29:15 +0200183 unsigned int cpu;
John Stultzf55a6fa2012-07-10 18:43:19 -0400184 unsigned int active_bases;
185 unsigned int clock_was_set;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800186#ifdef CONFIG_HIGH_RES_TIMERS
187 ktime_t expires_next;
188 int hres_active;
Thomas Gleixner41d2e492009-11-13 17:05:44 +0100189 int hang_detected;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800190 unsigned long nr_events;
Thomas Gleixner41d2e492009-11-13 17:05:44 +0100191 unsigned long nr_retries;
192 unsigned long nr_hangs;
193 ktime_t max_hang_time;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800194#endif
Thomas Gleixnerf24444b2011-05-20 13:02:58 +0200195 struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES];
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800196};
197
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700198static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
199{
John Stultz998adc32010-09-20 19:19:17 -0700200 timer->node.expires = time;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700201 timer->_softexpires = time;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700202}
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700203
204static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
205{
206 timer->_softexpires = time;
John Stultz998adc32010-09-20 19:19:17 -0700207 timer->node.expires = ktime_add_safe(time, delta);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700208}
209
210static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
211{
212 timer->_softexpires = time;
John Stultz998adc32010-09-20 19:19:17 -0700213 timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700214}
215
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700216static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
217{
John Stultz998adc32010-09-20 19:19:17 -0700218 timer->node.expires.tv64 = tv64;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700219 timer->_softexpires.tv64 = tv64;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700220}
221
222static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
223{
John Stultz998adc32010-09-20 19:19:17 -0700224 timer->node.expires = ktime_add_safe(timer->node.expires, time);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700225 timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700226}
227
David Howells7597bc92008-11-05 17:38:47 +0000228static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700229{
John Stultz998adc32010-09-20 19:19:17 -0700230 timer->node.expires = ktime_add_ns(timer->node.expires, ns);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700231 timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700232}
233
234static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
235{
John Stultz998adc32010-09-20 19:19:17 -0700236 return timer->node.expires;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700237}
238
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700239static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
240{
241 return timer->_softexpires;
242}
243
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700244static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
245{
John Stultz998adc32010-09-20 19:19:17 -0700246 return timer->node.expires.tv64;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700247}
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700248static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
249{
250 return timer->_softexpires.tv64;
251}
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700252
253static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
254{
John Stultz998adc32010-09-20 19:19:17 -0700255 return ktime_to_ns(timer->node.expires);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700256}
257
258static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
259{
John Stultz998adc32010-09-20 19:19:17 -0700260 return ktime_sub(timer->node.expires, timer->base->get_time());
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700261}
262
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800263#ifdef CONFIG_HIGH_RES_TIMERS
264struct clock_event_device;
265
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800266extern void hrtimer_interrupt(struct clock_event_device *dev);
267
268/*
269 * In high resolution mode the time reference must be read accurate
270 */
271static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
272{
273 return timer->base->get_time();
274}
275
Peter Zijlstra8f4d37e2008-01-25 21:08:29 +0100276static inline int hrtimer_is_hres_active(struct hrtimer *timer)
277{
278 return timer->base->cpu_base->hres_active;
279}
280
Arjan van de Ven2075eb82008-10-07 10:57:54 -0700281extern void hrtimer_peek_ahead_timers(void);
282
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800283/*
284 * The resolution of the clocks. The resolution value is returned in
285 * the clock_getres() system call to give application programmers an
286 * idea of the (in)accuracy of timers. Timer values are rounded up to
287 * this resolution values.
288 */
Tony Breeds151db1f2008-02-08 09:24:52 +1100289# define HIGH_RES_NSEC 1
290# define KTIME_HIGH_RES (ktime_t) { .tv64 = HIGH_RES_NSEC }
291# define MONOTONIC_RES_NSEC HIGH_RES_NSEC
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800292# define KTIME_MONOTONIC_RES KTIME_HIGH_RES
293
John Stultzf55a6fa2012-07-10 18:43:19 -0400294extern void clock_was_set_delayed(void);
295
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800296#else
297
Tony Breeds151db1f2008-02-08 09:24:52 +1100298# define MONOTONIC_RES_NSEC LOW_RES_NSEC
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800299# define KTIME_MONOTONIC_RES KTIME_LOW_RES
300
Arjan van de Ven2075eb82008-10-07 10:57:54 -0700301static inline void hrtimer_peek_ahead_timers(void) { }
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800302
303/*
304 * In non high resolution mode the time reference is taken from
305 * the base softirq time variable.
306 */
307static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
308{
309 return timer->base->softirq_time;
310}
311
Peter Zijlstra8f4d37e2008-01-25 21:08:29 +0100312static inline int hrtimer_is_hres_active(struct hrtimer *timer)
313{
314 return 0;
315}
John Stultzf55a6fa2012-07-10 18:43:19 -0400316
317static inline void clock_was_set_delayed(void) { }
318
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800319#endif
320
Thomas Gleixnerb12a03c2011-05-02 16:48:57 +0200321extern void clock_was_set(void);
Thomas Gleixner9ec26902011-05-20 16:18:50 +0200322#ifdef CONFIG_TIMERFD
323extern void timerfd_clock_was_set(void);
324#else
325static inline void timerfd_clock_was_set(void) { }
326#endif
Thomas Gleixnerb12a03c2011-05-02 16:48:57 +0200327extern void hrtimers_resume(void);
328
Arjan van de Ven2e94d1f2008-09-10 16:06:00 -0700329DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
Arjan van de Ven2e94d1f2008-09-10 16:06:00 -0700330
331
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800332/* Exported timer functions: */
333
334/* Initialize timers: */
George Anzinger7978672c2006-02-01 03:05:11 -0800335extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
336 enum hrtimer_mode mode);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800337
Thomas Gleixner237fc6e2008-04-30 00:55:04 -0700338#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
339extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
340 enum hrtimer_mode mode);
341
342extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
343#else
344static inline void hrtimer_init_on_stack(struct hrtimer *timer,
345 clockid_t which_clock,
346 enum hrtimer_mode mode)
347{
348 hrtimer_init(timer, which_clock, mode);
349}
350static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
351#endif
352
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800353/* Basic timer operations: */
354extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
355 const enum hrtimer_mode mode);
Arjan van de Venda8f2e12008-09-07 10:47:46 -0700356extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
357 unsigned long range_ns, const enum hrtimer_mode mode);
Peter Zijlstra7f1e2ca2009-03-13 12:21:27 +0100358extern int
359__hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
360 unsigned long delta_ns,
361 const enum hrtimer_mode mode, int wakeup);
362
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800363extern int hrtimer_cancel(struct hrtimer *timer);
364extern int hrtimer_try_to_cancel(struct hrtimer *timer);
365
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700366static inline int hrtimer_start_expires(struct hrtimer *timer,
367 enum hrtimer_mode mode)
368{
Arjan van de Venda8f2e12008-09-07 10:47:46 -0700369 unsigned long delta;
370 ktime_t soft, hard;
371 soft = hrtimer_get_softexpires(timer);
372 hard = hrtimer_get_expires(timer);
373 delta = ktime_to_ns(ktime_sub(hard, soft));
Arjan van de Ven4ce105d2008-09-07 15:31:39 -0700374 return hrtimer_start_range_ns(timer, soft, delta, mode);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700375}
376
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800377static inline int hrtimer_restart(struct hrtimer *timer)
378{
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700379 return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800380}
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800381
382/* Query timers: */
383extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
384extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
385
Tony Lindgren69239742006-03-06 15:42:45 -0800386extern ktime_t hrtimer_get_next_event(void);
Tony Lindgren69239742006-03-06 15:42:45 -0800387
Thomas Gleixner303e9672007-02-16 01:27:51 -0800388/*
Thomas Gleixner53370d22011-03-10 18:26:33 +0100389 * A timer is active, when it is enqueued into the rbtree or the
390 * callback function is running or it's in the state of being migrated
391 * to another cpu.
Thomas Gleixner303e9672007-02-16 01:27:51 -0800392 */
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800393static inline int hrtimer_active(const struct hrtimer *timer)
394{
Thomas Gleixner303e9672007-02-16 01:27:51 -0800395 return timer->state != HRTIMER_STATE_INACTIVE;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800396}
397
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800398/*
399 * Helper function to check, whether the timer is on one of the queues
400 */
401static inline int hrtimer_is_queued(struct hrtimer *timer)
402{
Peter Zijlstraca109492008-11-25 12:43:51 +0100403 return timer->state & HRTIMER_STATE_ENQUEUED;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800404}
405
Oliver Hartkopp4346f652008-04-30 23:04:37 +0200406/*
407 * Helper function to check, whether the timer is running the callback
408 * function
409 */
410static inline int hrtimer_callback_running(struct hrtimer *timer)
411{
412 return timer->state & HRTIMER_STATE_CALLBACK;
413}
414
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800415/* Forward a hrtimer so it expires after now: */
Davide Libenzi4d672e72008-02-04 22:27:26 -0800416extern u64
Roman Zippel44f21472006-03-26 01:38:06 -0800417hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800418
Davide Libenzi5e05ad72008-02-04 22:27:25 -0800419/* Forward a hrtimer so it expires after the hrtimer's current now */
Davide Libenzi4d672e72008-02-04 22:27:26 -0800420static inline u64 hrtimer_forward_now(struct hrtimer *timer,
421 ktime_t interval)
Davide Libenzi5e05ad72008-02-04 22:27:25 -0800422{
423 return hrtimer_forward(timer, timer->base->get_time(), interval);
424}
425
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800426/* Precise sleep: */
427extern long hrtimer_nanosleep(struct timespec *rqtp,
Oleg Nesterov080344b2008-02-01 17:29:05 +0300428 struct timespec __user *rmtp,
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800429 const enum hrtimer_mode mode,
430 const clockid_t clockid);
Toyo Abe1711ef32006-09-29 02:00:28 -0700431extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800432
Thomas Gleixner00362e32006-03-31 02:31:17 -0800433extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
434 struct task_struct *tsk);
435
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700436extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
437 const enum hrtimer_mode mode);
Carsten Emde351b3f72010-04-02 22:40:19 +0200438extern int schedule_hrtimeout_range_clock(ktime_t *expires,
439 unsigned long delta, const enum hrtimer_mode mode, int clock);
Arjan van de Ven7bb67432008-08-31 08:05:58 -0700440extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
441
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800442/* Soft interrupt function to run the hrtimer queues: */
443extern void hrtimer_run_queues(void);
Peter Zijlstrad3d74452008-01-25 21:08:31 +0100444extern void hrtimer_run_pending(void);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800445
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800446/* Bootup initialization: */
447extern void __init hrtimers_init(void);
448
Ingo Molnar88ad0bf62007-02-16 01:28:16 -0800449/* Show pending timers: */
450extern void sysrq_timer_list_show(void);
451
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800452#endif