Commit 29d85688 authored by Kees Cook's avatar Kees Cook
Browse files

string: Convert selftest to KUnit 

Convert test_string.c to KUnit so it can be easily run with everything
else.

Additional text context is retained for failure reporting. For example,
when forcing a bad match, we can see the loop counters reported for the
memset() tests:

[09:21:52]     # test_memset64: ASSERTION FAILED at lib/string_kunit.c:93
[09:21:52]     Expected v == 0xa2a1a1a1a1a1a1a1ULL, but
[09:21:52]         v == -6799976246779207263 (0xa1a1a1a1a1a1a1a1)
[09:21:52]         0xa2a1a1a1a1a1a1a1ULL == -6727918652741279327 (0xa2a1a1a1a1a1a1a1)
[09:21:52] i:0 j:0 k:0
[09:21:52] [FAILED] test_memset64

Currently passes without problems:

$ ./tools/testing/kunit/kunit.py run string
...
[09:37:40] Starting KUnit Kernel (1/1)...
[09:37:40] ============================================================
[09:37:40] =================== string (6 subtests) ====================
[09:37:40] [PASSED] test_memset16
[09:37:40] [PASSED] test_memset32
[09:37:40] [PASSED] test_memset64
[09:37:40] [PASSED] test_strchr
[09:37:40] [PASSED] test_strnchr
[09:37:40] [PASSED] test_strspn
[09:37:40] ===================== [PASSED] string ======================
[09:37:40] ============================================================
[09:37:40] Testing complete. Ran 6 tests: passed: 6
[09:37:40] Elapsed time: 6.730s total, 0.001s configuring, 6.562s building, 0.131s running

Link: https://lore.kernel.org/r/20240301202732.2688342-1-keescook@chromium.org


Signed-off-by: default avatarKees Cook <keescook@chromium.org>
parent e36b70fb

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -8976,9 +8976,9 @@ F: include/linux/string.h 
F:	include/linux/string_choices.h

F:	include/linux/string_helpers.h

F:	lib/string.c

F:	lib/string_kunit.c

F:	lib/string_helpers.c

F:	lib/test-string_helpers.c

F:	lib/test_string.c

F:	scripts/coccinelle/api/string_choices.cocci









GENERIC UIO DRIVER FOR PCI DEVICES
































lib/Kconfig.debug



+4
−2






























Original line number
Diff line number
Diff line







@@ -2352,8 +2352,10 @@ config ASYNC_RAID6_TEST







config TEST_HEXDUMP









	tristate "Test functions located in the hexdump module at runtime"



















config STRING_SELFTEST









	tristate "Test string functions at runtime"









config STRING_KUNIT_TEST









	tristate "KUnit test string functions at runtime" if !KUNIT_ALL_TESTS









	depends on KUNIT









	default KUNIT_ALL_TESTS



















config TEST_STRING_HELPERS









	tristate "Test functions located in the string_helpers module at runtime"
































lib/Makefile



+1
−1






























Original line number
Diff line number
Diff line







@@ -49,7 +49,7 @@ obj-y += bcd.o sort.o parser.o debug_locks.o random32.o \







	 percpu-refcount.o rhashtable.o base64.o \









	 once.o refcount.o rcuref.o usercopy.o errseq.o bucket_locks.o \









	 generic-radix-tree.o bitmap-str.o









obj-$(CONFIG_STRING_SELFTEST) += test_string.o









obj-$(CONFIG_STRING_KUNIT_TEST) += string_kunit.o









obj-y += string_helpers.o









obj-$(CONFIG_TEST_STRING_HELPERS) += test-string_helpers.o









obj-y += hexdump.o
































lib/test_string.c→lib/string_kunit.c



+199
−0






























Original line number
Diff line number
Diff line









// SPDX-License-Identifier: GPL-2.0-only









/*









 * Test cases for string functions.









 */



















#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt



















#include <kunit/test.h>









#include <linux/module.h>









#include <linux/printk.h>









#include <linux/slab.h>









#include <linux/string.h>



















static __init int memset16_selftest(void)









static void test_memset16(struct kunit *test)









