]>
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 | */ | |
0eeda71b TG |
17 | struct hlist_node entry; |
18 | unsigned long expires; | |
19 | void (*function)(unsigned long); | |
20 | unsigned long data; | |
21 | u32 flags; | |
3bbb9ec9 | 22 | |
6f2b9b9a | 23 | #ifdef CONFIG_LOCKDEP |
0eeda71b | 24 | struct lockdep_map lockdep_map; |
6f2b9b9a | 25 | #endif |
1da177e4 LT |
26 | }; |
27 | ||
6f2b9b9a JB |
28 | #ifdef CONFIG_LOCKDEP |
29 | /* | |
30 | * NB: because we have to copy the lockdep_map, setting the lockdep_map key | |
31 | * (second argument) here is required, otherwise it could be initialised to | |
32 | * the copy of the lockdep_map later! We use the pointer to and the string | |
33 | * "<file>:<line>" as the key resp. the name of the lockdep_map. | |
34 | */ | |
35 | #define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) \ | |
36 | .lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn), | |
37 | #else | |
38 | #define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) | |
39 | #endif | |
40 | ||
dd6414b5 | 41 | /* |
dd6414b5 PC |
42 | * A deferrable timer will work normally when the system is busy, but |
43 | * will not cause a CPU to come out of idle just to service it; instead, | |
44 | * the timer will be serviced when the CPU eventually wakes up with a | |
45 | * subsequent non-deferrable timer. | |
c5f66e99 TH |
46 | * |
47 | * An irqsafe timer is executed with IRQ disabled and it's safe to wait for | |
48 | * the completion of the running instance from IRQ handlers, for example, | |
49 | * by calling del_timer_sync(). | |
50 | * | |
51 | * Note: The irq disabled callback execution is a special case for | |
52 | * workqueue locking issues. It's not meant for executing random crap | |
53 | * with interrupts disabled. Abuse is monitored! | |
dd6414b5 | 54 | */ |
b0d6e2dc TG |
55 | #define TIMER_CPUMASK 0x0003FFFF |
56 | #define TIMER_MIGRATING 0x00040000 | |
0eeda71b | 57 | #define TIMER_BASEMASK (TIMER_CPUMASK | TIMER_MIGRATING) |
b0d6e2dc TG |
58 | #define TIMER_DEFERRABLE 0x00080000 |
59 | #define TIMER_PINNED 0x00100000 | |
60 | #define TIMER_IRQSAFE 0x00200000 | |
500462a9 TG |
61 | #define TIMER_ARRAYSHIFT 22 |
62 | #define TIMER_ARRAYMASK 0xFFC00000 | |
dd6414b5 | 63 | |
8a58a34b TG |
64 | #define TIMER_TRACE_FLAGMASK (TIMER_MIGRATING | TIMER_DEFERRABLE | TIMER_PINNED | TIMER_IRQSAFE) |
65 | ||
8ede369b | 66 | #define __TIMER_INITIALIZER(_function, _data, _flags) { \ |
1dabbcec | 67 | .entry = { .next = TIMER_ENTRY_STATIC }, \ |
1da177e4 | 68 | .function = (_function), \ |
1da177e4 | 69 | .data = (_data), \ |
0eeda71b | 70 | .flags = (_flags), \ |
6f2b9b9a JB |
71 | __TIMER_LOCKDEP_MAP_INITIALIZER( \ |
72 | __FILE__ ":" __stringify(__LINE__)) \ | |
1da177e4 LT |
73 | } |
74 | ||
1d27e3e2 | 75 | #define DEFINE_TIMER(_name, _function) \ |
8d06afab | 76 | struct timer_list _name = \ |
8ede369b | 77 | __TIMER_INITIALIZER(_function, 0, 0) |
8d06afab | 78 | |
fc683995 TH |
79 | void init_timer_key(struct timer_list *timer, unsigned int flags, |
80 | const char *name, struct lock_class_key *key); | |
6f2b9b9a | 81 | |
5a9af38d TH |
82 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
83 | extern void init_timer_on_stack_key(struct timer_list *timer, | |
fc683995 | 84 | unsigned int flags, const char *name, |
5a9af38d TH |
85 | struct lock_class_key *key); |
86 | extern void destroy_timer_on_stack(struct timer_list *timer); | |
87 | #else | |
88 | static inline void destroy_timer_on_stack(struct timer_list *timer) { } | |
89 | static inline void init_timer_on_stack_key(struct timer_list *timer, | |
fc683995 | 90 | unsigned int flags, const char *name, |
5a9af38d TH |
91 | struct lock_class_key *key) |
92 | { | |
fc683995 | 93 | init_timer_key(timer, flags, name, key); |
5a9af38d TH |
94 | } |
95 | #endif | |
96 | ||
6f2b9b9a | 97 | #ifdef CONFIG_LOCKDEP |
fc683995 | 98 | #define __init_timer(_timer, _flags) \ |
6f2b9b9a JB |
99 | do { \ |
100 | static struct lock_class_key __key; \ | |
fc683995 | 101 | init_timer_key((_timer), (_flags), #_timer, &__key); \ |
6f2b9b9a JB |
102 | } while (0) |
103 | ||
fc683995 | 104 | #define __init_timer_on_stack(_timer, _flags) \ |
6f2b9b9a JB |
105 | do { \ |
106 | static struct lock_class_key __key; \ | |
fc683995 | 107 | init_timer_on_stack_key((_timer), (_flags), #_timer, &__key); \ |
6f2b9b9a | 108 | } while (0) |
fc683995 TH |
109 | #else |
110 | #define __init_timer(_timer, _flags) \ | |
111 | init_timer_key((_timer), (_flags), NULL, NULL) | |
112 | #define __init_timer_on_stack(_timer, _flags) \ | |
113 | init_timer_on_stack_key((_timer), (_flags), NULL, NULL) | |
114 | #endif | |
6f2b9b9a | 115 | |
fc683995 TH |
116 | #define init_timer(timer) \ |
117 | __init_timer((timer), 0) | |
fc683995 TH |
118 | |
119 | #define __setup_timer(_timer, _fn, _data, _flags) \ | |
6f2b9b9a | 120 | do { \ |
fc683995 TH |
121 | __init_timer((_timer), (_flags)); \ |
122 | (_timer)->function = (_fn); \ | |
123 | (_timer)->data = (_data); \ | |
6f2b9b9a JB |
124 | } while (0) |
125 | ||
fc683995 | 126 | #define __setup_timer_on_stack(_timer, _fn, _data, _flags) \ |
6f2b9b9a | 127 | do { \ |
fc683995 TH |
128 | __init_timer_on_stack((_timer), (_flags)); \ |
129 | (_timer)->function = (_fn); \ | |
130 | (_timer)->data = (_data); \ | |
6f2b9b9a JB |
131 | } while (0) |
132 | ||
fc683995 TH |
133 | #define setup_timer(timer, fn, data) \ |
134 | __setup_timer((timer), (fn), (data), 0) | |
e675447b TG |
135 | #define setup_pinned_timer(timer, fn, data) \ |
136 | __setup_timer((timer), (fn), (data), TIMER_PINNED) | |
6f3ffc19 LS |
137 | #define setup_deferrable_timer(timer, fn, data) \ |
138 | __setup_timer((timer), (fn), (data), TIMER_DEFERRABLE) | |
e675447b TG |
139 | #define setup_pinned_deferrable_timer(timer, fn, data) \ |
140 | __setup_timer((timer), (fn), (data), TIMER_DEFERRABLE | TIMER_PINNED) | |
6f2b9b9a | 141 | #define setup_timer_on_stack(timer, fn, data) \ |
fc683995 | 142 | __setup_timer_on_stack((timer), (fn), (data), 0) |
e675447b TG |
143 | #define setup_pinned_timer_on_stack(timer, fn, data) \ |
144 | __setup_timer_on_stack((timer), (fn), (data), TIMER_PINNED) | |
8cadd283 | 145 | #define setup_deferrable_timer_on_stack(timer, fn, data) \ |
fc683995 | 146 | __setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE) |
e675447b TG |
147 | #define setup_pinned_deferrable_timer_on_stack(timer, fn, data) \ |
148 | __setup_timer_on_stack((timer), (fn), (data), TIMER_DEFERRABLE | TIMER_PINNED) | |
8cadd283 | 149 | |
686fef92 KC |
150 | #define TIMER_DATA_TYPE unsigned long |
151 | #define TIMER_FUNC_TYPE void (*)(TIMER_DATA_TYPE) | |
152 | ||
153 | static inline void timer_setup(struct timer_list *timer, | |
154 | void (*callback)(struct timer_list *), | |
155 | unsigned int flags) | |
156 | { | |
157 | __setup_timer(timer, (TIMER_FUNC_TYPE)callback, | |
158 | (TIMER_DATA_TYPE)timer, flags); | |
159 | } | |
160 | ||
58e1177b KC |
161 | static inline void timer_setup_on_stack(struct timer_list *timer, |
162 | void (*callback)(struct timer_list *), | |
163 | unsigned int flags) | |
164 | { | |
165 | __setup_timer_on_stack(timer, (TIMER_FUNC_TYPE)callback, | |
166 | (TIMER_DATA_TYPE)timer, flags); | |
167 | } | |
168 | ||
686fef92 KC |
169 | #define from_timer(var, callback_timer, timer_fieldname) \ |
170 | container_of(callback_timer, typeof(*var), timer_fieldname) | |
171 | ||
45f8bde0 | 172 | /** |
1da177e4 LT |
173 | * timer_pending - is a timer pending? |
174 | * @timer: the timer in question | |
175 | * | |
176 | * timer_pending will tell whether a given timer is currently pending, | |
177 | * or not. Callers must ensure serialization wrt. other operations done | |
178 | * to this timer, eg. interrupt contexts, or other CPUs on SMP. | |
179 | * | |
180 | * return value: 1 if the timer is pending, 0 if not. | |
181 | */ | |
182 | static inline int timer_pending(const struct timer_list * timer) | |
183 | { | |
1dabbcec | 184 | return timer->entry.pprev != NULL; |
1da177e4 LT |
185 | } |
186 | ||
187 | extern void add_timer_on(struct timer_list *timer, int cpu); | |
188 | extern int del_timer(struct timer_list * timer); | |
1da177e4 | 189 | extern int mod_timer(struct timer_list *timer, unsigned long expires); |
74019224 | 190 | extern int mod_timer_pending(struct timer_list *timer, unsigned long expires); |
1da177e4 | 191 | |
eaad084b TG |
192 | /* |
193 | * The jiffies value which is added to now, when there is no timer | |
194 | * in the timer wheel: | |
195 | */ | |
196 | #define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1) | |
197 | ||
74019224 | 198 | extern void add_timer(struct timer_list *timer); |
1da177e4 | 199 | |
6f1bc451 YZ |
200 | extern int try_to_del_timer_sync(struct timer_list *timer); |
201 | ||
1da177e4 LT |
202 | #ifdef CONFIG_SMP |
203 | extern int del_timer_sync(struct timer_list *timer); | |
1da177e4 | 204 | #else |
fd450b73 | 205 | # define del_timer_sync(t) del_timer(t) |
1da177e4 LT |
206 | #endif |
207 | ||
55c888d6 ON |
208 | #define del_singleshot_timer_sync(t) del_timer_sync(t) |
209 | ||
1da177e4 LT |
210 | extern void init_timers(void); |
211 | extern void run_local_timers(void); | |
05cfb614 | 212 | struct hrtimer; |
c9cb2e3d | 213 | extern enum hrtimer_restart it_real_fn(struct hrtimer *); |
1da177e4 | 214 | |
bc7a34b8 | 215 | #if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON) |
b2d5bfea | 216 | struct ctl_table; |
bc7a34b8 TG |
217 | |
218 | extern unsigned int sysctl_timer_migration; | |
219 | int timer_migration_handler(struct ctl_table *table, int write, | |
220 | void __user *buffer, size_t *lenp, | |
221 | loff_t *ppos); | |
222 | #endif | |
223 | ||
4c36a5de AV |
224 | unsigned long __round_jiffies(unsigned long j, int cpu); |
225 | unsigned long __round_jiffies_relative(unsigned long j, int cpu); | |
226 | unsigned long round_jiffies(unsigned long j); | |
227 | unsigned long round_jiffies_relative(unsigned long j); | |
228 | ||
9c133c46 AS |
229 | unsigned long __round_jiffies_up(unsigned long j, int cpu); |
230 | unsigned long __round_jiffies_up_relative(unsigned long j, int cpu); | |
231 | unsigned long round_jiffies_up(unsigned long j); | |
232 | unsigned long round_jiffies_up_relative(unsigned long j); | |
233 | ||
24f73b99 RC |
234 | #ifdef CONFIG_HOTPLUG_CPU |
235 | int timers_dead_cpu(unsigned int cpu); | |
236 | #else | |
237 | #define timers_dead_cpu NULL | |
238 | #endif | |
239 | ||
1da177e4 | 240 | #endif |