2 * include/linux/cpu.h - generic cpu definition
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.
8 * Basic handling of the devices is done in drivers/base/cpu.c
10 * CPUs are exported via sysfs in the devices/system/cpu
16 #include <linux/node.h>
17 #include <linux/compiler.h>
18 #include <linux/cpumask.h>
19 #include <linux/cpuhotplug.h>
23 struct attribute_group;
26 int node_id; /* The node which contains the CPU */
27 int hotpluggable; /* creates sysfs control file if hotpluggable */
31 extern void boot_cpu_init(void);
32 extern void boot_cpu_hotplug_init(void);
34 extern int register_cpu(struct cpu *cpu, int num);
35 extern struct device *get_cpu_device(unsigned cpu);
36 extern bool cpu_is_hotpluggable(unsigned cpu);
37 extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
38 extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
39 int cpu, unsigned int *thread);
41 extern int cpu_add_dev_attr(struct device_attribute *attr);
42 extern void cpu_remove_dev_attr(struct device_attribute *attr);
44 extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
45 extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
47 extern ssize_t cpu_show_meltdown(struct device *dev,
48 struct device_attribute *attr, char *buf);
49 extern ssize_t cpu_show_spectre_v1(struct device *dev,
50 struct device_attribute *attr, char *buf);
51 extern ssize_t cpu_show_spectre_v2(struct device *dev,
52 struct device_attribute *attr, char *buf);
53 extern ssize_t cpu_show_spec_store_bypass(struct device *dev,
54 struct device_attribute *attr, char *buf);
55 extern ssize_t cpu_show_l1tf(struct device *dev,
56 struct device_attribute *attr, char *buf);
57 extern ssize_t cpu_show_mds(struct device *dev,
58 struct device_attribute *attr, char *buf);
59 extern ssize_t cpu_show_tsx_async_abort(struct device *dev,
60 struct device_attribute *attr,
62 extern ssize_t cpu_show_itlb_multihit(struct device *dev,
63 struct device_attribute *attr, char *buf);
66 struct device *cpu_device_create(struct device *parent, void *drvdata,
67 const struct attribute_group **groups,
68 const char *fmt, ...);
69 #ifdef CONFIG_HOTPLUG_CPU
70 extern void unregister_cpu(struct cpu *cpu);
71 extern ssize_t arch_cpu_probe(const char *, size_t);
72 extern ssize_t arch_cpu_release(const char *, size_t);
74 struct notifier_block;
76 #define CPU_ONLINE 0x0002 /* CPU (unsigned)v is up */
77 #define CPU_UP_PREPARE 0x0003 /* CPU (unsigned)v coming up */
78 #define CPU_UP_CANCELED 0x0004 /* CPU (unsigned)v NOT coming up */
79 #define CPU_DOWN_PREPARE 0x0005 /* CPU (unsigned)v going down */
80 #define CPU_DOWN_FAILED 0x0006 /* CPU (unsigned)v NOT going down */
81 #define CPU_DEAD 0x0007 /* CPU (unsigned)v dead */
82 #define CPU_POST_DEAD 0x0009 /* CPU (unsigned)v dead, cpu_hotplug
84 #define CPU_BROKEN 0x000B /* CPU (unsigned)v did not die properly,
85 * perhaps due to preemption. */
87 /* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
88 * operation in progress
90 #define CPU_TASKS_FROZEN 0x0010
92 #define CPU_ONLINE_FROZEN (CPU_ONLINE | CPU_TASKS_FROZEN)
93 #define CPU_UP_PREPARE_FROZEN (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
94 #define CPU_UP_CANCELED_FROZEN (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
95 #define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
96 #define CPU_DOWN_FAILED_FROZEN (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
97 #define CPU_DEAD_FROZEN (CPU_DEAD | CPU_TASKS_FROZEN)
100 extern bool cpuhp_tasks_frozen;
101 /* Need to know about CPUs going up/down? */
102 #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
103 #define cpu_notifier(fn, pri) { \
104 static struct notifier_block fn##_nb = \
105 { .notifier_call = fn, .priority = pri }; \
106 register_cpu_notifier(&fn##_nb); \
109 #define __cpu_notifier(fn, pri) { \
110 static struct notifier_block fn##_nb = \
111 { .notifier_call = fn, .priority = pri }; \
112 __register_cpu_notifier(&fn##_nb); \
115 extern int register_cpu_notifier(struct notifier_block *nb);
116 extern int __register_cpu_notifier(struct notifier_block *nb);
117 extern void unregister_cpu_notifier(struct notifier_block *nb);
118 extern void __unregister_cpu_notifier(struct notifier_block *nb);
120 #else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
121 #define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
122 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
124 static inline int register_cpu_notifier(struct notifier_block *nb)
129 static inline int __register_cpu_notifier(struct notifier_block *nb)
134 static inline void unregister_cpu_notifier(struct notifier_block *nb)
138 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
143 int cpu_up(unsigned int cpu);
144 void notify_cpu_starting(unsigned int cpu);
145 extern void cpu_maps_update_begin(void);
146 extern void cpu_maps_update_done(void);
148 #define cpu_notifier_register_begin cpu_maps_update_begin
149 #define cpu_notifier_register_done cpu_maps_update_done
151 #else /* CONFIG_SMP */
152 #define cpuhp_tasks_frozen 0
154 #define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
155 #define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
157 static inline int register_cpu_notifier(struct notifier_block *nb)
162 static inline int __register_cpu_notifier(struct notifier_block *nb)
167 static inline void unregister_cpu_notifier(struct notifier_block *nb)
171 static inline void __unregister_cpu_notifier(struct notifier_block *nb)
175 static inline void cpu_maps_update_begin(void)
179 static inline void cpu_maps_update_done(void)
183 static inline void cpu_notifier_register_begin(void)
187 static inline void cpu_notifier_register_done(void)
191 #endif /* CONFIG_SMP */
192 extern struct bus_type cpu_subsys;
194 #ifdef CONFIG_HOTPLUG_CPU
195 /* Stop CPUs going up and down. */
197 extern void cpu_hotplug_begin(void);
198 extern void cpu_hotplug_done(void);
199 extern void get_online_cpus(void);
200 extern void put_online_cpus(void);
201 extern void cpu_hotplug_disable(void);
202 extern void cpu_hotplug_enable(void);
203 #define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
204 #define __hotcpu_notifier(fn, pri) __cpu_notifier(fn, pri)
205 #define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
206 #define __register_hotcpu_notifier(nb) __register_cpu_notifier(nb)
207 #define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
208 #define __unregister_hotcpu_notifier(nb) __unregister_cpu_notifier(nb)
209 void clear_tasks_mm_cpumask(int cpu);
210 int cpu_down(unsigned int cpu);
212 #else /* CONFIG_HOTPLUG_CPU */
214 static inline void cpu_hotplug_begin(void) {}
215 static inline void cpu_hotplug_done(void) {}
216 #define get_online_cpus() do { } while (0)
217 #define put_online_cpus() do { } while (0)
218 #define cpu_hotplug_disable() do { } while (0)
219 #define cpu_hotplug_enable() do { } while (0)
220 #define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
221 #define __hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
222 /* These aren't inline functions due to a GCC bug. */
223 #define register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
224 #define __register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
225 #define unregister_hotcpu_notifier(nb) ({ (void)(nb); })
226 #define __unregister_hotcpu_notifier(nb) ({ (void)(nb); })
227 #endif /* CONFIG_HOTPLUG_CPU */
229 #ifdef CONFIG_PM_SLEEP_SMP
230 extern int freeze_secondary_cpus(int primary);
231 static inline int disable_nonboot_cpus(void)
233 return freeze_secondary_cpus(0);
235 extern void enable_nonboot_cpus(void);
236 #else /* !CONFIG_PM_SLEEP_SMP */
237 static inline int disable_nonboot_cpus(void) { return 0; }
238 static inline void enable_nonboot_cpus(void) {}
239 #endif /* !CONFIG_PM_SLEEP_SMP */
241 void cpu_startup_entry(enum cpuhp_state state);
243 void cpu_idle_poll_ctrl(bool enable);
245 /* Attach to any functions which should be considered cpuidle. */
246 #define __cpuidle __attribute__((__section__(".cpuidle.text")))
248 bool cpu_in_idle(unsigned long pc);
250 void arch_cpu_idle(void);
251 void arch_cpu_idle_prepare(void);
252 void arch_cpu_idle_enter(void);
253 void arch_cpu_idle_exit(void);
254 void arch_cpu_idle_dead(void);
256 int cpu_report_state(int cpu);
257 int cpu_check_up_prepare(int cpu);
258 void cpu_set_state_online(int cpu);
259 #ifdef CONFIG_HOTPLUG_CPU
260 bool cpu_wait_death(unsigned int cpu, int seconds);
261 bool cpu_report_death(void);
262 void cpuhp_report_idle_dead(void);
264 static inline void cpuhp_report_idle_dead(void) { }
265 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
267 enum cpuhp_smt_control {
270 CPU_SMT_FORCE_DISABLED,
271 CPU_SMT_NOT_SUPPORTED,
274 #if defined(CONFIG_SMP) && defined(CONFIG_HOTPLUG_SMT)
275 extern enum cpuhp_smt_control cpu_smt_control;
276 extern void cpu_smt_disable(bool force);
277 extern void cpu_smt_check_topology_early(void);
278 extern void cpu_smt_check_topology(void);
279 extern int cpuhp_smt_enable(void);
280 extern int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval);
282 # define cpu_smt_control (CPU_SMT_ENABLED)
283 static inline void cpu_smt_disable(bool force) { }
284 static inline void cpu_smt_check_topology_early(void) { }
285 static inline void cpu_smt_check_topology(void) { }
286 static inline int cpuhp_smt_enable(void) { return 0; }
287 static inline int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval) { return 0; }
290 extern bool cpu_mitigations_off(void);
291 extern bool cpu_mitigations_auto_nosmt(void);
293 #endif /* _LINUX_CPU_H_ */