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/referenceType.hpp"
29 #include "oops/annotations.hpp"
30 #include "oops/constMethod.hpp"
31 #include "oops/fieldInfo.hpp"
32 #include "oops/instanceKlassFlags.hpp"
33 #include "oops/instanceOop.hpp"
34 #include "runtime/handles.hpp"
35 #include "runtime/javaThread.hpp"
36 #include "utilities/accessFlags.hpp"
37 #include "utilities/align.hpp"
38 #include "utilities/growableArray.hpp"
39 #include "utilities/macros.hpp"
40 #if INCLUDE_JFR
41 #include "jfr/support/jfrKlassExtension.hpp"
42 #endif
43
44 class ConstantPool;
45 class DeoptimizationScope;
46 class klassItable;
47 class Monitor;
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 jniIdMapBase;
71 class JNIid;
72 class JvmtiCachedClassFieldMap;
73 class nmethodBucket;
74 class OopMapCache;
75 class InterpreterOopMap;
76 class PackageEntry;
77 class ModuleEntry;
78
79 // This is used in iterators below.
80 class FieldClosure: public StackObj {
81 public:
82 virtual void do_field(fieldDescriptor* fd) = 0;
83 };
84
85 // Print fields.
86 // If "obj" argument to constructor is null, prints static fields, otherwise prints non-static fields.
87 class FieldPrinter: public FieldClosure {
88 oop _obj;
89 outputStream* _st;
90 public:
91 FieldPrinter(outputStream* st, oop obj = nullptr) : _obj(obj), _st(st) {}
92 void do_field(fieldDescriptor* fd);
93 };
94
115 return another_offset == end_offset();
116 }
117
118 // sizeof(OopMapBlock) in words.
119 static int size_in_words() {
120 return align_up((int)sizeof(OopMapBlock), wordSize) >>
121 LogBytesPerWord;
122 }
123
124 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
125 return a->offset() - b->offset();
126 }
127
128 private:
129 int _offset;
130 uint _count;
131 };
132
133 struct JvmtiCachedClassFileData;
134
135 class InstanceKlass: public Klass {
136 friend class VMStructs;
137 friend class JVMCIVMStructs;
138 friend class ClassFileParser;
139 friend class CompileReplay;
140
141 public:
142 static const KlassKind Kind = InstanceKlassKind;
143
144 protected:
145 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, ReferenceType reference_type = REF_NONE);
146
147 public:
148 InstanceKlass();
149
150 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
151 // of the class loading & initialization procedure, and the use of the states.
152 enum ClassState : u1 {
153 allocated, // allocated (but not yet linked)
154 loaded, // loaded and inserted in class hierarchy (but not linked yet)
155 linked, // successfully linked/verified (but not initialized yet)
156 being_initialized, // currently running class initializer
157 fully_initialized, // initialized (successful final state)
158 initialization_error // error happened during initialization
159 };
160
161 private:
162 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
163
164 protected:
165 // If you add a new field that points to any metaspace object, you
166 // must add this field to InstanceKlass::metaspace_pointers_do().
167
168 // Annotations for this class
169 Annotations* _annotations;
170 // Package this class is defined in
171 PackageEntry* _package_entry;
172 // Array classes holding elements of this class.
173 ObjArrayKlass* volatile _array_klasses;
174 // Constant pool for this class.
175 ConstantPool* _constants;
176 // The InnerClasses attribute and EnclosingMethod attribute. The
177 // _inner_classes is an array of shorts. If the class has InnerClasses
178 // attribute, then the _inner_classes array begins with 4-tuples of shorts
179 // [inner_class_info_index, outer_class_info_index,
180 // inner_name_index, inner_class_access_flags] for the InnerClasses
181 // attribute. If the EnclosingMethod attribute exists, it occupies the
182 // last two shorts [class_index, method_index] of the array. If only
183 // the InnerClasses attribute exists, the _inner_classes array length is
184 // number_of_inner_classes * 4. If the class has both InnerClasses
185 // and EnclosingMethod attributes the _inner_classes array length is
186 // number_of_inner_classes * 4 + enclosing_method_attribute_size.
187 Array<jushort>* _inner_classes;
188
189 // The NestMembers attribute. An array of shorts, where each is a
190 // class info index for the class that is a nest member. This data
191 // has not been validated.
192 Array<jushort>* _nest_members;
193
260 NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once
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<FieldStatus>* _fields_status;
279
280 // embedded Java vtable follows here
281 // embedded Java itables follows here
282 // embedded static fields follows here
283 // embedded nonstatic oop-map blocks follows here
284 // embedded implementor of this interface follows here
285 // The embedded implementor only exists if the current klass is an
286 // interface. The possible values of the implementor fall into following
287 // three cases:
288 // null: no implementor.
289 // A Klass* that's not itself: one implementor.
290 // Itself: more than one implementors.
291 //
292
293 friend class SystemDictionary;
294
295 static bool _disable_method_binary_search;
296
297 // Controls finalizer registration
298 static bool _finalization_enabled;
299
313 bool is_shared_unregistered_class() const { return _misc_flags.is_shared_unregistered_class(); }
314
315 // Check if the class can be shared in CDS
316 bool is_shareable() const;
317
318 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
319
320 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
321
322 #if INCLUDE_CDS
323 void set_shared_class_loader_type(s2 loader_type) { _misc_flags.set_shared_class_loader_type(loader_type); }
324 void assign_class_loader_type() { _misc_flags.assign_class_loader_type(_class_loader_data); }
325 #endif
326
327 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
328 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
329
330 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
331 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
332
333 // field sizes
334 int nonstatic_field_size() const { return _nonstatic_field_size; }
335 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
336
337 int static_field_size() const { return _static_field_size; }
338 void set_static_field_size(int size) { _static_field_size = size; }
339
340 int static_oop_field_count() const { return (int)_static_oop_field_count; }
341 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
342
343 // Java itable
344 int itable_length() const { return _itable_len; }
345 void set_itable_length(int len) { _itable_len = len; }
346
347 // array klasses
348 ObjArrayKlass* array_klasses() const { return _array_klasses; }
349 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
350 inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
351 void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }
352
353 // methods
354 Array<Method*>* methods() const { return _methods; }
355 void set_methods(Array<Method*>* a) { _methods = a; }
356 Method* method_with_idnum(int idnum);
357 Method* method_with_orig_idnum(int idnum);
358 Method* method_with_orig_idnum(int idnum, int version);
359
360 // method ordering
361 Array<int>* method_ordering() const { return _method_ordering; }
362 void set_method_ordering(Array<int>* m) { _method_ordering = m; }
363 void copy_method_ordering(const intArray* m, TRAPS);
364
365 // default_methods
366 Array<Method*>* default_methods() const { return _default_methods; }
367 void set_default_methods(Array<Method*>* a) { _default_methods = a; }
368
369 // default method vtable_indices
370 Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
371 void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
372 Array<int>* create_new_default_vtable_indices(int len, TRAPS);
373
374 // interfaces
375 Array<InstanceKlass*>* local_interfaces() const { return _local_interfaces; }
376 void set_local_interfaces(Array<InstanceKlass*>* a) {
377 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
378 _local_interfaces = a; }
379
380 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
381 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
382 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
383 _transitive_interfaces = a;
384 }
385
386 private:
387 friend class fieldDescriptor;
388 FieldInfo field(int index) const;
389
390 public:
391 int field_offset (int index) const { return field(index).offset(); }
392 int field_access_flags(int index) const { return field(index).access_flags().as_int(); }
393 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
394 FieldStatus field_status(int index) const { return fields_status()->at(index); }
395 inline Symbol* field_name (int index) const;
396 inline Symbol* field_signature (int index) const;
397
398 // Number of Java declared fields
399 int java_fields_count() const;
400 int total_fields_count() const;
401
402 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
403 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
404
405 Array<FieldStatus>* fields_status() const {return _fields_status; }
406 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
407
408 // inner classes
409 Array<u2>* inner_classes() const { return _inner_classes; }
410 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
411
412 // nest members
413 Array<u2>* nest_members() const { return _nest_members; }
414 void set_nest_members(Array<u2>* m) { _nest_members = m; }
415
416 // nest-host index
417 jushort nest_host_index() const { return _nest_host_index; }
418 void set_nest_host_index(u2 i) { _nest_host_index = i; }
419 // dynamic nest member support
420 void set_nest_host(InstanceKlass* host);
421
422 // record components
423 Array<RecordComponent*>* record_components() const { return _record_components; }
424 void set_record_components(Array<RecordComponent*>* record_components) {
425 _record_components = record_components;
426 }
427 bool is_record() const;
509 bool is_initialized() const { return _init_state == fully_initialized; }
510 bool is_not_initialized() const { return _init_state < being_initialized; }
511 bool is_being_initialized() const { return _init_state == being_initialized; }
512 bool is_in_error_state() const { return _init_state == initialization_error; }
513 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
514 ClassState init_state() const { return _init_state; }
515 const char* init_state_name() const;
516 bool is_rewritten() const { return _misc_flags.rewritten(); }
517
518 // is this a sealed class
519 bool is_sealed() const;
520
521 // defineClass specified verification
522 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
523 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
524
525 // marking
526 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
527 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
528
529 // initialization (virtuals from Klass)
530 bool should_be_initialized() const; // means that initialize should be called
531 void initialize(TRAPS);
532 void link_class(TRAPS);
533 bool link_class_or_fail(TRAPS); // returns false on failure
534 void rewrite_class(TRAPS);
535 void link_methods(TRAPS);
536 Method* class_initializer() const;
537
538 // reference type
539 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
540
541 // this class cp index
542 u2 this_class_index() const { return _this_class_index; }
543 void set_this_class_index(u2 index) { _this_class_index = index; }
544
545 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
546
547 // find local field, returns true if found
548 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
835
836 // On-stack replacement support
837 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
838 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
839 void add_osr_nmethod(nmethod* n);
840 bool remove_osr_nmethod(nmethod* n);
841 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
842 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
843
844 #if INCLUDE_JVMTI
845 // Breakpoint support (see methods on Method* for details)
846 BreakpointInfo* breakpoints() const { return _breakpoints; };
847 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
848 #endif
849
850 // support for stub routines
851 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
852 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
853 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
854
855 // subclass/subinterface checks
856 bool implements_interface(Klass* k) const;
857 bool is_same_or_direct_interface(Klass* k) const;
858
859 #ifdef ASSERT
860 // check whether this class or one of its superclasses was redefined
861 bool has_redefined_this_or_super() const;
862 #endif
863
864 // Access to the implementor of an interface.
865 InstanceKlass* implementor() const;
866 void set_implementor(InstanceKlass* ik);
867 int nof_implementors() const;
868 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
869 void init_implementor(); // initialize
870
871 private:
872 // link this class into the implementors list of every interface it implements
873 void process_interfaces();
874
892
893 static InstanceKlass* cast(Klass* k) {
894 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
895 }
896
897 static const InstanceKlass* cast(const Klass* k) {
898 assert(k != nullptr, "k should not be null");
899 assert(k->is_instance_klass(), "cast to InstanceKlass");
900 return static_cast<const InstanceKlass*>(k);
901 }
902
903 virtual InstanceKlass* java_super() const {
904 return (super() == nullptr) ? nullptr : cast(super());
905 }
906
907 // Sizing (in words)
908 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
909
910 static int size(int vtable_length, int itable_length,
911 int nonstatic_oop_map_size,
912 bool is_interface) {
913 return align_metadata_size(header_size() +
914 vtable_length +
915 itable_length +
916 nonstatic_oop_map_size +
917 (is_interface ? (int)sizeof(Klass*)/wordSize : 0));
918 }
919
920 int size() const { return size(vtable_length(),
921 itable_length(),
922 nonstatic_oop_map_size(),
923 is_interface());
924 }
925
926
927 inline intptr_t* start_of_itable() const;
928 inline intptr_t* end_of_itable() const;
929 inline oop static_field_base_raw();
930
931 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
932 inline Klass** end_of_nonstatic_oop_maps() const;
933
934 inline InstanceKlass* volatile* adr_implementor() const;
935
936 // Use this to return the size of an instance in heap words:
937 int size_helper() const {
938 return layout_helper_to_size_helper(layout_helper());
939 }
940
941 // This bit is initialized in classFileParser.cpp.
942 // It is false under any of the following conditions:
943 // - the class is abstract (including any interface)
944 // - the class size is larger than FastAllocateSizeLimit
945 // - the class is java/lang/Class, which cannot be allocated directly
946 bool can_be_fastpath_allocated() const {
947 return !layout_helper_needs_slow_path(layout_helper());
948 }
949
950 // Java itable
951 klassItable itable() const; // return klassItable wrapper
952 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
953 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
954 int vtable_index_of_interface_method(Method* method);
955
956 #if INCLUDE_JVMTI
957 void adjust_default_methods(bool* trace_name_printed);
968 // instanceKlasses and the metadata they point to.
969 void deallocate_contents(ClassLoaderData* loader_data);
970 static void deallocate_methods(ClassLoaderData* loader_data,
971 Array<Method*>* methods);
972 void static deallocate_interfaces(ClassLoaderData* loader_data,
973 const Klass* super_klass,
974 Array<InstanceKlass*>* local_interfaces,
975 Array<InstanceKlass*>* transitive_interfaces);
976 void static deallocate_record_components(ClassLoaderData* loader_data,
977 Array<RecordComponent*>* record_component);
978
979 virtual bool on_stack() const;
980
981 // callbacks for actions during class unloading
982 static void unload_class(InstanceKlass* ik);
983
984 virtual void release_C_heap_structures(bool release_sub_metadata = true);
985
986 // Naming
987 const char* signature_name() const;
988
989 // Oop fields (and metadata) iterators
990 //
991 // The InstanceKlass iterators also visits the Object's klass.
992
993 // Forward iteration
994 public:
995 // Iterate over all oop fields in the oop maps.
996 template <typename T, class OopClosureType>
997 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
998
999 // Iterate over all oop fields and metadata.
1000 template <typename T, class OopClosureType>
1001 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1002
1003 // Iterate over all oop fields in one oop map.
1004 template <typename T, class OopClosureType>
1005 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1006
1007
1093 const Symbol* name,
1094 const Symbol* signature,
1095 OverpassLookupMode overpass_mode,
1096 StaticLookupMode static_mode,
1097 PrivateLookupMode private_mode);
1098
1099 #if INCLUDE_JVMTI
1100 // RedefineClasses support
1101 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1102 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1103 #endif
1104 // log class name to classlist
1105 void log_to_classlist() const;
1106 public:
1107
1108 #if INCLUDE_CDS
1109 // CDS support - remove and restore oops from metadata. Oops are not shared.
1110 virtual void remove_unshareable_info();
1111 void remove_unshareable_flags();
1112 virtual void remove_java_mirror();
1113 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1114 void init_shared_package_entry();
1115 bool can_be_verified_at_dumptime() const;
1116 bool methods_contain_jsr_bytecode() const;
1117 void compute_has_loops_flag_for_methods();
1118 #endif
1119
1120 jint compute_modifier_flags() const;
1121
1122 public:
1123 // JVMTI support
1124 jint jvmti_class_status() const;
1125
1126 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1127
1128 public:
1129 // Printing
1130 void print_on(outputStream* st) const;
1131 void print_value_on(outputStream* st) const;
1132
1133 void oop_print_value_on(oop obj, outputStream* st);
|
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/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 Monitor;
49 class RecordComponent;
50
51 // An InstanceKlass is the VM level representation of a Java class.
52 // It contains all information needed for at class at execution runtime.
53
54 // InstanceKlass embedded field layout (after declared fields):
55 // [EMBEDDED Java vtable ] size in words = vtable_len
56 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
57 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
58 // indicating where oops are located in instances of this klass.
59 // [EMBEDDED implementor of the interface] only exist for interface
60 // [EMBEDDED InlineKlassFixedBlock] only if is an InlineKlass instance
61
62
63 // forward declaration for class -- see below for definition
64 #if INCLUDE_JVMTI
65 class BreakpointInfo;
66 #endif
67 class ClassFileParser;
68 class ClassFileStream;
69 class KlassDepChange;
70 class DependencyContext;
71 class fieldDescriptor;
72 class jniIdMapBase;
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 public:
94 FieldPrinter(outputStream* st, oop obj = nullptr) : _obj(obj), _st(st) {}
95 void do_field(fieldDescriptor* fd);
96 };
97
118 return another_offset == end_offset();
119 }
120
121 // sizeof(OopMapBlock) in words.
122 static int size_in_words() {
123 return align_up((int)sizeof(OopMapBlock), wordSize) >>
124 LogBytesPerWord;
125 }
126
127 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
128 return a->offset() - b->offset();
129 }
130
131 private:
132 int _offset;
133 uint _count;
134 };
135
136 struct JvmtiCachedClassFileData;
137
138 class SigEntry;
139
140 class InlineKlassFixedBlock {
141 Array<SigEntry>** _extended_sig;
142 Array<VMRegPair>** _return_regs;
143 address* _pack_handler;
144 address* _pack_handler_jobject;
145 address* _unpack_handler;
146 int* _default_value_offset;
147 ArrayKlass** _null_free_inline_array_klasses;
148 int _alignment;
149 int _first_field_offset;
150 int _payload_size_in_bytes;
151 int _internal_null_marker_offset; // -1 if none
152
153 friend class InlineKlass;
154 };
155
156 class InstanceKlass: public Klass {
157 friend class VMStructs;
158 friend class JVMCIVMStructs;
159 friend class ClassFileParser;
160 friend class CompileReplay;
161 friend class TemplateTable;
162
163 public:
164 static const KlassKind Kind = InstanceKlassKind;
165
166 protected:
167 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, ReferenceType reference_type = REF_NONE);
168
169 public:
170 InstanceKlass();
171
172 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
173 // of the class loading & initialization procedure, and the use of the states.
174 enum ClassState : u1 {
175 allocated, // allocated (but not yet linked)
176 loaded, // loaded and inserted in class hierarchy (but not linked yet)
177 linked, // successfully linked/verified (but not initialized yet)
178 being_initialized, // currently running class initializer
179 fully_initialized, // initialized (successful final state)
180 initialization_error // error happened during initialization
181 };
182
183 private:
184 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
185
186 protected:
187 // If you add a new field that points to any metaspace object, you
188 // must add this field to InstanceKlass::metaspace_pointers_do().
189
190 // Annotations for this class
191 Annotations* _annotations;
192 // Package this class is defined in
193 PackageEntry* _package_entry;
194 // Array classes holding elements of this class.
195 ArrayKlass* volatile _array_klasses;
196 // Constant pool for this class.
197 ConstantPool* _constants;
198 // The InnerClasses attribute and EnclosingMethod attribute. The
199 // _inner_classes is an array of shorts. If the class has InnerClasses
200 // attribute, then the _inner_classes array begins with 4-tuples of shorts
201 // [inner_class_info_index, outer_class_info_index,
202 // inner_name_index, inner_class_access_flags] for the InnerClasses
203 // attribute. If the EnclosingMethod attribute exists, it occupies the
204 // last two shorts [class_index, method_index] of the array. If only
205 // the InnerClasses attribute exists, the _inner_classes array length is
206 // number_of_inner_classes * 4. If the class has both InnerClasses
207 // and EnclosingMethod attributes the _inner_classes array length is
208 // number_of_inner_classes * 4 + enclosing_method_attribute_size.
209 Array<jushort>* _inner_classes;
210
211 // The NestMembers attribute. An array of shorts, where each is a
212 // class info index for the class that is a nest member. This data
213 // has not been validated.
214 Array<jushort>* _nest_members;
215
282 NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once
283
284 // Method array.
285 Array<Method*>* _methods;
286 // Default Method Array, concrete methods inherited from interfaces
287 Array<Method*>* _default_methods;
288 // Interfaces (InstanceKlass*s) this class declares locally to implement.
289 Array<InstanceKlass*>* _local_interfaces;
290 // Interfaces (InstanceKlass*s) this class implements transitively.
291 Array<InstanceKlass*>* _transitive_interfaces;
292 // Int array containing the original order of method in the class file (for JVMTI).
293 Array<int>* _method_ordering;
294 // Int array containing the vtable_indices for default_methods
295 // offset matches _default_methods offset
296 Array<int>* _default_vtable_indices;
297
298 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
299 Array<u1>* _fieldinfo_stream;
300 Array<FieldStatus>* _fields_status;
301
302 Array<InlineKlass*>* _inline_type_field_klasses; // For "inline class" fields, null if none present
303 Array<int>* _null_marker_offsets; // for flat fields with a null marker
304 Array<u2>* _loadable_descriptors;
305 const InlineKlassFixedBlock* _adr_inlineklass_fixed_block;
306
307 // embedded Java vtable follows here
308 // embedded Java itables follows here
309 // embedded static fields follows here
310 // embedded nonstatic oop-map blocks follows here
311 // embedded implementor of this interface follows here
312 // The embedded implementor only exists if the current klass is an
313 // interface. The possible values of the implementor fall into following
314 // three cases:
315 // null: no implementor.
316 // A Klass* that's not itself: one implementor.
317 // Itself: more than one implementors.
318 //
319
320 friend class SystemDictionary;
321
322 static bool _disable_method_binary_search;
323
324 // Controls finalizer registration
325 static bool _finalization_enabled;
326
340 bool is_shared_unregistered_class() const { return _misc_flags.is_shared_unregistered_class(); }
341
342 // Check if the class can be shared in CDS
343 bool is_shareable() const;
344
345 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
346
347 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
348
349 #if INCLUDE_CDS
350 void set_shared_class_loader_type(s2 loader_type) { _misc_flags.set_shared_class_loader_type(loader_type); }
351 void assign_class_loader_type() { _misc_flags.assign_class_loader_type(_class_loader_data); }
352 #endif
353
354 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
355 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
356
357 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
358 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
359
360 bool has_inline_type_fields() const { return _misc_flags.has_inline_type_fields(); }
361 void set_has_inline_type_fields() { _misc_flags.set_has_inline_type_fields(true); }
362
363 bool is_empty_inline_type() const { return _misc_flags.is_empty_inline_type(); }
364 void set_is_empty_inline_type() { _misc_flags.set_is_empty_inline_type(true); }
365
366 // Note: The naturally_atomic property only applies to
367 // inline classes; it is never true on identity classes.
368 // The bit is placed on instanceKlass for convenience.
369
370 // Query if h/w provides atomic load/store for instances.
371 bool is_naturally_atomic() const { return _misc_flags.is_naturally_atomic(); }
372 void set_is_naturally_atomic() { _misc_flags.set_is_naturally_atomic(true); }
373
374 // Query if this class is mentioned in the JVM option ForceNonTearable.
375 // This bit can occur anywhere, but is only significant
376 // for inline classes *and* their super types.
377 // It inherits from supers.
378 bool must_be_atomic() const { return _misc_flags.must_be_atomic(); }
379 void set_must_be_atomic() { _misc_flags.set_must_be_atomic(true); }
380
381 bool is_implicitly_constructible() const { return _misc_flags.is_implicitly_constructible(); }
382 void set_is_implicitly_constructible() { _misc_flags.set_is_implicitly_constructible(true); }
383
384 // field sizes
385 int nonstatic_field_size() const { return _nonstatic_field_size; }
386 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
387
388 int static_field_size() const { return _static_field_size; }
389 void set_static_field_size(int size) { _static_field_size = size; }
390
391 int static_oop_field_count() const { return (int)_static_oop_field_count; }
392 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
393
394 // Java itable
395 int itable_length() const { return _itable_len; }
396 void set_itable_length(int len) { _itable_len = len; }
397
398 // array klasses
399 ArrayKlass* array_klasses() const { return _array_klasses; }
400 inline ArrayKlass* array_klasses_acquire() const; // load with acquire semantics
401 inline void release_set_array_klasses(ArrayKlass* k); // store with release semantics
402 void set_array_klasses(ArrayKlass* k) { _array_klasses = k; }
403
404 // methods
405 Array<Method*>* methods() const { return _methods; }
406 void set_methods(Array<Method*>* a) { _methods = a; }
407 Method* method_with_idnum(int idnum);
408 Method* method_with_orig_idnum(int idnum);
409 Method* method_with_orig_idnum(int idnum, int version);
410
411 // method ordering
412 Array<int>* method_ordering() const { return _method_ordering; }
413 void set_method_ordering(Array<int>* m) { _method_ordering = m; }
414 void copy_method_ordering(const intArray* m, TRAPS);
415
416 // default_methods
417 Array<Method*>* default_methods() const { return _default_methods; }
418 void set_default_methods(Array<Method*>* a) { _default_methods = a; }
419
420 // default method vtable_indices
421 Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
422 void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
423 Array<int>* create_new_default_vtable_indices(int len, TRAPS);
424
425 // interfaces
426 Array<InstanceKlass*>* local_interfaces() const { return _local_interfaces; }
427 void set_local_interfaces(Array<InstanceKlass*>* a) {
428 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
429 _local_interfaces = a; }
430
431 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
432 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
433 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
434 _transitive_interfaces = a;
435 }
436
437 private:
438 friend class fieldDescriptor;
439 FieldInfo field(int index) const;
440
441 public:
442 int field_offset (int index) const { return field(index).offset(); }
443 int field_access_flags(int index) const { return field(index).access_flags().as_int(); }
444 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
445 FieldStatus field_status(int index) const { return fields_status()->at(index); }
446 inline Symbol* field_name (int index) const;
447 inline Symbol* field_signature (int index) const;
448 bool field_is_flat(int index) const { return field_flags(index).is_flat(); }
449 bool field_has_null_marker(int index) const { return field_flags(index).has_null_marker(); }
450 bool field_is_null_free_inline_type(int index) const;
451 bool is_class_in_loadable_descriptors_attribute(Symbol* name) const;
452
453 // Number of Java declared fields
454 int java_fields_count() const;
455 int total_fields_count() const;
456
457 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
458 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
459
460 Array<FieldStatus>* fields_status() const {return _fields_status; }
461 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
462
463 Array<u2>* loadable_descriptors() const { return _loadable_descriptors; }
464 void set_loadable_descriptors(Array<u2>* c) { _loadable_descriptors = c; }
465
466 // inner classes
467 Array<u2>* inner_classes() const { return _inner_classes; }
468 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
469
470 // nest members
471 Array<u2>* nest_members() const { return _nest_members; }
472 void set_nest_members(Array<u2>* m) { _nest_members = m; }
473
474 // nest-host index
475 jushort nest_host_index() const { return _nest_host_index; }
476 void set_nest_host_index(u2 i) { _nest_host_index = i; }
477 // dynamic nest member support
478 void set_nest_host(InstanceKlass* host);
479
480 // record components
481 Array<RecordComponent*>* record_components() const { return _record_components; }
482 void set_record_components(Array<RecordComponent*>* record_components) {
483 _record_components = record_components;
484 }
485 bool is_record() const;
567 bool is_initialized() const { return _init_state == fully_initialized; }
568 bool is_not_initialized() const { return _init_state < being_initialized; }
569 bool is_being_initialized() const { return _init_state == being_initialized; }
570 bool is_in_error_state() const { return _init_state == initialization_error; }
571 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
572 ClassState init_state() const { return _init_state; }
573 const char* init_state_name() const;
574 bool is_rewritten() const { return _misc_flags.rewritten(); }
575
576 // is this a sealed class
577 bool is_sealed() const;
578
579 // defineClass specified verification
580 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
581 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
582
583 // marking
584 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
585 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
586
587 static ByteSize kind_offset() { return in_ByteSize(offset_of(InstanceKlass, _kind)); }
588 static ByteSize misc_flags_offset() { return in_ByteSize(offset_of(InstanceKlass, _misc_flags)); }
589
590 // initialization (virtuals from Klass)
591 bool should_be_initialized() const; // means that initialize should be called
592 void initialize(TRAPS);
593 void link_class(TRAPS);
594 bool link_class_or_fail(TRAPS); // returns false on failure
595 void rewrite_class(TRAPS);
596 void link_methods(TRAPS);
597 Method* class_initializer() const;
598
599 // reference type
600 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
601
602 // this class cp index
603 u2 this_class_index() const { return _this_class_index; }
604 void set_this_class_index(u2 index) { _this_class_index = index; }
605
606 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
607
608 // find local field, returns true if found
609 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
896
897 // On-stack replacement support
898 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
899 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
900 void add_osr_nmethod(nmethod* n);
901 bool remove_osr_nmethod(nmethod* n);
902 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
903 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
904
905 #if INCLUDE_JVMTI
906 // Breakpoint support (see methods on Method* for details)
907 BreakpointInfo* breakpoints() const { return _breakpoints; };
908 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
909 #endif
910
911 // support for stub routines
912 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
913 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
914 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
915
916 static ByteSize inline_type_field_klasses_offset() { return in_ByteSize(offset_of(InstanceKlass, _inline_type_field_klasses)); }
917 static ByteSize null_marker_array_offset() { return in_ByteSize(offset_of(InstanceKlass, _null_marker_offsets)); }
918 static ByteSize adr_inlineklass_fixed_block_offset() { return in_ByteSize(offset_of(InstanceKlass, _adr_inlineklass_fixed_block)); }
919
920 // subclass/subinterface checks
921 bool implements_interface(Klass* k) const;
922 bool is_same_or_direct_interface(Klass* k) const;
923
924 #ifdef ASSERT
925 // check whether this class or one of its superclasses was redefined
926 bool has_redefined_this_or_super() const;
927 #endif
928
929 // Access to the implementor of an interface.
930 InstanceKlass* implementor() const;
931 void set_implementor(InstanceKlass* ik);
932 int nof_implementors() const;
933 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
934 void init_implementor(); // initialize
935
936 private:
937 // link this class into the implementors list of every interface it implements
938 void process_interfaces();
939
957
958 static InstanceKlass* cast(Klass* k) {
959 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
960 }
961
962 static const InstanceKlass* cast(const Klass* k) {
963 assert(k != nullptr, "k should not be null");
964 assert(k->is_instance_klass(), "cast to InstanceKlass");
965 return static_cast<const InstanceKlass*>(k);
966 }
967
968 virtual InstanceKlass* java_super() const {
969 return (super() == nullptr) ? nullptr : cast(super());
970 }
971
972 // Sizing (in words)
973 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
974
975 static int size(int vtable_length, int itable_length,
976 int nonstatic_oop_map_size,
977 bool is_interface,
978 bool is_inline_type) {
979 return align_metadata_size(header_size() +
980 vtable_length +
981 itable_length +
982 nonstatic_oop_map_size +
983 (is_interface ? (int)sizeof(Klass*)/wordSize : 0) +
984 (is_inline_type ? (int)sizeof(InlineKlassFixedBlock) : 0));
985 }
986
987 int size() const { return size(vtable_length(),
988 itable_length(),
989 nonstatic_oop_map_size(),
990 is_interface(),
991 is_inline_klass());
992 }
993
994
995 inline intptr_t* start_of_itable() const;
996 inline intptr_t* end_of_itable() const;
997 inline oop static_field_base_raw();
998 bool bounds_check(address addr, bool edge_ok = false, intptr_t size_in_bytes = -1) const PRODUCT_RETURN0;
999
1000 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
1001 inline Klass** end_of_nonstatic_oop_maps() const;
1002
1003 inline InstanceKlass* volatile* adr_implementor() const;
1004
1005 Array<InlineKlass*>* inline_type_field_klasses_array() const { return _inline_type_field_klasses; }
1006 void set_inline_type_field_klasses_array(Array<InlineKlass*>* array) { _inline_type_field_klasses = array; }
1007
1008 Array<int>* null_marker_offsets_array() const { return _null_marker_offsets; }
1009 void set_null_marker_offsets_array(Array<int>* array) { _null_marker_offsets = array; }
1010
1011 inline InlineKlass* get_inline_type_field_klass(int idx) const;
1012 inline InlineKlass* get_inline_type_field_klass_or_null(int idx) const;
1013 inline void set_inline_type_field_klass(int idx, InlineKlass* k);
1014 inline void reset_inline_type_field_klass(int idx);
1015
1016 // Use this to return the size of an instance in heap words:
1017 virtual int size_helper() const {
1018 return layout_helper_to_size_helper(layout_helper());
1019 }
1020
1021 // This bit is initialized in classFileParser.cpp.
1022 // It is false under any of the following conditions:
1023 // - the class is abstract (including any interface)
1024 // - the class size is larger than FastAllocateSizeLimit
1025 // - the class is java/lang/Class, which cannot be allocated directly
1026 bool can_be_fastpath_allocated() const {
1027 return !layout_helper_needs_slow_path(layout_helper());
1028 }
1029
1030 // Java itable
1031 klassItable itable() const; // return klassItable wrapper
1032 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
1033 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
1034 int vtable_index_of_interface_method(Method* method);
1035
1036 #if INCLUDE_JVMTI
1037 void adjust_default_methods(bool* trace_name_printed);
1048 // instanceKlasses and the metadata they point to.
1049 void deallocate_contents(ClassLoaderData* loader_data);
1050 static void deallocate_methods(ClassLoaderData* loader_data,
1051 Array<Method*>* methods);
1052 void static deallocate_interfaces(ClassLoaderData* loader_data,
1053 const Klass* super_klass,
1054 Array<InstanceKlass*>* local_interfaces,
1055 Array<InstanceKlass*>* transitive_interfaces);
1056 void static deallocate_record_components(ClassLoaderData* loader_data,
1057 Array<RecordComponent*>* record_component);
1058
1059 virtual bool on_stack() const;
1060
1061 // callbacks for actions during class unloading
1062 static void unload_class(InstanceKlass* ik);
1063
1064 virtual void release_C_heap_structures(bool release_sub_metadata = true);
1065
1066 // Naming
1067 const char* signature_name() const;
1068 const char* signature_name_of_carrier(char c) const;
1069
1070 // Oop fields (and metadata) iterators
1071 //
1072 // The InstanceKlass iterators also visits the Object's klass.
1073
1074 // Forward iteration
1075 public:
1076 // Iterate over all oop fields in the oop maps.
1077 template <typename T, class OopClosureType>
1078 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1079
1080 // Iterate over all oop fields and metadata.
1081 template <typename T, class OopClosureType>
1082 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1083
1084 // Iterate over all oop fields in one oop map.
1085 template <typename T, class OopClosureType>
1086 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1087
1088
1174 const Symbol* name,
1175 const Symbol* signature,
1176 OverpassLookupMode overpass_mode,
1177 StaticLookupMode static_mode,
1178 PrivateLookupMode private_mode);
1179
1180 #if INCLUDE_JVMTI
1181 // RedefineClasses support
1182 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1183 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1184 #endif
1185 // log class name to classlist
1186 void log_to_classlist() const;
1187 public:
1188
1189 #if INCLUDE_CDS
1190 // CDS support - remove and restore oops from metadata. Oops are not shared.
1191 virtual void remove_unshareable_info();
1192 void remove_unshareable_flags();
1193 virtual void remove_java_mirror();
1194 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1195 void init_shared_package_entry();
1196 bool can_be_verified_at_dumptime() const;
1197 bool methods_contain_jsr_bytecode() const;
1198 void compute_has_loops_flag_for_methods();
1199 #endif
1200
1201 jint compute_modifier_flags() const;
1202
1203 public:
1204 // JVMTI support
1205 jint jvmti_class_status() const;
1206
1207 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1208
1209 public:
1210 // Printing
1211 void print_on(outputStream* st) const;
1212 void print_value_on(outputStream* st) const;
1213
1214 void oop_print_value_on(oop obj, outputStream* st);
|