< prev index next >

src/hotspot/share/oops/oop.hpp

Print this page

 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_OOP_HPP
 26 #define SHARE_OOPS_OOP_HPP
 27 
 28 #include "memory/iterator.hpp"
 29 #include "memory/memRegion.hpp"
 30 #include "oops/accessDecorators.hpp"

 31 #include "oops/markWord.hpp"
 32 #include "oops/metadata.hpp"
 33 #include "runtime/atomic.hpp"
 34 #include "utilities/globalDefinitions.hpp"
 35 #include "utilities/macros.hpp"
 36 #include <type_traits>
 37 
 38 // oopDesc is the top baseclass for objects classes. The {name}Desc classes describe
 39 // the format of Java objects so the fields can be accessed from C++.
 40 // oopDesc is abstract.
 41 // (see oopHierarchy for complete oop class hierarchy)
 42 //
 43 // no virtual functions allowed
 44 
 45 // Forward declarations.
 46 class OopClosure;
 47 class FilteringClosure;
 48 
 49 class PSPromotionManager;
 50 class ParCompactionManager;
 51 
 52 class oopDesc {
 53   friend class VMStructs;
 54   friend class JVMCIVMStructs;
 55  private:
 56   volatile markWord _mark;
 57   union _metadata {
 58     Klass*      _klass;
 59     narrowKlass _compressed_klass;
 60   } _metadata;
 61 
 62   // There may be ordering constraints on the initialization of fields that
 63   // make use of the C++ copy/assign incorrect.
 64   NONCOPYABLE(oopDesc);
 65 
 66  public:
 67   // Must be trivial; see verifying static assert after the class.
 68   oopDesc() = default;
 69 
 70   inline markWord  mark()          const;
 71   inline markWord  mark_acquire()  const;
 72   inline markWord* mark_addr() const;
 73 
 74   inline void set_mark(markWord m);
 75   static inline void set_mark(HeapWord* mem, markWord m);
 76 
 77   inline void release_set_mark(markWord m);

 78   inline markWord cas_set_mark(markWord new_mark, markWord old_mark);
 79   inline markWord cas_set_mark(markWord new_mark, markWord old_mark, atomic_memory_order order);
 80 
 81   // Used only to re-initialize the mark word (e.g., of promoted
 82   // objects during a GC) -- requires a valid klass pointer
 83   inline void init_mark();
 84 
 85   inline Klass* klass() const;
 86   inline Klass* klass_or_null() const;
 87   inline Klass* klass_or_null_acquire() const;
 88 
 89   void set_narrow_klass(narrowKlass nk) NOT_CDS_JAVA_HEAP_RETURN;
 90   inline void set_klass(Klass* k);
 91   static inline void release_set_klass(HeapWord* mem, Klass* k);
 92 
 93   // For klass field compression
 94   static inline void set_klass_gap(HeapWord* mem, int z);
 95 
 96   // size of object header, aligned to platform wordSize
 97   static constexpr int header_size() { return sizeof(oopDesc)/HeapWordSize; }
 98 
 99   // Returns whether this is an instance of k or an instance of a subclass of k
100   inline bool is_a(Klass* k) const;
101 
102   // Returns the actual oop size of the object
103   inline size_t size();
104 
105   // Sometimes (for complicated concurrency-related reasons), it is useful
106   // to be able to figure out the size of an object knowing its klass.
107   inline size_t size_given_klass(Klass* klass);
108 
109   // type test operations (inlined in oop.inline.hpp)
110   inline bool is_instance()    const;
111   inline bool is_instanceRef() const;
112   inline bool is_array()       const;
113   inline bool is_objArray()    const;
114   inline bool is_typeArray()   const;

235   static void verify_on(outputStream* st, oopDesc* oop_desc);
236   static void verify(oopDesc* oopDesc);
237 
238   // locking operations
239   inline bool is_locked()   const;
240   inline bool is_unlocked() const;
241 
242   // asserts and guarantees
243   static bool is_oop(oop obj, bool ignore_mark_word = false);
244   static bool is_oop_or_null(oop obj, bool ignore_mark_word = false);
245 
246   // garbage collection
247   inline bool is_gc_marked() const;
248 
249   // Forward pointer operations for scavenge
250   inline bool is_forwarded() const;
251 
252   void verify_forwardee(oop forwardee) NOT_DEBUG_RETURN;
253 
254   inline void forward_to(oop p);

255 
256   // Like "forward_to", but inserts the forwarding pointer atomically.
257   // Exactly one thread succeeds in inserting the forwarding pointer, and
258   // this call returns "NULL" for that thread; any other thread has the
259   // value of the forwarding pointer returned and does not modify "this".
260   inline oop forward_to_atomic(oop p, markWord compare, atomic_memory_order order = memory_order_conservative);

261 
262   inline oop forwardee() const;

263 
264   // Age of object during scavenge
265   inline uint age() const;
266   inline void incr_age();
267 
268   template <typename OopClosureType>
269   inline void oop_iterate(OopClosureType* cl);
270 
271   template <typename OopClosureType>
272   inline void oop_iterate(OopClosureType* cl, MemRegion mr);
273 
274   template <typename OopClosureType>
275   inline size_t oop_iterate_size(OopClosureType* cl);
276 
277   template <typename OopClosureType>
278   inline size_t oop_iterate_size(OopClosureType* cl, MemRegion mr);
279 
280   template <typename OopClosureType>
281   inline void oop_iterate_backwards(OopClosureType* cl);
282 
283   template <typename OopClosureType>
284   inline void oop_iterate_backwards(OopClosureType* cl, Klass* klass);
285 
286   inline static bool is_instanceof_or_null(oop obj, Klass* klass);
287 
288   // identity hash; returns the identity hash key (computes it if necessary)
289   inline intptr_t identity_hash();
290   intptr_t slow_identity_hash();
291 
292   // marks are forwarded to stack when object is locked
293   inline bool     has_displaced_mark() const;
294   inline markWord displaced_mark() const;
295   inline void     set_displaced_mark(markWord m);
296 
297   // Checks if the mark word needs to be preserved
298   inline bool mark_must_be_preserved() const;
299   inline bool mark_must_be_preserved(markWord m) const;
300 
301   static bool has_klass_gap();
302 
303   // for code generation
304   static int mark_offset_in_bytes()      { return offset_of(oopDesc, _mark); }
305   static int klass_offset_in_bytes()     { return offset_of(oopDesc, _metadata._klass); }
306   static int klass_gap_offset_in_bytes() {
307     assert(has_klass_gap(), "only applicable to compressed klass pointers");
308     return klass_offset_in_bytes() + sizeof(narrowKlass);



309   }
310 
311   // for error reporting
312   static void* load_klass_raw(oop obj);
313   static void* load_oop_raw(oop obj, int offset);
314 





315   // Avoid include gc_globals.hpp in oop.inline.hpp
316   DEBUG_ONLY(bool get_UseParallelGC();)
317   DEBUG_ONLY(bool get_UseG1GC();)
318 };
319 
320 // An oopDesc is not initialized via a constructor.  Space is allocated in
321 // the Java heap, and static functions provided here on HeapWord* are used
322 // to fill in certain parts of that memory.  The allocated memory is then
323 // treated as referring to an oopDesc.  For that to be valid, the oopDesc
324 // class must have a trivial default constructor (C++14 3.8/1).
325 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
326 
327 #endif // SHARE_OOPS_OOP_HPP

 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_OOP_HPP
 26 #define SHARE_OOPS_OOP_HPP
 27 
 28 #include "memory/iterator.hpp"
 29 #include "memory/memRegion.hpp"
 30 #include "oops/accessDecorators.hpp"
 31 #include "oops/compressedKlass.hpp"
 32 #include "oops/markWord.hpp"
 33 #include "oops/metadata.hpp"
 34 #include "runtime/atomic.hpp"
 35 #include "utilities/globalDefinitions.hpp"
 36 #include "utilities/macros.hpp"
 37 #include <type_traits>
 38 
 39 // oopDesc is the top baseclass for objects classes. The {name}Desc classes describe
 40 // the format of Java objects so the fields can be accessed from C++.
 41 // oopDesc is abstract.
 42 // (see oopHierarchy for complete oop class hierarchy)
 43 //
 44 // no virtual functions allowed
 45 
 46 // Forward declarations.
 47 class OopClosure;
 48 class FilteringClosure;
 49 
 50 class PSPromotionManager;
 51 class ParCompactionManager;
 52 
 53 class oopDesc {
 54   friend class VMStructs;
 55   friend class JVMCIVMStructs;
 56  private:
 57   volatile markWord _mark;
 58 #ifndef _LP64
 59   Klass*            _klass;
 60 #endif

 61 
 62   // There may be ordering constraints on the initialization of fields that
 63   // make use of the C++ copy/assign incorrect.
 64   NONCOPYABLE(oopDesc);
 65 
 66  public:
 67   // Must be trivial; see verifying static assert after the class.
 68   oopDesc() = default;
 69 
 70   inline markWord  mark()          const;
 71   inline markWord  mark_acquire()  const;
 72   inline markWord* mark_addr() const;
 73 
 74   inline void set_mark(markWord m);
 75   static inline void set_mark(HeapWord* mem, markWord m);
 76 
 77   inline void release_set_mark(markWord m);
 78   static inline void release_set_mark(HeapWord* mem, markWord m);
 79   inline markWord cas_set_mark(markWord new_mark, markWord old_mark);
 80   inline markWord cas_set_mark(markWord new_mark, markWord old_mark, atomic_memory_order order);
 81 
 82   // Used only to re-initialize the mark word (e.g., of promoted
 83   // objects during a GC) -- requires a valid klass pointer
 84   inline void init_mark();
 85 
 86   inline Klass* klass() const;
 87   inline Klass* klass_or_null() const;
 88   inline Klass* klass_or_null_acquire() const;
 89 
 90 #ifndef _LP64
 91   inline void set_klass(Klass* k);
 92   static inline void release_set_klass(HeapWord* mem, Klass* k);
 93 #endif


 94 
 95   // size of object header, aligned to platform wordSize
 96   static constexpr int header_size() { return sizeof(oopDesc)/HeapWordSize; }
 97 
 98   // Returns whether this is an instance of k or an instance of a subclass of k
 99   inline bool is_a(Klass* k) const;
100 
101   // Returns the actual oop size of the object
102   inline size_t size();
103 
104   // Sometimes (for complicated concurrency-related reasons), it is useful
105   // to be able to figure out the size of an object knowing its klass.
106   inline size_t size_given_klass(Klass* klass);
107 
108   // type test operations (inlined in oop.inline.hpp)
109   inline bool is_instance()    const;
110   inline bool is_instanceRef() const;
111   inline bool is_array()       const;
112   inline bool is_objArray()    const;
113   inline bool is_typeArray()   const;

234   static void verify_on(outputStream* st, oopDesc* oop_desc);
235   static void verify(oopDesc* oopDesc);
236 
237   // locking operations
238   inline bool is_locked()   const;
239   inline bool is_unlocked() const;
240 
241   // asserts and guarantees
242   static bool is_oop(oop obj, bool ignore_mark_word = false);
243   static bool is_oop_or_null(oop obj, bool ignore_mark_word = false);
244 
245   // garbage collection
246   inline bool is_gc_marked() const;
247 
248   // Forward pointer operations for scavenge
249   inline bool is_forwarded() const;
250 
251   void verify_forwardee(oop forwardee) NOT_DEBUG_RETURN;
252 
253   inline void forward_to(oop p);
254   inline void forward_to_self();
255 
256   // Like "forward_to", but inserts the forwarding pointer atomically.
257   // Exactly one thread succeeds in inserting the forwarding pointer, and
258   // this call returns "NULL" for that thread; any other thread has the
259   // value of the forwarding pointer returned and does not modify "this".
260   inline oop forward_to_atomic(oop p, markWord compare, atomic_memory_order order = memory_order_conservative);
261   inline oop forward_to_self_atomic(markWord compare, atomic_memory_order order = memory_order_conservative);
262 
263   inline oop forwardee() const;
264   inline oop forwardee(markWord header) const;
265 
266   // Age of object during scavenge
267   inline uint age() const;
268   inline void incr_age();
269 
270   template <typename OopClosureType>
271   inline void oop_iterate(OopClosureType* cl);
272 
273   template <typename OopClosureType>
274   inline void oop_iterate(OopClosureType* cl, MemRegion mr);
275 
276   template <typename OopClosureType>
277   inline size_t oop_iterate_size(OopClosureType* cl);
278 
279   template <typename OopClosureType>
280   inline size_t oop_iterate_size(OopClosureType* cl, MemRegion mr);
281 
282   template <typename OopClosureType>
283   inline void oop_iterate_backwards(OopClosureType* cl);
284 
285   template <typename OopClosureType>
286   inline void oop_iterate_backwards(OopClosureType* cl, Klass* klass);
287 
288   inline static bool is_instanceof_or_null(oop obj, Klass* klass);
289 
290   // identity hash; returns the identity hash key (computes it if necessary)
291   inline intptr_t identity_hash();
292   intptr_t slow_identity_hash();
293 
294   // marks are forwarded to stack when object is locked
295   inline bool     has_displaced_mark() const;
296   inline markWord displaced_mark() const;
297   inline void     set_displaced_mark(markWord m);
298 
299   // Checks if the mark word needs to be preserved
300   inline bool mark_must_be_preserved() const;
301   inline bool mark_must_be_preserved(markWord m) const;
302 


303   // for code generation
304   static int mark_offset_in_bytes()      { return offset_of(oopDesc, _mark); }
305   static int klass_offset_in_bytes()     {
306 #ifdef _LP64
307     STATIC_ASSERT(markWord::klass_shift % 8 == 0);
308     return mark_offset_in_bytes() + markWord::klass_shift / 8;
309 #else
310     return offset_of(oopDesc, _klass);
311 #endif
312   }
313 
314   // for error reporting
315   static void* load_klass_raw(oop obj);
316   static void* load_oop_raw(oop obj, int offset);
317 
318   // Runtime entry
319 #ifdef _LP64
320   static narrowKlass load_nklass_runtime(oopDesc* o);
321 #endif
322 
323   // Avoid include gc_globals.hpp in oop.inline.hpp
324   DEBUG_ONLY(bool get_UseParallelGC();)
325   DEBUG_ONLY(bool get_UseG1GC();)
326 };
327 
328 // An oopDesc is not initialized via a constructor.  Space is allocated in
329 // the Java heap, and static functions provided here on HeapWord* are used
330 // to fill in certain parts of that memory.  The allocated memory is then
331 // treated as referring to an oopDesc.  For that to be valid, the oopDesc
332 // class must have a trivial default constructor (C++14 3.8/1).
333 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
334 
335 #endif // SHARE_OOPS_OOP_HPP
< prev index next >