[deliverable/linux.git] / include / linux / cpumask.h

#ifndef __LINUX_CPUMASK_H
#define __LINUX_CPUMASK_H

/*
 * Cpumasks provide a bitmap suitable for representing the
 * set of CPU's in a system, one bit position per CPU number.
 *
 * See detailed comments in the file linux/bitmap.h describing the
 * data type on which these cpumasks are based.
 *
 * For details of cpumask_scnprintf() and cpumask_parse_user(),
 * see bitmap_scnprintf() and bitmap_parse_user() in lib/bitmap.c.
 * For details of cpulist_scnprintf() and cpulist_parse(), see
 * bitmap_scnlistprintf() and bitmap_parselist(), also in bitmap.c.
 * For details of cpu_remap(), see bitmap_bitremap in lib/bitmap.c
 * For details of cpus_remap(), see bitmap_remap in lib/bitmap.c.
 *
 * The available cpumask operations are:
 *
 * void cpu_set(cpu, mask)		turn on bit 'cpu' in mask
 * void cpu_clear(cpu, mask)		turn off bit 'cpu' in mask
 * void cpus_setall(mask)		set all bits
 * void cpus_clear(mask)		clear all bits
 * int cpu_isset(cpu, mask)		true iff bit 'cpu' set in mask
 * int cpu_test_and_set(cpu, mask)	test and set bit 'cpu' in mask
 *
 * void cpus_and(dst, src1, src2)	dst = src1 & src2  [intersection]
 * void cpus_or(dst, src1, src2)	dst = src1 | src2  [union]
 * void cpus_xor(dst, src1, src2)	dst = src1 ^ src2
 * void cpus_andnot(dst, src1, src2)	dst = src1 & ~src2
 * void cpus_complement(dst, src)	dst = ~src
 *
 * int cpus_equal(mask1, mask2)		Does mask1 == mask2?
 * int cpus_intersects(mask1, mask2)	Do mask1 and mask2 intersect?
 * int cpus_subset(mask1, mask2)	Is mask1 a subset of mask2?
 * int cpus_empty(mask)			Is mask empty (no bits sets)?
 * int cpus_full(mask)			Is mask full (all bits sets)?
 * int cpus_weight(mask)		Hamming weigh - number of set bits
 *
 * void cpus_shift_right(dst, src, n)	Shift right
 * void cpus_shift_left(dst, src, n)	Shift left
 *
 * int first_cpu(mask)			Number lowest set bit, or NR_CPUS
 * int next_cpu(cpu, mask)		Next cpu past 'cpu', or NR_CPUS
 *
 * cpumask_t cpumask_of_cpu(cpu)	Return cpumask with bit 'cpu' set
 * CPU_MASK_ALL				Initializer - all bits set
 * CPU_MASK_NONE			Initializer - no bits set
 * unsigned long *cpus_addr(mask)	Array of unsigned long's in mask
 *
 * int cpumask_scnprintf(buf, len, mask) Format cpumask for printing
 * int cpumask_parse_user(ubuf, ulen, mask)	Parse ascii string as cpumask
 * int cpulist_scnprintf(buf, len, mask) Format cpumask as list for printing
 * int cpulist_parse(buf, map)		Parse ascii string as cpulist
 * int cpu_remap(oldbit, old, new)	newbit = map(old, new)(oldbit)
 * int cpus_remap(dst, src, old, new)	*dst = map(old, new)(src)
 *
 * for_each_cpu_mask(cpu, mask)		for-loop cpu over mask
 *
 * int num_online_cpus()		Number of online CPUs
 * int num_possible_cpus()		Number of all possible CPUs
 * int num_present_cpus()		Number of present CPUs
 *
 * int cpu_online(cpu)			Is some cpu online?
 * int cpu_possible(cpu)		Is some cpu possible?
 * int cpu_present(cpu)			Is some cpu present (can schedule)?
 *
 * int any_online_cpu(mask)		First online cpu in mask
 *
 * for_each_possible_cpu(cpu)		for-loop cpu over cpu_possible_map
 * for_each_online_cpu(cpu)		for-loop cpu over cpu_online_map
 * for_each_present_cpu(cpu)		for-loop cpu over cpu_present_map
 *
 * Subtlety:
 * 1) The 'type-checked' form of cpu_isset() causes gcc (3.3.2, anyway)
 *    to generate slightly worse code.  Note for example the additional
 *    40 lines of assembly code compiling the "for each possible cpu"
 *    loops buried in the disk_stat_read() macros calls when compiling
 *    drivers/block/genhd.c (arch i386, CONFIG_SMP=y).  So use a simple
 *    one-line #define for cpu_isset(), instead of wrapping an inline
 *    inside a macro, the way we do the other calls.
 */

#include <linux/kernel.h>
#include <linux/threads.h>
#include <linux/bitmap.h>

typedef struct { DECLARE_BITMAP(bits, NR_CPUS); } cpumask_t;
extern cpumask_t _unused_cpumask_arg_;

#define cpu_set(cpu, dst) __cpu_set((cpu), &(dst))
static inline void __cpu_set(int cpu, volatile cpumask_t *dstp)
{
	set_bit(cpu, dstp->bits);
}

