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