1 /*
2 * Copyright (c) 1999, 2023, 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 jobject _protection_domain;
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 GrowableArray<ciField*>* _nonstatic_fields;
72 int _has_injected_fields; // any non static injected fields? lazily initialized.
73
74 // The possible values of the _implementor fall into following three cases:
75 // null: no implementor.
76 // A ciInstanceKlass that's not itself: one implementor.
77 // Itself: more than one implementor.
78 ciInstanceKlass* _implementor;
79 GrowableArray<ciInstanceKlass*>* _transitive_interfaces;
80
81 void compute_injected_fields();
82 bool compute_injected_fields_helper();
83 void compute_transitive_interfaces();
84
85 protected:
86 ciInstanceKlass(Klass* k);
87 ciInstanceKlass(ciSymbol* name, jobject loader, jobject protection_domain);
88
89 InstanceKlass* get_instanceKlass() const {
90 return InstanceKlass::cast(get_Klass());
91 }
92
93 oop loader();
94 jobject loader_handle();
95
96 oop protection_domain();
97 jobject protection_domain_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 bool has_finalizer() {
154 assert(is_loaded(), "must be loaded");
155 return _has_finalizer; }
156 bool has_subklass() {
157 assert(is_loaded(), "must be loaded");
158 // Ignore cached subklass_false case.
159 // It could be invalidated by concurrent class loading and
160 // can result in type paradoxes during compilation when
161 // a subclass is observed, but has_subklass() returns false.
162 if (_has_subklass == subklass_true) {
163 return true;
164 }
165 if (flags().is_final()) {
166 return false;
167 }
168 return compute_shared_has_subklass();
169 }
170
171 jint layout_helper_size_in_bytes() {
172 return Klass::layout_helper_size_in_bytes(layout_helper());
173 }
174 jint size_helper() {
175 return (Klass::layout_helper_size_in_bytes(layout_helper())
176 >> LogHeapWordSize);
177 }
178 jint has_nonstatic_fields() {
179 assert(is_loaded(), "must be loaded");
180 return _has_nonstatic_fields; }
181 ciInstanceKlass* super();
182 jint nof_implementors() {
183 ciInstanceKlass* impl;
184 assert(is_loaded(), "must be loaded");
185 impl = implementor();
186 if (impl == nullptr) {
187 return 0;
188 } else if (impl != this) {
189 return 1;
190 } else {
191 return 2;
192 }
193 }
194 bool has_nonstatic_concrete_methods() {
195 assert(is_loaded(), "must be loaded");
196 return _has_nonstatic_concrete_methods;
197 }
198
199 bool is_hidden() const {
200 return _is_hidden;
201 }
202
203 bool is_record() const {
204 return _is_record;
205 }
206
207 ciInstanceKlass* get_canonical_holder(int offset);
208 ciField* get_field_by_offset(int field_offset, bool is_static);
209 ciField* get_field_by_name(ciSymbol* name, ciSymbol* signature, bool is_static);
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 bool has_injected_fields() {
220 if (_has_injected_fields == -1) {
221 compute_injected_fields();
222 }
223 return _has_injected_fields > 0 ? true : false;
224 }
225
226 bool has_object_fields() const;
227
228 // nth nonstatic field (presented by ascending address)
229 ciField* nonstatic_field_at(int i) {
230 assert(_nonstatic_fields != nullptr, "");
231 return _nonstatic_fields->at(i);
232 }
233
234 ciInstanceKlass* unique_concrete_subklass();
235 bool has_finalizable_subclass();
236
237 bool contains_field_offset(int offset);
238
239 // Get the instance of java.lang.Class corresponding to
240 // this klass. This instance is used for locking of
241 // synchronized static methods of this klass.
242 ciInstance* java_mirror();
243
244 // Java access flags
245 bool is_public () { return flags().is_public(); }
246 bool is_final () { return flags().is_final(); }
247 bool is_super () { return flags().is_super(); }
248 bool is_interface () { return flags().is_interface(); }
249 bool is_abstract () { return flags().is_abstract(); }
250
251 ciMethod* find_method(ciSymbol* name, ciSymbol* signature);
252 // Note: To find a method from name and type strings, use ciSymbol::make,
253 // but consider adding to vmSymbols.hpp instead.
254
255 bool is_leaf_type();
256 ciInstanceKlass* implementor();
257
258 ciInstanceKlass* unique_implementor() {
259 assert(is_loaded(), "must be loaded");
260 ciInstanceKlass* impl = implementor();
261 return (impl != this ? impl : nullptr);
262 }
263
264 // Is the defining class loader of this class the default loader?
265 bool uses_default_loader() const;
266
267 bool is_java_lang_Object() const;
268
269 BasicType box_klass_type() const;
270 bool is_box_klass() const;
271 bool is_boxed_value_offset(int offset) const;
272
273 // Is this klass in the given package?
274 bool is_in_package(const char* packagename) {
275 return is_in_package(packagename, (int) strlen(packagename));
276 }
277 bool is_in_package(const char* packagename, int len);
278
279 // What kind of ciObject is this?
280 bool is_instance_klass() const { return true; }
281
282 virtual ciKlass* exact_klass() {
283 if (is_loaded() && is_final() && !is_interface()) {
284 return this;
285 }
286 return nullptr;
287 }
288
289 bool can_be_instantiated() {
290 assert(is_loaded(), "must be loaded");
291 return !is_interface() && !is_abstract();
292 }
293
294 bool has_trusted_loader() const {
295 return _has_trusted_loader;
296 }
297 GrowableArray<ciInstanceKlass*>* transitive_interfaces() const;
298
299 // Replay support
300
301 // Dump the current state of this klass for compilation replay.
302 virtual void dump_replay_data(outputStream* out);
303
304 static void dump_replay_instanceKlass(outputStream* out, InstanceKlass* ik);
305
306
307 // Return stable class name suitable for replay file.
308 const char *replay_name() const;
309
310 #ifdef ASSERT
311 bool debug_final_field_at(int offset);
312 bool debug_stable_field_at(int offset);
313 #endif
314 };
315
316 #endif // SHARE_CI_CIINSTANCEKLASS_HPP