From: Andrey Konovalov <andreyknvl@google.com>
To: David Gow <davidgow@google.com>
Cc: Patricia Alfonso <trishalfonso@google.com>,
Brendan Higgins <brendanhiggins@google.com>,
Andrey Ryabinin <aryabinin@virtuozzo.com>,
Dmitry Vyukov <dvyukov@google.com>,
Ingo Molnar <mingo@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Juri Lelli <juri.lelli@redhat.com>,
Vincent Guittot <vincent.guittot@linaro.org>,
LKML <linux-kernel@vger.kernel.org>,
kasan-dev <kasan-dev@googlegroups.com>,
kunit-dev@googlegroups.com,
"open list:KERNEL SELFTEST FRAMEWORK"
<linux-kselftest@vger.kernel.org>
Subject: Re: [PATCH v7 4/5] KASAN: Testing Documentation
Date: Fri, 24 Apr 2020 15:23:41 +0200 [thread overview]
Message-ID: <CAAeHK+w+y2zAQzmm-uXyFhWBm0VunB7wKPekhjBxajZCD=xEng@mail.gmail.com> (raw)
In-Reply-To: <20200424061342.212535-5-davidgow@google.com>
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:163
> + Expected ptr is not null, but is
> + not 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:629
> + Expected kasan_data->report_expected == kasan_data->report_found, but
> + kasan_data->report_expected == 1
> + kasan_data->report_found == 0
> + not 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%40google.com.
next prev parent reply other threads:[~2020-04-24 13:23 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-24 6:13 [PATCH v7 0/5] KUnit-KASAN Integration David Gow
2020-04-24 6:13 ` [PATCH v7 1/5] Add KUnit Struct to Current Task David Gow
2020-04-24 6:13 ` [PATCH v7 2/5] KUnit: KASAN Integration David Gow
2020-04-24 6:13 ` [PATCH v7 3/5] KASAN: Port KASAN Tests to KUnit David Gow
2020-04-24 6:13 ` [PATCH v7 4/5] KASAN: Testing Documentation David Gow
2020-04-24 13:23 ` Andrey Konovalov [this message]
2020-04-24 6:13 ` [PATCH v7 5/5] mm: kasan: Do not panic if both panic_on_warn and kasan_multishot set David Gow
2020-05-03 10:09 ` [PATCH v7 0/5] KUnit-KASAN Integration Alan Maguire
2020-05-22 22:30 ` shuah
2020-05-27 2:50 ` David Gow
2020-05-28 19:52 ` Brendan Higgins
2020-05-28 20:16 ` Shuah Khan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAAeHK+w+y2zAQzmm-uXyFhWBm0VunB7wKPekhjBxajZCD=xEng@mail.gmail.com' \
--to=andreyknvl@google.com \
--cc=aryabinin@virtuozzo.com \
--cc=brendanhiggins@google.com \
--cc=davidgow@google.com \
--cc=dvyukov@google.com \
--cc=juri.lelli@redhat.com \
--cc=kasan-dev@googlegroups.com \
--cc=kunit-dev@googlegroups.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=trishalfonso@google.com \
--cc=vincent.guittot@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).