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 ObjectWaiter* volatile _next; 47 ObjectWaiter* volatile _prev; 48 Thread* _thread; 49 jlong _notifier_tid; 50 ParkEvent * _event; 51 volatile int _notified; 52 volatile TStates TState; 53 bool _active; // Contention monitoring is enabled 54 public: 55 ObjectWaiter(Thread* thread); 56 57 void wait_reenter_begin(ObjectMonitor *mon); 58 void wait_reenter_end(ObjectMonitor *mon); 59 }; 60 61 // The ObjectMonitor class implements the heavyweight version of a 62 // JavaMonitor. The lightweight BasicLock/stack lock version has been 63 // inflated into an ObjectMonitor. This inflation is typically due to 64 // contention or use of Object.wait(). 65 // 66 // WARNING: This is a very sensitive and fragile class. DO NOT make any 67 // changes unless you are fully aware of the underlying semantics. 68 // 69 // ObjectMonitor Layout Overview/Highlights/Restrictions: 70 // 71 // - The _header field must be at offset 0 because the displaced header 72 // from markWord is stored there. We do not want markWord.hpp to include 73 // ObjectMonitor.hpp to avoid exposing ObjectMonitor everywhere. This 74 // means that ObjectMonitor cannot inherit from any other class nor can 75 // it use any virtual member functions. This restriction is critical to 76 // the proper functioning of the VM. 77 // - The _header and _owner fields should be separated by enough space 78 // to avoid false sharing due to parallel access by different threads. 79 // This is an advisory recommendation. 80 // - The general layout of the fields in ObjectMonitor is: 81 // _header 82 // <lightly_used_fields> 83 // <optional padding> 84 // _owner 85 // <remaining_fields> 86 // - The VM assumes write ordering and machine word alignment with 87 // respect to the _owner field and the <remaining_fields> that can 88 // be read in parallel by other threads. 89 // - Generally fields that are accessed closely together in time should 90 // be placed proximally in space to promote data cache locality. That 91 // is, temporal locality should condition spatial locality. 92 // - We have to balance avoiding false sharing with excessive invalidation 93 // from coherence traffic. As such, we try to cluster fields that tend 94 // to be _written_ at approximately the same time onto the same data 95 // cache line. 96 // - We also have to balance the natural tension between minimizing 97 // single threaded capacity misses with excessive multi-threaded 98 // coherency misses. There is no single optimal layout for both 99 // single-threaded and multi-threaded environments. 100 // 101 // - See TEST_VM(ObjectMonitor, sanity) gtest for how critical restrictions are 102 // enforced. 103 // - Adjacent ObjectMonitors should be separated by enough space to avoid 104 // false sharing. This is handled by the ObjectMonitor allocation code 105 // in synchronizer.cpp. Also see TEST_VM(SynchronizerTest, sanity) gtest. 106 // 107 // Futures notes: 108 // - Separating _owner from the <remaining_fields> by enough space to 109 // avoid false sharing might be profitable. Given 110 // http://blogs.oracle.com/dave/entry/cas_and_cache_trivia_invalidate 111 // we know that the CAS in monitorenter will invalidate the line 112 // underlying _owner. We want to avoid an L1 data cache miss on that 113 // same line for monitorexit. Putting these <remaining_fields>: 114 // _recursions, _EntryList, _cxq, and _succ, all of which may be 115 // fetched in the inflated unlock path, on a different cache line 116 // would make them immune to CAS-based invalidation from the _owner 117 // field. 118 // 119 // - The _recursions field should be of type int, or int32_t but not 120 // intptr_t. There's no reason to use a 64-bit type for this field 121 // in a 64-bit JVM. 122 123 #ifndef OM_CACHE_LINE_SIZE 124 // Use DEFAULT_CACHE_LINE_SIZE if not already specified for 125 // the current build platform. 126 #define OM_CACHE_LINE_SIZE DEFAULT_CACHE_LINE_SIZE 127 #endif 128 129 class ObjectMonitor { 130 friend class ObjectSynchronizer; 131 friend class ObjectWaiter; 132 friend class VMStructs; 133 JVMCI_ONLY(friend class JVMCIVMStructs;) 134 135 // The sync code expects the header field to be at offset zero (0). 136 // Enforced by the assert() in header_addr(). 137 volatile markWord _header; // displaced object header word - mark 138 void* volatile _object; // backward object pointer - strong root 139 public: 140 ObjectMonitor* _next_om; // Next ObjectMonitor* linkage 141 private: 142 // Separate _header and _owner on different cache lines since both can 143 // have busy multi-threaded access. _header and _object are set at 144 // initial inflation and _object doesn't change until deflation so 145 // _object is a good choice to share the cache line with _header. 146 // _next_om shares _header's cache line for pre-monitor list historical 147 // reasons. _next_om only changes if the next ObjectMonitor is deflated. 148 DEFINE_PAD_MINUS_SIZE(0, OM_CACHE_LINE_SIZE, 149 sizeof(volatile markWord) + sizeof(void* volatile) + 150 sizeof(ObjectMonitor *)); 151 void* volatile _owner; // pointer to owning thread OR BasicLock 152 volatile jlong _previous_owner_tid; // thread id of the previous owner of the monitor 153 volatile intx _recursions; // recursion count, 0 for first entry 154 ObjectWaiter* volatile _EntryList; // Threads blocked on entry or reentry. 155 // The list is actually composed of WaitNodes, 156 // acting as proxies for Threads. 157 158 ObjectWaiter* volatile _cxq; // LL of recently-arrived threads blocked on entry. 159 Thread* volatile _succ; // Heir presumptive thread - used for futile wakeup throttling 160 Thread* volatile _Responsible; 161 162 volatile int _Spinner; // for exit->spinner handoff optimization 163 volatile int _SpinDuration; 164 165 volatile jint _contentions; // Number of active contentions in enter(). It is used by is_busy() 166 // along with other fields to determine if an ObjectMonitor can be 167 // deflated. See ObjectSynchronizer::deflate_monitor(). 168 protected: 169 ObjectWaiter* volatile _WaitSet; // LL of threads wait()ing on the monitor 170 volatile jint _waiters; // number of waiting threads 171 private: 172 volatile int _WaitSetLock; // protects Wait Queue - simple spinlock 173 174 public: 175 static void Initialize(); 176 177 // Only perform a PerfData operation if the PerfData object has been 178 // allocated and if the PerfDataManager has not freed the PerfData 179 // objects which can happen at normal VM shutdown. 180 // 181 #define OM_PERFDATA_OP(f, op_str) \ 182 do { \ 183 if (ObjectMonitor::_sync_ ## f != NULL && \ 184 PerfDataManager::has_PerfData()) { \ 185 ObjectMonitor::_sync_ ## f->op_str; \ 186 } \ 187 } while (0) 188 189 static PerfCounter * _sync_ContendedLockAttempts; 190 static PerfCounter * _sync_FutileWakeups; 191 static PerfCounter * _sync_Parks; 192 static PerfCounter * _sync_Notifications; 193 static PerfCounter * _sync_Inflations; 194 static PerfCounter * _sync_Deflations; 195 static PerfLongVariable * _sync_MonExtant; 196 197 static int Knob_SpinLimit; 198 199 void* operator new (size_t size) throw(); 200 void* operator new[] (size_t size) throw(); 201 void operator delete(void* p); 202 void operator delete[] (void* p); 203 204 // TODO-FIXME: the "offset" routines should return a type of off_t instead of int ... 205 // ByteSize would also be an appropriate type. 206 static int header_offset_in_bytes() { return offset_of(ObjectMonitor, _header); } 207 static int object_offset_in_bytes() { return offset_of(ObjectMonitor, _object); } 208 static int owner_offset_in_bytes() { return offset_of(ObjectMonitor, _owner); } 209 static int recursions_offset_in_bytes() { return offset_of(ObjectMonitor, _recursions); } 210 static int cxq_offset_in_bytes() { return offset_of(ObjectMonitor, _cxq); } 211 static int succ_offset_in_bytes() { return offset_of(ObjectMonitor, _succ); } 212 static int EntryList_offset_in_bytes() { return offset_of(ObjectMonitor, _EntryList); } 213 214 // ObjectMonitor references can be ORed with markWord::monitor_value 215 // as part of the ObjectMonitor tagging mechanism. When we combine an 216 // ObjectMonitor reference with an offset, we need to remove the tag 217 // value in order to generate the proper address. 218 // 219 // We can either adjust the ObjectMonitor reference and then add the 220 // offset or we can adjust the offset that is added to the ObjectMonitor 221 // reference. The latter avoids an AGI (Address Generation Interlock) 222 // stall so the helper macro adjusts the offset value that is returned 223 // to the ObjectMonitor reference manipulation code: 224 // 225 #define OM_OFFSET_NO_MONITOR_VALUE_TAG(f) \ 226 ((ObjectMonitor::f ## _offset_in_bytes()) - markWord::monitor_value) 227 228 markWord header() const; 229 volatile markWord* header_addr(); 230 void set_header(markWord hdr); 231 232 intptr_t is_busy() const { 233 // TODO-FIXME: assert _owner == null implies _recursions = 0 234 return _contentions|_waiters|intptr_t(_owner)|intptr_t(_cxq)|intptr_t(_EntryList); 235 } 236 const char* is_busy_to_string(stringStream* ss); 237 238 intptr_t is_entered(Thread* current) const; 239 240 void* owner() const; 241 void set_owner(void* owner); 242 243 jint waiters() const; 244 245 jint contentions() const; 246 intx recursions() const { return _recursions; } 247 248 // JVM/TI GetObjectMonitorUsage() needs this: 249 ObjectWaiter* first_waiter() { return _WaitSet; } 250 ObjectWaiter* next_waiter(ObjectWaiter* o) { return o->_next; } 251 Thread* thread_of_waiter(ObjectWaiter* o) { return o->_thread; } 252 253 protected: 254 // We don't typically expect or want the ctors or dtors to run. 255 // normal ObjectMonitors are type-stable and immortal. 256 ObjectMonitor() { ::memset((void*)this, 0, sizeof(*this)); } 257 258 ~ObjectMonitor() { 259 // TODO: Add asserts ... 260 // _cxq == 0 _succ == NULL _owner == NULL _waiters == 0 261 // _contentions == 0 _EntryList == NULL etc 262 } 263 264 private: 265 void Recycle() { 266 // TODO: add stronger asserts ... 267 // _cxq == 0 _succ == NULL _owner == NULL _waiters == 0 268 // _contentions == 0 EntryList == NULL 269 // _recursions == 0 _WaitSet == NULL 270 DEBUG_ONLY(stringStream ss;) 271 assert((is_busy() | _recursions) == 0, "freeing in-use monitor: %s, " 272 "recursions=" INTX_FORMAT, is_busy_to_string(&ss), _recursions); 273 _succ = NULL; 274 _EntryList = NULL; 275 _cxq = NULL; 276 _WaitSet = NULL; 277 _recursions = 0; 278 } 279 280 public: 281 282 void* object() const; 283 void* object_addr(); 284 void set_object(void* obj); 285 286 // Returns true if the specified thread owns the ObjectMonitor. Otherwise 287 // returns false and throws IllegalMonitorStateException (IMSE). 288 bool check_owner(Thread* THREAD); 289 void clear(); 290 291 void enter(TRAPS); 292 void exit(bool not_suspended, TRAPS); 293 void wait(jlong millis, bool interruptable, TRAPS); 294 void notify(TRAPS); 295 void notifyAll(TRAPS); 296 297 void print() const; 298 #ifdef ASSERT 299 void print_debug_style_on(outputStream* st) const; 300 #endif 301 void print_on(outputStream* st) const; 302 303 // Use the following at your own risk 304 intx complete_exit(TRAPS); 305 void reenter(intx recursions, TRAPS); 306 307 private: 308 void AddWaiter(ObjectWaiter* waiter); 309 void INotify(Thread* self); 310 ObjectWaiter* DequeueWaiter(); 311 void DequeueSpecificWaiter(ObjectWaiter* waiter); 312 void EnterI(TRAPS); 313 void ReenterI(Thread* self, ObjectWaiter* self_node); 314 void UnlinkAfterAcquire(Thread* self, ObjectWaiter* self_node); 315 int TryLock(Thread* self); 316 int NotRunnable(Thread* self, Thread * Owner); 317 int TrySpin(Thread* self); 318 void ExitEpilog(Thread* self, ObjectWaiter* Wakee); 319 bool ExitSuspendEquivalent(JavaThread* self); 320 }; 321 322 #endif // SHARE_RUNTIME_OBJECTMONITOR_HPP