1 /*
2 * Copyright (c) 1997, 2026, 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_OOPS_OBJARRAYKLASS_HPP
26 #define SHARE_OOPS_OBJARRAYKLASS_HPP
27
28 #include "oops/arrayKlass.hpp"
29 #include "utilities/macros.hpp"
30
31 class ClassLoaderData;
32
33 // ObjArrayKlass is the klass for objArrays
34
35 class ObjArrayKlass : public ArrayKlass {
36 friend class Deoptimization;
37 friend class JVMCIVMStructs;
38 friend class oopFactory;
39 friend class VMStructs;
40
41 public:
42 static const KlassKind Kind = ObjArrayKlassKind;
43
44 private:
45 // If you add a new field that points to any metaspace object, you
46 // must add this field to ObjArrayKlass::metaspace_pointers_do().
47 Klass* _bottom_klass; // The one-dimensional type (InstanceKlass or TypeArrayKlass)
48 protected:
49 Klass* _element_klass; // The klass of the elements of this array type
50 ObjArrayKlass* _next_refined_array_klass;
51
52 protected:
53 // Constructor
54 ObjArrayKlass(int n, Klass* element_klass, Symbol* name, KlassKind kind, ArrayProperties props, markWord mw);
55 static ObjArrayKlass* allocate_klass(ClassLoaderData* loader_data, int n, Klass* k, Symbol* name, ArrayProperties props, TRAPS);
56
57 static ArrayDescription array_layout_selection(Klass* element, ArrayProperties properties);
58 ObjArrayKlass* allocate_klass_from_description(ArrayDescription ad, TRAPS);
59 virtual objArrayOop allocate_instance(int length, ArrayProperties props, TRAPS);
60
61 // Create array_name for element klass
62 static Symbol* create_element_klass_array_name(JavaThread* current, Klass* element_klass);
63
64 public:
65 // For dummy objects
66 ObjArrayKlass() {}
67
68 virtual Klass* element_klass() const { return _element_klass; }
69 virtual void set_element_klass(Klass* k) { _element_klass = k; }
70
71
72 ObjArrayKlass* next_refined_array_klass() const { return _next_refined_array_klass; }
73 inline ObjArrayKlass* next_refined_array_klass_acquire() const;
74 void set_next_refined_klass_klass(ObjArrayKlass* ak) { _next_refined_array_klass = ak; }
75 inline void release_set_next_refined_klass(ObjArrayKlass* ak);
76 ObjArrayKlass* klass_with_properties(ArrayProperties props, TRAPS);
77 ObjArrayKlass* klass_from_description(ArrayDescription adesc, TRAPS);
78 static ByteSize next_refined_array_klass_offset() { return byte_offset_of(ObjArrayKlass, _next_refined_array_klass); }
79 bool find_refined_array_klass(ObjArrayKlass* k);
80
81 // Compiler/Interpreter offset
82 static ByteSize element_klass_offset() { return byte_offset_of(ObjArrayKlass, _element_klass); }
83
84 Klass* bottom_klass() const { return _bottom_klass; }
85 void set_bottom_klass(Klass* k) { _bottom_klass = k; }
86 Klass** bottom_klass_addr() { return &_bottom_klass; }
87
88 ModuleEntry* module() const override;
89 PackageEntry* package() const override;
90
91 // Dispatched operation
92 bool can_be_primary_super_slow() const override;
93 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
94 Array<InstanceKlass*>* transitive_interfaces) override;
95 DEBUG_ONLY(bool is_objArray_klass_slow() const override { return true; })
96 size_t oop_size(oop obj) const override;
97
98 // Allocation
99 static ObjArrayKlass* allocate_objArray_klass(ClassLoaderData* loader_data,
100 int n, Klass* element_klass, TRAPS);
101
102 oop multi_allocate(int rank, jint* sizes, TRAPS) override;
103
104 // Copying
105 void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS) override;
106
107 // Compute protection domain
108 oop protection_domain() const override { return bottom_klass()->protection_domain(); }
109
110 void metaspace_pointers_do(MetaspaceClosure* iter) override;
111
112 #if INCLUDE_CDS
113 void remove_unshareable_info() override;
114 void remove_java_mirror() override;
115 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
116 #endif
117
118 public:
119 static ObjArrayKlass* cast(Klass* k) {
120 return const_cast<ObjArrayKlass*>(cast(const_cast<const Klass*>(k)));
121 }
122
123 static const ObjArrayKlass* cast(const Klass* k) {
124 assert(k->is_objArray_klass(), "cast to ObjArrayKlass");
125 return static_cast<const ObjArrayKlass*>(k);
126 }
127
128 // Sizing
129 static int header_size() { return sizeof(ObjArrayKlass)/wordSize; }
130 int size() const override { return ArrayKlass::static_size(header_size()); }
131
132 // Initialization (virtual from Klass)
133 void initialize(TRAPS) override;
134
135 // Oop fields (and metadata) iterators
136 //
137 // The ObjArrayKlass iterators also visits the Object's klass.
138
139 // Iterate over oop elements and metadata.
140 template <typename T, typename OopClosureType>
141 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
142
143 // Iterate over oop elements and metadata.
144 template <typename T, typename OopClosureType>
145 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
146
147 // Iterate over oop elements within mr, and metadata.
148 template <typename T, typename OopClosureType>
149 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
150
151 // Iterate over all oop elements, and no metadata.
152 template <typename T, class OopClosureType>
153 inline void oop_oop_iterate_elements(objArrayOop a, OopClosureType* closure);
154
155 // Iterate over oop elements within index range [start, end), and no metadata.
156 template <typename T, class OopClosureType>
157 inline void oop_oop_iterate_elements_range(objArrayOop a, OopClosureType* closure, int start, int end);
158
159 private:
160 // Iterate over all oop elements bounded by addresses [low, high), and no metadata.
161 template <typename T, class OopClosureType>
162 inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, void* low, void* high);
163
164 public:
165 u2 compute_modifier_flags() const override;
166
167 public:
168 // Printing
169 void print_on(outputStream* st) const override;
170 void print_value_on(outputStream* st) const override;
171
172 void oop_print_value_on(oop obj, outputStream* st) override;
173 #ifndef PRODUCT
174 void oop_print_on (oop obj, outputStream* st) override;
175 #endif //PRODUCT
176
177 const char* internal_name() const override;
178
179 // Verification
180 void verify_on(outputStream* st) override;
181
182 void oop_verify_on(oop obj, outputStream* st) override;
183 };
184
185 #endif // SHARE_OOPS_OBJARRAYKLASS_HPP