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* _element_klass; // The klass of the elements of this array type
48 Klass* _bottom_klass; // The one-dimensional type (InstanceKlass or TypeArrayKlass)
49
50 // Constructor
51 ObjArrayKlass(int n, Klass* element_klass, Symbol* name);
52 static ObjArrayKlass* allocate_klass(ClassLoaderData* loader_data, int n, Klass* k, Symbol* name, TRAPS);
53
54 objArrayOop allocate_instance(int length, TRAPS);
55 public:
56 // For dummy objects
57 ObjArrayKlass() {}
58
59 // Instance variables
60 Klass* element_klass() const { return _element_klass; }
61 void set_element_klass(Klass* k) { _element_klass = k; }
62 Klass** element_klass_addr() { return &_element_klass; }
63
64 Klass* bottom_klass() const { return _bottom_klass; }
65 void set_bottom_klass(Klass* k) { _bottom_klass = k; }
66 Klass** bottom_klass_addr() { return &_bottom_klass; }
67
68 ModuleEntry* module() const;
69 PackageEntry* package() const;
70
71 // Compiler/Interpreter offset
72 static ByteSize element_klass_offset() { return byte_offset_of(ObjArrayKlass, _element_klass); }
73
74 // Dispatched operation
75 bool can_be_primary_super_slow() const;
76 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
77 Array<InstanceKlass*>* transitive_interfaces);
78 DEBUG_ONLY(bool is_objArray_klass_slow() const { return true; })
79 size_t oop_size(oop obj, markWord) const;
80
81 // Allocation
82 static ObjArrayKlass* allocate_objArray_klass(ClassLoaderData* loader_data,
83 int n, Klass* element_klass, TRAPS);
84
85 oop multi_allocate(int rank, jint* sizes, TRAPS);
86
87 // Copying
88 void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
89
90 // Compute protection domain
91 oop protection_domain() const { return bottom_klass()->protection_domain(); }
92
93 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
94
95 private:
96 // Either oop or narrowOop depending on UseCompressedOops.
97 // must be called from within ObjArrayKlass.cpp
98 void do_copy(arrayOop s, size_t src_offset,
99 arrayOop d, size_t dst_offset,
100 int length, TRAPS);
101 public:
102 static ObjArrayKlass* cast(Klass* k) {
103 return const_cast<ObjArrayKlass*>(cast(const_cast<const Klass*>(k)));
104 }
105
106 static const ObjArrayKlass* cast(const Klass* k) {
107 assert(k->is_objArray_klass(), "cast to ObjArrayKlass");
108 return static_cast<const ObjArrayKlass*>(k);
109 }
110
111 // Sizing
112 static int header_size() { return sizeof(ObjArrayKlass)/wordSize; }
113 int size() const { return ArrayKlass::static_size(header_size()); }
114
115 // Initialization (virtual from Klass)
116 void initialize(TRAPS);
117
118 // Oop fields (and metadata) iterators
119 //
120 // The ObjArrayKlass iterators also visits the Object's klass.
121
122 // Iterate over oop elements and metadata.
123 template <typename T, typename OopClosureType>
124 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
125
126 // Iterate over oop elements and metadata.
127 template <typename T, typename OopClosureType>
128 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
129
130 // Iterate over oop elements within mr, and metadata.
131 template <typename T, typename OopClosureType>
132 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
133
134 // Iterate over oop elements within [start, end), and metadata.
135 template <typename T, class OopClosureType>
136 inline void oop_oop_iterate_range(objArrayOop a, OopClosureType* closure, int start, int end);
137
138 public:
139 // Iterate over all oop elements.
140 template <typename T, class OopClosureType>
141 inline void oop_oop_iterate_elements(objArrayOop a, OopClosureType* closure);
142
143 private:
144 // Iterate over all oop elements with indices within mr.
145 template <typename T, class OopClosureType>
146 inline void oop_oop_iterate_elements_bounded(objArrayOop a, OopClosureType* closure, void* low, void* high);
147
148 public:
149 u2 compute_modifier_flags() const;
150
151 public:
152 // Printing
153 void print_on(outputStream* st) const;
154 void print_value_on(outputStream* st) const;
155
156 void oop_print_value_on(oop obj, outputStream* st);
157 #ifndef PRODUCT
158 void oop_print_on (oop obj, outputStream* st);
159 #endif //PRODUCT
160
161 const char* internal_name() const;
162
163 // Verification
164 void verify_on(outputStream* st);
165
166 void oop_verify_on(oop obj, outputStream* st);
167 };
168
169 #endif // SHARE_OOPS_OBJARRAYKLASS_HPP