1
#ifndef __LINUX_NODEMASK_H
2
#define __LINUX_NODEMASK_H
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
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_random(mask) Random node with set bit in mask
71
* int node_online(node) Is some node online?
72
* int node_possible(node) Is some node possible?
74
* node_set_online(node) set bit 'node' in node_online_map
75
* node_set_offline(node) clear bit 'node' in node_online_map
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
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.
87
* When doing above logical AND, OR, XOR, Remap operations the callers tend to
88
* need temporary nodemask_t's on the stack. But if NODES_SHIFT is large,
89
* nodemask_t's consume too much stack space. NODEMASK_SCRATCH is a helper
90
* for such situations. See below and CPUMASK_ALLOC also.
93
#include <linux/kernel.h>
94
#include <linux/threads.h>
95
#include <linux/bitmap.h>
96
#include <linux/numa.h>
98
typedef struct { DECLARE_BITMAP(bits, MAX_NUMNODES); } nodemask_t;
99
extern nodemask_t _unused_nodemask_arg_;
101
#define node_set(node, dst) __node_set((node), &(dst))
102
static inline void __node_set(int node, volatile nodemask_t *dstp)
104
set_bit(node, dstp->bits);
107
#define node_clear(node, dst) __node_clear((node), &(dst))
108
static inline void __node_clear(int node, volatile nodemask_t *dstp)
110
clear_bit(node, dstp->bits);
113
#define nodes_setall(dst) __nodes_setall(&(dst), MAX_NUMNODES)
114
static inline void __nodes_setall(nodemask_t *dstp, int nbits)
116
bitmap_fill(dstp->bits, nbits);
119
#define nodes_clear(dst) __nodes_clear(&(dst), MAX_NUMNODES)
120
static inline void __nodes_clear(nodemask_t *dstp, int nbits)
122
bitmap_zero(dstp->bits, nbits);
125
/* No static inline type checking - see Subtlety (1) above. */
126
#define node_isset(node, nodemask) test_bit((node), (nodemask).bits)
128
#define node_test_and_set(node, nodemask) \
129
__node_test_and_set((node), &(nodemask))
130
static inline int __node_test_and_set(int node, nodemask_t *addr)
132
return test_and_set_bit(node, addr->bits);
135
#define nodes_and(dst, src1, src2) \
136
__nodes_and(&(dst), &(src1), &(src2), MAX_NUMNODES)
137
static inline void __nodes_and(nodemask_t *dstp, const nodemask_t *src1p,
138
const nodemask_t *src2p, int nbits)
140
bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits);
143
#define nodes_or(dst, src1, src2) \
144
__nodes_or(&(dst), &(src1), &(src2), MAX_NUMNODES)
145
static inline void __nodes_or(nodemask_t *dstp, const nodemask_t *src1p,
146
const nodemask_t *src2p, int nbits)
148
bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits);
151
#define nodes_xor(dst, src1, src2) \
152
__nodes_xor(&(dst), &(src1), &(src2), MAX_NUMNODES)
153
static inline void __nodes_xor(nodemask_t *dstp, const nodemask_t *src1p,
154
const nodemask_t *src2p, int nbits)
156
bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits);
159
#define nodes_andnot(dst, src1, src2) \
160
__nodes_andnot(&(dst), &(src1), &(src2), MAX_NUMNODES)
161
static inline void __nodes_andnot(nodemask_t *dstp, const nodemask_t *src1p,
162
const nodemask_t *src2p, int nbits)
164
bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits);
167
#define nodes_complement(dst, src) \
168
__nodes_complement(&(dst), &(src), MAX_NUMNODES)
169
static inline void __nodes_complement(nodemask_t *dstp,
170
const nodemask_t *srcp, int nbits)
172
bitmap_complement(dstp->bits, srcp->bits, nbits);
175
#define nodes_equal(src1, src2) \
176
__nodes_equal(&(src1), &(src2), MAX_NUMNODES)
177
static inline int __nodes_equal(const nodemask_t *src1p,
178
const nodemask_t *src2p, int nbits)
180
return bitmap_equal(src1p->bits, src2p->bits, nbits);
183
#define nodes_intersects(src1, src2) \
184
__nodes_intersects(&(src1), &(src2), MAX_NUMNODES)
185
static inline int __nodes_intersects(const nodemask_t *src1p,
186
const nodemask_t *src2p, int nbits)
188
return bitmap_intersects(src1p->bits, src2p->bits, nbits);
191
#define nodes_subset(src1, src2) \
192
__nodes_subset(&(src1), &(src2), MAX_NUMNODES)
193
static inline int __nodes_subset(const nodemask_t *src1p,
194
const nodemask_t *src2p, int nbits)
196
return bitmap_subset(src1p->bits, src2p->bits, nbits);
199
#define nodes_empty(src) __nodes_empty(&(src), MAX_NUMNODES)
200
static inline int __nodes_empty(const nodemask_t *srcp, int nbits)
202
return bitmap_empty(srcp->bits, nbits);
205
#define nodes_full(nodemask) __nodes_full(&(nodemask), MAX_NUMNODES)
206
static inline int __nodes_full(const nodemask_t *srcp, int nbits)
208
return bitmap_full(srcp->bits, nbits);
211
#define nodes_weight(nodemask) __nodes_weight(&(nodemask), MAX_NUMNODES)
212
static inline int __nodes_weight(const nodemask_t *srcp, int nbits)
214
return bitmap_weight(srcp->bits, nbits);
217
#define nodes_shift_right(dst, src, n) \
218
__nodes_shift_right(&(dst), &(src), (n), MAX_NUMNODES)
219
static inline void __nodes_shift_right(nodemask_t *dstp,
220
const nodemask_t *srcp, int n, int nbits)
222
bitmap_shift_right(dstp->bits, srcp->bits, n, nbits);
225
#define nodes_shift_left(dst, src, n) \
226
__nodes_shift_left(&(dst), &(src), (n), MAX_NUMNODES)
227
static inline void __nodes_shift_left(nodemask_t *dstp,
228
const nodemask_t *srcp, int n, int nbits)
230
bitmap_shift_left(dstp->bits, srcp->bits, n, nbits);
233
/* FIXME: better would be to fix all architectures to never return
234
> MAX_NUMNODES, then the silly min_ts could be dropped. */
236
#define first_node(src) __first_node(&(src))
237
static inline int __first_node(const nodemask_t *srcp)
239
return min_t(int, MAX_NUMNODES, find_first_bit(srcp->bits, MAX_NUMNODES));
242
#define next_node(n, src) __next_node((n), &(src))
243
static inline int __next_node(int n, const nodemask_t *srcp)
245
return min_t(int,MAX_NUMNODES,find_next_bit(srcp->bits, MAX_NUMNODES, n+1));
248
static inline void init_nodemask_of_node(nodemask_t *mask, int node)
251
node_set(node, *mask);
254
#define nodemask_of_node(node) \
256
typeof(_unused_nodemask_arg_) m; \
257
if (sizeof(m) == sizeof(unsigned long)) { \
258
m.bits[0] = 1UL << (node); \
260
init_nodemask_of_node(&m, (node)); \
265
#define first_unset_node(mask) __first_unset_node(&(mask))
266
static inline int __first_unset_node(const nodemask_t *maskp)
268
return min_t(int,MAX_NUMNODES,
269
find_first_zero_bit(maskp->bits, MAX_NUMNODES));
272
#define NODE_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(MAX_NUMNODES)
274
#if MAX_NUMNODES <= BITS_PER_LONG
276
#define NODE_MASK_ALL \
278
[BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \
283
#define NODE_MASK_ALL \
285
[0 ... BITS_TO_LONGS(MAX_NUMNODES)-2] = ~0UL, \
286
[BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD \
291
#define NODE_MASK_NONE \
293
[0 ... BITS_TO_LONGS(MAX_NUMNODES)-1] = 0UL \
296
#define nodes_addr(src) ((src).bits)
298
#define nodemask_scnprintf(buf, len, src) \
299
__nodemask_scnprintf((buf), (len), &(src), MAX_NUMNODES)
300
static inline int __nodemask_scnprintf(char *buf, int len,
301
const nodemask_t *srcp, int nbits)
303
return bitmap_scnprintf(buf, len, srcp->bits, nbits);
306
#define nodemask_parse_user(ubuf, ulen, dst) \
307
__nodemask_parse_user((ubuf), (ulen), &(dst), MAX_NUMNODES)
308
static inline int __nodemask_parse_user(const char __user *buf, int len,
309
nodemask_t *dstp, int nbits)
311
return bitmap_parse_user(buf, len, dstp->bits, nbits);
314
#define nodelist_scnprintf(buf, len, src) \
315
__nodelist_scnprintf((buf), (len), &(src), MAX_NUMNODES)
316
static inline int __nodelist_scnprintf(char *buf, int len,
317
const nodemask_t *srcp, int nbits)
319
return bitmap_scnlistprintf(buf, len, srcp->bits, nbits);
322
#define nodelist_parse(buf, dst) __nodelist_parse((buf), &(dst), MAX_NUMNODES)
323
static inline int __nodelist_parse(const char *buf, nodemask_t *dstp, int nbits)
325
return bitmap_parselist(buf, dstp->bits, nbits);
328
#define node_remap(oldbit, old, new) \
329
__node_remap((oldbit), &(old), &(new), MAX_NUMNODES)
330
static inline int __node_remap(int oldbit,
331
const nodemask_t *oldp, const nodemask_t *newp, int nbits)
333
return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits);
336
#define nodes_remap(dst, src, old, new) \
337
__nodes_remap(&(dst), &(src), &(old), &(new), MAX_NUMNODES)
338
static inline void __nodes_remap(nodemask_t *dstp, const nodemask_t *srcp,
339
const nodemask_t *oldp, const nodemask_t *newp, int nbits)
341
bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits);
344
#define nodes_onto(dst, orig, relmap) \
345
__nodes_onto(&(dst), &(orig), &(relmap), MAX_NUMNODES)
346
static inline void __nodes_onto(nodemask_t *dstp, const nodemask_t *origp,
347
const nodemask_t *relmapp, int nbits)
349
bitmap_onto(dstp->bits, origp->bits, relmapp->bits, nbits);
352
#define nodes_fold(dst, orig, sz) \
353
__nodes_fold(&(dst), &(orig), sz, MAX_NUMNODES)
354
static inline void __nodes_fold(nodemask_t *dstp, const nodemask_t *origp,
357
bitmap_fold(dstp->bits, origp->bits, sz, nbits);
361
#define for_each_node_mask(node, mask) \
362
for ((node) = first_node(mask); \
363
(node) < MAX_NUMNODES; \
364
(node) = next_node((node), (mask)))
365
#else /* MAX_NUMNODES == 1 */
366
#define for_each_node_mask(node, mask) \
367
if (!nodes_empty(mask)) \
368
for ((node) = 0; (node) < 1; (node)++)
369
#endif /* MAX_NUMNODES */
372
* Bitmasks that are kept for all the nodes.
375
N_POSSIBLE, /* The node could become online at some point */
376
N_ONLINE, /* The node is online */
377
N_NORMAL_MEMORY, /* The node has regular memory */
378
#ifdef CONFIG_HIGHMEM
379
N_HIGH_MEMORY, /* The node has regular or high memory */
381
N_HIGH_MEMORY = N_NORMAL_MEMORY,
383
N_CPU, /* The node has one or more cpus */
388
* The following particular system nodemasks and operations
389
* on them manage all possible and online nodes.
392
extern nodemask_t node_states[NR_NODE_STATES];
395
static inline int node_state(int node, enum node_states state)
397
return node_isset(node, node_states[state]);
400
static inline void node_set_state(int node, enum node_states state)
402
__node_set(node, &node_states[state]);
405
static inline void node_clear_state(int node, enum node_states state)
407
__node_clear(node, &node_states[state]);
410
static inline int num_node_state(enum node_states state)
412
return nodes_weight(node_states[state]);
415
#define for_each_node_state(__node, __state) \
416
for_each_node_mask((__node), node_states[__state])
418
#define first_online_node first_node(node_states[N_ONLINE])
419
#define next_online_node(nid) next_node((nid), node_states[N_ONLINE])
421
extern int nr_node_ids;
422
extern int nr_online_nodes;
424
static inline void node_set_online(int nid)
426
node_set_state(nid, N_ONLINE);
427
nr_online_nodes = num_node_state(N_ONLINE);
430
static inline void node_set_offline(int nid)
432
node_clear_state(nid, N_ONLINE);
433
nr_online_nodes = num_node_state(N_ONLINE);
438
static inline int node_state(int node, enum node_states state)
443
static inline void node_set_state(int node, enum node_states state)
447
static inline void node_clear_state(int node, enum node_states state)
451
static inline int num_node_state(enum node_states state)
456
#define for_each_node_state(node, __state) \
457
for ( (node) = 0; (node) == 0; (node) = 1)
459
#define first_online_node 0
460
#define next_online_node(nid) (MAX_NUMNODES)
461
#define nr_node_ids 1
462
#define nr_online_nodes 1
464
#define node_set_online(node) node_set_state((node), N_ONLINE)
465
#define node_set_offline(node) node_clear_state((node), N_ONLINE)
469
#if defined(CONFIG_NUMA) && (MAX_NUMNODES > 1)
470
extern int node_random(const nodemask_t *maskp);
472
static inline int node_random(const nodemask_t *mask)
478
#define node_online_map node_states[N_ONLINE]
479
#define node_possible_map node_states[N_POSSIBLE]
481
#define num_online_nodes() num_node_state(N_ONLINE)
482
#define num_possible_nodes() num_node_state(N_POSSIBLE)
483
#define node_online(node) node_state((node), N_ONLINE)
484
#define node_possible(node) node_state((node), N_POSSIBLE)
486
#define for_each_node(node) for_each_node_state(node, N_POSSIBLE)
487
#define for_each_online_node(node) for_each_node_state(node, N_ONLINE)
490
* For nodemask scrach area.
491
* NODEMASK_ALLOC(type, name) allocates an object with a specified type and
494
#if NODES_SHIFT > 8 /* nodemask_t > 256 bytes */
495
#define NODEMASK_ALLOC(type, name, gfp_flags) \
496
type *name = kmalloc(sizeof(*name), gfp_flags)
497
#define NODEMASK_FREE(m) kfree(m)
499
#define NODEMASK_ALLOC(type, name, gfp_flags) type _##name, *name = &_##name
500
#define NODEMASK_FREE(m) do {} while (0)
503
/* A example struture for using NODEMASK_ALLOC, used in mempolicy. */
504
struct nodemask_scratch {
509
#define NODEMASK_SCRATCH(x) \
510
NODEMASK_ALLOC(struct nodemask_scratch, x, \
511
GFP_KERNEL | __GFP_NORETRY)
512
#define NODEMASK_SCRATCH_FREE(x) NODEMASK_FREE(x)
515
#endif /* __LINUX_NODEMASK_H */