1 /*
2 * Copyright (c) 1997, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
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/compressedKlass.hpp"
31 #include "oops/accessDecorators.hpp"
32 #include "oops/markWord.hpp"
33 #include "oops/metadata.hpp"
34 #include "oops/objLayout.hpp"
35 #include "runtime/atomic.hpp"
36 #include "utilities/globalDefinitions.hpp"
37 #include "utilities/macros.hpp"
38 #include <type_traits>
39
40 // oopDesc is the top baseclass for objects classes. The {name}Desc classes describe
41 // the format of Java objects so the fields can be accessed from C++.
42 // oopDesc is abstract.
43 // (see oopHierarchy for complete oop class hierarchy)
44 //
45 // no virtual functions allowed
46 //
47 // oopDesc::_mark - the "oop mark word" encoding to be found separately in markWord.hpp
48 //
49 // oopDesc::_metadata - encodes the object's klass pointer, as a raw pointer in "_klass"
50 // or compressed pointer in "_compressed_klass"
51 //
52 // The overall size of the _metadata field is dependent on "UseCompressedClassPointers",
53 // hence the terms "narrow" (32 bits) vs "wide" (64 bits).
54 //
55
56
57 class oopDesc {
58 friend class VMStructs;
59 friend class JVMCIVMStructs;
60 private:
61 volatile markWord _mark;
62 union _metadata {
63 Klass* _klass;
64 narrowKlass _compressed_klass;
65 } _metadata;
66
67 // There may be ordering constraints on the initialization of fields that
68 // make use of the C++ copy/assign incorrect.
69 NONCOPYABLE(oopDesc);
70
71 inline oop cas_set_forwardee(markWord new_mark, markWord old_mark, atomic_memory_order order);
72
73 public:
74 // Must be trivial; see verifying static assert after the class.
75 oopDesc() = default;
76
77 inline markWord mark() const;
78 inline markWord mark_acquire() const;
79 inline markWord* mark_addr() const;
80
81 inline void set_mark(markWord m);
82 static inline void set_mark(HeapWord* mem, markWord m);
83 static inline void release_set_mark(HeapWord* mem, markWord m);
84
85 inline void release_set_mark(markWord m);
86 inline markWord cas_set_mark(markWord new_mark, markWord old_mark);
87 inline markWord cas_set_mark(markWord new_mark, markWord old_mark, atomic_memory_order order);
88
89 // Returns the prototype mark that should be used for this object.
90 inline markWord prototype_mark() const;
91
92 // Used only to re-initialize the mark word (e.g., of promoted
93 // objects during a GC) -- requires a valid klass pointer
94 inline void init_mark();
95
96 inline Klass* klass() const;
97 inline Klass* klass_or_null() const;
98 inline Klass* klass_or_null_acquire() const;
99 // Get the klass without running any asserts.
100 inline Klass* klass_without_asserts() const;
101
102 void set_narrow_klass(narrowKlass nk) NOT_CDS_JAVA_HEAP_RETURN;
103 inline void set_klass(Klass* k);
104 static inline void release_set_klass(HeapWord* mem, Klass* k);
105
106 // For klass field compression
107 static inline void set_klass_gap(HeapWord* mem, int z);
108
109 // Size of object header, aligned to platform wordSize
110 static int header_size() {
111 if (UseCompactObjectHeaders) {
112 return sizeof(markWord) / HeapWordSize;
113 } else {
114 return sizeof(oopDesc) / HeapWordSize;
115 }
116 }
117
118 // Returns whether this is an instance of k or an instance of a subclass of k
119 inline bool is_a(Klass* k) const;
120
121 // Returns the actual oop size of the object in machine words
122 inline size_t size();
123
124 // Sometimes (for complicated concurrency-related reasons), it is useful
125 // to be able to figure out the size of an object knowing its klass.
126 inline size_t size_given_klass(Klass* klass);
127
128 // type test operations (inlined in oop.inline.hpp)
129 inline bool is_instance() const;
130 inline bool is_inline_type() const;
131 inline bool is_instanceRef() const;
132 inline bool is_stackChunk() const;
133 inline bool is_array() const;
134 inline bool is_objArray() const;
135 inline bool is_typeArray() const;
136 inline bool is_flatArray() const;
137 inline bool is_refArray() const;
138 inline bool is_null_free_array() const;
139 inline bool is_refined_objArray() const;
140
141 // type test operations that don't require inclusion of oop.inline.hpp.
142 bool is_instance_noinline() const;
143 bool is_instanceRef_noinline() const;
144 bool is_stackChunk_noinline() const;
145 bool is_array_noinline() const;
146 bool is_objArray_noinline() const;
147 bool is_refArray_noinline() const;
148 bool is_typeArray_noinline() const;
149 bool is_flatArray_noinline() const;
150 bool is_null_free_array_noinline() const;
151
152 protected:
153 inline oop as_oop() const { return const_cast<oopDesc*>(this); }
154
155 public:
156 template<typename T>
157 inline T* field_addr(int offset) const;
158
159 template <typename T> inline size_t field_offset(T* p) const;
160
161 // Standard compare function returns negative value if o1 < o2
162 // 0 if o1 == o2
163 // positive value if o1 > o2
164 inline static int compare(oop o1, oop o2) {
165 void* o1_addr = (void*)o1;
166 void* o2_addr = (void*)o2;
167 if (o1_addr < o2_addr) {
168 return -1;
169 } else if (o1_addr > o2_addr) {
170 return 1;
171 } else {
172 return 0;
173 }
174 }
175
176 // Access to fields in a instanceOop through these methods.
177 template<DecoratorSet decorators>
178 oop obj_field_access(int offset) const;
179 oop obj_field(int offset) const;
180
181 void obj_field_put(int offset, oop value);
182 void obj_field_put_raw(int offset, oop value);
183 void obj_field_put_volatile(int offset, oop value);
184 template<DecoratorSet decorators>
185 void obj_field_put_access(int offset, oop value);
186
187 Metadata* metadata_field(int offset) const;
188 void metadata_field_put(int offset, Metadata* value);
189
190 Metadata* metadata_field_acquire(int offset) const;
191 void release_metadata_field_put(int offset, Metadata* value);
192
193 jbyte byte_field(int offset) const;
194 void byte_field_put(int offset, jbyte contents);
195
196 jchar char_field(int offset) const;
197 void char_field_put(int offset, jchar contents);
198
199 jboolean bool_field(int offset) const;
200 void bool_field_put(int offset, jboolean contents);
201 jboolean bool_field_volatile(int offset) const;
202 void bool_field_put_volatile(int offset, jboolean contents);
203
204 jint int_field(int offset) const;
205 void int_field_put(int offset, jint contents);
206
207 jshort short_field(int offset) const;
208 void short_field_put(int offset, jshort contents);
209
210 jlong long_field(int offset) const;
211 void long_field_put(int offset, jlong contents);
212
213 jfloat float_field(int offset) const;
214 void float_field_put(int offset, jfloat contents);
215
216 jdouble double_field(int offset) const;
217 void double_field_put(int offset, jdouble contents);
218
219 address address_field(int offset) const;
220 void address_field_put(int offset, address contents);
221
222 oop obj_field_acquire(int offset) const;
223 void release_obj_field_put(int offset, oop value);
224
225 jbyte byte_field_acquire(int offset) const;
226 void release_byte_field_put(int offset, jbyte contents);
227
228 jchar char_field_acquire(int offset) const;
229 void release_char_field_put(int offset, jchar contents);
230
231 jboolean bool_field_acquire(int offset) const;
232 void release_bool_field_put(int offset, jboolean contents);
233
234 jint int_field_relaxed(int offset) const;
235 void int_field_put_relaxed(int offset, jint contents);
236 jint int_field_acquire(int offset) const;
237 void release_int_field_put(int offset, jint contents);
238
239 jshort short_field_acquire(int offset) const;
240 void release_short_field_put(int offset, jshort contents);
241
242 jlong long_field_acquire(int offset) const;
243 void release_long_field_put(int offset, jlong contents);
244
245 jfloat float_field_acquire(int offset) const;
246 void release_float_field_put(int offset, jfloat contents);
247
248 jdouble double_field_acquire(int offset) const;
249 void release_double_field_put(int offset, jdouble contents);
250
251 address address_field_acquire(int offset) const;
252 void release_address_field_put(int offset, address contents);
253
254 // printing functions for VM debugging
255 void print_on(outputStream* st) const; // First level print
256 void print_value_on(outputStream* st) const; // Second level print.
257 void print_address_on(outputStream* st) const; // Address printing
258 void print_name_on(outputStream* st) const; // External name printing.
259
260 // printing on default output stream
261 void print();
262 void print_value();
263 void print_address();
264
265 // return the print strings
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
322 template <typename OopClosureType>
323 inline void oop_iterate_backwards(OopClosureType* cl, Klass* klass);
324
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 inline static bool has_klass_gap() {
342 return ObjLayout::oop_has_klass_gap();
343 }
344
345 // for code generation
346 static int mark_offset_in_bytes() { return (int)offset_of(oopDesc, _mark); }
347 static int klass_offset_in_bytes() {
348 #ifdef _LP64
349 if (UseCompactObjectHeaders) {
350 // NOTE: The only places where this is used with compact headers are the C2
351 // compiler and JVMCI.
352 return mark_offset_in_bytes() + markWord::klass_offset_in_bytes;
353 } else
354 #endif
355 {
356 return (int)offset_of(oopDesc, _metadata._klass);
357 }
358 }
359 static int klass_gap_offset_in_bytes() {
360 assert(has_klass_gap(), "only applicable to compressed klass pointers");
361 return klass_offset_in_bytes() + sizeof(narrowKlass);
362 }
363
364 static int base_offset_in_bytes() {
365 return ObjLayout::oop_base_offset_in_bytes();
366 }
367
368 // for error reporting
369 static void* load_oop_raw(oop obj, int offset);
370 };
371
372 // An oopDesc is not initialized via a constructor. Space is allocated in
373 // the Java heap, and static functions provided here on HeapWord* are used
374 // to fill in certain parts of that memory. The allocated memory is then
375 // treated as referring to an oopDesc. For that to be valid, the oopDesc
376 // class must have a trivial default constructor (C++14 3.8/1).
377 static_assert(std::is_trivially_default_constructible<oopDesc>::value, "required");
378
379 #endif // SHARE_OOPS_OOP_HPP