| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 1 | AddressSanitizer RT |
| 2 | ================================ |
| Stephen Hines | 86277eb | 2015-03-23 12:06:32 -0700 | [diff] [blame] | 3 | This directory contains sources of the AddressSanitizer (ASan) runtime library. |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 4 | |
| Stephen Hines | 6a211c5 | 2014-07-21 00:49:56 -0700 | [diff] [blame] | 5 | Directory structure: |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 6 | README.txt : This file. |
| Alexey Samsonov | 5b1f020 | 2012-09-06 06:39:02 +0000 | [diff] [blame] | 7 | Makefile.mk : File for make-based build. |
| 8 | CMakeLists.txt : File for cmake-based build. |
| Stephen Hines | 6a211c5 | 2014-07-21 00:49:56 -0700 | [diff] [blame] | 9 | asan_*.{cc,h} : Sources of the asan runtime library. |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 10 | scripts/* : Helper scripts. |
| Alexey Samsonov | 5b1f020 | 2012-09-06 06:39:02 +0000 | [diff] [blame] | 11 | tests/* : ASan unit tests. |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 12 | |
| Alexey Samsonov | 5b1f020 | 2012-09-06 06:39:02 +0000 | [diff] [blame] | 13 | Also ASan runtime needs the following libraries: |
| 14 | lib/interception/ : Machinery used to intercept function calls. |
| Stephen Hines | 86277eb | 2015-03-23 12:06:32 -0700 | [diff] [blame] | 15 | lib/sanitizer_common/ : Code shared between various sanitizers. |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 16 | |
| Stephen Hines | 86277eb | 2015-03-23 12:06:32 -0700 | [diff] [blame] | 17 | ASan runtime currently also embeds part of LeakSanitizer runtime for |
| 18 | leak detection (lib/lsan/lsan_common.{cc,h}). |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 19 | |
| Stephen Hines | 86277eb | 2015-03-23 12:06:32 -0700 | [diff] [blame] | 20 | ASan runtime can only be built by CMake. You can run ASan tests |
| 21 | from the root of your CMake build tree: |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 22 | |
| Alexey Samsonov | 5b1f020 | 2012-09-06 06:39:02 +0000 | [diff] [blame] | 23 | make check-asan |
| Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 24 | |
| Alexey Samsonov | 5b1f020 | 2012-09-06 06:39:02 +0000 | [diff] [blame] | 25 | For more instructions see: |
| 26 | http://code.google.com/p/address-sanitizer/wiki/HowToBuild |