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