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 #ifndef SHARE_CI_CIINSTANCEKLASS_HPP
26 #define SHARE_CI_CIINSTANCEKLASS_HPP
27
28 #include "ci/ciConstantPoolCache.hpp"
29 #include "ci/ciFlags.hpp"
30 #include "ci/ciKlass.hpp"
31 #include "ci/ciSymbol.hpp"
32 #include "oops/instanceKlass.hpp"
33
34 // ciInstanceKlass
35 //
36 // This class represents a Klass* in the HotSpot virtual machine
37 // whose Klass part is an InstanceKlass. It may or may not
38 // be loaded.
39 class ciInstanceKlass : public ciKlass {
40 CI_PACKAGE_ACCESS
41 friend class ciBytecodeStream;
42 friend class ciEnv;
43 friend class ciExceptionHandler;
44 friend class ciMethod;
45 friend class ciField;
46 friend class ciReplay;
47 friend class CompileTrainingData;
48
49 private:
50 enum SubklassValue { subklass_unknown, subklass_false, subklass_true };
51
52 jobject _loader;
53
54 InstanceKlass::ClassState _init_state; // state of class
55 bool _is_shared;
56 bool _has_finalizer;
57 SubklassValue _has_subklass;
58 bool _has_nonstatic_fields;
59 bool _has_nonstatic_concrete_methods;
60 bool _is_hidden;
61 bool _is_record;
62 bool _trust_final_fields;
63 bool _has_trusted_loader;
64
65 ciFlags _flags;
66
67 // Lazy fields get filled in only upon request.
68 ciInstanceKlass* _super;
69 ciInstance* _java_mirror;
70
71 ciConstantPoolCache* _field_cache; // cached map index->field
72 GrowableArray<ciField*>* _nonstatic_fields; // ordered by JavaFieldStream
73 int _has_injected_fields; // any non static injected fields? lazily initialized.
74
75 // The possible values of the _implementor fall into following three cases:
76 // null: no implementor.
77 // A ciInstanceKlass that's not itself: one implementor.
78 // Itself: more than one implementor.
79 ciInstanceKlass* _implementor;
80 GrowableArray<ciInstanceKlass*>* _transitive_interfaces;
81
82 void compute_injected_fields();
83 bool compute_injected_fields_helper();
84 void compute_transitive_interfaces();
85
86 ciField* get_non_static_field_by_offset(int field_offset);
87
88 protected:
89 ciInstanceKlass(Klass* k);
90 ciInstanceKlass(ciSymbol* name, jobject loader);
91
92 InstanceKlass* get_instanceKlass() const {
93 return InstanceKlass::cast(get_Klass());
94 }
95
96 oop loader();
97 jobject loader_handle();
98
99 const char* type_string() { return "ciInstanceKlass"; }
100
101 bool is_in_package_impl(const char* packagename, int len);
102
103 void print_impl(outputStream* st);
104
105 ciConstantPoolCache* field_cache();
106
107 bool is_shared() { return _is_shared; }
108
109 void compute_shared_init_state();
110 bool compute_shared_has_subklass();
111 int compute_nonstatic_fields();
112 GrowableArray<ciField*>* compute_nonstatic_fields_impl(GrowableArray<ciField*>* super_fields);
113 bool compute_has_trusted_loader();
114
115 // Update the init_state for shared klasses
116 void update_if_shared(InstanceKlass::ClassState expected) {
117 if (_is_shared && _init_state != expected) {
118 if (is_loaded()) compute_shared_init_state();
119 }
120 }
121
122 public:
123 // Has this klass been initialized?
124 bool is_initialized() {
125 update_if_shared(InstanceKlass::fully_initialized);
126 return _init_state == InstanceKlass::fully_initialized;
127 }
128 bool is_not_initialized() {
129 update_if_shared(InstanceKlass::fully_initialized);
130 return _init_state < InstanceKlass::being_initialized;
131 }
132 // Is this klass being initialized?
133 bool is_being_initialized() {
134 update_if_shared(InstanceKlass::being_initialized);
135 return _init_state == InstanceKlass::being_initialized;
136 }
137 // Has this klass been linked?
138 bool is_linked() {
139 update_if_shared(InstanceKlass::linked);
140 return _init_state >= InstanceKlass::linked;
141 }
142 // Is this klass in error state?
143 bool is_in_error_state() {
144 update_if_shared(InstanceKlass::initialization_error);
145 return _init_state == InstanceKlass::initialization_error;
146 }
147
148 // General klass information.
149 ciFlags flags() {
150 assert(is_loaded(), "must be loaded");
151 return _flags;
152 }
153
154 // Fetch Klass::access_flags.
155 jint access_flags() { return flags().as_int(); }
156
157 bool has_finalizer() {
158 assert(is_loaded(), "must be loaded");
159 return _has_finalizer; }
160 bool has_subklass() {
161 assert(is_loaded(), "must be loaded");
162 // Ignore cached subklass_false case.
163 // It could be invalidated by concurrent class loading and
164 // can result in type paradoxes during compilation when
165 // a subclass is observed, but has_subklass() returns false.
166 if (_has_subklass == subklass_true) {
167 return true;
168 }
169 if (flags().is_final()) {
170 return false;
171 }
172 return compute_shared_has_subklass();
173 }
174
175 jint layout_helper_size_in_bytes() {
176 return Klass::layout_helper_size_in_bytes(layout_helper());
177 }
178 jint size_helper() {
179 return (Klass::layout_helper_size_in_bytes(layout_helper())
180 >> LogHeapWordSize);
181 }
182 jint has_nonstatic_fields() {
183 assert(is_loaded(), "must be loaded");
184 return _has_nonstatic_fields; }
185 ciInstanceKlass* super();
186 jint nof_implementors() {
187 ciInstanceKlass* impl;
188 assert(is_loaded(), "must be loaded");
189 impl = implementor();
190 if (impl == nullptr) {
191 return 0;
192 } else if (impl != this) {
193 return 1;
194 } else {
195 return 2;
196 }
197 }
198 bool has_nonstatic_concrete_methods() {
199 assert(is_loaded(), "must be loaded");
200 return _has_nonstatic_concrete_methods;
201 }
202
203 bool is_hidden() const {
204 return _is_hidden;
205 }
206
207 bool is_record() const {
208 return _is_record;
209 }
210
211 bool trust_final_fields() const {
212 return _trust_final_fields;
213 }
214
215 ciInstanceKlass* get_canonical_holder(int offset);
216 ciField* get_field_by_offset(int field_offset, bool is_static);
217 ciField* get_field_by_name(ciSymbol* name, ciSymbol* signature, bool is_static);
218 BasicType get_field_type_by_offset(int field_offset, bool is_static);
219
220 // total number of nonstatic fields (including inherited):
221 int nof_nonstatic_fields() {
222 if (_nonstatic_fields == nullptr)
223 return compute_nonstatic_fields();
224 else
225 return _nonstatic_fields->length();
226 }
227
228 bool has_injected_fields() {
229 if (_has_injected_fields == -1) {
230 compute_injected_fields();
231 }
232 return _has_injected_fields > 0 ? true : false;
233 }
234
235 bool has_object_fields() const;
236
237 // nth nonstatic field (presented by ascending address)
238 ciField* nonstatic_field_at(int i) {
239 assert(_nonstatic_fields != nullptr, "");
240 return _nonstatic_fields->at(i);
241 }
242
243 ciInstanceKlass* unique_concrete_subklass();
244 bool has_finalizable_subclass();
245
246 bool has_class_initializer();
247
248 bool contains_field_offset(int offset);
249
250 // Get the instance of java.lang.Class corresponding to
251 // this klass. This instance is used for locking of
252 // synchronized static methods of this klass.
253 ciInstance* java_mirror();
254
255 // Java access flags
256 bool is_public () { return flags().is_public(); }
257 bool is_final () { return flags().is_final(); }
258 bool is_super () { return flags().is_super(); }
259 bool is_interface () { return flags().is_interface(); }
260 bool is_abstract () { return flags().is_abstract(); }
261
262 ciMethod* find_method(ciSymbol* name, ciSymbol* signature);
263 // Note: To find a method from name and type strings, use ciSymbol::make,
264 // but consider adding to vmSymbols.hpp instead.
265
266 bool is_leaf_type();
267 ciInstanceKlass* implementor();
268
269 ciInstanceKlass* unique_implementor() {
270 assert(is_loaded(), "must be loaded");
271 assert(is_interface(), "must be");
272 ciInstanceKlass* impl = implementor();
273 return (impl != this ? impl : nullptr);
274 }
275
276 // Is the defining class loader of this class the default loader?
277 bool uses_default_loader() const;
278
279 bool is_java_lang_Object() const;
280
281 BasicType box_klass_type() const;
282 bool is_box_klass() const;
283 bool is_boxed_value_offset(int offset) const;
284
285 // Is this klass in the given package?
286 bool is_in_package(const char* packagename) {
287 return is_in_package(packagename, (int) strlen(packagename));
288 }
289 bool is_in_package(const char* packagename, int len);
290
291 // What kind of ciObject is this?
292 bool is_instance_klass() const { return true; }
293
294 virtual ciKlass* exact_klass() {
295 if (is_loaded() && is_final() && !is_interface()) {
296 return this;
297 }
298 return nullptr;
299 }
300
301 bool can_be_instantiated() {
302 assert(is_loaded(), "must be loaded");
303 return !is_interface() && !is_abstract();
304 }
305
306 bool has_trusted_loader() const {
307 return _has_trusted_loader;
308 }
309 GrowableArray<ciInstanceKlass*>* transitive_interfaces() const;
310
311 // Replay support
312
313 // Dump the current state of this klass for compilation replay.
314 virtual void dump_replay_data(outputStream* out);
315
316 static void dump_replay_instanceKlass(outputStream* out, InstanceKlass* ik);
317
318
319 // Return stable class name suitable for replay file.
320 const char *replay_name() const;
321
322 #ifdef ASSERT
323 bool debug_final_field_at(int offset);
324 bool debug_stable_field_at(int offset);
325 #endif
326 };
327
328 #endif // SHARE_CI_CIINSTANCEKLASS_HPP