1 /*
2 * Copyright (c) 1997, 2015, 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 "runtime/mutexLocker.hpp"
27 #include "runtime/os.inline.hpp"
28 #include "runtime/safepoint.hpp"
29 #include "runtime/thread.inline.hpp"
30 #include "runtime/threadLocalStorage.hpp"
31 #include "runtime/vmThread.hpp"
32
33 // Mutexes used in the VM (see comment in mutexLocker.hpp):
34 //
35 // Note that the following pointers are effectively final -- after having been
36 // set at JVM startup-time, they should never be subsequently mutated.
37 // Instead of using pointers to malloc()ed monitors and mutexes we should consider
38 // eliminating the indirection and using instances instead.
39 // Consider using GCC's __read_mostly.
40
41 Mutex* Patching_lock = NULL;
42 Monitor* SystemDictionary_lock = NULL;
43 Mutex* PackageTable_lock = NULL;
44 Mutex* CompiledIC_lock = NULL;
45 Mutex* InlineCacheBuffer_lock = NULL;
46 Mutex* VMStatistic_lock = NULL;
47 Mutex* JNIGlobalHandle_lock = NULL;
48 Mutex* JNIHandleBlockFreeList_lock = NULL;
49 Mutex* MemberNameTable_lock = NULL;
50 Mutex* JmethodIdCreation_lock = NULL;
51 Mutex* JfieldIdCreation_lock = NULL;
52 Monitor* JNICritical_lock = NULL;
53 Mutex* JvmtiThreadState_lock = NULL;
54 Monitor* JvmtiPendingEvent_lock = NULL;
55 Monitor* Heap_lock = NULL;
56 Monitor* ShenandoahHeap_lock = NULL;
57 Monitor* ShenandoahFullGC_lock = NULL;
58 Monitor* ShenandoahJNICritical_lock = NULL;
59 Mutex* ExpandHeap_lock = NULL;
60 Mutex* AdapterHandlerLibrary_lock = NULL;
61 Mutex* SignatureHandlerLibrary_lock = NULL;
62 Mutex* VtableStubs_lock = NULL;
63 Mutex* SymbolTable_lock = NULL;
64 Mutex* StringTable_lock = NULL;
65 Monitor* StringDedupQueue_lock = NULL;
66 Mutex* StringDedupTable_lock = NULL;
67 Monitor* CodeCache_lock = NULL;
68 Mutex* MethodData_lock = NULL;
69 Mutex* TouchedMethodLog_lock = NULL;
70 Mutex* RetData_lock = NULL;
71 Monitor* VMOperationQueue_lock = NULL;
72 Monitor* VMOperationRequest_lock = NULL;
73 Monitor* Safepoint_lock = NULL;
74 Monitor* SerializePage_lock = NULL;
75 Monitor* Threads_lock = NULL;
76 Monitor* CGC_lock = NULL;
77 Monitor* STS_lock = NULL;
78 Monitor* SLT_lock = NULL;
79 Monitor* FullGCCount_lock = NULL;
80 Monitor* CMark_lock = NULL;
81 Mutex* CMRegionStack_lock = NULL;
82 Mutex* SATB_Q_FL_lock = NULL;
83 Monitor* SATB_Q_CBL_mon = NULL;
84 Mutex* Shared_SATB_Q_lock = NULL;
85 Mutex* DirtyCardQ_FL_lock = NULL;
86 Monitor* DirtyCardQ_CBL_mon = NULL;
87 Mutex* Shared_DirtyCardQ_lock = NULL;
88 Mutex* ParGCRareEvent_lock = NULL;
89 Mutex* DerivedPointerTableGC_lock = NULL;
90 Mutex* Compile_lock = NULL;
91 Monitor* MethodCompileQueue_lock = NULL;
92 Monitor* CompileThread_lock = NULL;
93 Monitor* Compilation_lock = NULL;
94 Mutex* CompileTaskAlloc_lock = NULL;
95 Mutex* CompileStatistics_lock = NULL;
96 Mutex* MultiArray_lock = NULL;
97 Monitor* Terminator_lock = NULL;
98 Monitor* BeforeExit_lock = NULL;
99 Monitor* Notify_lock = NULL;
100 Monitor* Interrupt_lock = NULL;
101 Monitor* ProfileVM_lock = NULL;
102 Mutex* ProfilePrint_lock = NULL;
103 Mutex* ExceptionCache_lock = NULL;
104 Monitor* ObjAllocPost_lock = NULL;
105 Mutex* OsrList_lock = NULL;
106 Monitor* ShenandoahMemProtect_lock = NULL;
107
108 #ifndef PRODUCT
109 Mutex* FullGCALot_lock = NULL;
110 #endif
111
112 Mutex* Debug1_lock = NULL;
113 Mutex* Debug2_lock = NULL;
114 Mutex* Debug3_lock = NULL;
115
116 Mutex* tty_lock = NULL;
117
118 Mutex* RawMonitor_lock = NULL;
119 Mutex* PerfDataMemAlloc_lock = NULL;
120 Mutex* PerfDataManager_lock = NULL;
121 Mutex* OopMapCacheAlloc_lock = NULL;
122
123 Mutex* FreeList_lock = NULL;
124 Monitor* SecondaryFreeList_lock = NULL;
125 Mutex* OldSets_lock = NULL;
126 Monitor* RootRegionScan_lock = NULL;
127 Mutex* MMUTracker_lock = NULL;
128
129 Monitor* GCTaskManager_lock = NULL;
130
131 Mutex* Management_lock = NULL;
132 Monitor* Service_lock = NULL;
133 Monitor* PeriodicTask_lock = NULL;
134
135 #ifdef INCLUDE_TRACE
136 Mutex* JfrStacktrace_lock = NULL;
137 Monitor* JfrMsg_lock = NULL;
138 Mutex* JfrBuffer_lock = NULL;
139 Mutex* JfrStream_lock = NULL;
140 Mutex* JfrThreadGroups_lock = NULL;
141 #endif
142
143 #ifndef SUPPORTS_NATIVE_CX8
144 Mutex* UnsafeJlong_lock = NULL;
145 #endif
146
147 #define MAX_NUM_MUTEX 128
148 static Monitor * _mutex_array[MAX_NUM_MUTEX];
149 static int _num_mutex;
150
151 #ifdef ASSERT
152 void assert_locked_or_safepoint(const Monitor * lock) {
153 // check if this thread owns the lock (common case)
154 if (IgnoreLockingAssertions) return;
155 assert(lock != NULL, "Need non-NULL lock");
156 if (lock->owned_by_self()) return;
157 if (SafepointSynchronize::is_at_safepoint()) return;
158 if (!Universe::is_fully_initialized()) return;
159 // see if invoker of VM operation owns it
160 VM_Operation* op = VMThread::vm_operation();
161 if (op != NULL && op->calling_thread() == lock->owner()) return;
162 fatal(err_msg("must own lock %s", lock->name()));
163 }
164
165 // a stronger assertion than the above
166 void assert_lock_strong(const Monitor * lock) {
167 if (IgnoreLockingAssertions) return;
168 assert(lock != NULL, "Need non-NULL lock");
169 if (lock->owned_by_self()) return;
170 fatal(err_msg("must own lock %s", lock->name()));
171 }
172 #endif
173
174 #define def(var, type, pri, vm_block, safepoint_check_allowed ) { \
175 var = new type(Mutex::pri, #var, vm_block, safepoint_check_allowed); \
176 assert(_num_mutex < MAX_NUM_MUTEX, "increase MAX_NUM_MUTEX"); \
177 _mutex_array[_num_mutex++] = var; \
178 }
179
180 void mutex_init() {
181 def(tty_lock , Mutex , event, true, Monitor::_safepoint_check_never); // allow to lock in VM
182
183 def(CGC_lock , Monitor, special, true, Monitor::_safepoint_check_never); // coordinate between fore- and background GC
184 def(STS_lock , Monitor, leaf, true, Monitor::_safepoint_check_never);
185
186 if (UseConcMarkSweepGC || UseG1GC) {
187 def(FullGCCount_lock , Monitor, leaf, true, Monitor::_safepoint_check_never); // in support of ExplicitGCInvokesConcurrent
188 }
189 if (UseG1GC) {
190
191 def(CMark_lock , Monitor, nonleaf, true, Monitor::_safepoint_check_never); // coordinate concurrent mark thread
192 def(CMRegionStack_lock , Mutex, leaf, true, Monitor::_safepoint_check_never);
193 def(SATB_Q_FL_lock , Mutex , special, true, Monitor::_safepoint_check_never);
194 def(SATB_Q_CBL_mon , Monitor, nonleaf, true, Monitor::_safepoint_check_never);
195 def(Shared_SATB_Q_lock , Mutex, nonleaf, true, Monitor::_safepoint_check_never);
196
197 def(DirtyCardQ_FL_lock , Mutex , special, true, Monitor::_safepoint_check_never);
198 def(DirtyCardQ_CBL_mon , Monitor, nonleaf, true, Monitor::_safepoint_check_never);
199 def(Shared_DirtyCardQ_lock , Mutex, nonleaf, true, Monitor::_safepoint_check_never);
200
201 def(FreeList_lock , Mutex, leaf , true, Monitor::_safepoint_check_never);
202 def(SecondaryFreeList_lock , Monitor, leaf , true, Monitor::_safepoint_check_never);
203 def(OldSets_lock , Mutex , leaf , true, Monitor::_safepoint_check_never);
204 def(RootRegionScan_lock , Monitor, leaf , true, Monitor::_safepoint_check_never);
205 def(MMUTracker_lock , Mutex , leaf , true, Monitor::_safepoint_check_never);
206
207 def(StringDedupQueue_lock , Monitor, leaf, true, Monitor::_safepoint_check_never);
208 def(StringDedupTable_lock , Mutex , leaf, true, Monitor::_safepoint_check_never);
209 }
210 if (UseShenandoahGC) {
211 def(SATB_Q_FL_lock , Mutex , special, true, Monitor::_safepoint_check_never);
212 def(SATB_Q_CBL_mon , Monitor, nonleaf, true, Monitor::_safepoint_check_never);
213 def(Shared_SATB_Q_lock , Mutex, nonleaf, true, Monitor::_safepoint_check_never);
214 def(ShenandoahFullGC_lock , Monitor, leaf, true, Monitor::_safepoint_check_always);
215 def(ShenandoahJNICritical_lock , Monitor, nonleaf+1, false, Monitor::_safepoint_check_never);
216 def(ShenandoahMemProtect_lock , Monitor, native, false, Monitor::_safepoint_check_never);
217 }
218 def(ParGCRareEvent_lock , Mutex , leaf , true, Monitor::_safepoint_check_sometimes);
219 def(DerivedPointerTableGC_lock , Mutex, leaf, true, Monitor::_safepoint_check_never);
220 def(CodeCache_lock , Mutex , special, true, Monitor::_safepoint_check_never);
221 def(Interrupt_lock , Monitor, special, true, Monitor::_safepoint_check_never); // used for interrupt processing
222 def(RawMonitor_lock , Mutex, special, true, Monitor::_safepoint_check_never);
223 def(OopMapCacheAlloc_lock , Mutex, leaf, true, Monitor::_safepoint_check_always); // used for oop_map_cache allocation.
224
225 def(Patching_lock , Mutex , special, true, Monitor::_safepoint_check_never); // used for safepointing and code patching.
226 def(ObjAllocPost_lock , Monitor, special, false, Monitor::_safepoint_check_never);
227 def(Service_lock , Monitor, special, true, Monitor::_safepoint_check_never); // used for service thread operations
228 def(JmethodIdCreation_lock , Mutex , leaf, true, Monitor::_safepoint_check_always); // used for creating jmethodIDs.
229
230 def(SystemDictionary_lock , Monitor, leaf, true, Monitor::_safepoint_check_always); // lookups done by VM thread
231 def(PackageTable_lock , Mutex , leaf, false, Monitor::_safepoint_check_always);
232 def(InlineCacheBuffer_lock , Mutex , leaf, true, Monitor::_safepoint_check_always);
233 def(VMStatistic_lock , Mutex , leaf, false, Monitor::_safepoint_check_always);
234 def(ExpandHeap_lock , Mutex , leaf, true, Monitor::_safepoint_check_always); // Used during compilation by VM thread
235 def(JNIHandleBlockFreeList_lock , Mutex , leaf, true, Monitor::_safepoint_check_never); // handles are used by VM thread
236 def(SignatureHandlerLibrary_lock , Mutex , leaf, false, Monitor::_safepoint_check_always);
237 def(SymbolTable_lock , Mutex , leaf+2, true, Monitor::_safepoint_check_always);
238 def(StringTable_lock , Mutex , leaf, true, Monitor::_safepoint_check_always);
239 def(ProfilePrint_lock , Mutex , leaf, false, Monitor::_safepoint_check_always); // serial profile printing
240 def(ExceptionCache_lock , Mutex , leaf, false, Monitor::_safepoint_check_always); // serial profile printing
241 def(OsrList_lock , Mutex , leaf, true, Monitor::_safepoint_check_never);
242 def(Debug1_lock , Mutex , leaf, true, Monitor::_safepoint_check_never);
243 #ifndef PRODUCT
244 def(FullGCALot_lock , Mutex , leaf, false, Monitor::_safepoint_check_always); // a lock to make FullGCALot MT safe
245 #endif
246 def(BeforeExit_lock , Monitor, leaf, true, Monitor::_safepoint_check_always);
247 def(PerfDataMemAlloc_lock , Mutex , leaf, true, Monitor::_safepoint_check_always); // used for allocating PerfData memory for performance data
248 def(PerfDataManager_lock , Mutex , leaf, true, Monitor::_safepoint_check_always); // used for synchronized access to PerfDataManager resources
249
250 // CMS_modUnionTable_lock leaf
251 // CMS_bitMap_lock leaf 1
252 // CMS_freeList_lock leaf 2
253
254 def(Safepoint_lock , Monitor, safepoint, true, Monitor::_safepoint_check_sometimes); // locks SnippetCache_lock/Threads_lock
255
256 def(Threads_lock , Monitor, barrier, true, Monitor::_safepoint_check_sometimes);
257
258 def(VMOperationQueue_lock , Monitor, nonleaf, true, Monitor::_safepoint_check_sometimes); // VM_thread allowed to block on these
259 def(VMOperationRequest_lock , Monitor, nonleaf, true, Monitor::_safepoint_check_sometimes);
260 def(RetData_lock , Mutex , nonleaf, false, Monitor::_safepoint_check_always);
261 def(Terminator_lock , Monitor, nonleaf, true, Monitor::_safepoint_check_sometimes);
262 def(VtableStubs_lock , Mutex , nonleaf, true, Monitor::_safepoint_check_always);
263 def(Notify_lock , Monitor, nonleaf, true, Monitor::_safepoint_check_always);
264 def(JNIGlobalHandle_lock , Mutex , nonleaf, true, Monitor::_safepoint_check_always); // locks JNIHandleBlockFreeList_lock
265 def(JNICritical_lock , Monitor, nonleaf, true, Monitor::_safepoint_check_always); // used for JNI critical regions
266 def(AdapterHandlerLibrary_lock , Mutex , nonleaf, true, Monitor::_safepoint_check_always);
267 if (UseConcMarkSweepGC) {
268 def(SLT_lock , Monitor, nonleaf, false, Monitor::_safepoint_check_never); // used in CMS GC for locking PLL lock
269 }
270
271 def(Heap_lock , Monitor, nonleaf+1, false, Monitor::_safepoint_check_sometimes);
272 def(ShenandoahHeap_lock , Monitor, special, false, Monitor::_safepoint_check_never);
273 def(JfieldIdCreation_lock , Mutex , nonleaf+1, true, Monitor::_safepoint_check_always); // jfieldID, Used in VM_Operation
274 def(MemberNameTable_lock , Mutex , nonleaf+1, false, Monitor::_safepoint_check_always); // Used to protect MemberNameTable
275
276 def(CompiledIC_lock , Mutex , nonleaf+2, false, Monitor::_safepoint_check_always); // locks VtableStubs_lock, InlineCacheBuffer_lock
277 def(CompileTaskAlloc_lock , Mutex , nonleaf+2, true, Monitor::_safepoint_check_always);
278 def(CompileStatistics_lock , Mutex , nonleaf+2, false, Monitor::_safepoint_check_always);
279 def(MultiArray_lock , Mutex , nonleaf+2, false, Monitor::_safepoint_check_always); // locks SymbolTable_lock
280
281 def(JvmtiThreadState_lock , Mutex , nonleaf+2, false, Monitor::_safepoint_check_always); // Used by JvmtiThreadState/JvmtiEventController
282 def(JvmtiPendingEvent_lock , Monitor, nonleaf, false, Monitor::_safepoint_check_never); // Used by JvmtiCodeBlobEvents
283 def(Management_lock , Mutex , nonleaf+2, false, Monitor::_safepoint_check_always); // used for JVM management
284
285 def(Compile_lock , Mutex , nonleaf+3, true, Monitor::_safepoint_check_sometimes);
286 def(MethodData_lock , Mutex , nonleaf+3, false, Monitor::_safepoint_check_always);
287 def(TouchedMethodLog_lock , Mutex , nonleaf+3, false, Monitor::_safepoint_check_always);
288
289 def(MethodCompileQueue_lock , Monitor, nonleaf+4, true, Monitor::_safepoint_check_always);
290 def(Debug2_lock , Mutex , nonleaf+4, true, Monitor::_safepoint_check_never);
291 def(Debug3_lock , Mutex , nonleaf+4, true, Monitor::_safepoint_check_never);
292 def(ProfileVM_lock , Monitor, special, false, Monitor::_safepoint_check_never); // used for profiling of the VMThread
293 def(CompileThread_lock , Monitor, nonleaf+5, false, Monitor::_safepoint_check_always);
294 def(PeriodicTask_lock , Monitor, nonleaf+5, true, Monitor::_safepoint_check_sometimes);
295 if (WhiteBoxAPI) {
296 def(Compilation_lock , Monitor, leaf, false, Monitor::_safepoint_check_never);
297 }
298
299 #ifdef INCLUDE_TRACE
300 def(JfrMsg_lock , Monitor, leaf, true, Monitor::_safepoint_check_always);
301 def(JfrBuffer_lock , Mutex, leaf, true, Monitor::_safepoint_check_never);
302 def(JfrThreadGroups_lock , Mutex, leaf, true, Monitor::_safepoint_check_always);
303 def(JfrStream_lock , Mutex, nonleaf, true, Monitor::_safepoint_check_never);
304 def(JfrStacktrace_lock , Mutex, special, true, Monitor::_safepoint_check_sometimes);
305 #endif
306
307 #ifndef SUPPORTS_NATIVE_CX8
308 def(UnsafeJlong_lock , Mutex, special, false, Monitor::_safepoint_check_never);
309 #endif
310 }
311
312 GCMutexLocker::GCMutexLocker(Monitor * mutex) {
313 if (SafepointSynchronize::is_at_safepoint()) {
314 _locked = false;
315 } else {
316 _mutex = mutex;
317 _locked = true;
318 _mutex->lock();
319 }
320 }
321
322 // Print all mutexes/monitors that are currently owned by a thread; called
323 // by fatal error handler.
324 void print_owned_locks_on_error(outputStream* st) {
325 st->print("VM Mutex/Monitor currently owned by a thread: ");
326 bool none = true;
327 for (int i = 0; i < _num_mutex; i++) {
328 // see if it has an owner
329 if (_mutex_array[i]->owner() != NULL) {
330 if (none) {
331 // print format used by Mutex::print_on_error()
332 st->print_cr(" ([mutex/lock_event])");
333 none = false;
334 }
335 _mutex_array[i]->print_on_error(st);
336 st->cr();
337 }
338 }
339 if (none) st->print_cr("None");
340 }