Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 1 | /* |
| 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 Rothwell | 40b8606 | 2008-10-15 14:20:28 +1100 | [diff] [blame] | 23 | #include <linux/percpu.h> |
Heiko Carstens | 507e123 | 2009-06-23 17:38:15 +0200 | [diff] [blame] | 24 | #include <linux/timer.h> |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 25 | #include <linux/timerqueue.h> |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 26 | |
Thomas Gleixner | 3c8aa39 | 2007-02-16 01:27:50 -0800 | [diff] [blame] | 27 | struct hrtimer_clock_base; |
| 28 | struct hrtimer_cpu_base; |
| 29 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 30 | /* |
| 31 | * Mode arguments of xxx_hrtimer functions: |
| 32 | */ |
| 33 | enum hrtimer_mode { |
Arun R Bharadwaj | 597d027 | 2009-04-16 12:13:26 +0530 | [diff] [blame] | 34 | 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 Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 39 | }; |
| 40 | |
Thomas Gleixner | c9cb2e3 | 2007-02-16 01:27:49 -0800 | [diff] [blame] | 41 | /* |
| 42 | * Return values for the callback function |
| 43 | */ |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 44 | enum hrtimer_restart { |
Thomas Gleixner | c9cb2e3 | 2007-02-16 01:27:49 -0800 | [diff] [blame] | 45 | HRTIMER_NORESTART, /* Timer is not restarted */ |
| 46 | HRTIMER_RESTART, /* Timer must be restarted */ |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 47 | }; |
| 48 | |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 49 | /* |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 50 | * Values to track state of the timer |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 51 | * |
| 52 | * Possible states: |
| 53 | * |
| 54 | * 0x00 inactive |
| 55 | * 0x01 enqueued into rbtree |
| 56 | * 0x02 callback function running |
Thomas Gleixner | 53370d2 | 2011-03-10 18:26:33 +0100 | [diff] [blame] | 57 | * 0x04 timer is migrated to another cpu |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 58 | * |
Thomas Gleixner | b00c1a9 | 2008-09-29 15:44:46 +0200 | [diff] [blame] | 59 | * Special cases: |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 60 | * 0x03 callback function running and enqueued |
| 61 | * (was requeued on another CPU) |
Thomas Gleixner | 53370d2 | 2011-03-10 18:26:33 +0100 | [diff] [blame] | 62 | * 0x05 timer was migrated on CPU hotunplug |
| 63 | * |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 64 | * 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 Gleixner | 53370d2 | 2011-03-10 18:26:33 +0100 | [diff] [blame] | 72 | * 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 Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 77 | * |
| 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 Zijlstra | ca10949 | 2008-11-25 12:43:51 +0100 | [diff] [blame] | 83 | #define HRTIMER_STATE_MIGRATE 0x04 |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 84 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 85 | /** |
| 86 | * struct hrtimer - the basic hrtimer structure |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 87 | * @node: timerqueue node, which also manages node.expires, |
| 88 | * the absolute expiry time in the hrtimers internal |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 89 | * representation. The time is related to the clock on |
Thomas Gleixner | 592aa99 | 2008-10-20 16:38:19 +0200 | [diff] [blame] | 90 | * 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 Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 96 | * @function: timer expiry callback function |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 97 | * @base: pointer to the timer base (per cpu and per clock) |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 98 | * @state: state information (See bit values above) |
Viresh Kumar | e2e680f | 2014-03-19 16:21:33 +0530 | [diff] [blame] | 99 | * @start_pid: timer statistics field to store the pid of the task which |
| 100 | * started the timer |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 101 | * @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 Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 105 | * |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 106 | * The hrtimer structure must be initialized by hrtimer_init() |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 107 | */ |
| 108 | struct hrtimer { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 109 | struct timerqueue_node node; |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 110 | ktime_t _softexpires; |
Thomas Gleixner | 3c8aa39 | 2007-02-16 01:27:50 -0800 | [diff] [blame] | 111 | enum hrtimer_restart (*function)(struct hrtimer *); |
| 112 | struct hrtimer_clock_base *base; |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 113 | unsigned long state; |
Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 114 | #ifdef CONFIG_TIMER_STATS |
Richard Kennedy | 1b02469 | 2008-09-22 14:42:43 -0700 | [diff] [blame] | 115 | int start_pid; |
Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 116 | void *start_site; |
| 117 | char start_comm[16]; |
Ingo Molnar | 82f67cd | 2007-02-16 01:28:13 -0800 | [diff] [blame] | 118 | #endif |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 119 | }; |
| 120 | |
| 121 | /** |
Thomas Gleixner | 00362e3 | 2006-03-31 02:31:17 -0800 | [diff] [blame] | 122 | * struct hrtimer_sleeper - simple sleeper structure |
Thomas Gleixner | 00362e3 | 2006-03-31 02:31:17 -0800 | [diff] [blame] | 123 | * @timer: embedded timer structure |
| 124 | * @task: task to wake up |
| 125 | * |
| 126 | * task is set to NULL, when the timer expires. |
| 127 | */ |
| 128 | struct hrtimer_sleeper { |
| 129 | struct hrtimer timer; |
| 130 | struct task_struct *task; |
| 131 | }; |
| 132 | |
| 133 | /** |
Andres Salomon | d1d6717 | 2007-03-06 01:42:07 -0800 | [diff] [blame] | 134 | * struct hrtimer_clock_base - the timer base for a specific clock |
Randy Dunlap | 05fb6bf | 2007-02-28 20:12:13 -0800 | [diff] [blame] | 135 | * @cpu_base: per cpu clock base |
Thomas Gleixner | 3c8aa39 | 2007-02-16 01:27:50 -0800 | [diff] [blame] | 136 | * @index: clock type index for per_cpu support when moving a |
| 137 | * timer to a base on another cpu. |
Vitaliy Ivanov | 4d258b2 | 2011-06-27 19:07:08 +0300 | [diff] [blame] | 138 | * @clockid: clock id for per_cpu support |
Thomas Gleixner | 92127c7 | 2006-03-26 01:38:05 -0800 | [diff] [blame] | 139 | * @active: red black tree root node for the active timers |
Thomas Gleixner | 92127c7 | 2006-03-26 01:38:05 -0800 | [diff] [blame] | 140 | * @get_time: function to retrieve the current time of the clock |
Thomas Gleixner | 92127c7 | 2006-03-26 01:38:05 -0800 | [diff] [blame] | 141 | * @softirq_time: the time when running the hrtimer queue in the softirq |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 142 | * @offset: offset of this clock to the monotonic base |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 143 | */ |
Thomas Gleixner | 3c8aa39 | 2007-02-16 01:27:50 -0800 | [diff] [blame] | 144 | struct hrtimer_clock_base { |
| 145 | struct hrtimer_cpu_base *cpu_base; |
Thomas Gleixner | ab8177b | 2011-05-20 13:05:15 +0200 | [diff] [blame] | 146 | int index; |
| 147 | clockid_t clockid; |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 148 | struct timerqueue_head active; |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 149 | ktime_t (*get_time)(void); |
Thomas Gleixner | 92127c7 | 2006-03-26 01:38:05 -0800 | [diff] [blame] | 150 | ktime_t softirq_time; |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 151 | ktime_t offset; |
Thomas Gleixner | 3c8aa39 | 2007-02-16 01:27:50 -0800 | [diff] [blame] | 152 | }; |
| 153 | |
John Stultz | e06383d | 2010-12-14 19:37:07 -0800 | [diff] [blame] | 154 | enum hrtimer_base_type { |
John Stultz | e06383d | 2010-12-14 19:37:07 -0800 | [diff] [blame] | 155 | HRTIMER_BASE_MONOTONIC, |
Thomas Gleixner | 68fa61c | 2011-05-20 23:14:04 +0200 | [diff] [blame] | 156 | HRTIMER_BASE_REALTIME, |
John Stultz | 70a08cc | 2011-02-15 10:45:16 -0800 | [diff] [blame] | 157 | HRTIMER_BASE_BOOTTIME, |
John Stultz | 90adda9 | 2013-01-21 17:00:11 -0800 | [diff] [blame] | 158 | HRTIMER_BASE_TAI, |
John Stultz | e06383d | 2010-12-14 19:37:07 -0800 | [diff] [blame] | 159 | HRTIMER_MAX_CLOCK_BASES, |
| 160 | }; |
Thomas Gleixner | 3c8aa39 | 2007-02-16 01:27:50 -0800 | [diff] [blame] | 161 | |
| 162 | /* |
| 163 | * struct hrtimer_cpu_base - the per cpu clock bases |
| 164 | * @lock: lock protecting the base and associated clock bases |
| 165 | * and timers |
Viresh Kumar | cddd024 | 2014-06-22 01:29:15 +0200 | [diff] [blame] | 166 | * @cpu: cpu number |
Thomas Gleixner | ab8177b | 2011-05-20 13:05:15 +0200 | [diff] [blame] | 167 | * @active_bases: Bitfield to mark bases with active timers |
John Stultz | f55a6fa | 2012-07-10 18:43:19 -0400 | [diff] [blame] | 168 | * @clock_was_set: Indicates that clock was set from irq context. |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 169 | * @expires_next: absolute time of the next event which was scheduled |
| 170 | * via clock_set_next_event() |
Thomas Gleixner | 9bc74919 | 2015-01-20 21:24:10 +0100 | [diff] [blame] | 171 | * @in_hrtirq: hrtimer_interrupt() is currently executing |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 172 | * @hres_active: State of high resolution mode |
Thomas Gleixner | 41d2e49 | 2009-11-13 17:05:44 +0100 | [diff] [blame] | 173 | * @hang_detected: The last hrtimer interrupt detected a hang |
| 174 | * @nr_events: Total number of hrtimer interrupt events |
| 175 | * @nr_retries: Total number of hrtimer interrupt retries |
| 176 | * @nr_hangs: Total number of hrtimer interrupt hangs |
| 177 | * @max_hang_time: Maximum time spent in hrtimer_interrupt |
Thomas Gleixner | ab8177b | 2011-05-20 13:05:15 +0200 | [diff] [blame] | 178 | * @clock_base: array of clock bases for this cpu |
Thomas Gleixner | 3c8aa39 | 2007-02-16 01:27:50 -0800 | [diff] [blame] | 179 | */ |
| 180 | struct hrtimer_cpu_base { |
Thomas Gleixner | ecb49d1 | 2009-11-17 16:36:54 +0100 | [diff] [blame] | 181 | raw_spinlock_t lock; |
Viresh Kumar | cddd024 | 2014-06-22 01:29:15 +0200 | [diff] [blame] | 182 | unsigned int cpu; |
John Stultz | f55a6fa | 2012-07-10 18:43:19 -0400 | [diff] [blame] | 183 | unsigned int active_bases; |
| 184 | unsigned int clock_was_set; |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 185 | #ifdef CONFIG_HIGH_RES_TIMERS |
| 186 | ktime_t expires_next; |
Thomas Gleixner | 9bc74919 | 2015-01-20 21:24:10 +0100 | [diff] [blame] | 187 | int in_hrtirq; |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 188 | int hres_active; |
Thomas Gleixner | 41d2e49 | 2009-11-13 17:05:44 +0100 | [diff] [blame] | 189 | int hang_detected; |
Thomas Gleixner | a6ffebc | 2015-04-14 21:08:34 +0000 | [diff] [blame^] | 190 | unsigned int nr_events; |
| 191 | unsigned int nr_retries; |
| 192 | unsigned int nr_hangs; |
| 193 | unsigned int max_hang_time; |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 194 | #endif |
Thomas Gleixner | f24444b | 2011-05-20 13:02:58 +0200 | [diff] [blame] | 195 | struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES]; |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 196 | }; |
| 197 | |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 198 | static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time) |
| 199 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 200 | timer->node.expires = time; |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 201 | timer->_softexpires = time; |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 202 | } |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 203 | |
| 204 | static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta) |
| 205 | { |
| 206 | timer->_softexpires = time; |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 207 | timer->node.expires = ktime_add_safe(time, delta); |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta) |
| 211 | { |
| 212 | timer->_softexpires = time; |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 213 | timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta)); |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 214 | } |
| 215 | |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 216 | static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64) |
| 217 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 218 | timer->node.expires.tv64 = tv64; |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 219 | timer->_softexpires.tv64 = tv64; |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time) |
| 223 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 224 | timer->node.expires = ktime_add_safe(timer->node.expires, time); |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 225 | timer->_softexpires = ktime_add_safe(timer->_softexpires, time); |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 226 | } |
| 227 | |
David Howells | 7597bc9 | 2008-11-05 17:38:47 +0000 | [diff] [blame] | 228 | static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns) |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 229 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 230 | timer->node.expires = ktime_add_ns(timer->node.expires, ns); |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 231 | timer->_softexpires = ktime_add_ns(timer->_softexpires, ns); |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 232 | } |
| 233 | |
| 234 | static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer) |
| 235 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 236 | return timer->node.expires; |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 237 | } |
| 238 | |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 239 | static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer) |
| 240 | { |
| 241 | return timer->_softexpires; |
| 242 | } |
| 243 | |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 244 | static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer) |
| 245 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 246 | return timer->node.expires.tv64; |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 247 | } |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 248 | static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer) |
| 249 | { |
| 250 | return timer->_softexpires.tv64; |
| 251 | } |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 252 | |
| 253 | static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer) |
| 254 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 255 | return ktime_to_ns(timer->node.expires); |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer) |
| 259 | { |
John Stultz | 998adc3 | 2010-09-20 19:19:17 -0700 | [diff] [blame] | 260 | return ktime_sub(timer->node.expires, timer->base->get_time()); |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 261 | } |
| 262 | |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 263 | #ifdef CONFIG_HIGH_RES_TIMERS |
| 264 | struct clock_event_device; |
| 265 | |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 266 | extern void hrtimer_interrupt(struct clock_event_device *dev); |
| 267 | |
| 268 | /* |
| 269 | * In high resolution mode the time reference must be read accurate |
| 270 | */ |
| 271 | static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer) |
| 272 | { |
| 273 | return timer->base->get_time(); |
| 274 | } |
| 275 | |
Peter Zijlstra | 8f4d37e | 2008-01-25 21:08:29 +0100 | [diff] [blame] | 276 | static inline int hrtimer_is_hres_active(struct hrtimer *timer) |
| 277 | { |
| 278 | return timer->base->cpu_base->hres_active; |
| 279 | } |
| 280 | |
Arjan van de Ven | 2075eb8 | 2008-10-07 10:57:54 -0700 | [diff] [blame] | 281 | extern void hrtimer_peek_ahead_timers(void); |
| 282 | |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 283 | /* |
| 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 Breeds | 151db1f | 2008-02-08 09:24:52 +1100 | [diff] [blame] | 289 | # 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 Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 292 | # define KTIME_MONOTONIC_RES KTIME_HIGH_RES |
| 293 | |
John Stultz | f55a6fa | 2012-07-10 18:43:19 -0400 | [diff] [blame] | 294 | extern void clock_was_set_delayed(void); |
| 295 | |
Thomas Gleixner | 398ca17 | 2015-04-14 21:08:27 +0000 | [diff] [blame] | 296 | extern unsigned int hrtimer_resolution; |
| 297 | |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 298 | #else |
| 299 | |
Tony Breeds | 151db1f | 2008-02-08 09:24:52 +1100 | [diff] [blame] | 300 | # define MONOTONIC_RES_NSEC LOW_RES_NSEC |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 301 | # define KTIME_MONOTONIC_RES KTIME_LOW_RES |
| 302 | |
Thomas Gleixner | 398ca17 | 2015-04-14 21:08:27 +0000 | [diff] [blame] | 303 | #define hrtimer_resolution LOW_RES_NSEC |
| 304 | |
Arjan van de Ven | 2075eb8 | 2008-10-07 10:57:54 -0700 | [diff] [blame] | 305 | static inline void hrtimer_peek_ahead_timers(void) { } |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 306 | |
| 307 | /* |
| 308 | * In non high resolution mode the time reference is taken from |
| 309 | * the base softirq time variable. |
| 310 | */ |
| 311 | static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer) |
| 312 | { |
| 313 | return timer->base->softirq_time; |
| 314 | } |
| 315 | |
Peter Zijlstra | 8f4d37e | 2008-01-25 21:08:29 +0100 | [diff] [blame] | 316 | static inline int hrtimer_is_hres_active(struct hrtimer *timer) |
| 317 | { |
| 318 | return 0; |
| 319 | } |
John Stultz | f55a6fa | 2012-07-10 18:43:19 -0400 | [diff] [blame] | 320 | |
| 321 | static inline void clock_was_set_delayed(void) { } |
| 322 | |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 323 | #endif |
| 324 | |
Thomas Gleixner | b12a03c | 2011-05-02 16:48:57 +0200 | [diff] [blame] | 325 | extern void clock_was_set(void); |
Thomas Gleixner | 9ec2690 | 2011-05-20 16:18:50 +0200 | [diff] [blame] | 326 | #ifdef CONFIG_TIMERFD |
| 327 | extern void timerfd_clock_was_set(void); |
| 328 | #else |
| 329 | static inline void timerfd_clock_was_set(void) { } |
| 330 | #endif |
Thomas Gleixner | b12a03c | 2011-05-02 16:48:57 +0200 | [diff] [blame] | 331 | extern void hrtimers_resume(void); |
| 332 | |
Arjan van de Ven | 2e94d1f | 2008-09-10 16:06:00 -0700 | [diff] [blame] | 333 | DECLARE_PER_CPU(struct tick_device, tick_cpu_device); |
Arjan van de Ven | 2e94d1f | 2008-09-10 16:06:00 -0700 | [diff] [blame] | 334 | |
| 335 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 336 | /* Exported timer functions: */ |
| 337 | |
| 338 | /* Initialize timers: */ |
George Anzinger | 7978672c | 2006-02-01 03:05:11 -0800 | [diff] [blame] | 339 | extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock, |
| 340 | enum hrtimer_mode mode); |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 341 | |
Thomas Gleixner | 237fc6e | 2008-04-30 00:55:04 -0700 | [diff] [blame] | 342 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
| 343 | extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock, |
| 344 | enum hrtimer_mode mode); |
| 345 | |
| 346 | extern void destroy_hrtimer_on_stack(struct hrtimer *timer); |
| 347 | #else |
| 348 | static inline void hrtimer_init_on_stack(struct hrtimer *timer, |
| 349 | clockid_t which_clock, |
| 350 | enum hrtimer_mode mode) |
| 351 | { |
| 352 | hrtimer_init(timer, which_clock, mode); |
| 353 | } |
| 354 | static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { } |
| 355 | #endif |
| 356 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 357 | /* Basic timer operations: */ |
| 358 | extern int hrtimer_start(struct hrtimer *timer, ktime_t tim, |
| 359 | const enum hrtimer_mode mode); |
Arjan van de Ven | da8f2e1 | 2008-09-07 10:47:46 -0700 | [diff] [blame] | 360 | extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim, |
| 361 | unsigned long range_ns, const enum hrtimer_mode mode); |
Peter Zijlstra | 7f1e2ca | 2009-03-13 12:21:27 +0100 | [diff] [blame] | 362 | extern int |
| 363 | __hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim, |
| 364 | unsigned long delta_ns, |
| 365 | const enum hrtimer_mode mode, int wakeup); |
| 366 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 367 | extern int hrtimer_cancel(struct hrtimer *timer); |
| 368 | extern int hrtimer_try_to_cancel(struct hrtimer *timer); |
| 369 | |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 370 | static inline int hrtimer_start_expires(struct hrtimer *timer, |
| 371 | enum hrtimer_mode mode) |
| 372 | { |
Arjan van de Ven | da8f2e1 | 2008-09-07 10:47:46 -0700 | [diff] [blame] | 373 | unsigned long delta; |
| 374 | ktime_t soft, hard; |
| 375 | soft = hrtimer_get_softexpires(timer); |
| 376 | hard = hrtimer_get_expires(timer); |
| 377 | delta = ktime_to_ns(ktime_sub(hard, soft)); |
Arjan van de Ven | 4ce105d | 2008-09-07 15:31:39 -0700 | [diff] [blame] | 378 | return hrtimer_start_range_ns(timer, soft, delta, mode); |
Arjan van de Ven | 63ca243 | 2008-09-01 14:35:02 -0700 | [diff] [blame] | 379 | } |
| 380 | |
Thomas Gleixner | c9cb2e3 | 2007-02-16 01:27:49 -0800 | [diff] [blame] | 381 | static inline int hrtimer_restart(struct hrtimer *timer) |
| 382 | { |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 383 | return hrtimer_start_expires(timer, HRTIMER_MODE_ABS); |
Thomas Gleixner | c9cb2e3 | 2007-02-16 01:27:49 -0800 | [diff] [blame] | 384 | } |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 385 | |
| 386 | /* Query timers: */ |
| 387 | extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer); |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 388 | |
Tony Lindgren | 6923974 | 2006-03-06 15:42:45 -0800 | [diff] [blame] | 389 | extern ktime_t hrtimer_get_next_event(void); |
Tony Lindgren | 6923974 | 2006-03-06 15:42:45 -0800 | [diff] [blame] | 390 | |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 391 | /* |
Thomas Gleixner | 53370d2 | 2011-03-10 18:26:33 +0100 | [diff] [blame] | 392 | * A timer is active, when it is enqueued into the rbtree or the |
| 393 | * callback function is running or it's in the state of being migrated |
| 394 | * to another cpu. |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 395 | */ |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 396 | static inline int hrtimer_active(const struct hrtimer *timer) |
| 397 | { |
Thomas Gleixner | 303e967 | 2007-02-16 01:27:51 -0800 | [diff] [blame] | 398 | return timer->state != HRTIMER_STATE_INACTIVE; |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 399 | } |
| 400 | |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 401 | /* |
| 402 | * Helper function to check, whether the timer is on one of the queues |
| 403 | */ |
| 404 | static inline int hrtimer_is_queued(struct hrtimer *timer) |
| 405 | { |
Peter Zijlstra | ca10949 | 2008-11-25 12:43:51 +0100 | [diff] [blame] | 406 | return timer->state & HRTIMER_STATE_ENQUEUED; |
Thomas Gleixner | 54cdfdb | 2007-02-16 01:28:11 -0800 | [diff] [blame] | 407 | } |
| 408 | |
Oliver Hartkopp | 4346f65 | 2008-04-30 23:04:37 +0200 | [diff] [blame] | 409 | /* |
| 410 | * Helper function to check, whether the timer is running the callback |
| 411 | * function |
| 412 | */ |
| 413 | static inline int hrtimer_callback_running(struct hrtimer *timer) |
| 414 | { |
| 415 | return timer->state & HRTIMER_STATE_CALLBACK; |
| 416 | } |
| 417 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 418 | /* Forward a hrtimer so it expires after now: */ |
Davide Libenzi | 4d672e7 | 2008-02-04 22:27:26 -0800 | [diff] [blame] | 419 | extern u64 |
Roman Zippel | 44f2147 | 2006-03-26 01:38:06 -0800 | [diff] [blame] | 420 | hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval); |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 421 | |
Thomas Gleixner | 91e5a21 | 2015-04-13 21:02:22 +0000 | [diff] [blame] | 422 | /** |
| 423 | * hrtimer_forward_now - forward the timer expiry so it expires after now |
| 424 | * @timer: hrtimer to forward |
| 425 | * @interval: the interval to forward |
| 426 | * |
| 427 | * Forward the timer expiry so it will expire after the current time |
| 428 | * of the hrtimer clock base. Returns the number of overruns. |
| 429 | * |
| 430 | * Can be safely called from the callback function of @timer. If |
| 431 | * called from other contexts @timer must neither be enqueued nor |
| 432 | * running the callback and the caller needs to take care of |
| 433 | * serialization. |
| 434 | * |
| 435 | * Note: This only updates the timer expiry value and does not requeue |
| 436 | * the timer. |
| 437 | */ |
Davide Libenzi | 4d672e7 | 2008-02-04 22:27:26 -0800 | [diff] [blame] | 438 | static inline u64 hrtimer_forward_now(struct hrtimer *timer, |
| 439 | ktime_t interval) |
Davide Libenzi | 5e05ad7 | 2008-02-04 22:27:25 -0800 | [diff] [blame] | 440 | { |
| 441 | return hrtimer_forward(timer, timer->base->get_time(), interval); |
| 442 | } |
| 443 | |
Thomas Gleixner | 10c94ec | 2006-01-09 20:52:35 -0800 | [diff] [blame] | 444 | /* Precise sleep: */ |
| 445 | extern long hrtimer_nanosleep(struct timespec *rqtp, |
Oleg Nesterov | 080344b | 2008-02-01 17:29:05 +0300 | [diff] [blame] | 446 | struct timespec __user *rmtp, |
Thomas Gleixner | 10c94ec | 2006-01-09 20:52:35 -0800 | [diff] [blame] | 447 | const enum hrtimer_mode mode, |
| 448 | const clockid_t clockid); |
Toyo Abe | 1711ef3 | 2006-09-29 02:00:28 -0700 | [diff] [blame] | 449 | extern long hrtimer_nanosleep_restart(struct restart_block *restart_block); |
Thomas Gleixner | 10c94ec | 2006-01-09 20:52:35 -0800 | [diff] [blame] | 450 | |
Thomas Gleixner | 00362e3 | 2006-03-31 02:31:17 -0800 | [diff] [blame] | 451 | extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, |
| 452 | struct task_struct *tsk); |
| 453 | |
Arjan van de Ven | 654c8e0 | 2008-09-01 15:47:08 -0700 | [diff] [blame] | 454 | extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta, |
| 455 | const enum hrtimer_mode mode); |
Carsten Emde | 351b3f7 | 2010-04-02 22:40:19 +0200 | [diff] [blame] | 456 | extern int schedule_hrtimeout_range_clock(ktime_t *expires, |
| 457 | unsigned long delta, const enum hrtimer_mode mode, int clock); |
Arjan van de Ven | 7bb6743 | 2008-08-31 08:05:58 -0700 | [diff] [blame] | 458 | extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode); |
| 459 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 460 | /* Soft interrupt function to run the hrtimer queues: */ |
| 461 | extern void hrtimer_run_queues(void); |
Peter Zijlstra | d3d7445 | 2008-01-25 21:08:31 +0100 | [diff] [blame] | 462 | extern void hrtimer_run_pending(void); |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 463 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 464 | /* Bootup initialization: */ |
| 465 | extern void __init hrtimers_init(void); |
| 466 | |
Ingo Molnar | 88ad0bf6 | 2007-02-16 01:28:16 -0800 | [diff] [blame] | 467 | /* Show pending timers: */ |
| 468 | extern void sysrq_timer_list_show(void); |
| 469 | |
Thomas Gleixner | c0a3132 | 2006-01-09 20:52:32 -0800 | [diff] [blame] | 470 | #endif |