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_PERF_ARM_L2X0_ONLINE,
 118         CPUHP_AP_WORKQUEUE_ONLINE,
 119         CPUHP_AP_RCUTREE_ONLINE,
 120         CPUHP_AP_NOTIFY_ONLINE,
 121         CPUHP_AP_ONLINE_DYN,
 122         CPUHP_AP_ONLINE_DYN_END         = CPUHP_AP_ONLINE_DYN + 30,
 123         CPUHP_AP_X86_HPET_ONLINE,
 124         CPUHP_AP_X86_KVM_CLK_ONLINE,
 125         CPUHP_AP_ACTIVE,
 126         CPUHP_ONLINE,
 127 };
 128
 129 int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
 130                         int (*startup)(unsigned int cpu),
 131                         int (*teardown)(unsigned int cpu), bool multi_instance);
 132
 133 /**
 134  * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
 135  * @state:      The state for which the calls are installed
 136  * @name:       Name of the callback (will be used in debug output)
 137  * @startup:    startup callback function
 138  * @teardown:   teardown callback function
 139  *
 140  * Installs the callback functions and invokes the startup callback on
 141  * the present cpus which have already reached the @state.
 142  */
 143 static inline int cpuhp_setup_state(enum cpuhp_state state,
 144                                     const char *name,
 145                                     int (*startup)(unsigned int cpu),
 146                                     int (*teardown)(unsigned int cpu))
 147 {
 148         return __cpuhp_setup_state(state, name, true, startup, teardown, false);
 149 }
 150
 151 /**
 152  * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
 153  *                             callbacks
 154  * @state:      The state for which the calls are installed
 155  * @name:       Name of the callback.
 156  * @startup:    startup callback function
 157  * @teardown:   teardown callback function
 158  *
 159  * Same as @cpuhp_setup_state except that no calls are executed are invoked
 160  * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
 161  */
 162 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
 163                                             const char *name,
 164                                             int (*startup)(unsigned int cpu),
 165                                             int (*teardown)(unsigned int cpu))
 166 {
 167         return __cpuhp_setup_state(state, name, false, startup, teardown,
 168                                    false);
 169 }
 170
 171 /**
 172  * cpuhp_setup_state_multi - Add callbacks for multi state
 173  * @state:      The state for which the calls are installed
 174  * @name:       Name of the callback.
 175  * @startup:    startup callback function
 176  * @teardown:   teardown callback function
 177  *
 178  * Sets the internal multi_instance flag and prepares a state to work as a multi
 179  * instance callback. No callbacks are invoked at this point. The callbacks are
 180  * invoked once an instance for this state are registered via
 181  * @cpuhp_state_add_instance or @cpuhp_state_add_instance_nocalls.
 182  */
 183 static inline int cpuhp_setup_state_multi(enum cpuhp_state state,
 184                                           const char *name,
 185                                           int (*startup)(unsigned int cpu,
 186                                                          struct hlist_node *node),
 187                                           int (*teardown)(unsigned int cpu,
 188                                                           struct hlist_node *node))
 189 {
 190         return __cpuhp_setup_state(state, name, false,
 191                                    (void *) startup,
 192                                    (void *) teardown, true);
 193 }
 194
 195 int __cpuhp_state_add_instance(enum cpuhp_state state, struct hlist_node *node,
 196                                bool invoke);
 197
 198 /**
 199  * cpuhp_state_add_instance - Add an instance for a state and invoke startup
 200  *                            callback.
 201  * @state:      The state for which the instance is installed
 202  * @node:       The node for this individual state.
 203  *
 204  * Installs the instance for the @state and invokes the startup callback on
 205  * the present cpus which have already reached the @state. The @state must have
 206  * been earlier marked as multi-instance by @cpuhp_setup_state_multi.
 207  */
 208 static inline int cpuhp_state_add_instance(enum cpuhp_state state,
 209                                            struct hlist_node *node)
 210 {
 211         return __cpuhp_state_add_instance(state, node, true);
 212 }
 213
 214 /**
 215  * cpuhp_state_add_instance_nocalls - Add an instance for a state without
 216  *                                    invoking the startup callback.
 217  * @state:      The state for which the instance is installed
 218  * @node:       The node for this individual state.
 219  *
 220  * Installs the instance for the @state The @state must have been earlier
 221  * marked as multi-instance by @cpuhp_setup_state_multi.
 222  */
 223 static inline int cpuhp_state_add_instance_nocalls(enum cpuhp_state state,
 224                                                    struct hlist_node *node)
 225 {
 226         return __cpuhp_state_add_instance(state, node, false);
 227 }
 228
 229 void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
 230
 231 /**
 232  * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
 233  * @state:      The state for which the calls are removed
 234  *
 235  * Removes the callback functions and invokes the teardown callback on
 236  * the present cpus which have already reached the @state.
 237  */
 238 static inline void cpuhp_remove_state(enum cpuhp_state state)
 239 {
 240         __cpuhp_remove_state(state, true);
 241 }
 242
 243 /**
 244  * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
 245  *                              teardown
 246  * @state:      The state for which the calls are removed
 247  */
 248 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
 249 {
 250         __cpuhp_remove_state(state, false);
 251 }
 252
 253 /**
 254  * cpuhp_remove_multi_state - Remove hotplug multi state callback
 255  * @state:      The state for which the calls are removed
 256  *
 257  * Removes the callback functions from a multi state. This is the reverse of
 258  * cpuhp_setup_state_multi(). All instances should have been removed before
 259  * invoking this function.
 260  */
 261 static inline void cpuhp_remove_multi_state(enum cpuhp_state state)
 262 {
 263         __cpuhp_remove_state(state, false);
 264 }
 265
 266 int __cpuhp_state_remove_instance(enum cpuhp_state state,
 267                                   struct hlist_node *node, bool invoke);
 268
 269 /**
 270  * cpuhp_state_remove_instance - Remove hotplug instance from state and invoke
 271  *                               the teardown callback
 272  * @state:      The state from which the instance is removed
 273  * @node:       The node for this individual state.
 274  *
 275  * Removes the instance and invokes the teardown callback on the present cpus
 276  * which have already reached the @state.
 277  */
 278 static inline int cpuhp_state_remove_instance(enum cpuhp_state state,
 279                                               struct hlist_node *node)
 280 {
 281         return __cpuhp_state_remove_instance(state, node, true);
 282 }
 283
 284 /**
 285  * cpuhp_state_remove_instance_nocalls - Remove hotplug instance from state
 286  *                                       without invoking the reatdown callback
 287  * @state:      The state from which the instance is removed
 288  * @node:       The node for this individual state.
 289  *
 290  * Removes the instance without invoking the teardown callback.
 291  */
 292 static inline int cpuhp_state_remove_instance_nocalls(enum cpuhp_state state,
 293                                                       struct hlist_node *node)
 294 {
 295         return __cpuhp_state_remove_instance(state, node, false);
 296 }
 297
 298 #ifdef CONFIG_SMP
 299 void cpuhp_online_idle(enum cpuhp_state state);
 300 #else
 301 static inline void cpuhp_online_idle(enum cpuhp_state state) { }
 302 #endif
 303
 304 #endif