Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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_PADATA_DEAD,
63 CPUHP_WORKQUEUE_PREP,
64 CPUHP_POWER_NUMA_PREPARE,
65 CPUHP_HRTIMERS_PREPARE,
66 CPUHP_PROFILE_PREPARE,
67 CPUHP_X2APIC_PREPARE,
68 CPUHP_SMPCFD_PREPARE,
69 CPUHP_RELAY_PREPARE,
70 CPUHP_SLAB_PREPARE,
71 CPUHP_MD_RAID5_PREPARE,
72 CPUHP_RCUTREE_PREP,
73 CPUHP_CPUIDLE_COUPLED_PREPARE,
74 CPUHP_POWERPC_PMAC_PREPARE,
75 CPUHP_POWERPC_MMU_CTX_PREPARE,
76 CPUHP_XEN_PREPARE,
77 CPUHP_XEN_EVTCHN_PREPARE,
78 CPUHP_ARM_SHMOBILE_SCU_PREPARE,
79 CPUHP_SH_SH3X_PREPARE,
80 CPUHP_NET_FLOW_PREPARE,
81 CPUHP_TOPOLOGY_PREPARE,
82 CPUHP_NET_IUCV_PREPARE,
83 CPUHP_ARM_BL_PREPARE,
84 CPUHP_TRACE_RB_PREPARE,
85 CPUHP_MM_ZS_PREPARE,
86 CPUHP_MM_ZSWP_MEM_PREPARE,
87 CPUHP_MM_ZSWP_POOL_PREPARE,
88 CPUHP_KVM_PPC_BOOK3S_PREPARE,
89 CPUHP_ZCOMP_PREPARE,
90 CPUHP_TIMERS_PREPARE,
91 CPUHP_MIPS_SOC_PREPARE,
92 CPUHP_BP_PREPARE_DYN,
93 CPUHP_BP_PREPARE_DYN_END = CPUHP_BP_PREPARE_DYN + 20,
94 CPUHP_BRINGUP_CPU,
95 CPUHP_AP_IDLE_DEAD,
96 CPUHP_AP_OFFLINE,
97 CPUHP_AP_SCHED_STARTING,
98 CPUHP_AP_RCUTREE_DYING,
99 CPUHP_AP_CPU_PM_STARTING,
100 CPUHP_AP_IRQ_GIC_STARTING,
101 CPUHP_AP_IRQ_HIP04_STARTING,
102 CPUHP_AP_IRQ_ARMADA_XP_STARTING,
103 CPUHP_AP_IRQ_BCM2836_STARTING,
104 CPUHP_AP_IRQ_MIPS_GIC_STARTING,
105 CPUHP_AP_IRQ_RISCV_STARTING,
106 CPUHP_AP_IRQ_SIFIVE_PLIC_STARTING,
107 CPUHP_AP_ARM_MVEBU_COHERENCY,
108 CPUHP_AP_MICROCODE_LOADER,
109 CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING,
110 CPUHP_AP_PERF_X86_STARTING,
111 CPUHP_AP_PERF_X86_AMD_IBS_STARTING,
112 CPUHP_AP_PERF_X86_CQM_STARTING,
113 CPUHP_AP_PERF_X86_CSTATE_STARTING,
114 CPUHP_AP_PERF_XTENSA_STARTING,
115 CPUHP_AP_MIPS_OP_LOONGSON3_STARTING,
116 CPUHP_AP_ARM_SDEI_STARTING,
117 CPUHP_AP_ARM_VFP_STARTING,
118 CPUHP_AP_ARM64_DEBUG_MONITORS_STARTING,
119 CPUHP_AP_PERF_ARM_HW_BREAKPOINT_STARTING,
120 CPUHP_AP_PERF_ARM_ACPI_STARTING,
121 CPUHP_AP_PERF_ARM_STARTING,
122 CPUHP_AP_ARM_L2X0_STARTING,
123 CPUHP_AP_EXYNOS4_MCT_TIMER_STARTING,
124 CPUHP_AP_ARM_ARCH_TIMER_STARTING,
125 CPUHP_AP_ARM_GLOBAL_TIMER_STARTING,
126 CPUHP_AP_JCORE_TIMER_STARTING,
127 CPUHP_AP_ARM_TWD_STARTING,
128 CPUHP_AP_QCOM_TIMER_STARTING,
129 CPUHP_AP_TEGRA_TIMER_STARTING,
130 CPUHP_AP_ARMADA_TIMER_STARTING,
131 CPUHP_AP_MARCO_TIMER_STARTING,
132 CPUHP_AP_MIPS_GIC_TIMER_STARTING,
133 CPUHP_AP_ARC_TIMER_STARTING,
134 CPUHP_AP_RISCV_TIMER_STARTING,
135 CPUHP_AP_CSKY_TIMER_STARTING,
136 CPUHP_AP_HYPERV_TIMER_STARTING,
137 CPUHP_AP_KVM_STARTING,
138 CPUHP_AP_KVM_ARM_VGIC_INIT_STARTING,
139 CPUHP_AP_KVM_ARM_VGIC_STARTING,
140 CPUHP_AP_KVM_ARM_TIMER_STARTING,
141 /* Must be the last timer callback */
142 CPUHP_AP_DUMMY_TIMER_STARTING,
143 CPUHP_AP_ARM_XEN_STARTING,
144 CPUHP_AP_ARM_KVMPV_STARTING,
145 CPUHP_AP_ARM_CORESIGHT_STARTING,
146 CPUHP_AP_ARM_CORESIGHT_CTI_STARTING,
147 CPUHP_AP_ARM64_ISNDEP_STARTING,
148 CPUHP_AP_SMPCFD_DYING,
149 CPUHP_AP_X86_TBOOT_DYING,
150 CPUHP_AP_ARM_CACHE_B15_RAC_DYING,
151 CPUHP_AP_ONLINE,
152 CPUHP_TEARDOWN_CPU,
153 CPUHP_AP_ONLINE_IDLE,
154 CPUHP_AP_SMPBOOT_THREADS,
155 CPUHP_AP_X86_VDSO_VMA_ONLINE,
156 CPUHP_AP_IRQ_AFFINITY_ONLINE,
157 CPUHP_AP_BLK_MQ_ONLINE,
158 CPUHP_AP_ARM_MVEBU_SYNC_CLOCKS,
159 CPUHP_AP_X86_INTEL_EPB_ONLINE,
160 CPUHP_AP_PERF_ONLINE,
161 CPUHP_AP_PERF_X86_ONLINE,
162 CPUHP_AP_PERF_X86_UNCORE_ONLINE,
163 CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
164 CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
165 CPUHP_AP_PERF_X86_RAPL_ONLINE,
166 CPUHP_AP_PERF_X86_CQM_ONLINE,
167 CPUHP_AP_PERF_X86_CSTATE_ONLINE,
168 CPUHP_AP_PERF_S390_CF_ONLINE,
169 CPUHP_AP_PERF_S390_SF_ONLINE,
170 CPUHP_AP_PERF_ARM_CCI_ONLINE,
171 CPUHP_AP_PERF_ARM_CCN_ONLINE,
172 CPUHP_AP_PERF_ARM_HISI_DDRC_ONLINE,
173 CPUHP_AP_PERF_ARM_HISI_HHA_ONLINE,
174 CPUHP_AP_PERF_ARM_HISI_L3_ONLINE,
175 CPUHP_AP_PERF_ARM_L2X0_ONLINE,
176 CPUHP_AP_PERF_ARM_QCOM_L2_ONLINE,
177 CPUHP_AP_PERF_ARM_QCOM_L3_ONLINE,
178 CPUHP_AP_PERF_ARM_APM_XGENE_ONLINE,
179 CPUHP_AP_PERF_ARM_CAVIUM_TX2_UNCORE_ONLINE,
180 CPUHP_AP_PERF_POWERPC_NEST_IMC_ONLINE,
181 CPUHP_AP_PERF_POWERPC_CORE_IMC_ONLINE,
182 CPUHP_AP_PERF_POWERPC_THREAD_IMC_ONLINE,
183 CPUHP_AP_PERF_POWERPC_TRACE_IMC_ONLINE,
184 CPUHP_AP_WATCHDOG_ONLINE,
185 CPUHP_AP_WORKQUEUE_ONLINE,
186 CPUHP_AP_RCUTREE_ONLINE,
187 CPUHP_AP_BASE_CACHEINFO_ONLINE,
188 CPUHP_AP_ONLINE_DYN,
189 CPUHP_AP_ONLINE_DYN_END = CPUHP_AP_ONLINE_DYN + 30,
190 CPUHP_AP_X86_HPET_ONLINE,
191 CPUHP_AP_X86_KVM_CLK_ONLINE,
192 CPUHP_AP_ACTIVE,
193 CPUHP_ONLINE,
194};
195
196int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
197 int (*startup)(unsigned int cpu),
198 int (*teardown)(unsigned int cpu), bool multi_instance);
199
200int __cpuhp_setup_state_cpuslocked(enum cpuhp_state state, const char *name,
201 bool invoke,
202 int (*startup)(unsigned int cpu),
203 int (*teardown)(unsigned int cpu),
204 bool multi_instance);
205/**
206 * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
207 * @state: The state for which the calls are installed
208 * @name: Name of the callback (will be used in debug output)
209 * @startup: startup callback function
210 * @teardown: teardown callback function
211 *
212 * Installs the callback functions and invokes the startup callback on
213 * the present cpus which have already reached the @state.
214 */
215static inline int cpuhp_setup_state(enum cpuhp_state state,
216 const char *name,
217 int (*startup)(unsigned int cpu),
218 int (*teardown)(unsigned int cpu))
219{
220 return __cpuhp_setup_state(state, name, true, startup, teardown, false);
221}
222
223static inline int cpuhp_setup_state_cpuslocked(enum cpuhp_state state,
224 const char *name,
225 int (*startup)(unsigned int cpu),
226 int (*teardown)(unsigned int cpu))
227{
228 return __cpuhp_setup_state_cpuslocked(state, name, true, startup,
229 teardown, false);
230}
231
232/**
233 * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
234 * callbacks
235 * @state: The state for which the calls are installed
236 * @name: Name of the callback.
237 * @startup: startup callback function
238 * @teardown: teardown callback function
239 *
240 * Same as @cpuhp_setup_state except that no calls are executed are invoked
241 * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
242 */
243static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
244 const char *name,
245 int (*startup)(unsigned int cpu),
246 int (*teardown)(unsigned int cpu))
247{
248 return __cpuhp_setup_state(state, name, false, startup, teardown,
249 false);
250}
251
252static inline int cpuhp_setup_state_nocalls_cpuslocked(enum cpuhp_state state,
253 const char *name,
254 int (*startup)(unsigned int cpu),
255 int (*teardown)(unsigned int cpu))
256{
257 return __cpuhp_setup_state_cpuslocked(state, name, false, startup,
258 teardown, false);
259}
260
261/**
262 * cpuhp_setup_state_multi - Add callbacks for multi state
263 * @state: The state for which the calls are installed
264 * @name: Name of the callback.
265 * @startup: startup callback function
266 * @teardown: teardown callback function
267 *
268 * Sets the internal multi_instance flag and prepares a state to work as a multi
269 * instance callback. No callbacks are invoked at this point. The callbacks are
270 * invoked once an instance for this state are registered via
271 * @cpuhp_state_add_instance or @cpuhp_state_add_instance_nocalls.
272 */
273static inline int cpuhp_setup_state_multi(enum cpuhp_state state,
274 const char *name,
275 int (*startup)(unsigned int cpu,
276 struct hlist_node *node),
277 int (*teardown)(unsigned int cpu,
278 struct hlist_node *node))
279{
280 return __cpuhp_setup_state(state, name, false,
281 (void *) startup,
282 (void *) teardown, true);
283}
284
285int __cpuhp_state_add_instance(enum cpuhp_state state, struct hlist_node *node,
286 bool invoke);
287int __cpuhp_state_add_instance_cpuslocked(enum cpuhp_state state,
288 struct hlist_node *node, bool invoke);
289
290/**
291 * cpuhp_state_add_instance - Add an instance for a state and invoke startup
292 * callback.
293 * @state: The state for which the instance is installed
294 * @node: The node for this individual state.
295 *
296 * Installs the instance for the @state and invokes the startup callback on
297 * the present cpus which have already reached the @state. The @state must have
298 * been earlier marked as multi-instance by @cpuhp_setup_state_multi.
299 */
300static inline int cpuhp_state_add_instance(enum cpuhp_state state,
301 struct hlist_node *node)
302{
303 return __cpuhp_state_add_instance(state, node, true);
304}
305
306/**
307 * cpuhp_state_add_instance_nocalls - Add an instance for a state without
308 * invoking the startup callback.
309 * @state: The state for which the instance is installed
310 * @node: The node for this individual state.
311 *
312 * Installs the instance for the @state The @state must have been earlier
313 * marked as multi-instance by @cpuhp_setup_state_multi.
314 */
315static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state,
316 struct hlist_node *node)
317{
318 return __cpuhp_state_add_instance(state, node, false);
319}
320
321static inline int
322cpuhp_state_add_instance_nocalls_cpuslocked(enum cpuhp_state state,
323 struct hlist_node *node)
324{
325 return __cpuhp_state_add_instance_cpuslocked(state, node, false);
326}
327
328void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
329void __cpuhp_remove_state_cpuslocked(enum cpuhp_state state, bool invoke);
330
331/**
332 * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
333 * @state: The state for which the calls are removed
334 *
335 * Removes the callback functions and invokes the teardown callback on
336 * the present cpus which have already reached the @state.
337 */
338static inline void cpuhp_remove_state(enum cpuhp_state state)
339{
340 __cpuhp_remove_state(state, true);
341}
342
343/**
344 * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
345 * teardown
346 * @state: The state for which the calls are removed
347 */
348static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
349{
350 __cpuhp_remove_state(state, false);
351}
352
353static inline void cpuhp_remove_state_nocalls_cpuslocked(enum cpuhp_state state)
354{
355 __cpuhp_remove_state_cpuslocked(state, false);
356}
357
358/**
359 * cpuhp_remove_multi_state - Remove hotplug multi state callback
360 * @state: The state for which the calls are removed
361 *
362 * Removes the callback functions from a multi state. This is the reverse of
363 * cpuhp_setup_state_multi(). All instances should have been removed before
364 * invoking this function.
365 */
366static inline void cpuhp_remove_multi_state(enum cpuhp_state state)
367{
368 __cpuhp_remove_state(state, false);
369}
370
371int __cpuhp_state_remove_instance(enum cpuhp_state state,
372 struct hlist_node *node, bool invoke);
373
374/**
375 * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
376 * the teardown callback
377 * @state: The state from which the instance is removed
378 * @node: The node for this individual state.
379 *
380 * Removes the instance and invokes the teardown callback on the present cpus
381 * which have already reached the @state.
382 */
383static inline int cpuhp_state_remove_instance(enum cpuhp_state state,
384 struct hlist_node *node)
385{
386 return __cpuhp_state_remove_instance(state, node, true);
387}
388
389/**
390 * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
391 * without invoking the reatdown callback
392 * @state: The state from which the instance is removed
393 * @node: The node for this individual state.
394 *
395 * Removes the instance without invoking the teardown callback.
396 */
397static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state,
398 struct hlist_node *node)
399{
400 return __cpuhp_state_remove_instance(state, node, false);
401}
402
403#ifdef CONFIG_SMP
404void cpuhp_online_idle(enum cpuhp_state state);
405#else
406static inline void cpuhp_online_idle(enum cpuhp_state state) { }
407#endif
408
409#endif