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