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