1 /*

     2  * Copyright 1997-2007 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    20  * CA 95054 USA or visit www.sun.com if you need additional information or

    21  * have any 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 Mutex*   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 Mutex*   ParGCRareEvent_lock          = NULL;

    71 Mutex*   DerivedPointerTableGC_lock   = NULL;

    72 Mutex*   Compile_lock                 = NULL;

    73 Monitor* MethodCompileQueue_lock      = NULL;

    74 #ifdef TIERED

    75 Monitor* C1_lock                      = NULL;

    76 #endif // TIERED

    77 Monitor* CompileThread_lock           = NULL;

    78 Mutex*   CompileTaskAlloc_lock        = NULL;

    79 Mutex*   CompileStatistics_lock       = NULL;

    80 Mutex*   MultiArray_lock              = NULL;

    81 Monitor* Terminator_lock              = NULL;

    82 Monitor* BeforeExit_lock              = NULL;

    83 Monitor* Notify_lock                  = NULL;

    84 Monitor* Interrupt_lock               = NULL;

    85 Monitor* ProfileVM_lock               = NULL;

    86 Mutex*   ProfilePrint_lock            = NULL;

    87 Mutex*   ExceptionCache_lock          = NULL;

    88 Monitor* ObjAllocPost_lock            = NULL;

    89 Mutex*   OsrList_lock                 = NULL;

    90 #ifndef PRODUCT

    91 Mutex*   FullGCALot_lock              = NULL;

    92 #endif

    93 

    94 Mutex*   Debug1_lock                  = NULL;

    95 Mutex*   Debug2_lock                  = NULL;

    96 Mutex*   Debug3_lock                  = NULL;

    97 

    98 Mutex*   tty_lock                     = NULL;

    99 

   100 Mutex*   RawMonitor_lock              = NULL;

   101 Mutex*   PerfDataMemAlloc_lock        = NULL;

   102 Mutex*   PerfDataManager_lock         = NULL;

   103 Mutex*   OopMapCacheAlloc_lock        = NULL;

   104 

   105 Monitor* GCTaskManager_lock           = NULL;

   106 

   107 Mutex*   Management_lock              = NULL;

   108 Monitor* LowMemory_lock               = NULL;

   109 

   110 #define MAX_NUM_MUTEX 128

   111 static Monitor * _mutex_array[MAX_NUM_MUTEX];

   112 static int _num_mutex;

   113 

   114 #ifdef ASSERT

   115 void assert_locked_or_safepoint(const Monitor * lock) {

   116   // check if this thread owns the lock (common case)

   117   if (IgnoreLockingAssertions) return;

   118   assert(lock != NULL, "Need non-NULL lock");

   119   if (lock->owned_by_self()) return;

   120   if (SafepointSynchronize::is_at_safepoint()) return;

   121   if (!Universe::is_fully_initialized()) return;

   122   // see if invoker of VM operation owns it

   123   VM_Operation* op = VMThread::vm_operation();

   124   if (op != NULL && op->calling_thread() == lock->owner()) return;

   125   fatal1("must own lock %s", lock->name());

   126 }

   127 

   128 // a stronger assertion than the above

   129 void assert_lock_strong(const Monitor * lock) {

   130   if (IgnoreLockingAssertions) return;

   131   assert(lock != NULL, "Need non-NULL lock");

   132   if (lock->owned_by_self()) return;

   133   fatal1("must own lock %s", lock->name());

   134 }

   135 #endif

   136 

   137 #define def(var, type, pri, vm_block) {                           \

   138   var = new type(Mutex::pri, #var, vm_block);                     \

   139   assert(_num_mutex < MAX_NUM_MUTEX,                              \

   140                     "increase MAX_NUM_MUTEX");                    \

   141   _mutex_array[_num_mutex++] = var;                               \

   142 }

   143 

   144 void mutex_init() {

   145   def(tty_lock                     , Mutex  , event,       true ); // allow to lock in VM

   146 

   147   def(CGC_lock                   , Monitor, special,     true ); // coordinate between fore- and background GC

   148   def(STS_init_lock              , Mutex,   leaf,        true );

   149   if (UseConcMarkSweepGC) {

   150     def(iCMS_lock                  , Monitor, special,     true ); // CMS incremental mode start/stop notification

   151     def(FullGCCount_lock           , Monitor, leaf,        true ); // in support of ExplicitGCInvokesConcurrent

   152   }

   153   def(ParGCRareEvent_lock          , Mutex  , leaf     ,   true );

   154   def(DerivedPointerTableGC_lock   , Mutex,   leaf,        true );

   155   def(CodeCache_lock               , Mutex  , special,     true );

   156   def(Interrupt_lock               , Monitor, special,     true ); // used for interrupt processing

   157   def(RawMonitor_lock              , Mutex,   special,     true );

   158   def(OopMapCacheAlloc_lock        , Mutex,   leaf,        true ); // used for oop_map_cache allocation.

   159 

   160   def(Patching_lock                , Mutex  , special,     true ); // used for safepointing and code patching.

   161   def(ObjAllocPost_lock            , Monitor, special,     false);

   162   def(LowMemory_lock               , Monitor, special,     true ); // used for low memory detection

   163   def(JmethodIdCreation_lock       , Mutex  , leaf,        true ); // used for creating jmethodIDs.

   164 

   165   def(SystemDictionary_lock        , Monitor, leaf,        true ); // lookups done by VM thread

   166   def(PackageTable_lock            , Mutex  , leaf,        false);

   167   def(InlineCacheBuffer_lock       , Mutex  , leaf,        true );

   168   def(VMStatistic_lock             , Mutex  , leaf,        false);

   169   def(ExpandHeap_lock              , Mutex  , leaf,        true ); // Used during compilation by VM thread

   170   def(JNIHandleBlockFreeList_lock  , Mutex  , leaf,        true ); // handles are used by VM thread

   171   def(SignatureHandlerLibrary_lock , Mutex  , leaf,        false);

   172   def(SymbolTable_lock             , Mutex  , leaf,        true );

   173   def(StringTable_lock             , Mutex  , leaf,        true );

   174   def(ProfilePrint_lock            , Mutex  , leaf,        false); // serial profile printing

   175   def(ExceptionCache_lock          , Mutex  , leaf,        false); // serial profile printing

   176   def(OsrList_lock                 , Mutex  , leaf,        true );

   177   def(Debug1_lock                  , Mutex  , leaf,        true );

   178 #ifndef PRODUCT

   179   def(FullGCALot_lock              , Mutex  , leaf,        false); // a lock to make FullGCALot MT safe

   180 #endif

   181   def(BeforeExit_lock              , Monitor, leaf,        true );

   182   def(PerfDataMemAlloc_lock        , Mutex  , leaf,        true ); // used for allocating PerfData memory for performance data

   183   def(PerfDataManager_lock         , Mutex  , leaf,        true ); // used for synchronized access to PerfDataManager resources

   184 

   185   // CMS_modUnionTable_lock                   leaf

   186   // CMS_bitMap_lock                          leaf + 1

   187   // CMS_freeList_lock                        leaf + 2

   188 

   189   def(Safepoint_lock               , Monitor, safepoint,   true ); // locks SnippetCache_lock/Threads_lock

   190 

   191   if (!UseMembar) {

   192     def(SerializePage_lock         , Monitor, leaf,        true );

   193   }

   194 

   195   def(Threads_lock                 , Monitor, barrier,     true );

   196 

   197   def(VMOperationQueue_lock        , Monitor, nonleaf,     true ); // VM_thread allowed to block on these

   198   def(VMOperationRequest_lock      , Monitor, nonleaf,     true );

   199   def(RetData_lock                 , Mutex  , nonleaf,     false);

   200   def(Terminator_lock              , Monitor, nonleaf,     true );

   201   def(VtableStubs_lock             , Mutex  , nonleaf,     true );

   202   def(Notify_lock                  , Monitor, nonleaf,     true );

   203   def(JNIGlobalHandle_lock         , Mutex  , nonleaf,     true ); // locks JNIHandleBlockFreeList_lock

   204   def(JNICritical_lock             , Monitor, nonleaf,     true ); // used for JNI critical regions

   205   def(AdapterHandlerLibrary_lock   , Mutex  , nonleaf,     true);

   206   if (UseConcMarkSweepGC) {

   207     def(SLT_lock                   , Monitor, nonleaf,     false );

   208                     // used in CMS GC for locking PLL lock

   209   }

   210   def(Heap_lock                    , Mutex  , nonleaf+1,   false);

   211   def(JfieldIdCreation_lock        , Mutex  , nonleaf+1,   true ); // jfieldID, Used in VM_Operation

   212   def(JNICachedItableIndex_lock    , Mutex  , nonleaf+1,   false); // Used to cache an itable index during JNI invoke

   213 

   214   def(CompiledIC_lock              , Mutex  , nonleaf+2,   false); // locks VtableStubs_lock, InlineCacheBuffer_lock

   215   def(CompileTaskAlloc_lock        , Mutex  , nonleaf+2,   true );

   216   def(CompileStatistics_lock       , Mutex  , nonleaf+2,   false);

   217   def(MultiArray_lock              , Mutex  , nonleaf+2,   false); // locks SymbolTable_lock

   218 

   219   def(JvmtiThreadState_lock        , Mutex  , nonleaf+2,   false); // Used by JvmtiThreadState/JvmtiEventController

   220   def(JvmtiPendingEvent_lock       , Monitor, nonleaf,     false); // Used by JvmtiCodeBlobEvents

   221   def(Management_lock              , Mutex  , nonleaf+2,   false); // used for JVM management

   222 

   223   def(Compile_lock                 , Mutex  , nonleaf+3,   true );

   224   def(MethodData_lock              , Mutex  , nonleaf+3,   false);

   225 

   226   def(MethodCompileQueue_lock      , Monitor, nonleaf+4,   true );

   227   def(Debug2_lock                  , Mutex  , nonleaf+4,   true );

   228   def(Debug3_lock                  , Mutex  , nonleaf+4,   true );

   229   def(ProfileVM_lock               , Monitor, nonleaf+4,   false); // used for profiling of the VMThread

   230   def(CompileThread_lock           , Monitor, nonleaf+5,   false );

   231 #ifdef TIERED

   232   def(C1_lock                      , Monitor, nonleaf+5,   false );

   233 #endif // TIERED

   234 

   235 

   236 }

   237 

   238 GCMutexLocker::GCMutexLocker(Monitor * mutex) {

   239   if (SafepointSynchronize::is_at_safepoint()) {

   240     _locked = false;

   241   } else {

   242     _mutex = mutex;

   243     _locked = true;

   244     _mutex->lock();

   245   }

   246 }

   247 

   248 // Print all mutexes/monitors that are currently owned by a thread; called

   249 // by fatal error handler.

   250 void print_owned_locks_on_error(outputStream* st) {

   251   st->print("VM Mutex/Monitor currently owned by a thread: ");

   252   bool none = true;

   253   for (int i = 0; i < _num_mutex; i++) {

   254      // see if it has an owner

   255      if (_mutex_array[i]->owner() != NULL) {

   256        if (none) {

   257           // print format used by Mutex::print_on_error()

   258           st->print_cr(" ([mutex/lock_event])");

   259           none = false;

   260        }

   261        _mutex_array[i]->print_on_error(st);

   262        st->cr();

   263      }

   264   }

   265   if (none) st->print_cr("None");

   266 }