1 /*
2 * Copyright (c) 2017, 2024, 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_VM_OOPS_INLINEKLASS_HPP
26 #define SHARE_VM_OOPS_INLINEKLASS_HPP
27
28 #include "classfile/classFileParser.hpp"
29 #include "classfile/javaClasses.hpp"
30 #include "oops/instanceKlass.hpp"
31 #include "oops/method.hpp"
32 #include "runtime/registerMap.hpp"
33 //#include "oops/oop.inline.hpp"
34
35 // An InlineKlass is a specialized InstanceKlass for inline types.
36
37
38 class InlineKlass: public InstanceKlass {
39 friend class VMStructs;
40 friend class InstanceKlass;
41 friend class ClassFileParser;
42
43 public:
44 static const KlassKind Kind = InlineKlassKind;
45
46 InlineKlass();
47
48 private:
49
50 // Constructor
51 InlineKlass(const ClassFileParser& parser);
52
53 void init_fixed_block();
54 inline InlineKlassFixedBlock* inlineklass_static_block() const;
55 inline address adr_return_regs() const;
56
57 address adr_extended_sig() const {
58 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
59 return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _extended_sig));
60 }
61
62 // pack and unpack handlers for inline types return
63 address adr_pack_handler() const {
64 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
65 return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _pack_handler));
66 }
67
68 address adr_pack_handler_jobject() const {
69 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
70 return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _pack_handler_jobject));
71 }
72
73 address adr_unpack_handler() const {
74 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
75 return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _unpack_handler));
76 }
77
78 address adr_default_value_offset() const {
79 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
80 return ((address)_adr_inlineklass_fixed_block) + in_bytes(default_value_offset_offset());
81 }
82
83 ArrayKlass* volatile* adr_value_array_klasses() const {
84 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
85 return (ArrayKlass* volatile*) ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _null_free_inline_array_klasses));
86 }
87
88 ArrayKlass* value_array_klasses() const {
89 return *adr_value_array_klasses();
90 }
91
92 address adr_alignment() const {
93 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
94 return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _alignment));
95 }
96
97 address adr_first_field_offset() const {
98 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
99 return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _first_field_offset));
100 }
101
102 address adr_exact_size_in_bytes() const {
103 assert(_adr_inlineklass_fixed_block != nullptr, "Should have been initialized");
104 return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _exact_size_in_bytes));
105 }
106
107 public:
108 int get_alignment() const {
109 return *(int*)adr_alignment();
110 }
111
112 void set_alignment(int alignment) {
113 *(int*)adr_alignment() = alignment;
114 }
115
116 int first_field_offset() const {
117 int offset = *(int*)adr_first_field_offset();
118 assert(offset != 0, "Must be initialized before use");
119 return *(int*)adr_first_field_offset();
120 }
121
122 void set_first_field_offset(int offset) {
123 *(int*)adr_first_field_offset() = offset;
124 }
125
126 int get_exact_size_in_bytes() const {
127 return *(int*)adr_exact_size_in_bytes();
128 }
129
130 void set_exact_size_in_bytes(int exact_size) {
131 *(int*)adr_exact_size_in_bytes() = exact_size;
132 }
133
134 int first_field_offset_old();
135
136 virtual void remove_unshareable_info();
137 virtual void remove_java_mirror();
138 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
139 virtual void metaspace_pointers_do(MetaspaceClosure* it);
140
141 private:
142 int collect_fields(GrowableArray<SigEntry>* sig, int base_off = 0);
143
144 void cleanup_blobs();
145
146 public:
147 // Type testing
148 bool is_inline_klass_slow() const { return true; }
149
150 // Casting from Klass*
151 static InlineKlass* cast(Klass* k);
152
153 // Use this to return the size of an instance in heap words.
154 // Note that this size only applies to heap allocated stand-alone instances.
155 virtual int size_helper() const {
156 return layout_helper_to_size_helper(layout_helper());
157 }
158
159 // allocate_instance() allocates a stand alone value in the Java heap
160 // initialized to default value (cleared memory)
161 instanceOop allocate_instance(TRAPS);
162 // allocates a stand alone inline buffer in the Java heap
163 // DOES NOT have memory cleared, user MUST initialize payload before
164 // returning to Java (i.e.: inline_copy)
165 instanceOop allocate_instance_buffer(TRAPS);
166
167 address data_for_oop(oop o) const;
168
169 // Query if this class promises atomicity one way or another
170 bool is_atomic() { return is_naturally_atomic() || must_be_atomic(); }
171
172 bool flat_array();
173
174 bool contains_oops() const { return nonstatic_oop_map_count() > 0; }
175 int nonstatic_oop_count();
176
177 // null free inline arrays...
178 //
179
180 // null free inline array klass, akin to InstanceKlass::array_klass()
181 // Returns the array class for the n'th dimension
182 Klass* value_array_klass(int n, TRAPS);
183 Klass* value_array_klass_or_null(int n);
184
185 // Returns the array class with this class as element type
186 Klass* value_array_klass(TRAPS);
187 Klass* value_array_klass_or_null();
188
189
190 // General store methods
191 //
192 // Normally loads and store methods would be found in *Oops classes, but since values can be
193 // "in-lined" (flat layout) into containing oops, these methods reside here in InlineKlass.
194 //
195 // "inline_copy_*_to_new_*" assume new memory (i.e. IS_DEST_UNINITIALIZED for write barriers)
196
197 void inline_copy_payload_to_new_oop(void* src, oop dst);
198 void inline_copy_oop_to_new_oop(oop src, oop dst);
199 void inline_copy_oop_to_new_payload(oop src, void* dst);
200 void inline_copy_oop_to_payload(oop src, void* dst);
201
202 oop read_flat_field(oop obj, int offset, TRAPS);
203 void write_flat_field(oop obj, int offset, oop value, TRAPS);
204
205 // oop iterate raw inline type data pointer (where oop_addr may not be an oop, but backing/array-element)
206 template <typename T, class OopClosureType>
207 inline void oop_iterate_specialized(const address oop_addr, OopClosureType* closure);
208
209 template <typename T, class OopClosureType>
210 inline void oop_iterate_specialized_bounded(const address oop_addr, OopClosureType* closure, void* lo, void* hi);
211
212 // calling convention support
213 void initialize_calling_convention(TRAPS);
214 Array<SigEntry>* extended_sig() const {
215 return *((Array<SigEntry>**)adr_extended_sig());
216 }
217 inline Array<VMRegPair>* return_regs() const;
218 bool can_be_passed_as_fields() const;
219 bool can_be_returned_as_fields(bool init = false) const;
220 void save_oop_fields(const RegisterMap& map, GrowableArray<Handle>& handles) const;
221 void restore_oop_results(RegisterMap& map, GrowableArray<Handle>& handles) const;
222 oop realloc_result(const RegisterMap& reg_map, const GrowableArray<Handle>& handles, TRAPS);
223 static InlineKlass* returned_inline_klass(const RegisterMap& reg_map);
224
225 address pack_handler() const {
226 return *(address*)adr_pack_handler();
227 }
228
229 address unpack_handler() const {
230 return *(address*)adr_unpack_handler();
231 }
232
233 // pack and unpack handlers. Need to be loadable from generated code
234 // so at a fixed offset from the base of the klass pointer.
235 static ByteSize pack_handler_offset() {
236 return byte_offset_of(InlineKlassFixedBlock, _pack_handler);
237 }
238
239 static ByteSize pack_handler_jobject_offset() {
240 return byte_offset_of(InlineKlassFixedBlock, _pack_handler_jobject);
241 }
242
243 static ByteSize unpack_handler_offset() {
244 return byte_offset_of(InlineKlassFixedBlock, _unpack_handler);
245 }
246
247 static ByteSize default_value_offset_offset() {
248 return byte_offset_of(InlineKlassFixedBlock, _default_value_offset);
249 }
250
251 static ByteSize first_field_offset_offset() {
252 return byte_offset_of(InlineKlassFixedBlock, _first_field_offset);
253 }
254
255 void set_default_value_offset(int offset) {
256 *((int*)adr_default_value_offset()) = offset;
257 }
258
259 int default_value_offset() {
260 int offset = *((int*)adr_default_value_offset());
261 assert(offset != 0, "must not be called if not initialized");
262 return offset;
263 }
264
265 void set_default_value(oop val) {
266 java_mirror()->obj_field_put(default_value_offset(), val);
267 }
268
269 oop default_value();
270 void deallocate_contents(ClassLoaderData* loader_data);
271 static void cleanup(InlineKlass* ik) ;
272
273 // Verification
274 void verify_on(outputStream* st);
275 void oop_verify_on(oop obj, outputStream* st);
276
277 };
278
279 #endif /* SHARE_VM_OOPS_INLINEKLASS_HPP */