Merge tag 'perf-tools-for-v5.15-2021-09-11' of git://git.kernel.org/pub/scm/linux...
[linux-2.6-microblaze.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 /*
26  * CPU hotplug states. The state machine invokes the installed state
27  * startup callbacks sequentially from CPUHP_OFFLINE + 1 to CPUHP_ONLINE
28  * during a CPU online operation. During a CPU offline operation the
29  * installed teardown callbacks are invoked in the reverse order from
30  * CPU_ONLINE - 1 down to CPUHP_OFFLINE.
31  *
32  * The state space has three sections: PREPARE, STARTING and ONLINE.
33  *
34  * PREPARE: The callbacks are invoked on a control CPU before the
35  * hotplugged CPU is started up or after the hotplugged CPU has died.
36  *
37  * STARTING: The callbacks are invoked on the hotplugged CPU from the low level
38  * hotplug startup/teardown code with interrupts disabled.
39  *
40  * ONLINE: The callbacks are invoked on the hotplugged CPU from the per CPU
41  * hotplug thread with interrupts and preemption enabled.
42  *
43  * Adding explicit states to this enum is only necessary when:
44  *
45  * 1) The state is within the STARTING section
46  *
47  * 2) The state has ordering constraints vs. other states in the
48  *    same section.
49  *
50  * If neither #1 nor #2 apply, please use the dynamic state space when
51  * setting up a state by using CPUHP_PREPARE_DYN or CPUHP_PREPARE_ONLINE
52  * for the @state argument of the setup function.
53  *
54  * See Documentation/core-api/cpu_hotplug.rst for further information and
55  * examples.
56  */
57 enum cpuhp_state {
58         CPUHP_INVALID = -1,
59
60         /* PREPARE section invoked on a control CPU */
61         CPUHP_OFFLINE = 0,
62         CPUHP_CREATE_THREADS,
63         CPUHP_PERF_PREPARE,
64         CPUHP_PERF_X86_PREPARE,
65         CPUHP_PERF_X86_AMD_UNCORE_PREP,
66         CPUHP_PERF_POWER,
67         CPUHP_PERF_SUPERH,
68         CPUHP_X86_HPET_DEAD,
69         CPUHP_X86_APB_DEAD,
70         CPUHP_X86_MCE_DEAD,
71         CPUHP_VIRT_NET_DEAD,
72         CPUHP_SLUB_DEAD,
73         CPUHP_DEBUG_OBJ_DEAD,
74         CPUHP_MM_WRITEBACK_DEAD,
75         CPUHP_MM_VMSTAT_DEAD,
76         CPUHP_SOFTIRQ_DEAD,
77         CPUHP_NET_MVNETA_DEAD,
78         CPUHP_CPUIDLE_DEAD,
79         CPUHP_ARM64_FPSIMD_DEAD,
80         CPUHP_ARM_OMAP_WAKE_DEAD,
81         CPUHP_IRQ_POLL_DEAD,
82         CPUHP_BLOCK_SOFTIRQ_DEAD,
83         CPUHP_BIO_DEAD,
84         CPUHP_ACPI_CPUDRV_DEAD,
85         CPUHP_S390_PFAULT_DEAD,
86         CPUHP_BLK_MQ_DEAD,
87         CPUHP_FS_BUFF_DEAD,
88         CPUHP_PRINTK_DEAD,
89         CPUHP_MM_MEMCQ_DEAD,
90         CPUHP_XFS_DEAD,
91         CPUHP_PERCPU_CNT_DEAD,
92         CPUHP_RADIX_DEAD,
93         CPUHP_PAGE_ALLOC,
94         CPUHP_NET_DEV_DEAD,
95         CPUHP_PCI_XGENE_DEAD,
96         CPUHP_IOMMU_IOVA_DEAD,
97         CPUHP_LUSTRE_CFS_DEAD,
98         CPUHP_AP_ARM_CACHE_B15_RAC_DEAD,
99         CPUHP_PADATA_DEAD,
100         CPUHP_WORKQUEUE_PREP,
101         CPUHP_POWER_NUMA_PREPARE,
102         CPUHP_HRTIMERS_PREPARE,
103         CPUHP_PROFILE_PREPARE,
104         CPUHP_X2APIC_PREPARE,
105         CPUHP_SMPCFD_PREPARE,
106         CPUHP_RELAY_PREPARE,
107         CPUHP_SLAB_PREPARE,
108         CPUHP_MD_RAID5_PREPARE,
109         CPUHP_RCUTREE_PREP,
110         CPUHP_CPUIDLE_COUPLED_PREPARE,
111         CPUHP_POWERPC_PMAC_PREPARE,
112         CPUHP_POWERPC_MMU_CTX_PREPARE,
113         CPUHP_XEN_PREPARE,
114         CPUHP_XEN_EVTCHN_PREPARE,
115         CPUHP_ARM_SHMOBILE_SCU_PREPARE,
116         CPUHP_SH_SH3X_PREPARE,
117         CPUHP_NET_FLOW_PREPARE,
118         CPUHP_TOPOLOGY_PREPARE,
119         CPUHP_NET_IUCV_PREPARE,
120         CPUHP_ARM_BL_PREPARE,
121         CPUHP_TRACE_RB_PREPARE,
122         CPUHP_MM_ZS_PREPARE,
123         CPUHP_MM_ZSWP_MEM_PREPARE,
124         CPUHP_MM_ZSWP_POOL_PREPARE,
125         CPUHP_KVM_PPC_BOOK3S_PREPARE,
126         CPUHP_ZCOMP_PREPARE,
127         CPUHP_TIMERS_PREPARE,
128         CPUHP_MIPS_SOC_PREPARE,
129         CPUHP_BP_PREPARE_DYN,
130         CPUHP_BP_PREPARE_DYN_END                = CPUHP_BP_PREPARE_DYN + 20,
131         CPUHP_BRINGUP_CPU,
132
133         /*
134          * STARTING section invoked on the hotplugged CPU in low level
135          * bringup and teardown code.
136          */
137         CPUHP_AP_IDLE_DEAD,
138         CPUHP_AP_OFFLINE,
139         CPUHP_AP_SCHED_STARTING,
140         CPUHP_AP_RCUTREE_DYING,
141         CPUHP_AP_CPU_PM_STARTING,
142         CPUHP_AP_IRQ_GIC_STARTING,
143         CPUHP_AP_IRQ_HIP04_STARTING,
144         CPUHP_AP_IRQ_APPLE_AIC_STARTING,
145         CPUHP_AP_IRQ_ARMADA_XP_STARTING,
146         CPUHP_AP_IRQ_BCM2836_STARTING,
147         CPUHP_AP_IRQ_MIPS_GIC_STARTING,
148         CPUHP_AP_IRQ_RISCV_STARTING,
149         CPUHP_AP_IRQ_SIFIVE_PLIC_STARTING,
150         CPUHP_AP_ARM_MVEBU_COHERENCY,
151         CPUHP_AP_MICROCODE_LOADER,
152         CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING,
153         CPUHP_AP_PERF_X86_STARTING,
154         CPUHP_AP_PERF_X86_AMD_IBS_STARTING,
155         CPUHP_AP_PERF_X86_CQM_STARTING,
156         CPUHP_AP_PERF_X86_CSTATE_STARTING,
157         CPUHP_AP_PERF_XTENSA_STARTING,
158         CPUHP_AP_MIPS_OP_LOONGSON3_STARTING,
159         CPUHP_AP_ARM_SDEI_STARTING,
160         CPUHP_AP_ARM_VFP_STARTING,
161         CPUHP_AP_ARM64_DEBUG_MONITORS_STARTING,
162         CPUHP_AP_PERF_ARM_HW_BREAKPOINT_STARTING,
163         CPUHP_AP_PERF_ARM_ACPI_STARTING,
164         CPUHP_AP_PERF_ARM_STARTING,
165         CPUHP_AP_ARM_L2X0_STARTING,
166         CPUHP_AP_EXYNOS4_MCT_TIMER_STARTING,
167         CPUHP_AP_ARM_ARCH_TIMER_STARTING,
168         CPUHP_AP_ARM_GLOBAL_TIMER_STARTING,
169         CPUHP_AP_JCORE_TIMER_STARTING,
170         CPUHP_AP_ARM_TWD_STARTING,
171         CPUHP_AP_QCOM_TIMER_STARTING,
172         CPUHP_AP_TEGRA_TIMER_STARTING,
173         CPUHP_AP_ARMADA_TIMER_STARTING,
174         CPUHP_AP_MARCO_TIMER_STARTING,
175         CPUHP_AP_MIPS_GIC_TIMER_STARTING,
176         CPUHP_AP_ARC_TIMER_STARTING,
177         CPUHP_AP_RISCV_TIMER_STARTING,
178         CPUHP_AP_CLINT_TIMER_STARTING,
179         CPUHP_AP_CSKY_TIMER_STARTING,
180         CPUHP_AP_TI_GP_TIMER_STARTING,
181         CPUHP_AP_HYPERV_TIMER_STARTING,
182         CPUHP_AP_KVM_STARTING,
183         CPUHP_AP_KVM_ARM_VGIC_INIT_STARTING,
184         CPUHP_AP_KVM_ARM_VGIC_STARTING,
185         CPUHP_AP_KVM_ARM_TIMER_STARTING,
186         /* Must be the last timer callback */
187         CPUHP_AP_DUMMY_TIMER_STARTING,
188         CPUHP_AP_ARM_XEN_STARTING,
189         CPUHP_AP_ARM_CORESIGHT_STARTING,
190         CPUHP_AP_ARM_CORESIGHT_CTI_STARTING,
191         CPUHP_AP_ARM64_ISNDEP_STARTING,
192         CPUHP_AP_SMPCFD_DYING,
193         CPUHP_AP_X86_TBOOT_DYING,
194         CPUHP_AP_ARM_CACHE_B15_RAC_DYING,
195         CPUHP_AP_ONLINE,
196         CPUHP_TEARDOWN_CPU,
197
198         /* Online section invoked on the hotplugged CPU from the hotplug thread */
199         CPUHP_AP_ONLINE_IDLE,
200         CPUHP_AP_SCHED_WAIT_EMPTY,
201         CPUHP_AP_SMPBOOT_THREADS,
202         CPUHP_AP_X86_VDSO_VMA_ONLINE,
203         CPUHP_AP_IRQ_AFFINITY_ONLINE,
204         CPUHP_AP_BLK_MQ_ONLINE,
205         CPUHP_AP_ARM_MVEBU_SYNC_CLOCKS,
206         CPUHP_AP_X86_INTEL_EPB_ONLINE,
207         CPUHP_AP_PERF_ONLINE,
208         CPUHP_AP_PERF_X86_ONLINE,
209         CPUHP_AP_PERF_X86_UNCORE_ONLINE,
210         CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
211         CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
212         CPUHP_AP_PERF_X86_RAPL_ONLINE,
213         CPUHP_AP_PERF_X86_CQM_ONLINE,
214         CPUHP_AP_PERF_X86_CSTATE_ONLINE,
215         CPUHP_AP_PERF_X86_IDXD_ONLINE,
216         CPUHP_AP_PERF_S390_CF_ONLINE,
217         CPUHP_AP_PERF_S390_SF_ONLINE,
218         CPUHP_AP_PERF_ARM_CCI_ONLINE,
219         CPUHP_AP_PERF_ARM_CCN_ONLINE,
220         CPUHP_AP_PERF_ARM_HISI_DDRC_ONLINE,
221         CPUHP_AP_PERF_ARM_HISI_HHA_ONLINE,
222         CPUHP_AP_PERF_ARM_HISI_L3_ONLINE,
223         CPUHP_AP_PERF_ARM_HISI_PA_ONLINE,
224         CPUHP_AP_PERF_ARM_HISI_SLLC_ONLINE,
225         CPUHP_AP_PERF_ARM_L2X0_ONLINE,
226         CPUHP_AP_PERF_ARM_QCOM_L2_ONLINE,
227         CPUHP_AP_PERF_ARM_QCOM_L3_ONLINE,
228         CPUHP_AP_PERF_ARM_APM_XGENE_ONLINE,
229         CPUHP_AP_PERF_ARM_CAVIUM_TX2_UNCORE_ONLINE,
230         CPUHP_AP_PERF_POWERPC_NEST_IMC_ONLINE,
231         CPUHP_AP_PERF_POWERPC_CORE_IMC_ONLINE,
232         CPUHP_AP_PERF_POWERPC_THREAD_IMC_ONLINE,
233         CPUHP_AP_PERF_POWERPC_TRACE_IMC_ONLINE,
234         CPUHP_AP_PERF_POWERPC_HV_24x7_ONLINE,
235         CPUHP_AP_PERF_POWERPC_HV_GPCI_ONLINE,
236         CPUHP_AP_PERF_CSKY_ONLINE,
237         CPUHP_AP_WATCHDOG_ONLINE,
238         CPUHP_AP_WORKQUEUE_ONLINE,
239         CPUHP_AP_RCUTREE_ONLINE,
240         CPUHP_AP_BASE_CACHEINFO_ONLINE,
241         CPUHP_AP_ONLINE_DYN,
242         CPUHP_AP_ONLINE_DYN_END         = CPUHP_AP_ONLINE_DYN + 30,
243         CPUHP_AP_X86_HPET_ONLINE,
244         CPUHP_AP_X86_KVM_CLK_ONLINE,
245         CPUHP_AP_DTPM_CPU_ONLINE,
246         CPUHP_AP_ACTIVE,
247         CPUHP_ONLINE,
248 };
249
250 int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
251                         int (*startup)(unsigned int cpu),
252                         int (*teardown)(unsigned int cpu), bool multi_instance);
253
254 int __cpuhp_setup_state_cpuslocked(enum cpuhp_state state, const char *name,
255                                    bool invoke,
256                                    int (*startup)(unsigned int cpu),
257                                    int (*teardown)(unsigned int cpu),
258                                    bool multi_instance);
259 /**
260  * cpuhp_setup_state - Setup hotplug state callbacks with calling the @startup
261  *                     callback
262  * @state:      The state for which the calls are installed
263  * @name:       Name of the callback (will be used in debug output)
264  * @startup:    startup callback function or NULL if not required
265  * @teardown:   teardown callback function or NULL if not required
266  *
267  * Installs the callback functions and invokes the @startup callback on
268  * the online cpus which have already reached the @state.
269  */
270 static inline int cpuhp_setup_state(enum cpuhp_state state,
271                                     const char *name,
272                                     int (*startup)(unsigned int cpu),
273                                     int (*teardown)(unsigned int cpu))
274 {
275         return __cpuhp_setup_state(state, name, true, startup, teardown, false);
276 }
277
278 /**
279  * cpuhp_setup_state_cpuslocked - Setup hotplug state callbacks with calling
280  *                                @startup callback from a cpus_read_lock()
281  *                                held region
282  * @state:      The state for which the calls are installed
283  * @name:       Name of the callback (will be used in debug output)
284  * @startup:    startup callback function or NULL if not required
285  * @teardown:   teardown callback function or NULL if not required
286  *
287  * Same as cpuhp_setup_state() except that it must be invoked from within a
288  * cpus_read_lock() held region.
289  */
290 static inline int cpuhp_setup_state_cpuslocked(enum cpuhp_state state,
291                                                const char *name,
292                                                int (*startup)(unsigned int cpu),
293                                                int (*teardown)(unsigned int cpu))
294 {
295         return __cpuhp_setup_state_cpuslocked(state, name, true, startup,
296                                               teardown, false);
297 }
298
299 /**
300  * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
301  *                             @startup callback
302  * @state:      The state for which the calls are installed
303  * @name:       Name of the callback.
304  * @startup:    startup callback function or NULL if not required
305  * @teardown:   teardown callback function or NULL if not required
306  *
307  * Same as cpuhp_setup_state() except that the @startup callback is not
308  * invoked during installation. NOP if SMP=n or HOTPLUG_CPU=n.
309  */
310 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
311                                             const char *name,
312                                             int (*startup)(unsigned int cpu),
313                                             int (*teardown)(unsigned int cpu))
314 {
315         return __cpuhp_setup_state(state, name, false, startup, teardown,
316                                    false);
317 }
318
319 /**
320  * cpuhp_setup_state_nocalls_cpuslocked - Setup hotplug state callbacks without
321  *                                        invoking the @startup callback from
322  *                                        a cpus_read_lock() held region
323  *                             callbacks
324  * @state:      The state for which the calls are installed
325  * @name:       Name of the callback.
326  * @startup:    startup callback function or NULL if not required
327  * @teardown:   teardown callback function or NULL if not required
328  *
329  * Same as cpuhp_setup_state_nocalls() except that it must be invoked from
330  * within a cpus_read_lock() held region.
331  */
332 static inline int cpuhp_setup_state_nocalls_cpuslocked(enum cpuhp_state state,
333                                                      const char *name,
334                                                      int (*startup)(unsigned int cpu),
335                                                      int (*teardown)(unsigned int cpu))
336 {
337         return __cpuhp_setup_state_cpuslocked(state, name, false, startup,
338                                             teardown, false);
339 }
340
341 /**
342  * cpuhp_setup_state_multi - Add callbacks for multi state
343  * @state:      The state for which the calls are installed
344  * @name:       Name of the callback.
345  * @startup:    startup callback function or NULL if not required
346  * @teardown:   teardown callback function or NULL if not required
347  *
348  * Sets the internal multi_instance flag and prepares a state to work as a multi
349  * instance callback. No callbacks are invoked at this point. The callbacks are
350  * invoked once an instance for this state are registered via
351  * cpuhp_state_add_instance() or cpuhp_state_add_instance_nocalls()
352  */
353 static inline int cpuhp_setup_state_multi(enum cpuhp_state state,
354                                           const char *name,
355                                           int (*startup)(unsigned int cpu,
356                                                          struct hlist_node *node),
357                                           int (*teardown)(unsigned int cpu,
358                                                           struct hlist_node *node))
359 {
360         return __cpuhp_setup_state(state, name, false,
361                                    (void *) startup,
362                                    (void *) teardown, true);
363 }
364
365 int __cpuhp_state_add_instance(enum cpuhp_state state, struct hlist_node *node,
366                                bool invoke);
367 int __cpuhp_state_add_instance_cpuslocked(enum cpuhp_state state,
368                                           struct hlist_node *node, bool invoke);
369
370 /**
371  * cpuhp_state_add_instance - Add an instance for a state and invoke startup
372  *                            callback.
373  * @state:      The state for which the instance is installed
374  * @node:       The node for this individual state.
375  *
376  * Installs the instance for the @state and invokes the registered startup
377  * callback on the online cpus which have already reached the @state. The
378  * @state must have been earlier marked as multi-instance by
379  * cpuhp_setup_state_multi().
380  */
381 static inline int cpuhp_state_add_instance(enum cpuhp_state state,
382                                            struct hlist_node *node)
383 {
384         return __cpuhp_state_add_instance(state, node, true);
385 }
386
387 /**
388  * cpuhp_state_add_instance_nocalls - Add an instance for a state without
389  *                                    invoking the startup callback.
390  * @state:      The state for which the instance is installed
391  * @node:       The node for this individual state.
392  *
393  * Installs the instance for the @state. The @state must have been earlier
394  * marked as multi-instance by cpuhp_setup_state_multi. NOP if SMP=n or
395  * HOTPLUG_CPU=n.
396  */
397 static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state,
398                                                    struct hlist_node *node)
399 {
400         return __cpuhp_state_add_instance(state, node, false);
401 }
402
403 /**
404  * cpuhp_state_add_instance_nocalls_cpuslocked - Add an instance for a state
405  *                                               without invoking the startup
406  *                                               callback from a cpus_read_lock()
407  *                                               held region.
408  * @state:      The state for which the instance is installed
409  * @node:       The node for this individual state.
410  *
411  * Same as cpuhp_state_add_instance_nocalls() except that it must be
412  * invoked from within a cpus_read_lock() held region.
413  */
414 static inline int
415 cpuhp_state_add_instance_nocalls_cpuslocked(enum cpuhp_state state,
416                                             struct hlist_node *node)
417 {
418         return __cpuhp_state_add_instance_cpuslocked(state, node, false);
419 }
420
421 void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
422 void __cpuhp_remove_state_cpuslocked(enum cpuhp_state state, bool invoke);
423
424 /**
425  * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
426  * @state:      The state for which the calls are removed
427  *
428  * Removes the callback functions and invokes the teardown callback on
429  * the online cpus which have already reached the @state.
430  */
431 static inline void cpuhp_remove_state(enum cpuhp_state state)
432 {
433         __cpuhp_remove_state(state, true);
434 }
435
436 /**
437  * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
438  *                              the teardown callback
439  * @state:      The state for which the calls are removed
440  */
441 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
442 {
443         __cpuhp_remove_state(state, false);
444 }
445
446 /**
447  * cpuhp_remove_state_nocalls_cpuslocked - Remove hotplug state callbacks without invoking
448  *                                         teardown from a cpus_read_lock() held region.
449  * @state:      The state for which the calls are removed
450  *
451  * Same as cpuhp_remove_state nocalls() except that it must be invoked
452  * from within a cpus_read_lock() held region.
453  */
454 static inline void cpuhp_remove_state_nocalls_cpuslocked(enum cpuhp_state state)
455 {
456         __cpuhp_remove_state_cpuslocked(state, false);
457 }
458
459 /**
460  * cpuhp_remove_multi_state - Remove hotplug multi state callback
461  * @state:      The state for which the calls are removed
462  *
463  * Removes the callback functions from a multi state. This is the reverse of
464  * cpuhp_setup_state_multi(). All instances should have been removed before
465  * invoking this function.
466  */
467 static inline void cpuhp_remove_multi_state(enum cpuhp_state state)
468 {
469         __cpuhp_remove_state(state, false);
470 }
471
472 int __cpuhp_state_remove_instance(enum cpuhp_state state,
473                                   struct hlist_node *node, bool invoke);
474
475 /**
476  * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
477  *                               the teardown callback
478  * @state:      The state from which the instance is removed
479  * @node:       The node for this individual state.
480  *
481  * Removes the instance and invokes the teardown callback on the online cpus
482  * which have already reached @state.
483  */
484 static inline int cpuhp_state_remove_instance(enum cpuhp_state state,
485                                               struct hlist_node *node)
486 {
487         return __cpuhp_state_remove_instance(state, node, true);
488 }
489
490 /**
491  * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
492  *                                       without invoking the teardown callback
493  * @state:      The state from which the instance is removed
494  * @node:       The node for this individual state.
495  *
496  * Removes the instance without invoking the teardown callback.
497  */
498 static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state,
499                                                       struct hlist_node *node)
500 {
501         return __cpuhp_state_remove_instance(state, node, false);
502 }
503
504 #ifdef CONFIG_SMP
505 void cpuhp_online_idle(enum cpuhp_state state);
506 #else
507 static inline void cpuhp_online_idle(enum cpuhp_state state) { }
508 #endif
509
510 #endif