bootmem: add documentation to API functions
[linux-2.6/mini2440.git] / kernel / cpu.c
blob2cc409ce0a8f93012ff93432f4effe6884b0b01c
1 /* CPU control.
2 * (C) 2001, 2002, 2003, 2004 Rusty Russell
4 * This code is licenced under the GPL.
5 */
6 #include <linux/proc_fs.h>
7 #include <linux/smp.h>
8 #include <linux/init.h>
9 #include <linux/notifier.h>
10 #include <linux/sched.h>
11 #include <linux/unistd.h>
12 #include <linux/cpu.h>
13 #include <linux/module.h>
14 #include <linux/kthread.h>
15 #include <linux/stop_machine.h>
16 #include <linux/mutex.h>
19 * Represents all cpu's present in the system
20 * In systems capable of hotplug, this map could dynamically grow
21 * as new cpu's are detected in the system via any platform specific
22 * method, such as ACPI for e.g.
24 cpumask_t cpu_present_map __read_mostly;
25 EXPORT_SYMBOL(cpu_present_map);
27 #ifndef CONFIG_SMP
30 * Represents all cpu's that are currently online.
32 cpumask_t cpu_online_map __read_mostly = CPU_MASK_ALL;
33 EXPORT_SYMBOL(cpu_online_map);
35 cpumask_t cpu_possible_map __read_mostly = CPU_MASK_ALL;
36 EXPORT_SYMBOL(cpu_possible_map);
38 #else /* CONFIG_SMP */
40 /* Serializes the updates to cpu_online_map, cpu_present_map */
41 static DEFINE_MUTEX(cpu_add_remove_lock);
43 static __cpuinitdata RAW_NOTIFIER_HEAD(cpu_chain);
45 /* If set, cpu_up and cpu_down will return -EBUSY and do nothing.
46 * Should always be manipulated under cpu_add_remove_lock
48 static int cpu_hotplug_disabled;
50 static struct {
51 struct task_struct *active_writer;
52 struct mutex lock; /* Synchronizes accesses to refcount, */
54 * Also blocks the new readers during
55 * an ongoing cpu hotplug operation.
57 int refcount;
58 } cpu_hotplug;
60 void __init cpu_hotplug_init(void)
62 cpu_hotplug.active_writer = NULL;
63 mutex_init(&cpu_hotplug.lock);
64 cpu_hotplug.refcount = 0;
67 cpumask_t cpu_active_map;
69 #ifdef CONFIG_HOTPLUG_CPU
71 void get_online_cpus(void)
73 might_sleep();
74 if (cpu_hotplug.active_writer == current)
75 return;
76 mutex_lock(&cpu_hotplug.lock);
77 cpu_hotplug.refcount++;
78 mutex_unlock(&cpu_hotplug.lock);
81 EXPORT_SYMBOL_GPL(get_online_cpus);
83 void put_online_cpus(void)
85 if (cpu_hotplug.active_writer == current)
86 return;
87 mutex_lock(&cpu_hotplug.lock);
88 if (!--cpu_hotplug.refcount && unlikely(cpu_hotplug.active_writer))
89 wake_up_process(cpu_hotplug.active_writer);
90 mutex_unlock(&cpu_hotplug.lock);
93 EXPORT_SYMBOL_GPL(put_online_cpus);
95 #endif /* CONFIG_HOTPLUG_CPU */
98 * The following two API's must be used when attempting
99 * to serialize the updates to cpu_online_map, cpu_present_map.
101 void cpu_maps_update_begin(void)
103 mutex_lock(&cpu_add_remove_lock);
106 void cpu_maps_update_done(void)
108 mutex_unlock(&cpu_add_remove_lock);
112 * This ensures that the hotplug operation can begin only when the
113 * refcount goes to zero.
115 * Note that during a cpu-hotplug operation, the new readers, if any,
116 * will be blocked by the cpu_hotplug.lock
118 * Since cpu_hotplug_begin() is always called after invoking
119 * cpu_maps_update_begin(), we can be sure that only one writer is active.
121 * Note that theoretically, there is a possibility of a livelock:
122 * - Refcount goes to zero, last reader wakes up the sleeping
123 * writer.
124 * - Last reader unlocks the cpu_hotplug.lock.
125 * - A new reader arrives at this moment, bumps up the refcount.
126 * - The writer acquires the cpu_hotplug.lock finds the refcount
127 * non zero and goes to sleep again.
129 * However, this is very difficult to achieve in practice since
130 * get_online_cpus() not an api which is called all that often.
133 static void cpu_hotplug_begin(void)
135 cpu_hotplug.active_writer = current;
137 for (;;) {
138 mutex_lock(&cpu_hotplug.lock);
139 if (likely(!cpu_hotplug.refcount))
140 break;
141 __set_current_state(TASK_UNINTERRUPTIBLE);
142 mutex_unlock(&cpu_hotplug.lock);
143 schedule();
147 static void cpu_hotplug_done(void)
149 cpu_hotplug.active_writer = NULL;
150 mutex_unlock(&cpu_hotplug.lock);
152 /* Need to know about CPUs going up/down? */
153 int __ref register_cpu_notifier(struct notifier_block *nb)
155 int ret;
156 cpu_maps_update_begin();
157 ret = raw_notifier_chain_register(&cpu_chain, nb);
158 cpu_maps_update_done();
159 return ret;
162 #ifdef CONFIG_HOTPLUG_CPU
164 EXPORT_SYMBOL(register_cpu_notifier);
166 void __ref unregister_cpu_notifier(struct notifier_block *nb)
168 cpu_maps_update_begin();
169 raw_notifier_chain_unregister(&cpu_chain, nb);
170 cpu_maps_update_done();
172 EXPORT_SYMBOL(unregister_cpu_notifier);
174 static inline void check_for_tasks(int cpu)
176 struct task_struct *p;
178 write_lock_irq(&tasklist_lock);
179 for_each_process(p) {
180 if (task_cpu(p) == cpu &&
181 (!cputime_eq(p->utime, cputime_zero) ||
182 !cputime_eq(p->stime, cputime_zero)))
183 printk(KERN_WARNING "Task %s (pid = %d) is on cpu %d\
184 (state = %ld, flags = %x) \n",
185 p->comm, task_pid_nr(p), cpu,
186 p->state, p->flags);
188 write_unlock_irq(&tasklist_lock);
191 struct take_cpu_down_param {
192 unsigned long mod;
193 void *hcpu;
196 /* Take this CPU down. */
197 static int __ref take_cpu_down(void *_param)
199 struct take_cpu_down_param *param = _param;
200 int err;
202 raw_notifier_call_chain(&cpu_chain, CPU_DYING | param->mod,
203 param->hcpu);
204 /* Ensure this CPU doesn't handle any more interrupts. */
205 err = __cpu_disable();
206 if (err < 0)
207 return err;
209 /* Force idle task to run as soon as we yield: it should
210 immediately notice cpu is offline and die quickly. */
211 sched_idle_next();
212 return 0;
215 /* Requires cpu_add_remove_lock to be held */
216 static int __ref _cpu_down(unsigned int cpu, int tasks_frozen)
218 int err, nr_calls = 0;
219 struct task_struct *p;
220 cpumask_t old_allowed, tmp;
221 void *hcpu = (void *)(long)cpu;
222 unsigned long mod = tasks_frozen ? CPU_TASKS_FROZEN : 0;
223 struct take_cpu_down_param tcd_param = {
224 .mod = mod,
225 .hcpu = hcpu,
228 if (num_online_cpus() == 1)
229 return -EBUSY;
231 if (!cpu_online(cpu))
232 return -EINVAL;
234 cpu_hotplug_begin();
235 err = __raw_notifier_call_chain(&cpu_chain, CPU_DOWN_PREPARE | mod,
236 hcpu, -1, &nr_calls);
237 if (err == NOTIFY_BAD) {
238 nr_calls--;
239 __raw_notifier_call_chain(&cpu_chain, CPU_DOWN_FAILED | mod,
240 hcpu, nr_calls, NULL);
241 printk("%s: attempt to take down CPU %u failed\n",
242 __func__, cpu);
243 err = -EINVAL;
244 goto out_release;
247 /* Ensure that we are not runnable on dying cpu */
248 old_allowed = current->cpus_allowed;
249 cpus_setall(tmp);
250 cpu_clear(cpu, tmp);
251 set_cpus_allowed_ptr(current, &tmp);
253 p = __stop_machine_run(take_cpu_down, &tcd_param, cpu);
255 if (IS_ERR(p) || cpu_online(cpu)) {
256 /* CPU didn't die: tell everyone. Can't complain. */
257 if (raw_notifier_call_chain(&cpu_chain, CPU_DOWN_FAILED | mod,
258 hcpu) == NOTIFY_BAD)
259 BUG();
261 if (IS_ERR(p)) {
262 err = PTR_ERR(p);
263 goto out_allowed;
265 goto out_thread;
268 /* Wait for it to sleep (leaving idle task). */
269 while (!idle_cpu(cpu))
270 yield();
272 /* This actually kills the CPU. */
273 __cpu_die(cpu);
275 /* CPU is completely dead: tell everyone. Too late to complain. */
276 if (raw_notifier_call_chain(&cpu_chain, CPU_DEAD | mod,
277 hcpu) == NOTIFY_BAD)
278 BUG();
280 check_for_tasks(cpu);
282 out_thread:
283 err = kthread_stop(p);
284 out_allowed:
285 set_cpus_allowed_ptr(current, &old_allowed);
286 out_release:
287 cpu_hotplug_done();
288 return err;
291 int __ref cpu_down(unsigned int cpu)
293 int err = 0;
295 cpu_maps_update_begin();
297 if (cpu_hotplug_disabled) {
298 err = -EBUSY;
299 goto out;
302 cpu_clear(cpu, cpu_active_map);
305 * Make sure the all cpus did the reschedule and are not
306 * using stale version of the cpu_active_map.
307 * This is not strictly necessary becuase stop_machine()
308 * that we run down the line already provides the required
309 * synchronization. But it's really a side effect and we do not
310 * want to depend on the innards of the stop_machine here.
312 synchronize_sched();
314 err = _cpu_down(cpu, 0);
316 if (cpu_online(cpu))
317 cpu_set(cpu, cpu_active_map);
319 out:
320 cpu_maps_update_done();
321 return err;
323 EXPORT_SYMBOL(cpu_down);
324 #endif /*CONFIG_HOTPLUG_CPU*/
326 /* Requires cpu_add_remove_lock to be held */
327 static int __cpuinit _cpu_up(unsigned int cpu, int tasks_frozen)
329 int ret, nr_calls = 0;
330 void *hcpu = (void *)(long)cpu;
331 unsigned long mod = tasks_frozen ? CPU_TASKS_FROZEN : 0;
333 if (cpu_online(cpu) || !cpu_present(cpu))
334 return -EINVAL;
336 cpu_hotplug_begin();
337 ret = __raw_notifier_call_chain(&cpu_chain, CPU_UP_PREPARE | mod, hcpu,
338 -1, &nr_calls);
339 if (ret == NOTIFY_BAD) {
340 nr_calls--;
341 printk("%s: attempt to bring up CPU %u failed\n",
342 __func__, cpu);
343 ret = -EINVAL;
344 goto out_notify;
347 /* Arch-specific enabling code. */
348 ret = __cpu_up(cpu);
349 if (ret != 0)
350 goto out_notify;
351 BUG_ON(!cpu_online(cpu));
353 /* Now call notifier in preparation. */
354 raw_notifier_call_chain(&cpu_chain, CPU_ONLINE | mod, hcpu);
356 out_notify:
357 if (ret != 0)
358 __raw_notifier_call_chain(&cpu_chain,
359 CPU_UP_CANCELED | mod, hcpu, nr_calls, NULL);
360 cpu_hotplug_done();
362 return ret;
365 int __cpuinit cpu_up(unsigned int cpu)
367 int err = 0;
368 if (!cpu_isset(cpu, cpu_possible_map)) {
369 printk(KERN_ERR "can't online cpu %d because it is not "
370 "configured as may-hotadd at boot time\n", cpu);
371 #if defined(CONFIG_IA64) || defined(CONFIG_X86_64) || defined(CONFIG_S390)
372 printk(KERN_ERR "please check additional_cpus= boot "
373 "parameter\n");
374 #endif
375 return -EINVAL;
378 cpu_maps_update_begin();
380 if (cpu_hotplug_disabled) {
381 err = -EBUSY;
382 goto out;
385 err = _cpu_up(cpu, 0);
387 if (cpu_online(cpu))
388 cpu_set(cpu, cpu_active_map);
390 out:
391 cpu_maps_update_done();
392 return err;
395 #ifdef CONFIG_PM_SLEEP_SMP
396 static cpumask_t frozen_cpus;
398 int disable_nonboot_cpus(void)
400 int cpu, first_cpu, error = 0;
402 cpu_maps_update_begin();
403 first_cpu = first_cpu(cpu_online_map);
404 /* We take down all of the non-boot CPUs in one shot to avoid races
405 * with the userspace trying to use the CPU hotplug at the same time
407 cpus_clear(frozen_cpus);
408 printk("Disabling non-boot CPUs ...\n");
409 for_each_online_cpu(cpu) {
410 if (cpu == first_cpu)
411 continue;
412 error = _cpu_down(cpu, 1);
413 if (!error) {
414 cpu_set(cpu, frozen_cpus);
415 printk("CPU%d is down\n", cpu);
416 } else {
417 printk(KERN_ERR "Error taking CPU%d down: %d\n",
418 cpu, error);
419 break;
422 if (!error) {
423 BUG_ON(num_online_cpus() > 1);
424 /* Make sure the CPUs won't be enabled by someone else */
425 cpu_hotplug_disabled = 1;
426 } else {
427 printk(KERN_ERR "Non-boot CPUs are not disabled\n");
429 cpu_maps_update_done();
430 return error;
433 void __ref enable_nonboot_cpus(void)
435 int cpu, error;
437 /* Allow everyone to use the CPU hotplug again */
438 cpu_maps_update_begin();
439 cpu_hotplug_disabled = 0;
440 if (cpus_empty(frozen_cpus))
441 goto out;
443 printk("Enabling non-boot CPUs ...\n");
444 for_each_cpu_mask_nr(cpu, frozen_cpus) {
445 error = _cpu_up(cpu, 1);
446 if (!error) {
447 printk("CPU%d is up\n", cpu);
448 continue;
450 printk(KERN_WARNING "Error taking CPU%d up: %d\n", cpu, error);
452 cpus_clear(frozen_cpus);
453 out:
454 cpu_maps_update_done();
456 #endif /* CONFIG_PM_SLEEP_SMP */
458 #endif /* CONFIG_SMP */