1 /*
2 * Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
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 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
61
62 // forward declaration for class -- see below for definition
63 #if INCLUDE_JVMTI
64 class BreakpointInfo;
65 #endif
66 class ClassFileParser;
67 class ClassFileStream;
68 class KlassDepChange;
69 class DependencyContext;
70 class fieldDescriptor;
71 class jniIdMapBase;
72 class JNIid;
73 class JvmtiCachedClassFieldMap;
74 class nmethodBucket;
75 class OopMapCache;
76 class InterpreterOopMap;
77 class PackageEntry;
78 class ModuleEntry;
79
80 // This is used in iterators below.
81 class FieldClosure: public StackObj {
82 public:
83 virtual void do_field(fieldDescriptor* fd) = 0;
84 };
85
86 // Print fields.
87 // If "obj" argument to constructor is null, prints static fields, otherwise prints non-static fields.
88 class FieldPrinter: public FieldClosure {
89 oop _obj;
90 outputStream* _st;
91 public:
92 FieldPrinter(outputStream* st, oop obj = nullptr) : _obj(obj), _st(st) {}
93 void do_field(fieldDescriptor* fd);
94 };
95
96 // Describes where oops are located in instances of this klass.
97 class OopMapBlock {
98 public:
99 // Byte offset of the first oop mapped by this block.
100 int offset() const { return _offset; }
101 void set_offset(int offset) { _offset = offset; }
102
103 // Number of oops in this block.
104 uint count() const { return _count; }
105 void set_count(uint count) { _count = count; }
106
107 void increment_count(int diff) { _count += diff; }
108
109 int offset_span() const { return _count * heapOopSize; }
110
111 int end_offset() const {
112 return offset() + offset_span();
116 return another_offset == end_offset();
117 }
118
119 // sizeof(OopMapBlock) in words.
120 static int size_in_words() {
121 return align_up((int)sizeof(OopMapBlock), wordSize) >>
122 LogBytesPerWord;
123 }
124
125 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
126 return a->offset() - b->offset();
127 }
128
129 private:
130 int _offset;
131 uint _count;
132 };
133
134 struct JvmtiCachedClassFileData;
135
136 class InstanceKlass: public Klass {
137 friend class VMStructs;
138 friend class JVMCIVMStructs;
139 friend class ClassFileParser;
140 friend class CompileReplay;
141
142 public:
143 static const KlassKind Kind = InstanceKlassKind;
144
145 protected:
146 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, ReferenceType reference_type = REF_NONE);
147
148 void* operator new(size_t size, ClassLoaderData* loader_data, size_t word_size, bool use_class_space, TRAPS) throw();
149
150 public:
151 InstanceKlass();
152
153 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
154 // of the class loading & initialization procedure, and the use of the states.
155 enum ClassState : u1 {
156 allocated, // allocated (but not yet linked)
157 loaded, // loaded and inserted in class hierarchy (but not linked yet)
158 linked, // successfully linked/verified (but not initialized yet)
159 being_initialized, // currently running class initializer
160 fully_initialized, // initialized (successful final state)
161 initialization_error // error happened during initialization
162 };
163
164 private:
165 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
166
167 protected:
168 // If you add a new field that points to any metaspace object, you
169 // must add this field to InstanceKlass::metaspace_pointers_do().
170
171 // Annotations for this class
172 Annotations* _annotations;
173 // Package this class is defined in
174 PackageEntry* _package_entry;
175 // Array classes holding elements of this class.
176 ObjArrayKlass* volatile _array_klasses;
177 // Constant pool for this class.
178 ConstantPool* _constants;
179 // The InnerClasses attribute and EnclosingMethod attribute. The
180 // _inner_classes is an array of shorts. If the class has InnerClasses
181 // attribute, then the _inner_classes array begins with 4-tuples of shorts
182 // [inner_class_info_index, outer_class_info_index,
183 // inner_name_index, inner_class_access_flags] for the InnerClasses
184 // attribute. If the EnclosingMethod attribute exists, it occupies the
185 // last two shorts [class_index, method_index] of the array. If only
186 // the InnerClasses attribute exists, the _inner_classes array length is
187 // number_of_inner_classes * 4. If the class has both InnerClasses
188 // and EnclosingMethod attributes the _inner_classes array length is
189 // number_of_inner_classes * 4 + enclosing_method_attribute_size.
190 Array<jushort>* _inner_classes;
191
192 // The NestMembers attribute. An array of shorts, where each is a
193 // class info index for the class that is a nest member. This data
194 // has not been validated.
195 Array<jushort>* _nest_members;
196
263 NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once
264
265 // Method array.
266 Array<Method*>* _methods;
267 // Default Method Array, concrete methods inherited from interfaces
268 Array<Method*>* _default_methods;
269 // Interfaces (InstanceKlass*s) this class declares locally to implement.
270 Array<InstanceKlass*>* _local_interfaces;
271 // Interfaces (InstanceKlass*s) this class implements transitively.
272 Array<InstanceKlass*>* _transitive_interfaces;
273 // Int array containing the original order of method in the class file (for JVMTI).
274 Array<int>* _method_ordering;
275 // Int array containing the vtable_indices for default_methods
276 // offset matches _default_methods offset
277 Array<int>* _default_vtable_indices;
278
279 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
280 Array<u1>* _fieldinfo_stream;
281 Array<FieldStatus>* _fields_status;
282
283 // embedded Java vtable follows here
284 // embedded Java itables follows here
285 // embedded static fields follows here
286 // embedded nonstatic oop-map blocks follows here
287 // embedded implementor of this interface follows here
288 // The embedded implementor only exists if the current klass is an
289 // interface. The possible values of the implementor fall into following
290 // three cases:
291 // null: no implementor.
292 // A Klass* that's not itself: one implementor.
293 // Itself: more than one implementors.
294 //
295
296 friend class SystemDictionary;
297
298 static bool _disable_method_binary_search;
299
300 // Controls finalizer registration
301 static bool _finalization_enabled;
302
316 bool is_shared_unregistered_class() const { return _misc_flags.is_shared_unregistered_class(); }
317
318 // Check if the class can be shared in CDS
319 bool is_shareable() const;
320
321 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
322
323 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
324
325 #if INCLUDE_CDS
326 void set_shared_class_loader_type(s2 loader_type) { _misc_flags.set_shared_class_loader_type(loader_type); }
327 void assign_class_loader_type() { _misc_flags.assign_class_loader_type(_class_loader_data); }
328 #endif
329
330 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
331 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
332
333 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
334 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
335
336 // field sizes
337 int nonstatic_field_size() const { return _nonstatic_field_size; }
338 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
339
340 int static_field_size() const { return _static_field_size; }
341 void set_static_field_size(int size) { _static_field_size = size; }
342
343 int static_oop_field_count() const { return (int)_static_oop_field_count; }
344 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
345
346 // Java itable
347 int itable_length() const { return _itable_len; }
348 void set_itable_length(int len) { _itable_len = len; }
349
350 // array klasses
351 ObjArrayKlass* array_klasses() const { return _array_klasses; }
352 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
353 inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
354 void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }
355
356 // methods
357 Array<Method*>* methods() const { return _methods; }
358 void set_methods(Array<Method*>* a) { _methods = a; }
359 Method* method_with_idnum(int idnum);
360 Method* method_with_orig_idnum(int idnum);
361 Method* method_with_orig_idnum(int idnum, int version);
362
363 // method ordering
364 Array<int>* method_ordering() const { return _method_ordering; }
365 void set_method_ordering(Array<int>* m) { _method_ordering = m; }
366 void copy_method_ordering(const intArray* m, TRAPS);
367
368 // default_methods
369 Array<Method*>* default_methods() const { return _default_methods; }
370 void set_default_methods(Array<Method*>* a) { _default_methods = a; }
371
372 // default method vtable_indices
373 Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
374 void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
375 Array<int>* create_new_default_vtable_indices(int len, TRAPS);
376
377 // interfaces
378 Array<InstanceKlass*>* local_interfaces() const { return _local_interfaces; }
379 void set_local_interfaces(Array<InstanceKlass*>* a) {
380 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
381 _local_interfaces = a; }
382
383 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
384 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
385 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
386 _transitive_interfaces = a;
387 }
388
389 private:
390 friend class fieldDescriptor;
391 FieldInfo field(int index) const;
392
393 public:
394 int field_offset (int index) const { return field(index).offset(); }
395 int field_access_flags(int index) const { return field(index).access_flags().as_int(); }
396 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
397 FieldStatus field_status(int index) const { return fields_status()->at(index); }
398 inline Symbol* field_name (int index) const;
399 inline Symbol* field_signature (int index) const;
400
401 // Number of Java declared fields
402 int java_fields_count() const;
403 int total_fields_count() const;
404
405 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
406 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
407
408 Array<FieldStatus>* fields_status() const {return _fields_status; }
409 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
410
411 // inner classes
412 Array<u2>* inner_classes() const { return _inner_classes; }
413 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
414
415 // nest members
416 Array<u2>* nest_members() const { return _nest_members; }
417 void set_nest_members(Array<u2>* m) { _nest_members = m; }
418
419 // nest-host index
420 jushort nest_host_index() const { return _nest_host_index; }
421 void set_nest_host_index(u2 i) { _nest_host_index = i; }
422 // dynamic nest member support
423 void set_nest_host(InstanceKlass* host);
424
425 // record components
426 Array<RecordComponent*>* record_components() const { return _record_components; }
427 void set_record_components(Array<RecordComponent*>* record_components) {
428 _record_components = record_components;
429 }
430 bool is_record() const;
512 bool is_initialized() const { return init_state() == fully_initialized; }
513 bool is_not_initialized() const { return init_state() < being_initialized; }
514 bool is_being_initialized() const { return init_state() == being_initialized; }
515 bool is_in_error_state() const { return init_state() == initialization_error; }
516 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
517 ClassState init_state() const { return Atomic::load_acquire(&_init_state); }
518 const char* init_state_name() const;
519 bool is_rewritten() const { return _misc_flags.rewritten(); }
520
521 // is this a sealed class
522 bool is_sealed() const;
523
524 // defineClass specified verification
525 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
526 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
527
528 // marking
529 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
530 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
531
532 // initialization (virtuals from Klass)
533 bool should_be_initialized() const; // means that initialize should be called
534 void initialize(TRAPS);
535 void link_class(TRAPS);
536 bool link_class_or_fail(TRAPS); // returns false on failure
537 void rewrite_class(TRAPS);
538 void link_methods(TRAPS);
539 Method* class_initializer() const;
540
541 // reference type
542 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
543
544 // this class cp index
545 u2 this_class_index() const { return _this_class_index; }
546 void set_this_class_index(u2 index) { _this_class_index = index; }
547
548 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
549
550 // find local field, returns true if found
551 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
838
839 // On-stack replacement support
840 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
841 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
842 void add_osr_nmethod(nmethod* n);
843 bool remove_osr_nmethod(nmethod* n);
844 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
845 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
846
847 #if INCLUDE_JVMTI
848 // Breakpoint support (see methods on Method* for details)
849 BreakpointInfo* breakpoints() const { return _breakpoints; };
850 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
851 #endif
852
853 // support for stub routines
854 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
855 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
856 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
857
858 // subclass/subinterface checks
859 bool implements_interface(Klass* k) const;
860 bool is_same_or_direct_interface(Klass* k) const;
861
862 #ifdef ASSERT
863 // check whether this class or one of its superclasses was redefined
864 bool has_redefined_this_or_super() const;
865 #endif
866
867 // Access to the implementor of an interface.
868 InstanceKlass* implementor() const;
869 void set_implementor(InstanceKlass* ik);
870 int nof_implementors() const;
871 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
872 void init_implementor(); // initialize
873
874 private:
875 // link this class into the implementors list of every interface it implements
876 void process_interfaces();
877
895
896 static InstanceKlass* cast(Klass* k) {
897 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
898 }
899
900 static const InstanceKlass* cast(const Klass* k) {
901 assert(k != nullptr, "k should not be null");
902 assert(k->is_instance_klass(), "cast to InstanceKlass");
903 return static_cast<const InstanceKlass*>(k);
904 }
905
906 virtual InstanceKlass* java_super() const {
907 return (super() == nullptr) ? nullptr : cast(super());
908 }
909
910 // Sizing (in words)
911 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
912
913 static int size(int vtable_length, int itable_length,
914 int nonstatic_oop_map_size,
915 bool is_interface) {
916 return align_metadata_size(header_size() +
917 vtable_length +
918 itable_length +
919 nonstatic_oop_map_size +
920 (is_interface ? (int)sizeof(Klass*)/wordSize : 0));
921 }
922
923 int size() const { return size(vtable_length(),
924 itable_length(),
925 nonstatic_oop_map_size(),
926 is_interface());
927 }
928
929
930 inline intptr_t* start_of_itable() const;
931 inline intptr_t* end_of_itable() const;
932 inline oop static_field_base_raw();
933
934 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
935 inline Klass** end_of_nonstatic_oop_maps() const;
936
937 inline InstanceKlass* volatile* adr_implementor() const;
938
939 // Use this to return the size of an instance in heap words:
940 int size_helper() const {
941 return layout_helper_to_size_helper(layout_helper());
942 }
943
944 // This bit is initialized in classFileParser.cpp.
945 // It is false under any of the following conditions:
946 // - the class is abstract (including any interface)
947 // - the class size is larger than FastAllocateSizeLimit
948 // - the class is java/lang/Class, which cannot be allocated directly
949 bool can_be_fastpath_allocated() const {
950 return !layout_helper_needs_slow_path(layout_helper());
951 }
952
953 // Java itable
954 klassItable itable() const; // return klassItable wrapper
955 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
956 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
957 int vtable_index_of_interface_method(Method* method);
958
959 #if INCLUDE_JVMTI
960 void adjust_default_methods(bool* trace_name_printed);
971 // instanceKlasses and the metadata they point to.
972 void deallocate_contents(ClassLoaderData* loader_data);
973 static void deallocate_methods(ClassLoaderData* loader_data,
974 Array<Method*>* methods);
975 void static deallocate_interfaces(ClassLoaderData* loader_data,
976 const Klass* super_klass,
977 Array<InstanceKlass*>* local_interfaces,
978 Array<InstanceKlass*>* transitive_interfaces);
979 void static deallocate_record_components(ClassLoaderData* loader_data,
980 Array<RecordComponent*>* record_component);
981
982 virtual bool on_stack() const;
983
984 // callbacks for actions during class unloading
985 static void unload_class(InstanceKlass* ik);
986
987 virtual void release_C_heap_structures(bool release_sub_metadata = true);
988
989 // Naming
990 const char* signature_name() const;
991
992 // Oop fields (and metadata) iterators
993 //
994 // The InstanceKlass iterators also visits the Object's klass.
995
996 // Forward iteration
997 public:
998 // Iterate over all oop fields in the oop maps.
999 template <typename T, class OopClosureType>
1000 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1001
1002 // Iterate over all oop fields and metadata.
1003 template <typename T, class OopClosureType>
1004 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1005
1006 // Iterate over all oop fields in one oop map.
1007 template <typename T, class OopClosureType>
1008 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1009
1010
1096 const Symbol* name,
1097 const Symbol* signature,
1098 OverpassLookupMode overpass_mode,
1099 StaticLookupMode static_mode,
1100 PrivateLookupMode private_mode);
1101
1102 #if INCLUDE_JVMTI
1103 // RedefineClasses support
1104 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1105 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1106 #endif
1107 // log class name to classlist
1108 void log_to_classlist() const;
1109 public:
1110
1111 #if INCLUDE_CDS
1112 // CDS support - remove and restore oops from metadata. Oops are not shared.
1113 virtual void remove_unshareable_info();
1114 void remove_unshareable_flags();
1115 virtual void remove_java_mirror();
1116 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1117 void init_shared_package_entry();
1118 bool can_be_verified_at_dumptime() const;
1119 void compute_has_loops_flag_for_methods();
1120 #endif
1121
1122 jint compute_modifier_flags() const;
1123
1124 public:
1125 // JVMTI support
1126 jint jvmti_class_status() const;
1127
1128 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1129
1130 public:
1131 // Printing
1132 void print_on(outputStream* st) const;
1133 void print_value_on(outputStream* st) const;
1134
1135 void oop_print_value_on(oop obj, outputStream* st);
1136
1137 void oop_print_on (oop obj, outputStream* st);
1138
1139 #ifndef PRODUCT
1140 void print_dependent_nmethods(bool verbose = false);
1141 bool is_dependent_nmethod(nmethod* nm);
1142 bool verify_itable_index(int index);
1143 #endif
1144
1145 const char* internal_name() const;
1146
1147 // Verification
1148 void verify_on(outputStream* st);
1149
1150 void oop_verify_on(oop obj, outputStream* st);
1151
1152 // Logging
1153 void print_class_load_logging(ClassLoaderData* loader_data,
1154 const ModuleEntry* module_entry,
1155 const ClassFileStream* cfs) const;
1156 private:
1157 void print_class_load_cause_logging() const;
|
1 /*
2 * Copyright (c) 1997, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
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 "runtime/handles.hpp"
37 #include "runtime/javaThread.hpp"
38 #include "utilities/accessFlags.hpp"
39 #include "utilities/align.hpp"
40 #include "utilities/growableArray.hpp"
41 #include "utilities/macros.hpp"
42 #if INCLUDE_JFR
43 #include "jfr/support/jfrKlassExtension.hpp"
44 #endif
45
46 class ConstantPool;
47 class DeoptimizationScope;
48 class klassItable;
49 class Monitor;
50 class RecordComponent;
51
52 // An InstanceKlass is the VM level representation of a Java class.
53 // It contains all information needed for at class at execution runtime.
54
55 // InstanceKlass embedded field layout (after declared fields):
56 // [EMBEDDED Java vtable ] size in words = vtable_len
57 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
58 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
59 // indicating where oops are located in instances of this klass.
60 // [EMBEDDED implementor of the interface] only exist for interface
61 // [EMBEDDED InlineKlassFixedBlock] only if is an InlineKlass instance
62
63
64 // forward declaration for class -- see below for definition
65 #if INCLUDE_JVMTI
66 class BreakpointInfo;
67 #endif
68 class ClassFileParser;
69 class ClassFileStream;
70 class KlassDepChange;
71 class DependencyContext;
72 class fieldDescriptor;
73 class jniIdMapBase;
74 class JNIid;
75 class JvmtiCachedClassFieldMap;
76 class nmethodBucket;
77 class OopMapCache;
78 class BufferedInlineTypeBlob;
79 class InterpreterOopMap;
80 class PackageEntry;
81 class ModuleEntry;
82
83 // This is used in iterators below.
84 class FieldClosure: public StackObj {
85 public:
86 virtual void do_field(fieldDescriptor* fd) = 0;
87 };
88
89 // Print fields.
90 // If "obj" argument to constructor is null, prints static fields, otherwise prints non-static fields.
91 class FieldPrinter: public FieldClosure {
92 oop _obj;
93 outputStream* _st;
94 int _indent;
95 int _base_offset;
96 public:
97 FieldPrinter(outputStream* st, oop obj = nullptr, int indent = 0, int base_offset = 0) :
98 _obj(obj), _st(st), _indent(indent), _base_offset(base_offset) {}
99 void do_field(fieldDescriptor* fd);
100 };
101
102 // Describes where oops are located in instances of this klass.
103 class OopMapBlock {
104 public:
105 // Byte offset of the first oop mapped by this block.
106 int offset() const { return _offset; }
107 void set_offset(int offset) { _offset = offset; }
108
109 // Number of oops in this block.
110 uint count() const { return _count; }
111 void set_count(uint count) { _count = count; }
112
113 void increment_count(int diff) { _count += diff; }
114
115 int offset_span() const { return _count * heapOopSize; }
116
117 int end_offset() const {
118 return offset() + offset_span();
122 return another_offset == end_offset();
123 }
124
125 // sizeof(OopMapBlock) in words.
126 static int size_in_words() {
127 return align_up((int)sizeof(OopMapBlock), wordSize) >>
128 LogBytesPerWord;
129 }
130
131 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
132 return a->offset() - b->offset();
133 }
134
135 private:
136 int _offset;
137 uint _count;
138 };
139
140 struct JvmtiCachedClassFileData;
141
142 class SigEntry;
143
144 class InlineKlassFixedBlock {
145 Array<SigEntry>** _extended_sig;
146 Array<VMRegPair>** _return_regs;
147 address* _pack_handler;
148 address* _pack_handler_jobject;
149 address* _unpack_handler;
150 int* _default_value_offset;
151 int* _null_reset_value_offset;
152 FlatArrayKlass* _non_atomic_flat_array_klass;
153 FlatArrayKlass* _atomic_flat_array_klass;
154 FlatArrayKlass* _nullable_atomic_flat_array_klass;
155 ObjArrayKlass* _null_free_reference_array_klass;
156 int _first_field_offset;
157 int _payload_size_in_bytes; // size of payload layout
158 int _payload_alignment; // alignment required for payload
159 int _non_atomic_size_in_bytes; // size of null-free non-atomic flat layout
160 int _non_atomic_alignment; // alignment requirement for null-free non-atomic layout
161 int _atomic_size_in_bytes; // size and alignment requirement for a null-free atomic layout, -1 if no atomic flat layout is possible
162 int _nullable_size_in_bytes; // size and alignment requirement for a nullable layout (always atomic), -1 if no nullable flat layout is possible
163 int _null_marker_offset; // expressed as an offset from the beginning of the object for a heap buffered value
164 // first_field_offset must be subtracted to get the offset from the beginning of the payload
165
166 friend class InlineKlass;
167 };
168
169 class InlineLayoutInfo : public MetaspaceObj {
170 InlineKlass* _klass;
171 LayoutKind _kind;
172 int _null_marker_offset; // null marker offset for this field, relative to the beginning of the current container
173
174 public:
175 InlineLayoutInfo(): _klass(nullptr), _kind(LayoutKind::UNKNOWN), _null_marker_offset(-1) {}
176 InlineLayoutInfo(InlineKlass* ik, LayoutKind kind, int size, int nm_offset):
177 _klass(ik), _kind(kind), _null_marker_offset(nm_offset) {}
178
179 InlineKlass* klass() const { return _klass; }
180 void set_klass(InlineKlass* k) { _klass = k; }
181
182 LayoutKind kind() const {
183 assert(_kind != LayoutKind::UNKNOWN, "Not set");
184 return _kind;
185 }
186 void set_kind(LayoutKind lk) { _kind = lk; }
187
188 int null_marker_offset() const {
189 assert(_null_marker_offset != -1, "Not set");
190 return _null_marker_offset;
191 }
192 void set_null_marker_offset(int o) { _null_marker_offset = o; }
193
194 void metaspace_pointers_do(MetaspaceClosure* it);
195 MetaspaceObj::Type type() const { return InlineLayoutInfoType; }
196
197 static ByteSize klass_offset() { return in_ByteSize(offset_of(InlineLayoutInfo, _klass)); }
198 static ByteSize null_marker_offset_offset() { return in_ByteSize(offset_of(InlineLayoutInfo, _null_marker_offset)); }
199 };
200
201 class InstanceKlass: public Klass {
202 friend class VMStructs;
203 friend class JVMCIVMStructs;
204 friend class ClassFileParser;
205 friend class CompileReplay;
206 friend class TemplateTable;
207
208 public:
209 static const KlassKind Kind = InstanceKlassKind;
210
211 protected:
212 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, ReferenceType reference_type = REF_NONE);
213
214 void* operator new(size_t size, ClassLoaderData* loader_data, size_t word_size, bool use_class_space, TRAPS) throw();
215
216 public:
217 InstanceKlass();
218
219 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
220 // of the class loading & initialization procedure, and the use of the states.
221 enum ClassState : u1 {
222 allocated, // allocated (but not yet linked)
223 loaded, // loaded and inserted in class hierarchy (but not linked yet)
224 linked, // successfully linked/verified (but not initialized yet)
225 being_initialized, // currently running class initializer
226 fully_initialized, // initialized (successful final state)
227 initialization_error // error happened during initialization
228 };
229
230 private:
231 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
232
233 protected:
234 // If you add a new field that points to any metaspace object, you
235 // must add this field to InstanceKlass::metaspace_pointers_do().
236
237 // Annotations for this class
238 Annotations* _annotations;
239 // Package this class is defined in
240 PackageEntry* _package_entry;
241 // Array classes holding elements of this class.
242 ArrayKlass* volatile _array_klasses;
243 // Constant pool for this class.
244 ConstantPool* _constants;
245 // The InnerClasses attribute and EnclosingMethod attribute. The
246 // _inner_classes is an array of shorts. If the class has InnerClasses
247 // attribute, then the _inner_classes array begins with 4-tuples of shorts
248 // [inner_class_info_index, outer_class_info_index,
249 // inner_name_index, inner_class_access_flags] for the InnerClasses
250 // attribute. If the EnclosingMethod attribute exists, it occupies the
251 // last two shorts [class_index, method_index] of the array. If only
252 // the InnerClasses attribute exists, the _inner_classes array length is
253 // number_of_inner_classes * 4. If the class has both InnerClasses
254 // and EnclosingMethod attributes the _inner_classes array length is
255 // number_of_inner_classes * 4 + enclosing_method_attribute_size.
256 Array<jushort>* _inner_classes;
257
258 // The NestMembers attribute. An array of shorts, where each is a
259 // class info index for the class that is a nest member. This data
260 // has not been validated.
261 Array<jushort>* _nest_members;
262
329 NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once
330
331 // Method array.
332 Array<Method*>* _methods;
333 // Default Method Array, concrete methods inherited from interfaces
334 Array<Method*>* _default_methods;
335 // Interfaces (InstanceKlass*s) this class declares locally to implement.
336 Array<InstanceKlass*>* _local_interfaces;
337 // Interfaces (InstanceKlass*s) this class implements transitively.
338 Array<InstanceKlass*>* _transitive_interfaces;
339 // Int array containing the original order of method in the class file (for JVMTI).
340 Array<int>* _method_ordering;
341 // Int array containing the vtable_indices for default_methods
342 // offset matches _default_methods offset
343 Array<int>* _default_vtable_indices;
344
345 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
346 Array<u1>* _fieldinfo_stream;
347 Array<FieldStatus>* _fields_status;
348
349 Array<InlineLayoutInfo>* _inline_layout_info_array;
350 Array<u2>* _loadable_descriptors;
351 const InlineKlassFixedBlock* _adr_inlineklass_fixed_block;
352
353 // embedded Java vtable follows here
354 // embedded Java itables follows here
355 // embedded static fields follows here
356 // embedded nonstatic oop-map blocks follows here
357 // embedded implementor of this interface follows here
358 // The embedded implementor only exists if the current klass is an
359 // interface. The possible values of the implementor fall into following
360 // three cases:
361 // null: no implementor.
362 // A Klass* that's not itself: one implementor.
363 // Itself: more than one implementors.
364 //
365
366 friend class SystemDictionary;
367
368 static bool _disable_method_binary_search;
369
370 // Controls finalizer registration
371 static bool _finalization_enabled;
372
386 bool is_shared_unregistered_class() const { return _misc_flags.is_shared_unregistered_class(); }
387
388 // Check if the class can be shared in CDS
389 bool is_shareable() const;
390
391 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
392
393 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
394
395 #if INCLUDE_CDS
396 void set_shared_class_loader_type(s2 loader_type) { _misc_flags.set_shared_class_loader_type(loader_type); }
397 void assign_class_loader_type() { _misc_flags.assign_class_loader_type(_class_loader_data); }
398 #endif
399
400 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
401 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
402
403 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
404 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
405
406 bool has_inline_type_fields() const { return _misc_flags.has_inline_type_fields(); }
407 void set_has_inline_type_fields() { _misc_flags.set_has_inline_type_fields(true); }
408
409 bool is_naturally_atomic() const { return _misc_flags.is_naturally_atomic(); }
410 void set_is_naturally_atomic() { _misc_flags.set_is_naturally_atomic(true); }
411
412 // Query if this class has atomicity requirements (default is yes)
413 // This bit can occur anywhere, but is only significant
414 // for inline classes *and* their super types.
415 // It inherits from supers.
416 // Its value depends on the ForceNonTearable VM option, the LooselyConsistentValue annotation
417 // and the presence of flat fields with atomicity requirements
418 bool must_be_atomic() const { return _misc_flags.must_be_atomic(); }
419 void set_must_be_atomic() { _misc_flags.set_must_be_atomic(true); }
420
421 // Query if this class can be implicitly constructed, meaning the VM is allowed
422 // to create instances without calling a constructor
423 // Applies to inline classes and their super types
424 bool is_implicitly_constructible() const { return _misc_flags.is_implicitly_constructible(); }
425 void set_is_implicitly_constructible() { _misc_flags.set_is_implicitly_constructible(true); }
426
427 // field sizes
428 int nonstatic_field_size() const { return _nonstatic_field_size; }
429 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
430
431 int static_field_size() const { return _static_field_size; }
432 void set_static_field_size(int size) { _static_field_size = size; }
433
434 int static_oop_field_count() const { return (int)_static_oop_field_count; }
435 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
436
437 // Java itable
438 int itable_length() const { return _itable_len; }
439 void set_itable_length(int len) { _itable_len = len; }
440
441 // array klasses
442 ArrayKlass* array_klasses() const { return _array_klasses; }
443 inline ArrayKlass* array_klasses_acquire() const; // load with acquire semantics
444 inline void release_set_array_klasses(ArrayKlass* k); // store with release semantics
445 void set_array_klasses(ArrayKlass* k) { _array_klasses = k; }
446
447 // methods
448 Array<Method*>* methods() const { return _methods; }
449 void set_methods(Array<Method*>* a) { _methods = a; }
450 Method* method_with_idnum(int idnum);
451 Method* method_with_orig_idnum(int idnum);
452 Method* method_with_orig_idnum(int idnum, int version);
453
454 // method ordering
455 Array<int>* method_ordering() const { return _method_ordering; }
456 void set_method_ordering(Array<int>* m) { _method_ordering = m; }
457 void copy_method_ordering(const intArray* m, TRAPS);
458
459 // default_methods
460 Array<Method*>* default_methods() const { return _default_methods; }
461 void set_default_methods(Array<Method*>* a) { _default_methods = a; }
462
463 // default method vtable_indices
464 Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
465 void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
466 Array<int>* create_new_default_vtable_indices(int len, TRAPS);
467
468 // interfaces
469 Array<InstanceKlass*>* local_interfaces() const { return _local_interfaces; }
470 void set_local_interfaces(Array<InstanceKlass*>* a) {
471 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
472 _local_interfaces = a; }
473
474 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
475 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
476 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
477 _transitive_interfaces = a;
478 }
479
480 private:
481 friend class fieldDescriptor;
482 FieldInfo field(int index) const;
483
484 public:
485 int field_offset (int index) const { return field(index).offset(); }
486 int field_access_flags(int index) const { return field(index).access_flags().as_int(); }
487 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
488 FieldStatus field_status(int index) const { return fields_status()->at(index); }
489 inline Symbol* field_name (int index) const;
490 inline Symbol* field_signature (int index) const;
491 bool field_is_flat(int index) const { return field_flags(index).is_flat(); }
492 bool field_has_null_marker(int index) const { return field_flags(index).has_null_marker(); }
493 bool field_is_null_free_inline_type(int index) const;
494 bool is_class_in_loadable_descriptors_attribute(Symbol* name) const;
495
496 int null_marker_offset(int index) const { return inline_layout_info(index).null_marker_offset(); }
497
498 // Number of Java declared fields
499 int java_fields_count() const;
500 int total_fields_count() const;
501
502 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
503 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
504
505 Array<FieldStatus>* fields_status() const {return _fields_status; }
506 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
507
508 Array<u2>* loadable_descriptors() const { return _loadable_descriptors; }
509 void set_loadable_descriptors(Array<u2>* c) { _loadable_descriptors = c; }
510
511 // inner classes
512 Array<u2>* inner_classes() const { return _inner_classes; }
513 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
514
515 // nest members
516 Array<u2>* nest_members() const { return _nest_members; }
517 void set_nest_members(Array<u2>* m) { _nest_members = m; }
518
519 // nest-host index
520 jushort nest_host_index() const { return _nest_host_index; }
521 void set_nest_host_index(u2 i) { _nest_host_index = i; }
522 // dynamic nest member support
523 void set_nest_host(InstanceKlass* host);
524
525 // record components
526 Array<RecordComponent*>* record_components() const { return _record_components; }
527 void set_record_components(Array<RecordComponent*>* record_components) {
528 _record_components = record_components;
529 }
530 bool is_record() const;
612 bool is_initialized() const { return init_state() == fully_initialized; }
613 bool is_not_initialized() const { return init_state() < being_initialized; }
614 bool is_being_initialized() const { return init_state() == being_initialized; }
615 bool is_in_error_state() const { return init_state() == initialization_error; }
616 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
617 ClassState init_state() const { return Atomic::load_acquire(&_init_state); }
618 const char* init_state_name() const;
619 bool is_rewritten() const { return _misc_flags.rewritten(); }
620
621 // is this a sealed class
622 bool is_sealed() const;
623
624 // defineClass specified verification
625 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
626 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
627
628 // marking
629 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
630 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
631
632 static ByteSize kind_offset() { return in_ByteSize(offset_of(InstanceKlass, _kind)); }
633 static ByteSize misc_flags_offset() { return in_ByteSize(offset_of(InstanceKlass, _misc_flags)); }
634
635 // initialization (virtuals from Klass)
636 bool should_be_initialized() const; // means that initialize should be called
637 void initialize(TRAPS);
638 void link_class(TRAPS);
639 bool link_class_or_fail(TRAPS); // returns false on failure
640 void rewrite_class(TRAPS);
641 void link_methods(TRAPS);
642 Method* class_initializer() const;
643
644 // reference type
645 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
646
647 // this class cp index
648 u2 this_class_index() const { return _this_class_index; }
649 void set_this_class_index(u2 index) { _this_class_index = index; }
650
651 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
652
653 // find local field, returns true if found
654 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
941
942 // On-stack replacement support
943 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
944 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
945 void add_osr_nmethod(nmethod* n);
946 bool remove_osr_nmethod(nmethod* n);
947 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
948 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
949
950 #if INCLUDE_JVMTI
951 // Breakpoint support (see methods on Method* for details)
952 BreakpointInfo* breakpoints() const { return _breakpoints; };
953 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
954 #endif
955
956 // support for stub routines
957 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
958 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
959 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
960
961 static ByteSize inline_layout_info_array_offset() { return in_ByteSize(offset_of(InstanceKlass, _inline_layout_info_array)); }
962 static ByteSize adr_inlineklass_fixed_block_offset() { return in_ByteSize(offset_of(InstanceKlass, _adr_inlineklass_fixed_block)); }
963
964 // subclass/subinterface checks
965 bool implements_interface(Klass* k) const;
966 bool is_same_or_direct_interface(Klass* k) const;
967
968 #ifdef ASSERT
969 // check whether this class or one of its superclasses was redefined
970 bool has_redefined_this_or_super() const;
971 #endif
972
973 // Access to the implementor of an interface.
974 InstanceKlass* implementor() const;
975 void set_implementor(InstanceKlass* ik);
976 int nof_implementors() const;
977 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
978 void init_implementor(); // initialize
979
980 private:
981 // link this class into the implementors list of every interface it implements
982 void process_interfaces();
983
1001
1002 static InstanceKlass* cast(Klass* k) {
1003 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
1004 }
1005
1006 static const InstanceKlass* cast(const Klass* k) {
1007 assert(k != nullptr, "k should not be null");
1008 assert(k->is_instance_klass(), "cast to InstanceKlass");
1009 return static_cast<const InstanceKlass*>(k);
1010 }
1011
1012 virtual InstanceKlass* java_super() const {
1013 return (super() == nullptr) ? nullptr : cast(super());
1014 }
1015
1016 // Sizing (in words)
1017 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
1018
1019 static int size(int vtable_length, int itable_length,
1020 int nonstatic_oop_map_size,
1021 bool is_interface,
1022 bool is_inline_type) {
1023 return align_metadata_size(header_size() +
1024 vtable_length +
1025 itable_length +
1026 nonstatic_oop_map_size +
1027 (is_interface ? (int)sizeof(Klass*)/wordSize : 0) +
1028 (is_inline_type ? (int)sizeof(InlineKlassFixedBlock) : 0));
1029 }
1030
1031 int size() const { return size(vtable_length(),
1032 itable_length(),
1033 nonstatic_oop_map_size(),
1034 is_interface(),
1035 is_inline_klass());
1036 }
1037
1038
1039 inline intptr_t* start_of_itable() const;
1040 inline intptr_t* end_of_itable() const;
1041 inline oop static_field_base_raw();
1042 bool bounds_check(address addr, bool edge_ok = false, intptr_t size_in_bytes = -1) const PRODUCT_RETURN0;
1043
1044 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
1045 inline Klass** end_of_nonstatic_oop_maps() const;
1046
1047 inline InstanceKlass* volatile* adr_implementor() const;
1048
1049 void set_inline_layout_info_array(Array<InlineLayoutInfo>* array) { _inline_layout_info_array = array; }
1050 Array<InlineLayoutInfo>* inline_layout_info_array() const { return _inline_layout_info_array; }
1051 void set_inline_layout_info(int index, InlineLayoutInfo *info) {
1052 assert(_inline_layout_info_array != nullptr ,"Array not created");
1053 _inline_layout_info_array->at_put(index, *info);
1054 }
1055 InlineLayoutInfo inline_layout_info(int index) const {
1056 assert(_inline_layout_info_array != nullptr ,"Array not created");
1057 return _inline_layout_info_array->at(index);
1058 }
1059 InlineLayoutInfo* inline_layout_info_adr(int index) {
1060 assert(_inline_layout_info_array != nullptr ,"Array not created");
1061 return _inline_layout_info_array->adr_at(index);
1062 }
1063
1064 inline InlineKlass* get_inline_type_field_klass(int idx) const ;
1065 inline InlineKlass* get_inline_type_field_klass_or_null(int idx) const;
1066
1067 // Use this to return the size of an instance in heap words:
1068 virtual int size_helper() const {
1069 return layout_helper_to_size_helper(layout_helper());
1070 }
1071
1072 // This bit is initialized in classFileParser.cpp.
1073 // It is false under any of the following conditions:
1074 // - the class is abstract (including any interface)
1075 // - the class size is larger than FastAllocateSizeLimit
1076 // - the class is java/lang/Class, which cannot be allocated directly
1077 bool can_be_fastpath_allocated() const {
1078 return !layout_helper_needs_slow_path(layout_helper());
1079 }
1080
1081 // Java itable
1082 klassItable itable() const; // return klassItable wrapper
1083 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
1084 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
1085 int vtable_index_of_interface_method(Method* method);
1086
1087 #if INCLUDE_JVMTI
1088 void adjust_default_methods(bool* trace_name_printed);
1099 // instanceKlasses and the metadata they point to.
1100 void deallocate_contents(ClassLoaderData* loader_data);
1101 static void deallocate_methods(ClassLoaderData* loader_data,
1102 Array<Method*>* methods);
1103 void static deallocate_interfaces(ClassLoaderData* loader_data,
1104 const Klass* super_klass,
1105 Array<InstanceKlass*>* local_interfaces,
1106 Array<InstanceKlass*>* transitive_interfaces);
1107 void static deallocate_record_components(ClassLoaderData* loader_data,
1108 Array<RecordComponent*>* record_component);
1109
1110 virtual bool on_stack() const;
1111
1112 // callbacks for actions during class unloading
1113 static void unload_class(InstanceKlass* ik);
1114
1115 virtual void release_C_heap_structures(bool release_sub_metadata = true);
1116
1117 // Naming
1118 const char* signature_name() const;
1119 const char* signature_name_of_carrier(char c) const;
1120
1121 // Oop fields (and metadata) iterators
1122 //
1123 // The InstanceKlass iterators also visits the Object's klass.
1124
1125 // Forward iteration
1126 public:
1127 // Iterate over all oop fields in the oop maps.
1128 template <typename T, class OopClosureType>
1129 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1130
1131 // Iterate over all oop fields and metadata.
1132 template <typename T, class OopClosureType>
1133 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1134
1135 // Iterate over all oop fields in one oop map.
1136 template <typename T, class OopClosureType>
1137 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1138
1139
1225 const Symbol* name,
1226 const Symbol* signature,
1227 OverpassLookupMode overpass_mode,
1228 StaticLookupMode static_mode,
1229 PrivateLookupMode private_mode);
1230
1231 #if INCLUDE_JVMTI
1232 // RedefineClasses support
1233 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1234 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1235 #endif
1236 // log class name to classlist
1237 void log_to_classlist() const;
1238 public:
1239
1240 #if INCLUDE_CDS
1241 // CDS support - remove and restore oops from metadata. Oops are not shared.
1242 virtual void remove_unshareable_info();
1243 void remove_unshareable_flags();
1244 virtual void remove_java_mirror();
1245 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1246 void init_shared_package_entry();
1247 bool can_be_verified_at_dumptime() const;
1248 void compute_has_loops_flag_for_methods();
1249 #endif
1250
1251 jint compute_modifier_flags() const;
1252
1253 public:
1254 // JVMTI support
1255 jint jvmti_class_status() const;
1256
1257 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1258
1259 public:
1260 // Printing
1261 void print_on(outputStream* st) const;
1262 void print_value_on(outputStream* st) const;
1263
1264 void oop_print_value_on(oop obj, outputStream* st);
1265
1266 void oop_print_on (oop obj, outputStream* st) { oop_print_on(obj, st, 0, 0); }
1267 void oop_print_on (oop obj, outputStream* st, int indent = 0, int base_offset = 0);
1268
1269 #ifndef PRODUCT
1270 void print_dependent_nmethods(bool verbose = false);
1271 bool is_dependent_nmethod(nmethod* nm);
1272 bool verify_itable_index(int index);
1273 #endif
1274
1275 const char* internal_name() const;
1276
1277 // Verification
1278 void verify_on(outputStream* st);
1279
1280 void oop_verify_on(oop obj, outputStream* st);
1281
1282 // Logging
1283 void print_class_load_logging(ClassLoaderData* loader_data,
1284 const ModuleEntry* module_entry,
1285 const ClassFileStream* cfs) const;
1286 private:
1287 void print_class_load_cause_logging() const;
|