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