Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef __LINUX_CPUMASK_H |
3 | #define __LINUX_CPUMASK_H | |
4 | ||
5 | /* | |
6 | * Cpumasks provide a bitmap suitable for representing the | |
6ba2ef7b RR |
7 | * set of CPU's in a system, one bit position per CPU number. In general, |
8 | * only nr_cpu_ids (<= NR_CPUS) bits are valid. | |
1da177e4 | 9 | */ |
1da177e4 LT |
10 | #include <linux/kernel.h> |
11 | #include <linux/threads.h> | |
12 | #include <linux/bitmap.h> | |
0c09ab96 | 13 | #include <linux/atomic.h> |
187f1882 | 14 | #include <linux/bug.h> |
1da177e4 | 15 | |
cdfdef75 | 16 | /* Don't assign or return these: may not be this big! */ |
2d3854a3 | 17 | typedef struct cpumask { DECLARE_BITMAP(bits, NR_CPUS); } cpumask_t; |
1da177e4 | 18 | |
ae7a47e7 | 19 | /** |
6ba2ef7b RR |
20 | * cpumask_bits - get the bits in a cpumask |
21 | * @maskp: the struct cpumask * | |
ae7a47e7 | 22 | * |
6ba2ef7b RR |
23 | * You should only assume nr_cpu_ids bits of this mask are valid. This is |
24 | * a macro so it's const-correct. | |
ae7a47e7 | 25 | */ |
6ba2ef7b | 26 | #define cpumask_bits(maskp) ((maskp)->bits) |
7ea931c9 | 27 | |
f1bbc032 TH |
28 | /** |
29 | * cpumask_pr_args - printf args to output a cpumask | |
30 | * @maskp: cpumask to be printed | |
31 | * | |
32 | * Can be used to provide arguments for '%*pb[l]' when printing a cpumask. | |
33 | */ | |
34 | #define cpumask_pr_args(maskp) nr_cpu_ids, cpumask_bits(maskp) | |
35 | ||
41df0d61 | 36 | #if NR_CPUS == 1 |
9b130ad5 | 37 | #define nr_cpu_ids 1U |
6ba2ef7b | 38 | #else |
9b130ad5 | 39 | extern unsigned int nr_cpu_ids; |
41df0d61 MT |
40 | #endif |
41 | ||
6ba2ef7b RR |
42 | #ifdef CONFIG_CPUMASK_OFFSTACK |
43 | /* Assuming NR_CPUS is huge, a runtime limit is more efficient. Also, | |
44 | * not all bits may be allocated. */ | |
9b130ad5 | 45 | #define nr_cpumask_bits nr_cpu_ids |
6ba2ef7b | 46 | #else |
c311c797 | 47 | #define nr_cpumask_bits ((unsigned int)NR_CPUS) |
6ba2ef7b | 48 | #endif |
1da177e4 LT |
49 | |
50 | /* | |
51 | * The following particular system cpumasks and operations manage | |
b3199c02 | 52 | * possible, present, active and online cpus. |
1da177e4 | 53 | * |
b3199c02 RR |
54 | * cpu_possible_mask- has bit 'cpu' set iff cpu is populatable |
55 | * cpu_present_mask - has bit 'cpu' set iff cpu is populated | |
56 | * cpu_online_mask - has bit 'cpu' set iff cpu available to scheduler | |
57 | * cpu_active_mask - has bit 'cpu' set iff cpu available to migration | |
1da177e4 | 58 | * |
b3199c02 | 59 | * If !CONFIG_HOTPLUG_CPU, present == possible, and active == online. |
1da177e4 | 60 | * |
b3199c02 RR |
61 | * The cpu_possible_mask is fixed at boot time, as the set of CPU id's |
62 | * that it is possible might ever be plugged in at anytime during the | |
63 | * life of that system boot. The cpu_present_mask is dynamic(*), | |
64 | * representing which CPUs are currently plugged in. And | |
65 | * cpu_online_mask is the dynamic subset of cpu_present_mask, | |
66 | * indicating those CPUs available for scheduling. | |
67 | * | |
68 | * If HOTPLUG is enabled, then cpu_possible_mask is forced to have | |
1da177e4 LT |
69 | * all NR_CPUS bits set, otherwise it is just the set of CPUs that |
70 | * ACPI reports present at boot. | |
71 | * | |
b3199c02 | 72 | * If HOTPLUG is enabled, then cpu_present_mask varies dynamically, |
1da177e4 | 73 | * depending on what ACPI reports as currently plugged in, otherwise |
b3199c02 | 74 | * cpu_present_mask is just a copy of cpu_possible_mask. |
1da177e4 | 75 | * |
b3199c02 RR |
76 | * (*) Well, cpu_present_mask is dynamic in the hotplug case. If not |
77 | * hotplug, it's a copy of cpu_possible_mask, hence fixed at boot. | |
1da177e4 LT |
78 | * |
79 | * Subtleties: | |
80 | * 1) UP arch's (NR_CPUS == 1, CONFIG_SMP not defined) hardcode | |
81 | * assumption that their single CPU is online. The UP | |
b3199c02 | 82 | * cpu_{online,possible,present}_masks are placebos. Changing them |
1da177e4 LT |
83 | * will have no useful affect on the following num_*_cpus() |
84 | * and cpu_*() macros in the UP case. This ugliness is a UP | |
85 | * optimization - don't waste any instructions or memory references | |
86 | * asking if you're online or how many CPUs there are if there is | |
87 | * only one CPU. | |
1da177e4 LT |
88 | */ |
89 | ||
4b804c85 RV |
90 | extern struct cpumask __cpu_possible_mask; |
91 | extern struct cpumask __cpu_online_mask; | |
92 | extern struct cpumask __cpu_present_mask; | |
93 | extern struct cpumask __cpu_active_mask; | |
5aec01b8 RV |
94 | #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) | |
b3199c02 | 98 | |
0c09ab96 TG |
99 | extern atomic_t __num_online_cpus; |
100 | ||
1da177e4 | 101 | #if NR_CPUS > 1 |
0c09ab96 TG |
102 | /** |
103 | * num_online_cpus() - Read the number of online CPUs | |
104 | * | |
105 | * Despite the fact that __num_online_cpus is of type atomic_t, this | |
106 | * interface gives only a momentary snapshot and is not protected against | |
107 | * concurrent CPU hotplug operations unless invoked from a cpuhp_lock held | |
108 | * region. | |
109 | */ | |
110 | static inline unsigned int num_online_cpus(void) | |
111 | { | |
112 | return atomic_read(&__num_online_cpus); | |
113 | } | |
ae7a47e7 RR |
114 | #define num_possible_cpus() cpumask_weight(cpu_possible_mask) |
115 | #define num_present_cpus() cpumask_weight(cpu_present_mask) | |
6ad4c188 | 116 | #define num_active_cpus() cpumask_weight(cpu_active_mask) |
ae7a47e7 RR |
117 | #define cpu_online(cpu) cpumask_test_cpu((cpu), cpu_online_mask) |
118 | #define cpu_possible(cpu) cpumask_test_cpu((cpu), cpu_possible_mask) | |
119 | #define cpu_present(cpu) cpumask_test_cpu((cpu), cpu_present_mask) | |
120 | #define cpu_active(cpu) cpumask_test_cpu((cpu), cpu_active_mask) | |
1da177e4 | 121 | #else |
221e3ebf HC |
122 | #define num_online_cpus() 1U |
123 | #define num_possible_cpus() 1U | |
124 | #define num_present_cpus() 1U | |
125 | #define num_active_cpus() 1U | |
1da177e4 LT |
126 | #define cpu_online(cpu) ((cpu) == 0) |
127 | #define cpu_possible(cpu) ((cpu) == 0) | |
128 | #define cpu_present(cpu) ((cpu) == 0) | |
e761b772 | 129 | #define cpu_active(cpu) ((cpu) == 0) |
1da177e4 LT |
130 | #endif |
131 | ||
e797bda3 TG |
132 | extern cpumask_t cpus_booted_once_mask; |
133 | ||
80d19669 | 134 | static inline void cpu_max_bits_warn(unsigned int cpu, unsigned int bits) |
2d3854a3 RR |
135 | { |
136 | #ifdef CONFIG_DEBUG_PER_CPU_MAPS | |
80d19669 | 137 | WARN_ON_ONCE(cpu >= bits); |
2d3854a3 | 138 | #endif /* CONFIG_DEBUG_PER_CPU_MAPS */ |
80d19669 AN |
139 | } |
140 | ||
141 | /* verify cpu argument to cpumask_* operators */ | |
142 | static inline unsigned int cpumask_check(unsigned int cpu) | |
143 | { | |
144 | cpu_max_bits_warn(cpu, nr_cpumask_bits); | |
2d3854a3 RR |
145 | return cpu; |
146 | } | |
147 | ||
148 | #if NR_CPUS == 1 | |
984f2f37 RR |
149 | /* Uniprocessor. Assume all masks are "1". */ |
150 | static inline unsigned int cpumask_first(const struct cpumask *srcp) | |
151 | { | |
152 | return 0; | |
153 | } | |
154 | ||
e22cdc3f RM |
155 | static inline unsigned int cpumask_last(const struct cpumask *srcp) |
156 | { | |
157 | return 0; | |
158 | } | |
159 | ||
984f2f37 RR |
160 | /* Valid inputs for n are -1 and 0. */ |
161 | static inline unsigned int cpumask_next(int n, const struct cpumask *srcp) | |
162 | { | |
163 | return n+1; | |
164 | } | |
165 | ||
166 | static inline unsigned int cpumask_next_zero(int n, const struct cpumask *srcp) | |
167 | { | |
168 | return n+1; | |
169 | } | |
170 | ||
171 | static inline unsigned int cpumask_next_and(int n, | |
172 | const struct cpumask *srcp, | |
173 | const struct cpumask *andp) | |
174 | { | |
175 | return n+1; | |
176 | } | |
177 | ||
9af18e56 WB |
178 | static inline unsigned int cpumask_next_wrap(int n, const struct cpumask *mask, |
179 | int start, bool wrap) | |
180 | { | |
181 | /* cpu0 unless stop condition, wrap and at cpu0, then nr_cpumask_bits */ | |
182 | return (wrap && n == 0); | |
183 | } | |
184 | ||
984f2f37 RR |
185 | /* cpu must be a valid cpu, ie 0, so there's no other choice. */ |
186 | static inline unsigned int cpumask_any_but(const struct cpumask *mask, | |
187 | unsigned int cpu) | |
188 | { | |
189 | return 1; | |
190 | } | |
2d3854a3 | 191 | |
f36963c9 | 192 | static inline unsigned int cpumask_local_spread(unsigned int i, int node) |
da91309e | 193 | { |
da91309e AV |
194 | return 0; |
195 | } | |
196 | ||
46a87b38 PT |
197 | static inline int cpumask_any_and_distribute(const struct cpumask *src1p, |
198 | const struct cpumask *src2p) { | |
199 | return cpumask_next_and(-1, src1p, src2p); | |
200 | } | |
201 | ||
2d3854a3 RR |
202 | #define for_each_cpu(cpu, mask) \ |
203 | for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask) | |
8bd93a2c PM |
204 | #define for_each_cpu_not(cpu, mask) \ |
205 | for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask) | |
d207af2e MK |
206 | #define for_each_cpu_wrap(cpu, mask, start) \ |
207 | for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask, (void)(start)) | |
2a4a4082 AD |
208 | #define for_each_cpu_and(cpu, mask1, mask2) \ |
209 | for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask1, (void)mask2) | |
2d3854a3 RR |
210 | #else |
211 | /** | |
212 | * cpumask_first - get the first cpu in a cpumask | |
213 | * @srcp: the cpumask pointer | |
214 | * | |
215 | * Returns >= nr_cpu_ids if no cpus set. | |
216 | */ | |
217 | static inline unsigned int cpumask_first(const struct cpumask *srcp) | |
218 | { | |
219 | return find_first_bit(cpumask_bits(srcp), nr_cpumask_bits); | |
220 | } | |
221 | ||
e22cdc3f RM |
222 | /** |
223 | * cpumask_last - get the last CPU in a cpumask | |
224 | * @srcp: - the cpumask pointer | |
225 | * | |
226 | * Returns >= nr_cpumask_bits if no CPUs set. | |
227 | */ | |
228 | static inline unsigned int cpumask_last(const struct cpumask *srcp) | |
229 | { | |
230 | return find_last_bit(cpumask_bits(srcp), nr_cpumask_bits); | |
231 | } | |
232 | ||
f22ef333 | 233 | unsigned int cpumask_next(int n, const struct cpumask *srcp); |
2d3854a3 RR |
234 | |
235 | /** | |
236 | * cpumask_next_zero - get the next unset cpu in a cpumask | |
237 | * @n: the cpu prior to the place to search (ie. return will be > @n) | |
238 | * @srcp: the cpumask pointer | |
239 | * | |
240 | * Returns >= nr_cpu_ids if no further cpus unset. | |
241 | */ | |
242 | static inline unsigned int cpumask_next_zero(int n, const struct cpumask *srcp) | |
243 | { | |
244 | /* -1 is a legal arg here. */ | |
245 | if (n != -1) | |
246 | cpumask_check(n); | |
247 | return find_next_zero_bit(cpumask_bits(srcp), nr_cpumask_bits, n+1); | |
248 | } | |
249 | ||
250 | int cpumask_next_and(int n, const struct cpumask *, const struct cpumask *); | |
251 | int cpumask_any_but(const struct cpumask *mask, unsigned int cpu); | |
f36963c9 | 252 | unsigned int cpumask_local_spread(unsigned int i, int node); |
46a87b38 PT |
253 | int cpumask_any_and_distribute(const struct cpumask *src1p, |
254 | const struct cpumask *src2p); | |
2d3854a3 | 255 | |
984f2f37 RR |
256 | /** |
257 | * for_each_cpu - iterate over every cpu in a mask | |
258 | * @cpu: the (optionally unsigned) integer iterator | |
259 | * @mask: the cpumask pointer | |
260 | * | |
261 | * After the loop, cpu is >= nr_cpu_ids. | |
262 | */ | |
2d3854a3 RR |
263 | #define for_each_cpu(cpu, mask) \ |
264 | for ((cpu) = -1; \ | |
265 | (cpu) = cpumask_next((cpu), (mask)), \ | |
266 | (cpu) < nr_cpu_ids;) | |
984f2f37 | 267 | |
8bd93a2c PM |
268 | /** |
269 | * for_each_cpu_not - iterate over every cpu in a complemented mask | |
270 | * @cpu: the (optionally unsigned) integer iterator | |
271 | * @mask: the cpumask pointer | |
272 | * | |
273 | * After the loop, cpu is >= nr_cpu_ids. | |
274 | */ | |
275 | #define for_each_cpu_not(cpu, mask) \ | |
276 | for ((cpu) = -1; \ | |
277 | (cpu) = cpumask_next_zero((cpu), (mask)), \ | |
278 | (cpu) < nr_cpu_ids;) | |
279 | ||
c743f0a5 PZ |
280 | extern int cpumask_next_wrap(int n, const struct cpumask *mask, int start, bool wrap); |
281 | ||
282 | /** | |
283 | * for_each_cpu_wrap - iterate over every cpu in a mask, starting at a specified location | |
284 | * @cpu: the (optionally unsigned) integer iterator | |
285 | * @mask: the cpumask poiter | |
286 | * @start: the start location | |
287 | * | |
288 | * The implementation does not assume any bit in @mask is set (including @start). | |
289 | * | |
290 | * After the loop, cpu is >= nr_cpu_ids. | |
291 | */ | |
292 | #define for_each_cpu_wrap(cpu, mask, start) \ | |
293 | for ((cpu) = cpumask_next_wrap((start)-1, (mask), (start), false); \ | |
294 | (cpu) < nr_cpumask_bits; \ | |
295 | (cpu) = cpumask_next_wrap((cpu), (mask), (start), true)) | |
296 | ||
984f2f37 RR |
297 | /** |
298 | * for_each_cpu_and - iterate over every cpu in both masks | |
299 | * @cpu: the (optionally unsigned) integer iterator | |
2a4a4082 AD |
300 | * @mask1: the first cpumask pointer |
301 | * @mask2: the second cpumask pointer | |
984f2f37 RR |
302 | * |
303 | * This saves a temporary CPU mask in many places. It is equivalent to: | |
304 | * struct cpumask tmp; | |
2a4a4082 | 305 | * cpumask_and(&tmp, &mask1, &mask2); |
984f2f37 RR |
306 | * for_each_cpu(cpu, &tmp) |
307 | * ... | |
308 | * | |
309 | * After the loop, cpu is >= nr_cpu_ids. | |
310 | */ | |
2a4a4082 | 311 | #define for_each_cpu_and(cpu, mask1, mask2) \ |
2d3854a3 | 312 | for ((cpu) = -1; \ |
2a4a4082 | 313 | (cpu) = cpumask_next_and((cpu), (mask1), (mask2)), \ |
2d3854a3 RR |
314 | (cpu) < nr_cpu_ids;) |
315 | #endif /* SMP */ | |
316 | ||
317 | #define CPU_BITS_NONE \ | |
318 | { \ | |
319 | [0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \ | |
320 | } | |
321 | ||
322 | #define CPU_BITS_CPU0 \ | |
323 | { \ | |
324 | [0] = 1UL \ | |
325 | } | |
326 | ||
327 | /** | |
328 | * cpumask_set_cpu - set a cpu in a cpumask | |
329 | * @cpu: cpu number (< nr_cpu_ids) | |
330 | * @dstp: the cpumask pointer | |
331 | */ | |
332 | static inline void cpumask_set_cpu(unsigned int cpu, struct cpumask *dstp) | |
333 | { | |
334 | set_bit(cpumask_check(cpu), cpumask_bits(dstp)); | |
335 | } | |
336 | ||
6c8557bd PZ |
337 | static inline void __cpumask_set_cpu(unsigned int cpu, struct cpumask *dstp) |
338 | { | |
339 | __set_bit(cpumask_check(cpu), cpumask_bits(dstp)); | |
340 | } | |
341 | ||
342 | ||
2d3854a3 RR |
343 | /** |
344 | * cpumask_clear_cpu - clear a cpu in a cpumask | |
345 | * @cpu: cpu number (< nr_cpu_ids) | |
346 | * @dstp: the cpumask pointer | |
347 | */ | |
348 | static inline void cpumask_clear_cpu(int cpu, struct cpumask *dstp) | |
349 | { | |
350 | clear_bit(cpumask_check(cpu), cpumask_bits(dstp)); | |
351 | } | |
352 | ||
6c8557bd PZ |
353 | static inline void __cpumask_clear_cpu(int cpu, struct cpumask *dstp) |
354 | { | |
355 | __clear_bit(cpumask_check(cpu), cpumask_bits(dstp)); | |
356 | } | |
357 | ||
2d3854a3 RR |
358 | /** |
359 | * cpumask_test_cpu - test for a cpu in a cpumask | |
360 | * @cpu: cpu number (< nr_cpu_ids) | |
361 | * @cpumask: the cpumask pointer | |
362 | * | |
c777ad69 | 363 | * Returns 1 if @cpu is set in @cpumask, else returns 0 |
2d3854a3 | 364 | */ |
3bbf7f46 RV |
365 | static inline int cpumask_test_cpu(int cpu, const struct cpumask *cpumask) |
366 | { | |
367 | return test_bit(cpumask_check(cpu), cpumask_bits((cpumask))); | |
368 | } | |
2d3854a3 RR |
369 | |
370 | /** | |
371 | * cpumask_test_and_set_cpu - atomically test and set a cpu in a cpumask | |
372 | * @cpu: cpu number (< nr_cpu_ids) | |
373 | * @cpumask: the cpumask pointer | |
374 | * | |
c777ad69 AS |
375 | * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0 |
376 | * | |
2d3854a3 RR |
377 | * test_and_set_bit wrapper for cpumasks. |
378 | */ | |
379 | static inline int cpumask_test_and_set_cpu(int cpu, struct cpumask *cpumask) | |
380 | { | |
381 | return test_and_set_bit(cpumask_check(cpu), cpumask_bits(cpumask)); | |
382 | } | |
383 | ||
54fdade1 XG |
384 | /** |
385 | * cpumask_test_and_clear_cpu - atomically test and clear a cpu in a cpumask | |
386 | * @cpu: cpu number (< nr_cpu_ids) | |
387 | * @cpumask: the cpumask pointer | |
388 | * | |
c777ad69 AS |
389 | * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0 |
390 | * | |
54fdade1 XG |
391 | * test_and_clear_bit wrapper for cpumasks. |
392 | */ | |
393 | static inline int cpumask_test_and_clear_cpu(int cpu, struct cpumask *cpumask) | |
394 | { | |
395 | return test_and_clear_bit(cpumask_check(cpu), cpumask_bits(cpumask)); | |
396 | } | |
397 | ||
2d3854a3 RR |
398 | /** |
399 | * cpumask_setall - set all cpus (< nr_cpu_ids) in a cpumask | |
400 | * @dstp: the cpumask pointer | |
401 | */ | |
402 | static inline void cpumask_setall(struct cpumask *dstp) | |
403 | { | |
404 | bitmap_fill(cpumask_bits(dstp), nr_cpumask_bits); | |
405 | } | |
406 | ||
407 | /** | |
408 | * cpumask_clear - clear all cpus (< nr_cpu_ids) in a cpumask | |
409 | * @dstp: the cpumask pointer | |
410 | */ | |
411 | static inline void cpumask_clear(struct cpumask *dstp) | |
412 | { | |
413 | bitmap_zero(cpumask_bits(dstp), nr_cpumask_bits); | |
414 | } | |
415 | ||
416 | /** | |
417 | * cpumask_and - *dstp = *src1p & *src2p | |
418 | * @dstp: the cpumask result | |
419 | * @src1p: the first input | |
420 | * @src2p: the second input | |
c777ad69 AS |
421 | * |
422 | * If *@dstp is empty, returns 0, else returns 1 | |
2d3854a3 | 423 | */ |
f4b0373b | 424 | static inline int cpumask_and(struct cpumask *dstp, |
2d3854a3 RR |
425 | const struct cpumask *src1p, |
426 | const struct cpumask *src2p) | |
427 | { | |
f4b0373b | 428 | return bitmap_and(cpumask_bits(dstp), cpumask_bits(src1p), |
2d3854a3 RR |
429 | cpumask_bits(src2p), nr_cpumask_bits); |
430 | } | |
431 | ||
432 | /** | |
433 | * cpumask_or - *dstp = *src1p | *src2p | |
434 | * @dstp: the cpumask result | |
435 | * @src1p: the first input | |
436 | * @src2p: the second input | |
437 | */ | |
438 | static inline void cpumask_or(struct cpumask *dstp, const struct cpumask *src1p, | |
439 | const struct cpumask *src2p) | |
440 | { | |
441 | bitmap_or(cpumask_bits(dstp), cpumask_bits(src1p), | |
442 | cpumask_bits(src2p), nr_cpumask_bits); | |
443 | } | |
444 | ||
445 | /** | |
446 | * cpumask_xor - *dstp = *src1p ^ *src2p | |
447 | * @dstp: the cpumask result | |
448 | * @src1p: the first input | |
449 | * @src2p: the second input | |
450 | */ | |
451 | static inline void cpumask_xor(struct cpumask *dstp, | |
452 | const struct cpumask *src1p, | |
453 | const struct cpumask *src2p) | |
454 | { | |
455 | bitmap_xor(cpumask_bits(dstp), cpumask_bits(src1p), | |
456 | cpumask_bits(src2p), nr_cpumask_bits); | |
457 | } | |
458 | ||
459 | /** | |
460 | * cpumask_andnot - *dstp = *src1p & ~*src2p | |
461 | * @dstp: the cpumask result | |
462 | * @src1p: the first input | |
463 | * @src2p: the second input | |
c777ad69 AS |
464 | * |
465 | * If *@dstp is empty, returns 0, else returns 1 | |
2d3854a3 | 466 | */ |
f4b0373b | 467 | static inline int cpumask_andnot(struct cpumask *dstp, |
2d3854a3 RR |
468 | const struct cpumask *src1p, |
469 | const struct cpumask *src2p) | |
470 | { | |
f4b0373b | 471 | return bitmap_andnot(cpumask_bits(dstp), cpumask_bits(src1p), |
2d3854a3 RR |
472 | cpumask_bits(src2p), nr_cpumask_bits); |
473 | } | |
474 | ||
475 | /** | |
476 | * cpumask_complement - *dstp = ~*srcp | |
477 | * @dstp: the cpumask result | |
478 | * @srcp: the input to invert | |
479 | */ | |
480 | static inline void cpumask_complement(struct cpumask *dstp, | |
481 | const struct cpumask *srcp) | |
482 | { | |
483 | bitmap_complement(cpumask_bits(dstp), cpumask_bits(srcp), | |
484 | nr_cpumask_bits); | |
485 | } | |
486 | ||
487 | /** | |
488 | * cpumask_equal - *src1p == *src2p | |
489 | * @src1p: the first input | |
490 | * @src2p: the second input | |
491 | */ | |
492 | static inline bool cpumask_equal(const struct cpumask *src1p, | |
493 | const struct cpumask *src2p) | |
494 | { | |
495 | return bitmap_equal(cpumask_bits(src1p), cpumask_bits(src2p), | |
496 | nr_cpumask_bits); | |
497 | } | |
498 | ||
b9fa6442 TG |
499 | /** |
500 | * cpumask_or_equal - *src1p | *src2p == *src3p | |
501 | * @src1p: the first input | |
502 | * @src2p: the second input | |
503 | * @src3p: the third input | |
504 | */ | |
505 | static inline bool cpumask_or_equal(const struct cpumask *src1p, | |
506 | const struct cpumask *src2p, | |
507 | const struct cpumask *src3p) | |
508 | { | |
509 | return bitmap_or_equal(cpumask_bits(src1p), cpumask_bits(src2p), | |
510 | cpumask_bits(src3p), nr_cpumask_bits); | |
511 | } | |
512 | ||
2d3854a3 RR |
513 | /** |
514 | * cpumask_intersects - (*src1p & *src2p) != 0 | |
515 | * @src1p: the first input | |
516 | * @src2p: the second input | |
517 | */ | |
518 | static inline bool cpumask_intersects(const struct cpumask *src1p, | |
519 | const struct cpumask *src2p) | |
520 | { | |
521 | return bitmap_intersects(cpumask_bits(src1p), cpumask_bits(src2p), | |
522 | nr_cpumask_bits); | |
523 | } | |
524 | ||
525 | /** | |
526 | * cpumask_subset - (*src1p & ~*src2p) == 0 | |
527 | * @src1p: the first input | |
528 | * @src2p: the second input | |
c777ad69 AS |
529 | * |
530 | * Returns 1 if *@src1p is a subset of *@src2p, else returns 0 | |
2d3854a3 RR |
531 | */ |
532 | static inline int cpumask_subset(const struct cpumask *src1p, | |
533 | const struct cpumask *src2p) | |
534 | { | |
535 | return bitmap_subset(cpumask_bits(src1p), cpumask_bits(src2p), | |
536 | nr_cpumask_bits); | |
537 | } | |
538 | ||
539 | /** | |
540 | * cpumask_empty - *srcp == 0 | |
541 | * @srcp: the cpumask to that all cpus < nr_cpu_ids are clear. | |
542 | */ | |
543 | static inline bool cpumask_empty(const struct cpumask *srcp) | |
544 | { | |
545 | return bitmap_empty(cpumask_bits(srcp), nr_cpumask_bits); | |
546 | } | |
547 | ||
548 | /** | |
549 | * cpumask_full - *srcp == 0xFFFFFFFF... | |
550 | * @srcp: the cpumask to that all cpus < nr_cpu_ids are set. | |
551 | */ | |
552 | static inline bool cpumask_full(const struct cpumask *srcp) | |
553 | { | |
554 | return bitmap_full(cpumask_bits(srcp), nr_cpumask_bits); | |
555 | } | |
556 | ||
557 | /** | |
558 | * cpumask_weight - Count of bits in *srcp | |
559 | * @srcp: the cpumask to count bits (< nr_cpu_ids) in. | |
560 | */ | |
561 | static inline unsigned int cpumask_weight(const struct cpumask *srcp) | |
562 | { | |
563 | return bitmap_weight(cpumask_bits(srcp), nr_cpumask_bits); | |
564 | } | |
565 | ||
566 | /** | |
567 | * cpumask_shift_right - *dstp = *srcp >> n | |
568 | * @dstp: the cpumask result | |
569 | * @srcp: the input to shift | |
570 | * @n: the number of bits to shift by | |
571 | */ | |
572 | static inline void cpumask_shift_right(struct cpumask *dstp, | |
573 | const struct cpumask *srcp, int n) | |
574 | { | |
575 | bitmap_shift_right(cpumask_bits(dstp), cpumask_bits(srcp), n, | |
576 | nr_cpumask_bits); | |
577 | } | |
578 | ||
579 | /** | |
580 | * cpumask_shift_left - *dstp = *srcp << n | |
581 | * @dstp: the cpumask result | |
582 | * @srcp: the input to shift | |
583 | * @n: the number of bits to shift by | |
584 | */ | |
585 | static inline void cpumask_shift_left(struct cpumask *dstp, | |
586 | const struct cpumask *srcp, int n) | |
587 | { | |
588 | bitmap_shift_left(cpumask_bits(dstp), cpumask_bits(srcp), n, | |
589 | nr_cpumask_bits); | |
590 | } | |
591 | ||
592 | /** | |
593 | * cpumask_copy - *dstp = *srcp | |
594 | * @dstp: the result | |
595 | * @srcp: the input cpumask | |
596 | */ | |
597 | static inline void cpumask_copy(struct cpumask *dstp, | |
598 | const struct cpumask *srcp) | |
599 | { | |
600 | bitmap_copy(cpumask_bits(dstp), cpumask_bits(srcp), nr_cpumask_bits); | |
601 | } | |
602 | ||
603 | /** | |
604 | * cpumask_any - pick a "random" cpu from *srcp | |
605 | * @srcp: the input cpumask | |
606 | * | |
607 | * Returns >= nr_cpu_ids if no cpus set. | |
608 | */ | |
609 | #define cpumask_any(srcp) cpumask_first(srcp) | |
610 | ||
611 | /** | |
612 | * cpumask_first_and - return the first cpu from *srcp1 & *srcp2 | |
613 | * @src1p: the first input | |
614 | * @src2p: the second input | |
615 | * | |
616 | * Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and(). | |
617 | */ | |
618 | #define cpumask_first_and(src1p, src2p) cpumask_next_and(-1, (src1p), (src2p)) | |
619 | ||
620 | /** | |
621 | * cpumask_any_and - pick a "random" cpu from *mask1 & *mask2 | |
622 | * @mask1: the first input cpumask | |
623 | * @mask2: the second input cpumask | |
624 | * | |
625 | * Returns >= nr_cpu_ids if no cpus set. | |
626 | */ | |
627 | #define cpumask_any_and(mask1, mask2) cpumask_first_and((mask1), (mask2)) | |
628 | ||
cd83e42c RR |
629 | /** |
630 | * cpumask_of - the cpumask containing just a given cpu | |
631 | * @cpu: the cpu (<= nr_cpu_ids) | |
632 | */ | |
633 | #define cpumask_of(cpu) (get_cpu_mask(cpu)) | |
634 | ||
29c0177e RR |
635 | /** |
636 | * cpumask_parse_user - extract a cpumask from a user string | |
637 | * @buf: the buffer to extract from | |
638 | * @len: the length of the buffer | |
639 | * @dstp: the cpumask to set. | |
640 | * | |
641 | * Returns -errno, or 0 for success. | |
642 | */ | |
643 | static inline int cpumask_parse_user(const char __user *buf, int len, | |
644 | struct cpumask *dstp) | |
645 | { | |
4d59b6cc | 646 | return bitmap_parse_user(buf, len, cpumask_bits(dstp), nr_cpumask_bits); |
29c0177e RR |
647 | } |
648 | ||
4b060420 MT |
649 | /** |
650 | * cpumask_parselist_user - extract a cpumask from a user string | |
651 | * @buf: the buffer to extract from | |
652 | * @len: the length of the buffer | |
653 | * @dstp: the cpumask to set. | |
654 | * | |
655 | * Returns -errno, or 0 for success. | |
656 | */ | |
657 | static inline int cpumask_parselist_user(const char __user *buf, int len, | |
658 | struct cpumask *dstp) | |
659 | { | |
660 | return bitmap_parselist_user(buf, len, cpumask_bits(dstp), | |
4d59b6cc | 661 | nr_cpumask_bits); |
4b060420 MT |
662 | } |
663 | ||
ba630e49 | 664 | /** |
b06fb415 | 665 | * cpumask_parse - extract a cpumask from a string |
ba630e49 TH |
666 | * @buf: the buffer to extract from |
667 | * @dstp: the cpumask to set. | |
668 | * | |
669 | * Returns -errno, or 0 for success. | |
670 | */ | |
671 | static inline int cpumask_parse(const char *buf, struct cpumask *dstp) | |
672 | { | |
190535f7 | 673 | return bitmap_parse(buf, UINT_MAX, cpumask_bits(dstp), nr_cpumask_bits); |
ba630e49 TH |
674 | } |
675 | ||
29c0177e | 676 | /** |
231daf07 | 677 | * cpulist_parse - extract a cpumask from a user string of ranges |
29c0177e | 678 | * @buf: the buffer to extract from |
29c0177e RR |
679 | * @dstp: the cpumask to set. |
680 | * | |
681 | * Returns -errno, or 0 for success. | |
682 | */ | |
683 | static inline int cpulist_parse(const char *buf, struct cpumask *dstp) | |
684 | { | |
4d59b6cc | 685 | return bitmap_parselist(buf, cpumask_bits(dstp), nr_cpumask_bits); |
2d3854a3 RR |
686 | } |
687 | ||
688 | /** | |
689 | * cpumask_size - size to allocate for a 'struct cpumask' in bytes | |
2d3854a3 | 690 | */ |
4de373a1 | 691 | static inline unsigned int cpumask_size(void) |
2d3854a3 | 692 | { |
cdfdef75 | 693 | return BITS_TO_LONGS(nr_cpumask_bits) * sizeof(long); |
2d3854a3 RR |
694 | } |
695 | ||
696 | /* | |
697 | * cpumask_var_t: struct cpumask for stack usage. | |
698 | * | |
699 | * Oh, the wicked games we play! In order to make kernel coding a | |
700 | * little more difficult, we typedef cpumask_var_t to an array or a | |
701 | * pointer: doing &mask on an array is a noop, so it still works. | |
702 | * | |
703 | * ie. | |
704 | * cpumask_var_t tmpmask; | |
705 | * if (!alloc_cpumask_var(&tmpmask, GFP_KERNEL)) | |
706 | * return -ENOMEM; | |
707 | * | |
708 | * ... use 'tmpmask' like a normal struct cpumask * ... | |
709 | * | |
710 | * free_cpumask_var(tmpmask); | |
a64a26e8 KM |
711 | * |
712 | * | |
713 | * However, one notable exception is there. alloc_cpumask_var() allocates | |
714 | * only nr_cpumask_bits bits (in the other hand, real cpumask_t always has | |
715 | * NR_CPUS bits). Therefore you don't have to dereference cpumask_var_t. | |
716 | * | |
717 | * cpumask_var_t tmpmask; | |
718 | * if (!alloc_cpumask_var(&tmpmask, GFP_KERNEL)) | |
719 | * return -ENOMEM; | |
720 | * | |
721 | * var = *tmpmask; | |
722 | * | |
723 | * This code makes NR_CPUS length memcopy and brings to a memory corruption. | |
724 | * cpumask_copy() provide safe copy functionality. | |
4ba29684 CL |
725 | * |
726 | * Note that there is another evil here: If you define a cpumask_var_t | |
727 | * as a percpu variable then the way to obtain the address of the cpumask | |
728 | * structure differently influences what this_cpu_* operation needs to be | |
729 | * used. Please use this_cpu_cpumask_var_t in those cases. The direct use | |
730 | * of this_cpu_ptr() or this_cpu_read() will lead to failures when the | |
731 | * other type of cpumask_var_t implementation is configured. | |
668802c2 WL |
732 | * |
733 | * Please also note that __cpumask_var_read_mostly can be used to declare | |
734 | * a cpumask_var_t variable itself (not its content) as read mostly. | |
2d3854a3 RR |
735 | */ |
736 | #ifdef CONFIG_CPUMASK_OFFSTACK | |
737 | typedef struct cpumask *cpumask_var_t; | |
738 | ||
668802c2 WL |
739 | #define this_cpu_cpumask_var_ptr(x) this_cpu_read(x) |
740 | #define __cpumask_var_read_mostly __read_mostly | |
4ba29684 | 741 | |
7b4967c5 | 742 | bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node); |
2d3854a3 | 743 | bool alloc_cpumask_var(cpumask_var_t *mask, gfp_t flags); |
0281b5dc YL |
744 | bool zalloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node); |
745 | bool zalloc_cpumask_var(cpumask_var_t *mask, gfp_t flags); | |
2d3854a3 RR |
746 | void alloc_bootmem_cpumask_var(cpumask_var_t *mask); |
747 | void free_cpumask_var(cpumask_var_t mask); | |
cd83e42c | 748 | void free_bootmem_cpumask_var(cpumask_var_t mask); |
2d3854a3 | 749 | |
f7e30f01 MK |
750 | static inline bool cpumask_available(cpumask_var_t mask) |
751 | { | |
752 | return mask != NULL; | |
753 | } | |
754 | ||
2d3854a3 RR |
755 | #else |
756 | typedef struct cpumask cpumask_var_t[1]; | |
757 | ||
4ba29684 | 758 | #define this_cpu_cpumask_var_ptr(x) this_cpu_ptr(x) |
668802c2 | 759 | #define __cpumask_var_read_mostly |
4ba29684 | 760 | |
2d3854a3 RR |
761 | static inline bool alloc_cpumask_var(cpumask_var_t *mask, gfp_t flags) |
762 | { | |
763 | return true; | |
764 | } | |
765 | ||
7b4967c5 MT |
766 | static inline bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, |
767 | int node) | |
768 | { | |
769 | return true; | |
770 | } | |
771 | ||
0281b5dc YL |
772 | static inline bool zalloc_cpumask_var(cpumask_var_t *mask, gfp_t flags) |
773 | { | |
774 | cpumask_clear(*mask); | |
775 | return true; | |
776 | } | |
777 | ||
778 | static inline bool zalloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, | |
779 | int node) | |
780 | { | |
781 | cpumask_clear(*mask); | |
782 | return true; | |
783 | } | |
784 | ||
2d3854a3 RR |
785 | static inline void alloc_bootmem_cpumask_var(cpumask_var_t *mask) |
786 | { | |
787 | } | |
788 | ||
789 | static inline void free_cpumask_var(cpumask_var_t mask) | |
790 | { | |
791 | } | |
cd83e42c RR |
792 | |
793 | static inline void free_bootmem_cpumask_var(cpumask_var_t mask) | |
794 | { | |
795 | } | |
f7e30f01 MK |
796 | |
797 | static inline bool cpumask_available(cpumask_var_t mask) | |
798 | { | |
799 | return true; | |
800 | } | |
2d3854a3 RR |
801 | #endif /* CONFIG_CPUMASK_OFFSTACK */ |
802 | ||
2d3854a3 RR |
803 | /* It's common to want to use cpu_all_mask in struct member initializers, |
804 | * so it has to refer to an address rather than a pointer. */ | |
805 | extern const DECLARE_BITMAP(cpu_all_bits, NR_CPUS); | |
806 | #define cpu_all_mask to_cpumask(cpu_all_bits) | |
807 | ||
808 | /* First bits of cpu_bit_bitmap are in fact unset. */ | |
809 | #define cpu_none_mask to_cpumask(cpu_bit_bitmap[0]) | |
810 | ||
ae7a47e7 RR |
811 | #define for_each_possible_cpu(cpu) for_each_cpu((cpu), cpu_possible_mask) |
812 | #define for_each_online_cpu(cpu) for_each_cpu((cpu), cpu_online_mask) | |
813 | #define for_each_present_cpu(cpu) for_each_cpu((cpu), cpu_present_mask) | |
814 | ||
2d3854a3 | 815 | /* Wrappers for arch boot code to manipulate normally-constant masks */ |
3fa41520 RR |
816 | void init_cpu_present(const struct cpumask *src); |
817 | void init_cpu_possible(const struct cpumask *src); | |
818 | void init_cpu_online(const struct cpumask *src); | |
6ba2ef7b | 819 | |
427d77a3 TG |
820 | static inline void reset_cpu_possible_mask(void) |
821 | { | |
822 | bitmap_zero(cpumask_bits(&__cpu_possible_mask), NR_CPUS); | |
823 | } | |
824 | ||
9425676a RV |
825 | static inline void |
826 | set_cpu_possible(unsigned int cpu, bool possible) | |
827 | { | |
828 | if (possible) | |
829 | cpumask_set_cpu(cpu, &__cpu_possible_mask); | |
830 | else | |
831 | cpumask_clear_cpu(cpu, &__cpu_possible_mask); | |
832 | } | |
833 | ||
834 | static inline void | |
835 | set_cpu_present(unsigned int cpu, bool present) | |
836 | { | |
837 | if (present) | |
838 | cpumask_set_cpu(cpu, &__cpu_present_mask); | |
839 | else | |
840 | cpumask_clear_cpu(cpu, &__cpu_present_mask); | |
841 | } | |
842 | ||
0c09ab96 | 843 | void set_cpu_online(unsigned int cpu, bool online); |
9425676a RV |
844 | |
845 | static inline void | |
846 | set_cpu_active(unsigned int cpu, bool active) | |
847 | { | |
848 | if (active) | |
849 | cpumask_set_cpu(cpu, &__cpu_active_mask); | |
850 | else | |
851 | cpumask_clear_cpu(cpu, &__cpu_active_mask); | |
852 | } | |
853 | ||
854 | ||
6ba2ef7b RR |
855 | /** |
856 | * to_cpumask - convert an NR_CPUS bitmap to a struct cpumask * | |
857 | * @bitmap: the bitmap | |
858 | * | |
859 | * There are a few places where cpumask_var_t isn't appropriate and | |
860 | * static cpumasks must be used (eg. very early boot), yet we don't | |
861 | * expose the definition of 'struct cpumask'. | |
862 | * | |
863 | * This does the conversion, and can be used as a constant initializer. | |
864 | */ | |
865 | #define to_cpumask(bitmap) \ | |
866 | ((struct cpumask *)(1 ? (bitmap) \ | |
867 | : (void *)sizeof(__check_is_bitmap(bitmap)))) | |
868 | ||
869 | static inline int __check_is_bitmap(const unsigned long *bitmap) | |
870 | { | |
871 | return 1; | |
872 | } | |
873 | ||
874 | /* | |
875 | * Special-case data structure for "single bit set only" constant CPU masks. | |
876 | * | |
877 | * We pre-generate all the 64 (or 32) possible bit positions, with enough | |
878 | * padding to the left and the right, and return the constant pointer | |
879 | * appropriately offset. | |
880 | */ | |
881 | extern const unsigned long | |
882 | cpu_bit_bitmap[BITS_PER_LONG+1][BITS_TO_LONGS(NR_CPUS)]; | |
883 | ||
884 | static inline const struct cpumask *get_cpu_mask(unsigned int cpu) | |
885 | { | |
886 | const unsigned long *p = cpu_bit_bitmap[1 + cpu % BITS_PER_LONG]; | |
887 | p -= cpu / BITS_PER_LONG; | |
888 | return to_cpumask(p); | |
889 | } | |
890 | ||
891 | #define cpu_is_offline(cpu) unlikely(!cpu_online(cpu)) | |
892 | ||
893 | #if NR_CPUS <= BITS_PER_LONG | |
894 | #define CPU_BITS_ALL \ | |
895 | { \ | |
9941a383 | 896 | [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \ |
6ba2ef7b RR |
897 | } |
898 | ||
899 | #else /* NR_CPUS > BITS_PER_LONG */ | |
900 | ||
901 | #define CPU_BITS_ALL \ | |
902 | { \ | |
903 | [0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \ | |
9941a383 | 904 | [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \ |
6ba2ef7b RR |
905 | } |
906 | #endif /* NR_CPUS > BITS_PER_LONG */ | |
907 | ||
5aaba363 SH |
908 | /** |
909 | * cpumap_print_to_pagebuf - copies the cpumask into the buffer either | |
910 | * as comma-separated list of cpus or hex values of cpumask | |
911 | * @list: indicates whether the cpumap must be list | |
912 | * @mask: the cpumask to copy | |
913 | * @buf: the buffer to copy into | |
914 | * | |
915 | * Returns the length of the (null-terminated) @buf string, zero if | |
916 | * nothing is copied. | |
917 | */ | |
918 | static inline ssize_t | |
919 | cpumap_print_to_pagebuf(bool list, char *buf, const struct cpumask *mask) | |
920 | { | |
921 | return bitmap_print_to_pagebuf(list, buf, cpumask_bits(mask), | |
513e3d2d | 922 | nr_cpu_ids); |
5aaba363 SH |
923 | } |
924 | ||
6ba2ef7b | 925 | #if NR_CPUS <= BITS_PER_LONG |
6ba2ef7b RR |
926 | #define CPU_MASK_ALL \ |
927 | (cpumask_t) { { \ | |
9941a383 | 928 | [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \ |
6ba2ef7b | 929 | } } |
6ba2ef7b | 930 | #else |
6ba2ef7b RR |
931 | #define CPU_MASK_ALL \ |
932 | (cpumask_t) { { \ | |
933 | [0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \ | |
9941a383 | 934 | [BITS_TO_LONGS(NR_CPUS)-1] = BITMAP_LAST_WORD_MASK(NR_CPUS) \ |
6ba2ef7b | 935 | } } |
9941a383 | 936 | #endif /* NR_CPUS > BITS_PER_LONG */ |
6ba2ef7b RR |
937 | |
938 | #define CPU_MASK_NONE \ | |
939 | (cpumask_t) { { \ | |
940 | [0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \ | |
941 | } } | |
942 | ||
1527781d RR |
943 | #define CPU_MASK_CPU0 \ |
944 | (cpumask_t) { { \ | |
945 | [0] = 1UL \ | |
946 | } } | |
947 | ||
1da177e4 | 948 | #endif /* __LINUX_CPUMASK_H */ |