]>
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; | |
354b46b1 | 20 | void (*function)(struct timer_list *); |
0eeda71b | 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 | ||
1fe66ba5 | 66 | #define __TIMER_INITIALIZER(_function, _flags) { \ |
1dabbcec | 67 | .entry = { .next = TIMER_ENTRY_STATIC }, \ |
1da177e4 | 68 | .function = (_function), \ |
0eeda71b | 69 | .flags = (_flags), \ |
6f2b9b9a JB |
70 | __TIMER_LOCKDEP_MAP_INITIALIZER( \ |
71 | __FILE__ ":" __stringify(__LINE__)) \ | |
1da177e4 LT |
72 | } |
73 | ||
1d27e3e2 | 74 | #define DEFINE_TIMER(_name, _function) \ |
8d06afab | 75 | struct timer_list _name = \ |
841b86f3 | 76 | __TIMER_INITIALIZER(_function, 0) |
8d06afab | 77 | |
919b250f KC |
78 | /* |
79 | * LOCKDEP and DEBUG timer interfaces. | |
80 | */ | |
188665b2 KC |
81 | void init_timer_key(struct timer_list *timer, |
82 | void (*func)(struct timer_list *), unsigned int flags, | |
fc683995 | 83 | const char *name, struct lock_class_key *key); |
6f2b9b9a | 84 | |
5a9af38d TH |
85 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
86 | extern void init_timer_on_stack_key(struct timer_list *timer, | |
188665b2 | 87 | void (*func)(struct timer_list *), |
fc683995 | 88 | unsigned int flags, const char *name, |
5a9af38d | 89 | struct lock_class_key *key); |
5a9af38d | 90 | #else |
5a9af38d | 91 | static inline void init_timer_on_stack_key(struct timer_list *timer, |
188665b2 KC |
92 | void (*func)(struct timer_list *), |
93 | unsigned int flags, | |
94 | const char *name, | |
5a9af38d TH |
95 | struct lock_class_key *key) |
96 | { | |
188665b2 | 97 | init_timer_key(timer, func, flags, name, key); |
5a9af38d TH |
98 | } |
99 | #endif | |
100 | ||
6f2b9b9a | 101 | #ifdef CONFIG_LOCKDEP |
188665b2 | 102 | #define __init_timer(_timer, _fn, _flags) \ |
6f2b9b9a JB |
103 | do { \ |
104 | static struct lock_class_key __key; \ | |
188665b2 | 105 | init_timer_key((_timer), (_fn), (_flags), #_timer, &__key);\ |
6f2b9b9a JB |
106 | } while (0) |
107 | ||
188665b2 | 108 | #define __init_timer_on_stack(_timer, _fn, _flags) \ |
6f2b9b9a JB |
109 | do { \ |
110 | static struct lock_class_key __key; \ | |
188665b2 KC |
111 | init_timer_on_stack_key((_timer), (_fn), (_flags), \ |
112 | #_timer, &__key); \ | |
6f2b9b9a | 113 | } while (0) |
fc683995 | 114 | #else |
188665b2 KC |
115 | #define __init_timer(_timer, _fn, _flags) \ |
116 | init_timer_key((_timer), (_fn), (_flags), NULL, NULL) | |
117 | #define __init_timer_on_stack(_timer, _fn, _flags) \ | |
118 | init_timer_on_stack_key((_timer), (_fn), (_flags), NULL, NULL) | |
fc683995 | 119 | #endif |
6f2b9b9a | 120 | |
919b250f KC |
121 | /** |
122 | * timer_setup - prepare a timer for first use | |
123 | * @timer: the timer in question | |
124 | * @callback: the function to call when timer expires | |
125 | * @flags: any TIMER_* flags | |
126 | * | |
127 | * Regular timer initialization should use either DEFINE_TIMER() above, | |
128 | * or timer_setup(). For timers on the stack, timer_setup_on_stack() must | |
129 | * be used and must be balanced with a call to destroy_timer_on_stack(). | |
130 | */ | |
131 | #define timer_setup(timer, callback, flags) \ | |
132 | __init_timer((timer), (callback), (flags)) | |
6f2b9b9a | 133 | |
919b250f KC |
134 | #define timer_setup_on_stack(timer, callback, flags) \ |
135 | __init_timer_on_stack((timer), (callback), (flags)) | |
686fef92 | 136 | |
919b250f KC |
137 | #ifdef CONFIG_DEBUG_OBJECTS_TIMERS |
138 | extern void destroy_timer_on_stack(struct timer_list *timer); | |
52f737c2 | 139 | #else |
919b250f | 140 | static inline void destroy_timer_on_stack(struct timer_list *timer) { } |
52f737c2 | 141 | #endif |
58e1177b | 142 | |
686fef92 KC |
143 | #define from_timer(var, callback_timer, timer_fieldname) \ |
144 | container_of(callback_timer, typeof(*var), timer_fieldname) | |
145 | ||
45f8bde0 | 146 | /** |
1da177e4 LT |
147 | * timer_pending - is a timer pending? |
148 | * @timer: the timer in question | |
149 | * | |
150 | * timer_pending will tell whether a given timer is currently pending, | |
151 | * or not. Callers must ensure serialization wrt. other operations done | |
152 | * to this timer, eg. interrupt contexts, or other CPUs on SMP. | |
153 | * | |
154 | * return value: 1 if the timer is pending, 0 if not. | |
155 | */ | |
156 | static inline int timer_pending(const struct timer_list * timer) | |
157 | { | |
1dabbcec | 158 | return timer->entry.pprev != NULL; |
1da177e4 LT |
159 | } |
160 | ||
161 | extern void add_timer_on(struct timer_list *timer, int cpu); | |
162 | extern int del_timer(struct timer_list * timer); | |
1da177e4 | 163 | extern int mod_timer(struct timer_list *timer, unsigned long expires); |
74019224 | 164 | extern int mod_timer_pending(struct timer_list *timer, unsigned long expires); |
b24591e2 | 165 | extern int timer_reduce(struct timer_list *timer, unsigned long expires); |
1da177e4 | 166 | |
eaad084b TG |
167 | /* |
168 | * The jiffies value which is added to now, when there is no timer | |
169 | * in the timer wheel: | |
170 | */ | |
171 | #define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1) | |
172 | ||
74019224 | 173 | extern void add_timer(struct timer_list *timer); |
1da177e4 | 174 | |
6f1bc451 YZ |
175 | extern int try_to_del_timer_sync(struct timer_list *timer); |
176 | ||
1da177e4 LT |
177 | #ifdef CONFIG_SMP |
178 | extern int del_timer_sync(struct timer_list *timer); | |
1da177e4 | 179 | #else |
fd450b73 | 180 | # define del_timer_sync(t) del_timer(t) |
1da177e4 LT |
181 | #endif |
182 | ||
55c888d6 ON |
183 | #define del_singleshot_timer_sync(t) del_timer_sync(t) |
184 | ||
1da177e4 LT |
185 | extern void init_timers(void); |
186 | extern void run_local_timers(void); | |
05cfb614 | 187 | struct hrtimer; |
c9cb2e3d | 188 | extern enum hrtimer_restart it_real_fn(struct hrtimer *); |
1da177e4 | 189 | |
bc7a34b8 | 190 | #if defined(CONFIG_SMP) && defined(CONFIG_NO_HZ_COMMON) |
b2d5bfea | 191 | struct ctl_table; |
bc7a34b8 TG |
192 | |
193 | extern unsigned int sysctl_timer_migration; | |
194 | int timer_migration_handler(struct ctl_table *table, int write, | |
195 | void __user *buffer, size_t *lenp, | |
196 | loff_t *ppos); | |
197 | #endif | |
198 | ||
4c36a5de AV |
199 | unsigned long __round_jiffies(unsigned long j, int cpu); |
200 | unsigned long __round_jiffies_relative(unsigned long j, int cpu); | |
201 | unsigned long round_jiffies(unsigned long j); | |
202 | unsigned long round_jiffies_relative(unsigned long j); | |
203 | ||
9c133c46 AS |
204 | unsigned long __round_jiffies_up(unsigned long j, int cpu); |
205 | unsigned long __round_jiffies_up_relative(unsigned long j, int cpu); | |
206 | unsigned long round_jiffies_up(unsigned long j); | |
207 | unsigned long round_jiffies_up_relative(unsigned long j); | |
208 | ||
24f73b99 | 209 | #ifdef CONFIG_HOTPLUG_CPU |
26456f87 | 210 | int timers_prepare_cpu(unsigned int cpu); |
24f73b99 RC |
211 | int timers_dead_cpu(unsigned int cpu); |
212 | #else | |
26456f87 TG |
213 | #define timers_prepare_cpu NULL |
214 | #define timers_dead_cpu NULL | |
24f73b99 RC |
215 | #endif |
216 | ||
1da177e4 | 217 | #endif |