timer stats: Optimize by adding quick check to avoid function calls
[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
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  *
58  * Special cases:
59  * 0x03         callback function running and enqueued
60  *              (was requeued on another CPU)
61  * 0x09         timer was migrated on CPU hotunplug
62  * The "callback function running and enqueued" status is only possible on
63  * SMP. It happens for example when a posix timer expired and the callback
64  * queued a signal. Between dropping the lock which protects the posix timer
65  * and reacquiring the base lock of the hrtimer, another CPU can deliver the
66  * signal and rearm the timer. We have to preserve the callback running state,
67  * as otherwise the timer could be removed before the softirq code finishes the
68  * the handling of the timer.
69  *
70  * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state to
71  * preserve the HRTIMER_STATE_CALLBACK bit in the above scenario.
72  *
73  * All state transitions are protected by cpu_base->lock.
74  */
75 #define HRTIMER_STATE_INACTIVE  0x00
76 #define HRTIMER_STATE_ENQUEUED  0x01
77 #define HRTIMER_STATE_CALLBACK  0x02
78 #define HRTIMER_STATE_MIGRATE   0x04
79
80 /**
81  * struct hrtimer - the basic hrtimer structure
82  * @node:       red black tree node for time ordered insertion
83  * @_expires:   the absolute expiry time in the hrtimers internal
84  *              representation. The time is related to the clock on
85  *              which the timer is based. Is setup by adding
86  *              slack to the _softexpires value. For non range timers
87  *              identical to _softexpires.
88  * @_softexpires: the absolute earliest expiry time of the hrtimer.
89  *              The time which was given as expiry time when the timer
90  *              was armed.
91  * @function:   timer expiry callback function
92  * @base:       pointer to the timer base (per cpu and per clock)
93  * @state:      state information (See bit values above)
94  * @cb_entry:   list head to enqueue an expired timer into the callback list
95  * @start_site: timer statistics field to store the site where the timer
96  *              was started
97  * @start_comm: timer statistics field to store the name of the process which
98  *              started the timer
99  * @start_pid: timer statistics field to store the pid of the task which
100  *              started the timer
101  *
102  * The hrtimer structure must be initialized by hrtimer_init()
103  */
104 struct hrtimer {
105         struct rb_node                  node;
106         ktime_t                         _expires;
107         ktime_t                         _softexpires;
108         enum hrtimer_restart            (*function)(struct hrtimer *);
109         struct hrtimer_clock_base       *base;
110         unsigned long                   state;
111         struct list_head                cb_entry;
112 #ifdef CONFIG_TIMER_STATS
113         int                             start_pid;
114         void                            *start_site;
115         char                            start_comm[16];
116 #endif
117 };
118
119 /**
120  * struct hrtimer_sleeper - simple sleeper structure
121  * @timer:      embedded timer structure
122  * @task:       task to wake up
123  *
124  * task is set to NULL, when the timer expires.
125  */
126 struct hrtimer_sleeper {
127         struct hrtimer timer;
128         struct task_struct *task;
129 };
130
131 /**
132  * struct hrtimer_clock_base - the timer base for a specific clock
133  * @cpu_base:           per cpu clock base
134  * @index:              clock type index for per_cpu support when moving a
135  *                      timer to a base on another cpu.
136  * @active:             red black tree root node for the active timers
137  * @first:              pointer to the timer node which expires first
138  * @resolution:         the resolution of the clock, in nanoseconds
139  * @get_time:           function to retrieve the current time of the clock
140  * @softirq_time:       the time when running the hrtimer queue in the softirq
141  * @offset:             offset of this clock to the monotonic base
142  */
143 struct hrtimer_clock_base {
144         struct hrtimer_cpu_base *cpu_base;
145         clockid_t               index;
146         struct rb_root          active;
147         struct rb_node          *first;
148         ktime_t                 resolution;
149         ktime_t                 (*get_time)(void);
150         ktime_t                 softirq_time;
151 #ifdef CONFIG_HIGH_RES_TIMERS
152         ktime_t                 offset;
153 #endif
154 };
155
156 #define HRTIMER_MAX_CLOCK_BASES 2
157
158 /*
159  * struct hrtimer_cpu_base - the per cpu clock bases
160  * @lock:               lock protecting the base and associated clock bases
161  *                      and timers
162  * @clock_base:         array of clock bases for this cpu
163  * @curr_timer:         the timer which is executing a callback right now
164  * @expires_next:       absolute time of the next event which was scheduled
165  *                      via clock_set_next_event()
166  * @hres_active:        State of high resolution mode
167  * @check_clocks:       Indictator, when set evaluate time source and clock
168  *                      event devices whether high resolution mode can be
169  *                      activated.
170  * @nr_events:          Total number of timer interrupt events
171  */
172 struct hrtimer_cpu_base {
173         spinlock_t                      lock;
174         struct hrtimer_clock_base       clock_base[HRTIMER_MAX_CLOCK_BASES];
175 #ifdef CONFIG_HIGH_RES_TIMERS
176         ktime_t                         expires_next;
177         int                             hres_active;
178         unsigned long                   nr_events;
179 #endif
180 };
181
182 static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
183 {
184         timer->_expires = time;
185         timer->_softexpires = time;
186 }
187
188 static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
189 {
190         timer->_softexpires = time;
191         timer->_expires = ktime_add_safe(time, delta);
192 }
193
194 static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
195 {
196         timer->_softexpires = time;
197         timer->_expires = ktime_add_safe(time, ns_to_ktime(delta));
198 }
199
200 static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
201 {
202         timer->_expires.tv64 = tv64;
203         timer->_softexpires.tv64 = tv64;
204 }
205
206 static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
207 {
208         timer->_expires = ktime_add_safe(timer->_expires, time);
209         timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
210 }
211
212 static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
213 {
214         timer->_expires = ktime_add_ns(timer->_expires, ns);
215         timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
216 }
217
218 static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
219 {
220         return timer->_expires;
221 }
222
223 static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
224 {
225         return timer->_softexpires;
226 }
227
228 static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
229 {
230         return timer->_expires.tv64;
231 }
232 static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
233 {
234         return timer->_softexpires.tv64;
235 }
236
237 static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
238 {
239         return ktime_to_ns(timer->_expires);
240 }
241
242 static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
243 {
244     return ktime_sub(timer->_expires, timer->base->get_time());
245 }
246
247 #ifdef CONFIG_HIGH_RES_TIMERS
248 struct clock_event_device;
249
250 extern void clock_was_set(void);
251 extern void hres_timers_resume(void);
252 extern void hrtimer_interrupt(struct clock_event_device *dev);
253
254 /*
255  * In high resolution mode the time reference must be read accurate
256  */
257 static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
258 {
259         return timer->base->get_time();
260 }
261
262 static inline int hrtimer_is_hres_active(struct hrtimer *timer)
263 {
264         return timer->base->cpu_base->hres_active;
265 }
266
267 extern void hrtimer_peek_ahead_timers(void);
268
269 /*
270  * The resolution of the clocks. The resolution value is returned in
271  * the clock_getres() system call to give application programmers an
272  * idea of the (in)accuracy of timers. Timer values are rounded up to
273  * this resolution values.
274  */
275 # define HIGH_RES_NSEC          1
276 # define KTIME_HIGH_RES         (ktime_t) { .tv64 = HIGH_RES_NSEC }
277 # define MONOTONIC_RES_NSEC     HIGH_RES_NSEC
278 # define KTIME_MONOTONIC_RES    KTIME_HIGH_RES
279
280 #else
281
282 # define MONOTONIC_RES_NSEC     LOW_RES_NSEC
283 # define KTIME_MONOTONIC_RES    KTIME_LOW_RES
284
285 /*
286  * clock_was_set() is a NOP for non- high-resolution systems. The
287  * time-sorted order guarantees that a timer does not expire early and
288  * is expired in the next softirq when the clock was advanced.
289  */
290 static inline void clock_was_set(void) { }
291 static inline void hrtimer_peek_ahead_timers(void) { }
292
293 static inline void hres_timers_resume(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 ktime_t ktime_get(void);
311 extern ktime_t ktime_get_real(void);
312
313
314 DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
315
316
317 /* Exported timer functions: */
318
319 /* Initialize timers: */
320 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
321                          enum hrtimer_mode mode);
322
323 #ifdef CONFIG_DEBUG_OBJECTS_TIMERS
324 extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
325                                   enum hrtimer_mode mode);
326
327 extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
328 #else
329 static inline void hrtimer_init_on_stack(struct hrtimer *timer,
330                                          clockid_t which_clock,
331                                          enum hrtimer_mode mode)
332 {
333         hrtimer_init(timer, which_clock, mode);
334 }
335 static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
336 #endif
337
338 /* Basic timer operations: */
339 extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
340                          const enum hrtimer_mode mode);
341 extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
342                         unsigned long range_ns, const enum hrtimer_mode mode);
343 extern int
344 __hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
345                          unsigned long delta_ns,
346                          const enum hrtimer_mode mode, int wakeup);
347
348 extern int hrtimer_cancel(struct hrtimer *timer);
349 extern int hrtimer_try_to_cancel(struct hrtimer *timer);
350
351 static inline int hrtimer_start_expires(struct hrtimer *timer,
352                                                 enum hrtimer_mode mode)
353 {
354         unsigned long delta;
355         ktime_t soft, hard;
356         soft = hrtimer_get_softexpires(timer);
357         hard = hrtimer_get_expires(timer);
358         delta = ktime_to_ns(ktime_sub(hard, soft));
359         return hrtimer_start_range_ns(timer, soft, delta, mode);
360 }
361
362 static inline int hrtimer_restart(struct hrtimer *timer)
363 {
364         return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
365 }
366
367 /* Query timers: */
368 extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
369 extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
370
371 extern ktime_t hrtimer_get_next_event(void);
372
373 /*
374  * A timer is active, when it is enqueued into the rbtree or the callback
375  * function is running.
376  */
377 static inline int hrtimer_active(const struct hrtimer *timer)
378 {
379         return timer->state != HRTIMER_STATE_INACTIVE;
380 }
381
382 /*
383  * Helper function to check, whether the timer is on one of the queues
384  */
385 static inline int hrtimer_is_queued(struct hrtimer *timer)
386 {
387         return timer->state & HRTIMER_STATE_ENQUEUED;
388 }
389
390 /*
391  * Helper function to check, whether the timer is running the callback
392  * function
393  */
394 static inline int hrtimer_callback_running(struct hrtimer *timer)
395 {
396         return timer->state & HRTIMER_STATE_CALLBACK;
397 }
398
399 /* Forward a hrtimer so it expires after now: */
400 extern u64
401 hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
402
403 /* Forward a hrtimer so it expires after the hrtimer's current now */
404 static inline u64 hrtimer_forward_now(struct hrtimer *timer,
405                                       ktime_t interval)
406 {
407         return hrtimer_forward(timer, timer->base->get_time(), interval);
408 }
409
410 /* Precise sleep: */
411 extern long hrtimer_nanosleep(struct timespec *rqtp,
412                               struct timespec __user *rmtp,
413                               const enum hrtimer_mode mode,
414                               const clockid_t clockid);
415 extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
416
417 extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
418                                  struct task_struct *tsk);
419
420 extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
421                                                 const enum hrtimer_mode mode);
422 extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
423
424 /* Soft interrupt function to run the hrtimer queues: */
425 extern void hrtimer_run_queues(void);
426 extern void hrtimer_run_pending(void);
427
428 /* Bootup initialization: */
429 extern void __init hrtimers_init(void);
430
431 #if BITS_PER_LONG < 64
432 extern u64 ktime_divns(const ktime_t kt, s64 div);
433 #else /* BITS_PER_LONG < 64 */
434 # define ktime_divns(kt, div)           (u64)((kt).tv64 / (div))
435 #endif
436
437 /* Show pending timers: */
438 extern void sysrq_timer_list_show(void);
439
440 /*
441  * Timer-statistics info:
442  */
443 #ifdef CONFIG_TIMER_STATS
444
445 extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
446                                      void *timerf, char *comm,
447                                      unsigned int timer_flag);
448
449 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
450 {
451         if (likely(!timer->start_pid))
452                 return;
453         timer_stats_update_stats(timer, timer->start_pid, timer->start_site,
454                                  timer->function, timer->start_comm, 0);
455 }
456
457 extern void __timer_stats_hrtimer_set_start_info(struct hrtimer *timer,
458                                                  void *addr);
459
460 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
461 {
462         if (likely(!timer_stats_active))
463                 return;
464         __timer_stats_hrtimer_set_start_info(timer, __builtin_return_address(0));
465 }
466
467 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
468 {
469         timer->start_site = NULL;
470 }
471 #else
472 static inline void timer_stats_account_hrtimer(struct hrtimer *timer)
473 {
474 }
475
476 static inline void timer_stats_hrtimer_set_start_info(struct hrtimer *timer)
477 {
478 }
479
480 static inline void timer_stats_hrtimer_clear_start_info(struct hrtimer *timer)
481 {
482 }
483 #endif
484
485 #endif