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