#define cpu_clear(cpu, dst) __cpu_clear((cpu), &(dst))
static inline void __cpu_clear(int cpu, volatile cpumask_t *dstp)
{
	clear_bit(cpu, dstp->bits);
}

#define cpus_setall(dst) __cpus_setall(&(dst), NR_CPUS)
static inline void __cpus_setall(cpumask_t *dstp, int nbits)
{
	bitmap_fill(dstp->bits, nbits);
}

#define cpus_clear(dst) __cpus_clear(&(dst), NR_CPUS)
static inline void __cpus_clear(cpumask_t *dstp, int nbits)
{
	bitmap_zero(dstp->bits, nbits);
}

/* No static inline type checking - see Subtlety (1) above. */
#define cpu_isset(cpu, cpumask) test_bit((cpu), (cpumask).bits)

#define cpu_test_and_set(cpu, cpumask) __cpu_test_and_set((cpu), &(cpumask))
static inline int __cpu_test_and_set(int cpu, cpumask_t *addr)
{
	return test_and_set_bit(cpu, addr->bits);
}

#define cpus_and(dst, src1, src2) __cpus_and(&(dst), &(src1), &(src2), NR_CPUS)
static inline void __cpus_and(cpumask_t *dstp, const cpumask_t *src1p,
					const cpumask_t *src2p, int nbits)
{
	bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits);
}

#define cpus_or(dst, src1, src2) __cpus_or(&(dst), &(src1), &(src2), NR_CPUS)
static inline void __cpus_or(cpumask_t *dstp, const cpumask_t *src1p,
					const cpumask_t *src2p, int nbits)
{
	bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits);
}

#define cpus_xor(dst, src1, src2) __cpus_xor(&(dst), &(src1), &(src2), NR_CPUS)
static inline void __cpus_xor(cpumask_t *dstp, const cpumask_t *src1p,
					const cpumask_t *src2p, int nbits)
{
	bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits);
}

#define cpus_andnot(dst, src1, src2) \
				__cpus_andnot(&(dst), &(src1), &(src2), NR_CPUS)
static inline void __cpus_andnot(cpumask_t *dstp, const cpumask_t *src1p,
					const cpumask_t *src2p, int nbits)
{
	bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits);
}

#define cpus_complement(dst, src) __cpus_complement(&(dst), &(src), NR_CPUS)
static inline void __cpus_complement(cpumask_t *dstp,
					const cpumask_t *srcp, int nbits)
{
	bitmap_complement(dstp->bits, srcp->bits, nbits);
}

#define cpus_equal(src1, src2) __cpus_equal(&(src1), &(src2), NR_CPUS)
static inline int __cpus_equal(const cpumask_t *src1p,
					const cpumask_t *src2p, int nbits)
{
	return bitmap_equal(src1p->bits, src2p->bits, nbits);
}

#define cpus_intersects(src1, src2) __cpus_intersects(&(src1), &(src2), NR_CPUS)
static inline int __cpus_intersects(const cpumask_t *src1p,
					const cpumask_t *src2p, int nbits)
{
	return bitmap_intersects(src1p->bits, src2p->bits, nbits);
}

#define cpus_subset(src1, src2) __cpus_subset(&(src1), &(src2), NR_CPUS)
static inline int __cpus_subset(const cpumask_t *src1p,
					const cpumask_t *src2p, int nbits)
{
	return bitmap_subset(src1p->bits, src2p->bits, nbits);
}

#define cpus_empty(src) __cpus_empty(&(src), NR_CPUS)
static inline int __cpus_empty(const cpumask_t *srcp, int nbits)
{
	return bitmap_empty(srcp->bits, nbits);
}

#define cpus_full(cpumask) __cpus_full(&(cpumask), NR_CPUS)
static inline int __cpus_full(const cpumask_t *srcp, int nbits)
{
	return bitmap_full(srcp->bits, nbits);
}

#define cpus_weight(cpumask) __cpus_weight(&(cpumask), NR_CPUS)
static inline int __cpus_weight(const cpumask_t *srcp, int nbits)
{
	return bitmap_weight(srcp->bits, nbits);
}

#define cpus_shift_right(dst, src, n) \
			__cpus_shift_right(&(dst), &(src), (n), NR_CPUS)
static inline void __cpus_shift_right(cpumask_t *dstp,
					const cpumask_t *srcp, int n, int nbits)
{
	bitmap_shift_right(dstp->bits, srcp->bits, n, nbits);
}

#define cpus_shift_left(dst, src, n) \
			__cpus_shift_left(&(dst), &(src), (n), NR_CPUS)
static inline void __cpus_shift_left(cpumask_t *dstp,
					const cpumask_t *srcp, int n, int nbits)
{
	bitmap_shift_left(dstp->bits, srcp->bits, n, nbits);
}

#ifdef CONFIG_SMP
int __first_cpu(const cpumask_t *srcp);
#define first_cpu(src) __first_cpu(&(src))
int __next_cpu(int n, const cpumask_t *srcp);
#define next_cpu(n, src) __next_cpu((n), &(src))
#else
#define first_cpu(src)		({ (void)(src); 0; })
#define next_cpu(n, src)	({ (void)(src); 1; })
#endif

