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