2020-12-03 02:36:00

by Walter Wu

[permalink] [raw]
Subject: [PATCH v5 4/4] kasan: update documentation for generic kasan

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

Signed-off-by: Walter Wu <[email protected]>
Suggested-by: Marco Elver <[email protected]>
Acked-by: Marco Elver <[email protected]>
Reviewed-by: Dmitry Vyukov <[email protected]>
Reviewed-by: Andrey Konovalov <[email protected]>
Cc: Andrey Ryabinin <[email protected]>
Cc: Alexander Potapenko <[email protected]>
Cc: Jonathan Corbet <[email protected]>
---

v4:
- remove timer stack description

v3:
- Thanks for Marco suggestion

---
Documentation/dev-tools/kasan.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
index c09c9ca2ff1c..3cb556ceb4a5 100644
--- a/Documentation/dev-tools/kasan.rst
+++ b/Documentation/dev-tools/kasan.rst
@@ -190,8 +190,9 @@ 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 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() and workqueue queuing.

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