#ifdef CONFIG_HAVE_CPUMASK_OF_CPU_MAP
extern cpumask_t *cpumask_of_cpu_map;
#define cpumask_of_cpu(cpu)    (cpumask_of_cpu_map[cpu])

#else
#define cpumask_of_cpu(cpu)						\
(*({									\
	typeof(_unused_cpumask_arg_) m;					\
	if (sizeof(m) == sizeof(unsigned long)) {			\
		m.bits[0] = 1UL<<(cpu);					\
	} else {							\
		cpus_clear(m);						\
		cpu_set((cpu), m);					\
	}								\
	&m;								\
}))
#endif

#define CPU_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(NR_CPUS)

#if NR_CPUS <= BITS_PER_LONG

#define CPU_MASK_ALL							\
(cpumask_t) { {								\
	[BITS_TO_LONGS(NR_CPUS)-1] = CPU_MASK_LAST_WORD			\
} }

#define CPU_MASK_ALL_PTR	(&CPU_MASK_ALL)

#else

#define CPU_MASK_ALL							\
(cpumask_t) { {								\
	[0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL,			\
	[BITS_TO_LONGS(NR_CPUS)-1] = CPU_MASK_LAST_WORD			\
} }

/* cpu_mask_all is in init/main.c */
extern cpumask_t cpu_mask_all;
#define CPU_MASK_ALL_PTR	(&cpu_mask_all)

#endif

#define CPU_MASK_NONE							\
(cpumask_t) { {								\
	[0 ... BITS_TO_LONGS(NR_CPUS)-1] =  0UL				\
} }

#define CPU_MASK_CPU0							\
(cpumask_t) { {								\
	[0] =  1UL							\
} }

#define cpus_addr(src) ((src).bits)

#define cpumask_scnprintf(buf, len, src) \
			__cpumask_scnprintf((buf), (len), &(src), NR_CPUS)
static inline int __cpumask_scnprintf(char *buf, int len,
					const cpumask_t *srcp, int nbits)
{
	return bitmap_scnprintf(buf, len, srcp->bits, nbits);
}

#define cpumask_scnprintf_len(len) \
			__cpumask_scnprintf_len((len))
static inline int __cpumask_scnprintf_len(int len)
{
	return bitmap_scnprintf_len(len);
}

#define cpumask_parse_user(ubuf, ulen, dst) \
			__cpumask_parse_user((ubuf), (ulen), &(dst), NR_CPUS)
static inline int __cpumask_parse_user(const char __user *buf, int len,
					cpumask_t *dstp, int nbits)
{
	return bitmap_parse_user(buf, len, dstp->bits, nbits);
}

#define cpulist_scnprintf(buf, len, src) \
			__cpulist_scnprintf((buf), (len), &(src), NR_CPUS)
static inline int __cpulist_scnprintf(char *buf, int len,
					const cpumask_t *srcp, int nbits)
{
	return bitmap_scnlistprintf(buf, len, srcp->bits, nbits);
}

#define cpulist_parse(buf, dst) __cpulist_parse((buf), &(dst), NR_CPUS)
static inline int __cpulist_parse(const char *buf, cpumask_t *dstp, int nbits)
{
	return bitmap_parselist(buf, dstp->bits, nbits);
}

#define cpu_remap(oldbit, old, new) \
		__cpu_remap((oldbit), &(old), &(new), NR_CPUS)
static inline int __cpu_remap(int oldbit,
		const cpumask_t *oldp, const cpumask_t *newp, int nbits)
{
	return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits);
}

#define cpus_remap(dst, src, old, new) \
		__cpus_remap(&(dst), &(src), &(old), &(new), NR_CPUS)
static inline void __cpus_remap(cpumask_t *dstp, const cpumask_t *srcp,
		const cpumask_t *oldp, const cpumask_t *newp, int nbits)
{
	bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits);
}

#if NR_CPUS > 1
#define for_each_cpu_mask(cpu, mask)		\
	for ((cpu) = first_cpu(mask);		\
		(cpu) < NR_CPUS;		\
		(cpu) = next_cpu((cpu), (mask)))
#else /* NR_CPUS == 1 */
#define for_each_cpu_mask(cpu, mask)		\
	for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask)
#endif /* NR_CPUS */

