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