Merge tag 'powerpc-6.9-2' of git://git.kernel.org/pub/scm/linux/kernel/git/powerpc...
[linux-block.git] / include / linux / tick.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
c1797baf
TG
2/*
3 * Tick related global functions
906568c9
TG
4 */
5#ifndef _LINUX_TICK_H
6#define _LINUX_TICK_H
7
8#include <linux/clockchips.h>
2bbb6817 9#include <linux/irqflags.h>
33a5f626 10#include <linux/percpu.h>
460775df
FW
11#include <linux/context_tracking_state.h>
12#include <linux/cpumask.h>
c0f489d2 13#include <linux/sched.h>
f268c373 14#include <linux/rcupdate.h>
2be2a197 15#include <linux/static_key.h>
906568c9 16
c1797baf
TG
17#ifdef CONFIG_GENERIC_CLOCKEVENTS
18extern void __init tick_init(void);
7270d11c
TG
19/* Should be core only, but ARM BL switcher requires it */
20extern void tick_suspend_local(void);
21/* Should be core only, but XEN resume magic and ARM BL switcher require it */
f46481d0 22extern void tick_resume_local(void);
a49b116d 23extern void tick_cleanup_dead_cpu(int cpu);
c1797baf
TG
24#else /* CONFIG_GENERIC_CLOCKEVENTS */
25static inline void tick_init(void) { }
7270d11c 26static inline void tick_suspend_local(void) { }
f46481d0 27static inline void tick_resume_local(void) { }
a49b116d 28static inline void tick_cleanup_dead_cpu(int cpu) { }
c1797baf 29#endif /* !CONFIG_GENERIC_CLOCKEVENTS */
124cf911 30
3ad6eb06
FW
31#if defined(CONFIG_GENERIC_CLOCKEVENTS) && defined(CONFIG_HOTPLUG_CPU)
32extern int tick_cpu_dying(unsigned int cpu);
500f8f9b 33extern void tick_assert_timekeeping_handover(void);
3ad6eb06
FW
34#else
35#define tick_cpu_dying NULL
500f8f9b 36static inline void tick_assert_timekeeping_handover(void) { }
3ad6eb06
FW
37#endif
38
87e9b9f1
RW
39#if defined(CONFIG_GENERIC_CLOCKEVENTS) && defined(CONFIG_SUSPEND)
40extern void tick_freeze(void);
41extern void tick_unfreeze(void);
42#else
43static inline void tick_freeze(void) { }
44static inline void tick_unfreeze(void) { }
45#endif
46
c1797baf 47#ifdef CONFIG_TICK_ONESHOT
5acac1be 48extern void tick_irq_enter(void);
3c5d92a0 49# ifndef arch_needs_cpu
fe0f4976 50# define arch_needs_cpu() (0)
3c5d92a0 51# endif
79bf2bb3 52# else
5acac1be 53static inline void tick_irq_enter(void) { }
c1797baf 54#endif
33a5f626 55
345527b1
PM
56#if defined(CONFIG_GENERIC_CLOCKEVENTS_BROADCAST) && defined(CONFIG_TICK_ONESHOT)
57extern void hotplug_cpu__broadcast_tick_pull(int dead_cpu);
58#else
59static inline void hotplug_cpu__broadcast_tick_pull(int dead_cpu) { }
60#endif
61
592a438f
TG
62enum tick_broadcast_mode {
63 TICK_BROADCAST_OFF,
64 TICK_BROADCAST_ON,
65 TICK_BROADCAST_FORCE,
66};
67
1fe5d5c3
TG
68enum tick_broadcast_state {
69 TICK_BROADCAST_EXIT,
70 TICK_BROADCAST_ENTER,
71};
72
2be2a197
TG
73extern struct static_key_false arch_needs_tick_broadcast;
74
592a438f
TG
75#ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
76extern void tick_broadcast_control(enum tick_broadcast_mode mode);
77#else
78static inline void tick_broadcast_control(enum tick_broadcast_mode mode) { }
79#endif /* BROADCAST */
80
37b64a42 81#ifdef CONFIG_GENERIC_CLOCKEVENTS
1fe5d5c3 82extern int tick_broadcast_oneshot_control(enum tick_broadcast_state state);
37b64a42
TG
83#else
84static inline int tick_broadcast_oneshot_control(enum tick_broadcast_state state)
85{
86 return 0;
87}
88#endif
1fe5d5c3 89
592a438f
TG
90static inline void tick_broadcast_enable(void)
91{
92 tick_broadcast_control(TICK_BROADCAST_ON);
93}
94static inline void tick_broadcast_disable(void)
95{
96 tick_broadcast_control(TICK_BROADCAST_OFF);
97}
98static inline void tick_broadcast_force(void)
99{
100 tick_broadcast_control(TICK_BROADCAST_FORCE);
101}
1fe5d5c3
TG
102static inline int tick_broadcast_enter(void)
103{
104 return tick_broadcast_oneshot_control(TICK_BROADCAST_ENTER);
105}
106static inline void tick_broadcast_exit(void)
107{
108 tick_broadcast_oneshot_control(TICK_BROADCAST_EXIT);
109}
592a438f 110
d027d45d
FW
111enum tick_dep_bits {
112 TICK_DEP_BIT_POSIX_TIMER = 0,
113 TICK_DEP_BIT_PERF_EVENTS = 1,
114 TICK_DEP_BIT_SCHED = 2,
01b4c399 115 TICK_DEP_BIT_CLOCK_UNSTABLE = 3,
df1e849a
PM
116 TICK_DEP_BIT_RCU = 4,
117 TICK_DEP_BIT_RCU_EXP = 5
d027d45d 118};
df1e849a 119#define TICK_DEP_BIT_MAX TICK_DEP_BIT_RCU_EXP
d027d45d 120
e6e6cc22 121#define TICK_DEP_MASK_NONE 0
d027d45d
FW
122#define TICK_DEP_MASK_POSIX_TIMER (1 << TICK_DEP_BIT_POSIX_TIMER)
123#define TICK_DEP_MASK_PERF_EVENTS (1 << TICK_DEP_BIT_PERF_EVENTS)
124#define TICK_DEP_MASK_SCHED (1 << TICK_DEP_BIT_SCHED)
125#define TICK_DEP_MASK_CLOCK_UNSTABLE (1 << TICK_DEP_BIT_CLOCK_UNSTABLE)
01b4c399 126#define TICK_DEP_MASK_RCU (1 << TICK_DEP_BIT_RCU)
df1e849a 127#define TICK_DEP_MASK_RCU_EXP (1 << TICK_DEP_BIT_RCU_EXP)
d027d45d 128
c1797baf 129#ifdef CONFIG_NO_HZ_COMMON
4cc7ecb7 130extern bool tick_nohz_enabled;
a3642983 131extern bool tick_nohz_tick_stopped(void);
22ab8bc0 132extern bool tick_nohz_tick_stopped_cpu(int cpu);
0e776768 133extern void tick_nohz_idle_stop_tick(void);
554c8aa8 134extern void tick_nohz_idle_retain_tick(void);
2aaf709a 135extern void tick_nohz_idle_restart_tick(void);
1268fbc7 136extern void tick_nohz_idle_enter(void);
280f0677
FW
137extern void tick_nohz_idle_exit(void);
138extern void tick_nohz_irq_exit(void);
45f1ff59 139extern bool tick_nohz_idle_got_tick(void);
6f9b83ac 140extern ktime_t tick_nohz_get_next_hrtimer(void);
296bb1e5 141extern ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next);
b7eaf1aa 142extern unsigned long tick_nohz_get_idle_calls(void);
466a2b42 143extern unsigned long tick_nohz_get_idle_calls_cpu(int cpu);
6378ddb5 144extern u64 get_cpu_idle_time_us(int cpu, u64 *last_update_time);
0224cf4c 145extern u64 get_cpu_iowait_time_us(int cpu, u64 *last_update_time);
c1797baf 146#else /* !CONFIG_NO_HZ_COMMON */
46373a15 147#define tick_nohz_enabled (0)
c1797baf 148static inline int tick_nohz_tick_stopped(void) { return 0; }
22ab8bc0 149static inline int tick_nohz_tick_stopped_cpu(int cpu) { return 0; }
0e776768 150static inline void tick_nohz_idle_stop_tick(void) { }
554c8aa8 151static inline void tick_nohz_idle_retain_tick(void) { }
2aaf709a 152static inline void tick_nohz_idle_restart_tick(void) { }
2bbb6817
FW
153static inline void tick_nohz_idle_enter(void) { }
154static inline void tick_nohz_idle_exit(void) { }
45f1ff59 155static inline bool tick_nohz_idle_got_tick(void) { return false; }
6f9b83ac
UH
156static inline ktime_t tick_nohz_get_next_hrtimer(void)
157{
158 /* Next wake up is the tick period, assume it starts now */
159 return ktime_add(ktime_get(), TICK_NSEC);
160}
296bb1e5 161static inline ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next)
4f86d3a8 162{
296bb1e5
RW
163 *delta_next = TICK_NSEC;
164 return *delta_next;
4f86d3a8 165}
8083e4ad 166static inline u64 get_cpu_idle_time_us(int cpu, u64 *unused) { return -1; }
0224cf4c 167static inline u64 get_cpu_iowait_time_us(int cpu, u64 *unused) { return -1; }
c1797baf 168#endif /* !CONFIG_NO_HZ_COMMON */
906568c9 169
31a5c0b7
JM
170/*
171 * Mask of CPUs that are nohz_full.
172 *
173 * Users should be guarded by CONFIG_NO_HZ_FULL or a tick_nohz_full_cpu()
174 * check.
175 */
176extern cpumask_var_t tick_nohz_full_mask;
177
c5bfece2 178#ifdef CONFIG_NO_HZ_FULL
460775df 179extern bool tick_nohz_full_running;
460775df
FW
180
181static inline bool tick_nohz_full_enabled(void)
182{
74c57875 183 if (!context_tracking_enabled())
460775df
FW
184 return false;
185
186 return tick_nohz_full_running;
187}
188
f105dfec
PZ
189/*
190 * Check if a CPU is part of the nohz_full subset. Arrange for evaluating
191 * the cpu expression (typically smp_processor_id()) _after_ the static
192 * key.
193 */
194#define tick_nohz_full_cpu(_cpu) ({ \
195 bool __ret = false; \
196 if (tick_nohz_full_enabled()) \
197 __ret = cpumask_test_cpu((_cpu), tick_nohz_full_mask); \
198 __ret; \
199})
460775df 200
83dedea8
CM
201static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask)
202{
203 if (tick_nohz_full_enabled())
204 cpumask_or(mask, mask, tick_nohz_full_mask);
205}
206
d027d45d
FW
207extern void tick_nohz_dep_set(enum tick_dep_bits bit);
208extern void tick_nohz_dep_clear(enum tick_dep_bits bit);
209extern void tick_nohz_dep_set_cpu(int cpu, enum tick_dep_bits bit);
210extern void tick_nohz_dep_clear_cpu(int cpu, enum tick_dep_bits bit);
211extern void tick_nohz_dep_set_task(struct task_struct *tsk,
212 enum tick_dep_bits bit);
213extern void tick_nohz_dep_clear_task(struct task_struct *tsk,
214 enum tick_dep_bits bit);
1e4ca26d 215extern void tick_nohz_dep_set_signal(struct task_struct *tsk,
d027d45d
FW
216 enum tick_dep_bits bit);
217extern void tick_nohz_dep_clear_signal(struct signal_struct *signal,
218 enum tick_dep_bits bit);
58d76682 219extern bool tick_nohz_cpu_hotpluggable(unsigned int cpu);
d027d45d
FW
220
221/*
222 * The below are tick_nohz_[set,clear]_dep() wrappers that optimize off-cases
223 * on top of static keys.
224 */
225static inline void tick_dep_set(enum tick_dep_bits bit)
226{
227 if (tick_nohz_full_enabled())
228 tick_nohz_dep_set(bit);
229}
230
231static inline void tick_dep_clear(enum tick_dep_bits bit)
232{
233 if (tick_nohz_full_enabled())
234 tick_nohz_dep_clear(bit);
235}
236
237static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit)
238{
239 if (tick_nohz_full_cpu(cpu))
240 tick_nohz_dep_set_cpu(cpu, bit);
241}
242
243static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit)
244{
245 if (tick_nohz_full_cpu(cpu))
246 tick_nohz_dep_clear_cpu(cpu, bit);
247}
248
249static inline void tick_dep_set_task(struct task_struct *tsk,
250 enum tick_dep_bits bit)
251{
252 if (tick_nohz_full_enabled())
253 tick_nohz_dep_set_task(tsk, bit);
254}
255static inline void tick_dep_clear_task(struct task_struct *tsk,
256 enum tick_dep_bits bit)
257{
258 if (tick_nohz_full_enabled())
259 tick_nohz_dep_clear_task(tsk, bit);
260}
1e4ca26d 261static inline void tick_dep_set_signal(struct task_struct *tsk,
d027d45d
FW
262 enum tick_dep_bits bit)
263{
264 if (tick_nohz_full_enabled())
1e4ca26d 265 tick_nohz_dep_set_signal(tsk, bit);
d027d45d
FW
266}
267static inline void tick_dep_clear_signal(struct signal_struct *signal,
268 enum tick_dep_bits bit)
269{
270 if (tick_nohz_full_enabled())
271 tick_nohz_dep_clear_signal(signal, bit);
272}
273
3d36aebc 274extern void tick_nohz_full_kick_cpu(int cpu);
de734f89 275extern void __tick_nohz_task_switch(void);
6f1982fe 276extern void __init tick_nohz_full_setup(cpumask_var_t cpumask);
a831881b 277#else
460775df
FW
278static inline bool tick_nohz_full_enabled(void) { return false; }
279static inline bool tick_nohz_full_cpu(int cpu) { return false; }
83dedea8 280static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask) { }
d027d45d 281
01b4c399
FW
282static inline void tick_nohz_dep_set_cpu(int cpu, enum tick_dep_bits bit) { }
283static inline void tick_nohz_dep_clear_cpu(int cpu, enum tick_dep_bits bit) { }
58d76682 284static inline bool tick_nohz_cpu_hotpluggable(unsigned int cpu) { return true; }
01b4c399 285
d027d45d
FW
286static inline void tick_dep_set(enum tick_dep_bits bit) { }
287static inline void tick_dep_clear(enum tick_dep_bits bit) { }
288static inline void tick_dep_set_cpu(int cpu, enum tick_dep_bits bit) { }
289static inline void tick_dep_clear_cpu(int cpu, enum tick_dep_bits bit) { }
290static inline void tick_dep_set_task(struct task_struct *tsk,
291 enum tick_dep_bits bit) { }
292static inline void tick_dep_clear_task(struct task_struct *tsk,
293 enum tick_dep_bits bit) { }
1e4ca26d 294static inline void tick_dep_set_signal(struct task_struct *tsk,
d027d45d
FW
295 enum tick_dep_bits bit) { }
296static inline void tick_dep_clear_signal(struct signal_struct *signal,
297 enum tick_dep_bits bit) { }
298
3d36aebc 299static inline void tick_nohz_full_kick_cpu(int cpu) { }
de734f89 300static inline void __tick_nohz_task_switch(void) { }
6f1982fe 301static inline void tick_nohz_full_setup(cpumask_var_t cpumask) { }
a831881b
FW
302#endif
303
de734f89 304static inline void tick_nohz_task_switch(void)
d13508f9
FW
305{
306 if (tick_nohz_full_enabled())
de734f89 307 __tick_nohz_task_switch();
d13508f9
FW
308}
309
f268c373
FW
310static inline void tick_nohz_user_enter_prepare(void)
311{
312 if (tick_nohz_full_cpu(smp_processor_id()))
313 rcu_nocb_flush_deferred_wakeup();
314}
315
906568c9 316#endif