git: 777a0f30b3 - main - developers-handbook/kerneldebug: Document KASAN and KMSAN

Mark Johnston <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by markj (src committer):

URL: https://cgit.FreeBSD.org/doc/commit/?id=777a0f30b349615db6feba4b48383dc1723e22e7

commit 777a0f30b349615db6feba4b48383dc1723e22e7
Author:     Mark Johnston <[email protected]>
AuthorDate: 2021-07-13 21:32:19 +0000
Commit:     Mark Johnston <[email protected]>
CommitDate: 2021-08-18 21:37:21 +0000

    developers-handbook/kerneldebug: Document KASAN and KMSAN
    
    Reviewed by:    allanjude, ceri, imp
    Sponsored by:   The FreeBSD Foundation
    Differential Revision:  https://reviews.freebsd.org/D31166
---
 .../content/en/books/developers-handbook/kerneldebug/_index.adoc        | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc b/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc
index 817ef1f7de..5385ac1426 100644
--- a/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc
+++ b/documentation/content/en/books/developers-handbook/kerneldebug/_index.adoc
@@ -827,3 +827,5 @@ This section provides a brief glossary of compile-time kernel options used for d
 * `options DEBUG_VFS_LOCKS`: track lock acquisition points for lockmgr/vnode locks, expanding the amount of information displayed by `show lockedvnods` in DDB. This option has a measurable performance impact.
 * `options DEBUG_MEMGUARD`: a replacement for the man:malloc[9] kernel memory allocator that uses the VM system to detect reads or writes from allocated memory after free. Details may be found in man:memguard[9]. This option has a significant performance impact, but can be very helpful in debugging kernel memory corruption bugs.
 * `options DIAGNOSTIC`: enable additional, more expensive diagnostic tests along the lines of `options INVARIANTS`.
+* `options KASAN`: enable the Kernel Address Sanitizer. This enables compiler instrumentation which can be used to detect invalid memory accesses in the kernel, such as use-after-frees and buffer overflows. This largely supersedes `options DEBUG_MEMGUARD`. See man:kasan[9] for details, and for the currently supported platforms.
+* `options KMSAN`: enable the Kernel Memory Sanitizer. This enables compiler instrumentation which can be used to detect uses of uninitialized memory. See man:kmsan[9] for details, and for the currently supported platforms.
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/dev-commits-doc-all
To unsubscribe, send any mail to "[email protected]"
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.