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