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