51932e5acf7ce8cd44b57c0a7fe2288013d1967d
[linux-2.6.git] / include / linux / hrtimer.h
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>
23 #include <linux/percpu.h>
24 #include <linux/timer.h>
25 #include <linux/timerqueue.h>
26
27 struct hrtimer_clock_base;
28 struct hrtimer_cpu_base;
29
30 /*
31  * Mode arguments of xxx_hrtimer functions:
32  */
33 enum hrtimer_mode {
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,
39 };
40
41 /*
42  * Return values for the callback function
43  */
44 enum hrtimer_restart {
45         HRTIMER_NORESTART,      /* Timer is not restarted */
46         HRTIMER_RESTART,        /* Timer must be restarted */
47 };
48
49 /*
50  * Values to track state of the timer
51  *
52  * Possible states:
53  *
54  * 0x00         inactive
55  * 0x01         enqueued into rbtree
56  * 0x02         callback function running
57  * 0x04         timer is migrated to another cpu
58  *
59  * Special cases:
60  * 0x03         callback function running and enqueued
61  *              (was requeued on another CPU)
62  * 0x05         timer was migrated on CPU hotunplug
63  *
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  *
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.
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
83 #define HRTIMER_STATE_MIGRATE   0x04
84
85 /**
86  * struct hrtimer - the basic hrtimer structure
87  * @node:       timerqueue node, which also manages node.expires,
88  *              the absolute expiry time in the hrtimers internal
89  *              representation. The time is related to the clock on
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.
96  * @function:   timer expiry callback function
97  * @base:       pointer to the timer base (per cpu and per clock)
98  * @state:      state information (See bit values above)
99  * @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
105  *
106  * The hrtimer structure must be initialized by hrtimer_init()
107  */
108 struct hrtimer {
109         struct timerqueue_node          node;
110         ktime_t                         _softexpires;
111         enum hrtimer_restart            (*function)(struct hrtimer *);
112         struct hrtimer_clock_base       *base;
113         unsigned long                   state;
114 #ifdef CONFIG_TIMER_STATS
115         int                             start_pid;
116         void                            *start_site;
117         char                            start_comm[16];
118 #endif
119 };
120
121 /**
122  * struct hrtimer_sleeper - simple sleeper structure
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 /**
134  * struct hrtimer_clock_base - the timer base for a specific clock
135  * @cpu_base:           per cpu clock base
136  * @index:              clock type index for per_cpu support when moving a
137  *                      timer to a base on another cpu.
138  * @active:             red black tree root node for the active timers
139  * @resolution:         the resolution of the clock, in nanoseconds
140  * @get_time:           function to retrieve the current time of the clock
141  * @softirq_time:       the time when running the hrtimer queue in the softirq
142  * @offset:             offset of this clock to the monotonic base
143  */
144 struct hrtimer_clock_base {
145         struct hrtimer_cpu_base *cpu_base;
146         int                     index;
147         clockid_t               clockid;
148         struct timerqueue_head  active;
149         ktime_t                 resolution;
150         ktime_t                 (*get_time)(void);
151         ktime_t                 softirq_time;
152         ktime_t                 offset;
153 };
154
155 enum  hrtimer_base_type {
156         HRTIMER_BASE_MONOTONIC,
157         HRTIMER_BASE_REALTIME,
158         HRTIMER_BASE_BOOTTIME,
159         HRTIMER_MAX_CLOCK_BASES,
160 };
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
166  * @active_bases:       Bitfield to mark bases with active timers
167  * @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
170  * @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
175  * @clock_base:         array of clock bases for this cpu
176  */
177 struct hrtimer_cpu_base {
178         raw_spinlock_t                  lock;
179         unsigned long                   active_bases;
180 #ifdef CONFIG_HIGH_RES_TIMERS
181         ktime_t                         expires_next;
182         int                             hres_active;
183         int                             hang_detected;
184         unsigned long                   nr_events;
185         unsigned long                   nr_retries;
186         unsigned long                   nr_hangs;
187         ktime_t                         max_hang_time;
188 #endif
189         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
190 };
191
192 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
193 {
194         timer->node.expires = time;
195         timer->_softexpires = time;
196 }
197
198 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
199 {
200         timer->_softexpires = time;
201         timer->node.expires = ktime_add_safe(time, delta);
202 }
203
204 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
205 {
206         timer->_softexpires = time;
207         timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
208 }
209
210 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
211 {
212         timer->node.expires.tv64 = tv64;
213         timer->_softexpires.tv64 = tv64;
214 }
215
216 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
217 {
218         timer->node.expires = ktime_add_safe(timer->node.expires, time);
219         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
220 }
221
222 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
223 {
224         timer->node.expires = ktime_add_ns(timer->node.expires, ns);
225         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
226 }
227
228 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
229 {
230         return timer->node.expires;
231 }
232
233 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
234 {
235         return timer->_softexpires;
236 }
237
238 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
239 {
240         return timer->node.expires.tv64;
241 }
242 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
243 {
244         return timer->_softexpires.tv64;
245 }
246
247 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
248 {
249         return ktime_to_ns(timer->node.expires);
250 }
251
252 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
253 {
254         return ktime_sub(timer->node.expires, timer->base->get_time());
255 }
256
257 #ifdef CONFIG_HIGH_RES_TIMERS
258 struct clock_event_device;
259
260 extern void hrtimer_interrupt(struct clock_event_device *dev);
261
262 /*
263  * In high resolution mode the time reference must be read accurate
264  */
265 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
266 {
267         return timer->base->get_time();
268 }
269
270 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
271 {
272         return timer->base->cpu_base->hres_active;
273 }
274
275 extern void hrtimer_peek_ahead_timers(void);
276
277 /*
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  */
283 # define HIGH_RES_NSEC          1
284 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
285 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
286 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
287
288 #else
289
290 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
291 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
292
293 static inline void hrtimer_peek_ahead_timers(void) { }
294
295 /*
296  * In non high resolution mode the time reference is taken from
297  * the base softirq time variable.
298  */
299 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
300 {
301         return timer->base->softirq_time;
302 }
303
304 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
305 {
306         return 0;
307 }
308 #endif
309
310 extern void clock_was_set(void);
311 #ifdef CONFIG_TIMERFD
312 extern void timerfd_clock_was_set(void);
313 #else
314 static inline void timerfd_clock_was_set(void) { }
315 #endif
316 extern void hrtimers_resume(void);
317
318 extern ktime_t ktime_get(void);
319 extern ktime_t ktime_get_real(void);
320 extern ktime_t ktime_get_boottime(void);
321 extern ktime_t ktime_get_monotonic_offset(void);
322
323 DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
324
325
326 /* Exported timer functions: */
327
328 /* Initialize timers: */
329 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
330                          enum hrtimer_mode mode);
331
332 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
333 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
334                                   enum hrtimer_mode mode);
335
336 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
337 #else
338 static 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 }
344 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
345 #endif
346
347 /* Basic timer operations: */
348 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
349                          const enum hrtimer_mode mode);
350 extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
351                         unsigned long range_ns, const enum hrtimer_mode mode);
352 extern 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
357 extern int hrtimer_cancel(struct hrtimer *timer);
358 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
359
360 static inline int hrtimer_start_expires(struct hrtimer *timer,
361                                                 enum hrtimer_mode mode)
362 {
363         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));
368         return hrtimer_start_range_ns(timer, soft, delta, mode);
369 }
370
371 static inline int hrtimer_restart(struct hrtimer *timer)
372 {
373         return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
374 }
375
376 /* Query timers: */
377 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
378 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
379
380 extern ktime_t hrtimer_get_next_event(void);
381
382 /*
383  * 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.
386  */
387 static inline int hrtimer_active(const struct hrtimer *timer)
388 {
389         return timer->state != HRTIMER_STATE_INACTIVE;
390 }
391
392 /*
393  * Helper function to check, whether the timer is on one of the queues
394  */
395 static inline int hrtimer_is_queued(struct hrtimer *timer)
396 {
397         return timer->state & HRTIMER_STATE_ENQUEUED;
398 }
399
400 /*
401  * Helper function to check, whether the timer is running the callback
402  * function
403  */
404 static inline int hrtimer_callback_running(struct hrtimer *timer)
405 {
406         return timer->state & HRTIMER_STATE_CALLBACK;
407 }
408
409 /* Forward a hrtimer so it expires after now: */
410 extern u64
411 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
412
413 /* Forward a hrtimer so it expires after the hrtimer's current now */
414 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
415                                       ktime_t interval)
416 {
417         return hrtimer_forward(timer, timer->base->get_time(), interval);
418 }
419
420 /* Precise sleep: */
421 extern long hrtimer_nanosleep(struct timespec *rqtp,
422                               struct timespec __user *rmtp,
423                               const enum hrtimer_mode mode,
424                               const clockid_t clockid);
425 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
426
427 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
428                                  struct task_struct *tsk);
429
430 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
431                                                 const enum hrtimer_mode mode);
432 extern int schedule_hrtimeout_range_clock(ktime_t *expires,
433                 unsigned long delta, const enum hrtimer_mode mode, int clock);
434 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
435
436 /* Soft interrupt function to run the hrtimer queues: */
437 extern void hrtimer_run_queues(void);
438 extern void hrtimer_run_pending(void);
439
440 /* Bootup initialization: */
441 extern void __init hrtimers_init(void);
442
443 #if BITS_PER_LONG < 64
444 extern u64 ktime_divns(const ktime_t kt, s64 div);
445 #else /* BITS_PER_LONG < 64 */
446 # define ktime_divns(kt, div)           (u64)((kt).tv64 / (div))
447 #endif
448
449 /* Show pending timers: */
450 extern void sysrq_timer_list_show(void);
451
452 #endif