]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef _LINUX_TIMER_H |
2 | #define _LINUX_TIMER_H | |
3 | ||
1da177e4 | 4 | #include <linux/list.h> |
82f67cd9 | 5 | #include <linux/ktime.h> |
1da177e4 | 6 | #include <linux/stddef.h> |
c6f3a97f | 7 | #include <linux/debugobjects.h> |
6f2b9b9a | 8 | #include <linux/stringify.h> |
1da177e4 | 9 | |
a6fa8e5a | 10 | struct tvec_base; |
1da177e4 LT |
11 | |
12 | struct timer_list { | |
3bbb9ec9 AV |
13 | /* |
14 | * All fields that change during normal runtime grouped to the | |
15 | * same cacheline | |
16 | */ | |
1da177e4 LT |
17 | struct list_head entry; |
18 | unsigned long expires; | |
3bbb9ec9 | 19 | struct tvec_base *base; |
1da177e4 | 20 | |
1da177e4 LT |
21 | void (*function)(unsigned long); |
22 | unsigned long data; | |
23 | ||
3bbb9ec9 AV |
24 | int slack; |
25 | ||
82f67cd9 | 26 | #ifdef CONFIG_TIMER_STATS |
d0959024 | 27 | int start_pid; |
82f67cd9 IM |
28 | void *start_site; |
29 | char start_comm[16]; | |
82f67cd9 | 30 | #endif |
6f2b9b9a JB |
31 | #ifdef CONFIG_LOCKDEP |
32 | struct lockdep_map lockdep_map; | |
33 | #endif | |
1da177e4 LT |
34 | }; |
35 | ||
a6fa8e5a | 36 | extern struct tvec_base boot_tvec_bases; |
55c888d6 | 37 | |
6f2b9b9a JB |
38 | #ifdef CONFIG_LOCKDEP |
39 | /* | |
40 | * NB: because we have to copy the lockdep_map, setting the lockdep_map key | |
41 | * (second argument) here is required, otherwise it could be initialised to | |
42 | * the copy of the lockdep_map later! We use the pointer to and the string | |
43 | * "<file>:<line>" as the key resp. the name of the lockdep_map. | |
44 | */ | |
45 | #define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) \ | |
46 | .lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn), | |
47 | #else | |
48 | #define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) | |
49 | #endif | |
50 | ||
dd6414b5 PC |
51 | /* |
52 | * Note that all tvec_bases are 2 byte aligned and lower bit of | |
53 | * base in timer_list is guaranteed to be zero. Use the LSB to | |
54 | * indicate whether the timer is deferrable. | |
55 | * | |
56 | * A deferrable timer will work normally when the system is busy, but | |
57 | * will not cause a CPU to come out of idle just to service it; instead, | |
58 | * the timer will be serviced when the CPU eventually wakes up with a | |
59 | * subsequent non-deferrable timer. | |
60 | */ | |
e52b1db3 TH |
61 | #define TIMER_DEFERRABLE 0x1LU |
62 | ||
63 | #define TIMER_FLAG_MASK 0x1LU | |
dd6414b5 | 64 | |
fc683995 | 65 | #define __TIMER_INITIALIZER(_function, _expires, _data, _flags) { \ |
c6f3a97f | 66 | .entry = { .prev = TIMER_ENTRY_STATIC }, \ |
1da177e4 LT |
67 | .function = (_function), \ |
68 | .expires = (_expires), \ | |
69 | .data = (_data), \ | |
fc683995 | 70 | .base = (void *)((unsigned long)&boot_tvec_bases + (_flags)), \ |
aaabe31c | 71 | .slack = -1, \ |
6f2b9b9a JB |
72 | __TIMER_LOCKDEP_MAP_INITIALIZER( \ |
73 | __FILE__ ":" __stringify(__LINE__)) \ | |
1da177e4 LT |
74 | } |
75 | ||
fc683995 TH |
76 | #define TIMER_INITIALIZER(_function, _expires, _data) \ |
77 | __TIMER_INITIALIZER((_function), (_expires), (_data), 0) | |
dd6414b5 | 78 | |
fc683995 TH |
79 | #define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data) \ |
80 | __TIMER_INITIALIZER((_function), (_expires), (_data), TIMER_DEFERRABLE) | |
dd6414b5 | 81 | |
8d06afab IM |
82 | #define DEFINE_TIMER(_name, _function, _expires, _data) \ |
83 | struct timer_list _name = \ | |
84 | TIMER_INITIALIZER(_function, _expires, _data) | |
85 | ||
fc683995 TH |
86 | void init_timer_key(struct timer_list *timer, unsigned int flags, |
87 | const char *name, struct lock_class_key *key); | |
6f2b9b9a | 88 | |
5a9af38d TH |
89 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
90 | extern void init_timer_on_stack_key(struct timer_list *timer, | |
fc683995 | 91 | unsigned int flags, const char *name, |
5a9af38d TH |
92 | struct lock_class_key *key); |
93 | extern void destroy_timer_on_stack(struct timer_list *timer); | |
94 | #else | |
95 | static inline void destroy_timer_on_stack(struct timer_list *timer) { } | |
96 | static inline void init_timer_on_stack_key(struct timer_list *timer, | |
fc683995 | 97 | unsigned int flags, const char *name, |
5a9af38d TH |
98 | struct lock_class_key *key) |
99 | { | |
fc683995 | 100 | init_timer_key(timer, flags, name, key); |
5a9af38d TH |
101 | } |
102 | #endif | |
103 | ||
6f2b9b9a | 104 | #ifdef CONFIG_LOCKDEP |
fc683995 | 105 | #define __init_timer(_timer, _flags) \ |
6f2b9b9a JB |
106 | do { \ |
107 | static struct lock_class_key __key; \ | |
fc683995 | 108 | init_timer_key((_timer), (_flags), #_timer, &__key); \ |
6f2b9b9a JB |
109 | } while (0) |
110 | ||
fc683995 | 111 | #define __init_timer_on_stack(_timer, _flags) \ |
6f2b9b9a JB |
112 | do { \ |
113 | static struct lock_class_key __key; \ | |
fc683995 | 114 | init_timer_on_stack_key((_timer), (_flags), #_timer, &__key); \ |
6f2b9b9a | 115 | } while (0) |
fc683995 TH |
116 | #else |
117 | #define __init_timer(_timer, _flags) \ | |
118 | init_timer_key((_timer), (_flags), NULL, NULL) | |
119 | #define __init_timer_on_stack(_timer, _flags) \ | |
120 | init_timer_on_stack_key((_timer), (_flags), NULL, NULL) | |
121 | #endif | |
6f2b9b9a | 122 | |
fc683995 TH |
123 | #define init_timer(timer) \ |
124 | __init_timer((timer), 0) | |
125 | #define init_timer_deferrable(timer) \ | |
126 | __init_timer((timer), TIMER_DEFERRABLE) | |
6f2b9b9a | 127 | #define init_timer_on_stack(timer) \ |
fc683995 TH |
128 | __init_timer_on_stack((timer), 0) |
129 | ||
130 | #define __setup_timer(_timer, _fn, _data, _flags) \ | |
6f2b9b9a | 131 | do { \ |
fc683995 TH |
132 | __init_timer((_timer), (_flags)); \ |
133 | (_timer)->function = (_fn); \ | |
134 | (_timer)->data = (_data); \ | |
6f2b9b9a JB |
135 | } while (0) |
136 | ||
fc683995 | 137 | #define __setup_timer_on_stack(_timer, _fn, _data, _flags) \ |
6f2b9b9a | 138 | do { \ |
fc683995 TH |
139 | __init_timer_on_stack((_timer), (_flags)); \ |
140 | (_timer)->function = (_fn); \ | |
141 | (_timer)->data = (_data); \ | |
6f2b9b9a JB |
142 | } while (0) |
143 | ||
fc683995 TH |
144 | #define setup_timer(timer, fn, data) \ |
145 | __setup_timer((timer), (fn), (data), 0) | |
6f2b9b9a | 146 | #define setup_timer_on_stack(timer, fn, data) \ |
fc683995 | 147 | __setup_timer_on_stack((timer), (fn), (data), 0) |
8cadd283 | 148 | #define setup_deferrable_timer_on_stack(timer, fn, data) \ |
fc683995 | 149 | __setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE) |
8cadd283 | 150 | |
45f8bde0 | 151 | /** |
1da177e4 LT |
152 | * timer_pending - is a timer pending? |
153 | * @timer: the timer in question | |
154 | * | |
155 | * timer_pending will tell whether a given timer is currently pending, | |
156 | * or not. Callers must ensure serialization wrt. other operations done | |
157 | * to this timer, eg. interrupt contexts, or other CPUs on SMP. | |
158 | * | |
159 | * return value: 1 if the timer is pending, 0 if not. | |
160 | */ | |
161 | static inline int timer_pending(const struct timer_list * timer) | |
162 | { | |
55c888d6 | 163 | return timer->entry.next != NULL; |
1da177e4 LT |
164 | } |
165 | ||
166 | extern void add_timer_on(struct timer_list *timer, int cpu); | |
167 | extern int del_timer(struct timer_list * timer); | |
1da177e4 | 168 | extern int mod_timer(struct timer_list *timer, unsigned long expires); |
74019224 | 169 | extern int mod_timer_pending(struct timer_list *timer, unsigned long expires); |
597d0275 | 170 | extern int mod_timer_pinned(struct timer_list *timer, unsigned long expires); |
1da177e4 | 171 | |
3bbb9ec9 AV |
172 | extern void set_timer_slack(struct timer_list *time, int slack_hz); |
173 | ||
597d0275 AB |
174 | #define TIMER_NOT_PINNED 0 |
175 | #define TIMER_PINNED 1 | |
eaad084b TG |
176 | /* |
177 | * The jiffies value which is added to now, when there is no timer | |
178 | * in the timer wheel: | |
179 | */ | |
180 | #define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1) | |
181 | ||
fd064b9b TG |
182 | /* |
183 | * Return when the next timer-wheel timeout occurs (in absolute jiffies), | |
184 | * locks the timer base and does the comparison against the given | |
185 | * jiffie. | |
186 | */ | |
187 | extern unsigned long get_next_timer_interrupt(unsigned long now); | |
1da177e4 | 188 | |
82f67cd9 IM |
189 | /* |
190 | * Timer-statistics info: | |
191 | */ | |
192 | #ifdef CONFIG_TIMER_STATS | |
193 | ||
507e1231 HC |
194 | extern int timer_stats_active; |
195 | ||
c5c061b8 VP |
196 | #define TIMER_STATS_FLAG_DEFERRABLE 0x1 |
197 | ||
82f67cd9 IM |
198 | extern void init_timer_stats(void); |
199 | ||
200 | extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf, | |
c5c061b8 VP |
201 | void *timerf, char *comm, |
202 | unsigned int timer_flag); | |
82f67cd9 IM |
203 | |
204 | extern void __timer_stats_timer_set_start_info(struct timer_list *timer, | |
205 | void *addr); | |
206 | ||
207 | static inline void timer_stats_timer_set_start_info(struct timer_list *timer) | |
208 | { | |
507e1231 HC |
209 | if (likely(!timer_stats_active)) |
210 | return; | |
82f67cd9 IM |
211 | __timer_stats_timer_set_start_info(timer, __builtin_return_address(0)); |
212 | } | |
213 | ||
214 | static inline void timer_stats_timer_clear_start_info(struct timer_list *timer) | |
215 | { | |
216 | timer->start_site = NULL; | |
217 | } | |
218 | #else | |
219 | static inline void init_timer_stats(void) | |
220 | { | |
221 | } | |
222 | ||
82f67cd9 IM |
223 | static inline void timer_stats_timer_set_start_info(struct timer_list *timer) |
224 | { | |
225 | } | |
226 | ||
227 | static inline void timer_stats_timer_clear_start_info(struct timer_list *timer) | |
228 | { | |
229 | } | |
230 | #endif | |
231 | ||
74019224 | 232 | extern void add_timer(struct timer_list *timer); |
1da177e4 | 233 | |
6f1bc451 YZ |
234 | extern int try_to_del_timer_sync(struct timer_list *timer); |
235 | ||
1da177e4 LT |
236 | #ifdef CONFIG_SMP |
237 | extern int del_timer_sync(struct timer_list *timer); | |
1da177e4 | 238 | #else |
fd450b73 | 239 | # define del_timer_sync(t) del_timer(t) |
1da177e4 LT |
240 | #endif |
241 | ||
55c888d6 ON |
242 | #define del_singleshot_timer_sync(t) del_timer_sync(t) |
243 | ||
1da177e4 LT |
244 | extern void init_timers(void); |
245 | extern void run_local_timers(void); | |
05cfb614 | 246 | struct hrtimer; |
c9cb2e3d | 247 | extern enum hrtimer_restart it_real_fn(struct hrtimer *); |
1da177e4 | 248 | |
4c36a5de AV |
249 | unsigned long __round_jiffies(unsigned long j, int cpu); |
250 | unsigned long __round_jiffies_relative(unsigned long j, int cpu); | |
251 | unsigned long round_jiffies(unsigned long j); | |
252 | unsigned long round_jiffies_relative(unsigned long j); | |
253 | ||
9c133c46 AS |
254 | unsigned long __round_jiffies_up(unsigned long j, int cpu); |
255 | unsigned long __round_jiffies_up_relative(unsigned long j, int cpu); | |
256 | unsigned long round_jiffies_up(unsigned long j); | |
257 | unsigned long round_jiffies_up_relative(unsigned long j); | |
258 | ||
1da177e4 | 259 | #endif |