1 /*
   2  * Copyright (c) 2017, 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.inline.hpp"
  32 #include "memory/iterator.inline.hpp"
  33 #include "memory/metadataFactory.hpp"
  34 #include "memory/metaspaceClosure.hpp"
  35 #include "memory/oopFactory.hpp"
  36 #include "memory/resourceArea.hpp"
  37 #include "memory/universe.hpp"
  38 #include "oops/instanceKlass.hpp"
  39 #include "oops/klass.inline.hpp"
  40 #include "oops/objArrayKlass.hpp"
  41 #include "oops/objArrayOop.inline.hpp"
  42 #include "oops/oop.inline.hpp"
  43 #include "oops/arrayKlass.hpp"
  44 #include "oops/arrayOop.hpp"
  45 #include "oops/valueKlass.hpp"
  46 #include "oops/valueArrayOop.hpp"
  47 #include "oops/valueArrayOop.inline.hpp"
  48 #include "oops/verifyOopClosure.hpp"
  49 #include "runtime/handles.inline.hpp"
  50 #include "runtime/mutexLocker.hpp"
  51 #include "utilities/copy.hpp"
  52 #include "utilities/macros.hpp"
  53 
  54 #include "oops/valueArrayKlass.hpp"
  55 
  56 // Allocation...
  57 
  58 ValueArrayKlass::ValueArrayKlass(Klass* element_klass, Symbol* name) : ArrayKlass(name, ID) {
  59   assert(element_klass->is_value(), "Expected Value");
  60 
  61   set_element_klass(ValueKlass::cast(element_klass));
  62   set_class_loader_data(element_klass->class_loader_data());
  63   set_layout_helper(array_layout_helper(ValueKlass::cast(element_klass)));
  64 
  65   assert(is_array_klass(), "sanity");
  66   assert(is_valueArray_klass(), "sanity");
  67 
  68   CMH("tweak name symbol refcnt ?")
  69 #ifndef PRODUCT
  70   if (PrintValueArrayLayout) {
  71     print();
  72   }
  73 #endif
  74 }
  75 
  76 ValueKlass* ValueArrayKlass::element_klass() const {
  77   return ValueKlass::cast(_element_klass);
  78 }
  79 
  80 void ValueArrayKlass::set_element_klass(Klass* k) {
  81   _element_klass = k;
  82 }
  83 
  84 ValueArrayKlass* ValueArrayKlass::allocate_klass(Klass*  element_klass,
  85                                                  Symbol* name,
  86                                                  TRAPS) {
  87   assert(ValueArrayFlatten, "Flatten array required");
  88   assert(ValueKlass::cast(element_klass)->is_atomic() || (!ValueArrayAtomicAccess), "Atomic by-default");
  89 
  90   /*
  91    *  MVT->LWorld, now need to allocate secondaries array types, just like objArrayKlass...
  92    *  ...so now we are trying out covariant array types, just copy objArrayKlass
  93    *  TODO refactor any remaining commonality
  94    */
  95 
  96   // Eagerly allocate the direct array supertype.
  97   Klass* super_klass = NULL;
  98   if (!Universe::is_bootstrapping() || SystemDictionary::Object_klass_loaded()) {
  99     Klass* element_super = element_klass->super();
 100     if (element_super != NULL) {
 101       // The element type has a direct super.  E.g., String[] has direct super of Object[].
 102       super_klass = element_super->array_klass_or_null(ArrayStorageProperties::empty);
 103       bool supers_exist = super_klass != NULL;
 104       // Also, see if the element has secondary supertypes.
 105       // We need an array type for each.
 106       Array<Klass*>* element_supers = element_klass->secondary_supers();
 107       for( int i = element_supers->length()-1; i >= 0; i-- ) {
 108         Klass* elem_super = element_supers->at(i);
 109         if (elem_super->array_klass_or_null(ArrayStorageProperties::empty) == NULL) {
 110           supers_exist = false;
 111           break;
 112         }
 113       }
 114       if (!supers_exist) {
 115         // Oops.  Not allocated yet.  Back out, allocate it, and retry.
 116         Klass* ek = NULL;
 117         {
 118           MutexUnlocker mu(MultiArray_lock);
 119           super_klass = element_super->array_klass(CHECK_0);
 120           for( int i = element_supers->length()-1; i >= 0; i-- ) {
 121             Klass* elem_super = element_supers->at(i);
 122             elem_super->array_klass(CHECK_0);
 123           }
 124           // Now retry from the beginning
 125           ek = element_klass->array_klass(ArrayStorageProperties::flattened_and_null_free, 1, CHECK_0);
 126         }  // re-lock
 127         return ValueArrayKlass::cast(ek);
 128       }
 129     } else {
 130       ShouldNotReachHere(); // Value array klass cannot be the object array klass
 131     }
 132   }
 133 
 134 
 135   ClassLoaderData* loader_data = element_klass->class_loader_data();
 136   int size = ArrayKlass::static_size(ValueArrayKlass::header_size());
 137   ValueArrayKlass* vak = new (loader_data, size, THREAD) ValueArrayKlass(element_klass, name);
 138   if (vak == NULL) {
 139     return NULL;
 140   }
 141   loader_data->add_class(vak);
 142 
 143   ModuleEntry* module = vak->module();
 144   assert(module != NULL, "No module entry for array");
 145   complete_create_array_klass(vak, super_klass, module, CHECK_NULL);
 146   return vak;
 147 }
 148 
 149 ValueArrayKlass* ValueArrayKlass::allocate_klass(ArrayStorageProperties storage_props, Klass* element_klass, TRAPS) {
 150   assert(storage_props.is_flattened(), "Expected flat storage");
 151   Symbol* name = ArrayKlass::create_element_klass_array_name(true, element_klass, CHECK_NULL);
 152   return allocate_klass(element_klass, name, THREAD);
 153 }
 154 
 155 void ValueArrayKlass::initialize(TRAPS) {
 156   element_klass()->initialize(THREAD);
 157 }
 158 
 159 // Oops allocation...
 160 valueArrayOop ValueArrayKlass::allocate(int length, TRAPS) {
 161   if (length < 0) {
 162     THROW_0(vmSymbols::java_lang_NegativeArraySizeException());
 163   }
 164   if (length > max_elements()) {
 165     report_java_out_of_memory("Requested array size exceeds VM limit");
 166     JvmtiExport::post_array_size_exhausted();
 167     THROW_OOP_0(Universe::out_of_memory_error_array_size());
 168   }
 169 
 170   int size = valueArrayOopDesc::object_size(layout_helper(), length);
 171   return (valueArrayOop) Universe::heap()->array_allocate(this, size, length, true, THREAD);
 172 }
 173 
 174 
 175 oop ValueArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
 176   // For valueArrays this is only called for the last dimension
 177   assert(rank == 1, "just checking");
 178   int length = *last_size;
 179   return allocate(length, THREAD);
 180 }
 181 
 182 jint ValueArrayKlass::array_layout_helper(ValueKlass* vk) {
 183   BasicType etype = T_VALUETYPE;
 184   int atag  = _lh_array_tag_vt_value;
 185   int esize = upper_log2(vk->raw_value_byte_size());
 186   int hsize = arrayOopDesc::base_offset_in_bytes(etype);
 187 
 188   int lh = (atag       << _lh_array_tag_shift)
 189     |      (hsize      << _lh_header_size_shift)
 190     |      ((int)etype << _lh_element_type_shift)
 191     |      ((esize)    << _lh_log2_element_size_shift);
 192 
 193   assert(lh < (int)_lh_neutral_value, "must look like an array layout");
 194   assert(layout_helper_is_array(lh), "correct kind");
 195   assert(layout_helper_is_valueArray(lh), "correct kind");
 196   assert(!layout_helper_is_typeArray(lh), "correct kind");
 197   assert(!layout_helper_is_objArray(lh), "correct kind");
 198   assert(layout_helper_header_size(lh) == hsize, "correct decode");
 199   assert(layout_helper_element_type(lh) == etype, "correct decode");
 200   assert(layout_helper_log2_element_size(lh) == esize, "correct decode");
 201   assert((1 << esize) < BytesPerLong || is_aligned(hsize, HeapWordsPerLong), "unaligned base");
 202 
 203   return lh;
 204 }
 205 
 206 int ValueArrayKlass::oop_size(oop obj) const {
 207   assert(obj->is_valueArray(),"must be a value array");
 208   valueArrayOop array = valueArrayOop(obj);
 209   return array->object_size();
 210 }
 211 
 212 jint ValueArrayKlass::max_elements() const {
 213   return arrayOopDesc::max_array_length(arrayOopDesc::header_size(T_VALUETYPE), element_byte_size());
 214 }
 215 
 216 oop ValueArrayKlass::protection_domain() const {
 217   return element_klass()->protection_domain();
 218 }
 219 
 220 void ValueArrayKlass::copy_array(arrayOop s, int src_pos,
 221                                  arrayOop d, int dst_pos, int length, TRAPS) {
 222 
 223   assert(s->is_objArray() || s->is_valueArray(), "must be obj or value array");
 224 
 225    // Check destination
 226    if ((!d->is_valueArray()) && (!d->is_objArray())) {
 227      THROW(vmSymbols::java_lang_ArrayStoreException());
 228    }
 229 
 230    // Check if all offsets and lengths are non negative
 231    if (src_pos < 0 || dst_pos < 0 || length < 0) {
 232      THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
 233    }
 234    // Check if the ranges are valid
 235    if  ( (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length())
 236       || (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length()) ) {
 237      THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
 238    }
 239    // Check zero copy
 240    if (length == 0)
 241      return;
 242 
 243    ArrayKlass* sk = ArrayKlass::cast(s->klass());
 244    ArrayKlass* dk = ArrayKlass::cast(d->klass());
 245    Klass* d_elem_klass = dk->element_klass();
 246    Klass* s_elem_klass = sk->element_klass();
 247    /**** CMH: compare and contrast impl, re-factor once we find edge cases... ****/
 248 
 249    if (sk->is_valueArray_klass()) {
 250      assert(sk == this, "Unexpected call to copy_array");
 251      // Check subtype, all src homogeneous, so just once
 252      if (!s_elem_klass->is_subtype_of(d_elem_klass)) {
 253        THROW(vmSymbols::java_lang_ArrayStoreException());
 254      }
 255 
 256      valueArrayOop sa = valueArrayOop(s);
 257      ValueKlass* s_elem_vklass = element_klass();
 258 
 259      // valueArray-to-valueArray
 260      if (dk->is_valueArray_klass()) {
 261        // element types MUST be exact, subtype check would be dangerous
 262        if (dk != this) {
 263          THROW(vmSymbols::java_lang_ArrayStoreException());
 264        }
 265 
 266        valueArrayOop da = valueArrayOop(d);
 267        address dst = (address) da->value_at_addr(dst_pos, layout_helper());
 268        address src = (address) sa->value_at_addr(src_pos, layout_helper());
 269        if (contains_oops()) {
 270          int elem_incr = 1 << log2_element_size();
 271          address src_end = src + (length << log2_element_size());
 272          while (src < src_end) {
 273            s_elem_vklass->value_store(src, dst, element_byte_size(), true, false);
 274            src += elem_incr;
 275            dst += elem_incr;
 276          }
 277        } else {
 278          // we are basically a type array...don't bother limiting element copy
 279          // it would have to be a lot wasted space to be worth value_store() calls, need a setting here ?
 280          Copy::conjoint_memory_atomic(src, dst, (size_t)length << log2_element_size());
 281        }
 282      }
 283      else { // valueArray-to-objArray
 284        assert(dk->is_objArray_klass(), "Expected objArray here");
 285        // Need to allocate each new src elem payload -> dst oop
 286        objArrayHandle dh(THREAD, (objArrayOop)d);
 287        valueArrayHandle sh(THREAD, sa);
 288        int dst_end = dst_pos + length;
 289        while (dst_pos < dst_end) {
 290          oop o = s_elem_vklass->allocate_instance(CHECK);
 291          s_elem_vklass->value_store(sh->value_at_addr(src_pos, layout_helper()),
 292                                              s_elem_vklass->data_for_oop(o), true, true);
 293          dh->obj_at_put(dst_pos, o);
 294          dst_pos++;
 295          src_pos++;
 296        }
 297      }
 298    } else {
 299      assert(s->is_objArray(), "Expected objArray");
 300      objArrayOop sa = objArrayOop(s);
 301      assert(d->is_valueArray(), "Excepted valueArray");  // objArray-to-valueArray
 302      ValueKlass* d_elem_vklass = ValueKlass::cast(d_elem_klass);
 303      valueArrayOop da = valueArrayOop(d);
 304 
 305      int src_end = src_pos + length;
 306      int delem_incr = 1 << dk->log2_element_size();
 307      address dst = (address) da->value_at_addr(dst_pos, layout_helper());
 308      while (src_pos < src_end) {
 309        oop se = sa->obj_at(src_pos);
 310        if (se == NULL) {
 311          THROW(vmSymbols::java_lang_NullPointerException());
 312        }
 313        // Check exact type per element
 314        if (se->klass() != d_elem_klass) {
 315          THROW(vmSymbols::java_lang_ArrayStoreException());
 316        }
 317        d_elem_vklass->value_store(d_elem_vklass->data_for_oop(se), dst, true, false);
 318        dst += delem_incr;
 319        src_pos++;
 320      }
 321    }
 322 }
 323 
 324 
 325 Klass* ValueArrayKlass::array_klass_impl(ArrayStorageProperties storage_props, bool or_null, int n, TRAPS) {
 326   assert(storage_props.is_flattened() || n > 1, "Expected flat storage");
 327   assert(dimension() <= n, "check order of chain");
 328   int dim = dimension();
 329   if (dim == n) return this;
 330 
 331   if (higher_dimension() == NULL) {
 332     if (or_null)  return NULL;
 333 
 334     ResourceMark rm;
 335     JavaThread *jt = (JavaThread *)THREAD;
 336     {
 337       // Ensure atomic creation of higher dimensions
 338       MutexLocker mu(MultiArray_lock, THREAD);
 339 
 340       // Check if another thread beat us
 341       if (higher_dimension() == NULL) {
 342 
 343         // Create multi-dim klass object and link them together
 344         Klass* k =
 345           ObjArrayKlass::allocate_objArray_klass(storage_props, dim + 1, this, CHECK_NULL);
 346         ObjArrayKlass* ak = ObjArrayKlass::cast(k);
 347         ak->set_lower_dimension(this);
 348         OrderAccess::storestore();
 349         set_higher_dimension(ak);
 350         assert(ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass");
 351       }
 352     }
 353   } else {
 354     CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
 355   }
 356 
 357   ObjArrayKlass *ak = ObjArrayKlass::cast(higher_dimension());
 358   if (or_null) {
 359     return ak->array_klass_or_null(storage_props, n);
 360   }
 361   return ak->array_klass(storage_props, n, THREAD);
 362 }
 363 
 364 Klass* ValueArrayKlass::array_klass_impl(ArrayStorageProperties storage_props, bool or_null, TRAPS) {
 365   return array_klass_impl(storage_props, or_null, dimension() +  1, THREAD);
 366 }
 367 
 368 ModuleEntry* ValueArrayKlass::module() const {
 369   assert(element_klass() != NULL, "ValueArrayKlass returned unexpected NULL bottom_klass");
 370   // The array is defined in the module of its bottom class
 371   return element_klass()->module();
 372 }
 373 
 374 PackageEntry* ValueArrayKlass::package() const {
 375   assert(element_klass() != NULL, "ValuerrayKlass returned unexpected NULL bottom_klass");
 376   return element_klass()->package();
 377 }
 378 
 379 bool ValueArrayKlass::can_be_primary_super_slow() const {
 380     return true;
 381 }
 382 
 383 GrowableArray<Klass*>* ValueArrayKlass::compute_secondary_supers(int num_extra_slots,
 384                                                                  Array<InstanceKlass*>* transitive_interfaces) {
 385   assert(transitive_interfaces == NULL, "sanity");
 386   // interfaces = { cloneable_klass, serializable_klass, elemSuper[], ... };
 387   Array<Klass*>* elem_supers = element_klass()->secondary_supers();
 388   int num_elem_supers = elem_supers == NULL ? 0 : elem_supers->length();
 389   int num_secondaries = num_extra_slots + 2 + num_elem_supers;
 390   if (num_secondaries == 2) {
 391     // Must share this for correct bootstrapping!
 392     set_secondary_supers(Universe::the_array_interfaces_array());
 393     return NULL;
 394   } else {
 395     GrowableArray<Klass*>* secondaries = new GrowableArray<Klass*>(num_elem_supers+2);
 396     secondaries->push(SystemDictionary::Cloneable_klass());
 397     secondaries->push(SystemDictionary::Serializable_klass());
 398     for (int i = 0; i < num_elem_supers; i++) {
 399       Klass* elem_super = (Klass*) elem_supers->at(i);
 400       Klass* array_super = elem_super->array_klass_or_null(ArrayStorageProperties::empty);
 401       assert(array_super != NULL, "must already have been created");
 402       secondaries->push(array_super);
 403     }
 404     return secondaries;
 405   }
 406 }
 407 
 408 void ValueArrayKlass::print_on(outputStream* st) const {
 409 #ifndef PRODUCT
 410   assert(!is_objArray_klass(), "Unimplemented");
 411 
 412   st->print("Value Type Array: ");
 413   Klass::print_on(st);
 414 
 415   st->print(" - element klass: ");
 416   element_klass()->print_value_on(st);
 417   st->cr();
 418 
 419   int elem_size = element_byte_size();
 420   st->print(" - element size %i ", elem_size);
 421   st->print("aligned layout size %i", 1 << layout_helper_log2_element_size(layout_helper()));
 422   st->cr();
 423 #endif //PRODUCT
 424 }
 425 
 426 void ValueArrayKlass::print_value_on(outputStream* st) const {
 427   assert(is_klass(), "must be klass");
 428 
 429   element_klass()->print_value_on(st);
 430   st->print("[]");
 431 }
 432 
 433 
 434 #ifndef PRODUCT
 435 void ValueArrayKlass::oop_print_on(oop obj, outputStream* st) {
 436   ArrayKlass::oop_print_on(obj, st);
 437   valueArrayOop va = valueArrayOop(obj);
 438   ValueKlass* vk = element_klass();
 439   int print_len = MIN2((intx) va->length(), MaxElementPrintSize);
 440   for(int index = 0; index < print_len; index++) {
 441     int off = (address) va->value_at_addr(index, layout_helper()) - (address) obj;
 442     st->print_cr(" - Index %3d offset %3d: ", index, off);
 443     oop obj = (oop) ((address)va->value_at_addr(index, layout_helper()) - vk->first_field_offset());
 444     FieldPrinter print_field(st, obj);
 445     vk->do_nonstatic_fields(&print_field);
 446     st->cr();
 447   }
 448   int remaining = va->length() - print_len;
 449   if (remaining > 0) {
 450     st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
 451   }
 452 }
 453 #endif //PRODUCT
 454 
 455 void ValueArrayKlass::oop_print_value_on(oop obj, outputStream* st) {
 456   assert(obj->is_valueArray(), "must be valueArray");
 457   st->print("a ");
 458   element_klass()->print_value_on(st);
 459   int len = valueArrayOop(obj)->length();
 460   st->print("[%d] ", len);
 461   obj->print_address_on(st);
 462   if (PrintMiscellaneous && (WizardMode || Verbose)) {
 463     int lh = layout_helper();
 464     st->print("{");
 465     for (int i = 0; i < len; i++) {
 466       if (i > 4) {
 467         st->print("..."); break;
 468       }
 469       st->print(" " INTPTR_FORMAT, (intptr_t)(void*)valueArrayOop(obj)->value_at_addr(i , lh));
 470     }
 471     st->print(" }");
 472   }
 473 }
 474 
 475 // Verification
 476 class VerifyElementClosure: public BasicOopIterateClosure {
 477  public:
 478   virtual void do_oop(oop* p)       { VerifyOopClosure::verify_oop.do_oop(p); }
 479   virtual void do_oop(narrowOop* p) { VerifyOopClosure::verify_oop.do_oop(p); }
 480 };
 481 
 482 void ValueArrayKlass::oop_verify_on(oop obj, outputStream* st) {
 483   ArrayKlass::oop_verify_on(obj, st);
 484   guarantee(obj->is_valueArray(), "must be valueArray");
 485 
 486   if (contains_oops()) {
 487     valueArrayOop va = valueArrayOop(obj);
 488     VerifyElementClosure ec;
 489     va->oop_iterate(&ec);
 490   }
 491 }
 492 
 493 void ValueArrayKlass::verify_on(outputStream* st) {
 494   ArrayKlass::verify_on(st);
 495   guarantee(element_klass()->is_value(), "should be value type klass");
 496 }