45
46 // Forward declarations.
47 class OopClosure;
48 class PSPromotionManager;
49 class ParCompactionManager;
50
51 class oopDesc {
52 friend class VMStructs;
53 friend class JVMCIVMStructs;
54 private:
55 volatile markWord _mark;
56 union _metadata {
57 Klass* _klass;
58 narrowKlass _compressed_klass;
59 } _metadata;
60
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 klass without running any asserts.
89 inline Klass* klass_without_asserts() 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:
239 char* print_string();
240 char* print_value_string();
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_oop_raw(oop obj, int offset);
320
321 DEBUG_ONLY(bool size_might_change();)
322 };
323
324 // An oopDesc is not initialized via a constructor. Space is allocated in
325 // the Java heap, and static functions provided here on HeapWord* are used
326 // to fill in certain parts of that memory. The allocated memory is then
327 // treated as referring to an oopDesc. For that to be valid, the oopDesc
328 // class must have a trivial default constructor (C++14 3.8/1).
329 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
330
331 #endif // SHARE_OOPS_OOP_HPP
|
45
46 // Forward declarations.
47 class OopClosure;
48 class PSPromotionManager;
49 class ParCompactionManager;
50
51 class oopDesc {
52 friend class VMStructs;
53 friend class JVMCIVMStructs;
54 private:
55 volatile markWord _mark;
56 union _metadata {
57 Klass* _klass;
58 narrowKlass _compressed_klass;
59 } _metadata;
60
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 inline oop cas_set_forwardee(markWord new_mark, markWord old_mark, atomic_memory_order order);
66
67 public:
68 // Must be trivial; see verifying static assert after the class.
69 oopDesc() = default;
70
71 inline markWord mark() const;
72 inline markWord mark_acquire() const;
73 inline markWord* mark_addr() const;
74
75 inline void set_mark(markWord m);
76 static inline void set_mark(HeapWord* mem, markWord m);
77 static inline void release_set_mark(HeapWord* mem, markWord m);
78
79 inline void release_set_mark(markWord m);
80 inline markWord cas_set_mark(markWord new_mark, markWord old_mark);
81 inline markWord cas_set_mark(markWord new_mark, markWord old_mark, atomic_memory_order order);
82
83 inline markWord resolve_mark() const;
84
85 // Returns the prototype mark that should be used for this object.
86 inline markWord prototype_mark() const;
87
88 // Used only to re-initialize the mark word (e.g., of promoted
89 // objects during a GC) -- requires a valid klass pointer
90 inline void init_mark();
91
92 inline Klass* klass() const;
93 inline Klass* klass_or_null() const;
94 inline Klass* klass_or_null_acquire() const;
95 // Get the klass without running any asserts.
96 inline Klass* klass_without_asserts() const;
97
98 void set_narrow_klass(narrowKlass nk) NOT_CDS_JAVA_HEAP_RETURN;
99 inline void set_klass(Klass* k);
100 static inline void release_set_klass(HeapWord* mem, Klass* k);
101
102 // For klass field compression
103 static inline void set_klass_gap(HeapWord* mem, int z);
104
105 // size of object header, aligned to platform wordSize
106 static int header_size() {
107 if (UseCompactObjectHeaders) {
108 return sizeof(markWord) / HeapWordSize;
109 } else {
110 return sizeof(oopDesc)/HeapWordSize;
111 }
112 }
113
114 // Returns whether this is an instance of k or an instance of a subclass of k
115 inline bool is_a(Klass* k) const;
116
117 // Returns the actual oop size of the object in machine words
118 inline size_t size();
119
120 // Sometimes (for complicated concurrency-related reasons), it is useful
121 // to be able to figure out the size of an object knowing its klass.
122 inline size_t size_given_klass(Klass* klass);
123
124 // The following set of methods is used to access the mark-word and related
125 // properties when the object may be forwarded. Be careful where and when
126 // using this method. It assumes that the forwardee is installed in
127 // the header as a plain pointer (or self-forwarded). In particular,
128 // those methods can not deal with the sliding-forwarding that is used
129 // in Serial, G1 and Shenandoah full-GCs.
130 private:
131 inline Klass* forward_safe_klass_impl(markWord m) const;
132 public:
133 inline Klass* forward_safe_klass() const;
134 inline Klass* forward_safe_klass(markWord m) const;
135 inline size_t forward_safe_size();
136 inline void forward_safe_init_mark();
137
138 // type test operations (inlined in oop.inline.hpp)
139 inline bool is_instance() const;
140 inline bool is_instanceRef() const;
141 inline bool is_stackChunk() const;
142 inline bool is_array() const;
143 inline bool is_objArray() const;
144 inline bool is_typeArray() const;
145
146 // type test operations that don't require inclusion of oop.inline.hpp.
147 bool is_instance_noinline() const;
148 bool is_instanceRef_noinline() const;
149 bool is_stackChunk_noinline() const;
150 bool is_array_noinline() const;
151 bool is_objArray_noinline() const;
152 bool is_typeArray_noinline() const;
153
154 protected:
155 inline oop as_oop() const { return const_cast<oopDesc*>(this); }
156
157 public:
266 char* print_string();
267 char* print_value_string();
268
269 // verification operations
270 static void verify_on(outputStream* st, oopDesc* oop_desc);
271 static void verify(oopDesc* oopDesc);
272
273 // locking operations
274 inline bool is_locked() const;
275 inline bool is_unlocked() const;
276
277 // asserts and guarantees
278 static bool is_oop(oop obj, bool ignore_mark_word = false);
279 static bool is_oop_or_null(oop obj, bool ignore_mark_word = false);
280
281 // garbage collection
282 inline bool is_gc_marked() const;
283
284 // Forward pointer operations for scavenge
285 inline bool is_forwarded() const;
286 inline bool is_self_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 inline void unset_self_forwarded();
302
303 // Age of object during scavenge
304 inline uint age() const;
305 inline void incr_age();
306
307 template <typename OopClosureType>
308 inline void oop_iterate(OopClosureType* cl);
309
310 template <typename OopClosureType>
311 inline void oop_iterate(OopClosureType* cl, MemRegion mr);
312
313 template <typename OopClosureType>
314 inline size_t oop_iterate_size(OopClosureType* cl);
315
316 template <typename OopClosureType>
317 inline size_t oop_iterate_size(OopClosureType* cl, MemRegion mr);
318
319 template <typename OopClosureType>
320 inline void oop_iterate_backwards(OopClosureType* cl);
321
325 inline static bool is_instanceof_or_null(oop obj, Klass* klass);
326
327 // identity hash; returns the identity hash key (computes it if necessary)
328 inline intptr_t identity_hash();
329 intptr_t slow_identity_hash();
330 inline bool fast_no_hash_check();
331
332 // marks are forwarded to stack when object is locked
333 inline bool has_displaced_mark() const;
334 inline markWord displaced_mark() const;
335 inline void set_displaced_mark(markWord m);
336
337 // Checks if the mark word needs to be preserved
338 inline bool mark_must_be_preserved() const;
339 inline bool mark_must_be_preserved(markWord m) const;
340
341 static bool has_klass_gap();
342
343 // for code generation
344 static int mark_offset_in_bytes() { return (int)offset_of(oopDesc, _mark); }
345 static int klass_offset_in_bytes() {
346 #ifdef _LP64
347 if (UseCompactObjectHeaders) {
348 constexpr int load_shift = markWord::klass_load_shift;
349 STATIC_ASSERT(load_shift % 8 == 0);
350 return mark_offset_in_bytes() + load_shift / 8;
351 } else
352 #endif
353 {
354 return (int)offset_of(oopDesc, _metadata._klass);
355 }
356 }
357 static int klass_gap_offset_in_bytes() {
358 assert(has_klass_gap(), "only applicable to compressed klass pointers");
359 assert(!UseCompactObjectHeaders, "don't use klass_offset_in_bytes() with compact headers");
360 return klass_offset_in_bytes() + sizeof(narrowKlass);
361 }
362
363 static int base_offset_in_bytes() {
364 #ifdef _LP64
365 if (UseCompactObjectHeaders) {
366 // With compact headers, the Klass* field is not used for the Klass*
367 // and is used for the object fields instead.
368 STATIC_ASSERT(sizeof(markWord) == 8);
369 return sizeof(markWord);
370 } else if (UseCompressedClassPointers) {
371 return sizeof(markWord) + sizeof(narrowKlass);
372 } else
373 #endif
374 {
375 return sizeof(oopDesc);
376 }
377 }
378
379 // for error reporting
380 static void* load_oop_raw(oop obj, int offset);
381
382 DEBUG_ONLY(bool size_might_change(Klass* klass);)
383 };
384
385 // An oopDesc is not initialized via a constructor. Space is allocated in
386 // the Java heap, and static functions provided here on HeapWord* are used
387 // to fill in certain parts of that memory. The allocated memory is then
388 // treated as referring to an oopDesc. For that to be valid, the oopDesc
389 // class must have a trivial default constructor (C++14 3.8/1).
390 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
391
392 #endif // SHARE_OOPS_OOP_HPP
|