blob: daf9685b861c05143b17c529b1b72e77aa49c4ee [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TIMER_H
2#define _LINUX_TIMER_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/list.h>
Ingo Molnar82f67cd2007-02-16 01:28:13 -08005#include <linux/ktime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/stddef.h>
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -07007#include <linux/debugobjects.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
Pavel Macheka6fa8e52008-01-30 13:30:00 +01009struct tvec_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11struct timer_list {
12 struct list_head entry;
13 unsigned long expires;
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 void (*function)(unsigned long);
16 unsigned long data;
17
Pavel Macheka6fa8e52008-01-30 13:30:00 +010018 struct tvec_base *base;
Ingo Molnar82f67cd2007-02-16 01:28:13 -080019#ifdef CONFIG_TIMER_STATS
20 void *start_site;
21 char start_comm[16];
22 int start_pid;
23#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070024};
25
Pavel Macheka6fa8e52008-01-30 13:30:00 +010026extern struct tvec_base boot_tvec_bases;
Oleg Nesterov55c888d2005-06-23 00:08:56 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#define TIMER_INITIALIZER(_function, _expires, _data) { \
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -070029 .entry = { .prev = TIMER_ENTRY_STATIC }, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 .function = (_function), \
31 .expires = (_expires), \
32 .data = (_data), \
Oleg Nesterov3691c512006-03-31 02:30:30 -080033 .base = &boot_tvec_bases, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 }
35
Ingo Molnar8d06afa2005-09-09 13:10:40 -070036#define DEFINE_TIMER(_name, _function, _expires, _data) \
37 struct timer_list _name = \
38 TIMER_INITIALIZER(_function, _expires, _data)
39
Harvey Harrisonec701582008-02-08 04:19:55 -080040void init_timer(struct timer_list *timer);
41void init_timer_deferrable(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -070043#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
44extern void init_timer_on_stack(struct timer_list *timer);
45extern void destroy_timer_on_stack(struct timer_list *timer);
46#else
47static inline void destroy_timer_on_stack(struct timer_list *timer) { }
48static inline void init_timer_on_stack(struct timer_list *timer)
49{
50 init_timer(timer);
51}
52#endif
53
Oleg Nesterova8db2db2005-10-30 15:01:38 -080054static inline void setup_timer(struct timer_list * timer,
55 void (*function)(unsigned long),
56 unsigned long data)
57{
58 timer->function = function;
59 timer->data = data;
60 init_timer(timer);
61}
62
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -070063static inline void setup_timer_on_stack(struct timer_list *timer,
64 void (*function)(unsigned long),
65 unsigned long data)
66{
67 timer->function = function;
68 timer->data = data;
69 init_timer_on_stack(timer);
70}
71
Robert P. J. Day45f8bde2007-01-26 00:57:09 -080072/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * timer_pending - is a timer pending?
74 * @timer: the timer in question
75 *
76 * timer_pending will tell whether a given timer is currently pending,
77 * or not. Callers must ensure serialization wrt. other operations done
78 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
79 *
80 * return value: 1 if the timer is pending, 0 if not.
81 */
82static inline int timer_pending(const struct timer_list * timer)
83{
Oleg Nesterov55c888d2005-06-23 00:08:56 -070084 return timer->entry.next != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085}
86
87extern void add_timer_on(struct timer_list *timer, int cpu);
88extern int del_timer(struct timer_list * timer);
89extern int __mod_timer(struct timer_list *timer, unsigned long expires);
90extern int mod_timer(struct timer_list *timer, unsigned long expires);
91
Thomas Gleixnerfd064b92007-02-16 01:27:47 -080092/*
Thomas Gleixnereaad0842007-05-29 23:47:39 +020093 * The jiffies value which is added to now, when there is no timer
94 * in the timer wheel:
95 */
96#define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1)
97
98/*
Thomas Gleixnerfd064b92007-02-16 01:27:47 -080099 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
100 * locks the timer base:
101 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102extern unsigned long next_timer_interrupt(void);
Thomas Gleixnerfd064b92007-02-16 01:27:47 -0800103/*
104 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
105 * locks the timer base and does the comparison against the given
106 * jiffie.
107 */
108extern unsigned long get_next_timer_interrupt(unsigned long now);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800110/*
111 * Timer-statistics info:
112 */
113#ifdef CONFIG_TIMER_STATS
114
Venki Pallipadic5c061b82007-07-15 23:40:30 -0700115#define TIMER_STATS_FLAG_DEFERRABLE 0x1
116
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800117extern void init_timer_stats(void);
118
119extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
Venki Pallipadic5c061b82007-07-15 23:40:30 -0700120 void *timerf, char *comm,
121 unsigned int timer_flag);
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800122
123extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
124 void *addr);
125
126static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
127{
128 __timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
129}
130
131static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
132{
133 timer->start_site = NULL;
134}
135#else
136static inline void init_timer_stats(void)
137{
138}
139
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800140static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
141{
142}
143
144static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
145{
146}
147#endif
148
Robert P. J. Day45f8bde2007-01-26 00:57:09 -0800149/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * add_timer - start a timer
151 * @timer: the timer to be added
152 *
153 * The kernel will do a ->function(->data) callback from the
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100154 * timer interrupt at the ->expires point in the future. The
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 * current time is 'jiffies'.
156 *
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100157 * The timer's ->expires, ->function (and if the handler uses it, ->data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 * fields must be set prior calling this function.
159 *
Andrzej Zaborowski13fce802006-03-24 18:13:37 +0100160 * Timers with an ->expires field in the past will be executed in the next
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 * timer tick.
162 */
Andrew Morton15d2bac2005-10-30 15:02:24 -0800163static inline void add_timer(struct timer_list *timer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164{
Andrew Morton15d2bac2005-10-30 15:02:24 -0800165 BUG_ON(timer_pending(timer));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 __mod_timer(timer, timer->expires);
167}
168
169#ifdef CONFIG_SMP
Oleg Nesterovfd450b72005-06-23 00:08:59 -0700170 extern int try_to_del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 extern int del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172#else
Oleg Nesterovfd450b72005-06-23 00:08:59 -0700173# define try_to_del_timer_sync(t) del_timer(t)
174# define del_timer_sync(t) del_timer(t)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175#endif
176
Oleg Nesterov55c888d2005-06-23 00:08:56 -0700177#define del_singleshot_timer_sync(t) del_timer_sync(t)
178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179extern void init_timers(void);
180extern void run_local_timers(void);
Roman Zippel05cfb612006-03-26 01:38:12 -0800181struct hrtimer;
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800182extern enum hrtimer_restart it_real_fn(struct hrtimer *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Arjan van de Ven4c36a5d2006-12-10 02:21:24 -0800184unsigned long __round_jiffies(unsigned long j, int cpu);
185unsigned long __round_jiffies_relative(unsigned long j, int cpu);
186unsigned long round_jiffies(unsigned long j);
187unsigned long round_jiffies_relative(unsigned long j);
188
Alan Stern9c133c42008-11-06 08:42:48 +0100189unsigned long __round_jiffies_up(unsigned long j, int cpu);
190unsigned long __round_jiffies_up_relative(unsigned long j, int cpu);
191unsigned long round_jiffies_up(unsigned long j);
192unsigned long round_jiffies_up_relative(unsigned long j);
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194#endif