/*
 * The following particular system cpumasks and operations manage
 * possible, present and online cpus.  Each of them is a fixed size
 * bitmap of size NR_CPUS.
 *
 *  #ifdef CONFIG_HOTPLUG_CPU
 *     cpu_possible_map - has bit 'cpu' set iff cpu is populatable
 *     cpu_present_map  - has bit 'cpu' set iff cpu is populated
 *     cpu_online_map   - has bit 'cpu' set iff cpu available to scheduler
 *  #else
 *     cpu_possible_map - has bit 'cpu' set iff cpu is populated
 *     cpu_present_map  - copy of cpu_possible_map
 *     cpu_online_map   - has bit 'cpu' set iff cpu available to scheduler
 *  #endif
 *
 *  In either case, NR_CPUS is fixed at compile time, as the static
 *  size of these bitmaps.  The cpu_possible_map is fixed at boot
 *  time, as the set of CPU id's that it is possible might ever
 *  be plugged in at anytime during the life of that system boot.
 *  The cpu_present_map is dynamic(*), representing which CPUs
 *  are currently plugged in.  And cpu_online_map is the dynamic
 *  subset of cpu_present_map, indicating those CPUs available
 *  for scheduling.
 *
 *  If HOTPLUG is enabled, then cpu_possible_map is forced to have
 *  all NR_CPUS bits set, otherwise it is just the set of CPUs that
 *  ACPI reports present at boot.
 *
 *  If HOTPLUG is enabled, then cpu_present_map varies dynamically,
 *  depending on what ACPI reports as currently plugged in, otherwise
 *  cpu_present_map is just a copy of cpu_possible_map.
 *
 *  (*) Well, cpu_present_map is dynamic in the hotplug case.  If not
 *      hotplug, it's a copy of cpu_possible_map, hence fixed at boot.
 *
 * Subtleties:
 * 1) UP arch's (NR_CPUS == 1, CONFIG_SMP not defined) hardcode
 *    assumption that their single CPU is online.  The UP
 *    cpu_{online,possible,present}_maps are placebos.  Changing them
 *    will have no useful affect on the following num_*_cpus()
 *    and cpu_*() macros in the UP case.  This ugliness is a UP
 *    optimization - don't waste any instructions or memory references
 *    asking if you're online or how many CPUs there are if there is
 *    only one CPU.
 * 2) Most SMP arch's #define some of these maps to be some
 *    other map specific to that arch.  Therefore, the following
 *    must be #define macros, not inlines.  To see why, examine
 *    the assembly code produced by the following.  Note that
 *    set1() writes phys_x_map, but set2() writes x_map:
 *        int x_map, phys_x_map;
 *        #define set1(a) x_map = a
 *        inline void set2(int a) { x_map = a; }
 *        #define x_map phys_x_map
 *        main(){ set1(3); set2(5); }
 */

extern cpumask_t cpu_possible_map;
extern cpumask_t cpu_online_map;
extern cpumask_t cpu_present_map;

#if NR_CPUS > 1
#define num_online_cpus()	cpus_weight(cpu_online_map)
#define num_possible_cpus()	cpus_weight(cpu_possible_map)
#define num_present_cpus()	cpus_weight(cpu_present_map)
#define cpu_online(cpu)		cpu_isset((cpu), cpu_online_map)
#define cpu_possible(cpu)	cpu_isset((cpu), cpu_possible_map)
#define cpu_present(cpu)	cpu_isset((cpu), cpu_present_map)
#else
#define num_online_cpus()	1
#define num_possible_cpus()	1
#define num_present_cpus()	1
#define cpu_online(cpu)		((cpu) == 0)
#define cpu_possible(cpu)	((cpu) == 0)
#define cpu_present(cpu)	((cpu) == 0)
#endif

#define cpu_is_offline(cpu)	unlikely(!cpu_online(cpu))

#ifdef CONFIG_SMP
extern int nr_cpu_ids;
#define any_online_cpu(mask) __any_online_cpu(&(mask))
int __any_online_cpu(const cpumask_t *mask);
#else
#define nr_cpu_ids			1
#define any_online_cpu(mask)		0
#endif

#define for_each_possible_cpu(cpu)  for_each_cpu_mask((cpu), cpu_possible_map)
#define for_each_online_cpu(cpu)  for_each_cpu_mask((cpu), cpu_online_map)
#define for_each_present_cpu(cpu) for_each_cpu_mask((cpu), cpu_present_map)

