xref: /aosp_15_r20/external/compiler-rt/lib/asan/README.txt (revision 7c3d14c8b49c529e04be81a3ce6f5cc23712e4c6)
1*7c3d14c8STreehugger RobotAddressSanitizer RT
2*7c3d14c8STreehugger Robot================================
3*7c3d14c8STreehugger RobotThis directory contains sources of the AddressSanitizer (ASan) runtime library.
4*7c3d14c8STreehugger Robot
5*7c3d14c8STreehugger RobotDirectory structure:
6*7c3d14c8STreehugger RobotREADME.txt       : This file.
7*7c3d14c8STreehugger RobotMakefile.mk      : File for make-based build.
8*7c3d14c8STreehugger RobotCMakeLists.txt   : File for cmake-based build.
9*7c3d14c8STreehugger Robotasan_*.{cc,h}    : Sources of the asan runtime library.
10*7c3d14c8STreehugger Robotscripts/*        : Helper scripts.
11*7c3d14c8STreehugger Robottests/*          : ASan unit tests.
12*7c3d14c8STreehugger Robot
13*7c3d14c8STreehugger RobotAlso ASan runtime needs the following libraries:
14*7c3d14c8STreehugger Robotlib/interception/      : Machinery used to intercept function calls.
15*7c3d14c8STreehugger Robotlib/sanitizer_common/  : Code shared between various sanitizers.
16*7c3d14c8STreehugger Robot
17*7c3d14c8STreehugger RobotASan runtime currently also embeds part of LeakSanitizer runtime for
18*7c3d14c8STreehugger Robotleak detection (lib/lsan/lsan_common.{cc,h}).
19*7c3d14c8STreehugger Robot
20*7c3d14c8STreehugger RobotASan runtime can only be built by CMake. You can run ASan tests
21*7c3d14c8STreehugger Robotfrom the root of your CMake build tree:
22*7c3d14c8STreehugger Robot
23*7c3d14c8STreehugger Robotmake check-asan
24*7c3d14c8STreehugger Robot
25*7c3d14c8STreehugger RobotFor more instructions see:
26*7c3d14c8STreehugger Robothttps://github.com/google/sanitizers/wiki/AddressSanitizerHowToBuild
27