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