#endif /* __LINUX_CPUMASK_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __LINUX_CPUMASK_H
	2	#define __LINUX_CPUMASK_H
	3
	4	/*
	5	* Cpumasks provide a bitmap suitable for representing the
	6	* set of CPU's in a system, one bit position per CPU number.
	7	*
	8	* See detailed comments in the file linux/bitmap.h describing the
	9	* data type on which these cpumasks are based.
	10	*
01a3ee2b RC	11	* For details of cpumask_scnprintf() and cpumask_parse_user(),
01a3ee2b RC	12	* see bitmap_scnprintf() and bitmap_parse_user() in lib/bitmap.c.
1da177e4 LT	13	* For details of cpulist_scnprintf() and cpulist_parse(), see
1da177e4 LT	14	* bitmap_scnlistprintf() and bitmap_parselist(), also in bitmap.c.
fb5eeeee PJ	15	* For details of cpu_remap(), see bitmap_bitremap in lib/bitmap.c
fb5eeeee PJ	16	* For details of cpus_remap(), see bitmap_remap in lib/bitmap.c.
1da177e4 LT	17	*
	18	* The available cpumask operations are:
	19	*
	20	* void cpu_set(cpu, mask) turn on bit 'cpu' in mask
	21	* void cpu_clear(cpu, mask) turn off bit 'cpu' in mask
	22	* void cpus_setall(mask) set all bits
	23	* void cpus_clear(mask) clear all bits
	24	* int cpu_isset(cpu, mask) true iff bit 'cpu' set in mask
	25	* int cpu_test_and_set(cpu, mask) test and set bit 'cpu' in mask
	26	*
	27	* void cpus_and(dst, src1, src2) dst = src1 & src2 [intersection]
	28	* void cpus_or(dst, src1, src2) dst = src1 \| src2 [union]
	29	* void cpus_xor(dst, src1, src2) dst = src1 ^ src2
	30	* void cpus_andnot(dst, src1, src2) dst = src1 & ~src2
	31	* void cpus_complement(dst, src) dst = ~src
	32	*
	33	* int cpus_equal(mask1, mask2) Does mask1 == mask2?
	34	* int cpus_intersects(mask1, mask2) Do mask1 and mask2 intersect?
	35	* int cpus_subset(mask1, mask2) Is mask1 a subset of mask2?
	36	* int cpus_empty(mask) Is mask empty (no bits sets)?
	37	* int cpus_full(mask) Is mask full (all bits sets)?
	38	* int cpus_weight(mask) Hamming weigh - number of set bits
	39	*
	40	* void cpus_shift_right(dst, src, n) Shift right
	41	* void cpus_shift_left(dst, src, n) Shift left
	42	*
	43	* int first_cpu(mask) Number lowest set bit, or NR_CPUS
	44	* int next_cpu(cpu, mask) Next cpu past 'cpu', or NR_CPUS
	45	*
	46	* cpumask_t cpumask_of_cpu(cpu) Return cpumask with bit 'cpu' set
	47	* CPU_MASK_ALL Initializer - all bits set
	48	* CPU_MASK_NONE Initializer - no bits set
	49	* unsigned long *cpus_addr(mask) Array of unsigned long's in mask
	50	*
	51	* int cpumask_scnprintf(buf, len, mask) Format cpumask for printing
01a3ee2b	52	* int cpumask_parse_user(ubuf, ulen, mask) Parse ascii string as cpumask
1da177e4 LT	53	* int cpulist_scnprintf(buf, len, mask) Format cpumask as list for printing
1da177e4 LT	54	* int cpulist_parse(buf, map) Parse ascii string as cpulist
fb5eeeee PJ	55	* int cpu_remap(oldbit, old, new) newbit = map(old, new)(oldbit)
fb5eeeee PJ	56	* int cpus_remap(dst, src, old, new) *dst = map(old, new)(src)
1da177e4 LT	57	*
	58	* for_each_cpu_mask(cpu, mask) for-loop cpu over mask
	59	*
	60	* int num_online_cpus() Number of online CPUs
	61	* int num_possible_cpus() Number of all possible CPUs
	62	* int num_present_cpus() Number of present CPUs
	63	*
	64	* int cpu_online(cpu) Is some cpu online?
	65	* int cpu_possible(cpu) Is some cpu possible?
	66	* int cpu_present(cpu) Is some cpu present (can schedule)?
	67	*
	68	* int any_online_cpu(mask) First online cpu in mask
	69	*
631d6747	70	* for_each_possible_cpu(cpu) for-loop cpu over cpu_possible_map
1da177e4 LT	71	* for_each_online_cpu(cpu) for-loop cpu over cpu_online_map
	72	* for_each_present_cpu(cpu) for-loop cpu over cpu_present_map
	73	*
	74	* Subtlety:
	75	* 1) The 'type-checked' form of cpu_isset() causes gcc (3.3.2, anyway)
	76	* to generate slightly worse code. Note for example the additional
	77	* 40 lines of assembly code compiling the "for each possible cpu"
	78	* loops buried in the disk_stat_read() macros calls when compiling
	79	* drivers/block/genhd.c (arch i386, CONFIG_SMP=y). So use a simple
	80	* one-line #define for cpu_isset(), instead of wrapping an inline
	81	* inside a macro, the way we do the other calls.
	82	*/
	83
	84	#include <linux/kernel.h>
	85	#include <linux/threads.h>
	86	#include <linux/bitmap.h>
