[mirror_ubuntu-artful-kernel.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/node.h>
#include <linux/compiler.h>
#include <linux/cpumask.h>

struct device;

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 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);

extern int sched_create_sysfs_power_savings_entries(struct device *dev);

#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;

#ifdef CONFIG_ARCH_HAS_CPU_AUTOPROBE
extern int arch_cpu_uevent(struct device *dev, struct kobj_uevent_env *env);
extern ssize_t arch_print_cpu_modalias(struct device *dev,
				       struct device_attribute *attr,
				       char *bufptr);
#endif

/*
 * 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 bus_type cpu_subsys;

#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 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 */

#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
1da177e4 LT	17	#include <linux/node.h>
	18	#include <linux/compiler.h>
	19	#include <linux/cpumask.h>
1da177e4	20
313162d0 PG	21	struct device;
313162d0 PG	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);
0344c6c5	32
8a25a2fd KS	33	extern int cpu_add_dev_attr(struct device_attribute *attr);
8a25a2fd KS	34	extern void cpu_remove_dev_attr(struct device_attribute *attr);
0344c6c5	35
8a25a2fd KS	36	extern int cpu_add_dev_attr_group(struct attribute_group *attrs);
8a25a2fd KS	37	extern void cpu_remove_dev_attr_group(struct attribute_group *attrs);
0344c6c5	38
8a25a2fd	39	extern int sched_create_sysfs_power_savings_entries(struct device *dev);
0344c6c5	40
1da177e4	41	#ifdef CONFIG_HOTPLUG_CPU
76b67ed9	42	extern void unregister_cpu(struct cpu *cpu);
12633e80 NF	43	extern ssize_t arch_cpu_probe(const char *, size_t);
12633e80 NF	44	extern ssize_t arch_cpu_release(const char *, size_t);
1da177e4 LT	45	#endif
	46	struct notifier_block;
	47
fad12ac8 TR	48	#ifdef CONFIG_ARCH_HAS_CPU_AUTOPROBE
	49	extern int arch_cpu_uevent(struct device dev, struct kobj_uevent_env env);
	50	extern ssize_t arch_print_cpu_modalias(struct device *dev,
	51	struct device_attribute *attr,
	52	char *bufptr);
	53	#endif
	54
50a323b7 TH	55	/*
	56	* CPU notifier priorities.
	57	*/
	58	enum {
3a101d05 TH	59	/*
	60	* SCHED_ACTIVE marks a cpu which is coming up active during
	61	* CPU_ONLINE and CPU_DOWN_FAILED and must be the first
	62	* notifier. CPUSET_ACTIVE adjusts cpuset according to
	63	* cpu_active mask right after SCHED_ACTIVE. During
	64	* CPU_DOWN_PREPARE, SCHED_INACTIVE and CPUSET_INACTIVE are
	65	* ordered in the similar way.
	66	*
	67	* This ordering guarantees consistent cpu_active mask and
	68	* migration behavior to all cpu notifiers.
	69	*/
	70	CPU_PRI_SCHED_ACTIVE = INT_MAX,
	71	CPU_PRI_CPUSET_ACTIVE = INT_MAX - 1,
	72	CPU_PRI_SCHED_INACTIVE = INT_MIN + 1,
	73	CPU_PRI_CPUSET_INACTIVE = INT_MIN,
	74
50a323b7 TH	75	/* migration should happen before other stuff but after perf */
	76	CPU_PRI_PERF = 20,
	77	CPU_PRI_MIGRATION = 10,
db7bccf4 TH	78	/* prepare workqueues for other notifiers */
db7bccf4 TH	79	CPU_PRI_WORKQUEUE = 5,
50a323b7 TH	80	};
50a323b7 TH	81
80f1ff97 AW	82	#define CPU_ONLINE 0x0002 /* CPU (unsigned)v is up */
	83	#define CPU_UP_PREPARE 0x0003 /* CPU (unsigned)v coming up */
	84	#define CPU_UP_CANCELED 0x0004 /* CPU (unsigned)v NOT coming up */
	85	#define CPU_DOWN_PREPARE 0x0005 /* CPU (unsigned)v going down */
	86	#define CPU_DOWN_FAILED 0x0006 /* CPU (unsigned)v NOT going down */
	87	#define CPU_DEAD 0x0007 /* CPU (unsigned)v dead */
	88	#define CPU_DYING 0x0008 /* CPU (unsigned)v not running any task,
	89	* not handling interrupts, soon dead.
	90	* Called on the dying cpu, interrupts
	91	* are already disabled. Must not
	92	* sleep, must not fail */
	93	#define CPU_POST_DEAD 0x0009 /* CPU (unsigned)v dead, cpu_hotplug
	94	* lock is dropped */
	95	#define CPU_STARTING 0x000A /* CPU (unsigned)v soon running.
	96	* Called on the new cpu, just before
	97	* enabling interrupts. Must not sleep,
	98	* must not fail */
	99
	100	/* Used for CPU hotplug events occurring while tasks are frozen due to a suspend
	101	* operation in progress
	102	*/
	103	#define CPU_TASKS_FROZEN 0x0010
	104
	105	#define CPU_ONLINE_FROZEN (CPU_ONLINE \| CPU_TASKS_FROZEN)
	106	#define CPU_UP_PREPARE_FROZEN (CPU_UP_PREPARE \| CPU_TASKS_FROZEN)
	107	#define CPU_UP_CANCELED_FROZEN (CPU_UP_CANCELED \| CPU_TASKS_FROZEN)
	108	#define CPU_DOWN_PREPARE_FROZEN (CPU_DOWN_PREPARE \| CPU_TASKS_FROZEN)
	109	#define CPU_DOWN_FAILED_FROZEN (CPU_DOWN_FAILED \| CPU_TASKS_FROZEN)
	110	#define CPU_DEAD_FROZEN (CPU_DEAD \| CPU_TASKS_FROZEN)
	111	#define CPU_DYING_FROZEN (CPU_DYING \| CPU_TASKS_FROZEN)
	112	#define CPU_STARTING_FROZEN (CPU_STARTING \| CPU_TASKS_FROZEN)
	113
	114
