[linux.git] / include / linux / cpu.h

/*
 * include/linux/cpu.h - generic cpu definition
 *
 * This is mainly for topological representation. We define the 
 * basic 'struct cpu' here, which can be embedded in per-arch 
 * definitions of processors.
 *
 * Basic handling of the devices is done in drivers/base/cpu.c
 * and system devices are handled in drivers/base/sys.c. 
 *
 * CPUs are exported via sysfs in the class/cpu/devices/
 * directory. 
 */
#ifndef _LINUX_CPU_H_
#define _LINUX_CPU_H_

#include <linux/sysdev.h>
#include <linux/node.h>
#include <linux/compiler.h>
#include <linux/cpumask.h>

struct cpu {
	int node_id;		/* The node which contains the CPU */
	int hotpluggable;	/* creates sysfs control file if hotpluggable */
	struct sys_device sysdev;
};

extern int register_cpu(struct cpu *cpu, int num);
extern struct sys_device *get_cpu_sysdev(unsigned cpu);

extern int cpu_add_sysdev_attr(struct sysdev_attribute *attr);
extern void cpu_remove_sysdev_attr(struct sysdev_attribute *attr);

extern int cpu_add_sysdev_attr_group(struct attribute_group *attrs);
extern void cpu_remove_sysdev_attr_group(struct attribute_group *attrs);

extern int sched_create_sysfs_power_savings_entries(struct sysdev_class *cls);

#ifdef CONFIG_HOTPLUG_CPU
extern void unregister_cpu(struct cpu *cpu);
extern ssize_t arch_cpu_probe(const char *, size_t);
extern ssize_t arch_cpu_release(const char *, size_t);
#endif
struct notifier_block;

/*
 * CPU notifier priorities.
 */
enum {
	/*
	 * SCHED_ACTIVE marks a cpu which is coming up active during
	 * CPU_ONLINE and CPU_DOWN_FAILED and must be the first
	 * notifier.  CPUSET_ACTIVE adjusts cpuset according to
	 * cpu_active mask right after SCHED_ACTIVE.  During
	 * CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are
	 * ordered in the similar way.
	 *
	 * This ordering guarantees consistent cpu_active mask and
	 * migration behavior to all cpu notifiers.
	 */
	CPU_PRI_SCHED_ACTIVE	= INT_MAX,
	CPU_PRI_CPUSET_ACTIVE	= INT_MAX - 1,
	CPU_PRI_SCHED_INACTIVE	= INT_MIN + 1,
	CPU_PRI_CPUSET_INACTIVE	= INT_MIN,

	/* migration should happen before other stuff but after perf */
	CPU_PRI_PERF		= 20,
	CPU_PRI_MIGRATION	= 10,
	/* prepare workqueues for other notifiers */
	CPU_PRI_WORKQUEUE	= 5,
};

#define CPU_ONLINE		0x0002 /* CPU (unsigned)v is up */
#define CPU_UP_PREPARE		0x0003 /* CPU (unsigned)v coming up */
#define CPU_UP_CANCELED		0x0004 /* CPU (unsigned)v NOT coming up */
#define CPU_DOWN_PREPARE	0x0005 /* CPU (unsigned)v going down */
#define CPU_DOWN_FAILED		0x0006 /* CPU (unsigned)v NOT going down */
#define CPU_DEAD		0x0007 /* CPU (unsigned)v dead */
#define CPU_DYING		0x0008 /* CPU (unsigned)v not running any task,
					* not handling interrupts, soon dead.
					* Called on the dying cpu, interrupts
					* are already disabled. Must not
					* sleep, must not fail */
#define CPU_POST_DEAD		0x0009 /* CPU (unsigned)v dead, cpu_hotplug
					* lock is dropped */
#define CPU_STARTING		0x000A /* CPU (unsigned)v soon running.
					* Called on the new cpu, just before
					* enabling interrupts. Must not sleep,
					* must not fail */

/* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
 * operation in progress
 */
#define CPU_TASKS_FROZEN	0x0010

#define CPU_ONLINE_FROZEN	(CPU_ONLINE | CPU_TASKS_FROZEN)
#define CPU_UP_PREPARE_FROZEN	(CPU_UP_PREPARE | CPU_TASKS_FROZEN)
#define CPU_UP_CANCELED_FROZEN	(CPU_UP_CANCELED | CPU_TASKS_FROZEN)
#define CPU_DOWN_PREPARE_FROZEN	(CPU_DOWN_PREPARE | CPU_TASKS_FROZEN)
#define CPU_DOWN_FAILED_FROZEN	(CPU_DOWN_FAILED | CPU_TASKS_FROZEN)
#define CPU_DEAD_FROZEN		(CPU_DEAD | CPU_TASKS_FROZEN)
#define CPU_DYING_FROZEN	(CPU_DYING | CPU_TASKS_FROZEN)
#define CPU_STARTING_FROZEN	(CPU_STARTING | CPU_TASKS_FROZEN)


