Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * include/linux/cpu.h - generic cpu definition | |
3 | * | |
4 | * This is mainly for topological representation. We define the | |
5 | * basic 'struct cpu' here, which can be embedded in per-arch | |
6 | * definitions of processors. | |
7 | * | |
8 | * Basic handling of the devices is done in drivers/base/cpu.c | |
1da177e4 | 9 | * |
611a75e1 | 10 | * CPUs are exported via sysfs in the devices/system/cpu |
1da177e4 | 11 | * directory. |
1da177e4 LT |
12 | */ |
13 | #ifndef _LINUX_CPU_H_ | |
14 | #define _LINUX_CPU_H_ | |
15 | ||
1da177e4 LT |
16 | #include <linux/node.h> |
17 | #include <linux/compiler.h> | |
18 | #include <linux/cpumask.h> | |
1da177e4 | 19 | |
313162d0 | 20 | struct device; |
d1cb9d1a | 21 | struct device_node; |
3d52943b | 22 | struct attribute_group; |
313162d0 | 23 | |
1da177e4 LT |
24 | struct cpu { |
25 | int node_id; /* The node which contains the CPU */ | |
72486f1f | 26 | int hotpluggable; /* creates sysfs control file if hotpluggable */ |
8a25a2fd | 27 | struct device dev; |
1da177e4 LT |
28 | }; |
29 | ||
76b67ed9 | 30 | extern int register_cpu(struct cpu *cpu, int num); |
8a25a2fd | 31 | extern struct device *get_cpu_device(unsigned cpu); |
2987557f | 32 | extern bool cpu_is_hotpluggable(unsigned cpu); |
183912d3 | 33 | extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id); |
d1cb9d1a DM |
34 | extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun, |
35 | int cpu, unsigned int *thread); | |
0344c6c5 | 36 | |
8a25a2fd KS |
37 | extern int cpu_add_dev_attr(struct device_attribute *attr); |
38 | extern void cpu_remove_dev_attr(struct device_attribute *attr); | |
0344c6c5 | 39 | |
8a25a2fd KS |
40 | extern int cpu_add_dev_attr_group(struct attribute_group *attrs); |
41 | extern void cpu_remove_dev_attr_group(struct attribute_group *attrs); | |
0344c6c5 | 42 | |
8db14860 NI |
43 | extern __printf(4, 5) |
44 | struct device *cpu_device_create(struct device *parent, void *drvdata, | |
45 | const struct attribute_group **groups, | |
46 | const char *fmt, ...); | |
1da177e4 | 47 | #ifdef CONFIG_HOTPLUG_CPU |
76b67ed9 | 48 | extern void unregister_cpu(struct cpu *cpu); |
12633e80 NF |
49 | extern ssize_t arch_cpu_probe(const char *, size_t); |
50 | extern ssize_t arch_cpu_release(const char *, size_t); | |
1da177e4 LT |
51 | #endif |
52 | struct notifier_block; | |
53 | ||
50a323b7 TH |
54 | /* |
55 | * CPU notifier priorities. | |
56 | */ | |
57 | enum { | |
3a101d05 TH |
58 | /* |
59 | * SCHED_ACTIVE marks a cpu which is coming up active during | |
60 | * CPU_ONLINE and CPU_DOWN_FAILED and must be the first | |
61 | * notifier. CPUSET_ACTIVE adjusts cpuset according to | |
62 | * cpu_active mask right after SCHED_ACTIVE. During | |
63 | * CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are | |
64 | * ordered in the similar way. | |
65 | * | |
66 | * This ordering guarantees consistent cpu_active mask and | |
67 | * migration behavior to all cpu notifiers. | |
68 | */ | |
69 | CPU_PRI_SCHED_ACTIVE = INT_MAX, | |
70 | CPU_PRI_CPUSET_ACTIVE = INT_MAX - 1, | |
71 | CPU_PRI_SCHED_INACTIVE = INT_MIN + 1, | |
72 | CPU_PRI_CPUSET_INACTIVE = INT_MIN, | |
73 | ||
50a323b7 TH |
74 | /* migration should happen before other stuff but after perf */ |
75 | CPU_PRI_PERF = 20, | |
76 | CPU_PRI_MIGRATION = 10, | |
00df35f9 | 77 | CPU_PRI_SMPBOOT = 9, |
65758202 TH |
78 | /* bring up workqueues before normal notifiers and down after */ |
79 | CPU_PRI_WORKQUEUE_UP = 5, | |
80 | CPU_PRI_WORKQUEUE_DOWN = -5, | |
50a323b7 TH |
81 | }; |
82 | ||
80f1ff97 AW |
83 | #define CPU_ONLINE 0x0002 /* CPU (unsigned)v is up */ |
84 | #define CPU_UP_PREPARE 0x0003 /* CPU (unsigned)v coming up */ | |
85 | #define CPU_UP_CANCELED 0x0004 /* CPU (unsigned)v NOT coming up */ | |
86 | #define CPU_DOWN_PREPARE 0x0005 /* CPU (unsigned)v going down */ | |
87 | #define CPU_DOWN_FAILED 0x0006 /* CPU (unsigned)v NOT going down */ | |
88 | #define CPU_DEAD 0x0007 /* CPU (unsigned)v dead */ | |
89 | #define CPU_DYING 0x0008 /* CPU (unsigned)v not running any task, | |
90 | * not handling interrupts, soon dead. | |
91 | * Called on the dying cpu, interrupts | |
92 | * are already disabled. Must not | |
93 | * sleep, must not fail */ | |
94 | #define CPU_POST_DEAD 0x0009 /* CPU (unsigned)v dead, cpu_hotplug | |
95 | * lock is dropped */ | |
96 | #define CPU_STARTING 0x000A /* CPU (unsigned)v soon running. | |
97 | * Called on the new cpu, just before | |
98 | * enabling interrupts. Must not sleep, | |
99 | * must not fail */ | |
88428cc5 PM |
100 | #define CPU_DYING_IDLE 0x000B /* CPU (unsigned)v dying, reached |
101 | * idle loop. */ | |
8038dad7 PM |
102 | #define CPU_BROKEN 0x000C /* CPU (unsigned)v did not die properly, |
103 | * perhaps due to preemption. */ | |
80f1ff97 AW |
104 | |
105 | /* Used for CPU hotplug events occurring while tasks are frozen due to a suspend | |
106 | * operation in progress | |
107 | */ | |
108 | #define CPU_TASKS_FROZEN 0x0010 | |
109 | ||
110 | #define CPU_ONLINE_FROZEN (CPU_ONLINE | CPU_TASKS_FROZEN) | |
111 | #define CPU_UP_PREPARE_FROZEN (CPU_UP_PREPARE | CPU_TASKS_FROZEN) | |
112 | #define CPU_UP_CANCELED_FROZEN (CPU_UP_CANCELED | CPU_TASKS_FROZEN) | |
113 | #define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN) | |
114 | #define CPU_DOWN_FAILED_FROZEN (CPU_DOWN_FAILED | CPU_TASKS_FROZEN) | |
115 | #define CPU_DEAD_FROZEN (CPU_DEAD | CPU_TASKS_FROZEN) | |
116 | #define CPU_DYING_FROZEN (CPU_DYING | CPU_TASKS_FROZEN) | |
117 | #define CPU_STARTING_FROZEN (CPU_STARTING | CPU_TASKS_FROZEN) | |
118 | ||
119 | ||
1da177e4 LT |
120 | #ifdef CONFIG_SMP |
121 | /* Need to know about CPUs going up/down? */ | |
799e64f0 PM |
122 | #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) |
123 | #define cpu_notifier(fn, pri) { \ | |
0db0628d | 124 | static struct notifier_block fn##_nb = \ |
799e64f0 PM |
125 | { .notifier_call = fn, .priority = pri }; \ |
126 | register_cpu_notifier(&fn##_nb); \ | |
127 | } | |
93ae4f97 SB |
128 | |
129 | #define __cpu_notifier(fn, pri) { \ | |
130 | static struct notifier_block fn##_nb = \ | |
131 | { .notifier_call = fn, .priority = pri }; \ | |
132 | __register_cpu_notifier(&fn##_nb); \ | |
133 | } | |
799e64f0 PM |
134 | #else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */ |
135 | #define cpu_notifier(fn, pri) do { (void)(fn); } while (0) | |
93ae4f97 | 136 | #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0) |
799e64f0 | 137 | #endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */ |
93ae4f97 | 138 | |
65edc68c | 139 | #ifdef CONFIG_HOTPLUG_CPU |
47e627bc | 140 | extern int register_cpu_notifier(struct notifier_block *nb); |
93ae4f97 | 141 | extern int __register_cpu_notifier(struct notifier_block *nb); |
1da177e4 | 142 | extern void unregister_cpu_notifier(struct notifier_block *nb); |
93ae4f97 | 143 | extern void __unregister_cpu_notifier(struct notifier_block *nb); |
65edc68c | 144 | #else |
47e627bc AK |
145 | |
146 | #ifndef MODULE | |
147 | extern int register_cpu_notifier(struct notifier_block *nb); | |
93ae4f97 | 148 | extern int __register_cpu_notifier(struct notifier_block *nb); |
47e627bc AK |
149 | #else |
150 | static inline int register_cpu_notifier(struct notifier_block *nb) | |
151 | { | |
152 | return 0; | |
153 | } | |
93ae4f97 SB |
154 | |
155 | static inline int __register_cpu_notifier(struct notifier_block *nb) | |
156 | { | |
157 | return 0; | |
158 | } | |
47e627bc AK |
159 | #endif |
160 | ||
65edc68c CS |
161 | static inline void unregister_cpu_notifier(struct notifier_block *nb) |
162 | { | |
163 | } | |
93ae4f97 SB |
164 | |
165 | static inline void __unregister_cpu_notifier(struct notifier_block *nb) | |
166 | { | |
167 | } | |
65edc68c | 168 | #endif |
1da177e4 | 169 | |
00df35f9 | 170 | void smpboot_thread_init(void); |
1da177e4 | 171 | int cpu_up(unsigned int cpu); |
e545a614 | 172 | void notify_cpu_starting(unsigned int cpu); |
3da1c84c ON |
173 | extern void cpu_maps_update_begin(void); |
174 | extern void cpu_maps_update_done(void); | |
d0d23b54 | 175 | |
93ae4f97 SB |
176 | #define cpu_notifier_register_begin cpu_maps_update_begin |
177 | #define cpu_notifier_register_done cpu_maps_update_done | |
178 | ||
3da1c84c | 179 | #else /* CONFIG_SMP */ |
1da177e4 | 180 | |
799e64f0 | 181 | #define cpu_notifier(fn, pri) do { (void)(fn); } while (0) |
93ae4f97 | 182 | #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0) |
799e64f0 | 183 | |
1da177e4 LT |
184 | static inline int register_cpu_notifier(struct notifier_block *nb) |
185 | { | |
186 | return 0; | |
187 | } | |
d0d23b54 | 188 | |
93ae4f97 SB |
189 | static inline int __register_cpu_notifier(struct notifier_block *nb) |
190 | { | |
191 | return 0; | |
192 | } | |
193 | ||
1da177e4 LT |
194 | static inline void unregister_cpu_notifier(struct notifier_block *nb) |
195 | { | |
196 | } | |
197 | ||
93ae4f97 SB |
198 | static inline void __unregister_cpu_notifier(struct notifier_block *nb) |
199 | { | |
200 | } | |
201 | ||
3da1c84c ON |
202 | static inline void cpu_maps_update_begin(void) |
203 | { | |
204 | } | |
205 | ||
206 | static inline void cpu_maps_update_done(void) | |
207 | { | |
208 | } | |
209 | ||
93ae4f97 SB |
210 | static inline void cpu_notifier_register_begin(void) |
211 | { | |
212 | } | |
213 | ||
214 | static inline void cpu_notifier_register_done(void) | |
215 | { | |
216 | } | |
217 | ||
590ee7db IM |
218 | static inline void smpboot_thread_init(void) |
219 | { | |
220 | } | |
221 | ||
1da177e4 | 222 | #endif /* CONFIG_SMP */ |
8a25a2fd | 223 | extern struct bus_type cpu_subsys; |
1da177e4 LT |
224 | |
225 | #ifdef CONFIG_HOTPLUG_CPU | |
226 | /* Stop CPUs going up and down. */ | |
f7dff2b1 | 227 | |
b9d10be7 TK |
228 | extern void cpu_hotplug_begin(void); |
229 | extern void cpu_hotplug_done(void); | |
86ef5c9a | 230 | extern void get_online_cpus(void); |
dd56af42 | 231 | extern bool try_get_online_cpus(void); |
86ef5c9a | 232 | extern void put_online_cpus(void); |
16e53dbf SB |
233 | extern void cpu_hotplug_disable(void); |
234 | extern void cpu_hotplug_enable(void); | |
799e64f0 | 235 | #define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri) |
93ae4f97 | 236 | #define __hotcpu_notifier(fn, pri) __cpu_notifier(fn, pri) |
39f4885c | 237 | #define register_hotcpu_notifier(nb) register_cpu_notifier(nb) |
93ae4f97 | 238 | #define __register_hotcpu_notifier(nb) __register_cpu_notifier(nb) |
39f4885c | 239 | #define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb) |
93ae4f97 | 240 | #define __unregister_hotcpu_notifier(nb) __unregister_cpu_notifier(nb) |
cb79295e | 241 | void clear_tasks_mm_cpumask(int cpu); |
1da177e4 | 242 | int cpu_down(unsigned int cpu); |
f7dff2b1 GS |
243 | |
244 | #else /* CONFIG_HOTPLUG_CPU */ | |
245 | ||
b9d10be7 TK |
246 | static inline void cpu_hotplug_begin(void) {} |
247 | static inline void cpu_hotplug_done(void) {} | |
86ef5c9a | 248 | #define get_online_cpus() do { } while (0) |
dd56af42 | 249 | #define try_get_online_cpus() true |
86ef5c9a | 250 | #define put_online_cpus() do { } while (0) |
16e53dbf SB |
251 | #define cpu_hotplug_disable() do { } while (0) |
252 | #define cpu_hotplug_enable() do { } while (0) | |
02316067 | 253 | #define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0) |
93ae4f97 | 254 | #define __hotcpu_notifier(fn, pri) do { (void)(fn); } while (0) |
761bb431 SS |
255 | /* These aren't inline functions due to a GCC bug. */ |
256 | #define register_hotcpu_notifier(nb) ({ (void)(nb); 0; }) | |
93ae4f97 | 257 | #define __register_hotcpu_notifier(nb) ({ (void)(nb); 0; }) |
761bb431 | 258 | #define unregister_hotcpu_notifier(nb) ({ (void)(nb); }) |
93ae4f97 | 259 | #define __unregister_hotcpu_notifier(nb) ({ (void)(nb); }) |
f7dff2b1 | 260 | #endif /* CONFIG_HOTPLUG_CPU */ |
1da177e4 | 261 | |
f3de4be9 | 262 | #ifdef CONFIG_PM_SLEEP_SMP |
e3920fb4 RW |
263 | extern int disable_nonboot_cpus(void); |
264 | extern void enable_nonboot_cpus(void); | |
f3de4be9 | 265 | #else /* !CONFIG_PM_SLEEP_SMP */ |
e3920fb4 RW |
266 | static inline int disable_nonboot_cpus(void) { return 0; } |
267 | static inline void enable_nonboot_cpus(void) {} | |
f3de4be9 | 268 | #endif /* !CONFIG_PM_SLEEP_SMP */ |
e3920fb4 | 269 | |
a1a04ec3 TG |
270 | enum cpuhp_state { |
271 | CPUHP_OFFLINE, | |
272 | CPUHP_ONLINE, | |
273 | }; | |
274 | ||
275 | void cpu_startup_entry(enum cpuhp_state state); | |
a1a04ec3 | 276 | |
d1669912 TG |
277 | void cpu_idle_poll_ctrl(bool enable); |
278 | ||
279 | void arch_cpu_idle(void); | |
280 | void arch_cpu_idle_prepare(void); | |
281 | void arch_cpu_idle_enter(void); | |
282 | void arch_cpu_idle_exit(void); | |
283 | void arch_cpu_idle_dead(void); | |
284 | ||
8038dad7 PM |
285 | DECLARE_PER_CPU(bool, cpu_dead_idle); |
286 | ||
287 | int cpu_report_state(int cpu); | |
288 | int cpu_check_up_prepare(int cpu); | |
289 | void cpu_set_state_online(int cpu); | |
290 | #ifdef CONFIG_HOTPLUG_CPU | |
291 | bool cpu_wait_death(unsigned int cpu, int seconds); | |
292 | bool cpu_report_death(void); | |
293 | #endif /* #ifdef CONFIG_HOTPLUG_CPU */ | |
294 | ||
1da177e4 | 295 | #endif /* _LINUX_CPU_H_ */ |