1 /*
2 * Copyright (c) 1997, 2024, 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 "precompiled.hpp"
26 #include "gc/shared/gc_globals.hpp"
27 #include "logging/log.hpp"
28 #include "logging/logStream.hpp"
29 #include "memory/resourceArea.hpp"
30 #include "memory/universe.hpp"
31 #include "runtime/javaThread.hpp"
32 #include "runtime/mutexLocker.hpp"
33 #include "runtime/safepoint.hpp"
34 #include "runtime/vmThread.hpp"
35 #include "utilities/vmError.hpp"
36
37 // Mutexes used in the VM (see comment in mutexLocker.hpp):
38
39 Mutex* Patching_lock = nullptr;
40 Mutex* NMethodState_lock = nullptr;
41 Monitor* SystemDictionary_lock = nullptr;
42 Mutex* InvokeMethodTypeTable_lock = nullptr;
43 Monitor* InvokeMethodIntrinsicTable_lock = nullptr;
44 Mutex* SharedDictionary_lock = nullptr;
45 Monitor* ClassInitError_lock = nullptr;
46 Mutex* Module_lock = nullptr;
47 Mutex* CompiledIC_lock = nullptr;
48 Mutex* VMStatistic_lock = nullptr;
49 Mutex* JmethodIdCreation_lock = nullptr;
50 Mutex* JfieldIdCreation_lock = nullptr;
51 Monitor* JNICritical_lock = nullptr;
52 Mutex* JvmtiThreadState_lock = nullptr;
53 Monitor* EscapeBarrier_lock = nullptr;
54 Monitor* JvmtiVTMSTransition_lock = nullptr;
55 Monitor* Heap_lock = nullptr;
56 #ifdef 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* 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 #ifndef PRODUCT
94 Mutex* FullGCALot_lock = nullptr;
95 #endif
96
97 Mutex* tty_lock = nullptr;
98
99 Mutex* RawMonitor_lock = nullptr;
100 Mutex* PerfDataMemAlloc_lock = nullptr;
101 Mutex* PerfDataManager_lock = nullptr;
102
103 Mutex* FreeList_lock = nullptr;
104 Mutex* OldSets_lock = nullptr;
105 Mutex* Uncommit_lock = nullptr;
106 Monitor* RootRegionScan_lock = nullptr;
107
108 Mutex* Management_lock = nullptr;
109 Monitor* MonitorDeflation_lock = nullptr;
110 Monitor* Service_lock = nullptr;
111 Monitor* Notification_lock = nullptr;
112 Monitor* PeriodicTask_lock = nullptr;
113 Monitor* RedefineClasses_lock = nullptr;
114 Mutex* Verify_lock = nullptr;
115
116 #if INCLUDE_JFR
117 Mutex* JfrStacktrace_lock = nullptr;
118 Monitor* JfrMsg_lock = nullptr;
119 Mutex* JfrBuffer_lock = nullptr;
120 Monitor* JfrThreadSampler_lock = nullptr;
121 #endif
122
123 Mutex* CodeHeapStateAnalytics_lock = nullptr;
124
125 Mutex* ExternalsRecorder_lock = nullptr;
126
127 Monitor* ContinuationRelativize_lock = nullptr;
128
129 Mutex* Metaspace_lock = nullptr;
130 Monitor* MetaspaceCritical_lock = nullptr;
131 Mutex* ClassLoaderDataGraph_lock = nullptr;
132 Monitor* ThreadsSMRDelete_lock = nullptr;
133 Mutex* ThreadIdTableCreate_lock = nullptr;
134 Mutex* SharedDecoder_lock = nullptr;
135 Mutex* DCmdFactory_lock = nullptr;
136 Mutex* NMTQuery_lock = nullptr;
137 Mutex* NMTCompilationCostHistory_lock = nullptr;
138
139 #if INCLUDE_CDS
140 #if INCLUDE_JVMTI
141 Mutex* CDSClassFileStream_lock = nullptr;
142 #endif
143 Mutex* DumpTimeTable_lock = nullptr;
144 Mutex* CDSLambda_lock = nullptr;
145 Mutex* DumpRegion_lock = nullptr;
146 Mutex* ClassListFile_lock = nullptr;
147 Mutex* UnregisteredClassesTable_lock= nullptr;
148 Mutex* LambdaFormInvokers_lock = nullptr;
149 Mutex* ScratchObjects_lock = nullptr;
150 #endif // INCLUDE_CDS
151 Mutex* Bootclasspath_lock = nullptr;
152
153 #if INCLUDE_JVMCI
154 Monitor* JVMCI_lock = nullptr;
155 Monitor* JVMCIRuntime_lock = nullptr;
156 #endif
157
158 // Only one RecursiveMutex
159 RecursiveMutex* MultiArray_lock = nullptr;
160
161 #define MAX_NUM_MUTEX 128
162 static Mutex* _mutex_array[MAX_NUM_MUTEX];
163 static int _num_mutex;
164
165 #ifdef ASSERT
166 void assert_locked_or_safepoint(const Mutex* lock) {
167 if (DebuggingContext::is_enabled() || VMError::is_error_reported()) return;
168 // check if this thread owns the lock (common case)
169 assert(lock != nullptr, "Need non-null lock");
170 if (lock->owned_by_self()) return;
171 if (SafepointSynchronize::is_at_safepoint()) return;
172 if (!Universe::is_fully_initialized()) return;
173 fatal("must own lock %s", lock->name());
174 }
175
176 // a stronger assertion than the above
177 void assert_lock_strong(const Mutex* lock) {
178 if (DebuggingContext::is_enabled() || VMError::is_error_reported()) return;
179 assert(lock != nullptr, "Need non-null lock");
180 if (lock->owned_by_self()) return;
181 fatal("must own lock %s", lock->name());
182 }
183 #endif
184
185 static void add_mutex(Mutex* var) {
186 assert(_num_mutex < MAX_NUM_MUTEX, "increase MAX_NUM_MUTEX");
187 _mutex_array[_num_mutex++] = var;
188 }
189
190 #define MUTEX_STORAGE_NAME(name) name##_storage
191 #define MUTEX_STORAGE(name, type) alignas(type) static uint8_t MUTEX_STORAGE_NAME(name)[sizeof(type)]
192 #define MUTEX_DEF(name, type, pri, ...) { \
193 assert(name == nullptr, "Mutex/Monitor initialized twice"); \
194 MUTEX_STORAGE(name, type); \
195 name = ::new(static_cast<void*>(MUTEX_STORAGE_NAME(name))) type((pri), #name, ##__VA_ARGS__); \
196 add_mutex(name); \
197 }
198 #define MUTEX_DEFN(name, type, pri, ...) MUTEX_DEF(name, type, Mutex::pri, ##__VA_ARGS__)
199
200 // Specify relative ranked lock
201 #ifdef ASSERT
202 #define MUTEX_DEFL(name, type, held_lock, ...) MUTEX_DEF(name, type, (held_lock)->rank() - 1, ##__VA_ARGS__)
203 #else
204 #define MUTEX_DEFL(name, type, held_lock, ...) MUTEX_DEFN(name, type, safepoint, ##__VA_ARGS__)
205 #endif
206
207 // Using Padded subclasses to prevent false sharing of these global monitors and mutexes.
208 void mutex_init() {
209 MUTEX_DEFN(tty_lock , PaddedMutex , tty); // allow to lock in VM
210
211 MUTEX_DEFN(STS_lock , PaddedMonitor, nosafepoint);
212
213 if (UseG1GC) {
214 MUTEX_DEFN(CGC_lock , PaddedMonitor, nosafepoint);
215
216 MUTEX_DEFN(G1DetachedRefinementStats_lock, PaddedMutex , nosafepoint-2);
217
218 MUTEX_DEFN(FreeList_lock , PaddedMutex , service-1);
219 MUTEX_DEFN(OldSets_lock , PaddedMutex , nosafepoint);
220 MUTEX_DEFN(Uncommit_lock , PaddedMutex , service-2);
221 MUTEX_DEFN(RootRegionScan_lock , PaddedMonitor, nosafepoint-1);
222
223 MUTEX_DEFN(MarkStackFreeList_lock , PaddedMutex , nosafepoint);
224 MUTEX_DEFN(MarkStackChunkList_lock , PaddedMutex , nosafepoint);
225 }
226 MUTEX_DEFN(MonitoringSupport_lock , PaddedMutex , service-1); // used for serviceability monitoring support
227
228 MUTEX_DEFN(StringDedup_lock , PaddedMonitor, nosafepoint);
229 MUTEX_DEFN(StringDedupIntern_lock , PaddedMutex , nosafepoint);
230 MUTEX_DEFN(RawMonitor_lock , PaddedMutex , nosafepoint-1);
231
232 MUTEX_DEFN(Metaspace_lock , PaddedMutex , nosafepoint-3);
233 MUTEX_DEFN(MetaspaceCritical_lock , PaddedMonitor, nosafepoint-1);
234
235 MUTEX_DEFN(Patching_lock , PaddedMutex , nosafepoint); // used for safepointing and code patching.
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-2); // used for creating jmethodIDs.
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_DEFN(CompileStatistics_lock , PaddedMutex , safepoint);
267 MUTEX_DEFN(DirectivesStack_lock , PaddedMutex , nosafepoint);
268
269 MUTEX_DEFN(JvmtiVTMSTransition_lock , PaddedMonitor, safepoint); // used for Virtual Thread Mount State transition management
270 MUTEX_DEFN(EscapeBarrier_lock , PaddedMonitor, nosafepoint); // Used to synchronize object reallocation/relocking triggered by JVMTI
271 MUTEX_DEFN(Management_lock , PaddedMutex , safepoint); // used for JVM management
272
273 MUTEX_DEFN(ConcurrentGCBreakpoints_lock , PaddedMonitor, safepoint, true);
274 MUTEX_DEFN(TouchedMethodLog_lock , PaddedMutex , safepoint);
275
276 MUTEX_DEFN(CompileThread_lock , PaddedMonitor, safepoint);
277 MUTEX_DEFN(PeriodicTask_lock , PaddedMonitor, safepoint, true);
278 MUTEX_DEFN(RedefineClasses_lock , PaddedMonitor, safepoint);
279 MUTEX_DEFN(Verify_lock , PaddedMutex , safepoint);
280 MUTEX_DEFN(ClassLoaderDataGraph_lock , PaddedMutex , safepoint);
281
282 if (WhiteBoxAPI) {
283 MUTEX_DEFN(Compilation_lock , PaddedMonitor, nosafepoint);
284 }
285
286 #if INCLUDE_JFR
287 MUTEX_DEFN(JfrBuffer_lock , PaddedMutex , event);
288 MUTEX_DEFN(JfrMsg_lock , PaddedMonitor, event);
289 MUTEX_DEFN(JfrStacktrace_lock , PaddedMutex , event);
290 MUTEX_DEFN(JfrThreadSampler_lock , PaddedMonitor, nosafepoint);
291 #endif
292
293 MUTEX_DEFN(ContinuationRelativize_lock , PaddedMonitor, nosafepoint-3);
294 MUTEX_DEFN(CodeHeapStateAnalytics_lock , PaddedMutex , safepoint);
295 MUTEX_DEFN(ThreadsSMRDelete_lock , PaddedMonitor, service-2); // Holds ConcurrentHashTableResize_lock
296 MUTEX_DEFN(ThreadIdTableCreate_lock , PaddedMutex , safepoint);
297 MUTEX_DEFN(SharedDecoder_lock , PaddedMutex , tty-1);
298 MUTEX_DEFN(DCmdFactory_lock , PaddedMutex , nosafepoint);
299 MUTEX_DEFN(NMTQuery_lock , PaddedMutex , safepoint);
300 MUTEX_DEFN(NMTCompilationCostHistory_lock , PaddedMutex , nosafepoint);
301 #if INCLUDE_CDS
302 #if INCLUDE_JVMTI
303 MUTEX_DEFN(CDSClassFileStream_lock , PaddedMutex , safepoint);
304 #endif
305 MUTEX_DEFN(DumpTimeTable_lock , PaddedMutex , nosafepoint);
306 MUTEX_DEFN(CDSLambda_lock , PaddedMutex , nosafepoint);
307 MUTEX_DEFN(DumpRegion_lock , PaddedMutex , nosafepoint);
308 MUTEX_DEFN(ClassListFile_lock , PaddedMutex , nosafepoint);
309 MUTEX_DEFN(UnregisteredClassesTable_lock , PaddedMutex , nosafepoint-1);
310 MUTEX_DEFN(LambdaFormInvokers_lock , PaddedMutex , safepoint);
311 MUTEX_DEFN(ScratchObjects_lock , PaddedMutex , nosafepoint-1); // Holds DumpTimeTable_lock
312 #endif // INCLUDE_CDS
313 MUTEX_DEFN(Bootclasspath_lock , PaddedMutex , nosafepoint);
314
315 #if INCLUDE_JVMCI
316 // JVMCIRuntime::_lock must be acquired before JVMCI_lock to avoid deadlock
317 MUTEX_DEFN(JVMCIRuntime_lock , PaddedMonitor, safepoint, true);
318 #endif
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(Threads_lock , PaddedMonitor, CompileThread_lock, true);
329 MUTEX_DEFL(Compile_lock , PaddedMutex , MethodCompileQueue_lock);
330 MUTEX_DEFL(Heap_lock , PaddedMonitor, AdapterHandlerLibrary_lock);
331
332 MUTEX_DEFL(PerfDataMemAlloc_lock , PaddedMutex , Heap_lock);
333 MUTEX_DEFL(PerfDataManager_lock , PaddedMutex , Heap_lock);
334 MUTEX_DEFL(VMOperation_lock , PaddedMonitor, Heap_lock, true);
335 MUTEX_DEFL(ClassInitError_lock , PaddedMonitor, Threads_lock);
336
337 if (UseG1GC) {
338 MUTEX_DEFL(G1OldGCCount_lock , PaddedMonitor, Threads_lock, true);
339 MUTEX_DEFL(G1RareEvent_lock , PaddedMutex , Threads_lock, true);
340 }
341
342 MUTEX_DEFL(CompileTaskAlloc_lock , PaddedMutex , MethodCompileQueue_lock);
343 #ifdef INCLUDE_PARALLELGC
344 if (UseParallelGC) {
345 MUTEX_DEFL(PSOldGenExpand_lock , PaddedMutex , Heap_lock, true);
346 }
347 #endif
348 MUTEX_DEFL(Module_lock , PaddedMutex , ClassLoaderDataGraph_lock);
349 MUTEX_DEFL(SystemDictionary_lock , PaddedMonitor, Module_lock);
350 MUTEX_DEFL(JNICritical_lock , PaddedMonitor, AdapterHandlerLibrary_lock); // used for JNI critical regions
351 #if INCLUDE_JVMCI
352 // JVMCIRuntime_lock must be acquired before JVMCI_lock to avoid deadlock
353 MUTEX_DEFL(JVMCI_lock , PaddedMonitor, JVMCIRuntime_lock);
354 #endif
355 MUTEX_DEFL(JvmtiThreadState_lock , PaddedMutex , JvmtiVTMSTransition_lock); // Used by JvmtiThreadState/JvmtiEventController
356
357 // Allocate RecursiveMutex
358 MultiArray_lock = new RecursiveMutex();
359 }
360
361 #undef MUTEX_DEFL
362 #undef MUTEX_DEFN
363 #undef MUTEX_DEF
364 #undef MUTEX_STORAGE
365 #undef MUTEX_STORAGE_NAME
366
367 void MutexLockerImpl::post_initialize() {
368 // Print mutex ranks if requested.
369 LogTarget(Info, vmmutex) lt;
370 if (lt.is_enabled()) {
371 ResourceMark rm;
372 LogStream ls(lt);
373 print_lock_ranks(&ls);
374 }
375 }
376
377 GCMutexLocker::GCMutexLocker(Mutex* mutex) {
378 if (SafepointSynchronize::is_at_safepoint()) {
379 _locked = false;
380 } else {
381 _mutex = mutex;
382 _locked = true;
383 _mutex->lock();
384 }
385 }
386
387 // Print all mutexes/monitors that are currently owned by a thread; called
388 // by fatal error handler.
389 void print_owned_locks_on_error(outputStream* st) {
390 st->print("VM Mutex/Monitor currently owned by a thread: ");
391 bool none = true;
392 for (int i = 0; i < _num_mutex; i++) {
393 // see if it has an owner
394 if (_mutex_array[i]->owner() != nullptr) {
395 if (none) {
396 // print format used by Mutex::print_on_error()
397 st->print_cr(" ([mutex/lock_event])");
398 none = false;
399 }
400 _mutex_array[i]->print_on_error(st);
401 st->cr();
402 }
403 }
404 if (none) st->print_cr("None");
405 }
406
407 void print_lock_ranks(outputStream* st) {
408 st->print_cr("VM Mutex/Monitor ranks: ");
409
410 #ifdef ASSERT
411 // Be extra defensive and figure out the bounds on
412 // ranks right here. This also saves a bit of time
413 // in the #ranks*#mutexes loop below.
414 int min_rank = INT_MAX;
415 int max_rank = INT_MIN;
416 for (int i = 0; i < _num_mutex; i++) {
417 Mutex* m = _mutex_array[i];
418 int r = (int) m->rank();
419 if (min_rank > r) min_rank = r;
420 if (max_rank < r) max_rank = r;
421 }
422
423 // Print the listings rank by rank
424 for (int r = min_rank; r <= max_rank; r++) {
425 bool first = true;
426 for (int i = 0; i < _num_mutex; i++) {
427 Mutex* m = _mutex_array[i];
428 if (r != (int) m->rank()) continue;
429
430 if (first) {
431 st->cr();
432 st->print_cr("Rank \"%s\":", m->rank_name());
433 first = false;
434 }
435 st->print_cr(" %s", m->name());
436 }
437 }
438 #else
439 st->print_cr(" Only known in debug builds.");
440 #endif // ASSERT
441 }