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