1 /*
2 * Copyright (c) 1997, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
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 #include "gc/shared/gc_globals.hpp"
26 #include "logging/log.hpp"
27 #include "logging/logStream.hpp"
28 #include "memory/resourceArea.hpp"
29 #include "memory/universe.hpp"
30 #include "runtime/javaThread.hpp"
31 #include "runtime/mutexLocker.hpp"
32 #include "runtime/safepoint.hpp"
33 #include "runtime/vmThread.hpp"
34 #include "utilities/vmError.hpp"
35
36 // Mutexes used in the VM (see comment in mutexLocker.hpp):
37
38 Mutex* NMethodState_lock = nullptr;
39 Mutex* NMethodEntryBarrier_lock = nullptr;
40 Monitor* SystemDictionary_lock = nullptr;
41 Mutex* InvokeMethodTypeTable_lock = nullptr;
42 Monitor* InvokeMethodIntrinsicTable_lock = nullptr;
43 Mutex* SharedDictionary_lock = nullptr;
44 Monitor* ClassInitError_lock = nullptr;
45 Mutex* Module_lock = nullptr;
46 Mutex* CompiledIC_lock = nullptr;
47 Mutex* VMStatistic_lock = nullptr;
48 Mutex* JmethodIdCreation_lock = nullptr;
49 Mutex* JfieldIdCreation_lock = nullptr;
50 Monitor* JNICritical_lock = nullptr;
51 Mutex* JvmtiThreadState_lock = nullptr;
52 Monitor* EscapeBarrier_lock = nullptr;
53 Monitor* JvmtiVTMSTransition_lock = nullptr;
54 Mutex* JvmtiVThreadSuspend_lock = nullptr;
55 Monitor* Heap_lock = nullptr;
56 #if INCLUDE_PARALLELGC
57 Mutex* PSOldGenExpand_lock = nullptr;
58 #endif
59 Mutex* AdapterHandlerLibrary_lock = nullptr;
60 Mutex* SignatureHandlerLibrary_lock = nullptr;
61 Mutex* VtableStubs_lock = nullptr;
62 Mutex* SymbolArena_lock = nullptr;
63 Monitor* StringDedup_lock = nullptr;
64 Mutex* StringDedupIntern_lock = nullptr;
65 Monitor* CodeCache_lock = nullptr;
66 Mutex* TouchedMethodLog_lock = nullptr;
67 Mutex* RetData_lock = nullptr;
68 Monitor* VMOperation_lock = nullptr;
69 Monitor* ThreadsLockThrottle_lock = nullptr;
70 Monitor* Threads_lock = nullptr;
71 Mutex* NonJavaThreadsList_lock = nullptr;
72 Mutex* NonJavaThreadsListSync_lock = nullptr;
73 Monitor* STS_lock = nullptr;
74 Mutex* MonitoringSupport_lock = nullptr;
75 Monitor* ConcurrentGCBreakpoints_lock = nullptr;
76 Mutex* Compile_lock = nullptr;
77 Monitor* CompileTaskWait_lock = nullptr;
78 Monitor* MethodCompileQueue_lock = nullptr;
79 Monitor* CompileThread_lock = nullptr;
80 Monitor* Compilation_lock = nullptr;
81 Mutex* CompileStatistics_lock = nullptr;
82 Mutex* DirectivesStack_lock = nullptr;
83 Monitor* Terminator_lock = nullptr;
84 Monitor* InitCompleted_lock = nullptr;
85 Monitor* BeforeExit_lock = nullptr;
86 Monitor* Notify_lock = nullptr;
87 Mutex* ExceptionCache_lock = nullptr;
88 Mutex* TrainingData_lock = nullptr;
89 Monitor* TrainingReplayQueue_lock = nullptr;
90 #ifndef PRODUCT
91 Mutex* FullGCALot_lock = nullptr;
92 #endif
93
94 Mutex* tty_lock = nullptr;
95
96 Mutex* RawMonitor_lock = nullptr;
97 Mutex* PerfDataMemAlloc_lock = nullptr;
98 Mutex* PerfDataManager_lock = nullptr;
99
100 #if INCLUDE_G1GC
101 Monitor* G1CGC_lock = nullptr;
102 Mutex* G1DetachedRefinementStats_lock = nullptr;
103 Mutex* G1FreeList_lock = nullptr;
104 Mutex* G1MarkStackChunkList_lock = nullptr;
105 Mutex* G1MarkStackFreeList_lock = nullptr;
106 Monitor* G1OldGCCount_lock = nullptr;
107 Mutex* G1OldSets_lock = nullptr;
108 Mutex* G1Uncommit_lock = nullptr;
109 Monitor* G1RootRegionScan_lock = nullptr;
110 Mutex* G1RareEvent_lock = nullptr;
111 #endif
112
113 Mutex* Management_lock = nullptr;
114 Monitor* MonitorDeflation_lock = nullptr;
115 Monitor* Service_lock = nullptr;
116 Monitor* Notification_lock = nullptr;
117 Monitor* PeriodicTask_lock = nullptr;
118 Monitor* RedefineClasses_lock = nullptr;
119 Mutex* Verify_lock = nullptr;
120
121 #if INCLUDE_JFR
122 Mutex* JfrStacktrace_lock = nullptr;
123 Monitor* JfrMsg_lock = nullptr;
124 Mutex* JfrBuffer_lock = nullptr;
125 #endif
126
127 Mutex* CodeHeapStateAnalytics_lock = nullptr;
128
129 Mutex* ExternalsRecorder_lock = nullptr;
130
131 Mutex* AOTCodeCStrings_lock = nullptr;
132
133 Monitor* ContinuationRelativize_lock = nullptr;
134
135 Mutex* Metaspace_lock = nullptr;
136 Monitor* MetaspaceCritical_lock = nullptr;
137 Mutex* ClassLoaderDataGraph_lock = nullptr;
138 Monitor* ThreadsSMRDelete_lock = nullptr;
139 Mutex* ThreadIdTableCreate_lock = nullptr;
140 Mutex* SharedDecoder_lock = nullptr;
141 Mutex* DCmdFactory_lock = nullptr;
142 Mutex* NMTQuery_lock = nullptr;
143 Mutex* NMTCompilationCostHistory_lock = nullptr;
144 Mutex* NmtVirtualMemory_lock = nullptr;
145
146 #if INCLUDE_CDS
147 #if INCLUDE_JVMTI
148 Mutex* CDSClassFileStream_lock = nullptr;
149 #endif
150 Mutex* DumpTimeTable_lock = nullptr;
151 Mutex* CDSLambda_lock = nullptr;
152 Mutex* DumpRegion_lock = nullptr;
153 Mutex* ClassListFile_lock = nullptr;
154 Mutex* UnregisteredClassesTable_lock= nullptr;
155 Mutex* LambdaFormInvokers_lock = nullptr;
156 Mutex* ScratchObjects_lock = nullptr;
157 Mutex* FinalImageRecipes_lock = nullptr;
158 #endif // INCLUDE_CDS
159 Mutex* Bootclasspath_lock = nullptr;
160
161 #if INCLUDE_JVMCI
162 Monitor* JVMCI_lock = nullptr;
163 Monitor* JVMCIRuntime_lock = nullptr;
164 #endif
165
166 // Only one RecursiveMutex
167 RecursiveMutex* MultiArray_lock = nullptr;
168
169 #ifdef ASSERT
170 void assert_locked_or_safepoint(const Mutex* lock) {
171 if (DebuggingContext::is_enabled() || VMError::is_error_reported()) return;
172 // check if this thread owns the lock (common case)
173 assert(lock != nullptr, "Need non-null lock");
174 if (lock->owned_by_self()) return;
175 if (SafepointSynchronize::is_at_safepoint()) return;
176 if (!Universe::is_fully_initialized()) return;
177 fatal("must own lock %s", lock->name());
178 }
179
180 // a stronger assertion than the above
181 void assert_lock_strong(const Mutex* lock) {
182 if (DebuggingContext::is_enabled() || VMError::is_error_reported()) return;
183 assert(lock != nullptr, "Need non-null lock");
184 if (lock->owned_by_self()) return;
185 fatal("must own lock %s", lock->name());
186 }
187 #endif
188
189 #define MUTEX_STORAGE_NAME(name) name##_storage
190 #define MUTEX_STORAGE(name, type) alignas(type) static uint8_t MUTEX_STORAGE_NAME(name)[sizeof(type)]
191 #define MUTEX_DEF(name, type, pri, ...) { \
192 assert(name == nullptr, "Mutex/Monitor initialized twice"); \
193 MUTEX_STORAGE(name, type); \
194 name = ::new(static_cast<void*>(MUTEX_STORAGE_NAME(name))) type((pri), #name, ##__VA_ARGS__); \
195 Mutex::add_mutex(name); \
196 }
197 #define MUTEX_DEFN(name, type, pri, ...) MUTEX_DEF(name, type, Mutex::pri, ##__VA_ARGS__)
198
199 // Specify relative ranked lock
200 #ifdef ASSERT
201 #define MUTEX_DEFL(name, type, held_lock, ...) MUTEX_DEF(name, type, (held_lock)->rank() - 1, ##__VA_ARGS__)
202 #else
203 #define MUTEX_DEFL(name, type, held_lock, ...) MUTEX_DEFN(name, type, safepoint, ##__VA_ARGS__)
204 #endif
205
206 // Using Padded subclasses to prevent false sharing of these global monitors and mutexes.
207 void mutex_init() {
208 MUTEX_DEFN(tty_lock , PaddedMutex , tty); // allow to lock in VM
209
210 MUTEX_DEFN(NMethodEntryBarrier_lock , PaddedMutex , service-1);
211
212 MUTEX_DEFN(STS_lock , PaddedMonitor, nosafepoint);
213
214 #if INCLUDE_G1GC
215 if (UseG1GC) {
216 MUTEX_DEFN(G1CGC_lock , PaddedMonitor, nosafepoint);
217 MUTEX_DEFN(G1DetachedRefinementStats_lock, PaddedMutex , nosafepoint-2);
218 MUTEX_DEFN(G1FreeList_lock , PaddedMutex , service-1);
219 MUTEX_DEFN(G1MarkStackChunkList_lock , PaddedMutex , nosafepoint);
220 MUTEX_DEFN(G1MarkStackFreeList_lock , PaddedMutex , nosafepoint);
221 MUTEX_DEFN(G1OldSets_lock , PaddedMutex , nosafepoint);
222 MUTEX_DEFN(G1RootRegionScan_lock , PaddedMonitor, nosafepoint-1);
223 MUTEX_DEFN(G1Uncommit_lock , PaddedMutex , service-2);
224 }
225 #endif
226
227 MUTEX_DEFN(MonitoringSupport_lock , PaddedMutex , service-1); // used for serviceability monitoring support
228
229 MUTEX_DEFN(StringDedup_lock , PaddedMonitor, nosafepoint);
230 MUTEX_DEFN(StringDedupIntern_lock , PaddedMutex , nosafepoint);
231 MUTEX_DEFN(RawMonitor_lock , PaddedMutex , nosafepoint-1);
232
233 MUTEX_DEFN(Metaspace_lock , PaddedMutex , nosafepoint-3);
234 MUTEX_DEFN(MetaspaceCritical_lock , PaddedMonitor, nosafepoint-1);
235
236 MUTEX_DEFN(MonitorDeflation_lock , PaddedMonitor, nosafepoint); // used for monitor deflation thread operations
237 MUTEX_DEFN(Service_lock , PaddedMonitor, service); // used for service thread operations
238 MUTEX_DEFN(Notification_lock , PaddedMonitor, service); // used for notification thread operations
239
240 MUTEX_DEFN(JmethodIdCreation_lock , PaddedMutex , nosafepoint-1); // used for creating jmethodIDs can also lock HandshakeState_lock
241 MUTEX_DEFN(InvokeMethodTypeTable_lock , PaddedMutex , safepoint);
242 MUTEX_DEFN(InvokeMethodIntrinsicTable_lock , PaddedMonitor, safepoint);
243 MUTEX_DEFN(AdapterHandlerLibrary_lock , PaddedMutex , safepoint);
244 MUTEX_DEFN(SharedDictionary_lock , PaddedMutex , safepoint);
245 MUTEX_DEFN(VMStatistic_lock , PaddedMutex , safepoint);
246 MUTEX_DEFN(SignatureHandlerLibrary_lock , PaddedMutex , safepoint);
247 MUTEX_DEFN(SymbolArena_lock , PaddedMutex , nosafepoint);
248 MUTEX_DEFN(ExceptionCache_lock , PaddedMutex , safepoint);
249 #ifndef PRODUCT
250 MUTEX_DEFN(FullGCALot_lock , PaddedMutex , safepoint); // a lock to make FullGCALot MT safe
251 #endif
252 MUTEX_DEFN(BeforeExit_lock , PaddedMonitor, safepoint);
253
254 MUTEX_DEFN(NonJavaThreadsList_lock , PaddedMutex , nosafepoint-1);
255 MUTEX_DEFN(NonJavaThreadsListSync_lock , PaddedMutex , nosafepoint);
256
257 MUTEX_DEFN(RetData_lock , PaddedMutex , safepoint);
258 MUTEX_DEFN(Terminator_lock , PaddedMonitor, safepoint, true);
259 MUTEX_DEFN(InitCompleted_lock , PaddedMonitor, nosafepoint);
260 MUTEX_DEFN(Notify_lock , PaddedMonitor, safepoint, true);
261
262 MUTEX_DEFN(JfieldIdCreation_lock , PaddedMutex , safepoint);
263
264 MUTEX_DEFN(CompiledIC_lock , PaddedMutex , nosafepoint); // locks VtableStubs_lock
265 MUTEX_DEFN(MethodCompileQueue_lock , PaddedMonitor, safepoint);
266 MUTEX_DEFL(TrainingData_lock , PaddedMutex , MethodCompileQueue_lock);
267 MUTEX_DEFN(TrainingReplayQueue_lock , PaddedMonitor, safepoint);
268 MUTEX_DEFN(CompileStatistics_lock , PaddedMutex , safepoint);
269 MUTEX_DEFN(DirectivesStack_lock , PaddedMutex , nosafepoint);
270
271 MUTEX_DEFN(JvmtiVTMSTransition_lock , PaddedMonitor, safepoint); // used for Virtual Thread Mount State transition management
272 MUTEX_DEFN(JvmtiVThreadSuspend_lock , PaddedMutex, nosafepoint-1);
273 MUTEX_DEFN(EscapeBarrier_lock , PaddedMonitor, nosafepoint); // Used to synchronize object reallocation/relocking triggered by JVMTI
274 MUTEX_DEFN(Management_lock , PaddedMutex , safepoint); // used for JVM management
275
276 MUTEX_DEFN(ConcurrentGCBreakpoints_lock , PaddedMonitor, safepoint, true);
277 MUTEX_DEFN(TouchedMethodLog_lock , PaddedMutex , safepoint);
278
279 MUTEX_DEFN(CompileThread_lock , PaddedMonitor, safepoint);
280 MUTEX_DEFN(PeriodicTask_lock , PaddedMonitor, safepoint, true);
281 MUTEX_DEFN(RedefineClasses_lock , PaddedMonitor, safepoint);
282 MUTEX_DEFN(Verify_lock , PaddedMutex , safepoint);
283 MUTEX_DEFN(ClassLoaderDataGraph_lock , PaddedMutex , safepoint);
284
285 if (WhiteBoxAPI) {
286 MUTEX_DEFN(Compilation_lock , PaddedMonitor, nosafepoint);
287 }
288
289 #if INCLUDE_JFR
290 MUTEX_DEFN(JfrBuffer_lock , PaddedMutex , event);
291 MUTEX_DEFN(JfrMsg_lock , PaddedMonitor, event);
292 MUTEX_DEFN(JfrStacktrace_lock , PaddedMutex , event);
293 #endif
294
295 MUTEX_DEFN(ContinuationRelativize_lock , PaddedMonitor, nosafepoint-3);
296 MUTEX_DEFN(CodeHeapStateAnalytics_lock , PaddedMutex , safepoint);
297 MUTEX_DEFN(ThreadsSMRDelete_lock , PaddedMonitor, service-2); // Holds ConcurrentHashTableResize_lock
298 MUTEX_DEFN(ThreadIdTableCreate_lock , PaddedMutex , safepoint);
299 MUTEX_DEFN(DCmdFactory_lock , PaddedMutex , nosafepoint);
300 MUTEX_DEFN(NMTQuery_lock , PaddedMutex , safepoint);
301 MUTEX_DEFN(NMTCompilationCostHistory_lock , PaddedMutex , nosafepoint);
302 MUTEX_DEFN(NmtVirtualMemory_lock , PaddedMutex , service-4); // Must be lower than G1Mapper_lock used from G1RegionsSmallerThanCommitSizeMapper::commit_regions
303 #if INCLUDE_CDS
304 #if INCLUDE_JVMTI
305 MUTEX_DEFN(CDSClassFileStream_lock , PaddedMutex , safepoint);
306 #endif
307 MUTEX_DEFN(DumpTimeTable_lock , PaddedMutex , nosafepoint);
308 MUTEX_DEFN(CDSLambda_lock , PaddedMutex , nosafepoint);
309 MUTEX_DEFN(DumpRegion_lock , PaddedMutex , nosafepoint);
310 MUTEX_DEFN(ClassListFile_lock , PaddedMutex , nosafepoint);
311 MUTEX_DEFN(UnregisteredClassesTable_lock , PaddedMutex , nosafepoint-1);
312 MUTEX_DEFN(LambdaFormInvokers_lock , PaddedMutex , safepoint);
313 MUTEX_DEFN(ScratchObjects_lock , PaddedMutex , nosafepoint-1); // Holds DumpTimeTable_lock
314 MUTEX_DEFN(FinalImageRecipes_lock , PaddedMutex , nosafepoint);
315 #endif // INCLUDE_CDS
316 MUTEX_DEFN(Bootclasspath_lock , PaddedMutex , nosafepoint);
317
318 #if INCLUDE_JVMCI
319 // JVMCIRuntime::_lock must be acquired before JVMCI_lock to avoid deadlock
320 MUTEX_DEFN(JVMCIRuntime_lock , PaddedMonitor, safepoint, true);
321 #endif
322
323 MUTEX_DEFN(ThreadsLockThrottle_lock , PaddedMonitor, safepoint);
324
325 // These locks have relative rankings, and inherit safepoint checking attributes from that rank.
326 MUTEX_DEFL(VtableStubs_lock , PaddedMutex , CompiledIC_lock); // Also holds DumpTimeTable_lock
327 MUTEX_DEFL(CodeCache_lock , PaddedMonitor, VtableStubs_lock);
328 MUTEX_DEFL(NMethodState_lock , PaddedMutex , CodeCache_lock);
329
330 // tty_lock is held when printing nmethod and its relocations which use this lock.
331 MUTEX_DEFL(ExternalsRecorder_lock , PaddedMutex , tty_lock);
332
333 MUTEX_DEFL(AOTCodeCStrings_lock , PaddedMutex , tty_lock);
334
335 MUTEX_DEFL(Threads_lock , PaddedMonitor, CompileThread_lock, true);
336 MUTEX_DEFL(Compile_lock , PaddedMutex , MethodCompileQueue_lock);
337 MUTEX_DEFL(JNICritical_lock , PaddedMonitor, AdapterHandlerLibrary_lock); // used for JNI critical regions
338 MUTEX_DEFL(Heap_lock , PaddedMonitor, JNICritical_lock);
339
340 MUTEX_DEFL(PerfDataMemAlloc_lock , PaddedMutex , Heap_lock);
341 MUTEX_DEFL(PerfDataManager_lock , PaddedMutex , Heap_lock);
342 MUTEX_DEFL(VMOperation_lock , PaddedMonitor, Heap_lock, true);
343 MUTEX_DEFL(ClassInitError_lock , PaddedMonitor, Threads_lock);
344
345 #if INCLUDE_G1GC
346 if (UseG1GC) {
347 MUTEX_DEFL(G1OldGCCount_lock , PaddedMonitor, Threads_lock, true);
348 MUTEX_DEFL(G1RareEvent_lock , PaddedMutex , Threads_lock, true);
349 }
350 #endif
351
352 MUTEX_DEFL(CompileTaskWait_lock , PaddedMonitor, MethodCompileQueue_lock);
353
354 #if INCLUDE_PARALLELGC
355 if (UseParallelGC) {
356 MUTEX_DEFL(PSOldGenExpand_lock , PaddedMutex , Heap_lock, true);
357 }
358 #endif
359 MUTEX_DEFL(Module_lock , PaddedMutex , ClassLoaderDataGraph_lock);
360 MUTEX_DEFL(SystemDictionary_lock , PaddedMonitor, Module_lock);
361 #if INCLUDE_JVMCI
362 // JVMCIRuntime_lock must be acquired before JVMCI_lock to avoid deadlock
363 MUTEX_DEFL(JVMCI_lock , PaddedMonitor, JVMCIRuntime_lock);
364 #endif
365 MUTEX_DEFL(JvmtiThreadState_lock , PaddedMutex , JvmtiVTMSTransition_lock); // Used by JvmtiThreadState/JvmtiEventController
366 MUTEX_DEFL(SharedDecoder_lock , PaddedMutex , NmtVirtualMemory_lock); // Must be lower than NmtVirtualMemory_lock due to MemTracker::print_containing_region
367
368 // Allocate RecursiveMutex
369 MultiArray_lock = new RecursiveMutex();
370 }
371
372 #undef MUTEX_DEFL
373 #undef MUTEX_DEFN
374 #undef MUTEX_DEF
375 #undef MUTEX_STORAGE
376 #undef MUTEX_STORAGE_NAME
377
378 void MutexLockerImpl::post_initialize() {
379 // Print mutex ranks if requested.
380 LogTarget(Info, vmmutex) lt;
381 if (lt.is_enabled()) {
382 ResourceMark rm;
383 LogStream ls(lt);
384 Mutex::print_lock_ranks(&ls);
385 }
386 }
387
388 GCMutexLocker::GCMutexLocker(Mutex* mutex) {
389 if (SafepointSynchronize::is_at_safepoint()) {
390 _locked = false;
391 } else {
392 _mutex = mutex;
393 _locked = true;
394 _mutex->lock();
395 }
396 }