1 /*
2 * Copyright (c) 1997, 2026, 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_OOPS_INSTANCEKLASS_HPP
26 #define SHARE_OOPS_INSTANCEKLASS_HPP
27
28 #include "code/vmreg.hpp"
29 #include "memory/allocation.hpp"
30 #include "memory/referenceType.hpp"
31 #include "oops/annotations.hpp"
32 #include "oops/arrayKlass.hpp"
33 #include "oops/constMethod.hpp"
34 #include "oops/fieldInfo.hpp"
35 #include "oops/instanceKlassFlags.hpp"
36 #include "oops/instanceOop.hpp"
37 #include "oops/refArrayKlass.hpp"
38 #include "runtime/handles.hpp"
39 #include "runtime/javaThread.hpp"
40 #include "utilities/accessFlags.hpp"
41 #include "utilities/align.hpp"
42 #include "utilities/growableArray.hpp"
43 #include "utilities/macros.hpp"
44 #if INCLUDE_JFR
45 #include "jfr/support/jfrKlassExtension.hpp"
46 #endif
47
48 class ConstantPool;
49 class DeoptimizationScope;
50 class klassItable;
51 class RecordComponent;
52
53 // An InstanceKlass is the VM level representation of a Java class.
54 // It contains all information needed for at class at execution runtime.
55
56 // InstanceKlass embedded field layout (after declared fields):
57 // [EMBEDDED Java vtable ] size in words = vtable_len
58 // [EMBEDDED Java itable ] size in words = itable_len
59 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
60 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
61 // indicating where oops are located in instances of this klass.
62 // [EMBEDDED implementor of the interface] only exists for interface
63 // [EMBEDDED InlineKlass::Members] only if is an InlineKlass instance
64
65
66 // forward declaration for class -- see below for definition
67 #if INCLUDE_JVMTI
68 class BreakpointInfo;
69 #endif
70 class ClassFileParser;
71 class ClassFileStream;
72 class KlassDepChange;
73 class DependencyContext;
74 class fieldDescriptor;
75 class JNIid;
76 class JvmtiCachedClassFieldMap;
77 class nmethodBucket;
78 class OopMapCache;
79 class InterpreterOopMap;
80 class PackageEntry;
81 class ModuleEntry;
82
83 // This is used in iterators below.
84 class FieldClosure: public StackObj {
85 public:
86 virtual void do_field(fieldDescriptor* fd) = 0;
87 };
88
89 // Print fields.
90 // If "obj" argument to constructor is null, prints fields as if they are static fields,
91 // otherwise prints non-static fields. It is possible to print non-static fields the same
92 // way as static fields when no oops are available, such as when debug printing classes.
93 class FieldPrinter: public FieldClosure {
94 oop _obj;
95 outputStream* _st;
96 int _indent;
97 int _base_offset;
98 public:
99 FieldPrinter(outputStream* st, oop obj = nullptr, int indent = 0, int base_offset = 0) :
100 _obj(obj), _st(st), _indent(indent), _base_offset(base_offset) {}
101 void do_field(fieldDescriptor* fd);
102 };
103
104 // Describes where oops are located in instances of this klass.
105 class OopMapBlock {
106 public:
107 // Byte offset of the first oop mapped by this block.
108 int offset() const { return _offset; }
109 void set_offset(int offset) { _offset = offset; }
110
111 // Number of oops in this block.
112 uint count() const { return _count; }
113 void set_count(uint count) { _count = count; }
114
115 void increment_count(int diff) { _count += diff; }
116
117 int offset_span() const { return _count * heapOopSize; }
118
119 int end_offset() const {
120 return offset() + offset_span();
121 }
122
123 bool is_contiguous(int another_offset) const {
124 return another_offset == end_offset();
125 }
126
127 // sizeof(OopMapBlock) in words.
128 static int size_in_words() {
129 return align_up((int)sizeof(OopMapBlock), wordSize) >>
130 LogBytesPerWord;
131 }
132
133 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
134 return a->offset() - b->offset();
135 }
136
137 private:
138 int _offset;
139 uint _count;
140 };
141
142 struct JvmtiCachedClassFileData;
143
144 class InlineLayoutInfo : public MetaspaceObj {
145 InlineKlass* _klass;
146 LayoutKind _kind;
147 int _null_marker_offset; // null marker offset for this field, relative to the beginning of the current container
148
149 public:
150 InlineLayoutInfo(): _klass(nullptr), _kind(LayoutKind::UNKNOWN), _null_marker_offset(-1) {}
151
152 InlineKlass* klass() const { return _klass; }
153 void set_klass(InlineKlass* k) { _klass = k; }
154
155 LayoutKind kind() const {
156 assert(_kind != LayoutKind::UNKNOWN, "Not set");
157 return _kind;
158 }
159 void set_kind(LayoutKind lk) { _kind = lk; }
160
161 int null_marker_offset() const {
162 assert(_null_marker_offset != -1, "Not set");
163 return _null_marker_offset;
164 }
165 void set_null_marker_offset(int o) { _null_marker_offset = o; }
166
167 void metaspace_pointers_do(MetaspaceClosure* it);
168 MetaspaceObj::Type type() const { return InlineLayoutInfoType; }
169
170 static ByteSize klass_offset() { return byte_offset_of(InlineLayoutInfo, _klass); }
171 static ByteSize null_marker_offset_offset() { return byte_offset_of(InlineLayoutInfo, _null_marker_offset); }
172
173 // Print
174 void print() const;
175 void print_on(outputStream* st) const;
176 };
177
178 class InstanceKlass: public Klass {
179 friend class VMStructs;
180 friend class ClassFileParser;
181 friend class CompileReplay;
182 friend class TemplateTable;
183
184 public:
185 static const KlassKind Kind = InstanceKlassKind;
186
187 protected:
188 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, markWord prototype = markWord::prototype(), ReferenceType reference_type = REF_NONE);
189
190 public:
191 InstanceKlass();
192
193 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
194 // of the class loading & initialization procedure, and the use of the states.
195 enum ClassState : u1 {
196 allocated, // allocated (but not yet linked)
197 loaded, // loaded and inserted in class hierarchy (but not linked yet)
198 linked, // successfully linked/verified (but not initialized yet)
199 being_initialized, // currently running class initializer
200 fully_initialized, // initialized (successful final state)
201 initialization_error // error happened during initialization
202 };
203
204 private:
205 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
206
207 protected:
208 // If you add a new field that points to any metaspace object, you
209 // must add this field to InstanceKlass::metaspace_pointers_do().
210
211 // Annotations for this class
212 Annotations* _annotations;
213 // Package this class is defined in
214 PackageEntry* _package_entry;
215 // Array classes holding elements of this class.
216 ObjArrayKlass* volatile _array_klasses;
217 // Constant pool for this class.
218 ConstantPool* _constants;
219 // The InnerClasses attribute and EnclosingMethod attribute. The
220 // _inner_classes is an array of shorts. If the class has InnerClasses
221 // attribute, then the _inner_classes array begins with 4-tuples of shorts
222 // [inner_class_info_index, outer_class_info_index,
223 // inner_name_index, inner_class_access_flags] for the InnerClasses
224 // attribute. If the EnclosingMethod attribute exists, it occupies the
225 // last two shorts [class_index, method_index] of the array. If only
226 // the InnerClasses attribute exists, the _inner_classes array length is
227 // number_of_inner_classes * 4. If the class has both InnerClasses
228 // and EnclosingMethod attributes the _inner_classes array length is
229 // number_of_inner_classes * 4 + enclosing_method_attribute_size.
230 Array<jushort>* _inner_classes;
231
232 // The NestMembers attribute. An array of shorts, where each is a
233 // class info index for the class that is a nest member. This data
234 // has not been validated.
235 Array<jushort>* _nest_members;
236
237 // Resolved nest-host klass: either true nest-host or self if we are not
238 // nested, or an error occurred resolving or validating the nominated
239 // nest-host. Can also be set directly by JDK API's that establish nest
240 // relationships.
241 // By always being set it makes nest-member access checks simpler.
242 InstanceKlass* _nest_host;
243
244 // The PermittedSubclasses attribute. An array of shorts, where each is a
245 // class info index for the class that is a permitted subclass.
246 Array<jushort>* _permitted_subclasses;
247
248 // The contents of the Record attribute.
249 Array<RecordComponent*>* _record_components;
250
251 // the source debug extension for this klass, null if not specified.
252 // Specified as UTF-8 string without terminating zero byte in the classfile,
253 // it is stored in the instanceklass as a null-terminated UTF-8 string
254 const char* _source_debug_extension;
255
256 // Number of heapOopSize words used by non-static fields in this klass
257 // (including inherited fields but after header_size()).
258 int _nonstatic_field_size;
259 int _static_field_size; // number words used by static fields (oop and non-oop) in this klass
260 int _nonstatic_oop_map_size; // size in words of nonstatic oop map blocks
261 int _itable_len; // length of Java itable (in words)
262
263 // The NestHost attribute. The class info index for the class
264 // that is the nest-host of this class. This data has not been validated.
265 u2 _nest_host_index;
266 u2 _this_class_index; // constant pool entry
267 u2 _static_oop_field_count; // number of static oop fields in this klass
268
269 volatile u2 _idnum_allocated_count; // JNI/JVMTI: increments with the addition of methods, old ids don't change
270
271 // Class states are defined as ClassState (see above).
272 // Place the _init_state here to utilize the unused 2-byte after
273 // _idnum_allocated_count.
274 volatile ClassState _init_state; // state of class
275
276 u1 _reference_type; // reference type
277 int _acmp_maps_offset; // offset to injected static field storing .acmp_maps for value classes
278 // unfortunately, abstract values need one too so it cannot be stored in
279 // the InlineKlass::Members that only exist for InlineKlass.
280
281 AccessFlags _access_flags; // Access flags. The class/interface distinction is stored here.
282
283 // State is set either at parse time or while executing, atomically to not disturb other state
284 InstanceKlassFlags _misc_flags;
285
286 JavaThread* volatile _init_thread; // Pointer to current thread doing initialization (to handle recursive initialization)
287
288 OopMapCache* volatile _oop_map_cache; // OopMapCache for all methods in the klass (allocated lazily)
289 JNIid* _jni_ids; // First JNI identifier for static fields in this class
290 jmethodID* volatile _methods_jmethod_ids; // jmethodIDs corresponding to method_idnum, or null if none
291 nmethodBucket* volatile _dep_context; // packed DependencyContext structure
292 uint64_t volatile _dep_context_last_cleaned;
293 nmethod* _osr_nmethods_head; // Head of list of on-stack replacement nmethods for this class
294 #if INCLUDE_JVMTI
295 BreakpointInfo* _breakpoints; // bpt lists, managed by Method*
296 // Linked instanceKlasses of previous versions
297 InstanceKlass* _previous_versions;
298 // JVMTI fields can be moved to their own structure - see 6315920
299 // JVMTI: cached class file, before retransformable agent modified it in CFLH
300 JvmtiCachedClassFileData* _cached_class_file;
301 #endif
302
303 #if INCLUDE_JVMTI
304 JvmtiCachedClassFieldMap* _jvmti_cached_class_field_map; // JVMTI: used during heap iteration
305 #endif
306
307 NOT_PRODUCT(int _verify_count;) // to avoid redundant verifies
308 NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once
309
310 // Method array.
311 Array<Method*>* _methods;
312 // Default Method Array, concrete methods inherited from interfaces
313 Array<Method*>* _default_methods;
314 // Interfaces (InstanceKlass*s) this class declares locally to implement.
315 Array<InstanceKlass*>* _local_interfaces;
316 // Interfaces (InstanceKlass*s) this class implements transitively.
317 Array<InstanceKlass*>* _transitive_interfaces;
318 // Int array containing the original order of method in the class file (for JVMTI).
319 Array<int>* _method_ordering;
320 // Int array containing the vtable_indices for default_methods
321 // offset matches _default_methods offset
322 Array<int>* _default_vtable_indices;
323
324 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
325 Array<u1>* _fieldinfo_stream;
326 Array<u1>* _fieldinfo_search_table;
327 Array<FieldStatus>* _fields_status;
328
329 Array<InlineLayoutInfo>* _inline_layout_info_array;
330 Array<u2>* _loadable_descriptors;
331 Array<int>* _acmp_maps_array; // Metadata copy of the acmp_maps oop used in value classes.
332 // When loading an inline klass from the CDS/AOT archive
333 // this copy can be used to regenerate the ".acmp_maps" oop
334 // if it is not stored in the archive.
335
336 // Located here because sub-klasses can't have their own C++ fields
337 address _adr_inline_klass_members;
338
339 friend class SystemDictionary;
340
341 static bool _disable_method_binary_search;
342
343 // Controls finalizer registration
344 static bool _finalization_enabled;
345
346 public:
347
348 // Queries finalization state
349 static bool is_finalization_enabled() { return _finalization_enabled; }
350
351 // Sets finalization state
352 static void set_finalization_enabled(bool val) { _finalization_enabled = val; }
353
354 // Access flags
355 AccessFlags access_flags() const { return _access_flags; }
356 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
357
358 bool is_public() const { return _access_flags.is_public(); }
359 bool is_final() const { return _access_flags.is_final(); }
360 bool is_interface() const override { return _access_flags.is_interface(); }
361 bool is_abstract() const override { return _access_flags.is_abstract(); }
362 bool is_synthetic() const { return _access_flags.is_synthetic(); }
363 void set_is_synthetic() { _access_flags.set_is_synthetic(); }
364 bool is_identity_class() const override { return _access_flags.is_identity_class(); }
365
366 static ByteSize access_flags_offset() { return byte_offset_of(InstanceKlass, _access_flags); }
367
368 void set_is_cloneable();
369
370 // Quick checks for the loader that defined this class (without switching on this->class_loader())
371 bool defined_by_boot_loader() const { return _misc_flags.defined_by_boot_loader(); }
372 bool defined_by_platform_loader() const { return _misc_flags.defined_by_platform_loader(); }
373 bool defined_by_app_loader() const { return _misc_flags.defined_by_app_loader(); }
374 bool defined_by_other_loaders() const { return _misc_flags.defined_by_other_loaders(); }
375 void set_class_loader_type() { _misc_flags.set_class_loader_type(_class_loader_data); }
376
377 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
378
379 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
380
381 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
382 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
383
384 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
385 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
386
387 bool has_inlined_fields() const { return _misc_flags.has_inlined_fields(); }
388 void set_has_inlined_fields() { _misc_flags.set_has_inlined_fields(true); }
389
390 bool has_null_restricted_static_fields() const { return _misc_flags.has_null_restricted_static_fields(); }
391 void set_has_null_restricted_static_fields() { _misc_flags.set_has_null_restricted_static_fields(true); }
392
393 bool is_naturally_atomic(bool null_free) const;
394 void set_is_naturally_atomic() { _misc_flags.set_is_naturally_atomic(true); }
395
396 // Query if this class has atomicity requirements (default is yes)
397 // This bit can occur anywhere, but is only significant
398 // for inline classes *and* their super types.
399 // It inherits from supers.
400 // Its value depends on the ForceNonTearable VM option, the LooselyConsistentValue annotation
401 // and the presence of flat fields with atomicity requirements
402 bool must_be_atomic() const { return _misc_flags.must_be_atomic(); }
403 void set_must_be_atomic() { _misc_flags.set_must_be_atomic(true); }
404
405 bool fail_over_verified() const { return _misc_flags.fail_over_verified(); }
406 void set_fail_over_verified() { _misc_flags.set_fail_over_verified(true); }
407
408 // field sizes
409 int nonstatic_field_size() const { return _nonstatic_field_size; }
410 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
411
412 int static_field_size() const { return _static_field_size; }
413 void set_static_field_size(int size) { _static_field_size = size; }
414
415 int static_oop_field_count() const { return (int)_static_oop_field_count; }
416 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
417
418 bool trust_final_fields() { return _misc_flags.trust_final_fields(); }
419 void set_trust_final_fields(bool value) { _misc_flags.set_trust_final_fields(value); }
420
421 // Java itable
422 int itable_length() const { return _itable_len; }
423 void set_itable_length(int len) { _itable_len = len; }
424
425 // array klasses
426 ObjArrayKlass* array_klasses() const { return _array_klasses; }
427 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
428 inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
429 void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }
430
431 // methods
432 Array<Method*>* methods() const { return _methods; }
433 void set_methods(Array<Method*>* a) { _methods = a; }
434 Method* method_with_idnum(int idnum) const;
435 Method* method_with_orig_idnum(int idnum) const;
436 Method* method_with_orig_idnum(int idnum, int version) const;
437
438 // method ordering
439 Array<int>* method_ordering() const { return _method_ordering; }
440 void set_method_ordering(Array<int>* m) { _method_ordering = m; }
441 void copy_method_ordering(const intArray* m, TRAPS);
442
443 // default_methods
444 Array<Method*>* default_methods() const { return _default_methods; }
445 void set_default_methods(Array<Method*>* a) { _default_methods = a; }
446
447 // default method vtable_indices
448 Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
449 void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
450 Array<int>* create_new_default_vtable_indices(int len, TRAPS);
451
452 // interfaces
453 Array<InstanceKlass*>* local_interfaces() const { return _local_interfaces; }
454 void set_local_interfaces(Array<InstanceKlass*>* a) {
455 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
456 _local_interfaces = a; }
457
458 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
459 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
460 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
461 _transitive_interfaces = a;
462 }
463
464 private:
465 friend class fieldDescriptor;
466 FieldInfo field(int index) const;
467
468 public:
469 int field_offset (int index) const { return field(index).offset(); }
470 int field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
471 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
472 FieldStatus field_status(int index) const { return fields_status()->at(index); }
473 inline Symbol* field_name (int index) const;
474 inline Symbol* field_signature (int index) const;
475 bool field_is_flat(int index) const { return field_flags(index).is_flat(); }
476 bool field_has_null_marker(int index) const { return field_flags(index).has_null_marker(); }
477 bool field_is_null_free_inline_type(int index) const;
478 bool is_class_in_loadable_descriptors_attribute(Symbol* name) const;
479
480 int field_null_marker_offset(int index) const { return inline_layout_info(index).null_marker_offset(); }
481
482 // Number of Java declared fields
483 int java_fields_count() const;
484 int total_fields_count() const;
485
486 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
487 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
488
489 Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
490 void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }
491
492 Array<FieldStatus>* fields_status() const {return _fields_status; }
493 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
494
495 Array<u2>* loadable_descriptors() const { return _loadable_descriptors; }
496 void set_loadable_descriptors(Array<u2>* c) { _loadable_descriptors = c; }
497
498 Array<int>* acmp_maps_array() const { return _acmp_maps_array; }
499 void set_acmp_maps_array(Array<int>* array) { _acmp_maps_array = array; }
500
501 // inner classes
502 Array<u2>* inner_classes() const { return _inner_classes; }
503 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
504
505 // nest members
506 Array<u2>* nest_members() const { return _nest_members; }
507 void set_nest_members(Array<u2>* m) { _nest_members = m; }
508
509 // nest-host index
510 jushort nest_host_index() const { return _nest_host_index; }
511 void set_nest_host_index(u2 i) { _nest_host_index = i; }
512 // dynamic nest member support
513 void set_nest_host(InstanceKlass* host);
514
515 // record components
516 Array<RecordComponent*>* record_components() const { return _record_components; }
517 void set_record_components(Array<RecordComponent*>* record_components) {
518 _record_components = record_components;
519 }
520 bool is_record() const;
521
522 // test for enum class (or possibly an anonymous subclass within a sealed enum)
523 bool is_enum_subclass() const;
524
525 // permitted subclasses
526 Array<u2>* permitted_subclasses() const { return _permitted_subclasses; }
527 void set_permitted_subclasses(Array<u2>* s) { _permitted_subclasses = s; }
528
529 private:
530 // Called to verify that k is a member of this nest - does not look at k's nest-host,
531 // nor does it resolve any CP entries or load any classes.
532 bool has_nest_member(JavaThread* current, InstanceKlass* k) const;
533
534 public:
535 // Call this only if you know that the nest host has been initialized.
536 InstanceKlass* nest_host_not_null() {
537 assert(_nest_host != nullptr, "must be");
538 return _nest_host;
539 }
540 InstanceKlass* nest_host_or_null() {
541 return _nest_host;
542 }
543 // Used to construct informative IllegalAccessError messages at a higher level,
544 // if there was an issue resolving or validating the nest host.
545 // Returns null if there was no error.
546 const char* nest_host_error();
547 // Returns nest-host class, resolving and validating it if needed.
548 // Returns null if resolution is not possible from the calling context.
549 InstanceKlass* nest_host(TRAPS);
550 // Check if this klass is a nestmate of k - resolves this nest-host and k's
551 bool has_nestmate_access_to(InstanceKlass* k, TRAPS);
552
553 // Called to verify that k is a permitted subclass of this class.
554 // The incoming stringStream is used for logging, and for the caller to create
555 // a detailed exception message on failure.
556 bool has_as_permitted_subclass(const InstanceKlass* k, stringStream& ss) const;
557
558 enum InnerClassAttributeOffset {
559 // From http://mirror.eng/products/jdk/1.1/docs/guide/innerclasses/spec/innerclasses.doc10.html#18814
560 inner_class_inner_class_info_offset = 0,
561 inner_class_outer_class_info_offset = 1,
562 inner_class_inner_name_offset = 2,
563 inner_class_access_flags_offset = 3,
564 inner_class_next_offset = 4
565 };
566
567 enum EnclosingMethodAttributeOffset {
568 enclosing_method_class_index_offset = 0,
569 enclosing_method_method_index_offset = 1,
570 enclosing_method_attribute_size = 2
571 };
572
573 // package
574 PackageEntry* package() const override { return _package_entry; }
575 ModuleEntry* module() const override;
576 bool in_javabase_module() const;
577 bool in_unnamed_package() const { return (_package_entry == nullptr); }
578 void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
579 // If the package for the InstanceKlass is in the boot loader's package entry
580 // table then sets the classpath_index field so that
581 // get_system_package() will know to return a non-null value for the
582 // package's location. And, so that the package will be added to the list of
583 // packages returned by get_system_packages().
584 // For packages whose classes are loaded from the boot loader class path, the
585 // classpath_index indicates which entry on the boot loader class path.
586 void set_classpath_index(s2 path_index);
587 bool is_same_class_package(const Klass* class2) const;
588 bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
589
590 // find an enclosing class
591 InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
592
593 // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
594 bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
595
596 // Check if this klass can be null-free
597 static void check_can_be_annotated_with_NullRestricted(InstanceKlass* type, Symbol* container_klass_name, TRAPS);
598
599 private:
600 // Check prohibited package ("java/" only loadable by boot or platform loaders)
601 static void check_prohibited_package(Symbol* class_name,
602 ClassLoaderData* loader_data,
603 TRAPS);
604
605 JavaThread* init_thread() { return AtomicAccess::load(&_init_thread); }
606 const char* init_thread_name() {
607 return init_thread()->name_raw();
608 }
609
610 public:
611 // initialization state
612 bool is_loaded() const { return init_state() >= loaded; }
613 bool is_linked() const { return init_state() >= linked; }
614 bool is_initialized() const { return init_state() == fully_initialized; }
615 bool is_not_initialized() const { return init_state() < being_initialized; }
616 bool is_being_initialized() const { return init_state() == being_initialized; }
617 bool is_in_error_state() const { return init_state() == initialization_error; }
618 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
619 ClassState init_state() const { return AtomicAccess::load_acquire(&_init_state); }
620 const char* init_state_name() const;
621 bool is_rewritten() const { return _misc_flags.rewritten(); }
622
623 // is this a sealed class
624 bool is_sealed() const;
625
626 // defineClass specified verification
627 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
628 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
629
630 // marking
631 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
632 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
633
634 static ByteSize kind_offset() { return byte_offset_of(InstanceKlass, _kind); }
635 static ByteSize misc_flags_offset() { return byte_offset_of(InstanceKlass, _misc_flags); }
636
637 // initialization (virtuals from Klass)
638 bool should_be_initialized() const override; // means that initialize should be called
639 void initialize_with_aot_initialized_mirror(bool early_init, TRAPS);
640 void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
641 void initialize(TRAPS) override;
642 void initialize_preemptable(TRAPS) override;
643 void link_class(TRAPS);
644 bool link_class_or_fail(TRAPS); // returns false on failure
645 void rewrite_class(TRAPS);
646 void link_methods(TRAPS);
647 Method* class_initializer() const;
648 bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;
649
650 // reference type
651 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
652
653 bool has_acmp_maps_offset() const {
654 return _acmp_maps_offset != 0;
655 }
656
657 int acmp_maps_offset() const {
658 assert(_acmp_maps_offset != 0, "Not initialized");
659 return _acmp_maps_offset;
660 }
661 void set_acmp_maps_offset(int offset) { _acmp_maps_offset = offset; }
662 static ByteSize acmp_maps_offset_offset() { return byte_offset_of(InstanceKlass, _acmp_maps_offset); }
663
664 // this class cp index
665 u2 this_class_index() const { return _this_class_index; }
666 void set_this_class_index(u2 index) { _this_class_index = index; }
667
668 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
669
670 // find local field, returns true if found
671 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
672 // find field in direct superinterfaces, returns the interface in which the field is defined
673 Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
674 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
675 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
676 // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
677 Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;
678
679 // find a non-static or static field given its offset within the class.
680 bool contains_field_offset(int offset);
681
682 bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
683 bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
684
685 bool find_local_flat_field_containing_offset(int offset, fieldDescriptor* fd) const;
686 bool find_flat_field_containing_offset(int offset, fieldDescriptor* fd) const;
687
688 private:
689 inline static int quick_search(const Array<Method*>* methods, const Symbol* name);
690
691 public:
692 static void disable_method_binary_search() {
693 _disable_method_binary_search = true;
694 }
695
696 // find a local method (returns null if not found)
697 Method* find_method(const Symbol* name, const Symbol* signature) const;
698 static Method* find_method(const Array<Method*>* methods,
699 const Symbol* name,
700 const Symbol* signature);
701
702 // find a local method, but skip static methods
703 Method* find_instance_method(const Symbol* name, const Symbol* signature,
704 PrivateLookupMode private_mode) const;
705 static Method* find_instance_method(const Array<Method*>* methods,
706 const Symbol* name,
707 const Symbol* signature,
708 PrivateLookupMode private_mode);
709
710 // find a local method (returns null if not found)
711 Method* find_local_method(const Symbol* name,
712 const Symbol* signature,
713 OverpassLookupMode overpass_mode,
714 StaticLookupMode static_mode,
715 PrivateLookupMode private_mode) const;
716
717 // find a local method from given methods array (returns null if not found)
718 static Method* find_local_method(const Array<Method*>* methods,
719 const Symbol* name,
720 const Symbol* signature,
721 OverpassLookupMode overpass_mode,
722 StaticLookupMode static_mode,
723 PrivateLookupMode private_mode);
724
725 // find a local method index in methods or default_methods (returns -1 if not found)
726 static int find_method_index(const Array<Method*>* methods,
727 const Symbol* name,
728 const Symbol* signature,
729 OverpassLookupMode overpass_mode,
730 StaticLookupMode static_mode,
731 PrivateLookupMode private_mode);
732
733 // lookup operation (returns null if not found)
734 Method* uncached_lookup_method(const Symbol* name,
735 const Symbol* signature,
736 OverpassLookupMode overpass_mode,
737 PrivateLookupMode private_mode = PrivateLookupMode::find) const override;
738
739 // lookup a method in all the interfaces that this class implements
740 // (returns null if not found)
741 Method* lookup_method_in_all_interfaces(Symbol* name, Symbol* signature, DefaultsLookupMode defaults_mode) const;
742
743 // lookup a method in local defaults then in all interfaces
744 // (returns null if not found)
745 Method* lookup_method_in_ordered_interfaces(Symbol* name, Symbol* signature) const;
746
747 // Find method indices by name. If a method with the specified name is
748 // found the index to the first method is returned, and 'end' is filled in
749 // with the index of first non-name-matching method. If no method is found
750 // -1 is returned.
751 int find_method_by_name(const Symbol* name, int* end) const;
752 static int find_method_by_name(const Array<Method*>* methods,
753 const Symbol* name, int* end);
754
755 // constant pool
756 ConstantPool* constants() const { return _constants; }
757 void set_constants(ConstantPool* c) { _constants = c; }
758
759 // protection domain
760 oop protection_domain() const override;
761
762 // signers
763 objArrayOop signers() const;
764
765 bool is_contended() const { return _misc_flags.is_contended(); }
766 void set_is_contended(bool value) { _misc_flags.set_is_contended(value); }
767
768 // source file name
769 Symbol* source_file_name() const;
770 u2 source_file_name_index() const;
771 void set_source_file_name_index(u2 sourcefile_index);
772
773 // minor and major version numbers of class file
774 u2 minor_version() const;
775 void set_minor_version(u2 minor_version);
776 u2 major_version() const;
777 void set_major_version(u2 major_version);
778
779 bool supports_inline_types() const;
780
781 // source debug extension
782 const char* source_debug_extension() const { return _source_debug_extension; }
783 void set_source_debug_extension(const char* array, int length);
784
785 // nonstatic oop-map blocks
786 static int nonstatic_oop_map_size(unsigned int oop_map_count) {
787 return oop_map_count * OopMapBlock::size_in_words();
788 }
789 unsigned int nonstatic_oop_map_count() const {
790 return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
791 }
792 int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
793 void set_nonstatic_oop_map_size(int words) {
794 _nonstatic_oop_map_size = words;
795 }
796
797 bool has_contended_annotations() const { return _misc_flags.has_contended_annotations(); }
798 void set_has_contended_annotations(bool value) { _misc_flags.set_has_contended_annotations(value); }
799
800 #if INCLUDE_JVMTI
801 // Redefinition locking. Class can only be redefined by one thread at a time.
802 bool is_being_redefined() const { return _misc_flags.is_being_redefined(); }
803 void set_is_being_redefined(bool value) { _misc_flags.set_is_being_redefined(value); }
804
805 // RedefineClasses() support for previous versions:
806 void add_previous_version(InstanceKlass* ik, int emcp_method_count);
807 void purge_previous_version_list();
808
809 InstanceKlass* previous_versions() const { return _previous_versions; }
810 #else
811 InstanceKlass* previous_versions() const { return nullptr; }
812 #endif
813
814 const InstanceKlass* get_klass_version(int version) const;
815
816 bool has_been_redefined() const { return _misc_flags.has_been_redefined(); }
817 void set_has_been_redefined() { _misc_flags.set_has_been_redefined(true); }
818
819 bool is_scratch_class() const { return _misc_flags.is_scratch_class(); }
820 void set_is_scratch_class() { _misc_flags.set_is_scratch_class(true); }
821
822 bool has_resolved_methods() const { return _misc_flags.has_resolved_methods(); }
823 void set_has_resolved_methods() { _misc_flags.set_has_resolved_methods(true); }
824 void set_has_resolved_methods(bool value) { _misc_flags.set_has_resolved_methods(value); }
825
826 public:
827 #if INCLUDE_JVMTI
828
829 void init_previous_versions() {
830 _previous_versions = nullptr;
831 }
832
833 private:
834 static bool _should_clean_previous_versions;
835 public:
836 static void purge_previous_versions(InstanceKlass* ik) {
837 if (ik->has_been_redefined()) {
838 ik->purge_previous_version_list();
839 }
840 }
841
842 static bool should_clean_previous_versions_and_reset();
843 static bool should_clean_previous_versions() { return _should_clean_previous_versions; }
844
845 // JVMTI: Support for caching a class file before it is modified by an agent that can do retransformation
846 void set_cached_class_file(JvmtiCachedClassFileData *data) {
847 _cached_class_file = data;
848 }
849 JvmtiCachedClassFileData * get_cached_class_file();
850 jint get_cached_class_file_len();
851 unsigned char * get_cached_class_file_bytes();
852
853 // JVMTI: Support for caching of field indices, types, and offsets
854 void set_jvmti_cached_class_field_map(JvmtiCachedClassFieldMap* descriptor) {
855 _jvmti_cached_class_field_map = descriptor;
856 }
857 JvmtiCachedClassFieldMap* jvmti_cached_class_field_map() const {
858 return _jvmti_cached_class_field_map;
859 }
860 #else // INCLUDE_JVMTI
861
862 static void purge_previous_versions(InstanceKlass* ik) { return; };
863 static bool should_clean_previous_versions_and_reset() { return false; }
864
865 void set_cached_class_file(JvmtiCachedClassFileData *data) {
866 assert(data == nullptr, "unexpected call with JVMTI disabled");
867 }
868 JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)nullptr; }
869
870 #endif // INCLUDE_JVMTI
871
872 bool has_nonstatic_concrete_methods() const { return _misc_flags.has_nonstatic_concrete_methods(); }
873 void set_has_nonstatic_concrete_methods(bool b) { _misc_flags.set_has_nonstatic_concrete_methods(b); }
874
875 bool declares_nonstatic_concrete_methods() const { return _misc_flags.declares_nonstatic_concrete_methods(); }
876 void set_declares_nonstatic_concrete_methods(bool b) { _misc_flags.set_declares_nonstatic_concrete_methods(b); }
877
878 bool has_miranda_methods () const { return _misc_flags.has_miranda_methods(); }
879 void set_has_miranda_methods() { _misc_flags.set_has_miranda_methods(true); }
880 bool has_final_method() const { return _misc_flags.has_final_method(); }
881 void set_has_final_method() { _misc_flags.set_has_final_method(true); }
882
883 // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
884 inline u2 next_method_idnum();
885 void set_initial_method_idnum(u2 value) { _idnum_allocated_count = value; }
886
887 // runtime support for strict statics
888 bool has_strict_static_fields() const { return _misc_flags.has_strict_static_fields(); }
889 void set_has_strict_static_fields(bool b) { _misc_flags.set_has_strict_static_fields(b); }
890 void notify_strict_static_access(int field_index, bool is_writing, TRAPS);
891 const char* format_strict_static_message(Symbol* field_name, const char* doing_what = nullptr);
892 void throw_strict_static_exception(Symbol* field_name, const char* when, TRAPS);
893
894 // generics support
895 Symbol* generic_signature() const;
896 u2 generic_signature_index() const;
897 void set_generic_signature_index(u2 sig_index);
898
899 u2 enclosing_method_data(int offset) const;
900 u2 enclosing_method_class_index() const {
901 return enclosing_method_data(enclosing_method_class_index_offset);
902 }
903 u2 enclosing_method_method_index() {
904 return enclosing_method_data(enclosing_method_method_index_offset);
905 }
906 void set_enclosing_method_indices(u2 class_index,
907 u2 method_index);
908
909 // jmethodID support
910 jmethodID get_jmethod_id(Method* method);
911 void make_methods_jmethod_ids();
912 jmethodID jmethod_id_or_null(Method* method);
913 void update_methods_jmethod_cache();
914
915 // annotations support
916 Annotations* annotations() const { return _annotations; }
917 void set_annotations(Annotations* anno) { _annotations = anno; }
918
919 AnnotationArray* class_annotations() const {
920 return (_annotations != nullptr) ? _annotations->class_annotations() : nullptr;
921 }
922 Array<AnnotationArray*>* fields_annotations() const {
923 return (_annotations != nullptr) ? _annotations->fields_annotations() : nullptr;
924 }
925 AnnotationArray* class_type_annotations() const {
926 return (_annotations != nullptr) ? _annotations->class_type_annotations() : nullptr;
927 }
928 Array<AnnotationArray*>* fields_type_annotations() const {
929 return (_annotations != nullptr) ? _annotations->fields_type_annotations() : nullptr;
930 }
931 // allocation
932 instanceOop allocate_instance(TRAPS);
933 static instanceOop allocate_instance(oop cls, TRAPS);
934
935 // additional member function to return a handle
936 instanceHandle allocate_instance_handle(TRAPS);
937
938 // Helper function
939 static instanceOop register_finalizer(instanceOop i, TRAPS);
940
941 // Check whether reflection/jni/jvm code is allowed to instantiate this class;
942 // if not, throw either an Error or an Exception.
943 void check_valid_for_instantiation(bool throwError, TRAPS) override;
944
945 // initialization
946 void call_class_initializer(TRAPS);
947 void set_initialization_state_and_notify(ClassState state, TRAPS);
948
949 // OopMapCache support
950 OopMapCache* oop_map_cache() { return _oop_map_cache; }
951 void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
952 void mask_for(const methodHandle& method, int bci, InterpreterOopMap* entry);
953
954 // JNI identifier support (for static fields - for jni performance)
955 JNIid* jni_ids() { return _jni_ids; }
956 void set_jni_ids(JNIid* ids) { _jni_ids = ids; }
957 JNIid* jni_id_for(int offset);
958
959 public:
960 // maintenance of deoptimization dependencies
961 inline DependencyContext dependencies();
962 void mark_dependent_nmethods(DeoptimizationScope* deopt_scope, KlassDepChange& changes);
963 void add_dependent_nmethod(nmethod* nm);
964 void clean_dependency_context();
965 // Setup link to hierarchy and deoptimize
966 void add_to_hierarchy(JavaThread* current);
967
968 // On-stack replacement support
969 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
970 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
971 void add_osr_nmethod(nmethod* n);
972 bool remove_osr_nmethod(nmethod* n);
973 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
974 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
975
976 #if INCLUDE_JVMTI
977 // Breakpoint support (see methods on Method* for details)
978 BreakpointInfo* breakpoints() const { return _breakpoints; };
979 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
980 #endif
981
982 // support for stub routines
983 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
984 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
985 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
986
987 static ByteSize inline_layout_info_array_offset() { return byte_offset_of(InstanceKlass, _inline_layout_info_array); }
988 static ByteSize adr_inline_klass_members_offset() { return byte_offset_of(InstanceKlass, _adr_inline_klass_members); }
989
990 // subclass/subinterface checks
991 bool implements_interface(Klass* k) const;
992 bool is_same_or_direct_interface(Klass* k) const;
993
994 #ifdef ASSERT
995 // check whether this class or one of its superclasses was redefined
996 bool has_redefined_this_or_super() const;
997 #endif
998
999 // Access to the implementor of an interface.
1000 // The embedded implementor only exists if the current klass is an
1001 // interface. The possible values of the implementor fall into following
1002 // three cases:
1003 // null: no implementor.
1004 // A Klass* that's not itself: one implementor.
1005 // Itself: more than one implementors.
1006 //
1007 InstanceKlass* implementor() const;
1008 void set_implementor(InstanceKlass* ik);
1009 int nof_implementors() const;
1010 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
1011 void init_implementor(); // initialize
1012
1013 private:
1014 // link this class into the implementors list of every interface it implements
1015 void process_interfaces();
1016
1017 public:
1018 // virtual operations from Klass
1019 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
1020 Array<InstanceKlass*>* transitive_interfaces) override;
1021 bool can_be_primary_super_slow() const override;
1022 size_t oop_size(oop obj) const override { return size_helper(); }
1023 // slow because it's a virtual call and used for verifying the layout_helper.
1024 // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
1025 DEBUG_ONLY(bool is_instance_klass_slow() const override { return true; })
1026
1027 // Iterators
1028 void do_local_static_fields(FieldClosure* cl);
1029 void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
1030 void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
1031 void print_nonstatic_fields(FieldClosure* cl); // including inherited and injected fields
1032
1033 void methods_do(void f(Method* method));
1034
1035 static InstanceKlass* cast(Klass* k) {
1036 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
1037 }
1038
1039 static const InstanceKlass* cast(const Klass* k) {
1040 assert(k != nullptr, "k should not be null");
1041 assert(k->is_instance_klass(), "cast to InstanceKlass");
1042 return static_cast<const InstanceKlass*>(k);
1043 }
1044
1045 // This hides Klass::super(). The _super of an InstanceKlass is
1046 // always an InstanceKlass (or nullptr)
1047 InstanceKlass* super() const {
1048 return (Klass::super() == nullptr) ? nullptr : InstanceKlass::cast(Klass::super());
1049 }
1050
1051 InstanceKlass* java_super() const override {
1052 return InstanceKlass::super();
1053 }
1054
1055 // Sizing (in words)
1056 static int header_size() { return sizeof(InstanceKlass) / wordSize; }
1057
1058 static int size(int vtable_length,
1059 int itable_length,
1060 int nonstatic_oop_map_size,
1061 bool is_interface,
1062 bool is_inline_type);
1063
1064 int size() const override;
1065
1066
1067 inline intptr_t* start_of_itable() const;
1068 inline intptr_t* end_of_itable() const;
1069 inline oop static_field_base_raw();
1070
1071 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
1072 inline Klass** end_of_nonstatic_oop_maps() const;
1073
1074 inline InstanceKlass* volatile* adr_implementor() const;
1075
1076 // The end of the memory block that belongs to this InstanceKlass.
1077 // Sub-klasses can place their fields after this address.
1078 inline address end_of_instance_klass() const;
1079
1080 void set_inline_layout_info_array(Array<InlineLayoutInfo>* array) { _inline_layout_info_array = array; }
1081 Array<InlineLayoutInfo>* inline_layout_info_array() const { return _inline_layout_info_array; }
1082
1083 InlineLayoutInfo inline_layout_info(int index) const {
1084 assert(_inline_layout_info_array != nullptr, "Array not created");
1085 return _inline_layout_info_array->at(index);
1086 }
1087
1088 InlineLayoutInfo* inline_layout_info_adr(int index) {
1089 assert(_inline_layout_info_array != nullptr, "Array not created");
1090 return _inline_layout_info_array->adr_at(index);
1091 }
1092
1093 inline InlineKlass* get_inline_type_field_klass(int idx) const ;
1094 inline InlineKlass* get_inline_type_field_klass_or_null(int idx) const;
1095
1096 // Use this to return the size of an instance in heap words:
1097 int size_helper() const {
1098 return layout_helper_to_size_helper(layout_helper());
1099 }
1100
1101 // This bit is initialized in classFileParser.cpp.
1102 // It is false under any of the following conditions:
1103 // - the class is abstract (including any interface)
1104 // - the class size is larger than FastAllocateSizeLimit
1105 // - the class is java/lang/Class, which cannot be allocated directly
1106 bool can_be_fastpath_allocated() const {
1107 return !layout_helper_needs_slow_path(layout_helper());
1108 }
1109
1110 // Java itable
1111 klassItable itable() const; // return klassItable wrapper
1112 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
1113 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
1114 int vtable_index_of_interface_method(Method* method);
1115
1116 #if INCLUDE_JVMTI
1117 void adjust_default_methods(bool* trace_name_printed);
1118 #endif // INCLUDE_JVMTI
1119
1120 void clean_weak_instanceklass_links();
1121 private:
1122 void clean_implementors_list();
1123 void clean_method_data();
1124
1125 public:
1126 // Explicit metaspace deallocation of fields
1127 // For RedefineClasses and class file parsing errors, we need to deallocate
1128 // instanceKlasses and the metadata they point to.
1129 void deallocate_contents(ClassLoaderData* loader_data);
1130 static void deallocate_methods(ClassLoaderData* loader_data,
1131 Array<Method*>* methods);
1132 void static deallocate_interfaces(ClassLoaderData* loader_data,
1133 const InstanceKlass* super_klass,
1134 Array<InstanceKlass*>* local_interfaces,
1135 Array<InstanceKlass*>* transitive_interfaces);
1136 void static deallocate_record_components(ClassLoaderData* loader_data,
1137 Array<RecordComponent*>* record_component);
1138
1139 bool on_stack() const override;
1140
1141 // callbacks for actions during class unloading
1142 static void unload_class(InstanceKlass* ik);
1143
1144 void release_C_heap_structures(bool release_sub_metadata = true) override;
1145
1146 // Naming
1147 const char* signature_name() const override;
1148
1149 // Oop fields (and metadata) iterators
1150 //
1151 // The InstanceKlass iterators also visits the Object's klass.
1152
1153 // Forward iteration
1154 public:
1155 // Iterate over all oop fields in the oop maps.
1156 template <typename T, class OopClosureType>
1157 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1158
1159 // Iterate over all oop fields and metadata.
1160 template <typename T, class OopClosureType>
1161 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1162
1163 // Iterate over all oop fields in one oop map.
1164 template <typename T, class OopClosureType>
1165 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1166
1167
1168 // Reverse iteration
1169 // Iterate over all oop fields and metadata.
1170 template <typename T, class OopClosureType>
1171 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
1172
1173 private:
1174 // Iterate over all oop fields in the oop maps.
1175 template <typename T, class OopClosureType>
1176 inline void oop_oop_iterate_oop_maps_reverse(oop obj, OopClosureType* closure);
1177
1178 // Iterate over all oop fields in one oop map.
1179 template <typename T, class OopClosureType>
1180 inline void oop_oop_iterate_oop_map_reverse(OopMapBlock* map, oop obj, OopClosureType* closure);
1181
1182
1183 // Bounded range iteration
1184 public:
1185 // Iterate over all oop fields in the oop maps.
1186 template <typename T, class OopClosureType>
1187 inline void oop_oop_iterate_oop_maps_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1188
1189 // Iterate over all oop fields and metadata.
1190 template <typename T, class OopClosureType>
1191 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1192
1193 private:
1194 // Iterate over all oop fields in one oop map.
1195 template <typename T, class OopClosureType>
1196 inline void oop_oop_iterate_oop_map_bounded(OopMapBlock* map, oop obj, OopClosureType* closure, MemRegion mr);
1197
1198
1199 public:
1200 u2 idnum_allocated_count() const { return _idnum_allocated_count; }
1201
1202 private:
1203 // initialization state
1204 void set_init_state(ClassState state);
1205 void set_rewritten() { _misc_flags.set_rewritten(true); }
1206 void set_init_thread(JavaThread *thread) {
1207 assert((thread == JavaThread::current() && _init_thread == nullptr) ||
1208 (thread == nullptr && _init_thread == JavaThread::current()), "Only one thread is allowed to own initialization");
1209 AtomicAccess::store(&_init_thread, thread);
1210 }
1211
1212 jmethodID* methods_jmethod_ids_acquire() const;
1213 void release_set_methods_jmethod_ids(jmethodID* jmeths);
1214 // This nulls out obsolete jmethodIDs for all methods in 'klass'.
1215 static void clear_obsolete_jmethod_ids(InstanceKlass* klass);
1216 jmethodID update_jmethod_id(jmethodID* jmeths, Method* method, int idnum);
1217
1218 public:
1219 // Lock for (1) initialization; (2) access to the ConstantPool of this class.
1220 // Must be one per class and it has to be a VM internal object so java code
1221 // cannot lock it (like the mirror).
1222 // It has to be an object not a Mutex because it's held through java calls.
1223 oop init_lock() const;
1224
1225 // Returns the array class for the n'th dimension
1226 ArrayKlass* array_klass(int n, TRAPS) override;
1227 ArrayKlass* array_klass_or_null(int n) override;
1228
1229 // Returns the array class with this class as element type
1230 ArrayKlass* array_klass(TRAPS) override;
1231 ArrayKlass* array_klass_or_null() override;
1232
1233 static void clean_initialization_error_table();
1234 private:
1235 void fence_and_clear_init_lock();
1236
1237 bool link_class_impl (TRAPS);
1238 bool verify_code (TRAPS);
1239 void initialize_impl (TRAPS);
1240 void initialize_super_interfaces (TRAPS);
1241
1242 void add_initialization_error(JavaThread* current, Handle exception);
1243 oop get_initialization_error(JavaThread* current);
1244
1245 // find a local method (returns null if not found)
1246 Method* find_method_impl(const Symbol* name,
1247 const Symbol* signature,
1248 OverpassLookupMode overpass_mode,
1249 StaticLookupMode static_mode,
1250 PrivateLookupMode private_mode) const;
1251
1252 static Method* find_method_impl(const Array<Method*>* methods,
1253 const Symbol* name,
1254 const Symbol* signature,
1255 OverpassLookupMode overpass_mode,
1256 StaticLookupMode static_mode,
1257 PrivateLookupMode private_mode);
1258
1259 #if INCLUDE_JVMTI
1260 // RedefineClasses support
1261 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1262 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1263 #endif
1264 public:
1265
1266 #if INCLUDE_CDS
1267 // CDS support - remove and restore oops from metadata. Oops are not shared.
1268 void remove_unshareable_info() override;
1269 void remove_unshareable_flags();
1270 void remove_java_mirror() override;
1271 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1272 void init_shared_package_entry();
1273 bool can_be_verified_at_dumptime() const;
1274 void compute_has_loops_flag_for_methods();
1275 #endif
1276 bool has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
1277 void set_has_init_deps_processed() {
1278 assert(is_initialized(), "");
1279 assert(!has_init_deps_processed(), "already set"); // one-off action
1280 _misc_flags.set_has_init_deps_processed(true);
1281 }
1282
1283 u2 compute_modifier_flags() const override;
1284
1285 public:
1286 // JVMTI support
1287 jint jvmti_class_status() const override;
1288
1289 void metaspace_pointers_do(MetaspaceClosure* iter) override;
1290
1291 public:
1292 // Printing
1293 void print_on(outputStream* st) const override;
1294 void print_value_on(outputStream* st) const override;
1295 void print_class_flags(outputStream* st) const;
1296
1297 void oop_print_value_on(oop obj, outputStream* st) override;
1298
1299 void oop_print_on (oop obj, outputStream* st) override { oop_print_on(obj, st, 0, 0); }
1300 void oop_print_on (oop obj, outputStream* st, int indent = 0, int base_offset = 0);
1301
1302 #ifndef PRODUCT
1303 void print_dependent_nmethods(bool verbose = false);
1304 bool is_dependent_nmethod(nmethod* nm);
1305 bool verify_itable_index(int index);
1306 #endif
1307
1308 const char* internal_name() const override;
1309
1310 template<typename T, typename TClosureType>
1311 static void print_array_on(outputStream* st, Array<T>* array, TClosureType elem_printer);
1312
1313 // Verification
1314 void verify_on(outputStream* st) override;
1315
1316 void oop_verify_on(oop obj, outputStream* st) override;
1317
1318 // Logging
1319 void print_class_load_logging(ClassLoaderData* loader_data,
1320 const ModuleEntry* module_entry,
1321 const ClassFileStream* cfs) const;
1322 private:
1323 void print_class_load_cause_logging() const;
1324 void print_class_load_helper(ClassLoaderData* loader_data,
1325 const ModuleEntry* module_entry,
1326 const ClassFileStream* cfs) const;
1327 };
1328
1329 // for adding methods
1330 // UNSET_IDNUM return means no more ids available
1331 inline u2 InstanceKlass::next_method_idnum() {
1332 if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
1333 return ConstMethod::UNSET_IDNUM; // no more ids available
1334 } else {
1335 return _idnum_allocated_count++;
1336 }
1337 }
1338
1339 class PrintClassClosure : public KlassClosure {
1340 private:
1341 outputStream* _st;
1342 bool _verbose;
1343 public:
1344 PrintClassClosure(outputStream* st, bool verbose);
1345
1346 void do_klass(Klass* k);
1347 };
1348
1349 /* JNIid class for jfieldIDs only */
1350 class JNIid: public CHeapObj<mtClass> {
1351 friend class VMStructs;
1352 private:
1353 InstanceKlass* _holder;
1354 JNIid* _next;
1355 int _offset;
1356 #ifdef ASSERT
1357 bool _is_static_field_id;
1358 #endif
1359
1360 public:
1361 // Accessors
1362 InstanceKlass* holder() const { return _holder; }
1363 int offset() const { return _offset; }
1364 JNIid* next() { return _next; }
1365 // Constructor
1366 JNIid(InstanceKlass* holder, int offset, JNIid* next);
1367 // Identifier lookup
1368 JNIid* find(int offset);
1369
1370 bool find_local_field(fieldDescriptor* fd) {
1371 return InstanceKlass::cast(holder())->find_local_field_from_offset(offset(), true, fd);
1372 }
1373
1374 static void deallocate(JNIid* id);
1375 // Debugging
1376 #ifdef ASSERT
1377 bool is_static_field_id() const { return _is_static_field_id; }
1378 void set_is_static_field_id() { _is_static_field_id = true; }
1379 #endif
1380 void verify(InstanceKlass* holder);
1381 };
1382
1383 // An iterator that's used to access the inner classes indices in the
1384 // InstanceKlass::_inner_classes array.
1385 class InnerClassesIterator : public StackObj {
1386 private:
1387 Array<jushort>* _inner_classes;
1388 int _length;
1389 int _idx;
1390 public:
1391
1392 InnerClassesIterator(const InstanceKlass* k) {
1393 _inner_classes = k->inner_classes();
1394 if (k->inner_classes() != nullptr) {
1395 _length = _inner_classes->length();
1396 // The inner class array's length should be the multiple of
1397 // inner_class_next_offset if it only contains the InnerClasses
1398 // attribute data, or it should be
1399 // n*inner_class_next_offset+enclosing_method_attribute_size
1400 // if it also contains the EnclosingMethod data.
1401 assert((_length % InstanceKlass::inner_class_next_offset == 0 ||
1402 _length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size),
1403 "just checking");
1404 // Remove the enclosing_method portion if exists.
1405 if (_length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size) {
1406 _length -= InstanceKlass::enclosing_method_attribute_size;
1407 }
1408 } else {
1409 _length = 0;
1410 }
1411 _idx = 0;
1412 }
1413
1414 int length() const {
1415 return _length;
1416 }
1417
1418 void next() {
1419 _idx += InstanceKlass::inner_class_next_offset;
1420 }
1421
1422 bool done() const {
1423 return (_idx >= _length);
1424 }
1425
1426 u2 inner_class_info_index() const {
1427 return _inner_classes->at(
1428 _idx + InstanceKlass::inner_class_inner_class_info_offset);
1429 }
1430
1431 void set_inner_class_info_index(u2 index) {
1432 _inner_classes->at_put(
1433 _idx + InstanceKlass::inner_class_inner_class_info_offset, index);
1434 }
1435
1436 u2 outer_class_info_index() const {
1437 return _inner_classes->at(
1438 _idx + InstanceKlass::inner_class_outer_class_info_offset);
1439 }
1440
1441 void set_outer_class_info_index(u2 index) {
1442 _inner_classes->at_put(
1443 _idx + InstanceKlass::inner_class_outer_class_info_offset, index);
1444 }
1445
1446 u2 inner_name_index() const {
1447 return _inner_classes->at(
1448 _idx + InstanceKlass::inner_class_inner_name_offset);
1449 }
1450
1451 void set_inner_name_index(u2 index) {
1452 _inner_classes->at_put(
1453 _idx + InstanceKlass::inner_class_inner_name_offset, index);
1454 }
1455
1456 u2 inner_access_flags() const {
1457 return _inner_classes->at(
1458 _idx + InstanceKlass::inner_class_access_flags_offset);
1459 }
1460 };
1461
1462 // Iterator over class hierarchy under a particular class. Implements depth-first pre-order traversal.
1463 // Usage:
1464 // for (ClassHierarchyIterator iter(root_klass); !iter.done(); iter.next()) {
1465 // Klass* k = iter.klass();
1466 // ...
1467 // }
1468 class ClassHierarchyIterator : public StackObj {
1469 private:
1470 InstanceKlass* _root;
1471 Klass* _current;
1472 bool _visit_subclasses;
1473
1474 public:
1475 ClassHierarchyIterator(InstanceKlass* root) : _root(root), _current(root), _visit_subclasses(true) {
1476 assert(_root == _current, "required"); // initial state
1477 }
1478
1479 bool done() {
1480 return (_current == nullptr);
1481 }
1482
1483 // Make a step iterating over the class hierarchy under the root class.
1484 // Skips subclasses if requested.
1485 void next();
1486
1487 Klass* klass() {
1488 assert(!done(), "sanity");
1489 return _current;
1490 }
1491
1492 // Skip subclasses of the current class.
1493 void skip_subclasses() {
1494 _visit_subclasses = false;
1495 }
1496 };
1497
1498 #endif // SHARE_OOPS_INSTANCEKLASS_HPP