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