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