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
25enum 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_POWER,
33 CPUHP_PERF_SUPERH,
34 CPUHP_X86_HPET_DEAD,
35 CPUHP_X86_APB_DEAD,
36 CPUHP_X86_MCE_DEAD,
37 CPUHP_VIRT_NET_DEAD,
38 CPUHP_SLUB_DEAD,
39 CPUHP_MM_WRITEBACK_DEAD,
40 CPUHP_MM_VMSTAT_DEAD,
41 CPUHP_SOFTIRQ_DEAD,
42 CPUHP_NET_MVNETA_DEAD,
43 CPUHP_CPUIDLE_DEAD,
44 CPUHP_ARM64_FPSIMD_DEAD,
45 CPUHP_ARM_OMAP_WAKE_DEAD,
46 CPUHP_IRQ_POLL_DEAD,
47 CPUHP_BLOCK_SOFTIRQ_DEAD,
48 CPUHP_ACPI_CPUDRV_DEAD,
49 CPUHP_S390_PFAULT_DEAD,
50 CPUHP_BLK_MQ_DEAD,
51 CPUHP_FS_BUFF_DEAD,
52 CPUHP_PRINTK_DEAD,
53 CPUHP_MM_MEMCQ_DEAD,
54 CPUHP_PERCPU_CNT_DEAD,
55 CPUHP_RADIX_DEAD,
56 CPUHP_PAGE_ALLOC_DEAD,
57 CPUHP_NET_DEV_DEAD,
58 CPUHP_PCI_XGENE_DEAD,
59 CPUHP_IOMMU_INTEL_DEAD,
60 CPUHP_LUSTRE_CFS_DEAD,
61 CPUHP_AP_ARM_CACHE_B15_RAC_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_PREPARE,
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_MIPS_OP_LOONGSON3_STARTING,
111 CPUHP_AP_ARM_SDEI_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_QCOM_TIMER_STARTING,
124 CPUHP_AP_TEGRA_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_RISCV_TIMER_STARTING,
130 CPUHP_AP_CSKY_TIMER_STARTING,
131 CPUHP_AP_KVM_STARTING,
132 CPUHP_AP_KVM_ARM_VGIC_INIT_STARTING,
133 CPUHP_AP_KVM_ARM_VGIC_STARTING,
134 CPUHP_AP_KVM_ARM_TIMER_STARTING,
135 /* Must be the last timer callback */
136 CPUHP_AP_DUMMY_TIMER_STARTING,
137 CPUHP_AP_ARM_XEN_STARTING,
138 CPUHP_AP_ARM_CORESIGHT_STARTING,
139 CPUHP_AP_ARM64_ISNDEP_STARTING,
140 CPUHP_AP_SMPCFD_DYING,
141 CPUHP_AP_X86_TBOOT_DYING,
142 CPUHP_AP_ARM_CACHE_B15_RAC_DYING,
143 CPUHP_AP_ONLINE,
144 CPUHP_TEARDOWN_CPU,
145 CPUHP_AP_ONLINE_IDLE,
146 CPUHP_AP_SMPBOOT_THREADS,
147 CPUHP_AP_X86_VDSO_VMA_ONLINE,
148 CPUHP_AP_IRQ_AFFINITY_ONLINE,
149 CPUHP_AP_ARM_MVEBU_SYNC_CLOCKS,
150 CPUHP_AP_PERF_ONLINE,
151 CPUHP_AP_PERF_X86_ONLINE,
152 CPUHP_AP_PERF_X86_UNCORE_ONLINE,
153 CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
154 CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
155 CPUHP_AP_PERF_X86_RAPL_ONLINE,
156 CPUHP_AP_PERF_X86_CQM_ONLINE,
157 CPUHP_AP_PERF_X86_CSTATE_ONLINE,
158 CPUHP_AP_PERF_S390_CF_ONLINE,
159 CPUHP_AP_PERF_S390_SF_ONLINE,
160 CPUHP_AP_PERF_ARM_CCI_ONLINE,
161 CPUHP_AP_PERF_ARM_CCN_ONLINE,
162 CPUHP_AP_PERF_ARM_HISI_DDRC_ONLINE,
163 CPUHP_AP_PERF_ARM_HISI_HHA_ONLINE,
164 CPUHP_AP_PERF_ARM_HISI_L3_ONLINE,
165 CPUHP_AP_PERF_ARM_L2X0_ONLINE,
166 CPUHP_AP_PERF_ARM_QCOM_L2_ONLINE,
167 CPUHP_AP_PERF_ARM_QCOM_L3_ONLINE,
168 CPUHP_AP_PERF_ARM_APM_XGENE_ONLINE,
169 CPUHP_AP_PERF_ARM_CAVIUM_TX2_UNCORE_ONLINE,
170 CPUHP_AP_PERF_POWERPC_NEST_IMC_ONLINE,
171 CPUHP_AP_PERF_POWERPC_CORE_IMC_ONLINE,
172 CPUHP_AP_PERF_POWERPC_THREAD_IMC_ONLINE,
173 CPUHP_AP_WATCHDOG_ONLINE,
174 CPUHP_AP_WORKQUEUE_ONLINE,
175 CPUHP_AP_RCUTREE_ONLINE,
176 CPUHP_AP_ONLINE_DYN,
177 CPUHP_AP_ONLINE_DYN_END = CPUHP_AP_ONLINE_DYN + 30,
178 CPUHP_AP_X86_HPET_ONLINE,
179 CPUHP_AP_X86_KVM_CLK_ONLINE,
180 CPUHP_AP_ACTIVE,
181 CPUHP_ONLINE,
182};
183
184int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
185 int (*startup)(unsigned int cpu),
186 int (*teardown)(unsigned int cpu), bool multi_instance);
187
188int __cpuhp_setup_state_cpuslocked(enum cpuhp_state state, const char *name,
189 bool invoke,
190 int (*startup)(unsigned int cpu),
191 int (*teardown)(unsigned int cpu),
192 bool multi_instance);
193/**
194 * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
195 * @state: The state for which the calls are installed
196 * @name: Name of the callback (will be used in debug output)
197 * @startup: startup callback function
198 * @teardown: teardown callback function
199 *
200 * Installs the callback functions and invokes the startup callback on
201 * the present cpus which have already reached the @state.
202 */
203static inline int cpuhp_setup_state(enum cpuhp_state state,
204 const char *name,
205 int (*startup)(unsigned int cpu),
206 int (*teardown)(unsigned int cpu))
207{
208 return __cpuhp_setup_state(state, name, true, startup, teardown, false);
209}
210
211static inline int cpuhp_setup_state_cpuslocked(enum cpuhp_state state,
212 const char *name,
213 int (*startup)(unsigned int cpu),
214 int (*teardown)(unsigned int cpu))
215{
216 return __cpuhp_setup_state_cpuslocked(state, name, true, startup,
217 teardown, false);
218}
219
220/**
221 * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
222 * callbacks
223 * @state: The state for which the calls are installed
224 * @name: Name of the callback.
225 * @startup: startup callback function
226 * @teardown: teardown callback function
227 *
228 * Same as @cpuhp_setup_state except that no calls are executed are invoked
229 * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
230 */
231static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
232 const char *name,
233 int (*startup)(unsigned int cpu),
234 int (*teardown)(unsigned int cpu))
235{
236 return __cpuhp_setup_state(state, name, false, startup, teardown,
237 false);
238}
239
240static inline int cpuhp_setup_state_nocalls_cpuslocked(enum cpuhp_state state,
241 const char *name,
242 int (*startup)(unsigned int cpu),
243 int (*teardown)(unsigned int cpu))
244{
245 return __cpuhp_setup_state_cpuslocked(state, name, false, startup,
246 teardown, false);
247}
248
249/**
250 * cpuhp_setup_state_multi - Add callbacks for multi state
251 * @state: The state for which the calls are installed
252 * @name: Name of the callback.
253 * @startup: startup callback function
254 * @teardown: teardown callback function
255 *
256 * Sets the internal multi_instance flag and prepares a state to work as a multi
257 * instance callback. No callbacks are invoked at this point. The callbacks are
258 * invoked once an instance for this state are registered via
259 * @cpuhp_state_add_instance or @cpuhp_state_add_instance_nocalls.
260 */
261static inline int cpuhp_setup_state_multi(enum cpuhp_state state,
262 const char *name,
263 int (*startup)(unsigned int cpu,
264 struct hlist_node *node),
265 int (*teardown)(unsigned int cpu,
266 struct hlist_node *node))
267{
268 return __cpuhp_setup_state(state, name, false,
269 (void *) startup,
270 (void *) teardown, true);
271}
272
273int __cpuhp_state_add_instance(enum cpuhp_state state, struct hlist_node *node,
274 bool invoke);
275int __cpuhp_state_add_instance_cpuslocked(enum cpuhp_state state,
276 struct hlist_node *node, bool invoke);
277
278/**
279 * cpuhp_state_add_instance - Add an instance for a state and invoke startup
280 * callback.
281 * @state: The state for which the instance is installed
282 * @node: The node for this individual state.
283 *
284 * Installs the instance for the @state and invokes the startup callback on
285 * the present cpus which have already reached the @state. The @state must have
286 * been earlier marked as multi-instance by @cpuhp_setup_state_multi.
287 */
288static inline int cpuhp_state_add_instance(enum cpuhp_state state,
289 struct hlist_node *node)
290{
291 return __cpuhp_state_add_instance(state, node, true);
292}
293
294/**
295 * cpuhp_state_add_instance_nocalls - Add an instance for a state without
296 * invoking the startup callback.
297 * @state: The state for which the instance is installed
298 * @node: The node for this individual state.
299 *
300 * Installs the instance for the @state The @state must have been earlier
301 * marked as multi-instance by @cpuhp_setup_state_multi.
302 */
303static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state,
304 struct hlist_node *node)
305{
306 return __cpuhp_state_add_instance(state, node, false);
307}
308
309static inline int
310cpuhp_state_add_instance_nocalls_cpuslocked(enum cpuhp_state state,
311 struct hlist_node *node)
312{
313 return __cpuhp_state_add_instance_cpuslocked(state, node, false);
314}
315
316void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
317void __cpuhp_remove_state_cpuslocked(enum cpuhp_state state, bool invoke);
318
319/**
320 * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
321 * @state: The state for which the calls are removed
322 *
323 * Removes the callback functions and invokes the teardown callback on
324 * the present cpus which have already reached the @state.
325 */
326static inline void cpuhp_remove_state(enum cpuhp_state state)
327{
328 __cpuhp_remove_state(state, true);
329}
330
331/**
332 * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
333 * teardown
334 * @state: The state for which the calls are removed
335 */
336static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
337{
338 __cpuhp_remove_state(state, false);
339}
340
341static inline void cpuhp_remove_state_nocalls_cpuslocked(enum cpuhp_state state)
342{
343 __cpuhp_remove_state_cpuslocked(state, false);
344}
345
346/**
347 * cpuhp_remove_multi_state - Remove hotplug multi state callback
348 * @state: The state for which the calls are removed
349 *
350 * Removes the callback functions from a multi state. This is the reverse of
351 * cpuhp_setup_state_multi(). All instances should have been removed before
352 * invoking this function.
353 */
354static inline void cpuhp_remove_multi_state(enum cpuhp_state state)
355{
356 __cpuhp_remove_state(state, false);
357}
358
359int __cpuhp_state_remove_instance(enum cpuhp_state state,
360 struct hlist_node *node, bool invoke);
361
362/**
363 * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
364 * the teardown callback
365 * @state: The state from which the instance is removed
366 * @node: The node for this individual state.
367 *
368 * Removes the instance and invokes the teardown callback on the present cpus
369 * which have already reached the @state.
370 */
371static inline int cpuhp_state_remove_instance(enum cpuhp_state state,
372 struct hlist_node *node)
373{
374 return __cpuhp_state_remove_instance(state, node, true);
375}
376
377/**
378 * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
379 * without invoking the reatdown callback
380 * @state: The state from which the instance is removed
381 * @node: The node for this individual state.
382 *
383 * Removes the instance without invoking the teardown callback.
384 */
385static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state,
386 struct hlist_node *node)
387{
388 return __cpuhp_state_remove_instance(state, node, false);
389}
390
391#ifdef CONFIG_SMP
392void cpuhp_online_idle(enum cpuhp_state state);
393#else
394static inline void cpuhp_online_idle(enum cpuhp_state state) { }
395#endif
396
397#endif
398