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