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