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 
  41   // Constructor
  42   ValueArrayKlass(Klass* element_klass, Symbol* name);
  43 
  44   static ValueArrayKlass* allocate_klass(Klass* element_klass, Symbol* name, TRAPS);
  45 protected:
  46   // Returns the ArrayKlass for n'th dimension.
  47   Klass* array_klass_impl(bool or_null, int n, TRAPS);
  48 
  49   // Returns the array class with this class as element type.
  50   Klass* array_klass_impl(bool or_null, TRAPS);
  51 
  52  public:
  53 
  54   ValueArrayKlass() {}
  55 
  56   virtual ValueKlass* element_klass() const;
  57   virtual void set_element_klass(Klass* k);
  58 
  59   // Casting from Klass*
  60   static ValueArrayKlass* cast(Klass* k) {
  61     assert(k->is_valueArray_klass(), "cast to ValueArrayKlass");
  62     return (ValueArrayKlass*) k;
  63   }
  64 
  65   // klass allocation
  66   static ValueArrayKlass* allocate_klass(Klass* element_klass, TRAPS);
  67 
  68   void initialize(TRAPS);
  69 
  70   ModuleEntry* module() const;
  71   PackageEntry* package() const;
  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() {
  79     return element_klass()->contains_oops();
  80   }
  81 
  82   bool is_atomic() {
  83     return element_klass()->is_atomic();
  84   }
  85 
  86   oop protection_domain() const;
  87 
  88   static jint array_layout_helper(ValueKlass* vklass); // layout helper for values
  89 
  90   // sizing
  91   static int header_size()  { return sizeof(ValueArrayKlass)/HeapWordSize; }
  92   int size() const          { return ArrayKlass::static_size(header_size()); }
  93 
  94   jint max_elements() const;
  95 
  96   int oop_size(oop obj) const;
  97 
  98   // Oop Allocation
  99   oop allocate(int length, bool do_zero, TRAPS);
 100   oop multi_allocate(int rank, jint* sizes, TRAPS);
 101 
 102   // Naming
 103   const char* internal_name() const { return external_name(); }
 104 
 105   // Copying
 106   void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
 107 
 108   // GC specific object visitors
 109   //
 110   // Mark Sweep
 111   int oop_ms_adjust_pointers(oop obj);
 112 
 113 #if INCLUDE_ALL_GCS
 114   // Parallel Scavenge
 115   void oop_ps_push_contents(  oop obj, PSPromotionManager* pm);
 116   // Parallel Compact
 117   void oop_pc_follow_contents(oop obj, ParCompactionManager* cm);
 118   void oop_pc_update_pointers(oop obj, ParCompactionManager* cm);
 119 #endif
 120 
 121   CMH("Oop iterators. Don't have embedded oops yet, so CMH...")
 122 
 123  private:
 124   template <bool nv, typename OopClosureType>
 125   inline void oop_oop_iterate(oop obj, OopClosureType* closure);
 126   template <bool nv, typename OopClosureType>
 127   inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
 128 
 129   template <bool nv, typename T, class OopClosureType>
 130   inline void oop_oop_iterate_elements_specialized(valueArrayOop a, OopClosureType* closure);
 131 
 132   template <bool nv, class OopClosureType>
 133   inline void oop_oop_iterate_elements_bounded(valueArrayOop a, OopClosureType* closure, MemRegion mr);
 134 
 135   template <bool nv, typename T, class OopClosureType>
 136   inline void oop_oop_iterate_elements_specialized_bounded(valueArrayOop a, OopClosureType* closure, void* low, void* high);
 137 
 138  public:
 139   template <bool nv, class OopClosureType>
 140   inline void oop_oop_iterate_elements(valueArrayOop a, OopClosureType* closure);
 141 
 142   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_DECL)
 143   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_DECL)
 144   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_DECL_RANGE)
 145   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_DECL_RANGE)
 146 
 147 #if INCLUDE_ALL_GCS
 148   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_DECL_NO_BACKWARDS)
 149   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_DECL_NO_BACKWARDS)
 150 #endif // INCLUDE_ALL_GCS
 151 
 152  public:
 153   // Printing
 154   void print_on(outputStream* st) const;
 155   void print_value_on(outputStream* st) const;
 156 
 157   void oop_print_value_on(oop obj, outputStream* st);
 158 #ifndef PRODUCT
 159   void oop_print_on(oop obj, outputStream* st);
 160 #endif
 161 
 162   // Verification
 163   void verify_on(outputStream* st);
 164   void oop_verify_on(oop obj, outputStream* st);
 165 };
 166 
 167 #endif
 168