< prev index next >

src/hotspot/share/oops/oop.hpp

Print this page

 61   // There may be ordering constraints on the initialization of fields that
 62   // make use of the C++ copy/assign incorrect.
 63   NONCOPYABLE(oopDesc);
 64 
 65  public:
 66   // Must be trivial; see verifying static assert after the class.
 67   oopDesc() = default;
 68 
 69   inline markWord  mark()          const;
 70   inline markWord  mark_acquire()  const;
 71   inline markWord* mark_addr() const;
 72 
 73   inline void set_mark(markWord m);
 74   static inline void set_mark(HeapWord* mem, markWord m);
 75   static inline void release_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   // Get the raw value without any checks.
 89   inline Klass* klass_raw() const;
 90 
 91   void set_narrow_klass(narrowKlass nk) NOT_CDS_JAVA_HEAP_RETURN;
 92   inline void set_klass(Klass* k);
 93   static inline void release_set_klass(HeapWord* mem, Klass* k);
 94 
 95   // For klass field compression
 96   static inline void set_klass_gap(HeapWord* mem, int z);
 97 
 98   // size of object header, aligned to platform wordSize
 99   static constexpr int header_size() { return sizeof(oopDesc)/HeapWordSize; }






100 
101   // Returns whether this is an instance of k or an instance of a subclass of k
102   inline bool is_a(Klass* k) const;
103 
104   // Returns the actual oop size of the object in machine words
105   inline size_t size();
106 
107   // Sometimes (for complicated concurrency-related reasons), it is useful
108   // to be able to figure out the size of an object knowing its klass.
109   inline size_t size_given_klass(Klass* klass);
110 














111   // type test operations (inlined in oop.inline.hpp)
112   inline bool is_instance()    const;
113   inline bool is_instanceRef() const;
114   inline bool is_stackChunk()  const;
115   inline bool is_array()       const;
116   inline bool is_objArray()    const;
117   inline bool is_typeArray()   const;
118 
119   // type test operations that don't require inclusion of oop.inline.hpp.
120   bool is_instance_noinline()    const;
121   bool is_instanceRef_noinline() const;
122   bool is_stackChunk_noinline()  const;
123   bool is_array_noinline()       const;
124   bool is_objArray_noinline()    const;
125   bool is_typeArray_noinline()   const;
126 
127  protected:
128   inline oop        as_oop() const { return const_cast<oopDesc*>(this); }
129 
130  public:

241 
242   // verification operations
243   static void verify_on(outputStream* st, oopDesc* oop_desc);
244   static void verify(oopDesc* oopDesc);
245 
246   // locking operations
247   inline bool is_locked()   const;
248   inline bool is_unlocked() const;
249 
250   // asserts and guarantees
251   static bool is_oop(oop obj, bool ignore_mark_word = false);
252   static bool is_oop_or_null(oop obj, bool ignore_mark_word = false);
253 
254   // garbage collection
255   inline bool is_gc_marked() const;
256 
257   // Forward pointer operations for scavenge
258   inline bool is_forwarded() const;
259 
260   inline void forward_to(oop p);

261 
262   // Like "forward_to", but inserts the forwarding pointer atomically.
263   // Exactly one thread succeeds in inserting the forwarding pointer, and
264   // this call returns null for that thread; any other thread has the
265   // value of the forwarding pointer returned and does not modify "this".
266   inline oop forward_to_atomic(oop p, markWord compare, atomic_memory_order order = memory_order_conservative);

267 
268   inline oop forwardee() const;

269 
270   // Age of object during scavenge
271   inline uint age() const;
272   inline void incr_age();
273 
274   template <typename OopClosureType>
275   inline void oop_iterate(OopClosureType* cl);
276 
277   template <typename OopClosureType>
278   inline void oop_iterate(OopClosureType* cl, MemRegion mr);
279 
280   template <typename OopClosureType>
281   inline size_t oop_iterate_size(OopClosureType* cl);
282 
283   template <typename OopClosureType>
284   inline size_t oop_iterate_size(OopClosureType* cl, MemRegion mr);
285 
286   template <typename OopClosureType>
287   inline void oop_iterate_backwards(OopClosureType* cl);
288 

292   inline static bool is_instanceof_or_null(oop obj, Klass* klass);
293 
294   // identity hash; returns the identity hash key (computes it if necessary)
295   inline intptr_t identity_hash();
296   intptr_t slow_identity_hash();
297   inline bool fast_no_hash_check();
298 
299   // marks are forwarded to stack when object is locked
300   inline bool     has_displaced_mark() const;
301   inline markWord displaced_mark() const;
302   inline void     set_displaced_mark(markWord m);
303 
304   // Checks if the mark word needs to be preserved
305   inline bool mark_must_be_preserved() const;
306   inline bool mark_must_be_preserved(markWord m) const;
307 
308   static bool has_klass_gap();
309 
310   // for code generation
311   static int mark_offset_in_bytes()      { return (int)offset_of(oopDesc, _mark); }
312   static int klass_offset_in_bytes()     { return (int)offset_of(oopDesc, _metadata._klass); }










