< prev index next >

src/hotspot/share/oops/oop.hpp

Print this page

 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   static inline void release_set_mark(HeapWord* mem, markWord m);
 77 
 78   inline void release_set_mark(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   // Get the raw value without any checks.
 90   inline Klass* klass_raw() const;
 91 
 92   void set_narrow_klass(narrowKlass nk) NOT_CDS_JAVA_HEAP_RETURN;
 93   inline void set_klass(Klass* k);
 94   static inline void release_set_klass(HeapWord* mem, Klass* k);
 95 
 96   // For klass field compression
 97   static inline void set_klass_gap(HeapWord* mem, int z);
 98 
 99   // size of object header, aligned to platform wordSize
100   static constexpr int header_size() { return sizeof(oopDesc)/HeapWordSize; }






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














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

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

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

270 
271   inline oop forwardee() const;

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

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










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

318     return klass_offset_in_bytes() + sizeof(narrowKlass);
319   }
320 
















321   // for error reporting
322   static void* load_klass_raw(oop obj);
323   static void* load_oop_raw(oop obj, int offset);
324 
325   DEBUG_ONLY(bool size_might_change();)
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

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

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

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