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