313   static int klass_gap_offset_in_bytes() {
314     assert(has_klass_gap(), "only applicable to compressed klass pointers");

315     return klass_offset_in_bytes() + sizeof(narrowKlass);
316   }
317 
















318   // for error reporting
319   static void* load_klass_raw(oop obj);
320   static void* load_oop_raw(oop obj, int offset);
321 
322   DEBUG_ONLY(bool size_might_change();)
323 };
324 
325 // An oopDesc is not initialized via a constructor.  Space is allocated in
326 // the Java heap, and static functions provided here on HeapWord* are used
327 // to fill in certain parts of that memory.  The allocated memory is then
328 // treated as referring to an oopDesc.  For that to be valid, the oopDesc
329 // class must have a trivial default constructor (C++14 3.8/1).
330 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
331 
332 #endif // SHARE_OOPS_OOP_HPP

 61   // There may be ordering constraints on the initialization of fields that
 62   // make use of the C++ copy/assign incorrect.
 63   NONCOPYABLE(oopDesc);
 64 
 65  public:
 66   // Must be trivial; see verifying static assert after the class.
 67   oopDesc() = default;
 68 
 69   inline markWord  mark()          const;
 70   inline markWord  mark_acquire()  const;
 71   inline markWord* mark_addr() const;
 72 
 73   inline void set_mark(markWord m);
 74   static inline void set_mark(HeapWord* mem, markWord m);
 75   static inline void release_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   inline markWord resolve_mark() const;
 82 
 83   // Returns the prototype mark that should be used for this object.
 84   inline markWord prototype_mark() const;
 85 
 86   // Used only to re-initialize the mark word (e.g., of promoted
 87   // objects during a GC) -- requires a valid klass pointer
 88   inline void init_mark();
 89 
 90   inline Klass* klass() const;
 91   inline Klass* klass_or_null() const;
 92   inline Klass* klass_or_null_acquire() const;
 93   // Get the raw value without any checks.
 94   inline Klass* klass_raw() const;
 95 
 96   void set_narrow_klass(narrowKlass nk) NOT_CDS_JAVA_HEAP_RETURN;
 97   inline void set_klass(Klass* k);
 98   static inline void release_set_klass(HeapWord* mem, Klass* k);
 99 
100   // For klass field compression
101   static inline void set_klass_gap(HeapWord* mem, int z);
102 
103   // size of object header, aligned to platform wordSize
104   static int header_size() {
105     if (UseCompactObjectHeaders) {
106       return sizeof(markWord) / HeapWordSize;
107     } else {
108       return sizeof(oopDesc)/HeapWordSize;
109     }
110   }
111 
112   // Returns whether this is an instance of k or an instance of a subclass of k
113   inline bool is_a(Klass* k) const;
114 
115   // Returns the actual oop size of the object in machine words
116   inline size_t size();
117 
118   // Sometimes (for complicated concurrency-related reasons), it is useful
119   // to be able to figure out the size of an object knowing its klass.
120   inline size_t size_given_klass(Klass* klass);
121 
122   // The following set of methods is used to access the mark-word and related
123   // properties when the object may be forwarded. Be careful where and when
124   // using this method. It assumes that the forwardee is installed in
125   // the header as a plain pointer (or self-forwarded). In particular,
126   // those methods can not deal with the sliding-forwarding that is used
127   // in Serial, G1 and Shenandoah full-GCs.
128 private:
129   inline Klass*   forward_safe_klass_impl(markWord m) const;
130 public:
131   inline Klass*   forward_safe_klass() const;
132   inline Klass*   forward_safe_klass(markWord m) const;
133   inline size_t   forward_safe_size();
134   inline void     forward_safe_init_mark();
135 
136   // type test operations (inlined in oop.inline.hpp)
137   inline bool is_instance()    const;
138   inline bool is_instanceRef() const;
139   inline bool is_stackChunk()  const;
140   inline bool is_array()       const;
141   inline bool is_objArray()    const;
142   inline bool is_typeArray()   const;
143 
144   // type test operations that don't require inclusion of oop.inline.hpp.
145   bool is_instance_noinline()    const;
146   bool is_instanceRef_noinline() const;
147   bool is_stackChunk_noinline()  const;
148   bool is_array_noinline()       const;
149   bool is_objArray_noinline()    const;
150   bool is_typeArray_noinline()   const;
151 
152  protected:
153   inline oop        as_oop() const { return const_cast<oopDesc*>(this); }
154 
155  public:

