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 _has_trusted_loader;
63
64 ciFlags _flags;
65
66 // Lazy fields get filled in only upon request.
67 ciInstanceKlass* _super;
68 ciInstance* _java_mirror;
69
70 ciConstantPoolCache* _field_cache; // cached map index->field
71
72 // Fields declared in the bytecode (without nested fields in flat fields),
73 // ordered in JavaFieldStream order, with superclasses first (i.e. from lang.java.Object
74 // to most derived class).
75 const GrowableArray<ciField*>* _declared_nonstatic_fields;
76
77 // Fields laid out in memory (flat fields are expanded into their components). The ciField object
78 // for each primitive component has the holder being this ciInstanceKlass or one of its
79 // superclasses.
80 // Fields are in the same order as in _declared_nonstatic_fields, but flat fields are replaced by
81 // the list of their own fields, ordered the same way (hierarchy traversed top-down, in
82 // JavaFieldStream order).
83 const GrowableArray<ciField*>* _nonstatic_fields;
84
85 int _has_injected_fields; // any non static injected fields? lazily initialized.
86
87 // The possible values of the _implementor fall into following three cases:
88 // null: no implementor.
89 // A ciInstanceKlass that's not itself: one implementor.
90 // Itself: more than one implementor.
91 ciInstanceKlass* _implementor;
92 GrowableArray<ciInstanceKlass*>* _transitive_interfaces;
93
94 void compute_injected_fields();
95 bool compute_injected_fields_helper();
96 void compute_transitive_interfaces();
97
98 ciField* get_non_static_field_by_offset(int field_offset);
99
100 protected:
101 ciInstanceKlass(Klass* k);
102 ciInstanceKlass(ciSymbol* name, jobject loader, BasicType bt = T_OBJECT); // for unloaded klasses
103
104 InstanceKlass* get_instanceKlass() const {
105 return InstanceKlass::cast(get_Klass());
106 }
107
108 oop loader();
109 jobject loader_handle();
110
111 const char* type_string() { return "ciInstanceKlass"; }
112
113 bool is_in_package_impl(const char* packagename, int len);
114
115 void print_impl(outputStream* st);
116
117 ciConstantPoolCache* field_cache();
118
119 bool is_shared() { return _is_shared; }
120
121 void compute_shared_init_state();
122 bool compute_shared_has_subklass();
123 void compute_nonstatic_fields();
124 void compute_nonstatic_fields_impl(const GrowableArray<ciField*>* super_declared_fields, const GrowableArray<ciField*>* super_fields);
125 bool compute_has_trusted_loader();
126
127 // Update the init_state for shared klasses
128 void update_if_shared(InstanceKlass::ClassState expected) {
129 if (_is_shared && _init_state != expected) {
130 if (is_loaded()) compute_shared_init_state();
131 }
132 }
133
134 public:
135 // Has this klass been initialized?
136 bool is_initialized() {
137 update_if_shared(InstanceKlass::fully_initialized);
138 return _init_state == InstanceKlass::fully_initialized;
139 }
140 bool is_not_initialized() {
141 update_if_shared(InstanceKlass::fully_initialized);
142 return _init_state < InstanceKlass::being_initialized;
143 }
144 // Is this klass being initialized?
145 bool is_being_initialized() {
146 update_if_shared(InstanceKlass::being_initialized);
147 return _init_state == InstanceKlass::being_initialized;
148 }
149 // Has this klass been linked?
150 bool is_linked() {
151 update_if_shared(InstanceKlass::linked);
152 return _init_state >= InstanceKlass::linked;
153 }
154 // Is this klass in error state?
155 bool is_in_error_state() {
156 update_if_shared(InstanceKlass::initialization_error);
157 return _init_state == InstanceKlass::initialization_error;
158 }
159
160 // General klass information.
161 ciFlags flags() {
162 assert(is_loaded(), "must be loaded");
163 return _flags;
164 }
165
166 // Fetch Klass::access_flags.
167 jint access_flags() { return flags().as_int(); }
168
169 bool has_finalizer() {
170 assert(is_loaded(), "must be loaded");
171 return _has_finalizer; }
172 bool has_subklass() {
173 assert(is_loaded(), "must be loaded");
174 // Ignore cached subklass_false case.
175 // It could be invalidated by concurrent class loading and
176 // can result in type paradoxes during compilation when
177 // a subclass is observed, but has_subklass() returns false.
178 if (_has_subklass == subklass_true) {
179 return true;
180 }
181 if (flags().is_final()) {
182 return false;
183 }
184 return compute_shared_has_subklass();
185 }
186
187 jint layout_helper_size_in_bytes() {
188 return Klass::layout_helper_size_in_bytes(layout_helper());
189 }
190 jint size_helper() {
191 return (Klass::layout_helper_size_in_bytes(layout_helper())
192 >> LogHeapWordSize);
193 }
194 jint has_nonstatic_fields() {
195 assert(is_loaded(), "must be loaded");
196 return _has_nonstatic_fields; }
197 ciInstanceKlass* super();
198 jint nof_implementors() {
199 ciInstanceKlass* impl;
200 assert(is_loaded(), "must be loaded");
201 impl = implementor();
202 if (impl == nullptr) {
203 return 0;
204 } else if (impl != this) {
205 return 1;
206 } else {
207 return 2;
208 }
209 }
210 bool has_nonstatic_concrete_methods() {
211 assert(is_loaded(), "must be loaded");
212 return _has_nonstatic_concrete_methods;
213 }
214
215 bool is_hidden() const {
216 return _is_hidden;
217 }
218
219 bool is_record() const {
220 return _is_record;
221 }
222
223 ciInstanceKlass* get_canonical_holder(int offset);
224 ciField* get_field_by_offset(int field_offset, bool is_static);
225 ciField* get_field_by_name(ciSymbol* name, ciSymbol* signature, bool is_static);
226 // Get field descriptor at field_offset ignoring flattening
227 ciField* get_non_flat_field_by_offset(int field_offset);
228 // Get the index of the declared field that contains this offset
229 int field_index_by_offset(int offset);
230
231 // Total number of nonstatic fields (including inherited)
232 int nof_declared_nonstatic_fields() {
233 if (_declared_nonstatic_fields == nullptr) {
234 compute_nonstatic_fields();
235 }
236 return _declared_nonstatic_fields->length();
237 }
238 BasicType get_field_type_by_offset(int field_offset, bool is_static);
239
240 int nof_nonstatic_fields() {
241 if (_nonstatic_fields == nullptr) {
242 compute_nonstatic_fields();
243 }
244 return _nonstatic_fields->length();
245 }
246
247 bool has_injected_fields() {
248 if (_has_injected_fields == -1) {
249 compute_injected_fields();
250 }
251 return _has_injected_fields > 0 ? true : false;
252 }
253
254 bool has_object_fields() const;
255
256 ciField* declared_nonstatic_field_at(int i) {
257 assert(_declared_nonstatic_fields != nullptr, "should be initialized");
258 return _declared_nonstatic_fields->at(i);
259 }
260
261 ciField* nonstatic_field_at(int i) {
262 assert(_nonstatic_fields != nullptr, "");
263 return _nonstatic_fields->at(i);
264 }
265
266 ciInstanceKlass* unique_concrete_subklass();
267 bool has_finalizable_subclass();
268
269 bool has_class_initializer();
270
271 bool contains_field_offset(int offset);
272
273 // Get the instance of java.lang.Class corresponding to
274 // this klass. This instance is used for locking of
275 // synchronized static methods of this klass.
276 ciInstance* java_mirror();
277
278 // Java access flags
279 bool is_public () { return flags().is_public(); }
280 bool is_final () { return flags().is_final(); }
281 bool is_interface () { return flags().is_interface(); }
282 bool is_abstract () { return flags().is_abstract(); }
283 bool is_abstract_value_klass() { return is_abstract() && !flags().is_identity(); }
284
285 ciMethod* find_method(ciSymbol* name, ciSymbol* signature);
286 // Note: To find a method from name and type strings, use ciSymbol::make,
287 // but consider adding to vmSymbols.hpp instead.
288
289 bool is_leaf_type();
290 ciInstanceKlass* implementor();
291
292 ciInstanceKlass* unique_implementor() {
293 assert(is_loaded(), "must be loaded");
294 assert(is_interface(), "must be");
295 ciInstanceKlass* impl = implementor();
296 return (impl != this ? impl : nullptr);
297 }
298
299 virtual bool can_be_inline_klass(bool is_exact = false);
300
301 // Is the defining class loader of this class the default loader?
302 bool uses_default_loader() const;
303
304 bool is_java_lang_Object() const;
305
306 BasicType box_klass_type() const;
307 bool is_box_klass() const;
308 bool is_boxed_value_offset(int offset) const;
309
310 // Is this klass in the given package?
311 bool is_in_package(const char* packagename) {
312 return is_in_package(packagename, (int) strlen(packagename));
313 }
314 bool is_in_package(const char* packagename, int len);
315
316 // What kind of ciObject is this?
317 bool is_instance_klass() const { return true; }
318
319 virtual ciKlass* exact_klass() {
320 if (is_loaded() && is_final() && !is_interface()) {
321 return this;
322 }
323 return nullptr;
324 }
325
326 bool can_be_instantiated() {
327 assert(is_loaded(), "must be loaded");
328 return !is_interface() && !is_abstract();
329 }
330
331 bool has_trusted_loader() const {
332 return _has_trusted_loader;
333 }
334 GrowableArray<ciInstanceKlass*>* transitive_interfaces() const;
335
336 // Replay support
337
338 // Dump the current state of this klass for compilation replay.
339 virtual void dump_replay_data(outputStream* out);
340
341 static void dump_replay_instanceKlass(outputStream* out, InstanceKlass* ik);
342
343
344 // Return stable class name suitable for replay file.
345 const char *replay_name() const;
346
347 #ifdef ASSERT
348 bool debug_final_field_at(int offset);
349 bool debug_stable_field_at(int offset);
350 #endif
351 };
352
353 #endif // SHARE_CI_CIINSTANCEKLASS_HPP