[llvm-commits] [compiler-rt] r170881 - /compiler-rt/trunk/lib/tsan/rtl/tsan_interface_java.h

[Dmitry Vyukov]

Author: dvyukov
Date: Fri Dec 21 04:57:59 2012
New Revision: 170881

URL: http://llvm.org/viewvc/llvm-project?rev=170881&view=rev
Log:
tsan: add a high-level comment to tsan_interface_java.h

Modified:
    compiler-rt/trunk/lib/tsan/rtl/tsan_interface_java.h

Modified: compiler-rt/trunk/lib/tsan/rtl/tsan_interface_java.h
URL: http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/tsan/rtl/tsan_interface_java.h?rev=170881&r1=170880&r2=170881&view=diff
==============================================================================
--- compiler-rt/trunk/lib/tsan/rtl/tsan_interface_java.h (original)
+++ compiler-rt/trunk/lib/tsan/rtl/tsan_interface_java.h Fri Dec 21 04:57:59 2012
@@ -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