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 | |
1da177e4 | 11 | struct timer_list { |
3bbb9ec9 AV |
12 | /* |
13 | * All fields that change during normal runtime grouped to the | |
14 | * same cacheline | |
15 | */ | |
0eeda71b TG |
16 | struct hlist_node entry; |
17 | unsigned long expires; | |
354b46b1 | 18 | void (*function)(struct timer_list *); |
0eeda71b | 19 | u32 flags; |
3bbb9ec9 | 20 | |
6f2b9b9a | 21 | #ifdef CONFIG_LOCKDEP |
0eeda71b | 22 | struct lockdep_map lockdep_map; |
6f2b9b9a | 23 | #endif |
1da177e4 LT |
24 | }; |
25 | ||
6f2b9b9a JB |
26 | #ifdef CONFIG_LOCKDEP |
27 | /* | |
28 | * NB: because we have to copy the lockdep_map, setting the lockdep_map key | |
29 | * (second argument) here is required, otherwise it could be initialised to | |
30 | * the copy of the lockdep_map later! We use the pointer to and the string | |
31 | * "<file>:<line>" as the key resp. the name of the lockdep_map. | |
32 | */ | |
33 | #define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) \ | |
34 | .lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn), | |
35 | #else | |
36 | #define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) | |
37 | #endif | |
38 | ||
28ef2db8 PX |
39 | /** |
40 | * @TIMER_DEFERRABLE: A deferrable timer will work normally when the | |
41 | * system is busy, but will not cause a CPU to come out of idle just | |
42 | * to service it; instead, the timer will be serviced when the CPU | |
43 | * eventually wakes up with a subsequent non-deferrable timer. | |
c5f66e99 | 44 | * |
28ef2db8 PX |
45 | * @TIMER_IRQSAFE: An irqsafe timer is executed with IRQ disabled and |
46 | * it's safe to wait for the completion of the running instance from | |
47 | * IRQ handlers, for example, by calling del_timer_sync(). | |
c5f66e99 TH |
48 | * |
49 | * Note: The irq disabled callback execution is a special case for | |
50 | * workqueue locking issues. It's not meant for executing random crap | |
51 | * with interrupts disabled. Abuse is monitored! | |
28ef2db8 PX |
52 | * |
53 | * @TIMER_PINNED: A pinned timer will not be affected by any timer | |
54 | * placement heuristics (like, NOHZ) and will always expire on the CPU | |
55 | * on which the timer was enqueued. | |
56 | * | |
57 | * Note: Because enqueuing of timers can migrate the timer from one | |
58 | * CPU to another, pinned timers are not guaranteed to stay on the | |
59 | * initialy selected CPU. They move to the CPU on which the enqueue | |
60 | * function is invoked via mod_timer() or add_timer(). If the timer | |
61 | * should be placed on a particular CPU, then add_timer_on() has to be | |
62 | * used. | |
dd6414b5 | 63 | */ |
b0d6e2dc TG |
64 | #define TIMER_CPUMASK 0x0003FFFF |
65 | #define TIMER_MIGRATING 0x00040000 | |
0eeda71b | 66 | #define TIMER_BASEMASK (TIMER_CPUMASK | TIMER_MIGRATING) |
b0d6e2dc TG |
67 | #define TIMER_DEFERRABLE 0x00080000 |
68 | #define TIMER_PINNED 0x00100000 | |
69 | #define TIMER_IRQSAFE 0x00200000 | |
b952caf2 | 70 | #define TIMER_INIT_FLAGS (TIMER_DEFERRABLE | TIMER_PINNED | TIMER_IRQSAFE) |
500462a9 TG |
71 | #define TIMER_ARRAYSHIFT 22 |
72 | #define TIMER_ARRAYMASK 0xFFC00000 | |
dd6414b5 | 73 | |
8a58a34b TG |
74 | #define TIMER_TRACE_FLAGMASK (TIMER_MIGRATING | TIMER_DEFERRABLE | TIMER_PINNED | TIMER_IRQSAFE) |
75 | ||
1fe66ba5 | 76 | #define __TIMER_INITIALIZER(_function, _flags) { \ |
1dabbcec | 77 | .entry = { .next = TIMER_ENTRY_STATIC }, \ |
1da177e4 | 78 | .function = (_function), \ |
0eeda71b | 79 | .flags = (_flags), \ |
6f2b9b9a JB |
80 | __TIMER_LOCKDEP_MAP_INITIALIZER( \ |
81 | __FILE__ ":" __stringify(__LINE__)) \ | |
1da177e4 LT |
82 | } |
83 | ||
1d27e3e2 | 84 | #define DEFINE_TIMER(_name, _function) \ |
8d06afab | 85 | struct timer_list _name = \ |
841b86f3 | 86 | __TIMER_INITIALIZER(_function, 0) |
8d06afab | 87 | |
919b250f KC |
88 | /* |
89 | * LOCKDEP and DEBUG timer interfaces. | |
90 | */ | |
188665b2 KC |
91 | void init_timer_key(struct timer_list *timer, |
92 | void (*func)(struct timer_list *), unsigned int flags, | |
fc683995 | 93 | const char *name, struct lock_class_key *key); |
6f2b9b9a | 94 | |
5a9af38d TH |
95 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
96 | extern void init_timer_on_stack_key(struct timer_list *timer, | |
188665b2 | 97 | void (*func)(struct timer_list *), |
fc683995 | 98 | unsigned int flags, const char *name, |
5a9af38d | 99 | struct lock_class_key *key); |
5a9af38d | 100 | #else |
5a9af38d | 101 | static inline void init_timer_on_stack_key(struct timer_list *timer, |
188665b2 KC |
102 | void (*func)(struct timer_list *), |
103 | unsigned int flags, | |
104 | const char *name, | |
5a9af38d TH |
105 | struct lock_class_key *key) |
106 | { | |
188665b2 | 107 | init_timer_key(timer, func, flags, name, key); |
5a9af38d TH |
108 | } |
109 | #endif | |
110 | ||
6f2b9b9a | 111 | #ifdef CONFIG_LOCKDEP |
188665b2 | 112 | #define __init_timer(_timer, _fn, _flags) \ |
6f2b9b9a JB |
113 | do { \ |
114 | static struct lock_class_key __key; \ | |
188665b2 | 115 | init_timer_key((_timer), (_fn), (_flags), #_timer, &__key);\ |
6f2b9b9a JB |
116 | } while (0) |
117 | ||
188665b2 | 118 | #define __init_timer_on_stack(_timer, _fn, _flags) \ |
6f2b9b9a JB |
119 | do { \ |
120 | static struct lock_class_key __key; \ | |
188665b2 KC |
121 | init_timer_on_stack_key((_timer), (_fn), (_flags), \ |
122 | #_timer, &__key); \ | |
6f2b9b9a | 123 | } while (0) |
fc683995 | 124 | #else |
188665b2 KC |
125 | #define __init_timer(_timer, _fn, _flags) \ |
126 | init_timer_key((_timer), (_fn), (_flags), NULL, NULL) | |
127 | #define __init_timer_on_stack(_timer, _fn, _flags) \ | |
128 | init_timer_on_stack_key((_timer), (_fn), (_flags), NULL, NULL) | |
fc683995 | 129 | #endif |
6f2b9b9a | 130 | |
919b250f KC |
131 | /** |
132 | * timer_setup - prepare a timer for first use | |
133 | * @timer: the timer in question | |
134 | * @callback: the function to call when timer expires | |
135 | * @flags: any TIMER_* flags | |
136 | * | |
137 | * Regular timer initialization should use either DEFINE_TIMER() above, | |
138 | * or timer_setup(). For timers on the stack, timer_setup_on_stack() must | |
139 | * be used and must be balanced with a call to destroy_timer_on_stack(). | |
140 | */ | |
141 | #define timer_setup(timer, callback, flags) \ | |
142 | __init_timer((timer), (callback), (flags)) | |
6f2b9b9a | 143 | |
919b250f KC |
144 | #define timer_setup_on_stack(timer, callback, flags) \ |
145 | __init_timer_on_stack((timer), (callback), (flags)) | |
686fef92 | 146 | |
919b250f KC |
147 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
148 | extern void destroy_timer_on_stack(struct timer_list *timer); | |
52f737c2 | 149 | #else |
919b250f | 150 | static inline void destroy_timer_on_stack(struct timer_list *timer) { } |
52f737c2 | 151 | #endif |
58e1177b | 152 | |
686fef92 KC |
153 | #define from_timer(var, callback_timer, timer_fieldname) \ |
154 | container_of(callback_timer, typeof(*var), timer_fieldname) | |
155 | ||
45f8bde0 | 156 | /** |
1da177e4 LT |
157 | * timer_pending - is a timer pending? |
158 | * @timer: the timer in question | |
159 | * | |
160 | * timer_pending will tell whether a given timer is currently pending, | |
161 | * or not. Callers must ensure serialization wrt. other operations done | |
162 | * to this timer, eg. interrupt contexts, or other CPUs on SMP. | |
163 | * | |
164 | * return value: 1 if the timer is pending, 0 if not. | |
165 | */ | |
166 | static inline int timer_pending(const struct timer_list * timer) | |
167 | { | |
90c01894 | 168 | return !hlist_unhashed_lockless(&timer->entry); |
1da177e4 LT |
169 | } |
170 | ||
171 | extern void add_timer_on(struct timer_list *timer, int cpu); | |
1da177e4 | 172 | extern int mod_timer(struct timer_list *timer, unsigned long expires); |
74019224 | 173 | extern int mod_timer_pending(struct timer_list *timer, unsigned long expires); |
b24591e2 | 174 | extern int timer_reduce(struct timer_list *timer, unsigned long expires); |
1da177e4 | 175 | |
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 | ||
74019224 | 182 | extern void add_timer(struct timer_list *timer); |
1da177e4 | 183 | |
6f1bc451 | 184 | extern int try_to_del_timer_sync(struct timer_list *timer); |
9b13df3f | 185 | extern int timer_delete_sync(struct timer_list *timer); |
bb663f0f | 186 | extern int timer_delete(struct timer_list *timer); |
f571faf6 TG |
187 | extern int timer_shutdown_sync(struct timer_list *timer); |
188 | extern int timer_shutdown(struct timer_list *timer); | |
9b13df3f TG |
189 | |
190 | /** | |
191 | * del_timer_sync - Delete a pending timer and wait for a running callback | |
192 | * @timer: The timer to be deleted | |
193 | * | |
194 | * See timer_delete_sync() for detailed explanation. | |
195 | * | |
196 | * Do not use in new code. Use timer_delete_sync() instead. | |
197 | */ | |
198 | static inline int del_timer_sync(struct timer_list *timer) | |
199 | { | |
200 | return timer_delete_sync(timer); | |
201 | } | |
1da177e4 | 202 | |
bb663f0f TG |
203 | /** |
204 | * del_timer - Delete a pending timer | |
205 | * @timer: The timer to be deleted | |
206 | * | |
207 | * See timer_delete() for detailed explanation. | |
208 | * | |
209 | * Do not use in new code. Use timer_delete() instead. | |
210 | */ | |
211 | static inline int del_timer(struct timer_list *timer) | |
212 | { | |
213 | return timer_delete(timer); | |
214 | } | |
215 | ||
1da177e4 | 216 | extern void init_timers(void); |
05cfb614 | 217 | struct hrtimer; |
c9cb2e3d | 218 | extern enum hrtimer_restart it_real_fn(struct hrtimer *); |
1da177e4 | 219 | |
4c36a5de AV |
220 | unsigned long __round_jiffies(unsigned long j, int cpu); |
221 | unsigned long __round_jiffies_relative(unsigned long j, int cpu); | |
222 | unsigned long round_jiffies(unsigned long j); | |
223 | unsigned long round_jiffies_relative(unsigned long j); | |
224 | ||
9c133c46 AS |
225 | unsigned long __round_jiffies_up(unsigned long j, int cpu); |
226 | unsigned long __round_jiffies_up_relative(unsigned long j, int cpu); | |
227 | unsigned long round_jiffies_up(unsigned long j); | |
228 | unsigned long round_jiffies_up_relative(unsigned long j); | |
229 | ||
24f73b99 | 230 | #ifdef CONFIG_HOTPLUG_CPU |
26456f87 | 231 | int timers_prepare_cpu(unsigned int cpu); |
24f73b99 RC |
232 | int timers_dead_cpu(unsigned int cpu); |
233 | #else | |
26456f87 TG |
234 | #define timers_prepare_cpu NULL |
235 | #define timers_dead_cpu NULL | |
24f73b99 RC |
236 | #endif |
237 | ||
1da177e4 | 238 | #endif |