ASoC: Fix section mismatch in wm8995.c
[linux-2.6/next.git] / include / linux / nodemask.h
blobdba35e413371e599045d41134003a1ef8713fd38
1 #ifndef __LINUX_NODEMASK_H
2 #define __LINUX_NODEMASK_H
4 /*
5 * Nodemasks provide a bitmap suitable for representing the
6 * set of Node's in a system, one bit position per Node number.
8 * See detailed comments in the file linux/bitmap.h describing the
9 * data type on which these nodemasks are based.
11 * For details of nodemask_scnprintf() and nodemask_parse_user(),
12 * see bitmap_scnprintf() and bitmap_parse_user() in lib/bitmap.c.
13 * For details of nodelist_scnprintf() and nodelist_parse(), see
14 * bitmap_scnlistprintf() and bitmap_parselist(), also in bitmap.c.
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.
17 * 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.
20 * The available nodemask operations are:
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
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
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
42 * void nodes_shift_right(dst, src, n) Shift right
43 * void nodes_shift_left(dst, src, n) Shift left
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.
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
55 * int nodemask_scnprintf(buf, len, mask) Format nodemask for printing
56 * int nodemask_parse_user(ubuf, ulen, mask) Parse ascii string as nodemask
57 * int nodelist_scnprintf(buf, len, mask) Format nodemask as list for printing
58 * int nodelist_parse(buf, map) Parse ascii string as nodelist
59 * int node_remap(oldbit, old, new) newbit = map(old, new)(oldbit)
60 * 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
64 * for_each_node_mask(node, mask) for-loop node over mask
66 * int num_online_nodes() Number of online Nodes
67 * int num_possible_nodes() Number of all possible Nodes
69 * int node_online(node) Is some node online?
70 * int node_possible(node) Is some node possible?
72 * node_set_online(node) set bit 'node' in node_online_map
73 * node_set_offline(node) clear bit 'node' in node_online_map
75 * for_each_node(node) for-loop node over node_possible_map
76 * for_each_online_node(node) for-loop node over node_online_map
78 * Subtlety:
79 * 1) The 'type-checked' form of node_isset() causes gcc (3.3.2, anyway)
80 * to generate slightly worse code. So use a simple one-line #define
81 * for node_isset(), instead of wrapping an inline inside a macro, the
82 * way we do the other calls.
84 * NODEMASK_SCRATCH
85 * When doing above logical AND, OR, XOR, Remap operations the callers tend to
86 * need temporary nodemask_t's on the stack. But if NODES_SHIFT is large,
87 * nodemask_t's consume too much stack space. NODEMASK_SCRATCH is a helper
88 * for such situations. See below and CPUMASK_ALLOC also.
91 #include <linux/kernel.h>
92 #include <linux/threads.h>
93 #include <linux/bitmap.h>
94 #include <linux/numa.h>
96 typedef struct { DECLARE_BITMAP(bits, MAX_NUMNODES); } nodemask_t;
97 extern nodemask_t _unused_nodemask_arg_;
99 #define node_set(node, dst) __node_set((node), &(dst))
100 static inline void __node_set(int node, volatile nodemask_t *dstp)
102 set_bit(node, dstp->bits);
105 #define node_clear(node, dst) __node_clear((node), &(dst))
106 static inline void __node_clear(int node, volatile nodemask_t *dstp)
108 clear_bit(node, dstp->bits);
111 #define nodes_setall(dst) __nodes_setall(&(dst), MAX_NUMNODES)
112 static inline void __nodes_setall(nodemask_t *dstp, int nbits)
114 bitmap_fill(dstp->bits, nbits);
117 #define nodes_clear(dst) __nodes_clear(&(dst), MAX_NUMNODES)
118 static inline void __nodes_clear(nodemask_t *dstp, int nbits)
120 bitmap_zero(dstp->bits, nbits);
123 /* No static inline type checking - see Subtlety (1) above. */
124 #define node_isset(node, nodemask) test_bit((node), (nodemask).bits)
126 #define node_test_and_set(node, nodemask) \
127 __node_test_and_set((node), &(nodemask))
128 static inline int __node_test_and_set(int node, nodemask_t *addr)
130 return test_and_set_bit(node, addr->bits);
133 #define nodes_and(dst, src1, src2) \
134 __nodes_and(&(dst), &(src1), &(src2), MAX_NUMNODES)
135 static inline void __nodes_and(nodemask_t *dstp, const nodemask_t *src1p,
136 const nodemask_t *src2p, int nbits)
138 bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits);
141 #define nodes_or(dst, src1, src2) \
142 __nodes_or(&(dst), &(src1), &(src2), MAX_NUMNODES)
143 static inline void __nodes_or(nodemask_t *dstp, const nodemask_t *src1p,
144 const nodemask_t *src2p, int nbits)
146 bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits);
149 #define nodes_xor(dst, src1, src2) \
150 __nodes_xor(&(dst), &(src1), &(src2), MAX_NUMNODES)
151 static inline void __nodes_xor(nodemask_t *dstp, const nodemask_t *src1p,
152 const nodemask_t *src2p, int nbits)
154 bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits);
157 #define nodes_andnot(dst, src1, src2) \
158 __nodes_andnot(&(dst), &(src1), &(src2), MAX_NUMNODES)
159 static inline void __nodes_andnot(nodemask_t *dstp, const nodemask_t *src1p,
160 const nodemask_t *src2p, int nbits)
162 bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits);
165 #define nodes_complement(dst, src) \
166 __nodes_complement(&(dst), &(src), MAX_NUMNODES)
167 static inline void __nodes_complement(nodemask_t *dstp,
168 const nodemask_t *srcp, int nbits)
170 bitmap_complement(dstp->bits, srcp->bits, nbits);
173 #define nodes_equal(src1, src2) \
174 __nodes_equal(&(src1), &(src2), MAX_NUMNODES)
175 static inline int __nodes_equal(const nodemask_t *src1p,
176 const nodemask_t *src2p, int nbits)
178 return bitmap_equal(src1p->bits, src2p->bits, nbits);
181 #define nodes_intersects(src1, src2) \
182 __nodes_intersects(&(src1), &(src2), MAX_NUMNODES)
183 static inline int __nodes_intersects(const nodemask_t *src1p,
184 const nodemask_t *src2p, int nbits)
186 return bitmap_intersects(src1p->bits, src2p->bits, nbits);
189 #define nodes_subset(src1, src2) \
190 __nodes_subset(&(src1), &(src2), MAX_NUMNODES)
191 static inline int __nodes_subset(const nodemask_t *src1p,
192 const nodemask_t *src2p, int nbits)
194 return bitmap_subset(src1p->bits, src2p->bits, nbits);
197 #define nodes_empty(src) __nodes_empty(&(src), MAX_NUMNODES)
198 static inline int __nodes_empty(const nodemask_t *srcp, int nbits)
200 return bitmap_empty(srcp->bits, nbits);
203 #define nodes_full(nodemask) __nodes_full(&(nodemask), MAX_NUMNODES)
204 static inline int __nodes_full(const nodemask_t *srcp, int nbits)
206 return bitmap_full(srcp->bits, nbits);
209 #define nodes_weight(nodemask) __nodes_weight(&(nodemask), MAX_NUMNODES)
210 static inline int __nodes_weight(const nodemask_t *srcp, int nbits)
212 return bitmap_weight(srcp->bits, nbits);
215 #define nodes_shift_right(dst, src, n) \
216 __nodes_shift_right(&(dst), &(src), (n), MAX_NUMNODES)
217 static inline void __nodes_shift_right(nodemask_t *dstp,
218 const nodemask_t *srcp, int n, int nbits)
220 bitmap_shift_right(dstp->bits, srcp->bits, n, nbits);
223 #define nodes_shift_left(dst, src, n) \
224 __nodes_shift_left(&(dst), &(src), (n), MAX_NUMNODES)
225 static inline void __nodes_shift_left(nodemask_t *dstp,
226 const nodemask_t *srcp, int n, int nbits)
228 bitmap_shift_left(dstp->bits, srcp->bits, n, nbits);
231 /* FIXME: better would be to fix all architectures to never return
232 > MAX_NUMNODES, then the silly min_ts could be dropped. */
234 #define first_node(src) __first_node(&(src))
235 static inline int __first_node(const nodemask_t *srcp)
237 return min_t(int, MAX_NUMNODES, find_first_bit(srcp->bits, MAX_NUMNODES));
240 #define next_node(n, src) __next_node((n), &(src))
241 static inline int __next_node(int n, const nodemask_t *srcp)
243 return min_t(int,MAX_NUMNODES,find_next_bit(srcp->bits, MAX_NUMNODES, n+1));
246 static inline void init_nodemask_of_node(nodemask_t *mask, int node)
248 nodes_clear(*mask);
249 node_set(node, *mask);
252 #define nodemask_of_node(node) \
253 ({ \
254 typeof(_unused_nodemask_arg_) m; \
255 if (sizeof(m) == sizeof(unsigned long)) { \
256 m.bits[0] = 1UL << (node); \
257 } else { \
258 init_nodemask_of_node(&m, (node)); \
260 m; \
263 #define first_unset_node(mask) __first_unset_node(&(mask))
264 static inline int __first_unset_node(const nodemask_t *maskp)
266 return min_t(int,MAX_NUMNODES,
267 find_first_zero_bit(maskp->bits, MAX_NUMNODES));
270 #define NODE_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(MAX_NUMNODES)
272 #if MAX_NUMNODES <= BITS_PER_LONG
274 #define NODE_MASK_ALL \
275 ((nodemask_t) { { \
276 [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \
277 } })
279 #else
281 #define NODE_MASK_ALL \
282 ((nodemask_t) { { \
283 [0 ... BITS_TO_LONGS(MAX_NUMNODES)-2] = ~0UL, \
284 [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \
285 } })
287 #endif
289 #define NODE_MASK_NONE \
290 ((nodemask_t) { { \
291 [0 ... BITS_TO_LONGS(MAX_NUMNODES)-1] = 0UL \
292 } })
294 #define nodes_addr(src) ((src).bits)
296 #define nodemask_scnprintf(buf, len, src) \
297 __nodemask_scnprintf((buf), (len), &(src), MAX_NUMNODES)
298 static inline int __nodemask_scnprintf(char *buf, int len,
299 const nodemask_t *srcp, int nbits)
301 return bitmap_scnprintf(buf, len, srcp->bits, nbits);
304 #define nodemask_parse_user(ubuf, ulen, dst) \
305 __nodemask_parse_user((ubuf), (ulen), &(dst), MAX_NUMNODES)
306 static inline int __nodemask_parse_user(const char __user *buf, int len,
307 nodemask_t *dstp, int nbits)
309 return bitmap_parse_user(buf, len, dstp->bits, nbits);
312 #define nodelist_scnprintf(buf, len, src) \
313 __nodelist_scnprintf((buf), (len), &(src), MAX_NUMNODES)
314 static inline int __nodelist_scnprintf(char *buf, int len,
315 const nodemask_t *srcp, int nbits)
317 return bitmap_scnlistprintf(buf, len, srcp->bits, nbits);
320 #define nodelist_parse(buf, dst) __nodelist_parse((buf), &(dst), MAX_NUMNODES)
321 static inline int __nodelist_parse(const char *buf, nodemask_t *dstp, int nbits)
323 return bitmap_parselist(buf, dstp->bits, nbits);
326 #define node_remap(oldbit, old, new) \
327 __node_remap((oldbit), &(old), &(new), MAX_NUMNODES)
328 static inline int __node_remap(int oldbit,
329 const nodemask_t *oldp, const nodemask_t *newp, int nbits)
331 return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits);
334 #define nodes_remap(dst, src, old, new) \
335 __nodes_remap(&(dst), &(src), &(old), &(new), MAX_NUMNODES)
336 static inline void __nodes_remap(nodemask_t *dstp, const nodemask_t *srcp,
337 const nodemask_t *oldp, const nodemask_t *newp, int nbits)
339 bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits);
342 #define nodes_onto(dst, orig, relmap) \
343 __nodes_onto(&(dst), &(orig), &(relmap), MAX_NUMNODES)
344 static inline void __nodes_onto(nodemask_t *dstp, const nodemask_t *origp,
345 const nodemask_t *relmapp, int nbits)
347 bitmap_onto(dstp->bits, origp->bits, relmapp->bits, nbits);
350 #define nodes_fold(dst, orig, sz) \
351 __nodes_fold(&(dst), &(orig), sz, MAX_NUMNODES)
352 static inline void __nodes_fold(nodemask_t *dstp, const nodemask_t *origp,
353 int sz, int nbits)
355 bitmap_fold(dstp->bits, origp->bits, sz, nbits);
358 #if MAX_NUMNODES > 1
359 #define for_each_node_mask(node, mask) \
360 for ((node) = first_node(mask); \
361 (node) < MAX_NUMNODES; \
362 (node) = next_node((node), (mask)))
363 #else /* MAX_NUMNODES == 1 */
364 #define for_each_node_mask(node, mask) \
365 if (!nodes_empty(mask)) \
366 for ((node) = 0; (node) < 1; (node)++)
367 #endif /* MAX_NUMNODES */
370 * Bitmasks that are kept for all the nodes.
372 enum node_states {
373 N_POSSIBLE, /* The node could become online at some point */
374 N_ONLINE, /* The node is online */
375 N_NORMAL_MEMORY, /* The node has regular memory */
376 #ifdef CONFIG_HIGHMEM
377 N_HIGH_MEMORY, /* The node has regular or high memory */
378 #else
379 N_HIGH_MEMORY = N_NORMAL_MEMORY,
380 #endif
381 N_CPU, /* The node has one or more cpus */
382 NR_NODE_STATES
386 * The following particular system nodemasks and operations
387 * on them manage all possible and online nodes.
390 extern nodemask_t node_states[NR_NODE_STATES];
392 #if MAX_NUMNODES > 1
393 static inline int node_state(int node, enum node_states state)
395 return node_isset(node, node_states[state]);
398 static inline void node_set_state(int node, enum node_states state)
400 __node_set(node, &node_states[state]);
403 static inline void node_clear_state(int node, enum node_states state)
405 __node_clear(node, &node_states[state]);
408 static inline int num_node_state(enum node_states state)
410 return nodes_weight(node_states[state]);
413 #define for_each_node_state(__node, __state) \
414 for_each_node_mask((__node), node_states[__state])
416 #define first_online_node first_node(node_states[N_ONLINE])
417 #define next_online_node(nid) next_node((nid), node_states[N_ONLINE])
419 extern int nr_node_ids;
420 extern int nr_online_nodes;
422 static inline void node_set_online(int nid)
424 node_set_state(nid, N_ONLINE);
425 nr_online_nodes = num_node_state(N_ONLINE);
428 static inline void node_set_offline(int nid)
430 node_clear_state(nid, N_ONLINE);
431 nr_online_nodes = num_node_state(N_ONLINE);
433 #else
435 static inline int node_state(int node, enum node_states state)
437 return node == 0;
440 static inline void node_set_state(int node, enum node_states state)
444 static inline void node_clear_state(int node, enum node_states state)
448 static inline int num_node_state(enum node_states state)
450 return 1;
453 #define for_each_node_state(node, __state) \
454 for ( (node) = 0; (node) == 0; (node) = 1)
456 #define first_online_node 0
457 #define next_online_node(nid) (MAX_NUMNODES)
458 #define nr_node_ids 1
459 #define nr_online_nodes 1
461 #define node_set_online(node) node_set_state((node), N_ONLINE)
462 #define node_set_offline(node) node_clear_state((node), N_ONLINE)
463 #endif
465 #define node_online_map node_states[N_ONLINE]
466 #define node_possible_map node_states[N_POSSIBLE]
468 #define num_online_nodes() num_node_state(N_ONLINE)
469 #define num_possible_nodes() num_node_state(N_POSSIBLE)
470 #define node_online(node) node_state((node), N_ONLINE)
471 #define node_possible(node) node_state((node), N_POSSIBLE)
473 #define for_each_node(node) for_each_node_state(node, N_POSSIBLE)
474 #define for_each_online_node(node) for_each_node_state(node, N_ONLINE)
477 * For nodemask scrach area.
478 * NODEMASK_ALLOC(type, name) allocates an object with a specified type and
479 * name.
481 #if NODES_SHIFT > 8 /* nodemask_t > 256 bytes */
482 #define NODEMASK_ALLOC(type, name, gfp_flags) \
483 type *name = kmalloc(sizeof(*name), gfp_flags)
484 #define NODEMASK_FREE(m) kfree(m)
485 #else
486 #define NODEMASK_ALLOC(type, name, gfp_flags) type _##name, *name = &_##name
487 #define NODEMASK_FREE(m) do {} while (0)
488 #endif
490 /* A example struture for using NODEMASK_ALLOC, used in mempolicy. */
491 struct nodemask_scratch {
492 nodemask_t mask1;
493 nodemask_t mask2;
496 #define NODEMASK_SCRATCH(x) \
497 NODEMASK_ALLOC(struct nodemask_scratch, x, \
498 GFP_KERNEL | __GFP_NORETRY)
499 #define NODEMASK_SCRATCH_FREE(x) NODEMASK_FREE(x)
502 #endif /* __LINUX_NODEMASK_H */