[linux-2.6-block.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
 *
 * CPUs are exported via sysfs in the devices/system/cpu
 * directory. 
 */
#ifndef _LINUX_CPU_H_
#define _LINUX_CPU_H_

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

struct device;
struct device_node;

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

extern int register_cpu(struct cpu *cpu, int num);
extern struct device *get_cpu_device(unsigned cpu);
extern bool cpu_is_hotpluggable(unsigned cpu);
extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
					      int cpu, unsigned int *thread);

extern int cpu_add_dev_attr(struct device_attribute *attr);
extern void cpu_remove_dev_attr(struct device_attribute *attr);

extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);

#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,
	/* bring up workqueues before normal notifiers and down after */
	CPU_PRI_WORKQUEUE_UP	= 5,
	CPU_PRI_WORKQUEUE_DOWN	= -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 =			\
		{ .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 bus_type cpu_subsys;

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

extern void cpu_hotplug_begin(void);
extern void cpu_hotplug_done(void);
extern void get_online_cpus(void);
extern void put_online_cpus(void);
extern void cpu_hotplug_disable(void);
extern void cpu_hotplug_enable(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)
void clear_tasks_mm_cpumask(int cpu);
int cpu_down(unsigned int cpu);

#else		/* CONFIG_HOTPLUG_CPU */

static inline void cpu_hotplug_begin(void) {}
static inline void cpu_hotplug_done(void) {}
#define get_online_cpus()	do { } while (0)
#define put_online_cpus()	do { } while (0)
#define cpu_hotplug_disable()	do { } while (0)
#define cpu_hotplug_enable()	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 disable_nonboot_cpus(void);
extern void enable_nonboot_cpus(void);
#else /* !CONFIG_PM_SLEEP_SMP */
static inline int disable_nonboot_cpus(void) { return 0; }
static inline void enable_nonboot_cpus(void) {}
#endif /* !CONFIG_PM_SLEEP_SMP */

enum cpuhp_state {
	CPUHP_OFFLINE,
	CPUHP_ONLINE,
};

void cpu_startup_entry(enum cpuhp_state state);
void cpu_idle(void);

void cpu_idle_poll_ctrl(bool enable);

void arch_cpu_idle(void);
void arch_cpu_idle_prepare(void);
void arch_cpu_idle_enter(void);
void arch_cpu_idle_exit(void);
void arch_cpu_idle_dead(void);

#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
1da177e4	9	*
611a75e1	10	* CPUs are exported via sysfs in the devices/system/cpu
1da177e4	11	* directory.
1da177e4 LT	12	*/
	13	#ifndef _LINUX_CPU_H_
	14	#define _LINUX_CPU_H_
	15
1da177e4 LT	16	#include <linux/node.h>
	17	#include <linux/compiler.h>
	18	#include <linux/cpumask.h>
1da177e4	19
313162d0	20	struct device;
d1cb9d1a	21	struct device_node;
313162d0	22
1da177e4 LT	23	struct cpu {
1da177e4 LT	24	int node_id; /* The node which contains the CPU */
72486f1f	25	int hotpluggable; /* creates sysfs control file if hotpluggable */
8a25a2fd	26	struct device dev;
1da177e4 LT	27	};
1da177e4 LT	28
76b67ed9	29	extern int register_cpu(struct cpu *cpu, int num);
8a25a2fd	30	extern struct device *get_cpu_device(unsigned cpu);
2987557f	31	extern bool cpu_is_hotpluggable(unsigned cpu);
183912d3	32	extern bool arch_match_cpu_phys_id(int cpu, u64 phys_id);
d1cb9d1a DM	33	extern bool arch_find_n_match_cpu_physical_id(struct device_node *cpun,
d1cb9d1a DM	34	int cpu, unsigned int *thread);
0344c6c5	35
8a25a2fd KS	36	extern int cpu_add_dev_attr(struct device_attribute *attr);
8a25a2fd KS	37	extern void cpu_remove_dev_attr(struct device_attribute *attr);
0344c6c5	38
8a25a2fd KS	39	extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
8a25a2fd KS	40	extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
0344c6c5	41
1da177e4	42	#ifdef CONFIG_HOTPLUG_CPU
76b67ed9	43	extern void unregister_cpu(struct cpu *cpu);
12633e80 NF	44	extern ssize_t arch_cpu_probe(const char *, size_t);
12633e80 NF	45	extern ssize_t arch_cpu_release(const char *, size_t);
1da177e4 LT	46	#endif
	47	struct notifier_block;
	48
50a323b7 TH	49	/*
	50	* CPU notifier priorities.
	51	*/
	52	enum {
3a101d05 TH	53	/*
	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
50a323b7 TH	69	/* migration should happen before other stuff but after perf */
	70	CPU_PRI_PERF = 20,
	71	CPU_PRI_MIGRATION = 10,
65758202 TH	72	/* bring up workqueues before normal notifiers and down after */
	73	CPU_PRI_WORKQUEUE_UP = 5,
	74	CPU_PRI_WORKQUEUE_DOWN = -5,
50a323b7 TH	75	};
50a323b7 TH	76
80f1ff97 AW	77	#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
1da177e4 LT	110	#ifdef CONFIG_SMP
1da177e4 LT	111	/* Need to know about CPUs going up/down? */
799e64f0 PM	112	#if defined(CONFIG_HOTPLUG_CPU) \|\| !defined(MODULE)
799e64f0 PM	113	#define cpu_notifier(fn, pri) { \
0db0628d	114	static struct notifier_block fn##_nb = \
799e64f0 PM	115	{ .notifier_call = fn, .priority = pri }; \
	116	register_cpu_notifier(&fn##_nb); \
	117	}
	118	#else /* #if defined(CONFIG_HOTPLUG_CPU) \|\| !defined(MODULE) */
	119	#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
	120	#endif /* #else #if defined(CONFIG_HOTPLUG_CPU) \|\| !defined(MODULE) */
65edc68c	121	#ifdef CONFIG_HOTPLUG_CPU
47e627bc	122	extern int register_cpu_notifier(struct notifier_block *nb);
1da177e4	123	extern void unregister_cpu_notifier(struct notifier_block *nb);
65edc68c	124	#else
47e627bc AK	125
	126	#ifndef MODULE
	127	extern int register_cpu_notifier(struct notifier_block *nb);
	128	#else
	129	static inline int register_cpu_notifier(struct notifier_block *nb)
	130	{
	131	return 0;
	132	}
	133	#endif
	134
65edc68c CS	135	static inline void unregister_cpu_notifier(struct notifier_block *nb)
	136	{
	137	}
	138	#endif
1da177e4 LT	139
1da177e4 LT	140	int cpu_up(unsigned int cpu);
e545a614	141	void notify_cpu_starting(unsigned int cpu);
3da1c84c ON	142	extern void cpu_maps_update_begin(void);
3da1c84c ON	143	extern void cpu_maps_update_done(void);
d0d23b54	144
3da1c84c	145	#else /* CONFIG_SMP */
1da177e4	146
799e64f0 PM	147	#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
799e64f0 PM	148
1da177e4 LT	149	static inline int register_cpu_notifier(struct notifier_block *nb)
	150	{
	151	return 0;
	152	}
d0d23b54	153
1da177e4 LT	154	static inline void unregister_cpu_notifier(struct notifier_block *nb)
	155	{
	156	}
	157
3da1c84c ON	158	static inline void cpu_maps_update_begin(void)
	159	{
	160	}
	161
	162	static inline void cpu_maps_update_done(void)
	163	{
	164	}
	165
1da177e4	166	#endif /* CONFIG_SMP */
8a25a2fd	167	extern struct bus_type cpu_subsys;
1da177e4 LT	168
	169	#ifdef CONFIG_HOTPLUG_CPU
	170	/* Stop CPUs going up and down. */
f7dff2b1	171
b9d10be7 TK	172	extern void cpu_hotplug_begin(void);
b9d10be7 TK	173	extern void cpu_hotplug_done(void);
86ef5c9a GS	174	extern void get_online_cpus(void);
86ef5c9a GS	175	extern void put_online_cpus(void);
16e53dbf SB	176	extern void cpu_hotplug_disable(void);
16e53dbf SB	177	extern void cpu_hotplug_enable(void);
799e64f0	178	#define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
39f4885c CS	179	#define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
39f4885c CS	180	#define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
cb79295e	181	void clear_tasks_mm_cpumask(int cpu);
1da177e4	182	int cpu_down(unsigned int cpu);
f7dff2b1 GS	183
	184	#else /* CONFIG_HOTPLUG_CPU */
	185
b9d10be7 TK	186	static inline void cpu_hotplug_begin(void) {}
b9d10be7 TK	187	static inline void cpu_hotplug_done(void) {}
86ef5c9a GS	188	#define get_online_cpus() do { } while (0)
86ef5c9a GS	189	#define put_online_cpus() do { } while (0)
16e53dbf SB	190	#define cpu_hotplug_disable() do { } while (0)
16e53dbf SB	191	#define cpu_hotplug_enable() 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
e3920fb4 RW	199	extern int disable_nonboot_cpus(void);
e3920fb4 RW	200	extern void enable_nonboot_cpus(void);
f3de4be9	201	#else /* !CONFIG_PM_SLEEP_SMP */
e3920fb4 RW	202	static inline int disable_nonboot_cpus(void) { return 0; }
e3920fb4 RW	203	static inline void enable_nonboot_cpus(void) {}
f3de4be9	204	#endif /* !CONFIG_PM_SLEEP_SMP */
e3920fb4	205
a1a04ec3 TG	206	enum cpuhp_state {
	207	CPUHP_OFFLINE,
	208	CPUHP_ONLINE,
	209	};
	210
	211	void cpu_startup_entry(enum cpuhp_state state);
	212	void cpu_idle(void);
	213
d1669912 TG	214	void cpu_idle_poll_ctrl(bool enable);
	215
	216	void arch_cpu_idle(void);
	217	void arch_cpu_idle_prepare(void);
	218	void arch_cpu_idle_enter(void);
	219	void arch_cpu_idle_exit(void);
	220	void arch_cpu_idle_dead(void);
	221
1da177e4	222	#endif /* _LINUX_CPU_H_ */