Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * include/linux/cpu.h - generic cpu definition
4 *
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.
8 *
9 * Basic handling of the devices is done in drivers/base/cpu.c
10 *
11 * CPUs are exported via sysfs in the devices/system/cpu
12 * directory.
13 */
14#ifndef _LINUX_CPU_H_
15#define _LINUX_CPU_H_
16
17#include <linux/node.h>
18#include <linux/compiler.h>
19#include <linux/cpumask.h>
20#include <linux/cpuhotplug.h>
21
22struct device;
23struct device_node;
24struct attribute_group;
25
26struct cpu {
27 int node_id; /* The node which contains the CPU */
28 int hotpluggable; /* creates sysfs control file if hotpluggable */
29 struct device dev;
30};
31
32extern void boot_cpu_init(void);
33extern void boot_cpu_hotplug_init(void);
34extern void cpu_init(void);
35extern void trap_init(void);
36
37extern int register_cpu(struct cpu *cpu, int num);
38extern struct device *get_cpu_device(unsigned cpu);
39extern bool cpu_is_hotpluggable(unsigned cpu);
40extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
41extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
42 int cpu, unsigned int *thread);
43
44extern int cpu_add_dev_attr(struct device_attribute *attr);
45extern void cpu_remove_dev_attr(struct device_attribute *attr);
46
47extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
48extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
49
50extern ssize_t cpu_show_meltdown(struct device *dev,
51 struct device_attribute *attr, char *buf);
52extern ssize_t cpu_show_spectre_v1(struct device *dev,
53 struct device_attribute *attr, char *buf);
54extern ssize_t cpu_show_spectre_v2(struct device *dev,
55 struct device_attribute *attr, char *buf);
56extern ssize_t cpu_show_spec_store_bypass(struct device *dev,
57 struct device_attribute *attr, char *buf);
58extern ssize_t cpu_show_l1tf(struct device *dev,
59 struct device_attribute *attr, char *buf);
60extern ssize_t cpu_show_mds(struct device *dev,
61 struct device_attribute *attr, char *buf);
62extern ssize_t cpu_show_tsx_async_abort(struct device *dev,
63 struct device_attribute *attr,
64 char *buf);
65extern ssize_t cpu_show_itlb_multihit(struct device *dev,
66 struct device_attribute *attr, char *buf);
67
68extern __printf(4, 5)
69struct device *cpu_device_create(struct device *parent, void *drvdata,
70 const struct attribute_group **groups,
71 const char *fmt, ...);
72#ifdef CONFIG_HOTPLUG_CPU
73extern void unregister_cpu(struct cpu *cpu);
74extern ssize_t arch_cpu_probe(const char *, size_t);
75extern ssize_t arch_cpu_release(const char *, size_t);
76#endif
77
78/*
79 * These states are not related to the core CPU hotplug mechanism. They are
80 * used by various (sub)architectures to track internal state
81 */
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 */
88
89#ifdef CONFIG_SMP
90extern bool cpuhp_tasks_frozen;
91int add_cpu(unsigned int cpu);
92int cpu_device_up(struct device *dev);
93void notify_cpu_starting(unsigned int cpu);
94extern void cpu_maps_update_begin(void);
95extern void cpu_maps_update_done(void);
96int bringup_hibernate_cpu(unsigned int sleep_cpu);
97void bringup_nonboot_cpus(unsigned int setup_max_cpus);
98
99#else /* CONFIG_SMP */
100#define cpuhp_tasks_frozen 0
101
102static inline void cpu_maps_update_begin(void)
103{
104}
105
106static inline void cpu_maps_update_done(void)
107{
108}
109
110#endif /* CONFIG_SMP */
111extern struct bus_type cpu_subsys;
112
113#ifdef CONFIG_HOTPLUG_CPU
114extern void cpus_write_lock(void);
115extern void cpus_write_unlock(void);
116extern void cpus_read_lock(void);
117extern void cpus_read_unlock(void);
118extern int cpus_read_trylock(void);
119extern void lockdep_assert_cpus_held(void);
120extern void cpu_hotplug_disable(void);
121extern void cpu_hotplug_enable(void);
122void clear_tasks_mm_cpumask(int cpu);
123int remove_cpu(unsigned int cpu);
124int cpu_device_down(struct device *dev);
125extern void smp_shutdown_nonboot_cpus(unsigned int primary_cpu);
126
127#else /* CONFIG_HOTPLUG_CPU */
128
129static inline void cpus_write_lock(void) { }
130static inline void cpus_write_unlock(void) { }
131static inline void cpus_read_lock(void) { }
132static inline void cpus_read_unlock(void) { }
133static inline int cpus_read_trylock(void) { return true; }
134static inline void lockdep_assert_cpus_held(void) { }
135static inline void cpu_hotplug_disable(void) { }
136static inline void cpu_hotplug_enable(void) { }
137static inline void smp_shutdown_nonboot_cpus(unsigned int primary_cpu) { }
138#endif /* !CONFIG_HOTPLUG_CPU */
139
140/* Wrappers which go away once all code is converted */
141static inline void cpu_hotplug_begin(void) { cpus_write_lock(); }
142static inline void cpu_hotplug_done(void) { cpus_write_unlock(); }
143static inline void get_online_cpus(void) { cpus_read_lock(); }
144static inline void put_online_cpus(void) { cpus_read_unlock(); }
145
146#ifdef CONFIG_PM_SLEEP_SMP
147int __freeze_secondary_cpus(int primary, bool suspend);
148static inline int freeze_secondary_cpus(int primary)
149{
150 return __freeze_secondary_cpus(primary, true);
151}
152
153static inline int disable_nonboot_cpus(void)
154{
155 return __freeze_secondary_cpus(0, false);
156}
157
158void enable_nonboot_cpus(void);
159
160static inline int suspend_disable_secondary_cpus(void)
161{
162 int cpu = 0;
163
164 if (IS_ENABLED(CONFIG_PM_SLEEP_SMP_NONZERO_CPU))
165 cpu = -1;
166
167 return freeze_secondary_cpus(cpu);
168}
169static inline void suspend_enable_secondary_cpus(void)
170{
171 return enable_nonboot_cpus();
172}
173
174#else /* !CONFIG_PM_SLEEP_SMP */
175static inline int disable_nonboot_cpus(void) { return 0; }
176static inline void enable_nonboot_cpus(void) {}
177static inline int suspend_disable_secondary_cpus(void) { return 0; }
178static inline void suspend_enable_secondary_cpus(void) { }
179#endif /* !CONFIG_PM_SLEEP_SMP */
180
181void cpu_startup_entry(enum cpuhp_state state);
182
183void cpu_idle_poll_ctrl(bool enable);
184
185/* Attach to any functions which should be considered cpuidle. */
186#define __cpuidle __attribute__((__section__(".cpuidle.text")))
187
188bool cpu_in_idle(unsigned long pc);
189
190void arch_cpu_idle(void);
191void arch_cpu_idle_prepare(void);
192void arch_cpu_idle_enter(void);
193void arch_cpu_idle_exit(void);
194void arch_cpu_idle_dead(void);
195
196int cpu_report_state(int cpu);
197int cpu_check_up_prepare(int cpu);
198void cpu_set_state_online(int cpu);
199void play_idle_precise(u64 duration_ns, u64 latency_ns);
200
201static inline void play_idle(unsigned long duration_us)
202{
203 play_idle_precise(duration_us * NSEC_PER_USEC, U64_MAX);
204}
205
206#ifdef CONFIG_HOTPLUG_CPU
207bool cpu_wait_death(unsigned int cpu, int seconds);
208bool cpu_report_death(void);
209void cpuhp_report_idle_dead(void);
210#else
211static inline void cpuhp_report_idle_dead(void) { }
212#endif /* #ifdef CONFIG_HOTPLUG_CPU */
213
214enum cpuhp_smt_control {
215 CPU_SMT_ENABLED,
216 CPU_SMT_DISABLED,
217 CPU_SMT_FORCE_DISABLED,
218 CPU_SMT_NOT_SUPPORTED,
219 CPU_SMT_NOT_IMPLEMENTED,
220};
221
222#if defined(CONFIG_SMP) && defined(CONFIG_HOTPLUG_SMT)
223extern enum cpuhp_smt_control cpu_smt_control;
224extern void cpu_smt_disable(bool force);
225extern void cpu_smt_check_topology(void);
226extern bool cpu_smt_possible(void);
227extern int cpuhp_smt_enable(void);
228extern int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval);
229#else
230# define cpu_smt_control (CPU_SMT_NOT_IMPLEMENTED)
231static inline void cpu_smt_disable(bool force) { }
232static inline void cpu_smt_check_topology(void) { }
233static inline bool cpu_smt_possible(void) { return false; }
234static inline int cpuhp_smt_enable(void) { return 0; }
235static inline int cpuhp_smt_disable(enum cpuhp_smt_control ctrlval) { return 0; }
236#endif
237
238extern bool cpu_mitigations_off(void);
239extern bool cpu_mitigations_auto_nosmt(void);
240
241#endif /* _LINUX_CPU_H_ */