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