blob: 81887120395c81347c6a74ad3c92d847f3c4c90d [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;
Paul Gortmaker313162d2012-01-30 11:46:54 -050022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023struct cpu {
24 int node_id; /* The node which contains the CPU */
Siddha, Suresh B72486f12006-12-07 02:14:10 +010025 int hotpluggable; /* creates sysfs control file if hotpluggable */
Kay Sievers8a25a2f2011-12-21 14:29:42 -080026 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027};
28
KAMEZAWA Hiroyuki76b67ed2006-06-27 02:53:41 -070029extern int register_cpu(struct cpu *cpu, int num);
Kay Sievers8a25a2f2011-12-21 14:29:42 -080030extern struct device *get_cpu_device(unsigned cpu);
Josh Triplett29875572011-12-03 13:06:50 -080031extern bool cpu_is_hotpluggable(unsigned cpu);
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +010032extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
David Millerd1cb9d12013-10-03 17:24:51 -040033extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
34 int cpu, unsigned int *thread);
Christian Krafft0344c6c2006-10-24 18:31:24 +020035
Kay Sievers8a25a2f2011-12-21 14:29:42 -080036extern int cpu_add_dev_attr(struct device_attribute *attr);
37extern void cpu_remove_dev_attr(struct device_attribute *attr);
Christian Krafft0344c6c2006-10-24 18:31:24 +020038
Kay Sievers8a25a2f2011-12-21 14:29:42 -080039extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
40extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
Christian Krafft0344c6c2006-10-24 18:31:24 +020041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#ifdef CONFIG_HOTPLUG_CPU
KAMEZAWA Hiroyuki76b67ed2006-06-27 02:53:41 -070043extern void unregister_cpu(struct cpu *cpu);
Nathan Fontenot12633e82009-11-25 17:23:25 +000044extern ssize_t arch_cpu_probe(const char *, size_t);
45extern ssize_t arch_cpu_release(const char *, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#endif
47struct notifier_block;
48
Tejun Heo50a323b2010-06-08 21:40:36 +020049/*
50 * CPU notifier priorities.
51 */
52enum {
Tejun Heo3a101d02010-06-08 21:40:36 +020053 /*
54 * SCHED_ACTIVE marks a cpu which is coming up active during
55 * CPU_ONLINE and CPU_DOWN_FAILED and must be the first
56 * notifier. CPUSET_ACTIVE adjusts cpuset according to
57 * cpu_active mask right after SCHED_ACTIVE. During
58 * CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are
59 * ordered in the similar way.
60 *
61 * This ordering guarantees consistent cpu_active mask and
62 * migration behavior to all cpu notifiers.
63 */
64 CPU_PRI_SCHED_ACTIVE = INT_MAX,
65 CPU_PRI_CPUSET_ACTIVE = INT_MAX - 1,
66 CPU_PRI_SCHED_INACTIVE = INT_MIN + 1,
67 CPU_PRI_CPUSET_INACTIVE = INT_MIN,
68
Tejun Heo50a323b2010-06-08 21:40:36 +020069 /* migration should happen before other stuff but after perf */
70 CPU_PRI_PERF = 20,
71 CPU_PRI_MIGRATION = 10,
Tejun Heo65758202012-07-17 12:39:26 -070072 /* bring up workqueues before normal notifiers and down after */
73 CPU_PRI_WORKQUEUE_UP = 5,
74 CPU_PRI_WORKQUEUE_DOWN = -5,
Tejun Heo50a323b2010-06-08 21:40:36 +020075};
76
Amerigo Wang80f1ff92011-07-25 17:13:08 -070077#define CPU_ONLINE 0x0002 /* CPU (unsigned)v is up */
78#define CPU_UP_PREPARE 0x0003 /* CPU (unsigned)v coming up */
79#define CPU_UP_CANCELED 0x0004 /* CPU (unsigned)v NOT coming up */
80#define CPU_DOWN_PREPARE 0x0005 /* CPU (unsigned)v going down */
81#define CPU_DOWN_FAILED 0x0006 /* CPU (unsigned)v NOT going down */
82#define CPU_DEAD 0x0007 /* CPU (unsigned)v dead */
83#define CPU_DYING 0x0008 /* CPU (unsigned)v not running any task,
84 * not handling interrupts, soon dead.
85 * Called on the dying cpu, interrupts
86 * are already disabled. Must not
87 * sleep, must not fail */
88#define CPU_POST_DEAD 0x0009 /* CPU (unsigned)v dead, cpu_hotplug
89 * lock is dropped */
90#define CPU_STARTING 0x000A /* CPU (unsigned)v soon running.
91 * Called on the new cpu, just before
92 * enabling interrupts. Must not sleep,
93 * must not fail */
94
95/* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
96 * operation in progress
97 */
98#define CPU_TASKS_FROZEN 0x0010
99
100#define CPU_ONLINE_FROZEN (CPU_ONLINE | CPU_TASKS_FROZEN)
101#define CPU_UP_PREPARE_FROZEN (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
102#define CPU_UP_CANCELED_FROZEN (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
103#define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
104#define CPU_DOWN_FAILED_FROZEN (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
105#define CPU_DEAD_FROZEN (CPU_DEAD | CPU_TASKS_FROZEN)
106#define CPU_DYING_FROZEN (CPU_DYING | CPU_TASKS_FROZEN)
107#define CPU_STARTING_FROZEN (CPU_STARTING | CPU_TASKS_FROZEN)
108
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110#ifdef CONFIG_SMP
111/* Need to know about CPUs going up/down? */
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700112#if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
113#define cpu_notifier(fn, pri) { \
Paul Gortmaker0db06282013-06-19 14:53:51 -0400114 static struct notifier_block fn##_nb = \
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700115 { .notifier_call = fn, .priority = pri }; \
116 register_cpu_notifier(&fn##_nb); \
117}
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530118
119#define __cpu_notifier(fn, pri) { \
120 static struct notifier_block fn##_nb = \
121 { .notifier_call = fn, .priority = pri }; \
122 __register_cpu_notifier(&fn##_nb); \
123}
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700124#else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
125#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530126#define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700127#endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530128
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700129#ifdef CONFIG_HOTPLUG_CPU
Avi Kivity47e627b2007-02-12 00:54:43 -0800130extern int register_cpu_notifier(struct notifier_block *nb);
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530131extern int __register_cpu_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132extern void unregister_cpu_notifier(struct notifier_block *nb);
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530133extern void __unregister_cpu_notifier(struct notifier_block *nb);
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700134#else
Avi Kivity47e627b2007-02-12 00:54:43 -0800135
136#ifndef MODULE
137extern int register_cpu_notifier(struct notifier_block *nb);
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530138extern int __register_cpu_notifier(struct notifier_block *nb);
Avi Kivity47e627b2007-02-12 00:54:43 -0800139#else
140static inline int register_cpu_notifier(struct notifier_block *nb)
141{
142 return 0;
143}
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530144
145static inline int __register_cpu_notifier(struct notifier_block *nb)
146{
147 return 0;
148}
Avi Kivity47e627b2007-02-12 00:54:43 -0800149#endif
150
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700151static inline void unregister_cpu_notifier(struct notifier_block *nb)
152{
153}
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530154
155static inline void __unregister_cpu_notifier(struct notifier_block *nb)
156{
157}
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700158#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160int cpu_up(unsigned int cpu);
Manfred Spraule545a612008-09-07 16:57:22 +0200161void notify_cpu_starting(unsigned int cpu);
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700162extern void cpu_maps_update_begin(void);
163extern void cpu_maps_update_done(void);
Ingo Molnard0d23b52008-01-25 21:08:02 +0100164
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530165#define cpu_notifier_register_begin cpu_maps_update_begin
166#define cpu_notifier_register_done cpu_maps_update_done
167
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700168#else /* CONFIG_SMP */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700170#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530171#define __cpu_notifier(fn, pri) do { (void)(fn); } while (0)
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173static inline int register_cpu_notifier(struct notifier_block *nb)
174{
175 return 0;
176}
Ingo Molnard0d23b52008-01-25 21:08:02 +0100177
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530178static inline int __register_cpu_notifier(struct notifier_block *nb)
179{
180 return 0;
181}
182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183static inline void unregister_cpu_notifier(struct notifier_block *nb)
184{
185}
186
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530187static inline void __unregister_cpu_notifier(struct notifier_block *nb)
188{
189}
190
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700191static inline void cpu_maps_update_begin(void)
192{
193}
194
195static inline void cpu_maps_update_done(void)
196{
197}
198
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530199static inline void cpu_notifier_register_begin(void)
200{
201}
202
203static inline void cpu_notifier_register_done(void)
204{
205}
206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207#endif /* CONFIG_SMP */
Kay Sievers8a25a2f2011-12-21 14:29:42 -0800208extern struct bus_type cpu_subsys;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210#ifdef CONFIG_HOTPLUG_CPU
211/* Stop CPUs going up and down. */
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800212
Toshi Kanib9d10be2013-08-12 09:45:53 -0600213extern void cpu_hotplug_begin(void);
214extern void cpu_hotplug_done(void);
Gautham R Shenoy86ef5c92008-01-25 21:08:02 +0100215extern void get_online_cpus(void);
216extern void put_online_cpus(void);
Srivatsa S. Bhat16e53db2013-06-12 14:04:36 -0700217extern void cpu_hotplug_disable(void);
218extern void cpu_hotplug_enable(void);
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700219#define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530220#define __hotcpu_notifier(fn, pri) __cpu_notifier(fn, pri)
Chandra Seetharaman39f48852006-06-27 02:54:10 -0700221#define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530222#define __register_hotcpu_notifier(nb) __register_cpu_notifier(nb)
Chandra Seetharaman39f48852006-06-27 02:54:10 -0700223#define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530224#define __unregister_hotcpu_notifier(nb) __unregister_cpu_notifier(nb)
Anton Vorontsovcb792952012-05-31 16:26:22 -0700225void clear_tasks_mm_cpumask(int cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226int cpu_down(unsigned int cpu);
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800227
228#else /* CONFIG_HOTPLUG_CPU */
229
Toshi Kanib9d10be2013-08-12 09:45:53 -0600230static inline void cpu_hotplug_begin(void) {}
231static inline void cpu_hotplug_done(void) {}
Gautham R Shenoy86ef5c92008-01-25 21:08:02 +0100232#define get_online_cpus() do { } while (0)
233#define put_online_cpus() do { } while (0)
Srivatsa S. Bhat16e53db2013-06-12 14:04:36 -0700234#define cpu_hotplug_disable() do { } while (0)
235#define cpu_hotplug_enable() do { } while (0)
Ingo Molnar023160672006-12-06 20:38:17 -0800236#define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530237#define __hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
Satyam Sharma761bb432007-10-18 03:06:38 -0700238/* These aren't inline functions due to a GCC bug. */
239#define register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530240#define __register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
Satyam Sharma761bb432007-10-18 03:06:38 -0700241#define unregister_hotcpu_notifier(nb) ({ (void)(nb); })
Srivatsa S. Bhat93ae4f92014-03-11 02:04:14 +0530242#define __unregister_hotcpu_notifier(nb) ({ (void)(nb); })
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800243#endif /* CONFIG_HOTPLUG_CPU */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700245#ifdef CONFIG_PM_SLEEP_SMP
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700246extern int disable_nonboot_cpus(void);
247extern void enable_nonboot_cpus(void);
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700248#else /* !CONFIG_PM_SLEEP_SMP */
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700249static inline int disable_nonboot_cpus(void) { return 0; }
250static inline void enable_nonboot_cpus(void) {}
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700251#endif /* !CONFIG_PM_SLEEP_SMP */
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700252
Thomas Gleixnera1a04ec2013-03-21 22:49:34 +0100253enum cpuhp_state {
254 CPUHP_OFFLINE,
255 CPUHP_ONLINE,
256};
257
258void cpu_startup_entry(enum cpuhp_state state);
259void cpu_idle(void);
260
Thomas Gleixnerd1669912013-03-21 22:49:35 +0100261void cpu_idle_poll_ctrl(bool enable);
262
263void arch_cpu_idle(void);
264void arch_cpu_idle_prepare(void);
265void arch_cpu_idle_enter(void);
266void arch_cpu_idle_exit(void);
267void arch_cpu_idle_dead(void);
268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269#endif /* _LINUX_CPU_H_ */