1 /*
2 * Copyright (c) 1999, 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 #include "ci/ciFlatArrayKlass.hpp"
26 #include "ci/ciInstanceKlass.hpp"
27 #include "ci/ciObjArrayKlass.hpp"
28 #include "ci/ciRefArrayKlass.hpp"
29 #include "ci/ciSymbol.hpp"
30 #include "ci/ciUtilities.hpp"
31 #include "ci/ciUtilities.inline.hpp"
32 #include "oops/objArrayKlass.hpp"
33 #include "runtime/signature.hpp"
34
35 // ciObjArrayKlass
36 //
37 // This class represents a Klass* in the HotSpot virtual machine
38 // whose Klass part is an ObjArrayKlass.
39
40 // ------------------------------------------------------------------
41 // ciObjArrayKlass::ciObjArrayKlass
42 //
43 // Constructor for loaded object array klasses.
44 ciObjArrayKlass::ciObjArrayKlass(Klass* k) : ciArrayKlass(k) {
45 assert(get_Klass()->is_objArray_klass(), "wrong type");
46 Klass* element_Klass = get_ObjArrayKlass()->bottom_klass();
47 _base_element_klass = CURRENT_ENV->get_klass(element_Klass);
48 assert(_base_element_klass->is_instance_klass() ||
49 _base_element_klass->is_type_array_klass(), "bad base klass");
50 if (dimension() == 1) {
51 _element_klass = _base_element_klass;
52 } else {
53 _element_klass = nullptr;
54 }
55 if (!ciObjectFactory::is_initialized()) {
56 assert(_element_klass->is_java_lang_Object(), "only arrays of object are shared");
57 }
58 }
59
60 // ------------------------------------------------------------------
61 // ciObjArrayKlass::ciObjArrayKlass
62 //
63 // Constructor for unloaded object array klasses.
64 ciObjArrayKlass::ciObjArrayKlass(ciSymbol* array_name,
65 ciKlass* base_element_klass,
66 int dimension)
67 : ciArrayKlass(array_name,
68 dimension, T_OBJECT) {
69 _base_element_klass = base_element_klass;
70 assert(_base_element_klass->is_instance_klass() ||
71 _base_element_klass->is_type_array_klass() ||
72 _base_element_klass->is_flat_array_klass() ||
73 _base_element_klass->is_ref_array_klass(), "bad base klass");
74 if (dimension == 1) {
75 _element_klass = base_element_klass;
76 } else {
77 _element_klass = nullptr;
78 }
79 }
80
81 // ------------------------------------------------------------------
82 // ciObjArrayKlass::element_klass
83 //
84 // What is the one-level element type of this array?
85 ciKlass* ciObjArrayKlass::element_klass() {
86 if (_element_klass == nullptr) {
87 assert(dimension() > 1, "_element_klass should not be null");
88 // Produce the element klass.
89 if (is_loaded()) {
90 VM_ENTRY_MARK;
91 Klass* element_Klass = get_ObjArrayKlass()->element_klass();
92 _element_klass = CURRENT_THREAD_ENV->get_klass(element_Klass);
93 } else {
94 VM_ENTRY_MARK;
95 // We are an unloaded array klass. Attempt to fetch our
96 // element klass by name.
97 _element_klass = CURRENT_THREAD_ENV->get_klass_by_name_impl(
98 this,
99 constantPoolHandle(),
100 construct_array_name(base_element_klass()->name(),
101 dimension() - 1),
102 false);
103 }
104 }
105 return _element_klass;
106 }
107
108 // ------------------------------------------------------------------
109 // ciObjArrayKlass::construct_array_name
110 //
111 // Build an array name from an element name and a dimension.
112 ciSymbol* ciObjArrayKlass::construct_array_name(ciSymbol* element_name,
113 int dimension) {
114 EXCEPTION_CONTEXT;
115 int element_len = element_name->utf8_length();
116 int buflen = dimension + element_len + 3; // '['+ + 'L'? + (element) + ';'? + '\0'
117 char* name = CURRENT_THREAD_ENV->name_buffer(buflen);
118 int pos = 0;
119 for ( ; pos < dimension; pos++) {
120 name[pos] = JVM_SIGNATURE_ARRAY;
121 }
122 Symbol* base_name_sym = element_name->get_symbol();
123 if (Signature::is_array(base_name_sym) ||
124 Signature::has_envelope(base_name_sym)) {
125 strncpy(&name[pos], (char*)element_name->base(), element_len);
126 name[pos + element_len] = '\0';
127 } else {
128 name[pos++] = JVM_SIGNATURE_CLASS;
129 strncpy(&name[pos], (char*)element_name->base(), element_len);
130 name[pos + element_len] = JVM_SIGNATURE_ENDCLASS;
131 name[pos + element_len + 1] = '\0';
132 }
133 return ciSymbol::make(name);
134 }
135
136 // ------------------------------------------------------------------
137 // ciObjArrayKlass::make_impl
138 //
139 // Implementation of make.
140 ciObjArrayKlass* ciObjArrayKlass::make_impl(ciKlass* element_klass, bool refined_type, bool null_free, bool atomic) {
141 if (element_klass->is_loaded()) {
142 EXCEPTION_CONTEXT;
143 // The element klass is loaded
144 Klass* array = element_klass->get_Klass()->array_klass(THREAD);
145 if (HAS_PENDING_EXCEPTION) {
146 CLEAR_PENDING_EXCEPTION;
147 CURRENT_THREAD_ENV->record_out_of_memory_failure();
148 return ciEnv::unloaded_ciobjarrayklass();
149 }
150 if (!refined_type) {
151 return CURRENT_THREAD_ENV->get_obj_array_klass(array);
152 }
153
154 ArrayKlass::ArrayProperties props = ArrayKlass::ArrayProperties::DEFAULT;
155 if (null_free) {
156 assert(element_klass->is_inlinetype(), "Only value class arrays can be null free");
157 props = (ArrayKlass::ArrayProperties)(props | ArrayKlass::ArrayProperties::NULL_RESTRICTED);
158 }
159 if (!atomic) {
160 assert(element_klass->is_inlinetype(), "Only value class arrays can be non-atomic");
161 props = (ArrayKlass::ArrayProperties)(props | ArrayKlass::ArrayProperties::NON_ATOMIC);
162 }
163 array = ObjArrayKlass::cast(array)->klass_with_properties(props, THREAD);
164 if (array->is_flatArray_klass()) {
165 return CURRENT_THREAD_ENV->get_flat_array_klass(array);
166 } else {
167 return CURRENT_THREAD_ENV->get_ref_array_klass(array);
168 }
169 }
170
171 // The array klass was unable to be made or the element klass was not loaded.
172 ciSymbol* array_name = construct_array_name(element_klass->name(), 1);
173 if (array_name == ciEnv::unloaded_cisymbol()) {
174 return ciEnv::unloaded_ciobjarrayklass();
175 }
176 return
177 CURRENT_ENV->get_unloaded_klass(element_klass, array_name)
178 ->as_obj_array_klass();
179 }
180
181 // ------------------------------------------------------------------
182 // ciObjArrayKlass::make
183 //
184 // Make an array klass corresponding to the specified primitive type.
185 ciObjArrayKlass* ciObjArrayKlass::make(ciKlass* element_klass, bool refined_type, bool null_free, bool atomic) {
186 GUARDED_VM_ENTRY(return make_impl(element_klass, refined_type, null_free, atomic);)
187 }
188
189 ciArrayKlass* ciObjArrayKlass::make(ciKlass* element_klass, int dims) {
190 ciKlass* klass = element_klass;
191 for (int i = 0; i < dims; i++) {
192 klass = ciObjArrayKlass::make(klass, /* refined_type = */ false);
193 }
194 return klass->as_array_klass();
195 }
196
197 ciKlass* ciObjArrayKlass::exact_klass() {
198 // This cannot be an exact klass because the refined types subtype it
199 return nullptr;
200 }