include/linux/cpuhotplug.h

   1 #ifndef __CPUHOTPLUG_H
   2 #define __CPUHOTPLUG_H
   3
   4 #include <linux/types.h>
   5
   6 enum cpuhp_state {
   7         CPUHP_OFFLINE,
   8         CPUHP_CREATE_THREADS,
   9         CPUHP_PERF_PREPARE,
  10         CPUHP_PERF_X86_PREPARE,
  11         CPUHP_PERF_X86_UNCORE_PREP,
  12         CPUHP_PERF_X86_AMD_UNCORE_PREP,
  13         CPUHP_PERF_X86_RAPL_PREP,
  14         CPUHP_PERF_BFIN,
  15         CPUHP_PERF_POWER,
  16         CPUHP_PERF_SUPERH,
  17         CPUHP_X86_HPET_DEAD,
  18         CPUHP_X86_APB_DEAD,
  19         CPUHP_X86_MCE_DEAD,
  20         CPUHP_VIRT_NET_DEAD,
  21         CPUHP_SLUB_DEAD,
  22         CPUHP_MM_WRITEBACK_DEAD,
  23         CPUHP_MM_VMSTAT_DEAD,
  24         CPUHP_SOFTIRQ_DEAD,
  25         CPUHP_NET_MVNETA_DEAD,
  26         CPUHP_CPUIDLE_DEAD,
  27         CPUHP_ARM64_FPSIMD_DEAD,
  28         CPUHP_ARM_OMAP_WAKE_DEAD,
  29         CPUHP_IRQ_POLL_DEAD,
  30         CPUHP_BLOCK_SOFTIRQ_DEAD,
  31         CPUHP_VIRT_SCSI_DEAD,
  32         CPUHP_ACPI_CPUDRV_DEAD,
  33         CPUHP_S390_PFAULT_DEAD,
  34         CPUHP_BLK_MQ_DEAD,
  35         CPUHP_FS_BUFF_DEAD,
  36         CPUHP_PRINTK_DEAD,
  37         CPUHP_MM_MEMCQ_DEAD,
  38         CPUHP_PERCPU_CNT_DEAD,
  39         CPUHP_RADIX_DEAD,
  40         CPUHP_PAGE_ALLOC_DEAD,
  41         CPUHP_NET_DEV_DEAD,
  42         CPUHP_PCI_XGENE_DEAD,
  43         CPUHP_WORKQUEUE_PREP,
  44         CPUHP_POWER_NUMA_PREPARE,
  45         CPUHP_HRTIMERS_PREPARE,
  46         CPUHP_PROFILE_PREPARE,
  47         CPUHP_X2APIC_PREPARE,
  48         CPUHP_SMPCFD_PREPARE,
  49         CPUHP_RELAY_PREPARE,
  50         CPUHP_SLAB_PREPARE,
  51         CPUHP_MD_RAID5_PREPARE,
  52         CPUHP_RCUTREE_PREP,
  53         CPUHP_CPUIDLE_COUPLED_PREPARE,
  54         CPUHP_POWERPC_PMAC_PREPARE,
  55         CPUHP_POWERPC_MMU_CTX_PREPARE,
  56         CPUHP_XEN_PREPARE,
  57         CPUHP_XEN_EVTCHN_PREPARE,
  58         CPUHP_NOTIFY_PREPARE,
  59         CPUHP_ARM_SHMOBILE_SCU_PREPARE,
  60         CPUHP_SH_SH3X_PREPARE,
  61         CPUHP_BLK_MQ_PREPARE,
  62         CPUHP_NET_FLOW_PREPARE,
  63         CPUHP_TOPOLOGY_PREPARE,
  64         CPUHP_NET_IUCV_PREPARE,
  65         CPUHP_ARM_BL_PREPARE,
  66         CPUHP_TRACE_RB_PREPARE,
  67         CPUHP_MM_ZS_PREPARE,
  68         CPUHP_MM_ZSWP_MEM_PREPARE,
  69         CPUHP_TIMERS_DEAD,
  70         CPUHP_NOTF_ERR_INJ_PREPARE,
  71         CPUHP_MIPS_SOC_PREPARE,
  72         CPUHP_BRINGUP_CPU,
  73         CPUHP_AP_IDLE_DEAD,
  74         CPUHP_AP_OFFLINE,
  75         CPUHP_AP_SCHED_STARTING,
  76         CPUHP_AP_RCUTREE_DYING,
  77         CPUHP_AP_IRQ_GIC_STARTING,
  78         CPUHP_AP_IRQ_GICV3_STARTING,
  79         CPUHP_AP_IRQ_HIP04_STARTING,
  80         CPUHP_AP_IRQ_ARMADA_XP_STARTING,
  81         CPUHP_AP_IRQ_ARMADA_CASC_STARTING,
  82         CPUHP_AP_IRQ_BCM2836_STARTING,
  83         CPUHP_AP_ARM_MVEBU_COHERENCY,
  84         CPUHP_AP_PERF_X86_UNCORE_STARTING,
  85         CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING,
  86         CPUHP_AP_PERF_X86_STARTING,
  87         CPUHP_AP_PERF_X86_AMD_IBS_STARTING,
  88         CPUHP_AP_PERF_X86_CQM_STARTING,
  89         CPUHP_AP_PERF_X86_CSTATE_STARTING,
  90         CPUHP_AP_PERF_XTENSA_STARTING,
  91         CPUHP_AP_PERF_METAG_STARTING,
  92         CPUHP_AP_MIPS_OP_LOONGSON3_STARTING,
  93         CPUHP_AP_ARM_VFP_STARTING,
  94         CPUHP_AP_ARM64_DEBUG_MONITORS_STARTING,
  95         CPUHP_AP_PERF_ARM_HW_BREAKPOINT_STARTING,
  96         CPUHP_AP_PERF_ARM_STARTING,
  97         CPUHP_AP_ARM_L2X0_STARTING,
  98         CPUHP_AP_ARM_ARCH_TIMER_STARTING,
  99         CPUHP_AP_ARM_GLOBAL_TIMER_STARTING,
 100         CPUHP_AP_DUMMY_TIMER_STARTING,
 101         CPUHP_AP_JCORE_TIMER_STARTING,
 102         CPUHP_AP_EXYNOS4_MCT_TIMER_STARTING,
 103         CPUHP_AP_ARM_TWD_STARTING,
 104         CPUHP_AP_METAG_TIMER_STARTING,
 105         CPUHP_AP_QCOM_TIMER_STARTING,
 106         CPUHP_AP_ARMADA_TIMER_STARTING,
 107         CPUHP_AP_MARCO_TIMER_STARTING,
 108         CPUHP_AP_MIPS_GIC_TIMER_STARTING,
 109         CPUHP_AP_ARC_TIMER_STARTING,
 110         CPUHP_AP_KVM_STARTING,
 111         CPUHP_AP_KVM_ARM_VGIC_INIT_STARTING,
 112         CPUHP_AP_KVM_ARM_VGIC_STARTING,
 113         CPUHP_AP_KVM_ARM_TIMER_STARTING,
 114         CPUHP_AP_ARM_XEN_STARTING,
 115         CPUHP_AP_ARM_CORESIGHT_STARTING,
 116         CPUHP_AP_ARM_CORESIGHT4_STARTING,
 117         CPUHP_AP_ARM64_ISNDEP_STARTING,
 118         CPUHP_AP_SMPCFD_DYING,
 119         CPUHP_AP_X86_TBOOT_DYING,
 120         CPUHP_AP_ONLINE,
 121         CPUHP_TEARDOWN_CPU,
 122         CPUHP_AP_ONLINE_IDLE,
 123         CPUHP_AP_SMPBOOT_THREADS,
 124         CPUHP_AP_X86_VDSO_VMA_ONLINE,
 125         CPUHP_AP_PERF_ONLINE,
 126         CPUHP_AP_PERF_X86_ONLINE,
 127         CPUHP_AP_PERF_X86_UNCORE_ONLINE,
 128         CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
 129         CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
 130         CPUHP_AP_PERF_X86_RAPL_ONLINE,
 131         CPUHP_AP_PERF_X86_CQM_ONLINE,
 132         CPUHP_AP_PERF_X86_CSTATE_ONLINE,
 133         CPUHP_AP_PERF_S390_CF_ONLINE,
 134         CPUHP_AP_PERF_S390_SF_ONLINE,
 135         CPUHP_AP_PERF_ARM_CCI_ONLINE,
 136         CPUHP_AP_PERF_ARM_CCN_ONLINE,
 137         CPUHP_AP_PERF_ARM_L2X0_ONLINE,
 138         CPUHP_AP_WORKQUEUE_ONLINE,
 139         CPUHP_AP_RCUTREE_ONLINE,
 140         CPUHP_AP_NOTIFY_ONLINE,
 141         CPUHP_AP_ONLINE_DYN,
 142         CPUHP_AP_ONLINE_DYN_END         = CPUHP_AP_ONLINE_DYN + 30,
 143         CPUHP_AP_X86_HPET_ONLINE,
 144         CPUHP_AP_X86_KVM_CLK_ONLINE,
 145         CPUHP_AP_ACTIVE,
 146         CPUHP_ONLINE,
 147 };
 148
 149 int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
 150                         int (*startup)(unsigned int cpu),
 151                         int (*teardown)(unsigned int cpu), bool multi_instance);
 152
 153 /**
 154  * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
 155  * @state:      The state for which the calls are installed
 156  * @name:       Name of the callback (will be used in debug output)
 157  * @startup:    startup callback function
 158  * @teardown:   teardown callback function
 159  *
 160  * Installs the callback functions and invokes the startup callback on
 161  * the present cpus which have already reached the @state.
 162  */
 163 static inline int cpuhp_setup_state(enum cpuhp_state state,
 164                                     const char *name,
 165                                     int (*startup)(unsigned int cpu),
 166                                     int (*teardown)(unsigned int cpu))
 167 {
 168         return __cpuhp_setup_state(state, name, true, startup, teardown, false);
 169 }
 170
 171 /**
 172  * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
 173  *                             callbacks
 174  * @state:      The state for which the calls are installed
 175  * @name:       Name of the callback.
 176  * @startup:    startup callback function
 177  * @teardown:   teardown callback function
 178  *
 179  * Same as @cpuhp_setup_state except that no calls are executed are invoked
 180  * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
 181  */
 182 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
 183                                             const char *name,
 184                                             int (*startup)(unsigned int cpu),
 185                                             int (*teardown)(unsigned int cpu))
 186 {
 187         return __cpuhp_setup_state(state, name, false, startup, teardown,
 188                                    false);
 189 }
 190
 191 /**
 192  * cpuhp_setup_state_multi - Add callbacks for multi state
 193  * @state:      The state for which the calls are installed
 194  * @name:       Name of the callback.
 195  * @startup:    startup callback function
 196  * @teardown:   teardown callback function
 197  *
 198  * Sets the internal multi_instance flag and prepares a state to work as a multi
 199  * instance callback. No callbacks are invoked at this point. The callbacks are
 200  * invoked once an instance for this state are registered via
 201  * @cpuhp_state_add_instance or @cpuhp_state_add_instance_nocalls.
 202  */
 203 static inline int cpuhp_setup_state_multi(enum cpuhp_state state,
 204                                           const char *name,
 205                                           int (*startup)(unsigned int cpu,
 206                                                          struct hlist_node *node),
 207                                           int (*teardown)(unsigned int cpu,
 208                                                           struct hlist_node *node))
 209 {
 210         return __cpuhp_setup_state(state, name, false,
 211                                    (void *) startup,
 212                                    (void *) teardown, true);
 213 }
 214
 215 int __cpuhp_state_add_instance(enum cpuhp_state state, struct hlist_node *node,
 216                                bool invoke);
 217
 218 /**
 219  * cpuhp_state_add_instance - Add an instance for a state and invoke startup
 220  *                            callback.
 221  * @state:      The state for which the instance is installed
 222  * @node:       The node for this individual state.
 223  *
 224  * Installs the instance for the @state and invokes the startup callback on
 225  * the present cpus which have already reached the @state. The @state must have
 226  * been earlier marked as multi-instance by @cpuhp_setup_state_multi.
 227  */
 228 static inline int cpuhp_state_add_instance(enum cpuhp_state state,
 229                                            struct hlist_node *node)
 230 {
 231         return __cpuhp_state_add_instance(state, node, true);
 232 }
 233
 234 /**
 235  * cpuhp_state_add_instance_nocalls - Add an instance for a state without
 236  *                                    invoking the startup callback.
 237  * @state:      The state for which the instance is installed
 238  * @node:       The node for this individual state.
 239  *
 240  * Installs the instance for the @state The @state must have been earlier
 241  * marked as multi-instance by @cpuhp_setup_state_multi.
 242  */
 243 static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state,
 244                                                    struct hlist_node *node)
 245 {
 246         return __cpuhp_state_add_instance(state, node, false);
 247 }
 248
 249 void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
 250
 251 /**
 252  * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
 253  * @state:      The state for which the calls are removed
 254  *
 255  * Removes the callback functions and invokes the teardown callback on
 256  * the present cpus which have already reached the @state.
 257  */
 258 static inline void cpuhp_remove_state(enum cpuhp_state state)
 259 {
 260         __cpuhp_remove_state(state, true);
 261 }
 262
 263 /**
 264  * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
 265  *                              teardown
 266  * @state:      The state for which the calls are removed
 267  */
 268 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
 269 {
 270         __cpuhp_remove_state(state, false);
 271 }
 272
 273 /**
 274  * cpuhp_remove_multi_state - Remove hotplug multi state callback
 275  * @state:      The state for which the calls are removed
 276  *
 277  * Removes the callback functions from a multi state. This is the reverse of
 278  * cpuhp_setup_state_multi(). All instances should have been removed before
 279  * invoking this function.
 280  */
 281 static inline void cpuhp_remove_multi_state(enum cpuhp_state state)
 282 {
 283         __cpuhp_remove_state(state, false);
 284 }
 285
 286 int __cpuhp_state_remove_instance(enum cpuhp_state state,
 287                                   struct hlist_node *node, bool invoke);
 288
 289 /**
 290  * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
 291  *                               the teardown callback
 292  * @state:      The state from which the instance is removed
 293  * @node:       The node for this individual state.
 294  *
 295  * Removes the instance and invokes the teardown callback on the present cpus
 296  * which have already reached the @state.
 297  */
 298 static inline int cpuhp_state_remove_instance(enum cpuhp_state state,
 299                                               struct hlist_node *node)
 300 {
 301         return __cpuhp_state_remove_instance(state, node, true);
 302 }
 303
 304 /**
 305  * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
 306  *                                       without invoking the reatdown callback
 307  * @state:      The state from which the instance is removed
 308  * @node:       The node for this individual state.
 309  *
 310  * Removes the instance without invoking the teardown callback.
 311  */
 312 static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state,
 313                                                       struct hlist_node *node)
 314 {
 315         return __cpuhp_state_remove_instance(state, node, false);
 316 }
 317
 318 #ifdef CONFIG_SMP
 319 void cpuhp_online_idle(enum cpuhp_state state);
 320 #else
 321 static inline void cpuhp_online_idle(enum cpuhp_state state) { }
 322 #endif
 323
 324 #endif