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 void* operator new(size_t size, ClassLoaderData* loader_data, size_t word_size, bool use_class_space, TRAPS) throw();
147
148 public:
149 InstanceKlass();
150
151 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
152 // of the class loading & initialization procedure, and the use of the states.
153 enum ClassState : u1 {
154 allocated, // allocated (but not yet linked)
155 loaded, // loaded and inserted in class hierarchy (but not linked yet)
156 linked, // successfully linked/verified (but not initialized yet)
157 being_initialized, // currently running class initializer
158 fully_initialized, // initialized (successful final state)
159 initialization_error // error happened during initialization
160 };
161
162 private:
163 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
164
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
310 // Quick checks for the loader that defined this class (without switching on this->class_loader())
311 bool defined_by_boot_loader() const { return _misc_flags.defined_by_boot_loader(); }
312 bool defined_by_platform_loader() const { return _misc_flags.defined_by_platform_loader(); }
313 bool defined_by_app_loader() const { return _misc_flags.defined_by_app_loader(); }
314 bool defined_by_other_loaders() const { return _misc_flags.defined_by_other_loaders(); }
315 void set_class_loader_type() { _misc_flags.set_class_loader_type(_class_loader_data); }
316
317 // Check if the class can be shared in CDS
318 bool is_shareable() const;
319
320 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
321
322 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
323
324 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
325 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
326
327 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
328 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
329
330 // field sizes
331 int nonstatic_field_size() const { return _nonstatic_field_size; }
332 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
333
334 int static_field_size() const { return _static_field_size; }
335 void set_static_field_size(int size) { _static_field_size = size; }
336
337 int static_oop_field_count() const { return (int)_static_oop_field_count; }
338 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
339
340 // Java itable
341 int itable_length() const { return _itable_len; }
342 void set_itable_length(int len) { _itable_len = len; }
343
344 // array klasses
345 ObjArrayKlass* array_klasses() const { return _array_klasses; }
346 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
347 inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
348 void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }
349
374 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
375 _local_interfaces = a; }
376
377 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
378 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
379 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
380 _transitive_interfaces = a;
381 }
382
383 private:
384 friend class fieldDescriptor;
385 FieldInfo field(int index) const;
386
387 public:
388 int field_offset (int index) const { return field(index).offset(); }
389 int field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
390 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
391 FieldStatus field_status(int index) const { return fields_status()->at(index); }
392 inline Symbol* field_name (int index) const;
393 inline Symbol* field_signature (int index) const;
394
395 // Number of Java declared fields
396 int java_fields_count() const;
397 int total_fields_count() const;
398
399 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
400 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
401
402 Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
403 void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }
404
405 Array<FieldStatus>* fields_status() const {return _fields_status; }
406 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
407
408 // inner classes
409 Array<u2>* inner_classes() const { return _inner_classes; }
410 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
411
412 // nest members
413 Array<u2>* nest_members() const { return _nest_members; }
414 void set_nest_members(Array<u2>* m) { _nest_members = m; }
415
416 // nest-host index
417 jushort nest_host_index() const { return _nest_host_index; }
418 void set_nest_host_index(u2 i) { _nest_host_index = i; }
419 // dynamic nest member support
420 void set_nest_host(InstanceKlass* host);
421
422 // record components
423 Array<RecordComponent*>* record_components() const { return _record_components; }
424 void set_record_components(Array<RecordComponent*>* record_components) {
425 _record_components = record_components;
426 }
427 bool is_record() const;
483 bool in_javabase_module() const;
484 bool in_unnamed_package() const { return (_package_entry == nullptr); }
485 void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
486 // If the package for the InstanceKlass is in the boot loader's package entry
487 // table then sets the classpath_index field so that
488 // get_system_package() will know to return a non-null value for the
489 // package's location. And, so that the package will be added to the list of
490 // packages returned by get_system_packages().
491 // For packages whose classes are loaded from the boot loader class path, the
492 // classpath_index indicates which entry on the boot loader class path.
493 void set_classpath_index(s2 path_index);
494 bool is_same_class_package(const Klass* class2) const;
495 bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
496
497 // find an enclosing class
498 InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
499
500 // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
501 bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
502
503 private:
504 // Check prohibited package ("java/" only loadable by boot or platform loaders)
505 static void check_prohibited_package(Symbol* class_name,
506 ClassLoaderData* loader_data,
507 TRAPS);
508
509 JavaThread* init_thread() { return Atomic::load(&_init_thread); }
510 const char* init_thread_name() {
511 return init_thread()->name_raw();
512 }
513
514 public:
515 // initialization state
516 bool is_loaded() const { return init_state() >= loaded; }
517 bool is_linked() const { return init_state() >= linked; }
518 bool is_initialized() const { return init_state() == fully_initialized; }
519 bool is_not_initialized() const { return init_state() < being_initialized; }
520 bool is_being_initialized() const { return init_state() == being_initialized; }
521 bool is_in_error_state() const { return init_state() == initialization_error; }
522 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
523 ClassState init_state() const { return Atomic::load_acquire(&_init_state); }
524 const char* init_state_name() const;
525 bool is_rewritten() const { return _misc_flags.rewritten(); }
526
527 // is this a sealed class
528 bool is_sealed() const;
529
530 // defineClass specified verification
531 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
532 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
533
534 // marking
535 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
536 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
537
538 // initialization (virtuals from Klass)
539 bool should_be_initialized() const; // means that initialize should be called
540 void initialize_with_aot_initialized_mirror(TRAPS);
541 void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
542 void initialize(TRAPS);
543 void link_class(TRAPS);
544 bool link_class_or_fail(TRAPS); // returns false on failure
545 void rewrite_class(TRAPS);
546 void link_methods(TRAPS);
547 Method* class_initializer() const;
548 bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;
549
550 // reference type
551 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
552
553 // this class cp index
554 u2 this_class_index() const { return _this_class_index; }
555 void set_this_class_index(u2 index) { _this_class_index = index; }
556
557 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
645 // protection domain
646 oop protection_domain() const;
647
648 // signers
649 objArrayOop signers() const;
650
651 bool is_contended() const { return _misc_flags.is_contended(); }
652 void set_is_contended(bool value) { _misc_flags.set_is_contended(value); }
653
654 // source file name
655 Symbol* source_file_name() const;
656 u2 source_file_name_index() const;
657 void set_source_file_name_index(u2 sourcefile_index);
658
659 // minor and major version numbers of class file
660 u2 minor_version() const;
661 void set_minor_version(u2 minor_version);
662 u2 major_version() const;
663 void set_major_version(u2 major_version);
664
665 // source debug extension
666 const char* source_debug_extension() const { return _source_debug_extension; }
667 void set_source_debug_extension(const char* array, int length);
668
669 // nonstatic oop-map blocks
670 static int nonstatic_oop_map_size(unsigned int oop_map_count) {
671 return oop_map_count * OopMapBlock::size_in_words();
672 }
673 unsigned int nonstatic_oop_map_count() const {
674 return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
675 }
676 int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
677 void set_nonstatic_oop_map_size(int words) {
678 _nonstatic_oop_map_size = words;
679 }
680
681 bool has_contended_annotations() const { return _misc_flags.has_contended_annotations(); }
682 void set_has_contended_annotations(bool value) { _misc_flags.set_has_contended_annotations(value); }
683
684 #if INCLUDE_JVMTI
751 }
752 JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)nullptr; }
753
754 #endif // INCLUDE_JVMTI
755
756 bool has_nonstatic_concrete_methods() const { return _misc_flags.has_nonstatic_concrete_methods(); }
757 void set_has_nonstatic_concrete_methods(bool b) { _misc_flags.set_has_nonstatic_concrete_methods(b); }
758
759 bool declares_nonstatic_concrete_methods() const { return _misc_flags.declares_nonstatic_concrete_methods(); }
760 void set_declares_nonstatic_concrete_methods(bool b) { _misc_flags.set_declares_nonstatic_concrete_methods(b); }
761
762 bool has_miranda_methods () const { return _misc_flags.has_miranda_methods(); }
763 void set_has_miranda_methods() { _misc_flags.set_has_miranda_methods(true); }
764 bool has_final_method() const { return _misc_flags.has_final_method(); }
765 void set_has_final_method() { _misc_flags.set_has_final_method(true); }
766
767 // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
768 inline u2 next_method_idnum();
769 void set_initial_method_idnum(u2 value) { _idnum_allocated_count = value; }
770
771 // generics support
772 Symbol* generic_signature() const;
773 u2 generic_signature_index() const;
774 void set_generic_signature_index(u2 sig_index);
775
776 u2 enclosing_method_data(int offset) const;
777 u2 enclosing_method_class_index() const {
778 return enclosing_method_data(enclosing_method_class_index_offset);
779 }
780 u2 enclosing_method_method_index() {
781 return enclosing_method_data(enclosing_method_method_index_offset);
782 }
783 void set_enclosing_method_indices(u2 class_index,
784 u2 method_index);
785
786 // jmethodID support
787 jmethodID get_jmethod_id(Method* method);
788 void make_methods_jmethod_ids();
789 jmethodID jmethod_id_or_null(Method* method);
790 void update_methods_jmethod_cache();
795
796 AnnotationArray* class_annotations() const {
797 return (_annotations != nullptr) ? _annotations->class_annotations() : nullptr;
798 }
799 Array<AnnotationArray*>* fields_annotations() const {
800 return (_annotations != nullptr) ? _annotations->fields_annotations() : nullptr;
801 }
802 AnnotationArray* class_type_annotations() const {
803 return (_annotations != nullptr) ? _annotations->class_type_annotations() : nullptr;
804 }
805 Array<AnnotationArray*>* fields_type_annotations() const {
806 return (_annotations != nullptr) ? _annotations->fields_type_annotations() : nullptr;
807 }
808 // allocation
809 instanceOop allocate_instance(TRAPS);
810 static instanceOop allocate_instance(oop cls, TRAPS);
811
812 // additional member function to return a handle
813 instanceHandle allocate_instance_handle(TRAPS);
814
815 objArrayOop allocate_objArray(int n, int length, TRAPS);
816 // Helper function
817 static instanceOop register_finalizer(instanceOop i, TRAPS);
818
819 // Check whether reflection/jni/jvm code is allowed to instantiate this class;
820 // if not, throw either an Error or an Exception.
821 virtual void check_valid_for_instantiation(bool throwError, TRAPS);
822
823 // initialization
824 void call_class_initializer(TRAPS);
825 void set_initialization_state_and_notify(ClassState state, TRAPS);
826
827 // OopMapCache support
828 OopMapCache* oop_map_cache() { return _oop_map_cache; }
829 void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
830 void mask_for(const methodHandle& method, int bci, InterpreterOopMap* entry);
831
832 // JNI identifier support (for static fields - for jni performance)
833 JNIid* jni_ids() { return _jni_ids; }
834 void set_jni_ids(JNIid* ids) { _jni_ids = ids; }
835 JNIid* jni_id_for(int offset);
845
846 // On-stack replacement support
847 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
848 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
849 void add_osr_nmethod(nmethod* n);
850 bool remove_osr_nmethod(nmethod* n);
851 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
852 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
853
854 #if INCLUDE_JVMTI
855 // Breakpoint support (see methods on Method* for details)
856 BreakpointInfo* breakpoints() const { return _breakpoints; };
857 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
858 #endif
859
860 // support for stub routines
861 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
862 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
863 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
864
865 // subclass/subinterface checks
866 bool implements_interface(Klass* k) const;
867 bool is_same_or_direct_interface(Klass* k) const;
868
869 #ifdef ASSERT
870 // check whether this class or one of its superclasses was redefined
871 bool has_redefined_this_or_super() const;
872 #endif
873
874 // Access to the implementor of an interface.
875 InstanceKlass* implementor() const;
876 void set_implementor(InstanceKlass* ik);
877 int nof_implementors() const;
878 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
879 void init_implementor(); // initialize
880
881 private:
882 // link this class into the implementors list of every interface it implements
883 void process_interfaces();
884
902
903 static InstanceKlass* cast(Klass* k) {
904 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
905 }
906
907 static const InstanceKlass* cast(const Klass* k) {
908 assert(k != nullptr, "k should not be null");
909 assert(k->is_instance_klass(), "cast to InstanceKlass");
910 return static_cast<const InstanceKlass*>(k);
911 }
912
913 virtual InstanceKlass* java_super() const {
914 return (super() == nullptr) ? nullptr : cast(super());
915 }
916
917 // Sizing (in words)
918 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
919
920 static int size(int vtable_length, int itable_length,
921 int nonstatic_oop_map_size,
922 bool is_interface) {
923 return align_metadata_size(header_size() +
924 vtable_length +
925 itable_length +
926 nonstatic_oop_map_size +
927 (is_interface ? (int)sizeof(Klass*)/wordSize : 0));
928 }
929
930 int size() const { return size(vtable_length(),
931 itable_length(),
932 nonstatic_oop_map_size(),
933 is_interface());
934 }
935
936
937 inline intptr_t* start_of_itable() const;
938 inline intptr_t* end_of_itable() const;
939 inline oop static_field_base_raw();
940
941 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
942 inline Klass** end_of_nonstatic_oop_maps() const;
943
944 inline InstanceKlass* volatile* adr_implementor() const;
945
946 // Use this to return the size of an instance in heap words:
947 int size_helper() const {
948 return layout_helper_to_size_helper(layout_helper());
949 }
950
951 // This bit is initialized in classFileParser.cpp.
952 // It is false under any of the following conditions:
953 // - the class is abstract (including any interface)
954 // - the class size is larger than FastAllocateSizeLimit
955 // - the class is java/lang/Class, which cannot be allocated directly
956 bool can_be_fastpath_allocated() const {
957 return !layout_helper_needs_slow_path(layout_helper());
958 }
959
960 // Java itable
961 klassItable itable() const; // return klassItable wrapper
962 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
963 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
964 int vtable_index_of_interface_method(Method* method);
965
966 #if INCLUDE_JVMTI
967 void adjust_default_methods(bool* trace_name_printed);
978 // instanceKlasses and the metadata they point to.
979 void deallocate_contents(ClassLoaderData* loader_data);
980 static void deallocate_methods(ClassLoaderData* loader_data,
981 Array<Method*>* methods);
982 void static deallocate_interfaces(ClassLoaderData* loader_data,
983 const Klass* super_klass,
984 Array<InstanceKlass*>* local_interfaces,
985 Array<InstanceKlass*>* transitive_interfaces);
986 void static deallocate_record_components(ClassLoaderData* loader_data,
987 Array<RecordComponent*>* record_component);
988
989 virtual bool on_stack() const;
990
991 // callbacks for actions during class unloading
992 static void unload_class(InstanceKlass* ik);
993
994 virtual void release_C_heap_structures(bool release_sub_metadata = true);
995
996 // Naming
997 const char* signature_name() const;
998
999 // Oop fields (and metadata) iterators
1000 //
1001 // The InstanceKlass iterators also visits the Object's klass.
1002
1003 // Forward iteration
1004 public:
1005 // Iterate over all oop fields in the oop maps.
1006 template <typename T, class OopClosureType>
1007 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1008
1009 // Iterate over all oop fields and metadata.
1010 template <typename T, class OopClosureType>
1011 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1012
1013 // Iterate over all oop fields in one oop map.
1014 template <typename T, class OopClosureType>
1015 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1016
1017
1103 const Symbol* name,
1104 const Symbol* signature,
1105 OverpassLookupMode overpass_mode,
1106 StaticLookupMode static_mode,
1107 PrivateLookupMode private_mode);
1108
1109 #if INCLUDE_JVMTI
1110 // RedefineClasses support
1111 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1112 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1113 #endif
1114 // log class name to classlist
1115 void log_to_classlist() const;
1116 public:
1117
1118 #if INCLUDE_CDS
1119 // CDS support - remove and restore oops from metadata. Oops are not shared.
1120 virtual void remove_unshareable_info();
1121 void remove_unshareable_flags();
1122 virtual void remove_java_mirror();
1123 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1124 void init_shared_package_entry();
1125 bool can_be_verified_at_dumptime() const;
1126 void compute_has_loops_flag_for_methods();
1127 #endif
1128 bool has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
1129 void set_has_init_deps_processed() {
1130 assert(is_initialized(), "");
1131 assert(!has_init_deps_processed(), "already set"); // one-off action
1132 _misc_flags.set_has_init_deps_processed(true);
1133 }
1134
1135 u2 compute_modifier_flags() const;
1136
1137 public:
1138 // JVMTI support
1139 jint jvmti_class_status() const;
1140
1141 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1142
1143 public:
1144 // Printing
1145 void print_on(outputStream* st) const;
1146 void print_value_on(outputStream* st) const;
1147
1148 void oop_print_value_on(oop obj, outputStream* st);
1149
1150 void oop_print_on (oop obj, outputStream* st);
1151
1152 #ifndef PRODUCT
1153 void print_dependent_nmethods(bool verbose = false);
1154 bool is_dependent_nmethod(nmethod* nm);
1155 bool verify_itable_index(int index);
1156 #endif
1157
1158 const char* internal_name() const;
1159
1160 // Verification
1161 void verify_on(outputStream* st);
1162
1163 void oop_verify_on(oop obj, outputStream* st);
1164
1165 // Logging
1166 void print_class_load_logging(ClassLoaderData* loader_data,
1167 const ModuleEntry* module_entry,
1168 const ClassFileStream* cfs) const;
1169 private:
1170 void print_class_load_cause_logging() const;
|
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_OOPS_INSTANCEKLASS_HPP
26 #define SHARE_OOPS_INSTANCEKLASS_HPP
27
28 #include "code/vmreg.hpp"
29 #include "memory/allocation.hpp"
30 #include "memory/referenceType.hpp"
31 #include "oops/annotations.hpp"
32 #include "oops/constMethod.hpp"
33 #include "oops/fieldInfo.hpp"
34 #include "oops/instanceKlassFlags.hpp"
35 #include "oops/instanceOop.hpp"
36 #include "oops/refArrayKlass.hpp"
37 #include "runtime/handles.hpp"
38 #include "runtime/javaThread.hpp"
39 #include "utilities/accessFlags.hpp"
40 #include "utilities/align.hpp"
41 #include "utilities/growableArray.hpp"
42 #include "utilities/macros.hpp"
43 #if INCLUDE_JFR
44 #include "jfr/support/jfrKlassExtension.hpp"
45 #endif
46
47 class ConstantPool;
48 class DeoptimizationScope;
49 class klassItable;
50 class RecordComponent;
51
52 // An InstanceKlass is the VM level representation of a Java class.
53 // It contains all information needed for at class at execution runtime.
54
55 // InstanceKlass embedded field layout (after declared fields):
56 // [EMBEDDED Java vtable ] size in words = vtable_len
57 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
58 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
59 // indicating where oops are located in instances of this klass.
60 // [EMBEDDED implementor of the interface] only exist for interface
61 // [EMBEDDED InlineKlassFixedBlock] only if is an InlineKlass instance
62
63
64 // forward declaration for class -- see below for definition
65 #if INCLUDE_JVMTI
66 class BreakpointInfo;
67 #endif
68 class ClassFileParser;
69 class ClassFileStream;
70 class KlassDepChange;
71 class DependencyContext;
72 class fieldDescriptor;
73 class JNIid;
74 class JvmtiCachedClassFieldMap;
75 class nmethodBucket;
76 class OopMapCache;
77 class BufferedInlineTypeBlob;
78 class InterpreterOopMap;
79 class PackageEntry;
80 class ModuleEntry;
81
82 // This is used in iterators below.
83 class FieldClosure: public StackObj {
84 public:
85 virtual void do_field(fieldDescriptor* fd) = 0;
86 };
87
88 // Print fields.
89 // If "obj" argument to constructor is null, prints static fields, otherwise prints non-static fields.
90 class FieldPrinter: public FieldClosure {
91 oop _obj;
92 outputStream* _st;
93 int _indent;
94 int _base_offset;
95 public:
96 FieldPrinter(outputStream* st, oop obj = nullptr, int indent = 0, int base_offset = 0) :
97 _obj(obj), _st(st), _indent(indent), _base_offset(base_offset) {}
98 void do_field(fieldDescriptor* fd);
99 };
100
101 // Describes where oops are located in instances of this klass.
102 class OopMapBlock {
103 public:
104 // Byte offset of the first oop mapped by this block.
105 int offset() const { return _offset; }
106 void set_offset(int offset) { _offset = offset; }
107
108 // Number of oops in this block.
109 uint count() const { return _count; }
110 void set_count(uint count) { _count = count; }
111
112 void increment_count(int diff) { _count += diff; }
113
114 int offset_span() const { return _count * heapOopSize; }
115
116 int end_offset() const {
117 return offset() + offset_span();
121 return another_offset == end_offset();
122 }
123
124 // sizeof(OopMapBlock) in words.
125 static int size_in_words() {
126 return align_up((int)sizeof(OopMapBlock), wordSize) >>
127 LogBytesPerWord;
128 }
129
130 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
131 return a->offset() - b->offset();
132 }
133
134 private:
135 int _offset;
136 uint _count;
137 };
138
139 struct JvmtiCachedClassFileData;
140
141 class SigEntry;
142
143 class InlineKlassFixedBlock {
144 Array<SigEntry>** _extended_sig;
145 Array<VMRegPair>** _return_regs;
146 address* _pack_handler;
147 address* _pack_handler_jobject;
148 address* _unpack_handler;
149 int* _null_reset_value_offset;
150 int _payload_offset; // offset of the begining of the payload in a heap buffered instance
151 int _payload_size_in_bytes; // size of payload layout
152 int _payload_alignment; // alignment required for payload
153 int _non_atomic_size_in_bytes; // size of null-free non-atomic flat layout
154 int _non_atomic_alignment; // alignment requirement for null-free non-atomic layout
155 int _atomic_size_in_bytes; // size and alignment requirement for a null-free atomic layout, -1 if no atomic flat layout is possible
156 int _nullable_size_in_bytes; // size and alignment requirement for a nullable layout (always atomic), -1 if no nullable flat layout is possible
157 int _null_marker_offset; // expressed as an offset from the beginning of the object for a heap buffered value
158 // payload_offset must be subtracted to get the offset from the beginning of the payload
159
160 friend class InlineKlass;
161 };
162
163 class InlineLayoutInfo : public MetaspaceObj {
164 InlineKlass* _klass;
165 LayoutKind _kind;
166 int _null_marker_offset; // null marker offset for this field, relative to the beginning of the current container
167
168 public:
169 InlineLayoutInfo(): _klass(nullptr), _kind(LayoutKind::UNKNOWN), _null_marker_offset(-1) {}
170 InlineLayoutInfo(InlineKlass* ik, LayoutKind kind, int size, int nm_offset):
171 _klass(ik), _kind(kind), _null_marker_offset(nm_offset) {}
172
173 InlineKlass* klass() const { return _klass; }
174 void set_klass(InlineKlass* k) { _klass = k; }
175
176 LayoutKind kind() const {
177 assert(_kind != LayoutKind::UNKNOWN, "Not set");
178 return _kind;
179 }
180 void set_kind(LayoutKind lk) { _kind = lk; }
181
182 int null_marker_offset() const {
183 assert(_null_marker_offset != -1, "Not set");
184 return _null_marker_offset;
185 }
186 void set_null_marker_offset(int o) { _null_marker_offset = o; }
187
188 void metaspace_pointers_do(MetaspaceClosure* it);
189 MetaspaceObj::Type type() const { return InlineLayoutInfoType; }
190
191 static ByteSize klass_offset() { return in_ByteSize(offset_of(InlineLayoutInfo, _klass)); }
192 static ByteSize null_marker_offset_offset() { return in_ByteSize(offset_of(InlineLayoutInfo, _null_marker_offset)); }
193 };
194
195 class InstanceKlass: public Klass {
196 friend class VMStructs;
197 friend class JVMCIVMStructs;
198 friend class ClassFileParser;
199 friend class CompileReplay;
200 friend class TemplateTable;
201
202 public:
203 static const KlassKind Kind = InstanceKlassKind;
204
205 protected:
206 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, markWord prototype = markWord::prototype(), ReferenceType reference_type = REF_NONE);
207
208 void* operator new(size_t size, ClassLoaderData* loader_data, size_t word_size, bool use_class_space, TRAPS) throw();
209
210 public:
211 InstanceKlass();
212
213 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
214 // of the class loading & initialization procedure, and the use of the states.
215 enum ClassState : u1 {
216 allocated, // allocated (but not yet linked)
217 loaded, // loaded and inserted in class hierarchy (but not linked yet)
218 linked, // successfully linked/verified (but not initialized yet)
219 being_initialized, // currently running class initializer
220 fully_initialized, // initialized (successful final state)
221 initialization_error // error happened during initialization
222 };
223
224 private:
225 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
226
324
325 // Method array.
326 Array<Method*>* _methods;
327 // Default Method Array, concrete methods inherited from interfaces
328 Array<Method*>* _default_methods;
329 // Interfaces (InstanceKlass*s) this class declares locally to implement.
330 Array<InstanceKlass*>* _local_interfaces;
331 // Interfaces (InstanceKlass*s) this class implements transitively.
332 Array<InstanceKlass*>* _transitive_interfaces;
333 // Int array containing the original order of method in the class file (for JVMTI).
334 Array<int>* _method_ordering;
335 // Int array containing the vtable_indices for default_methods
336 // offset matches _default_methods offset
337 Array<int>* _default_vtable_indices;
338
339 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
340 Array<u1>* _fieldinfo_stream;
341 Array<u1>* _fieldinfo_search_table;
342 Array<FieldStatus>* _fields_status;
343
344 Array<InlineLayoutInfo>* _inline_layout_info_array;
345 Array<u2>* _loadable_descriptors;
346 const InlineKlassFixedBlock* _adr_inlineklass_fixed_block;
347
348 // embedded Java vtable follows here
349 // embedded Java itables follows here
350 // embedded static fields follows here
351 // embedded nonstatic oop-map blocks follows here
352 // embedded implementor of this interface follows here
353 // The embedded implementor only exists if the current klass is an
354 // interface. The possible values of the implementor fall into following
355 // three cases:
356 // null: no implementor.
357 // A Klass* that's not itself: one implementor.
358 // Itself: more than one implementors.
359 //
360
361 friend class SystemDictionary;
362
363 static bool _disable_method_binary_search;
364
365 // Controls finalizer registration
366 static bool _finalization_enabled;
367
376 // Quick checks for the loader that defined this class (without switching on this->class_loader())
377 bool defined_by_boot_loader() const { return _misc_flags.defined_by_boot_loader(); }
378 bool defined_by_platform_loader() const { return _misc_flags.defined_by_platform_loader(); }
379 bool defined_by_app_loader() const { return _misc_flags.defined_by_app_loader(); }
380 bool defined_by_other_loaders() const { return _misc_flags.defined_by_other_loaders(); }
381 void set_class_loader_type() { _misc_flags.set_class_loader_type(_class_loader_data); }
382
383 // Check if the class can be shared in CDS
384 bool is_shareable() const;
385
386 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
387
388 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
389
390 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
391 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
392
393 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
394 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
395
396 bool has_inline_type_fields() const { return _misc_flags.has_inline_type_fields(); }
397 void set_has_inline_type_fields() { _misc_flags.set_has_inline_type_fields(true); }
398
399 bool is_naturally_atomic() const { return _misc_flags.is_naturally_atomic(); }
400 void set_is_naturally_atomic() { _misc_flags.set_is_naturally_atomic(true); }
401
402 // Query if this class has atomicity requirements (default is yes)
403 // This bit can occur anywhere, but is only significant
404 // for inline classes *and* their super types.
405 // It inherits from supers.
406 // Its value depends on the ForceNonTearable VM option, the LooselyConsistentValue annotation
407 // and the presence of flat fields with atomicity requirements
408 bool must_be_atomic() const { return _misc_flags.must_be_atomic(); }
409 void set_must_be_atomic() { _misc_flags.set_must_be_atomic(true); }
410
411 // field sizes
412 int nonstatic_field_size() const { return _nonstatic_field_size; }
413 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
414
415 int static_field_size() const { return _static_field_size; }
416 void set_static_field_size(int size) { _static_field_size = size; }
417
418 int static_oop_field_count() const { return (int)_static_oop_field_count; }
419 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
420
421 // Java itable
422 int itable_length() const { return _itable_len; }
423 void set_itable_length(int len) { _itable_len = len; }
424
425 // array klasses
426 ObjArrayKlass* array_klasses() const { return _array_klasses; }
427 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
428 inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
429 void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }
430
455 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
456 _local_interfaces = a; }
457
458 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
459 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
460 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
461 _transitive_interfaces = a;
462 }
463
464 private:
465 friend class fieldDescriptor;
466 FieldInfo field(int index) const;
467
468 public:
469 int field_offset (int index) const { return field(index).offset(); }
470 int field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
471 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
472 FieldStatus field_status(int index) const { return fields_status()->at(index); }
473 inline Symbol* field_name (int index) const;
474 inline Symbol* field_signature (int index) const;
475 bool field_is_flat(int index) const { return field_flags(index).is_flat(); }
476 bool field_has_null_marker(int index) const { return field_flags(index).has_null_marker(); }
477 bool field_is_null_free_inline_type(int index) const;
478 bool is_class_in_loadable_descriptors_attribute(Symbol* name) const;
479
480 int null_marker_offset(int index) const { return inline_layout_info(index).null_marker_offset(); }
481
482 // Number of Java declared fields
483 int java_fields_count() const;
484 int total_fields_count() const;
485
486 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
487 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
488
489 Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
490 void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }
491
492 Array<FieldStatus>* fields_status() const {return _fields_status; }
493 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
494
495 Array<u2>* loadable_descriptors() const { return _loadable_descriptors; }
496 void set_loadable_descriptors(Array<u2>* c) { _loadable_descriptors = c; }
497
498 // inner classes
499 Array<u2>* inner_classes() const { return _inner_classes; }
500 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
501
502 // nest members
503 Array<u2>* nest_members() const { return _nest_members; }
504 void set_nest_members(Array<u2>* m) { _nest_members = m; }
505
506 // nest-host index
507 jushort nest_host_index() const { return _nest_host_index; }
508 void set_nest_host_index(u2 i) { _nest_host_index = i; }
509 // dynamic nest member support
510 void set_nest_host(InstanceKlass* host);
511
512 // record components
513 Array<RecordComponent*>* record_components() const { return _record_components; }
514 void set_record_components(Array<RecordComponent*>* record_components) {
515 _record_components = record_components;
516 }
517 bool is_record() const;
573 bool in_javabase_module() const;
574 bool in_unnamed_package() const { return (_package_entry == nullptr); }
575 void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
576 // If the package for the InstanceKlass is in the boot loader's package entry
577 // table then sets the classpath_index field so that
578 // get_system_package() will know to return a non-null value for the
579 // package's location. And, so that the package will be added to the list of
580 // packages returned by get_system_packages().
581 // For packages whose classes are loaded from the boot loader class path, the
582 // classpath_index indicates which entry on the boot loader class path.
583 void set_classpath_index(s2 path_index);
584 bool is_same_class_package(const Klass* class2) const;
585 bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
586
587 // find an enclosing class
588 InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
589
590 // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
591 bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
592
593 // Check if this klass can be null-free
594 static void check_can_be_annotated_with_NullRestricted(InstanceKlass* type, Symbol* container_klass_name, TRAPS);
595
596 private:
597 // Check prohibited package ("java/" only loadable by boot or platform loaders)
598 static void check_prohibited_package(Symbol* class_name,
599 ClassLoaderData* loader_data,
600 TRAPS);
601
602 JavaThread* init_thread() { return Atomic::load(&_init_thread); }
603 const char* init_thread_name() {
604 return init_thread()->name_raw();
605 }
606
607 public:
608 // initialization state
609 bool is_loaded() const { return init_state() >= loaded; }
610 bool is_linked() const { return init_state() >= linked; }
611 bool is_initialized() const { return init_state() == fully_initialized; }
612 bool is_not_initialized() const { return init_state() < being_initialized; }
613 bool is_being_initialized() const { return init_state() == being_initialized; }
614 bool is_in_error_state() const { return init_state() == initialization_error; }
615 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
616 ClassState init_state() const { return Atomic::load_acquire(&_init_state); }
617 const char* init_state_name() const;
618 bool is_rewritten() const { return _misc_flags.rewritten(); }
619
620 // is this a sealed class
621 bool is_sealed() const;
622
623 // defineClass specified verification
624 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
625 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
626
627 // marking
628 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
629 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
630
631 static ByteSize kind_offset() { return in_ByteSize(offset_of(InstanceKlass, _kind)); }
632 static ByteSize misc_flags_offset() { return in_ByteSize(offset_of(InstanceKlass, _misc_flags)); }
633
634 // initialization (virtuals from Klass)
635 bool should_be_initialized() const; // means that initialize should be called
636 void initialize_with_aot_initialized_mirror(TRAPS);
637 void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
638 void initialize(TRAPS);
639 void link_class(TRAPS);
640 bool link_class_or_fail(TRAPS); // returns false on failure
641 void rewrite_class(TRAPS);
642 void link_methods(TRAPS);
643 Method* class_initializer() const;
644 bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;
645
646 // reference type
647 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
648
649 // this class cp index
650 u2 this_class_index() const { return _this_class_index; }
651 void set_this_class_index(u2 index) { _this_class_index = index; }
652
653 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
741 // protection domain
742 oop protection_domain() const;
743
744 // signers
745 objArrayOop signers() const;
746
747 bool is_contended() const { return _misc_flags.is_contended(); }
748 void set_is_contended(bool value) { _misc_flags.set_is_contended(value); }
749
750 // source file name
751 Symbol* source_file_name() const;
752 u2 source_file_name_index() const;
753 void set_source_file_name_index(u2 sourcefile_index);
754
755 // minor and major version numbers of class file
756 u2 minor_version() const;
757 void set_minor_version(u2 minor_version);
758 u2 major_version() const;
759 void set_major_version(u2 major_version);
760
761 bool supports_inline_types() const;
762
763 // source debug extension
764 const char* source_debug_extension() const { return _source_debug_extension; }
765 void set_source_debug_extension(const char* array, int length);
766
767 // nonstatic oop-map blocks
768 static int nonstatic_oop_map_size(unsigned int oop_map_count) {
769 return oop_map_count * OopMapBlock::size_in_words();
770 }
771 unsigned int nonstatic_oop_map_count() const {
772 return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
773 }
774 int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
775 void set_nonstatic_oop_map_size(int words) {
776 _nonstatic_oop_map_size = words;
777 }
778
779 bool has_contended_annotations() const { return _misc_flags.has_contended_annotations(); }
780 void set_has_contended_annotations(bool value) { _misc_flags.set_has_contended_annotations(value); }
781
782 #if INCLUDE_JVMTI
849 }
850 JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)nullptr; }
851
852 #endif // INCLUDE_JVMTI
853
854 bool has_nonstatic_concrete_methods() const { return _misc_flags.has_nonstatic_concrete_methods(); }
855 void set_has_nonstatic_concrete_methods(bool b) { _misc_flags.set_has_nonstatic_concrete_methods(b); }
856
857 bool declares_nonstatic_concrete_methods() const { return _misc_flags.declares_nonstatic_concrete_methods(); }
858 void set_declares_nonstatic_concrete_methods(bool b) { _misc_flags.set_declares_nonstatic_concrete_methods(b); }
859
860 bool has_miranda_methods () const { return _misc_flags.has_miranda_methods(); }
861 void set_has_miranda_methods() { _misc_flags.set_has_miranda_methods(true); }
862 bool has_final_method() const { return _misc_flags.has_final_method(); }
863 void set_has_final_method() { _misc_flags.set_has_final_method(true); }
864
865 // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
866 inline u2 next_method_idnum();
867 void set_initial_method_idnum(u2 value) { _idnum_allocated_count = value; }
868
869 // runtime support for strict statics
870 bool has_strict_static_fields() const { return _misc_flags.has_strict_static_fields(); }
871 void set_has_strict_static_fields(bool b) { _misc_flags.set_has_strict_static_fields(b); }
872 void notify_strict_static_access(int field_index, bool is_writing, TRAPS);
873 const char* format_strict_static_message(Symbol* field_name, const char* doing_what = nullptr);
874 void throw_strict_static_exception(Symbol* field_name, const char* when, TRAPS);
875
876 // generics support
877 Symbol* generic_signature() const;
878 u2 generic_signature_index() const;
879 void set_generic_signature_index(u2 sig_index);
880
881 u2 enclosing_method_data(int offset) const;
882 u2 enclosing_method_class_index() const {
883 return enclosing_method_data(enclosing_method_class_index_offset);
884 }
885 u2 enclosing_method_method_index() {
886 return enclosing_method_data(enclosing_method_method_index_offset);
887 }
888 void set_enclosing_method_indices(u2 class_index,
889 u2 method_index);
890
891 // jmethodID support
892 jmethodID get_jmethod_id(Method* method);
893 void make_methods_jmethod_ids();
894 jmethodID jmethod_id_or_null(Method* method);
895 void update_methods_jmethod_cache();
900
901 AnnotationArray* class_annotations() const {
902 return (_annotations != nullptr) ? _annotations->class_annotations() : nullptr;
903 }
904 Array<AnnotationArray*>* fields_annotations() const {
905 return (_annotations != nullptr) ? _annotations->fields_annotations() : nullptr;
906 }
907 AnnotationArray* class_type_annotations() const {
908 return (_annotations != nullptr) ? _annotations->class_type_annotations() : nullptr;
909 }
910 Array<AnnotationArray*>* fields_type_annotations() const {
911 return (_annotations != nullptr) ? _annotations->fields_type_annotations() : nullptr;
912 }
913 // allocation
914 instanceOop allocate_instance(TRAPS);
915 static instanceOop allocate_instance(oop cls, TRAPS);
916
917 // additional member function to return a handle
918 instanceHandle allocate_instance_handle(TRAPS);
919
920 objArrayOop allocate_objArray(int lenght, ArrayKlass::ArrayProperties props, TRAPS);
921 // Helper function
922 static instanceOop register_finalizer(instanceOop i, TRAPS);
923
924 // Check whether reflection/jni/jvm code is allowed to instantiate this class;
925 // if not, throw either an Error or an Exception.
926 virtual void check_valid_for_instantiation(bool throwError, TRAPS);
927
928 // initialization
929 void call_class_initializer(TRAPS);
930 void set_initialization_state_and_notify(ClassState state, TRAPS);
931
932 // OopMapCache support
933 OopMapCache* oop_map_cache() { return _oop_map_cache; }
934 void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
935 void mask_for(const methodHandle& method, int bci, InterpreterOopMap* entry);
936
937 // JNI identifier support (for static fields - for jni performance)
938 JNIid* jni_ids() { return _jni_ids; }
939 void set_jni_ids(JNIid* ids) { _jni_ids = ids; }
940 JNIid* jni_id_for(int offset);
950
951 // On-stack replacement support
952 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
953 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
954 void add_osr_nmethod(nmethod* n);
955 bool remove_osr_nmethod(nmethod* n);
956 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
957 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
958
959 #if INCLUDE_JVMTI
960 // Breakpoint support (see methods on Method* for details)
961 BreakpointInfo* breakpoints() const { return _breakpoints; };
962 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
963 #endif
964
965 // support for stub routines
966 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
967 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
968 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
969
970 static ByteSize inline_layout_info_array_offset() { return in_ByteSize(offset_of(InstanceKlass, _inline_layout_info_array)); }
971 static ByteSize adr_inlineklass_fixed_block_offset() { return in_ByteSize(offset_of(InstanceKlass, _adr_inlineklass_fixed_block)); }
972
973 // subclass/subinterface checks
974 bool implements_interface(Klass* k) const;
975 bool is_same_or_direct_interface(Klass* k) const;
976
977 #ifdef ASSERT
978 // check whether this class or one of its superclasses was redefined
979 bool has_redefined_this_or_super() const;
980 #endif
981
982 // Access to the implementor of an interface.
983 InstanceKlass* implementor() const;
984 void set_implementor(InstanceKlass* ik);
985 int nof_implementors() const;
986 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
987 void init_implementor(); // initialize
988
989 private:
990 // link this class into the implementors list of every interface it implements
991 void process_interfaces();
992
1010
1011 static InstanceKlass* cast(Klass* k) {
1012 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
1013 }
1014
1015 static const InstanceKlass* cast(const Klass* k) {
1016 assert(k != nullptr, "k should not be null");
1017 assert(k->is_instance_klass(), "cast to InstanceKlass");
1018 return static_cast<const InstanceKlass*>(k);
1019 }
1020
1021 virtual InstanceKlass* java_super() const {
1022 return (super() == nullptr) ? nullptr : cast(super());
1023 }
1024
1025 // Sizing (in words)
1026 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
1027
1028 static int size(int vtable_length, int itable_length,
1029 int nonstatic_oop_map_size,
1030 bool is_interface,
1031 bool is_inline_type) {
1032 return align_metadata_size(header_size() +
1033 vtable_length +
1034 itable_length +
1035 nonstatic_oop_map_size +
1036 (is_interface ? (int)sizeof(Klass*)/wordSize : 0) +
1037 (is_inline_type ? (int)sizeof(InlineKlassFixedBlock) : 0));
1038 }
1039
1040 int size() const { return size(vtable_length(),
1041 itable_length(),
1042 nonstatic_oop_map_size(),
1043 is_interface(),
1044 is_inline_klass());
1045 }
1046
1047
1048 inline intptr_t* start_of_itable() const;
1049 inline intptr_t* end_of_itable() const;
1050 inline oop static_field_base_raw();
1051 bool bounds_check(address addr, bool edge_ok = false, intptr_t size_in_bytes = -1) const PRODUCT_RETURN0;
1052
1053 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
1054 inline Klass** end_of_nonstatic_oop_maps() const;
1055
1056 inline InstanceKlass* volatile* adr_implementor() const;
1057
1058 void set_inline_layout_info_array(Array<InlineLayoutInfo>* array) { _inline_layout_info_array = array; }
1059 Array<InlineLayoutInfo>* inline_layout_info_array() const { return _inline_layout_info_array; }
1060 void set_inline_layout_info(int index, InlineLayoutInfo *info) {
1061 assert(_inline_layout_info_array != nullptr ,"Array not created");
1062 _inline_layout_info_array->at_put(index, *info);
1063 }
1064 InlineLayoutInfo inline_layout_info(int index) const {
1065 assert(_inline_layout_info_array != nullptr ,"Array not created");
1066 return _inline_layout_info_array->at(index);
1067 }
1068 InlineLayoutInfo* inline_layout_info_adr(int index) {
1069 assert(_inline_layout_info_array != nullptr ,"Array not created");
1070 return _inline_layout_info_array->adr_at(index);
1071 }
1072
1073 inline InlineKlass* get_inline_type_field_klass(int idx) const ;
1074 inline InlineKlass* get_inline_type_field_klass_or_null(int idx) const;
1075
1076 // Use this to return the size of an instance in heap words:
1077 virtual int size_helper() const {
1078 return layout_helper_to_size_helper(layout_helper());
1079 }
1080
1081 // This bit is initialized in classFileParser.cpp.
1082 // It is false under any of the following conditions:
1083 // - the class is abstract (including any interface)
1084 // - the class size is larger than FastAllocateSizeLimit
1085 // - the class is java/lang/Class, which cannot be allocated directly
1086 bool can_be_fastpath_allocated() const {
1087 return !layout_helper_needs_slow_path(layout_helper());
1088 }
1089
1090 // Java itable
1091 klassItable itable() const; // return klassItable wrapper
1092 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
1093 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
1094 int vtable_index_of_interface_method(Method* method);
1095
1096 #if INCLUDE_JVMTI
1097 void adjust_default_methods(bool* trace_name_printed);
1108 // instanceKlasses and the metadata they point to.
1109 void deallocate_contents(ClassLoaderData* loader_data);
1110 static void deallocate_methods(ClassLoaderData* loader_data,
1111 Array<Method*>* methods);
1112 void static deallocate_interfaces(ClassLoaderData* loader_data,
1113 const Klass* super_klass,
1114 Array<InstanceKlass*>* local_interfaces,
1115 Array<InstanceKlass*>* transitive_interfaces);
1116 void static deallocate_record_components(ClassLoaderData* loader_data,
1117 Array<RecordComponent*>* record_component);
1118
1119 virtual bool on_stack() const;
1120
1121 // callbacks for actions during class unloading
1122 static void unload_class(InstanceKlass* ik);
1123
1124 virtual void release_C_heap_structures(bool release_sub_metadata = true);
1125
1126 // Naming
1127 const char* signature_name() const;
1128 const char* signature_name_of_carrier(char c) const;
1129
1130 // Oop fields (and metadata) iterators
1131 //
1132 // The InstanceKlass iterators also visits the Object's klass.
1133
1134 // Forward iteration
1135 public:
1136 // Iterate over all oop fields in the oop maps.
1137 template <typename T, class OopClosureType>
1138 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1139
1140 // Iterate over all oop fields and metadata.
1141 template <typename T, class OopClosureType>
1142 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1143
1144 // Iterate over all oop fields in one oop map.
1145 template <typename T, class OopClosureType>
1146 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1147
1148
1234 const Symbol* name,
1235 const Symbol* signature,
1236 OverpassLookupMode overpass_mode,
1237 StaticLookupMode static_mode,
1238 PrivateLookupMode private_mode);
1239
1240 #if INCLUDE_JVMTI
1241 // RedefineClasses support
1242 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1243 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1244 #endif
1245 // log class name to classlist
1246 void log_to_classlist() const;
1247 public:
1248
1249 #if INCLUDE_CDS
1250 // CDS support - remove and restore oops from metadata. Oops are not shared.
1251 virtual void remove_unshareable_info();
1252 void remove_unshareable_flags();
1253 virtual void remove_java_mirror();
1254 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1255 void init_shared_package_entry();
1256 bool can_be_verified_at_dumptime() const;
1257 void compute_has_loops_flag_for_methods();
1258 #endif
1259 bool has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
1260 void set_has_init_deps_processed() {
1261 assert(is_initialized(), "");
1262 assert(!has_init_deps_processed(), "already set"); // one-off action
1263 _misc_flags.set_has_init_deps_processed(true);
1264 }
1265
1266 u2 compute_modifier_flags() const;
1267
1268 public:
1269 // JVMTI support
1270 jint jvmti_class_status() const;
1271
1272 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1273
1274 public:
1275 // Printing
1276 void print_on(outputStream* st) const;
1277 void print_value_on(outputStream* st) const;
1278
1279 void oop_print_value_on(oop obj, outputStream* st);
1280
1281 void oop_print_on (oop obj, outputStream* st) { oop_print_on(obj, st, 0, 0); }
1282 void oop_print_on (oop obj, outputStream* st, int indent = 0, int base_offset = 0);
1283
1284 #ifndef PRODUCT
1285 void print_dependent_nmethods(bool verbose = false);
1286 bool is_dependent_nmethod(nmethod* nm);
1287 bool verify_itable_index(int index);
1288 #endif
1289
1290 const char* internal_name() const;
1291
1292 // Verification
1293 void verify_on(outputStream* st);
1294
1295 void oop_verify_on(oop obj, outputStream* st);
1296
1297 // Logging
1298 void print_class_load_logging(ClassLoaderData* loader_data,
1299 const ModuleEntry* module_entry,
1300 const ClassFileStream* cfs) const;
1301 private:
1302 void print_class_load_cause_logging() const;
|