2023-01-27 20:40:08

by Rae Moar

[permalink] [raw]

Subject: [PATCH v2] 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]/

Reported-by: kernel test robot <[email protected]>

Signed-off-by: Rae Moar <[email protected]>
Reviewed-by: David Gow <[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(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 87ea90576b50..a20bff149bdf 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -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, \
diff --git a/lib/kunit/assert.c b/lib/kunit/assert.c
index f5b50babe38d..05a09652f5a1 100644
--- a/lib/kunit/assert.c
+++ b/lib/kunit/assert.c
@@ -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

2023-01-28 07:57:39

by David Gow

[permalink] [raw]

Subject: Re: [PATCH v2] kunit: fix bug in KUNIT_EXPECT_MEMEQ

---

On Sat, 28 Jan 2023 at 04:40, Rae Moar <[email protected]> wrote:
>
> 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]/
>
> Reported-by: kernel test robot <[email protected]>
>
> Signed-off-by: Rae Moar <[email protected]>
> Reviewed-by: David Gow <[email protected]>
> ---
>
> Changes since v1:
> - Fix formatting of backslashes
> - Add Fixes: ... statement to commit message
>

Looks good to me, now.

Thanks.
— David

> include/kunit/test.h | 5 +++--
> lib/kunit/assert.c | 40 +++++++++++++++++++++++++---------------
> 2 files changed, 28 insertions(+), 17 deletions(-)
>
> diff --git a/include/kunit/test.h b/include/kunit/test.h
> index 87ea90576b50..a20bff149bdf 100644
> --- a/include/kunit/test.h
> +++ b/include/kunit/test.h
> @@ -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, \
> diff --git a/lib/kunit/assert.c b/lib/kunit/assert.c
> index f5b50babe38d..05a09652f5a1 100644
> --- a/lib/kunit/assert.c
> +++ b/lib/kunit/assert.c
> @@ -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
>

---

Attachments:

smime.p7s (3.91 kB)
S/MIME Cryptographic Signature