1da177e4 LT	87
	88	typedef struct { DECLARE_BITMAP(bits, NR_CPUS); } cpumask_t;
	89	extern cpumask_t _unused_cpumask_arg_;
	90
	91	#define cpu_set(cpu, dst) __cpu_set((cpu), &(dst))
	92	static inline void __cpu_set(int cpu, volatile cpumask_t *dstp)
	93	{
	94	set_bit(cpu, dstp->bits);
	95	}
	96
	97	#define cpu_clear(cpu, dst) __cpu_clear((cpu), &(dst))
	98	static inline void __cpu_clear(int cpu, volatile cpumask_t *dstp)
	99	{
	100	clear_bit(cpu, dstp->bits);
	101	}
	102
	103	#define cpus_setall(dst) __cpus_setall(&(dst), NR_CPUS)
	104	static inline void __cpus_setall(cpumask_t *dstp, int nbits)
	105	{
	106	bitmap_fill(dstp->bits, nbits);
	107	}
	108
	109	#define cpus_clear(dst) __cpus_clear(&(dst), NR_CPUS)
	110	static inline void __cpus_clear(cpumask_t *dstp, int nbits)
	111	{
	112	bitmap_zero(dstp->bits, nbits);
	113	}
	114
	115	/* No static inline type checking - see Subtlety (1) above. */
	116	#define cpu_isset(cpu, cpumask) test_bit((cpu), (cpumask).bits)
	117
	118	#define cpu_test_and_set(cpu, cpumask) __cpu_test_and_set((cpu), &(cpumask))
	119	static inline int __cpu_test_and_set(int cpu, cpumask_t *addr)
	120	{
	121	return test_and_set_bit(cpu, addr->bits);
	122	}
	123
	124	#define cpus_and(dst, src1, src2) __cpus_and(&(dst), &(src1), &(src2), NR_CPUS)
	125	static inline void __cpus_and(cpumask_t dstp, const cpumask_t src1p,
	126	const cpumask_t *src2p, int nbits)
	127	{
	128	bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits);
	129	}
	130
	131	#define cpus_or(dst, src1, src2) __cpus_or(&(dst), &(src1), &(src2), NR_CPUS)
	132	static inline void __cpus_or(cpumask_t dstp, const cpumask_t src1p,
	133	const cpumask_t *src2p, int nbits)
	134	{
	135	bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits);
	136	}
	137
	138	#define cpus_xor(dst, src1, src2) __cpus_xor(&(dst), &(src1), &(src2), NR_CPUS)
	139	static inline void __cpus_xor(cpumask_t dstp, const cpumask_t src1p,
	140	const cpumask_t *src2p, int nbits)
	141	{
	142	bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits);
	143	}
	144
	145	#define cpus_andnot(dst, src1, src2) \
	146	__cpus_andnot(&(dst), &(src1), &(src2), NR_CPUS)
	147	static inline void __cpus_andnot(cpumask_t dstp, const cpumask_t src1p,
	148	const cpumask_t *src2p, int nbits)
	149	{
	150	bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits);
151	}
152
153	#define cpus_complement(dst, src) __cpus_complement(&(dst), &(src), NR_CPUS)
154	static inline void __cpus_complement(cpumask_t *dstp,
155	const cpumask_t *srcp, int nbits)
156	{
157	bitmap_complement(dstp->bits, srcp->bits, nbits);
158	}
159
160	#define cpus_equal(src1, src2) __cpus_equal(&(src1), &(src2), NR_CPUS)
161	static inline int __cpus_equal(const cpumask_t *src1p,
162	const cpumask_t *src2p, int nbits)
163	{
164	return bitmap_equal(src1p->bits, src2p->bits, nbits);
165	}
166
167	#define cpus_intersects(src1, src2) __cpus_intersects(&(src1), &(src2), NR_CPUS)
168	static inline int __cpus_intersects(const cpumask_t *src1p,
169	const cpumask_t *src2p, int nbits)
170	{
171	return bitmap_intersects(src1p->bits, src2p->bits, nbits);
172	}
173
174	#define cpus_subset(src1, src2) __cpus_subset(&(src1), &(src2), NR_CPUS)
175	static inline int __cpus_subset(const cpumask_t *src1p,
176	const cpumask_t *src2p, int nbits)
177	{
178	return bitmap_subset(src1p->bits, src2p->bits, nbits);
179	}
180
181	#define cpus_empty(src) __cpus_empty(&(src), NR_CPUS)
182	static inline int __cpus_empty(const cpumask_t *srcp, int nbits)
183	{
184	return bitmap_empty(srcp->bits, nbits);
185	}
186
187	#define cpus_full(cpumask) __cpus_full(&(cpumask), NR_CPUS)
188	static inline int __cpus_full(const cpumask_t *srcp, int nbits)
189	{
190	return bitmap_full(srcp->bits, nbits);
191	}
192
193	#define cpus_weight(cpumask) __cpus_weight(&(cpumask), NR_CPUS)
194	static inline int __cpus_weight(const cpumask_t *srcp, int nbits)
195	{
196	return bitmap_weight(srcp->bits, nbits);
197	}
198
199	#define cpus_shift_right(dst, src, n) \
200	__cpus_shift_right(&(dst), &(src), (n), NR_CPUS)
201	static inline void __cpus_shift_right(cpumask_t *dstp,
202	const cpumask_t *srcp, int n, int nbits)
203	{
204	bitmap_shift_right(dstp->bits, srcp->bits, n, nbits);
205	}
206
207	#define cpus_shift_left(dst, src, n) \
208	__cpus_shift_left(&(dst), &(src), (n), NR_CPUS)
209	static inline void __cpus_shift_left(cpumask_t *dstp,
210	const cpumask_t *srcp, int n, int nbits)
211	{
212	bitmap_shift_left(dstp->bits, srcp->bits, n, nbits);
213	}
214
ccb46000 AM	215	#ifdef CONFIG_SMP
	216	int __first_cpu(const cpumask_t *srcp);
	217	#define first_cpu(src) __first_cpu(&(src))
3d18bd74 AM	218	int __next_cpu(int n, const cpumask_t *srcp);
3d18bd74 AM	219	#define next_cpu(n, src) __next_cpu((n), &(src))
ccb46000	220	#else
23551885 IM	221	#define first_cpu(src) ({ (void)(src); 0; })
23551885 IM	222	#define next_cpu(n, src) ({ (void)(src); 1; })
ccb46000	223	#endif
1da177e4	224
9f0e8d04 MT	225	#ifdef CONFIG_HAVE_CPUMASK_OF_CPU_MAP
	226	extern cpumask_t *cpumask_of_cpu_map;
	227	#define cpumask_of_cpu(cpu) (cpumask_of_cpu_map[cpu])
	228
	229	#else
