blob: 6cb60fd2ea8454f4dad52cb4c32cd62a3301072f [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
9 * and system devices are handled in drivers/base/sys.c.
10 *
Rolf Eike Beerd51fe1b2005-09-02 08:59:25 +020011 * CPUs are exported via sysfs in the class/cpu/devices/
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * directory.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
14#ifndef _LINUX_CPU_H_
15#define _LINUX_CPU_H_
16
17#include <linux/sysdev.h>
18#include <linux/node.h>
19#include <linux/compiler.h>
20#include <linux/cpumask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22struct cpu {
23 int node_id; /* The node which contains the CPU */
Siddha, Suresh B72486f12006-12-07 02:14:10 +010024 int hotpluggable; /* creates sysfs control file if hotpluggable */
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 struct sys_device sysdev;
26};
27
KAMEZAWA Hiroyuki76b67ed92006-06-27 02:53:41 -070028extern int register_cpu(struct cpu *cpu, int num);
Andrew Mortona29d6422006-03-07 23:53:25 -080029extern struct sys_device *get_cpu_sysdev(unsigned cpu);
Christian Krafft0344c6c2006-10-24 18:31:24 +020030
31extern int cpu_add_sysdev_attr(struct sysdev_attribute *attr);
32extern void cpu_remove_sysdev_attr(struct sysdev_attribute *attr);
33
34extern int cpu_add_sysdev_attr_group(struct attribute_group *attrs);
35extern void cpu_remove_sysdev_attr_group(struct attribute_group *attrs);
36
Ralf Baechle3367b992007-05-08 00:27:52 -070037extern int sched_create_sysfs_power_savings_entries(struct sysdev_class *cls);
Christian Krafft0344c6c2006-10-24 18:31:24 +020038
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#ifdef CONFIG_HOTPLUG_CPU
KAMEZAWA Hiroyuki76b67ed92006-06-27 02:53:41 -070040extern void unregister_cpu(struct cpu *cpu);
Nathan Fontenot12633e82009-11-25 17:23:25 +000041extern ssize_t arch_cpu_probe(const char *, size_t);
42extern ssize_t arch_cpu_release(const char *, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#endif
44struct notifier_block;
45
Tejun Heo50a323b2010-06-08 21:40:36 +020046/*
47 * CPU notifier priorities.
48 */
49enum {
Tejun Heo3a101d02010-06-08 21:40:36 +020050 /*
51 * SCHED_ACTIVE marks a cpu which is coming up active during
52 * CPU_ONLINE and CPU_DOWN_FAILED and must be the first
53 * notifier. CPUSET_ACTIVE adjusts cpuset according to
54 * cpu_active mask right after SCHED_ACTIVE. During
55 * CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are
56 * ordered in the similar way.
57 *
58 * This ordering guarantees consistent cpu_active mask and
59 * migration behavior to all cpu notifiers.
60 */
61 CPU_PRI_SCHED_ACTIVE = INT_MAX,
62 CPU_PRI_CPUSET_ACTIVE = INT_MAX - 1,
63 CPU_PRI_SCHED_INACTIVE = INT_MIN + 1,
64 CPU_PRI_CPUSET_INACTIVE = INT_MIN,
65
Tejun Heo50a323b2010-06-08 21:40:36 +020066 /* migration should happen before other stuff but after perf */
67 CPU_PRI_PERF = 20,
68 CPU_PRI_MIGRATION = 10,
Tejun Heodb7bccf2010-06-29 10:07:12 +020069 /* prepare workqueues for other notifiers */
70 CPU_PRI_WORKQUEUE = 5,
Tejun Heo50a323b2010-06-08 21:40:36 +020071};
72
Amerigo Wang80f1ff92011-07-25 17:13:08 -070073#define CPU_ONLINE 0x0002 /* CPU (unsigned)v is up */
74#define CPU_UP_PREPARE 0x0003 /* CPU (unsigned)v coming up */
75#define CPU_UP_CANCELED 0x0004 /* CPU (unsigned)v NOT coming up */
76#define CPU_DOWN_PREPARE 0x0005 /* CPU (unsigned)v going down */
77#define CPU_DOWN_FAILED 0x0006 /* CPU (unsigned)v NOT going down */
78#define CPU_DEAD 0x0007 /* CPU (unsigned)v dead */
79#define CPU_DYING 0x0008 /* CPU (unsigned)v not running any task,
80 * not handling interrupts, soon dead.
81 * Called on the dying cpu, interrupts
82 * are already disabled. Must not
83 * sleep, must not fail */
84#define CPU_POST_DEAD 0x0009 /* CPU (unsigned)v dead, cpu_hotplug
85 * lock is dropped */
86#define CPU_STARTING 0x000A /* CPU (unsigned)v soon running.
87 * Called on the new cpu, just before
88 * enabling interrupts. Must not sleep,
89 * must not fail */
90
91/* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
92 * operation in progress
93 */
94#define CPU_TASKS_FROZEN 0x0010
95
96#define CPU_ONLINE_FROZEN (CPU_ONLINE | CPU_TASKS_FROZEN)
97#define CPU_UP_PREPARE_FROZEN (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
98#define CPU_UP_CANCELED_FROZEN (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
99#define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
100#define CPU_DOWN_FAILED_FROZEN (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
101#define CPU_DEAD_FROZEN (CPU_DEAD | CPU_TASKS_FROZEN)
102#define CPU_DYING_FROZEN (CPU_DYING | CPU_TASKS_FROZEN)
103#define CPU_STARTING_FROZEN (CPU_STARTING | CPU_TASKS_FROZEN)
104
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106#ifdef CONFIG_SMP
107/* Need to know about CPUs going up/down? */
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700108#if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
109#define cpu_notifier(fn, pri) { \
110 static struct notifier_block fn##_nb __cpuinitdata = \
111 { .notifier_call = fn, .priority = pri }; \
112 register_cpu_notifier(&fn##_nb); \
113}
114#else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
115#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
116#endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700117#ifdef CONFIG_HOTPLUG_CPU
Avi Kivity47e627b2007-02-12 00:54:43 -0800118extern int register_cpu_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119extern void unregister_cpu_notifier(struct notifier_block *nb);
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700120#else
Avi Kivity47e627b2007-02-12 00:54:43 -0800121
122#ifndef MODULE
123extern int register_cpu_notifier(struct notifier_block *nb);
124#else
125static inline int register_cpu_notifier(struct notifier_block *nb)
126{
127 return 0;
128}
129#endif
130
Chandra Seetharaman65edc682006-06-27 02:54:08 -0700131static inline void unregister_cpu_notifier(struct notifier_block *nb)
132{
133}
134#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136int cpu_up(unsigned int cpu);
Manfred Spraule545a612008-09-07 16:57:22 +0200137void notify_cpu_starting(unsigned int cpu);
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700138extern void cpu_maps_update_begin(void);
139extern void cpu_maps_update_done(void);
Ingo Molnard0d23b52008-01-25 21:08:02 +0100140
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700141#else /* CONFIG_SMP */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700143#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145static inline int register_cpu_notifier(struct notifier_block *nb)
146{
147 return 0;
148}
Ingo Molnard0d23b52008-01-25 21:08:02 +0100149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150static inline void unregister_cpu_notifier(struct notifier_block *nb)
151{
152}
153
Oleg Nesterov3da1c842008-07-25 01:47:50 -0700154static inline void cpu_maps_update_begin(void)
155{
156}
157
158static inline void cpu_maps_update_done(void)
159{
160}
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162#endif /* CONFIG_SMP */
163extern struct sysdev_class cpu_sysdev_class;
164
165#ifdef CONFIG_HOTPLUG_CPU
166/* Stop CPUs going up and down. */
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800167
Gautham R Shenoy86ef5c92008-01-25 21:08:02 +0100168extern void get_online_cpus(void);
169extern void put_online_cpus(void);
Paul E. McKenney799e64f2009-08-15 09:53:47 -0700170#define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
Chandra Seetharaman39f48852006-06-27 02:54:10 -0700171#define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
172#define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173int cpu_down(unsigned int cpu);
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800174
Gautham R Shenoy51badeb2009-11-26 09:59:05 +0000175#ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
176extern void cpu_hotplug_driver_lock(void);
177extern void cpu_hotplug_driver_unlock(void);
178#else
179static inline void cpu_hotplug_driver_lock(void)
180{
181}
182
183static inline void cpu_hotplug_driver_unlock(void)
184{
185}
186#endif
187
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800188#else /* CONFIG_HOTPLUG_CPU */
189
Gautham R Shenoy86ef5c92008-01-25 21:08:02 +0100190#define get_online_cpus() do { } while (0)
191#define put_online_cpus() do { } while (0)
Ingo Molnar023160672006-12-06 20:38:17 -0800192#define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
Satyam Sharma761bb432007-10-18 03:06:38 -0700193/* These aren't inline functions due to a GCC bug. */
194#define register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
195#define unregister_hotcpu_notifier(nb) ({ (void)(nb); })
Gautham R Shenoyf7dff2b2006-12-06 20:38:58 -0800196#endif /* CONFIG_HOTPLUG_CPU */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700198#ifdef CONFIG_PM_SLEEP_SMP
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700199extern int disable_nonboot_cpus(void);
200extern void enable_nonboot_cpus(void);
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700201#else /* !CONFIG_PM_SLEEP_SMP */
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700202static inline int disable_nonboot_cpus(void) { return 0; }
203static inline void enable_nonboot_cpus(void) {}
Rafael J. Wysockif3de4be2007-08-30 23:56:29 -0700204#endif /* !CONFIG_PM_SLEEP_SMP */
Rafael J. Wysockie3920fb2006-09-25 23:32:48 -0700205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206#endif /* _LINUX_CPU_H_ */