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 #include "classfile/moduleEntry.hpp"
 26 #include "classfile/packageEntry.hpp"
 27 #include "classfile/symbolTable.hpp"
 28 #include "classfile/vmSymbols.hpp"
 29 #include "gc/shared/collectedHeap.hpp"
 30 #include "gc/shared/collectedHeap.inline.hpp"
 31 #include "memory/metadataFactory.hpp"
 32 #include "memory/resourceArea.hpp"
 33 #include "memory/universe.hpp"
 34 #include "oops/arrayKlass.hpp"
 35 #include "oops/instanceKlass.hpp"
 36 #include "oops/klass.inline.hpp"
 37 #include "oops/objArrayKlass.hpp"
 38 #include "oops/oop.inline.hpp"
 39 #include "oops/typeArrayKlass.inline.hpp"
 40 #include "oops/typeArrayOop.inline.hpp"
 41 #include "runtime/handles.inline.hpp"
 42 #include "utilities/macros.hpp"
 43 
 44 TypeArrayKlass* TypeArrayKlass::create_klass(BasicType type,
 45                                       const char* name_str, TRAPS) {
 46   Symbol* sym = nullptr;
 47   if (name_str != nullptr) {
 48     sym = SymbolTable::new_permanent_symbol(name_str);
 49   }
 50 
 51   ClassLoaderData* null_loader_data = ClassLoaderData::the_null_class_loader_data();
 52 
 53   TypeArrayKlass* ak = TypeArrayKlass::allocate(null_loader_data, type, sym, CHECK_NULL);
 54 
 55   // Call complete_create_array_klass after all instance variables have been initialized.
 56   complete_create_array_klass(ak, ak->super(), ModuleEntryTable::javabase_moduleEntry(), CHECK_NULL);
 57 
 58   // Add all classes to our internal class loader list here,
 59   // including classes in the bootstrap (null) class loader.
 60   // Do this step after creating the mirror so that if the
 61   // mirror creation fails, loaded_classes_do() doesn't find
 62   // an array class without a mirror.
 63   null_loader_data->add_class(ak);
 64   JFR_ONLY(ASSIGN_PRIMITIVE_CLASS_ID(ak);)
 65   return ak;
 66 }
 67 
 68 TypeArrayKlass* TypeArrayKlass::allocate(ClassLoaderData* loader_data, BasicType type, Symbol* name, TRAPS) {
 69   assert(TypeArrayKlass::header_size() <= InstanceKlass::header_size(),
 70       "array klasses must be same size as InstanceKlass");
 71 
 72   int size = ArrayKlass::static_size(TypeArrayKlass::header_size());
 73 
 74   return new (loader_data, size, THREAD) TypeArrayKlass(type, name);
 75 }
 76 
 77 u2 TypeArrayKlass::compute_modifier_flags() const {
 78   u2 identity_flag = (Arguments::enable_preview()) ? JVM_ACC_IDENTITY : 0;
 79 
 80   return JVM_ACC_ABSTRACT | JVM_ACC_FINAL | JVM_ACC_PUBLIC
 81                     | identity_flag;
 82 }
 83 
 84 TypeArrayKlass::TypeArrayKlass(BasicType type, Symbol* name) : ArrayKlass(name, Kind) {
 85   set_layout_helper(array_layout_helper(type));
 86   assert(is_array_klass(), "sanity");
 87   assert(is_typeArray_klass(), "sanity");
 88 
 89   set_max_length(arrayOopDesc::max_array_length(type));
 90   assert(size() >= TypeArrayKlass::header_size(), "bad size");
 91 
 92   set_class_loader_data(ClassLoaderData::the_null_class_loader_data());
 93 }
 94 
 95 typeArrayOop TypeArrayKlass::allocate_common(int length, bool do_zero, TRAPS) {
 96   assert(log2_element_size() >= 0, "bad scale");
 97   check_array_allocation_length(length, max_length(), CHECK_NULL);
 98   size_t size = typeArrayOopDesc::object_size(layout_helper(), length);
 99   return (typeArrayOop)Universe::heap()->array_allocate(this, size, length,
100                                                         do_zero, CHECK_NULL);
101 }
102 
103 oop TypeArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
104   assert(rank == 1, "just checking");
105   int length = *last_size;
106   return allocate(length, THREAD);
107 }
108 
109 
110 void TypeArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) {
111   assert(s->is_typeArray(), "must be type array");
112 
113   // Check destination type.
114   if (!d->is_typeArray()) {
115     ResourceMark rm(THREAD);
116     stringStream ss;
117     if (d->is_objArray()) {
118       ss.print("arraycopy: type mismatch: can not copy %s[] into object array[]",
119                type2name_tab[ArrayKlass::cast(s->klass())->element_type()]);
120     } else {
121       ss.print("arraycopy: destination type %s is not an array", d->klass()->external_name());
122     }
123     THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
124   }
125   if (element_type() != TypeArrayKlass::cast(d->klass())->element_type()) {
126     ResourceMark rm(THREAD);
127     stringStream ss;
128     ss.print("arraycopy: type mismatch: can not copy %s[] into %s[]",
129              type2name_tab[ArrayKlass::cast(s->klass())->element_type()],
130              type2name_tab[ArrayKlass::cast(d->klass())->element_type()]);
131     THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
132   }
133 
134   // Check if all offsets and lengths are non negative.
135   if (src_pos < 0 || dst_pos < 0 || length < 0) {
136     // Pass specific exception reason.
137     ResourceMark rm(THREAD);
138     stringStream ss;
139     if (src_pos < 0) {
140       ss.print("arraycopy: source index %d out of bounds for %s[%d]",
141                src_pos, type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
142     } else if (dst_pos < 0) {
143       ss.print("arraycopy: destination index %d out of bounds for %s[%d]",
144                dst_pos, type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
145     } else {
146       ss.print("arraycopy: length %d is negative", length);
147     }
148     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
149   }
150   // Check if the ranges are valid
151   if ((((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) ||
152       (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length())) {
153     // Pass specific exception reason.
154     ResourceMark rm(THREAD);
155     stringStream ss;
156     if (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) {
157       ss.print("arraycopy: last source index %u out of bounds for %s[%d]",
158                (unsigned int) length + (unsigned int) src_pos,
159                type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
160     } else {
161       ss.print("arraycopy: last destination index %u out of bounds for %s[%d]",
162                (unsigned int) length + (unsigned int) dst_pos,
163                type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
164     }
165     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
166   }
167   // Check zero copy
168   if (length == 0)
169     return;
170 
171   // This is an attempt to make the copy_array fast.
172   int l2es = log2_element_size();
173   size_t src_offset = arrayOopDesc::base_offset_in_bytes(element_type()) + ((size_t)src_pos << l2es);
174   size_t dst_offset = arrayOopDesc::base_offset_in_bytes(element_type()) + ((size_t)dst_pos << l2es);
175   ArrayAccess<ARRAYCOPY_ATOMIC>::arraycopy<void>(s, src_offset, d, dst_offset, (size_t)length << l2es);
176 }
177 
178 size_t TypeArrayKlass::oop_size(oop obj) const {
179   // In this assert, we cannot safely access the Klass* with compact headers.
180   assert(UseCompactObjectHeaders || obj->is_typeArray(),"must be a type array");
181   typeArrayOop t = typeArrayOop(obj);
182   return t->object_size(this);
183 }
184 
185 void TypeArrayKlass::initialize(TRAPS) {
186   // Nothing to do. Having this function is handy since objArrayKlasses can be
187   // initialized by calling initialize on their bottom_klass, see ObjArrayKlass::initialize
188 }
189 
190 const char* TypeArrayKlass::external_name(BasicType type) {
191   switch (type) {
192     case T_BOOLEAN: return "[Z";
193     case T_CHAR:    return "[C";
194     case T_FLOAT:   return "[F";
195     case T_DOUBLE:  return "[D";
196     case T_BYTE:    return "[B";
197     case T_SHORT:   return "[S";
198     case T_INT:     return "[I";
199     case T_LONG:    return "[J";
200     default: ShouldNotReachHere();
201   }
202   return nullptr;
203 }
204 
205 
206 // Printing
207 
208 void TypeArrayKlass::print_on(outputStream* st) const {
209 #ifndef PRODUCT
210   assert(is_klass(), "must be klass");
211   print_value_on(st);
212   Klass::print_on(st);
213 #endif //PRODUCT
214 }
215 
216 void TypeArrayKlass::print_value_on(outputStream* st) const {
217   assert(is_klass(), "must be klass");
218   st->print("{type array ");
219   BasicType bt = element_type();
220   if (bt == T_BOOLEAN) {
221     st->print("bool");
222   } else {
223     st->print("%s", type2name_tab[bt]);
224   }
225   st->print("}");
226 }
227 
228 static void print_boolean_array(typeArrayOop ta, int print_len, outputStream* st) {
229   for (int index = 0; index < print_len; index++) {
230     st->print_cr(" - %3d: %s", index, (ta->bool_at(index) == 0) ? "false" : "true");
231   }
232 }
233 
234 
235 static void print_char_array(typeArrayOop ta, int print_len, outputStream* st) {
236   for (int index = 0; index < print_len; index++) {
237     jchar c = ta->char_at(index);
238     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
239   }
240 }
241 
242 
243 static void print_float_array(typeArrayOop ta, int print_len, outputStream* st) {
244   for (int index = 0; index < print_len; index++) {
245     st->print_cr(" - %3d: %g", index, ta->float_at(index));
246   }
247 }
248 
249 
250 static void print_double_array(typeArrayOop ta, int print_len, outputStream* st) {
251   for (int index = 0; index < print_len; index++) {
252     st->print_cr(" - %3d: %g", index, ta->double_at(index));
253   }
254 }
255 
256 
257 static void print_byte_array(typeArrayOop ta, int print_len, outputStream* st) {
258   for (int index = 0; index < print_len; index++) {
259     jbyte c = ta->byte_at(index);
260     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
261   }
262 }
263 
264 
265 static void print_short_array(typeArrayOop ta, int print_len, outputStream* st) {
266   for (int index = 0; index < print_len; index++) {
267     int v = ta->ushort_at(index);
268     st->print_cr(" - %3d: 0x%x\t %d", index, v, v);
269   }
270 }
271 
272 
273 static void print_int_array(typeArrayOop ta, int print_len, outputStream* st) {
274   for (int index = 0; index < print_len; index++) {
275     jint v = ta->int_at(index);
276     st->print_cr(" - %3d: 0x%x %d", index, v, v);
277   }
278 }
279 
280 
281 static void print_long_array(typeArrayOop ta, int print_len, outputStream* st) {
282   for (int index = 0; index < print_len; index++) {
283     jlong v = ta->long_at(index);
284     st->print_cr(" - %3d: 0x%x 0x%x", index, high(v), low(v));
285   }
286 }
287 
288 
289 void TypeArrayKlass::oop_print_on(oop obj, outputStream* st) {
290   ArrayKlass::oop_print_on(obj, st);
291   oop_print_elements_on(typeArrayOop(obj), st);
292 }
293 
294 void TypeArrayKlass::oop_print_elements_on(typeArrayOop ta, outputStream* st) {
295   int print_len = MIN2(ta->length(), MaxElementPrintSize);
296   switch (element_type()) {
297     case T_BOOLEAN: print_boolean_array(ta, print_len, st); break;
298     case T_CHAR:    print_char_array(ta, print_len, st);    break;
299     case T_FLOAT:   print_float_array(ta, print_len, st);   break;
300     case T_DOUBLE:  print_double_array(ta, print_len, st);  break;
301     case T_BYTE:    print_byte_array(ta, print_len, st);    break;
302     case T_SHORT:   print_short_array(ta, print_len, st);   break;
303     case T_INT:     print_int_array(ta, print_len, st);     break;
304     case T_LONG:    print_long_array(ta, print_len, st);    break;
305     default: ShouldNotReachHere();
306   }
307   int remaining = ta->length() - print_len;
308   if (remaining > 0) {
309     st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
310   }
311 }
312 
313 const char* TypeArrayKlass::internal_name() const {
314   return Klass::external_name();
315 }
316 
317 // A TypeArrayKlass is an array of a primitive type, its defining module is java.base
318 ModuleEntry* TypeArrayKlass::module() const {
319   return ModuleEntryTable::javabase_moduleEntry();
320 }
321 
322 PackageEntry* TypeArrayKlass::package() const {
323   return nullptr;
324 }