1da177e4 LT	115	#ifdef CONFIG_SMP
1da177e4 LT	116	/* Need to know about CPUs going up/down? */
799e64f0 PM	117	#if defined(CONFIG_HOTPLUG_CPU) \|\| !defined(MODULE)
	118	#define cpu_notifier(fn, pri) { \
	119	static struct notifier_block fn##_nb __cpuinitdata = \
	120	{ .notifier_call = fn, .priority = pri }; \
	121	register_cpu_notifier(&fn##_nb); \
	122	}
	123	#else /* #if defined(CONFIG_HOTPLUG_CPU) \|\| !defined(MODULE) */
	124	#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
	125	#endif /* #else #if defined(CONFIG_HOTPLUG_CPU) \|\| !defined(MODULE) */
65edc68c	126	#ifdef CONFIG_HOTPLUG_CPU
47e627bc	127	extern int register_cpu_notifier(struct notifier_block *nb);
1da177e4	128	extern void unregister_cpu_notifier(struct notifier_block *nb);
65edc68c	129	#else
47e627bc AK	130
	131	#ifndef MODULE
	132	extern int register_cpu_notifier(struct notifier_block *nb);
	133	#else
	134	static inline int register_cpu_notifier(struct notifier_block *nb)
	135	{
	136	return 0;
	137	}
	138	#endif
	139
65edc68c CS	140	static inline void unregister_cpu_notifier(struct notifier_block *nb)
	141	{
	142	}
	143	#endif
1da177e4 LT	144
1da177e4 LT	145	int cpu_up(unsigned int cpu);
e545a614	146	void notify_cpu_starting(unsigned int cpu);
3da1c84c ON	147	extern void cpu_maps_update_begin(void);
3da1c84c ON	148	extern void cpu_maps_update_done(void);
d0d23b54	149
3da1c84c	150	#else /* CONFIG_SMP */
1da177e4	151
799e64f0 PM	152	#define cpu_notifier(fn, pri) do { (void)(fn); } while (0)
799e64f0 PM	153
1da177e4 LT	154	static inline int register_cpu_notifier(struct notifier_block *nb)
	155	{
	156	return 0;
	157	}
d0d23b54	158
1da177e4 LT	159	static inline void unregister_cpu_notifier(struct notifier_block *nb)
	160	{
	161	}
	162
3da1c84c ON	163	static inline void cpu_maps_update_begin(void)
	164	{
	165	}
	166
	167	static inline void cpu_maps_update_done(void)
	168	{
	169	}
	170
1da177e4	171	#endif /* CONFIG_SMP */
8a25a2fd	172	extern struct bus_type cpu_subsys;
1da177e4 LT	173
	174	#ifdef CONFIG_HOTPLUG_CPU
	175	/* Stop CPUs going up and down. */
f7dff2b1	176
86ef5c9a GS	177	extern void get_online_cpus(void);
86ef5c9a GS	178	extern void put_online_cpus(void);
799e64f0	179	#define hotcpu_notifier(fn, pri) cpu_notifier(fn, pri)
39f4885c CS	180	#define register_hotcpu_notifier(nb) register_cpu_notifier(nb)
39f4885c CS	181	#define unregister_hotcpu_notifier(nb) unregister_cpu_notifier(nb)
1da177e4	182	int cpu_down(unsigned int cpu);
f7dff2b1	183
51badebd GS	184	#ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
	185	extern void cpu_hotplug_driver_lock(void);
	186	extern void cpu_hotplug_driver_unlock(void);
	187	#else
	188	static inline void cpu_hotplug_driver_lock(void)
	189	{
	190	}
	191
	192	static inline void cpu_hotplug_driver_unlock(void)
	193	{
	194	}
	195	#endif
	196
f7dff2b1 GS	197	#else /* CONFIG_HOTPLUG_CPU */
f7dff2b1 GS	198
86ef5c9a GS	199	#define get_online_cpus() do { } while (0)
86ef5c9a GS	200	#define put_online_cpus() do { } while (0)
02316067	201	#define hotcpu_notifier(fn, pri) do { (void)(fn); } while (0)
761bb431 SS	202	/* These aren't inline functions due to a GCC bug. */
	203	#define register_hotcpu_notifier(nb) ({ (void)(nb); 0; })
	204	#define unregister_hotcpu_notifier(nb) ({ (void)(nb); })
f7dff2b1	205	#endif /* CONFIG_HOTPLUG_CPU */
1da177e4	206
f3de4be9	207	#ifdef CONFIG_PM_SLEEP_SMP
e3920fb4 RW	208	extern int disable_nonboot_cpus(void);
e3920fb4 RW	209	extern void enable_nonboot_cpus(void);
f3de4be9	210	#else /* !CONFIG_PM_SLEEP_SMP */
e3920fb4 RW	211	static inline int disable_nonboot_cpus(void) { return 0; }
e3920fb4 RW	212	static inline void enable_nonboot_cpus(void) {}
f3de4be9	213	#endif /* !CONFIG_PM_SLEEP_SMP */
e3920fb4	214
1da177e4	215	#endif /* _LINUX_CPU_H_ */