1 /*
2 * Copyright (c) 1997, 2025, 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, ArrayKlass::ArrayProperties props, markWord mw);
55 static ObjArrayKlass* allocate_klass(ClassLoaderData* loader_data, int n, Klass* k, Symbol* name, ArrayKlass::ArrayProperties props, TRAPS);
56
57 static ArrayDescription array_layout_selection(Klass* element, ArrayProperties properties);
58 virtual objArrayOop allocate_instance(int length, ArrayProperties props, TRAPS);
59
60 // Create array_name for element klass
61 static Symbol* create_element_klass_array_name(JavaThread* current, Klass* element_klass);
62
63 public:
64 // For dummy objects
65 ObjArrayKlass() {}
66
67 virtual Klass* element_klass() const { return _element_klass; }
68 virtual void set_element_klass(Klass* k) { _element_klass = k; }
69
70 // Compiler/Interpreter offset
71 static ByteSize element_klass_offset() { return in_ByteSize(offset_of(ObjArrayKlass, _element_klass)); }
72
73 ObjArrayKlass* next_refined_array_klass() const { return _next_refined_array_klass; }
74 inline ObjArrayKlass* next_refined_array_klass_acquire() const;
75 void set_next_refined_klass_klass(ObjArrayKlass* ak) { _next_refined_array_klass = ak; }
76 inline void release_set_next_refined_klass(ObjArrayKlass* ak);
77 ObjArrayKlass* klass_with_properties(ArrayKlass::ArrayProperties properties, TRAPS);
78 static ByteSize next_refined_array_klass_offset() { return byte_offset_of(ObjArrayKlass, _next_refined_array_klass); }
79
80 Klass* bottom_klass() const { return _bottom_klass; }
81 void set_bottom_klass(Klass* k) { _bottom_klass = k; }
82 Klass** bottom_klass_addr() { return &_bottom_klass; }
83
84 ModuleEntry* module() const;
85 PackageEntry* package() const;
86
87 // Dispatched operation
88 bool can_be_primary_super_slow() const;
89 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
90 Array<InstanceKlass*>* transitive_interfaces);
91 DEBUG_ONLY(bool is_objArray_klass_slow() const { return true; })
92 size_t oop_size(oop obj) const;
93
94 // Allocation
95 static ObjArrayKlass* allocate_objArray_klass(ClassLoaderData* loader_data,
96 int n, Klass* element_klass, TRAPS);
97
98 oop multi_allocate(int rank, jint* sizes, TRAPS);
99
100 // Copying
101 void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
102
103 // Compute protection domain
104 oop protection_domain() const { return bottom_klass()->protection_domain(); }
105
106 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
107
108 #if INCLUDE_CDS
109 virtual void remove_unshareable_info();
110 virtual void remove_java_mirror();
111 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
112 #endif
113
114 public:
115 static ObjArrayKlass* cast(Klass* k) {
116 return const_cast<ObjArrayKlass*>(cast(const_cast<const Klass*>(k)));
117 }
118
119 static const ObjArrayKlass* cast(const Klass* k) {
120 assert(k->is_objArray_klass(), "cast to ObjArrayKlass");
121 return static_cast<const ObjArrayKlass*>(k);
122 }
123
124 // Sizing
125 static int header_size() { return sizeof(ObjArrayKlass)/wordSize; }
126 int size() const { return ArrayKlass::static_size(header_size()); }
127
128 // Initialization (virtual from Klass)
129 void initialize(TRAPS);
130
131 // Oop fields (and metadata) iterators
132 //
133 // The ObjArrayKlass iterators also visits the Object's klass.
134
135 // Iterate over oop elements and metadata.
136 template <typename T, typename OopClosureType>
137 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
138
139 // Iterate over oop elements and metadata.
140 template <typename T, typename OopClosureType>
141 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
142
143 // Iterate over oop elements within mr, and metadata.
144 template <typename T, typename OopClosureType>
145 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
146
147 // Iterate over oop elements within [start, end), and metadata.
148 template <typename T, class OopClosureType>
149 inline void oop_oop_iterate_range(objArrayOop a, OopClosureType* closure, int start, int end);
150
151 public:
152 // Iterate over all oop elements.
153 template <typename T, class OopClosureType>
154 inline void oop_oop_iterate_elements(objArrayOop a, OopClosureType* closure);
155
156 private:
157 // Iterate over all oop elements with indices within mr.
158 template <typename T, class OopClosureType>
159 inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, void* low, void* high);
160
161 public:
162 u2 compute_modifier_flags() const;
163
164 public:
165 // Printing
166 void print_on(outputStream* st) const;
167 void print_value_on(outputStream* st) const;
168
169 virtual void oop_print_value_on(oop obj, outputStream* st);
170 #ifndef PRODUCT
171 virtual void oop_print_on (oop obj, outputStream* st);
172 #endif //PRODUCT
173
174 const char* internal_name() const;
175
176 // Verification
177 void verify_on(outputStream* st);
178
179 void oop_verify_on(oop obj, outputStream* st);
180 };
181
182 #endif // SHARE_OOPS_OBJARRAYKLASS_HPP