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