{









	unsigned i, j, k;









	u16 v, *p;



















	p = kmalloc(256 * 2 * 2, GFP_KERNEL);









	if (!p)









		return -1;









	p = kunit_kzalloc(test, 256 * 2 * 2, GFP_KERNEL);









	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, p);



















	for (i = 0; i < 256; i++) {









		for (j = 0; j < 256; j++) {








@@ -20,34 +26,27 @@ static __init int memset16_selftest(void)







			for (k = 0; k < 512; k++) {









				v = p[k];









				if (k < i) {









					if (v != 0xa1a1)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xa1a1,









						"i:%d j:%d k:%d", i, j, k);









				} else if (k < i + j) {









					if (v != 0xb1b2)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xb1b2,









						"i:%d j:%d k:%d", i, j, k);









				} else {









					if (v != 0xa1a1)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xa1a1,









						"i:%d j:%d k:%d", i, j, k);









				}









			}









		}









	}



















fail:









	kfree(p);









	if (i < 256)









		return (i << 24) | (j << 16) | k | 0x8000;









	return 0;









}



















static __init int memset32_selftest(void)









static void test_memset32(struct kunit *test)









{









	unsigned i, j, k;









	u32 v, *p;



















	p = kmalloc(256 * 2 * 4, GFP_KERNEL);









	if (!p)









		return -1;









	p = kunit_kzalloc(test, 256 * 2 * 4, GFP_KERNEL);









	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, p);



















	for (i = 0; i < 256; i++) {









		for (j = 0; j < 256; j++) {








@@ -56,34 +55,27 @@ static __init int memset32_selftest(void)







			for (k = 0; k < 512; k++) {









				v = p[k];









				if (k < i) {









					if (v != 0xa1a1a1a1)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xa1a1a1a1,









						"i:%d j:%d k:%d", i, j, k);









				} else if (k < i + j) {









					if (v != 0xb1b2b3b4)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xb1b2b3b4,









						"i:%d j:%d k:%d", i, j, k);









				} else {









					if (v != 0xa1a1a1a1)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xa1a1a1a1,









						"i:%d j:%d k:%d", i, j, k);









				}









			}









		}









	}



















fail:









	kfree(p);









	if (i < 256)









		return (i << 24) | (j << 16) | k | 0x8000;









	return 0;









}



















static __init int memset64_selftest(void)









static void test_memset64(struct kunit *test)









{









	unsigned i, j, k;









	u64 v, *p;



















	p = kmalloc(256 * 2 * 8, GFP_KERNEL);









	if (!p)









		return -1;









	p = kunit_kzalloc(test, 256 * 2 * 8, GFP_KERNEL);









	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, p);



















	for (i = 0; i < 256; i++) {









		for (j = 0; j < 256; j++) {








@@ -92,27 +84,21 @@ static __init int memset64_selftest(void)







			for (k = 0; k < 512; k++) {









				v = p[k];









				if (k < i) {









					if (v != 0xa1a1a1a1a1a1a1a1ULL)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xa1a1a1a1a1a1a1a1ULL,









						"i:%d j:%d k:%d", i, j, k);









				} else if (k < i + j) {









					if (v != 0xb1b2b3b4b5b6b7b8ULL)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xb1b2b3b4b5b6b7b8ULL,









						"i:%d j:%d k:%d", i, j, k);









				} else {









					if (v != 0xa1a1a1a1a1a1a1a1ULL)









						goto fail;









					KUNIT_ASSERT_EQ_MSG(test, v, 0xa1a1a1a1a1a1a1a1ULL,









						"i:%d j:%d k:%d", i, j, k);









				}









			}









		}









	}



















fail:









	kfree(p);









	if (i < 256)









		return (i << 24) | (j << 16) | k | 0x8000;









	return 0;









}



















static __init int strchr_selftest(void)









static void test_strchr(struct kunit *test)









{









	const char *test_string = "abcdefghijkl";









	const char *empty_string = "";








@@ -121,26 +107,21 @@ static __init int strchr_selftest(void)

















	for (i = 0; i < strlen(test_string) + 1; i++) {









		result = strchr(test_string, test_string[i]);









		if (result - test_string != i)









			return i + 'a';









		KUNIT_ASSERT_EQ_MSG(test, result - test_string, i,









				    "char:%c", 'a' + i);









	}



















	result = strchr(empty_string, '\0');









	if (result != empty_string)









		return 0x101;









	KUNIT_ASSERT_PTR_EQ(test, result, empty_string);



















	result = strchr(empty_string, 'a');









	if (result)









		return 0x102;









	KUNIT_ASSERT_NULL(test, result);



















	result = strchr(test_string, 'z');









	if (result)









		return 0x103;



















	return 0;









	KUNIT_ASSERT_NULL(test, result);









}



















