1 /*
   2  * Copyright (c) 1997, 2014, 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_OBJARRAYKLASS_HPP
  26 #define SHARE_VM_OOPS_OBJARRAYKLASS_HPP
  27 
  28 #include "classfile/classLoaderData.hpp"
  29 #include "oops/arrayKlass.hpp"
  30 #include "utilities/macros.hpp"
  31 
  32 // ObjArrayKlass is the klass for objArrays
  33 
  34 class ObjArrayKlass : public ArrayKlass {
  35   friend class VMStructs;
  36  private:
  37   Klass* _element_klass;            // The klass of the elements of this array type
  38   Klass* _bottom_klass;             // The one-dimensional type (InstanceKlass or TypeArrayKlass)
  39 
  40   // Constructor
  41   ObjArrayKlass(int n, KlassHandle element_klass, Symbol* name);
  42   static ObjArrayKlass* allocate(ClassLoaderData* loader_data, int n, KlassHandle klass_handle, Symbol* name, TRAPS);
  43  public:
  44   // For dummy objects
  45   ObjArrayKlass() {}
  46 
  47   // Instance variables
  48   Klass* element_klass() const      { return _element_klass; }
  49   void set_element_klass(Klass* k)  { _element_klass = k; }
  50   Klass** element_klass_addr()      { return &_element_klass; }
  51 
  52   Klass* bottom_klass() const       { return _bottom_klass; }
  53   void set_bottom_klass(Klass* k)   { _bottom_klass = k; }
  54   Klass** bottom_klass_addr()       { return &_bottom_klass; }
  55 
  56   // Compiler/Interpreter offset
  57   static ByteSize element_klass_offset() { return in_ByteSize(offset_of(ObjArrayKlass, _element_klass)); }
  58 
  59   // Dispatched operation
  60   bool can_be_primary_super_slow() const;
  61   GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots);
  62   bool compute_is_subtype_of(Klass* k);
  63   bool oop_is_objArray_slow()  const  { return true; }
  64   int oop_size(oop obj) const;
  65 
  66   // Allocation
  67   static Klass* allocate_objArray_klass(ClassLoaderData* loader_data,
  68                                           int n, KlassHandle element_klass, TRAPS);
  69 
  70   objArrayOop allocate(int length, TRAPS);
  71   oop multi_allocate(int rank, jint* sizes, TRAPS);
  72 
  73   // Copying
  74   void  copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
  75 
  76   // Compute protection domain
  77   oop protection_domain() const { return bottom_klass()->protection_domain(); }
  78 
  79  private:
  80   // Either oop or narrowOop depending on UseCompressedOops.
  81   // must be called from within ObjArrayKlass.cpp
  82   template <class T> void do_copy(arrayOop s, T* src, arrayOop d,
  83                                   T* dst, int length, TRAPS);
  84  protected:
  85   // Returns the ObjArrayKlass for n'th dimension.
  86   virtual Klass* array_klass_impl(bool or_null, int n, TRAPS);
  87 
  88   // Returns the array class with this class as element type.
  89   virtual Klass* array_klass_impl(bool or_null, TRAPS);
  90 
  91  public:
  92   // Casting from Klass*
  93   static ObjArrayKlass* cast(Klass* k) {
  94     assert(k->oop_is_objArray(), "cast to ObjArrayKlass");
  95     return (ObjArrayKlass*) k;
  96   }
  97 
  98   // Sizing
  99   static int header_size()                { return sizeof(ObjArrayKlass)/HeapWordSize; }
 100   int size() const                        { return ArrayKlass::static_size(header_size()); }
 101 
 102   // Initialization (virtual from Klass)
 103   void initialize(TRAPS);
 104 
 105   // GC specific object visitors
 106   //
 107   // Mark Sweep
 108   void oop_ms_follow_contents(oop obj);
 109   int  oop_ms_adjust_pointers(oop obj);
 110 #if INCLUDE_ALL_GCS
 111   // Parallel Scavenge
 112   void oop_ps_push_contents(  oop obj, PSPromotionManager* pm);
 113   // Parallel Compact
 114   void oop_pc_follow_contents(oop obj, ParCompactionManager* cm);
 115   void oop_pc_update_pointers(oop obj);
 116 #endif
 117 
 118   // Oop fields (and metadata) iterators
 119   //  [nv = true]  Use non-virtual calls to do_oop_nv.
 120   //  [nv = false] Use virtual calls to do_oop.
 121   //
 122   // The ObjArrayKlass iterators also visits the Object's klass.
 123 
 124  private:
 125 
 126   // Iterate over oop elements and metadata.
 127   template <bool nv, typename OopClosureType>
 128   inline int oop_oop_iterate(oop obj, OopClosureType* closure);
 129 
 130   // Iterate over oop elements within mr, and metadata.
 131   template <bool nv, typename OopClosureType>
 132   inline int oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
 133 
 134   // Iterate over oop elements with indices within [start, end), and metadata.
 135   template <bool nv, class OopClosureType>
 136   inline int oop_oop_iterate_range(oop obj, OopClosureType* closure, int start, int end);
 137 
 138   // Iterate over oop elements within [start, end), and metadata.
 139   // Specialized for [T = oop] or [T = narrowOop].
 140   template <bool nv, typename T, class OopClosureType>
 141   inline void oop_oop_iterate_range_specialized(objArrayOop a, OopClosureType* closure, int start, int end);
 142 
 143  public:
 144   // Iterate over all oop elements.
 145   template <bool nv, class OopClosureType>
 146   inline void oop_oop_iterate_elements(objArrayOop a, OopClosureType* closure);
 147 
 148  private:
 149   // Iterate over all oop elements.
 150   // Specialized for [T = oop] or [T = narrowOop].
 151   template <bool nv, typename T, class OopClosureType>
 152   inline void oop_oop_iterate_elements_specialized(objArrayOop a, OopClosureType* closure);
 153 
 154   // Iterate over all oop elements with indices within mr.
 155   template <bool nv, class OopClosureType>
 156   inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, MemRegion mr);
 157 
 158   // Iterate over oop elements within [low, high)..
 159   // Specialized for [T = oop] or [T = narrowOop].
 160   template <bool nv, typename T, class OopClosureType>
 161   inline void oop_oop_iterate_elements_specialized_bounded(objArrayOop a, OopClosureType* closure, void* low, void* high);
 162 
 163 
 164  public:
 165 
 166   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_DECL)
 167   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_DECL)
 168   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_RANGE_DECL)
 169   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_RANGE_DECL)
 170 
 171 #if INCLUDE_ALL_GCS
 172   ALL_OOP_OOP_ITERATE_CLOSURES_1(OOP_OOP_ITERATE_NO_BACKWARDS_DECL)
 173   ALL_OOP_OOP_ITERATE_CLOSURES_2(OOP_OOP_ITERATE_NO_BACKWARDS_DECL)
 174 #endif // INCLUDE_ALL_GCS
 175 
 176   // JVM support
 177   jint compute_modifier_flags(TRAPS) const;
 178 
 179  public:
 180   // Printing
 181   void print_on(outputStream* st) const;
 182   void print_value_on(outputStream* st) const;
 183 
 184   void oop_print_value_on(oop obj, outputStream* st);
 185 #ifndef PRODUCT
 186   void oop_print_on      (oop obj, outputStream* st);
 187 #endif //PRODUCT
 188 
 189   const char* internal_name() const;
 190 
 191   // Verification
 192   void verify_on(outputStream* st);
 193 
 194   void oop_verify_on(oop obj, outputStream* st);
 195 };
 196 
 197 #endif // SHARE_VM_OOPS_OBJARRAYKLASS_HPP