1da177e4	230	#define cpumask_of_cpu(cpu) \
9f0e8d04	231	(*({ \
1da177e4 LT	232	typeof(_unused_cpumask_arg_) m; \
	233	if (sizeof(m) == sizeof(unsigned long)) { \
	234	m.bits[0] = 1UL<<(cpu); \
	235	} else { \
	236	cpus_clear(m); \
	237	cpu_set((cpu), m); \
	238	} \
9f0e8d04 MT	239	&m; \
	240	}))
	241	#endif
1da177e4 LT	242
	243	#define CPU_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(NR_CPUS)
	244
	245	#if NR_CPUS <= BITS_PER_LONG
	246
	247	#define CPU_MASK_ALL \
	248	(cpumask_t) { { \
	249	[BITS_TO_LONGS(NR_CPUS)-1] = CPU_MASK_LAST_WORD \
	250	} }
	251
321a8e9d MT	252	#define CPU_MASK_ALL_PTR (&CPU_MASK_ALL)
321a8e9d MT	253
1da177e4 LT	254	#else
	255
	256	#define CPU_MASK_ALL \
	257	(cpumask_t) { { \
	258	[0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \
	259	[BITS_TO_LONGS(NR_CPUS)-1] = CPU_MASK_LAST_WORD \
	260	} }
	261
321a8e9d MT	262	/* cpu_mask_all is in init/main.c */
	263	extern cpumask_t cpu_mask_all;
	264	#define CPU_MASK_ALL_PTR (&cpu_mask_all)
	265
1da177e4 LT	266	#endif
	267
	268	#define CPU_MASK_NONE \
	269	(cpumask_t) { { \
	270	[0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \
	271	} }
	272
	273	#define CPU_MASK_CPU0 \
	274	(cpumask_t) { { \
	275	[0] = 1UL \
	276	} }
	277
	278	#define cpus_addr(src) ((src).bits)
	279
	280	#define cpumask_scnprintf(buf, len, src) \
	281	__cpumask_scnprintf((buf), (len), &(src), NR_CPUS)
	282	static inline int __cpumask_scnprintf(char *buf, int len,
	283	const cpumask_t *srcp, int nbits)
	284	{
	285	return bitmap_scnprintf(buf, len, srcp->bits, nbits);
	286	}
	287
30ca60c1 MT	288	#define cpumask_scnprintf_len(len) \
	289	__cpumask_scnprintf_len((len))
	290	static inline int __cpumask_scnprintf_len(int len)
	291	{
	292	return bitmap_scnprintf_len(len);
	293	}
	294
01a3ee2b RC	295	#define cpumask_parse_user(ubuf, ulen, dst) \
	296	__cpumask_parse_user((ubuf), (ulen), &(dst), NR_CPUS)
	297	static inline int __cpumask_parse_user(const char __user *buf, int len,
1da177e4 LT	298	cpumask_t *dstp, int nbits)
1da177e4 LT	299	{
01a3ee2b	300	return bitmap_parse_user(buf, len, dstp->bits, nbits);
1da177e4 LT	301	}
	302
	303	#define cpulist_scnprintf(buf, len, src) \
	304	__cpulist_scnprintf((buf), (len), &(src), NR_CPUS)
	305	static inline int __cpulist_scnprintf(char *buf, int len,
	306	const cpumask_t *srcp, int nbits)
	307	{
	308	return bitmap_scnlistprintf(buf, len, srcp->bits, nbits);
	309	}
	310
	311	#define cpulist_parse(buf, dst) __cpulist_parse((buf), &(dst), NR_CPUS)
	312	static inline int __cpulist_parse(const char buf, cpumask_t dstp, int nbits)
	313	{
	314	return bitmap_parselist(buf, dstp->bits, nbits);
	315	}
	316
fb5eeeee PJ	317	#define cpu_remap(oldbit, old, new) \
	318	__cpu_remap((oldbit), &(old), &(new), NR_CPUS)
	319	static inline int __cpu_remap(int oldbit,
	320	const cpumask_t oldp, const cpumask_t newp, int nbits)
	321	{
	322	return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits);
	323	}
	324
	325	#define cpus_remap(dst, src, old, new) \
	326	__cpus_remap(&(dst), &(src), &(old), &(new), NR_CPUS)
	327	static inline void __cpus_remap(cpumask_t dstp, const cpumask_t srcp,
	328	const cpumask_t oldp, const cpumask_t newp, int nbits)
	329	{
	330	bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits);
	331	}
	332
1da177e4 LT	333	#if NR_CPUS > 1
	334	#define for_each_cpu_mask(cpu, mask) \
	335	for ((cpu) = first_cpu(mask); \
	336	(cpu) < NR_CPUS; \
	337	(cpu) = next_cpu((cpu), (mask)))
	338	#else /* NR_CPUS == 1 */
