New sentence, new line. Fix macro arguments. Improve Nd.

Remove superfluous Pp. Other minor cleanups.
This commit is contained in:
wiz 2020-06-24 08:20:13 +00:00
parent f01e01eb6a
commit bc3f8a62e1

View File

@ -1,4 +1,4 @@
.\" $NetBSD: kernel_sanitizers.7,v 1.1 2020/06/23 16:08:46 maxv Exp $
.\" $NetBSD: kernel_sanitizers.7,v 1.2 2020/06/24 08:20:13 wiz Exp $
.\"
.\" Copyright (c) 2020 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -28,13 +28,11 @@
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd June 22, 2020
.Dt kernel_sanitizers 7
.Dt KERNEL_SANITIZERS 7
.Os
.Sh NAME
.Nm kernel_sanitizers
.Nd
.Nx
Kernel Sanitizers
.Nd NetBSD Kernel Sanitizers
.Sh DESCRIPTION
Kernel Sanitizers are powerful kernel bug detection features that can
automatically discover several classes of bugs at run time while the kernel
@ -55,15 +53,14 @@ Compiler instrumentation and an entirely MI runtime.
aarch64 (gcc), amd64 (gcc).
[Theoretically supported on all other architectures with no MD change required]
.Ss Files
.Pp
.Bl -tag -width XXXX -compact
.It Pa src/common/lib/libc/misc/
Core KUBSAN code. MI.
Core KUBSAN code.
MI.
.El
.Sh KASAN
Kernel Address Sanitizer, specializes in finding memory corruptions such as
buffer overflows and use-after-frees.
.Pp
.Ss Runtime cost
Heavy runtime checks, and ~12.5% increase in memory consumption.
.Ss Used components
@ -89,11 +86,14 @@ An architecture is allowed to have only partial support.
.Ss Files
.Bl -tag -width XXXX -compact
.It Pa src/sys/kern/subr_asan.c
Core KASAN code. MI.
Core KASAN code.
MI.
.It Pa src/sys/sys/asan.h
Main KASAN header. MI.
Main KASAN header.
MI.
.It Pa src/sys/arch/{port}/include/asan.h
Port-specific KASAN code. MD.
Port-specific KASAN code.
MD.
.El
.Pp
Each new port of KASAN should respect the existing naming conventions, and
@ -109,11 +109,14 @@ amd64 (gcc).
.Ss Files
.Bl -tag -width XXXX -compact
.It Pa src/sys/kern/subr_csan.c
Core KCSAN code. MI.
Core KCSAN code.
MI.
.It Pa src/sys/sys/csan.h
Main KCSAN header. MI.
Main KCSAN header.
MI.
.It Pa src/sys/arch/{port}/include/csan.h
Port-specific KCSAN code. MD.
Port-specific KCSAN code.
MD.
.El
.Pp
Each new port of KCSAN should respect the existing naming conventions, and
@ -130,16 +133,20 @@ amd64 (llvm).
.Ss Files
.Bl -tag -width XXXX -compact
.It Pa src/sys/kern/subr_msan.c
Core KMSAN code. MI.
Core KMSAN code.
MI.
.It Pa src/sys/sys/msan.h
Main KMSAN header. MI.
Main KMSAN header.
MI.
.It Pa src/sys/arch/{port}/include/msan.h
Port-specific KMSAN code. MD.
Port-specific KMSAN code.
MD.
.El
.Pp
Each new port of KMSAN should respect the existing naming conventions, and
should introduce only one MD header file.
.Sh AUTHORS
.An -nosplit
Support for KUBSAN was developed by
.An Kamil Rytarowski .
Support for KASAN, KCSAN and KMSAN was developed by