include/linux/cpuhotplug.h

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