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