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 "memory/allocation.hpp"
29 #include "memory/referenceType.hpp"
30 #include "oops/annotations.hpp"
31 #include "oops/constMethod.hpp"
32 #include "oops/fieldInfo.hpp"
33 #include "oops/instanceKlassFlags.hpp"
34 #include "oops/instanceOop.hpp"
35 #include "runtime/handles.hpp"
36 #include "runtime/javaThread.hpp"
37 #include "utilities/accessFlags.hpp"
38 #include "utilities/align.hpp"
39 #include "utilities/growableArray.hpp"
40 #include "utilities/macros.hpp"
41 #if INCLUDE_JFR
42 #include "jfr/support/jfrKlassExtension.hpp"
43 #endif
44
45 class ConstantPool;
46 class DeoptimizationScope;
47 class klassItable;
48 class RecordComponent;
49
50 // An InstanceKlass is the VM level representation of a Java class.
51 // It contains all information needed for at class at execution runtime.
52
53 // InstanceKlass embedded field layout (after declared fields):
54 // [EMBEDDED Java vtable ] size in words = vtable_len
55 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
56 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
57 // indicating where oops are located in instances of this klass.
58 // [EMBEDDED implementor of the interface] only exist for interface
59
60
61 // forward declaration for class -- see below for definition
62 #if INCLUDE_JVMTI
63 class BreakpointInfo;
64 #endif
65 class ClassFileParser;
66 class ClassFileStream;
67 class KlassDepChange;
68 class DependencyContext;
69 class fieldDescriptor;
70 class JNIid;
71 class JvmtiCachedClassFieldMap;
72 class nmethodBucket;
73 class OopMapCache;
74 class InterpreterOopMap;
75 class PackageEntry;
76 class ModuleEntry;
77
78 // This is used in iterators below.
79 class FieldClosure: public StackObj {
80 public:
81 virtual void do_field(fieldDescriptor* fd) = 0;
82 };
83
84 // Print fields.
85 // If "obj" argument to constructor is null, prints static fields, otherwise prints non-static fields.
86 class FieldPrinter: public FieldClosure {
87 oop _obj;
88 outputStream* _st;
89 public:
90 FieldPrinter(outputStream* st, oop obj = nullptr) : _obj(obj), _st(st) {}
91 void do_field(fieldDescriptor* fd);
92 };
93
94 // Describes where oops are located in instances of this klass.
95 class OopMapBlock {
96 public:
97 // Byte offset of the first oop mapped by this block.
98 int offset() const { return _offset; }
99 void set_offset(int offset) { _offset = offset; }
100
101 // Number of oops in this block.
102 uint count() const { return _count; }
103 void set_count(uint count) { _count = count; }
104
105 void increment_count(int diff) { _count += diff; }
106
107 int offset_span() const { return _count * heapOopSize; }
108
109 int end_offset() const {
110 return offset() + offset_span();
114 return another_offset == end_offset();
115 }
116
117 // sizeof(OopMapBlock) in words.
118 static int size_in_words() {
119 return align_up((int)sizeof(OopMapBlock), wordSize) >>
120 LogBytesPerWord;
121 }
122
123 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
124 return a->offset() - b->offset();
125 }
126
127 private:
128 int _offset;
129 uint _count;
130 };
131
132 struct JvmtiCachedClassFileData;
133
134 class InstanceKlass: public Klass {
135 friend class VMStructs;
136 friend class JVMCIVMStructs;
137 friend class ClassFileParser;
138 friend class CompileReplay;
139
140 public:
141 static const KlassKind Kind = InstanceKlassKind;
142
143 protected:
144 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, ReferenceType reference_type = REF_NONE);
145
146 public:
147 InstanceKlass();
148
149 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
150 // of the class loading & initialization procedure, and the use of the states.
151 enum ClassState : u1 {
152 allocated, // allocated (but not yet linked)
153 loaded, // loaded and inserted in class hierarchy (but not linked yet)
154 linked, // successfully linked/verified (but not initialized yet)
155 being_initialized, // currently running class initializer
156 fully_initialized, // initialized (successful final state)
157 initialization_error // error happened during initialization
158 };
159
160 private:
161 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
162
163 protected:
164 // If you add a new field that points to any metaspace object, you
212 // Number of heapOopSize words used by non-static fields in this klass
213 // (including inherited fields but after header_size()).
214 int _nonstatic_field_size;
215 int _static_field_size; // number words used by static fields (oop and non-oop) in this klass
216 int _nonstatic_oop_map_size; // size in words of nonstatic oop map blocks
217 int _itable_len; // length of Java itable (in words)
218
219 // The NestHost attribute. The class info index for the class
220 // that is the nest-host of this class. This data has not been validated.
221 u2 _nest_host_index;
222 u2 _this_class_index; // constant pool entry
223 u2 _static_oop_field_count; // number of static oop fields in this klass
224
225 volatile u2 _idnum_allocated_count; // JNI/JVMTI: increments with the addition of methods, old ids don't change
226
227 // Class states are defined as ClassState (see above).
228 // Place the _init_state here to utilize the unused 2-byte after
229 // _idnum_allocated_count.
230 volatile ClassState _init_state; // state of class
231
232 u1 _reference_type; // reference type
233
234 AccessFlags _access_flags; // Access flags. The class/interface distinction is stored here.
235
236 // State is set either at parse time or while executing, atomically to not disturb other state
237 InstanceKlassFlags _misc_flags;
238
239 JavaThread* volatile _init_thread; // Pointer to current thread doing initialization (to handle recursive initialization)
240
241 OopMapCache* volatile _oop_map_cache; // OopMapCache for all methods in the klass (allocated lazily)
242 JNIid* _jni_ids; // First JNI identifier for static fields in this class
243 jmethodID* volatile _methods_jmethod_ids; // jmethodIDs corresponding to method_idnum, or null if none
244 nmethodBucket* volatile _dep_context; // packed DependencyContext structure
245 uint64_t volatile _dep_context_last_cleaned;
246 nmethod* _osr_nmethods_head; // Head of list of on-stack replacement nmethods for this class
247 #if INCLUDE_JVMTI
248 BreakpointInfo* _breakpoints; // bpt lists, managed by Method*
249 // Linked instanceKlasses of previous versions
250 InstanceKlass* _previous_versions;
251 // JVMTI fields can be moved to their own structure - see 6315920
252 // JVMTI: cached class file, before retransformable agent modified it in CFLH
262
263 // Method array.
264 Array<Method*>* _methods;
265 // Default Method Array, concrete methods inherited from interfaces
266 Array<Method*>* _default_methods;
267 // Interfaces (InstanceKlass*s) this class declares locally to implement.
268 Array<InstanceKlass*>* _local_interfaces;
269 // Interfaces (InstanceKlass*s) this class implements transitively.
270 Array<InstanceKlass*>* _transitive_interfaces;
271 // Int array containing the original order of method in the class file (for JVMTI).
272 Array<int>* _method_ordering;
273 // Int array containing the vtable_indices for default_methods
274 // offset matches _default_methods offset
275 Array<int>* _default_vtable_indices;
276
277 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
278 Array<u1>* _fieldinfo_stream;
279 Array<u1>* _fieldinfo_search_table;
280 Array<FieldStatus>* _fields_status;
281
282 // embedded Java vtable follows here
283 // embedded Java itables follows here
284 // embedded static fields follows here
285 // embedded nonstatic oop-map blocks follows here
286 // embedded implementor of this interface follows here
287 // The embedded implementor only exists if the current klass is an
288 // interface. The possible values of the implementor fall into following
289 // three cases:
290 // null: no implementor.
291 // A Klass* that's not itself: one implementor.
292 // Itself: more than one implementors.
293 //
294
295 friend class SystemDictionary;
296
297 static bool _disable_method_binary_search;
298
299 // Controls finalizer registration
300 static bool _finalization_enabled;
301
302 public:
303
304 // Queries finalization state
305 static bool is_finalization_enabled() { return _finalization_enabled; }
306
307 // Sets finalization state
308 static void set_finalization_enabled(bool val) { _finalization_enabled = val; }
309
310 // Access flags
311 AccessFlags access_flags() const { return _access_flags; }
312 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
313
314 bool is_public() const { return _access_flags.is_public(); }
315 bool is_final() const { return _access_flags.is_final(); }
316 bool is_interface() const override { return _access_flags.is_interface(); }
317 bool is_abstract() const override { return _access_flags.is_abstract(); }
318 bool is_super() const { return _access_flags.is_super(); }
319 bool is_synthetic() const { return _access_flags.is_synthetic(); }
320 void set_is_synthetic() { _access_flags.set_is_synthetic(); }
321
322 static ByteSize access_flags_offset() { return byte_offset_of(InstanceKlass, _access_flags); }
323
324 void set_is_cloneable();
325
326 // Quick checks for the loader that defined this class (without switching on this->class_loader())
327 bool defined_by_boot_loader() const { return _misc_flags.defined_by_boot_loader(); }
328 bool defined_by_platform_loader() const { return _misc_flags.defined_by_platform_loader(); }
329 bool defined_by_app_loader() const { return _misc_flags.defined_by_app_loader(); }
330 bool defined_by_other_loaders() const { return _misc_flags.defined_by_other_loaders(); }
331 void set_class_loader_type() { _misc_flags.set_class_loader_type(_class_loader_data); }
332
333 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
334
335 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
336
337 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
338 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
339
340 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
341 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
342
343 // field sizes
344 int nonstatic_field_size() const { return _nonstatic_field_size; }
345 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
346
347 int static_field_size() const { return _static_field_size; }
348 void set_static_field_size(int size) { _static_field_size = size; }
349
350 int static_oop_field_count() const { return (int)_static_oop_field_count; }
351 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
352
353 bool trust_final_fields() { return _misc_flags.trust_final_fields(); }
354 void set_trust_final_fields(bool value) { _misc_flags.set_trust_final_fields(value); }
355
356 // Java itable
357 int itable_length() const { return _itable_len; }
358 void set_itable_length(int len) { _itable_len = len; }
359
360 // array klasses
361 ObjArrayKlass* array_klasses() const { return _array_klasses; }
362 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
390 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
391 _local_interfaces = a; }
392
393 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
394 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
395 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
396 _transitive_interfaces = a;
397 }
398
399 private:
400 friend class fieldDescriptor;
401 FieldInfo field(int index) const;
402
403 public:
404 int field_offset (int index) const { return field(index).offset(); }
405 int field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
406 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
407 FieldStatus field_status(int index) const { return fields_status()->at(index); }
408 inline Symbol* field_name (int index) const;
409 inline Symbol* field_signature (int index) const;
410
411 // Number of Java declared fields
412 int java_fields_count() const;
413 int total_fields_count() const;
414
415 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
416 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
417
418 Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
419 void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }
420
421 Array<FieldStatus>* fields_status() const {return _fields_status; }
422 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
423
424 // inner classes
425 Array<u2>* inner_classes() const { return _inner_classes; }
426 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
427
428 // nest members
429 Array<u2>* nest_members() const { return _nest_members; }
430 void set_nest_members(Array<u2>* m) { _nest_members = m; }
431
432 // nest-host index
433 jushort nest_host_index() const { return _nest_host_index; }
434 void set_nest_host_index(u2 i) { _nest_host_index = i; }
435 // dynamic nest member support
436 void set_nest_host(InstanceKlass* host);
437
438 // record components
439 Array<RecordComponent*>* record_components() const { return _record_components; }
440 void set_record_components(Array<RecordComponent*>* record_components) {
441 _record_components = record_components;
442 }
443 bool is_record() const;
499 bool in_javabase_module() const;
500 bool in_unnamed_package() const { return (_package_entry == nullptr); }
501 void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
502 // If the package for the InstanceKlass is in the boot loader's package entry
503 // table then sets the classpath_index field so that
504 // get_system_package() will know to return a non-null value for the
505 // package's location. And, so that the package will be added to the list of
506 // packages returned by get_system_packages().
507 // For packages whose classes are loaded from the boot loader class path, the
508 // classpath_index indicates which entry on the boot loader class path.
509 void set_classpath_index(s2 path_index);
510 bool is_same_class_package(const Klass* class2) const;
511 bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
512
513 // find an enclosing class
514 InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
515
516 // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
517 bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
518
519 private:
520 // Check prohibited package ("java/" only loadable by boot or platform loaders)
521 static void check_prohibited_package(Symbol* class_name,
522 ClassLoaderData* loader_data,
523 TRAPS);
524
525 JavaThread* init_thread() { return AtomicAccess::load(&_init_thread); }
526 const char* init_thread_name() {
527 return init_thread()->name_raw();
528 }
529
530 public:
531 // initialization state
532 bool is_loaded() const { return init_state() >= loaded; }
533 bool is_linked() const { return init_state() >= linked; }
534 bool is_initialized() const { return init_state() == fully_initialized; }
535 bool is_not_initialized() const { return init_state() < being_initialized; }
536 bool is_being_initialized() const { return init_state() == being_initialized; }
537 bool is_in_error_state() const { return init_state() == initialization_error; }
538 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
539 ClassState init_state() const { return AtomicAccess::load_acquire(&_init_state); }
540 const char* init_state_name() const;
541 bool is_rewritten() const { return _misc_flags.rewritten(); }
542
543 // is this a sealed class
544 bool is_sealed() const;
545
546 // defineClass specified verification
547 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
548 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
549
550 // marking
551 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
552 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
553
554 // initialization (virtuals from Klass)
555 bool should_be_initialized() const override; // means that initialize should be called
556 void initialize_with_aot_initialized_mirror(bool early_init, TRAPS);
557 void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
558 void initialize(TRAPS) override;
559 void initialize_preemptable(TRAPS) override;
560 void link_class(TRAPS);
561 bool link_class_or_fail(TRAPS); // returns false on failure
562 void rewrite_class(TRAPS);
563 void link_methods(TRAPS);
564 Method* class_initializer() const;
565 bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;
566
567 // reference type
568 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
569
570 // this class cp index
571 u2 this_class_index() const { return _this_class_index; }
572 void set_this_class_index(u2 index) { _this_class_index = index; }
573
574 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
575
576 // find local field, returns true if found
577 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
578 // find field in direct superinterfaces, returns the interface in which the field is defined
579 Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
580 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
581 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
582 // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
583 Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;
584
585 // find a non-static or static field given its offset within the class.
586 bool contains_field_offset(int offset);
587
588 bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
589 bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
590
591 private:
592 inline static int quick_search(const Array<Method*>* methods, const Symbol* name);
593
594 public:
595 static void disable_method_binary_search() {
596 _disable_method_binary_search = true;
597 }
598
599 // find a local method (returns null if not found)
600 Method* find_method(const Symbol* name, const Symbol* signature) const;
601 static Method* find_method(const Array<Method*>* methods,
602 const Symbol* name,
603 const Symbol* signature);
604
605 // find a local method, but skip static methods
606 Method* find_instance_method(const Symbol* name, const Symbol* signature,
607 PrivateLookupMode private_mode) const;
608 static Method* find_instance_method(const Array<Method*>* methods,
609 const Symbol* name,
610 const Symbol* signature,
662 // protection domain
663 oop protection_domain() const override;
664
665 // signers
666 objArrayOop signers() const;
667
668 bool is_contended() const { return _misc_flags.is_contended(); }
669 void set_is_contended(bool value) { _misc_flags.set_is_contended(value); }
670
671 // source file name
672 Symbol* source_file_name() const;
673 u2 source_file_name_index() const;
674 void set_source_file_name_index(u2 sourcefile_index);
675
676 // minor and major version numbers of class file
677 u2 minor_version() const;
678 void set_minor_version(u2 minor_version);
679 u2 major_version() const;
680 void set_major_version(u2 major_version);
681
682 // source debug extension
683 const char* source_debug_extension() const { return _source_debug_extension; }
684 void set_source_debug_extension(const char* array, int length);
685
686 // nonstatic oop-map blocks
687 static int nonstatic_oop_map_size(unsigned int oop_map_count) {
688 return oop_map_count * OopMapBlock::size_in_words();
689 }
690 unsigned int nonstatic_oop_map_count() const {
691 return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
692 }
693 int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
694 void set_nonstatic_oop_map_size(int words) {
695 _nonstatic_oop_map_size = words;
696 }
697
698 bool has_contended_annotations() const { return _misc_flags.has_contended_annotations(); }
699 void set_has_contended_annotations(bool value) { _misc_flags.set_has_contended_annotations(value); }
700
701 #if INCLUDE_JVMTI
768 }
769 JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)nullptr; }
770
771 #endif // INCLUDE_JVMTI
772
773 bool has_nonstatic_concrete_methods() const { return _misc_flags.has_nonstatic_concrete_methods(); }
774 void set_has_nonstatic_concrete_methods(bool b) { _misc_flags.set_has_nonstatic_concrete_methods(b); }
775
776 bool declares_nonstatic_concrete_methods() const { return _misc_flags.declares_nonstatic_concrete_methods(); }
777 void set_declares_nonstatic_concrete_methods(bool b) { _misc_flags.set_declares_nonstatic_concrete_methods(b); }
778
779 bool has_miranda_methods () const { return _misc_flags.has_miranda_methods(); }
780 void set_has_miranda_methods() { _misc_flags.set_has_miranda_methods(true); }
781 bool has_final_method() const { return _misc_flags.has_final_method(); }
782 void set_has_final_method() { _misc_flags.set_has_final_method(true); }
783
784 // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
785 inline u2 next_method_idnum();
786 void set_initial_method_idnum(u2 value) { _idnum_allocated_count = value; }
787
788 // generics support
789 Symbol* generic_signature() const;
790 u2 generic_signature_index() const;
791 void set_generic_signature_index(u2 sig_index);
792
793 u2 enclosing_method_data(int offset) const;
794 u2 enclosing_method_class_index() const {
795 return enclosing_method_data(enclosing_method_class_index_offset);
796 }
797 u2 enclosing_method_method_index() {
798 return enclosing_method_data(enclosing_method_method_index_offset);
799 }
800 void set_enclosing_method_indices(u2 class_index,
801 u2 method_index);
802
803 // jmethodID support
804 jmethodID get_jmethod_id(Method* method);
805 void make_methods_jmethod_ids();
806 jmethodID jmethod_id_or_null(Method* method);
807 void update_methods_jmethod_cache();
861
862 // On-stack replacement support
863 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
864 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
865 void add_osr_nmethod(nmethod* n);
866 bool remove_osr_nmethod(nmethod* n);
867 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
868 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
869
870 #if INCLUDE_JVMTI
871 // Breakpoint support (see methods on Method* for details)
872 BreakpointInfo* breakpoints() const { return _breakpoints; };
873 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
874 #endif
875
876 // support for stub routines
877 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
878 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
879 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
880
881 // subclass/subinterface checks
882 bool implements_interface(Klass* k) const;
883 bool is_same_or_direct_interface(Klass* k) const;
884
885 #ifdef ASSERT
886 // check whether this class or one of its superclasses was redefined
887 bool has_redefined_this_or_super() const;
888 #endif
889
890 // Access to the implementor of an interface.
891 InstanceKlass* implementor() const;
892 void set_implementor(InstanceKlass* ik);
893 int nof_implementors() const;
894 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
895 void init_implementor(); // initialize
896
897 private:
898 // link this class into the implementors list of every interface it implements
899 void process_interfaces();
900
901 public:
902 // virtual operations from Klass
903 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
904 Array<InstanceKlass*>* transitive_interfaces) override;
905 bool can_be_primary_super_slow() const override;
906 size_t oop_size(oop obj) const override { return size_helper(); }
907 // slow because it's a virtual call and used for verifying the layout_helper.
908 // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
909 DEBUG_ONLY(bool is_instance_klass_slow() const override { return true; })
910
911 // Iterators
912 void do_local_static_fields(FieldClosure* cl);
913 void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
914 void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
915 void print_nonstatic_fields(FieldClosure* cl); // including inherited and injected fields
916
917 void methods_do(void f(Method* method));
918
919 static InstanceKlass* cast(Klass* k) {
920 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
921 }
922
923 static const InstanceKlass* cast(const Klass* k) {
924 assert(k != nullptr, "k should not be null");
925 assert(k->is_instance_klass(), "cast to InstanceKlass");
926 return static_cast<const InstanceKlass*>(k);
927 }
928
929 // This hides Klass::super(). The _super of an InstanceKlass is
930 // always an InstanceKlass (or nullptr)
931 InstanceKlass* super() const {
932 return (Klass::super() == nullptr) ? nullptr : InstanceKlass::cast(Klass::super());
933 }
934
935 InstanceKlass* java_super() const override {
936 return InstanceKlass::super();
937 }
938
939 // Sizing (in words)
940 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
941
942 static int size(int vtable_length, int itable_length,
943 int nonstatic_oop_map_size,
944 bool is_interface) {
945 return align_metadata_size(header_size() +
946 vtable_length +
947 itable_length +
948 nonstatic_oop_map_size +
949 (is_interface ? (int)sizeof(Klass*)/wordSize : 0));
950 }
951
952 int size() const override { return size(vtable_length(),
953 itable_length(),
954 nonstatic_oop_map_size(),
955 is_interface());
956 }
957
958
959 inline intptr_t* start_of_itable() const;
960 inline intptr_t* end_of_itable() const;
961 inline oop static_field_base_raw();
962
963 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
964 inline Klass** end_of_nonstatic_oop_maps() const;
965
966 inline InstanceKlass* volatile* adr_implementor() const;
967
968 // Use this to return the size of an instance in heap words:
969 int size_helper() const {
970 return layout_helper_to_size_helper(layout_helper());
971 }
972
973 // This bit is initialized in classFileParser.cpp.
974 // It is false under any of the following conditions:
975 // - the class is abstract (including any interface)
976 // - the class size is larger than FastAllocateSizeLimit
977 // - the class is java/lang/Class, which cannot be allocated directly
978 bool can_be_fastpath_allocated() const {
979 return !layout_helper_needs_slow_path(layout_helper());
980 }
981
982 // Java itable
983 klassItable itable() const; // return klassItable wrapper
984 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
985 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
986 int vtable_index_of_interface_method(Method* method);
987
1000 // instanceKlasses and the metadata they point to.
1001 void deallocate_contents(ClassLoaderData* loader_data);
1002 static void deallocate_methods(ClassLoaderData* loader_data,
1003 Array<Method*>* methods);
1004 void static deallocate_interfaces(ClassLoaderData* loader_data,
1005 const InstanceKlass* super_klass,
1006 Array<InstanceKlass*>* local_interfaces,
1007 Array<InstanceKlass*>* transitive_interfaces);
1008 void static deallocate_record_components(ClassLoaderData* loader_data,
1009 Array<RecordComponent*>* record_component);
1010
1011 bool on_stack() const override;
1012
1013 // callbacks for actions during class unloading
1014 static void unload_class(InstanceKlass* ik);
1015
1016 void release_C_heap_structures(bool release_sub_metadata = true) override;
1017
1018 // Naming
1019 const char* signature_name() const override;
1020
1021 // Oop fields (and metadata) iterators
1022 //
1023 // The InstanceKlass iterators also visits the Object's klass.
1024
1025 // Forward iteration
1026 public:
1027 // Iterate over all oop fields in the oop maps.
1028 template <typename T, class OopClosureType>
1029 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1030
1031 // Iterate over all oop fields and metadata.
1032 template <typename T, class OopClosureType>
1033 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1034
1035 // Iterate over all oop fields in one oop map.
1036 template <typename T, class OopClosureType>
1037 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1038
1039
1123
1124 static Method* find_method_impl(const Array<Method*>* methods,
1125 const Symbol* name,
1126 const Symbol* signature,
1127 OverpassLookupMode overpass_mode,
1128 StaticLookupMode static_mode,
1129 PrivateLookupMode private_mode);
1130
1131 #if INCLUDE_JVMTI
1132 // RedefineClasses support
1133 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1134 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1135 #endif
1136 public:
1137
1138 #if INCLUDE_CDS
1139 // CDS support - remove and restore oops from metadata. Oops are not shared.
1140 void remove_unshareable_info() override;
1141 void remove_unshareable_flags();
1142 void remove_java_mirror() override;
1143 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1144 void init_shared_package_entry();
1145 bool can_be_verified_at_dumptime() const;
1146 void compute_has_loops_flag_for_methods();
1147 #endif
1148 bool has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
1149 void set_has_init_deps_processed() {
1150 assert(is_initialized(), "");
1151 assert(!has_init_deps_processed(), "already set"); // one-off action
1152 _misc_flags.set_has_init_deps_processed(true);
1153 }
1154
1155 u2 compute_modifier_flags() const override;
1156
1157 public:
1158 // JVMTI support
1159 jint jvmti_class_status() const override;
1160
1161 void metaspace_pointers_do(MetaspaceClosure* iter) override;
1162
1163 public:
1164 // Printing
1165 void print_on(outputStream* st) const override;
1166 void print_value_on(outputStream* st) const override;
1167
1168 void oop_print_value_on(oop obj, outputStream* st) override;
1169
1170 void oop_print_on (oop obj, outputStream* st) override;
1171
1172 #ifndef PRODUCT
1173 void print_dependent_nmethods(bool verbose = false);
1174 bool is_dependent_nmethod(nmethod* nm);
1175 bool verify_itable_index(int index);
1176 #endif
1177
1178 const char* internal_name() const override;
1179
1180 // Verification
1181 void verify_on(outputStream* st) override;
1182
1183 void oop_verify_on(oop obj, outputStream* st) override;
1184
1185 // Logging
1186 void print_class_load_logging(ClassLoaderData* loader_data,
1187 const ModuleEntry* module_entry,
1188 const ClassFileStream* cfs) const;
1189 private:
1190 void print_class_load_cause_logging() const;
1191 void print_class_load_helper(ClassLoaderData* loader_data,
1192 const ModuleEntry* module_entry,
1193 const ClassFileStream* cfs) const;
1194 };
1195
1196 // for adding methods
1197 // UNSET_IDNUM return means no more ids available
1198 inline u2 InstanceKlass::next_method_idnum() {
1199 if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
|
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_OOPS_INSTANCEKLASS_HPP
26 #define SHARE_OOPS_INSTANCEKLASS_HPP
27
28 #include "code/vmreg.hpp"
29 #include "memory/allocation.hpp"
30 #include "memory/referenceType.hpp"
31 #include "oops/annotations.hpp"
32 #include "oops/arrayKlass.hpp"
33 #include "oops/constMethod.hpp"
34 #include "oops/fieldInfo.hpp"
35 #include "oops/instanceKlassFlags.hpp"
36 #include "oops/instanceOop.hpp"
37 #include "oops/refArrayKlass.hpp"
38 #include "runtime/handles.hpp"
39 #include "runtime/javaThread.hpp"
40 #include "utilities/accessFlags.hpp"
41 #include "utilities/align.hpp"
42 #include "utilities/growableArray.hpp"
43 #include "utilities/macros.hpp"
44 #if INCLUDE_JFR
45 #include "jfr/support/jfrKlassExtension.hpp"
46 #endif
47
48 class ConstantPool;
49 class DeoptimizationScope;
50 class klassItable;
51 class RecordComponent;
52
53 // An InstanceKlass is the VM level representation of a Java class.
54 // It contains all information needed for at class at execution runtime.
55
56 // InstanceKlass embedded field layout (after declared fields):
57 // [EMBEDDED Java vtable ] size in words = vtable_len
58 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
59 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
60 // indicating where oops are located in instances of this klass.
61 // [EMBEDDED implementor of the interface] only exist for interface
62 // [EMBEDDED InlineKlass::Members] only if is an InlineKlass instance
63
64
65 // forward declaration for class -- see below for definition
66 #if INCLUDE_JVMTI
67 class BreakpointInfo;
68 #endif
69 class ClassFileParser;
70 class ClassFileStream;
71 class KlassDepChange;
72 class DependencyContext;
73 class fieldDescriptor;
74 class JNIid;
75 class JvmtiCachedClassFieldMap;
76 class nmethodBucket;
77 class OopMapCache;
78 class BufferedInlineTypeBlob;
79 class InterpreterOopMap;
80 class PackageEntry;
81 class ModuleEntry;
82
83 // This is used in iterators below.
84 class FieldClosure: public StackObj {
85 public:
86 virtual void do_field(fieldDescriptor* fd) = 0;
87 };
88
89 // Print fields.
90 // If "obj" argument to constructor is null, prints fields as if they are static fields,
91 // otherwise prints non-static fields. It is possible to print non-static fields the same
92 // way as static fields when no oops are available, such as when debug printing classes.
93 class FieldPrinter: public FieldClosure {
94 oop _obj;
95 outputStream* _st;
96 int _indent;
97 int _base_offset;
98 public:
99 FieldPrinter(outputStream* st, oop obj = nullptr, int indent = 0, int base_offset = 0) :
100 _obj(obj), _st(st), _indent(indent), _base_offset(base_offset) {}
101 void do_field(fieldDescriptor* fd);
102 };
103
104 // Describes where oops are located in instances of this klass.
105 class OopMapBlock {
106 public:
107 // Byte offset of the first oop mapped by this block.
108 int offset() const { return _offset; }
109 void set_offset(int offset) { _offset = offset; }
110
111 // Number of oops in this block.
112 uint count() const { return _count; }
113 void set_count(uint count) { _count = count; }
114
115 void increment_count(int diff) { _count += diff; }
116
117 int offset_span() const { return _count * heapOopSize; }
118
119 int end_offset() const {
120 return offset() + offset_span();
124 return another_offset == end_offset();
125 }
126
127 // sizeof(OopMapBlock) in words.
128 static int size_in_words() {
129 return align_up((int)sizeof(OopMapBlock), wordSize) >>
130 LogBytesPerWord;
131 }
132
133 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
134 return a->offset() - b->offset();
135 }
136
137 private:
138 int _offset;
139 uint _count;
140 };
141
142 struct JvmtiCachedClassFileData;
143
144 class InlineLayoutInfo : public MetaspaceObj {
145 InlineKlass* _klass;
146 LayoutKind _kind;
147 int _null_marker_offset; // null marker offset for this field, relative to the beginning of the current container
148
149 public:
150 InlineLayoutInfo(): _klass(nullptr), _kind(LayoutKind::UNKNOWN), _null_marker_offset(-1) {}
151 InlineLayoutInfo(InlineKlass* ik, LayoutKind kind, int size, int nm_offset):
152 _klass(ik), _kind(kind), _null_marker_offset(nm_offset) {}
153
154 InlineKlass* klass() const { return _klass; }
155 void set_klass(InlineKlass* k) { _klass = k; }
156
157 LayoutKind kind() const {
158 assert(_kind != LayoutKind::UNKNOWN, "Not set");
159 return _kind;
160 }
161 void set_kind(LayoutKind lk) { _kind = lk; }
162
163 int null_marker_offset() const {
164 assert(_null_marker_offset != -1, "Not set");
165 return _null_marker_offset;
166 }
167 void set_null_marker_offset(int o) { _null_marker_offset = o; }
168
169 void metaspace_pointers_do(MetaspaceClosure* it);
170 MetaspaceObj::Type type() const { return InlineLayoutInfoType; }
171
172 static ByteSize klass_offset() { return byte_offset_of(InlineLayoutInfo, _klass); }
173 static ByteSize null_marker_offset_offset() { return byte_offset_of(InlineLayoutInfo, _null_marker_offset); }
174
175 // Print
176 void print() const;
177 void print_on(outputStream* st) const;
178 };
179
180 class InstanceKlass: public Klass {
181 friend class VMStructs;
182 friend class JVMCIVMStructs;
183 friend class ClassFileParser;
184 friend class CompileReplay;
185 friend class TemplateTable;
186
187 public:
188 static const KlassKind Kind = InstanceKlassKind;
189
190 protected:
191 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, markWord prototype = markWord::prototype(), ReferenceType reference_type = REF_NONE);
192
193 public:
194 InstanceKlass();
195
196 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
197 // of the class loading & initialization procedure, and the use of the states.
198 enum ClassState : u1 {
199 allocated, // allocated (but not yet linked)
200 loaded, // loaded and inserted in class hierarchy (but not linked yet)
201 linked, // successfully linked/verified (but not initialized yet)
202 being_initialized, // currently running class initializer
203 fully_initialized, // initialized (successful final state)
204 initialization_error // error happened during initialization
205 };
206
207 private:
208 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
209
210 protected:
211 // If you add a new field that points to any metaspace object, you
259 // Number of heapOopSize words used by non-static fields in this klass
260 // (including inherited fields but after header_size()).
261 int _nonstatic_field_size;
262 int _static_field_size; // number words used by static fields (oop and non-oop) in this klass
263 int _nonstatic_oop_map_size; // size in words of nonstatic oop map blocks
264 int _itable_len; // length of Java itable (in words)
265
266 // The NestHost attribute. The class info index for the class
267 // that is the nest-host of this class. This data has not been validated.
268 u2 _nest_host_index;
269 u2 _this_class_index; // constant pool entry
270 u2 _static_oop_field_count; // number of static oop fields in this klass
271
272 volatile u2 _idnum_allocated_count; // JNI/JVMTI: increments with the addition of methods, old ids don't change
273
274 // Class states are defined as ClassState (see above).
275 // Place the _init_state here to utilize the unused 2-byte after
276 // _idnum_allocated_count.
277 volatile ClassState _init_state; // state of class
278
279 u1 _reference_type; // reference type
280 int _acmp_maps_offset; // offset to injected static field storing .acmp_maps for values classes
281 // unfortunately, abstract values need one too so it cannot be stored in
282 // the InlineKlass::Members that only exist for InlineKlass.
283
284 AccessFlags _access_flags; // Access flags. The class/interface distinction is stored here.
285
286 // State is set either at parse time or while executing, atomically to not disturb other state
287 InstanceKlassFlags _misc_flags;
288
289 JavaThread* volatile _init_thread; // Pointer to current thread doing initialization (to handle recursive initialization)
290
291 OopMapCache* volatile _oop_map_cache; // OopMapCache for all methods in the klass (allocated lazily)
292 JNIid* _jni_ids; // First JNI identifier for static fields in this class
293 jmethodID* volatile _methods_jmethod_ids; // jmethodIDs corresponding to method_idnum, or null if none
294 nmethodBucket* volatile _dep_context; // packed DependencyContext structure
295 uint64_t volatile _dep_context_last_cleaned;
296 nmethod* _osr_nmethods_head; // Head of list of on-stack replacement nmethods for this class
297 #if INCLUDE_JVMTI
298 BreakpointInfo* _breakpoints; // bpt lists, managed by Method*
299 // Linked instanceKlasses of previous versions
300 InstanceKlass* _previous_versions;
301 // JVMTI fields can be moved to their own structure - see 6315920
302 // JVMTI: cached class file, before retransformable agent modified it in CFLH
312
313 // Method array.
314 Array<Method*>* _methods;
315 // Default Method Array, concrete methods inherited from interfaces
316 Array<Method*>* _default_methods;
317 // Interfaces (InstanceKlass*s) this class declares locally to implement.
318 Array<InstanceKlass*>* _local_interfaces;
319 // Interfaces (InstanceKlass*s) this class implements transitively.
320 Array<InstanceKlass*>* _transitive_interfaces;
321 // Int array containing the original order of method in the class file (for JVMTI).
322 Array<int>* _method_ordering;
323 // Int array containing the vtable_indices for default_methods
324 // offset matches _default_methods offset
325 Array<int>* _default_vtable_indices;
326
327 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
328 Array<u1>* _fieldinfo_stream;
329 Array<u1>* _fieldinfo_search_table;
330 Array<FieldStatus>* _fields_status;
331
332 Array<InlineLayoutInfo>* _inline_layout_info_array;
333 Array<u2>* _loadable_descriptors;
334 Array<int>* _acmp_maps_array; // Metadata copy of the acmp_maps oop used in value classes.
335 // When loading an inline klass from the CDS/AOT archive
336 // this copy can be used to regenerate the ".acmp_maps" oop
337 // if it is not stored in the archive.
338
339 // Located here because sub-klasses can't have their own C++ fields
340 address _adr_inline_klass_members;
341
342 // embedded Java vtable follows here
343 // embedded Java itables follows here
344 // embedded static fields follows here
345 // embedded nonstatic oop-map blocks follows here
346 // embedded implementor of this interface follows here
347 // The embedded implementor only exists if the current klass is an
348 // interface. The possible values of the implementor fall into following
349 // three cases:
350 // null: no implementor.
351 // A Klass* that's not itself: one implementor.
352 // Itself: more than one implementors.
353 //
354
355 friend class SystemDictionary;
356
357 static bool _disable_method_binary_search;
358
359 // Controls finalizer registration
360 static bool _finalization_enabled;
361
362 public:
363
364 // Queries finalization state
365 static bool is_finalization_enabled() { return _finalization_enabled; }
366
367 // Sets finalization state
368 static void set_finalization_enabled(bool val) { _finalization_enabled = val; }
369
370 // Access flags
371 AccessFlags access_flags() const { return _access_flags; }
372 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
373
374 bool is_public() const { return _access_flags.is_public(); }
375 bool is_final() const { return _access_flags.is_final(); }
376 bool is_interface() const override { return _access_flags.is_interface(); }
377 bool is_abstract() const override { return _access_flags.is_abstract(); }
378 bool is_synthetic() const { return _access_flags.is_synthetic(); }
379 void set_is_synthetic() { _access_flags.set_is_synthetic(); }
380 bool is_identity_class() const override { return _access_flags.is_identity_class(); }
381
382 static ByteSize access_flags_offset() { return byte_offset_of(InstanceKlass, _access_flags); }
383
384 void set_is_cloneable();
385
386 // Quick checks for the loader that defined this class (without switching on this->class_loader())
387 bool defined_by_boot_loader() const { return _misc_flags.defined_by_boot_loader(); }
388 bool defined_by_platform_loader() const { return _misc_flags.defined_by_platform_loader(); }
389 bool defined_by_app_loader() const { return _misc_flags.defined_by_app_loader(); }
390 bool defined_by_other_loaders() const { return _misc_flags.defined_by_other_loaders(); }
391 void set_class_loader_type() { _misc_flags.set_class_loader_type(_class_loader_data); }
392
393 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
394
395 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
396
397 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
398 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
399
400 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
401 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
402
403 bool has_inlined_fields() const { return _misc_flags.has_inlined_fields(); }
404 void set_has_inlined_fields() { _misc_flags.set_has_inlined_fields(true); }
405
406 bool is_naturally_atomic(bool null_free) const;
407 void set_is_naturally_atomic() { _misc_flags.set_is_naturally_atomic(true); }
408
409 // Query if this class has atomicity requirements (default is yes)
410 // This bit can occur anywhere, but is only significant
411 // for inline classes *and* their super types.
412 // It inherits from supers.
413 // Its value depends on the ForceNonTearable VM option, the LooselyConsistentValue annotation
414 // and the presence of flat fields with atomicity requirements
415 bool must_be_atomic() const { return _misc_flags.must_be_atomic(); }
416 void set_must_be_atomic() { _misc_flags.set_must_be_atomic(true); }
417
418 // field sizes
419 int nonstatic_field_size() const { return _nonstatic_field_size; }
420 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
421
422 int static_field_size() const { return _static_field_size; }
423 void set_static_field_size(int size) { _static_field_size = size; }
424
425 int static_oop_field_count() const { return (int)_static_oop_field_count; }
426 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
427
428 bool trust_final_fields() { return _misc_flags.trust_final_fields(); }
429 void set_trust_final_fields(bool value) { _misc_flags.set_trust_final_fields(value); }
430
431 // Java itable
432 int itable_length() const { return _itable_len; }
433 void set_itable_length(int len) { _itable_len = len; }
434
435 // array klasses
436 ObjArrayKlass* array_klasses() const { return _array_klasses; }
437 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
465 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
466 _local_interfaces = a; }
467
468 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
469 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
470 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
471 _transitive_interfaces = a;
472 }
473
474 private:
475 friend class fieldDescriptor;
476 FieldInfo field(int index) const;
477
478 public:
479 int field_offset (int index) const { return field(index).offset(); }
480 int field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
481 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
482 FieldStatus field_status(int index) const { return fields_status()->at(index); }
483 inline Symbol* field_name (int index) const;
484 inline Symbol* field_signature (int index) const;
485 bool field_is_flat(int index) const { return field_flags(index).is_flat(); }
486 bool field_has_null_marker(int index) const { return field_flags(index).has_null_marker(); }
487 bool field_is_null_free_inline_type(int index) const;
488 bool is_class_in_loadable_descriptors_attribute(Symbol* name) const;
489
490 int field_null_marker_offset(int index) const { return inline_layout_info(index).null_marker_offset(); }
491
492 // Number of Java declared fields
493 int java_fields_count() const;
494 int total_fields_count() const;
495
496 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
497 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
498
499 Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
500 void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }
501
502 Array<FieldStatus>* fields_status() const {return _fields_status; }
503 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
504
505 Array<u2>* loadable_descriptors() const { return _loadable_descriptors; }
506 void set_loadable_descriptors(Array<u2>* c) { _loadable_descriptors = c; }
507
508 Array<int>* acmp_maps_array() const { return _acmp_maps_array; }
509 void set_acmp_maps_array(Array<int>* array) { _acmp_maps_array = array; }
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;
586 bool in_javabase_module() const;
587 bool in_unnamed_package() const { return (_package_entry == nullptr); }
588 void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
589 // If the package for the InstanceKlass is in the boot loader's package entry
590 // table then sets the classpath_index field so that
591 // get_system_package() will know to return a non-null value for the
592 // package's location. And, so that the package will be added to the list of
593 // packages returned by get_system_packages().
594 // For packages whose classes are loaded from the boot loader class path, the
595 // classpath_index indicates which entry on the boot loader class path.
596 void set_classpath_index(s2 path_index);
597 bool is_same_class_package(const Klass* class2) const;
598 bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
599
600 // find an enclosing class
601 InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
602
603 // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
604 bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
605
606 // Check if this klass can be null-free
607 static void check_can_be_annotated_with_NullRestricted(InstanceKlass* type, Symbol* container_klass_name, TRAPS);
608
609 private:
610 // Check prohibited package ("java/" only loadable by boot or platform loaders)
611 static void check_prohibited_package(Symbol* class_name,
612 ClassLoaderData* loader_data,
613 TRAPS);
614
615 JavaThread* init_thread() { return AtomicAccess::load(&_init_thread); }
616 const char* init_thread_name() {
617 return init_thread()->name_raw();
618 }
619
620 public:
621 // initialization state
622 bool is_loaded() const { return init_state() >= loaded; }
623 bool is_linked() const { return init_state() >= linked; }
624 bool is_initialized() const { return init_state() == fully_initialized; }
625 bool is_not_initialized() const { return init_state() < being_initialized; }
626 bool is_being_initialized() const { return init_state() == being_initialized; }
627 bool is_in_error_state() const { return init_state() == initialization_error; }
628 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
629 ClassState init_state() const { return AtomicAccess::load_acquire(&_init_state); }
630 const char* init_state_name() const;
631 bool is_rewritten() const { return _misc_flags.rewritten(); }
632
633 // is this a sealed class
634 bool is_sealed() const;
635
636 // defineClass specified verification
637 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
638 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
639
640 // marking
641 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
642 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
643
644 static ByteSize kind_offset() { return byte_offset_of(InstanceKlass, _kind); }
645 static ByteSize misc_flags_offset() { return byte_offset_of(InstanceKlass, _misc_flags); }
646
647 // initialization (virtuals from Klass)
648 bool should_be_initialized() const override; // means that initialize should be called
649 void initialize_with_aot_initialized_mirror(bool early_init, TRAPS);
650 void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
651 void initialize(TRAPS) override;
652 void initialize_preemptable(TRAPS) override;
653 void link_class(TRAPS);
654 bool link_class_or_fail(TRAPS); // returns false on failure
655 void rewrite_class(TRAPS);
656 void link_methods(TRAPS);
657 Method* class_initializer() const;
658 bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;
659
660 // reference type
661 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
662
663 bool has_acmp_maps_offset() const {
664 return _acmp_maps_offset != 0;
665 }
666
667 int acmp_maps_offset() const {
668 assert(_acmp_maps_offset != 0, "Not initialized");
669 return _acmp_maps_offset;
670 }
671 void set_acmp_maps_offset(int offset) { _acmp_maps_offset = offset; }
672 static ByteSize acmp_maps_offset_offset() { return byte_offset_of(InstanceKlass, _acmp_maps_offset); }
673
674 // this class cp index
675 u2 this_class_index() const { return _this_class_index; }
676 void set_this_class_index(u2 index) { _this_class_index = index; }
677
678 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
679
680 // find local field, returns true if found
681 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
682 // find field in direct superinterfaces, returns the interface in which the field is defined
683 Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
684 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
685 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
686 // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
687 Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;
688
689 // find a non-static or static field given its offset within the class.
690 bool contains_field_offset(int offset);
691
692 bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
693 bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
694
695 bool find_local_flat_field_containing_offset(int offset, fieldDescriptor* fd) const;
696 bool find_flat_field_containing_offset(int offset, fieldDescriptor* fd) const;
697
698 private:
699 inline static int quick_search(const Array<Method*>* methods, const Symbol* name);
700
701 public:
702 static void disable_method_binary_search() {
703 _disable_method_binary_search = true;
704 }
705
706 // find a local method (returns null if not found)
707 Method* find_method(const Symbol* name, const Symbol* signature) const;
708 static Method* find_method(const Array<Method*>* methods,
709 const Symbol* name,
710 const Symbol* signature);
711
712 // find a local method, but skip static methods
713 Method* find_instance_method(const Symbol* name, const Symbol* signature,
714 PrivateLookupMode private_mode) const;
715 static Method* find_instance_method(const Array<Method*>* methods,
716 const Symbol* name,
717 const Symbol* signature,
769 // protection domain
770 oop protection_domain() const override;
771
772 // signers
773 objArrayOop signers() const;
774
775 bool is_contended() const { return _misc_flags.is_contended(); }
776 void set_is_contended(bool value) { _misc_flags.set_is_contended(value); }
777
778 // source file name
779 Symbol* source_file_name() const;
780 u2 source_file_name_index() const;
781 void set_source_file_name_index(u2 sourcefile_index);
782
783 // minor and major version numbers of class file
784 u2 minor_version() const;
785 void set_minor_version(u2 minor_version);
786 u2 major_version() const;
787 void set_major_version(u2 major_version);
788
789 bool supports_inline_types() const;
790
791 // source debug extension
792 const char* source_debug_extension() const { return _source_debug_extension; }
793 void set_source_debug_extension(const char* array, int length);
794
795 // nonstatic oop-map blocks
796 static int nonstatic_oop_map_size(unsigned int oop_map_count) {
797 return oop_map_count * OopMapBlock::size_in_words();
798 }
799 unsigned int nonstatic_oop_map_count() const {
800 return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
801 }
802 int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
803 void set_nonstatic_oop_map_size(int words) {
804 _nonstatic_oop_map_size = words;
805 }
806
807 bool has_contended_annotations() const { return _misc_flags.has_contended_annotations(); }
808 void set_has_contended_annotations(bool value) { _misc_flags.set_has_contended_annotations(value); }
809
810 #if INCLUDE_JVMTI
877 }
878 JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)nullptr; }
879
880 #endif // INCLUDE_JVMTI
881
882 bool has_nonstatic_concrete_methods() const { return _misc_flags.has_nonstatic_concrete_methods(); }
883 void set_has_nonstatic_concrete_methods(bool b) { _misc_flags.set_has_nonstatic_concrete_methods(b); }
884
885 bool declares_nonstatic_concrete_methods() const { return _misc_flags.declares_nonstatic_concrete_methods(); }
886 void set_declares_nonstatic_concrete_methods(bool b) { _misc_flags.set_declares_nonstatic_concrete_methods(b); }
887
888 bool has_miranda_methods () const { return _misc_flags.has_miranda_methods(); }
889 void set_has_miranda_methods() { _misc_flags.set_has_miranda_methods(true); }
890 bool has_final_method() const { return _misc_flags.has_final_method(); }
891 void set_has_final_method() { _misc_flags.set_has_final_method(true); }
892
893 // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
894 inline u2 next_method_idnum();
895 void set_initial_method_idnum(u2 value) { _idnum_allocated_count = value; }
896
897 // runtime support for strict statics
898 bool has_strict_static_fields() const { return _misc_flags.has_strict_static_fields(); }
899 void set_has_strict_static_fields(bool b) { _misc_flags.set_has_strict_static_fields(b); }
900 void notify_strict_static_access(int field_index, bool is_writing, TRAPS);
901 const char* format_strict_static_message(Symbol* field_name, const char* doing_what = nullptr);
902 void throw_strict_static_exception(Symbol* field_name, const char* when, TRAPS);
903
904 // generics support
905 Symbol* generic_signature() const;
906 u2 generic_signature_index() const;
907 void set_generic_signature_index(u2 sig_index);
908
909 u2 enclosing_method_data(int offset) const;
910 u2 enclosing_method_class_index() const {
911 return enclosing_method_data(enclosing_method_class_index_offset);
912 }
913 u2 enclosing_method_method_index() {
914 return enclosing_method_data(enclosing_method_method_index_offset);
915 }
916 void set_enclosing_method_indices(u2 class_index,
917 u2 method_index);
918
919 // jmethodID support
920 jmethodID get_jmethod_id(Method* method);
921 void make_methods_jmethod_ids();
922 jmethodID jmethod_id_or_null(Method* method);
923 void update_methods_jmethod_cache();
977
978 // On-stack replacement support
979 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
980 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
981 void add_osr_nmethod(nmethod* n);
982 bool remove_osr_nmethod(nmethod* n);
983 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
984 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
985
986 #if INCLUDE_JVMTI
987 // Breakpoint support (see methods on Method* for details)
988 BreakpointInfo* breakpoints() const { return _breakpoints; };
989 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
990 #endif
991
992 // support for stub routines
993 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
994 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
995 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
996
997 static ByteSize inline_layout_info_array_offset() { return byte_offset_of(InstanceKlass, _inline_layout_info_array); }
998 static ByteSize adr_inline_klass_members_offset() { return byte_offset_of(InstanceKlass, _adr_inline_klass_members); }
999
1000 // subclass/subinterface checks
1001 bool implements_interface(Klass* k) const;
1002 bool is_same_or_direct_interface(Klass* k) const;
1003
1004 #ifdef ASSERT
1005 // check whether this class or one of its superclasses was redefined
1006 bool has_redefined_this_or_super() const;
1007 #endif
1008
1009 // Access to the implementor of an interface.
1010 InstanceKlass* implementor() const;
1011 void set_implementor(InstanceKlass* ik);
1012 int nof_implementors() const;
1013 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
1014 void init_implementor(); // initialize
1015
1016 private:
1017 // link this class into the implementors list of every interface it implements
1018 void process_interfaces();
1019
1020 public:
1021 // virtual operations from Klass
1022 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
1023 Array<InstanceKlass*>* transitive_interfaces) override;
1024 bool can_be_primary_super_slow() const override;
1025 size_t oop_size(oop obj) const override { return size_helper(); }
1026 // slow because it's a virtual call and used for verifying the layout_helper.
1027 // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
1028 DEBUG_ONLY(bool is_instance_klass_slow() const override { return true; })
1029
1030 // Iterators
1031 void do_local_static_fields(FieldClosure* cl);
1032 void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
1033 void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
1034 void print_nonstatic_fields(FieldClosure* cl); // including inherited and injected fields
1035
1036 void methods_do(void f(Method* method));
1037
1038 static InstanceKlass* cast(Klass* k) {
1039 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
1040 }
1041
1042 static const InstanceKlass* cast(const Klass* k) {
1043 assert(k != nullptr, "k should not be null");
1044 assert(k->is_instance_klass(), "cast to InstanceKlass");
1045 return static_cast<const InstanceKlass*>(k);
1046 }
1047
1048 // This hides Klass::super(). The _super of an InstanceKlass is
1049 // always an InstanceKlass (or nullptr)
1050 InstanceKlass* super() const {
1051 return (Klass::super() == nullptr) ? nullptr : InstanceKlass::cast(Klass::super());
1052 }
1053
1054 InstanceKlass* java_super() const override {
1055 return InstanceKlass::super();
1056 }
1057
1058 // Sizing (in words)
1059 static int header_size() { return sizeof(InstanceKlass) / wordSize; }
1060
1061 static int size(int vtable_length,
1062 int itable_length,
1063 int nonstatic_oop_map_size,
1064 bool is_interface,
1065 bool is_inline_type);
1066
1067 int size() const override;
1068
1069
1070 inline intptr_t* start_of_itable() const;
1071 inline intptr_t* end_of_itable() const;
1072 inline oop static_field_base_raw();
1073 bool bounds_check(address addr, bool edge_ok = false, intptr_t size_in_bytes = -1) const PRODUCT_RETURN0;
1074
1075 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
1076 inline Klass** end_of_nonstatic_oop_maps() const;
1077
1078 inline InstanceKlass* volatile* adr_implementor() const;
1079
1080 // The end of the memory block that belongs to this InstanceKlass.
1081 // Sub-klasses can place their fields after this address.
1082 inline address end_of_instance_klass() const;
1083
1084 void set_inline_layout_info_array(Array<InlineLayoutInfo>* array) { _inline_layout_info_array = array; }
1085 Array<InlineLayoutInfo>* inline_layout_info_array() const { return _inline_layout_info_array; }
1086
1087 InlineLayoutInfo inline_layout_info(int index) const {
1088 assert(_inline_layout_info_array != nullptr, "Array not created");
1089 return _inline_layout_info_array->at(index);
1090 }
1091
1092 InlineLayoutInfo* inline_layout_info_adr(int index) {
1093 assert(_inline_layout_info_array != nullptr, "Array not created");
1094 return _inline_layout_info_array->adr_at(index);
1095 }
1096
1097 inline InlineKlass* get_inline_type_field_klass(int idx) const ;
1098 inline InlineKlass* get_inline_type_field_klass_or_null(int idx) const;
1099
1100 // Use this to return the size of an instance in heap words:
1101 int size_helper() const {
1102 return layout_helper_to_size_helper(layout_helper());
1103 }
1104
1105 // This bit is initialized in classFileParser.cpp.
1106 // It is false under any of the following conditions:
1107 // - the class is abstract (including any interface)
1108 // - the class size is larger than FastAllocateSizeLimit
1109 // - the class is java/lang/Class, which cannot be allocated directly
1110 bool can_be_fastpath_allocated() const {
1111 return !layout_helper_needs_slow_path(layout_helper());
1112 }
1113
1114 // Java itable
1115 klassItable itable() const; // return klassItable wrapper
1116 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
1117 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
1118 int vtable_index_of_interface_method(Method* method);
1119
1132 // instanceKlasses and the metadata they point to.
1133 void deallocate_contents(ClassLoaderData* loader_data);
1134 static void deallocate_methods(ClassLoaderData* loader_data,
1135 Array<Method*>* methods);
1136 void static deallocate_interfaces(ClassLoaderData* loader_data,
1137 const InstanceKlass* super_klass,
1138 Array<InstanceKlass*>* local_interfaces,
1139 Array<InstanceKlass*>* transitive_interfaces);
1140 void static deallocate_record_components(ClassLoaderData* loader_data,
1141 Array<RecordComponent*>* record_component);
1142
1143 bool on_stack() const override;
1144
1145 // callbacks for actions during class unloading
1146 static void unload_class(InstanceKlass* ik);
1147
1148 void release_C_heap_structures(bool release_sub_metadata = true) override;
1149
1150 // Naming
1151 const char* signature_name() const override;
1152 const char* signature_name_of_carrier(char c) const;
1153
1154 // Oop fields (and metadata) iterators
1155 //
1156 // The InstanceKlass iterators also visits the Object's klass.
1157
1158 // Forward iteration
1159 public:
1160 // Iterate over all oop fields in the oop maps.
1161 template <typename T, class OopClosureType>
1162 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1163
1164 // Iterate over all oop fields and metadata.
1165 template <typename T, class OopClosureType>
1166 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1167
1168 // Iterate over all oop fields in one oop map.
1169 template <typename T, class OopClosureType>
1170 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1171
1172
1256
1257 static Method* find_method_impl(const Array<Method*>* methods,
1258 const Symbol* name,
1259 const Symbol* signature,
1260 OverpassLookupMode overpass_mode,
1261 StaticLookupMode static_mode,
1262 PrivateLookupMode private_mode);
1263
1264 #if INCLUDE_JVMTI
1265 // RedefineClasses support
1266 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1267 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1268 #endif
1269 public:
1270
1271 #if INCLUDE_CDS
1272 // CDS support - remove and restore oops from metadata. Oops are not shared.
1273 void remove_unshareable_info() override;
1274 void remove_unshareable_flags();
1275 void remove_java_mirror() override;
1276 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1277 void init_shared_package_entry();
1278 bool can_be_verified_at_dumptime() const;
1279 void compute_has_loops_flag_for_methods();
1280 #endif
1281 bool has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
1282 void set_has_init_deps_processed() {
1283 assert(is_initialized(), "");
1284 assert(!has_init_deps_processed(), "already set"); // one-off action
1285 _misc_flags.set_has_init_deps_processed(true);
1286 }
1287
1288 u2 compute_modifier_flags() const override;
1289
1290 public:
1291 // JVMTI support
1292 jint jvmti_class_status() const override;
1293
1294 void metaspace_pointers_do(MetaspaceClosure* iter) override;
1295
1296 public:
1297 // Printing
1298 void print_on(outputStream* st) const override;
1299 void print_value_on(outputStream* st) const override;
1300
1301 void oop_print_value_on(oop obj, outputStream* st) override;
1302
1303 void oop_print_on (oop obj, outputStream* st) override { oop_print_on(obj, st, 0, 0); }
1304 void oop_print_on (oop obj, outputStream* st, int indent = 0, int base_offset = 0);
1305
1306 #ifndef PRODUCT
1307 void print_dependent_nmethods(bool verbose = false);
1308 bool is_dependent_nmethod(nmethod* nm);
1309 bool verify_itable_index(int index);
1310 #endif
1311
1312 const char* internal_name() const override;
1313
1314 template<typename T, typename TClosureType>
1315 static void print_array_on(outputStream* st, Array<T>* array, TClosureType elem_printer);
1316
1317 // Verification
1318 void verify_on(outputStream* st) override;
1319
1320 void oop_verify_on(oop obj, outputStream* st) override;
1321
1322 // Logging
1323 void print_class_load_logging(ClassLoaderData* loader_data,
1324 const ModuleEntry* module_entry,
1325 const ClassFileStream* cfs) const;
1326 private:
1327 void print_class_load_cause_logging() const;
1328 void print_class_load_helper(ClassLoaderData* loader_data,
1329 const ModuleEntry* module_entry,
1330 const ClassFileStream* cfs) const;
1331 };
1332
1333 // for adding methods
1334 // UNSET_IDNUM return means no more ids available
1335 inline u2 InstanceKlass::next_method_idnum() {
1336 if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
|