1 /*
2 * Copyright (c) 1997, 2018, 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 #ifndef SHARE_VM_RUNTIME_MUTEXLOCKER_HPP
26 #define SHARE_VM_RUNTIME_MUTEXLOCKER_HPP
27
28 #include "memory/allocation.hpp"
29 #include "runtime/flags/flagSetting.hpp"
30 #include "runtime/mutex.hpp"
31
32 // Mutexes used in the VM.
33
34 extern Mutex* Patching_lock; // a lock used to guard code patching of compiled code
35 extern Monitor* SystemDictionary_lock; // a lock on the system dictionary
36 extern Mutex* SharedDictionary_lock; // a lock on the CDS shared dictionary
37 extern Mutex* Module_lock; // a lock on module and package related data structures
38 extern Mutex* CompiledIC_lock; // a lock used to guard compiled IC patching and access
39 extern Mutex* InlineCacheBuffer_lock; // a lock used to guard the InlineCacheBuffer
40 extern Mutex* VMStatistic_lock; // a lock used to guard statistics count increment
41 extern Mutex* JNIGlobalAlloc_lock; // JNI global storage allocate list lock
42 extern Mutex* JNIGlobalActive_lock; // JNI global storage active list lock
43 extern Mutex* JNIWeakAlloc_lock; // JNI weak storage allocate list lock
44 extern Mutex* JNIWeakActive_lock; // JNI weak storage active list lock
45 extern Mutex* StringTableWeakAlloc_lock; // StringTable weak storage allocate list lock
46 extern Mutex* StringTableWeakActive_lock; // STringTable weak storage active list lock
47 extern Mutex* JNIHandleBlockFreeList_lock; // a lock on the JNI handle block free list
48 extern Mutex* VMWeakAlloc_lock; // VM Weak Handles storage allocate list lock
49 extern Mutex* VMWeakActive_lock; // VM Weak Handles storage active list lock
50 extern Mutex* ResolvedMethodTable_lock; // a lock on the ResolvedMethodTable updates
51 extern Mutex* JmethodIdCreation_lock; // a lock on creating JNI method identifiers
52 extern Mutex* JfieldIdCreation_lock; // a lock on creating JNI static field identifiers
53 extern Monitor* JNICritical_lock; // a lock used while entering and exiting JNI critical regions, allows GC to sometimes get in
54 extern Mutex* JvmtiThreadState_lock; // a lock on modification of JVMTI thread data
55 extern Monitor* Heap_lock; // a lock on the heap
56 extern Mutex* ExpandHeap_lock; // a lock on expanding the heap
57 extern Mutex* AdapterHandlerLibrary_lock; // a lock on the AdapterHandlerLibrary
58 extern Mutex* SignatureHandlerLibrary_lock; // a lock on the SignatureHandlerLibrary
59 extern Mutex* VtableStubs_lock; // a lock on the VtableStubs
60 extern Mutex* SymbolArena_lock; // a lock on the symbol table arena
61 extern Mutex* StringTable_lock; // a lock on the interned string table
62 extern Monitor* StringDedupQueue_lock; // a lock on the string deduplication queue
63 extern Mutex* StringDedupTable_lock; // a lock on the string deduplication table
64 extern Monitor* CodeCache_lock; // a lock on the CodeCache, rank is special, use MutexLockerEx
65 extern Mutex* MethodData_lock; // a lock on installation of method data
66 extern Mutex* TouchedMethodLog_lock; // a lock on allocation of LogExecutedMethods info
67 extern Mutex* RetData_lock; // a lock on installation of RetData inside method data
68 extern Mutex* DerivedPointerTableGC_lock; // a lock to protect the derived pointer table
69 extern Monitor* CGCPhaseManager_lock; // a lock to protect a concurrent GC's phase management
70 extern Monitor* VMOperationQueue_lock; // a lock on queue of vm_operations waiting to execute
71 extern Monitor* VMOperationRequest_lock; // a lock on Threads waiting for a vm_operation to terminate
72 extern Monitor* Safepoint_lock; // a lock used by the safepoint abstraction
73 extern Monitor* Threads_lock; // a lock on the Threads table of active Java threads
74 // (also used by Safepoints too to block threads creation/destruction)
75 extern Mutex* NonJavaThreadsList_lock; // a lock on the NonJavaThreads list
76 extern Monitor* CGC_lock; // used for coordination between
77 // fore- & background GC threads.
78 extern Monitor* STS_lock; // used for joining/leaving SuspendibleThreadSet.
79 extern Monitor* FullGCCount_lock; // in support of "concurrent" full gc
80 extern Mutex* SATB_Q_FL_lock; // Protects SATB Q
81 // buffer free list.
82 extern Monitor* SATB_Q_CBL_mon; // Protects SATB Q
83 // completed buffer queue.
84 extern Mutex* Shared_SATB_Q_lock; // Lock protecting SATB
85 // queue shared by
86 // non-Java threads.
87
88 extern Mutex* DirtyCardQ_FL_lock; // Protects dirty card Q
89 // buffer free list.
90 extern Monitor* DirtyCardQ_CBL_mon; // Protects dirty card Q
91 // completed buffer queue.
92 extern Mutex* Shared_DirtyCardQ_lock; // Lock protecting dirty card
93 // queue shared by
94 // non-Java threads.
95 extern Mutex* MarkStackFreeList_lock; // Protects access to the global mark stack free list.
96 extern Mutex* MarkStackChunkList_lock; // Protects access to the global mark stack chunk list.
97 extern Mutex* MonitoringSupport_lock; // Protects updates to the serviceability memory pools.
98 extern Mutex* ParGCRareEvent_lock; // Synchronizes various (rare) parallel GC ops.
99 extern Mutex* Compile_lock; // a lock held when Compilation is updating code (used to block CodeCache traversal, CHA updates, etc)
100 extern Monitor* MethodCompileQueue_lock; // a lock held when method compilations are enqueued, dequeued
101 extern Monitor* CompileThread_lock; // a lock held by compile threads during compilation system initialization
102 extern Monitor* Compilation_lock; // a lock used to pause compilation
103 extern Mutex* CompileTaskAlloc_lock; // a lock held when CompileTasks are allocated
104 extern Mutex* CompileStatistics_lock; // a lock held when updating compilation statistics
105 extern Mutex* DirectivesStack_lock; // a lock held when mutating the dirstack and ref counting directives
106 extern Mutex* MultiArray_lock; // a lock used to guard allocation of multi-dim arrays
107 extern Monitor* Terminator_lock; // a lock used to guard termination of the vm
108 extern Monitor* BeforeExit_lock; // a lock used to guard cleanups and shutdown hooks
109 extern Monitor* Notify_lock; // a lock used to synchronize the start-up of the vm
110 extern Mutex* ProfilePrint_lock; // a lock used to serialize the printing of profiles
111 extern Mutex* ExceptionCache_lock; // a lock used to synchronize exception cache updates
112 extern Mutex* OsrList_lock; // a lock used to serialize access to OSR queues
113
114 #ifndef PRODUCT
115 extern Mutex* FullGCALot_lock; // a lock to make FullGCALot MT safe
116 #endif // PRODUCT
117 extern Mutex* Debug1_lock; // A bunch of pre-allocated locks that can be used for tracing
118 extern Mutex* Debug2_lock; // down synchronization related bugs!
119 extern Mutex* Debug3_lock;
120
121 extern Mutex* RawMonitor_lock;
122 extern Mutex* PerfDataMemAlloc_lock; // a lock on the allocator for PerfData memory for performance data
123 extern Mutex* PerfDataManager_lock; // a long on access to PerfDataManager resources
124 extern Mutex* ParkerFreeList_lock;
125 extern Mutex* OopMapCacheAlloc_lock; // protects allocation of oop_map caches
126
127 extern Mutex* FreeList_lock; // protects the free region list during safepoints
128 extern Mutex* OldSets_lock; // protects the old region sets
129 extern Monitor* RootRegionScan_lock; // used to notify that the CM threads have finished scanning the IM snapshot regions
130
131 extern Mutex* Management_lock; // a lock used to serialize JVM management
132 extern Monitor* Service_lock; // a lock used for service thread operation
133 extern Monitor* PeriodicTask_lock; // protects the periodic task structure
134 extern Monitor* RedefineClasses_lock; // locks classes from parallel redefinition
135 extern Mutex* ThreadHeapSampler_lock; // protects the static data for initialization.
136
137 #if INCLUDE_JFR
138 extern Mutex* JfrStacktrace_lock; // used to guard access to the JFR stacktrace table
139 extern Monitor* JfrMsg_lock; // protects JFR messaging
140 extern Mutex* JfrBuffer_lock; // protects JFR buffer operations
141 extern Mutex* JfrStream_lock; // protects JFR stream access
142 #endif
143
144 #ifndef SUPPORTS_NATIVE_CX8
145 extern Mutex* UnsafeJlong_lock; // provides Unsafe atomic updates to jlongs on platforms that don't support cx8
146 #endif
147
148 extern Mutex* MetaspaceExpand_lock; // protects Metaspace virtualspace and chunk expansions
149 extern Mutex* ClassLoaderDataGraph_lock; // protects CLDG list, needed for concurrent unloading
150
151
152 extern Monitor* CodeHeapStateAnalytics_lock; // lock print functions against concurrent analyze functions.
153 // Only used locally in PrintCodeCacheLayout processing.
154
155 // A MutexLocker provides mutual exclusion with respect to a given mutex
156 // for the scope which contains the locker. The lock is an OS lock, not
157 // an object lock, and the two do not interoperate. Do not use Mutex-based
158 // locks to lock on Java objects, because they will not be respected if a
159 // that object is locked using the Java locking mechanism.
160 //
161 // NOTE WELL!!
162 //
163 // See orderAccess.hpp. We assume throughout the VM that MutexLocker's
164 // and friends constructors do a fence, a lock and an acquire *in that
165 // order*. And that their destructors do a release and unlock, in *that*
166 // order. If their implementations change such that these assumptions
167 // are violated, a whole lot of code will break.
168
169 // Print all mutexes/monitors that are currently owned by a thread; called
170 // by fatal error handler.
171 void print_owned_locks_on_error(outputStream* st);
172
173 char *lock_name(Mutex *mutex);
174
175 class MutexLocker: StackObj {
176 private:
177 Monitor * _mutex;
178 public:
179 MutexLocker(Monitor * mutex) {
180 assert(mutex->rank() != Mutex::special,
181 "Special ranked mutex should only use MutexLockerEx");
182 _mutex = mutex;
183 _mutex->lock();
184 }
185
186 // Overloaded constructor passing current thread
187 MutexLocker(Monitor * mutex, Thread *thread) {
188 assert(mutex->rank() != Mutex::special,
189 "Special ranked mutex should only use MutexLockerEx");
190 _mutex = mutex;
191 _mutex->lock(thread);
192 }
193
194 ~MutexLocker() {
195 _mutex->unlock();
196 }
197
198 };
199
200 // for debugging: check that we're already owning this lock (or are at a safepoint)
201 #ifdef ASSERT
202 void assert_locked_or_safepoint(const Monitor * lock);
203 void assert_locked_or_safepoint_weak(const Monitor * lock);
204 void assert_lock_strong(const Monitor * lock);
205 #else
206 #define assert_locked_or_safepoint(lock)
207 #define assert_locked_or_safepoint_weak(lock)
208 #define assert_lock_strong(lock)
209 #endif
210
211 // A MutexLockerEx behaves like a MutexLocker when its constructor is
212 // called with a Mutex. Unlike a MutexLocker, its constructor can also be
213 // called with NULL, in which case the MutexLockerEx is a no-op. There
214 // is also a corresponding MutexUnlockerEx. We want to keep the
215 // basic MutexLocker as fast as possible. MutexLockerEx can also lock
216 // without safepoint check.
217
218 class MutexLockerEx: public StackObj {
219 private:
220 Monitor * _mutex;
221 public:
222 MutexLockerEx(Monitor * mutex, bool no_safepoint_check = !Mutex::_no_safepoint_check_flag) {
223 _mutex = mutex;
224 if (_mutex != NULL) {
225 assert(mutex->rank() > Mutex::special || no_safepoint_check,
226 "Mutexes with rank special or lower should not do safepoint checks");
227 if (no_safepoint_check)
228 _mutex->lock_without_safepoint_check();
229 else
230 _mutex->lock();
231 }
232 }
233
234 ~MutexLockerEx() {
235 if (_mutex != NULL) {
236 _mutex->unlock();
237 }
238 }
239 };
240
241 // A MonitorLockerEx is like a MutexLockerEx above, except it takes
242 // a possibly null Monitor, and allows wait/notify as well which are
243 // delegated to the underlying Monitor.
244
245 class MonitorLockerEx: public MutexLockerEx {
246 private:
247 Monitor * _monitor;
248 public:
249 MonitorLockerEx(Monitor* monitor,
250 bool no_safepoint_check = !Mutex::_no_safepoint_check_flag):
251 MutexLockerEx(monitor, no_safepoint_check),
252 _monitor(monitor) {
253 // Superclass constructor did locking
254 }
255
256 ~MonitorLockerEx() {
257 #ifdef ASSERT
258 if (_monitor != NULL) {
259 assert_lock_strong(_monitor);
260 }
261 #endif // ASSERT
262 // Superclass destructor will do unlocking
263 }
264
265 bool wait(bool no_safepoint_check = !Mutex::_no_safepoint_check_flag,
266 long timeout = 0,
267 bool as_suspend_equivalent = !Mutex::_as_suspend_equivalent_flag) {
268 if (_monitor != NULL) {
269 return _monitor->wait(no_safepoint_check, timeout, as_suspend_equivalent);
270 }
271 return false;
272 }
273
274 bool notify_all() {
275 if (_monitor != NULL) {
276 return _monitor->notify_all();
277 }
278 return true;
279 }
280
281 bool notify() {
282 if (_monitor != NULL) {
283 return _monitor->notify();
284 }
285 return true;
286 }
287 };
288
289
290
291 // A GCMutexLocker is usually initialized with a mutex that is
292 // automatically acquired in order to do GC. The function that
293 // synchronizes using a GCMutexLocker may be called both during and between
294 // GC's. Thus, it must acquire the mutex if GC is not in progress, but not
295 // if GC is in progress (since the mutex is already held on its behalf.)
296
297 class GCMutexLocker: public StackObj {
298 private:
299 Monitor * _mutex;
300 bool _locked;
301 public:
302 GCMutexLocker(Monitor * mutex);
303 ~GCMutexLocker() { if (_locked) _mutex->unlock(); }
304 };
305
306
307
308 // A MutexUnlocker temporarily exits a previously
309 // entered mutex for the scope which contains the unlocker.
310
311 class MutexUnlocker: StackObj {
312 private:
313 Monitor * _mutex;
314
315 public:
316 MutexUnlocker(Monitor * mutex) {
317 _mutex = mutex;
318 _mutex->unlock();
319 }
320
321 ~MutexUnlocker() {
322 _mutex->lock();
323 }
324 };
325
326 // A MutexUnlockerEx temporarily exits a previously
327 // entered mutex for the scope which contains the unlocker.
328
329 class MutexUnlockerEx: StackObj {
330 private:
331 Monitor * _mutex;
332 bool _no_safepoint_check;
333
334 public:
335 MutexUnlockerEx(Monitor * mutex, bool no_safepoint_check = !Mutex::_no_safepoint_check_flag) {
336 _mutex = mutex;
337 _no_safepoint_check = no_safepoint_check;
338 _mutex->unlock();
339 }
340
341 ~MutexUnlockerEx() {
342 if (_no_safepoint_check == Mutex::_no_safepoint_check_flag) {
343 _mutex->lock_without_safepoint_check();
344 } else {
345 _mutex->lock();
346 }
347 }
348 };
349
350 #ifndef PRODUCT
351 //
352 // A special MutexLocker that allows:
353 // - reentrant locking
354 // - locking out of order
355 //
356 // Only to be used for verify code, where we can relax out dead-lock
357 // detection code a bit (unsafe, but probably ok). This code is NEVER to
358 // be included in a product version.
359 //
360 class VerifyMutexLocker: StackObj {
361 private:
362 Monitor * _mutex;
363 bool _reentrant;
364 public:
365 VerifyMutexLocker(Monitor * mutex) {
366 _mutex = mutex;
367 _reentrant = mutex->owned_by_self();
368 if (!_reentrant) {
369 // We temp. disable strict safepoint checking, while we require the lock
370 FlagSetting fs(StrictSafepointChecks, false);
371 _mutex->lock();
372 }
373 }
374
375 ~VerifyMutexLocker() {
376 if (!_reentrant) {
377 _mutex->unlock();
378 }
379 }
380 };
381
382 #endif
383
384 #endif // SHARE_VM_RUNTIME_MUTEXLOCKER_HPP