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