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:
242
243 // verification operations
244 static void verify_on(outputStream* st, oopDesc* oop_desc);
245 static void verify(oopDesc* oopDesc);
246
247 // locking operations
248 inline bool is_locked() const;
249 inline bool is_unlocked() const;
250
251 // asserts and guarantees
252 static bool is_oop(oop obj, bool ignore_mark_word = false);
253 static bool is_oop_or_null(oop obj, bool ignore_mark_word = false);
254
255 // garbage collection
256 inline bool is_gc_marked() const;
257
258 // Forward pointer operations for scavenge
259 inline bool is_forwarded() const;
260
261 inline void forward_to(oop p);
262
263 // Like "forward_to", but inserts the forwarding pointer atomically.
264 // Exactly one thread succeeds in inserting the forwarding pointer, and
265 // this call returns null for that thread; any other thread has the
266 // value of the forwarding pointer returned and does not modify "this".
267 inline oop forward_to_atomic(oop p, markWord compare, atomic_memory_order order = memory_order_conservative);
268
269 inline oop forwardee() const;
270
271 // Age of object during scavenge
272 inline uint age() const;
273 inline void incr_age();
274
275 template <typename OopClosureType>
276 inline void oop_iterate(OopClosureType* cl);
277
278 template <typename OopClosureType>
279 inline void oop_iterate(OopClosureType* cl, MemRegion mr);
280
281 template <typename OopClosureType>
282 inline size_t oop_iterate_size(OopClosureType* cl);
283
284 template <typename OopClosureType>
285 inline size_t oop_iterate_size(OopClosureType* cl, MemRegion mr);
286
287 template <typename OopClosureType>
288 inline void oop_iterate_backwards(OopClosureType* cl);
289
293 inline static bool is_instanceof_or_null(oop obj, Klass* klass);
294
295 // identity hash; returns the identity hash key (computes it if necessary)
296 inline intptr_t identity_hash();
297 intptr_t slow_identity_hash();
298 inline bool fast_no_hash_check();
299
300 // marks are forwarded to stack when object is locked
301 inline bool has_displaced_mark() const;
302 inline markWord displaced_mark() const;
303 inline void set_displaced_mark(markWord m);
304
305 // Checks if the mark word needs to be preserved
306 inline bool mark_must_be_preserved() const;
307 inline bool mark_must_be_preserved(markWord m) const;
308
309 static bool has_klass_gap();
310
311 // for code generation
312 static int mark_offset_in_bytes() { return (int)offset_of(oopDesc, _mark); }
313 static int klass_offset_in_bytes() { return (int)offset_of(oopDesc, _metadata._klass); }
314 static int klass_gap_offset_in_bytes() {
315 assert(has_klass_gap(), "only applicable to compressed klass pointers");
316 return klass_offset_in_bytes() + sizeof(narrowKlass);
317 }
318
319 // for error reporting
320 static void* load_klass_raw(oop obj);
321 static void* load_oop_raw(oop obj, int offset);
322
323 DEBUG_ONLY(bool size_might_change();)
324 };
325
326 // An oopDesc is not initialized via a constructor. Space is allocated in
327 // the Java heap, and static functions provided here on HeapWord* are used
328 // to fill in certain parts of that memory. The allocated memory is then
329 // treated as referring to an oopDesc. For that to be valid, the oopDesc
330 // class must have a trivial default constructor (C++14 3.8/1).
331 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
332
333 #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:
267
268 // verification operations
269 static void verify_on(outputStream* st, oopDesc* oop_desc);
270 static void verify(oopDesc* oopDesc);
271
272 // locking operations
273 inline bool is_locked() const;
274 inline bool is_unlocked() const;
275
276 // asserts and guarantees
277 static bool is_oop(oop obj, bool ignore_mark_word = false);
278 static bool is_oop_or_null(oop obj, bool ignore_mark_word = false);
279
280 // garbage collection
281 inline bool is_gc_marked() const;
282
283 // Forward pointer operations for scavenge
284 inline bool is_forwarded() const;
285
286 inline void forward_to(oop p);
287 inline void forward_to_self();
288
289 // Like "forward_to", but inserts the forwarding pointer atomically.
290 // Exactly one thread succeeds in inserting the forwarding pointer, and
291 // this call returns null for that thread; any other thread has the
292 // value of the forwarding pointer returned and does not modify "this".
293 inline oop forward_to_atomic(oop p, markWord compare, atomic_memory_order order = memory_order_conservative);
294 inline oop forward_to_self_atomic(markWord compare, atomic_memory_order order = memory_order_conservative);
295
296 inline oop forwardee() const;
297 inline oop forwardee(markWord header) const;
298
299 // Age of object during scavenge
300 inline uint age() const;
301 inline void incr_age();
302
303 template <typename OopClosureType>
304 inline void oop_iterate(OopClosureType* cl);
305
306 template <typename OopClosureType>
307 inline void oop_iterate(OopClosureType* cl, MemRegion mr);
308
309 template <typename OopClosureType>
310 inline size_t oop_iterate_size(OopClosureType* cl);
311
312 template <typename OopClosureType>
313 inline size_t oop_iterate_size(OopClosureType* cl, MemRegion mr);
314
315 template <typename OopClosureType>
316 inline void oop_iterate_backwards(OopClosureType* cl);
317
321 inline static bool is_instanceof_or_null(oop obj, Klass* klass);
322
323 // identity hash; returns the identity hash key (computes it if necessary)
324 inline intptr_t identity_hash();
325 intptr_t slow_identity_hash();
326 inline bool fast_no_hash_check();
327
328 // marks are forwarded to stack when object is locked
329 inline bool has_displaced_mark() const;
330 inline markWord displaced_mark() const;
331 inline void set_displaced_mark(markWord m);
332
333 // Checks if the mark word needs to be preserved
334 inline bool mark_must_be_preserved() const;
335 inline bool mark_must_be_preserved(markWord m) const;
336
337 static bool has_klass_gap();
338
339 // for code generation
340 static int mark_offset_in_bytes() { return (int)offset_of(oopDesc, _mark); }
341 static int klass_offset_in_bytes() {
342 #ifdef _LP64
343 if (UseCompactObjectHeaders) {
344 STATIC_ASSERT(markWord::klass_shift % 8 == 0);
345 return mark_offset_in_bytes() + markWord::klass_shift / 8;
346 } else
347 #endif
348 {
349 return (int)offset_of(oopDesc, _metadata._klass);
350 }
351 }
352 static int klass_gap_offset_in_bytes() {
353 assert(has_klass_gap(), "only applicable to compressed klass pointers");
354 assert(!UseCompactObjectHeaders, "don't use klass_offset_in_bytes() with compact headers");
355 return klass_offset_in_bytes() + sizeof(narrowKlass);
356 }
357
358 static int base_offset_in_bytes() {
359 #ifdef _LP64
360 if (UseCompactObjectHeaders) {
361 // With compact headers, the Klass* field is not used for the Klass*
362 // and is used for the object fields instead.
363 STATIC_ASSERT(sizeof(markWord) == 8);
364 return sizeof(markWord);
365 } else if (UseCompressedClassPointers) {
366 return sizeof(markWord) + sizeof(narrowKlass);
367 } else
368 #endif
369 {
370 return sizeof(oopDesc);
371 }
372 }
373
374 // for error reporting
375 static void* load_klass_raw(oop obj);
376 static void* load_oop_raw(oop obj, int offset);
377
378 DEBUG_ONLY(bool size_might_change();)
379 };
380
381 // An oopDesc is not initialized via a constructor. Space is allocated in
382 // the Java heap, and static functions provided here on HeapWord* are used
383 // to fill in certain parts of that memory. The allocated memory is then
384 // treated as referring to an oopDesc. For that to be valid, the oopDesc
385 // class must have a trivial default constructor (C++14 3.8/1).
386 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
387
388 #endif // SHARE_OOPS_OOP_HPP
|