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     ResourceMark rm(THREAD);
 120     stringStream ss;
 121     ss.print("%d", length);
 122     THROW_MSG_0(vmSymbols::java_lang_NegativeArraySizeException(), ss.as_string());
 123   }
 124 }
 125 
 126 oop TypeArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
 127   // For typeArrays this is only called for the last dimension
 128   assert(rank == 1, "just checking");
 129   int length = *last_size;
 130   return allocate(length, THREAD);
 131 }
 132 
 133 
 134 void TypeArrayKlass::copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) {
 135   assert(s->is_typeArray(), "must be type array");
 136 
 137   // Check destination
 138   if (!d->is_typeArray() || element_type() != TypeArrayKlass::cast(d->klass())->element_type()) {
 139     THROW(vmSymbols::java_lang_ArrayStoreException());
 140   }
 141 
 142   // Check is all offsets and lengths are non negative
 143   if (src_pos < 0 || dst_pos < 0 || length < 0) {
 144     // Pass specific exception reason.
 145     ResourceMark rm;
 146     stringStream ss;
 147     if (src_pos < 0) {
 148       ss.print("arraycopy: source index %d out of bounds for %s[%d]",
 149                src_pos, type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
 150     } else if (dst_pos < 0) {
 151       ss.print("arraycopy: destination index %d out of bounds for %s[%d]",
 152                dst_pos, type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
 153     } else {
 154       ss.print("arraycopy: length %d is negative", length);
 155     }
 156     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
 157   }
 158   // Check if the ranges are valid
 159   if ((((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) ||
 160       (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length())) {
 161     // Pass specific exception reason.
 162     ResourceMark rm;
 163     stringStream ss;
 164     if (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length()) {
 165       ss.print("arraycopy: last source index %u out of bounds for %s[%d]",
 166                (unsigned int) length + (unsigned int) src_pos,
 167                type2name_tab[ArrayKlass::cast(s->klass())->element_type()], s->length());
 168     } else {
 169       ss.print("arraycopy: last destination index %u out of bounds for %s[%d]",
 170                (unsigned int) length + (unsigned int) dst_pos,
 171                type2name_tab[ArrayKlass::cast(d->klass())->element_type()], d->length());
 172     }
 173     THROW_MSG(vmSymbols::java_lang_ArrayIndexOutOfBoundsException(), ss.as_string());
 174   }
 175   // Check zero copy
 176   if (length == 0)
 177     return;
 178 
 179   // This is an attempt to make the copy_array fast.
 180   int l2es = log2_element_size();
 181   int ihs = array_header_in_bytes() / wordSize;
 182   void* src = (char*) (s->base(element_type())) + ((size_t)src_pos << l2es);
 183   void* dst = (char*) (d->base(element_type())) + ((size_t)dst_pos << l2es);
 184   HeapAccess<ARRAYCOPY_ATOMIC>::arraycopy(s, d, src, dst, (size_t)length << l2es);
 185 }
 186 
 187 // create a klass of array holding typeArrays
 188 Klass* TypeArrayKlass::array_klass_impl(bool or_null, int n, TRAPS) {
 189   int dim = dimension();
 190   assert(dim <= n, "check order of chain");
 191     if (dim == n)
 192       return this;
 193 
 194   // lock-free read needs acquire semantics
 195   if (higher_dimension_acquire() == NULL) {
 196     if (or_null)  return NULL;
 197 
 198     ResourceMark rm;
 199     JavaThread *jt = (JavaThread *)THREAD;
 200     {
 201       MutexLocker mc(Compile_lock, THREAD);   // for vtables
 202       // Atomic create higher dimension and link into list
 203       MutexLocker mu(MultiArray_lock, THREAD);
 204 
 205       if (higher_dimension() == NULL) {
 206         Klass* oak = ObjArrayKlass::allocate_objArray_klass(
 207               class_loader_data(), dim + 1, this, CHECK_NULL);
 208         ObjArrayKlass* h_ak = ObjArrayKlass::cast(oak);
 209         h_ak->set_lower_dimension(this);
 210         // use 'release' to pair with lock-free load
 211         release_set_higher_dimension(h_ak);
 212         assert(h_ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass");
 213       }
 214     }
 215   } else {
 216     CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
 217   }
 218   ObjArrayKlass* h_ak = ObjArrayKlass::cast(higher_dimension());
 219   if (or_null) {
 220     return h_ak->array_klass_or_null(n);
 221   }
 222   return h_ak->array_klass(n, THREAD);
 223 }
 224 
 225 Klass* TypeArrayKlass::array_klass_impl(bool or_null, TRAPS) {
 226   return array_klass_impl(or_null, dimension() +  1, THREAD);
 227 }
 228 
 229 int TypeArrayKlass::oop_size(oop obj) const {
 230   assert(obj->is_typeArray(),"must be a type array");
 231   typeArrayOop t = typeArrayOop(obj);
 232   return t->object_size();
 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 }