2020-08-24 08:17:44

by Walter Wu

Subject: [PATCH v2 6/6] kasan: update documentation for generic kasan

Generic KASAN support to record the last two timer and workqueue
stacks and print them in KASAN report. So that need to update
documentation.

Signed-off-by: Walter Wu <[email protected]>
Cc: Andrey Ryabinin <[email protected]>
Cc: Dmitry Vyukov <[email protected]>
Cc: Alexander Potapenko <[email protected]>
Cc: Jonathan Corbet <[email protected]>
---
Documentation/dev-tools/kasan.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
index fede42e6536b..5a4c5da8bda8 100644
--- a/Documentation/dev-tools/kasan.rst
+++ b/Documentation/dev-tools/kasan.rst
@@ -193,8 +193,8 @@ function calls GCC directly inserts the code to check the shadow memory.
This option significantly enlarges kernel but it gives x1.1-x2 performance
boost over outline instrumented kernel.

-Generic KASAN prints up to 2 call_rcu() call stacks in reports, the last one
-and the second to last.
+Generic KASAN prints up to 2 call_rcu() call stacks, timer queueing stacks,
+or workqueue queueing stacks in reports, the last one and the second to last.

Software tag-based KASAN
~~~~~~~~~~~~~~~~~~~~~~~~
--
2.18.0

2020-08-24 11:47:48

by Marco Elver

Subject: Re: [PATCH v2 6/6] kasan: update documentation for generic kasan

On Mon, 24 Aug 2020 at 10:14, Walter Wu <[email protected]> wrote:
>
> Generic KASAN support to record the last two timer and workqueue
> stacks and print them in KASAN report. So that need to update
> documentation.
>
> Signed-off-by: Walter Wu <[email protected]>
> Cc: Andrey Ryabinin <[email protected]>
> Cc: Dmitry Vyukov <[email protected]>
> Cc: Alexander Potapenko <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> ---
> Documentation/dev-tools/kasan.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
> index fede42e6536b..5a4c5da8bda8 100644
> --- a/Documentation/dev-tools/kasan.rst
> +++ b/Documentation/dev-tools/kasan.rst
> @@ -193,8 +193,8 @@ function calls GCC directly inserts the code to check the shadow memory.
> This option significantly enlarges kernel but it gives x1.1-x2 performance
> boost over outline instrumented kernel.
>
> -Generic KASAN prints up to 2 call_rcu() call stacks in reports, the last one
> -and the second to last.
> +Generic KASAN prints up to 2 call_rcu() call stacks, timer queueing stacks,
> +or workqueue queueing stacks in reports, the last one and the second to last.

We could make this more readable by writing something like this:

"Generic KASAN also reports the last 2 call stacks to creation of work
that potentially has access to an object. Call stacks for the
following are shown: call_rcu(), timer and workqueue queuing."

Thanks,
-- Marco