Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #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 | * | |
11 | * For details of nodemask_scnprintf() and nodemask_parse(), | |
12 | * see bitmap_scnprintf() and bitmap_parse() in lib/bitmap.c. | |
13 | * For details of nodelist_scnprintf() and nodelist_parse(), see | |
14 | * bitmap_scnlistprintf() and bitmap_parselist(), also in bitmap.c. | |
fb5eeeee PJ |
15 | * 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. | |
1da177e4 LT |
17 | * |
18 | * The available nodemask operations are: | |
19 | * | |
20 | * void node_set(node, mask) turn on bit 'node' in mask | |
21 | * void node_clear(node, mask) turn off bit 'node' in mask | |
22 | * void nodes_setall(mask) set all bits | |
23 | * void nodes_clear(mask) clear all bits | |
24 | * int node_isset(node, mask) true iff bit 'node' set in mask | |
25 | * int node_test_and_set(node, mask) test and set bit 'node' in mask | |
26 | * | |
27 | * void nodes_and(dst, src1, src2) dst = src1 & src2 [intersection] | |
28 | * void nodes_or(dst, src1, src2) dst = src1 | src2 [union] | |
29 | * void nodes_xor(dst, src1, src2) dst = src1 ^ src2 | |
30 | * void nodes_andnot(dst, src1, src2) dst = src1 & ~src2 | |
31 | * void nodes_complement(dst, src) dst = ~src | |
32 | * | |
33 | * int nodes_equal(mask1, mask2) Does mask1 == mask2? | |
34 | * int nodes_intersects(mask1, mask2) Do mask1 and mask2 intersect? | |
35 | * int nodes_subset(mask1, mask2) Is mask1 a subset of mask2? | |
36 | * int nodes_empty(mask) Is mask empty (no bits sets)? | |
37 | * int nodes_full(mask) Is mask full (all bits sets)? | |
38 | * int nodes_weight(mask) Hamming weight - number of set bits | |
39 | * | |
40 | * void nodes_shift_right(dst, src, n) Shift right | |
41 | * void nodes_shift_left(dst, src, n) Shift left | |
42 | * | |
43 | * int first_node(mask) Number lowest set bit, or MAX_NUMNODES | |
44 | * int next_node(node, mask) Next node past 'node', or MAX_NUMNODES | |
45 | * int first_unset_node(mask) First node not set in mask, or | |
46 | * MAX_NUMNODES. | |
47 | * | |
48 | * nodemask_t nodemask_of_node(node) Return nodemask with bit 'node' set | |
49 | * NODE_MASK_ALL Initializer - all bits set | |
50 | * NODE_MASK_NONE Initializer - no bits set | |
51 | * unsigned long *nodes_addr(mask) Array of unsigned long's in mask | |
52 | * | |
53 | * int nodemask_scnprintf(buf, len, mask) Format nodemask for printing | |
54 | * int nodemask_parse(ubuf, ulen, mask) Parse ascii string as nodemask | |
55 | * int nodelist_scnprintf(buf, len, mask) Format nodemask as list for printing | |
56 | * int nodelist_parse(buf, map) Parse ascii string as nodelist | |
fb5eeeee PJ |
57 | * int node_remap(oldbit, old, new) newbit = map(old, new)(oldbit) |
58 | * int nodes_remap(dst, src, old, new) *dst = map(old, new)(dst) | |
1da177e4 LT |
59 | * |
60 | * for_each_node_mask(node, mask) for-loop node over mask | |
61 | * | |
62 | * int num_online_nodes() Number of online Nodes | |
63 | * int num_possible_nodes() Number of all possible Nodes | |
64 | * | |
65 | * int node_online(node) Is some node online? | |
66 | * int node_possible(node) Is some node possible? | |
67 | * | |
68 | * int any_online_node(mask) First online node in mask | |
69 | * | |
70 | * node_set_online(node) set bit 'node' in node_online_map | |
71 | * node_set_offline(node) clear bit 'node' in node_online_map | |
72 | * | |
73 | * for_each_node(node) for-loop node over node_possible_map | |
74 | * for_each_online_node(node) for-loop node over node_online_map | |
75 | * | |
76 | * Subtlety: | |
77 | * 1) The 'type-checked' form of node_isset() causes gcc (3.3.2, anyway) | |
78 | * to generate slightly worse code. So use a simple one-line #define | |
79 | * for node_isset(), instead of wrapping an inline inside a macro, the | |
80 | * way we do the other calls. | |
81 | */ | |
82 | ||
83 | #include <linux/kernel.h> | |
84 | #include <linux/threads.h> | |
85 | #include <linux/bitmap.h> | |
86 | #include <linux/numa.h> | |
87 | #include <asm/bug.h> | |
88 | ||
89 | typedef struct { DECLARE_BITMAP(bits, MAX_NUMNODES); } nodemask_t; | |
90 | extern nodemask_t _unused_nodemask_arg_; | |
91 | ||
92 | #define node_set(node, dst) __node_set((node), &(dst)) | |
93 | static inline void __node_set(int node, volatile nodemask_t *dstp) | |
94 | { | |
95 | set_bit(node, dstp->bits); | |
96 | } | |
97 | ||
98 | #define node_clear(node, dst) __node_clear((node), &(dst)) | |
99 | static inline void __node_clear(int node, volatile nodemask_t *dstp) | |
100 | { | |
101 | clear_bit(node, dstp->bits); | |
102 | } | |
103 | ||
104 | #define nodes_setall(dst) __nodes_setall(&(dst), MAX_NUMNODES) | |
105 | static inline void __nodes_setall(nodemask_t *dstp, int nbits) | |
106 | { | |
107 | bitmap_fill(dstp->bits, nbits); | |
108 | } | |
109 | ||
110 | #define nodes_clear(dst) __nodes_clear(&(dst), MAX_NUMNODES) | |
111 | static inline void __nodes_clear(nodemask_t *dstp, int nbits) | |
112 | { | |
113 | bitmap_zero(dstp->bits, nbits); | |
114 | } | |
115 | ||
116 | /* No static inline type checking - see Subtlety (1) above. */ | |
117 | #define node_isset(node, nodemask) test_bit((node), (nodemask).bits) | |
118 | ||
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 | ||
126 | #define nodes_and(dst, src1, src2) \ | |
127 | __nodes_and(&(dst), &(src1), &(src2), MAX_NUMNODES) | |
128 | static inline void __nodes_and(nodemask_t *dstp, const nodemask_t *src1p, | |
129 | const nodemask_t *src2p, int nbits) | |
130 | { | |
131 | bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits); | |
132 | } | |
133 | ||
134 | #define nodes_or(dst, src1, src2) \ | |
135 | __nodes_or(&(dst), &(src1), &(src2), MAX_NUMNODES) | |
136 | static inline void __nodes_or(nodemask_t *dstp, const nodemask_t *src1p, | |
137 | const nodemask_t *src2p, int nbits) | |
138 | { | |
139 | bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits); | |
140 | } | |
141 | ||
142 | #define nodes_xor(dst, src1, src2) \ | |
143 | __nodes_xor(&(dst), &(src1), &(src2), MAX_NUMNODES) | |
144 | static inline void __nodes_xor(nodemask_t *dstp, const nodemask_t *src1p, | |
145 | const nodemask_t *src2p, int nbits) | |
146 | { | |
147 | bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits); | |
148 | } | |
149 | ||
150 | #define nodes_andnot(dst, src1, src2) \ | |
151 | __nodes_andnot(&(dst), &(src1), &(src2), MAX_NUMNODES) | |
152 | static inline void __nodes_andnot(nodemask_t *dstp, const nodemask_t *src1p, | |
153 | const nodemask_t *src2p, int nbits) | |
154 | { | |
155 | bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits); | |
156 | } | |
157 | ||
158 | #define nodes_complement(dst, src) \ | |
159 | __nodes_complement(&(dst), &(src), MAX_NUMNODES) | |
160 | static inline void __nodes_complement(nodemask_t *dstp, | |
161 | const nodemask_t *srcp, int nbits) | |
162 | { | |
163 | bitmap_complement(dstp->bits, srcp->bits, nbits); | |
164 | } | |
165 | ||
166 | #define nodes_equal(src1, src2) \ | |
167 | __nodes_equal(&(src1), &(src2), MAX_NUMNODES) | |
168 | static inline int __nodes_equal(const nodemask_t *src1p, | |
169 | const nodemask_t *src2p, int nbits) | |
170 | { | |
171 | return bitmap_equal(src1p->bits, src2p->bits, nbits); | |
172 | } | |
173 | ||
174 | #define nodes_intersects(src1, src2) \ | |
175 | __nodes_intersects(&(src1), &(src2), MAX_NUMNODES) | |
176 | static inline int __nodes_intersects(const nodemask_t *src1p, | |
177 | const nodemask_t *src2p, int nbits) | |
178 | { | |
179 | return bitmap_intersects(src1p->bits, src2p->bits, nbits); | |
180 | } | |
181 | ||
182 | #define nodes_subset(src1, src2) \ | |
183 | __nodes_subset(&(src1), &(src2), MAX_NUMNODES) | |
184 | static inline int __nodes_subset(const nodemask_t *src1p, | |
185 | const nodemask_t *src2p, int nbits) | |
186 | { | |
187 | return bitmap_subset(src1p->bits, src2p->bits, nbits); | |
188 | } | |
189 | ||
190 | #define nodes_empty(src) __nodes_empty(&(src), MAX_NUMNODES) | |
191 | static inline int __nodes_empty(const nodemask_t *srcp, int nbits) | |
192 | { | |
193 | return bitmap_empty(srcp->bits, nbits); | |
194 | } | |
195 | ||
196 | #define nodes_full(nodemask) __nodes_full(&(nodemask), MAX_NUMNODES) | |
197 | static inline int __nodes_full(const nodemask_t *srcp, int nbits) | |
198 | { | |
199 | return bitmap_full(srcp->bits, nbits); | |
200 | } | |
201 | ||
202 | #define nodes_weight(nodemask) __nodes_weight(&(nodemask), MAX_NUMNODES) | |
203 | static inline int __nodes_weight(const nodemask_t *srcp, int nbits) | |
204 | { | |
205 | return bitmap_weight(srcp->bits, nbits); | |
206 | } | |
207 | ||
208 | #define nodes_shift_right(dst, src, n) \ | |
209 | __nodes_shift_right(&(dst), &(src), (n), MAX_NUMNODES) | |
210 | static inline void __nodes_shift_right(nodemask_t *dstp, | |
211 | const nodemask_t *srcp, int n, int nbits) | |
212 | { | |
213 | bitmap_shift_right(dstp->bits, srcp->bits, n, nbits); | |
214 | } | |
215 | ||
216 | #define nodes_shift_left(dst, src, n) \ | |
217 | __nodes_shift_left(&(dst), &(src), (n), MAX_NUMNODES) | |
218 | static inline void __nodes_shift_left(nodemask_t *dstp, | |
219 | const nodemask_t *srcp, int n, int nbits) | |
220 | { | |
221 | bitmap_shift_left(dstp->bits, srcp->bits, n, nbits); | |
222 | } | |
223 | ||
224 | /* FIXME: better would be to fix all architectures to never return | |
225 | > MAX_NUMNODES, then the silly min_ts could be dropped. */ | |
226 | ||
227 | #define first_node(src) __first_node(&(src)) | |
228 | static inline int __first_node(const nodemask_t *srcp) | |
229 | { | |
230 | return min_t(int, MAX_NUMNODES, find_first_bit(srcp->bits, MAX_NUMNODES)); | |
231 | } | |
232 | ||
233 | #define next_node(n, src) __next_node((n), &(src)) | |
234 | static inline int __next_node(int n, const nodemask_t *srcp) | |
235 | { | |
236 | return min_t(int,MAX_NUMNODES,find_next_bit(srcp->bits, MAX_NUMNODES, n+1)); | |
237 | } | |
238 | ||
239 | #define nodemask_of_node(node) \ | |
240 | ({ \ | |
241 | typeof(_unused_nodemask_arg_) m; \ | |
242 | if (sizeof(m) == sizeof(unsigned long)) { \ | |
243 | m.bits[0] = 1UL<<(node); \ | |
244 | } else { \ | |
245 | nodes_clear(m); \ | |
246 | node_set((node), m); \ | |
247 | } \ | |
248 | m; \ | |
249 | }) | |
250 | ||
251 | #define first_unset_node(mask) __first_unset_node(&(mask)) | |
252 | static inline int __first_unset_node(const nodemask_t *maskp) | |
253 | { | |
254 | return min_t(int,MAX_NUMNODES, | |
255 | find_first_zero_bit(maskp->bits, MAX_NUMNODES)); | |
256 | } | |
257 | ||
258 | #define NODE_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(MAX_NUMNODES) | |
259 | ||
260 | #if MAX_NUMNODES <= BITS_PER_LONG | |
261 | ||
262 | #define NODE_MASK_ALL \ | |
263 | ((nodemask_t) { { \ | |
264 | [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \ | |
265 | } }) | |
266 | ||
267 | #else | |
268 | ||
269 | #define NODE_MASK_ALL \ | |
270 | ((nodemask_t) { { \ | |
271 | [0 ... BITS_TO_LONGS(MAX_NUMNODES)-2] = ~0UL, \ | |
272 | [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \ | |
273 | } }) | |
274 | ||
275 | #endif | |
276 | ||
277 | #define NODE_MASK_NONE \ | |
278 | ((nodemask_t) { { \ | |
279 | [0 ... BITS_TO_LONGS(MAX_NUMNODES)-1] = 0UL \ | |
280 | } }) | |
281 | ||
282 | #define nodes_addr(src) ((src).bits) | |
283 | ||
284 | #define nodemask_scnprintf(buf, len, src) \ | |
285 | __nodemask_scnprintf((buf), (len), &(src), MAX_NUMNODES) | |
286 | static inline int __nodemask_scnprintf(char *buf, int len, | |
287 | const nodemask_t *srcp, int nbits) | |
288 | { | |
289 | return bitmap_scnprintf(buf, len, srcp->bits, nbits); | |
290 | } | |
291 | ||
292 | #define nodemask_parse(ubuf, ulen, dst) \ | |
293 | __nodemask_parse((ubuf), (ulen), &(dst), MAX_NUMNODES) | |
294 | static inline int __nodemask_parse(const char __user *buf, int len, | |
295 | nodemask_t *dstp, int nbits) | |
296 | { | |
297 | return bitmap_parse(buf, len, dstp->bits, nbits); | |
298 | } | |
299 | ||
300 | #define nodelist_scnprintf(buf, len, src) \ | |
301 | __nodelist_scnprintf((buf), (len), &(src), MAX_NUMNODES) | |
302 | static inline int __nodelist_scnprintf(char *buf, int len, | |
303 | const nodemask_t *srcp, int nbits) | |
304 | { | |
305 | return bitmap_scnlistprintf(buf, len, srcp->bits, nbits); | |
306 | } | |
307 | ||
308 | #define nodelist_parse(buf, dst) __nodelist_parse((buf), &(dst), MAX_NUMNODES) | |
309 | static inline int __nodelist_parse(const char *buf, nodemask_t *dstp, int nbits) | |
310 | { | |
311 | return bitmap_parselist(buf, dstp->bits, nbits); | |
312 | } | |
313 | ||
fb5eeeee PJ |
314 | #define node_remap(oldbit, old, new) \ |
315 | __node_remap((oldbit), &(old), &(new), MAX_NUMNODES) | |
316 | static inline int __node_remap(int oldbit, | |
317 | const nodemask_t *oldp, const nodemask_t *newp, int nbits) | |
318 | { | |
319 | return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits); | |
320 | } | |
321 | ||
322 | #define nodes_remap(dst, src, old, new) \ | |
323 | __nodes_remap(&(dst), &(src), &(old), &(new), MAX_NUMNODES) | |
324 | static inline void __nodes_remap(nodemask_t *dstp, const nodemask_t *srcp, | |
325 | const nodemask_t *oldp, const nodemask_t *newp, int nbits) | |
326 | { | |
327 | bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits); | |
328 | } | |
329 | ||
1da177e4 LT |
330 | #if MAX_NUMNODES > 1 |
331 | #define for_each_node_mask(node, mask) \ | |
332 | for ((node) = first_node(mask); \ | |
333 | (node) < MAX_NUMNODES; \ | |
334 | (node) = next_node((node), (mask))) | |
335 | #else /* MAX_NUMNODES == 1 */ | |
336 | #define for_each_node_mask(node, mask) \ | |
337 | if (!nodes_empty(mask)) \ | |
338 | for ((node) = 0; (node) < 1; (node)++) | |
339 | #endif /* MAX_NUMNODES */ | |
340 | ||
341 | /* | |
342 | * The following particular system nodemasks and operations | |
343 | * on them manage all possible and online nodes. | |
344 | */ | |
345 | ||
346 | extern nodemask_t node_online_map; | |
347 | extern nodemask_t node_possible_map; | |
348 | ||
349 | #if MAX_NUMNODES > 1 | |
350 | #define num_online_nodes() nodes_weight(node_online_map) | |
351 | #define num_possible_nodes() nodes_weight(node_possible_map) | |
352 | #define node_online(node) node_isset((node), node_online_map) | |
353 | #define node_possible(node) node_isset((node), node_possible_map) | |
354 | #else | |
355 | #define num_online_nodes() 1 | |
356 | #define num_possible_nodes() 1 | |
357 | #define node_online(node) ((node) == 0) | |
358 | #define node_possible(node) ((node) == 0) | |
359 | #endif | |
360 | ||
361 | #define any_online_node(mask) \ | |
362 | ({ \ | |
363 | int node; \ | |
364 | for_each_node_mask(node, (mask)) \ | |
365 | if (node_online(node)) \ | |
366 | break; \ | |
367 | node; \ | |
368 | }) | |
369 | ||
370 | #define node_set_online(node) set_bit((node), node_online_map.bits) | |
371 | #define node_set_offline(node) clear_bit((node), node_online_map.bits) | |
372 | ||
373 | #define for_each_node(node) for_each_node_mask((node), node_possible_map) | |
374 | #define for_each_online_node(node) for_each_node_mask((node), node_online_map) | |
375 | ||
376 | #endif /* __LINUX_NODEMASK_H */ |