xref: /linux/lib/math/tests/int_sqrt_kunit.c (revision 1260ed77798502de9c98020040d2995008de10cc)
1*0fafc9e1SLuis Felipe Hernandez // SPDX-License-Identifier: GPL-2.0-only
2*0fafc9e1SLuis Felipe Hernandez 
3*0fafc9e1SLuis Felipe Hernandez #include <kunit/test.h>
4*0fafc9e1SLuis Felipe Hernandez #include <linux/limits.h>
5*0fafc9e1SLuis Felipe Hernandez #include <linux/math.h>
6*0fafc9e1SLuis Felipe Hernandez #include <linux/module.h>
7*0fafc9e1SLuis Felipe Hernandez #include <linux/string.h>
8*0fafc9e1SLuis Felipe Hernandez 
9*0fafc9e1SLuis Felipe Hernandez struct test_case_params {
10*0fafc9e1SLuis Felipe Hernandez 	unsigned long x;
11*0fafc9e1SLuis Felipe Hernandez 	unsigned long expected_result;
12*0fafc9e1SLuis Felipe Hernandez 	const char *name;
13*0fafc9e1SLuis Felipe Hernandez };
14*0fafc9e1SLuis Felipe Hernandez 
15*0fafc9e1SLuis Felipe Hernandez static const struct test_case_params params[] = {
16*0fafc9e1SLuis Felipe Hernandez 	{ 0, 0, "edge case: square root of 0" },
17*0fafc9e1SLuis Felipe Hernandez 	{ 1, 1, "perfect square: square root of 1" },
18*0fafc9e1SLuis Felipe Hernandez 	{ 2, 1, "non-perfect square: square root of 2" },
19*0fafc9e1SLuis Felipe Hernandez 	{ 3, 1, "non-perfect square: square root of 3" },
20*0fafc9e1SLuis Felipe Hernandez 	{ 4, 2, "perfect square: square root of 4" },
21*0fafc9e1SLuis Felipe Hernandez 	{ 5, 2, "non-perfect square: square root of 5" },
22*0fafc9e1SLuis Felipe Hernandez 	{ 6, 2, "non-perfect square: square root of 6" },
23*0fafc9e1SLuis Felipe Hernandez 	{ 7, 2, "non-perfect square: square root of 7" },
24*0fafc9e1SLuis Felipe Hernandez 	{ 8, 2, "non-perfect square: square root of 8" },
25*0fafc9e1SLuis Felipe Hernandez 	{ 9, 3, "perfect square: square root of 9" },
26*0fafc9e1SLuis Felipe Hernandez 	{ 15, 3, "non-perfect square: square root of 15 (N-1 from 16)" },
27*0fafc9e1SLuis Felipe Hernandez 	{ 16, 4, "perfect square: square root of 16" },
28*0fafc9e1SLuis Felipe Hernandez 	{ 17, 4, "non-perfect square: square root of 17 (N+1 from 16)" },
29*0fafc9e1SLuis Felipe Hernandez 	{ 80, 8, "non-perfect square: square root of 80 (N-1 from 81)" },
30*0fafc9e1SLuis Felipe Hernandez 	{ 81, 9, "perfect square: square root of 81" },
31*0fafc9e1SLuis Felipe Hernandez 	{ 82, 9, "non-perfect square: square root of 82 (N+1 from 81)" },
32*0fafc9e1SLuis Felipe Hernandez 	{ 255, 15, "non-perfect square: square root of 255 (N-1 from 256)" },
33*0fafc9e1SLuis Felipe Hernandez 	{ 256, 16, "perfect square: square root of 256" },
34*0fafc9e1SLuis Felipe Hernandez 	{ 257, 16, "non-perfect square: square root of 257 (N+1 from 256)" },
35*0fafc9e1SLuis Felipe Hernandez 	{ 2147483648, 46340, "large input: square root of 2147483648" },
36*0fafc9e1SLuis Felipe Hernandez 	{ 4294967295, 65535, "edge case: ULONG_MAX for 32-bit" },
37*0fafc9e1SLuis Felipe Hernandez };
38*0fafc9e1SLuis Felipe Hernandez 
39*0fafc9e1SLuis Felipe Hernandez static void get_desc(const struct test_case_params *tc, char *desc)
40*0fafc9e1SLuis Felipe Hernandez {
41*0fafc9e1SLuis Felipe Hernandez 	strscpy(desc, tc->name, KUNIT_PARAM_DESC_SIZE);
42*0fafc9e1SLuis Felipe Hernandez }
43*0fafc9e1SLuis Felipe Hernandez 
44*0fafc9e1SLuis Felipe Hernandez KUNIT_ARRAY_PARAM(int_sqrt, params, get_desc);
45*0fafc9e1SLuis Felipe Hernandez 
46*0fafc9e1SLuis Felipe Hernandez static void int_sqrt_test(struct kunit *test)
47*0fafc9e1SLuis Felipe Hernandez {
48*0fafc9e1SLuis Felipe Hernandez 	const struct test_case_params *tc = (const struct test_case_params *)test->param_value;
49*0fafc9e1SLuis Felipe Hernandez 
50*0fafc9e1SLuis Felipe Hernandez 	KUNIT_EXPECT_EQ(test, tc->expected_result, int_sqrt(tc->x));
51*0fafc9e1SLuis Felipe Hernandez }
52*0fafc9e1SLuis Felipe Hernandez 
53*0fafc9e1SLuis Felipe Hernandez static struct kunit_case math_int_sqrt_test_cases[] = {
54*0fafc9e1SLuis Felipe Hernandez 	KUNIT_CASE_PARAM(int_sqrt_test, int_sqrt_gen_params),
55*0fafc9e1SLuis Felipe Hernandez 	{}
56*0fafc9e1SLuis Felipe Hernandez };
57*0fafc9e1SLuis Felipe Hernandez 
58*0fafc9e1SLuis Felipe Hernandez static struct kunit_suite int_sqrt_test_suite = {
59*0fafc9e1SLuis Felipe Hernandez 	.name = "math-int_sqrt",
60*0fafc9e1SLuis Felipe Hernandez 	.test_cases = math_int_sqrt_test_cases,
61*0fafc9e1SLuis Felipe Hernandez };
62*0fafc9e1SLuis Felipe Hernandez 
63*0fafc9e1SLuis Felipe Hernandez kunit_test_suites(&int_sqrt_test_suite);
64*0fafc9e1SLuis Felipe Hernandez 
65*0fafc9e1SLuis Felipe Hernandez MODULE_DESCRIPTION("math.int_sqrt KUnit test suite");
66*0fafc9e1SLuis Felipe Hernandez MODULE_LICENSE("GPL");
67