mm: simplify nodemask printing
[sfrench/cifs-2.6.git] / include / linux / nodemask.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_NODEMASK_H
3 #define __LINUX_NODEMASK_H
4
5 /*
6  * Nodemasks provide a bitmap suitable for representing the
7  * set of Node's in a system, one bit position per Node number.
8  *
9  * See detailed comments in the file linux/bitmap.h describing the
10  * data type on which these nodemasks are based.
11  *
12  * For details of nodemask_parse_user(), see bitmap_parse_user() in
13  * lib/bitmap.c.  For details of nodelist_parse(), see bitmap_parselist(),
14  * also in bitmap.c.  For details of node_remap(), see bitmap_bitremap in
15  * lib/bitmap.c.  For details of nodes_remap(), see bitmap_remap in
16  * lib/bitmap.c.  For details of nodes_onto(), see bitmap_onto in
17  * lib/bitmap.c.  For details of nodes_fold(), see bitmap_fold in
18  * lib/bitmap.c.
19  *
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 next_node_in(node, mask)         Next node past 'node', or wrap to first,
48  *                                      or MAX_NUMNODES
49  * int first_unset_node(mask)           First node not set in mask, or 
50  *                                      MAX_NUMNODES
51  *
52  * nodemask_t nodemask_of_node(node)    Return nodemask with bit 'node' set
53  * NODE_MASK_ALL                        Initializer - all bits set
54  * NODE_MASK_NONE                       Initializer - no bits set
55  * unsigned long *nodes_addr(mask)      Array of unsigned long's in mask
56  *
57  * int nodemask_parse_user(ubuf, ulen, mask)    Parse ascii string as nodemask
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
63  *
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_random(mask)                Random node with set bit in mask
70  *
71  * int node_online(node)                Is some node online?
72  * int node_possible(node)              Is some node possible?
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  * NODEMASK_SCRATCH
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.
91  */
92
93 #include <linux/kernel.h>
94 #include <linux/threads.h>
95 #include <linux/bitmap.h>
96 #include <linux/numa.h>
97
98 typedef struct { DECLARE_BITMAP(bits, MAX_NUMNODES); } nodemask_t;
99 extern nodemask_t _unused_nodemask_arg_;
100
101 /**
102  * nodemask_pr_args - printf args to output a nodemask
103  * @maskp: nodemask to be printed
104  *
105  * Can be used to provide arguments for '%*pb[l]' when printing a nodemask.
106  */
107 #define nodemask_pr_args(maskp)                         \
108         ((maskp) != NULL) ? MAX_NUMNODES : 0,           \
109         ((maskp) != NULL) ? (maskp)->bits : NULL
110
111 /*
112  * The inline keyword gives the compiler room to decide to inline, or
113  * not inline a function as it sees best.  However, as these functions
114  * are called in both __init and non-__init functions, if they are not
115  * inlined we will end up with a section mis-match error (of the type of
116  * freeable items not being freed).  So we must use __always_inline here
117  * to fix the problem.  If other functions in the future also end up in
118  * this situation they will also need to be annotated as __always_inline
119  */
120 #define node_set(node, dst) __node_set((node), &(dst))
121 static __always_inline void __node_set(int node, volatile nodemask_t *dstp)
122 {
123         set_bit(node, dstp->bits);
124 }
125
126 #define node_clear(node, dst) __node_clear((node), &(dst))
127 static inline void __node_clear(int node, volatile nodemask_t *dstp)
128 {
129         clear_bit(node, dstp->bits);
130 }
131
132 #define nodes_setall(dst) __nodes_setall(&(dst), MAX_NUMNODES)
133 static inline void __nodes_setall(nodemask_t *dstp, unsigned int nbits)
134 {
135         bitmap_fill(dstp->bits, nbits);
136 }
137
138 #define nodes_clear(dst) __nodes_clear(&(dst), MAX_NUMNODES)
139 static inline void __nodes_clear(nodemask_t *dstp, unsigned int nbits)
140 {
141         bitmap_zero(dstp->bits, nbits);
142 }
143
144 /* No static inline type checking - see Subtlety (1) above. */
145 #define node_isset(node, nodemask) test_bit((node), (nodemask).bits)
146
147 #define node_test_and_set(node, nodemask) \
148                         __node_test_and_set((node), &(nodemask))
149 static inline int __node_test_and_set(int node, nodemask_t *addr)
150 {
151         return test_and_set_bit(node, addr->bits);
152 }
153
154 #define nodes_and(dst, src1, src2) \
155                         __nodes_and(&(dst), &(src1), &(src2), MAX_NUMNODES)
156 static inline void __nodes_and(nodemask_t *dstp, const nodemask_t *src1p,
157                                         const nodemask_t *src2p, unsigned int nbits)
158 {
159         bitmap_and(dstp->bits, src1p->bits, src2p->bits, nbits);
160 }
161
162 #define nodes_or(dst, src1, src2) \
163                         __nodes_or(&(dst), &(src1), &(src2), MAX_NUMNODES)
164 static inline void __nodes_or(nodemask_t *dstp, const nodemask_t *src1p,
165                                         const nodemask_t *src2p, unsigned int nbits)
166 {
167         bitmap_or(dstp->bits, src1p->bits, src2p->bits, nbits);
168 }
169
170 #define nodes_xor(dst, src1, src2) \
171                         __nodes_xor(&(dst), &(src1), &(src2), MAX_NUMNODES)
172 static inline void __nodes_xor(nodemask_t *dstp, const nodemask_t *src1p,
173                                         const nodemask_t *src2p, unsigned int nbits)
174 {
175         bitmap_xor(dstp->bits, src1p->bits, src2p->bits, nbits);
176 }
177
178 #define nodes_andnot(dst, src1, src2) \
179                         __nodes_andnot(&(dst), &(src1), &(src2), MAX_NUMNODES)
180 static inline void __nodes_andnot(nodemask_t *dstp, const nodemask_t *src1p,
181                                         const nodemask_t *src2p, unsigned int nbits)
182 {
183         bitmap_andnot(dstp->bits, src1p->bits, src2p->bits, nbits);
184 }
185
186 #define nodes_complement(dst, src) \
187                         __nodes_complement(&(dst), &(src), MAX_NUMNODES)
188 static inline void __nodes_complement(nodemask_t *dstp,
189                                         const nodemask_t *srcp, unsigned int nbits)
190 {
191         bitmap_complement(dstp->bits, srcp->bits, nbits);
192 }
193
194 #define nodes_equal(src1, src2) \
195                         __nodes_equal(&(src1), &(src2), MAX_NUMNODES)
196 static inline int __nodes_equal(const nodemask_t *src1p,
197                                         const nodemask_t *src2p, unsigned int nbits)
198 {
199         return bitmap_equal(src1p->bits, src2p->bits, nbits);
200 }
201
202 #define nodes_intersects(src1, src2) \
203                         __nodes_intersects(&(src1), &(src2), MAX_NUMNODES)
204 static inline int __nodes_intersects(const nodemask_t *src1p,
205                                         const nodemask_t *src2p, unsigned int nbits)
206 {
207         return bitmap_intersects(src1p->bits, src2p->bits, nbits);
208 }
209
210 #define nodes_subset(src1, src2) \
211                         __nodes_subset(&(src1), &(src2), MAX_NUMNODES)
212 static inline int __nodes_subset(const nodemask_t *src1p,
213                                         const nodemask_t *src2p, unsigned int nbits)
214 {
215         return bitmap_subset(src1p->bits, src2p->bits, nbits);
216 }
217
218 #define nodes_empty(src) __nodes_empty(&(src), MAX_NUMNODES)
219 static inline int __nodes_empty(const nodemask_t *srcp, unsigned int nbits)
220 {
221         return bitmap_empty(srcp->bits, nbits);
222 }
223
224 #define nodes_full(nodemask) __nodes_full(&(nodemask), MAX_NUMNODES)
225 static inline int __nodes_full(const nodemask_t *srcp, unsigned int nbits)
226 {
227         return bitmap_full(srcp->bits, nbits);
228 }
229
230 #define nodes_weight(nodemask) __nodes_weight(&(nodemask), MAX_NUMNODES)
231 static inline int __nodes_weight(const nodemask_t *srcp, unsigned int nbits)
232 {
233         return bitmap_weight(srcp->bits, nbits);
234 }
235
236 #define nodes_shift_right(dst, src, n) \
237                         __nodes_shift_right(&(dst), &(src), (n), MAX_NUMNODES)
238 static inline void __nodes_shift_right(nodemask_t *dstp,
239                                         const nodemask_t *srcp, int n, int nbits)
240 {
241         bitmap_shift_right(dstp->bits, srcp->bits, n, nbits);
242 }
243
244 #define nodes_shift_left(dst, src, n) \
245                         __nodes_shift_left(&(dst), &(src), (n), MAX_NUMNODES)
246 static inline void __nodes_shift_left(nodemask_t *dstp,
247                                         const nodemask_t *srcp, int n, int nbits)
248 {
249         bitmap_shift_left(dstp->bits, srcp->bits, n, nbits);
250 }
251
252 /* FIXME: better would be to fix all architectures to never return
253           > MAX_NUMNODES, then the silly min_ts could be dropped. */
254
255 #define first_node(src) __first_node(&(src))
256 static inline int __first_node(const nodemask_t *srcp)
257 {
258         return min_t(int, MAX_NUMNODES, find_first_bit(srcp->bits, MAX_NUMNODES));
259 }
260
261 #define next_node(n, src) __next_node((n), &(src))
262 static inline int __next_node(int n, const nodemask_t *srcp)
263 {
264         return min_t(int,MAX_NUMNODES,find_next_bit(srcp->bits, MAX_NUMNODES, n+1));
265 }
266
267 /*
268  * Find the next present node in src, starting after node n, wrapping around to
269  * the first node in src if needed.  Returns MAX_NUMNODES if src is empty.
270  */
271 #define next_node_in(n, src) __next_node_in((n), &(src))
272 int __next_node_in(int node, const nodemask_t *srcp);
273
274 static inline void init_nodemask_of_node(nodemask_t *mask, int node)
275 {
276         nodes_clear(*mask);
277         node_set(node, *mask);
278 }
279
280 #define nodemask_of_node(node)                                          \
281 ({                                                                      \
282         typeof(_unused_nodemask_arg_) m;                                \
283         if (sizeof(m) == sizeof(unsigned long)) {                       \
284                 m.bits[0] = 1UL << (node);                              \
285         } else {                                                        \
286                 init_nodemask_of_node(&m, (node));                      \
287         }                                                               \
288         m;                                                              \
289 })
290
291 #define first_unset_node(mask) __first_unset_node(&(mask))
292 static inline int __first_unset_node(const nodemask_t *maskp)
293 {
294         return min_t(int,MAX_NUMNODES,
295                         find_first_zero_bit(maskp->bits, MAX_NUMNODES));
296 }
297
298 #define NODE_MASK_LAST_WORD BITMAP_LAST_WORD_MASK(MAX_NUMNODES)
299
300 #if MAX_NUMNODES <= BITS_PER_LONG
301
302 #define NODE_MASK_ALL                                                   \
303 ((nodemask_t) { {                                                       \
304         [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD           \
305 } })
306
307 #else
308
309 #define NODE_MASK_ALL                                                   \
310 ((nodemask_t) { {                                                       \
311         [0 ... BITS_TO_LONGS(MAX_NUMNODES)-2] = ~0UL,                   \
312         [BITS_TO_LONGS(MAX_NUMNODES)-1] = NODE_MASK_LAST_WORD           \
313 } })
314
315 #endif
316
317 #define NODE_MASK_NONE                                                  \
318 ((nodemask_t) { {                                                       \
319         [0 ... BITS_TO_LONGS(MAX_NUMNODES)-1] =  0UL                    \
320 } })
321
322 #define nodes_addr(src) ((src).bits)
323
324 #define nodemask_parse_user(ubuf, ulen, dst) \
325                 __nodemask_parse_user((ubuf), (ulen), &(dst), MAX_NUMNODES)
326 static inline int __nodemask_parse_user(const char __user *buf, int len,
327                                         nodemask_t *dstp, int nbits)
328 {
329         return bitmap_parse_user(buf, len, dstp->bits, nbits);
330 }
331
332 #define nodelist_parse(buf, dst) __nodelist_parse((buf), &(dst), MAX_NUMNODES)
333 static inline int __nodelist_parse(const char *buf, nodemask_t *dstp, int nbits)
334 {
335         return bitmap_parselist(buf, dstp->bits, nbits);
336 }
337
338 #define node_remap(oldbit, old, new) \
339                 __node_remap((oldbit), &(old), &(new), MAX_NUMNODES)
340 static inline int __node_remap(int oldbit,
341                 const nodemask_t *oldp, const nodemask_t *newp, int nbits)
342 {
343         return bitmap_bitremap(oldbit, oldp->bits, newp->bits, nbits);
344 }
345
346 #define nodes_remap(dst, src, old, new) \
347                 __nodes_remap(&(dst), &(src), &(old), &(new), MAX_NUMNODES)
348 static inline void __nodes_remap(nodemask_t *dstp, const nodemask_t *srcp,
349                 const nodemask_t *oldp, const nodemask_t *newp, int nbits)
350 {
351         bitmap_remap(dstp->bits, srcp->bits, oldp->bits, newp->bits, nbits);
352 }
353
354 #define nodes_onto(dst, orig, relmap) \
355                 __nodes_onto(&(dst), &(orig), &(relmap), MAX_NUMNODES)
356 static inline void __nodes_onto(nodemask_t *dstp, const nodemask_t *origp,
357                 const nodemask_t *relmapp, int nbits)
358 {
359         bitmap_onto(dstp->bits, origp->bits, relmapp->bits, nbits);
360 }
361
362 #define nodes_fold(dst, orig, sz) \
363                 __nodes_fold(&(dst), &(orig), sz, MAX_NUMNODES)
364 static inline void __nodes_fold(nodemask_t *dstp, const nodemask_t *origp,
365                 int sz, int nbits)
366 {
367         bitmap_fold(dstp->bits, origp->bits, sz, nbits);
368 }
369
370 #if MAX_NUMNODES > 1
371 #define for_each_node_mask(node, mask)                  \
372         for ((node) = first_node(mask);                 \
373                 (node) < MAX_NUMNODES;                  \
374                 (node) = next_node((node), (mask)))
375 #else /* MAX_NUMNODES == 1 */
376 #define for_each_node_mask(node, mask)                  \
377         if (!nodes_empty(mask))                         \
378                 for ((node) = 0; (node) < 1; (node)++)
379 #endif /* MAX_NUMNODES */
380
381 /*
382  * Bitmasks that are kept for all the nodes.
383  */
384 enum node_states {
385         N_POSSIBLE,             /* The node could become online at some point */
386         N_ONLINE,               /* The node is online */
387         N_NORMAL_MEMORY,        /* The node has regular memory */
388 #ifdef CONFIG_HIGHMEM
389         N_HIGH_MEMORY,          /* The node has regular or high memory */
390 #else
391         N_HIGH_MEMORY = N_NORMAL_MEMORY,
392 #endif
393         N_MEMORY,               /* The node has memory(regular, high, movable) */
394         N_CPU,          /* The node has one or more cpus */
395         NR_NODE_STATES
396 };
397
398 /*
399  * The following particular system nodemasks and operations
400  * on them manage all possible and online nodes.
401  */
402
403 extern nodemask_t node_states[NR_NODE_STATES];
404
405 #if MAX_NUMNODES > 1
406 static inline int node_state(int node, enum node_states state)
407 {
408         return node_isset(node, node_states[state]);
409 }
410
411 static inline void node_set_state(int node, enum node_states state)
412 {
413         __node_set(node, &node_states[state]);
414 }
415
416 static inline void node_clear_state(int node, enum node_states state)
417 {
418         __node_clear(node, &node_states[state]);
419 }
420
421 static inline int num_node_state(enum node_states state)
422 {
423         return nodes_weight(node_states[state]);
424 }
425
426 #define for_each_node_state(__node, __state) \
427         for_each_node_mask((__node), node_states[__state])
428
429 #define first_online_node       first_node(node_states[N_ONLINE])
430 #define first_memory_node       first_node(node_states[N_MEMORY])
431 static inline int next_online_node(int nid)
432 {
433         return next_node(nid, node_states[N_ONLINE]);
434 }
435 static inline int next_memory_node(int nid)
436 {
437         return next_node(nid, node_states[N_MEMORY]);
438 }
439
440 extern int nr_node_ids;
441 extern int nr_online_nodes;
442
443 static inline void node_set_online(int nid)
444 {
445         node_set_state(nid, N_ONLINE);
446         nr_online_nodes = num_node_state(N_ONLINE);
447 }
448
449 static inline void node_set_offline(int nid)
450 {
451         node_clear_state(nid, N_ONLINE);
452         nr_online_nodes = num_node_state(N_ONLINE);
453 }
454
455 #else
456
457 static inline int node_state(int node, enum node_states state)
458 {
459         return node == 0;
460 }
461
462 static inline void node_set_state(int node, enum node_states state)
463 {
464 }
465
466 static inline void node_clear_state(int node, enum node_states state)
467 {
468 }
469
470 static inline int num_node_state(enum node_states state)
471 {
472         return 1;
473 }
474
475 #define for_each_node_state(node, __state) \
476         for ( (node) = 0; (node) == 0; (node) = 1)
477
478 #define first_online_node       0
479 #define first_memory_node       0
480 #define next_online_node(nid)   (MAX_NUMNODES)
481 #define nr_node_ids             1
482 #define nr_online_nodes         1
483
484 #define node_set_online(node)      node_set_state((node), N_ONLINE)
485 #define node_set_offline(node)     node_clear_state((node), N_ONLINE)
486
487 #endif
488
489 #if defined(CONFIG_NUMA) && (MAX_NUMNODES > 1)
490 extern int node_random(const nodemask_t *maskp);
491 #else
492 static inline int node_random(const nodemask_t *mask)
493 {
494         return 0;
495 }
496 #endif
497
498 #define node_online_map         node_states[N_ONLINE]
499 #define node_possible_map       node_states[N_POSSIBLE]
500
501 #define num_online_nodes()      num_node_state(N_ONLINE)
502 #define num_possible_nodes()    num_node_state(N_POSSIBLE)
503 #define node_online(node)       node_state((node), N_ONLINE)
504 #define node_possible(node)     node_state((node), N_POSSIBLE)
505
506 #define for_each_node(node)        for_each_node_state(node, N_POSSIBLE)
507 #define for_each_online_node(node) for_each_node_state(node, N_ONLINE)
508
509 /*
510  * For nodemask scrach area.
511  * NODEMASK_ALLOC(type, name) allocates an object with a specified type and
512  * name.
513  */
514 #if NODES_SHIFT > 8 /* nodemask_t > 256 bytes */
515 #define NODEMASK_ALLOC(type, name, gfp_flags)   \
516                         type *name = kmalloc(sizeof(*name), gfp_flags)
517 #define NODEMASK_FREE(m)                        kfree(m)
518 #else
519 #define NODEMASK_ALLOC(type, name, gfp_flags)   type _##name, *name = &_##name
520 #define NODEMASK_FREE(m)                        do {} while (0)
521 #endif
522
523 /* A example struture for using NODEMASK_ALLOC, used in mempolicy. */
524 struct nodemask_scratch {
525         nodemask_t      mask1;
526         nodemask_t      mask2;
527 };
528
529 #define NODEMASK_SCRATCH(x)                                             \
530                         NODEMASK_ALLOC(struct nodemask_scratch, x,      \
531                                         GFP_KERNEL | __GFP_NORETRY)
532 #define NODEMASK_SCRATCH_FREE(x)        NODEMASK_FREE(x)
533
534
535 #endif /* __LINUX_NODEMASK_H */