libsanitizer/tsan/tsan_interface_java.h

   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 can overlap.
  52 void __tsan_java_move(jptr src, jptr dst, jptr size) INTERFACE_ATTRIBUTE;
  53 // This function must be called on the finalizer thread
  54 // before executing a batch of finalizers.
  55 // It ensures necessary synchronization between
  56 // java object creation and finalization.
  57 void __tsan_java_finalize() INTERFACE_ATTRIBUTE;
  58 // Finds the first allocated memory block in the [*from_ptr, to) range, saves
  59 // its address in *from_ptr and returns its size. Returns 0 if there are no
  60 // allocated memory blocks in the range.
  61 jptr __tsan_java_find(jptr *from_ptr, jptr to) INTERFACE_ATTRIBUTE;
  62
  63 // Mutex lock.
  64 // Addr is any unique address associated with the mutex.
  65 // Can be called on recursive reentry.
  66 void __tsan_java_mutex_lock(jptr addr) INTERFACE_ATTRIBUTE;
  67 // Mutex unlock.
  68 void __tsan_java_mutex_unlock(jptr addr) INTERFACE_ATTRIBUTE;
  69 // Mutex read lock.
  70 void __tsan_java_mutex_read_lock(jptr addr) INTERFACE_ATTRIBUTE;
  71 // Mutex read unlock.
  72 void __tsan_java_mutex_read_unlock(jptr addr) INTERFACE_ATTRIBUTE;
  73 // Recursive mutex lock, intended for handling of Object.wait().
  74 // The 'rec' value must be obtained from the previous
  75 // __tsan_java_mutex_unlock_rec().
  76 void __tsan_java_mutex_lock_rec(jptr addr, int rec) INTERFACE_ATTRIBUTE;
  77 // Recursive mutex unlock, intended for handling of Object.wait().
  78 // The return value says how many times this thread called lock()
  79 // w/o a pairing unlock() (i.e. how many recursive levels it unlocked).
  80 // It must be passed back to __tsan_java_mutex_lock_rec() to restore
  81 // the same recursion level.
  82 int __tsan_java_mutex_unlock_rec(jptr addr) INTERFACE_ATTRIBUTE;
  83
  84 // Raw acquire/release primitives.
  85 // Can be used to establish happens-before edges on volatile/final fields,
  86 // in atomic operations, etc. release_store is the same as release, but it
  87 // breaks release sequence on addr (see C++ standard 1.10/7 for details).
  88 void __tsan_java_acquire(jptr addr) INTERFACE_ATTRIBUTE;
  89 void __tsan_java_release(jptr addr) INTERFACE_ATTRIBUTE;
  90 void __tsan_java_release_store(jptr addr) INTERFACE_ATTRIBUTE;
  91
  92 #ifdef __cplusplus
  93 }  // extern "C"
  94 #endif
  95
  96 #undef INTERFACE_ATTRIBUTE
  97
  98 #endif  // #ifndef TSAN_INTERFACE_JAVA_H