Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
9 *
10 * CPUs are exported via sysfs in the devices/system/cpu
11 * directory.
12 */
13#ifndef _LINUX_CPU_H_
14#define _LINUX_CPU_H_
15
16#include <linux/node.h>
17#include <linux/compiler.h>
18#include <linux/cpumask.h>
19#include <linux/cpuhotplug.h>
20
21struct device;
22struct device_node;
23struct attribute_group;
24
25struct cpu {
26 int node_id; /* The node which contains the CPU */
27 int hotpluggable; /* creates sysfs control file if hotpluggable */
28 struct device dev;
29};
30
31extern void boot_cpu_init(void);
32extern void boot_cpu_state_init(void);
33
34extern int register_cpu(struct cpu *cpu, int num);
35extern struct device *get_cpu_device(unsigned cpu);
36extern bool cpu_is_hotpluggable(unsigned cpu);
37extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
38extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
39 int cpu, unsigned int *thread);
40
41extern int cpu_add_dev_attr(struct device_attribute *attr);
42extern void cpu_remove_dev_attr(struct device_attribute *attr);
43
44extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
45extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
46
47extern __printf(4, 5)
48struct device *cpu_device_create(struct device *parent, void *drvdata,
49 const struct attribute_group **groups,
50 const char *fmt, ...);
51#ifdef CONFIG_HOTPLUG_CPU
52extern void unregister_cpu(struct cpu *cpu);
53extern ssize_t arch_cpu_probe(const char *, size_t);
54extern ssize_t arch_cpu_release(const char *, size_t);
55#endif
56struct notifier_block;
57
58/*
59 * CPU notifier priorities.
60 */
61enum {
62 CPU_PRI_PERF = 20,
63
64 /* bring up workqueues before normal notifiers and down after */
65 CPU_PRI_WORKQUEUE_UP = 5,
66 CPU_PRI_WORKQUEUE_DOWN = -5,
67};
68
69#define CPU_ONLINE 0x0002 /* CPU (unsigned)v is up */
70#define CPU_UP_PREPARE 0x0003 /* CPU (unsigned)v coming up */
71#define CPU_UP_CANCELED 0x0004 /* CPU (unsigned)v NOT coming up */
72#define CPU_DOWN_PREPARE 0x0005 /* CPU (unsigned)v going down */
73#define CPU_DOWN_FAILED 0x0006 /* CPU (unsigned)v NOT going down */
74#define CPU_DEAD 0x0007 /* CPU (unsigned)v dead */
75#define CPU_DYING 0x0008 /* CPU (unsigned)v not running any task,
76 * not handling interrupts, soon dead.
77 * Called on the dying cpu, interrupts
78 * are already disabled. Must not
79 * sleep, must not fail */
80#define CPU_POST_DEAD 0x0009 /* CPU (unsigned)v dead, cpu_hotplug
81 * lock is dropped */
82#define CPU_STARTING 0x000A /* CPU (unsigned)v soon running.
83 * Called on the new cpu, just before
84 * enabling interrupts. Must not sleep,
85 * must not fail */
86#define CPU_BROKEN 0x000B /* CPU (unsigned)v did not die properly,
87 * perhaps due to preemption. */
88
89/* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
90 * operation in progress
91 */
92#define CPU_TASKS_FROZEN 0x0010
93
94#define CPU_ONLINE_FROZEN (CPU_ONLINE | CPU_TASKS_FROZEN)
95#define CPU_UP_PREPARE_FROZEN (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
96#define CPU_UP_CANCELED_FROZEN (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
97#define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
98#define CPU_DOWN_FAILED_FROZEN (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
99#define CPU_DEAD_FROZEN (CPU_DEAD | CPU_TASKS_FROZEN)
100#define CPU_DYING_FROZEN (CPU_DYING | CPU_TASKS_FROZEN)
101#define CPU_STARTING_FROZEN (CPU_STARTING | CPU_TASKS_FROZEN)
102
103
104#ifdef CONFIG_SMP
105extern bool cpuhp_tasks_frozen;
106/* Need to know about CPUs going up/down? */
107#if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
108#define cpu_notifier(fn, pri) { \
109 static struct notifier_block fn##_nb = \
110 { .notifier_call = fn, .priority = pri }; \
111 register_cpu_notifier(&fn##_nb); \
112}
113
114#define __cpu_notifier(fn, pri) { \
115 static struct notifier_block fn##_nb = \
116 { .notifier_call = fn, .priority = pri }; \
117 __register_cpu_notifier(&fn##_nb); \
118}
119#else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
120#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
121#define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
122#endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
123
124#ifdef CONFIG_HOTPLUG_CPU
125extern int register_cpu_notifier(struct notifier_block *nb);
126extern int __register_cpu_notifier(struct notifier_block *nb);
127extern void unregister_cpu_notifier(struct notifier_block *nb);
128extern void __unregister_cpu_notifier(struct notifier_block *nb);
129#else
130
131#ifndef MODULE
132extern int register_cpu_notifier(struct notifier_block *nb);
133extern int __register_cpu_notifier(struct notifier_block *nb);
134#else
135static inline int register_cpu_notifier(struct notifier_block *nb)
136{
137 return 0;
138}
139
140static inline int __register_cpu_notifier(struct notifier_block *nb)
141{
142 return 0;
143}
144#endif
145
146static inline void unregister_cpu_notifier(struct notifier_block *nb)
147{
148}
149
150static inline void __unregister_cpu_notifier(struct notifier_block *nb)
151{
152}
153#endif
154
155int cpu_up(unsigned int cpu);
156void notify_cpu_starting(unsigned int cpu);
157extern void cpu_maps_update_begin(void);
158extern void cpu_maps_update_done(void);
159
160#define cpu_notifier_register_begin cpu_maps_update_begin
161#define cpu_notifier_register_done cpu_maps_update_done
162
163#else /* CONFIG_SMP */
164#define cpuhp_tasks_frozen 0
165
166#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
167#define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
168
169static inline int register_cpu_notifier(struct notifier_block *nb)
170{
171 return 0;
172}
173
174static inline int __register_cpu_notifier(struct notifier_block *nb)
175{
176 return 0;
177}
178
179static inline void unregister_cpu_notifier(struct notifier_block *nb)
180{
181}
182
183static inline void __unregister_cpu_notifier(struct notifier_block *nb)
184{
185}
186
187static inline void cpu_maps_update_begin(void)
188{
189}
190
191static inline void cpu_maps_update_done(void)
192{
193}
194
195static inline void cpu_notifier_register_begin(void)
196{
197}
198
199static inline void cpu_notifier_register_done(void)
200{
201}
202
203#endif /* CONFIG_SMP */
204extern struct bus_type cpu_subsys;
205
206#ifdef CONFIG_HOTPLUG_CPU
207/* Stop CPUs going up and down. */
208
209extern void cpu_hotplug_begin(void);
210extern void cpu_hotplug_done(void);
211extern void get_online_cpus(void);
212extern void put_online_cpus(void);
213extern void cpu_hotplug_disable(void);
214extern void cpu_hotplug_enable(void);
215#define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
216#define __hotcpu_notifier(fn, pri) __cpu_notifier(fn, pri)
217#define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
218#define __register_hotcpu_notifier(nb) __register_cpu_notifier(nb)
219#define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
220#define __unregister_hotcpu_notifier(nb) __unregister_cpu_notifier(nb)
221void clear_tasks_mm_cpumask(int cpu);
222int cpu_down(unsigned int cpu);
223
224#else /* CONFIG_HOTPLUG_CPU */
225
226static inline void cpu_hotplug_begin(void) {}
227static inline void cpu_hotplug_done(void) {}
228#define get_online_cpus() do { } while (0)
229#define put_online_cpus() do { } while (0)
230#define cpu_hotplug_disable() do { } while (0)
231#define cpu_hotplug_enable() do { } while (0)
232#define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
233#define __hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
234/* These aren't inline functions due to a GCC bug. */
235#define register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
236#define __register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
237#define unregister_hotcpu_notifier(nb) ({ (void)(nb); })
238#define __unregister_hotcpu_notifier(nb) ({ (void)(nb); })
239#endif /* CONFIG_HOTPLUG_CPU */
240
241#ifdef CONFIG_PM_SLEEP_SMP
242extern int disable_nonboot_cpus(void);
243extern void enable_nonboot_cpus(void);
244#else /* !CONFIG_PM_SLEEP_SMP */
245static inline int disable_nonboot_cpus(void) { return 0; }
246static inline void enable_nonboot_cpus(void) {}
247#endif /* !CONFIG_PM_SLEEP_SMP */
248
249void cpu_startup_entry(enum cpuhp_state state);
250
251void cpu_idle_poll_ctrl(bool enable);
252
253void arch_cpu_idle(void);
254void arch_cpu_idle_prepare(void);
255void arch_cpu_idle_enter(void);
256void arch_cpu_idle_exit(void);
257void arch_cpu_idle_dead(void);
258
259int cpu_report_state(int cpu);
260int cpu_check_up_prepare(int cpu);
261void cpu_set_state_online(int cpu);
262#ifdef CONFIG_HOTPLUG_CPU
263bool cpu_wait_death(unsigned int cpu, int seconds);
264bool cpu_report_death(void);
265void cpuhp_report_idle_dead(void);
266#else
267static inline void cpuhp_report_idle_dead(void) { }
268#endif /* #ifdef CONFIG_HOTPLUG_CPU */
269
270#endif /* _LINUX_CPU_H_ */