Skip to contentSkip to conversation

kunit: fix bug in KUNIT_EXPECT_MEMEQ

PATCH In review Rae Moar 2 participants 2 messages Jan 27, 2023 – Jan 28, 2023

Subsystems (2)
lore
Share & tools
lore

Rae Moar

author
#0 lore raw

PATCH v2 1/1 kunit: fix bug in KUNIT_EXPECT_MEMEQ

In KUNIT_EXPECT_MEMEQ and KUNIT_EXPECT_MEMNEQ, add check if one of the inputs is NULL and fail if this is the case.

Currently, the kernel crashes if one of the inputs is NULL. Instead, fail the test and add an appropriate error message.

Fixes b8a926bea8b1 ("kunit: Introduce KUNIT_EXPECT_MEMEQ and KUNIT_EXPECT_MEMNEQ macros")

This was found by the kernel test robot:
https://lore.kernel.org/all/[email protected]/

---

Changes since v1:
- Fix formatting of backslashes
- Add Fixes: ... statement to commit message

 include/kunit/test.h |  5 +++--
 lib/kunit/assert.c   | 40 +++++++++++++++++++++++++---------------
 2 files changed, 28 insertions(+), 17 deletions(-)
include/kunit/test.h +3 -2
index 87ea90576b50..a20bff149bdf 100644
@@ -683,8 +683,9 @@ do {									       \
 		.right_text = #right,					       \
 	};								       \
 									       \
-	if (likely(memcmp(__left, __right, __size) op 0))		       \
-		break;							       \
+	if (likely(__left && __right))					       \
+		if (likely(memcmp(__left, __right, __size) op 0))	       \
+			break;						       \
 									       \
 	_KUNIT_FAILED(test,						       \
 		      assert_type,					       \
lib/kunit/assert.c +25 -15
index f5b50babe38d..05a09652f5a1 100644
@@ -241,24 +241,34 @@ void kunit_mem_assert_format(const struct kunit_assert *assert,
 	mem_assert = container_of(assert, struct kunit_mem_assert,
 				  assert);
 
-	string_stream_add(stream,
-			  KUNIT_SUBTEST_INDENT "Expected %s %s %s, but\n",
-			  mem_assert->text->left_text,
-			  mem_assert->text->operation,
-			  mem_assert->text->right_text);
+	if (!mem_assert->left_value) {
+		string_stream_add(stream,
+				  KUNIT_SUBTEST_INDENT "Expected %s is not null, but is\n",
+				  mem_assert->text->left_text);
+	} else if (!mem_assert->right_value) {
+		string_stream_add(stream,
+				  KUNIT_SUBTEST_INDENT "Expected %s is not null, but is\n",
+				  mem_assert->text->right_text);
+	} else {
+		string_stream_add(stream,
+				KUNIT_SUBTEST_INDENT "Expected %s %s %s, but\n",
+				mem_assert->text->left_text,
+				mem_assert->text->operation,
+				mem_assert->text->right_text);
 
-	string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
-			  mem_assert->text->left_text);
-	kunit_assert_hexdump(stream, mem_assert->left_value,
-			     mem_assert->right_value, mem_assert->size);
+		string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
+				mem_assert->text->left_text);
+		kunit_assert_hexdump(stream, mem_assert->left_value,
+					mem_assert->right_value, mem_assert->size);
 
-	string_stream_add(stream, "\n");
+		string_stream_add(stream, "\n");
 
-	string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
-			  mem_assert->text->right_text);
-	kunit_assert_hexdump(stream, mem_assert->right_value,
-			     mem_assert->left_value, mem_assert->size);
+		string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
+				mem_assert->text->right_text);
+		kunit_assert_hexdump(stream, mem_assert->right_value,
+					mem_assert->left_value, mem_assert->size);
 
-	kunit_assert_print_msg(message, stream);
+		kunit_assert_print_msg(message, stream);
+	}
 }
 EXPORT_SYMBOL_GPL(kunit_mem_assert_format);

base-commit: 5835ffc27381c2d32c3f0d7b575cb3397555ab47

