diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2012-12-21 10:57:59 +0000 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2012-12-21 10:57:59 +0000 |
| commit | bed53cfc128b445199c0135702b5fd318becd0bd (patch) | |
| tree | 7817d830fc42770333fb27d8d13210153f37dbe6 | |
| parent | acef0e66a64bea56d31d80f9afb5178d59f6ae0c (diff) | |
| download | bcm5719-llvm-bed53cfc128b445199c0135702b5fd318becd0bd.tar.gz bcm5719-llvm-bed53cfc128b445199c0135702b5fd318becd0bd.zip | |
tsan: add a high-level comment to tsan_interface_java.h
llvm-svn: 170881
| -rw-r--r-- | compiler-rt/lib/tsan/rtl/tsan_interface_java.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/compiler-rt/lib/tsan/rtl/tsan_interface_java.h b/compiler-rt/lib/tsan/rtl/tsan_interface_java.h index 9af31a5293a..241483aaa01 100644 --- a/compiler-rt/lib/tsan/rtl/tsan_interface_java.h +++ b/compiler-rt/lib/tsan/rtl/tsan_interface_java.h @@ -9,6 +9,17 @@ // // This file is a part of ThreadSanitizer (TSan), a race detector. // +// Interface for verification of Java or mixed Java/C++ programs. +// The interface is intended to be used from within a JVM and notify TSan +// about such events like Java locks and GC memory compaction. +// +// For plain memory accesses and function entry/exit a JVM is intended to use +// C++ interfaces: __tsan_readN/writeN and __tsan_func_enter/exit. +// +// For volatile memory accesses and atomic operations JVM is intended to use +// standard atomics API: __tsan_atomicN_load/store/etc. +// +// For usage examples see lit_tests/java_*.cc //===----------------------------------------------------------------------===// #ifndef TSAN_INTERFACE_JAVA_H #define TSAN_INTERFACE_JAVA_H |
