1 /* SPDX-License-Identifier: GPL-2.0 */
3 * include/linux/cpu.h - generic cpu definition
5 * This is mainly for topological representation. We define the
6 * basic 'struct cpu' here, which can be embedded in per-arch
7 * definitions of processors.
9 * Basic handling of the devices is done in drivers/base/cpu.c
11 * CPUs are exported via sysfs in the devices/system/cpu
17 #include <linux/node.h>
18 #include <linux/compiler.h>
19 #include <linux/cpumask.h>
20 #include <linux/cpuhotplug.h>
24 struct attribute_group;
27 int node_id; /* The node which contains the CPU */
28 int hotpluggable; /* creates sysfs control file if hotpluggable */
32 extern void boot_cpu_init(void);
33 extern void boot_cpu_hotplug_init(void);
34 extern void cpu_init(void);
35 extern void trap_init(void);
37 extern int register_cpu(struct cpu *cpu, int num);
38 extern struct device *get_cpu_device(unsigned cpu);
39 extern bool cpu_is_hotpluggable(unsigned cpu);
40 extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
41 extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
42 int cpu, unsigned int *thread);
44 extern int cpu_add_dev_attr(struct device_attribute *attr);
45 extern void cpu_remove_dev_attr(struct device_attribute *attr);
47 extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
48 extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
50 extern ssize_t cpu_show_meltdown(struct device *dev,
51 struct device_attribute *attr, char *buf);
52 extern ssize_t cpu_show_spectre_v1(struct device *dev,
53 struct device_attribute *attr, char *buf);
54 extern ssize_t cpu_show_spectre_v2(struct device *dev,
55 struct device_attribute *attr, char *buf);
56 extern ssize_t cpu_show_spec_store_bypass(struct device *dev,
57 struct device_attribute *attr, char *buf);
58 extern ssize_t cpu_show_l1tf(struct device *dev,
59 struct device_attribute *attr, char *buf);
60 extern ssize_t cpu_show_mds(struct device *dev,
61 struct device_attribute *attr, char *buf);
62 extern ssize_t cpu_show_tsx_async_abort(struct device *dev,
63 struct device_attribute *attr,
65 extern ssize_t cpu_show_itlb_multihit(struct device *dev,
66 struct device_attribute *attr, char *buf);
69 struct device *cpu_device_create(struct device *parent, void *drvdata,
70 const struct attribute_group **groups,
71 const char *fmt, ...);
72 #ifdef CONFIG_HOTPLUG_CPU
73 extern void unregister_cpu(struct cpu *cpu);
74 extern ssize_t arch_cpu_probe(const char *, size_t);
75 extern ssize_t arch_cpu_release(const char *, size_t);
79 * These states are not related to the core CPU hotplug mechanism. They are
80 * used by various (sub)architectures to track internal state
82 #define CPU_ONLINE 0x0002 /* CPU is up */
83 #define CPU_UP_PREPARE 0x0003 /* CPU coming up */
84 #define CPU_DEAD 0x0007 /* CPU dead */
85 #define CPU_DEAD_FROZEN 0x0008 /* CPU timed out on unplug */
86 #define CPU_POST_DEAD 0x0009 /* CPU successfully unplugged */
87 #define CPU_BROKEN 0x000B /* CPU did not die properly */
90 extern bool cpuhp_tasks_frozen;
91 int add_cpu(unsigned int cpu);
92 int cpu_device_up(struct device *dev);
93 void notify_cpu_starting(unsigned int cpu);
94 extern void cpu_maps_update_begin(void);
95 extern void cpu_maps_update_done(void);
96 int bringup_hibernate_cpu(unsigned int sleep_cpu);
97 void bringup_nonboot_cpus(unsigned int setup_max_cpus);
99 #else /* CONFIG_SMP */
100 #define cpuhp_tasks_frozen 0
102 static inline void cpu_maps_update_begin(void)
106 static inline void cpu_maps_update_done(void)
110 #endif /* CONFIG_SMP */
111 extern struct bus_type cpu_subsys;
113 #ifdef CONFIG_HOTPLUG_CPU
114 extern void cpus_write_lock(void);
115 extern void cpus_write_unlock(void);
116 extern void cpus_read_lock(void);
117 extern void cpus_read_unlock(void);
118 extern int cpus_read_trylock(void);
119 extern void lockdep_assert_cpus_held(void);
120 extern void cpu_hotplug_disable(void);
121 extern void cpu_hotplug_enable(void);
122 void clear_tasks_mm_cpumask(int cpu);
123 int remove_cpu(unsigned int cpu);
124 int cpu_device_down(struct device *dev);
125 extern void smp_shutdown_nonboot_cpus(unsigned int primary_cpu);
127 #else /* CONFIG_HOTPLUG_CPU */
129 static inline void cpus_write_lock(void) { }
130 static inline void cpus_write_unlock(void) { }
131 static inline void cpus_read_lock(void) { }
132 static inline void cpus_read_unlock(void) { }
133 static inline int cpus_read_trylock(void) { return true; }
134 static inline void lockdep_assert_cpus_held(void) { }
135 static inline void cpu_hotplug_disable(void) { }
136 static inline void cpu_hotplug_enable(void) { }
137 static inline void smp_shutdown_nonboot_cpus(unsigned int primary_cpu) { }
138 #endif /* !CONFIG_HOTPLUG_CPU */
140 /* Wrappers which go away once all code is converted */
141 static inline void cpu_hotplug_begin(void) { cpus_write_lock(); }
142 static inline void cpu_hotplug_done(void) { cpus_write_unlock(); }
143 static inline void get_online_cpus(void) { cpus_read_lock(); }
144 static inline void put_online_cpus(void) { cpus_read_unlock(); }
146 #ifdef CONFIG_PM_SLEEP_SMP
147 int __freeze_secondary_cpus(int primary, bool suspend);
148 static inline int freeze_secondary_cpus(int primary)
150 return __freeze_secondary_cpus(primary, true);
153 static inline int disable_nonboot_cpus(void)
155 return __freeze_secondary_cpus(0, false);
158 void enable_nonboot_cpus(void);
160 static inline int suspend_disable_secondary_cpus(void)
164 if (IS_ENABLED(CONFIG_PM_SLEEP_SMP_NONZERO_CPU))
167 return freeze_secondary_cpus(cpu);
169 static inline void suspend_enable_secondary_cpus(void)
171 return enable_nonboot_cpus();
174 #else /* !CONFIG_PM_SLEEP_SMP */
175 static inline int disable_nonboot_cpus(void) { return 0; }
176 static inline void enable_nonboot_cpus(void) {}
177 static inline int suspend_disable_secondary_cpus(void) { return 0; }
178 static inline void suspend_enable_secondary_cpus(void) { }
179 #endif /* !CONFIG_PM_SLEEP_SMP */
181 void cpu_startup_entry(enum cpuhp_state state);
183 void cpu_idle_poll_ctrl(bool enable);
185 /* Attach to any functions which should be considered cpuidle. */
186 #define __cpuidle __attribute__((__section__(".cpuidle.text")))
188 bool cpu_in_idle(unsigned long pc);
190 void arch_cpu_idle(void);
191 void arch_cpu_idle_prepare(void);
192 void arch_cpu_idle_enter(void);
193 void arch_cpu_idle_exit(void);
194 void arch_cpu_idle_dead(void);
196 int cpu_report_state(int cpu);
197 int cpu_check_up_prepare(int cpu);
198 void cpu_set_state_online(int cpu);
199 void play_idle_precise(u64 duration_ns, u64 latency_ns);
201 static inline void play_idle(unsigned long duration_us)
203 play_idle_precise(duration_us * NSEC_PER_USEC, U64_MAX);
206 #ifdef CONFIG_HOTPLUG_CPU
207 bool cpu_wait_death(unsigned int cpu, int seconds);
208 bool cpu_report_death(void);
209 void cpuhp_report_idle_dead(void);
211 static inline void cpuhp_report_idle_dead(void) { }
212 #endif /* #ifdef CONFIG_HOTPLUG_CPU */
214 enum cpuhp_smt_control {
217 CPU_SMT_FORCE_DISABLED,
218 CPU_SMT_NOT_SUPPORTED,
219 CPU_SMT_NOT_IMPLEMENTED,
222 #if defined(CONFIG_SMP) && defined(CONFIG_HOTPLUG_SMT)
223 extern enum cpuhp_smt_control cpu_smt_control;
224 extern void cpu_smt_disable(bool force);
225 extern void cpu_smt_check_topology(void);
226 extern bool cpu_smt_possible(void);
227 extern int cpuhp_smt_enable(void);
228 extern int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval);
230 # define cpu_smt_control (CPU_SMT_NOT_IMPLEMENTED)
231 static inline void cpu_smt_disable(bool force) { }
232 static inline void cpu_smt_check_topology(void) { }
233 static inline bool cpu_smt_possible(void) { return false; }
234 static inline int cpuhp_smt_enable(void) { return 0; }
235 static inline int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval) { return 0; }
238 extern bool cpu_mitigations_off(void);
239 extern bool cpu_mitigations_auto_nosmt(void);
241 #endif /* _LINUX_CPU_H_ */