266 
267   // verification operations
268   static void verify_on(outputStream* st, oopDesc* oop_desc);
269   static void verify(oopDesc* oopDesc);
270 
271   // locking operations
272   inline bool is_locked()   const;
273   inline bool is_unlocked() const;
274 
275   // asserts and guarantees
276   static bool is_oop(oop obj, bool ignore_mark_word = false);
277   static bool is_oop_or_null(oop obj, bool ignore_mark_word = false);
278 
279   // garbage collection
280   inline bool is_gc_marked() const;
281 
282   // Forward pointer operations for scavenge
283   inline bool is_forwarded() const;
284 
285   inline void forward_to(oop p);
286   inline void forward_to_self();
287 
288   // Like "forward_to", but inserts the forwarding pointer atomically.
289   // Exactly one thread succeeds in inserting the forwarding pointer, and
290   // this call returns null for that thread; any other thread has the
291   // value of the forwarding pointer returned and does not modify "this".
292   inline oop forward_to_atomic(oop p, markWord compare, atomic_memory_order order = memory_order_conservative);
293   inline oop forward_to_self_atomic(markWord compare, atomic_memory_order order = memory_order_conservative);
294 
295   inline oop forwardee() const;
296   inline oop forwardee(markWord header) const;
297 
298   // Age of object during scavenge
299   inline uint age() const;
300   inline void incr_age();
301 
302   template <typename OopClosureType>
303   inline void oop_iterate(OopClosureType* cl);
304 
305   template <typename OopClosureType>
306   inline void oop_iterate(OopClosureType* cl, MemRegion mr);
307 
308   template <typename OopClosureType>
309   inline size_t oop_iterate_size(OopClosureType* cl);
310 
311   template <typename OopClosureType>
312   inline size_t oop_iterate_size(OopClosureType* cl, MemRegion mr);
313 
314   template <typename OopClosureType>
315   inline void oop_iterate_backwards(OopClosureType* cl);
316 

320   inline static bool is_instanceof_or_null(oop obj, Klass* klass);
321 
322   // identity hash; returns the identity hash key (computes it if necessary)
323   inline intptr_t identity_hash();
324   intptr_t slow_identity_hash();
325   inline bool fast_no_hash_check();
326 
327   // marks are forwarded to stack when object is locked
328   inline bool     has_displaced_mark() const;
329   inline markWord displaced_mark() const;
330   inline void     set_displaced_mark(markWord m);
331 
332   // Checks if the mark word needs to be preserved
333   inline bool mark_must_be_preserved() const;
334   inline bool mark_must_be_preserved(markWord m) const;
335 
336   static bool has_klass_gap();
337 
338   // for code generation
339   static int mark_offset_in_bytes()      { return (int)offset_of(oopDesc, _mark); }
340   static int klass_offset_in_bytes()     {
341 #ifdef _LP64
342     if (UseCompactObjectHeaders) {
343       STATIC_ASSERT(markWord::klass_shift % 8 == 0);
344       return mark_offset_in_bytes() + markWord::klass_shift / 8;
345     } else
346 #endif
347     {
348       return (int)offset_of(oopDesc, _metadata._klass);
349     }
350   }
351   static int klass_gap_offset_in_bytes() {
352     assert(has_klass_gap(), "only applicable to compressed klass pointers");
353     assert(!UseCompactObjectHeaders, "don't use klass_offset_in_bytes() with compact headers");
354     return klass_offset_in_bytes() + sizeof(narrowKlass);
355   }
356 
357   static int base_offset_in_bytes() {
358 #ifdef _LP64
359     if (UseCompactObjectHeaders) {
360       // With compact headers, the Klass* field is not used for the Klass*
361       // and is used for the object fields instead.
362       assert(sizeof(markWord) == 8, "sanity");
363       return sizeof(markWord);
364     } else if (UseCompressedClassPointers) {
365       return sizeof(markWord) + sizeof(narrowKlass);
366     } else
367 #endif
368     {
369       return sizeof(oopDesc);
370     }
371   }
372 
373   // for error reporting
374   static void* load_klass_raw(oop obj);
375   static void* load_oop_raw(oop obj, int offset);
376 
377   DEBUG_ONLY(bool size_might_change();)
378 };
379 
380 // An oopDesc is not initialized via a constructor.  Space is allocated in
381 // the Java heap, and static functions provided here on HeapWord* are used
382 // to fill in certain parts of that memory.  The allocated memory is then
383 // treated as referring to an oopDesc.  For that to be valid, the oopDesc
384 // class must have a trivial default constructor (C++14 3.8/1).
385 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
386 
387 #endif // SHARE_OOPS_OOP_HPP
< prev index next >