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