blob: d2ca8c38f9c45c0b279ef329c7abf130fcd0dc61 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
Robert P. J. Day611a75e12013-05-03 06:45:48 -040010 * CPUs are exported via sysfs in the devices/system/cpu
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 */
13#ifndef _LINUX_CPU_H_
14#define _LINUX_CPU_H_
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/node.h>
17#include <linux/compiler.h>
18#include <linux/cpumask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
Paul Gortmaker313162d2012-01-30 11:46:54 -050020struct device;
David Millerd1cb9d12013-10-03 17:24:51 -040021struct device_node;
Sudeep Holla3d529432014-09-30 14:48:24 +010022struct attribute_group;
Paul Gortmaker313162d2012-01-30 11:46:54 -050023
Linus Torvalds1da177e2005-04-16 15:20:36 -070024struct cpu {
25 int node_id; /* The node which contains the CPU */
Siddha, Suresh B72486f12006-12-07 02:14:10 +010026 int hotpluggable; /* creates sysfs control file if hotpluggable */
Kay Sievers8a25a2f2011-12-21 14:29:42 -080027 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028};
29
KAMEZAWA Hiroyuki76b67ed2006-06-27 02:53:41 -070030extern int register_cpu(struct cpu *cpu, int num);
Kay Sievers8a25a2f2011-12-21 14:29:42 -080031extern struct device *get_cpu_device(unsigned cpu);
Josh Triplett29875572011-12-03 13:06:50 -080032extern bool cpu_is_hotpluggable(unsigned cpu);
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +010033extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
David Millerd1cb9d12013-10-03 17:24:51 -040034extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
35 int cpu, unsigned int *thread);
Christian Krafft0344c6c2006-10-24 18:31:24 +020036
Kay Sievers8a25a2f2011-12-21 14:29:42 -080037extern int cpu_add_dev_attr(struct device_attribute *attr);
38extern void cpu_remove_dev_attr(struct device_attribute *attr);
Christian Krafft0344c6c2006-10-24 18:31:24 +020039
Kay Sievers8a25a2f2011-12-21 14:29:42 -080040extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
41extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
Christian Krafft0344c6c2006-10-24 18:31:24 +020042
Nicolas Iooss8db14862015-07-17 16:23:42 -070043extern __printf(4, 5)
44struct device *cpu_device_create(struct device *parent, void *drvdata,
45 const struct attribute_group **groups,
46 const char *fmt, ...);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#ifdef CONFIG_HOTPLUG_CPU
KAMEZAWA Hiroyuki76b67ed2006-06-27 02:53:41 -070048extern void unregister_cpu(struct cpu *cpu);
Nathan Fontenot12633e82009-11-25 17:23:25 +000049extern ssize_t arch_cpu_probe(const char *, size_t);
50extern ssize_t arch_cpu_release(const char *, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#endif
52struct notifier_block;
53
Tejun Heo50a323b2010-06-08 21:40:36 +020054/*
55 * CPU notifier priorities.
56 */
57enum {
Tejun Heo3a101d02010-06-08 21:40:36 +020058 /*
59 * SCHED_ACTIVE marks a cpu which is coming up active during
60 * CPU_ONLINE and CPU_DOWN_FAILED and must be the first
61 * notifier. CPUSET_ACTIVE adjusts cpuset according to
62 * cpu_active mask right after SCHED_ACTIVE. During
63 * CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are
64 * ordered in the similar way.
65 *
66 * This ordering guarantees consistent cpu_active mask and
67 * migration behavior to all cpu notifiers.
68 */
69 CPU_PRI_SCHED_ACTIVE = INT_MAX,
70 CPU_PRI_CPUSET_ACTIVE = INT_MAX - 1,
71 CPU_PRI_SCHED_INACTIVE = INT_MIN + 1,
72 CPU_PRI_CPUSET_INACTIVE = INT_MIN,
73
Tejun Heo50a323b2010-06-08 21:40:36 +020074 /* migration should happen before other stuff but after perf */
75 CPU_PRI_PERF = 20,
76 CPU_PRI_MIGRATION = 10,
Paul E. McKenney00df35f2015-04-12 08:06:55 -070077 CPU_PRI_SMPBOOT = 9,
Tejun Heo65758202012-07-17 12:39:26 -070078 /* bring up workqueues before normal notifiers and down after */
79 CPU_PRI_WORKQUEUE_UP = 5,
80 CPU_PRI_WORKQUEUE_DOWN = -5,
Tejun Heo50a323b2010-06-08 21:40:36 +020081};
82
Amerigo Wang80f1ff92011-07-25 17:13:08 -070083#define CPU_ONLINE 0x0002 /* CPU (unsigned)v is up */
84#define CPU_UP_PREPARE 0x0003 /* CPU (unsigned)v coming up */
85#define CPU_UP_CANCELED 0x0004 /* CPU (unsigned)v NOT coming up */
86#define CPU_DOWN_PREPARE 0x0005 /* CPU (unsigned)v going down */
87#define CPU_DOWN_FAILED 0x0006 /* CPU (unsigned)v NOT going down */
88#define CPU_DEAD 0x0007 /* CPU (unsigned)v dead */
89#define CPU_DYING 0x0008 /* CPU (unsigned)v not running any task,
90 * not handling interrupts, soon dead.
91 * Called on the dying cpu, interrupts
92 * are already disabled. Must not
93 * sleep, must not fail */
94#define CPU_POST_DEAD 0x0009 /* CPU (unsigned)v dead, cpu_hotplug
95 * lock is dropped */
96#define CPU_STARTING 0x000A /* CPU (unsigned)v soon running.
97 * Called on the new cpu, just before
98 * enabling interrupts. Must not sleep,
99 * must not fail */
Paul E. McKenney88428cc2015-01-28 14:42:09 -0800100#define CPU_DYING_IDLE 0x000B /* CPU (unsigned)v dying, reached
101 * idle loop. */
Paul E. McKenney8038dad2015-02-25 10:34:39 -0800102#define CPU_BROKEN 0x000C /* CPU (unsigned)v did not die properly,
103 * perhaps due to preemption. */
Amerigo Wang80f1ff92011-07-25 17:13:08 -0700104
105/* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
106 * operation in progress
107 */
108#define CPU_TASKS_FROZEN 0x0010
109
110#define CPU_ONLINE_FROZEN (CPU_ONLINE | CPU_TASKS_FROZEN)
111#define CPU_UP_PREPARE_FROZEN (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
112#define CPU_UP_CANCELED_FROZEN (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
113#define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
114#define CPU_DOWN_FAILED_FROZEN (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
115#define CPU_DEAD_FROZEN (CPU_DEAD | CPU_TASKS_FROZEN)
116#define CPU_DYING_FROZEN (CPU_DYING | CPU_TASKS_FROZEN)
117#define CPU_STARTING_FROZEN (CPU_STARTING | CPU_TASKS_FROZEN)
118
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120#ifdef CONFIG_SMP
121/* Need to know about CPUs going up/down? */
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700122#if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
123#define cpu_notifier(fn, pri) { \
Paul Gortmaker0db06282013-06-19 14:53:51 -0400124 static struct notifier_block fn##_nb = \
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700125 { .notifier_call = fn, .priority = pri }; \
126 register_cpu_notifier(&fn##_nb); \
127}
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530128
129#define __cpu_notifier(fn, pri) { \
130 static struct notifier_block fn##_nb = \
131 { .notifier_call = fn, .priority = pri }; \
132 __register_cpu_notifier(&fn##_nb); \
133}
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700134#else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
135#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530136#define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700137#endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530138
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700139#ifdef CONFIG_HOTPLUG_CPU
Avi Kivity47e627b2007-02-12 00:54:43 -0800140extern int register_cpu_notifier(struct notifier_block *nb);
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530141extern int __register_cpu_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142extern void unregister_cpu_notifier(struct notifier_block *nb);
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530143extern void __unregister_cpu_notifier(struct notifier_block *nb);
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700144#else
Avi Kivity47e627b2007-02-12 00:54:43 -0800145
146#ifndef MODULE
147extern int register_cpu_notifier(struct notifier_block *nb);
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530148extern int __register_cpu_notifier(struct notifier_block *nb);
Avi Kivity47e627b2007-02-12 00:54:43 -0800149#else
150static inline int register_cpu_notifier(struct notifier_block *nb)
151{
152 return 0;
153}
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530154
155static inline int __register_cpu_notifier(struct notifier_block *nb)
156{
157 return 0;
158}
Avi Kivity47e627b2007-02-12 00:54:43 -0800159#endif
160
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700161static inline void unregister_cpu_notifier(struct notifier_block *nb)
162{
163}
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530164
165static inline void __unregister_cpu_notifier(struct notifier_block *nb)
166{
167}
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700168#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Paul E. McKenney00df35f2015-04-12 08:06:55 -0700170void smpboot_thread_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171int cpu_up(unsigned int cpu);
Manfred Spraule545a612008-09-07 16:57:22 +0200172void notify_cpu_starting(unsigned int cpu);
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700173extern void cpu_maps_update_begin(void);
174extern void cpu_maps_update_done(void);
Ingo Molnard0d23b52008-01-25 21:08:02 +0100175
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530176#define cpu_notifier_register_begin cpu_maps_update_begin
177#define cpu_notifier_register_done cpu_maps_update_done
178
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700179#else /* CONFIG_SMP */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700181#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530182#define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184static inline int register_cpu_notifier(struct notifier_block *nb)
185{
186 return 0;
187}
Ingo Molnard0d23b52008-01-25 21:08:02 +0100188
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530189static inline int __register_cpu_notifier(struct notifier_block *nb)
190{
191 return 0;
192}
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194static inline void unregister_cpu_notifier(struct notifier_block *nb)
195{
196}
197
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530198static inline void __unregister_cpu_notifier(struct notifier_block *nb)
199{
200}
201
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700202static inline void cpu_maps_update_begin(void)
203{
204}
205
206static inline void cpu_maps_update_done(void)
207{
208}
209
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530210static inline void cpu_notifier_register_begin(void)
211{
212}
213
214static inline void cpu_notifier_register_done(void)
215{
216}
217
Ingo Molnar590ee7d2015-04-13 10:04:59 +0200218static inline void smpboot_thread_init(void)
219{
220}
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222#endif /* CONFIG_SMP */
Kay Sievers8a25a2f2011-12-21 14:29:42 -0800223extern struct bus_type cpu_subsys;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225#ifdef CONFIG_HOTPLUG_CPU
226/* Stop CPUs going up and down. */
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800227
Toshi Kanib9d10be2013-08-12 09:45:53 -0600228extern void cpu_hotplug_begin(void);
229extern void cpu_hotplug_done(void);
Gautham R Shenoy86ef5c92008-01-25 21:08:02 +0100230extern void get_online_cpus(void);
231extern void put_online_cpus(void);
Srivatsa S. Bhat16e53db2013-06-12 14:04:36 -0700232extern void cpu_hotplug_disable(void);
233extern void cpu_hotplug_enable(void);
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700234#define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530235#define __hotcpu_notifier(fn, pri) __cpu_notifier(fn, pri)
Chandra Seetharaman39f48852006-06-27 02:54:10 -0700236#define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530237#define __register_hotcpu_notifier(nb) __register_cpu_notifier(nb)
Chandra Seetharaman39f48852006-06-27 02:54:10 -0700238#define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530239#define __unregister_hotcpu_notifier(nb) __unregister_cpu_notifier(nb)
Anton Vorontsovcb792952012-05-31 16:26:22 -0700240void clear_tasks_mm_cpumask(int cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241int cpu_down(unsigned int cpu);
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800242
243#else /* CONFIG_HOTPLUG_CPU */
244
Toshi Kanib9d10be2013-08-12 09:45:53 -0600245static inline void cpu_hotplug_begin(void) {}
246static inline void cpu_hotplug_done(void) {}
Gautham R Shenoy86ef5c92008-01-25 21:08:02 +0100247#define get_online_cpus() do { } while (0)
248#define put_online_cpus() do { } while (0)
Srivatsa S. Bhat16e53db2013-06-12 14:04:36 -0700249#define cpu_hotplug_disable() do { } while (0)
250#define cpu_hotplug_enable() do { } while (0)
Ingo Molnar023160672006-12-06 20:38:17 -0800251#define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530252#define __hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
Satyam Sharma761bb432007-10-18 03:06:38 -0700253/* These aren't inline functions due to a GCC bug. */
254#define register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530255#define __register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
Satyam Sharma761bb432007-10-18 03:06:38 -0700256#define unregister_hotcpu_notifier(nb) ({ (void)(nb); })
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530257#define __unregister_hotcpu_notifier(nb) ({ (void)(nb); })
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800258#endif /* CONFIG_HOTPLUG_CPU */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700260#ifdef CONFIG_PM_SLEEP_SMP
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700261extern int disable_nonboot_cpus(void);
262extern void enable_nonboot_cpus(void);
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700263#else /* !CONFIG_PM_SLEEP_SMP */
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700264static inline int disable_nonboot_cpus(void) { return 0; }
265static inline void enable_nonboot_cpus(void) {}
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700266#endif /* !CONFIG_PM_SLEEP_SMP */
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700267
Thomas Gleixnera1a04ec2013-03-21 22:49:34 +0100268enum cpuhp_state {
269 CPUHP_OFFLINE,
270 CPUHP_ONLINE,
271};
272
273void cpu_startup_entry(enum cpuhp_state state);
Thomas Gleixnera1a04ec2013-03-21 22:49:34 +0100274
Thomas Gleixnerd1669912013-03-21 22:49:35 +0100275void cpu_idle_poll_ctrl(bool enable);
276
277void arch_cpu_idle(void);
278void arch_cpu_idle_prepare(void);
279void arch_cpu_idle_enter(void);
280void arch_cpu_idle_exit(void);
281void arch_cpu_idle_dead(void);
282
Paul E. McKenney8038dad2015-02-25 10:34:39 -0800283DECLARE_PER_CPU(bool, cpu_dead_idle);
284
285int cpu_report_state(int cpu);
286int cpu_check_up_prepare(int cpu);
287void cpu_set_state_online(int cpu);
288#ifdef CONFIG_HOTPLUG_CPU
289bool cpu_wait_death(unsigned int cpu, int seconds);
290bool cpu_report_death(void);
291#endif /* #ifdef CONFIG_HOTPLUG_CPU */
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293#endif /* _LINUX_CPU_H_ */