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