1 /* 2 * Copyright (c) 2017, 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_OOPS_ACCESS_HPP 26 #define SHARE_OOPS_ACCESS_HPP 27 28 #include "memory/allocation.hpp" 29 #include "oops/accessBackend.hpp" 30 #include "oops/accessDecorators.hpp" 31 #include "oops/oopsHierarchy.hpp" 32 #include "utilities/debug.hpp" 33 #include "utilities/globalDefinitions.hpp" 34 35 36 // = GENERAL = 37 // Access is an API for performing accesses with declarative semantics. Each access can have a number of "decorators". 38 // A decorator is an attribute or property that affects the way a memory access is performed in some way. 39 // There are different groups of decorators. Some have to do with memory ordering, others to do with, 40 // e.g. strength of references, strength of GC barriers, or whether compression should be applied or not. 41 // Some decorators are set at buildtime, such as whether primitives require GC barriers or not, others 42 // at callsites such as whether an access is in the heap or not, and others are resolved at runtime 43 // such as GC-specific barriers and encoding/decoding compressed oops. For more information about what 44 // decorators are available, cf. oops/accessDecorators.hpp. 45 // By pipelining handling of these decorators, the design of the Access API allows separation of concern 46 // over the different orthogonal concerns of decorators, while providing a powerful way of 47 // expressing these orthogonal semantic properties in a unified way. 48 // 49 // == OPERATIONS == 50 // * load: Load a value from an address. 51 // * load_at: Load a value from an internal pointer relative to a base object. 52 // * store: Store a value at an address. 53 // * store_at: Store a value in an internal pointer relative to a base object. 54 // * atomic_cmpxchg: Atomically compare-and-swap a new value at an address if previous value matched the compared value. 55 // * atomic_cmpxchg_at: Atomically compare-and-swap a new value at an internal pointer address if previous value matched the compared value. 56 // * atomic_xchg: Atomically swap a new value at an address if previous value matched the compared value. 57 // * atomic_xchg_at: Atomically swap a new value at an internal pointer address if previous value matched the compared value. 58 // * arraycopy: Copy data from one heap array to another heap array. The ArrayAccess class has convenience functions for this. 59 // * clone: Clone the contents of an object to a newly allocated object. 60 // * value_copy: Copy the contents of a value type from one heap address to another 61 // * resolve: Resolve a stable to-space invariant oop that is guaranteed not to relocate its payload until a subsequent thread transition. 62 // 63 // == IMPLEMENTATION == 64 // Each access goes through the following steps in a template pipeline. 65 // There are essentially 5 steps for each access: 66 // * Step 1: Set default decorators and decay types. This step gets rid of CV qualifiers 67 // and sets default decorators to sensible values. 68 // * Step 2: Reduce types. This step makes sure there is only a single T type and not 69 // multiple types. The P type of the address and T type of the value must 70 // match. 71 // * Step 3: Pre-runtime dispatch. This step checks whether a runtime call can be 72 // avoided, and in that case avoids it (calling raw accesses or 73 // primitive accesses in a build that does not require primitive GC barriers) 74 // * Step 4: Runtime-dispatch. This step performs a runtime dispatch to the corresponding 75 // BarrierSet::AccessBarrier accessor that attaches GC-required barriers 76 // to the access. 77 // * Step 5.a: Barrier resolution. This step is invoked the first time a runtime-dispatch 78 // happens for an access. The appropriate BarrierSet::AccessBarrier accessor 79 // is resolved, then the function pointer is updated to that accessor for 80 // future invocations. 81 // * Step 5.b: Post-runtime dispatch. This step now casts previously unknown types such 82 // as the address type of an oop on the heap (is it oop* or narrowOop*) to 83 // the appropriate type. It also splits sufficiently orthogonal accesses into 84 // different functions, such as whether the access involves oops or primitives 85 // and whether the access is performed on the heap or outside. Then the 86 // appropriate BarrierSet::AccessBarrier is called to perform the access. 87 // 88 // The implementation of step 1-4 resides in in accessBackend.hpp, to allow selected 89 // accesses to be accessible from only access.hpp, as opposed to access.inline.hpp. 90 // Steps 5.a and 5.b require knowledge about the GC backends, and therefore needs to 91 // include the various GC backend .inline.hpp headers. Their implementation resides in 92 // access.inline.hpp. The accesses that are allowed through the access.hpp file 93 // must be instantiated in access.cpp using the INSTANTIATE_HPP_ACCESS macro. 94 95 template <DecoratorSet decorators = DECORATORS_NONE> 96 class Access: public AllStatic { 97 // This function asserts that if an access gets passed in a decorator outside 98 // of the expected_decorators, then something is wrong. It additionally checks 99 // the consistency of the decorators so that supposedly disjoint decorators are indeed 100 // disjoint. For example, an access can not be both in heap and on root at the 101 // same time. 102 template <DecoratorSet expected_decorators> 103 static void verify_decorators(); 104 105 template <DecoratorSet expected_mo_decorators> 106 static void verify_primitive_decorators() { 107 const DecoratorSet primitive_decorators = (AS_DECORATOR_MASK ^ AS_NO_KEEPALIVE) | 108 IN_HEAP | IS_ARRAY; 109 verify_decorators<expected_mo_decorators | primitive_decorators>(); 110 } 111 112 template <DecoratorSet expected_mo_decorators> 113 static void verify_oop_decorators() { 114 const DecoratorSet oop_decorators = AS_DECORATOR_MASK | IN_DECORATOR_MASK | 115 (ON_DECORATOR_MASK ^ ON_UNKNOWN_OOP_REF) | // no unknown oop refs outside of the heap 116 IS_ARRAY | IS_NOT_NULL | IS_DEST_UNINITIALIZED; 117 verify_decorators<expected_mo_decorators | oop_decorators>(); 118 } 119 120 template <DecoratorSet expected_mo_decorators> 121 static void verify_heap_oop_decorators() { 122 const DecoratorSet heap_oop_decorators = AS_DECORATOR_MASK | ON_DECORATOR_MASK | 123 IN_HEAP | IS_ARRAY | IS_NOT_NULL; 124 verify_decorators<expected_mo_decorators | heap_oop_decorators>(); 125 } 126 127 template <DecoratorSet expected_mo_decorators> 128 static void verify_heap_value_decorators() { 129 const DecoratorSet heap_value_decorators = IN_HEAP | IS_DEST_UNINITIALIZED; 130 verify_decorators<expected_mo_decorators | heap_value_decorators>(); 131 } 132 133 static const DecoratorSet load_mo_decorators = MO_UNORDERED | MO_VOLATILE | MO_RELAXED | MO_ACQUIRE | MO_SEQ_CST; 134 static const DecoratorSet store_mo_decorators = MO_UNORDERED | MO_VOLATILE | MO_RELAXED | MO_RELEASE | MO_SEQ_CST; 135 static const DecoratorSet atomic_xchg_mo_decorators = MO_SEQ_CST; 136 static const DecoratorSet atomic_cmpxchg_mo_decorators = MO_RELAXED | MO_SEQ_CST; 137 138 protected: 139 template <typename T> 140 static inline void oop_arraycopy(arrayOop src_obj, size_t src_offset_in_bytes, const T* src_raw, 141 arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw, 142 size_t length) { 143 verify_decorators<ARRAYCOPY_DECORATOR_MASK | IN_HEAP | 144 AS_DECORATOR_MASK | IS_ARRAY | IS_DEST_UNINITIALIZED>(); 145 AccessInternal::arraycopy<decorators | INTERNAL_VALUE_IS_OOP>(src_obj, src_offset_in_bytes, src_raw, 146 dst_obj, dst_offset_in_bytes, dst_raw, 147 length); 148 } 149 150 template <typename T> 151 static inline void arraycopy(arrayOop src_obj, size_t src_offset_in_bytes, const T* src_raw, 152 arrayOop dst_obj, size_t dst_offset_in_bytes, T* dst_raw, 153 size_t length) { 154 verify_decorators<ARRAYCOPY_DECORATOR_MASK | IN_HEAP | 155 AS_DECORATOR_MASK | IS_ARRAY>(); 156 AccessInternal::arraycopy<decorators>(src_obj, src_offset_in_bytes, src_raw, 157 dst_obj, dst_offset_in_bytes, dst_raw, 158 length); 159 } 160 161 public: 162 // Primitive heap accesses 163 static inline AccessInternal::LoadAtProxy<decorators> load_at(oop base, ptrdiff_t offset) { 164 verify_primitive_decorators<load_mo_decorators>(); 165 return AccessInternal::LoadAtProxy<decorators>(base, offset); 166 } 167 168 template <typename T> 169 static inline void store_at(oop base, ptrdiff_t offset, T value) { 170 verify_primitive_decorators<store_mo_decorators>(); 171 AccessInternal::store_at<decorators>(base, offset, value); 172 } 173 174 template <typename T> 175 static inline T atomic_cmpxchg_at(T new_value, oop base, ptrdiff_t offset, T compare_value) { 176 verify_primitive_decorators<atomic_cmpxchg_mo_decorators>(); 177 return AccessInternal::atomic_cmpxchg_at<decorators>(new_value, base, offset, compare_value); 178 } 179 180 template <typename T> 181 static inline T atomic_xchg_at(T new_value, oop base, ptrdiff_t offset) { 182 verify_primitive_decorators<atomic_xchg_mo_decorators>(); 183 return AccessInternal::atomic_xchg_at<decorators>(new_value, base, offset); 184 } 185 186 // Oop heap accesses 187 static inline AccessInternal::OopLoadAtProxy<decorators> oop_load_at(oop base, ptrdiff_t offset) { 188 verify_heap_oop_decorators<load_mo_decorators>(); 189 return AccessInternal::OopLoadAtProxy<decorators>(base, offset); 190 } 191 192 template <typename T> 193 static inline void oop_store_at(oop base, ptrdiff_t offset, T value) { 194 verify_heap_oop_decorators<store_mo_decorators>(); 195 typedef typename AccessInternal::OopOrNarrowOop<T>::type OopType; 196 OopType oop_value = value; 197 AccessInternal::store_at<decorators | INTERNAL_VALUE_IS_OOP>(base, offset, oop_value); 198 } 199 200 template <typename T> 201 static inline T oop_atomic_cmpxchg_at(T new_value, oop base, ptrdiff_t offset, T compare_value) { 202 verify_heap_oop_decorators<atomic_cmpxchg_mo_decorators>(); 203 typedef typename AccessInternal::OopOrNarrowOop<T>::type OopType; 204 OopType new_oop_value = new_value; 205 OopType compare_oop_value = compare_value; 206 return AccessInternal::atomic_cmpxchg_at<decorators | INTERNAL_VALUE_IS_OOP>(new_oop_value, base, offset, compare_oop_value); 207 } 208 209 template <typename T> 210 static inline T oop_atomic_xchg_at(T new_value, oop base, ptrdiff_t offset) { 211 verify_heap_oop_decorators<atomic_xchg_mo_decorators>(); 212 typedef typename AccessInternal::OopOrNarrowOop<T>::type OopType; 213 OopType new_oop_value = new_value; 214 return AccessInternal::atomic_xchg_at<decorators | INTERNAL_VALUE_IS_OOP>(new_oop_value, base, offset); 215 } 216 217 // Clone an object from src to dst 218 static inline void clone(oop src, oop dst, size_t size) { 219 verify_decorators<IN_HEAP>(); 220 AccessInternal::clone<decorators>(src, dst, size); 221 } 222 223 // Value type inline heap access (flattened)... 224 225 // Copy value type data from src to dst 226 static inline void value_copy(void* src, void* dst, ValueKlass* md) { 227 verify_heap_value_decorators<IN_HEAP>(); 228 AccessInternal::value_copy<decorators>(src, dst, md); 229 } 230 231 // Primitive accesses 232 template <typename P> 233 static inline P load(P* addr) { 234 verify_primitive_decorators<load_mo_decorators>(); 235 return AccessInternal::load<decorators, P, P>(addr); 236 } 237 238 template <typename P, typename T> 239 static inline void store(P* addr, T value) { 240 verify_primitive_decorators<store_mo_decorators>(); 241 AccessInternal::store<decorators>(addr, value); 242 } 243 244 template <typename P, typename T> 245 static inline T atomic_cmpxchg(T new_value, P* addr, T compare_value) { 246 verify_primitive_decorators<atomic_cmpxchg_mo_decorators>(); 247 return AccessInternal::atomic_cmpxchg<decorators>(new_value, addr, compare_value); 248 } 249 250 template <typename P, typename T> 251 static inline T atomic_xchg(T new_value, P* addr) { 252 verify_primitive_decorators<atomic_xchg_mo_decorators>(); 253 return AccessInternal::atomic_xchg<decorators>(new_value, addr); 254 } 255 256 // Oop accesses 257 template <typename P> 258 static inline AccessInternal::OopLoadProxy<P, decorators> oop_load(P* addr) { 259 verify_oop_decorators<load_mo_decorators>(); 260 return AccessInternal::OopLoadProxy<P, decorators>(addr); 261 } 262 263 template <typename P, typename T> 264 static inline void oop_store(P* addr, T value) { 265 verify_oop_decorators<store_mo_decorators>(); 266 typedef typename AccessInternal::OopOrNarrowOop<T>::type OopType; 267 OopType oop_value = value; 268 AccessInternal::store<decorators | INTERNAL_VALUE_IS_OOP>(addr, oop_value); 269 } 270 271 template <typename P, typename T> 272 static inline T oop_atomic_cmpxchg(T new_value, P* addr, T compare_value) { 273 verify_oop_decorators<atomic_cmpxchg_mo_decorators>(); 274 typedef typename AccessInternal::OopOrNarrowOop<T>::type OopType; 275 OopType new_oop_value = new_value; 276 OopType compare_oop_value = compare_value; 277 return AccessInternal::atomic_cmpxchg<decorators | INTERNAL_VALUE_IS_OOP>(new_oop_value, addr, compare_oop_value); 278 } 279 280 template <typename P, typename T> 281 static inline T oop_atomic_xchg(T new_value, P* addr) { 282 verify_oop_decorators<atomic_xchg_mo_decorators>(); 283 typedef typename AccessInternal::OopOrNarrowOop<T>::type OopType; 284 OopType new_oop_value = new_value; 285 return AccessInternal::atomic_xchg<decorators | INTERNAL_VALUE_IS_OOP>(new_oop_value, addr); 286 } 287 288 static oop resolve(oop obj) { 289 verify_decorators<DECORATORS_NONE>(); 290 return AccessInternal::resolve<decorators>(obj); 291 } 292 }; 293 294 // Helper for performing raw accesses (knows only of memory ordering 295 // atomicity decorators as well as compressed oops) 296 template <DecoratorSet decorators = DECORATORS_NONE> 297 class RawAccess: public Access<AS_RAW | decorators> {}; 298 299 // Helper for performing normal accesses on the heap. These accesses 300 // may resolve an accessor on a GC barrier set 301 template <DecoratorSet decorators = DECORATORS_NONE> 302 class HeapAccess: public Access<IN_HEAP | decorators> {}; 303 304 // Helper for performing normal accesses in roots. These accesses 305 // may resolve an accessor on a GC barrier set 306 template <DecoratorSet decorators = DECORATORS_NONE> 307 class NativeAccess: public Access<IN_NATIVE | decorators> {}; 308 309 // Helper for array access. 310 template <DecoratorSet decorators = DECORATORS_NONE> 311 class ArrayAccess: public HeapAccess<IS_ARRAY | decorators> { 312 typedef HeapAccess<IS_ARRAY | decorators> AccessT; 313 public: 314 template <typename T> 315 static inline void arraycopy(arrayOop src_obj, size_t src_offset_in_bytes, 316 arrayOop dst_obj, size_t dst_offset_in_bytes, 317 size_t length) { 318 AccessT::arraycopy(src_obj, src_offset_in_bytes, reinterpret_cast<const T*>(NULL), 319 dst_obj, dst_offset_in_bytes, reinterpret_cast<T*>(NULL), 320 length); 321 } 322 323 template <typename T> 324 static inline void arraycopy_to_native(arrayOop src_obj, size_t src_offset_in_bytes, 325 T* dst, 326 size_t length) { 327 AccessT::arraycopy(src_obj, src_offset_in_bytes, reinterpret_cast<const T*>(NULL), 328 NULL, 0, dst, 329 length); 330 } 331 332 template <typename T> 333 static inline void arraycopy_from_native(const T* src, 334 arrayOop dst_obj, size_t dst_offset_in_bytes, 335 size_t length) { 336 AccessT::arraycopy(NULL, 0, src, 337 dst_obj, dst_offset_in_bytes, reinterpret_cast<T*>(NULL), 338 length); 339 } 340 341 static inline void oop_arraycopy(arrayOop src_obj, size_t src_offset_in_bytes, 342 arrayOop dst_obj, size_t dst_offset_in_bytes, 343 size_t length) { 344 AccessT::oop_arraycopy(src_obj, src_offset_in_bytes, reinterpret_cast<const HeapWord*>(NULL), 345 dst_obj, dst_offset_in_bytes, reinterpret_cast<HeapWord*>(NULL), 346 length); 347 } 348 349 template <typename T> 350 static inline void oop_arraycopy_raw(T* src, T* dst, size_t length) { 351 AccessT::oop_arraycopy(NULL, 0, src, 352 NULL, 0, dst, 353 length); 354 } 355 356 }; 357 358 template <DecoratorSet decorators> 359 template <DecoratorSet expected_decorators> 360 void Access<decorators>::verify_decorators() { 361 STATIC_ASSERT((~expected_decorators & decorators) == 0); // unexpected decorator used 362 const DecoratorSet barrier_strength_decorators = decorators & AS_DECORATOR_MASK; 363 STATIC_ASSERT(barrier_strength_decorators == 0 || ( // make sure barrier strength decorators are disjoint if set 364 (barrier_strength_decorators ^ AS_NO_KEEPALIVE) == 0 || 365 (barrier_strength_decorators ^ AS_RAW) == 0 || 366 (barrier_strength_decorators ^ AS_NORMAL) == 0 367 )); 368 const DecoratorSet ref_strength_decorators = decorators & ON_DECORATOR_MASK; 369 STATIC_ASSERT(ref_strength_decorators == 0 || ( // make sure ref strength decorators are disjoint if set 370 (ref_strength_decorators ^ ON_STRONG_OOP_REF) == 0 || 371 (ref_strength_decorators ^ ON_WEAK_OOP_REF) == 0 || 372 (ref_strength_decorators ^ ON_PHANTOM_OOP_REF) == 0 || 373 (ref_strength_decorators ^ ON_UNKNOWN_OOP_REF) == 0 374 )); 375 const DecoratorSet memory_ordering_decorators = decorators & MO_DECORATOR_MASK; 376 STATIC_ASSERT(memory_ordering_decorators == 0 || ( // make sure memory ordering decorators are disjoint if set 377 (memory_ordering_decorators ^ MO_UNORDERED) == 0 || 378 (memory_ordering_decorators ^ MO_VOLATILE) == 0 || 379 (memory_ordering_decorators ^ MO_RELAXED) == 0 || 380 (memory_ordering_decorators ^ MO_ACQUIRE) == 0 || 381 (memory_ordering_decorators ^ MO_RELEASE) == 0 || 382 (memory_ordering_decorators ^ MO_SEQ_CST) == 0 383 )); 384 const DecoratorSet location_decorators = decorators & IN_DECORATOR_MASK; 385 STATIC_ASSERT(location_decorators == 0 || ( // make sure location decorators are disjoint if set 386 (location_decorators ^ IN_NATIVE) == 0 || 387 (location_decorators ^ IN_HEAP) == 0 388 )); 389 } 390 391 #endif // SHARE_OOPS_ACCESS_HPP