1 /*
  2  * Copyright (c) 2017, 2020, 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_FLATARRAYKLASS_HPP
 26 #define SHARE_VM_OOPS_FLATARRAYKLASS_HPP
 27 
 28 #include "classfile/classLoaderData.hpp"
 29 #include "oops/arrayKlass.hpp"
 30 #include "oops/inlineKlass.hpp"
 31 #include "utilities/macros.hpp"
 32 
 33 /**
 34  * Array of inline types, gives a layout of typeArrayOop, but needs oops iterators
 35  */
 36 class FlatArrayKlass : public ArrayKlass {
 37   friend class VMStructs;
 38 
 39  public:
 40   static const KlassKind Kind = FlatArrayKlassKind;
 41 
 42  private:
 43   // Constructor
 44   FlatArrayKlass(Klass* element_klass, Symbol* name);
 45 
 46  public:
 47 
 48   FlatArrayKlass() {}
 49 
 50   virtual InlineKlass* element_klass() const;
 51   virtual void set_element_klass(Klass* k);
 52 
 53   // Casting from Klass*
 54   static FlatArrayKlass* cast(Klass* k) {
 55     assert(k->is_flatArray_klass(), "cast to FlatArrayKlass");
 56     return (FlatArrayKlass*) k;
 57   }
 58 
 59   // klass allocation
 60   static FlatArrayKlass* allocate_klass(Klass* element_klass, TRAPS);
 61 
 62   void initialize(TRAPS);
 63 
 64   ModuleEntry* module() const;
 65   PackageEntry* package() const;
 66 
 67   bool can_be_primary_super_slow() const;
 68   GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
 69                                                   Array<InstanceKlass*>* transitive_interfaces);
 70 
 71   int element_byte_size() const { return 1 << layout_helper_log2_element_size(_layout_helper); }
 72 
 73   bool is_flatArray_klass_slow() const { return true; }
 74 
 75   bool contains_oops() {
 76     return element_klass()->contains_oops();
 77   }
 78 
 79   // Override.
 80   bool element_access_must_be_atomic() {
 81     return element_klass()->must_be_atomic();
 82   }
 83 
 84   oop protection_domain() const;
 85 
 86   virtual void metaspace_pointers_do(MetaspaceClosure* iter);
 87 
 88   static jint array_layout_helper(InlineKlass* vklass); // layout helper for values
 89 
 90   // sizing
 91   static int header_size()  { return sizeof(FlatArrayKlass)/HeapWordSize; }
 92   int size() const          { return ArrayKlass::static_size(header_size()); }
 93 
 94   jint max_elements() const;
 95 
 96   size_t oop_size(oop obj) const;
 97 
 98   // Oop Allocation
 99   flatArrayOop allocate(int length, 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 
114   template <typename T, typename OopClosureType>
115   inline void oop_oop_iterate(oop obj, OopClosureType* closure);
116 
117   template <typename T, typename OopClosureType>
118   inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
119 
120   template <typename T, typename OopClosureType>
121   inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
122 
123   template <typename T, class OopClosureType>
124   inline void oop_oop_iterate_elements(flatArrayOop a, OopClosureType* closure);
125 
126 private:
127   template <typename T, class OopClosureType>
128   inline void oop_oop_iterate_elements_specialized(flatArrayOop a, OopClosureType* closure);
129 
130   template <typename T, class OopClosureType>
131   inline void oop_oop_iterate_elements_bounded(flatArrayOop a, OopClosureType* closure, MemRegion mr);
132 
133   template <typename T, class OopClosureType>
134   inline void oop_oop_iterate_elements_specialized_bounded(flatArrayOop a, OopClosureType* closure, void* low, void* high);
135 
136  public:
137   jint compute_modifier_flags() const;
138 
139   // Printing
140   void print_on(outputStream* st) const;
141   void print_value_on(outputStream* st) const;
142 
143   void oop_print_value_on(oop obj, outputStream* st);
144 #ifndef PRODUCT
145   void oop_print_on(oop obj, outputStream* st);
146 #endif
147 
148   // Verification
149   void verify_on(outputStream* st);
150   void oop_verify_on(oop obj, outputStream* st);
151 };
152 
153 #endif