Signature · 1 line
2.39.1.456.gfc5497dd1b-goog
#1 lore raw
Quoted 14 lines · Rae Moar

In KUNIT_EXPECT_MEMEQ and KUNIT_EXPECT_MEMNEQ, add check if one of the inputs is NULL and fail if this is the case.

Currently, the kernel crashes if one of the inputs is NULL. Instead, fail the test and add an appropriate error message.

Fixes b8a926bea8b1 ("kunit: Introduce KUNIT_EXPECT_MEMEQ and KUNIT_EXPECT_MEMNEQ macros")

This was found by the kernel test robot:
https://lore.kernel.org/all/[email protected]/

Quoted 8 lines

---

Changes since v1:
- Fix formatting of backslashes
- Add Fixes: ... statement to commit message

Looks good to me, now.

Thanks.
— David

Quoted 79 lines
 include/kunit/test.h |  5 +++--
 lib/kunit/assert.c   | 40 +++++++++++++++++++++++++---------------
 2 files changed, 28 insertions(+), 17 deletions(-)
include/kunit/test.h +3 -2
index 87ea90576b50..a20bff149bdf 100644
@@ -683,8 +683,9 @@ do {                                                                               \
                .right_text = #right,                                          \
        };                                                                     \
                                                                               \
-       if (likely(memcmp(__left, __right, __size) op 0))                      \
-               break;                                                         \
+       if (likely(__left && __right))                                         \
+               if (likely(memcmp(__left, __right, __size) op 0))              \
+                       break;                                                 \
                                                                               \
        _KUNIT_FAILED(test,                                                    \
                      assert_type,                                             \
lib/kunit/assert.c +25 -15
index f5b50babe38d..05a09652f5a1 100644
@@ -241,24 +241,34 @@ void kunit_mem_assert_format(const struct kunit_assert *assert,
        mem_assert = container_of(assert, struct kunit_mem_assert,
                                  assert);
 
-       string_stream_add(stream,
-                         KUNIT_SUBTEST_INDENT "Expected %s %s %s, but\n",
-                         mem_assert->text->left_text,
-                         mem_assert->text->operation,
-                         mem_assert->text->right_text);
+       if (!mem_assert->left_value) {
+               string_stream_add(stream,
+                                 KUNIT_SUBTEST_INDENT "Expected %s is not null, but is\n",
+                                 mem_assert->text->left_text);
+       } else if (!mem_assert->right_value) {
+               string_stream_add(stream,
+                                 KUNIT_SUBTEST_INDENT "Expected %s is not null, but is\n",
+                                 mem_assert->text->right_text);
+       } else {
+               string_stream_add(stream,
+                               KUNIT_SUBTEST_INDENT "Expected %s %s %s, but\n",
+                               mem_assert->text->left_text,
+                               mem_assert->text->operation,
+                               mem_assert->text->right_text);
 
-       string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
-                         mem_assert->text->left_text);
-       kunit_assert_hexdump(stream, mem_assert->left_value,
-                            mem_assert->right_value, mem_assert->size);
+               string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
+                               mem_assert->text->left_text);
+               kunit_assert_hexdump(stream, mem_assert->left_value,
+                                       mem_assert->right_value, mem_assert->size);
 
-       string_stream_add(stream, "\n");
+               string_stream_add(stream, "\n");
 
-       string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
-                         mem_assert->text->right_text);
-       kunit_assert_hexdump(stream, mem_assert->right_value,
-                            mem_assert->left_value, mem_assert->size);
+               string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s ==\n",
+                               mem_assert->text->right_text);
+               kunit_assert_hexdump(stream, mem_assert->right_value,
+                                       mem_assert->left_value, mem_assert->size);
 
-       kunit_assert_print_msg(message, stream);
+               kunit_assert_print_msg(message, stream);
+       }
 }
 EXPORT_SYMBOL_GPL(kunit_mem_assert_format);

base-commit: 5835ffc27381c2d32c3f0d7b575cb3397555ab47 --
2.39.1.456.gfc5497dd1b-goog