Skip to contentSkip to conversation

lib/math: Add int_pow test suite

PATCH Superseded Luis Felipe Hernandez 2 participants 3 messages Aug 20, 2024 – Sep 6, 2024

Subsystems (2)

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 lib/math: Add int_pow test suite

Adds test suite for integer based power function.

---
Changes in v3:
- Fix compiler warning: explicitly define constant as unsigned int
- Add changes in patch revisions
Changes in v2:
- Address review feedback
- Add kconfig entry
- Use correct dir and file convention for KUnit
- Fix typo
- Remove unused static_stub header
- Refactor test suite to use paramerterized test cases
- Add close to max allowable value to in large_result test case
- Add test case with non-power of two exponent
- Fix module license

---
 lib/Kconfig.debug              |  9 ++++++
 lib/math/Makefile              |  1 +
 lib/math/tests/Makefile        |  3 ++
 lib/math/tests/int_pow_kunit.c | 52 ++++++++++++++++++++++++++++++++++
 4 files changed, 65 insertions(+)
 create mode 100644 lib/math/tests/Makefile
 create mode 100644 lib/math/tests/int_pow_kunit.c
lib/Kconfig.debug +9 -0
index a30c03a66172..b0bbd30d4cba 100644
@@ -3051,3 +3051,12 @@ config RUST_KERNEL_DOCTESTS
 endmenu # "Rust"
 
 endmenu # Kernel hacking
+
+config INT_POW_TEST
+       tristate "Integer exponentiation (int_pow) test" if !KUNIT_ALL_TESTS
+       depends on KUNIT
+       default KUNIT_ALL_TESTS
+       help
+         Enable this to test the int_pow maths function KUnit test.
+
+         If unsure, say N
lib/math/Makefile +1 -0
index 91fcdb0c9efe..3c1f92a7459d 100644
@@ -5,5 +5,6 @@ obj-$(CONFIG_CORDIC)		+= cordic.o
 obj-$(CONFIG_PRIME_NUMBERS)	+= prime_numbers.o
 obj-$(CONFIG_RATIONAL)		+= rational.o
 
+obj-$(CONFIG_INT_POW_TEST)  += tests/int_pow_kunit.o
 obj-$(CONFIG_TEST_DIV64)	+= test_div64.o
 obj-$(CONFIG_RATIONAL_KUNIT_TEST) += rational-test.o
lib/math/tests/Makefile new file +3 -0
new file mode 100644
index 000000000000..6a169123320a
@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+obj-$(CONFIG_INT_POW_TEST) += int_pow_kunit.o
lib/math/tests/int_pow_kunit.c new file +52 -0

52 lines not on this page · raw message

Signature · 1 line
2.46.0
#1 lore raw
Quoted 122 lines · Luis Felipe Hernandez

Adds test suite for integer based power function.

---
Changes in v3:
- Fix compiler warning: explicitly define constant as unsigned int
- Add changes in patch revisions
Changes in v2:
- Address review feedback
- Add kconfig entry
- Use correct dir and file convention for KUnit
- Fix typo
- Remove unused static_stub header
- Refactor test suite to use paramerterized test cases
- Add close to max allowable value to in large_result test case
- Add test case with non-power of two exponent
- Fix module license

---
 lib/Kconfig.debug              |  9 ++++++
 lib/math/Makefile              |  1 +
 lib/math/tests/Makefile        |  3 ++
 lib/math/tests/int_pow_kunit.c | 52 ++++++++++++++++++++++++++++++++++
 4 files changed, 65 insertions(+)
 create mode 100644 lib/math/tests/Makefile
 create mode 100644 lib/math/tests/int_pow_kunit.c
lib/Kconfig.debug +9 -0
index a30c03a66172..b0bbd30d4cba 100644
@@ -3051,3 +3051,12 @@ config RUST_KERNEL_DOCTESTS
 endmenu # "Rust"
 
 endmenu # Kernel hacking
+
+config INT_POW_TEST
+       tristate "Integer exponentiation (int_pow) test" if !KUNIT_ALL_TESTS
+       depends on KUNIT
+       default KUNIT_ALL_TESTS
+       help
+         Enable this to test the int_pow maths function KUnit test.
+
+         If unsure, say N
lib/math/Makefile +1 -0
index 91fcdb0c9efe..3c1f92a7459d 100644
@@ -5,5 +5,6 @@ obj-$(CONFIG_CORDIC)          += cordic.o
 obj-$(CONFIG_PRIME_NUMBERS)  += prime_numbers.o
 obj-$(CONFIG_RATIONAL)               += rational.o
 
