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   return JVM_ACC_ABSTRACT | JVM_ACC_FINAL | JVM_ACC_PUBLIC;
 79 }
 80 
 81 TypeArrayKlass::TypeArrayKlass(BasicType type, Symbol* name) : ArrayKlass(name, Kind) {
 82   set_layout_helper(array_layout_helper(type));
 83   assert(is_array_klass(), "sanity");
 84   assert(is_typeArray_klass(), "sanity");
 85 
 86   set_max_length(arrayOopDesc::max_array_length(type));
 87   assert(size() >= TypeArrayKlass::header_size(), "bad size");
 88 
 89   set_class_loader_data(ClassLoaderData::the_null_class_loader_data());
 90 
 91   // Compute modifier flags.
 92   set_modifier_flags(compute_modifier_flags());
 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   // For typeArrays this is only called for the last dimension
105   assert(rank == 1, "just checking");
106   int length = *last_size;
107   return allocate(length, THREAD);
108 }
109 
110 
111 void TypeArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) {
112   assert(s->is_typeArray(), "must be type array");
113 
114   // Check destination type.
115   if (!d->is_typeArray()) {
116     ResourceMark rm(THREAD);
117     stringStream ss;
118     if (d->is_objArray()) {
119       ss.print("arraycopy: type mismatch: can not copy %s[] into object array[]",
120                type2name_tab[ArrayKlass::cast(s->klass())->element_type()]);
121     } else {
122       ss.print("arraycopy: destination type %s is not an array", d->klass()->external_name());
123     }
124     THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
125   }
126   if (element_type() != TypeArrayKlass::cast(d->klass())->element_type()) {
127     ResourceMark rm(THREAD);
128     stringStream ss;
129     ss.print("arraycopy: type mismatch: can not copy %s[] into %s[]",
130              type2name_tab[ArrayKlass::cast(s->klass())->element_type()],
131              type2name_tab[ArrayKlass::cast(d->klass())->element_type()]);
132     THROW_MSG(vmSymbols::java_lang_ArrayStoreException(), ss.as_string());
133   }
134 
135   // Check if all offsets and lengths are non negative.
136   if (src_pos < 0 || dst_pos < 0 || length < 0) {
137     // Pass specific exception reason.
138     ResourceMark rm(THREAD);
139     stringStream ss;
140     if (src_pos < 0) {
141       ss.print("arraycopy: source index %d out of bounds for %s[%d]",
142                src_pos, type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
143     } else if (dst_pos < 0) {
144       ss.print("arraycopy: destination index %d out of bounds for %s[%d]",
145                dst_pos, type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
146     } else {
147       ss.print("arraycopy: length %d is negative", length);
148     }
149     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
150   }
151   // Check if the ranges are valid
152   if ((((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) ||
153       (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length())) {
154     // Pass specific exception reason.
155     ResourceMark rm(THREAD);
156     stringStream ss;
157     if (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) {
158       ss.print("arraycopy: last source index %u out of bounds for %s[%d]",
159                (unsigned int) length + (unsigned int) src_pos,
160                type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
161     } else {
162       ss.print("arraycopy: last destination index %u out of bounds for %s[%d]",
163                (unsigned int) length + (unsigned int) dst_pos,
164                type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
165     }
166     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
167   }
168   // Check zero copy
169   if (length == 0)
170     return;
171 
172   // This is an attempt to make the copy_array fast.
173   int l2es = log2_element_size();
174   size_t src_offset = arrayOopDesc::base_offset_in_bytes(element_type()) + ((size_t)src_pos << l2es);
175   size_t dst_offset = arrayOopDesc::base_offset_in_bytes(element_type()) + ((size_t)dst_pos << l2es);
176   ArrayAccess<ARRAYCOPY_ATOMIC>::arraycopy<void>(s, src_offset, d, dst_offset, (size_t)length << l2es);
177 }
178 
179 size_t TypeArrayKlass::oop_size(oop obj, markWord mark) const {
180   // In this assert, we cannot safely access the Klass* with compact headers.
181   assert(UseCompactObjectHeaders || obj->is_typeArray(),"must be a type array");
182   typeArrayOop t = typeArrayOop(obj);
183   int length = LP64_ONLY(UseCompactObjectHeaders ? mark.array_length() :) t->length();
184   return t->object_size(this, length);
185 }
186 
187 void TypeArrayKlass::initialize(TRAPS) {
188   // Nothing to do. Having this function is handy since objArrayKlasses can be
189   // initialized by calling initialize on their bottom_klass, see ObjArrayKlass::initialize
190 }
191 
192 const char* TypeArrayKlass::external_name(BasicType type) {
193   switch (type) {
194     case T_BOOLEAN: return "[Z";
195     case T_CHAR:    return "[C";
196     case T_FLOAT:   return "[F";
197     case T_DOUBLE:  return "[D";
198     case T_BYTE:    return "[B";
199     case T_SHORT:   return "[S";
200     case T_INT:     return "[I";
201     case T_LONG:    return "[J";
202     default: ShouldNotReachHere();
203   }
204   return nullptr;
205 }
206 
207 
208 // Printing
209 
210 void TypeArrayKlass::print_on(outputStream* st) const {
211 #ifndef PRODUCT
212   assert(is_klass(), "must be klass");
213   print_value_on(st);
214   Klass::print_on(st);
215 #endif //PRODUCT
216 }
217 
218 void TypeArrayKlass::print_value_on(outputStream* st) const {
219   assert(is_klass(), "must be klass");
220   st->print("{type array ");
221   BasicType bt = element_type();
222   if (bt == T_BOOLEAN) {
223     st->print("bool");
224   } else {
225     st->print("%s", type2name_tab[bt]);
226   }
227   st->print("}");
228 }
229 
230 static void print_boolean_array(typeArrayOop ta, int print_len, outputStream* st) {
231   for (int index = 0; index < print_len; index++) {
232     st->print_cr(" - %3d: %s", index, (ta->bool_at(index) == 0) ? "false" : "true");
233   }
234 }
235 
236 
237 static void print_char_array(typeArrayOop ta, int print_len, outputStream* st) {
238   for (int index = 0; index < print_len; index++) {
239     jchar c = ta->char_at(index);
240     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
241   }
242 }
243 
244 
245 static void print_float_array(typeArrayOop ta, int print_len, outputStream* st) {
246   for (int index = 0; index < print_len; index++) {
247     st->print_cr(" - %3d: %g", index, ta->float_at(index));
248   }
249 }
250 
251 
252 static void print_double_array(typeArrayOop ta, int print_len, outputStream* st) {
253   for (int index = 0; index < print_len; index++) {
254     st->print_cr(" - %3d: %g", index, ta->double_at(index));
255   }
256 }
257 
258 
259 static void print_byte_array(typeArrayOop ta, int print_len, outputStream* st) {
260   for (int index = 0; index < print_len; index++) {
261     jbyte c = ta->byte_at(index);
262     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
263   }
264 }
265 
266 
267 static void print_short_array(typeArrayOop ta, int print_len, outputStream* st) {
268   for (int index = 0; index < print_len; index++) {
269     int v = ta->ushort_at(index);
270     st->print_cr(" - %3d: 0x%x\t %d", index, v, v);
271   }
272 }
273 
274 
275 static void print_int_array(typeArrayOop ta, int print_len, outputStream* st) {
276   for (int index = 0; index < print_len; index++) {
277     jint v = ta->int_at(index);
278     st->print_cr(" - %3d: 0x%x %d", index, v, v);
279   }
280 }
281 
282 
283 static void print_long_array(typeArrayOop ta, int print_len, outputStream* st) {
284   for (int index = 0; index < print_len; index++) {
285     jlong v = ta->long_at(index);
286     st->print_cr(" - %3d: 0x%x 0x%x", index, high(v), low(v));
287   }
288 }
289 
290 
291 void TypeArrayKlass::oop_print_on(oop obj, outputStream* st) {
292   ArrayKlass::oop_print_on(obj, st);
293   oop_print_elements_on(typeArrayOop(obj), st);
294 }
295 
296 void TypeArrayKlass::oop_print_elements_on(typeArrayOop ta, outputStream* st) {
297   int print_len = MIN2(ta->length(), MaxElementPrintSize);
298   switch (element_type()) {
299     case T_BOOLEAN: print_boolean_array(ta, print_len, st); break;
300     case T_CHAR:    print_char_array(ta, print_len, st);    break;
301     case T_FLOAT:   print_float_array(ta, print_len, st);   break;
302     case T_DOUBLE:  print_double_array(ta, print_len, st);  break;
303     case T_BYTE:    print_byte_array(ta, print_len, st);    break;
304     case T_SHORT:   print_short_array(ta, print_len, st);   break;
305     case T_INT:     print_int_array(ta, print_len, st);     break;
306     case T_LONG:    print_long_array(ta, print_len, st);    break;
307     default: ShouldNotReachHere();
308   }
309   int remaining = ta->length() - print_len;
310   if (remaining > 0) {
311     st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
312   }
313 }
314 
315 const char* TypeArrayKlass::internal_name() const {
316   return Klass::external_name();
317 }
318 
319 // A TypeArrayKlass is an array of a primitive type, its defining module is java.base
320 ModuleEntry* TypeArrayKlass::module() const {
321   return ModuleEntryTable::javabase_moduleEntry();
322 }
323 
324 PackageEntry* TypeArrayKlass::package() const {
325   return nullptr;
326 }