lib/math: Add int_sqrt test suite
Subsystems (2)
PATCH v5 1/1 lib/math: Add int_sqrt test suite
Adds test suite for integer based square root function.
The test suite is designed to verify the correctness of the int_sqrt() math library function.
---
Changes in v2
- Add new line at the end of int_sqrt_kunit.c
- Add explicit header includes for MODULE_* macros, strscpy, and ULONG_MAX
Changes in v3
- Remove unnecesary new line after Kconfig entry for INT_SQRT_KUNIT_TEST
- Correct int_sqrt instances with int_sqrt() in commit message and kconfig
entry desc
- Fix limits.h header include path
Changes in v4
- Fix Kconfig entry: remove redundant word test
Changes in v5
- Address review feedback by Nicolas Pitre
- Make edge case portable by not relying on arch dependent macro
- Add more edge cases
--- lib/Kconfig.debug | 15 +++++++++ lib/math/Makefile | 1 + lib/math/tests/Makefile | 1 + lib/math/tests/int_sqrt_kunit.c | 60 +++++++++++++++++++++++++++++++++ 4 files changed, 77 insertions(+) create mode 100644 lib/math/tests/int_sqrt_kunit.c
lib/Kconfig.debug +15 -0
@@ -3161,6 +3161,21 @@ config INT_POW_TEST If unsure, say N +config INT_SQRT_KUNIT_TEST + tristate "Integer square root test" if !KUNIT_ALL_TESTS + depends on KUNIT + default KUNIT_ALL_TESTS + help + This option enables the KUnit test suite for the int_sqrt() function, + which performs square root calculation. The test suite checks + various scenarios, including edge cases, to ensure correctness. + + Enabling this option will include tests that check various scenarios + and edge cases to ensure the accuracy and reliability of the square root + function. + + If unsure, say N + endif # RUNTIME_TESTING_MENU config ARCH_USE_MEMTEST
lib/math/Makefile +1 -0
@@ -9,3 +9,4 @@ obj-$(CONFIG_INT_POW_TEST) += tests/int_pow_kunit.o obj-$(CONFIG_TEST_DIV64) += test_div64.o obj-$(CONFIG_TEST_MULDIV64) += test_mul_u64_u64_div_u64.o obj-$(CONFIG_RATIONAL_KUNIT_TEST) += rational-test.o +obj-y += tests/
lib/math/tests/Makefile +1 -0
@@ -1,3 +1,4 @@ # SPDX-License-Identifier: GPL-2.0-only obj-$(CONFIG_INT_POW_TEST) += int_pow_kunit.o +obj-$(CONFIG_INT_SQRT_KUNIT_TEST) += int_sqrt_kunit.o
lib/math/tests/int_sqrt_kunit.c new file +60 -0
60 lines not on this page · raw message
Signature · 1 line
2.47.1
Quoted 7 lines · Luis Felipe Hernandez
Adds test suite for integer based square root function.
The test suite is designed to verify the correctness of the
int_sqrt()math library function.Signed-off-by Luis Felipe Hernandez <[email protected]>---
I don't know why you CC'ed linux-usb for this patch. But as long as you did...
Quoted 15 lines
lib/math/tests/int_sqrt_kunit.c new file +9
-0@@ -0,0 +1,60 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include <kunit/test.h> +#include <linux/limits.h> +#include <linux/math.h> +#include <linux/module.h> +#include <linux/string.h> + +struct test_case_params {
lib/math/tests/int_sqrt_kunit.c line 19
Quoted 10 lines
lib/math/tests/int_sqrt_kunit.c new file +10
-0+unsigned long x; +unsigned long expected_result; +const char *name; +}; + +static const struct test_case_params params[] = { + {0 ,0 ,"edge case: square root of 0" }, + {1 ,1 ,"perfect square: square root of 1" }, + {2 ,1 ,"non-perfect square: square root of 2" }, + {3 ,1 ,"non-perfect square: sqaure root of 3" },
s/sqau/squa/
lib/math/tests/int_sqrt_kunit.c line 21
Quoted 2 lines
lib/math/tests/int_sqrt_kunit.c new file +2
-0+ { 4, 2, "perfect square: square root of 4" }, + { 5, 2, "non-perfect square: square root of 5" },
s/square root/square root/
lib/math/tests/int_sqrt_kunit.c line 31
Quoted 10 lines
lib/math/tests/int_sqrt_kunit.c new file +10
-0+ { 6, 2, "non-perfect square: square root of 6" }, + { 7, 2, "non-perfect square: square root of 7" }, + { 8, 2, "non-perfect square: square root of 8" }, + { 9, 3, "perfect square: square root of 9" }, + { 16, 4, "perfect square: square root of 16" }, + { 81, 9, "perfect square: square root of 81" }, + { 256, 16, "perfect square: square root of 256" }, + { 2147483648, 46340, "large input: square root of 2147483648" }, + { 4294967295, 65535, "edge case: ULONG_MAX for 32-bit" }, +};
For the higher numbers (16, 81, etc.), you should test N-1 (and maybe also N+1) as well as N.
Alan Stern
On Wed, Dec 11, 2024 at 03:42:33PM -0500, Alan Stern wrote:
Hi Alan,
Thank you for the review and feedback. I apologize about my previous patch, particularly CC'ing the linux-usb list unnecessarily and the spelling errors.
I'll address your suggestions in a subsequent revision of this patch.
Quoted 2 lines
I don't know why you CC'ed linux-usb for this patch. But as long as you did...
This was mas my mistake, I must've pulled it from my bash history of a previous patch I created with git format-patch. I will be more thorough and ensure I use b4 in new patches to help generate the recipients list.
Quoted 4 lines
Quoted 1 line
+ { 3, 1, "non-perfect square: sqaure root of 3" },
s/sqau/squa/
Quoted 1 line
+ { 5, 2, "non-perfect square: square root of 5" },
s/square root/square root/
I failed to run checkpatch with --strict --codespell, it could've easily caught this. I'll update my post-commit hook to prevent missing this step in the future.
I'll update these accoridngly:
{ 3, 1, "non-perfect square: square root of 3" },
...
{ 5, 2, "non-perfect square: square root of 5" },
Quoted 2 lines
For the higher numbers (16, 81, etc.), you should test N-1 (and maybe also N+1) as well as N.
Good point, I'm assuming this will help ensure the test suite validates int_sqrt() behavior around the boundaries of a perfect square.
I'll add the following test cases as per your suggestion:
{ 15, 3, "non-perfect square: square root of 15 (N-1 from 16)" }, { 16, 4, "perfect square: square root of 16" },
{ 17, 4, "non-perfect square: square root of 17 (N+1 from 16)" }, { 80, 8, "non-perfect square: square root of 80 (N-1 from 81)" }, { 81, 9, "perfect square: square root of 81" },
{ 82, 9, "non-perfect square: square root of 82 (N+1 from 81)" }, { 255, 15, "non-perfect square: square root of 255 (N-1 from 256)" }, { 256, 16, "perfect square: square root of 256" },
{ 257, 16, "non-perfect square: square root of 257 (N+1 from 256)" },
Thank you for your time Alan, and again I apologize to you and the linux-usb mailing list.
Best,
Felipe