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