[rustc.git] / src / compiler-rt / lib / asan / README.txt

AddressSanitizer RT
================================
This directory contains sources of the AddressSanitizer (ASan) runtime library.

Directory structure:
README.txt       : This file.
Makefile.mk      : File for make-based build.
CMakeLists.txt   : File for cmake-based build.
asan_*.{cc,h}    : Sources of the asan runtime library.
scripts/*        : Helper scripts.
tests/*          : ASan unit tests.

Also ASan runtime needs the following libraries:
lib/interception/      : Machinery used to intercept function calls.
lib/sanitizer_common/  : Code shared between various sanitizers.

ASan runtime currently also embeds part of LeakSanitizer runtime for
leak detection (lib/lsan/lsan_common.{cc,h}).

ASan runtime can only be built by CMake. You can run ASan tests
from the root of your CMake build tree:

make check-asan

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