blob: 51932e5acf7ce8cd44b57c0a7fe2288013d1967d [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)
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -080099 * @start_site: timer statistics field to store the site where the timer
100 * was started
101 * @start_comm: timer statistics field to store the name of the process which
102 * started the timer
103 * @start_pid: timer statistics field to store the pid of the task 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.
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 * @resolution: the resolution of the clock, in nanoseconds
140 * @get_time: function to retrieve the current time of the clock
Thomas Gleixner92127c72006-03-26 01:38:05 -0800141 * @softirq_time: the time when running the hrtimer queue in the softirq
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800142 * @offset: offset of this clock to the monotonic base
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800143 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800144struct hrtimer_clock_base {
145 struct hrtimer_cpu_base *cpu_base;
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200146 int index;
147 clockid_t clockid;
John Stultz998adc32010-09-20 19:19:17 -0700148 struct timerqueue_head active;
Thomas Gleixnere2787632006-01-12 11:36:14 +0100149 ktime_t resolution;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800150 ktime_t (*get_time)(void);
Thomas Gleixner92127c72006-03-26 01:38:05 -0800151 ktime_t softirq_time;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800152 ktime_t offset;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800153};
154
John Stultze06383d2010-12-14 19:37:07 -0800155enum hrtimer_base_type {
John Stultze06383d2010-12-14 19:37:07 -0800156 HRTIMER_BASE_MONOTONIC,
Thomas Gleixner68fa61c2011-05-20 23:14:04 +0200157 HRTIMER_BASE_REALTIME,
John Stultz70a08cc2011-02-15 10:45:16 -0800158 HRTIMER_BASE_BOOTTIME,
John Stultze06383d2010-12-14 19:37:07 -0800159 HRTIMER_MAX_CLOCK_BASES,
160};
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800161
162/*
163 * struct hrtimer_cpu_base - the per cpu clock bases
164 * @lock: lock protecting the base and associated clock bases
165 * and timers
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200166 * @active_bases: Bitfield to mark bases with active timers
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800167 * @expires_next: absolute time of the next event which was scheduled
168 * via clock_set_next_event()
169 * @hres_active: State of high resolution mode
Thomas Gleixner41d2e492009-11-13 17:05:44 +0100170 * @hang_detected: The last hrtimer interrupt detected a hang
171 * @nr_events: Total number of hrtimer interrupt events
172 * @nr_retries: Total number of hrtimer interrupt retries
173 * @nr_hangs: Total number of hrtimer interrupt hangs
174 * @max_hang_time: Maximum time spent in hrtimer_interrupt
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200175 * @clock_base: array of clock bases for this cpu
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800176 */
177struct hrtimer_cpu_base {
Thomas Gleixnerecb49d12009-11-17 16:36:54 +0100178 raw_spinlock_t lock;
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200179 unsigned long active_bases;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800180#ifdef CONFIG_HIGH_RES_TIMERS
181 ktime_t expires_next;
182 int hres_active;
Thomas Gleixner41d2e492009-11-13 17:05:44 +0100183 int hang_detected;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800184 unsigned long nr_events;
Thomas Gleixner41d2e492009-11-13 17:05:44 +0100185 unsigned long nr_retries;
186 unsigned long nr_hangs;
187 ktime_t max_hang_time;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800188#endif
Thomas Gleixnerf24444b2011-05-20 13:02:58 +0200189 struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES];
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800190};
191
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700192static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
193{
John Stultz998adc32010-09-20 19:19:17 -0700194 timer->node.expires = time;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700195 timer->_softexpires = time;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700196}
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700197
198static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
199{
200 timer->_softexpires = time;
John Stultz998adc32010-09-20 19:19:17 -0700201 timer->node.expires = ktime_add_safe(time, delta);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700202}
203
204static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
205{
206 timer->_softexpires = time;
John Stultz998adc32010-09-20 19:19:17 -0700207 timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700208}
209
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700210static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
211{
John Stultz998adc32010-09-20 19:19:17 -0700212 timer->node.expires.tv64 = tv64;
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700213 timer->_softexpires.tv64 = tv64;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700214}
215
216static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
217{
John Stultz998adc32010-09-20 19:19:17 -0700218 timer->node.expires = ktime_add_safe(timer->node.expires, time);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700219 timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700220}
221
David Howells7597bc92008-11-05 17:38:47 +0000222static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700223{
John Stultz998adc32010-09-20 19:19:17 -0700224 timer->node.expires = ktime_add_ns(timer->node.expires, ns);
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700225 timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700226}
227
228static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
229{
John Stultz998adc32010-09-20 19:19:17 -0700230 return timer->node.expires;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700231}
232
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700233static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
234{
235 return timer->_softexpires;
236}
237
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700238static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
239{
John Stultz998adc32010-09-20 19:19:17 -0700240 return timer->node.expires.tv64;
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700241}
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700242static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
243{
244 return timer->_softexpires.tv64;
245}
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700246
247static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
248{
John Stultz998adc32010-09-20 19:19:17 -0700249 return ktime_to_ns(timer->node.expires);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700250}
251
252static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
253{
John Stultz998adc32010-09-20 19:19:17 -0700254 return ktime_sub(timer->node.expires, timer->base->get_time());
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700255}
256
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800257#ifdef CONFIG_HIGH_RES_TIMERS
258struct clock_event_device;
259
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800260extern void hrtimer_interrupt(struct clock_event_device *dev);
261
262/*
263 * In high resolution mode the time reference must be read accurate
264 */
265static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
266{
267 return timer->base->get_time();
268}
269
Peter Zijlstra8f4d37e2008-01-25 21:08:29 +0100270static inline int hrtimer_is_hres_active(struct hrtimer *timer)
271{
272 return timer->base->cpu_base->hres_active;
273}
274
Arjan van de Ven2075eb82008-10-07 10:57:54 -0700275extern void hrtimer_peek_ahead_timers(void);
276
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800277/*
278 * The resolution of the clocks. The resolution value is returned in
279 * the clock_getres() system call to give application programmers an
280 * idea of the (in)accuracy of timers. Timer values are rounded up to
281 * this resolution values.
282 */
Tony Breeds151db1f2008-02-08 09:24:52 +1100283# define HIGH_RES_NSEC 1
284# define KTIME_HIGH_RES (ktime_t) { .tv64 = HIGH_RES_NSEC }
285# define MONOTONIC_RES_NSEC HIGH_RES_NSEC
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800286# define KTIME_MONOTONIC_RES KTIME_HIGH_RES
287
288#else
289
Tony Breeds151db1f2008-02-08 09:24:52 +1100290# define MONOTONIC_RES_NSEC LOW_RES_NSEC
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800291# define KTIME_MONOTONIC_RES KTIME_LOW_RES
292
Arjan van de Ven2075eb82008-10-07 10:57:54 -0700293static inline void hrtimer_peek_ahead_timers(void) { }
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800294
295/*
296 * In non high resolution mode the time reference is taken from
297 * the base softirq time variable.
298 */
299static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
300{
301 return timer->base->softirq_time;
302}
303
Peter Zijlstra8f4d37e2008-01-25 21:08:29 +0100304static inline int hrtimer_is_hres_active(struct hrtimer *timer)
305{
306 return 0;
307}
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800308#endif
309
Thomas Gleixnerb12a03c2011-05-02 16:48:57 +0200310extern void clock_was_set(void);
Thomas Gleixner9ec26902011-05-20 16:18:50 +0200311#ifdef CONFIG_TIMERFD
312extern void timerfd_clock_was_set(void);
313#else
314static inline void timerfd_clock_was_set(void) { }
315#endif
Thomas Gleixnerb12a03c2011-05-02 16:48:57 +0200316extern void hrtimers_resume(void);
317
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800318extern ktime_t ktime_get(void);
319extern ktime_t ktime_get_real(void);
John Stultzabb3a4e2011-02-14 17:52:09 -0800320extern ktime_t ktime_get_boottime(void);
Thomas Gleixner99ee5312011-04-27 14:16:42 +0200321extern ktime_t ktime_get_monotonic_offset(void);
Thomas Gleixnerbecf8b52006-01-09 20:52:38 -0800322
Arjan van de Ven2e94d1f2008-09-10 16:06:00 -0700323DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
Arjan van de Ven2e94d1f2008-09-10 16:06:00 -0700324
325
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800326/* Exported timer functions: */
327
328/* Initialize timers: */
George Anzinger79786722006-02-01 03:05:11 -0800329extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
330 enum hrtimer_mode mode);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800331
Thomas Gleixner237fc6e2008-04-30 00:55:04 -0700332#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
333extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
334 enum hrtimer_mode mode);
335
336extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
337#else
338static inline void hrtimer_init_on_stack(struct hrtimer *timer,
339 clockid_t which_clock,
340 enum hrtimer_mode mode)
341{
342 hrtimer_init(timer, which_clock, mode);
343}
344static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
345#endif
346
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800347/* Basic timer operations: */
348extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
349 const enum hrtimer_mode mode);
Arjan van de Venda8f2e12008-09-07 10:47:46 -0700350extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
351 unsigned long range_ns, const enum hrtimer_mode mode);
Peter Zijlstra7f1e2ca2009-03-13 12:21:27 +0100352extern int
353__hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
354 unsigned long delta_ns,
355 const enum hrtimer_mode mode, int wakeup);
356
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800357extern int hrtimer_cancel(struct hrtimer *timer);
358extern int hrtimer_try_to_cancel(struct hrtimer *timer);
359
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700360static inline int hrtimer_start_expires(struct hrtimer *timer,
361 enum hrtimer_mode mode)
362{
Arjan van de Venda8f2e12008-09-07 10:47:46 -0700363 unsigned long delta;
364 ktime_t soft, hard;
365 soft = hrtimer_get_softexpires(timer);
366 hard = hrtimer_get_expires(timer);
367 delta = ktime_to_ns(ktime_sub(hard, soft));
Arjan van de Ven4ce105d2008-09-07 15:31:39 -0700368 return hrtimer_start_range_ns(timer, soft, delta, mode);
Arjan van de Ven63ca2432008-09-01 14:35:02 -0700369}
370
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800371static inline int hrtimer_restart(struct hrtimer *timer)
372{
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700373 return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800374}
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800375
376/* Query timers: */
377extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
378extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
379
Tony Lindgren69239742006-03-06 15:42:45 -0800380extern ktime_t hrtimer_get_next_event(void);
Tony Lindgren69239742006-03-06 15:42:45 -0800381
Thomas Gleixner303e9672007-02-16 01:27:51 -0800382/*
Thomas Gleixner53370d22011-03-10 18:26:33 +0100383 * A timer is active, when it is enqueued into the rbtree or the
384 * callback function is running or it's in the state of being migrated
385 * to another cpu.
Thomas Gleixner303e9672007-02-16 01:27:51 -0800386 */
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800387static inline int hrtimer_active(const struct hrtimer *timer)
388{
Thomas Gleixner303e9672007-02-16 01:27:51 -0800389 return timer->state != HRTIMER_STATE_INACTIVE;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800390}
391
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800392/*
393 * Helper function to check, whether the timer is on one of the queues
394 */
395static inline int hrtimer_is_queued(struct hrtimer *timer)
396{
Peter Zijlstraca109492008-11-25 12:43:51 +0100397 return timer->state & HRTIMER_STATE_ENQUEUED;
Thomas Gleixner54cdfdb2007-02-16 01:28:11 -0800398}
399
Oliver Hartkopp4346f652008-04-30 23:04:37 +0200400/*
401 * Helper function to check, whether the timer is running the callback
402 * function
403 */
404static inline int hrtimer_callback_running(struct hrtimer *timer)
405{
406 return timer->state & HRTIMER_STATE_CALLBACK;
407}
408
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800409/* Forward a hrtimer so it expires after now: */
Davide Libenzi4d672e72008-02-04 22:27:26 -0800410extern u64
Roman Zippel44f21472006-03-26 01:38:06 -0800411hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800412
Davide Libenzi5e05ad72008-02-04 22:27:25 -0800413/* Forward a hrtimer so it expires after the hrtimer's current now */
Davide Libenzi4d672e72008-02-04 22:27:26 -0800414static inline u64 hrtimer_forward_now(struct hrtimer *timer,
415 ktime_t interval)
Davide Libenzi5e05ad72008-02-04 22:27:25 -0800416{
417 return hrtimer_forward(timer, timer->base->get_time(), interval);
418}
419
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800420/* Precise sleep: */
421extern long hrtimer_nanosleep(struct timespec *rqtp,
Oleg Nesterov080344b2008-02-01 17:29:05 +0300422 struct timespec __user *rmtp,
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800423 const enum hrtimer_mode mode,
424 const clockid_t clockid);
Toyo Abe1711ef32006-09-29 02:00:28 -0700425extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800426
Thomas Gleixner00362e32006-03-31 02:31:17 -0800427extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
428 struct task_struct *tsk);
429
Arjan van de Ven654c8e02008-09-01 15:47:08 -0700430extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
431 const enum hrtimer_mode mode);
Carsten Emde351b3f72010-04-02 22:40:19 +0200432extern int schedule_hrtimeout_range_clock(ktime_t *expires,
433 unsigned long delta, const enum hrtimer_mode mode, int clock);
Arjan van de Ven7bb67432008-08-31 08:05:58 -0700434extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
435
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800436/* Soft interrupt function to run the hrtimer queues: */
437extern void hrtimer_run_queues(void);
Peter Zijlstrad3d74452008-01-25 21:08:31 +0100438extern void hrtimer_run_pending(void);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800439
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800440/* Bootup initialization: */
441extern void __init hrtimers_init(void);
442
Thomas Gleixner79bf2bb2007-02-16 01:28:03 -0800443#if BITS_PER_LONG < 64
Davide Libenzi4d672e72008-02-04 22:27:26 -0800444extern u64 ktime_divns(const ktime_t kt, s64 div);
Thomas Gleixner79bf2bb2007-02-16 01:28:03 -0800445#else /* BITS_PER_LONG < 64 */
Davide Libenzi4d672e72008-02-04 22:27:26 -0800446# define ktime_divns(kt, div) (u64)((kt).tv64 / (div))
Thomas Gleixner79bf2bb2007-02-16 01:28:03 -0800447#endif
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