1 /*
   2  * Copyright (c) 2015, 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/symbolTable.hpp"
  27 #include "classfile/systemDictionary.hpp"
  28 #include "classfile/vmSymbols.hpp"
  29 #include "gc/shared/collectedHeap.hpp"
  30 #include "gc/shared/collectedHeap.inline.hpp"
  31 #include "memory/metadataFactory.hpp"
  32 #include "memory/resourceArea.hpp"
  33 #include "memory/universe.hpp"
  34 #include "memory/universe.inline.hpp"
  35 #include "oops/instanceKlass.hpp"
  36 #include "oops/klass.inline.hpp"
  37 #include "oops/objArrayKlass.hpp"
  38 #include "oops/oop.inline.hpp"
  39 #include "oops/arrayKlass.hpp"
  40 #include "oops/arrayOop.hpp"
  41 #include "oops/valueKlass.hpp"
  42 #include "oops/valueArrayOop.hpp"
  43 #include "runtime/handles.inline.hpp"
  44 #include "runtime/orderAccess.inline.hpp"
  45 #include "utilities/macros.hpp"
  46 
  47 #include "oops/valueArrayKlass.hpp"
  48 
  49 // Allocation...
  50 
  51 ValueArrayKlass::ValueArrayKlass(KlassHandle element_klass_handle, Symbol* name) : ArrayKlass(name) {
  52   Klass* k = element_klass_handle();
  53   assert(k->is_value(), "Expected Value");
  54   set_element_klass(ValueKlass::cast(k));
  55   set_class_loader_data(k->class_loader_data());
  56 
  57   set_layout_helper(array_layout_helper(element_klass()));
  58   assert(is_array_klass(), "sanity");
  59   assert(is_valueArray_klass(), "sanity");
  60 
  61   CMH("tweak name symbol refcnt ?")
  62 #ifndef PRODUCT
  63   if (PrintValueArrayLayout) {
  64     print();
  65   }
  66 #endif
  67 }
  68 
  69 ValueArrayKlass* ValueArrayKlass::allocate_klass(KlassHandle      element_klass,
  70                                                  Symbol*          name,
  71                                                  TRAPS) {
  72   assert(ValueArrayFlatten, "Flatten array not allowed");
  73   assert(ValueKlass::cast(element_klass())->is_atomic() || (!ValueArrayAtomicAccess), "Atomic by-default");
  74 
  75   ClassLoaderData* loader_data = element_klass->class_loader_data();
  76   int size = ArrayKlass::static_size(ValueArrayKlass::header_size());
  77   ValueArrayKlass* vak = new (loader_data, size, THREAD) ValueArrayKlass(element_klass, name);
  78   if (vak == NULL) {
  79     return NULL;
  80   }
  81   loader_data->add_class(vak);
  82   complete_create_array_klass(vak, vak->super(), CHECK_NULL);
  83   return vak;
  84 }
  85 
  86 ValueArrayKlass* ValueArrayKlass::allocate_klass(KlassHandle element_klass, TRAPS) {
  87   Symbol* name = ArrayKlass::create_element_klass_array_name(element_klass, CHECK_NULL);
  88   return allocate_klass(element_klass, name, THREAD);
  89 }
  90 
  91 // Oops allocation...
  92 valueArrayOop ValueArrayKlass::allocate_array(int length,
  93                                               bool do_zero,
  94                                               TRAPS) {
  95   CMH("this is virtually identical in all arrayKlasses, refactor")
  96   if (length < 0) {
  97     THROW_0(vmSymbols::java_lang_NegativeArraySizeException());
  98   }
  99   if (length > max_elements()) {
 100     report_java_out_of_memory("Requested array size exceeds VM limit");
 101     JvmtiExport::post_array_size_exhausted();
 102     THROW_OOP_0(Universe::out_of_memory_error_array_size());
 103   }
 104 
 105   size_t size = valueArrayOopDesc::object_size(layout_helper(), length);
 106   KlassHandle h_k(THREAD, this);
 107   valueArrayOop array;
 108   CollectedHeap* ch = Universe::heap();
 109   if (do_zero) {
 110     array = (valueArrayOop)CollectedHeap::array_allocate(h_k, (int)size, length, CHECK_NULL);
 111   } else {
 112     array = (valueArrayOop)CollectedHeap::array_allocate_nozero(h_k, (int)size, length, CHECK_NULL);
 113   }
 114   return array;
 115 }
 116 
 117 
 118 oop ValueArrayKlass::multi_allocate(int rank, jint* last_size, TRAPS) {
 119   // For valueArrays this is only called for the last dimension
 120   assert(rank == 1, "just checking");
 121   int length = *last_size;
 122   return allocate_array(length, true, THREAD);
 123 }
 124 
 125 jint ValueArrayKlass::array_layout_helper(ValueKlass* vk) {
 126   BasicType etype = T_VALUETYPE;
 127   int atag  = _lh_array_tag_type_value;
 128   int esize = upper_log2(vk->raw_value_byte_size());
 129   int hsize = arrayOopDesc::base_offset_in_bytes(etype);
 130 
 131   int lh = (atag        << _lh_array_tag_shift)
 132     |      (1          << _lh_valuetype_bit)
 133     |      (hsize      << _lh_header_size_shift)
 134     |      ((int)etype << _lh_element_type_shift)
 135     |      (esize);
 136 
 137 #ifdef DEBUG
 138   assert(lh < (int)_lh_neutral_value, "must look like an array layout");
 139   assert(layout_helper_is_array(lh), "correct kind");
 140   assert(layout_helper_is_valueArray(lh), "correct kind");
 141   assert(layout_helper_header_size(lh) == hsize, "correct decode");
 142   assert(layout_helper_element_type(lh) == etype, "correct decode");
 143   assert(layout_helper_is_typeArray(lh), "correct kind");
 144   assert(1 << layout_helper_log2_element_size(lh) == esize, "correct decode");
 145 #endif
 146   return lh;
 147 }
 148 
 149 int ValueArrayKlass::oop_size(oop obj) const {
 150   assert(obj->is_valueArray(),"must be a value array");
 151   valueArrayOop array = valueArrayOop(obj);
 152   return array->object_size();
 153 }
 154 
 155 jint ValueArrayKlass::max_elements() const {
 156   return arrayOopDesc::max_array_length(arrayOopDesc::header_size(T_VALUETYPE), element_byte_size());
 157 }
 158 
 159 oop ValueArrayKlass::protection_domain() const {
 160   return element_klass()->protection_domain();
 161 }
 162 
 163 void ValueArrayKlass::copy_array(arrayOop s, int src_pos,
 164                                  arrayOop d, int dst_pos, int length, TRAPS) {
 165   assert(s->is_valueArray(), "must be value array");
 166 
 167    // Check destination
 168    if (!d->is_valueArray() || element_klass() != ValueArrayKlass::cast(d->klass())->element_klass()) {
 169      THROW(vmSymbols::java_lang_ArrayStoreException());
 170    }
 171 
 172    // Check is all offsets and lengths are non negative
 173    if (src_pos < 0 || dst_pos < 0 || length < 0) {
 174      THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
 175    }
 176    // Check if the ranges are valid
 177    if  ( (((unsigned int) length + (unsigned int) src_pos) > (unsigned int) s->length())
 178       || (((unsigned int) length + (unsigned int) dst_pos) > (unsigned int) d->length()) ) {
 179      THROW(vmSymbols::java_lang_ArrayIndexOutOfBoundsException());
 180    }
 181    // Check zero copy
 182    if (length == 0)
 183      return;
 184 
 185    valueArrayOop da = valueArrayOop(d);
 186    valueArrayOop sa = valueArrayOop(s);
 187    int end_src_pos = src_pos + length;
 188    while (src_pos < end_src_pos) {
 189      element_klass()->value_store(sa->value_at_addr(src_pos++, layout_helper()),
 190                                   da->value_at_addr(dst_pos++, layout_helper()),
 191                                   true,
 192                                   false);
 193    }
 194 }
 195 
 196 
 197 Klass* ValueArrayKlass::array_klass_impl(bool or_null, int n, TRAPS) {
 198 
 199   assert(dimension() <= n, "check order of chain");
 200   int dim = dimension();
 201   if (dim == n) return this;
 202 
 203   if (higher_dimension() == NULL) {
 204     if (or_null)  return NULL;
 205 
 206     ResourceMark rm;
 207     JavaThread *jt = (JavaThread *)THREAD;
 208     {
 209       MutexLocker mc(Compile_lock, THREAD);   // for vtables
 210       // Ensure atomic creation of higher dimensions
 211       MutexLocker mu(MultiArray_lock, THREAD);
 212 
 213       // Check if another thread beat us
 214       if (higher_dimension() == NULL) {
 215 
 216         // Create multi-dim klass object and link them together
 217         Klass* k =
 218           ObjArrayKlass::allocate_objArray_klass(class_loader_data(), dim + 1, this, CHECK_NULL);
 219         ObjArrayKlass* ak = ObjArrayKlass::cast(k);
 220         ak->set_lower_dimension(this);
 221         OrderAccess::storestore();
 222         set_higher_dimension(ak);
 223         assert(ak->is_objArray_klass(), "incorrect initialization of ObjArrayKlass");
 224       }
 225     }
 226   } else {
 227     CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
 228   }
 229 
 230   ObjArrayKlass *ak = ObjArrayKlass::cast(higher_dimension());
 231   if (or_null) {
 232     return ak->array_klass_or_null(n);
 233   }
 234   return ak->array_klass(n, THREAD);
 235 }
 236 
 237 Klass* ValueArrayKlass::array_klass_impl(bool or_null, TRAPS) {
 238   return array_klass_impl(or_null, dimension() +  1, THREAD);
 239 }
 240 
 241 void ValueArrayKlass::print_on(outputStream* st) const {
 242 #ifndef PRODUCT
 243   assert(!is_objArray_klass(), "Unimplemented");
 244 
 245   st->print("Value Type Array: ");
 246   Klass::print_on(st);
 247 
 248   st->print(" - element klass: ");
 249   element_klass()->print_value_on(st);
 250   st->cr();
 251 
 252   int elem_size = element_byte_size();
 253   st->print(" - element size %i ", elem_size);
 254   st->print("aligned layout size %i", 1 << layout_helper_log2_element_size(layout_helper()));
 255   st->cr();
 256 #endif //PRODUCT
 257 }
 258 
 259 #ifndef PRODUCT
 260 void ValueArrayKlass::oop_print_on(oop obj, outputStream* st) {
 261   ArrayKlass::oop_print_on(obj, st);
 262   valueArrayOop va = valueArrayOop(obj);
 263   int print_len = MIN2((intx) va->length(), MaxElementPrintSize);
 264   for(int index = 0; index < print_len; index++) {
 265     st->print(" - %3d : ", index);
 266     CMH("CMH: helper method for valueOop/valorind printing")
 267     st->print(" CMH: helper method for valueOop/valorind printing");
 268     st->cr();
 269   }
 270   int remaining = va->length() - print_len;
 271   if (remaining > 0) {
 272     st->print_cr(" - <%d more elements, increase MaxElementPrintSize to print>", remaining);
 273   }
 274 }
 275 #endif //PRODUCT
 276