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_MSG_0(vmSymbols::java_lang_NegativeArraySizeException(), err_msg("%d", length));
 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("arraycopy: source index %d out of bounds for %s[%d]",
 146                src_pos, type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
 147     } else if (dst_pos < 0) {
 148       ss.print("arraycopy: destination index %d out of bounds for %s[%d]",
 149                dst_pos, type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
 150     } else {
 151       ss.print("arraycopy: length %d is negative", length);
 152     }
 153     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
 154   }
 155   // Check if the ranges are valid
 156   if ((((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) ||
 157       (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length())) {
 158     // Pass specific exception reason.
 159     ResourceMark rm;
 160     stringStream ss;
 161     if (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) {
 162       ss.print("arraycopy: last source index %u out of bounds for %s[%d]",
 163                (unsigned int) length + (unsigned int) src_pos,
 164                type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
 165     } else {
 166       ss.print("arraycopy: last destination index %u out of bounds for %s[%d]",
 167                (unsigned int) length + (unsigned int) dst_pos,
 168                type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
 169     }
 170     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
 171   }
 172   // Check zero copy
 173   if (length == 0)
 174     return;
 175 
 176   // This is an attempt to make the copy_array fast.
 177   int l2es = log2_element_size();
 178   size_t src_offset = arrayOopDesc::base_offset_in_bytes(element_type()) + ((size_t)src_pos << l2es);
 179   size_t dst_offset = arrayOopDesc::base_offset_in_bytes(element_type()) + ((size_t)dst_pos << l2es);
 180   ArrayAccess<ARRAYCOPY_ATOMIC>::arraycopy<void>(s, src_offset, d, dst_offset, (size_t)length << l2es);
 181 }
 182 
 183 // create a klass of array holding typeArrays
 184 Klass* TypeArrayKlass::array_klass_impl(bool or_null, int n, TRAPS) {
 185   int dim = dimension();
 186   assert(dim <= n, "check order of chain");
 187     if (dim == n)
 188       return this;
 189 
 190   // lock-free read needs acquire semantics
 191   if (higher_dimension_acquire() == NULL) {
 192     if (or_null)  return NULL;
 193 
 194     ResourceMark rm;
 195     JavaThread *jt = (JavaThread *)THREAD;
 196     {
 197       MutexLocker mc(Compile_lock, THREAD);   // for vtables
 198       // Atomic create higher dimension and link into list
 199       MutexLocker mu(MultiArray_lock, THREAD);
 200 
 201       if (higher_dimension() == NULL) {
 202         Klass* oak = ObjArrayKlass::allocate_objArray_klass(
 203               class_loader_data(), dim + 1, this, CHECK_NULL);
 204         ObjArrayKlass* h_ak = ObjArrayKlass::cast(oak);
 205         h_ak->set_lower_dimension(this);
 206         // use 'release' to pair with lock-free load
 207         release_set_higher_dimension(h_ak);
 208         assert(h_ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass");
 209       }
 210     }
 211   } else {
 212     CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
 213   }
 214   ObjArrayKlass* h_ak = ObjArrayKlass::cast(higher_dimension());
 215   if (or_null) {
 216     return h_ak->array_klass_or_null(n);
 217   }
 218   return h_ak->array_klass(n, THREAD);
 219 }
 220 
 221 Klass* TypeArrayKlass::array_klass_impl(bool or_null, TRAPS) {
 222   return array_klass_impl(or_null, dimension() +  1, THREAD);
 223 }
 224 
 225 int TypeArrayKlass::oop_size(oop obj) const {
 226   assert(obj->is_typeArray(),"must be a type array");
 227   typeArrayOop t = typeArrayOop(obj);
 228   return t->object_size();
 229 }
 230 
 231 void TypeArrayKlass::initialize(TRAPS) {
 232   // Nothing to do. Having this function is handy since objArrayKlasses can be
 233   // initialized by calling initialize on their bottom_klass, see ObjArrayKlass::initialize
 234 }
 235 
 236 const char* TypeArrayKlass::external_name(BasicType type) {
 237   switch (type) {
 238     case T_BOOLEAN: return "[Z";
 239     case T_CHAR:    return "[C";
 240     case T_FLOAT:   return "[F";
 241     case T_DOUBLE:  return "[D";
 242     case T_BYTE:    return "[B";
 243     case T_SHORT:   return "[S";
 244     case T_INT:     return "[I";
 245     case T_LONG:    return "[J";
 246     default: ShouldNotReachHere();
 247   }
 248   return NULL;
 249 }
 250 
 251 
 252 // Printing
 253 
 254 void TypeArrayKlass::print_on(outputStream* st) const {
 255 #ifndef PRODUCT
 256   assert(is_klass(), "must be klass");
 257   print_value_on(st);
 258   Klass::print_on(st);
 259 #endif //PRODUCT
 260 }
 261 
 262 void TypeArrayKlass::print_value_on(outputStream* st) const {
 263   assert(is_klass(), "must be klass");
 264   st->print("{type array ");
 265   BasicType bt = element_type();
 266   if (bt == T_BOOLEAN) {
 267     st->print("bool");
 268   } else {
 269     st->print("%s", type2name_tab[bt]);
 270   }
 271   st->print("}");
 272 }
 273 
 274 #ifndef PRODUCT
 275 
 276 static void print_boolean_array(typeArrayOop ta, int print_len, outputStream* st) {
 277   for (int index = 0; index < print_len; index++) {
 278     st->print_cr(" - %3d: %s", index, (ta->bool_at(index) == 0) ? "false" : "true");
 279   }
 280 }
 281 
 282 
 283 static void print_char_array(typeArrayOop ta, int print_len, outputStream* st) {
 284   for (int index = 0; index < print_len; index++) {
 285     jchar c = ta->char_at(index);
 286     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
 287   }
 288 }
 289 
 290 
 291 static void print_float_array(typeArrayOop ta, int print_len, outputStream* st) {
 292   for (int index = 0; index < print_len; index++) {
 293     st->print_cr(" - %3d: %g", index, ta->float_at(index));
 294   }
 295 }
 296 
 297 
 298 static void print_double_array(typeArrayOop ta, int print_len, outputStream* st) {
 299   for (int index = 0; index < print_len; index++) {
 300     st->print_cr(" - %3d: %g", index, ta->double_at(index));
 301   }
 302 }
 303 
 304 
 305 static void print_byte_array(typeArrayOop ta, int print_len, outputStream* st) {
 306   for (int index = 0; index < print_len; index++) {
 307     jbyte c = ta->byte_at(index);
 308     st->print_cr(" - %3d: %x %c", index, c, isprint(c) ? c : ' ');
 309   }
 310 }
 311 
 312 
 313 static void print_short_array(typeArrayOop ta, int print_len, outputStream* st) {
 314   for (int index = 0; index < print_len; index++) {
 315     int v = ta->ushort_at(index);
 316     st->print_cr(" - %3d: 0x%x\t %d", index, v, v);
 317   }
 318 }
 319 
 320 
 321 static void print_int_array(typeArrayOop ta, int print_len, outputStream* st) {
 322   for (int index = 0; index < print_len; index++) {
 323     jint v = ta->int_at(index);
 324     st->print_cr(" - %3d: 0x%x %d", index, v, v);
 325   }
 326 }
 327 
 328 
 329 static void print_long_array(typeArrayOop ta, int print_len, outputStream* st) {
 330   for (int index = 0; index < print_len; index++) {
 331     jlong v = ta->long_at(index);
 332     st->print_cr(" - %3d: 0x%x 0x%x", index, high(v), low(v));
 333   }
 334 }
 335 
 336 
 337 void TypeArrayKlass::oop_print_on(oop obj, outputStream* st) {
 338   ArrayKlass::oop_print_on(obj, st);
 339   typeArrayOop ta = typeArrayOop(obj);
 340   int print_len = MIN2((intx) ta->length(), MaxElementPrintSize);
 341   switch (element_type()) {
 342     case T_BOOLEAN: print_boolean_array(ta, print_len, st); break;
 343     case T_CHAR:    print_char_array(ta, print_len, st);    break;
 344     case T_FLOAT:   print_float_array(ta, print_len, st);   break;
 345     case T_DOUBLE:  print_double_array(ta, print_len, st);  break;
 346     case T_BYTE:    print_byte_array(ta, print_len, st);    break;
 347     case T_SHORT:   print_short_array(ta, print_len, st);   break;
 348     case T_INT:     print_int_array(ta, print_len, st);     break;
 349     case T_LONG:    print_long_array(ta, print_len, st);    break;
 350     default: ShouldNotReachHere();
 351   }
 352   int remaining = ta->length() - print_len;
 353   if (remaining > 0) {
 354     st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
 355   }
 356 }
 357 
 358 #endif // PRODUCT
 359 
 360 const char* TypeArrayKlass::internal_name() const {
 361   return Klass::external_name();
 362 }
 363 
 364 // A TypeArrayKlass is an array of a primitive type, its defining module is java.base
 365 ModuleEntry* TypeArrayKlass::module() const {
 366   return ModuleEntryTable::javabase_moduleEntry();
 367 }
 368 
 369 PackageEntry* TypeArrayKlass::package() const {
 370   return NULL;
 371 }