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