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