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