Home | History | Annotate | Line # | Download | only in tsan
tsan_interface_java.h revision 1.1 
      1 //===-- tsan_interface_java.h -----------------------------------*- C++ -*-===//
      2 //
      3 // This file is distributed under the University of Illinois Open Source
      4 // License. See LICENSE.TXT for details.
      5 //
      6 //===----------------------------------------------------------------------===//
      7 //
      8 // This file is a part of ThreadSanitizer (TSan), a race detector.
      9 //
     10 // Interface for verification of Java or mixed Java/C++ programs.
     11 // The interface is intended to be used from within a JVM and notify TSan
     12 // about such events like Java locks and GC memory compaction.
     13 //
     14 // For plain memory accesses and function entry/exit a JVM is intended to use
     15 // C++ interfaces: __tsan_readN/writeN and __tsan_func_enter/exit.
     16 //
     17 // For volatile memory accesses and atomic operations JVM is intended to use
     18 // standard atomics API: __tsan_atomicN_load/store/etc.
     19 //
     20 // For usage examples see lit_tests/java_*.cc
     21 //===----------------------------------------------------------------------===//
     22 #ifndef TSAN_INTERFACE_JAVA_H
     23 #define TSAN_INTERFACE_JAVA_H
     24 
     25 #ifndef INTERFACE_ATTRIBUTE
     26 # define INTERFACE_ATTRIBUTE __attribute__((visibility("default")))
     27 #endif
     28 
     29 #ifdef __cplusplus
     30 extern "C" {
     31 #endif
     32 
     33 typedef unsigned long jptr;  // NOLINT
     34 
     35 // Must be called before any other callback from Java.
     36 void __tsan_java_init(jptr heap_begin, jptr heap_size) INTERFACE_ATTRIBUTE;
     37 // Must be called when the application exits.
     38 // Not necessary the last callback (concurrently running threads are OK).
     39 // Returns exit status or 0 if tsan does not want to override it.
     40 int  __tsan_java_fini() INTERFACE_ATTRIBUTE;
     41 
     42 // Callback for memory allocations.
     43 // May be omitted for allocations that are not subject to data races
     44 // nor contain synchronization objects (e.g. String).
     45 void __tsan_java_alloc(jptr ptr, jptr size) INTERFACE_ATTRIBUTE;
     46 // Callback for memory free.
     47 // Can be aggregated for several objects (preferably).
     48 void __tsan_java_free(jptr ptr, jptr size) INTERFACE_ATTRIBUTE;
     49 // Callback for memory move by GC.
     50 // Can be aggregated for several objects (preferably).
     51 // The ranges must not overlap.
     52 void __tsan_java_move(jptr src, jptr dst, jptr size) INTERFACE_ATTRIBUTE;
     53 
     54 // Mutex lock.
     55 // Addr is any unique address associated with the mutex.
     56 // Must not be called on recursive reentry.
     57 // Object.wait() is handled as a pair of unlock/lock.
     58 void __tsan_java_mutex_lock(jptr addr) INTERFACE_ATTRIBUTE;
     59 // Mutex unlock.
     60 void __tsan_java_mutex_unlock(jptr addr) INTERFACE_ATTRIBUTE;
     61 // Mutex read lock.
     62 void __tsan_java_mutex_read_lock(jptr addr) INTERFACE_ATTRIBUTE;
     63 // Mutex read unlock.
     64 void __tsan_java_mutex_read_unlock(jptr addr) INTERFACE_ATTRIBUTE;
     65 
     66 #ifdef __cplusplus
     67 }  // extern "C"
     68 #endif
     69 
     70 #undef INTERFACE_ATTRIBUTE
     71 
     72 #endif  // #ifndef TSAN_INTERFACE_JAVA_H
     73