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