1 /*
2 * Copyright (c) 2017, 2026, 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 #include "classfile/moduleEntry.hpp"
26 #include "classfile/packageEntry.hpp"
27 #include "classfile/symbolTable.hpp"
28 #include "classfile/systemDictionary.hpp"
29 #include "classfile/vmSymbols.hpp"
30 #include "gc/shared/collectedHeap.inline.hpp"
31 #include "memory/iterator.inline.hpp"
32 #include "memory/metadataFactory.hpp"
33 #include "memory/metaspaceClosure.hpp"
34 #include "memory/oopFactory.hpp"
35 #include "memory/resourceArea.hpp"
36 #include "memory/universe.hpp"
37 #include "oops/access.hpp"
38 #include "oops/arrayKlass.inline.hpp"
39 #include "oops/arrayOop.hpp"
40 #include "oops/flatArrayKlass.hpp"
41 #include "oops/flatArrayOop.hpp"
42 #include "oops/flatArrayOop.inline.hpp"
43 #include "oops/inlineKlass.hpp"
44 #include "oops/instanceKlass.hpp"
45 #include "oops/klass.inline.hpp"
46 #include "oops/layoutKind.hpp"
47 #include "oops/objArrayKlass.hpp"
48 #include "oops/objArrayOop.inline.hpp"
49 #include "oops/oop.inline.hpp"
50 #include "oops/oopCast.inline.hpp"
51 #include "oops/valuePayload.inline.hpp"
52 #include "oops/verifyOopClosure.hpp"
53 #include "runtime/arguments.hpp"
54 #include "runtime/handles.inline.hpp"
55 #include "runtime/mutexLocker.hpp"
56 #include "utilities/copy.hpp"
57 #include "utilities/macros.hpp"
58
59 // Allocation...
60
61 FlatArrayKlass::FlatArrayKlass(Klass* element_klass, Symbol* name, ArrayProperties props, LayoutKind lk)
62 : ObjArrayKlass(1, element_klass, name, Kind, props),
63 _layout_kind(lk) {
64 assert(element_klass->is_inline_klass(), "Expected Inline");
65 assert(lk != LayoutKind::NULLABLE_NON_ATOMIC_FLAT, "Layout not supported by arrays yet (needs frozen arrays)");
66 assert(LayoutKindHelper::is_flat(lk), "Must be a flat layout");
67
68 assert(_class_loader_data == element_klass->class_loader_data(), "Sanity check");
69
70 set_layout_helper(array_layout_helper(InlineKlass::cast(element_klass), lk));
71 assert(is_array_klass(), "sanity");
72 assert(is_flatArray_klass(), "sanity");
73
74 #ifdef ASSERT
75 assert(layout_helper_is_array(layout_helper()), "Must be");
76 assert(layout_helper_is_flatArray(layout_helper()), "Must be");
77 assert(layout_helper_element_type(layout_helper()) == T_FLAT_ELEMENT, "Must be");
78 assert(prototype_header().is_flat_array(), "Must be");
79 switch(lk) {
80 case LayoutKind::NULL_FREE_NON_ATOMIC_FLAT:
81 case LayoutKind::NULL_FREE_ATOMIC_FLAT:
82 assert(layout_helper_is_null_free(layout_helper()), "Must be");
83 assert(prototype_header().is_null_free_array(), "Must be");
84 break;
85 case LayoutKind::NULLABLE_ATOMIC_FLAT:
86 assert(!layout_helper_is_null_free(layout_helper()), "Must be");
87 assert(!prototype_header().is_null_free_array(), "Must be");
88 break;
89 case LayoutKind::NULLABLE_NON_ATOMIC_FLAT:
90 ShouldNotReachHere();
91 default:
92 ShouldNotReachHere();
93 break;
94 }
95 #endif // ASSERT
96
97 if (PrintFlatArrayLayout) {
98 print();
99 }
100 }
101
102 FlatArrayKlass* FlatArrayKlass::allocate_klass(Klass* eklass, ArrayProperties props, LayoutKind lk, TRAPS) {
103 guarantee((!Universe::is_bootstrapping() || vmClasses::Object_klass_is_loaded()), "Really ?!");
104 assert(UseArrayFlattening, "Flatten array required");
105 assert(MultiArray_lock->holds_lock(THREAD), "must hold lock after bootstrapping");
106
107 InlineKlass* element_klass = InlineKlass::cast(eklass);
108 assert(element_klass->must_be_atomic() || (!AlwaysAtomicAccesses), "Atomic by-default");
109
110 // Eagerly allocate the direct array supertype.
111 Klass* super_klass = nullptr;
112 Klass* element_super = element_klass->super();
113 if (element_super != nullptr) {
114 // The element type has a direct super. E.g., String[] has direct super of Object[].
115 super_klass = element_klass->array_klass(CHECK_NULL);
116 }
117
118 Symbol* name = create_element_klass_array_name(THREAD, element_klass);
119 ClassLoaderData* loader_data = element_klass->class_loader_data();
120 int size = ArrayKlass::static_size(FlatArrayKlass::header_size());
121 FlatArrayKlass* vak = new (loader_data, size, THREAD) FlatArrayKlass(element_klass, name, props, lk);
122
123 ModuleEntry* module = vak->module();
124 assert(module != nullptr, "No module entry for array");
125 complete_create_array_klass(vak, super_klass, module, CHECK_NULL);
126
127 loader_data->add_class(vak);
128
129 return vak;
130 }
131
132 void FlatArrayKlass::initialize(TRAPS) {
133 element_klass()->initialize(THREAD);
134 }
135
136 void FlatArrayKlass::metaspace_pointers_do(MetaspaceClosure* it) {
137 ObjArrayKlass::metaspace_pointers_do(it);
138 }
139
140 // Oops allocation...
141 flatArrayOop FlatArrayKlass::allocate_instance(int length, TRAPS) {
142 assert(UseArrayFlattening, "Must be enabled");
143 check_array_allocation_length(length, max_elements(), CHECK_NULL);
144 int size = flatArrayOopDesc::object_size(layout_helper(), length);
145 oop array = Universe::heap()->array_allocate(this, size, length, true, CHECK_NULL);
146 return oop_cast<flatArrayOop>(array);
147 }
148
149 oop FlatArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
150 // FlatArrays only have one dimension
151 ShouldNotReachHere();
152 }
153
154 jint FlatArrayKlass::array_layout_helper(InlineKlass* vk, LayoutKind lk) {
155 BasicType etype = T_FLAT_ELEMENT;
156 int esize = log2i_exact(round_up_power_of_2(vk->layout_size_in_bytes(lk)));
157 int hsize = arrayOopDesc::base_offset_in_bytes(etype);
158 bool null_free = !LayoutKindHelper::is_nullable_flat(lk);
159 int lh = Klass::array_layout_helper(_lh_array_tag_flat_value, null_free, hsize, etype, esize);
160
161 assert(lh < (int)_lh_neutral_value, "must look like an array layout");
162 assert(layout_helper_is_array(lh), "correct kind");
163 assert(layout_helper_is_flatArray(lh), "correct kind");
164 assert(!layout_helper_is_typeArray(lh), "correct kind");
165 assert(layout_helper_is_null_free(lh) == null_free, "correct kind");
166 assert(layout_helper_header_size(lh) == hsize, "correct decode");
167 assert(layout_helper_element_type(lh) == etype, "correct decode");
168 assert(layout_helper_log2_element_size(lh) == esize, "correct decode");
169 assert((1 << esize) < BytesPerLong || is_aligned(hsize, HeapWordsPerLong), "unaligned base");
170
171 return lh;
172 }
173
174 size_t FlatArrayKlass::oop_size(oop obj) const {
175 // In this assert, we cannot safely access the Klass* with compact headers,
176 // because size_given_klass() calls oop_size() on objects that might be
177 // concurrently forwarded, which would overwrite the Klass*.
178 // Also, why we need to pass this layout_helper() to flatArrayOop::object_size.
179 assert(UseCompactObjectHeaders || obj->is_flatArray(),"must be an flat array");
180 flatArrayOop array = flatArrayOop(obj);
181 return array->object_size(layout_helper());
182 }
183
184 // For now return the maximum number of array elements that will not exceed:
185 // nof bytes = "max_jint * HeapWord" since the "oopDesc::oop_iterate_size"
186 // returns "int" HeapWords, need fix for JDK-4718400 and JDK-8233189
187 jint FlatArrayKlass::max_elements() const {
188 // Check the max number of heap words limit first (because of int32_t in oopDesc_oop_size() etc)
189 size_t max_size = max_jint;
190 max_size -= (arrayOopDesc::base_offset_in_bytes(T_FLAT_ELEMENT) >> LogHeapWordSize);
191 max_size = align_down(max_size, MinObjAlignment);
192 max_size <<= LogHeapWordSize; // convert to max payload size in bytes
193 max_size >>= layout_helper_log2_element_size(_layout_helper); // divide by element size (in bytes) = max elements
194 // Within int32_t heap words, still can't exceed Java array element limit
195 if (max_size > max_jint) {
196 max_size = max_jint;
197 }
198 assert((max_size >> LogHeapWordSize) <= max_jint, "Overflow");
199 return (jint) max_size;
200 }
201
202 oop FlatArrayKlass::protection_domain() const {
203 return element_klass()->protection_domain();
204 }
205
206 // Temp hack having this here: need to move towards Access API
207 static bool needs_backwards_copy(arrayOop s, int src_pos,
208 arrayOop d, int dst_pos, int length) {
209 return (s == d) && (dst_pos > src_pos) && (dst_pos - src_pos) < length;
210 }
211
212 void FlatArrayKlass::copy_array(arrayOop s, int src_pos,
213 arrayOop d, int dst_pos, int length, TRAPS) {
214
215 assert(s->is_refined_objArray(), "must be ref or flat array");
216
217 // Check destination
218 if (!d->is_refined_objArray()) {
219 THROW(vmSymbols::java_lang_ArrayStoreException());
220 }
221
222 // Check if all offsets and lengths are non negative
223 if (src_pos < 0 || dst_pos < 0 || length < 0) {
224 THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
225 }
226 // Check if the ranges are valid
227 if ( (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length())
228 || (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length()) ) {
229 THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
230 }
231 // Check zero copy
232 if (length == 0)
233 return;
234
235 ObjArrayKlass* sk = ObjArrayKlass::cast(s->klass());
236 ObjArrayKlass* dk = ObjArrayKlass::cast(d->klass());
237 Klass* d_elem_klass = dk->element_klass();
238 Klass* s_elem_klass = sk->element_klass();
239 /**** CMH: compare and contrast impl, re-factor once we find edge cases... ****/
240
241 if (sk->is_flatArray_klass()) {
242 assert(sk == this, "Unexpected call to copy_array");
243 FlatArrayKlass* fsk = FlatArrayKlass::cast(sk);
244 // Check subtype, all src homogeneous, so just once
245 if (!s_elem_klass->is_subtype_of(d_elem_klass)) {
246 THROW(vmSymbols::java_lang_ArrayStoreException());
247 }
248
249 flatArrayOop sa = flatArrayOop(s);
250
251 // flatArray-to-flatArray
252 if (dk->is_flatArray_klass()) {
253 // element types MUST be exact, subtype check would be dangerous
254 if (d_elem_klass != this->element_klass()) {
255 THROW(vmSymbols::java_lang_ArrayStoreException());
256 }
257
258 FlatArrayKlass* fdk = FlatArrayKlass::cast(dk);
259 InlineKlass* vk = InlineKlass::cast(s_elem_klass);
260 flatArrayOop da = flatArrayOop(d);
261
262 // We have already checked that src_pos and dst_pos are valid indices.
263 FlatArrayPayload src_payload(sa, src_pos, fsk);
264 FlatArrayPayload dst_payload(da, dst_pos, fdk);
265
266 if (fsk->layout_kind() == fdk->layout_kind()) {
267 // Because source and destination have the same layout, we do not have
268 // to worry about null checks and atomicity problems and can call the
269 // Access API directly.
270 int index_delta;
271 if (needs_backwards_copy(sa, src_pos, da, dst_pos, length)) {
272 index_delta = -1;
273 src_payload.advance_index(length - 1);
274 dst_payload.advance_index(length - 1);
275 } else {
276 index_delta = 1;
277 }
278
279 for (int i = 0; i < length; i++) {
280 HeapAccess<>::value_copy(src_payload, dst_payload);
281 src_payload.advance_index(index_delta);
282 dst_payload.advance_index(index_delta);
283 }
284 } else {
285 // We need to allocate a buffer object to facilitate the copy between
286 // the different layouts. Keep the payload in a handle so we can reload
287 // the oops.
288 FlatArrayPayload::Handle src_payload_handle = src_payload.make_handle(THREAD);
289 FlatArrayPayload::Handle dst_payload_handle = dst_payload.make_handle(THREAD);
290
291 inlineOop buffer = vk->allocate_instance(CHECK);
292 BufferedValuePayload buf_payload(buffer);
293
294 // Reload the oops from the payload handles.
295 src_payload = src_payload_handle();
296 dst_payload = dst_payload_handle();
297
298 const bool dst_is_null_restricted = !LayoutKindHelper::is_nullable_flat(dst_payload.layout_kind());
299
300 // fsk->layout_kind() != fdk->layout_kind() implies that s != d, which
301 // means that the copy is disjoint and we do not need to worry about
302 // needs_backwards_copy.
303 for (int i = 0; i < length; i++) {
304 // Copy via buffer
305 if (src_payload.is_payload_null() || !src_payload.copy_to(buf_payload)) {
306 // The source payload is null. Nothing to copy.
307 if (dst_is_null_restricted) {
308 // The destination does not support null.
309 THROW(vmSymbols::java_lang_NullPointerException());
310 }
311 } else {
312 dst_payload.copy_from(buf_payload);
313 }
314
315 // Advance to next element
316 src_payload.next_element();
317 dst_payload.next_element();
318 }
319 }
320 } else {
321 // flatArray-to-refArray
322 assert(dk->is_refArray_klass(), "Expected objArray here");
323
324 // Need to allocate each new src elem payload -> dst oop
325 refArrayHandle dh(THREAD, (refArrayOop)d);
326 flatArrayHandle sh(THREAD, sa);
327 for (int i = 0; i < length; i++) {
328 oop o = sh->obj_at(src_pos + i, CHECK);
329 dh->obj_at_put(dst_pos + i, o);
330 }
331 }
332 } else {
333 // refArray-to-flatArray
334 assert(s->is_refArray(), "Expected refArray");
335 assert(d->is_flatArray(), "Expected flatArray");
336 refArrayOop sa = refArrayOop(s);
337 flatArrayOop da = flatArrayOop(d);
338
339 for (int i = 0; i < length; i++) {
340 da->obj_at_put( dst_pos + i, sa->obj_at(src_pos + i), CHECK);
341 }
342 }
343 }
344
345 bool FlatArrayKlass::can_be_primary_super_slow() const {
346 return true;
347 }
348
349 u2 FlatArrayKlass::compute_modifier_flags() const {
350 // The modifier for an flatArray is the same as its element
351 // With the addition of ACC_IDENTITY
352 u2 element_flags = element_klass()->compute_modifier_flags();
353
354 u2 identity_flag = (Arguments::is_valhalla_enabled()) ? JVM_ACC_IDENTITY : 0;
355
356 return (element_flags & (JVM_ACC_PUBLIC | JVM_ACC_PRIVATE | JVM_ACC_PROTECTED))
357 | (identity_flag | JVM_ACC_ABSTRACT | JVM_ACC_FINAL);
358 }
359
360 void FlatArrayKlass::print_on(outputStream* st) const {
361 assert(!is_refArray_klass(), "Unimplemented");
362 ResourceMark rm;
363
364 st->print("Flat Type Array: ");
365 Klass::print_on(st);
366
367 st->print(" - element klass: ");
368 element_klass()->print_value_on(st);
369 st->cr();
370
371 st->print(" - layout kind: %s", LayoutKindHelper::layout_kind_as_string(layout_kind()));
372 st->cr();
373
374 st->print(" - array properties: %s", properties().as_string());
375 st->cr();
376
377 int elem_size = element_byte_size();
378 st->print(" - element size %i ", elem_size);
379 st->print("aligned layout size %i", 1 << layout_helper_log2_element_size(layout_helper()));
380 st->cr();
381 }
382
383 void FlatArrayKlass::print_value_on(outputStream* st) const {
384 assert(is_klass(), "must be klass");
385
386 element_klass()->print_value_on(st);
387 st->print("[]");
388 }
389
390 #ifndef PRODUCT
391 void FlatArrayKlass::oop_print_on(oop obj, outputStream* st) {
392 ArrayKlass::oop_print_on(obj, st);
393 flatArrayOop va = flatArrayOop(obj);
394 oop_print_elements_on(va, st);
395 }
396 #endif //PRODUCT
397
398 void FlatArrayKlass::oop_print_value_on(oop obj, outputStream* st) {
399 assert(obj->is_flatArray(), "must be flatArray");
400 st->print("a ");
401 element_klass()->print_value_on(st);
402 int len = flatArrayOop(obj)->length();
403 st->print("[%d] ", len);
404 obj->print_address_on(st);
405 if (PrintMiscellaneous && (WizardMode || Verbose)) {
406 int lh = layout_helper();
407 st->print("{");
408 for (int i = 0; i < len; i++) {
409 if (i > 4) {
410 st->print("..."); break;
411 }
412 st->print(" " INTPTR_FORMAT, (intptr_t)(void*)flatArrayOop(obj)->value_at_addr(i , lh));
413 }
414 st->print(" }");
415 }
416 }
417
418 void FlatArrayKlass::oop_print_elements_on(flatArrayOop fa, outputStream* st) {
419 InlineKlass* vk = element_klass();
420 int print_len = MIN2(fa->length(), MaxElementPrintSize);
421 for(int index = 0; index < print_len; index++) {
422 int off = (address) fa->value_at_addr(index, layout_helper()) - cast_from_oop<address>(fa);
423 st->print_cr(" - Index %3d offset %3d: ", index, off);
424 oop obj = cast_to_oop((address)fa->value_at_addr(index, layout_helper()) - vk->payload_offset());
425 FieldPrinter print_field(st, obj);
426 vk->do_nonstatic_fields(&print_field);
427 st->cr();
428 }
429 int remaining = fa->length() - print_len;
430 if (remaining > 0) {
431 st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
432 }
433 }
434
435 // Verification
436 class VerifyElementClosure: public BasicOopIterateClosure {
437 public:
438 virtual void do_oop(oop* p) { VerifyOopClosure::verify_oop.do_oop(p); }
439 virtual void do_oop(narrowOop* p) { VerifyOopClosure::verify_oop.do_oop(p); }
440 };
441
442 void FlatArrayKlass::oop_verify_on(oop obj, outputStream* st) {
443 ObjArrayKlass::oop_verify_on(obj, st);
444 guarantee(obj->is_flatArray(), "must be flatArray");
445
446 if (contains_oops()) {
447 flatArrayOop va = flatArrayOop(obj);
448 VerifyElementClosure ec;
449 va->oop_iterate(&ec);
450 }
451 }
452
453 void FlatArrayKlass::verify_on(outputStream* st) {
454 ArrayKlass::verify_on(st);
455 guarantee(element_klass()->is_inline_klass(), "should be inline type klass");
456 }