1 /*
   2  * Copyright (c) 1997, 2019, 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/systemDictionary.hpp"
  30 #include "classfile/vmSymbols.hpp"
  31 #include "gc/shared/collectedHeap.hpp"
  32 #include "gc/shared/collectedHeap.inline.hpp"
  33 #include "memory/metadataFactory.hpp"
  34 #include "memory/resourceArea.hpp"
  35 #include "memory/universe.hpp"
  36 #include "oops/arrayKlass.inline.hpp"
  37 #include "oops/instanceKlass.hpp"
  38 #include "oops/klass.inline.hpp"
  39 #include "oops/objArrayKlass.hpp"
  40 #include "oops/oop.inline.hpp"
  41 #include "oops/typeArrayKlass.inline.hpp"
  42 #include "oops/typeArrayOop.inline.hpp"
  43 #include "runtime/handles.inline.hpp"
  44 #include "utilities/macros.hpp"
  45 
  46 TypeArrayKlass* TypeArrayKlass::create_klass(BasicType type,
  47                                       const char* name_str, TRAPS) {
  48   Symbol* sym = NULL;
  49   if (name_str != NULL) {
  50     sym = SymbolTable::new_permanent_symbol(name_str);
  51   }
  52 
  53   ClassLoaderData* null_loader_data = ClassLoaderData::the_null_class_loader_data();
  54 
  55   TypeArrayKlass* ak = TypeArrayKlass::allocate(null_loader_data, type, sym, CHECK_NULL);
  56 
  57   // Call complete_create_array_klass after all instance variables have been initialized.
  58   complete_create_array_klass(ak, ak->super(), ModuleEntryTable::javabase_moduleEntry(), CHECK_NULL);
  59 
  60   // Add all classes to our internal class loader list here,
  61   // including classes in the bootstrap (NULL) class loader.
  62   // Do this step after creating the mirror so that if the
  63   // mirror creation fails, loaded_classes_do() doesn't find
  64   // an array class without a mirror.
  65   null_loader_data->add_class(ak);
  66 
  67   return ak;
  68 }
  69 
  70 TypeArrayKlass* TypeArrayKlass::allocate(ClassLoaderData* loader_data, BasicType type, Symbol* name, TRAPS) {
  71   assert(TypeArrayKlass::header_size() <= InstanceKlass::header_size(),
  72       "array klasses must be same size as InstanceKlass");
  73 
  74   int size = ArrayKlass::static_size(TypeArrayKlass::header_size());
  75 
  76   return new (loader_data, size, THREAD) TypeArrayKlass(type, name);
  77 }
  78 
  79 TypeArrayKlass::TypeArrayKlass(BasicType type, Symbol* name) : ArrayKlass(name, ID) {
  80   set_layout_helper(array_layout_helper(type));
  81   assert(is_array_klass(), "sanity");
  82   assert(is_typeArray_klass(), "sanity");
  83 
  84   set_max_length(arrayOopDesc::max_array_length(type));
  85   assert(size() >= TypeArrayKlass::header_size(), "bad size");
  86 
  87   set_class_loader_data(ClassLoaderData::the_null_class_loader_data());
  88 }
  89 
  90 typeArrayOop TypeArrayKlass::allocate_common(int length, bool do_zero, TRAPS) {
  91   assert(log2_element_size() >= 0, "bad scale");
  92   check_array_allocation_length(length, max_length(), CHECK_NULL);
  93   size_t size = typeArrayOopDesc::object_size(layout_helper(), length);
  94   return (typeArrayOop)Universe::heap()->array_allocate(this, (int)size, length,
  95                                                         do_zero, CHECK_NULL);
  96 }
  97 
  98 oop TypeArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
  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_impl(ArrayStorageProperties storage_props, bool or_null, int n, TRAPS) {
 175   assert(storage_props.is_empty(), "Didn't expect storage properties");
 176   int dim = dimension();
 177   assert(dim <= n, "check order of chain");
 178     if (dim == n)
 179       return this;
 180 
 181   // lock-free read needs acquire semantics
 182   if (higher_dimension_acquire() == NULL) {
 183     if (or_null)  return NULL;
 184 
 185     ResourceMark rm;
 186     {
 187       // Atomic create higher dimension and link into list
 188       MutexLocker mu(MultiArray_lock, THREAD);
 189 
 190       if (higher_dimension() == NULL) {
 191         Klass* oak = ObjArrayKlass::allocate_objArray_klass(
 192               ArrayStorageProperties::empty, dim + 1, this, CHECK_NULL);
 193         ObjArrayKlass* h_ak = ObjArrayKlass::cast(oak);
 194         h_ak->set_lower_dimension(this);
 195         // use 'release' to pair with lock-free load
 196         release_set_higher_dimension(h_ak);
 197         assert(h_ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass");
 198       }
 199     }
 200   } else {
 201     CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
 202   }
 203   ObjArrayKlass* h_ak = ObjArrayKlass::cast(higher_dimension());
 204   if (or_null) {
 205     return h_ak->array_klass_or_null(storage_props, n);
 206   }
 207   return h_ak->array_klass(storage_props, n, THREAD);
 208 }
 209 
 210 Klass* TypeArrayKlass::array_klass_impl(ArrayStorageProperties storage_props, bool or_null, TRAPS) {
 211   return array_klass_impl(storage_props, or_null, dimension() +  1, THREAD);
 212 }
 213 
 214 int TypeArrayKlass::oop_size(oop obj) const {
 215   assert(obj->is_typeArray(),"must be a type array");
 216   typeArrayOop t = typeArrayOop(obj);
 217   return t->object_size();
 218 }
 219 
 220 void TypeArrayKlass::initialize(TRAPS) {
 221   // Nothing to do. Having this function is handy since objArrayKlasses can be
 222   // initialized by calling initialize on their bottom_klass, see ObjArrayKlass::initialize
 223 }
 224 
 225 const char* TypeArrayKlass::external_name(BasicType type) {
 226   switch (type) {
 227     case T_BOOLEAN: return "[Z";
 228     case T_CHAR:    return "[C";
 229     case T_FLOAT:   return "[F";
 230     case T_DOUBLE:  return "[D";
 231     case T_BYTE:    return "[B";
 232     case T_SHORT:   return "[S";
 233     case T_INT:     return "[I";
 234     case T_LONG:    return "[J";
 235     default: ShouldNotReachHere();
 236   }
 237   return NULL;
 238 }
 239 
 240 
 241 // Printing
 242 
 243 void TypeArrayKlass::print_on(outputStream* st) const {
 244 #ifndef PRODUCT
 245   assert(is_klass(), "must be klass");
 246   print_value_on(st);
 247   Klass::print_on(st);
 248 #endif //PRODUCT
 249 }
 250 
 251 void TypeArrayKlass::print_value_on(outputStream* st) const {
 252   assert(is_klass(), "must be klass");
 253   st->print("{type array ");
 254   BasicType bt = element_type();
 255   if (bt == T_BOOLEAN) {
 256     st->print("bool");
 257   } else {
 258     st->print("%s", type2name_tab[bt]);
 259   }
 260   st->print("}");
 261 }
 262 
 263 #ifndef PRODUCT
 264 
 265 static void print_boolean_array(typeArrayOop ta, int print_len, outputStream* st) {
 266   for (int index = 0; index < print_len; index++) {
 267     st->print_cr(" - %3d: %s", index, (ta->bool_at(index) == 0) ? "false" : "true");
 268   }
 269 }
 270 
 271 
 272 static void print_char_array(typeArrayOop ta, int print_len, outputStream* st) {
 273   for (int index = 0; index < print_len; index++) {
 274     jchar c = ta->char_at(index);
 275     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
 276   }
 277 }
 278 
 279 
 280 static void print_float_array(typeArrayOop ta, int print_len, outputStream* st) {
 281   for (int index = 0; index < print_len; index++) {
 282     st->print_cr(" - %3d: %g", index, ta->float_at(index));
 283   }
 284 }
 285 
 286 
 287 static void print_double_array(typeArrayOop ta, int print_len, outputStream* st) {
 288   for (int index = 0; index < print_len; index++) {
 289     st->print_cr(" - %3d: %g", index, ta->double_at(index));
 290   }
 291 }
 292 
 293 
 294 static void print_byte_array(typeArrayOop ta, int print_len, outputStream* st) {
 295   for (int index = 0; index < print_len; index++) {
 296     jbyte c = ta->byte_at(index);
 297     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
 298   }
 299 }
 300 
 301 
 302 static void print_short_array(typeArrayOop ta, int print_len, outputStream* st) {
 303   for (int index = 0; index < print_len; index++) {
 304     int v = ta->ushort_at(index);
 305     st->print_cr(" - %3d: 0x%x\t %d", index, v, v);
 306   }
 307 }
 308 
 309 
 310 static void print_int_array(typeArrayOop ta, int print_len, outputStream* st) {
 311   for (int index = 0; index < print_len; index++) {
 312     jint v = ta->int_at(index);
 313     st->print_cr(" - %3d: 0x%x %d", index, v, v);
 314   }
 315 }
 316 
 317 
 318 static void print_long_array(typeArrayOop ta, int print_len, outputStream* st) {
 319   for (int index = 0; index < print_len; index++) {
 320     jlong v = ta->long_at(index);
 321     st->print_cr(" - %3d: 0x%x 0x%x", index, high(v), low(v));
 322   }
 323 }
 324 
 325 
 326 void TypeArrayKlass::oop_print_on(oop obj, outputStream* st) {
 327   ArrayKlass::oop_print_on(obj, st);
 328   typeArrayOop ta = typeArrayOop(obj);
 329   int print_len = MIN2((intx) ta->length(), MaxElementPrintSize);
 330   switch (element_type()) {
 331     case T_BOOLEAN: print_boolean_array(ta, print_len, st); break;
 332     case T_CHAR:    print_char_array(ta, print_len, st);    break;
 333     case T_FLOAT:   print_float_array(ta, print_len, st);   break;
 334     case T_DOUBLE:  print_double_array(ta, print_len, st);  break;
 335     case T_BYTE:    print_byte_array(ta, print_len, st);    break;
 336     case T_SHORT:   print_short_array(ta, print_len, st);   break;
 337     case T_INT:     print_int_array(ta, print_len, st);     break;
 338     case T_LONG:    print_long_array(ta, print_len, st);    break;
 339     default: ShouldNotReachHere();
 340   }
 341   int remaining = ta->length() - print_len;
 342   if (remaining > 0) {
 343     st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
 344   }
 345 }
 346 
 347 #endif // PRODUCT
 348 
 349 const char* TypeArrayKlass::internal_name() const {
 350   return Klass::external_name();
 351 }
 352 
 353 // A TypeArrayKlass is an array of a primitive type, its defining module is java.base
 354 ModuleEntry* TypeArrayKlass::module() const {
 355   return ModuleEntryTable::javabase_moduleEntry();
 356 }
 357 
 358 PackageEntry* TypeArrayKlass::package() const {
 359   return NULL;
 360 }