xref: /freebsd/contrib/llvm-project/compiler-rt/lib/asan/README.txt (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1AddressSanitizer RT
2================================
3This directory contains sources of the AddressSanitizer (ASan) runtime library.
4
5Directory structure:
6README.txt       : This file.
7Makefile.mk      : File for make-based build.
8CMakeLists.txt   : File for cmake-based build.
9asan_*.{cc,h}    : Sources of the asan runtime library.
10scripts/*        : Helper scripts.
11tests/*          : ASan unit tests.
12
13Also ASan runtime needs the following libraries:
14lib/interception/      : Machinery used to intercept function calls.
15lib/sanitizer_common/  : Code shared between various sanitizers.
16
17ASan runtime currently also embeds part of LeakSanitizer runtime for
18leak detection (lib/lsan/lsan_common.{cc,h}).
19
20ASan runtime can only be built by CMake. You can run ASan tests
21from the root of your CMake build tree:
22
23make check-asan
24
25For more instructions see:
26https://github.com/google/sanitizers/wiki/AddressSanitizerHowToBuild
27