From owner-dev-commits-doc-all@freebsd.org Wed Aug 18 21:38:22 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id E5337657417 for ; Wed, 18 Aug 2021 21:38:22 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Gqh8t5ydPz3M1L; Wed, 18 Aug 2021 21:38:22 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id B07BD18DB0; Wed, 18 Aug 2021 21:38:22 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 17ILcM4O027580; Wed, 18 Aug 2021 21:38:22 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 17ILcMvO027579; Wed, 18 Aug 2021 21:38:22 GMT (envelope-from git) Date: Wed, 18 Aug 2021 21:38:22 GMT Message-Id: <202108182138.17ILcMvO027579@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Mark Johnston Subject: git: 777a0f30b3 - main - developers-handbook/kerneldebug: Document KASAN and KMSAN MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: markj X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 777a0f30b349615db6feba4b48383dc1723e22e7 Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 18 Aug 2021 21:38:23 -0000 The branch main has been updated by markj (src committer): URL: https://cgit.FreeBSD.org/doc/commit/?id=777a0f30b349615db6feba4b48383dc1723e22e7 commit 777a0f30b349615db6feba4b48383dc1723e22e7 Author: Mark Johnston AuthorDate: 2021-07-13 21:32:19 +0000 Commit: Mark Johnston 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.