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