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