blob: 4fbc62e891015b3fd469d66eae2264188bc33a55 [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
Olav Haugan99cd46a2016-05-29 19:56:37 -070056 * cpu_isolated_mask- has bit 'cpu' set iff cpu isolated
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 *
Rusty Russellb3199c02008-12-30 09:05:14 +103058 * If !CONFIG_HOTPLUG_CPU, present == possible, and active == online.
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 *
Rusty Russellb3199c02008-12-30 09:05:14 +103060 * The cpu_possible_mask is fixed at boot time, as the set of CPU id's
61 * that it is possible might ever be plugged in at anytime during the
62 * life of that system boot. The cpu_present_mask is dynamic(*),
63 * representing which CPUs are currently plugged in. And
64 * cpu_online_mask is the dynamic subset of cpu_present_mask,
65 * indicating those CPUs available for scheduling.
66 *
67 * If HOTPLUG is enabled, then cpu_possible_mask is forced to have
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 * all NR_CPUS bits set, otherwise it is just the set of CPUs that
69 * ACPI reports present at boot.
70 *
Rusty Russellb3199c02008-12-30 09:05:14 +103071 * If HOTPLUG is enabled, then cpu_present_mask varies dynamically,
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * depending on what ACPI reports as currently plugged in, otherwise
Rusty Russellb3199c02008-12-30 09:05:14 +103073 * cpu_present_mask is just a copy of cpu_possible_mask.
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 *
Rusty Russellb3199c02008-12-30 09:05:14 +103075 * (*) Well, cpu_present_mask is dynamic in the hotplug case. If not
76 * hotplug, it's a copy of cpu_possible_mask, hence fixed at boot.
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 *
78 * Subtleties:
79 * 1) UP arch's (NR_CPUS == 1, CONFIG_SMP not defined) hardcode
80 * assumption that their single CPU is online. The UP
Rusty Russellb3199c02008-12-30 09:05:14 +103081 * cpu_{online,possible,present}_masks are placebos. Changing them
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 * will have no useful affect on the following num_*_cpus()
83 * and cpu_*() macros in the UP case. This ugliness is a UP
84 * optimization - don't waste any instructions or memory references
85 * asking if you're online or how many CPUs there are if there is
86 * only one CPU.
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 */
88
Rasmus Villemoes4b804c82016-01-20 15:00:19 -080089extern struct cpumask __cpu_possible_mask;
90extern struct cpumask __cpu_online_mask;
91extern struct cpumask __cpu_present_mask;
92extern struct cpumask __cpu_active_mask;
Olav Haugan99cd46a2016-05-29 19:56:37 -070093extern struct cpumask __cpu_isolated_mask;
Rasmus Villemoes5aec01b2016-01-20 15:00:25 -080094#define cpu_possible_mask ((const struct cpumask *)&__cpu_possible_mask)
95#define cpu_online_mask ((const struct cpumask *)&__cpu_online_mask)
96#define cpu_present_mask ((const struct cpumask *)&__cpu_present_mask)
97#define cpu_active_mask ((const struct cpumask *)&__cpu_active_mask)
Olav Haugan99cd46a2016-05-29 19:56:37 -070098#define cpu_isolated_mask ((const struct cpumask *)&__cpu_isolated_mask)
Rusty Russellb3199c02008-12-30 09:05:14 +103099
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100#if NR_CPUS > 1
Rusty Russellae7a47e2008-12-30 09:05:15 +1030101#define num_online_cpus() cpumask_weight(cpu_online_mask)
102#define num_possible_cpus() cpumask_weight(cpu_possible_mask)
103#define num_present_cpus() cpumask_weight(cpu_present_mask)
Peter Zijlstra6ad4c182009-11-25 13:31:39 +0100104#define num_active_cpus() cpumask_weight(cpu_active_mask)
Olav Haugan99cd46a2016-05-29 19:56:37 -0700105#define num_isolated_cpus() cpumask_weight(cpu_isolated_mask)
Pavankumar Kondeti68435b02017-06-29 16:17:55 +0530106#define num_online_uniso_cpus() \
107({ \
108 cpumask_t mask; \
109 \
110 cpumask_andnot(&mask, cpu_online_mask, cpu_isolated_mask); \
111 cpumask_weight(&mask); \
112})
Rusty Russellae7a47e2008-12-30 09:05:15 +1030113#define cpu_online(cpu) cpumask_test_cpu((cpu), cpu_online_mask)
114#define cpu_possible(cpu) cpumask_test_cpu((cpu), cpu_possible_mask)
115#define cpu_present(cpu) cpumask_test_cpu((cpu), cpu_present_mask)
116#define cpu_active(cpu) cpumask_test_cpu((cpu), cpu_active_mask)
Olav Haugan99cd46a2016-05-29 19:56:37 -0700117#define cpu_isolated(cpu) cpumask_test_cpu((cpu), cpu_isolated_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118#else
Heiko Carstens221e3eb2010-03-05 13:42:41 -0800119#define num_online_cpus() 1U
120#define num_possible_cpus() 1U
121#define num_present_cpus() 1U
122#define num_active_cpus() 1U
Olav Haugan99cd46a2016-05-29 19:56:37 -0700123#define num_isolated_cpus() 0U
Pavankumar Kondeti68435b02017-06-29 16:17:55 +0530124#define num_online_uniso_cpus() 1U
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125#define cpu_online(cpu) ((cpu) == 0)
126#define cpu_possible(cpu) ((cpu) == 0)
127#define cpu_present(cpu) ((cpu) == 0)
Max Krasnyanskye761b772008-07-15 04:43:49 -0700128#define cpu_active(cpu) ((cpu) == 0)
Olav Haugan0315a602017-01-19 17:14:29 -0800129#define cpu_isolated(cpu) ((cpu) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#endif
131
Rusty Russell2d3854a2008-11-05 13:39:10 +1100132/* verify cpu argument to cpumask_* operators */
133static inline unsigned int cpumask_check(unsigned int cpu)
134{
135#ifdef CONFIG_DEBUG_PER_CPU_MAPS
136 WARN_ON_ONCE(cpu >= nr_cpumask_bits);
137#endif /* CONFIG_DEBUG_PER_CPU_MAPS */
138 return cpu;
139}
140
141#if NR_CPUS == 1
Rusty Russell984f2f32008-11-08 20:24:19 +1100142/* Uniprocessor. Assume all masks are "1". */
143static inline unsigned int cpumask_first(const struct cpumask *srcp)
144{
145 return 0;
146}
147
148/* Valid inputs for n are -1 and 0. */
149static inline unsigned int cpumask_next(int n, const struct cpumask *srcp)
150{
151 return n+1;
152}
153
154static inline unsigned int cpumask_next_zero(int n, const struct cpumask *srcp)
155{
156 return n+1;
157}
158
159static inline unsigned int cpumask_next_and(int n,
160 const struct cpumask *srcp,
161 const struct cpumask *andp)
162{
163 return n+1;
164}
165
166/* cpu must be a valid cpu, ie 0, so there's no other choice. */
167static inline unsigned int cpumask_any_but(const struct cpumask *mask,
168 unsigned int cpu)
169{
170 return 1;
171}
Rusty Russell2d3854a2008-11-05 13:39:10 +1100172
Rusty Russellf36963c2015-05-09 03:14:13 +0930173static inline unsigned int cpumask_local_spread(unsigned int i, int node)
Amir Vadaida913092014-06-09 10:24:38 +0300174{
Amir Vadaida913092014-06-09 10:24:38 +0300175 return 0;
176}
177
Rusty Russell2d3854a2008-11-05 13:39:10 +1100178#define for_each_cpu(cpu, mask) \
179 for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask)
Paul E. McKenney8bd93a22010-02-22 17:04:59 -0800180#define for_each_cpu_not(cpu, mask) \
181 for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask)
Rusty Russell2d3854a2008-11-05 13:39:10 +1100182#define for_each_cpu_and(cpu, mask, and) \
183 for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask, (void)and)
184#else
185/**
186 * cpumask_first - get the first cpu in a cpumask
187 * @srcp: the cpumask pointer
188 *
189 * Returns >= nr_cpu_ids if no cpus set.
190 */
191static inline unsigned int cpumask_first(const struct cpumask *srcp)
192{
193 return find_first_bit(cpumask_bits(srcp), nr_cpumask_bits);
194}
195
196/**
197 * cpumask_next - get the next 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 set.
202 */
203static inline unsigned int cpumask_next(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_bit(cpumask_bits(srcp), nr_cpumask_bits, n+1);
209}
210
211/**
212 * cpumask_next_zero - get the next unset cpu in a cpumask
213 * @n: the cpu prior to the place to search (ie. return will be > @n)
214 * @srcp: the cpumask pointer
215 *
216 * Returns >= nr_cpu_ids if no further cpus unset.
217 */
218static inline unsigned int cpumask_next_zero(int n, const struct cpumask *srcp)
219{
220 /* -1 is a legal arg here. */
221 if (n != -1)
222 cpumask_check(n);
223 return find_next_zero_bit(cpumask_bits(srcp), nr_cpumask_bits, n+1);
224}
225
226int cpumask_next_and(int n, const struct cpumask *, const struct cpumask *);
227int cpumask_any_but(const struct cpumask *mask, unsigned int cpu);
Rusty Russellf36963c2015-05-09 03:14:13 +0930228unsigned int cpumask_local_spread(unsigned int i, int node);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100229
Rusty Russell984f2f32008-11-08 20:24:19 +1100230/**
231 * for_each_cpu - iterate over every cpu in a mask
232 * @cpu: the (optionally unsigned) integer iterator
233 * @mask: the cpumask pointer
234 *
235 * After the loop, cpu is >= nr_cpu_ids.
236 */
Rusty Russell2d3854a2008-11-05 13:39:10 +1100237#define for_each_cpu(cpu, mask) \
238 for ((cpu) = -1; \
239 (cpu) = cpumask_next((cpu), (mask)), \
240 (cpu) < nr_cpu_ids;)
Rusty Russell984f2f32008-11-08 20:24:19 +1100241
242/**
Paul E. McKenney8bd93a22010-02-22 17:04:59 -0800243 * for_each_cpu_not - iterate over every cpu in a complemented mask
244 * @cpu: the (optionally unsigned) integer iterator
245 * @mask: the cpumask pointer
246 *
247 * After the loop, cpu is >= nr_cpu_ids.
248 */
249#define for_each_cpu_not(cpu, mask) \
250 for ((cpu) = -1; \
251 (cpu) = cpumask_next_zero((cpu), (mask)), \
252 (cpu) < nr_cpu_ids;)
253
254/**
Rusty Russell984f2f32008-11-08 20:24:19 +1100255 * for_each_cpu_and - iterate over every cpu in both masks
256 * @cpu: the (optionally unsigned) integer iterator
257 * @mask: the first cpumask pointer
258 * @and: the second cpumask pointer
259 *
260 * This saves a temporary CPU mask in many places. It is equivalent to:
261 * struct cpumask tmp;
262 * cpumask_and(&tmp, &mask, &and);
263 * for_each_cpu(cpu, &tmp)
264 * ...
265 *
266 * After the loop, cpu is >= nr_cpu_ids.
267 */
Rusty Russell2d3854a2008-11-05 13:39:10 +1100268#define for_each_cpu_and(cpu, mask, and) \
269 for ((cpu) = -1; \
270 (cpu) = cpumask_next_and((cpu), (mask), (and)), \
271 (cpu) < nr_cpu_ids;)
272#endif /* SMP */
273
274#define CPU_BITS_NONE \
275{ \
276 [0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \
277}
278
279#define CPU_BITS_CPU0 \
280{ \
281 [0] = 1UL \
282}
283
284/**
285 * cpumask_set_cpu - set a cpu in a cpumask
286 * @cpu: cpu number (< nr_cpu_ids)
287 * @dstp: the cpumask pointer
288 */
289static inline void cpumask_set_cpu(unsigned int cpu, struct cpumask *dstp)
290{
291 set_bit(cpumask_check(cpu), cpumask_bits(dstp));
292}
293
294/**
295 * cpumask_clear_cpu - clear a cpu in a cpumask
296 * @cpu: cpu number (< nr_cpu_ids)
297 * @dstp: the cpumask pointer
298 */
299static inline void cpumask_clear_cpu(int cpu, struct cpumask *dstp)
300{
301 clear_bit(cpumask_check(cpu), cpumask_bits(dstp));
302}
303
304/**
305 * cpumask_test_cpu - test for a cpu in a cpumask
306 * @cpu: cpu number (< nr_cpu_ids)
307 * @cpumask: the cpumask pointer
308 *
Alex Shic777ad62012-05-28 22:23:51 +0800309 * Returns 1 if @cpu is set in @cpumask, else returns 0
Rusty Russell2d3854a2008-11-05 13:39:10 +1100310 */
Rasmus Villemoes3bbf7f42015-03-31 13:25:05 +1030311static inline int cpumask_test_cpu(int cpu, const struct cpumask *cpumask)
312{
313 return test_bit(cpumask_check(cpu), cpumask_bits((cpumask)));
314}
Rusty Russell2d3854a2008-11-05 13:39:10 +1100315
316/**
317 * cpumask_test_and_set_cpu - atomically test and set a cpu in a cpumask
318 * @cpu: cpu number (< nr_cpu_ids)
319 * @cpumask: the cpumask pointer
320 *
Alex Shic777ad62012-05-28 22:23:51 +0800321 * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0
322 *
Rusty Russell2d3854a2008-11-05 13:39:10 +1100323 * test_and_set_bit wrapper for cpumasks.
324 */
325static inline int cpumask_test_and_set_cpu(int cpu, struct cpumask *cpumask)
326{
327 return test_and_set_bit(cpumask_check(cpu), cpumask_bits(cpumask));
328}
329
330/**
Xiao Guangrong54fdade2009-09-22 16:43:39 -0700331 * cpumask_test_and_clear_cpu - atomically test and clear a cpu in a cpumask
332 * @cpu: cpu number (< nr_cpu_ids)
333 * @cpumask: the cpumask pointer
334 *
Alex Shic777ad62012-05-28 22:23:51 +0800335 * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0
336 *
Xiao Guangrong54fdade2009-09-22 16:43:39 -0700337 * test_and_clear_bit wrapper for cpumasks.
338 */
339static inline int cpumask_test_and_clear_cpu(int cpu, struct cpumask *cpumask)
340{
341 return test_and_clear_bit(cpumask_check(cpu), cpumask_bits(cpumask));
342}
343
344/**
Rusty Russell2d3854a2008-11-05 13:39:10 +1100345 * cpumask_setall - set all cpus (< nr_cpu_ids) in a cpumask
346 * @dstp: the cpumask pointer
347 */
348static inline void cpumask_setall(struct cpumask *dstp)
349{
350 bitmap_fill(cpumask_bits(dstp), nr_cpumask_bits);
351}
352
353/**
354 * cpumask_clear - clear all cpus (< nr_cpu_ids) in a cpumask
355 * @dstp: the cpumask pointer
356 */
357static inline void cpumask_clear(struct cpumask *dstp)
358{
359 bitmap_zero(cpumask_bits(dstp), nr_cpumask_bits);
360}
361
362/**
363 * cpumask_and - *dstp = *src1p & *src2p
364 * @dstp: the cpumask result
365 * @src1p: the first input
366 * @src2p: the second input
Alex Shic777ad62012-05-28 22:23:51 +0800367 *
368 * If *@dstp is empty, returns 0, else returns 1
Rusty Russell2d3854a2008-11-05 13:39:10 +1100369 */
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700370static inline int cpumask_and(struct cpumask *dstp,
Rusty Russell2d3854a2008-11-05 13:39:10 +1100371 const struct cpumask *src1p,
372 const struct cpumask *src2p)
373{
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700374 return bitmap_and(cpumask_bits(dstp), cpumask_bits(src1p),
Rusty Russell2d3854a2008-11-05 13:39:10 +1100375 cpumask_bits(src2p), nr_cpumask_bits);
376}
377
378/**
379 * cpumask_or - *dstp = *src1p | *src2p
380 * @dstp: the cpumask result
381 * @src1p: the first input
382 * @src2p: the second input
383 */
384static inline void cpumask_or(struct cpumask *dstp, const struct cpumask *src1p,
385 const struct cpumask *src2p)
386{
387 bitmap_or(cpumask_bits(dstp), cpumask_bits(src1p),
388 cpumask_bits(src2p), nr_cpumask_bits);
389}
390
391/**
392 * cpumask_xor - *dstp = *src1p ^ *src2p
393 * @dstp: the cpumask result
394 * @src1p: the first input
395 * @src2p: the second input
396 */
397static inline void cpumask_xor(struct cpumask *dstp,
398 const struct cpumask *src1p,
399 const struct cpumask *src2p)
400{
401 bitmap_xor(cpumask_bits(dstp), cpumask_bits(src1p),
402 cpumask_bits(src2p), nr_cpumask_bits);
403}
404
405/**
406 * cpumask_andnot - *dstp = *src1p & ~*src2p
407 * @dstp: the cpumask result
408 * @src1p: the first input
409 * @src2p: the second input
Alex Shic777ad62012-05-28 22:23:51 +0800410 *
411 * If *@dstp is empty, returns 0, else returns 1
Rusty Russell2d3854a2008-11-05 13:39:10 +1100412 */
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700413static inline int cpumask_andnot(struct cpumask *dstp,
Rusty Russell2d3854a2008-11-05 13:39:10 +1100414 const struct cpumask *src1p,
415 const struct cpumask *src2p)
416{
Linus Torvaldsf4b03732009-08-21 09:26:15 -0700417 return bitmap_andnot(cpumask_bits(dstp), cpumask_bits(src1p),
Rusty Russell2d3854a2008-11-05 13:39:10 +1100418 cpumask_bits(src2p), nr_cpumask_bits);
419}
420
421/**
422 * cpumask_complement - *dstp = ~*srcp
423 * @dstp: the cpumask result
424 * @srcp: the input to invert
425 */
426static inline void cpumask_complement(struct cpumask *dstp,
427 const struct cpumask *srcp)
428{
429 bitmap_complement(cpumask_bits(dstp), cpumask_bits(srcp),
430 nr_cpumask_bits);
431}
432
433/**
434 * cpumask_equal - *src1p == *src2p
435 * @src1p: the first input
436 * @src2p: the second input
437 */
438static inline bool cpumask_equal(const struct cpumask *src1p,
439 const struct cpumask *src2p)
440{
441 return bitmap_equal(cpumask_bits(src1p), cpumask_bits(src2p),
442 nr_cpumask_bits);
443}
444
445/**
446 * cpumask_intersects - (*src1p & *src2p) != 0
447 * @src1p: the first input
448 * @src2p: the second input
449 */
450static inline bool cpumask_intersects(const struct cpumask *src1p,
451 const struct cpumask *src2p)
452{
453 return bitmap_intersects(cpumask_bits(src1p), cpumask_bits(src2p),
454 nr_cpumask_bits);
455}
456
457/**
458 * cpumask_subset - (*src1p & ~*src2p) == 0
459 * @src1p: the first input
460 * @src2p: the second input
Alex Shic777ad62012-05-28 22:23:51 +0800461 *
462 * Returns 1 if *@src1p is a subset of *@src2p, else returns 0
Rusty Russell2d3854a2008-11-05 13:39:10 +1100463 */
464static inline int cpumask_subset(const struct cpumask *src1p,
465 const struct cpumask *src2p)
466{
467 return bitmap_subset(cpumask_bits(src1p), cpumask_bits(src2p),
468 nr_cpumask_bits);
469}
470
471/**
472 * cpumask_empty - *srcp == 0
473 * @srcp: the cpumask to that all cpus < nr_cpu_ids are clear.
474 */
475static inline bool cpumask_empty(const struct cpumask *srcp)
476{
477 return bitmap_empty(cpumask_bits(srcp), nr_cpumask_bits);
478}
479
480/**
481 * cpumask_full - *srcp == 0xFFFFFFFF...
482 * @srcp: the cpumask to that all cpus < nr_cpu_ids are set.
483 */
484static inline bool cpumask_full(const struct cpumask *srcp)
485{
486 return bitmap_full(cpumask_bits(srcp), nr_cpumask_bits);
487}
488
489/**
490 * cpumask_weight - Count of bits in *srcp
491 * @srcp: the cpumask to count bits (< nr_cpu_ids) in.
492 */
493static inline unsigned int cpumask_weight(const struct cpumask *srcp)
494{
495 return bitmap_weight(cpumask_bits(srcp), nr_cpumask_bits);
496}
497
498/**
499 * cpumask_shift_right - *dstp = *srcp >> n
500 * @dstp: the cpumask result
501 * @srcp: the input to shift
502 * @n: the number of bits to shift by
503 */
504static inline void cpumask_shift_right(struct cpumask *dstp,
505 const struct cpumask *srcp, int n)
506{
507 bitmap_shift_right(cpumask_bits(dstp), cpumask_bits(srcp), n,
508 nr_cpumask_bits);
509}
510
511/**
512 * cpumask_shift_left - *dstp = *srcp << n
513 * @dstp: the cpumask result
514 * @srcp: the input to shift
515 * @n: the number of bits to shift by
516 */
517static inline void cpumask_shift_left(struct cpumask *dstp,
518 const struct cpumask *srcp, int n)
519{
520 bitmap_shift_left(cpumask_bits(dstp), cpumask_bits(srcp), n,
521 nr_cpumask_bits);
522}
523
524/**
525 * cpumask_copy - *dstp = *srcp
526 * @dstp: the result
527 * @srcp: the input cpumask
528 */
529static inline void cpumask_copy(struct cpumask *dstp,
530 const struct cpumask *srcp)
531{
532 bitmap_copy(cpumask_bits(dstp), cpumask_bits(srcp), nr_cpumask_bits);
533}
534
535/**
536 * cpumask_any - pick a "random" cpu from *srcp
537 * @srcp: the input cpumask
538 *
539 * Returns >= nr_cpu_ids if no cpus set.
540 */
541#define cpumask_any(srcp) cpumask_first(srcp)
542
543/**
544 * cpumask_first_and - return the first cpu from *srcp1 & *srcp2
545 * @src1p: the first input
546 * @src2p: the second input
547 *
548 * Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and().
549 */
550#define cpumask_first_and(src1p, src2p) cpumask_next_and(-1, (src1p), (src2p))
551
552/**
553 * cpumask_any_and - pick a "random" cpu from *mask1 & *mask2
554 * @mask1: the first input cpumask
555 * @mask2: the second input cpumask
556 *
557 * Returns >= nr_cpu_ids if no cpus set.
558 */
559#define cpumask_any_and(mask1, mask2) cpumask_first_and((mask1), (mask2))
560
561/**
Rusty Russellcd83e422008-11-07 11:12:29 +1100562 * cpumask_of - the cpumask containing just a given cpu
563 * @cpu: the cpu (<= nr_cpu_ids)
564 */
565#define cpumask_of(cpu) (get_cpu_mask(cpu))
566
567/**
Rusty Russell29c01772008-12-13 21:20:25 +1030568 * cpumask_parse_user - extract a cpumask from a user string
569 * @buf: the buffer to extract from
570 * @len: the length of the buffer
571 * @dstp: the cpumask to set.
572 *
573 * Returns -errno, or 0 for success.
574 */
575static inline int cpumask_parse_user(const char __user *buf, int len,
576 struct cpumask *dstp)
577{
Tejun Heoc4236b02017-02-08 14:30:56 -0800578 return bitmap_parse_user(buf, len, cpumask_bits(dstp), nr_cpumask_bits);
Rusty Russell29c01772008-12-13 21:20:25 +1030579}
580
581/**
Mike Travis4b060422011-05-24 17:13:12 -0700582 * cpumask_parselist_user - extract a cpumask from a user string
583 * @buf: the buffer to extract from
584 * @len: the length of the buffer
585 * @dstp: the cpumask to set.
586 *
587 * Returns -errno, or 0 for success.
588 */
589static inline int cpumask_parselist_user(const char __user *buf, int len,
590 struct cpumask *dstp)
591{
592 return bitmap_parselist_user(buf, len, cpumask_bits(dstp),
Tejun Heoc4236b02017-02-08 14:30:56 -0800593 nr_cpumask_bits);
Mike Travis4b060422011-05-24 17:13:12 -0700594}
595
596/**
Geliang Tangb06fb412016-08-02 14:05:42 -0700597 * cpumask_parse - extract a cpumask from a string
Tejun Heoba630e42013-03-12 11:30:04 -0700598 * @buf: the buffer to extract from
599 * @dstp: the cpumask to set.
600 *
601 * Returns -errno, or 0 for success.
602 */
603static inline int cpumask_parse(const char *buf, struct cpumask *dstp)
604{
605 char *nl = strchr(buf, '\n');
Brian W Hartcea092c2014-05-14 10:33:45 +0930606 unsigned int len = nl ? (unsigned int)(nl - buf) : strlen(buf);
Tejun Heoba630e42013-03-12 11:30:04 -0700607
Tejun Heoc4236b02017-02-08 14:30:56 -0800608 return bitmap_parse(buf, len, cpumask_bits(dstp), nr_cpumask_bits);
Tejun Heoba630e42013-03-12 11:30:04 -0700609}
610
611/**
Alex Shi231daf02012-07-27 09:29:42 +0930612 * cpulist_parse - extract a cpumask from a user string of ranges
Rusty Russell29c01772008-12-13 21:20:25 +1030613 * @buf: the buffer to extract from
Rusty Russell29c01772008-12-13 21:20:25 +1030614 * @dstp: the cpumask to set.
615 *
616 * Returns -errno, or 0 for success.
617 */
618static inline int cpulist_parse(const char *buf, struct cpumask *dstp)
619{
Tejun Heoc4236b02017-02-08 14:30:56 -0800620 return bitmap_parselist(buf, cpumask_bits(dstp), nr_cpumask_bits);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100621}
622
623/**
624 * cpumask_size - size to allocate for a 'struct cpumask' in bytes
Rusty Russell2d3854a2008-11-05 13:39:10 +1100625 */
626static inline size_t cpumask_size(void)
627{
Rusty Russellcdfdef72015-03-05 10:49:19 +1030628 return BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100629}
630
631/*
632 * cpumask_var_t: struct cpumask for stack usage.
633 *
634 * Oh, the wicked games we play! In order to make kernel coding a
635 * little more difficult, we typedef cpumask_var_t to an array or a
636 * pointer: doing &mask on an array is a noop, so it still works.
637 *
638 * ie.
639 * cpumask_var_t tmpmask;
640 * if (!alloc_cpumask_var(&tmpmask, GFP_KERNEL))
641 * return -ENOMEM;
642 *
643 * ... use 'tmpmask' like a normal struct cpumask * ...
644 *
645 * free_cpumask_var(tmpmask);
KOSAKI Motohiroa64a26e2011-07-26 16:08:45 -0700646 *
647 *
648 * However, one notable exception is there. alloc_cpumask_var() allocates
649 * only nr_cpumask_bits bits (in the other hand, real cpumask_t always has
650 * NR_CPUS bits). Therefore you don't have to dereference cpumask_var_t.
651 *
652 * cpumask_var_t tmpmask;
653 * if (!alloc_cpumask_var(&tmpmask, GFP_KERNEL))
654 * return -ENOMEM;
655 *
656 * var = *tmpmask;
657 *
658 * This code makes NR_CPUS length memcopy and brings to a memory corruption.
659 * cpumask_copy() provide safe copy functionality.
Christoph Lameter4ba29682014-08-26 19:12:21 -0500660 *
661 * Note that there is another evil here: If you define a cpumask_var_t
662 * as a percpu variable then the way to obtain the address of the cpumask
663 * structure differently influences what this_cpu_* operation needs to be
664 * used. Please use this_cpu_cpumask_var_t in those cases. The direct use
665 * of this_cpu_ptr() or this_cpu_read() will lead to failures when the
666 * other type of cpumask_var_t implementation is configured.
Rusty Russell2d3854a2008-11-05 13:39:10 +1100667 */
668#ifdef CONFIG_CPUMASK_OFFSTACK
669typedef struct cpumask *cpumask_var_t;
670
Christoph Lameter4ba29682014-08-26 19:12:21 -0500671#define this_cpu_cpumask_var_ptr(x) this_cpu_read(x)
672
Mike Travis7b4967c2008-12-19 16:56:37 +1030673bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100674bool alloc_cpumask_var(cpumask_var_t *mask, gfp_t flags);
Yinghai Lu0281b5d2009-06-06 14:50:36 -0700675bool zalloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node);
676bool zalloc_cpumask_var(cpumask_var_t *mask, gfp_t flags);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100677void alloc_bootmem_cpumask_var(cpumask_var_t *mask);
678void free_cpumask_var(cpumask_var_t mask);
Rusty Russellcd83e422008-11-07 11:12:29 +1100679void free_bootmem_cpumask_var(cpumask_var_t mask);
Rusty Russell2d3854a2008-11-05 13:39:10 +1100680
681#else
682typedef struct cpumask cpumask_var_t[1];
683
Christoph Lameter4ba29682014-08-26 19:12:21 -0500684#define this_cpu_cpumask_var_ptr(x) this_cpu_ptr(x)
685
Rusty Russell2d3854a2008-11-05 13:39:10 +1100686static inline bool alloc_cpumask_var(cpumask_var_t *mask, gfp_t flags)
687{
688 return true;
689}
690
Mike Travis7b4967c2008-12-19 16:56:37 +1030691static inline bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags,
692 int node)
693{
694 return true;
695}
696
Yinghai Lu0281b5d2009-06-06 14:50:36 -0700697static inline bool zalloc_cpumask_var(cpumask_var_t *mask, gfp_t flags)
698{
699 cpumask_clear(*mask);
700 return true;
701}
702
703static inline bool zalloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags,
704 int node)
705{
706 cpumask_clear(*mask);
707 return true;
708}
709
Rusty Russell2d3854a2008-11-05 13:39:10 +1100710static inline void alloc_bootmem_cpumask_var(cpumask_var_t *mask)
711{
712}
713
714static inline void free_cpumask_var(cpumask_var_t mask)
715{
716}
Rusty Russellcd83e422008-11-07 11:12:29 +1100717
718static inline void free_bootmem_cpumask_var(cpumask_var_t mask)
719{
720}
Rusty Russell2d3854a2008-11-05 13:39:10 +1100721#endif /* CONFIG_CPUMASK_OFFSTACK */
722
Rusty Russell2d3854a2008-11-05 13:39:10 +1100723/* It's common to want to use cpu_all_mask in struct member initializers,
724 * so it has to refer to an address rather than a pointer. */
725extern const DECLARE_BITMAP(cpu_all_bits, NR_CPUS);
726#define cpu_all_mask to_cpumask(cpu_all_bits)
727
728/* First bits of cpu_bit_bitmap are in fact unset. */
729#define cpu_none_mask to_cpumask(cpu_bit_bitmap[0])
730
Rusty Russellae7a47e2008-12-30 09:05:15 +1030731#define for_each_possible_cpu(cpu) for_each_cpu((cpu), cpu_possible_mask)
732#define for_each_online_cpu(cpu) for_each_cpu((cpu), cpu_online_mask)
733#define for_each_present_cpu(cpu) for_each_cpu((cpu), cpu_present_mask)
Olav Haugan99cd46a2016-05-29 19:56:37 -0700734#define for_each_isolated_cpu(cpu) for_each_cpu((cpu), cpu_isolated_mask)
Rusty Russellae7a47e2008-12-30 09:05:15 +1030735
Rusty Russell2d3854a2008-11-05 13:39:10 +1100736/* Wrappers for arch boot code to manipulate normally-constant masks */
Rusty Russell3fa41522008-12-30 09:05:16 +1030737void init_cpu_present(const struct cpumask *src);
738void init_cpu_possible(const struct cpumask *src);
739void init_cpu_online(const struct cpumask *src);
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600740
Rasmus Villemoes94256762016-01-20 15:00:28 -0800741static inline void
742set_cpu_possible(unsigned int cpu, bool possible)
743{
744 if (possible)
745 cpumask_set_cpu(cpu, &__cpu_possible_mask);
746 else
747 cpumask_clear_cpu(cpu, &__cpu_possible_mask);
748}
749
750static inline void
751set_cpu_present(unsigned int cpu, bool present)
752{
753 if (present)
754 cpumask_set_cpu(cpu, &__cpu_present_mask);
755 else
756 cpumask_clear_cpu(cpu, &__cpu_present_mask);
757}
758
759static inline void
760set_cpu_online(unsigned int cpu, bool online)
761{
Peter Zijlstra (Intel)e9d867a2016-03-10 12:54:08 +0100762 if (online)
Rasmus Villemoes94256762016-01-20 15:00:28 -0800763 cpumask_set_cpu(cpu, &__cpu_online_mask);
Peter Zijlstra (Intel)e9d867a2016-03-10 12:54:08 +0100764 else
Rasmus Villemoes94256762016-01-20 15:00:28 -0800765 cpumask_clear_cpu(cpu, &__cpu_online_mask);
Rasmus Villemoes94256762016-01-20 15:00:28 -0800766}
767
768static inline void
769set_cpu_active(unsigned int cpu, bool active)
770{
771 if (active)
772 cpumask_set_cpu(cpu, &__cpu_active_mask);
773 else
774 cpumask_clear_cpu(cpu, &__cpu_active_mask);
775}
776
Olav Haugan99cd46a2016-05-29 19:56:37 -0700777static inline void
778set_cpu_isolated(unsigned int cpu, bool isolated)
779{
780 if (isolated)
781 cpumask_set_cpu(cpu, &__cpu_isolated_mask);
782 else
783 cpumask_clear_cpu(cpu, &__cpu_isolated_mask);
784}
785
Rasmus Villemoes94256762016-01-20 15:00:28 -0800786
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600787/**
788 * to_cpumask - convert an NR_CPUS bitmap to a struct cpumask *
789 * @bitmap: the bitmap
790 *
791 * There are a few places where cpumask_var_t isn't appropriate and
792 * static cpumasks must be used (eg. very early boot), yet we don't
793 * expose the definition of 'struct cpumask'.
794 *
795 * This does the conversion, and can be used as a constant initializer.
796 */
797#define to_cpumask(bitmap) \
798 ((struct cpumask *)(1 ? (bitmap) \
799 : (void *)sizeof(__check_is_bitmap(bitmap))))
800
801static inline int __check_is_bitmap(const unsigned long *bitmap)
802{
803 return 1;
804}
805
806/*
807 * Special-case data structure for "single bit set only" constant CPU masks.
808 *
809 * We pre-generate all the 64 (or 32) possible bit positions, with enough
810 * padding to the left and the right, and return the constant pointer
811 * appropriately offset.
812 */
813extern const unsigned long
814 cpu_bit_bitmap[BITS_PER_LONG+1][BITS_TO_LONGS(NR_CPUS)];
815
816static inline const struct cpumask *get_cpu_mask(unsigned int cpu)
817{
818 const unsigned long *p = cpu_bit_bitmap[1 + cpu % BITS_PER_LONG];
819 p -= cpu / BITS_PER_LONG;
820 return to_cpumask(p);
821}
822
823#define cpu_is_offline(cpu) unlikely(!cpu_online(cpu))
824
825#if NR_CPUS <= BITS_PER_LONG
826#define CPU_BITS_ALL \
827{ \
Rusty Russell9941a382015-03-05 10:49:19 +1030828 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600829}
830
831#else /* NR_CPUS > BITS_PER_LONG */
832
833#define CPU_BITS_ALL \
834{ \
835 [0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \
Rusty Russell9941a382015-03-05 10:49:19 +1030836 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
Rusty Russell6ba2ef72009-09-24 09:34:53 -0600837}
838#endif /* NR_CPUS > BITS_PER_LONG */
839
Sudeep Holla5aaba362014-09-30 14:48:22 +0100840/**
841 * cpumap_print_to_pagebuf - copies the cpumask into the buffer either
842 * as comma-separated list of cpus or hex values of cpumask
843 * @list: indicates whether the cpumap must be list
844 * @mask: the cpumask to copy
845 * @buf: the buffer to copy into
846 *
847 * Returns the length of the (null-terminated) @buf string, zero if
848 * nothing is copied.
849 */
850static inline ssize_t
851cpumap_print_to_pagebuf(bool list, char *buf, const struct cpumask *mask)
852{
853 return bitmap_print_to_pagebuf(list, buf, cpumask_bits(mask),
Tejun Heo513e3d22015-02-13 14:36:50 -0800854 nr_cpu_ids);
Sudeep Holla5aaba362014-09-30 14:48:22 +0100855}
856
Rusty Russell9941a382015-03-05 10:49:19 +1030857#if NR_CPUS <= BITS_PER_LONG
858#define CPU_MASK_ALL \
859(cpumask_t) { { \
860 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
861} }
862#else
863#define CPU_MASK_ALL \
864(cpumask_t) { { \
865 [0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \
866 [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \
867} }
868#endif /* NR_CPUS > BITS_PER_LONG */
869
870#define CPU_MASK_NONE \
871(cpumask_t) { { \
872 [0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \
873} }
874
Rusty Russell15277812015-04-16 12:33:51 +0930875#define CPU_MASK_CPU0 \
876(cpumask_t) { { \
877 [0] = 1UL \
878} }
879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880#endif /* __LINUX_CPUMASK_H */