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