workqueue: Convert to state machine callbacks
[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_WORKQUEUE_PREP,
16         CPUHP_NOTIFY_PREPARE,
17         CPUHP_BRINGUP_CPU,
18         CPUHP_AP_IDLE_DEAD,
19         CPUHP_AP_OFFLINE,
20         CPUHP_AP_SCHED_STARTING,
21         CPUHP_AP_IRQ_GIC_STARTING,
22         CPUHP_AP_IRQ_GICV3_STARTING,
23         CPUHP_AP_IRQ_HIP04_STARTING,
24         CPUHP_AP_IRQ_ARMADA_XP_STARTING,
25         CPUHP_AP_IRQ_ARMADA_CASC_STARTING,
26         CPUHP_AP_IRQ_BCM2836_STARTING,
27         CPUHP_AP_ARM_MVEBU_COHERENCY,
28         CPUHP_AP_PERF_X86_UNCORE_STARTING,
29         CPUHP_AP_PERF_X86_AMD_UNCORE_STARTING,
30         CPUHP_AP_PERF_X86_STARTING,
31         CPUHP_AP_PERF_X86_AMD_IBS_STARTING,
32         CPUHP_AP_PERF_X86_CQM_STARTING,
33         CPUHP_AP_PERF_X86_CSTATE_STARTING,
34         CPUHP_AP_PERF_XTENSA_STARTING,
35         CPUHP_AP_NOTIFY_STARTING,
36         CPUHP_AP_ONLINE,
37         CPUHP_TEARDOWN_CPU,
38         CPUHP_AP_ONLINE_IDLE,
39         CPUHP_AP_SMPBOOT_THREADS,
40         CPUHP_AP_X86_VDSO_VMA_ONLINE,
41         CPUHP_AP_PERF_ONLINE,
42         CPUHP_AP_PERF_X86_ONLINE,
43         CPUHP_AP_PERF_X86_UNCORE_ONLINE,
44         CPUHP_AP_PERF_X86_AMD_UNCORE_ONLINE,
45         CPUHP_AP_PERF_X86_AMD_POWER_ONLINE,
46         CPUHP_AP_PERF_X86_RAPL_ONLINE,
47         CPUHP_AP_PERF_X86_CQM_ONLINE,
48         CPUHP_AP_PERF_X86_CSTATE_ONLINE,
49         CPUHP_AP_PERF_S390_CF_ONLINE,
50         CPUHP_AP_PERF_S390_SF_ONLINE,
51         CPUHP_AP_PERF_ARM_CCI_ONLINE,
52         CPUHP_AP_PERF_ARM_CCN_ONLINE,
53         CPUHP_AP_WORKQUEUE_ONLINE,
54         CPUHP_AP_NOTIFY_ONLINE,
55         CPUHP_AP_ONLINE_DYN,
56         CPUHP_AP_ONLINE_DYN_END         = CPUHP_AP_ONLINE_DYN + 30,
57         CPUHP_AP_ACTIVE,
58         CPUHP_ONLINE,
59 };
60
61 int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke,
62                         int (*startup)(unsigned int cpu),
63                         int (*teardown)(unsigned int cpu));
64
65 /**
66  * cpuhp_setup_state - Setup hotplug state callbacks with calling the callbacks
67  * @state:      The state for which the calls are installed
68  * @name:       Name of the callback (will be used in debug output)
69  * @startup:    startup callback function
70  * @teardown:   teardown callback function
71  *
72  * Installs the callback functions and invokes the startup callback on
73  * the present cpus which have already reached the @state.
74  */
75 static inline int cpuhp_setup_state(enum cpuhp_state state,
76                                     const char *name,
77                                     int (*startup)(unsigned int cpu),
78                                     int (*teardown)(unsigned int cpu))
79 {
80         return __cpuhp_setup_state(state, name, true, startup, teardown);
81 }
82
83 /**
84  * cpuhp_setup_state_nocalls - Setup hotplug state callbacks without calling the
85  *                             callbacks
86  * @state:      The state for which the calls are installed
87  * @name:       Name of the callback.
88  * @startup:    startup callback function
89  * @teardown:   teardown callback function
90  *
91  * Same as @cpuhp_setup_state except that no calls are executed are invoked
92  * during installation of this callback. NOP if SMP=n or HOTPLUG_CPU=n.
93  */
94 static inline int cpuhp_setup_state_nocalls(enum cpuhp_state state,
95                                             const char *name,
96                                             int (*startup)(unsigned int cpu),
97                                             int (*teardown)(unsigned int cpu))
98 {
99         return __cpuhp_setup_state(state, name, false, startup, teardown);
100 }
101
102 void __cpuhp_remove_state(enum cpuhp_state state, bool invoke);
103
104 /**
105  * cpuhp_remove_state - Remove hotplug state callbacks and invoke the teardown
106  * @state:      The state for which the calls are removed
107  *
108  * Removes the callback functions and invokes the teardown callback on
109  * the present cpus which have already reached the @state.
110  */
111 static inline void cpuhp_remove_state(enum cpuhp_state state)
112 {
113         __cpuhp_remove_state(state, true);
114 }
115
116 /**
117  * cpuhp_remove_state_nocalls - Remove hotplug state callbacks without invoking
118  *                              teardown
119  * @state:      The state for which the calls are removed
120  */
121 static inline void cpuhp_remove_state_nocalls(enum cpuhp_state state)
122 {
123         __cpuhp_remove_state(state, false);
124 }
125
126 #ifdef CONFIG_SMP
127 void cpuhp_online_idle(enum cpuhp_state state);
128 #else
129 static inline void cpuhp_online_idle(enum cpuhp_state state) { }
130 #endif
131
132 #endif