#ifdef CONFIG_SMP
/* Need to know about CPUs going up/down? */
#if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE)
#define cpu_notifier(fn, pri) {					\
	static struct notifier_block fn##_nb __cpuinitdata =	\
		{ .notifier_call = fn, .priority = pri };	\
	register_cpu_notifier(&fn##_nb);			\
}
#else /* #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
#define cpu_notifier(fn, pri)	do { (void)(fn); } while (0)
#endif /* #else #if defined(CONFIG_HOTPLUG_CPU) || !defined(MODULE) */
#ifdef CONFIG_HOTPLUG_CPU
extern int register_cpu_notifier(struct notifier_block *nb);
extern void unregister_cpu_notifier(struct notifier_block *nb);
#else

#ifndef MODULE
extern int register_cpu_notifier(struct notifier_block *nb);
#else
static inline int register_cpu_notifier(struct notifier_block *nb)
{
	return 0;
}
#endif

static inline void unregister_cpu_notifier(struct notifier_block *nb)
{
}
#endif

int cpu_up(unsigned int cpu);
void notify_cpu_starting(unsigned int cpu);
extern void cpu_maps_update_begin(void);
extern void cpu_maps_update_done(void);

#else	/* CONFIG_SMP */

#define cpu_notifier(fn, pri)	do { (void)(fn); } while (0)

static inline int register_cpu_notifier(struct notifier_block *nb)
{
	return 0;
}

static inline void unregister_cpu_notifier(struct notifier_block *nb)
{
}

static inline void cpu_maps_update_begin(void)
{
}

static inline void cpu_maps_update_done(void)
{
}

#endif /* CONFIG_SMP */
extern struct sysdev_class cpu_sysdev_class;

#ifdef CONFIG_HOTPLUG_CPU
/* Stop CPUs going up and down. */

extern void get_online_cpus(void);
extern void put_online_cpus(void);
#define hotcpu_notifier(fn, pri)	cpu_notifier(fn, pri)
#define register_hotcpu_notifier(nb)	register_cpu_notifier(nb)
#define unregister_hotcpu_notifier(nb)	unregister_cpu_notifier(nb)
int cpu_down(unsigned int cpu);

#ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
extern void cpu_hotplug_driver_lock(void);
extern void cpu_hotplug_driver_unlock(void);
#else
static inline void cpu_hotplug_driver_lock(void)
{
}

static inline void cpu_hotplug_driver_unlock(void)
{
}
#endif

#else		/* CONFIG_HOTPLUG_CPU */

#define get_online_cpus()	do { } while (0)
#define put_online_cpus()	do { } while (0)
#define hotcpu_notifier(fn, pri)	do { (void)(fn); } while (0)
/* These aren't inline functions due to a GCC bug. */
#define register_hotcpu_notifier(nb)	({ (void)(nb); 0; })
#define unregister_hotcpu_notifier(nb)	({ (void)(nb); })
#endif		/* CONFIG_HOTPLUG_CPU */

#ifdef CONFIG_PM_SLEEP_SMP
extern int suspend_cpu_hotplug;

extern int disable_nonboot_cpus(void);
extern void enable_nonboot_cpus(void);
#else /* !CONFIG_PM_SLEEP_SMP */
#define suspend_cpu_hotplug	0

static inline int disable_nonboot_cpus(void) { return 0; }
static inline void enable_nonboot_cpus(void) {}
#endif /* !CONFIG_PM_SLEEP_SMP */

#endif /* _LINUX_CPU_H_ */
Commit	Line	Data
1da177e4 LT	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	*
d51fe1be	11	* CPUs are exported via sysfs in the class/cpu/devices/
1da177e4	12	* directory.
1da177e4 LT	13	*/
	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>
1da177e4 LT	21
	22	struct cpu {
	23	int node_id; /* The node which contains the CPU */
72486f1f	24	int hotpluggable; /* creates sysfs control file if hotpluggable */
1da177e4 LT	25	struct sys_device sysdev;
	26	};
	27
76b67ed9	28	extern int register_cpu(struct cpu *cpu, int num);
a29d642a	29	extern struct sys_device *get_cpu_sysdev(unsigned cpu);
0344c6c5 CK	30
	31	extern int cpu_add_sysdev_attr(struct sysdev_attribute *attr);
	32	extern void cpu_remove_sysdev_attr(struct sysdev_attribute *attr);
	33
	34	extern int cpu_add_sysdev_attr_group(struct attribute_group *attrs);
	35	extern void cpu_remove_sysdev_attr_group(struct attribute_group *attrs);
	36
3367b994	37	extern int sched_create_sysfs_power_savings_entries(struct sysdev_class *cls);
0344c6c5	38
1da177e4	39	#ifdef CONFIG_HOTPLUG_CPU
76b67ed9	40	extern void unregister_cpu(struct cpu *cpu);
12633e80 NF	41	extern ssize_t arch_cpu_probe(const char *, size_t);
12633e80 NF	42	extern ssize_t arch_cpu_release(const char *, size_t);
1da177e4 LT	43	#endif
	44	struct notifier_block;
	45
