include/linux/cpuhotplug.h

   1 #ifndef __CPUHOTPLUG_H
   2 #define __CPUHOTPLUG_H
   3
   4 #include <linux/types.h>
   5
   6 /*
   7  * CPU-up                       CPU-down
   8  *
   9  * BP           AP              BP              AP
  10  *
  11  * OFFLINE                      OFFLINE
  12  *   |                            ^
  13  *   v                            |
  14  * BRINGUP_CPU->AP_OFFLINE      BRINGUP_CPU  <- AP_IDLE_DEAD (idle thread/play_dead)
  15  *                |                             AP_OFFLINE
  16  *                v (IRQ-off)     ,---------------^
  17  *              AP_ONLNE          | (stop_machine)
  18  *                |             TEARDOWN_CPU <- AP_ONLINE_IDLE
  19  *                |                               ^
  20  *                v                               |
  21  *              AP_ACTIVE                       AP_ACTIVE
  22  */
  23
  24 enum cpuhp_state {
  25         CPUHP_INVALID = -1,
  26         CPUHP_OFFLINE = 0,
  27         CPUHP_CREATE_THREADS,
  28         CPUHP_PERF_PREPARE,
  29         CPUHP_PERF_X86_PREPARE,
  30         CPUHP_PERF_X86_AMD_UNCORE_PREP,
  31         CPUHP_PERF_BFIN,
  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_WORKQUEUE_PREP,
  62         CPUHP_POWER_NUMA_PREPARE,
  63         CPUHP_HRTIMERS_PREPARE,
  64         CPUHP_PROFILE_PREPARE,
  65         CPUHP_X2APIC_PREPARE,
  66         CPUHP_SMPCFD_PREPARE,
  67         CPUHP_RELAY_PREPARE,
  68         CPUHP_SLAB_PREPARE,
  69         CPUHP_MD_RAID5_PREPARE,
  70         CPUHP_RCUTREE_PREP,
  71         CPUHP_CPUIDLE_COUPLED_PREPARE,
  72         CPUHP_POWERPC_PMAC_PREPARE,
  73         CPUHP_POWERPC_MMU_CTX_PREPARE,
  74         CPUHP_XEN_PREPARE,
  75         CPUHP_XEN_EVTCHN_PREPARE,
  76         CPUHP_ARM_SHMOBILE_SCU_PREPARE,
  77         CPUHP_SH_SH3X_PREPARE,
  78         CPUHP_NET_FLOW_PREPARE,
  79         CPUHP_TOPOLOGY_PREPARE,
  80         CPUHP_NET_IUCV_PREPARE,
  81         CPUHP_ARM_BL_PREPARE,
  82         CPUHP_TRACE_RB_PREPARE,
  83         CPUHP_MM_ZS_PREPARE,
  84         CPUHP_MM_ZSWP_MEM_PREPARE,
  85         CPUHP_MM_ZSWP_POOL_PREPARE,
  86         CPUHP_KVM_PPC_BOOK3S_PREPARE,
  87         CPUHP_ZCOMP_PREPARE,
  88         CPUHP_TIMERS_DEAD,
  89         CPUHP_MIPS_SOC_PREPARE,
  90         CPUHP_BP_PREPARE_DYN,
  91         CPUHP_BP_PREPARE_DYN_END                = CPUHP_BP_PREPARE_DYN + 20,
  92         CPUHP_BRINGUP_CPU,
  93         CPUHP_AP_IDLE_DEAD,
  94         CPUHP_AP_OFFLINE,
  95         CPUHP_AP_SCHED_STARTING,
  96         CPUHP_AP_RCUTREE_DYING,
  97         CPUHP_AP_IRQ_GIC_STARTING,
  98         CPUHP_AP_IRQ_HIP04_STARTING,
  99         CPUHP_AP_IRQ_ARMADA_XP_STARTING,
 100         CPUHP_AP_IRQ_BCM2836_STARTING,
 101         CPUHP_AP_ARM_MVEBU_COHERENCY,
 102         CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING,
 103         CPUHP_AP_PERF_X86_STARTING,
 104         CPUHP_AP_PERF_X86_AMD_IBS_STARTING,
 105         CPUHP_AP_PERF_X86_CQM_STARTING,
 106         CPUHP_AP_PERF_X86_CSTATE_STARTING,
 107         CPUHP_AP_PERF_XTENSA_STARTING,
 108         CPUHP_AP_PERF_METAG_STARTING,
 109         CPUHP_AP_MIPS_OP_LOONGSON3_STARTING,
 110         CPUHP_AP_ARM_VFP_STARTING,
 111         CPUHP_AP_ARM64_DEBUG_MONITORS_STARTING,
 112         CPUHP_AP_PERF_ARM_HW_BREAKPOINT_STARTING,
 113         CPUHP_AP_PERF_ARM_ACPI_STARTING,
 114         CPUHP_AP_PERF_ARM_STARTING,
 115         CPUHP_AP_ARM_L2X0_STARTING,
 116         CPUHP_AP_ARM_ARCH_TIMER_STARTING,
 117         CPUHP_AP_ARM_GLOBAL_TIMER_STARTING,
 118         CPUHP_AP_JCORE_TIMER_STARTING,
 119         CPUHP_AP_EXYNOS4_MCT_TIMER_STARTING,
 120         CPUHP_AP_ARM_TWD_STARTING,
 121         CPUHP_AP_METAG_TIMER_STARTING,
 122         CPUHP_AP_QCOM_TIMER_STARTING,
 123         CPUHP_AP_ARMADA_TIMER_STARTING,
 124         CPUHP_AP_MARCO_TIMER_STARTING,
 125         CPUHP_AP_MIPS_GIC_TIMER_STARTING,
 126         CPUHP_AP_ARC_TIMER_STARTING,
 127         CPUHP_AP_KVM_STARTING,
 128         CPUHP_AP_KVM_ARM_VGIC_INIT_STARTING,
 129         CPUHP_AP_KVM_ARM_VGIC_STARTING,
 130         CPUHP_AP_KVM_ARM_TIMER_STARTING,
 131         /* Must be the last timer callback */
 132         CPUHP_AP_DUMMY_TIMER_STARTING,
 133         CPUHP_AP_ARM_XEN_STARTING,
 134         CPUHP_AP_ARM_CORESIGHT_STARTING,
 135         CPUHP_AP_ARM64_ISNDEP_STARTING,
 136         CPUHP_AP_SMPCFD_DYING,
 137         CPUHP_AP_X86_TBOOT_DYING,
 138         CPUHP_AP_ONLINE,
 139         CPUHP_TEARDOWN_CPU,
 140         CPUHP_AP_ONLINE_IDLE,
 141         CPUHP_AP_SMPBOOT_THREADS,
 142         CPUHP_AP_X86_VDSO_VMA_ONLINE,
 143         CPUHP_AP_IRQ_AFFINITY_ONLINE,
 144         CPUHP_AP_PERF_ONLINE,
 145         CPUHP_AP_PERF_X86_ONLINE,
 146         CPUHP_AP_PERF_X86_UNCORE_ONLINE,
 147         CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
 148         CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
 149         CPUHP_AP_PERF_X86_RAPL_ONLINE,
 150         CPUHP_AP_PERF_X86_CQM_ONLINE,
 151         CPUHP_AP_PERF_X86_CSTATE_ONLINE,
 152         CPUHP_AP_PERF_S390_CF_ONLINE,
 153         CPUHP_AP_PERF_S390_SF_ONLINE,
 154         CPUHP_AP_PERF_ARM_CCI_ONLINE,
 155         CPUHP_AP_PERF_ARM_CCN_ONLINE,
 156         CPUHP_AP_PERF_ARM_L2X0_ONLINE,
 157         CPUHP_AP_PERF_ARM_QCOM_L2_ONLINE,
 158         CPUHP_AP_PERF_ARM_QCOM_L3_ONLINE,
 159         CPUHP_AP_PERF_POWERPC_NEST_IMC_ONLINE,
 160         CPUHP_AP_PERF_POWERPC_CORE_IMC_ONLINE,
 161         CPUHP_AP_PERF_POWERPC_THREAD_IMC_ONLINE,
 162         CPUHP_AP_WORKQUEUE_ONLINE,
 163         CPUHP_AP_RCUTREE_ONLINE,
 164         CPUHP_AP_ONLINE_DYN,
 165         CPUHP_AP_ONLINE_DYN_END         = CPUHP_AP_ONLINE_DYN + 30,
 166         CPUHP_AP_X86_HPET_ONLINE,
 167         CPUHP_AP_X86_KVM_CLK_ONLINE,
 168         CPUHP_AP_ACTIVE,
 169         CPUHP_ONLINE,
 170 };
 171
 172 int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
 173                         int (*startup)(unsigned int cpu),
 174                         int (*teardown)(unsigned int cpu), bool multi_instance);
 175
 176 int __cpuhp_setup_state_cpuslocked(enum cpuhp_state state, const char *name,
 177                                    bool invoke,
 178                                    int (*startup)(unsigned int cpu),
 179                                    int (*teardown)(unsigned int cpu),
 180                                    bool multi_instance);
 181 /**
 182  * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
 183  * @state:      The state for which the calls are installed
 184  * @name:       Name of the callback (will be used in debug output)
 185  * @startup:    startup callback function
 186  * @teardown:   teardown callback function
 187  *
 188  * Installs the callback functions and invokes the startup callback on
 189  * the present cpus which have already reached the @state.
 190  */
 191 static inline int cpuhp_setup_state(enum cpuhp_state state,
 192                                     const char *name,
 193                                     int (*startup)(unsigned int cpu),
 194                                     int (*teardown)(unsigned int cpu))
 195 {
 196         return __cpuhp_setup_state(state, name, true, startup, teardown, false);
 197 }
 198
 199 static inline int cpuhp_setup_state_cpuslocked(enum cpuhp_state state,
 200                                                const char *name,
 201                                                int (*startup)(unsigned int cpu),
 202                                                int (*teardown)(unsigned int cpu))
 203 {
 204         return __cpuhp_setup_state_cpuslocked(state, name, true, startup,
 205                                               teardown, false);
 206 }
 207
 208 /**
 209  * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
 210  *                             callbacks
 211  * @state:      The state for which the calls are installed
 212  * @name:       Name of the callback.
 213  * @startup:    startup callback function
 214  * @teardown:   teardown callback function
 215  *
 216  * Same as @cpuhp_setup_state except that no calls are executed are invoked
 217  * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
 218  */
 219 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
 220                                             const char *name,
 221                                             int (*startup)(unsigned int cpu),
 222                                             int (*teardown)(unsigned int cpu))
 223 {
 224         return __cpuhp_setup_state(state, name, false, startup, teardown,
 225                                    false);
 226 }
 227
 228 static inline int cpuhp_setup_state_nocalls_cpuslocked(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_cpuslocked(state, name, false, startup,
 234                                             teardown, false);
 235 }
 236
 237 /**
 238  * cpuhp_setup_state_multi - Add callbacks for multi state
 239  * @state:      The state for which the calls are installed
 240  * @name:       Name of the callback.
 241  * @startup:    startup callback function
 242  * @teardown:   teardown callback function
 243  *
 244  * Sets the internal multi_instance flag and prepares a state to work as a multi
 245  * instance callback. No callbacks are invoked at this point. The callbacks are
 246  * invoked once an instance for this state are registered via
 247  * @cpuhp_state_add_instance or @cpuhp_state_add_instance_nocalls.
 248  */
 249 static inline int cpuhp_setup_state_multi(enum cpuhp_state state,
 250                                           const char *name,
 251                                           int (*startup)(unsigned int cpu,
 252                                                          struct hlist_node *node),
 253                                           int (*teardown)(unsigned int cpu,
 254                                                           struct hlist_node *node))
 255 {
 256         return __cpuhp_setup_state(state, name, false,
 257                                    (void *) startup,
 258                                    (void *) teardown, true);
 259 }
 260
 261 int __cpuhp_state_add_instance(enum cpuhp_state state, struct hlist_node *node,
 262                                bool invoke);
 263 int __cpuhp_state_add_instance_cpuslocked(enum cpuhp_state state,
 264                                           struct hlist_node *node, bool invoke);
 265
 266 /**
 267  * cpuhp_state_add_instance - Add an instance for a state and invoke startup
 268  *                            callback.
 269  * @state:      The state for which the instance is installed
 270  * @node:       The node for this individual state.
 271  *
 272  * Installs the instance for the @state and invokes the startup callback on
 273  * the present cpus which have already reached the @state. The @state must have
 274  * been earlier marked as multi-instance by @cpuhp_setup_state_multi.
 275  */
 276 static inline int cpuhp_state_add_instance(enum cpuhp_state state,
 277                                            struct hlist_node *node)
 278 {
 279         return __cpuhp_state_add_instance(state, node, true);
 280 }
 281
 282 /**
 283  * cpuhp_state_add_instance_nocalls - Add an instance for a state without
 284  *                                    invoking the startup callback.
 285  * @state:      The state for which the instance is installed
 286  * @node:       The node for this individual state.
 287  *
 288  * Installs the instance for the @state The @state must have been earlier
 289  * marked as multi-instance by @cpuhp_setup_state_multi.
 290  */
 291 static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state,
 292                                                    struct hlist_node *node)
 293 {
 294         return __cpuhp_state_add_instance(state, node, false);
 295 }
 296
 297 static inline int
 298 cpuhp_state_add_instance_nocalls_cpuslocked(enum cpuhp_state state,
 299                                             struct hlist_node *node)
 300 {
 301         return __cpuhp_state_add_instance_cpuslocked(state, node, false);
 302 }
 303
 304 void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
 305 void __cpuhp_remove_state_cpuslocked(enum cpuhp_state state, bool invoke);
 306
 307 /**
 308  * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
 309  * @state:      The state for which the calls are removed
 310  *
 311  * Removes the callback functions and invokes the teardown callback on
 312  * the present cpus which have already reached the @state.
 313  */
 314 static inline void cpuhp_remove_state(enum cpuhp_state state)
 315 {
 316         __cpuhp_remove_state(state, true);
 317 }
 318
 319 /**
 320  * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
 321  *                              teardown
 322  * @state:      The state for which the calls are removed
 323  */
 324 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
 325 {
 326         __cpuhp_remove_state(state, false);
 327 }
 328
 329 static inline void cpuhp_remove_state_nocalls_cpuslocked(enum cpuhp_state state)
 330 {
 331         __cpuhp_remove_state_cpuslocked(state, false);
 332 }
 333
 334 /**
 335  * cpuhp_remove_multi_state - Remove hotplug multi state callback
 336  * @state:      The state for which the calls are removed
 337  *
 338  * Removes the callback functions from a multi state. This is the reverse of
 339  * cpuhp_setup_state_multi(). All instances should have been removed before
 340  * invoking this function.
 341  */
 342 static inline void cpuhp_remove_multi_state(enum cpuhp_state state)
 343 {
 344         __cpuhp_remove_state(state, false);
 345 }
 346
 347 int __cpuhp_state_remove_instance(enum cpuhp_state state,
 348                                   struct hlist_node *node, bool invoke);
 349
 350 /**
 351  * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
 352  *                               the teardown callback
 353  * @state:      The state from which the instance is removed
 354  * @node:       The node for this individual state.
 355  *
 356  * Removes the instance and invokes the teardown callback on the present cpus
 357  * which have already reached the @state.
 358  */
 359 static inline int cpuhp_state_remove_instance(enum cpuhp_state state,
 360                                               struct hlist_node *node)
 361 {
 362         return __cpuhp_state_remove_instance(state, node, true);
 363 }
 364
 365 /**
 366  * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
 367  *                                       without invoking the reatdown callback
 368  * @state:      The state from which the instance is removed
 369  * @node:       The node for this individual state.
 370  *
 371  * Removes the instance without invoking the teardown callback.
 372  */
 373 static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state,
 374                                                       struct hlist_node *node)
 375 {
 376         return __cpuhp_state_remove_instance(state, node, false);
 377 }
 378
 379 #ifdef CONFIG_SMP
 380 void cpuhp_online_idle(enum cpuhp_state state);
 381 #else
 382 static inline void cpuhp_online_idle(enum cpuhp_state state) { }
 383 #endif
 384
 385 #endif