kunit: Always print actual pointer values in asserts
authorDavid Gow <davidgow@google.com>
Thu, 21 Nov 2019 23:50:58 +0000 (15:50 -0800)
committerShuah Khan <skhan@linuxfoundation.org>
Wed, 25 Mar 2020 18:12:33 +0000 (12:12 -0600)
KUnit assertions and expectations will print the values being tested. If
these are pointers (e.g., KUNIT_EXPECT_PTR_EQ(test, a, b)), these
pointers are currently printed with the %pK format specifier, which -- to
prevent information leaks which may compromise, e.g., ASLR -- are often
either hashed or replaced with ____ptrval____ or similar, making debugging
tests difficult.

By replacing %pK with %px as Documentation/core-api/printk-formats.rst
suggests, we disable this security feature for KUnit assertions and
expectations, allowing the actual pointer values to be printed. Given
that KUnit is not intended for use in production kernels, and the
pointers are only printed on failing tests, this seems like a worthwhile
tradeoff.

Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
lib/kunit/assert.c

index b24bebc..02ecd0d 100644 (file)
@@ -118,10 +118,10 @@ void kunit_binary_ptr_assert_format(const struct kunit_assert *assert,
                         binary_assert->left_text,
                         binary_assert->operation,
                         binary_assert->right_text);
-       string_stream_add(stream, "\t\t%s == %pK\n",
+       string_stream_add(stream, "\t\t%s == %px\n",
                         binary_assert->left_text,
                         binary_assert->left_value);
-       string_stream_add(stream, "\t\t%s == %pK",
+       string_stream_add(stream, "\t\t%s == %px",
                         binary_assert->right_text,
                         binary_assert->right_value);
        kunit_assert_print_msg(assert, stream);