include/linux/cpumask.h

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