xref: /linux-6.15/include/linux/topology.h (revision a1e58bbd)
1 /*
2  * include/linux/topology.h
3  *
4  * Written by: Matthew Dobson, IBM Corporation
5  *
6  * Copyright (C) 2002, IBM Corp.
7  *
8  * All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
18  * NON INFRINGEMENT.  See the GNU General Public License for more
19  * details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  *
25  * Send feedback to <[email protected]>
26  */
27 #ifndef _LINUX_TOPOLOGY_H
28 #define _LINUX_TOPOLOGY_H
29 
30 #include <linux/cpumask.h>
31 #include <linux/bitops.h>
32 #include <linux/mmzone.h>
33 #include <linux/smp.h>
34 #include <asm/topology.h>
35 
36 #ifndef node_has_online_mem
37 #define node_has_online_mem(nid) (1)
38 #endif
39 
40 #ifndef nr_cpus_node
41 #define nr_cpus_node(node)							\
42 	({									\
43 		cpumask_t __tmp__;						\
44 		__tmp__ = node_to_cpumask(node);				\
45 		cpus_weight(__tmp__);						\
46 	})
47 #endif
48 
49 #define for_each_node_with_cpus(node)						\
50 	for_each_online_node(node)						\
51 		if (nr_cpus_node(node))
52 
53 void arch_update_cpu_topology(void);
54 
55 /* Conform to ACPI 2.0 SLIT distance definitions */
56 #define LOCAL_DISTANCE		10
57 #define REMOTE_DISTANCE		20
58 #ifndef node_distance
59 #define node_distance(from,to)	((from) == (to) ? LOCAL_DISTANCE : REMOTE_DISTANCE)
60 #endif
61 #ifndef RECLAIM_DISTANCE
62 /*
63  * If the distance between nodes in a system is larger than RECLAIM_DISTANCE
64  * (in whatever arch specific measurement units returned by node_distance())
65  * then switch on zone reclaim on boot.
66  */
67 #define RECLAIM_DISTANCE 20
68 #endif
69 #ifndef PENALTY_FOR_NODE_WITH_CPUS
70 #define PENALTY_FOR_NODE_WITH_CPUS	(1)
71 #endif
72 
73 /*
74  * Below are the 3 major initializers used in building sched_domains:
75  * SD_SIBLING_INIT, for SMT domains
76  * SD_CPU_INIT, for SMP domains
77  * SD_NODE_INIT, for NUMA domains
78  *
79  * Any architecture that cares to do any tuning to these values should do so
80  * by defining their own arch-specific initializer in include/asm/topology.h.
81  * A definition there will automagically override these default initializers
82  * and allow arch-specific performance tuning of sched_domains.
83  */
84 #ifdef CONFIG_SCHED_SMT
85 /* MCD - Do we really need this?  It is always on if CONFIG_SCHED_SMT is,
86  * so can't we drop this in favor of CONFIG_SCHED_SMT?
87  */
88 #define ARCH_HAS_SCHED_WAKE_IDLE
89 /* Common values for SMT siblings */
90 #ifndef SD_SIBLING_INIT
91 #define SD_SIBLING_INIT (struct sched_domain) {		\
92 	.span			= CPU_MASK_NONE,	\
93 	.parent			= NULL,			\
94 	.child			= NULL,			\
95 	.groups			= NULL,			\
96 	.min_interval		= 1,			\
97 	.max_interval		= 2,			\
98 	.busy_factor		= 64,			\
99 	.imbalance_pct		= 110,			\
100 	.cache_nice_tries	= 0,			\
101 	.busy_idx		= 0,			\
102 	.idle_idx		= 0,			\
103 	.newidle_idx		= 0,			\
104 	.wake_idx		= 0,			\
105 	.forkexec_idx		= 0,			\
106 	.flags			= SD_LOAD_BALANCE	\
107 				| SD_BALANCE_NEWIDLE	\
108 				| SD_BALANCE_FORK	\
109 				| SD_BALANCE_EXEC	\
110 				| SD_WAKE_AFFINE	\
111 				| SD_WAKE_IDLE		\
112 				| SD_SHARE_CPUPOWER,	\
113 	.last_balance		= jiffies,		\
114 	.balance_interval	= 1,			\
115 	.nr_balance_failed	= 0,			\
116 }
117 #endif
118 #endif /* CONFIG_SCHED_SMT */
119 
120 #ifdef CONFIG_SCHED_MC
121 /* Common values for MC siblings. for now mostly derived from SD_CPU_INIT */
122 #ifndef SD_MC_INIT
123 #define SD_MC_INIT (struct sched_domain) {		\
124 	.span			= CPU_MASK_NONE,	\
125 	.parent			= NULL,			\
126 	.child			= NULL,			\
127 	.groups			= NULL,			\
128 	.min_interval		= 1,			\
129 	.max_interval		= 4,			\
130 	.busy_factor		= 64,			\
131 	.imbalance_pct		= 125,			\
132 	.cache_nice_tries	= 1,			\
133 	.busy_idx		= 2,			\
134 	.idle_idx		= 0,			\
135 	.newidle_idx		= 0,			\
136 	.wake_idx		= 1,			\
137 	.forkexec_idx		= 1,			\
138 	.flags			= SD_LOAD_BALANCE	\
139 				| SD_BALANCE_NEWIDLE	\
140 				| SD_BALANCE_FORK	\
141 				| SD_BALANCE_EXEC	\
142 				| SD_WAKE_AFFINE	\
143 				| SD_SHARE_PKG_RESOURCES\
144 				| BALANCE_FOR_MC_POWER,	\
145 	.last_balance		= jiffies,		\
146 	.balance_interval	= 1,			\
147 	.nr_balance_failed	= 0,			\
148 }
149 #endif
150 #endif /* CONFIG_SCHED_MC */
151 
152 /* Common values for CPUs */
153 #ifndef SD_CPU_INIT
154 #define SD_CPU_INIT (struct sched_domain) {		\
155 	.span			= CPU_MASK_NONE,	\
156 	.parent			= NULL,			\
157 	.child			= NULL,			\
158 	.groups			= NULL,			\
159 	.min_interval		= 1,			\
160 	.max_interval		= 4,			\
161 	.busy_factor		= 64,			\
162 	.imbalance_pct		= 125,			\
163 	.cache_nice_tries	= 1,			\
164 	.busy_idx		= 2,			\
165 	.idle_idx		= 1,			\
166 	.newidle_idx		= 2,			\
167 	.wake_idx		= 1,			\
168 	.forkexec_idx		= 1,			\
169 	.flags			= SD_LOAD_BALANCE	\
170 				| SD_BALANCE_NEWIDLE	\
171 				| SD_BALANCE_FORK	\
172 				| SD_BALANCE_EXEC	\
173 				| SD_WAKE_AFFINE	\
174 				| BALANCE_FOR_PKG_POWER,\
175 	.last_balance		= jiffies,		\
176 	.balance_interval	= 1,			\
177 	.nr_balance_failed	= 0,			\
178 }
179 #endif
180 
181 /* sched_domains SD_ALLNODES_INIT for NUMA machines */
182 #define SD_ALLNODES_INIT (struct sched_domain) {	\
183 	.span			= CPU_MASK_NONE,	\
184 	.parent			= NULL,			\
185 	.child			= NULL,			\
186 	.groups			= NULL,			\
187 	.min_interval		= 64,			\
188 	.max_interval		= 64*num_online_cpus(),	\
189 	.busy_factor		= 128,			\
190 	.imbalance_pct		= 133,			\
191 	.cache_nice_tries	= 1,			\
192 	.busy_idx		= 3,			\
193 	.idle_idx		= 3,			\
194 	.newidle_idx		= 0, /* unused */	\
195 	.wake_idx		= 0, /* unused */	\
196 	.forkexec_idx		= 0, /* unused */	\
197 	.flags			= SD_LOAD_BALANCE	\
198 				| SD_SERIALIZE,	\
199 	.last_balance		= jiffies,		\
200 	.balance_interval	= 64,			\
201 	.nr_balance_failed	= 0,			\
202 }
203 
204 #ifdef CONFIG_NUMA
205 #ifndef SD_NODE_INIT
206 #error Please define an appropriate SD_NODE_INIT in include/asm/topology.h!!!
207 #endif
208 #endif /* CONFIG_NUMA */
209 
210 #endif /* _LINUX_TOPOLOGY_H */
211