1 // SPDX-License-Identifier: GPL-2.0-only
3 * Test cases for bitmap API.
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
8 #include <linux/bitmap.h>
9 #include <linux/init.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/printk.h>
13 #include <linux/slab.h>
14 #include <linux/string.h>
15 #include <linux/uaccess.h>
17 #include "../tools/testing/selftests/kselftest_module.h"
19 KSTM_MODULE_GLOBALS();
21 static char pbl_buffer[PAGE_SIZE] __initdata;
23 static const unsigned long exp1[] __initconst = {
26 BITMAP_FROM_U64(0x0000ffff),
27 BITMAP_FROM_U64(0xffff0000),
28 BITMAP_FROM_U64(0x55555555),
29 BITMAP_FROM_U64(0xaaaaaaaa),
30 BITMAP_FROM_U64(0x11111111),
31 BITMAP_FROM_U64(0x22222222),
32 BITMAP_FROM_U64(0xffffffff),
33 BITMAP_FROM_U64(0xfffffffe),
34 BITMAP_FROM_U64(0x3333333311111111ULL),
35 BITMAP_FROM_U64(0xffffffff77777777ULL),
39 static const unsigned long exp2[] __initconst = {
40 BITMAP_FROM_U64(0x3333333311111111ULL),
41 BITMAP_FROM_U64(0xffffffff77777777ULL),
44 /* Fibonacci sequence */
45 static const unsigned long exp2_to_exp3_mask[] __initconst = {
46 BITMAP_FROM_U64(0x008000020020212eULL),
48 /* exp3_0_1 = (exp2[0] & ~exp2_to_exp3_mask) | (exp2[1] & exp2_to_exp3_mask) */
49 static const unsigned long exp3_0_1[] __initconst = {
50 BITMAP_FROM_U64(0x33b3333311313137ULL),
52 /* exp3_1_0 = (exp2[1] & ~exp2_to_exp3_mask) | (exp2[0] & exp2_to_exp3_mask) */
53 static const unsigned long exp3_1_0[] __initconst = {
54 BITMAP_FROM_U64(0xff7fffff77575751ULL),
58 __check_eq_uint(const char *srcfile, unsigned int line,
59 const unsigned int exp_uint, unsigned int x)
62 pr_err("[%s:%u] expected %u, got %u\n",
63 srcfile, line, exp_uint, x);
71 __check_eq_bitmap(const char *srcfile, unsigned int line,
72 const unsigned long *exp_bmap, const unsigned long *bmap,
75 if (!bitmap_equal(exp_bmap, bmap, nbits)) {
76 pr_warn("[%s:%u] bitmaps contents differ: expected \"%*pbl\", got \"%*pbl\"\n",
78 nbits, exp_bmap, nbits, bmap);
85 __check_eq_pbl(const char *srcfile, unsigned int line,
86 const char *expected_pbl,
87 const unsigned long *bitmap, unsigned int nbits)
89 snprintf(pbl_buffer, sizeof(pbl_buffer), "%*pbl", nbits, bitmap);
90 if (strcmp(expected_pbl, pbl_buffer)) {
91 pr_warn("[%s:%u] expected \"%s\", got \"%s\"\n",
93 expected_pbl, pbl_buffer);
100 __check_eq_u32_array(const char *srcfile, unsigned int line,
101 const u32 *exp_arr, unsigned int exp_len,
102 const u32 *arr, unsigned int len) __used;
104 __check_eq_u32_array(const char *srcfile, unsigned int line,
105 const u32 *exp_arr, unsigned int exp_len,
106 const u32 *arr, unsigned int len)
108 if (exp_len != len) {
109 pr_warn("[%s:%u] array length differ: expected %u, got %u\n",
115 if (memcmp(exp_arr, arr, len*sizeof(*arr))) {
116 pr_warn("[%s:%u] array contents differ\n", srcfile, line);
117 print_hex_dump(KERN_WARNING, " exp: ", DUMP_PREFIX_OFFSET,
118 32, 4, exp_arr, exp_len*sizeof(*exp_arr), false);
119 print_hex_dump(KERN_WARNING, " got: ", DUMP_PREFIX_OFFSET,
120 32, 4, arr, len*sizeof(*arr), false);
127 static bool __init __check_eq_clump8(const char *srcfile, unsigned int line,
128 const unsigned int offset,
129 const unsigned int size,
130 const unsigned char *const clump_exp,
131 const unsigned long *const clump)
135 if (offset >= size) {
136 pr_warn("[%s:%u] bit offset for clump out-of-bounds: expected less than %u, got %u\n",
137 srcfile, line, size, offset);
141 exp = clump_exp[offset / 8];
143 pr_warn("[%s:%u] bit offset for zero clump: expected nonzero clump, got bit offset %u with clump value 0",
144 srcfile, line, offset);
149 pr_warn("[%s:%u] expected clump value of 0x%lX, got clump value of 0x%lX",
150 srcfile, line, exp, *clump);
157 #define __expect_eq(suffix, ...) \
161 if (!__check_eq_ ## suffix(__FILE__, __LINE__, \
169 #define expect_eq_uint(...) __expect_eq(uint, ##__VA_ARGS__)
170 #define expect_eq_bitmap(...) __expect_eq(bitmap, ##__VA_ARGS__)
171 #define expect_eq_pbl(...) __expect_eq(pbl, ##__VA_ARGS__)
172 #define expect_eq_u32_array(...) __expect_eq(u32_array, ##__VA_ARGS__)
173 #define expect_eq_clump8(...) __expect_eq(clump8, ##__VA_ARGS__)
175 static void __init test_zero_clear(void)
177 DECLARE_BITMAP(bmap, 1024);
179 /* Known way to set all bits */
180 memset(bmap, 0xff, 128);
182 expect_eq_pbl("0-22", bmap, 23);
183 expect_eq_pbl("0-1023", bmap, 1024);
185 /* single-word bitmaps */
186 bitmap_clear(bmap, 0, 9);
187 expect_eq_pbl("9-1023", bmap, 1024);
189 bitmap_zero(bmap, 35);
190 expect_eq_pbl("64-1023", bmap, 1024);
192 /* cross boundaries operations */
193 bitmap_clear(bmap, 79, 19);
194 expect_eq_pbl("64-78,98-1023", bmap, 1024);
196 bitmap_zero(bmap, 115);
197 expect_eq_pbl("128-1023", bmap, 1024);
199 /* Zeroing entire area */
200 bitmap_zero(bmap, 1024);
201 expect_eq_pbl("", bmap, 1024);
204 static void __init test_fill_set(void)
206 DECLARE_BITMAP(bmap, 1024);
208 /* Known way to clear all bits */
209 memset(bmap, 0x00, 128);
211 expect_eq_pbl("", bmap, 23);
212 expect_eq_pbl("", bmap, 1024);
214 /* single-word bitmaps */
215 bitmap_set(bmap, 0, 9);
216 expect_eq_pbl("0-8", bmap, 1024);
218 bitmap_fill(bmap, 35);
219 expect_eq_pbl("0-63", bmap, 1024);
221 /* cross boundaries operations */
222 bitmap_set(bmap, 79, 19);
223 expect_eq_pbl("0-63,79-97", bmap, 1024);
225 bitmap_fill(bmap, 115);
226 expect_eq_pbl("0-127", bmap, 1024);
228 /* Zeroing entire area */
229 bitmap_fill(bmap, 1024);
230 expect_eq_pbl("0-1023", bmap, 1024);
233 static void __init test_copy(void)
235 DECLARE_BITMAP(bmap1, 1024);
236 DECLARE_BITMAP(bmap2, 1024);
238 bitmap_zero(bmap1, 1024);
239 bitmap_zero(bmap2, 1024);
241 /* single-word bitmaps */
242 bitmap_set(bmap1, 0, 19);
243 bitmap_copy(bmap2, bmap1, 23);
244 expect_eq_pbl("0-18", bmap2, 1024);
246 bitmap_set(bmap2, 0, 23);
247 bitmap_copy(bmap2, bmap1, 23);
248 expect_eq_pbl("0-18", bmap2, 1024);
250 /* multi-word bitmaps */
251 bitmap_set(bmap1, 0, 109);
252 bitmap_copy(bmap2, bmap1, 1024);
253 expect_eq_pbl("0-108", bmap2, 1024);
255 bitmap_fill(bmap2, 1024);
256 bitmap_copy(bmap2, bmap1, 1024);
257 expect_eq_pbl("0-108", bmap2, 1024);
259 /* the following tests assume a 32- or 64-bit arch (even 128b
263 bitmap_fill(bmap2, 1024);
264 bitmap_copy(bmap2, bmap1, 109); /* ... but 0-padded til word length */
265 expect_eq_pbl("0-108,128-1023", bmap2, 1024);
267 bitmap_fill(bmap2, 1024);
268 bitmap_copy(bmap2, bmap1, 97); /* ... but aligned on word length */
269 expect_eq_pbl("0-108,128-1023", bmap2, 1024);
272 #define EXP2_IN_BITS (sizeof(exp2) * 8)
274 static void __init test_replace(void)
276 unsigned int nbits = 64;
277 unsigned int nlongs = DIV_ROUND_UP(nbits, BITS_PER_LONG);
278 DECLARE_BITMAP(bmap, 1024);
280 BUILD_BUG_ON(EXP2_IN_BITS < nbits * 2);
282 bitmap_zero(bmap, 1024);
283 bitmap_replace(bmap, &exp2[0 * nlongs], &exp2[1 * nlongs], exp2_to_exp3_mask, nbits);
284 expect_eq_bitmap(bmap, exp3_0_1, nbits);
286 bitmap_zero(bmap, 1024);
287 bitmap_replace(bmap, &exp2[1 * nlongs], &exp2[0 * nlongs], exp2_to_exp3_mask, nbits);
288 expect_eq_bitmap(bmap, exp3_1_0, nbits);
290 bitmap_fill(bmap, 1024);
291 bitmap_replace(bmap, &exp2[0 * nlongs], &exp2[1 * nlongs], exp2_to_exp3_mask, nbits);
292 expect_eq_bitmap(bmap, exp3_0_1, nbits);
294 bitmap_fill(bmap, 1024);
295 bitmap_replace(bmap, &exp2[1 * nlongs], &exp2[0 * nlongs], exp2_to_exp3_mask, nbits);
296 expect_eq_bitmap(bmap, exp3_1_0, nbits);
299 #define PARSE_TIME 0x1
302 struct test_bitmap_parselist{
305 const unsigned long *expected;
310 static const struct test_bitmap_parselist parselist_tests[] __initconst = {
311 #define step (sizeof(u64) / sizeof(unsigned long))
313 {0, "0", &exp1[0], 8, 0},
314 {0, "1", &exp1[1 * step], 8, 0},
315 {0, "0-15", &exp1[2 * step], 32, 0},
316 {0, "16-31", &exp1[3 * step], 32, 0},
317 {0, "0-31:1/2", &exp1[4 * step], 32, 0},
318 {0, "1-31:1/2", &exp1[5 * step], 32, 0},
319 {0, "0-31:1/4", &exp1[6 * step], 32, 0},
320 {0, "1-31:1/4", &exp1[7 * step], 32, 0},
321 {0, "0-31:4/4", &exp1[8 * step], 32, 0},
322 {0, "1-31:4/4", &exp1[9 * step], 32, 0},
323 {0, "0-31:1/4,32-63:2/4", &exp1[10 * step], 64, 0},
324 {0, "0-31:3/4,32-63:4/4", &exp1[11 * step], 64, 0},
325 {0, " ,, 0-31:3/4 ,, 32-63:4/4 ,, ", &exp1[11 * step], 64, 0},
327 {0, "0-31:1/4,32-63:2/4,64-95:3/4,96-127:4/4", exp2, 128, 0},
329 {0, "0-2047:128/256", NULL, 2048, PARSE_TIME},
331 {0, "", &exp1[12 * step], 8, 0},
332 {0, "\n", &exp1[12 * step], 8, 0},
333 {0, ",, ,, , , ,", &exp1[12 * step], 8, 0},
334 {0, " , ,, , , ", &exp1[12 * step], 8, 0},
335 {0, " , ,, , , \n", &exp1[12 * step], 8, 0},
337 {-EINVAL, "-1", NULL, 8, 0},
338 {-EINVAL, "-0", NULL, 8, 0},
339 {-EINVAL, "10-1", NULL, 8, 0},
340 {-EINVAL, "0-31:", NULL, 8, 0},
341 {-EINVAL, "0-31:0", NULL, 8, 0},
342 {-EINVAL, "0-31:0/", NULL, 8, 0},
343 {-EINVAL, "0-31:0/0", NULL, 8, 0},
344 {-EINVAL, "0-31:1/0", NULL, 8, 0},
345 {-EINVAL, "0-31:10/1", NULL, 8, 0},
346 {-EOVERFLOW, "0-98765432123456789:10/1", NULL, 8, 0},
348 {-EINVAL, "a-31", NULL, 8, 0},
349 {-EINVAL, "0-a1", NULL, 8, 0},
350 {-EINVAL, "a-31:10/1", NULL, 8, 0},
351 {-EINVAL, "0-31:a/1", NULL, 8, 0},
352 {-EINVAL, "0-\n", NULL, 8, 0},
356 static void __init test_bitmap_parselist(void)
361 DECLARE_BITMAP(bmap, 2048);
363 for (i = 0; i < ARRAY_SIZE(parselist_tests); i++) {
364 #define ptest parselist_tests[i]
367 err = bitmap_parselist(ptest.in, bmap, ptest.nbits);
368 time = ktime_get() - time;
370 if (err != ptest.errno) {
371 pr_err("parselist: %d: input is %s, errno is %d, expected %d\n",
372 i, ptest.in, err, ptest.errno);
376 if (!err && ptest.expected
377 && !__bitmap_equal(bmap, ptest.expected, ptest.nbits)) {
378 pr_err("parselist: %d: input is %s, result is 0x%lx, expected 0x%lx\n",
379 i, ptest.in, bmap[0],
384 if (ptest.flags & PARSE_TIME)
385 pr_err("parselist: %d: input is '%s' OK, Time: %llu\n",
392 static const unsigned long parse_test[] __initconst = {
395 BITMAP_FROM_U64(0xdeadbeef),
396 BITMAP_FROM_U64(0x100000000ULL),
399 static const unsigned long parse_test2[] __initconst = {
400 BITMAP_FROM_U64(0x100000000ULL), BITMAP_FROM_U64(0xdeadbeef),
401 BITMAP_FROM_U64(0x100000000ULL), BITMAP_FROM_U64(0xbaadf00ddeadbeef),
402 BITMAP_FROM_U64(0x100000000ULL), BITMAP_FROM_U64(0x0badf00ddeadbeef),
405 static const struct test_bitmap_parselist parse_tests[] __initconst = {
406 {0, "", &parse_test[0 * step], 32, 0},
407 {0, " ", &parse_test[0 * step], 32, 0},
408 {0, "0", &parse_test[0 * step], 32, 0},
409 {0, "0\n", &parse_test[0 * step], 32, 0},
410 {0, "1", &parse_test[1 * step], 32, 0},
411 {0, "deadbeef", &parse_test[2 * step], 32, 0},
412 {0, "1,0", &parse_test[3 * step], 33, 0},
413 {0, "deadbeef,\n,0,1", &parse_test[2 * step], 96, 0},
415 {0, "deadbeef,1,0", &parse_test2[0 * 2 * step], 96, 0},
416 {0, "baadf00d,deadbeef,1,0", &parse_test2[1 * 2 * step], 128, 0},
417 {0, "badf00d,deadbeef,1,0", &parse_test2[2 * 2 * step], 124, 0},
418 {0, "badf00d,deadbeef,1,0", &parse_test2[2 * 2 * step], 124, NO_LEN},
419 {0, " badf00d,deadbeef,1,0 ", &parse_test2[2 * 2 * step], 124, 0},
420 {0, " , badf00d,deadbeef,1,0 , ", &parse_test2[2 * 2 * step], 124, 0},
421 {0, " , badf00d, ,, ,,deadbeef,1,0 , ", &parse_test2[2 * 2 * step], 124, 0},
423 {-EINVAL, "goodfood,deadbeef,1,0", NULL, 128, 0},
424 {-EOVERFLOW, "3,0", NULL, 33, 0},
425 {-EOVERFLOW, "123badf00d,deadbeef,1,0", NULL, 128, 0},
426 {-EOVERFLOW, "badf00d,deadbeef,1,0", NULL, 90, 0},
427 {-EOVERFLOW, "fbadf00d,deadbeef,1,0", NULL, 95, 0},
428 {-EOVERFLOW, "badf00d,deadbeef,1,0", NULL, 100, 0},
432 static void __init test_bitmap_parse(void)
437 DECLARE_BITMAP(bmap, 2048);
439 for (i = 0; i < ARRAY_SIZE(parse_tests); i++) {
440 struct test_bitmap_parselist test = parse_tests[i];
441 size_t len = test.flags & NO_LEN ? UINT_MAX : strlen(test.in);
444 err = bitmap_parse(test.in, len, bmap, test.nbits);
445 time = ktime_get() - time;
447 if (err != test.errno) {
448 pr_err("parse: %d: input is %s, errno is %d, expected %d\n",
449 i, test.in, err, test.errno);
453 if (!err && test.expected
454 && !__bitmap_equal(bmap, test.expected, test.nbits)) {
455 pr_err("parse: %d: input is %s, result is 0x%lx, expected 0x%lx\n",
461 if (test.flags & PARSE_TIME)
462 pr_err("parse: %d: input is '%s' OK, Time: %llu\n",
467 #define EXP1_IN_BITS (sizeof(exp1) * 8)
469 static void __init test_bitmap_arr32(void)
471 unsigned int nbits, next_bit;
472 u32 arr[EXP1_IN_BITS / 32];
473 DECLARE_BITMAP(bmap2, EXP1_IN_BITS);
475 memset(arr, 0xa5, sizeof(arr));
477 for (nbits = 0; nbits < EXP1_IN_BITS; ++nbits) {
478 bitmap_to_arr32(arr, exp1, nbits);
479 bitmap_from_arr32(bmap2, arr, nbits);
480 expect_eq_bitmap(bmap2, exp1, nbits);
482 next_bit = find_next_bit(bmap2,
483 round_up(nbits, BITS_PER_LONG), nbits);
484 if (next_bit < round_up(nbits, BITS_PER_LONG))
485 pr_err("bitmap_copy_arr32(nbits == %d:"
486 " tail is not safely cleared: %d\n",
489 if (nbits < EXP1_IN_BITS - 32)
490 expect_eq_uint(arr[DIV_ROUND_UP(nbits, 32)],
495 static void noinline __init test_mem_optimisations(void)
497 DECLARE_BITMAP(bmap1, 1024);
498 DECLARE_BITMAP(bmap2, 1024);
499 unsigned int start, nbits;
501 for (start = 0; start < 1024; start += 8) {
502 for (nbits = 0; nbits < 1024 - start; nbits += 8) {
503 memset(bmap1, 0x5a, sizeof(bmap1));
504 memset(bmap2, 0x5a, sizeof(bmap2));
506 bitmap_set(bmap1, start, nbits);
507 __bitmap_set(bmap2, start, nbits);
508 if (!bitmap_equal(bmap1, bmap2, 1024)) {
509 printk("set not equal %d %d\n", start, nbits);
512 if (!__bitmap_equal(bmap1, bmap2, 1024)) {
513 printk("set not __equal %d %d\n", start, nbits);
517 bitmap_clear(bmap1, start, nbits);
518 __bitmap_clear(bmap2, start, nbits);
519 if (!bitmap_equal(bmap1, bmap2, 1024)) {
520 printk("clear not equal %d %d\n", start, nbits);
523 if (!__bitmap_equal(bmap1, bmap2, 1024)) {
524 printk("clear not __equal %d %d\n", start,
532 static const unsigned char clump_exp[] __initconst = {
533 0x01, /* 1 bit set */
534 0x02, /* non-edge 1 bit set */
535 0x00, /* zero bits set */
536 0x38, /* 3 bits set across 4-bit boundary */
537 0x38, /* Repeated clump */
538 0x0F, /* 4 bits set */
539 0xFF, /* all bits set */
540 0x05, /* non-adjacent 2 bits set */
543 static void __init test_for_each_set_clump8(void)
545 #define CLUMP_EXP_NUMBITS 64
546 DECLARE_BITMAP(bits, CLUMP_EXP_NUMBITS);
550 /* set bitmap to test case */
551 bitmap_zero(bits, CLUMP_EXP_NUMBITS);
552 bitmap_set(bits, 0, 1); /* 0x01 */
553 bitmap_set(bits, 9, 1); /* 0x02 */
554 bitmap_set(bits, 27, 3); /* 0x28 */
555 bitmap_set(bits, 35, 3); /* 0x28 */
556 bitmap_set(bits, 40, 4); /* 0x0F */
557 bitmap_set(bits, 48, 8); /* 0xFF */
558 bitmap_set(bits, 56, 1); /* 0x05 - part 1 */
559 bitmap_set(bits, 58, 1); /* 0x05 - part 2 */
561 for_each_set_clump8(start, clump, bits, CLUMP_EXP_NUMBITS)
562 expect_eq_clump8(start, CLUMP_EXP_NUMBITS, clump_exp, &clump);
565 struct test_bitmap_cut {
570 unsigned long expected[4];
573 static struct test_bitmap_cut test_cut[] = {
574 { 0, 0, 8, { 0x0000000aUL, }, { 0x0000000aUL, }, },
575 { 0, 0, 32, { 0xdadadeadUL, }, { 0xdadadeadUL, }, },
576 { 0, 3, 8, { 0x000000aaUL, }, { 0x00000015UL, }, },
577 { 3, 3, 8, { 0x000000aaUL, }, { 0x00000012UL, }, },
578 { 0, 1, 32, { 0xa5a5a5a5UL, }, { 0x52d2d2d2UL, }, },
579 { 0, 8, 32, { 0xdeadc0deUL, }, { 0x00deadc0UL, }, },
580 { 1, 1, 32, { 0x5a5a5a5aUL, }, { 0x2d2d2d2cUL, }, },
581 { 0, 15, 32, { 0xa5a5a5a5UL, }, { 0x00014b4bUL, }, },
582 { 0, 16, 32, { 0xa5a5a5a5UL, }, { 0x0000a5a5UL, }, },
583 { 15, 15, 32, { 0xa5a5a5a5UL, }, { 0x000125a5UL, }, },
584 { 15, 16, 32, { 0xa5a5a5a5UL, }, { 0x0000a5a5UL, }, },
585 { 16, 15, 32, { 0xa5a5a5a5UL, }, { 0x0001a5a5UL, }, },
587 { BITS_PER_LONG, BITS_PER_LONG, BITS_PER_LONG,
588 { 0xa5a5a5a5UL, 0xa5a5a5a5UL, },
589 { 0xa5a5a5a5UL, 0xa5a5a5a5UL, },
591 { 1, BITS_PER_LONG - 1, BITS_PER_LONG,
592 { 0xa5a5a5a5UL, 0xa5a5a5a5UL, },
593 { 0x00000001UL, 0x00000001UL, },
596 { 0, BITS_PER_LONG * 2, BITS_PER_LONG * 2 + 1,
597 { 0xa5a5a5a5UL, 0x00000001UL, 0x00000001UL, 0x00000001UL },
600 { 16, BITS_PER_LONG * 2 + 1, BITS_PER_LONG * 2 + 1 + 16,
601 { 0x0000ffffUL, 0x5a5a5a5aUL, 0x5a5a5a5aUL, 0x5a5a5a5aUL },
606 static void __init test_bitmap_cut(void)
608 unsigned long b[5], *in = &b[1], *out = &b[0]; /* Partial overlap */
611 for (i = 0; i < ARRAY_SIZE(test_cut); i++) {
612 struct test_bitmap_cut *t = &test_cut[i];
614 memcpy(in, t->in, sizeof(t->in));
616 bitmap_cut(out, in, t->first, t->cut, t->nbits);
618 expect_eq_bitmap(t->expected, out, t->nbits);
622 static void __init selftest(void)
630 test_bitmap_parselist();
631 test_mem_optimisations();
632 test_for_each_set_clump8();
636 KSTM_MODULE_LOADERS(test_bitmap);
637 MODULE_AUTHOR("david decotigny <david.decotigny@googlers.com>");
638 MODULE_LICENSE("GPL");