9de9adb6 AM	339	#define for_each_cpu_mask(cpu, mask) \
9de9adb6 AM	340	for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask)
1da177e4 LT	341	#endif /* NR_CPUS */
	342
	343	/*
	344	* The following particular system cpumasks and operations manage
	345	* possible, present and online cpus. Each of them is a fixed size
	346	* bitmap of size NR_CPUS.
	347	*
	348	* #ifdef CONFIG_HOTPLUG_CPU
7a8ef1cb	349	* cpu_possible_map - has bit 'cpu' set iff cpu is populatable
1da177e4 LT	350	* cpu_present_map - has bit 'cpu' set iff cpu is populated
	351	* cpu_online_map - has bit 'cpu' set iff cpu available to scheduler
	352	* #else
	353	* cpu_possible_map - has bit 'cpu' set iff cpu is populated
	354	* cpu_present_map - copy of cpu_possible_map
	355	* cpu_online_map - has bit 'cpu' set iff cpu available to scheduler
	356	* #endif
	357	*
	358	* In either case, NR_CPUS is fixed at compile time, as the static
	359	* size of these bitmaps. The cpu_possible_map is fixed at boot
	360	* time, as the set of CPU id's that it is possible might ever
	361	* be plugged in at anytime during the life of that system boot.
	362	* The cpu_present_map is dynamic(*), representing which CPUs
	363	* are currently plugged in. And cpu_online_map is the dynamic
	364	* subset of cpu_present_map, indicating those CPUs available
	365	* for scheduling.
	366	*
	367	* If HOTPLUG is enabled, then cpu_possible_map is forced to have
	368	* all NR_CPUS bits set, otherwise it is just the set of CPUs that
	369	* ACPI reports present at boot.
	370	*
	371	* If HOTPLUG is enabled, then cpu_present_map varies dynamically,
	372	* depending on what ACPI reports as currently plugged in, otherwise
	373	* cpu_present_map is just a copy of cpu_possible_map.
	374	*
	375	* (*) Well, cpu_present_map is dynamic in the hotplug case. If not
	376	* hotplug, it's a copy of cpu_possible_map, hence fixed at boot.
	377	*
	378	* Subtleties:
	379	* 1) UP arch's (NR_CPUS == 1, CONFIG_SMP not defined) hardcode
	380	* assumption that their single CPU is online. The UP
	381	* cpu_{online,possible,present}_maps are placebos. Changing them
	382	* will have no useful affect on the following num_*_cpus()
	383	* and cpu_*() macros in the UP case. This ugliness is a UP
	384	* optimization - don't waste any instructions or memory references
	385	* asking if you're online or how many CPUs there are if there is
	386	* only one CPU.
	387	* 2) Most SMP arch's #define some of these maps to be some
	388	* other map specific to that arch. Therefore, the following
	389	* must be #define macros, not inlines. To see why, examine
	390	* the assembly code produced by the following. Note that
	391	* set1() writes phys_x_map, but set2() writes x_map:
	392	* int x_map, phys_x_map;
	393	* #define set1(a) x_map = a
	394	* inline void set2(int a) { x_map = a; }
	395	* #define x_map phys_x_map
	396	* main(){ set1(3); set2(5); }
	397	*/
	398
	399	extern cpumask_t cpu_possible_map;
	400	extern cpumask_t cpu_online_map;
	401	extern cpumask_t cpu_present_map;
	402
	403	#if NR_CPUS > 1
	404	#define num_online_cpus() cpus_weight(cpu_online_map)
	405	#define num_possible_cpus() cpus_weight(cpu_possible_map)
	406	#define num_present_cpus() cpus_weight(cpu_present_map)
	407	#define cpu_online(cpu) cpu_isset((cpu), cpu_online_map)
	408	#define cpu_possible(cpu) cpu_isset((cpu), cpu_possible_map)
	409	#define cpu_present(cpu) cpu_isset((cpu), cpu_present_map)
	410	#else
	411	#define num_online_cpus() 1
	412	#define num_possible_cpus() 1
	413	#define num_present_cpus() 1
414	#define cpu_online(cpu) ((cpu) == 0)
415	#define cpu_possible(cpu) ((cpu) == 0)
416	#define cpu_present(cpu) ((cpu) == 0)
417	#endif
418
a263898f IM	419	#define cpu_is_offline(cpu) unlikely(!cpu_online(cpu))
a263898f IM	420
86302820	421	#ifdef CONFIG_SMP
53b8a315	422	extern int nr_cpu_ids;
96a9b4d3 AM	423	#define any_online_cpu(mask) __any_online_cpu(&(mask))
96a9b4d3 AM	424	int __any_online_cpu(const cpumask_t *mask);
86302820	425	#else
53b8a315	426	#define nr_cpu_ids 1
96a9b4d3	427	#define any_online_cpu(mask) 0
86302820 AM	428	#endif
86302820 AM	429
631d6747	430	#define for_each_possible_cpu(cpu) for_each_cpu_mask((cpu), cpu_possible_map)
1da177e4 LT	431	#define for_each_online_cpu(cpu) for_each_cpu_mask((cpu), cpu_online_map)
	432	#define for_each_present_cpu(cpu) for_each_cpu_mask((cpu), cpu_present_map)
	433
	434	#endif /* __LINUX_CPUMASK_H */