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