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