On Fri, Apr 24, 2020 at 8:14 AM 'David Gow' via kasan-dev kasan-dev@googlegroups.com wrote:
From: Patricia Alfonso trishalfonso@google.com
Include documentation on how to test KASAN using CONFIG_TEST_KASAN_KUNIT and CONFIG_TEST_KASAN_MODULE.
Signed-off-by: Patricia Alfonso trishalfonso@google.com Reviewed-by: Dmitry Vyukov dvyukov@google.com Signed-off-by: David Gow davidgow@google.com
Reviewed-by: Andrey Konovalov andreyknvl@google.com
Documentation/dev-tools/kasan.rst | 70 +++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+)
diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst index c652d740735d..b4b109d88f9e 100644 --- a/Documentation/dev-tools/kasan.rst +++ b/Documentation/dev-tools/kasan.rst @@ -281,3 +281,73 @@ unmapped. This will require changes in arch-specific code.
This allows ``VMAP_STACK`` support on x86, and can simplify support of architectures that do not have a fixed module region.
+CONFIG_TEST_KASAN_KUNIT & CONFIG_TEST_KASAN_MODULE +--------------------------------------------------
+``CONFIG_TEST_KASAN_KUNIT`` utilizes the KUnit Test Framework for testing. +This means each test focuses on a small unit of functionality and +there are a few ways these tests can be run.
+Each test will print the KASAN report if an error is detected and then +print the number of the test and the status of the test:
+pass::
ok 28 - kmalloc_double_kzfree+or, if kmalloc failed::
# kmalloc_large_oob_right: ASSERTION FAILED at lib/test_kasan.c:163Expected ptr is not null, but isnot ok 4 - kmalloc_large_oob_right+or, if a KASAN report was expected, but not found::
# kmalloc_double_kzfree: EXPECTATION FAILED at lib/test_kasan.c:629Expected kasan_data->report_expected == kasan_data->report_found, butkasan_data->report_expected == 1kasan_data->report_found == 0not ok 28 - kmalloc_double_kzfree+All test statuses are tracked as they run and an overall status will +be printed at the end::
ok 1 - kasan_kunit_test+or::
not ok 1 - kasan_kunit_test+(1) Loadable Module +~~~~~~~~~~~~~~~~~~~~
+With ``CONFIG_KUNIT`` enabled, ``CONFIG_TEST_KASAN_KUNIT`` can be built as +a loadable module and run on any architecture that supports KASAN +using something like insmod or modprobe.
+(2) Built-In +~~~~~~~~~~~~~
+With ``CONFIG_KUNIT`` built-in, ``CONFIG_TEST_KASAN_KUNIT`` can be built-in +on any architecure that supports KASAN. These and any other KUnit +tests enabled will run and print the results at boot as a late-init +call.
+(3) Using kunit_tool +~~~~~~~~~~~~~~~~~~~~~
+With ``CONFIG_KUNIT`` and ``CONFIG_TEST_KASAN_KUNIT`` built-in, we can also +use kunit_tool to see the results of these along with other KUnit +tests in a more readable way. This will not print the KASAN reports +of tests that passed. Use `KUnit documentation https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html`_ for more up-to-date +information on kunit_tool.
+.. _KUnit: https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html
+``CONFIG_TEST_KASAN_MODULE`` is a set of KASAN tests that could not be +converted to KUnit. These tests can be run only as a module with +``CONFIG_TEST_KASAN_MODULE`` built as a loadable module and +``CONFIG_KASAN`` built-in. The type of error expected and the +function being run is printed before the expression expected to give +an error. Then the error is printed, if found, and that test +should be interpretted to pass only if the error was the one expected
+by the test.
2.26.2.303.gf8c07b1a785-goog
-- You received this message because you are subscribed to the Google Groups "kasan-dev" group. To unsubscribe from this group and stop receiving emails from it, send an email to kasan-dev+unsubscribe@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/kasan-dev/20200424061342.212535-5-davidgow....