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