50a323b7 TH	46	/*
	47	* CPU notifier priorities.
	48	*/
	49	enum {
3a101d05 TH	50	/*
	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
50a323b7 TH	66	/* migration should happen before other stuff but after perf */
	67	CPU_PRI_PERF = 20,
	68	CPU_PRI_MIGRATION = 10,
db7bccf4 TH	69	/* prepare workqueues for other notifiers */
db7bccf4 TH	70	CPU_PRI_WORKQUEUE = 5,
50a323b7 TH	71	};
50a323b7 TH	72
80f1ff97 AW	73	#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
1da177e4 LT	106	#ifdef CONFIG_SMP
1da177e4 LT	107	/* Need to know about CPUs going up/down? */
799e64f0 PM	108	#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) */
65edc68c	117	#ifdef CONFIG_HOTPLUG_CPU
47e627bc	118	extern int register_cpu_notifier(struct notifier_block *nb);
1da177e4	119	extern void unregister_cpu_notifier(struct notifier_block *nb);
65edc68c	120	#else
47e627bc AK	121
	122	#ifndef MODULE
	123	extern int register_cpu_notifier(struct notifier_block *nb);
	124	#else
	125	static inline int register_cpu_notifier(struct notifier_block *nb)
	126	{
	127	return 0;
	128	}
	129	#endif
	130
65edc68c CS	131	static inline void unregister_cpu_notifier(struct notifier_block *nb)
	132	{
	133	}
	134	#endif
1da177e4 LT	135
1da177e4 LT	136	int cpu_up(unsigned int cpu);
e545a614	137	void notify_cpu_starting(unsigned int cpu);
3da1c84c ON	138	extern void cpu_maps_update_begin(void);
3da1c84c ON	139	extern void cpu_maps_update_done(void);
d0d23b54	140
3da1c84c	141	#else /* CONFIG_SMP */
1da177e4	142
799e64f0 PM	143	#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
799e64f0 PM	144
1da177e4 LT	145	static inline int register_cpu_notifier(struct notifier_block *nb)
	146	{
	147	return 0;
	148	}
d0d23b54	149
1da177e4 LT	150	static inline void unregister_cpu_notifier(struct notifier_block *nb)
	151	{
	152	}
	153
3da1c84c ON	154	static inline void cpu_maps_update_begin(void)
	155	{
	156	}
	157
	158	static inline void cpu_maps_update_done(void)
	159	{
	160	}
	161
1da177e4 LT	162	#endif /* CONFIG_SMP */
	163	extern struct sysdev_class cpu_sysdev_class;
	164
	165	#ifdef CONFIG_HOTPLUG_CPU
	166	/* Stop CPUs going up and down. */
f7dff2b1	167
86ef5c9a GS	168	extern void get_online_cpus(void);
86ef5c9a GS	169	extern void put_online_cpus(void);
799e64f0	170	#define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
39f4885c CS	171	#define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
39f4885c CS	172	#define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
1da177e4	173	int cpu_down(unsigned int cpu);
f7dff2b1	174
51badebd GS	175	#ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
	176	extern void cpu_hotplug_driver_lock(void);
	177	extern void cpu_hotplug_driver_unlock(void);
	178	#else
	179	static inline void cpu_hotplug_driver_lock(void)
	180	{
	181	}
	182
	183	static inline void cpu_hotplug_driver_unlock(void)
	184	{
	185	}
	186	#endif
	187
f7dff2b1 GS	188	#else /* CONFIG_HOTPLUG_CPU */
f7dff2b1 GS	189
86ef5c9a GS	190	#define get_online_cpus() do { } while (0)
86ef5c9a GS	191	#define put_online_cpus() do { } while (0)
02316067	192	#define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
761bb431 SS	193	/* 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); })
f7dff2b1	196	#endif /* CONFIG_HOTPLUG_CPU */
1da177e4	197
f3de4be9	198	#ifdef CONFIG_PM_SLEEP_SMP
1d64b9cb RW	199	extern int suspend_cpu_hotplug;
1d64b9cb RW	200
e3920fb4 RW	201	extern int disable_nonboot_cpus(void);
e3920fb4 RW	202	extern void enable_nonboot_cpus(void);
f3de4be9	203	#else /* !CONFIG_PM_SLEEP_SMP */
1d64b9cb RW	204	#define suspend_cpu_hotplug 0
1d64b9cb RW	205
e3920fb4 RW	206	static inline int disable_nonboot_cpus(void) { return 0; }
e3920fb4 RW	207	static inline void enable_nonboot_cpus(void) {}
f3de4be9	208	#endif /* !CONFIG_PM_SLEEP_SMP */
e3920fb4	209
1da177e4	210	#endif /* _LINUX_CPU_H_ */