Skip to contentSkip to conversation

kasan: update documentation for generic kasan

PATCH In review Walter Wu 1 participant 1 message Dec 3, 2020

Subsystems (4)
lore
Share & tools
lore

Walter Wu

author
#0 lore raw

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.

---

v4:
- remove timer stack description

v3:
- Thanks for Marco suggestion

---
 Documentation/dev-tools/kasan.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/dev-tools/kasan.rst +3 -2
index c09c9ca2ff1c..3cb556ceb4a5 100644
@@ -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
 ~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.18.0