summaryrefslogtreecommitdiff
path: root/lib/asan/README.txt
diff options
context:
space:
mode:
authorAlexey Samsonov <samsonov@google.com>2012-09-06 06:39:02 +0000
committerAlexey Samsonov <samsonov@google.com>2012-09-06 06:39:02 +0000
commit5b1f0202cefdab3970b4d5372777d586ffa49dd3 (patch)
tree42a8254d88ef76fe3934179dfa1965817fc66d78 /lib/asan/README.txt
parentff392a44a9af183de5adc8893ddd11ac77625d56 (diff)
[ASan] Nuke output_tests/ in favor of lit_tests/. Stop using Makefile.old.
git-svn-id: https://llvm.org/svn/llvm-project/compiler-rt/trunk@163294 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'lib/asan/README.txt')
-rw-r--r--lib/asan/README.txt26
1 files changed, 15 insertions, 11 deletions
diff --git a/lib/asan/README.txt b/lib/asan/README.txt
index 786917b70..e4f4961c5 100644
--- a/lib/asan/README.txt
+++ b/lib/asan/README.txt
@@ -4,22 +4,26 @@ This directory contains sources of the AddressSanitizer (asan) run-time library.
We are in the process of integrating AddressSanitizer with LLVM, stay tuned.
Directory structre:
-
README.txt : This file.
-Makefile.mk : Currently a stub for a proper makefile. not usable.
-Makefile.old : Old out-of-tree makefile, the only usable one so far.
+Makefile.mk : File for make-based build.
+CMakeLists.txt : File for cmake-based build.
asan_*.{cc,h} : Sources of the asan run-time lirbary.
-mach_override/* : Utility to override functions on Darwin (MIT License).
scripts/* : Helper scripts.
+tests/* : ASan unit tests.
+lit_tests/* : ASan output tests.
-Temporary build instructions (verified on linux):
+Also ASan runtime needs the following libraries:
+lib/interception/ : Machinery used to intercept function calls.
+lib/sanitizer_common/ : Code shared between ASan and TSan.
-cd lib/asan
-make -f Makefile.old get_third_party # gets googletest
-make -f Makefile.old test -j 8 CLANG_BUILD=/path/to/Release+Asserts
-# Optional:
-# make -f Makefile.old install # installs clang and rt to lib/asan_clang_linux
+Currently ASan runtime can be built by both make and cmake build systems.
+(see compiler-rt/make and files Makefile.mk for make-based build and
+files CMakeLists.txt for cmake-based build).
-For more info see http://code.google.com/p/address-sanitizer/
+ASan unit and output tests work only with cmake. You may run this
+command from the root of your cmake build tree:
+make check-asan
+For more instructions see:
+http://code.google.com/p/address-sanitizer/wiki/HowToBuild