+obj-$(CONFIG_INT_POW_TEST)  += tests/int_pow_kunit.o
 obj-$(CONFIG_TEST_DIV64)     += test_div64.o
 obj-$(CONFIG_RATIONAL_KUNIT_TEST) += rational-test.o
lib/math/tests/Makefile new file +3 -0
new file mode 100644
index 000000000000..6a169123320a
@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+obj-$(CONFIG_INT_POW_TEST) += int_pow_kunit.o
lib/math/tests/int_pow_kunit.c new file +52 -1
new file mode 100644
index 000000000000..e04dd73dabd1
@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#include <kunit/test.h>
+#include <linux/math.h>
+
+struct test_case_params {
+     u64 base;
+     unsigned int exponent;
+     u64 expected_result;
+     const char *name;
+};
+
+static const struct test_case_params params[] = {
+     { 64, 0, 1, "Power of zero" },
+     { 64, 1, 64, "Power of one"},
+     { 0, 5, 0, "Base zero" },
+     { 1, 64, 1, "Base one" },
+     { 2, 2, 4, "Two squared"},
+     { 2, 3, 8, "Two cubed"},
+     { 5, 5, 3125, "Five raised to the fith power" },
+     { U64_MAX, 1, U64_MAX, "Max base" },
+     { 2, 63, 9223372036854775808ULL, "Large result"},
+};
+
+static void get_desc(const struct test_case_params *tc, char *desc)
+{
+     strscpy(desc, tc->name, KUNIT_PARAM_DESC_SIZE);
+}
+
+KUNIT_ARRAY_PARAM(int_pow, params, get_desc);
+
+static void int_pow_test(struct kunit *test)
+{
+     const struct test_case_params *tc = (const struct test_case_params *)test->param_value;
+
+     KUNIT_EXPECT_EQ(test, tc->expected_result, int_pow(tc->base, tc->exponent));
+}
+
+static struct kunit_case math_int_pow_test_cases[] = {
+     KUNIT_CASE_PARAM(int_pow_test, int_pow_gen_params),
+     {}
+};
+
+static struct kunit_suite int_pow_test_suite = {
+     .name = "math-int_pow",
+     .test_cases = math_int_pow_test_cases,
+};
+
+kunit_test_suites(&int_pow_test_suite);
+
+MODULE_DESCRIPTION("math.int_pow KUnit test suite");
+MODULE_LICENSE("GPL");
--
Quoted 2 lines

2.46.0

Hello,

I wanted to follow up on the last patch version (v3) and see if there is feedback on any areas I can further improve in the test suite and/or commit message as
well as if there was any further work I could help with regarding the organization of the other tests located in /lib/math such that they also live in /lib/math/tests in order to keep consistent.

Thank you,

Felipe

Reviewed-by on v3 1/1
#2 lore raw
In reply to Luis Felipe Hernandez
Quoted 4 lines · Luis Felipe Hernandez

Adds test suite for integer based power function.

Quoted 15 lines

---
Changes in v3:
- Fix compiler warning: explicitly define constant as unsigned int
- Add changes in patch revisions
Changes in v2:
- Address review feedback
- Add kconfig entry
- Use correct dir and file convention for KUnit
- Fix typo
- Remove unused static_stub header
- Refactor test suite to use paramerterized test cases
- Add close to max allowable value to in large_result test case
- Add test case with non-power of two exponent
- Fix module license
---

This looks pretty good to me, thanks!

A few very minor nitpicks below, but nothing serious.

With those fixed, this is:

Cheers,
-- David

Quoted 15 lines
 lib/Kconfig.debug              |  9 ++++++
 lib/math/Makefile              |  1 +
 lib/math/tests/Makefile        |  3 ++
 lib/math/tests/int_pow_kunit.c | 52 ++++++++++++++++++++++++++++++++++
 4 files changed, 65 insertions(+)
 create mode 100644 lib/math/tests/Makefile
 create mode 100644 lib/math/tests/int_pow_kunit.c
