1//===-- tsan_interface_java.h -----------------------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file is a part of ThreadSanitizer (TSan), a race detector.
11//
12// Interface for verification of Java or mixed Java/C++ programs.
13// The interface is intended to be used from within a JVM and notify TSan
14// about such events like Java locks and GC memory compaction.
15//
16// For plain memory accesses and function entry/exit a JVM is intended to use
17// C++ interfaces: __tsan_readN/writeN and __tsan_func_enter/exit.
18//
19// For volatile memory accesses and atomic operations JVM is intended to use
20// standard atomics API: __tsan_atomicN_load/store/etc.
21//
22// For usage examples see lit_tests/java_*.cc
23//===----------------------------------------------------------------------===//
24#ifndef TSAN_INTERFACE_JAVA_H
25#define TSAN_INTERFACE_JAVA_H
26
27#ifndef INTERFACE_ATTRIBUTE
28# define INTERFACE_ATTRIBUTE __attribute__((visibility("default")))
29#endif
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35typedef unsigned long jptr;  // NOLINT
36
37// Must be called before any other callback from Java.
38void __tsan_java_init(jptr heap_begin, jptr heap_size) INTERFACE_ATTRIBUTE;
39// Must be called when the application exits.
40// Not necessary the last callback (concurrently running threads are OK).
41// Returns exit status or 0 if tsan does not want to override it.
42int  __tsan_java_fini() INTERFACE_ATTRIBUTE;
43
44// Callback for memory allocations.
45// May be omitted for allocations that are not subject to data races
46// nor contain synchronization objects (e.g. String).
47void __tsan_java_alloc(jptr ptr, jptr size) INTERFACE_ATTRIBUTE;
48// Callback for memory free.
49// Can be aggregated for several objects (preferably).
50void __tsan_java_free(jptr ptr, jptr size) INTERFACE_ATTRIBUTE;
51// Callback for memory move by GC.
52// Can be aggregated for several objects (preferably).
53// The ranges can overlap.
54void __tsan_java_move(jptr src, jptr dst, jptr size) INTERFACE_ATTRIBUTE;
55// This function must be called on the finalizer thread
56// before executing a batch of finalizers.
57// It ensures necessary synchronization between
58// java object creation and finalization.
59void __tsan_java_finalize() INTERFACE_ATTRIBUTE;
60// Finds the first allocated memory block in the [*from_ptr, to) range, saves
61// its address in *from_ptr and returns its size. Returns 0 if there are no
62// allocated memory blocks in the range.
63jptr __tsan_java_find(jptr *from_ptr, jptr to) INTERFACE_ATTRIBUTE;
64
65// Mutex lock.
66// Addr is any unique address associated with the mutex.
67// Can be called on recursive reentry.
68void __tsan_java_mutex_lock(jptr addr) INTERFACE_ATTRIBUTE;
69// Mutex unlock.
70void __tsan_java_mutex_unlock(jptr addr) INTERFACE_ATTRIBUTE;
71// Mutex read lock.
72void __tsan_java_mutex_read_lock(jptr addr) INTERFACE_ATTRIBUTE;
73// Mutex read unlock.
74void __tsan_java_mutex_read_unlock(jptr addr) INTERFACE_ATTRIBUTE;
75// Recursive mutex lock, intended for handling of Object.wait().
76// The 'rec' value must be obtained from the previous
77// __tsan_java_mutex_unlock_rec().
78void __tsan_java_mutex_lock_rec(jptr addr, int rec) INTERFACE_ATTRIBUTE;
79// Recursive mutex unlock, intended for handling of Object.wait().
80// The return value says how many times this thread called lock()
81// w/o a pairing unlock() (i.e. how many recursive levels it unlocked).
82// It must be passed back to __tsan_java_mutex_lock_rec() to restore
83// the same recursion level.
84int __tsan_java_mutex_unlock_rec(jptr addr) INTERFACE_ATTRIBUTE;
85
86// Raw acquire/release primitives.
87// Can be used to establish happens-before edges on volatile/final fields,
88// in atomic operations, etc. release_store is the same as release, but it
89// breaks release sequence on addr (see C++ standard 1.10/7 for details).
90void __tsan_java_acquire(jptr addr) INTERFACE_ATTRIBUTE;
91void __tsan_java_release(jptr addr) INTERFACE_ATTRIBUTE;
92void __tsan_java_release_store(jptr addr) INTERFACE_ATTRIBUTE;
93
94#ifdef __cplusplus
95}  // extern "C"
96#endif
97
98#undef INTERFACE_ATTRIBUTE
99
100#endif  // #ifndef TSAN_INTERFACE_JAVA_H
101