1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_SCHED_TOPOLOGY_H
3 #define _LINUX_SCHED_TOPOLOGY_H
4 
5 #include <linux/topology.h>
6 
7 #include <linux/sched/idle.h>
8 
9 /*
10  * sched-domains (multiprocessor balancing) declarations:
11  */
12 #ifdef CONFIG_SMP
13 
14 /* Generate SD flag indexes */
15 #define SD_FLAG(name, mflags) __##name,
16 enum {
17 	#include <linux/sched/sd_flags.h>
18 	__SD_FLAG_CNT,
19 };
20 #undef SD_FLAG
21 /* Generate SD flag bits */
22 #define SD_FLAG(name, mflags) name = 1 << __##name,
23 enum {
24 	#include <linux/sched/sd_flags.h>
25 };
26 #undef SD_FLAG
27 
28 struct sd_flag_debug {
29 	unsigned int meta_flags;
30 	char *name;
31 };
32 extern const struct sd_flag_debug sd_flag_debug[];
33 
34 #ifdef CONFIG_SCHED_SMT
cpu_smt_flags(void)35 static inline int cpu_smt_flags(void)
36 {
37 	return SD_SHARE_CPUCAPACITY | SD_SHARE_LLC;
38 }
39 #endif
40 
41 #ifdef CONFIG_SCHED_CLUSTER
cpu_cluster_flags(void)42 static inline int cpu_cluster_flags(void)
43 {
44 	return SD_CLUSTER | SD_SHARE_LLC;
45 }
46 #endif
47 
48 #ifdef CONFIG_SCHED_MC
cpu_core_flags(void)49 static inline int cpu_core_flags(void)
50 {
51 	return SD_SHARE_LLC;
52 }
53 #endif
54 
55 #ifdef CONFIG_NUMA
cpu_numa_flags(void)56 static inline int cpu_numa_flags(void)
57 {
58 	return SD_NUMA;
59 }
60 #endif
61 
62 extern int arch_asym_cpu_priority(int cpu);
63 
64 struct sched_domain_attr {
65 	int relax_domain_level;
66 };
67 
68 #define SD_ATTR_INIT	(struct sched_domain_attr) {	\
69 	.relax_domain_level = -1,			\
70 }
71 
72 extern int sched_domain_level_max;
73 
74 struct sched_group;
75 
76 struct sched_domain_shared {
77 	atomic_t	ref;
78 	atomic_t	nr_busy_cpus;
79 	int		has_idle_cores;
80 	int		nr_idle_scan;
81 };
82 
83 struct sched_domain {
84 	/* These fields must be setup */
85 	struct sched_domain __rcu *parent;	/* top domain must be null terminated */
86 	struct sched_domain __rcu *child;	/* bottom domain must be null terminated */
87 	struct sched_group *groups;	/* the balancing groups of the domain */
88 	unsigned long min_interval;	/* Minimum balance interval ms */
89 	unsigned long max_interval;	/* Maximum balance interval ms */
90 	unsigned int busy_factor;	/* less balancing by factor if busy */
91 	unsigned int imbalance_pct;	/* No balance until over watermark */
92 	unsigned int cache_nice_tries;	/* Leave cache hot tasks for # tries */
93 	unsigned int imb_numa_nr;	/* Nr running tasks that allows a NUMA imbalance */
94 
95 	int nohz_idle;			/* NOHZ IDLE status */
96 	int flags;			/* See SD_* */
97 	int level;
98 
99 	/* Runtime fields. */
100 	unsigned long last_balance;	/* init to jiffies. units in jiffies */
101 	unsigned int balance_interval;	/* initialise to 1. units in ms. */
102 	unsigned int nr_balance_failed; /* initialise to 0 */
103 
104 	/* idle_balance() stats */
105 	u64 max_newidle_lb_cost;
106 	unsigned long last_decay_max_lb_cost;
107 
108 #ifdef CONFIG_SCHEDSTATS
109 	/* sched_balance_rq() stats */
110 	unsigned int lb_count[CPU_MAX_IDLE_TYPES];
111 	unsigned int lb_failed[CPU_MAX_IDLE_TYPES];
112 	unsigned int lb_balanced[CPU_MAX_IDLE_TYPES];
113 	unsigned int lb_imbalance_load[CPU_MAX_IDLE_TYPES];
114 	unsigned int lb_imbalance_util[CPU_MAX_IDLE_TYPES];
115 	unsigned int lb_imbalance_task[CPU_MAX_IDLE_TYPES];
116 	unsigned int lb_imbalance_misfit[CPU_MAX_IDLE_TYPES];
117 	unsigned int lb_gained[CPU_MAX_IDLE_TYPES];
118 	unsigned int lb_hot_gained[CPU_MAX_IDLE_TYPES];
119 	unsigned int lb_nobusyg[CPU_MAX_IDLE_TYPES];
120 	unsigned int lb_nobusyq[CPU_MAX_IDLE_TYPES];
121 
122 	/* Active load balancing */
123 	unsigned int alb_count;
124 	unsigned int alb_failed;
125 	unsigned int alb_pushed;
126 
127 	/* SD_BALANCE_EXEC stats */
128 	unsigned int sbe_count;
129 	unsigned int sbe_balanced;
130 	unsigned int sbe_pushed;
131 
132 	/* SD_BALANCE_FORK stats */
133 	unsigned int sbf_count;
134 	unsigned int sbf_balanced;
135 	unsigned int sbf_pushed;
136 
137 	/* try_to_wake_up() stats */
138 	unsigned int ttwu_wake_remote;
139 	unsigned int ttwu_move_affine;
140 	unsigned int ttwu_move_balance;
141 #endif
142 	char *name;
143 	union {
144 		void *private;		/* used during construction */
145 		struct rcu_head rcu;	/* used during destruction */
146 	};
147 	struct sched_domain_shared *shared;
148 
149 	unsigned int span_weight;
150 	/*
151 	 * Span of all CPUs in this domain.
152 	 *
153 	 * NOTE: this field is variable length. (Allocated dynamically
154 	 * by attaching extra space to the end of the structure,
155 	 * depending on how many CPUs the kernel has booted up with)
156 	 */
157 	unsigned long span[];
158 };
159 
sched_domain_span(struct sched_domain * sd)160 static inline struct cpumask *sched_domain_span(struct sched_domain *sd)
161 {
162 	return to_cpumask(sd->span);
163 }
164 
165 extern void partition_sched_domains(int ndoms_new, cpumask_var_t doms_new[],
166 				    struct sched_domain_attr *dattr_new);
167 
168 /* Allocate an array of sched domains, for partition_sched_domains(). */
169 cpumask_var_t *alloc_sched_domains(unsigned int ndoms);
170 void free_sched_domains(cpumask_var_t doms[], unsigned int ndoms);
171 
172 bool cpus_equal_capacity(int this_cpu, int that_cpu);
173 bool cpus_share_cache(int this_cpu, int that_cpu);
174 bool cpus_share_resources(int this_cpu, int that_cpu);
175 
176 typedef const struct cpumask *(*sched_domain_mask_f)(int cpu);
177 typedef int (*sched_domain_flags_f)(void);
178 
179 #define SDTL_OVERLAP	0x01
180 
181 struct sd_data {
182 	struct sched_domain *__percpu *sd;
183 	struct sched_domain_shared *__percpu *sds;
184 	struct sched_group *__percpu *sg;
185 	struct sched_group_capacity *__percpu *sgc;
186 };
187 
188 struct sched_domain_topology_level {
189 	sched_domain_mask_f mask;
190 	sched_domain_flags_f sd_flags;
191 	int		    flags;
192 	int		    numa_level;
193 	struct sd_data      data;
194 	char                *name;
195 };
196 
197 extern void __init set_sched_topology(struct sched_domain_topology_level *tl);
198 
199 # define SD_INIT_NAME(type)		.name = #type
200 
201 #else /* CONFIG_SMP */
202 
203 struct sched_domain_attr;
204 
205 static inline void
partition_sched_domains(int ndoms_new,cpumask_var_t doms_new[],struct sched_domain_attr * dattr_new)206 partition_sched_domains(int ndoms_new, cpumask_var_t doms_new[],
207 			struct sched_domain_attr *dattr_new)
208 {
209 }
210 
cpus_equal_capacity(int this_cpu,int that_cpu)211 static inline bool cpus_equal_capacity(int this_cpu, int that_cpu)
212 {
213 	return true;
214 }
215 
cpus_share_cache(int this_cpu,int that_cpu)216 static inline bool cpus_share_cache(int this_cpu, int that_cpu)
217 {
218 	return true;
219 }
220 
cpus_share_resources(int this_cpu,int that_cpu)221 static inline bool cpus_share_resources(int this_cpu, int that_cpu)
222 {
223 	return true;
224 }
225 
226 #endif	/* !CONFIG_SMP */
227 
228 #if defined(CONFIG_ENERGY_MODEL) && defined(CONFIG_CPU_FREQ_GOV_SCHEDUTIL)
229 extern void rebuild_sched_domains_energy(void);
230 #else
rebuild_sched_domains_energy(void)231 static inline void rebuild_sched_domains_energy(void)
232 {
233 }
234 #endif
235 
236 #ifndef arch_scale_cpu_capacity
237 /**
238  * arch_scale_cpu_capacity - get the capacity scale factor of a given CPU.
239  * @cpu: the CPU in question.
240  *
241  * Return: the CPU scale factor normalized against SCHED_CAPACITY_SCALE, i.e.
242  *
243  *             max_perf(cpu)
244  *      ----------------------------- * SCHED_CAPACITY_SCALE
245  *      max(max_perf(c) : c \in CPUs)
246  */
247 static __always_inline
arch_scale_cpu_capacity(int cpu)248 unsigned long arch_scale_cpu_capacity(int cpu)
249 {
250 	return SCHED_CAPACITY_SCALE;
251 }
252 #endif
253 
254 #ifndef arch_scale_hw_pressure
255 static __always_inline
arch_scale_hw_pressure(int cpu)256 unsigned long arch_scale_hw_pressure(int cpu)
257 {
258 	return 0;
259 }
260 #endif
261 
262 #ifndef arch_update_hw_pressure
263 static __always_inline
arch_update_hw_pressure(const struct cpumask * cpus,unsigned long capped_frequency)264 void arch_update_hw_pressure(const struct cpumask *cpus,
265 				  unsigned long capped_frequency)
266 { }
267 #endif
268 
269 #ifndef arch_scale_freq_ref
270 static __always_inline
arch_scale_freq_ref(int cpu)271 unsigned int arch_scale_freq_ref(int cpu)
272 {
273 	return 0;
274 }
275 #endif
276 
task_node(const struct task_struct * p)277 static inline int task_node(const struct task_struct *p)
278 {
279 	return cpu_to_node(task_cpu(p));
280 }
281 
282 #endif /* _LINUX_SCHED_TOPOLOGY_H */
283