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_ARRAYKLASS_HPP
26 #define SHARE_OOPS_ARRAYKLASS_HPP
27
28 #include "oops/klass.hpp"
29
30 class fieldDescriptor;
31 class klassVtable;
32 class ObjArrayKlass;
33
34 // ArrayKlass is the abstract baseclass for all array classes
35
36 class ArrayKlass: public Klass {
37 friend class VMStructs;
38 private:
39 // If you add a new field that points to any metaspace object, you
40 // must add this field to ArrayKlass::metaspace_pointers_do().
41 int _dimension; // This is n'th-dimensional array.
42 ObjArrayKlass* volatile _higher_dimension; // Refers the (n+1)'th-dimensional array (if present).
43 ArrayKlass* volatile _lower_dimension; // Refers the (n-1)'th-dimensional array (if present).
44
45 protected:
46 // Constructors
47 // The constructor with the Symbol argument does the real array
48 // initialization, the other is a dummy
49 ArrayKlass(Symbol* name, KlassKind kind);
50 ArrayKlass();
51
52 public:
53 // Testing operation
54 DEBUG_ONLY(bool is_array_klass_slow() const override { return true; })
55
56 // Returns the ObjArrayKlass for n'th dimension.
57 ArrayKlass* array_klass(int n, TRAPS) override;
58 ArrayKlass* array_klass_or_null(int n) override;
59
60 // Returns the array class with this class as element type.
61 ArrayKlass* array_klass(TRAPS) override;
62 ArrayKlass* array_klass_or_null() override;
63
64 // Instance variables
65 int dimension() const { return _dimension; }
66 void set_dimension(int dimension) { _dimension = dimension; }
67
68 ObjArrayKlass* higher_dimension() const { return _higher_dimension; }
69 inline ObjArrayKlass* higher_dimension_acquire() const; // load with acquire semantics
70 void set_higher_dimension(ObjArrayKlass* k) { _higher_dimension = k; }
71 inline void release_set_higher_dimension(ObjArrayKlass* k); // store with release semantics
72
73 ArrayKlass* lower_dimension() const { return _lower_dimension; }
74 void set_lower_dimension(ArrayKlass* k) { _lower_dimension = k; }
75
76 // offset of first element, including any padding for the sake of alignment
77 int array_header_in_bytes() const { return layout_helper_header_size(layout_helper()); }
78 int log2_element_size() const { return layout_helper_log2_element_size(layout_helper()); }
79 // type of elements (T_OBJECT for both oop arrays and array-arrays)
80 BasicType element_type() const { return layout_helper_element_type(layout_helper()); }
81
82 InstanceKlass* java_super() const override;
83
84 // Allocation
85 // Sizes points to the first dimension of the array, subsequent dimensions
86 // are always in higher memory. The callers of these set that up.
87 virtual oop multi_allocate(int rank, jint* sizes, TRAPS);
90 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
91
92 // Lookup operations
93 Method* uncached_lookup_method(const Symbol* name,
94 const Symbol* signature,
95 OverpassLookupMode overpass_mode,
96 PrivateLookupMode private_mode = PrivateLookupMode::find) const override;
97
98 static ArrayKlass* cast(Klass* k) {
99 return const_cast<ArrayKlass*>(cast(const_cast<const Klass*>(k)));
100 }
101
102 static const ArrayKlass* cast(const Klass* k) {
103 assert(k->is_array_klass(), "cast to ArrayKlass");
104 return static_cast<const ArrayKlass*>(k);
105 }
106
107 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
108 Array<InstanceKlass*>* transitive_interfaces) override;
109
110 // Sizing
111 static int static_size(int header_size);
112
113 void metaspace_pointers_do(MetaspaceClosure* iter) override;
114
115 // Return a handle.
116 static void complete_create_array_klass(ArrayKlass* k, Klass* super_klass, ModuleEntry* module, TRAPS);
117
118 // JVMTI support
119 jint jvmti_class_status() const override;
120
121 #if INCLUDE_CDS
122 // CDS support - remove and restore oops from metadata. Oops are not shared.
123 void remove_unshareable_info() override;
124 void remove_java_mirror() override;
125 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
126 void cds_print_value_on(outputStream* st) const;
127 #endif
128
129 void log_array_class_load(Klass* k);
130 // Printing
131 void print_on(outputStream* st) const override;
132 void print_value_on(outputStream* st) const override;
133
134 void oop_print_on(oop obj, outputStream* st) override;
135
136 // Verification
137 void verify_on(outputStream* st) override;
138
139 void oop_verify_on(oop obj, outputStream* st) override;
140 };
141
142 #endif // SHARE_OOPS_ARRAYKLASS_HPP
|
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_ARRAYKLASS_HPP
26 #define SHARE_OOPS_ARRAYKLASS_HPP
27
28 #include "oops/arrayProperties.hpp"
29 #include "oops/klass.hpp"
30 #include "oops/layoutKind.hpp"
31
32 class fieldDescriptor;
33 class klassVtable;
34 class ObjArrayKlass;
35
36 // ArrayKlass is the abstract baseclass for all array classes
37
38 class ArrayKlass: public Klass {
39 friend class VMStructs;
40
41 public:
42 static ArrayProperties array_properties_from_layout(LayoutKind lk);
43
44 private:
45 // If you add a new field that points to any metaspace object, you
46 // must add this field to ArrayKlass::metaspace_pointers_do().
47 int _dimension; // This is n'th-dimensional array.
48 ArrayProperties _properties;
49 ObjArrayKlass* volatile _higher_dimension; // Refers the (n+1)'th-dimensional array (if present).
50 ArrayKlass* volatile _lower_dimension; // Refers the (n-1)'th-dimensional array (if present).
51
52 protected:
53 // Constructors
54 // The constructor with the Symbol argument does the real array
55 // initialization, the other is a dummy
56 ArrayKlass(Symbol* name, KlassKind kind, ArrayProperties props, markWord prototype_header = markWord::prototype());
57 ArrayKlass();
58
59 // Create array_name for element klass
60 static Symbol* create_element_klass_array_name(Klass* element_klass, TRAPS);
61
62 public:
63
64 // Testing operation
65 DEBUG_ONLY(bool is_array_klass_slow() const override { return true; })
66
67 // Returns the ObjArrayKlass for n'th dimension.
68 ArrayKlass* array_klass(int n, TRAPS) override;
69 ArrayKlass* array_klass_or_null(int n) override;
70
71 // Returns the array class with this class as element type.
72 ArrayKlass* array_klass(TRAPS) override;
73 ArrayKlass* array_klass_or_null() override;
74
75 // Instance variables
76 int dimension() const { return _dimension; }
77 void set_dimension(int dimension) { _dimension = dimension; }
78
79 ArrayProperties properties() const { return _properties; }
80 void set_properties(ArrayProperties props) { _properties = props; }
81 static ByteSize properties_offset() { return byte_offset_of(ArrayKlass, _properties); }
82
83 ObjArrayKlass* higher_dimension() const { return _higher_dimension; }
84 inline ObjArrayKlass* higher_dimension_acquire() const; // load with acquire semantics
85 void set_higher_dimension(ObjArrayKlass* k) { _higher_dimension = k; }
86 inline void release_set_higher_dimension(ObjArrayKlass* k); // store with release semantics
87
88 ArrayKlass* lower_dimension() const { return _lower_dimension; }
89 void set_lower_dimension(ArrayKlass* k) { _lower_dimension = k; }
90
91 // offset of first element, including any padding for the sake of alignment
92 int array_header_in_bytes() const { return layout_helper_header_size(layout_helper()); }
93 int log2_element_size() const { return layout_helper_log2_element_size(layout_helper()); }
94 // type of elements (T_OBJECT for both oop arrays and array-arrays)
95 BasicType element_type() const { return layout_helper_element_type(layout_helper()); }
96
97 InstanceKlass* java_super() const override;
98
99 // Allocation
100 // Sizes points to the first dimension of the array, subsequent dimensions
101 // are always in higher memory. The callers of these set that up.
102 virtual oop multi_allocate(int rank, jint* sizes, TRAPS);
105 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
106
107 // Lookup operations
108 Method* uncached_lookup_method(const Symbol* name,
109 const Symbol* signature,
110 OverpassLookupMode overpass_mode,
111 PrivateLookupMode private_mode = PrivateLookupMode::find) const override;
112
113 static ArrayKlass* cast(Klass* k) {
114 return const_cast<ArrayKlass*>(cast(const_cast<const Klass*>(k)));
115 }
116
117 static const ArrayKlass* cast(const Klass* k) {
118 assert(k->is_array_klass(), "cast to ArrayKlass");
119 return static_cast<const ArrayKlass*>(k);
120 }
121
122 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
123 Array<InstanceKlass*>* transitive_interfaces) override;
124
125 oop component_mirror() const;
126
127 // Sizing
128 static int static_size(int header_size);
129
130 void metaspace_pointers_do(MetaspaceClosure* iter) override;
131
132 // Return a handle.
133 static void complete_create_array_klass(ArrayKlass* k, Klass* super_klass, ModuleEntry* module, TRAPS);
134
135 // JVMTI support
136 jint jvmti_class_status() const override;
137
138 #if INCLUDE_CDS
139 // CDS support - remove and restore oops from metadata. Oops are not shared.
140 void remove_unshareable_info() override;
141 void remove_java_mirror() override;
142 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
143 void cds_print_value_on(outputStream* st) const;
144 #endif
145
146 void log_array_class_load(Klass* k);
147 // Printing
148 void print_on(outputStream* st) const override;
149 void print_value_on(outputStream* st) const override;
150
151 void oop_print_on(oop obj, outputStream* st) override;
152
153 // Verification
154 void verify_on(outputStream* st) override;
155
156 void oop_verify_on(oop obj, outputStream* st) override;
157 };
158
159 class ArrayDescription : public StackObj {
160 public:
161 Klass::KlassKind _kind;
162 ArrayProperties _properties;
163 LayoutKind _layout_kind;
164
165 ArrayDescription(Klass::KlassKind k, ArrayProperties p, LayoutKind lk) {
166 _kind = k;
167 _layout_kind = lk;
168 assert(lk == LayoutKind::REFERENCE || k != Klass::KlassKind::RefArrayKlassKind, "Sanity check");
169 assert(lk != LayoutKind::UNKNOWN, "Sanity check");
170
171 // Atomicity depends on the layout kind, which might be different than what
172 // the given properties says
173 const bool non_atomic = lk != LayoutKind::REFERENCE && !LayoutKindHelper::is_atomic_flat(lk);
174 _properties = p.with_non_atomic(non_atomic);
175 }
176 };
177
178 #endif // SHARE_OOPS_ARRAYKLASS_HPP
|