xref: /linux-6.15/include/linux/cpuhotplug.h (revision e00a844a)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __CPUHOTPLUG_H
3 #define __CPUHOTPLUG_H
4 
5 #include <linux/types.h>
6 
7 /*
8  * CPU-up			CPU-down
9  *
10  * BP		AP		BP		AP
11  *
12  * OFFLINE			OFFLINE
13  *   |				  ^
14  *   v				  |
15  * BRINGUP_CPU->AP_OFFLINE	BRINGUP_CPU  <- AP_IDLE_DEAD (idle thread/play_dead)
16  *		  |				AP_OFFLINE
17  *		  v (IRQ-off)	  ,---------------^
18  *		AP_ONLNE	  | (stop_machine)
19  *		  |		TEARDOWN_CPU <-	AP_ONLINE_IDLE
20  *		  |				  ^
21  *		  v				  |
22  *              AP_ACTIVE			AP_ACTIVE
23  */
24 
25 enum cpuhp_state {
26 	CPUHP_INVALID = -1,
27 	CPUHP_OFFLINE = 0,
28 	CPUHP_CREATE_THREADS,
29 	CPUHP_PERF_PREPARE,
30 	CPUHP_PERF_X86_PREPARE,
31 	CPUHP_PERF_X86_AMD_UNCORE_PREP,
32 	CPUHP_PERF_BFIN,
33 	CPUHP_PERF_POWER,
34 	CPUHP_PERF_SUPERH,
35 	CPUHP_X86_HPET_DEAD,
36 	CPUHP_X86_APB_DEAD,
37 	CPUHP_X86_MCE_DEAD,
38 	CPUHP_VIRT_NET_DEAD,
39 	CPUHP_SLUB_DEAD,
40 	CPUHP_MM_WRITEBACK_DEAD,
41 	CPUHP_MM_VMSTAT_DEAD,
42 	CPUHP_SOFTIRQ_DEAD,
43 	CPUHP_NET_MVNETA_DEAD,
44 	CPUHP_CPUIDLE_DEAD,
45 	CPUHP_ARM64_FPSIMD_DEAD,
46 	CPUHP_ARM_OMAP_WAKE_DEAD,
47 	CPUHP_IRQ_POLL_DEAD,
48 	CPUHP_BLOCK_SOFTIRQ_DEAD,
49 	CPUHP_ACPI_CPUDRV_DEAD,
50 	CPUHP_S390_PFAULT_DEAD,
51 	CPUHP_BLK_MQ_DEAD,
52 	CPUHP_FS_BUFF_DEAD,
53 	CPUHP_PRINTK_DEAD,
54 	CPUHP_MM_MEMCQ_DEAD,
55 	CPUHP_PERCPU_CNT_DEAD,
56 	CPUHP_RADIX_DEAD,
57 	CPUHP_PAGE_ALLOC_DEAD,
58 	CPUHP_NET_DEV_DEAD,
59 	CPUHP_PCI_XGENE_DEAD,
60 	CPUHP_IOMMU_INTEL_DEAD,
61 	CPUHP_LUSTRE_CFS_DEAD,
62 	CPUHP_WORKQUEUE_PREP,
63 	CPUHP_POWER_NUMA_PREPARE,
64 	CPUHP_HRTIMERS_PREPARE,
65 	CPUHP_PROFILE_PREPARE,
66 	CPUHP_X2APIC_PREPARE,
67 	CPUHP_SMPCFD_PREPARE,
68 	CPUHP_RELAY_PREPARE,
69 	CPUHP_SLAB_PREPARE,
70 	CPUHP_MD_RAID5_PREPARE,
71 	CPUHP_RCUTREE_PREP,
72 	CPUHP_CPUIDLE_COUPLED_PREPARE,
73 	CPUHP_POWERPC_PMAC_PREPARE,
74 	CPUHP_POWERPC_MMU_CTX_PREPARE,
75 	CPUHP_XEN_PREPARE,
76 	CPUHP_XEN_EVTCHN_PREPARE,
77 	CPUHP_ARM_SHMOBILE_SCU_PREPARE,
78 	CPUHP_SH_SH3X_PREPARE,
79 	CPUHP_NET_FLOW_PREPARE,
80 	CPUHP_TOPOLOGY_PREPARE,
81 	CPUHP_NET_IUCV_PREPARE,
82 	CPUHP_ARM_BL_PREPARE,
83 	CPUHP_TRACE_RB_PREPARE,
84 	CPUHP_MM_ZS_PREPARE,
85 	CPUHP_MM_ZSWP_MEM_PREPARE,
86 	CPUHP_MM_ZSWP_POOL_PREPARE,
87 	CPUHP_KVM_PPC_BOOK3S_PREPARE,
88 	CPUHP_ZCOMP_PREPARE,
89 	CPUHP_TIMERS_DEAD,
90 	CPUHP_MIPS_SOC_PREPARE,
91 	CPUHP_BP_PREPARE_DYN,
92 	CPUHP_BP_PREPARE_DYN_END		= CPUHP_BP_PREPARE_DYN + 20,
93 	CPUHP_BRINGUP_CPU,
94 	CPUHP_AP_IDLE_DEAD,
95 	CPUHP_AP_OFFLINE,
96 	CPUHP_AP_SCHED_STARTING,
97 	CPUHP_AP_RCUTREE_DYING,
98 	CPUHP_AP_IRQ_GIC_STARTING,
99 	CPUHP_AP_IRQ_HIP04_STARTING,
100 	CPUHP_AP_IRQ_ARMADA_XP_STARTING,
101 	CPUHP_AP_IRQ_BCM2836_STARTING,
102 	CPUHP_AP_IRQ_MIPS_GIC_STARTING,
103 	CPUHP_AP_ARM_MVEBU_COHERENCY,
104 	CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING,
105 	CPUHP_AP_PERF_X86_STARTING,
106 	CPUHP_AP_PERF_X86_AMD_IBS_STARTING,
107 	CPUHP_AP_PERF_X86_CQM_STARTING,
108 	CPUHP_AP_PERF_X86_CSTATE_STARTING,
109 	CPUHP_AP_PERF_XTENSA_STARTING,
110 	CPUHP_AP_PERF_METAG_STARTING,
111 	CPUHP_AP_MIPS_OP_LOONGSON3_STARTING,
112 	CPUHP_AP_ARM_VFP_STARTING,
113 	CPUHP_AP_ARM64_DEBUG_MONITORS_STARTING,
114 	CPUHP_AP_PERF_ARM_HW_BREAKPOINT_STARTING,
115 	CPUHP_AP_PERF_ARM_ACPI_STARTING,
116 	CPUHP_AP_PERF_ARM_STARTING,
117 	CPUHP_AP_ARM_L2X0_STARTING,
118 	CPUHP_AP_ARM_ARCH_TIMER_STARTING,
119 	CPUHP_AP_ARM_GLOBAL_TIMER_STARTING,
120 	CPUHP_AP_JCORE_TIMER_STARTING,
121 	CPUHP_AP_EXYNOS4_MCT_TIMER_STARTING,
122 	CPUHP_AP_ARM_TWD_STARTING,
123 	CPUHP_AP_METAG_TIMER_STARTING,
124 	CPUHP_AP_QCOM_TIMER_STARTING,
125 	CPUHP_AP_ARMADA_TIMER_STARTING,
126 	CPUHP_AP_MARCO_TIMER_STARTING,
127 	CPUHP_AP_MIPS_GIC_TIMER_STARTING,
128 	CPUHP_AP_ARC_TIMER_STARTING,
129 	CPUHP_AP_KVM_STARTING,
130 	CPUHP_AP_KVM_ARM_VGIC_INIT_STARTING,
131 	CPUHP_AP_KVM_ARM_VGIC_STARTING,
132 	CPUHP_AP_KVM_ARM_TIMER_STARTING,
133 	/* Must be the last timer callback */
134 	CPUHP_AP_DUMMY_TIMER_STARTING,
135 	CPUHP_AP_ARM_XEN_STARTING,
136 	CPUHP_AP_ARM_CORESIGHT_STARTING,
137 	CPUHP_AP_ARM64_ISNDEP_STARTING,
138 	CPUHP_AP_SMPCFD_DYING,
139 	CPUHP_AP_X86_TBOOT_DYING,
140 	CPUHP_AP_ONLINE,
141 	CPUHP_TEARDOWN_CPU,
142 	CPUHP_AP_ONLINE_IDLE,
143 	CPUHP_AP_SMPBOOT_THREADS,
144 	CPUHP_AP_X86_VDSO_VMA_ONLINE,
145 	CPUHP_AP_IRQ_AFFINITY_ONLINE,
146 	CPUHP_AP_PERF_ONLINE,
147 	CPUHP_AP_PERF_X86_ONLINE,
148 	CPUHP_AP_PERF_X86_UNCORE_ONLINE,
149 	CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
150 	CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
151 	CPUHP_AP_PERF_X86_RAPL_ONLINE,
152 	CPUHP_AP_PERF_X86_CQM_ONLINE,
153 	CPUHP_AP_PERF_X86_CSTATE_ONLINE,
154 	CPUHP_AP_PERF_S390_CF_ONLINE,
155 	CPUHP_AP_PERF_S390_SF_ONLINE,
156 	CPUHP_AP_PERF_ARM_CCI_ONLINE,
157 	CPUHP_AP_PERF_ARM_CCN_ONLINE,
158 	CPUHP_AP_PERF_ARM_HISI_DDRC_ONLINE,
159 	CPUHP_AP_PERF_ARM_HISI_HHA_ONLINE,
160 	CPUHP_AP_PERF_ARM_HISI_L3_ONLINE,
161 	CPUHP_AP_PERF_ARM_L2X0_ONLINE,
162 	CPUHP_AP_PERF_ARM_QCOM_L2_ONLINE,
163 	CPUHP_AP_PERF_ARM_QCOM_L3_ONLINE,
164 	CPUHP_AP_PERF_POWERPC_NEST_IMC_ONLINE,
165 	CPUHP_AP_PERF_POWERPC_CORE_IMC_ONLINE,
166 	CPUHP_AP_PERF_POWERPC_THREAD_IMC_ONLINE,
167 	CPUHP_AP_WORKQUEUE_ONLINE,
168 	CPUHP_AP_RCUTREE_ONLINE,
169 	CPUHP_AP_ONLINE_DYN,
170 	CPUHP_AP_ONLINE_DYN_END		= CPUHP_AP_ONLINE_DYN + 30,
171 	CPUHP_AP_X86_HPET_ONLINE,
172 	CPUHP_AP_X86_KVM_CLK_ONLINE,
173 	CPUHP_AP_ACTIVE,
174 	CPUHP_ONLINE,
175 };
176 
177 int __cpuhp_setup_state(enum cpuhp_state state,	const char *name, bool invoke,
178 			int (*startup)(unsigned int cpu),
179 			int (*teardown)(unsigned int cpu), bool multi_instance);
180 
181 int __cpuhp_setup_state_cpuslocked(enum cpuhp_state state, const char *name,
182 				   bool invoke,
183 				   int (*startup)(unsigned int cpu),
184 				   int (*teardown)(unsigned int cpu),
185 				   bool multi_instance);
186 /**
187  * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
188  * @state:	The state for which the calls are installed
189  * @name:	Name of the callback (will be used in debug output)
190  * @startup:	startup callback function
191  * @teardown:	teardown callback function
192  *
193  * Installs the callback functions and invokes the startup callback on
194  * the present cpus which have already reached the @state.
195  */
196 static inline int cpuhp_setup_state(enum cpuhp_state state,
197 				    const char *name,
198 				    int (*startup)(unsigned int cpu),
199 				    int (*teardown)(unsigned int cpu))
200 {
201 	return __cpuhp_setup_state(state, name, true, startup, teardown, false);
202 }
203 
204 static inline int cpuhp_setup_state_cpuslocked(enum cpuhp_state state,
205 					       const char *name,
206 					       int (*startup)(unsigned int cpu),
207 					       int (*teardown)(unsigned int cpu))
208 {
209 	return __cpuhp_setup_state_cpuslocked(state, name, true, startup,
210 					      teardown, false);
211 }
212 
213 /**
214  * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
215  *			       callbacks
216  * @state:	The state for which the calls are installed
217  * @name:	Name of the callback.
218  * @startup:	startup callback function
219  * @teardown:	teardown callback function
220  *
221  * Same as @cpuhp_setup_state except that no calls are executed are invoked
222  * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
223  */
224 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
225 					    const char *name,
226 					    int (*startup)(unsigned int cpu),
227 					    int (*teardown)(unsigned int cpu))
228 {
229 	return __cpuhp_setup_state(state, name, false, startup, teardown,
230 				   false);
231 }
232 
233 static inline int cpuhp_setup_state_nocalls_cpuslocked(enum cpuhp_state state,
234 						     const char *name,
235 						     int (*startup)(unsigned int cpu),
236 						     int (*teardown)(unsigned int cpu))
237 {
238 	return __cpuhp_setup_state_cpuslocked(state, name, false, startup,
239 					    teardown, false);
240 }
241 
242 /**
243  * cpuhp_setup_state_multi - Add callbacks for multi state
244  * @state:	The state for which the calls are installed
245  * @name:	Name of the callback.
246  * @startup:	startup callback function
247  * @teardown:	teardown callback function
248  *
249  * Sets the internal multi_instance flag and prepares a state to work as a multi
250  * instance callback. No callbacks are invoked at this point. The callbacks are
251  * invoked once an instance for this state are registered via
252  * @cpuhp_state_add_instance or @cpuhp_state_add_instance_nocalls.
253  */
254 static inline int cpuhp_setup_state_multi(enum cpuhp_state state,
255 					  const char *name,
256 					  int (*startup)(unsigned int cpu,
257 							 struct hlist_node *node),
258 					  int (*teardown)(unsigned int cpu,
259 							  struct hlist_node *node))
260 {
261 	return __cpuhp_setup_state(state, name, false,
262 				   (void *) startup,
263 				   (void *) teardown, true);
264 }
265 
266 int __cpuhp_state_add_instance(enum cpuhp_state state, struct hlist_node *node,
267 			       bool invoke);
268 int __cpuhp_state_add_instance_cpuslocked(enum cpuhp_state state,
269 					  struct hlist_node *node, bool invoke);
270 
271 /**
272  * cpuhp_state_add_instance - Add an instance for a state and invoke startup
273  *                            callback.
274  * @state:	The state for which the instance is installed
275  * @node:	The node for this individual state.
276  *
277  * Installs the instance for the @state and invokes the startup callback on
278  * the present cpus which have already reached the @state. The @state must have
279  * been earlier marked as multi-instance by @cpuhp_setup_state_multi.
280  */
281 static inline int cpuhp_state_add_instance(enum cpuhp_state state,
282 					   struct hlist_node *node)
283 {
284 	return __cpuhp_state_add_instance(state, node, true);
285 }
286 
287 /**
288  * cpuhp_state_add_instance_nocalls - Add an instance for a state without
289  *                                    invoking the startup callback.
290  * @state:	The state for which the instance is installed
291  * @node:	The node for this individual state.
292  *
293  * Installs the instance for the @state The @state must have been earlier
294  * marked as multi-instance by @cpuhp_setup_state_multi.
295  */
296 static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state,
297 						   struct hlist_node *node)
298 {
299 	return __cpuhp_state_add_instance(state, node, false);
300 }
301 
302 static inline int
303 cpuhp_state_add_instance_nocalls_cpuslocked(enum cpuhp_state state,
304 					    struct hlist_node *node)
305 {
306 	return __cpuhp_state_add_instance_cpuslocked(state, node, false);
307 }
308 
309 void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
310 void __cpuhp_remove_state_cpuslocked(enum cpuhp_state state, bool invoke);
311 
312 /**
313  * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
314  * @state:	The state for which the calls are removed
315  *
316  * Removes the callback functions and invokes the teardown callback on
317  * the present cpus which have already reached the @state.
318  */
319 static inline void cpuhp_remove_state(enum cpuhp_state state)
320 {
321 	__cpuhp_remove_state(state, true);
322 }
323 
324 /**
325  * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
326  *				teardown
327  * @state:	The state for which the calls are removed
328  */
329 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
330 {
331 	__cpuhp_remove_state(state, false);
332 }
333 
334 static inline void cpuhp_remove_state_nocalls_cpuslocked(enum cpuhp_state state)
335 {
336 	__cpuhp_remove_state_cpuslocked(state, false);
337 }
338 
339 /**
340  * cpuhp_remove_multi_state - Remove hotplug multi state callback
341  * @state:	The state for which the calls are removed
342  *
343  * Removes the callback functions from a multi state. This is the reverse of
344  * cpuhp_setup_state_multi(). All instances should have been removed before
345  * invoking this function.
346  */
347 static inline void cpuhp_remove_multi_state(enum cpuhp_state state)
348 {
349 	__cpuhp_remove_state(state, false);
350 }
351 
352 int __cpuhp_state_remove_instance(enum cpuhp_state state,
353 				  struct hlist_node *node, bool invoke);
354 
355 /**
356  * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
357  *                               the teardown callback
358  * @state:	The state from which the instance is removed
359  * @node:	The node for this individual state.
360  *
361  * Removes the instance and invokes the teardown callback on the present cpus
362  * which have already reached the @state.
363  */
364 static inline int cpuhp_state_remove_instance(enum cpuhp_state state,
365 					      struct hlist_node *node)
366 {
367 	return __cpuhp_state_remove_instance(state, node, true);
368 }
369 
370 /**
371  * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
372  *					 without invoking the reatdown callback
373  * @state:	The state from which the instance is removed
374  * @node:	The node for this individual state.
375  *
376  * Removes the instance without invoking the teardown callback.
377  */
378 static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state,
379 						      struct hlist_node *node)
380 {
381 	return __cpuhp_state_remove_instance(state, node, false);
382 }
383 
384 #ifdef CONFIG_SMP
385 void cpuhp_online_idle(enum cpuhp_state state);
386 #else
387 static inline void cpuhp_online_idle(enum cpuhp_state state) { }
388 #endif
389 
390 #endif
391