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