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/cpuhotplug.h>
20#include <linux/cpuhplock.h>
21#include <linux/cpu_smt.h>
22
23struct device;
24struct device_node;
25struct attribute_group;
26
27struct cpu {
28 int node_id; /* The node which contains the CPU */
29 int hotpluggable; /* creates sysfs control file if hotpluggable */
30 struct device dev;
31};
32
33extern void boot_cpu_init(void);
34extern void boot_cpu_hotplug_init(void);
35extern void cpu_init(void);
36extern void trap_init(void);
37
38extern int register_cpu(struct cpu *cpu, int num);
39extern struct device *get_cpu_device(unsigned cpu);
40extern bool cpu_is_hotpluggable(unsigned cpu);
41extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
42extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
43 int cpu, unsigned int *thread);
44
45extern int cpu_add_dev_attr(struct device_attribute *attr);
46extern void cpu_remove_dev_attr(struct device_attribute *attr);
47
48extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
49extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
50
51extern ssize_t cpu_show_meltdown(struct device *dev,
52 struct device_attribute *attr, char *buf);
53extern ssize_t cpu_show_spectre_v1(struct device *dev,
54 struct device_attribute *attr, char *buf);
55extern ssize_t cpu_show_spectre_v2(struct device *dev,
56 struct device_attribute *attr, char *buf);
57extern ssize_t cpu_show_spec_store_bypass(struct device *dev,
58 struct device_attribute *attr, char *buf);
59extern ssize_t cpu_show_l1tf(struct device *dev,
60 struct device_attribute *attr, char *buf);
61extern ssize_t cpu_show_mds(struct device *dev,
62 struct device_attribute *attr, char *buf);
63extern ssize_t cpu_show_tsx_async_abort(struct device *dev,
64 struct device_attribute *attr,
65 char *buf);
66extern ssize_t cpu_show_itlb_multihit(struct device *dev,
67 struct device_attribute *attr, char *buf);
68extern ssize_t cpu_show_srbds(struct device *dev, struct device_attribute *attr, char *buf);
69extern ssize_t cpu_show_mmio_stale_data(struct device *dev,
70 struct device_attribute *attr,
71 char *buf);
72extern ssize_t cpu_show_retbleed(struct device *dev,
73 struct device_attribute *attr, char *buf);
74extern ssize_t cpu_show_spec_rstack_overflow(struct device *dev,
75 struct device_attribute *attr, char *buf);
76extern ssize_t cpu_show_gds(struct device *dev,
77 struct device_attribute *attr, char *buf);
78extern ssize_t cpu_show_reg_file_data_sampling(struct device *dev,
79 struct device_attribute *attr, char *buf);
80extern ssize_t cpu_show_ghostwrite(struct device *dev, struct device_attribute *attr, char *buf);
81
82extern __printf(4, 5)
83struct device *cpu_device_create(struct device *parent, void *drvdata,
84 const struct attribute_group **groups,
85 const char *fmt, ...);
86extern bool arch_cpu_is_hotpluggable(int cpu);
87extern int arch_register_cpu(int cpu);
88extern void arch_unregister_cpu(int cpu);
89#ifdef CONFIG_HOTPLUG_CPU
90extern void unregister_cpu(struct cpu *cpu);
91extern ssize_t arch_cpu_probe(const char *, size_t);
92extern ssize_t arch_cpu_release(const char *, size_t);
93#endif
94
95#ifdef CONFIG_GENERIC_CPU_DEVICES
96DECLARE_PER_CPU(struct cpu, cpu_devices);
97#endif
98
99/*
100 * These states are not related to the core CPU hotplug mechanism. They are
101 * used by various (sub)architectures to track internal state
102 */
103#define CPU_ONLINE 0x0002 /* CPU is up */
104#define CPU_UP_PREPARE 0x0003 /* CPU coming up */
105#define CPU_DEAD 0x0007 /* CPU dead */
106#define CPU_DEAD_FROZEN 0x0008 /* CPU timed out on unplug */
107#define CPU_POST_DEAD 0x0009 /* CPU successfully unplugged */
108#define CPU_BROKEN 0x000B /* CPU did not die properly */
109
110#ifdef CONFIG_SMP
111extern bool cpuhp_tasks_frozen;
112int add_cpu(unsigned int cpu);
113int cpu_device_up(struct device *dev);
114void notify_cpu_starting(unsigned int cpu);
115extern void cpu_maps_update_begin(void);
116extern void cpu_maps_update_done(void);
117int bringup_hibernate_cpu(unsigned int sleep_cpu);
118void bringup_nonboot_cpus(unsigned int max_cpus);
119
120#else /* CONFIG_SMP */
121#define cpuhp_tasks_frozen 0
122
123static inline void cpu_maps_update_begin(void)
124{
125}
126
127static inline void cpu_maps_update_done(void)
128{
129}
130
131static inline int add_cpu(unsigned int cpu) { return 0;}
132
133#endif /* CONFIG_SMP */
134extern const struct bus_type cpu_subsys;
135
136#ifdef CONFIG_PM_SLEEP_SMP
137extern int freeze_secondary_cpus(int primary);
138extern void thaw_secondary_cpus(void);
139
140static inline int suspend_disable_secondary_cpus(void)
141{
142 int cpu = 0;
143
144 if (IS_ENABLED(CONFIG_PM_SLEEP_SMP_NONZERO_CPU))
145 cpu = -1;
146
147 return freeze_secondary_cpus(cpu);
148}
149static inline void suspend_enable_secondary_cpus(void)
150{
151 return thaw_secondary_cpus();
152}
153
154#else /* !CONFIG_PM_SLEEP_SMP */
155static inline void thaw_secondary_cpus(void) {}
156static inline int suspend_disable_secondary_cpus(void) { return 0; }
157static inline void suspend_enable_secondary_cpus(void) { }
158#endif /* !CONFIG_PM_SLEEP_SMP */
159
160void __noreturn cpu_startup_entry(enum cpuhp_state state);
161
162void cpu_idle_poll_ctrl(bool enable);
163
164bool cpu_in_idle(unsigned long pc);
165
166void arch_cpu_idle(void);
167void arch_cpu_idle_prepare(void);
168void arch_cpu_idle_enter(void);
169void arch_cpu_idle_exit(void);
170void arch_tick_broadcast_enter(void);
171void arch_tick_broadcast_exit(void);
172void __noreturn arch_cpu_idle_dead(void);
173
174#ifdef CONFIG_ARCH_HAS_CPU_FINALIZE_INIT
175void arch_cpu_finalize_init(void);
176#else
177static inline void arch_cpu_finalize_init(void) { }
178#endif
179
180void play_idle_precise(u64 duration_ns, u64 latency_ns);
181
182static inline void play_idle(unsigned long duration_us)
183{
184 play_idle_precise(duration_us * NSEC_PER_USEC, U64_MAX);
185}
186
187#ifdef CONFIG_HOTPLUG_CPU
188void cpuhp_report_idle_dead(void);
189#else
190static inline void cpuhp_report_idle_dead(void) { }
191#endif /* #ifdef CONFIG_HOTPLUG_CPU */
192
193#ifdef CONFIG_CPU_MITIGATIONS
194extern bool cpu_mitigations_off(void);
195extern bool cpu_mitigations_auto_nosmt(void);
196#else
197static inline bool cpu_mitigations_off(void)
198{
199 return true;
200}
201static inline bool cpu_mitigations_auto_nosmt(void)
202{
203 return false;
204}
205#endif
206
207#endif /* _LINUX_CPU_H_ */