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 #ifndef SHARE_RUNTIME_MUTEXLOCKER_HPP
26 #define SHARE_RUNTIME_MUTEXLOCKER_HPP
27
28 #include "memory/allocation.hpp"
29 #include "runtime/flags/flagSetting.hpp"
30 #include "runtime/mutex.hpp"
31
32 class Thread;
33
34 // Mutexes used in the VM.
35
36 extern Mutex* NMethodState_lock; // a lock used to guard a compiled method state
37 extern Mutex* NMethodEntryBarrier_lock; // protects nmethod entry barrier
38 extern Monitor* SystemDictionary_lock; // a lock on the system dictionary
39 extern Mutex* InvokeMethodTypeTable_lock;
40 extern Monitor* InvokeMethodIntrinsicTable_lock;
41 extern Mutex* SharedDictionary_lock; // a lock on the CDS shared dictionary
42 extern Monitor* ClassInitError_lock; // a lock on the class initialization error table
43 extern Mutex* Module_lock; // a lock on module and package related data structures
44 extern Mutex* CompiledIC_lock; // a lock used to guard compiled IC patching and access
45 extern Mutex* VMStatistic_lock; // a lock used to guard statistics count increment
46 extern Mutex* JmethodIdCreation_lock; // a lock on creating JNI method identifiers
47 extern Mutex* JfieldIdCreation_lock; // a lock on creating JNI static field identifiers
48 extern Monitor* JNICritical_lock; // a lock used while synchronizing with threads entering/leaving JNI critical regions
49 extern Mutex* JvmtiThreadState_lock; // a lock on modification of JVMTI thread data
50 extern Monitor* EscapeBarrier_lock; // a lock to sync reallocating and relocking objects because of JVMTI access
58 extern Mutex* SignatureHandlerLibrary_lock; // a lock on the SignatureHandlerLibrary
59 extern Mutex* VtableStubs_lock; // a lock on the VtableStubs
60 extern Mutex* SymbolArena_lock; // a lock on the symbol table arena
61 extern Monitor* StringDedup_lock; // a lock on the string deduplication facility
62 extern Mutex* StringDedupIntern_lock; // a lock on StringTable notification of StringDedup
63 extern Monitor* CodeCache_lock; // a lock on the CodeCache
64 extern Mutex* TouchedMethodLog_lock; // a lock on allocation of LogExecutedMethods info
65 extern Mutex* RetData_lock; // a lock on installation of RetData inside method data
66 extern Monitor* VMOperation_lock; // a lock on queue of vm_operations waiting to execute
67 extern Monitor* ThreadsLockThrottle_lock; // used by Thread start/exit to reduce competition for Threads_lock,
68 // so a VM thread calling a safepoint is prioritized
69 extern Monitor* Threads_lock; // a lock on the Threads table of active Java threads
70 // (also used by Safepoints too to block threads creation/destruction)
71 extern Mutex* NonJavaThreadsList_lock; // a lock on the NonJavaThreads list
72 extern Mutex* NonJavaThreadsListSync_lock; // a lock for NonJavaThreads list synchronization
73 extern Monitor* STS_lock; // used for joining/leaving SuspendibleThreadSet.
74 extern Mutex* MonitoringSupport_lock; // Protects updates to the serviceability memory pools and allocated memory high water mark.
75 extern Monitor* ConcurrentGCBreakpoints_lock; // Protects concurrent GC breakpoint management
76 extern Mutex* Compile_lock; // a lock held when Compilation is updating code (used to block CodeCache traversal, CHA updates, etc)
77 extern Monitor* MethodCompileQueue_lock; // a lock held when method compilations are enqueued, dequeued
78 extern Monitor* CompileThread_lock; // a lock held by compile threads during compilation system initialization
79 extern Monitor* Compilation_lock; // a lock used to pause compilation
80 extern Mutex* TrainingData_lock; // a lock used when accessing training records
81 extern Monitor* TrainingReplayQueue_lock; // a lock held when class are added/removed to the training replay queue
82 extern Monitor* CompileTaskWait_lock; // a lock held when CompileTasks are waited/notified
83 extern Mutex* CompileStatistics_lock; // a lock held when updating compilation statistics
84 extern Mutex* DirectivesStack_lock; // a lock held when mutating the dirstack and ref counting directives
85 extern Monitor* Terminator_lock; // a lock used to guard termination of the vm
86 extern Monitor* InitCompleted_lock; // a lock used to signal threads waiting on init completed
87 extern Monitor* BeforeExit_lock; // a lock used to guard cleanups and shutdown hooks
88 extern Monitor* Notify_lock; // a lock used to synchronize the start-up of the vm
89 extern Mutex* ExceptionCache_lock; // a lock used to synchronize exception cache updates
90
91 #ifndef PRODUCT
92 extern Mutex* FullGCALot_lock; // a lock to make FullGCALot MT safe
93 #endif // PRODUCT
94
95 #if INCLUDE_G1GC
96 extern Monitor* G1CGC_lock; // used for coordination between fore- & background G1 concurrent GC threads.
97 extern Mutex* G1DetachedRefinementStats_lock; // Lock protecting detached refinement stats for G1.
117 extern Monitor* RedefineClasses_lock; // locks classes from parallel redefinition
118 extern Mutex* Verify_lock; // synchronize initialization of verify library
119 extern Monitor* ThreadsSMRDelete_lock; // Used by ThreadsSMRSupport to take pressure off the Threads_lock
120 extern Mutex* ThreadIdTableCreate_lock; // Used by ThreadIdTable to lazily create the thread id table
121 extern Mutex* SharedDecoder_lock; // serializes access to the decoder during normal (not error reporting) use
122 extern Mutex* DCmdFactory_lock; // serialize access to DCmdFactory information
123 extern Mutex* NMTQuery_lock; // serialize NMT Dcmd queries
124 extern Mutex* NMTCompilationCostHistory_lock; // guards NMT compilation cost history
125 extern Mutex* NmtVirtualMemory_lock; // guards NMT virtual memory updates
126 #if INCLUDE_CDS
127 #if INCLUDE_JVMTI
128 extern Mutex* CDSClassFileStream_lock; // FileMapInfo::open_stream_for_jvmti
129 #endif
130 extern Mutex* DumpTimeTable_lock; // SystemDictionaryShared::_dumptime_table
131 extern Mutex* CDSLambda_lock; // LambdaProxyClassDictionary::find_lambda_proxy_class
132 extern Mutex* DumpRegion_lock; // Symbol::operator new(size_t sz, int len)
133 extern Mutex* ClassListFile_lock; // ClassListWriter()
134 extern Mutex* UnregisteredClassesTable_lock; // UnregisteredClassesTableTable
135 extern Mutex* LambdaFormInvokers_lock; // Protecting LambdaFormInvokers::_lambdaform_lines
136 extern Mutex* ScratchObjects_lock; // Protecting _scratch_xxx_table in heapShared.cpp
137 extern Mutex* FinalImageRecipes_lock; // Protecting the tables used by FinalImageRecipes.
138 #endif // INCLUDE_CDS
139 #if INCLUDE_JFR
140 extern Mutex* JfrStacktrace_lock; // used to guard access to the JFR stacktrace table
141 extern Monitor* JfrMsg_lock; // protects JFR messaging
142 extern Mutex* JfrBuffer_lock; // protects JFR buffer operations
143 #endif
144
145 extern Mutex* Metaspace_lock; // protects Metaspace virtualspace and chunk expansions
146 extern Monitor* MetaspaceCritical_lock; // synchronizes failed metaspace allocations that risk throwing metaspace OOM
147 extern Mutex* ClassLoaderDataGraph_lock; // protects CLDG list, needed for concurrent unloading
148
149
150 extern Mutex* CodeHeapStateAnalytics_lock; // lock print functions against concurrent analyze functions.
151 // Only used locally in PrintCodeCacheLayout processing.
152
153 extern Mutex* ExternalsRecorder_lock; // used to guard access to the external addresses table
154
155 extern Mutex* AOTCodeCStrings_lock; // used to guard access to the AOT code C strings table
156
176 // See orderAccess.hpp. We assume throughout the VM that MutexLocker's
177 // and friends constructors do a fence, a lock and an acquire *in that
178 // order*. And that their destructors do a release and unlock, in *that*
179 // order. If their implementations change such that these assumptions
180 // are violated, a whole lot of code will break.
181
182 // for debugging: check that we're already owning this lock (or are at a safepoint / handshake)
183 #ifdef ASSERT
184 void assert_locked_or_safepoint(const Mutex* lock);
185 void assert_lock_strong(const Mutex* lock);
186 #else
187 #define assert_locked_or_safepoint(lock)
188 #define assert_lock_strong(lock)
189 #endif
190
191 // Internal implementation. Skips on null Mutex.
192 // Subclasses enforce stronger invariants.
193 class MutexLockerImpl: public StackObj {
194 protected:
195 Mutex* _mutex;
196
197 MutexLockerImpl(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
198 _mutex(mutex) {
199 bool no_safepoint_check = flag == Mutex::_no_safepoint_check_flag;
200 if (_mutex != nullptr) {
201 if (no_safepoint_check) {
202 _mutex->lock_without_safepoint_check();
203 } else {
204 _mutex->lock();
205 }
206 }
207 }
208
209 MutexLockerImpl(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
210 _mutex(mutex) {
211 bool no_safepoint_check = flag == Mutex::_no_safepoint_check_flag;
212 if (_mutex != nullptr) {
213 if (no_safepoint_check) {
214 _mutex->lock_without_safepoint_check(thread);
215 } else {
216 _mutex->lock(thread);
217 }
218 }
219 }
220
221 ~MutexLockerImpl() {
222 if (_mutex != nullptr) {
223 assert_lock_strong(_mutex);
224 _mutex->unlock();
225 }
226 }
227
228 public:
229 static void post_initialize();
230 };
231
232 // Simplest mutex locker.
233 // Does not allow null mutexes.
234 class MutexLocker: public MutexLockerImpl {
235 public:
236 MutexLocker(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
237 MutexLockerImpl(mutex, flag) {
238 assert(mutex != nullptr, "null mutex not allowed");
239 }
240
241 MutexLocker(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
242 MutexLockerImpl(thread, mutex, flag) {
243 assert(mutex != nullptr, "null mutex not allowed");
244 }
245 };
246
247 // Conditional mutex locker.
248 // Like MutexLocker above, but only locks when condition is true.
249 class ConditionalMutexLocker: public MutexLockerImpl {
|
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 #ifndef SHARE_RUNTIME_MUTEXLOCKER_HPP
26 #define SHARE_RUNTIME_MUTEXLOCKER_HPP
27
28 #include "logging/log.hpp"
29 #include "memory/allocation.hpp"
30 #include "runtime/flags/flagSetting.hpp"
31 #include "runtime/mutex.hpp"
32 #include "runtime/perfData.hpp"
33
34 class Thread;
35
36 // Mutexes used in the VM.
37
38 extern Mutex* NMethodState_lock; // a lock used to guard a compiled method state
39 extern Mutex* NMethodEntryBarrier_lock; // protects nmethod entry barrier
40 extern Monitor* SystemDictionary_lock; // a lock on the system dictionary
41 extern Mutex* InvokeMethodTypeTable_lock;
42 extern Monitor* InvokeMethodIntrinsicTable_lock;
43 extern Mutex* SharedDictionary_lock; // a lock on the CDS shared dictionary
44 extern Monitor* ClassInitError_lock; // a lock on the class initialization error table
45 extern Mutex* Module_lock; // a lock on module and package related data structures
46 extern Mutex* CompiledIC_lock; // a lock used to guard compiled IC patching and access
47 extern Mutex* VMStatistic_lock; // a lock used to guard statistics count increment
48 extern Mutex* JmethodIdCreation_lock; // a lock on creating JNI method identifiers
49 extern Mutex* JfieldIdCreation_lock; // a lock on creating JNI static field identifiers
50 extern Monitor* JNICritical_lock; // a lock used while synchronizing with threads entering/leaving JNI critical regions
51 extern Mutex* JvmtiThreadState_lock; // a lock on modification of JVMTI thread data
52 extern Monitor* EscapeBarrier_lock; // a lock to sync reallocating and relocking objects because of JVMTI access
60 extern Mutex* SignatureHandlerLibrary_lock; // a lock on the SignatureHandlerLibrary
61 extern Mutex* VtableStubs_lock; // a lock on the VtableStubs
62 extern Mutex* SymbolArena_lock; // a lock on the symbol table arena
63 extern Monitor* StringDedup_lock; // a lock on the string deduplication facility
64 extern Mutex* StringDedupIntern_lock; // a lock on StringTable notification of StringDedup
65 extern Monitor* CodeCache_lock; // a lock on the CodeCache
66 extern Mutex* TouchedMethodLog_lock; // a lock on allocation of LogExecutedMethods info
67 extern Mutex* RetData_lock; // a lock on installation of RetData inside method data
68 extern Monitor* VMOperation_lock; // a lock on queue of vm_operations waiting to execute
69 extern Monitor* ThreadsLockThrottle_lock; // used by Thread start/exit to reduce competition for Threads_lock,
70 // so a VM thread calling a safepoint is prioritized
71 extern Monitor* Threads_lock; // a lock on the Threads table of active Java threads
72 // (also used by Safepoints too to block threads creation/destruction)
73 extern Mutex* NonJavaThreadsList_lock; // a lock on the NonJavaThreads list
74 extern Mutex* NonJavaThreadsListSync_lock; // a lock for NonJavaThreads list synchronization
75 extern Monitor* STS_lock; // used for joining/leaving SuspendibleThreadSet.
76 extern Mutex* MonitoringSupport_lock; // Protects updates to the serviceability memory pools and allocated memory high water mark.
77 extern Monitor* ConcurrentGCBreakpoints_lock; // Protects concurrent GC breakpoint management
78 extern Mutex* Compile_lock; // a lock held when Compilation is updating code (used to block CodeCache traversal, CHA updates, etc)
79 extern Monitor* MethodCompileQueue_lock; // a lock held when method compilations are enqueued, dequeued
80 extern Monitor* MethodCompileQueueC1_lock; // a lock held when method compilations are enqueued, dequeued
81 extern Monitor* MethodCompileQueueC2_lock; // a lock held when method compilations are enqueued, dequeued
82 extern Monitor* MethodCompileQueueSC1_lock; // a lock held when method compilations are enqueued, dequeued
83 extern Monitor* MethodCompileQueueSC2_lock; // a lock held when method compilations are enqueued, dequeued
84 extern Monitor* CompileThread_lock; // a lock held by compile threads during compilation system initialization
85 extern Monitor* Compilation_lock; // a lock used to pause compilation
86 extern Mutex* TrainingData_lock; // a lock used when accessing training records
87 extern Monitor* TrainingReplayQueue_lock; // a lock held when class are added/removed to the training replay queue
88 extern Monitor* CompileTaskWait_lock; // a lock held when CompileTasks are waited/notified
89 extern Mutex* CompileStatistics_lock; // a lock held when updating compilation statistics
90 extern Mutex* DirectivesStack_lock; // a lock held when mutating the dirstack and ref counting directives
91 extern Monitor* Terminator_lock; // a lock used to guard termination of the vm
92 extern Monitor* InitCompleted_lock; // a lock used to signal threads waiting on init completed
93 extern Monitor* BeforeExit_lock; // a lock used to guard cleanups and shutdown hooks
94 extern Monitor* Notify_lock; // a lock used to synchronize the start-up of the vm
95 extern Mutex* ExceptionCache_lock; // a lock used to synchronize exception cache updates
96
97 #ifndef PRODUCT
98 extern Mutex* FullGCALot_lock; // a lock to make FullGCALot MT safe
99 #endif // PRODUCT
100
101 #if INCLUDE_G1GC
102 extern Monitor* G1CGC_lock; // used for coordination between fore- & background G1 concurrent GC threads.
103 extern Mutex* G1DetachedRefinementStats_lock; // Lock protecting detached refinement stats for G1.
123 extern Monitor* RedefineClasses_lock; // locks classes from parallel redefinition
124 extern Mutex* Verify_lock; // synchronize initialization of verify library
125 extern Monitor* ThreadsSMRDelete_lock; // Used by ThreadsSMRSupport to take pressure off the Threads_lock
126 extern Mutex* ThreadIdTableCreate_lock; // Used by ThreadIdTable to lazily create the thread id table
127 extern Mutex* SharedDecoder_lock; // serializes access to the decoder during normal (not error reporting) use
128 extern Mutex* DCmdFactory_lock; // serialize access to DCmdFactory information
129 extern Mutex* NMTQuery_lock; // serialize NMT Dcmd queries
130 extern Mutex* NMTCompilationCostHistory_lock; // guards NMT compilation cost history
131 extern Mutex* NmtVirtualMemory_lock; // guards NMT virtual memory updates
132 #if INCLUDE_CDS
133 #if INCLUDE_JVMTI
134 extern Mutex* CDSClassFileStream_lock; // FileMapInfo::open_stream_for_jvmti
135 #endif
136 extern Mutex* DumpTimeTable_lock; // SystemDictionaryShared::_dumptime_table
137 extern Mutex* CDSLambda_lock; // LambdaProxyClassDictionary::find_lambda_proxy_class
138 extern Mutex* DumpRegion_lock; // Symbol::operator new(size_t sz, int len)
139 extern Mutex* ClassListFile_lock; // ClassListWriter()
140 extern Mutex* UnregisteredClassesTable_lock; // UnregisteredClassesTableTable
141 extern Mutex* LambdaFormInvokers_lock; // Protecting LambdaFormInvokers::_lambdaform_lines
142 extern Mutex* ScratchObjects_lock; // Protecting _scratch_xxx_table in heapShared.cpp
143 extern Mutex* ArchivedObjectTables_lock; // Protecting the table used by HeapShared::get_archived_object_permanent_index()
144 extern Mutex* FinalImageRecipes_lock; // Protecting the tables used by FinalImageRecipes.
145 #endif // INCLUDE_CDS
146 #if INCLUDE_JFR
147 extern Mutex* JfrStacktrace_lock; // used to guard access to the JFR stacktrace table
148 extern Monitor* JfrMsg_lock; // protects JFR messaging
149 extern Mutex* JfrBuffer_lock; // protects JFR buffer operations
150 #endif
151
152 extern Mutex* Metaspace_lock; // protects Metaspace virtualspace and chunk expansions
153 extern Monitor* MetaspaceCritical_lock; // synchronizes failed metaspace allocations that risk throwing metaspace OOM
154 extern Mutex* ClassLoaderDataGraph_lock; // protects CLDG list, needed for concurrent unloading
155
156
157 extern Mutex* CodeHeapStateAnalytics_lock; // lock print functions against concurrent analyze functions.
158 // Only used locally in PrintCodeCacheLayout processing.
159
160 extern Mutex* ExternalsRecorder_lock; // used to guard access to the external addresses table
161
162 extern Mutex* AOTCodeCStrings_lock; // used to guard access to the AOT code C strings table
163
183 // See orderAccess.hpp. We assume throughout the VM that MutexLocker's
184 // and friends constructors do a fence, a lock and an acquire *in that
185 // order*. And that their destructors do a release and unlock, in *that*
186 // order. If their implementations change such that these assumptions
187 // are violated, a whole lot of code will break.
188
189 // for debugging: check that we're already owning this lock (or are at a safepoint / handshake)
190 #ifdef ASSERT
191 void assert_locked_or_safepoint(const Mutex* lock);
192 void assert_lock_strong(const Mutex* lock);
193 #else
194 #define assert_locked_or_safepoint(lock)
195 #define assert_lock_strong(lock)
196 #endif
197
198 // Internal implementation. Skips on null Mutex.
199 // Subclasses enforce stronger invariants.
200 class MutexLockerImpl: public StackObj {
201 protected:
202 Mutex* _mutex;
203 bool _prof;
204 elapsedTimer _before;
205 elapsedTimer _after;
206
207 private:
208 static PerfCounter** _perf_lock_count;
209 static PerfCounter** _perf_lock_wait_time;
210 static PerfCounter** _perf_lock_hold_time;
211
212 public:
213
214 MutexLockerImpl(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag);
215
216 MutexLockerImpl(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag);
217
218 ~MutexLockerImpl() {
219 if (_mutex != nullptr) {
220 assert_lock_strong(_mutex);
221 _mutex->unlock();
222
223 if (_mutex->id() == -1) {
224 log_trace(init)("Unnamed unclassified lock: %s", _mutex->name());
225 }
226
227 if (_prof) {
228 assert(UsePerfData, "required");
229 _after.stop();
230 _perf_lock_count [_mutex->id() + 1]->inc();
231 _perf_lock_wait_time[_mutex->id() + 1]->inc(_before.ticks());
232 _perf_lock_hold_time[_mutex->id() + 1]->inc(_after.ticks());
233 }
234 }
235 }
236
237 private:
238 static void print_counter_on(outputStream* st, const char* name, bool is_unique, int idx);
239
240 public:
241 static int name2id(const char* name);
242
243 static void post_initialize();
244 static void init_counters();
245 static void print_counters_on(outputStream* st);
246 };
247
248 // Simplest mutex locker.
249 // Does not allow null mutexes.
250 class MutexLocker: public MutexLockerImpl {
251 public:
252 MutexLocker(Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
253 MutexLockerImpl(mutex, flag) {
254 assert(mutex != nullptr, "null mutex not allowed");
255 }
256
257 MutexLocker(Thread* thread, Mutex* mutex, Mutex::SafepointCheckFlag flag = Mutex::_safepoint_check_flag) :
258 MutexLockerImpl(thread, mutex, flag) {
259 assert(mutex != nullptr, "null mutex not allowed");
260 }
261 };
262
263 // Conditional mutex locker.
264 // Like MutexLocker above, but only locks when condition is true.
265 class ConditionalMutexLocker: public MutexLockerImpl {
|