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