Commit | Line | Data |
---|---|---|
c0a31329 TG |
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> | |
40b86062 | 23 | #include <linux/percpu.h> |
507e1231 | 24 | #include <linux/timer.h> |
998adc3d | 25 | #include <linux/timerqueue.h> |
c0a31329 | 26 | |
3c8aa39d TG |
27 | struct hrtimer_clock_base; |
28 | struct hrtimer_cpu_base; | |
29 | ||
c0a31329 TG |
30 | /* |
31 | * Mode arguments of xxx_hrtimer functions: | |
32 | */ | |
33 | enum hrtimer_mode { | |
597d0275 AB |
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, | |
c0a31329 TG |
39 | }; |
40 | ||
c9cb2e3d TG |
41 | /* |
42 | * Return values for the callback function | |
43 | */ | |
c0a31329 | 44 | enum hrtimer_restart { |
c9cb2e3d TG |
45 | HRTIMER_NORESTART, /* Timer is not restarted */ |
46 | HRTIMER_RESTART, /* Timer must be restarted */ | |
c0a31329 TG |
47 | }; |
48 | ||
54cdfdb4 TG |
49 | /* |
50 | * Values to track state of the timer | |
303e967f TG |
51 | * |
52 | * Possible states: | |
53 | * | |
54 | * 0x00 inactive | |
55 | * 0x01 enqueued into rbtree | |
56 | * 0x02 callback function running | |
53370d2e | 57 | * 0x04 timer is migrated to another cpu |
54cdfdb4 | 58 | * |
b00c1a99 | 59 | * Special cases: |
303e967f TG |
60 | * 0x03 callback function running and enqueued |
61 | * (was requeued on another CPU) | |
53370d2e TG |
62 | * 0x05 timer was migrated on CPU hotunplug |
63 | * | |
303e967f TG |
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 | * | |
53370d2e TG |
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. | |
303e967f TG |
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 | |
ca109491 | 83 | #define HRTIMER_STATE_MIGRATE 0x04 |
303e967f | 84 | |
c0a31329 TG |
85 | /** |
86 | * struct hrtimer - the basic hrtimer structure | |
998adc3d JS |
87 | * @node: timerqueue node, which also manages node.expires, |
88 | * the absolute expiry time in the hrtimers internal | |
c0a31329 | 89 | * representation. The time is related to the clock on |
592aa999 TG |
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. | |
c0a31329 | 96 | * @function: timer expiry callback function |
c0a31329 | 97 | * @base: pointer to the timer base (per cpu and per clock) |
303e967f | 98 | * @state: state information (See bit values above) |
e2e680fb VK |
99 | * @start_pid: timer statistics field to store the pid of the task which |
100 | * started the timer | |
54cdfdb4 TG |
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 | |
c0a31329 | 105 | * |
54cdfdb4 | 106 | * The hrtimer structure must be initialized by hrtimer_init() |
c0a31329 TG |
107 | */ |
108 | struct hrtimer { | |
998adc3d | 109 | struct timerqueue_node node; |
654c8e0b | 110 | ktime_t _softexpires; |
3c8aa39d TG |
111 | enum hrtimer_restart (*function)(struct hrtimer *); |
112 | struct hrtimer_clock_base *base; | |
303e967f | 113 | unsigned long state; |
82f67cd9 | 114 | #ifdef CONFIG_TIMER_STATS |
1b024690 | 115 | int start_pid; |
82f67cd9 IM |
116 | void *start_site; |
117 | char start_comm[16]; | |
82f67cd9 | 118 | #endif |
c0a31329 TG |
119 | }; |
120 | ||
00362e33 TG |
121 | /** |
122 | * struct hrtimer_sleeper - simple sleeper structure | |
00362e33 TG |
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 | ||
c0a31329 | 133 | /** |
d1d67174 | 134 | * struct hrtimer_clock_base - the timer base for a specific clock |
05fb6bf0 | 135 | * @cpu_base: per cpu clock base |
3c8aa39d TG |
136 | * @index: clock type index for per_cpu support when moving a |
137 | * timer to a base on another cpu. | |
4d258b25 | 138 | * @clockid: clock id for per_cpu support |
92127c7a | 139 | * @active: red black tree root node for the active timers |
92127c7a | 140 | * @get_time: function to retrieve the current time of the clock |
54cdfdb4 | 141 | * @offset: offset of this clock to the monotonic base |
c0a31329 | 142 | */ |
3c8aa39d TG |
143 | struct hrtimer_clock_base { |
144 | struct hrtimer_cpu_base *cpu_base; | |
ab8177bc TG |
145 | int index; |
146 | clockid_t clockid; | |
998adc3d | 147 | struct timerqueue_head active; |
c0a31329 | 148 | ktime_t (*get_time)(void); |
54cdfdb4 | 149 | ktime_t offset; |
3c8aa39d TG |
150 | }; |
151 | ||
e06383db | 152 | enum hrtimer_base_type { |
e06383db | 153 | HRTIMER_BASE_MONOTONIC, |
68fa61c0 | 154 | HRTIMER_BASE_REALTIME, |
70a08cca | 155 | HRTIMER_BASE_BOOTTIME, |
90adda98 | 156 | HRTIMER_BASE_TAI, |
e06383db JS |
157 | HRTIMER_MAX_CLOCK_BASES, |
158 | }; | |
3c8aa39d TG |
159 | |
160 | /* | |
161 | * struct hrtimer_cpu_base - the per cpu clock bases | |
162 | * @lock: lock protecting the base and associated clock bases | |
163 | * and timers | |
cddd0248 | 164 | * @cpu: cpu number |
ab8177bc | 165 | * @active_bases: Bitfield to mark bases with active timers |
868a3e91 | 166 | * @clock_was_set_seq: Sequence counter of clock was set events |
54cdfdb4 TG |
167 | * @expires_next: absolute time of the next event which was scheduled |
168 | * via clock_set_next_event() | |
9bc74919 | 169 | * @in_hrtirq: hrtimer_interrupt() is currently executing |
54cdfdb4 | 170 | * @hres_active: State of high resolution mode |
41d2e494 TG |
171 | * @hang_detected: The last hrtimer interrupt detected a hang |
172 | * @nr_events: Total number of hrtimer interrupt events | |
173 | * @nr_retries: Total number of hrtimer interrupt retries | |
174 | * @nr_hangs: Total number of hrtimer interrupt hangs | |
175 | * @max_hang_time: Maximum time spent in hrtimer_interrupt | |
ab8177bc | 176 | * @clock_base: array of clock bases for this cpu |
3c8aa39d TG |
177 | */ |
178 | struct hrtimer_cpu_base { | |
ecb49d1a | 179 | raw_spinlock_t lock; |
cddd0248 | 180 | unsigned int cpu; |
f55a6faa | 181 | unsigned int active_bases; |
868a3e91 | 182 | unsigned int clock_was_set_seq; |
54cdfdb4 | 183 | #ifdef CONFIG_HIGH_RES_TIMERS |
e19ffe8b TG |
184 | unsigned int in_hrtirq : 1, |
185 | hres_active : 1, | |
186 | hang_detected : 1; | |
54cdfdb4 | 187 | ktime_t expires_next; |
a6ffebce TG |
188 | unsigned int nr_events; |
189 | unsigned int nr_retries; | |
190 | unsigned int nr_hangs; | |
191 | unsigned int max_hang_time; | |
54cdfdb4 | 192 | #endif |
f24444b0 | 193 | struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES]; |
6d9a1411 | 194 | } ____cacheline_aligned; |
c0a31329 | 195 | |
63ca243b AV |
196 | static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time) |
197 | { | |
998adc3d | 198 | timer->node.expires = time; |
654c8e0b | 199 | timer->_softexpires = time; |
63ca243b | 200 | } |
654c8e0b AV |
201 | |
202 | static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta) | |
203 | { | |
204 | timer->_softexpires = time; | |
998adc3d | 205 | timer->node.expires = ktime_add_safe(time, delta); |
654c8e0b AV |
206 | } |
207 | ||
208 | static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta) | |
209 | { | |
210 | timer->_softexpires = time; | |
998adc3d | 211 | timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta)); |
654c8e0b AV |
212 | } |
213 | ||
63ca243b AV |
214 | static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64) |
215 | { | |
998adc3d | 216 | timer->node.expires.tv64 = tv64; |
654c8e0b | 217 | timer->_softexpires.tv64 = tv64; |
63ca243b AV |
218 | } |
219 | ||
220 | static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time) | |
221 | { | |
998adc3d | 222 | timer->node.expires = ktime_add_safe(timer->node.expires, time); |
654c8e0b | 223 | timer->_softexpires = ktime_add_safe(timer->_softexpires, time); |
63ca243b AV |
224 | } |
225 | ||
7597bc94 | 226 | static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns) |
63ca243b | 227 | { |
998adc3d | 228 | timer->node.expires = ktime_add_ns(timer->node.expires, ns); |
654c8e0b | 229 | timer->_softexpires = ktime_add_ns(timer->_softexpires, ns); |
63ca243b AV |
230 | } |
231 | ||
232 | static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer) | |
233 | { | |
998adc3d | 234 | return timer->node.expires; |
63ca243b AV |
235 | } |
236 | ||
654c8e0b AV |
237 | static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer) |
238 | { | |
239 | return timer->_softexpires; | |
240 | } | |
241 | ||
63ca243b AV |
242 | static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer) |
243 | { | |
998adc3d | 244 | return timer->node.expires.tv64; |
63ca243b | 245 | } |
654c8e0b AV |
246 | static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer) |
247 | { | |
248 | return timer->_softexpires.tv64; | |
249 | } | |
63ca243b AV |
250 | |
251 | static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer) | |
252 | { | |
998adc3d | 253 | return ktime_to_ns(timer->node.expires); |
63ca243b AV |
254 | } |
255 | ||
256 | static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer) | |
257 | { | |
998adc3d | 258 | return ktime_sub(timer->node.expires, timer->base->get_time()); |
63ca243b AV |
259 | } |
260 | ||
54cdfdb4 TG |
261 | static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer) |
262 | { | |
263 | return timer->base->get_time(); | |
264 | } | |
265 | ||
21d6d52a TG |
266 | #ifdef CONFIG_HIGH_RES_TIMERS |
267 | struct clock_event_device; | |
268 | ||
269 | extern void hrtimer_interrupt(struct clock_event_device *dev); | |
270 | ||
8f4d37ec PZ |
271 | static inline int hrtimer_is_hres_active(struct hrtimer *timer) |
272 | { | |
273 | return timer->base->cpu_base->hres_active; | |
274 | } | |
275 | ||
2075eb8d AV |
276 | extern void hrtimer_peek_ahead_timers(void); |
277 | ||
54cdfdb4 TG |
278 | /* |
279 | * The resolution of the clocks. The resolution value is returned in | |
280 | * the clock_getres() system call to give application programmers an | |
281 | * idea of the (in)accuracy of timers. Timer values are rounded up to | |
282 | * this resolution values. | |
283 | */ | |
151db1fc TB |
284 | # define HIGH_RES_NSEC 1 |
285 | # define KTIME_HIGH_RES (ktime_t) { .tv64 = HIGH_RES_NSEC } | |
286 | # define MONOTONIC_RES_NSEC HIGH_RES_NSEC | |
54cdfdb4 TG |
287 | # define KTIME_MONOTONIC_RES KTIME_HIGH_RES |
288 | ||
f55a6faa JS |
289 | extern void clock_was_set_delayed(void); |
290 | ||
398ca17f TG |
291 | extern unsigned int hrtimer_resolution; |
292 | ||
54cdfdb4 TG |
293 | #else |
294 | ||
151db1fc | 295 | # define MONOTONIC_RES_NSEC LOW_RES_NSEC |
54cdfdb4 TG |
296 | # define KTIME_MONOTONIC_RES KTIME_LOW_RES |
297 | ||
398ca17f TG |
298 | #define hrtimer_resolution LOW_RES_NSEC |
299 | ||
2075eb8d | 300 | static inline void hrtimer_peek_ahead_timers(void) { } |
54cdfdb4 | 301 | |
8f4d37ec PZ |
302 | static inline int hrtimer_is_hres_active(struct hrtimer *timer) |
303 | { | |
304 | return 0; | |
305 | } | |
f55a6faa JS |
306 | |
307 | static inline void clock_was_set_delayed(void) { } | |
308 | ||
54cdfdb4 TG |
309 | #endif |
310 | ||
b12a03ce | 311 | extern void clock_was_set(void); |
9ec26907 TG |
312 | #ifdef CONFIG_TIMERFD |
313 | extern void timerfd_clock_was_set(void); | |
314 | #else | |
315 | static inline void timerfd_clock_was_set(void) { } | |
316 | #endif | |
b12a03ce TG |
317 | extern void hrtimers_resume(void); |
318 | ||
2e94d1f7 | 319 | DECLARE_PER_CPU(struct tick_device, tick_cpu_device); |
2e94d1f7 AV |
320 | |
321 | ||
c0a31329 TG |
322 | /* Exported timer functions: */ |
323 | ||
324 | /* Initialize timers: */ | |
7978672c GA |
325 | extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock, |
326 | enum hrtimer_mode mode); | |
c0a31329 | 327 | |
237fc6e7 TG |
328 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
329 | extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock, | |
330 | enum hrtimer_mode mode); | |
331 | ||
332 | extern void destroy_hrtimer_on_stack(struct hrtimer *timer); | |
333 | #else | |
334 | static inline void hrtimer_init_on_stack(struct hrtimer *timer, | |
335 | clockid_t which_clock, | |
336 | enum hrtimer_mode mode) | |
337 | { | |
338 | hrtimer_init(timer, which_clock, mode); | |
339 | } | |
340 | static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { } | |
341 | #endif | |
342 | ||
c0a31329 TG |
343 | /* Basic timer operations: */ |
344 | extern int hrtimer_start(struct hrtimer *timer, ktime_t tim, | |
345 | const enum hrtimer_mode mode); | |
da8f2e17 AV |
346 | extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim, |
347 | unsigned long range_ns, const enum hrtimer_mode mode); | |
7f1e2ca9 PZ |
348 | extern int |
349 | __hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim, | |
350 | unsigned long delta_ns, | |
351 | const enum hrtimer_mode mode, int wakeup); | |
352 | ||
c0a31329 TG |
353 | extern int hrtimer_cancel(struct hrtimer *timer); |
354 | extern int hrtimer_try_to_cancel(struct hrtimer *timer); | |
355 | ||
63ca243b AV |
356 | static inline int hrtimer_start_expires(struct hrtimer *timer, |
357 | enum hrtimer_mode mode) | |
358 | { | |
da8f2e17 AV |
359 | unsigned long delta; |
360 | ktime_t soft, hard; | |
361 | soft = hrtimer_get_softexpires(timer); | |
362 | hard = hrtimer_get_expires(timer); | |
363 | delta = ktime_to_ns(ktime_sub(hard, soft)); | |
4ce105d3 | 364 | return hrtimer_start_range_ns(timer, soft, delta, mode); |
63ca243b AV |
365 | } |
366 | ||
c9cb2e3d TG |
367 | static inline int hrtimer_restart(struct hrtimer *timer) |
368 | { | |
654c8e0b | 369 | return hrtimer_start_expires(timer, HRTIMER_MODE_ABS); |
c9cb2e3d | 370 | } |
c0a31329 TG |
371 | |
372 | /* Query timers: */ | |
373 | extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer); | |
c0a31329 | 374 | |
69239749 | 375 | extern ktime_t hrtimer_get_next_event(void); |
69239749 | 376 | |
303e967f | 377 | /* |
53370d2e TG |
378 | * A timer is active, when it is enqueued into the rbtree or the |
379 | * callback function is running or it's in the state of being migrated | |
380 | * to another cpu. | |
303e967f | 381 | */ |
c0a31329 TG |
382 | static inline int hrtimer_active(const struct hrtimer *timer) |
383 | { | |
303e967f | 384 | return timer->state != HRTIMER_STATE_INACTIVE; |
c0a31329 TG |
385 | } |
386 | ||
54cdfdb4 TG |
387 | /* |
388 | * Helper function to check, whether the timer is on one of the queues | |
389 | */ | |
390 | static inline int hrtimer_is_queued(struct hrtimer *timer) | |
391 | { | |
ca109491 | 392 | return timer->state & HRTIMER_STATE_ENQUEUED; |
54cdfdb4 TG |
393 | } |
394 | ||
4346f654 OH |
395 | /* |
396 | * Helper function to check, whether the timer is running the callback | |
397 | * function | |
398 | */ | |
399 | static inline int hrtimer_callback_running(struct hrtimer *timer) | |
400 | { | |
401 | return timer->state & HRTIMER_STATE_CALLBACK; | |
402 | } | |
403 | ||
c0a31329 | 404 | /* Forward a hrtimer so it expires after now: */ |
4d672e7a | 405 | extern u64 |
44f21475 | 406 | hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval); |
c0a31329 | 407 | |
91e5a217 TG |
408 | /** |
409 | * hrtimer_forward_now - forward the timer expiry so it expires after now | |
410 | * @timer: hrtimer to forward | |
411 | * @interval: the interval to forward | |
412 | * | |
413 | * Forward the timer expiry so it will expire after the current time | |
414 | * of the hrtimer clock base. Returns the number of overruns. | |
415 | * | |
416 | * Can be safely called from the callback function of @timer. If | |
417 | * called from other contexts @timer must neither be enqueued nor | |
418 | * running the callback and the caller needs to take care of | |
419 | * serialization. | |
420 | * | |
421 | * Note: This only updates the timer expiry value and does not requeue | |
422 | * the timer. | |
423 | */ | |
4d672e7a DL |
424 | static inline u64 hrtimer_forward_now(struct hrtimer *timer, |
425 | ktime_t interval) | |
5e05ad7d DL |
426 | { |
427 | return hrtimer_forward(timer, timer->base->get_time(), interval); | |
428 | } | |
429 | ||
10c94ec1 TG |
430 | /* Precise sleep: */ |
431 | extern long hrtimer_nanosleep(struct timespec *rqtp, | |
080344b9 | 432 | struct timespec __user *rmtp, |
10c94ec1 TG |
433 | const enum hrtimer_mode mode, |
434 | const clockid_t clockid); | |
1711ef38 | 435 | extern long hrtimer_nanosleep_restart(struct restart_block *restart_block); |
10c94ec1 | 436 | |
00362e33 TG |
437 | extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, |
438 | struct task_struct *tsk); | |
439 | ||
654c8e0b AV |
440 | extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta, |
441 | const enum hrtimer_mode mode); | |
351b3f7a CE |
442 | extern int schedule_hrtimeout_range_clock(ktime_t *expires, |
443 | unsigned long delta, const enum hrtimer_mode mode, int clock); | |
7bb67439 AV |
444 | extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode); |
445 | ||
c0a31329 TG |
446 | /* Soft interrupt function to run the hrtimer queues: */ |
447 | extern void hrtimer_run_queues(void); | |
d3d74453 | 448 | extern void hrtimer_run_pending(void); |
c0a31329 TG |
449 | |
450 | /* Bootup initialization: */ | |
451 | extern void __init hrtimers_init(void); | |
452 | ||
88ad0bf6 IM |
453 | /* Show pending timers: */ |
454 | extern void sysrq_timer_list_show(void); | |
455 | ||
c0a31329 | 456 | #endif |