1 /*
2 * Copyright (c) 1997, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_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/constMethod.hpp"
33 #include "oops/fieldInfo.hpp"
34 #include "oops/instanceKlassFlags.hpp"
35 #include "oops/instanceOop.hpp"
36 #include "oops/refArrayKlass.hpp"
37 #include "runtime/handles.hpp"
38 #include "runtime/javaThread.hpp"
39 #include "utilities/accessFlags.hpp"
40 #include "utilities/align.hpp"
41 #include "utilities/growableArray.hpp"
42 #include "utilities/macros.hpp"
43 #if INCLUDE_JFR
44 #include "jfr/support/jfrKlassExtension.hpp"
45 #endif
46
47 class ConstantPool;
48 class DeoptimizationScope;
49 class klassItable;
50 class RecordComponent;
51
52 // An InstanceKlass is the VM level representation of a Java class.
53 // It contains all information needed for at class at execution runtime.
54
55 // InstanceKlass embedded field layout (after declared fields):
56 // [EMBEDDED Java vtable ] size in words = vtable_len
57 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
58 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
59 // indicating where oops are located in instances of this klass.
60 // [EMBEDDED implementor of the interface] only exist for interface
61 // [EMBEDDED InlineKlass::Members] only if is an InlineKlass instance
62
63
64 // forward declaration for class -- see below for definition
65 #if INCLUDE_JVMTI
66 class BreakpointInfo;
67 #endif
68 class ClassFileParser;
69 class ClassFileStream;
70 class KlassDepChange;
71 class DependencyContext;
72 class fieldDescriptor;
73 class JNIid;
74 class JvmtiCachedClassFieldMap;
75 class nmethodBucket;
76 class OopMapCache;
77 class BufferedInlineTypeBlob;
78 class InterpreterOopMap;
79 class PackageEntry;
80 class ModuleEntry;
81
82 // This is used in iterators below.
83 class FieldClosure: public StackObj {
84 public:
85 virtual void do_field(fieldDescriptor* fd) = 0;
86 };
87
88 // Print fields.
89 // If "obj" argument to constructor is null, prints static fields, otherwise prints non-static fields.
90 class FieldPrinter: public FieldClosure {
91 oop _obj;
92 outputStream* _st;
93 int _indent;
94 int _base_offset;
95 public:
96 FieldPrinter(outputStream* st, oop obj = nullptr, int indent = 0, int base_offset = 0) :
97 _obj(obj), _st(st), _indent(indent), _base_offset(base_offset) {}
98 void do_field(fieldDescriptor* fd);
99 };
100
101 // Describes where oops are located in instances of this klass.
102 class OopMapBlock {
103 public:
104 // Byte offset of the first oop mapped by this block.
105 int offset() const { return _offset; }
106 void set_offset(int offset) { _offset = offset; }
107
108 // Number of oops in this block.
109 uint count() const { return _count; }
110 void set_count(uint count) { _count = count; }
111
112 void increment_count(int diff) { _count += diff; }
113
114 int offset_span() const { return _count * heapOopSize; }
115
116 int end_offset() const {
117 return offset() + offset_span();
118 }
119
120 bool is_contiguous(int another_offset) const {
121 return another_offset == end_offset();
122 }
123
124 // sizeof(OopMapBlock) in words.
125 static int size_in_words() {
126 return align_up((int)sizeof(OopMapBlock), wordSize) >>
127 LogBytesPerWord;
128 }
129
130 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
131 return a->offset() - b->offset();
132 }
133
134 private:
135 int _offset;
136 uint _count;
137 };
138
139 struct JvmtiCachedClassFileData;
140
141 class InlineLayoutInfo : public MetaspaceObj {
142 InlineKlass* _klass;
143 LayoutKind _kind;
144 int _null_marker_offset; // null marker offset for this field, relative to the beginning of the current container
145
146 public:
147 InlineLayoutInfo(): _klass(nullptr), _kind(LayoutKind::UNKNOWN), _null_marker_offset(-1) {}
148 InlineLayoutInfo(InlineKlass* ik, LayoutKind kind, int size, int nm_offset):
149 _klass(ik), _kind(kind), _null_marker_offset(nm_offset) {}
150
151 InlineKlass* klass() const { return _klass; }
152 void set_klass(InlineKlass* k) { _klass = k; }
153
154 LayoutKind kind() const {
155 assert(_kind != LayoutKind::UNKNOWN, "Not set");
156 return _kind;
157 }
158 void set_kind(LayoutKind lk) { _kind = lk; }
159
160 int null_marker_offset() const {
161 assert(_null_marker_offset != -1, "Not set");
162 return _null_marker_offset;
163 }
164 void set_null_marker_offset(int o) { _null_marker_offset = o; }
165
166 void metaspace_pointers_do(MetaspaceClosure* it);
167 MetaspaceObj::Type type() const { return InlineLayoutInfoType; }
168
169 static ByteSize klass_offset() { return byte_offset_of(InlineLayoutInfo, _klass); }
170 static ByteSize null_marker_offset_offset() { return byte_offset_of(InlineLayoutInfo, _null_marker_offset); }
171 };
172
173 class InstanceKlass: public Klass {
174 friend class VMStructs;
175 friend class JVMCIVMStructs;
176 friend class ClassFileParser;
177 friend class CompileReplay;
178 friend class TemplateTable;
179
180 public:
181 static const KlassKind Kind = InstanceKlassKind;
182
183 protected:
184 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, markWord prototype = markWord::prototype(), ReferenceType reference_type = REF_NONE);
185
186 public:
187 InstanceKlass();
188
189 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
190 // of the class loading & initialization procedure, and the use of the states.
191 enum ClassState : u1 {
192 allocated, // allocated (but not yet linked)
193 loaded, // loaded and inserted in class hierarchy (but not linked yet)
194 linked, // successfully linked/verified (but not initialized yet)
195 being_initialized, // currently running class initializer
196 fully_initialized, // initialized (successful final state)
197 initialization_error // error happened during initialization
198 };
199
200 private:
201 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
202
203 protected:
204 // If you add a new field that points to any metaspace object, you
205 // must add this field to InstanceKlass::metaspace_pointers_do().
206
207 // Annotations for this class
208 Annotations* _annotations;
209 // Package this class is defined in
210 PackageEntry* _package_entry;
211 // Array classes holding elements of this class.
212 ObjArrayKlass* volatile _array_klasses;
213 // Constant pool for this class.
214 ConstantPool* _constants;
215 // The InnerClasses attribute and EnclosingMethod attribute. The
216 // _inner_classes is an array of shorts. If the class has InnerClasses
217 // attribute, then the _inner_classes array begins with 4-tuples of shorts
218 // [inner_class_info_index, outer_class_info_index,
219 // inner_name_index, inner_class_access_flags] for the InnerClasses
220 // attribute. If the EnclosingMethod attribute exists, it occupies the
221 // last two shorts [class_index, method_index] of the array. If only
222 // the InnerClasses attribute exists, the _inner_classes array length is
223 // number_of_inner_classes * 4. If the class has both InnerClasses
224 // and EnclosingMethod attributes the _inner_classes array length is
225 // number_of_inner_classes * 4 + enclosing_method_attribute_size.
226 Array<jushort>* _inner_classes;
227
228 // The NestMembers attribute. An array of shorts, where each is a
229 // class info index for the class that is a nest member. This data
230 // has not been validated.
231 Array<jushort>* _nest_members;
232
233 // Resolved nest-host klass: either true nest-host or self if we are not
234 // nested, or an error occurred resolving or validating the nominated
235 // nest-host. Can also be set directly by JDK API's that establish nest
236 // relationships.
237 // By always being set it makes nest-member access checks simpler.
238 InstanceKlass* _nest_host;
239
240 // The PermittedSubclasses attribute. An array of shorts, where each is a
241 // class info index for the class that is a permitted subclass.
242 Array<jushort>* _permitted_subclasses;
243
244 // The contents of the Record attribute.
245 Array<RecordComponent*>* _record_components;
246
247 // the source debug extension for this klass, null if not specified.
248 // Specified as UTF-8 string without terminating zero byte in the classfile,
249 // it is stored in the instanceklass as a null-terminated UTF-8 string
250 const char* _source_debug_extension;
251
252 // Number of heapOopSize words used by non-static fields in this klass
253 // (including inherited fields but after header_size()).
254 int _nonstatic_field_size;
255 int _static_field_size; // number words used by static fields (oop and non-oop) in this klass
256 int _nonstatic_oop_map_size; // size in words of nonstatic oop map blocks
257 int _itable_len; // length of Java itable (in words)
258
259 // The NestHost attribute. The class info index for the class
260 // that is the nest-host of this class. This data has not been validated.
261 u2 _nest_host_index;
262 u2 _this_class_index; // constant pool entry
263 u2 _static_oop_field_count; // number of static oop fields in this klass
264
265 volatile u2 _idnum_allocated_count; // JNI/JVMTI: increments with the addition of methods, old ids don't change
266
267 // Class states are defined as ClassState (see above).
268 // Place the _init_state here to utilize the unused 2-byte after
269 // _idnum_allocated_count.
270 volatile ClassState _init_state; // state of class
271
272 u1 _reference_type; // reference type
273 int _acmp_maps_offset; // offset to injected static field storing .acmp_maps for values classes
274 // unfortunately, abstract values need one too so it cannot be stored in
275 // the InlineKlass::Members that only exist for InlineKlass.
276
277 AccessFlags _access_flags; // Access flags. The class/interface distinction is stored here.
278
279 // State is set either at parse time or while executing, atomically to not disturb other state
280 InstanceKlassFlags _misc_flags;
281
282 JavaThread* volatile _init_thread; // Pointer to current thread doing initialization (to handle recursive initialization)
283
284 OopMapCache* volatile _oop_map_cache; // OopMapCache for all methods in the klass (allocated lazily)
285 JNIid* _jni_ids; // First JNI identifier for static fields in this class
286 jmethodID* volatile _methods_jmethod_ids; // jmethodIDs corresponding to method_idnum, or null if none
287 nmethodBucket* volatile _dep_context; // packed DependencyContext structure
288 uint64_t volatile _dep_context_last_cleaned;
289 nmethod* _osr_nmethods_head; // Head of list of on-stack replacement nmethods for this class
290 #if INCLUDE_JVMTI
291 BreakpointInfo* _breakpoints; // bpt lists, managed by Method*
292 // Linked instanceKlasses of previous versions
293 InstanceKlass* _previous_versions;
294 // JVMTI fields can be moved to their own structure - see 6315920
295 // JVMTI: cached class file, before retransformable agent modified it in CFLH
296 JvmtiCachedClassFileData* _cached_class_file;
297 #endif
298
299 #if INCLUDE_JVMTI
300 JvmtiCachedClassFieldMap* _jvmti_cached_class_field_map; // JVMTI: used during heap iteration
301 #endif
302
303 NOT_PRODUCT(int _verify_count;) // to avoid redundant verifies
304 NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once
305
306 // Method array.
307 Array<Method*>* _methods;
308 // Default Method Array, concrete methods inherited from interfaces
309 Array<Method*>* _default_methods;
310 // Interfaces (InstanceKlass*s) this class declares locally to implement.
311 Array<InstanceKlass*>* _local_interfaces;
312 // Interfaces (InstanceKlass*s) this class implements transitively.
313 Array<InstanceKlass*>* _transitive_interfaces;
314 // Int array containing the original order of method in the class file (for JVMTI).
315 Array<int>* _method_ordering;
316 // Int array containing the vtable_indices for default_methods
317 // offset matches _default_methods offset
318 Array<int>* _default_vtable_indices;
319
320 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
321 Array<u1>* _fieldinfo_stream;
322 Array<u1>* _fieldinfo_search_table;
323 Array<FieldStatus>* _fields_status;
324
325 Array<InlineLayoutInfo>* _inline_layout_info_array;
326 Array<u2>* _loadable_descriptors;
327 Array<int>* _acmp_maps_array; // Metadata copy of the acmp_maps oop used in value classes.
328 // When loading an inline klass from the CDS/AOT archive
329 // this copy can be used to regenerate the ".acmp_maps" oop
330 // if it is not stored in the archive.
331
332 // Located here because sub-klasses can't have their own C++ fields
333 address _adr_inline_klass_members;
334
335 // embedded Java vtable follows here
336 // embedded Java itables follows here
337 // embedded static fields follows here
338 // embedded nonstatic oop-map blocks follows here
339 // embedded implementor of this interface follows here
340 // The embedded implementor only exists if the current klass is an
341 // interface. The possible values of the implementor fall into following
342 // three cases:
343 // null: no implementor.
344 // A Klass* that's not itself: one implementor.
345 // Itself: more than one implementors.
346 //
347
348 friend class SystemDictionary;
349
350 static bool _disable_method_binary_search;
351
352 // Controls finalizer registration
353 static bool _finalization_enabled;
354
355 public:
356
357 // Queries finalization state
358 static bool is_finalization_enabled() { return _finalization_enabled; }
359
360 // Sets finalization state
361 static void set_finalization_enabled(bool val) { _finalization_enabled = val; }
362
363 // Access flags
364 AccessFlags access_flags() const { return _access_flags; }
365 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
366
367 bool is_public() const { return _access_flags.is_public(); }
368 bool is_final() const { return _access_flags.is_final(); }
369 bool is_interface() const override { return _access_flags.is_interface(); }
370 bool is_abstract() const override { return _access_flags.is_abstract(); }
371 bool is_synthetic() const { return _access_flags.is_synthetic(); }
372 void set_is_synthetic() { _access_flags.set_is_synthetic(); }
373 bool is_identity_class() const override { return _access_flags.is_identity_class(); }
374
375 static ByteSize access_flags_offset() { return byte_offset_of(InstanceKlass, _access_flags); }
376
377 void set_is_cloneable();
378
379 // Quick checks for the loader that defined this class (without switching on this->class_loader())
380 bool defined_by_boot_loader() const { return _misc_flags.defined_by_boot_loader(); }
381 bool defined_by_platform_loader() const { return _misc_flags.defined_by_platform_loader(); }
382 bool defined_by_app_loader() const { return _misc_flags.defined_by_app_loader(); }
383 bool defined_by_other_loaders() const { return _misc_flags.defined_by_other_loaders(); }
384 void set_class_loader_type() { _misc_flags.set_class_loader_type(_class_loader_data); }
385
386 // Check if the class can be shared in CDS
387 bool is_shareable() const;
388
389 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
390
391 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
392
393 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
394 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
395
396 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
397 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
398
399 bool has_inlined_fields() const { return _misc_flags.has_inlined_fields(); }
400 void set_has_inlined_fields() { _misc_flags.set_has_inlined_fields(true); }
401
402 bool is_naturally_atomic() const { return _misc_flags.is_naturally_atomic(); }
403 void set_is_naturally_atomic() { _misc_flags.set_is_naturally_atomic(true); }
404
405 // Query if this class has atomicity requirements (default is yes)
406 // This bit can occur anywhere, but is only significant
407 // for inline classes *and* their super types.
408 // It inherits from supers.
409 // Its value depends on the ForceNonTearable VM option, the LooselyConsistentValue annotation
410 // and the presence of flat fields with atomicity requirements
411 bool must_be_atomic() const { return _misc_flags.must_be_atomic(); }
412 void set_must_be_atomic() { _misc_flags.set_must_be_atomic(true); }
413
414 // field sizes
415 int nonstatic_field_size() const { return _nonstatic_field_size; }
416 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
417
418 int static_field_size() const { return _static_field_size; }
419 void set_static_field_size(int size) { _static_field_size = size; }
420
421 int static_oop_field_count() const { return (int)_static_oop_field_count; }
422 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
423
424 // Java itable
425 int itable_length() const { return _itable_len; }
426 void set_itable_length(int len) { _itable_len = len; }
427
428 // array klasses
429 ObjArrayKlass* array_klasses() const { return _array_klasses; }
430 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
431 inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
432 void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }
433
434 // methods
435 Array<Method*>* methods() const { return _methods; }
436 void set_methods(Array<Method*>* a) { _methods = a; }
437 Method* method_with_idnum(int idnum) const;
438 Method* method_with_orig_idnum(int idnum) const;
439 Method* method_with_orig_idnum(int idnum, int version) const;
440
441 // method ordering
442 Array<int>* method_ordering() const { return _method_ordering; }
443 void set_method_ordering(Array<int>* m) { _method_ordering = m; }
444 void copy_method_ordering(const intArray* m, TRAPS);
445
446 // default_methods
447 Array<Method*>* default_methods() const { return _default_methods; }
448 void set_default_methods(Array<Method*>* a) { _default_methods = a; }
449
450 // default method vtable_indices
451 Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
452 void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
453 Array<int>* create_new_default_vtable_indices(int len, TRAPS);
454
455 // interfaces
456 Array<InstanceKlass*>* local_interfaces() const { return _local_interfaces; }
457 void set_local_interfaces(Array<InstanceKlass*>* a) {
458 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
459 _local_interfaces = a; }
460
461 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
462 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
463 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
464 _transitive_interfaces = a;
465 }
466
467 private:
468 friend class fieldDescriptor;
469 FieldInfo field(int index) const;
470
471 public:
472 int field_offset (int index) const { return field(index).offset(); }
473 int field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
474 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
475 FieldStatus field_status(int index) const { return fields_status()->at(index); }
476 inline Symbol* field_name (int index) const;
477 inline Symbol* field_signature (int index) const;
478 bool field_is_flat(int index) const { return field_flags(index).is_flat(); }
479 bool field_has_null_marker(int index) const { return field_flags(index).has_null_marker(); }
480 bool field_is_null_free_inline_type(int index) const;
481 bool is_class_in_loadable_descriptors_attribute(Symbol* name) const;
482
483 int field_null_marker_offset(int index) const { return inline_layout_info(index).null_marker_offset(); }
484
485 // Number of Java declared fields
486 int java_fields_count() const;
487 int total_fields_count() const;
488
489 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
490 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
491
492 Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
493 void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }
494
495 Array<FieldStatus>* fields_status() const {return _fields_status; }
496 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
497
498 Array<u2>* loadable_descriptors() const { return _loadable_descriptors; }
499 void set_loadable_descriptors(Array<u2>* c) { _loadable_descriptors = c; }
500
501 Array<int>* acmp_maps_array() const { return _acmp_maps_array; }
502 void set_acmp_maps_array(Array<int>* array) { _acmp_maps_array = array; }
503
504 // inner classes
505 Array<u2>* inner_classes() const { return _inner_classes; }
506 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
507
508 // nest members
509 Array<u2>* nest_members() const { return _nest_members; }
510 void set_nest_members(Array<u2>* m) { _nest_members = m; }
511
512 // nest-host index
513 jushort nest_host_index() const { return _nest_host_index; }
514 void set_nest_host_index(u2 i) { _nest_host_index = i; }
515 // dynamic nest member support
516 void set_nest_host(InstanceKlass* host);
517
518 // record components
519 Array<RecordComponent*>* record_components() const { return _record_components; }
520 void set_record_components(Array<RecordComponent*>* record_components) {
521 _record_components = record_components;
522 }
523 bool is_record() const;
524
525 // test for enum class (or possibly an anonymous subclass within a sealed enum)
526 bool is_enum_subclass() const;
527
528 // permitted subclasses
529 Array<u2>* permitted_subclasses() const { return _permitted_subclasses; }
530 void set_permitted_subclasses(Array<u2>* s) { _permitted_subclasses = s; }
531
532 private:
533 // Called to verify that k is a member of this nest - does not look at k's nest-host,
534 // nor does it resolve any CP entries or load any classes.
535 bool has_nest_member(JavaThread* current, InstanceKlass* k) const;
536
537 public:
538 // Call this only if you know that the nest host has been initialized.
539 InstanceKlass* nest_host_not_null() {
540 assert(_nest_host != nullptr, "must be");
541 return _nest_host;
542 }
543 InstanceKlass* nest_host_or_null() {
544 return _nest_host;
545 }
546 // Used to construct informative IllegalAccessError messages at a higher level,
547 // if there was an issue resolving or validating the nest host.
548 // Returns null if there was no error.
549 const char* nest_host_error();
550 // Returns nest-host class, resolving and validating it if needed.
551 // Returns null if resolution is not possible from the calling context.
552 InstanceKlass* nest_host(TRAPS);
553 // Check if this klass is a nestmate of k - resolves this nest-host and k's
554 bool has_nestmate_access_to(InstanceKlass* k, TRAPS);
555
556 // Called to verify that k is a permitted subclass of this class.
557 // The incoming stringStream is used for logging, and for the caller to create
558 // a detailed exception message on failure.
559 bool has_as_permitted_subclass(const InstanceKlass* k, stringStream& ss) const;
560
561 enum InnerClassAttributeOffset {
562 // From http://mirror.eng/products/jdk/1.1/docs/guide/innerclasses/spec/innerclasses.doc10.html#18814
563 inner_class_inner_class_info_offset = 0,
564 inner_class_outer_class_info_offset = 1,
565 inner_class_inner_name_offset = 2,
566 inner_class_access_flags_offset = 3,
567 inner_class_next_offset = 4
568 };
569
570 enum EnclosingMethodAttributeOffset {
571 enclosing_method_class_index_offset = 0,
572 enclosing_method_method_index_offset = 1,
573 enclosing_method_attribute_size = 2
574 };
575
576 // package
577 PackageEntry* package() const override { return _package_entry; }
578 ModuleEntry* module() const override;
579 bool in_javabase_module() const;
580 bool in_unnamed_package() const { return (_package_entry == nullptr); }
581 void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
582 // If the package for the InstanceKlass is in the boot loader's package entry
583 // table then sets the classpath_index field so that
584 // get_system_package() will know to return a non-null value for the
585 // package's location. And, so that the package will be added to the list of
586 // packages returned by get_system_packages().
587 // For packages whose classes are loaded from the boot loader class path, the
588 // classpath_index indicates which entry on the boot loader class path.
589 void set_classpath_index(s2 path_index);
590 bool is_same_class_package(const Klass* class2) const;
591 bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
592
593 // find an enclosing class
594 InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
595
596 // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
597 bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
598
599 // Check if this klass can be null-free
600 static void check_can_be_annotated_with_NullRestricted(InstanceKlass* type, Symbol* container_klass_name, TRAPS);
601
602 private:
603 // Check prohibited package ("java/" only loadable by boot or platform loaders)
604 static void check_prohibited_package(Symbol* class_name,
605 ClassLoaderData* loader_data,
606 TRAPS);
607
608 JavaThread* init_thread() { return AtomicAccess::load(&_init_thread); }
609 const char* init_thread_name() {
610 return init_thread()->name_raw();
611 }
612
613 public:
614 // initialization state
615 bool is_loaded() const { return init_state() >= loaded; }
616 bool is_linked() const { return init_state() >= linked; }
617 bool is_initialized() const { return init_state() == fully_initialized; }
618 bool is_not_initialized() const { return init_state() < being_initialized; }
619 bool is_being_initialized() const { return init_state() == being_initialized; }
620 bool is_in_error_state() const { return init_state() == initialization_error; }
621 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
622 ClassState init_state() const { return AtomicAccess::load_acquire(&_init_state); }
623 const char* init_state_name() const;
624 bool is_rewritten() const { return _misc_flags.rewritten(); }
625
626 // is this a sealed class
627 bool is_sealed() const;
628
629 // defineClass specified verification
630 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
631 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
632
633 // marking
634 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
635 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
636
637 static ByteSize kind_offset() { return byte_offset_of(InstanceKlass, _kind); }
638 static ByteSize misc_flags_offset() { return byte_offset_of(InstanceKlass, _misc_flags); }
639
640 // initialization (virtuals from Klass)
641 bool should_be_initialized() const override; // means that initialize should be called
642 void initialize_with_aot_initialized_mirror(TRAPS);
643 void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
644 void initialize(TRAPS) override;
645 void initialize_preemptable(TRAPS) override;
646 void link_class(TRAPS);
647 bool link_class_or_fail(TRAPS); // returns false on failure
648 void rewrite_class(TRAPS);
649 void link_methods(TRAPS);
650 Method* class_initializer() const;
651 bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;
652
653 // reference type
654 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
655
656 bool has_acmp_maps_offset() const {
657 return _acmp_maps_offset != 0;
658 }
659
660 int acmp_maps_offset() const {
661 assert(_acmp_maps_offset != 0, "Not initialized");
662 return _acmp_maps_offset;
663 }
664 void set_acmp_maps_offset(int offset) { _acmp_maps_offset = offset; }
665 static ByteSize acmp_maps_offset_offset() { return byte_offset_of(InstanceKlass, _acmp_maps_offset); }
666
667 // this class cp index
668 u2 this_class_index() const { return _this_class_index; }
669 void set_this_class_index(u2 index) { _this_class_index = index; }
670
671 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
672
673 // find local field, returns true if found
674 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
675 // find field in direct superinterfaces, returns the interface in which the field is defined
676 Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
677 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
678 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
679 // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
680 Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;
681
682 // find a non-static or static field given its offset within the class.
683 bool contains_field_offset(int offset);
684
685 bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
686 bool find_field_from_offset(int offset, bool is_static, 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 InstanceKlass* implementor() const;
1001 void set_implementor(InstanceKlass* ik);
1002 int nof_implementors() const;
1003 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
1004 void init_implementor(); // initialize
1005
1006 private:
1007 // link this class into the implementors list of every interface it implements
1008 void process_interfaces();
1009
1010 public:
1011 // virtual operations from Klass
1012 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
1013 Array<InstanceKlass*>* transitive_interfaces) override;
1014 bool can_be_primary_super_slow() const override;
1015 size_t oop_size(oop obj) const override { return size_helper(); }
1016 // slow because it's a virtual call and used for verifying the layout_helper.
1017 // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
1018 DEBUG_ONLY(bool is_instance_klass_slow() const override { return true; })
1019
1020 // Iterators
1021 void do_local_static_fields(FieldClosure* cl);
1022 void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
1023 void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
1024 void print_nonstatic_fields(FieldClosure* cl); // including inherited and injected fields
1025
1026 void methods_do(void f(Method* method));
1027
1028 static InstanceKlass* cast(Klass* k) {
1029 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
1030 }
1031
1032 static const InstanceKlass* cast(const Klass* k) {
1033 assert(k != nullptr, "k should not be null");
1034 assert(k->is_instance_klass(), "cast to InstanceKlass");
1035 return static_cast<const InstanceKlass*>(k);
1036 }
1037
1038 // This hides Klass::super(). The _super of an InstanceKlass is
1039 // always an InstanceKlass (or nullptr)
1040 InstanceKlass* super() const {
1041 return (Klass::super() == nullptr) ? nullptr : InstanceKlass::cast(Klass::super());
1042 }
1043
1044 InstanceKlass* java_super() const override {
1045 return InstanceKlass::super();
1046 }
1047
1048 // Sizing (in words)
1049 static int header_size() { return sizeof(InstanceKlass) / wordSize; }
1050
1051 static int size(int vtable_length,
1052 int itable_length,
1053 int nonstatic_oop_map_size,
1054 bool is_interface,
1055 bool is_inline_type);
1056
1057 int size() const override;
1058
1059 inline intptr_t* start_of_itable() const;
1060 inline intptr_t* end_of_itable() const;
1061 inline oop static_field_base_raw();
1062 bool bounds_check(address addr, bool edge_ok = false, intptr_t size_in_bytes = -1) const PRODUCT_RETURN0;
1063
1064 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
1065 inline Klass** end_of_nonstatic_oop_maps() const;
1066
1067 inline InstanceKlass* volatile* adr_implementor() const;
1068
1069 // The end of the memory block that belongs to this InstanceKlass.
1070 // Sub-klasses can place their fields after this address.
1071 inline address end_of_instance_klass() const;
1072
1073 void set_inline_layout_info_array(Array<InlineLayoutInfo>* array) { _inline_layout_info_array = array; }
1074 Array<InlineLayoutInfo>* inline_layout_info_array() const { return _inline_layout_info_array; }
1075
1076 InlineLayoutInfo inline_layout_info(int index) const {
1077 assert(_inline_layout_info_array != nullptr, "Array not created");
1078 return _inline_layout_info_array->at(index);
1079 }
1080
1081 InlineLayoutInfo* inline_layout_info_adr(int index) {
1082 assert(_inline_layout_info_array != nullptr, "Array not created");
1083 return _inline_layout_info_array->adr_at(index);
1084 }
1085
1086 inline InlineKlass* get_inline_type_field_klass(int idx) const ;
1087 inline InlineKlass* get_inline_type_field_klass_or_null(int idx) const;
1088
1089 // Use this to return the size of an instance in heap words:
1090 int size_helper() const {
1091 return layout_helper_to_size_helper(layout_helper());
1092 }
1093
1094 // This bit is initialized in classFileParser.cpp.
1095 // It is false under any of the following conditions:
1096 // - the class is abstract (including any interface)
1097 // - the class size is larger than FastAllocateSizeLimit
1098 // - the class is java/lang/Class, which cannot be allocated directly
1099 bool can_be_fastpath_allocated() const {
1100 return !layout_helper_needs_slow_path(layout_helper());
1101 }
1102
1103 // Java itable
1104 klassItable itable() const; // return klassItable wrapper
1105 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
1106 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
1107 int vtable_index_of_interface_method(Method* method);
1108
1109 #if INCLUDE_JVMTI
1110 void adjust_default_methods(bool* trace_name_printed);
1111 #endif // INCLUDE_JVMTI
1112
1113 void clean_weak_instanceklass_links();
1114 private:
1115 void clean_implementors_list();
1116 void clean_method_data();
1117
1118 public:
1119 // Explicit metaspace deallocation of fields
1120 // For RedefineClasses and class file parsing errors, we need to deallocate
1121 // instanceKlasses and the metadata they point to.
1122 void deallocate_contents(ClassLoaderData* loader_data);
1123 static void deallocate_methods(ClassLoaderData* loader_data,
1124 Array<Method*>* methods);
1125 void static deallocate_interfaces(ClassLoaderData* loader_data,
1126 const InstanceKlass* super_klass,
1127 Array<InstanceKlass*>* local_interfaces,
1128 Array<InstanceKlass*>* transitive_interfaces);
1129 void static deallocate_record_components(ClassLoaderData* loader_data,
1130 Array<RecordComponent*>* record_component);
1131
1132 bool on_stack() const override;
1133
1134 // callbacks for actions during class unloading
1135 static void unload_class(InstanceKlass* ik);
1136
1137 void release_C_heap_structures(bool release_sub_metadata = true) override;
1138
1139 // Naming
1140 const char* signature_name() const override;
1141 const char* signature_name_of_carrier(char c) const;
1142
1143 // Oop fields (and metadata) iterators
1144 //
1145 // The InstanceKlass iterators also visits the Object's klass.
1146
1147 // Forward iteration
1148 public:
1149 // Iterate over all oop fields in the oop maps.
1150 template <typename T, class OopClosureType>
1151 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1152
1153 // Iterate over all oop fields and metadata.
1154 template <typename T, class OopClosureType>
1155 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1156
1157 // Iterate over all oop fields in one oop map.
1158 template <typename T, class OopClosureType>
1159 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1160
1161
1162 // Reverse iteration
1163 // Iterate over all oop fields and metadata.
1164 template <typename T, class OopClosureType>
1165 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
1166
1167 private:
1168 // Iterate over all oop fields in the oop maps.
1169 template <typename T, class OopClosureType>
1170 inline void oop_oop_iterate_oop_maps_reverse(oop obj, OopClosureType* closure);
1171
1172 // Iterate over all oop fields in one oop map.
1173 template <typename T, class OopClosureType>
1174 inline void oop_oop_iterate_oop_map_reverse(OopMapBlock* map, oop obj, OopClosureType* closure);
1175
1176
1177 // Bounded range iteration
1178 public:
1179 // Iterate over all oop fields in the oop maps.
1180 template <typename T, class OopClosureType>
1181 inline void oop_oop_iterate_oop_maps_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1182
1183 // Iterate over all oop fields and metadata.
1184 template <typename T, class OopClosureType>
1185 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1186
1187 private:
1188 // Iterate over all oop fields in one oop map.
1189 template <typename T, class OopClosureType>
1190 inline void oop_oop_iterate_oop_map_bounded(OopMapBlock* map, oop obj, OopClosureType* closure, MemRegion mr);
1191
1192
1193 public:
1194 u2 idnum_allocated_count() const { return _idnum_allocated_count; }
1195
1196 private:
1197 // initialization state
1198 void set_init_state(ClassState state);
1199 void set_rewritten() { _misc_flags.set_rewritten(true); }
1200 void set_init_thread(JavaThread *thread) {
1201 assert((thread == JavaThread::current() && _init_thread == nullptr) ||
1202 (thread == nullptr && _init_thread == JavaThread::current()), "Only one thread is allowed to own initialization");
1203 AtomicAccess::store(&_init_thread, thread);
1204 }
1205
1206 jmethodID* methods_jmethod_ids_acquire() const;
1207 void release_set_methods_jmethod_ids(jmethodID* jmeths);
1208 // This nulls out obsolete jmethodIDs for all methods in 'klass'.
1209 static void clear_obsolete_jmethod_ids(InstanceKlass* klass);
1210 jmethodID update_jmethod_id(jmethodID* jmeths, Method* method, int idnum);
1211
1212 public:
1213 // Lock for (1) initialization; (2) access to the ConstantPool of this class.
1214 // Must be one per class and it has to be a VM internal object so java code
1215 // cannot lock it (like the mirror).
1216 // It has to be an object not a Mutex because it's held through java calls.
1217 oop init_lock() const;
1218
1219 // Returns the array class for the n'th dimension
1220 ArrayKlass* array_klass(int n, TRAPS) override;
1221 ArrayKlass* array_klass_or_null(int n) override;
1222
1223 // Returns the array class with this class as element type
1224 ArrayKlass* array_klass(TRAPS) override;
1225 ArrayKlass* array_klass_or_null() override;
1226
1227 static void clean_initialization_error_table();
1228 private:
1229 void fence_and_clear_init_lock();
1230
1231 bool link_class_impl (TRAPS);
1232 bool verify_code (TRAPS);
1233 void initialize_impl (TRAPS);
1234 void initialize_super_interfaces (TRAPS);
1235
1236 void add_initialization_error(JavaThread* current, Handle exception);
1237 oop get_initialization_error(JavaThread* current);
1238
1239 // find a local method (returns null if not found)
1240 Method* find_method_impl(const Symbol* name,
1241 const Symbol* signature,
1242 OverpassLookupMode overpass_mode,
1243 StaticLookupMode static_mode,
1244 PrivateLookupMode private_mode) const;
1245
1246 static Method* find_method_impl(const Array<Method*>* methods,
1247 const Symbol* name,
1248 const Symbol* signature,
1249 OverpassLookupMode overpass_mode,
1250 StaticLookupMode static_mode,
1251 PrivateLookupMode private_mode);
1252
1253 #if INCLUDE_JVMTI
1254 // RedefineClasses support
1255 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1256 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1257 #endif
1258 // log class name to classlist
1259 void log_to_classlist() const;
1260 public:
1261
1262 #if INCLUDE_CDS
1263 // CDS support - remove and restore oops from metadata. Oops are not shared.
1264 void remove_unshareable_info() override;
1265 void remove_unshareable_flags();
1266 void remove_java_mirror() override;
1267 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1268 void init_shared_package_entry();
1269 bool can_be_verified_at_dumptime() const;
1270 void compute_has_loops_flag_for_methods();
1271 #endif
1272 bool has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
1273 void set_has_init_deps_processed() {
1274 assert(is_initialized(), "");
1275 assert(!has_init_deps_processed(), "already set"); // one-off action
1276 _misc_flags.set_has_init_deps_processed(true);
1277 }
1278
1279 u2 compute_modifier_flags() const override;
1280
1281 public:
1282 // JVMTI support
1283 jint jvmti_class_status() const override;
1284
1285 void metaspace_pointers_do(MetaspaceClosure* iter) override;
1286
1287 public:
1288 // Printing
1289 void print_on(outputStream* st) const override;
1290 void print_value_on(outputStream* st) const override;
1291
1292 void oop_print_value_on(oop obj, outputStream* st) override;
1293
1294 void oop_print_on (oop obj, outputStream* st) override { oop_print_on(obj, st, 0, 0); }
1295 void oop_print_on (oop obj, outputStream* st, int indent = 0, int base_offset = 0);
1296
1297 #ifndef PRODUCT
1298 void print_dependent_nmethods(bool verbose = false);
1299 bool is_dependent_nmethod(nmethod* nm);
1300 bool verify_itable_index(int index);
1301 #endif
1302
1303 const char* internal_name() const override;
1304
1305 // Verification
1306 void verify_on(outputStream* st) override;
1307
1308 void oop_verify_on(oop obj, outputStream* st) override;
1309
1310 // Logging
1311 void print_class_load_logging(ClassLoaderData* loader_data,
1312 const ModuleEntry* module_entry,
1313 const ClassFileStream* cfs) const;
1314 private:
1315 void print_class_load_cause_logging() const;
1316 void print_class_load_helper(ClassLoaderData* loader_data,
1317 const ModuleEntry* module_entry,
1318 const ClassFileStream* cfs) const;
1319 };
1320
1321 // for adding methods
1322 // UNSET_IDNUM return means no more ids available
1323 inline u2 InstanceKlass::next_method_idnum() {
1324 if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
1325 return ConstMethod::UNSET_IDNUM; // no more ids available
1326 } else {
1327 return _idnum_allocated_count++;
1328 }
1329 }
1330
1331 class PrintClassClosure : public KlassClosure {
1332 private:
1333 outputStream* _st;
1334 bool _verbose;
1335 public:
1336 PrintClassClosure(outputStream* st, bool verbose);
1337
1338 void do_klass(Klass* k);
1339 };
1340
1341 /* JNIid class for jfieldIDs only */
1342 class JNIid: public CHeapObj<mtClass> {
1343 friend class VMStructs;
1344 private:
1345 InstanceKlass* _holder;
1346 JNIid* _next;
1347 int _offset;
1348 #ifdef ASSERT
1349 bool _is_static_field_id;
1350 #endif
1351
1352 public:
1353 // Accessors
1354 InstanceKlass* holder() const { return _holder; }
1355 int offset() const { return _offset; }
1356 JNIid* next() { return _next; }
1357 // Constructor
1358 JNIid(InstanceKlass* holder, int offset, JNIid* next);
1359 // Identifier lookup
1360 JNIid* find(int offset);
1361
1362 bool find_local_field(fieldDescriptor* fd) {
1363 return InstanceKlass::cast(holder())->find_local_field_from_offset(offset(), true, fd);
1364 }
1365
1366 static void deallocate(JNIid* id);
1367 // Debugging
1368 #ifdef ASSERT
1369 bool is_static_field_id() const { return _is_static_field_id; }
1370 void set_is_static_field_id() { _is_static_field_id = true; }
1371 #endif
1372 void verify(InstanceKlass* holder);
1373 };
1374
1375 // An iterator that's used to access the inner classes indices in the
1376 // InstanceKlass::_inner_classes array.
1377 class InnerClassesIterator : public StackObj {
1378 private:
1379 Array<jushort>* _inner_classes;
1380 int _length;
1381 int _idx;
1382 public:
1383
1384 InnerClassesIterator(const InstanceKlass* k) {
1385 _inner_classes = k->inner_classes();
1386 if (k->inner_classes() != nullptr) {
1387 _length = _inner_classes->length();
1388 // The inner class array's length should be the multiple of
1389 // inner_class_next_offset if it only contains the InnerClasses
1390 // attribute data, or it should be
1391 // n*inner_class_next_offset+enclosing_method_attribute_size
1392 // if it also contains the EnclosingMethod data.
1393 assert((_length % InstanceKlass::inner_class_next_offset == 0 ||
1394 _length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size),
1395 "just checking");
1396 // Remove the enclosing_method portion if exists.
1397 if (_length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size) {
1398 _length -= InstanceKlass::enclosing_method_attribute_size;
1399 }
1400 } else {
1401 _length = 0;
1402 }
1403 _idx = 0;
1404 }
1405
1406 int length() const {
1407 return _length;
1408 }
1409
1410 void next() {
1411 _idx += InstanceKlass::inner_class_next_offset;
1412 }
1413
1414 bool done() const {
1415 return (_idx >= _length);
1416 }
1417
1418 u2 inner_class_info_index() const {
1419 return _inner_classes->at(
1420 _idx + InstanceKlass::inner_class_inner_class_info_offset);
1421 }
1422
1423 void set_inner_class_info_index(u2 index) {
1424 _inner_classes->at_put(
1425 _idx + InstanceKlass::inner_class_inner_class_info_offset, index);
1426 }
1427
1428 u2 outer_class_info_index() const {
1429 return _inner_classes->at(
1430 _idx + InstanceKlass::inner_class_outer_class_info_offset);
1431 }
1432
1433 void set_outer_class_info_index(u2 index) {
1434 _inner_classes->at_put(
1435 _idx + InstanceKlass::inner_class_outer_class_info_offset, index);
1436 }
1437
1438 u2 inner_name_index() const {
1439 return _inner_classes->at(
1440 _idx + InstanceKlass::inner_class_inner_name_offset);
1441 }
1442
1443 void set_inner_name_index(u2 index) {
1444 _inner_classes->at_put(
1445 _idx + InstanceKlass::inner_class_inner_name_offset, index);
1446 }
1447
1448 u2 inner_access_flags() const {
1449 return _inner_classes->at(
1450 _idx + InstanceKlass::inner_class_access_flags_offset);
1451 }
1452 };
1453
1454 // Iterator over class hierarchy under a particular class. Implements depth-first pre-order traversal.
1455 // Usage:
1456 // for (ClassHierarchyIterator iter(root_klass); !iter.done(); iter.next()) {
1457 // Klass* k = iter.klass();
1458 // ...
1459 // }
1460 class ClassHierarchyIterator : public StackObj {
1461 private:
1462 InstanceKlass* _root;
1463 Klass* _current;
1464 bool _visit_subclasses;
1465
1466 public:
1467 ClassHierarchyIterator(InstanceKlass* root) : _root(root), _current(root), _visit_subclasses(true) {
1468 assert(_root == _current, "required"); // initial state
1469 }
1470
1471 bool done() {
1472 return (_current == nullptr);
1473 }
1474
1475 // Make a step iterating over the class hierarchy under the root class.
1476 // Skips subclasses if requested.
1477 void next();
1478
1479 Klass* klass() {
1480 assert(!done(), "sanity");
1481 return _current;
1482 }
1483
1484 // Skip subclasses of the current class.
1485 void skip_subclasses() {
1486 _visit_subclasses = false;
1487 }
1488 };
1489
1490 #endif // SHARE_OOPS_INSTANCEKLASS_HPP