Wed, 17 Sep 2008 19:59:35 +0400
Merge
1 /*
2 * Copyright 1997-2008 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 */
25 // Mutexes used in the VM.
27 extern Mutex* Patching_lock; // a lock used to guard code patching of compiled code
28 extern Monitor* SystemDictionary_lock; // a lock on the system dictonary
29 extern Mutex* PackageTable_lock; // a lock on the class loader package table
30 extern Mutex* CompiledIC_lock; // a lock used to guard compiled IC patching and access
31 extern Mutex* InlineCacheBuffer_lock; // a lock used to guard the InlineCacheBuffer
32 extern Mutex* VMStatistic_lock; // a lock used to guard statistics count increment
33 extern Mutex* JNIGlobalHandle_lock; // a lock on creating JNI global handles
34 extern Mutex* JNIHandleBlockFreeList_lock; // a lock on the JNI handle block free list
35 extern Mutex* JNICachedItableIndex_lock; // a lock on caching an itable index during JNI invoke
36 extern Mutex* JmethodIdCreation_lock; // a lock on creating JNI method identifiers
37 extern Mutex* JfieldIdCreation_lock; // a lock on creating JNI static field identifiers
38 extern Monitor* JNICritical_lock; // a lock used while entering and exiting JNI critical regions, allows GC to sometimes get in
39 extern Mutex* JvmtiThreadState_lock; // a lock on modification of JVMTI thread data
40 extern Monitor* JvmtiPendingEvent_lock; // a lock on the JVMTI pending events list
41 extern Monitor* Heap_lock; // a lock on the heap
42 extern Mutex* ExpandHeap_lock; // a lock on expanding the heap
43 extern Mutex* AdapterHandlerLibrary_lock; // a lock on the AdapterHandlerLibrary
44 extern Mutex* SignatureHandlerLibrary_lock; // a lock on the SignatureHandlerLibrary
45 extern Mutex* VtableStubs_lock; // a lock on the VtableStubs
46 extern Mutex* SymbolTable_lock; // a lock on the symbol table
47 extern Mutex* StringTable_lock; // a lock on the interned string table
48 extern Mutex* CodeCache_lock; // a lock on the CodeCache, rank is special, use MutexLockerEx
49 extern Mutex* MethodData_lock; // a lock on installation of method data
50 extern Mutex* RetData_lock; // a lock on installation of RetData inside method data
51 extern Mutex* DerivedPointerTableGC_lock; // a lock to protect the derived pointer table
52 extern Monitor* VMOperationQueue_lock; // a lock on queue of vm_operations waiting to execute
53 extern Monitor* VMOperationRequest_lock; // a lock on Threads waiting for a vm_operation to terminate
54 extern Monitor* Safepoint_lock; // a lock used by the safepoint abstraction
55 extern Monitor* Threads_lock; // a lock on the Threads table of active Java threads
56 // (also used by Safepoints too to block threads creation/destruction)
57 extern Monitor* CGC_lock; // used for coordination between
58 // fore- & background GC threads.
59 extern Mutex* STS_init_lock; // coordinate initialization of SuspendibleThreadSets.
60 extern Monitor* SLT_lock; // used in CMS GC for acquiring PLL
61 extern Monitor* iCMS_lock; // CMS incremental mode start/stop notification
62 extern Monitor* FullGCCount_lock; // in support of "concurrent" full gc
63 extern Monitor* CMark_lock; // used for concurrent mark thread coordination
64 extern Monitor* ZF_mon; // used for G1 conc zero-fill.
65 extern Monitor* Cleanup_mon; // used for G1 conc cleanup.
66 extern Monitor* G1ConcRefine_mon; // used for G1 conc-refine
67 // coordination.
69 extern Mutex* SATB_Q_FL_lock; // Protects SATB Q
70 // buffer free list.
71 extern Monitor* SATB_Q_CBL_mon; // Protects SATB Q
72 // completed buffer queue.
73 extern Mutex* Shared_SATB_Q_lock; // Lock protecting SATB
74 // queue shared by
75 // non-Java threads.
77 extern Mutex* DirtyCardQ_FL_lock; // Protects dirty card Q
78 // buffer free list.
79 extern Monitor* DirtyCardQ_CBL_mon; // Protects dirty card Q
80 // completed buffer queue.
81 extern Mutex* Shared_DirtyCardQ_lock; // Lock protecting dirty card
82 // queue shared by
83 // non-Java threads.
84 // (see option ExplicitGCInvokesConcurrent)
85 extern Mutex* ParGCRareEvent_lock; // Synchronizes various (rare) parallel GC ops.
86 extern Mutex* EvacFailureStack_lock; // guards the evac failure scan stack
87 extern Mutex* Compile_lock; // a lock held when Compilation is updating code (used to block CodeCache traversal, CHA updates, etc)
88 extern Monitor* MethodCompileQueue_lock; // a lock held when method compilations are enqueued, dequeued
89 #ifdef TIERED
90 extern Monitor* C1_lock; // a lock to ensure on single c1 compile is ever active
91 #endif // TIERED
92 extern Monitor* CompileThread_lock; // a lock held by compile threads during compilation system initialization
93 extern Mutex* CompileTaskAlloc_lock; // a lock held when CompileTasks are allocated
94 extern Mutex* CompileStatistics_lock; // a lock held when updating compilation statistics
95 extern Mutex* MultiArray_lock; // a lock used to guard allocation of multi-dim arrays
96 extern Monitor* Terminator_lock; // a lock used to guard termination of the vm
97 extern Monitor* BeforeExit_lock; // a lock used to guard cleanups and shutdown hooks
98 extern Monitor* Notify_lock; // a lock used to synchronize the start-up of the vm
99 extern Monitor* Interrupt_lock; // a lock used for condition variable mediated interrupt processing
100 extern Monitor* ProfileVM_lock; // a lock used for profiling the VMThread
101 extern Mutex* ProfilePrint_lock; // a lock used to serialize the printing of profiles
102 extern Mutex* ExceptionCache_lock; // a lock used to synchronize exception cache updates
103 extern Mutex* OsrList_lock; // a lock used to serialize access to OSR queues
105 #ifndef PRODUCT
106 extern Mutex* FullGCALot_lock; // a lock to make FullGCALot MT safe
107 #endif
108 extern Mutex* Debug1_lock; // A bunch of pre-allocated locks that can be used for tracing
109 extern Mutex* Debug2_lock; // down synchronization related bugs!
110 extern Mutex* Debug3_lock;
112 extern Mutex* RawMonitor_lock;
113 extern Mutex* PerfDataMemAlloc_lock; // a lock on the allocator for PerfData memory for performance data
114 extern Mutex* PerfDataManager_lock; // a long on access to PerfDataManager resources
115 extern Mutex* ParkerFreeList_lock;
116 extern Mutex* OopMapCacheAlloc_lock; // protects allocation of oop_map caches
118 extern Mutex* MMUTracker_lock; // protects the MMU
119 // tracker data structures
120 extern Mutex* HotCardCache_lock; // protects the hot card cache
122 extern Mutex* Management_lock; // a lock used to serialize JVM management
123 extern Monitor* LowMemory_lock; // a lock used for low memory detection
125 // A MutexLocker provides mutual exclusion with respect to a given mutex
126 // for the scope which contains the locker. The lock is an OS lock, not
127 // an object lock, and the two do not interoperate. Do not use Mutex-based
128 // locks to lock on Java objects, because they will not be respected if a
129 // that object is locked using the Java locking mechanism.
130 //
131 // NOTE WELL!!
132 //
133 // See orderAccess.hpp. We assume throughout the VM that MutexLocker's
134 // and friends constructors do a fence, a lock and an acquire *in that
135 // order*. And that their destructors do a release and unlock, in *that*
136 // order. If their implementations change such that these assumptions
137 // are violated, a whole lot of code will break.
139 // Print all mutexes/monitors that are currently owned by a thread; called
140 // by fatal error handler.
141 void print_owned_locks_on_error(outputStream* st);
143 char *lock_name(Mutex *mutex);
145 class MutexLocker: StackObj {
146 private:
147 Monitor * _mutex;
148 public:
149 MutexLocker(Monitor * mutex) {
150 assert(mutex->rank() != Mutex::special,
151 "Special ranked mutex should only use MutexLockerEx");
152 _mutex = mutex;
153 _mutex->lock();
154 }
156 // Overloaded constructor passing current thread
157 MutexLocker(Monitor * mutex, Thread *thread) {
158 assert(mutex->rank() != Mutex::special,
159 "Special ranked mutex should only use MutexLockerEx");
160 _mutex = mutex;
161 _mutex->lock(thread);
162 }
164 ~MutexLocker() {
165 _mutex->unlock();
166 }
168 };
170 // for debugging: check that we're already owning this lock (or are at a safepoint)
171 #ifdef ASSERT
172 void assert_locked_or_safepoint(const Monitor * lock);
173 void assert_lock_strong(const Monitor * lock);
174 #else
175 #define assert_locked_or_safepoint(lock)
176 #define assert_lock_strong(lock)
177 #endif
179 // A MutexLockerEx behaves like a MutexLocker when its constructor is
180 // called with a Mutex. Unlike a MutexLocker, its constructor can also be
181 // called with NULL, in which case the MutexLockerEx is a no-op. There
182 // is also a corresponding MutexUnlockerEx. We want to keep the
183 // basic MutexLocker as fast as possible. MutexLockerEx can also lock
184 // without safepoint check.
186 class MutexLockerEx: public StackObj {
187 private:
188 Monitor * _mutex;
189 public:
190 MutexLockerEx(Monitor * mutex, bool no_safepoint_check = !Mutex::_no_safepoint_check_flag) {
191 _mutex = mutex;
192 if (_mutex != NULL) {
193 assert(mutex->rank() > Mutex::special || no_safepoint_check,
194 "Mutexes with rank special or lower should not do safepoint checks");
195 if (no_safepoint_check)
196 _mutex->lock_without_safepoint_check();
197 else
198 _mutex->lock();
199 }
200 }
202 ~MutexLockerEx() {
203 if (_mutex != NULL) {
204 _mutex->unlock();
205 }
206 }
207 };
209 // A MonitorLockerEx is like a MutexLockerEx above, except it takes
210 // a possibly null Monitor, and allows wait/notify as well which are
211 // delegated to the underlying Monitor.
213 class MonitorLockerEx: public MutexLockerEx {
214 private:
215 Monitor * _monitor;
216 public:
217 MonitorLockerEx(Monitor* monitor,
218 bool no_safepoint_check = !Mutex::_no_safepoint_check_flag):
219 MutexLockerEx(monitor, no_safepoint_check),
220 _monitor(monitor) {
221 // Superclass constructor did locking
222 }
224 ~MonitorLockerEx() {
225 #ifdef ASSERT
226 if (_monitor != NULL) {
227 assert_lock_strong(_monitor);
228 }
229 #endif // ASSERT
230 // Superclass destructor will do unlocking
231 }
233 bool wait(bool no_safepoint_check = !Mutex::_no_safepoint_check_flag,
234 long timeout = 0,
235 bool as_suspend_equivalent = !Mutex::_as_suspend_equivalent_flag) {
236 if (_monitor != NULL) {
237 return _monitor->wait(no_safepoint_check, timeout, as_suspend_equivalent);
238 }
239 return false;
240 }
242 bool notify_all() {
243 if (_monitor != NULL) {
244 return _monitor->notify_all();
245 }
246 return true;
247 }
249 bool notify() {
250 if (_monitor != NULL) {
251 return _monitor->notify();
252 }
253 return true;
254 }
255 };
259 // A GCMutexLocker is usually initialized with a mutex that is
260 // automatically acquired in order to do GC. The function that
261 // synchronizes using a GCMutexLocker may be called both during and between
262 // GC's. Thus, it must acquire the mutex if GC is not in progress, but not
263 // if GC is in progress (since the mutex is already held on its behalf.)
265 class GCMutexLocker: public StackObj {
266 private:
267 Monitor * _mutex;
268 bool _locked;
269 public:
270 GCMutexLocker(Monitor * mutex);
271 ~GCMutexLocker() { if (_locked) _mutex->unlock(); }
272 };
276 // A MutexUnlocker temporarily exits a previously
277 // entered mutex for the scope which contains the unlocker.
279 class MutexUnlocker: StackObj {
280 private:
281 Monitor * _mutex;
283 public:
284 MutexUnlocker(Monitor * mutex) {
285 _mutex = mutex;
286 _mutex->unlock();
287 }
289 ~MutexUnlocker() {
290 _mutex->lock();
291 }
292 };
294 // A MutexUnlockerEx temporarily exits a previously
295 // entered mutex for the scope which contains the unlocker.
297 class MutexUnlockerEx: StackObj {
298 private:
299 Monitor * _mutex;
300 bool _no_safepoint_check;
302 public:
303 MutexUnlockerEx(Monitor * mutex, bool no_safepoint_check = !Mutex::_no_safepoint_check_flag) {
304 _mutex = mutex;
305 _no_safepoint_check = no_safepoint_check;
306 _mutex->unlock();
307 }
309 ~MutexUnlockerEx() {
310 if (_no_safepoint_check == Mutex::_no_safepoint_check_flag) {
311 _mutex->lock_without_safepoint_check();
312 } else {
313 _mutex->lock();
314 }
315 }
316 };
318 #ifndef PRODUCT
319 //
320 // A special MutexLocker that allows:
321 // - reentrant locking
322 // - locking out of order
323 //
324 // Only too be used for verify code, where we can relaxe out dead-lock
325 // dection code a bit (unsafe, but probably ok). This code is NEVER to
326 // be included in a product version.
327 //
328 class VerifyMutexLocker: StackObj {
329 private:
330 Monitor * _mutex;
331 bool _reentrant;
332 public:
333 VerifyMutexLocker(Monitor * mutex) {
334 _mutex = mutex;
335 _reentrant = mutex->owned_by_self();
336 if (!_reentrant) {
337 // We temp. diable strict safepoint checking, while we require the lock
338 FlagSetting fs(StrictSafepointChecks, false);
339 _mutex->lock();
340 }
341 }
343 ~VerifyMutexLocker() {
344 if (!_reentrant) {
345 _mutex->unlock();
346 }
347 }
348 };
350 #endif