[PATCH v6 17/18] khwasan: update kasan documentation

On Wed, Sep 12, 2018 at 8:39 PM, Dmitry Vyukov [off-list ref] wrote:

On Wed, Aug 29, 2018 at 1:35 PM, Andrey Konovalov [off-list ref] wrote:

quoted

This patch updates KASAN documentation to reflect the addition of KHWASAN.

quoted

-Currently KASAN is supported only for the x86_64 and arm64 architectures.
+KASAN uses compile-time instrumentation to insert validity checks before every
+memory access, and therefore requires a compiler version that supports that.
+For classic KASAN you need GCC version 4.9.2 or later. GCC 5.0 or later is
+required for detection of out-of-bounds accesses on stack and global variables.
+KHWASAN in turns is only supported in clang and requires revision 330044 or

in turn?

quoted

-and choose between CONFIG_KASAN_OUTLINE and CONFIG_KASAN_INLINE. Outline and
-inline are compiler instrumentation types. The former produces smaller binary
-the latter is 1.1 - 2 times faster. Inline instrumentation requires a GCC
+and choose between CONFIG_KASAN_GENERIC (to enable classic KASAN) and
+CONFIG_KASAN_HW (to enabled KHWASAN). You also need to choose choose between

to enable

quoted

+     print_address_description+0x73/0x280 mm/kasan/report.c:254

KASAN does not print line numbers per se.
I think we need to show unmodified output to not confuse readers
(probably remove the useless ? lines).

Will fix all in v7.