1/*
2 * Tick related global functions
3 */
4#ifndef _LINUX_TICK_H
5#define _LINUX_TICK_H
6
7#include <linux/clockchips.h>
8#include <linux/irqflags.h>
9#include <linux/percpu.h>
10#include <linux/context_tracking_state.h>
11#include <linux/cpumask.h>
12#include <linux/sched.h>
13
14#ifdef CONFIG_GENERIC_CLOCKEVENTS
15extern void __init tick_init(void);
16/* Should be core only, but ARM BL switcher requires it */
17extern void tick_suspend_local(void);
18/* Should be core only, but XEN resume magic and ARM BL switcher require it */
19extern void tick_resume_local(void);
20extern void tick_handover_do_timer(void);
21extern void tick_cleanup_dead_cpu(int cpu);
22#else /* CONFIG_GENERIC_CLOCKEVENTS */
23static inline void tick_init(void) { }
24static inline void tick_suspend_local(void) { }
25static inline void tick_resume_local(void) { }
26static inline void tick_handover_do_timer(void) { }
27static inline void tick_cleanup_dead_cpu(int cpu) { }
28#endif /* !CONFIG_GENERIC_CLOCKEVENTS */
29
30#if defined(CONFIG_GENERIC_CLOCKEVENTS) && defined(CONFIG_SUSPEND)
31extern void tick_freeze(void);
32extern void tick_unfreeze(void);
33#else
34static inline void tick_freeze(void) { }
35static inline void tick_unfreeze(void) { }
36#endif
37
38#ifdef CONFIG_TICK_ONESHOT
39extern void tick_irq_enter(void);
40#  ifndef arch_needs_cpu
41#   define arch_needs_cpu() (0)
42#  endif
43# else
44static inline void tick_irq_enter(void) { }
45#endif
46
47#if defined(CONFIG_GENERIC_CLOCKEVENTS_BROADCAST) && defined(CONFIG_TICK_ONESHOT)
48extern void hotplug_cpu__broadcast_tick_pull(int dead_cpu);
49#else
50static inline void hotplug_cpu__broadcast_tick_pull(int dead_cpu) { }
51#endif
52
53enum tick_broadcast_mode {
54	TICK_BROADCAST_OFF,
55	TICK_BROADCAST_ON,
56	TICK_BROADCAST_FORCE,
57};
58
59enum tick_broadcast_state {
60	TICK_BROADCAST_EXIT,
61	TICK_BROADCAST_ENTER,
62};
63
64#ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
65extern void tick_broadcast_control(enum tick_broadcast_mode mode);
66#else
67static inline void tick_broadcast_control(enum tick_broadcast_mode mode) { }
68#endif /* BROADCAST */
69
70#ifdef CONFIG_GENERIC_CLOCKEVENTS
71extern int tick_broadcast_oneshot_control(enum tick_broadcast_state state);
72#else
73static inline int tick_broadcast_oneshot_control(enum tick_broadcast_state state)
74{
75	return 0;
76}
77#endif
78
79static inline void tick_broadcast_enable(void)
80{
81	tick_broadcast_control(TICK_BROADCAST_ON);
82}
83static inline void tick_broadcast_disable(void)
84{
85	tick_broadcast_control(TICK_BROADCAST_OFF);
86}
87static inline void tick_broadcast_force(void)
88{
89	tick_broadcast_control(TICK_BROADCAST_FORCE);
90}
91static inline int tick_broadcast_enter(void)
92{
93	return tick_broadcast_oneshot_control(TICK_BROADCAST_ENTER);
94}
95static inline void tick_broadcast_exit(void)
96{
97	tick_broadcast_oneshot_control(TICK_BROADCAST_EXIT);
98}
99
100#ifdef CONFIG_NO_HZ_COMMON
101extern int tick_nohz_tick_stopped(void);
102extern void tick_nohz_idle_enter(void);
103extern void tick_nohz_idle_exit(void);
104extern void tick_nohz_irq_exit(void);
105extern ktime_t tick_nohz_get_sleep_length(void);
106extern u64 get_cpu_idle_time_us(int cpu, u64 *last_update_time);
107extern u64 get_cpu_iowait_time_us(int cpu, u64 *last_update_time);
108#else /* !CONFIG_NO_HZ_COMMON */
109static inline int tick_nohz_tick_stopped(void) { return 0; }
110static inline void tick_nohz_idle_enter(void) { }
111static inline void tick_nohz_idle_exit(void) { }
112
113static inline ktime_t tick_nohz_get_sleep_length(void)
114{
115	ktime_t len = { .tv64 = NSEC_PER_SEC/HZ };
116
117	return len;
118}
119static inline u64 get_cpu_idle_time_us(int cpu, u64 *unused) { return -1; }
120static inline u64 get_cpu_iowait_time_us(int cpu, u64 *unused) { return -1; }
121#endif /* !CONFIG_NO_HZ_COMMON */
122
123#ifdef CONFIG_NO_HZ_FULL
124extern bool tick_nohz_full_running;
125extern cpumask_var_t tick_nohz_full_mask;
126extern cpumask_var_t housekeeping_mask;
127
128static inline bool tick_nohz_full_enabled(void)
129{
130	if (!context_tracking_is_enabled())
131		return false;
132
133	return tick_nohz_full_running;
134}
135
136static inline bool tick_nohz_full_cpu(int cpu)
137{
138	if (!tick_nohz_full_enabled())
139		return false;
140
141	return cpumask_test_cpu(cpu, tick_nohz_full_mask);
142}
143
144static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask)
145{
146	if (tick_nohz_full_enabled())
147		cpumask_or(mask, mask, tick_nohz_full_mask);
148}
149
150static inline int housekeeping_any_cpu(void)
151{
152	return cpumask_any_and(housekeeping_mask, cpu_online_mask);
153}
154
155extern void tick_nohz_full_kick(void);
156extern void tick_nohz_full_kick_cpu(int cpu);
157extern void tick_nohz_full_kick_all(void);
158extern void __tick_nohz_task_switch(void);
159#else
160static inline int housekeeping_any_cpu(void)
161{
162	return smp_processor_id();
163}
164static inline bool tick_nohz_full_enabled(void) { return false; }
165static inline bool tick_nohz_full_cpu(int cpu) { return false; }
166static inline void tick_nohz_full_add_cpus_to(struct cpumask *mask) { }
167static inline void tick_nohz_full_kick_cpu(int cpu) { }
168static inline void tick_nohz_full_kick(void) { }
169static inline void tick_nohz_full_kick_all(void) { }
170static inline void __tick_nohz_task_switch(void) { }
171#endif
172
173static inline const struct cpumask *housekeeping_cpumask(void)
174{
175#ifdef CONFIG_NO_HZ_FULL
176	if (tick_nohz_full_enabled())
177		return housekeeping_mask;
178#endif
179	return cpu_possible_mask;
180}
181
182static inline bool is_housekeeping_cpu(int cpu)
183{
184#ifdef CONFIG_NO_HZ_FULL
185	if (tick_nohz_full_enabled())
186		return cpumask_test_cpu(cpu, housekeeping_mask);
187#endif
188	return true;
189}
190
191static inline void housekeeping_affine(struct task_struct *t)
192{
193#ifdef CONFIG_NO_HZ_FULL
194	if (tick_nohz_full_enabled())
195		set_cpus_allowed_ptr(t, housekeeping_mask);
196
197#endif
198}
199
200static inline void tick_nohz_task_switch(void)
201{
202	if (tick_nohz_full_enabled())
203		__tick_nohz_task_switch();
204}
205
206#endif
207