8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_RUNTIME_MUTEXLOCKER_HPP
26 #define SHARE_RUNTIME_MUTEXLOCKER_HPP
27
28 #include "memory/allocation.hpp"
29 #include "runtime/flags/flagSetting.hpp"
30 #include "runtime/mutex.hpp"
31
32 class Thread;
33
34 // Mutexes used in the VM.
35
36 extern Mutex* NMethodState_lock; // a lock used to guard a compiled method state
37 extern Monitor* SystemDictionary_lock; // a lock on the system dictionary
38 extern Mutex* InvokeMethodTypeTable_lock;
39 extern Monitor* InvokeMethodIntrinsicTable_lock;
40 extern Mutex* SharedDictionary_lock; // a lock on the CDS shared dictionary
41 extern Monitor* ClassInitError_lock; // a lock on the class initialization error table
42 extern Mutex* Module_lock; // a lock on module and package related data structures
43 extern Mutex* CompiledIC_lock; // a lock used to guard compiled IC patching and access
44 extern Mutex* VMStatistic_lock; // a lock used to guard statistics count increment
45 extern Mutex* JmethodIdCreation_lock; // a lock on creating JNI method identifiers
46 extern Mutex* JfieldIdCreation_lock; // a lock on creating JNI static field identifiers
47 extern Monitor* JNICritical_lock; // a lock used while synchronizing with threads entering/leaving JNI critical regions
48 extern Mutex* JvmtiThreadState_lock; // a lock on modification of JVMTI thread data
49 extern Monitor* EscapeBarrier_lock; // a lock to sync reallocating and relocking objects because of JVMTI access
50 extern Monitor* VThreadTransition_lock; // a lock used when disabling virtual thread transitions
57 extern Mutex* SignatureHandlerLibrary_lock; // a lock on the SignatureHandlerLibrary
58 extern Mutex* VtableStubs_lock; // a lock on the VtableStubs
59 extern Mutex* SymbolArena_lock; // a lock on the symbol table arena
60 extern Monitor* StringDedup_lock; // a lock on the string deduplication facility
61 extern Mutex* StringDedupIntern_lock; // a lock on StringTable notification of StringDedup
62 extern Monitor* CodeCache_lock; // a lock on the CodeCache
63 extern Mutex* TouchedMethodLog_lock; // a lock on allocation of LogExecutedMethods info
64 extern Mutex* RetData_lock; // a lock on installation of RetData inside method data
65 extern Monitor* VMOperation_lock; // a lock on queue of vm_operations waiting to execute
66 extern Monitor* ThreadsLockThrottle_lock; // used by Thread start/exit to reduce competition for Threads_lock,
67 // so a VM thread calling a safepoint is prioritized
68 extern Monitor* Threads_lock; // a lock on the Threads table of active Java threads
69 // (also used by Safepoints too to block threads creation/destruction)
70 extern Mutex* NonJavaThreadsList_lock; // a lock on the NonJavaThreads list
71 extern Mutex* NonJavaThreadsListSync_lock; // a lock for NonJavaThreads list synchronization
72 extern Monitor* STS_lock; // used for joining/leaving SuspendibleThreadSet.
73 extern Mutex* MonitoringSupport_lock; // Protects updates to the serviceability memory pools and allocated memory high water mark.
74 extern Monitor* ConcurrentGCBreakpoints_lock; // Protects concurrent GC breakpoint management
75 extern Mutex* Compile_lock; // a lock held when Compilation is updating code (used to block CodeCache traversal, CHA updates, etc)
76 extern Monitor* MethodCompileQueue_lock; // a lock held when method compilations are enqueued, dequeued
77 extern Monitor* CompileThread_lock; // a lock held by compile threads during compilation system initialization
78 extern Monitor* Compilation_lock; // a lock used to pause compilation
79 extern Mutex* TrainingData_lock; // a lock used when accessing training records
80 extern Monitor* TrainingReplayQueue_lock; // a lock held when class are added/removed to the training replay queue
81 extern Monitor* CompileTaskWait_lock; // a lock held when CompileTasks are waited/notified
82 extern Mutex* CompileStatistics_lock; // a lock held when updating compilation statistics
83 extern Mutex* DirectivesStack_lock; // a lock held when mutating the dirstack and ref counting directives
84 extern Monitor* AOTHeapLoading_lock; // a lock used to guard materialization of AOT heap objects
85 extern Monitor* Terminator_lock; // a lock used to guard termination of the vm
86 extern Monitor* InitCompleted_lock; // a lock used to signal threads waiting on init completed
87 extern Monitor* BeforeExit_lock; // a lock used to guard cleanups and shutdown hooks
88 extern Monitor* Notify_lock; // a lock used to synchronize the start-up of the vm
89 extern Mutex* ExceptionCache_lock; // a lock used to synchronize exception cache updates
90
91 #ifndef PRODUCT
92 extern Mutex* FullGCALot_lock; // a lock to make FullGCALot MT safe
93 #endif // PRODUCT
94
95 #if INCLUDE_G1GC
96 extern Monitor* G1CGC_lock; // used for coordination between fore- & background G1 concurrent GC threads.
176 // See orderAccess.hpp. We assume throughout the VM that MutexLocker's
177 // and friends constructors do a fence, a lock and an acquire *in that
178 // order*. And that their destructors do a release and unlock, in *that*
179 // order. If their implementations change such that these assumptions
180 // are violated, a whole lot of code will break.
181
182 // for debugging: check that we're already owning this lock (or are at a safepoint / handshake)
183 #ifdef ASSERT
184 void assert_locked_or_safepoint(const Mutex* lock);
185 void assert_lock_strong(const Mutex* lock);
186 #else
187 #define assert_locked_or_safepoint(lock)
188 #define assert_lock_strong(lock)
189 #endif
190
191 // Internal implementation. Skips on null Mutex.
192 // Subclasses enforce stronger invariants.
193 class MutexLockerImpl: public StackObj {
194 protected:
195 Mutex* _mutex;
196
197 MutexLockerImpl(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
198 _mutex(mutex) {
199 bool no_safepoint_check = flag == Mutex::_no_safepoint_check_flag;
200 if (_mutex != nullptr) {
201 if (no_safepoint_check) {
202 _mutex->lock_without_safepoint_check();
203 } else {
204 _mutex->lock();
205 }
206 }
207 }
208
209 MutexLockerImpl(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
210 _mutex(mutex) {
211 bool no_safepoint_check = flag == Mutex::_no_safepoint_check_flag;
212 if (_mutex != nullptr) {
213 if (no_safepoint_check) {
214 _mutex->lock_without_safepoint_check(thread);
215 } else {
216 _mutex->lock(thread);
217 }
218 }
219 }
220
221 ~MutexLockerImpl() {
222 if (_mutex != nullptr) {
223 assert_lock_strong(_mutex);
224 _mutex->unlock();
225 }
226 }
227
228 public:
229 static void post_initialize();
230 };
231
232 // Simplest mutex locker.
233 // Does not allow null mutexes.
234 class MutexLocker: public MutexLockerImpl {
235 public:
236 MutexLocker(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
237 MutexLockerImpl(mutex, flag) {
238 assert(mutex != nullptr, "null mutex not allowed");
239 }
240
241 MutexLocker(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
242 MutexLockerImpl(thread, mutex, flag) {
243 assert(mutex != nullptr, "null mutex not allowed");
244 }
245 };
246
247 // Conditional mutex locker.
248 // Like MutexLocker above, but only locks when condition is true.
249 class ConditionalMutexLocker: public MutexLockerImpl {
|
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_RUNTIME_MUTEXLOCKER_HPP
26 #define SHARE_RUNTIME_MUTEXLOCKER_HPP
27
28 #include "logging/log.hpp"
29 #include "memory/allocation.hpp"
30 #include "runtime/flags/flagSetting.hpp"
31 #include "runtime/mutex.hpp"
32 #include "runtime/perfData.hpp"
33
34 class Thread;
35
36 // Mutexes used in the VM.
37
38 extern Mutex* NMethodState_lock; // a lock used to guard a compiled method state
39 extern Monitor* SystemDictionary_lock; // a lock on the system dictionary
40 extern Mutex* InvokeMethodTypeTable_lock;
41 extern Monitor* InvokeMethodIntrinsicTable_lock;
42 extern Mutex* SharedDictionary_lock; // a lock on the CDS shared dictionary
43 extern Monitor* ClassInitError_lock; // a lock on the class initialization error table
44 extern Mutex* Module_lock; // a lock on module and package related data structures
45 extern Mutex* CompiledIC_lock; // a lock used to guard compiled IC patching and access
46 extern Mutex* VMStatistic_lock; // a lock used to guard statistics count increment
47 extern Mutex* JmethodIdCreation_lock; // a lock on creating JNI method identifiers
48 extern Mutex* JfieldIdCreation_lock; // a lock on creating JNI static field identifiers
49 extern Monitor* JNICritical_lock; // a lock used while synchronizing with threads entering/leaving JNI critical regions
50 extern Mutex* JvmtiThreadState_lock; // a lock on modification of JVMTI thread data
51 extern Monitor* EscapeBarrier_lock; // a lock to sync reallocating and relocking objects because of JVMTI access
52 extern Monitor* VThreadTransition_lock; // a lock used when disabling virtual thread transitions
59 extern Mutex* SignatureHandlerLibrary_lock; // a lock on the SignatureHandlerLibrary
60 extern Mutex* VtableStubs_lock; // a lock on the VtableStubs
61 extern Mutex* SymbolArena_lock; // a lock on the symbol table arena
62 extern Monitor* StringDedup_lock; // a lock on the string deduplication facility
63 extern Mutex* StringDedupIntern_lock; // a lock on StringTable notification of StringDedup
64 extern Monitor* CodeCache_lock; // a lock on the CodeCache
65 extern Mutex* TouchedMethodLog_lock; // a lock on allocation of LogExecutedMethods info
66 extern Mutex* RetData_lock; // a lock on installation of RetData inside method data
67 extern Monitor* VMOperation_lock; // a lock on queue of vm_operations waiting to execute
68 extern Monitor* ThreadsLockThrottle_lock; // used by Thread start/exit to reduce competition for Threads_lock,
69 // so a VM thread calling a safepoint is prioritized
70 extern Monitor* Threads_lock; // a lock on the Threads table of active Java threads
71 // (also used by Safepoints too to block threads creation/destruction)
72 extern Mutex* NonJavaThreadsList_lock; // a lock on the NonJavaThreads list
73 extern Mutex* NonJavaThreadsListSync_lock; // a lock for NonJavaThreads list synchronization
74 extern Monitor* STS_lock; // used for joining/leaving SuspendibleThreadSet.
75 extern Mutex* MonitoringSupport_lock; // Protects updates to the serviceability memory pools and allocated memory high water mark.
76 extern Monitor* ConcurrentGCBreakpoints_lock; // Protects concurrent GC breakpoint management
77 extern Mutex* Compile_lock; // a lock held when Compilation is updating code (used to block CodeCache traversal, CHA updates, etc)
78 extern Monitor* MethodCompileQueue_lock; // a lock held when method compilations are enqueued, dequeued
79 extern Monitor* MethodCompileQueueC1_lock; // a lock held when method compilations are enqueued, dequeued
80 extern Monitor* MethodCompileQueueC2_lock; // a lock held when method compilations are enqueued, dequeued
81 extern Monitor* MethodCompileQueueSC1_lock; // a lock held when method compilations are enqueued, dequeued
82 extern Monitor* MethodCompileQueueSC2_lock; // a lock held when method compilations are enqueued, dequeued
83 extern Monitor* CompileThread_lock; // a lock held by compile threads during compilation system initialization
84 extern Monitor* Compilation_lock; // a lock used to pause compilation
85 extern Mutex* TrainingData_lock; // a lock used when accessing training records
86 extern Monitor* TrainingReplayQueue_lock; // a lock held when class are added/removed to the training replay queue
87 extern Monitor* CompileTaskWait_lock; // a lock held when CompileTasks are waited/notified
88 extern Mutex* CompileStatistics_lock; // a lock held when updating compilation statistics
89 extern Mutex* DirectivesStack_lock; // a lock held when mutating the dirstack and ref counting directives
90 extern Monitor* AOTHeapLoading_lock; // a lock used to guard materialization of AOT heap objects
91 extern Monitor* Terminator_lock; // a lock used to guard termination of the vm
92 extern Monitor* InitCompleted_lock; // a lock used to signal threads waiting on init completed
93 extern Monitor* BeforeExit_lock; // a lock used to guard cleanups and shutdown hooks
94 extern Monitor* Notify_lock; // a lock used to synchronize the start-up of the vm
95 extern Mutex* ExceptionCache_lock; // a lock used to synchronize exception cache updates
96
97 #ifndef PRODUCT
98 extern Mutex* FullGCALot_lock; // a lock to make FullGCALot MT safe
99 #endif // PRODUCT
100
101 #if INCLUDE_G1GC
102 extern Monitor* G1CGC_lock; // used for coordination between fore- & background G1 concurrent GC threads.
182 // See orderAccess.hpp. We assume throughout the VM that MutexLocker's
183 // and friends constructors do a fence, a lock and an acquire *in that
184 // order*. And that their destructors do a release and unlock, in *that*
185 // order. If their implementations change such that these assumptions
186 // are violated, a whole lot of code will break.
187
188 // for debugging: check that we're already owning this lock (or are at a safepoint / handshake)
189 #ifdef ASSERT
190 void assert_locked_or_safepoint(const Mutex* lock);
191 void assert_lock_strong(const Mutex* lock);
192 #else
193 #define assert_locked_or_safepoint(lock)
194 #define assert_lock_strong(lock)
195 #endif
196
197 // Internal implementation. Skips on null Mutex.
198 // Subclasses enforce stronger invariants.
199 class MutexLockerImpl: public StackObj {
200 protected:
201 Mutex* _mutex;
202 bool _prof;
203 elapsedTimer _before;
204 elapsedTimer _after;
205
206 private:
207 static PerfCounter** _perf_lock_count;
208 static PerfCounter** _perf_lock_wait_time;
209 static PerfCounter** _perf_lock_hold_time;
210
211 public:
212
213 MutexLockerImpl(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag);
214
215 MutexLockerImpl(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag);
216
217 ~MutexLockerImpl() {
218 if (_mutex != nullptr) {
219 assert_lock_strong(_mutex);
220 _mutex->unlock();
221
222 if (_mutex->id() == -1) {
223 log_trace(init)("Unnamed unclassified lock: %s", _mutex->name());
224 }
225
226 if (_prof) {
227 assert(UsePerfData, "required");
228 _after.stop();
229 _perf_lock_count [_mutex->id() + 1]->inc();
230 _perf_lock_wait_time[_mutex->id() + 1]->inc(_before.ticks());
231 _perf_lock_hold_time[_mutex->id() + 1]->inc(_after.ticks());
232 }
233 }
234 }
235
236 private:
237 static void print_counter_on(outputStream* st, const char* name, bool is_unique, int idx);
238
239 public:
240 static int name2id(const char* name);
241
242 static void post_initialize();
243 static void init_counters();
244 static void print_counters_on(outputStream* st);
245 };
246
247 // Simplest mutex locker.
248 // Does not allow null mutexes.
249 class MutexLocker: public MutexLockerImpl {
250 public:
251 MutexLocker(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
252 MutexLockerImpl(mutex, flag) {
253 assert(mutex != nullptr, "null mutex not allowed");
254 }
255
256 MutexLocker(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
257 MutexLockerImpl(thread, mutex, flag) {
258 assert(mutex != nullptr, "null mutex not allowed");
259 }
260 };
261
262 // Conditional mutex locker.
263 // Like MutexLocker above, but only locks when condition is true.
264 class ConditionalMutexLocker: public MutexLockerImpl {
|