blob: fc14275ff34e49390a6dab06b023b6c2488c9bdc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_CPUMASK_H
2#define __LINUX_CPUMASK_H
3
4/*
5 * Cpumasks provide a bitmap suitable for representing the
Rusty Russell6ba2ef72009-09-24 09:34:53 -06006 * set of CPU's in a system, one bit position per CPU number. In general,
7 * only nr_cpu_ids (<= NR_CPUS) bits are valid.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/kernel.h>
10#include <linux/threads.h>
11#include <linux/bitmap.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050012#include <linux/bug.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
Rusty Russellcdfdef72015-03-05 10:49:19 +103014/* Don't assign or return these: may not be this big! */
Rusty Russell2d3854a2008-11-05 13:39:10 +110015typedef struct cpumask { DECLARE_BITMAP(bits, NR_CPUS); } cpumask_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Rusty Russellae7a47e2008-12-30 09:05:15 +103017/**
Rusty Russell6ba2ef72009-09-24 09:34:53 -060018 * cpumask_bits - get the bits in a cpumask
19 * @maskp: the struct cpumask *
Rusty Russellae7a47e2008-12-30 09:05:15 +103020 *
Rusty Russell6ba2ef72009-09-24 09:34:53 -060021 * You should only assume nr_cpu_ids bits of this mask are valid. This is
22 * a macro so it's const-correct.
Rusty Russellae7a47e2008-12-30 09:05:15 +103023 */
Rusty Russell6ba2ef72009-09-24 09:34:53 -060024#define cpumask_bits(maskp) ((maskp)->bits)
Paul Jackson7ea931c2008-04-28 02:12:29 -070025
Tejun Heof1bbc032015-02-13 14:36:57 -080026/**
27 * cpumask_pr_args - printf args to output a cpumask
28 * @maskp: cpumask to be printed
29 *
30 * Can be used to provide arguments for '%*pb[l]' when printing a cpumask.
31 */
32#define cpumask_pr_args(maskp) nr_cpu_ids, cpumask_bits(maskp)
33
Mike Travis41df0d612008-05-12 21:21:13 +020034#if NR_CPUS == 1
Mike Travis41df0d612008-05-12 21:21:13 +020035#define nr_cpu_ids 1
Rusty Russell6ba2ef72009-09-24 09:34:53 -060036#else
Mike Travis41df0d612008-05-12 21:21:13 +020037extern int nr_cpu_ids;
Mike Travis41df0d612008-05-12 21:21:13 +020038#endif
39
Rusty Russell6ba2ef72009-09-24 09:34:53 -060040#ifdef CONFIG_CPUMASK_OFFSTACK
41/* Assuming NR_CPUS is huge, a runtime limit is more efficient. Also,
42 * not all bits may be allocated. */
43#define nr_cpumask_bits nr_cpu_ids
44#else
45#define nr_cpumask_bits NR_CPUS
46#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48/*
49 * The following particular system cpumasks and operations manage
Rusty Russellb3199c02008-12-30 09:05:14 +103050 * possible, present, active and online cpus.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 *
Rusty Russellb3199c02008-12-30 09:05:14 +103052 * cpu_possible_mask- has bit 'cpu' set iff cpu is populatable
53 * cpu_present_mask - has bit 'cpu' set iff cpu is populated
54 * cpu_online_mask - has bit 'cpu' set iff cpu available to scheduler
55 * cpu_active_mask - has bit 'cpu' set iff cpu available to migration
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 *
Rusty Russellb3199c02008-12-30 09:05:14 +103057 * If !CONFIG_HOTPLUG_CPU, present == possible, and active == online.
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 *
Rusty Russellb3199c02008-12-30 09:05:14 +103059 * The cpu_possible_mask is fixed at boot time, as the set of CPU id's
60 * that it is possible might ever be plugged in at anytime during the
61 * life of that system boot. The cpu_present_mask is dynamic(*),
62 * representing which CPUs are currently plugged in. And
63 * cpu_online_mask is the dynamic subset of cpu_present_mask,
64 * indicating those CPUs available for scheduling.
65 *
66 * If HOTPLUG is enabled, then cpu_possible_mask is forced to have
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * all NR_CPUS bits set, otherwise it is just the set of CPUs that
68 * ACPI reports present at boot.
69 *
Rusty Russellb3199c02008-12-30 09:05:14 +103070 * If HOTPLUG is enabled, then cpu_present_mask varies dynamically,
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * depending on what ACPI reports as currently plugged in, otherwise
Rusty Russellb3199c02008-12-30 09:05:14 +103072 * cpu_present_mask is just a copy of cpu_possible_mask.
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 *
Rusty Russellb3199c02008-12-30 09:05:14 +103074 * (*) Well, cpu_present_mask is dynamic in the hotplug case. If not
75 * hotplug, it's a copy of cpu_possible_mask, hence fixed at boot.
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 *
77 * Subtleties:
78 * 1) UP arch's (NR_CPUS == 1, CONFIG_SMP not defined) hardcode
79 * assumption that their single CPU is online. The UP
Rusty Russellb3199c02008-12-30 09:05:14 +103080 * cpu_{online,possible,present}_masks are placebos. Changing them
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * will have no useful affect on the following num_*_cpus()
82 * and cpu_*() macros in the UP case. This ugliness is a UP
83 * optimization - don't waste any instructions or memory references
84 * asking if you're online or how many CPUs there are if there is
85 * only one CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 */
87
Rasmus Villemoes4b804c82016-01-20 15:00:19 -080088extern struct cpumask __cpu_possible_mask;
89extern struct cpumask __cpu_online_mask;
90extern struct cpumask __cpu_present_mask;
91extern struct cpumask __cpu_active_mask;
Rasmus Villemoes5aec01b2016-01-20 15:00:25 -080092#define cpu_possible_mask ((const struct cpumask *)&__cpu_possible_mask)
93#define cpu_online_mask ((const struct cpumask *)&__cpu_online_mask)
94#define cpu_present_mask ((const struct cpumask *)&__cpu_present_mask)
95#define cpu_active_mask ((const struct cpumask *)&__cpu_active_mask)
Rusty Russellb3199c02008-12-30 09:05:14 +103096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#if NR_CPUS > 1
Rusty Russellae7a47e2008-12-30 09:05:15 +103098#define num_online_cpus() cpumask_weight(cpu_online_mask)
99#define num_possible_cpus() cpumask_weight(cpu_possible_mask)
100#define num_present_cpus() cpumask_weight(cpu_present_mask)
Peter Zijlstra6ad4c182009-11-25 13:31:39 +0100101#define num_active_cpus() cpumask_weight(cpu_active_mask)
Rusty Russellae7a47e2008-12-30 09:05:15 +1030102#define cpu_online(cpu) cpumask_test_cpu((cpu), cpu_online_mask)
103#define cpu_possible(cpu) cpumask_test_cpu((cpu), cpu_possible_mask)
104#define cpu_present(cpu) cpumask_test_cpu((cpu), cpu_present_mask)
105#define cpu_active(cpu) cpumask_test_cpu((cpu), cpu_active_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106#else
Heiko Carstens221e3eb2010-03-05 13:42:41 -0800107#define num_online_cpus() 1U
108#define num_possible_cpus() 1U
109#define num_present_cpus() 1U
110#define num_active_cpus() 1U
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#define cpu_online(cpu) ((cpu) == 0)
112#define cpu_possible(cpu) ((cpu) == 0)
113#define cpu_present(cpu) ((cpu) == 0)
Max Krasnyanskye761b772008-07-15 04:43:49 -0700114#define cpu_active(cpu) ((cpu) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115#endif
116
Rusty Russell2d3854a2008-11-05 13:39:10 +1100117/* verify cpu argument to cpumask_* operators */
118static inline unsigned int cpumask_check(unsigned int cpu)
119{
120#ifdef CONFIG_DEBUG_PER_CPU_MAPS
121 WARN_ON_ONCE(cpu >= nr_cpumask_bits);
122#endif /* CONFIG_DEBUG_PER_CPU_MAPS */
123 return cpu;
124}
125
126#if NR_CPUS == 1
Rusty Russell984f2f32008-11-08 20:24:19 +1100127/* Uniprocessor. Assume all masks are "1". */
128static inline unsigned int cpumask_first(const struct cpumask *srcp)
129{
130 return 0;
131}
132
133/* Valid inputs for n are -1 and 0. */
134static inline unsigned int cpumask_next(int n, const struct cpumask *srcp)
135{
136 return n+1;
137}
138
139static inline unsigned int cpumask_next_zero(int n, const struct cpumask *srcp)
140{
141 return n+1;
142}
143
144static inline unsigned int cpumask_next_and(int n,
145 const struct cpumask *srcp,
146 const struct cpumask *andp)
147{
148 return n+1;
149}
150
151/* cpu must be a valid cpu, ie 0, so there's no other choice. */
152static inline unsigned int cpumask_any_but(const struct cpumask *mask,
153 unsigned int cpu)
154{
155 return 1;
156}
Rusty Russell2d3854a2008-11-05 13:39:10 +1100157
Rusty Russellf36963c2015-05-09 03:14:13 +0930158static inline unsigned int cpumask_local_spread(unsigned int i, int node)
Amir Vadaida913092014-06-09 10:24:38 +0300159{
Amir Vadaida913092014-06-09 10:24:38 +0300160 return 0;
161}
162
Rusty Russell2d3854a2008-11-05 13:39:10 +1100163#define for_each_cpu(cpu, mask) \
164 for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask)
Paul E. McKenney8bd93a22010-02-22 17:04:59 -0800165#define for_each_cpu_not(cpu, mask) \
166 for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask)
Rusty Russell2d3854a2008-11-05 13:39:10 +1100167#define for_each_cpu_and(cpu, mask, and) \
168 for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask, (void)and)
169#else
170/**
171 * cpumask_first - get the first cpu in a cpumask
172 * @srcp: the cpumask pointer
173 *
174 * Returns >= nr_cpu_ids if no cpus set.
175 */
176static inline unsigned int cpumask_first(const struct cpumask *srcp)
177{
178 return find_first_bit(cpumask_bits(srcp), nr_cpumask_bits);
179}
180
181/**
182 * cpumask_next - get the next cpu in a cpumask
183 * @n: the cpu prior to the place to search (ie. return will be > @n)
184 * @srcp: the cpumask pointer
185 *
186 * Returns >= nr_cpu_ids if no further cpus set.
187 */
188static inline unsigned int cpumask_next(int n, const struct cpumask *srcp)
189{
190 /* -1 is a legal arg here. */
191 if (n != -1)
192 cpumask_check(n);
193 return find_next_bit(cpumask_bits(srcp), nr_cpumask_bits, n+1);
194}
195
196/**
197 * cpumask_next_zero - get the next unset cpu in a cpumask
198 * @n: the cpu prior to the place to search (ie. return will be > @n)
199 * @srcp: the cpumask pointer
200 *
201 * Returns >= nr_cpu_ids if no further cpus unset.
202 */
203static inline unsigned int cpumask_next_zero(int n, const struct cpumask *srcp)
204{
205 /* -1 is a legal arg here. */
206 if (n != -1)
207 cpumask_check(n);
208 return find_next_zero_bit(cpumask_bits(srcp), nr_cpumask_bits, n+1);
209}
210
211int cpumask_next_and(int n, const struct cpumask *, const struct cpumask *);
212int cpumask_any_but(const struct cpumask *mask, unsigned int cpu);
Rusty Russellf36963c2015-05-09 03:14:13 +0930213unsigned int cpumask_local_spread(unsigned int i, int node);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100214
Rusty Russell984f2f32008-11-08 20:24:19 +1100215/**
216 * for_each_cpu - iterate over every cpu in a mask
217 * @cpu: the (optionally unsigned) integer iterator
218 * @mask: the cpumask pointer
219 *
220 * After the loop, cpu is >= nr_cpu_ids.
221 */
Rusty Russell2d3854a2008-11-05 13:39:10 +1100222#define for_each_cpu(cpu, mask) \
223 for ((cpu) = -1; \
224 (cpu) = cpumask_next((cpu), (mask)), \
225 (cpu) < nr_cpu_ids;)
Rusty Russell984f2f32008-11-08 20:24:19 +1100226
227/**
Paul E. McKenney8bd93a22010-02-22 17:04:59 -0800228 * for_each_cpu_not - iterate over every cpu in a complemented mask
229 * @cpu: the (optionally unsigned) integer iterator
230 * @mask: the cpumask pointer
231 *
232 * After the loop, cpu is >= nr_cpu_ids.
233 */
234#define for_each_cpu_not(cpu, mask) \
235 for ((cpu) = -1; \
236 (cpu) = cpumask_next_zero((cpu), (mask)), \
237 (cpu) < nr_cpu_ids;)
238
239/**
Rusty Russell984f2f32008-11-08 20:24:19 +1100240 * for_each_cpu_and - iterate over every cpu in both masks
241 * @cpu: the (optionally unsigned) integer iterator
242 * @mask: the first cpumask pointer
243 * @and: the second cpumask pointer
244 *
245 * This saves a temporary CPU mask in many places. It is equivalent to:
246 * struct cpumask tmp;
247 * cpumask_and(&tmp, &mask, &and);
248 * for_each_cpu(cpu, &tmp)
249 * ...
250 *
251 * After the loop, cpu is >= nr_cpu_ids.
252 */
Rusty Russell2d3854a2008-11-05 13:39:10 +1100253#define for_each_cpu_and(cpu, mask, and) \
254 for ((cpu) = -1; \
255 (cpu) = cpumask_next_and((cpu), (mask), (and)), \
256 (cpu) < nr_cpu_ids;)
257#endif /* SMP */
258
259#define CPU_BITS_NONE \
260{ \
261 [0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \
262}
263
264#define CPU_BITS_CPU0 \
265{ \
266 [0] = 1UL \
267}
268
269/**
270 * cpumask_set_cpu - set a cpu in a cpumask
271 * @cpu: cpu number (< nr_cpu_ids)
272 * @dstp: the cpumask pointer
273 */
274static inline void cpumask_set_cpu(unsigned int cpu, struct cpumask *dstp)
275{
276 set_bit(cpumask_check(cpu), cpumask_bits(dstp));
277}
278
279/**
280 * cpumask_clear_cpu - clear a cpu in a cpumask
281 * @cpu: cpu number (< nr_cpu_ids)
282 * @dstp: the cpumask pointer
283 */
284static inline void cpumask_clear_cpu(int cpu, struct cpumask *dstp)
285{
286 clear_bit(cpumask_check(cpu), cpumask_bits(dstp));
287}
288
289/**
290 * cpumask_test_cpu - test for a cpu in a cpumask
291 * @cpu: cpu number (< nr_cpu_ids)
292 * @cpumask: the cpumask pointer
293 *
Alex Shic777ad62012-05-28 22:23:51 +0800294 * Returns 1 if @cpu is set in @cpumask, else returns 0
Rusty Russell2d3854a2008-11-05 13:39:10 +1100295 */
Rasmus Villemoes3bbf7f42015-03-31 13:25:05 +1030296static inline int cpumask_test_cpu(int cpu, const struct cpumask *cpumask)
297{
298 return test_bit(cpumask_check(cpu), cpumask_bits((cpumask)));
299}
Rusty Russell2d3854a2008-11-05 13:39:10 +1100300
301/**
302 * cpumask_test_and_set_cpu - atomically test and set a cpu in a cpumask
303 * @cpu: cpu number (< nr_cpu_ids)
304 * @cpumask: the cpumask pointer
305 *
Alex Shic777ad62012-05-28 22:23:51 +0800306 * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0
307 *
Rusty Russell2d3854a2008-11-05 13:39:10 +1100308 * test_and_set_bit wrapper for cpumasks.
309 */
310static inline int cpumask_test_and_set_cpu(int cpu, struct cpumask *cpumask)
311{
312 return test_and_set_bit(cpumask_check(cpu), cpumask_bits(cpumask));
313}
314
315/**
Xiao Guangrong54fdade2009-09-22 16:43:39 -0700316 * cpumask_test_and_clear_cpu - atomically test and clear a cpu in a cpumask
317 * @cpu: cpu number (< nr_cpu_ids)
318 * @cpumask: the cpumask pointer
319 *
Alex Shic777ad62012-05-28 22:23:51 +0800320 * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0
321 *
Xiao Guangrong54fdade2009-09-22 16:43:39 -0700322 * test_and_clear_bit wrapper for cpumasks.
323 */
324static inline int cpumask_test_and_clear_cpu(int cpu, struct cpumask *cpumask)
325{
326 return test_and_clear_bit(cpumask_check(cpu), cpumask_bits(cpumask));
327}
328
329/**
Rusty Russell2d3854a2008-11-05 13:39:10 +1100330 * cpumask_setall - set all cpus (< nr_cpu_ids) in a cpumask
331 * @dstp: the cpumask pointer
332 */
333static inline void cpumask_setall(struct cpumask *dstp)
334{
335 bitmap_fill(cpumask_bits(dstp), nr_cpumask_bits);
336}
337
338/**
339 * cpumask_clear - clear all cpus (< nr_cpu_ids) in a cpumask
340 * @dstp: the cpumask pointer
341 */
342static inline void cpumask_clear(struct cpumask *dstp)
343{
344 bitmap_zero(cpumask_bits(dstp), nr_cpumask_bits);
345}
346
347/**
348 * cpumask_and - *dstp = *src1p & *src2p
349 * @dstp: the cpumask result
350 * @src1p: the first input
351 * @src2p: the second input
Alex Shic777ad62012-05-28 22:23:51 +0800352 *
353 * If *@dstp is empty, returns 0, else returns 1
Rusty Russell2d3854a2008-11-05 13:39:10 +1100354 */
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700355static inline int cpumask_and(struct cpumask *dstp,
Rusty Russell2d3854a2008-11-05 13:39:10 +1100356 const struct cpumask *src1p,
357 const struct cpumask *src2p)
358{
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700359 return bitmap_and(cpumask_bits(dstp), cpumask_bits(src1p),
Rusty Russell2d3854a2008-11-05 13:39:10 +1100360 cpumask_bits(src2p), nr_cpumask_bits);
361}
362
363/**
364 * cpumask_or - *dstp = *src1p | *src2p
365 * @dstp: the cpumask result
366 * @src1p: the first input
367 * @src2p: the second input
368 */
369static inline void cpumask_or(struct cpumask *dstp, const struct cpumask *src1p,
370 const struct cpumask *src2p)
371{
372 bitmap_or(cpumask_bits(dstp), cpumask_bits(src1p),
373 cpumask_bits(src2p), nr_cpumask_bits);
374}
375
376/**
377 * cpumask_xor - *dstp = *src1p ^ *src2p
378 * @dstp: the cpumask result
379 * @src1p: the first input
380 * @src2p: the second input
381 */
382static inline void cpumask_xor(struct cpumask *dstp,
383 const struct cpumask *src1p,
384 const struct cpumask *src2p)
385{
386 bitmap_xor(cpumask_bits(dstp), cpumask_bits(src1p),
387 cpumask_bits(src2p), nr_cpumask_bits);
388}
389
390/**
391 * cpumask_andnot - *dstp = *src1p & ~*src2p
392 * @dstp: the cpumask result
393 * @src1p: the first input
394 * @src2p: the second input
Alex Shic777ad62012-05-28 22:23:51 +0800395 *
396 * If *@dstp is empty, returns 0, else returns 1
Rusty Russell2d3854a2008-11-05 13:39:10 +1100397 */
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700398static inline int cpumask_andnot(struct cpumask *dstp,
Rusty Russell2d3854a2008-11-05 13:39:10 +1100399 const struct cpumask *src1p,
400 const struct cpumask *src2p)
401{
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700402 return bitmap_andnot(cpumask_bits(dstp), cpumask_bits(src1p),
Rusty Russell2d3854a2008-11-05 13:39:10 +1100403 cpumask_bits(src2p), nr_cpumask_bits);
404}
405
406/**
407 * cpumask_complement - *dstp = ~*srcp
408 * @dstp: the cpumask result
409 * @srcp: the input to invert
410 */
411static inline void cpumask_complement(struct cpumask *dstp,
412 const struct cpumask *srcp)
413{
414 bitmap_complement(cpumask_bits(dstp), cpumask_bits(srcp),
415 nr_cpumask_bits);
416}
417
418/**
419 * cpumask_equal - *src1p == *src2p
420 * @src1p: the first input
421 * @src2p: the second input
422 */
423static inline bool cpumask_equal(const struct cpumask *src1p,
424 const struct cpumask *src2p)
425{
426 return bitmap_equal(cpumask_bits(src1p), cpumask_bits(src2p),
427 nr_cpumask_bits);
428}
429
430/**
431 * cpumask_intersects - (*src1p & *src2p) != 0
432 * @src1p: the first input
433 * @src2p: the second input
434 */
435static inline bool cpumask_intersects(const struct cpumask *src1p,
436 const struct cpumask *src2p)
437{
438 return bitmap_intersects(cpumask_bits(src1p), cpumask_bits(src2p),
439 nr_cpumask_bits);
440}
441
442/**
443 * cpumask_subset - (*src1p & ~*src2p) == 0
444 * @src1p: the first input
445 * @src2p: the second input
Alex Shic777ad62012-05-28 22:23:51 +0800446 *
447 * Returns 1 if *@src1p is a subset of *@src2p, else returns 0
Rusty Russell2d3854a2008-11-05 13:39:10 +1100448 */
449static inline int cpumask_subset(const struct cpumask *src1p,
450 const struct cpumask *src2p)
451{
452 return bitmap_subset(cpumask_bits(src1p), cpumask_bits(src2p),
453 nr_cpumask_bits);
454}
455
456/**
457 * cpumask_empty - *srcp == 0
458 * @srcp: the cpumask to that all cpus < nr_cpu_ids are clear.
459 */
460static inline bool cpumask_empty(const struct cpumask *srcp)
461{
462 return bitmap_empty(cpumask_bits(srcp), nr_cpumask_bits);
463}
464
465/**
466 * cpumask_full - *srcp == 0xFFFFFFFF...
467 * @srcp: the cpumask to that all cpus < nr_cpu_ids are set.
468 */
469static inline bool cpumask_full(const struct cpumask *srcp)
470{
471 return bitmap_full(cpumask_bits(srcp), nr_cpumask_bits);
472}
473
474/**
475 * cpumask_weight - Count of bits in *srcp
476 * @srcp: the cpumask to count bits (< nr_cpu_ids) in.
477 */
478static inline unsigned int cpumask_weight(const struct cpumask *srcp)
479{
480 return bitmap_weight(cpumask_bits(srcp), nr_cpumask_bits);
481}
482
483/**
484 * cpumask_shift_right - *dstp = *srcp >> n
485 * @dstp: the cpumask result
486 * @srcp: the input to shift
487 * @n: the number of bits to shift by
488 */
489static inline void cpumask_shift_right(struct cpumask *dstp,
490 const struct cpumask *srcp, int n)
491{
492 bitmap_shift_right(cpumask_bits(dstp), cpumask_bits(srcp), n,
493 nr_cpumask_bits);
494}
495
496/**
497 * cpumask_shift_left - *dstp = *srcp << n
498 * @dstp: the cpumask result
499 * @srcp: the input to shift
500 * @n: the number of bits to shift by
501 */
502static inline void cpumask_shift_left(struct cpumask *dstp,
503 const struct cpumask *srcp, int n)
504{
505 bitmap_shift_left(cpumask_bits(dstp), cpumask_bits(srcp), n,
506 nr_cpumask_bits);
507}
508
509/**
510 * cpumask_copy - *dstp = *srcp
511 * @dstp: the result
512 * @srcp: the input cpumask
513 */
514static inline void cpumask_copy(struct cpumask *dstp,
515 const struct cpumask *srcp)
516{
517 bitmap_copy(cpumask_bits(dstp), cpumask_bits(srcp), nr_cpumask_bits);
518}
519
520/**
521 * cpumask_any - pick a "random" cpu from *srcp
522 * @srcp: the input cpumask
523 *
524 * Returns >= nr_cpu_ids if no cpus set.
525 */
526#define cpumask_any(srcp) cpumask_first(srcp)
527
528/**
529 * cpumask_first_and - return the first cpu from *srcp1 & *srcp2
530 * @src1p: the first input
531 * @src2p: the second input
532 *
533 * Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and().
534 */
535#define cpumask_first_and(src1p, src2p) cpumask_next_and(-1, (src1p), (src2p))
536
537/**
538 * cpumask_any_and - pick a "random" cpu from *mask1 & *mask2
539 * @mask1: the first input cpumask
540 * @mask2: the second input cpumask
541 *
542 * Returns >= nr_cpu_ids if no cpus set.
543 */
544#define cpumask_any_and(mask1, mask2) cpumask_first_and((mask1), (mask2))
545
546/**
Rusty Russellcd83e422008-11-07 11:12:29 +1100547 * cpumask_of - the cpumask containing just a given cpu
548 * @cpu: the cpu (<= nr_cpu_ids)
549 */
550#define cpumask_of(cpu) (get_cpu_mask(cpu))
551
552/**
Rusty Russell29c01772008-12-13 21:20:25 +1030553 * cpumask_parse_user - extract a cpumask from a user string
554 * @buf: the buffer to extract from
555 * @len: the length of the buffer
556 * @dstp: the cpumask to set.
557 *
558 * Returns -errno, or 0 for success.
559 */
560static inline int cpumask_parse_user(const char __user *buf, int len,
561 struct cpumask *dstp)
562{
Tejun Heo513e3d22015-02-13 14:36:50 -0800563 return bitmap_parse_user(buf, len, cpumask_bits(dstp), nr_cpu_ids);
Rusty Russell29c01772008-12-13 21:20:25 +1030564}
565
566/**
Mike Travis4b060422011-05-24 17:13:12 -0700567 * cpumask_parselist_user - extract a cpumask from a user string
568 * @buf: the buffer to extract from
569 * @len: the length of the buffer
570 * @dstp: the cpumask to set.
571 *
572 * Returns -errno, or 0 for success.
573 */
574static inline int cpumask_parselist_user(const char __user *buf, int len,
575 struct cpumask *dstp)
576{
577 return bitmap_parselist_user(buf, len, cpumask_bits(dstp),
Tejun Heo513e3d22015-02-13 14:36:50 -0800578 nr_cpu_ids);
Mike Travis4b060422011-05-24 17:13:12 -0700579}
580
581/**
Tejun Heoba630e42013-03-12 11:30:04 -0700582 * cpumask_parse - extract a cpumask from from a string
583 * @buf: the buffer to extract from
584 * @dstp: the cpumask to set.
585 *
586 * Returns -errno, or 0 for success.
587 */
588static inline int cpumask_parse(const char *buf, struct cpumask *dstp)
589{
590 char *nl = strchr(buf, '\n');
Brian W Hartcea092c2014-05-14 10:33:45 +0930591 unsigned int len = nl ? (unsigned int)(nl - buf) : strlen(buf);
Tejun Heoba630e42013-03-12 11:30:04 -0700592
Tejun Heo513e3d22015-02-13 14:36:50 -0800593 return bitmap_parse(buf, len, cpumask_bits(dstp), nr_cpu_ids);
Tejun Heoba630e42013-03-12 11:30:04 -0700594}
595
596/**
Alex Shi231daf02012-07-27 09:29:42 +0930597 * cpulist_parse - extract a cpumask from a user string of ranges
Rusty Russell29c01772008-12-13 21:20:25 +1030598 * @buf: the buffer to extract from
Rusty Russell29c01772008-12-13 21:20:25 +1030599 * @dstp: the cpumask to set.
600 *
601 * Returns -errno, or 0 for success.
602 */
603static inline int cpulist_parse(const char *buf, struct cpumask *dstp)
604{
Tejun Heo513e3d22015-02-13 14:36:50 -0800605 return bitmap_parselist(buf, cpumask_bits(dstp), nr_cpu_ids);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100606}
607
608/**
609 * cpumask_size - size to allocate for a 'struct cpumask' in bytes
610 *
611 * This will eventually be a runtime variable, depending on nr_cpu_ids.
612 */
613static inline size_t cpumask_size(void)
614{
Rusty Russellcdfdef72015-03-05 10:49:19 +1030615 return BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100616}
617
618/*
619 * cpumask_var_t: struct cpumask for stack usage.
620 *
621 * Oh, the wicked games we play! In order to make kernel coding a
622 * little more difficult, we typedef cpumask_var_t to an array or a
623 * pointer: doing &mask on an array is a noop, so it still works.
624 *
625 * ie.
626 * cpumask_var_t tmpmask;
627 * if (!alloc_cpumask_var(&tmpmask, GFP_KERNEL))
628 * return -ENOMEM;
629 *
630 * ... use 'tmpmask' like a normal struct cpumask * ...
631 *
632 * free_cpumask_var(tmpmask);
KOSAKI Motohiroa64a26e2011-07-26 16:08:45 -0700633 *
634 *
635 * However, one notable exception is there. alloc_cpumask_var() allocates
636 * only nr_cpumask_bits bits (in the other hand, real cpumask_t always has
637 * NR_CPUS bits). Therefore you don't have to dereference cpumask_var_t.
638 *
639 * cpumask_var_t tmpmask;
640 * if (!alloc_cpumask_var(&tmpmask, GFP_KERNEL))
641 * return -ENOMEM;
642 *
643 * var = *tmpmask;
644 *
645 * This code makes NR_CPUS length memcopy and brings to a memory corruption.
646 * cpumask_copy() provide safe copy functionality.
Christoph Lameter4ba29682014-08-26 19:12:21 -0500647 *
648 * Note that there is another evil here: If you define a cpumask_var_t
649 * as a percpu variable then the way to obtain the address of the cpumask
650 * structure differently influences what this_cpu_* operation needs to be
651 * used. Please use this_cpu_cpumask_var_t in those cases. The direct use
652 * of this_cpu_ptr() or this_cpu_read() will lead to failures when the
653 * other type of cpumask_var_t implementation is configured.
Rusty Russell2d3854a2008-11-05 13:39:10 +1100654 */
655#ifdef CONFIG_CPUMASK_OFFSTACK
656typedef struct cpumask *cpumask_var_t;
657
Christoph Lameter4ba29682014-08-26 19:12:21 -0500658#define this_cpu_cpumask_var_ptr(x) this_cpu_read(x)
659
Mike Travis7b4967c2008-12-19 16:56:37 +1030660bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100661bool alloc_cpumask_var(cpumask_var_t *mask, gfp_t flags);
Yinghai Lu0281b5d2009-06-06 14:50:36 -0700662bool zalloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node);
663bool zalloc_cpumask_var(cpumask_var_t *mask, gfp_t flags);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100664void alloc_bootmem_cpumask_var(cpumask_var_t *mask);
665void free_cpumask_var(cpumask_var_t mask);
Rusty Russellcd83e422008-11-07 11:12:29 +1100666void free_bootmem_cpumask_var(cpumask_var_t mask);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100667
668#else
669typedef struct cpumask cpumask_var_t[1];
670
Christoph Lameter4ba29682014-08-26 19:12:21 -0500671#define this_cpu_cpumask_var_ptr(x) this_cpu_ptr(x)
672
Rusty Russell2d3854a2008-11-05 13:39:10 +1100673static inline bool alloc_cpumask_var(cpumask_var_t *mask, gfp_t flags)
674{
675 return true;
676}
677
Mike Travis7b4967c2008-12-19 16:56:37 +1030678static inline bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags,
679 int node)
680{
681 return true;
682}
683
Yinghai Lu0281b5d2009-06-06 14:50:36 -0700684static inline bool zalloc_cpumask_var(cpumask_var_t *mask, gfp_t flags)
685{
686 cpumask_clear(*mask);
687 return true;
688}
689
690static inline bool zalloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags,
691 int node)
692{
693 cpumask_clear(*mask);
694 return true;
695}
696
Rusty Russell2d3854a2008-11-05 13:39:10 +1100697static inline void alloc_bootmem_cpumask_var(cpumask_var_t *mask)
698{
699}
700
701static inline void free_cpumask_var(cpumask_var_t mask)
702{
703}
Rusty Russellcd83e422008-11-07 11:12:29 +1100704
705static inline void free_bootmem_cpumask_var(cpumask_var_t mask)
706{
707}
Rusty Russell2d3854a2008-11-05 13:39:10 +1100708#endif /* CONFIG_CPUMASK_OFFSTACK */
709
Rusty Russell2d3854a2008-11-05 13:39:10 +1100710/* It's common to want to use cpu_all_mask in struct member initializers,
711 * so it has to refer to an address rather than a pointer. */
712extern const DECLARE_BITMAP(cpu_all_bits, NR_CPUS);
713#define cpu_all_mask to_cpumask(cpu_all_bits)
714
715/* First bits of cpu_bit_bitmap are in fact unset. */
716#define cpu_none_mask to_cpumask(cpu_bit_bitmap[0])
717
Rusty Russellae7a47e2008-12-30 09:05:15 +1030718#define for_each_possible_cpu(cpu) for_each_cpu((cpu), cpu_possible_mask)
719#define for_each_online_cpu(cpu) for_each_cpu((cpu), cpu_online_mask)
720#define for_each_present_cpu(cpu) for_each_cpu((cpu), cpu_present_mask)
721
Rusty Russell2d3854a2008-11-05 13:39:10 +1100722/* Wrappers for arch boot code to manipulate normally-constant masks */
Rusty Russell3fa41522008-12-30 09:05:16 +1030723void init_cpu_present(const struct cpumask *src);
724void init_cpu_possible(const struct cpumask *src);
725void init_cpu_online(const struct cpumask *src);
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600726
Rasmus Villemoes94256762016-01-20 15:00:28 -0800727static inline void
728set_cpu_possible(unsigned int cpu, bool possible)
729{
730 if (possible)
731 cpumask_set_cpu(cpu, &__cpu_possible_mask);
732 else
733 cpumask_clear_cpu(cpu, &__cpu_possible_mask);
734}
735
736static inline void
737set_cpu_present(unsigned int cpu, bool present)
738{
739 if (present)
740 cpumask_set_cpu(cpu, &__cpu_present_mask);
741 else
742 cpumask_clear_cpu(cpu, &__cpu_present_mask);
743}
744
745static inline void
746set_cpu_online(unsigned int cpu, bool online)
747{
748 if (online) {
749 cpumask_set_cpu(cpu, &__cpu_online_mask);
750 cpumask_set_cpu(cpu, &__cpu_active_mask);
751 } else {
752 cpumask_clear_cpu(cpu, &__cpu_online_mask);
753 }
754}
755
756static inline void
757set_cpu_active(unsigned int cpu, bool active)
758{
759 if (active)
760 cpumask_set_cpu(cpu, &__cpu_active_mask);
761 else
762 cpumask_clear_cpu(cpu, &__cpu_active_mask);
763}
764
765
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600766/**
767 * to_cpumask - convert an NR_CPUS bitmap to a struct cpumask *
768 * @bitmap: the bitmap
769 *
770 * There are a few places where cpumask_var_t isn't appropriate and
771 * static cpumasks must be used (eg. very early boot), yet we don't
772 * expose the definition of 'struct cpumask'.
773 *
774 * This does the conversion, and can be used as a constant initializer.
775 */
776#define to_cpumask(bitmap) \
777 ((struct cpumask *)(1 ? (bitmap) \
778 : (void *)sizeof(__check_is_bitmap(bitmap))))
779
780static inline int __check_is_bitmap(const unsigned long *bitmap)
781{
782 return 1;
783}
784
785/*
786 * Special-case data structure for "single bit set only" constant CPU masks.
787 *
788 * We pre-generate all the 64 (or 32) possible bit positions, with enough
789 * padding to the left and the right, and return the constant pointer
790 * appropriately offset.
791 */
792extern const unsigned long
793 cpu_bit_bitmap[BITS_PER_LONG+1][BITS_TO_LONGS(NR_CPUS)];
794
795static inline const struct cpumask *get_cpu_mask(unsigned int cpu)
796{
797 const unsigned long *p = cpu_bit_bitmap[1 + cpu % BITS_PER_LONG];
798 p -= cpu / BITS_PER_LONG;
799 return to_cpumask(p);
800}
801
802#define cpu_is_offline(cpu) unlikely(!cpu_online(cpu))
803
804#if NR_CPUS <= BITS_PER_LONG
805#define CPU_BITS_ALL \
806{ \
Rusty Russell9941a382015-03-05 10:49:19 +1030807 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600808}
809
810#else /* NR_CPUS > BITS_PER_LONG */
811
812#define CPU_BITS_ALL \
813{ \
814 [0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \
Rusty Russell9941a382015-03-05 10:49:19 +1030815 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600816}
817#endif /* NR_CPUS > BITS_PER_LONG */
818
Sudeep Holla5aaba362014-09-30 14:48:22 +0100819/**
820 * cpumap_print_to_pagebuf - copies the cpumask into the buffer either
821 * as comma-separated list of cpus or hex values of cpumask
822 * @list: indicates whether the cpumap must be list
823 * @mask: the cpumask to copy
824 * @buf: the buffer to copy into
825 *
826 * Returns the length of the (null-terminated) @buf string, zero if
827 * nothing is copied.
828 */
829static inline ssize_t
830cpumap_print_to_pagebuf(bool list, char *buf, const struct cpumask *mask)
831{
832 return bitmap_print_to_pagebuf(list, buf, cpumask_bits(mask),
Tejun Heo513e3d22015-02-13 14:36:50 -0800833 nr_cpu_ids);
Sudeep Holla5aaba362014-09-30 14:48:22 +0100834}
835
Rusty Russell9941a382015-03-05 10:49:19 +1030836#if NR_CPUS <= BITS_PER_LONG
837#define CPU_MASK_ALL \
838(cpumask_t) { { \
839 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
840} }
841#else
842#define CPU_MASK_ALL \
843(cpumask_t) { { \
844 [0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \
845 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
846} }
847#endif /* NR_CPUS > BITS_PER_LONG */
848
849#define CPU_MASK_NONE \
850(cpumask_t) { { \
851 [0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \
852} }
853
Rusty Russell15277812015-04-16 12:33:51 +0930854#define CPU_MASK_CPU0 \
855(cpumask_t) { { \
856 [0] = 1UL \
857} }
858
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859#endif /* __LINUX_CPUMASK_H */