1 /*
2 * Copyright (c) 1998, 2019, 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 #ifndef SHARE_RUNTIME_OBJECTMONITOR_HPP
26 #define SHARE_RUNTIME_OBJECTMONITOR_HPP
27
28 #include "memory/allocation.hpp"
29 #include "memory/padded.hpp"
30 #include "oops/markWord.hpp"
31 #include "runtime/os.hpp"
32 #include "runtime/park.hpp"
33 #include "runtime/perfData.hpp"
34
35 class ObjectMonitor;
36
37 // ObjectWaiter serves as a "proxy" or surrogate thread.
38 // TODO-FIXME: Eliminate ObjectWaiter and use the thread-specific
39 // ParkEvent instead. Beware, however, that the JVMTI code
40 // knows about ObjectWaiters, so we'll have to reconcile that code.
41 // See next_waiter(), first_waiter(), etc.
42
43 class ObjectWaiter : public StackObj {
44 public:
45 enum TStates { TS_UNDEF, TS_READY, TS_RUN, TS_WAIT, TS_ENTER, TS_CXQ };
46 enum Sorted { PREPEND, APPEND, SORTED };
47 ObjectWaiter* volatile _next;
48 ObjectWaiter* volatile _prev;
49 Thread* _thread;
50 jlong _notifier_tid;
51 ParkEvent * _event;
52 volatile int _notified;
53 volatile TStates TState;
54 Sorted _Sorted; // List placement disposition
55 bool _active; // Contention monitoring is enabled
56 public:
57 ObjectWaiter(Thread* thread);
58
59 void wait_reenter_begin(ObjectMonitor *mon);
60 void wait_reenter_end(ObjectMonitor *mon);
61 };
62
63 // The ObjectMonitor class implements the heavyweight version of a
64 // JavaMonitor. The lightweight BasicLock/stack lock version has been
65 // inflated into an ObjectMonitor. This inflation is typically due to
66 // contention or use of Object.wait().
67 //
68 // WARNING: This is a very sensitive and fragile class. DO NOT make any
69 // changes unless you are fully aware of the underlying semantics.
70 //
71 // Class JvmtiRawMonitor currently inherits from ObjectMonitor so
72 // changes in this class must be careful to not break JvmtiRawMonitor.
73 // These two subsystems should be separated.
74 //
75 // ObjectMonitor Layout Overview/Highlights/Restrictions:
76 //
77 // - The _header field must be at offset 0 because the displaced header
78 // from markWord is stored there. We do not want markWord.hpp to include
79 // ObjectMonitor.hpp to avoid exposing ObjectMonitor everywhere. This
80 // means that ObjectMonitor cannot inherit from any other class nor can
81 // it use any virtual member functions. This restriction is critical to
82 // the proper functioning of the VM.
83 // - The _header and _owner fields should be separated by enough space
84 // to avoid false sharing due to parallel access by different threads.
85 // This is an advisory recommendation.
86 // - The general layout of the fields in ObjectMonitor is:
87 // _header
88 // <lightly_used_fields>
89 // <optional padding>
90 // _owner
91 // <remaining_fields>
92 // - The VM assumes write ordering and machine word alignment with
93 // respect to the _owner field and the <remaining_fields> that can
94 // be read in parallel by other threads.
95 // - Generally fields that are accessed closely together in time should
96 // be placed proximally in space to promote data cache locality. That
97 // is, temporal locality should condition spatial locality.
98 // - We have to balance avoiding false sharing with excessive invalidation
99 // from coherence traffic. As such, we try to cluster fields that tend
100 // to be _written_ at approximately the same time onto the same data
101 // cache line.
102 // - We also have to balance the natural tension between minimizing
103 // single threaded capacity misses with excessive multi-threaded
104 // coherency misses. There is no single optimal layout for both
105 // single-threaded and multi-threaded environments.
106 //
107 // - See TEST_VM(ObjectMonitor, sanity) gtest for how critical restrictions are
108 // enforced.
109 // - Adjacent ObjectMonitors should be separated by enough space to avoid
110 // false sharing. This is handled by the ObjectMonitor allocation code
111 // in synchronizer.cpp. Also see TEST_VM(SynchronizerTest, sanity) gtest.
112 //
113 // Futures notes:
114 // - Separating _owner from the <remaining_fields> by enough space to
115 // avoid false sharing might be profitable. Given
116 // http://blogs.oracle.com/dave/entry/cas_and_cache_trivia_invalidate
117 // we know that the CAS in monitorenter will invalidate the line
118 // underlying _owner. We want to avoid an L1 data cache miss on that
119 // same line for monitorexit. Putting these <remaining_fields>:
120 // _recursions, _EntryList, _cxq, and _succ, all of which may be
121 // fetched in the inflated unlock path, on a different cache line
122 // would make them immune to CAS-based invalidation from the _owner
123 // field.
124 //
125 // - The _recursions field should be of type int, or int32_t but not
126 // intptr_t. There's no reason to use a 64-bit type for this field
127 // in a 64-bit JVM.
128
129 #ifndef OM_CACHE_LINE_SIZE
130 // Use DEFAULT_CACHE_LINE_SIZE if not already specified for
131 // the current build platform.
132 #define OM_CACHE_LINE_SIZE DEFAULT_CACHE_LINE_SIZE
133 #endif
134
135 class ObjectMonitor {
136 public:
137 enum {
138 OM_OK, // no error
139 OM_SYSTEM_ERROR, // operating system error
140 OM_ILLEGAL_MONITOR_STATE, // IllegalMonitorStateException
141 OM_INTERRUPTED, // Thread.interrupt()
142 OM_TIMED_OUT // Object.wait() timed out
143 };
144
145 private:
146 friend class ObjectMonitorHandle;
147 friend class ObjectSynchronizer;
148 friend class ObjectWaiter;
149 friend class VMStructs;
150 JVMCI_ONLY(friend class JVMCIVMStructs;)
151
152 // The sync code expects the header field to be at offset zero (0).
153 // Enforced by the assert() in header_addr().
154 volatile markWord _header; // displaced object header word - mark
155 void* volatile _object; // backward object pointer - strong root
156 typedef enum {
157 Free = 0, // Free must be 0 for monitor to be free after memset(..,0,..).
158 New,
159 Old
160 } AllocationState;
161 AllocationState _allocation_state;
162 // Separate _header and _owner on different cache lines since both can
163 // have busy multi-threaded access. _header, _object and _allocation_state
164 // are set at initial inflation. _object and _allocation_state don't
165 // change until deflation so _object and _allocation_state are good
166 // choices to share the cache line with _header.
167 DEFINE_PAD_MINUS_SIZE(0, OM_CACHE_LINE_SIZE, sizeof(volatile markWord) +
168 sizeof(void* volatile) + sizeof(AllocationState));
169 // Used by async deflation as a marker in the _owner field:
170 #define DEFLATER_MARKER reinterpret_cast<void*>(-1)
171 protected: // protected for JvmtiRawMonitor
172 void* volatile _owner; // pointer to owning thread OR BasicLock
173 private:
174 volatile jlong _previous_owner_tid; // thread id of the previous owner of the monitor
175 // Separate _owner and _ref_count on different cache lines since both
176 // can have busy multi-threaded access. _previous_owner_tid is only
177 // changed by ObjectMonitor::exit() so it is a good choice to share the
178 // cache line with _owner.
179 DEFINE_PAD_MINUS_SIZE(1, OM_CACHE_LINE_SIZE, sizeof(void* volatile) +
180 sizeof(volatile jlong));
181 volatile jint _ref_count; // ref count for ObjectMonitor* and used by the async deflation
182 // protocol. See ObjectSynchronizer::deflate_monitor_using_JT().
183 private:
184 // Separate _ref_count and _next_om on different cache lines since
185 // both can have busy multi-threaded access.
186 DEFINE_PAD_MINUS_SIZE(2, OM_CACHE_LINE_SIZE, sizeof(volatile jint));
187 public: // for static synchronizer.cpp access:
188 ObjectMonitor* volatile _next_om; // Next ObjectMonitor* linkage
189 protected: // protected for JvmtiRawMonitor
190 volatile intptr_t _recursions; // recursion count, 0 for first entry
191 ObjectWaiter* volatile _EntryList; // Threads blocked on entry or reentry.
192 // The list is actually composed of WaitNodes,
193 // acting as proxies for Threads.
194 private:
195 ObjectWaiter* volatile _cxq; // LL of recently-arrived threads blocked on entry.
196 Thread* volatile _succ; // Heir presumptive thread - used for futile wakeup throttling
197 Thread* volatile _Responsible;
198
199 volatile int _Spinner; // for exit->spinner handoff optimization
200 volatile int _SpinDuration;
201
202 volatile jint _contentions; // Number of active contentions in enter(). It is used by is_busy()
203 // along with other fields to determine if an ObjectMonitor can be
204 // deflated. See ObjectSynchronizer::deflate_monitor() and
205 // ObjectSynchronizer::deflate_monitor_using_JT().
206 protected:
207 ObjectWaiter* volatile _WaitSet; // LL of threads wait()ing on the monitor
208 volatile jint _waiters; // number of waiting threads
209 private:
210 volatile int _WaitSetLock; // protects Wait Queue - simple spinlock
211
212 public:
213 volatile int visit_marker;
214 static void Initialize();
215
216 // Only perform a PerfData operation if the PerfData object has been
217 // allocated and if the PerfDataManager has not freed the PerfData
218 // objects which can happen at normal VM shutdown.
219 //
220 #define OM_PERFDATA_OP(f, op_str) \
221 do { \
222 if (ObjectMonitor::_sync_ ## f != NULL && \
223 PerfDataManager::has_PerfData()) { \
224 ObjectMonitor::_sync_ ## f->op_str; \
225 } \
226 } while (0)
227
228 static PerfCounter * _sync_ContendedLockAttempts;
229 static PerfCounter * _sync_FutileWakeups;
230 static PerfCounter * _sync_Parks;
231 static PerfCounter * _sync_Notifications;
232 static PerfCounter * _sync_Inflations;
233 static PerfCounter * _sync_Deflations;
234 static PerfLongVariable * _sync_MonExtant;
235
236 static int Knob_SpinLimit;
237
238 void* operator new (size_t size) throw();
239 void* operator new[] (size_t size) throw();
240 void operator delete(void* p);
241 void operator delete[] (void* p);
242
243 // TODO-FIXME: the "offset" routines should return a type of off_t instead of int ...
244 // ByteSize would also be an appropriate type.
245 static int header_offset_in_bytes() { return offset_of(ObjectMonitor, _header); }
246 static int object_offset_in_bytes() { return offset_of(ObjectMonitor, _object); }
247 static int owner_offset_in_bytes() { return offset_of(ObjectMonitor, _owner); }
248 static int recursions_offset_in_bytes() { return offset_of(ObjectMonitor, _recursions); }
249 static int cxq_offset_in_bytes() { return offset_of(ObjectMonitor, _cxq); }
250 static int succ_offset_in_bytes() { return offset_of(ObjectMonitor, _succ); }
251 static int EntryList_offset_in_bytes() { return offset_of(ObjectMonitor, _EntryList); }
252
253 // ObjectMonitor references can be ORed with markWord::monitor_value
254 // as part of the ObjectMonitor tagging mechanism. When we combine an
255 // ObjectMonitor reference with an offset, we need to remove the tag
256 // value in order to generate the proper address.
257 //
258 // We can either adjust the ObjectMonitor reference and then add the
259 // offset or we can adjust the offset that is added to the ObjectMonitor
260 // reference. The latter avoids an AGI (Address Generation Interlock)
261 // stall so the helper macro adjusts the offset value that is returned
262 // to the ObjectMonitor reference manipulation code:
263 //
264 #define OM_OFFSET_NO_MONITOR_VALUE_TAG(f) \
265 ((ObjectMonitor::f ## _offset_in_bytes()) - markWord::monitor_value)
266
267 markWord header() const;
268 volatile markWord* header_addr();
269 void set_header(markWord hdr);
270
271 intptr_t is_busy() const {
272 // TODO-FIXME: assert _owner == null implies _recursions = 0
273 // We do not include _ref_count in the is_busy() check because
274 // _ref_count is for indicating that the ObjectMonitor* is in
275 // use which is orthogonal to whether the ObjectMonitor itself
276 // is in use for a locking operation.
277 intptr_t ret_code = _contentions | _waiters | intptr_t(_cxq) | intptr_t(_EntryList);
278 if (!AsyncDeflateIdleMonitors) {
279 ret_code |= intptr_t(_owner);
280 } else {
281 if (_owner != DEFLATER_MARKER) {
282 ret_code |= intptr_t(_owner);
283 }
284 }
285 return ret_code;
286 }
287 const char* is_busy_to_string(stringStream* ss);
288
289 intptr_t is_entered(Thread* current) const;
290
291 void* owner() const; // Returns NULL if DEFLATER_MARKER is observed.
292 // Returns true if owner field == DEFLATER_MARKER and false otherwise.
293 bool owner_is_DEFLATER_MARKER();
294 void set_owner(void* owner);
295
296 jint waiters() const;
297
298 jint contentions() const;
299 intptr_t recursions() const { return _recursions; }
300
301 // JVM/TI GetObjectMonitorUsage() needs this:
302 ObjectWaiter* first_waiter() { return _WaitSet; }
303 ObjectWaiter* next_waiter(ObjectWaiter* o) { return o->_next; }
304 Thread* thread_of_waiter(ObjectWaiter* o) { return o->_thread; }
305
306 protected:
307 // We don't typically expect or want the ctors or dtors to run.
308 // normal ObjectMonitors are type-stable and immortal.
309 ObjectMonitor() { ::memset((void*)this, 0, sizeof(*this)); }
310
311 ~ObjectMonitor() {
312 // TODO: Add asserts ...
313 // _cxq == 0 _succ == NULL _owner == NULL _waiters == 0
314 // _contentions == 0 _EntryList == NULL etc
315 }
316
317 private:
318 void Recycle() {
319 // TODO: add stronger asserts ...
320 // _cxq == 0 _succ == NULL _owner == NULL _waiters == 0
321 // _contentions == 0 EntryList == NULL
322 // _recursions == 0 _WaitSet == NULL
323 DEBUG_ONLY(stringStream ss;)
324 assert((is_busy() | _recursions) == 0, "freeing in-use monitor: %s, "
325 "recursions=" INTPTR_FORMAT, is_busy_to_string(&ss), _recursions);
326 _succ = NULL;
327 _EntryList = NULL;
328 _cxq = NULL;
329 _WaitSet = NULL;
330 _recursions = 0;
331 }
332
333 public:
334
335 void* object() const;
336 void* object_addr();
337 void set_object(void* obj);
338 void set_allocation_state(AllocationState s);
339 AllocationState allocation_state() const;
340 bool is_free() const;
341 bool is_active() const;
342 bool is_old() const;
343 bool is_new() const;
344 void dec_ref_count();
345 void inc_ref_count();
346 jint ref_count() const;
347
348 // Returns true if the specified thread owns the ObjectMonitor. Otherwise
349 // returns false and throws IllegalMonitorStateException (IMSE).
350 bool check_owner(Thread* THREAD);
351 void clear();
352 void clear_using_JT();
353
354 void enter(TRAPS);
355 void exit(bool not_suspended, TRAPS);
356 void wait(jlong millis, bool interruptable, TRAPS);
357 void notify(TRAPS);
358 void notifyAll(TRAPS);
359
360 void print() const;
361 void print_on(outputStream* st) const;
362
363 // Use the following at your own risk
364 intptr_t complete_exit(TRAPS);
365 void reenter(intptr_t recursions, TRAPS);
366
367 private:
368 void AddWaiter(ObjectWaiter* waiter);
369 void INotify(Thread* self);
370 ObjectWaiter* DequeueWaiter();
371 void DequeueSpecificWaiter(ObjectWaiter* waiter);
372 void EnterI(TRAPS);
373 void ReenterI(Thread* self, ObjectWaiter* self_node);
374 void UnlinkAfterAcquire(Thread* self, ObjectWaiter* self_node);
375 int TryLock(Thread* self);
376 int NotRunnable(Thread* self, Thread* Owner);
377 int TrySpin(Thread* self);
378 void ExitEpilog(Thread* self, ObjectWaiter* Wakee);
379 bool ExitSuspendEquivalent(JavaThread* self);
380 void install_displaced_markword_in_object(const oop obj);
381 };
382
383 // A helper object for managing an ObjectMonitor*'s ref_count. There
384 // are special safety considerations when async deflation is used.
385 class ObjectMonitorHandle : public StackObj {
386 private:
387 ObjectMonitor* _om_ptr;
388 public:
389 ObjectMonitorHandle() { _om_ptr = NULL; }
390 ~ObjectMonitorHandle();
391
392 ObjectMonitor* om_ptr() const { return _om_ptr; }
393 // Save the ObjectMonitor* associated with the specified markWord and
394 // increment the ref_count.
395 bool save_om_ptr(oop object, markWord mark);
396
397 // For internal used by ObjectSynchronizer::monitors_iterate().
398 ObjectMonitorHandle(ObjectMonitor* _om_ptr);
399 // For internal use by ObjectSynchronizer::inflate().
400 void set_om_ptr(ObjectMonitor* om_ptr);
401 };
402
403 // Macro to use guarantee() for more strict AsyncDeflateIdleMonitors
404 // checks and assert() otherwise.
405 #define ADIM_guarantee(p, ...) \
406 do { \
407 if (AsyncDeflateIdleMonitors) { \
408 guarantee(p, __VA_ARGS__); \
409 } else { \
410 assert(p, __VA_ARGS__); \
411 } \
412 } while (0)
413
414 #endif // SHARE_RUNTIME_OBJECTMONITOR_HPP