device.h: audit and cleanup users in main include dir
[linux-2.6.git] / include / linux / cpu.h
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  * and system devices are handled in drivers/base/sys.c. 
10  *
11  * CPUs are exported via sysfs in the class/cpu/devices/
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/cpumask.h>
20
21 struct device;
22
23 struct cpu {
24         int node_id;            /* The node which contains the CPU */
25         int hotpluggable;       /* creates sysfs control file if hotpluggable */
26         struct device dev;
27 };
28
29 extern int register_cpu(struct cpu *cpu, int num);
30 extern struct device *get_cpu_device(unsigned cpu);
31 extern bool cpu_is_hotpluggable(unsigned cpu);
32
33 extern int cpu_add_dev_attr(struct device_attribute *attr);
34 extern void cpu_remove_dev_attr(struct device_attribute *attr);
35
36 extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
37 extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
38
39 extern int sched_create_sysfs_power_savings_entries(struct device *dev);
40
41 #ifdef CONFIG_HOTPLUG_CPU
42 extern void unregister_cpu(struct cpu *cpu);
43 extern ssize_t arch_cpu_probe(const char *, size_t);
44 extern ssize_t arch_cpu_release(const char *, size_t);
45 #endif
46 struct notifier_block;
47
48 /*
49  * CPU notifier priorities.
50  */
51 enum {
52         /*
53          * SCHED_ACTIVE marks a cpu which is coming up active during
54          * CPU_ONLINE and CPU_DOWN_FAILED and must be the first
55          * notifier.  CPUSET_ACTIVE adjusts cpuset according to
56          * cpu_active mask right after SCHED_ACTIVE.  During
57          * CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are
58          * ordered in the similar way.
59          *
60          * This ordering guarantees consistent cpu_active mask and
61          * migration behavior to all cpu notifiers.
62          */
63         CPU_PRI_SCHED_ACTIVE    = INT_MAX,
64         CPU_PRI_CPUSET_ACTIVE   = INT_MAX - 1,
65         CPU_PRI_SCHED_INACTIVE  = INT_MIN + 1,
66         CPU_PRI_CPUSET_INACTIVE = INT_MIN,
67
68         /* migration should happen before other stuff but after perf */
69         CPU_PRI_PERF            = 20,
70         CPU_PRI_MIGRATION       = 10,
71         /* prepare workqueues for other notifiers */
72         CPU_PRI_WORKQUEUE       = 5,
73 };
74
75 #define CPU_ONLINE              0x0002 /* CPU (unsigned)v is up */
76 #define CPU_UP_PREPARE          0x0003 /* CPU (unsigned)v coming up */
77 #define CPU_UP_CANCELED         0x0004 /* CPU (unsigned)v NOT coming up */
78 #define CPU_DOWN_PREPARE        0x0005 /* CPU (unsigned)v going down */
79 #define CPU_DOWN_FAILED         0x0006 /* CPU (unsigned)v NOT going down */
80 #define CPU_DEAD                0x0007 /* CPU (unsigned)v dead */
81 #define CPU_DYING               0x0008 /* CPU (unsigned)v not running any task,
82                                         * not handling interrupts, soon dead.
83                                         * Called on the dying cpu, interrupts
84                                         * are already disabled. Must not
85                                         * sleep, must not fail */
86 #define CPU_POST_DEAD           0x0009 /* CPU (unsigned)v dead, cpu_hotplug
87                                         * lock is dropped */
88 #define CPU_STARTING            0x000A /* CPU (unsigned)v soon running.
89                                         * Called on the new cpu, just before
90                                         * enabling interrupts. Must not sleep,
91                                         * must not fail */
92
93 /* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
94  * operation in progress
95  */
96 #define CPU_TASKS_FROZEN        0x0010
97
98 #define CPU_ONLINE_FROZEN       (CPU_ONLINE | CPU_TASKS_FROZEN)
99 #define CPU_UP_PREPARE_FROZEN   (CPU_UP_PREPARE | CPU_TASKS_FROZEN)
100 #define CPU_UP_CANCELED_FROZEN  (CPU_UP_CANCELED | CPU_TASKS_FROZEN)
101 #define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
102 #define CPU_DOWN_FAILED_FROZEN  (CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
103 #define CPU_DEAD_FROZEN         (CPU_DEAD | CPU_TASKS_FROZEN)
104 #define CPU_DYING_FROZEN        (CPU_DYING | CPU_TASKS_FROZEN)
105 #define CPU_STARTING_FROZEN     (CPU_STARTING | CPU_TASKS_FROZEN)
106
107
108 #ifdef CONFIG_SMP
109 /* Need to know about CPUs going up/down? */
110 #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
111 #define cpu_notifier(fn, pri) {                                 \
112         static struct notifier_block fn##_nb __cpuinitdata =    \
113                 { .notifier_call = fn, .priority = pri };       \
114         register_cpu_notifier(&fn##_nb);                        \
115 }
116 #else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
117 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
118 #endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
119 #ifdef CONFIG_HOTPLUG_CPU
120 extern int register_cpu_notifier(struct notifier_block *nb);
121 extern void unregister_cpu_notifier(struct notifier_block *nb);
122 #else
123
124 #ifndef MODULE
125 extern int register_cpu_notifier(struct notifier_block *nb);
126 #else
127 static inline int register_cpu_notifier(struct notifier_block *nb)
128 {
129         return 0;
130 }
131 #endif
132
133 static inline void unregister_cpu_notifier(struct notifier_block *nb)
134 {
135 }
136 #endif
137
138 int cpu_up(unsigned int cpu);
139 void notify_cpu_starting(unsigned int cpu);
140 extern void cpu_maps_update_begin(void);
141 extern void cpu_maps_update_done(void);
142
143 #else   /* CONFIG_SMP */
144
145 #define cpu_notifier(fn, pri)   do { (void)(fn); } while (0)
146
147 static inline int register_cpu_notifier(struct notifier_block *nb)
148 {
149         return 0;
150 }
151
152 static inline void unregister_cpu_notifier(struct notifier_block *nb)
153 {
154 }
155
156 static inline void cpu_maps_update_begin(void)
157 {
158 }
159
160 static inline void cpu_maps_update_done(void)
161 {
162 }
163
164 #endif /* CONFIG_SMP */
165 extern struct bus_type cpu_subsys;
166
167 #ifdef CONFIG_HOTPLUG_CPU
168 /* Stop CPUs going up and down. */
169
170 extern void get_online_cpus(void);
171 extern void put_online_cpus(void);
172 #define hotcpu_notifier(fn, pri)        cpu_notifier(fn, pri)
173 #define register_hotcpu_notifier(nb)    register_cpu_notifier(nb)
174 #define unregister_hotcpu_notifier(nb)  unregister_cpu_notifier(nb)
175 int cpu_down(unsigned int cpu);
176
177 #ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
178 extern void cpu_hotplug_driver_lock(void);
179 extern void cpu_hotplug_driver_unlock(void);
180 #else
181 static inline void cpu_hotplug_driver_lock(void)
182 {
183 }
184
185 static inline void cpu_hotplug_driver_unlock(void)
186 {
187 }
188 #endif
189
190 #else           /* CONFIG_HOTPLUG_CPU */
191
192 #define get_online_cpus()       do { } while (0)
193 #define put_online_cpus()       do { } while (0)
194 #define hotcpu_notifier(fn, pri)        do { (void)(fn); } while (0)
195 /* These aren't inline functions due to a GCC bug. */
196 #define register_hotcpu_notifier(nb)    ({ (void)(nb); 0; })
197 #define unregister_hotcpu_notifier(nb)  ({ (void)(nb); })
198 #endif          /* CONFIG_HOTPLUG_CPU */
199
200 #ifdef CONFIG_PM_SLEEP_SMP
201 extern int disable_nonboot_cpus(void);
202 extern void enable_nonboot_cpus(void);
203 #else /* !CONFIG_PM_SLEEP_SMP */
204 static inline int disable_nonboot_cpus(void) { return 0; }
205 static inline void enable_nonboot_cpus(void) {}
206 #endif /* !CONFIG_PM_SLEEP_SMP */
207
208 #endif /* _LINUX_CPU_H_ */