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