include/linux/cpumask.h

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