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 void ValueArrayKlass::set_element_klass(ValueKlass* k) {
  73   _element_klass = k;
  74 }
  75 
  76 ValueArrayKlass* ValueArrayKlass::allocate_klass(Klass*  element_klass,
  77                                                  Symbol* name,
  78                                                  TRAPS) {
  79   assert(ValueArrayFlatten, "Flatten array not allowed");
  80   assert(ValueKlass::cast(element_klass)->is_atomic() || (!ValueArrayAtomicAccess), "Atomic by-default");
  81 
  82   ClassLoaderData* loader_data = element_klass->class_loader_data();
  83   int size = ArrayKlass::static_size(ValueArrayKlass::header_size());
  84   ValueArrayKlass* vak = new (loader_data, size, THREAD) ValueArrayKlass(element_klass, name);
  85   if (vak == NULL) {
  86     return NULL;
  87   }
  88   loader_data->add_class(vak);
  89   complete_create_array_klass(vak, vak->super(), vak->module(), CHECK_NULL);
  90   return vak;
  91 }
  92 
  93 ValueArrayKlass* ValueArrayKlass::allocate_klass(Klass* element_klass, TRAPS) {
  94   Symbol* name = ArrayKlass::create_element_klass_array_name(element_klass, CHECK_NULL);
  95   return allocate_klass(element_klass, name, THREAD);
  96 }
  97 
  98 void ValueArrayKlass::initialize(TRAPS) {
  99   element_klass()->initialize(THREAD);
 100 }
 101 
 102 // Oops allocation...
 103 oop ValueArrayKlass::allocate(int length, bool do_zero, TRAPS) {
 104   if (length < 0) {
 105     THROW_0(vmSymbols::java_lang_NegativeArraySizeException());
 106   }
 107   if (length > max_elements()) {
 108     report_java_out_of_memory("Requested array size exceeds VM limit");
 109     JvmtiExport::post_array_size_exhausted();
 110     THROW_OOP_0(Universe::out_of_memory_error_array_size());
 111   }
 112 
 113   size_t size = valueArrayOopDesc::object_size(layout_helper(), length);
 114   if (do_zero) {
 115     return CollectedHeap::array_allocate(this, (int)size, length, CHECK_NULL);
 116   } else {
 117     return CollectedHeap::array_allocate_nozero(this, (int)size, length, CHECK_NULL);
 118   }
 119 }
 120 
 121 
 122 oop ValueArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
 123   // For valueArrays this is only called for the last dimension
 124   assert(rank == 1, "just checking");
 125   int length = *last_size;
 126   return allocate(length, true, THREAD);
 127 }
 128 
 129 jint ValueArrayKlass::array_layout_helper(ValueKlass* vk) {
 130   BasicType etype = T_VALUETYPE;
 131   int atag  = _lh_array_tag_vt_value;
 132   int esize = upper_log2(vk->raw_value_byte_size());
 133   int hsize = arrayOopDesc::base_offset_in_bytes(etype);
 134 
 135   int lh = (atag       << _lh_array_tag_shift)
 136     |      (hsize      << _lh_header_size_shift)
 137     |      ((int)etype << _lh_element_type_shift)
 138     |      ((esize)    << _lh_log2_element_size_shift);
 139 
 140   assert(lh < (int)_lh_neutral_value, "must look like an array layout");
 141   assert(layout_helper_is_array(lh), "correct kind");
 142   assert(layout_helper_is_valueArray(lh), "correct kind");
 143   assert(!layout_helper_is_typeArray(lh), "correct kind");
 144   assert(!layout_helper_is_objArray(lh), "correct kind");
 145   assert(layout_helper_header_size(lh) == hsize, "correct decode");
 146   assert(layout_helper_element_type(lh) == etype, "correct decode");
 147   assert(layout_helper_log2_element_size(lh) == esize, "correct decode");
 148   assert((1 << esize) < BytesPerLong || is_size_aligned(hsize, HeapWordsPerLong), "unaligned base");
 149 
 150   return lh;
 151 }
 152 
 153 int ValueArrayKlass::oop_size(oop obj) const {
 154   assert(obj->is_valueArray(),"must be a value array");
 155   valueArrayOop array = valueArrayOop(obj);
 156   return array->object_size();
 157 }
 158 
 159 jint ValueArrayKlass::max_elements() const {
 160   return arrayOopDesc::max_array_length(arrayOopDesc::header_size(T_VALUETYPE), element_byte_size());
 161 }
 162 
 163 oop ValueArrayKlass::protection_domain() const {
 164   return element_klass()->protection_domain();
 165 }
 166 
 167 void ValueArrayKlass::copy_array(arrayOop s, int src_pos,
 168                                  arrayOop d, int dst_pos, int length, TRAPS) {
 169   assert(s->is_valueArray(), "must be value array");
 170 
 171    // Check destination
 172    if (!d->is_valueArray() || element_klass() != ValueArrayKlass::cast(d->klass())->element_klass()) {
 173      THROW(vmSymbols::java_lang_ArrayStoreException());
 174    }
 175 
 176    // Check is all offsets and lengths are non negative
 177    if (src_pos < 0 || dst_pos < 0 || length < 0) {
 178      THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
 179    }
 180    // Check if the ranges are valid
 181    if  ( (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length())
 182       || (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length()) ) {
 183      THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
 184    }
 185    // Check zero copy
 186    if (length == 0)
 187      return;
 188 
 189    valueArrayOop sa = valueArrayOop(s);
 190    valueArrayOop da = valueArrayOop(d);
 191    address src = (address) sa->value_at_addr(src_pos, layout_helper());
 192    address dst = (address) da->value_at_addr(dst_pos, layout_helper());
 193    if (contains_oops()) {
 194      int elem_incr = 1 << log2_element_size();
 195      address src_end = src + (length << log2_element_size());
 196      while (src < src_end) {
 197        element_klass()->value_store(src, dst, element_byte_size(), true, false);
 198        src += elem_incr;
 199        dst += elem_incr;
 200      }
 201    } else {
 202      // we are basically a type array...don't bother limiting element copy
 203      // it would have to be a lot wasted space to be worth value_store() calls, need a setting here ?
 204      Copy::conjoint_memory_atomic(src, dst, (size_t)length << log2_element_size());
 205    }
 206 }
 207 
 208 
 209 Klass* ValueArrayKlass::array_klass_impl(bool or_null, int n, TRAPS) {
 210 
 211   assert(dimension() <= n, "check order of chain");
 212   int dim = dimension();
 213   if (dim == n) return this;
 214 
 215   if (higher_dimension() == NULL) {
 216     if (or_null)  return NULL;
 217 
 218     ResourceMark rm;
 219     JavaThread *jt = (JavaThread *)THREAD;
 220     {
 221       MutexLocker mc(Compile_lock, THREAD);   // for vtables
 222       // Ensure atomic creation of higher dimensions
 223       MutexLocker mu(MultiArray_lock, THREAD);
 224 
 225       // Check if another thread beat us
 226       if (higher_dimension() == NULL) {
 227 
 228         // Create multi-dim klass object and link them together
 229         Klass* k =
 230           ObjArrayKlass::allocate_objArray_klass(class_loader_data(), dim + 1, this, CHECK_NULL);
 231         ObjArrayKlass* ak = ObjArrayKlass::cast(k);
 232         ak->set_lower_dimension(this);
 233         OrderAccess::storestore();
 234         set_higher_dimension(ak);
 235         assert(ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass");
 236       }
 237     }
 238   } else {
 239     CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
 240   }
 241 
 242   ObjArrayKlass *ak = ObjArrayKlass::cast(higher_dimension());
 243   if (or_null) {
 244     return ak->array_klass_or_null(n);
 245   }
 246   return ak->array_klass(n, THREAD);
 247 }
 248 
 249 Klass* ValueArrayKlass::array_klass_impl(bool or_null, TRAPS) {
 250   return array_klass_impl(or_null, dimension() +  1, THREAD);
 251 }
 252 
 253 ModuleEntry* ValueArrayKlass::module() const {
 254   assert(element_klass() != NULL, "ObjArrayKlass returned unexpected NULL bottom_klass");
 255   // The array is defined in the module of its bottom class
 256   return element_klass()->module();
 257 }
 258 
 259 PackageEntry* ValueArrayKlass::package() const {
 260   assert(element_klass() != NULL, "ObjArrayKlass returned unexpected NULL bottom_klass");
 261   return element_klass()->package();
 262 }
 263 
 264 void ValueArrayKlass::print_on(outputStream* st) const {
 265 #ifndef PRODUCT
 266   assert(!is_objArray_klass(), "Unimplemented");
 267 
 268   st->print("Value Type Array: ");
 269   Klass::print_on(st);
 270 
 271   st->print(" - element klass: ");
 272   element_klass()->print_value_on(st);
 273   st->cr();
 274 
 275   int elem_size = element_byte_size();
 276   st->print(" - element size %i ", elem_size);
 277   st->print("aligned layout size %i", 1 << layout_helper_log2_element_size(layout_helper()));
 278   st->cr();
 279 #endif //PRODUCT
 280 }
 281 
 282 void ValueArrayKlass::print_value_on(outputStream* st) const {
 283   assert(is_klass(), "must be klass");
 284 
 285   element_klass()->print_value_on(st);
 286   st->print("[]");
 287 }
 288 
 289 
 290 #ifndef PRODUCT
 291 void ValueArrayKlass::oop_print_on(oop obj, outputStream* st) {
 292   ArrayKlass::oop_print_on(obj, st);
 293   valueArrayOop va = valueArrayOop(obj);
 294   ValueKlass* vk = element_klass();
 295   int print_len = MIN2((intx) va->length(), MaxElementPrintSize);
 296   for(int index = 0; index < print_len; index++) {
 297     int off = (address) va->value_at_addr(index, layout_helper()) - (address) obj;
 298     st->print_cr(" - Index %3d offset %3d: ", index, off);
 299     oop obj = (oop) ((address)va->value_at_addr(index, layout_helper()) - vk->first_field_offset());
 300     FieldPrinter print_field(st, obj);
 301     vk->do_nonstatic_fields(&print_field);
 302     st->cr();
 303   }
 304   int remaining = va->length() - print_len;
 305   if (remaining > 0) {
 306     st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
 307   }
 308 }
 309 #endif //PRODUCT
 310 
 311 void ValueArrayKlass::oop_print_value_on(oop obj, outputStream* st) {
 312   assert(obj->is_valueArray(), "must be valueArray");
 313   st->print("a ");
 314   element_klass()->print_value_on(st);
 315   int len = valueArrayOop(obj)->length();
 316   st->print("[%d] ", len);
 317   obj->print_address_on(st);
 318   if (PrintMiscellaneous && (WizardMode || Verbose)) {
 319     int lh = layout_helper();
 320     st->print("{");
 321     for (int i = 0; i < len; i++) {
 322       if (i > 4) {
 323         st->print("..."); break;
 324       }
 325       st->print(" " INTPTR_FORMAT, (intptr_t)(void*)valueArrayOop(obj)->value_at_addr(i , lh));
 326     }
 327     st->print(" }");
 328   }
 329 }
 330 
 331 // Verification
 332 
 333 void ValueArrayKlass::oop_verify_on(oop obj, outputStream* st) {
 334   ArrayKlass::oop_verify_on(obj, st);
 335   guarantee(obj->is_valueArray(), "must be valueArray");
 336 
 337   if (element_klass()->contains_oops()) {
 338     valueArrayOop va = valueArrayOop(obj);
 339     NoHeaderExtendedOopClosure wrapClosure(&VerifyOopClosure::verify_oop);
 340     va->oop_iterate(&wrapClosure);
 341   }
 342 }
 343 
 344 void ValueArrayKlass::verify_on(outputStream* st) {
 345   ArrayKlass::verify_on(st);
 346   guarantee(element_klass()->is_value(), "should be value type klass");
 347 }