lib/Kconfig.debug +0 -0
index a30c03a66172..b0bbd30d4cba 100644
@@ -3051,3 +3051,12 @@ config RUST_KERNEL_DOCTESTS
 endmenu # "Rust"
 

lib/Kconfig.debug config RUST_KERNEL_DOCTESTS · line 3062

Quoted 10 lines
lib/Kconfig.debug +9 -0
 endmenu # Kernel hacking
+
+config INT_POW_TEST
+       tristate "Integer exponentiation (int_pow) test" if !KUNIT_ALL_TESTS
+       depends on KUNIT
+       default KUNIT_ALL_TESTS
+       help
+         Enable this to test the int_pow maths function KUnit test.
+
+         If unsure, say N

Hmm... checkpatch is still warning that this is too short a description. Maybe we could add a sentence about what int_pow actually does (integer exponentiation?)

Quoted 26 lines
lib/math/Makefile +1 -0
index 91fcdb0c9efe..3c1f92a7459d 100644
@@ -5,5 +5,6 @@ obj-$(CONFIG_CORDIC)            += cordic.o
 obj-$(CONFIG_PRIME_NUMBERS)    += prime_numbers.o
 obj-$(CONFIG_RATIONAL)         += rational.o
 
+obj-$(CONFIG_INT_POW_TEST)  += tests/int_pow_kunit.o
 obj-$(CONFIG_TEST_DIV64)       += test_div64.o
 obj-$(CONFIG_RATIONAL_KUNIT_TEST) += rational-test.o
lib/math/tests/Makefile new file +3 -0
new file mode 100644
index 000000000000..6a169123320a
@@ -0,0 +1,3 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+obj-$(CONFIG_INT_POW_TEST) += int_pow_kunit.o
lib/math/tests/int_pow_kunit.c new file +0 -0
new file mode 100644
index 000000000000..e04dd73dabd1

lib/math/tests/int_pow_kunit.c line 1

Quoted 1 line
lib/math/tests/int_pow_kunit.c new file +1 -0
@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: GPL-2.0

Maybe use GPL-2.0-only for consistency with the above? GPL-2.0 is deprecated, so either GPL-2.0-only or GPL-2.0-or-later should be used where possible.

Quoted 9 lines
lib/math/tests/int_pow_kunit.c new file +9 -0
+
+#include <kunit/test.h>
+#include <linux/math.h>
+
+struct test_case_params {
+       u64 base;
+       unsigned int exponent;
+       u64 expected_result;
+       const char *name;

lib/math/tests/int_pow_kunit.c line 20

Quoted 10 lines
lib/math/tests/int_pow_kunit.c new file +10 -0
+};
+
+static const struct test_case_params params[] = {
+       { 64, 0, 1, "Power of zero" },
+       { 64, 1, 64, "Power of one"},
+       { 0, 5, 0, "Base zero" },
+       { 1, 64, 1, "Base one" },
+       { 2, 2, 4, "Two squared"},
+       { 2, 3, 8, "Two cubed"},
+       { 5, 5, 3125, "Five raised to the fith power" },

Nit: _fiftth_ power

Quoted 35 lines
lib/math/tests/int_pow_kunit.c new file +32 -1
+       { U64_MAX, 1, U64_MAX, "Max base" },
+       { 2, 63, 9223372036854775808ULL, "Large result"},
+};
+
+static void get_desc(const struct test_case_params *tc, char *desc)
+{
+       strscpy(desc, tc->name, KUNIT_PARAM_DESC_SIZE);
+}
+
+KUNIT_ARRAY_PARAM(int_pow, params, get_desc);
+
+static void int_pow_test(struct kunit *test)
+{
+       const struct test_case_params *tc = (const struct test_case_params *)test->param_value;
+
+       KUNIT_EXPECT_EQ(test, tc->expected_result, int_pow(tc->base, tc->exponent));
+}
+
+static struct kunit_case math_int_pow_test_cases[] = {
+       KUNIT_CASE_PARAM(int_pow_test, int_pow_gen_params),
+       {}
+};
+
+static struct kunit_suite int_pow_test_suite = {
+       .name = "math-int_pow",
+       .test_cases = math_int_pow_test_cases,
+};
+
+kunit_test_suites(&int_pow_test_suite);
+
+MODULE_DESCRIPTION("math.int_pow KUnit test suite");
+MODULE_LICENSE("GPL");
--

2.46.0