Skip to contentSkip to conversation

kunit: memcpy: Split slow memcpy tests into MEMCPY_SLOW_KUNIT_TEST

PATCH Superseded Kees Cook 3 participants 4 messages Jan 14, 2023 Library code

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 kunit: memcpy: Split slow memcpy tests into MEMCPY_SLOW_KUNIT_TEST

Since the long memcpy tests may stall a system for tens of seconds in virtualized architecture environments, split those tests off under CONFIG_MEMCPY_SLOW_KUNIT_TEST so they can be separately disabled.

---
v2: fix tristate to bool
v1: https://lore.kernel.org/lkml/[email protected]

---
 lib/Kconfig.debug  |  9 +++++++++
 lib/memcpy_kunit.c | 15 ++++++++++++---
 2 files changed, 21 insertions(+), 3 deletions(-)
lib/Kconfig.debug +9 -0
index c2c78d0e761c..f90637171453 100644
@@ -2621,6 +2621,15 @@ config MEMCPY_KUNIT_TEST
 
 	  If unsure, say N.
 
+config MEMCPY_SLOW_KUNIT_TEST
+	bool "Include exhaustive memcpy tests" if !KUNIT_ALL_TESTS
+	depends on MEMCPY_KUNIT_TEST
+	default KUNIT_ALL_TESTS
+	help
+	  Some memcpy tests are quite exhaustive in checking for overlaps
+	  and bit ranges. These can be very slow, so they are split out
+	  as a separate config.
+
 config IS_SIGNED_TYPE_KUNIT_TEST
 	tristate "Test is_signed_type() macro" if !KUNIT_ALL_TESTS
 	depends on KUNIT
lib/memcpy_kunit.c +12 -3
index 89128551448d..5a545e1b5dbb 100644
@@ -307,8 +307,12 @@ static void set_random_nonzero(struct kunit *test, u8 *byte)
 	}
 }
 
