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