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