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