nodemask.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516
  1. #ifndef __LINUX_NODEMASK_H
  2. #define __LINUX_NODEMASK_H
  3. /*
  4. * Nodemasks provide a bitmap suitable for representing the
  5. * set of Node's in a system, one bit position per Node number.
  6. *
  7. * See detailed comments in the file linux/bitmap.h describing the
  8. * data type on which these nodemasks are based.
  9. *
  10. * For details of nodemask_scnprintf() and nodemask_parse_user(),
  11. * see bitmap_scnprintf() and bitmap_parse_user() in lib/bitmap.c.
  12. * For details of nodelist_scnprintf() and nodelist_parse(), see
  13. * bitmap_scnlistprintf() and bitmap_parselist(), also in bitmap.c.
  14. * For details of node_remap(), see bitmap_bitremap in lib/bitmap.c.
  15. * For details of nodes_remap(), see bitmap_remap in lib/bitmap.c.
  16. * For details of nodes_onto(), see bitmap_onto in lib/bitmap.c.
  17. * For details of nodes_fold(), see bitmap_fold in lib/bitmap.c.
  18. *
  19. * The available nodemask operations are:
  20. *
  21. * void node_set(node, mask) turn on bit 'node' in mask
  22. * void node_clear(node, mask) turn off bit 'node' in mask
  23. * void nodes_setall(mask) set all bits
  24. * void nodes_clear(mask) clear all bits
  25. * int node_isset(node, mask) true iff bit 'node' set in mask
  26. * int node_test_and_set(node, mask) test and set bit 'node' in mask
  27. *
  28. * void nodes_and(dst, src1, src2) dst = src1 & src2 [intersection]
  29. * void nodes_or(dst, src1, src2) dst = src1 | src2 [union]
  30. * void nodes_xor(dst, src1, src2) dst = src1 ^ src2
  31. * void nodes_andnot(dst, src1, src2) dst = src1 & ~src2
  32. * void nodes_complement(dst, src) dst = ~src
  33. *
  34. * int nodes_equal(mask1, mask2) Does mask1 == mask2?
  35. * int nodes_intersects(mask1, mask2) Do mask1 and mask2 intersect?
  36. * int nodes_subset(mask1, mask2) Is mask1 a subset of mask2?
  37. * int nodes_empty(mask) Is mask empty (no bits sets)?
  38. * int nodes_full(mask) Is mask full (all bits sets)?
  39. * int nodes_weight(mask) Hamming weight - number of set bits
  40. *
  41. * void nodes_shift_right(dst, src, n) Shift right
  42. * void nodes_shift_left(dst, src, n) Shift left
  43. *
  44. * int first_node(mask) Number lowest set bit, or MAX_NUMNODES
  45. * int next_node(node, mask) Next node past 'node', or MAX_NUMNODES
  46. * int first_unset_node(mask) First node not set in mask, or
  47. * MAX_NUMNODES.
  48. *
  49. * nodemask_t nodemask_of_node(node) Return nodemask with bit 'node' set
  50. * NODE_MASK_ALL Initializer - all bits set
  51. * NODE_MASK_NONE Initializer - no bits set
  52. * unsigned long *nodes_addr(mask) Array of unsigned long's in mask
  53. *
  54. * int nodemask_scnprintf(buf, len, mask) Format nodemask for printing
  55. * int nodemask_parse_user(ubuf, ulen, mask) Parse ascii string as nodemask
  56. * int nodelist_scnprintf(buf, len, mask) Format nodemask as list for printing
  57. * int nodelist_parse(buf, map) Parse ascii string as nodelist
  58. * int node_remap(oldbit, old, new) newbit = map(old, new)(oldbit)
  59. * void nodes_remap(dst, src, old, new) *dst = map(old, new)(src)
  60. * void nodes_onto(dst, orig, relmap) *dst = orig relative to relmap
  61. * void nodes_fold(dst, orig, sz) dst bits = orig bits mod sz
  62. *
  63. * for_each_node_mask(node, mask) for-loop node over mask
  64. *
  65. * int num_online_nodes() Number of online Nodes
  66. * int num_possible_nodes() Number of all possible Nodes
  67. *
  68. * int node_random(mask) Random node with set bit in mask
  69. *
  70. * int node_online(node) Is some node online?
  71. * int node_possible(node) Is some node possible?
  72. *
  73. * node_set_online(node) set bit 'node' in node_online_map
  74. * node_set_offline(node) clear bit 'node' in node_online_map
  75. *
  76. * for_each_node(node) for-loop node over node_possible_map
  77. * for_each_online_node(node) for-loop node over node_online_map
  78. *
  79. * Subtlety:
  80. * 1) The 'type-checked' form of node_isset() causes gcc (3.3.2, anyway)
  81. * to generate slightly worse code. So use a simple one-line #define
  82. * for node_isset(), instead of wrapping an inline inside a macro, the
  83. * way we do the other calls.
  84. *
  85. * NODEMASK_SCRATCH
  86. * When doing above logical AND, OR, XOR, Remap operations the callers tend to
  87. * need temporary nodemask_t's on the stack. But if NODES_SHIFT is large,
  88. * nodemask_t's consume too much stack space. NODEMASK_SCRATCH is a helper
  89. * for such situations. See below and CPUMASK_ALLOC also.
  90. */
  91. #include <linux/kernel.h>
  92. #include <linux/threads.h>
  93. #include <linux/bitmap.h>
  94. #include <linux/numa.h>
  95. typedef struct { DECLARE_BITMAP(bits, MAX_NUMNODES); } nodemask_t;
  96. extern nodemask_t _unused_nodemask_arg_;
  97. #define node_set(node, dst) __node_set((node), &(dst))
  98. static inline void __node_set(int node, volatile nodemask_t *dstp)
  99. {
  100. set_bit(node, dstp->bits);
  101. }
  102. #define node_clear(node, dst) __node_clear((node), &(dst))
  103. static inline void __node_clear(int node, volatile nodemask_t *dstp)
  104. {
  105. clear_bit(node, dstp->bits);
  106. }
  107. #define nodes_setall(dst) __nodes_setall(&(dst), MAX_NUMNODES)
  108. static inline void __nodes_setall(nodemask_t *dstp, int nbits)
  109. {
  110. bitmap_fill(dstp->bits, nbits);
  111. }
  112. #define nodes_clear(dst) __nodes_clear(&(dst), MAX_NUMNODES)
  113. static inline void __nodes_clear(nodemask_t *dstp, int nbits)
  114. {
  115. bitmap_zero(dstp->bits, nbits);
  116. }
  117. /* No static inline type checking - see Subtlety (1) above. */
  118. #define node_isset(node, nodemask) test_bit((node), (nodemask).bits)
  119. #define node_test_and_set(node, nodemask) \
  120. __node_test_and_set((node), &(nodemask))
  121. static inline int __node_test_and_set(int node, nodemask_t *addr)
  122. {
  123. return test_and_set_bit(node, addr->bits);
  124. }
  125. #define nodes_and(dst, src1, src2) \
  126. __nodes_and(&(dst), &(src1), &(src2), MAX_NUMNODES)
  127. static inline void __nodes_and(nodemask_t *dstp, const nodemask_t *src1p,
  128. const nodemask_t *src2p, int nbits)
  129. {
  130. bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits);
  131. }
  132. #define nodes_or(dst, src1, src2) \
  133. __nodes_or(&(dst), &(src1), &(src2), MAX_NUMNODES)
  134. static inline void __nodes_or(nodemask_t *dstp, const nodemask_t *src1p,
  135. const nodemask_t *src2p, int nbits)
  136. {
  137. bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits);
  138. }
  139. #define nodes_xor(dst, src1, src2) \
  140. __nodes_xor(&(dst), &(src1), &(src2), MAX_NUMNODES)
  141. static inline void __nodes_xor(nodemask_t *dstp, const nodemask_t *src1p,
  142. const nodemask_t *src2p, int nbits)
  143. {
  144. bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits);
  145. }
  146. #define nodes_andnot(dst, src1, src2) \
  147. __nodes_andnot(&(dst), &(src1), &(src2), MAX_NUMNODES)
  148. static inline void __nodes_andnot(nodemask_t *dstp, const nodemask_t *src1p,
  149. const nodemask_t *src2p, int nbits)
  150. {
  151. bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits);
  152. }
  153. #define nodes_complement(dst, src) \
  154. __nodes_complement(&(dst), &(src), MAX_NUMNODES)
  155. static inline void __nodes_complement(nodemask_t *dstp,
  156. const nodemask_t *srcp, int nbits)
  157. {
  158. bitmap_complement(dstp->bits, srcp->bits, nbits);
  159. }
  160. #define nodes_equal(src1, src2) \
  161. __nodes_equal(&(src1), &(src2), MAX_NUMNODES)
  162. static inline int __nodes_equal(const nodemask_t *src1p,
  163. const nodemask_t *src2p, int nbits)
  164. {
  165. return bitmap_equal(src1p->bits, src2p->bits, nbits);
  166. }
  167. #define nodes_intersects(src1, src2) \
  168. __nodes_intersects(&(src1), &(src2), MAX_NUMNODES)
  169. static inline int __nodes_intersects(const nodemask_t *src1p,
  170. const nodemask_t *src2p, int nbits)
  171. {
  172. return bitmap_intersects(src1p->bits, src2p->bits, nbits);
  173. }
  174. #define nodes_subset(src1, src2) \
  175. __nodes_subset(&(src1), &(src2), MAX_NUMNODES)
  176. static inline int __nodes_subset(const nodemask_t *src1p,
  177. const nodemask_t *src2p, int nbits)
  178. {
  179. return bitmap_subset(src1p->bits, src2p->bits, nbits);
  180. }
  181. #define nodes_empty(src) __nodes_empty(&(src), MAX_NUMNODES)
  182. static inline int __nodes_empty(const nodemask_t *srcp, int nbits)
  183. {
  184. return bitmap_empty(srcp->bits, nbits);
  185. }
  186. #define nodes_full(nodemask) __nodes_full(&(nodemask), MAX_NUMNODES)
  187. static inline int __nodes_full(const nodemask_t *srcp, int nbits)
  188. {
  189. return bitmap_full(srcp->bits, nbits);
  190. }
  191. #define nodes_weight(nodemask) __nodes_weight(&(nodemask), MAX_NUMNODES)
  192. static inline int __nodes_weight(const nodemask_t *srcp, int nbits)
  193. {
  194. return bitmap_weight(srcp->bits, nbits);
  195. }
  196. #define nodes_shift_right(dst, src, n) \
  197. __nodes_shift_right(&(dst), &(src), (n), MAX_NUMNODES)
  198. static inline void __nodes_shift_right(nodemask_t *dstp,
  199. const nodemask_t *srcp, int n, int nbits)
  200. {
  201. bitmap_shift_right(dstp->bits, srcp->bits, n, nbits);
  202. }
  203. #define nodes_shift_left(dst, src, n) \
  204. __nodes_shift_left(&(dst), &(src), (n), MAX_NUMNODES)
  205. static inline void __nodes_shift_left(nodemask_t *dstp,
  206. const nodemask_t *srcp, int n, int nbits)
  207. {
  208. bitmap_shift_left(dstp->bits, srcp->bits, n, nbits);
  209. }
  210. /* FIXME: better would be to fix all architectures to never return
  211. > MAX_NUMNODES, then the silly min_ts could be dropped. */
  212. #define first_node(src) __first_node(&(src))
  213. static inline int __first_node(const nodemask_t *srcp)
  214. {
  215. return min_t(int, MAX_NUMNODES, find_first_bit(srcp->bits, MAX_NUMNODES));
  216. }
  217. #define next_node(n, src) __next_node((n), &(src))
  218. static inline int __next_node(int n, const nodemask_t *srcp)
  219. {
  220. return min_t(int,MAX_NUMNODES,find_next_bit(srcp->bits, MAX_NUMNODES, n+1));
  221. }
  222. static inline void init_nodemask_of_node(nodemask_t *mask, int node)
  223. {
  224. nodes_clear(*mask);
  225. node_set(node, *mask);
  226. }
  227. #define nodemask_of_node(node) \
  228. ({ \
  229. typeof(_unused_nodemask_arg_) m; \
  230. if (sizeof(m) == sizeof(unsigned long)) { \
  231. m.bits[0] = 1UL << (node); \
  232. } else { \
  233. init_nodemask_of_node(&m, (node)); \
  234. } \
  235. m; \
  236. })
  237. #define first_unset_node(mask) __first_unset_node(&(mask))
  238. static inline int __first_unset_node(const nodemask_t *maskp)
  239. {
  240. return min_t(int,MAX_NUMNODES,
  241. find_first_zero_bit(maskp->bits, MAX_NUMNODES));
  242. }
  243. #define NODE_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(MAX_NUMNODES)
  244. #if MAX_NUMNODES <= BITS_PER_LONG
  245. #define NODE_MASK_ALL \
  246. ((nodemask_t) { { \
  247. [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \
  248. } })
  249. #else
  250. #define NODE_MASK_ALL \
  251. ((nodemask_t) { { \
  252. [0 ... BITS_TO_LONGS(MAX_NUMNODES)-2] = ~0UL, \
  253. [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \
  254. } })
  255. #endif
  256. #define NODE_MASK_NONE \
  257. ((nodemask_t) { { \
  258. [0 ... BITS_TO_LONGS(MAX_NUMNODES)-1] = 0UL \
  259. } })
  260. #define nodes_addr(src) ((src).bits)
  261. #define nodemask_scnprintf(buf, len, src) \
  262. __nodemask_scnprintf((buf), (len), &(src), MAX_NUMNODES)
  263. static inline int __nodemask_scnprintf(char *buf, int len,
  264. const nodemask_t *srcp, int nbits)
  265. {
  266. return bitmap_scnprintf(buf, len, srcp->bits, nbits);
  267. }
  268. #define nodemask_parse_user(ubuf, ulen, dst) \
  269. __nodemask_parse_user((ubuf), (ulen), &(dst), MAX_NUMNODES)
  270. static inline int __nodemask_parse_user(const char __user *buf, int len,
  271. nodemask_t *dstp, int nbits)
  272. {
  273. return bitmap_parse_user(buf, len, dstp->bits, nbits);
  274. }
  275. #define nodelist_scnprintf(buf, len, src) \
  276. __nodelist_scnprintf((buf), (len), &(src), MAX_NUMNODES)
  277. static inline int __nodelist_scnprintf(char *buf, int len,
  278. const nodemask_t *srcp, int nbits)
  279. {
  280. return bitmap_scnlistprintf(buf, len, srcp->bits, nbits);
  281. }
  282. #define nodelist_parse(buf, dst) __nodelist_parse((buf), &(dst), MAX_NUMNODES)
  283. static inline int __nodelist_parse(const char *buf, nodemask_t *dstp, int nbits)
  284. {
  285. return bitmap_parselist(buf, dstp->bits, nbits);
  286. }
  287. #define node_remap(oldbit, old, new) \
  288. __node_remap((oldbit), &(old), &(new), MAX_NUMNODES)
  289. static inline int __node_remap(int oldbit,
  290. const nodemask_t *oldp, const nodemask_t *newp, int nbits)
  291. {
  292. return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits);
  293. }
  294. #define nodes_remap(dst, src, old, new) \
  295. __nodes_remap(&(dst), &(src), &(old), &(new), MAX_NUMNODES)
  296. static inline void __nodes_remap(nodemask_t *dstp, const nodemask_t *srcp,
  297. const nodemask_t *oldp, const nodemask_t *newp, int nbits)
  298. {
  299. bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits);
  300. }
  301. #define nodes_onto(dst, orig, relmap) \
  302. __nodes_onto(&(dst), &(orig), &(relmap), MAX_NUMNODES)
  303. static inline void __nodes_onto(nodemask_t *dstp, const nodemask_t *origp,
  304. const nodemask_t *relmapp, int nbits)
  305. {
  306. bitmap_onto(dstp->bits, origp->bits, relmapp->bits, nbits);
  307. }
  308. #define nodes_fold(dst, orig, sz) \
  309. __nodes_fold(&(dst), &(orig), sz, MAX_NUMNODES)
  310. static inline void __nodes_fold(nodemask_t *dstp, const nodemask_t *origp,
  311. int sz, int nbits)
  312. {
  313. bitmap_fold(dstp->bits, origp->bits, sz, nbits);
  314. }
  315. #if MAX_NUMNODES > 1
  316. #define for_each_node_mask(node, mask) \
  317. for ((node) = first_node(mask); \
  318. (node) < MAX_NUMNODES; \
  319. (node) = next_node((node), (mask)))
  320. #else /* MAX_NUMNODES == 1 */
  321. #define for_each_node_mask(node, mask) \
  322. if (!nodes_empty(mask)) \
  323. for ((node) = 0; (node) < 1; (node)++)
  324. #endif /* MAX_NUMNODES */
  325. /*
  326. * Bitmasks that are kept for all the nodes.
  327. */
  328. enum node_states {
  329. N_POSSIBLE, /* The node could become online at some point */
  330. N_ONLINE, /* The node is online */
  331. N_NORMAL_MEMORY, /* The node has regular memory */
  332. #ifdef CONFIG_HIGHMEM
  333. N_HIGH_MEMORY, /* The node has regular or high memory */
  334. #else
  335. N_HIGH_MEMORY = N_NORMAL_MEMORY,
  336. #endif
  337. N_CPU, /* The node has one or more cpus */
  338. NR_NODE_STATES
  339. };
  340. /*
  341. * The following particular system nodemasks and operations
  342. * on them manage all possible and online nodes.
  343. */
  344. extern nodemask_t node_states[NR_NODE_STATES];
  345. #if MAX_NUMNODES > 1
  346. static inline int node_state(int node, enum node_states state)
  347. {
  348. return node_isset(node, node_states[state]);
  349. }
  350. static inline void node_set_state(int node, enum node_states state)
  351. {
  352. __node_set(node, &node_states[state]);
  353. }
  354. static inline void node_clear_state(int node, enum node_states state)
  355. {
  356. __node_clear(node, &node_states[state]);
  357. }
  358. static inline int num_node_state(enum node_states state)
  359. {
  360. return nodes_weight(node_states[state]);
  361. }
  362. #define for_each_node_state(__node, __state) \
  363. for_each_node_mask((__node), node_states[__state])
  364. #define first_online_node first_node(node_states[N_ONLINE])
  365. #define next_online_node(nid) next_node((nid), node_states[N_ONLINE])
  366. extern int nr_node_ids;
  367. extern int nr_online_nodes;
  368. static inline void node_set_online(int nid)
  369. {
  370. node_set_state(nid, N_ONLINE);
  371. nr_online_nodes = num_node_state(N_ONLINE);
  372. }
  373. static inline void node_set_offline(int nid)
  374. {
  375. node_clear_state(nid, N_ONLINE);
  376. nr_online_nodes = num_node_state(N_ONLINE);
  377. }
  378. #else
  379. static inline int node_state(int node, enum node_states state)
  380. {
  381. return node == 0;
  382. }
  383. static inline void node_set_state(int node, enum node_states state)
  384. {
  385. }
  386. static inline void node_clear_state(int node, enum node_states state)
  387. {
  388. }
  389. static inline int num_node_state(enum node_states state)
  390. {
  391. return 1;
  392. }
  393. #define for_each_node_state(node, __state) \
  394. for ( (node) = 0; (node) == 0; (node) = 1)
  395. #define first_online_node 0
  396. #define next_online_node(nid) (MAX_NUMNODES)
  397. #define nr_node_ids 1
  398. #define nr_online_nodes 1
  399. #define node_set_online(node) node_set_state((node), N_ONLINE)
  400. #define node_set_offline(node) node_clear_state((node), N_ONLINE)
  401. #endif
  402. #if defined(CONFIG_NUMA) && (MAX_NUMNODES > 1)
  403. extern int node_random(const nodemask_t *maskp);
  404. #else
  405. static inline int node_random(const nodemask_t *mask)
  406. {
  407. return 0;
  408. }
  409. #endif
  410. #define node_online_map node_states[N_ONLINE]
  411. #define node_possible_map node_states[N_POSSIBLE]
  412. #define num_online_nodes() num_node_state(N_ONLINE)
  413. #define num_possible_nodes() num_node_state(N_POSSIBLE)
  414. #define node_online(node) node_state((node), N_ONLINE)
  415. #define node_possible(node) node_state((node), N_POSSIBLE)
  416. #define for_each_node(node) for_each_node_state(node, N_POSSIBLE)
  417. #define for_each_online_node(node) for_each_node_state(node, N_ONLINE)
  418. /*
  419. * For nodemask scrach area.
  420. * NODEMASK_ALLOC(type, name) allocates an object with a specified type and
  421. * name.
  422. */
  423. #if NODES_SHIFT > 8 /* nodemask_t > 256 bytes */
  424. #define NODEMASK_ALLOC(type, name, gfp_flags) \
  425. type *name = kmalloc(sizeof(*name), gfp_flags)
  426. #define NODEMASK_FREE(m) kfree(m)
  427. #else
  428. #define NODEMASK_ALLOC(type, name, gfp_flags) type _##name, *name = &_##name
  429. #define NODEMASK_FREE(m) do {} while (0)
  430. #endif
  431. /* A example struture for using NODEMASK_ALLOC, used in mempolicy. */
  432. struct nodemask_scratch {
  433. nodemask_t mask1;
  434. nodemask_t mask2;
  435. };
  436. #define NODEMASK_SCRATCH(x) \
  437. NODEMASK_ALLOC(struct nodemask_scratch, x, \
  438. GFP_KERNEL | __GFP_NORETRY)
  439. #define NODEMASK_SCRATCH_FREE(x) NODEMASK_FREE(x)
  440. #endif /* __LINUX_NODEMASK_H */