-static void init_large(struct kunit *test)
+static int init_large(struct kunit *test)
 {
+	if (!IS_ENABLED(CONFIG_MEMCPY_SLOW_KUNIT_TEST)) {
+		kunit_skip(test, "Slow test skipped. Enable with CONFIG_MEMCPY_SLOW_KUNIT_TEST=y");
+		return -EBUSY;
+	}
 
 	/* Get many bit patterns. */
 	get_random_bytes(large_src, ARRAY_SIZE(large_src));
@@ -319,6 +323,8 @@ static void init_large(struct kunit *test)
 
 	/* Explicitly zero the entire destination. */
 	memset(large_dst, 0, ARRAY_SIZE(large_dst));
+
+	return 0;
 }
 
 /*
@@ -327,7 +333,9 @@ static void init_large(struct kunit *test)
  */
 static void copy_large_test(struct kunit *test, bool use_memmove)
 {
-	init_large(test);
+
+	if (init_large(test))
+		return;
 
 	/* Copy a growing number of non-overlapping bytes ... */
 	for (int bytes = 1; bytes <= ARRAY_SIZE(large_src); bytes++) {
@@ -472,7 +480,8 @@ static void memmove_overlap_test(struct kunit *test)
 	static const int bytes_start = 1;
 	static const int bytes_end = ARRAY_SIZE(large_src) + 1;
 
-	init_large(test);
+	if (init_large(test))
+		return;
 
 	/* Copy a growing number of overlapping bytes ... */
 	for (int bytes = bytes_start; bytes < bytes_end;
Signature · 1 line
2.34.1
author
#1 lore raw

gah. this is actually v2. :(

Quoted 92 lines · Kees Cook

Since the long memcpy tests may stall a system for tens of seconds in virtualized architecture environments, split those tests off under CONFIG_MEMCPY_SLOW_KUNIT_TEST so they can be separately disabled.

---
v2: fix tristate to bool
v1: https://lore.kernel.org/lkml/[email protected]

---
 lib/Kconfig.debug  |  9 +++++++++
 lib/memcpy_kunit.c | 15 ++++++++++++---
 2 files changed, 21 insertions(+), 3 deletions(-)
lib/Kconfig.debug +9 -0
index c2c78d0e761c..f90637171453 100644
@@ -2621,6 +2621,15 @@ config MEMCPY_KUNIT_TEST
 
 	  If unsure, say N.
 
+config MEMCPY_SLOW_KUNIT_TEST
+	bool "Include exhaustive memcpy tests" if !KUNIT_ALL_TESTS
+	depends on MEMCPY_KUNIT_TEST
+	default KUNIT_ALL_TESTS
+	help
+	  Some memcpy tests are quite exhaustive in checking for overlaps
+	  and bit ranges. These can be very slow, so they are split out
+	  as a separate config.
+
 config IS_SIGNED_TYPE_KUNIT_TEST
 	tristate "Test is_signed_type() macro" if !KUNIT_ALL_TESTS
 	depends on KUNIT
lib/memcpy_kunit.c +12 -3
index 89128551448d..5a545e1b5dbb 100644
@@ -307,8 +307,12 @@ static void set_random_nonzero(struct kunit *test, u8 *byte)
 	}
 }
 
-static void init_large(struct kunit *test)
+static int init_large(struct kunit *test)
 {
+	if (!IS_ENABLED(CONFIG_MEMCPY_SLOW_KUNIT_TEST)) {
+		kunit_skip(test, "Slow test skipped. Enable with CONFIG_MEMCPY_SLOW_KUNIT_TEST=y");
+		return -EBUSY;
+	}
 
 	/* Get many bit patterns. */
 	get_random_bytes(large_src, ARRAY_SIZE(large_src));
@@ -319,6 +323,8 @@ static void init_large(struct kunit *test)
 
 	/* Explicitly zero the entire destination. */
 	memset(large_dst, 0, ARRAY_SIZE(large_dst));
+
+	return 0;
 }
 
 /*
@@ -327,7 +333,9 @@ static void init_large(struct kunit *test)
  */
 static void copy_large_test(struct kunit *test, bool use_memmove)
 {
-	init_large(test);
+
+	if (init_large(test))
+		return;
 
 	/* Copy a growing number of non-overlapping bytes ... */
 	for (int bytes = 1; bytes <= ARRAY_SIZE(large_src); bytes++) {
@@ -472,7 +480,8 @@ static void memmove_overlap_test(struct kunit *test)
 	static const int bytes_start = 1;
 	static const int bytes_end = ARRAY_SIZE(large_src) + 1;
 
-	init_large(test);
+	if (init_large(test))
+		return;
 
 	/* Copy a growing number of overlapping bytes ... */
 	for (int bytes = bytes_start; bytes < bytes_end;
Signature · 1 line
2.34.1
Signature · 1 line
Kees Cook
#2 lore raw
In reply to Kees Cook
Quoted 5 lines · Kees Cook
lib/memcpy_kunit.c +0 -0
index 89128551448d..5a545e1b5dbb 100644

lib/memcpy_kunit.c static void set_random_nonzero(struct kunit *test, u8 *byte) · line 314

Quoted 9 lines
lib/memcpy_kunit.c +4 -1
@@ -307,8 +307,12 @@ static void set_random_nonzero(struct kunit *test, u8 *byte)
        }
 }
 
-static void init_large(struct kunit *test)
+static int init_large(struct kunit *test)
 {
+       if (!IS_ENABLED(CONFIG_MEMCPY_SLOW_KUNIT_TEST)) {
+               kunit_skip(test, "Slow test skipped. Enable with CONFIG_MEMCPY_SLOW_KUNIT_TEST=y");
+               return -EBUSY;

Note: kunit_skip() here means you don't need explicit returns in the test cases. kunit_skip() is basically
kunit_mark_skipped(test, "reason"); kthread_complete_and_exit(...);

So the diff in this file could be reduced down to just these 2 lines
if (!IS_ENABLED(...))

      kunit_skip(test, "...")

But I can see the appeal of being more explicit about the control flow. In that case, you could switch kunit_mark_skipped(), which just sets the status and doesn't affect control flow at all.

Daniel

#3 lore raw
In reply to Kees Cook
Quoted 14 lines · Kees Cook

Since the long memcpy tests may stall a system for tens of seconds in virtualized architecture environments, split those tests off under CONFIG_MEMCPY_SLOW_KUNIT_TEST so they can be separately disabled.

Quoted 1 line

---

Thanks: this is okay as-is, but I left a few suggestions below, having tried it out a bit more.

Daniel's comment about kunit_skip() aborting the test is the only real fix, but depending on how easy you'd want to make turning these tests off, there are a couple of possible tweaks to the Kconfig option.

Cheers,
-- David

Quoted 12 lines

v2: fix tristate to bool
v1: https://lore.kernel.org/lkml/[email protected]

---
 lib/Kconfig.debug  |  9 +++++++++
 lib/memcpy_kunit.c | 15 ++++++++++++---
 2 files changed, 21 insertions(+), 3 deletions(-)
lib/Kconfig.debug +0 -0
index c2c78d0e761c..f90637171453 100644

lib/Kconfig.debug config MEMCPY_KUNIT_TEST · line 2625

Quoted 5 lines
lib/Kconfig.debug +2 -0
@@ -2621,6 +2621,15 @@ config MEMCPY_KUNIT_TEST
 
          If unsure, say N.
 
+config MEMCPY_SLOW_KUNIT_TEST
+       bool "Include exhaustive memcpy tests" if !KUNIT_ALL_TESTS

I think it'd be better to not include the "if !KUNIT_ALL_TESTS" here, because it's very convenient to be able to use:
./tools/testing/kunit/kunit.py run memcpy --kconfig_add CONFIG_MEMCPY_SLOW_KUNIT_TEST=n
to override it.

That does undermine the way KUNIT_ALL_TESTS works a bit, though it depends if you want to consider this a new set of tests, or just an option for the existing ones.

lib/Kconfig.debug config MEMCPY_KUNIT_TEST · line 2627

Quoted 2 lines
lib/Kconfig.debug +2 -0
+       depends on MEMCPY_KUNIT_TEST
+       default KUNIT_ALL_TESTS

Does this default work for everyone? Personally, I think these tests aren't slow enough that we'd want them disabled from an "all tests" build by default. So I'd keep it as-is.

Quoted 13 lines
lib/Kconfig.debug +5 -0
+       help
+         Some memcpy tests are quite exhaustive in checking for overlaps
+         and bit ranges. These can be very slow, so they are split out
+         as a separate config.
+
 config IS_SIGNED_TYPE_KUNIT_TEST
        tristate "Test is_signed_type() macro" if !KUNIT_ALL_TESTS
        depends on KUNIT
lib/memcpy_kunit.c +0 -0
index 89128551448d..5a545e1b5dbb 100644

lib/memcpy_kunit.c static void set_random_nonzero(struct kunit *test, u8 *byte) · line 314

Quoted 9 lines
lib/memcpy_kunit.c +4 -1
@@ -307,8 +307,12 @@ static void set_random_nonzero(struct kunit *test, u8 *byte)
        }
 }
 
-static void init_large(struct kunit *test)
+static int init_large(struct kunit *test)
 {
+       if (!IS_ENABLED(CONFIG_MEMCPY_SLOW_KUNIT_TEST)) {
+               kunit_skip(test, "Slow test skipped. Enable with CONFIG_MEMCPY_SLOW_KUNIT_TEST=y");
+               return -EBUSY;

As Daniel notes, it shouldn't be necessary to return here, as kunit_skip() will abort the test. (It's a macro, so isn't marked __noreturn itself, but kunit_try_catch_throw(), which it uses, is.)

Quoted 37 lines
lib/memcpy_kunit.c +8 -3
+       }
 
        /* Get many bit patterns. */
        get_random_bytes(large_src, ARRAY_SIZE(large_src));
@@ -319,6 +323,8 @@ static void init_large(struct kunit *test)
 
        /* Explicitly zero the entire destination. */
        memset(large_dst, 0, ARRAY_SIZE(large_dst));
+
+       return 0;
 }
 
 /*
@@ -327,7 +333,9 @@ static void init_large(struct kunit *test)
  */
 static void copy_large_test(struct kunit *test, bool use_memmove)
 {
-       init_large(test);
+
+       if (init_large(test))
+               return;
 
        /* Copy a growing number of non-overlapping bytes ... */
        for (int bytes = 1; bytes <= ARRAY_SIZE(large_src); bytes++) {
@@ -472,7 +480,8 @@ static void memmove_overlap_test(struct kunit *test)
        static const int bytes_start = 1;
        static const int bytes_end = ARRAY_SIZE(large_src) + 1;
 
-       init_large(test);
+       if (init_large(test))
+               return;
 
        /* Copy a growing number of overlapping bytes ... */
        for (int bytes = bytes_start; bytes < bytes_end;
--

2.34.1