summaryrefslogtreecommitdiff
path: root/lib/asan/README.txt
diff options
context:
space:
mode:
authorKostya Serebryany <kcc@google.com>2011-11-30 01:07:02 +0000
committerKostya Serebryany <kcc@google.com>2011-11-30 01:07:02 +0000
commit1e172b4bdec57329bf904f063a29f99cddf2d85f (patch)
tree615823ee9e1c1dfa52262cbf608c8e63cd07d0f3 /lib/asan/README.txt
parent1626d864159d42d1c5a492c1cb686f629e81f815 (diff)
AddressSanitizer run-time library. Not yet integrated with the compiler-rt build system, but can be built using the old makefile. See details in README.txt
git-svn-id: https://llvm.org/svn/llvm-project/compiler-rt/trunk@145463 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'lib/asan/README.txt')
-rw-r--r--lib/asan/README.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/asan/README.txt b/lib/asan/README.txt
new file mode 100644
index 000000000..00ae3c48f
--- /dev/null
+++ b/lib/asan/README.txt
@@ -0,0 +1,26 @@
+AddressSanitizer RT
+================================
+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.
+asan_*.{cc,h} : Sources of the asan run-time lirbary.
+mach_override/* : Utility to override functions on Darwin (MIT License).
+sysinfo/* : Portable utility to iterate over /proc/maps (BSD License).
+scripts/* : Helper scripts.
+
+Temporary build instructions (verified on linux):
+
+cd lib/asan
+make -f Makefile.old get_third_party # gets googletest and cpplint
+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
+
+For more info see http://code.google.com/p/address-sanitizer/
+
+