From owner-dev-commits-src-main@freebsd.org Thu Apr 29 16:27:22 2021 Return-Path: Delivered-To: dev-commits-src-main@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 65D5F6301A4; Thu, 29 Apr 2021 16:27: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 4FWLWG2Vzfz4qdJ; Thu, 29 Apr 2021 16:27: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 4921A1E385; Thu, 29 Apr 2021 16:27: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 13TGRMtV098594; Thu, 29 Apr 2021 16:27:22 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 13TGRM9j098593; Thu, 29 Apr 2021 16:27:22 GMT (envelope-from git) Date: Thu, 29 Apr 2021 16:27:22 GMT Message-Id: <202104291627.13TGRM9j098593@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mark Johnston Subject: git: 420d30f5bdbf - main - kasan.9: A couple of fixups MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: markj X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 420d30f5bdbfc20d83b3c9a7d5b4e90446b922fa Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-main@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for the main branch of the src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 29 Apr 2021 16:27:22 -0000 The branch main has been updated by markj: URL: https://cgit.FreeBSD.org/src/commit/?id=420d30f5bdbfc20d83b3c9a7d5b4e90446b922fa commit 420d30f5bdbfc20d83b3c9a7d5b4e90446b922fa Author: Mark Johnston AuthorDate: 2021-04-29 16:26:03 +0000 Commit: Mark Johnston CommitDate: 2021-04-29 16:26:37 +0000 kasan.9: A couple of fixups - Mention GENERIC-KASAN. - Note that the runtime was ported from NetBSD. Sponsored by: The FreeBSD Foundation --- share/man/man9/kasan.9 | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/share/man/man9/kasan.9 b/share/man/man9/kasan.9 index ecc068209913..d675a78f1e29 100644 --- a/share/man/man9/kasan.9 +++ b/share/man/man9/kasan.9 @@ -27,15 +27,22 @@ .\" .\" $FreeBSD$ .\" -.Dd April 13, 2021 +.Dd April 29, 2021 .Dt KASAN 9 .Os .Sh NAME -.Nm kasan -.Nd kernel address sanitizer +.Nm KASAN +.Nd Kernel Address SANitizer .Sh SYNOPSIS -To compile KASAN into the kernel, place the following line in your kernel -configuration file: +The +.Pa GENERIC-KASAN +kernel configuration can be used to compile a KASAN-enabled kernel using +.Pa GENERIC +as a base configuration. +Alternately, to compile +.Nm +into the kernel, place the following line in your +kernel configuration file: .Bd -ragged -offset indent .Cd "options KASAN" .Ed @@ -142,13 +149,16 @@ are equal, .Fa code should be 0. .Sh SEE ALSO +.Xr build 7 , .Xr malloc 9 , .Xr memguard 9 , .Xr redzone 9 , .Xr uma 9 .Sh HISTORY .Nm -first appeared in +was ported from +.Nx +and first appeared in .Fx 14.0 . .Sh BUGS Accesses to kernel memory outside of the kernel map are ignored by the