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