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