FreeBSD src
Go to file
Mark Johnston 38da497a4d Add the KASAN runtime
KASAN enables the use of LLVM's AddressSanitizer in the kernel.  This
feature makes use of compiler instrumentation to validate memory
accesses in the kernel and detect several types of bugs, including
use-after-frees and out-of-bounds accesses.  It is particularly
effective when combined with test suites or syzkaller.  KASAN has high
CPU and memory usage overhead and so is not suited for production
environments.

The runtime and pmap maintain a shadow of the kernel map to store
information about the validity of memory mapped at a given kernel
address.

The runtime implements a number of functions defined by the compiler
ABI.  These are prefixed by __asan.  The compiler emits calls to
__asan_load*() and __asan_store*() around memory accesses, and the
runtime consults the shadow map to determine whether a given access is
valid.

kasan_mark() is called by various kernel allocators to update state in
the shadow map.  Updates to those allocators will come in subsequent
commits.

The runtime also defines various interceptors.  Some low-level routines
are implemented in assembly and are thus not amenable to compiler
instrumentation.  To handle this, the runtime implements these routines
on behalf of the rest of the kernel.  The sanitizer implementation
validates memory accesses manually before handing off to the real
implementation.

The sanitizer in a KASAN-configured kernel can be disabled by setting
the loader tunable debug.kasan.disable=1.

Obtained from:	NetBSD
MFC after:	2 weeks
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D29416
2021-04-13 17:42:20 -04:00
.github/workflows GitHub actions: unbreak macOS build 2021-01-08 15:36:38 +01:00
bin sh: fix debug build 2021-04-11 09:23:14 +02:00
cddl dtrace: Document the libdir, nolibs and syslibdir options 2021-04-02 17:42:38 -04:00
contrib Merge commit 'd0e943077d94e6266ece9856789c5d5313676e38' 2021-04-12 11:29:47 -04:00
crypto OpenSSL: Merge OpenSSL 1.1.1k 2021-03-25 11:45:19 -04:00
etc base: remove if_wg(4) and associated utilities, manpage 2021-03-17 09:14:48 -05:00
gnu dialog: fix macro redefinition 2021-03-01 16:01:44 +01:00
include Vendor import of Gavin D. Howard's bc version 4.0.0 2021-04-06 10:44:52 +02:00
kerberos5 kerberos5: fix the WITH_OPENLDAP build 2021-01-30 00:07:50 -06:00
lib Fix race in case of device destruction. 2021-04-13 11:25:27 -04:00
libexec rc: replace NETWORK with NETWORKING 2021-04-12 15:28:48 +01:00
release release: move installworld before installkernel 2021-04-05 13:16:01 -04:00
rescue ping: add a ping6 hard link for backwards compatibility 2020-11-26 18:33:04 +00:00
sbin pf: Implement the NAT source port selection of MAP-E Customer Edge 2021-04-13 10:53:18 +02:00
secure OpenSSL: Regen manual pages for 1.1.1k 2021-03-25 12:17:52 -04:00
share Add the KASAN runtime 2021-04-13 17:42:20 -04:00
stand Fix build of stand/usb . 2021-04-12 16:13:33 +02:00
sys Add the KASAN runtime 2021-04-13 17:42:20 -04:00
targets Remove kgmon(8) 2021-04-04 00:50:28 +03:00
tests pf: Implement the NAT source port selection of MAP-E Customer Edge 2021-04-13 10:53:18 +02:00
tools OCF: Remove support for asymmetric cryptographic operations. 2021-04-12 14:28:43 -07:00
usr.bin Use if ... else when printing memory attributes 2021-04-11 10:58:46 +00:00
usr.sbin config(8): Correct the mentioned paper in the SEE ALSO section 2021-04-13 06:49:00 +02:00
.arcconfig Remove history.immutable from .arcconfig 2021-04-13 12:36:25 +01:00
.arclint arc lint: ignore /tests/ in chmod 2017-12-19 03:38:06 +00:00
.cirrus.yml Cirrus-CI: Add more information to help track down disk full issues 2021-03-03 11:51:08 -05:00
.clang-format clang-format: Avoid breaking after the opening paren of function definitions 2020-10-28 11:54:00 +00:00
.gitattributes Add a basic clang-format configuration file 2019-06-07 15:23:52 +00:00
.gitignore gitignore: expand list of ignored files 2021-01-14 17:03:57 +01:00
COPYRIGHT copyrights: Happy New Year 2021 2020-12-31 10:29:44 -05:00
LOCKS LOCKS: update current locks 2018-06-09 03:08:04 +00:00
MAINTAINERS Add a pointer to csprng@ for the CSPRNG driver. This is enforced anyway by 2020-09-01 08:02:12 +00:00
Makefile libedit: vendor import snapshot 20200710 2021-03-22 15:29:33 +01:00
Makefile.inc1 Makefile.inc1: unbreak bootstrap when kbdcontrol does not exist 2021-03-23 20:47:14 -04:00
Makefile.libcompat libcompat: remove redundant path for ncurses 2021-01-07 15:14:52 +01:00
Makefile.sys.inc AUTO_OBJ: For all top-level targets enforce using an OBJDIR. 2017-12-05 21:29:47 +00:00
ObsoleteFiles.inc Remove reference to the pfctlinput2() from domain(9) after 237c1f932b. 2021-04-14 00:40:20 +03:00
README.md Update capsicum-test to ea66424d921bb393539b298c108a46edee5c3051 2021-04-12 11:25:49 -04:00
RELNOTES Spellcheck. 2021-04-12 15:12:19 -07:00
UPDATING Add a note to indicate "don't run the nfscbd(8) without this patch. 2021-04-11 15:14:47 -07:00

FreeBSD Source:

This is the top level of the FreeBSD source directory.

FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms. A large community has continually developed it for more than thirty years. Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices.

For copyright information, please see the file COPYRIGHT in this directory. Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.

The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree. See build(7), config(8), FreeBSD handbook on building userland, and Handbook for kernels for more information, including setting make(1) variables.

Source Roadmap:

Directory Description
bin System/user commands.
cddl Various commands and libraries under the Common Development and Distribution License.
contrib Packages contributed by 3rd parties.
crypto Cryptography stuff (see crypto/README).
etc Template files for /etc.
gnu Various commands and libraries under the GNU Public License. Please see gnu/COPYING and gnu/COPYING.LIB for more information.
include System include files.
kerberos5 Kerberos5 (Heimdal) package.
lib System libraries.
libexec System daemons.
release Release building Makefile & associated tools.
rescue Build system for statically linked /rescue utilities.
sbin System commands.
secure Cryptographic libraries and commands.
share Shared resources.
stand Boot loader sources.
sys Kernel sources.
sys/arch/conf Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries.
tests Regression tests which can be run by Kyua. See tests/README for additional information.
tools Utilities for regression testing and miscellaneous tasks.
usr.bin User commands.
usr.sbin System administration commands.

For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see FreeBSD Handbook.