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