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 #ifndef SHARE_VM_OOPS_VALUEARRAYKLASS_HPP
  26 #define SHARE_VM_OOPS_VALUEARRAYKLASS_HPP
  27 
  28 #include "classfile/classLoaderData.hpp"
  29 #include "oops/arrayKlass.hpp"
  30 #include "oops/valueKlass.hpp"
  31 #include "utilities/macros.hpp"
  32 
  33 /**
  34  * Array of values, gives a layout of typeArrayOop, but needs oops iterators
  35  */
  36 class ValueArrayKlass : public ArrayKlass {
  37   friend class VMStructs;
  38  private:
  39   int            _element_value_store_size;  // pow2 addressing, limit value store copy size
  40   ValueKlass*    _element_klass;             // The klass of the elements of this array type
  41 
  42   // Constructor
  43   ValueArrayKlass(KlassHandle element_klass, Symbol* name);
  44   void set_element_klass(ValueKlass* k);
  45 
  46   static ValueArrayKlass* allocate_klass(KlassHandle element_klass, Symbol* name, TRAPS);
  47 protected:
  48   // Returns the ArrayKlass for n'th dimension.
  49   Klass* array_klass_impl(bool or_null, int n, TRAPS);
  50 
  51   // Returns the array class with this class as element type.
  52   Klass* array_klass_impl(bool or_null, TRAPS);
  53 
  54  public:
  55 
  56   ValueArrayKlass() {}
  57 
  58   // Casting from Klass*
  59   static ValueArrayKlass* cast(Klass* k) {
  60     assert(k->is_valueArray_klass(), "cast to ValueArrayKlass");
  61     return (ValueArrayKlass*) k;
  62   }
  63 
  64   // klass allocation
  65   static ValueArrayKlass* allocate_klass(KlassHandle element_klass, TRAPS);
  66 
  67   void initialize(TRAPS);
  68 
  69   // Instance variables
  70   ValueKlass* element_klass() const     { return _element_klass; }
  71   ValueKlass** element_klass_addr()     { return &_element_klass; }
  72 
  73   int element_byte_size() const { return 1 << layout_helper_log2_element_size(_layout_helper); }
  74   int element_value_store_size() const { return _element_value_store_size; }
  75 
  76   bool is_valueArray_klass_slow() const { return true; }
  77 
  78   bool contains_oops() { return element_klass()->contains_oops(); }
  79   bool is_atomic() { return element_klass()->is_atomic(); }
  80 
  81   oop protection_domain() const;
  82 
  83   static jint array_layout_helper(ValueKlass* vklass); // layout helper for values
  84 
  85   // sizing
  86   static int header_size()  { return sizeof(ValueArrayKlass)/HeapWordSize; }
  87   int size() const          { return ArrayKlass::static_size(header_size()); }
  88 
  89   jint max_elements() const;
  90 
  91   int oop_size(oop obj) const;
  92 
  93   // Oop Allocation
  94   oop allocate(int length, bool do_zero, TRAPS);
  95   oop multi_allocate(int rank, jint* sizes, TRAPS);
  96 
  97   // Naming
  98   const char* internal_name() const { return external_name(); }
  99 
 100   // Copying
 101   void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
 102 
 103   // Compiler/Interpreter offset
 104   static ByteSize element_klass_offset() { return in_ByteSize(offset_of(ValueArrayKlass, _element_klass)); }
 105 
 106   // GC specific object visitors
 107   //
 108   // Mark Sweep
 109   int oop_ms_adjust_pointers(oop obj);
 110 
 111 #if INCLUDE_ALL_GCS
 112   // Parallel Scavenge
 113   void oop_ps_push_contents(  oop obj, PSPromotionManager* pm);
 114   // Parallel Compact
 115   void oop_pc_follow_contents(oop obj, ParCompactionManager* cm);
 116   void oop_pc_update_pointers(oop obj, ParCompactionManager* cm);
 117 #endif
 118 
 119   CMH("Oop iterators. Don't have embedded oops yet, so CMH...")
 120 
 121  private:
 122   template <bool nv, typename OopClosureType>
 123   inline void oop_oop_iterate(oop obj, OopClosureType* closure);
 124   template <bool nv, typename OopClosureType>
 125   inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
 126 
 127   template <bool nv, typename T, class OopClosureType>
 128   inline void oop_oop_iterate_elements_specialized(valueArrayOop a, OopClosureType* closure);
 129 
 130   template <bool nv, class OopClosureType>
 131   inline void oop_oop_iterate_elements_bounded(valueArrayOop a, OopClosureType* closure, MemRegion mr);
 132 
 133   template <bool nv, typename T, class OopClosureType>
 134   inline void oop_oop_iterate_elements_specialized_bounded(valueArrayOop a, OopClosureType* closure, void* low, void* high);
 135 
 136  public:
 137   template <bool nv, class OopClosureType>
 138   inline void oop_oop_iterate_elements(valueArrayOop a, OopClosureType* closure);
 139 
 140   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_DECL)
 141   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_DECL)
 142   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_DECL_RANGE)
 143   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_DECL_RANGE)
 144 
 145 #if INCLUDE_ALL_GCS
 146   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_DECL_NO_BACKWARDS)
 147   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_DECL_NO_BACKWARDS)
 148 #endif // INCLUDE_ALL_GCS
 149 
 150  public:
 151   // Printing
 152   void print_on(outputStream* st) const;
 153   void print_value_on(outputStream* st) const;
 154 
 155   void oop_print_value_on(oop obj, outputStream* st);
 156 #ifndef PRODUCT
 157   void oop_print_on(oop obj, outputStream* st);
 158 #endif
 159 
 160   // Verification
 161   void verify_on(outputStream* st);
 162   void oop_verify_on(oop obj, outputStream* st);
 163 };
 164 
 165 #endif
 166