cpumask.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. #ifndef __LINUX_CPUMASK_H
  2. #define __LINUX_CPUMASK_H
  3. /*
  4. * Cpumasks provide a bitmap suitable for representing the
  5. * set of CPU's in a system, one bit position per CPU number.
  6. *
  7. * See detailed comments in the file linux/bitmap.h describing the
  8. * data type on which these cpumasks are based.
  9. *
  10. * For details of cpumask_scnprintf() and cpumask_parse_user(),
  11. * see bitmap_scnprintf() and bitmap_parse_user() in lib/bitmap.c.
  12. * For details of cpulist_scnprintf() and cpulist_parse(), see
  13. * bitmap_scnlistprintf() and bitmap_parselist(), also in bitmap.c.
  14. * For details of cpu_remap(), see bitmap_bitremap in lib/bitmap.c
  15. * For details of cpus_remap(), see bitmap_remap in lib/bitmap.c.
  16. *
  17. * The available cpumask operations are:
  18. *
  19. * void cpu_set(cpu, mask) turn on bit 'cpu' in mask
  20. * void cpu_clear(cpu, mask) turn off bit 'cpu' in mask
  21. * void cpus_setall(mask) set all bits
  22. * void cpus_clear(mask) clear all bits
  23. * int cpu_isset(cpu, mask) true iff bit 'cpu' set in mask
  24. * int cpu_test_and_set(cpu, mask) test and set bit 'cpu' in mask
  25. *
  26. * void cpus_and(dst, src1, src2) dst = src1 & src2 [intersection]
  27. * void cpus_or(dst, src1, src2) dst = src1 | src2 [union]
  28. * void cpus_xor(dst, src1, src2) dst = src1 ^ src2
  29. * void cpus_andnot(dst, src1, src2) dst = src1 & ~src2
  30. * void cpus_complement(dst, src) dst = ~src
  31. *
  32. * int cpus_equal(mask1, mask2) Does mask1 == mask2?
  33. * int cpus_intersects(mask1, mask2) Do mask1 and mask2 intersect?
  34. * int cpus_subset(mask1, mask2) Is mask1 a subset of mask2?
  35. * int cpus_empty(mask) Is mask empty (no bits sets)?
  36. * int cpus_full(mask) Is mask full (all bits sets)?
  37. * int cpus_weight(mask) Hamming weigh - number of set bits
  38. *
  39. * void cpus_shift_right(dst, src, n) Shift right
  40. * void cpus_shift_left(dst, src, n) Shift left
  41. *
  42. * int first_cpu(mask) Number lowest set bit, or NR_CPUS
  43. * int next_cpu(cpu, mask) Next cpu past 'cpu', or NR_CPUS
  44. *
  45. * cpumask_t cpumask_of_cpu(cpu) Return cpumask with bit 'cpu' set
  46. * CPU_MASK_ALL Initializer - all bits set
  47. * CPU_MASK_NONE Initializer - no bits set
  48. * unsigned long *cpus_addr(mask) Array of unsigned long's in mask
  49. *
  50. * int cpumask_scnprintf(buf, len, mask) Format cpumask for printing
  51. * int cpumask_parse_user(ubuf, ulen, mask) Parse ascii string as cpumask
  52. * int cpulist_scnprintf(buf, len, mask) Format cpumask as list for printing
  53. * int cpulist_parse(buf, map) Parse ascii string as cpulist
  54. * int cpu_remap(oldbit, old, new) newbit = map(old, new)(oldbit)
  55. * int cpus_remap(dst, src, old, new) *dst = map(old, new)(src)
  56. *
  57. * for_each_cpu_mask(cpu, mask) for-loop cpu over mask
  58. *
  59. * int num_online_cpus() Number of online CPUs
  60. * int num_possible_cpus() Number of all possible CPUs
  61. * int num_present_cpus() Number of present CPUs
  62. *
  63. * int cpu_online(cpu) Is some cpu online?
  64. * int cpu_possible(cpu) Is some cpu possible?
  65. * int cpu_present(cpu) Is some cpu present (can schedule)?
  66. *
  67. * int any_online_cpu(mask) First online cpu in mask
  68. *
  69. * for_each_possible_cpu(cpu) for-loop cpu over cpu_possible_map
  70. * for_each_online_cpu(cpu) for-loop cpu over cpu_online_map
  71. * for_each_present_cpu(cpu) for-loop cpu over cpu_present_map
  72. *
  73. * Subtlety:
  74. * 1) The 'type-checked' form of cpu_isset() causes gcc (3.3.2, anyway)
  75. * to generate slightly worse code. Note for example the additional
  76. * 40 lines of assembly code compiling the "for each possible cpu"
  77. * loops buried in the disk_stat_read() macros calls when compiling
  78. * drivers/block/genhd.c (arch i386, CONFIG_SMP=y). So use a simple
  79. * one-line #define for cpu_isset(), instead of wrapping an inline
  80. * inside a macro, the way we do the other calls.
  81. */
  82. #include <linux/kernel.h>
  83. #include <linux/threads.h>
  84. #include <linux/bitmap.h>
  85. typedef struct { DECLARE_BITMAP(bits, NR_CPUS); } cpumask_t;
  86. extern cpumask_t _unused_cpumask_arg_;
  87. #define cpu_set(cpu, dst) __cpu_set((cpu), &(dst))
  88. static inline void __cpu_set(int cpu, volatile cpumask_t *dstp)
  89. {
  90. set_bit(cpu, dstp->bits);
  91. }
  92. #define cpu_clear(cpu, dst) __cpu_clear((cpu), &(dst))
  93. static inline void __cpu_clear(int cpu, volatile cpumask_t *dstp)
  94. {
  95. clear_bit(cpu, dstp->bits);
  96. }
  97. #define cpus_setall(dst) __cpus_setall(&(dst), NR_CPUS)
  98. static inline void __cpus_setall(cpumask_t *dstp, int nbits)
  99. {
  100. bitmap_fill(dstp->bits, nbits);
  101. }
  102. #define cpus_clear(dst) __cpus_clear(&(dst), NR_CPUS)
  103. static inline void __cpus_clear(cpumask_t *dstp, int nbits)
  104. {
  105. bitmap_zero(dstp->bits, nbits);
  106. }
  107. /* No static inline type checking - see Subtlety (1) above. */
  108. #define cpu_isset(cpu, cpumask) test_bit((cpu), (cpumask).bits)
  109. #define cpu_test_and_set(cpu, cpumask) __cpu_test_and_set((cpu), &(cpumask))
  110. static inline int __cpu_test_and_set(int cpu, cpumask_t *addr)
  111. {
  112. return test_and_set_bit(cpu, addr->bits);
  113. }
  114. #define cpus_and(dst, src1, src2) __cpus_and(&(dst), &(src1), &(src2), NR_CPUS)
  115. static inline void __cpus_and(cpumask_t *dstp, const cpumask_t *src1p,
  116. const cpumask_t *src2p, int nbits)
  117. {
  118. bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits);
  119. }
  120. #define cpus_or(dst, src1, src2) __cpus_or(&(dst), &(src1), &(src2), NR_CPUS)
  121. static inline void __cpus_or(cpumask_t *dstp, const cpumask_t *src1p,
  122. const cpumask_t *src2p, int nbits)
  123. {
  124. bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits);
  125. }
  126. #define cpus_xor(dst, src1, src2) __cpus_xor(&(dst), &(src1), &(src2), NR_CPUS)
  127. static inline void __cpus_xor(cpumask_t *dstp, const cpumask_t *src1p,
  128. const cpumask_t *src2p, int nbits)
  129. {
  130. bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits);
  131. }
  132. #define cpus_andnot(dst, src1, src2) \
  133. __cpus_andnot(&(dst), &(src1), &(src2), NR_CPUS)
  134. static inline void __cpus_andnot(cpumask_t *dstp, const cpumask_t *src1p,
  135. const cpumask_t *src2p, int nbits)
  136. {
  137. bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits);
  138. }
  139. #define cpus_complement(dst, src) __cpus_complement(&(dst), &(src), NR_CPUS)
  140. static inline void __cpus_complement(cpumask_t *dstp,
  141. const cpumask_t *srcp, int nbits)
  142. {
  143. bitmap_complement(dstp->bits, srcp->bits, nbits);
  144. }
  145. #define cpus_equal(src1, src2) __cpus_equal(&(src1), &(src2), NR_CPUS)
  146. static inline int __cpus_equal(const cpumask_t *src1p,
  147. const cpumask_t *src2p, int nbits)
  148. {
  149. return bitmap_equal(src1p->bits, src2p->bits, nbits);
  150. }
  151. #define cpus_intersects(src1, src2) __cpus_intersects(&(src1), &(src2), NR_CPUS)
  152. static inline int __cpus_intersects(const cpumask_t *src1p,
  153. const cpumask_t *src2p, int nbits)
  154. {
  155. return bitmap_intersects(src1p->bits, src2p->bits, nbits);
  156. }
  157. #define cpus_subset(src1, src2) __cpus_subset(&(src1), &(src2), NR_CPUS)
  158. static inline int __cpus_subset(const cpumask_t *src1p,
  159. const cpumask_t *src2p, int nbits)
  160. {
  161. return bitmap_subset(src1p->bits, src2p->bits, nbits);
  162. }
  163. #define cpus_empty(src) __cpus_empty(&(src), NR_CPUS)
  164. static inline int __cpus_empty(const cpumask_t *srcp, int nbits)
  165. {
  166. return bitmap_empty(srcp->bits, nbits);
  167. }
  168. #define cpus_full(cpumask) __cpus_full(&(cpumask), NR_CPUS)
  169. static inline int __cpus_full(const cpumask_t *srcp, int nbits)
  170. {
  171. return bitmap_full(srcp->bits, nbits);
  172. }
  173. #define cpus_weight(cpumask) __cpus_weight(&(cpumask), NR_CPUS)
  174. static inline int __cpus_weight(const cpumask_t *srcp, int nbits)
  175. {
  176. return bitmap_weight(srcp->bits, nbits);
  177. }
  178. #define cpus_shift_right(dst, src, n) \
  179. __cpus_shift_right(&(dst), &(src), (n), NR_CPUS)
  180. static inline void __cpus_shift_right(cpumask_t *dstp,
  181. const cpumask_t *srcp, int n, int nbits)
  182. {
  183. bitmap_shift_right(dstp->bits, srcp->bits, n, nbits);
  184. }
  185. #define cpus_shift_left(dst, src, n) \
  186. __cpus_shift_left(&(dst), &(src), (n), NR_CPUS)
  187. static inline void __cpus_shift_left(cpumask_t *dstp,
  188. const cpumask_t *srcp, int n, int nbits)
  189. {
  190. bitmap_shift_left(dstp->bits, srcp->bits, n, nbits);
  191. }
  192. #ifdef CONFIG_SMP
  193. int __first_cpu(const cpumask_t *srcp);
  194. #define first_cpu(src) __first_cpu(&(src))
  195. int __next_cpu(int n, const cpumask_t *srcp);
  196. #define next_cpu(n, src) __next_cpu((n), &(src))
  197. #else
  198. #define first_cpu(src) 0
  199. #define next_cpu(n, src) 1
  200. #endif
  201. #define cpumask_of_cpu(cpu) \
  202. ({ \
  203. typeof(_unused_cpumask_arg_) m; \
  204. if (sizeof(m) == sizeof(unsigned long)) { \
  205. m.bits[0] = 1UL<<(cpu); \
  206. } else { \
  207. cpus_clear(m); \
  208. cpu_set((cpu), m); \
  209. } \
  210. m; \
  211. })
  212. #define CPU_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(NR_CPUS)
  213. #if NR_CPUS <= BITS_PER_LONG
  214. #define CPU_MASK_ALL \
  215. (cpumask_t) { { \
  216. [BITS_TO_LONGS(NR_CPUS)-1] = CPU_MASK_LAST_WORD \
  217. } }
  218. #else
  219. #define CPU_MASK_ALL \
  220. (cpumask_t) { { \
  221. [0 ... BITS_TO_LONGS(NR_CPUS)-2] = ~0UL, \
  222. [BITS_TO_LONGS(NR_CPUS)-1] = CPU_MASK_LAST_WORD \
  223. } }
  224. #endif
  225. #define CPU_MASK_NONE \
  226. (cpumask_t) { { \
  227. [0 ... BITS_TO_LONGS(NR_CPUS)-1] = 0UL \
  228. } }
  229. #define CPU_MASK_CPU0 \
  230. (cpumask_t) { { \
  231. [0] = 1UL \
  232. } }
  233. #define cpus_addr(src) ((src).bits)
  234. #define cpumask_scnprintf(buf, len, src) \
  235. __cpumask_scnprintf((buf), (len), &(src), NR_CPUS)
  236. static inline int __cpumask_scnprintf(char *buf, int len,
  237. const cpumask_t *srcp, int nbits)
  238. {
  239. return bitmap_scnprintf(buf, len, srcp->bits, nbits);
  240. }
  241. #define cpumask_parse_user(ubuf, ulen, dst) \
  242. __cpumask_parse_user((ubuf), (ulen), &(dst), NR_CPUS)
  243. static inline int __cpumask_parse_user(const char __user *buf, int len,
  244. cpumask_t *dstp, int nbits)
  245. {
  246. return bitmap_parse_user(buf, len, dstp->bits, nbits);
  247. }
  248. #define cpulist_scnprintf(buf, len, src) \
  249. __cpulist_scnprintf((buf), (len), &(src), NR_CPUS)
  250. static inline int __cpulist_scnprintf(char *buf, int len,
  251. const cpumask_t *srcp, int nbits)
  252. {
  253. return bitmap_scnlistprintf(buf, len, srcp->bits, nbits);
  254. }
  255. #define cpulist_parse(buf, dst) __cpulist_parse((buf), &(dst), NR_CPUS)
  256. static inline int __cpulist_parse(const char *buf, cpumask_t *dstp, int nbits)
  257. {
  258. return bitmap_parselist(buf, dstp->bits, nbits);
  259. }
  260. #define cpu_remap(oldbit, old, new) \
  261. __cpu_remap((oldbit), &(old), &(new), NR_CPUS)
  262. static inline int __cpu_remap(int oldbit,
  263. const cpumask_t *oldp, const cpumask_t *newp, int nbits)
  264. {
  265. return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits);
  266. }
  267. #define cpus_remap(dst, src, old, new) \
  268. __cpus_remap(&(dst), &(src), &(old), &(new), NR_CPUS)
  269. static inline void __cpus_remap(cpumask_t *dstp, const cpumask_t *srcp,
  270. const cpumask_t *oldp, const cpumask_t *newp, int nbits)
  271. {
  272. bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits);
  273. }
  274. #if NR_CPUS > 1
  275. #define for_each_cpu_mask(cpu, mask) \
  276. for ((cpu) = first_cpu(mask); \
  277. (cpu) < NR_CPUS; \
  278. (cpu) = next_cpu((cpu), (mask)))
  279. #else /* NR_CPUS == 1 */
  280. #define for_each_cpu_mask(cpu, mask) \
  281. for ((cpu) = 0; (cpu) < 1; (cpu)++, (void)mask)
  282. #endif /* NR_CPUS */
  283. /*
  284. * The following particular system cpumasks and operations manage
  285. * possible, present and online cpus. Each of them is a fixed size
  286. * bitmap of size NR_CPUS.
  287. *
  288. * #ifdef CONFIG_HOTPLUG_CPU
  289. * cpu_possible_map - has bit 'cpu' set iff cpu is populatable
  290. * cpu_present_map - has bit 'cpu' set iff cpu is populated
  291. * cpu_online_map - has bit 'cpu' set iff cpu available to scheduler
  292. * #else
  293. * cpu_possible_map - has bit 'cpu' set iff cpu is populated
  294. * cpu_present_map - copy of cpu_possible_map
  295. * cpu_online_map - has bit 'cpu' set iff cpu available to scheduler
  296. * #endif
  297. *
  298. * In either case, NR_CPUS is fixed at compile time, as the static
  299. * size of these bitmaps. The cpu_possible_map is fixed at boot
  300. * time, as the set of CPU id's that it is possible might ever
  301. * be plugged in at anytime during the life of that system boot.
  302. * The cpu_present_map is dynamic(*), representing which CPUs
  303. * are currently plugged in. And cpu_online_map is the dynamic
  304. * subset of cpu_present_map, indicating those CPUs available
  305. * for scheduling.
  306. *
  307. * If HOTPLUG is enabled, then cpu_possible_map is forced to have
  308. * all NR_CPUS bits set, otherwise it is just the set of CPUs that
  309. * ACPI reports present at boot.
  310. *
  311. * If HOTPLUG is enabled, then cpu_present_map varies dynamically,
  312. * depending on what ACPI reports as currently plugged in, otherwise
  313. * cpu_present_map is just a copy of cpu_possible_map.
  314. *
  315. * (*) Well, cpu_present_map is dynamic in the hotplug case. If not
  316. * hotplug, it's a copy of cpu_possible_map, hence fixed at boot.
  317. *
  318. * Subtleties:
  319. * 1) UP arch's (NR_CPUS == 1, CONFIG_SMP not defined) hardcode
  320. * assumption that their single CPU is online. The UP
  321. * cpu_{online,possible,present}_maps are placebos. Changing them
  322. * will have no useful affect on the following num_*_cpus()
  323. * and cpu_*() macros in the UP case. This ugliness is a UP
  324. * optimization - don't waste any instructions or memory references
  325. * asking if you're online or how many CPUs there are if there is
  326. * only one CPU.
  327. * 2) Most SMP arch's #define some of these maps to be some
  328. * other map specific to that arch. Therefore, the following
  329. * must be #define macros, not inlines. To see why, examine
  330. * the assembly code produced by the following. Note that
  331. * set1() writes phys_x_map, but set2() writes x_map:
  332. * int x_map, phys_x_map;
  333. * #define set1(a) x_map = a
  334. * inline void set2(int a) { x_map = a; }
  335. * #define x_map phys_x_map
  336. * main(){ set1(3); set2(5); }
  337. */
  338. extern cpumask_t cpu_possible_map;
  339. extern cpumask_t cpu_online_map;
  340. extern cpumask_t cpu_present_map;
  341. #if NR_CPUS > 1
  342. #define num_online_cpus() cpus_weight(cpu_online_map)
  343. #define num_possible_cpus() cpus_weight(cpu_possible_map)
  344. #define num_present_cpus() cpus_weight(cpu_present_map)
  345. #define cpu_online(cpu) cpu_isset((cpu), cpu_online_map)
  346. #define cpu_possible(cpu) cpu_isset((cpu), cpu_possible_map)
  347. #define cpu_present(cpu) cpu_isset((cpu), cpu_present_map)
  348. #else
  349. #define num_online_cpus() 1
  350. #define num_possible_cpus() 1
  351. #define num_present_cpus() 1
  352. #define cpu_online(cpu) ((cpu) == 0)
  353. #define cpu_possible(cpu) ((cpu) == 0)
  354. #define cpu_present(cpu) ((cpu) == 0)
  355. #endif
  356. #ifdef CONFIG_SMP
  357. extern int nr_cpu_ids;
  358. #define any_online_cpu(mask) __any_online_cpu(&(mask))
  359. int __any_online_cpu(const cpumask_t *mask);
  360. #else
  361. #define nr_cpu_ids 1
  362. #define any_online_cpu(mask) 0
  363. #endif
  364. #define for_each_possible_cpu(cpu) for_each_cpu_mask((cpu), cpu_possible_map)
  365. #define for_each_online_cpu(cpu) for_each_cpu_mask((cpu), cpu_online_map)
  366. #define for_each_present_cpu(cpu) for_each_cpu_mask((cpu), cpu_present_map)
  367. #endif /* __LINUX_CPUMASK_H */