static __init int strnchr_selftest(void)









static void test_strnchr(struct kunit *test)









{









	const char *test_string = "abcdefghijkl";









	const char *empty_string = "";








@@ -151,35 +132,29 @@ static __init int strnchr_selftest(void)







		for (j = 0; j < strlen(test_string) + 2; j++) {









			result = strnchr(test_string, j, test_string[i]);









			if (j <= i) {









				if (!result)









					continue;









				return ((i + 'a') << 8) | j;









				KUNIT_ASSERT_NULL_MSG(test, result,









					"char:%c i:%d j:%d", 'a' + i, i, j);









			} else {









				KUNIT_ASSERT_EQ_MSG(test, result - test_string, i,









					"char:%c i:%d j:%d", 'a' + i, i, j);









			}









			if (result - test_string != i)









				return ((i + 'a') << 8) | j;









		}









	}



















	result = strnchr(empty_string, 0, '\0');









	if (result)









		return 0x10001;









	KUNIT_ASSERT_NULL(test, result);



















	result = strnchr(empty_string, 1, '\0');









	if (result != empty_string)









		return 0x10002;









	KUNIT_ASSERT_PTR_EQ(test, result, empty_string);



















	result = strnchr(empty_string, 1, 'a');









	if (result)









		return 0x10003;









	KUNIT_ASSERT_NULL(test, result);



















	result = strnchr(NULL, 0, '\0');









	if (result)









		return 0x10004;



















	return 0;









	KUNIT_ASSERT_NULL(test, result);









}



















static __init int strspn_selftest(void)









static void test_strspn(struct kunit *test)









{









	static const struct strspn_test {









		const char str[16];








@@ -187,71 +162,38 @@ static __init int strspn_selftest(void)







		const char reject[16];









		unsigned a;









		unsigned r;









	} tests[] __initconst = {









	} tests[] = {









		{ "foobar", "", "", 0, 6 },









		{ "abba", "abc", "ABBA", 4, 4 },









		{ "abba", "a", "b", 1, 1 },









		{ "", "abc", "abc", 0, 0},









	};









	const struct strspn_test *s = tests;









	size_t i, res;









	size_t i;



















	for (i = 0; i < ARRAY_SIZE(tests); ++i, ++s) {









		res = strspn(s->str, s->accept);









		if (res != s->a)









			return 0x100 + 2*i;









		res = strcspn(s->str, s->reject);









		if (res != s->r)









			return 0x100 + 2*i + 1;









		KUNIT_ASSERT_EQ_MSG(test, s->a, strspn(s->str, s->accept),









			"i:%zu", i);









		KUNIT_ASSERT_EQ_MSG(test, s->r, strcspn(s->str, s->reject),









			"i:%zu", i);









	}









	return 0;









}



















static __exit void string_selftest_remove(void)









{









}



















static __init int string_selftest_init(void)









{









	int test, subtest;



















	test = 1;









	subtest = memset16_selftest();









	if (subtest)









		goto fail;



















	test = 2;









	subtest = memset32_selftest();









	if (subtest)









		goto fail;



















	test = 3;









	subtest = memset64_selftest();









	if (subtest)









		goto fail;



















	test = 4;









	subtest = strchr_selftest();









	if (subtest)









		goto fail;



















	test = 5;









	subtest = strnchr_selftest();









	if (subtest)









		goto fail;









static struct kunit_case string_test_cases[] = {









	KUNIT_CASE(test_memset16),









	KUNIT_CASE(test_memset32),









	KUNIT_CASE(test_memset64),









	KUNIT_CASE(test_strchr),









	KUNIT_CASE(test_strnchr),









	KUNIT_CASE(test_strspn),









	{}









};



















	test = 6;









	subtest = strspn_selftest();









	if (subtest)









		goto fail;









static struct kunit_suite string_test_suite = {









	.name = "string",









	.test_cases = string_test_cases,









};



















	pr_info("String selftests succeeded\n");









	return 0;









fail:









	pr_crit("String selftest failure %d.%08x\n", test, subtest);









	return 0;









}









kunit_test_suites(&string_test_suite);



















module_init(string_selftest_init);









module_exit(string_selftest_remove);









MODULE_LICENSE("GPL v2");