1 /* 2 * Copyright (c) 1997, 2019, 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_RUNTIME_MUTEXLOCKER_HPP 26 #define SHARE_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* ProtectionDomainSet_lock; // a lock on the pd_set list in the system dictionary 37 extern Mutex* SharedDictionary_lock; // a lock on the CDS shared dictionary 38 extern Mutex* Module_lock; // a lock on module and package related data structures 39 extern Mutex* CompiledIC_lock; // a lock used to guard compiled IC patching and access 40 extern Mutex* InlineCacheBuffer_lock; // a lock used to guard the InlineCacheBuffer 41 extern Mutex* VMStatistic_lock; // a lock used to guard statistics count increment 42 extern Mutex* JNIHandleBlockFreeList_lock; // a lock on the JNI handle block free list 43 extern Mutex* JmethodIdCreation_lock; // a lock on creating JNI method identifiers 44 extern Mutex* JfieldIdCreation_lock; // a lock on creating JNI static field identifiers 45 extern Monitor* JNICritical_lock; // a lock used while entering and exiting JNI critical regions, allows GC to sometimes get in 46 extern Mutex* JvmtiThreadState_lock; // a lock on modification of JVMTI thread data 47 extern Monitor* JvmtiObjReallocRelock_lock; // a lock to sync reallocating and relocking objects because of JVMTI access 48 extern Monitor* Heap_lock; // a lock on the heap 49 extern Mutex* ExpandHeap_lock; // a lock on expanding the heap 50 extern Mutex* AdapterHandlerLibrary_lock; // a lock on the AdapterHandlerLibrary 51 extern Mutex* SignatureHandlerLibrary_lock; // a lock on the SignatureHandlerLibrary 52 extern Mutex* VtableStubs_lock; // a lock on the VtableStubs 53 extern Mutex* SymbolArena_lock; // a lock on the symbol table arena 54 extern Monitor* StringDedupQueue_lock; // a lock on the string deduplication queue 55 extern Mutex* StringDedupTable_lock; // a lock on the string deduplication table 56 extern Monitor* CodeCache_lock; // a lock on the CodeCache, rank is special 57 extern Mutex* MethodData_lock; // a lock on installation of method data 58 extern Mutex* TouchedMethodLog_lock; // a lock on allocation of LogExecutedMethods info 59 extern Mutex* RetData_lock; // a lock on installation of RetData inside method data 60 extern Monitor* CGCPhaseManager_lock; // a lock to protect a concurrent GC's phase management 61 extern Monitor* VMOperationQueue_lock; // a lock on queue of vm_operations waiting to execute 62 extern Monitor* VMOperationRequest_lock; // a lock on Threads waiting for a vm_operation to terminate 63 extern Monitor* Threads_lock; // a lock on the Threads table of active Java threads 64 // (also used by Safepoints too to block threads creation/destruction) 65 extern Mutex* NonJavaThreadsList_lock; // a lock on the NonJavaThreads list 66 extern Mutex* NonJavaThreadsListSync_lock; // a lock for NonJavaThreads list synchronization 67 extern Monitor* CGC_lock; // used for coordination between 68 // fore- & background GC threads. 69 extern Monitor* STS_lock; // used for joining/leaving SuspendibleThreadSet. 70 extern Monitor* FullGCCount_lock; // in support of "concurrent" full gc 71 extern Monitor* DirtyCardQ_CBL_mon; // Protects dirty card Q 72 // completed buffer queue. 73 extern Mutex* Shared_DirtyCardQ_lock; // Lock protecting dirty card 74 // queue shared by 75 // non-Java threads. 76 extern Mutex* MarkStackFreeList_lock; // Protects access to the global mark stack free list. 77 extern Mutex* MarkStackChunkList_lock; // Protects access to the global mark stack chunk list. 78 extern Mutex* MonitoringSupport_lock; // Protects updates to the serviceability memory pools. 79 extern Mutex* ParGCRareEvent_lock; // Synchronizes various (rare) parallel GC ops. 80 extern Mutex* Compile_lock; // a lock held when Compilation is updating code (used to block CodeCache traversal, CHA updates, etc) 81 extern Monitor* MethodCompileQueue_lock; // a lock held when method compilations are enqueued, dequeued 82 extern Monitor* CompileThread_lock; // a lock held by compile threads during compilation system initialization 83 extern Monitor* Compilation_lock; // a lock used to pause compilation 84 extern Mutex* CompileTaskAlloc_lock; // a lock held when CompileTasks are allocated 85 extern Mutex* CompileStatistics_lock; // a lock held when updating compilation statistics 86 extern Mutex* DirectivesStack_lock; // a lock held when mutating the dirstack and ref counting directives 87 extern Mutex* MultiArray_lock; // a lock used to guard allocation of multi-dim arrays 88 extern Monitor* Terminator_lock; // a lock used to guard termination of the vm 89 extern Monitor* InitCompleted_lock; // a lock used to signal threads waiting on init completed 90 extern Monitor* BeforeExit_lock; // a lock used to guard cleanups and shutdown hooks 91 extern Monitor* Notify_lock; // a lock used to synchronize the start-up of the vm 92 extern Mutex* ProfilePrint_lock; // a lock used to serialize the printing of profiles 93 extern Mutex* ExceptionCache_lock; // a lock used to synchronize exception cache updates 94 extern Mutex* OsrList_lock; // a lock used to serialize access to OSR queues 95 extern Mutex* NMethodSweeperStats_lock; // a lock used to serialize access to sweeper statistics 96 97 #ifndef PRODUCT 98 extern Mutex* FullGCALot_lock; // a lock to make FullGCALot MT safe 99 #endif // PRODUCT 100 extern Mutex* Debug1_lock; // A bunch of pre-allocated locks that can be used for tracing 101 extern Mutex* Debug2_lock; // down synchronization related bugs! 102 extern Mutex* Debug3_lock; 103 104 extern Mutex* RawMonitor_lock; 105 extern Mutex* PerfDataMemAlloc_lock; // a lock on the allocator for PerfData memory for performance data 106 extern Mutex* PerfDataManager_lock; // a long on access to PerfDataManager resources 107 extern Mutex* ParkerFreeList_lock; 108 extern Mutex* OopMapCacheAlloc_lock; // protects allocation of oop_map caches 109 110 extern Mutex* FreeList_lock; // protects the free region list during safepoints 111 extern Mutex* OldSets_lock; // protects the old region sets 112 extern Monitor* RootRegionScan_lock; // used to notify that the CM threads have finished scanning the IM snapshot regions 113 114 extern Mutex* Management_lock; // a lock used to serialize JVM management 115 extern Monitor* Service_lock; // a lock used for service thread operation 116 extern Monitor* PeriodicTask_lock; // protects the periodic task structure 117 extern Monitor* RedefineClasses_lock; // locks classes from parallel redefinition 118 extern Monitor* ThreadsSMRDelete_lock; // Used by ThreadsSMRSupport to take pressure off the Threads_lock 119 extern Mutex* SharedDecoder_lock; // serializes access to the decoder during normal (not error reporting) use 120 extern Mutex* DCmdFactory_lock; // serialize access to DCmdFactory information 121 #if INCLUDE_NMT 122 extern Mutex* NMTQuery_lock; // serialize NMT Dcmd queries 123 #endif 124 #if INCLUDE_CDS 125 #if INCLUDE_JVMTI 126 extern Mutex* CDSClassFileStream_lock; // FileMapInfo::open_stream_for_jvmti 127 #endif 128 extern Mutex* DumpTimeTable_lock; // SystemDictionaryShared::find_or_allocate_info_for 129 #endif // INCLUDE_CDS 130 #if INCLUDE_JFR 131 extern Mutex* JfrStacktrace_lock; // used to guard access to the JFR stacktrace table 132 extern Monitor* JfrMsg_lock; // protects JFR messaging 133 extern Mutex* JfrBuffer_lock; // protects JFR buffer operations 134 extern Mutex* JfrStream_lock; // protects JFR stream access 135 extern Monitor* JfrThreadSampler_lock; // used to suspend/resume JFR thread sampler 136 #endif 137 138 #ifndef SUPPORTS_NATIVE_CX8 139 extern Mutex* UnsafeJlong_lock; // provides Unsafe atomic updates to jlongs on platforms that don't support cx8 140 #endif 141 142 extern Mutex* MetaspaceExpand_lock; // protects Metaspace virtualspace and chunk expansions 143 extern Mutex* ClassLoaderDataGraph_lock; // protects CLDG list, needed for concurrent unloading 144 145 146 extern Mutex* CodeHeapStateAnalytics_lock; // lock print functions against concurrent analyze functions. 147 // Only used locally in PrintCodeCacheLayout processing. 148 149 #if INCLUDE_JVMCI 150 extern Monitor* JVMCI_lock; // Monitor to control initialization of JVMCI 151 #endif 152 153 // A MutexLocker provides mutual exclusion with respect to a given mutex 154 // for the scope which contains the locker. The lock is an OS lock, not 155 // an object lock, and the two do not interoperate. Do not use Mutex-based 156 // locks to lock on Java objects, because they will not be respected if a 157 // that object is locked using the Java locking mechanism. 158 // 159 // NOTE WELL!! 160 // 161 // See orderAccess.hpp. We assume throughout the VM that MutexLocker's 162 // and friends constructors do a fence, a lock and an acquire *in that 163 // order*. And that their destructors do a release and unlock, in *that* 164 // order. If their implementations change such that these assumptions 165 // are violated, a whole lot of code will break. 166 167 // Print all mutexes/monitors that are currently owned by a thread; called 168 // by fatal error handler. 169 void print_owned_locks_on_error(outputStream* st); 170 171 char *lock_name(Mutex *mutex); 172 173 // for debugging: check that we're already owning this lock (or are at a safepoint) 174 #ifdef ASSERT 175 void assert_locked_or_safepoint(const Mutex* lock); 176 void assert_locked_or_safepoint_weak(const Mutex* lock); 177 void assert_lock_strong(const Mutex* lock); 178 #else 179 #define assert_locked_or_safepoint(lock) 180 #define assert_locked_or_safepoint_weak(lock) 181 #define assert_lock_strong(lock) 182 #endif 183 184 class MutexLocker: public StackObj { 185 protected: 186 Mutex* _mutex; 187 private: 188 public: 189 MutexLocker(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) : 190 _mutex(mutex) { 191 bool no_safepoint_check = flag == Mutex::_no_safepoint_check_flag; 192 if (_mutex != NULL) { 193 assert(_mutex->rank() > Mutex::special || no_safepoint_check, 194 "Mutexes with rank special or lower should not do safepoint checks"); 195 if (no_safepoint_check) { 196 _mutex->lock_without_safepoint_check(); 197 } else { 198 _mutex->lock(); 199 } 200 } 201 } 202 203 MutexLocker(Mutex* mutex, Thread* thread, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) : 204 _mutex(mutex) { 205 bool no_safepoint_check = flag == Mutex::_no_safepoint_check_flag; 206 if (_mutex != NULL) { 207 assert(_mutex->rank() > Mutex::special || no_safepoint_check, 208 "Mutexes with rank special or lower should not do safepoint checks"); 209 if (no_safepoint_check) { 210 _mutex->lock_without_safepoint_check(thread); 211 } else { 212 _mutex->lock(thread); 213 } 214 } 215 } 216 217 ~MutexLocker() { 218 if (_mutex != NULL) { 219 assert_lock_strong(_mutex); 220 _mutex->unlock(); 221 } 222 } 223 }; 224 225 // A MonitorLocker is like a MutexLocker above, except it allows 226 // wait/notify as well which are delegated to the underlying Monitor. 227 // It also disallows NULL. 228 229 class MonitorLocker: public MutexLocker { 230 Mutex::SafepointCheckFlag _flag; 231 Monitor* _monitor; 232 public: 233 MonitorLocker(Monitor* monitor, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) : 234 MutexLocker(monitor, flag), _flag(flag), _monitor(monitor) { 235 // Superclass constructor did locking 236 assert(_monitor != NULL, "NULL monitor not allowed"); 237 } 238 239 MonitorLocker(Monitor* monitor, Thread* thread, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) : 240 MutexLocker(monitor, thread, flag), _flag(flag), _monitor(monitor) { 241 // Superclass constructor did locking 242 assert(_monitor != NULL, "NULL monitor not allowed"); 243 } 244 245 bool wait(long timeout = 0, 246 bool as_suspend_equivalent = !Mutex::_as_suspend_equivalent_flag) { 247 if (_flag == Mutex::_safepoint_check_flag) { 248 return _monitor->wait(timeout, as_suspend_equivalent); 249 } else { 250 return _monitor->wait_without_safepoint_check(timeout); 251 } 252 return false; 253 } 254 255 void notify_all() { 256 _monitor->notify_all(); 257 } 258 259 void notify() { 260 _monitor->notify(); 261 } 262 }; 263 264 265 // A GCMutexLocker is usually initialized with a mutex that is 266 // automatically acquired in order to do GC. The function that 267 // synchronizes using a GCMutexLocker may be called both during and between 268 // GC's. Thus, it must acquire the mutex if GC is not in progress, but not 269 // if GC is in progress (since the mutex is already held on its behalf.) 270 271 class GCMutexLocker: public StackObj { 272 private: 273 Mutex* _mutex; 274 bool _locked; 275 public: 276 GCMutexLocker(Mutex* mutex); 277 ~GCMutexLocker() { if (_locked) _mutex->unlock(); } 278 }; 279 280 // A MutexUnlocker temporarily exits a previously 281 // entered mutex for the scope which contains the unlocker. 282 283 class MutexUnlocker: StackObj { 284 private: 285 Mutex* _mutex; 286 bool _no_safepoint_check; 287 288 public: 289 MutexUnlocker(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) : 290 _mutex(mutex), 291 _no_safepoint_check(flag) { 292 _mutex->unlock(); 293 } 294 295 ~MutexUnlocker() { 296 if (_no_safepoint_check) { 297 _mutex->lock_without_safepoint_check(); 298 } else { 299 _mutex->lock(); 300 } 301 } 302 }; 303 304 #endif // SHARE_RUNTIME_MUTEXLOCKER_HPP