1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/types.h>
15 * BRINGUP_CPU->AP_OFFLINE BRINGUP_CPU <- AP_IDLE_DEAD (idle thread/play_dead)
17 * v (IRQ-off) ,---------------^
18 * AP_ONLNE | (stop_machine)
19 * | TEARDOWN_CPU <- AP_ONLINE_IDLE
26 * CPU hotplug states. The state machine invokes the installed state
27 * startup callbacks sequentially from CPUHP_OFFLINE + 1 to CPUHP_ONLINE
28 * during a CPU online operation. During a CPU offline operation the
29 * installed teardown callbacks are invoked in the reverse order from
30 * CPU_ONLINE - 1 down to CPUHP_OFFLINE.
32 * The state space has three sections: PREPARE, STARTING and ONLINE.
34 * PREPARE: The callbacks are invoked on a control CPU before the
35 * hotplugged CPU is started up or after the hotplugged CPU has died.
37 * STARTING: The callbacks are invoked on the hotplugged CPU from the low level
38 * hotplug startup/teardown code with interrupts disabled.
40 * ONLINE: The callbacks are invoked on the hotplugged CPU from the per CPU
41 * hotplug thread with interrupts and preemption enabled.
43 * Adding explicit states to this enum is only necessary when:
45 * 1) The state is within the STARTING section
47 * 2) The state has ordering constraints vs. other states in the
50 * If neither #1 nor #2 apply, please use the dynamic state space when
51 * setting up a state by using CPUHP_BP_PREPARE_DYN or CPUHP_AP_ONLINE_DYN
52 * for the @state argument of the setup function.
54 * See Documentation/core-api/cpu_hotplug.rst for further information and
60 /* PREPARE section invoked on a control CPU */
64 CPUHP_PERF_X86_PREPARE
,
65 CPUHP_PERF_X86_AMD_UNCORE_PREP
,
75 CPUHP_MM_WRITEBACK_DEAD
,
76 /* Must be after CPUHP_MM_VMSTAT_DEAD */
77 CPUHP_MM_DEMOTION_DEAD
,
80 CPUHP_NET_MVNETA_DEAD
,
82 CPUHP_ARM64_FPSIMD_DEAD
,
83 CPUHP_ARM_OMAP_WAKE_DEAD
,
85 CPUHP_BLOCK_SOFTIRQ_DEAD
,
87 CPUHP_ACPI_CPUDRV_DEAD
,
88 CPUHP_S390_PFAULT_DEAD
,
93 CPUHP_PERCPU_CNT_DEAD
,
98 CPUHP_IOMMU_IOVA_DEAD
,
99 CPUHP_LUSTRE_CFS_DEAD
,
100 CPUHP_AP_ARM_CACHE_B15_RAC_DEAD
,
102 CPUHP_AP_DTPM_CPU_DEAD
,
103 CPUHP_RANDOM_PREPARE
,
104 CPUHP_WORKQUEUE_PREP
,
105 CPUHP_POWER_NUMA_PREPARE
,
106 CPUHP_HRTIMERS_PREPARE
,
107 CPUHP_PROFILE_PREPARE
,
108 CPUHP_X2APIC_PREPARE
,
109 CPUHP_SMPCFD_PREPARE
,
112 CPUHP_MD_RAID5_PREPARE
,
114 CPUHP_CPUIDLE_COUPLED_PREPARE
,
115 CPUHP_POWERPC_PMAC_PREPARE
,
116 CPUHP_POWERPC_MMU_CTX_PREPARE
,
118 CPUHP_XEN_EVTCHN_PREPARE
,
119 CPUHP_ARM_SHMOBILE_SCU_PREPARE
,
120 CPUHP_SH_SH3X_PREPARE
,
121 CPUHP_NET_FLOW_PREPARE
,
122 CPUHP_TOPOLOGY_PREPARE
,
123 CPUHP_NET_IUCV_PREPARE
,
124 CPUHP_ARM_BL_PREPARE
,
125 CPUHP_TRACE_RB_PREPARE
,
127 CPUHP_MM_ZSWP_MEM_PREPARE
,
128 CPUHP_MM_ZSWP_POOL_PREPARE
,
129 CPUHP_KVM_PPC_BOOK3S_PREPARE
,
131 CPUHP_TIMERS_PREPARE
,
132 CPUHP_MIPS_SOC_PREPARE
,
133 CPUHP_BP_PREPARE_DYN
,
134 CPUHP_BP_PREPARE_DYN_END
= CPUHP_BP_PREPARE_DYN
+ 20,
139 * STARTING section invoked on the hotplugged CPU in low level
140 * bringup and teardown code.
144 CPUHP_AP_CACHECTRL_STARTING
,
145 CPUHP_AP_SCHED_STARTING
,
146 CPUHP_AP_RCUTREE_DYING
,
147 CPUHP_AP_CPU_PM_STARTING
,
148 CPUHP_AP_IRQ_GIC_STARTING
,
149 CPUHP_AP_IRQ_HIP04_STARTING
,
150 CPUHP_AP_IRQ_APPLE_AIC_STARTING
,
151 CPUHP_AP_IRQ_ARMADA_XP_STARTING
,
152 CPUHP_AP_IRQ_BCM2836_STARTING
,
153 CPUHP_AP_IRQ_MIPS_GIC_STARTING
,
154 CPUHP_AP_IRQ_RISCV_STARTING
,
155 CPUHP_AP_IRQ_LOONGARCH_STARTING
,
156 CPUHP_AP_IRQ_SIFIVE_PLIC_STARTING
,
157 CPUHP_AP_ARM_MVEBU_COHERENCY
,
158 CPUHP_AP_MICROCODE_LOADER
,
159 CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING
,
160 CPUHP_AP_PERF_X86_STARTING
,
161 CPUHP_AP_PERF_X86_AMD_IBS_STARTING
,
162 CPUHP_AP_PERF_X86_CQM_STARTING
,
163 CPUHP_AP_PERF_X86_CSTATE_STARTING
,
164 CPUHP_AP_PERF_XTENSA_STARTING
,
165 CPUHP_AP_MIPS_OP_LOONGSON3_STARTING
,
166 CPUHP_AP_ARM_VFP_STARTING
,
167 CPUHP_AP_ARM64_DEBUG_MONITORS_STARTING
,
168 CPUHP_AP_PERF_ARM_HW_BREAKPOINT_STARTING
,
169 CPUHP_AP_PERF_ARM_ACPI_STARTING
,
170 CPUHP_AP_PERF_ARM_STARTING
,
171 CPUHP_AP_PERF_RISCV_STARTING
,
172 CPUHP_AP_ARM_L2X0_STARTING
,
173 CPUHP_AP_EXYNOS4_MCT_TIMER_STARTING
,
174 CPUHP_AP_ARM_ARCH_TIMER_STARTING
,
175 CPUHP_AP_ARM_ARCH_TIMER_EVTSTRM_STARTING
,
176 CPUHP_AP_ARM_GLOBAL_TIMER_STARTING
,
177 CPUHP_AP_JCORE_TIMER_STARTING
,
178 CPUHP_AP_ARM_TWD_STARTING
,
179 CPUHP_AP_QCOM_TIMER_STARTING
,
180 CPUHP_AP_TEGRA_TIMER_STARTING
,
181 CPUHP_AP_ARMADA_TIMER_STARTING
,
182 CPUHP_AP_MARCO_TIMER_STARTING
,
183 CPUHP_AP_MIPS_GIC_TIMER_STARTING
,
184 CPUHP_AP_ARC_TIMER_STARTING
,
185 CPUHP_AP_RISCV_TIMER_STARTING
,
186 CPUHP_AP_CLINT_TIMER_STARTING
,
187 CPUHP_AP_CSKY_TIMER_STARTING
,
188 CPUHP_AP_TI_GP_TIMER_STARTING
,
189 CPUHP_AP_HYPERV_TIMER_STARTING
,
190 /* Must be the last timer callback */
191 CPUHP_AP_DUMMY_TIMER_STARTING
,
192 CPUHP_AP_ARM_XEN_STARTING
,
193 CPUHP_AP_ARM_XEN_RUNSTATE_STARTING
,
194 CPUHP_AP_ARM_CORESIGHT_STARTING
,
195 CPUHP_AP_ARM_CORESIGHT_CTI_STARTING
,
196 CPUHP_AP_ARM64_ISNDEP_STARTING
,
197 CPUHP_AP_SMPCFD_DYING
,
198 CPUHP_AP_HRTIMERS_DYING
,
199 CPUHP_AP_X86_TBOOT_DYING
,
200 CPUHP_AP_ARM_CACHE_B15_RAC_DYING
,
204 /* Online section invoked on the hotplugged CPU from the hotplug thread */
205 CPUHP_AP_ONLINE_IDLE
,
206 CPUHP_AP_HYPERV_ONLINE
,
208 CPUHP_AP_SCHED_WAIT_EMPTY
,
209 CPUHP_AP_SMPBOOT_THREADS
,
210 CPUHP_AP_IRQ_AFFINITY_ONLINE
,
211 CPUHP_AP_BLK_MQ_ONLINE
,
212 CPUHP_AP_ARM_MVEBU_SYNC_CLOCKS
,
213 CPUHP_AP_X86_INTEL_EPB_ONLINE
,
214 CPUHP_AP_PERF_ONLINE
,
215 CPUHP_AP_PERF_X86_ONLINE
,
216 CPUHP_AP_PERF_X86_UNCORE_ONLINE
,
217 CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE
,
218 CPUHP_AP_PERF_X86_AMD_POWER_ONLINE
,
219 CPUHP_AP_PERF_X86_RAPL_ONLINE
,
220 CPUHP_AP_PERF_X86_CQM_ONLINE
,
221 CPUHP_AP_PERF_X86_CSTATE_ONLINE
,
222 CPUHP_AP_PERF_X86_IDXD_ONLINE
,
223 CPUHP_AP_PERF_S390_CF_ONLINE
,
224 CPUHP_AP_PERF_S390_SF_ONLINE
,
225 CPUHP_AP_PERF_ARM_CCI_ONLINE
,
226 CPUHP_AP_PERF_ARM_CCN_ONLINE
,
227 CPUHP_AP_PERF_ARM_HISI_CPA_ONLINE
,
228 CPUHP_AP_PERF_ARM_HISI_DDRC_ONLINE
,
229 CPUHP_AP_PERF_ARM_HISI_HHA_ONLINE
,
230 CPUHP_AP_PERF_ARM_HISI_L3_ONLINE
,
231 CPUHP_AP_PERF_ARM_HISI_PA_ONLINE
,
232 CPUHP_AP_PERF_ARM_HISI_SLLC_ONLINE
,
233 CPUHP_AP_PERF_ARM_HISI_PCIE_PMU_ONLINE
,
234 CPUHP_AP_PERF_ARM_HNS3_PMU_ONLINE
,
235 CPUHP_AP_PERF_ARM_L2X0_ONLINE
,
236 CPUHP_AP_PERF_ARM_QCOM_L2_ONLINE
,
237 CPUHP_AP_PERF_ARM_QCOM_L3_ONLINE
,
238 CPUHP_AP_PERF_ARM_APM_XGENE_ONLINE
,
239 CPUHP_AP_PERF_ARM_CAVIUM_TX2_UNCORE_ONLINE
,
240 CPUHP_AP_PERF_ARM_MARVELL_CN10K_DDR_ONLINE
,
241 CPUHP_AP_PERF_POWERPC_NEST_IMC_ONLINE
,
242 CPUHP_AP_PERF_POWERPC_CORE_IMC_ONLINE
,
243 CPUHP_AP_PERF_POWERPC_THREAD_IMC_ONLINE
,
244 CPUHP_AP_PERF_POWERPC_TRACE_IMC_ONLINE
,
245 CPUHP_AP_PERF_POWERPC_HV_24x7_ONLINE
,
246 CPUHP_AP_PERF_POWERPC_HV_GPCI_ONLINE
,
247 CPUHP_AP_PERF_CSKY_ONLINE
,
248 CPUHP_AP_WATCHDOG_ONLINE
,
249 CPUHP_AP_WORKQUEUE_ONLINE
,
250 CPUHP_AP_RANDOM_ONLINE
,
251 CPUHP_AP_RCUTREE_ONLINE
,
252 CPUHP_AP_BASE_CACHEINFO_ONLINE
,
254 CPUHP_AP_ONLINE_DYN_END
= CPUHP_AP_ONLINE_DYN
+ 30,
255 /* Must be after CPUHP_AP_ONLINE_DYN for node_states[N_CPU] update */
256 CPUHP_AP_MM_DEMOTION_ONLINE
,
257 CPUHP_AP_X86_HPET_ONLINE
,
258 CPUHP_AP_X86_KVM_CLK_ONLINE
,
263 int __cpuhp_setup_state(enum cpuhp_state state
, const char *name
, bool invoke
,
264 int (*startup
)(unsigned int cpu
),
265 int (*teardown
)(unsigned int cpu
), bool multi_instance
);
267 int __cpuhp_setup_state_cpuslocked(enum cpuhp_state state
, const char *name
,
269 int (*startup
)(unsigned int cpu
),
270 int (*teardown
)(unsigned int cpu
),
271 bool multi_instance
);
273 * cpuhp_setup_state - Setup hotplug state callbacks with calling the @startup
275 * @state: The state for which the calls are installed
276 * @name: Name of the callback (will be used in debug output)
277 * @startup: startup callback function or NULL if not required
278 * @teardown: teardown callback function or NULL if not required
280 * Installs the callback functions and invokes the @startup callback on
281 * the online cpus which have already reached the @state.
283 static inline int cpuhp_setup_state(enum cpuhp_state state
,
285 int (*startup
)(unsigned int cpu
),
286 int (*teardown
)(unsigned int cpu
))
288 return __cpuhp_setup_state(state
, name
, true, startup
, teardown
, false);
292 * cpuhp_setup_state_cpuslocked - Setup hotplug state callbacks with calling
293 * @startup callback from a cpus_read_lock()
295 * @state: The state for which the calls are installed
296 * @name: Name of the callback (will be used in debug output)
297 * @startup: startup callback function or NULL if not required
298 * @teardown: teardown callback function or NULL if not required
300 * Same as cpuhp_setup_state() except that it must be invoked from within a
301 * cpus_read_lock() held region.
303 static inline int cpuhp_setup_state_cpuslocked(enum cpuhp_state state
,
305 int (*startup
)(unsigned int cpu
),
306 int (*teardown
)(unsigned int cpu
))
308 return __cpuhp_setup_state_cpuslocked(state
, name
, true, startup
,
313 * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
315 * @state: The state for which the calls are installed
316 * @name: Name of the callback.
317 * @startup: startup callback function or NULL if not required
318 * @teardown: teardown callback function or NULL if not required
320 * Same as cpuhp_setup_state() except that the @startup callback is not
321 * invoked during installation. NOP if SMP=n or HOTPLUG_CPU=n.
323 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state
,
325 int (*startup
)(unsigned int cpu
),
326 int (*teardown
)(unsigned int cpu
))
328 return __cpuhp_setup_state(state
, name
, false, startup
, teardown
,
333 * cpuhp_setup_state_nocalls_cpuslocked - Setup hotplug state callbacks without
334 * invoking the @startup callback from
335 * a cpus_read_lock() held region
337 * @state: The state for which the calls are installed
338 * @name: Name of the callback.
339 * @startup: startup callback function or NULL if not required
340 * @teardown: teardown callback function or NULL if not required
342 * Same as cpuhp_setup_state_nocalls() except that it must be invoked from
343 * within a cpus_read_lock() held region.
345 static inline int cpuhp_setup_state_nocalls_cpuslocked(enum cpuhp_state state
,
347 int (*startup
)(unsigned int cpu
),
348 int (*teardown
)(unsigned int cpu
))
350 return __cpuhp_setup_state_cpuslocked(state
, name
, false, startup
,
355 * cpuhp_setup_state_multi - Add callbacks for multi state
356 * @state: The state for which the calls are installed
357 * @name: Name of the callback.
358 * @startup: startup callback function or NULL if not required
359 * @teardown: teardown callback function or NULL if not required
361 * Sets the internal multi_instance flag and prepares a state to work as a multi
362 * instance callback. No callbacks are invoked at this point. The callbacks are
363 * invoked once an instance for this state are registered via
364 * cpuhp_state_add_instance() or cpuhp_state_add_instance_nocalls()
366 static inline int cpuhp_setup_state_multi(enum cpuhp_state state
,
368 int (*startup
)(unsigned int cpu
,
369 struct hlist_node
*node
),
370 int (*teardown
)(unsigned int cpu
,
371 struct hlist_node
*node
))
373 return __cpuhp_setup_state(state
, name
, false,
375 (void *) teardown
, true);
378 int __cpuhp_state_add_instance(enum cpuhp_state state
, struct hlist_node
*node
,
380 int __cpuhp_state_add_instance_cpuslocked(enum cpuhp_state state
,
381 struct hlist_node
*node
, bool invoke
);
384 * cpuhp_state_add_instance - Add an instance for a state and invoke startup
386 * @state: The state for which the instance is installed
387 * @node: The node for this individual state.
389 * Installs the instance for the @state and invokes the registered startup
390 * callback on the online cpus which have already reached the @state. The
391 * @state must have been earlier marked as multi-instance by
392 * cpuhp_setup_state_multi().
394 static inline int cpuhp_state_add_instance(enum cpuhp_state state
,
395 struct hlist_node
*node
)
397 return __cpuhp_state_add_instance(state
, node
, true);
401 * cpuhp_state_add_instance_nocalls - Add an instance for a state without
402 * invoking the startup callback.
403 * @state: The state for which the instance is installed
404 * @node: The node for this individual state.
406 * Installs the instance for the @state. The @state must have been earlier
407 * marked as multi-instance by cpuhp_setup_state_multi. NOP if SMP=n or
410 static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state
,
411 struct hlist_node
*node
)
413 return __cpuhp_state_add_instance(state
, node
, false);
417 * cpuhp_state_add_instance_nocalls_cpuslocked - Add an instance for a state
418 * without invoking the startup
419 * callback from a cpus_read_lock()
421 * @state: The state for which the instance is installed
422 * @node: The node for this individual state.
424 * Same as cpuhp_state_add_instance_nocalls() except that it must be
425 * invoked from within a cpus_read_lock() held region.
428 cpuhp_state_add_instance_nocalls_cpuslocked(enum cpuhp_state state
,
429 struct hlist_node
*node
)
431 return __cpuhp_state_add_instance_cpuslocked(state
, node
, false);
434 void __cpuhp_remove_state(enum cpuhp_state state
, bool invoke
);
435 void __cpuhp_remove_state_cpuslocked(enum cpuhp_state state
, bool invoke
);
438 * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
439 * @state: The state for which the calls are removed
441 * Removes the callback functions and invokes the teardown callback on
442 * the online cpus which have already reached the @state.
444 static inline void cpuhp_remove_state(enum cpuhp_state state
)
446 __cpuhp_remove_state(state
, true);
450 * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
451 * the teardown callback
452 * @state: The state for which the calls are removed
454 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state
)
456 __cpuhp_remove_state(state
, false);
460 * cpuhp_remove_state_nocalls_cpuslocked - Remove hotplug state callbacks without invoking
461 * teardown from a cpus_read_lock() held region.
462 * @state: The state for which the calls are removed
464 * Same as cpuhp_remove_state nocalls() except that it must be invoked
465 * from within a cpus_read_lock() held region.
467 static inline void cpuhp_remove_state_nocalls_cpuslocked(enum cpuhp_state state
)
469 __cpuhp_remove_state_cpuslocked(state
, false);
473 * cpuhp_remove_multi_state - Remove hotplug multi state callback
474 * @state: The state for which the calls are removed
476 * Removes the callback functions from a multi state. This is the reverse of
477 * cpuhp_setup_state_multi(). All instances should have been removed before
478 * invoking this function.
480 static inline void cpuhp_remove_multi_state(enum cpuhp_state state
)
482 __cpuhp_remove_state(state
, false);
485 int __cpuhp_state_remove_instance(enum cpuhp_state state
,
486 struct hlist_node
*node
, bool invoke
);
489 * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
490 * the teardown callback
491 * @state: The state from which the instance is removed
492 * @node: The node for this individual state.
494 * Removes the instance and invokes the teardown callback on the online cpus
495 * which have already reached @state.
497 static inline int cpuhp_state_remove_instance(enum cpuhp_state state
,
498 struct hlist_node
*node
)
500 return __cpuhp_state_remove_instance(state
, node
, true);
504 * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
505 * without invoking the teardown callback
506 * @state: The state from which the instance is removed
507 * @node: The node for this individual state.
509 * Removes the instance without invoking the teardown callback.
511 static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state
,
512 struct hlist_node
*node
)
514 return __cpuhp_state_remove_instance(state
, node
, false);
518 void cpuhp_online_idle(enum cpuhp_state state
);
520 static inline void cpuhp_online_idle(enum cpuhp_state state
) { }
525 void cpuhp_ap_sync_alive(void);
526 void arch_cpuhp_sync_state_poll(void);
527 void arch_cpuhp_cleanup_kick_cpu(unsigned int cpu
);
528 int arch_cpuhp_kick_ap_alive(unsigned int cpu
, struct task_struct
*tidle
);
529 bool arch_cpuhp_init_parallel_bringup(void);
531 #ifdef CONFIG_HOTPLUG_CORE_SYNC_DEAD
532 void cpuhp_ap_report_dead(void);
533 void arch_cpuhp_cleanup_dead_cpu(unsigned int cpu
);
535 static inline void cpuhp_ap_report_dead(void) { }
536 static inline void arch_cpuhp_cleanup_dead_cpu(unsigned int cpu
) { }