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