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 */ 24 static inline void tick_init(void) { } 25 static inline void tick_suspend_local(void) { } 26 static inline void tick_resume_local(void) { } 27 static inline void tick_handover_do_timer(void) { } 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 35 static inline void tick_freeze(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 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 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 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 74 static inline int tick_broadcast_oneshot_control(enum tick_broadcast_state state) 75 { 76 return 0; 77 } 78 #endif 79 80 static inline void tick_broadcast_enable(void) 81 { 82 tick_broadcast_control(TICK_BROADCAST_ON); 83 } 84 static inline void tick_broadcast_disable(void) 85 { 86 tick_broadcast_control(TICK_BROADCAST_OFF); 87 } 88 static inline void tick_broadcast_force(void) 89 { 90 tick_broadcast_control(TICK_BROADCAST_FORCE); 91 } 92 static inline int tick_broadcast_enter(void) 93 { 94 return tick_broadcast_oneshot_control(TICK_BROADCAST_ENTER); 95 } 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 bool tick_nohz_tick_stopped(void); 117 extern bool tick_nohz_tick_stopped_cpu(int cpu); 118 extern void tick_nohz_idle_stop_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(void); 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 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) 139 static inline int tick_nohz_tick_stopped(void) { return 0; } 140 static inline int tick_nohz_tick_stopped_cpu(int cpu) { return 0; } 141 static inline void tick_nohz_idle_stop_tick(void) { } 142 static inline void tick_nohz_idle_restart_tick(void) { } 143 static inline void tick_nohz_idle_enter(void) { } 144 static inline void tick_nohz_idle_exit(void) { } 145 static inline bool tick_nohz_idle_got_tick(void) { return false; } 146 147 static inline ktime_t tick_nohz_get_sleep_length(void) 148 { 149 return NSEC_PER_SEC / HZ; 150 } 151 static inline u64 get_cpu_idle_time_us(int cpu, u64 *unused) { return -1; } 152 static inline u64 get_cpu_iowait_time_us(int cpu, u64 *unused) { return -1; } 153 154 static inline void tick_nohz_idle_stop_tick_protected(void) { } 155 #endif /* !CONFIG_NO_HZ_COMMON */ 156 157 #ifdef CONFIG_NO_HZ_FULL 158 extern bool tick_nohz_full_running; 159 extern cpumask_var_t tick_nohz_full_mask; 160 161 static inline bool tick_nohz_full_enabled(void) 162 { 163 if (!context_tracking_is_enabled()) 164 return false; 165 166 return tick_nohz_full_running; 167 } 168 169 static inline bool tick_nohz_full_cpu(int cpu) 170 { 171 if (!tick_nohz_full_enabled()) 172 return false; 173 174 return cpumask_test_cpu(cpu, tick_nohz_full_mask); 175 } 176 177 static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask) 178 { 179 if (tick_nohz_full_enabled()) 180 cpumask_or(mask, mask, tick_nohz_full_mask); 181 } 182 183 extern void tick_nohz_dep_set(enum tick_dep_bits bit); 184 extern void tick_nohz_dep_clear(enum tick_dep_bits bit); 185 extern void tick_nohz_dep_set_cpu(int cpu, enum tick_dep_bits bit); 186 extern void tick_nohz_dep_clear_cpu(int cpu, enum tick_dep_bits bit); 187 extern void tick_nohz_dep_set_task(struct task_struct *tsk, 188 enum tick_dep_bits bit); 189 extern void tick_nohz_dep_clear_task(struct task_struct *tsk, 190 enum tick_dep_bits bit); 191 extern void tick_nohz_dep_set_signal(struct signal_struct *signal, 192 enum tick_dep_bits bit); 193 extern void tick_nohz_dep_clear_signal(struct signal_struct *signal, 194 enum tick_dep_bits bit); 195 196 /* 197 * The below are tick_nohz_[set,clear]_dep() wrappers that optimize off-cases 198 * on top of static keys. 199 */ 200 static inline void tick_dep_set(enum tick_dep_bits bit) 201 { 202 if (tick_nohz_full_enabled()) 203 tick_nohz_dep_set(bit); 204 } 205 206 static inline void tick_dep_clear(enum tick_dep_bits bit) 207 { 208 if (tick_nohz_full_enabled()) 209 tick_nohz_dep_clear(bit); 210 } 211 212 static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit) 213 { 214 if (tick_nohz_full_cpu(cpu)) 215 tick_nohz_dep_set_cpu(cpu, bit); 216 } 217 218 static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit) 219 { 220 if (tick_nohz_full_cpu(cpu)) 221 tick_nohz_dep_clear_cpu(cpu, bit); 222 } 223 224 static inline void tick_dep_set_task(struct task_struct *tsk, 225 enum tick_dep_bits bit) 226 { 227 if (tick_nohz_full_enabled()) 228 tick_nohz_dep_set_task(tsk, bit); 229 } 230 static inline void tick_dep_clear_task(struct task_struct *tsk, 231 enum tick_dep_bits bit) 232 { 233 if (tick_nohz_full_enabled()) 234 tick_nohz_dep_clear_task(tsk, bit); 235 } 236 static inline void tick_dep_set_signal(struct signal_struct *signal, 237 enum tick_dep_bits bit) 238 { 239 if (tick_nohz_full_enabled()) 240 tick_nohz_dep_set_signal(signal, bit); 241 } 242 static inline void tick_dep_clear_signal(struct signal_struct *signal, 243 enum tick_dep_bits bit) 244 { 245 if (tick_nohz_full_enabled()) 246 tick_nohz_dep_clear_signal(signal, bit); 247 } 248 249 extern void tick_nohz_full_kick_cpu(int cpu); 250 extern void __tick_nohz_task_switch(void); 251 extern void __init tick_nohz_full_setup(cpumask_var_t cpumask); 252 #else 253 static inline bool tick_nohz_full_enabled(void) { return false; } 254 static inline bool tick_nohz_full_cpu(int cpu) { return false; } 255 static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask) { } 256 257 static inline void tick_dep_set(enum tick_dep_bits bit) { } 258 static inline void tick_dep_clear(enum tick_dep_bits bit) { } 259 static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit) { } 260 static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit) { } 261 static inline void tick_dep_set_task(struct task_struct *tsk, 262 enum tick_dep_bits bit) { } 263 static inline void tick_dep_clear_task(struct task_struct *tsk, 264 enum tick_dep_bits bit) { } 265 static inline void tick_dep_set_signal(struct signal_struct *signal, 266 enum tick_dep_bits bit) { } 267 static inline void tick_dep_clear_signal(struct signal_struct *signal, 268 enum tick_dep_bits bit) { } 269 270 static inline void tick_nohz_full_kick_cpu(int cpu) { } 271 static inline void __tick_nohz_task_switch(void) { } 272 static inline void tick_nohz_full_setup(cpumask_var_t cpumask) { } 273 #endif 274 275 static inline void tick_nohz_task_switch(void) 276 { 277 if (tick_nohz_full_enabled()) 278 __tick_nohz_task_switch(); 279 } 280 281 #endif 282