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