1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Tick related global functions
4 */
5 #ifndef _LINUX_TICK_H
6 #define _LINUX_TICK_H
7
8 #include <linux/clockchips.h>
9 #include <linux/irqflags.h>
10 #include <linux/percpu.h>
11 #include <linux/context_tracking_state.h>
12 #include <linux/cpumask.h>
13 #include <linux/sched.h>
14
15 #ifdef CONFIG_GENERIC_CLOCKEVENTS
16 extern void __init tick_init(void);
17 /* Should be core only, but ARM BL switcher requires it */
18 extern void tick_suspend_local(void);
19 /* Should be core only, but XEN resume magic and ARM BL switcher require it */
20 extern void tick_resume_local(void);
21 extern void tick_handover_do_timer(void);
22 extern void tick_cleanup_dead_cpu(int cpu);
23 #else /* CONFIG_GENERIC_CLOCKEVENTS */
tick_init(void)24 static inline void tick_init(void) { }
tick_suspend_local(void)25 static inline void tick_suspend_local(void) { }
tick_resume_local(void)26 static inline void tick_resume_local(void) { }
tick_handover_do_timer(void)27 static inline void tick_handover_do_timer(void) { }
tick_cleanup_dead_cpu(int cpu)28 static inline void tick_cleanup_dead_cpu(int cpu) { }
29 #endif /* !CONFIG_GENERIC_CLOCKEVENTS */
30
31 #if defined(CONFIG_GENERIC_CLOCKEVENTS) && defined(CONFIG_SUSPEND)
32 extern void tick_freeze(void);
33 extern void tick_unfreeze(void);
34 #else
tick_freeze(void)35 static inline void tick_freeze(void) { }
tick_unfreeze(void)36 static inline void tick_unfreeze(void) { }
37 #endif
38
39 #ifdef CONFIG_TICK_ONESHOT
40 extern void tick_irq_enter(void);
41 # ifndef arch_needs_cpu
42 # define arch_needs_cpu() (0)
43 # endif
44 # else
tick_irq_enter(void)45 static inline void tick_irq_enter(void) { }
46 #endif
47
48 #if defined(CONFIG_GENERIC_CLOCKEVENTS_BROADCAST) && defined(CONFIG_TICK_ONESHOT)
49 extern void hotplug_cpu__broadcast_tick_pull(int dead_cpu);
50 #else
hotplug_cpu__broadcast_tick_pull(int dead_cpu)51 static inline void hotplug_cpu__broadcast_tick_pull(int dead_cpu) { }
52 #endif
53
54 enum tick_broadcast_mode {
55 TICK_BROADCAST_OFF,
56 TICK_BROADCAST_ON,
57 TICK_BROADCAST_FORCE,
58 };
59
60 enum tick_broadcast_state {
61 TICK_BROADCAST_EXIT,
62 TICK_BROADCAST_ENTER,
63 };
64
65 #ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
66 extern void tick_broadcast_control(enum tick_broadcast_mode mode);
67 #else
tick_broadcast_control(enum tick_broadcast_mode mode)68 static inline void tick_broadcast_control(enum tick_broadcast_mode mode) { }
69 #endif /* BROADCAST */
70
71 #ifdef CONFIG_GENERIC_CLOCKEVENTS
72 extern int tick_broadcast_oneshot_control(enum tick_broadcast_state state);
73 #else
tick_broadcast_oneshot_control(enum tick_broadcast_state state)74 static inline int tick_broadcast_oneshot_control(enum tick_broadcast_state state)
75 {
76 return 0;
77 }
78 #endif
79
tick_broadcast_enable(void)80 static inline void tick_broadcast_enable(void)
81 {
82 tick_broadcast_control(TICK_BROADCAST_ON);
83 }
tick_broadcast_disable(void)84 static inline void tick_broadcast_disable(void)
85 {
86 tick_broadcast_control(TICK_BROADCAST_OFF);
87 }
tick_broadcast_force(void)88 static inline void tick_broadcast_force(void)
89 {
90 tick_broadcast_control(TICK_BROADCAST_FORCE);
91 }
tick_broadcast_enter(void)92 static inline int tick_broadcast_enter(void)
93 {
94 return tick_broadcast_oneshot_control(TICK_BROADCAST_ENTER);
95 }
tick_broadcast_exit(void)96 static inline void tick_broadcast_exit(void)
97 {
98 tick_broadcast_oneshot_control(TICK_BROADCAST_EXIT);
99 }
100
101 enum tick_dep_bits {
102 TICK_DEP_BIT_POSIX_TIMER = 0,
103 TICK_DEP_BIT_PERF_EVENTS = 1,
104 TICK_DEP_BIT_SCHED = 2,
105 TICK_DEP_BIT_CLOCK_UNSTABLE = 3
106 };
107
108 #define TICK_DEP_MASK_NONE 0
109 #define TICK_DEP_MASK_POSIX_TIMER (1 << TICK_DEP_BIT_POSIX_TIMER)
110 #define TICK_DEP_MASK_PERF_EVENTS (1 << TICK_DEP_BIT_PERF_EVENTS)
111 #define TICK_DEP_MASK_SCHED (1 << TICK_DEP_BIT_SCHED)
112 #define TICK_DEP_MASK_CLOCK_UNSTABLE (1 << TICK_DEP_BIT_CLOCK_UNSTABLE)
113
114 #ifdef CONFIG_NO_HZ_COMMON
115 extern bool tick_nohz_enabled;
116 extern int tick_nohz_tick_stopped(void);
117 extern void tick_nohz_idle_stop_tick(void);
118 extern void tick_nohz_idle_retain_tick(void);
119 extern void tick_nohz_idle_restart_tick(void);
120 extern void tick_nohz_idle_enter(void);
121 extern void tick_nohz_idle_exit(void);
122 extern void tick_nohz_irq_exit(void);
123 extern bool tick_nohz_idle_got_tick(void);
124 extern ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next);
125 extern unsigned long tick_nohz_get_idle_calls(void);
126 extern unsigned long tick_nohz_get_idle_calls_cpu(int cpu);
127 extern u64 get_cpu_idle_time_us(int cpu, u64 *last_update_time);
128 extern u64 get_cpu_iowait_time_us(int cpu, u64 *last_update_time);
129
tick_nohz_idle_stop_tick_protected(void)130 static inline void tick_nohz_idle_stop_tick_protected(void)
131 {
132 local_irq_disable();
133 tick_nohz_idle_stop_tick();
134 local_irq_enable();
135 }
136
137 #else /* !CONFIG_NO_HZ_COMMON */
138 #define tick_nohz_enabled (0)
tick_nohz_tick_stopped(void)139 static inline int tick_nohz_tick_stopped(void) { return 0; }
tick_nohz_idle_stop_tick(void)140 static inline void tick_nohz_idle_stop_tick(void) { }
tick_nohz_idle_retain_tick(void)141 static inline void tick_nohz_idle_retain_tick(void) { }
tick_nohz_idle_restart_tick(void)142 static inline void tick_nohz_idle_restart_tick(void) { }
tick_nohz_idle_enter(void)143 static inline void tick_nohz_idle_enter(void) { }
tick_nohz_idle_exit(void)144 static inline void tick_nohz_idle_exit(void) { }
tick_nohz_idle_got_tick(void)145 static inline bool tick_nohz_idle_got_tick(void) { return false; }
146
tick_nohz_get_sleep_length(ktime_t * delta_next)147 static inline ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next)
148 {
149 *delta_next = TICK_NSEC;
150 return *delta_next;
151 }
get_cpu_idle_time_us(int cpu,u64 * unused)152 static inline u64 get_cpu_idle_time_us(int cpu, u64 *unused) { return -1; }
get_cpu_iowait_time_us(int cpu,u64 * unused)153 static inline u64 get_cpu_iowait_time_us(int cpu, u64 *unused) { return -1; }
154
tick_nohz_idle_stop_tick_protected(void)155 static inline void tick_nohz_idle_stop_tick_protected(void) { }
156 #endif /* !CONFIG_NO_HZ_COMMON */
157
158 #ifdef CONFIG_NO_HZ_FULL
159 extern bool tick_nohz_full_running;
160 extern cpumask_var_t tick_nohz_full_mask;
161 extern cpumask_var_t housekeeping_mask;
162
tick_nohz_full_enabled(void)163 static inline bool tick_nohz_full_enabled(void)
164 {
165 if (!context_tracking_is_enabled())
166 return false;
167
168 return tick_nohz_full_running;
169 }
170
tick_nohz_full_cpu(int cpu)171 static inline bool tick_nohz_full_cpu(int cpu)
172 {
173 if (!tick_nohz_full_enabled())
174 return false;
175
176 return cpumask_test_cpu(cpu, tick_nohz_full_mask);
177 }
178
tick_nohz_full_add_cpus_to(struct cpumask * mask)179 static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask)
180 {
181 if (tick_nohz_full_enabled())
182 cpumask_or(mask, mask, tick_nohz_full_mask);
183 }
184
housekeeping_any_cpu(void)185 static inline int housekeeping_any_cpu(void)
186 {
187 return cpumask_any_and(housekeeping_mask, cpu_online_mask);
188 }
189
190 extern void tick_nohz_dep_set(enum tick_dep_bits bit);
191 extern void tick_nohz_dep_clear(enum tick_dep_bits bit);
192 extern void tick_nohz_dep_set_cpu(int cpu, enum tick_dep_bits bit);
193 extern void tick_nohz_dep_clear_cpu(int cpu, enum tick_dep_bits bit);
194 extern void tick_nohz_dep_set_task(struct task_struct *tsk,
195 enum tick_dep_bits bit);
196 extern void tick_nohz_dep_clear_task(struct task_struct *tsk,
197 enum tick_dep_bits bit);
198 extern void tick_nohz_dep_set_signal(struct signal_struct *signal,
199 enum tick_dep_bits bit);
200 extern void tick_nohz_dep_clear_signal(struct signal_struct *signal,
201 enum tick_dep_bits bit);
202
203 /*
204 * The below are tick_nohz_[set,clear]_dep() wrappers that optimize off-cases
205 * on top of static keys.
206 */
tick_dep_set(enum tick_dep_bits bit)207 static inline void tick_dep_set(enum tick_dep_bits bit)
208 {
209 if (tick_nohz_full_enabled())
210 tick_nohz_dep_set(bit);
211 }
212
tick_dep_clear(enum tick_dep_bits bit)213 static inline void tick_dep_clear(enum tick_dep_bits bit)
214 {
215 if (tick_nohz_full_enabled())
216 tick_nohz_dep_clear(bit);
217 }
218
tick_dep_set_cpu(int cpu,enum tick_dep_bits bit)219 static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit)
220 {
221 if (tick_nohz_full_cpu(cpu))
222 tick_nohz_dep_set_cpu(cpu, bit);
223 }
224
tick_dep_clear_cpu(int cpu,enum tick_dep_bits bit)225 static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit)
226 {
227 if (tick_nohz_full_cpu(cpu))
228 tick_nohz_dep_clear_cpu(cpu, bit);
229 }
230
tick_dep_set_task(struct task_struct * tsk,enum tick_dep_bits bit)231 static inline void tick_dep_set_task(struct task_struct *tsk,
232 enum tick_dep_bits bit)
233 {
234 if (tick_nohz_full_enabled())
235 tick_nohz_dep_set_task(tsk, bit);
236 }
tick_dep_clear_task(struct task_struct * tsk,enum tick_dep_bits bit)237 static inline void tick_dep_clear_task(struct task_struct *tsk,
238 enum tick_dep_bits bit)
239 {
240 if (tick_nohz_full_enabled())
241 tick_nohz_dep_clear_task(tsk, bit);
242 }
tick_dep_set_signal(struct signal_struct * signal,enum tick_dep_bits bit)243 static inline void tick_dep_set_signal(struct signal_struct *signal,
244 enum tick_dep_bits bit)
245 {
246 if (tick_nohz_full_enabled())
247 tick_nohz_dep_set_signal(signal, bit);
248 }
tick_dep_clear_signal(struct signal_struct * signal,enum tick_dep_bits bit)249 static inline void tick_dep_clear_signal(struct signal_struct *signal,
250 enum tick_dep_bits bit)
251 {
252 if (tick_nohz_full_enabled())
253 tick_nohz_dep_clear_signal(signal, bit);
254 }
255
256 extern void tick_nohz_full_kick_cpu(int cpu);
257 extern void __tick_nohz_task_switch(void);
258 #else
housekeeping_any_cpu(void)259 static inline int housekeeping_any_cpu(void)
260 {
261 return smp_processor_id();
262 }
tick_nohz_full_enabled(void)263 static inline bool tick_nohz_full_enabled(void) { return false; }
tick_nohz_full_cpu(int cpu)264 static inline bool tick_nohz_full_cpu(int cpu) { return false; }
tick_nohz_full_add_cpus_to(struct cpumask * mask)265 static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask) { }
266
tick_dep_set(enum tick_dep_bits bit)267 static inline void tick_dep_set(enum tick_dep_bits bit) { }
tick_dep_clear(enum tick_dep_bits bit)268 static inline void tick_dep_clear(enum tick_dep_bits bit) { }
tick_dep_set_cpu(int cpu,enum tick_dep_bits bit)269 static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit) { }
tick_dep_clear_cpu(int cpu,enum tick_dep_bits bit)270 static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit) { }
tick_dep_set_task(struct task_struct * tsk,enum tick_dep_bits bit)271 static inline void tick_dep_set_task(struct task_struct *tsk,
272 enum tick_dep_bits bit) { }
tick_dep_clear_task(struct task_struct * tsk,enum tick_dep_bits bit)273 static inline void tick_dep_clear_task(struct task_struct *tsk,
274 enum tick_dep_bits bit) { }
tick_dep_set_signal(struct signal_struct * signal,enum tick_dep_bits bit)275 static inline void tick_dep_set_signal(struct signal_struct *signal,
276 enum tick_dep_bits bit) { }
tick_dep_clear_signal(struct signal_struct * signal,enum tick_dep_bits bit)277 static inline void tick_dep_clear_signal(struct signal_struct *signal,
278 enum tick_dep_bits bit) { }
279
tick_nohz_full_kick_cpu(int cpu)280 static inline void tick_nohz_full_kick_cpu(int cpu) { }
__tick_nohz_task_switch(void)281 static inline void __tick_nohz_task_switch(void) { }
282 #endif
283
housekeeping_cpumask(void)284 static inline const struct cpumask *housekeeping_cpumask(void)
285 {
286 #ifdef CONFIG_NO_HZ_FULL
287 if (tick_nohz_full_enabled())
288 return housekeeping_mask;
289 #endif
290 return cpu_possible_mask;
291 }
292
is_housekeeping_cpu(int cpu)293 static inline bool is_housekeeping_cpu(int cpu)
294 {
295 #ifdef CONFIG_NO_HZ_FULL
296 if (tick_nohz_full_enabled())
297 return cpumask_test_cpu(cpu, housekeeping_mask);
298 #endif
299 return true;
300 }
301
housekeeping_affine(struct task_struct * t)302 static inline void housekeeping_affine(struct task_struct *t)
303 {
304 #ifdef CONFIG_NO_HZ_FULL
305 if (tick_nohz_full_enabled())
306 set_cpus_allowed_ptr(t, housekeeping_mask);
307
308 #endif
309 }
310
tick_nohz_task_switch(void)311 static inline void tick_nohz_task_switch(void)
312 {
313 if (tick_nohz_full_enabled())
314 __tick_nohz_task_switch();
315 }
316
317 #endif
318