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