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